From 591f8ad714b1316b94ca1c167f6ca58bcde0a127 Mon Sep 17 00:00:00 2001 From: Dirk Van Haerenborgh Date: Fri, 29 Oct 2021 06:46:35 +0200 Subject: [PATCH] add javascriptcore --- .gitignore | 1 + Atk-1.0.gir | 14034 +--- GIRepository-2.0.gir | 378 +- GLib-2.0.gir | 49668 ++++--------- GModule-2.0.gir | 180 +- GObject-2.0.gir | 17323 ++--- Gdk-3.0.gir | 22729 ++---- Gdk-4.0.gir | 19031 +++-- GdkPixbuf-2.0.gir | 6067 +- GdkPixdata-2.0.gir | 215 +- GdkWayland-4.0.gir | 215 +- GdkX11-4.0.gir | 1556 +- Gio-2.0.gir | 29038 ++++---- Graphene-1.0.gir | 56 +- Gsk-4.0.gir | 4746 +- Gtk-3.0.gir | 119274 ++++++++------------------------ Gtk-4.0.gir | 36967 +++++----- HarfBuzz-0.0.gir | 4767 +- JavaScriptCore-4.0-patch.gir | 355 + JavaScriptCore-4.0.gir | 1755 +- JavaScriptCore-4.0.xsl | 84 + Pango-1.0.gir | 4967 +- PangoCairo-1.0.gir | 681 +- PangoFT2-1.0.gir | 436 +- PangoFc-1.0.gir | 755 +- PangoOT-1.0.gir | 986 +- PangoXft-1.0.gir | 614 +- Soup-2.4.gir | 44471 +++++++----- WebKit2-4.0.gir | 8751 ++- WebKit2WebExtension-4.0.gir | 11580 ++-- dl.sh | 23 +- fix.sh | 20 + freetype2-2.0.gir | 11 +- win32-1.0.gir | 9 +- 34 files changed, 167292 insertions(+), 234451 deletions(-) create mode 100644 JavaScriptCore-4.0-patch.gir create mode 100644 JavaScriptCore-4.0.xsl diff --git a/.gitignore b/.gitignore index ac2281f..41ef4db 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.rnc +tmp.html diff --git a/Atk-1.0.gir b/Atk-1.0.gir index b16ed76..bdb306d 100644 --- a/Atk-1.0.gir +++ b/Atk-1.0.gir @@ -2,22 +2,13 @@ - + - + - This is a singly-linked list (a #GSList) of #AtkAttribute. It is + This is a singly-linked list (a #GSList) of #AtkAttribute. It is used by atk_text_get_run_attributes(), atk_text_get_default_attributes(), atk_editable_text_set_run_attributes(), @@ -36,24 +27,15 @@ atk_document_get_attributes() and atk_object_get_attributes() - + - - #AtkAction should be implemented by instances of #AtkObject classes + + #AtkAction should be implemented by instances of #AtkObject classes with which the user can interact directly, i.e. buttons, checkboxes, scrollbars, e.g. components which are not "passive" providers of UI information. @@ -72,62 +54,44 @@ exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for #AtkAction names. - Perform the specified action on the object. + Perform the specified action on the object. - %TRUE if success, %FALSE otherwise + %TRUE if success, %FALSE otherwise - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Returns a description of the specified action of the object. + Returns a description of the specified action of the object. - a description string, or %NULL if @action does + a description string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Gets the keybinding which can be used to activate this action, if one + Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut". @@ -151,81 +115,59 @@ for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively. - the keybinding which can be used to activate + the keybinding which can be used to activate this action, or %NULL if there is no keybinding for this action. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Returns the localized name of the specified action of the object. + Returns the localized name of the specified action of the object. - a name string, or %NULL if @action does not + a name string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Gets the number of accessible actions available on the object. + Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object. - a the number of actions, or 0 if @action does not + a the number of actions, or 0 if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - Returns a non-localized string naming the specified action of the + Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to @@ -241,116 +183,82 @@ i.e. the result of some actions via atk_action_do_action() may be NIL. - a name string, or %NULL if @action does not + a name string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Sets a description of the specified action of the object. + Sets a description of the specified action of the object. - a gboolean representing if the description was successfully set; + a gboolean representing if the description was successfully set; - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - the description to be assigned to this action + the description to be assigned to this action - Perform the specified action on the object. + Perform the specified action on the object. - %TRUE if success, %FALSE otherwise + %TRUE if success, %FALSE otherwise - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Returns a description of the specified action of the object. + Returns a description of the specified action of the object. - a description string, or %NULL if @action does + a description string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Gets the keybinding which can be used to activate this action, if one + Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut". @@ -374,82 +282,59 @@ for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively. - the keybinding which can be used to activate + the keybinding which can be used to activate this action, or %NULL if there is no keybinding for this action. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - - Returns the localized name of the specified action of the object. + + Returns the localized name of the specified action of the object. - a name string, or %NULL if @action does not + a name string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Gets the number of accessible actions available on the object. + Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object. - a the number of actions, or 0 if @action does not + a the number of actions, or 0 if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - Returns a non-localized string naming the specified action of the + Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to @@ -465,66 +350,46 @@ i.e. the result of some actions via atk_action_do_action() may be NIL. - a name string, or %NULL if @action does not + a name string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - Sets a description of the specified action of the object. + Sets a description of the specified action of the object. - a gboolean representing if the description was successfully set; + a gboolean representing if the description was successfully set; - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - the description to be assigned to this action + the description to be assigned to this action - - The #AtkAction interface should be supported by any object that can + + The #AtkAction interface should be supported by any object that can perform one or more actions. The interface provides the standard mechanism for an assistive technology to determine what those actions are as well as tell the object to perform them. Any object that can @@ -537,22 +402,16 @@ be manipulated should support this interface. - %TRUE if success, %FALSE otherwise + %TRUE if success, %FALSE otherwise - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed @@ -562,17 +421,13 @@ be manipulated should support this interface. - a the number of actions, or 0 if @action does not + a the number of actions, or 0 if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface @@ -582,23 +437,17 @@ implement this interface. - a description string, or %NULL if @action does + a description string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed @@ -608,23 +457,17 @@ not implement this interface. - a name string, or %NULL if @action does not + a name string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed @@ -634,23 +477,17 @@ implement this interface. - the keybinding which can be used to activate + the keybinding which can be used to activate this action, or %NULL if there is no keybinding for this action. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed @@ -660,28 +497,20 @@ this action, or %NULL if there is no keybinding for this action. - a gboolean representing if the description was successfully set; + a gboolean representing if the description was successfully set; - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed - the description to be assigned to this action + the description to be assigned to this action @@ -691,23 +520,17 @@ this action, or %NULL if there is no keybinding for this action. - a name string, or %NULL if @action does not + a name string, or %NULL if @action does not implement this interface. - a #GObject instance that implements AtkActionIface + a #GObject instance that implements AtkActionIface - the action index corresponding to the action to be performed + the action index corresponding to the action to be performed @@ -715,9 +538,7 @@ implement this interface. - AtkAttribute is a string name/value pair representing a generic + AtkAttribute is a string name/value pair representing a generic attribute. This can be used to expose additional information from an accessible object as a whole (see atk_object_get_attributes()) or an document (see atk_document_get_attributes()). In the case of @@ -730,21 +551,15 @@ and atk_text_attribute_get_value() for more information. A string name/value pair representing a generic attribute. - The attribute name. + The attribute name. - the value of the attribute, represented as a string. + the value of the attribute, represented as a string. - Frees the memory used by an #AtkAttributeSet, including all its + Frees the memory used by an #AtkAttributeSet, including all its #AtkAttributes. @@ -752,80 +567,51 @@ A string name/value pair representing a generic attribute. - The #AtkAttributeSet to free + The #AtkAttributeSet to free - - Like atk_get_binary_age(), but from the headers used at + + Like atk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. - - Returns %TRUE if the version of the ATK header files is the same as + + Returns %TRUE if the version of the ATK header files is the same as or newer than the passed-in version. - major version (e.g. 1 for version 1.2.5) + major version (e.g. 1 for version 1.2.5) - minor version (e.g. 2 for version 1.2.5) + minor version (e.g. 2 for version 1.2.5) - micro version (e.g. 5 for version 1.2.5) + micro version (e.g. 5 for version 1.2.5) - + - + - - #AtkComponent should be implemented by most if not all UI elements + + #AtkComponent should be implemented by most if not all UI elements with an actual on-screen presence, i.e. components which can be said to have a screen-coordinate bounding box. Virtually all widgets will need to have #AtkComponent implementations provided @@ -836,37 +622,25 @@ A possible exception might be textual information with a transparent background, in which case text glyph bounding box information is provided by #AtkText. - - Add the specified handler to the set of functions to be called + + Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again If you need to track when an object gains or lose the focus, use the #AtkObject::state-change "focused" notification instead. - a handler id which can be used in atk_component_remove_focus_handler() + a handler id which can be used in atk_component_remove_focus_handler() or zero if the handler was already added. - The #AtkComponent to attach the @handler to + The #AtkComponent to attach the @handler to - The #AtkFocusHandler to be attached to @component + The #AtkFocusHandler to be attached to @component @@ -886,75 +660,55 @@ or zero if the handler was already added. - Checks whether the specified point is within the extent of the @component. + Checks whether the specified point is within the extent of the @component. Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it. - %TRUE or %FALSE indicating whether the specified point is within + %TRUE or %FALSE indicating whether the specified point is within the extent of the @component or not - the #AtkComponent + the #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Returns the alpha value (i.e. the opacity) for this + Returns the alpha value (i.e. the opacity) for this @component, on a scale from 0 (fully transparent) to 1.0 (fully opaque). - An alpha value from 0 to 1.0, inclusive. + An alpha value from 0 to 1.0, inclusive. - an #AtkComponent + an #AtkComponent - Gets the rectangle which gives the extent of the @component. + Gets the rectangle which gives the extent of the @component. If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1. @@ -964,113 +718,65 @@ support), all of x, y, width, height are set to -1. - an #AtkComponent + an #AtkComponent - - address of #gint to put x coordinate + + address of #gint to put x coordinate - - address of #gint to put y coordinate + + address of #gint to put y coordinate - - address of #gint to put width + + address of #gint to put width - - address of #gint to put height + + address of #gint to put height - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Gets the layer of the component. + Gets the layer of the component. - an #AtkLayer which is the layer of the component + an #AtkLayer which is the layer of the component - an #AtkComponent + an #AtkComponent - Gets the zorder of the component. The value G_MININT will be returned + Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW. - a gint which is the zorder of the component, i.e. the depth at + a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container. - an #AtkComponent + an #AtkComponent - - Gets the position of @component in the form of + + Gets the position of @component in the form of a point specifying @component's top-left corner. If the position can not be obtained (e.g. a non-embedded plug or missing @@ -1082,46 +788,26 @@ support), x and y are set to -1. - an #AtkComponent + an #AtkComponent - - address of #gint to put x coordinate position + + address of #gint to put x coordinate position - - address of #gint to put y coordinate position + + address of #gint to put y coordinate position - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Gets the size of the @component in terms of width and height. + Gets the size of the @component in terms of width and height. If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1. @@ -1132,104 +818,64 @@ support), width and height are set to -1. - an #AtkComponent + an #AtkComponent - - address of #gint to put width of @component + + address of #gint to put width of @component - - address of #gint to put height of @component + + address of #gint to put height of @component - Grabs focus for this @component. + Grabs focus for this @component. - %TRUE if successful, %FALSE otherwise. + %TRUE if successful, %FALSE otherwise. - an #AtkComponent + an #AtkComponent - - Gets a reference to the accessible child, if one exists, at the + + Gets a reference to the accessible child, if one exists, at the coordinate point specified by @x and @y. - a reference to the accessible + a reference to the accessible child, if one exists - the #AtkComponent + the #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - - Remove the handler specified by @handler_id from the list of + + Remove the handler specified by @handler_id from the list of functions to be executed when this object receives focus events (in or out). If you need to track when an object gains or @@ -1240,324 +886,226 @@ lose the focus, use the #AtkObject::state-change "focused" notification instead. - the #AtkComponent to remove the focus handler from + the #AtkComponent to remove the focus handler from - the handler id of the focus handler to be removed + the handler id of the focus handler to be removed from @component - Makes @component visible on the screen by scrolling all necessary parents. + Makes @component visible on the screen by scrolling all necessary parents. Contrary to atk_component_set_position, this does not actually move @component in its parent, this only makes the parents scroll so that the object shows up on the screen, given its current position within the parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkComponent + an #AtkComponent - specify where the object should be made visible. + specify where the object should be made visible. - - Move the top-left of @component to a given position of the screen by + + Move the top-left of @component to a given position of the screen by scrolling all necessary parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkComponent + an #AtkComponent - specify whether coordinates are relative to the screen or to the + specify whether coordinates are relative to the screen or to the parent object. - x-position where to scroll to + x-position where to scroll to - y-position where to scroll to + y-position where to scroll to - Sets the extents of @component. + Sets the extents of @component. - %TRUE or %FALSE whether the extents were set or not + %TRUE or %FALSE whether the extents were set or not - an #AtkComponent + an #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - width to set for @component + width to set for @component - height to set for @component + height to set for @component - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Sets the position of @component. + Sets the position of @component. Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves @component in its parent. - %TRUE or %FALSE whether or not the position was set or not + %TRUE or %FALSE whether or not the position was set or not - an #AtkComponent + an #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the component's top level window - Set the size of the @component in terms of width and height. + Set the size of the @component in terms of width and height. - %TRUE or %FALSE whether the size was set or not + %TRUE or %FALSE whether the size was set or not - an #AtkComponent + an #AtkComponent - width to set for @component + width to set for @component - height to set for @component + height to set for @component - - Add the specified handler to the set of functions to be called + + Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again If you need to track when an object gains or lose the focus, use the #AtkObject::state-change "focused" notification instead. - a handler id which can be used in atk_component_remove_focus_handler() + a handler id which can be used in atk_component_remove_focus_handler() or zero if the handler was already added. - The #AtkComponent to attach the @handler to + The #AtkComponent to attach the @handler to - The #AtkFocusHandler to be attached to @component + The #AtkFocusHandler to be attached to @component - Checks whether the specified point is within the extent of the @component. + Checks whether the specified point is within the extent of the @component. Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it. - %TRUE or %FALSE indicating whether the specified point is within + %TRUE or %FALSE indicating whether the specified point is within the extent of the @component or not - the #AtkComponent + the #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - - Returns the alpha value (i.e. the opacity) for this + + Returns the alpha value (i.e. the opacity) for this @component, on a scale from 0 (fully transparent) to 1.0 (fully opaque). - An alpha value from 0 to 1.0, inclusive. + An alpha value from 0 to 1.0, inclusive. - an #AtkComponent + an #AtkComponent - Gets the rectangle which gives the extent of the @component. + Gets the rectangle which gives the extent of the @component. If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1. @@ -1567,114 +1115,65 @@ support), all of x, y, width, height are set to -1. - an #AtkComponent + an #AtkComponent - - address of #gint to put x coordinate + + address of #gint to put x coordinate - - address of #gint to put y coordinate + + address of #gint to put y coordinate - - address of #gint to put width + + address of #gint to put width - - address of #gint to put height + + address of #gint to put height - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Gets the layer of the component. + Gets the layer of the component. - an #AtkLayer which is the layer of the component + an #AtkLayer which is the layer of the component - an #AtkComponent + an #AtkComponent - - Gets the zorder of the component. The value G_MININT will be returned + + Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW. - a gint which is the zorder of the component, i.e. the depth at + a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container. - an #AtkComponent + an #AtkComponent - - Gets the position of @component in the form of + + Gets the position of @component in the form of a point specifying @component's top-left corner. If the position can not be obtained (e.g. a non-embedded plug or missing @@ -1686,48 +1185,26 @@ support), x and y are set to -1. - an #AtkComponent + an #AtkComponent - - address of #gint to put x coordinate position + + address of #gint to put x coordinate position - - address of #gint to put y coordinate position + + address of #gint to put y coordinate position - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - - Gets the size of the @component in terms of width and height. + + Gets the size of the @component in terms of width and height. If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1. @@ -1738,104 +1215,64 @@ support), width and height are set to -1. - an #AtkComponent + an #AtkComponent - - address of #gint to put width of @component + + address of #gint to put width of @component - - address of #gint to put height of @component + + address of #gint to put height of @component - Grabs focus for this @component. + Grabs focus for this @component. - %TRUE if successful, %FALSE otherwise. + %TRUE if successful, %FALSE otherwise. - an #AtkComponent + an #AtkComponent - - Gets a reference to the accessible child, if one exists, at the + + Gets a reference to the accessible child, if one exists, at the coordinate point specified by @x and @y. - a reference to the accessible + a reference to the accessible child, if one exists - the #AtkComponent + the #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - - Remove the handler specified by @handler_id from the list of + + Remove the handler specified by @handler_id from the list of functions to be executed when this object receives focus events (in or out). If you need to track when an object gains or @@ -1846,243 +1283,169 @@ lose the focus, use the #AtkObject::state-change "focused" notification instead. - the #AtkComponent to remove the focus handler from + the #AtkComponent to remove the focus handler from - the handler id of the focus handler to be removed + the handler id of the focus handler to be removed from @component - - Makes @component visible on the screen by scrolling all necessary parents. + + Makes @component visible on the screen by scrolling all necessary parents. Contrary to atk_component_set_position, this does not actually move @component in its parent, this only makes the parents scroll so that the object shows up on the screen, given its current position within the parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkComponent + an #AtkComponent - specify where the object should be made visible. + specify where the object should be made visible. - - Move the top-left of @component to a given position of the screen by + + Move the top-left of @component to a given position of the screen by scrolling all necessary parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkComponent + an #AtkComponent - specify whether coordinates are relative to the screen or to the + specify whether coordinates are relative to the screen or to the parent object. - x-position where to scroll to + x-position where to scroll to - y-position where to scroll to + y-position where to scroll to - Sets the extents of @component. + Sets the extents of @component. - %TRUE or %FALSE whether the extents were set or not + %TRUE or %FALSE whether the extents were set or not - an #AtkComponent + an #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - width to set for @component + width to set for @component - height to set for @component + height to set for @component - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Sets the position of @component. + Sets the position of @component. Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves @component in its parent. - %TRUE or %FALSE whether or not the position was set or not + %TRUE or %FALSE whether or not the position was set or not - an #AtkComponent + an #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the component's top level window - Set the size of the @component in terms of width and height. + Set the size of the @component in terms of width and height. - %TRUE or %FALSE whether the size was set or not + %TRUE or %FALSE whether the size was set or not - an #AtkComponent + an #AtkComponent - width to set for @component + width to set for @component - height to set for @component + height to set for @component - The 'bounds-changed" signal is emitted when the bposition or + The 'bounds-changed" signal is emitted when the bposition or size of the component changes. - The AtkRectangle giving the new position and size. + The AtkRectangle giving the new position and size. - - The AtkComponent interface should be supported by any object that is + + The AtkComponent interface should be supported by any object that is rendered on the screen. The interface provides the standard mechanism for an assistive technology to determine and set the graphical representation of an object. @@ -2094,23 +1457,17 @@ representation of an object. - a handler id which can be used in atk_component_remove_focus_handler() + a handler id which can be used in atk_component_remove_focus_handler() or zero if the handler was already added. - The #AtkComponent to attach the @handler to + The #AtkComponent to attach the @handler to - The #AtkFocusHandler to be attached to @component + The #AtkFocusHandler to be attached to @component @@ -2120,35 +1477,25 @@ or zero if the handler was already added. - %TRUE or %FALSE indicating whether the specified point is within + %TRUE or %FALSE indicating whether the specified point is within the extent of the @component or not - the #AtkComponent + the #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window @@ -2159,35 +1506,25 @@ or to the components top level window - a reference to the accessible + a reference to the accessible child, if one exists - the #AtkComponent + the #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window @@ -2202,59 +1539,27 @@ or to the components top level window - an #AtkComponent + an #AtkComponent - - address of #gint to put x coordinate + + address of #gint to put x coordinate - - address of #gint to put y coordinate + + address of #gint to put y coordinate - - address of #gint to put width + + address of #gint to put width - - address of #gint to put height + + address of #gint to put height - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window @@ -2269,37 +1574,19 @@ or to the components top level window - an #AtkComponent + an #AtkComponent - - address of #gint to put x coordinate position + + address of #gint to put x coordinate position - - address of #gint to put y coordinate position + + address of #gint to put y coordinate position - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window @@ -2314,31 +1601,15 @@ or to the components top level window - an #AtkComponent + an #AtkComponent - - address of #gint to put width of @component + + address of #gint to put width of @component - - address of #gint to put height of @component + + address of #gint to put height of @component @@ -2348,16 +1619,12 @@ or to the components top level window - %TRUE if successful, %FALSE otherwise. + %TRUE if successful, %FALSE otherwise. - an #AtkComponent + an #AtkComponent @@ -2371,15 +1638,11 @@ or to the components top level window - the #AtkComponent to remove the focus handler from + the #AtkComponent to remove the focus handler from - the handler id of the focus handler to be removed + the handler id of the focus handler to be removed from @component @@ -2390,46 +1653,32 @@ from @component - %TRUE or %FALSE whether the extents were set or not + %TRUE or %FALSE whether the extents were set or not - an #AtkComponent + an #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - width to set for @component + width to set for @component - height to set for @component + height to set for @component - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window @@ -2440,34 +1689,24 @@ or to the components top level window - %TRUE or %FALSE whether or not the position was set or not + %TRUE or %FALSE whether or not the position was set or not - an #AtkComponent + an #AtkComponent - x coordinate + x coordinate - y coordinate + y coordinate - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the component's top level window @@ -2478,28 +1717,20 @@ or to the component's top level window - %TRUE or %FALSE whether the size was set or not + %TRUE or %FALSE whether the size was set or not - an #AtkComponent + an #AtkComponent - width to set for @component + width to set for @component - height to set for @component + height to set for @component @@ -2509,16 +1740,12 @@ or to the component's top level window - an #AtkLayer which is the layer of the component + an #AtkLayer which is the layer of the component - an #AtkComponent + an #AtkComponent @@ -2528,18 +1755,14 @@ or to the component's top level window - a gint which is the zorder of the component, i.e. the depth at + a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container. - an #AtkComponent + an #AtkComponent @@ -2565,16 +1788,12 @@ container. - An alpha value from 0 to 1.0, inclusive. + An alpha value from 0 to 1.0, inclusive. - an #AtkComponent + an #AtkComponent @@ -2584,22 +1803,16 @@ container. - whether scrolling was successful. + whether scrolling was successful. - an #AtkComponent + an #AtkComponent - specify where the object should be made visible. + specify where the object should be made visible. @@ -2609,142 +1822,83 @@ container. - whether scrolling was successful. + whether scrolling was successful. - an #AtkComponent + an #AtkComponent - specify whether coordinates are relative to the screen or to the + specify whether coordinates are relative to the screen or to the parent object. - x-position where to scroll to + x-position where to scroll to - y-position where to scroll to + y-position where to scroll to - - Specifies how xy coordinates are to be interpreted. Used by functions such + + Specifies how xy coordinates are to be interpreted. Used by functions such as atk_component_get_position() and atk_text_get_character_extents() - - specifies xy coordinates relative to the screen + + specifies xy coordinates relative to the screen - - specifies xy coordinates relative to the widget's + + specifies xy coordinates relative to the widget's top-level window - - specifies xy coordinates relative to the widget's + + specifies xy coordinates relative to the widget's immediate parent. Since: 2.30 - - A convenience macro for ATK type implementations. + + A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE(), but defines an abstract type. - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words separated by '_'. + The name of the new type, in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - - A convenience macro for ATK type implementations. + + A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE_WITH_CODE(), but defines an abstract type. - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words separated by '_'. + The name of the new type, in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - Custom code that gets inserted in the _get_type() function. + Custom code that gets inserted in the _get_type() function. - - A convenience macro for type ATK implementations, which declares a class + + A convenience macro for type ATK implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these) and a static variable named @t_n _parent_class pointing to the parent class. Furthermore, it @@ -2752,209 +1906,144 @@ defines a _get_type() function. - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words separated by '_'. + The name of the new type, in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - - The most general convenience macro for ATK type implementations, on which + + The most general convenience macro for ATK type implementations, on which ATK_DEFINE_TYPE(), etc are based. - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words separated by '_'. + The name of the new type, in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - #GTypeFlags to pass to g_type_register_static() + #GTypeFlags to pass to g_type_register_static() - Custom code that gets inserted in the _get_type() function. + Custom code that gets inserted in the _get_type() function. - - A convenience macro for ATK type implementations. + + A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE(), but allows you to insert custom code into the _get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type in lowercase, with words separated by '_'. + The name of the new type in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - Custom code that gets inserted in the _get_type() function. + Custom code that gets inserted in the _get_type() function. - + - + - + - + - + - + - + - + - + - + - + - + - - The AtkDocument interface should be supported by any object whose + + The AtkDocument interface should be supported by any object whose content is a representation or view of a document. The AtkDocument interface should appear on the toplevel container for the document content; however AtkDocument instances may be nested (i.e. an @@ -2962,35 +2051,23 @@ AtkDocument may be a descendant of another AtkDocument) in those cases where one document contains "embedded content" which can reasonably be considered a document in its own right. - - Retrieves the current page number inside @document. + + Retrieves the current page number inside @document. - the current page number inside @document, or -1 if + the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant. - the #AtkDocument + the #AtkDocument - - Gets a %gpointer that points to an instance of the DOM. It is + + Gets a %gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer. Since 2.12. @document is already a representation of @@ -2998,83 +2075,56 @@ the document. Use it directly, or one of its children, as an instance of the DOM. - a %gpointer that points to an instance of the DOM. + a %gpointer that points to an instance of the DOM. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Retrieves the value of the given @attribute_name inside @document. + + Retrieves the value of the given @attribute_name inside @document. - a string value associated with the named + a string value associated with the named attribute for this document, or %NULL if a value for @attribute_name has not been specified for this document. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - a character string representing the name of the attribute + a character string representing the name of the attribute whose value is being queried. - - Gets an AtkAttributeSet which describes document-wide + + Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs. - An AtkAttributeSet containing the explicitly + An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale + + Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and @@ -3082,191 +2132,129 @@ instance of the DOM. Please use atk_object_get_object_locale() instead. - a UTF-8 string indicating the POSIX-style LC_MESSAGES + a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Gets a string indicating the document type. + + Gets a string indicating the document type. Since 2.12. Please use atk_document_get_attributes() to ask for the document type if it applies. - a string indicating the document type + a string indicating the document type - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Retrieves the total number of pages inside @document. + + Retrieves the total number of pages inside @document. - total page count of @document, or -1 if not implemented, + total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant. - the #AtkDocument + the #AtkDocument - - Sets the value for the given @attribute_name inside @document. + + Sets the value for the given @attribute_name inside @document. - %TRUE if @attribute_value is successfully associated + %TRUE if @attribute_value is successfully associated with @attribute_name for this @document, and %FALSE if if the document does not allow the attribute to be modified - a #GObject instance that implements #AtkDocumentIface + a #GObject instance that implements #AtkDocumentIface - a character string representing the name of the attribute + a character string representing the name of the attribute whose value is being set. - a string value to be associated with @attribute_name. + a string value to be associated with @attribute_name. - - Retrieves the value of the given @attribute_name inside @document. + + Retrieves the value of the given @attribute_name inside @document. - a string value associated with the named + a string value associated with the named attribute for this document, or %NULL if a value for @attribute_name has not been specified for this document. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - a character string representing the name of the attribute + a character string representing the name of the attribute whose value is being queried. - - Gets an AtkAttributeSet which describes document-wide + + Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs. - An AtkAttributeSet containing the explicitly + An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Retrieves the current page number inside @document. + + Retrieves the current page number inside @document. - the current page number inside @document, or -1 if + the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant. - the #AtkDocument + the #AtkDocument - - Gets a %gpointer that points to an instance of the DOM. It is + + Gets a %gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer. Since 2.12. @document is already a representation of @@ -3274,51 +2262,34 @@ the document. Use it directly, or one of its children, as an instance of the DOM. - a %gpointer that points to an instance of the DOM. + a %gpointer that points to an instance of the DOM. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Gets a string indicating the document type. + + Gets a string indicating the document type. Since 2.12. Please use atk_document_get_attributes() to ask for the document type if it applies. - a string indicating the document type + a string indicating the document type - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale + + Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and @@ -3326,86 +2297,60 @@ ask for the document type if it applies. Please use atk_object_get_object_locale() instead. - a UTF-8 string indicating the POSIX-style LC_MESSAGES + a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - - Retrieves the total number of pages inside @document. + + Retrieves the total number of pages inside @document. - total page count of @document, or -1 if not implemented, + total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant. - the #AtkDocument + the #AtkDocument - - Sets the value for the given @attribute_name inside @document. + + Sets the value for the given @attribute_name inside @document. - %TRUE if @attribute_value is successfully associated + %TRUE if @attribute_value is successfully associated with @attribute_name for this @document, and %FALSE if if the document does not allow the attribute to be modified - a #GObject instance that implements #AtkDocumentIface + a #GObject instance that implements #AtkDocumentIface - a character string representing the name of the attribute + a character string representing the name of the attribute whose value is being set. - a string value to be associated with @attribute_name. + a string value to be associated with @attribute_name. - The 'load-complete' signal is emitted when a pending load of + The 'load-complete' signal is emitted when a pending load of a static document has completed. This signal is to be expected by ATK clients if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state of an AtkObject which @@ -3419,9 +2364,7 @@ signals.) - The 'load-stopped' signal is emitted when a pending load of + The 'load-stopped' signal is emitted when a pending load of document contents is cancelled, paused, or otherwise interrupted by the user or application logic. It should not however be emitted while waiting for a resource (for instance @@ -3432,9 +2375,7 @@ user-significant timeout has occurred. - The 'page-changed' signal is emitted when the current page of + The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer. @@ -3442,18 +2383,14 @@ viewer. - the new page number. If this value is unknown + the new page number. If this value is unknown or not applicable, -1 should be provided. - The 'reload' signal is emitted when the contents of a + The 'reload' signal is emitted when the contents of a document is refreshed from its source. Once 'reload' has been emitted, a matching 'load-complete' or 'load-stopped' signal should follow, which clients may await before @@ -3463,9 +2400,7 @@ interrogating ATK for the latest document content. - + @@ -3474,16 +2409,12 @@ interrogating ATK for the latest document content. - a string indicating the document type + a string indicating the document type - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface @@ -3493,16 +2424,12 @@ interrogating ATK for the latest document content. - a %gpointer that points to an instance of the DOM. + a %gpointer that points to an instance of the DOM. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface @@ -3512,18 +2439,14 @@ interrogating ATK for the latest document content. - a UTF-8 string indicating the POSIX-style LC_MESSAGES + a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface @@ -3533,18 +2456,14 @@ interrogating ATK for the latest document content. - An AtkAttributeSet containing the explicitly + An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface @@ -3554,24 +2473,18 @@ interrogating ATK for the latest document content. - a string value associated with the named + a string value associated with the named attribute for this document, or %NULL if a value for @attribute_name has not been specified for this document. - a #GObject instance that implements AtkDocumentIface + a #GObject instance that implements AtkDocumentIface - a character string representing the name of the attribute + a character string representing the name of the attribute whose value is being queried. @@ -3582,31 +2495,23 @@ interrogating ATK for the latest document content. - %TRUE if @attribute_value is successfully associated + %TRUE if @attribute_value is successfully associated with @attribute_name for this @document, and %FALSE if if the document does not allow the attribute to be modified - a #GObject instance that implements #AtkDocumentIface + a #GObject instance that implements #AtkDocumentIface - a character string representing the name of the attribute + a character string representing the name of the attribute whose value is being set. - a string value to be associated with @attribute_name. + a string value to be associated with @attribute_name. @@ -3616,17 +2521,13 @@ interrogating ATK for the latest document content. - the current page number inside @document, or -1 if + the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant. - the #AtkDocument + the #AtkDocument @@ -3636,50 +2537,35 @@ interrogating ATK for the latest document content. - total page count of @document, or -1 if not implemented, + total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant. - the #AtkDocument + the #AtkDocument - + - + - - #AtkEditableText should be implemented by UI components which + + #AtkEditableText should be implemented by UI components which contain text which the user can edit, via the #AtkObject corresponding to that component (see #AtkObject). @@ -3690,9 +2576,7 @@ implementor as well. See also: #AtkText - Copy text from @start_pos up to, but not including @end_pos + Copy text from @start_pos up to, but not including @end_pos to the clipboard. @@ -3700,29 +2584,21 @@ to the clipboard. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position - Copy text from @start_pos up to, but not including @end_pos + Copy text from @start_pos up to, but not including @end_pos to the clipboard and then delete from the widget. @@ -3730,85 +2606,61 @@ to the clipboard and then delete from the widget. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position - Delete text @start_pos up to, but not including @end_pos. + Delete text @start_pos up to, but not including @end_pos. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position - Insert text at a given position. + Insert text at a given position. - an #AtkEditableText + an #AtkEditableText - the text to insert + the text to insert - the length of text to insert, in bytes + the length of text to insert, in bytes - The caller initializes this to + The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text. @@ -3816,97 +2668,71 @@ points at the position after the newly inserted text. - Paste text from clipboard to specified @position. + Paste text from clipboard to specified @position. - an #AtkEditableText + an #AtkEditableText - position to paste + position to paste - Sets the attributes for a specified range. See the ATK_ATTRIBUTE + Sets the attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets. - %TRUE if attributes successfully set for the specified + %TRUE if attributes successfully set for the specified range, otherwise %FALSE - an #AtkEditableText + an #AtkEditableText - an #AtkAttributeSet + an #AtkAttributeSet - start of range in which to set attributes + start of range in which to set attributes - end of range in which to set attributes + end of range in which to set attributes - Set text contents of @text. + Set text contents of @text. - an #AtkEditableText + an #AtkEditableText - string to set for text contents of @text + string to set for text contents of @text - Copy text from @start_pos up to, but not including @end_pos + Copy text from @start_pos up to, but not including @end_pos to the clipboard. @@ -3914,29 +2740,21 @@ to the clipboard. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position - Copy text from @start_pos up to, but not including @end_pos + Copy text from @start_pos up to, but not including @end_pos to the clipboard and then delete from the widget. @@ -3944,85 +2762,61 @@ to the clipboard and then delete from the widget. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position - Delete text @start_pos up to, but not including @end_pos. + Delete text @start_pos up to, but not including @end_pos. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position - Insert text at a given position. + Insert text at a given position. - an #AtkEditableText + an #AtkEditableText - the text to insert + the text to insert - the length of text to insert, in bytes + the length of text to insert, in bytes - The caller initializes this to + The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text. @@ -4030,99 +2824,71 @@ points at the position after the newly inserted text. - Paste text from clipboard to specified @position. + Paste text from clipboard to specified @position. - an #AtkEditableText + an #AtkEditableText - position to paste + position to paste - - Sets the attributes for a specified range. See the ATK_ATTRIBUTE + + Sets the attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets. - %TRUE if attributes successfully set for the specified + %TRUE if attributes successfully set for the specified range, otherwise %FALSE - an #AtkEditableText + an #AtkEditableText - an #AtkAttributeSet + an #AtkAttributeSet - start of range in which to set attributes + start of range in which to set attributes - end of range in which to set attributes + end of range in which to set attributes - - Set text contents of @text. + + Set text contents of @text. - an #AtkEditableText + an #AtkEditableText - string to set for text contents of @text + string to set for text contents of @text - + @@ -4131,35 +2897,25 @@ range, otherwise %FALSE - %TRUE if attributes successfully set for the specified + %TRUE if attributes successfully set for the specified range, otherwise %FALSE - an #AtkEditableText + an #AtkEditableText - an #AtkAttributeSet + an #AtkAttributeSet - start of range in which to set attributes + start of range in which to set attributes - end of range in which to set attributes + end of range in which to set attributes @@ -4173,15 +2929,11 @@ range, otherwise %FALSE - an #AtkEditableText + an #AtkEditableText - string to set for text contents of @text + string to set for text contents of @text @@ -4195,27 +2947,19 @@ range, otherwise %FALSE - an #AtkEditableText + an #AtkEditableText - the text to insert + the text to insert - the length of text to insert, in bytes + the length of text to insert, in bytes - The caller initializes this to + The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text. @@ -4231,21 +2975,15 @@ points at the position after the newly inserted text. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position @@ -4259,21 +2997,15 @@ points at the position after the newly inserted text. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position @@ -4287,21 +3019,15 @@ points at the position after the newly inserted text. - an #AtkEditableText + an #AtkEditableText - start position + start position - end position + end position @@ -4315,15 +3041,11 @@ points at the position after the newly inserted text. - an #AtkEditableText + an #AtkEditableText - position to paste + position to paste @@ -4331,9 +3053,7 @@ points at the position after the newly inserted text. - A function which is called when an object emits a matching event, + A function which is called when an object emits a matching event, as used in #atk_add_focus_tracker. Currently the only events for which object-specific handlers are supported are events of type "focus:". Most clients of ATK will prefer to @@ -4346,18 +3066,14 @@ see atk_add_focus_tracker. - An #AtkObject instance for whom the callback will be called when + An #AtkObject instance for whom the callback will be called when the specified event (e.g. 'focus:') takes place. - An #AtkEventListenerInit function is a special function that is + An #AtkEventListenerInit function is a special function that is called in order to initialize the per-object event registration system used by #AtkEventListener, if any preparation is required. @@ -4367,13 +3083,8 @@ see atk_focus_tracker_init. - - The type of callback function used for + + The type of callback function used for atk_component_add_focus_handler() and atk_component_remove_focus_handler() Deprecated with atk_component_add_focus_handler() @@ -4385,126 +3096,84 @@ methods for more information. - the #AtkObject that receives/lose the focus + the #AtkObject that receives/lose the focus - TRUE if the object receives the focus + TRUE if the object receives the focus - An AtkFunction is a function definition used for padding which has + An AtkFunction is a function definition used for padding which has been added to class and interface structures to allow for expansion in the future. - not used + not used - - custom data defined by the user + + custom data defined by the user - + - + - + - - This object class is derived from AtkObject. It can be used as a + + This object class is derived from AtkObject. It can be used as a basis for implementing accessible objects for GObjects which are not derived from GtkWidget. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library. - - Gets the accessible object for the specified @obj. + + Gets the accessible object for the specified @obj. - a #AtkObject which is the accessible object for + a #AtkObject which is the accessible object for the @obj - a #GObject + a #GObject - - Gets the GObject for which @obj is the accessible object. + + Gets the GObject for which @obj is the accessible object. - a #GObject which is the object for which @obj is + a #GObject which is the object for which @obj is the accessible object - a #AtkGObjectAccessible + a #AtkGObjectAccessible @@ -4513,9 +3182,7 @@ the accessible object - + @@ -4527,79 +3194,57 @@ the accessible object - + - + - + - + - + - + - + - - An ATK object which encapsulates a link or set of links (for + + An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it @@ -4608,49 +3253,35 @@ AtkHypertext object. - Gets the index with the hypertext document at which this link ends. + Gets the index with the hypertext document at which this link ends. - the index with the hypertext document at which this link ends + the index with the hypertext document at which this link ends - an #AtkHyperlink + an #AtkHyperlink - Gets the number of anchors associated with this hyperlink. + Gets the number of anchors associated with this hyperlink. - the number of anchors associated with this hyperlink + the number of anchors associated with this hyperlink - an #AtkHyperlink + an #AtkHyperlink - Returns the item associated with this hyperlinks nth anchor. + Returns the item associated with this hyperlinks nth anchor. For instance, the returned #AtkObject will implement #AtkText if @link_ is a text hyperlink, #AtkImage if @link_ is an image hyperlink etc. @@ -4658,120 +3289,84 @@ hyperlink etc. Multiple anchors are primarily used by client-side image maps. - an #AtkObject associated with this hyperlinks + an #AtkObject associated with this hyperlinks i-th anchor - an #AtkHyperlink + an #AtkHyperlink - a (zero-index) integer specifying the desired anchor + a (zero-index) integer specifying the desired anchor - Gets the index with the hypertext document at which this link begins. + Gets the index with the hypertext document at which this link begins. - the index with the hypertext document at which this link begins + the index with the hypertext document at which this link begins - an #AtkHyperlink + an #AtkHyperlink - Get a the URI associated with the anchor specified + Get a the URI associated with the anchor specified by @i of @link_. Multiple anchors are primarily used by client-side image maps. - a string specifying the URI + a string specifying the URI - an #AtkHyperlink + an #AtkHyperlink - a (zero-index) integer specifying the desired anchor + a (zero-index) integer specifying the desired anchor - - Determines whether this AtkHyperlink is selected + + Determines whether this AtkHyperlink is selected Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links. - True if the AtkHyperlink is selected, False otherwise + True if the AtkHyperlink is selected, False otherwise - an #AtkHyperlink + an #AtkHyperlink - Since the document that a link is associated with may have changed + Since the document that a link is associated with may have changed this method returns %TRUE if the link is still valid (with respect to the document it references) and %FALSE otherwise. - whether or not this link is still valid + whether or not this link is still valid - an #AtkHyperlink + an #AtkHyperlink @@ -4799,49 +3394,35 @@ respect to the document it references) and %FALSE otherwise. - Gets the index with the hypertext document at which this link ends. + Gets the index with the hypertext document at which this link ends. - the index with the hypertext document at which this link ends + the index with the hypertext document at which this link ends - an #AtkHyperlink + an #AtkHyperlink - Gets the number of anchors associated with this hyperlink. + Gets the number of anchors associated with this hyperlink. - the number of anchors associated with this hyperlink + the number of anchors associated with this hyperlink - an #AtkHyperlink + an #AtkHyperlink - Returns the item associated with this hyperlinks nth anchor. + Returns the item associated with this hyperlinks nth anchor. For instance, the returned #AtkObject will implement #AtkText if @link_ is a text hyperlink, #AtkImage if @link_ is an image hyperlink etc. @@ -4849,144 +3430,101 @@ hyperlink etc. Multiple anchors are primarily used by client-side image maps. - an #AtkObject associated with this hyperlinks + an #AtkObject associated with this hyperlinks i-th anchor - an #AtkHyperlink + an #AtkHyperlink - a (zero-index) integer specifying the desired anchor + a (zero-index) integer specifying the desired anchor - - Gets the index with the hypertext document at which this link begins. + + Gets the index with the hypertext document at which this link begins. - the index with the hypertext document at which this link begins + the index with the hypertext document at which this link begins - an #AtkHyperlink + an #AtkHyperlink - Get a the URI associated with the anchor specified + Get a the URI associated with the anchor specified by @i of @link_. Multiple anchors are primarily used by client-side image maps. - a string specifying the URI + a string specifying the URI - an #AtkHyperlink + an #AtkHyperlink - a (zero-index) integer specifying the desired anchor + a (zero-index) integer specifying the desired anchor - Indicates whether the link currently displays some or all of its + Indicates whether the link currently displays some or all of its content inline. Ordinary HTML links will usually return %FALSE, but an inline &lt;src&gt; HTML element will return %TRUE. - whether or not this link displays its content inline. + whether or not this link displays its content inline. - an #AtkHyperlink + an #AtkHyperlink - - Determines whether this AtkHyperlink is selected + + Determines whether this AtkHyperlink is selected Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links. - True if the AtkHyperlink is selected, False otherwise + True if the AtkHyperlink is selected, False otherwise - an #AtkHyperlink + an #AtkHyperlink - Since the document that a link is associated with may have changed + Since the document that a link is associated with may have changed this method returns %TRUE if the link is still valid (with respect to the document it references) and %FALSE otherwise. - whether or not this link is still valid + whether or not this link is still valid - an #AtkHyperlink + an #AtkHyperlink @@ -4997,13 +3535,8 @@ respect to the document it references) and %FALSE otherwise. - - Selected link + + Selected link Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links. @@ -5015,17 +3548,13 @@ ATK_STATE_FOCUSED for focused links. - The signal link-activated is emitted when a link is activated. + The signal link-activated is emitted when a link is activated. - + @@ -5034,22 +3563,16 @@ ATK_STATE_FOCUSED for focused links. - a string specifying the URI + a string specifying the URI - an #AtkHyperlink + an #AtkHyperlink - a (zero-index) integer specifying the desired anchor + a (zero-index) integer specifying the desired anchor @@ -5059,23 +3582,17 @@ ATK_STATE_FOCUSED for focused links. - an #AtkObject associated with this hyperlinks + an #AtkObject associated with this hyperlinks i-th anchor - an #AtkHyperlink + an #AtkHyperlink - a (zero-index) integer specifying the desired anchor + a (zero-index) integer specifying the desired anchor @@ -5085,16 +3602,12 @@ i-th anchor - the index with the hypertext document at which this link ends + the index with the hypertext document at which this link ends - an #AtkHyperlink + an #AtkHyperlink @@ -5104,16 +3617,12 @@ i-th anchor - the index with the hypertext document at which this link begins + the index with the hypertext document at which this link begins - an #AtkHyperlink + an #AtkHyperlink @@ -5123,16 +3632,12 @@ i-th anchor - whether or not this link is still valid + whether or not this link is still valid - an #AtkHyperlink + an #AtkHyperlink @@ -5142,16 +3647,12 @@ i-th anchor - the number of anchors associated with this hyperlink + the number of anchors associated with this hyperlink - an #AtkHyperlink + an #AtkHyperlink @@ -5174,16 +3675,12 @@ i-th anchor - True if the AtkHyperlink is selected, False otherwise + True if the AtkHyperlink is selected, False otherwise - an #AtkHyperlink + an #AtkHyperlink @@ -5206,15 +3703,8 @@ i-th anchor - - AtkHyperlinkImpl allows AtkObjects to refer to their associated + + AtkHyperlinkImpl allows AtkObjects to refer to their associated AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas AtkHyperlink is a object type. The AtkHyperlinkImpl interface @@ -5243,56 +3733,38 @@ reasons, AtkHyperlink was defined as an object type, not an interface. Thus, in order to interact with AtkObjects via AtkHyperlink semantics, a new interface was required. - - Gets the hyperlink associated with this object. + + Gets the hyperlink associated with this object. - an AtkHyperlink object which points to this + an AtkHyperlink object which points to this implementing AtkObject. - a #GObject instance that implements AtkHyperlinkImplIface + a #GObject instance that implements AtkHyperlinkImplIface - - Gets the hyperlink associated with this object. + + Gets the hyperlink associated with this object. - an AtkHyperlink object which points to this + an AtkHyperlink object which points to this implementing AtkObject. - a #GObject instance that implements AtkHyperlinkImplIface + a #GObject instance that implements AtkHyperlinkImplIface - + @@ -5301,48 +3773,27 @@ implementing AtkObject. - an AtkHyperlink object which points to this + an AtkHyperlink object which points to this implementing AtkObject. - a #GObject instance that implements AtkHyperlinkImplIface + a #GObject instance that implements AtkHyperlinkImplIface - - Describes the type of link - - Link is inline + + Describes the type of link + + Link is inline - - An interface used for objects which implement linking between + + An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. A Hypertext instance is associated with one or more Hyperlinks, which are associated with particular @@ -5352,77 +3803,55 @@ Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets. - Gets the link in this hypertext document at index + Gets the link in this hypertext document at index @link_index - the link in this hypertext document at + the link in this hypertext document at index @link_index - an #AtkHypertext + an #AtkHypertext - an integer specifying the desired link + an integer specifying the desired link - Gets the index into the array of hyperlinks that is associated with + Gets the index into the array of hyperlinks that is associated with the character specified by @char_index. - an index into the array of hyperlinks in @hypertext, + an index into the array of hyperlinks in @hypertext, or -1 if there is no hyperlink associated with this character. - an #AtkHypertext + an #AtkHypertext - a character index + a character index - Gets the number of links within this hypertext document. + Gets the number of links within this hypertext document. - the number of links within this hypertext document + the number of links within this hypertext document - an #AtkHypertext + an #AtkHypertext @@ -5442,86 +3871,61 @@ or -1 if there is no hyperlink associated with this character. - Gets the link in this hypertext document at index + Gets the link in this hypertext document at index @link_index - the link in this hypertext document at + the link in this hypertext document at index @link_index - an #AtkHypertext + an #AtkHypertext - an integer specifying the desired link + an integer specifying the desired link - - Gets the index into the array of hyperlinks that is associated with + + Gets the index into the array of hyperlinks that is associated with the character specified by @char_index. - an index into the array of hyperlinks in @hypertext, + an index into the array of hyperlinks in @hypertext, or -1 if there is no hyperlink associated with this character. - an #AtkHypertext + an #AtkHypertext - a character index + a character index - Gets the number of links within this hypertext document. + Gets the number of links within this hypertext document. - the number of links within this hypertext document + the number of links within this hypertext document - an #AtkHypertext + an #AtkHypertext - The "link-selected" signal is emitted by an AtkHyperText + The "link-selected" signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected. @@ -5529,17 +3933,13 @@ is selected. - the index of the hyperlink which is selected + the index of the hyperlink which is selected - + @@ -5548,23 +3948,17 @@ is selected. - the link in this hypertext document at + the link in this hypertext document at index @link_index - an #AtkHypertext + an #AtkHypertext - an integer specifying the desired link + an integer specifying the desired link @@ -5574,16 +3968,12 @@ index @link_index - the number of links within this hypertext document + the number of links within this hypertext document - an #AtkHypertext + an #AtkHypertext @@ -5593,23 +3983,17 @@ index @link_index - an index into the array of hyperlinks in @hypertext, + an index into the array of hyperlinks in @hypertext, or -1 if there is no hyperlink associated with this character. - an #AtkHypertext + an #AtkHypertext - a character index + a character index @@ -5639,441 +4023,337 @@ or -1 if there is no hyperlink associated with this character. - + - + - + - - Like atk_get_interface_age(), but from the headers used at + + Like atk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - #AtkImage should be implemented by #AtkObject subtypes on behalf of + + #AtkImage should be implemented by #AtkObject subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, @@ -6087,55 +4367,38 @@ descriptive information is provided for alternative, text-only presentation of the most significant information present in the image. - - Get a textual description of this image. + + Get a textual description of this image. - a string representing the image description + a string representing the image description - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - Retrieves the locale identifier associated to the #AtkImage. + + Retrieves the locale identifier associated to the #AtkImage. - a string corresponding to the POSIX + a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or %NULL if the image does not specify a locale. - An #AtkImage + An #AtkImage - Gets the position of the image in the form of a point specifying the + Gets the position of the image in the form of a point specifying the images top-left corner. If the position can not be obtained (e.g. missing support), x and y are set @@ -6146,46 +4409,26 @@ to -1. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. + + address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. - - address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. + + address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Get the width and height in pixels for the specified image. + Get the width and height in pixels for the specified image. The values of @width and @height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen). @@ -6197,113 +4440,70 @@ to -1. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - filled with the image width, or -1 if the value cannot be obtained. + + filled with the image width, or -1 if the value cannot be obtained. - - filled with the image height, or -1 if the value cannot be obtained. + + filled with the image height, or -1 if the value cannot be obtained. - - Sets the textual description for this image. + + Sets the textual description for this image. - boolean TRUE, or FALSE if operation could + boolean TRUE, or FALSE if operation could not be completed. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - a string description to set for @image + a string description to set for @image - - Get a textual description of this image. + + Get a textual description of this image. - a string representing the image description + a string representing the image description - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - Retrieves the locale identifier associated to the #AtkImage. + + Retrieves the locale identifier associated to the #AtkImage. - a string corresponding to the POSIX + a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or %NULL if the image does not specify a locale. - An #AtkImage + An #AtkImage - - Gets the position of the image in the form of a point specifying the + + Gets the position of the image in the form of a point specifying the images top-left corner. If the position can not be obtained (e.g. missing support), x and y are set @@ -6314,46 +4514,26 @@ to -1. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. + + address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. - - address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. + + address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window - Get the width and height in pixels for the specified image. + Get the width and height in pixels for the specified image. The values of @width and @height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen). @@ -6365,67 +4545,40 @@ to -1. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - filled with the image width, or -1 if the value cannot be obtained. + + filled with the image width, or -1 if the value cannot be obtained. - - filled with the image height, or -1 if the value cannot be obtained. + + filled with the image height, or -1 if the value cannot be obtained. - - Sets the textual description for this image. + + Sets the textual description for this image. - boolean TRUE, or FALSE if operation could + boolean TRUE, or FALSE if operation could not be completed. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - a string description to set for @image + a string description to set for @image - + @@ -6438,37 +4591,19 @@ not be completed. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. + + address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. - - address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. + + address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. - specifies whether the coordinates are relative to the screen + specifies whether the coordinates are relative to the screen or to the components top level window @@ -6479,16 +4614,12 @@ or to the components top level window - a string representing the image description + a string representing the image description - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface @@ -6502,31 +4633,15 @@ or to the components top level window - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - - filled with the image width, or -1 if the value cannot be obtained. + + filled with the image width, or -1 if the value cannot be obtained. - - filled with the image height, or -1 if the value cannot be obtained. + + filled with the image height, or -1 if the value cannot be obtained. @@ -6536,23 +4651,17 @@ or to the components top level window - boolean TRUE, or FALSE if operation could + boolean TRUE, or FALSE if operation could not be completed. - a #GObject instance that implements AtkImageIface + a #GObject instance that implements AtkImageIface - a string description to set for @image + a string description to set for @image @@ -6562,18 +4671,14 @@ not be completed. - a string corresponding to the POSIX + a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or %NULL if the image does not specify a locale. - An #AtkImage + An #AtkImage @@ -6582,142 +4687,89 @@ not be completed. - - Gets a reference to an object's #AtkObject implementation, if + + Gets a reference to an object's #AtkObject implementation, if the object implements #AtkObjectIface - a reference to an object's #AtkObject + a reference to an object's #AtkObject implementation - The #GObject instance which should implement #AtkImplementorIface + The #GObject instance which should implement #AtkImplementorIface if a non-null return value is required. - - The AtkImplementor interface is implemented by objects for which + + The AtkImplementor interface is implemented by objects for which AtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor); - Encapsulates information about a key event. + Encapsulates information about a key event. - An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE + An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE - A bitmask representing the state of the modifier keys immediately after the event takes place. + A bitmask representing the state of the modifier keys immediately after the event takes place. The meaning of the bits is currently defined to match the bitmask used by GDK in GdkEventType.state, see http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html#GdkEventKey - A guint representing a keysym value corresponding to those used by GDK and X11: see + A guint representing a keysym value corresponding to those used by GDK and X11: see /usr/X11/include/keysymdef.h. - The length of member #string. + The length of member #string. - A string containing one of the following: either a string approximating the text that would + A string containing one of the following: either a string approximating the text that would result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress. Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0", "semicolon", "aacute". Keypad keys have the prefix "KP". - The raw hardware code that generated the key event. This field is raraly useful. + The raw hardware code that generated the key event. This field is raraly useful. - A timestamp in milliseconds indicating when the event occurred. + A timestamp in milliseconds indicating when the event occurred. These timestamps are relative to a starting point which should be considered arbitrary, and only used to compare the dispatch times of events to one another. - - Specifies the type of a keyboard evemt. - - specifies a key press event + + Specifies the type of a keyboard evemt. + + specifies a key press event - - specifies a key release event + + specifies a key release event - - Not a valid value; specifies end of enumeration + + Not a valid value; specifies end of enumeration - An #AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs, + An #AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs, if registered via atk_add_key_event_listener. It allows for pre-emptive interception of key events via the return code as described below. - TRUE (nonzero) if the event emission should be stopped and the event + TRUE (nonzero) if the event emission should be stopped and the event discarded without being passed to the normal GUI recipient; FALSE (zero) if the event dispatch to the client application should proceed as normal. @@ -6726,131 +4778,63 @@ see atk_add_key_event_listener. - an AtkKeyEventStruct containing information about the key event for which + an AtkKeyEventStruct containing information about the key event for which notification is being given. - - a block of data which will be passed to the event listener, on notification. + + a block of data which will be passed to the event listener, on notification. - - Describes the layer of a component + + Describes the layer of a component These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another. - - The object does not have a layer + + The object does not have a layer - - This layer is reserved for the desktop background + + This layer is reserved for the desktop background - - This layer is used for Canvas components + + This layer is used for Canvas components - - This layer is normally used for components + + This layer is normally used for components - - This layer is used for layered components + + This layer is used for layered components - - This layer is used for popup components, such as menus + + This layer is used for popup components, such as menus - - This layer is reserved for future use. + + This layer is reserved for future use. - - This layer is used for toplevel windows. + + This layer is used for toplevel windows. - - Like atk_get_major_version(), but from the headers used at + + Like atk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. - - Like atk_get_micro_version(), but from the headers used at + + Like atk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. - - Like atk_get_minor_version(), but from the headers used at + + Like atk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. @@ -6863,59 +4847,35 @@ against at application run time. - + - + - - A set of utility functions for thread locking. This interface and + + A set of utility functions for thread locking. This interface and all his related methods are deprecated since 2.12. - - Obtain the singleton instance of AtkMisc for this application. + + Obtain the singleton instance of AtkMisc for this application. Since 2.12. - The singleton instance of AtkMisc for this application. + The singleton instance of AtkMisc for this application. - - Take the thread mutex for the GUI toolkit, + + Take the thread mutex for the GUI toolkit, if one exists. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER). @@ -6926,20 +4886,13 @@ if one exists. - an AtkMisc instance for this application. + an AtkMisc instance for this application. - - Release the thread mutex for the GUI toolkit, + + Release the thread mutex for the GUI toolkit, if one exists. This method, and atk_misc_threads_enter, are needed in some situations by threaded application code which services ATK requests, since fulfilling ATK requests often @@ -6955,20 +4908,13 @@ be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. - an AtkMisc instance for this application. + an AtkMisc instance for this application. - - Take the thread mutex for the GUI toolkit, + + Take the thread mutex for the GUI toolkit, if one exists. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER). @@ -6979,20 +4925,13 @@ if one exists. - an AtkMisc instance for this application. + an AtkMisc instance for this application. - - Release the thread mutex for the GUI toolkit, + + Release the thread mutex for the GUI toolkit, if one exists. This method, and atk_misc_threads_enter, are needed in some situations by threaded application code which services ATK requests, since fulfilling ATK requests often @@ -7008,9 +4947,7 @@ be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. - an AtkMisc instance for this application. + an AtkMisc instance for this application. @@ -7019,12 +4956,8 @@ be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. - - Usage of AtkMisc is deprecated since 2.12 and heavily discouraged. + + Usage of AtkMisc is deprecated since 2.12 and heavily discouraged. @@ -7037,9 +4970,7 @@ be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. - an AtkMisc instance for this application. + an AtkMisc instance for this application. @@ -7053,9 +4984,7 @@ be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. - an AtkMisc instance for this application. + an AtkMisc instance for this application. @@ -7067,70 +4996,50 @@ be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. - + - + - + - + - + - + - - An AtkNoOpObject is an AtkObject which purports to implement all + + An AtkNoOpObject is an AtkObject which purports to implement all ATK interfaces. It is the type of AtkObject which is created if an accessible object is requested for an object type for which no factory type is specified. @@ -7148,22 +5057,16 @@ factory type is specified. - Provides a default (non-functioning stub) #AtkObject. + Provides a default (non-functioning stub) #AtkObject. Application maintainers should not use this method. - a default (non-functioning stub) #AtkObject + a default (non-functioning stub) #AtkObject - a #GObject + a #GObject @@ -7172,37 +5075,23 @@ Application maintainers should not use this method. - + - - The AtkObjectFactory which creates an AtkNoOpObject. An instance of + + The AtkObjectFactory which creates an AtkNoOpObject. An instance of this is created by an AtkRegistry if no factory type has not been specified to create an accessible object of a particular type. - Creates an instance of an #AtkObjectFactory which generates primitive + Creates an instance of an #AtkObjectFactory which generates primitive (non-functioning) #AtkObjects. - an instance of an #AtkObjectFactory + an instance of an #AtkObjectFactory @@ -7210,9 +5099,7 @@ specified to create an accessible object of a particular type. - + @@ -7225,61 +5112,43 @@ specified to create an accessible object of a particular type. - + - + - + - + - + - - This class is the primary class for accessibility support via the + + This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of #AtkObject (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI @@ -7309,10 +5178,7 @@ See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also - + @@ -7329,45 +5195,29 @@ See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also - + - - Calls @handler on property changes. + + Calls @handler on property changes. Connect directly to #AtkObject::property-change or the relevant #GObject::notify signal for each desired property. - a #guint which is the handler id used in + a #guint which is the handler id used in atk_object_remove_property_change_handler() - an #AtkObject + an #AtkObject - a function to be called when a property changes its value - + a function to be called when a property changes its value + @@ -7385,20 +5235,14 @@ See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also - - Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of + + Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" #AtkAttributeSet properties. - an #AtkAttributeSet consisting of all + an #AtkAttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to @@ -7407,98 +5251,70 @@ atk_attribute_set_free(). - An #AtkObject. + An #AtkObject. - Gets the accessible description of the accessible. + Gets the accessible description of the accessible. - a character string representing the accessible description + a character string representing the accessible description of the accessible. - an #AtkObject + an #AtkObject - Gets the 0-based index of this accessible in its parent; returns -1 if the + Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. - an integer which is the index of the accessible in its parent + an integer which is the index of the accessible in its parent - an #AtkObject + an #AtkObject - Gets the layer of the accessible. + Gets the layer of the accessible. Use atk_component_get_layer instead. - an #AtkLayer which is the layer of the accessible + an #AtkLayer which is the layer of the accessible - an #AtkObject + an #AtkObject - - Gets the zorder of the accessible. The value G_MININT will be returned + + Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI. Use atk_component_get_mdi_zorder instead. - a gint which is the zorder of the accessible, i.e. the depth at + a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container. - an #AtkObject + an #AtkObject @@ -7515,53 +5331,37 @@ container. - Gets the accessible name of the accessible. + Gets the accessible name of the accessible. - a character string representing the accessible name of the object. + a character string representing the accessible name of the object. - an #AtkObject + an #AtkObject - - Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale + + Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible. - a UTF-8 string indicating the POSIX-style LC_MESSAGES + a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible. - an #AtkObject + an #AtkObject - Gets the accessible parent of the accessible. By default this is + Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with @@ -7571,45 +5371,33 @@ If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent(). - an #AtkObject representing the accessible + an #AtkObject representing the accessible parent of the accessible - an #AtkObject + an #AtkObject - Gets the role of the accessible. + Gets the role of the accessible. - an #AtkRole which is the role of the accessible + an #AtkRole which is the role of the accessible - an #AtkObject + an #AtkObject - This function is called when implementing subclasses of #AtkObject. + This function is called when implementing subclasses of #AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of #AtkObject @@ -7619,18 +5407,11 @@ to create an instance of a subclass of #AtkObject - a #AtkObject + a #AtkObject - - a #gpointer which identifies the object for which the AtkObject was created. + + a #gpointer which identifies the object for which the AtkObject was created. @@ -7664,55 +5445,38 @@ to create an instance of a subclass of #AtkObject - Gets the #AtkRelationSet associated with the object. + Gets the #AtkRelationSet associated with the object. - an #AtkRelationSet representing the relation set + an #AtkRelationSet representing the relation set of the object. - an #AtkObject + an #AtkObject - Gets a reference to the state set of the accessible; the caller must + Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. - a reference to an #AtkStateSet which is the state + a reference to an #AtkStateSet which is the state set of the accessible - an #AtkObject + an #AtkObject - - Removes a property change handler. + + Removes a property change handler. See atk_object_connect_property_change_handler() @@ -7720,23 +5484,17 @@ set of the accessible - an #AtkObject + an #AtkObject - a guint which identifies the handler to be removed. + a guint which identifies the handler to be removed. - Sets the accessible description of the accessible. You can't set + Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "". @@ -7746,23 +5504,17 @@ the name to a empty value you can use "". - an #AtkObject + an #AtkObject - a character string to be set as the accessible description + a character string to be set as the accessible description - Sets the accessible name of the accessible. You can't set the name + Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "". @@ -7772,61 +5524,45 @@ a empty value you can use "". - an #AtkObject + an #AtkObject - a character string to be set as the accessible name + a character string to be set as the accessible name - Sets the accessible parent of the accessible. @parent can be NULL. + Sets the accessible parent of the accessible. @parent can be NULL. - an #AtkObject + an #AtkObject - an #AtkObject to be set as the accessible parent + an #AtkObject to be set as the accessible parent - Sets the role of the accessible. + Sets the role of the accessible. - an #AtkObject + an #AtkObject - an #AtkRole to be set as the role + an #AtkRole to be set as the role @@ -7859,110 +5595,72 @@ a empty value you can use "". - - Adds a relationship of the specified type with the specified target. + + Adds a relationship of the specified type with the specified target. - TRUE if the relationship is added. + TRUE if the relationship is added. - The #AtkObject to which an AtkRelation is to be added. + The #AtkObject to which an AtkRelation is to be added. - The #AtkRelationType of the relation + The #AtkRelationType of the relation - The #AtkObject which is to be the target of the relation. + The #AtkObject which is to be the target of the relation. - - Calls @handler on property changes. + + Calls @handler on property changes. Connect directly to #AtkObject::property-change or the relevant #GObject::notify signal for each desired property. - a #guint which is the handler id used in + a #guint which is the handler id used in atk_object_remove_property_change_handler() - an #AtkObject + an #AtkObject - a function to be called when a property changes its value - + a function to be called when a property changes its value + - - Gets the accessible id of the accessible. + + Gets the accessible id of the accessible. - a character string representing the accessible id of the object, or + a character string representing the accessible id of the object, or NULL if no such string was set. - an #AtkObject + an #AtkObject - - Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of + + Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" #AtkAttributeSet properties. - an #AtkAttributeSet consisting of all + an #AtkAttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to @@ -7971,175 +5669,121 @@ atk_attribute_set_free(). - An #AtkObject. + An #AtkObject. - Gets the accessible description of the accessible. + Gets the accessible description of the accessible. - a character string representing the accessible description + a character string representing the accessible description of the accessible. - an #AtkObject + an #AtkObject - - Gets the 0-based index of this accessible in its parent; returns -1 if the + + Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. - an integer which is the index of the accessible in its parent + an integer which is the index of the accessible in its parent - an #AtkObject + an #AtkObject - - Gets the layer of the accessible. + + Gets the layer of the accessible. Use atk_component_get_layer instead. - an #AtkLayer which is the layer of the accessible + an #AtkLayer which is the layer of the accessible - an #AtkObject + an #AtkObject - - Gets the zorder of the accessible. The value G_MININT will be returned + + Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI. Use atk_component_get_mdi_zorder instead. - a gint which is the zorder of the accessible, i.e. the depth at + a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container. - an #AtkObject + an #AtkObject - - Gets the number of accessible children of the accessible. + + Gets the number of accessible children of the accessible. - an integer representing the number of accessible children + an integer representing the number of accessible children of the accessible. - an #AtkObject + an #AtkObject - Gets the accessible name of the accessible. + Gets the accessible name of the accessible. - a character string representing the accessible name of the object. + a character string representing the accessible name of the object. - an #AtkObject + an #AtkObject - - Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale + + Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible. - a UTF-8 string indicating the POSIX-style LC_MESSAGES + a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible. - an #AtkObject + an #AtkObject - Gets the accessible parent of the accessible. By default this is + Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with @@ -8149,45 +5793,33 @@ If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent(). - an #AtkObject representing the accessible + an #AtkObject representing the accessible parent of the accessible - an #AtkObject + an #AtkObject - Gets the role of the accessible. + Gets the role of the accessible. - an #AtkRole which is the role of the accessible + an #AtkRole which is the role of the accessible - an #AtkObject + an #AtkObject - This function is called when implementing subclasses of #AtkObject. + This function is called when implementing subclasses of #AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of #AtkObject @@ -8197,27 +5829,17 @@ to create an instance of a subclass of #AtkObject - a #AtkObject + a #AtkObject - - a #gpointer which identifies the object for which the AtkObject was created. + + a #gpointer which identifies the object for which the AtkObject was created. - - Emits a state-change signal for the specified state. + + Emits a state-change signal for the specified state. Note that as a general rule when the state of an existing object changes, emitting a notification is expected. @@ -8227,29 +5849,21 @@ emitting a notification is expected. - an #AtkObject + an #AtkObject - an #AtkState whose state is changed + an #AtkState whose state is changed - a gboolean which indicates whether the state is being set on or off + a gboolean which indicates whether the state is being set on or off - Gets the accessible parent of the accessible, if it has been + Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns %NULL. @@ -8258,102 +5872,71 @@ to be exposed to accessible tools. See atk_object_get_parent() for further reference. - an #AtkObject representing the accessible + an #AtkObject representing the accessible parent of the accessible if assigned - an #AtkObject + an #AtkObject - - Gets a reference to the specified accessible child of the object. + + Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on. - an #AtkObject representing the specified + an #AtkObject representing the specified accessible child of the accessible. - an #AtkObject + an #AtkObject - a gint representing the position of the child, starting from 0 + a gint representing the position of the child, starting from 0 - - Gets the #AtkRelationSet associated with the object. + + Gets the #AtkRelationSet associated with the object. - an #AtkRelationSet representing the relation set + an #AtkRelationSet representing the relation set of the object. - an #AtkObject + an #AtkObject - Gets a reference to the state set of the accessible; the caller must + Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. - a reference to an #AtkStateSet which is the state + a reference to an #AtkStateSet which is the state set of the accessible - an #AtkObject + an #AtkObject - - Removes a property change handler. + + Removes a property change handler. See atk_object_connect_property_change_handler() @@ -8361,58 +5944,39 @@ set of the accessible - an #AtkObject + an #AtkObject - a guint which identifies the handler to be removed. + a guint which identifies the handler to be removed. - - Removes a relationship of the specified type with the specified target. + + Removes a relationship of the specified type with the specified target. - TRUE if the relationship is removed. + TRUE if the relationship is removed. - The #AtkObject from which an AtkRelation is to be removed. + The #AtkObject from which an AtkRelation is to be removed. - The #AtkRelationType of the relation + The #AtkRelationType of the relation - The #AtkObject which is the target of the relation to be removed. + The #AtkObject which is the target of the relation to be removed. - - Sets the accessible ID of the accessible. This is not meant to be presented + + Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen @@ -8423,23 +5987,17 @@ reading, or for automatic regression testing. - an #AtkObject + an #AtkObject - a character string to be set as the accessible id + a character string to be set as the accessible id - Sets the accessible description of the accessible. You can't set + Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "". @@ -8449,23 +6007,17 @@ the name to a empty value you can use "". - an #AtkObject + an #AtkObject - a character string to be set as the accessible description + a character string to be set as the accessible description - Sets the accessible name of the accessible. You can't set the name + Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "". @@ -8475,61 +6027,45 @@ a empty value you can use "". - an #AtkObject + an #AtkObject - a character string to be set as the accessible name + a character string to be set as the accessible name - Sets the accessible parent of the accessible. @parent can be NULL. + Sets the accessible parent of the accessible. @parent can be NULL. - an #AtkObject + an #AtkObject - an #AtkObject to be set as the accessible parent + an #AtkObject to be set as the accessible parent - Sets the role of the accessible. + Sets the role of the accessible. - an #AtkObject + an #AtkObject - an #AtkRole to be set as the role + an #AtkRole to be set as the role @@ -8537,13 +6073,10 @@ a empty value you can use "". - + - + @@ -8552,85 +6085,49 @@ a empty value you can use "". - + - - Table caption. + + Table caption. Since 1.3. Use table-caption-object instead. - + - - Accessible table column description. + + Accessible table column description. Since 2.12. Use atk_table_get_column_description() and atk_table_set_column_description() instead. - - Accessible table column header. + + Accessible table column header. Since 2.12. Use atk_table_get_column_header() and atk_table_set_column_header() instead. - - Accessible table row description. + + Accessible table row description. Since 2.12. Use atk_table_get_row_description() and atk_table_set_row_description() instead. - - Accessible table row header. + + Accessible table row header. Since 2.12. Use atk_table_get_row_header() and atk_table_set_row_header() instead. - + - - Numeric value of this object, in case being and AtkValue. + + Numeric value of this object, in case being and AtkValue. Since 2.12. Use atk_value_get_value_and_text() to get the value, and value-changed signal to be notified on their value changes. @@ -8658,9 +6155,7 @@ changes. - The "active-descendant-changed" signal is emitted by an object + The "active-descendant-changed" signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes. @@ -8669,17 +6164,13 @@ signal when the cell in the table which has focus changes. - the newly focused object. + the newly focused object. - The signal "children-changed" is emitted when a child is added or + The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove" @@ -8687,17 +6178,13 @@ removed form an object. It supports two details: "add" and - The index of the added or removed child. The value can be + The index of the added or removed child. The value can be -1. This is used if the value is not known by the implementor when the child is added/removed or irrelevant. - A gpointer to the child AtkObject which was added or + A gpointer to the child AtkObject which was added or removed. If the child was removed, it is possible that it is not available for the implementor. In that case this pointer can be NULL. @@ -8705,13 +6192,8 @@ NULL. - - The signal "focus-event" is emitted when an object gained or lost + + The signal "focus-event" is emitted when an object gained or lost focus. Use the #AtkObject::state-change signal instead. @@ -8719,18 +6201,14 @@ focus. - a boolean value which indicates whether the object gained + a boolean value which indicates whether the object gained or lost focus. - The signal "property-change" is emitted when an object's property + The signal "property-change" is emitted when an object's property value changes. @arg1 contains an #AtkPropertyValues with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not @@ -8748,18 +6226,14 @@ notify doesn't support emission hooks. - an #AtkPropertyValues containing the new + an #AtkPropertyValues containing the new value of the property which changed. - The "state-change" signal is emitted when an object's state + The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed. @@ -8767,32 +6241,24 @@ changed. - The name of the state which has changed + The name of the state which has changed - A boolean which indicates whether the state has been set or unset. + A boolean which indicates whether the state has been set or unset. - The "visible-data-changed" signal is emitted when the visual + The "visible-data-changed" signal is emitted when the visual appearance of the object changed. - + @@ -8801,16 +6267,12 @@ appearance of the object changed. - a character string representing the accessible name of the object. + a character string representing the accessible name of the object. - an #AtkObject + an #AtkObject @@ -8820,17 +6282,13 @@ appearance of the object changed. - a character string representing the accessible description + a character string representing the accessible description of the accessible. - an #AtkObject + an #AtkObject @@ -8840,17 +6298,13 @@ of the accessible. - an #AtkObject representing the accessible + an #AtkObject representing the accessible parent of the accessible - an #AtkObject + an #AtkObject @@ -8889,16 +6343,12 @@ parent of the accessible - an integer which is the index of the accessible in its parent + an integer which is the index of the accessible in its parent - an #AtkObject + an #AtkObject @@ -8908,17 +6358,13 @@ parent of the accessible - an #AtkRelationSet representing the relation set + an #AtkRelationSet representing the relation set of the object. - an #AtkObject + an #AtkObject @@ -8928,16 +6374,12 @@ of the object. - an #AtkRole which is the role of the accessible + an #AtkRole which is the role of the accessible - an #AtkObject + an #AtkObject @@ -8947,16 +6389,12 @@ of the object. - an #AtkLayer which is the layer of the accessible + an #AtkLayer which is the layer of the accessible - an #AtkObject + an #AtkObject @@ -8966,18 +6404,14 @@ of the object. - a gint which is the zorder of the accessible, i.e. the depth at + a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container. - an #AtkObject + an #AtkObject @@ -8987,17 +6421,13 @@ container. - a reference to an #AtkStateSet which is the state + a reference to an #AtkStateSet which is the state set of the accessible - an #AtkObject + an #AtkObject @@ -9011,15 +6441,11 @@ set of the accessible - an #AtkObject + an #AtkObject - a character string to be set as the accessible name + a character string to be set as the accessible name @@ -9033,15 +6459,11 @@ set of the accessible - an #AtkObject + an #AtkObject - a character string to be set as the accessible description + a character string to be set as the accessible description @@ -9055,15 +6477,11 @@ set of the accessible - an #AtkObject + an #AtkObject - an #AtkObject to be set as the accessible parent + an #AtkObject to be set as the accessible parent @@ -9077,15 +6495,11 @@ set of the accessible - an #AtkObject + an #AtkObject - an #AtkRole to be set as the role + an #AtkRole to be set as the role @@ -9095,25 +6509,18 @@ set of the accessible - a #guint which is the handler id used in + a #guint which is the handler id used in atk_object_remove_property_change_handler() - an #AtkObject + an #AtkObject - a function to be called when a property changes its value - + a function to be called when a property changes its value + @@ -9126,15 +6533,11 @@ set of the accessible - an #AtkObject + an #AtkObject - a guint which identifies the handler to be removed. + a guint which identifies the handler to be removed. @@ -9148,18 +6551,11 @@ set of the accessible - a #AtkObject + a #AtkObject - - a #gpointer which identifies the object for which the AtkObject was created. + + a #gpointer which identifies the object for which the AtkObject was created. @@ -9178,10 +6574,7 @@ set of the accessible - + @@ -9261,10 +6654,7 @@ set of the accessible - + @@ -9274,9 +6664,7 @@ set of the accessible - an #AtkAttributeSet consisting of all + an #AtkAttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to @@ -9285,9 +6673,7 @@ atk_attribute_set_free(). - An #AtkObject. + An #AtkObject. @@ -9297,17 +6683,13 @@ atk_attribute_set_free(). - a UTF-8 string indicating the POSIX-style LC_MESSAGES + a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible. - an #AtkObject + an #AtkObject @@ -9317,25 +6699,15 @@ atk_attribute_set_free(). - - This class is the base object class for a factory used to create an + + This class is the base object class for a factory used to create an accessible object for a specific GType. The function atk_registry_set_factory_type() is normally called to store in the registry the factory type to be used to create an accessible of a particular GType. - Inform @factory that it is no longer being used to create + Inform @factory that it is no longer being used to create accessibles. When called, @factory may need to inform #AtkObjects which it has created that they need to be re-instantiated. Note: primarily used for runtime replacement of #AtkObjectFactorys @@ -9346,69 +6718,49 @@ in object registries. - an #AtkObjectFactory to invalidate + an #AtkObjectFactory to invalidate - - Provides an #AtkObject that implements an accessibility interface + + Provides an #AtkObject that implements an accessibility interface on behalf of @obj - an #AtkObject that implements an accessibility + an #AtkObject that implements an accessibility interface on behalf of @obj - The #AtkObjectFactory associated with @obj's + The #AtkObjectFactory associated with @obj's object type - a #GObject + a #GObject - - Gets the GType of the accessible which is created by the factory. + + Gets the GType of the accessible which is created by the factory. - the type of the accessible which is created by the @factory. + the type of the accessible which is created by the @factory. The value G_TYPE_INVALID is returned if no type if found. - an #AtkObjectFactory + an #AtkObjectFactory - Inform @factory that it is no longer being used to create + Inform @factory that it is no longer being used to create accessibles. When called, @factory may need to inform #AtkObjects which it has created that they need to be re-instantiated. Note: primarily used for runtime replacement of #AtkObjectFactorys @@ -9419,9 +6771,7 @@ in object registries. - an #AtkObjectFactory to invalidate + an #AtkObjectFactory to invalidate @@ -9430,9 +6780,7 @@ in object registries. - + @@ -9458,9 +6806,7 @@ in object registries. - an #AtkObjectFactory to invalidate + an #AtkObjectFactory to invalidate @@ -9488,45 +6834,29 @@ in object registries. - + - + - - See #AtkSocket + + See #AtkSocket - Creates a new #AtkPlug instance. + Creates a new #AtkPlug instance. - the newly created #AtkPlug + the newly created #AtkPlug @@ -9542,9 +6872,7 @@ in object registries. - Gets the unique ID of an #AtkPlug object, which can be used to + Gets the unique ID of an #AtkPlug object, which can be used to embed inside of an #AtkSocket using atk_socket_embed(). Internally, this calls a class function that should be registered @@ -9554,60 +6882,21 @@ loaded) and pass the value to the process implementing the #AtkSocket, so it could embed the plug. - the unique ID for the plug + the unique ID for the plug - an #AtkPlug + an #AtkPlug - - Sets @child as accessible child of @plug and @plug as accessible parent of -@child. @child can be NULL. - -In some cases, one can not use the AtkPlug type directly as accessible -object for the toplevel widget of the application. For instance in the gtk -case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and -from AtkPlug. In such a case, one can create, in addition to the standard -accessible object for the toplevel widget, an AtkPlug object, and make the -former the child of the latter by calling atk_plug_set_child(). - - - - - - - an #AtkPlug to be set as accessible parent of @child. - - - - an #AtkObject to be set as accessible child of @plug. - - - - - + @@ -9626,12 +6915,8 @@ former the child of the latter by calling atk_plug_set_child(). - - An AtkPropertyChangeHandler is a function which is executed when an + + An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to atk_object_connect_property_change_handler(). Since 2.12. @@ -9641,320 +6926,218 @@ atk_object_connect_property_change_handler(). - atkobject which property changes + atkobject which property changes - values changed + values changed - Note: @old_value field of #AtkPropertyValues will not contain a + Note: @old_value field of #AtkPropertyValues will not contain a valid value. This is a field defined with the purpose of contain the previous value of the property, but is not used anymore. - The name of the ATK property which has changed. + The name of the ATK property which has changed. - NULL. This field is not used anymore. + NULL. This field is not used anymore. - The new value of the named property. + The new value of the named property. - + - + - + - + - + - + - + - + - + - - #AtkRange are used on #AtkValue, in order to represent the full + + #AtkRange are used on #AtkValue, in order to represent the full range of a given component (for example an slider or a range control), or to define each individual subrange this full range is splitted if available. See #AtkValue documentation for further details. - Creates a new #AtkRange. + Creates a new #AtkRange. - a new #AtkRange + a new #AtkRange - inferior limit for this range + inferior limit for this range - superior limit for this range + superior limit for this range - human readable description of this range. + human readable description of this range. - Returns a new #AtkRange that is a exact copy of @src + Returns a new #AtkRange that is a exact copy of @src - a new #AtkRange copy of @src + a new #AtkRange copy of @src - #AtkRange to copy + #AtkRange to copy - Free @range + Free @range - #AtkRange to free + #AtkRange to free - - Returns the human readable description of @range + + Returns the human readable description of @range - the human-readable description of @range + the human-readable description of @range - an #AtkRange + an #AtkRange - - Returns the lower limit of @range + + Returns the lower limit of @range - the lower limit of @range + the lower limit of @range - an #AtkRange + an #AtkRange - - Returns the upper limit of @range + + Returns the upper limit of @range - the upper limit of @range + the upper limit of @range - an #AtkRange + an #AtkRange - - A data structure for holding a rectangle. Those coordinates are + + A data structure for holding a rectangle. Those coordinates are relative to the component top-level parent. - X coordinate of the left side of the rectangle. + X coordinate of the left side of the rectangle. - Y coordinate of the top side of the rectangle. + Y coordinate of the top side of the rectangle. - width of the rectangle. + width of the rectangle. - height of the rectangle. + height of the rectangle. - - The AtkRegistry is normally used to create appropriate ATK "peers" + + The AtkRegistry is normally used to create appropriate ATK "peers" for user interface components. Application developers usually need only interact with the AtkRegistry by associating appropriate ATK implementation classes with GObject classes via the @@ -9962,67 +7145,47 @@ atk_registry_set_factory_type call, passing the appropriate GType for application custom widget classes. - Gets an #AtkObjectFactory appropriate for creating #AtkObjects + Gets an #AtkObjectFactory appropriate for creating #AtkObjects appropriate for @type. - an #AtkObjectFactory appropriate for creating + an #AtkObjectFactory appropriate for creating #AtkObjects appropriate for @type. - an #AtkRegistry + an #AtkRegistry - a #GType with which to look up the associated #AtkObjectFactory + a #GType with which to look up the associated #AtkObjectFactory - - Provides a #GType indicating the #AtkObjectFactory subclass + + Provides a #GType indicating the #AtkObjectFactory subclass associated with @type. - a #GType associated with type @type + a #GType associated with type @type - an #AtkRegistry + an #AtkRegistry - a #GType with which to look up the associated #AtkObjectFactory + a #GType with which to look up the associated #AtkObjectFactory subclass - - Associate an #AtkObjectFactory subclass with a #GType. Note: + + Associate an #AtkObjectFactory subclass with a #GType. Note: The associated @factory_type will thereafter be responsible for the creation of new #AtkObject implementations for instances appropriate for @type. @@ -10032,21 +7195,15 @@ appropriate for @type. - the #AtkRegistry in which to register the type association + the #AtkRegistry in which to register the type association - an #AtkObject type + an #AtkObject type - an #AtkObjectFactory type to associate with @type. Must + an #AtkObjectFactory type to associate with @type. Must implement AtkObject appropriate for @type. @@ -10068,71 +7225,47 @@ implement AtkObject appropriate for @type. - + - - An AtkRelation describes a relation between an object and one or + + An AtkRelation describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as an AtkRelationSet, which is a set of AtkRelations. - Create a new relation for the specified key and the specified list + Create a new relation for the specified key and the specified list of targets. See also atk_object_add_relationship(). - a pointer to a new #AtkRelation + a pointer to a new #AtkRelation - an array of pointers to + an array of pointers to #AtkObjects - number of #AtkObjects pointed to by @targets + number of #AtkObjects pointed to by @targets - an #AtkRelationType with which to create the new + an #AtkRelationType with which to create the new #AtkRelation - - Adds the specified AtkObject to the target for the relation, if it is + + Adds the specified AtkObject to the target for the relation, if it is not already present. See also atk_object_add_relationship(). @@ -10140,84 +7273,59 @@ not already present. See also atk_object_add_relationship(). - an #AtkRelation + an #AtkRelation - an #AtkObject + an #AtkObject - - Gets the type of @relation + + Gets the type of @relation - the type of @relation + the type of @relation - an #AtkRelation + an #AtkRelation - Gets the target list of @relation + Gets the target list of @relation - the target list of @relation + the target list of @relation - an #AtkRelation + an #AtkRelation - Remove the specified AtkObject from the target for the relation. + Remove the specified AtkObject from the target for the relation. - TRUE if the removal is successful. + TRUE if the removal is successful. - an #AtkRelation + an #AtkRelation - an #AtkObject + an #AtkObject @@ -10240,24 +7348,14 @@ not already present. See also atk_object_add_relationship(). - + - - The AtkRelationSet held by an object establishes its relationships + + The AtkRelationSet held by an object establishes its relationships with objects beyond the normal "parent/child" hierarchical relationships that all user interface objects have. AtkRelationSets establish whether objects are labelled or @@ -10267,21 +7365,15 @@ content which "flows" between them, among other types of possible relationships. - Creates a new empty relation set. + Creates a new empty relation set. - a new #AtkRelationSet + a new #AtkRelationSet - Add a new relation to the current relation set if it is not already + Add a new relation to the current relation set if it is not already present. This function ref's the AtkRelation so the caller of this function should unref it to ensure that it will be destroyed when the AtkRelationSet @@ -10292,25 +7384,17 @@ is destroyed. - an #AtkRelationSet + an #AtkRelationSet - an #AtkRelation + an #AtkRelation - - Add a new relation of the specified type with the specified target to + + Add a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. If it is does contain a relation of that typea the target is added to the relation. @@ -10320,169 +7404,118 @@ is added to the relation. - an #AtkRelationSet + an #AtkRelationSet - an #AtkRelationType + an #AtkRelationType - an #AtkObject + an #AtkObject - Determines whether the relation set contains a relation that matches the + Determines whether the relation set contains a relation that matches the specified type. - %TRUE if @relationship is the relationship type of a relation + %TRUE if @relationship is the relationship type of a relation in @set, %FALSE otherwise - an #AtkRelationSet + an #AtkRelationSet - an #AtkRelationType + an #AtkRelationType - - Determines whether the relation set contains a relation that + + Determines whether the relation set contains a relation that matches the specified pair formed by type @relationship and object @target. - %TRUE if @set contains a relation with the relationship + %TRUE if @set contains a relation with the relationship type @relationship with an object @target, %FALSE otherwise - an #AtkRelationSet + an #AtkRelationSet - an #AtkRelationType + an #AtkRelationType - an #AtkObject + an #AtkObject - - Determines the number of relations in a relation set. + + Determines the number of relations in a relation set. - an integer representing the number of relations in the set. + an integer representing the number of relations in the set. - an #AtkRelationSet + an #AtkRelationSet - Determines the relation at the specified position in the relation set. + Determines the relation at the specified position in the relation set. - a #AtkRelation, which is the relation at + a #AtkRelation, which is the relation at position i in the set. - an #AtkRelationSet + an #AtkRelationSet - a gint representing a position in the set, starting from 0. + a gint representing a position in the set, starting from 0. - - Finds a relation that matches the specified type. + + Finds a relation that matches the specified type. - an #AtkRelation, which is a relation matching the + an #AtkRelation, which is a relation matching the specified type. - an #AtkRelationSet + an #AtkRelationSet - an #AtkRelationType + an #AtkRelationType - Removes a relation from the relation set. + Removes a relation from the relation set. This function unref's the #AtkRelation so it will be deleted unless there is another reference to it. @@ -10491,15 +7524,11 @@ is another reference to it. - an #AtkRelationSet + an #AtkRelationSet - an #AtkRelation + an #AtkRelation @@ -10513,9 +7542,7 @@ is another reference to it. - + @@ -10527,137 +7554,57 @@ is another reference to it. - - Describes the type of the relation - - Not used, represens "no relationship" or an error condition. + + Describes the type of the relation + + Not used, represens "no relationship" or an error condition. - - Indicates an object controlled by one or more target objects. + + Indicates an object controlled by one or more target objects. - - Indicates an object is an controller for one or more target objects. + + Indicates an object is an controller for one or more target objects. - - Indicates an object is a label for one or more target objects. + + Indicates an object is a label for one or more target objects. - - Indicates an object is labelled by one or more target objects. + + Indicates an object is labelled by one or more target objects. - - Indicates an object is a member of a group of one or more target objects. + + Indicates an object is a member of a group of one or more target objects. - - Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. + + Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. - - Indicates that the object has content that flows logically to another + + Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow). - - Indicates that the object has content that flows logically from + + Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow). - - Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component. + + Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component. - - Indicates that the object visually embeds + + Indicates that the object visually embeds another object's content, i.e. this object's content flows around another's content. - - Reciprocal of %ATK_RELATION_EMBEDS, indicates that + + Reciprocal of %ATK_RELATION_EMBEDS, indicates that this object's content is visualy embedded in another object. - - Indicates that an object is a popup for another object. + + Indicates that an object is a popup for another object. - - Indicates that an object is a parent window of another object. + + Indicates that an object is a parent window of another object. - - Reciprocal of %ATK_RELATION_DESCRIPTION_FOR. Indicates that one + + Reciprocal of %ATK_RELATION_DESCRIPTION_FOR. Indicates that one or more target objects provide descriptive information about this object. This relation type is most appropriate for information that is not essential as its presentation may be user-configurable and/or limited to an on-demand mechanism such as an assistive @@ -10668,31 +7615,16 @@ an on-screen object, consider using %ATK_RELATION_DETAILS as assistive technolog provide a means for the user to navigate to objects containing detailed descriptions so that their content can be more closely reviewed. - - Reciprocal of %ATK_RELATION_DESCRIBED_BY. Indicates that this + + Reciprocal of %ATK_RELATION_DESCRIBED_BY. Indicates that this object provides descriptive information about the target object(s). See also %ATK_RELATION_DETAILS_FOR and %ATK_RELATION_ERROR_FOR. - - Indicates an object is a cell in a treetable and is expanded to display other cells in the same column. + + Indicates an object is a cell in a treetable and is expanded to display other cells in the same column. - - Reciprocal of %ATK_RELATION_DETAILS_FOR. Indicates that this object + + Reciprocal of %ATK_RELATION_DETAILS_FOR. Indicates that this object has a detailed or extended description, the contents of which can be found in the target object(s). This relation type is most appropriate for information that is sufficiently lengthy as to make navigation to the container of that information desirable. For less @@ -10700,605 +7632,257 @@ verbose information suitable for announcement only, see %ATK_RELATION_DESCRIBED_ the detailed information describes an error condition, %ATK_RELATION_ERROR_FOR should be used instead. @Since: ATK-2.26. - - Reciprocal of %ATK_RELATION_DETAILS. Indicates that this object + + Reciprocal of %ATK_RELATION_DETAILS. Indicates that this object provides a detailed or extended description about the target object(s). See also %ATK_RELATION_DESCRIPTION_FOR and %ATK_RELATION_ERROR_FOR. @Since: ATK-2.26. - - Reciprocal of %ATK_RELATION_ERROR_FOR. Indicates that this object + + Reciprocal of %ATK_RELATION_ERROR_FOR. Indicates that this object has one or more errors, the nature of which is described in the contents of the target object(s). Objects that have this relation type should also contain %ATK_STATE_INVALID_ENTRY in their #AtkStateSet. @Since: ATK-2.26. - - Reciprocal of %ATK_RELATION_ERROR_MESSAGE. Indicates that this object + + Reciprocal of %ATK_RELATION_ERROR_MESSAGE. Indicates that this object contains an error message describing an invalid condition in the target object(s). @Since: ATK_2.26. - - Not used, this value indicates the end of the enumeration. + + Not used, this value indicates the end of the enumeration. - Get the #AtkRelationType type corresponding to a relation name. + Get the #AtkRelationType type corresponding to a relation name. - the #AtkRelationType enumerated type corresponding to the specified name, + the #AtkRelationType enumerated type corresponding to the specified name, or #ATK_RELATION_NULL if no matching relation type is found. - a string which is the (non-localized) name of an ATK relation type. + a string which is the (non-localized) name of an ATK relation type. - Gets the description string describing the #AtkRelationType @type. + Gets the description string describing the #AtkRelationType @type. - the string describing the AtkRelationType + the string describing the AtkRelationType - The #AtkRelationType whose name is required + The #AtkRelationType whose name is required - Associate @name with a new #AtkRelationType + Associate @name with a new #AtkRelationType - an #AtkRelationType associated with @name + an #AtkRelationType associated with @name - a name string + a name string - - Describes the role of an object + + Describes the role of an object These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= %ATK_ROLE_LAST_DEFINED is not necessarily an error. - - Invalid role + + Invalid role - - A label which represents an accelerator + + A label which represents an accelerator - - An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc. + + An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc. - - An object which is an animated image + + An object which is an animated image - - An arrow in one of the four cardinal directions + + An arrow in one of the four cardinal directions - - An object that displays a calendar and allows the user to select a date + + An object that displays a calendar and allows the user to select a date - - An object that can be drawn into and is used to trap events + + An object that can be drawn into and is used to trap events - - A choice that can be checked or unchecked and provides a separate indicator for the current state + + A choice that can be checked or unchecked and provides a separate indicator for the current state - - A menu item with a check box + + A menu item with a check box - - A specialized dialog that lets the user choose a color + + A specialized dialog that lets the user choose a color - - The header for a column of data + + The header for a column of data - - A collapsible list of choices the user can select from + + A collapsible list of choices the user can select from - - An object whose purpose is to allow a user to edit a date + + An object whose purpose is to allow a user to edit a date - - An inconifed internal frame within a DESKTOP_PANE + + An inconifed internal frame within a DESKTOP_PANE - - A pane that supports internal frames and iconified versions of those internal frames + + A pane that supports internal frames and iconified versions of those internal frames - - An object whose purpose is to allow a user to set a value + + An object whose purpose is to allow a user to set a value - - A top level window with title bar and a border + + A top level window with title bar and a border - - A pane that allows the user to navigate through and select the contents of a directory + + A pane that allows the user to navigate through and select the contents of a directory - - An object used for drawing custom user interface elements + + An object used for drawing custom user interface elements - - A specialized dialog that lets the user choose a file + + A specialized dialog that lets the user choose a file - - A object that fills up space in a user interface + + A object that fills up space in a user interface - - A specialized dialog that lets the user choose a font + + A specialized dialog that lets the user choose a font - - A top level window with a title bar, border, menubar, etc. + + A top level window with a title bar, border, menubar, etc. - - A pane that is guaranteed to be painted on top of all panes beneath it + + A pane that is guaranteed to be painted on top of all panes beneath it - - A document container for HTML, whose children represent the document content + + A document container for HTML, whose children represent the document content - - A small fixed size picture, typically used to decorate components + + A small fixed size picture, typically used to decorate components - - An object whose primary purpose is to display an image + + An object whose primary purpose is to display an image - - A frame-like object that is clipped by a desktop pane + + A frame-like object that is clipped by a desktop pane - - An object used to present an icon or short string in an interface + + An object used to present an icon or short string in an interface - - A specialized pane that allows its children to be drawn in layers, providing a form of stacking order + + A specialized pane that allows its children to be drawn in layers, providing a form of stacking order - - An object that presents a list of objects to the user and allows the user to select one or more of them + + An object that presents a list of objects to the user and allows the user to select one or more of them - - An object that represents an element of a list + + An object that represents an element of a list - - An object usually found inside a menu bar that contains a list of actions the user can choose from + + An object usually found inside a menu bar that contains a list of actions the user can choose from - - An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from + + An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from - - An object usually contained in a menu that presents an action the user can choose + + An object usually contained in a menu that presents an action the user can choose - - A specialized pane whose primary use is inside a DIALOG + + A specialized pane whose primary use is inside a DIALOG - - An object that is a child of a page tab list + + An object that is a child of a page tab list - - An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object + + An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object - - A generic container that is often used to group objects + + A generic container that is often used to group objects - - A text object uses for passwords, or other places where the text content is not shown visibly to the user + + A text object uses for passwords, or other places where the text content is not shown visibly to the user - - A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices + + A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices - - An object used to indicate how much of a task has been completed + + An object used to indicate how much of a task has been completed - - An object the user can manipulate to tell the application to do something + + An object the user can manipulate to tell the application to do something - - A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked + + A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked - - A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected + + A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected - - A specialized pane that has a glass pane and a layered pane as its children + + A specialized pane that has a glass pane and a layered pane as its children - - The header for a row of data + + The header for a row of data - - An object usually used to allow a user to incrementally view a large amount of data. + + An object usually used to allow a user to incrementally view a large amount of data. - - An object that allows a user to incrementally view a large amount of information + + An object that allows a user to incrementally view a large amount of information - - An object usually contained in a menu to provide a visible and logical separation of the contents in a menu + + An object usually contained in a menu to provide a visible and logical separation of the contents in a menu - - An object that allows the user to select from a bounded range + + An object that allows the user to select from a bounded range - - A specialized panel that presents two other panels at the same time + + A specialized panel that presents two other panels at the same time - - An object used to get an integer or floating point number from the user + + An object used to get an integer or floating point number from the user - - An object which reports messages of minor importance to the user + + An object which reports messages of minor importance to the user - - An object used to represent information in terms of rows and columns + + An object used to represent information in terms of rows and columns - - A cell in a table + + A cell in a table - - The header for a column of a table + + The header for a column of a table - - The header for a row of a table + + The header for a row of a table - - A menu item used to tear off and reattach its menu + + A menu item used to tear off and reattach its menu - - An object that represents an accessible terminal. (Since: 0.6) + + An object that represents an accessible terminal. (Since: 0.6) - - An interactive widget that supports multiple lines of text and + + An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For widgets @@ -11306,499 +7890,214 @@ whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see ATK_ROLE_STATIC. - - A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state + + A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state - - A bar or palette usually composed of push buttons or toggle buttons + + A bar or palette usually composed of push buttons or toggle buttons - - An object that provides information about another object + + An object that provides information about another object - - An object used to represent hierarchical information to the user + + An object used to represent hierarchical information to the user - - An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7) + + An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7) - - The object contains some Accessible information, but its role is not known + + The object contains some Accessible information, but its role is not known - - An object usually used in a scroll pane + + An object usually used in a scroll pane - - A top level window with no title or border. + + A top level window with no title or border. - - An object that serves as a document header. (Since: 1.1.1) + + An object that serves as a document header. (Since: 1.1.1) - - An object that serves as a document footer. (Since: 1.1.1) + + An object that serves as a document footer. (Since: 1.1.1) - - An object which is contains a paragraph of text content. (Since: 1.1.1) + + An object which is contains a paragraph of text content. (Since: 1.1.1) - - An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1) + + An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1) - - The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4) + + The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4) - - The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. (Since: 1.3) + + The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. (Since: 1.3) - - The object is an editable text object in a toolbar. (Since: 1.5) + + The object is an editable text object in a toolbar. (Since: 1.5) - - The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. (Since: 1.7.2) + + The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. (Since: 1.7.2) - - The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present. (Since: 1.11) + + The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present. (Since: 1.11) - - The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. (Since: 1.11) + + The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. (Since: 1.11) - - The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. (Since: 1.11) + + The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. (Since: 1.11) - - The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. (Since: 1.11) + + The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. (Since: 1.11) - - The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes. + + The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes. - - The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. (Since: 1.11) + + The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. (Since: 1.11) - - The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. (Since: 1.11) + + The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. (Since: 1.11) - - The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. (Since: 1.11) + + The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. (Since: 1.11) - - The object is a container for form controls, for instance as part of a + + The object is a container for form controls, for instance as part of a web form or user-input form within a document. This role is primarily a tag/convenience for clients when navigating complex documents, it is not expected that ordinary GUI containers will always have ATK_ROLE_FORM. (Since: 1.12.0) - - The object is a hypertext anchor, i.e. a "link" in a + + The object is a hypertext anchor, i.e. a "link" in a hypertext document. Such objects are distinct from 'inline' content which may also use the Hypertext/Hyperlink interfaces to indicate the range/location within a text object where an inline or embedded object lies. (Since: 1.12.1) - - The object is a window or similar viewport + + The object is a window or similar viewport which is used to allow composition or input of a 'complex character', in other words it is an "input method window." (Since: 1.12.1) - - A row in a table. (Since: 2.1.0) + + A row in a table. (Since: 2.1.0) - - An object that represents an element of a tree. (Since: 2.1.0) + + An object that represents an element of a tree. (Since: 2.1.0) - - A document frame which contains a spreadsheet. (Since: 2.1.0) + + A document frame which contains a spreadsheet. (Since: 2.1.0) - - A document frame which contains a presentation or slide content. (Since: 2.1.0) + + A document frame which contains a presentation or slide content. (Since: 2.1.0) - - A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0) + + A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0) - - A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0) + + A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0) - - A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0) + + A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0) - - An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. (Since: 2.1.0) + + An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. (Since: 2.1.0) - - A non-collapsible list of choices the user can select from. (Since: 2.1.0) + + A non-collapsible list of choices the user can select from. (Since: 2.1.0) - - A group of related widgets. This group typically has a label. (Since: 2.1.0) + + A group of related widgets. This group typically has a label. (Since: 2.1.0) - - An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. (Since: 2.1.0) + + An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. (Since: 2.1.0) - - A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. (Since: 2.1.0) + + A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. (Since: 2.1.0) - - An object designed to present a message to the user within an existing window. (Since: 2.1.0) + + An object designed to present a message to the user within an existing window. (Since: 2.1.0) - - A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. (Since: 2.7.3) + + A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. (Since: 2.7.3) - - A bar that serves as the title of a window or a + + A bar that serves as the title of a window or a dialog. (Since: 2.12) - - An object which contains a text section + + An object which contains a text section that is quoted from another source. (Since: 2.12) - - An object which represents an audio element. (Since: 2.12) + + An object which represents an audio element. (Since: 2.12) - - An object which represents a video element. (Since: 2.12) + + An object which represents a video element. (Since: 2.12) - - A definition of a term or concept. (Since: 2.12) + + A definition of a term or concept. (Since: 2.12) - - A section of a page that consists of a + + A section of a page that consists of a composition that forms an independent part of a document, page, or site. Examples: A blog entry, a news story, a forum post. (Since: 2.12) - - A region of a web page intended as a + + A region of a web page intended as a navigational landmark. This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document. (Since: 2.12) - - A text widget or container holding log content, such + + A text widget or container holding log content, such as chat history and error logs. In this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. (Since: 2.12) - - A container where non-essential information + + A container where non-essential information changes frequently. Common usages of marquee include stock tickers and ad banners. The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of important content changes. (Since: 2.12) - - A text widget or container that holds a mathematical + + A text widget or container that holds a mathematical expression. (Since: 2.12) - - A widget whose purpose is to display a rating, + + A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player. Objects of this role should also implement AtkValue. (Since: 2.12) - - An object containing a numerical counter which + + An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point. (Since: 2.12) - - An object that represents a list of + + An object that represents a list of term-value groups. A term-value group represents a individual description and consist of one or more names (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be more than one group with the same term name. (Since: 2.12) - - An object that represents a term or phrase + + An object that represents a term or phrase with a corresponding definition. (Since: 2.12) - - An object that represents the + + An object that represents the description, definition or value of a term. (Since: 2.12) - - A generic non-container object whose purpose is to display a + + A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user. Examples in which %ATK_ROLE_STATIC is appropriate include the message displayed in a message box @@ -11812,77 +8111,37 @@ labels which describe another widget, see %ATK_ROLE_LABEL. For text views, see %ATK_ROLE_TEXT. For generic containers, see %ATK_ROLE_PANEL. For objects whose role is not known by the implementor, see %ATK_ROLE_UNKNOWN. (Since: 2.16) - - An object that represents a mathematical fraction. + + An object that represents a mathematical fraction. (Since: 2.16) - - An object that represents a mathematical expression + + An object that represents a mathematical expression displayed with a radical. (Since: 2.16) - - An object that contains text that is displayed as a + + An object that contains text that is displayed as a subscript. (Since: 2.16) - - An object that contains text that is displayed as a + + An object that contains text that is displayed as a superscript. (Since: 2.16) - - An object that contains the text of a footnote. (Since: 2.26) + + An object that contains the text of a footnote. (Since: 2.26) - - Content previously deleted or proposed to be + + Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers. (Since: 2.34) - - Content previously inserted or proposed to be + + Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers. (Since: 2.34) - - A run of content that is marked or highlighted, such as for + + A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose. If the marked content has an associated section in the document elaborating on the reason for the mark, then %ATK_RELATION_DETAILS should be used on the mark @@ -11890,128 +8149,87 @@ to point to that associated section. In addition, the reciprocal relation %ATK_RELATION_DETAILS_FOR should be used on the associated content section to point back to the mark. (Since: 2.36) - - A container for content that is called out as a proposed + + A container for content that is called out as a proposed change from the current version of the document, such as by a reviewer of the content. This role should include either %ATK_ROLE_CONTENT_DELETION and/or %ATK_ROLE_CONTENT_INSERTION children, in any order, to indicate what the actual change is. (Since: 2.36) - - not a valid role, used for finding end of the enumeration + + not a valid role, used for finding end of the enumeration - Get the #AtkRole type corresponding to a rolew name. + Get the #AtkRole type corresponding to a rolew name. - the #AtkRole enumerated type corresponding to the specified name, + the #AtkRole enumerated type corresponding to the specified name, or #ATK_ROLE_INVALID if no matching role is found. - a string which is the (non-localized) name of an ATK role. + a string which is the (non-localized) name of an ATK role. - - Gets the localized description string describing the #AtkRole @role. + + Gets the localized description string describing the #AtkRole @role. - the localized string describing the AtkRole + the localized string describing the AtkRole - The #AtkRole whose localized name is required + The #AtkRole whose localized name is required - Gets the description string describing the #AtkRole @role. + Gets the description string describing the #AtkRole @role. - the string describing the AtkRole + the string describing the AtkRole - The #AtkRole whose name is required + The #AtkRole whose name is required - - Registers the role specified by @name. @name must be a meaningful + + Registers the role specified by @name. @name must be a meaningful name. So it should not be empty, or consisting on whitespaces. Since 2.12. If your application/toolkit doesn't find a suitable role for a specific object defined at #AtkRole, please submit a bug in order to add a new role to the specification. - an #AtkRole for the new role if added + an #AtkRole for the new role if added properly. ATK_ROLE_INVALID in case of error. - a character string describing the new role. + a character string describing the new role. - + - + @@ -12025,151 +8243,89 @@ properly. ATK_ROLE_INVALID in case of error. - + - + - + - + - + - + - + - - Specifies where an object should be placed on the screen when using scroll_to. - - Scroll the object vertically and horizontally to bring + + Specifies where an object should be placed on the screen when using scroll_to. + + Scroll the object vertically and horizontally to bring its top left corner to the top left corner of the window. - - Scroll the object vertically and horizontally to + + Scroll the object vertically and horizontally to bring its bottom right corner to the bottom right corner of the window. - - Scroll the object vertically to bring its top edge to + + Scroll the object vertically to bring its top edge to the top edge of the window. - - Scroll the object vertically to bring its bottom + + Scroll the object vertically to bring its bottom edge to the bottom edge of the window. - - Scroll the object vertically and horizontally to bring + + Scroll the object vertically and horizontally to bring its left edge to the left edge of the window. - - Scroll the object vertically and horizontally to + + Scroll the object vertically and horizontally to bring its right edge to the right edge of the window. - - Scroll the object vertically and horizontally so that + + Scroll the object vertically and horizontally so that as much as possible of the object becomes visible. The exact placement is determined by the application. - - #AtkSelection should be implemented by UI components with children + + #AtkSelection should be implemented by UI components with children which are exposed by #atk_object_ref_child and #atk_object_get_n_children, if the use of the parent UI component ordinarily involves selection of one or more of the objects @@ -12181,113 +8337,83 @@ are accomplished a other ATK interfaces - #AtkSelection is limited to the selection/deselection of children. - Adds the specified accessible child of the object to the + Adds the specified accessible child of the object to the object's selection. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the child index. + a #gint specifying the child index. - Clears the selection in the object so that no children in the object + Clears the selection in the object so that no children in the object are selected. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - Gets the number of accessible children currently selected. + Gets the number of accessible children currently selected. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. - a gint representing the number of items selected, or 0 + a gint representing the number of items selected, or 0 if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - Determines if the current child of this object is selected + Determines if the current child of this object is selected Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. - a gboolean representing the specified child is selected, or 0 + a gboolean representing the specified child is selected, or 0 if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the child index. + a #gint specifying the child index. - Gets a reference to the accessible object representing the specified + Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should @@ -12295,74 +8421,53 @@ use type checking/interface checking macros or the atk_get_accessible_value() convenience method. - an #AtkObject representing the + an #AtkObject representing the selected accessible, or %NULL if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the index in the selection set. (e.g. the + a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). - Removes the specified child of the object from the object's selection. + Removes the specified child of the object from the object's selection. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the index in the selection set. (e.g. the + a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). - - Causes every child of the object to be selected if the object + + Causes every child of the object to be selected if the object supports multiple selections. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface @@ -12379,116 +8484,83 @@ supports multiple selections. - Adds the specified accessible child of the object to the + Adds the specified accessible child of the object to the object's selection. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the child index. + a #gint specifying the child index. - - Clears the selection in the object so that no children in the object + + Clears the selection in the object so that no children in the object are selected. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - - Gets the number of accessible children currently selected. + + Gets the number of accessible children currently selected. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. - a gint representing the number of items selected, or 0 + a gint representing the number of items selected, or 0 if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - - Determines if the current child of this object is selected + + Determines if the current child of this object is selected Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. - a gboolean representing the specified child is selected, or 0 + a gboolean representing the specified child is selected, or 0 if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the child index. + a #gint specifying the child index. - Gets a reference to the accessible object representing the specified + Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should @@ -12496,92 +8568,66 @@ use type checking/interface checking macros or the atk_get_accessible_value() convenience method. - an #AtkObject representing the + an #AtkObject representing the selected accessible, or %NULL if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the index in the selection set. (e.g. the + a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). - - Removes the specified child of the object from the object's selection. + + Removes the specified child of the object from the object's selection. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the index in the selection set. (e.g. the + a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). - - Causes every child of the object to be selected if the object + + Causes every child of the object to be selected if the object supports multiple selections. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - The "selection-changed" signal is emitted by an object which + The "selection-changed" signal is emitted by an object which implements AtkSelection interface when the selection changes. - + @@ -12590,22 +8636,16 @@ implements AtkSelection interface when the selection changes. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the child index. + a #gint specifying the child index. @@ -12615,16 +8655,12 @@ implements AtkSelection interface when the selection changes. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface @@ -12634,24 +8670,18 @@ implements AtkSelection interface when the selection changes. - an #AtkObject representing the + an #AtkObject representing the selected accessible, or %NULL if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the index in the selection set. (e.g. the + a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). @@ -12662,17 +8692,13 @@ ith selection as opposed to the ith child). - a gint representing the number of items selected, or 0 + a gint representing the number of items selected, or 0 if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface @@ -12682,23 +8708,17 @@ if @selection does not implement this interface. - a gboolean representing the specified child is selected, or 0 + a gboolean representing the specified child is selected, or 0 if @selection does not implement this interface. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the child index. + a #gint specifying the child index. @@ -12708,22 +8728,16 @@ if @selection does not implement this interface. - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface - a #gint specifying the index in the selection set. (e.g. the + a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). @@ -12734,16 +8748,12 @@ ith selection as opposed to the ith child). - TRUE if success, FALSE otherwise. + TRUE if success, FALSE otherwise. - a #GObject instance that implements AtkSelectionIface + a #GObject instance that implements AtkSelectionIface @@ -12763,16 +8773,8 @@ ith selection as opposed to the ith child). - - Together with #AtkPlug, #AtkSocket provides the ability to embed + + Together with #AtkPlug, #AtkSocket provides the ability to embed accessibles from one process into another in a fashion that is transparent to assistive technologies. #AtkSocket works as the container of #AtkPlug, embedding it using the method @@ -12797,21 +8799,15 @@ functions will be implemented by the IPC layer. - Creates a new #AtkSocket. + Creates a new #AtkSocket. - the newly created #AtkSocket instance + the newly created #AtkSocket instance - Embeds the children of an #AtkPlug as the children of the + Embeds the children of an #AtkPlug as the children of the #AtkSocket. The plug may be in the same process or in a different process. @@ -12827,23 +8823,17 @@ as needed. - an #AtkSocket + an #AtkSocket - the ID of an #AtkPlug + the ID of an #AtkPlug - Embeds the children of an #AtkPlug as the children of the + Embeds the children of an #AtkPlug as the children of the #AtkSocket. The plug may be in the same process or in a different process. @@ -12859,37 +8849,25 @@ as needed. - an #AtkSocket + an #AtkSocket - the ID of an #AtkPlug + the ID of an #AtkPlug - - Determines whether or not the socket has an embedded plug. + + Determines whether or not the socket has an embedded plug. - TRUE if a plug is embedded in the socket + TRUE if a plug is embedded in the socket - an #AtkSocket + an #AtkSocket @@ -12901,9 +8879,7 @@ as needed. - + @@ -12916,50 +8892,32 @@ as needed. - an #AtkSocket + an #AtkSocket - the ID of an #AtkPlug + the ID of an #AtkPlug - - An AtkStateSet is a read-only representation of the full set of #AtkStates + + An AtkStateSet is a read-only representation of the full set of #AtkStates that apply to an object at a given time. This set is not meant to be modified, but rather created when #atk_object_ref_state_set() is called. - Creates a new empty state set. + Creates a new empty state set. - a new #AtkStateSet + a new #AtkStateSet - Adds the state of the specified type to the state set if it is not already + Adds the state of the specified type to the state set if it is not already present. Note that because an #AtkStateSet is a read-only object, this method should @@ -12968,30 +8926,22 @@ be used to add a state to a newly-created set which will then be returned by of an object. See also #atk_object_notify_state_change. - %TRUE if the state for @type is not already in @set. + %TRUE if the state for @type is not already in @set. - an #AtkStateSet + an #AtkStateSet - an #AtkStateType + an #AtkStateType - Adds the states of the specified types to the state set. + Adds the states of the specified types to the state set. Note that because an #AtkStateSet is a read-only object, this method should be used to add states to a newly-created set which will then be returned by @@ -13003,186 +8953,132 @@ of an object. See also #atk_object_notify_state_change. - an #AtkStateSet + an #AtkStateSet - an array of #AtkStateType + an array of #AtkStateType - The number of elements in the array + The number of elements in the array - Constructs the intersection of the two sets, returning %NULL if the + Constructs the intersection of the two sets, returning %NULL if the intersection is empty. - a new #AtkStateSet which is the intersection of + a new #AtkStateSet which is the intersection of the two sets. - an #AtkStateSet + an #AtkStateSet - another #AtkStateSet + another #AtkStateSet - Removes all states from the state set. + Removes all states from the state set. - an #AtkStateSet + an #AtkStateSet - - Checks whether the state for the specified type is in the specified set. + + Checks whether the state for the specified type is in the specified set. - %TRUE if @type is the state type is in @set. + %TRUE if @type is the state type is in @set. - an #AtkStateSet + an #AtkStateSet - an #AtkStateType + an #AtkStateType - - Checks whether the states for all the specified types are in the + + Checks whether the states for all the specified types are in the specified set. - %TRUE if all the states for @type are in @set. + %TRUE if all the states for @type are in @set. - an #AtkStateSet + an #AtkStateSet - an array of #AtkStateType + an array of #AtkStateType - The number of elements in the array + The number of elements in the array - Checks whether the state set is empty, i.e. has no states set. + Checks whether the state set is empty, i.e. has no states set. - %TRUE if @set has no states set, otherwise %FALSE + %TRUE if @set has no states set, otherwise %FALSE - an #AtkStateType + an #AtkStateType - Constructs the union of the two sets. + Constructs the union of the two sets. - a new #AtkStateSet which is + a new #AtkStateSet which is the union of the two sets, returning %NULL is empty. - an #AtkStateSet + an #AtkStateSet - another #AtkStateSet + another #AtkStateSet - Removes the state for the specified type from the state set. + Removes the state for the specified type from the state set. Note that because an #AtkStateSet is a read-only object, this method should be used to remove a state to a newly-created set which will then be returned @@ -13190,51 +9086,37 @@ by #atk_object_ref_state_set. It should not be used to modify the existing state of an object. See also #atk_object_notify_state_change. - %TRUE if @type was the state type is in @set. + %TRUE if @type was the state type is in @set. - an #AtkStateSet + an #AtkStateSet - an #AtkType + an #AtkType - Constructs the exclusive-or of the two sets, returning %NULL is empty. + Constructs the exclusive-or of the two sets, returning %NULL is empty. The set returned by this operation contains the states in exactly one of the two sets. - a new #AtkStateSet which contains the states + a new #AtkStateSet which contains the states which are in exactly one of the two sets. - an #AtkStateSet + an #AtkStateSet - another #AtkStateSet + another #AtkStateSet @@ -13243,209 +9125,87 @@ which are in exactly one of the two sets. - + - - The possible types of states of an object - - Indicates an invalid state - probably an error condition. + + The possible types of states of an object + + Indicates an invalid state - probably an error condition. - - Indicates a window is currently the active window, or an object is the active subelement within a container or table. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container. + + Indicates a window is currently the active window, or an object is the active subelement within a container or table. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container. - - Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code. + + Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code. - - Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed. + + Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed. - - Indicates this object is currently checked, for instance a checkbox is 'non-empty'. + + Indicates this object is currently checked, for instance a checkbox is 'non-empty'. - - Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed) + + Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed) - - Indicates that this object can contain text, and that the + + Indicates that this object can contain text, and that the user can change the textual contents of this object by editing those contents directly. For an object which is expected to be editable due to its type, but which cannot be edited due to the application or platform preventing the user from doing so, that object's #AtkStateSet should lack ATK_STATE_EDITABLE and should contain ATK_STATE_READ_ONLY. - - Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE + + Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE - - Indicates this object allows progressive disclosure of its children + + Indicates this object allows progressive disclosure of its children - - Indicates this object its expanded - see ATK_STATE_EXPANDABLE above + + Indicates this object its expanded - see ATK_STATE_EXPANDABLE above - - Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus + + Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus - - Indicates this object currently has the keyboard focus + + Indicates this object currently has the keyboard focus - - Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful. + + Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful. - - Indicates this object is minimized and is represented only by an icon + + Indicates this object is minimized and is represented only by an icon - - Indicates something must be done with this object before the user can interact with an object in a different window + + Indicates something must be done with this object before the user can interact with an object in a different window - - Indicates this (text) object can contain multiple lines of text + + Indicates this (text) object can contain multiple lines of text - - Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections. + + Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections. - - Indicates this object paints every pixel within its rectangular region. + + Indicates this object paints every pixel within its rectangular region. - - Indicates this object is currently pressed. + + Indicates this object is currently pressed. - - Indicates the size of this object is not fixed + + Indicates the size of this object is not fixed - - Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected + + Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected - - Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected + + Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected - - Indicates this object is sensitive, e.g. to user interaction. + + Indicates this object is sensitive, e.g. to user interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, but may be found in the absence of STATE_ENABLED if the current visible state of the control is "disconnected" from the application state. In such cases, direct user interaction @@ -13453,61 +9213,31 @@ can often result in the object gaining STATE_SENSITIVE, for instance if a user m an explicit selection using an object whose current state is ambiguous or undefined. @see STATE_ENABLED, STATE_INDETERMINATE. - - Indicates this object, the object's parent, the object's parent's parent, and so on, + + Indicates this object, the object's parent, the object's parent's parent, and so on, are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose between this object and the top of the window stack. - - Indicates this (text) object can contain only a single line of text + + Indicates this (text) object can contain only a single line of text - - Indicates that the information returned for this object may no longer be + + Indicates that the information returned for this object may no longer be synchronized with the application state. This is implied if the object has STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that the index associated with this object has changed since the user accessed the object (in lieu of "index-in-parent-changed" events). - - Indicates this object is transient, i.e. a snapshot which may not emit events when its + + Indicates this object is transient, i.e. a snapshot which may not emit events when its state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no notification given when the cached data becomes obsolete. - - Indicates the orientation of this object is vertical + + Indicates the orientation of this object is vertical - - Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. + + Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. **note**: %ATK_STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the field of view, or having an ancestor container that has not yet made visible. @@ -13519,13 +9249,8 @@ contents are clipped, e.g. a truncated spreadsheet cell or an image within a scrolling viewport. Mostly useful for screen-review and magnification algorithms. - - Indicates that "active-descendant-changed" event + + Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e. are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. @@ -13535,13 +9260,8 @@ notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children. - - Indicates that the value, or some other quantifiable + + Indicates that the value, or some other quantifiable property, of this AtkObject cannot be fully determined. In the case of a large data set in which the total number of items in that set is unknown (e.g. 1 of 999+), implementors should expose the currently-known set size (999) along @@ -13549,117 +9269,57 @@ with this state. In the case of a check box, this state should be used to indicate that the check box is a tri-state check box which is currently neither checked nor unchecked. - - Indicates that an object is truncated, e.g. a text value in a speradsheet cell. + + Indicates that an object is truncated, e.g. a text value in a speradsheet cell. - - Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface. + + Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface. - - Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. + + Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. - - Indicates that the object in question implements some form of ¨typeahead¨ or + + Indicates that the object in question implements some form of ¨typeahead¨ or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become selected. Subsequent character input may narrow the selection further as long as one or more sub-elements match the string. This state is normally only useful and encountered on objects that implement Selection. -In some cases the typeahead behavior may result in full or partial ¨completion¨ of +In some cases the typeahead behavior may result in full or partial ¨completion¨ of the data in the input field, in which case these input events may trigger text-changed events from the AtkText interface. This state supplants @ATK_ROLE_AUTOCOMPLETE. - - Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from @ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations. + + Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from @ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations. - - Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button. + + Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button. - - Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. + + Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. **note**: some applications, notably content viewers, may not be able to detect all kinds of animated content. Therefore the absence of this state should not be taken as definitive evidence that the object's visual representation is static; this state is advisory. - - Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited". + + Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited". - - Indicates this object has the potential to be + + Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell. @Since: ATK-2.12 - - Indicates that the object has a popup context + + Indicates that the object has a popup context menu or sub-level menu which may or may not be showing. This means that activation renders conditional content. Note that ordinary tooltips are not considered popups in this context. @Since: ATK-2.12 - - Indicates this object has a tooltip. @Since: ATK-2.16 + + Indicates this object has a tooltip. @Since: ATK-2.16 - - Indicates that a widget which is ENABLED and SENSITIVE + + Indicates that a widget which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user. Note that this state should only be applied to widget types whose value is normally directly user modifiable, such as check boxes, radio buttons, spin buttons, text input @@ -13669,84 +9329,54 @@ widget does not include modification by the user, as is the case with labels and containers, ATK_STATE_READ_ONLY should not be applied. See also ATK_STATE_EDITABLE. @Since: ATK-2-16 - - Not a valid state, used for finding end of enumeration + + Not a valid state, used for finding end of enumeration - Gets the #AtkStateType corresponding to the description string @name. + Gets the #AtkStateType corresponding to the description string @name. - an #AtkStateType corresponding to @name + an #AtkStateType corresponding to @name - a character string state name + a character string state name - Gets the description string describing the #AtkStateType @type. + Gets the description string describing the #AtkStateType @type. - the string describing the AtkStateType + the string describing the AtkStateType - The #AtkStateType whose name is required + The #AtkStateType whose name is required - Register a new object state. + Register a new object state. - an #AtkState value for the new state. + an #AtkState value for the new state. - a character string describing the new state. + a character string describing the new state. - - An interface whereby an object allows its backing content to be + + An interface whereby an object allows its backing content to be streamed to clients. Typical implementors would be images or icons, HTML content, or multimedia display/rendering widgets. @@ -13764,84 +9394,60 @@ tied to the current user-agent view of the a particular document, but may in some cases give access to the underlying model data. - Gets the character string of the specified mime type. The first mime + Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on. - a gchar* representing the specified mime type; the caller + a gchar* representing the specified mime type; the caller should not free the character string. - a GObject instance that implements AtkStreamableContent + a GObject instance that implements AtkStreamableContent - a gint representing the position of the mime type starting from 0 + a gint representing the position of the mime type starting from 0 - Gets the number of mime types supported by this object. + Gets the number of mime types supported by this object. - a gint which is the number of mime types supported by the object. + a gint which is the number of mime types supported by the object. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - Gets the content in the specified mime type. + Gets the content in the specified mime type. - A #GIOChannel which contains the content in the + A #GIOChannel which contains the content in the specified mime type. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - a gchar* representing the mime type + a gchar* representing the mime type - Get a string representing a URI in IETF standard format + Get a string representing a URI in IETF standard format (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content may be streamed in the specified mime-type, if one is available. If mime_type is NULL, the URI for the default (and possibly only) mime-type is @@ -13851,112 +9457,77 @@ Note that it is possible for get_uri to return NULL but for get_stream to work nonetheless, since not all GIOChannels connect to URIs. - Returns a string representing a URI, or %NULL + Returns a string representing a URI, or %NULL if no corresponding URI can be constructed. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - a gchar* representing the mime type, or NULL to request a URI + a gchar* representing the mime type, or NULL to request a URI for the default mime type. - - Gets the character string of the specified mime type. The first mime + + Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on. - a gchar* representing the specified mime type; the caller + a gchar* representing the specified mime type; the caller should not free the character string. - a GObject instance that implements AtkStreamableContent + a GObject instance that implements AtkStreamableContent - a gint representing the position of the mime type starting from 0 + a gint representing the position of the mime type starting from 0 - - Gets the number of mime types supported by this object. + + Gets the number of mime types supported by this object. - a gint which is the number of mime types supported by the object. + a gint which is the number of mime types supported by the object. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - - Gets the content in the specified mime type. + + Gets the content in the specified mime type. - A #GIOChannel which contains the content in the + A #GIOChannel which contains the content in the specified mime type. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - a gchar* representing the mime type + a gchar* representing the mime type - - Get a string representing a URI in IETF standard format + + Get a string representing a URI in IETF standard format (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content may be streamed in the specified mime-type, if one is available. If mime_type is NULL, the URI for the default (and possibly only) mime-type is @@ -13966,32 +9537,24 @@ Note that it is possible for get_uri to return NULL but for get_stream to work nonetheless, since not all GIOChannels connect to URIs. - Returns a string representing a URI, or %NULL + Returns a string representing a URI, or %NULL if no corresponding URI can be constructed. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - a gchar* representing the mime type, or NULL to request a URI + a gchar* representing the mime type, or NULL to request a URI for the default mime type. - + @@ -14000,16 +9563,12 @@ for the default mime type. - a gint which is the number of mime types supported by the object. + a gint which is the number of mime types supported by the object. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface @@ -14019,23 +9578,17 @@ for the default mime type. - a gchar* representing the specified mime type; the caller + a gchar* representing the specified mime type; the caller should not free the character string. - a GObject instance that implements AtkStreamableContent + a GObject instance that implements AtkStreamableContent - a gint representing the position of the mime type starting from 0 + a gint representing the position of the mime type starting from 0 @@ -14045,23 +9598,17 @@ should not free the character string. - A #GIOChannel which contains the content in the + A #GIOChannel which contains the content in the specified mime type. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - a gchar* representing the mime type + a gchar* representing the mime type @@ -14071,23 +9618,17 @@ specified mime type. - Returns a string representing a URI, or %NULL + Returns a string representing a URI, or %NULL if no corresponding URI can be constructed. - a GObject instance that implements AtkStreamableContentIface + a GObject instance that implements AtkStreamableContentIface - a gchar* representing the mime type, or NULL to request a URI + a gchar* representing the mime type, or NULL to request a URI for the default mime type. @@ -14111,27 +9652,21 @@ for the default mime type. - + - + - + @@ -14145,24 +9680,15 @@ for the default mime type. - + - - #AtkTable should be implemented by components which present + + #AtkTable should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an @@ -14191,57 +9717,40 @@ that forcing made #AtkTable implementation complex, and hard to expose other kind of children, like rows or captions. Right now, index-based methods are deprecated. - - Adds the specified @column to the selection. + + Adds the specified @column to the selection. - a gboolean representing if the column was successfully added to + a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - Adds the specified @row to the selection. + Adds the specified @row to the selection. - a gboolean representing if row was successfully added to selection, + a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table @@ -14292,511 +9801,358 @@ or 0 if value does not implement this interface. - Gets the caption for the @table. + Gets the caption for the @table. - a AtkObject* representing the + a AtkObject* representing the table caption, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - - Gets a #gint representing the column at the specified @index_. + + Gets a #gint representing the column at the specified @index_. Since 2.12. - a gint representing the column at the specified index, + a gint representing the column at the specified index, or -1 if the table does not implement this method. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - a #gint representing an index in @table + a #gint representing an index in @table - - Gets the description text of the specified @column in the table + + Gets the description text of the specified @column in the table - a gchar* representing the column description, or %NULL + a gchar* representing the column description, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - - Gets the number of columns occupied by the accessible object + + Gets the number of columns occupied by the accessible object at the specified @row and @column in the @table. - a gint representing the column extent at specified position, or 0 + a gint representing the column extent at specified position, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - Gets the column header of a specified column in an accessible table. + Gets the column header of a specified column in an accessible table. - a AtkObject* representing the + a AtkObject* representing the specified column header, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in the table + a #gint representing a column in the table - - Gets a #gint representing the index at the specified @row and + + Gets a #gint representing the index at the specified @row and @column. Since 2.12. Use atk_table_ref_at() in order to get the accessible that represents the cell at (@row, @column) - a #gint representing the index at specified position. + a #gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - Gets the number of columns in the table. + Gets the number of columns in the table. - a gint representing the number of columns, or 0 + a gint representing the number of columns, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - Gets the number of rows in the table. + Gets the number of rows in the table. - a gint representing the number of rows, or 0 + a gint representing the number of rows, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - - Gets a #gint representing the row at the specified @index_. + + Gets a #gint representing the row at the specified @index_. since 2.12. - a gint representing the row at the specified index, + a gint representing the row at the specified index, or -1 if the table does not implement this method. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - a #gint representing an index in @table + a #gint representing an index in @table - Gets the description text of the specified row in the table + Gets the description text of the specified row in the table - a gchar* representing the row description, or + a gchar* representing the row description, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - Gets the number of rows occupied by the accessible object + Gets the number of rows occupied by the accessible object at a specified @row and @column in the @table. - a gint representing the row extent at specified position, or 0 + a gint representing the row extent at specified position, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - Gets the row header of a specified row in an accessible table. + Gets the row header of a specified row in an accessible table. - a AtkObject* representing the + a AtkObject* representing the specified row header, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in the table + a #gint representing a row in the table - - Gets the selected columns of the table by initializing **selected with + + Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller. - a gint representing the number of selected columns, + a gint representing the number of selected columns, or %0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint** that is to contain the selected columns numbers + a #gint** that is to contain the selected columns numbers - Gets the selected rows of the table by initializing **selected with + Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller. - a gint representing the number of selected rows, + a gint representing the number of selected rows, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint** that is to contain the selected row numbers + a #gint** that is to contain the selected row numbers - Gets the summary description of the table. + Gets the summary description of the table. - a AtkObject* representing a summary description + a AtkObject* representing a summary description of the table, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - Gets a boolean value indicating whether the specified @column + Gets a boolean value indicating whether the specified @column is selected - a gboolean representing if the column is selected, or 0 + a gboolean representing if the column is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - Gets a boolean value indicating whether the specified @row + Gets a boolean value indicating whether the specified @row is selected - a gboolean representing if the row is selected, or 0 + a gboolean representing if the row is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - Gets a boolean value indicating whether the accessible object + Gets a boolean value indicating whether the accessible object at the specified @row and @column is selected - a gboolean representing if the cell is selected, or 0 + a gboolean representing if the cell is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table @@ -14813,91 +10169,63 @@ if value does not implement this interface. - Get a reference to the table cell at @row, @column. This cell + Get a reference to the table cell at @row, @column. This cell should implement the interface #AtkTableCell - an #AtkObject representing the referred + an #AtkObject representing the referred to accessible - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - - Adds the specified @column to the selection. + + Adds the specified @column to the selection. - a gboolean representing if the column was successfully removed from + a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - - Removes the specified @row from the selection. + + Removes the specified @row from the selection. - a gboolean representing if the row was successfully removed from + a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table @@ -14948,1050 +10276,740 @@ the selection, or 0 if value does not implement this interface. - Sets the caption for the table. + Sets the caption for the table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #AtkObject representing the caption to set for @table + a #AtkObject representing the caption to set for @table - - Sets the description text for the specified @column of the @table. + + Sets the description text for the specified @column of the @table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - a #gchar representing the description text + a #gchar representing the description text to set for the specified @column of the @table - Sets the specified column header to @header. + Sets the specified column header to @header. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - an #AtkTable + an #AtkTable - Sets the description text for the specified @row of @table. + Sets the description text for the specified @row of @table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gchar representing the description text + a #gchar representing the description text to set for the specified @row of @table - Sets the specified row header to @header. + Sets the specified row header to @header. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - an #AtkTable + an #AtkTable - Sets the summary description of the table. + Sets the summary description of the table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - an #AtkObject representing the summary description + an #AtkObject representing the summary description to set for @table - - Adds the specified @column to the selection. + + Adds the specified @column to the selection. - a gboolean representing if the column was successfully added to + a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - - Adds the specified @row to the selection. + + Adds the specified @row to the selection. - a gboolean representing if row was successfully added to selection, + a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - Gets the caption for the @table. + Gets the caption for the @table. - a AtkObject* representing the + a AtkObject* representing the table caption, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - - Gets a #gint representing the column at the specified @index_. + + Gets a #gint representing the column at the specified @index_. Since 2.12. - a gint representing the column at the specified index, + a gint representing the column at the specified index, or -1 if the table does not implement this method. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - a #gint representing an index in @table + a #gint representing an index in @table - - Gets the description text of the specified @column in the table + + Gets the description text of the specified @column in the table - a gchar* representing the column description, or %NULL + a gchar* representing the column description, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - - Gets the number of columns occupied by the accessible object + + Gets the number of columns occupied by the accessible object at the specified @row and @column in the @table. - a gint representing the column extent at specified position, or 0 + a gint representing the column extent at specified position, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - - Gets the column header of a specified column in an accessible table. + + Gets the column header of a specified column in an accessible table. - a AtkObject* representing the + a AtkObject* representing the specified column header, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in the table + a #gint representing a column in the table - - Gets a #gint representing the index at the specified @row and + + Gets a #gint representing the index at the specified @row and @column. Since 2.12. Use atk_table_ref_at() in order to get the accessible that represents the cell at (@row, @column) - a #gint representing the index at specified position. + a #gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - Gets the number of columns in the table. + Gets the number of columns in the table. - a gint representing the number of columns, or 0 + a gint representing the number of columns, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - Gets the number of rows in the table. + Gets the number of rows in the table. - a gint representing the number of rows, or 0 + a gint representing the number of rows, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - - Gets a #gint representing the row at the specified @index_. + + Gets a #gint representing the row at the specified @index_. since 2.12. - a gint representing the row at the specified index, + a gint representing the row at the specified index, or -1 if the table does not implement this method. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - a #gint representing an index in @table + a #gint representing an index in @table - - Gets the description text of the specified row in the table + + Gets the description text of the specified row in the table - a gchar* representing the row description, or + a gchar* representing the row description, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - - Gets the number of rows occupied by the accessible object + + Gets the number of rows occupied by the accessible object at a specified @row and @column in the @table. - a gint representing the row extent at specified position, or 0 + a gint representing the row extent at specified position, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - Gets the row header of a specified row in an accessible table. + Gets the row header of a specified row in an accessible table. - a AtkObject* representing the + a AtkObject* representing the specified row header, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in the table + a #gint representing a row in the table - - Gets the selected columns of the table by initializing **selected with + + Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller. - a gint representing the number of selected columns, + a gint representing the number of selected columns, or %0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint** that is to contain the selected columns numbers + a #gint** that is to contain the selected columns numbers - - Gets the selected rows of the table by initializing **selected with + + Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller. - a gint representing the number of selected rows, + a gint representing the number of selected rows, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint** that is to contain the selected row numbers + a #gint** that is to contain the selected row numbers - Gets the summary description of the table. + Gets the summary description of the table. - a AtkObject* representing a summary description + a AtkObject* representing a summary description of the table, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - - Gets a boolean value indicating whether the specified @column + + Gets a boolean value indicating whether the specified @column is selected - a gboolean representing if the column is selected, or 0 + a gboolean representing if the column is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - Gets a boolean value indicating whether the specified @row + Gets a boolean value indicating whether the specified @row is selected - a gboolean representing if the row is selected, or 0 + a gboolean representing if the row is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - Gets a boolean value indicating whether the accessible object + Gets a boolean value indicating whether the accessible object at the specified @row and @column is selected - a gboolean representing if the cell is selected, or 0 + a gboolean representing if the cell is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - Get a reference to the table cell at @row, @column. This cell + Get a reference to the table cell at @row, @column. This cell should implement the interface #AtkTableCell - an #AtkObject representing the referred + an #AtkObject representing the referred to accessible - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table - - Adds the specified @column to the selection. + + Adds the specified @column to the selection. - a gboolean representing if the column was successfully removed from + a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - - Removes the specified @row from the selection. + + Removes the specified @row from the selection. - a gboolean representing if the row was successfully removed from + a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - Sets the caption for the table. + Sets the caption for the table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #AtkObject representing the caption to set for @table + a #AtkObject representing the caption to set for @table - - Sets the description text for the specified @column of the @table. + + Sets the description text for the specified @column of the @table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - a #gchar representing the description text + a #gchar representing the description text to set for the specified @column of the @table - - Sets the specified column header to @header. + + Sets the specified column header to @header. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - an #AtkTable + an #AtkTable - - Sets the description text for the specified @row of @table. + + Sets the description text for the specified @row of @table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gchar representing the description text + a #gchar representing the description text to set for the specified @row of @table - Sets the specified row header to @header. + Sets the specified row header to @header. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - an #AtkTable + an #AtkTable - Sets the summary description of the table. + Sets the summary description of the table. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - an #AtkObject representing the summary description + an #AtkObject representing the summary description to set for @table - The "column-deleted" signal is emitted by an object which + The "column-deleted" signal is emitted by an object which implements the AtkTable interface when a column is deleted. - The index of the first column deleted. + The index of the first column deleted. - The number of columns deleted. + The number of columns deleted. - The "column-inserted" signal is emitted by an object which + The "column-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted. - The index of the column inserted. + The index of the column inserted. - The number of colums inserted. + The number of colums inserted. - The "column-reordered" signal is emitted by an object which + The "column-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered. @@ -15999,9 +11017,7 @@ reordered. - The "model-changed" signal is emitted by an object which + The "model-changed" signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes. @@ -16009,55 +11025,41 @@ the table changes. - The "row-deleted" signal is emitted by an object which + The "row-deleted" signal is emitted by an object which implements the AtkTable interface when a row is deleted. - The index of the first row deleted. + The index of the first row deleted. - The number of rows deleted. + The number of rows deleted. - The "row-inserted" signal is emitted by an object which + The "row-inserted" signal is emitted by an object which implements the AtkTable interface when a row is inserted. - The index of the first row inserted. + The index of the first row inserted. - The number of rows inserted. + The number of rows inserted. - The "row-reordered" signal is emitted by an object which + The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the rows are reordered. @@ -16065,32 +11067,19 @@ reordered. - - Being #AtkTable a component which present elements ordered via rows + + Being #AtkTable a component which present elements ordered via rows and columns, an #AtkTableCell is the interface which each of those elements, so "cells" should implement. See also #AtkTable. - - Returns the column headers as an array of cell accessibles. + + Returns the column headers as an array of cell accessibles. - a GPtrArray of AtkObjects + a GPtrArray of AtkObjects representing the column header cells. @@ -16098,149 +11087,87 @@ representing the column header cells. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Returns the number of columns occupied by this cell accessible. + + Returns the number of columns occupied by this cell accessible. - a gint representing the number of columns occupied by this cell, + a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Retrieves the tabular position of this cell. + + Retrieves the tabular position of this cell. - TRUE if successful; FALSE otherwise. + TRUE if successful; FALSE otherwise. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - the row of the given cell. + + the row of the given cell. - - the column of the given cell. + + the column of the given cell. - - Gets the row and column indexes and span of this cell accessible. + + Gets the row and column indexes and span of this cell accessible. Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object. - TRUE if successful; FALSE otherwise. + TRUE if successful; FALSE otherwise. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - the row index of the given cell. + + the row index of the given cell. - - the column index of the given cell. + + the column index of the given cell. - - the number of rows occupied by this cell. + + the number of rows occupied by this cell. - - the number of columns occupied by this cell. + + the number of columns occupied by this cell. - - Returns the row headers as an array of cell accessibles. + + Returns the row headers as an array of cell accessibles. - a GPtrArray of AtkObjects + a GPtrArray of AtkObjects representing the row header cells. @@ -16248,67 +11175,45 @@ representing the row header cells. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Returns the number of rows occupied by this cell accessible. + + Returns the number of rows occupied by this cell accessible. - a gint representing the number of rows occupied by this cell, + a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - Returns a reference to the accessible of the containing table. + Returns a reference to the accessible of the containing table. - the atk object for the containing table. + the atk object for the containing table. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Returns the column headers as an array of cell accessibles. + + Returns the column headers as an array of cell accessibles. - a GPtrArray of AtkObjects + a GPtrArray of AtkObjects representing the column header cells. @@ -16316,149 +11221,87 @@ representing the column header cells. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Returns the number of columns occupied by this cell accessible. + + Returns the number of columns occupied by this cell accessible. - a gint representing the number of columns occupied by this cell, + a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Retrieves the tabular position of this cell. + + Retrieves the tabular position of this cell. - TRUE if successful; FALSE otherwise. + TRUE if successful; FALSE otherwise. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - the row of the given cell. + + the row of the given cell. - - the column of the given cell. + + the column of the given cell. - - Gets the row and column indexes and span of this cell accessible. + + Gets the row and column indexes and span of this cell accessible. Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object. - TRUE if successful; FALSE otherwise. + TRUE if successful; FALSE otherwise. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - the row index of the given cell. + + the row index of the given cell. - - the column index of the given cell. + + the column index of the given cell. - - the number of rows occupied by this cell. + + the number of rows occupied by this cell. - - the number of columns occupied by this cell. + + the number of columns occupied by this cell. - - Returns the row headers as an array of cell accessibles. + + Returns the row headers as an array of cell accessibles. - a GPtrArray of AtkObjects + a GPtrArray of AtkObjects representing the row header cells. @@ -16466,66 +11309,43 @@ representing the row header cells. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Returns the number of rows occupied by this cell accessible. + + Returns the number of rows occupied by this cell accessible. - a gint representing the number of rows occupied by this cell, + a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - Returns a reference to the accessible of the containing table. + + Returns a reference to the accessible of the containing table. - the atk object for the containing table. + the atk object for the containing table. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - AtkTableCell is an interface for cells inside an #AtkTable. + + AtkTableCell is an interface for cells inside an #AtkTable. @@ -16534,17 +11354,13 @@ or 0 if the cell does not implement this method. - a gint representing the number of columns occupied by this cell, + a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface @@ -16554,9 +11370,7 @@ or 0 if the cell does not implement this method. - a GPtrArray of AtkObjects + a GPtrArray of AtkObjects representing the column header cells. @@ -16564,9 +11378,7 @@ representing the column header cells. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface @@ -16576,34 +11388,20 @@ representing the column header cells. - TRUE if successful; FALSE otherwise. + TRUE if successful; FALSE otherwise. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - the row of the given cell. + + the row of the given cell. - - the column of the given cell. + + the column of the given cell. @@ -16613,17 +11411,13 @@ representing the column header cells. - a gint representing the number of rows occupied by this cell, + a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface @@ -16633,9 +11427,7 @@ or 0 if the cell does not implement this method. - a GPtrArray of AtkObjects + a GPtrArray of AtkObjects representing the row header cells. @@ -16643,9 +11435,7 @@ representing the row header cells. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface @@ -16655,52 +11445,28 @@ representing the row header cells. - TRUE if successful; FALSE otherwise. + TRUE if successful; FALSE otherwise. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - - the row index of the given cell. + + the row index of the given cell. - - the column index of the given cell. + + the column index of the given cell. - - the number of rows occupied by this cell. + + the number of rows occupied by this cell. - - the number of columns occupied by this cell. + + the number of columns occupied by this cell. @@ -16710,25 +11476,19 @@ representing the row header cells. - the atk object for the containing table. + the atk object for the containing table. - a GObject instance that implements AtkTableCellIface + a GObject instance that implements AtkTableCellIface - + @@ -16737,29 +11497,21 @@ representing the row header cells. - an #AtkObject representing the referred + an #AtkObject representing the referred to accessible - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table @@ -16769,30 +11521,22 @@ to accessible - a #gint representing the index at specified position. + a #gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table @@ -16802,23 +11546,17 @@ of table or table does not implement this interface. - a gint representing the column at the specified index, + a gint representing the column at the specified index, or -1 if the table does not implement this method. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - a #gint representing an index in @table + a #gint representing an index in @table @@ -16828,23 +11566,17 @@ or -1 if the table does not implement this method. - a gint representing the row at the specified index, + a gint representing the row at the specified index, or -1 if the table does not implement this method. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface - a #gint representing an index in @table + a #gint representing an index in @table @@ -16854,17 +11586,13 @@ or -1 if the table does not implement this method. - a gint representing the number of columns, or 0 + a gint representing the number of columns, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface @@ -16874,17 +11602,13 @@ if value does not implement this interface. - a gint representing the number of rows, or 0 + a gint representing the number of rows, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface @@ -16894,29 +11618,21 @@ if value does not implement this interface. - a gint representing the column extent at specified position, or 0 + a gint representing the column extent at specified position, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table @@ -16926,29 +11642,21 @@ if value does not implement this interface. - a gint representing the row extent at specified position, or 0 + a gint representing the row extent at specified position, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table @@ -16958,17 +11666,13 @@ if value does not implement this interface. - a AtkObject* representing the + a AtkObject* representing the table caption, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableInterface + a GObject instance that implements AtkTableInterface @@ -16978,23 +11682,17 @@ table caption, or %NULL if value does not implement this interface. - a gchar* representing the column description, or %NULL + a gchar* representing the column description, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table @@ -17004,24 +11702,18 @@ if value does not implement this interface. - a AtkObject* representing the + a AtkObject* representing the specified column header, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in the table + a #gint representing a column in the table @@ -17031,23 +11723,17 @@ interface. - a gchar* representing the row description, or + a gchar* representing the row description, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table @@ -17057,24 +11743,18 @@ interface. - a AtkObject* representing the + a AtkObject* representing the specified row header, or %NULL if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in the table + a #gint representing a row in the table @@ -17084,17 +11764,13 @@ interface. - a AtkObject* representing a summary description + a AtkObject* representing a summary description of the table, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface @@ -17108,15 +11784,11 @@ of the table, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #AtkObject representing the caption to set for @table + a #AtkObject representing the caption to set for @table @@ -17130,21 +11802,15 @@ of the table, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - a #gchar representing the description text + a #gchar representing the description text to set for the specified @column of the @table @@ -17159,21 +11825,15 @@ to set for the specified @column of the @table - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table - an #AtkTable + an #AtkTable @@ -17187,21 +11847,15 @@ to set for the specified @column of the @table - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gchar representing the description text + a #gchar representing the description text to set for the specified @row of @table @@ -17216,21 +11870,15 @@ to set for the specified @row of @table - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - an #AtkTable + an #AtkTable @@ -17244,15 +11892,11 @@ to set for the specified @row of @table - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - an #AtkObject representing the summary description + an #AtkObject representing the summary description to set for @table @@ -17263,23 +11907,17 @@ to set for @table - a gint representing the number of selected columns, + a gint representing the number of selected columns, or %0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint** that is to contain the selected columns numbers + a #gint** that is to contain the selected columns numbers @@ -17289,23 +11927,17 @@ or %0 if value does not implement this interface. - a gint representing the number of selected rows, + a gint representing the number of selected rows, or zero if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint** that is to contain the selected row numbers + a #gint** that is to contain the selected row numbers @@ -17315,23 +11947,17 @@ or zero if value does not implement this interface. - a gboolean representing if the column is selected, or 0 + a gboolean representing if the column is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table @@ -17341,23 +11967,17 @@ if value does not implement this interface. - a gboolean representing if the row is selected, or 0 + a gboolean representing if the row is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table @@ -17367,29 +11987,21 @@ if value does not implement this interface. - a gboolean representing if the cell is selected, or 0 + a gboolean representing if the cell is selected, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table - a #gint representing a column in @table + a #gint representing a column in @table @@ -17399,23 +12011,17 @@ if value does not implement this interface. - a gboolean representing if row was successfully added to selection, + a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table @@ -17425,23 +12031,17 @@ or 0 if value does not implement this interface. - a gboolean representing if the row was successfully removed from + a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a row in @table + a #gint representing a row in @table @@ -17451,23 +12051,17 @@ the selection, or 0 if value does not implement this interface. - a gboolean representing if the column was successfully added to + a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table @@ -17477,23 +12071,17 @@ the selection, or 0 if value does not implement this interface. - a gboolean representing if the column was successfully removed from + a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface. - a GObject instance that implements AtkTableIface + a GObject instance that implements AtkTableIface - a #gint representing a column in @table + a #gint representing a column in @table @@ -17615,15 +12203,8 @@ the selection, or 0 if value does not implement this interface. - - #AtkText should be implemented by #AtkObjects on behalf of widgets + + #AtkText should be implemented by #AtkObjects on behalf of widgets that have text content which is either attributed or otherwise non-trivial. #AtkObjects whose text content is simple, unattributed, and very brief may expose that content via @@ -17643,12 +12224,8 @@ caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures. - - Frees the memory associated with an array of AtkTextRange. It is assumed + + Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated. @@ -17657,9 +12234,7 @@ and is NULL terminated. - A pointer to an array of #AtkTextRange which is + A pointer to an array of #AtkTextRange which is to be freed. @@ -17668,48 +12243,32 @@ and is NULL terminated. - Adds a selection bounded by the specified offsets. + Adds a selection bounded by the specified offsets. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - the starting character offset of the selected region + the starting character offset of the selected region - the offset of the first character after the selected region. + the offset of the first character after the selected region. - - Get the ranges of text in the specified bounding box. + + Get the ranges of text in the specified bounding box. - Array of AtkTextRange. The last + Array of AtkTextRange. The last element of the array returned by this function will be NULL. @@ -17717,111 +12276,77 @@ and is NULL terminated. - an #AtkText + an #AtkText - An AtkTextRectangle giving the dimensions of the bounding box. + An AtkTextRectangle giving the dimensions of the bounding box. - Specify whether coordinates are relative to the screen or widget window. + Specify whether coordinates are relative to the screen or widget window. - Specify the horizontal clip type. + Specify the horizontal clip type. - Specify the vertical clip type. + Specify the vertical clip type. - Gets the offset of the position of the caret (cursor). + Gets the offset of the position of the caret (cursor). - the character offset of the position of the caret or -1 if + the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. - an #AtkText + an #AtkText - - Gets the specified text. + + Gets the specified text. - the character at @offset or 0 in the case of failure. + the character at @offset or 0 in the case of failure. - an #AtkText + an #AtkText - a character offset within @text + a character offset within @text - Gets the character count. + Gets the character count. - the number of characters or -1 in case of failure. + the number of characters or -1 in case of failure. - an #AtkText + an #AtkText - - If the extent can not be obtained (e.g. missing support), all of x, y, width, + + If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1. Get the bounding box containing the glyph representing the character at @@ -17832,163 +12357,100 @@ Get the bounding box containing the glyph representing the character at - an #AtkText + an #AtkText - The offset of the text character for which bounding information is required. + The offset of the text character for which bounding information is required. - - Pointer for the x coordinate of the bounding box + + Pointer for the x coordinate of the bounding box - - Pointer for the y coordinate of the bounding box + + Pointer for the y coordinate of the bounding box - - Pointer for the width of the bounding box + + Pointer for the width of the bounding box - - Pointer for the height of the bounding box + + Pointer for the height of the bounding box - specify whether coordinates are relative to the screen or widget window + specify whether coordinates are relative to the screen or widget window - - Creates an #AtkAttributeSet which consists of the default values of + + Creates an #AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. - an #AtkAttributeSet which contains the default text + an #AtkAttributeSet which contains the default text attributes for this #AtkText. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). - an #AtkText + an #AtkText - Gets the number of selected regions. + Gets the number of selected regions. - The number of selected regions, or -1 in the case of failure. + The number of selected regions, or -1 in the case of failure. - an #AtkText + an #AtkText - Gets the offset of the character located at coordinates @x and @y. @x and @y + Gets the offset of the character located at coordinates @x and @y. @x and @y are interpreted as being relative to the screen or this widget's window depending on @coords. - the offset to the character which is located at the specified + the offset to the character which is located at the specified @x and @y coordinates of -1 in case of failure. - an #AtkText + an #AtkText - screen x-position of character + screen x-position of character - screen y-position of character + screen y-position of character - specify whether coordinates are relative to the screen or + specify whether coordinates are relative to the screen or widget window - - Get the bounding box for text within the specified range. + + Get the bounding box for text within the specified range. If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1. @@ -17998,46 +12460,31 @@ fields are set to -1. - an #AtkText + an #AtkText - The offset of the first text character for which boundary + The offset of the first text character for which boundary information is required. - The offset of the text character after the last character + The offset of the text character after the last character for which boundary information is required. - Specify whether coordinates are relative to the screen or widget window. + Specify whether coordinates are relative to the screen or widget window. - - A pointer to a AtkTextRectangle which is filled in by this function. + + A pointer to a AtkTextRectangle which is filled in by this function. - Creates an #AtkAttributeSet which consists of the attributes explicitly + Creates an #AtkAttributeSet which consists of the attributes explicitly set at the position @offset in the text. @start_offset and @end_offset are set to the start and end of the range around @offset where the attributes are invariant. Note that @end_offset is the offset of the first character @@ -18046,103 +12493,65 @@ attributes that can be returned. Note that other attributes may also be returned. - an #AtkAttributeSet which contains the attributes + an #AtkAttributeSet which contains the attributes explicitly set at @offset. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). - an #AtkText + an #AtkText - the character offset at which to get the attributes, -1 means the offset of + the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. - - the address to put the start offset of the range + + the address to put the start offset of the range - - the address to put the end offset of the range + + the address to put the end offset of the range - Gets the text from the specified selection. + Gets the text from the specified selection. - a newly allocated string containing the selected text. Use g_free() + a newly allocated string containing the selected text. Use g_free() to free the returned string. - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. - - passes back the starting character offset of the selected region + + passes back the starting character offset of the selected region - - passes back the ending character offset (offset immediately past) + + passes back the ending character offset (offset immediately past) of the selected region - - Gets a portion of the text exposed through an #AtkText according to a given @offset + + Gets a portion of the text exposed through an #AtkText according to a given @offset and a specific @granularity, along with the start and end offsets defining the boundaries of such a portion of text. @@ -18174,9 +12583,7 @@ is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. - a newly allocated string containing the text at + a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. @@ -18184,142 +12591,89 @@ of the following paragraph after the offset. - an #AtkText + an #AtkText - position + position - An #AtkTextGranularity + An #AtkTextGranularity - - the starting character offset of the returned string, or -1 + + the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) - - the offset of the first character after the returned string, + + the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) - Gets the specified text. + Gets the specified text. - a newly allocated string containing the text from @start_offset up + a newly allocated string containing the text from @start_offset up to, but not including @end_offset. Use g_free() to free the returned string. - an #AtkText + an #AtkText - a starting character offset within @text + a starting character offset within @text - an ending character offset within @text, or -1 for the end of the string. + an ending character offset within @text, or -1 for the end of the string. - - Gets the specified text. + + Gets the specified text. Please use atk_text_get_string_at_offset() instead. - a newly allocated string containing the text after @offset bounded + a newly allocated string containing the text after @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring - - Gets the specified text. + + Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned. @@ -18347,132 +12701,83 @@ start after the offset. 2.9.4. Please use atk_text_get_string_at_offset() instead. - a newly allocated string containing the text at @offset bounded + a newly allocated string containing the text at @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring - - Gets the specified text. + + Gets the specified text. Please use atk_text_get_string_at_offset() instead. - a newly allocated string containing the text before @offset bounded + a newly allocated string containing the text before @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring - Removes the specified selection. + Removes the specified selection. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, @@ -18481,104 +12786,70 @@ moving or deleting a selected region can change the numbering. - - Makes a substring of @text visible on the screen by scrolling all necessary parents. + + Makes a substring of @text visible on the screen by scrolling all necessary parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkText + an #AtkText - start offset in the @text + start offset in the @text - end offset in the @text, or -1 for the end of the text. + end offset in the @text, or -1 for the end of the text. - specify where the object should be made visible. + specify where the object should be made visible. - - Move the top-left of a substring of @text to a given position of the screen + + Move the top-left of a substring of @text to a given position of the screen by scrolling all necessary parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkText + an #AtkText - start offset in the @text + start offset in the @text - end offset in the @text, or -1 for the end of the text. + end offset in the @text, or -1 for the end of the text. - specify whether coordinates are relative to the screen or to the + specify whether coordinates are relative to the screen or to the parent object. - x-position where to scroll to + x-position where to scroll to - y-position where to scroll to + y-position where to scroll to - Sets the caret (cursor) position to the specified @offset. + Sets the caret (cursor) position to the specified @offset. In the case of rich-text content, this method should either grab focus or move the sequential focus navigation starting point (if the application @@ -18597,48 +12868,34 @@ motion or focus navigation operation, this method should try to scroll the new caret position into view while minimizing unnecessary scroll motion. - %TRUE if successful, %FALSE otherwise. + %TRUE if successful, %FALSE otherwise. - an #AtkText + an #AtkText - the character offset of the new caret position + the character offset of the new caret position - Changes the start and end offset of the specified selection. + Changes the start and end offset of the specified selection. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, @@ -18646,15 +12903,11 @@ moving or deleting a selected region can change the numbering. - the new starting character offset of the selection + the new starting character offset of the selection - the new end position of (e.g. offset immediately past) + the new end position of (e.g. offset immediately past) the selection @@ -18714,48 +12967,32 @@ the selection - Adds a selection bounded by the specified offsets. + Adds a selection bounded by the specified offsets. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - the starting character offset of the selected region + the starting character offset of the selected region - the offset of the first character after the selected region. + the offset of the first character after the selected region. - - Get the ranges of text in the specified bounding box. + + Get the ranges of text in the specified bounding box. - Array of AtkTextRange. The last + Array of AtkTextRange. The last element of the array returned by this function will be NULL. @@ -18763,112 +13000,77 @@ the selection - an #AtkText + an #AtkText - An AtkTextRectangle giving the dimensions of the bounding box. + An AtkTextRectangle giving the dimensions of the bounding box. - Specify whether coordinates are relative to the screen or widget window. + Specify whether coordinates are relative to the screen or widget window. - Specify the horizontal clip type. + Specify the horizontal clip type. - Specify the vertical clip type. + Specify the vertical clip type. - Gets the offset of the position of the caret (cursor). + Gets the offset of the position of the caret (cursor). - the character offset of the position of the caret or -1 if + the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. - an #AtkText + an #AtkText - - Gets the specified text. + + Gets the specified text. - the character at @offset or 0 in the case of failure. + the character at @offset or 0 in the case of failure. - an #AtkText + an #AtkText - a character offset within @text + a character offset within @text - - Gets the character count. + + Gets the character count. - the number of characters or -1 in case of failure. + the number of characters or -1 in case of failure. - an #AtkText + an #AtkText - - If the extent can not be obtained (e.g. missing support), all of x, y, width, + + If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1. Get the bounding box containing the glyph representing the character at @@ -18879,164 +13081,100 @@ Get the bounding box containing the glyph representing the character at - an #AtkText + an #AtkText - The offset of the text character for which bounding information is required. + The offset of the text character for which bounding information is required. - - Pointer for the x coordinate of the bounding box + + Pointer for the x coordinate of the bounding box - - Pointer for the y coordinate of the bounding box + + Pointer for the y coordinate of the bounding box - - Pointer for the width of the bounding box + + Pointer for the width of the bounding box - - Pointer for the height of the bounding box + + Pointer for the height of the bounding box - specify whether coordinates are relative to the screen or widget window + specify whether coordinates are relative to the screen or widget window - - Creates an #AtkAttributeSet which consists of the default values of + + Creates an #AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. - an #AtkAttributeSet which contains the default text + an #AtkAttributeSet which contains the default text attributes for this #AtkText. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). - an #AtkText + an #AtkText - Gets the number of selected regions. + Gets the number of selected regions. - The number of selected regions, or -1 in the case of failure. + The number of selected regions, or -1 in the case of failure. - an #AtkText + an #AtkText - - Gets the offset of the character located at coordinates @x and @y. @x and @y + + Gets the offset of the character located at coordinates @x and @y. @x and @y are interpreted as being relative to the screen or this widget's window depending on @coords. - the offset to the character which is located at the specified + the offset to the character which is located at the specified @x and @y coordinates of -1 in case of failure. - an #AtkText + an #AtkText - screen x-position of character + screen x-position of character - screen y-position of character + screen y-position of character - specify whether coordinates are relative to the screen or + specify whether coordinates are relative to the screen or widget window - - Get the bounding box for text within the specified range. + + Get the bounding box for text within the specified range. If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1. @@ -19046,47 +13184,31 @@ fields are set to -1. - an #AtkText + an #AtkText - The offset of the first text character for which boundary + The offset of the first text character for which boundary information is required. - The offset of the text character after the last character + The offset of the text character after the last character for which boundary information is required. - Specify whether coordinates are relative to the screen or widget window. + Specify whether coordinates are relative to the screen or widget window. - - A pointer to a AtkTextRectangle which is filled in by this function. + + A pointer to a AtkTextRectangle which is filled in by this function. - - Creates an #AtkAttributeSet which consists of the attributes explicitly + + Creates an #AtkAttributeSet which consists of the attributes explicitly set at the position @offset in the text. @start_offset and @end_offset are set to the start and end of the range around @offset where the attributes are invariant. Note that @end_offset is the offset of the first character @@ -19095,103 +13217,65 @@ attributes that can be returned. Note that other attributes may also be returned. - an #AtkAttributeSet which contains the attributes + an #AtkAttributeSet which contains the attributes explicitly set at @offset. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). - an #AtkText + an #AtkText - the character offset at which to get the attributes, -1 means the offset of + the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. - - the address to put the start offset of the range + + the address to put the start offset of the range - - the address to put the end offset of the range + + the address to put the end offset of the range - Gets the text from the specified selection. + Gets the text from the specified selection. - a newly allocated string containing the selected text. Use g_free() + a newly allocated string containing the selected text. Use g_free() to free the returned string. - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. - - passes back the starting character offset of the selected region + + passes back the starting character offset of the selected region - - passes back the ending character offset (offset immediately past) + + passes back the ending character offset (offset immediately past) of the selected region - - Gets a portion of the text exposed through an #AtkText according to a given @offset + + Gets a portion of the text exposed through an #AtkText according to a given @offset and a specific @granularity, along with the start and end offsets defining the boundaries of such a portion of text. @@ -19223,9 +13307,7 @@ is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. - a newly allocated string containing the text at + a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. @@ -19233,142 +13315,89 @@ of the following paragraph after the offset. - an #AtkText + an #AtkText - position + position - An #AtkTextGranularity + An #AtkTextGranularity - - the starting character offset of the returned string, or -1 + + the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) - - the offset of the first character after the returned string, + + the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) - Gets the specified text. + Gets the specified text. - a newly allocated string containing the text from @start_offset up + a newly allocated string containing the text from @start_offset up to, but not including @end_offset. Use g_free() to free the returned string. - an #AtkText + an #AtkText - a starting character offset within @text + a starting character offset within @text - an ending character offset within @text, or -1 for the end of the string. + an ending character offset within @text, or -1 for the end of the string. - - Gets the specified text. + + Gets the specified text. Please use atk_text_get_string_at_offset() instead. - a newly allocated string containing the text after @offset bounded + a newly allocated string containing the text after @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring - - Gets the specified text. + + Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned. @@ -19396,132 +13425,83 @@ start after the offset. 2.9.4. Please use atk_text_get_string_at_offset() instead. - a newly allocated string containing the text at @offset bounded + a newly allocated string containing the text at @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring - - Gets the specified text. + + Gets the specified text. Please use atk_text_get_string_at_offset() instead. - a newly allocated string containing the text before @offset bounded + a newly allocated string containing the text before @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring - Removes the specified selection. + Removes the specified selection. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, @@ -19530,104 +13510,70 @@ moving or deleting a selected region can change the numbering. - - Makes a substring of @text visible on the screen by scrolling all necessary parents. + + Makes a substring of @text visible on the screen by scrolling all necessary parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkText + an #AtkText - start offset in the @text + start offset in the @text - end offset in the @text, or -1 for the end of the text. + end offset in the @text, or -1 for the end of the text. - specify where the object should be made visible. + specify where the object should be made visible. - - Move the top-left of a substring of @text to a given position of the screen + + Move the top-left of a substring of @text to a given position of the screen by scrolling all necessary parents. - whether scrolling was successful. + whether scrolling was successful. - an #AtkText + an #AtkText - start offset in the @text + start offset in the @text - end offset in the @text, or -1 for the end of the text. + end offset in the @text, or -1 for the end of the text. - specify whether coordinates are relative to the screen or to the + specify whether coordinates are relative to the screen or to the parent object. - x-position where to scroll to + x-position where to scroll to - y-position where to scroll to + y-position where to scroll to - Sets the caret (cursor) position to the specified @offset. + Sets the caret (cursor) position to the specified @offset. In the case of rich-text content, this method should either grab focus or move the sequential focus navigation starting point (if the application @@ -19646,48 +13592,34 @@ motion or focus navigation operation, this method should try to scroll the new caret position into view while minimizing unnecessary scroll motion. - %TRUE if successful, %FALSE otherwise. + %TRUE if successful, %FALSE otherwise. - an #AtkText + an #AtkText - the character offset of the new caret position + the character offset of the new caret position - Changes the start and end offset of the specified selection. + Changes the start and end offset of the specified selection. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, @@ -19695,24 +13627,18 @@ moving or deleting a selected region can change the numbering. - the new starting character offset of the selection + the new starting character offset of the selection - the new end position of (e.g. offset immediately past) + the new end position of (e.g. offset immediately past) the selection - The "text-attributes-changed" signal is emitted when the text + The "text-attributes-changed" signal is emitted when the text attributes of the text of an object which implements AtkText changes. @@ -19720,9 +13646,7 @@ changes. - The "text-caret-moved" signal is emitted when the caret + The "text-caret-moved" signal is emitted when the caret position of the text of an object which implements AtkText changes. @@ -19730,21 +13654,13 @@ changes. - The new position of the text caret. + The new position of the text caret. - - The "text-changed" signal is emitted when the text of the + + The "text-changed" signal is emitted when the text of the object which implements the AtkText interface changes, This signal will have a detail which is either "insert" or "delete" which identifies whether the text change was an @@ -19756,23 +13672,17 @@ insertion or a deletion. - The position (character offset) of the insertion or deletion. + The position (character offset) of the insertion or deletion. - The length (in characters) of text inserted or deleted. + The length (in characters) of text inserted or deleted. - The "text-insert" signal is emitted when a new text is + The "text-insert" signal is emitted when a new text is inserted. If the signal was not triggered by the user (e.g. typing or pasting text), the "system" detail should be included. @@ -19781,29 +13691,21 @@ included. - The position (character offset) of the insertion. + The position (character offset) of the insertion. - The length (in characters) of text inserted. + The length (in characters) of text inserted. - The new text inserted + The new text inserted - The "text-remove" signal is emitted when a new text is + The "text-remove" signal is emitted when a new text is removed. If the signal was not triggered by the user (e.g. typing or pasting text), the "system" detail should be included. @@ -19812,547 +13714,261 @@ included. - The position (character offset) of the removal. + The position (character offset) of the removal. - The length (in characters) of text removed. + The length (in characters) of text removed. - The old text removed + The old text removed - The "text-selection-changed" signal is emitted when the + The "text-selection-changed" signal is emitted when the selected text of an object which implements AtkText changes. - - Describes the text attributes supported - - Invalid attribute, like bad spelling or grammar. + + Describes the text attributes supported + + Invalid attribute, like bad spelling or grammar. - - The pixel width of the left margin + + The pixel width of the left margin - - The pixel width of the right margin + + The pixel width of the right margin - - The number of pixels that the text is indented + + The number of pixels that the text is indented - - Either "true" or "false" indicating whether text is visible or not + + Either "true" or "false" indicating whether text is visible or not - - Either "true" or "false" indicating whether text is editable or not + + Either "true" or "false" indicating whether text is editable or not - - Pixels of blank space to leave above each newline-terminated line. + + Pixels of blank space to leave above each newline-terminated line. - - Pixels of blank space to leave below each newline-terminated line. + + Pixels of blank space to leave below each newline-terminated line. - - Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). + + Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). - - "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. + + "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. - - Number of pixels that the characters are risen above the baseline. See also ATK_TEXT_ATTR_TEXT_POSITION. + + Number of pixels that the characters are risen above the baseline. See also ATK_TEXT_ATTR_TEXT_POSITION. - - "none", "single", "double", "low", or "error" + + "none", "single", "double", "low", or "error" - - "true" or "false" whether the text is strikethrough + + "true" or "false" whether the text is strikethrough - - The size of the characters in points. eg: 10 + + The size of the characters in points. eg: 10 - - The scale of the characters. The value is a string representation of a double + + The scale of the characters. The value is a string representation of a double - - The weight of the characters. + + The weight of the characters. - - The language used + + The language used - - The font family name + + The font family name - - The background color. The value is an RGB value of the format "%u,%u,%u" + + The background color. The value is an RGB value of the format "%u,%u,%u" - - The foreground color. The value is an RGB value of the format "%u,%u,%u" + + The foreground color. The value is an RGB value of the format "%u,%u,%u" - - "true" if a #GdkBitmap is set for stippling the background color. + + "true" if a #GdkBitmap is set for stippling the background color. - - "true" if a #GdkBitmap is set for stippling the foreground color. + + "true" if a #GdkBitmap is set for stippling the foreground color. - - The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char". + + The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char". - - The direction of the text, if set. Values are "none", "ltr" or "rtl" + + The direction of the text, if set. Values are "none", "ltr" or "rtl" - - The justification of the text, if set. Values are "left", "right", "center" or "fill" + + The justification of the text, if set. Values are "left", "right", "center" or "fill" - - The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded" + + The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded" - - The capitalization variant of the text, if set. Values are "normal" or "small_caps" + + The capitalization variant of the text, if set. Values are "normal" or "small_caps" - - The slant style of the text, if set. Values are "normal", "oblique" or "italic" + + The slant style of the text, if set. Values are "normal", "oblique" or "italic" - - The vertical position with respect to the baseline. Values are "baseline", "super", or "sub". Note that a super or sub text attribute refers to position with respect to the baseline of the prior character. + + The vertical position with respect to the baseline. Values are "baseline", "super", or "sub". Note that a super or sub text attribute refers to position with respect to the baseline of the prior character. - - not a valid text attribute, used for finding end of enumeration + + not a valid text attribute, used for finding end of enumeration - Get the #AtkTextAttribute type corresponding to a text attribute name. + Get the #AtkTextAttribute type corresponding to a text attribute name. - the #AtkTextAttribute enumerated type corresponding to the specified + the #AtkTextAttribute enumerated type corresponding to the specified name, or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found. - a string which is the (non-localized) name of an ATK text attribute. + a string which is the (non-localized) name of an ATK text attribute. - Gets the name corresponding to the #AtkTextAttribute + Gets the name corresponding to the #AtkTextAttribute - a string containing the name; this string should not be freed + a string containing the name; this string should not be freed - The #AtkTextAttribute whose name is required + The #AtkTextAttribute whose name is required - Gets the value for the index of the #AtkTextAttribute + Gets the value for the index of the #AtkTextAttribute - a string containing the value; this string + a string containing the value; this string should not be freed; %NULL is returned if there are no values maintained for the attr value. - The #AtkTextAttribute for which a value is required + The #AtkTextAttribute for which a value is required - The index of the required value + The index of the required value - Associate @name with a new #AtkTextAttribute + Associate @name with a new #AtkTextAttribute - an #AtkTextAttribute associated with @name + an #AtkTextAttribute associated with @name - a name string + a name string - - Text boundary types used for specifying boundaries for regions of text. + + Text boundary types used for specifying boundaries for regions of text. This enumeration is deprecated since 2.9.4 and should not be used. Use AtkTextGranularity with #atk_text_get_string_at_offset instead. - - Boundary is the boundary between characters + + Boundary is the boundary between characters (including non-printing characters) - - Boundary is the start (i.e. first character) of a word. + + Boundary is the start (i.e. first character) of a word. - - Boundary is the end (i.e. last + + Boundary is the end (i.e. last character) of a word. - - Boundary is the first character in a sentence. + + Boundary is the first character in a sentence. - - Boundary is the last (terminal) + + Boundary is the last (terminal) character in a sentence; in languages which use "sentence stop" punctuation such as English, the boundary is thus the '.', '?', or similar terminal punctuation character. - - Boundary is the initial character of the content or a + + Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character. - - Boundary is the linefeed, or return + + Boundary is the linefeed, or return character. - - Describes the type of clipping required. - - No clipping to be done + + Describes the type of clipping required. + + No clipping to be done - - Text clipped by min coordinate is omitted + + Text clipped by min coordinate is omitted - - Text clipped by max coordinate is omitted + + Text clipped by max coordinate is omitted - - Only text fully within mix/max bound is retained + + Only text fully within mix/max bound is retained - - Text granularity types used for specifying the granularity of the region of + + Text granularity types used for specifying the granularity of the region of text we are interested in. - - Granularity is defined by the boundaries between characters + + Granularity is defined by the boundaries between characters (including non-printing characters) - - Granularity is defined by the boundaries of a word, + + Granularity is defined by the boundaries of a word, starting at the beginning of the current word and finishing at the beginning of the following one, if present. - - Granularity is defined by the boundaries of a sentence, + + Granularity is defined by the boundaries of a sentence, starting at the beginning of the current sentence and finishing at the beginning of the following one, if present. - - Granularity is defined by the boundaries of a line, + + Granularity is defined by the boundaries of a line, starting at the beginning of the current line and finishing at the beginning of the following one, if present. - - Granularity is defined by the boundaries of a paragraph, + + Granularity is defined by the boundaries of a paragraph, starting at the beginning of the current paragraph and finishing at the beginning of the following one, if present. - + @@ -20361,30 +13977,22 @@ the following one, if present. - a newly allocated string containing the text from @start_offset up + a newly allocated string containing the text from @start_offset up to, but not including @end_offset. Use g_free() to free the returned string. - an #AtkText + an #AtkText - a starting character offset within @text + a starting character offset within @text - an ending character offset within @text, or -1 for the end of the string. + an ending character offset within @text, or -1 for the end of the string. @@ -20394,48 +14002,30 @@ the following one, if present. - a newly allocated string containing the text after @offset bounded + a newly allocated string containing the text after @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring @@ -20446,48 +14036,30 @@ the following one, if present. - a newly allocated string containing the text at @offset bounded + a newly allocated string containing the text at @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring @@ -20498,22 +14070,16 @@ the following one, if present. - the character at @offset or 0 in the case of failure. + the character at @offset or 0 in the case of failure. - an #AtkText + an #AtkText - a character offset within @text + a character offset within @text @@ -20523,48 +14089,30 @@ the following one, if present. - a newly allocated string containing the text before @offset bounded + a newly allocated string containing the text before @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. - an #AtkText + an #AtkText - position + position - An #AtkTextBoundary + An #AtkTextBoundary - - the starting character offset of the returned string + + the starting character offset of the returned string - - the offset of the first character after the + + the offset of the first character after the returned substring @@ -20575,18 +14123,14 @@ the following one, if present. - the character offset of the position of the caret or -1 if + the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. - an #AtkText + an #AtkText @@ -20596,43 +14140,27 @@ the following one, if present. - an #AtkAttributeSet which contains the attributes + an #AtkAttributeSet which contains the attributes explicitly set at @offset. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). - an #AtkText + an #AtkText - the character offset at which to get the attributes, -1 means the offset of + the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. - - the address to put the start offset of the range + + the address to put the start offset of the range - - the address to put the end offset of the range + + the address to put the end offset of the range @@ -20642,18 +14170,14 @@ the character to be inserted at the caret location. - an #AtkAttributeSet which contains the default text + an #AtkAttributeSet which contains the default text attributes for this #AtkText. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). - an #AtkText + an #AtkText @@ -20667,65 +14191,31 @@ the character to be inserted at the caret location. - an #AtkText + an #AtkText - The offset of the text character for which bounding information is required. + The offset of the text character for which bounding information is required. - - Pointer for the x coordinate of the bounding box + + Pointer for the x coordinate of the bounding box - - Pointer for the y coordinate of the bounding box + + Pointer for the y coordinate of the bounding box - - Pointer for the width of the bounding box + + Pointer for the width of the bounding box - - Pointer for the height of the bounding box + + Pointer for the height of the bounding box - specify whether coordinates are relative to the screen or widget window + specify whether coordinates are relative to the screen or widget window @@ -20735,16 +14225,12 @@ the character to be inserted at the caret location. - the number of characters or -1 in case of failure. + the number of characters or -1 in case of failure. - an #AtkText + an #AtkText @@ -20754,35 +14240,25 @@ the character to be inserted at the caret location. - the offset to the character which is located at the specified + the offset to the character which is located at the specified @x and @y coordinates of -1 in case of failure. - an #AtkText + an #AtkText - screen x-position of character + screen x-position of character - screen y-position of character + screen y-position of character - specify whether coordinates are relative to the screen or + specify whether coordinates are relative to the screen or widget window @@ -20793,16 +14269,12 @@ widget window - The number of selected regions, or -1 in the case of failure. + The number of selected regions, or -1 in the case of failure. - an #AtkText + an #AtkText @@ -20812,45 +14284,29 @@ widget window - a newly allocated string containing the selected text. Use g_free() + a newly allocated string containing the selected text. Use g_free() to free the returned string. - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. - - passes back the starting character offset of the selected region + + passes back the starting character offset of the selected region - - passes back the ending character offset (offset immediately past) + + passes back the ending character offset (offset immediately past) of the selected region @@ -20861,28 +14317,20 @@ of the selected region - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - the starting character offset of the selected region + the starting character offset of the selected region - the offset of the first character after the selected region. + the offset of the first character after the selected region. @@ -20892,22 +14340,16 @@ of the selected region - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, @@ -20921,22 +14363,16 @@ moving or deleting a selected region can change the numbering. - %TRUE if successful, %FALSE otherwise + %TRUE if successful, %FALSE otherwise - an #AtkText + an #AtkText - The selection number. The selected regions are + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, @@ -20944,15 +14380,11 @@ moving or deleting a selected region can change the numbering. - the new starting character offset of the selection + the new starting character offset of the selection - the new end position of (e.g. offset immediately past) + the new end position of (e.g. offset immediately past) the selection @@ -20963,22 +14395,16 @@ the selection - %TRUE if successful, %FALSE otherwise. + %TRUE if successful, %FALSE otherwise. - an #AtkText + an #AtkText - the character offset of the new caret position + the character offset of the new caret position @@ -21053,38 +14479,25 @@ the selection - an #AtkText + an #AtkText - The offset of the first text character for which boundary + The offset of the first text character for which boundary information is required. - The offset of the text character after the last character + The offset of the text character after the last character for which boundary information is required. - Specify whether coordinates are relative to the screen or widget window. + Specify whether coordinates are relative to the screen or widget window. - - A pointer to a AtkTextRectangle which is filled in by this function. + + A pointer to a AtkTextRectangle which is filled in by this function. @@ -21094,9 +14507,7 @@ the selection - Array of AtkTextRange. The last + Array of AtkTextRange. The last element of the array returned by this function will be NULL. @@ -21104,33 +14515,23 @@ the selection - an #AtkText + an #AtkText - An AtkTextRectangle giving the dimensions of the bounding box. + An AtkTextRectangle giving the dimensions of the bounding box. - Specify whether coordinates are relative to the screen or widget window. + Specify whether coordinates are relative to the screen or widget window. - Specify the horizontal clip type. + Specify the horizontal clip type. - Specify the vertical clip type. + Specify the vertical clip type. @@ -21140,9 +14541,7 @@ the selection - a newly allocated string containing the text at + a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. @@ -21150,40 +14549,24 @@ the selection - an #AtkText + an #AtkText - position + position - An #AtkTextGranularity + An #AtkTextGranularity - - the starting character offset of the returned string, or -1 + + the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) - - the offset of the first character after the returned string, + + the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) @@ -21194,34 +14577,24 @@ the selection - whether scrolling was successful. + whether scrolling was successful. - an #AtkText + an #AtkText - start offset in the @text + start offset in the @text - end offset in the @text, or -1 for the end of the text. + end offset in the @text, or -1 for the end of the text. - specify where the object should be made visible. + specify where the object should be made visible. @@ -21231,120 +14604,80 @@ the selection - whether scrolling was successful. + whether scrolling was successful. - an #AtkText + an #AtkText - start offset in the @text + start offset in the @text - end offset in the @text, or -1 for the end of the text. + end offset in the @text, or -1 for the end of the text. - specify whether coordinates are relative to the screen or to the + specify whether coordinates are relative to the screen or to the parent object. - x-position where to scroll to + x-position where to scroll to - y-position where to scroll to + y-position where to scroll to - - A structure used to describe a text range. + + A structure used to describe a text range. - A rectangle giving the bounds of the text range + A rectangle giving the bounds of the text range - The start offset of a AtkTextRange + The start offset of a AtkTextRange - The end offset of a AtkTextRange + The end offset of a AtkTextRange - The text in the text range + The text in the text range - A structure used to store a rectangle used by AtkText. + A structure used to store a rectangle used by AtkText. - The horizontal coordinate of a rectangle + The horizontal coordinate of a rectangle - The vertical coordinate of a rectangle + The vertical coordinate of a rectangle - The width of a rectangle + The width of a rectangle - The height of a rectangle + The height of a rectangle - + @@ -21360,34 +14693,22 @@ parent object. - + - + - - A set of ATK utility functions which are used to support event + + A set of ATK utility functions which are used to support event registration of various types, and obtaining the 'root' accessible of a process and information about the current ATK implementation and toolkit version. @@ -21396,9 +14717,7 @@ and toolkit version. - + @@ -21411,8 +14730,7 @@ and toolkit version. - + @@ -21443,10 +14761,7 @@ and toolkit version. - + @@ -21497,22 +14812,15 @@ and toolkit version. - + - - A macro that should be defined by the user prior to including + + A macro that should be defined by the user prior to including the atk/atk.h header. The definition should be one of the predefined ATK version macros: %ATK_VERSION_2_12, %ATK_VERSION_2_14,... @@ -21527,15 +14835,8 @@ using functions deprecated in later releases will not). - - #AtkValue should be implemented for components which either display + + #AtkValue should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have #AtkObject @@ -21676,12 +14977,8 @@ whether or not it has also changed. </para> </refsect1> - - Gets the value of this object. + + Gets the value of this object. Since 2.12. Use atk_value_get_value_and_text() instead. @@ -21690,54 +14987,35 @@ instead. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the current accessible value + + a #GValue representing the current accessible value - - Gets the minimum increment by which the value of this object may be + + Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. - the minimum increment by which the value of this + the minimum increment by which the value of this object may be changed. zero if undefined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - Gets the maximum value of this object. + + Gets the maximum value of this object. Since 2.12. Use atk_value_get_range() instead. @@ -21745,29 +15023,17 @@ object may be changed. zero if undefined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the maximum accessible value + + a #GValue representing the maximum accessible value - - Gets the minimum increment by which the value of this object may be changed. If zero, + + Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. Since 2.12. Use atk_value_get_increment() instead. @@ -21777,28 +15043,17 @@ floating point precision of the platform. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the minimum increment by which the accessible value may be changed + + a #GValue representing the minimum increment by which the accessible value may be changed - - Gets the minimum value of this object. + + Gets the minimum value of this object. Since 2.12. Use atk_value_get_range() instead. @@ -21806,56 +15061,37 @@ floating point precision of the platform. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the minimum accessible value + + a #GValue representing the minimum accessible value - Gets the range of this object. + Gets the range of this object. - a newly allocated #AtkRange + a newly allocated #AtkRange that represents the minimum, maximum and descriptor (if available) of @obj. NULL if that range is not defined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - Gets the list of subranges defined for this object. See #AtkValue + + Gets the list of subranges defined for this object. See #AtkValue introduction for examples of subranges and when to expose them. - an #GSList of + an #GSList of #AtkRange which each of the subranges defined for this object. Free the returns list with g_slist_free(). @@ -21864,19 +15100,13 @@ the returns list with g_slist_free(). - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - Gets the current value and the human readable text alternative of + + Gets the current value and the human readable text alternative of @obj. @text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. @@ -21885,67 +15115,41 @@ caller. Can be NULL if no descriptor is available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - address of #gdouble to put the current value of @obj + + address of #gdouble to put the current value of @obj - - address of #gchar to put the human + + address of #gchar to put the human readable text alternative for @value - - Sets the value of this object. + + Sets the value of this object. Since 2.12. Use atk_value_set_value() instead. - %TRUE if new value is successfully set, %FALSE otherwise. + %TRUE if new value is successfully set, %FALSE otherwise. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - a #GValue which is the desired new accessible value. + a #GValue which is the desired new accessible value. - Sets the value of this object. + Sets the value of this object. This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be @@ -21965,25 +15169,17 @@ not. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - a double which is the desired new accessible value. + a double which is the desired new accessible value. - - Gets the value of this object. + + Gets the value of this object. Since 2.12. Use atk_value_get_value_and_text() instead. @@ -21992,54 +15188,35 @@ instead. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the current accessible value + + a #GValue representing the current accessible value - - Gets the minimum increment by which the value of this object may be + + Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. - the minimum increment by which the value of this + the minimum increment by which the value of this object may be changed. zero if undefined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - Gets the maximum value of this object. + + Gets the maximum value of this object. Since 2.12. Use atk_value_get_range() instead. @@ -22047,29 +15224,17 @@ object may be changed. zero if undefined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the maximum accessible value + + a #GValue representing the maximum accessible value - - Gets the minimum increment by which the value of this object may be changed. If zero, + + Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. Since 2.12. Use atk_value_get_increment() instead. @@ -22079,28 +15244,17 @@ floating point precision of the platform. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the minimum increment by which the accessible value may be changed + + a #GValue representing the minimum increment by which the accessible value may be changed - - Gets the minimum value of this object. + + Gets the minimum value of this object. Since 2.12. Use atk_value_get_range() instead. @@ -22108,58 +15262,37 @@ floating point precision of the platform. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the minimum accessible value + + a #GValue representing the minimum accessible value - - Gets the range of this object. + + Gets the range of this object. - a newly allocated #AtkRange + a newly allocated #AtkRange that represents the minimum, maximum and descriptor (if available) of @obj. NULL if that range is not defined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - Gets the list of subranges defined for this object. See #AtkValue + + Gets the list of subranges defined for this object. See #AtkValue introduction for examples of subranges and when to expose them. - an #GSList of + an #GSList of #AtkRange which each of the subranges defined for this object. Free the returns list with g_slist_free(). @@ -22168,19 +15301,13 @@ the returns list with g_slist_free(). - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - Gets the current value and the human readable text alternative of + + Gets the current value and the human readable text alternative of @obj. @text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. @@ -22189,69 +15316,41 @@ caller. Can be NULL if no descriptor is available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - address of #gdouble to put the current value of @obj + + address of #gdouble to put the current value of @obj - - address of #gchar to put the human + + address of #gchar to put the human readable text alternative for @value - - Sets the value of this object. + + Sets the value of this object. Since 2.12. Use atk_value_set_value() instead. - %TRUE if new value is successfully set, %FALSE otherwise. + %TRUE if new value is successfully set, %FALSE otherwise. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - a #GValue which is the desired new accessible value. + a #GValue which is the desired new accessible value. - - Sets the value of this object. + + Sets the value of this object. This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be @@ -22271,23 +15370,17 @@ not. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - a double which is the desired new accessible value. + a double which is the desired new accessible value. - The 'value-changed' signal is emitted when the current value + The 'value-changed' signal is emitted when the current value that represent the object changes. @value is the numerical representation of this new value. @text is the human readable text alternative of @value, and can be NULL if it is @@ -22304,24 +15397,18 @@ types their new password. Appropiate value text would be - the new value in a numerical form. + the new value in a numerical form. - human readable text alternative (also called + human readable text alternative (also called description) of this object. NULL if not available. - + @@ -22334,18 +15421,11 @@ description) of this object. NULL if not available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the current accessible value + + a #GValue representing the current accessible value @@ -22359,18 +15439,11 @@ description) of this object. NULL if not available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the maximum accessible value + + a #GValue representing the maximum accessible value @@ -22384,18 +15457,11 @@ description) of this object. NULL if not available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the minimum accessible value + + a #GValue representing the minimum accessible value @@ -22405,22 +15471,16 @@ description) of this object. NULL if not available. - %TRUE if new value is successfully set, %FALSE otherwise. + %TRUE if new value is successfully set, %FALSE otherwise. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - a #GValue which is the desired new accessible value. + a #GValue which is the desired new accessible value. @@ -22434,18 +15494,11 @@ description) of this object. NULL if not available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - a #GValue representing the minimum increment by which the accessible value may be changed + + a #GValue representing the minimum increment by which the accessible value may be changed @@ -22459,29 +15512,15 @@ description) of this object. NULL if not available. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - - address of #gdouble to put the current value of @obj + + address of #gdouble to put the current value of @obj - - address of #gchar to put the human + + address of #gchar to put the human readable text alternative for @value @@ -22492,18 +15531,14 @@ readable text alternative for @value - a newly allocated #AtkRange + a newly allocated #AtkRange that represents the minimum, maximum and descriptor (if available) of @obj. NULL if that range is not defined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface @@ -22513,17 +15548,13 @@ of @obj. NULL if that range is not defined. - the minimum increment by which the value of this + the minimum increment by which the value of this object may be changed. zero if undefined. - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface @@ -22533,9 +15564,7 @@ object may be changed. zero if undefined. - an #GSList of + an #GSList of #AtkRange which each of the subranges defined for this object. Free the returns list with g_slist_free(). @@ -22544,9 +15573,7 @@ the returns list with g_slist_free(). - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface @@ -22560,147 +15587,77 @@ the returns list with g_slist_free(). - a GObject instance that implements AtkValueIface + a GObject instance that implements AtkValueIface - a double which is the desired new accessible value. + a double which is the desired new accessible value. - - Default types for a given value. Those are defined in order to + + Default types for a given value. Those are defined in order to easily get localized strings to describe a given value or a given subrange, using atk_value_type_get_localized_name(). - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - Gets the localized description string describing the #AtkValueType @value_type. + + Gets the localized description string describing the #AtkValueType @value_type. - the localized string describing the #AtkValueType + the localized string describing the #AtkValueType - The #AtkValueType whose localized name is required + The #AtkValueType whose localized name is required - Gets the description string describing the #AtkValueType @value_type. + Gets the description string describing the #AtkValueType @value_type. - the string describing the #AtkValueType + the string describing the #AtkValueType - The #AtkValueType whose name is required + The #AtkValueType whose name is required @@ -22713,153 +15670,110 @@ subrange, using atk_value_type_get_localized_name(). - + - - #AtkWindow should be implemented by the UI elements that represent + + #AtkWindow should be implemented by the UI elements that represent a top-level window, such as the main window of an application or dialog. - The signal #AtkWindow::activate is emitted when a window + The signal #AtkWindow::activate is emitted when a window becomes the active window of the application or session. - The signal #AtkWindow::create is emitted when a new window + The signal #AtkWindow::create is emitted when a new window is created. - The signal #AtkWindow::deactivate is emitted when a window is + The signal #AtkWindow::deactivate is emitted when a window is no longer the active window of the application or session. - The signal #AtkWindow::destroy is emitted when a window is + The signal #AtkWindow::destroy is emitted when a window is destroyed. - The signal #AtkWindow::maximize is emitted when a window + The signal #AtkWindow::maximize is emitted when a window is maximized. - The signal #AtkWindow::minimize is emitted when a window + The signal #AtkWindow::minimize is emitted when a window is minimized. - The signal #AtkWindow::move is emitted when a window + The signal #AtkWindow::move is emitted when a window is moved. - The signal #AtkWindow::resize is emitted when a window + The signal #AtkWindow::resize is emitted when a window is resized. - The signal #AtkWindow::restore is emitted when a window + The signal #AtkWindow::restore is emitted when a window is restored. - + - - Adds the specified function to the list of functions to be called + + Adds the specified function to the list of functions to be called when an object receives focus. Focus tracking has been dropped as a feature to be implemented by ATK itself. If you need focus tracking on your implementation, subscribe to the #AtkObject::state-change "focused" signal. - added focus tracker id, or 0 on failure. + added focus tracker id, or 0 on failure. - Function to be added to the list of functions to be called + Function to be added to the list of functions to be called when an object receives focus. - - Adds the specified function to the list of functions to be called + + Adds the specified function to the list of functions to be called when an ATK event of type event_type occurs. The format of event_type is the following: @@ -22894,67 +15808,43 @@ interfaces, so creating the instance will register all ATK types as a collateral effect. - added event listener id, or 0 on failure. + added event listener id, or 0 on failure. - the listener to notify - + the listener to notify + - the type of event for which notification is requested + the type of event for which notification is requested - - Adds the specified function to the list of functions to be called + + Adds the specified function to the list of functions to be called when a key event occurs. The @data element will be passed to the #AtkKeySnoopFunc (@listener) as the @func_data param, on notification. - added event listener id, or 0 on failure. + added event listener id, or 0 on failure. - the listener to notify + the listener to notify - - a #gpointer that points to a block of data that should be sent to the registered listeners, + + a #gpointer that points to a block of data that should be sent to the registered listeners, along with the event notification, when it occurs. - - Frees the memory used by an #AtkAttributeSet, including all its + + Frees the memory used by an #AtkAttributeSet, including all its #AtkAttributes. @@ -22962,21 +15852,13 @@ a collateral effect. - The #AtkAttributeSet to free + The #AtkAttributeSet to free - - Specifies the function to be called for focus tracker initialization. + + Specifies the function to be called for focus tracker initialization. This function should be called by an implementation of the ATK interface if any specific work needs to be done to enable focus tracking. @@ -22988,20 +15870,13 @@ to be implemented by ATK itself. - Function to be called for focus tracker initialization + Function to be called for focus tracker initialization - - Cause the focus tracker functions which have been specified to be + + Cause the focus tracker functions which have been specified to be executed for the object. Focus tracking has been dropped as a feature to be implemented by ATK itself. As #AtkObject::focus-event was @@ -23014,33 +15889,22 @@ atk_object_notify_state_change() instead. - an #AtkObject + an #AtkObject - - Returns the binary age as passed to libtool when building the ATK + + Returns the binary age as passed to libtool when building the ATK library the process is running against. - the binary age of the ATK library + the binary age of the ATK library - - Gets a default implementation of the #AtkObjectFactory/type + + Gets a default implementation of the #AtkObjectFactory/type registry. Note: For most toolkit maintainers, this will be the correct registry for registering new #AtkObject factories. Following @@ -23049,49 +15913,31 @@ to associate an #AtkObjectFactory subclass with the GType of objects for whom accessibility information will be provided. - a default implementation of the + a default implementation of the #AtkObjectFactory/type registry - - Gets the currently focused object. + + Gets the currently focused object. - the currently focused object for the current + the currently focused object for the current application - - Returns the interface age as passed to libtool when building the + + Returns the interface age as passed to libtool when building the ATK library the process is running against. - the interface age of the ATK library + the interface age of the ATK library - - Returns the major version number of the ATK library. (e.g. in ATK + + Returns the major version number of the ATK library. (e.g. in ATK version 2.7.4 this is 2.) This function is in the library, so it represents the ATK library @@ -23100,18 +15946,12 @@ macro represents the major version of the ATK headers you have included when compiling your code. - the major version number of the ATK library + the major version number of the ATK library - - Returns the micro version number of the ATK library. (e.g. in ATK + + Returns the micro version number of the ATK library. (e.g. in ATK version 2.7.4 this is 4.) This function is in the library, so it represents the ATK library @@ -23120,18 +15960,12 @@ your code is are running against. In contrast, the headers you have included when compiling your code. - the micro version number of the ATK library + the micro version number of the ATK library - - Returns the minor version number of the ATK library. (e.g. in ATK + + Returns the minor version number of the ATK library. (e.g. in ATK version 2.7.4 this is 7.) This function is in the library, so it represents the ATK library @@ -23140,136 +15974,88 @@ your code is are running against. In contrast, the headers you have included when compiling your code. - the minor version number of the ATK library + the minor version number of the ATK library - Gets the root accessible container for the current application. + Gets the root accessible container for the current application. - the root accessible container for the current + the root accessible container for the current application - Gets name string for the GUI toolkit implementing ATK for this application. + Gets name string for the GUI toolkit implementing ATK for this application. - name string for the GUI toolkit implementing ATK for this application + name string for the GUI toolkit implementing ATK for this application - - Gets version string for the GUI toolkit implementing ATK for this application. + + Gets version string for the GUI toolkit implementing ATK for this application. - version string for the GUI toolkit implementing ATK for this application + version string for the GUI toolkit implementing ATK for this application - Gets the current version for ATK. + Gets the current version for ATK. - version string for ATK + version string for ATK - - Get the #AtkRelationType type corresponding to a relation name. + + Get the #AtkRelationType type corresponding to a relation name. - the #AtkRelationType enumerated type corresponding to the specified name, + the #AtkRelationType enumerated type corresponding to the specified name, or #ATK_RELATION_NULL if no matching relation type is found. - a string which is the (non-localized) name of an ATK relation type. + a string which is the (non-localized) name of an ATK relation type. - - Gets the description string describing the #AtkRelationType @type. + + Gets the description string describing the #AtkRelationType @type. - the string describing the AtkRelationType + the string describing the AtkRelationType - The #AtkRelationType whose name is required + The #AtkRelationType whose name is required - - Associate @name with a new #AtkRelationType + + Associate @name with a new #AtkRelationType - an #AtkRelationType associated with @name + an #AtkRelationType associated with @name - a name string + a name string - - Removes the specified focus tracker from the list of functions + + Removes the specified focus tracker from the list of functions to be called when any object receives focus. Focus tracking has been dropped as a feature to be implemented by ATK itself. If you need focus tracking on your @@ -23281,18 +16067,13 @@ to be called when any object receives focus. - the id of the focus tracker to remove + the id of the focus tracker to remove - - @listener_id is the value returned by #atk_add_global_event_listener + + @listener_id is the value returned by #atk_add_global_event_listener when you registered that event listener. Toolkit implementor note: ATK provides a default implementation for @@ -23309,18 +16090,13 @@ Removes the specified event listener - the id of the event listener to remove + the id of the event listener to remove - - @listener_id is the value returned by #atk_add_key_event_listener + + @listener_id is the value returned by #atk_add_key_event_listener when you registered that event listener. Removes the specified event listener. @@ -23330,279 +16106,181 @@ Removes the specified event listener. - the id of the event listener to remove + the id of the event listener to remove - - Get the #AtkRole type corresponding to a rolew name. + + Get the #AtkRole type corresponding to a rolew name. - the #AtkRole enumerated type corresponding to the specified name, + the #AtkRole enumerated type corresponding to the specified name, or #ATK_ROLE_INVALID if no matching role is found. - a string which is the (non-localized) name of an ATK role. + a string which is the (non-localized) name of an ATK role. - - Gets the localized description string describing the #AtkRole @role. + + Gets the localized description string describing the #AtkRole @role. - the localized string describing the AtkRole + the localized string describing the AtkRole - The #AtkRole whose localized name is required + The #AtkRole whose localized name is required - - Gets the description string describing the #AtkRole @role. + + Gets the description string describing the #AtkRole @role. - the string describing the AtkRole + the string describing the AtkRole - The #AtkRole whose name is required + The #AtkRole whose name is required - - Registers the role specified by @name. @name must be a meaningful + + Registers the role specified by @name. @name must be a meaningful name. So it should not be empty, or consisting on whitespaces. Since 2.12. If your application/toolkit doesn't find a suitable role for a specific object defined at #AtkRole, please submit a bug in order to add a new role to the specification. - an #AtkRole for the new role if added + an #AtkRole for the new role if added properly. ATK_ROLE_INVALID in case of error. - a character string describing the new role. + a character string describing the new role. - - Gets the #AtkStateType corresponding to the description string @name. + + Gets the #AtkStateType corresponding to the description string @name. - an #AtkStateType corresponding to @name + an #AtkStateType corresponding to @name - a character string state name + a character string state name - - Gets the description string describing the #AtkStateType @type. + + Gets the description string describing the #AtkStateType @type. - the string describing the AtkStateType + the string describing the AtkStateType - The #AtkStateType whose name is required + The #AtkStateType whose name is required - - Register a new object state. + + Register a new object state. - an #AtkState value for the new state. + an #AtkState value for the new state. - a character string describing the new state. + a character string describing the new state. - - Get the #AtkTextAttribute type corresponding to a text attribute name. + + Get the #AtkTextAttribute type corresponding to a text attribute name. - the #AtkTextAttribute enumerated type corresponding to the specified + the #AtkTextAttribute enumerated type corresponding to the specified name, or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found. - a string which is the (non-localized) name of an ATK text attribute. + a string which is the (non-localized) name of an ATK text attribute. - - Gets the name corresponding to the #AtkTextAttribute + + Gets the name corresponding to the #AtkTextAttribute - a string containing the name; this string should not be freed + a string containing the name; this string should not be freed - The #AtkTextAttribute whose name is required + The #AtkTextAttribute whose name is required - - Gets the value for the index of the #AtkTextAttribute + + Gets the value for the index of the #AtkTextAttribute - a string containing the value; this string + a string containing the value; this string should not be freed; %NULL is returned if there are no values maintained for the attr value. - The #AtkTextAttribute for which a value is required + The #AtkTextAttribute for which a value is required - The index of the required value + The index of the required value - - Associate @name with a new #AtkTextAttribute + + Associate @name with a new #AtkTextAttribute - an #AtkTextAttribute associated with @name + an #AtkTextAttribute associated with @name - a name string + a name string - - Frees the memory associated with an array of AtkTextRange. It is assumed + + Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated. @@ -23611,9 +16289,7 @@ and is NULL terminated. - A pointer to an array of #AtkTextRange which is + A pointer to an array of #AtkTextRange which is to be freed. @@ -23621,46 +16297,30 @@ and is NULL terminated. - - Gets the localized description string describing the #AtkValueType @value_type. + + Gets the localized description string describing the #AtkValueType @value_type. - the localized string describing the #AtkValueType + the localized string describing the #AtkValueType - The #AtkValueType whose localized name is required + The #AtkValueType whose localized name is required - - Gets the description string describing the #AtkValueType @value_type. + + Gets the description string describing the #AtkValueType @value_type. - the string describing the #AtkValueType + the string describing the #AtkValueType - The #AtkValueType whose name is required + The #AtkValueType whose name is required diff --git a/GIRepository-2.0.gir b/GIRepository-2.0.gir index 9e4b680..466c035 100644 --- a/GIRepository-2.0.gir +++ b/GIRepository-2.0.gir @@ -1193,7 +1193,7 @@ against. c:identifier="g_function_info_get_vfunc"> Obtain the virtual function associated with this #GIFunctionInfo. + line="194">Obtain the virtual function associated with this #GIFunctionInfo. Only #GIFunctionInfo with the flag %GI_FUNCTION_WRAPS_VFUNC has a virtual function set. For other cases, %NULL will be returned. the virtual function or %NULL if not set. + line="202">the virtual function or %NULL if not set. Free it by calling g_base_info_unref() when done. @@ -3797,7 +3797,7 @@ Free it by calling g_base_info_unref() when done. a #GIFunctionInfo + line="196">a #GIFunctionInfo @@ -3808,7 +3808,7 @@ Free it by calling g_base_info_unref() when done. throws="1"> Invokes the function described in @info with the given + line="238">Invokes the function described in @info with the given arguments. Note that inout parameters must appear in both argument lists. This function uses dlsym() to obtain a pointer to the function, so the library or shared object containing the @@ -3818,7 +3818,7 @@ have been g_module_symbol()<!-- -->ed before calling this function. %TRUE if the function has been invoked, %FALSE if an + line="261">%TRUE if the function has been invoked, %FALSE if an error occurred. @@ -3826,13 +3826,13 @@ have been g_module_symbol()<!-- -->ed before calling this function. a #GIFunctionInfo describing the function to invoke + line="240">a #GIFunctionInfo describing the function to invoke an array of #GIArgument<!-- -->s, one for each in + line="241">an array of #GIArgument<!-- -->s, one for each in parameter of @info. If there are no in parameter, @in_args can be %NULL @@ -3842,13 +3842,13 @@ have been g_module_symbol()<!-- -->ed before calling this function. the length of the @in_args array + line="244">the length of the @in_args array an array of #GIArgument<!-- -->s, one for each out + line="245">an array of #GIArgument<!-- -->s, one for each out parameter of @info. If there are no out parameters, @out_args may be %NULL @@ -3858,13 +3858,13 @@ have been g_module_symbol()<!-- -->ed before calling this function. the length of the @out_args array + line="248">the length of the @out_args array return location for the return value of the + line="249">return location for the return value of the function. If the function returns void, @return_value may be %NULL @@ -4685,11 +4685,11 @@ g_base_info_unref() when done. TODO + line="222">TODO TODO + line="227">TODO @@ -4725,13 +4725,13 @@ the expected arguments for the functions type signature. c:identifier="g_object_info_find_method"> Obtain a method of the object type given a @name. %NULL will be + line="439">Obtain a method of the object type given a @name. %NULL will be returned if there's no method available with that name. - + the #GIFunctionInfo. Free the struct by calling + line="447">the #GIFunctionInfo. Free the struct by calling g_base_info_unref() when done. @@ -4739,13 +4739,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="441">a #GIObjectInfo name of method to obtain + line="442">name of method to obtain @@ -4754,17 +4754,17 @@ g_base_info_unref() when done. c:identifier="g_object_info_find_method_using_interfaces"> Obtain a method of the object given a @name, searching both the + line="474">Obtain a method of the object given a @name, searching both the object @info and any interfaces it implements. %NULL will be returned if there's no method available with that name. Note that this function does *not* search parent classes; you will have to chain up if that's desired. - + the #GIFunctionInfo. Free the struct by calling + line="487">the #GIFunctionInfo. Free the struct by calling g_base_info_unref() when done. @@ -4772,13 +4772,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="476">a #GIObjectInfo name of method to obtain + line="477">name of method to obtain transfer-ownership="full"> The implementor of the interface + line="478">The implementor of the interface @@ -4796,25 +4796,25 @@ g_base_info_unref() when done. c:identifier="g_object_info_find_signal"> TODO - + line="590">TODO + Info for the signal with name @name in @info, or %NULL on failure. + line="597">Info for the signal with name @name in @info, or %NULL on failure. a #GIObjectInfo + line="592">a #GIObjectInfo Name of signal + line="593">Name of signal @@ -4823,18 +4823,18 @@ g_base_info_unref() when done. c:identifier="g_object_info_find_vfunc"> Locate a virtual function slot with name @name. Note that the namespace + line="683">Locate a virtual function slot with name @name. Note that the namespace for virtuals is distinct from that of methods; there may or may not be a concrete method associated for a virtual. If there is one, it may be retrieved using g_vfunc_info_get_invoker(), otherwise %NULL will be returned. See the documentation for g_vfunc_info_get_invoker() for more information on invoking virtuals. - + the #GIVFuncInfo, or %NULL. Free it with + line="696">the #GIVFuncInfo, or %NULL. Free it with g_base_info_unref() when done. @@ -4842,13 +4842,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="685">a #GIObjectInfo The name of a virtual function to find. + line="686">The name of a virtual function to find. @@ -4857,7 +4857,7 @@ g_base_info_unref() when done. c:identifier="g_object_info_find_vfunc_using_interfaces"> Locate a virtual function slot with name @name, searching both the object + line="725">Locate a virtual function slot with name @name, searching both the object @info and any interfaces it implements. Note that the namespace for virtuals is distinct from that of methods; there may or may not be a concrete method associated for a virtual. If there is one, it may be @@ -4866,11 +4866,11 @@ returned. Note that this function does *not* search parent classes; you will have to chain up if that's desired. - + the #GIVFuncInfo. Free the struct by calling + line="741">the #GIVFuncInfo. Free the struct by calling g_base_info_unref() when done. @@ -4878,13 +4878,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="727">a #GIObjectInfo name of vfunc to obtain + line="728">name of vfunc to obtain transfer-ownership="full"> The implementor of the interface + line="729">The implementor of the interface @@ -4924,13 +4924,13 @@ instantiated c:identifier="g_object_info_get_class_struct"> Every #GObject has two structures; an instance structure and a class + line="846">Every #GObject has two structures; an instance structure and a class structure. This function returns the metadata for the class structure. - + the #GIStructInfo or %NULL. Free with + line="853">the #GIStructInfo or %NULL. Free with g_base_info_unref() when done. @@ -4938,7 +4938,7 @@ g_base_info_unref() when done. a #GIObjectInfo + line="848">a #GIObjectInfo @@ -4947,12 +4947,12 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_constant"> Obtain an object type constant at index @n. - + line="807">Obtain an object type constant at index @n. + the #GIConstantInfo. Free the struct by calling + line="814">the #GIConstantInfo. Free the struct by calling g_base_info_unref() when done. @@ -4960,13 +4960,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="809">a #GIObjectInfo index of constant to get + line="810">index of constant to get @@ -4975,12 +4975,12 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_field"> Obtain an object type field at index @n. - + line="299">Obtain an object type field at index @n. + the #GIFieldInfo. Free the struct by calling + line="306">the #GIFieldInfo. Free the struct by calling g_base_info_unref() when done. @@ -4988,28 +4988,29 @@ g_base_info_unref() when done. a #GIObjectInfo + line="301">a #GIObjectInfo index of field to get + line="302">index of field to get - + Obtain if the object type is of a fundamental type which is not -G_TYPE_OBJECT. This is mostly for supporting GstMiniObject. + line="136">Checks whether the object type is a final type, i.e. if it cannot +be derived %TRUE if the object type is a fundamental type + line="143">%TRUE if the object type is final @@ -5021,27 +5022,49 @@ G_TYPE_OBJECT. This is mostly for supporting GstMiniObject. + + Obtain if the object type is of a fundamental type which is not +G_TYPE_OBJECT. This is mostly for supporting GstMiniObject. + + + %TRUE if the object type is a fundamental type + + + + + a #GIObjectInfo + + + + Obtain the symbol name of the function that should be called to convert + line="1053">Obtain the symbol name of the function that should be called to convert an object instance pointer of this object type to a GValue. I's mainly used fundamental types. The type signature for the symbol is %GIObjectInfoGetValueFunction, to fetch the function pointer see g_object_info_get_get_value_function(). - + the symbol or %NULL + line="1063">the symbol or %NULL a #GIObjectInfo + line="1055">a #GIObjectInfo @@ -5051,15 +5074,15 @@ see g_object_info_get_get_value_function(). introspectable="0"> Obtain a pointer to a function which can be used to + line="1082">Obtain a pointer to a function which can be used to extract an instance of this object type out of a GValue. This takes derivation into account and will reversely traverse the base classes of this type, starting at the top type. - + the function pointer or %NULL + line="1091">the function pointer or %NULL @@ -5067,7 +5090,7 @@ the base classes of this type, starting at the top type. a #GIObjectInfo + line="1084">a #GIObjectInfo @@ -5076,12 +5099,12 @@ the base classes of this type, starting at the top type. c:identifier="g_object_info_get_interface"> Obtain an object type interface at index @n. - + line="251">Obtain an object type interface at index @n. + the #GIInterfaceInfo. Free the struct by calling + line="258">the #GIInterfaceInfo. Free the struct by calling g_base_info_unref() when done. @@ -5089,13 +5112,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="253">a #GIObjectInfo index of interface to get + line="254">index of interface to get @@ -5104,12 +5127,12 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_method"> Obtain an object type method at index @n. - + line="402">Obtain an object type method at index @n. + the #GIFunctionInfo. Free the struct by calling + line="409">the #GIFunctionInfo. Free the struct by calling g_base_info_unref() when done. @@ -5117,13 +5140,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="404">a #GIObjectInfo index of method to get + line="405">index of method to get @@ -5132,19 +5155,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_constants"> Obtain the number of constants that this object type has. - + line="785">Obtain the number of constants that this object type has. + number of constants + line="791">number of constants a #GIObjectInfo + line="787">a #GIObjectInfo @@ -5153,19 +5176,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_fields"> Obtain the number of fields that this object type has. - + line="277">Obtain the number of fields that this object type has. + number of fields + line="283">number of fields a #GIObjectInfo + line="279">a #GIObjectInfo @@ -5174,19 +5197,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_interfaces"> Obtain the number of interfaces that this object type has. - + line="229">Obtain the number of interfaces that this object type has. + number of interfaces + line="235">number of interfaces a #GIObjectInfo + line="231">a #GIObjectInfo @@ -5195,19 +5218,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_methods"> Obtain the number of methods that this object type has. - + line="380">Obtain the number of methods that this object type has. + number of methods + line="386">number of methods a #GIObjectInfo + line="382">a #GIObjectInfo @@ -5216,19 +5239,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_properties"> Obtain the number of properties that this object type has. - + line="324">Obtain the number of properties that this object type has. + number of properties + line="330">number of properties a #GIObjectInfo + line="326">a #GIObjectInfo @@ -5237,19 +5260,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_signals"> Obtain the number of signals that this object type has. - + line="531">Obtain the number of signals that this object type has. + number of signals + line="537">number of signals a #GIObjectInfo + line="533">a #GIObjectInfo @@ -5258,19 +5281,19 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_n_vfuncs"> Obtain the number of virtual functions that this object type has. - + line="623">Obtain the number of virtual functions that this object type has. + number of virtual functions + line="629">number of virtual functions a #GIObjectInfo + line="625">a #GIObjectInfo @@ -5280,7 +5303,7 @@ g_base_info_unref() when done. Obtain the parent of the object type. - + c:identifier="g_object_info_get_property"> Obtain an object type property at index @n. - + line="345">Obtain an object type property at index @n. + the #GIPropertyInfo. Free the struct by calling + line="352">the #GIPropertyInfo. Free the struct by calling g_base_info_unref() when done. @@ -5314,13 +5337,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="347">a #GIObjectInfo index of property to get + line="348">index of property to get @@ -5329,22 +5352,22 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_ref_function"> Obtain the symbol name of the function that should be called to ref this + line="908">Obtain the symbol name of the function that should be called to ref this object type. It's mainly used fundamental types. The type signature for the symbol is %GIObjectInfoRefFunction, to fetch the function pointer see g_object_info_get_ref_function(). - + the symbol or %NULL + line="917">the symbol or %NULL a #GIObjectInfo + line="910">a #GIObjectInfo @@ -5354,22 +5377,22 @@ see g_object_info_get_ref_function(). introspectable="0"> Obtain a pointer to a function which can be used to + line="936">Obtain a pointer to a function which can be used to increase the reference count an instance of this object type. This takes derivation into account and will reversely traverse the base classes of this type, starting at the top type. - + the function pointer or %NULL + line="945">the function pointer or %NULL a #GIObjectInfo + line="938">a #GIObjectInfo @@ -5378,23 +5401,23 @@ the base classes of this type, starting at the top type. c:identifier="g_object_info_get_set_value_function"> Obtain the symbol name of the function that should be called to convert + line="1004">Obtain the symbol name of the function that should be called to convert set a GValue giving an object instance pointer of this object type. I's mainly used fundamental types. The type signature for the symbol is %GIObjectInfoSetValueFunction, to fetch the function pointer see g_object_info_get_set_value_function(). - + the symbol or %NULL + line="1014">the symbol or %NULL a #GIObjectInfo + line="1006">a #GIObjectInfo @@ -5404,15 +5427,15 @@ see g_object_info_get_set_value_function(). introspectable="0"> Obtain a pointer to a function which can be used to + line="1033">Obtain a pointer to a function which can be used to set a GValue given an instance of this object type. This takes derivation into account and will reversely traverse the base classes of this type, starting at the top type. - + the function pointer or %NULL + line="1042">the function pointer or %NULL @@ -5420,7 +5443,7 @@ the base classes of this type, starting at the top type. a #GIObjectInfo + line="1035">a #GIObjectInfo @@ -5429,12 +5452,12 @@ the base classes of this type, starting at the top type. c:identifier="g_object_info_get_signal"> Obtain an object type signal at index @n. - + line="553">Obtain an object type signal at index @n. + the #GISignalInfo. Free the struct by calling + line="560">the #GISignalInfo. Free the struct by calling g_base_info_unref() when done. @@ -5442,13 +5465,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="555">a #GIObjectInfo index of signal to get + line="556">index of signal to get @@ -5457,20 +5480,20 @@ g_base_info_unref() when done. c:identifier="g_object_info_get_type_init"> Obtain the function which when called will return the GType + line="206">Obtain the function which when called will return the GType function for which this object type is registered. the type init function + line="213">the type init function a #GIObjectInfo + line="208">a #GIObjectInfo @@ -5479,19 +5502,19 @@ function for which this object type is registered. c:identifier="g_object_info_get_type_name"> Obtain the name of the objects class/type. + line="184">Obtain the name of the objects class/type. name of the objects type + line="190">name of the objects type a #GIObjectInfo + line="186">a #GIObjectInfo @@ -5500,22 +5523,22 @@ function for which this object type is registered. c:identifier="g_object_info_get_unref_function"> Obtain the symbol name of the function that should be called to unref this + line="956">Obtain the symbol name of the function that should be called to unref this object type. It's mainly used fundamental types. The type signature for the symbol is %GIObjectInfoUnrefFunction, to fetch the function pointer see g_object_info_get_unref_function(). - + the symbol or %NULL + line="965">the symbol or %NULL a #GIObjectInfo + line="958">a #GIObjectInfo @@ -5525,15 +5548,15 @@ see g_object_info_get_unref_function(). introspectable="0"> Obtain a pointer to a function which can be used to + line="984">Obtain a pointer to a function which can be used to decrease the reference count an instance of this object type. This takes derivation into account and will reversely traverse the base classes of this type, starting at the top type. - + the function pointer or %NULL + line="993">the function pointer or %NULL @@ -5541,7 +5564,7 @@ the base classes of this type, starting at the top type. a #GIObjectInfo + line="986">a #GIObjectInfo @@ -5550,12 +5573,12 @@ the base classes of this type, starting at the top type. c:identifier="g_object_info_get_vfunc"> Obtain an object type virtual function at index @n. - + line="645">Obtain an object type virtual function at index @n. + the #GIVFuncInfo. Free the struct by calling + line="652">the #GIVFuncInfo. Free the struct by calling g_base_info_unref() when done. @@ -5563,13 +5586,13 @@ g_base_info_unref() when done. a #GIObjectInfo + line="647">a #GIObjectInfo index of virtual function to get + line="648">index of virtual function to get @@ -5596,6 +5619,30 @@ more information about possible flag values. + + Obtains the getter function associated with this #GIPropertyInfo. + +The setter is only available for %G_PARAM_READABLE properties. + + + the function info or %NULL if not set. + Free it with g_base_info_unref() when done. + + + + + a #GIPropertyInfo + + + + + + Obtains the setter function associated with this #GIPropertyInfo. + +The setter is only available for %G_PARAM_WRITABLE properties that +are also not %G_PARAM_CONSTRUCT_ONLY. + + + the function info or %NULL if not set. + Free it with g_base_info_unref() when done. + + + + + a #GIPropertyInfo + + + + - + - + - Integer representing a day of the month; between 1 and 31. -#G_DATE_BAD_DAY represents an invalid day of the month. + Integer representing a day of the month; between 1 and 31. + +The %G_DATE_BAD_DAY value represents an invalid day of the month. - Integer representing a year; #G_DATE_BAD_YEAR is the invalid -value. The year must be 1 or higher; negative (BC) years are not -allowed. The year is represented with four digits. + Integer type representing a year. + +The %G_DATE_BAD_YEAR value is the invalid value. The year +must be 1 or higher; negative ([BCE](https://en.wikipedia.org/wiki/Common_Era)) +years are not allowed. + +The year is represented with four digits. - Opaque type. See g_main_context_pusher_new() for details. - + Opaque type. See g_main_context_pusher_new() for details. + - Opaque type. See g_mutex_locker_new() for details. + Opaque type. See g_mutex_locker_new() for details. - A type which is used to hold a process identification. + A type which is used to hold a process identification. On UNIX, processes are identified by a process id (an integer), while Windows uses process handles (which are pointers). @@ -58,38 +46,28 @@ the g_spawn functions. - A GQuark is a non-zero integer which uniquely identifies a + A GQuark is a non-zero integer which uniquely identifies a particular string. A GQuark value of zero is associated to %NULL. - Opaque type. See g_rw_lock_reader_locker_new() for details. + Opaque type. See g_rw_lock_reader_locker_new() for details. - Opaque type. See g_rw_lock_writer_locker_new() for details. + Opaque type. See g_rw_lock_writer_locker_new() for details. - Opaque type. See g_rec_mutex_locker_new() for details. + Opaque type. See g_rec_mutex_locker_new() for details. - A typedef for a reference-counted string. A pointer to a #GRefString can be + A typedef for a reference-counted string. A pointer to a #GRefString can be treated like a standard `char*` array by all code, but can additionally have `g_ref_string_*()` methods called on it. `g_ref_string_*()` methods cannot be called on `char*` arrays not allocated using g_ref_string_new(). @@ -100,19 +78,17 @@ g_autofree(), so that the reference counting metadata is also freed. - A typedef alias for gchar**. This is mostly useful when used together with + A typedef alias for gchar**. This is mostly useful when used together with g_auto(). - + - Simply a replacement for `time_t`. It has been deprecated + Simply a replacement for `time_t`. It has been deprecated since it is not equivalent to `time_t` on 64-bit platforms -with a 64-bit `time_t`. Unrelated to #GTimer. +with a 64-bit `time_t`. + +Unrelated to #GTimer. Note that #GTime is defined to always be a 32-bit integer, unlike `time_t` which may be 64-bit on some systems. Therefore, @@ -121,6 +97,7 @@ address of a #GTime variable as argument to the UNIX time() function. Instead, do the following: + |[<!-- language="C" --> time_t ttime; GTime gtime; @@ -134,9 +111,7 @@ gtime = (GTime)ttime; - A value representing an interval of time, in microseconds. + A value representing an interval of time, in microseconds. @@ -144,43 +119,29 @@ gtime = (GTime)ttime; - - Return the minimal alignment required by the platform ABI for values of the given + + Return the minimal alignment required by the platform ABI for values of the given type. The address of a variable or struct member of the given type must always be a multiple of this alignment. For example, most platforms require int variables to be aligned at a 4-byte boundary, so `G_ALIGNOF (int)` is 4 on most platforms. -Note this is not necessarily the same as the value returned by GCC’s +Note this is not necessarily the same as the value returned by GCC’s `__alignof__` operator, which returns the preferred alignment for a type. The preferred alignment may be a stricter alignment than the minimal alignment. - + - a type-name + a type-name - - + + - - Evaluates to a truth value if the absolute difference between @a and @b is + + Evaluates to a truth value if the absolute difference between @a and @b is smaller than @epsilon, and to a false value otherwise. For example, @@ -188,31 +149,21 @@ For example, - `G_APPROX_VALUE (3.14, 3.15, 0.001)` evaluates to false - `G_APPROX_VALUE (n, 0.f, FLT_EPSILON)` evaluates to true if `n` is within the single precision floating point epsilon from zero - + - a numeric value + a numeric value - a numeric value + a numeric value - a numeric value that expresses the tolerance between @a and @b + a numeric value that expresses the tolerance between @a and @b - - A good size for a buffer to be passed into g_ascii_dtostr(). + + A good size for a buffer to be passed into g_ascii_dtostr(). It is guaranteed to be enough for all output of that function on systems with 64bit IEEE-compatible doubles. @@ -232,77 +183,50 @@ The typical usage would be something like: - - Contains the public fields of a GArray. + + Contains the public fields of a GArray. - a pointer to the element data. The data may be moved as + a pointer to the element data. The data may be moved as elements are added to the #GArray. - the number of elements in the #GArray not including the + the number of elements in the #GArray not including the possible terminating zero element. - - Adds @len elements onto the end of the array. + + Adds @len elements onto the end of the array. - the #GArray + the #GArray - a #GArray + a #GArray - a pointer to the elements to append to the end of the array + a pointer to the elements to append to the end of the array - the number of elements to append + the number of elements to append - - Checks whether @target exists in @array by performing a binary + + Checks whether @target exists in @array by performing a binary search based on the given comparison function @compare_func which get pointers to items as arguments. If the element is found, %TRUE -is returned and the element’s index is returned in @out_match_index +is returned and the element’s index is returned in @out_match_index (if non-%NULL). Otherwise, %FALSE is returned and @out_match_index is undefined. If @target exists multiple times in @array, the index of the first instance is returned. This search is using a binary @@ -327,71 +251,44 @@ gboolean result = g_array_binary_search (garray, &i, cmpint, &matched_in ]| - %TRUE if @target is one of the elements of @array, %FALSE otherwise. + %TRUE if @target is one of the elements of @array, %FALSE otherwise. - a #GArray. + a #GArray. - - a pointer to the item to look up. + + a pointer to the item to look up. - A #GCompareFunc used to locate @target. + A #GCompareFunc used to locate @target. - - return location + + return location for the index of the element, if found. - - Create a shallow copy of a #GArray. If the array elements consist of + + Create a shallow copy of a #GArray. If the array elements consist of pointers to data, the pointers are copied but the actual data is not. - A copy of @array. + A copy of @array. - A #GArray. + A #GArray. @@ -399,9 +296,7 @@ pointers to data, the pointers are copied but the actual data is not. - Frees the memory allocated for the #GArray. If @free_segment is + Frees the memory allocated for the #GArray. If @free_segment is %TRUE it frees the memory block holding the elements as well. Pass %FALSE if you want to free the #GArray wrapper but preserve the underlying array for use elsewhere. If the reference count of @@ -417,67 +312,48 @@ threads, use only the atomic g_array_ref() and g_array_unref() functions. - the element data if @free_segment is %FALSE, otherwise + the element data if @free_segment is %FALSE, otherwise %NULL. The element data should be freed using g_free(). - a #GArray + a #GArray - if %TRUE the actual element data is freed as well + if %TRUE the actual element data is freed as well - - Gets the size of the elements in @array. + + Gets the size of the elements in @array. - Size of each element, in bytes + Size of each element, in bytes - A #GArray + A #GArray - - Inserts @len elements into a #GArray at the given index. + + Inserts @len elements into a #GArray at the given index. -If @index_ is greater than the array’s current length, the array is expanded. +If @index_ is greater than the array’s current length, the array is expanded. The elements between the old end of the array and the newly inserted elements will be initialised to zero if the array was configured to clear elements; otherwise their values will be undefined. -If @index_ is less than the array’s current length, new entries will be +If @index_ is less than the array’s current length, new entries will be inserted into the array, and the existing entries above @index_ will be moved upwards. @@ -485,87 +361,60 @@ upwards. function is a no-op. - the #GArray + the #GArray - a #GArray + a #GArray - the index to place the elements at + the index to place the elements at - - a pointer to the elements to insert + + a pointer to the elements to insert - the number of elements to insert + the number of elements to insert - Creates a new #GArray with a reference count of 1. + Creates a new #GArray with a reference count of 1. - the new #GArray + the new #GArray - %TRUE if the array should have an extra element at + %TRUE if the array should have an extra element at the end which is set to 0 - %TRUE if #GArray elements should be automatically cleared + %TRUE if #GArray elements should be automatically cleared to 0 when they are allocated - the size of each element in bytes + the size of each element in bytes - - Adds @len elements onto the start of the array. + + Adds @len elements onto the start of the array. @data may be %NULL if (and only if) @len is zero. If @len is zero, this function is a no-op. @@ -575,182 +424,124 @@ existing elements in the array have to be moved to make space for the new elements. - the #GArray + the #GArray - a #GArray + a #GArray - - a pointer to the elements to prepend to the start of the array + + a pointer to the elements to prepend to the start of the array - the number of elements to prepend, which may be zero + the number of elements to prepend, which may be zero - - Atomically increments the reference count of @array by one. + + Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread. - The passed in #GArray + The passed in #GArray - A #GArray + A #GArray - - Removes the element at the given index from a #GArray. The following + + Removes the element at the given index from a #GArray. The following elements are moved down one place. - the #GArray + the #GArray - a #GArray + a #GArray - the index of the element to remove + the index of the element to remove - - Removes the element at the given index from a #GArray. The last + + Removes the element at the given index from a #GArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the #GArray. But it is faster than g_array_remove_index(). - the #GArray + the #GArray - a @GArray + a @GArray - the index of the element to remove + the index of the element to remove - - Removes the given number of elements starting at the given index + + Removes the given number of elements starting at the given index from a #GArray. The following elements are moved to close the gap. - the #GArray + the #GArray - a @GArray + a @GArray - the index of the first element to remove + the index of the first element to remove - the number of elements to remove + the number of elements to remove - - Sets a function to clear an element of @array. + + Sets a function to clear an element of @array. The @clear_func will be called when an element in the array data segment is removed and when the array is freed and data @@ -759,112 +550,103 @@ pointer to the element to clear, rather than the element itself. Note that in contrast with other uses of #GDestroyNotify functions, @clear_func is expected to clear the contents of -the array element it is given, but not free the element itself. +the array element it is given, but not free the element itself. + +|[<!-- language="C" --> +typedef struct +{ + gchar *str; + GObject *obj; +} ArrayElement; + +static void +array_element_clear (ArrayElement *element) +{ + g_clear_pointer (&element->str, g_free); + g_clear_object (&element->obj); +} + +// main code +GArray *garray = g_array_new (FALSE, FALSE, sizeof (ArrayElement)); +g_array_set_clear_func (garray, (GDestroyNotify) array_element_clear); +// assign data to the structure +g_array_free (garray, TRUE); +]| - A #GArray + A #GArray - a function to clear an element of @array + a function to clear an element of @array - - Sets the size of the array, expanding it if necessary. If the array + + Sets the size of the array, expanding it if necessary. If the array was created with @clear_ set to %TRUE, the new elements are set to 0. - the #GArray + the #GArray - a #GArray + a #GArray - the new size of the #GArray + the new size of the #GArray - - Creates a new #GArray with @reserved_size elements preallocated and + + Creates a new #GArray with @reserved_size elements preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many elements to the array. Note however that the size of the array is still 0. - the new #GArray + the new #GArray - %TRUE if the array should have an extra element at + %TRUE if the array should have an extra element at the end with all bits cleared - %TRUE if all bits in the array should be cleared to 0 on + %TRUE if all bits in the array should be cleared to 0 on allocation - size of each element in the array + size of each element in the array - number of elements preallocated + number of elements preallocated - Sorts a #GArray using @compare_func which should be a qsort()-style + Sorts a #GArray using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater zero if first arg is greater than second arg). @@ -876,27 +658,19 @@ This is guaranteed to be a stable sort since version 2.32. - a #GArray + a #GArray - comparison function + comparison function - - Like g_array_sort(), but the comparison function receives an extra + + Like g_array_sort(), but the comparison function receives an extra user data argument. This is guaranteed to be a stable sort since version 2.32. @@ -910,37 +684,23 @@ This did not actually work, so any such code should be removed. - a #GArray + a #GArray - comparison function + comparison function - - data to pass to @compare_func + + data to pass to @compare_func - - Frees the data in the array and resets the size to zero, while + + Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller. @@ -960,42 +720,26 @@ data = g_array_steal (some_array, &data_len); ]| - the element data, which should be + the element data, which should be freed using g_free(). - a #GArray. + a #GArray. - - pointer to retrieve the number of + + pointer to retrieve the number of elements of the original array - - Atomically decrements the reference count of @array by one. If the + + Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread. @@ -1005,9 +749,7 @@ thread. - A #GArray + A #GArray @@ -1041,16 +783,12 @@ thread. - The GAsyncQueue struct is an opaque data structure which represents -an asynchronous queue. It should only be accessed through the -g_async_queue_* functions. + An opaque data structure which represents an asynchronous queue. + +It should only be accessed through the `g_async_queue_*` functions. - Returns the length of the queue. + Returns the length of the queue. Actually this function returns the number of data items in the queue minus the number of waiting threads, so a negative @@ -1060,25 +798,18 @@ in the queue and n threads waiting. This can happen due to locking of the queue or due to scheduling. - the length of the @queue + the length of the @queue - a #GAsyncQueue. + a #GAsyncQueue. - - Returns the length of the queue. + + Returns the length of the queue. Actually this function returns the number of data items in the queue minus the number of waiting threads, so a negative @@ -1090,24 +821,18 @@ of the queue or due to scheduling. This function must be called while holding the @queue's lock. - the length of the @queue. + the length of the @queue. - a #GAsyncQueue + a #GAsyncQueue - Acquires the @queue's lock. If another thread is already + Acquires the @queue's lock. If another thread is already holding the lock, this call will block until the lock becomes available. @@ -1122,89 +847,62 @@ deadlock may occur. - a #GAsyncQueue + a #GAsyncQueue - Pops data from the @queue. If @queue is empty, this function + Pops data from the @queue. If @queue is empty, this function blocks until data becomes available. - data from the queue + data from the queue - a #GAsyncQueue + a #GAsyncQueue - Pops data from the @queue. If @queue is empty, this function + Pops data from the @queue. If @queue is empty, this function blocks until data becomes available. This function must be called while holding the @queue's lock. - data from the queue. + data from the queue. - a #GAsyncQueue + a #GAsyncQueue - Pushes the @data into the @queue. @data must not be %NULL. + Pushes the @data into the @queue. @data must not be %NULL. - a #GAsyncQueue + a #GAsyncQueue - - @data to push into the @queue + + @data to push into the @queue - - Pushes the @item into the @queue. @item must not be %NULL. + + Pushes the @item into the @queue. @item must not be %NULL. In contrast to g_async_queue_push(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue. @@ -1214,28 +912,17 @@ so that it will be the next one to be popped off the queue. - a #GAsyncQueue + a #GAsyncQueue - - data to push into the @queue + + data to push into the @queue - - Pushes the @item into the @queue. @item must not be %NULL. + + Pushes the @item into the @queue. @item must not be %NULL. In contrast to g_async_queue_push_unlocked(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue. @@ -1247,29 +934,17 @@ This function must be called while holding the @queue's lock. - a #GAsyncQueue + a #GAsyncQueue - - data to push into the @queue + + data to push into the @queue - - Inserts @data into @queue using @func to determine the new + + Inserts @data into @queue using @func to determine the new position. This function requires that the @queue is sorted before pushing on @@ -1285,44 +960,25 @@ For an example of @func see g_async_queue_sort(). - a #GAsyncQueue + a #GAsyncQueue - - the @data to push into the @queue + + the @data to push into the @queue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - - user data passed to @func. + + user data passed to @func. - - Inserts @data into @queue using @func to determine the new + + Inserts @data into @queue using @func to determine the new position. The sort function @func is passed two elements of the @queue. @@ -1343,41 +999,25 @@ For an example of @func see g_async_queue_sort(). - a #GAsyncQueue + a #GAsyncQueue - - the @data to push into the @queue + + the @data to push into the @queue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - - user data passed to @func. + + user data passed to @func. - Pushes the @data into the @queue. @data must not be %NULL. + Pushes the @data into the @queue. @data must not be %NULL. This function must be called while holding the @queue's lock. @@ -1386,50 +1026,32 @@ This function must be called while holding the @queue's lock. - a #GAsyncQueue + a #GAsyncQueue - - @data to push into the @queue + + @data to push into the @queue - Increases the reference count of the asynchronous @queue by 1. + Increases the reference count of the asynchronous @queue by 1. You do not need to hold the lock to call this function. - the @queue that was passed in (since 2.6) + the @queue that was passed in (since 2.6) - a #GAsyncQueue + a #GAsyncQueue - - Increases the reference count of the asynchronous @queue by 1. + + Increases the reference count of the asynchronous @queue by 1. Reference counting is done atomically. so g_async_queue_ref() can be used regardless of the @queue's lock. @@ -1439,82 +1061,51 @@ lock. - a #GAsyncQueue + a #GAsyncQueue - Remove an item from the queue. + Remove an item from the queue. - %TRUE if the item was removed + %TRUE if the item was removed - a #GAsyncQueue + a #GAsyncQueue - - the data to remove from the @queue + + the data to remove from the @queue - - Remove an item from the queue. + + Remove an item from the queue. This function must be called while holding the @queue's lock. - %TRUE if the item was removed + %TRUE if the item was removed - a #GAsyncQueue + a #GAsyncQueue - - the data to remove from the @queue + + the data to remove from the @queue - - Sorts @queue using @func. + + Sorts @queue using @func. The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the @@ -1542,35 +1133,21 @@ lowest priority would be at the top of the queue, you could use: - a #GAsyncQueue + a #GAsyncQueue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - - user data passed to @func + + user data passed to @func - - Sorts @queue using @func. + + Sorts @queue using @func. The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the @@ -1585,34 +1162,21 @@ This function must be called while holding the @queue's lock. - a #GAsyncQueue + a #GAsyncQueue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - - user data passed to @func + + user data passed to @func - - Pops data from the @queue. If the queue is empty, blocks until + + Pops data from the @queue. If the queue is empty, blocks until @end_time or until data becomes available. If no data is received before @end_time, %NULL is returned. @@ -1622,33 +1186,23 @@ and g_time_val_add() can be used. use g_async_queue_timeout_pop(). - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before @end_time. - a #GAsyncQueue + a #GAsyncQueue - a #GTimeVal, determining the final time + a #GTimeVal, determining the final time - - Pops data from the @queue. If the queue is empty, blocks until + + Pops data from the @queue. If the queue is empty, blocks until @end_time or until data becomes available. If no data is received before @end_time, %NULL is returned. @@ -1660,62 +1214,45 @@ This function must be called while holding the @queue's lock. use g_async_queue_timeout_pop_unlocked(). - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before @end_time. - a #GAsyncQueue + a #GAsyncQueue - a #GTimeVal, determining the final time + a #GTimeVal, determining the final time - Pops data from the @queue. If the queue is empty, blocks for + Pops data from the @queue. If the queue is empty, blocks for @timeout microseconds, or until data becomes available. If no data is received before the timeout, %NULL is returned. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before the timeout. - a #GAsyncQueue + a #GAsyncQueue - the number of microseconds to wait + the number of microseconds to wait - - Pops data from the @queue. If the queue is empty, blocks for + + Pops data from the @queue. If the queue is empty, blocks for @timeout microseconds, or until data becomes available. If no data is received before the timeout, %NULL is returned. @@ -1723,78 +1260,57 @@ If no data is received before the timeout, %NULL is returned. This function must be called while holding the @queue's lock. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before the timeout. - a #GAsyncQueue + a #GAsyncQueue - the number of microseconds to wait + the number of microseconds to wait - Tries to pop data from the @queue. If no data is available, + Tries to pop data from the @queue. If no data is available, %NULL is returned. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is available immediately. - a #GAsyncQueue + a #GAsyncQueue - - Tries to pop data from the @queue. If no data is available, + + Tries to pop data from the @queue. If no data is available, %NULL is returned. This function must be called while holding the @queue's lock. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is available immediately. - a #GAsyncQueue + a #GAsyncQueue - Releases the queue's lock. + Releases the queue's lock. Calling this function when you have not acquired the with g_async_queue_lock() leads to undefined @@ -1805,17 +1321,13 @@ behaviour. - a #GAsyncQueue + a #GAsyncQueue - Decreases the reference count of the asynchronous @queue by 1. + Decreases the reference count of the asynchronous @queue by 1. If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed. So you are not allowed @@ -1827,20 +1339,13 @@ You do not need to hold the lock to call this function. - a #GAsyncQueue. + a #GAsyncQueue. - - Decreases the reference count of the asynchronous @queue by 1 + + Decreases the reference count of the asynchronous @queue by 1 and releases the lock. This function must be called while holding the @queue's lock. If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed. @@ -1853,73 +1358,47 @@ lock. - a #GAsyncQueue + a #GAsyncQueue - Creates a new asynchronous queue. + Creates a new asynchronous queue. - a new #GAsyncQueue. Free with g_async_queue_unref() + a new #GAsyncQueue. Free with g_async_queue_unref() - - Creates a new asynchronous queue and sets up a destroy notify + + Creates a new asynchronous queue and sets up a destroy notify function that is used to free any remaining queue items when the queue is destroyed after the final unref. - a new #GAsyncQueue. Free with g_async_queue_unref() + a new #GAsyncQueue. Free with g_async_queue_unref() - - function to free queue elements + + function to free queue elements - Specifies one of the possible types of byte order. + Specifies one of the possible types of byte order. See #G_BYTE_ORDER. - The `GBookmarkFile` structure contains only -private data and should not be directly accessed. + An opaque data structure representing a set of bookmarks. - - Adds the application with @name and @exec to the list of + + Adds the application with @name and @exec to the list of applications that have registered a bookmark for @uri into @bookmark. @@ -1947,44 +1426,26 @@ If no bookmark for @uri is found, one is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - the name of the application registering the bookmark + + the name of the application registering the bookmark or %NULL - - command line to be used to launch the bookmark or %NULL + + command line to be used to launch the bookmark or %NULL - - Adds @group to the list of groups to which the bookmark for @uri + + Adds @group to the list of groups to which the bookmark for @uri belongs to. If no bookmark for @uri is found then it is created. @@ -1994,51 +1455,34 @@ If no bookmark for @uri is found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the group name to be added + the group name to be added - Frees a #GBookmarkFile. + Frees a #GBookmarkFile. - a #GBookmarkFile + a #GBookmarkFile - - Gets the time the bookmark for @uri was added to @bookmark + + Gets the time the bookmark for @uri was added to @bookmark In the event the URI cannot be found, -1 is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. @@ -2046,67 +1490,43 @@ In the event the URI cannot be found, -1 is returned and `time_t` is deprecated due to the year 2038 problem. - a timestamp + a timestamp - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Gets the time the bookmark for @uri was added to @bookmark + + Gets the time the bookmark for @uri was added to @bookmark In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a #GDateTime + a #GDateTime - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Gets the registration information of @app_name for the bookmark for + + Gets the registration information of @app_name for the bookmark for @uri. See g_bookmark_file_set_application_info() for more information about the returned data. @@ -2123,72 +1543,38 @@ set and %FALSE is returned. `time_t` is deprecated due to the year 2038 problem. - %TRUE on success. + %TRUE on success. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - an application's name + an application's name - - return location for the command line of the application, or %NULL + + return location for the command line of the application, or %NULL - - return location for the registration count, or %NULL + + return location for the registration count, or %NULL - - return location for the last registration time, or %NULL + + return location for the last registration time, or %NULL - - Gets the registration information of @app_name for the bookmark for + + Gets the registration information of @app_name for the bookmark for @uri. See g_bookmark_file_set_application_info() for more information about the returned data. @@ -2203,81 +1589,45 @@ the command line fails, an error of the #G_SHELL_ERROR domain is set and %FALSE is returned. - %TRUE on success. + %TRUE on success. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - an application's name + an application's name - - return location for the command line of the application, or %NULL + + return location for the command line of the application, or %NULL - - return location for the registration count, or %NULL + + return location for the registration count, or %NULL - - return location for the last registration time, or %NULL + + return location for the last registration time, or %NULL - - Retrieves the names of the applications that have registered the + + Retrieves the names of the applications that have registered the bookmark for @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a newly allocated %NULL-terminated array of strings. + a newly allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -2285,70 +1635,43 @@ In the event the URI cannot be found, %NULL is returned and - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - return location of the length of the returned list, or %NULL + + return location of the length of the returned list, or %NULL - - Retrieves the description of the bookmark for @uri. + + Retrieves the description of the bookmark for @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified URI cannot be found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Retrieves the list of group names of the bookmark for @uri. + + Retrieves the list of group names of the bookmark for @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. @@ -2357,9 +1680,7 @@ The returned array is %NULL terminated, so @length may optionally be %NULL. - a newly allocated %NULL-terminated array of group names. + a newly allocated %NULL-terminated array of group names. Use g_strfreev() to free it. @@ -2367,92 +1688,51 @@ be %NULL. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - return location for the length of the returned string, or %NULL + + return location for the length of the returned string, or %NULL - - Gets the icon of the bookmark for @uri. + + Gets the icon of the bookmark for @uri. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if the icon for the bookmark for the URI was found. + %TRUE if the icon for the bookmark for the URI was found. You should free the returned strings. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - return location for the icon's location or %NULL + + return location for the icon's location or %NULL - - return location for the icon's MIME type or %NULL + + return location for the icon's MIME type or %NULL - - Gets whether the private flag of the bookmark for @uri is set. + + Gets whether the private flag of the bookmark for @uri is set. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the @@ -2460,33 +1740,22 @@ event that the private flag cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. - %TRUE if the private flag is set, %FALSE otherwise. + %TRUE if the private flag is set, %FALSE otherwise. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Retrieves the MIME type of the resource pointed by @uri. + + Retrieves the MIME type of the resource pointed by @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the @@ -2494,36 +1763,23 @@ event that the MIME type cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified URI cannot be found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Gets the time when the bookmark for @uri was last modified. + + Gets the time when the bookmark for @uri was last modified. In the event the URI cannot be found, -1 is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. @@ -2531,87 +1787,57 @@ In the event the URI cannot be found, -1 is returned and `time_t` is deprecated due to the year 2038 problem. - a timestamp + a timestamp - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Gets the time when the bookmark for @uri was last modified. + + Gets the time when the bookmark for @uri was last modified. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a #GDateTime + a #GDateTime - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Gets the number of bookmarks inside @bookmark. + + Gets the number of bookmarks inside @bookmark. - the number of bookmarks + the number of bookmarks - a #GBookmarkFile + a #GBookmarkFile - - Returns the title of the bookmark for @uri. + + Returns the title of the bookmark for @uri. If @uri is %NULL, the title of @bookmark is returned. @@ -2619,43 +1845,28 @@ In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified URI cannot be found. - a #GBookmarkFile + a #GBookmarkFile - - a valid URI or %NULL + + a valid URI or %NULL - - Returns all URIs of the bookmarks in the bookmark file @bookmark. + + Returns all URIs of the bookmarks in the bookmark file @bookmark. The array of returned URIs will be %NULL-terminated, so @length may optionally be %NULL. - a newly allocated %NULL-terminated array of strings. + a newly allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -2663,33 +1874,17 @@ optionally be %NULL. - a #GBookmarkFile + a #GBookmarkFile - - return location for the number of returned URIs, or %NULL + + return location for the number of returned URIs, or %NULL - - Gets the time the bookmark for @uri was last visited. + + Gets the time the bookmark for @uri was last visited. In the event the URI cannot be found, -1 is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. @@ -2697,288 +1892,188 @@ In the event the URI cannot be found, -1 is returned and `time_t` is deprecated due to the year 2038 problem. - a timestamp. + a timestamp. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Gets the time the bookmark for @uri was last visited. + + Gets the time the bookmark for @uri was last visited. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a #GDateTime + a #GDateTime - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Checks whether the bookmark for @uri inside @bookmark has been + + Checks whether the bookmark for @uri inside @bookmark has been registered by application @name. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if the application @name was found + %TRUE if the application @name was found - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the name of the application + the name of the application - - Checks whether @group appears in the list of groups to which + + Checks whether @group appears in the list of groups to which the bookmark for @uri belongs to. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if @group was found. + %TRUE if @group was found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the group name to be searched + the group name to be searched - - Looks whether the desktop bookmark has an item with its URI set to @uri. + + Looks whether the desktop bookmark has an item with its URI set to @uri. - %TRUE if @uri is inside @bookmark, %FALSE otherwise + %TRUE if @uri is inside @bookmark, %FALSE otherwise - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Loads a bookmark file from memory into an empty #GBookmarkFile + + Loads a bookmark file from memory into an empty #GBookmarkFile structure. If the object cannot be created then @error is set to a #GBookmarkFileError. - %TRUE if a desktop bookmark could be loaded. + %TRUE if a desktop bookmark could be loaded. - an empty #GBookmarkFile struct + an empty #GBookmarkFile struct - desktop bookmarks + desktop bookmarks loaded in memory - the length of @data in bytes + the length of @data in bytes - - This function looks for a desktop bookmark file named @file in the + + This function looks for a desktop bookmark file named @file in the paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), loads the file into @bookmark and returns the file's full path in @full_path. If the file could not be loaded then @error is set to either a #GFileError or #GBookmarkFileError. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - a #GBookmarkFile + a #GBookmarkFile - a relative path to a filename to open and parse + a relative path to a filename to open and parse - - return location for a string + + return location for a string containing the full path of the file, or %NULL - - Loads a desktop bookmark file into an empty #GBookmarkFile structure. + + Loads a desktop bookmark file into an empty #GBookmarkFile structure. If the file could not be loaded then @error is set to either a #GFileError or #GBookmarkFileError. - %TRUE if a desktop bookmark file could be loaded + %TRUE if a desktop bookmark file could be loaded - an empty #GBookmarkFile struct + an empty #GBookmarkFile struct - the path of a filename to load, in the + the path of a filename to load, in the GLib file name encoding - - Changes the URI of a bookmark item from @old_uri to @new_uri. Any + + Changes the URI of a bookmark item from @old_uri to @new_uri. Any existing bookmark for @new_uri will be overwritten. If @new_uri is %NULL, then the bookmark is removed. @@ -2986,42 +2081,26 @@ In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if the URI was successfully changed + %TRUE if the URI was successfully changed - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - a valid URI, or %NULL + + a valid URI, or %NULL - - Removes application registered with @name from the list of applications + + Removes application registered with @name from the list of applications that have registered a bookmark for @uri inside @bookmark. In the event the URI cannot be found, %FALSE is returned and @@ -3031,39 +2110,26 @@ a bookmark for @uri, %FALSE is returned and error is set to #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. - %TRUE if the application was successfully removed. + %TRUE if the application was successfully removed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the name of the application + the name of the application - - Removes @group from the list of groups to which the bookmark + + Removes @group from the list of groups to which the bookmark for @uri belongs to. In the event the URI cannot be found, %FALSE is returned and @@ -3072,69 +2138,44 @@ In the event no group was defined, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. - %TRUE if @group was successfully removed. + %TRUE if @group was successfully removed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the group name to be removed + the group name to be removed - - Removes the bookmark for @uri from the bookmark file @bookmark. + + Removes the bookmark for @uri from the bookmark file @bookmark. - %TRUE if the bookmark was removed successfully. + %TRUE if the bookmark was removed successfully. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - Sets the time the bookmark for @uri was added into @bookmark. + + Sets the time the bookmark for @uri was added into @bookmark. If no bookmark for @uri is found then it is created. Use g_bookmark_file_set_added_date_time() instead, as @@ -3145,31 +2186,21 @@ If no bookmark for @uri is found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a timestamp or -1 to use the current time + a timestamp or -1 to use the current time - - Sets the time the bookmark for @uri was added into @bookmark. + + Sets the time the bookmark for @uri was added into @bookmark. If no bookmark for @uri is found then it is created. @@ -3178,34 +2209,21 @@ If no bookmark for @uri is found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a #GDateTime + a #GDateTime - - Sets the meta-data of application @name inside the list of + + Sets the meta-data of application @name inside the list of applications that have registered a bookmark for @uri inside @bookmark. @@ -3237,58 +2255,39 @@ for @uri is found, one is created. `time_t` is deprecated due to the year 2038 problem. - %TRUE if the application's meta-data was successfully + %TRUE if the application's meta-data was successfully changed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - an application's name + an application's name - an application's command line + an application's command line - the number of registrations done for this application + the number of registrations done for this application - the time of the last registration for this application + the time of the last registration for this application - - Sets the meta-data of application @name inside the list of + + Sets the meta-data of application @name inside the list of applications that have registered a bookmark for @uri inside @bookmark. @@ -3317,61 +2316,40 @@ for @uri, %FALSE is returned and error is set to for @uri is found, one is created. - %TRUE if the application's meta-data was successfully + %TRUE if the application's meta-data was successfully changed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - an application's name + an application's name - an application's command line + an application's command line - the number of registrations done for this application + the number of registrations done for this application - - the time of the last registration for this application, + + the time of the last registration for this application, which may be %NULL if @count is 0 - - Sets @description as the description of the bookmark for @uri. + + Sets @description as the description of the bookmark for @uri. If @uri is %NULL, the description of @bookmark is set. @@ -3382,34 +2360,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - - a valid URI or %NULL + + a valid URI or %NULL - a string + a string - - Sets a list of group names for the item with URI @uri. Each previously + + Sets a list of group names for the item with URI @uri. Each previously set group name list is removed. If @uri cannot be found then an item for it is created. @@ -3419,43 +2384,28 @@ If @uri cannot be found then an item for it is created. - a #GBookmarkFile + a #GBookmarkFile - an item's URI + an item's URI - - an array of + + an array of group names, or %NULL to remove all groups - number of group name values in @groups + number of group name values in @groups - - Sets the icon for the bookmark for @uri. If @href is %NULL, unsets + + Sets the icon for the bookmark for @uri. If @href is %NULL, unsets the currently set icon. @href can either be a full URL for the icon file or the icon name following the Icon Naming specification. @@ -3466,40 +2416,25 @@ If no bookmark for @uri is found one is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - - the URI of the icon for the bookmark, or %NULL + + the URI of the icon for the bookmark, or %NULL - the MIME type of the icon for the bookmark + the MIME type of the icon for the bookmark - - Sets the private flag of the bookmark for @uri. + + Sets the private flag of the bookmark for @uri. If a bookmark for @uri cannot be found then it is created. @@ -3508,31 +2443,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - %TRUE if the bookmark should be marked as private + %TRUE if the bookmark should be marked as private - - Sets @mime_type as the MIME type of the bookmark for @uri. + + Sets @mime_type as the MIME type of the bookmark for @uri. If a bookmark for @uri cannot be found then it is created. @@ -3541,33 +2466,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a MIME type + a MIME type - - Sets the last time the bookmark for @uri was last modified. + + Sets the last time the bookmark for @uri was last modified. If no bookmark for @uri is found then it is created. @@ -3583,31 +2496,21 @@ g_bookmark_file_set_visited_date_time(). - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a timestamp or -1 to use the current time + a timestamp or -1 to use the current time - - Sets the last time the bookmark for @uri was last modified. + + Sets the last time the bookmark for @uri was last modified. If no bookmark for @uri is found then it is created. @@ -3621,31 +2524,21 @@ g_bookmark_file_set_visited_date_time(). - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a #GDateTime + a #GDateTime - - Sets @title as the title of the bookmark for @uri inside the + + Sets @title as the title of the bookmark for @uri inside the bookmark file @bookmark. If @uri is %NULL, the title of @bookmark is set. @@ -3657,36 +2550,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - - a valid URI or %NULL + + a valid URI or %NULL - a UTF-8 encoded string + a UTF-8 encoded string - - Sets the time the bookmark for @uri was last visited. + + Sets the time the bookmark for @uri was last visited. If no bookmark for @uri is found then it is created. @@ -3703,31 +2581,21 @@ does not affect the "modified" time. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a timestamp or -1 to use the current time + a timestamp or -1 to use the current time - - Sets the time the bookmark for @uri was last visited. + + Sets the time the bookmark for @uri was last visited. If no bookmark for @uri is found then it is created. @@ -3742,37 +2610,24 @@ does not affect the "modified" time. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a #GDateTime + a #GDateTime - - This function outputs @bookmark as a string. + + This function outputs @bookmark as a string. - + a newly allocated string holding the contents of the #GBookmarkFile @@ -3780,50 +2635,30 @@ does not affect the "modified" time. - a #GBookmarkFile + a #GBookmarkFile - - return location for the length of the returned string, or %NULL + + return location for the length of the returned string, or %NULL - - This function outputs @bookmark into a file. The write process is + + This function outputs @bookmark into a file. The write process is guaranteed to be atomic by using g_file_set_contents() internally. - %TRUE if the file was successfully written. + %TRUE if the file was successfully written. - a #GBookmarkFile + a #GBookmarkFile - path of the output file + path of the output file @@ -3833,189 +2668,114 @@ guaranteed to be atomic by using g_file_set_contents() internally. - - Creates a new empty #GBookmarkFile object. + + Creates a new empty #GBookmarkFile object. Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data() or g_bookmark_file_load_from_data_dirs() to read an existing bookmark file. - an empty #GBookmarkFile + an empty #GBookmarkFile - - Error codes returned by bookmark file parsing. - - - URI was ill-formed + + Error codes returned by bookmark file parsing. + + + URI was ill-formed - - a requested field was not found + + a requested field was not found - - a requested application did + + a requested application did not register a bookmark - - a requested URI was not found + + a requested URI was not found - document was ill formed + document was ill formed - - the text being parsed was + + the text being parsed was in an unknown encoding - - an error occurred while writing + + an error occurred while writing - - requested file was not found + + requested file was not found - - Contains the public fields of a GByteArray. + + Contains the public fields of a GByteArray. - a pointer to the element data. The data may be moved as + a pointer to the element data. The data may be moved as elements are added to the #GByteArray - the number of elements in the #GByteArray + the number of elements in the #GByteArray - - Adds the given bytes to the end of the #GByteArray. + + Adds the given bytes to the end of the #GByteArray. The array will grow in size automatically if necessary. - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the byte data to be added + the byte data to be added - the number of bytes to add + the number of bytes to add - Frees the memory allocated by the #GByteArray. If @free_segment is + Frees the memory allocated by the #GByteArray. If @free_segment is %TRUE it frees the actual byte data. If the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array will be set to zero. - the element data if @free_segment is %FALSE, otherwise + the element data if @free_segment is %FALSE, otherwise %NULL. The element data should be freed using g_free(). - a #GByteArray + a #GByteArray - if %TRUE the actual byte data is freed as well + if %TRUE the actual byte data is freed as well - - Transfers the data from the #GByteArray into a new immutable #GBytes. + + Transfers the data from the #GByteArray into a new immutable #GBytes. The #GByteArray is freed unless the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array @@ -4025,17 +2785,13 @@ This is identical to using g_bytes_new_take() and g_byte_array_free() together. - a new immutable #GBytes representing same + a new immutable #GBytes representing same byte data that was in the array - a #GByteArray + a #GByteArray @@ -4043,292 +2799,206 @@ together. - Creates a new #GByteArray with a reference count of 1. + Creates a new #GByteArray with a reference count of 1. - the new #GByteArray + the new #GByteArray - - Create byte array containing the data. The data will be owned by the array -and will be freed with g_free(), i.e. it could be allocated using g_strdup(). + + Create byte array containing the data. The data will be owned by the array +and will be freed with g_free(), i.e. it could be allocated using g_strdup(). + +Do not use it if @len is greater than %G_MAXUINT. #GByteArray +stores the length of its data in #guint, which may be shorter than +#gsize. - a new #GByteArray + a new #GByteArray - byte data for the array + byte data for the array - length of @data + length of @data - - Adds the given data to the start of the #GByteArray. + + Adds the given data to the start of the #GByteArray. The array will grow in size automatically if necessary. - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the byte data to be added + the byte data to be added - the number of bytes to add + the number of bytes to add - - Atomically increments the reference count of @array by one. + + Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread. - The passed in #GByteArray + The passed in #GByteArray - A #GByteArray + A #GByteArray - - Removes the byte at the given index from a #GByteArray. + + Removes the byte at the given index from a #GByteArray. The following bytes are moved down one place. - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the index of the byte to remove + the index of the byte to remove - - Removes the byte at the given index from a #GByteArray. The last + + Removes the byte at the given index from a #GByteArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the #GByteArray. But it is faster than g_byte_array_remove_index(). - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the index of the byte to remove + the index of the byte to remove - - Removes the given number of bytes starting at the given index from a + + Removes the given number of bytes starting at the given index from a #GByteArray. The following elements are moved to close the gap. - the #GByteArray + the #GByteArray - a @GByteArray + a @GByteArray - the index of the first byte to remove + the index of the first byte to remove - the number of bytes to remove + the number of bytes to remove - - Sets the size of the #GByteArray, expanding it if necessary. + + Sets the size of the #GByteArray, expanding it if necessary. - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the new size of the #GByteArray + the new size of the #GByteArray - - Creates a new #GByteArray with @reserved_size bytes preallocated. + + Creates a new #GByteArray with @reserved_size bytes preallocated. This avoids frequent reallocation, if you are going to add many bytes to the array. Note however that the size of the array is still 0. - the new #GByteArray + the new #GByteArray - number of bytes preallocated + number of bytes preallocated - - Sorts a byte array, using @compare_func which should be a + + Sorts a byte array, using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if first arg is greater than second arg). @@ -4344,27 +3014,19 @@ their addresses. - a #GByteArray + a #GByteArray - comparison function + comparison function - - Like g_byte_array_sort(), but the comparison function takes an extra + + Like g_byte_array_sort(), but the comparison function takes an extra user data argument. @@ -4372,71 +3034,47 @@ user data argument. - a #GByteArray + a #GByteArray - comparison function + comparison function - - data to pass to @compare_func + + data to pass to @compare_func - Frees the data in the array and resets the size to zero, while + Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller. - the element data, which should be + the element data, which should be freed using g_free(). - a #GByteArray. + a #GByteArray. - - pointer to retrieve the number of + + pointer to retrieve the number of elements of the original array - Atomically decrements the reference count of @array by one. If the + Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread. @@ -4446,9 +3084,7 @@ thread. - A #GByteArray + A #GByteArray @@ -4456,15 +3092,8 @@ thread. - - A simple refcounted data type representing an immutable sequence of zero or + + A simple refcounted data type representing an immutable sequence of zero or more bytes from an unspecified origin. The purpose of a #GBytes is to keep the memory region that it holds @@ -4490,83 +3119,54 @@ mutable array for a #GBytes sequence. To create an immutable #GBytes from a mutable #GByteArray, use the g_byte_array_free_to_bytes() function. - Creates a new #GBytes from @data. + Creates a new #GBytes from @data. @data is copied. If @size is 0, @data may be %NULL. - a new #GBytes + a new #GBytes - - + + the data to be used for the bytes - the size of @data + the size of @data - - Creates a new #GBytes from static data. + + Creates a new #GBytes from static data. @data must be static (ie: never modified or freed). It may be %NULL if @size is 0. - a new #GBytes + a new #GBytes - - + + the data to be used for the bytes - the size of @data + the size of @data - - Creates a new #GBytes from @data. + + Creates a new #GBytes from @data. After this call, @data belongs to the bytes and may no longer be modified by the caller. g_free() will be called on @data when the @@ -4580,39 +3180,25 @@ g_bytes_new_with_free_func(). @data may be %NULL if @size is 0. - a new #GBytes + a new #GBytes - - + + the data to be used for the bytes - the size of @data + the size of @data - - Creates a #GBytes from @data. + + Creates a #GBytes from @data. When the last reference is dropped, @free_func will be called with the @user_data argument. @@ -4623,51 +3209,33 @@ been called to indicate that the bytes is no longer in use. @data may be %NULL if @size is 0. - a new #GBytes + a new #GBytes - - + + the data to be used for the bytes - the size of @data + the size of @data - the function to call to release the data + the function to call to release the data - - data to pass to @free_func + + data to pass to @free_func - Compares the two #GBytes values. + Compares the two #GBytes values. This function can be used to sort GBytes instances in lexicographical order. @@ -4678,62 +3246,46 @@ comparison. If @bytes1 has a smaller value at that position it is considered less, otherwise greater than @bytes2. - a negative value if @bytes1 is less than @bytes2, a positive value + a negative value if @bytes1 is less than @bytes2, a positive value if @bytes1 is greater than @bytes2, and zero if @bytes1 is equal to @bytes2 - a pointer to a #GBytes + a pointer to a #GBytes - a pointer to a #GBytes to compare with @bytes1 + a pointer to a #GBytes to compare with @bytes1 - Compares the two #GBytes values being pointed to and returns + Compares the two #GBytes values being pointed to and returns %TRUE if they are equal. This function can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #GBytes + a pointer to a #GBytes - a pointer to a #GBytes to compare with @bytes1 + a pointer to a #GBytes to compare with @bytes1 - Get the byte data in the #GBytes. This data should not be modified. + Get the byte data in the #GBytes. This data should not be modified. This function will always return the same pointer for a given #GBytes. @@ -4742,9 +3294,7 @@ may represent an empty string with @data non-%NULL and @size as 0. %NULL will not be returned if @size is non-zero. - + a pointer to the byte data, or %NULL @@ -4752,75 +3302,95 @@ not be returned if @size is non-zero. - a #GBytes + a #GBytes - - location to return size of byte data + + location to return size of byte data + + Gets a pointer to a region in @bytes. + +The region starts at @offset many bytes from the start of the data +and contains @n_elements many elements of @element_size size. + +@n_elements may be zero, but @element_size must always be non-zero. +Ideally, @element_size is a static constant (eg: sizeof a struct). + +This function does careful bounds checking (including checking for +arithmetic overflows) and returns a non-%NULL pointer if the +specified region lies entirely within the @bytes. If the region is +in some way out of range, or if an overflow has occurred, then %NULL +is returned. + +Note: it is possible to have a valid zero-size region. In this case, +the returned pointer will be equal to the base pointer of the data of +@bytes, plus @offset. This will be non-%NULL except for the case +where @bytes itself was a zero-sized region. Since it is unlikely +that you will be using this function to check for a zero-sized region +in a zero-sized @bytes, %NULL effectively always means "error". + + + the requested region, or %NULL in case of an error + + + + + a #GBytes + + + + a non-zero element size + + + + an offset to the start of the region within the @bytes + + + + the number of elements in the region + + + + - Get the size of the byte data in the #GBytes. + Get the size of the byte data in the #GBytes. This function will always return the same value for a given #GBytes. - the size + the size - a #GBytes + a #GBytes - Creates an integer hash code for the byte data in the #GBytes. + Creates an integer hash code for the byte data in the #GBytes. This function can be passed to g_hash_table_new() as the @key_hash_func parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #GBytes key + a pointer to a #GBytes key - - Creates a #GBytes which is a subsection of another #GBytes. The @offset + + + Creates a #GBytes which is a subsection of another #GBytes. The @offset + @length may not be longer than the size of @bytes. A reference to @bytes will be held by the newly created #GBytes until @@ -4833,109 +3403,80 @@ the same #GBytes instead of @bytes. This allows consumers to simplify the usage of #GBytes when asynchronously writing to streams. - a new #GBytes + a new #GBytes - a #GBytes + a #GBytes - offset which subsection starts at + offset which subsection starts at - length of subsection + length of subsection - Increase the reference count on @bytes. + Increase the reference count on @bytes. - the #GBytes + the #GBytes - a #GBytes + a #GBytes - Releases a reference on @bytes. This may result in the bytes being + Releases a reference on @bytes. This may result in the bytes being freed. If @bytes is %NULL, it will return immediately. - - a #GBytes + + a #GBytes - - Unreferences the bytes, and returns a new mutable #GByteArray containing + + Unreferences the bytes, and returns a new mutable #GByteArray containing the same byte data. As an optimization, the byte data is transferred to the array without copying if this was the last reference to bytes and bytes was created with g_bytes_new(), g_bytes_new_take() or g_byte_array_free_to_bytes(). In all -other cases the data is copied. +other cases the data is copied. + +Do not use it if @bytes contains more than %G_MAXUINT +bytes. #GByteArray stores the length of its data in #guint, which +may be shorter than #gsize, that @bytes is using. - a new mutable #GByteArray containing the same byte data + a new mutable #GByteArray containing the same byte data - a #GBytes + a #GBytes - - Unreferences the bytes, and returns a pointer the same byte data + + Unreferences the bytes, and returns a pointer the same byte data contents. As an optimization, the byte data is returned without copying if this was @@ -4944,9 +3485,7 @@ g_bytes_new_take() or g_byte_array_free_to_bytes(). In all other cases the data is copied. - a pointer to the same byte data, which should be + a pointer to the same byte data, which should be freed with g_free() @@ -4954,96 +3493,61 @@ data is copied. - a #GBytes + a #GBytes - - location to place the length of the returned data + + location to place the length of the returned data - - Checks the version of the GLib library that is being compiled + + Checks the version of the GLib library that is being compiled against. See glib_check_version() for a runtime check. - the major version to check for + the major version to check for - the minor version to check for + the minor version to check for - the micro version to check for + the micro version to check for - - The set of uppercase ASCII alphabet characters. + + The set of uppercase ASCII alphabet characters. Used for specifying valid identifier characters in #GScannerConfig. - The set of ASCII digits. + The set of ASCII digits. Used for specifying valid identifier characters in #GScannerConfig. - - The set of lowercase ASCII alphabet characters. + + The set of lowercase ASCII alphabet characters. Used for specifying valid identifier characters in #GScannerConfig. - - An opaque structure representing a checksumming operation. + + An opaque structure representing a checksumming operation. + To create a new GChecksum, use g_checksum_new(). To free a GChecksum, use g_checksum_free(). - + - Creates a new #GChecksum, using the checksum algorithm @checksum_type. + Creates a new #GChecksum, using the checksum algorithm @checksum_type. If the @checksum_type is not known, %NULL is returned. A #GChecksum can be used to compute the checksum, or digest, of an arbitrary binary blob, using different hashing algorithms. @@ -5056,385 +3560,269 @@ vector of raw bytes. Once either g_checksum_get_string() or g_checksum_get_digest() have been called on a #GChecksum, the checksum will be closed and it won't be possible to call g_checksum_update() on it anymore. - - - the newly created #GChecksum, or %NULL. + + + the newly created #GChecksum, or %NULL. Use g_checksum_free() to free the memory allocated by it. - the desired type of checksum + the desired type of checksum - Copies a #GChecksum. If @checksum has been closed, by calling + Copies a #GChecksum. If @checksum has been closed, by calling g_checksum_get_string() or g_checksum_get_digest(), the copied checksum will be closed as well. - + - the copy of the passed #GChecksum. Use g_checksum_free() - when finished using it. + the copy of the passed #GChecksum. Use + g_checksum_free() when finished using it. - the #GChecksum to copy + the #GChecksum to copy - Frees the memory allocated for @checksum. - + Frees the memory allocated for @checksum. + - a #GChecksum + a #GChecksum - - Gets the digest from @checksum as a raw binary vector and places it + + Gets the digest from @checksum as a raw binary vector and places it into @buffer. The size of the digest depends on the type of checksum. Once this function has been called, the #GChecksum is closed and can no longer be updated with g_checksum_update(). - + - a #GChecksum + a #GChecksum - output buffer + output buffer - - an inout parameter. The caller initializes it to the size of @buffer. + + an inout parameter. The caller initializes it to the size of @buffer. After the call it contains the length of the digest. - - Gets the digest as a hexadecimal string. + + Gets the digest as a hexadecimal string. Once this function has been called the #GChecksum can no longer be updated with g_checksum_update(). The hexadecimal characters will be lower case. - + - the hexadecimal representation of the checksum. The + the hexadecimal representation of the checksum. The returned string is owned by the checksum and should not be modified or freed. - a #GChecksum + a #GChecksum - Resets the state of the @checksum back to its initial state. - + Resets the state of the @checksum back to its initial state. + - the #GChecksum to reset + the #GChecksum to reset - Feeds @data into an existing #GChecksum. The checksum must still be + Feeds @data into an existing #GChecksum. The checksum must still be open, that is g_checksum_get_string() or g_checksum_get_digest() must not have been called on @checksum. - + - a #GChecksum + a #GChecksum - buffer used to compute the checksum + buffer used to compute the checksum - size of the buffer, or -1 if it is a null-terminated string. + size of the buffer, or -1 if it is a null-terminated string. - - Gets the length in bytes of digests of type @checksum_type - + + Gets the length in bytes of digests of type @checksum_type + - the checksum length, or -1 if @checksum_type is + the checksum length, or -1 if @checksum_type is not supported. - a #GChecksumType + a #GChecksumType - The hashing algorithm to be used by #GChecksum when performing the + The hashing algorithm to be used by #GChecksum when performing the digest of some data. Note that the #GChecksumType enumeration may be extended at a later date to include new hashing algorithm types. - Use the MD5 hashing algorithm + Use the MD5 hashing algorithm - Use the SHA-1 hashing algorithm + Use the SHA-1 hashing algorithm - Use the SHA-256 hashing algorithm + Use the SHA-256 hashing algorithm - Use the SHA-512 hashing algorithm (Since: 2.36) + Use the SHA-512 hashing algorithm (Since: 2.36) - Use the SHA-384 hashing algorithm (Since: 2.51) + Use the SHA-384 hashing algorithm (Since: 2.51) - Prototype of a #GChildWatchSource callback, called when a child -process has exited. To interpret @status, see the documentation -for g_spawn_check_exit_status(). - + Prototype of a #GChildWatchSource callback, called when a child +process has exited. + +To interpret @wait_status, see the documentation +for g_spawn_check_wait_status(). In particular, +on Unix platforms, note that it is usually not equal +to the integer passed to `exit()` or returned from `main()`. + - the process id of the child process + the process id of the child process - - Status information about the child process, encoded - in a platform-specific manner + + Status information about the child process, encoded + in a platform-specific manner - - user data passed to g_child_watch_add() + + user data passed to g_child_watch_add() - Specifies the type of function passed to g_clear_handle_id(). + Specifies the type of function passed to g_clear_handle_id(). The implementation is expected to free the resource identified by @handle_id; for instance, if @handle_id is a #GSource ID, g_source_remove() can be used. - + - the handle ID to clear + the handle ID to clear - Specifies the type of a comparison function used to compare two + Specifies the type of a comparison function used to compare two values. The function should return a negative integer if the first value comes before the second, 0 if they are equal, or a positive integer if the first value comes after the second. - negative value if @a < @b; zero if @a = @b; positive + negative value if @a < @b; zero if @a = @b; positive value if @a > @b - - a value + + a value - - a value to compare with + + a value to compare with - - user data + + user data - Specifies the type of a comparison function used to compare two + Specifies the type of a comparison function used to compare two values. The function should return a negative integer if the first value comes before the second, 0 if they are equal, or a positive integer if the first value comes after the second. - negative value if @a < @b; zero if @a = @b; positive + negative value if @a < @b; zero if @a = @b; positive value if @a > @b - - a value + + a value - - a value to compare with + + a value to compare with - The #GCond struct is an opaque data structure that represents a + The #GCond struct is an opaque data structure that represents a condition. Threads can block on a #GCond if they find a certain condition to be false. If other threads change the state of this condition they signal the #GCond, and that causes the waiting @@ -5509,9 +3897,7 @@ A #GCond should only be accessed via the g_cond_ functions. - If threads are waiting for @cond, all of them are unblocked. + If threads are waiting for @cond, all of them are unblocked. If no threads are waiting for @cond, this function has no effect. It is good practice to lock the same mutex as the waiting threads while calling this function, though not required. @@ -5521,17 +3907,13 @@ while calling this function, though not required. - a #GCond + a #GCond - Frees the resources allocated to a #GCond with g_cond_init(). + Frees the resources allocated to a #GCond with g_cond_init(). This function should not be used with a #GCond that has been statically allocated. @@ -5544,17 +3926,13 @@ blocking leads to undefined behaviour. - an initialised #GCond + an initialised #GCond - Initialises a #GCond so that it can be used. + Initialises a #GCond so that it can be used. This function is useful to initialise a #GCond that has been allocated as part of a larger structure. It is not necessary to @@ -5571,17 +3949,13 @@ to undefined behaviour. - an uninitialized #GCond + an uninitialized #GCond - If threads are waiting for @cond, at least one of them is unblocked. + If threads are waiting for @cond, at least one of them is unblocked. If no threads are waiting for @cond, this function has no effect. It is good practice to hold the same lock as the waiting thread while calling this function, though not required. @@ -5591,17 +3965,13 @@ while calling this function, though not required. - a #GCond + a #GCond - Atomically releases @mutex and waits until @cond is signalled. + Atomically releases @mutex and waits until @cond is signalled. When this function returns, @mutex is locked again and owned by the calling thread. @@ -5621,25 +3991,17 @@ the documentation for #GCond for a complete example. - a #GCond + a #GCond - a #GMutex that is currently locked + a #GMutex that is currently locked - - Waits until either @cond is signalled or @end_time has passed. + + Waits until either @cond is signalled or @end_time has passed. As with g_cond_wait() it is possible that a spurious or stolen wakeup could occur. For that reason, waiting on a condition variable should @@ -5689,167 +4051,101 @@ have to start over waiting again (which would lead to a total wait time of more than 5 seconds). - %TRUE on a signal, %FALSE on a timeout + %TRUE on a signal, %FALSE on a timeout - a #GCond + a #GCond - a #GMutex that is currently locked + a #GMutex that is currently locked - the monotonic time to wait until + the monotonic time to wait until - - Error codes returned by character set conversion routines. + + Error codes returned by character set conversion routines. - - Conversion between the requested character + + Conversion between the requested character sets is not supported. - - Invalid byte sequence in conversion input; + + Invalid byte sequence in conversion input; or the character sequence could not be represented in the target character set. - Conversion failed for some reason. + Conversion failed for some reason. - - Partial character sequence at end of input. + + Partial character sequence at end of input. - URI is invalid. + URI is invalid. - - Pathname is not an absolute path. + + Pathname is not an absolute path. - - No memory available. Since: 2.40 + + No memory available. Since: 2.40 - - An embedded NUL character is present in + + An embedded NUL character is present in conversion output where a NUL-terminated string is expected. Since: 2.56 - A function of this signature is used to copy the node data + A function of this signature is used to copy the node data when doing a deep-copy of a tree. - A pointer to the copy + A pointer to the copy - A pointer to the data which should be copied + A pointer to the data which should be copied - - Additional data + + Additional data - - A bitmask that restricts the possible flags passed to + + A bitmask that restricts the possible flags passed to g_datalist_set_flags(). Passing a flags value where flags & ~G_DATALIST_FLAGS_MASK != 0 is an error. - Represents an invalid #GDateDay. + Represents an invalid #GDateDay. - Represents an invalid Julian day number. + Represents an invalid Julian day number. - Represents an invalid year. + Represents an invalid year. - - Defines the appropriate cleanup function for a pointer type. + + Defines the appropriate cleanup function for a pointer type. The function will not be called if the variable to be cleaned up contains %NULL. @@ -5866,27 +4162,18 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC(GObject, g_object_unref) This macro should be used unconditionally; it is a no-op on compilers where cleanup is not supported. - + - a type name to define a g_autoptr() cleanup function for + a type name to define a g_autoptr() cleanup function for - the cleanup function + the cleanup function - - Defines the appropriate cleanup function for a type. + + Defines the appropriate cleanup function for a type. This will typically be the `_clear()` function for the given type. @@ -5899,27 +4186,18 @@ G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GQueue, g_queue_clear) This macro should be used unconditionally; it is a no-op on compilers where cleanup is not supported. - + - a type name to define a g_auto() cleanup function for + a type name to define a g_auto() cleanup function for - the clear function + the clear function - - Defines the appropriate cleanup function for a type. + + Defines the appropriate cleanup function for a type. With this definition, it will be possible to use g_auto() with @TypeName. @@ -5939,32 +4217,46 @@ G_DEFINE_AUTO_CLEANUP_FREE_FUNC(GStrv, g_strfreev, NULL) This macro should be used unconditionally; it is a no-op on compilers where cleanup is not supported. - + - a type name to define a g_auto() cleanup function for + a type name to define a g_auto() cleanup function for - the free function + the free function - the "none" value for the type + the "none" value for the type - - A convenience macro which defines a function returning the + + A convenience macro which defines two functions. First, returning +the #GQuark for the extended error type @ErrorType; it is called +`error_type_quark()`. Second, returning the private data from a +passed #GError; it is called `error_type_get_private()`. + +For this macro to work, a type named `ErrorTypePrivate` should be +defined, `error_type_private_init()`, `error_type_private_copy()` +and `error_type_private_clear()` functions need to be either +declared or defined. The functions should be similar to +#GErrorInitFunc, #GErrorCopyFunc and #GErrorClearFunc, +respectively, but they should receive the private data type instead +of #GError. + +See [Extended #GError Domains][gerror-extended-domains] for an example. + + + + name to return a #GQuark for + + + prefix for the function name + + + + + A convenience macro which defines a function returning the #GQuark for the name @QN. The function will be named @q_n_quark(). @@ -5973,222 +4265,183 @@ in the macro, so you shouldn't use double quotes. - the name to return a #GQuark for + the name to return a #GQuark for - prefix for the function name + prefix for the function name - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - This macro is similar to %G_GNUC_DEPRECATED_FOR, and can be used to mark + + + + + + + + + + + + + + + + This macro is similar to %G_GNUC_DEPRECATED_FOR, and can be used to mark functions declarations as deprecated. Unlike %G_GNUC_DEPRECATED_FOR, it is meant to be portable across different compilers and must be placed before the function declaration. @@ -6197,628 +4450,530 @@ before the function declaration. G_DEPRECATED_FOR(my_replacement) int my_mistake (void); ]| - + - the name of the function that this function was deprecated for + the name of the function that this function was deprecated for - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - + + - + - + - + - - + + - - + + - - + + - - + + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - The directory separator character. + The directory separator character. This is '/' on UNIX machines and '\' under Windows. - The directory separator as a string. + The directory separator as a string. This is "/" on UNIX machines and "\" under Windows. - The #GData struct is an opaque data structure to represent a -[Keyed Data List][glib-Keyed-Data-Lists]. It should only be -accessed via the following functions. + An opaque data structure that represents a keyed data list. + +See also: [Keyed data lists][glib-Keyed-Data-Lists]. - Specifies the type of function passed to g_dataset_foreach(). It is + Specifies the type of function passed to g_dataset_foreach(). It is called with each #GQuark id and associated data element, together with the @user_data parameter supplied to g_dataset_foreach(). @@ -6827,43 +4982,24 @@ with the @user_data parameter supplied to g_dataset_foreach(). - the #GQuark id to identifying the data element. + the #GQuark id to identifying the data element. - - the data element. + + the data element. - - user data passed to g_dataset_foreach(). + + user data passed to g_dataset_foreach(). - - Represents a day between January 1, Year 1 and a few thousand years in + + Represents a day between January 1, Year 1 and a few thousand years in the future. None of its members should be accessed directly. -If the #GDate-struct is obtained from g_date_new(), it will be safe +If the `GDate` is obtained from g_date_new(), it will be safe to mutate but invalid and thus not safe for calendrical computations. If it's declared on the stack, it will contain garbage so must be @@ -6873,118 +5009,84 @@ becomes valid after you set it to a Julian day or you set a day, month, and year. - the Julian representation of the date + the Julian representation of the date - this bit is set if @julian_days is valid + this bit is set if @julian_days is valid - this is set if @day, @month and @year are valid + this is set if @day, @month and @year are valid - the day of the day-month-year representation of the date, - as a number between 1 and 31 + the day of the day-month-year representation of the date, + as a number between 1 and 31 - the day of the day-month-year representation of the date, - as a number between 1 and 12 + the day of the day-month-year representation of the date, + as a number between 1 and 12 - the day of the day-month-year representation of the date + the day of the day-month-year representation of the date - Allocates a #GDate and initializes + Allocates a #GDate and initializes it to a safe state. The new date will be cleared (as if you'd called g_date_clear()) but invalid (it won't represent an existing day). Free the return value with g_date_free(). - a newly-allocated #GDate + a newly-allocated #GDate - Like g_date_new(), but also sets the value of the date. Assuming the + Like g_date_new(), but also sets the value of the date. Assuming the day-month-year triplet you pass in represents an existing day, the returned date will be valid. - a newly-allocated #GDate initialized with @day, @month, and @year + a newly-allocated #GDate initialized with @day, @month, and @year - day of the month + day of the month - month of the year + month of the year - year + year - Like g_date_new(), but also sets the value of the date. Assuming the + Like g_date_new(), but also sets the value of the date. Assuming the Julian day number you pass in is valid (greater than 0, less than an unreasonably large number), the returned date will be valid. - a newly-allocated #GDate initialized with @julian_day + a newly-allocated #GDate initialized with @julian_day - days since January 1, Year 1 + days since January 1, Year 1 - Increments a date some number of days. + Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid. @@ -6993,23 +5095,17 @@ The date must be valid. - a #GDate to increment + a #GDate to increment - number of days to move the date forward + number of days to move the date forward - Increments a date by some number of months. + Increments a date by some number of months. If the day of the month is greater than 28, this routine may change the day of the month (because the destination month may not have @@ -7020,23 +5116,17 @@ the current day in it). The date must be valid. - a #GDate to increment + a #GDate to increment - number of months to move forward + number of months to move forward - Increments a date by some number of years. + Increments a date by some number of years. If the date is February 29, and the destination year is not a leap year, the date will be changed to February 28. The date must be valid. @@ -7046,23 +5136,17 @@ to February 28. The date must be valid. - a #GDate to increment + a #GDate to increment - number of years to move forward + number of years to move forward - If @date is prior to @min_date, sets @date equal to @min_date. + If @date is prior to @min_date, sets @date equal to @min_date. If @date falls after @max_date, sets @date equal to @max_date. Otherwise, @date is unchanged. Either of @min_date and @max_date may be %NULL. @@ -7073,29 +5157,21 @@ All non-%NULL dates must be valid. - a #GDate to clamp + a #GDate to clamp - minimum accepted value for @date + minimum accepted value for @date - maximum accepted value for @date + maximum accepted value for @date - Initializes one or more #GDate structs to a safe but invalid + Initializes one or more #GDate structs to a safe but invalid state. The cleared dates will not represent an existing date, but will not contain garbage. Useful to init a date declared on the stack. Validity can be tested with g_date_valid(). @@ -7105,353 +5181,251 @@ Validity can be tested with g_date_valid(). - pointer to one or more dates to clear + pointer to one or more dates to clear - number of dates to clear + number of dates to clear - qsort()-style comparison function for dates. + qsort()-style comparison function for dates. Both dates must be valid. - 0 for equal, less than zero if @lhs is less than @rhs, + 0 for equal, less than zero if @lhs is less than @rhs, greater than zero if @lhs is greater than @rhs - first date to compare + first date to compare - second date to compare + second date to compare - Copies a GDate to a newly-allocated GDate. If the input was invalid + Copies a GDate to a newly-allocated GDate. If the input was invalid (as determined by g_date_valid()), the invalid state will be copied as is into the new object. - a newly-allocated #GDate initialized from @date + a newly-allocated #GDate initialized from @date - a #GDate to copy + a #GDate to copy - Computes the number of days between two dates. + Computes the number of days between two dates. If @date2 is prior to @date1, the returned value is negative. Both dates must be valid. - the number of days between @date1 and @date2 + the number of days between @date1 and @date2 - the first date + the first date - the second date + the second date - Frees a #GDate returned from g_date_new(). + Frees a #GDate returned from g_date_new(). - a #GDate to free + a #GDate to free - Returns the day of the month. The date must be valid. + Returns the day of the month. The date must be valid. - day of the month + day of the month - a #GDate to extract the day of the month from + a #GDate to extract the day of the month from - Returns the day of the year, where Jan 1 is the first day of the + Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid. - day of the year + day of the year - a #GDate to extract day of year from + a #GDate to extract day of year from - - Returns the week of the year, where weeks are interpreted according + + Returns the week of the year, where weeks are interpreted according to ISO 8601. - ISO 8601 week number of the year. + ISO 8601 week number of the year. - a valid #GDate + a valid #GDate - Returns the Julian day or "serial number" of the #GDate. The + Returns the Julian day or "serial number" of the #GDate. The Julian day is simply the number of days since January 1, Year 1; i.e., January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, etc. The date must be valid. - Julian day + Julian day - a #GDate to extract the Julian day from + a #GDate to extract the Julian day from - - Returns the week of the year, where weeks are understood to start on + + Returns the week of the year, where weeks are understood to start on Monday. If the date is before the first Monday of the year, return 0. The date must be valid. - week of the year + week of the year - a #GDate + a #GDate - Returns the month of the year. The date must be valid. + Returns the month of the year. The date must be valid. - month of the year as a #GDateMonth + month of the year as a #GDateMonth - a #GDate to get the month from + a #GDate to get the month from - - Returns the week of the year during which this date falls, if + + Returns the week of the year during which this date falls, if weeks are understood to begin on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year. - week number + week number - a #GDate + a #GDate - Returns the day of the week for a #GDate. The date must be valid. + Returns the day of the week for a #GDate. The date must be valid. - day of the week as a #GDateWeekday. + day of the week as a #GDateWeekday. - a #GDate + a #GDate - Returns the year of a #GDate. The date must be valid. + Returns the year of a #GDate. The date must be valid. - year in which the date falls + year in which the date falls - a #GDate + a #GDate - Returns %TRUE if the date is on the first of a month. + Returns %TRUE if the date is on the first of a month. The date must be valid. - %TRUE if the date is the first of the month + %TRUE if the date is the first of the month - a #GDate to check + a #GDate to check - Returns %TRUE if the date is the last day of the month. + Returns %TRUE if the date is the last day of the month. The date must be valid. - %TRUE if the date is the last day of the month + %TRUE if the date is the last day of the month - a #GDate to check + a #GDate to check - Checks if @date1 is less than or equal to @date2, + Checks if @date1 is less than or equal to @date2, and swap the values if this is not the case. @@ -7459,23 +5433,17 @@ and swap the values if this is not the case. - the first date + the first date - the second date + the second date - Sets the day of the month for a #GDate. If the resulting + Sets the day of the month for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. @@ -7483,23 +5451,17 @@ day-month-year triplet is invalid, the date will be invalid. - a #GDate + a #GDate - day to set + day to set - Sets the value of a #GDate from a day, month, and year. + Sets the value of a #GDate from a day, month, and year. The day-month-year triplet must be valid; if you aren't sure it is, call g_date_valid_dmy() to check before you set it. @@ -7509,58 +5471,42 @@ set it. - a #GDate + a #GDate - day + day - month + month - year + year - Sets the value of a #GDate from a Julian day number. + Sets the value of a #GDate from a Julian day number. - a #GDate + a #GDate - Julian day number (days since January 1, Year 1) + Julian day number (days since January 1, Year 1) - Sets the month of the year for a #GDate. If the resulting + Sets the month of the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. @@ -7568,23 +5514,17 @@ day-month-year triplet is invalid, the date will be invalid. - a #GDate + a #GDate - month to set + month to set - Parses a user-inputted string @str, and try to figure out what date it + Parses a user-inputted string @str, and try to figure out what date it represents, taking the [current locale][setlocale] into account. If the string is successfully parsed, the date will be valid after the call. Otherwise, it will be invalid. You should check using g_date_valid() @@ -7601,26 +5541,17 @@ capacity). - a #GDate to fill in + a #GDate to fill in - string to parse + string to parse - - Sets the value of a date from a #GTime value. + + Sets the value of a date from a #GTime value. The time to date conversion is done using the user's current timezone. Use g_date_set_time_t() instead. @@ -7629,25 +5560,17 @@ The time to date conversion is done using the user's current timezone. - a #GDate. + a #GDate. - #GTime value to set. + #GTime value to set. - - Sets the value of a date to the date corresponding to a time + + Sets the value of a date to the date corresponding to a time specified as a time_t. The time to date conversion is done using the user's current timezone. @@ -7664,27 +5587,17 @@ To set the value of a date to the current day, you could write: - a #GDate + a #GDate - time_t value to set + time_t value to set - - Sets the value of a date from a #GTimeVal value. Note that the + + Sets the value of a date from a #GTimeVal value. Note that the @tv_usec member is ignored, because #GDate can't make use of the additional precision. @@ -7697,23 +5610,17 @@ The time to date conversion is done using the user's current timezone. - a #GDate + a #GDate - #GTimeVal value to set + #GTimeVal value to set - Sets the year for a #GDate. If the resulting day-month-year + Sets the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. @@ -7721,23 +5628,17 @@ triplet is invalid, the date will be invalid. - a #GDate + a #GDate - year to set + year to set - Moves a date some number of days into the past. + Moves a date some number of days into the past. To move by weeks, just move by weeks*7 days. The date must be valid. @@ -7746,23 +5647,17 @@ The date must be valid. - a #GDate to decrement + a #GDate to decrement - number of days to move + number of days to move - Moves a date some number of months into the past. + Moves a date some number of months into the past. If the current day of the month doesn't exist in the destination month, the day of the month may change. The date must be valid. @@ -7772,23 +5667,17 @@ may change. The date must be valid. - a #GDate to decrement + a #GDate to decrement - number of months to move + number of months to move - Moves a date some number of years into the past. + Moves a date some number of years into the past. If the current day doesn't exist in the destination year (i.e. it's February 29 and you move to a non-leap-year) then the day is changed to February 29. The date @@ -7799,23 +5688,17 @@ must be valid. - a #GDate to decrement + a #GDate to decrement - number of years to move + number of years to move - Fills in the date-related bits of a struct tm using the @date value. + Fills in the date-related bits of a struct tm using the @date value. Initializes the non-date parts with something safe but meaningless. @@ -7823,74 +5706,52 @@ Initializes the non-date parts with something safe but meaningless. - a #GDate to set the struct tm from + a #GDate to set the struct tm from - struct tm to fill + struct tm to fill - Returns %TRUE if the #GDate represents an existing day. The date must not + Returns %TRUE if the #GDate represents an existing day. The date must not contain garbage; it should have been initialized with g_date_clear() if it wasn't allocated by one of the g_date_new() variants. - Whether the date is valid + Whether the date is valid - a #GDate to check + a #GDate to check - - Returns the number of days in a month, taking leap + + Returns the number of days in a month, taking leap years into account. - number of days in @month during the @year + number of days in @month during the @year - month + month - year + year - - Returns the number of weeks in the year, where weeks + + Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -7899,25 +5760,18 @@ Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.) - number of Mondays in the year + number of Mondays in the year - a year + a year - - Returns the number of weeks in the year, where weeks + + Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -7926,24 +5780,18 @@ Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.) - the number of weeks in @year + the number of weeks in @year - year to count weeks in + year to count weeks in - Returns %TRUE if the year is a leap year. + Returns %TRUE if the year is a leap year. For the purposes of this function, leap year is every year divisible by 4 unless that year is divisible by 100. If it @@ -7951,24 +5799,18 @@ is divisible by 100 it would be a leap year only if that year is also divisible by 400. - %TRUE if the year is a leap year + %TRUE if the year is a leap year - year to check + year to check - Generates a printed representation of the date, in a + Generates a printed representation of the date, in a [locale][setlocale]-specific way. Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats @@ -7983,271 +5825,191 @@ make the \%F provided by the C99 strftime() work on Windows where the C library only complies to C89. - number of characters written to the buffer, or 0 the buffer was too small + number of characters written to the buffer, or 0 the buffer was too small - destination buffer + destination buffer - buffer size + buffer size - format string + format string - valid #GDate + valid #GDate - Returns %TRUE if the day of the month is valid (a day is valid if it's + Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive). - %TRUE if the day is valid + %TRUE if the day is valid - day to check + day to check - Returns %TRUE if the day-month-year triplet forms a valid, existing day + Returns %TRUE if the day-month-year triplet forms a valid, existing day in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future). - %TRUE if the date is a valid one + %TRUE if the date is a valid one - day + day - month + month - year + year - Returns %TRUE if the Julian day is valid. Anything greater than zero + Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit. - %TRUE if the Julian day is valid + %TRUE if the Julian day is valid - Julian day to check + Julian day to check - Returns %TRUE if the month value is valid. The 12 #GDateMonth + Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months. - %TRUE if the month is valid + %TRUE if the month is valid - month + month - Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration + Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays. - %TRUE if the weekday is valid + %TRUE if the weekday is valid - weekday + weekday - Returns %TRUE if the year is valid. Any year greater than 0 is valid, + Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand. - %TRUE if the year is valid + %TRUE if the year is valid - year + year - This enumeration isn't used in the API, but may be useful if you need + This enumeration isn't used in the API, but may be useful if you need to mark a number as a day, month, or year. a day - a month + a month a year - Enumeration representing a month; values are #G_DATE_JANUARY, -#G_DATE_FEBRUARY, etc. #G_DATE_BAD_MONTH is the invalid value. + Enumeration representing a month; values are %G_DATE_JANUARY, +%G_DATE_FEBRUARY, etc. %G_DATE_BAD_MONTH is the invalid value. - invalid value + invalid value - January + January - February + February - March + March - April + April - May + May - June + June - July + July - August + August - September + September - October + October - November + November - December + December - - `GDateTime` is an opaque structure whose members -cannot be accessed directly. - + + An opaque structure that represents a date and time, including a time zone. + - Creates a new #GDateTime corresponding to the given date and time in + Creates a new #GDateTime corresponding to the given date and time in the time zone @tz. The @year must be between 1 and 9999, @month between 1 and 12 and @day @@ -8275,64 +6037,44 @@ return %NULL. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeZone + a #GTimeZone - the year component of the date + the year component of the date - the month component of the date + the month component of the date - the day component of the date + the day component of the date - the hour component of the date + the hour component of the date - the minute component of the date + the minute component of the date - the number of seconds past the minute + the number of seconds past the minute - - Creates a #GDateTime corresponding to the given + + Creates a #GDateTime corresponding to the given [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601) @text. ISO 8601 strings of the form <date><sep><time><tz> are supported, with some extensions from [RFC 3339](https://tools.ietf.org/html/rfc3339) as @@ -8375,40 +6117,25 @@ formatted string. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - an ISO 8601 formatted time string. + an ISO 8601 formatted time string. - - a #GTimeZone to use if the text doesn't contain a + + a #GTimeZone to use if the text doesn't contain a timezone, or %NULL. - - Creates a #GDateTime corresponding to the given #GTimeVal @tv in the + + Creates a #GDateTime corresponding to the given #GTimeVal @tv in the local time zone. The time contained in a #GTimeVal is always stored in the form of @@ -8422,30 +6149,20 @@ You should release the return value by calling g_date_time_unref() when you are done with it. #GTimeVal is not year-2038-safe. Use g_date_time_new_from_unix_local() instead. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeVal + a #GTimeVal - - Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC. + + Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC. The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC. @@ -8457,28 +6174,20 @@ You should release the return value by calling g_date_time_unref() when you are done with it. #GTimeVal is not year-2038-safe. Use g_date_time_new_from_unix_utc() instead. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeVal + a #GTimeVal - - Creates a #GDateTime corresponding to the given Unix time @t in the + + Creates a #GDateTime corresponding to the given Unix time @t in the local time zone. Unix time is the number of seconds that have elapsed since 1970-01-01 @@ -8489,28 +6198,20 @@ of the supported range of #GDateTime. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - the Unix time + the Unix time - - Creates a #GDateTime corresponding to the given Unix time @t in UTC. + + Creates a #GDateTime corresponding to the given Unix time @t in UTC. Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC. @@ -8520,84 +6221,58 @@ of the supported range of #GDateTime. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - the Unix time + the Unix time - - Creates a new #GDateTime corresponding to the given date and time in + + Creates a new #GDateTime corresponding to the given date and time in the local time zone. This call is equivalent to calling g_date_time_new() with the time zone returned by g_time_zone_new_local(). - + - a #GDateTime, or %NULL + a #GDateTime, or %NULL - the year component of the date + the year component of the date - the month component of the date + the month component of the date - the day component of the date + the day component of the date - the hour component of the date + the hour component of the date - the minute component of the date + the minute component of the date - the number of seconds past the minute + the number of seconds past the minute - - Creates a #GDateTime corresponding to this exact instant in the given + + Creates a #GDateTime corresponding to this exact instant in the given time zone @tz. The time is as accurate as the system allows, to a maximum accuracy of 1 microsecond. @@ -8606,453 +6281,350 @@ year 9999. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeZone + a #GTimeZone - - Creates a #GDateTime corresponding to this exact instant in the local + + Creates a #GDateTime corresponding to this exact instant in the local time zone. This is equivalent to calling g_date_time_new_now() with the time zone returned by g_time_zone_new_local(). - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - - Creates a #GDateTime corresponding to this exact instant in UTC. + + Creates a #GDateTime corresponding to this exact instant in UTC. This is equivalent to calling g_date_time_new_now() with the time zone returned by g_time_zone_new_utc(). - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - - Creates a new #GDateTime corresponding to the given date and time in + + Creates a new #GDateTime corresponding to the given date and time in UTC. This call is equivalent to calling g_date_time_new() with the time zone returned by g_time_zone_new_utc(). - + - a #GDateTime, or %NULL + a #GDateTime, or %NULL - the year component of the date + the year component of the date - the month component of the date + the month component of the date - the day component of the date + the day component of the date - the hour component of the date + the hour component of the date - the minute component of the date + the minute component of the date - the number of seconds past the minute + the number of seconds past the minute - Creates a copy of @datetime and adds the specified timespan to the copy. - + Creates a copy of @datetime and adds the specified timespan to the copy. + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - a #GTimeSpan + a #GTimeSpan - - Creates a copy of @datetime and adds the specified number of days to the + + Creates a copy of @datetime and adds the specified number of days to the copy. Add negative values to subtract days. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of days + the number of days - - Creates a new #GDateTime adding the specified values to the current date and + + Creates a new #GDateTime adding the specified values to the current date and time in @datetime. Add negative values to subtract. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of years to add + the number of years to add - the number of months to add + the number of months to add - the number of days to add + the number of days to add - the number of hours to add + the number of hours to add - the number of minutes to add + the number of minutes to add - the number of seconds to add + the number of seconds to add - - Creates a copy of @datetime and adds the specified number of hours. + + Creates a copy of @datetime and adds the specified number of hours. Add negative values to subtract hours. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of hours to add + the number of hours to add - - Creates a copy of @datetime adding the specified number of minutes. + + Creates a copy of @datetime adding the specified number of minutes. Add negative values to subtract minutes. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of minutes to add + the number of minutes to add - - Creates a copy of @datetime and adds the specified number of months to the + + Creates a copy of @datetime and adds the specified number of months to the copy. Add negative values to subtract months. The day of the month of the resulting #GDateTime is clamped to the number of days in the updated calendar month. For example, if adding 1 month to 31st January 2018, the result would be 28th February 2018. In 2020 (a leap year), the result would be 29th February. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of months + the number of months - - Creates a copy of @datetime and adds the specified number of seconds. + + Creates a copy of @datetime and adds the specified number of seconds. Add negative values to subtract seconds. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of seconds to add + the number of seconds to add - - Creates a copy of @datetime and adds the specified number of weeks to the + + Creates a copy of @datetime and adds the specified number of weeks to the copy. Add negative values to subtract weeks. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of weeks + the number of weeks - - Creates a copy of @datetime and adds the specified number of years to the + + Creates a copy of @datetime and adds the specified number of years to the copy. Add negative values to subtract years. As with g_date_time_add_months(), if the resulting date would be 29th February on a non-leap year, the day will be clamped to 28th February. - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the number of years + the number of years - - Calculates the difference in time between @end and @begin. The + + A comparison function for #GDateTimes that is suitable +as a #GCompareFunc. Both #GDateTimes must be non-%NULL. + + + -1, 0 or 1 if @dt1 is less than, equal to or greater + than @dt2. + + + + + first #GDateTime to compare + + + + second #GDateTime to compare + + + + + + Calculates the difference in time between @end and @begin. The #GTimeSpan that is returned is effectively @end - @begin (ie: positive if the first parameter is larger). - + - the difference between the two #GDateTime, as a time + the difference between the two #GDateTime, as a time span expressed in microseconds. - a #GDateTime + a #GDateTime - a #GDateTime + a #GDateTime + + Checks to see if @dt1 and @dt2 are equal. + +Equal here means that they represent the same moment after converting +them to the same time zone. + + + %TRUE if @dt1 and @dt2 are equal + + + + + a #GDateTime + + + + a #GDateTime + + + + - Creates a newly allocated string representing the requested @format. + Creates a newly allocated string representing the requested @format. The format strings understood by this function are a subset of the strftime() format language as specified by C99. The \%D, \%U and \%W @@ -9151,11 +6723,9 @@ some languages (Baltic, Slavic, Greek, and more) due to their grammatical rules. For other languages there is no difference. \%OB is a GNU and BSD strftime() extension expected to be added to the future POSIX specification, \%Ob and \%Oh are GNU strftime() extensions. Since: 2.56 - + - a newly allocated string formatted to + a newly allocated string formatted to the requested format or %NULL in the case that there was an error (such as a format specifier not being supported in the current locale). The string should be freed with g_free(). @@ -9163,308 +6733,204 @@ strftime() extension expected to be added to the future POSIX specification, - A #GDateTime + A #GDateTime - a valid UTF-8 string, containing the format for the + a valid UTF-8 string, containing the format for the #GDateTime - - Format @datetime in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), + + Format @datetime in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), including the date, time and time zone, and return that as a UTF-8 encoded string. Since GLib 2.66, this will output to sub-second precision if needed. - + - a newly allocated string formatted in + a newly allocated string formatted in ISO 8601 format or %NULL in the case that there was an error. The string should be freed with g_free(). - A #GDateTime + A #GDateTime - - Retrieves the day of the month represented by @datetime in the gregorian + + Retrieves the day of the month represented by @datetime in the gregorian calendar. - + - the day of the month + the day of the month - a #GDateTime + a #GDateTime - - Retrieves the ISO 8601 day of the week on which @datetime falls (1 is + + Retrieves the ISO 8601 day of the week on which @datetime falls (1 is Monday, 2 is Tuesday... 7 is Sunday). - + - the day of the week + the day of the week - a #GDateTime + a #GDateTime - - Retrieves the day of the year represented by @datetime in the Gregorian + + Retrieves the day of the year represented by @datetime in the Gregorian calendar. - + - the day of the year + the day of the year - a #GDateTime + a #GDateTime - - Retrieves the hour of the day represented by @datetime - + + Retrieves the hour of the day represented by @datetime + - the hour of the day + the hour of the day - a #GDateTime + a #GDateTime - - Retrieves the microsecond of the date represented by @datetime - + + Retrieves the microsecond of the date represented by @datetime + - the microsecond of the second + the microsecond of the second - a #GDateTime + a #GDateTime - - Retrieves the minute of the hour represented by @datetime - + + Retrieves the minute of the hour represented by @datetime + - the minute of the hour + the minute of the hour - a #GDateTime + a #GDateTime - - Retrieves the month of the year represented by @datetime in the Gregorian + + Retrieves the month of the year represented by @datetime in the Gregorian calendar. - + - the month represented by @datetime + the month represented by @datetime - a #GDateTime + a #GDateTime - - Retrieves the second of the minute represented by @datetime - + + Retrieves the second of the minute represented by @datetime + - the second represented by @datetime + the second represented by @datetime - a #GDateTime + a #GDateTime - - Retrieves the number of seconds since the start of the last minute, + + Retrieves the number of seconds since the start of the last minute, including the fractional part. - + - the number of seconds + the number of seconds - a #GDateTime + a #GDateTime - - Get the time zone for this @datetime. - + + Get the time zone for this @datetime. + - the time zone + the time zone - a #GDateTime + a #GDateTime - - Determines the time zone abbreviation to be used at the time and in + + Determines the time zone abbreviation to be used at the time and in the time zone of @datetime. For example, in Toronto this is currently "EST" during the winter months and "EDT" during the summer months when daylight savings time is in effect. - + - the time zone abbreviation. The returned + the time zone abbreviation. The returned string is owned by the #GDateTime and it should not be modified or freed - a #GDateTime + a #GDateTime - - Determines the offset to UTC in effect at the time and in the time + + Determines the offset to UTC in effect at the time and in the time zone of @datetime. The offset is the number of microseconds that you add to UTC time to @@ -9472,29 +6938,21 @@ arrive at local time for the time zone (ie: negative numbers for time zones west of GMT, positive numbers for east). If @datetime represents UTC time, then the offset is always zero. - + - the number of microseconds that should be added to UTC to + the number of microseconds that should be added to UTC to get the local time - a #GDateTime + a #GDateTime - - Returns the ISO 8601 week-numbering year in which the week containing + + Returns the ISO 8601 week-numbering year in which the week containing @datetime falls. This function, taken together with g_date_time_get_week_of_year() and @@ -9525,28 +6983,20 @@ week (Monday to Sunday). Note that January 1 0001 in the proleptic Gregorian calendar is a Monday, so this function never returns 0. - + - the ISO 8601 week-numbering year for @datetime + the ISO 8601 week-numbering year for @datetime - a #GDateTime + a #GDateTime - - Returns the ISO 8601 week number for the week containing @datetime. + + Returns the ISO 8601 week number for the week containing @datetime. The ISO 8601 week number is the same for every day of the week (from Moday through Sunday). That can produce some unusual results (described below). @@ -9561,172 +7011,121 @@ year are considered as being contained in the last week of the previous year. Similarly, the final days of a calendar year may be considered as being part of the first ISO 8601 week of the next year if 4 or more days of that week are contained within the new year. - + - the ISO 8601 week number for @datetime. + the ISO 8601 week number for @datetime. - a #GDateTime + a #GDateTime - - Retrieves the year represented by @datetime in the Gregorian calendar. - + + Retrieves the year represented by @datetime in the Gregorian calendar. + - the year represented by @datetime + the year represented by @datetime - A #GDateTime + A #GDateTime - Retrieves the Gregorian day, month, and year of a given #GDateTime. - + Retrieves the Gregorian day, month, and year of a given #GDateTime. + - a #GDateTime. + a #GDateTime. - - the return location for the gregorian year, or %NULL. + + the return location for the gregorian year, or %NULL. - - the return location for the month of the year, or %NULL. + + the return location for the month of the year, or %NULL. - - the return location for the day of the month, or %NULL. + + the return location for the day of the month, or %NULL. - - Determines if daylight savings time is in effect at the time and in -the time zone of @datetime. - + + Hashes @datetime into a #guint, suitable for use within #GHashTable. + - %TRUE if daylight savings time is in effect + a #guint containing the hash + + + + + a #GDateTime + + + + + + Determines if daylight savings time is in effect at the time and in +the time zone of @datetime. + + + %TRUE if daylight savings time is in effect - a #GDateTime + a #GDateTime - Atomically increments the reference count of @datetime by one. - + Atomically increments the reference count of @datetime by one. + - the #GDateTime with the reference count increased + the #GDateTime with the reference count increased - a #GDateTime + a #GDateTime - - Creates a new #GDateTime corresponding to the same instant in time as + + Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in the local time zone. This call is equivalent to calling g_date_time_to_timezone() with the time zone returned by g_time_zone_new_local(). - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - - Stores the instant in time that @datetime represents into @tv. + + Stores the instant in time that @datetime represents into @tv. The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the time @@ -9741,262 +7140,135 @@ out of range. On systems where 'long' is 64bit, this function never fails. #GTimeVal is not year-2038-safe. Use g_date_time_to_unix() instead. - + - %TRUE if successful, else %FALSE + %TRUE if successful, else %FALSE - a #GDateTime + a #GDateTime - a #GTimeVal to modify + a #GTimeVal to modify - - Create a new #GDateTime corresponding to the same instant in time as + + Create a new #GDateTime corresponding to the same instant in time as @datetime, but in the time zone @tz. This call can fail in the case that the time goes out of bounds. For example, converting 0001-01-01 00:00:00 UTC to a time zone west of Greenwich will fail (due to the year 0 being out of range). - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - the new #GTimeZone + the new #GTimeZone - Gives the Unix time corresponding to @datetime, rounding down to the + Gives the Unix time corresponding to @datetime, rounding down to the nearest second. Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC, regardless of the time zone associated with @datetime. - + - the Unix time corresponding to @datetime + the Unix time corresponding to @datetime - a #GDateTime + a #GDateTime - Creates a new #GDateTime corresponding to the same instant in time as + Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in UTC. This call is equivalent to calling g_date_time_to_timezone() with the time zone returned by g_time_zone_new_utc(). - + - the newly created #GDateTime which + the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL - a #GDateTime + a #GDateTime - Atomically decrements the reference count of @datetime by one. + Atomically decrements the reference count of @datetime by one. When the reference count reaches zero, the resources allocated by @datetime are freed - + - a #GDateTime + a #GDateTime - - A comparison function for #GDateTimes that is suitable -as a #GCompareFunc. Both #GDateTimes must be non-%NULL. - - - -1, 0 or 1 if @dt1 is less than, equal to or greater - than @dt2. - - - - - first #GDateTime to compare - - - - second #GDateTime to compare - - - - - - Checks to see if @dt1 and @dt2 are equal. - -Equal here means that they represent the same moment after converting -them to the same time zone. - - - %TRUE if @dt1 and @dt2 are equal - - - - - a #GDateTime - - - - a #GDateTime - - - - - - Hashes @datetime into a #guint, suitable for use within #GHashTable. - - - a #guint containing the hash - - - - - a #GDateTime - - - - - Enumeration representing a day of the week; #G_DATE_MONDAY, + Enumeration representing a day of the week; #G_DATE_MONDAY, #G_DATE_TUESDAY, etc. #G_DATE_BAD_WEEKDAY is an invalid weekday. - invalid value + invalid value - Monday + Monday - Tuesday + Tuesday - Wednesday + Wednesday - Thursday + Thursday - Friday + Friday - Saturday + Saturday - Sunday + Sunday - Associates a string with a bit flag. + Associates a string with a bit flag. Used in g_parse_debug_string(). - the string + the string @@ -10005,9 +7277,7 @@ Used in g_parse_debug_string(). - Specifies the type of function which is called when a data element + Specifies the type of function which is called when a data element is destroyed. It is passed the pointer to the data element and should free any memory and resources allocated for it. @@ -10015,43 +7285,30 @@ should free any memory and resources allocated for it. - - the data element. + + the data element. - An opaque structure representing an opened directory. + An opaque structure representing an opened directory. - Closes the directory and deallocates all related resources. + Closes the directory and deallocates all related resources. - a #GDir* created by g_dir_open() + a #GDir* created by g_dir_open() - Retrieves the name of another entry in the directory, or %NULL. + Retrieves the name of another entry in the directory, or %NULL. The order of entries returned from this function is not defined, and may vary by file system or other operating-system dependent factors. @@ -10066,26 +7323,20 @@ On Windows, as is true of all GLib functions which operate on filenames, the returned name is in UTF-8. - The entry's name or %NULL if there are no + The entry's name or %NULL if there are no more entries. The return value is owned by GLib and must not be modified or freed. - a #GDir* created by g_dir_open() + a #GDir* created by g_dir_open() - Resets the given directory. The next call to g_dir_read_name() + Resets the given directory. The next call to g_dir_read_name() will return the first entry again. @@ -10093,20 +7344,13 @@ will return the first entry again. - a #GDir* created by g_dir_open() + a #GDir* created by g_dir_open() - - Creates a subdirectory in the preferred directory for temporary + + Creates a subdirectory in the preferred directory for temporary files (as returned by g_get_tmp_dir()). @tmpl should be a string in the GLib file name encoding containing @@ -10119,74 +7363,52 @@ Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not modified, and might thus be a read-only literal string. - The actual name used. This string + The actual name used. This string should be freed with g_free() when not needed any longer and is is in the GLib file name encoding. In case of errors, %NULL is returned and @error will be set. - - Template for directory name, + + Template for directory name, as in g_mkdtemp(), basename only, or %NULL for a default template - - Opens a directory for reading. The names of the files in the + + Opens a directory for reading. The names of the files in the directory can then be retrieved using g_dir_read_name(). Note that the ordering is not defined. - a newly allocated #GDir on success, %NULL on failure. + a newly allocated #GDir on success, %NULL on failure. If non-%NULL, you must free the result with g_dir_close() when you are finished with it. - the path to the directory you are interested in. On Unix + the path to the directory you are interested in. On Unix in the on-disk encoding. On Windows in UTF-8 - Currently must be set to 0. Reserved for future use. + Currently must be set to 0. Reserved for future use. - The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign, + The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign, mantissa and exponent of IEEE floats and doubles. These unions are defined as appropriate for a given platform. IEEE floats and doubles are supported (used for storage) by at least Intel, PPC and Sparc. - the double value + the double value @@ -10206,52 +7428,33 @@ as appropriate for a given platform. IEEE floats and doubles are supported - The type of functions that are used to 'duplicate' an object. + The type of functions that are used to 'duplicate' an object. What this means depends on the context, it could just be incrementing the reference count, if @data is a ref-counted object. - a duplicate of data + a duplicate of data - - the data to duplicate + + the data to duplicate - - user data that was specified in + + user data that was specified in g_datalist_id_dup_data() - The base of natural logarithms. + The base of natural logarithms. - + @@ -10261,224 +7464,149 @@ object. - Specifies the type of a function used to test two values for + 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. - %TRUE if @a = @b; %FALSE otherwise + %TRUE if @a = @b; %FALSE otherwise - - a value + + a value - - a value to compare with + + a value to compare with - - The `GError` structure contains information about + + The `GError` structure contains information about an error that has occurred. - error domain, e.g. #G_FILE_ERROR + error domain, e.g. #G_FILE_ERROR - error code, e.g. %G_FILE_ERROR_NOENT + error code, e.g. %G_FILE_ERROR_NOENT - human-readable informative error message + human-readable informative error message - Creates a new #GError with the given @domain and @code, + Creates a new #GError with the given @domain and @code, and a message formatted with @format. - + - a new #GError + a new #GError - error domain + error domain - error code + error code - printf()-style format for error message + printf()-style format for error message - parameters for message format + parameters for message format - Creates a new #GError; unlike g_error_new(), @message is + Creates a new #GError; unlike g_error_new(), @message is not a printf()-style format string. Use this function if @message contains text you don't have control over, that could include printf() escape sequences. - + - a new #GError + a new #GError - error domain + error domain - error code + error code - error message + error message - - Creates a new #GError with the given @domain and @code, + + Creates a new #GError with the given @domain and @code, and a message formatted with @format. - + - a new #GError + a new #GError - error domain + error domain - error code + error code - printf()-style format for error message + printf()-style format for error message - #va_list of parameters for the message format + #va_list of parameters for the message format - Makes a copy of @error. - + Makes a copy of @error. + - a new #GError + a new #GError - a #GError + a #GError - Frees a #GError and associated resources. - + Frees a #GError and associated resources. + - a #GError + a #GError - Returns %TRUE if @error matches @domain and @code, %FALSE + Returns %TRUE if @error matches @domain and @code, %FALSE otherwise. In particular, when @error is %NULL, %FALSE will be returned. @@ -10488,99 +7616,197 @@ instead treat any not-explicitly-recognized error code as being equivalent to the `FAILED` code. This way, if the domain is extended in the future to provide a more specific error code for a certain case, your code will still work. - + - whether @error has @domain and @code + whether @error has @domain and @code - - a #GError + + a #GError - an error domain + an error domain - an error code + an error code + + This function registers an extended #GError domain. +@error_type_name will be duplicated. Otherwise does the same as +g_error_domain_register_static(). + + + #GQuark representing the error domain + + + + + string to create a #GQuark from + + + + size of the private error data in bytes + + + + function initializing fields of the private error data + + + + function copying fields of the private error data + + + + function freeing fields of the private error data + + + + + + This function registers an extended #GError domain. + +@error_type_name should not be freed. @error_type_private_size must +be greater than 0. + +@error_type_init receives an initialized #GError and should then initialize +the private data. + +@error_type_copy is a function that receives both original and a copy +#GError and should copy the fields of the private error data. The standard +#GError fields are already handled. + +@error_type_clear receives the pointer to the error, and it should free the +fields of the private error data. It should not free the struct itself though. + +Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it +already takes care of passing valid information to this function. + + + #GQuark representing the error domain + + + + + static string to create a #GQuark from + + + + size of the private error data in bytes + + + + function initializing fields of the private error data + + + + function copying fields of the private error data + + + + function freeing fields of the private error data + + + + + + Specifies the type of function which is called when an extended +error instance is freed. It is passed the error pointer about to be +freed, and should free the error's private data fields. + +Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it +already takes care of getting the private data from @error. + + + + + + + extended error to clear + + + + + + Specifies the type of function which is called when an extended +error instance is copied. It is passed the pointer to the +destination error and source error, and should copy only the fields +of the private data from @src_error to @dest_error. + +Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it +already takes care of getting the private data from @src_error and +@dest_error. + + + + + + + source extended error + + + + destination extended error + + + + + + Specifies the type of function which is called just after an +extended error instance is created and its fields filled. It should +only initialize the fields in the private data, which can be +received with the generated `*_get_private()` function. + +Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it +already takes care of getting the private data from @error. + + + + + + + extended error + + + + - The possible errors, used in the @v_error field + The possible errors, used in the @v_error field of #GTokenValue, when the token is a %G_TOKEN_ERROR. - unknown error + unknown error - unexpected end of file + unexpected end of file - - unterminated string constant + + unterminated string constant - - unterminated comment + + unterminated comment - - non-digit character in a number + + non-digit character in a number - digit beyond radix in a number + digit beyond radix in a number - non-decimal floating point number + non-decimal floating point number - - malformed floating point number + + malformed floating point number - - Values corresponding to @errno codes returned from file operations + + Values corresponding to @errno codes returned from file operations on UNIX. Unlike @errno codes, GFileError values are available on all systems, even Windows. The exact meaning of each code depends on what sort of file operation you were performing; the UNIX @@ -10594,127 +7820,87 @@ don't occur on some systems, etc., sometimes there are subtle differences in when a system will report a given error, etc. - Operation not permitted; only the owner of + Operation not permitted; only the owner of the file (or other resource) or processes with special privileges can perform the operation. - File is a directory; you cannot open a directory + File is a directory; you cannot open a directory for writing, or create or remove hard links to it. - Permission denied; the file permissions do not + Permission denied; the file permissions do not allow the attempted operation. - - Filename too long. + + Filename too long. - No such file or directory. This is a "file + No such file or directory. This is a "file doesn't exist" error for ordinary files that are referenced in contexts where they are expected to already exist. - A file that isn't a directory was specified when + A file that isn't a directory was specified when a directory is required. - No such device or address. The system tried to + No such device or address. The system tried to use the device represented by a file you specified, and it couldn't find the device. This can mean that the device file was installed incorrectly, or that the physical device is missing or not correctly attached to the computer. - The underlying file system of the specified file + The underlying file system of the specified file does not support memory mapping. - The directory containing the new link can't be + The directory containing the new link can't be modified because it's on a read-only file system. - Text file busy. + Text file busy. - You passed in a pointer to bad memory. + You passed in a pointer to bad memory. (GLib won't reliably return this, don't pass in pointers to bad memory.) - Too many levels of symbolic links were encountered + Too many levels of symbolic links were encountered in looking up a file name. This often indicates a cycle of symbolic links. - No space left on device; write operation on a + No space left on device; write operation on a file failed because the disk is full. - No memory available. The system cannot allocate + No memory available. The system cannot allocate more virtual memory because its capacity is full. - The current process has too many files open and + The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. - There are too many distinct file openings in the + There are too many distinct file openings in the entire system. - Bad file descriptor; for example, I/O on a + Bad file descriptor; for example, I/O on a descriptor that has been closed or reading from a descriptor open only for writing (or vice versa). - Invalid argument. This is used to indicate + Invalid argument. This is used to indicate various kinds of problems with passing the wrong argument to a library function. - Broken pipe; there is no process reading from the + Broken pipe; there is no process reading from the other end of a pipe. Every library function that returns this error code also generates a 'SIGPIPE' signal; this signal terminates the program if not handled or blocked. Thus, your @@ -10722,146 +7908,94 @@ differences in when a system will report a given error, etc. or blocked 'SIGPIPE'. - Resource temporarily unavailable; the call might + Resource temporarily unavailable; the call might work if you try again later. - Interrupted function call; an asynchronous signal + Interrupted function call; an asynchronous signal occurred and prevented completion of the call. When this happens, you should try the call again. - Input/output error; usually used for physical read + Input/output error; usually used for physical read or write errors. i.e. the disk or other physical device hardware is returning errors. - Operation not permitted; only the owner of the + Operation not permitted; only the owner of the file (or other resource) or processes with special privileges can perform the operation. - Function not implemented; this indicates that + Function not implemented; this indicates that the system is missing some functionality. - Does not correspond to a UNIX error code; this + Does not correspond to a UNIX error code; this is the standard "failed for unspecified reason" error code present in all #GError error code enumerations. Returned if no specific code applies. - - Flags to pass to g_file_set_contents_full() to affect its safety and + + Flags to pass to g_file_set_contents_full() to affect its safety and performance. - No guarantees about file consistency or durability. - The most dangerous setting, which is slightly faster than other settings. + No guarantees about file consistency or durability. + The most dangerous setting, which is slightly faster than other settings. - - Guarantee file consistency: after a crash, - either the old version of the file or the new version of the file will be - available, but not a mixture. On Unix systems this equates to an `fsync()` - on the file and use of an atomic `rename()` of the new version of the file - over the old. + + Guarantee file consistency: after a crash, + either the old version of the file or the new version of the file will be + available, but not a mixture. On Unix systems this equates to an `fsync()` + on the file and use of an atomic `rename()` of the new version of the file + over the old. - - Guarantee file durability: after a crash, the - new version of the file will be available. On Unix systems this equates to - an `fsync()` on the file (if %G_FILE_SET_CONTENTS_CONSISTENT is unset), or - the effects of %G_FILE_SET_CONTENTS_CONSISTENT plus an `fsync()` on the - directory containing the file after calling `rename()`. + + Guarantee file durability: after a crash, the + new version of the file will be available. On Unix systems this equates to + an `fsync()` on the file (if %G_FILE_SET_CONTENTS_CONSISTENT is unset), or + the effects of %G_FILE_SET_CONTENTS_CONSISTENT plus an `fsync()` on the + directory containing the file after calling `rename()`. - - Only apply consistency and durability - guarantees if the file already exists. This may speed up file operations - if the file doesn’t currently exist, but may result in a corrupted version - of the new file if the system crashes while writing it. + + Only apply consistency and durability + guarantees if the file already exists. This may speed up file operations + if the file doesn’t currently exist, but may result in a corrupted version + of the new file if the system crashes while writing it. - A test to perform on a file using g_file_test(). + A test to perform on a file using g_file_test(). - - %TRUE if the file is a regular file + + %TRUE if the file is a regular file (not a directory). Note that this test will also return %TRUE if the tested file is a symlink to a regular file. - - %TRUE if the file is a symlink. + + %TRUE if the file is a symlink. - %TRUE if the file is a directory. + %TRUE if the file is a directory. - - %TRUE if the file is executable. + + %TRUE if the file is executable. - %TRUE if the file exists. It may or may not + %TRUE if the file exists. It may or may not be a regular file. - The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign, + The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign, mantissa and exponent of IEEE floats and doubles. These unions are defined as appropriate for a given platform. IEEE floats and doubles are supported (used for storage) by at least Intel, PPC and Sparc. - the double value + the double value @@ -10878,44 +8012,28 @@ as appropriate for a given platform. IEEE floats and doubles are supported - Flags to modify the format of the string returned by g_format_size_full(). + Flags to modify the format of the string returned by g_format_size_full(). - behave the same as g_format_size() + behave the same as g_format_size() - - include the exact number of bytes as part + + include the exact number of bytes as part of the returned string. For example, "45.6 kB (45,612 bytes)". - - use IEC (base 1024) units with "KiB"-style + + use IEC (base 1024) units with "KiB"-style suffixes. IEC units should only be used for reporting things with a strong "power of 2" basis, like RAM sizes or RAID stripe sizes. Network and storage sizes should be reported in the normal SI units. - set the size as a quantity in bits, rather than - bytes, and return units in bits. For example, ‘Mb’ rather than ‘MB’. + set the size as a quantity in bits, rather than + bytes, and return units in bits. For example, ‘Mb’ rather than ‘MB’. - Declares a type of function which takes an arbitrary + Declares a type of function which takes an arbitrary data pointer argument and has no return value. It is not currently used in GLib or GTK+. @@ -10923,52 +8041,32 @@ not currently used in GLib or GTK+. - - a data pointer + + a data pointer - Specifies the type of functions passed to g_list_foreach() and + Specifies the type of functions passed to g_list_foreach() and g_slist_foreach(). - - the element's data + + the element's data - - user data passed to g_list_foreach() or g_slist_foreach() + + user data passed to g_list_foreach() or g_slist_foreach() - This is the platform dependent conversion specifier for scanning and + This is the platform dependent conversion specifier for scanning and printing values of type #gint16. It is a string literal, but doesn't include the percent-sign, such that you can add precision and length modifiers between percent-sign and conversion specifier. @@ -10983,13 +8081,8 @@ g_print ("%" G_GINT32_FORMAT, out); - - The platform dependent length modifier for conversion specifiers + + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gint16 or #guint16. It is a string literal, but doesn't include the percent-sign, such that you can add precision and length modifiers between percent-sign @@ -11004,45 +8097,30 @@ g_print ("%#" G_GINT16_MODIFIER "x", value); - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gint32. See also #G_GINT16_FORMAT. - - The platform dependent length modifier for conversion specifiers + + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gint32 or #guint32. It is a string literal. See also #G_GINT16_MODIFIER. - - This macro is used to insert 64-bit integer literals + + This macro is used to insert 64-bit integer literals into the source code. - a literal integer value, e.g. 0x1d636b02300a7aa7 + a literal integer value, e.g. 0x1d636b02300a7aa7 - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gint64. See also #G_GINT16_FORMAT. Some platforms do not support scanning and printing 64-bit integers, @@ -11054,13 +8132,8 @@ instead. - - The platform dependent length modifier for conversion specifiers + + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gint64 or #guint64. It is a string literal. @@ -11070,36 +8143,21 @@ is not defined. - - This is the platform dependent conversion specifier for scanning + + This is the platform dependent conversion specifier for scanning and printing values of type #gintptr. - - The platform dependent length modifier for conversion specifiers + + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gintptr or #guintptr. It is a string literal. - - Expands to the GNU C `alloc_size` function attribute if the compiler + + Expands to the GNU C `alloc_size` function attribute if the compiler is a new enough gcc. This attribute tells the compiler that the function returns a pointer to memory of a size that is specified by the @xth function parameter. @@ -11112,22 +8170,15 @@ gpointer g_malloc (gsize n_bytes) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1); ]| See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-alloc_005fsize-function-attribute) for more details. - + - the index of the argument specifying the allocation size + the index of the argument specifying the allocation size - - Expands to the GNU C `alloc_size` function attribute if the compiler is a + + Expands to the GNU C `alloc_size` function attribute if the compiler is a new enough gcc. This attribute tells the compiler that the function returns a pointer to memory of a size that is specified by the product of two function parameters. @@ -11141,27 +8192,18 @@ gpointer g_malloc_n (gsize n_blocks, ]| See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-alloc_005fsize-function-attribute) for more details. - + - the index of the argument specifying one factor of the allocation size + the index of the argument specifying one factor of the allocation size - the index of the argument specifying the second factor of the allocation size + the index of the argument specifying the second factor of the allocation size - - Expands to a check for a compiler with __GNUC__ defined and a version + + Expands to a check for a compiler with __GNUC__ defined and a version greater than or equal to the major and minor numbers provided. For example, the following would only match on compilers such as GCC 4.8 or newer. @@ -11169,27 +8211,18 @@ the following would only match on compilers such as GCC 4.8 or newer. #if G_GNUC_CHECK_VERSION(4, 8) #endif ]| - + - major version to check against + major version to check against - minor version to check against + minor version to check against - - Like %G_GNUC_DEPRECATED, but names the intended replacement for the + + Like %G_GNUC_DEPRECATED, but names the intended replacement for the deprecated symbol if the version of gcc in use is new enough to support custom deprecation messages. @@ -11204,22 +8237,16 @@ See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function Note that if @f is a macro, it will be expanded in the warning message. You can enclose it in quotes to prevent this. (The quotes will show up in the warning, but it's better than showing the macro expansion.) - + - the intended replacement for the deprecated symbol, + the intended replacement for the deprecated symbol, such as the name of a function - - Expands to the GNU C `format_arg` function attribute if the compiler + + Expands to the GNU C `format_arg` function attribute if the compiler is gcc. This function attribute specifies that a function takes a format string for a `printf()`, `scanf()`, `strftime()` or `strfmon()` style function and modifies it, so that the result can be passed to a `printf()`, @@ -11235,47 +8262,29 @@ See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function |[<!-- language="C" --> gchar *g_dgettext (gchar *domain_name, gchar *msgid) G_GNUC_FORMAT (2); ]| - + - the index of the argument + the index of the argument - - Expands to "" on all modern compilers, and to __FUNCTION__ on gcc + + Expands to "" on all modern compilers, and to __FUNCTION__ on gcc version 2.x. Don't use it. Use G_STRFUNC() instead - + - - Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__ + + Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__ on gcc version 2.x. Don't use it. Use G_STRFUNC() instead - + - - Expands to the GNU C `format` function attribute if the compiler is gcc. + + Expands to the GNU C `format` function attribute if the compiler is gcc. This is used for declaring functions which take a variable number of arguments, with the same syntax as `printf()`. It allows the compiler to type-check the arguments passed to the function. @@ -11293,28 +8302,20 @@ gint g_snprintf (gchar *string, gchar const *format, ...) G_GNUC_PRINTF (3, 4); ]| - + - the index of the argument corresponding to the + the index of the argument corresponding to the format string (the arguments are numbered from 1) - the index of the first of the format arguments, or 0 if + the index of the first of the format arguments, or 0 if there are no format arguments - - Expands to the GNU C `format` function attribute if the compiler is gcc. + + Expands to the GNU C `format` function attribute if the compiler is gcc. This is used for declaring functions which take a variable number of arguments, with the same syntax as `scanf()`. It allows the compiler to type-check the arguments passed to the function. @@ -11331,29 +8332,20 @@ int my_vscanf (MyStream *stream, See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288) for details. - + - the index of the argument corresponding to + the index of the argument corresponding to the format string (the arguments are numbered from 1) - the index of the first of the format arguments, or 0 if + the index of the first of the format arguments, or 0 if there are no format arguments - - Expands to the GNU C `strftime` format function attribute if the compiler + + Expands to the GNU C `strftime` format function attribute if the compiler is gcc. This is used for declaring functions which take a format argument which is passed to `strftime()` or an API implementing its formats. It allows the compiler check the format passed to the function. @@ -11367,118 +8359,76 @@ gsize my_strftime (MyBuffer *buffer, See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288) for details. - + - the index of the argument corresponding to + the index of the argument corresponding to the format string (the arguments are numbered from 1) - - This macro is used to insert #goffset 64-bit integer literals + + This macro is used to insert #goffset 64-bit integer literals into the source code. See also #G_GINT64_CONSTANT. - a literal integer value, e.g. 0x1d636b02300a7aa7 + a literal integer value, e.g. 0x1d636b02300a7aa7 - - This is the platform dependent conversion specifier for scanning + + This is the platform dependent conversion specifier for scanning and printing values of type #gsize. See also #G_GINT16_FORMAT. - - The platform dependent length modifier for conversion specifiers + + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gsize. It is a string literal. - - This is the platform dependent conversion specifier for scanning + + This is the platform dependent conversion specifier for scanning and printing values of type #gssize. See also #G_GINT16_FORMAT. - - The platform dependent length modifier for conversion specifiers + + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gssize. It is a string literal. - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #guint16. See also #G_GINT16_FORMAT - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #guint32. See also #G_GINT16_FORMAT. - - This macro is used to insert 64-bit unsigned integer + + This macro is used to insert 64-bit unsigned integer literals into the source code. - a literal integer value, e.g. 0x1d636b02300a7aa7U + a literal integer value, e.g. 0x1d636b02300a7aa7U - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #guint64. See also #G_GINT16_FORMAT. Some platforms do not support scanning and printing 64-bit integers, @@ -11490,13 +8440,8 @@ instead. - - This is the platform dependent conversion specifier + + This is the platform dependent conversion specifier for scanning and printing values of type #guintptr. @@ -11509,18 +8454,12 @@ for scanning and printing values of type #guintptr. - - Defined to 1 if gcc-style visibility handling is supported. + + Defined to 1 if gcc-style visibility handling is supported. - + @@ -11529,9 +8468,7 @@ for scanning and printing values of type #guintptr. - Specifies the type of the function passed to g_hash_table_foreach(). + Specifies the type of the function passed to g_hash_table_foreach(). It is called with each key/value pair, together with the @user_data parameter which is passed to g_hash_table_foreach(). @@ -11539,189 +8476,113 @@ parameter which is passed to g_hash_table_foreach(). - - a key + + a key - - the value corresponding to the key + + the value corresponding to the key - - user data passed to g_hash_table_foreach() + + user data passed to g_hash_table_foreach() - Casts a pointer to a `GHook*`. + Casts a pointer to a `GHook*`. - a pointer + a pointer - - Returns %TRUE if the #GHook is active, which is normally the case + + Returns %TRUE if the #GHook is active, which is normally the case until the #GHook is destroyed. - a #GHook + a #GHook - - Gets the flags of a hook. + + Gets the flags of a hook. - a #GHook + a #GHook - - The position of the first bit which is not reserved for internal + + The position of the first bit which is not reserved for internal use be the #GHook implementation, i.e. `1 << G_HOOK_FLAG_USER_SHIFT` is the first bit which can be used for application-defined flags. - - Returns %TRUE if the #GHook function is currently executing. + + Returns %TRUE if the #GHook function is currently executing. - a #GHook + a #GHook - - Returns %TRUE if the #GHook is not in a #GHookList. + + Returns %TRUE if the #GHook is not in a #GHookList. - a #GHook + a #GHook - - Returns %TRUE if the #GHook is valid, i.e. it is in a #GHookList, + + Returns %TRUE if the #GHook is valid, i.e. it is in a #GHookList, it is active and it has not been destroyed. - a #GHook + a #GHook - Specifies the type of the function passed to + Specifies the type of the function passed to g_hash_table_foreach_remove(). It is called with each key/value pair, together with the @user_data parameter passed to g_hash_table_foreach_remove(). It should return %TRUE if the key/value pair should be removed from the #GHashTable. - %TRUE if the key/value pair should be removed from the + %TRUE if the key/value pair should be removed from the #GHashTable - - a key + + a key - - the value associated with the key + + the value associated with the key - - user data passed to g_hash_table_remove() + + user data passed to g_hash_table_remove() - Specifies the type of the hash function which is passed to + Specifies the type of the hash function which is passed to g_hash_table_new() when a #GHashTable is created. The function is passed a key and should return a #guint hash value. @@ -11753,38 +8614,23 @@ remainder is taken modulo a somewhat predictable prime number. There must be an element of randomness that an attacker is unable to guess. - the hash value corresponding to the key + the hash value corresponding to the key - - a key + + a key - - The #GHashTable struct is an opaque data structure to represent a + + The #GHashTable struct is an opaque data structure to represent a [Hash Table][glib-Hash-Tables]. It should only be accessed via the following functions. - This is a convenience function for using a #GHashTable as a set. It + This is a convenience function for using a #GHashTable as a set. It is equivalent to calling g_hash_table_replace() with @key as both the key and the value. @@ -11801,70 +8647,46 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - - a key to insert + + a key to insert - - Checks if @key is in @hash_table. + + Checks if @key is in @hash_table. - %TRUE if @key is in @hash_table, %FALSE otherwise. + %TRUE if @key is in @hash_table, %FALSE otherwise. - a #GHashTable + a #GHashTable - - a key to check + + a key to check - Destroys all keys and values in the #GHashTable and decrements its + Destroys all keys and values in the #GHashTable and decrements its reference count by 1. If keys and/or values are dynamically allocated, you should either free them first or create the #GHashTable with destroy notifiers using g_hash_table_new_full(). In the latter case the destroy @@ -11876,9 +8698,7 @@ destruction phase. - a #GHashTable + a #GHashTable @@ -11886,13 +8706,8 @@ destruction phase. - - Calls the given function for key/value pairs in the #GHashTable + + Calls the given function for key/value pairs in the #GHashTable until @predicate returns %TRUE. The function is passed the key and value of each pair, and the given @user_data parameter. The hash table may not be modified while iterating over it (you can't @@ -11907,46 +8722,31 @@ to use additional or different data structures for reverse lookups values in a hash table ends up needing O(n*n) operations). - The value of the first key/value pair is returned, + The value of the first key/value pair is returned, for which @predicate evaluates to %TRUE. If no pair with the requested property is found, %NULL is returned. - a #GHashTable + a #GHashTable - function to test the key/value pairs for a certain property + function to test the key/value pairs for a certain property - - user data to pass to the function + + user data to pass to the function - - Calls the given function for each of the key/value pairs in the + + Calls the given function for each of the key/value pairs in the #GHashTable. The function is passed the key and value of each pair, and the given @user_data parameter. The hash table may not be modified while iterating over it (you can't add/remove @@ -11964,37 +8764,24 @@ order searches in contrast to g_hash_table_lookup(). - a #GHashTable + a #GHashTable - the function to call for each key/value pair + the function to call for each key/value pair - - user data to pass to the function + + user data to pass to the function - - Calls the given function for each key/value pair in the + + Calls the given function for each key/value pair in the #GHashTable. If the function returns %TRUE, then the key/value pair is removed from the #GHashTable. If you supplied key or value destroy functions when creating the #GHashTable, they are @@ -12004,44 +8791,29 @@ See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table. - the number of key/value pairs removed + the number of key/value pairs removed - a #GHashTable + a #GHashTable - the function to call for each key/value pair + the function to call for each key/value pair - - user data to pass to the function + + user data to pass to the function - - Calls the given function for each key/value pair in the + + Calls the given function for each key/value pair in the #GHashTable. If the function returns %TRUE, then the key/value pair is removed from the #GHashTable, but no key or value destroy functions are called. @@ -12050,45 +8822,29 @@ See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table. - the number of key/value pairs removed. + the number of key/value pairs removed. - a #GHashTable + a #GHashTable - the function to call for each key/value pair + the function to call for each key/value pair - - user data to pass to the function + + user data to pass to the function - - Retrieves every key inside @hash_table. The returned data is valid + + Retrieves every key inside @hash_table. The returned data is valid until changes to the hash release those keys. This iterates over every entry in the hash table to build its return value. @@ -12096,9 +8852,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a #GHashTableIter. - a #GList containing all the keys + a #GList containing all the keys inside the hash table. The content of the list is owned by the hash table and should not be modified or freed. Use g_list_free() when done using the list. @@ -12108,9 +8862,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - a #GHashTable + a #GHashTable @@ -12118,13 +8870,8 @@ To iterate over the entries in a #GHashTable more efficiently, use a - - Retrieves every key inside @hash_table, as an array. + + Retrieves every key inside @hash_table, as an array. The returned array is %NULL-terminated but may contain %NULL as a key. Use @length to determine the true length if it's possible that @@ -12143,9 +8890,7 @@ appropriate to use g_strfreev() if you call g_hash_table_steal_all() first to transfer ownership of the keys. - a + a %NULL-terminated array containing each key from the table. @@ -12153,32 +8898,20 @@ first to transfer ownership of the keys. - a #GHashTable + a #GHashTable - - the length of the returned array + + the length of the returned array - - Retrieves every value inside @hash_table. The returned data + + Retrieves every value inside @hash_table. The returned data is valid until @hash_table is modified. This iterates over every entry in the hash table to build its return value. @@ -12186,9 +8919,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a #GHashTableIter. - a #GList containing all the values + a #GList containing all the values inside the hash table. The content of the list is owned by the hash table and should not be modified or freed. Use g_list_free() when done using the list. @@ -12198,9 +8929,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - a #GHashTable + a #GHashTable @@ -12209,9 +8938,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - Inserts a new key and value into a #GHashTable. + Inserts a new key and value into a #GHashTable. If the key already exists in the #GHashTable its current value is replaced with the new value. If you supplied a @@ -12225,81 +8952,53 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - - a key to insert + + a key to insert - - the value to associate with the key + + the value to associate with the key - Looks up a key in a #GHashTable. Note that this function cannot + Looks up a key in a #GHashTable. Note that this function cannot distinguish between a key that is not present and one which is present and has the value %NULL. If you need this distinction, use g_hash_table_lookup_extended(). - the associated value, or %NULL if the key is not found + the associated value, or %NULL if the key is not found - a #GHashTable + a #GHashTable - - the key to look up + + the key to look up - - Looks up a key in the #GHashTable, returning the original key and the + + Looks up a key in the #GHashTable, returning the original key and the associated value and a #gboolean which is %TRUE if the key was found. This is useful if you need to free the memory allocated for the original key, for example before calling g_hash_table_remove(). @@ -12309,61 +9008,34 @@ whether the %NULL key exists, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - - the key to look up + + the key to look up - - return location for the original key + + return location for the original key - - return location for the value associated + + return location for the value associated with the key - Creates a new #GHashTable with a reference count of 1. + Creates a new #GHashTable with a reference count of 1. Hash values returned by @hash_func are used to determine where keys are stored within the #GHashTable data structure. The g_direct_hash(), @@ -12381,9 +9053,7 @@ as its first parameter, and the user-provided key to check against as its second. - a new #GHashTable + a new #GHashTable @@ -12391,25 +9061,17 @@ its second. - a function to create a hash value from a key + a function to create a hash value from a key - a function to check two keys for equality + a function to check two keys for equality - - Creates a new #GHashTable like g_hash_table_new() with a reference + + Creates a new #GHashTable like g_hash_table_new() with a reference count of 1 and allows to specify functions to free the memory allocated for the key and value that get called when removing the entry from the #GHashTable. @@ -12422,9 +9084,7 @@ calling g_hash_table_remove_all() before releasing the last reference using g_hash_table_unref(). - a new #GHashTable + a new #GHashTable @@ -12432,59 +9092,33 @@ g_hash_table_unref(). - a function to create a hash value from a key + a function to create a hash value from a key - - a function to check two keys for equality + + a function to check two keys for equality - - a function to free the memory allocated for the key + + a function to free the memory allocated for the key used when removing the entry from the #GHashTable, or %NULL if you don't want to supply such a function. - - a function to free the memory allocated for the + + a function to free the memory allocated for the value used when removing the entry from the #GHashTable, or %NULL if you don't want to supply such a function. - - Atomically increments the reference count of @hash_table by one. + + Atomically increments the reference count of @hash_table by one. This function is MT-safe and may be called from any thread. - the passed in #GHashTable + the passed in #GHashTable @@ -12492,9 +9126,7 @@ This function is MT-safe and may be called from any thread. - a valid #GHashTable + a valid #GHashTable @@ -12503,9 +9135,7 @@ This function is MT-safe and may be called from any thread. - Removes a key and its associated value from a #GHashTable. + Removes a key and its associated value from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise @@ -12513,38 +9143,25 @@ you have to make sure that any dynamically allocated values are freed yourself. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - - the key to remove + + the key to remove - - Removes all keys and their associated values from a #GHashTable. + + Removes all keys and their associated values from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the keys and values are freed using the supplied destroy functions, @@ -12556,9 +9173,7 @@ values are freed yourself. - a #GHashTable + a #GHashTable @@ -12567,9 +9182,7 @@ values are freed yourself. - Inserts a new key and value into a #GHashTable similar to + Inserts a new key and value into a #GHashTable similar to g_hash_table_insert(). The difference is that if the key already exists in the #GHashTable, it gets replaced by the new key. If you supplied a @value_destroy_func when creating @@ -12582,57 +9195,37 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - - a key to insert + + a key to insert - - the value to associate with the key + + the value to associate with the key - Returns the number of elements contained in the #GHashTable. + Returns the number of elements contained in the #GHashTable. - the number of key/value pairs in the #GHashTable. + the number of key/value pairs in the #GHashTable. - a #GHashTable + a #GHashTable @@ -12641,44 +9234,29 @@ or not. - Removes a key and its associated value from a #GHashTable without + Removes a key and its associated value from a #GHashTable without calling the key and value destroy functions. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - - the key to remove + + the key to remove - - Removes all keys and their associated values from a #GHashTable + + Removes all keys and their associated values from a #GHashTable without calling the key and value destroy functions. @@ -12686,9 +9264,7 @@ without calling the key and value destroy functions. - a #GHashTable + a #GHashTable @@ -12696,12 +9272,8 @@ without calling the key and value destroy functions. - - Looks up a key in the #GHashTable, stealing the original key and the + + Looks up a key in the #GHashTable, stealing the original key and the associated value and returning %TRUE if the key was found. If the key was not found, %FALSE is returned. @@ -12713,62 +9285,35 @@ You can pass %NULL for @lookup_key, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - - the key to look up + + the key to look up - - return location for the + + return location for the original key - - return location + + return location for the value associated with the key - Atomically decrements the reference count of @hash_table by one. + Atomically decrements the reference count of @hash_table by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. @@ -12778,9 +9323,7 @@ This function is MT-safe and may be called from any thread. - a valid #GHashTable + a valid #GHashTable @@ -12790,9 +9333,7 @@ This function is MT-safe and may be called from any thread. - A GHashTableIter structure represents an iterator that can be used + A GHashTableIter structure represents an iterator that can be used to iterate over the elements of a #GHashTable. GHashTableIter structures are typically allocated on the stack and then initialized with g_hash_table_iter_init(). @@ -12818,18 +9359,11 @@ table is not defined. - - Returns the #GHashTable associated with @iter. + + Returns the #GHashTable associated with @iter. - the #GHashTable associated with @iter. + the #GHashTable associated with @iter. @@ -12837,17 +9371,13 @@ table is not defined. - an initialized #GHashTableIter + an initialized #GHashTableIter - Initializes a key/value pair iterator and associates it with + Initializes a key/value pair iterator and associates it with @hash_table. Modifying the hash table after calling this function invalidates the returned iterator. @@ -12870,15 +9400,11 @@ while (g_hash_table_iter_next (&iter, &key, &value)) - an uninitialized #GHashTableIter + an uninitialized #GHashTableIter - a #GHashTable + a #GHashTable @@ -12887,57 +9413,31 @@ while (g_hash_table_iter_next (&iter, &key, &value)) - Advances @iter and retrieves the key and/or value that are now + Advances @iter and retrieves the key and/or value that are now pointed to as a result of this advancement. If %FALSE is returned, @key and @value are not set, and the iterator becomes invalid. - %FALSE if the end of the #GHashTable has been reached. + %FALSE if the end of the #GHashTable has been reached. - an initialized #GHashTableIter + an initialized #GHashTableIter - - a location to store the key + + a location to store the key - - a location to store the value + + a location to store the value - - Removes the key/value pair currently pointed to by the iterator + + Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned %TRUE, and cannot be called more than once for the same key/value pair. @@ -12961,19 +9461,13 @@ while (g_hash_table_iter_next (&iter, &key, &value)) - an initialized #GHashTableIter + an initialized #GHashTableIter - - Replaces the value currently pointed to by the iterator + + Replaces the value currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned %TRUE. @@ -12985,28 +9479,17 @@ If you supplied a @value_destroy_func when creating the - an initialized #GHashTableIter + an initialized #GHashTableIter - - the value to replace with + + the value to replace with - - Removes the key/value pair currently pointed to by the + + Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable, without calling the key and value destroy functions. Can only be called after g_hash_table_iter_next() returned %TRUE, and cannot @@ -13017,53 +9500,36 @@ be called more than once for the same key/value pair. - an initialized #GHashTableIter + an initialized #GHashTableIter - An opaque structure representing a HMAC operation. + An opaque structure representing a HMAC operation. To create a new GHmac, use g_hmac_new(). To free a GHmac, use g_hmac_unref(). - - Copies a #GHmac. If @hmac has been closed, by calling + + Copies a #GHmac. If @hmac has been closed, by calling g_hmac_get_string() or g_hmac_get_digest(), the copied HMAC will be closed as well. - the copy of the passed #GHmac. Use g_hmac_unref() + the copy of the passed #GHmac. Use g_hmac_unref() when finished using it. - the #GHmac to copy + the #GHmac to copy - - Gets the digest from @checksum as a raw binary array and places it + + Gets the digest from @checksum as a raw binary array and places it into @buffer. The size of the digest depends on the type of checksum. Once this function has been called, the #GHmac is closed and can @@ -13074,37 +9540,24 @@ no longer be updated with g_checksum_update(). - a #GHmac + a #GHmac - output buffer + output buffer - - an inout parameter. The caller initializes it to the + + an inout parameter. The caller initializes it to the size of @buffer. After the call it contains the length of the digest - - Gets the HMAC as a hexadecimal string. + + Gets the HMAC as a hexadecimal string. Once this function has been called the #GHmac can no longer be updated with g_hmac_update(). @@ -13112,51 +9565,36 @@ updated with g_hmac_update(). The hexadecimal characters will be lower case. - the hexadecimal representation of the HMAC. The + the hexadecimal representation of the HMAC. The returned string is owned by the HMAC and should not be modified or freed. - a #GHmac + a #GHmac - - Atomically increments the reference count of @hmac by one. + + Atomically increments the reference count of @hmac by one. This function is MT-safe and may be called from any thread. - the passed in #GHmac. + the passed in #GHmac. - a valid #GHmac + a valid #GHmac - Atomically decrements the reference count of @hmac by one. + Atomically decrements the reference count of @hmac by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. @@ -13168,17 +9606,13 @@ Frees the memory allocated for @hmac. - a #GHmac + a #GHmac - Feeds @data into an existing #GHmac. + Feeds @data into an existing #GHmac. The HMAC must still be open, that is g_hmac_get_string() or g_hmac_get_digest() must not have been called on @hmac. @@ -13188,34 +9622,23 @@ g_hmac_get_digest() must not have been called on @hmac. - a #GHmac + a #GHmac - buffer used to compute the checksum + buffer used to compute the checksum - size of the buffer, or -1 if it is a nul-terminated string + size of the buffer, or -1 if it is a nul-terminated string - - Creates a new #GHmac, using the digest algorithm @digest_type. + + Creates a new #GHmac, using the digest algorithm @digest_type. If the @digest_type is not known, %NULL is returned. A #GHmac can be used to compute the HMAC of a key and an arbitrary binary blob, using different hashing algorithms. @@ -13233,169 +9656,119 @@ Support for digests of type %G_CHECKSUM_SHA512 has been added in GLib 2.42. Support for %G_CHECKSUM_SHA384 was added in GLib 2.52. - the newly created #GHmac, or %NULL. + the newly created #GHmac, or %NULL. Use g_hmac_unref() to free the memory allocated by it. - the desired type of digest + the desired type of digest - the key for the HMAC + the key for the HMAC - the length of the keys + the length of the keys - The #GHook struct represents a single hook function in a #GHookList. + The #GHook struct represents a single hook function in a #GHookList. - data which is passed to func when this hook is invoked + data which is passed to func when this hook is invoked - pointer to the next hook in the list + pointer to the next hook in the list - pointer to the previous hook in the list + pointer to the previous hook in the list - the reference count of this hook + the reference count of this hook - the id of this hook, which is unique within its list + the id of this hook, which is unique within its list - flags which are set for this hook. See #GHookFlagMask for + flags which are set for this hook. See #GHookFlagMask for predefined flags - the function to call when this hook is invoked. The possible + the function to call when this hook is invoked. The possible signatures for this function are #GHookFunc and #GHookCheckFunc - the default @finalize_hook function of a #GHookList calls + the default @finalize_hook function of a #GHookList calls this member of the hook that is being finalized - Compares the ids of two #GHook elements, returning a negative value + Compares the ids of two #GHook elements, returning a negative value if the second id is greater than the first. - a value <= 0 if the id of @sibling is >= the id of @new_hook + a value <= 0 if the id of @sibling is >= the id of @new_hook - a #GHook + a #GHook - a #GHook to compare with @new_hook + a #GHook to compare with @new_hook - Allocates space for a #GHook and initializes it. + Allocates space for a #GHook and initializes it. - a new #GHook + a new #GHook - a #GHookList + a #GHookList - Destroys a #GHook, given its ID. + Destroys a #GHook, given its ID. - %TRUE if the #GHook was found in the #GHookList and destroyed + %TRUE if the #GHook was found in the #GHookList and destroyed - a #GHookList + a #GHookList - a hook ID + a hook ID - Removes one #GHook from a #GHookList, marking it + Removes one #GHook from a #GHookList, marking it inactive and calling g_hook_unref() on it. @@ -13403,213 +9776,137 @@ inactive and calling g_hook_unref() on it. - a #GHookList + a #GHookList - the #GHook to remove + the #GHook to remove - Finds a #GHook in a #GHookList using the given function to + Finds a #GHook in a #GHookList using the given function to test for a match. - the found #GHook or %NULL if no matching #GHook is found + the found #GHook or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - the function to call for each #GHook, which should return + the function to call for each #GHook, which should return %TRUE when the #GHook has been found - - the data to pass to @func + + the data to pass to @func - - Finds a #GHook in a #GHookList with the given data. + + Finds a #GHook in a #GHookList with the given data. - the #GHook with the given @data or %NULL if no matching + the #GHook with the given @data or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - - the data to find + + the data to find - - Finds a #GHook in a #GHookList with the given function. + + Finds a #GHook in a #GHookList with the given function. - the #GHook with the given @func or %NULL if no matching + the #GHook with the given @func or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - - the function to find + + the function to find - - Finds a #GHook in a #GHookList with the given function and data. + + Finds a #GHook in a #GHookList with the given function and data. - the #GHook with the given @func and @data or %NULL if + the #GHook with the given @func and @data or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - the function to find + the function to find - - the data to find + + the data to find - - Returns the first #GHook in a #GHookList which has not been destroyed. + + Returns the first #GHook in a #GHookList which has not been destroyed. The reference count for the #GHook is incremented, so you must call g_hook_unref() to restore it when no longer needed. (Or call g_hook_next_valid() if you are stepping through the #GHookList.) - the first valid #GHook, or %NULL if none are valid + the first valid #GHook, or %NULL if none are valid - a #GHookList + a #GHookList - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped @@ -13617,9 +9914,7 @@ g_hook_next_valid() if you are stepping through the #GHookList.) - Calls the #GHookList @finalize_hook function if it exists, + Calls the #GHookList @finalize_hook function if it exists, and frees the memory allocated for the #GHook. @@ -13627,141 +9922,96 @@ and frees the memory allocated for the #GHook. - a #GHookList + a #GHookList - the #GHook to free + the #GHook to free - Returns the #GHook with the given id, or %NULL if it is not found. + Returns the #GHook with the given id, or %NULL if it is not found. - the #GHook with the given id, or %NULL if it is not found + the #GHook with the given id, or %NULL if it is not found - a #GHookList + a #GHookList - a hook id + a hook id - Inserts a #GHook into a #GHookList, before a given #GHook. + Inserts a #GHook into a #GHookList, before a given #GHook. - a #GHookList + a #GHookList - - the #GHook to insert the new #GHook before + + the #GHook to insert the new #GHook before - the #GHook to insert + the #GHook to insert - - Inserts a #GHook into a #GHookList, sorted by the given function. + + Inserts a #GHook into a #GHookList, sorted by the given function. - a #GHookList + a #GHookList - the #GHook to insert + the #GHook to insert - the comparison function used to sort the #GHook elements + the comparison function used to sort the #GHook elements - - Returns the next #GHook in a #GHookList which has not been destroyed. + + Returns the next #GHook in a #GHookList which has not been destroyed. The reference count for the #GHook is incremented, so you must call g_hook_unref() to restore it when no longer needed. (Or continue to call g_hook_next_valid() until %NULL is returned.) - the next valid #GHook, or %NULL if none are valid + the next valid #GHook, or %NULL if none are valid - a #GHookList + a #GHookList - the current #GHook + the current #GHook - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped @@ -13769,58 +10019,42 @@ g_hook_next_valid() until %NULL is returned.) - Prepends a #GHook on the start of a #GHookList. + Prepends a #GHook on the start of a #GHookList. - a #GHookList + a #GHookList - the #GHook to add to the start of @hook_list + the #GHook to add to the start of @hook_list - Increments the reference count for a #GHook. + Increments the reference count for a #GHook. - the @hook that was passed in (since 2.6) + the @hook that was passed in (since 2.6) - a #GHookList + a #GHookList - the #GHook to increment the reference count of + the #GHook to increment the reference count of - Decrements the reference count of a #GHook. + Decrements the reference count of a #GHook. If the reference count falls to 0, the #GHook is removed from the #GHookList and g_hook_free() is called to free it. @@ -13829,104 +10063,70 @@ from the #GHookList and g_hook_free() is called to free it. - a #GHookList + a #GHookList - the #GHook to unref + the #GHook to unref - Defines the type of a hook function that can be invoked + Defines the type of a hook function that can be invoked by g_hook_list_invoke_check(). - %FALSE if the #GHook should be destroyed + %FALSE if the #GHook should be destroyed - - the data field of the #GHook is passed to the hook function here + + the data field of the #GHook is passed to the hook function here - Defines the type of function used by g_hook_list_marshal_check(). + Defines the type of function used by g_hook_list_marshal_check(). - %FALSE if @hook should be destroyed + %FALSE if @hook should be destroyed - a #GHook + a #GHook - - user data + + user data - Defines the type of function used to compare #GHook elements in + Defines the type of function used to compare #GHook elements in g_hook_insert_sorted(). - a value <= 0 if @new_hook should be before @sibling + a value <= 0 if @new_hook should be before @sibling - the #GHook being inserted + the #GHook being inserted - the #GHook to compare with @new_hook + the #GHook to compare with @new_hook - Defines the type of function to be called when a hook in a + Defines the type of function to be called when a hook in a list of hooks gets finalized. @@ -13934,158 +10134,110 @@ list of hooks gets finalized. - a #GHookList + a #GHookList - the hook in @hook_list that gets finalized + the hook in @hook_list that gets finalized - Defines the type of the function passed to g_hook_find(). + Defines the type of the function passed to g_hook_find(). - %TRUE if the required #GHook has been found + %TRUE if the required #GHook has been found - a #GHook + a #GHook - - user data passed to g_hook_find_func() + + user data passed to g_hook_find_func() - Flags used internally in the #GHook implementation. + Flags used internally in the #GHook implementation. - set if the hook has not been destroyed + set if the hook has not been destroyed - set if the hook is currently being run + set if the hook is currently being run - A mask covering all bits reserved for + A mask covering all bits reserved for hook flags; see %G_HOOK_FLAG_USER_SHIFT - Defines the type of a hook function that can be invoked + Defines the type of a hook function that can be invoked by g_hook_list_invoke(). - - the data field of the #GHook is passed to the hook function here + + the data field of the #GHook is passed to the hook function here - The #GHookList struct represents a list of hook functions. + The #GHookList struct represents a list of hook functions. - the next free #GHook id + the next free #GHook id - the size of the #GHookList elements, in bytes + the size of the #GHookList elements, in bytes - 1 if the #GHookList has been initialized + 1 if the #GHookList has been initialized - the first #GHook element in the list + the first #GHook element in the list - unused + unused - the function to call to finalize a #GHook element. + the function to call to finalize a #GHook element. The default behaviour is to call the hooks @destroy function - unused + unused - Removes all the #GHook elements from a #GHookList. + Removes all the #GHook elements from a #GHookList. - a #GHookList + a #GHookList - Initializes a #GHookList. + Initializes a #GHookList. This must be called before the #GHookList is used. @@ -14093,39 +10245,29 @@ This must be called before the #GHookList is used. - a #GHookList + a #GHookList - the size of each element in the #GHookList, + the size of each element in the #GHookList, typically `sizeof (GHook)`. - Calls all of the #GHook functions in a #GHookList. + Calls all of the #GHook functions in a #GHookList. - a #GHookList + a #GHookList - %TRUE if functions which are already running + %TRUE if functions which are already running (e.g. in another thread) can be called. If set to %FALSE, these are skipped @@ -14133,9 +10275,7 @@ This must be called before the #GHookList is used. - Calls all of the #GHook functions in a #GHookList. + Calls all of the #GHook functions in a #GHookList. Any function which returns %FALSE is removed from the #GHookList. @@ -14143,69 +10283,46 @@ Any function which returns %FALSE is removed from the #GHookList. - a #GHookList + a #GHookList - %TRUE if functions which are already running + %TRUE if functions which are already running (e.g. in another thread) can be called. If set to %FALSE, these are skipped - - Calls a function on each valid #GHook. + + Calls a function on each valid #GHook. - a #GHookList + a #GHookList - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped - the function to call for each #GHook + the function to call for each #GHook - - data to pass to @marshaller + + data to pass to @marshaller - - Calls a function on each valid #GHook and destroys it if the + + Calls a function on each valid #GHook and destroys it if the function returns %FALSE. @@ -14213,76 +10330,49 @@ function returns %FALSE. - a #GHookList + a #GHookList - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped - the function to call for each #GHook + the function to call for each #GHook - - data to pass to @marshaller + + data to pass to @marshaller - Defines the type of function used by g_hook_list_marshal(). + Defines the type of function used by g_hook_list_marshal(). - a #GHook + a #GHook - - user data + + user data - The GIConv struct wraps an iconv() conversion descriptor. It contains + The GIConv struct wraps an iconv() conversion descriptor. It contains private data and should only be accessed using the following functions. - - Same as the standard UNIX routine iconv(), but + + Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -14297,48 +10387,34 @@ used), or it may return -1 and set an error such as %EILSEQ, in such a situation. - count of non-reversible conversions, or -1 on error + count of non-reversible conversions, or -1 on error - conversion descriptor from g_iconv_open() + conversion descriptor from g_iconv_open() - bytes to convert + bytes to convert - inout parameter, bytes remaining to convert in @inbuf + inout parameter, bytes remaining to convert in @inbuf - converted output bytes + converted output bytes - inout parameter, bytes available to fill in @outbuf + inout parameter, bytes available to fill in @outbuf - Same as the standard UNIX routine iconv_close(), but + Same as the standard UNIX routine iconv_close(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. Should be called to clean up the conversion descriptor from g_iconv_open() when @@ -14348,24 +10424,18 @@ GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers. - -1 on error, 0 on success + -1 on error, 0 on success - a conversion descriptor from g_iconv_open() + a conversion descriptor from g_iconv_open() - Same as the standard UNIX routine iconv_open(), but + Same as the standard UNIX routine iconv_open(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -14373,54 +10443,34 @@ GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers. - a "conversion descriptor", or (GIConv)-1 if + a "conversion descriptor", or (GIConv)-1 if opening the converter failed. - destination codeset + destination codeset - source codeset + source codeset - - The bias by which exponents in double-precision floats are offset. + + The bias by which exponents in double-precision floats are offset. - - The bias by which exponents in single-precision floats are offset. + + The bias by which exponents in single-precision floats are offset. - - A data structure representing an IO Channel. The fields should be + + A data structure representing an IO Channel. The fields should be considered private and should only be accessed with the following functions. @@ -14486,43 +10536,31 @@ functions. - - Open a file @filename as a #GIOChannel using mode @mode. This + + Open a file @filename as a #GIOChannel using mode @mode. This channel will be closed when the last reference to it is dropped, so there is no need to call g_io_channel_close() (though doing so will not cause problems, as long as no attempt is made to access the channel after it is closed). - A #GIOChannel on success, %NULL on failure. + A #GIOChannel on success, %NULL on failure. - A string containing the name of a file + A string containing the name of a file - One of "r", "w", "a", "r+", "w+", "a+". These have + One of "r", "w", "a", "r+", "w+", "a+". These have the same meaning as in fopen() - Creates a new #GIOChannel given a file descriptor. On UNIX systems + Creates a new #GIOChannel given a file descriptor. On UNIX systems this works for plain files, pipes, and sockets. The returned #GIOChannel has a reference count of 1. @@ -14546,27 +10584,18 @@ valid file descriptor and socket. If that happens a warning is issued, and GLib assumes that it is the file descriptor you mean. - a new #GIOChannel. + a new #GIOChannel. - a file descriptor. + a file descriptor. - - Close an IO channel. Any pending data to be written will be + + Close an IO channel. Any pending data to be written will be flushed, ignoring errors. The channel will not be freed until the last reference is dropped using g_io_channel_unref(). Use g_io_channel_shutdown() instead. @@ -14576,150 +10605,107 @@ last reference is dropped using g_io_channel_unref(). - A #GIOChannel + A #GIOChannel - Flushes the write buffer for the GIOChannel. + Flushes the write buffer for the GIOChannel. - the status of the operation: One of + the status of the operation: One of #G_IO_STATUS_NORMAL, #G_IO_STATUS_AGAIN, or #G_IO_STATUS_ERROR. - a #GIOChannel + a #GIOChannel - - This function returns a #GIOCondition depending on whether there + + This function returns a #GIOCondition depending on whether there is data to be read/space to write data in the internal buffers in the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set. - A #GIOCondition + A #GIOCondition - A #GIOChannel + A #GIOChannel - - Gets the buffer size. + + Gets the buffer size. - the size of the buffer. + the size of the buffer. - a #GIOChannel + a #GIOChannel - Returns whether @channel is buffered. + Returns whether @channel is buffered. - %TRUE if the @channel is buffered. + %TRUE if the @channel is buffered. - a #GIOChannel + a #GIOChannel - - Returns whether the file/socket/whatever associated with @channel + + Returns whether the file/socket/whatever associated with @channel will be closed when @channel receives its final unref and is destroyed. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels. - %TRUE if the channel will be closed, %FALSE otherwise. + %TRUE if the channel will be closed, %FALSE otherwise. - a #GIOChannel. + a #GIOChannel. - Gets the encoding for the input/output of the channel. + Gets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The encoding %NULL makes the channel safe for binary data. - A string containing the encoding, this string is + A string containing the encoding, this string is owned by GLib and must not be freed. - a #GIOChannel + a #GIOChannel - Gets the current flags for a #GIOChannel, including read-only + Gets the current flags for a #GIOChannel, including read-only flags such as %G_IO_FLAG_IS_READABLE. The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE @@ -14730,53 +10716,39 @@ should immediately call g_io_channel_get_flags() to update the internal values of these flags. - the flags which are set on the channel + the flags which are set on the channel - a #GIOChannel + a #GIOChannel - This returns the string that #GIOChannel uses to determine + This returns the string that #GIOChannel uses to determine where in the file a line break occurs. A value of %NULL indicates autodetection. - The line termination string. This value + The line termination string. This value is owned by GLib and must not be freed. - a #GIOChannel + a #GIOChannel - a location to return the length of the line terminator + a location to return the length of the line terminator - Initializes a #GIOChannel struct. + Initializes a #GIOChannel struct. This is called by each of the above functions when creating a #GIOChannel, and so is not often needed by the application @@ -14787,105 +10759,66 @@ programmer (unless you are creating a new type of #GIOChannel). - a #GIOChannel + a #GIOChannel - - Reads data from a #GIOChannel. + + Reads data from a #GIOChannel. Use g_io_channel_read_chars() instead. - %G_IO_ERROR_NONE if the operation was successful. + %G_IO_ERROR_NONE if the operation was successful. - a #GIOChannel + a #GIOChannel - a buffer to read the data into (which should be at least + a buffer to read the data into (which should be at least count bytes long) - the number of bytes to read from the #GIOChannel + the number of bytes to read from the #GIOChannel - returns the number of bytes actually read + returns the number of bytes actually read - - Replacement for g_io_channel_read() with the new API. + + Replacement for g_io_channel_read() with the new API. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - - + + a buffer to read data into - the size of the buffer. Note that the buffer may not be + the size of the buffer. Note that the buffer may not be completely filled even if there is data in the buffer if the remaining data is not a complete character. - - The number of bytes read. This may be + + The number of bytes read. This may be zero even on success if count < 6 and the channel's encoding is non-%NULL. This indicates that the next UTF-8 character is too wide for the buffer. @@ -14893,132 +10826,77 @@ programmer (unless you are creating a new type of #GIOChannel). - - Reads a line, including the terminating character(s), + + Reads a line, including the terminating character(s), from a #GIOChannel into a newly-allocated string. @str_return will contain allocated memory if the return is %G_IO_STATUS_NORMAL. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - - The line read from the #GIOChannel, including the + + The line read from the #GIOChannel, including the line terminator. This data should be freed with g_free() when no longer needed. This is a nul-terminated string. If a @length of zero is returned, this will be %NULL instead. - - location to store length of the read data, or %NULL + + location to store length of the read data, or %NULL - - location to store position of line terminator, or %NULL + + location to store position of line terminator, or %NULL - - Reads a line from a #GIOChannel, using a #GString as a buffer. + + Reads a line from a #GIOChannel, using a #GString as a buffer. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - a #GString into which the line will be written. + a #GString into which the line will be written. If @buffer already contains data, the old data will be overwritten. - - location to store position of line terminator, or %NULL + + location to store position of line terminator, or %NULL - - Reads all the remaining data from the file. + + Reads all the remaining data from the file. - %G_IO_STATUS_NORMAL on success. + %G_IO_STATUS_NORMAL on success. This function never returns %G_IO_STATUS_EOF. - a #GIOChannel + a #GIOChannel - - Location to + + Location to store a pointer to a string holding the remaining data in the #GIOChannel. This data should be freed with g_free() when no longer needed. This data is terminated by an extra nul @@ -15027,139 +10905,90 @@ is %G_IO_STATUS_NORMAL. - - location to store length of the data + + location to store length of the data - - Reads a Unicode character from @channel. + + Reads a Unicode character from @channel. This function cannot be called on a channel with %NULL encoding. - a #GIOStatus + a #GIOStatus - a #GIOChannel + a #GIOChannel - - a location to return a character + + a location to return a character - Increments the reference count of a #GIOChannel. + Increments the reference count of a #GIOChannel. - the @channel that was passed in (since 2.6) + the @channel that was passed in (since 2.6) - a #GIOChannel + a #GIOChannel - - Sets the current position in the #GIOChannel, similar to the standard + + Sets the current position in the #GIOChannel, similar to the standard library function fseek(). Use g_io_channel_seek_position() instead. - %G_IO_ERROR_NONE if the operation was successful. + %G_IO_ERROR_NONE if the operation was successful. - a #GIOChannel + a #GIOChannel - an offset, in bytes, which is added to the position specified + an offset, in bytes, which is added to the position specified by @type - the position in the file, which can be %G_SEEK_CUR (the current + the position in the file, which can be %G_SEEK_CUR (the current position), %G_SEEK_SET (the start of the file), or %G_SEEK_END (the end of the file) - - Replacement for g_io_channel_seek() with the new API. + + Replacement for g_io_channel_seek() with the new API. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - The offset in bytes from the position specified by @type + The offset in bytes from the position specified by @type - a #GSeekType. The type %G_SEEK_CUR is only allowed in those + a #GSeekType. The type %G_SEEK_CUR is only allowed in those cases where a call to g_io_channel_set_encoding () is allowed. See the documentation for g_io_channel_set_encoding () for details. @@ -15167,34 +10996,25 @@ library function fseek(). - - Sets the buffer size. + + Sets the buffer size. - a #GIOChannel + a #GIOChannel - the size of the buffer, or 0 to let GLib pick a good size + the size of the buffer, or 0 to let GLib pick a good size - The buffering state can only be set if the channel's encoding + The buffering state can only be set if the channel's encoding is %NULL. For any other encoding, the channel must be buffered. A buffered channel can only be set unbuffered if the channel's @@ -15219,24 +11039,17 @@ The default state of the channel is buffered. - a #GIOChannel + a #GIOChannel - whether to set the channel buffered or unbuffered + whether to set the channel buffered or unbuffered - - Whether to close the channel on the final unref of the #GIOChannel + + Whether to close the channel on the final unref of the #GIOChannel data structure. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels. @@ -15248,26 +11061,18 @@ can cause problems when the final reference to the #GIOChannel is dropped. - a #GIOChannel + a #GIOChannel - Whether to close the channel on the final unref of + Whether to close the channel on the final unref of the GIOChannel data structure. - - Sets the encoding for the input/output of the channel. + + Sets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The default encoding for the external file is UTF-8. @@ -15303,61 +11108,40 @@ they are "seekable", cannot call g_io_channel_write_chars() after calling one of the API "read" functions. - %G_IO_STATUS_NORMAL if the encoding was successfully set + %G_IO_STATUS_NORMAL if the encoding was successfully set - a #GIOChannel + a #GIOChannel - - the encoding type + + the encoding type - - Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK). + + Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK). - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - the flags to set on the IO channel + the flags to set on the IO channel - This sets the string that #GIOChannel uses to determine + This sets the string that #GIOChannel uses to determine where in the file a line break occurs. @@ -15365,27 +11149,18 @@ where in the file a line break occurs. - a #GIOChannel + a #GIOChannel - - The line termination string. Use %NULL for + + The line termination string. Use %NULL for autodetect. Autodetection breaks on "\n", "\r\n", "\r", "\0", and the Unicode paragraph separator. Autodetection should not be used for anything other than file-based channels. - The length of the termination string. If -1 is passed, the + The length of the termination string. If -1 is passed, the string is assumed to be nul-terminated. This option allows termination strings with embedded nuls. @@ -15393,121 +11168,84 @@ where in the file a line break occurs. - Close an IO channel. Any pending data to be written will be + Close an IO channel. Any pending data to be written will be flushed if @flush is %TRUE. The channel will not be freed until the last reference is dropped using g_io_channel_unref(). - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - if %TRUE, flush pending + if %TRUE, flush pending - Returns the file descriptor of the #GIOChannel. + Returns the file descriptor of the #GIOChannel. On Windows this function returns the file descriptor or socket of the #GIOChannel. - the file descriptor of the #GIOChannel. + the file descriptor of the #GIOChannel. - a #GIOChannel, created with g_io_channel_unix_new(). + a #GIOChannel, created with g_io_channel_unix_new(). - Decrements the reference count of a #GIOChannel. + Decrements the reference count of a #GIOChannel. - a #GIOChannel + a #GIOChannel - - Writes data to a #GIOChannel. + + Writes data to a #GIOChannel. Use g_io_channel_write_chars() instead. - %G_IO_ERROR_NONE if the operation was successful. + %G_IO_ERROR_NONE if the operation was successful. - a #GIOChannel + a #GIOChannel - the buffer containing the data to write + the buffer containing the data to write - the number of bytes to write + the number of bytes to write - the number of bytes actually written + the number of bytes actually written - - Replacement for g_io_channel_write() with the new API. + + Replacement for g_io_channel_write() with the new API. On seekable channels with encodings other than %NULL or UTF-8, generic mixing of reading and writing is not allowed. A call to g_io_channel_write_chars () @@ -15515,40 +11253,27 @@ may only be made on a channel from which data has been read in the cases described in the documentation for g_io_channel_set_encoding (). - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - a buffer to write data from + a buffer to write data from - the size of the buffer. If -1, the buffer + the size of the buffer. If -1, the buffer is taken to be a nul-terminated string. - - The number of bytes written. This can be nonzero + + The number of bytes written. This can be nonzero even if the return value is not %G_IO_STATUS_NORMAL. If the return value is %G_IO_STATUS_NORMAL and the channel is blocking, this will always be equal @@ -15557,53 +11282,36 @@ cases described in the documentation for g_io_channel_set_encoding (). - - Writes a Unicode character to @channel. + + Writes a Unicode character to @channel. This function cannot be called on a channel with %NULL encoding. - a #GIOStatus + a #GIOStatus - a #GIOChannel + a #GIOChannel - a character + a character - - Converts an `errno` error number to a #GIOChannelError. + + Converts an `errno` error number to a #GIOChannelError. - a #GIOChannelError error number, e.g. + a #GIOChannelError error number, e.g. %G_IO_CHANNEL_ERROR_INVAL. - an `errno` error number, e.g. `EINVAL` + an `errno` error number, e.g. `EINVAL` @@ -15614,242 +11322,148 @@ This function cannot be called on a channel with %NULL encoding. - - Error codes returned by #GIOChannel operations. + + Error codes returned by #GIOChannel operations. - File too large. + File too large. - Invalid argument. + Invalid argument. - IO error. + IO error. - File is a directory. + File is a directory. - No space left on device. + No space left on device. - No such device or address. + No such device or address. - - Value too large for defined datatype. + + Value too large for defined datatype. - Broken pipe. + Broken pipe. - Some other error. + Some other error. - - A bitwise combination representing a condition to watch for on an + + A bitwise combination representing a condition to watch for on an event source. - - There is data to read. + + There is data to read. - - Data can be written (without blocking). + + Data can be written (without blocking). - - There is urgent data to read. + + There is urgent data to read. - - Error condition. + + Error condition. - - Hung up (the connection has been broken, usually for + + Hung up (the connection has been broken, usually for pipes and sockets). - - Invalid request. The file descriptor is not open. + + Invalid request. The file descriptor is not open. - #GIOError is only used by the deprecated functions + #GIOError is only used by the deprecated functions g_io_channel_read(), g_io_channel_write(), and g_io_channel_seek(). - no error + no error - an EAGAIN error occurred + an EAGAIN error occurred - an EINVAL error occurred + an EINVAL error occurred - another error occurred + another error occurred - Specifies properties of a #GIOChannel. Some of the flags can only be + Specifies properties of a #GIOChannel. Some of the flags can only be read with g_io_channel_get_flags(), but not changed with g_io_channel_set_flags(). - turns on append mode, corresponds to %O_APPEND + turns on append mode, corresponds to %O_APPEND (see the documentation of the UNIX open() syscall) - turns on nonblocking mode, corresponds to + turns on nonblocking mode, corresponds to %O_NONBLOCK/%O_NDELAY (see the documentation of the UNIX open() syscall) - - indicates that the io channel is readable. + + indicates that the io channel is readable. This flag cannot be changed. - - indicates that the io channel is writable. + + indicates that the io channel is writable. This flag cannot be changed. - - a misspelled version of @G_IO_FLAG_IS_WRITABLE + + a misspelled version of @G_IO_FLAG_IS_WRITABLE that existed before the spelling was fixed in GLib 2.30. It is kept here for compatibility reasons. Deprecated since 2.30 - - indicates that the io channel is seekable, + + indicates that the io channel is seekable, i.e. that g_io_channel_seek_position() can be used on it. This flag cannot be changed. - the mask that specifies all the valid flags. + the mask that specifies all the valid flags. - the mask of the flags that are returned from + the mask of the flags that are returned from g_io_channel_get_flags() - the mask of the flags that the user can modify + the mask of the flags that the user can modify with g_io_channel_set_flags() - Specifies the type of function passed to g_io_add_watch() or + Specifies the type of function passed to g_io_add_watch() or g_io_add_watch_full(), which is called when the requested condition on a #GIOChannel is satisfied. - the function should return %FALSE if the event source + the function should return %FALSE if the event source should be removed - the #GIOChannel event source + the #GIOChannel event source - the condition which has been satisfied + the condition which has been satisfied - - user data set in g_io_add_watch() or g_io_add_watch_full() + + user data set in g_io_add_watch() or g_io_add_watch_full() - A table of functions used to handle different types of #GIOChannel + A table of functions used to handle different types of #GIOChannel in a generic way. @@ -15988,376 +11602,220 @@ in a generic way. - Statuses returned by most of the #GIOFuncs functions. + Statuses returned by most of the #GIOFuncs functions. - An error occurred. + An error occurred. - Success. + Success. - End of file. + End of file. - Resource temporarily unavailable. + Resource temporarily unavailable. - - Checks whether a character is a directory + + Checks whether a character is a directory separator. It returns %TRUE for '/' on UNIX machines and for '\' or '/' under Windows. - a character + a character - - The name of the main group of a desktop entry file, as defined in the + + The name of the main group of a desktop entry file, as defined in the [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec). Consult the specification for more details about the meanings of the keys below. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string list + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string list giving the available application actions. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings giving the categories in which the desktop entry should be shown in a menu. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the tooltip for the desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true -if the application is D-Bus activatable. + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean +set to true if the application is D-Bus activatable. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the command line to execute. It is only valid for desktop entries with the `Application` type. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the generic name of the desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the desktop entry has been deleted by the user. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the name of the icon to be displayed for the desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings giving the MIME types supported by this desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the specific name of the desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings identifying the environments that should not display the desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the desktop entry should be shown in menus. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings identifying the environments that should display the desktop entry. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string containing the working directory to run the program in. It is only valid for desktop entries with the `Application` type. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the application supports the [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec). - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is string + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is string identifying the WM class or name hint of a window that the application will create, which can be used to emulate Startup Notification with older applications. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the program should be run in a terminal window. -It is only valid for desktop entries with the -`Application` type. + +It is only valid for desktop entries with the `Application` type. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the file name of a binary on disk used to determine if the program is actually installed. It is only valid for desktop entries with the `Application` type. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string -giving the type of the desktop entry. Usually -#G_KEY_FILE_DESKTOP_TYPE_APPLICATION, -#G_KEY_FILE_DESKTOP_TYPE_LINK, or -#G_KEY_FILE_DESKTOP_TYPE_DIRECTORY. + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string +giving the type of the desktop entry. + +Usually %G_KEY_FILE_DESKTOP_TYPE_APPLICATION, +%G_KEY_FILE_DESKTOP_TYPE_LINK, or +%G_KEY_FILE_DESKTOP_TYPE_DIRECTORY. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the URL to access. It is only valid for desktop entries with the `Link` type. - - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + + A key under %G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the version of the Desktop Entry Specification used for the desktop entry file. - - The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + + The value of the %G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing applications. - - The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + + The value of the %G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing directories. - - The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + + The value of the %G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing links to documents. - - The GKeyFile struct contains only private data + + The GKeyFile struct contains only private data and should not be accessed directly. - Creates a new empty #GKeyFile object. Use + Creates a new empty #GKeyFile object. Use g_key_file_load_from_file(), g_key_file_load_from_data(), g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to read an existing key file. - an empty #GKeyFile. + an empty #GKeyFile. - - Clears all keys and groups from @key_file, and decreases the + + Clears all keys and groups from @key_file, and decreases the reference count by 1. If the reference count reaches zero, frees the key file and all its allocated memory. @@ -16366,20 +11824,13 @@ frees the key file and all its allocated memory. - a #GKeyFile + a #GKeyFile - - Returns the value associated with @key under @group_name as a + + Returns the value associated with @key under @group_name as a boolean. If @key cannot be found then %FALSE is returned and @error is set @@ -16388,40 +11839,27 @@ associated with @key cannot be interpreted as a boolean then %FALSE is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - the value associated with the key as a boolean, + the value associated with the key as a boolean, or %FALSE if the key was not found or could not be parsed. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - Returns the values associated with @key under @group_name as + + Returns the values associated with @key under @group_name as booleans. If @key cannot be found then %NULL is returned and @error is set to @@ -16430,9 +11868,7 @@ with @key cannot be interpreted as booleans then %NULL is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - + the values associated with the key as a list of booleans, or %NULL if the key was not found or could not be parsed. The returned list of booleans should be freed with g_free() when no longer needed. @@ -16442,41 +11878,25 @@ and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - the number of booleans returned + + the number of booleans returned - - Retrieves a comment above @key from @group_name. + + Retrieves a comment above @key from @group_name. If @key is %NULL then @comment will be read from above @group_name. If both @key and @group_name are %NULL, then @comment will be read from above the first group in the file. @@ -16486,42 +11906,26 @@ but does include any whitespace after them (on each line). It includes the line breaks between lines, but does not include the final line break. - a comment that should be freed with g_free() + a comment that should be freed with g_free() - a #GKeyFile + a #GKeyFile - - a group name, or %NULL + + a group name, or %NULL - - a key + + a key - - Returns the value associated with @key under @group_name as a + + Returns the value associated with @key under @group_name as a double. If @group_name is %NULL, the start_group is used. If @key cannot be found then 0.0 is returned and @error is set to @@ -16530,40 +11934,27 @@ with @key cannot be interpreted as a double then 0.0 is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - the value associated with the key as a double, or + the value associated with the key as a double, or 0.0 if the key was not found or could not be parsed. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - Returns the values associated with @key under @group_name as + + Returns the values associated with @key under @group_name as doubles. If @key cannot be found then %NULL is returned and @error is set to @@ -16572,9 +11963,7 @@ with @key cannot be interpreted as doubles then %NULL is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - + the values associated with the key as a list of doubles, or %NULL if the key was not found or could not be parsed. The returned list of doubles should be freed with g_free() when no longer needed. @@ -16584,47 +11973,30 @@ and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - the number of doubles returned + + the number of doubles returned - - Returns all groups in the key file loaded with @key_file. + + Returns all groups in the key file loaded with @key_file. The array of returned groups will be %NULL-terminated, so @length may optionally be %NULL. - a newly-allocated %NULL-terminated array of strings. + a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -16632,69 +12004,42 @@ The array of returned groups will be %NULL-terminated, so - a #GKeyFile + a #GKeyFile - - return location for the number of returned groups, or %NULL + + return location for the number of returned groups, or %NULL - - Returns the value associated with @key under @group_name as a signed + + Returns the value associated with @key under @group_name as a signed 64-bit integer. This is similar to g_key_file_get_integer() but can return 64-bit results without truncation. - the value associated with the key as a signed 64-bit integer, or + the value associated with the key as a signed 64-bit integer, or 0 if the key was not found or could not be parsed. - a non-%NULL #GKeyFile + a non-%NULL #GKeyFile - a non-%NULL group name + a non-%NULL group name - a non-%NULL key + a non-%NULL key - - Returns the value associated with @key under @group_name as an + + Returns the value associated with @key under @group_name as an integer. If @key cannot be found then 0 is returned and @error is set to @@ -16704,40 +12049,27 @@ for a #gint, then 0 is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - the value associated with the key as an integer, or + the value associated with the key as an integer, or 0 if the key was not found or could not be parsed. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - Returns the values associated with @key under @group_name as + + Returns the values associated with @key under @group_name as integers. If @key cannot be found then %NULL is returned and @error is set to @@ -16747,9 +12079,7 @@ with @key cannot be interpreted as integers, or are out of range for and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - + the values associated with the key as a list of integers, or %NULL if the key was not found or could not be parsed. The returned list of integers should be freed with g_free() when no longer needed. @@ -16759,50 +12089,32 @@ and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - the number of integers returned + + the number of integers returned - - Returns all keys for the group name @group_name. The array of + + Returns all keys for the group name @group_name. The array of returned keys will be %NULL-terminated, so @length may optionally be %NULL. In the event that the @group_name cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - a newly-allocated %NULL-terminated array of strings. + a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -16810,36 +12122,21 @@ be found, %NULL is returned and @error is set to - a #GKeyFile + a #GKeyFile - a group name + a group name - - return location for the number of keys returned, or %NULL + + return location for the number of keys returned, or %NULL - - Returns the actual locale which the result of + + Returns the actual locale which the result of g_key_file_get_locale_string() or g_key_file_get_locale_string_list() came from. @@ -16850,49 +12147,31 @@ have originally been tagged with the locale that is the result of this function. - the locale from the file, or %NULL if the key was not + the locale from the file, or %NULL if the key was not found or the entry in the file was was untranslated - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - a locale identifier or %NULL + + a locale identifier or %NULL - - Returns the value associated with @key under @group_name + + Returns the value associated with @key under @group_name translated in the given @locale if available. If @locale is %NULL then the current locale is assumed. @@ -16906,49 +12185,31 @@ with @key cannot be interpreted or no suitable translation can be found then the untranslated value is returned. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified key cannot be found. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - a locale identifier or %NULL + + a locale identifier or %NULL - - Returns the values associated with @key under @group_name + + Returns the values associated with @key under @group_name translated in the given @locale if available. If @locale is %NULL then the current locale is assumed. @@ -16964,9 +12225,7 @@ returned array is %NULL-terminated, so @length may optionally be %NULL. - a newly allocated %NULL-terminated string array + a newly allocated %NULL-terminated string array or %NULL if the key isn't found. The string array should be freed with g_strfreev(). @@ -16975,74 +12234,43 @@ be %NULL. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - a locale identifier or %NULL + + a locale identifier or %NULL - - return location for the number of returned strings or %NULL + + return location for the number of returned strings or %NULL - - Returns the name of the start group of the file. + + Returns the name of the start group of the file. - - The start group of the key file. + + The start group of the key file. - a #GKeyFile + a #GKeyFile - - Returns the string value associated with @key under @group_name. + + Returns the string value associated with @key under @group_name. Unlike g_key_file_get_value(), this function handles escape sequences like \s. @@ -17052,40 +12280,27 @@ event that the @group_name cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified key cannot be found. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - Returns the values associated with @key under @group_name. + + Returns the values associated with @key under @group_name. In the event the key cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the @@ -17093,9 +12308,7 @@ event that the @group_name cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - + a %NULL-terminated string array or %NULL if the specified key cannot be found. The array should be freed with g_strfreev(). @@ -17104,81 +12317,50 @@ and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - return location for the number of returned strings, or %NULL + + return location for the number of returned strings, or %NULL - - Returns the value associated with @key under @group_name as an unsigned + + Returns the value associated with @key under @group_name as an unsigned 64-bit integer. This is similar to g_key_file_get_integer() but can return large positive results without truncation. - the value associated with the key as an unsigned 64-bit integer, + the value associated with the key as an unsigned 64-bit integer, or 0 if the key was not found or could not be parsed. - a non-%NULL #GKeyFile + a non-%NULL #GKeyFile - a non-%NULL group name + a non-%NULL group name - a non-%NULL key + a non-%NULL key - - Returns the raw value associated with @key under @group_name. + + Returns the raw value associated with @key under @group_name. Use g_key_file_get_string() to retrieve an unescaped UTF-8 string. In the event the key cannot be found, %NULL is returned and @@ -17187,70 +12369,46 @@ event that the @group_name cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified key cannot be found. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - - Looks whether the key file has the group @group_name. + + Looks whether the key file has the group @group_name. - %TRUE if @group_name is a part of @key_file, %FALSE + %TRUE if @group_name is a part of @key_file, %FALSE otherwise. - a #GKeyFile + a #GKeyFile - a group name + a group name - - Looks whether the key file has the key @key in the group + + Looks whether the key file has the key @key in the group @group_name. Note that this function does not follow the rules for #GError strictly; @@ -17262,168 +12420,107 @@ Language bindings should use g_key_file_get_value() to test whether or not a key exists. - %TRUE if @key is a part of @group_name, %FALSE otherwise + %TRUE if @key is a part of @group_name, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name + a group name - a key name + a key name - - Loads a key file from the data in @bytes into an empty #GKeyFile structure. + + Loads a key file from the data in @bytes into an empty #GKeyFile structure. If the object cannot be created then %error is set to a #GKeyFileError. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - a #GBytes + a #GBytes - flags from #GKeyFileFlags + flags from #GKeyFileFlags - - Loads a key file from memory into an empty #GKeyFile structure. + + Loads a key file from memory into an empty #GKeyFile structure. If the object cannot be created then %error is set to a #GKeyFileError. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - key file loaded in memory + key file loaded in memory - the length of @data in bytes (or (gsize)-1 if data is nul-terminated) + the length of @data in bytes (or (gsize)-1 if data is nul-terminated) - flags from #GKeyFileFlags + flags from #GKeyFileFlags - - This function looks for a key file named @file in the paths + + This function looks for a key file named @file in the paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), loads the file into @key_file and returns the file's full path in @full_path. If the file could not be loaded then an %error is set to either a #GFileError or #GKeyFileError. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - a relative path to a filename to open and parse + a relative path to a filename to open and parse - - return location for a string containing the full path + + return location for a string containing the full path of the file, or %NULL - flags from #GKeyFileFlags + flags from #GKeyFileFlags - - This function looks for a key file named @file in the paths + + This function looks for a key file named @file in the paths specified in @search_dirs, loads the file into @key_file and returns the file's full path in @full_path. @@ -17434,59 +12531,37 @@ file, a %G_FILE_ERROR is returned. If there is a problem parsing the file, a %G_KEY_FILE_ERROR is returned. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - a relative path to a filename to open and parse + a relative path to a filename to open and parse - %NULL-terminated array of directories to search + %NULL-terminated array of directories to search - - return location for a string containing the full path + + return location for a string containing the full path of the file, or %NULL - flags from #GKeyFileFlags + flags from #GKeyFileFlags - - Loads a key file into an empty #GKeyFile structure. + + Loads a key file into an empty #GKeyFile structure. If the OS returns an error when opening or reading the file, a %G_FILE_ERROR is returned. If there is a problem parsing the file, a @@ -17496,171 +12571,106 @@ This function will never return a %G_KEY_FILE_ERROR_NOT_FOUND error. If the @file is not found, %G_FILE_ERROR_NOENT is returned. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - the path of a filename to load, in the GLib filename encoding + the path of a filename to load, in the GLib filename encoding - flags from #GKeyFileFlags + flags from #GKeyFileFlags - - Increases the reference count of @key_file. + + Increases the reference count of @key_file. - the same @key_file. + the same @key_file. - a #GKeyFile + a #GKeyFile - - Removes a comment above @key from @group_name. + + Removes a comment above @key from @group_name. If @key is %NULL then @comment will be removed above @group_name. If both @key and @group_name are %NULL, then @comment will be removed above the first group in the file. - %TRUE if the comment was removed, %FALSE otherwise + %TRUE if the comment was removed, %FALSE otherwise - a #GKeyFile + a #GKeyFile - - a group name, or %NULL + + a group name, or %NULL - - a key + + a key - - Removes the specified group, @group_name, + + Removes the specified group, @group_name, from the key file. - %TRUE if the group was removed, %FALSE otherwise + %TRUE if the group was removed, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name + a group name - - Removes @key in @group_name from the key file. + + Removes @key in @group_name from the key file. - %TRUE if the key was removed, %FALSE otherwise + %TRUE if the key was removed, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name + a group name - a key name to remove + a key name to remove - - Writes the contents of @key_file to @filename using + + Writes the contents of @key_file to @filename using g_file_set_contents(). If you need stricter guarantees about durability of the written file than are provided by g_file_set_contents(), use g_file_set_contents_full() with the return value of g_key_file_to_data(). @@ -17669,32 +12679,22 @@ This function can fail for any of the reasons that g_file_set_contents() may fail. - %TRUE if successful, else %FALSE with @error set + %TRUE if successful, else %FALSE with @error set - a #GKeyFile + a #GKeyFile - the name of the file to write to + the name of the file to write to - - Associates a new boolean value with @key under @group_name. + + Associates a new boolean value with @key under @group_name. If @key cannot be found then it is created. @@ -17702,37 +12702,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - %TRUE or %FALSE + %TRUE or %FALSE - - Associates a list of boolean values with @key under @group_name. + + Associates a list of boolean values with @key under @group_name. If @key cannot be found then it is created. If @group_name is %NULL, the start_group is used. @@ -17741,46 +12729,31 @@ If @group_name is %NULL, the start_group is used. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of boolean values + an array of boolean values - length of @list + length of @list - - Places a comment above @key from @group_name. + + Places a comment above @key from @group_name. If @key is %NULL then @comment will be written above @group_name. If both @key and @group_name are %NULL, then @comment will be @@ -17790,50 +12763,30 @@ Note that this function prepends a '#' comment marker to each line of @comment. - %TRUE if the comment was written, %FALSE otherwise + %TRUE if the comment was written, %FALSE otherwise - a #GKeyFile + a #GKeyFile - - a group name, or %NULL + + a group name, or %NULL - - a key + + a key - a comment + a comment - - Associates a new double value with @key under @group_name. + + Associates a new double value with @key under @group_name. If @key cannot be found then it is created. @@ -17841,37 +12794,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a double value + a double value - - Associates a list of double values with @key under + + Associates a list of double values with @key under @group_name. If @key cannot be found then it is created. @@ -17879,45 +12820,31 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of double values + an array of double values - number of double values in @list + number of double values in @list - - Associates a new integer value with @key under @group_name. + + Associates a new integer value with @key under @group_name. If @key cannot be found then it is created. @@ -17925,37 +12852,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an integer value + an integer value - - Associates a new integer value with @key under @group_name. + + Associates a new integer value with @key under @group_name. If @key cannot be found then it is created. @@ -17963,37 +12878,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an integer value + an integer value - - Associates a list of integer values with @key under @group_name. + + Associates a list of integer values with @key under @group_name. If @key cannot be found then it is created. @@ -18001,45 +12904,31 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of integer values + an array of integer values - number of integer values in @list + number of integer values in @list - - Sets the character which is used to separate + + Sets the character which is used to separate values in lists. Typically ';' or ',' are used as separators. The default list separator is ';'. @@ -18048,25 +12937,17 @@ as separators. The default list separator is ';'. - a #GKeyFile + a #GKeyFile - the separator + the separator - - Associates a string value for @key and @locale under @group_name. + + Associates a string value for @key and @locale under @group_name. If the translation for @key cannot be found then it is created. @@ -18074,43 +12955,29 @@ If the translation for @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a locale identifier + a locale identifier - a string + a string - - Associates a list of string values for @key and @locale under + + Associates a list of string values for @key and @locale under @group_name. If the translation for @key cannot be found then it is created. @@ -18119,51 +12986,35 @@ it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a locale identifier + a locale identifier - a %NULL-terminated array of locale string values + a %NULL-terminated array of locale string values - the length of @list + the length of @list - - Associates a new string value with @key under @group_name. + + Associates a new string value with @key under @group_name. If @key cannot be found then it is created. If @group_name cannot be found then it is created. Unlike g_key_file_set_value(), this function handles characters @@ -18174,37 +13025,25 @@ that need escaping, such as newlines. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a string + a string - - Associates a list of string values for @key under @group_name. + + Associates a list of string values for @key under @group_name. If @key cannot be found then it is created. If @group_name cannot be found then it is created. @@ -18213,45 +13052,31 @@ If @group_name cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of string values + an array of string values - number of string values in @list + number of string values in @list - - Associates a new integer value with @key under @group_name. + + Associates a new integer value with @key under @group_name. If @key cannot be found then it is created. @@ -18259,37 +13084,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an integer value + an integer value - - Associates a new value with @key under @group_name. + + Associates a new value with @key under @group_name. If @key cannot be found then it is created. If @group_name cannot be found then it is created. To set an UTF-8 string which may contain @@ -18301,74 +13114,48 @@ g_key_file_set_string(). - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a string + a string - - This function outputs @key_file as a string. + + This function outputs @key_file as a string. Note that this function never reports an error, so it is safe to pass %NULL as @error. - a newly allocated string holding + a newly allocated string holding the contents of the #GKeyFile - a #GKeyFile + a #GKeyFile - - return location for the length of the + + return location for the length of the returned string, or %NULL - Decreases the reference count of @key_file by 1. If the reference count + Decreases the reference count of @key_file by 1. If the reference count reaches zero, frees the key file and all its allocated memory. @@ -18376,9 +13163,7 @@ reaches zero, frees the key file and all its allocated memory. - a #GKeyFile + a #GKeyFile @@ -18389,159 +13174,101 @@ reaches zero, frees the key file and all its allocated memory. - - Error codes returned by key file parsing. + + Error codes returned by key file parsing. - - the text being parsed was in - an unknown encoding + + the text being parsed was in + an unknown encoding - document was ill-formed + document was ill-formed - - the file was not found + + the file was not found - - a requested key was not found + + a requested key was not found - - a requested group was not found + + a requested group was not found - - a value could not be parsed + + a value could not be parsed - Flags which influence the parsing. + Flags which influence the parsing. - No flags, default behaviour + No flags, default behaviour - - Use this flag if you plan to write the - (possibly modified) contents of the key file back to a file; - otherwise all comments will be lost when the key file is - written back. + + Use this flag if you plan to write the + (possibly modified) contents of the key file back to a file; + otherwise all comments will be lost when the key file is + written back. - - Use this flag if you plan to write the - (possibly modified) contents of the key file back to a file; - otherwise only the translations for the current language will be - written back. + + Use this flag if you plan to write the + (possibly modified) contents of the key file back to a file; + otherwise only the translations for the current language will be + written back. - - Hints the compiler that the expression is likely to evaluate to + + Hints the compiler that the expression is likely to evaluate to a true value. The compiler may use this information for optimizations. |[<!-- language="C" --> if (G_LIKELY (random () != 1)) g_print ("not one"); ]| - + - the expression + the expression - Specifies one of the possible types of byte order. + Specifies one of the possible types of byte order. See #G_BYTE_ORDER. - The natural logarithm of 10. + The natural logarithm of 10. - The natural logarithm of 2. + The natural logarithm of 2. - Works like g_mutex_lock(), but for a lock defined with -#G_LOCK_DEFINE. + Works like g_mutex_lock(), but for a lock defined with +%G_LOCK_DEFINE. - the name of the lock + the name of the lock - - The #G_LOCK_ macros provide a convenient interface to #GMutex. -#G_LOCK_DEFINE defines a lock. It can appear in any place where + + The `G_LOCK_` macros provide a convenient interface to #GMutex. +%G_LOCK_DEFINE defines a lock. It can appear in any place where variable definitions may appear in programs, i.e. in the first block of a function or outside of functions. The @name parameter will be mangled to get the name of the #GMutex. This means that you can use names of existing variables as the parameter - e.g. the name of the variable you intend to protect with the lock. Look at our -give_me_next_number() example using the #G_LOCK macros: +give_me_next_number() example using the `G_LOCK` macros: + +Here is an example for using the `G_LOCK` convenience macros: -Here is an example for using the #G_LOCK convenience macros: |[<!-- language="C" --> G_LOCK_DEFINE (current_number); @@ -18561,46 +13288,30 @@ Here is an example for using the #G_LOCK convenience macros: - the name of the lock + the name of the lock - - This works like #G_LOCK_DEFINE, but it creates a static object. + + This works like %G_LOCK_DEFINE, but it creates a static object. - the name of the lock + the name of the lock - - This declares a lock, that is defined with #G_LOCK_DEFINE in another + + This declares a lock, that is defined with %G_LOCK_DEFINE in another module. - the name of the lock + the name of the lock - + @@ -18608,16 +13319,12 @@ module. - Multiplying the base 2 exponent by this number yields the base 10 exponent. + Multiplying the base 2 exponent by this number yields the base 10 exponent. - Defines the log domain. See [Log Domains](#log-domains). + Defines the log domain. See [Log Domains](#log-domains). Libraries should define this so that any messages which they log can be differentiated from messages from other @@ -18640,78 +13347,58 @@ AM_CPPFLAGS = -DG_LOG_DOMAIN=\"Gtk\" Applications can choose to leave it as the default %NULL (or `""`) domain. However, defining the domain offers the same advantages as above. - + - GLib log levels that are considered fatal by default. + GLib log levels that are considered fatal by default. This is not used if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. - - Log levels below 1<<G_LOG_LEVEL_USER_SHIFT are used by GLib. + + Log levels below 1<<G_LOG_LEVEL_USER_SHIFT are used by GLib. Higher bits can be used for user-defined log levels. - The #GList struct is used for each element in a doubly-linked list. + The #GList struct is used for each element in a doubly-linked list. - holds the element's data, which can be a pointer to any kind + holds the element's data, which can be a pointer to any kind of data, or any integer value using the [Type Conversion Macros][glib-Type-Conversion-Macros] - contains the link to the next element in the list + contains the link to the next element in the list - contains the link to the previous element in the list + contains the link to the previous element in the list - Allocates space for one #GList element. It is called by + Allocates space for one #GList element. It is called by g_list_append(), g_list_prepend(), g_list_insert() and g_list_insert_sorted() and so is rarely used on its own. - a pointer to the newly-allocated #GList element + a pointer to the newly-allocated #GList element - Adds a new element on to the end of the list. + Adds a new element on to the end of the list. Note that the return value is the new start of the list, if @list was empty; make sure you store the new value. @@ -18735,37 +13422,26 @@ number_list = g_list_append (number_list, GINT_TO_POINTER (14)); ]| - either @list or the new start of the #GList if @list was %NULL + either @list or the new start of the #GList if @list was %NULL - a pointer to a #GList + a pointer to a #GList - - the data for the new element + + the data for the new element - Adds the second #GList onto the end of the first #GList. + Adds the second #GList onto the end of the first #GList. Note that the elements of the second #GList are not copied. They are used directly. @@ -18777,26 +13453,20 @@ list = g_list_concat (llink, list); ]| - the start of the new #GList, which equals @list1 if not %NULL + the start of the new #GList, which equals @list1 if not %NULL - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the #GList to add to the end of the first #GList, + the #GList to add to the end of the first #GList, this must point to the top of the list @@ -18805,9 +13475,7 @@ list = g_list_concat (llink, list); - Copies a #GList. + Copies a #GList. Note that this is a "shallow" copy. If the list elements consist of pointers to data, the pointers are copied but @@ -18815,31 +13483,22 @@ the actual data is not. See g_list_copy_deep() if you need to copy the data as well. - the start of the new list that holds the same data as @list + the start of the new list that holds the same data as @list - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - - Makes a full (deep) copy of a #GList. + + Makes a full (deep) copy of a #GList. In contrast with g_list_copy(), this function uses @func to make a copy of each list element, in addition to copying the list @@ -18848,7 +13507,7 @@ container itself. @func, as a #GCopyFunc, takes two arguments, the data to be copied and a @user_data pointer. On common processor architectures, it's safe to pass %NULL as @user_data if the copy function takes only one argument. You -may get compiler warnings from this though if compiling with GCC’s +may get compiler warnings from this though if compiling with GCC’s `-Wcast-function-type` warning. For instance, if @list holds a list of GObjects, you can do: @@ -18862,9 +13521,7 @@ g_list_free_full (another_list, g_object_unref); ]| - the start of the new list that holds a full copy of @list, + the start of the new list that holds a full copy of @list, use g_list_free_full() to free it @@ -18872,60 +13529,41 @@ g_list_free_full (another_list, g_object_unref); - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - a copy function used to copy every element in the list + a copy function used to copy every element in the list - - user data passed to the copy function @func, or %NULL + + user data passed to the copy function @func, or %NULL - - Removes the node link_ from the list and frees it. + + Removes the node link_ from the list and frees it. Compare this to g_list_remove_link() which removes the node without freeing it. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - node to delete from @list + node to delete from @list @@ -18933,44 +13571,29 @@ without freeing it. - Finds the element in a #GList which contains the given data. + Finds the element in a #GList which contains the given data. - the found #GList element, or %NULL if it is not found + the found #GList element, or %NULL if it is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - - the element data to find + + the element data to find - - Finds an element in a #GList, using a supplied function to + + Finds an element in a #GList, using a supplied function to find the desired element. It iterates over the list, calling the given function which should return 0 when the desired element is found. The function takes two #gconstpointer arguments, @@ -18978,49 +13601,34 @@ the #GList element's data as the first argument and the given user data. - the found #GList element, or %NULL if it is not found + the found #GList element, or %NULL if it is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - - user data passed to the function + + user data passed to the function - the function to call for each element. + the function to call for each element. It should return 0 when the desired element is found - Gets the first element in a #GList. + Gets the first element in a #GList. - the first element in the #GList, + the first element in the #GList, or %NULL if the #GList has no elements @@ -19028,21 +13636,15 @@ given user data. - any #GList element + any #GList element - - Calls a function for each element of a #GList. + + Calls a function for each element of a #GList. It is safe for @func to remove the element from @list, but it must not modify any part of the list after that element. @@ -19052,34 +13654,23 @@ not modify any part of the list after that element. - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the function to call with each element's data + the function to call with each element's data - - user data to pass to the function + + user data to pass to the function - Frees all of the memory used by a #GList. + Frees all of the memory used by a #GList. The freed elements are returned to the slice allocator. If list elements contain dynamically-allocated memory, you should @@ -19088,7 +13679,7 @@ either use g_list_free_full() or free them manually first. It can be combined with g_steal_pointer() to ensure the list head pointer is not left dangling: |[<!-- language="C" --> -GList *list_of_borrowed_things = …; /<!-- -->* (transfer container) *<!-- -->/ +GList *list_of_borrowed_things = …; /<!-- -->* (transfer container) *<!-- -->/ g_list_free (g_steal_pointer (&list_of_borrowed_things)); ]| @@ -19097,9 +13688,7 @@ g_list_free (g_steal_pointer (&list_of_borrowed_things)); - the first link of a #GList + the first link of a #GList @@ -19107,9 +13696,7 @@ g_list_free (g_steal_pointer (&list_of_borrowed_things)); - Frees one #GList element, but does not update links from the next and + Frees one #GList element, but does not update links from the next and previous elements in the list, so you should not call this function on an element that is currently part of a list. @@ -19120,33 +13707,26 @@ It is usually used after g_list_remove_link(). - a #GList element + a #GList element - - Convenience method, which frees all the memory used by a #GList, + + Convenience method, which frees all the memory used by a #GList, and calls @free_func on every element's data. @free_func must not modify the list (eg, by removing the freed element from it). It can be combined with g_steal_pointer() to ensure the list head pointer -is not left dangling ­— this also has the nice property that the head pointer +is not left dangling ­— this also has the nice property that the head pointer is cleared before any of the list elements are freed, to prevent double frees from @free_func: |[<!-- language="C" --> -GList *list_of_owned_things = …; /<!-- -->* (transfer full) (element-type GObject) *<!-- -->/ +GList *list_of_owned_things = …; /<!-- -->* (transfer full) (element-type GObject) *<!-- -->/ g_list_free_full (g_steal_pointer (&list_of_owned_things), g_object_unref); ]| @@ -19155,180 +13735,121 @@ g_list_free_full (g_steal_pointer (&list_of_owned_things), g_object_unref); - the first link of a #GList + the first link of a #GList - the function to be called to free each element's data + the function to be called to free each element's data - Gets the position of the element containing + Gets the position of the element containing the given data (starting from 0). - the index of the element containing the data, + the index of the element containing the data, or -1 if the data is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - - the data to find + + the data to find - Inserts a new element into the list at the given position. + Inserts a new element into the list at the given position. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - - the data for the new element + + the data for the new element - the position to insert the element. If this is + the position to insert the element. If this is negative, or is larger than the number of elements in the list, the new element is added on to the end of the list. - - Inserts a new element into the list before the given position. + + Inserts a new element into the list before the given position. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - the list element before which the new element + the list element before which the new element is inserted or %NULL to insert at the end of the list - - the data for the new element + + the data for the new element - - Inserts @link_ into the list before the given position. + + Inserts @link_ into the list before the given position. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - - the list element before which the new element + + the list element before which the new element is inserted or %NULL to insert at the end of the list - the list element to be added, which must not be part of + the list element to be added, which must not be part of any other list @@ -19336,12 +13857,8 @@ the given data (starting from 0). - - Inserts a new element into the list, using the given comparison + + Inserts a new element into the list, using the given comparison function to determine its position. If you are adding many new elements to a list, and the number of @@ -19350,49 +13867,33 @@ g_list_prepend() to add the new items and sort the list afterwards with g_list_sort(). - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the + a pointer to a #GList, this must point to the top of the already sorted list - - the data for the new element + + the data for the new element - the function to compare elements in the list. It should + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. - - Inserts a new element into the list, using the given comparison + + Inserts a new element into the list, using the given comparison function to determine its position. If you are adding many new elements to a list, and the number of @@ -19401,60 +13902,40 @@ g_list_prepend() to add the new items and sort the list afterwards with g_list_sort(). - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the + a pointer to a #GList, this must point to the top of the already sorted list - - the data for the new element + + the data for the new element - the function to compare elements in the list. It should + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. - - user data to pass to comparison function + + user data to pass to comparison function - Gets the last element in a #GList. + Gets the last element in a #GList. - the last element in the #GList, + the last element in the #GList, or %NULL if the #GList has no elements @@ -19462,9 +13943,7 @@ with g_list_sort(). - any #GList element + any #GList element @@ -19472,9 +13951,7 @@ with g_list_sort(). - Gets the number of elements in a #GList. + Gets the number of elements in a #GList. This function iterates over the whole list to count its elements. Use a #GQueue instead of a GList if you regularly need the number @@ -19482,16 +13959,12 @@ of items. To check whether the list is non-empty, it is faster to check @list against %NULL. - the number of elements in the #GList + the number of elements in the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list @@ -19499,18 +13972,14 @@ of items. To check whether the list is non-empty, it is faster to check - Gets the element at the given position in a #GList. + Gets the element at the given position in a #GList. This iterates over the list until it reaches the @n-th position. If you intend to iterate over every element, it is better to use a for-loop as described in the #GList introduction. - the element, or %NULL if the position is off + the element, or %NULL if the position is off the end of the #GList @@ -19518,67 +13987,47 @@ described in the #GList introduction. - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the position of the element, counting from 0 + the position of the element, counting from 0 - - Gets the data of the element at the given position. + + Gets the data of the element at the given position. This iterates over the list until it reaches the @n-th position. If you intend to iterate over every element, it is better to use a for-loop as described in the #GList introduction. - the element's data, or %NULL if the position + the element's data, or %NULL if the position is off the end of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the position of the element + the position of the element - - Gets the element @n places before @list. + + Gets the element @n places before @list. - the element, or %NULL if the position is + the element, or %NULL if the position is off the end of the #GList @@ -19586,61 +14035,43 @@ described in the #GList introduction. - a #GList + a #GList - the position of the element, counting from 0 + the position of the element, counting from 0 - - Gets the position of the given element + + Gets the position of the given element in the #GList (starting from 0). - the position of the element in the #GList, + the position of the element in the #GList, or -1 if the element is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - an element in the #GList + an element in the #GList - - Prepends a new element on to the start of the list. + + Prepends a new element on to the start of the list. Note that the return value is the new start of the list, which will have changed, so make sure you store the new value. @@ -19657,9 +14088,7 @@ Do not use this function to prepend a new element to a different element than the start of the list. Use g_list_insert_before() instead. - a pointer to the newly prepended element, which is the new + a pointer to the newly prepended element, which is the new start of the #GList @@ -19667,103 +14096,68 @@ element than the start of the list. Use g_list_insert_before() instead. - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - - the data for the new element + + the data for the new element - Removes an element from a #GList. + Removes an element from a #GList. If two elements contain the same data, only the first is removed. If none of the elements contain the data, the #GList is unchanged. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - - the data of the element to remove + + the data of the element to remove - - Removes all list nodes with data equal to @data. + + Removes all list nodes with data equal to @data. Returns the new head of the list. Contrast with g_list_remove() which removes only the first node matching the given data. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - - data to remove + + data to remove - - Removes an element from a #GList, without freeing the element. + + Removes an element from a #GList, without freeing the element. The removed element's prev and next links are set to %NULL, so that it becomes a self-contained list with one element. @@ -19777,53 +14171,39 @@ g_list_free (llink); ]| - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - an element in the #GList + an element in the #GList - - Reverses a #GList. + + Reverses a #GList. It simply switches the next and prev pointers of each element. - the start of the reversed #GList + the start of the reversed #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list @@ -19831,32 +14211,24 @@ It simply switches the next and prev pointers of each element. - Sorts a #GList using the given comparison function. The algorithm + Sorts a #GList using the given comparison function. The algorithm used is a stable sort. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the comparison function used to sort the #GList. + the comparison function used to sort the #GList. This function is passed the data from 2 elements of the #GList and should return 0 if they are equal, a negative value if the first element comes before the second, or a positive value if @@ -19865,53 +14237,36 @@ used is a stable sort. - - Like g_list_sort(), but the comparison function accepts + + Like g_list_sort(), but the comparison function accepts a user data argument. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - comparison function + comparison function - - user data to pass to comparison function + + user data to pass to comparison function - Structure representing a single field in a structured log entry. See + Structure representing a single field in a structured log entry. See g_log_structured() for details. Log fields may contain arbitrary values, including binary with embedded nul @@ -19920,28 +14275,20 @@ have a trailing nul byte. Otherwise, @length must be set to a non-negative value. - field name (UTF-8 string) + field name (UTF-8 string) - field value (arbitrary bytes) + field value (arbitrary bytes) - length of @value, in bytes, or -1 if it is nul-terminated + length of @value, in bytes, or -1 if it is nul-terminated - Specifies the prototype of log handler functions. + Specifies the prototype of log handler functions. The default log handler, g_log_default_handler(), automatically appends a new-line character to @message when printing it. It is advised that any @@ -19957,106 +14304,64 @@ This is not used if structured logging is enabled; see - the log domain of the message + the log domain of the message - the log level of the message (including the + the log level of the message (including the fatal and recursion flags) - the message to process + the message to process - - user data, set in g_log_set_handler() + + user data, set in g_log_set_handler() - Flags specifying the level of log messages. + Flags specifying the level of log messages. It is possible to change how GLib treats messages of the various levels using g_log_set_handler() and g_log_set_fatal_mask(). - - internal flag + + internal flag - internal flag + internal flag - log level for errors, see g_error(). + log level for errors, see g_error(). This level is also used for messages produced by g_assert(). - - log level for critical warning messages, see + + log level for critical warning messages, see g_critical(). This level is also used for messages produced by g_return_if_fail() and g_return_val_if_fail(). - - log level for warnings, see g_warning() + + log level for warnings, see g_warning() - - log level for messages, see g_message() + + log level for messages, see g_message() - log level for informational messages, see g_info() + log level for informational messages, see g_info() - log level for debug messages, see g_debug() + log level for debug messages, see g_debug() - a mask including all log levels + a mask including all log levels - Writer function for log entries. A log entry is a collection of one or more + Writer function for log entries. A log entry is a collection of one or more #GLogFields, using the standard [field names from journal specification](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html). See g_log_structured() for more information. @@ -20074,53 +14379,35 @@ error handling the message (for example, if the writer function is meant to send messages to a remote logging server and there is a network error), it should return %G_LOG_WRITER_UNHANDLED. This allows writer functions to be chained and fall back to simpler handlers in case of failure. - + - %G_LOG_WRITER_HANDLED if the log entry was handled successfully; - %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED if the log entry was handled successfully; + %G_LOG_WRITER_UNHANDLED otherwise - log level of the message + log level of the message - fields forming the message + fields forming the message - number of @fields + number of @fields - - user data passed to g_log_set_writer_func() + + user data passed to g_log_set_writer_func() - - Return values from #GLogWriterFuncs to indicate whether the given log entry + + Return values from #GLogWriterFuncs to indicate whether the given log entry was successfully handled by the writer, or whether there was an error in handling it (and hence a fallback writer should be used). @@ -20128,20 +14415,14 @@ If a #GLogWriterFunc ignores a log entry, it should return %G_LOG_WRITER_HANDLED. - Log writer has handled the log entry. + Log writer has handled the log entry. - Log writer could not handle the log entry. + Log writer could not handle the log entry. - The major version number of the GLib library. + The major version number of the GLib library. Like #glib_major_version, but from the headers used at application compile time, rather than from the library @@ -20150,76 +14431,47 @@ linked against at application run time. - The maximum value which can be held in a #gint16. + The maximum value which can be held in a #gint16. - - The maximum value which can be held in a #gint32. + + The maximum value which can be held in a #gint32. - The maximum value which can be held in a #gint64. + The maximum value which can be held in a #gint64. - The maximum value which can be held in a #gint8. + The maximum value which can be held in a #gint8. - - The maximum value which can be held in a #guint16. + + The maximum value which can be held in a #guint16. - - The maximum value which can be held in a #guint32. + + The maximum value which can be held in a #guint32. - - The maximum value which can be held in a #guint64. + + The maximum value which can be held in a #guint64. - The maximum value which can be held in a #guint8. + The maximum value which can be held in a #guint8. - - The micro version number of the GLib library. + + The micro version number of the GLib library. Like #gtk_micro_version, but from the headers used at application compile time, rather than from the library @@ -20228,40 +14480,27 @@ linked against at application run time. - The minimum value which can be held in a #gint16. + The minimum value which can be held in a #gint16. - - The minimum value which can be held in a #gint32. + + The minimum value which can be held in a #gint32. - The minimum value which can be held in a #gint64. + The minimum value which can be held in a #gint64. - The minimum value which can be held in a #gint8. + The minimum value which can be held in a #gint8. - - The minor version number of the GLib library. + + The minor version number of the GLib library. Like #gtk_minor_version, but from the headers used at application compile time, rather than from the library @@ -20273,32 +14512,20 @@ linked against at application run time. - - The `GMainContext` struct is an opaque data + + The `GMainContext` struct is an opaque data type representing a set of sources to be handled in a main loop. - Creates a new #GMainContext structure. - + Creates a new #GMainContext structure. + - the new #GMainContext + the new #GMainContext - Tries to become the owner of the specified context. + Tries to become the owner of the specified context. If some other thread is the owner of the context, returns %FALSE immediately. Ownership is properly recursive: the owner can require ownership again @@ -20308,54 +14535,39 @@ is called as many times as g_main_context_acquire(). You must be the owner of a context before you can call g_main_context_prepare(), g_main_context_query(), g_main_context_check(), g_main_context_dispatch(). - + - %TRUE if the operation succeeded, and + %TRUE if the operation succeeded, and this thread is now the owner of @context. - a #GMainContext + a #GMainContext - Adds a file descriptor to the set of file descriptors polled for + Adds a file descriptor to the set of file descriptors polled for this context. This will very seldom be used directly. Instead a typical event source will use g_source_add_unix_fd() instead. - + - - a #GMainContext (or %NULL for the default context) + + a #GMainContext (or %NULL for the default context) - a #GPollFD structure holding information about a file + a #GPollFD structure holding information about a file descriptor to watch. - the priority for this file descriptor which should be + the priority for this file descriptor which should be the same as the priority used for g_source_attach() to ensure that the file descriptor is polled whenever the results may be needed. @@ -20363,115 +14575,82 @@ a typical event source will use g_source_add_unix_fd() instead. - Passes the results of polling back to the main loop. + Passes the results of polling back to the main loop. You should be +careful to pass @fds and its length @n_fds as received from +g_main_context_query(), as this functions relies on assumptions +on how @fds is filled. You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - + - %TRUE if some sources are ready to be dispatched. + %TRUE if some sources are ready to be dispatched. - a #GMainContext + a #GMainContext - the maximum numerical priority of sources to check + the maximum numerical priority of sources to check - array of #GPollFD's that was passed to + array of #GPollFD's that was passed to the last call to g_main_context_query() - return value of g_main_context_query() + return value of g_main_context_query() - Dispatches all pending sources. + Dispatches all pending sources. You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - + - a #GMainContext + a #GMainContext - - Finds a source with the given source functions and user data. If + + Finds a source with the given source functions and user data. If multiple sources exist with the same source function and user data, the first one found will be returned. - + - the source, if one was found, otherwise %NULL + the source, if one was found, otherwise %NULL - - a #GMainContext (if %NULL, the default context will be used). + + a #GMainContext (if %NULL, the default context will be used). - the @source_funcs passed to g_source_new(). + the @source_funcs passed to g_source_new(). - - the user data from the callback. + + the user data from the callback. - - Finds a #GSource given a pair of context and ID. + + Finds a #GSource given a pair of context and ID. It is a programmer error to attempt to look up a non-existent source. @@ -20483,96 +14662,62 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - the #GSource + the #GSource - - a #GMainContext (if %NULL, the default context will be used) + + a #GMainContext (if %NULL, the default context will be used) - the source ID, as returned by g_source_get_id(). + the source ID, as returned by g_source_get_id(). - - Finds a source with the given user data for the callback. If + + Finds a source with the given user data for the callback. If multiple sources exist with the same user data, the first one found will be returned. - + - the source, if one was found, otherwise %NULL + the source, if one was found, otherwise %NULL - a #GMainContext + a #GMainContext - - the user_data for the callback. + + the user_data for the callback. - - Gets the poll function set by g_main_context_set_poll_func(). - + + Gets the poll function set by g_main_context_set_poll_func(). + - the poll function + the poll function - a #GMainContext + a #GMainContext - - Invokes a function in such a way that @context is owned during the + + Invokes a function in such a way that @context is owned during the invocation of @function. -If @context is %NULL then the global default main context — as -returned by g_main_context_default() — is used. +If @context is %NULL then the global default main context — as +returned by g_main_context_default() — is used. If @context is owned by the current thread, @function is called directly. Otherwise, if @context is the thread-default main context @@ -20582,50 +14727,34 @@ afterwards. In any other case, an idle source is created to call @function and that source is attached to @context (presumably to be run in another -thread). The idle source is attached with #G_PRIORITY_DEFAULT +thread). The idle source is attached with %G_PRIORITY_DEFAULT priority. If you want a different priority, use g_main_context_invoke_full(). Note that, as with normal idle functions, @function should probably return %FALSE. If it returns %TRUE, it will be continuously run in a loop (and may prevent this call from returning). - + - - a #GMainContext, or %NULL + + a #GMainContext, or %NULL - function to call + function to call - - data to pass to @function + + data to pass to @function - - Invokes a function in such a way that @context is owned during the + + Invokes a function in such a way that @context is owned during the invocation of @function. This function is the same as g_main_context_invoke() except that it @@ -20634,86 +14763,52 @@ scheduled as an idle and also lets you give a #GDestroyNotify for @data. @notify should not assume that it is called from any particular thread or with any particular context acquired. - + - - a #GMainContext, or %NULL + + a #GMainContext, or %NULL - the priority at which to run @function + the priority at which to run @function - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - a function to call when @data is no longer in use, or %NULL. + + a function to call when @data is no longer in use, or %NULL. - - Determines whether this thread holds the (recursive) + + Determines whether this thread holds the (recursive) ownership of this #GMainContext. This is useful to know before waiting on another thread that may be blocking to get ownership of @context. - + - %TRUE if current thread is owner of @context. + %TRUE if current thread is owner of @context. - a #GMainContext + a #GMainContext - Runs a single iteration for the given main loop. This involves + Runs a single iteration for the given main loop. This involves checking to see if any event sources are ready to be processed, then if no events sources are ready and @may_block is %TRUE, waiting for a source to become ready, then dispatching the highest priority @@ -20725,120 +14820,76 @@ given moment without further waiting. Note that even when @may_block is %TRUE, it is still possible for g_main_context_iteration() to return %FALSE, since the wait may be interrupted for other reasons than an event source becoming ready. - + - %TRUE if events were dispatched. + %TRUE if events were dispatched. - - a #GMainContext (if %NULL, the default context will be used) + + a #GMainContext (if %NULL, the default context will be used) - whether the call may block. + whether the call may block. - Checks if any sources have pending events for the given context. - + Checks if any sources have pending events for the given context. + - %TRUE if events are pending. + %TRUE if events are pending. - - a #GMainContext (if %NULL, the default context will be used) + + a #GMainContext (if %NULL, the default context will be used) - - Pops @context off the thread-default context stack (verifying that + + Pops @context off the thread-default context stack (verifying that it was on the top of the stack). - + - - a #GMainContext object, or %NULL + + a #GMainContext object, or %NULL - Prepares to poll sources within a main loop. The resulting information + Prepares to poll sources within a main loop. The resulting information for polling is determined by calling g_main_context_query (). You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - + - %TRUE if some source is ready to be dispatched + %TRUE if some source is ready to be dispatched prior to polling. - a #GMainContext + a #GMainContext - - location to store priority of highest priority + + location to store priority of highest priority source already ready. - - Acquires @context and sets it as the thread-default context for the + + Acquires @context and sets it as the thread-default context for the current thread. This will cause certain asynchronous operations (such as most [gio][gio]-based I/O) which are started in this thread to run under @context and deliver their @@ -20876,238 +14927,173 @@ started while the non-default context is active. Beware that libraries that predate this function may not correctly handle being used from a thread with a thread-default context. Eg, see g_file_supports_thread_contexts(). - + - - a #GMainContext, or %NULL for the global default context + + a #GMainContext, or %NULL for the global default context - Determines information necessary to poll this main loop. + Determines information necessary to poll this main loop. You should +be careful to pass the resulting @fds array and its length @n_fds +as is when calling g_main_context_check(), as this function relies +on assumptions made when the array is filled. You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - + - the number of records actually stored in @fds, + the number of records actually stored in @fds, or, if more than @n_fds records need to be stored, the number of records that need to be stored. - a #GMainContext + a #GMainContext - maximum priority source to check + maximum priority source to check - - location to store timeout to be used in polling + + location to store timeout to be used in polling - - location to + + location to store #GPollFD records that need to be polled. - length of @fds. + length of @fds. - Increases the reference count on a #GMainContext object by one. - + Increases the reference count on a #GMainContext object by one. + - the @context that was passed in (since 2.6) + the @context that was passed in (since 2.6) - a #GMainContext + a #GMainContext - Releases ownership of a context previously acquired by this thread + Releases ownership of a context previously acquired by this thread with g_main_context_acquire(). If the context was acquired multiple times, the ownership will be released only when g_main_context_release() is called as many times as it was acquired. - + - a #GMainContext + a #GMainContext - Removes file descriptor from the set of file descriptors to be + Removes file descriptor from the set of file descriptors to be polled for a particular context. - + - a #GMainContext + a #GMainContext - a #GPollFD descriptor previously added with g_main_context_add_poll() + a #GPollFD descriptor previously added with g_main_context_add_poll() - - Sets the function to use to handle polling of file descriptors. It + + Sets the function to use to handle polling of file descriptors. It will be used instead of the poll() system call (or GLib's replacement function, which is used where poll() isn't available). This function could possibly be used to integrate the GLib event loop with an external event loop. - + - a #GMainContext + a #GMainContext - the function to call to poll all file descriptors + the function to call to poll all file descriptors - Decreases the reference count on a #GMainContext object by one. If + Decreases the reference count on a #GMainContext object by one. If the result is zero, free the context and free all associated memory. - + - a #GMainContext + a #GMainContext - - Tries to become the owner of the specified context, + + Tries to become the owner of the specified context, as with g_main_context_acquire(). But if another thread is the owner, atomically drop @mutex and wait on @cond until that owner releases ownership or until @cond is signaled, then try again (once) to become the owner. Use g_main_context_is_owner() and separate locking instead. - + - %TRUE if the operation succeeded, and + %TRUE if the operation succeeded, and this thread is now the owner of @context. - a #GMainContext + a #GMainContext - a condition variable + a condition variable - a mutex, currently held + a mutex, currently held - If @context is currently blocking in g_main_context_iteration() + If @context is currently blocking in g_main_context_iteration() waiting for a source to become ready, cause it to stop blocking and return. Otherwise, cause the next invocation of g_main_context_iteration() to return without blocking. @@ -21121,7 +15107,7 @@ loop with a termination condition, computed from multiple threads: |[<!-- language="C" --> #define NUM_TASKS 10 - static volatile gint tasks_remaining = NUM_TASKS; + static gint tasks_remaining = NUM_TASKS; // (atomic) ... while (g_atomic_int_get (&tasks_remaining) != 0) @@ -21135,40 +15121,30 @@ Then in a thread: if (g_atomic_int_dec_and_test (&tasks_remaining)) g_main_context_wakeup (NULL); ]| - + - a #GMainContext + a #GMainContext - Returns the global default main context. This is the main context + Returns the global default main context. This is the main context used for main loop functions when a main loop is not explicitly specified, and corresponds to the "main" main loop. See also g_main_context_get_thread_default(). - + - the global default main context. + the global default main context. - - Gets the thread-default #GMainContext for this thread. Asynchronous + + Gets the thread-default #GMainContext for this thread. Asynchronous operations that want to be able to be run in contexts other than the default one should call this method or g_main_context_ref_thread_default() to get a #GMainContext to add @@ -21179,71 +15155,46 @@ always return %NULL if you are running in the default thread.) If you need to hold a reference on the context, use g_main_context_ref_thread_default() instead. - - - the thread-default #GMainContext, or + + + the thread-default #GMainContext, or %NULL if the thread-default context is the global default context. - - Gets the thread-default #GMainContext for this thread, as with + + Gets the thread-default #GMainContext for this thread, as with g_main_context_get_thread_default(), but also adds a reference to it with g_main_context_ref(). In addition, unlike g_main_context_get_thread_default(), if the thread-default context is the global default context, this will return that #GMainContext (with a ref added to it) rather than returning %NULL. - + - the thread-default #GMainContext. Unref + the thread-default #GMainContext. Unref with g_main_context_unref() when you are done with it. - - The `GMainLoop` struct is an opaque data type + + The `GMainLoop` struct is an opaque data type representing the main event loop of a GLib or GTK+ application. - Creates a new #GMainLoop structure. - + Creates a new #GMainLoop structure. + - a new #GMainLoop. + a new #GMainLoop. - - a #GMainContext (if %NULL, the default context will be used). + + a #GMainContext (if %NULL, the default context will be used). - set to %TRUE to indicate that the loop is running. This + set to %TRUE to indicate that the loop is running. This is not very important since calling g_main_loop_run() will set this to %TRUE anyway. @@ -21251,143 +15202,102 @@ is not very important since calling g_main_loop_run() will set this to - Returns the #GMainContext of @loop. - + Returns the #GMainContext of @loop. + - the #GMainContext of @loop + the #GMainContext of @loop - a #GMainLoop. + a #GMainLoop. - Checks to see if the main loop is currently being run via g_main_loop_run(). - + Checks to see if the main loop is currently being run via g_main_loop_run(). + - %TRUE if the mainloop is currently being run. + %TRUE if the mainloop is currently being run. - a #GMainLoop. + a #GMainLoop. - Stops a #GMainLoop from running. Any calls to g_main_loop_run() + Stops a #GMainLoop from running. Any calls to g_main_loop_run() for the loop will return. Note that sources that have already been dispatched when g_main_loop_quit() is called will still be executed. - - - - - - - a #GMainLoop - - - - - - Increases the reference count on a #GMainLoop object by one. - - - @loop - - - - - a #GMainLoop - - - - - - Runs a main loop until g_main_loop_quit() is called on the loop. -If this is called for the thread of the loop's #GMainContext, -it will process events from the loop, otherwise it will -simply wait. - - - - - - - a #GMainLoop - - - - - - Decreases the reference count on a #GMainLoop object by one. If -the result is zero, free the loop and free all associated memory. - a #GMainLoop + a #GMainLoop + + + + + + Increases the reference count on a #GMainLoop object by one. + + + @loop + + + + + a #GMainLoop + + + + + + Runs a main loop until g_main_loop_quit() is called on the loop. +If this is called for the thread of the loop's #GMainContext, +it will process events from the loop, otherwise it will +simply wait. + + + + + + + a #GMainLoop + + + + + + Decreases the reference count on a #GMainLoop object by one. If +the result is zero, free the loop and free all associated memory. + + + + + + + a #GMainLoop - - The #GMappedFile represents a file mapping created with + + The #GMappedFile represents a file mapping created with g_mapped_file_new(). It has only private members and should not be accessed directly. - - Maps a file into memory. On UNIX, this is using the mmap() function. + + Maps a file into memory. On UNIX, this is using the mmap() function. If @writable is %TRUE, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer @@ -21405,35 +15315,24 @@ size 0 (e.g. device files such as /dev/null), @error will be set to the #GFileError value #G_FILE_ERROR_INVAL. - a newly allocated #GMappedFile which must be unref'd + a newly allocated #GMappedFile which must be unref'd with g_mapped_file_unref(), or %NULL if the mapping failed. - The path of the file to load, in the GLib + The path of the file to load, in the GLib filename encoding - whether the mapping should be writable + whether the mapping should be writable - - Maps a file into memory. On UNIX, this is using the mmap() function. + + Maps a file into memory. On UNIX, this is using the mmap() function. If @writable is %TRUE, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer @@ -21446,35 +15345,23 @@ will not be modified, or if all modifications of the file are done atomically (e.g. using g_file_set_contents()). - a newly allocated #GMappedFile which must be unref'd + a newly allocated #GMappedFile which must be unref'd with g_mapped_file_unref(), or %NULL if the mapping failed. - The file descriptor of the file to load + The file descriptor of the file to load - whether the mapping should be writable + whether the mapping should be writable - - This call existed before #GMappedFile had refcounting and is currently + + This call existed before #GMappedFile had refcounting and is currently exactly the same as g_mapped_file_unref(). Use g_mapped_file_unref() instead. @@ -21483,44 +15370,30 @@ exactly the same as g_mapped_file_unref(). - a #GMappedFile + a #GMappedFile - - Creates a new #GBytes which references the data mapped from @file. + + Creates a new #GBytes which references the data mapped from @file. The mapped contents of the file must not be modified after creating this bytes object, because a #GBytes should be immutable. - A newly allocated #GBytes referencing data + A newly allocated #GBytes referencing data from @file - a #GMappedFile + a #GMappedFile - - Returns the contents of a #GMappedFile. + + Returns the contents of a #GMappedFile. Note that the contents may not be zero-terminated, even if the #GMappedFile is backed by a text file. @@ -21528,67 +15401,47 @@ even if the #GMappedFile is backed by a text file. If the file is empty then %NULL is returned. - the contents of @file, or %NULL. + the contents of @file, or %NULL. - a #GMappedFile + a #GMappedFile - - Returns the length of the contents of a #GMappedFile. + + Returns the length of the contents of a #GMappedFile. - the length of the contents of @file. + the length of the contents of @file. - a #GMappedFile + a #GMappedFile - Increments the reference count of @file by one. It is safe to call + Increments the reference count of @file by one. It is safe to call this function from any thread. - the passed in #GMappedFile. + the passed in #GMappedFile. - a #GMappedFile + a #GMappedFile - Decrements the reference count of @file by one. If the reference count + Decrements the reference count of @file by one. If the reference count drops to 0, unmaps the buffer of @file and frees it. It is safe to call this function from any thread. @@ -21600,18 +15453,14 @@ Since 2.22 - a #GMappedFile + a #GMappedFile - A mixed enumerated type and flags field. You must specify one type + A mixed enumerated type and flags field. You must specify one type (string, strdup, boolean, tristate). Additionally, you may optionally bitwise OR the type with the flag %G_MARKUP_COLLECT_OPTIONAL. @@ -21619,201 +15468,126 @@ It is likely that this enum will be extended in the future to support other types. - used to terminate the list of attributes + used to terminate the list of attributes to collect - collect the string pointer directly from + collect the string pointer directly from the attribute_values[] array. Expects a parameter of type (const char **). If %G_MARKUP_COLLECT_OPTIONAL is specified and the attribute isn't present then the pointer will be set to %NULL - as with %G_MARKUP_COLLECT_STRING, but + as with %G_MARKUP_COLLECT_STRING, but expects a parameter of type (char **) and g_strdup()s the returned pointer. The pointer must be freed with g_free() - expects a parameter of type (gboolean *) + expects a parameter of type (gboolean *) and parses the attribute value as a boolean. Sets %FALSE if the attribute isn't present. Valid boolean values consist of (case-insensitive) "false", "f", "no", "n", "0" and "true", "t", "yes", "y", "1" - - as with %G_MARKUP_COLLECT_BOOLEAN, but + + as with %G_MARKUP_COLLECT_BOOLEAN, but in the case of a missing attribute a value is set that compares equal to neither %FALSE nor %TRUE G_MARKUP_COLLECT_OPTIONAL is implied - - can be bitwise ORed with the other fields. + + can be bitwise ORed with the other fields. If present, allows the attribute not to appear. A default value is set depending on what value type is used - - Error codes returned by markup parsing. + + Error codes returned by markup parsing. - text being parsed was not valid UTF-8 + text being parsed was not valid UTF-8 - document contained nothing, or only whitespace + document contained nothing, or only whitespace - document was ill-formed + document was ill-formed - - error should be set by #GMarkupParser + + error should be set by #GMarkupParser functions; element wasn't known - - error should be set by #GMarkupParser + + error should be set by #GMarkupParser functions; attribute wasn't known - - error should be set by #GMarkupParser + + error should be set by #GMarkupParser functions; content was invalid - - error should be set by #GMarkupParser + + error should be set by #GMarkupParser functions; a required attribute was missing - - A parse context is used to parse a stream of bytes that + + A parse context is used to parse a stream of bytes that you expect to contain marked-up text. See g_markup_parse_context_new(), #GMarkupParser, and so on for more details. - Creates a new parse context. A parse context is used to parse + Creates a new parse context. A parse context is used to parse marked-up documents. You can feed any number of documents into a context, as long as no errors occur; once an error occurs, the parse context can't continue to parse text (you have to free it and create a new parse context). - a new #GMarkupParseContext + a new #GMarkupParseContext - a #GMarkupParser + a #GMarkupParser - one or more #GMarkupParseFlags + one or more #GMarkupParseFlags - - user data to pass to #GMarkupParser functions + + user data to pass to #GMarkupParser functions - - user data destroy notifier called when + + user data destroy notifier called when the parse context is freed - - Signals to the #GMarkupParseContext that all data has been + + Signals to the #GMarkupParseContext that all data has been fed into the parse context with g_markup_parse_context_parse(). This function reports an error if the document isn't complete, for example if elements are still open. - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - a #GMarkupParseContext + a #GMarkupParseContext - Frees a #GMarkupParseContext. + Frees a #GMarkupParseContext. This function can't be called from inside one of the #GMarkupParser functions or while a subparser is pushed. @@ -21823,46 +15597,31 @@ This function can't be called from inside one of the - a #GMarkupParseContext + a #GMarkupParseContext - - Retrieves the name of the currently open element. + + Retrieves the name of the currently open element. If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see g_markup_parse_context_get_element_stack(). - the name of the currently open element, or %NULL + the name of the currently open element, or %NULL - a #GMarkupParseContext + a #GMarkupParseContext - - Retrieves the element stack from the internal state of the parser. + + Retrieves the element stack from the internal state of the parser. The returned #GSList is a list of strings where the first item is the currently open tag (as would be returned by @@ -21875,27 +15634,20 @@ would merely return the name of the element that is being processed. - the element stack, which must not be modified + the element stack, which must not be modified - a #GMarkupParseContext + a #GMarkupParseContext - - Retrieves the current line number and the number of the character on + + Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages." @@ -21905,69 +15657,41 @@ semantics for what constitutes the "current" line number other than - a #GMarkupParseContext + a #GMarkupParseContext - - return location for a line number, or %NULL + + return location for a line number, or %NULL - - return location for a char-on-line number, or %NULL + + return location for a char-on-line number, or %NULL - - Returns the user_data associated with @context. + + Returns the user_data associated with @context. This will either be the user_data that was provided to g_markup_parse_context_new() or to the most recent call of g_markup_parse_context_push(). - the provided user_data. The returned data belongs to + the provided user_data. The returned data belongs to the markup context and will be freed when g_markup_parse_context_free() is called. - a #GMarkupParseContext + a #GMarkupParseContext - - Feed some data to the #GMarkupParseContext. + + Feed some data to the #GMarkupParseContext. The data need not be valid UTF-8; an error will be signaled if it's invalid. The data need not be an entire document; you can @@ -21979,38 +15703,26 @@ is reported, no further data may be fed to the #GMarkupParseContext; all errors are fatal. - %FALSE if an error occurred, %TRUE on success + %FALSE if an error occurred, %TRUE on success - a #GMarkupParseContext + a #GMarkupParseContext - chunk of text to parse + chunk of text to parse - length of @text in bytes + length of @text in bytes - - Completes the process of a temporary sub-parser redirection. + + Completes the process of a temporary sub-parser redirection. This function exists to collect the user_data allocated by a matching call to g_markup_parse_context_push(). It must be called @@ -22025,26 +15737,18 @@ be used by the subparsers themselves to implement a higher-level interface. - the user data passed to g_markup_parse_context_push() + the user data passed to g_markup_parse_context_push() - a #GMarkupParseContext + a #GMarkupParseContext - - Temporarily redirects markup data to a sub-parser. + + Temporarily redirects markup data to a sub-parser. This function may only be called from the start_element handler of a #GMarkupParser. It must be matched with a corresponding call to @@ -22164,56 +15868,35 @@ static void end_element (context, element_name, ...) - a #GMarkupParseContext + a #GMarkupParseContext - a #GMarkupParser + a #GMarkupParser - - user data to pass to #GMarkupParser functions + + user data to pass to #GMarkupParser functions - - Increases the reference count of @context. + + Increases the reference count of @context. - the same @context + the same @context - a #GMarkupParseContext + a #GMarkupParseContext - - Decreases the reference count of @context. When its reference count + + Decreases the reference count of @context. When its reference count drops to 0, it is freed. @@ -22221,63 +15904,41 @@ drops to 0, it is freed. - a #GMarkupParseContext + a #GMarkupParseContext - Flags that affect the behaviour of the parser. + Flags that affect the behaviour of the parser. - - flag you should not use + + flag you should not use - - When this flag is set, CDATA marked + + When this flag is set, CDATA marked sections are not passed literally to the @passthrough function of the parser. Instead, the content of the section (without the `<![CDATA[` and `]]>`) is passed to the @text function. This flag was added in GLib 2.12 - - Normally errors caught by GMarkup + + Normally errors caught by GMarkup itself have line/column information prefixed to them to let the caller know the location of the error. When this flag is set the location information is also prefixed to errors generated by the #GMarkupParser implementation functions - - Ignore (don't report) qualified + + Ignore (don't report) qualified attributes and tags, along with their contents. A qualified attribute or tag is one that contains ':' in its name (ie: is in another namespace). Since: 2.40. - Any of the fields in #GMarkupParser can be %NULL, in which case they + 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 @@ -22304,11 +15965,7 @@ back to its caller. - + @@ -22327,11 +15984,7 @@ back to its caller. - + @@ -22353,11 +16006,7 @@ back to its caller. - + @@ -22379,11 +16028,7 @@ back to its caller. - + @@ -22402,34 +16047,19 @@ back to its caller. - + - - A GMatchInfo is an opaque struct used to return information about + + A GMatchInfo is an opaque struct used to return information about matches. - - Returns a new string containing the text in @string_to_expand with + + Returns a new string containing the text in @string_to_expand with references and escape sequences expanded. References refer to the last match done with @string against @regex and have the same syntax used by g_regex_replace(). @@ -22448,33 +16078,22 @@ Use g_regex_check_replacement() to find out whether @string_to_expand contains references. - the expanded string, or %NULL if an error occurred + the expanded string, or %NULL if an error occurred - - a #GMatchInfo or %NULL + + a #GMatchInfo or %NULL - the string to expand + the string to expand - Retrieves the text matching the @match_num'th capturing + Retrieves the text matching the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on. @@ -22492,33 +16111,23 @@ The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string. - The matched substring, or %NULL if an error + The matched substring, or %NULL if an error occurred. You have to free the string yourself - #GMatchInfo structure + #GMatchInfo structure - number of the sub expression + number of the sub expression - - Bundles up pointers to each of the matching substrings from a match + + Bundles up pointers to each of the matching substrings from a match and stores them in an array of gchar pointers. The first element in the returned array is the match number 0, i.e. the entire matched text. @@ -22536,9 +16145,7 @@ The strings are fetched from the string passed to the match function, so you cannot call this function after freeing the string. - a %NULL-terminated array of gchar * + a %NULL-terminated array of gchar * pointers. It must be freed using g_strfreev(). If the previous match failed %NULL is returned @@ -22547,19 +16154,13 @@ so you cannot call this function after freeing the string. - a #GMatchInfo structure + a #GMatchInfo structure - - Retrieves the text matching the capturing parentheses named @name. + + Retrieves the text matching the capturing parentheses named @name. If @name is a valid sub pattern name but it didn't match anything (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b") @@ -22569,91 +16170,57 @@ The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string. - The matched substring, or %NULL if an error + The matched substring, or %NULL if an error occurred. You have to free the string yourself - #GMatchInfo structure + #GMatchInfo structure - name of the subexpression + name of the subexpression - - Retrieves the position in bytes of the capturing parentheses named @name. + + Retrieves the position in bytes of the capturing parentheses named @name. If @name is a valid sub pattern name but it didn't match anything (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b") then @start_pos and @end_pos are set to -1 and %TRUE is returned. - %TRUE if the position was fetched, %FALSE otherwise. + %TRUE if the position was fetched, %FALSE otherwise. If the position cannot be fetched, @start_pos and @end_pos are left unchanged. - #GMatchInfo structure + #GMatchInfo structure - name of the subexpression + name of the subexpression - - pointer to location where to store + + pointer to location where to store the start position, or %NULL - - pointer to location where to store + + pointer to location where to store the end position, or %NULL - - Retrieves the position in bytes of the @match_num'th capturing + + Retrieves the position in bytes of the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on. @@ -22668,79 +16235,48 @@ substring. Substrings are matched in reverse order of length, so 0 is the longest match. - %TRUE if the position was fetched, %FALSE otherwise. If + %TRUE if the position was fetched, %FALSE otherwise. If the position cannot be fetched, @start_pos and @end_pos are left unchanged - #GMatchInfo structure + #GMatchInfo structure - number of the sub expression + number of the sub expression - - pointer to location where to store + + pointer to location where to store the start position, or %NULL - - pointer to location where to store + + pointer to location where to store the end position, or %NULL - If @match_info is not %NULL, calls g_match_info_unref(); otherwise does + If @match_info is not %NULL, calls g_match_info_unref(); otherwise does nothing. - - a #GMatchInfo, or %NULL + + a #GMatchInfo, or %NULL - - Retrieves the number of matched substrings (including substring 0, + + Retrieves the number of matched substrings (including substring 0, that is the whole matched text), so 1 is returned if the pattern has no substrings in it and 0 is returned if the match failed. @@ -22750,74 +16286,50 @@ count is not that of the number of capturing parentheses but that of the number of matched substrings. - Number of matched substrings, or -1 if an error occurred + Number of matched substrings, or -1 if an error occurred - a #GMatchInfo structure + a #GMatchInfo structure - - Returns #GRegex object used in @match_info. It belongs to Glib + + Returns #GRegex object used in @match_info. It belongs to Glib and must not be freed. Use g_regex_ref() if you need to keep it after you free @match_info object. - #GRegex object used in @match_info + #GRegex object used in @match_info - a #GMatchInfo + a #GMatchInfo - - Returns the string searched with @match_info. This is the + + Returns the string searched with @match_info. This is the string passed to g_regex_match() or g_regex_replace() so you may not free it before calling this function. - the string searched with @match_info + the string searched with @match_info - a #GMatchInfo + a #GMatchInfo - - Usually if the string passed to g_regex_match*() matches as far as + + Usually if the string passed to g_regex_match*() matches as far as it goes, but is too short to match the entire pattern, %FALSE is returned. There are circumstances where it might be helpful to distinguish this case from other cases in which there is no match. @@ -22826,7 +16338,7 @@ Consider, for example, an application where a human is required to type in data for a field with specific formatting requirements. An example might be a date in the form ddmmmyy, defined by the pattern "^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$". -If the application sees the user’s keystrokes one by one, and can +If the application sees the user’s keystrokes one by one, and can check that what has been typed so far is potentially valid, it is able to raise an error as soon as a mistake is made. @@ -22852,50 +16364,33 @@ The restrictions no longer apply. See pcrepartial(3) for more information on partial matching. - %TRUE if the match was partial, %FALSE otherwise + %TRUE if the match was partial, %FALSE otherwise - a #GMatchInfo structure + a #GMatchInfo structure - - Returns whether the previous match operation succeeded. + + Returns whether the previous match operation succeeded. - %TRUE if the previous match operation succeeded, + %TRUE if the previous match operation succeeded, %FALSE otherwise - a #GMatchInfo structure + a #GMatchInfo structure - - Scans for the next match using the same parameters of the previous + + Scans for the next match using the same parameters of the previous call to g_regex_match_full() or g_regex_match() that returned @match_info. @@ -22903,44 +16398,32 @@ The match is done on the string passed to the match function, so you cannot free it before calling this function. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GMatchInfo structure + a #GMatchInfo structure - Increases reference count of @match_info by 1. + Increases reference count of @match_info by 1. - @match_info + @match_info - a #GMatchInfo + a #GMatchInfo - Decreases reference count of @match_info by 1. When reference count drops + Decreases reference count of @match_info by 1. When reference count drops to zero, it frees all the memory associated with the match_info structure. @@ -22948,26 +16431,22 @@ to zero, it frees all the memory associated with the match_info structure. - a #GMatchInfo + a #GMatchInfo - A set of functions used to perform memory allocation. The same #GMemVTable must + A set of functions used to perform memory allocation. The same #GMemVTable must be used for all allocations in the same program; a call to g_mem_set_vtable(), if it exists, should be prior to any use of GLib. This functions related to this has been deprecated in 2.46, and no longer work. - + - + @@ -22980,7 +16459,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -22996,7 +16475,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -23009,7 +16488,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -23025,7 +16504,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -23038,7 +16517,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -23054,9 +16533,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - The #GMutex struct is an opaque data structure to represent a mutex + The #GMutex struct is an opaque data structure to represent a mutex (mutual exclusion). It can be used to protect data against shared access. @@ -23110,9 +16587,7 @@ A #GMutex should only be accessed via g_mutex_ functions. - Frees the resources allocated to a mutex with g_mutex_init(). + Frees the resources allocated to a mutex with g_mutex_init(). This function should not be used with a #GMutex that has been statically allocated. @@ -23127,17 +16602,13 @@ Sine: 2.32 - an initialized #GMutex + an initialized #GMutex - Initializes a #GMutex so that it can be used. + Initializes a #GMutex so that it can be used. This function is useful to initialize a mutex that has been allocated on the stack, or as part of a larger structure. @@ -23167,17 +16638,13 @@ to undefined behaviour. - an uninitialized #GMutex + an uninitialized #GMutex - Locks @mutex. If @mutex is already locked by another thread, the + Locks @mutex. If @mutex is already locked by another thread, the current thread will block until @mutex is unlocked by the other thread. @@ -23191,17 +16658,13 @@ already been locked by the same thread results in undefined behaviour - a #GMutex + a #GMutex - Tries to lock @mutex. If @mutex is already locked by another thread, + Tries to lock @mutex. If @mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @mutex and returns %TRUE. @@ -23211,24 +16674,18 @@ already been locked by the same thread results in undefined behaviour (including but not limited to deadlocks or arbitrary return values). - %TRUE if @mutex could be locked + %TRUE if @mutex could be locked - a #GMutex + a #GMutex - Unlocks @mutex. If another thread is blocked in a g_mutex_lock() + Unlocks @mutex. If another thread is blocked in a g_mutex_lock() call for @mutex, it will become unblocked and can lock @mutex itself. Calling g_mutex_unlock() on a mutex that is not locked by the @@ -23239,20 +16696,14 @@ current thread leads to undefined behaviour. - a #GMutex + a #GMutex - - Returns %TRUE if a #GNode is a leaf node. + + Returns %TRUE if a #GNode is a leaf node. @@ -23260,12 +16711,8 @@ current thread leads to undefined behaviour. - - Returns %TRUE if a #GNode is the root of a tree. + + Returns %TRUE if a #GNode is the root of a tree. @@ -23273,128 +16720,87 @@ current thread leads to undefined behaviour. - - Determines the number of elements in an array. The array must be + + Determines the number of elements in an array. The array must be declared so the compiler knows its size at compile-time; this macro will not work on an array allocated on the heap, only static arrays or arrays on the stack. - + - the array + the array - The #GNode struct represents one node in a [n-ary tree][glib-N-ary-Trees]. + The #GNode struct represents one node in a [n-ary tree][glib-N-ary-Trees]. - contains the actual data of the node. + contains the actual data of the node. - points to the node's next sibling (a sibling is another + points to the node's next sibling (a sibling is another #GNode with the same parent). - points to the node's previous sibling. + points to the node's previous sibling. - points to the parent of the #GNode, or is %NULL if the + points to the parent of the #GNode, or is %NULL if the #GNode is the root of the tree. - points to the first child of the #GNode. The other + points to the first child of the #GNode. The other children are accessed by using the @next pointer of each child. - Gets the position of the first child of a #GNode + Gets the position of the first child of a #GNode which contains the given data. - the index of the child of @node which contains + the index of the child of @node which contains @data, or -1 if the data is not found - a #GNode + a #GNode - - the data to find + + the data to find - Gets the position of a #GNode with respect to its siblings. + Gets the position of a #GNode with respect to its siblings. @child must be a child of @node. The first child is numbered 0, the second 1, and so on. - the position of @child with respect to its siblings + the position of @child with respect to its siblings - a #GNode + a #GNode - a child of @node + a child of @node - - Calls a function for each of the children of a #GNode. Note that it + + Calls a function for each of the children of a #GNode. Note that it doesn't descend beneath the child nodes. @func must not do anything that would modify the structure of the tree. @@ -23403,122 +16809,81 @@ that would modify the structure of the tree. - a #GNode + a #GNode - which types of children are to be visited, one of + which types of children are to be visited, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - the function to call for each visited node + the function to call for each visited node - - user data to pass to the function + + user data to pass to the function - Recursively copies a #GNode (but does not deep-copy the data inside the + Recursively copies a #GNode (but does not deep-copy the data inside the nodes, see g_node_copy_deep() if you need that). - a new #GNode containing the same data pointers + a new #GNode containing the same data pointers - a #GNode + a #GNode - - Recursively copies a #GNode and its data. + + Recursively copies a #GNode and its data. - a new #GNode containing copies of the data in @node. + a new #GNode containing copies of the data in @node. - a #GNode + a #GNode - the function which is called to copy the data inside each node, + the function which is called to copy the data inside each node, or %NULL to use the original data. - - data to pass to @copy_func + + data to pass to @copy_func - Gets the depth of a #GNode. + Gets the depth of a #GNode. If @node is %NULL the depth is 0. The root node has a depth of 1. For the children of the root node the depth is 2. And so on. - the depth of the #GNode + the depth of the #GNode - a #GNode + a #GNode - Removes @root and its children from the tree, freeing any memory + Removes @root and its children from the tree, freeing any memory allocated. @@ -23526,446 +16891,300 @@ allocated. - the root of the tree/subtree to destroy + the root of the tree/subtree to destroy - Finds a #GNode in a tree. + Finds a #GNode in a tree. - the found #GNode, or %NULL if the data is not found + the found #GNode, or %NULL if the data is not found - the root #GNode of the tree to search + the root #GNode of the tree to search - the order in which nodes are visited - %G_IN_ORDER, + the order in which nodes are visited - %G_IN_ORDER, %G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER - which types of children are to be searched, one of + which types of children are to be searched, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - - the data to find + + the data to find - - Finds the first child of a #GNode with the given data. + + Finds the first child of a #GNode with the given data. - the found child #GNode, or %NULL if the data is not found + the found child #GNode, or %NULL if the data is not found - a #GNode + a #GNode - which types of children are to be searched, one of + which types of children are to be searched, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - - the data to find + + the data to find - - Gets the first sibling of a #GNode. + + Gets the first sibling of a #GNode. This could possibly be the node itself. - the first sibling of @node + the first sibling of @node - a #GNode + a #GNode - - Gets the root of a tree. + + Gets the root of a tree. - the root of the tree + the root of the tree - a #GNode + a #GNode - Inserts a #GNode beneath the parent at the given position. + Inserts a #GNode beneath the parent at the given position. - the inserted #GNode + the inserted #GNode - the #GNode to place @node under + the #GNode to place @node under - the position to place @node at, with respect to its siblings + the position to place @node at, with respect to its siblings If position is -1, @node is inserted as the last child of @parent - the #GNode to insert + the #GNode to insert - - Inserts a #GNode beneath the parent after the given sibling. + + Inserts a #GNode beneath the parent after the given sibling. - the inserted #GNode + the inserted #GNode - the #GNode to place @node under + the #GNode to place @node under - the sibling #GNode to place @node after. + the sibling #GNode to place @node after. If sibling is %NULL, the node is inserted as the first child of @parent. - the #GNode to insert + the #GNode to insert - - Inserts a #GNode beneath the parent before the given sibling. + + Inserts a #GNode beneath the parent before the given sibling. - the inserted #GNode + the inserted #GNode - the #GNode to place @node under + the #GNode to place @node under - the sibling #GNode to place @node before. + the sibling #GNode to place @node before. If sibling is %NULL, the node is inserted as the last child of @parent. - the #GNode to insert + the #GNode to insert - Returns %TRUE if @node is an ancestor of @descendant. + Returns %TRUE if @node is an ancestor of @descendant. This is true if node is the parent of @descendant, or if node is the grandparent of @descendant etc. - %TRUE if @node is an ancestor of @descendant + %TRUE if @node is an ancestor of @descendant - a #GNode + a #GNode - a #GNode + a #GNode - - Gets the last child of a #GNode. + + Gets the last child of a #GNode. - the last child of @node, or %NULL if @node has no children + the last child of @node, or %NULL if @node has no children - a #GNode (must not be %NULL) + a #GNode (must not be %NULL) - - Gets the last sibling of a #GNode. + + Gets the last sibling of a #GNode. This could possibly be the node itself. - the last sibling of @node + the last sibling of @node - a #GNode + a #GNode - Gets the maximum height of all branches beneath a #GNode. + Gets the maximum height of all branches beneath a #GNode. This is the maximum distance from the #GNode to all leaf nodes. If @root is %NULL, 0 is returned. If @root has no children, 1 is returned. If @root has children, 2 is returned. And so on. - the maximum height of the tree beneath @root + the maximum height of the tree beneath @root - a #GNode + a #GNode - Gets the number of children of a #GNode. + Gets the number of children of a #GNode. - the number of children of @node + the number of children of @node - a #GNode + a #GNode - Gets the number of nodes in a tree. + Gets the number of nodes in a tree. - the number of nodes in the tree + the number of nodes in the tree - a #GNode + a #GNode - which types of children are to be counted, one of + which types of children are to be counted, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - - Gets a child of a #GNode, using the given index. + + Gets a child of a #GNode, using the given index. The first child is at index 0. If the index is too big, %NULL is returned. - the child of @node at index @n + the child of @node at index @n - a #GNode + a #GNode - the index of the desired child + the index of the desired child - Inserts a #GNode as the first child of the given parent. + Inserts a #GNode as the first child of the given parent. - the inserted #GNode + the inserted #GNode - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the #GNode to insert + the #GNode to insert - Reverses the order of the children of a #GNode. + Reverses the order of the children of a #GNode. (It doesn't change the order of the grandchildren.) @@ -23973,19 +17192,13 @@ too big, %NULL is returned. - a #GNode. + a #GNode. - - Traverses a tree starting at the given root #GNode. + + Traverses a tree starting at the given root #GNode. It calls the given function for each node visited. The traversal can be halted at any point by returning %TRUE from @func. @func must not do anything that would modify the structure of the tree. @@ -23995,97 +17208,67 @@ The traversal can be halted at any point by returning %TRUE from @func. - the root #GNode of the tree to traverse + the root #GNode of the tree to traverse - the order in which nodes are visited - %G_IN_ORDER, + the order in which nodes are visited - %G_IN_ORDER, %G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER. - which types of children are to be visited, one of + which types of children are to be visited, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - the maximum depth of the traversal. Nodes below this + the maximum depth of the traversal. Nodes below this depth will not be visited. If max_depth is -1 all nodes in the tree are visited. If depth is 1, only the root is visited. If depth is 2, the root and its children are visited. And so on. - the function to call for each visited #GNode + the function to call for each visited #GNode - - user data to pass to the function + + user data to pass to the function - Unlinks a #GNode from a tree, resulting in two separate trees. + Unlinks a #GNode from a tree, resulting in two separate trees. - the #GNode to unlink, which becomes the root of a new tree + the #GNode to unlink, which becomes the root of a new tree - Creates a new #GNode containing the given data. + Creates a new #GNode containing the given data. Used to create the first node in a tree. - a new #GNode + a new #GNode - - the data of the new node + + the data of the new node - Specifies the type of function passed to g_node_children_foreach(). + Specifies the type of function passed to g_node_children_foreach(). The function is called with each child node, together with the user data passed to g_node_children_foreach(). @@ -24094,145 +17277,87 @@ data passed to g_node_children_foreach(). - a #GNode. + a #GNode. - - user data passed to g_node_children_foreach(). + + user data passed to g_node_children_foreach(). - Specifies the type of function passed to g_node_traverse(). The + Specifies the type of function passed to g_node_traverse(). The function is called with each of the nodes visited, together with the user data passed to g_node_traverse(). If the function returns %TRUE, then the traversal is stopped. - %TRUE to stop the traversal. + %TRUE to stop the traversal. - a #GNode. + a #GNode. - - user data passed to g_node_traverse(). + + user data passed to g_node_traverse(). - Defines how a Unicode string is transformed in a canonical + Defines how a Unicode string is transformed in a canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. Unicode strings should generally be normalized before comparing them. - + - standardize differences that do not affect the + standardize differences that do not affect the text content, such as the above-mentioned accent representation - another name for %G_NORMALIZE_DEFAULT + another name for %G_NORMALIZE_DEFAULT - - like %G_NORMALIZE_DEFAULT, but with + + like %G_NORMALIZE_DEFAULT, but with composed forms rather than a maximally decomposed form - another name for %G_NORMALIZE_DEFAULT_COMPOSE + another name for %G_NORMALIZE_DEFAULT_COMPOSE - beyond %G_NORMALIZE_DEFAULT also standardize the + beyond %G_NORMALIZE_DEFAULT also standardize the "compatibility" characters in Unicode, such as SUPERSCRIPT THREE to the standard forms (in this case DIGIT THREE). Formatting information may be lost but for most text operations such characters should be considered the same - another name for %G_NORMALIZE_ALL + another name for %G_NORMALIZE_ALL - - like %G_NORMALIZE_ALL, but with composed + + like %G_NORMALIZE_ALL, but with composed forms rather than a maximally decomposed form - another name for %G_NORMALIZE_ALL_COMPOSE + another name for %G_NORMALIZE_ALL_COMPOSE - - Error codes returned by functions converting a string to a number. - - - String was not a valid number. + + Error codes returned by functions converting a string to a number. + + + String was not a valid number. - - String was a number, but out of bounds. + + String was a number, but out of bounds. - - If a long option in the main group has this name, it is not treated as a + + If a long option in the main group has this name, it is not treated as a regular option. Instead it collects all non-option arguments which would otherwise be left in `argv`. The option must be of type %G_OPTION_ARG_CALLBACK, %G_OPTION_ARG_STRING_ARRAY @@ -24246,22 +17371,16 @@ necessary encoding conversions for strings or filenames. - A #GOnce struct controls a one-time initialization function. Any + A #GOnce struct controls a one-time initialization function. Any one-time initialization function must have its own unique #GOnce struct. - the status of the #GOnce + the status of the #GOnce - the value returned by the call to the function, if @status + the value returned by the call to the function, if @status is %G_ONCE_STATUS_READY @@ -24277,20 +17396,13 @@ struct. - + - - Function to be called when starting a critical initialization + + Function to be called when starting a critical initialization section. The argument @location must point to a static 0-initialized variable that will be set to a value other than 0 at the end of the initialization section. In combination with @@ -24311,254 +17423,178 @@ like this: } // use initialization_value here -]| +]| + +While @location has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. - %TRUE if the initialization section should be entered, + %TRUE if the initialization section should be entered, %FALSE and blocks otherwise - location of a static initializable variable + location of a static initializable variable containing 0 - - Counterpart to g_once_init_enter(). Expects a location of a static + + Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized initialization variable, and an initialization value other than 0. Sets the variable to the initialization value, and releases concurrent threads blocking in g_once_init_enter() on this -initialization variable. +initialization variable. + +While @location has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. - location of a static initializable variable + location of a static initializable variable containing 0 - new non-0 value for *@value_location + new non-0 value for *@value_location - The possible statuses of a one-time initialization function + The possible statuses of a one-time initialization function controlled by a #GOnce struct. - - the function has not been called yet. + + the function has not been called yet. - the function call is currently in progress. + the function call is currently in progress. - the function has been called. + the function has been called. - The #GOptionArg enum values determine which type of extra argument the + The #GOptionArg enum values determine which type of extra argument the options expect to find. If an option expects an extra argument, it can be specified in several ways; with a short option: `-x arg`, with a long option: `--name arg` or combined in a single argument: `--name=arg`. - No extra argument. This is useful for simple flags. + No extra argument. This is useful for simple flags. - The option takes a UTF-8 string argument. + The option takes a UTF-8 string argument. - The option takes an integer argument. + The option takes an integer argument. - The option provides a callback (of type + The option provides a callback (of type #GOptionArgFunc) to parse the extra argument. - The option takes a filename as argument, which will + The option takes a filename as argument, which will be in the GLib filename encoding rather than UTF-8. - - The option takes a string argument, multiple + + The option takes a string argument, multiple uses of the option are collected into an array of strings. - - The option takes a filename as argument, + + The option takes a filename as argument, multiple uses of the option are collected into an array of strings. - The option takes a double argument. The argument + The option takes a double argument. The argument can be formatted either for the user's locale or for the "C" locale. Since 2.12 - The option takes a 64-bit integer. Like + The option takes a 64-bit integer. Like %G_OPTION_ARG_INT but for larger numbers. The number can be in decimal base, or in hexadecimal (when prefixed with `0x`, for example, `0xffffffff`). Since 2.12 - The type of function to be passed as callback for %G_OPTION_ARG_CALLBACK + The type of function to be passed as callback for %G_OPTION_ARG_CALLBACK options. - %TRUE if the option was successfully parsed, %FALSE if an error + %TRUE if the option was successfully parsed, %FALSE if an error occurred, in which case @error should be set with g_set_error() - The name of the option being parsed. This will be either a + The name of the option being parsed. This will be either a single dash followed by a single letter (for a short name) or two dashes followed by a long option name. - The value to be parsed. + The value to be parsed. - - User data added to the #GOptionGroup containing the option when it + + User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() - A `GOptionContext` struct defines which options + A `GOptionContext` struct defines which options are accepted by the commandline option parser. The struct has only private fields and should not be directly accessed. - - Adds a #GOptionGroup to the @context, so that parsing with @context + + Adds a #GOptionGroup to the @context, so that parsing with @context will recognize the options in the group. Note that this will take ownership of the @group and thus the @group should not be freed. - + - a #GOptionContext + a #GOptionContext - the group to add + the group to add - - A convenience function which creates a main group if it doesn't + + A convenience function which creates a main group if it doesn't exist, adds the @entries to it and sets the translation domain. - + - a #GOptionContext + a #GOptionContext - a %NULL-terminated array of #GOptionEntrys + a %NULL-terminated array of #GOptionEntrys - - a translation domain to use for translating + + a translation domain to use for translating the `--help` output for the options in @entries with gettext(), or %NULL @@ -24566,214 +17602,142 @@ exist, adds the @entries to it and sets the translation domain. - Frees context and all the groups which have been + Frees context and all the groups which have been added to it. Please note that parsed arguments need to be freed separately (see #GOptionEntry). - + - a #GOptionContext + a #GOptionContext - - Returns the description. See g_option_context_set_description(). - + + Returns the description. See g_option_context_set_description(). + - the description + the description - a #GOptionContext + a #GOptionContext - - Returns a formatted, translated help text for the given context. + + Returns a formatted, translated help text for the given context. To obtain the text produced by `--help`, call `g_option_context_get_help (context, TRUE, NULL)`. To obtain the text produced by `--help-all`, call `g_option_context_get_help (context, FALSE, NULL)`. To obtain the help text for an option group, call `g_option_context_get_help (context, FALSE, group)`. - + - A newly allocated string containing the help text + A newly allocated string containing the help text - a #GOptionContext + a #GOptionContext - if %TRUE, only include the main group + if %TRUE, only include the main group - - the #GOptionGroup to create help for, or %NULL + + the #GOptionGroup to create help for, or %NULL - - Returns whether automatic `--help` generation + + Returns whether automatic `--help` generation is turned on for @context. See g_option_context_set_help_enabled(). - + - %TRUE if automatic help generation is turned on. + %TRUE if automatic help generation is turned on. - a #GOptionContext + a #GOptionContext - - Returns whether unknown options are ignored or not. See + + Returns whether unknown options are ignored or not. See g_option_context_set_ignore_unknown_options(). - + - %TRUE if unknown options are ignored. + %TRUE if unknown options are ignored. - a #GOptionContext + a #GOptionContext - - Returns a pointer to the main group of @context. - + + Returns a pointer to the main group of @context. + - the main group of @context, or %NULL if + the main group of @context, or %NULL if @context doesn't have a main group. Note that group belongs to @context and should not be modified or freed. - a #GOptionContext + a #GOptionContext - - Returns whether strict POSIX code is enabled. + + Returns whether strict POSIX code is enabled. See g_option_context_set_strict_posix() for more information. - + - %TRUE if strict POSIX is enabled, %FALSE otherwise. + %TRUE if strict POSIX is enabled, %FALSE otherwise. - a #GOptionContext + a #GOptionContext - - Returns the summary. See g_option_context_set_summary(). - + + Returns the summary. See g_option_context_set_summary(). + - the summary + the summary - a #GOptionContext + a #GOptionContext - - Parses the command line arguments, recognizing options + + Parses the command line arguments, recognizing options which have been added to @context. A side-effect of calling this function is that g_set_prgname() will be called. @@ -24794,52 +17758,31 @@ call `exit (0)`. Note that function depends on the [current locale][setlocale] for automatic character set conversion of string and filename arguments. - + - %TRUE if the parsing was successful, + %TRUE if the parsing was successful, %FALSE if an error occurred - a #GOptionContext + a #GOptionContext - - a pointer to the number of command line arguments + + a pointer to the number of command line arguments - - a pointer to the array of command line arguments + + a pointer to the array of command line arguments - - Parses the command line arguments. + + Parses the command line arguments. This function is similar to g_option_context_parse() except that it respects the normal memory rules when dealing with a strv instead of @@ -24855,29 +17798,19 @@ See g_win32_get_command_line() for a solution. This function is useful if you are trying to use #GOptionContext with #GApplication. - + - %TRUE if the parsing was successful, + %TRUE if the parsing was successful, %FALSE if an error occurred - a #GOptionContext + a #GOptionContext - - a pointer + + a pointer to the command line arguments (which must be in UTF-8 on Windows). Starting with GLib 2.62, @arguments can be %NULL, which matches g_option_context_parse(). @@ -24887,133 +17820,94 @@ This function is useful if you are trying to use #GOptionContext with - - Adds a string to be displayed in `--help` output after the list + + Adds a string to be displayed in `--help` output after the list of options. This text often includes a bug reporting address. Note that the summary is translated (see g_option_context_set_translate_func()). - + - a #GOptionContext + a #GOptionContext - - a string to be shown in `--help` output + + a string to be shown in `--help` output after the list of options, or %NULL - - Enables or disables automatic generation of `--help` output. + + Enables or disables automatic generation of `--help` output. By default, g_option_context_parse() recognizes `--help`, `-h`, `-?`, `--help-all` and `--help-groupname` and creates suitable output to stdout. - + - a #GOptionContext + a #GOptionContext - %TRUE to enable `--help`, %FALSE to disable it + %TRUE to enable `--help`, %FALSE to disable it - - Sets whether to ignore unknown options or not. If an argument is + + Sets whether to ignore unknown options or not. If an argument is ignored, it is left in the @argv array after parsing. By default, g_option_context_parse() treats unknown options as error. This setting does not affect non-option arguments (i.e. arguments which don't start with a dash). But note that GOption cannot reliably determine whether a non-option belongs to a preceding unknown option. - + - a #GOptionContext + a #GOptionContext - %TRUE to ignore unknown options, %FALSE to produce + %TRUE to ignore unknown options, %FALSE to produce an error when unknown options are met - - Sets a #GOptionGroup as main group of the @context. + + Sets a #GOptionGroup as main group of the @context. This has the same effect as calling g_option_context_add_group(), the only difference is that the options in the main group are treated differently when generating `--help` output. - + - a #GOptionContext + a #GOptionContext - the group to set as main group + the group to set as main group - - Sets strict POSIX mode. + + Sets strict POSIX mode. By default, this mode is disabled. @@ -25037,65 +17931,46 @@ options up to the verb name while leaving the remaining options to be parsed by the relevant subcommand (which can be determined by examining the verb name, which should be present in argv[1] after parsing). - + - a #GOptionContext + a #GOptionContext - the new value + the new value - - Adds a string to be displayed in `--help` output before the list + + Adds a string to be displayed in `--help` output before the list of options. This is typically a summary of the program functionality. Note that the summary is translated (see g_option_context_set_translate_func() and g_option_context_set_translation_domain()). - + - a #GOptionContext + a #GOptionContext - - a string to be shown in `--help` output + + a string to be shown in `--help` output before the list of options, or %NULL - - Sets the function which is used to translate the contexts + + Sets the function which is used to translate the contexts user-visible strings, for `--help` output. If @func is %NULL, strings are not translated. @@ -25106,83 +17981,49 @@ the summary (see g_option_context_set_summary()) and the description If you are using gettext(), you only need to set the translation domain, see g_option_context_set_translation_domain(). - + - a #GOptionContext + a #GOptionContext - - the #GTranslateFunc, or %NULL + + the #GTranslateFunc, or %NULL - - user data to pass to @func, or %NULL + + user data to pass to @func, or %NULL - - a function which gets called to free @data, or %NULL + + a function which gets called to free @data, or %NULL - - A convenience function to use gettext() for translating + + A convenience function to use gettext() for translating user-visible strings. - + - a #GOptionContext + a #GOptionContext - the domain to use + the domain to use - - Creates a new option context. + + Creates a new option context. The @parameter_string can serve multiple purposes. It can be used to add descriptions for "rest" arguments, which are not parsed by @@ -25201,22 +18042,15 @@ below the usage line, use g_option_context_set_summary(). Note that the @parameter_string is translated using the function set with g_option_context_set_translate_func(), so it should normally be passed untranslated. - + - a newly created #GOptionContext, which must be + a newly created #GOptionContext, which must be freed with g_option_context_free() after use. - - a string which is displayed in + + a string which is displayed in the first line of `--help` output, after the usage summary `programname [OPTION...]` @@ -25225,16 +18059,12 @@ it should normally be passed untranslated. - A GOptionEntry struct defines a single option. To have an effect, they + A GOptionEntry struct defines a single option. To have an effect, they must be added to a #GOptionGroup with g_option_context_add_main_entries() or g_option_group_add_entries(). - The long name of an option can be used to specify it + The long name of an option can be used to specify it in a commandline as `--long_name`. Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also possible to specify the option as @@ -25242,30 +18072,22 @@ or g_option_group_add_entries(). - If an option has a short name, it can be specified + If an option has a short name, it can be specified `-short_name` in a commandline. @short_name must be a printable ASCII character different from '-', or zero if the option has no short name. - Flags from #GOptionFlags + Flags from #GOptionFlags - The type of the option, as a #GOptionArg + The type of the option, as a #GOptionArg - If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data + If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data must point to a #GOptionArgFunc callback function, which will be called to handle the extra argument. Otherwise, @arg_data is a pointer to a location to store the value, the required type of @@ -25285,140 +18107,91 @@ or g_option_group_add_entries(). - the description for the option in `--help` + the description for the option in `--help` output. The @description is translated using the @translate_func of the group, see g_option_group_set_translation_domain(). - The placeholder to use for the extra argument parsed + The placeholder to use for the extra argument parsed by the option in `--help` output. The @arg_description is translated using the @translate_func of the group, see g_option_group_set_translation_domain(). - - Error codes returned by option parsing. + + Error codes returned by option parsing. - - An option was not known to the parser. + + An option was not known to the parser. This error will only be reported, if the parser hasn't been instructed to ignore unknown options, see g_option_context_set_ignore_unknown_options(). - - A value couldn't be parsed. + + A value couldn't be parsed. - A #GOptionArgFunc callback failed. + A #GOptionArgFunc callback failed. - The type of function to be used as callback when a parse error occurs. + The type of function to be used as callback when a parse error occurs. - The active #GOptionContext + The active #GOptionContext - The group to which the function belongs + The group to which the function belongs - - User data added to the #GOptionGroup containing the option when it + + User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() - Flags which modify individual options. + Flags which modify individual options. - No flags. Since: 2.42. + No flags. Since: 2.42. - The option doesn't appear in `--help` output. + The option doesn't appear in `--help` output. - The option appears in the main section of the + The option appears in the main section of the `--help` output, even if it is defined in a group. - For options of the %G_OPTION_ARG_NONE kind, this + For options of the %G_OPTION_ARG_NONE kind, this flag indicates that the sense of the option is reversed. - For options of the %G_OPTION_ARG_CALLBACK kind, + For options of the %G_OPTION_ARG_CALLBACK kind, this flag indicates that the callback does not take any argument (like a %G_OPTION_ARG_NONE option). Since 2.8 - For options of the %G_OPTION_ARG_CALLBACK + For options of the %G_OPTION_ARG_CALLBACK kind, this flag indicates that the argument should be passed to the callback in the GLib filename encoding rather than UTF-8. Since 2.8 - - For options of the %G_OPTION_ARG_CALLBACK + + For options of the %G_OPTION_ARG_CALLBACK kind, this flag indicates that the argument supply is optional. If no argument is given then data of %GOptionParseFunc will be set to NULL. Since 2.8 - This flag turns off the automatic conflict + This flag turns off the automatic conflict resolution which prefixes long option names with `groupname-` if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. @@ -25426,14 +18199,8 @@ or g_option_group_add_entries(). your direct control. Since 2.8. - - A `GOptionGroup` struct defines the options in a single + + A `GOptionGroup` struct defines the options in a single group. The struct has only private fields and should not be directly accessed. All options in a group share the same translation function. Libraries which @@ -25442,452 +18209,302 @@ getting a `GOptionGroup` holding their options, which the application can then add to its #GOptionContext. - Creates a new #GOptionGroup. - + Creates a new #GOptionGroup. + - a newly created option group. It should be added + a newly created option group. It should be added to a #GOptionContext or freed with g_option_group_unref(). - the name for the option group, this is used to provide + the name for the option group, this is used to provide help for the options in this group with `--help-`@name - a description for this group to be shown in + a description for this group to be shown in `--help`. This string is translated using the translation domain or translation function of the group - a description for the `--help-`@name option. + a description for the `--help-`@name option. This string is translated using the translation domain or translation function of the group - - user data that will be passed to the pre- and post-parse hooks, + + user data that will be passed to the pre- and post-parse hooks, the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL - - a function that will be called to free @user_data, or %NULL + + a function that will be called to free @user_data, or %NULL - - Adds the options specified in @entries to @group. - + + Adds the options specified in @entries to @group. + - a #GOptionGroup + a #GOptionGroup - a %NULL-terminated array of #GOptionEntrys + a %NULL-terminated array of #GOptionEntrys - - Frees a #GOptionGroup. Note that you must not free groups + + Frees a #GOptionGroup. Note that you must not free groups which have been added to a #GOptionContext. Use g_option_group_unref() instead. - + - a #GOptionGroup + a #GOptionGroup - Increments the reference count of @group by one. - + Increments the reference count of @group by one. + - a #GOptionGroup + a #GOptionGroup - a #GOptionGroup + a #GOptionGroup - - Associates a function with @group which will be called + + Associates a function with @group which will be called from g_option_context_parse() when an error occurs. Note that the user data to be passed to @error_func can be specified when constructing the group with g_option_group_new(). - + - a #GOptionGroup + a #GOptionGroup - a function to call when an error occurs + a function to call when an error occurs - - Associates two functions with @group which will be called + + Associates two functions with @group which will be called from g_option_context_parse() before the first option is parsed and after the last option has been parsed, respectively. Note that the user data to be passed to @pre_parse_func and @post_parse_func can be specified when constructing the group with g_option_group_new(). - + - a #GOptionGroup + a #GOptionGroup - - a function to call before parsing, or %NULL + + a function to call before parsing, or %NULL - - a function to call after parsing, or %NULL + + a function to call after parsing, or %NULL - - Sets the function which is used to translate user-visible strings, + + Sets the function which is used to translate user-visible strings, for `--help` output. Different groups can use different #GTranslateFuncs. If @func is %NULL, strings are not translated. If you are using gettext(), you only need to set the translation domain, see g_option_group_set_translation_domain(). - + - a #GOptionGroup + a #GOptionGroup - - the #GTranslateFunc, or %NULL + + the #GTranslateFunc, or %NULL - - user data to pass to @func, or %NULL + + user data to pass to @func, or %NULL - - a function which gets called to free @data, or %NULL + + a function which gets called to free @data, or %NULL - - A convenience function to use gettext() for translating + + A convenience function to use gettext() for translating user-visible strings. - + - a #GOptionGroup + a #GOptionGroup - the domain to use + the domain to use - Decrements the reference count of @group by one. + Decrements the reference count of @group by one. If the reference count drops to 0, the @group will be freed. and all memory allocated by the @group is released. - + - a #GOptionGroup + a #GOptionGroup - The type of function that can be called before and after parsing. + The type of function that can be called before and after parsing. - %TRUE if the function completed successfully, %FALSE if an error + %TRUE if the function completed successfully, %FALSE if an error occurred, in which case @error should be set with g_set_error() - The active #GOptionContext + The active #GOptionContext - The group to which the function belongs + The group to which the function belongs - - User data added to the #GOptionGroup containing the option when it + + User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() - Specifies one of the possible types of byte order + Specifies one of the possible types of byte order (currently unused). See #G_BYTE_ORDER. - The value of pi (ratio of circle's circumference to its diameter). + The value of pi (ratio of circle's circumference to its diameter). - A format specifier that can be used in printf()-style format strings + A format specifier that can be used in printf()-style format strings when printing a #GPid. - Pi divided by 2. + Pi divided by 2. - Pi divided by 4. + Pi divided by 4. - A format specifier that can be used in printf()-style format strings + A format specifier that can be used in printf()-style format strings when printing the @fd member of a #GPollFD. - Use this for default priority event sources. + Use this for default priority event sources. In GLib this priority is used when adding timeout functions with g_timeout_add(). In GDK this priority is used for events from the X server. - + - - Use this for default priority idle functions. + + Use this for default priority idle functions. In GLib this priority is used when adding idle functions with g_idle_add(). - + - Use this for high priority event sources. + Use this for high priority event sources. It is not used within GLib or GTK+. - + - - Use this for high priority idle functions. + + Use this for high priority idle functions. GTK+ uses #G_PRIORITY_HIGH_IDLE + 10 for resizing operations, and #G_PRIORITY_HIGH_IDLE + 20 for redrawing operations. (This is done to ensure that any pending resizes are processed before any pending redraws, so that widgets are not redrawn twice unnecessarily.) - + - Use this for very low priority background tasks. + Use this for very low priority background tasks. It is not used within GLib or GTK+. - + - - A macro to assist with the static initialisation of a #GPrivate. + + A macro to assist with the static initialisation of a #GPrivate. This macro is useful for the case that a #GDestroyNotify function should be associated with the key. This is needed when the key will be @@ -25936,175 +18553,200 @@ set_local_count (gint count) - a #GDestroyNotify + a #GDestroyNotify - - A GPatternSpec struct is the 'compiled' form of a pattern. This + + A GPatternSpec struct is the 'compiled' form of a pattern. This structure is opaque and its fields cannot be accessed directly. - - Compares two compiled pattern specs and returns whether they will -match the same set of strings. + + Compiles a pattern to a #GPatternSpec. + + + a newly-allocated #GPatternSpec + + + + + a zero-terminated UTF-8 encoded string + + + + + + Copies @pspec in a new #GPatternSpec. + + a copy of @pspec. + + + + + a #GPatternSpec + + + + + + Compares two compiled pattern specs and returns whether they will +match the same set of strings. + - Whether the compiled patterns are equal + Whether the compiled patterns are equal - a #GPatternSpec + a #GPatternSpec - another #GPatternSpec + another #GPatternSpec - Frees the memory allocated for the #GPatternSpec. + Frees the memory allocated for the #GPatternSpec. - a #GPatternSpec + a #GPatternSpec - - Compiles a pattern to a #GPatternSpec. - - - a newly-allocated #GPatternSpec - + + Matches a string against a compiled pattern. Passing the correct +length of the string given is mandatory. The reversed string can be +omitted by passing %NULL, this is more efficient if the reversed +version of the string to be matched is not at hand, as +g_pattern_match() will only construct it if the compiled pattern +requires reverse matches. + +Note that, if the user code will (possibly) match a string against a +multitude of patterns containing wildcards, chances are high that +some patterns will require a reversed string. In this case, it's +more efficient to provide the reversed string to avoid multiple +constructions thereof in the various calls to g_pattern_match(). + +Note also that the reverse of a UTF-8 encoded string can in general +not be obtained by g_strreverse(). This works only if the string +does not contain any multibyte characters. GLib offers the +g_utf8_strreverse() function to reverse UTF-8 encoded strings. + + + %TRUE if @string matches @pspec + - - a zero-terminated UTF-8 encoded string + + a #GPatternSpec + + + + the length of @string (in bytes, i.e. strlen(), + not g_utf8_strlen()) + + + + the UTF-8 encoded string to match + + + + the reverse of @string or %NULL - + + + Matches a string against a compiled pattern. If the string is to be +matched against more than one pattern, consider using +g_pattern_match() instead while supplying the reversed string. + + + %TRUE if @string matches @pspec + + + + + a #GPatternSpec + + + + the UTF-8 encoded string to match + + + + - - Represents a file descriptor, which events to poll for, and which events + + Represents a file descriptor, which events to poll for, and which events occurred. - the file descriptor to poll (or a HANDLE on Win32) + the file descriptor to poll (or a HANDLE on Win32) - a bitwise combination from #GIOCondition, specifying which + a bitwise combination from #GIOCondition, specifying which events should be polled for. Typically for reading from a file descriptor you would use %G_IO_IN | %G_IO_HUP | %G_IO_ERR, and for writing you would use %G_IO_OUT | %G_IO_ERR. - a bitwise combination of flags from #GIOCondition, returned + a bitwise combination of flags from #GIOCondition, returned from the poll() function to indicate which events occurred. - Specifies the type of function passed to g_main_context_set_poll_func(). + Specifies the type of function passed to g_main_context_set_poll_func(). The semantics of the function should match those of the poll() system call. - the number of #GPollFD elements which have events or errors + the number of #GPollFD elements which have events or errors reported, or -1 if an error occurred. - an array of #GPollFD elements + an array of #GPollFD elements - the number of elements in @ufds + the number of elements in @ufds - the maximum time to wait for an event of the file descriptors. + the maximum time to wait for an event of the file descriptors. A negative value indicates an infinite timeout. - Specifies the type of the print handler functions. + Specifies the type of the print handler functions. These are called with the complete formatted string to output. - + - the message to output + the message to output - The #GPrivate struct is an opaque data structure to represent a + The #GPrivate struct is an opaque data structure to represent a thread-local data key. It is approximately equivalent to the pthread_setspecific()/pthread_getspecific() APIs on POSIX and to TlsSetValue()/TlsGetValue() on Windows. @@ -26134,33 +18776,25 @@ be accessed via the g_private_ functions. - Returns the current value of the thread local variable @key. + Returns the current value of the thread local variable @key. If the value has not yet been set in this thread, %NULL is returned. Values are never copied between threads (when a new thread is created, for example). - the thread-local value + the thread-local value - a #GPrivate + a #GPrivate - Sets the thread local variable @key to have the value @value in the + Sets the thread local variable @key to have the value @value in the current thread. This function differs from g_private_set() in the following way: if @@ -26172,26 +18806,17 @@ the previous value was non-%NULL then the #GDestroyNotify handler for - a #GPrivate + a #GPrivate - - the new value + + the new value - Sets the thread local variable @key to have the value @value in the + Sets the thread local variable @key to have the value @value in the current thread. This function differs from g_private_replace() in the following way: @@ -26202,49 +18827,30 @@ the #GDestroyNotify for @key is not called on the old value. - a #GPrivate + a #GPrivate - - the new value + + the new value - - Contains the public fields of a pointer array. + + Contains the public fields of a pointer array. - points to the array of pointers, which may be moved when the + points to the array of pointers, which may be moved when the array grows - number of pointers in the array + number of pointers in the array - Adds a pointer to the end of the pointer array. The array will grow + Adds a pointer to the end of the pointer array. The array will grow in size automatically if necessary. @@ -26252,36 +18858,24 @@ in size automatically if necessary. - a #GPtrArray + a #GPtrArray - - the pointer to add + + the pointer to add - - Makes a full (deep) copy of a #GPtrArray. + + Makes a full (deep) copy of a #GPtrArray. @func, as a #GCopyFunc, takes two arguments, the data to be copied and a @user_data pointer. On common processor architectures, it's safe to pass %NULL as @user_data if the copy function takes only one argument. You -may get compiler warnings from this though if compiling with GCC’s +may get compiler warnings from this though if compiling with GCC’s `-Wcast-function-type` warning. If @func is %NULL, then only the pointers (and not what they are @@ -26291,57 +18885,37 @@ The copy of @array will have the same #GDestroyNotify for its elements as @array. - a deep copy of the initial #GPtrArray. + a deep copy of the initial #GPtrArray. - #GPtrArray to duplicate + #GPtrArray to duplicate - - a copy function used to copy every element in the array + + a copy function used to copy every element in the array - - user data passed to the copy function @func, or %NULL + + user data passed to the copy function @func, or %NULL - - Adds all pointers of @array to the end of the array @array_to_extend. + + Adds all pointers of @array to the end of the array @array_to_extend. The array will grow in size automatically if needed. @array_to_extend is modified in-place. @func, as a #GCopyFunc, takes two arguments, the data to be copied and a @user_data pointer. On common processor architectures, it's safe to pass %NULL as @user_data if the copy function takes only one argument. You -may get compiler warnings from this though if compiling with GCC’s +may get compiler warnings from this though if compiling with GCC’s `-Wcast-function-type` warning. If @func is %NULL, then only the pointers (and not what they are @@ -26352,49 +18926,29 @@ pointing to) are copied to the new #GPtrArray. - a #GPtrArray. + a #GPtrArray. - a #GPtrArray to add to the end of @array_to_extend. + a #GPtrArray to add to the end of @array_to_extend. - - a copy function used to copy every element in the array + + a copy function used to copy every element in the array - - user data passed to the copy function @func, or %NULL + + user data passed to the copy function @func, or %NULL - - Adds all the pointers in @array to the end of @array_to_extend, transferring + + Adds all the pointers in @array to the end of @array_to_extend, transferring ownership of each element from @array to @array_to_extend and modifying @array_to_extend in-place. @array is then freed. @@ -26407,17 +18961,13 @@ length of @array set to zero. - a #GPtrArray. + a #GPtrArray. - a #GPtrArray to add to the end of + a #GPtrArray to add to the end of @array_to_extend. @@ -26425,14 +18975,9 @@ length of @array set to zero. - - Checks whether @needle exists in @haystack. If the element is found, %TRUE is -returned and the element’s index is returned in @index_ (if non-%NULL). + + Checks whether @needle exists in @haystack. If the element is found, %TRUE is +returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned. @@ -26440,51 +18985,30 @@ This does pointer comparisons only. If you want to use more complex equality checks, such as string comparisons, use g_ptr_array_find_with_equal_func(). - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - - pointer to look for + + pointer to look for - - return location for the index of + + return location for the index of the element, if found - - Checks whether @needle exists in @haystack, using the given @equal_func. -If the element is found, %TRUE is returned and the element’s index is + + Checks whether @needle exists in @haystack, using the given @equal_func. +If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned. @@ -26494,61 +19018,35 @@ and @needle as its second parameter. If @equal_func is %NULL, pointer equality is used. - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - - pointer to look for + + pointer to look for - - the function to call for each element, which should + + the function to call for each element, which should return %TRUE when the desired element is found; or %NULL to use pointer equality - - return location for the index of + + return location for the index of the element, if found - - Calls a function for each element of a #GPtrArray. @func must not + + Calls a function for each element of a #GPtrArray. @func must not add elements to or remove elements from the array. @@ -26556,34 +19054,23 @@ add elements to or remove elements from the array. - a #GPtrArray + a #GPtrArray - the function to call for each array element + the function to call for each array element - - user data to pass to the function + + user data to pass to the function - Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE + Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE it frees the memory block holding the elements as well. Pass %FALSE if you want to free the #GPtrArray wrapper but preserve the underlying array for use elsewhere. If the reference count of @array @@ -26598,37 +19085,26 @@ This function is not thread-safe. If using a #GPtrArray from multiple threads, use only the atomic g_ptr_array_ref() and g_ptr_array_unref() functions. - - the pointer array if @free_seg is %FALSE, otherwise %NULL. - The pointer array should be freed using g_free(). + + the pointer array if @free_seg is + %FALSE, otherwise %NULL. The pointer array should be freed using g_free(). - a #GPtrArray + a #GPtrArray - if %TRUE the actual pointer array is freed as well + if %TRUE the actual pointer array is freed as well - - Inserts an element into the pointer array at the given index. The + + Inserts an element into the pointer array at the given index. The array will grow in size automatically if necessary. @@ -26636,51 +19112,33 @@ array will grow in size automatically if necessary. - a #GPtrArray + a #GPtrArray - the index to place the new element at, or -1 to append + the index to place the new element at, or -1 to append - - the pointer to add. + + the pointer to add. - Creates a new #GPtrArray with a reference count of 1. + Creates a new #GPtrArray with a reference count of 1. - the new #GPtrArray + the new #GPtrArray - - Creates a new #GPtrArray with @reserved_size pointers preallocated + + Creates a new #GPtrArray with @reserved_size pointers preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many pointers to the array. Note however that the size of the array is still 0. It also set @element_free_func @@ -26689,100 +19147,64 @@ g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements. - A new #GPtrArray + A new #GPtrArray - number of pointers preallocated + number of pointers preallocated - - A function to free elements with + + A function to free elements with destroy @array or %NULL - - Creates a new #GPtrArray with a reference count of 1 and use + + Creates a new #GPtrArray with a reference count of 1 and use @element_free_func for freeing each element when the array is destroyed either via g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements. - A new #GPtrArray + A new #GPtrArray - - A function to free elements with + + A function to free elements with destroy @array or %NULL - - Atomically increments the reference count of @array by one. + + Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread. - The passed in #GPtrArray + The passed in #GPtrArray - a #GPtrArray + a #GPtrArray - - Removes the first occurrence of the given pointer from the pointer + + Removes the first occurrence of the given pointer from the pointer array. The following elements are moved down one place. If @array has a non-%NULL #GDestroyNotify function it is called for the removed element. @@ -26791,38 +19213,25 @@ It returns %TRUE if the pointer was removed, or %FALSE if the pointer was not found. - %TRUE if the pointer is removed, %FALSE if the pointer + %TRUE if the pointer is removed, %FALSE if the pointer is not found in the array - a #GPtrArray + a #GPtrArray - - the pointer to remove + + the pointer to remove - - Removes the first occurrence of the given pointer from the pointer + + Removes the first occurrence of the given pointer from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_remove(). If @array has a non-%NULL @@ -26832,71 +19241,48 @@ It returns %TRUE if the pointer was removed, or %FALSE if the pointer was not found. - %TRUE if the pointer was found in the array + %TRUE if the pointer was found in the array - a #GPtrArray + a #GPtrArray - - the pointer to remove + + the pointer to remove - - Removes the pointer at the given index from the pointer array. + + Removes the pointer at the given index from the pointer array. The following elements are moved down one place. If @array has a non-%NULL #GDestroyNotify function it is called for the removed element. If so, the return value from this function will potentially point to freed memory (depending on the #GDestroyNotify implementation). - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to remove + the index of the pointer to remove - - Removes the pointer at the given index from the pointer array. + + Removes the pointer at the given index from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_remove_index(). If @array has a non-%NULL @@ -26905,77 +19291,53 @@ return value from this function will potentially point to freed memory (depending on the #GDestroyNotify implementation). - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to remove + the index of the pointer to remove - - Removes the given number of pointers starting at the given index + + Removes the given number of pointers starting at the given index from a #GPtrArray. The following elements are moved to close the gap. If @array has a non-%NULL #GDestroyNotify function it is called for the removed elements. - the @array + the @array - a @GPtrArray + a @GPtrArray - the index of the first pointer to remove + the index of the first pointer to remove - the number of pointers to remove + the number of pointers to remove - - Sets a function for freeing each element when @array is destroyed + + Sets a function for freeing each element when @array is destroyed either via g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements. @@ -26984,32 +19346,20 @@ with @free_segment set to %TRUE or when removing elements. - A #GPtrArray + A #GPtrArray - - A function to free elements with + + A function to free elements with destroy @array or %NULL - - Sets the size of the array. When making the array larger, + + Sets the size of the array. When making the array larger, newly-added elements will be set to %NULL. When making it smaller, if @array has a non-%NULL #GDestroyNotify function then it will be called for the removed elements. @@ -27019,52 +19369,38 @@ called for the removed elements. - a #GPtrArray + a #GPtrArray - the new length of the pointer array + the new length of the pointer array - - Creates a new #GPtrArray with @reserved_size pointers preallocated + + Creates a new #GPtrArray with @reserved_size pointers preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many pointers to the array. Note however that the size of the array is still 0. - the new #GPtrArray + the new #GPtrArray - number of pointers preallocated + number of pointers preallocated - Sorts the array, using @compare_func which should be a qsort()-style + Sorts the array, using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if irst arg is greater than second arg). @@ -27089,7 +19425,7 @@ sort_filelist (gconstpointer a, gconstpointer b) return g_ascii_strcasecmp (entry1->name, entry2->name); } -… +… g_autoptr (GPtrArray) file_list = NULL; // initialize file_list array and load with many FileListEntry entries @@ -27105,27 +19441,19 @@ This is guaranteed to be a stable sort since version 2.32. - a #GPtrArray + a #GPtrArray - comparison function + comparison function - - Like g_ptr_array_sort(), but the comparison function has an extra + + Like g_ptr_array_sort(), but the comparison function has an extra user data argument. Note that the comparison function for g_ptr_array_sort_with_data() @@ -27184,37 +19512,23 @@ This is guaranteed to be a stable sort since version 2.32. - a #GPtrArray + a #GPtrArray - comparison function + comparison function - - data to pass to @compare_func + + data to pass to @compare_func - - Frees the data in the array and resets the size to zero, while + + Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller. @@ -27230,7 +19544,7 @@ g_autoptr(GPtrArray) chunk_buffer = g_ptr_array_new_with_free_func (g_bytes_unre g_ptr_array_add (chunk_buffer, g_bytes_new_static ("hello", 5)); g_ptr_array_add (chunk_buffer, g_bytes_new_static ("world", 5)); -… +… // Periodically, the chunks need to be sent as an array-and-length to some // other part of the program. @@ -27243,7 +19557,7 @@ for (gsize i = 0; i < n_chunks; i++) // Do something with each chunk here, and then free them, since // g_ptr_array_steal() transfers ownership of all the elements and the // array to the caller. - … + … g_bytes_unref (chunks[i]); } @@ -27256,76 +19570,49 @@ g_assert (chunk_buffer->len == 0); ]| - the element data, which should be + the element data, which should be freed using g_free(). - a #GPtrArray. + a #GPtrArray. - - pointer to retrieve the number of + + pointer to retrieve the number of elements of the original array - - Removes the pointer at the given index from the pointer array. + + Removes the pointer at the given index from the pointer array. The following elements are moved down one place. The #GDestroyNotify for @array is *not* called on the removed element; ownership is transferred to the caller of this function. - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to steal + the index of the pointer to steal - - Removes the pointer at the given index from the pointer array. + + Removes the pointer at the given index from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_steal_index(). The #GDestroyNotify for @array is @@ -27333,35 +19620,24 @@ is faster than g_ptr_array_steal_index(). The #GDestroyNotify for @array is of this function. - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to steal + the index of the pointer to steal - - Atomically decrements the reference count of @array by one. If the + + Atomically decrements the reference count of @array by one. If the reference count drops to 0, the effect is the same as calling g_ptr_array_free() with @free_segment set to %TRUE. This function is thread-safe and may be called from any thread. @@ -27371,9 +19647,7 @@ is thread-safe and may be called from any thread. - A #GPtrArray + A #GPtrArray @@ -27382,37 +19656,27 @@ is thread-safe and may be called from any thread. - Contains the public fields of a + Contains the public fields of a [Queue][glib-Double-ended-Queues]. - a pointer to the first element of the queue + a pointer to the first element of the queue - a pointer to the last element of the queue + a pointer to the last element of the queue - the number of elements in the queue + the number of elements in the queue - Removes all the elements in @queue. If queue elements contain + Removes all the elements in @queue. If queue elements contain dynamically-allocated memory, they should be freed first. @@ -27420,19 +19684,13 @@ dynamically-allocated memory, they should be freed first. - a #GQueue + a #GQueue - - Convenience method, which frees all the memory used by a #GQueue, + + Convenience method, which frees all the memory used by a #GQueue, and calls the provided @free_func on each item in the #GQueue. @@ -27440,55 +19698,33 @@ and calls the provided @free_func on each item in the #GQueue. - a pointer to a #GQueue + a pointer to a #GQueue - - the function to be called to free memory allocated + + the function to be called to free memory allocated - - Copies a @queue. Note that is a shallow copy. If the elements in the + + Copies a @queue. Note that is a shallow copy. If the elements in the queue consist of pointers to data, the pointers are copied, but the actual data is not. - a copy of @queue + a copy of @queue - a #GQueue + a #GQueue - - Removes @link_ from @queue and frees it. + + Removes @link_ from @queue and frees it. @link_ must be part of @queue. @@ -27497,107 +19733,68 @@ actual data is not. - a #GQueue + a #GQueue - a #GList link that must be part of @queue + a #GList link that must be part of @queue - - Finds the first link in @queue which contains @data. + + Finds the first link in @queue which contains @data. - the first link in @queue which contains @data + the first link in @queue which contains @data - a #GQueue + a #GQueue - - data to find + + data to find - - Finds an element in a #GQueue, using a supplied function to find the + + Finds an element in a #GQueue, using a supplied function to find the desired element. It iterates over the queue, calling the given function which should return 0 when the desired element is found. The function takes two gconstpointer arguments, the #GQueue element's data as the first argument and the given user data as the second argument. - the found link, or %NULL if it wasn't found + the found link, or %NULL if it wasn't found - a #GQueue + a #GQueue - - user data passed to @func + + user data passed to @func - a #GCompareFunc to call for each element. It should return 0 + a #GCompareFunc to call for each element. It should return 0 when the desired element is found - - Calls @func for each element in the queue passing @user_data to the + + Calls @func for each element in the queue passing @user_data to the function. It is safe for @func to remove the element from @queue, but it must @@ -27608,32 +19805,21 @@ not modify any part of the queue after that element. - a #GQueue + a #GQueue - the function to call for each element's data + the function to call for each element's data - - user data to pass to @func + + user data to pass to @func - Frees the memory allocated for the #GQueue. Only call this function + Frees the memory allocated for the #GQueue. Only call this function if @queue was created with g_queue_new(). If queue elements contain dynamically-allocated memory, they should be freed first. @@ -27645,17 +19831,13 @@ either use g_queue_free_full() or free them manually first. - a #GQueue + a #GQueue - Convenience method, which frees all the memory used by a #GQueue, + Convenience method, which frees all the memory used by a #GQueue, and calls the specified destroy function on every element's data. @free_func should not modify the queue (eg, by removing the freed @@ -27666,75 +19848,50 @@ element from it). - a pointer to a #GQueue + a pointer to a #GQueue - the function to be called to free each element's data + the function to be called to free each element's data - - Returns the number of items in @queue. + + Returns the number of items in @queue. - the number of items in @queue + the number of items in @queue - a #GQueue + a #GQueue - Returns the position of the first element in @queue which contains @data. + Returns the position of the first element in @queue which contains @data. - the position of the first element in @queue which + the position of the first element in @queue which contains @data, or -1 if no element in @queue contains @data - a #GQueue + a #GQueue - - the data to find + + the data to find - A statically-allocated #GQueue must be initialized with this function + A statically-allocated #GQueue must be initialized with this function before it can be used. Alternatively you can initialize it with #G_QUEUE_INIT. It is not necessary to initialize queues created with g_queue_new(). @@ -27744,20 +19901,13 @@ g_queue_new(). - an uninitialized #GQueue + an uninitialized #GQueue - - Inserts @data into @queue after @sibling. + + Inserts @data into @queue after @sibling. @sibling must be part of @queue. Since GLib 2.44 a %NULL sibling pushes the data at the head of the queue. @@ -27767,41 +19917,24 @@ data at the head of the queue. - a #GQueue + a #GQueue - - a #GList link that must be part of @queue, or %NULL to + + a #GList link that must be part of @queue, or %NULL to push at the head of the queue. - - the data to insert + + the data to insert - - Inserts @link_ into @queue after @sibling. + + Inserts @link_ into @queue after @sibling. @sibling must be part of @queue. @@ -27810,40 +19943,26 @@ data at the head of the queue. - a #GQueue + a #GQueue - - a #GList link that must be part of @queue, or %NULL to + + a #GList link that must be part of @queue, or %NULL to push at the head of the queue. - a #GList link to insert which must not be part of any other list. + a #GList link to insert which must not be part of any other list. - - Inserts @data into @queue before @sibling. + + Inserts @data into @queue before @sibling. @sibling must be part of @queue. Since GLib 2.44 a %NULL sibling pushes the data at the tail of the queue. @@ -27853,41 +19972,24 @@ data at the tail of the queue. - a #GQueue + a #GQueue - - a #GList link that must be part of @queue, or %NULL to + + a #GList link that must be part of @queue, or %NULL to push at the tail of the queue. - - the data to insert + + the data to insert - - Inserts @link_ into @queue before @sibling. + + Inserts @link_ into @queue before @sibling. @sibling must be part of @queue. @@ -27896,127 +19998,82 @@ data at the tail of the queue. - a #GQueue + a #GQueue - - a #GList link that must be part of @queue, or %NULL to + + a #GList link that must be part of @queue, or %NULL to push at the tail of the queue. - a #GList link to insert which must not be part of any other list. + a #GList link to insert which must not be part of any other list. - - Inserts @data into @queue using @func to determine the new position. + + Inserts @data into @queue using @func to determine the new position. - a #GQueue + a #GQueue - - the data to insert + + the data to insert - the #GCompareDataFunc used to compare elements in the queue. It is + the #GCompareDataFunc used to compare elements in the queue. It is called with two elements of the @queue and @user_data. It should return 0 if the elements are equal, a negative value if the first element comes before the second, and a positive value if the second element comes before the first. - - user data passed to @func + + user data passed to @func - Returns %TRUE if the queue is empty. + Returns %TRUE if the queue is empty. - %TRUE if the queue is empty + %TRUE if the queue is empty - a #GQueue. + a #GQueue. - - Returns the position of @link_ in @queue. + + Returns the position of @link_ in @queue. - the position of @link_, or -1 if the link is + the position of @link_, or -1 if the link is not part of @queue - a #GQueue + a #GQueue - a #GList link + a #GList link @@ -28024,90 +20081,60 @@ data at the tail of the queue. - Returns the first element of the queue. + Returns the first element of the queue. - the data of the first element in the queue, or %NULL + the data of the first element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - - Returns the first link in @queue. + + Returns the first link in @queue. - the first link in @queue, or %NULL if @queue is empty + the first link in @queue, or %NULL if @queue is empty - a #GQueue + a #GQueue - Returns the @n'th element of @queue. + Returns the @n'th element of @queue. - the data for the @n'th element of @queue, + the data for the @n'th element of @queue, or %NULL if @n is off the end of @queue - a #GQueue + a #GQueue - the position of the element + the position of the element - - Returns the link at the given position + + Returns the link at the given position - the link at the @n'th position, or %NULL + the link at the @n'th position, or %NULL if @n is off the end of the list @@ -28115,97 +20142,66 @@ data at the tail of the queue. - a #GQueue + a #GQueue - the position of the link + the position of the link - Returns the last element of the queue. + Returns the last element of the queue. - the data of the last element in the queue, or %NULL + the data of the last element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - - Returns the last link in @queue. + + Returns the last link in @queue. - the last link in @queue, or %NULL if @queue is empty + the last link in @queue, or %NULL if @queue is empty - a #GQueue + a #GQueue - Removes the first element of the queue and returns its data. + Removes the first element of the queue and returns its data. - the data of the first element in the queue, or %NULL + the data of the first element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - - Removes and returns the first element of the queue. + + Removes and returns the first element of the queue. - the #GList element at the head of the queue, or %NULL + the #GList element at the head of the queue, or %NULL if the queue is empty @@ -28213,102 +20209,69 @@ data at the tail of the queue. - a #GQueue + a #GQueue - Removes the @n'th element of @queue and returns its data. + Removes the @n'th element of @queue and returns its data. - the element's data, or %NULL if @n is off the end of @queue + the element's data, or %NULL if @n is off the end of @queue - a #GQueue + a #GQueue - the position of the element + the position of the element - - Removes and returns the link at the given position. + + Removes and returns the link at the given position. - the @n'th link, or %NULL if @n is off the end of @queue + the @n'th link, or %NULL if @n is off the end of @queue - a #GQueue + a #GQueue - the link's position + the link's position - Removes the last element of the queue and returns its data. + Removes the last element of the queue and returns its data. - the data of the last element in the queue, or %NULL + the data of the last element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - - Removes and returns the last element of the queue. + + Removes and returns the last element of the queue. - the #GList element at the tail of the queue, or %NULL + the #GList element at the tail of the queue, or %NULL if the queue is empty @@ -28316,60 +20279,41 @@ data at the tail of the queue. - a #GQueue + a #GQueue - Adds a new element at the head of the queue. + Adds a new element at the head of the queue. - a #GQueue. + a #GQueue. - - the data for the new element. + + the data for the new element. - - Adds a new element at the head of the queue. + + Adds a new element at the head of the queue. - a #GQueue + a #GQueue - a single #GList element, not a list with more than one element + a single #GList element, not a list with more than one element @@ -28377,69 +20321,47 @@ data at the tail of the queue. - Inserts a new element into @queue at the given position. + Inserts a new element into @queue at the given position. - a #GQueue + a #GQueue - - the data for the new element + + the data for the new element - the position to insert the new element. If @n is negative or + the position to insert the new element. If @n is negative or larger than the number of elements in the @queue, the element is added to the end of the queue. - - Inserts @link into @queue at the given position. + + Inserts @link into @queue at the given position. - a #GQueue + a #GQueue - the position to insert the link. If this is negative or larger than + the position to insert the link. If this is negative or larger than the number of elements in @queue, the link is added to the end of @queue. - the link to add to @queue + the link to add to @queue @@ -28447,52 +20369,35 @@ data at the tail of the queue. - Adds a new element at the tail of the queue. + Adds a new element at the tail of the queue. - a #GQueue + a #GQueue - - the data for the new element + + the data for the new element - - Adds a new element at the tail of the queue. + + Adds a new element at the tail of the queue. - a #GQueue + a #GQueue - a single #GList element, not a list with more than one element + a single #GList element, not a list with more than one element @@ -28500,127 +20405,80 @@ data at the tail of the queue. - Removes the first element in @queue that contains @data. + Removes the first element in @queue that contains @data. - %TRUE if @data was found and removed from @queue + %TRUE if @data was found and removed from @queue - a #GQueue + a #GQueue - - the data to remove + + the data to remove - - Remove all elements whose data equals @data from @queue. + + Remove all elements whose data equals @data from @queue. - the number of elements removed from @queue + the number of elements removed from @queue - a #GQueue + a #GQueue - - the data to remove + + the data to remove - Reverses the order of the items in @queue. + Reverses the order of the items in @queue. - a #GQueue + a #GQueue - - Sorts @queue using @compare_func. + + Sorts @queue using @compare_func. - a #GQueue + a #GQueue - the #GCompareDataFunc used to sort @queue. This function + the #GCompareDataFunc used to sort @queue. This function is passed two elements of the queue and should return 0 if they are equal, a negative value if the first comes before the second, and a positive value if the second comes before the first. - - user data passed to @compare_func + + user data passed to @compare_func - - Unlinks @link_ so that it will no longer be part of @queue. + + Unlinks @link_ so that it will no longer be part of @queue. The link is not freed. @link_ must be part of @queue. @@ -28630,15 +20488,11 @@ The link is not freed. - a #GQueue + a #GQueue - a #GList link that must be part of @queue + a #GList link that must be part of @queue @@ -28646,22 +20500,16 @@ The link is not freed. - Creates a new #GQueue. + Creates a new #GQueue. - a newly allocated #GQueue + a newly allocated #GQueue - The GRWLock struct is an opaque data structure to represent a + The GRWLock struct is an opaque data structure to represent a reader-writer lock. It is similar to a #GMutex in that it allows multiple threads to coordinate access to a shared resource. @@ -28734,9 +20582,7 @@ A GRWLock should only be accessed with the g_rw_lock_ functions. - Frees the resources allocated to a lock with g_rw_lock_init(). + Frees the resources allocated to a lock with g_rw_lock_init(). This function should not be used with a #GRWLock that has been statically allocated. @@ -28751,17 +20597,13 @@ Sine: 2.32 - an initialized #GRWLock + an initialized #GRWLock - Initializes a #GRWLock so that it can be used. + Initializes a #GRWLock so that it can be used. This function is useful to initialize a lock that has been allocated on the stack, or as part of a larger structure. It is not @@ -28791,26 +20633,26 @@ to undefined behaviour. - an uninitialized #GRWLock + an uninitialized #GRWLock - - Obtain a read lock on @rw_lock. If another thread currently holds -the write lock on @rw_lock, the current thread will block. If another thread -does not hold the write lock, but is waiting for it, it is implementation -defined whether the reader or writer will block. Read locks can be taken + + Obtain a read lock on @rw_lock. If another thread currently holds +the write lock on @rw_lock, the current thread will block until the +write lock was (held and) released. If another thread does not hold +the write lock, but is waiting for it, it is implementation defined +whether the reader or writer will block. Read locks can be taken recursively. -It is implementation-defined how many threads are allowed to -hold read locks on the same lock simultaneously. If the limit is hit, +Calling g_rw_lock_reader_lock() while the current thread already +owns a write lock leads to undefined behaviour. Read locks however +can be taken recursively, in which case you need to make sure to +call g_rw_lock_reader_unlock() the same amount of times. + +It is implementation-defined how many read locks are allowed to be +held on the same lock simultaneously. If the limit is hit, or if a deadlock is detected, a critical warning will be emitted. @@ -28818,43 +20660,29 @@ or if a deadlock is detected, a critical warning will be emitted. - a #GRWLock + a #GRWLock - - Tries to obtain a read lock on @rw_lock and returns %TRUE if + + Tries to obtain a read lock on @rw_lock and returns %TRUE if the read lock was successfully obtained. Otherwise it returns %FALSE. - %TRUE if @rw_lock could be locked + %TRUE if @rw_lock could be locked - a #GRWLock + a #GRWLock - - Release a read lock on @rw_lock. + + Release a read lock on @rw_lock. Calling g_rw_lock_reader_unlock() on a lock that is not held by the current thread leads to undefined behaviour. @@ -28864,64 +20692,48 @@ by the current thread leads to undefined behaviour. - a #GRWLock + a #GRWLock - - Obtain a write lock on @rw_lock. If any thread already holds + + Obtain a write lock on @rw_lock. If another thread currently holds a read or write lock on @rw_lock, the current thread will block -until all other threads have dropped their locks on @rw_lock. +until all other threads have dropped their locks on @rw_lock. + +Calling g_rw_lock_writer_lock() while the current thread already +owns a read or write lock on @rw_lock leads to undefined behaviour. - a #GRWLock + a #GRWLock - - Tries to obtain a write lock on @rw_lock. If any other thread holds -a read or write lock on @rw_lock, it immediately returns %FALSE. + + Tries to obtain a write lock on @rw_lock. If another thread +currently holds a read or write lock on @rw_lock, it immediately +returns %FALSE. Otherwise it locks @rw_lock and returns %TRUE. - %TRUE if @rw_lock could be locked + %TRUE if @rw_lock could be locked - a #GRWLock + a #GRWLock - - Release a write lock on @rw_lock. + + Release a write lock on @rw_lock. Calling g_rw_lock_writer_unlock() on a lock that is not held by the current thread leads to undefined behaviour. @@ -28931,199 +20743,140 @@ by the current thread leads to undefined behaviour. - a #GRWLock + a #GRWLock - The GRand struct is an opaque data structure. It should only be + The GRand struct is an opaque data structure. It should only be accessed through the g_rand_* functions. - - Copies a #GRand into a new one with the same exact state as before. + + Copies a #GRand into a new one with the same exact state as before. This way you can take a snapshot of the random number generator for replaying later. - the new #GRand + the new #GRand - a #GRand + a #GRand - Returns the next random #gdouble from @rand_ equally distributed over + Returns the next random #gdouble from @rand_ equally distributed over the range [0..1). - a random number + a random number - a #GRand + a #GRand - Returns the next random #gdouble from @rand_ equally distributed over + Returns the next random #gdouble from @rand_ equally distributed over the range [@begin..@end). - a random number + a random number - a #GRand + a #GRand - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Frees the memory allocated for the #GRand. + Frees the memory allocated for the #GRand. - a #GRand + a #GRand - Returns the next random #guint32 from @rand_ equally distributed over + Returns the next random #guint32 from @rand_ equally distributed over the range [0..2^32-1]. - a random number + a random number - a #GRand + a #GRand - Returns the next random #gint32 from @rand_ equally distributed over + Returns the next random #gint32 from @rand_ equally distributed over the range [@begin..@end-1]. - a random number + a random number - a #GRand + a #GRand - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Sets the seed for the random number generator #GRand to @seed. + Sets the seed for the random number generator #GRand to @seed. - a #GRand + a #GRand - a value to reinitialize the random number generator + a value to reinitialize the random number generator - - Initializes the random number generator by an array of longs. + + Initializes the random number generator by an array of longs. Array can be of arbitrary size, though only the first 624 values are taken. This function is useful if you have many low entropy seeds, or if you require more then 32 bits of actual entropy for @@ -29134,88 +20887,59 @@ your application. - a #GRand + a #GRand - array to initialize with + array to initialize with - length of array + length of array - Creates a new random number generator initialized with a seed taken + Creates a new random number generator initialized with a seed taken either from `/dev/urandom` (if existing) or from the current time (as a fallback). On Windows, the seed is taken from rand_s(). - the new #GRand + the new #GRand - - Creates a new random number generator initialized with @seed. + + Creates a new random number generator initialized with @seed. - the new #GRand + the new #GRand - a value to initialize the random number generator + a value to initialize the random number generator - - Creates a new random number generator initialized with @seed. + + Creates a new random number generator initialized with @seed. - the new #GRand + the new #GRand - an array of seeds to initialize the random number generator + an array of seeds to initialize the random number generator - an array of seeds to initialize the random number + an array of seeds to initialize the random number generator @@ -29223,9 +20947,7 @@ On Windows, the seed is taken from rand_s(). - The GRecMutex struct is an opaque data structure to represent a + The GRecMutex struct is an opaque data structure to represent a recursive mutex. It is similar to a #GMutex with the difference that it is possible to lock a GRecMutex multiple times in the same thread without deadlock. When doing so, care has to be taken to @@ -29247,9 +20969,7 @@ g_rec_mutex_ functions. - Frees the resources allocated to a recursive mutex with + Frees the resources allocated to a recursive mutex with g_rec_mutex_init(). This function should not be used with a #GRecMutex that has been @@ -29265,17 +20985,13 @@ Sine: 2.32 - an initialized #GRecMutex + an initialized #GRecMutex - Initializes a #GRecMutex so that it can be used. + Initializes a #GRecMutex so that it can be used. This function is useful to initialize a recursive mutex that has been allocated on the stack, or as part of a larger @@ -29307,17 +21023,13 @@ is no longer needed, use g_rec_mutex_clear(). - an uninitialized #GRecMutex + an uninitialized #GRecMutex - Locks @rec_mutex. If @rec_mutex is already locked by another + Locks @rec_mutex. If @rec_mutex is already locked by another thread, the current thread will block until @rec_mutex is unlocked by the other thread. If @rec_mutex is already locked by the current thread, the 'lock count' of @rec_mutex is increased. @@ -29329,39 +21041,29 @@ as many times as it has been locked. - a #GRecMutex + a #GRecMutex - Tries to lock @rec_mutex. If @rec_mutex is already locked + Tries to lock @rec_mutex. If @rec_mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @rec_mutex and returns %TRUE. - %TRUE if @rec_mutex could be locked + %TRUE if @rec_mutex could be locked - a #GRecMutex + a #GRecMutex - Unlocks @rec_mutex. If another thread is blocked in a + Unlocks @rec_mutex. If another thread is blocked in a g_rec_mutex_lock() call for @rec_mutex, it will become unblocked and can lock @rec_mutex itself. @@ -29373,23 +21075,14 @@ locked by the current thread leads to undefined behaviour. - a #GRecMutex + a #GRecMutex - - The g_regex_*() functions implement regular + + The g_regex_*() functions implement regular expression pattern matching using syntax and semantics similar to Perl regular expression. @@ -29409,7 +21102,7 @@ preceded by a letter. Note that, unless you set the #G_REGEX_RAW flag, all the strings passed to these functions must be encoded in UTF-8. The lengths and the positions inside the strings are in bytes and not in characters, so, for instance, -"\xc3\xa0" (i.e. "à") is two bytes long but it is treated as a +"\xc3\xa0" (i.e. "à") is two bytes long but it is treated as a single character. If you set #G_REGEX_RAW the strings can be non-valid UTF-8 strings and a byte is treated as a character, so "\xc3\xa0" is two bytes and two characters long. @@ -29455,239 +21148,158 @@ the excellent [PCRE](http://www.pcre.org/) library written by Philip Hazel. - - Compiles the regular expression to an internal form, and does + + Compiles the regular expression to an internal form, and does the initial setup of the #GRegex structure. - a #GRegex structure or %NULL if an error occurred. Call + a #GRegex structure or %NULL if an error occurred. Call g_regex_unref() when you are done with it - the regular expression + the regular expression - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options for the regular expression, or 0 + match options for the regular expression, or 0 - - Returns the number of capturing subpatterns in the pattern. + + Returns the number of capturing subpatterns in the pattern. - the number of capturing subpatterns + the number of capturing subpatterns - a #GRegex + a #GRegex - - Returns the compile options that @regex was created with. + + Returns the compile options that @regex was created with. Depending on the version of PCRE that is used, this may or may not include flags set by option expressions such as `(?i)` found at the top-level within the compiled pattern. - flags from #GRegexCompileFlags + flags from #GRegexCompileFlags - a #GRegex + a #GRegex - - Checks whether the pattern contains explicit CR or LF references. + + Checks whether the pattern contains explicit CR or LF references. - %TRUE if the pattern contains explicit CR or LF references + %TRUE if the pattern contains explicit CR or LF references - a #GRegex structure + a #GRegex structure - - Returns the match options that @regex was created with. + + Returns the match options that @regex was created with. - flags from #GRegexMatchFlags + flags from #GRegexMatchFlags - a #GRegex + a #GRegex - - Returns the number of the highest back reference + + Returns the number of the highest back reference in the pattern, or 0 if the pattern does not contain back references. - the number of the highest back reference + the number of the highest back reference - a #GRegex + a #GRegex - - Gets the number of characters in the longest lookbehind assertion in the + + Gets the number of characters in the longest lookbehind assertion in the pattern. This information is useful when doing multi-segment matching using the partial matching facilities. - the number of characters in the longest lookbehind assertion. + the number of characters in the longest lookbehind assertion. - a #GRegex structure + a #GRegex structure - - Gets the pattern string associated with @regex, i.e. a copy of + + Gets the pattern string associated with @regex, i.e. a copy of the string passed to g_regex_new(). - the pattern of @regex + the pattern of @regex - a #GRegex structure + a #GRegex structure - - Retrieves the number of the subexpression named @name. + + Retrieves the number of the subexpression named @name. - The number of the subexpression or -1 if @name + The number of the subexpression or -1 if @name does not exists - #GRegex structure + #GRegex structure - name of the subexpression + name of the subexpression - Scans for a match in @string for the pattern in @regex. + Scans for a match in @string for the pattern in @regex. The @match_options are combined with the match options specified when the @regex structure was created, letting you have more flexibility in reusing #GRegex structures. @@ -29729,48 +21341,31 @@ you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - match options + match options - - pointer to location where to store + + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - Using the standard algorithm for regular expression matching only + Using the standard algorithm for regular expression matching only the longest match in the string is retrieved. This function uses a different algorithm so it can retrieve all the possible matches. For more documentation see g_regex_match_all_full(). @@ -29786,51 +21381,31 @@ you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - match options + match options - - pointer to location where to store + + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - - Using the standard algorithm for regular expression matching only + + Using the standard algorithm for regular expression matching only the longest match in the @string is retrieved, it is not possible to obtain all the available matches. For instance matching "<a> <b> <c>" against the pattern "<.*>" @@ -29870,65 +21445,41 @@ you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - match options + match options - - pointer to location where to store + + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - - Scans for a match in @string for the pattern in @regex. + + Scans for a match in @string for the pattern in @regex. The @match_options are combined with the match options specified when the @regex structure was created, letting you have more flexibility in reusing #GRegex structures. @@ -29981,85 +21532,55 @@ print_uppercase_words (const gchar *string) ]| - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - match options + match options - - pointer to location where to store + + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - Increases reference count of @regex by 1. + Increases reference count of @regex by 1. - @regex + @regex - a #GRegex + a #GRegex - - Replaces all occurrences of the pattern in @regex with the + + Replaces all occurrences of the pattern in @regex with the replacement text. Backreferences of the form '\number' or '\g<number>' in the replacement text are interpolated by the number-th captured subexpression of the match, '\g<name>' refers @@ -30087,60 +21608,40 @@ string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b". - a newly allocated string containing the replacements + a newly allocated string containing the replacements - a #GRegex structure + a #GRegex structure - the string to perform matches against + the string to perform matches against - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - text to replace each match with + text to replace each match with - options for the match + options for the match - - Replaces occurrences of the pattern in regex with the output of + + Replaces occurrences of the pattern in regex with the output of @eval for that occurrence. Setting @start_position differs from just passing over a shortened @@ -30187,68 +21688,44 @@ g_hash_table_destroy (h); ]| - a newly allocated string containing the replacements + a newly allocated string containing the replacements - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - string to perform matches against + string to perform matches against - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - options for the match + options for the match - a function to call for each match + a function to call for each match - - user data to pass to the function + + user data to pass to the function - - Replaces all occurrences of the pattern in @regex with the + + Replaces all occurrences of the pattern in @regex with the replacement text. @replacement is replaced literally, to include backreferences use g_regex_replace(). @@ -30258,56 +21735,40 @@ case of a pattern that begins with any kind of lookbehind assertion, such as "\b". - a newly allocated string containing the replacements + a newly allocated string containing the replacements - a #GRegex structure + a #GRegex structure - the string to perform matches against + the string to perform matches against - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - text to replace each match with + text to replace each match with - options for the match + options for the match - Breaks the string on the pattern, and returns an array of the tokens. + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first @@ -30326,9 +21787,7 @@ For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c". - a %NULL-terminated gchar ** array. Free + a %NULL-terminated gchar ** array. Free it using g_strfreev() @@ -30336,32 +21795,21 @@ it using g_strfreev() - a #GRegex structure + a #GRegex structure - the string to split with the pattern + the string to split with the pattern - match time option flags + match time option flags - - Breaks the string on the pattern, and returns an array of the tokens. + + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first @@ -30384,9 +21832,7 @@ string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b". - a %NULL-terminated gchar ** array. Free + a %NULL-terminated gchar ** array. Free it using g_strfreev() @@ -30394,50 +21840,36 @@ it using g_strfreev() - a #GRegex structure + a #GRegex structure - the string to split with the pattern + the string to split with the pattern - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - match time option flags + match time option flags - the maximum number of tokens to split @string into. + the maximum number of tokens to split @string into. If this is less than 1, the string is split completely - Decreases reference count of @regex by 1. When reference count drops + Decreases reference count of @regex by 1. When reference count drops to zero, it frees all the memory associated with the regex structure. @@ -30445,20 +21877,13 @@ to zero, it frees all the memory associated with the regex structure. - a #GRegex + a #GRegex - - Checks whether @replacement is a valid replacement string + + Checks whether @replacement is a valid replacement string (see g_regex_replace()), i.e. that all escape sequences in it are valid. @@ -30469,27 +21894,16 @@ about actual match, but '\0\1' (whole match followed by first subpattern) requires valid #GMatchInfo object. - whether @replacement is a valid replacement string + whether @replacement is a valid replacement string - the replacement string + the replacement string - - location to store information about + + location to store information about references in @replacement or %NULL @@ -30500,44 +21914,30 @@ subpattern) requires valid #GMatchInfo object. - - Escapes the nul characters in @string to "\x00". It can be used + + Escapes the nul characters in @string to "\x00". It can be used to compile a regex with embedded nul characters. For completeness, @length can be -1 for a nul-terminated string. In this case the output string will be of course equal to @string. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string + the length of @string - - Escapes the special characters used for regular expressions + + Escapes the special characters used for regular expressions in @string, for instance "a.b*c" becomes "a\.b\*c". This function is useful to dynamically generate regular expressions. @@ -30546,34 +21946,24 @@ in this case remember to specify the correct length of @string in @length. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - - Scans for a match in @string for @pattern. + + Scans for a match in @string for @pattern. This function is equivalent to g_regex_match() but it does not require to compile the pattern with g_regex_new(), avoiding some @@ -30585,44 +21975,30 @@ once, it's more efficient to compile the pattern once with g_regex_new() and then use g_regex_match(). - %TRUE if the string matched, %FALSE otherwise + %TRUE if the string matched, %FALSE otherwise - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - - Breaks the string on the pattern, and returns an array of + + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the @@ -30651,9 +22027,7 @@ characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c". - a %NULL-terminated array of strings. Free + a %NULL-terminated array of strings. Free it using g_strfreev() @@ -30661,50 +22035,34 @@ it using g_strfreev() - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - - Flags specifying compile-time options. + + Flags specifying compile-time options. - Letters in the pattern match both upper- and + Letters in the pattern match both upper- and lowercase letters. This option can be changed within a pattern by a "(?i)" option setting. - By default, GRegex treats the strings as consisting + By default, GRegex treats the strings as consisting of a single line of characters (even if it actually contains newlines). The "start of line" metacharacter ("^") matches only at the start of the string, while the "end of line" metacharacter @@ -30717,16 +22075,12 @@ it using g_strfreev() setting. - A dot metacharacter (".") in the pattern matches all + A dot metacharacter (".") in the pattern matches all characters, including newlines. Without it, newlines are excluded. This option can be changed within a pattern by a ("?s") option setting. - Whitespace data characters in the pattern are + Whitespace data characters in the pattern are totally ignored except when escaped or inside a character class. Whitespace does not include the VT character (code 11). In addition, characters between an unescaped "#" outside a character class and @@ -30734,626 +22088,337 @@ it using g_strfreev() be changed within a pattern by a "(?x)" option setting. - The pattern is forced to be "anchored", that is, + The pattern is forced to be "anchored", that is, it is constrained to match only at the first matching point in the string that is being searched. This effect can also be achieved by appropriate constructs in the pattern itself such as the "^" metacharacter. - - A dollar metacharacter ("$") in the pattern + + A dollar metacharacter ("$") in the pattern matches only at the end of the string. Without this option, a dollar also matches immediately before the final character if it is a newline (but not before any other newlines). This option is ignored if #G_REGEX_MULTILINE is set. - Inverts the "greediness" of the quantifiers so that + Inverts the "greediness" of the quantifiers so that they are not greedy by default, but become greedy if followed by "?". It can also be set by a "(?U)" option setting within the pattern. - Usually strings must be valid UTF-8 strings, using this + Usually strings must be valid UTF-8 strings, using this flag they are considered as a raw sequence of bytes. - - Disables the use of numbered capturing + + Disables the use of numbered capturing parentheses in the pattern. Any opening parenthesis that is not followed by "?" behaves as if it were followed by "?:" but named parentheses can still be used for capturing (and they acquire numbers in the usual way). - Optimize the regular expression. If the pattern will + Optimize the regular expression. If the pattern will be used many times, then it may be worth the effort to optimize it to improve the speed of matches. - Limits an unanchored pattern to match before (or at) the + Limits an unanchored pattern to match before (or at) the first newline. Since: 2.34 - Names used to identify capturing subpatterns need not + Names used to identify capturing subpatterns need not be unique. This can be helpful for certain types of pattern when it is known that only one instance of the named subpattern can ever be matched. - - Usually any newline character or character sequence is + + Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character is '\r'. - - Usually any newline character or character sequence is + + Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character is '\n'. - - Usually any newline character or character sequence is + + Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character sequence is '\r\n'. - - Usually any newline character or character sequence + + Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character sequences are '\r', '\n', and '\r\n'. Since: 2.34 - - Usually any newline character or character sequence + + Usually any newline character or character sequence is recognised. If this option is set, then "\R" only recognizes the newline characters '\r', '\n' and '\r\n'. Since: 2.34 - - Changes behaviour so that it is compatible with + + Changes behaviour so that it is compatible with JavaScript rather than PCRE. Since: 2.34 - - Error codes returned by regular expressions functions. + + Error codes returned by regular expressions functions. - Compilation of the regular expression failed. + Compilation of the regular expression failed. - Optimization of the regular expression failed. + Optimization of the regular expression failed. - Replacement failed due to an ill-formed replacement + Replacement failed due to an ill-formed replacement string. - The match process failed. + The match process failed. - Internal error of the regular expression engine. + Internal error of the regular expression engine. Since 2.16 - - "\\" at end of pattern. Since 2.16 + + "\\" at end of pattern. Since 2.16 - - "\\c" at end of pattern. Since 2.16 + + "\\c" at end of pattern. Since 2.16 - - Unrecognized character follows "\\". + + Unrecognized character follows "\\". Since 2.16 - - Numbers out of order in "{}" + + Numbers out of order in "{}" quantifier. Since 2.16 - - Number too big in "{}" quantifier. + + Number too big in "{}" quantifier. Since 2.16 - - Missing terminating "]" for + + Missing terminating "]" for character class. Since 2.16 - - Invalid escape sequence + + Invalid escape sequence in character class. Since 2.16 - - Range out of order in character class. + + Range out of order in character class. Since 2.16 - - Nothing to repeat. Since 2.16 + + Nothing to repeat. Since 2.16 - - Unrecognized character after "(?", + + Unrecognized character after "(?", "(?<" or "(?P". Since 2.16 - - POSIX named classes are + + POSIX named classes are supported only within a class. Since 2.16 - - Missing terminating ")" or ")" + + Missing terminating ")" or ")" without opening "(". Since 2.16 - - Reference to non-existent + + Reference to non-existent subpattern. Since 2.16 - - Missing terminating ")" after comment. + + Missing terminating ")" after comment. Since 2.16 - - Regular expression too large. + + Regular expression too large. Since 2.16 - - Failed to get memory. Since 2.16 + + Failed to get memory. Since 2.16 - - Lookbehind assertion is not + + Lookbehind assertion is not fixed length. Since 2.16 - - Malformed number or name after "(?(". + + Malformed number or name after "(?(". Since 2.16 - - Conditional group contains + + Conditional group contains more than two branches. Since 2.16 - - Assertion expected after "(?(". + + Assertion expected after "(?(". Since 2.16 - - Unknown POSIX class name. + + Unknown POSIX class name. Since 2.16 - - POSIX collating + + POSIX collating elements are not supported. Since 2.16 - - Character value in "\\x{...}" sequence + + Character value in "\\x{...}" sequence is too large. Since 2.16 - - Invalid condition "(?(0)". Since 2.16 + + Invalid condition "(?(0)". Since 2.16 - - \\C not allowed in + + \\C not allowed in lookbehind assertion. Since 2.16 - - Recursive call could loop indefinitely. + + Recursive call could loop indefinitely. Since 2.16 - - Missing terminator + + Missing terminator in subpattern name. Since 2.16 - - Two named subpatterns have + + Two named subpatterns have the same name. Since 2.16 - - Malformed "\\P" or "\\p" sequence. + + Malformed "\\P" or "\\p" sequence. Since 2.16 - - Unknown property name after "\\P" or + + Unknown property name after "\\P" or "\\p". Since 2.16 - - Subpattern name is too long + + Subpattern name is too long (maximum 32 characters). Since 2.16 - - Too many named subpatterns (maximum + + Too many named subpatterns (maximum 10,000). Since 2.16 - - Octal value is greater than "\\377". + + Octal value is greater than "\\377". Since 2.16 - - "DEFINE" group contains more + + "DEFINE" group contains more than one branch. Since 2.16 - - Repeating a "DEFINE" group is not allowed. + + Repeating a "DEFINE" group is not allowed. This error is never raised. Since: 2.16 Deprecated: 2.34 - - Inconsistent newline options. + + Inconsistent newline options. Since 2.16 - - "\\g" is not followed by a braced, + + "\\g" is not followed by a braced, angle-bracketed, or quoted name or number, or by a plain number. Since: 2.16 - - relative reference must not be zero. Since: 2.34 + + relative reference must not be zero. Since: 2.34 - - the backtracing + + the backtracing control verb used does not allow an argument. Since: 2.34 - - unknown backtracing + + unknown backtracing control verb. Since: 2.34 - - number is too big in escape sequence. Since: 2.34 + + number is too big in escape sequence. Since: 2.34 - - Missing subpattern name. Since: 2.34 + + Missing subpattern name. Since: 2.34 - - Missing digit. Since 2.34 + + Missing digit. Since 2.34 - - In JavaScript compatibility mode, + + In JavaScript compatibility mode, "[" is an invalid data character. Since: 2.34 - - different names for subpatterns of the + + different names for subpatterns of the same number are not allowed. Since: 2.34 - - the backtracing control + + the backtracing control verb requires an argument. Since: 2.34 - - "\\c" must be followed by an ASCII + + "\\c" must be followed by an ASCII character. Since: 2.34 - - "\\k" is not followed by a braced, angle-bracketed, or + + "\\k" is not followed by a braced, angle-bracketed, or quoted name. Since: 2.34 - - "\\N" is not supported in a class. Since: 2.34 + + "\\N" is not supported in a class. Since: 2.34 - - too many forward references. Since: 2.34 + + too many forward references. Since: 2.34 - - the name is too long in "(*MARK)", "(*PRUNE)", + + the name is too long in "(*MARK)", "(*PRUNE)", "(*SKIP)", or "(*THEN)". Since: 2.34 - - the character value in the \\u sequence is + + the character value in the \\u sequence is too large. Since: 2.34 - - Specifies the type of the function passed to g_regex_replace_eval(). + + Specifies the type of the function passed to g_regex_replace_eval(). It is called for each occurrence of the pattern in the string passed to g_regex_replace_eval(), and it should append the replacement to @result. - %FALSE to continue the replacement process, %TRUE to stop it + %FALSE to continue the replacement process, %TRUE to stop it - the #GMatchInfo generated by the match. + the #GMatchInfo generated by the match. Use g_match_info_get_regex() and g_match_info_get_string() if you need the #GRegex or the matched string. - a #GString containing the new string + a #GString containing the new string - - user data passed to g_regex_replace_eval() + + user data passed to g_regex_replace_eval() - Flags specifying match-time options. + Flags specifying match-time options. - The pattern is forced to be "anchored", that is, + The pattern is forced to be "anchored", that is, it is constrained to match only at the first matching point in the string that is being searched. This effect can also be achieved by appropriate constructs in the pattern itself such as the "^" metacharacter. - Specifies that first character of the string is + Specifies that first character of the string is not the beginning of a line, so the circumflex metacharacter should not match before it. Setting this without #G_REGEX_MULTILINE (at compile time) causes circumflex never to match. This option affects @@ -31361,21 +22426,15 @@ to g_regex_replace_eval(), and it should append the replacement to affect "\A". - Specifies that the end of the subject string is + Specifies that the end of the subject string is not the end of a line, so the dollar metacharacter should not match it nor (except in multiline mode) a newline immediately before it. Setting this without #G_REGEX_MULTILINE (at compile time) causes dollar never to match. This option affects only the behaviour of the dollar metacharacter, it does not affect "\Z" or "\z". - - An empty string is not considered to be a valid + + An empty string is not considered to be a valid match if this option is set. If there are alternatives in the pattern, they are tried. If all the alternatives match the empty string, the entire match fails. For example, if the pattern "a?b?" is applied to @@ -31384,123 +22443,71 @@ to g_regex_replace_eval(), and it should append the replacement to valid, so GRegex searches further into the string for occurrences of "a" or "b". - - Turns on the partial matching feature, for more + + Turns on the partial matching feature, for more documentation on partial matching see g_match_info_is_partial_match(). - - Overrides the newline definition set when + + Overrides the newline definition set when creating a new #GRegex, setting the '\r' character as line terminator. - - Overrides the newline definition set when + + Overrides the newline definition set when creating a new #GRegex, setting the '\n' character as line terminator. - - Overrides the newline definition set when + + Overrides the newline definition set when creating a new #GRegex, setting the '\r\n' characters sequence as line terminator. - - Overrides the newline definition set when + + Overrides the newline definition set when creating a new #GRegex, any Unicode newline sequence is recognised as a newline. These are '\r', '\n' and '\rn', and the single characters U+000B LINE TABULATION, U+000C FORM FEED (FF), U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR. - - Overrides the newline definition set when + + Overrides the newline definition set when creating a new #GRegex; any '\r', '\n', or '\r\n' character sequence is recognized as a newline. Since: 2.34 - - Overrides the newline definition for "\R" set when + + Overrides the newline definition for "\R" set when creating a new #GRegex; only '\r', '\n', or '\r\n' character sequences are recognized as a newline by "\R". Since: 2.34 - - Overrides the newline definition for "\R" set when + + Overrides the newline definition for "\R" set when creating a new #GRegex; any Unicode newline character or character sequence are recognized as a newline by "\R". These are '\r', '\n' and '\rn', and the single characters U+000B LINE TABULATION, U+000C FORM FEED (FF), U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR. Since: 2.34 - - An alias for #G_REGEX_MATCH_PARTIAL. Since: 2.34 + + An alias for #G_REGEX_MATCH_PARTIAL. Since: 2.34 - - Turns on the partial matching feature. In contrast to + + Turns on the partial matching feature. In contrast to to #G_REGEX_MATCH_PARTIAL_SOFT, this stops matching as soon as a partial match is found, without continuing to search for a possible complete match. See g_match_info_is_partial_match() for more information. Since: 2.34 - - Like #G_REGEX_MATCH_NOTEMPTY, but only applied to + + Like #G_REGEX_MATCH_NOTEMPTY, but only applied to the start of the matched string. For anchored patterns this can only happen for pattern containing "\K". Since: 2.34 - - The search path separator character. + + The search path separator character. This is ':' on UNIX machines and ';' under Windows. - - The search path separator as a string. + + The search path separator as a string. This is ":" on UNIX machines and ";" under Windows. @@ -31509,25 +22516,16 @@ This is ":" on UNIX machines and ";" under Windows. - - Returns the size of @member in the struct definition without having a + + Returns the size of @member in the struct definition without having a declared instance of @struct_type. - + - a structure type, e.g. #GOutputVector + a structure type, e.g. #GOutputVector - a field in the structure, e.g. `size` + a field in the structure, e.g. `size` @@ -31544,47 +22542,35 @@ declared instance of @struct_type. - The #GSList struct is used for each element in the singly-linked + The #GSList struct is used for each element in the singly-linked list. - holds the element's data, which can be a pointer to any kind + holds the element's data, which can be a pointer to any kind of data, or any integer value using the [Type Conversion Macros][glib-Type-Conversion-Macros] - contains the link to the next element in the list. + contains the link to the next element in the list. - Allocates space for one #GSList element. It is called by the + Allocates space for one #GSList element. It is called by the g_slist_append(), g_slist_prepend(), g_slist_insert() and g_slist_insert_sorted() functions and so is rarely used on its own. - a pointer to the newly-allocated #GSList element. + a pointer to the newly-allocated #GSList element. - Adds a new element on to the end of the list. + Adds a new element on to the end of the list. The return value is the new start of the list, which may have changed, so make sure you store the new value. @@ -31608,61 +22594,44 @@ number_list = g_slist_append (number_list, GINT_TO_POINTER (14)); ]| - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - - the data for the new element + + the data for the new element - Adds the second #GSList onto the end of the first #GSList. + Adds the second #GSList onto the end of the first #GSList. Note that the elements of the second #GSList are not copied. They are used directly. - the start of the new #GSList + the start of the new #GSList - a #GSList + a #GSList - the #GSList to add to the end of the first #GSList + the #GSList to add to the end of the first #GSList @@ -31670,9 +22639,7 @@ They are used directly. - Copies a #GSList. + Copies a #GSList. Note that this is a "shallow" copy. If the list elements consist of pointers to data, the pointers are copied but @@ -31680,31 +22647,22 @@ the actual data isn't. See g_slist_copy_deep() if you need to copy the data as well. - a copy of @list + a copy of @list - a #GSList + a #GSList - - Makes a full (deep) copy of a #GSList. + + Makes a full (deep) copy of a #GSList. In contrast with g_slist_copy(), this function uses @func to make a copy of each list element, in addition to copying the list container itself. @@ -31712,7 +22670,7 @@ each list element, in addition to copying the list container itself. @func, as a #GCopyFunc, takes two arguments, the data to be copied and a @user_data pointer. On common processor architectures, it's safe to pass %NULL as @user_data if the copy function takes only one argument. You -may get compiler warnings from this though if compiling with GCC’s +may get compiler warnings from this though if compiling with GCC’s `-Wcast-function-type` warning. For instance, if @list holds a list of GObjects, you can do: @@ -31726,45 +22684,30 @@ g_slist_free_full (another_list, g_object_unref); ]| - a full copy of @list, use g_slist_free_full() to free it + a full copy of @list, use g_slist_free_full() to free it - a #GSList + a #GSList - a copy function used to copy every element in the list + a copy function used to copy every element in the list - - user data passed to the copy function @func, or #NULL + + user data passed to the copy function @func, or #NULL - - Removes the node link_ from the list and frees it. + + Removes the node link_ from the list and frees it. Compare this to g_slist_remove_link() which removes the node without freeing it. @@ -31775,26 +22718,20 @@ consider a different data structure, such as the doubly-linked #GList. - the new head of @list + the new head of @list - a #GSList + a #GSList - node to delete + node to delete @@ -31802,15 +22739,11 @@ consider a different data structure, such as the doubly-linked - Finds the element in a #GSList which + Finds the element in a #GSList which contains the given data. - the found #GSList element, + the found #GSList element, or %NULL if it is not found @@ -31818,30 +22751,19 @@ contains the given data. - a #GSList + a #GSList - - the element data to find + + the element data to find - - Finds an element in a #GSList, using a supplied function to + + Finds an element in a #GSList, using a supplied function to find the desired element. It iterates over the list, calling the given function which should return 0 when the desired element is found. The function takes two #gconstpointer arguments, @@ -31849,46 +22771,31 @@ the #GSList element's data as the first argument and the given user data. - the found #GSList element, or %NULL if it is not found + the found #GSList element, or %NULL if it is not found - a #GSList + a #GSList - - user data passed to the function + + user data passed to the function - the function to call for each element. + the function to call for each element. It should return 0 when the desired element is found - - Calls a function for each element of a #GSList. + + Calls a function for each element of a #GSList. It is safe for @func to remove the element from @list, but it must not modify any part of the list after that element. @@ -31898,34 +22805,23 @@ not modify any part of the list after that element. - a #GSList + a #GSList - the function to call with each element's data + the function to call with each element's data - - user data to pass to the function + + user data to pass to the function - Frees all of the memory used by a #GSList. + Frees all of the memory used by a #GSList. The freed elements are returned to the slice allocator. If list elements contain dynamically-allocated memory, @@ -31935,7 +22831,7 @@ first. It can be combined with g_steal_pointer() to ensure the list head pointer is not left dangling: |[<!-- language="C" --> -GSList *list_of_borrowed_things = …; /<!-- -->* (transfer container) *<!-- -->/ +GSList *list_of_borrowed_things = …; /<!-- -->* (transfer container) *<!-- -->/ g_slist_free (g_steal_pointer (&list_of_borrowed_things)); ]| @@ -31944,9 +22840,7 @@ g_slist_free (g_steal_pointer (&list_of_borrowed_things)); - the first link of a #GSList + the first link of a #GSList @@ -31954,9 +22848,7 @@ g_slist_free (g_steal_pointer (&list_of_borrowed_things)); - Frees one #GSList element. + Frees one #GSList element. It is usually used after g_slist_remove_link(). @@ -31964,33 +22856,26 @@ It is usually used after g_slist_remove_link(). - a #GSList element + a #GSList element - - Convenience method, which frees all the memory used by a #GSList, and + + Convenience method, which frees all the memory used by a #GSList, and calls the specified destroy function on every element's data. @free_func must not modify the list (eg, by removing the freed element from it). It can be combined with g_steal_pointer() to ensure the list head pointer -is not left dangling ­— this also has the nice property that the head pointer +is not left dangling ­— this also has the nice property that the head pointer is cleared before any of the list elements are freed, to prevent double frees from @free_func: |[<!-- language="C" --> -GSList *list_of_owned_things = …; /<!-- -->* (transfer full) (element-type GObject) *<!-- -->/ +GSList *list_of_owned_things = …; /<!-- -->* (transfer full) (element-type GObject) *<!-- -->/ g_slist_free_full (g_steal_pointer (&list_of_owned_things), g_object_unref); ]| @@ -31999,89 +22884,61 @@ g_slist_free_full (g_steal_pointer (&list_of_owned_things), g_object_unref); - the first link of a #GSList + the first link of a #GSList - the function to be called to free each element's data + the function to be called to free each element's data - Gets the position of the element containing + Gets the position of the element containing the given data (starting from 0). - the index of the element containing the data, + the index of the element containing the data, or -1 if the data is not found - a #GSList + a #GSList - - the data to find + + the data to find - Inserts a new element into the list at the given position. + Inserts a new element into the list at the given position. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - - the data for the new element + + the data for the new element - the position to insert the element. + the position to insert the element. If this is negative, or is larger than the number of elements in the list, the new element is added on to the end of the list. @@ -32089,158 +22946,103 @@ the given data (starting from 0). - - Inserts a node before @sibling containing @data. + + Inserts a node before @sibling containing @data. - the new head of the list. + the new head of the list. - a #GSList + a #GSList - node to insert @data before + node to insert @data before - - data to put in the newly-inserted node + + data to put in the newly-inserted node - - Inserts a new element into the list, using the given + + Inserts a new element into the list, using the given comparison function to determine its position. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - - the data for the new element + + the data for the new element - the function to compare elements in the list. + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. - - Inserts a new element into the list, using the given + + Inserts a new element into the list, using the given comparison function to determine its position. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - - the data for the new element + + the data for the new element - the function to compare elements in the list. + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. - - data to pass to comparison function + + data to pass to comparison function - Gets the last element in a #GSList. + Gets the last element in a #GSList. This function iterates over the whole list. - the last element in the #GSList, + the last element in the #GSList, or %NULL if the #GSList has no elements @@ -32248,9 +23050,7 @@ This function iterates over the whole list. - a #GSList + a #GSList @@ -32258,25 +23058,19 @@ This function iterates over the whole list. - Gets the number of elements in a #GSList. + Gets the number of elements in a #GSList. This function iterates over the whole list to count its elements. To check whether the list is non-empty, it is faster to check @list against %NULL. - the number of elements in the #GSList + the number of elements in the #GSList - a #GSList + a #GSList @@ -32284,14 +23078,10 @@ check @list against %NULL. - Gets the element at the given position in a #GSList. + Gets the element at the given position in a #GSList. - the element, or %NULL if the position is off + the element, or %NULL if the position is off the end of the #GSList @@ -32299,92 +23089,64 @@ check @list against %NULL. - a #GSList + a #GSList - the position of the element, counting from 0 + the position of the element, counting from 0 - - Gets the data of the element at the given position. + + Gets the data of the element at the given position. - the element's data, or %NULL if the position + the element's data, or %NULL if the position is off the end of the #GSList - a #GSList + a #GSList - the position of the element + the position of the element - - Gets the position of the given element + + Gets the position of the given element in the #GSList (starting from 0). - the position of the element in the #GSList, + the position of the element in the #GSList, or -1 if the element is not found - a #GSList + a #GSList - an element in the #GSList + an element in the #GSList - - Adds a new element on to the start of the list. + + Adds a new element on to the start of the list. The return value is the new start of the list, which may have changed, so make sure you store the new value. @@ -32397,112 +23159,75 @@ list = g_slist_prepend (list, "first"); ]| - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - - the data for the new element + + the data for the new element - Removes an element from a #GSList. + Removes an element from a #GSList. If two elements contain the same data, only the first is removed. If none of the elements contain the data, the #GSList is unchanged. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - - the data of the element to remove + + the data of the element to remove - - Removes all list nodes with data equal to @data. + + Removes all list nodes with data equal to @data. Returns the new head of the list. Contrast with g_slist_remove() which removes only the first node matching the given data. - new head of @list + new head of @list - a #GSList + a #GSList - - data to remove + + data to remove - - Removes an element from a #GSList, without + + Removes an element from a #GSList, without freeing the element. The removed element's next link is set to %NULL, so that it becomes a self-contained list with one element. @@ -32514,52 +23239,38 @@ frequently, you should consider a different data structure, such as the doubly-linked #GList. - the new start of the #GSList, without the element + the new start of the #GSList, without the element - a #GSList + a #GSList - an element in the #GSList + an element in the #GSList - - Reverses a #GSList. + + Reverses a #GSList. - the start of the reversed #GSList + the start of the reversed #GSList - a #GSList + a #GSList @@ -32567,32 +23278,24 @@ such as the doubly-linked #GList. - Sorts a #GSList using the given comparison function. The algorithm + Sorts a #GSList using the given comparison function. The algorithm used is a stable sort. - the start of the sorted #GSList + the start of the sorted #GSList - a #GSList + a #GSList - the comparison function used to sort the #GSList. + the comparison function used to sort the #GSList. This function is passed the data from 2 elements of the #GSList and should return 0 if they are equal, a negative value if the first element comes before the second, or a positive value if @@ -32601,66 +23304,41 @@ used is a stable sort. - - Like g_slist_sort(), but the sort function accepts a user data argument. + + Like g_slist_sort(), but the sort function accepts a user data argument. - new head of the list + new head of the list - a #GSList + a #GSList - comparison function + comparison function - - data to pass to comparison function + + data to pass to comparison function - - Use this macro as the return value of a #GSourceFunc to leave + + Use this macro as the return value of a #GSourceFunc to leave the #GSource in the main loop. - + - - Cast a function pointer to a #GSourceFunc, suppressing warnings from GCC 8 + + Cast a function pointer to a #GSourceFunc, suppressing warnings from GCC 8 onwards with `-Wextra` or `-Wcast-function-type` enabled about the function types being incompatible. @@ -32672,36 +23350,23 @@ back to the correct type before it is called by the source. - a function pointer. + a function pointer. - - Use this macro as the return value of a #GSourceFunc to remove + + Use this macro as the return value of a #GSourceFunc to remove the #GSource from the main loop. - + - The square root of two. + The square root of two. - - Accepts a macro or a string and converts it into a string after + + Accepts a macro or a string and converts it into a string after preprocessor argument expansion. For example, the following code: |[<!-- language="C" --> @@ -32714,96 +23379,62 @@ is transformed by the preprocessor into (code equivalent to): |[<!-- language="C" --> const gchar *greeting = "27 today!"; ]| - + - a macro or a string + a macro or a string - - + + - - Returns a member of a structure at a given offset, using the given type. - + + Returns a member of a structure at a given offset, using the given type. + - the type of the struct field + the type of the struct field - a pointer to a struct + a pointer to a struct - the offset of the field from the start of the struct, + the offset of the field from the start of the struct, in bytes - - Returns an untyped pointer to a given offset of a struct. - + + Returns an untyped pointer to a given offset of a struct. + - a pointer to a struct + a pointer to a struct - the offset from the start of the struct, in bytes + the offset from the start of the struct, in bytes - - Returns the offset, in bytes, of a member of a struct. - + + Returns the offset, in bytes, of a member of a struct. + - a structure type, e.g. #GtkWidget + a structure type, e.g. #GtkWidget - a field in the structure, e.g. @window + a field in the structure, e.g. @window - - The standard delimiters, used in g_strdelimit(). + + The standard delimiters, used in g_strdelimit(). @@ -32819,9 +23450,7 @@ const gchar *greeting = "27 today!"; - + @@ -32834,9 +23463,7 @@ const gchar *greeting = "27 today!"; - The data structure representing a lexical scanner. + The data structure representing a lexical scanner. You should set @input_name after creating the scanner, since it is used by the default message handler when displaying @@ -32852,87 +23479,59 @@ If you want to use your own message handler you can set the is declared by #GScannerMsgFunc. - unused + unused - unused + unused - g_scanner_error() increments this field + g_scanner_error() increments this field - name of input stream, featured by the default message handler + name of input stream, featured by the default message handler - quarked data + quarked data - link into the scanner configuration + link into the scanner configuration - token parsed by the last g_scanner_get_next_token() + token parsed by the last g_scanner_get_next_token() - value of the last token from g_scanner_get_next_token() + value of the last token from g_scanner_get_next_token() - line number of the last token from g_scanner_get_next_token() + line number of the last token from g_scanner_get_next_token() - char number of the last token from g_scanner_get_next_token() + char number of the last token from g_scanner_get_next_token() - token parsed by the last g_scanner_peek_next_token() + token parsed by the last g_scanner_peek_next_token() - value of the last token from g_scanner_peek_next_token() + value of the last token from g_scanner_peek_next_token() - line number of the last token from g_scanner_peek_next_token() + line number of the last token from g_scanner_peek_next_token() - char number of the last token from g_scanner_peek_next_token() + char number of the last token from g_scanner_peek_next_token() @@ -32957,275 +23556,199 @@ is declared by #GScannerMsgFunc. - handler function for _warn and _error + handler function for _warn and _error - Returns the current line in the input stream (counting + Returns the current line in the input stream (counting from 1). This is the line of the last token parsed via g_scanner_get_next_token(). - the current line + the current line - a #GScanner + a #GScanner - Returns the current position in the current line (counting + Returns the current position in the current line (counting from 0). This is the position of the last token parsed via g_scanner_get_next_token(). - the current position on the line + the current position on the line - a #GScanner + a #GScanner - Gets the current token type. This is simply the @token + Gets the current token type. This is simply the @token field in the #GScanner structure. - the current token type + the current token type - a #GScanner + a #GScanner - - Gets the current token value. This is simply the @value + + Gets the current token value. This is simply the @value field in the #GScanner structure. - the current token value + the current token value - a #GScanner + a #GScanner - Frees all memory used by the #GScanner. + Frees all memory used by the #GScanner. - a #GScanner + a #GScanner - Returns %TRUE if the scanner has reached the end of + Returns %TRUE if the scanner has reached the end of the file or text buffer. - %TRUE if the scanner has reached the end of + %TRUE if the scanner has reached the end of the file or text buffer - a #GScanner + a #GScanner - Outputs an error message, via the #GScanner message handler. + Outputs an error message, via the #GScanner message handler. - a #GScanner + a #GScanner - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Parses the next token just like g_scanner_peek_next_token() + Parses the next token just like g_scanner_peek_next_token() and also removes it from the input stream. The token data is placed in the @token, @value, @line, and @position fields of the #GScanner structure. - the type of the token + the type of the token - a #GScanner + a #GScanner - Prepares to scan a file. + Prepares to scan a file. - a #GScanner + a #GScanner - a file descriptor + a file descriptor - Prepares to scan a text buffer. + Prepares to scan a text buffer. - a #GScanner + a #GScanner - the text buffer to scan + the text buffer to scan - the length of the text buffer + the length of the text buffer - Looks up a symbol in the current scope and return its value. + Looks up a symbol in the current scope and return its value. If the symbol is not bound in the current scope, %NULL is returned. - the value of @symbol in the current scope, or %NULL + the value of @symbol in the current scope, or %NULL if @symbol is not bound in the current scope - a #GScanner + a #GScanner - the symbol to look up + the symbol to look up - Parses the next token, without removing it from the input stream. + Parses the next token, without removing it from the input stream. The token data is placed in the @next_token, @next_value, @next_line, and @next_position fields of the #GScanner structure. @@ -33238,65 +23761,43 @@ configuration will return whatever was peeked before, regardless of any symbols that may have been added or removed in the new scope. - the type of the token + the type of the token - a #GScanner + a #GScanner - - Adds a symbol to the given scope. + + Adds a symbol to the given scope. - a #GScanner + a #GScanner - the scope id + the scope id - the symbol to add + the symbol to add - - the value of the symbol + + the value of the symbol - - Calls the given function for each of the symbol/value pairs + + Calls the given function for each of the symbol/value pairs in the given scope of the #GScanner. The function is passed the symbol and value of each pair, and the given @user_data parameter. @@ -33306,130 +23807,88 @@ parameter. - a #GScanner + a #GScanner - the scope id + the scope id - the function to call for each symbol/value pair + the function to call for each symbol/value pair - - user data to pass to the function + + user data to pass to the function - - Looks up a symbol in a scope and return its value. If the + + Looks up a symbol in a scope and return its value. If the symbol is not bound in the scope, %NULL is returned. - the value of @symbol in the given scope, or %NULL + the value of @symbol in the given scope, or %NULL if @symbol is not bound in the given scope. - a #GScanner + a #GScanner - the scope id + the scope id - the symbol to look up + the symbol to look up - - Removes a symbol from a scope. + + Removes a symbol from a scope. - a #GScanner + a #GScanner - the scope id + the scope id - the symbol to remove + the symbol to remove - Sets the current scope. + Sets the current scope. - the old scope id + the old scope id - a #GScanner + a #GScanner - the new scope id + the new scope id - - Rewinds the filedescriptor to the current buffer position + + Rewinds the filedescriptor to the current buffer position and blows the file read ahead buffer. This is useful for third party uses of the scanners filedescriptor, which hooks onto the current scanning position. @@ -33439,17 +23898,13 @@ onto the current scanning position. - a #GScanner + a #GScanner - Outputs a message through the scanner's msg_handler, + Outputs a message through the scanner's msg_handler, resulting from an unexpected token in the input stream. Note that you should not call g_scanner_peek_next_token() followed by g_scanner_unexp_token() without an intermediate @@ -33462,91 +23917,67 @@ to construct part of the message. - a #GScanner + a #GScanner - the expected token + the expected token - a string describing how the scanner's user + a string describing how the scanner's user refers to identifiers (%NULL defaults to "identifier"). This is used if @expected_token is %G_TOKEN_IDENTIFIER or %G_TOKEN_IDENTIFIER_NULL. - a string describing how the scanner's user refers + a string describing how the scanner's user refers to symbols (%NULL defaults to "symbol"). This is used if @expected_token is %G_TOKEN_SYMBOL or any token value greater than %G_TOKEN_LAST. - the name of the symbol, if the scanner's current + the name of the symbol, if the scanner's current token is a symbol. - a message string to output at the end of the + a message string to output at the end of the warning/error, or %NULL. - if %TRUE it is output as an error. If %FALSE it is + if %TRUE it is output as an error. If %FALSE it is output as a warning. - Outputs a warning message, via the #GScanner message handler. + Outputs a warning message, via the #GScanner message handler. - a #GScanner + a #GScanner - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Creates a new #GScanner. + Creates a new #GScanner. The @config_templ structure specifies the initial settings of the scanner, which are copied into the #GScanner @@ -33554,212 +23985,154 @@ of the scanner, which are copied into the #GScanner are used. - the new #GScanner + the new #GScanner - the initial scanner settings + the initial scanner settings - Specifies the #GScanner parser configuration. Most settings can + Specifies the #GScanner parser configuration. Most settings can be changed during the parsing phase and will affect the lexical parsing of the next unpeeked token. - specifies which characters should be skipped + specifies which characters should be skipped by the scanner (the default is the whitespace characters: space, tab, carriage-return and line-feed). - specifies the characters which can start + specifies the characters which can start identifiers (the default is #G_CSET_a_2_z, "_", and #G_CSET_A_2_Z). - specifies the characters which can be used + specifies the characters which can be used in identifiers, after the first character (the default is #G_CSET_a_2_z, "_0123456789", #G_CSET_A_2_Z, #G_CSET_LATINS, #G_CSET_LATINC). - specifies the characters at the start and + specifies the characters at the start and end of single-line comments. The default is "#\n" which means that single-line comments start with a '#' and continue until a '\n' (end of line). - specifies if symbols are case sensitive (the + specifies if symbols are case sensitive (the default is %FALSE). - specifies if multi-line comments are skipped + specifies if multi-line comments are skipped and not returned as tokens (the default is %TRUE). - specifies if single-line comments are skipped + specifies if single-line comments are skipped and not returned as tokens (the default is %TRUE). - specifies if multi-line comments are recognized + specifies if multi-line comments are recognized (the default is %TRUE). - specifies if identifiers are recognized (the + specifies if identifiers are recognized (the default is %TRUE). - specifies if single-character + specifies if single-character identifiers are recognized (the default is %FALSE). - specifies if %NULL is reported as + specifies if %NULL is reported as %G_TOKEN_IDENTIFIER_NULL (the default is %FALSE). - specifies if symbols are recognized (the default + specifies if symbols are recognized (the default is %TRUE). - specifies if binary numbers are recognized (the + specifies if binary numbers are recognized (the default is %FALSE). - specifies if octal numbers are recognized (the + specifies if octal numbers are recognized (the default is %TRUE). - specifies if floating point numbers are recognized + specifies if floating point numbers are recognized (the default is %TRUE). - specifies if hexadecimal numbers are recognized (the + specifies if hexadecimal numbers are recognized (the default is %TRUE). - specifies if '$' is recognized as a prefix for + specifies if '$' is recognized as a prefix for hexadecimal numbers (the default is %FALSE). - specifies if strings can be enclosed in single + specifies if strings can be enclosed in single quotes (the default is %TRUE). - specifies if strings can be enclosed in double + specifies if strings can be enclosed in double quotes (the default is %TRUE). - specifies if binary, octal and hexadecimal numbers + specifies if binary, octal and hexadecimal numbers are reported as #G_TOKEN_INT (the default is %TRUE). - specifies if all numbers are reported as %G_TOKEN_FLOAT + specifies if all numbers are reported as %G_TOKEN_FLOAT (the default is %FALSE). - specifies if identifiers are reported as strings + specifies if identifiers are reported as strings (the default is %FALSE). - specifies if characters are reported by setting + specifies if characters are reported by setting `token = ch` or as %G_TOKEN_CHAR (the default is %TRUE). - specifies if symbols are reported by setting + specifies if symbols are reported by setting `token = v_symbol` or as %G_TOKEN_SYMBOL (the default is %FALSE). - specifies if a symbol is searched for in the + specifies if a symbol is searched for in the default scope in addition to the current scope (the default is %FALSE). - use value.v_int64 rather than v_int + use value.v_int64 rather than v_int @@ -33767,99 +24140,65 @@ parsing of the next unpeeked token. - Specifies the type of the message handler function. + Specifies the type of the message handler function. - a #GScanner + a #GScanner - the message + the message - %TRUE if the message signals an error, + %TRUE if the message signals an error, %FALSE if it signals a warning. - An enumeration specifying the base position for a + An enumeration specifying the base position for a g_io_channel_seek_position() operation. - the current position in the file. + the current position in the file. - the start of the file. + the start of the file. - the end of the file. + the end of the file. - The #GSequence struct is an opaque data type representing a + The #GSequence struct is an opaque data type representing a [sequence][glib-Sequences] data type. - Adds a new item to the end of @seq. + Adds a new item to the end of @seq. - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequence + a #GSequence - - the data for the new item + + the data for the new item - - Calls @func for each item in the sequence passing @user_data + + Calls @func for each item in the sequence passing @user_data to the function. @func must not modify the sequence itself. @@ -33867,32 +24206,21 @@ to the function. @func must not modify the sequence itself. - a #GSequence + a #GSequence - the function to call for each item in @seq + the function to call for each item in @seq - - user data passed to @func + + user data passed to @func - Frees the memory allocated for @seq. If @seq has a data destroy + Frees the memory allocated for @seq. If @seq has a data destroy function associated with it, that function is called on all items in @seq. @@ -33901,117 +24229,76 @@ in @seq. - a #GSequence + a #GSequence - - Returns the begin iterator for @seq. + + Returns the begin iterator for @seq. - the begin iterator for @seq. + the begin iterator for @seq. - a #GSequence + a #GSequence - - Returns the end iterator for @seg + + Returns the end iterator for @seg - the end iterator for @seq + the end iterator for @seq - a #GSequence + a #GSequence - - Returns the iterator at position @pos. If @pos is negative or larger + + Returns the iterator at position @pos. If @pos is negative or larger than the number of items in @seq, the end iterator is returned. - The #GSequenceIter at position @pos + The #GSequenceIter at position @pos - a #GSequence + a #GSequence - a position in @seq, or -1 for the end + a position in @seq, or -1 for the end - - Returns the length of @seq. Note that this method is O(h) where `h' is the -height of the tree. It is thus more efficient to use g_sequence_is_empty() -when comparing the length to zero. + + Returns the positive length (>= 0) of @seq. Note that this method is +O(h) where `h' is the height of the tree. It is thus more efficient +to use g_sequence_is_empty() when comparing the length to zero. - the length of @seq + the length of @seq - a #GSequence + a #GSequence - - Inserts @data into @seq using @cmp_func to determine the new + + Inserts @data into @seq using @cmp_func to determine the new position. The sequence must already be sorted according to @cmp_func; otherwise the new position of @data is undefined. @@ -34025,51 +24312,30 @@ it is more efficient to do unsorted insertions and then call g_sequence_sort() or g_sequence_sort_iter(). - a #GSequenceIter pointing to the new item. + a #GSequenceIter pointing to the new item. - a #GSequence + a #GSequence - - the data to insert + + the data to insert - the function used to compare items in the sequence + the function used to compare items in the sequence - - user data passed to @cmp_func. + + user data passed to @cmp_func. - - Like g_sequence_insert_sorted(), but uses + + Like g_sequence_insert_sorted(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @@ -34083,78 +24349,48 @@ it is more efficient to do unsorted insertions and then call g_sequence_sort() or g_sequence_sort_iter(). - a #GSequenceIter pointing to the new item + a #GSequenceIter pointing to the new item - a #GSequence + a #GSequence - - data for the new item + + data for the new item - the function used to compare iterators in the sequence - + the function used to compare iterators in the sequence + - - user data passed to @iter_cmp + + user data passed to @iter_cmp - - Returns %TRUE if the sequence contains zero items. + + Returns %TRUE if the sequence contains zero items. This function is functionally identical to checking the result of g_sequence_get_length() being equal to zero. However this function is implemented in O(1) running time. - %TRUE if the sequence is empty, otherwise %FALSE. + %TRUE if the sequence is empty, otherwise %FALSE. - a #GSequence + a #GSequence - - Returns an iterator pointing to the position of the first item found + + Returns an iterator pointing to the position of the first item found equal to @data according to @cmp_func and @cmp_data. If more than one item is equal, it is not guaranteed that it is the first which is returned. In that case, you can use g_sequence_iter_next() and @@ -34169,53 +24405,32 @@ This function will fail if the data contained in the sequence is unsorted. - an #GSequenceIter pointing to the position of the + an #GSequenceIter pointing to the position of the first item found equal to @data according to @cmp_func and @cmp_data, or %NULL if no such item exists - a #GSequence + a #GSequence - - data to look up + + data to look up - the function used to compare items in the sequence + the function used to compare items in the sequence - - user data passed to @cmp_func + + user data passed to @cmp_func - - Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc + + Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @iter_cmp is called with two iterators pointing into @seq. @@ -34227,83 +24442,50 @@ This function will fail if the data contained in the sequence is unsorted. - an #GSequenceIter pointing to the position of + an #GSequenceIter pointing to the position of the first item found equal to @data according to @iter_cmp and @cmp_data, or %NULL if no such item exists - a #GSequence + a #GSequence - - data to look up + + data to look up - the function used to compare iterators in the sequence - + the function used to compare iterators in the sequence + - - user data passed to @iter_cmp + + user data passed to @iter_cmp - Adds a new item to the front of @seq + Adds a new item to the front of @seq - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequence + a #GSequence - - the data for the new item + + the data for the new item - - Returns an iterator pointing to the position where @data would + + Returns an iterator pointing to the position where @data would be inserted according to @cmp_func and @cmp_data. @cmp_func is called with two items of the @seq, and @cmp_data. @@ -34318,52 +24500,31 @@ This function will fail if the data contained in the sequence is unsorted. - an #GSequenceIter pointing to the position where @data + an #GSequenceIter pointing to the position where @data would have been inserted according to @cmp_func and @cmp_data - a #GSequence + a #GSequence - - data for the new item + + data for the new item - the function used to compare items in the sequence + the function used to compare items in the sequence - - user data passed to @cmp_func + + user data passed to @cmp_func - - Like g_sequence_search(), but uses a #GSequenceIterCompareFunc + + Like g_sequence_search(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @iter_cmp is called with two iterators pointing into @seq. @@ -34378,54 +24539,32 @@ This function will fail if the data contained in the sequence is unsorted. - a #GSequenceIter pointing to the position in @seq + a #GSequenceIter pointing to the position in @seq where @data would have been inserted according to @iter_cmp and @cmp_data - a #GSequence + a #GSequence - - data for the new item + + data for the new item - the function used to compare iterators in the sequence - + the function used to compare iterators in the sequence + - - user data passed to @iter_cmp + + user data passed to @iter_cmp - - Sorts @seq using @cmp_func. + + Sorts @seq using @cmp_func. @cmp_func is passed two items of @seq and should return 0 if they are equal, a negative value if the @@ -34437,35 +24576,21 @@ if the second comes before the first. - a #GSequence + a #GSequence - the function used to sort the sequence + the function used to sort the sequence - - user data passed to @cmp_func + + user data passed to @cmp_func - - Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead + + Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function @cmp_func is called with two iterators pointing into @seq. It should @@ -34478,36 +24603,21 @@ iterator comes before the first. - a #GSequence + a #GSequence - the function used to compare iterators in the sequence - + the function used to compare iterators in the sequence + - - user data passed to @cmp_func + + user data passed to @cmp_func - - Calls @func for each item in the range (@begin, @end) passing + + Calls @func for each item in the range (@begin, @end) passing @user_data to the function. @func must not modify the sequence itself. @@ -34516,89 +24626,57 @@ itself. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - a #GFunc + a #GFunc - - user data passed to @func + + user data passed to @func - Returns the data that @iter points to. + Returns the data that @iter points to. - the data that @iter points to + the data that @iter points to - a #GSequenceIter + a #GSequenceIter - - Inserts a new item just before the item pointed to by @iter. + + Inserts a new item just before the item pointed to by @iter. - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequenceIter + a #GSequenceIter - - the data for the new item + + the data for the new item - Moves the item pointed to by @src to the position indicated by @dest. + Moves the item pointed to by @src to the position indicated by @dest. After calling this function @dest will point to the position immediately after @src. It is allowed for @src and @dest to point into different sequences. @@ -34608,26 +24686,18 @@ sequences. - a #GSequenceIter pointing to the item to move + a #GSequenceIter pointing to the item to move - a #GSequenceIter pointing to the position to which + a #GSequenceIter pointing to the position to which the item is moved - - Inserts the (@begin, @end) range at the destination pointed to by @dest. + + Inserts the (@begin, @end) range at the destination pointed to by @dest. The @begin and @end iters must point into the same sequence. It is allowed for @dest to point to a different sequence than the one pointed into by @begin and @end. @@ -34641,60 +24711,37 @@ the (@begin, @end) range, the range does not move. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - Creates a new GSequence. The @data_destroy function, if non-%NULL will + + Creates a new GSequence. The @data_destroy function, if non-%NULL will be called on all items when the sequence is destroyed and on items that are removed from the sequence. - a new #GSequence + a new #GSequence - - a #GDestroyNotify function, or %NULL + + a #GDestroyNotify function, or %NULL - - Finds an iterator somewhere in the range (@begin, @end). This + + Finds an iterator somewhere in the range (@begin, @end). This iterator will be close to the middle of the range, but is not guaranteed to be exactly in the middle. @@ -34702,31 +24749,23 @@ The @begin and @end iterators must both point to the same sequence and @begin must come before or be equal to @end in the sequence. - a #GSequenceIter pointing somewhere in the + a #GSequenceIter pointing somewhere in the (@begin, @end) range - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Removes the item pointed to by @iter. It is an error to pass the + Removes the item pointed to by @iter. It is an error to pass the end iterator to this function. If the sequence has a data destroy function associated with it, this @@ -34737,19 +24776,13 @@ function is called on the data for the removed item. - a #GSequenceIter + a #GSequenceIter - - Removes all items in the (@begin, @end) range. + + Removes all items in the (@begin, @end) range. If the sequence has a data destroy function associated with it, this function is called on the data for the removed items. @@ -34759,23 +24792,17 @@ function is called on the data for the removed items. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Changes the data for the item pointed to by @iter to be @data. If + Changes the data for the item pointed to by @iter to be @data. If the sequence has a data destroy function associated with it, that function is called on the existing data that @iter pointed to. @@ -34784,29 +24811,17 @@ function is called on the existing data that @iter pointed to. - a #GSequenceIter + a #GSequenceIter - - new data for the item + + new data for the item - - Moves the data pointed to by @iter to a new position as indicated by + + Moves the data pointed to by @iter to a new position as indicated by @cmp_func. This function should be called for items in a sequence already sorted according to @cmp_func whenever some aspect of an item changes so that @cmp_func @@ -34822,35 +24837,21 @@ the second item comes before the first. - A #GSequenceIter + A #GSequenceIter - the function used to compare items in the sequence + the function used to compare items in the sequence - - user data passed to @cmp_func. + + user data passed to @cmp_func. - - Like g_sequence_sort_changed(), but uses + + Like g_sequence_sort_changed(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @@ -34865,33 +24866,21 @@ iterator comes before the first. - a #GSequenceIter + a #GSequenceIter - the function used to compare iterators in the sequence - + the function used to compare iterators in the sequence + - - user data passed to @cmp_func + + user data passed to @cmp_func - Swaps the items pointed to by @a and @b. It is allowed for @a and @b + Swaps the items pointed to by @a and @b. It is allowed for @a and @b to point into difference sequences. @@ -34899,322 +24888,209 @@ to point into difference sequences. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - The #GSequenceIter struct is an opaque data type representing an + The #GSequenceIter struct is an opaque data type representing an iterator pointing into a #GSequence. - - Returns a negative number if @a comes before @b, 0 if they are equal, + + Returns a negative number if @a comes before @b, 0 if they are equal, and a positive number if @a comes after @b. The @a and @b iterators must point into the same sequence. - a negative number if @a comes before @b, 0 if they are + a negative number if @a comes before @b, 0 if they are equal, and a positive number if @a comes after @b - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - Returns the position of @iter + + Returns the position of @iter - the position of @iter + the position of @iter - a #GSequenceIter + a #GSequenceIter - - Returns the #GSequence that @iter points into. + + Returns the #GSequence that @iter points into. - the #GSequence that @iter points into + the #GSequence that @iter points into - a #GSequenceIter + a #GSequenceIter - - Returns whether @iter is the begin iterator + + Returns whether @iter is the begin iterator - whether @iter is the begin iterator + whether @iter is the begin iterator - a #GSequenceIter + a #GSequenceIter - - Returns whether @iter is the end iterator + + Returns whether @iter is the end iterator - Whether @iter is the end iterator + Whether @iter is the end iterator - a #GSequenceIter + a #GSequenceIter - Returns the #GSequenceIter which is @delta positions away from @iter. + Returns the #GSequenceIter which is @delta positions away from @iter. If @iter is closer than -@delta positions to the beginning of the sequence, the begin iterator is returned. If @iter is closer than @delta positions to the end of the sequence, the end iterator is returned. - a #GSequenceIter which is @delta positions away from @iter + a #GSequenceIter which is @delta positions away from @iter - a #GSequenceIter + a #GSequenceIter - A positive or negative number indicating how many positions away + A positive or negative number indicating how many positions away from @iter the returned #GSequenceIter will be - Returns an iterator pointing to the next position after @iter. + Returns an iterator pointing to the next position after @iter. If @iter is the end iterator, the end iterator is returned. - a #GSequenceIter pointing to the next position after @iter + a #GSequenceIter pointing to the next position after @iter - a #GSequenceIter + a #GSequenceIter - Returns an iterator pointing to the previous position before @iter. + Returns an iterator pointing to the previous position before @iter. If @iter is the begin iterator, the begin iterator is returned. - a #GSequenceIter pointing to the previous position + a #GSequenceIter pointing to the previous position before @iter - a #GSequenceIter + a #GSequenceIter - A #GSequenceIterCompareFunc is a function used to compare iterators. + A #GSequenceIterCompareFunc is a function used to compare iterators. It must return zero if the iterators compare equal, a negative value if @a comes before @b, and a positive value if @b comes before @a. - zero if the iterators are equal, a negative value if @a + zero if the iterators are equal, a negative value if @a comes before @b, and a positive value if @b comes before @a. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - user data + + user data - - Error codes returned by shell functions. + + Error codes returned by shell functions. - - Mismatched or otherwise mangled quoting. + + Mismatched or otherwise mangled quoting. - - String to be parsed was empty. + + String to be parsed was empty. - Some other error. + Some other error. - + - + - + - + - + - + - - The `GSource` struct is an opaque data type + + The `GSource` struct is an opaque data type representing an event source. - + @@ -35257,9 +25133,7 @@ representing an event source. - Creates a new #GSource structure. The size is specified to + Creates a new #GSource structure. The size is specified to allow creating structures derived from #GSource that contain additional data. The size passed in must be at least `sizeof (GSource)`. @@ -35267,35 +25141,25 @@ additional data. The size passed in must be at least The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be executed. - + - the newly-created #GSource. + the newly-created #GSource. - structure containing functions that implement + structure containing functions that implement the sources behavior. - size of the #GSource structure to create. + size of the #GSource structure to create. - - Adds @child_source to @source as a "polled" source; when @source is + + Adds @child_source to @source as a "polled" source; when @source is added to a #GMainContext, @child_source will be automatically added with the same priority, when @child_source is triggered, it will cause @source to dispatch (in addition to calling its own @@ -35312,29 +25176,23 @@ is attached to it. This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. - + - a #GSource + a #GSource - a second #GSource that @source should "poll" + a second #GSource that @source should "poll" - Adds a file descriptor to the set of file descriptors polled for + Adds a file descriptor to the set of file descriptors polled for this source. This is usually combined with g_source_new() 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 @@ -35346,32 +25204,24 @@ Do not call this API on a #GSource that you did not create. Using this API forces the linear scanning of event sources on each main loop iteration. Newly-written event sources should try to use g_source_add_unix_fd() instead of this API. - + - a #GSource + a #GSource - a #GPollFD structure holding information about a file + a #GPollFD structure holding information about a file descriptor to watch. - - Monitors @fd for the IO events in @events. + + Monitors @fd for the IO events in @events. The tag returned by this function can be used to remove or modify the monitoring of the fd using g_source_remove_unix_fd() or @@ -35384,72 +25234,51 @@ This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. As the name suggests, this function is not available on Windows. - + - an opaque tag + an opaque tag - a #GSource + a #GSource - the fd to monitor + the fd to monitor - an event mask + an event mask - Adds a #GSource to a @context so that it will be executed within + Adds a #GSource to a @context so that it will be executed within that context. Remove it by calling g_source_destroy(). This function is safe to call from any thread, regardless of which thread the @context is running in. - + - the ID (greater than 0) for the source within the + the ID (greater than 0) for the source within the #GMainContext. - a #GSource + a #GSource - - a #GMainContext (if %NULL, the default context will be used) + + a #GMainContext (if %NULL, the default context will be used) - Removes a source from its #GMainContext, if any, and mark it as + Removes a source from its #GMainContext, if any, and mark it as destroyed. The source cannot be subsequently added to another context. It is safe to call this on sources which have already been removed from their context. @@ -35458,45 +25287,39 @@ This does not unref the #GSource: if you still hold a reference, use g_source_unref() to drop it. This function is safe to call from any thread, regardless of which thread -the #GMainContext is running in. - +the #GMainContext is running in. + +If the source is currently attached to a #GMainContext, destroying it +will effectively unset the callback similar to calling g_source_set_callback(). +This can mean, that the data's #GDestroyNotify gets called right away. + - a #GSource + a #GSource - Checks whether a source is allowed to be called recursively. + Checks whether a source is allowed to be called recursively. see g_source_set_can_recurse(). - + - whether recursion is allowed. + whether recursion is allowed. - a #GSource + a #GSource - Gets the #GMainContext with which the source is associated. + Gets the #GMainContext with which the source is associated. You can call this on a source that has been destroyed, provided that the #GMainContext it was attached to still exists (in which @@ -35504,56 +25327,41 @@ case it will return that #GMainContext). In particular, you can always call this function on the source returned from g_main_current_source(). But calling this function on a source whose #GMainContext has been destroyed is an error. - + - the #GMainContext with which the + the #GMainContext with which the source is associated, or %NULL if the context has not yet been added to a source. - a #GSource + a #GSource - - This function ignores @source and is otherwise the same as + + This function ignores @source and is otherwise the same as g_get_current_time(). use g_source_get_time() instead - + - a #GSource + a #GSource - #GTimeVal structure in which to store current time. + #GTimeVal structure in which to store current time. - Returns the numeric ID for a particular source. The ID of a source + Returns the numeric ID for a particular source. The ID of a source is a positive integer which is unique within a particular main loop context. The reverse mapping from ID to source is done by g_main_context_find_source_by_id(). @@ -35562,119 +25370,87 @@ You can only call this function while the source is associated to a #GMainContext instance; calling this function before g_source_attach() or after g_source_destroy() yields undefined behavior. The ID returned is unique within the #GMainContext instance passed to g_source_attach(). - + - the ID (greater than 0) for the source + the ID (greater than 0) for the source - a #GSource + a #GSource - Gets a name for the source, used in debugging and profiling. The + Gets a name for the source, used in debugging and profiling. The name may be #NULL if it has never been set with g_source_set_name(). - - - the name of the source + + + the name of the source - a #GSource + a #GSource - Gets the priority of a source. - + Gets the priority of a source. + - the priority of the source + the priority of the source - a #GSource + a #GSource - Gets the "ready time" of @source, as set by + Gets the "ready time" of @source, as set by g_source_set_ready_time(). Any time before the current monotonic time (including 0) is an indication that the source will fire immediately. - + - the monotonic ready time, -1 for "never" + the monotonic ready time, -1 for "never" - a #GSource + a #GSource - Gets the time to be used when checking this source. The advantage of + Gets the time to be used when checking this source. The advantage of calling this function over calling g_get_monotonic_time() directly is that when checking multiple sources, GLib can cache a single value instead of having to repeatedly get the system monotonic time. The time here is the system monotonic time, if available, or some other reasonable alternative otherwise. See g_get_monotonic_time(). - + - the monotonic time in microseconds + the monotonic time in microseconds - a #GSource + a #GSource - - Returns whether @source has been destroyed. + + Returns whether @source has been destroyed. This is important when you operate upon your objects from within idle handlers, but may have freed the object @@ -35686,10 +25462,10 @@ idle_callback (gpointer data) { SomeWidget *self = data; - GDK_THREADS_ENTER (); + g_mutex_lock (&self->idle_id_mutex); // do stuff with self self->idle_id = 0; - GDK_THREADS_LEAVE (); + g_mutex_unlock (&self->idle_id_mutex); return G_SOURCE_REMOVE; } @@ -35697,9 +25473,19 @@ idle_callback (gpointer data) static void some_widget_do_stuff_later (SomeWidget *self) { + g_mutex_lock (&self->idle_id_mutex); self->idle_id = g_idle_add (idle_callback, self); + g_mutex_unlock (&self->idle_id_mutex); } +static void +some_widget_init (SomeWidget *self) +{ + g_mutex_init (&self->idle_id_mutex); + + // ... +} + static void some_widget_finalize (GObject *object) { @@ -35708,6 +25494,8 @@ some_widget_finalize (GObject *object) if (self->idle_id) g_source_remove (self->idle_id); + g_mutex_clear (&self->idle_id_mutex); + G_OBJECT_CLASS (parent_class)->finalize (object); } ]| @@ -35724,12 +25512,12 @@ idle_callback (gpointer data) { SomeWidget *self = data; - GDK_THREADS_ENTER (); + g_mutex_lock (&self->idle_id_mutex); if (!g_source_is_destroyed (g_main_current_source ())) { // do stuff with self } - GDK_THREADS_LEAVE (); + g_mutex_unlock (&self->idle_id_mutex); return FALSE; } @@ -35740,28 +25528,20 @@ Calls to this function from a thread other than the one acquired by the source could be destroyed immediately after this function returns. However, once a source is destroyed it cannot be un-destroyed, so this function can be used for opportunistic checks from any thread. - + - %TRUE if the source has been destroyed + %TRUE if the source has been destroyed - a #GSource + a #GSource - - Updates the event mask to watch for the fd identified by @tag. + + Updates the event mask to watch for the fd identified by @tag. @tag is the tag returned from g_source_add_unix_fd(). @@ -35772,37 +25552,27 @@ This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. As the name suggests, this function is not available on Windows. - + - a #GSource + a #GSource - the tag from g_source_add_unix_fd() + the tag from g_source_add_unix_fd() - the new event mask to watch + the new event mask to watch - - Queries the events reported for the fd corresponding to @tag on + + Queries the events reported for the fd corresponding to @tag on @source during the last poll. The return value of this function is only defined when the function @@ -35812,54 +25582,60 @@ This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. As the name suggests, this function is not available on Windows. - + - the conditions reported on the fd + the conditions reported on the fd - a #GSource + a #GSource - the tag from g_source_add_unix_fd() + the tag from g_source_add_unix_fd() - Increases the reference count on a source by one. - + Increases the reference count on a source by one. + - @source + @source - a #GSource + a #GSource - - Detaches @child_source from @source and destroys it. + + Detaches @child_source from @source and destroys it. + +This API is only intended to be used by implementations of #GSource. +Do not call this API on a #GSource that you did not create. + + + + + + + a #GSource + + + + a #GSource previously passed to + g_source_add_child_source(). + + + + + + Removes a file descriptor from the set of file descriptors polled for +this source. This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. @@ -35869,53 +25645,17 @@ Do not call this API on a #GSource that you did not create. - a #GSource - - - - a #GSource previously passed to - g_source_add_child_source(). - - - - - - Removes a file descriptor from the set of file descriptors polled for -this source. - -This API is only intended to be used by implementations of #GSource. -Do not call this API on a #GSource that you did not create. - - - - - - - a #GSource + a #GSource - a #GPollFD structure previously passed to g_source_add_poll(). + a #GPollFD structure previously passed to g_source_add_poll(). - - Reverses the effect of a previous call to g_source_add_unix_fd(). + + Reverses the effect of a previous call to g_source_add_unix_fd(). You only need to call this if you want to remove an fd from being watched while keeping the same source around. In the normal case you @@ -35925,29 +25665,23 @@ This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. As the name suggests, this function is not available on Windows. - + - a #GSource + a #GSource - the tag from g_source_add_unix_fd() + the tag from g_source_add_unix_fd() - Sets the callback function for a source. The callback for a source is + Sets the callback function for a source. The callback for a source is called from the source's dispatch function. The exact type of @func depends on the type of source; ie. you @@ -35963,54 +25697,35 @@ to the type of source you are using, such as g_idle_add() or g_timeout_add(). It is safe to call this function multiple times on a source which has already been attached to a context. The changes will take effect for the next time -the source is dispatched after this call returns. - +the source is dispatched after this call returns. + +Note that g_source_destroy() for a currently attached source has the effect +of also unsetting the callback. + - the source + the source - - a callback function + + a callback function - - the data to pass to callback function + + the data to pass to callback function - - a function to call when @data is no longer in use, or %NULL. + + a function to call when @data is no longer in use, or %NULL. - - Sets the callback function storing the data as a refcounted callback + + Sets the callback function storing the data as a refcounted callback "object". This is used internally. Note that calling g_source_set_callback_indirect() assumes an initial reference count on @callback_data, and thus @@ -36020,68 +25735,48 @@ than @callback_funcs->ref. It is safe to call this function multiple times on a source which has already been attached to a context. The changes will take effect for the next time the source is dispatched after this call returns. - + - the source + the source - - pointer to callback data "object" + + pointer to callback data "object" - functions for reference counting @callback_data + functions for reference counting @callback_data and getting the callback and data - Sets whether a source can be called recursively. If @can_recurse is + Sets whether a source can be called recursively. If @can_recurse is %TRUE, then while the source is being dispatched then this source will be processed normally. Otherwise, all processing of this source is blocked until the dispatch function returns. - + - a #GSource + a #GSource - whether recursion is allowed for this source + whether recursion is allowed for this source - - Set @dispose as dispose function on @source. @dispose will be called once + + Set @dispose as dispose function on @source. @dispose will be called once the reference count of @source reaches 0 but before any of the state of the source is freed, especially before the finalize function is called. @@ -36097,55 +25792,41 @@ The finalize function can not be used for this purpose as at that point @source is already partially freed and not valid anymore. This should only ever be called from #GSource implementations. - + - A #GSource to set the dispose function on + A #GSource to set the dispose function on - #GSourceDisposeFunc to set on the source + #GSourceDisposeFunc to set on the source - - Sets the source functions (can be used to override + + Sets the source functions (can be used to override default implementations) of an unattached source. - + - a #GSource + a #GSource - the new #GSourceFuncs + the new #GSourceFuncs - Sets a name for the source, used in debugging and profiling. + Sets a name for the source, used in debugging and profiling. The name defaults to #NULL. The source name should describe in a human-readable way @@ -36160,30 +25841,26 @@ to include details like the event type in the source name. Use caution if changing the name while another thread may be accessing it with g_source_get_name(); that function does not copy the value, and changing the value will free it while the other thread -may be attempting to use it. - +may be attempting to use it. + +Also see g_source_set_static_name(). + - a #GSource + a #GSource - debug name for the source + debug name for the source - Sets the priority of a source. While the main loop is being run, a + Sets the priority of a source. While the main loop is being run, a source will be dispatched if it is ready to be dispatched and no sources at a higher (numerically smaller) priority are ready to be dispatched. @@ -36191,31 +25868,23 @@ dispatched. A child source always has the same priority as its parent. It is not permitted to change the priority of a source once it has been added as a child of another source. - + - a #GSource + a #GSource - the new priority. + the new priority. - - Sets a #GSource to be dispatched when the given monotonic time is + + Sets a #GSource to be dispatched when the given monotonic time is reached (or passed). If the monotonic time is in the past (as it always will be if @ready_time is 0) then the source will be dispatched immediately. @@ -36237,49 +25906,58 @@ destroyed with g_source_destroy(). This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. - + - a #GSource + a #GSource - the monotonic time at which the source will be ready, + the monotonic time at which the source will be ready, 0 for "immediately", -1 for "never" - - Decreases the reference count of a source by one. If the -resulting reference count is zero the source and associated -memory will be destroyed. - + + A variant of g_source_set_name() that does not +duplicate the @name, and can only be used with +string literals. + - a #GSource + a #GSource + + + + debug name for the source + + + + + + Decreases the reference count of a source by one. If the +resulting reference count is zero the source and associated +memory will be destroyed. + + + + + + + a #GSource - Removes the source with the given ID from the default main context. You must + Removes the source with the given ID from the default main context. You must use g_source_destroy() for sources added to a non-default main context. The ID of a #GSource is given by g_source_get_id(), or will be @@ -36298,86 +25976,56 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - For historical reasons, this function always returns %TRUE + For historical reasons, this function always returns %TRUE - the ID of the source to remove. + the ID of the source to remove. - - Removes a source from the default main loop context given the + + Removes a source from the default main loop context given the source functions and user data. If multiple sources exist with the same source functions and user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - The @source_funcs passed to g_source_new() + The @source_funcs passed to g_source_new() - - the user data for the callback + + the user data for the callback - - Removes a source from the default main loop context given the user + + Removes a source from the default main loop context given the user data for the callback. If multiple sources exist with the same user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - - the user_data for the callback. + + the user_data for the callback. - - Sets the name of a source using its ID. + + Sets the name of a source using its ID. This is a convenience utility to set source names from the return value of g_idle_add(), g_timeout_add(), etc. @@ -36393,35 +26041,29 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - a #GSource ID + a #GSource ID - debug name for the source + debug name for the source - The `GSourceCallbackFuncs` struct contains + The `GSourceCallbackFuncs` struct contains functions for managing callback objects. - + - + @@ -36434,7 +26076,7 @@ functions for managing callback objects. - + @@ -36447,7 +26089,7 @@ functions for managing callback objects. - + @@ -36461,50 +26103,37 @@ functions for managing callback objects. - + - - Dispose function for @source. See g_source_set_dispose_function() for + + Dispose function for @source. See g_source_set_dispose_function() for details. - + - #GSource that is currently being disposed + #GSource that is currently being disposed - This is just a placeholder for #GClosureMarshal, + This is just a placeholder for #GClosureMarshal, which cannot be used here for dependency reasons. - + - Specifies the type of function passed to g_timeout_add(), + Specifies the type of function passed to g_timeout_add(), g_timeout_add_full(), g_idle_add(), and g_idle_add_full(). When calling g_source_set_callback(), you may need to cast a function of a @@ -36512,30 +26141,20 @@ different type to this type. Use G_SOURCE_FUNC() to avoid warnings about incompatible function types. - %FALSE if the source should be removed. #G_SOURCE_CONTINUE and + %FALSE if the source should be removed. #G_SOURCE_CONTINUE and #G_SOURCE_REMOVE are more memorable names for the return value. - - data passed to the function, set when the source was + + data passed to the function, set when the source was created with one of the above functions - The `GSourceFuncs` struct contains a table of + The `GSourceFuncs` struct contains a table of functions used to handle event sources in a generic manner. For idle sources, the prepare and check functions always return %TRUE @@ -36555,10 +26174,10 @@ any events need to be processed. It sets the returned timeout to -1 to indicate that it doesn't mind how long the poll() call blocks. In the check function, it tests the results of the poll() call to see if the required condition has been met, and returns %TRUE if so. - + - + @@ -36574,7 +26193,7 @@ required condition has been met, and returns %TRUE if so. - + @@ -36587,7 +26206,7 @@ required condition has been met, and returns %TRUE if so. - + @@ -36598,11 +26217,7 @@ required condition has been met, and returns %TRUE if so. - + @@ -36610,7 +26225,7 @@ required condition has been met, and returns %TRUE if so. - + @@ -36632,9 +26247,7 @@ required condition has been met, and returns %TRUE if so. - Specifies the type of the setup function passed to g_spawn_async(), + Specifies the type of the setup function passed to g_spawn_async(), g_spawn_sync() and g_spawn_async_with_pipes(), which can, in very limited ways, be used to affect the child's execution. @@ -36669,317 +26282,249 @@ list to the `g_spawn...` function. - - user data to pass to the function. + + user data to pass to the function. - - Error codes returned by spawning processes. + + Error codes returned by spawning processes. - Fork failed due to lack of memory. + Fork failed due to lack of memory. - Read or select on pipes failed. + Read or select on pipes failed. - Changing to working directory failed. + Changing to working directory failed. - execv() returned `EACCES` + execv() returned `EACCES` - execv() returned `EPERM` + execv() returned `EPERM` - execv() returned `E2BIG` + execv() returned `E2BIG` - deprecated alias for %G_SPAWN_ERROR_TOO_BIG (deprecated since GLib 2.32) + deprecated alias for %G_SPAWN_ERROR_TOO_BIG (deprecated since GLib 2.32) - execv() returned `ENOEXEC` + execv() returned `ENOEXEC` - - execv() returned `ENAMETOOLONG` + + execv() returned `ENAMETOOLONG` - execv() returned `ENOENT` + execv() returned `ENOENT` - execv() returned `ENOMEM` + execv() returned `ENOMEM` - execv() returned `ENOTDIR` + execv() returned `ENOTDIR` - execv() returned `ELOOP` + execv() returned `ELOOP` - execv() returned `ETXTBUSY` + execv() returned `ETXTBUSY` - execv() returned `EIO` + execv() returned `EIO` - execv() returned `ENFILE` + execv() returned `ENFILE` - execv() returned `EMFILE` + execv() returned `EMFILE` - execv() returned `EINVAL` + execv() returned `EINVAL` - execv() returned `EISDIR` + execv() returned `EISDIR` - execv() returned `ELIBBAD` + execv() returned `ELIBBAD` - Some other fatal failure, + Some other fatal failure, `error->message` should explain. - Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). + Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). - no flags, default behaviour + no flags, default behaviour - - the parent's open file descriptors will + + the parent's open file descriptors will be inherited by the child; otherwise all descriptors except stdin, stdout and stderr will be closed before calling exec() in the child. - - the child will not be automatically reaped; + + the child will not be automatically reaped; you must use g_child_watch_add() yourself (or call waitpid() or handle `SIGCHLD` yourself), or the child will become a zombie. - `argv[0]` need not be an absolute path, it will be + `argv[0]` need not be an absolute path, it will be looked for in the user's `PATH`. - - the child's standard output will be discarded, + + the child's standard output will be discarded, instead of going to the same location as the parent's standard output. - - the child's standard error will be discarded. + + the child's standard error will be discarded. - - the child will inherit the parent's standard + + the child will inherit the parent's standard input (by default, the child's standard input is attached to `/dev/null`). - - the first element of `argv` is the file to + + the first element of `argv` is the file to execute, while the remaining elements are the actual argument vector to pass to the file. Normally g_spawn_async_with_pipes() uses `argv[0]` as the file to execute, and passes all of `argv` to the child. - - if `argv[0]` is not an absolute path, + + if `argv[0]` is not an absolute path, it will be looked for in the `PATH` from the passed child environment. Since: 2.34 - - create all pipes with the `O_CLOEXEC` flag set. + + create all pipes with the `O_CLOEXEC` flag set. Since: 2.40 - A type corresponding to the appropriate struct type for the stat() + A type corresponding to the appropriate struct type for the stat() system call, depending on the platform and/or compiler being used. See g_stat() for more information. - - The GString struct contains the public fields of a GString. + + The GString struct contains the public fields of a GString. - points to the character data. It may move as text is added. + points to the character data. It may move as text is added. The @str field is null-terminated and so can be used as an ordinary C string. - contains the length of the string, not including the + contains the length of the string, not including the terminating nul byte. - the number of bytes that can be stored in the + the number of bytes that can be stored in the string before it needs to be reallocated. May be larger than @len. + + Creates a new #GString, initialized with the given string. + + + the new #GString + + + + + the initial text to copy into the string, or %NULL to + start with an empty string + + + + + + Creates a new #GString with @len bytes of the @init buffer. +Because a length is provided, @init need not be nul-terminated, +and can contain embedded nul bytes. + +Since this function does not stop at nul bytes, it is the caller's +responsibility to ensure that @init has at least @len addressable +bytes. + + + a new #GString + + + + + initial contents of the string + + + + length of @init to use + + + + + + Creates a new #GString, with enough space for @dfl_size +bytes. This is useful if you are going to add a lot of +text to the string and don't want it to be reallocated +too often. + + + the new #GString + + + + + the default size of the space allocated to hold the string + + + + - Adds a string onto the end of a #GString, expanding + Adds a string onto the end of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the string to append onto the end of @string + the string to append onto the end of @string - Adds a byte onto the end of a #GString, expanding + Adds a byte onto the end of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the byte to append onto the end of @string + the byte to append onto the end of @string - Appends @len bytes of @val to @string. + Appends @len bytes of @val to @string. If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to @@ -36990,367 +26535,257 @@ is considered to request the entire string length. This makes g_string_append_len() equivalent to g_string_append(). - @string + @string - a #GString + a #GString - bytes to append + bytes to append - number of bytes of @val to use, or -1 for all of @val + number of bytes of @val to use, or -1 for all of @val - - Appends a formatted string onto the end of a #GString. + + Appends a formatted string onto the end of a #GString. This function is similar to g_string_printf() except that the text is appended to the #GString. + + + + + + + a #GString + + + + the string format. See the printf() documentation + + + + the parameters to insert into the format string + + + + + + Converts a Unicode character into UTF-8, and appends it +to the string. + + + @string + + + + + a #GString + + + + a Unicode character + + + + + + Appends @unescaped to @string, escaping any characters that +are reserved in URIs using URI-style escape sequences. + + + @string + + + + + a #GString + + + + a string + + + + a string of reserved characters allowed + to be used, or %NULL + + + + set %TRUE if the escaped string may include UTF8 characters + + + + + + Appends a formatted string onto the end of a #GString. +This function is similar to g_string_append_printf() +except that the arguments to the format string are passed +as a va_list. - a #GString + a #GString - the string format. See the printf() documentation - - - - the parameters to insert into the format string - - - - - - Converts a Unicode character into UTF-8, and appends it -to the string. - - - @string - - - - - a #GString - - - - a Unicode character - - - - - - Appends @unescaped to @string, escaping any characters that -are reserved in URIs using URI-style escape sequences. - - - @string - - - - - a #GString - - - - a string - - - - a string of reserved characters allowed - to be used, or %NULL - - - - set %TRUE if the escaped string may include UTF8 characters - - - - - - Appends a formatted string onto the end of a #GString. -This function is similar to g_string_append_printf() -except that the arguments to the format string are passed -as a va_list. - - - - - - - a #GString - - - - the string format. See the printf() documentation + the string format. See the printf() documentation - the list of arguments to insert in the output + the list of arguments to insert in the output - Converts all uppercase ASCII letters to lowercase ASCII letters. - + Converts all uppercase ASCII letters to lowercase ASCII letters. + - passed-in @string pointer, with all the + passed-in @string pointer, with all the uppercase characters converted to lowercase in place, with semantics that exactly match g_ascii_tolower(). - a GString + a GString - Converts all lowercase ASCII letters to uppercase ASCII letters. - + Converts all lowercase ASCII letters to uppercase ASCII letters. + - passed-in @string pointer, with all the + passed-in @string pointer, with all the lowercase characters converted to uppercase in place, with semantics that exactly match g_ascii_toupper(). - a GString + a GString - Copies the bytes from a string into a #GString, + Copies the bytes from a string into a #GString, destroying any previous contents. It is rather like the standard strcpy() function, except that you do not have to worry about having enough space to copy the string. - @string + @string - the destination #GString. Its current contents + the destination #GString. Its current contents are destroyed. - the string to copy into @string + the string to copy into @string - - Converts a #GString to lowercase. + + Converts a #GString to lowercase. This function uses the locale-specific tolower() function, which is almost never the right thing. Use g_string_ascii_down() or g_utf8_strdown() instead. - + - the #GString + the #GString - a #GString + a #GString - Compares two strings for equality, returning %TRUE if they are equal. + Compares two strings for equality, returning %TRUE if they are equal. For use with #GHashTable. - %TRUE if the strings are the same length and contain the + %TRUE if the strings are the same length and contain the same bytes - a #GString + a #GString - another #GString + another #GString - Removes @len bytes from a #GString, starting at position @pos. + Removes @len bytes from a #GString, starting at position @pos. The rest of the #GString is shifted down to fill the gap. - @string + @string - a #GString + a #GString - the position of the content to remove + the position of the content to remove - the number of bytes to remove, or -1 to remove all + the number of bytes to remove, or -1 to remove all following bytes - Frees the memory allocated for the #GString. + Frees the memory allocated for the #GString. If @free_segment is %TRUE it also frees the character data. If it's %FALSE, the caller gains ownership of the buffer and must free it after use with g_free(). - the character data of @string + the character data of @string (i.e. %NULL if @free_segment is %TRUE) - a #GString + a #GString - if %TRUE, the actual character data is freed as well + if %TRUE, the actual character data is freed as well - - Transfers ownership of the contents of @string to a newly allocated + + Transfers ownership of the contents of @string to a newly allocated #GBytes. The #GString structure itself is deallocated, and it is therefore invalid to use @string after invoking this function. @@ -37360,109 +26795,77 @@ trailing nul character (not reflected in its "len"), the returned equal to the "len" member. - A newly allocated #GBytes containing contents of @string; @string itself is freed + A newly allocated #GBytes containing contents of @string; @string itself is freed - a #GString + a #GString - Creates a hash code for @str; for use with #GHashTable. + Creates a hash code for @str; for use with #GHashTable. - hash code for @str + hash code for @str - a string to hash + a string to hash - Inserts a copy of a string into a #GString, + Inserts a copy of a string into a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the position to insert the copy of the string + the position to insert the copy of the string - the string to insert + the string to insert - Inserts a byte into a #GString, expanding it if necessary. + Inserts a byte into a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the position to insert the byte + the position to insert the byte - the byte to insert + the byte to insert - Inserts @len bytes of @val into @string at @pos. + Inserts @len bytes of @val into @string at @pos. If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to @@ -37474,206 +26877,142 @@ is considered to request the entire string length. If @pos is -1, bytes are inserted at the end of the string. - @string + @string - a #GString + a #GString - position in @string where insertion should + position in @string where insertion should happen, or -1 for at the end - bytes to insert + bytes to insert - number of bytes of @val to insert, or -1 for all of @val + number of bytes of @val to insert, or -1 for all of @val - Converts a Unicode character into UTF-8, and insert it + Converts a Unicode character into UTF-8, and insert it into the string at the given position. - @string + @string - a #GString + a #GString - the position at which to insert character, or -1 + the position at which to insert character, or -1 to append at the end of the string - a Unicode character + a Unicode character - - Overwrites part of a string, lengthening it if necessary. + + Overwrites part of a string, lengthening it if necessary. - @string + @string - a #GString + a #GString - the position at which to start overwriting + the position at which to start overwriting - the string that will overwrite the @string starting at @pos + the string that will overwrite the @string starting at @pos - - Overwrites part of a string, lengthening it if necessary. + + Overwrites part of a string, lengthening it if necessary. This function will work with embedded nuls. - @string + @string - a #GString + a #GString - the position at which to start overwriting + the position at which to start overwriting - the string that will overwrite the @string starting at @pos + the string that will overwrite the @string starting at @pos - the number of bytes to write from @val + the number of bytes to write from @val - Adds a string on to the start of a #GString, + Adds a string on to the start of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the string to prepend on the start of @string + the string to prepend on the start of @string - Adds a byte onto the start of a #GString, + Adds a byte onto the start of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the byte to prepend on the start of the #GString + the byte to prepend on the start of the #GString - Prepends @len bytes of @val to @string. + Prepends @len bytes of @val to @string. If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to @@ -37684,219 +27023,190 @@ is considered to request the entire string length. This makes g_string_prepend_len() equivalent to g_string_prepend(). - @string + @string - a #GString + a #GString - bytes to prepend + bytes to prepend - number of bytes in @val to prepend, or -1 for all of @val + number of bytes in @val to prepend, or -1 for all of @val - Converts a Unicode character into UTF-8, and prepends it + Converts a Unicode character into UTF-8, and prepends it to the string. - @string + @string - a #GString + a #GString - a Unicode character + a Unicode character - Writes a formatted string into a #GString. + Writes a formatted string into a #GString. This is similar to the standard sprintf() function, except that the #GString buffer automatically expands to contain the results. The previous contents of the #GString are destroyed. - + - a #GString + a #GString - the string format. See the printf() documentation + the string format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string + + Replaces the string @find with the string @replace in a #GString up to +@limit times. If the number of instances of @find in the #GString is +less than @limit, all instances are replaced. If @limit is `0`, +all instances of @find are replaced. + +If @find is the empty string, since versions 2.69.1 and 2.68.4 the +replacement will be inserted no more than once per possible position +(beginning of string, end of string and between characters). This did +not work correctly in earlier versions. + + + the number of find and replace operations performed. + + + + + a #GString + + + + the string to find in @string + + + + the string to insert in place of @find + + + + the maximum instances of @find to replace with @replace, or `0` for +no limit + + + + - Sets the length of a #GString. If the length is less than + Sets the length of a #GString. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as always, string->str[string->len] will be a nul byte.) - @string + @string - a #GString + a #GString - the new length + the new length - Cuts off the end of the GString, leaving the first @len bytes. + Cuts off the end of the GString, leaving the first @len bytes. - @string + @string - a #GString + a #GString - the new size of @string + the new size of @string - - Converts a #GString to uppercase. + + Converts a #GString to uppercase. This function uses the locale-specific toupper() function, which is almost never the right thing. Use g_string_ascii_up() or g_utf8_strup() instead. - + - @string + @string - a #GString + a #GString - - Writes a formatted string into a #GString. + + Writes a formatted string into a #GString. This function is similar to g_string_printf() except that the arguments to the format string are passed as a va_list. - + - a #GString + a #GString - the string format. See the printf() documentation + the string format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - An opaque data structure representing String Chunks. + An opaque data structure representing String Chunks. It should only be accessed by using the following functions. - Frees all strings contained within the #GStringChunk. + Frees all strings contained within the #GStringChunk. After calling g_string_chunk_clear() it is not safe to access any of the strings which were contained within it. @@ -37905,17 +27215,13 @@ access any of the strings which were contained within it. - a #GStringChunk + a #GStringChunk - Frees all memory allocated by the #GStringChunk. + Frees all memory allocated by the #GStringChunk. After calling g_string_chunk_free() it is not safe to access any of the strings which were contained within it. @@ -37924,17 +27230,13 @@ access any of the strings which were contained within it. - a #GStringChunk + a #GStringChunk - Adds a copy of @string to the #GStringChunk. + Adds a copy of @string to the #GStringChunk. It returns a pointer to the new copy of the string in the #GStringChunk. The characters in the string can be changed, if necessary, though you should not @@ -37947,31 +27249,23 @@ by g_string_chunk_insert_const() when looking for duplicates. - a pointer to the copy of @string within + a pointer to the copy of @string within the #GStringChunk - a #GStringChunk + a #GStringChunk - the string to add + the string to add - Adds a copy of @string to the #GStringChunk, unless the same + Adds a copy of @string to the #GStringChunk, unless the same string has already been added to the #GStringChunk with g_string_chunk_insert_const(). @@ -37986,33 +27280,23 @@ pointer to a string added with g_string_chunk_insert(), even if they do match. - a pointer to the new or existing copy of @string + a pointer to the new or existing copy of @string within the #GStringChunk - a #GStringChunk + a #GStringChunk - the string to add + the string to add - - Adds a copy of the first @len bytes of @string to the #GStringChunk. + + Adds a copy of the first @len bytes of @string to the #GStringChunk. The copy is nul-terminated. Since this function does not stop at nul bytes, it is the caller's @@ -38023,51 +27307,35 @@ The characters in the returned string can be changed, if necessary, though you should not change anything after the end of the string. - a pointer to the copy of @string within the #GStringChunk + a pointer to the copy of @string within the #GStringChunk - a #GStringChunk + a #GStringChunk - bytes to insert + bytes to insert - number of bytes of @string to insert, or -1 to insert a + number of bytes of @string to insert, or -1 to insert a nul-terminated string - - Creates a new #GStringChunk. + + Creates a new #GStringChunk. - a new #GStringChunk + a new #GStringChunk - the default size of the blocks of memory which are + the default size of the blocks of memory which are allocated to store the strings. If a particular string is larger than this default size, a larger block of memory will be allocated for it. @@ -38076,22 +27344,150 @@ though you should not change anything after the end of the string. - - Creates a unique temporary directory for each unit test and uses + + #GStrvBuilder is a method of easily building dynamically sized +NULL-terminated string arrays. + +The following example shows how to build a two element array: + +|[<!-- language="C" --> + g_autoptr(GStrvBuilder) builder = g_strv_builder_new (); + g_strv_builder_add (builder, "hello"); + g_strv_builder_add (builder, "world"); + g_auto(GStrv) array = g_strv_builder_end (builder); +]| + + + Add a string to the end of the array. + +Since 2.68 + + + + + + + a #GStrvBuilder + + + + a string. + + + + + + Appends all the given strings to the builder. + +Since 2.70 + + + + + + + a #GStrvBuilder + + + + one or more strings followed by %NULL + + + + + + Appends all the strings in the given vector to the builder. + +Since 2.70 + + + + + + + a #GStrvBuilder + + + + the vector of strings to add + + + + + + + + Ends the builder process and returns the constructed NULL-terminated string +array. The returned value should be freed with g_strfreev() when no longer +needed. + + + the constructed string array. + +Since 2.68 + + + + + + + a #GStrvBuilder + + + + + + Atomically increments the reference count of @builder by one. +This function is thread-safe and may be called from any thread. + + + The passed in #GStrvBuilder + + + + + a #GStrvBuilder + + + + + + Decreases the reference count on @builder. + +In the event that there are no more references, releases all memory +associated with the #GStrvBuilder. + + + + + + + a #GStrvBuilder allocated by g_strv_builder_new() + + + + + + Creates a new #GStrvBuilder with a reference count of 1. +Use g_strv_builder_unref() on the returned value when no longer needed. + + + the new #GStrvBuilder + + + + + + Creates a unique temporary directory for each unit test and uses g_set_user_dirs() to set XDG directories to point into subdirectories of it for the duration of the unit test. The directory tree is cleaned up after the -test finishes successfully. Note that this doesn’t take effect until +test finishes successfully. Note that this doesn’t take effect until g_test_run() is called, so calls to (for example) g_get_user_home_dir() will -return the system-wide value when made in a test program’s main() function. +return the system-wide value when made in a test program’s main() function. The following functions will return subdirectories of the temporary directory when this option is used. The specific subdirectory paths in use are not -guaranteed to be stable API — always use a getter function to retrieve them. +guaranteed to be stable API — always use a getter function to retrieve them. - g_get_home_dir() - g_get_user_cache_dir() @@ -38103,82 +27499,64 @@ guaranteed to be stable API — always use a getter function to retrieve them. The subdirectories may not be created by the test harness; as with normal calls to functions like g_get_user_cache_dir(), the caller must be prepared -to create the directory if it doesn’t exist. - +to create the directory if it doesn’t exist. + - - Evaluates to a time span of one day. + + Evaluates to a time span of one day. - - Evaluates to a time span of one hour. + + Evaluates to a time span of one hour. - - Evaluates to a time span of one millisecond. + + Evaluates to a time span of one millisecond. - - Evaluates to a time span of one minute. + + Evaluates to a time span of one minute. - - Evaluates to a time span of one second. + + Evaluates to a time span of one second. - Works like g_mutex_trylock(), but for a lock defined with -#G_LOCK_DEFINE. + Works like g_mutex_trylock(), but for a lock defined with +%G_LOCK_DEFINE. - the name of the lock + the name of the lock - An opaque structure representing a test case. + An opaque structure representing a test case. + + Free the @test_case. + + + + + + + a #GTestCase + + + + - + @@ -38199,31 +27577,21 @@ to create the directory if it doesn’t exist. - The type used for test case functions that take an extra pointer + The type used for test case functions that take an extra pointer argument. - - the data provided when registering the test + + the data provided when registering the test - The type of file to return the filename for, when used with + The type of file to return the filename for, when used with g_test_build_filename(). These two options correspond rather directly to the 'dist' and @@ -38239,22 +27607,16 @@ Note: as a general rule of automake, files that are generated only as part of the build-from-git process (but then are distributed with the tarball) always go in srcdir (even if doing a srcdir != builddir build from git) and are considered as distributed files. - + - a file that was included in the distribution tarball + a file that was included in the distribution tarball - a file that was built on the compiling machine + a file that was built on the compiling machine - The type used for functions that operate on test fixtures. This is + The type used for functions that operate on test fixtures. This is used for the fixture setup and teardown functions as well as for the testcases themselves. @@ -38270,34 +27632,24 @@ zero then @fixture will be equal to @user_data. - the test fixture + the test fixture - - the data provided when registering the test + + the data provided when registering the test - The type used for test case functions. + The type used for test case functions. - + @@ -38307,10 +27659,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to free test log messages, no ABI guarantees provided. - + Internal function for gtester to free test log messages, no ABI guarantees provided. + @@ -38320,13 +27670,9 @@ zero then @fixture will be equal to @user_data. - - Internal function for gtester to retrieve test log messages, no ABI guarantees provided. - + + Internal function for gtester to retrieve test log messages, no ABI guarantees provided. + @@ -38337,10 +27683,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to decode test log messages, no ABI guarantees provided. - + Internal function for gtester to decode test log messages, no ABI guarantees provided. + @@ -38356,64 +27700,42 @@ zero then @fixture will be equal to @user_data. - - Internal function for gtester to decode test log messages, no ABI guarantees provided. - + + Internal function for gtester to decode test log messages, no ABI guarantees provided. + - - Specifies the prototype of fatal log handler functions. - + + Specifies the prototype of fatal log handler functions. + - %TRUE if the program should abort, %FALSE otherwise + %TRUE if the program should abort, %FALSE otherwise - the log domain of the message + the log domain of the message - the log level of the message (including the fatal and recursion flags) + the log level of the message (including the fatal and recursion flags) - the message to process + the message to process - - user data, set in g_test_log_set_fatal_handler() + + user data, set in g_test_log_set_fatal_handler() - + @@ -38430,10 +27752,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to free test log messages, no ABI guarantees provided. - + Internal function for gtester to free test log messages, no ABI guarantees provided. + @@ -38445,14 +27765,12 @@ zero then @fixture will be equal to @user_data. - + - + @@ -38468,17 +27786,13 @@ zero then @fixture will be equal to @user_data. - + - + - + @@ -38489,147 +27803,107 @@ zero then @fixture will be equal to @user_data. - Flags to pass to g_test_trap_subprocess() to control input and output. + Flags to pass to g_test_trap_subprocess() to control input and output. Note that in contrast with g_test_trap_fork(), the default is to not show stdout and stderr. - - - If this flag is given, the child + + + If this flag is given, the child process will inherit the parent's stdin. Otherwise, the child's stdin is redirected to `/dev/null`. - - If this flag is given, the child + + If this flag is given, the child process will inherit the parent's stdout. Otherwise, the child's stdout will not be visible, but it will be captured to allow later tests with g_test_trap_assert_stdout(). - - If this flag is given, the child + + If this flag is given, the child process will inherit the parent's stderr. Otherwise, the child's stderr will not be visible, but it will be captured to allow later tests with g_test_trap_assert_stderr(). - An opaque structure representing a test suite. + An opaque structure representing a test suite. - Adds @test_case to @suite. - + Adds @test_case to @suite. + - a #GTestSuite + a #GTestSuite - a #GTestCase + a #GTestCase - - Adds @nestedsuite to @suite. - + + Adds @nestedsuite to @suite. + - a #GTestSuite + a #GTestSuite - another #GTestSuite + another #GTestSuite + + Free the @suite and all nested #GTestSuites. + + + + + + + a #GTestSuite + + + + - - Test traps are guards around forked tests. + + Test traps are guards around forked tests. These flags determine what traps to set. #GTestTrapFlags is used only with g_test_trap_fork(), which is deprecated. g_test_trap_subprocess() uses #GTestSubprocessFlags. - - - Redirect stdout of the test child to + + + Redirect stdout of the test child to `/dev/null` so it cannot be observed on the console during test runs. The actual output is still captured though to allow later tests with g_test_trap_assert_stdout(). - - Redirect stderr of the test child to + + Redirect stderr of the test child to `/dev/null` so it cannot be observed on the console during test runs. The actual output is still captured though to allow later tests with g_test_trap_assert_stderr(). - - If this flag is given, stdin of the + + If this flag is given, stdin of the child process is shared with stdin of its parent process. It is redirected to `/dev/null` otherwise. - - The #GThread struct represents a running thread. This struct + + The #GThread struct represents a running thread. This struct is returned by g_thread_new() or g_thread_try_new(). You can obtain the #GThread struct representing the current thread by calling g_thread_self(). @@ -38644,9 +27918,7 @@ The structure is opaque -- none of its fields may be directly accessed. - This function creates a new thread. The new thread starts by invoking + This function creates a new thread. The new thread starts by invoking @func with the argument data. The thread will run until @func returns or until g_thread_exit() is called from the new thread. The return value of @func becomes the return value of the thread, which can be obtained @@ -38675,93 +27947,52 @@ Starting with GLib 2.64 the behaviour is now consistent between Windows and POSIX and all threads inherit their parent thread's priority. - the new #GThread + the new #GThread - - an (optional) name for the new thread + + an (optional) name for the new thread - - a function to execute in the new thread + + a function to execute in the new thread - - an argument to supply to the new thread + + an argument to supply to the new thread - - This function is the same as g_thread_new() except that + + This function is the same as g_thread_new() except that it allows for the possibility of failure. If a thread can not be created (due to resource limits), @error is set and %NULL is returned. - the new #GThread, or %NULL if an error occurred + the new #GThread, or %NULL if an error occurred - - an (optional) name for the new thread + + an (optional) name for the new thread - - a function to execute in the new thread + + a function to execute in the new thread - - an argument to supply to the new thread + + an argument to supply to the new thread - Waits until @thread finishes, i.e. the function @func, as + Waits until @thread finishes, i.e. the function @func, as given to g_thread_new(), returns or g_thread_exit() is called. If @thread has already terminated, then g_thread_join() returns immediately. @@ -38779,44 +28010,32 @@ to be freed. Use g_thread_ref() to obtain an extra reference if you want to keep the GThread alive beyond the g_thread_join() call. - the return value of the thread + the return value of the thread - a #GThread + a #GThread - Increase the reference count on @thread. + Increase the reference count on @thread. - a new reference to @thread + a new reference to @thread - a #GThread + a #GThread - Decrease the reference count on @thread, possibly freeing all + Decrease the reference count on @thread, possibly freeing all resources associated with it. Note that each thread holds a reference to its #GThread while @@ -38828,9 +28047,7 @@ if you don't need it anymore. - a #GThread + a #GThread @@ -38841,9 +28058,7 @@ if you don't need it anymore. - Terminates the current thread. + Terminates the current thread. If another thread is waiting for us using g_thread_join() then the waiting thread will be woken up and get @retval as the return value @@ -38861,21 +28076,14 @@ or or from within a #GThreadPool. - - the return value of this thread + + the return value of this thread - This function 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. @@ -38886,16 +28094,12 @@ APIs). This may be useful for thread identification purposes as g_thread_join()) on these threads. - the #GThread representing the current thread + the #GThread representing the current thread - Causes the calling thread to voluntarily relinquish the CPU, so + Causes the calling thread to voluntarily relinquish the CPU, so that other threads can run. This function is often used as a method to make busy wait less evil. @@ -38905,75 +28109,48 @@ This function is often used as a method to make busy wait less evil. - - Possible errors of thread related functions. + + Possible errors of thread related functions. - - a thread couldn't be created due to resource + + a thread couldn't be created due to resource shortage. Try again later. - Specifies the type of the @func functions passed to g_thread_new() + Specifies the type of the @func functions passed to g_thread_new() or g_thread_try_new(). - the return value of the thread + the return value of the thread - - data passed to the thread + + data passed to the thread - The #GThreadPool struct represents a thread pool. It has three + The #GThreadPool struct represents a thread pool. It has three public read-only members, but the underlying struct is bigger, so you must not copy this struct. - the function to execute in the threads of this pool + the function to execute in the threads of this pool - the user data for the threads of this pool + the user data for the threads of this pool - are all threads exclusive to this pool + are all threads exclusive to this pool - Frees all resources allocated for @pool. + Frees all resources allocated for @pool. If @immediate is %TRUE, no new task is processed for @pool. Otherwise @pool is not freed before the last task is processed. @@ -38987,109 +28164,74 @@ or only the currently running) are ready. Otherwise this function returns immediately. After calling this function @pool must not be used anymore. - + - a #GThreadPool + a #GThreadPool - should @pool shut down immediately? + should @pool shut down immediately? - should the function wait for all tasks to be finished? + should the function wait for all tasks to be finished? - - Returns the maximal number of threads for @pool. - + + Returns the maximal number of threads for @pool. + - the maximal number of threads + the maximal number of threads - a #GThreadPool + a #GThreadPool - - Returns the number of threads currently running in @pool. - + + Returns the number of threads currently running in @pool. + - the number of threads currently running + the number of threads currently running - a #GThreadPool + a #GThreadPool - - Moves the item to the front of the queue of unprocessed + + Moves the item to the front of the queue of unprocessed items, so that it will be processed next. - + - %TRUE if the item was found and moved + %TRUE if the item was found and moved - a #GThreadPool + a #GThreadPool - - an unprocessed item in the pool + + an unprocessed item in the pool - Inserts @data into the list of tasks to be executed by @pool. + Inserts @data into the list of tasks to be executed by @pool. When the number of currently running threads is lower than the maximal allowed number of threads, a new thread is started (or @@ -39103,37 +28245,24 @@ created. In that case @data is simply appended to the queue of work to do. Before version 2.32, this function did not return a success status. - + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a #GThreadPool + a #GThreadPool - - a new task for @pool + + a new task for @pool - - Sets the maximal allowed number of threads for @pool. + + Sets the maximal allowed number of threads for @pool. A value of -1 means that the maximal number of threads is unlimited. If @pool is an exclusive thread pool, setting the maximal number of threads to -1 is not allowed. @@ -39153,36 +28282,25 @@ errors. An error can only occur when a new thread couldn't be created. Before version 2.32, this function did not return a success status. - + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a #GThreadPool + a #GThreadPool - a new maximal number of threads for @pool, + a new maximal number of threads for @pool, or -1 for unlimited - - Sets the function used to sort the list of tasks. This allows the + + Sets the function used to sort the list of tasks. This allows the tasks to be processed by a priority determined by @func, and not just in the order in which they were added to the pool. @@ -39191,21 +28309,17 @@ that threads are executed cannot be guaranteed 100%. Threads are scheduled by the operating system and are executed at random. It cannot be assumed that threads are executed in the order they are created. - + - a #GThreadPool + a #GThreadPool - the #GCompareDataFunc used to sort the list of tasks. + the #GCompareDataFunc used to sort the list of tasks. This function is passed two tasks. It should return 0 if the order in which they are handled does not matter, a negative value if the first task should be processed before @@ -39213,91 +28327,59 @@ created. processed first. - - user data passed to @func + + user data passed to @func - Returns the number of tasks still unprocessed in @pool. - + Returns the number of tasks still unprocessed in @pool. + - the number of unprocessed tasks + the number of unprocessed tasks - a #GThreadPool + a #GThreadPool - - This function will return the maximum @interval that a + + This function will return the maximum @interval that a thread will wait in the thread pool for new tasks before being stopped. If this function returns 0, threads waiting in the thread pool for new work are not stopped. - + - the maximum @interval (milliseconds) to wait + the maximum @interval (milliseconds) to wait for new tasks in the thread pool before stopping the thread - - Returns the maximal allowed number of unused threads. - + + Returns the maximal allowed number of unused threads. + - the maximal number of unused threads + the maximal number of unused threads - - Returns the number of currently unused threads. - + + Returns the number of currently unused threads. + - the number of currently unused threads + the number of currently unused threads - - This function creates a new thread pool. + + This function creates a new thread pool. Whenever you call g_thread_pool_push(), either a new thread is created or an unused one is reused. At most @max_threads threads @@ -39330,49 +28412,68 @@ See #GThreadError for possible errors that may occur. Note, even in case of error a valid #GThreadPool is returned. - the new #GThreadPool + the new #GThreadPool - a function to execute in the threads of the new thread pool + a function to execute in the threads of the new thread pool - - user data that is handed over to @func every time it + + user data that is handed over to @func every time it is called - the maximal number of threads to execute concurrently + the maximal number of threads to execute concurrently in the new thread pool, -1 means no limit - should this thread pool be exclusive? + should this thread pool be exclusive? - - This function will set the maximum @interval that a thread + + This function creates a new thread pool similar to g_thread_pool_new() +but allowing @item_free_func to be specified to free the data passed +to g_thread_pool_push() in the case that the #GThreadPool is stopped +and freed before all tasks have been executed. + + + the new #GThreadPool + + + + + a function to execute in the threads of the new thread pool + + + + user data that is handed over to @func every time it + is called + + + + used to pass as a free function to + g_async_queue_new_full() + + + + the maximal number of threads to execute concurrently + in the new thread pool, `-1` means no limit + + + + should this thread pool be exclusive? + + + + + + This function will set the maximum @interval that a thread waiting in the pool for new tasks can be idle for before being stopped. This function is similar to calling g_thread_pool_stop_unused_threads() on a regular timeout, @@ -39381,59 +28482,47 @@ except this is done on a per thread basis. By setting @interval to 0, idle threads will not be stopped. The default value is 15000 (15 seconds). - + - the maximum @interval (in milliseconds) + the maximum @interval (in milliseconds) a thread can be idle - - Sets the maximal number of unused threads to @max_threads. + + Sets the maximal number of unused threads to @max_threads. If @max_threads is -1, no limit is imposed on the number of unused threads. The default value is 2. - + - maximal number of unused threads + maximal number of unused threads - - Stops all currently unused threads. This does not change the + + Stops all currently unused threads. This does not change the maximal number of unused threads. This function can be used to regularly stop all unused threads e.g. from g_timeout_add(). - + - Disambiguates a given time in two ways. + Disambiguates a given time in two ways. First, specifies if the given time is in universal or local time. @@ -39441,31 +28530,21 @@ Second, if the time is in local time, specifies if it is local standard time or local daylight time. This is important for the case where the same local time occurs twice (during daylight savings time transitions, for example). - + - the time is in local standard time + the time is in local standard time - the time is in local daylight time + the time is in local daylight time - the time is in UTC + the time is in UTC - - Represents a precise time, with seconds and microseconds. -Similar to the struct timeval returned by the gettimeofday() + + Represents a precise time, with seconds and microseconds. + +Similar to the struct timeval returned by the `gettimeofday()` UNIX system call. GLib is attempting to unify around the use of 64-bit integers to @@ -39476,24 +28555,15 @@ problem. Use #GDateTime or #guint64 instead. - seconds + seconds - microseconds + microseconds - - Adds the given number of microseconds to @time_. @microseconds can + + Adds the given number of microseconds to @time_. @microseconds can also be negative to decrease the value of @time_. #GTimeVal is not year-2038-safe. Use `guint64` for representing microseconds since the epoch, or use #GDateTime. @@ -39503,27 +28573,17 @@ also be negative to decrease the value of @time_. - a #GTimeVal + a #GTimeVal - number of microseconds to add to @time + number of microseconds to add to @time - - Converts @time_ into an RFC 3339 encoded string, relative to the + + Converts @time_ into an RFC 3339 encoded string, relative to the Coordinated Universal Time (UTC). This is one of the many formats allowed by ISO 8601. @@ -39561,29 +28621,19 @@ The return value of g_time_val_to_iso8601() has been nullable since GLib g_date_time_format_iso8601(dt) instead. - a newly allocated string containing an ISO 8601 date, + a newly allocated string containing an ISO 8601 date, or %NULL if @time_ was too large - a #GTimeVal + a #GTimeVal - - Converts a string containing an ISO 8601 encoded date and time + + Converts a string containing an ISO 8601 encoded date and time to a #GTimeVal and puts it into @time_. @iso_date must include year, month, day, hours, minutes, and @@ -39604,45 +28654,49 @@ g_date_time_unref (dt); g_date_time_new_from_iso8601() instead. - %TRUE if the conversion was successful. + %TRUE if the conversion was successful. - an ISO 8601 encoded date string + an ISO 8601 encoded date string - - a #GTimeVal + + a #GTimeVal - - #GTimeZone is an opaque structure whose members cannot be accessed + + #GTimeZone is an opaque structure whose members cannot be accessed directly. - - - Creates a #GTimeZone corresponding to @identifier. + + + A version of g_time_zone_new_identifier() which returns the UTC time zone +if @identifier could not be parsed or loaded. + +If you need to check whether @identifier was loaded successfully, use +g_time_zone_new_identifier(). + Use g_time_zone_new_identifier() instead, as it provides + error reporting. Change your code to handle a potentially %NULL return + value. + + + the requested timezone + + + + + a timezone identifier + + + + + + Creates a #GTimeZone corresponding to @identifier. If @identifier cannot be +parsed or loaded, %NULL is returned. @identifier can either be an RFC3339/ISO 8601 time offset or something that would pass as a valid value for the `TZ` environment @@ -39652,8 +28706,8 @@ In Windows, @identifier can also be the unlocalized name of a time zone for standard time, for example "Pacific Standard Time". Valid RFC3339 time offsets are `"Z"` (for UTC) or -`"±hh:mm"`. ISO 8601 additionally specifies -`"±hhmm"` and `"±hh"`. Offsets are +`"±hh:mm"`. ISO 8601 additionally specifies +`"±hhmm"` and `"±hh"`. Offsets are time values to be added to Coordinated Universal Time (UTC) to get the local time. @@ -39665,7 +28719,7 @@ There are no spaces in the specification. The name of standard and daylight savings time zone must be three or more alphabetic characters. Offsets are time values to be added to local time to get Coordinated Universal Time (UTC) and should be -`"[±]hh[[:]mm[:ss]]"`. Dates are either +`"[±]hh[[:]mm[:ss]]"`. Dates are either `"Jn"` (Julian day with n between 1 and 365, leap years not counted), `"n"` (zero-based Julian day with n between 0 and 365) or `"Mm.w.d"` (day d @@ -39673,7 +28727,7 @@ with n between 0 and 365) or `"Mm.w.d"` (day d 0 is a Sunday). Times are in local wall clock time, the default is 02:00:00. -In Windows, the "tzn[+|–]hh[:mm[:ss]][dzn]" format is used, but also +In Windows, the "tzn[+|–]hh[:mm[:ss]][dzn]" format is used, but also accepts POSIX format. The Windows format uses US rules for all time zones; daylight savings time is 60 minutes behind the standard time with date and time of change taken from Pacific Standard Time. @@ -39694,7 +28748,7 @@ available and it is greater than 2037, then it will followed instead. See -[RFC3339 §5.6](http://tools.ietf.org/html/rfc3339#section-5.6) +[RFC3339 §5.6](http://tools.ietf.org/html/rfc3339#section-5.6) for a precise definition of valid RFC3339 time offsets (the `time-offset` expansion) and ISO 8601 for the full list of valid time offsets. See @@ -39706,31 +28760,21 @@ for the list of time zones on Windows. You should release the return value by calling g_time_zone_unref() when you are done with it. - - - the requested timezone + + + the requested timezone, or %NULL on + failure - - a timezone identifier + + a timezone identifier - - Creates a #GTimeZone corresponding to local time. The local time + + Creates a #GTimeZone corresponding to local time. The local time zone may change between invocations to this function; for example, if the system administrator changes it. @@ -39739,66 +28783,46 @@ the `TZ` environment variable (including the possibility of %NULL). You should release the return value by calling g_time_zone_unref() when you are done with it. - + - the local timezone + the local timezone - - Creates a #GTimeZone corresponding to the given constant offset from UTC, + + Creates a #GTimeZone corresponding to the given constant offset from UTC, in seconds. This is equivalent to calling g_time_zone_new() with a string in the form `[+|-]hh[:mm[:ss]]`. - + - a timezone at the given offset from UTC + a timezone at the given offset from UTC - offset to UTC, in seconds + offset to UTC, in seconds - - Creates a #GTimeZone corresponding to UTC. + + Creates a #GTimeZone corresponding to UTC. This is equivalent to calling g_time_zone_new() with a value like "Z", "UTC", "+00", etc. You should release the return value by calling g_time_zone_unref() when you are done with it. - + - the universal timezone + the universal timezone - - Finds an interval within @tz that corresponds to the given @time_, + + Finds an interval within @tz that corresponds to the given @time_, possibly adjusting @time_ if required to fit into an interval. The meaning of @time_ depends on @type. @@ -39814,40 +28838,28 @@ non-existent times. If the non-existent local @time_ of 02:30 were requested on March 14th 2010 in Toronto then this function would adjust @time_ to be 03:00 and return the interval containing the adjusted time. - + - the interval containing @time_, never -1 + the interval containing @time_, never -1 - a #GTimeZone + a #GTimeZone - the #GTimeType of @time_ + the #GTimeType of @time_ - a pointer to a number of seconds since January 1, 1970 + a pointer to a number of seconds since January 1, 1970 - - Finds an interval within @tz that corresponds to the given @time_. + + Finds an interval within @tz that corresponds to the given @time_. The meaning of @time_ depends on @type. If @type is %G_TIME_TYPE_UNIVERSAL then this function will always @@ -39865,73 +28877,51 @@ It is still possible for this function to fail. In Toronto, for example, 02:00 on March 14th 2010 does not exist (due to the leap forward to begin daylight savings time). -1 is returned in that case. - + - the interval containing @time_, or -1 in case of failure + the interval containing @time_, or -1 in case of failure - a #GTimeZone + a #GTimeZone - the #GTimeType of @time_ + the #GTimeType of @time_ - a number of seconds since January 1, 1970 + a number of seconds since January 1, 1970 - - Determines the time zone abbreviation to be used during a particular + + Determines the time zone abbreviation to be used during a particular @interval of time in the time zone @tz. For example, in Toronto this is currently "EST" during the winter months and "EDT" during the summer months when daylight savings time is in effect. - + - the time zone abbreviation, which belongs to @tz + the time zone abbreviation, which belongs to @tz - a #GTimeZone + a #GTimeZone - an interval within the timezone + an interval within the timezone - - Get the identifier of this #GTimeZone, as passed to g_time_zone_new(). + + Get the identifier of this #GTimeZone, as passed to g_time_zone_new(). If the identifier passed at construction time was not recognised, `UTC` will be returned. If it was %NULL, the identifier of the local timezone at construction time will be returned. @@ -39939,130 +28929,94 @@ construction time will be returned. The identifier will be returned in the same format as provided at construction time: if provided as a time offset, that will be returned by this function. - + - identifier for this timezone + identifier for this timezone - a #GTimeZone + a #GTimeZone - - Determines the offset to UTC in effect during a particular @interval + + Determines the offset to UTC in effect during a particular @interval of time in the time zone @tz. The offset is the number of seconds that you add to UTC time to arrive at local time for @tz (ie: negative numbers for time zones west of GMT, positive numbers for east). - + - the number of seconds that should be added to UTC to get the + the number of seconds that should be added to UTC to get the local time in @tz - a #GTimeZone + a #GTimeZone - an interval within the timezone + an interval within the timezone - Determines if daylight savings time is in effect during a particular + Determines if daylight savings time is in effect during a particular @interval of time in the time zone @tz. - + - %TRUE if daylight savings time is in effect + %TRUE if daylight savings time is in effect - a #GTimeZone + a #GTimeZone - an interval within the timezone + an interval within the timezone - Increases the reference count on @tz. - + Increases the reference count on @tz. + - a new reference to @tz. + a new reference to @tz. - a #GTimeZone + a #GTimeZone - Decreases the reference count on @tz. - + Decreases the reference count on @tz. + - a #GTimeZone + a #GTimeZone - Opaque datatype that records a start time. + Opaque datatype that records a start time. - Resumes a timer that has previously been stopped with + Resumes a timer that has previously been stopped with g_timer_stop(). g_timer_stop() must be called before using this function. @@ -40071,34 +29025,26 @@ function. - a #GTimer. + a #GTimer. - Destroys a timer, freeing associated resources. + Destroys a timer, freeing associated resources. - a #GTimer to destroy. + a #GTimer to destroy. - If @timer has been started but not stopped, obtains the time since + If @timer has been started but not stopped, obtains the time since the timer was started. If @timer has been stopped, obtains the elapsed time between the time it was started and the time it was stopped. The return value is the number of seconds elapsed, @@ -40106,23 +29052,17 @@ including any fractional part. The @microseconds out parameter is essentially useless. - seconds elapsed as a floating point value, including any + seconds elapsed as a floating point value, including any fractional part. - a #GTimer. + a #GTimer. - return location for the fractional part of seconds + return location for the fractional part of seconds elapsed, in microseconds (that is, the total number of microseconds elapsed, modulo 1000000), or %NULL @@ -40130,29 +29070,21 @@ essentially useless. - Exposes whether the timer is currently active. + Exposes whether the timer is currently active. - %TRUE if the timer is running, %FALSE otherwise + %TRUE if the timer is running, %FALSE otherwise - a #GTimer. + a #GTimer. - This function is useless; it's fine to call g_timer_start() on an + This function is useless; it's fine to call g_timer_start() on an already-started timer to reset the start time, so g_timer_reset() serves no purpose. @@ -40161,17 +29093,13 @@ serves no purpose. - a #GTimer. + a #GTimer. - Marks a start time, so that future calls to g_timer_elapsed() will + Marks a start time, so that future calls to g_timer_elapsed() will report the time since g_timer_start() was called. g_timer_new() automatically marks the start time, so no need to call g_timer_start() immediately after creating the timer. @@ -40181,17 +29109,13 @@ g_timer_start() immediately after creating the timer. - a #GTimer. + a #GTimer. - Marks an end time, so calls to g_timer_elapsed() will return the + Marks an end time, so calls to g_timer_elapsed() will return the difference between this end time and the start time. @@ -40199,368 +29123,230 @@ difference between this end time and the start time. - a #GTimer. + a #GTimer. - Creates a new timer, and starts timing (i.e. g_timer_start() is + Creates a new timer, and starts timing (i.e. g_timer_start() is implicitly called for you). - a new #GTimer. + a new #GTimer. - The possible types of token returned from each + The possible types of token returned from each g_scanner_get_next_token() call. - the end of the file + the end of the file - a '(' character + a '(' character - a ')' character + a ')' character - a '{' character + a '{' character - - a '}' character + + a '}' character - a '[' character + a '[' character - a ']' character + a ']' character - a '=' character + a '=' character - a ',' character + a ',' character - not a token + not a token - an error occurred + an error occurred - a character + a character - a binary integer + a binary integer - an octal integer + an octal integer - an integer + an integer - a hex integer + a hex integer - a floating point number + a floating point number - a string + a string - a symbol + a symbol - an identifier + an identifier - - a null identifier + + a null identifier - - one line comment + + one line comment - - multi line comment + + multi line comment - A union holding the value of the token. + A union holding the value of the token. - token symbol value + token symbol value - token identifier value + token identifier value - token binary integer value + token binary integer value - octal integer value + octal integer value - integer value + integer value - 64-bit integer value + 64-bit integer value - floating point value + floating point value - hex integer value + hex integer value - string value + string value - comment value + comment value - character value + character value - error value + error value - The type of functions which are used to translate user-visible + The type of functions which are used to translate user-visible strings, for <option>--help</option> output. - a translation of the string for the current locale. + a translation of the string for the current locale. The returned string is owned by GLib and must not be freed. - the untranslated string + the untranslated string - - user data specified when installing the function, e.g. + + user data specified when installing the function, e.g. in g_option_group_set_translate_func() - - Each piece of memory that is pushed onto the stack + + Each piece of memory that is pushed onto the stack is cast to a GTrashStack*. #GTrashStack is deprecated without replacement - pointer to the previous element of the stack, + pointer to the previous element of the stack, gets stored in the first `sizeof (gpointer)` bytes of the element - - Returns the height of a #GTrashStack. + + Returns the height of a #GTrashStack. Note that execution of this function is of O(N) complexity where N denotes the number of items on the stack. #GTrashStack is deprecated without replacement - the height of the stack + the height of the stack - a #GTrashStack + a #GTrashStack - - Returns the element at the top of a #GTrashStack + + Returns the element at the top of a #GTrashStack which may be %NULL. #GTrashStack is deprecated without replacement - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - - Pops a piece of memory off a #GTrashStack. + + Pops a piece of memory off a #GTrashStack. #GTrashStack is deprecated without replacement - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - - Pushes a piece of memory onto a #GTrashStack. + + Pushes a piece of memory onto a #GTrashStack. #GTrashStack is deprecated without replacement @@ -40568,109 +29354,91 @@ which may be %NULL. - a #GTrashStack + a #GTrashStack - the piece of memory to push on the stack + the piece of memory to push on the stack - Specifies which nodes are visited during several of the tree + Specifies which nodes are visited during several of the tree functions, including g_node_traverse() and g_node_find(). - only leaf nodes should be visited. This name has + only leaf nodes should be visited. This name has been introduced in 2.6, for older version use %G_TRAVERSE_LEAFS. - only non-leaf nodes should be visited. This + only non-leaf nodes should be visited. This name has been introduced in 2.6, for older version use %G_TRAVERSE_NON_LEAFS. - all nodes should be visited. + all nodes should be visited. - a mask of all traverse flags. + a mask of all traverse flags. - identical to %G_TRAVERSE_LEAVES. + identical to %G_TRAVERSE_LEAVES. - identical to %G_TRAVERSE_NON_LEAVES. + identical to %G_TRAVERSE_NON_LEAVES. - Specifies the type of function passed to g_tree_traverse(). It is + Specifies the type of function passed to g_tree_traverse(). It is passed the key and value of each node, together with the @user_data parameter passed to g_tree_traverse(). If the function returns %TRUE, the traversal is stopped. - + - %TRUE to stop the traversal + %TRUE to stop the traversal - - a key of a #GTree node + + a key of a #GTree node - - the value corresponding to the key + + the value corresponding to the key - - user data passed to g_tree_traverse() + + user data passed to g_tree_traverse() + + + + + + Specifies the type of function passed to g_tree_foreach_node(). It is +passed each node, together with the @user_data parameter passed to +g_tree_foreach_node(). If the function returns %TRUE, the traversal is +stopped. + + + %TRUE to stop the traversal + + + + + a #GTreeNode + + + + user data passed to g_tree_foreach_node() - Specifies the type of traversal performed by g_tree_traverse(), + Specifies the type of traversal performed by g_tree_traverse(), g_node_traverse() and g_node_find(). The different orders are illustrated here: - In order: A, B, C, D, E, F, G, H, I @@ -40683,27 +29451,19 @@ illustrated here: ![](Sorted_binary_tree_breadth-first_traversal.svg) - vists a node's left child first, then the node itself, + vists a node's left child first, then the node itself, then its right child. This is the one to use if you want the output sorted according to the compare function. - visits a node, then its children. + visits a node, then its children. - visits the node's children, then the node itself. + visits the node's children, then the node itself. - is not implemented for + is not implemented for [balanced binary trees][glib-Balanced-Binary-Trees]. For [n-ary trees][glib-N-ary-Trees], it vists the root node first, then its children, then @@ -40711,39 +29471,100 @@ illustrated here: efficient than the other orders. - - The GTree struct is an opaque data structure representing a + + The GTree struct is an opaque data structure representing a [balanced binary tree][glib-Balanced-Binary-Trees]. It should be accessed only by using the following functions. - + + + Creates a new #GTree. + + + a newly allocated #GTree + + + + + the function used to order the nodes in the #GTree. + It should return values similar to the standard strcmp() function - + 0 if the two arguments are equal, a negative value if the first argument + comes before the second, or a positive value if the first argument comes + after the second. + + + + + + Creates a new #GTree like g_tree_new() and allows to specify functions +to free the memory allocated for the key and value that get called when +removing the entry from the #GTree. + + + a newly allocated #GTree + + + + + qsort()-style comparison function + + + + data to pass to comparison function + + + + a function to free the memory allocated for the key + used when removing the entry from the #GTree or %NULL if you don't + want to supply such a function + + + + a function to free the memory allocated for the + value used when removing the entry from the #GTree or %NULL if you + don't want to supply such a function + + + + + + Creates a new #GTree with a comparison function that accepts user data. +See g_tree_new() for more details. + + + a newly allocated #GTree + + + + + qsort()-style comparison function + + + + data to pass to comparison function + + + + - Removes all keys and values from the #GTree and decreases its + Removes all keys and values from the #GTree and decreases its reference count by one. If keys and/or values are dynamically allocated, you should either free them first or create the #GTree using g_tree_new_full(). In the latter case the destroy functions you supplied will be called on all keys and values before destroying the #GTree. - + - a #GTree + a #GTree - Calls the given function for each of the key/value pairs in the #GTree. + Calls the given function for each of the key/value pairs in the #GTree. The function is passed the key and value of each pair, and the given @data parameter. The tree is traversed in sorted order. @@ -40751,63 +29572,99 @@ The tree may not be modified while iterating over it (you can't add/remove items). To remove all items matching a predicate, you need to add each item to a list in your #GTraverseFunc as you walk over the tree, then walk the list and remove each item. - + - a #GTree + a #GTree - the function to call for each node visited. + the function to call for each node visited. If this function returns %TRUE, the traversal is stopped. - - user data to pass to the function + + user data to pass to the function + + + + + + Calls the given function for each of the nodes in the #GTree. +The function is passed the pointer to the particular node, and the given +@data parameter. The tree traversal happens in-order. + +The tree may not be modified while iterating over it (you can't +add/remove items). To remove all items matching a predicate, you need +to add each item to a list in your #GTraverseFunc as you walk over +the tree, then walk the list and remove each item. + + + + + + + a #GTree + + + + the function to call for each node visited. + If this function returns %TRUE, the traversal is stopped. + + + + user data to pass to the function - Gets the height of a #GTree. + Gets the height of a #GTree. If the #GTree contains no nodes, the height is 0. If the #GTree contains only one root node the height is 1. If the root node has children the height is 2, etc. - + - the height of @tree + the height of @tree - a #GTree + a #GTree - Inserts a key/value pair into a #GTree. + Inserts a key/value pair into a #GTree. + +Inserts a new key and value into a #GTree as g_tree_insert_node() does, +only this function does not return the inserted or set node. + + + + + + + a #GTree + + + + the key to insert + + + + the value corresponding to the key + + + + + + Inserts a key/value pair into a #GTree. If the given key already exists in the #GTree its corresponding value is set to the new value. If you supplied a @value_destroy_func when @@ -40820,174 +29677,184 @@ so that the distance from the root to every leaf is as small as possible. The cost of maintaining a balanced tree while inserting new key/value result in a O(n log(n)) operation where most of the other operations are O(log(n)). - + - + the inserted (or set) node. + - a #GTree + a #GTree - - the key to insert + + the key to insert - - the value corresponding to the key + + the value corresponding to the key - Gets the value corresponding to the given key. Since a #GTree is + Gets the value corresponding to the given key. Since a #GTree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree). - + - the value corresponding to the key, or %NULL + the value corresponding to the key, or %NULL if the key was not found - a #GTree + a #GTree - - the key to look up + + the key to look up - Looks up a key in the #GTree, returning the original key and the + Looks up a key in the #GTree, returning the original key and the associated value. This is useful if you need to free the memory allocated for the original key, for example before calling g_tree_remove(). - + - %TRUE if the key was found in the #GTree + %TRUE if the key was found in the #GTree - a #GTree + a #GTree - - the key to look up + + the key to look up - - returns the original key + + returns the original key - - returns the value associated with the key + + returns the value associated with the key + + Gets the tree node corresponding to the given key. Since a #GTree is +automatically balanced as key/value pairs are added, key lookup +is O(log n) (where n is the number of key/value pairs in the tree). + + + the tree node corresponding to + the key, or %NULL if the key was not found + + + + + a #GTree + + + + the key to look up + + + + + + Gets the lower bound node corresponding to the given key, +or %NULL if the tree is empty or all the nodes in the tree +have keys that are strictly lower than the searched key. + +The lower bound is the first node that has its key greater +than or equal to the searched key. + + + the tree node corresponding to + the lower bound, or %NULL if the tree is empty or has only + keys strictly lower than the searched key. + + + + + a #GTree + + + + the key to calculate the lower bound for + + + + - Gets the number of nodes in a #GTree. - + Gets the number of nodes in a #GTree. + - the number of nodes in @tree + the number of nodes in @tree - a #GTree + a #GTree - - Increments the reference count of @tree by one. + + Returns the first in-order node of the tree, or %NULL +for an empty tree. + + + the first node in the tree + + + + + a #GTree + + + + + + Returns the last in-order node of the tree, or %NULL +for an empty tree. + + + the last node in the tree + + + + + a #GTree + + + + + + Increments the reference count of @tree by one. It is safe to call this function from any thread. - - - the passed in #GTree + + + the passed in #GTree - a #GTree + a #GTree - Removes a key/value pair from a #GTree. + Removes a key/value pair from a #GTree. If the #GTree was created using g_tree_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to @@ -40997,36 +29864,61 @@ If the key does not exist in the #GTree, the function does nothing. The cost of maintaining a balanced tree while removing a key/value result in a O(n log(n)) operation where most of the other operations are O(log(n)). - + - %TRUE if the key was found (prior to 2.8, this function + %TRUE if the key was found (prior to 2.8, this function returned nothing) - a #GTree + a #GTree - - the key to remove + + the key to remove + + Removes all nodes from a #GTree and destroys their keys and values, +then resets the #GTree’s root to %NULL. + + + + + + + a #GTree + + + + - Inserts a new key and value into a #GTree similar to g_tree_insert(). + Inserts a new key and value into a #GTree as g_tree_replace_node() does, +only this function does not return the inserted or set node. + + + + + + + a #GTree + + + + the key to insert + + + + the value corresponding to the key + + + + + + Inserts a new key and value into a #GTree similar to g_tree_insert_node(). The difference is that if the key already exists in the #GTree, it gets replaced by the new key. If you supplied a @value_destroy_func when creating the #GTree, the old value is freed using that function. If you @@ -41035,41 +29927,28 @@ freed using that function. The tree is automatically 'balanced' as new key/value pairs are added, so that the distance from the root to every leaf is as small as possible. - + - + the inserted (or set) node. + - a #GTree + a #GTree - - the key to insert + + the key to insert - - the value corresponding to the key + + the value corresponding to the key - Searches a #GTree using @search_func. + Searches a #GTree using @search_func. The @search_func is called with a pointer to the key of a key/value pair in the tree, and the passed in @user_data. If @search_func returns @@ -41078,286 +29957,233 @@ the result of g_tree_search(). If @search_func returns -1, searching will proceed among the key/value pairs that have a smaller key; if @search_func returns 1, searching will proceed among the key/value pairs that have a larger key. - + - the value corresponding to the found key, or %NULL + the value corresponding to the found key, or %NULL if the key was not found - a #GTree + a #GTree - a function used to search the #GTree + a function used to search the #GTree - - the data passed as the second argument to @search_func + + the data passed as the second argument to @search_func + + + + + + Searches a #GTree using @search_func. + +The @search_func is called with a pointer to the key of a key/value +pair in the tree, and the passed in @user_data. If @search_func returns +0 for a key/value pair, then the corresponding node is returned as +the result of g_tree_search(). If @search_func returns -1, searching +will proceed among the key/value pairs that have a smaller key; if +@search_func returns 1, searching will proceed among the key/value +pairs that have a larger key. + + + the node corresponding to the + found key, or %NULL if the key was not found + + + + + a #GTree + + + + a function used to search the #GTree + + + + the data passed as the second argument to @search_func - Removes a key and its associated value from a #GTree without calling + Removes a key and its associated value from a #GTree without calling the key and value destroy functions. If the key does not exist in the #GTree, the function does nothing. - + - %TRUE if the key was found (prior to 2.8, this function + %TRUE if the key was found (prior to 2.8, this function returned nothing) - a #GTree + a #GTree - - the key to remove + + the key to remove - - Calls the given function for each node in the #GTree. + + Calls the given function for each node in the #GTree. The order of a balanced tree is somewhat arbitrary. If you just want to visit all nodes in sorted order, use g_tree_foreach() instead. If you really need to visit nodes in a different order, consider using an [n-ary tree][glib-N-ary-Trees]. - + - a #GTree + a #GTree - - the function to call for each node visited. If this + + the function to call for each node visited. If this function returns %TRUE, the traversal is stopped. - the order in which nodes are visited, one of %G_IN_ORDER, + the order in which nodes are visited, one of %G_IN_ORDER, %G_PRE_ORDER and %G_POST_ORDER - - user data to pass to the function + + user data to pass to the function - Decrements the reference count of @tree by one. + Decrements the reference count of @tree by one. If the reference count drops to 0, all keys and values will be destroyed (if destroy functions were specified) and all memory allocated by @tree will be released. It is safe to call this function from any thread. - + - a #GTree + a #GTree - - Creates a new #GTree. - - - a newly allocated #GTree - + + Gets the upper bound node corresponding to the given key, +or %NULL if the tree is empty or all the nodes in the tree +have keys that are lower than or equal to the searched key. + +The upper bound is the first node that has its key strictly greater +than the searched key. + + + the tree node corresponding to the + upper bound, or %NULL if the tree is empty or has only keys + lower than or equal to the searched key. + - - the function used to order the nodes in the #GTree. - It should return values similar to the standard strcmp() function - - 0 if the two arguments are equal, a negative value if the first argument - comes before the second, or a positive value if the first argument comes - after the second. - + + a #GTree + + + + the key to calculate the upper bound for + - - - Creates a new #GTree like g_tree_new() and allows to specify functions -to free the memory allocated for the key and value that get called when -removing the entry from the #GTree. - - - a newly allocated #GTree - - - - - qsort()-style comparison function - - - - data to pass to comparison function - - - - a function to free the memory allocated for the key - used when removing the entry from the #GTree or %NULL if you don't - want to supply such a function - - - - a function to free the memory allocated for the - value used when removing the entry from the #GTree or %NULL if you - don't want to supply such a function - - - - - - Creates a new #GTree with a comparison function that accepts user data. -See g_tree_new() for more details. - - - a newly allocated #GTree - - - - - qsort()-style comparison function - - - - data to pass to comparison function - - - - + - - This macro can be used to mark a function declaration as unavailable. + + An opaque type which identifies a specific node in a #GTree. + + + Gets the key stored at a particular tree node. + + + the key at the node. + + + + + a #GTree node + + + + + + Returns the next in-order node of the tree, or %NULL +if the passed node was already the last one. + + + the next node in the tree + + + + + a #GTree node + + + + + + Returns the previous in-order node of the tree, or %NULL +if the passed node was already the first one. + + + the previous node in the tree + + + + + a #GTree node + + + + + + Gets the value stored at a particular tree node. + + + the value at the node. + + + + + a #GTree node + + + + + + + This macro can be used to mark a function declaration as unavailable. It must be placed before the function declaration. Use of a function that has been annotated with this macros will produce a compiler warning. - + - the major version that introduced the symbol + the major version that introduced the symbol - the minor version that introduced the symbol + the minor version that introduced the symbol - - + + @@ -41365,10 +30191,8 @@ that has been annotated with this macros will produce a compiler warning. - - + + @@ -41376,10 +30200,8 @@ that has been annotated with this macros will produce a compiler warning. - - + + @@ -41387,10 +30209,8 @@ that has been annotated with this macros will produce a compiler warning. - - + + @@ -41398,383 +30218,200 @@ that has been annotated with this macros will produce a compiler warning. - - The maximum length (in codepoints) of a compatibility or canonical + + The maximum length (in codepoints) of a compatibility or canonical decomposition of a single Unicode character. This is as defined by Unicode 6.1. - + - - Hints the compiler that the expression is unlikely to evaluate to + + Hints the compiler that the expression is unlikely to evaluate to a true value. The compiler may use this information for optimizations. |[<!-- language="C" --> if (G_UNLIKELY (random () == 1)) g_print ("a random one"); ]| - + - the expression + the expression - Works like g_mutex_unlock(), but for a lock defined with -#G_LOCK_DEFINE. + Works like g_mutex_unlock(), but for a lock defined with +%G_LOCK_DEFINE. - the name of the lock + the name of the lock - - Generic delimiters characters as defined in + + Generic delimiters characters as defined in [RFC 3986](https://tools.ietf.org/html/rfc3986). Includes `:/?#[]@`. - + - - Subcomponent delimiter characters as defined in + + Subcomponent delimiter characters as defined in [RFC 3986](https://tools.ietf.org/html/rfc3986). Includes `!$&'()*+,;=`. - + - Number of microseconds in one second (1 million). + Number of microseconds in one second (1 million). This macro is provided for code readability. - These are the possible line break classifications. + These are the possible line break classifications. Since new unicode versions may add new types here, applications should be ready to handle unknown values. They may be regarded as %G_UNICODE_BREAK_UNKNOWN. See [Unicode Line Breaking Algorithm](http://www.unicode.org/unicode/reports/tr14/). - - - Mandatory Break (BK) + + + Mandatory Break (BK) - - Carriage Return (CR) + + Carriage Return (CR) - - Line Feed (LF) + + Line Feed (LF) - - Attached Characters and Combining Marks (CM) + + Attached Characters and Combining Marks (CM) - - Surrogates (SG) + + Surrogates (SG) - - Zero Width Space (ZW) + + Zero Width Space (ZW) - - Inseparable (IN) + + Inseparable (IN) - - Non-breaking ("Glue") (GL) + + Non-breaking ("Glue") (GL) - - Contingent Break Opportunity (CB) + + Contingent Break Opportunity (CB) - Space (SP) + Space (SP) - Break Opportunity After (BA) + Break Opportunity After (BA) - Break Opportunity Before (BB) + Break Opportunity Before (BB) - - Break Opportunity Before and After (B2) + + Break Opportunity Before and After (B2) - Hyphen (HY) + Hyphen (HY) - - Nonstarter (NS) + + Nonstarter (NS) - - Opening Punctuation (OP) + + Opening Punctuation (OP) - - Closing Punctuation (CL) + + Closing Punctuation (CL) - - Ambiguous Quotation (QU) + + Ambiguous Quotation (QU) - - Exclamation/Interrogation (EX) + + Exclamation/Interrogation (EX) - - Ideographic (ID) + + Ideographic (ID) - Numeric (NU) + Numeric (NU) - - Infix Separator (Numeric) (IS) + + Infix Separator (Numeric) (IS) - Symbols Allowing Break After (SY) + Symbols Allowing Break After (SY) - - Ordinary Alphabetic and Symbol Characters (AL) + + Ordinary Alphabetic and Symbol Characters (AL) - Prefix (Numeric) (PR) + Prefix (Numeric) (PR) - Postfix (Numeric) (PO) + Postfix (Numeric) (PO) - - Complex Content Dependent (South East Asian) (SA) + + Complex Content Dependent (South East Asian) (SA) - - Ambiguous (Alphabetic or Ideographic) (AI) + + Ambiguous (Alphabetic or Ideographic) (AI) - Unknown (XX) + Unknown (XX) - - Next Line (NL) + + Next Line (NL) - - Word Joiner (WJ) + + Word Joiner (WJ) - - Hangul L Jamo (JL) + + Hangul L Jamo (JL) - - Hangul V Jamo (JV) + + Hangul V Jamo (JV) - - Hangul T Jamo (JT) + + Hangul T Jamo (JT) - - Hangul LV Syllable (H2) + + Hangul LV Syllable (H2) - - Hangul LVT Syllable (H3) + + Hangul LVT Syllable (H3) - - Closing Parenthesis (CP). Since 2.28 + + Closing Parenthesis (CP). Since 2.28. Deprecated: 2.70: Use %G_UNICODE_BREAK_CLOSE_PARENTHESIS instead. - - Conditional Japanese Starter (CJ). Since: 2.32 + + Closing Parenthesis (CP). Since 2.70 - - Hebrew Letter (HL). Since: 2.32 + + Conditional Japanese Starter (CJ). Since: 2.32 - - Regional Indicator (RI). Since: 2.36 + + Hebrew Letter (HL). Since: 2.32 - - Emoji Base (EB). Since: 2.50 + + Regional Indicator (RI). Since: 2.36 - - Emoji Modifier (EM). Since: 2.50 + + Emoji Base (EB). Since: 2.50 - - Zero Width Joiner (ZWJ). Since: 2.50 + + Emoji Modifier (EM). Since: 2.50 + + + Zero Width Joiner (ZWJ). Since: 2.50 - The #GUnicodeScript enumeration identifies different writing + The #GUnicodeScript enumeration identifies different writing systems. The values correspond to the names as defined in the Unicode standard. The enumeration has been added in GLib 2.14, and is interchangeable with #PangoScript. @@ -41782,1217 +30419,604 @@ and is interchangeable with #PangoScript. Note that new types may be added in the future. Applications should be ready to handle unknown values. See [Unicode Standard Annex #24: Script names](http://www.unicode.org/reports/tr24/). - - - a value never returned from g_unichar_get_script() + + + a value never returned from g_unichar_get_script() - a character used by multiple different scripts + a character used by multiple different scripts - - a mark glyph that takes its script from the + + a mark glyph that takes its script from the base glyph to which it is attached - Arabic + Arabic - - Armenian + + Armenian - Bengali + Bengali - - Bopomofo + + Bopomofo - - Cherokee + + Cherokee - Coptic + Coptic - - Cyrillic + + Cyrillic - Deseret + Deseret - - Devanagari + + Devanagari - - Ethiopic + + Ethiopic - - Georgian + + Georgian - Gothic + Gothic - Greek + Greek - - Gujarati + + Gujarati - - Gurmukhi + + Gurmukhi - Han + Han - Hangul + Hangul - Hebrew + Hebrew - - Hiragana + + Hiragana - - Kannada + + Kannada - - Katakana + + Katakana - Khmer + Khmer - Lao + Lao - Latin + Latin - - Malayalam + + Malayalam - - Mongolian + + Mongolian - - Myanmar + + Myanmar - Ogham + Ogham - - Old Italic + + Old Italic - Oriya + Oriya - Runic + Runic - - Sinhala + + Sinhala - Syriac + Syriac - Tamil + Tamil - Telugu + Telugu - Thaana + Thaana - Thai + Thai - - Tibetan + + Tibetan - - Canadian Aboriginal + + Canadian Aboriginal - Yi + Yi - - Tagalog + + Tagalog - - Hanunoo + + Hanunoo - Buhid + Buhid - - Tagbanwa + + Tagbanwa - - Braille + + Braille - - Cypriot + + Cypriot - Limbu + Limbu - - Osmanya + + Osmanya - - Shavian + + Shavian - - Linear B + + Linear B - Tai Le + Tai Le - - Ugaritic + + Ugaritic - - New Tai Lue + + New Tai Lue - - Buginese + + Buginese - - Glagolitic + + Glagolitic - - Tifinagh + + Tifinagh - - Syloti Nagri + + Syloti Nagri - - Old Persian + + Old Persian - - Kharoshthi + + Kharoshthi - - an unassigned code point + + an unassigned code point - - Balinese + + Balinese - - Cuneiform + + Cuneiform - - Phoenician + + Phoenician - - Phags-pa + + Phags-pa - N'Ko + N'Ko - - Kayah Li. Since 2.16.3 + + Kayah Li. Since 2.16.3 - Lepcha. Since 2.16.3 + Lepcha. Since 2.16.3 - Rejang. Since 2.16.3 + Rejang. Since 2.16.3 - - Sundanese. Since 2.16.3 + + Sundanese. Since 2.16.3 - - Saurashtra. Since 2.16.3 + + Saurashtra. Since 2.16.3 - Cham. Since 2.16.3 + Cham. Since 2.16.3 - - Ol Chiki. Since 2.16.3 + + Ol Chiki. Since 2.16.3 - Vai. Since 2.16.3 + Vai. Since 2.16.3 - Carian. Since 2.16.3 + Carian. Since 2.16.3 - Lycian. Since 2.16.3 + Lycian. Since 2.16.3 - Lydian. Since 2.16.3 + Lydian. Since 2.16.3 - - Avestan. Since 2.26 + + Avestan. Since 2.26 - Bamum. Since 2.26 + Bamum. Since 2.26 - - Egyptian Hieroglpyhs. Since 2.26 + + Egyptian Hieroglpyhs. Since 2.26 - - Imperial Aramaic. Since 2.26 + + Imperial Aramaic. Since 2.26 - - Inscriptional Pahlavi. Since 2.26 + + Inscriptional Pahlavi. Since 2.26 - - Inscriptional Parthian. Since 2.26 + + Inscriptional Parthian. Since 2.26 - - Javanese. Since 2.26 + + Javanese. Since 2.26 - Kaithi. Since 2.26 + Kaithi. Since 2.26 - Lisu. Since 2.26 + Lisu. Since 2.26 - - Meetei Mayek. Since 2.26 + + Meetei Mayek. Since 2.26 - - Old South Arabian. Since 2.26 + + Old South Arabian. Since 2.26 - - Old Turkic. Since 2.28 + + Old Turkic. Since 2.28 - - Samaritan. Since 2.26 + + Samaritan. Since 2.26 - - Tai Tham. Since 2.26 + + Tai Tham. Since 2.26 - - Tai Viet. Since 2.26 + + Tai Viet. Since 2.26 - Batak. Since 2.28 + Batak. Since 2.28 - Brahmi. Since 2.28 + Brahmi. Since 2.28 - - Mandaic. Since 2.28 + + Mandaic. Since 2.28 - Chakma. Since: 2.32 + Chakma. Since: 2.32 - - Meroitic Cursive. Since: 2.32 + + Meroitic Cursive. Since: 2.32 - - Meroitic Hieroglyphs. Since: 2.32 + + Meroitic Hieroglyphs. Since: 2.32 - Miao. Since: 2.32 + Miao. Since: 2.32 - - Sharada. Since: 2.32 + + Sharada. Since: 2.32 - - Sora Sompeng. Since: 2.32 + + Sora Sompeng. Since: 2.32 - Takri. Since: 2.32 + Takri. Since: 2.32 - - Bassa. Since: 2.42 + + Bassa. Since: 2.42 - - Caucasian Albanian. Since: 2.42 + + Caucasian Albanian. Since: 2.42 - - Duployan. Since: 2.42 + + Duployan. Since: 2.42 - - Elbasan. Since: 2.42 + + Elbasan. Since: 2.42 - - Grantha. Since: 2.42 + + Grantha. Since: 2.42 - Kjohki. Since: 2.42 + Kjohki. Since: 2.42 - - Khudawadi, Sindhi. Since: 2.42 + + Khudawadi, Sindhi. Since: 2.42 - - Linear A. Since: 2.42 + + Linear A. Since: 2.42 - - Mahajani. Since: 2.42 + + Mahajani. Since: 2.42 - - Manichaean. Since: 2.42 + + Manichaean. Since: 2.42 - - Mende Kikakui. Since: 2.42 + + Mende Kikakui. Since: 2.42 - Modi. Since: 2.42 + Modi. Since: 2.42 - Mro. Since: 2.42 + Mro. Since: 2.42 - - Nabataean. Since: 2.42 + + Nabataean. Since: 2.42 - - Old North Arabian. Since: 2.42 + + Old North Arabian. Since: 2.42 - - Old Permic. Since: 2.42 + + Old Permic. Since: 2.42 - - Pahawh Hmong. Since: 2.42 + + Pahawh Hmong. Since: 2.42 - - Palmyrene. Since: 2.42 + + Palmyrene. Since: 2.42 - - Pau Cin Hau. Since: 2.42 + + Pau Cin Hau. Since: 2.42 - - Psalter Pahlavi. Since: 2.42 + + Psalter Pahlavi. Since: 2.42 - - Siddham. Since: 2.42 + + Siddham. Since: 2.42 - - Tirhuta. Since: 2.42 + + Tirhuta. Since: 2.42 - - Warang Citi. Since: 2.42 + + Warang Citi. Since: 2.42 - Ahom. Since: 2.48 + Ahom. Since: 2.48 - - Anatolian Hieroglyphs. Since: 2.48 + + Anatolian Hieroglyphs. Since: 2.48 - Hatran. Since: 2.48 + Hatran. Since: 2.48 - - Multani. Since: 2.48 + + Multani. Since: 2.48 - - Old Hungarian. Since: 2.48 + + Old Hungarian. Since: 2.48 - - Signwriting. Since: 2.48 + + Signwriting. Since: 2.48 - Adlam. Since: 2.50 + Adlam. Since: 2.50 - - Bhaiksuki. Since: 2.50 + + Bhaiksuki. Since: 2.50 - - Marchen. Since: 2.50 + + Marchen. Since: 2.50 - Newa. Since: 2.50 + Newa. Since: 2.50 - Osage. Since: 2.50 + Osage. Since: 2.50 - Tangut. Since: 2.50 + Tangut. Since: 2.50 - - Masaram Gondi. Since: 2.54 + + Masaram Gondi. Since: 2.54 - Nushu. Since: 2.54 + Nushu. Since: 2.54 - - Soyombo. Since: 2.54 + + Soyombo. Since: 2.54 - - Zanabazar Square. Since: 2.54 + + Zanabazar Square. Since: 2.54 - Dogra. Since: 2.58 + Dogra. Since: 2.58 - - Gunjala Gondi. Since: 2.58 + + Gunjala Gondi. Since: 2.58 - - Hanifi Rohingya. Since: 2.58 + + Hanifi Rohingya. Since: 2.58 - - Makasar. Since: 2.58 + + Makasar. Since: 2.58 - - Medefaidrin. Since: 2.58 + + Medefaidrin. Since: 2.58 - - Old Sogdian. Since: 2.58 + + Old Sogdian. Since: 2.58 - - Sogdian. Since: 2.58 + + Sogdian. Since: 2.58 - - Elym. Since: 2.62 + + Elym. Since: 2.62 - - Nand. Since: 2.62 + + Nand. Since: 2.62 - - Rohg. Since: 2.62 + + Rohg. Since: 2.62 - Wcho. Since: 2.62 + Wcho. Since: 2.62 - - Chorasmian. Since: 2.66 + + Chorasmian. Since: 2.66 - - Dives Akuru. Since: 2.66 + + Dives Akuru. Since: 2.66 - - Khitan small script. Since: 2.66 + + Khitan small script. Since: 2.66 - Yezidi. Since: 2.66 + Yezidi. Since: 2.66 - These are the possible character classifications from the + These are the possible character classifications from the Unicode specification. See [Unicode Character Database](http://www.unicode.org/reports/tr44/#General_Category_Values). - General category "Other, Control" (Cc) + General category "Other, Control" (Cc) - General category "Other, Format" (Cf) + General category "Other, Format" (Cf) - General category "Other, Not Assigned" (Cn) + General category "Other, Not Assigned" (Cn) - - General category "Other, Private Use" (Co) + + General category "Other, Private Use" (Co) - General category "Other, Surrogate" (Cs) + General category "Other, Surrogate" (Cs) - - General category "Letter, Lowercase" (Ll) + + General category "Letter, Lowercase" (Ll) - - General category "Letter, Modifier" (Lm) + + General category "Letter, Modifier" (Lm) - - General category "Letter, Other" (Lo) + + General category "Letter, Other" (Lo) - - General category "Letter, Titlecase" (Lt) + + General category "Letter, Titlecase" (Lt) - - General category "Letter, Uppercase" (Lu) + + General category "Letter, Uppercase" (Lu) - - General category "Mark, Spacing" (Mc) + + General category "Mark, Spacing" (Mc) - - General category "Mark, Enclosing" (Me) + + General category "Mark, Enclosing" (Me) - - General category "Mark, Nonspacing" (Mn) + + General category "Mark, Nonspacing" (Mn) - - General category "Number, Decimal Digit" (Nd) + + General category "Number, Decimal Digit" (Nd) - - General category "Number, Letter" (Nl) + + General category "Number, Letter" (Nl) - - General category "Number, Other" (No) + + General category "Number, Other" (No) - - General category "Punctuation, Connector" (Pc) + + General category "Punctuation, Connector" (Pc) - - General category "Punctuation, Dash" (Pd) + + General category "Punctuation, Dash" (Pd) - - General category "Punctuation, Close" (Pe) + + General category "Punctuation, Close" (Pe) - - General category "Punctuation, Final quote" (Pf) + + General category "Punctuation, Final quote" (Pf) - - General category "Punctuation, Initial quote" (Pi) + + General category "Punctuation, Initial quote" (Pi) - - General category "Punctuation, Other" (Po) + + General category "Punctuation, Other" (Po) - - General category "Punctuation, Open" (Ps) + + General category "Punctuation, Open" (Ps) - - General category "Symbol, Currency" (Sc) + + General category "Symbol, Currency" (Sc) - - General category "Symbol, Modifier" (Sk) + + General category "Symbol, Modifier" (Sk) - - General category "Symbol, Math" (Sm) + + General category "Symbol, Math" (Sm) - - General category "Symbol, Other" (So) + + General category "Symbol, Other" (So) - - General category "Separator, Line" (Zl) + + General category "Separator, Line" (Zl) - - General category "Separator, Paragraph" (Zp) + + General category "Separator, Paragraph" (Zp) - - General category "Separator, Space" (Zs) + + General category "Separator, Space" (Zs) - The type of functions to be called when a UNIX fd watch source + The type of functions to be called when a UNIX fd watch source triggers. - %FALSE if the source should be removed + %FALSE if the source should be removed - the fd that triggered the event + the fd that triggered the event - the IO conditions reported on @fd + the IO conditions reported on @fd - - user data passed to g_unix_fd_add() + + user data passed to g_unix_fd_add() - - The #GUri type and related functions can be used to parse URIs into + + The #GUri type and related functions can be used to parse URIs into their components, and build valid URIs from individual components. Note that #GUri scope is to help manipulate URIs in various applications, @@ -43007,10 +31031,10 @@ security-sensitive decisions. ## Relative and absolute URIs # {#relative-absolute-uris} As defined in [RFC 3986](https://tools.ietf.org/html/rfc3986#section-4), the -hierarchical nature of URIs means that they can either be ‘relative -references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for -clarity, ‘URIs’ are referred to in this documentation as -‘absolute URIs’ — although +hierarchical nature of URIs means that they can either be ‘relative +references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for +clarity, ‘URIs’ are referred to in this documentation as +‘absolute URIs’ — although [in constrast to RFC 3986](https://tools.ietf.org/html/rfc3986#section-4.3), fragment identifiers are always allowed). @@ -43038,7 +31062,7 @@ what forms they accept. The most minimalist APIs for parsing URIs are g_uri_split() and g_uri_split_with_user(). These split a URI into its component parts, and return the parts; the difference between the two is that -g_uri_split() treats the ‘userinfo’ component of the URI as a +g_uri_split() treats the ‘userinfo’ component of the URI as a single element, while g_uri_split_with_user() can (depending on the #GUriFlags you pass) treat it as containing a username, password, and authentication parameters. Alternatively, g_uri_split_network() @@ -43094,87 +31118,64 @@ g_filename_to_uri() if you want to properly convert between Note that there is no `g_uri_equal ()` function, because comparing URIs usefully requires scheme-specific knowledge that #GUri does -not have. For example, `http://example.com/` and -`http://EXAMPLE.COM:80` have exactly the same meaning according -to the HTTP specification, and `data:,foo` and -`data:;base64,Zm9v` resolve to the same thing according to the -`data:` URI specification. +not have. #GUri can help with normalization if you use the various +encoded #GUriFlags as well as %G_URI_FLAGS_SCHEME_NORMALIZE however +it is not comprehensive. +For example, `data:,foo` and `data:;base64,Zm9v` resolve to the same +thing according to the `data:` URI specification which GLib does not +handle. - - Gets @uri's authentication parameters, which may contain + + Gets @uri's authentication parameters, which may contain `%`-encoding, depending on the flags with which @uri was created. (If @uri was not created with %G_URI_FLAGS_HAS_AUTH_PARAMS then this will be %NULL.) Depending on the URI scheme, g_uri_parse_params() may be useful for further parsing this information. - + - @uri's authentication parameters. + @uri's authentication parameters. - a #GUri + a #GUri - Gets @uri's flags set upon construction. - + Gets @uri's flags set upon construction. + - @uri's flags. + @uri's flags. - a #GUri + a #GUri - - Gets @uri's fragment, which may contain `%`-encoding, depending on + + Gets @uri's fragment, which may contain `%`-encoding, depending on the flags with which @uri was created. - + - @uri's fragment. + @uri's fragment. - a #GUri + a #GUri - Gets @uri's host. This will never have `%`-encoded characters, + Gets @uri's host. This will never have `%`-encoded characters, unless it is non-UTF-8 (which can only be the case if @uri was created with %G_URI_FLAGS_NON_DNS). @@ -43183,246 +31184,169 @@ that address, without the brackets around it that are necessary in the string form of the URI. Note that in this case there may also be a scope ID attached to the address. Eg, `fe80::1234%``em1` (or `fe80::1234%``25em1` if the string is still encoded). - - - @uri's host. + + + @uri's host. - a #GUri + a #GUri - - Gets @uri's password, which may contain `%`-encoding, depending on + + Gets @uri's password, which may contain `%`-encoding, depending on the flags with which @uri was created. (If @uri was not created with %G_URI_FLAGS_HAS_PASSWORD then this will be %NULL.) - + - @uri's password. + @uri's password. - a #GUri + a #GUri - Gets @uri's path, which may contain `%`-encoding, depending on the + Gets @uri's path, which may contain `%`-encoding, depending on the flags with which @uri was created. - + - @uri's path. + @uri's path. - a #GUri + a #GUri - Gets @uri's port. - + Gets @uri's port. + - @uri's port, or `-1` if no port was specified. + @uri's port, or `-1` if no port was specified. - a #GUri + a #GUri - Gets @uri's query, which may contain `%`-encoding, depending on the + Gets @uri's query, which may contain `%`-encoding, depending on the flags with which @uri was created. For queries consisting of a series of `name=value` parameters, #GUriParamsIter or g_uri_parse_params() may be useful. - + - @uri's query. + @uri's query. - a #GUri + a #GUri - Gets @uri's scheme. Note that this will always be all-lowercase, + Gets @uri's scheme. Note that this will always be all-lowercase, regardless of the string or strings that @uri was created from. - + - @uri's scheme. + @uri's scheme. - a #GUri + a #GUri - Gets the ‘username’ component of @uri's userinfo, which may contain + Gets the ‘username’ component of @uri's userinfo, which may contain `%`-encoding, depending on the flags with which @uri was created. If @uri was not created with %G_URI_FLAGS_HAS_PASSWORD or %G_URI_FLAGS_HAS_AUTH_PARAMS, this is the same as g_uri_get_userinfo(). - + - @uri's user. + @uri's user. - a #GUri + a #GUri - - Gets @uri's userinfo, which may contain `%`-encoding, depending on + + Gets @uri's userinfo, which may contain `%`-encoding, depending on the flags with which @uri was created. - + - @uri's userinfo. + @uri's userinfo. - a #GUri + a #GUri - - Parses @uri_ref according to @flags and, if it is a + + Parses @uri_ref according to @flags and, if it is a [relative URI][relative-absolute-uris], resolves it relative to @base_uri. If the result is not a valid absolute URI, it will be discarded, and an error returned. - + - a new #GUri. + a new #GUri, or NULL on error. - - a base absolute URI + + a base absolute URI - a string representing a relative or absolute URI + a string representing a relative or absolute URI - flags describing how to parse @uri_ref + flags describing how to parse @uri_ref - - Increments the reference count of @uri by one. + + Increments the reference count of @uri by one. - @uri + @uri - a #GUri + a #GUri - Returns a string representing @uri. + Returns a string representing @uri. This is not guaranteed to return a string which is identical to the string that @uri was parsed from. However, if the source URI was @@ -43434,60 +31358,41 @@ URI (according to RFC 3986). If @uri might contain sensitive details, such as authentication parameters, or private data in its query string, and the returned string is going to be logged, then consider using g_uri_to_string_partial() to redact parts. - + - a string representing @uri, which the caller - must free. + a string representing @uri, + which the caller must free. - a #GUri + a #GUri - - Returns a string representing @uri, subject to the options in + + Returns a string representing @uri, subject to the options in @flags. See g_uri_to_string() and #GUriHideFlags for more details. - + - a string representing @uri, which the caller - must free. + a string representing + @uri, which the caller must free. - a #GUri + a #GUri - flags describing what parts of @uri to hide + flags describing what parts of @uri to hide - - Atomically decrements the reference count of @uri by one. + + Atomically decrements the reference count of @uri by one. When the reference count reaches zero, the resources allocated by @uri are freed @@ -43497,187 +31402,109 @@ When the reference count reaches zero, the resources allocated by - a #GUri + a #GUri - Creates a new #GUri from the given components according to @flags. + Creates a new #GUri from the given components according to @flags. See also g_uri_build_with_user(), which allows specifying the components of the "userinfo" separately. - + - a new #GUri + a new #GUri - flags describing how to build the #GUri + flags describing how to build the #GUri - the URI scheme + the URI scheme - - the userinfo component, or %NULL + + the userinfo component, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - - Creates a new #GUri from the given components according to @flags + + Creates a new #GUri from the given components according to @flags (%G_URI_FLAGS_HAS_PASSWORD is added unconditionally). The @flags must be coherent with the passed values, in particular use `%`-encoded values with %G_URI_FLAGS_ENCODED. In contrast to g_uri_build(), this allows specifying the components -of the ‘userinfo’ field separately. Note that @user must be non-%NULL +of the ‘userinfo’ field separately. Note that @user must be non-%NULL if either @password or @auth_params is non-%NULL. - + - a new #GUri + a new #GUri - flags describing how to build the #GUri + flags describing how to build the #GUri - the URI scheme + the URI scheme - - the user component of the userinfo, or %NULL + + the user component of the userinfo, or %NULL - - the password component of the userinfo, or %NULL + + the password component of the userinfo, or %NULL - - the auth params of the userinfo, or %NULL + + the auth params of the userinfo, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL @@ -43687,63 +31514,44 @@ if either @password or @auth_params is non-%NULL. - - Escapes arbitrary data for use in a URI. + + Escapes arbitrary data for use in a URI. -Normally all characters that are not ‘unreserved’ (i.e. ASCII +Normally all characters that are not ‘unreserved’ (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in @reserved_chars_allowed -they are not escaped. This is useful for the ‘reserved’ characters +they are not escaped. This is useful for the ‘reserved’ characters in the URI specification, since those are allowed unescaped in some portions of a URI. Though technically incorrect, this will also allow escaping nul bytes as `%``00`. - + - an escaped version of @unescaped. The returned - string should be freed when no longer needed. + an escaped version of @unescaped. + The returned string should be freed when no longer needed. - the unescaped input data. + the unescaped input data. - the length of @unescaped + the length of @unescaped - - a string of reserved + + a string of reserved characters that are allowed to be used, or %NULL. - - Escapes a string for use in a URI. + + Escapes a string for use in a URI. Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are @@ -43751,79 +31559,55 @@ escaped. But if you specify characters in @reserved_chars_allowed they are not escaped. This is useful for the "reserved" characters in the URI specification, since those are allowed unescaped in some portions of a URI. - + - an escaped version of @unescaped. The returned string -should be freed when no longer needed. + an escaped version of @unescaped. The +returned string should be freed when no longer needed. - the unescaped input string. + the unescaped input string. - - a string of reserved + + a string of reserved characters that are allowed to be used, or %NULL. - %TRUE if the result can include UTF-8 characters. + %TRUE if the result can include UTF-8 characters. - - Parses @uri_string according to @flags, to determine whether it is a valid + + Parses @uri_string according to @flags, to determine whether it is a valid [absolute URI][relative-absolute-uris], i.e. it does not need to be resolved relative to another URI using g_uri_parse_relative(). -If it’s not a valid URI, an error is returned explaining how it’s invalid. +If it’s not a valid URI, an error is returned explaining how it’s invalid. See g_uri_split(), and the definition of #GUriFlags, for more information on the effect of @flags. - + - %TRUE if @uri_string is a valid absolute URI, %FALSE on error. + %TRUE if @uri_string is a valid absolute URI, %FALSE on error. - a string containing an absolute URI + a string containing an absolute URI - flags for parsing @uri_string + flags for parsing @uri_string - Joins the given components together according to @flags to create + Joins the given components together according to @flags to create an absolute URI string. @path may not be %NULL (though it may be the empty string). @@ -43833,203 +31617,117 @@ character. When @host is not present, @path cannot begin with two slash [RFC 3986, section 3](https://tools.ietf.org/html/rfc3986#section-3). See also g_uri_join_with_user(), which allows specifying the -components of the ‘userinfo’ separately. +components of the ‘userinfo’ separately. %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set in @flags. - + - an absolute URI string + an absolute URI string - flags describing how to build the URI string + flags describing how to build the URI string - - the URI scheme, or %NULL + + the URI scheme, or %NULL - - the userinfo component, or %NULL + + the userinfo component, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - - Joins the given components together according to @flags to create + + Joins the given components together according to @flags to create an absolute URI string. @path may not be %NULL (though it may be the empty string). In contrast to g_uri_join(), this allows specifying the components -of the ‘userinfo’ separately. It otherwise behaves the same. +of the ‘userinfo’ separately. It otherwise behaves the same. %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set in @flags. - + - an absolute URI string + an absolute URI string - flags describing how to build the URI string + flags describing how to build the URI string - - the URI scheme, or %NULL + + the URI scheme, or %NULL - - the user component of the userinfo, or %NULL + + the user component of the userinfo, or %NULL - - the password component of the userinfo, or + + the password component of the userinfo, or %NULL - - the auth params of the userinfo, or + + the auth params of the userinfo, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - - Splits an URI list conforming to the text/uri-list + + Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated. - a newly allocated %NULL-terminated list + a newly allocated %NULL-terminated list of strings holding the individual URIs. The array should be freed with g_strfreev(). @@ -44038,51 +31736,33 @@ discarding any comments. The URIs are not validated. - an URI list + an URI list - - Parses @uri_string according to @flags. If the result is not a + + Parses @uri_string according to @flags. If the result is not a valid [absolute URI][relative-absolute-uris], it will be discarded, and an error returned. - + - a new #GUri. + a new #GUri, or NULL on error. - a string representing an absolute URI + a string representing an absolute URI - flags describing how to parse @uri_string + flags describing how to parse @uri_string - - Many URI schemes include one or more attribute/value pairs as part of the URI + + Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use @@ -44101,18 +31781,16 @@ invalid encoding.) If %G_URI_PARAMS_CASE_INSENSITIVE is passed to @flags, attributes will be compared case-insensitively, so a params string `attr=123&Attr=456` will only -return a single attribute–value pair, `Attr=456`. Case will be preserved in +return a single attribute–value pair, `Attr=456`. Case will be preserved in the returned attributes. If @params cannot be parsed (for example, it contains two @separators characters in a row), then @error is set and %NULL is returned. - + - A hash table of - attribute/value pairs, with both names and values fully-decoded; or %NULL - on error. + + A hash table of attribute/value pairs, with both names and values + fully-decoded; or %NULL on error. @@ -44120,22 +31798,16 @@ characters in a row), then @error is set and %NULL is returned. - a `%`-encoded string containing `attribute=value` + a `%`-encoded string containing `attribute=value` parameters - the length of @params, or `-1` if it is nul-terminated + the length of @params, or `-1` if it is nul-terminated - the separator byte character set between parameters. (usually + the separator byte character set between parameters. (usually `&`, but sometimes `;` or both `&;`). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case @@ -44143,48 +31815,34 @@ characters in a row), then @error is set and %NULL is returned. - flags to modify the way the parameters are handled. + flags to modify the way the parameters are handled. - - Gets the scheme portion of a URI string. + + Gets the scheme portion of a URI string. [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include `file`, `https`, `svn+ssh`, etc. - + - The ‘scheme’ component of the URI, or + The ‘scheme’ component of the URI, or %NULL on error. The returned string should be freed when no longer needed. - a valid URI. + a valid URI. - - Gets the scheme portion of a URI string. + + Gets the scheme portion of a URI string. [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme as: |[ @@ -44194,75 +31852,51 @@ Common schemes include `file`, `https`, `svn+ssh`, etc. Unlike g_uri_parse_scheme(), the returned scheme is normalized to all-lowercase and does not need to be freed. - + - The ‘scheme’ component of the URI, or + The ‘scheme’ component of the URI, or %NULL on error. The returned string is normalized to all-lowercase, and interned via g_intern_string(), so it does not need to be freed. - a valid URI. + a valid URI. - - Parses @uri_ref according to @flags and, if it is a + + Parses @uri_ref according to @flags and, if it is a [relative URI][relative-absolute-uris], resolves it relative to @base_uri_string. If the result is not a valid absolute URI, it will be discarded, and an error returned. (If @base_uri_string is %NULL, this just returns @uri_ref, or %NULL if @uri_ref is invalid or not absolute.) - + - the resolved URI string. + the resolved URI string, +or NULL on error. - - a string representing a base URI + + a string representing a base URI - a string representing a relative or absolute URI + a string representing a relative or absolute URI - flags describing how to parse @uri_ref + flags describing how to parse @uri_ref - - Parses @uri_ref (which can be an + + Parses @uri_ref (which can be an [absolute or relative URI][relative-absolute-uris]) according to @flags, and returns the pieces. Any component that doesn't appear in @uri_ref will be returned as %NULL (but note that all URIs always have a path component, @@ -44278,198 +31912,99 @@ Note that the %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS @flags are ignored by g_uri_split(), since it always returns only the full userinfo; use g_uri_split_with_user() if you want it split up. - + - %TRUE if @uri_ref parsed successfully, %FALSE + %TRUE if @uri_ref parsed successfully, %FALSE on error. - a string containing a relative or absolute URI + a string containing a relative or absolute URI - flags for parsing @uri_ref + flags for parsing @uri_ref - - on return, contains + + on return, contains the scheme (converted to lowercase), or %NULL - - on return, contains + + on return, contains the userinfo, or %NULL - - on return, contains the + + on return, contains the host, or %NULL - - on return, contains the + + on return, contains the port, or `-1` - - on return, contains the + + on return, contains the path - - on return, contains the + + on return, contains the query, or %NULL - - on return, contains + + on return, contains the fragment, or %NULL - - Parses @uri_string (which must be an [absolute URI][relative-absolute-uris]) + + Parses @uri_string (which must be an [absolute URI][relative-absolute-uris]) according to @flags, and returns the pieces relevant to connecting to a host. See the documentation for g_uri_split() for more details; this is mostly a wrapper around that function with simpler arguments. However, it will return an error if @uri_string is a relative URI, or does not contain a hostname component. - + - %TRUE if @uri_string parsed successfully, + %TRUE if @uri_string parsed successfully, %FALSE on error. - a string containing an absolute URI + a string containing an absolute URI - flags for parsing @uri_string + flags for parsing @uri_string - - on return, contains + + on return, contains the scheme (converted to lowercase), or %NULL - - on return, contains the + + on return, contains the host, or %NULL - - on return, contains the + + on return, contains the port, or `-1` - - Parses @uri_ref (which can be an + + Parses @uri_ref (which can be an [absolute or relative URI][relative-absolute-uris]) according to @flags, and returns the pieces. Any component that doesn't appear in @uri_ref will be returned as %NULL (but note that all URIs always have a path component, @@ -44480,151 +32015,70 @@ information on the effect of @flags. Note that @password will only be parsed out if @flags contains %G_URI_FLAGS_HAS_PASSWORD, and @auth_params will only be parsed out if @flags contains %G_URI_FLAGS_HAS_AUTH_PARAMS. - + - %TRUE if @uri_ref parsed successfully, %FALSE + %TRUE if @uri_ref parsed successfully, %FALSE on error. - a string containing a relative or absolute URI + a string containing a relative or absolute URI - flags for parsing @uri_ref + flags for parsing @uri_ref - - on return, contains + + on return, contains the scheme (converted to lowercase), or %NULL - - on return, contains + + on return, contains the user, or %NULL - - on return, contains + + on return, contains the password, or %NULL - - on return, contains + + on return, contains the auth_params, or %NULL - - on return, contains the + + on return, contains the host, or %NULL - - on return, contains the + + on return, contains the port, or `-1` - - on return, contains the + + on return, contains the path - - on return, contains the + + on return, contains the query, or %NULL - - on return, contains + + on return, contains the fragment, or %NULL - - Unescapes a segment of an escaped string as binary data. + + Unescapes a segment of an escaped string as binary data. Note that in contrast to g_uri_unescape_string(), this does allow nul bytes to appear in the output. @@ -44634,47 +32088,32 @@ character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling. - + - an unescaped version of @escaped_string or %NULL on - error (if decoding failed, using %G_URI_ERROR_FAILED error code). The - returned #GBytes should be unreffed when no longer needed. + an unescaped version of @escaped_string + or %NULL on error (if decoding failed, using %G_URI_ERROR_FAILED error + code). The returned #GBytes should be unreffed when no longer needed. - A URI-escaped string + A URI-escaped string - the length (in bytes) of @escaped_string to escape, or `-1` if it + the length (in bytes) of @escaped_string to escape, or `-1` if it is nul-terminated. - - a string of illegal characters + + a string of illegal characters not to be allowed, or %NULL. - - Unescapes a segment of an escaped string. + + Unescapes a segment of an escaped string. If any of the characters in @illegal_characters or the NUL character appears as an escaped character in @escaped_string, then @@ -44684,203 +32123,122 @@ escaped path element, which might confuse pathname handling. Note: `NUL` byte is not accepted in the output, in contrast to g_uri_unescape_bytes(). - - - an unescaped version of @escaped_string or %NULL on error. -The returned string should be freed when no longer needed. As a -special case if %NULL is given for @escaped_string, this function -will return %NULL. + + + an unescaped version of @escaped_string, +or %NULL on error. The returned string should be freed when no longer +needed. As a special case if %NULL is given for @escaped_string, this +function will return %NULL. - - A string, may be %NULL + + A string, may be %NULL - - Pointer to end of @escaped_string, + + Pointer to end of @escaped_string, may be %NULL - - An optional string of illegal + + An optional string of illegal characters not to be allowed, may be %NULL - - Unescapes a whole escaped string. + + Unescapes a whole escaped string. If any of the characters in @illegal_characters or the NUL character appears as an escaped character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling. - - - an unescaped version of @escaped_string. The returned string -should be freed when no longer needed. + + + an unescaped version of @escaped_string. +The returned string should be freed when no longer needed. - an escaped string to be unescaped. + an escaped string to be unescaped. - - a string of illegal characters + + a string of illegal characters not to be allowed, or %NULL. - - Error codes returned by #GUri methods. - + + Error codes returned by #GUri methods. + - Generic error if no more specific error is available. + Generic error if no more specific error is available. See the error message for details. - - The scheme of a URI could not be parsed. + + The scheme of a URI could not be parsed. - The user/userinfo of a URI could not be parsed. + The user/userinfo of a URI could not be parsed. - - The password of a URI could not be parsed. + + The password of a URI could not be parsed. - - The authentication parameters of a URI could not be parsed. + + The authentication parameters of a URI could not be parsed. - The host of a URI could not be parsed. + The host of a URI could not be parsed. - The port of a URI could not be parsed. + The port of a URI could not be parsed. - The path of a URI could not be parsed. + The path of a URI could not be parsed. - The query of a URI could not be parsed. + The query of a URI could not be parsed. - - The fragment of a URI could not be parsed. + + The fragment of a URI could not be parsed. - Flags that describe a URI. + Flags that describe a URI. When parsing a URI, if you need to choose different flags based on the type of URI, you can use g_uri_peek_scheme() on the URI string to check the scheme first, and use that to decide what flags to parse it with. - + - No flags set. + No flags set. - - Parse the URI more relaxedly than the + + Parse the URI more relaxedly than the [RFC 3986](https://tools.ietf.org/html/rfc3986) grammar specifies, fixing up or ignoring common mistakes in URIs coming from external sources. This is also needed for some obscure URI schemes where `;` - separates the host from the path. Don’t use this flag unless you need to. + separates the host from the path. Don’t use this flag unless you need to. - - The userinfo field may contain a password, + + The userinfo field may contain a password, which will be separated from the username by `:`. - - The userinfo may contain additional + + The userinfo may contain additional authentication-related parameters, which will be separated from the username and/or password by `;`. - When parsing a URI, this indicates that `%`-encoded + When parsing a URI, this indicates that `%`-encoded characters in the userinfo, path, query, and fragment fields should not be decoded. (And likewise the host field if %G_URI_FLAGS_NON_DNS is also set.) When building a URI, it indicates @@ -44888,122 +32246,82 @@ parse it with. should not do any encoding itself. - The host component should not be assumed to be a + The host component should not be assumed to be a DNS hostname or IP address (for example, for `smb` URIs with NetBIOS hostnames). - - Same as %G_URI_FLAGS_ENCODED, for the query + + Same as %G_URI_FLAGS_ENCODED, for the query field only. - - Same as %G_URI_FLAGS_ENCODED, for the path only. + + Same as %G_URI_FLAGS_ENCODED, for the path only. - - Same as %G_URI_FLAGS_ENCODED, for the + + Same as %G_URI_FLAGS_ENCODED, for the fragment only. + + A scheme-based normalization will be applied. + For example, when parsing an HTTP URI changing omitted path to `/` and + omitted port to `80`; and when building a URI, changing empty path to `/` + and default port `80`). This only supports a subset of known schemes. (Since: 2.68) + - Flags describing what parts of the URI to hide in + Flags describing what parts of the URI to hide in g_uri_to_string_partial(). Note that %G_URI_HIDE_PASSWORD and %G_URI_HIDE_AUTH_PARAMS will only work if the #GUri was parsed with the corresponding flags. - + - No flags set. + No flags set. - Hide the userinfo. + Hide the userinfo. - Hide the password. + Hide the password. - - Hide the auth_params. + + Hide the auth_params. - Hide the query. + Hide the query. - Hide the fragment. + Hide the fragment. - Flags modifying the way parameters are handled by g_uri_parse_params() and + Flags modifying the way parameters are handled by g_uri_parse_params() and #GUriParamsIter. - + - No flags set. + No flags set. - - Parameter names are case insensitive. + + Parameter names are case insensitive. - Replace `+` with space character. Only useful for + Replace `+` with space character. Only useful for URLs on the web, using the `https` or `http` schemas. - - See %G_URI_FLAGS_PARSE_RELAXED. + + See %G_URI_FLAGS_PARSE_RELAXED. - Many URI schemes include one or more attribute/value pairs as part of the URI + Many URI schemes include one or more attribute/value pairs as part of the URI value. For example `scheme://server/path?query=string&is=there` has two -attributes – `query=string` and `is=there` – in its query part. +attributes – `query=string` and `is=there` – in its query part. A #GUriParamsIter structure represents an iterator that can be used to iterate over the attribute/value pairs of a URI query string. #GUriParamsIter structures are typically allocated on the stack and then initialized with g_uri_params_iter_init(). See the documentation for g_uri_params_iter_init() for a usage example. - + @@ -45019,9 +32337,7 @@ for a usage example. - Initializes an attribute/value pair iterator. + Initializes an attribute/value pair iterator. The iterator keeps pointers to the @params and @separators arguments, those variables must thus outlive the iterator and not be modified during the @@ -45054,34 +32370,26 @@ while (g_uri_params_iter_next (&iter, &unowned_attr, &unowned_value, if (error) // handle parsing error ]| - + - an uninitialized #GUriParamsIter + an uninitialized #GUriParamsIter - a `%`-encoded string containing `attribute=value` + a `%`-encoded string containing `attribute=value` parameters - the length of @params, or `-1` if it is nul-terminated + the length of @params, or `-1` if it is nul-terminated - the separator byte character set between parameters. (usually + the separator byte character set between parameters. (usually `&`, but sometimes `;` or both `&;`). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case @@ -45089,20 +32397,13 @@ if (error) - flags to modify the way the parameters are handled. + flags to modify the way the parameters are handled. - - Advances @iter and retrieves the next attribute/value. %FALSE is returned if + + Advances @iter and retrieves the next attribute/value. %FALSE is returned if an error has occurred (in which case @error is set), or if the end of the iteration is reached (in which case @attribute and @value are set to %NULL and the iterator becomes invalid). If %TRUE is returned, @@ -45111,44 +32412,24 @@ attribute/value pair. Note that the same @attribute may be returned multiple times, since URIs allow repeated attributes. - + - %FALSE if the end of the parameters has been reached or an error was + %FALSE if the end of the parameters has been reached or an error was encountered. %TRUE otherwise. - an initialized #GUriParamsIter + an initialized #GUriParamsIter - - on return, contains + + on return, contains the attribute, or %NULL. - - on return, contains + + on return, contains the value, or %NULL. @@ -45156,9 +32437,7 @@ allow repeated attributes. - These are logical ids for special directories which are defined + These are logical ids for special directories which are defined depending on the platform used. You should use g_get_user_special_dir() to retrieve the full path associated to the logical id. @@ -45166,80 +32445,41 @@ The #GUserDirectory enumeration can be extended at later date. Not every platform has a directory for every logical id in this enumeration. - - the user's Desktop directory + + the user's Desktop directory - - the user's Documents directory + + the user's Documents directory - - the user's Downloads directory + + the user's Downloads directory - - the user's Music directory + + the user's Music directory - - the user's Pictures directory + + the user's Pictures directory - - the user's shared directory + + the user's shared directory - - the user's Templates directory + + the user's Templates directory - - the user's Movies directory + + the user's Movies directory - - the number of enum values + + the number of enum values - - A stack-allocated #GVariantBuilder must be initialized if it is + + A stack-allocated #GVariantBuilder must be initialized if it is used together with g_auto() to avoid warnings or crashes if function returns before g_variant_builder_init() is called on the -builder. This macro can be used as initializer instead of an +builder. + +This macro can be used as initializer instead of an explicit zeroing a variable when declaring it and a following g_variant_builder_init(), but it cannot be assigned to a variable. @@ -45248,27 +32488,21 @@ lifetime issues, as copying the @variant_type does not happen in the G_VARIANT_BUILDER_INIT() call, but rather in functions that make sure that #GVariantBuilder is valid. -|[ +|[<!-- language="C" --> g_auto(GVariantBuilder) builder = G_VARIANT_BUILDER_INIT (G_VARIANT_TYPE_BYTESTRING); ]| - + - a const GVariantType* + a const GVariantType* - - A stack-allocated #GVariantDict must be initialized if it is used + + A stack-allocated #GVariantDict must be initialized if it is used together with g_auto() to avoid warnings or crashes if function returns before g_variant_dict_init() is called on the builder. + This macro can be used as initializer instead of an explicit zeroing a variable when declaring it and a following g_variant_dict_init(), but it cannot be assigned to a variable. @@ -45282,25 +32516,19 @@ value has to be a constant expression, the only possible value of safely with a different @asv right after the variable was initialized with G_VARIANT_DICT_INIT(). -|[ +|[<!-- language="C" --> g_autoptr(GVariant) variant = get_asv_variant (); g_auto(GVariantDict) dict = G_VARIANT_DICT_INIT (variant); ]| - + - a GVariant* + a GVariant* - - Converts a string to a const #GVariantType. Depending on the + + Converts a string to a const #GVariantType. Depending on the current debugging level, this function may perform a runtime check to ensure that @string is a valid GVariant type string. @@ -45312,31 +32540,26 @@ Since 2.24 - a well-formed #GVariantType type string + a well-formed #GVariantType type string - Portable way to copy va_list variables. + Portable way to copy va_list variables. In order to use this function, you must include string.h yourself, because this macro may use memmove() and GLib does not include -string.h for you. +string.h for you. + +Each invocation of `G_VA_COPY (ap1, ap2)` must be matched with a +corresponding `va_end (ap1)` call in the same function. - the va_list variable to place a copy of @ap2 in + the va_list variable to place a copy of @ap2 in - a va_list + a va_list @@ -45344,13 +32567,8 @@ string.h for you. - - A macro that should be defined by the user prior to including + + A macro that should be defined by the user prior to including the glib.h header. The definition should be one of the predefined GLib version macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,... @@ -45362,18 +32580,11 @@ If the compiler is configured to warn about the use of deprecated functions, then using functions that were deprecated in version %GLIB_VERSION_MIN_REQUIRED or earlier will cause warnings (but using functions deprecated in later releases will not). - + - - #GVariant is a variant datatype; it can contain one or more values + + #GVariant is a variant datatype; it can contain one or more values along with information about the type of the values. A #GVariant may contain simple types, like an integer, or a boolean value; @@ -45382,7 +32593,7 @@ value pairs. A #GVariant is also immutable: once it's been created neither its type nor its content can be modified further. GVariant is useful whenever data needs to be serialized, for example when -sending method parameters in DBus, or when saving settings using GSettings. +sending method parameters in D-Bus, or when saving settings using GSettings. When creating a new #GVariant, you pass the data you want to store in it along with a string representing the type of data you wish to pass to it. @@ -45417,19 +32628,19 @@ see g_variant_ref_sink(). concurrently accessed in any way from any number of threads without problems. -#GVariant is heavily optimised for dealing with data in serialised +#GVariant is heavily optimised for dealing with data in serialized form. It works particularly well with data located in memory-mapped -files. It can perform nearly all deserialisation operations in a +files. It can perform nearly all deserialization operations in a small constant time, usually touching only a single memory page. -Serialised #GVariant data can also be sent over the network. +Serialized #GVariant data can also be sent over the network. #GVariant is largely compatible with D-Bus. Almost all types of #GVariant instances can be sent over D-Bus. See #GVariantType for -exceptions. (However, #GVariant's serialisation format is not the same -as the serialisation format of a D-Bus message body: use #GDBusMessage, +exceptions. (However, #GVariant's serialization format is not the same +as the serialization format of a D-Bus message body: use #GDBusMessage, in the gio library, for those.) -For space-efficiency, the #GVariant serialisation format does not +For space-efficiency, the #GVariant serialization format does not automatically include the variant's length, type or endianness, which must either be implied from context (such as knowledge that a particular file format always contains a little-endian @@ -45459,14 +32670,14 @@ current implementation. The information here is subject to change in the future. The memory allocated by #GVariant can be grouped into 4 broad -purposes: memory for serialised data, memory for the type +purposes: memory for serialized data, memory for the type information cache, buffer management memory and memory for the #GVariant structure itself. -## Serialised Data Memory +## Serialized Data Memory This is the memory that is used for storing GVariant data in -serialised form. This is what would be sent over the network or +serialized form. This is what would be sent over the network or what would end up on disk, not counting any indicator of the endianness, or of the length or type of the top-level variant. @@ -45500,7 +32711,7 @@ item inside the variant. As an example, consider a dictionary mapping strings to variants. In the case that the dictionary is empty, 0 bytes are required for -the serialisation. +the serialization. If we add an item "width" that maps to the int32 value of 500 then we will use 4 byte to store the int32 (so 6 for the variant @@ -45526,7 +32737,7 @@ dictionary. For each GVariant type that currently exists in the program a type information structure is kept in the type information cache. The -type information structure is required for rapid deserialisation. +type information structure is required for rapid deserialization. Continuing with the above example, if a #GVariant exists with the type "a{sv}" then a type information struct will exist for @@ -45571,14 +32782,14 @@ structure is required for many different values of the same type. ## Buffer Management Memory #GVariant uses an internal buffer management structure to deal -with the various different possible sources of serialised data +with the various different possible sources of serialized data that it uses. The buffer is responsible for ensuring that the correct call is made when the data is no longer in use by #GVariant. This may involve a g_free() or a g_slice_free() or even g_mapped_file_unref(). One buffer management structure is used for each chunk of -serialised data. The size of the buffer management structure +serialized data. The size of the buffer management structure is 4 * (void *). On 32-bit systems, that's 16 bytes. ## GVariant structure @@ -45588,7 +32799,7 @@ systems, that's 24 bytes. #GVariant structures only exist if they are explicitly created with API calls. For example, if a #GVariant is constructed out of -serialised data for the example given above (with the dictionary) +serialized data for the example given above (with the dictionary) then although there are 9 individual values that comprise the entire dictionary (two keys, two values, two variants containing the values, two dictionary entries, plus the dictionary itself), @@ -45598,8 +32809,8 @@ dictionary. If calls are made to start accessing the other values then #GVariant instances will exist for those values only for as long as they are in use (ie: until you call g_variant_unref()). The -type information is shared. The serialised data and the buffer -management structure for that serialised data is shared by the +type information is shared. The serialized data and the buffer +management structure for that serialized data is shared by the child. ## Summary @@ -45607,22 +32818,17 @@ child. To put the entire example together, for our dictionary mapping strings to variants (with two entries, as given above), we are using 91 bytes of memory for type information, 29 bytes of memory -for the serialised data, 16 bytes for buffer management and 24 +for the serialized data, 16 bytes for buffer management and 24 bytes for the #GVariant instance, or a total of 160 bytes, plus malloc overhead. If we were to use g_variant_get_child_value() to access the two dictionary entries, we would use an additional 48 bytes. If we were to have other dictionaries of the same type, we -would use more memory for the serialised data and buffer +would use more memory for the serialized data and buffer management for those dictionaries, but the type information would be shared. - - Creates a new #GVariant instance. + + Creates a new #GVariant instance. Think of this function as an analogue to g_strdup_printf(). @@ -45650,34 +32856,24 @@ new_variant = g_variant_new ("(t^as)", (guint64) some_flags, some_strings); ]| - + - a new floating #GVariant instance + a new floating #GVariant instance - a #GVariant format string + a #GVariant format string - arguments, as per @format_string + arguments, as per @format_string - - Creates a new #GVariant array from @children. + + Creates a new #GVariant array from @children. @child_type must be non-%NULL if @n_children is zero. Otherwise, the child type is determined by inspecting the first element of the @@ -45694,91 +32890,57 @@ If the @children are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink(). - a floating reference to a new #GVariant array + a floating reference to a new #GVariant array - - the element type of the new array + + the element type of the new array - - an array of + + an array of #GVariant pointers, the children - the length of @children + the length of @children - - Creates a new boolean #GVariant instance -- either %TRUE or %FALSE. + + Creates a new boolean #GVariant instance -- either %TRUE or %FALSE. - a floating reference to a new boolean #GVariant instance + a floating reference to a new boolean #GVariant instance - a #gboolean value + a #gboolean value - - Creates a new byte #GVariant instance. + + Creates a new byte #GVariant instance. - a floating reference to a new byte #GVariant instance + a floating reference to a new byte #GVariant instance - a #guint8 value + a #guint8 value - - Creates an array-of-bytes #GVariant with the contents of @string. + + Creates an array-of-bytes #GVariant with the contents of @string. This function is just like g_variant_new_string() except that the string need not be valid UTF-8. @@ -45786,16 +32948,12 @@ The nul terminator character at the end of the string is stored in the array. - a floating reference to a new bytestring #GVariant instance + a floating reference to a new bytestring #GVariant instance - a normal + a normal nul-terminated string in no particular encoding @@ -45803,99 +32961,67 @@ the array. - - Constructs an array of bytestring #GVariant from the given array of + + Constructs an array of bytestring #GVariant from the given array of strings. If @length is -1 then @strv is %NULL-terminated. - a new floating #GVariant instance + a new floating #GVariant instance - an array of strings + an array of strings - the length of @strv, or -1 + the length of @strv, or -1 - - Creates a new dictionary entry #GVariant. @key and @value must be + + Creates a new dictionary entry #GVariant. @key and @value must be non-%NULL. @key must be a value of a basic type (ie: not a container). If the @key or @value are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink(). - a floating reference to a new dictionary entry #GVariant + a floating reference to a new dictionary entry #GVariant - a basic #GVariant, the key + a basic #GVariant, the key - a #GVariant, the value + a #GVariant, the value - - Creates a new double #GVariant instance. + + Creates a new double #GVariant instance. - a floating reference to a new double #GVariant instance + a floating reference to a new double #GVariant instance - a #gdouble floating point value + a #gdouble floating point value - - Constructs a new array #GVariant instance, where the elements are + + Constructs a new array #GVariant instance, where the elements are of @element_type type. @elements must be an array with fixed-sized elements. Numeric types are @@ -45904,54 +33030,37 @@ fixed-size as are tuples containing only other fixed-sized types. @element_size must be the size of a single element in the array. For example, if calling this function for an array of 32-bit integers, you might say sizeof(gint32). This value isn't used except for the purpose -of a double-check that the form of the serialised data matches the caller's +of a double-check that the form of the serialized data matches the caller's expectation. @n_elements must be the length of the @elements array. - a floating reference to a new array #GVariant instance + a floating reference to a new array #GVariant instance - the #GVariantType of each element + the #GVariantType of each element - - a pointer to the fixed array of contiguous elements + + a pointer to the fixed array of contiguous elements - the number of elements + the number of elements - the size of each element + the size of each element - - Constructs a new serialised-mode #GVariant instance. This is the -inner interface for creation of new serialised values that gets + + Constructs a new serialized-mode #GVariant instance. This is the +inner interface for creation of new serialized values that gets called from various functions in gvariant.c. A reference is taken on @bytes. @@ -45961,38 +33070,26 @@ Otherwise this function will internally create a copy of the memory (since GLib 2.60) or (in older versions) fail and exit the process. - a new #GVariant with a floating reference + a new #GVariant with a floating reference - a #GVariantType + a #GVariantType - a #GBytes + a #GBytes - if the contents of @bytes are trusted + if the contents of @bytes are trusted - - Creates a new #GVariant instance from serialised data. + + Creates a new #GVariant instance from serialized data. @type is the type of #GVariant instance that will be constructed. The interpretation of @data depends on knowing the type. @@ -46002,8 +33099,8 @@ unchanging value until such a time as @notify is called with @user_data. If the contents of @data change before that time then the result is undefined. -If @data is trusted to be serialised data in normal form then -@trusted should be %TRUE. This applies to serialised data created +If @data is trusted to be serialized data in normal form then +@trusted should be %TRUE. This applies to serialized data created within this process or read from a trusted location on the disk (such as a file installed in /usr/lib alongside your application). You should set trusted to %FALSE if @data is read from the network, a @@ -46023,153 +33120,100 @@ the memory (since GLib 2.60) or (in older versions) fail and exit the process. - a new floating #GVariant of type @type + a new floating #GVariant of type @type - a definite #GVariantType + a definite #GVariantType - the serialised data + the serialized data - the size of @data + the size of @data - %TRUE if @data is definitely in normal form + %TRUE if @data is definitely in normal form - function to call when @data is no longer needed + function to call when @data is no longer needed - - data for @notify + + data for @notify - - Creates a new handle #GVariant instance. + + Creates a new handle #GVariant instance. By convention, handles are indexes into an array of file descriptors that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them. - a floating reference to a new handle #GVariant instance + a floating reference to a new handle #GVariant instance - a #gint32 value + a #gint32 value - - Creates a new int16 #GVariant instance. + + Creates a new int16 #GVariant instance. - a floating reference to a new int16 #GVariant instance + a floating reference to a new int16 #GVariant instance - a #gint16 value + a #gint16 value - - Creates a new int32 #GVariant instance. + + Creates a new int32 #GVariant instance. - a floating reference to a new int32 #GVariant instance + a floating reference to a new int32 #GVariant instance - a #gint32 value + a #gint32 value - - Creates a new int64 #GVariant instance. + + Creates a new int64 #GVariant instance. - a floating reference to a new int64 #GVariant instance + a floating reference to a new int64 #GVariant instance - a #gint64 value + a #gint64 value - - Depending on if @child is %NULL, either wraps @child inside of a + + Depending on if @child is %NULL, either wraps @child inside of a maybe container or creates a Nothing instance for the given @type. At least one of @child_type and @child must be non-%NULL. @@ -46181,62 +33225,38 @@ If @child is a floating reference (see g_variant_ref_sink()), the new instance takes ownership of @child. - a floating reference to a new #GVariant maybe instance + a floating reference to a new #GVariant maybe instance - - the #GVariantType of the child, or %NULL + + the #GVariantType of the child, or %NULL - - the child value, or %NULL + + the child value, or %NULL - - Creates a D-Bus object path #GVariant with the contents of @string. + + Creates a D-Bus object path #GVariant with the contents of @string. @string must be a valid D-Bus object path. Use g_variant_is_object_path() if you're not sure. - a floating reference to a new object path #GVariant instance + a floating reference to a new object path #GVariant instance - a normal C nul-terminated string + a normal C nul-terminated string - - Constructs an array of object paths #GVariant from the given array of + + Constructs an array of object paths #GVariant from the given array of strings. Each string must be a valid #GVariant object path; see @@ -46245,34 +33265,24 @@ g_variant_is_object_path(). If @length is -1 then @strv is %NULL-terminated. - a new floating #GVariant instance + a new floating #GVariant instance - an array of strings + an array of strings - the length of @strv, or -1 + the length of @strv, or -1 - - Parses @format and returns the result. + + Parses @format and returns the result. @format must be a text format #GVariant with one extension: at any point that a value may appear in the text, a '%' character followed @@ -46304,34 +33314,24 @@ You may not use this function to return, unmodified, a single #GVariant pointer from the argument list. ie: @format may not solely be anything along the lines of "%*", "%?", "\%r", or anything starting with "%@". - + - a new floating #GVariant instance + a new floating #GVariant instance - a text format #GVariant + a text format #GVariant - arguments as per @format + arguments as per @format - - Parses @format and returns the result. + + Parses @format and returns the result. This is the version of g_variant_new_parsed() intended to be used from libraries. @@ -46352,152 +33352,104 @@ returning control to the user that originally provided the pointer. At this point, the caller will have their own full reference to the result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call. - + - a new, usually floating, #GVariant + a new, usually floating, #GVariant - a text format #GVariant + a text format #GVariant - a pointer to a #va_list + a pointer to a #va_list - - Creates a string-type GVariant using printf formatting. + + Creates a string-type GVariant using printf formatting. This is similar to calling g_strdup_printf() and then g_variant_new_string() but it saves a temporary variable and an unnecessary copy. - a floating reference to a new string + a floating reference to a new string #GVariant instance - a printf-style format string + a printf-style format string - arguments for @format_string + arguments for @format_string - - Creates a D-Bus type signature #GVariant with the contents of + + Creates a D-Bus type signature #GVariant with the contents of @string. @string must be a valid D-Bus type signature. Use g_variant_is_signature() if you're not sure. - a floating reference to a new signature #GVariant instance + a floating reference to a new signature #GVariant instance - a normal C nul-terminated string + a normal C nul-terminated string - - Creates a string #GVariant with the contents of @string. + + Creates a string #GVariant with the contents of @string. @string must be valid UTF-8, and must not be %NULL. To encode potentially-%NULL strings, use g_variant_new() with `ms` as the [format string][gvariant-format-strings-maybe-types]. - a floating reference to a new string #GVariant instance + a floating reference to a new string #GVariant instance - a normal UTF-8 nul-terminated string + a normal UTF-8 nul-terminated string - - Constructs an array of strings #GVariant from the given array of + + Constructs an array of strings #GVariant from the given array of strings. If @length is -1 then @strv is %NULL-terminated. - a new floating #GVariant instance + a new floating #GVariant instance - an array of strings + an array of strings - the length of @strv, or -1 + the length of @strv, or -1 - - Creates a string #GVariant with the contents of @string. + + Creates a string #GVariant with the contents of @string. @string must be valid UTF-8, and must not be %NULL. To encode potentially-%NULL strings, use this with g_variant_new_maybe(). @@ -46510,27 +33462,19 @@ it to this function. It is even possible that @string is immediately freed. - a floating reference to a new string + a floating reference to a new string #GVariant instance - a normal UTF-8 nul-terminated string + a normal UTF-8 nul-terminated string - - Creates a new tuple #GVariant out of the items in @children. The + + Creates a new tuple #GVariant out of the items in @children. The type is determined from the types of @children. No entry in the @children array may be %NULL. @@ -46540,101 +33484,66 @@ If the @children are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink(). - a floating reference to a new #GVariant tuple + a floating reference to a new #GVariant tuple - the items to make the tuple out of + the items to make the tuple out of - the length of @children + the length of @children - - Creates a new uint16 #GVariant instance. + + Creates a new uint16 #GVariant instance. - a floating reference to a new uint16 #GVariant instance + a floating reference to a new uint16 #GVariant instance - a #guint16 value + a #guint16 value - - Creates a new uint32 #GVariant instance. + + Creates a new uint32 #GVariant instance. - a floating reference to a new uint32 #GVariant instance + a floating reference to a new uint32 #GVariant instance - a #guint32 value + a #guint32 value - - Creates a new uint64 #GVariant instance. + + Creates a new uint64 #GVariant instance. - a floating reference to a new uint64 #GVariant instance + a floating reference to a new uint64 #GVariant instance - a #guint64 value + a #guint64 value - - This function is intended to be used by libraries based on + + This function is intended to be used by libraries based on #GVariant that want to provide g_variant_new()-like functionality to their users. @@ -46670,68 +33579,47 @@ returning control to the user that originally provided the pointer. At this point, the caller will have their own full reference to the result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call. - + - a new, usually floating, #GVariant + a new, usually floating, #GVariant - a string that is prefixed with a format string + a string that is prefixed with a format string - - location to store the end pointer, + + location to store the end pointer, or %NULL - a pointer to a #va_list + a pointer to a #va_list - - Boxes @value. The result is a #GVariant instance representing a + + Boxes @value. The result is a #GVariant instance representing a variant containing the original value. If @child is a floating reference (see g_variant_ref_sink()), the new instance takes ownership of @child. - a floating reference to a new variant #GVariant instance + a floating reference to a new variant #GVariant instance - a #GVariant instance + a #GVariant instance - Performs a byteswapping operation on the contents of @value. The + Performs a byteswapping operation on the contents of @value. The result is that all multi-byte numeric data contained in @value is byteswapped. That includes 16, 32, and 64bit signed and unsigned integers as well as file handles and double precision floating point @@ -46744,26 +33632,18 @@ bytes and containers containing only these things (recursively). The returned value is always in normal form and is marked as trusted. - the byteswapped form of @value + the byteswapped form of @value - a #GVariant + a #GVariant - - Checks if calling g_variant_get() with @format_string on @value would + + Checks if calling g_variant_get() with @format_string on @value would be valid from a type-compatibility standpoint. @format_string is assumed to be a valid format string (from a syntactic standpoint). @@ -46777,58 +33657,42 @@ check fails then a g_critical() is printed and %FALSE is returned. This function is meant to be used by functions that wish to provide varargs accessors to #GVariant values of uncertain values (eg: g_variant_lookup() or g_menu_model_get_item_attribute()). - + - %TRUE if @format_string is safe to use + %TRUE if @format_string is safe to use - a #GVariant + a #GVariant - a valid #GVariant format string + a valid #GVariant format string - %TRUE to ensure the format string makes deep copies + %TRUE to ensure the format string makes deep copies - Classifies @value according to its top-level type. + Classifies @value according to its top-level type. - the #GVariantClass of @value + the #GVariantClass of @value - a #GVariant + a #GVariant - Compares @one and @two. + Compares @one and @two. The types of @one and @two are #gconstpointer only to allow use of this function with #GTree, #GPtrArray, etc. They must each be a @@ -46847,44 +33711,32 @@ the handling of incomparable values (ie: NaN) is undefined. If you only require an equality comparison, g_variant_equal() is more general. - + - negative value if a < b; + negative value if a < b; zero if a = b; positive value if a > b. - a basic-typed #GVariant instance + a basic-typed #GVariant instance - a #GVariant instance of the same type + a #GVariant instance of the same type - - Similar to g_variant_get_bytestring() except that instead of + + Similar to g_variant_get_bytestring() except that instead of returning a constant string, the string is duplicated. The return value must be freed using g_free(). - + a newly allocated string @@ -46892,31 +33744,18 @@ The return value must be freed using g_free(). - an array-of-bytes #GVariant instance + an array-of-bytes #GVariant instance - - a pointer to a #gsize, to store + + a pointer to a #gsize, to store the length (not including the nul terminator) - - Gets the contents of an array of array of bytes #GVariant. This call + + Gets the contents of an array of array of bytes #GVariant. This call makes a deep copy; the return result should be released with g_strfreev(). @@ -46928,37 +33767,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of strings + an array of strings - an array of array of bytes #GVariant ('aay') + an array of array of bytes #GVariant ('aay') - - the length of the result, or %NULL + + the length of the result, or %NULL - Gets the contents of an array of object paths #GVariant. This call + Gets the contents of an array of object paths #GVariant. This call makes a deep copy; the return result should be released with g_strfreev(). @@ -46970,39 +33796,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of strings + an array of strings - an array of object paths #GVariant + an array of object paths #GVariant - - the length of the result, or %NULL + + the length of the result, or %NULL - - Similar to g_variant_get_string() except that instead of returning + + Similar to g_variant_get_string() except that instead of returning a constant string, the string is duplicated. The string will always be UTF-8 encoded. @@ -47010,33 +33821,22 @@ The string will always be UTF-8 encoded. The return value must be freed using g_free(). - a newly allocated string, UTF-8 encoded + a newly allocated string, UTF-8 encoded - a string #GVariant instance + a string #GVariant instance - - a pointer to a #gsize, to store the length + + a pointer to a #gsize, to store the length - Gets the contents of an array of strings #GVariant. This call + Gets the contents of an array of strings #GVariant. This call makes a deep copy; the return result should be released with g_strfreev(). @@ -47048,69 +33848,45 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of strings + an array of strings - an array of strings #GVariant + an array of strings #GVariant - - the length of the result, or %NULL + + the length of the result, or %NULL - Checks if @one and @two have the same type and value. + Checks if @one and @two have the same type and value. The types of @one and @two are #gconstpointer only to allow use of this function with #GHashTable. They must each be a #GVariant. - %TRUE if @one and @two are equal + %TRUE if @one and @two are equal - a #GVariant instance + a #GVariant instance - a #GVariant instance + a #GVariant instance - - Deconstructs a #GVariant instance. + + Deconstructs a #GVariant instance. Think of this function as an analogue to scanf(). @@ -47126,85 +33902,61 @@ extended in the future. the values and also determines if the values are copied or borrowed, see the section on [GVariant format strings][gvariant-format-strings-pointers]. - + - a #GVariant instance + a #GVariant instance - a #GVariant format string + a #GVariant format string - arguments, as per @format_string + arguments, as per @format_string - - Returns the boolean value of @value. + + Returns the boolean value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_BOOLEAN. - %TRUE or %FALSE + %TRUE or %FALSE - a boolean #GVariant instance + a boolean #GVariant instance - Returns the byte value of @value. + Returns the byte value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_BYTE. - a #guint8 + a #guint8 - a byte #GVariant instance + a byte #GVariant instance - - Returns the string value of a #GVariant instance with an + + Returns the string value of a #GVariant instance with an array-of-bytes type. The string has no particular encoding. If the array does not end with a nul terminator character, the empty @@ -47224,9 +33976,7 @@ array of bytes. The return value remains valid as long as @value exists. - + the constant string @@ -47234,19 +33984,13 @@ The return value remains valid as long as @value exists. - an array-of-bytes #GVariant instance + an array-of-bytes #GVariant instance - - Gets the contents of an array of array of bytes #GVariant. This call + + Gets the contents of an array of array of bytes #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified. @@ -47258,40 +34002,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of constant strings + an array of constant strings - an array of array of bytes #GVariant ('aay') + an array of array of bytes #GVariant ('aay') - - the length of the result, or %NULL + + the length of the result, or %NULL - - Reads a child item out of a container #GVariant instance and + + Reads a child item out of a container #GVariant instance and deconstructs it according to @format_string. This call is essentially a combination of g_variant_get_child_value() and g_variant_get(). @@ -47306,37 +34034,25 @@ see the section on - a container #GVariant + a container #GVariant - the index of the child to deconstruct + the index of the child to deconstruct - a #GVariant format string + a #GVariant format string - arguments, as per @format_string + arguments, as per @format_string - - Reads a child item out of a container #GVariant instance. This + + Reads a child item out of a container #GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of #GVariant. @@ -47349,7 +34065,7 @@ g_variant_unref() when you're done with it. Note that values borrowed from the returned child are not guaranteed to still be valid after the child is freed even if you still hold a reference -to @value, if @value has not been serialised at the time this function is +to @value, if @value has not been serialized at the time this function is called. To avoid this, you can serialize @value by calling g_variant_get_data() and optionally ignoring the return value. @@ -47361,127 +34077,94 @@ nesting up to at least 64 levels. This function is O(1). - the child at the specified index + the child at the specified index - a container #GVariant + a container #GVariant - the index of the child to fetch + the index of the child to fetch - Returns a pointer to the serialised form of a #GVariant instance. + Returns a pointer to the serialized form of a #GVariant instance. The returned data may not be in fully-normalised form if read from an untrusted source. The returned data must not be freed; it remains valid for as long as @value exists. -If @value is a fixed-sized value that was deserialised from a -corrupted serialised container then %NULL may be returned. In this +If @value is a fixed-sized value that was deserialized from a +corrupted serialized container then %NULL may be returned. In this case, the proper thing to do is typically to use the appropriate number of nul bytes in place of @value. If @value is not fixed-sized then %NULL is never returned. -In the case that @value is already in serialised form, this function -is O(1). If the value is not already in serialised form, -serialisation occurs implicitly and is approximately O(n) in the size +In the case that @value is already in serialized form, this function +is O(1). If the value is not already in serialized form, +serialization occurs implicitly and is approximately O(n) in the size of the result. -To deserialise the data returned by this function, in addition to the -serialised data, you must know the type of the #GVariant, and (if the +To deserialize the data returned by this function, in addition to the +serialized data, you must know the type of the #GVariant, and (if the machine might be different) the endianness of the machine that stored it. As a result, file formats or network messages that incorporate -serialised #GVariants must include this information either +serialized #GVariants must include this information either implicitly (for instance "the file always contains a %G_VARIANT_TYPE_VARIANT and it is always in little-endian order") or explicitly (by storing the type and/or endianness in addition to the -serialised data). +serialized data). - the serialised form of @value, or %NULL + the serialized form of @value, or %NULL - a #GVariant instance + a #GVariant instance - - Returns a pointer to the serialised form of a #GVariant instance. + + Returns a pointer to the serialized form of a #GVariant instance. The semantics of this function are exactly the same as g_variant_get_data(), except that the returned #GBytes holds a reference to the variant data. - A new #GBytes representing the variant data + A new #GBytes representing the variant data - a #GVariant + a #GVariant - - Returns the double precision floating point value of @value. + + Returns the double precision floating point value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_DOUBLE. - a #gdouble + a #gdouble - a double #GVariant instance + a double #GVariant instance - - Provides access to the serialised data for an array of fixed-sized + + Provides access to the serialized data for an array of fixed-sized items. @value must be an array with fixed-sized elements. Numeric types are @@ -47489,7 +34172,7 @@ fixed-size, as are tuples containing only other fixed-sized types. @element_size must be the size of a single element in the array, as given by the section on -[serialized data memory][gvariant-serialised-data-memory]. +[serialized data memory][gvariant-serialized-data-memory]. In particular, arrays of these fixed-sized types can be interpreted as an array of the given C type, with @element_size set to the size @@ -47502,16 +34185,14 @@ the appropriate type: For example, if calling this function for an array of 32-bit integers, you might say `sizeof(gint32)`. This value isn't used except for the purpose -of a double-check that the form of the serialised data matches the caller's +of a double-check that the form of the serialized data matches the caller's expectation. @n_elements, which must be non-%NULL, is set equal to the number of items in the array. - a pointer to + a pointer to the fixed array @@ -47519,34 +34200,21 @@ items in the array. - a #GVariant array with fixed-sized elements + a #GVariant array with fixed-sized elements - - a pointer to the location to store the number of items + + a pointer to the location to store the number of items - the size of each element + the size of each element - - Returns the 32-bit signed integer value of @value. + + Returns the 32-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_HANDLE. @@ -47556,124 +34224,84 @@ that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them. - a #gint32 + a #gint32 - a handle #GVariant instance + a handle #GVariant instance - - Returns the 16-bit signed integer value of @value. + + Returns the 16-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT16. - a #gint16 + a #gint16 - an int16 #GVariant instance + an int16 #GVariant instance - - Returns the 32-bit signed integer value of @value. + + Returns the 32-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT32. - a #gint32 + a #gint32 - an int32 #GVariant instance + an int32 #GVariant instance - - Returns the 64-bit signed integer value of @value. + + Returns the 64-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT64. - a #gint64 + a #gint64 - an int64 #GVariant instance + an int64 #GVariant instance - - Given a maybe-typed #GVariant instance, extract its value. If the + + Given a maybe-typed #GVariant instance, extract its value. If the value is Nothing, then this function returns %NULL. - the contents of @value, or %NULL + the contents of @value, or %NULL - a maybe-typed value + a maybe-typed value - - Gets a #GVariant instance that has the same value as @value and is + + Gets a #GVariant instance that has the same value as @value and is trusted to be in normal form. If @value is already trusted to be in normal form then a new @@ -47687,7 +34315,7 @@ If @value is found not to be in normal form then a new trusted #GVariant is created with the same value as @value. It makes sense to call this function if you've received #GVariant -data from untrusted sources and you want to ensure your serialised +data from untrusted sources and you want to ensure your serialized output is definitely in normal form. If @value is already in normal form, a new reference will be returned @@ -47698,24 +34326,18 @@ value from this function to guarantee ownership of a single non-floating reference to it. - a trusted #GVariant + a trusted #GVariant - a #GVariant + a #GVariant - Gets the contents of an array of object paths #GVariant. This call + Gets the contents of an array of object paths #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified. @@ -47727,69 +34349,48 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of constant strings + an array of constant strings - an array of object paths #GVariant + an array of object paths #GVariant - - the length of the result, or %NULL + + the length of the result, or %NULL - Determines the number of bytes that would be required to store @value + Determines the number of bytes that would be required to store @value with g_variant_store(). If @value has a fixed-sized type then this function always returned that fixed size. -In the case that @value is already in serialised form or the size has +In the case that @value is already in serialized form or the size has already been calculated (ie: this function has been called before) then this function is O(1). Otherwise, the size is calculated, an operation which is approximately O(n) in the number of values involved. - the serialised size of @value + the serialized size of @value - a #GVariant instance + a #GVariant instance - - Returns the string value of a #GVariant instance with a string + + Returns the string value of a #GVariant instance with a string type. This includes the types %G_VARIANT_TYPE_STRING, %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE. @@ -47799,7 +34400,7 @@ contain nul bytes. If @length is non-%NULL then the length of the string (in bytes) is returned there. For trusted values, this information is already known. Untrusted values will be validated and, if valid, a strlen() will be -performed. If invalid, a default value will be returned — for +performed. If invalid, a default value will be returned — for %G_VARIANT_TYPE_OBJECT_PATH, this is `"/"`, and for other types it is the empty string. @@ -47809,36 +34410,23 @@ other than those three. The return value remains valid as long as @value exists. - the constant string, UTF-8 encoded + the constant string, UTF-8 encoded - a string #GVariant instance + a string #GVariant instance - - a pointer to a #gsize, + + a pointer to a #gsize, to store the length - Gets the contents of an array of strings #GVariant. This call + Gets the contents of an array of strings #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified. @@ -47850,162 +34438,108 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of constant strings + an array of constant strings - an array of strings #GVariant + an array of strings #GVariant - - the length of the result, or %NULL + + the length of the result, or %NULL - Determines the type of @value. + Determines the type of @value. The return value is valid for the lifetime of @value and must not be freed. - a #GVariantType + a #GVariantType - a #GVariant + a #GVariant - - Returns the type string of @value. Unlike the result of calling + + Returns the type string of @value. Unlike the result of calling g_variant_type_peek_string(), this string is nul-terminated. This string belongs to #GVariant and must not be freed. - the type string for the type of @value + the type string for the type of @value - a #GVariant + a #GVariant - - Returns the 16-bit unsigned integer value of @value. + + Returns the 16-bit unsigned integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT16. - a #guint16 + a #guint16 - a uint16 #GVariant instance + a uint16 #GVariant instance - - Returns the 32-bit unsigned integer value of @value. + + Returns the 32-bit unsigned integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT32. - a #guint32 + a #guint32 - a uint32 #GVariant instance + a uint32 #GVariant instance - - Returns the 64-bit unsigned integer value of @value. + + Returns the 64-bit unsigned integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT64. - a #guint64 + a #guint64 - a uint64 #GVariant instance + a uint64 #GVariant instance - - This function is intended to be used by libraries based on #GVariant + + This function is intended to be used by libraries based on #GVariant that want to provide g_variant_get()-like functionality to their users. @@ -48029,68 +34563,47 @@ varargs call by the user. the values and also determines if the values are copied or borrowed, see the section on [GVariant format strings][gvariant-format-strings-pointers]. - + - a #GVariant + a #GVariant - a string that is prefixed with a format string + a string that is prefixed with a format string - - location to store the end pointer, + + location to store the end pointer, or %NULL - a pointer to a #va_list + a pointer to a #va_list - - Unboxes @value. The result is the #GVariant instance that was + + Unboxes @value. The result is the #GVariant instance that was contained in @value. - the item contained in the variant + the item contained in the variant - a variant #GVariant instance + a variant #GVariant instance - Generates a hash value for a #GVariant instance. + Generates a hash value for a #GVariant instance. The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor @@ -48101,48 +34614,32 @@ The type of @value is #gconstpointer only to allow use of this function with #GHashTable. @value must be a #GVariant. - a hash value corresponding to @value + a hash value corresponding to @value - a basic #GVariant value as a #gconstpointer + a basic #GVariant value as a #gconstpointer - - Checks if @value is a container. + + Checks if @value is a container. - %TRUE if @value is a container + %TRUE if @value is a container - a #GVariant instance + a #GVariant instance - - Checks whether @value has a floating reference count. + + Checks whether @value has a floating reference count. This function should only ever be used to assert that a given variant is or is not floating, or for debug purposes. To acquire a reference @@ -48153,29 +34650,21 @@ See g_variant_ref_sink() for more information about floating reference counts. - whether @value is floating + whether @value is floating - a #GVariant + a #GVariant - - Checks if @value is in normal form. + + Checks if @value is in normal form. The main reason to do this is to detect if a given chunk of -serialised data is in normal form: load the data into a #GVariant +serialized data is in normal form: load the data into a #GVariant using g_variant_new_from_data() and then use this function to check. @@ -48187,55 +34676,36 @@ There may be implementation specific restrictions on deeply nested values. GVariant is guaranteed to handle nesting up to at least 64 levels. - %TRUE if @value is in normal form + %TRUE if @value is in normal form - a #GVariant instance + a #GVariant instance - - Checks if a value has a type matching the provided type. + + Checks if a value has a type matching the provided type. - %TRUE if the type of @value matches @type + %TRUE if the type of @value matches @type - a #GVariant instance + a #GVariant instance - a #GVariantType + a #GVariantType - - Creates a heap-allocated #GVariantIter for iterating over the items + + Creates a heap-allocated #GVariantIter for iterating over the items in @value. Use g_variant_iter_free() to free the return value when you no longer @@ -48245,27 +34715,18 @@ A reference is taken to @value and will be released only when g_variant_iter_free() is called. - a new heap-allocated #GVariantIter + a new heap-allocated #GVariantIter - a container #GVariant + a container #GVariant - - Looks up a value in a dictionary #GVariant. + + Looks up a value in a dictionary #GVariant. This function is a wrapper around g_variant_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, @@ -48281,44 +34742,30 @@ This function is currently implemented with a linear scan. If you plan to do many lookups then #GVariantDict may be more efficient. - %TRUE if a value was unpacked + %TRUE if a value was unpacked - a dictionary #GVariant + a dictionary #GVariant - the key to look up in the dictionary + the key to look up in the dictionary - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - - Looks up a value in a dictionary #GVariant. + + Looks up a value in a dictionary #GVariant. This function works with dictionaries of the type a{s*} (and equally well with type a{o*}, but we only further discuss the string case @@ -48341,41 +34788,26 @@ This function is currently implemented with a linear scan. If you plan to do many lookups then #GVariantDict may be more efficient. - the value of the dictionary key, or %NULL + the value of the dictionary key, or %NULL - a dictionary #GVariant + a dictionary #GVariant - the key to look up in the dictionary + the key to look up in the dictionary - - a #GVariantType, or %NULL + + a #GVariantType, or %NULL - - Determines the number of children in a container #GVariant instance. + + Determines the number of children in a container #GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of #GVariant. @@ -48388,24 +34820,18 @@ only on the type). For dictionary entries, it is always 2 This function is O(1). - the number of children in the container + the number of children in the container - a container #GVariant + a container #GVariant - Pretty-prints @value in the format understood by g_variant_parse(). + Pretty-prints @value in the format understood by g_variant_parse(). The format is described [here][gvariant-text]. @@ -48413,93 +34839,63 @@ If @type_annotate is %TRUE, then type information is included in the output. - a newly-allocated string holding the result. + a newly-allocated string holding the result. - a #GVariant + a #GVariant - %TRUE if type information should be included in + %TRUE if type information should be included in the output - - Behaves as g_variant_print(), but operates on a #GString. + + Behaves as g_variant_print(), but operates on a #GString. If @string is non-%NULL then it is appended to and returned. Else, a new empty #GString is allocated and it is returned. - a #GString containing the string + a #GString containing the string - a #GVariant + a #GVariant - - a #GString, or %NULL + + a #GString, or %NULL - %TRUE if type information should be included in + %TRUE if type information should be included in the output - Increases the reference count of @value. + Increases the reference count of @value. - the same @value + the same @value - a #GVariant + a #GVariant - #GVariant uses a floating reference count system. All functions with + #GVariant uses a floating reference count system. All functions with names starting with `g_variant_new_` return floating references. @@ -48523,32 +34919,26 @@ maintaining normal refcounting semantics in situations where values are not floating. - the same @value + the same @value - a #GVariant + a #GVariant - Stores the serialised form of @value at @data. @data should be + Stores the serialized form of @value at @data. @data should be large enough. See g_variant_get_size(). The stored data is in machine native byte order but may not be in fully-normalised form if read from an untrusted source. See g_variant_get_normal_form() for a solution. -As with g_variant_get_data(), to be able to deserialise the -serialised variant successfully, its type and (if the destination +As with g_variant_get_data(), to be able to deserialize the +serialized variant successfully, its type and (if the destination machine might be different) its endianness must also be available. This function is approximately O(n) in the size of @data. @@ -48558,23 +34948,17 @@ This function is approximately O(n) in the size of @data. - the #GVariant to store + the #GVariant to store - the location to store the serialised data at + the location to store the serialized data at - If @value is floating, sink it. Otherwise, do nothing. + If @value is floating, sink it. Otherwise, do nothing. Typically you want to use g_variant_ref_sink() in order to automatically do the correct thing with respect to floating or @@ -48608,24 +34992,18 @@ an additional reference on top of that one is added. It is best to avoid this situation. - the same @value + the same @value - a #GVariant + a #GVariant - Decreases the reference count of @value. When its reference count + Decreases the reference count of @value. When its reference count drops to 0, the memory used by the variant is freed. @@ -48633,19 +35011,13 @@ drops to 0, the memory used by the variant is freed. - a #GVariant + a #GVariant - - Determines if a given string is a valid D-Bus object path. You + + Determines if a given string is a valid D-Bus object path. You should ensure that a string is a valid D-Bus object path before passing it to g_variant_new_object_path(). @@ -48655,26 +35027,18 @@ must contain only the characters `[A-Z][a-z][0-9]_`. No sequence (including the one following the final `/` character) may be empty. - %TRUE if @string is a D-Bus object path + %TRUE if @string is a D-Bus object path - a normal C nul-terminated string + a normal C nul-terminated string - - Determines if a given string is a valid D-Bus type signature. You + + Determines if a given string is a valid D-Bus type signature. You should ensure that a string is a valid D-Bus type signature before passing it to g_variant_new_signature(). @@ -48682,24 +35046,18 @@ D-Bus type signatures consist of zero or more definite #GVariantType strings in sequence. - %TRUE if @string is a D-Bus type signature + %TRUE if @string is a D-Bus type signature - a normal C nul-terminated string + a normal C nul-terminated string - Parses a #GVariant from a text representation. + Parses a #GVariant from a text representation. A single #GVariant is parsed from the content of @text. @@ -48734,55 +35092,32 @@ produced by g_variant_print()". There may be implementation specific restrictions on deeply nested values, which would result in a %G_VARIANT_PARSE_ERROR_RECURSION error. #GVariant is guaranteed to handle nesting up to at least 64 levels. - + - a non-floating reference to a #GVariant, or %NULL + a non-floating reference to a #GVariant, or %NULL - - a #GVariantType, or %NULL + + a #GVariantType, or %NULL - a string containing a GVariant in text form + a string containing a GVariant in text form - - a pointer to the end of @text, or %NULL + + a pointer to the end of @text, or %NULL - - a location to store the end pointer, or %NULL + + a location to store the end pointer, or %NULL - - Pretty-prints a message showing the context of a #GVariant parse + + Pretty-prints a message showing the context of a #GVariant parse error within the string for which parsing was attempted. The resulting string is suitable for output to the console or other @@ -48811,54 +35146,37 @@ The format of the message may change in a future version. If @source_str was not nul-terminated when you passed it to g_variant_parse() then you must add nul termination before using this function. - + - the printed message + the printed message - a #GError from the #GVariantParseError domain + a #GError from the #GVariantParseError domain - the string that was given to the parser + the string that was given to the parser - + - - Same as g_variant_error_quark(). + + Same as g_variant_error_quark(). Use g_variant_parse_error_quark() instead. - - A utility type for constructing container-type #GVariant instances. + + A utility type for constructing container-type #GVariant instances. This is an opaque structure and may only be accessed using the following functions. @@ -48888,12 +35206,8 @@ access it from more than one thread. - - Allocates and initialises a new #GVariantBuilder. + + Allocates and initialises a new #GVariantBuilder. You should call g_variant_builder_unref() on the return value when it is no longer needed. The memory will not be automatically freed by @@ -48902,29 +35216,20 @@ any other call. In most cases it is easier to place a #GVariantBuilder directly on the stack of the calling function and initialise it with g_variant_builder_init(). - + - a #GVariantBuilder + a #GVariantBuilder - a container type + a container type - - Adds to a #GVariantBuilder. + + Adds to a #GVariantBuilder. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_builder_add_value(). @@ -48954,38 +35259,27 @@ make_pointless_dictionary (void) return g_variant_builder_end (&builder); } ]| - + - a #GVariantBuilder + a #GVariantBuilder - a #GVariant varargs format string + a #GVariant varargs format string - arguments, as per @format_string + arguments, as per @format_string - - Adds to a #GVariantBuilder. + + Adds to a #GVariantBuilder. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new_parsed() followed by @@ -49011,37 +35305,27 @@ make_pointless_dictionary (void) return g_variant_builder_end (&builder); } ]| - + - a #GVariantBuilder + a #GVariantBuilder - a text format #GVariant + a text format #GVariant - arguments as per @format + arguments as per @format - - Adds @value to @builder. + + Adds @value to @builder. It is an error to call this function in any way that would create an inconsistent value to be constructed. Some examples of this are @@ -49051,32 +35335,23 @@ a variant, etc. If @value is a floating reference (see g_variant_ref_sink()), the @builder instance takes ownership of @value. - + - a #GVariantBuilder + a #GVariantBuilder - a #GVariant + a #GVariant - - Releases all memory associated with a #GVariantBuilder without + + Releases all memory associated with a #GVariantBuilder without freeing the #GVariantBuilder structure itself. It typically only makes sense to do this on a stack-allocated @@ -49090,47 +35365,37 @@ This function leaves the #GVariantBuilder structure set to all-zeros. It is valid to call this function on either an initialised #GVariantBuilder or one that is set to all-zeros but it is not valid to call this function on uninitialised memory. - + - a #GVariantBuilder + a #GVariantBuilder - - Closes the subcontainer inside the given @builder that was opened by + + Closes the subcontainer inside the given @builder that was opened by the most recent call to g_variant_builder_open(). It is an error to call this function in any way that would create an inconsistent value to be constructed (ie: too few values added to the subcontainer). - + - a #GVariantBuilder + a #GVariantBuilder - Ends the builder process and returns the constructed value. + Ends the builder process and returns the constructed value. It is not permissible to use @builder in any way after this call except for reference counting operations (in the case of a @@ -49147,29 +35412,20 @@ required). It is also an error to call this function if the builder was created with an indefinite array or maybe type and no children have been added; in this case it is impossible to infer the type of the empty array. - + - a new, floating, #GVariant + a new, floating, #GVariant - a #GVariantBuilder + a #GVariantBuilder - - Initialises a #GVariantBuilder structure. + + Initialises a #GVariantBuilder structure. @type must be non-%NULL. It specifies the type of container to construct. It can be an indefinite type such as @@ -49198,29 +35454,23 @@ with this function. If you ever pass a reference to a should assume that the person receiving that reference may try to use reference counting; you should use g_variant_builder_new() instead of this function. - + - a #GVariantBuilder + a #GVariantBuilder - a container type + a container type - Opens a subcontainer inside the given @builder. When done adding + Opens a subcontainer inside the given @builder. When done adding items to the subcontainer, g_variant_builder_close() must be called. @type is the type of the container: so to build a tuple of several values, @type must include the tuple itself. @@ -49256,189 +35506,120 @@ g_variant_builder_close (&builder); output = g_variant_builder_end (&builder); ]| - + - a #GVariantBuilder + a #GVariantBuilder - the #GVariantType of the container + the #GVariantType of the container - Increases the reference count on @builder. + Increases the reference count on @builder. Don't call this on stack-allocated #GVariantBuilder instances or bad things will happen. - + - a new reference to @builder + a new reference to @builder - a #GVariantBuilder allocated by g_variant_builder_new() + a #GVariantBuilder allocated by g_variant_builder_new() - - Decreases the reference count on @builder. + + Decreases the reference count on @builder. In the event that there are no more references, releases all memory associated with the #GVariantBuilder. Don't call this on stack-allocated #GVariantBuilder instances or bad things will happen. - + - a #GVariantBuilder allocated by g_variant_builder_new() + a #GVariantBuilder allocated by g_variant_builder_new() - The range of possible top-level types of #GVariant instances. + The range of possible top-level types of #GVariant instances. - The #GVariant is a boolean. + The #GVariant is a boolean. - The #GVariant is a byte. + The #GVariant is a byte. - The #GVariant is a signed 16 bit integer. + The #GVariant is a signed 16 bit integer. - The #GVariant is an unsigned 16 bit integer. + The #GVariant is an unsigned 16 bit integer. - The #GVariant is a signed 32 bit integer. + The #GVariant is a signed 32 bit integer. - The #GVariant is an unsigned 32 bit integer. + The #GVariant is an unsigned 32 bit integer. - The #GVariant is a signed 64 bit integer. + The #GVariant is a signed 64 bit integer. - The #GVariant is an unsigned 64 bit integer. + The #GVariant is an unsigned 64 bit integer. - The #GVariant is a file handle index. + The #GVariant is a file handle index. - The #GVariant is a double precision floating + The #GVariant is a double precision floating point value. - The #GVariant is a normal string. + The #GVariant is a normal string. - - The #GVariant is a D-Bus object path + + The #GVariant is a D-Bus object path string. - - The #GVariant is a D-Bus signature string. + + The #GVariant is a D-Bus signature string. - - The #GVariant is a variant. + + The #GVariant is a variant. - The #GVariant is a maybe-typed value. + The #GVariant is a maybe-typed value. - The #GVariant is an array. + The #GVariant is an array. - The #GVariant is a tuple. + The #GVariant is a tuple. - - The #GVariant is a dictionary entry. + + The #GVariant is a dictionary entry. - - #GVariantDict is a mutable interface to #GVariant dictionaries. + + #GVariantDict is a mutable interface to #GVariant dictionaries. It can be used for doing a sequence of dictionary lookups in an efficient way on an existing #GVariant dictionary or it can be used @@ -49527,11 +35708,11 @@ key is not found. Each returns the new dictionary as a floating return result; } ]| - + - + - + @@ -49551,9 +35732,7 @@ key is not found. Each returns the new dictionary as a floating - Allocates and initialises a new #GVariantDict. + Allocates and initialises a new #GVariantDict. You should call g_variant_dict_unref() on the return value when it is no longer needed. The memory will not be automatically freed by @@ -49563,30 +35742,21 @@ In some cases it may be easier to place a #GVariantDict directly on the stack of the calling function and initialise it with g_variant_dict_init(). This is particularly useful when you are using #GVariantDict to construct a #GVariant. - + - a #GVariantDict + a #GVariantDict - - the #GVariant with which to initialise the + + the #GVariant with which to initialise the dictionary - Releases all memory associated with a #GVariantDict without freeing + Releases all memory associated with a #GVariantDict without freeing the #GVariantDict structure itself. It typically only makes sense to do this on a stack-allocated @@ -49600,80 +35770,57 @@ It is valid to call this function on either an initialised #GVariantDict or one that was previously cleared by an earlier call to g_variant_dict_clear() but it is not valid to call this function on uninitialised memory. - + - a #GVariantDict + a #GVariantDict - - Checks if @key exists in @dict. - + + Checks if @key exists in @dict. + - %TRUE if @key is in @dict + %TRUE if @key is in @dict - a #GVariantDict + a #GVariantDict - the key to look up in the dictionary + the key to look up in the dictionary - Returns the current value of @dict as a #GVariant of type + Returns the current value of @dict as a #GVariant of type %G_VARIANT_TYPE_VARDICT, clearing it in the process. It is not permissible to use @dict in any way after this call except for reference counting operations (in the case of a heap-allocated #GVariantDict) or by reinitialising it with g_variant_dict_init() (in the case of stack-allocated). - + - a new, floating, #GVariant + a new, floating, #GVariant - a #GVariantDict + a #GVariantDict - - Initialises a #GVariantDict structure. + + Initialises a #GVariantDict structure. If @from_asv is given, it is used to initialise the dictionary. @@ -49689,109 +35836,74 @@ pass a reference to a #GVariantDict outside of the control of your own code then you should assume that the person receiving that reference may try to use reference counting; you should use g_variant_dict_new() instead of this function. - + - a #GVariantDict + a #GVariantDict - - the initial value for @dict + + the initial value for @dict - - Inserts a value into a #GVariantDict. + + Inserts a value into a #GVariantDict. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_dict_insert_value(). - + - a #GVariantDict + a #GVariantDict - the key to insert a value for + the key to insert a value for - a #GVariant varargs format string + a #GVariant varargs format string - arguments, as per @format_string + arguments, as per @format_string - - Inserts (or replaces) a key in a #GVariantDict. + + Inserts (or replaces) a key in a #GVariantDict. @value is consumed if it is floating. - + - a #GVariantDict + a #GVariantDict - the key to insert a value for + the key to insert a value for - the value to insert + the value to insert - - Looks up a value in a #GVariantDict. + + Looks up a value in a #GVariantDict. This function is a wrapper around g_variant_dict_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, @@ -49801,46 +35913,32 @@ value and returns %TRUE. @format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed, see the section on [GVariant format strings][gvariant-format-strings-pointers]. - + - %TRUE if a value was unpacked + %TRUE if a value was unpacked - a #GVariantDict + a #GVariantDict - the key to look up in the dictionary + the key to look up in the dictionary - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - - Looks up a value in a #GVariantDict. + + Looks up a value in a #GVariantDict. If @key is not found in @dictionary, %NULL is returned. @@ -49851,116 +35949,83 @@ returned. If the key is found and the value has the correct type, it is returned. If @expected_type was specified then any non-%NULL return value will have this type. - + - the value of the dictionary key, or %NULL + the value of the dictionary key, or %NULL - a #GVariantDict + a #GVariantDict - the key to look up in the dictionary + the key to look up in the dictionary - - a #GVariantType, or %NULL + + a #GVariantType, or %NULL - Increases the reference count on @dict. + Increases the reference count on @dict. Don't call this on stack-allocated #GVariantDict instances or bad things will happen. - + - a new reference to @dict + a new reference to @dict - a heap-allocated #GVariantDict + a heap-allocated #GVariantDict - - Removes a key and its associated value from a #GVariantDict. - + + Removes a key and its associated value from a #GVariantDict. + - %TRUE if the key was found and removed + %TRUE if the key was found and removed - a #GVariantDict + a #GVariantDict - the key to remove + the key to remove - Decreases the reference count on @dict. + Decreases the reference count on @dict. In the event that there are no more references, releases all memory associated with the #GVariantDict. Don't call this on stack-allocated #GVariantDict instances or bad things will happen. - + - a heap-allocated #GVariantDict + a heap-allocated #GVariantDict - #GVariantIter is an opaque data structure and can only be accessed + #GVariantIter is an opaque data structure and can only be accessed using the following functions. @@ -49968,13 +36033,8 @@ using the following functions. - - Creates a new heap-allocated #GVariantIter to iterate over the + + Creates a new heap-allocated #GVariantIter to iterate over the container that was being iterated over by @iter. Iteration begins on the new iterator from the current position of the old iterator but the two copies are independent past that point. @@ -49986,24 +36046,18 @@ A reference is taken to the container that @iter is iterating over and will be related only when g_variant_iter_free() is called. - a new heap-allocated #GVariantIter + a new heap-allocated #GVariantIter - a #GVariantIter + a #GVariantIter - Frees a heap-allocated #GVariantIter. Only call this function on + Frees a heap-allocated #GVariantIter. Only call this function on iterators that were returned by g_variant_iter_new() or g_variant_iter_copy(). @@ -50012,20 +36066,13 @@ g_variant_iter_copy(). - a heap-allocated #GVariantIter + a heap-allocated #GVariantIter - - Initialises (without allocating) a #GVariantIter. @iter may be + + Initialises (without allocating) a #GVariantIter. @iter may be completely uninitialised prior to this call; its old value is ignored. @@ -50033,33 +36080,22 @@ The iterator remains valid for as long as @value exists, and need not be freed in any way. - the number of items in @value + the number of items in @value - a pointer to a #GVariantIter + a pointer to a #GVariantIter - a container #GVariant + a container #GVariant - - Gets the next item in the container and unpacks it into the variable + + Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE. If no more items remain then %FALSE is returned. @@ -50123,66 +36159,45 @@ See the section on [GVariant format strings][gvariant-format-strings-pointers]. - %TRUE if a value was unpacked, or %FALSE if there was no + %TRUE if a value was unpacked, or %FALSE if there was no value - a #GVariantIter + a #GVariantIter - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - - Queries the number of child items in the container that we are + + Queries the number of child items in the container that we are iterating over. This is the total number of items -- not the number of items remaining. This function might be useful for preallocation of arrays. - the number of children in the container + the number of children in the container - a #GVariantIter + a #GVariantIter - - Gets the next item in the container and unpacks it into the variable + + Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE. If no more items remain then %FALSE is returned. @@ -50225,38 +36240,26 @@ See the section on [GVariant format strings][gvariant-format-strings-pointers]. - %TRUE if a value was unpacked, or %FALSE if there as no value + %TRUE if a value was unpacked, or %FALSE if there as no value - a #GVariantIter + a #GVariantIter - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - - Gets the next item in the container. If no more items remain then + + Gets the next item in the container. If no more items remain then %NULL is returned. Use g_variant_unref() to drop your reference on the return value when @@ -50285,170 +36288,80 @@ Here is an example for iterating with g_variant_iter_next_value(): ]| - a #GVariant, or %NULL + a #GVariant, or %NULL - a #GVariantIter + a #GVariantIter - - Error codes returned by parsing text-format GVariants. + + Error codes returned by parsing text-format GVariants. - - generic error (unused) + + generic error (unused) - - a non-basic #GVariantType was given where a basic type was expected + + a non-basic #GVariantType was given where a basic type was expected - - cannot infer the #GVariantType + + cannot infer the #GVariantType - - an indefinite #GVariantType was given where a definite type was expected + + an indefinite #GVariantType was given where a definite type was expected - - extra data after parsing finished + + extra data after parsing finished - - invalid character in number or unicode escape + + invalid character in number or unicode escape - - not a valid #GVariant format string + + not a valid #GVariant format string - - not a valid object path + + not a valid object path - - not a valid type signature + + not a valid type signature - - not a valid #GVariant type string + + not a valid #GVariant type string - - could not find a common type for array entries + + could not find a common type for array entries - - the numerical value is out of range of the given type + + the numerical value is out of range of the given type - - the numerical value is out of range for any type + + the numerical value is out of range for any type - - cannot parse as variant of the specified type + + cannot parse as variant of the specified type - - an unexpected token was encountered + + an unexpected token was encountered - - an unknown keyword was encountered + + an unknown keyword was encountered - - unterminated string constant + + unterminated string constant - - no value given + + no value given - - variant was too deeply nested; #GVariant is only guaranteed to handle nesting up to 64 levels (Since: 2.64) + + variant was too deeply nested; #GVariant is only guaranteed to handle nesting up to 64 levels (Since: 2.64) - - This section introduces the GVariant type system. It is based, in + + This section introduces the GVariant type system. It is based, in large part, on the D-Bus type system, with two major changes and some minor lifting of restrictions. The [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html), @@ -50475,7 +36388,7 @@ may only appear nested inside of arrays. Just as in D-Bus, GVariant types are described with strings ("type strings"). Subject to the differences mentioned above, these strings -are of the same form as those found in DBus. Note, however: D-Bus +are of the same form as those found in D-Bus. Note, however: D-Bus always works in terms of messages and therefore individual type strings appear nowhere in its interface. Instead, "signatures" are a concatenation of the strings of the type of each argument in a @@ -50597,9 +36510,7 @@ that, due to the restriction that the key of a dictionary entry must be a basic type, "{**}" is not a valid type string. - Creates a new #GVariantType corresponding to the type string given + Creates a new #GVariantType corresponding to the type string given by @type_string. It is appropriate to call g_variant_type_free() on the return value. @@ -50607,106 +36518,79 @@ It is a programmer error to call this function with an invalid type string. Use g_variant_type_string_is_valid() if you are unsure. - a new #GVariantType + a new #GVariantType - a valid GVariant type string + a valid GVariant type string - Constructs the type corresponding to an array of elements of the + Constructs the type corresponding to an array of elements of the type @type. It is appropriate to call g_variant_type_free() on the return value. - a new array #GVariantType + a new array #GVariantType Since 2.24 - a #GVariantType + a #GVariantType - - Constructs the type corresponding to a dictionary entry with a key + + Constructs the type corresponding to a dictionary entry with a key of type @key and a value of type @value. It is appropriate to call g_variant_type_free() on the return value. - a new dictionary entry #GVariantType + a new dictionary entry #GVariantType Since 2.24 - a basic #GVariantType + a basic #GVariantType - a #GVariantType + a #GVariantType - Constructs the type corresponding to a maybe instance containing + Constructs the type corresponding to a maybe instance containing type @type or Nothing. It is appropriate to call g_variant_type_free() on the return value. - a new maybe #GVariantType + a new maybe #GVariantType Since 2.24 - a #GVariantType + a #GVariantType - Constructs a new tuple type, from @items. + Constructs a new tuple type, from @items. @length is the number of items in @items, or -1 to indicate that @items is %NULL-terminated. @@ -50714,107 +36598,79 @@ Since 2.24 It is appropriate to call g_variant_type_free() on the return value. - a new tuple #GVariantType + a new tuple #GVariantType Since 2.24 - an array of #GVariantTypes, one for each item - + an array of #GVariantTypes, one for each item + - the length of @items, or -1 + the length of @items, or -1 - Makes a copy of a #GVariantType. It is appropriate to call + Makes a copy of a #GVariantType. It is appropriate to call g_variant_type_free() on the return value. @type may not be %NULL. - a new #GVariantType + a new #GVariantType Since 2.24 - a #GVariantType + a #GVariantType - Returns a newly-allocated copy of the type string corresponding to + Returns a newly-allocated copy of the type string corresponding to @type. The returned string is nul-terminated. It is appropriate to call g_free() on the return value. - the corresponding type string + the corresponding type string Since 2.24 - a #GVariantType + a #GVariantType - Determines the element type of an array or maybe type. + Determines the element type of an array or maybe type. This function may only be used with array or maybe types. - the element type of @type + the element type of @type Since 2.24 - an array or maybe #GVariantType + an array or maybe #GVariantType - Compares @type1 and @type2 for equality. + Compares @type1 and @type2 for equality. Only returns %TRUE if the types are exactly equal. Even if one type is an indefinite type and the other is a subtype of it, %FALSE will @@ -50826,32 +36682,24 @@ allow use with #GHashTable without function pointer casting. For both arguments, a valid #GVariantType must be provided. - %TRUE if @type1 and @type2 are exactly equal + %TRUE if @type1 and @type2 are exactly equal Since 2.24 - a #GVariantType + a #GVariantType - a #GVariantType + a #GVariantType - Determines the first item type of a tuple or dictionary entry + Determines the first item type of a tuple or dictionary entry type. This function may only be used with tuple or dictionary entry types, @@ -50867,26 +36715,20 @@ This call, together with g_variant_type_next() provides an iterator interface over tuple and dictionary entry types. - the first item type of @type, or %NULL + the first item type of @type, or %NULL Since 2.24 - a tuple or dictionary entry #GVariantType + a tuple or dictionary entry #GVariantType - Frees a #GVariantType that was allocated with + Frees a #GVariantType that was allocated with g_variant_type_copy(), g_variant_type_new() or one of the container type constructor functions. @@ -50898,72 +36740,52 @@ Since 2.24 - - a #GVariantType, or %NULL + + a #GVariantType, or %NULL - - Returns the length of the type string corresponding to the given + + Returns the length of the type string corresponding to the given @type. This function must be used to determine the valid extent of the memory region returned by g_variant_type_peek_string(). - the length of the corresponding type string + the length of the corresponding type string Since 2.24 - a #GVariantType + a #GVariantType - Hashes @type. + Hashes @type. The argument type of @type is only #gconstpointer to allow use with #GHashTable without function pointer casting. A valid #GVariantType must be provided. - the hash value + the hash value Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is an array type. This is true if the + Determines if the given @type is an array type. This is true if the type string for @type starts with an 'a'. This function returns %TRUE for any indefinite type for which every @@ -50971,26 +36793,20 @@ definite subtype is an array type -- %G_VARIANT_TYPE_ARRAY, for example. - %TRUE if @type is an array type + %TRUE if @type is an array type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is a basic type. + Determines if the given @type is a basic type. Basic types are booleans, bytes, integers, doubles, strings, object paths and signatures. @@ -51001,26 +36817,20 @@ This function returns %FALSE for all indefinite types except %G_VARIANT_TYPE_BASIC. - %TRUE if @type is a basic type + %TRUE if @type is a basic type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is a container type. + Determines if the given @type is a container type. Container types are any array, maybe, tuple, or dictionary entry types plus the variant type. @@ -51030,26 +36840,20 @@ definite subtype is a container -- %G_VARIANT_TYPE_ARRAY, for example. - %TRUE if @type is a container type + %TRUE if @type is a container type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is definite (ie: not indefinite). + Determines if the given @type is definite (ie: not indefinite). A type is definite if its type string does not contain any indefinite type characters ('*', '?', or 'r'). @@ -51061,26 +36865,20 @@ indefinite type like %G_VARIANT_TYPE_ARRAY, however, will result in %FALSE being returned. - %TRUE if @type is definite + %TRUE if @type is definite Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is a dictionary entry type. This is + Determines if the given @type is a dictionary entry type. This is true if the type string for @type starts with a '{'. This function returns %TRUE for any indefinite type for which every @@ -51088,26 +36886,20 @@ definite subtype is a dictionary entry type -- %G_VARIANT_TYPE_DICT_ENTRY, for example. - %TRUE if @type is a dictionary entry type + %TRUE if @type is a dictionary entry type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is a maybe type. This is true if the + Determines if the given @type is a maybe type. This is true if the type string for @type starts with an 'm'. This function returns %TRUE for any indefinite type for which every @@ -51115,58 +36907,44 @@ definite subtype is a maybe type -- %G_VARIANT_TYPE_MAYBE, for example. - %TRUE if @type is a maybe type + %TRUE if @type is a maybe type Since 2.24 - a #GVariantType + a #GVariantType - Checks if @type is a subtype of @supertype. + Checks if @type is a subtype of @supertype. This function returns %TRUE if @type is a subtype of @supertype. All types are considered to be subtypes of themselves. Aside from that, only indefinite types can have subtypes. - %TRUE if @type is a subtype of @supertype + %TRUE if @type is a subtype of @supertype Since 2.24 - a #GVariantType + a #GVariantType - a #GVariantType + a #GVariantType - Determines if the given @type is a tuple type. This is true if the + Determines if the given @type is a tuple type. This is true if the type string for @type starts with a '(' or if @type is %G_VARIANT_TYPE_TUPLE. @@ -51175,74 +36953,56 @@ definite subtype is a tuple type -- %G_VARIANT_TYPE_TUPLE, for example. - %TRUE if @type is a tuple type + %TRUE if @type is a tuple type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is the variant type. + Determines if the given @type is the variant type. - %TRUE if @type is the variant type + %TRUE if @type is the variant type Since 2.24 - a #GVariantType + a #GVariantType - Determines the key type of a dictionary entry type. + Determines the key type of a dictionary entry type. This function may only be used with a dictionary entry type. Other than the additional restriction, this call is equivalent to g_variant_type_first(). - the key type of the dictionary entry + the key type of the dictionary entry Since 2.24 - a dictionary entry #GVariantType + a dictionary entry #GVariantType - Determines the number of items contained in a tuple or + Determines the number of items contained in a tuple or dictionary entry type. This function may only be used with tuple or dictionary entry types, @@ -51253,26 +37013,20 @@ In the case of a dictionary entry type, this function will always return 2. - the number of items in @type + the number of items in @type Since 2.24 - a tuple or dictionary entry #GVariantType + a tuple or dictionary entry #GVariantType - Determines the next item type of a tuple or dictionary entry + Determines the next item type of a tuple or dictionary entry type. @type must be the result of a previous call to @@ -51285,70 +37039,52 @@ entry then this call returns %NULL. For tuples, %NULL is returned when @type is the last item in a tuple. - the next #GVariantType after @type, or %NULL + the next #GVariantType after @type, or %NULL Since 2.24 - a #GVariantType from a previous call + a #GVariantType from a previous call - - Returns the type string corresponding to the given @type. The + + Returns the type string corresponding to the given @type. The result is not nul-terminated; in order to determine its length you must call g_variant_type_get_string_length(). To get a nul-terminated string, see g_variant_type_dup_string(). - the corresponding type string (not nul-terminated) + the corresponding type string (not nul-terminated) Since 2.24 - a #GVariantType + a #GVariantType - Determines the value type of a dictionary entry type. + Determines the value type of a dictionary entry type. This function may only be used with a dictionary entry type. - the value type of the dictionary entry + the value type of the dictionary entry Since 2.24 - a dictionary entry #GVariantType + a dictionary entry #GVariantType @@ -51364,8 +37100,7 @@ Since 2.24 - + @@ -51376,37 +37111,26 @@ Since 2.24 - - Checks if @type_string is a valid GVariant type string. This call is + + Checks if @type_string is a valid GVariant type string. This call is equivalent to calling g_variant_type_string_scan() and confirming that the following character is a nul terminator. - %TRUE if @type_string is exactly one valid type string + %TRUE if @type_string is exactly one valid type string Since 2.24 - a pointer to any string + a pointer to any string - - Scan for a single complete and valid GVariant type string in @string. + + Scan for a single complete and valid GVariant type string in @string. The memory pointed to by @limit (or bytes beyond it) is never accessed. @@ -51421,45 +37145,27 @@ For the simple case of checking if a string is a valid type string, see g_variant_type_string_is_valid(). - %TRUE if a valid type string was found + %TRUE if a valid type string was found - a pointer to any string + a pointer to any string - - the end of @string, or %NULL + + the end of @string, or %NULL - - location to store the end pointer, or %NULL + + location to store the end pointer, or %NULL - Declares a type of function which takes no arguments + Declares a type of function which takes no arguments and has no return value. It is used to specify the type function passed to g_atexit(). @@ -51467,42 +37173,30 @@ function passed to g_atexit(). - - On Windows, this macro defines a DllMain() function that stores + + On Windows, this macro defines a DllMain() function that stores the actual DLL name that the code being compiled will be included in. On non-Windows platforms, expands to nothing. - empty or "static" + empty or "static" - the name of the (pointer to the) char array where + the name of the (pointer to the) char array where the DLL name will be stored. If this is used, you must also include `windows.h`. If you need a more complex DLL entry point function, you cannot use this - + - A wrapper for the POSIX access() function. This function is used to + A wrapper for the POSIX access() function. This function is used to test a pathname for one or several of read, write or execute permissions, or just existence. @@ -51516,33 +37210,25 @@ more exactly should use the Win32 API. See your C library manual for more details about access(). - zero if the pathname refers to an existing file system + zero if the pathname refers to an existing file system object that has all the tested permissions, or -1 otherwise or on error. - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - as in access() + as in access() - Allocates @size bytes on the stack; these bytes will be freed when the current + Allocates @size bytes on the stack; these bytes will be freed when the current stack frame is cleaned up. This macro essentially just wraps the alloca() function present on most UNIX variants. Thus it provides the same advantages and pitfalls as alloca(): @@ -51562,23 +37248,24 @@ Thus it provides the same advantages and pitfalls as alloca(): way as out of stack space situations from infinite function recursion, i.e. with a segmentation fault. +- Allowing @size to be specified by an untrusted party would allow for them + to trigger a segmentation fault by specifying a large size, leading to a + denial of service vulnerability. @size must always be entirely under the + control of the program. + - Special care has to be taken when mixing alloca() with GNU C variable sized arrays. Stack space allocated with alloca() in the same scope as a variable sized array will be freed together with the variable sized array upon exit of that scope, and not upon exit of the enclosing function scope. - + - number of bytes to allocate. + number of bytes to allocate. - An "atomically reference counted box", or "ArcBox", is an opaque wrapper + An "atomically reference counted box", or "ArcBox", is an opaque wrapper data type that is guaranteed to be as big as the size of a given data type, and which augments the given data type with thread safe reference counting semantics for its memory management. @@ -51695,12 +37382,8 @@ my_data_struct_release (MyDataStruct *data) G_DEFINE_AUTOPTR_CLEANUP_FUNC (MyDataStruct, my_data_struct_release) ]| - - Adds the value on to the end of the array. The array will grow in + + Adds the value on to the end of the array. The array will grow in size automatically if necessary. g_array_append_val() is a macro which uses a reference to the value @@ -51709,23 +37392,15 @@ such as "27". You must use variables. - a #GArray + a #GArray - the value to append to the #GArray + the value to append to the #GArray - - Returns the element of a #GArray at the given index. The return + + Returns the element of a #GArray at the given index. The return value is cast to the given type. This is the main way to read or write an element in a #GArray. @@ -51753,28 +37428,18 @@ This example reads from and writes to an array of integers: - a #GArray + a #GArray - the type of the elements + the type of the elements - the index of the element to return + the index of the element to return - - Inserts an element into an array at the given index. + + Inserts an element into an array at the given index. g_array_insert_val() is a macro which uses a reference to the value parameter @v. This means that you cannot use it with literal values @@ -51782,28 +37447,18 @@ such as "27". You must use variables. - a #GArray + a #GArray - the index to place the element at + the index to place the element at - the value to insert into the array + the value to insert into the array - - Adds the value on to the start of the array. The array will grow in + + Adds the value on to the start of the array. The array will grow in size automatically if necessary. This operation is slower than g_array_append_val() since the @@ -51816,21 +37471,15 @@ such as "27". You must use variables. - a #GArray + a #GArray - the value to prepend to the #GArray + the value to prepend to the #GArray - Arrays are similar to standard C arrays, except that they grow + Arrays are similar to standard C arrays, except that they grow automatically as elements are added. Array elements can be of any size (though all elements of one array @@ -51871,9 +37520,7 @@ Here is an example that stores integers in a #GArray: ]| - #GByteArray is a mutable array of bytes based on #GArray, to provide arrays + #GByteArray is a mutable array of bytes based on #GArray, to provide arrays of bytes which grow automatically as elements are added. To create a new #GByteArray use g_byte_array_new(). To add elements to a @@ -51907,9 +37554,7 @@ See #GBytes if you are interested in an immutable object representing a sequence of bytes. - Pointer Arrays are similar to Arrays but are used only for storing + Pointer Arrays are similar to Arrays but are used only for storing pointers. If you remove elements from the array, elements at the end of the @@ -51951,32 +37596,24 @@ An example using a #GPtrArray: ]| - Determines the numeric value of a character as a decimal digit. + Determines the numeric value of a character as a decimal digit. Differs from g_unichar_digit_value() because it takes a char, so there's no worry about sign extension if characters are signed. - If @c is a decimal digit (according to g_ascii_isdigit()), + If @c is a decimal digit (according to g_ascii_isdigit()), its numeric value. Otherwise, -1. - an ASCII character + an ASCII character - Converts a #gdouble to a string, using the '.' as + Converts a #gdouble to a string, using the '.' as decimal point. This function generates enough precision that converting @@ -51987,36 +37624,26 @@ be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes, including the terminating nul character, which is always added. - The pointer to the buffer with the converted string. + The pointer to the buffer with the converted string. - A buffer to place the resulting string in + A buffer to place the resulting string in - The length of the buffer. + The length of the buffer. - The #gdouble to convert + The #gdouble to convert - Converts a #gdouble to a string, using the '.' as + Converts a #gdouble to a string, using the '.' as 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'. @@ -52027,45 +37654,31 @@ If you just want to want to serialize the value into a string, use g_ascii_dtostr(). - The pointer to the buffer with the converted string. + The pointer to the buffer with the converted string. - A buffer to place the resulting string in + A buffer to place the resulting string in - The length of the buffer. + The length of the buffer. - The printf()-style format to use for the + The printf()-style format to use for the code to use for converting. - The #gdouble to convert + The #gdouble to convert - - Determines whether a character is alphanumeric. + + Determines whether a character is alphanumeric. Unlike the standard C library isalnum() function, this only recognizes standard ASCII letters and ignores the locale, @@ -52076,18 +37689,12 @@ passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is alphabetic (i.e. a letter). + + Determines whether a character is alphabetic (i.e. a letter). Unlike the standard C library isalpha() function, this only recognizes standard ASCII letters and ignores the locale, @@ -52098,18 +37705,12 @@ passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is a control character. + + Determines whether a character is a control character. Unlike the standard C library iscntrl() function, this only recognizes standard ASCII control characters and ignores the @@ -52120,18 +37721,12 @@ before passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is digit (0-9). + + Determines whether a character is digit (0-9). Unlike the standard C library isdigit() function, this takes a char, not an int, so don't call it on %EOF, but no need to @@ -52139,18 +37734,12 @@ cast to #guchar before passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is a printing character and not a space. + + Determines whether a character is a printing character and not a space. Unlike the standard C library isgraph() function, this only recognizes standard ASCII characters and ignores the locale, @@ -52161,18 +37750,12 @@ passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is an ASCII lower case letter. + + Determines whether a character is an ASCII lower case letter. Unlike the standard C library islower() function, this only recognizes standard ASCII letters and ignores the locale, @@ -52183,18 +37766,12 @@ to #guchar before passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is a printing character. + + Determines whether a character is a printing character. Unlike the standard C library isprint() function, this only recognizes standard ASCII characters and ignores the locale, @@ -52205,18 +37782,12 @@ passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is a punctuation character. + + Determines whether a character is a punctuation character. Unlike the standard C library ispunct() function, this only recognizes standard ASCII letters and ignores the locale, @@ -52227,18 +37798,12 @@ passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is a white-space character. + + Determines whether a character is a white-space character. Unlike the standard C library isspace() function, this only recognizes standard ASCII white-space and ignores the locale, @@ -52249,18 +37814,12 @@ passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is an ASCII upper case letter. + + Determines whether a character is an ASCII upper case letter. Unlike the standard C library isupper() function, this only recognizes standard ASCII letters and ignores the locale, @@ -52271,18 +37830,12 @@ to #guchar before passing a possibly non-ASCII character in. - any character + any character - - Determines whether a character is a hexadecimal-digit character. + + Determines whether a character is a hexadecimal-digit character. Unlike the standard C library isxdigit() function, this takes a char, not an int, so don't call it on %EOF, but no need to @@ -52290,16 +37843,12 @@ cast to #guchar before passing a possibly non-ASCII character in. - any character + any character - Compare two strings, ignoring the case of ASCII characters. + Compare two strings, ignoring the case of ASCII characters. Unlike the BSD strcasecmp() function, this only recognizes standard ASCII letters and ignores the locale, treating all non-ASCII @@ -52316,36 +37865,26 @@ strings using this function, you will get false matches. Both @s1 and @s2 must be non-%NULL. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - string to compare with @s2 + string to compare with @s2 - string to compare with @s1 + string to compare with @s1 - Converts all upper case ASCII letters to lower case ASCII letters. + Converts all upper case ASCII letters to lower case ASCII letters. - a newly-allocated string, with all the upper case + a newly-allocated string, with all the upper case characters in @str converted to lower case, with semantics that exactly match g_ascii_tolower(). (Note that this is unlike the old g_strdown(), which modified the string in place.) @@ -52353,26 +37892,17 @@ Both @s1 and @s2 must be non-%NULL. - a string + a string - length of @str in bytes, or -1 if @str is nul-terminated + length of @str in bytes, or -1 if @str is nul-terminated - - A convenience function for converting a string to a signed number. + + A convenience function for converting a string to a signed number. This function assumes that @str contains only a number of the given @base that is within inclusive bounds limited by @min and @max. If @@ -52393,58 +37923,36 @@ bounds - %G_NUMBER_PARSER_ERROR_OUT_OF_BOUNDS. See g_ascii_strtoll() if you have more complex needs such as parsing a string which starts with a number, but then has other characters. - + - %TRUE if @str was a number, otherwise %FALSE. + %TRUE if @str was a number, otherwise %FALSE. - a string + a string - base of a parsed number + base of a parsed number - a lower bound (inclusive) + a lower bound (inclusive) - an upper bound (inclusive) + an upper bound (inclusive) - - a return location for a number + + a return location for a number - - A convenience function for converting a string to an unsigned number. + + A convenience function for converting a string to an unsigned number. This function assumes that @str contains only a number of the given @base that is within inclusive bounds limited by @min and @max. If @@ -52466,55 +37974,36 @@ bounds - %G_NUMBER_PARSER_ERROR_OUT_OF_BOUNDS. See g_ascii_strtoull() if you have more complex needs such as parsing a string which starts with a number, but then has other characters. - + - %TRUE if @str was a number, otherwise %FALSE. + %TRUE if @str was a number, otherwise %FALSE. - a string + a string - base of a parsed number + base of a parsed number - a lower bound (inclusive) + a lower bound (inclusive) - an upper bound (inclusive) + an upper bound (inclusive) - - a return location for a number + + a return location for a number - Compare @s1 and @s2, ignoring the case of ASCII characters and any + Compare @s1 and @s2, ignoring the case of ASCII characters and any characters after the first @n in each string. Unlike the BSD strcasecmp() function, this only recognizes standard @@ -52526,37 +38015,27 @@ function only on strings known to be in encodings where bytes corresponding to ASCII letters always represent themselves. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - string to compare with @s2 + string to compare with @s2 - string to compare with @s1 + string to compare with @s1 - number of characters to compare + number of characters to compare - Converts a string to a #gdouble value. + Converts a string to a #gdouble value. This function behaves like the standard strtod() function does in the C locale. It does this without actually changing @@ -52581,38 +38060,23 @@ This function resets %errno before calling strtod() so that you can reliably detect overflow and underflow. - the #gdouble value. + the #gdouble value. - the string to convert to a numeric value. + the string to convert to a numeric value. - - if non-%NULL, it returns the + + if non-%NULL, it returns the character after the last character used in the conversion. - - Converts a string to a #gint64 value. + + Converts a string to a #gint64 value. This function behaves like the standard strtoll() function does in the C locale. It does this without actually changing the current locale, since that would not be @@ -52631,44 +38095,27 @@ string conversion fails, zero is returned, and @endptr returns @nptr (if @endptr is non-%NULL). - the #gint64 value or zero on error. + the #gint64 value or zero on error. - the string to convert to a numeric value. + the string to convert to a numeric value. - - if non-%NULL, it returns the + + if non-%NULL, it returns the character after the last character used in the conversion. - to be used for the conversion, 2..36 or 0 + to be used for the conversion, 2..36 or 0 - - Converts a string to a #guint64 value. + + Converts a string to a #guint64 value. This function behaves like the standard strtoull() function does in the C locale. It does this without actually changing the current locale, since that would not be @@ -52692,47 +38139,30 @@ If the string conversion fails, zero is returned, and @endptr returns @nptr (if @endptr is non-%NULL). - the #guint64 value or zero on error. + the #guint64 value or zero on error. - the string to convert to a numeric value. + the string to convert to a numeric value. - - if non-%NULL, it returns the + + if non-%NULL, it returns the character after the last character used in the conversion. - to be used for the conversion, 2..36 or 0 + to be used for the conversion, 2..36 or 0 - Converts all lower case ASCII letters to upper case ASCII letters. + Converts all lower case ASCII letters to upper case ASCII letters. - a newly allocated string, with all the lower case + a newly allocated string, with all the lower case characters in @str converted to upper case, with semantics that exactly match g_ascii_toupper(). (Note that this is unlike the old g_strup(), which modified the string in place.) @@ -52740,23 +38170,17 @@ If the string conversion fails, zero is returned, and @endptr returns - a string + a string - length of @str in bytes, or -1 if @str is nul-terminated + length of @str in bytes, or -1 if @str is nul-terminated - Convert a character to ASCII lower case. + Convert a character to ASCII lower case. Unlike the standard C library tolower() function, this only recognizes standard ASCII letters and ignores the locale, returning @@ -52767,25 +38191,19 @@ don't call it on %EOF but no need to worry about casting to #guchar before passing a possibly non-ASCII character in. - the result of converting @c to lower case. If @c is + the result of converting @c to lower case. If @c is not an ASCII upper case letter, @c is returned unchanged. - any character + any character - Convert a character to ASCII upper case. + Convert a character to ASCII upper case. Unlike the standard C library toupper() function, this only recognizes standard ASCII letters and ignores the locale, returning @@ -52796,49 +38214,37 @@ don't call it on %EOF but no need to worry about casting to #guchar before passing a possibly non-ASCII character in. - the result of converting @c to upper case. If @c is not + the result of converting @c to upper case. If @c is not an ASCII lower case letter, @c is returned unchanged. - any character + any character - Determines the numeric value of a character as a hexadecimal + Determines the numeric value of a character as a hexadecimal digit. Differs from g_unichar_xdigit_value() because it takes a char, so there's no worry about sign extension if characters are signed. - If @c is a hex digit (according to g_ascii_isxdigit()), + If @c is a hex digit (according to g_ascii_isxdigit()), its numeric value. Otherwise, -1. - an ASCII character. + an ASCII character. - Debugging macro to terminate the application if the assertion + Debugging macro to terminate the application if the assertion fails. If the assertion fails (i.e. the expression is not true), an error message is logged and the application is terminated. @@ -52848,22 +38254,15 @@ not depend on any side effects from @expr. Similarly, it must not be used in unit tests, otherwise the unit tests will be ineffective if compiled with `G_DISABLE_ASSERT`. Use g_assert_true() and related macros in unit tests instead. - + - the expression to check + the expression to check - - Debugging macro to compare two floating point numbers. + + Debugging macro to compare two floating point numbers. The effect of `g_assert_cmpfloat (n1, op, n2)` is the same as `g_assert_true (n1 op n2)`. The advantage @@ -52872,30 +38271,19 @@ actual values of @n1 and @n2. - a floating point number + a floating point number - The comparison operator to use. + The comparison operator to use. One of `==`, `!=`, `<`, `>`, `<=`, `>=`. - another floating point number + another floating point number - - Debugging macro to compare two floating point numbers within an epsilon. + + Debugging macro to compare two floating point numbers within an epsilon. The effect of `g_assert_cmpfloat_with_epsilon (n1, n2, epsilon)` is the same as `g_assert_true (abs (n1 - n2) < epsilon)`. The advantage @@ -52904,60 +38292,38 @@ actual values of @n1 and @n2. - a floating point number + a floating point number - another floating point number + another floating point number - a numeric value that expresses the expected tolerance + a numeric value that expresses the expected tolerance between @n1 and @n2 - - Debugging macro to compare to unsigned integers. + + Debugging macro to compare to unsigned integers. This is a variant of g_assert_cmpuint() that displays the numbers in hexadecimal notation in the message. - an unsigned integer + an unsigned integer - The comparison operator to use. + The comparison operator to use. One of `==`, `!=`, `<`, `>`, `<=`, `>=`. - another unsigned integer + another unsigned integer - - Debugging macro to compare two integers. + + Debugging macro to compare two integers. The effect of `g_assert_cmpint (n1, op, n2)` is the same as `g_assert_true (n1 op n2)`. The advantage @@ -52966,30 +38332,19 @@ actual values of @n1 and @n2. - an integer + an integer - The comparison operator to use. + The comparison operator to use. One of `==`, `!=`, `<`, `>`, `<=`, `>=`. - another integer + another integer - - Debugging macro to compare memory regions. If the comparison fails, + + Debugging macro to compare memory regions. If the comparison fails, an error message is logged and the application is either terminated or the testcase marked as failed. @@ -53006,34 +38361,21 @@ includes the actual values of @l1 and @l2. - pointer to a buffer + pointer to a buffer - length of @m1 + length of @m1 - pointer to another buffer + pointer to another buffer - length of @m2 + length of @m2 - - Debugging macro to compare two strings. If the comparison fails, + + Debugging macro to compare two strings. If the comparison fails, an error message is logged and the application is either terminated or the testcase marked as failed. The strings are compared using g_strcmp0(). @@ -53049,30 +38391,45 @@ includes the actual values of @s1 and @s2. - a string (may be %NULL) + a string (may be %NULL) - The comparison operator to use. + The comparison operator to use. One of `==`, `!=`, `<`, `>`, `<=`, `>=`. - another string (may be %NULL) + another string (may be %NULL) - - Debugging macro to compare two unsigned integers. + + Debugging macro to check if two %NULL-terminated string arrays (i.e. 2 +#GStrv) are equal. If they are not equal, an error message is logged and the +application is either terminated or the testcase marked as failed. +If both arrays are %NULL, the check passes. If one array is %NULL but the +other is not, an error message is logged. + +The effect of `g_assert_cmpstrv (strv1, strv2)` is the same as +`g_assert_true (g_strv_equal (strv1, strv2))` (if both arrays are not +%NULL). The advantage of this macro is that it can produce a message that +includes how @strv1 and @strv2 are different. + +|[<!-- language="C" --> + const char *expected[] = { "one", "two", "three", NULL }; + g_assert_cmpstrv (mystrv, expected); +]| + + + + a string array (may be %NULL) + + + another string array (may be %NULL) + + + + + Debugging macro to compare two unsigned integers. The effect of `g_assert_cmpuint (n1, op, n2)` is the same as `g_assert_true (n1 op n2)`. The advantage @@ -53081,30 +38438,19 @@ actual values of @n1 and @n2. - an unsigned integer + an unsigned integer - The comparison operator to use. + The comparison operator to use. One of `==`, `!=`, `<`, `>`, `<=`, `>=`. - another unsigned integer + another unsigned integer - - Debugging macro to compare two #GVariants. If the comparison fails, + + Debugging macro to compare two #GVariants. If the comparison fails, an error message is logged and the application is either terminated or the testcase marked as failed. The variants are compared using g_variant_equal(). @@ -53115,24 +38461,15 @@ that it can produce a message that includes the actual values of @v1 and @v2. - pointer to a #GVariant + pointer to a #GVariant - pointer to another #GVariant + pointer to another #GVariant - - Debugging macro to check that a method has returned + + Debugging macro to check that a method has returned the correct #GError. The effect of `g_assert_error (err, dom, c)` is @@ -53144,32 +38481,21 @@ error message and code. This can only be used to test for a specific error. If you want to test that @err is set, but don't care what it's set to, just use `g_assert_nonnull (err)`. - + - a #GError, possibly %NULL + a #GError, possibly %NULL - the expected error domain (a #GQuark) + the expected error domain (a #GQuark) - the expected error code + the expected error code - - Debugging macro to check an expression is false. + + Debugging macro to check an expression is false. If the assertion fails (i.e. the expression is not false), an error message is logged and the application is either @@ -53180,22 +38506,15 @@ Note that unlike g_assert(), this macro is unaffected by whether conversely, g_assert() should not be used in tests. See g_test_set_nonfatal_assertions(). - + - the expression to check + the expression to check - - Debugging macro to check that an expression has a non-negative return value, + + Debugging macro to check that an expression has a non-negative return value, as used by traditional POSIX functions (such as `rmdir()`) to indicate success. @@ -53205,43 +38524,29 @@ will contain the value of `errno` and its human-readable message from g_strerror(). This macro will clear the value of `errno` before executing @expr. - + - the expression to check + the expression to check - - Debugging macro to check that a #GError is not set. + + Debugging macro to check that a #GError is not set. The effect of `g_assert_no_error (err)` is the same as `g_assert_true (err == NULL)`. The advantage of this macro is that it can produce a message that includes the error message and code. - + - a #GError, possibly %NULL + a #GError, possibly %NULL - - Debugging macro to check an expression is not %NULL. + + Debugging macro to check an expression is not %NULL. If the assertion fails (i.e. the expression is %NULL), an error message is logged and the application is either @@ -53252,22 +38557,15 @@ Note that unlike g_assert(), this macro is unaffected by whether conversely, g_assert() should not be used in tests. See g_test_set_nonfatal_assertions(). - + - the expression to check + the expression to check - - Debugging macro to check an expression is %NULL. + + Debugging macro to check an expression is %NULL. If the assertion fails (i.e. the expression is not %NULL), an error message is logged and the application is either @@ -53278,22 +38576,15 @@ Note that unlike g_assert(), this macro is unaffected by whether conversely, g_assert() should not be used in tests. See g_test_set_nonfatal_assertions(). - + - the expression to check + the expression to check - - Debugging macro to check that an expression is true. + + Debugging macro to check that an expression is true. If the assertion fails (i.e. the expression is not true), an error message is logged and the application is either @@ -53304,17 +38595,15 @@ Note that unlike g_assert(), this macro is unaffected by whether conversely, g_assert() should not be used in tests. See g_test_set_nonfatal_assertions(). - + - the expression to check + the expression to check - + @@ -53337,7 +38626,7 @@ See g_test_set_nonfatal_assertions(). - + @@ -53359,10 +38648,8 @@ See g_test_set_nonfatal_assertions(). - - + + @@ -53396,9 +38683,8 @@ See g_test_set_nonfatal_assertions(). - - + + @@ -53429,9 +38715,40 @@ See g_test_set_nonfatal_assertions(). - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -53462,60 +38779,38 @@ See g_test_set_nonfatal_assertions(). - - Internal function used to print messages from the public g_assert() and + + Internal function used to print messages from the public g_assert() and g_assert_not_reached() macros. - + - - log domain + + log domain - file containing the assertion + file containing the assertion - line number of the assertion + line number of the assertion - function containing the assertion + function containing the assertion - - expression which failed + + expression which failed - Often you need to communicate between different threads. In general + Often you need to communicate between different threads. In general it's safer not to do this by shared memory, but by explicit message passing. These messages only make sense asynchronously for multi-threaded applications though, as a synchronous operation could @@ -53557,13 +38852,8 @@ you need to distribute work to a set of worker threads instead of using #GAsyncQueue manually. #GThreadPool uses a GAsyncQueue internally. - - Specifies a function to be called at normal program termination. + + Specifies a function to be called at normal program termination. Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor macro that maps to a call to the atexit() function in the C @@ -53600,19 +38890,13 @@ program. - the function to call on normal program termination. + the function to call on normal program termination. - - Atomically adds @val to the value of @atomic. + + Atomically adds @val to the value of @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic += val; return tmp; }`. @@ -53620,69 +38904,55 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. Before version 2.30, this function did not return a value -(but g_atomic_int_exchange_and_add() did, and had the same meaning). - +(but g_atomic_int_exchange_and_add() did, and had the same meaning). + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the add, signed + the value of @atomic before the add, signed - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to add + the value to add - - Performs an atomic bitwise 'and' of the value of @atomic and @val, + + Performs an atomic bitwise 'and' of the value of @atomic and @val, storing the result back in @atomic. This call acts as a full compiler and hardware memory barrier. Think of this operation as an atomic version of -`{ tmp = *atomic; *atomic &= val; return tmp; }`. - +`{ tmp = *atomic; *atomic &= val; return tmp; }`. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to 'and' + the value to 'and' - - Compares @atomic to @oldval and, if equal, sets it to @newval. + + Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs. This compare and exchange is done atomically. @@ -53690,243 +38960,192 @@ This compare and exchange is done atomically. Think of this operation as an atomic version of `{ if (*atomic == oldval) { *atomic = newval; return TRUE; } else return FALSE; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - %TRUE if the exchange took place + %TRUE if the exchange took place - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to compare with + the value to compare with - the value to conditionally replace with + the value to conditionally replace with - - Decrements the value of @atomic by 1. + + Decrements the value of @atomic by 1. Think of this operation as an atomic version of `{ *atomic -= 1; return (*atomic == 0); }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - %TRUE if the resultant value is zero + %TRUE if the resultant value is zero - a pointer to a #gint or #guint + a pointer to a #gint or #guint - - This function existed before g_atomic_int_add() returned the prior + + This function existed before g_atomic_int_add() returned the prior value of the integer (which it now does). It is retained only for compatibility reasons. Don't use this function in new code. Use g_atomic_int_add() instead. - + - the value of @atomic before the add, signed + the value of @atomic before the add, signed - a pointer to a #gint + a pointer to a #gint - the value to add + the value to add - - Gets the current value of @atomic. + + Gets the current value of @atomic. This call acts as a full compiler and hardware -memory barrier (before the get). - +memory barrier (before the get). + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of the integer + the value of the integer - a pointer to a #gint or #guint + a pointer to a #gint or #guint - - Increments the value of @atomic by 1. + + Increments the value of @atomic by 1. Think of this operation as an atomic version of `{ *atomic += 1; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - a pointer to a #gint or #guint + a pointer to a #gint or #guint - - Performs an atomic bitwise 'or' of the value of @atomic and @val, + + Performs an atomic bitwise 'or' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic |= val; return tmp; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to 'or' + the value to 'or' - - Sets the value of @atomic to @newval. + + Sets the value of @atomic to @newval. This call acts as a full compiler and hardware -memory barrier (after the set). - +memory barrier (after the set). + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - a pointer to a #gint or #guint + a pointer to a #gint or #guint - a new value to store + a new value to store - - Performs an atomic bitwise 'xor' of the value of @atomic and @val, + + Performs an atomic bitwise 'xor' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic ^= val; return tmp; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to 'xor' + the value to 'xor' - The following is a collection of compiler macros to provide atomic + The following is a collection of compiler macros to provide atomic access to integer and pointer-sized values. The macros that have 'int' in the name will operate on pointers to @@ -53962,79 +39181,61 @@ the case of performing multiple atomic operations it can often be faster to simply acquire a mutex lock around the critical area, perform the operations normally and then release the lock. - - Atomically adds @val to the value of @atomic. + + Atomically adds @val to the value of @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic += val; return tmp; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the add, signed + the value of @atomic before the add, signed - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to add + the value to add - - Performs an atomic bitwise 'and' of the value of @atomic and @val, + + Performs an atomic bitwise 'and' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic &= val; return tmp; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to 'and' + the value to 'and' - - Compares @atomic to @oldval and, if equal, sets it to @newval. + + Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs. This compare and exchange is done atomically. @@ -54042,194 +39243,144 @@ This compare and exchange is done atomically. Think of this operation as an atomic version of `{ if (*atomic == oldval) { *atomic = newval; return TRUE; } else return FALSE; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - %TRUE if the exchange took place + %TRUE if the exchange took place - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - - the value to compare with + + the value to compare with - - the value to conditionally replace with + + the value to conditionally replace with - - Gets the current value of @atomic. + + Gets the current value of @atomic. This call acts as a full compiler and hardware -memory barrier (before the get). - +memory barrier (before the get). + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of the pointer + the value of the pointer - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - - Performs an atomic bitwise 'or' of the value of @atomic and @val, + + Performs an atomic bitwise 'or' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic |= val; return tmp; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to 'or' + the value to 'or' - - Sets the value of @atomic to @newval. + + Sets the value of @atomic to @newval. This call acts as a full compiler and hardware -memory barrier (after the set). - +memory barrier (after the set). + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - - a new value to store + + a new value to store - - Performs an atomic bitwise 'xor' of the value of @atomic and @val, + + Performs an atomic bitwise 'xor' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic ^= val; return tmp; }`. -This call acts as a full compiler and hardware memory barrier. - +This call acts as a full compiler and hardware memory barrier. + +While @atomic has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. + - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to 'xor' + the value to 'xor' - - Atomically acquires a reference on the data pointed by @mem_block. - + + Atomically acquires a reference on the data pointed by @mem_block. + - a pointer to the data, + a pointer to the data, with its reference count increased - a pointer to reference counted data + a pointer to reference counted data - - Allocates @block_size bytes of memory, and adds atomic + + Allocates @block_size bytes of memory, and adds atomic reference counting semantics to it. The data will be freed when its reference count drops to @@ -54237,28 +39388,20 @@ zero. The allocated data is guaranteed to be suitably aligned for any built-in type. - + - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - - Allocates @block_size bytes of memory, and adds atomic + + Allocates @block_size bytes of memory, and adds atomic reference counting semantics to it. The contents of the returned data is set to zero. @@ -54268,262 +39411,184 @@ zero. The allocated data is guaranteed to be suitably aligned for any built-in type. - + - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - - Allocates a new block of data with atomic reference counting + + Allocates a new block of data with atomic reference counting semantics, and copies @block_size bytes of @mem_block into it. - + - a pointer to the allocated + a pointer to the allocated memory - the number of bytes to copy, must be greater than 0 + the number of bytes to copy, must be greater than 0 - the memory to copy + the memory to copy - - Retrieves the size of the reference counted data pointed by @mem_block. - + + Retrieves the size of the reference counted data pointed by @mem_block. + - the size of the data, in bytes + the size of the data, in bytes - a pointer to reference counted data + a pointer to reference counted data - - A convenience macro to allocate atomically reference counted + + A convenience macro to allocate atomically reference counted data with the size of the given @type. This macro calls g_atomic_rc_box_alloc() with `sizeof (@type)` and casts the returned pointer to a pointer of the given @type, avoiding a type cast in the source code. - + - the type to allocate, typically a structure name + the type to allocate, typically a structure name - - A convenience macro to allocate atomically reference counted + + A convenience macro to allocate atomically reference counted data with the size of the given @type, and set its contents to zero. This macro calls g_atomic_rc_box_alloc0() with `sizeof (@type)` and casts the returned pointer to a pointer of the given @type, avoiding a type cast in the source code. - + - the type to allocate, typically a structure name + the type to allocate, typically a structure name - - Atomically releases a reference on the data pointed by @mem_block. + + Atomically releases a reference on the data pointed by @mem_block. If the reference was the last one, it will free the resources allocated for @mem_block. - + - a pointer to reference counted data + a pointer to reference counted data - - Atomically releases a reference on the data pointed by @mem_block. + + Atomically releases a reference on the data pointed by @mem_block. If the reference was the last one, it will call @clear_func to clear the contents of @mem_block, and then will free the resources allocated for @mem_block. - + - a pointer to reference counted data + a pointer to reference counted data - a function to call when clearing the data + a function to call when clearing the data - - Atomically compares the current value of @arc with @val. + + Atomically compares the current value of @arc with @val. - %TRUE if the reference count is the same + %TRUE if the reference count is the same as the given value - the address of an atomic reference count variable + the address of an atomic reference count variable - the value to compare + the value to compare - - Atomically decreases the reference count. + + Atomically decreases the reference count. + +If %TRUE is returned, the reference count reached 0. After this point, @arc +is an undefined state and must be reinitialized with +g_atomic_ref_count_init() to be used again. - %TRUE if the reference count reached 0, and %FALSE otherwise + %TRUE if the reference count reached 0, and %FALSE otherwise - the address of an atomic reference count variable + the address of an atomic reference count variable - - Atomically increases the reference count. + + Atomically increases the reference count. - the address of an atomic reference count variable + the address of an atomic reference count variable - - Initializes a reference count variable. + + Initializes a reference count variable to 1. - the address of an atomic reference count variable + the address of an atomic reference count variable - Base64 is an encoding that allows a sequence of arbitrary bytes to be + Base64 is an encoding that allows a sequence of arbitrary bytes to be encoded as a sequence of printable ASCII characters. For the definition of Base64, see [RFC 1421](http://www.ietf.org/rfc/rfc1421.txt) @@ -54540,19 +39605,13 @@ decoding, you can use g_base64_decode_inplace(). Support for Base64 encoding has been added in GLib 2.12. - - Decode a sequence of Base-64 encoded text into binary data. Note + + Decode a sequence of Base-64 encoded text into binary data. Note that the returned binary data is not necessarily zero-terminated, so it should not be used as a character string. - + newly allocated buffer containing the binary data that @text represents. The returned buffer must be freed with g_free(). @@ -54562,68 +39621,40 @@ so it should not be used as a character string. - zero-terminated string with base64 text to decode + zero-terminated string with base64 text to decode - - The length of the decoded data is written here + + The length of the decoded data is written here - - Decode a sequence of Base-64 encoded text into binary data + + Decode a sequence of Base-64 encoded text into binary data by overwriting the input data. - The binary data that @text responds. This pointer + The binary data that @text responds. This pointer is the same as the input @text. - - zero-terminated + + zero-terminated string with base64 text to decode - - The length of the decoded data is written here + + The length of the decoded data is written here - - Incrementally decode a sequence of binary data from its Base-64 stringified + + Incrementally decode a sequence of binary data from its Base-64 stringified representation. By calling this function multiple times you can convert data in chunks to avoid having to have the full encoded data in memory. @@ -54633,99 +39664,61 @@ at least: (@len / 4) * 3 + 3 bytes (+ 3 may be needed in case of non-zero state). - The number of bytes of output that was written + The number of bytes of output that was written - binary input data + binary input data - max length of @in data to decode + max length of @in data to decode - - output buffer + + output buffer - - Saved state between steps, initialize to 0 + + Saved state between steps, initialize to 0 - - Saved state between steps, initialize to 0 + + Saved state between steps, initialize to 0 - - Encode a sequence of binary data into its Base-64 stringified + + Encode a sequence of binary data into its Base-64 stringified representation. - a newly allocated, zero-terminated Base-64 + a newly allocated, zero-terminated Base-64 encoded string representing @data. The returned string must be freed with g_free(). - - the binary data to encode + + the binary data to encode - the length of @data + the length of @data - - Flush the status from a sequence of calls to g_base64_encode_step(). + + Flush the status from a sequence of calls to g_base64_encode_step(). The output buffer must be large enough to fit all the data that will be written to it. It will need up to 4 bytes, or up to 5 bytes if @@ -54734,55 +39727,32 @@ line-breaking is enabled. The @out array will not be automatically nul-terminated. - The number of bytes of output that was written + The number of bytes of output that was written - whether to break long lines + whether to break long lines - - pointer to destination buffer + + pointer to destination buffer - - Saved state from g_base64_encode_step() + + Saved state from g_base64_encode_step() - - Saved state from g_base64_encode_step() + + Saved state from g_base64_encode_step() - - Incrementally encode a sequence of binary data into its Base-64 stringified + + Incrementally encode a sequence of binary data into its Base-64 stringified representation. By calling this function multiple times you can convert data in chunks to avoid having to have the full encoded data in memory. @@ -54803,70 +39773,42 @@ Note however that it breaks the lines with `LF` characters, not or certain other protocols. - The number of bytes of output that was written + The number of bytes of output that was written - the binary data to encode + the binary data to encode - the length of @in + the length of @in - whether to break long lines + whether to break long lines - - pointer to destination buffer + + pointer to destination buffer - - Saved state between steps, initialize to 0 + + Saved state between steps, initialize to 0 - - Saved state between steps, initialize to 0 + + Saved state between steps, initialize to 0 - - Gets the name of the file without any leading directory + + Gets the name of the file without any leading directory components. It returns a pointer into the given file name string. Use g_path_get_basename() instead, but notice @@ -54875,25 +39817,19 @@ string. into the argument. - the name of the file without any leading + the name of the file without any leading directory components - the name of the file + the name of the file - Sets the indicated @lock_bit in @address. If the bit is already + Sets the indicated @lock_bit in @address. If the bit is already set, this call will block until g_bit_unlock() unsets the corresponding bit. @@ -54905,112 +39841,85 @@ between 0 and 31 then the result is undefined. This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work -reliably. +reliably. While @address has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. - a pointer to an integer + a pointer to an integer - a bit value between 0 and 31 + a bit value between 0 and 31 - Find the position of the first bit set in @mask, searching + Find the position of the first bit set in @mask, searching from (but not including) @nth_bit upwards. Bits are numbered from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63, usually). To start searching from the 0th bit, set @nth_bit to -1. - the index of the first bit set which is higher than @nth_bit, or -1 + the index of the first bit set which is higher than @nth_bit, or -1 if no higher bits are set - a #gulong containing flags + a #gulong containing flags - the index of the bit to start the search from + the index of the bit to start the search from - Find the position of the first bit set in @mask, searching + Find the position of the first bit set in @mask, searching from (but not including) @nth_bit downwards. Bits are numbered from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63, usually). To start searching from the last bit, set @nth_bit to -1 or GLIB_SIZEOF_LONG * 8. - the index of the first bit set which is lower than @nth_bit, or -1 + the index of the first bit set which is lower than @nth_bit, or -1 if no lower bits are set - a #gulong containing flags + a #gulong containing flags - the index of the bit to start the search from + the index of the bit to start the search from - Gets the number of bits used to hold @number, + Gets the number of bits used to hold @number, e.g. if @number is 4, 3 bits are needed. - the number of bits used to hold @number + the number of bits used to hold @number - a #guint + a #guint - Sets the indicated @lock_bit in @address, returning %TRUE if + Sets the indicated @lock_bit in @address, returning %TRUE if successful. If the bit is already set, returns %FALSE immediately. Attempting to lock on two different bits within the same integer is @@ -55021,69 +39930,55 @@ between 0 and 31 then the result is undefined. This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work -reliably. +reliably. While @address has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. - %TRUE if the lock was acquired + %TRUE if the lock was acquired - a pointer to an integer + a pointer to an integer - a bit value between 0 and 31 + a bit value between 0 and 31 - Clears the indicated @lock_bit in @address. If another thread is + Clears the indicated @lock_bit in @address. If another thread is currently blocked in g_bit_lock() on this same bit then it will be woken up. This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work -reliably. +reliably. While @address has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. - a pointer to an integer + a pointer to an integer - a bit value between 0 and 31 + a bit value between 0 and 31 - + - GBookmarkFile lets you parse, edit or create files containing bookmarks + GBookmarkFile lets you parse, edit or create files containing bookmarks to URI, along with some meta-data about the resource pointed by the URI like its MIME type, the application that is registering the bookmark and the icon that should be used to represent the bookmark. The data is stored @@ -55108,7 +40003,7 @@ registered; the URI and MIME type of an icon, to be used when displaying the bookmark inside a GUI. Here is an example of a bookmark file: -[bookmarks.xbel](https://git.gnome.org/browse/glib/tree/glib/tests/bookmarks.xbel) +[bookmarks.xbel](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/glib/tests/bookmarks.xbel) A bookmark file might contain more than one bookmark; each bookmark is accessed through its URI. @@ -55122,12 +40017,8 @@ g_bookmark_file_to_file(). The #GBookmarkFile parser was added in GLib 2.12. - - Creates a filename from a series of elements using the correct + + Creates a filename from a series of elements using the correct separator for filenames. On Unix, this function behaves identically to `g_build_path @@ -55144,79 +40035,54 @@ path. If the first element is a relative path, the result will be a relative path. - a newly-allocated string that must be freed with + a newly-allocated string that must be freed with g_free(). - the first element in the path + the first element in the path - remaining elements in path, terminated by %NULL + remaining elements in path, terminated by %NULL - - Behaves exactly like g_build_filename(), but takes the path elements + + Behaves exactly like g_build_filename(), but takes the path elements as a va_list. This function is mainly meant for language bindings. - a newly-allocated string that must be freed + a newly-allocated string that must be freed with g_free(). - the first element in the path + the first element in the path - va_list of remaining elements in path + va_list of remaining elements in path - - Behaves exactly like g_build_filename(), but takes the path elements + + Behaves exactly like g_build_filename(), but takes the path elements as a string array, instead of varargs. This function is mainly meant for language bindings. - a newly-allocated string that must be freed + a newly-allocated string that must be freed with g_free(). - %NULL-terminated + %NULL-terminated array of strings containing the path elements. @@ -55225,9 +40091,7 @@ meant for language bindings. - Creates a path from a series of elements using @separator as the + Creates a path from a series of elements using @separator as the separator between elements. At the boundary between two elements, any trailing occurrences of separator in the first element, or leading occurrences of separator in the second element are removed @@ -55255,58 +40119,42 @@ copies of the separator, elements consisting only of copies of the separator are ignored. - a newly-allocated string that must be freed with + a newly-allocated string that must be freed with g_free(). - a string used to separator the elements of the path. + a string used to separator the elements of the path. - the first element in the path + the first element in the path - remaining elements in path, terminated by %NULL + remaining elements in path, terminated by %NULL - Behaves exactly like g_build_path(), but takes the path elements + Behaves exactly like g_build_path(), but takes the path elements as a string array, instead of varargs. This function is mainly meant for language bindings. - a newly-allocated string that must be freed + a newly-allocated string that must be freed with g_free(). - a string used to separator the elements of the path. + a string used to separator the elements of the path. - %NULL-terminated + %NULL-terminated array of strings containing the path elements. @@ -55314,47 +40162,32 @@ meant for language bindings. - - Frees the memory allocated by the #GByteArray. If @free_segment is + + Frees the memory allocated by the #GByteArray. If @free_segment is %TRUE it frees the actual byte data. If the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array will be set to zero. - the element data if @free_segment is %FALSE, otherwise + the element data if @free_segment is %FALSE, otherwise %NULL. The element data should be freed using g_free(). - a #GByteArray + a #GByteArray - if %TRUE the actual byte data is freed as well + if %TRUE the actual byte data is freed as well - - Transfers the data from the #GByteArray into a new immutable #GBytes. + + Transfers the data from the #GByteArray into a new immutable #GBytes. The #GByteArray is freed unless the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array @@ -55364,120 +40197,82 @@ This is identical to using g_bytes_new_take() and g_byte_array_free() together. - a new immutable #GBytes representing same + a new immutable #GBytes representing same byte data that was in the array - a #GByteArray + a #GByteArray - - Creates a new #GByteArray with a reference count of 1. + + Creates a new #GByteArray with a reference count of 1. - the new #GByteArray + the new #GByteArray - - Create byte array containing the data. The data will be owned by the array -and will be freed with g_free(), i.e. it could be allocated using g_strdup(). + + Create byte array containing the data. The data will be owned by the array +and will be freed with g_free(), i.e. it could be allocated using g_strdup(). + +Do not use it if @len is greater than %G_MAXUINT. #GByteArray +stores the length of its data in #guint, which may be shorter than +#gsize. - a new #GByteArray + a new #GByteArray - byte data for the array + byte data for the array - length of @data + length of @data - - Frees the data in the array and resets the size to zero, while + + Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller. - the element data, which should be + the element data, which should be freed using g_free(). - a #GByteArray. + a #GByteArray. - - pointer to retrieve the number of + + pointer to retrieve the number of elements of the original array - - Atomically decrements the reference count of @array by one. If the + + Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread. @@ -55487,9 +40282,7 @@ thread. - A #GByteArray + A #GByteArray @@ -55497,9 +40290,7 @@ thread. - These macros provide a portable way to determine the host byte order + These macros provide a portable way to determine the host byte order and to convert values between different byte orders. The byte order is the order in which bytes are stored to create larger @@ -55528,12 +40319,8 @@ Note that the byte order conversion macros may evaluate their arguments multiple times, thus you should not use them with arguments which have side-effects. - - Gets the canonical file name from @filename. All triple slashes are turned into + + Gets the canonical file name from @filename. All triple slashes are turned into single slashes, and all `..` and `.`s resolved against @relative_to. Symlinks are not followed, and the returned path is guaranteed to be absolute. @@ -55549,109 +40336,81 @@ exist. No file system I/O is done. - a newly allocated string with the + a newly allocated string with the canonical file path - the name of the file + the name of the file - - the relative directory, or %NULL + + the relative directory, or %NULL to use the current working directory - A wrapper for the POSIX chdir() function. The function changes the + A wrapper for the POSIX chdir() function. The function changes the current directory of the process to @path. See your C library manual for more details about chdir(). - 0 on success, -1 if an error occurred. + 0 on success, -1 if an error occurred. - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - - Checks that the GLib library in use is compatible with the -given version. Generally you would pass in the constants -#GLIB_MAJOR_VERSION, #GLIB_MINOR_VERSION, #GLIB_MICRO_VERSION -as the three arguments to this function; that produces -a check that the library in use is compatible with -the version of GLib the application or module was compiled -against. + + Checks that the GLib library in use is compatible with the +given version. + +Generally you would pass in the constants %GLIB_MAJOR_VERSION, +%GLIB_MINOR_VERSION, %GLIB_MICRO_VERSION as the three arguments +to this function; that produces a check that the library in use +is compatible with the version of GLib the application or module +was compiled against. Compatibility is defined by two things: first the version of the running library is newer than the version -@required_major.required_minor.@required_micro. Second +`@required_major.required_minor.@required_micro`. Second the running library must be binary compatible with the -version @required_major.required_minor.@required_micro +version `@required_major.@required_minor.@required_micro` (same major version.) - - %NULL if the GLib library is compatible with the - given version, or a string describing the version mismatch. - The returned string is owned by GLib and must not be modified - or freed. + + %NULL if the GLib library is + compatible with the given version, or a string describing the + version mismatch. The returned string is owned by GLib and must + not be modified or freed. - the required major version + the required major version - the required minor version + the required minor version - the required micro version + the required micro version - GLib offers a set of macros for doing additions and multiplications + GLib offers a set of macros for doing additions and multiplications of unsigned integers, with checks for overflows. The helpers all have three arguments. A pointer to the destination @@ -55666,9 +40425,7 @@ implemented with inline assembly or compiler intrinsics where available. - GLib provides a generic API for computing checksums (or "digests") + GLib provides a generic API for computing checksums (or "digests") for a sequence of arbitrary bytes, using various hashing algorithms like MD5, SHA-1 and SHA-256. Checksums are commonly used in various environments and specifications. @@ -55684,42 +40441,27 @@ and g_compute_checksum_for_string(), respectively. Support for checksums has been added in GLib 2.16 - - Gets the length in bytes of digests of type @checksum_type - + + Gets the length in bytes of digests of type @checksum_type + - the checksum length, or -1 if @checksum_type is + the checksum length, or -1 if @checksum_type is not supported. - a #GChecksumType + a #GChecksumType - - Sets a function to be called when the child indicated by @pid -exits, at a default priority, #G_PRIORITY_DEFAULT. + + Sets a function to be called when the child indicated by @pid +exits, at a default priority, %G_PRIORITY_DEFAULT. If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() -you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to +you will need to pass %G_SPAWN_DO_NOT_REAP_CHILD as flag to the spawn function for the child watching to work. Note that on platforms where #GPid must be explicitly closed @@ -55735,53 +40477,37 @@ This internally creates a main loop source using g_child_watch_source_new() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - process id to watch. On POSIX the positive pid of a child -process. On Windows a handle for a process (which doesn't have to be -a child). + process id to watch. On POSIX the positive pid of a child + process. On Windows a handle for a process (which doesn't have + to be a child). - function to call + function to call - - data to pass to @function + + data to pass to @function - - Sets a function to be called when the child indicated by @pid + + Sets a function to be called when the child indicated by @pid exits, at the priority @priority. If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() -you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to +you will need to pass %G_SPAWN_DO_NOT_REAP_CHILD as flag to the spawn function for the child watching to work. -In many programs, you will want to call g_spawn_check_exit_status() +In many programs, you will want to call g_spawn_check_wait_status() in the callback to determine whether or not the child exited successfully. @@ -55798,65 +40524,38 @@ This internally creates a main loop source using g_child_watch_source_new() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the idle source. Typically this will be in the - range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. + the priority of the idle source. Typically this will be in the + range between %G_PRIORITY_DEFAULT_IDLE and %G_PRIORITY_HIGH_IDLE. - process to watch. On POSIX the positive pid of a child process. On + process to watch. On POSIX the positive pid of a child process. On Windows a handle for a process (which doesn't have to be a child). - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the idle is removed, or %NULL + + function to call when the idle is removed, or %NULL - - Creates a new child_watch source. + + Creates a new child_watch source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be @@ -55880,7 +40579,7 @@ due to limitations in POSIX process interfaces: * the application must not wait for @pid to exit by any other mechanism, including `waitpid(pid, ...)` or a second child-watch source for the same @pid -* the application must not ignore SIGCHILD +* the application must not ignore `SIGCHLD` If any of those conditions are not met, this and related APIs will not work correctly. This can often be diagnosed via a GLib warning @@ -55888,40 +40587,29 @@ stating that `ECHILD` was received by `waitpid`. Calling `waitpid` for specific processes other than @pid remains a valid thing to do. - + - the newly-created child watch source + the newly-created child watch source - process to watch. On POSIX the positive pid of a child process. On + process to watch. On POSIX the positive pid of a child process. On Windows a handle for a process (which doesn't have to be a child). - If @err or *@err is %NULL, does nothing. Otherwise, + If @err or *@err is %NULL, does nothing. Otherwise, calls g_error_free() on *@err and sets *@err to %NULL. - + - - Clears a numeric handler, such as a #GSource ID. + + Clears a numeric handler, such as a #GSource ID. @tag_ptr must be a valid pointer to the variable holding the handler. @@ -55931,32 +40619,23 @@ set to zero. A macro is also included that allows this function to be used without pointer casts. - + - a pointer to the handler ID + a pointer to the handler ID - the function to call to clear the handler + the function to call to clear the handler - - Clears a pointer to a #GList, freeing it and, optionally, freeing its elements using @destroy. + + Clears a pointer to a #GList, freeing it and, optionally, freeing its elements using @destroy. @list_ptr must be a valid pointer. If @list_ptr points to a null #GList, this does nothing. @@ -55965,32 +40644,19 @@ pointer casts. - a #GList return location + a #GList return location - - the function to pass to g_list_free_full() or %NULL to not free elements + + the function to pass to g_list_free_full() or %NULL to not free elements - - Clears a reference to a variable. + + Clears a reference to a variable. @pp must not be %NULL. @@ -56004,33 +40670,24 @@ or calling conventions, so you must ensure that your @destroy function is compatible with being called as `GDestroyNotify` using the standard calling convention for the platform that GLib was compiled for; otherwise the program will experience undefined behaviour. - + - a pointer to a variable, struct member etc. holding a + a pointer to a variable, struct member etc. holding a pointer - a function to which a gpointer can be passed, to destroy *@pp + a function to which a gpointer can be passed, to destroy *@pp - - Clears a pointer to a #GSList, freeing it and, optionally, freeing its elements using @destroy. + + Clears a pointer to a #GSList, freeing it and, optionally, freeing its elements using @destroy. @slist_ptr must be a valid pointer. If @slist_ptr points to a null #GSList, this does nothing. @@ -56039,29 +40696,19 @@ will experience undefined behaviour. - a #GSList return location + a #GSList return location - - the function to pass to g_slist_free_full() or %NULL to not free elements + + the function to pass to g_slist_free_full() or %NULL to not free elements - This wraps the close() call; in case of error, %errno will be + This wraps the close() call; in case of error, %errno will be preserved, but the error will also be stored as a #GError in @error. Besides using #GError, there is another major reason to prefer this @@ -56070,281 +40717,202 @@ attempt to correctly handle %EINTR, which has platform-specific semantics. - %TRUE on success, %FALSE if there was an error. + %TRUE on success, %FALSE if there was an error. - A file descriptor + A file descriptor - - Computes the checksum for a binary @data. This is a + + Computes the checksum for a binary @data. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free(). The hexadecimal string returned will be in lower case. - - - the digest of the binary data as a string in hexadecimal. - The returned string should be freed with g_free() when done using it. + + + the digest of the binary data as a + string in hexadecimal, or %NULL if g_checksum_new() fails for + @checksum_type. The returned string should be freed with g_free() when + done using it. - a #GChecksumType + a #GChecksumType - binary blob to compute the digest of + binary blob to compute the digest of - - Computes the checksum for a binary @data of @length. This is a + + Computes the checksum for a binary @data of @length. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free(). The hexadecimal string returned will be in lower case. - - - the digest of the binary data as a string in hexadecimal. - The returned string should be freed with g_free() when done using it. + + + the digest of the binary data as a + string in hexadecimal, or %NULL if g_checksum_new() fails for + @checksum_type. The returned string should be freed with g_free() when + done using it. - a #GChecksumType + a #GChecksumType - binary blob to compute the digest of + binary blob to compute the digest of - length of @data + length of @data - - Computes the checksum of a string. + + Computes the checksum of a string. The hexadecimal string returned will be in lower case. - - - the checksum as a hexadecimal string. The returned string + + + the checksum as a hexadecimal string, + or %NULL if g_checksum_new() fails for @checksum_type. The returned string should be freed with g_free() when done using it. - a #GChecksumType + a #GChecksumType - the string to compute the checksum of + the string to compute the checksum of - the length of the string, or -1 if the string is null-terminated. + the length of the string, or -1 if the string is null-terminated. - - Computes the HMAC for a binary @data. This is a + + Computes the HMAC for a binary @data. This is a convenience wrapper for g_hmac_new(), g_hmac_get_string() and g_hmac_unref(). The hexadecimal string returned will be in lower case. - the HMAC of the binary data as a string in hexadecimal. + the HMAC of the binary data as a string in hexadecimal. The returned string should be freed with g_free() when done using it. - a #GChecksumType to use for the HMAC + a #GChecksumType to use for the HMAC - the key to use in the HMAC + the key to use in the HMAC - binary blob to compute the HMAC of + binary blob to compute the HMAC of - - Computes the HMAC for a binary @data of @length. This is a + + Computes the HMAC for a binary @data of @length. This is a convenience wrapper for g_hmac_new(), g_hmac_get_string() and g_hmac_unref(). The hexadecimal string returned will be in lower case. - the HMAC of the binary data as a string in hexadecimal. + the HMAC of the binary data as a string in hexadecimal. The returned string should be freed with g_free() when done using it. - a #GChecksumType to use for the HMAC + a #GChecksumType to use for the HMAC - the key to use in the HMAC + the key to use in the HMAC - the length of the key + the length of the key - binary blob to compute the HMAC of + binary blob to compute the HMAC of - length of @data + length of @data - - Computes the HMAC for a string. + + Computes the HMAC for a string. The hexadecimal string returned will be in lower case. - the HMAC as a hexadecimal string. + the HMAC as a hexadecimal string. The returned string should be freed with g_free() when done using it. - a #GChecksumType to use for the HMAC + a #GChecksumType to use for the HMAC - the key to use in the HMAC + the key to use in the HMAC - the length of the key + the length of the key - the string to compute the HMAC for + the string to compute the HMAC for - the length of the string, or -1 if the string is nul-terminated + the length of the string, or -1 if the string is nul-terminated - The g_convert() family of function wraps the functionality of iconv(). + The g_convert() family of function wraps the functionality of iconv(). In addition to pure character set conversions, GLib has functions to deal with the extra complications of encodings for file names. @@ -56355,16 +40923,16 @@ a file name is valid as long as it does not have path separators in it ("/"). However, displaying file names may require conversion: from the character set in which they were created, to the character set in which the application operates. Consider the Spanish file name -"Presentación.sxi". If the application which created it uses +"Presentación.sxi". If the application which created it uses ISO-8859-1 for its encoding, |[ -Character: P r e s e n t a c i ó n . s x i +Character: P r e s e n t a c i ó n . s x i Hex code: 50 72 65 73 65 6e 74 61 63 69 f3 6e 2e 73 78 69 ]| However, if the application use UTF-8, the actual file name on disk would look like this: |[ -Character: P r e s e n t a c i ó n . s x i +Character: P r e s e n t a c i ó n . s x i Hex code: 50 72 65 73 65 6e 74 61 63 69 c3 b3 6e 2e 73 78 69 ]| Glib uses UTF-8 for its strings, and GUI toolkits like GTK+ that use @@ -56438,9 +41006,7 @@ name encodings correctly. `ISO-8859-1`, for example. - Converts a string from one character set to another. + Converts a string from one character set to another. Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial @@ -56456,9 +41022,7 @@ Using extensions such as "//TRANSLIT" may not work (or may not work well) on many platforms. Consider using g_str_to_ascii() instead. - + If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free(). Otherwise %NULL and @error will be set. @@ -56468,44 +41032,29 @@ well) on many platforms. Consider using g_str_to_ascii() instead. - + the string to convert. - the length of the string in bytes, or -1 if the string is + the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) - name of character set into which to convert @str + name of character set into which to convert @str - character set of @str. + character set of @str. - - location to store the number of bytes in + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -56515,15 +41064,8 @@ well) on many platforms. Consider using g_str_to_ascii() instead. input sequence. - - the number of bytes stored in + + the number of bytes stored in the output buffer (not including the terminating nul). @@ -56534,12 +41076,8 @@ well) on many platforms. Consider using g_str_to_ascii() instead. - - Converts a string from one character set to another, possibly + + Converts a string from one character set to another, possibly including fallback sequences for characters not representable in the output. Note that it is not guaranteed that the specification for the fallback sequences in @fallback will be honored. Some @@ -56558,9 +41096,7 @@ character until it knows that the next character is not a mark that could combine with the base character.) - + If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free(). Otherwise %NULL and @error will be set. @@ -56570,81 +41106,52 @@ could combine with the base character.) - + the string to convert. - the length of the string in bytes, or -1 if the string is + the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) - name of character set into which to convert @str + name of character set into which to convert @str - character set of @str. + character set of @str. - UTF-8 string to use in place of characters not + UTF-8 string to use in place of characters not present in the target encoding. (The string must be representable in the target encoding). If %NULL, characters not in the target encoding will be represented as Unicode escapes \uxxxx or \Uxxxxyyyy. - - location to store the number of bytes in + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters at the end of the input. - - the number of bytes stored in + + the number of bytes stored in the output buffer (not including the terminating nul). - - Converts a string from one character set to another. + + Converts a string from one character set to another. Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial @@ -56665,9 +41172,7 @@ the input character set. To get defined behaviour for conversion of unrepresentable characters, use g_convert_with_fallback(). - + If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free(). Otherwise %NULL and @error will be set. @@ -56677,38 +41182,25 @@ unrepresentable characters, use g_convert_with_fallback(). - + the string to convert. - the length of the string in bytes, or -1 if the string is + the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) - conversion descriptor from g_iconv_open() + conversion descriptor from g_iconv_open() - - location to store the number of bytes in + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -56718,24 +41210,15 @@ unrepresentable characters, use g_convert_with_fallback(). input sequence. - - the number of bytes stored in + + the number of bytes stored in the output buffer (not including the terminating nul). - Keyed data lists provide lists of arbitrary data elements which can + Keyed data lists provide lists of arbitrary data elements which can be accessed either with a string or with a #GQuark corresponding to the string. @@ -56762,12 +41245,8 @@ g_datalist_id_remove_data() and g_datalist_remove_data(). To remove all data elements from a datalist, use g_datalist_clear(). - - Frees all the data elements of the datalist. + + Frees all the data elements of the datalist. The data elements' destroy functions are called if they have been set. @@ -56776,17 +41255,13 @@ if they have been set. - a datalist. + a datalist. - Calls the given function for each data element of the datalist. The + Calls the given function for each data element of the datalist. The function is called with each data element's #GQuark id and data, together with the given @user_data parameter. Note that this function is NOT thread-safe. So unless @datalist can be protected @@ -56802,89 +41277,56 @@ than skipping over elements that are removed. - a datalist. + a datalist. - - the function to call for each data element. + + the function to call for each data element. - - user data to pass to the function. + + user data to pass to the function. - Gets a data element, using its string identifier. This is slower than + Gets a data element, using its string identifier. This is slower than g_datalist_id_get_data() because it compares strings. - the data element, or %NULL if it + the data element, or %NULL if it is not found. - a datalist. + a datalist. - the string identifying a data element. + the string identifying a data element. - - Gets flags values packed in together with the datalist. + + Gets flags values packed in together with the datalist. See g_datalist_set_flags(). - the flags of the datalist + the flags of the datalist - pointer to the location that holds a list + pointer to the location that holds a list - - This is a variant of g_datalist_id_get_data() which + + This is a variant of g_datalist_id_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -56899,133 +41341,83 @@ This function can be useful to avoid races when multiple threads are using the same datalist and the same key. - the result of calling @dup_func on the value + the result of calling @dup_func on the value associated with @key_id in @datalist, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. - location of a datalist + location of a datalist - the #GQuark identifying a data element + the #GQuark identifying a data element - - function to duplicate the old value + + function to duplicate the old value - - passed as user_data to @dup_func + + passed as user_data to @dup_func - - Retrieves the data element corresponding to @key_id. + + Retrieves the data element corresponding to @key_id. - the data element, or %NULL if + the data element, or %NULL if it is not found. - a datalist. + a datalist. - the #GQuark identifying a data element. + the #GQuark identifying a data element. - - Removes an element, using its #GQuark identifier. + + Removes an element, using its #GQuark identifier. - a datalist. + a datalist. - the #GQuark identifying the data element. + the #GQuark identifying the data element. - - Removes an element, without calling its destroy notification + + Removes an element, without calling its destroy notification function. - the data previously stored at @key_id, + the data previously stored at @key_id, or %NULL if none. - a datalist. + a datalist. - the #GQuark identifying a data element. + the #GQuark identifying a data element. - - Compares the member that is associated with @key_id in + + Compares the member that is associated with @key_id in @datalist to @oldval, and if they are the same, replace @oldval with @newval. @@ -57040,101 +41432,57 @@ or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. - %TRUE if the existing value for @key_id was replaced + %TRUE if the existing value for @key_id was replaced by @newval, %FALSE otherwise. - location of a datalist + location of a datalist - the #GQuark identifying a data element + the #GQuark identifying a data element - - the old value to compare against + + the old value to compare against - - the new value to replace it with + + the new value to replace it with - - destroy notify for the new value + + destroy notify for the new value - - destroy notify for the existing value + + destroy notify for the existing value - - Sets the data corresponding to the given #GQuark id. Any previous + + Sets the data corresponding to the given #GQuark id. Any previous data with the same key is removed, and its destroy function is called. - a datalist. + a datalist. - the #GQuark to identify the data element. + the #GQuark to identify the data element. - the data element, or %NULL to remove any previous element + the data element, or %NULL to remove any previous element corresponding to @q. - - Sets the data corresponding to the given #GQuark id, and the + + Sets the data corresponding to the given #GQuark id, and the function to be called when the element is removed from the datalist. Any previous data with the same key is removed, and its destroy function is called. @@ -57144,35 +41492,20 @@ function is called. - a datalist. + a datalist. - the #GQuark to identify the data element. + the #GQuark to identify the data element. - - the data element or %NULL to remove any previous element + + the data element or %NULL to remove any previous element corresponding to @key_id. - - the function to call when the data element is + + the function to call when the data element is removed. This function will be called with the data element and can be used to free any memory allocated for it. If @data is %NULL, then @destroy_func must @@ -57181,12 +41514,8 @@ function is called. - - Resets the datalist to %NULL. It does not free any memory or call + + Resets the datalist to %NULL. It does not free any memory or call any destroy functions. @@ -57194,121 +41523,77 @@ any destroy functions. - a pointer to a pointer to a datalist. + a pointer to a pointer to a datalist. - - Removes an element using its string identifier. The data element's + + Removes an element using its string identifier. The data element's destroy function is called if it has been set. - a datalist. + a datalist. - the string identifying the data element. + the string identifying the data element. - - Removes an element, without calling its destroy notifier. + + Removes an element, without calling its destroy notifier. - a datalist. + a datalist. - the string identifying the data element. + the string identifying the data element. - - Sets the data element corresponding to the given string identifier. + + Sets the data element corresponding to the given string identifier. - a datalist. + a datalist. - the string to identify the data element. + the string to identify the data element. - the data element, or %NULL to remove any previous element + the data element, or %NULL to remove any previous element corresponding to @k. - - Sets the data element corresponding to the given string identifier, + + Sets the data element corresponding to the given string identifier, and the function to be called when the data element is removed. - a datalist. + a datalist. - the string to identify the data element. + the string to identify the data element. - the data element, or %NULL to remove any previous element + the data element, or %NULL to remove any previous element corresponding to @k. - the function to call when the data element is removed. + the function to call when the data element is removed. This function will be called with the data element and can be used to free any memory allocated for it. If @d is %NULL, then @f must also be %NULL. - - Turns on flag values for a data list. This function is used + + Turns on flag values for a data list. This function is used to keep a small number of boolean flags in an object with a data list without using any additional space. It is not generally useful except in circumstances where space @@ -57320,15 +41605,11 @@ example.) - pointer to the location that holds a list + pointer to the location that holds a list - the flags to turn on. The values of the flags are + the flags to turn on. The values of the flags are restricted by %G_DATALIST_FLAGS_MASK (currently 3; giving two possible boolean flags). A value for @flags that doesn't fit within the mask is @@ -57337,27 +41618,19 @@ example.) - - Turns off flag values for a data list. See g_datalist_unset_flags() + + Turns off flag values for a data list. See g_datalist_unset_flags() - pointer to the location that holds a list + pointer to the location that holds a list - the flags to turn off. The values of the flags are + the flags to turn off. The values of the flags are restricted by %G_DATALIST_FLAGS_MASK (currently 3: giving two possible boolean flags). A value for @flags that doesn't fit within the mask is @@ -57367,9 +41640,7 @@ example.) - Destroys the dataset, freeing all memory allocated, and calling any + Destroys the dataset, freeing all memory allocated, and calling any destroy functions set for data elements. @@ -57377,17 +41648,13 @@ destroy functions set for data elements. - the location identifying the dataset. + the location identifying the dataset. - Calls the given function for each data element which is associated + Calls the given function for each data element which is associated with the given location. Note that this function is NOT thread-safe. So unless @dataset_location can be protected from any modifications during invocation of this function, it should not be called. @@ -57401,162 +41668,102 @@ than skipping over elements that are removed. - the location identifying the dataset. + the location identifying the dataset. - - the function to call for each data element. + + the function to call for each data element. - - user data to pass to the function. + + user data to pass to the function. - - Gets the data element corresponding to a string. + + Gets the data element corresponding to a string. - the location identifying the dataset. + the location identifying the dataset. - the string identifying the data element. + the string identifying the data element. - Gets the data element corresponding to a #GQuark. + Gets the data element corresponding to a #GQuark. - the data element corresponding to + the data element corresponding to the #GQuark, or %NULL if it is not found. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark id to identify the data element. + the #GQuark id to identify the data element. - - Removes a data element from a dataset. The data element's destroy + + Removes a data element from a dataset. The data element's destroy function is called if it has been set. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark id identifying the data element. + the #GQuark id identifying the data element. - - Removes an element, without calling its destroy notification + + Removes an element, without calling its destroy notification function. - the data previously stored at @key_id, + the data previously stored at @key_id, or %NULL if none. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark ID identifying the data element. + the #GQuark ID identifying the data element. - - Sets the data element associated with the given #GQuark id. Any + + Sets the data element associated with the given #GQuark id. Any previous data with the same key is removed, and its destroy function is called. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark id to identify the data element. + the #GQuark id to identify the data element. - the data element. + the data element. - - Sets the data element associated with the given #GQuark id, and also + + Sets the data element associated with the given #GQuark id, and also the function to call when the data element is destroyed. Any previous data with the same key is removed, and its destroy function is called. @@ -57566,30 +41773,19 @@ is called. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark id to identify the data element. + the #GQuark id to identify the data element. - - the data element. + + the data element. - the function to call when the data element is + the function to call when the data element is removed. This function will be called with the data element and can be used to free any memory allocated for it. @@ -57597,109 +41793,69 @@ is called. - - Removes a data element corresponding to a string. Its destroy + + Removes a data element corresponding to a string. Its destroy function is called if it has been set. - the location identifying the dataset. + the location identifying the dataset. - the string identifying the data element. + the string identifying the data element. - - Removes an element, without calling its destroy notifier. + + Removes an element, without calling its destroy notifier. - the location identifying the dataset. + the location identifying the dataset. - the string identifying the data element. + the string identifying the data element. - - Sets the data corresponding to the given string identifier. + + Sets the data corresponding to the given string identifier. - the location identifying the dataset. + the location identifying the dataset. - the string to identify the data element. + the string to identify the data element. - the data element. + the data element. - - Sets the data corresponding to the given string identifier, and the + + Sets the data corresponding to the given string identifier, and the function to call when the data element is destroyed. - the location identifying the dataset. + the location identifying the dataset. - the string to identify the data element. + the string to identify the data element. - the data element. + the data element. - the function to call when the data element is removed. This + the function to call when the data element is removed. This function will be called with the data element and can be used to free any memory allocated for it. - Datasets associate groups of data elements with particular memory + Datasets associate groups of data elements with particular memory locations. These are useful if you need to associate data with a structure returned from an external library. Since you cannot modify the structure, you use its location in memory as the key into a @@ -57732,9 +41888,7 @@ g_dataset_id_remove_data() and g_dataset_remove_data(). To destroy a dataset, use g_dataset_destroy(). - The #GDate data structure represents a day between January 1, Year 1, + The #GDate data structure represents a day between January 1, Year 1, and sometime a few thousand years in the future (right now it will go to the year 65535 or so, but g_date_set_parse() only parses up to the year 8000 or so - just count on "a few thousand"). #GDate is meant to @@ -57775,9 +41929,7 @@ representation is valid. Sometimes neither is valid. Use the API. GLib also features #GDateTime which represents a precise time. - #GDateTime is a structure that combines a Gregorian date and time + #GDateTime is a structure that combines a Gregorian date and time into a single structure. It provides many conversion and methods to manipulate dates and times. Time precision is provided down to microseconds and the time can range (proleptically) from 0001-01-01 @@ -57803,41 +41955,27 @@ savings time transitions are either 23 or 25 hours in length). #GDateTime is available since GLib 2.26. - - Returns the number of days in a month, taking leap + + Returns the number of days in a month, taking leap years into account. - number of days in @month during the @year + number of days in @month during the @year - month + month - year + year - - Returns the number of weeks in the year, where weeks + + Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -57846,26 +41984,18 @@ Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.) - number of Mondays in the year + number of Mondays in the year - a year + a year - - Returns the number of weeks in the year, where weeks + + Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -57874,26 +42004,18 @@ Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.) - the number of weeks in @year + the number of weeks in @year - year to count weeks in + year to count weeks in - - Returns %TRUE if the year is a leap year. + + Returns %TRUE if the year is a leap year. For the purposes of this function, leap year is every year divisible by 4 unless that year is divisible by 100. If it @@ -57901,26 +42023,18 @@ is divisible by 100 it would be a leap year only if that year is also divisible by 400. - %TRUE if the year is a leap year + %TRUE if the year is a leap year - year to check + year to check - - Generates a printed representation of the date, in a + + Generates a printed representation of the date, in a [locale][setlocale]-specific way. Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats @@ -57935,318 +42049,155 @@ make the \%F provided by the C99 strftime() work on Windows where the C library only complies to C89. - number of characters written to the buffer, or 0 the buffer was too small + number of characters written to the buffer, or 0 the buffer was too small - destination buffer + destination buffer - buffer size + buffer size - format string + format string - valid #GDate + valid #GDate - - A comparison function for #GDateTimes that is suitable -as a #GCompareFunc. Both #GDateTimes must be non-%NULL. - - - -1, 0 or 1 if @dt1 is less than, equal to or greater - than @dt2. - - - - - first #GDateTime to compare - - - - second #GDateTime to compare - - - - - - Checks to see if @dt1 and @dt2 are equal. - -Equal here means that they represent the same moment after converting -them to the same time zone. - - - %TRUE if @dt1 and @dt2 are equal - - - - - a #GDateTime - - - - a #GDateTime - - - - - - Hashes @datetime into a #guint, suitable for use within #GHashTable. - - - a #guint containing the hash - - - - - a #GDateTime - - - - - - Returns %TRUE if the day of the month is valid (a day is valid if it's + + Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive). - %TRUE if the day is valid + %TRUE if the day is valid - day to check + day to check - - Returns %TRUE if the day-month-year triplet forms a valid, existing day + + Returns %TRUE if the day-month-year triplet forms a valid, existing day in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future). - %TRUE if the date is a valid one + %TRUE if the date is a valid one - day + day - month + month - year + year - - Returns %TRUE if the Julian day is valid. Anything greater than zero + + Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit. - %TRUE if the Julian day is valid + %TRUE if the Julian day is valid - Julian day to check + Julian day to check - - Returns %TRUE if the month value is valid. The 12 #GDateMonth + + Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months. - %TRUE if the month is valid + %TRUE if the month is valid - month + month - - Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration + + Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays. - %TRUE if the weekday is valid + %TRUE if the weekday is valid - weekday + weekday - - Returns %TRUE if the year is valid. Any year greater than 0 is valid, + + Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand. - %TRUE if the year is valid + %TRUE if the year is valid - year + year - This is a variant of g_dgettext() that allows specifying a locale + This is a variant of g_dgettext() that allows specifying a locale category instead of always using `LC_MESSAGES`. See g_dgettext() for more information about how this functions differs from calling dcgettext() directly. - the translated string for the given locale category + the translated string for the given locale category - - the translation domain to use, or %NULL to use + + the translation domain to use, or %NULL to use the domain set with textdomain() - message to translate + message to translate - a locale category + a locale category - This function is a wrapper of dgettext() which does not translate + This function is a wrapper of dgettext() which does not translate the message if the default domain as set with textdomain() has no translations for the current locale. @@ -58280,38 +42231,23 @@ Applications should normally not use this function directly, but use the _() macro for translations. - The translated string + The translated string - - the translation domain to use, or %NULL to use + + the translation domain to use, or %NULL to use the domain set with textdomain() - message to translate + message to translate - - Creates a subdirectory in the preferred directory for temporary + + Creates a subdirectory in the preferred directory for temporary files (as returned by g_get_tmp_dir()). @tmpl should be a string in the GLib file name encoding containing @@ -58324,31 +42260,22 @@ Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not modified, and might thus be a read-only literal string. - The actual name used. This string + The actual name used. This string should be freed with g_free() when not needed any longer and is is in the GLib file name encoding. In case of errors, %NULL is returned and @error will be set. - - Template for directory name, + + Template for directory name, as in g_mkdtemp(), basename only, or %NULL for a default template - Compares two #gpointer arguments and returns %TRUE if they are equal. + Compares two #gpointer arguments and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using opaque pointers compared by pointer value as keys in a #GHashTable. @@ -58357,36 +42284,22 @@ This equality function is also appropriate for keys that are integers stored in pointers, such as `GINT_TO_POINTER (n)`. - %TRUE if the two keys match. + %TRUE if the two keys match. - - a key + + a key - - a key to compare with @v1 + + a key to compare with @v1 - Converts a gpointer to a hash value. + Converts a gpointer to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using opaque pointers compared by pointer value as keys in a #GHashTable. @@ -58395,27 +42308,18 @@ This hash function is also appropriate for keys that are integers stored in pointers, such as `GINT_TO_POINTER (n)`. - a hash value corresponding to the key. + a hash value corresponding to the key. - - a #gpointer key + + a #gpointer key - This function is a wrapper of dngettext() which does not translate + This function is a wrapper of dngettext() which does not translate the message if the default domain as set with textdomain() has no translations for the current locale. @@ -58423,99 +42327,70 @@ See g_dgettext() for details of how this differs from dngettext() proper. - The translated string + The translated string - - the translation domain to use, or %NULL to use + + the translation domain to use, or %NULL to use the domain set with textdomain() - message to translate + message to translate - plural form of the message + plural form of the message - the quantity for which translation is needed + the quantity for which translation is needed - Compares the two #gdouble values being pointed to and returns + Compares the two #gdouble values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to doubles as keys in a #GHashTable. - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #gdouble key + a pointer to a #gdouble key - a pointer to a #gdouble key to compare with @v1 + a pointer to a #gdouble key to compare with @v1 - Converts a pointer to a #gdouble to a hash value. + Converts a pointer to a #gdouble to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to doubles as keys in a #GHashTable. - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #gdouble key + a pointer to a #gdouble key - This function is a variant of g_dgettext() which supports + This function is a variant of g_dgettext() which supports a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid. @@ -58530,41 +42405,28 @@ Applications should normally not use this function directly, but use the C_() macro for translations with context. - The translated string + The translated string - - the translation domain to use, or %NULL to use + + the translation domain to use, or %NULL to use the domain set with textdomain() - a combined message context and message id, separated + a combined message context and message id, separated by a \004 character - the offset of the message id in @msgctxid + the offset of the message id in @msgctxid - This function is a variant of g_dgettext() which supports + This function is a variant of g_dgettext() which supports a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid. @@ -58576,61 +42438,39 @@ This function differs from C_() in that it is not a macro and thus you may use non-string-literals as context and msgid arguments. - The translated string + The translated string - - the translation domain to use, or %NULL to use + + the translation domain to use, or %NULL to use the domain set with textdomain() - the message context + the message context - the message + the message - - Returns the value of the environment variable @variable in the + + Returns the value of the environment variable @variable in the provided list @envp. - the value of the environment variable, or %NULL if + the value of the environment variable, or %NULL if the environment variable is not set in @envp. The returned string is owned by @envp, and will be freed if @variable is set or unset again. - - + + an environment list (eg, as returned from g_get_environ()), or %NULL for an empty environment list @@ -58638,38 +42478,25 @@ provided list @envp. - the environment variable to get + the environment variable to get - - Sets the environment variable @variable in the provided list + + Sets the environment variable @variable in the provided list @envp to @value. - + the updated environment list. Free it using g_strfreev(). - - + + an environment list that can be freed using g_strfreev() (e.g., as returned from g_get_environ()), or %NULL for an empty environment list @@ -58678,51 +42505,34 @@ provided list @envp. - the environment variable to set, must not + the environment variable to set, must not contain '=' - the value for to set the variable to + the value for to set the variable to - whether to change the variable if it already exists + whether to change the variable if it already exists - - Removes the environment variable @variable from the provided + + Removes the environment variable @variable from the provided environment @envp. - + the updated environment list. Free it using g_strfreev(). - - + + an environment list that can be freed using g_strfreev() (e.g., as returned from g_get_environ()), or %NULL for an empty environment list @@ -58730,18 +42540,14 @@ environment @envp. - the environment variable to remove, must not + the environment variable to remove, must not contain '=' - GLib provides a standard method of reporting errors from a called + GLib provides a standard method of reporting errors from a called function to the calling code. (This is the same problem solved by exceptions in other languages.) It's important to understand that this method is both a data type (the #GError struct) and a [set of @@ -58828,6 +42634,12 @@ perhaps along with additional context known only to the calling function (the file being opened, or whatever - though in the g_file_get_contents() case, the @message already contains a filename). +Since error messages may be displayed to the user, they need to be valid +UTF-8 (all GTK widgets expect text to be UTF-8). Keep this in mind in +particular when formatting error messages with filenames, which are in +the 'filename encoding', and need to be turned into UTF-8 using +g_filename_to_utf8(), g_filename_display_name() or g_utf8_make_valid(). + Note, however, that many error messages are too technical to display to the user in an application, so prefer to use g_error_matches() to categorize errors from called functions, and build an appropriate error message for the context @@ -59030,14 +42842,14 @@ Summary of rules for use of #GError: - Do not report programming errors via #GError. - The last argument of a function that returns an error should - be a location where a #GError can be placed (i.e. "#GError** error"). - If #GError is used with varargs, the #GError** should be the last - argument before the "...". + be a location where a #GError can be placed (i.e. `GError **error`). + If #GError is used with varargs, the `GError**` should be the last + argument before the `...`. -- The caller may pass %NULL for the #GError** if they are not interested +- The caller may pass %NULL for the `GError**` if they are not interested in details of the exact error that occurred. -- If %NULL is passed for the #GError** argument, then errors should +- If %NULL is passed for the `GError**` argument, then errors should not be returned to the caller, but your function should still abort and return if an error occurs. That is, control flow should not be affected by whether the caller wants to get a #GError. @@ -59051,11 +42863,13 @@ Summary of rules for use of #GError: - If a #GError is reported, out parameters are not guaranteed to be set to any defined value. -- A #GError* must be initialized to %NULL before passing its address +- A `GError*` must be initialized to %NULL before passing its address to a function that can report errors. +- #GError structs must not be stack-allocated. + - "Piling up" errors is always a bug. That is, if you assign a - new #GError to a #GError* that is non-%NULL, thus overwriting + new #GError to a `GError*` that is non-%NULL, thus overwriting the previous error, it indicates that you should have aborted the operation instead of continuing. If you were able to continue, you should have cleared the previous error with g_clear_error(). @@ -59063,12 +42877,12 @@ Summary of rules for use of #GError: - By convention, if you return a boolean value indicating success then %TRUE means success and %FALSE means failure. Avoid creating - functions which have a boolean return value and a GError parameter, + functions which have a boolean return value and a #GError parameter, but where the boolean does something other than signal whether the - GError is set. Among other problems, it requires C callers to allocate - a temporary error. Instead, provide a "gboolean *" out parameter. + #GError is set. Among other problems, it requires C callers to allocate + a temporary error. Instead, provide a `gboolean *` out parameter. There are functions in GLib itself such as g_key_file_has_key() that - are deprecated because of this. If %FALSE is returned, the error must + are hard to use because of this. If %FALSE is returned, the error must be set to a non-%NULL value. One exception to this is that in situations that are already considered to be undefined behaviour (such as when a g_return_val_if_fail() check fails), the error need not be set. @@ -59085,15 +42899,128 @@ Summary of rules for use of #GError: - When implementing a function that can report errors, you may want to add a check at the top of your function that the error return location is either %NULL or contains a %NULL error (e.g. - `g_return_if_fail (error == NULL || *error == NULL);`). + `g_return_if_fail (error == NULL || *error == NULL);`). + +## Extended #GError Domains # {#gerror-extended-domains} + +Since GLib 2.68 it is possible to extend the #GError type. This is +done with the G_DEFINE_EXTENDED_ERROR() macro. To create an +extended #GError type do something like this in the header file: +|[<!-- language="C" --> +typedef enum +{ + MY_ERROR_BAD_REQUEST, +} MyError; +#define MY_ERROR (my_error_quark ()) +GQuark my_error_quark (void); +int +my_error_get_parse_error_id (GError *error); +const char * +my_error_get_bad_request_details (GError *error); +]| +and in implementation: +|[<!-- language="C" --> +typedef struct +{ + int parse_error_id; + char *bad_request_details; +} MyErrorPrivate; + +static void +my_error_private_init (MyErrorPrivate *priv) +{ + priv->parse_error_id = -1; + // No need to set priv->bad_request_details to NULL, + // the struct is initialized with zeros. +} + +static void +my_error_private_copy (const MyErrorPrivate *src_priv, MyErrorPrivate *dest_priv) +{ + dest_priv->parse_error_id = src_priv->parse_error_id; + dest_priv->bad_request_details = g_strdup (src_priv->bad_request_details); +} + +static void +my_error_private_clear (MyErrorPrivate *priv) +{ + g_free (priv->bad_request_details); +} + +// This defines the my_error_get_private and my_error_quark functions. +G_DEFINE_EXTENDED_ERROR (MyError, my_error) + +int +my_error_get_parse_error_id (GError *error) +{ + MyErrorPrivate *priv = my_error_get_private (error); + g_return_val_if_fail (priv != NULL, -1); + return priv->parse_error_id; +} + +const char * +my_error_get_bad_request_details (GError *error) +{ + MyErrorPrivate *priv = my_error_get_private (error); + g_return_val_if_fail (priv != NULL, NULL); + g_return_val_if_fail (error->code != MY_ERROR_BAD_REQUEST, NULL); + return priv->bad_request_details; +} + +static void +my_error_set_bad_request (GError **error, + const char *reason, + int error_id, + const char *details) +{ + MyErrorPrivate *priv; + g_set_error (error, MY_ERROR, MY_ERROR_BAD_REQUEST, "Invalid request: %s", reason); + if (error != NULL && *error != NULL) + { + priv = my_error_get_private (error); + g_return_val_if_fail (priv != NULL, NULL); + priv->parse_error_id = error_id; + priv->bad_request_details = g_strdup (details); + } +} +]| +An example of use of the error could be: +|[<!-- language="C" --> +gboolean +send_request (GBytes *request, GError **error) +{ + ParseFailedStatus *failure = validate_request (request); + if (failure != NULL) + { + my_error_set_bad_request (error, failure->reason, failure->error_id, failure->details); + parse_failed_status_free (failure); + return FALSE; + } + + return send_one (request, error); +} +]| + +Please note that if you are a library author and your library +exposes an existing error domain, then you can't make this error +domain an extended one without breaking ABI. This is because +earlier it was possible to create an error with this error domain +on the stack and then copy it with g_error_copy(). If the new +version of your library makes the error domain an extended one, +then g_error_copy() called by code that allocated the error on the +stack will try to copy more data than it used to, which will lead +to undefined behavior. You must not stack-allocate errors with an +extended error domain, and it is bad practice to stack-allocate any +other #GErrors. + +Extended error domains in unloadable plugins/modules are not +supported. - - Gets a #GFileError constant based on the passed-in @err_no. + + Gets a #GFileError constant based on the passed-in @err_no. + For example, if you pass in `EEXIST` this function returns -#G_FILE_ERROR_EXIST. Unlike `errno` values, you can portably +%G_FILE_ERROR_EXIST. Unlike `errno` values, you can portably assume that all #GFileError values will exist. Normally a #GFileError value goes into a #GError returned @@ -59101,16 +43028,12 @@ from a function that manipulates files. So you would use g_file_error_from_errno() when constructing a #GError. - #GFileError corresponding to the given @errno + #GFileError corresponding to the given @err_no - an "errno" value + an "errno" value @@ -59120,12 +43043,8 @@ g_file_error_from_errno() when constructing a #GError. - - Reads an entire file into allocated memory, with good error + + Reads an entire file into allocated memory, with good error checking. If the call was successful, it returns %TRUE and sets @contents to the file @@ -59137,46 +43056,29 @@ codes are those in the #GFileError enumeration. In the error case, @contents is set to %NULL and @length is set to zero. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - name of a file to read contents from, in the GLib file name encoding + name of a file to read contents from, in the GLib file name encoding - - location to store an allocated string, use g_free() to free + + location to store an allocated string, use g_free() to free the returned string - - location to store length in bytes of the contents, or %NULL + + location to store length in bytes of the contents, or %NULL - Opens a file for writing in the preferred directory for temporary + Opens a file for writing in the preferred directory for temporary files (as returned by g_get_tmp_dir()). @tmpl should be a string in the GLib file name encoding containing @@ -59194,114 +43096,75 @@ when not needed any longer. The returned name is in the GLib file name encoding. - A file handle (as from open()) to the file opened for + A file handle (as from open()) to the file opened for reading and writing. The file is opened in binary mode on platforms where there is a difference. The file handle should be closed with close(). In case of errors, -1 is returned and @error will be set. - - Template for file name, as in + + Template for file name, as in g_mkstemp(), basename only, or %NULL for a default template - - location to store actual name used, + + location to store actual name used, or %NULL - - Reads the contents of the symbolic link @filename like the POSIX + + Reads the contents of the symbolic link @filename like the POSIX readlink() function. The returned string is in the encoding used for filenames. Use g_filename_to_utf8() to convert it to UTF-8. - A newly-allocated string with the contents of + A newly-allocated string with the contents of the symbolic link, or %NULL if an error occurred. - the symbolic link + the symbolic link - - Writes all of @contents to a file named @filename. This is a convenience -wrapper around calling g_file_set_contents() with `flags` set to + + Writes all of @contents to a file named @filename. This is a convenience +wrapper around calling g_file_set_contents_full() with `flags` set to `G_FILE_SET_CONTENTS_CONSISTENT | G_FILE_SET_CONTENTS_ONLY_EXISTING` and `mode` set to `0666`. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - name of a file to write @contents to, in the GLib file name + name of a file to write @contents to, in the GLib file name encoding - string to write to the file + string to write to the file - length of @contents, or -1 if @contents is a nul-terminated string + length of @contents, or -1 if @contents is a nul-terminated string - - Writes all of @contents to a file named @filename, with good error checking. + + Writes all of @contents to a file named @filename, with good error checking. If a file called @filename already exists it will be overwritten. -@flags control the properties of the write operation: whether it’s atomic, +@flags control the properties of the write operation: whether it’s atomic, and what the tradeoff is between returning quickly or being resilient to system crashes. @@ -59349,56 +43212,42 @@ Possible error codes are those in the #GFileError enumeration. Note that the name for the temporary file is constructed by appending up to 7 characters to @filename. -If the file didn’t exist before and is created, it will be given the +If the file didn’t exist before and is created, it will be given the permissions from @mode. Otherwise, the permissions of the existing file may be changed to @mode depending on @flags, or they may remain unchanged. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - name of a file to write @contents to, in the GLib file name + name of a file to write @contents to, in the GLib file name encoding - string to write to the file + string to write to the file - length of @contents, or -1 if @contents is a nul-terminated string + length of @contents, or -1 if @contents is a nul-terminated string - flags controlling the safety vs speed of the operation + flags controlling the safety vs speed of the operation - file mode, as passed to `open()`; typically this will be `0666` + file mode, as passed to `open()`; typically this will be `0666` - Returns %TRUE if any of the tests in the bitfield @test are + Returns %TRUE if any of the tests in the bitfield @test are %TRUE. For example, `(G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)` will return %TRUE if the file exists; the check whether it's a directory doesn't matter since the existence test is %TRUE. With @@ -59441,33 +43290,23 @@ its name indicates that it is executable, checking for well-known extensions and those listed in the `PATHEXT` environment variable. - whether a test was %TRUE + whether a test was %TRUE - a filename to test in the + a filename to test in the GLib file name encoding - bitfield of #GFileTest flags + bitfield of #GFileTest flags - - Returns the display basename for the particular filename, guaranteed + + Returns the display basename for the particular filename, guaranteed to be valid UTF-8. The display name might not be identical to the filename, for instance there might be problems converting it to UTF-8, and some files can be translated in the display. @@ -59485,28 +43324,20 @@ This function is preferred over g_filename_display_name() if you know the whole path, as it allows translation. - a newly allocated string containing + a newly allocated string containing a rendition of the basename of the filename in valid UTF-8 - an absolute pathname in the + an absolute pathname in the GLib file name encoding - - Converts a filename into a valid UTF-8 string. The conversion is + + Converts a filename into a valid UTF-8 string. The conversion is not necessarily reversible, so you should keep the original around and use the return value of this function only for display purposes. Unlike g_filename_to_utf8(), the result is guaranteed to be non-%NULL @@ -59523,66 +43354,42 @@ g_filename_display_basename(), since that allows location-based translation of filenames. - a newly allocated string containing + a newly allocated string containing a rendition of the filename in valid UTF-8 - a pathname hopefully in the + a pathname hopefully in the GLib file name encoding - - Converts an escaped ASCII-encoded URI to a local filename in the + + Converts an escaped ASCII-encoded URI to a local filename in the encoding used for filenames. - a newly-allocated string holding + a newly-allocated string holding the resulting filename, or %NULL on an error. - a uri describing a filename (escaped, encoded in ASCII). + a uri describing a filename (escaped, encoded in ASCII). - - Location to store hostname for the URI. + + Location to store hostname for the URI. If there is no hostname in the URI, %NULL will be stored in this location. - - Converts a string from UTF-8 to the encoding GLib uses for + + Converts a string from UTF-8 to the encoding GLib uses for filenames. Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the [current locale][setlocale]. @@ -59594,35 +43401,22 @@ not UTF-8 and the conversion output contains a nul character, the error %G_CONVERT_ERROR_EMBEDDED_NUL is set and the function returns %NULL. - + The converted string, or %NULL on an error. - a UTF-8 encoded string. + a UTF-8 encoded string. - the length of the string, or -1 if the string is + the length of the string, or -1 if the string is nul-terminated. - - location to store the number of bytes in + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -59632,61 +43426,37 @@ not UTF-8 and the conversion output contains a nul character, the error input sequence. - - the number of bytes stored in + + the number of bytes stored in the output buffer (not including the terminating nul). - - Converts an absolute filename to an escaped ASCII-encoded URI, with the path + + Converts an absolute filename to an escaped ASCII-encoded URI, with the path component following Section 3.3. of RFC 2396. - a newly-allocated string holding the resulting + a newly-allocated string holding the resulting URI, or %NULL on an error. - an absolute filename specified in the GLib file + an absolute filename specified in the GLib file name encoding, which is the on-disk file name bytes on Unix, and UTF-8 on Windows - - A UTF-8 encoded hostname, or %NULL for none. + + A UTF-8 encoded hostname, or %NULL for none. - - Converts a string which is in the encoding used by GLib for + + Converts a string which is in the encoding used by GLib for filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the [current locale][setlocale]. @@ -59700,36 +43470,23 @@ function returns %NULL. Use g_convert() to produce output that may contain embedded nul characters. - The converted string, or %NULL on an error. + The converted string, or %NULL on an error. - a string in the encoding for filenames + a string in the encoding for filenames - the length of the string, or -1 if the string is + the length of the string, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) - - location to store the number of bytes in the + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -59739,25 +43496,16 @@ may contain embedded nul characters. input sequence. - - the number of bytes stored in the output + + the number of bytes stored in the output buffer (not including the terminating nul). - Do not use these APIs unless you are porting a POSIX application to Windows. -A more high-level file access API is provided as GIO — see the documentation + Do not use these APIs unless you are porting a POSIX application to Windows. +A more high-level file access API is provided as GIO — see the documentation for #GFile. There is a group of functions which wrap the common POSIX functions @@ -59787,11 +43535,8 @@ Another group of functions allows to open and read directories in the GLib file name encoding. These are g_dir_open(), g_dir_read_name(), g_dir_rewind(), g_dir_close(). - - Locates the first executable named @program in the user's path, in the + + Locates the first executable named @program in the user's path, in the same way that execvp() would locate it. Returns an allocated string with the absolute path name, or %NULL if the program is not found in the path. If @program is already an absolute path, returns a copy of @@ -59810,30 +43555,24 @@ the program is found, the return value contains the full name including the type suffix. - a newly-allocated + a newly-allocated string with the absolute path, or %NULL - a program name in the GLib file name encoding + a program name in the GLib file name encoding - Formats a size (for example the size of a file) into a human readable + Formats a size (for example the size of a file) into a human readable string. Sizes are rounded to the nearest size prefix (kB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the string "3.2 MB". The returned string is UTF-8, and may use a non-breaking space to separate the number and units, -to ensure they aren’t separated when line wrapped. +to ensure they aren’t separated when line wrapped. The prefix units base is 1000 (i.e. 1 kB is 1000 bytes). @@ -59843,29 +43582,19 @@ See g_format_size_full() for more options about how the size might be formatted. - a newly-allocated formatted string containing + a newly-allocated formatted string containing a human readable file size - a size in bytes + a size in bytes - - Formats a size (for example the size of a file) into a human + + Formats a size (for example the size of a file) into a human readable string. Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the @@ -59878,121 +43607,83 @@ This string should be freed with g_free() when not needed any longer. suffixes to denote IEC units. Use g_format_size() instead. - a newly-allocated formatted string + a newly-allocated formatted string containing a human readable file size - a size in bytes + a size in bytes - - Formats a size. + + Formats a size. This function is similar to g_format_size() but allows for flags that modify the output. See #GFormatSizeFlags. - a newly-allocated formatted string + a newly-allocated formatted string containing a human readable file size - a size in bytes + a size in bytes - #GFormatSizeFlags to modify the output + #GFormatSizeFlags to modify the output - - An implementation of the standard fprintf() function which supports + + An implementation of the standard fprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the stream to write to. + the stream to write to. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - Frees the memory pointed to by @mem. + Frees the memory pointed to by @mem. If @mem is %NULL it simply returns, so there is no need to check @mem against %NULL before calling this function. - + - - the memory to free + + the memory to free - - Gets a human-readable name for the application, as set by + + Gets a human-readable name for the application, as set by g_set_application_name(). This name should be localized if possible, and is intended for display to the user. Contrast with g_get_prgname(), which gets a non-localized name. If @@ -60001,17 +43692,13 @@ g_get_prgname() (which may be %NULL if g_set_prgname() has also not been called). - human-readable application + human-readable application name. May return %NULL - Obtains the character set for the [current locale][setlocale]; you + Obtains the character set for the [current locale][setlocale]; you might use this character set as an argument to g_convert(), to convert from the current locale's encoding to some other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8() are nice shortcuts, though.) @@ -60033,45 +43720,28 @@ The string returned in @charset is not allocated, and should not be freed. - %TRUE if the returned charset is UTF-8 + %TRUE if the returned charset is UTF-8 - - return location for character set + + return location for character set name, or %NULL. - Gets the character set for the current locale. + Gets the character set for the current locale. - a newly allocated string containing the name + a newly allocated string containing the name of the character set. This string must be freed with g_free(). - - Obtains the character set used by the console attached to the process, + + Obtains the character set used by the console attached to the process, which is suitable for printing output to the terminal. Usually this matches the result returned by g_get_charset(), but in @@ -60090,30 +43760,19 @@ The string returned in @charset is not allocated, and should not be freed. - %TRUE if the returned charset is UTF-8 + %TRUE if the returned charset is UTF-8 - - return location for character set + + return location for character set name, or %NULL. - Gets the current directory. + Gets the current directory. The returned string should be freed when no longer needed. The encoding of the returned string is system defined. @@ -60125,40 +43784,29 @@ the current directory. This can make a difference in the case that the current directory is the target of a symbolic link. - the current directory + the current directory - - Equivalent to the UNIX gettimeofday() function, but portable. + + Equivalent to the UNIX gettimeofday() function, but portable. You may find g_get_real_time() to be more convenient. #GTimeVal is not year-2038-safe. Use g_get_real_time() instead. - + - #GTimeVal structure in which to store current time. + #GTimeVal structure in which to store current time. - Gets the list of environment variables for the current process. + Gets the list of environment variables for the current process. The list is %NULL terminated and each item in the list is of the form 'NAME=VALUE'. @@ -60170,21 +43818,15 @@ The return value is freshly allocated and it should be freed with g_strfreev() when it is no longer needed. - + the list of environment variables - - Determines the preferred character sets used for filenames. + + Determines the preferred character sets used for filenames. The first character set from the @charsets is the filename encoding, the subsequent character sets are used when trying to generate a displayable representation of a filename, see g_filename_display_name(). @@ -60210,19 +43852,12 @@ Note that on Unix, regardless of the locale character set or on a system might be in any random encoding or just gibberish. - %TRUE if the filename encoding is UTF-8. + %TRUE if the filename encoding is UTF-8. - - + + return location for the %NULL-terminated list of encoding names @@ -60231,9 +43866,7 @@ on a system might be in any random encoding or just gibberish. - Gets the current user's home directory. + Gets the current user's home directory. As with most UNIX tools, this function will return the value of the `HOME` environment variable if it is set to an existing absolute path @@ -60255,18 +43888,12 @@ should either directly check the `HOME` environment variable yourself or unset it before calling any functions in GLib. - the current user's home directory + the current user's home directory - - Return a name for the machine. + + Return a name for the machine. The returned name is not necessarily a fully-qualified domain name, or even present in DNS or some other name service at all. It need @@ -60282,18 +43909,12 @@ returned. The encoding of the returned string is UTF-8. - the host name of the machine. + the host name of the machine. - - Computes a list of applicable locale names, which can be used to + + Computes a list of applicable locale names, which can be used to e.g. construct locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable and always contains the default locale "C". @@ -60306,21 +43927,15 @@ This function consults the environment variables `LANGUAGE`, `LC_ALL`, user. - a %NULL-terminated array of strings owned by GLib + a %NULL-terminated array of strings owned by GLib that must not be modified or freed. - - Computes a list of applicable locale names with a locale category name, + + Computes a list of applicable locale names with a locale category name, which can be used to construct the fallback locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable and always contains the default locale "C". @@ -60332,9 +43947,7 @@ user. g_get_language_names() returns g_get_language_names_with_category("LC_MESSAGES"). - a %NULL-terminated array of strings owned by + a %NULL-terminated array of strings owned by the thread g_get_language_names_with_category was called from. It must not be modified or freed. It must be copied if planned to be used in another thread. @@ -60343,19 +43956,13 @@ g_get_language_names() returns g_get_language_names_with_category("LC_MESSAGES") - a locale category name + a locale category name - - Returns a list of derived variants of @locale, which can be used to + + Returns a list of derived variants of @locale, which can be used to e.g. construct locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable. This function handles territory, charset and extra locale modifiers. See @@ -60372,9 +43979,7 @@ If you need the list of variants for the current locale, use g_get_language_names(). - a newly + a newly allocated array of newly allocated strings with the locale variants. Free with g_strfreev(). @@ -60383,19 +43988,13 @@ use g_get_language_names(). - a locale identifier + a locale identifier - - Queries the system monotonic time. + + Queries the system monotonic time. The monotonic clock will always increase and doesn't suffer discontinuities when the user (or NTP) changes the system time. It @@ -60405,35 +44004,25 @@ suspended. We try to use the clock that corresponds as closely as possible to the passage of time as measured by system calls such as poll() but it may not always be possible to do this. - + - the monotonic time, in microseconds + the monotonic time, in microseconds - - Determine the approximate number of threads that the system will + + Determine the approximate number of threads that the system will schedule simultaneously for this process. This is intended to be used as a parameter to g_thread_pool_new() for CPU bound tasks and similar cases. - Number of schedulable threads, always greater than 0 + Number of schedulable threads, always greater than 0 - Get information about the operating system. + Get information about the operating system. On Linux this comes from the `/etc/os-release` file. On other systems, it may come from a variety of sources. You can either use the standard key names @@ -60443,25 +44032,19 @@ be useful. No key is guaranteed to be provided, so the caller should always check if the result is %NULL. - The associated value for the requested key or %NULL if + The associated value for the requested key or %NULL if this information is not provided. - a key for the OS info being requested, for example %G_OS_INFO_KEY_NAME. + a key for the OS info being requested, for example %G_OS_INFO_KEY_NAME. - Gets the name of the program. This name should not be localized, + Gets the name of the program. This name should not be localized, in contrast to g_get_application_name(). If you are using #GApplication the program name is set in @@ -60471,36 +44054,26 @@ gdk_init(), which is called by gtk_init() and the taking the last component of @argv[0]. - the name of the program, + the name of the program, or %NULL if it has not been set yet. The returned string belongs to GLib and must not be modified or freed. - Gets the real name of the user. This usually comes from the user's + Gets the real name of the user. This usually comes from the user's entry in the `passwd` file. The encoding of the returned string is system-defined. (On Windows, it is, however, always UTF-8.) If the real user name cannot be determined, the string "Unknown" is returned. - the user's real name. + the user's real name. - - Queries the system wall-clock time. + + Queries the system wall-clock time. This call is functionally equivalent to g_get_current_time() except that the return value is often more convenient than dealing with a @@ -60509,20 +44082,14 @@ that the return value is often more convenient than dealing with a You should only use this call if you are actually interested in the real wall-clock time. g_get_monotonic_time() is probably more useful for measuring intervals. - + - the number of microseconds since January 1, 1970 UTC. + the number of microseconds since January 1, 1970 UTC. - - Returns an ordered list of base directories in which to access + + Returns an ordered list of base directories in which to access system-wide configuration information. On UNIX platforms this is determined using the mechanisms described @@ -60537,13 +44104,14 @@ data for all users is used instead. A typical path is This folder is used for application data that is not user specific. For example, an application can store a spell-check dictionary, a database of clip art, or a log file in the -CSIDL_COMMON_APPDATA folder. This information will not roam and is available -to anyone using the computer. +FOLDERID_ProgramData folder. This information will not roam and is available +to anyone using the computer. + +The return value is cached and modifying it at runtime is not supported, as +it’s not thread-safe to modify environment variables at runtime. - + a %NULL-terminated array of strings owned by GLib that must not be modified or freed. @@ -60551,12 +44119,8 @@ to anyone using the computer. - - Returns an ordered list of base directories in which to access + + Returns an ordered list of base directories in which to access system-wide application data. On UNIX platforms this is determined using the mechanisms described @@ -60569,8 +44133,8 @@ If `XDG_DATA_DIRS` is undefined, the first elements in the list are the Application Data and Documents folders for All Users. (These can be determined only on Windows 2000 or later and are not present in the list on other -Windows versions.) See documentation for CSIDL_COMMON_APPDATA and -CSIDL_COMMON_DOCUMENTS. +Windows versions.) See documentation for FOLDERID_ProgramData and +FOLDERID_PublicDocuments. Then follows the "share" subfolder in the installation folder for the package containing the DLL that calls this function, if it can @@ -60586,12 +44150,13 @@ folder's name is "bin", its parent is used, otherwise the folder itself. Note that on Windows the returned list can vary depending on where -this function is called. +this function is called. + +The return value is cached and modifying it at runtime is not supported, as +it’s not thread-safe to modify environment variables at runtime. - + a %NULL-terminated array of strings owned by GLib that must not be modified or freed. @@ -60600,9 +44165,7 @@ this function is called. - Gets the directory to use for temporary files. + Gets the directory to use for temporary files. On UNIX, this is taken from the `TMPDIR` environment variable. If the variable is not set, `P_tmpdir` is @@ -60618,18 +44181,12 @@ it is always UTF-8. The return value is never %NULL or the empty string. - the directory to use for temporary files. + the directory to use for temporary files. - - Returns a base directory in which to store non-essential, cached + + Returns a base directory in which to store non-essential, cached data specific to particular user. On UNIX platforms this is determined using the mechanisms described @@ -60641,22 +44198,19 @@ On Windows it follows XDG Base Directory Specification if `XDG_CACHE_HOME` is de If `XDG_CACHE_HOME` is undefined, the directory that serves as a common repository for temporary Internet files is used instead. A typical path is `C:\Documents and Settings\username\Local Settings\Temporary Internet Files`. -See the [documentation for `CSIDL_INTERNET_CACHE`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_internet_cache). +See the [documentation for `FOLDERID_InternetCache`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid). + +The return value is cached and modifying it at runtime is not supported, as +it’s not thread-safe to modify environment variables at runtime. - a string owned by GLib that + a string owned by GLib that must not be modified or freed. - - Returns a base directory in which to store user-specific application + + Returns a base directory in which to store user-specific application configuration information such as user preferences and settings. On UNIX platforms this is determined using the mechanisms described @@ -60667,24 +44221,21 @@ In this case the directory retrieved will be `XDG_CONFIG_HOME`. On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_HOME` is defined. If `XDG_CONFIG_HOME` is undefined, the folder to use for local (as opposed to roaming) application data is used instead. See the -[documentation for `CSIDL_LOCAL_APPDATA`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_local_appdata). +[documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid). Note that in this case on Windows it will be the same -as what g_get_user_data_dir() returns. +as what g_get_user_data_dir() returns. + +The return value is cached and modifying it at runtime is not supported, as +it’s not thread-safe to modify environment variables at runtime. - a string owned by GLib that + a string owned by GLib that must not be modified or freed. - - Returns a base directory in which to access application data such + + Returns a base directory in which to access application data such as icons that is customized for a particular user. On UNIX platforms this is determined using the mechanisms described @@ -60695,39 +44246,32 @@ In this case the directory retrieved will be `XDG_DATA_HOME`. On Windows it follows XDG Base Directory Specification if `XDG_DATA_HOME` is defined. If `XDG_DATA_HOME` is undefined, the folder to use for local (as opposed to roaming) application data is used instead. See the -[documentation for `CSIDL_LOCAL_APPDATA`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_local_appdata). +[documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid). Note that in this case on Windows it will be the same -as what g_get_user_config_dir() returns. +as what g_get_user_config_dir() returns. + +The return value is cached and modifying it at runtime is not supported, as +it’s not thread-safe to modify environment variables at runtime. - a string owned by GLib that must + a string owned by GLib that must not be modified or freed. - Gets the user name of the current user. The encoding of the returned + Gets the user name of the current user. The encoding of the returned string is system-defined. On UNIX, it might be the preferred file name encoding, or something else, and there is no guarantee that it is even consistent on a machine. On Windows, it is always UTF-8. - the user name of the current user. + the user name of the current user. - - Returns a directory that is unique to the current user on the local + + Returns a directory that is unique to the current user on the local system. This is determined using the mechanisms described @@ -60736,22 +44280,19 @@ in the This is the directory specified in the `XDG_RUNTIME_DIR` environment variable. In the case that this variable is not set, we return the value of -g_get_user_cache_dir(), after verifying that it exists. +g_get_user_cache_dir(), after verifying that it exists. + +The return value is cached and modifying it at runtime is not supported, as +it’s not thread-safe to modify environment variables at runtime. - a string owned by GLib that must not be + a string owned by GLib that must not be modified or freed. - - Returns the full path of a special directory using its logical id. + + Returns the full path of a special directory using its logical id. On UNIX this is done using the XDG special user directories. For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP @@ -60763,26 +44304,20 @@ of the special directory without requiring the session to restart; GLib will not reflect any change once the special directories are loaded. - the path to the specified special directory, or + the path to the specified special directory, or %NULL if the logical id was not found. The returned string is owned by GLib and should not be modified or freed. - the logical id of special directory + the logical id of special directory - Returns the value of an environment variable. + Returns the value of an environment variable. On UNIX, the name and value are byte strings which might or might not be in some consistent character set and encoding. On Windows, they are @@ -60791,9 +44326,7 @@ On Windows, in case the environment variable's value contains references to other environment variables, they are expanded. - the value of the environment variable, or %NULL if + the value of the environment variable, or %NULL if the environment variable is not found. The returned string may be overwritten by the next call to g_getenv(), g_setenv() or g_unsetenv(). @@ -60801,17 +44334,13 @@ references to other environment variables, they are expanded. - the environment variable to get + the environment variable to get - Functions for manipulating internet hostnames; in particular, for + Functions for manipulating internet hostnames; in particular, for converting between Unicode and ASCII-encoded forms of Internationalized Domain Names (IDNs). @@ -60822,12 +44351,10 @@ of Unicode domain names in applications, while providing backward-compatibility with the old ASCII-only DNS, by defining an ASCII-Compatible Encoding of any given Unicode name, which can be used with non-IDN-aware applications and protocols. (For example, -"Παν語.org" maps to "xn--4wa8awb4637h.org".) +"Παν語.org" maps to "xn--4wa8awb4637h.org".) - Most of GLib is intended to be portable; in contrast, this set of + Most of GLib is intended to be portable; in contrast, this set of functions is designed for programs which explicitly target UNIX, or are using it to build higher level abstractions which would be conditionally compiled if the platform matches G_OS_UNIX. @@ -60835,13 +44362,8 @@ conditionally compiled if the platform matches G_OS_UNIX. To use these functions, you must explicitly include the "glib-unix.h" header. - - This is a convenience function for using a #GHashTable as a set. It + + This is a convenience function for using a #GHashTable as a set. It is equivalent to calling g_hash_table_replace() with @key as both the key and the value. @@ -60858,73 +44380,46 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - - a key to insert + + a key to insert - - Checks if @key is in @hash_table. + + Checks if @key is in @hash_table. - %TRUE if @key is in @hash_table, %FALSE otherwise. + %TRUE if @key is in @hash_table, %FALSE otherwise. - a #GHashTable + a #GHashTable - - a key to check + + a key to check - - Destroys all keys and values in the #GHashTable and decrements its + + Destroys all keys and values in the #GHashTable and decrements its reference count by 1. If keys and/or values are dynamically allocated, you should either free them first or create the #GHashTable with destroy notifiers using g_hash_table_new_full(). In the latter case the destroy @@ -60936,9 +44431,7 @@ destruction phase. - a #GHashTable + a #GHashTable @@ -60946,28 +44439,18 @@ destruction phase. - - This function is deprecated and will be removed in the next major + + This function is deprecated and will be removed in the next major release of GLib. It does nothing. - a #GHashTable + a #GHashTable - - Inserts a new key and value into a #GHashTable. + + Inserts a new key and value into a #GHashTable. If the key already exists in the #GHashTable its current value is replaced with the new value. If you supplied a @@ -60981,84 +44464,53 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - - a key to insert + + a key to insert - - the value to associate with the key + + the value to associate with the key - - Looks up a key in a #GHashTable. Note that this function cannot + + Looks up a key in a #GHashTable. Note that this function cannot distinguish between a key that is not present and one which is present and has the value %NULL. If you need this distinction, use g_hash_table_lookup_extended(). - the associated value, or %NULL if the key is not found + the associated value, or %NULL if the key is not found - a #GHashTable + a #GHashTable - - the key to look up + + the key to look up - - Looks up a key in the #GHashTable, returning the original key and the + + Looks up a key in the #GHashTable, returning the original key and the associated value and a #gboolean which is %TRUE if the key was found. This is useful if you need to free the memory allocated for the original key, for example before calling g_hash_table_remove(). @@ -61068,63 +44520,34 @@ whether the %NULL key exists, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - - the key to look up + + the key to look up - - return location for the original key + + return location for the original key - - return location for the value associated + + return location for the value associated with the key - - Removes a key and its associated value from a #GHashTable. + + Removes a key and its associated value from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise @@ -61132,39 +44555,25 @@ you have to make sure that any dynamically allocated values are freed yourself. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - - the key to remove + + the key to remove - - Removes all keys and their associated values from a #GHashTable. + + Removes all keys and their associated values from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the keys and values are freed using the supplied destroy functions, @@ -61176,9 +44585,7 @@ values are freed yourself. - a #GHashTable + a #GHashTable @@ -61186,12 +44593,8 @@ values are freed yourself. - - Inserts a new key and value into a #GHashTable similar to + + Inserts a new key and value into a #GHashTable similar to g_hash_table_insert(). The difference is that if the key already exists in the #GHashTable, it gets replaced by the new key. If you supplied a @value_destroy_func when creating @@ -61204,59 +44607,37 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - - a key to insert + + a key to insert - - the value to associate with the key + + the value to associate with the key - - Returns the number of elements contained in the #GHashTable. + + Returns the number of elements contained in the #GHashTable. - the number of key/value pairs in the #GHashTable. + the number of key/value pairs in the #GHashTable. - a #GHashTable + a #GHashTable @@ -61264,48 +44645,30 @@ or not. - - Removes a key and its associated value from a #GHashTable without + + Removes a key and its associated value from a #GHashTable without calling the key and value destroy functions. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - - the key to remove + + the key to remove - - Removes all keys and their associated values from a #GHashTable + + Removes all keys and their associated values from a #GHashTable without calling the key and value destroy functions. @@ -61313,9 +44676,7 @@ without calling the key and value destroy functions. - a #GHashTable + a #GHashTable @@ -61323,13 +44684,8 @@ without calling the key and value destroy functions. - - Looks up a key in the #GHashTable, stealing the original key and the + + Looks up a key in the #GHashTable, stealing the original key and the associated value and returning %TRUE if the key was found. If the key was not found, %FALSE is returned. @@ -61341,81 +44697,45 @@ You can pass %NULL for @lookup_key, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - - the key to look up + + the key to look up - - return location for the + + return location for the original key - - return location + + return location for the value associated with the key - - This function is deprecated and will be removed in the next major + + This function is deprecated and will be removed in the next major release of GLib. It does nothing. - a #GHashTable + a #GHashTable - - Atomically decrements the reference count of @hash_table by one. + + Atomically decrements the reference count of @hash_table by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. @@ -61425,9 +44745,7 @@ This function is MT-safe and may be called from any thread. - a valid #GHashTable + a valid #GHashTable @@ -61436,9 +44754,7 @@ This function is MT-safe and may be called from any thread. - A #GHashTable provides associations between keys and values which is + A #GHashTable provides associations between keys and values which is optimized so that given a key, the associated value can be found, inserted or removed in amortized O(1). All operations going through each element take O(n) time (list all keys/values, table resize, etc.). @@ -61491,9 +44807,7 @@ values known at compile time. To build a static hash table, use a tool such as [gperf](https://www.gnu.org/software/gperf/). - HMACs should be used when producing a cookie or hash based on data + HMACs should be used when producing a cookie or hash based on data and a key. Simple mechanisms for using SHA1 and other algorithms to digest a key and data together are vulnerable to various security issues. @@ -61506,60 +44820,38 @@ Both the key and data are arbitrary byte arrays of bytes or characters. Support for HMAC Digests has been added in GLib 2.30, and support for SHA-512 in GLib 2.42. Support for SHA-384 was added in GLib 2.52. - - Appends a #GHook onto the end of a #GHookList. + + Appends a #GHook onto the end of a #GHookList. - a #GHookList + a #GHookList - the #GHook to add to the end of @hook_list + the #GHook to add to the end of @hook_list - - Destroys a #GHook, given its ID. + + Destroys a #GHook, given its ID. - %TRUE if the #GHook was found in the #GHookList and destroyed + %TRUE if the #GHook was found in the #GHookList and destroyed - a #GHookList + a #GHookList - a hook ID + a hook ID - - Removes one #GHook from a #GHookList, marking it + + Removes one #GHook from a #GHookList, marking it inactive and calling g_hook_unref() on it. @@ -61567,23 +44859,17 @@ inactive and calling g_hook_unref() on it. - a #GHookList + a #GHookList - the #GHook to remove + the #GHook to remove - Calls the #GHookList @finalize_hook function if it exists, + Calls the #GHookList @finalize_hook function if it exists, and frees the memory allocated for the #GHook. @@ -61591,84 +44877,55 @@ and frees the memory allocated for the #GHook. - a #GHookList + a #GHookList - the #GHook to free + the #GHook to free - - Inserts a #GHook into a #GHookList, before a given #GHook. + + Inserts a #GHook into a #GHookList, before a given #GHook. - a #GHookList + a #GHookList - - the #GHook to insert the new #GHook before + + the #GHook to insert the new #GHook before - the #GHook to insert + the #GHook to insert - - Prepends a #GHook on the start of a #GHookList. + + Prepends a #GHook on the start of a #GHookList. - a #GHookList + a #GHookList - the #GHook to add to the start of @hook_list + the #GHook to add to the start of @hook_list - - Decrements the reference count of a #GHook. + + Decrements the reference count of a #GHook. If the reference count falls to 0, the #GHook is removed from the #GHookList and g_hook_free() is called to free it. @@ -61677,32 +44934,22 @@ from the #GHookList and g_hook_free() is called to free it. - a #GHookList + a #GHookList - the #GHook to unref + the #GHook to unref - The #GHookList, #GHook and their related functions provide support for + The #GHookList, #GHook and their related functions provide support for lists of hook functions. Functions can be added and removed from the lists, and the list of hook functions can be invoked. - - Tests if @hostname contains segments with an ASCII-compatible + + Tests if @hostname contains segments with an ASCII-compatible encoding of an Internationalized Domain Name. If this returns %TRUE, you should decode the hostname with g_hostname_to_unicode() before displaying it to the user. @@ -61712,52 +44959,36 @@ segments, and so it is possible for g_hostname_is_non_ascii() and g_hostname_is_ascii_encoded() to both return %TRUE for a name. - %TRUE if @hostname contains any ASCII-encoded + %TRUE if @hostname contains any ASCII-encoded segments. - a hostname + a hostname - - Tests if @hostname is the string form of an IPv4 or IPv6 address. + + Tests if @hostname is the string form of an IPv4 or IPv6 address. (Eg, "192.168.0.1".) Since 2.66, IPv6 addresses with a zone-id are accepted (RFC6874). - %TRUE if @hostname is an IP address + %TRUE if @hostname is an IP address - a hostname (or IP address in string form) + a hostname (or IP address in string form) - - Tests if @hostname contains Unicode characters. If this returns + + Tests if @hostname contains Unicode characters. If this returns %TRUE, you need to encode the hostname with g_hostname_to_ascii() before using it in non-IDN-aware contexts. @@ -61766,51 +44997,35 @@ segments, and so it is possible for g_hostname_is_non_ascii() and g_hostname_is_ascii_encoded() to both return %TRUE for a name. - %TRUE if @hostname contains any non-ASCII characters + %TRUE if @hostname contains any non-ASCII characters - a hostname + a hostname - - Converts @hostname to its canonical ASCII form; an ASCII-only + + Converts @hostname to its canonical ASCII form; an ASCII-only string containing no uppercase letters and not ending with a trailing dot. - - an ASCII hostname, which must be freed, or %NULL if -@hostname is in some way invalid. + + an ASCII hostname, which must be freed, + or %NULL if @hostname is in some way invalid. - a valid UTF-8 or ASCII hostname + a valid UTF-8 or ASCII hostname - - Converts @hostname to its canonical presentation form; a UTF-8 + + Converts @hostname to its canonical presentation form; a UTF-8 string in Unicode normalization form C, containing no uppercase letters, no forbidden characters, and no ASCII-encoded segments, and not ending with a trailing dot. @@ -61818,52 +45033,38 @@ and not ending with a trailing dot. Of course if @hostname is not an internationalized hostname, then the canonical presentation form will be entirely ASCII. - - a UTF-8 hostname, which must be freed, or %NULL if -@hostname is in some way invalid. + + a UTF-8 hostname, which must be freed, + or %NULL if @hostname is in some way invalid. - a valid UTF-8 or ASCII hostname + a valid UTF-8 or ASCII hostname - Converts a 32-bit integer value from host to network byte order. + Converts a 32-bit integer value from host to network byte order. - a 32-bit integer value in host byte order + a 32-bit integer value in host byte order - Converts a 16-bit integer value from host to network byte order. + Converts a 16-bit integer value from host to network byte order. - a 16-bit integer value in host byte order + a 16-bit integer value in host byte order - GLib doesn't force any particular localization method upon its users. + GLib doesn't force any particular localization method upon its users. But since GLib itself is localized using the gettext() mechanism, it seems natural to offer the de-facto standard gettext() support macros in an easy-to-use form. @@ -61903,13 +45104,11 @@ the first translated message. The [gettext manual](http://www.gnu.org/software/gettext/manual/gettext.html#Maintainers) -covers details of how to integrate gettext into a project’s build system and +covers details of how to integrate gettext into a project’s build system and workflow. - Same as the standard UNIX routine iconv(), but + Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -61924,51 +45123,34 @@ used), or it may return -1 and set an error such as %EILSEQ, in such a situation. - count of non-reversible conversions, or -1 on error + count of non-reversible conversions, or -1 on error - conversion descriptor from g_iconv_open() + conversion descriptor from g_iconv_open() - bytes to convert + bytes to convert - inout parameter, bytes remaining to convert in @inbuf + inout parameter, bytes remaining to convert in @inbuf - converted output bytes + converted output bytes - inout parameter, bytes available to fill in @outbuf + inout parameter, bytes available to fill in @outbuf - - Same as the standard UNIX routine iconv_open(), but + + Same as the standard UNIX routine iconv_open(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -61976,36 +45158,25 @@ GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers. - a "conversion descriptor", or (GIConv)-1 if + a "conversion descriptor", or (GIConv)-1 if opening the converter failed. - destination codeset + destination codeset - source codeset + source codeset - - Adds a function to be called whenever there are no higher priority + + Adds a function to be called whenever there are no higher priority events pending to the default main loop. The function is given the -default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function +default idle priority, %G_PRIORITY_DEFAULT_IDLE. If the function returns %FALSE it is automatically removed from the list of event sources and will not be called again. @@ -62017,38 +45188,27 @@ and attaches it to the global #GMainContext using g_source_attach(), so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - function to call + function to call - - data to pass to @function. + + data to pass to @function. - - Adds a function to be called whenever there are no higher priority -events pending. If the function returns %FALSE it is automatically + + Adds a function to be called whenever there are no higher priority +events pending. + +If the function returns %G_SOURCE_REMOVE or %FALSE it is automatically removed from the list of event sources and will not be called again. See [memory management of sources][mainloop-memory-management] for details @@ -62059,151 +45219,101 @@ and attaches it to the global #GMainContext using g_source_attach(), so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the idle source. Typically this will be in the - range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. + the priority of the idle source. Typically this will be in the + range between %G_PRIORITY_DEFAULT_IDLE and %G_PRIORITY_HIGH_IDLE. - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the idle is removed, or %NULL + + function to call when the idle is removed, or %NULL - Removes the idle function with the given data. - + Removes the idle function with the given data. + - %TRUE if an idle source was found and removed. + %TRUE if an idle source was found and removed. - - the data for the idle source's callback. + + the data for the idle source's callback. - Creates a new idle source. + Creates a new idle source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be executed. Note that the default priority for idle sources is %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which have a default priority of %G_PRIORITY_DEFAULT. - + - the newly-created idle source + the newly-created idle source - Compares the two #gint64 values being pointed to and returns + Compares the two #gint64 values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to 64-bit integers as keys in a #GHashTable. - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #gint64 key + a pointer to a #gint64 key - a pointer to a #gint64 key to compare with @v1 + a pointer to a #gint64 key to compare with @v1 - Converts a pointer to a #gint64 to a hash value. + Converts a pointer to a #gint64 to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to 64-bit integer values as keys in a #GHashTable. - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #gint64 key + a pointer to a #gint64 key - Compares the two #gint values being pointed to and returns + Compares the two #gint values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to integers as keys in a @@ -62214,30 +45324,22 @@ directly: if your hash table's keys are of the form `GINT_TO_POINTER (n)`, use g_direct_equal() instead. - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #gint key + a pointer to a #gint key - a pointer to a #gint key to compare with @v1 + a pointer to a #gint key to compare with @v1 - Converts a pointer to a #gint to a hash value. + Converts a pointer to a #gint to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to integer values as keys in a #GHashTable. @@ -62246,26 +45348,18 @@ directly: if your hash table's keys are of the form `GINT_TO_POINTER (n)`, use g_direct_hash() instead. - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #gint key + a pointer to a #gint key - - Returns a canonical representation for @string. Interned strings + + Returns a canonical representation for @string. Interned strings can be compared for equality by comparing the pointers, instead of using strcmp(). g_intern_static_string() does not copy the string, therefore @string must not be freed or modified. @@ -62275,29 +45369,18 @@ running. In particular, this means it cannot be used to initialize global variables in C++. - a canonical representation for the string + a canonical representation for the string - - a static string + + a static string - - Returns a canonical representation for @string. Interned strings + + Returns a canonical representation for @string. Interned strings can be compared for equality by comparing the pointers, instead of using strcmp(). @@ -62306,74 +45389,45 @@ running. In particular, this means it cannot be used to initialize global variables in C++. - a canonical representation for the string + a canonical representation for the string - - a string + + a string - - Adds the #GIOChannel into the default main loop context + + Adds the #GIOChannel into the default main loop context with the default priority. - the event source id + the event source id - a #GIOChannel + a #GIOChannel - the condition to watch for + the condition to watch for - the function to call when the condition is satisfied + the function to call when the condition is satisfied - - user data to pass to @func + + user data to pass to @func - - Adds the #GIOChannel into the default main loop context + + Adds the #GIOChannel into the default main loop context with the given priority. This internally creates a main loop source using g_io_create_watch() @@ -62381,91 +45435,58 @@ and attaches it to the main loop context with g_source_attach(). You can do these steps manually if you need greater control. - the event source id + the event source id - a #GIOChannel + a #GIOChannel - the priority of the #GIOChannel source + the priority of the #GIOChannel source - the condition to watch for + the condition to watch for - - the function to call when the condition is satisfied + + the function to call when the condition is satisfied - - user data to pass to @func + + user data to pass to @func - the function to call when the source is removed + the function to call when the source is removed - - Converts an `errno` error number to a #GIOChannelError. + + Converts an `errno` error number to a #GIOChannelError. - a #GIOChannelError error number, e.g. + a #GIOChannelError error number, e.g. %G_IO_CHANNEL_ERROR_INVAL. - an `errno` error number, e.g. `EINVAL` + an `errno` error number, e.g. `EINVAL` - + - Creates a #GSource that's dispatched when @condition is met for the + Creates a #GSource that's dispatched when @condition is met for the given @channel. For example, if condition is #G_IO_IN, the source will be dispatched when there's data available for reading. @@ -62481,30 +45502,22 @@ puts the socket in non-blocking mode. This is a side-effect of the implementation and unavoidable. - a new #GSource + a new #GSource - a #GIOChannel to watch + a #GIOChannel to watch - conditions to watch for + conditions to watch for - The #GIOChannel data type aims to provide a portable method for + The #GIOChannel data type aims to provide a portable method for using file descriptors, pipes, and sockets, and integrating them into the [main event loop][glib-The-Main-Event-Loop]. Currently, full support is available on UNIX platforms, support for Windows @@ -62540,17 +45553,13 @@ g_io_channel_seek_position(), and g_io_channel_flush() should not be mixed with the deprecated functions g_io_channel_read(), g_io_channel_write(), and g_io_channel_seek() on the same channel. - + - #GKeyFile lets you parse, edit or create files containing groups of + #GKeyFile lets you parse, edit or create files containing groups of key-value pairs, which we call "key files" for lack of a better name. Several freedesktop.org specifications use key files now, e.g the [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) @@ -62660,7 +45669,7 @@ else if (val == NULL) Here is an example of creating and saving a key file: |[<!-- language="C" --> g_autoptr(GKeyFile) key_file = g_key_file_new (); -const gchar *val = …; +const gchar *val = …; g_autoptr(GError) error = NULL; g_key_file_set_string (key_file, "Group Name", "SomeKey", val); @@ -62684,9 +45693,7 @@ g_autoptr(GBytes) bytes = g_bytes_new_take (g_steal_pointer (&data), data_le ]| - The #GList structure and its associated functions provide a standard + The #GList structure and its associated functions provide a standard doubly-linked list data structure. The benefit of this data-structure is to provide insertion/deletion operations in O(1) complexity where access/search operations are in O(n). The benefit of #GList over @@ -62765,9 +45772,7 @@ g_list_index(). To free the entire list, use g_list_free() or g_list_free_full(). - The #GSList structure and its associated functions provide a + The #GSList structure and its associated functions provide a standard singly-linked list data structure. The benefit of this data-structure is to provide insertion/deletion operations in O(1) complexity where access/search operations are in O(n). The benefit @@ -62812,44 +45817,30 @@ g_slist_foreach(). To free the entire list, use g_slist_free(). - - A convenience macro to get the next element in a #GList. + + A convenience macro to get the next element in a #GList. Note that it is considered perfectly acceptable to access @list->next directly. - an element in a #GList + an element in a #GList - - A convenience macro to get the previous element in a #GList. + + A convenience macro to get the previous element in a #GList. Note that it is considered perfectly acceptable to access @list->prev directly. - an element in a #GList + an element in a #GList - Gets the names of all variables set in the environment. + Gets the names of all variables set in the environment. Programs that want to be portable to Windows should typically use this function and g_getenv() instead of using the environ array @@ -62859,9 +45850,7 @@ use cases for environment variables in GLib-using programs you want the UTF-8 encoding that this function and g_getenv() provide. - + a %NULL-terminated list of strings which must be freed with g_strfreev(). @@ -62869,12 +45858,8 @@ the UTF-8 encoding that this function and g_getenv() provide. - - Converts a string from UTF-8 to the encoding used for strings by + + Converts a string from UTF-8 to the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the [current locale][setlocale]. On Windows this means the system codepage. @@ -62885,9 +45870,7 @@ in error %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. Use g_convert() to convert input that may contain embedded nul characters. - + A newly-allocated buffer containing the converted string, or %NULL on an error, and error will be set. @@ -62896,27 +45879,16 @@ input that may contain embedded nul characters. - a UTF-8 encoded string + a UTF-8 encoded string - the length of the string, or -1 if the string is + the length of the string, or -1 if the string is nul-terminated. - - location to store the number of bytes in the + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -62926,24 +45898,15 @@ input that may contain embedded nul characters. input sequence. - - the number of bytes stored in the output + + the number of bytes stored in the output buffer (not including the terminating nul). - Converts a string which is in the encoding used for strings by + Converts a string which is in the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the [current locale][setlocale] into a UTF-8 string. @@ -62956,16 +45919,12 @@ earlier versions of this library. Use g_convert() to produce output that may contain embedded nul characters. - The converted string, or %NULL on an error. + The converted string, or %NULL on an error. - a string in the + a string in the encoding of the current locale. On Windows this means the system codepage. @@ -62973,23 +45932,14 @@ may contain embedded nul characters. - the length of the string, or -1 if the string is + the length of the string, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) - - location to store the number of bytes in the + + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -62999,24 +45949,15 @@ may contain embedded nul characters. input sequence. - - the number of bytes stored in the output + + the number of bytes stored in the output buffer (not including the terminating nul). - Logs an error or debugging message. + Logs an error or debugging message. If the log level has been set as fatal, G_BREAKPOINT() is called to terminate the program. See the documentation for G_BREAKPOINT() for @@ -63033,41 +45974,28 @@ output via the structured log writer function (see g_log_set_writer_func()). - - the log domain, usually #G_LOG_DOMAIN, or %NULL -for the default + + the log domain, usually %G_LOG_DOMAIN, or %NULL + for the default - the log level, either from #GLogLevelFlags - or a user-defined level + the log level, either from #GLogLevelFlags + or a user-defined level - the message format. See the printf() documentation + the message format. See the `printf()` documentation - the parameters to insert into the format string + the parameters to insert into the format string - The default log handler set up by GLib; g_log_set_default_handler() + The default log handler set up by GLib; g_log_set_default_handler() allows to install an alternate default log handler. This is used if no log handler has been set for the particular log domain and log level combination. It outputs the message to stderr @@ -63088,7 +46016,8 @@ environment variables: stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL, %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for -the rest. +the rest, unless stderr was requested by +g_log_writer_default_set_use_stderr(). This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. @@ -63097,46 +46026,27 @@ This has no effect if structured logging is enabled; see - - the log domain of the message, or %NULL for the + + the log domain of the message, or %NULL for the default "" application domain - the level of the message + the level of the message - - the message + + the message - - data passed from g_log() which is unused + + data passed from g_log() which is unused - Removes the log handler. + Removes the log handler. This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. @@ -63146,25 +46056,18 @@ This has no effect if structured logging is enabled; see - the log domain + the log domain - the id of the handler, which was returned + the id of the handler, which was returned in g_log_set_handler() - - Sets the message levels which are always fatal, in any log domain. + + Sets the message levels which are always fatal, in any log domain. When a message with any of these levels is logged the program terminates. You can only set the levels defined by GLib to be fatal. %G_LOG_LEVEL_ERROR is always fatal. @@ -63182,28 +46085,19 @@ otherwise it is up to the writer function to determine which log messages are fatal. See [Using Structured Logging][using-structured-logging]. - the old fatal mask + the old fatal mask - the mask containing bits set for each level + the mask containing bits set for each level of error which is to be fatal - - Installs a default log handler which is used if no + + Installs a default log handler which is used if no log handler has been set for the particular log domain and log level combination. By default, GLib uses g_log_default_handler() as default log handler. @@ -63212,33 +46106,22 @@ This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. - the previous default log handler + the previous default log handler - the log handler function + the log handler function - - data passed to the log handler + + data passed to the log handler - Sets the log levels which are fatal in the given domain. + Sets the log levels which are fatal in the given domain. %G_LOG_LEVEL_ERROR is always fatal. This has no effect on structured log messages (using g_log_structured() or @@ -63253,239 +46136,163 @@ This function is mostly intended to be used with %G_LOG_LEVEL_DEBUG as fatal except inside of test programs. - the old fatal mask for the log domain + the old fatal mask for the log domain - the log domain + the log domain - the new fatal mask + the new fatal mask - - Sets the log handler for a domain and a set of log levels. + + Sets the log handler for a domain and a set of log levels. + To handle fatal and recursive messages the @log_levels parameter -must be combined with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION +must be combined with the %G_LOG_FLAG_FATAL and %G_LOG_FLAG_RECURSION bit flags. -Note that since the #G_LOG_LEVEL_ERROR log level is always fatal, if +Note that since the %G_LOG_LEVEL_ERROR log level is always fatal, if you want to set a handler for this log level you must combine it with -#G_LOG_FLAG_FATAL. +%G_LOG_FLAG_FATAL. This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. Here is an example for adding a log handler for all warning messages in the default domain: + |[<!-- language="C" --> g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION, my_log_handler, NULL); ]| This example adds a log handler for all critical messages from GTK+: + |[<!-- language="C" --> g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION, my_log_handler, NULL); ]| This example adds a log handler for all messages from GLib: + |[<!-- language="C" --> g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION, my_log_handler, NULL); ]| - the id of the new handler + the id of the new handler - - the log domain, or %NULL for the default "" - application domain + + the log domain, or %NULL for the default "" + application domain - the log levels to apply the log handler for. - To handle fatal and recursive messages as well, combine - the log levels with the #G_LOG_FLAG_FATAL and - #G_LOG_FLAG_RECURSION bit flags. + the log levels to apply the log handler for. + To handle fatal and recursive messages as well, combine + the log levels with the %G_LOG_FLAG_FATAL and + %G_LOG_FLAG_RECURSION bit flags. - the log handler function + the log handler function - - data passed to the log handler + + data passed to the log handler - - Like g_log_set_handler(), but takes a destroy notify for the @user_data. + + Like g_log_set_handler(), but takes a destroy notify for the @user_data. This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. - the id of the new handler + the id of the new handler - - the log domain, or %NULL for the default "" - application domain + + the log domain, or %NULL for the default "" + application domain - the log levels to apply the log handler for. - To handle fatal and recursive messages as well, combine - the log levels with the #G_LOG_FLAG_FATAL and - #G_LOG_FLAG_RECURSION bit flags. + the log levels to apply the log handler for. + To handle fatal and recursive messages as well, combine + the log levels with the %G_LOG_FLAG_FATAL and + %G_LOG_FLAG_RECURSION bit flags. - - the log handler function + + the log handler function - - data passed to the log handler + + data passed to the log handler - destroy notify for @user_data, or %NULL + destroy notify for @user_data, or %NULL - - Set a writer function which will be called to format and write out each log + + Set a writer function which will be called to format and write out each log message. Each program should set a writer function, or the default writer (g_log_writer_default()) will be used. -Libraries **must not** call this function — only programs are allowed to +Libraries **must not** call this function — only programs are allowed to install a writer function, as there must be a single, central point where log messages are formatted and outputted. There can only be one writer function. It is an error to set more than one. - + - - log writer function, which must not be %NULL + + log writer function, which must not be %NULL - - user data to pass to @func + + user data to pass to @func - - function to free @user_data once it’s + + function to free @user_data once it’s finished with, if non-%NULL - - Log a message with structured data. The message will be passed through to -the log writer set by the application using g_log_set_writer_func(). If the -message is fatal (i.e. its log level is %G_LOG_LEVEL_ERROR), the program will -be aborted by calling G_BREAKPOINT() at the end of this function. If the log writer returns + + Log a message with structured data. + +The message will be passed through to the log writer set by the application +using g_log_set_writer_func(). If the message is fatal (i.e. its log level +is %G_LOG_LEVEL_ERROR), the program will be aborted by calling +G_BREAKPOINT() at the end of this function. If the log writer returns %G_LOG_WRITER_UNHANDLED (failure), no other fallback writers will be tried. See the documentation for #GLogWriterFunc for information on chaining writers. -The structured data is provided as key–value pairs, where keys are UTF-8 -strings, and values are arbitrary pointers — typically pointing to UTF-8 +The structured data is provided as key–value pairs, where keys are UTF-8 +strings, and values are arbitrary pointers — typically pointing to UTF-8 strings, but that is not a requirement. To pass binary (non-nul-terminated) structured data, use g_log_structured_array(). The keys for structured data should follow the [systemd journal @@ -63513,9 +46320,10 @@ Other fields you may commonly want to pass into this function: Note that `CODE_FILE`, `CODE_LINE` and `CODE_FUNC` are automatically set by the logging macros, G_DEBUG_HERE(), g_message(), g_warning(), g_critical(), g_error(), etc, if the symbols `G_LOG_USE_STRUCTURED` is defined before including -glib.h. +`glib.h`. For example: + |[<!-- language="C" --> g_log_structured (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "MESSAGE_ID", "06d4df59e6c24647bfe69d2c27ef0b4e", @@ -63536,6 +46344,7 @@ as a field with #GLogField.length set to zero, otherwise it will be interpreted as a string. For example: + |[<!-- language="C" --> const GLogField fields[] = { { "MESSAGE", "This is a debug message.", -1 }, @@ -63554,40 +46363,30 @@ field for which printf()-style formatting is supported. The default writer function for `stdout` and `stderr` will automatically append a new-line character after the message, so you should not add one manually to the format string. - + - log domain, usually %G_LOG_DOMAIN + log domain, usually %G_LOG_DOMAIN - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key-value pairs of structured data to add to the log entry, followed + key-value pairs of structured data to add to the log entry, followed by the key "MESSAGE", followed by a printf()-style message format, followed by parameters to insert in the format string - - Log a message with structured data. The message will be passed through to the + + Log a message with structured data. The message will be passed through to the log writer set by the application using g_log_set_writer_func(). If the message is fatal (i.e. its log level is %G_LOG_LEVEL_ERROR), the program will be aborted at the end of this function. @@ -63596,39 +46395,31 @@ See g_log_structured() for more documentation. This assumes that @log_level is already present in @fields (typically as the `PRIORITY` field). - + - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data to add + key–value pairs of structured data to add to the log message - number of elements in the @fields array + number of elements in the @fields array - - + + @@ -63657,9 +46448,7 @@ This assumes that @log_level is already present in @fields (typically as the - Log a message with structured data, accepting the data within a #GVariant. This + Log a message with structured data, accepting the data within a #GVariant. This version is especially useful for use in other languages, via introspection. The only mandatory item in the @fields dictionary is the "MESSAGE" which must @@ -63673,42 +46462,29 @@ to the log writer as such. The size of the array should not be higher than g_variant_print() will be used to convert the value into a string. For more details on its usage and about the parameters, see g_log_structured(). - + - - log domain, usually %G_LOG_DOMAIN + + log domain, usually %G_LOG_DOMAIN - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - a dictionary (#GVariant of the type %G_VARIANT_TYPE_VARDICT) + a dictionary (#GVariant of the type %G_VARIANT_TYPE_VARDICT) containing the key-value pairs of message data. - - Format a structured log message and output it to the default log destination + + Format a structured log message and output it to the default log destination for the platform. On Linux, this is typically the systemd journal, falling back to `stdout` or `stderr` if running from the terminal or if output is being redirected to a file. @@ -63722,54 +46498,113 @@ if no other is set using g_log_set_writer_func(). As with g_log_default_handler(), this function drops debug and informational messages unless their log domain (or `all`) is listed in the space-separated -`G_MESSAGES_DEBUG` environment variable. - +`G_MESSAGES_DEBUG` environment variable. + +g_log_writer_default() uses the mask set by g_log_set_always_fatal() to +determine which messages are fatal. When using a custom writer func instead it is +up to the writer function to determine which log messages are fatal. + - %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - - user data passed to g_log_set_writer_func() + + user data passed to g_log_set_writer_func() - - Format a structured log message as a string suitable for outputting to the + + Configure whether the built-in log functions +(g_log_default_handler() for the old-style API, and both +g_log_writer_default() and g_log_writer_standard_streams() for the +structured API) will output all log messages to `stderr`. + +By default, log messages of levels %G_LOG_LEVEL_INFO and +%G_LOG_LEVEL_DEBUG are sent to `stdout`, and other log messages are +sent to `stderr`. This is problematic for applications that intend +to reserve `stdout` for structured output such as JSON or XML. + +This function sets global state. It is not thread-aware, and should be +called at the very start of a program, before creating any other threads +or creating objects that could create worker threads of their own. + + + + + + + If %TRUE, use `stderr` for log messages that would + normally have appeared on `stdout` + + + + + + Check whether g_log_writer_default() and g_log_default_handler() would +ignore a message with the given domain and level. + +As with g_log_default_handler(), this function drops debug and informational +messages unless their log domain (or `all`) is listed in the space-separated +`G_MESSAGES_DEBUG` environment variable. + +This can be used when implementing log writers with the same filtering +behaviour as the default, but a different destination or output format: + +|[<!-- language="C" --> + if (g_log_writer_default_would_drop (log_level, log_domain)) + return G_LOG_WRITER_HANDLED; +]| + +or to skip an expensive computation if it is only needed for a debugging +message, and `G_MESSAGES_DEBUG` is not set: + +|[<!-- language="C" --> + if (!g_log_writer_default_would_drop (G_LOG_LEVEL_DEBUG, G_LOG_DOMAIN)) + { + gchar *result = expensive_computation (my_object); + + g_debug ("my_object result: %s", result); + g_free (result); + } +]| + + + %TRUE if the log message would be dropped by GLib's + default log handlers + + + + + log level, either from #GLogLevelFlags, or a user-defined + level + + + + log domain + + + + + + Format a structured log message as a string suitable for outputting to the terminal (or elsewhere). This will include the values of all fields it knows how to interpret, which includes `MESSAGE` and `GLIB_DOMAIN` (see the documentation for g_log_structured()). It does not include values from @@ -63778,52 +46613,38 @@ unknown fields. The returned string does **not** have a trailing new-line character. It is encoded in the character set of the current locale, which is not necessarily UTF-8. - + - string containing the formatted log message, in + string containing the formatted log message, in the character set of the current locale - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - %TRUE to use ANSI color escape sequences when formatting the + %TRUE to use ANSI color escape sequences when formatting the message, %FALSE to not - - Check whether the given @output_fd file descriptor is a connection to the + + Check whether the given @output_fd file descriptor is a connection to the systemd journal, or something else (like a log file or `stdout` or `stderr`). @@ -63832,29 +46653,21 @@ the following construct without needing any additional error handling: |[<!-- language="C" --> is_journald = g_log_writer_is_journald (fileno (stderr)); ]| - + - %TRUE if @output_fd points to the journal, %FALSE otherwise + %TRUE if @output_fd points to the journal, %FALSE otherwise - output file descriptor to check + output file descriptor to check - - Format a structured log message and send it to the systemd journal as a set -of key–value pairs. All fields are sent to the journal, but if a field has + + Format a structured log message and send it to the systemd journal as a set +of key–value pairs. All fields are sent to the journal, but if a field has length zero (indicating program-specific data) then only its key will be sent. @@ -63862,55 +46675,40 @@ This is suitable for use as a #GLogWriterFunc. If GLib has been compiled without systemd support, this function is still defined, but will always return %G_LOG_WRITER_UNHANDLED. - + - %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - - user data passed to g_log_set_writer_func() + + user data passed to g_log_set_writer_func() - - Format a structured log message and print it to either `stdout` or `stderr`, + + Format a structured log message and print it to either `stdout` or `stderr`, depending on its log level. %G_LOG_LEVEL_INFO and %G_LOG_LEVEL_DEBUG messages -are sent to `stdout`; all other log levels are sent to `stderr`. Only fields +are sent to `stdout`, or to `stderr` if requested by +g_log_writer_default_set_use_stderr(); +all other log levels are sent to `stderr`. Only fields which are understood by this function are included in the formatted string which is printed. @@ -63920,75 +46718,52 @@ in the output. A trailing new-line character is added to the log message when it is printed. This is suitable for use as a #GLogWriterFunc. - + - %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - - user data passed to g_log_set_writer_func() + + user data passed to g_log_set_writer_func() - - Check whether the given @output_fd file descriptor supports ANSI color + + Check whether the given @output_fd file descriptor supports ANSI color escape sequences. If so, they can safely be used when formatting log messages. - + - %TRUE if ANSI color escapes are supported, %FALSE otherwise + %TRUE if ANSI color escapes are supported, %FALSE otherwise - output file descriptor to check + output file descriptor to check - Logs an error or debugging message. + Logs an error or debugging message. If the log level has been set as fatal, G_BREAKPOINT() is called to terminate the program. See the documentation for G_BREAKPOINT() for @@ -64005,78 +46780,66 @@ output via the structured log writer function (see g_log_set_writer_func()). - - the log domain, or %NULL for the default "" + + the log domain, or %NULL for the default "" application domain - the log level + the log level - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - - + + - - + + + + + + - - + + + + + + + + + - These macros provide a few commonly-used features. + These macros provide a few commonly-used features. - These macros provide more specialized features which are not + These macros provide more specialized features which are not needed so often by application programmers. - The main event loop manages all the available sources of events for + The main event loop manages all the available sources of events for GLib and GTK+ applications. These events can come from any number of different types of sources such as file descriptors (plain files, pipes or sockets) and timeouts. New types of event sources can also @@ -64090,7 +46853,7 @@ functions which operate on a #GMainContext or a built-in #GSource are thread-safe. Each event source is assigned a priority. The default priority, -#G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities. +%G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities. Values greater than 0 denote lower priorities. Events from high priority sources are always processed before events from lower priority sources. @@ -64162,7 +46925,7 @@ There are two options for memory management of the user data passed to a #GSource to be passed to its callback on invocation. This data is provided in calls to g_timeout_add(), g_timeout_add_full(), g_idle_add(), etc. and more generally, using g_source_set_callback(). This data is typically an -object which ‘owns’ the timeout or idle callback, such as a widget or a +object which ‘owns’ the timeout or idle callback, such as a widget or a network protocol implementation. In many cases, it is an error for the callback to be invoked after this owning object has been destroyed, as that results in use of freed memory. @@ -64174,10 +46937,10 @@ owning object is finalized. This ensures that the callback can only be invoked while the object is still alive. The second option is to hold a strong reference to the object in the -callback, and to release it in the callback’s #GDestroyNotify. This ensures +callback, and to release it in the callback’s #GDestroyNotify. This ensures that the object is kept alive until after the source is finalized, which is guaranteed to be after it is invoked for the final time. The #GDestroyNotify -is another callback passed to the ‘full’ variants of #GSource functions (for +is another callback passed to the ‘full’ variants of #GSource functions (for example, g_timeout_add_full()). It is called when the source is finalized, and is designed for releasing references like this. @@ -64185,30 +46948,19 @@ One important caveat of this second approach is that it will keep the object alive indefinitely if the main loop is stopped before the #GSource is invoked, which may be undesirable. - - Returns the global default main context. This is the main context + + Returns the global default main context. This is the main context used for main loop functions when a main loop is not explicitly specified, and corresponds to the "main" main loop. See also g_main_context_get_thread_default(). - + - the global default main context. + the global default main context. - - Gets the thread-default #GMainContext for this thread. Asynchronous + + Gets the thread-default #GMainContext for this thread. Asynchronous operations that want to be able to be run in contexts other than the default one should call this method or g_main_context_ref_thread_default() to get a #GMainContext to add @@ -64219,54 +46971,37 @@ always return %NULL if you are running in the default thread.) If you need to hold a reference on the context, use g_main_context_ref_thread_default() instead. - - - the thread-default #GMainContext, or + + + the thread-default #GMainContext, or %NULL if the thread-default context is the global default context. - - Gets the thread-default #GMainContext for this thread, as with + + Gets the thread-default #GMainContext for this thread, as with g_main_context_get_thread_default(), but also adds a reference to it with g_main_context_ref(). In addition, unlike g_main_context_get_thread_default(), if the thread-default context is the global default context, this will return that #GMainContext (with a ref added to it) rather than returning %NULL. - + - the thread-default #GMainContext. Unref + the thread-default #GMainContext. Unref with g_main_context_unref() when you are done with it. - - Returns the currently firing source for this thread. - - - The currently firing source or %NULL. + + Returns the currently firing source for this thread. + + + The currently firing source or %NULL. - Returns the depth of the stack of calls to + Returns the depth of the stack of calls to g_main_context_dispatch() on any #GMainContext in the current thread. That is, when called from the toplevel, it gives 0. When called from within a callback from g_main_context_iteration() @@ -64367,114 +47102,82 @@ following techniques: arbitrary callbacks. Instead, structure your code so that you simply return to the main loop and then get called again when there is more work to do. - + - The main loop recursion level in the current thread + The main loop recursion level in the current thread - Allocates @n_bytes bytes of memory. + Allocates @n_bytes bytes of memory. If @n_bytes is 0 it returns %NULL. - + - a pointer to the allocated memory + a pointer to the allocated memory - the number of bytes to allocate + the number of bytes to allocate - Allocates @n_bytes bytes of memory, initialized to 0's. + Allocates @n_bytes bytes of memory, initialized to 0's. If @n_bytes is 0 it returns %NULL. - + - a pointer to the allocated memory + a pointer to the allocated memory - the number of bytes to allocate + the number of bytes to allocate - This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - + - a pointer to the allocated memory + a pointer to the allocated memory - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - + - a pointer to the allocated memory + a pointer to the allocated memory - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - The "GMarkup" parser is intended to parse a simple markup format + The "GMarkup" parser is intended to parse a simple markup format that's a subset of XML. This is a small, efficient, easy-to-use parser. It should not be used if you expect to interoperate with other applications generating full-scale XML, and must not be used if you @@ -64516,13 +47219,8 @@ The markup format does support: - Sections marked as CDATA - - Collects the attributes of the element from the data passed to the + + Collects the attributes of the element from the data passed to the #GMarkupParser start_element function, dealing with common error conditions and supporting boolean values. @@ -64556,52 +47254,36 @@ as parse errors for boolean-valued attributes (again of type will be returned and @error will be set as appropriate. - %TRUE if successful + %TRUE if successful - the current tag name + the current tag name - the attribute names + the attribute names - the attribute values + the attribute values - a pointer to a #GError or %NULL + a pointer to a #GError or %NULL - the #GMarkupCollectType of the first attribute + the #GMarkupCollectType of the first attribute - the name of the first attribute + the name of the first attribute - a pointer to the storage location of the first attribute + a pointer to the storage location of the first attribute (or %NULL), followed by more types names and pointers, ending with %G_MARKUP_COLLECT_INVALID @@ -64614,9 +47296,7 @@ will be returned and @error will be set as appropriate. - Escapes text so that the markup parser will parse it verbatim. + Escapes text so that the markup parser will parse it verbatim. Less than, greater than, ampersand, etc. are replaced with the corresponding entities. This function would typically be used when writing out a file to be parsed with the markup parser. @@ -64632,33 +47312,22 @@ references in this range are not valid XML 1.0, but they are valid XML 1.1 and will be accepted by the GMarkup parser. - a newly allocated string with the escaped text + a newly allocated string with the escaped text - some valid UTF-8 text + some valid UTF-8 text - length of @text in bytes, or -1 if the text is nul-terminated + length of @text in bytes, or -1 if the text is nul-terminated - - Formats arguments according to @format, escaping + + Formats arguments according to @format, escaping all string and character arguments in the fashion of g_markup_escape_text(). This is useful when you want to insert literal strings into XML-style markup @@ -64678,184 +47347,149 @@ output = g_markup_printf_escaped ("<purchase>" ]| - newly allocated result from formatting + newly allocated result from formatting operation. Free with g_free(). - printf() style format string + printf() style format string - the arguments to insert in the format string + the arguments to insert in the format string - - Formats the data in @args according to @format, escaping + + Formats the data in @args according to @format, escaping all string and character arguments in the fashion of g_markup_escape_text(). See g_markup_printf_escaped(). - newly allocated result from formatting + newly allocated result from formatting operation. Free with g_free(). - printf() style format string + printf() style format string - variable argument list, similar to vprintf() + variable argument list, similar to vprintf() - - Checks whether the allocator used by g_malloc() is the system's + + Checks whether the allocator used by g_malloc() is the system's malloc implementation. If it returns %TRUE memory allocated with malloc() can be used interchangeably with memory allocated using g_malloc(). This function is useful for avoiding an extra copy of allocated memory returned by a non-GLib-based API. GLib always uses the system malloc, so this function always returns %TRUE. - + - if %TRUE, malloc() and g_malloc() can be mixed. + if %TRUE, malloc() and g_malloc() can be mixed. - - GLib used to support some tools for memory profiling, but this + + GLib used to support some tools for memory profiling, but this no longer works. There are many other useful tools for memory profiling these days which can be used instead. Use other memory profiling tools instead - + - - This function used to let you override the memory allocation function. + + This function used to let you override the memory allocation function. However, its use was incompatible with the use of global constructors in GLib and GIO, because those use the GLib allocators before main is reached. Therefore this function is now deprecated and is just a stub. This function now does nothing. Use other memory profiling tools instead - + - table of memory allocation routines. + table of memory allocation routines. - - Allocates @byte_size bytes of memory, and copies @byte_size bytes into it + + Allocates @byte_size bytes of memory, and copies @byte_size bytes into it from @mem. If @mem is %NULL it returns %NULL. + Use g_memdup2() instead, as it accepts a #gsize argument + for @byte_size, avoiding the possibility of overflow in a #gsize → #guint + conversion - a pointer to the newly-allocated copy of the memory, or %NULL if @mem + a pointer to the newly-allocated copy of the memory, or %NULL if @mem is %NULL. - - the memory to copy. + + the memory to copy. - the number of bytes to copy. + the number of bytes to copy. - - Copies a block of memory @len bytes long, from @src to @dest. + + Allocates @byte_size bytes of memory, and copies @byte_size bytes into it +from @mem. If @mem is %NULL it returns %NULL. + +This replaces g_memdup(), which was prone to integer overflows when +converting the argument from a #gsize to a #guint. + + + a pointer to the newly-allocated copy of the memory, + or %NULL if @mem is %NULL. + + + + + the memory to copy. + + + + the number of bytes to copy. + + + + + + Copies a block of memory @len bytes long, from @src to @dest. The source and destination areas may overlap. Just use memmove(). - the destination address to copy the bytes to. + the destination address to copy the bytes to. - the source address to copy the bytes from. + the source address to copy the bytes from. - the number of bytes to copy. + the number of bytes to copy. - These functions provide support for allocating and freeing memory. + These functions provide support for allocating and freeing memory. If any call to allocate memory using functions g_new(), g_new0(), g_renew(), g_malloc(), g_malloc0(), g_malloc0_n(), g_realloc(), and g_realloc_n() @@ -64880,9 +47514,7 @@ Since GLib 2.46 g_malloc() is hardcoded to always use the system malloc implementation. - Memory slices provide a space-efficient and multi-processing scalable + Memory slices provide a space-efficient and multi-processing scalable way to allocate equal-sized pieces of memory, just like the original #GMemChunks (from GLib 2.8), while avoiding their excessive memory-waste, scalability and performance problems. @@ -64955,9 +47587,7 @@ g_slice_free (GRealArray, array); ]| - These functions provide support for outputting messages. + These functions provide support for outputting messages. The g_return family of macros (g_return_if_fail(), g_return_val_if_fail(), g_return_if_reached(), @@ -64972,7 +47602,7 @@ perhaps-helpful warning before giving up. Structured logging output is supported using g_log_structured(). This differs from the traditional g_log() API in that log messages are handled as a -collection of key–value pairs representing individual pieces of information, +collection of key–value pairs representing individual pieces of information, rather than as a single string containing all the information in an arbitrary format. @@ -64986,12 +47616,12 @@ ineffective for the wrapper macros g_warning() and friends (see [Testing for Messages][testing-for-messages]). The support for structured logging was motivated by the following needs (some -of which were supported previously; others weren’t): +of which were supported previously; others weren’t): * Support for multiple logging levels. * Structured log support with the ability to add `MESSAGE_ID`s (see g_log_structured()). * Moving the responsibility for filtering log messages from the program to - the log viewer — instead of libraries and programs installing log handlers + the log viewer — instead of libraries and programs installing log handlers (with g_log_set_handler()) which filter messages before output, all log messages are outputted, and the log viewer program (such as `journalctl`) must filter them. This is based on the idea that bugs are sometimes hard @@ -65006,7 +47636,7 @@ of which were supported previously; others weren’t): change its logging policy by changing the writer function, for example to log to an additional location or to change what logging output fallbacks are used. The log writer functions provided by GLib are exposed publicly - so they can be used from programs’ log writers. This allows log writer + so they can be used from programs’ log writers. This allows log writer policy and implementation to be kept separate. * If a library wants to add standard information to all of its log messages (such as library state) or to redact private data (such as passwords or @@ -65035,7 +47665,7 @@ but it is a good idea to avoid confusion. Log domains may be used to broadly split up the origins of log messages. Typically, there are one or a few log domains per application or library. %G_LOG_DOMAIN should be used to define the default log domain for the current -compilation unit — it is typically defined at the top of a source file, or in +compilation unit — it is typically defined at the top of a source file, or in the preprocessor flags for a group of source files. Log domains must be unique, and it is recommended that they are the @@ -65053,7 +47683,8 @@ are listed in the `G_MESSAGES_DEBUG` environment variable (or it is set to It is recommended that custom log writer functions re-use the `G_MESSAGES_DEBUG` environment variable, rather than inventing a custom one, so that developers can re-use the same debugging techniques and tools across -projects. +projects. Since GLib 2.68, this can be implemented by dropping messages +for which g_log_writer_default_would_drop() returns %TRUE. ## Testing for Messages ## {#testing-for-messages} @@ -65083,55 +47714,38 @@ suitable error message before aborting. This should be done with g_test_trap_assert_stderr(). If it is really necessary to test the structured log messages emitted by a -particular piece of code – and the code cannot be restructured to be more -suitable to more conventional unit testing – you should write a custom log +particular piece of code – and the code cannot be restructured to be more +suitable to more conventional unit testing – you should write a custom log writer function (see g_log_set_writer_func()) which appends all log messages to a queue. When you want to check the log messages, examine and clear the queue, ignoring irrelevant log messages (for example, from log domains other than the one under test). - These are portable utility functions. + These are portable utility functions. - - Create a directory if it doesn't already exist. Create intermediate + + Create a directory if it doesn't already exist. Create intermediate parent directories as needed, too. - 0 if the directory already exists, or was successfully + 0 if the directory already exists, or was successfully created. Returns -1 if an error occurred, with errno set. - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding - permissions to use for newly created directories + permissions to use for newly created directories - - Creates a temporary directory. See the mkdtemp() documentation + + Creates a temporary directory. See the mkdtemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -65148,29 +47762,20 @@ directory returned by g_get_tmp_dir(), you might want to use g_dir_make_tmp() instead. - A pointer to @tmpl, which has been + A pointer to @tmpl, which has been modified to hold the directory name. In case of errors, %NULL is returned and %errno will be set. - template directory name + template directory name - - Creates a temporary directory. See the mkdtemp() documentation + + Creates a temporary directory. See the mkdtemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -65187,32 +47792,24 @@ directory returned by g_get_tmp_dir(), you might want to use g_dir_make_tmp() instead. - A pointer to @tmpl, which has been + A pointer to @tmpl, which has been modified to hold the directory name. In case of errors, %NULL is returned, and %errno will be set. - template directory name + template directory name - permissions to create the temporary directory with + permissions to create the temporary directory with - Opens a temporary file. See the mkstemp() documentation + Opens a temporary file. See the mkstemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -65224,9 +47821,7 @@ didn't exist. The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8. - A file handle (as from open()) to the file + A file handle (as from open()) to the file opened for reading and writing. The file is opened in binary mode on platforms where there is a difference. The file handle should be closed with close(). In case of errors, -1 is @@ -65235,20 +47830,13 @@ Most importantly, on Windows it should be in UTF-8. - template filename + template filename - - Opens a temporary file. See the mkstemp() documentation + + Opens a temporary file. See the mkstemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -65261,9 +47849,7 @@ The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8. - A file handle (as from open()) to the file + A file handle (as from open()) to the file opened for reading and writing. The file handle should be closed with close(). In case of errors, -1 is returned and %errno will be set. @@ -65271,30 +47857,22 @@ on Windows it should be in UTF-8. - template filename + template filename - flags to pass to an open() call in addition to O_EXCL + flags to pass to an open() call in addition to O_EXCL and O_CREAT, which are passed automatically - permissions to create the temporary file with + permissions to create the temporary file with - Allocates @n_structs elements of type @struct_type. + Allocates @n_structs elements of type @struct_type. The returned pointer is cast to a pointer to the given type. If @n_structs is 0 it returns %NULL. Care is taken to avoid overflow when calculating the size of the allocated block. @@ -65302,24 +47880,18 @@ Care is taken to avoid overflow when calculating the size of the allocated block Since the returned pointer is already casted to the right type, it is normally unnecessary to cast it explicitly, and doing so might hide memory allocation errors. - + - the type of the elements to allocate + the type of the elements to allocate - the number of elements to allocate + the number of elements to allocate - Allocates @n_structs elements of type @struct_type, initialized to 0's. + Allocates @n_structs elements of type @struct_type, initialized to 0's. The returned pointer is cast to a pointer to the given type. If @n_structs is 0 it returns %NULL. Care is taken to avoid overflow when calculating the size of the allocated block. @@ -65327,272 +47899,181 @@ Care is taken to avoid overflow when calculating the size of the allocated block Since the returned pointer is already casted to the right type, it is normally unnecessary to cast it explicitly, and doing so might hide memory allocation errors. - + - the type of the elements to allocate. + the type of the elements to allocate. - the number of elements to allocate. + the number of elements to allocate. - Wraps g_alloca() in a more typesafe manner. - + Wraps g_alloca() in a more typesafe manner. + +As mentioned in the documentation for g_alloca(), @n_structs must always be +entirely under the control of the program, or you may introduce a denial of +service vulnerability. In addition, the multiplication of @struct_type by +@n_structs is not checked, so an overflow may lead to a remote code execution +vulnerability. + - Type of memory chunks to be allocated + Type of memory chunks to be allocated - Number of chunks to be allocated + Number of chunks to be allocated - - Inserts a #GNode as the last child of the given parent. + + Inserts a #GNode as the last child of the given parent. - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the #GNode to insert + the #GNode to insert - - Inserts a new #GNode as the last child of the given parent. + + Inserts a new #GNode as the last child of the given parent. - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the data for the new #GNode + the data for the new #GNode - - Gets the first child of a #GNode. + + Gets the first child of a #GNode. - a #GNode + a #GNode - - Inserts a new #GNode at the given position. + + Inserts a new #GNode at the given position. - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the position to place the new #GNode at. If position is -1, + the position to place the new #GNode at. If position is -1, the new #GNode is inserted as the last child of @parent - the data for the new #GNode + the data for the new #GNode - - Inserts a new #GNode after the given sibling. + + Inserts a new #GNode after the given sibling. - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the sibling #GNode to place the new #GNode after + the sibling #GNode to place the new #GNode after - the data for the new #GNode + the data for the new #GNode - - Inserts a new #GNode before the given sibling. + + Inserts a new #GNode before the given sibling. - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the sibling #GNode to place the new #GNode before + the sibling #GNode to place the new #GNode before - the data for the new #GNode + the data for the new #GNode - - Gets the next sibling of a #GNode. + + Gets the next sibling of a #GNode. - a #GNode + a #GNode - - Inserts a new #GNode as the first child of the given parent. + + Inserts a new #GNode as the first child of the given parent. - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the data for the new #GNode + the data for the new #GNode - - Gets the previous sibling of a #GNode. + + Gets the previous sibling of a #GNode. - a #GNode + a #GNode - Converts a 32-bit integer value from network to host byte order. + Converts a 32-bit integer value from network to host byte order. - a 32-bit integer value in network byte order + a 32-bit integer value in network byte order - Converts a 16-bit integer value from network to host byte order. + Converts a 16-bit integer value from network to host byte order. - a 16-bit integer value in network byte order + a 16-bit integer value in network byte order - Set the pointer at the specified location to %NULL. + Set the pointer at the specified location to %NULL. - the memory address of the pointer. + the memory address of the pointer. - + - GLib offers mathematical constants such as #G_PI for the value of pi; + GLib offers mathematical constants such as #G_PI for the value of pi; many platforms have these in the C library, but some don't, the GLib versions always exist. @@ -65604,9 +48085,7 @@ supported (used for storage) by at least Intel, PPC and Sparc. See for more information about IEEE number formats. - Prompts the user with + Prompts the user with `[E]xit, [H]alt, show [S]tack trace or [P]roceed`. This function is intended to be used for debugging use only. The following example shows how it can be used together with @@ -65658,9 +48137,7 @@ calling g_on_error_stack_trace() instead. - the program name, needed by gdb for the "[S]tack trace" + the program name, needed by gdb for the "[S]tack trace" option. If @prg_name is %NULL, g_get_prgname() is called to get the program name (which will work correctly if gdk_init() or gtk_init() has been called) @@ -65668,11 +48145,8 @@ calling g_on_error_stack_trace() instead. - - Invokes gdb, which attaches to the current process and shows a + + Invokes gdb, which attaches to the current process and shows a stack trace. Called by g_on_error_query() when the "[S]tack trace" option is selected. You can get the current process's program name with g_get_prgname(), assuming that you have called gtk_init() or @@ -65691,21 +48165,14 @@ handle that exception (see [Running GLib Applications](glib-running.html)). - the program name, needed by gdb for the "[S]tack trace" + the program name, needed by gdb for the "[S]tack trace" option - - The first call to this routine by a process with a given #GOnce + + The first call to this routine by a process with a given #GOnce struct calls @func with the given argument. Thereafter, subsequent calls to g_once() with the same #GOnce struct do not call @func again, but return the stored result of the first call. On return @@ -65732,31 +48199,20 @@ Calling g_once() recursively on the same #GOnce struct in - a #GOnce structure + a #GOnce structure - the #GThreadFunc function associated to @once. This function + the #GThreadFunc function associated to @once. This function is called only once, regardless of the number of times it and its associated #GOnce struct are passed to g_once(). - data to be passed to @func + data to be passed to @func - - Function to be called when starting a critical initialization + + Function to be called when starting a critical initialization section. The argument @location must point to a static 0-initialized variable that will be set to a value other than 0 at the end of the initialization section. In combination with @@ -65777,60 +48233,51 @@ like this: } // use initialization_value here -]| +]| + +While @location has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. - %TRUE if the initialization section should be entered, + %TRUE if the initialization section should be entered, %FALSE and blocks otherwise - location of a static initializable variable + location of a static initializable variable containing 0 - - Counterpart to g_once_init_enter(). Expects a location of a static + + Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized initialization variable, and an initialization value other than 0. Sets the variable to the initialization value, and releases concurrent threads blocking in g_once_init_enter() on this -initialization variable. +initialization variable. + +While @location has a `volatile` qualifier, this is a historical artifact and +the pointer passed to it should not be `volatile`. - location of a static initializable variable + location of a static initializable variable containing 0 - new non-0 value for *@value_location + new non-0 value for *@value_location - The GOption commandline parser is intended to be a simpler replacement + The GOption commandline parser is intended to be a simpler replacement for the popt library. It supports short and long commandline options, as shown in the following example: @@ -65910,7 +48357,7 @@ static GOptionEntry entries[] = { "verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose, "Be verbose", NULL }, { "beep", 'b', 0, G_OPTION_ARG_NONE, &beep, "Beep when done", NULL }, { "rand", 0, 0, G_OPTION_ARG_NONE, &randomize, "Randomize the data", NULL }, - { NULL } + G_OPTION_ENTRY_NULL }; int @@ -65990,9 +48437,7 @@ main (int argc, char **argv) - Parses a string containing debugging options + Parses a string containing debugging options into a %guint containing bit flags. This is used within GDK and GTK+ to parse the debug options passed on the command line or through environment variables. @@ -66006,43 +48451,30 @@ If @string is equal to "help", all the available keys in @keys are printed out to standard error. - the combined set of bit flags. + the combined set of bit flags. - - a list of debug options separated by colons, spaces, or + + a list of debug options separated by colons, spaces, or commas, or %NULL. - pointer to an array of #GDebugKey which associate + pointer to an array of #GDebugKey which associate strings with bit flags. - the number of #GDebugKeys in the array. + the number of #GDebugKeys in the array. - Gets the last component of the filename. + Gets the last component of the filename. If @file_name ends with a directory separator it gets the component before the last slash. If @file_name consists only of directory @@ -66050,25 +48482,19 @@ separators (and on Windows, possibly a drive letter), a single separator is returned. If @file_name is empty, it gets ".". - a newly allocated string containing the last + a newly allocated string containing the last component of the filename - the name of the file + the name of the file - Gets the directory components of a file name. For example, the directory + Gets the directory components of a file name. For example, the directory component of `/usr/bin/test` is `/usr/bin`. The directory component of `/` is `/`. @@ -66076,24 +48502,18 @@ If the file name has no directory components "." is returned. The returned string should be freed when no longer needed. - the directory components of the file + the directory components of the file - the name of the file + the name of the file - Returns %TRUE if the given @file_name is an absolute file name. + Returns %TRUE if the given @file_name is an absolute file name. Note that this is a somewhat vague concept on Windows. On POSIX systems, an absolute file name is well-defined. It always @@ -66119,47 +48539,35 @@ either. Such paths should be avoided, or need to be handled using Windows-specific code. - %TRUE if @file_name is absolute + %TRUE if @file_name is absolute - a file name + a file name - Returns a pointer into @file_name after the root component, + Returns a pointer into @file_name after the root component, i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute path it returns %NULL. - a pointer into @file_name after the + a pointer into @file_name after the root component - a file name + a file name - - Matches a string against a compiled pattern. Passing the correct + + Matches a string against a compiled pattern. Passing the correct length of the string given is mandatory. The reversed string can be omitted by passing %NULL, this is more efficient if the reversed version of the string to be matched is not at hand, as @@ -66176,107 +48584,76 @@ Note also that the reverse of a UTF-8 encoded string can in general not be obtained by g_strreverse(). This works only if the string does not contain any multibyte characters. GLib offers the g_utf8_strreverse() function to reverse UTF-8 encoded strings. - + Use g_pattern_spec_match() instead + - %TRUE if @string matches @pspec + %TRUE if @string matches @pspec - a #GPatternSpec + a #GPatternSpec - the length of @string (in bytes, i.e. strlen(), + the length of @string (in bytes, i.e. strlen(), not g_utf8_strlen()) - the UTF-8 encoded string to match + the UTF-8 encoded string to match - - the reverse of @string or %NULL + + the reverse of @string or %NULL - - Matches a string against a pattern given as a string. If this + + Matches a string against a pattern given as a string. If this function is to be called in a loop, it's more efficient to compile the pattern once with g_pattern_spec_new() and call g_pattern_match_string() repeatedly. - + - %TRUE if @string matches @pspec + %TRUE if @string matches @pspec - the UTF-8 encoded pattern + the UTF-8 encoded pattern - the UTF-8 encoded string to match + the UTF-8 encoded string to match - - Matches a string against a compiled pattern. If the string is to be + + Matches a string against a compiled pattern. If the string is to be matched against more than one pattern, consider using g_pattern_match() instead while supplying the reversed string. - + Use g_pattern_spec_match_string() instead + - %TRUE if @string matches @pspec + %TRUE if @string matches @pspec - a #GPatternSpec + a #GPatternSpec - the UTF-8 encoded string to match + the UTF-8 encoded string to match - The g_pattern_match* functions match a string + The g_pattern_match* functions match a string against a pattern containing '*' and '?' wildcards with similar semantics as the standard glob() function: '*' matches an arbitrary, possibly empty, string, '?' matches an arbitrary character. @@ -66291,100 +48668,81 @@ g_pattern_spec_new() and use g_pattern_match_string() instead of g_pattern_match_simple(). This avoids the overhead of repeated pattern compilation. - - This is equivalent to g_bit_lock, but working on pointers (or other + + This is equivalent to g_bit_lock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of -the pointer. +the pointer. + +While @address has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a bit value between 0 and 31 + a bit value between 0 and 31 - - This is equivalent to g_bit_trylock, but working on pointers (or + + This is equivalent to g_bit_trylock(), but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of -the pointer. +the pointer. + +While @address has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. - %TRUE if the lock was acquired + %TRUE if the lock was acquired - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a bit value between 0 and 31 + a bit value between 0 and 31 - - This is equivalent to g_bit_unlock, but working on pointers (or other + + This is equivalent to g_bit_unlock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of -the pointer. +the pointer. + +While @address has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a bit value between 0 and 31 + a bit value between 0 and 31 - Polls @fds, as with the poll() system call, but portably. (On + Polls @fds, as with the poll() system call, but portably. (On systems that don't have poll(), it is emulated using select().) This is used internally by #GMainContext, but it can be called directly if you need to block until a file descriptor is ready, but @@ -66403,81 +48761,72 @@ Windows, the easiest solution is to construct all of your #GPollFDs with g_io_channel_win32_make_pollfd(). - the number of entries in @fds whose @revents fields + the number of entries in @fds whose @revents fields were filled in, or 0 if the operation timed out, or -1 on error or if the call was interrupted. - file descriptors to poll + file descriptors to poll - the number of file descriptors in @fds + the number of file descriptors in @fds - amount of time to wait, in milliseconds, or -1 to wait forever + amount of time to wait, in milliseconds, or -1 to wait forever - - Formats a string according to @format and prefix it to an existing + + Formats a string according to @format and prefix it to an existing error message. If @err is %NULL (ie: no error variable) then do nothing. If *@err is %NULL (ie: an error variable is present but there is no error condition) then also do nothing. - + - - a return location for a #GError + + a return location for a #GError - printf()-style format string + printf()-style format string - arguments to @format + arguments to @format + + Prefixes @prefix to an existing error message. If @err or *@err is +%NULL (i.e.: no error variable) then do nothing. + + + + + + + a return location for a #GError, or %NULL + + + + string to prefix @err with + + + + - Outputs a formatted message via the print handler. + Outputs a formatted message via the print handler. The default print handler simply outputs the message to stdout, without appending a trailing new-line character. Typically, @format should end with its own new-line character. @@ -66487,29 +48836,23 @@ messages, since it may be redirected by applications to special purpose message windows or even files. Instead, libraries should use g_log(), g_log_structured(), or the convenience macros g_message(), g_warning() and g_error(). - + - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Outputs a formatted message via the error message handler. + Outputs a formatted message via the error message handler. The default handler simply outputs the message to stderr, without appending a trailing new-line character. Typically, @format should end with its own new-line character. @@ -66517,32 +48860,23 @@ new-line character. g_printerr() should not be used from within libraries. Instead g_log() or g_log_structured() should be used, or the convenience macros g_message(), g_warning() and g_error(). - + - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - - An implementation of the standard printf() function which supports + + An implementation of the standard printf() function which supports positional parameters, as specified in the Single Unix Specification. As with the standard printf(), this does not automatically append a trailing @@ -66552,60 +48886,42 @@ own new-line character. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - - Calculates the maximum space needed to store the output + + Calculates the maximum space needed to store the output of the sprintf() function. - the maximum space needed to store the formatted string + the maximum space needed to store the formatted string - the format string. See the printf() documentation + the format string. See the printf() documentation - the parameters to be inserted into the format string + the parameters to be inserted into the format string - If @dest is %NULL, free @src; otherwise, moves @src into *@dest. + If @dest is %NULL, free @src; otherwise, moves @src into *@dest. The error variable @dest points to must be %NULL. @src must be non-%NULL. @@ -66613,80 +48929,51 @@ The error variable @dest points to must be %NULL. Note that @src is no longer valid after this call. If you want to keep using the same GError*, you need to set it to %NULL after calling this function on it. - + - - error return location + + error return location - error to move into the return location + error to move into the return location - - If @dest is %NULL, free @src; otherwise, moves @src into *@dest. + + If @dest is %NULL, free @src; otherwise, moves @src into *@dest. *@dest must be %NULL. After the move, add a prefix as with g_prefix_error(). - + - error return location + error return location - error to move into the return location + error to move into the return location - printf()-style format string + printf()-style format string - arguments to @format + arguments to @format - - Checks whether @needle exists in @haystack. If the element is found, %TRUE is -returned and the element’s index is returned in @index_ (if non-%NULL). + + Checks whether @needle exists in @haystack. If the element is found, %TRUE is +returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned. @@ -66694,52 +48981,30 @@ This does pointer comparisons only. If you want to use more complex equality checks, such as string comparisons, use g_ptr_array_find_with_equal_func(). - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - - pointer to look for + + pointer to look for - - return location for the index of + + return location for the index of the element, if found - - Checks whether @needle exists in @haystack, using the given @equal_func. -If the element is found, %TRUE is returned and the element’s index is + + Checks whether @needle exists in @haystack, using the given @equal_func. +If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned. @@ -66749,83 +49014,50 @@ and @needle as its second parameter. If @equal_func is %NULL, pointer equality is used. - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - - pointer to look for + + pointer to look for - - the function to call for each element, which should + + the function to call for each element, which should return %TRUE when the desired element is found; or %NULL to use pointer equality - - return location for the index of + + return location for the index of the element, if found - - Returns the pointer at the given index of the pointer array. + + Returns the pointer at the given index of the pointer array. This does not perform bounds checking on the given @index_, so you are responsible for checking it against the array length. - a #GPtrArray + a #GPtrArray - the index of the pointer to return + the index of the pointer to return - - This is just like the standard C qsort() function, but + + This is just like the standard C qsort() function, but the comparison routine accepts a user data argument. This is guaranteed to be a stable sort since version 2.32. @@ -66835,45 +49067,29 @@ This is guaranteed to be a stable sort since version 2.32. - start of array to sort + start of array to sort - elements in the array + elements in the array - size of each element + size of each element - function to compare elements + function to compare elements - - data to pass to @compare_func + + data to pass to @compare_func - - Gets the #GQuark identifying the given (static) string. If the + + Gets the #GQuark identifying the given (static) string. If the string does not currently have an associated #GQuark, a new #GQuark is created, linked to the given string. @@ -66891,27 +49107,18 @@ running. In particular, this means it cannot be used to initialize global variables in C++. - the #GQuark identifying the string, or 0 if @string is %NULL + the #GQuark identifying the string, or 0 if @string is %NULL - - a string + + a string - Gets the #GQuark identifying the given string. If the string does + Gets the #GQuark identifying the given string. If the string does not currently have an associated #GQuark, a new #GQuark is created, using a copy of the string. @@ -66920,47 +49127,32 @@ running. In particular, this means it cannot be used to initialize global variables in C++. - the #GQuark identifying the string, or 0 if @string is %NULL + the #GQuark identifying the string, or 0 if @string is %NULL - - a string + + a string - Gets the string associated with the given #GQuark. + Gets the string associated with the given #GQuark. - the string associated with the #GQuark + the string associated with the #GQuark - a #GQuark. + a #GQuark. - Gets the #GQuark associated with the given string, or 0 if string is + Gets the #GQuark associated with the given string, or 0 if string is %NULL or it has no associated #GQuark. If you want the GQuark to be created if it doesn't already exist, @@ -66970,28 +49162,19 @@ This function must not be used before library constructors have finished running. - the #GQuark associated with the string, or 0 if @string is + the #GQuark associated with the string, or 0 if @string is %NULL or there is no #GQuark associated with it - - a string + + a string - Quarks are associations between strings and integer identifiers. + Quarks are associations between strings and integer identifiers. Given either the string or the #GQuark identifier it is possible to retrieve the other. @@ -67015,9 +49198,7 @@ strings is that they can be compared for equality by a simple pointer comparison, rather than using strcmp(). - The #GQueue structure and its associated functions provide a standard + The #GQueue structure and its associated functions provide a standard queue data structure. Internally, GQueue uses the same data structure as #GList to store elements with the same complexity over insertion/deletion (O(1)) and access/search (O(n)) operations. @@ -67041,105 +49222,73 @@ To remove elements, use g_queue_pop_head() and g_queue_pop_tail(). To free the entire queue, use g_queue_free(). - - Returns a random #gboolean from @rand_. + + Returns a random #gboolean from @rand_. This corresponds to an unbiased coin toss. - a #GRand + a #GRand - Returns a random #gdouble equally distributed over the range [0..1). + Returns a random #gdouble equally distributed over the range [0..1). - a random number + a random number - Returns a random #gdouble equally distributed over the range + Returns a random #gdouble equally distributed over the range [@begin..@end). - a random number + a random number - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Return a random #guint32 equally distributed over the range + Return a random #guint32 equally distributed over the range [0..2^32-1]. - a random number + a random number - Returns a random #gint32 equally distributed over the range + Returns a random #gint32 equally distributed over the range [@begin..@end-1]. - a random number + a random number - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - The following functions allow you to use a portable, fast and good + The following functions allow you to use a portable, fast and good pseudo-random number generator (PRNG). Do not use this API for cryptographic purposes such as key @@ -67185,9 +49334,7 @@ Use the GLib-2.0 algorithms only if you have sequences of numbers generated with Glib-2.0 that you need to reproduce exactly. - Sets the seed for the global random number generator, which is used + Sets the seed for the global random number generator, which is used by the g_random_* functions, to @seed. @@ -67195,40 +49342,28 @@ by the g_random_* functions, to @seed. - a value to reinitialize the global random number generator + a value to reinitialize the global random number generator - - Acquires a reference on the data pointed by @mem_block. - + + Acquires a reference on the data pointed by @mem_block. + - a pointer to the data, + a pointer to the data, with its reference count increased - a pointer to reference counted data + a pointer to reference counted data - Allocates @block_size bytes of memory, and adds reference + Allocates @block_size bytes of memory, and adds reference counting semantics to it. The data will be freed when its reference count drops to @@ -67236,28 +49371,20 @@ zero. The allocated data is guaranteed to be suitably aligned for any built-in type. - + - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - - Allocates @block_size bytes of memory, and adds reference + + Allocates @block_size bytes of memory, and adds reference counting semantics to it. The contents of the returned data is set to zero. @@ -67267,170 +49394,120 @@ zero. The allocated data is guaranteed to be suitably aligned for any built-in type. - + - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - Allocates a new block of data with reference counting + Allocates a new block of data with reference counting semantics, and copies @block_size bytes of @mem_block into it. - + - a pointer to the allocated + a pointer to the allocated memory - the number of bytes to copy, must be greater than 0 + the number of bytes to copy, must be greater than 0 - the memory to copy + the memory to copy - - Retrieves the size of the reference counted data pointed by @mem_block. - + + Retrieves the size of the reference counted data pointed by @mem_block. + - the size of the data, in bytes + the size of the data, in bytes - a pointer to reference counted data + a pointer to reference counted data - - A convenience macro to allocate reference counted data with + + A convenience macro to allocate reference counted data with the size of the given @type. This macro calls g_rc_box_alloc() with `sizeof (@type)` and casts the returned pointer to a pointer of the given @type, avoiding a type cast in the source code. - + - the type to allocate, typically a structure name + the type to allocate, typically a structure name - - A convenience macro to allocate reference counted data with + + A convenience macro to allocate reference counted data with the size of the given @type, and set its contents to zero. This macro calls g_rc_box_alloc0() with `sizeof (@type)` and casts the returned pointer to a pointer of the given @type, avoiding a type cast in the source code. - + - the type to allocate, typically a structure name + the type to allocate, typically a structure name - - Releases a reference on the data pointed by @mem_block. + + Releases a reference on the data pointed by @mem_block. If the reference was the last one, it will free the resources allocated for @mem_block. - + - a pointer to reference counted data + a pointer to reference counted data - - Releases a reference on the data pointed by @mem_block. + + Releases a reference on the data pointed by @mem_block. If the reference was the last one, it will call @clear_func to clear the contents of @mem_block, and then will free the resources allocated for @mem_block. - + - a pointer to reference counted data + a pointer to reference counted data - a function to call when clearing the data + a function to call when clearing the data - A "reference counted box", or "RcBox", is an opaque wrapper data type + A "reference counted box", or "RcBox", is an opaque wrapper data type that is guaranteed to be as big as the size of a given data type, and which augments the given data type with reference counting semantics for its memory management. @@ -67553,236 +49630,158 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (MyDataStruct, my_data_struct_release) ]| - Reallocates the memory pointed to by @mem, so that it now has space for + Reallocates the memory pointed to by @mem, so that it now has space for @n_bytes bytes of memory. It returns the new address of the memory, which may have been moved. @mem may be %NULL, in which case it's considered to have zero-length. @n_bytes may be 0, in which case %NULL will be returned and @mem will be freed unless it is %NULL. - + - the new address of the allocated memory + the new address of the allocated memory - - the memory to reallocate + + the memory to reallocate - new size of the memory in bytes + new size of the memory in bytes - This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - + - the new address of the allocated memory + the new address of the allocated memory - - the memory to reallocate + + the memory to reallocate - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - - Compares the current value of @rc with @val. + + Compares the current value of @rc with @val. - %TRUE if the reference count is the same + %TRUE if the reference count is the same as the given value - the address of a reference count variable + the address of a reference count variable - the value to compare + the value to compare - - Decreases the reference count. + + Decreases the reference count. + +If %TRUE is returned, the reference count reached 0. After this point, @rc +is an undefined state and must be reinitialized with +g_ref_count_init() to be used again. - %TRUE if the reference count reached 0, and %FALSE otherwise + %TRUE if the reference count reached 0, and %FALSE otherwise - the address of a reference count variable + the address of a reference count variable - - Increases the reference count. + + Increases the reference count. - the address of a reference count variable + the address of a reference count variable - - Initializes a reference count variable. + + Initializes a reference count variable to 1. - the address of a reference count variable + the address of a reference count variable - - Acquires a reference on a string. + + Acquires a reference on a string. - the given string, with its reference count increased + the given string, with its reference count increased - a reference counted string + a reference counted string - - Retrieves the length of @str. + + Retrieves the length of @str. - the length of the given string, in bytes + the length of the given string, in bytes - a reference counted string + a reference counted string - - Creates a new reference counted string and copies the contents of @str + + Creates a new reference counted string and copies the contents of @str into it. - the newly created reference counted string + the newly created reference counted string - a NUL-terminated string + a NUL-terminated string - - Creates a new reference counted string and copies the content of @str + + Creates a new reference counted string and copies the content of @str into it. If you call this function multiple times with the same @str, or with @@ -67790,59 +49789,41 @@ the same contents of @str, it will return a new reference, instead of creating a new string. - the newly created reference + the newly created reference counted string, or a new reference to an existing string - a NUL-terminated string + a NUL-terminated string - - Creates a new reference counted string and copies the contents of @str + + Creates a new reference counted string and copies the contents of @str into it, up to @len bytes. Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that @str has at least @len addressable bytes. - the newly created reference counted string + the newly created reference counted string - a string + a string - length of @str to use, or -1 if @str is nul-terminated + length of @str to use, or -1 if @str is nul-terminated - - Releases a reference on a string; if it was the last reference, the + + Releases a reference on a string; if it was the last reference, the resources allocated by the string are freed as well. @@ -67850,17 +49831,13 @@ resources allocated by the string are freed as well. - a reference counted string + a reference counted string - Reference counting is a garbage collection mechanism that is based on + Reference counting is a garbage collection mechanism that is based on assigning a counter to a data type, or any memory area; the counter is increased whenever a new reference to that data type is acquired, and decreased whenever the reference is released. Once the last reference @@ -67876,9 +49853,7 @@ API to increase and decrease the counters, and you should never check their content directly, or compare their content with other values. - Reference counted strings are normal C strings that have been augmented + Reference counted strings are normal C strings that have been augmented with a reference counter to manage their resources. You allocate a new reference counted string and acquire and release references as needed, instead of copying the string among callers; when the last reference on @@ -67938,14 +49913,8 @@ a reference to the existing string instead of creating a new reference counted string instance. Once the string loses its last reference, it will be automatically removed from the global interned strings table. - - Checks whether @replacement is a valid replacement string + + Checks whether @replacement is a valid replacement string (see g_regex_replace()), i.e. that all escape sequences in it are valid. @@ -67956,79 +49925,50 @@ about actual match, but '\0\1' (whole match followed by first subpattern) requires valid #GMatchInfo object. - whether @replacement is a valid replacement string + whether @replacement is a valid replacement string - the replacement string + the replacement string - - location to store information about + + location to store information about references in @replacement or %NULL - + - - Escapes the nul characters in @string to "\x00". It can be used + + Escapes the nul characters in @string to "\x00". It can be used to compile a regex with embedded nul characters. For completeness, @length can be -1 for a nul-terminated string. In this case the output string will be of course equal to @string. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string + the length of @string - - Escapes the special characters used for regular expressions + + Escapes the special characters used for regular expressions in @string, for instance "a.b*c" becomes "a\.b\*c". This function is useful to dynamically generate regular expressions. @@ -68037,35 +49977,24 @@ in this case remember to specify the correct length of @string in @length. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - - Scans for a match in @string for @pattern. + + Scans for a match in @string for @pattern. This function is equivalent to g_regex_match() but it does not require to compile the pattern with g_regex_new(), avoiding some @@ -68077,45 +50006,30 @@ once, it's more efficient to compile the pattern once with g_regex_new() and then use g_regex_match(). - %TRUE if the string matched, %FALSE otherwise + %TRUE if the string matched, %FALSE otherwise - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - - Breaks the string on the pattern, and returns an array of + + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the @@ -68144,9 +50058,7 @@ characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c". - a %NULL-terminated array of strings. Free + a %NULL-terminated array of strings. Free it using g_strfreev() @@ -68154,37 +50066,25 @@ it using g_strfreev() - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - - Resets the cache used for g_get_user_special_dir(), so + + Resets the cache used for g_get_user_special_dir(), so that the latest on-disk version is used. Call this only if you just changed the data on disk yourself. @@ -68198,82 +50098,54 @@ the directories that actually changed value though. - Reallocates the memory pointed to by @mem, so that it now has space for + Reallocates the memory pointed to by @mem, so that it now has space for @n_structs elements of type @struct_type. It returns the new address of the memory, which may have been moved. Care is taken to avoid overflow when calculating the size of the allocated block. - + - the type of the elements to allocate + the type of the elements to allocate - the currently allocated memory + the currently allocated memory - the number of elements to allocate + the number of elements to allocate - - + + - - Internal function used to print messages from the public g_return_if_fail() + + Internal function used to print messages from the public g_return_if_fail() and g_return_val_if_fail() macros. - + - - log domain + + log domain - function containing the assertion + function containing the assertion - - expression which failed + + expression which failed - - + + @@ -68281,166 +50153,104 @@ and g_return_val_if_fail() macros. - - + + - A wrapper for the POSIX rmdir() function. The rmdir() function + A wrapper for the POSIX rmdir() function. The rmdir() function deletes a directory from the filesystem. See your C library manual for more details about how rmdir() works on your system. - 0 if the directory was successfully removed, -1 if an error + 0 if the directory was successfully removed, -1 if an error occurred - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - The #GScanner and its associated functions provide a + The #GScanner and its associated functions provide a general purpose lexical scanner. - - Adds a symbol to the default scope. + + Adds a symbol to the default scope. Use g_scanner_scope_add_symbol() instead. - a #GScanner + a #GScanner - the symbol to add + the symbol to add - the value of the symbol + the value of the symbol - - Calls a function for each symbol in the default scope. + + Calls a function for each symbol in the default scope. Use g_scanner_scope_foreach_symbol() instead. - a #GScanner + a #GScanner - the function to call with each symbol + the function to call with each symbol - data to pass to the function + data to pass to the function - - There is no reason to use this macro, since it does nothing. + + There is no reason to use this macro, since it does nothing. This macro does nothing. - a #GScanner + a #GScanner - - Removes a symbol from the default scope. + + Removes a symbol from the default scope. Use g_scanner_scope_remove_symbol() instead. - a #GScanner + a #GScanner - the symbol to remove + the symbol to remove - - There is no reason to use this macro, since it does nothing. + + There is no reason to use this macro, since it does nothing. This macro does nothing. - a #GScanner + a #GScanner - The #GSequence data structure has the API of a list, but is + The #GSequence data structure has the API of a list, but is implemented internally with a balanced binary tree. This means that most of the operations (access, search, insertion, deletion, ...) on #GSequence are O(log(n)) in average and O(n) in worst case for time @@ -68483,68 +50293,40 @@ you want to add a large amount of data, it is more efficient to call g_sequence_sort() or g_sequence_sort_iter() after doing unsorted insertions. - - Returns the data that @iter points to. + + Returns the data that @iter points to. - the data that @iter points to + the data that @iter points to - a #GSequenceIter + a #GSequenceIter - - Inserts a new item just before the item pointed to by @iter. + + Inserts a new item just before the item pointed to by @iter. - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequenceIter + a #GSequenceIter - - the data for the new item + + the data for the new item - - Moves the item pointed to by @src to the position indicated by @dest. + + Moves the item pointed to by @src to the position indicated by @dest. After calling this function @dest will point to the position immediately after @src. It is allowed for @src and @dest to point into different sequences. @@ -68554,27 +50336,18 @@ sequences. - a #GSequenceIter pointing to the item to move + a #GSequenceIter pointing to the item to move - a #GSequenceIter pointing to the position to which + a #GSequenceIter pointing to the position to which the item is moved - - Inserts the (@begin, @end) range at the destination pointed to by @dest. + + Inserts the (@begin, @end) range at the destination pointed to by @dest. The @begin and @end iters must point into the same sequence. It is allowed for @dest to point to a different sequence than the one pointed into by @begin and @end. @@ -68588,32 +50361,21 @@ the (@begin, @end) range, the range does not move. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - Finds an iterator somewhere in the range (@begin, @end). This + + Finds an iterator somewhere in the range (@begin, @end). This iterator will be close to the middle of the range, but is not guaranteed to be exactly in the middle. @@ -68621,34 +50383,23 @@ The @begin and @end iterators must both point to the same sequence and @begin must come before or be equal to @end in the sequence. - a #GSequenceIter pointing somewhere in the + a #GSequenceIter pointing somewhere in the (@begin, @end) range - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - Removes the item pointed to by @iter. It is an error to pass the + + Removes the item pointed to by @iter. It is an error to pass the end iterator to this function. If the sequence has a data destroy function associated with it, this @@ -68659,20 +50410,13 @@ function is called on the data for the removed item. - a #GSequenceIter + a #GSequenceIter - - Removes all items in the (@begin, @end) range. + + Removes all items in the (@begin, @end) range. If the sequence has a data destroy function associated with it, this function is called on the data for the removed items. @@ -68682,26 +50426,17 @@ function is called on the data for the removed items. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - Changes the data for the item pointed to by @iter to be @data. If + + Changes the data for the item pointed to by @iter to be @data. If the sequence has a data destroy function associated with it, that function is called on the existing data that @iter pointed to. @@ -68710,29 +50445,17 @@ function is called on the existing data that @iter pointed to. - a #GSequenceIter + a #GSequenceIter - - new data for the item + + new data for the item - - Swaps the items pointed to by @a and @b. It is allowed for @a and @b + + Swaps the items pointed to by @a and @b. It is allowed for @a and @b to point into difference sequences. @@ -68740,25 +50463,17 @@ to point into difference sequences. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - - Sets a human-readable name for the application. This name should be + + Sets a human-readable name for the application. This name should be localized if possible, and is intended for display to the user. Contrast with g_set_prgname(), which sets a non-localized name. g_set_prgname() will be called automatically by gtk_init(), @@ -68775,110 +50490,72 @@ or when displaying an application's name in the task list. - localized name of the application + localized name of the application - Does nothing if @err is %NULL; if @err is non-%NULL, then *@err + Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must be %NULL. A new #GError is created and assigned to *@err. - + - - a return location for a #GError + + a return location for a #GError - error domain + error domain - error code + error code - printf()-style format + printf()-style format - args for @format + args for @format - - Does nothing if @err is %NULL; if @err is non-%NULL, then *@err + + Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must be %NULL. A new #GError is created and assigned to *@err. Unlike g_set_error(), @message is not a printf()-style format string. Use this function if @message contains text you don't have control over, that could include printf() escape sequences. - + - - a return location for a #GError + + a return location for a #GError - error domain + error domain - error code + error code - error message + error message - Sets the name of the program. This name should not be localized, + Sets the name of the program. This name should not be localized, in contrast to g_set_application_name(). If you are using #GApplication the program name is set in @@ -68894,73 +50571,53 @@ Note that for thread-safety reasons this function can only be called once. - the name of the program. + the name of the program. - - Sets the print handler. + + Sets the print handler. Any messages passed to g_print() will be output via the new handler. The default handler simply outputs the message to stdout. By providing your own handler you can redirect the output, to a GTK+ widget or a log file for example. - + - the old print handler + the old print handler - the new print handler + the new print handler - - Sets the handler for printing error messages. + + Sets the handler for printing error messages. Any messages passed to g_printerr() will be output via the new handler. The default handler simply outputs the message to stderr. By providing your own handler you can redirect the output, to a GTK+ widget or a log file for example. - + - the old error message handler + the old error message handler - the new error message handler + the new error message handler - Sets an environment variable. On UNIX, both the variable's name and + Sets an environment variable. On UNIX, both the variable's name and value can be arbitrary byte strings, except that the variable's name cannot contain '='. On Windows, they should be in UTF-8. @@ -68981,37 +50638,27 @@ g_environ_setenv() and g_environ_unsetenv(), and then pass that array directly to execvpe(), g_spawn_async(), or the like. - %FALSE if the environment variable couldn't be set. + %FALSE if the environment variable couldn't be set. - the environment variable to set, must not + the environment variable to set, must not contain '='. - the value for to set the variable to. + the value for to set the variable to. - whether to change the variable if it already exists. + whether to change the variable if it already exists. - GLib provides the functions g_shell_quote() and g_shell_unquote() + GLib provides the functions g_shell_quote() and g_shell_unquote() to handle shell-like quoting in strings. The function g_shell_parse_argv() parses a string similar to the way a POSIX shell (/bin/sh) would. @@ -69024,54 +50671,36 @@ are good enough in practice, though. - - Parses a command line into an argument vector, in much the same way + + Parses a command line into an argument vector, in much the same way the shell would, but without many of the expansions the shell would perform (variable expansion, globs, operators, filename expansion, -etc. are not supported). The results are defined to be the same as -those you would get from a UNIX98 /bin/sh, as long as the input -contains none of the unsupported shell expansions. If the input -does contain such expansions, they are passed through -literally. Possible errors are those from the #G_SHELL_ERROR -domain. Free the returned vector with g_strfreev(). +etc. are not supported). + +The results are defined to be the same as those you would get from +a UNIX98 `/bin/sh`, as long as the input contains none of the +unsupported shell expansions. If the input does contain such expansions, +they are passed through literally. + +Possible errors are those from the %G_SHELL_ERROR domain. + +Free the returned vector with g_strfreev(). - %TRUE on success, %FALSE if error set + %TRUE on success, %FALSE if error set - command line to parse + command line to parse - - return location for number of args + + return location for number of args - - + + return location for array of args @@ -69080,77 +50709,70 @@ domain. Free the returned vector with g_strfreev(). - Quotes a string so that the shell (/bin/sh) will interpret the -quoted string to mean @unquoted_string. If you pass a filename to -the shell, for example, you should first quote it with this -function. The return value must be freed with g_free(). The -quoting style used is undefined (single or double quotes may be + Quotes a string so that the shell (/bin/sh) will interpret the +quoted string to mean @unquoted_string. + +If you pass a filename to the shell, for example, you should first +quote it with this function. + +The return value must be freed with g_free(). + +The quoting style used is undefined (single or double quotes may be used). - quoted string + quoted string - a literal string + a literal string - Unquotes a string as the shell (/bin/sh) would. Only handles -quotes; if a string contains file globs, arithmetic operators, -variables, backticks, redirections, or other special-to-the-shell -features, the result will be different from the result a real shell -would produce (the variables, backticks, etc. will be passed -through literally instead of being expanded). This function is -guaranteed to succeed if applied to the result of + Unquotes a string as the shell (/bin/sh) would. + +This function only handles quotes; if a string contains file globs, +arithmetic operators, variables, backticks, redirections, or other +special-to-the-shell features, the result will be different from the +result a real shell would produce (the variables, backticks, etc. +will be passed through literally instead of being expanded). + +This function is guaranteed to succeed if applied to the result of g_shell_quote(). If it fails, it returns %NULL and sets the -error. The @quoted_string need not actually contain quoted or -escaped text; g_shell_unquote() simply goes through the string and -unquotes/unescapes anything that the shell would. Both single and -double quotes are handled, as are escapes including escaped -newlines. The return value must be freed with g_free(). Possible -errors are in the #G_SHELL_ERROR domain. +error. + +The @quoted_string need not actually contain quoted or escaped text; +g_shell_unquote() simply goes through the string and unquotes/unescapes +anything that the shell would. Both single and double quotes are +handled, as are escapes including escaped newlines. + +The return value must be freed with g_free(). + +Possible errors are in the %G_SHELL_ERROR domain. Shell quoting rules are a bit strange. Single quotes preserve the literal string exactly. escape sequences are not allowed; not even -\' - if you want a ' in the quoted text, you have to do something -like 'foo'\''bar'. Double quotes allow $, `, ", \, and newline to -be escaped with backslash. Otherwise double quotes preserve things -literally. +`\'` - if you want a `'` in the quoted text, you have to do something +like `'foo'\''bar'`. Double quotes allow `$`, ```, `"`, `\`, and +newline to be escaped with backslash. Otherwise double quotes +preserve things literally. - an unquoted string + an unquoted string - shell-quoted string + shell-quoted string - - Performs a checked addition of @a and @b, storing the result in + + Performs a checked addition of @a and @b, storing the result in @dest. If the operation is successful, %TRUE is returned. If the operation @@ -69159,29 +50781,18 @@ returned. - a pointer to the #gsize destination + a pointer to the #gsize destination - the #gsize left operand + the #gsize left operand - the #gsize right operand + the #gsize right operand - - Performs a checked multiplication of @a and @b, storing the result in + + Performs a checked multiplication of @a and @b, storing the result in @dest. If the operation is successful, %TRUE is returned. If the operation @@ -69190,115 +50801,83 @@ returned. - a pointer to the #gsize destination + a pointer to the #gsize destination - the #gsize left operand + the #gsize left operand - the #gsize right operand + the #gsize right operand - Allocates a block of memory from the slice allocator. + Allocates a block of memory from the slice allocator. + The block address handed out can be expected to be aligned -to at least 1 * sizeof (void*), -though in general slices are 2 * sizeof (void*) bytes aligned, -if a malloc() fallback implementation is used instead, -the alignment may be reduced in a libc dependent fashion. +to at least `1 * sizeof (void*)`, though in general slices +are `2 * sizeof (void*)` bytes aligned; if a `malloc()` +fallback implementation is used instead, the alignment may +be reduced in a libc dependent fashion. + Note that the underlying slice allocation mechanism can be changed with the [`G_SLICE=always-malloc`][G_SLICE] environment variable. - a pointer to the allocated memory block, which will be %NULL if and - only if @mem_size is 0 + a pointer to the allocated memory block, which will + be %NULL if and only if @mem_size is 0 - the number of bytes to allocate + the number of bytes to allocate - Allocates a block of memory via g_slice_alloc() and initializes + Allocates a block of memory via g_slice_alloc() and initializes the returned memory to 0. Note that the underlying slice allocation mechanism can be changed with the [`G_SLICE=always-malloc`][G_SLICE] environment variable. - a pointer to the allocated block, which will be %NULL if and only + a pointer to the allocated block, which will be %NULL if and only if @mem_size is 0 - the number of bytes to allocate + the number of bytes to allocate - Allocates a block of memory from the slice allocator + Allocates a block of memory from the slice allocator and copies @block_size bytes into it from @mem_block. @mem_block must be non-%NULL if @block_size is non-zero. - a pointer to the allocated memory block, which will be %NULL if and + a pointer to the allocated memory block, which will be %NULL if and only if @mem_size is 0 - the number of bytes to allocate + the number of bytes to allocate - - the memory to copy + + the memory to copy - - A convenience macro to duplicate a block of memory using + + A convenience macro to duplicate a block of memory using the slice allocator. It calls g_slice_copy() with `sizeof (@type)` @@ -69312,24 +50891,15 @@ This can never return %NULL. - the type to duplicate, typically a structure name + the type to duplicate, typically a structure name - the memory to copy into the allocated block + the memory to copy into the allocated block - - A convenience macro to free a block of memory that has + + A convenience macro to free a block of memory that has been allocated from the slice allocator. It calls g_slice_free1() using `sizeof (type)` @@ -69342,21 +50912,15 @@ If @mem is %NULL, this macro does nothing. - the type of the block to free, typically a structure name + the type of the block to free, typically a structure name - a pointer to the block to free + a pointer to the block to free - Frees a block of memory. + Frees a block of memory. The memory must have been allocated via g_slice_alloc() or g_slice_alloc0() and the @block_size has to match the size @@ -69371,29 +50935,18 @@ If @mem_block is %NULL, this function does nothing. - the size of the block + the size of the block - - a pointer to the block to free + + a pointer to the block to free - - Frees a linked list of memory blocks of structure type @type. + + Frees a linked list of memory blocks of structure type @type. + The memory blocks must be equal-sized, allocated via g_slice_alloc() or g_slice_alloc0() and linked together by a @next pointer (similar to #GSList). The name of the @@ -69406,28 +50959,18 @@ If @mem_chain is %NULL, this function does nothing. - the type of the @mem_chain blocks + the type of the @mem_chain blocks - a pointer to the first block of the chain + a pointer to the first block of the chain - the field name of the next pointer in @type + the field name of the next pointer in @type - - Frees a linked list of memory blocks of structure type @type. + + Frees a linked list of memory blocks of structure type @type. The memory blocks must be equal-sized, allocated via g_slice_alloc() or g_slice_alloc0() and linked together by a @@ -69444,24 +50987,15 @@ If @mem_chain is %NULL, this function does nothing. - the size of the blocks + the size of the blocks - - a pointer to the first block of the chain + + a pointer to the first block of the chain - the offset of the @next field in the blocks + the offset of the @next field in the blocks @@ -69477,8 +51011,7 @@ If @mem_chain is %NULL, this function does nothing. - + @@ -69495,13 +51028,8 @@ If @mem_chain is %NULL, this function does nothing. - - A convenience macro to allocate a block of memory from the + + A convenience macro to allocate a block of memory from the slice allocator. It calls g_slice_alloc() with `sizeof (@type)` and casts the @@ -69515,19 +51043,12 @@ This can never return %NULL as the minimum allocation size from - the type to allocate, typically a structure name + the type to allocate, typically a structure name - - A convenience macro to allocate a block of memory from the + + A convenience macro to allocate a block of memory from the slice allocator and set the memory to 0. It calls g_slice_alloc0() with `sizeof (@type)` @@ -69542,9 +51063,7 @@ This can never return %NULL as the minimum allocation size from - the type to allocate, typically a structure name + the type to allocate, typically a structure name @@ -69562,27 +51081,19 @@ This can never return %NULL as the minimum allocation size from - - A convenience macro to get the next element in a #GSList. + + A convenience macro to get the next element in a #GSList. Note that it is considered perfectly acceptable to access @slist->next directly. - an element in a #GSList. + an element in a #GSList. - A safer form of the standard sprintf() function. The output is guaranteed + A safer form of the standard sprintf() function. The output is guaranteed to not exceed @n characters (including the terminating nul character), so it is easy to ensure that a buffer overflow cannot occur. @@ -69601,47 +51112,33 @@ The format string may contain positional parameters, as specified in the Single Unix Specification. - the number of bytes which would be produced if the buffer + the number of bytes which would be produced if the buffer was large enough. - the buffer to hold the output. + the buffer to hold the output. - the maximum number of bytes to produce (including the + the maximum number of bytes to produce (including the terminating nul character). - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - - Removes the source with the given ID from the default main context. You must + + Removes the source with the given ID from the default main context. You must use g_source_destroy() for sources added to a non-default main context. The ID of a #GSource is given by g_source_get_id(), or will be @@ -69660,89 +51157,56 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - For historical reasons, this function always returns %TRUE + For historical reasons, this function always returns %TRUE - the ID of the source to remove. + the ID of the source to remove. - - Removes a source from the default main loop context given the + + Removes a source from the default main loop context given the source functions and user data. If multiple sources exist with the same source functions and user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - The @source_funcs passed to g_source_new() + The @source_funcs passed to g_source_new() - - the user data for the callback + + the user data for the callback - - Removes a source from the default main loop context given the user + + Removes a source from the default main loop context given the user data for the callback. If multiple sources exist with the same user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - - the user_data for the callback. + + the user_data for the callback. - - Sets the name of a source using its ID. + + Sets the name of a source using its ID. This is a convenience utility to set source names from the return value of g_idle_add(), g_timeout_add(), etc. @@ -69758,30 +51222,23 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - a #GSource ID + a #GSource ID - debug name for the source + debug name for the source - - Gets the smallest prime number from a built-in array of primes which + + Gets the smallest prime number from a built-in array of primes which is larger than @num. This is used within GLib to calculate the optimum size of a #GHashTable. @@ -69789,25 +51246,19 @@ The built-in array of primes ranges from 11 to 13845163 such that each prime is approximately 1.5-2 times the previous prime. - the smallest prime number from a built-in array of primes + the smallest prime number from a built-in array of primes which is larger than @num - a #guint + a #guint - GLib supports spawning of processes with an API that is more + GLib supports spawning of processes with an API that is more convenient than the bare UNIX fork() and exec(). The g_spawn family of functions has synchronous (g_spawn_sync()) @@ -69848,7 +51299,7 @@ child_watch_cb (GPid pid, gpointer user_data) { g_message ("Child %" G_PID_FORMAT " exited %s", pid, - g_spawn_check_exit_status (status, NULL) ? "normally" : "abnormally"); + g_spawn_check_wait_status (status, NULL) ? "normally" : "abnormally"); // Free any resources associated with the child here, such as I/O channels // on its stdout and stderr FDs. If you have no code to put in the @@ -69862,15 +51313,15 @@ child_watch_cb (GPid pid, ]| - See g_spawn_async_with_pipes() for a full description; this function + Executes a child program asynchronously. + +See g_spawn_async_with_pipes() for a full description; this function simply calls the g_spawn_async_with_pipes() without any pipes. You should call g_spawn_close_pid() on the returned child process reference when you don't need it any more. -If you are writing a GTK+ application, and the program you are spawning is a +If you are writing a GTK application, and the program you are spawning is a graphical application too, then to ensure that the spawned program opens its windows on the right screen, you may want to use #GdkAppLaunchContext, #GAppLaunchContext, or set the %DISPLAY environment variable. @@ -69880,251 +51331,212 @@ process and not its identifier. Process handles and process identifiers are different concepts on Windows. - %TRUE on success, %FALSE if error is set + %TRUE on success, %FALSE if error is set - - child's current working + + child's current working directory, or %NULL to inherit parent's - + child's argument vector - - + + child's environment, or %NULL to inherit parent's - flags from #GSpawnFlags + flags from #GSpawnFlags - - function to run in the child just before exec() + + function to run in the child just before exec() - - user data for @child_setup + + user data for @child_setup - - return location for child process reference, or %NULL + + return location for child process reference, or %NULL - - Identical to g_spawn_async_with_pipes() but instead of -creating pipes for the stdin/stdout/stderr, you can pass existing -file descriptors into this function through the @stdin_fd, -@stdout_fd and @stderr_fd parameters. The following @flags -also have their behaviour slightly tweaked as a result: + + Executes a child program asynchronously. -%G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output -will be discarded, instead of going to the same location as the parent's -standard output. If you use this flag, @standard_output must be -1. -%G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error -will be discarded, instead of going to the same location as the parent's -standard error. If you use this flag, @standard_error must be -1. -%G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's -standard input (by default, the child's standard input is attached to -/dev/null). If you use this flag, @standard_input must be -1. - -It is valid to pass the same fd in multiple parameters (e.g. you can pass -a single fd for both stdout and stderr). - +Identical to g_spawn_async_with_pipes_and_fds() but with `n_fds` set to zero, +so no FD assignments are used. + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - - child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding + + child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding - child's argument vector, in the GLib file name encoding + child's argument vector, in the GLib file name encoding - - child's environment, or %NULL to inherit parent's, in the GLib file name encoding + + child's environment, or %NULL to inherit parent's, in the GLib file name encoding - flags from #GSpawnFlags + flags from #GSpawnFlags - - function to run in the child just before exec() + + function to run in the child just before exec() - - user data for @child_setup + + user data for @child_setup - - return location for child process ID, or %NULL + + return location for child process ID, or %NULL - file descriptor to use for child's stdin, or -1 + file descriptor to use for child's stdin, or `-1` - file descriptor to use for child's stdout, or -1 + file descriptor to use for child's stdout, or `-1` - file descriptor to use for child's stderr, or -1 + file descriptor to use for child's stderr, or `-1` - - Executes a child program asynchronously (your program will not -block waiting for the child to exit). The child program is -specified by the only argument that must be provided, @argv. -@argv should be a %NULL-terminated array of strings, to be passed -as the argument vector for the child. The first string in @argv -is of course the name of the program to execute. By default, the -name of the program must be a full path. If @flags contains the -%G_SPAWN_SEARCH_PATH flag, the `PATH` environment variable is -used to search for the executable. If @flags contains the -%G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the `PATH` variable from -@envp is used to search for the executable. If both the -%G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP flags -are set, the `PATH` variable from @envp takes precedence over -the environment variable. + + Identical to g_spawn_async_with_pipes_and_fds() but with `n_fds` set to zero, +so no FD assignments are used. + + + %TRUE on success, %FALSE if an error was set + + + + + child's current working + directory, or %NULL to inherit parent's, in the GLib file name encoding + + + + child's argument + vector, in the GLib file name encoding + + + + + + + child's environment, or %NULL to inherit parent's, in the GLib file + name encoding + + + + + + flags from #GSpawnFlags + + + + function to run in the child just before exec() + + + + user data for @child_setup + + + + return location for child process ID, or %NULL + + + + return location for file descriptor to write to child's stdin, or %NULL + + + + return location for file descriptor to read child's stdout, or %NULL + + + + return location for file descriptor to read child's stderr, or %NULL + + + + + + Executes a child program asynchronously (your program will not +block waiting for the child to exit). -If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag is not -used, then the program will be run from the current directory (or -@working_directory, if specified); this might be unexpected or even +The child program is specified by the only argument that must be +provided, @argv. @argv should be a %NULL-terminated array of strings, +to be passed as the argument vector for the child. The first string +in @argv is of course the name of the program to execute. By default, +the name of the program must be a full path. If @flags contains the +%G_SPAWN_SEARCH_PATH flag, the `PATH` environment variable is used to +search for the executable. If @flags contains the +%G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the `PATH` variable from @envp +is used to search for the executable. If both the +%G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP flags are +set, the `PATH` variable from @envp takes precedence over the +environment variable. + +If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag +is not used, then the program will be run from the current directory +(or @working_directory, if specified); this might be unexpected or even dangerous in some cases when the current directory is world-writable. On Windows, note that all the string or string vector arguments to -this function and the other g_spawn*() functions are in UTF-8, the +this function and the other `g_spawn*()` functions are in UTF-8, the GLib file name encoding. Unicode characters that are not part of the system codepage passed in these arguments will be correctly available in the spawned program only if it uses wide character API to retrieve its command line. For C programs built with Microsoft's -tools it is enough to make the program have a wmain() instead of -main(). wmain() has a wide character argument vector as parameter. +tools it is enough to make the program have a `wmain()` instead of +`main()`. `wmain()` has a wide character argument vector as parameter. -At least currently, mingw doesn't support wmain(), so if you use +At least currently, mingw doesn't support `wmain()`, so if you use mingw to develop the spawned program, it should call g_win32_get_command_line() to get arguments in UTF-8. -On Windows the low-level child process creation API CreateProcess() +On Windows the low-level child process creation API `CreateProcess()` doesn't use argument vectors, but a command line. The C runtime -library's spawn*() family of functions (which g_spawn_async_with_pipes() +library's `spawn*()` family of functions (which g_spawn_async_with_pipes() eventually calls) paste the argument vector elements together into a command line, and the C runtime startup code does a corresponding reconstruction of an argument vector from the command line, to be -passed to main(). Complications arise when you have argument vector +passed to `main()`. Complications arise when you have argument vector elements that contain spaces or double quotes. The `spawn*()` functions don't do any quoting or escaping, but on the other hand the startup code does do unquoting and unescaping in order to enable receiving arguments with embedded spaces or double quotes. To work around this asymmetry, g_spawn_async_with_pipes() will do quoting and escaping on argument vector elements that need it before calling the C runtime -spawn() function. +`spawn()` function. The returned @child_pid on Windows is a handle to the child process, not its identifier. Process handles and process @@ -70142,29 +51554,46 @@ otherwise it will stay around as a zombie process until this process exits. Eventually you must call g_spawn_close_pid() on the @child_pid, in order to free resources which may be associated with the child process. (On Unix, using a child watch is equivalent to calling waitpid() or handling -the %SIGCHLD signal manually. On Windows, calling g_spawn_close_pid() -is equivalent to calling CloseHandle() on the process handle returned +the `SIGCHLD` signal manually. On Windows, calling g_spawn_close_pid() +is equivalent to calling `CloseHandle()` on the process handle returned in @child_pid). See g_child_watch_add(). Open UNIX file descriptors marked as `FD_CLOEXEC` will be automatically closed in the child process. %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that other open file descriptors will be inherited by the child; otherwise all -descriptors except stdin/stdout/stderr will be closed before calling exec() +descriptors except stdin/stdout/stderr will be closed before calling `exec()` in the child. %G_SPAWN_SEARCH_PATH means that @argv[0] need not be an absolute path, it will be looked for in the `PATH` environment variable. %G_SPAWN_SEARCH_PATH_FROM_ENVP means need not be an absolute path, it will be looked for in the `PATH` variable from @envp. If both %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP are used, the value from @envp takes precedence over the environment. + %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will be discarded, instead of going to the same location as the parent's -standard output. If you use this flag, @standard_output must be %NULL. +standard output. If you use this flag, @stdout_pipe_out must be %NULL. + %G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error will be discarded, instead of going to the same location as the parent's -standard error. If you use this flag, @standard_error must be %NULL. +standard error. If you use this flag, @stderr_pipe_out must be %NULL. + %G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's standard input (by default, the child's standard input is attached to -`/dev/null`). If you use this flag, @standard_input must be %NULL. +`/dev/null`). If you use this flag, @stdin_pipe_out must be %NULL. + +It is valid to pass the same FD in multiple parameters (e.g. you can pass +a single FD for both @stdout_fd and @stderr_fd, and include it in +@source_fds too). + +@source_fds and @target_fds allow zero or more FDs from this process to be +remapped to different FDs in the spawned process. If @n_fds is greater than +zero, @source_fds and @target_fds must both be non-%NULL and the same length. +Each FD in @source_fds is remapped to the FD number at the same index in +@target_fds. The source and target FD may be equal to simply propagate an FD +to the spawned process. FD remappings are processed after standard FDs, so +any target FDs which equal @stdin_fd, @stdout_fd or @stderr_fd will overwrite +them in the spawned process. + %G_SPAWN_FILE_AND_ARGV_ZERO means that the first element of @argv is the file to execute, while the remaining elements are the actual argument vector to pass to the file. Normally g_spawn_async_with_pipes() @@ -70173,60 +51602,60 @@ uses @argv[0] as the file to execute, and passes all of @argv to the child. @child_setup and @user_data are a function and user data. On POSIX platforms, the function is called in the child after GLib has performed all the setup it plans to perform (including creating -pipes, closing file descriptors, etc.) but before calling exec(). -That is, @child_setup is called just before calling exec() in the +pipes, closing file descriptors, etc.) but before calling `exec()`. +That is, @child_setup is called just before calling `exec()` in the child. Obviously actions taken in this function will only affect the child, not the parent. -On Windows, there is no separate fork() and exec() functionality. +On Windows, there is no separate `fork()` and `exec()` functionality. Child processes are created and run with a single API call, -CreateProcess(). There is no sensible thing @child_setup +`CreateProcess()`. There is no sensible thing @child_setup could be used for on Windows so it is ignored and not called. If non-%NULL, @child_pid will on Unix be filled with the child's process ID. You can use the process ID to send signals to the child, -or to use g_child_watch_add() (or waitpid()) if you specified the +or to use g_child_watch_add() (or `waitpid()`) if you specified the %G_SPAWN_DO_NOT_REAP_CHILD flag. On Windows, @child_pid will be filled with a handle to the child process only if you specified the %G_SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child process using the Win32 API, for example wait for its termination -with the WaitFor*() functions, or examine its exit code with -GetExitCodeProcess(). You should close the handle with CloseHandle() +with the `WaitFor*()` functions, or examine its exit code with +`GetExitCodeProcess()`. You should close the handle with `CloseHandle()` or g_spawn_close_pid() when you no longer need it. -If non-%NULL, the @standard_input, @standard_output, @standard_error +If non-%NULL, the @stdin_pipe_out, @stdout_pipe_out, @stderr_pipe_out locations will be filled with file descriptors for writing to the child's standard input or reading from its standard output or standard error. The caller of g_spawn_async_with_pipes() must close these file descriptors when they are no longer in use. If these parameters are %NULL, the corresponding pipe won't be created. -If @standard_input is %NULL, the child's standard input is attached to +If @stdin_pipe_out is %NULL, the child's standard input is attached to `/dev/null` unless %G_SPAWN_CHILD_INHERITS_STDIN is set. -If @standard_error is NULL, the child's standard error goes to the same +If @stderr_pipe_out is NULL, the child's standard error goes to the same location as the parent's standard error unless %G_SPAWN_STDERR_TO_DEV_NULL is set. -If @standard_output is NULL, the child's standard output goes to the same +If @stdout_pipe_out is NULL, the child's standard output goes to the same location as the parent's standard output unless %G_SPAWN_STDOUT_TO_DEV_NULL is set. @error can be %NULL to ignore errors, or non-%NULL to report errors. If an error is set, the function returns %FALSE. Errors are reported even if they occur in the child (for example if the executable in -@argv[0] is not found). Typically the `message` field of returned +`@argv[0]` is not found). Typically the `message` field of returned errors should be displayed to users. Possible errors are those from the #G_SPAWN_ERROR domain. -If an error occurs, @child_pid, @standard_input, @standard_output, -and @standard_error will not be filled with valid values. +If an error occurs, @child_pid, @stdin_pipe_out, @stdout_pipe_out, +and @stderr_pipe_out will not be filled with valid values. If @child_pid is not %NULL and an error does not occur then the returned process reference must be closed using g_spawn_close_pid(). On modern UNIX platforms, GLib can use an efficient process launching -codepath driven internally by posix_spawn(). This has the advantage of +codepath driven internally by `posix_spawn()`. This has the advantage of avoiding the fork-time performance costs of cloning the parent process address space, and avoiding associated memory overcommit checks that are not relevant in the context of immediately executing a distinct process. @@ -70238,250 +51667,235 @@ are met: 3. %G_SPAWN_SEARCH_PATH_FROM_ENVP is not set 4. @working_directory is %NULL 5. @child_setup is %NULL -6. The program is of a recognised binary format, or has a shebang. Otherwise, GLib will have to execute the program through the shell, which is not done using the optimized codepath. +6. The program is of a recognised binary format, or has a shebang. + Otherwise, GLib will have to execute the program through the + shell, which is not done using the optimized codepath. -If you are writing a GTK+ application, and the program you are spawning is a +If you are writing a GTK application, and the program you are spawning is a graphical application too, then to ensure that the spawned program opens its windows on the right screen, you may want to use #GdkAppLaunchContext, -#GAppLaunchContext, or set the %DISPLAY environment variable. - +#GAppLaunchContext, or set the `DISPLAY` environment variable. + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - - child's current working + + child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding - child's argument + child's argument vector, in the GLib file name encoding - + - - + + child's environment, or %NULL to inherit parent's, in the GLib file name encoding - + - flags from #GSpawnFlags + flags from #GSpawnFlags - - function to run in the child just before exec() + + function to run in the child just before `exec()` - - user data for @child_setup + + user data for @child_setup - - return location for child process ID, or %NULL + + file descriptor to use for child's stdin, or `-1` + + + + file descriptor to use for child's stdout, or `-1` + + + + file descriptor to use for child's stderr, or `-1` + + + + array of FDs from the parent + process to make available in the child process + + + + + + array of FDs to remap + @source_fds to in the child process + + + + + + number of FDs in @source_fds and @target_fds + + + + return location for child process ID, or %NULL - - return location for file descriptor to write to child's stdin, or %NULL + + return location for file descriptor to write to child's stdin, or %NULL - - return location for file descriptor to read child's stdout, or %NULL + + return location for file descriptor to read child's stdout, or %NULL - - return location for file descriptor to read child's stderr, or %NULL + + return location for file descriptor to read child's stderr, or %NULL - - Set @error if @exit_status indicates the child exited abnormally + + An old name for g_spawn_check_wait_status(), deprecated because its +name is misleading. + +Despite the name of the function, @wait_status must be the wait status +as returned by g_spawn_sync(), g_subprocess_get_status(), `waitpid()`, +etc. On Unix platforms, it is incorrect for it to be the exit status +as passed to `exit()` or returned by g_subprocess_get_exit_status() or +`WEXITSTATUS()`. + Use g_spawn_check_wait_status() instead, and check whether your code is conflating wait and exit statuses. + + + %TRUE if child exited successfully, %FALSE otherwise (and + @error will be set) + + + + + A status as returned from g_spawn_sync() + + + + + + Set @error if @wait_status indicates the child exited abnormally (e.g. with a nonzero exit code, or via a fatal signal). -The g_spawn_sync() and g_child_watch_add() family of APIs return an -exit status for subprocesses encoded in a platform-specific way. +The g_spawn_sync() and g_child_watch_add() family of APIs return the +status of subprocesses encoded in a platform-specific way. On Unix, this is guaranteed to be in the same format waitpid() returns, and on Windows it is guaranteed to be the result of GetExitCodeProcess(). Prior to the introduction of this function in GLib 2.34, interpreting -@exit_status required use of platform-specific APIs, which is problematic +@wait_status required use of platform-specific APIs, which is problematic for software using GLib as a cross-platform layer. Additionally, many programs simply want to determine whether or not the child exited successfully, and either propagate a #GError or print a message to standard error. In that common case, this function can be used. Note that the error message in @error will contain -human-readable information about the exit status. +human-readable information about the wait status. The @domain and @code of @error have special semantics in the case where the process has an "exit code", as opposed to being killed by a signal. On Unix, this happens if WIFEXITED() would be true of -@exit_status. On Windows, it is always the case. +@wait_status. On Windows, it is always the case. The special semantics are that the actual exit code will be the code set in @error, and the domain will be %G_SPAWN_EXIT_ERROR. This allows you to differentiate between different exit codes. If the process was terminated by some means other than an exit -status, the domain will be %G_SPAWN_ERROR, and the code will be -%G_SPAWN_ERROR_FAILED. +status (for example if it was killed by a signal), the domain will be +%G_SPAWN_ERROR and the code will be %G_SPAWN_ERROR_FAILED. This function just offers convenience; you can of course also check the available platform via a macro such as %G_OS_UNIX, and use -WIFEXITED() and WEXITSTATUS() on @exit_status directly. Do not attempt +WIFEXITED() and WEXITSTATUS() on @wait_status directly. Do not attempt to scan or parse the error message string; it may be translated and/or -change in future versions of GLib. - +change in future versions of GLib. + +Prior to version 2.70, g_spawn_check_exit_status() provides the same +functionality, although under a misleading name. + - %TRUE if child exited successfully, %FALSE otherwise (and - @error will be set) + %TRUE if child exited successfully, %FALSE otherwise (and + @error will be set) - - An exit code as returned from g_spawn_sync() + + A platform-specific wait status as returned from g_spawn_sync() - On some platforms, notably Windows, the #GPid type represents a resource + On some platforms, notably Windows, the #GPid type represents a resource which must be closed to prevent resource leaking. g_spawn_close_pid() is provided for this purpose. It should be used on all platforms, even though it doesn't do anything under UNIX. - + - The process reference to close + The process reference to close - - A simple version of g_spawn_async() that parses a command line with -g_shell_parse_argv() and passes it to g_spawn_async(). Runs a -command line in the background. Unlike g_spawn_async(), the + + A simple version of g_spawn_async() that parses a command line with +g_shell_parse_argv() and passes it to g_spawn_async(). + +Runs a command line in the background. Unlike g_spawn_async(), the %G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note that %G_SPAWN_SEARCH_PATH can have security implications, so consider using g_spawn_async() directly if appropriate. Possible errors are those from g_shell_parse_argv() and g_spawn_async(). The same concerns on Windows apply as for g_spawn_command_line_sync(). - + - %TRUE on success, %FALSE if error is set + %TRUE on success, %FALSE if error is set - a command line + a command line - - A simple version of g_spawn_sync() with little-used parameters -removed, taking a command line instead of an argument vector. See -g_spawn_sync() for full details. @command_line will be parsed by -g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag -is enabled. Note that %G_SPAWN_SEARCH_PATH can have security -implications, so consider using g_spawn_sync() directly if -appropriate. Possible errors are those from g_spawn_sync() and those + + A simple version of g_spawn_sync() with little-used parameters +removed, taking a command line instead of an argument vector. + +See g_spawn_sync() for full details. + +The @command_line argument will be parsed by g_shell_parse_argv(). + +Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag is enabled. +Note that %G_SPAWN_SEARCH_PATH can have security implications, so +consider using g_spawn_sync() directly if appropriate. + +Possible errors are those from g_spawn_sync() and those from g_shell_parse_argv(). -If @exit_status is non-%NULL, the platform-specific exit status of +If @wait_status is non-%NULL, the platform-specific status of the child is stored there; see the documentation of -g_spawn_check_exit_status() for how to use and interpret this. +g_spawn_check_wait_status() for how to use and interpret this. +On Unix platforms, note that it is usually not equal +to the integer passed to `exit()` or returned from `main()`. On Windows, please note the implications of g_shell_parse_argv() parsing @command_line. Parsing is done according to Unix shell rules, not @@ -70492,55 +51906,30 @@ canonical Windows paths, like "c:\\program files\\app\\app.exe", as the backslashes will be eaten, and the space will act as a separator. You need to enclose such paths with single quotes, like "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'". - + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - a command line + a command line - - return location for child output + + return location for child output - - return location for child errors + + return location for child errors - - return location for child exit status, as returned by waitpid() + + return location for child wait status, as returned by waitpid() @@ -70550,145 +51939,92 @@ separator. You need to enclose such paths with single quotes, like - + - Executes a child synchronously (waits for the child to exit before returning). + Executes a child synchronously (waits for the child to exit before returning). + All output from the child is stored in @standard_output and @standard_error, if those parameters are non-%NULL. Note that you must set the %G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when passing %NULL for @standard_output and @standard_error. -If @exit_status is non-%NULL, the platform-specific exit status of +If @wait_status is non-%NULL, the platform-specific status of the child is stored there; see the documentation of -g_spawn_check_exit_status() for how to use and interpret this. +g_spawn_check_wait_status() for how to use and interpret this. +On Unix platforms, note that it is usually not equal +to the integer passed to `exit()` or returned from `main()`. + Note that it is invalid to pass %G_SPAWN_DO_NOT_REAP_CHILD in @flags, and on POSIX platforms, the same restrictions as for g_child_watch_source_new() apply. If an error occurs, no data is returned in @standard_output, -@standard_error, or @exit_status. +@standard_error, or @wait_status. This function calls g_spawn_async_with_pipes() internally; see that function for full details on the other parameters and details on how these functions work on Windows. - + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - - child's current working + + child's current working directory, or %NULL to inherit parent's - + child's argument vector - - + + child's environment, or %NULL to inherit parent's - flags from #GSpawnFlags + flags from #GSpawnFlags - - function to run in the child just before exec() + + function to run in the child just before exec() - - user data for @child_setup + + user data for @child_setup - - return location for child output, or %NULL + + return location for child output, or %NULL - - return location for child error messages, or %NULL + + return location for child error messages, or %NULL - - return location for child exit status, as returned by waitpid(), or %NULL + + return location for child wait status, as returned by waitpid(), or %NULL - - An implementation of the standard sprintf() function which supports + + An implementation of the standard sprintf() function which supports positional parameters, as specified in the Single Unix Specification. Note that it is usually better to use g_snprintf(), to avoid the @@ -70699,42 +52035,29 @@ risk of buffer overflow. See also g_strdup_printf(). - the number of bytes printed. + the number of bytes printed. - A pointer to a memory buffer to contain the resulting string. It + A pointer to a memory buffer to contain the resulting string. It is up to the caller to ensure that the allocated buffer is large enough to hold the formatted result - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - - Sets @pp to %NULL, returning the value that was there before. + + Sets @pp to %NULL, returning the value that was there before. Conceptually, this transfers the ownership of the pointer from the referenced variable to the "caller" of the macro (ie: "steals" the @@ -70782,48 +52105,36 @@ get_object (GObject **obj_out) In the above example, the object will be automatically freed in the early error case and also in the case that %NULL was given for @obj_out. - + - a pointer to a pointer + a pointer to a pointer - Copies a nul-terminated string into the dest buffer, include the + Copies a nul-terminated string into the dest buffer, include the trailing nul, and return a pointer to the trailing nul byte. This is useful for concatenating multiple strings together without having to repeatedly scan for the end. - + - a pointer to trailing nul byte. + a pointer to trailing nul byte. - destination buffer. + destination buffer. - source string. + source string. - Compares two strings for byte-by-byte equality and returns %TRUE + Compares two strings for byte-by-byte equality and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL strings as keys in a #GHashTable. @@ -70833,86 +52144,58 @@ for general purpose comparisons of non-%NULL strings. For a %NULL-safe string comparison function, see g_strcmp0(). - %TRUE if the two keys match + %TRUE if the two keys match - a key + a key - a key to compare with @v1 + a key to compare with @v1 - - Looks whether the string @str begins with @prefix. + + Looks whether the string @str begins with @prefix. - %TRUE if @str begins with @prefix, %FALSE otherwise. + %TRUE if @str begins with @prefix, %FALSE otherwise. - a nul-terminated string + a nul-terminated string - the nul-terminated prefix to look for + the nul-terminated prefix to look for - - Looks whether the string @str ends with @suffix. + + Looks whether the string @str ends with @suffix. - %TRUE if @str end with @suffix, %FALSE otherwise. + %TRUE if @str end with @suffix, %FALSE otherwise. - a nul-terminated string + a nul-terminated string - the nul-terminated suffix to look for + the nul-terminated suffix to look for - Converts a string to a hash value. + Converts a string to a hash value. This function implements the widely used "djb" hash apparently posted by Daniel Bernstein to comp.lang.c some time ago. The 32 @@ -70928,47 +52211,33 @@ For example, it produces some hash collisions with strings as short as 2. - a hash value corresponding to the key + a hash value corresponding to the key - a string key + a string key - Determines if a string is pure ASCII. A string is pure ASCII if it + Determines if a string is pure ASCII. A string is pure ASCII if it contains no bytes with the high bit set. - %TRUE if @str is ASCII + %TRUE if @str is ASCII - a string + a string - - Checks if a search conducted for @search_term should match + + Checks if a search conducted for @search_term should match @potential_hit. This function calls g_str_tokenize_and_fold() on both @@ -70985,43 +52254,33 @@ your corpus and build an index on the returned folded tokens, then call g_str_tokenize_and_fold() on the search term and perform lookups into that index. -As some examples, searching for ‘fred’ would match the potential hit -‘Smith, Fred’ and also ‘Frédéric’. Searching for ‘Fréd’ would match -‘Frédéric’ but not ‘Frederic’ (due to the one-directional nature of -accent matching). Searching ‘fo’ would match ‘Foo’ and ‘Bar Foo -Baz’, but not ‘SFO’ (because no word has ‘fo’ as a prefix). - +As some examples, searching for ‘fred’ would match the potential hit +‘Smith, Fred’ and also ‘Frédéric’. Searching for ‘Fréd’ would match +‘Frédéric’ but not ‘Frederic’ (due to the one-directional nature of +accent matching). Searching ‘fo’ would match ‘Foo’ and ‘Bar Foo +Baz’, but not ‘SFO’ (because no word has ‘fo’ as a prefix). + - %TRUE if @potential_hit is a hit + %TRUE if @potential_hit is a hit - the search term from the user + the search term from the user - the text that may be a hit + the text that may be a hit - %TRUE to accept ASCII alternates + %TRUE to accept ASCII alternates - Transliterate @str to plain ASCII. + Transliterate @str to plain ASCII. For best results, @str should be in composed normalised form. @@ -71039,37 +52298,24 @@ If @from_locale is %NULL then the current locale is used. If you want to do translation for no specific locale, and you want it to be done independently of the currently locale, specify `"C"` for @from_locale. - + - a string in plain ASCII + a string in plain ASCII - a string, in UTF-8 + a string, in UTF-8 - - the source locale, if known + + the source locale, if known - - Tokenises @string and performs folding on each token. + + Tokenises @string and performs folding on each token. A token is a non-empty sequence of alphanumeric characters in the source string, separated by non-alphanumeric characters. An @@ -71084,39 +52330,25 @@ The number of ASCII alternatives that are generated and the method for doing so is unspecified, but @translit_locale (if specified) may improve the transliteration if the language of the source string is known. - + - the folded tokens + the folded tokens - a string + a string - - the language code (like 'de' or + + the language code (like 'de' or 'en_GB') from which @string originates - - a + + a return location for ASCII alternates @@ -71125,17 +52357,18 @@ known. - For each character in @string, if the character is not in @valid_chars, -replaces the character with @substitutor. Modifies @string in place, -and return @string itself, not a copy. The return value is to allow -nesting such as + For each character in @string, if the character is not in @valid_chars, +replaces the character with @substitutor. + +Modifies @string in place, and return @string itself, not a copy. The +return value is to allow nesting such as: + |[<!-- language="C" --> g_ascii_strup (g_strcanon (str, "abc", '?')) ]| -In order to modify a copy, you may use `g_strdup()`: +In order to modify a copy, you may use g_strdup(): + |[<!-- language="C" --> reformatted = g_strcanon (g_strdup (const_str), "abc", '?'); ... @@ -71143,69 +52376,48 @@ In order to modify a copy, you may use `g_strdup()`: ]| - @string + the modified @string - a nul-terminated array of bytes + a nul-terminated array of bytes - bytes permitted in @string + bytes permitted in @string - replacement character for disallowed bytes + replacement character for disallowed bytes - - A case-insensitive string comparison, corresponding to the standard + + A case-insensitive string comparison, corresponding to the standard strcasecmp() function on platforms which support it. See g_strncasecmp() for a discussion of why this function is deprecated and how to replace it. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - a string + a string - a string to compare with @s1 + a string to compare with @s1 - Removes trailing whitespace from a string. + Removes trailing whitespace from a string. This function doesn't allocate or reallocate any memory; it modifies @string in place. Therefore, it cannot be used @@ -71216,24 +52428,18 @@ The pointer to @string is returned to allow the nesting of functions. Also see g_strchug() and g_strstrip(). - @string + @string - a string to remove the trailing whitespace from + a string to remove the trailing whitespace from - Removes leading whitespace from a string, by moving the rest + Removes leading whitespace from a string, by moving the rest of the characters forward. This function doesn't allocate or reallocate any memory; @@ -71245,81 +52451,55 @@ The pointer to @string is returned to allow the nesting of functions. Also see g_strchomp() and g_strstrip(). - @string + @string - a string to remove the leading whitespace from + a string to remove the leading whitespace from - Compares @str1 and @str2 like strcmp(). Handles %NULL + Compares @str1 and @str2 like strcmp(). Handles %NULL gracefully by sorting it before non-%NULL strings. Comparing two %NULL pointers returns 0. - + - an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2. + an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2. - - a C string or %NULL + + a C string or %NULL - - another C string or %NULL + + another C string or %NULL - Replaces all escaped characters with their one byte equivalent. + Replaces all escaped characters with their one byte equivalent. This function does the reverse conversion of g_strescape(). - a newly-allocated copy of @source with all escaped + a newly-allocated copy of @source with all escaped character compressed - a string to compress + a string to compress - Concatenates all of the given strings into one long string. The + Concatenates all of the given strings into one long string. The returned string should be freed with g_free() when no longer needed. The variable argument list must end with %NULL. If you forget the %NULL, @@ -71330,39 +52510,35 @@ assemble a translated message from pieces, since proper translation often requires the pieces to be reordered. - a newly-allocated string containing all the string arguments + a newly-allocated string containing all the string arguments - the first string to add, which must not be %NULL + the first string to add, which must not be %NULL - a %NULL-terminated list of strings to append to the string + a %NULL-terminated list of strings to append to the string - Converts any delimiter characters in @string to @new_delimiter. + Converts any delimiter characters in @string to @new_delimiter. + Any characters in @string which are found in @delimiters are changed to the @new_delimiter character. Modifies @string in place, -and returns @string itself, not a copy. The return value is to -allow nesting such as +and returns @string itself, not a copy. + +The return value is to allow nesting such as: + |[<!-- language="C" --> g_ascii_strup (g_strdelimit (str, "abc", '?')) ]| -In order to modify a copy, you may use `g_strdup()`: +In order to modify a copy, you may use g_strdup(): + |[<!-- language="C" --> reformatted = g_strdelimit (g_strdup (const_str), "abc", '?'); ... @@ -71370,93 +52546,60 @@ In order to modify a copy, you may use `g_strdup()`: ]| - @string + the modified @string - the string to convert + the string to convert - - a string containing the current delimiters, + + a string containing the current delimiters, or %NULL to use the standard delimiters defined in #G_STR_DELIMITERS - the new delimiter character + the new delimiter character - - Converts a string to lower case. + + Converts a string to lower case. This function is totally broken for the reasons discussed in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown() instead. - the string + the string - the string to convert. + the string to convert. - Duplicates a string. If @str is %NULL it returns %NULL. + Duplicates a string. If @str is %NULL it returns %NULL. The returned string should be freed with g_free() when no longer needed. - a newly-allocated copy of @str + a newly-allocated copy of @str - - the string to duplicate + + the string to duplicate - - Similar to the standard C sprintf() function but safer, since it + + Similar to the standard C sprintf() function but safer, since it calculates the maximum space required and allocates memory to hold the result. The returned string should be freed with g_free() when no longer needed. @@ -71466,33 +52609,23 @@ contains `%lc` or `%ls` conversions, which can fail if no multibyte representation is available for the given character. - a newly-allocated string holding the result + a newly-allocated string holding the result - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the parameters to insert into the format string + the parameters to insert into the format string - - Similar to the standard C vsprintf() function but safer, since it + + Similar to the standard C vsprintf() function but safer, since it calculates the maximum space required and allocates memory to hold the result. The returned string should be freed with g_free() when no longer needed. @@ -71505,59 +52638,42 @@ See also g_vasprintf(), which offers the same functionality, but additionally returns the length of the allocated string. - a newly-allocated string holding the result + a newly-allocated string holding the result - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of parameters to insert into the format string + the list of parameters to insert into the format string - Copies %NULL-terminated array of strings. The copy is a deep copy; + Copies %NULL-terminated array of strings. The copy is a deep copy; the new array should be freed by first freeing each string, then the array itself. g_strfreev() does this for you. If called on a %NULL value, g_strdupv() simply returns %NULL. - + - a new %NULL-terminated array of strings. + a new %NULL-terminated array of strings. - - a %NULL-terminated array of strings + + a %NULL-terminated array of strings - Returns a string corresponding to the given error code, e.g. "no + Returns a string corresponding to the given error code, e.g. "no such process". Unlike strerror(), this always returns a string in UTF-8 encoding, and the pointer is guaranteed to remain valid for the lifetime of the process. @@ -71577,26 +52693,20 @@ as soon as the call returns: ]| - a UTF-8 string describing the error code. If the error code + a UTF-8 string describing the error code. If the error code is unknown, it returns a string like "unknown error (<code>)". - the system error number. See the standard C %errno + the system error number. See the standard C %errno documentation - Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\' + Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\' and '"' in the string @source by inserting a '\' before them. Additionally all characters in the range 0x01-0x1F (everything below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are @@ -71606,57 +52716,39 @@ Characters supplied in @exceptions are not escaped. g_strcompress() does the reverse conversion. - a newly-allocated copy of @source with certain + a newly-allocated copy of @source with certain characters escaped. See above. - a string to escape + a string to escape - - a string of characters not to escape in @source + + a string of characters not to escape in @source - Frees a %NULL-terminated array of strings, as well as each + Frees a %NULL-terminated array of strings, as well as each string it contains. If @str_array is %NULL, this function simply returns. - + - - a %NULL-terminated array of strings to free + + a %NULL-terminated array of strings to free - String chunks are used to store groups of strings. Memory is + String chunks are used to store groups of strings. Memory is allocated in blocks, and as strings are added to the #GStringChunk they are copied into the next free position in a block. When a block is full a new block is allocated. @@ -71679,90 +52771,8 @@ g_string_chunk_insert_const(). To free the entire #GStringChunk use g_string_chunk_free(). It is not possible to free individual strings. - - Creates a new #GString, initialized with the given string. - - - the new #GString - - - - - the initial text to copy into the string, or %NULL to -start with an empty string - - - - - - Creates a new #GString with @len bytes of the @init buffer. -Because a length is provided, @init need not be nul-terminated, -and can contain embedded nul bytes. - -Since this function does not stop at nul bytes, it is the caller's -responsibility to ensure that @init has at least @len addressable -bytes. - - - a new #GString - - - - - initial contents of the string - - - - length of @init to use - - - - - - Creates a new #GString, with enough space for @dfl_size -bytes. This is useful if you are going to add a lot of -text to the string and don't want it to be reallocated -too often. - - - the new #GString - - - - - the default size of the space allocated to - hold the string - - - - - This section describes a number of utility functions for creating, + This section describes a number of utility functions for creating, duplicating, and manipulating strings. Note that the functions g_printf(), g_fprintf(), g_sprintf(), @@ -71795,9 +52805,7 @@ should be used instead of `%llu` or similar parameters for formatting [Basic Types][glib-Basic-Types]. - A #GString is an object that handles the memory management of a C + A #GString is an object that handles the memory management of a C string for you. The emphasis of #GString is on text, typically UTF-8. Crucially, the "str" member of a #GString is guaranteed to have a trailing nul character, and it is therefore always safe to @@ -71809,110 +52817,76 @@ characters in the data. Conceptually then, #GString is like a #GByteArray with the addition of many convenience methods for text, and a guaranteed nul terminator. - - An auxiliary function for gettext() support (see Q_()). + + An auxiliary function for gettext() support (see Q_()). - @msgval, unless @msgval is identical to @msgid + @msgval, unless @msgval is identical to @msgid and contains a '|' character, in which case a pointer to the substring of msgid after the first '|' character is returned. - a string + a string - another string + another string - Joins a number of strings together to form one long string, with the + Joins a number of strings together to form one long string, with the optional @separator inserted between each of them. The returned string should be freed with g_free(). - a newly-allocated string containing all of the strings joined + a newly-allocated string containing all of the strings joined together, with @separator between them - - a string to insert between each of the + + a string to insert between each of the strings, or %NULL - a %NULL-terminated list of strings to join + a %NULL-terminated list of strings to join - Joins a number of strings together to form one long string, with the + Joins a number of strings together to form one long string, with the optional @separator inserted between each of them. The returned string should be freed with g_free(). If @str_array has no items, the return value will be an empty string. If @str_array contains a single item, @separator will not appear in the resulting string. - + - a newly-allocated string containing all of the strings joined + a newly-allocated string containing all of the strings joined together, with @separator between them - - a string to insert between each of the + + a string to insert between each of the strings, or %NULL - a %NULL-terminated array of strings to join + a %NULL-terminated array of strings to join - Portability wrapper that calls strlcat() on systems which have it, + Portability wrapper that calls strlcat() on systems which have it, and emulates it otherwise. Appends nul-terminated @src string to @dest, guaranteeing nul-termination for @dest. The total size of @dest won't exceed @dest_size. @@ -71927,39 +52901,29 @@ Caveat: this is supposedly a more secure alternative to strcat() or strncat(), but for real security g_strconcat() is harder to mess up. - size of attempted result, which is MIN (dest_size, strlen + size of attempted result, which is MIN (dest_size, strlen (original dest)) + strlen (src), so if retval >= dest_size, truncation occurred. - destination buffer, already containing one nul-terminated string + destination buffer, already containing one nul-terminated string - source buffer + source buffer - length of @dest buffer in bytes (not length of existing string + length of @dest buffer in bytes (not length of existing string inside @dest) - Portability wrapper that calls strlcpy() on systems which have it, + Portability wrapper that calls strlcpy() on systems which have it, and emulates strlcpy() otherwise. Copies @src to @dest; @dest is guaranteed to be nul-terminated; @src must be nul-terminated; @dest_size is the buffer size, not the number of bytes to copy. @@ -71975,39 +52939,26 @@ but if you really want to avoid screwups, g_strdup() is an even better idea. - length of @src + length of @src - destination buffer + destination buffer - source buffer + source buffer - length of @dest in bytes + length of @dest in bytes - - A case-insensitive string comparison, corresponding to the standard + + A case-insensitive string comparison, corresponding to the standard strncasecmp() function on platforms which support it. It is similar to g_strcasecmp() except it only compares the first @n characters of the strings. @@ -72027,37 +52978,27 @@ the strings. which is good for case-insensitive sorting of UTF-8. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - a string + a string - a string to compare with @s1 + a string to compare with @s1 - the maximum number of characters to compare + the maximum number of characters to compare - Duplicates the first @n bytes of a string, returning a newly-allocated + Duplicates the first @n bytes of a string, returning a newly-allocated buffer @n + 1 bytes long which will always be nul-terminated. If @str is less than @n bytes long the buffer is padded with nuls. If @str is %NULL it returns %NULL. The returned value should be freed when no longer @@ -72067,58 +53008,42 @@ To copy a number of characters from a UTF-8 encoded string, use g_utf8_strncpy() instead. - a newly-allocated buffer containing the first @n bytes + a newly-allocated buffer containing the first @n bytes of @str, nul-terminated - the string to duplicate + the string to duplicate - the maximum number of bytes to copy from @str + the maximum number of bytes to copy from @str - Creates a new string @length bytes long filled with @fill_char. + Creates a new string @length bytes long filled with @fill_char. The returned string should be freed when no longer needed. - a newly-allocated string filled the @fill_char + a newly-allocated string filled the @fill_char - the length of the new string + the length of the new string - the byte to fill the string with + the byte to fill the string with - Reverses all of the bytes in a string. For example, + Reverses all of the bytes in a string. For example, `g_strreverse ("abcdef")` will result in "fedcba". Note that g_strreverse() doesn't work on UTF-8 strings @@ -72126,111 +53051,82 @@ containing multibyte characters. For that purpose, use g_utf8_strreverse(). - the same pointer passed in as @string + the same pointer passed in as @string - the string to reverse + the string to reverse - Searches the string @haystack for the last occurrence + Searches the string @haystack for the last occurrence of the string @needle. - a pointer to the found occurrence, or + a pointer to the found occurrence, or %NULL if not found. - a nul-terminated string + a nul-terminated string - the nul-terminated string to search for + the nul-terminated string to search for - Searches the string @haystack for the last occurrence + Searches the string @haystack for the last occurrence of the string @needle, limiting the length of the search to @haystack_len. - a pointer to the found occurrence, or + a pointer to the found occurrence, or %NULL if not found. - a nul-terminated string + a nul-terminated string - the maximum length of @haystack + the maximum length of @haystack in bytes. A length of -1 + can be used to mean "search the entire string", like g_strrstr(). - the nul-terminated string to search for + the nul-terminated string to search for - Returns a string describing the given signal, e.g. "Segmentation fault". + Returns a string describing the given signal, e.g. "Segmentation fault". You should use this function in preference to strsignal(), because it returns a string in UTF-8 encoding, and since not all platforms support the strsignal() function. - a UTF-8 string describing the signal. If the signal is unknown, + a UTF-8 string describing the signal. If the signal is unknown, it returns "unknown signal (<signum>)". - the signal number. See the `signal` documentation + the signal number. See the `signal` documentation - Splits a string into a maximum of @max_tokens pieces, using the given + Splits a string into a maximum of @max_tokens pieces, using the given @delimiter. If @max_tokens is reached, the remainder of @string is appended to the last token. @@ -72244,11 +53140,9 @@ special case is that being able to represent an empty vector is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling g_strsplit(). - + - a newly-allocated %NULL-terminated array of strings. Use + a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -72256,35 +53150,24 @@ before calling g_strsplit(). - a string to split + a string to split - a string which specifies the places at which to split + a string which specifies the places at which to split the string. The delimiter is not included in any of the resulting strings, unless @max_tokens is reached. - the maximum number of pieces to split @string into. + the maximum number of pieces to split @string into. If this is less than 1, the string is split completely. - - Splits @string into a number of tokens not containing any of the characters + + Splits @string into a number of tokens not containing any of the characters in @delimiter. A token is the (possibly empty) longest string that does not contain any of the characters in @delimiters. If @max_tokens is reached, the remainder is appended to the last token. @@ -72305,11 +53188,9 @@ before calling g_strsplit_set(). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. - + - a newly-allocated %NULL-terminated array of strings. Use + a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -72317,85 +53198,60 @@ to delimit UTF-8 strings for anything but ASCII characters. - The string to be tokenized + The string to be tokenized - A nul-terminated string containing bytes that are used + A nul-terminated string containing bytes that are used to split the string (it can accept an empty string, which will result in no string splitting). - The maximum number of tokens to split @string into. + The maximum number of tokens to split @string into. If this is less than 1, the string is split completely - Searches the string @haystack for the first occurrence + Searches the string @haystack for the first occurrence of the string @needle, limiting the length of the search to @haystack_len. - a pointer to the found occurrence, or + a pointer to the found occurrence, or %NULL if not found. - a string + a nul-terminated string - the maximum length of @haystack. Note that -1 is - a valid length, if @haystack is nul-terminated, meaning it will - search through the whole string. + the maximum length of @haystack in bytes. A length of -1 + can be used to mean "search the entire string", like `strstr()`. - the string to search for + the string to search for - - Removes leading and trailing whitespace from a string. + + Removes leading and trailing whitespace from a string. See g_strchomp() and g_strchug(). - a string to remove the leading and trailing whitespace from + a string to remove the leading and trailing whitespace from - Converts a string to a #gdouble value. + Converts a string to a #gdouble value. It calls the standard strtod() function to handle the conversion, but if the string is not completely converted it attempts the conversion again with g_ascii_strtod(), and returns the best match. @@ -72408,197 +53264,132 @@ separated lists of values, since the commas may be interpreted as a decimal point in some locales, causing unexpected results. - the #gdouble value. + the #gdouble value. - the string to convert to a numeric value. + the string to convert to a numeric value. - - if non-%NULL, it returns the + + if non-%NULL, it returns the character after the last character used in the conversion. - - Converts a string to upper case. + + Converts a string to upper case. This function is totally broken for the reasons discussed in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead. - the string + the string - the string to convert + the string to convert - - Checks if @strv contains @str. @strv must not be %NULL. - + + Checks if @strv contains @str. @strv must not be %NULL. + - %TRUE if @str is an element of @strv, according to g_str_equal(). + %TRUE if @str is an element of @strv, according to g_str_equal(). - a %NULL-terminated array of strings + a %NULL-terminated array of strings - a string + a string - Checks if @strv1 and @strv2 contain exactly the same elements in exactly the + Checks if @strv1 and @strv2 contain exactly the same elements in exactly the same order. Elements are compared using g_str_equal(). To match independently of order, sort the arrays first (using g_qsort_with_data() or similar). Two empty arrays are considered equal. Neither @strv1 not @strv2 may be %NULL. - + - %TRUE if @strv1 and @strv2 are equal + %TRUE if @strv1 and @strv2 are equal - a %NULL-terminated array of strings + a %NULL-terminated array of strings - another %NULL-terminated array of strings + another %NULL-terminated array of strings - + - Returns the length of the given %NULL-terminated + Returns the length of the given %NULL-terminated string array @str_array. @str_array must not be %NULL. - + - length of @str_array. + length of @str_array. - a %NULL-terminated array of strings + a %NULL-terminated array of strings - - Hook up a new test case at @testpath, similar to g_test_add_func(). + + Hook up a new test case at @testpath, similar to g_test_add_func(). A fixture data structure with setup and teardown functions may be provided, similar to g_test_create_case(). g_test_add() is implemented as a macro, so that the fsetup(), ftest() and fteardown() callbacks can expect a @Fixture pointer as their first argument in a type safe manner. They otherwise have type #GTestFixtureFunc. - + - The test path for a new test case. + The test path for a new test case. - The type of a fixture data structure. + The type of a fixture data structure. - Data argument for the test functions. + Data argument for the test functions. - The function to set up the fixture data. + The function to set up the fixture data. - The actual test function. + The actual test function. - The function to tear down the fixture data. + The function to tear down the fixture data. - - Create a new test case, similar to g_test_create_case(). However + + Create a new test case, similar to g_test_create_case(). However the test is assumed to use no fixture, and test suites are automatically created on the fly and added to the root fixture, based on the slash-separated portions of @testpath. The @test_data argument @@ -72610,87 +53401,54 @@ required via the `-p` command-line option or g_test_trap_subprocess(). No component of @testpath may start with a dot (`.`) if the %G_TEST_OPTION_ISOLATE_DIRS option is being used; and it is recommended to -do so even if it isn’t. - +do so even if it isn’t. + - /-separated test case path name for the test. + /-separated test case path name for the test. - - Test data argument for the test function. + + Test data argument for the test function. - The test function to invoke for this test. + The test function to invoke for this test. - - Create a new test case, as with g_test_add_data_func(), but freeing + + Create a new test case, as with g_test_add_data_func(), but freeing @test_data after the test run is complete. - + - /-separated test case path name for the test. + /-separated test case path name for the test. - - Test data argument for the test function. + + Test data argument for the test function. - - The test function to invoke for this test. + + The test function to invoke for this test. - - #GDestroyNotify for @test_data. + + #GDestroyNotify for @test_data. - - Create a new test case, similar to g_test_create_case(). However + + Create a new test case, similar to g_test_create_case(). However the test is assumed to use no fixture, and test suites are automatically created on the fly and added to the root fixture, based on the slash-separated portions of @testpath. @@ -72701,30 +53459,24 @@ required via the `-p` command-line option or g_test_trap_subprocess(). No component of @testpath may start with a dot (`.`) if the %G_TEST_OPTION_ISOLATE_DIRS option is being used; and it is recommended to -do so even if it isn’t. - +do so even if it isn’t. + - /-separated test case path name for the test. + /-separated test case path name for the test. - The test function to invoke for this test. + The test function to invoke for this test. - - + + @@ -72735,10 +53487,7 @@ do so even if it isn’t. - + @@ -72752,9 +53501,8 @@ do so even if it isn’t. - - + + @@ -72774,35 +53522,31 @@ do so even if it isn’t. - This function adds a message to test reports that + This function adds a message to test reports that associates a bug URI with a test case. + Bug URIs are constructed from a base URI set with g_test_bug_base() and @bug_uri_snippet. If g_test_bug_base() has not been called, it is assumed to be the empty string, so a full URI can be provided to -g_test_bug() instead. +g_test_bug() instead. + +Since GLib 2.70, the base URI is not prepended to @bug_uri_snippet if it +is already a valid URI. See also: g_test_summary() - + - Bug specific bug tracker URI portion. + Bug specific bug tracker URI or URI portion. - - Specify the base URI for bug reports. + + Specify the base URI for bug reports. The base URI is used to construct bug report messages for g_test_message() when g_test_bug() is called. @@ -72812,30 +53556,23 @@ a test case changes the base URI for the scope of the test case only. Bug URIs are constructed by appending a bug specific URI portion to @uri_pattern, or by replacing the special string -'\%s' within @uri_pattern if that is present. +`%s` within @uri_pattern if that is present. If g_test_bug_base() is not called, bug URIs are formed solely from the value provided by g_test_bug(). - + - the base pattern for bug URIs + the base pattern for bug URIs - - Creates the pathname to a data file that is required for a test. + + Creates the pathname to a data file that is required for a test. This function is conceptually similar to g_build_filename() except that the first argument has been replaced with a #GTestFileType @@ -72857,41 +53594,28 @@ This allows for casual running of tests directly from the commandline in the srcdir == builddir case and should also support running of installed tests, assuming the data files have been installed in the same relative path as the test binary. - + - the path of the file, to be freed using g_free() + the path of the file, to be freed using g_free() - the type of file (built vs. distributed) + the type of file (built vs. distributed) - the first segment of the pathname + the first segment of the pathname - %NULL-terminated additional path segments + %NULL-terminated additional path segments - - Create a new #GTestCase, named @test_name. + + Create a new #GTestCase, named @test_name. This API is fairly low level, and calling g_test_add() or g_test_add_func() is preferable. @@ -72908,86 +53632,54 @@ fixture teardown is most useful if the same fixture type is used for multiple tests. In this cases, g_test_create_case() will be called with the same type of fixture (the @data_size argument), but varying @test_name and @data_test arguments. - + - a newly allocated #GTestCase. + a newly allocated #GTestCase. - the name for the test case + the name for the test case - the size of the fixture data structure + the size of the fixture data structure - - test data argument for the test functions + + test data argument for the test functions - the function to set up the fixture data + the function to set up the fixture data - the actual test function + the actual test function - - the function to teardown the fixture data + + the function to teardown the fixture data - - Create a new test suite with the name @suite_name. - + + Create a new test suite with the name @suite_name. + - A newly allocated #GTestSuite instance. + A newly allocated #GTestSuite instance. - a name for the suite + a name for the suite - - Indicates that a message with the given @log_domain and @log_level, + + Indicates that a message with the given @log_domain and @log_level, with text matching @pattern, is expected to be logged. When this message is logged, it will not be printed, and the test case will not abort. @@ -73021,38 +53713,27 @@ abort; use g_test_trap_subprocess() in this case. If messages at %G_LOG_LEVEL_DEBUG are emitted, but not explicitly expected via g_test_expect_message() then they will be ignored. - + - - the log domain of the message + + the log domain of the message - the log level of the message + the log level of the message - a glob-style [pattern][glib-Glob-style-pattern-matching] + a glob-style [pattern][glib-Glob-style-pattern-matching] - Indicates that a test failed. This function can be called + Indicates that a test failed. This function can be called multiple times from the same test. You can use this function if your test failed in a recoverable way. @@ -73064,16 +53745,38 @@ need to return from the test function yourself. So you can produce additional diagnostic messages or even continue running the test. -If not called from inside a test, this function does nothing. - +If not called from inside a test, this function does nothing. + +Note that unlike g_test_skip() and g_test_incomplete(), this +function does not log a message alongside the test failure. +If details of the test failure are available, either log them with +g_test_message() before g_test_fail(), or use g_test_fail_printf() +instead. + + + Equivalent to g_test_fail(), but also record a message like +g_test_skip_printf(). + + + + + + + the format string + + + + printf-like arguments to @format + + + + - Returns whether a test has already failed. This will + Returns whether a test has already failed. This will be the case when g_test_fail(), g_test_incomplete() or g_test_skip() have been called, but also if an assertion has failed. @@ -73083,45 +53786,32 @@ continuing after a failed assertion might be harmful. The return value of this function is only meaningful if it is called from inside a test function. - + - %TRUE if the test has failed + %TRUE if the test has failed - Gets the pathname of the directory containing test files of the type + Gets the pathname of the directory containing test files of the type specified by @file_type. This is approximately the same as calling g_test_build_filename("."), but you don't need to free the return value. - + - the path of the directory, owned by GLib + the path of the directory, owned by GLib - the type of file (built vs. distributed) + the type of file (built vs. distributed) - - Gets the pathname to a data file that is required for a test. + + Gets the pathname to a data file that is required for a test. This is the same as g_test_build_filename() with two differences. The first difference is that must only use this function from within @@ -73133,55 +53823,49 @@ It is safe to use this function from a thread inside of a testcase but you must ensure that all such uses occur before the main testcase function returns (ie: it is best to ensure that all threads have been joined). - + - the path, automatically freed at the end of the testcase + the path, automatically freed at the end of the testcase - the type of file (built vs. distributed) + the type of file (built vs. distributed) - the first segment of the pathname + the first segment of the pathname - %NULL-terminated additional path segments + %NULL-terminated additional path segments - - Get the toplevel test suite for the test path API. - + + Gets the test path for the test currently being run. + +In essence, it will be the same string passed as the first argument to +e.g. g_test_add() when the test was added. + +This function returns a valid string only within a test function. + + + the test path for the test currently being run + + + + + Get the toplevel test suite for the test path API. + - the toplevel #GTestSuite + the toplevel #GTestSuite - - Indicates that a test failed because of some incomplete + + Indicates that a test failed because of some incomplete functionality. This function can be called multiple times from the same test. @@ -73191,29 +53875,37 @@ produce additional diagnostic messages or even continue running the test. If not called from inside a test, this function does nothing. - + - - explanation + + explanation - - Initialize the GLib testing framework, e.g. by seeding the + + Equivalent to g_test_incomplete(), but the explanation is formatted +as if by g_strdup_printf(). + + + + + + + the format string + + + + printf-like arguments to @format + + + + + + Initialize the GLib testing framework, e.g. by seeding the test random number generator, the name for g_get_prgname() and parsing test related command line args. @@ -73258,40 +53950,29 @@ g_test_init() will print an error and exit. This is to prevent no-op tests from being executed, as g_assert() is commonly (erroneously) used in unit tests, and is a no-op when compiled with `G_DISABLE_ASSERT`. Ensure your tests are compiled without `G_DISABLE_ASSERT` defined. - + - Address of the @argc parameter of the main() function. + Address of the @argc parameter of the main() function. Changed if any arguments were handled. - Address of the @argv parameter of main(). + Address of the @argv parameter of main(). Any parameters understood by g_test_init() stripped before return. - %NULL-terminated list of special options, documented below. + %NULL-terminated list of special options, documented below. - - Installs a non-error fatal log handler which can be + + Installs a non-error fatal log handler which can be used to decide whether log messages which are counted as fatal abort the program. @@ -73312,30 +53993,23 @@ g_log_structured() or g_log_structured_array()). To change the fatal behaviour for specific log messages, programs must install a custom log writer function using g_log_set_writer_func().See [Using Structured Logging][using-structured-logging]. - + - the log handler function. + the log handler function. - - data passed to the log handler. + + data passed to the log handler. - + @@ -73345,229 +54019,151 @@ writer function using g_log_set_writer_func().See - - Report the result of a performance or measurement test. + + Report the result of a performance or measurement test. The test should generally strive to maximize the reported quantities (larger values are better than smaller ones), this and @maximized_quantity can determine sorting order for test result reports. - + - the reported value + the reported value - the format string of the report message + the format string of the report message - arguments to pass to the printf() function + arguments to pass to the printf() function - - Add a message to the test report. - + + Add a message to the test report. + - the format string + the format string - printf-like arguments to @format + printf-like arguments to @format - - Report the result of a performance or measurement test. + + Report the result of a performance or measurement test. The test should generally strive to minimize the reported quantities (smaller values are better than larger ones), this and @minimized_quantity can determine sorting order for test result reports. - + - the reported value + the reported value - the format string of the report message + the format string of the report message - arguments to pass to the printf() function + arguments to pass to the printf() function - - This function enqueus a callback @destroy_func to be executed + + This function enqueus a callback @destroy_func to be executed during the next test case teardown phase. This is most useful to auto destruct allocated test resources at the end of a test run. Resources are released in reverse queue order, that means enqueueing callback A before callback B will cause B() to be called before A() during teardown. - + - Destroy callback for teardown phase. + Destroy callback for teardown phase. - - Destroy callback data. + + Destroy callback data. - - Enqueue a pointer to be released with g_free() during the next + + Enqueue a pointer to be released with g_free() during the next teardown phase. This is equivalent to calling g_test_queue_destroy() with a destroy callback of g_free(). - + - - the pointer to be stored. + + the pointer to be stored. - - Enqueue an object to be released with g_object_unref() during + + Enqueue an object to be released with g_object_unref() during the next teardown phase. This is equivalent to calling g_test_queue_destroy() with a destroy callback of g_object_unref(). - + - the object to unref + the object to unref - - Get a reproducible random floating point number, + + Get a reproducible random floating point number, see g_test_rand_int() for details on test case random numbers. - + - a random number from the seeded random number generator. + a random number from the seeded random number generator. - - Get a reproducible random floating pointer number out of a specified range, + + Get a reproducible random floating pointer number out of a specified range, see g_test_rand_int() for details on test case random numbers. - + - a number with @range_start <= number < @range_end. + a number with @range_start <= number < @range_end. - the minimum value returned by this function + the minimum value returned by this function - the minimum value not returned by this function + the minimum value not returned by this function - - Get a reproducible random integer number. + + Get a reproducible random integer number. The random numbers generated by the g_test_rand_*() family of functions change with every new test program start, unless the --seed option is @@ -73576,47 +54172,33 @@ given when starting test programs. For individual test cases however, the random number generator is reseeded, to avoid dependencies between tests and to make --seed effective for all test cases. - + - a random number from the seeded random number generator. + a random number from the seeded random number generator. - - Get a reproducible random integer number out of a specified range, + + Get a reproducible random integer number out of a specified range, see g_test_rand_int() for details on test case random numbers. - + - a number with @begin <= number < @end. + a number with @begin <= number < @end. - the minimum value returned by this function + the minimum value returned by this function - the smallest value not to be returned by this function + the smallest value not to be returned by this function - Runs all tests under the toplevel suite which can be retrieved + Runs all tests under the toplevel suite which can be retrieved with g_test_get_root(). Similar to g_test_run_suite(), the test cases to be run are filtered according to test path arguments (`-p testpath` and `-s testpath`) as parsed by g_test_init(). @@ -73648,22 +54230,16 @@ g_test_add(), which lets you specify setup and teardown functions. If all tests are skipped or marked as incomplete (expected failures), this function will return 0 if producing TAP output, or 77 (treated as "skip test" by Automake) otherwise. - + - 0 on success, 1 on failure (assuming it returns at all), + 0 on success, 1 on failure (assuming it returns at all), 0 or 77 if all tests were skipped with g_test_skip() and/or g_test_incomplete() - - Execute the tests within @suite and all nested #GTestSuites. + + Execute the tests within @suite and all nested #GTestSuites. The test suites to be executed are filtered according to test path arguments (`-p testpath` and `-s testpath`) as parsed by g_test_init(). See the g_test_run() documentation for more @@ -73671,28 +54247,20 @@ information on the order that tests are run in. g_test_run_suite() or g_test_run() may only be called once in a program. - + - 0 on success + 0 on success - a #GTestSuite + a #GTestSuite - - Changes the behaviour of the various `g_assert_*()` macros, + + Changes the behaviour of the various `g_assert_*()` macros, g_test_assert_expected_messages() and the various `g_test_trap_assert_*()` macros to not abort to program, but instead call g_test_fail() and continue. (This also changes the behavior of @@ -73703,15 +54271,13 @@ Note that the g_assert_not_reached() and g_assert() macros are not affected by this. This function can only be called after g_test_init(). - + - Indicates that a test was skipped. + Indicates that a test was skipped. Calling this function will not stop the test from running, you need to return from the test function yourself. So you can @@ -73719,42 +54285,47 @@ produce additional diagnostic messages or even continue running the test. If not called from inside a test, this function does nothing. - + - - explanation + + explanation - - Returns %TRUE (after g_test_init() has been called) if the test -program is running under g_test_trap_subprocess(). - + + Equivalent to g_test_skip(), but the explanation is formatted +as if by g_strdup_printf(). + - %TRUE if the test program is running under + + + + + the format string + + + + printf-like arguments to @format + + + + + + Returns %TRUE (after g_test_init() has been called) if the test +program is running under g_test_trap_subprocess(). + + + %TRUE if the test program is running under g_test_trap_subprocess(). - Set the summary for a test, which describes what the test checks, and how it + Set the summary for a test, which describes what the test checks, and how it goes about checking it. This may be included in test report output, and is useful documentation for anyone reading the source code or modifying a test in future. It must be a single line. @@ -73769,72 +54340,49 @@ test_array_sort (void) g_test_summary ("Test my_array_sort() sorts the array correctly and stably, " "including testing zero length and one-element arrays."); - … + … } ]| See also: g_test_bug() - + - One or two sentences summarising what the test checks, and how it + One or two sentences summarising what the test checks, and how it checks it. - - Get the time since the last start of the timer with g_test_timer_start(). - + + Get the time since the last start of the timer with g_test_timer_start(). + - the time since the last start of the timer, as a double + the time since the last start of the timer, as a double - - Report the last result of g_test_timer_elapsed(). - + + Report the last result of g_test_timer_elapsed(). + - the last result of g_test_timer_elapsed(), as a double + the last result of g_test_timer_elapsed(), as a double - - Start a timing test. Call g_test_timer_elapsed() when the task is supposed + + Start a timing test. Call g_test_timer_elapsed() when the task is supposed to be done. Call this function again to restart the timer. - + - - Assert that the stderr output of the last test subprocess + + Assert that the stderr output of the last test subprocess matches @serrpattern. See g_test_trap_subprocess(). This is sometimes used to test situations that are formally @@ -73843,69 +54391,45 @@ g_assert() or g_error(). In these situations you should skip the entire test, including the call to g_test_trap_subprocess(), unless g_test_undefined() returns %TRUE to indicate that undefined behaviour may be tested. - + - a glob-style [pattern][glib-Glob-style-pattern-matching] + a glob-style [pattern][glib-Glob-style-pattern-matching] - - Assert that the stderr output of the last test subprocess + + Assert that the stderr output of the last test subprocess does not match @serrpattern. See g_test_trap_subprocess(). - + - a glob-style [pattern][glib-Glob-style-pattern-matching] + a glob-style [pattern][glib-Glob-style-pattern-matching] - - Assert that the stdout output of the last test subprocess matches + + Assert that the stdout output of the last test subprocess matches @soutpattern. See g_test_trap_subprocess(). - + - a glob-style [pattern][glib-Glob-style-pattern-matching] + a glob-style [pattern][glib-Glob-style-pattern-matching] - - Assert that the stdout output of the last test subprocess + + Assert that the stdout output of the last test subprocess does not match @soutpattern. See g_test_trap_subprocess(). - + - a glob-style [pattern][glib-Glob-style-pattern-matching] + a glob-style [pattern][glib-Glob-style-pattern-matching] - - + + @@ -73930,13 +54454,8 @@ does not match @soutpattern. See g_test_trap_subprocess(). - - Fork the current test program to execute a test case that might + + Fork the current test program to execute a test case that might not return or that might abort. If @usec_timeout is non-0, the forked test case is aborted and @@ -73967,62 +54486,40 @@ termination and validates child program outputs. This function is implemented only on Unix platforms, and is not always reliable due to problems inherent in fork-without-exec. Use g_test_trap_subprocess() instead. - + - %TRUE for the forked child and %FALSE for the executing parent process. + %TRUE for the forked child and %FALSE for the executing parent process. - Timeout for the forked test in micro seconds. + Timeout for the forked test in micro seconds. - Flags to modify forking behaviour. + Flags to modify forking behaviour. - - Check the result of the last g_test_trap_subprocess() call. - + + Check the result of the last g_test_trap_subprocess() call. + - %TRUE if the last test subprocess terminated successfully. + %TRUE if the last test subprocess terminated successfully. - - Check the result of the last g_test_trap_subprocess() call. - + + Check the result of the last g_test_trap_subprocess() call. + - %TRUE if the last test subprocess got killed due to a timeout. + %TRUE if the last test subprocess got killed due to a timeout. - - Respawns the test program to run only @test_path in a subprocess. + + Respawns the test program to run only @test_path in a subprocess. This can be used for a test case that might not return, or that might abort. @@ -74083,38 +54580,27 @@ message. return g_test_run (); } ]| - + - - Test to run in a subprocess + + Test to run in a subprocess - Timeout for the subprocess test in micro seconds. + Timeout for the subprocess test in micro seconds. - Flags to modify subprocess behaviour. + Flags to modify subprocess behaviour. - GLib provides a framework for writing and maintaining unit tests + GLib provides a framework for writing and maintaining unit tests in parallel to the code they are testing. The API is designed according to established concepts found in the other test frameworks (JUnit, NUnit, RUnit), which in turn is based on smalltalk unit testing concepts. @@ -74291,19 +54777,13 @@ Automake template provided by GLib. Note, however, that since GLib 2.62, in favour of using TAP. The `--tap` argument to tests is enabled by default as of GLib 2.62. - + - - Terminates the current thread. + + Terminates the current thread. If another thread is waiting for us using g_thread_join() then the waiting thread will be woken up and get @retval as the return value @@ -74321,74 +54801,45 @@ or or from within a #GThreadPool. - - the return value of this thread + + the return value of this thread - - This function will return the maximum @interval that a + + This function will return the maximum @interval that a thread will wait in the thread pool for new tasks before being stopped. If this function returns 0, threads waiting in the thread pool for new work are not stopped. - + - the maximum @interval (milliseconds) to wait + the maximum @interval (milliseconds) to wait for new tasks in the thread pool before stopping the thread - - Returns the maximal allowed number of unused threads. - + + Returns the maximal allowed number of unused threads. + - the maximal number of unused threads + the maximal number of unused threads - - Returns the number of currently unused threads. - + + Returns the number of currently unused threads. + - the number of currently unused threads + the number of currently unused threads - - This function will set the maximum @interval that a thread + + This function will set the maximum @interval that a thread waiting in the pool for new tasks can be idle for before being stopped. This function is similar to calling g_thread_pool_stop_unused_threads() on a regular timeout, @@ -74397,60 +54848,46 @@ except this is done on a per thread basis. By setting @interval to 0, idle threads will not be stopped. The default value is 15000 (15 seconds). - + - the maximum @interval (in milliseconds) + the maximum @interval (in milliseconds) a thread can be idle - - Sets the maximal number of unused threads to @max_threads. + + Sets the maximal number of unused threads to @max_threads. If @max_threads is -1, no limit is imposed on the number of unused threads. The default value is 2. - + - maximal number of unused threads + maximal number of unused threads - - Stops all currently unused threads. This does not change the + + Stops all currently unused threads. This does not change the maximal number of unused threads. This function can be used to regularly stop all unused threads e.g. from g_timeout_add(). - + - Sometimes you wish to asynchronously fork out the execution of work + Sometimes you wish to asynchronously fork out the execution of work and continue working in your own thread. If that will happen often, the overhead of starting and destroying a thread each time might be too high. In such cases reusing already started threads seems like a @@ -74480,12 +54917,8 @@ controlled by g_thread_pool_get_max_unused_threads() and g_thread_pool_set_max_unused_threads(). All currently unused threads can be stopped by calling g_thread_pool_stop_unused_threads(). - - This function 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. @@ -74496,18 +54929,12 @@ APIs). This may be useful for thread identification purposes as g_thread_join()) on these threads. - the #GThread representing the current thread + the #GThread representing the current thread - - Causes the calling thread to voluntarily relinquish the CPU, so + + Causes the calling thread to voluntarily relinquish the CPU, so that other threads can run. This function is often used as a method to make busy wait less evil. @@ -74517,9 +54944,7 @@ This function is often used as a method to make busy wait less evil. - Threads act almost like processes, but unlike processes all threads + Threads act almost like processes, but unlike processes all threads of one process share the same memory. This is good, as it provides easy communication between the involved threads via this shared memory, and it is bad, because strange things (so called @@ -74598,7 +55023,7 @@ Most refcounting functions such as g_object_ref() are also thread-safe. A common use for #GThreads is to move a long-running blocking operation out of the main thread and into a worker thread. For GLib functions, such as single GIO operations, this is not necessary, and complicates the code. -Instead, the `…_async()` version of the function should be used from the main +Instead, the `…_async()` version of the function should be used from the main thread, eliminating the need for locking and synchronisation between multiple threads. If an operation does need to be moved to a worker thread, consider using g_task_run_in_thread(), or a #GThreadPool. #GThreadPool is often a @@ -74609,15 +55034,8 @@ However, if multiple blocking operations need to be performed in sequence, and it is not possible to use #GTask for them, moving them to a worker thread can clarify the code. - - Converts a string containing an ISO 8601 encoded date and time + + Converts a string containing an ISO 8601 encoded date and time to a #GTimeVal and puts it into @time_. @iso_date must include year, month, day, hours, minutes, and @@ -74638,40 +55056,28 @@ g_date_time_unref (dt); g_date_time_new_from_iso8601() instead. - %TRUE if the conversion was successful. + %TRUE if the conversion was successful. - an ISO 8601 encoded date string + an ISO 8601 encoded date string - - a #GTimeVal + + a #GTimeVal - - Sets a function to be called at regular intervals, with the default -priority, #G_PRIORITY_DEFAULT. The function is called repeatedly -until it returns %FALSE, at which point the timeout is automatically -destroyed and the function will not be called again. The first call -to the function will be at the end of the first @interval. + + Sets a function to be called at regular intervals, with the default +priority, %G_PRIORITY_DEFAULT. + +The given @function is called repeatedly until it returns %G_SOURCE_REMOVE +or %FALSE, at which point the timeout is automatically destroyed and the +function will not be called again. The first call to the function will be +at the end of the first @interval. Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. @@ -74697,44 +55103,29 @@ It is safe to call this function from any thread. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the time between calls to the function, in milliseconds - (1/1000ths of a second) + the time between calls to the function, in milliseconds + (1/1000ths of a second) - function to call + function to call - - data to pass to @function + + data to pass to @function - - Sets a function to be called at regular intervals, with the given + + Sets a function to be called at regular intervals, with the given priority. The function is called repeatedly until it returns %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. The @notify function is @@ -74758,69 +55149,42 @@ use a custom main context. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the timeout source. Typically this will be in - the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. + the priority of the timeout source. Typically this will be in + the range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH. - the time between calls to the function, in milliseconds - (1/1000ths of a second) + the time between calls to the function, in milliseconds + (1/1000ths of a second) - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the timeout is removed, or %NULL + + function to call when the timeout is removed, or %NULL - - Sets a function to be called at regular intervals with the default -priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until -it returns %FALSE, at which point the timeout is automatically destroyed + + Sets a function to be called at regular intervals with the default +priority, %G_PRIORITY_DEFAULT. + +The function is called repeatedly until it returns %G_SOURCE_REMOVE +or %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. This internally creates a main loop source using @@ -74839,55 +55203,40 @@ on how to handle the return value and memory management of @data. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the time between calls to the function, in seconds + the time between calls to the function, in seconds - function to call + function to call - - data to pass to @function + + data to pass to @function - - Sets a function to be called at regular intervals, with @priority. -The function is called repeatedly until it returns %FALSE, at which -point the timeout is automatically destroyed and the function will -not be called again. + + Sets a function to be called at regular intervals, with @priority. + +The function is called repeatedly until it returns %G_SOURCE_REMOVE +or %FALSE, at which point the timeout is automatically destroyed and +the function will not be called again. Unlike g_timeout_add(), this function operates at whole second granularity. The initial starting point of the timer is determined by the implementation and the implementation is expected to group multiple timers together so that -they fire all at the same time. -To allow this grouping, the @interval to the first timer is rounded -and can deviate up to one second from the specified interval. -Subsequent timer iterations will generally run at the specified interval. +they fire all at the same time. To allow this grouping, the @interval to the +first timer is rounded and can deviate up to one second from the specified +interval. Subsequent timer iterations will generally run at the specified +interval. Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. @@ -74914,62 +55263,37 @@ It is safe to call this function from any thread. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the timeout source. Typically this will be in - the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. + the priority of the timeout source. Typically this will be in + the range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH. - the time between calls to the function, in seconds + the time between calls to the function, in seconds - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the timeout is removed, or %NULL + + function to call when the timeout is removed, or %NULL - Creates a new timeout source. + Creates a new timeout source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be @@ -74977,28 +55301,20 @@ executed. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the newly-created timeout source + the newly-created timeout source - the timeout interval in milliseconds. + the timeout interval in milliseconds. - - Creates a new timeout source. + + Creates a new timeout source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be @@ -75009,47 +55325,39 @@ in seconds. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the newly-created timeout source + the newly-created timeout source - the timeout interval in seconds + the timeout interval in seconds - #GTimer records a start time, and counts microseconds elapsed since + #GTimer records a start time, and counts microseconds elapsed since that time. This is done somewhat differently on different platforms, and can be tricky to get exactly right, so #GTimer provides a portable/convenient interface. - #GTimeZone is a structure that represents a time zone, at no + #GTimeZone is a structure that represents a time zone, at no particular point in time. It is refcounted and immutable. -Each time zone has an identifier (for example, ‘Europe/London’) which is +Each time zone has an identifier (for example, ‘Europe/London’) which is platform dependent. See g_time_zone_new() for information on the identifier formats. The identifier of a time zone can be retrieved using g_time_zone_get_identifier(). A time zone contains a number of intervals. Each interval has -an abbreviation to describe it (for example, ‘PDT’), an offset to UTC and a +an abbreviation to describe it (for example, ‘PDT’), an offset to UTC and a flag indicating if the daylight savings time is in effect during that -interval. A time zone always has at least one interval — interval 0. Note +interval. A time zone always has at least one interval — interval 0. Note that interval abbreviations are not the same as time zone identifiers -(apart from ‘UTC’), and cannot be passed to g_time_zone_new(). +(apart from ‘UTC’), and cannot be passed to g_time_zone_new(). Every UTC time is contained within exactly one interval, but a given local time may be contained within zero, one or two intervals (due to @@ -75065,9 +55373,7 @@ without other properties changing. #GTimeZone is available since GLib 2.26. - A #GTrashStack is an efficient way to keep a stack of unused allocated + A #GTrashStack is an efficient way to keep a stack of unused allocated memory chunks. Each memory chunk is required to be large enough to hold a #gpointer. This allows the stack to be maintained without any space overhead, since the stack pointers can be stored inside the memory chunks. @@ -75078,93 +55384,57 @@ is a perfectly valid empty stack. There is no longer any good reason to use #GTrashStack. If you have extra pieces of memory, free() them and allocate them again later. - - Returns the height of a #GTrashStack. + + Returns the height of a #GTrashStack. Note that execution of this function is of O(N) complexity where N denotes the number of items on the stack. #GTrashStack is deprecated without replacement - the height of the stack + the height of the stack - a #GTrashStack + a #GTrashStack - - Returns the element at the top of a #GTrashStack + + Returns the element at the top of a #GTrashStack which may be %NULL. #GTrashStack is deprecated without replacement - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - - Pops a piece of memory off a #GTrashStack. + + Pops a piece of memory off a #GTrashStack. #GTrashStack is deprecated without replacement - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - - Pushes a piece of memory onto a #GTrashStack. + + Pushes a piece of memory onto a #GTrashStack. #GTrashStack is deprecated without replacement @@ -75172,23 +55442,17 @@ which may be %NULL. - a #GTrashStack + a #GTrashStack - the piece of memory to push on the stack + the piece of memory to push on the stack - The #GTree structure and its associated functions provide a sorted + The #GTree structure and its associated functions provide a sorted collection of key/value pairs optimized for searching and traversing in order. This means that most of the operations (access, search, insertion, deletion, ...) on #GTree are O(log(n)) in average and O(n) @@ -75214,9 +55478,7 @@ the traversal, use g_tree_foreach(). To destroy a #GTree, use g_tree_destroy(). - The #GNode struct and its associated functions provide a N-ary tree + The #GNode struct and its associated functions provide a N-ary tree data structure, where nodes in the tree can contain arbitrary data. To create a new tree use g_node_new(). @@ -75248,257 +55510,170 @@ To remove a node or subtree from a tree use g_node_unlink() or g_node_destroy(). - Attempts to allocate @n_bytes, and returns %NULL on failure. + Attempts to allocate @n_bytes, and returns %NULL on failure. Contrast with g_malloc(), which aborts the program on failure. - + - the allocated memory, or %NULL. + the allocated memory, or %NULL. - number of bytes to allocate. + number of bytes to allocate. - Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on + Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on failure. Contrast with g_malloc0(), which aborts the program on failure. - + - the allocated memory, or %NULL + the allocated memory, or %NULL - number of bytes to allocate + number of bytes to allocate - - This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, + + This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - + - the allocated memory, or %NULL + the allocated memory, or %NULL - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - + - the allocated memory, or %NULL. + the allocated memory, or %NULL. - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - - Attempts to allocate @n_structs elements of type @struct_type, and returns + + Attempts to allocate @n_structs elements of type @struct_type, and returns %NULL on failure. Contrast with g_new(), which aborts the program on failure. The returned pointer is cast to a pointer to the given type. The function returns %NULL when @n_structs is 0 of if an overflow occurs. - + - the type of the elements to allocate + the type of the elements to allocate - the number of elements to allocate + the number of elements to allocate - - Attempts to allocate @n_structs elements of type @struct_type, initialized + + Attempts to allocate @n_structs elements of type @struct_type, initialized to 0's, and returns %NULL on failure. Contrast with g_new0(), which aborts the program on failure. The returned pointer is cast to a pointer to the given type. The function returns %NULL when @n_structs is 0 or if an overflow occurs. - + - the type of the elements to allocate + the type of the elements to allocate - the number of elements to allocate + the number of elements to allocate - Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL + Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL on failure. Contrast with g_realloc(), which aborts the program on failure. If @mem is %NULL, behaves the same as g_try_malloc(). - + - the allocated memory, or %NULL. + the allocated memory, or %NULL. - - previously-allocated memory, or %NULL. + + previously-allocated memory, or %NULL. - number of bytes to allocate. + number of bytes to allocate. - - This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, + + This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - + - the allocated memory, or %NULL. + the allocated memory, or %NULL. - - previously-allocated memory, or %NULL. + + previously-allocated memory, or %NULL. - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - - Attempts to reallocate the memory pointed to by @mem, so that it now has + + Attempts to reallocate the memory pointed to by @mem, so that it now has space for @n_structs elements of type @struct_type, and returns %NULL on failure. Contrast with g_renew(), which aborts the program on failure. It returns the new address of the memory, which may have been moved. The function returns %NULL if an overflow occurs. - + - the type of the elements to allocate + the type of the elements to allocate - the currently allocated memory + the currently allocated memory - the number of elements to allocate + the number of elements to allocate - Many times GLib, GTK+, and other libraries allow you to pass "user + Many times GLib, GTK+, and other libraries allow you to pass "user data" to a callback, in the form of a void pointer. From time to time you want to pass an integer instead of a pointer. You could allocate an integer, with something like: @@ -75534,23 +55709,28 @@ portable in any way, shape or form. These macros only allow storing integers in pointers, and only preserve 32 bits of the integer; values outside the range of a 32-bit integer will be mangled. + + + + + + + - GLib defines a number of commonly used types, which can be divided + GLib defines a number of commonly used types, which can be divided into several groups: - New types which are not part of standard C (but are defined in - various C standard library header files) — #gboolean, #gssize. + various C standard library header files) — #gboolean, #gssize. - Integer types which are guaranteed to be the same size across - all platforms — #gint8, #guint8, #gint16, #guint16, #gint32, + all platforms — #gint8, #guint8, #gint16, #guint16, #gint32, #guint32, #gint64, #guint64. - Types which are easier to use than their standard C counterparts - #gpointer, #gconstpointer, #guchar, #guint, #gushort, #gulong. - Types which correspond exactly to standard C types, but are - included for completeness — #gchar, #gint, #gshort, #glong, + included for completeness — #gchar, #gint, #gshort, #glong, #gfloat, #gdouble. - Types which correspond exactly to standard C99 types, but are available - to use even if your compiler does not support C99 — #gsize, #goffset, + to use even if your compiler does not support C99 — #gsize, #goffset, #gintptr, #guintptr. GLib also defines macros for the limits of some of the standard @@ -75564,55 +55744,33 @@ The format macros will always work with GLib API (like g_print()), and with any C99 compatible printf() implementation. - Convert a string from UCS-4 to UTF-16. A 0 character will be + Convert a string from UCS-4 to UTF-16. A 0 character will be added to the result after the converted text. - + - a pointer to a newly allocated UTF-16 string. + a pointer to a newly allocated UTF-16 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UCS-4 encoded string + a UCS-4 encoded string - the maximum length (number of characters) of @str to use. + the maximum length (number of characters) of @str to use. If @len < 0, then the string is nul-terminated. - - location to store number of + + location to store number of bytes read, or %NULL. If an error occurs then the index of the invalid input is stored here. - - location to store number + + location to store number of #gunichar2 written, or %NULL. The value stored here does not include the trailing 0. @@ -75620,15 +55778,11 @@ added to the result after the converted text. - Convert a string from a 32-bit fixed width representation as UCS-4. + Convert a string from a 32-bit fixed width representation as UCS-4. to UTF-8. The result will be terminated with a 0 byte. - + - a pointer to a newly allocated UTF-8 string. + a pointer to a newly allocated UTF-8 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. In that case, @items_read will be set to the position of the first invalid input character. @@ -75636,52 +55790,29 @@ to UTF-8. The result will be terminated with a 0 byte. - a UCS-4 encoded string + a UCS-4 encoded string - the maximum length (number of characters) of @str to use. + the maximum length (number of characters) of @str to use. If @len < 0, then the string is nul-terminated. - - location to store number of + + location to store number of characters read, or %NULL. - - location to store number + + location to store number of bytes written or %NULL. The value here stored does not include the trailing 0 byte. - - Performs a checked addition of @a and @b, storing the result in + + Performs a checked addition of @a and @b, storing the result in @dest. If the operation is successful, %TRUE is returned. If the operation @@ -75690,29 +55821,18 @@ returned. - a pointer to the #guint64 destination + a pointer to the #guint64 destination - the #guint64 left operand + the #guint64 left operand - the #guint64 right operand + the #guint64 right operand - - Performs a checked multiplication of @a and @b, storing the result in + + Performs a checked multiplication of @a and @b, storing the result in @dest. If the operation is successful, %TRUE is returned. If the operation @@ -75721,29 +55841,18 @@ returned. - a pointer to the #guint64 destination + a pointer to the #guint64 destination - the #guint64 left operand + the #guint64 left operand - the #guint64 right operand + the #guint64 right operand - - Performs a checked addition of @a and @b, storing the result in + + Performs a checked addition of @a and @b, storing the result in @dest. If the operation is successful, %TRUE is returned. If the operation @@ -75752,29 +55861,18 @@ returned. - a pointer to the #guint destination + a pointer to the #guint destination - the #guint left operand + the #guint left operand - the #guint right operand + the #guint right operand - - Performs a checked multiplication of @a and @b, storing the result in + + Performs a checked multiplication of @a and @b, storing the result in @dest. If the operation is successful, %TRUE is returned. If the operation @@ -75783,75 +55881,51 @@ returned. - a pointer to the #guint destination + a pointer to the #guint destination - the #guint left operand + the #guint left operand - the #guint right operand + the #guint right operand - Determines the break type of @c. @c should be a Unicode character + Determines the break type of @c. @c should be a Unicode character (to derive a character from UTF-8 encoded text, use g_utf8_get_char()). The break type is used to find word and line breaks ("text boundaries"), Pango implements the Unicode boundary resolution algorithms and normally you would use a function such as pango_break() instead of caring about break types yourself. - + - the break type of @c + the break type of @c - a Unicode character + a Unicode character - - Determines the canonical combining class of a Unicode character. - + + Determines the canonical combining class of a Unicode character. + - the combining class of the character + the combining class of the character - a Unicode character + a Unicode character - - Performs a single composition step of the + + Performs a single composition step of the Unicode canonical composition algorithm. This function includes algorithmic Hangul Jamo composition, @@ -75867,43 +55941,28 @@ If @a and @b do not compose a new character, @ch is set to zero. See [UAX#15](http://unicode.org/reports/tr15/) for details. - + - %TRUE if the characters could be composed + %TRUE if the characters could be composed - a Unicode character + a Unicode character - a Unicode character + a Unicode character - - return location for the composed character + + return location for the composed character - - Performs a single decomposition step of the + + Performs a single decomposition step of the Unicode canonical decomposition algorithm. This function does not include compatibility @@ -75926,68 +55985,44 @@ g_unichar_fully_decompose(). See [UAX#15](http://unicode.org/reports/tr15/) for details. - + - %TRUE if the character could be decomposed + %TRUE if the character could be decomposed - a Unicode character + a Unicode character - - return location for the first component of @ch + + return location for the first component of @ch - - return location for the second component of @ch + + return location for the second component of @ch - Determines the numeric value of a character as a decimal + Determines the numeric value of a character as a decimal digit. - + - If @c is a decimal digit (according to + If @c is a decimal digit (according to g_unichar_isdigit()), its numeric value. Otherwise, -1. - a Unicode character + a Unicode character - - Computes the canonical or compatibility decomposition of a + + Computes the canonical or compatibility decomposition of a Unicode character. For compatibility decomposition, pass %TRUE for @compat; for canonical decomposition pass %FALSE for @compat. @@ -76006,51 +56041,32 @@ as %G_UNICHAR_MAX_DECOMPOSITION_LENGTH. See [UAX#15](http://unicode.org/reports/tr15/) for details. - + - the length of the full decomposition. + the length of the full decomposition. - a Unicode character. + a Unicode character. - whether perform canonical or compatibility decomposition + whether perform canonical or compatibility decomposition - - location to store decomposed result, or %NULL + + location to store decomposed result, or %NULL - length of @result + length of @result - - In Unicode, some characters are "mirrored". This means that their + + In Unicode, some characters are "mirrored". This means that their images are mirrored horizontally in text that is laid out from right to left. For instance, "(" would become its mirror image, ")", in right-to-left text. @@ -76059,217 +56075,157 @@ If @ch has the Unicode mirrored property and there is another unicode character that typically has a glyph that is the mirror image of @ch's glyph and @mirrored_ch is set, it puts that character in the address pointed to by @mirrored_ch. Otherwise the original character is put. - + - %TRUE if @ch has a mirrored character, %FALSE otherwise + %TRUE if @ch has a mirrored character, %FALSE otherwise - a Unicode character + a Unicode character - location to store the mirrored character + location to store the mirrored character - - Looks up the #GUnicodeScript for a particular character (as defined + + Looks up the #GUnicodeScript for a particular character (as defined by Unicode Standard Annex \#24). No check is made for @ch being a valid Unicode character; if you pass in invalid character, the result is undefined. This function is equivalent to pango_script_for_unichar() and the two are interchangeable. - + - the #GUnicodeScript for the character. + the #GUnicodeScript for the character. - a Unicode character + a Unicode character - Determines whether a character is alphanumeric. + Determines whether a character is alphanumeric. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is an alphanumeric character + %TRUE if @c is an alphanumeric character - a Unicode character + a Unicode character - Determines whether a character is alphabetic (i.e. a letter). + Determines whether a character is alphabetic (i.e. a letter). Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is an alphabetic character + %TRUE if @c is an alphabetic character - a Unicode character + a Unicode character - Determines whether a character is a control character. + Determines whether a character is a control character. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a control character + %TRUE if @c is a control character - a Unicode character + a Unicode character - Determines if a given character is assigned in the Unicode + Determines if a given character is assigned in the Unicode standard. - + - %TRUE if the character has an assigned value + %TRUE if the character has an assigned value - a Unicode character + a Unicode character - Determines whether a character is numeric (i.e. a digit). This + Determines whether a character is numeric (i.e. a digit). This covers ASCII 0-9 and also digits in other languages/scripts. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a digit + %TRUE if @c is a digit - a Unicode character + a Unicode character - Determines whether a character is printable and not a space + Determines whether a character is printable and not a space (returns %FALSE for control characters, format characters, and spaces). g_unichar_isprint() is similar, but returns %TRUE for spaces. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is printable unless it's a space + %TRUE if @c is printable unless it's a space - a Unicode character + a Unicode character - Determines whether a character is a lowercase letter. + Determines whether a character is a lowercase letter. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a lowercase letter + %TRUE if @c is a lowercase letter - a Unicode character + a Unicode character - - Determines whether a character is a mark (non-spacing mark, + + Determines whether a character is a mark (non-spacing mark, combining mark, or enclosing mark in Unicode speak). Given some UTF-8 text, obtain a character value with g_utf8_get_char(). @@ -76278,165 +56234,121 @@ Note: in most cases where isalpha characters are allowed, ismark characters should be allowed to as they are essential for writing most European languages as well as many non-Latin scripts. - + - %TRUE if @c is a mark character + %TRUE if @c is a mark character - a Unicode character + a Unicode character - Determines whether a character is printable. + Determines whether a character is printable. Unlike g_unichar_isgraph(), returns %TRUE for spaces. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is printable + %TRUE if @c is printable - a Unicode character + a Unicode character - Determines whether a character is punctuation or a symbol. + Determines whether a character is punctuation or a symbol. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a punctuation or symbol character + %TRUE if @c is a punctuation or symbol character - a Unicode character + a Unicode character - Determines whether a character is a space, tab, or line separator + Determines whether a character is a space, tab, or line separator (newline, carriage return, etc.). Given some UTF-8 text, obtain a character value with g_utf8_get_char(). (Note: don't use this to do word breaking; you have to use Pango or equivalent to get word breaking right, the algorithm is fairly complex.) - + - %TRUE if @c is a space character + %TRUE if @c is a space character - a Unicode character + a Unicode character - Determines if a character is titlecase. Some characters in + Determines if a character is titlecase. Some characters in Unicode which are composites, such as the DZ digraph have three case variants instead of just two. The titlecase form is used at the beginning of a word where only the first letter is capitalized. The titlecase form of the DZ digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z. - + - %TRUE if the character is titlecase + %TRUE if the character is titlecase - a Unicode character + a Unicode character - Determines if a character is uppercase. - + Determines if a character is uppercase. + - %TRUE if @c is an uppercase character + %TRUE if @c is an uppercase character - a Unicode character + a Unicode character - Determines if a character is typically rendered in a double-width + Determines if a character is typically rendered in a double-width cell. - + - %TRUE if the character is wide + %TRUE if the character is wide - a Unicode character + a Unicode character - - Determines if a character is typically rendered in a double-width + + Determines if a character is typically rendered in a double-width cell under legacy East Asian locales. If a character is wide according to g_unichar_iswide(), then it is also reported wide with this function, but the converse is not necessarily true. See the @@ -76446,48 +56358,34 @@ for details. If a character passes the g_unichar_iswide() test then it will also pass this test, but not the other way around. Note that some characters may pass both this test and g_unichar_iszerowidth(). - + - %TRUE if the character is wide in legacy East Asian locales + %TRUE if the character is wide in legacy East Asian locales - a Unicode character + a Unicode character - Determines if a character is a hexadecimal digit. - + Determines if a character is a hexadecimal digit. + - %TRUE if the character is a hexadecimal digit + %TRUE if the character is a hexadecimal digit - a Unicode character. + a Unicode character. - - Determines if a given character typically takes zero width when rendered. + + Determines if a given character typically takes zero width when rendered. The return value is %TRUE for all non-spacing and enclosing marks (e.g., combining accents), format characters, zero-width space, but not U+00AD SOFT HYPHEN. @@ -76496,49 +56394,32 @@ A typical use of this function is with one of g_unichar_iswide() or g_unichar_iswide_cjk() to determine the number of cells a string occupies when displayed on a grid display (terminals). However, note that not all terminals support zero-width rendering of zero-width marks. - + - %TRUE if the character has zero width + %TRUE if the character has zero width - a Unicode character + a Unicode character - Converts a single character to UTF-8. - + Converts a single character to UTF-8. + - number of bytes written + number of bytes written - a Unicode character code + a Unicode character code - - output buffer, must have at + + output buffer, must have at least 6 bytes of space. If %NULL, the length will be computed and returned and nothing will be written to @outbuf. @@ -76546,140 +56427,101 @@ terminals support zero-width rendering of zero-width marks. - Converts a character to lower case. - + Converts a character to lower case. + - the result of converting @c to lower case. + the result of converting @c to lower case. If @c is not an upperlower or titlecase character, or has no lowercase equivalent @c is returned unchanged. - a Unicode character. + a Unicode character. - Converts a character to the titlecase. - + Converts a character to the titlecase. + - the result of converting @c to titlecase. + the result of converting @c to titlecase. If @c is not an uppercase or lowercase character, @c is returned unchanged. - a Unicode character + a Unicode character - Converts a character to uppercase. - + Converts a character to uppercase. + - the result of converting @c to uppercase. + the result of converting @c to uppercase. If @c is not a lowercase or titlecase character, or has no upper case equivalent @c is returned unchanged. - a Unicode character + a Unicode character - Classifies a Unicode character by type. - + Classifies a Unicode character by type. + - the type of the character. + the type of the character. - a Unicode character + a Unicode character - Checks whether @ch is a valid Unicode character. Some possible + Checks whether @ch is a valid Unicode character. Some possible integer values of @ch will not be valid. 0 is considered a valid character, though it's normally a string terminator. - + - %TRUE if @ch is a valid Unicode character + %TRUE if @ch is a valid Unicode character - a Unicode character + a Unicode character - - Determines the numeric value of a character as a hexadecimal + + Determines the numeric value of a character as a hexadecimal digit. - + - If @c is a hex digit (according to + If @c is a hex digit (according to g_unichar_isxdigit()), its numeric value. Otherwise, -1. - a Unicode character + a Unicode character - This section describes a number of functions for dealing with + This section describes a number of functions for dealing with Unicode characters and strings. There are analogues of the traditional `ctype.h` character classification and case conversion functions, UTF-8 analogues of some string utility functions, @@ -76708,71 +56550,49 @@ on the Unicode Character Data tables, which are available from * Unicode 12.1 was added in GLib 2.62 * Unicode 13.0 was added in GLib 2.66 - - Computes the canonical decomposition of a Unicode character. + + Computes the canonical decomposition of a Unicode character. Use the more flexible g_unichar_fully_decompose() instead. - + - a newly allocated string of Unicode characters. + a newly allocated string of Unicode characters. @result_len is set to the resulting length of the string. - a Unicode character. + a Unicode character. - location to store the length of the return value. + location to store the length of the return value. - - Computes the canonical ordering of a string in-place. + + Computes the canonical ordering of a string in-place. This rearranges decomposed characters in the string according to their combining classes. See the Unicode manual for more information. - + - a UCS-4 encoded string. + a UCS-4 encoded string. - the maximum length of @string to use. + the maximum length of @string to use. - - Looks up the Unicode script for @iso15924. ISO 15924 assigns four-letter + + Looks up the Unicode script for @iso15924. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is 'Arab'. This function accepts four letter codes encoded as a @guint32 in a big-endian fashion. That is, the code expected for Arabic is @@ -76781,30 +56601,22 @@ big-endian fashion. That is, the code expected for Arabic is See [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) for details. - + - the Unicode script for @iso15924, or + the Unicode script for @iso15924, or of %G_UNICODE_SCRIPT_INVALID_CODE if @iso15924 is zero and %G_UNICODE_SCRIPT_UNKNOWN if @iso15924 is unknown. - a Unicode script + a Unicode script - - Looks up the ISO 15924 code for @script. ISO 15924 assigns four-letter + + Looks up the ISO 15924 code for @script. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is 'Arab'. The four letter codes are encoded as a @guint32 by this function in a big-endian fashion. That is, the code returned for Arabic is @@ -76813,20 +56625,16 @@ big-endian fashion. That is, the code returned for Arabic is See [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) for details. - + - the ISO 15924 code for @script, encoded as an integer, + the ISO 15924 code for @script, encoded as an integer, of zero if @script is %G_UNICODE_SCRIPT_INVALID_CODE or ISO 15924 code 'Zzzz' (script code for UNKNOWN) if @script is not understood. - a Unicode script + a Unicode script @@ -76836,13 +56644,8 @@ for details. - - Sets a function to be called when the IO condition, as specified by + + Sets a function to be called when the IO condition, as specified by @condition becomes true for @fd. @function will be called when the specified IO condition becomes @@ -76857,47 +56660,30 @@ to cancel the watch at any time that it exists. The source will never close the fd -- you must do it yourself. - the ID (greater than 0) of the event source + the ID (greater than 0) of the event source - a file descriptor + a file descriptor - IO conditions to watch for on @fd + IO conditions to watch for on @fd - a #GUnixFDSourceFunc + a #GUnixFDSourceFunc - - data to pass to @function + + data to pass to @function - - Sets a function to be called when the IO condition, as specified by + + Sets a function to be called when the IO condition, as specified by @condition becomes true for @fd. This is the same as g_unix_fd_add(), except that it allows you to @@ -76905,96 +56691,60 @@ specify a non-default priority and a provide a #GDestroyNotify for @user_data. - the ID (greater than 0) of the event source + the ID (greater than 0) of the event source - the priority of the source + the priority of the source - a file descriptor + a file descriptor - IO conditions to watch for on @fd + IO conditions to watch for on @fd - - a #GUnixFDSourceFunc + + a #GUnixFDSourceFunc - - data to pass to @function + + data to pass to @function - function to call when the idle is removed, or %NULL + function to call when the idle is removed, or %NULL - - Creates a #GSource to watch for a particular IO condition on a file + + Creates a #GSource to watch for a particular IO condition on a file descriptor. The source will never close the fd -- you must do it yourself. - the newly created #GSource + the newly created #GSource - a file descriptor + a file descriptor - IO conditions to watch for on @fd + IO conditions to watch for on @fd - - Get the `passwd` file entry for the given @user_name using `getpwnam_r()`. -This can fail if the given @user_name doesn’t exist. + + Get the `passwd` file entry for the given @user_name using `getpwnam_r()`. +This can fail if the given @user_name doesn’t exist. The returned `struct passwd` has been allocated using g_malloc() and should be freed using g_free(). The strings referenced by the returned struct are @@ -77006,28 +56756,19 @@ This function is safe to call from multiple threads concurrently. You will need to include `pwd.h` to get the definition of `struct passwd`. - passwd entry, or %NULL on error; free the returned + passwd entry, or %NULL on error; free the returned value with g_free() - the username to get the passwd file entry for + the username to get the passwd file entry for - - Similar to the UNIX pipe() call, but on modern systems like Linux + + Similar to the UNIX pipe() call, but on modern systems like Linux uses the pipe2() system call, which atomically creates a pipe with the configured flags. The only supported flag currently is %FD_CLOEXEC. If for example you want to configure %O_NONBLOCK, that @@ -77037,161 +56778,99 @@ This function does not take %O_CLOEXEC, it takes %FD_CLOEXEC as if for fcntl(); these are different on Linux/glibc. - %TRUE on success, %FALSE if not (and errno will be set). + %TRUE on success, %FALSE if not (and errno will be set). - Array of two integers + Array of two integers - Bitfield of file descriptor flags, as for fcntl() + Bitfield of file descriptor flags, as for fcntl() - - Control the non-blocking state of the given file descriptor, + + Control the non-blocking state of the given file descriptor, according to @nonblock. On most systems this uses %O_NONBLOCK, but on some older ones may use %O_NDELAY. - %TRUE if successful + %TRUE if successful - A file descriptor + A file descriptor - If %TRUE, set the descriptor to be non-blocking + If %TRUE, set the descriptor to be non-blocking - - A convenience function for g_unix_signal_source_new(), which + + A convenience function for g_unix_signal_source_new(), which attaches to the default #GMainContext. You can remove the watch using g_source_remove(). - An ID (greater than 0) for the event source + An ID (greater than 0) for the event source - Signal number + Signal number - Callback + Callback - - Data for @handler + + Data for @handler - - A convenience function for g_unix_signal_source_new(), which + + A convenience function for g_unix_signal_source_new(), which attaches to the default #GMainContext. You can remove the watch using g_source_remove(). - An ID (greater than 0) for the event source + An ID (greater than 0) for the event source - the priority of the signal source. Typically this will be in + the priority of the signal source. Typically this will be in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. - Signal number + Signal number - - Callback + + Callback - - Data for @handler + + Data for @handler - #GDestroyNotify for @handler + #GDestroyNotify for @handler - - Create a #GSource that will be dispatched upon delivery of the UNIX + + Create a #GSource that will be dispatched upon delivery of the UNIX signal @signum. In GLib versions before 2.36, only `SIGHUP`, `SIGINT`, `SIGTERM` can be monitored. In GLib 2.36, `SIGUSR1` and `SIGUSR2` were added. In GLib 2.54, `SIGWINCH` was added. @@ -77216,24 +56895,18 @@ and must be added to one with g_source_attach() before it will be executed. - A newly created #GSource + A newly created #GSource - A signal number + A signal number - A wrapper for the POSIX unlink() function. The unlink() function + A wrapper for the POSIX unlink() function. The unlink() function deletes a name from the filesystem. If this was the last link to the file and no processes have it opened, the diskspace occupied by the file is freed. @@ -77243,26 +56916,20 @@ that on Windows, it is in general not possible to delete files that are open to some process, or mapped into memory. - 0 if the name was successfully deleted, -1 if an error + 0 if the name was successfully deleted, -1 if an error occurred - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - Removes an environment variable from the environment. + Removes an environment variable from the environment. Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed. @@ -77285,262 +56952,157 @@ array directly to execvpe(), g_spawn_async(), or the like. - the environment variable to remove, must + the environment variable to remove, must not contain '=' - - Creates a new #GUri from the given components according to @flags. + + Creates a new #GUri from the given components according to @flags. See also g_uri_build_with_user(), which allows specifying the components of the "userinfo" separately. - + - a new #GUri + a new #GUri - flags describing how to build the #GUri + flags describing how to build the #GUri - the URI scheme + the URI scheme - - the userinfo component, or %NULL + + the userinfo component, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - - Creates a new #GUri from the given components according to @flags + + Creates a new #GUri from the given components according to @flags (%G_URI_FLAGS_HAS_PASSWORD is added unconditionally). The @flags must be coherent with the passed values, in particular use `%`-encoded values with %G_URI_FLAGS_ENCODED. In contrast to g_uri_build(), this allows specifying the components -of the ‘userinfo’ field separately. Note that @user must be non-%NULL +of the ‘userinfo’ field separately. Note that @user must be non-%NULL if either @password or @auth_params is non-%NULL. - + - a new #GUri + a new #GUri - flags describing how to build the #GUri + flags describing how to build the #GUri - the URI scheme + the URI scheme - - the user component of the userinfo, or %NULL + + the user component of the userinfo, or %NULL - - the password component of the userinfo, or %NULL + + the password component of the userinfo, or %NULL - - the auth params of the userinfo, or %NULL + + the auth params of the userinfo, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - + - - Escapes arbitrary data for use in a URI. + + Escapes arbitrary data for use in a URI. -Normally all characters that are not ‘unreserved’ (i.e. ASCII +Normally all characters that are not ‘unreserved’ (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in @reserved_chars_allowed -they are not escaped. This is useful for the ‘reserved’ characters +they are not escaped. This is useful for the ‘reserved’ characters in the URI specification, since those are allowed unescaped in some portions of a URI. Though technically incorrect, this will also allow escaping nul bytes as `%``00`. - + - an escaped version of @unescaped. The returned - string should be freed when no longer needed. + an escaped version of @unescaped. + The returned string should be freed when no longer needed. - the unescaped input data. + the unescaped input data. - the length of @unescaped + the length of @unescaped - - a string of reserved + + a string of reserved characters that are allowed to be used, or %NULL. - - Escapes a string for use in a URI. + + Escapes a string for use in a URI. Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are @@ -77548,83 +57110,55 @@ escaped. But if you specify characters in @reserved_chars_allowed they are not escaped. This is useful for the "reserved" characters in the URI specification, since those are allowed unescaped in some portions of a URI. - + - an escaped version of @unescaped. The returned string -should be freed when no longer needed. + an escaped version of @unescaped. The +returned string should be freed when no longer needed. - the unescaped input string. + the unescaped input string. - - a string of reserved + + a string of reserved characters that are allowed to be used, or %NULL. - %TRUE if the result can include UTF-8 characters. + %TRUE if the result can include UTF-8 characters. - - Parses @uri_string according to @flags, to determine whether it is a valid + + Parses @uri_string according to @flags, to determine whether it is a valid [absolute URI][relative-absolute-uris], i.e. it does not need to be resolved relative to another URI using g_uri_parse_relative(). -If it’s not a valid URI, an error is returned explaining how it’s invalid. +If it’s not a valid URI, an error is returned explaining how it’s invalid. See g_uri_split(), and the definition of #GUriFlags, for more information on the effect of @flags. - + - %TRUE if @uri_string is a valid absolute URI, %FALSE on error. + %TRUE if @uri_string is a valid absolute URI, %FALSE on error. - a string containing an absolute URI + a string containing an absolute URI - flags for parsing @uri_string + flags for parsing @uri_string - - Joins the given components together according to @flags to create + + Joins the given components together according to @flags to create an absolute URI string. @path may not be %NULL (though it may be the empty string). @@ -77634,205 +57168,117 @@ character. When @host is not present, @path cannot begin with two slash [RFC 3986, section 3](https://tools.ietf.org/html/rfc3986#section-3). See also g_uri_join_with_user(), which allows specifying the -components of the ‘userinfo’ separately. +components of the ‘userinfo’ separately. %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set in @flags. - + - an absolute URI string + an absolute URI string - flags describing how to build the URI string + flags describing how to build the URI string - - the URI scheme, or %NULL + + the URI scheme, or %NULL - - the userinfo component, or %NULL + + the userinfo component, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - - Joins the given components together according to @flags to create + + Joins the given components together according to @flags to create an absolute URI string. @path may not be %NULL (though it may be the empty string). In contrast to g_uri_join(), this allows specifying the components -of the ‘userinfo’ separately. It otherwise behaves the same. +of the ‘userinfo’ separately. It otherwise behaves the same. %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set in @flags. - + - an absolute URI string + an absolute URI string - flags describing how to build the URI string + flags describing how to build the URI string - - the URI scheme, or %NULL + + the URI scheme, or %NULL - - the user component of the userinfo, or %NULL + + the user component of the userinfo, or %NULL - - the password component of the userinfo, or + + the password component of the userinfo, or %NULL - - the auth params of the userinfo, or + + the auth params of the userinfo, or %NULL - - the host component, or %NULL + + the host component, or %NULL - the port, or `-1` + the port, or `-1` - the path component + the path component - - the query component, or %NULL + + the query component, or %NULL - - the fragment, or %NULL + + the fragment, or %NULL - - Splits an URI list conforming to the text/uri-list + + Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated. - a newly allocated %NULL-terminated list + a newly allocated %NULL-terminated list of strings holding the individual URIs. The array should be freed with g_strfreev(). @@ -77841,53 +57287,33 @@ discarding any comments. The URIs are not validated. - an URI list + an URI list - - Parses @uri_string according to @flags. If the result is not a + + Parses @uri_string according to @flags. If the result is not a valid [absolute URI][relative-absolute-uris], it will be discarded, and an error returned. - + - a new #GUri. + a new #GUri, or NULL on error. - a string representing an absolute URI + a string representing an absolute URI - flags describing how to parse @uri_string + flags describing how to parse @uri_string - - Many URI schemes include one or more attribute/value pairs as part of the URI + + Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use @@ -77906,18 +57332,16 @@ invalid encoding.) If %G_URI_PARAMS_CASE_INSENSITIVE is passed to @flags, attributes will be compared case-insensitively, so a params string `attr=123&Attr=456` will only -return a single attribute–value pair, `Attr=456`. Case will be preserved in +return a single attribute–value pair, `Attr=456`. Case will be preserved in the returned attributes. If @params cannot be parsed (for example, it contains two @separators characters in a row), then @error is set and %NULL is returned. - + - A hash table of - attribute/value pairs, with both names and values fully-decoded; or %NULL - on error. + + A hash table of attribute/value pairs, with both names and values + fully-decoded; or %NULL on error. @@ -77925,22 +57349,16 @@ characters in a row), then @error is set and %NULL is returned. - a `%`-encoded string containing `attribute=value` + a `%`-encoded string containing `attribute=value` parameters - the length of @params, or `-1` if it is nul-terminated + the length of @params, or `-1` if it is nul-terminated - the separator byte character set between parameters. (usually + the separator byte character set between parameters. (usually `&`, but sometimes `;` or both `&;`). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case @@ -77948,50 +57366,34 @@ characters in a row), then @error is set and %NULL is returned. - flags to modify the way the parameters are handled. + flags to modify the way the parameters are handled. - - Gets the scheme portion of a URI string. + + Gets the scheme portion of a URI string. [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include `file`, `https`, `svn+ssh`, etc. - + - The ‘scheme’ component of the URI, or + The ‘scheme’ component of the URI, or %NULL on error. The returned string should be freed when no longer needed. - a valid URI. + a valid URI. - - Gets the scheme portion of a URI string. + + Gets the scheme portion of a URI string. [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme as: |[ @@ -78001,77 +57403,51 @@ Common schemes include `file`, `https`, `svn+ssh`, etc. Unlike g_uri_parse_scheme(), the returned scheme is normalized to all-lowercase and does not need to be freed. - + - The ‘scheme’ component of the URI, or + The ‘scheme’ component of the URI, or %NULL on error. The returned string is normalized to all-lowercase, and interned via g_intern_string(), so it does not need to be freed. - a valid URI. + a valid URI. - - Parses @uri_ref according to @flags and, if it is a + + Parses @uri_ref according to @flags and, if it is a [relative URI][relative-absolute-uris], resolves it relative to @base_uri_string. If the result is not a valid absolute URI, it will be discarded, and an error returned. (If @base_uri_string is %NULL, this just returns @uri_ref, or %NULL if @uri_ref is invalid or not absolute.) - + - the resolved URI string. + the resolved URI string, +or NULL on error. - - a string representing a base URI + + a string representing a base URI - a string representing a relative or absolute URI + a string representing a relative or absolute URI - flags describing how to parse @uri_ref + flags describing how to parse @uri_ref - - Parses @uri_ref (which can be an + + Parses @uri_ref (which can be an [absolute or relative URI][relative-absolute-uris]) according to @flags, and returns the pieces. Any component that doesn't appear in @uri_ref will be returned as %NULL (but note that all URIs always have a path component, @@ -78087,200 +57463,99 @@ Note that the %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS @flags are ignored by g_uri_split(), since it always returns only the full userinfo; use g_uri_split_with_user() if you want it split up. - + - %TRUE if @uri_ref parsed successfully, %FALSE + %TRUE if @uri_ref parsed successfully, %FALSE on error. - a string containing a relative or absolute URI + a string containing a relative or absolute URI - flags for parsing @uri_ref + flags for parsing @uri_ref - - on return, contains + + on return, contains the scheme (converted to lowercase), or %NULL - - on return, contains + + on return, contains the userinfo, or %NULL - - on return, contains the + + on return, contains the host, or %NULL - - on return, contains the + + on return, contains the port, or `-1` - - on return, contains the + + on return, contains the path - - on return, contains the + + on return, contains the query, or %NULL - - on return, contains + + on return, contains the fragment, or %NULL - - Parses @uri_string (which must be an [absolute URI][relative-absolute-uris]) + + Parses @uri_string (which must be an [absolute URI][relative-absolute-uris]) according to @flags, and returns the pieces relevant to connecting to a host. See the documentation for g_uri_split() for more details; this is mostly a wrapper around that function with simpler arguments. However, it will return an error if @uri_string is a relative URI, or does not contain a hostname component. - + - %TRUE if @uri_string parsed successfully, + %TRUE if @uri_string parsed successfully, %FALSE on error. - a string containing an absolute URI + a string containing an absolute URI - flags for parsing @uri_string + flags for parsing @uri_string - - on return, contains + + on return, contains the scheme (converted to lowercase), or %NULL - - on return, contains the + + on return, contains the host, or %NULL - - on return, contains the + + on return, contains the port, or `-1` - - Parses @uri_ref (which can be an + + Parses @uri_ref (which can be an [absolute or relative URI][relative-absolute-uris]) according to @flags, and returns the pieces. Any component that doesn't appear in @uri_ref will be returned as %NULL (but note that all URIs always have a path component, @@ -78291,152 +57566,70 @@ information on the effect of @flags. Note that @password will only be parsed out if @flags contains %G_URI_FLAGS_HAS_PASSWORD, and @auth_params will only be parsed out if @flags contains %G_URI_FLAGS_HAS_AUTH_PARAMS. - + - %TRUE if @uri_ref parsed successfully, %FALSE + %TRUE if @uri_ref parsed successfully, %FALSE on error. - a string containing a relative or absolute URI + a string containing a relative or absolute URI - flags for parsing @uri_ref + flags for parsing @uri_ref - - on return, contains + + on return, contains the scheme (converted to lowercase), or %NULL - - on return, contains + + on return, contains the user, or %NULL - - on return, contains + + on return, contains the password, or %NULL - - on return, contains + + on return, contains the auth_params, or %NULL - - on return, contains the + + on return, contains the host, or %NULL - - on return, contains the + + on return, contains the port, or `-1` - - on return, contains the + + on return, contains the path - - on return, contains the + + on return, contains the query, or %NULL - - on return, contains + + on return, contains the fragment, or %NULL - - Unescapes a segment of an escaped string as binary data. + + Unescapes a segment of an escaped string as binary data. Note that in contrast to g_uri_unescape_string(), this does allow nul bytes to appear in the output. @@ -78446,48 +57639,32 @@ character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling. - + - an unescaped version of @escaped_string or %NULL on - error (if decoding failed, using %G_URI_ERROR_FAILED error code). The - returned #GBytes should be unreffed when no longer needed. + an unescaped version of @escaped_string + or %NULL on error (if decoding failed, using %G_URI_ERROR_FAILED error + code). The returned #GBytes should be unreffed when no longer needed. - A URI-escaped string + A URI-escaped string - the length (in bytes) of @escaped_string to escape, or `-1` if it + the length (in bytes) of @escaped_string to escape, or `-1` if it is nul-terminated. - - a string of illegal characters + + a string of illegal characters not to be allowed, or %NULL. - - Unescapes a segment of an escaped string. + + Unescapes a segment of an escaped string. If any of the characters in @illegal_characters or the NUL character appears as an escaped character in @escaped_string, then @@ -78497,92 +57674,59 @@ escaped path element, which might confuse pathname handling. Note: `NUL` byte is not accepted in the output, in contrast to g_uri_unescape_bytes(). - - - an unescaped version of @escaped_string or %NULL on error. -The returned string should be freed when no longer needed. As a -special case if %NULL is given for @escaped_string, this function -will return %NULL. + + + an unescaped version of @escaped_string, +or %NULL on error. The returned string should be freed when no longer +needed. As a special case if %NULL is given for @escaped_string, this +function will return %NULL. - - A string, may be %NULL + + A string, may be %NULL - - Pointer to end of @escaped_string, + + Pointer to end of @escaped_string, may be %NULL - - An optional string of illegal + + An optional string of illegal characters not to be allowed, may be %NULL - - Unescapes a whole escaped string. + + Unescapes a whole escaped string. If any of the characters in @illegal_characters or the NUL character appears as an escaped character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling. - - - an unescaped version of @escaped_string. The returned string -should be freed when no longer needed. + + + an unescaped version of @escaped_string. +The returned string should be freed when no longer needed. - an escaped string to be unescaped. + an escaped string to be unescaped. - - a string of illegal characters + + a string of illegal characters not to be allowed, or %NULL. - Pauses the current thread for the given number of microseconds. + Pauses the current thread for the given number of microseconds. There are 1 million microseconds per second (represented by the #G_USEC_PER_SEC macro). g_usleep() may have limited precision, @@ -78594,64 +57738,40 @@ length of the sleep. - number of microseconds to pause + number of microseconds to pause - Convert a string from UTF-16 to UCS-4. The result will be + Convert a string from UTF-16 to UCS-4. The result will be nul-terminated. - + - a pointer to a newly allocated UCS-4 string. + a pointer to a newly allocated UCS-4 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-16 encoded string + a UTF-16 encoded string - the maximum length (number of #gunichar2) of @str to use. + the maximum length (number of #gunichar2) of @str to use. If @len < 0, then the string is nul-terminated. - - location to store number of + + location to store number of words read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here. - - location to store number + + location to store number of characters written, or %NULL. The value stored here does not include the trailing 0 character. @@ -78659,9 +57779,7 @@ nul-terminated. - Convert a string from UTF-16 to UTF-8. The result will be + Convert a string from UTF-16 to UTF-8. The result will be terminated with a 0 byte. Note that the input is expected to be already in native endianness, @@ -78674,52 +57792,32 @@ string; it may e.g. include embedded NUL characters. The only validation done by this function is to ensure that the input can be correctly interpreted as UTF-16, i.e. it doesn't contain unpaired surrogates or partial character sequences. - + - a pointer to a newly allocated UTF-8 string. + a pointer to a newly allocated UTF-8 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-16 encoded string + a UTF-16 encoded string - the maximum length (number of #gunichar2) of @str to use. + the maximum length (number of #gunichar2) of @str to use. If @len < 0, then the string is nul-terminated. - - location to store number of + + location to store number of words read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here. - - location to store number + + location to store number of bytes written, or %NULL. The value stored here does not include the trailing 0 byte. @@ -78727,9 +57825,7 @@ unpaired surrogates or partial character sequences. - Converts a string into a form that is independent of case. The + Converts a string into a form that is independent of case. The result will not correspond to any particular case, but can be compared for equality or ordered with the results of calling g_utf8_casefold() on other strings. @@ -78740,65 +57836,49 @@ ordering, though it is a fairly good one. Getting this exactly right would require a more sophisticated collation function that takes case sensitivity into account. GLib does not currently provide such a function. - + - a newly allocated string, that is a + a newly allocated string, that is a case independent form of @str. - a UTF-8 encoded string + a UTF-8 encoded string - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Compares two strings for ordering using the linguistically + Compares two strings for ordering using the linguistically correct rules for the [current locale][setlocale]. When sorting a large number of strings, it will be significantly faster to obtain collation keys with g_utf8_collate_key() and compare the keys with strcmp() when sorting instead of sorting the original strings. - + - < 0 if @str1 compares before @str2, + < 0 if @str1 compares before @str2, 0 if they compare equal, > 0 if @str1 compares after @str2. - a UTF-8 encoded string + a UTF-8 encoded string - a UTF-8 encoded string + a UTF-8 encoded string - Converts a string into a collation key that can be compared + Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp(). @@ -78807,35 +57887,25 @@ with strcmp() will always be the same as comparing the two original keys with g_utf8_collate(). Note that this function depends on the [current locale][setlocale]. - + - a newly allocated string. This string should + a newly allocated string. This string should be freed with g_free() when you are done with it. - a UTF-8 encoded string. + a UTF-8 encoded string. - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - - Converts a string into a collation key that can be compared + + Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp(). In order to sort filenames correctly, this function treats the dot '.' @@ -78846,33 +57916,25 @@ would like to treat numbers intelligently so that "file1" "file10" "file5" is sorted as "file1" "file5" "file10". Note that this function depends on the [current locale][setlocale]. - + - a newly allocated string. This string should + a newly allocated string. This string should be freed with g_free() when you are done with it. - a UTF-8 encoded string. + a UTF-8 encoded string. - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Finds the start of the next UTF-8 character in the string after @p. + Finds the start of the next UTF-8 character in the string after @p. @p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than @@ -78882,95 +57944,69 @@ If @end is %NULL, the return value will never be %NULL: if the end of the string is reached, a pointer to the terminating nul byte is returned. If @end is non-%NULL, the return value will be %NULL if the end of the string is reached. - + - a pointer to the found character or %NULL if @end is + a pointer to the found character or %NULL if @end is set and is reached - a pointer to a position within a UTF-8 encoded string + a pointer to a position within a UTF-8 encoded string - - a pointer to the byte following the end of the string, + + a pointer to the byte following the end of the string, or %NULL to indicate that the string is nul-terminated - Given a position @p with a UTF-8 encoded string @str, find the start + Given a position @p with a UTF-8 encoded string @str, find the start of the previous UTF-8 character starting before @p. Returns %NULL if no UTF-8 characters are present in @str before @p. @p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte. - + - a pointer to the found character or %NULL. + a pointer to the found character or %NULL. - pointer to the beginning of a UTF-8 encoded string + pointer to the beginning of a UTF-8 encoded string - pointer to some position within @str + pointer to some position within @str - Converts a sequence of bytes encoded as UTF-8 to a Unicode character. + Converts a sequence of bytes encoded as UTF-8 to a Unicode character. If @p does not point to a valid UTF-8 encoded character, results are undefined. If you are not sure that the bytes are complete valid Unicode characters, you should use g_utf8_get_char_validated() instead. - + - the resulting character + the resulting character - a pointer to Unicode character encoded as UTF-8 + a pointer to Unicode character encoded as UTF-8 - - Convert a sequence of bytes encoded as UTF-8 to a Unicode character. + + Convert a sequence of bytes encoded as UTF-8 to a Unicode character. This function checks for incomplete characters, for invalid characters such as characters that are out of the range of Unicode, and for overlong encodings of valid characters. @@ -78978,11 +58014,9 @@ overlong encodings of valid characters. Note that g_utf8_get_char_validated() returns (gunichar)-2 if @max_len is positive and any of the bytes in the first UTF-8 character sequence are nul. - + - the resulting character. If @p points to a partial + the resulting character. If @p points to a partial sequence at the end of a string that could begin a valid character (or if @max_len is zero), returns (gunichar)-2; otherwise, if @p does not point to a valid UTF-8 encoded @@ -78991,25 +58025,17 @@ sequence are nul. - a pointer to Unicode character encoded as UTF-8 + a pointer to Unicode character encoded as UTF-8 - the maximum number of bytes to read, or -1 if @p is nul-terminated + the maximum number of bytes to read, or -1 if @p is nul-terminated - - If the provided string is valid UTF-8, return a copy of it. If not, + + If the provided string is valid UTF-8, return a copy of it. If not, return a copy in which bytes that could not be interpreted as valid Unicode are replaced with the Unicode replacement character (U+FFFD). @@ -79018,53 +58044,44 @@ a string that was incorrectly declared to be UTF-8, and you need a valid UTF-8 version of it that can be logged or displayed to the user, with the assumption that it is close enough to ASCII or UTF-8 to be mostly readable as-is. - + - a valid UTF-8 string whose content resembles @str + a valid UTF-8 string whose content resembles @str - string to coerce into UTF-8 + string to coerce into UTF-8 - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - - Skips to the next character in a UTF-8 string. The string must be -valid; this macro is as fast as possible, and has no error-checking. -You would use this macro to iterate over a string character by -character. The macro returns the start of the next UTF-8 character. + + Skips to the next character in a UTF-8 string. + +The string must be valid; this macro is as fast as possible, and has +no error-checking. + +You would use this macro to iterate over a string character by character. + +The macro returns the start of the next UTF-8 character. + Before using this macro, use g_utf8_validate() to validate strings that may contain invalid UTF-8. - + - Pointer to the start of a valid UTF-8 character + Pointer to the start of a valid UTF-8 character - Converts a string into canonical form, standardizing + Converts a string into canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. The @@ -79089,41 +58106,30 @@ than a maximally decomposed form. This is often useful if you intend to convert the string to a legacy encoding or pass it to a system with less capable Unicode handling. - + - a newly allocated string, that + a newly allocated string, that is the normalized form of @str, or %NULL if @str is not valid UTF-8. - a UTF-8 encoded string. + a UTF-8 encoded string. - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - the type of normalization to perform. + the type of normalization to perform. - - Converts from an integer character offset to a pointer to a position + + Converts from an integer character offset to a pointer to a position within the string. Since 2.10, this function allows to pass a negative @offset to @@ -79136,174 +58142,127 @@ Therefore you should be sure that @offset is within string boundaries before calling that function. Call g_utf8_strlen() when unsure. This limitation exists as this function is called frequently during text rendering and therefore has to be as fast as possible. - + - the resulting pointer + the resulting pointer - a UTF-8 encoded string + a UTF-8 encoded string - a character offset within @str + a character offset within @str - - Converts from a pointer to position within a string to an integer + + Converts from a pointer to position within a string to an integer character offset. Since 2.10, this function allows @pos to be before @str, and returns a negative offset in this case. - + - the resulting character offset + the resulting character offset - a UTF-8 encoded string + a UTF-8 encoded string - a pointer to a position within @str + a pointer to a position within @str - Finds the previous UTF-8 character in the string before @p. + Finds the previous UTF-8 character in the string before @p. @p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte. If @p might be the first character of the string, you must use g_utf8_find_prev_char() instead. - + - a pointer to the found character + a pointer to the found character - a pointer to a position within a UTF-8 encoded string + a pointer to a position within a UTF-8 encoded string - Finds the leftmost occurrence of the given Unicode character + Finds the leftmost occurrence of the given Unicode character in a UTF-8 encoded string, while limiting the search to @len bytes. If @len is -1, allow unbounded search. - + - %NULL if the string does not contain the character, + %NULL if the string does not contain the character, otherwise, a pointer to the start of the leftmost occurrence of the character in the string. - a nul-terminated UTF-8 encoded string + a nul-terminated UTF-8 encoded string - the maximum length of @p + the maximum length of @p - a Unicode character + a Unicode character - Converts all Unicode characters in the string that have a case + Converts all Unicode characters in the string that have a case to lowercase. The exact manner that this is done depends on the current locale, and may result in the number of characters in the string changing. - + - a newly allocated string, with all characters + a newly allocated string, with all characters converted to lowercase. - a UTF-8 encoded string + a UTF-8 encoded string - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Computes the length of the string in characters, not including + Computes the length of the string in characters, not including the terminating nul character. If the @max'th byte falls in the middle of a character, the last (partial) character is not counted. - + - the length of the string in characters + the length of the string in characters - pointer to the start of a UTF-8 encoded string + pointer to the start of a UTF-8 encoded string - the maximum number of bytes to examine. If @max + the maximum number of bytes to examine. If @max is less than 0, then the string is assumed to be nul-terminated. If @max is 0, @p will not be examined and may be %NULL. If @max is greater than 0, up to @max @@ -79313,85 +58272,61 @@ middle of a character, the last (partial) character is not counted. - Like the standard C strncpy() function, but copies a given number + Like the standard C strncpy() function, but copies a given number of characters instead of a given number of bytes. The @src string must be valid UTF-8 encoded text. (Use g_utf8_validate() on all text before trying to use UTF-8 utility functions with it.) Note you must ensure @dest is at least 4 * @n to fit the largest possible UTF-8 characters - + - @dest + @dest - buffer to fill with characters from @src + buffer to fill with characters from @src - UTF-8 encoded string + UTF-8 encoded string - character count + character count - Find the rightmost occurrence of the given Unicode character + Find the rightmost occurrence of the given Unicode character in a UTF-8 encoded string, while limiting the search to @len bytes. If @len is -1, allow unbounded search. - + - %NULL if the string does not contain the character, + %NULL if the string does not contain the character, otherwise, a pointer to the start of the rightmost occurrence of the character in the string. - a nul-terminated UTF-8 encoded string + a nul-terminated UTF-8 encoded string - the maximum length of @p + the maximum length of @p - a Unicode character + a Unicode character - - Reverses a UTF-8 string. @str must be valid UTF-8 encoded text. + + Reverses a UTF-8 string. @str must be valid UTF-8 encoded text. (Use g_utf8_validate() on all text before trying to use UTF-8 utility functions with it.) @@ -79404,134 +58339,93 @@ for display purposes. Note that unlike g_strreverse(), this function returns newly-allocated memory, which should be freed with g_free() when no longer needed. - + - a newly-allocated string which is the reverse of @str + a newly-allocated string which is the reverse of @str - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - Converts all Unicode characters in the string that have a case + Converts all Unicode characters in the string that have a case to uppercase. The exact manner that this is done depends on the current locale, and may result in the number of characters in the string increasing. (For instance, the German ess-zet will be changed to SS.) - + - a newly allocated string, with all characters + a newly allocated string, with all characters converted to uppercase. - a UTF-8 encoded string + a UTF-8 encoded string - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - - Copies a substring out of a UTF-8 encoded string. + + Copies a substring out of a UTF-8 encoded string. The substring will contain @end_pos - @start_pos characters. - + - a newly allocated copy of the requested + a newly allocated copy of the requested substring. Free with g_free() when no longer needed. - a UTF-8 encoded string + a UTF-8 encoded string - a character offset within @str + a character offset within @str - another character offset within @str + another character offset within @str - Convert a string from UTF-8 to a 32-bit fixed width + Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4. A trailing 0 character will be added to the string after the converted text. - + - a pointer to a newly allocated UCS-4 string. + a pointer to a newly allocated UCS-4 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - - location to store number of + + location to store number of bytes read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial @@ -79539,15 +58433,8 @@ string after the converted text. invalid input is stored here. - - location to store number + + location to store number of characters written or %NULL. The value here stored does not include the trailing 0 character. @@ -79555,100 +58442,63 @@ string after the converted text. - Convert a string from UTF-8 to a 32-bit fixed width + Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4, assuming valid UTF-8 input. This function is roughly twice as fast as g_utf8_to_ucs4() but does no error checking on the input. A trailing 0 character will be added to the string after the converted text. - + - a pointer to a newly allocated UCS-4 string. + a pointer to a newly allocated UCS-4 string. This value must be freed with g_free(). - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - - location to store the + + location to store the number of characters in the result, or %NULL. - Convert a string from UTF-8 to UTF-16. A 0 character will be + Convert a string from UTF-8 to UTF-16. A 0 character will be added to the result after the converted text. - + - a pointer to a newly allocated UTF-16 string. + a pointer to a newly allocated UTF-16 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length (number of bytes) of @str to use. + the maximum length (number of bytes) of @str to use. If @len < 0, then the string is nul-terminated. - - location to store number of + + location to store number of bytes read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here. - - location to store number + + location to store number of #gunichar2 written, or %NULL. The value stored here does not include the trailing 0. @@ -79656,9 +58506,7 @@ added to the result after the converted text. - Validates UTF-8 encoded text. @str is the text to validate; + Validates UTF-8 encoded text. @str is the text to validate; if @str is nul-terminated, then @max_len can be -1, otherwise @max_len should be the number of bytes to validate. If @end is non-%NULL, then the end of the valid range @@ -79673,89 +58521,57 @@ Returns %TRUE if all of @str was valid. Many GLib and GTK+ routines require valid UTF-8 as input; so data read from a file or the network should be checked with g_utf8_validate() before doing anything else with it. - + - %TRUE if the text was valid UTF-8 + %TRUE if the text was valid UTF-8 - a pointer to character data + a pointer to character data - max bytes to validate, or -1 to go until NUL + max bytes to validate, or -1 to go until NUL - - return location for end of valid data + + return location for end of valid data - - Validates UTF-8 encoded text. + + Validates UTF-8 encoded text. As with g_utf8_validate(), but @max_len must be set, and hence this function will always return %FALSE if any of the bytes of @str are nul. - + - %TRUE if the text was valid UTF-8 + %TRUE if the text was valid UTF-8 - a pointer to character data + a pointer to character data - max bytes to validate + max bytes to validate - - return location for end of valid data + + return location for end of valid data - A UUID, or Universally unique identifier, is intended to uniquely + A UUID, or Universally unique identifier, is intended to uniquely identify information in a distributed environment. For the definition of UUID, see [RFC 4122](https://tools.ietf.org/html/rfc4122.html). @@ -79769,12 +58585,8 @@ The UUID specification defines 5 versions, and calling g_uuid_string_random() will generate a unique (or rather random) UUID of the most common version, version 4. - - Parses the string @str and verify if it is a UUID. + + Parses the string @str and verify if it is a UUID. The function accepts the following syntax: @@ -79784,49 +58596,34 @@ Note that hyphens are required within the UUID string itself, as per the aforementioned RFC. - %TRUE if @str is a valid UUID, %FALSE otherwise. + %TRUE if @str is a valid UUID, %FALSE otherwise. - a string representing a UUID + a string representing a UUID - - Generates a random UUID (RFC 4122 version 4) as a string. It has the same + + Generates a random UUID (RFC 4122 version 4) as a string. It has the same randomness guarantees as #GRand, so must not be used for cryptographic purposes such as key generation, nonces, salts or one-time pads. - A string that should be freed with g_free(). + A string that should be freed with g_free(). - + - - Determines if a given string is a valid D-Bus object path. You + + Determines if a given string is a valid D-Bus object path. You should ensure that a string is a valid D-Bus object path before passing it to g_variant_new_object_path(). @@ -79836,27 +58633,18 @@ must contain only the characters `[A-Z][a-z][0-9]_`. No sequence (including the one following the final `/` character) may be empty. - %TRUE if @string is a D-Bus object path + %TRUE if @string is a D-Bus object path - a normal C nul-terminated string + a normal C nul-terminated string - - Determines if a given string is a valid D-Bus type signature. You + + Determines if a given string is a valid D-Bus type signature. You should ensure that a string is a valid D-Bus type signature before passing it to g_variant_new_signature(). @@ -79864,27 +58652,18 @@ D-Bus type signatures consist of zero or more definite #GVariantType strings in sequence. - %TRUE if @string is a D-Bus type signature + %TRUE if @string is a D-Bus type signature - a normal C nul-terminated string + a normal C nul-terminated string - - Parses a #GVariant from a text representation. + + Parses a #GVariant from a text representation. A single #GVariant is parsed from the content of @text. @@ -79919,56 +58698,32 @@ produced by g_variant_print()". There may be implementation specific restrictions on deeply nested values, which would result in a %G_VARIANT_PARSE_ERROR_RECURSION error. #GVariant is guaranteed to handle nesting up to at least 64 levels. - + - a non-floating reference to a #GVariant, or %NULL + a non-floating reference to a #GVariant, or %NULL - - a #GVariantType, or %NULL + + a #GVariantType, or %NULL - a string containing a GVariant in text form + a string containing a GVariant in text form - - a pointer to the end of @text, or %NULL + + a pointer to the end of @text, or %NULL - - a location to store the end pointer, or %NULL + + a location to store the end pointer, or %NULL - - Pretty-prints a message showing the context of a #GVariant parse + + Pretty-prints a message showing the context of a #GVariant parse error within the string for which parsing was attempted. The resulting string is suitable for output to the console or other @@ -79997,50 +58752,35 @@ The format of the message may change in a future version. If @source_str was not nul-terminated when you passed it to g_variant_parse() then you must add nul termination before using this function. - + - the printed message + the printed message - a #GError from the #GVariantParseError domain + a #GError from the #GVariantParseError domain - the string that was given to the parser + the string that was given to the parser - + - - Same as g_variant_error_quark(). + + Same as g_variant_error_quark(). Use g_variant_parse_error_quark() instead. - + @@ -80051,9 +58791,7 @@ function. - + @@ -80064,39 +58802,26 @@ function. - - Checks if @type_string is a valid GVariant type string. This call is + + Checks if @type_string is a valid GVariant type string. This call is equivalent to calling g_variant_type_string_scan() and confirming that the following character is a nul terminator. - %TRUE if @type_string is exactly one valid type string + %TRUE if @type_string is exactly one valid type string Since 2.24 - a pointer to any string + a pointer to any string - - Scan for a single complete and valid GVariant type string in @string. + + Scan for a single complete and valid GVariant type string in @string. The memory pointed to by @limit (or bytes beyond it) is never accessed. @@ -80111,47 +58836,26 @@ For the simple case of checking if a string is a valid type string, see g_variant_type_string_is_valid(). - %TRUE if a valid type string was found + %TRUE if a valid type string was found - a pointer to any string + a pointer to any string - - the end of @string, or %NULL + + the end of @string, or %NULL - - location to store the end pointer, or %NULL + + location to store the end pointer, or %NULL - - An implementation of the GNU vasprintf() function which supports + + An implementation of the GNU vasprintf() function which supports positional parameters, as specified in the Single Unix Specification. This function is similar to g_vsprintf(), except that it allocates a string to hold the output, instead of putting the output in a buffer @@ -80164,37 +58868,27 @@ multibyte representation is available for the given character. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the return location for the newly-allocated string. + the return location for the newly-allocated string. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - GLib provides version information, primarily useful in configure + GLib provides version information, primarily useful in configure checks for builds that have a configure script. Applications will not typically use the features described here. @@ -80210,82 +58904,56 @@ you want to receive warnings about deprecated APIs. Define the macro %GLIB_VERSION_MAX_ALLOWED to specify the newest version of GLib whose API you want to use. - - An implementation of the standard fprintf() function which supports + + An implementation of the standard fprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the stream to write to. + the stream to write to. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - - An implementation of the standard vprintf() function which supports + + An implementation of the standard vprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - A safer form of the standard vsprintf() function. The output is guaranteed + A safer form of the standard vsprintf() function. The output is guaranteed to not exceed @n characters (including the terminating nul character), so it is easy to ensure that a buffer overflow cannot occur. @@ -80304,156 +58972,104 @@ The format string may contain positional parameters, as specified in the Single Unix Specification. - the number of bytes which would be produced if the buffer + the number of bytes which would be produced if the buffer was large enough. - the buffer to hold the output. + the buffer to hold the output. - the maximum number of bytes to produce (including the + the maximum number of bytes to produce (including the terminating nul character). - a standard printf() format string, but notice - string precision pitfalls][string-precision] + a standard printf() format string, but notice + [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - - An implementation of the standard vsprintf() function which supports + + An implementation of the standard vsprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the buffer to hold the output. + the buffer to hold the output. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - - Logs a warning if the expression is not true. - + + Logs a warning if the expression is not true. + - the expression to check + the expression to check - - Internal function used to print messages from the public g_warn_if_reached() + + Internal function used to print messages from the public g_warn_if_reached() and g_warn_if_fail() macros. - + - - log domain + + log domain - file containing the warning + file containing the warning - line number of the warning + line number of the warning - function containing the warning + function containing the warning - - expression which failed + + expression which failed - GLib defines several warning functions and assertions which can be used to + GLib defines several warning functions and assertions which can be used to warn of programmer errors when calling functions, and print error messages from command line programs. The g_return_if_fail(), g_return_val_if_fail(), g_return_if_reached() and g_return_val_if_reached() macros are intended as pre-condition assertions, to -be used at the top of a public function to check that the function’s +be used at the top of a public function to check that the function’s arguments are acceptable. Any failure of such a pre-condition assertion is considered a programming error on the part of the caller of the public API, and the program is considered to be in an undefined state afterwards. They @@ -80483,14 +59099,12 @@ g_dtls_connection_shutdown (GDtlsConnection *conn, g_print(), g_printerr() and g_set_print_handler() are intended to be used for output from command line applications, since they output to standard output -and standard error by default — whereas functions like g_message() and +and standard error by default — whereas functions like g_message() and g_log() may be redirected to special purpose message windows, files, or the system journal. - These functions provide some level of UNIX emulation on the + These functions provide some level of UNIX emulation on the Windows platform. If your application really needs the POSIX APIs, we suggest you try the Cygwin project. diff --git a/GModule-2.0.gir b/GModule-2.0.gir index 600a453..b049516 100644 --- a/GModule-2.0.gir +++ b/GModule-2.0.gir @@ -24,19 +24,19 @@ It should only be accessed via the following functions. Closes a module. - + line="185">Closes a module. + %TRUE on success + line="191">%TRUE on success a #GModule to close + line="187">a #GModule to close @@ -44,9 +44,9 @@ It should only be accessed via the following functions. Ensures that a module will never be unloaded. + line="204">Ensures that a module will never be unloaded. Any future g_module_close() calls on the module will be ignored. - + @@ -54,7 +54,7 @@ Any future g_module_close() calls on the module will be ignored. a #GModule to make permanently resident + line="206">a #GModule to make permanently resident @@ -62,21 +62,21 @@ Any future g_module_close() calls on the module will be ignored. Returns the filename that the module was opened with. + line="213">Returns the filename that the module was opened with. If @module refers to the application itself, "main" is returned. - + the filename of the module + line="221">the filename of the module a #GModule + line="215">a #GModule @@ -84,26 +84,26 @@ If @module refers to the application itself, "main" is returned. Gets a symbol pointer from a module, such as one exported + line="273">Gets a symbol pointer from a module, such as one exported by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL. - + %TRUE on success + line="282">%TRUE on success a #GModule + line="275">a #GModule the name of the symbol to find + line="276">the name of the symbol to find nullable="1"> returns the pointer to the symbol value + line="277">returns the pointer to the symbol value @@ -121,7 +121,7 @@ by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL. A portable way to build the filename of a module. The platform-specific + line="159">A portable way to build the filename of a module. The platform-specific prefix and suffix are added to the filename, if needed, and the result is added to the directory, using the correct separator character. @@ -134,11 +134,11 @@ For example, calling g_module_build_path() on a Linux system with a @directory of `/lib` and a @module_name of "mylibrary" will return `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the directory it will return `\Windows\mylibrary.dll`. - + the complete path of the module, including the standard library + line="180">the complete path of the module, including the standard library prefix and suffix. This should be freed when no longer needed @@ -149,7 +149,7 @@ directory it will return `\Windows\mylibrary.dll`. allow-none="1"> the directory where the module is. This can be + line="161">the directory where the module is. This can be %NULL or the empty string to indicate that the standard platform-specific directories will be used, though that is not recommended @@ -157,7 +157,7 @@ directory it will return `\Windows\mylibrary.dll`. the name of the module + line="164">the name of the module @@ -165,35 +165,29 @@ directory it will return `\Windows\mylibrary.dll`. Gets a string describing the last module error. - + line="195">Gets a string describing the last module error. + a string describing the last module error + line="200">a string describing the last module error + + + + + Opens a module. If the module has already been opened, -its reference count is incremented. - -First of all g_module_open() tries to open @file_name as a module. -If that fails and @file_name has the ".la"-suffix (and is a libtool -archive) it tries to open the corresponding module. If that fails -and it doesn't have the proper module suffix for the platform -(#G_MODULE_SUFFIX), this suffix will be appended and the corresponding -module will be opened. If that fails and @file_name doesn't have the -".la"-suffix, this suffix is appended and g_module_open() tries to open -the corresponding module. If eventually that fails as well, %NULL is -returned. - + line="225">A thin wrapper function around g_module_open_full() + a #GModule on success, or %NULL on failure + line="234">a #GModule on success, or %NULL on failure @@ -203,14 +197,60 @@ returned. allow-none="1"> the name of the file containing the module, or %NULL + line="227">the name of the file containing the module, or %NULL to obtain a #GModule representing the main program itself the flags used for opening the module. This can be the + line="229">the flags used for opening the module. This can be the + logical OR of any of the #GModuleFlags. + + + + + + Opens a module. If the module has already been opened, +its reference count is incremented. + +First of all g_module_open_full() tries to open @file_name as a module. +If that fails and @file_name has the ".la"-suffix (and is a libtool +archive) it tries to open the corresponding module. If that fails +and it doesn't have the proper module suffix for the platform +(#G_MODULE_SUFFIX), this suffix will be appended and the corresponding +module will be opened. If that fails and @file_name doesn't have the +".la"-suffix, this suffix is appended and g_module_open_full() tries to open +the corresponding module. If eventually that fails as well, %NULL is +returned. + + + a #GModule on success, or %NULL on failure + + + + + the name of the file containing the module, or %NULL + to obtain a #GModule representing the main program itself + + + + the flags used for opening the module. This can be the logical OR of any of the #GModuleFlags @@ -219,12 +259,12 @@ returned. Checks if modules are supported on the current platform. - + line="264">Checks if modules are supported on the current platform. + %TRUE if modules are supported + line="269">%TRUE if modules are supported @@ -253,6 +293,27 @@ error. + + Errors returned by g_module_open_full(). + + + there was an error loading or opening a module file + + + a module returned an error from its `g_module_check_init()` function + + moved-to="Module.build_path"> A portable way to build the filename of a module. The platform-specific + line="159">A portable way to build the filename of a module. The platform-specific prefix and suffix are added to the filename, if needed, and the result is added to the directory, using the correct separator character. @@ -318,11 +379,11 @@ For example, calling g_module_build_path() on a Linux system with a @directory of `/lib` and a @module_name of "mylibrary" will return `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the directory it will return `\Windows\mylibrary.dll`. - + the complete path of the module, including the standard library + line="180">the complete path of the module, including the standard library prefix and suffix. This should be freed when no longer needed @@ -333,7 +394,7 @@ directory it will return `\Windows\mylibrary.dll`. allow-none="1"> the directory where the module is. This can be + line="161">the directory where the module is. This can be %NULL or the empty string to indicate that the standard platform-specific directories will be used, though that is not recommended @@ -341,7 +402,7 @@ directory it will return `\Windows\mylibrary.dll`. the name of the module + line="164">the name of the module @@ -351,33 +412,40 @@ directory it will return `\Windows\mylibrary.dll`. moved-to="Module.error"> Gets a string describing the last module error. - + line="195">Gets a string describing the last module error. + a string describing the last module error + line="200">a string describing the last module error + + + + + Checks if modules are supported on the current platform. - + line="264">Checks if modules are supported on the current platform. + %TRUE if modules are supported + line="269">%TRUE if modules are supported These functions provide a portable way to dynamically load object files + line="79">These functions provide a portable way to dynamically load object files (commonly known as 'plug-ins'). The current implementation supports all systems that provide an implementation of dlopen() (e.g. Linux/Sun), as well as Windows platforms via DLLs. diff --git a/GObject-2.0.gir b/GObject-2.0.gir index f0b9c3c..92b3e52 100644 --- a/GObject-2.0.gir +++ b/GObject-2.0.gir @@ -2,53 +2,37 @@ - + - + - This is the signature of marshaller functions, required to marshall + This is the signature of marshaller functions, required to marshall arrays of parameter values to signal emissions into C language callback -invocations. It is merely an alias to #GClosureMarshal since the #GClosure -mechanism takes over responsibility of actual function invocation for the -signal system. - +invocations. + +It is merely an alias to #GClosureMarshal since the #GClosure mechanism +takes over responsibility of actual function invocation for the signal +system. + - This is the signature of va_list marshaller functions, an optional + This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid marshalling the signal argument into GValues. - + - A numerical value which represents the unique identifier of a registered + A numerical value which represents the unique identifier of a registered type. - + - - A convenience macro to ease adding private data to instances of a new type + + A convenience macro to ease adding private data to instances of a new type in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE(). @@ -67,10 +51,10 @@ For instance: G_ADD_PRIVATE (MyObject)) ]| -Will add MyObjectPrivate as the private data to any instance of the MyObject -type. +Will add `MyObjectPrivate` as the private data to any instance of the +`MyObject` type. -G_DEFINE_TYPE_* macros will automatically create a private function +`G_DEFINE_TYPE_*` macros will automatically create a private function based on the arguments to this macro, which can be used to safely retrieve the private data from an instance of the type; for instance: @@ -98,7 +82,7 @@ retrieve the private data from an instance of the type; for instance: } ]| -Note that this macro can only be used together with the G_DEFINE_TYPE_* +Note that this macro can only be used together with the `G_DEFINE_TYPE_*` macros, since it depends on variable names from those macros. Also note that private structs added with these macros must have a struct @@ -107,34 +91,26 @@ name of the form `TypeNamePrivate`. It is safe to call the `_get_instance_private` function on %NULL or invalid objects since it's only adding an offset to the instance pointer. In that case the returned pointer must not be dereferenced. - + - the name of the type in CamelCase + the name of the type in CamelCase - - A convenience macro to ease adding private data to instances of a new dynamic -type in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See -G_ADD_PRIVATE() for details, it is similar but for static types. + + A convenience macro to ease adding private data to instances of a new dynamic +type in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). + +See G_ADD_PRIVATE() for details, it is similar but for static types. Note that this macro can only be used together with the G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable names from that macro. - + - the name of the type in CamelCase + the name of the type in CamelCase @@ -146,64 +122,55 @@ names from that macro. - A callback function used by the type system to finalize those portions + A callback function used by the type system to finalize those portions of a derived types class structure that were setup from the corresponding -GBaseInitFunc() function. Class finalization basically works the inverse -way in which class initialization is performed. +GBaseInitFunc() function. + +Class finalization basically works the inverse way in which class +initialization is performed. + See GClassInitFunc() for a discussion of the class initialization process. - + - The #GTypeClass structure to finalize + The #GTypeClass structure to finalize - A callback function used by the type system to do base initialization -of the class structures of derived types. It is called as part of the -initialization process of all derived classes and should reallocate -or reset all dynamic class members copied over from the parent class. + A callback function used by the type system to do base initialization +of the class structures of derived types. + +This function is called as part of the initialization process of all derived +classes and should reallocate or reset all dynamic class members copied over +from the parent class. + For example, class members (such as strings) that are not sufficiently handled by a plain memory copy of the parent class into the derived class have to be altered. See GClassInitFunc() for a discussion of the class initialization process. - + - The #GTypeClass structure to initialize + The #GTypeClass structure to initialize - - #GBinding is the representation of a binding between a property on a + + #GBinding is the representation of a binding between a property on a #GObject instance (or source) and another property on another #GObject -instance (or target). Whenever the source property changes, the same -value is applied to the target property; for instance, the following -binding: +instance (or target). + +Whenever the source property changes, the same value is applied to the +target property; for instance, the following binding: |[<!-- language="C" --> g_object_bind_property (object1, "property-a", @@ -276,193 +243,183 @@ and target properties, instead of relying on the last reference on the binding, source, and target instances to drop. #GBinding is available since GObject 2.26 - - Retrieves the flags passed when constructing the #GBinding. - + + Retrieves the #GObject instance used as the source of the binding. + +A #GBinding can outlive the source #GObject as the binding does not hold a +strong reference to the source. If the source is destroyed before the +binding then this function will return %NULL. + + + the source #GObject, or %NULL if the + source does not exist any more. + + + + + a #GBinding + + + + + + Retrieves the #GObject instance used as the target of the binding. + +A #GBinding can outlive the target #GObject as the binding does not hold a +strong reference to the target. If the target is destroyed before the +binding then this function will return %NULL. + + + the target #GObject, or %NULL if the + target does not exist any more. + + + + + a #GBinding + + + + + + Retrieves the flags passed when constructing the #GBinding. + - the #GBindingFlags used by the #GBinding + the #GBindingFlags used by the #GBinding - a #GBinding + a #GBinding - - Retrieves the #GObject instance used as the source of the binding. - - - the source #GObject + + Retrieves the #GObject instance used as the source of the binding. + +A #GBinding can outlive the source #GObject as the binding does not hold a +strong reference to the source. If the source is destroyed before the +binding then this function will return %NULL. + +Use g_binding_dup_source() if the source or binding are used from different +threads as otherwise the pointer returned from this function might become +invalid if the source is finalized from another thread in the meantime. + Use g_binding_dup_source() for a safer version of this +function. + + + the source #GObject, or %NULL if the + source does not exist any more. - a #GBinding + a #GBinding - - Retrieves the name of the property of #GBinding:source used as the source + + Retrieves the name of the property of #GBinding:source used as the source of the binding. - + - the name of the source property + the name of the source property - a #GBinding + a #GBinding - - Retrieves the #GObject instance used as the target of the binding. - - - the target #GObject + + Retrieves the #GObject instance used as the target of the binding. + +A #GBinding can outlive the target #GObject as the binding does not hold a +strong reference to the target. If the target is destroyed before the +binding then this function will return %NULL. + +Use g_binding_dup_target() if the target or binding are used from different +threads as otherwise the pointer returned from this function might become +invalid if the target is finalized from another thread in the meantime. + Use g_binding_dup_target() for a safer version of this +function. + + + the target #GObject, or %NULL if the + target does not exist any more. - a #GBinding + a #GBinding - - Retrieves the name of the property of #GBinding:target used as the target + + Retrieves the name of the property of #GBinding:target used as the target of the binding. - + - the name of the target property + the name of the target property - a #GBinding + a #GBinding - Explicitly releases the binding between the source and the target + Explicitly releases the binding between the source and the target property expressed by @binding. This function will release the reference that is being held on -the @binding instance; if you want to hold on to the #GBinding instance -after calling g_binding_unbind(), you will need to hold a reference -to it. - +the @binding instance if the binding is still bound; if you want to hold on +to the #GBinding instance after calling g_binding_unbind(), you will need +to hold a reference to it. + +Note however that this function does not take ownership of @binding, it +only unrefs the reference that was initially created by +g_object_bind_property() and is owned by the binding. + - a #GBinding + a #GBinding - - Flags to be used to control the #GBinding + + Flags to be used to control the #GBinding - - The #GObject that should be used as the source of the binding + + The #GObject that should be used as the source of the binding - - The name of the property of #GBinding:source that should be used + + The name of the property of #GBinding:source that should be used as the source of the binding. This should be in [canonical form][canonical-parameter-names] to get the best performance. - - The #GObject that should be used as the target of the binding + + The #GObject that should be used as the target of the binding - - The name of the property of #GBinding:target that should be used + + The name of the property of #GBinding:target that should be used as the target of the binding. This should be in [canonical form][canonical-parameter-names] to get the @@ -470,134 +427,83 @@ best performance. - - Flags to be passed to g_object_bind_property() or + + Flags to be passed to g_object_bind_property() or g_object_bind_property_full(). This enumeration can be extended at later date. - - The default binding; if the source property + + The default binding; if the source property changes, the target property is updated with its value. - - Bidirectional binding; if either the + + Bidirectional binding; if either the property of the source or the property of the target changes, the other is updated. - - Synchronize the values of the source and + + Synchronize the values of the source and target properties when creating the binding; the direction of the synchronization is always from the source to the target. - - If the two properties being bound are + + If the two properties being bound are booleans, setting one to %TRUE will result in the other being set to %FALSE and vice versa. This flag will only work for boolean properties, and cannot be used when passing custom transformation functions to g_object_bind_property_full(). - - A function to be called to transform @from_value to @to_value. If -this is the @transform_to function of a binding, then @from_value + + A function to be called to transform @from_value to @to_value. + +If this is the @transform_to function of a binding, then @from_value is the @source_property on the @source object, and @to_value is the @target_property on the @target object. If this is the @transform_from function of a %G_BINDING_BIDIRECTIONAL binding, then those roles are reversed. - + - %TRUE if the transformation was successful, and %FALSE + %TRUE if the transformation was successful, and %FALSE otherwise - a #GBinding + a #GBinding - the #GValue containing the value to transform + the #GValue containing the value to transform - the #GValue in which to store the transformed value + the #GValue in which to store the transformed value - - data passed to the transform function + + data passed to the transform function - This function is provided by the user and should produce a copy + This function is provided by the user and should produce a copy of the passed in boxed structure. - The newly created copy of the boxed structure. + The newly created copy of the boxed structure. - The boxed structure to be copied. + The boxed structure to be copied. - This function is provided by the user and should free the boxed + This function is provided by the user and should free the boxed structure passed. @@ -605,66 +511,43 @@ structure passed. - The boxed structure to be freed. + The boxed structure to be freed. - - Cast a function pointer to a #GCallback. - + + Cast a function pointer to a #GCallback. + - a function pointer. + a function pointer. - - Checks whether the user data of the #GCClosure should be passed as the + + Checks whether the user data of the #GCClosure should be passed as the first parameter to the callback. See g_cclosure_new_swap(). - + - a #GCClosure + a #GCClosure - A #GCClosure is a specialization of #GClosure for C function callbacks. - + A #GCClosure is a specialization of #GClosure for C function callbacks. + - the #GClosure + the #GClosure - the callback function + the callback function - - A #GClosureMarshal function for use with signals with handlers that + + A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled(). @@ -674,115 +557,73 @@ accumulator, such as g_signal_accumulator_true_handled(). - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - - The invocation hint given as the last argument to + + The invocation hint given as the last argument to g_closure_invoke(). - - Additional data specified when registering the + + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -790,11 +631,8 @@ accumulator, such as g_signal_accumulator_true_handled(). - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -803,111 +641,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue which can store the returned #gboolean + a #GValue which can store the returned #gboolean - 2 + 2 - a #GValue array holding instance and arg1 + a #GValue array holding instance and arg1 - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -915,11 +711,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. @@ -927,111 +720,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue, which can store the returned string + a #GValue, which can store the returned string - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1039,11 +790,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. @@ -1051,111 +799,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gboolean parameter + a #GValue array holding the instance and the #gboolean parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1163,11 +869,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. @@ -1175,111 +878,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GBoxed* parameter + a #GValue array holding the instance and the #GBoxed* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1287,11 +948,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. @@ -1299,111 +957,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar parameter + a #GValue array holding the instance and the #gchar parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1411,11 +1027,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. @@ -1423,111 +1036,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gdouble parameter + a #GValue array holding the instance and the #gdouble parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1535,11 +1106,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. @@ -1547,111 +1115,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the enumeration parameter + a #GValue array holding the instance and the enumeration parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1659,11 +1185,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -1671,111 +1194,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the flags parameter + a #GValue array holding the instance and the flags parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1783,11 +1264,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. @@ -1795,111 +1273,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gfloat parameter + a #GValue array holding the instance and the #gfloat parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1907,11 +1343,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. @@ -1919,111 +1352,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gint parameter + a #GValue array holding the instance and the #gint parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2031,11 +1422,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. @@ -2043,111 +1431,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #glong parameter + a #GValue array holding the instance and the #glong parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2155,11 +1501,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. @@ -2167,111 +1510,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GObject* parameter + a #GValue array holding the instance and the #GObject* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2279,11 +1580,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. @@ -2291,111 +1589,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GParamSpec* parameter + a #GValue array holding the instance and the #GParamSpec* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2403,11 +1659,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. @@ -2415,111 +1668,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gpointer parameter + a #GValue array holding the instance and the #gpointer parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2527,11 +1738,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. @@ -2539,111 +1747,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar* parameter + a #GValue array holding the instance and the #gchar* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2651,11 +1817,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. @@ -2663,111 +1826,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guchar parameter + a #GValue array holding the instance and the #guchar parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2775,11 +1896,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. @@ -2787,55 +1905,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guint parameter + a #GValue array holding the instance and the #guint parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. @@ -2843,111 +1940,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2955,67 +2010,43 @@ denotes a flags type. - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -3023,11 +2054,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. @@ -3035,111 +2063,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gulong parameter + a #GValue array holding the instance and the #gulong parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -3147,12 +2133,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. @@ -3160,111 +2142,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GVariant* parameter + a #GValue array holding the instance and the #GVariant* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -3272,11 +2212,8 @@ denotes a flags type. - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer user_data)`. @@ -3284,111 +2221,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 1 + 1 - a #GValue array holding only the instance + a #GValue array holding only the instance - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID(). + + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -3396,134 +2291,87 @@ denotes a flags type. - - A generic marshaller function implemented via + + A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). Normally this function is not passed explicitly to g_signal_new(), but used automatically by GLib when specifying a %NULL marshaller. - + - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - - The invocation hint given as the last argument to + + The invocation hint given as the last argument to g_closure_invoke(). - - Additional data specified when registering the + + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - - A generic #GVaClosureMarshal function implemented via + + A generic #GVaClosureMarshal function implemented via [libffi](http://sourceware.org/libffi/). - + - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args_list. @@ -3532,243 +2380,167 @@ but used automatically by GLib when specifying a %NULL marshaller. - Creates a new closure which invokes @callback_func with @user_data as + Creates a new closure which invokes @callback_func with @user_data as the last parameter. -@destroy_data will be called as a finalize notifier on the #GClosure. - - - a floating reference to a new #GCClosure - - - - - the function to invoke - - - - user data to pass to @callback_func - - - - destroy notify to be called when @user_data is no longer used - - - - - - A variant of g_cclosure_new() which uses @object as @user_data and -calls g_object_watch_closure() on @object and the created -closure. This function is useful when you have a callback closely -associated with a #GObject, and want the callback to no longer run -after the object is is freed. - - - a new #GCClosure - - - - - the function to invoke - - - - a #GObject pointer to pass to @callback_func - - - - - - A variant of g_cclosure_new_swap() which uses @object as @user_data -and calls g_object_watch_closure() on @object and the created -closure. This function is useful when you have a callback closely -associated with a #GObject, and want the callback to no longer run -after the object is is freed. - - - a new #GCClosure - - - - - the function to invoke - - - - a #GObject pointer to pass to @callback_func - - - - - - Creates a new closure which invokes @callback_func with @user_data as -the first parameter. - @destroy_data will be called as a finalize notifier on the #GClosure. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - - the function to invoke + + the function to invoke - - user data to pass to @callback_func + + user data to pass to @callback_func - destroy notify to be called when @user_data is no longer used + destroy notify to be called when @user_data is no longer used + + + + + + A variant of g_cclosure_new() which uses @object as @user_data and +calls g_object_watch_closure() on @object and the created +closure. This function is useful when you have a callback closely +associated with a #GObject, and want the callback to no longer run +after the object is is freed. + + + a new #GCClosure + + + + + the function to invoke + + + + a #GObject pointer to pass to @callback_func + + + + + + A variant of g_cclosure_new_swap() which uses @object as @user_data +and calls g_object_watch_closure() on @object and the created +closure. This function is useful when you have a callback closely +associated with a #GObject, and want the callback to no longer run +after the object is is freed. + + + a new #GCClosure + + + + + the function to invoke + + + + a #GObject pointer to pass to @callback_func + + + + + + Creates a new closure which invokes @callback_func with @user_data as +the first parameter. + +@destroy_data will be called as a finalize notifier on the #GClosure. + + + a floating reference to a new #GCClosure + + + + + the function to invoke + + + + user data to pass to @callback_func + + + + destroy notify to be called when @user_data is no longer used - - Check if the closure still needs a marshaller. See g_closure_set_marshal(). + + Check if the closure still needs a marshaller. See g_closure_set_marshal(). - a #GClosure + a #GClosure - - Get the total number of notifiers connected with the closure @cl. + + Get the total number of notifiers connected with the closure @cl. + The count includes the meta marshaller, the finalize and invalidate notifiers and the marshal guards. Note that each guard counts as two notifiers. See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(), g_closure_add_invalidate_notifier() and g_closure_add_marshal_guards(). - + - a #GClosure + a #GClosure - The type used for callback functions in structure definitions and function -signatures. This doesn't mean that all callback functions must take no -parameters and return void. The required signature of a callback function -is determined by the context in which is used (e.g. the signal to which it -is connected). Use G_CALLBACK() to cast the callback function to a #GCallback. - + The type used for callback functions in structure definitions and function +signatures. + +This doesn't mean that all callback functions must take no parameters and +return void. The required signature of a callback function is determined by +the context in which is used (e.g. the signal to which it is connected). + +Use G_CALLBACK() to cast the callback function to a #GCallback. + - A callback function used by the type system to finalize a class. + A callback function used by the type system to finalize a class. + This function is rarely needed, as dynamically allocated class resources should be handled by GBaseInitFunc() and GBaseFinalizeFunc(). + Also, specification of a GClassFinalizeFunc() in the #GTypeInfo structure of a static type is invalid, because classes of static types will never be finalized (they are artificially kept alive when their reference count drops to zero). - + - The #GTypeClass structure to finalize + The #GTypeClass structure to finalize - - The @class_data member supplied via the #GTypeInfo structure + + The @class_data member supplied via the #GTypeInfo structure - A callback function used by the type system to initialize the class -of a specific type. This function should initialize all static class -members. + A callback function used by the type system to initialize the class +of a specific type. + +This function should initialize all static class members. The initialization process of a class involves: @@ -3837,6 +2609,7 @@ type_b_class_init (TypeBClass *class) class->static_float = 3.14159265358979323846; } ]| + Initialization of TypeBClass will first cause initialization of TypeAClass (derived classes reference their parent classes, see g_type_class_ref() on this). @@ -3861,37 +2634,25 @@ is called to complete the initialization process with the static members Corresponding finalization counter parts to the GBaseInitFunc() functions have to be provided to release allocated resources at class finalization time. - + - The #GTypeClass structure to initialize. + The #GTypeClass structure to initialize. - - The @class_data member supplied via the #GTypeInfo structure. + + The @class_data member supplied via the #GTypeInfo structure. - - A #GClosure represents a callback supplied by the programmer. It -will generally comprise a function of some kind and a marshaller + + A #GClosure represents a callback supplied by the programmer. + +It will generally comprise a function of some kind and a marshaller used to call it. It is the responsibility of the marshaller to convert the arguments for the invocation from #GValues into a suitable form, perform the callback on the converted arguments, @@ -3933,48 +2694,44 @@ callback function/data pointer combination: - g_closure_invalidate() and invalidation notifiers allow callbacks to be automatically removed when the objects they point to go away. - + - + - + - + - + - + - + - + - + - Indicates whether the closure is currently being invoked with + Indicates whether the closure is currently being invoked with g_closure_invoke() - + - Indicates whether the closure has been invalidated by + Indicates whether the closure has been invalidated by g_closure_invalidate() - + - + @@ -4007,42 +2764,33 @@ callback function/data pointer combination: - A variant of g_closure_new_simple() which stores @object in the + A variant of g_closure_new_simple() which stores @object in the @data field of the closure and calls g_object_watch_closure() on @object and the created closure. This function is mainly useful when implementing new types of closures. - + - a newly allocated #GClosure + a newly allocated #GClosure - the size of the structure to allocate, must be at least + the size of the structure to allocate, must be at least `sizeof (GClosure)` - a #GObject pointer to store in the @data field of the newly + a #GObject pointer to store in the @data field of the newly allocated #GClosure - Allocates a struct of the given size and initializes the initial -part as a #GClosure. This function is mainly useful when -implementing new types of closures. + Allocates a struct of the given size and initializes the initial +part as a #GClosure. + +This function is mainly useful when implementing new types of closures: |[<!-- language="C" --> typedef struct _MyClosure MyClosure; @@ -4076,186 +2824,118 @@ MyClosure *my_closure_new (gpointer data) return my_closure; } ]| - + - a floating reference to a new #GClosure + a floating reference to a new #GClosure - the size of the structure to allocate, must be at least + the size of the structure to allocate, must be at least `sizeof (GClosure)` - - data to store in the @data field of the newly allocated #GClosure + + data to store in the @data field of the newly allocated #GClosure - - Registers a finalization notifier which will be called when the -reference count of @closure goes down to 0. Multiple finalization -notifiers on a single closure are invoked in unspecified order. If -a single call to g_closure_unref() results in the closure being -both invalidated and finalized, then the invalidate notifiers will -be run before the finalize notifiers. - + + Registers a finalization notifier which will be called when the +reference count of @closure goes down to 0. + +Multiple finalization notifiers on a single closure are invoked in +unspecified order. If a single call to g_closure_unref() results in +the closure being both invalidated and finalized, then the invalidate +notifiers will be run before the finalize notifiers. + - a #GClosure + a #GClosure - - data to pass to @notify_func + + data to pass to @notify_func - - the callback function to register + + the callback function to register - - Registers an invalidation notifier which will be called when the -@closure is invalidated with g_closure_invalidate(). Invalidation -notifiers are invoked before finalization notifiers, in an -unspecified order. - + + Registers an invalidation notifier which will be called when the +@closure is invalidated with g_closure_invalidate(). + +Invalidation notifiers are invoked before finalization notifiers, +in an unspecified order. + - a #GClosure + a #GClosure - - data to pass to @notify_func + + data to pass to @notify_func - - the callback function to register + + the callback function to register - - Adds a pair of notifiers which get invoked before and after the -closure callback, respectively. This is typically used to protect -the extra arguments for the duration of the callback. See -g_object_watch_closure() for an example of marshal guards. - + + Adds a pair of notifiers which get invoked before and after the +closure callback, respectively. + +This is typically used to protect the extra arguments for the +duration of the callback. See g_object_watch_closure() for an +example of marshal guards. + - a #GClosure + a #GClosure - - data to pass + + data to pass to @pre_marshal_notify - - a function to call before the closure callback + + a function to call before the closure callback - - data to pass + + data to pass to @post_marshal_notify - - a function to call after the closure callback + + a function to call after the closure callback - Sets a flag on the closure to indicate that its calling + Sets a flag on the closure to indicate that its calling environment has become invalid, and thus causes any future invocations of g_closure_invoke() on this @closure to be -ignored. Also, invalidation notifiers installed on the closure will +ignored. + +Also, invalidation notifiers installed on the closure will be called at this point. Note that unless you are holding a reference to the closure yourself, the invalidation notifiers may unref the closure and cause it to be destroyed, so if you need to @@ -4265,210 +2945,151 @@ that you've previously called g_closure_ref(). Note that g_closure_invalidate() will also be called when the reference count of a closure drops to zero (unless it has already been invalidated before). - + - #GClosure to invalidate + #GClosure to invalidate - Invokes the closure, i.e. executes the callback represented by the @closure. - + Invokes the closure, i.e. executes the callback represented by the @closure. + - a #GClosure + a #GClosure - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the length of the @param_values array + the length of the @param_values array - an array of + an array of #GValues holding the arguments on which to invoke the callback of @closure - - a context-dependent invocation hint + + a context-dependent invocation hint - Increments the reference count on a closure to force it staying + Increments the reference count on a closure to force it staying alive while the caller holds a pointer to it. - + - The @closure passed in, for convenience + The @closure passed in, for convenience - #GClosure to increment the reference count on + #GClosure to increment the reference count on - - Removes a finalization notifier. + + Removes a finalization notifier. Notice that notifiers are automatically removed after they are run. - + - a #GClosure + a #GClosure - - data which was passed to g_closure_add_finalize_notifier() + + data which was passed to g_closure_add_finalize_notifier() when registering @notify_func - the callback function to remove + the callback function to remove - - Removes an invalidation notifier. + + Removes an invalidation notifier. Notice that notifiers are automatically removed after they are run. - + - a #GClosure + a #GClosure - - data which was passed to g_closure_add_invalidate_notifier() + + data which was passed to g_closure_add_invalidate_notifier() when registering @notify_func - the callback function to remove + the callback function to remove - - Sets the marshaller of @closure. The `marshal_data` -of @marshal provides a way for a meta marshaller to provide additional -information to the marshaller. (See g_closure_set_meta_marshal().) For -GObject's C predefined marshallers (the g_cclosure_marshal_*() + + Sets the marshaller of @closure. + +The `marshal_data` of @marshal provides a way for a meta marshaller to +provide additional information to the marshaller. + +For GObject's C predefined marshallers (the `g_cclosure_marshal_*()` functions), what it provides is a callback function to use instead of -@closure->callback. - +@closure->callback. + +See also: g_closure_set_meta_marshal() + - a #GClosure + a #GClosure - a #GClosureMarshal function + a #GClosureMarshal function - - Sets the meta marshaller of @closure. A meta marshaller wraps -@closure->marshal and modifies the way it is called in some -fashion. The most common use of this facility is for C callbacks. + + Sets the meta marshaller of @closure. + +A meta marshaller wraps the @closure's marshal and modifies the way +it is called in some fashion. The most common use of this facility +is for C callbacks. + The same marshallers (generated by [glib-genmarshal][glib-genmarshal]), are used everywhere, but the way that we get the callback function -differs. In most cases we want to use @closure->callback, but in +differs. In most cases we want to use the @closure's callback, but in other cases we want to use some different technique to retrieve the callback function. @@ -4477,63 +3098,55 @@ g_signal_type_cclosure_new()) retrieve the callback function from a fixed offset in the class structure. The meta marshaller retrieves the right callback and passes it to the marshaller as the @marshal_data argument. - + - a #GClosure + a #GClosure - - context-dependent data to pass + + context-dependent data to pass to @meta_marshal - - a #GClosureMarshal function + + a #GClosureMarshal function - Takes over the initial ownership of a closure. Each closure is -initially created in a "floating" state, which means that the initial -reference count is not owned by any caller. g_closure_sink() checks -to see if the object is still floating, and if so, unsets the -floating state and decreases the reference count. If the closure -is not floating, g_closure_sink() does nothing. The reason for the -existence of the floating state is to prevent cumbersome code -sequences like: + Takes over the initial ownership of a closure. + +Each closure is initially created in a "floating" state, which means +that the initial reference count is not owned by any caller. + +This function checks to see if the object is still floating, and if so, +unsets the floating state and decreases the reference count. If the +closure is not floating, g_closure_sink() does nothing. + +The reason for the existence of the floating state is to prevent +cumbersome code sequences like: + |[<!-- language="C" --> closure = g_cclosure_new (cb_func, cb_data); g_source_set_closure (source, closure); g_closure_unref (closure); // GObject doesn't really need this ]| + Because g_source_set_closure() (and similar functions) take ownership of the initial reference count, if it is unowned, we instead can write: + |[<!-- language="C" --> g_source_set_closure (source, g_cclosure_new (cb_func, cb_data)); ]| Generally, this function is used together with g_closure_ref(). An example of storing a closure for later notification looks like: + |[<!-- language="C" --> static GClosure *notify_closure = NULL; void @@ -4553,99 +3166,72 @@ foo_notify_set_closure (GClosure *closure) Because g_closure_sink() may decrement the reference count of a closure (if it hasn't been called on @closure yet) just like g_closure_unref(), g_closure_ref() should be called prior to this function. - + - #GClosure to decrement the initial reference count on, if it's + #GClosure to decrement the initial reference count on, if it's still being held - Decrements the reference count of a closure after it was previously -incremented by the same caller. If no other callers are using the -closure, then the closure will be destroyed and freed. - + Decrements the reference count of a closure after it was previously +incremented by the same caller. + +If no other callers are using the closure, then the closure will be +destroyed and freed. + - #GClosure to decrement the reference count on + #GClosure to decrement the reference count on - The type used for marshaller functions. - + The type used for marshaller functions. + - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the length of the @param_values array + the length of the @param_values array - an array of + an array of #GValues holding the arguments on which to invoke the callback of @closure - - the invocation hint given as the + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -4653,34 +3239,25 @@ closure, then the closure will be destroyed and freed. - The type used for the various notification callbacks which can be registered + The type used for the various notification callbacks which can be registered on closures. - + - - data specified when registering the notification callback + + data specified when registering the notification callback - the #GClosure on which the notification is emitted + the #GClosure on which the notification is emitted - + @@ -4689,36 +3266,25 @@ on closures. - The connection flags are used to specify the behaviour of a signal's + The connection flags are used to specify the behaviour of a signal's connection. - + - whether the handler should be called before or after the + whether the handler should be called before or after the default handler of the signal. - whether the instance and data should be swapped when + whether the instance and data should be swapped when calling the handler; see g_signal_connect_swapped() for an example. - - A convenience macro for emitting the usual declarations in the + + A convenience macro for emitting the usual declarations in the header file for a type which is intended to be subclassed. You might use it in a header as follows: -|[ +|[<!-- language="C" --> #ifndef _gtk_frobber_h_ #define _gtk_frobber_h_ @@ -4745,26 +3311,26 @@ GtkWidget * gtk_frobber_new (void); This results in the following things happening: -- the usual gtk_frobber_get_type() function is declared with a return type of #GType +- the usual `gtk_frobber_get_type()` function is declared with a return type of #GType -- the GtkFrobber struct is created with GtkWidget as the first and only item. You are expected to use +- the `GtkFrobber` struct is created with `GtkWidget` as the first and only item. You are expected to use a private structure from your .c file to store your instance variables. -- the GtkFrobberClass type is defined as a typedef to struct _GtkFrobberClass, which is left undefined. +- the `GtkFrobberClass` type is defined as a typedef to `struct _GtkFrobberClass`, which is left undefined. You should do this from the header file directly after you use the macro. -- the GTK_FROBBER() and GTK_FROBBER_CLASS() casts are emitted as static inline functions along with - the GTK_IS_FROBBER() and GTK_IS_FROBBER_CLASS() type checking functions and GTK_FROBBER_GET_CLASS() +- the `GTK_FROBBER()` and `GTK_FROBBER_CLASS()` casts are emitted as `static inline` functions along with + the `GTK_IS_FROBBER()` and `GTK_IS_FROBBER_CLASS()` type checking functions and `GTK_FROBBER_GET_CLASS()` function. - g_autoptr() support being added for your type, based on the type of your parent class You can only use this function if your parent type also supports g_autoptr(). -Because the type macro (GTK_TYPE_FROBBER in the above example) is not a callable, you must continue to +Because the type macro (`GTK_TYPE_FROBBER` in the above example) is not a callable, you must continue to manually define this as a macro for yourself. -The declaration of the _get_type() function is the first thing emitted by the macro. This allows this macro +The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro to be used in the usual way with export control and API versioning macros. If you are writing a library, it is important to note that it is possible to convert a type from using @@ -4777,48 +3343,33 @@ structures, use G_DECLARE_FINAL_TYPE(). If you must use G_DECLARE_DERIVABLE_TYPE() you should be sure to include some padding at the bottom of your class structure to leave space for the addition of future virtual functions. - + - The name of the new type, in camel case (like GtkWidget) + The name of the new type, in camel case (like `GtkWidget`) - The name of the new type in lowercase, with words - separated by '_' (like 'gtk_widget') + The name of the new type in lowercase, with words + separated by `_` (like `gtk_widget`) - The name of the module, in all caps (like 'GTK') + The name of the module, in all caps (like `GTK`) - The bare name of the type, in all caps (like 'WIDGET') + The bare name of the type, in all caps (like `WIDGET`) - the name of the parent type, in camel case (like GtkWidget) + the name of the parent type, in camel case (like `GtkWidget`) - - A convenience macro for emitting the usual declarations in the header file for a type which is not (at the -present time) intended to be subclassed. + + A convenience macro for emitting the usual declarations in the header file +for a type which is not (at the present time) intended to be subclassed. You might use it in a header as follows: -|[ +|[<!-- language="C" --> #ifndef _myapp_window_h_ #define _myapp_window_h_ @@ -4836,15 +3387,15 @@ MyAppWindow * my_app_window_new (void); This results in the following things happening: -- the usual my_app_window_get_type() function is declared with a return type of #GType +- the usual `my_app_window_get_type()` function is declared with a return type of #GType -- the MyAppWindow types is defined as a typedef of struct _MyAppWindow. The struct itself is not +- the `MyAppWindow` type is defined as a `typedef` of `struct _MyAppWindow`. The struct itself is not defined and should be defined from the .c file before G_DEFINE_TYPE() is used. -- the MY_APP_WINDOW() cast is emitted as static inline function along with the MY_APP_IS_WINDOW() type +- the `MY_APP_WINDOW()` cast is emitted as `static inline` function along with the `MY_APP_IS_WINDOW()` type checking function -- the MyAppWindowClass type is defined as a struct containing GtkWindowClass. This is done for the +- the `MyAppWindowClass` type is defined as a struct containing `GtkWindowClass`. This is done for the convenience of the person defining the type and should not be considered to be part of the ABI. In particular, without a firm declaration of the instance structure, it is not possible to subclass the type and therefore the fact that the size of the class structure is exposed is not a concern and it can be @@ -4854,10 +3405,10 @@ This results in the following things happening: You can only use this function if your parent type also supports g_autoptr(). -Because the type macro (MY_APP_TYPE_WINDOW in the above example) is not a callable, you must continue to +Because the type macro (`MY_APP_TYPE_WINDOW` in the above example) is not a callable, you must continue to manually define this as a macro for yourself. -The declaration of the _get_type() function is the first thing emitted by the macro. This allows this macro +The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro to be used in the usual way with export control and API versioning macros. If you want to declare your own class structure, use G_DECLARE_DERIVABLE_TYPE(). @@ -4867,47 +3418,32 @@ G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be subclassed. Once a class structure has been exposed it is not possible to change its size or remove or reorder items without breaking the API and/or ABI. - + - The name of the new type, in camel case (like GtkWidget) + The name of the new type, in camel case (like `GtkWidget`) - The name of the new type in lowercase, with words - separated by '_' (like 'gtk_widget') + The name of the new type in lowercase, with words + separated by `_` (like `gtk_widget`) - The name of the module, in all caps (like 'GTK') + The name of the module, in all caps (like `GTK`) - The bare name of the type, in all caps (like 'WIDGET') + The bare name of the type, in all caps (like `WIDGET`) - the name of the parent type, in camel case (like GtkWidget) + the name of the parent type, in camel case (like `GtkWidget`) - - A convenience macro for emitting the usual declarations in the header file for a GInterface type. + + A convenience macro for emitting the usual declarations in the header file for a #GInterface type. You might use it in a header as follows: -|[ +|[<!-- language="C" --> #ifndef _my_model_h_ #define _my_model_h_ @@ -4931,189 +3467,146 @@ gpointer my_model_get_item (MyModel *model); This results in the following things happening: -- the usual my_model_get_type() function is declared with a return type of #GType +- the usual `my_model_get_type()` function is declared with a return type of #GType -- the MyModelInterface type is defined as a typedef to struct _MyModelInterface, +- the `MyModelInterface` type is defined as a typedef to `struct _MyModelInterface`, which is left undefined. You should do this from the header file directly after you use the macro. -- the MY_MODEL() cast is emitted as static inline functions along with - the MY_IS_MODEL() type checking function and MY_MODEL_GET_IFACE() function. +- the `MY_MODEL()` cast is emitted as `static inline` functions along with + the `MY_IS_MODEL()` type checking function and `MY_MODEL_GET_IFACE()` function. - g_autoptr() support being added for your type, based on your prerequisite type. You can only use this function if your prerequisite type also supports g_autoptr(). -Because the type macro (MY_TYPE_MODEL in the above example) is not a callable, you must continue to +Because the type macro (`MY_TYPE_MODEL` in the above example) is not a callable, you must continue to manually define this as a macro for yourself. -The declaration of the _get_type() function is the first thing emitted by the macro. This allows this macro +The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro to be used in the usual way with export control and API versioning macros. - + - The name of the new type, in camel case (like GtkWidget) + The name of the new type, in camel case (like `GtkWidget`) - The name of the new type in lowercase, with words - separated by '_' (like 'gtk_widget') + The name of the new type in lowercase, with words + separated by `_` (like `gtk_widget`) - The name of the module, in all caps (like 'GTK') + The name of the module, in all caps (like `GTK`) - The bare name of the type, in all caps (like 'WIDGET') + The bare name of the type, in all caps (like `WIDGET`) - the name of the prerequisite type, in camel case (like GtkWidget) + the name of the prerequisite type, in camel case (like `GtkWidget`) - - A convenience macro for type implementations. + + A convenience macro for type implementations. + Similar to G_DEFINE_TYPE(), but defines an abstract type. See G_DEFINE_TYPE_EXTENDED() for an example. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words - separated by '_'. + The name of the new type, in lowercase, with words + separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - - A convenience macro for type implementations. + + A convenience macro for type implementations. + Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and -allows you to insert custom code into the *_get_type() function, e.g. +allows you to insert custom code into the `*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). + See G_DEFINE_TYPE_EXTENDED() for an example. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words - separated by '_'. + The name of the new type, in lowercase, with words + separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - Custom code that gets inserted in the @type_name_get_type() function. + Custom code that gets inserted in the `type_name_get_type()` function. - - Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type. + + Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type. + See G_DEFINE_TYPE_EXTENDED() for an example. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words - separated by '_'. + The name of the new type, in lowercase, with words + separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - - A convenience macro for boxed type implementations, which defines a -type_name_get_type() function registering the boxed type. - + + A convenience macro for defining a new custom boxed type. + +Using this macro is the recommended way of defining new custom boxed +types, over calling g_boxed_type_register_static() directly. It defines +a `type_name_get_type()` function which will return the newly defined +#GType, enabling lazy instantiation. + +|[<!-- language="C" --> +G_DEFINE_BOXED_TYPE (MyStruct, my_struct, my_struct_copy, my_struct_free) + +void +foo () +{ + GType type = my_struct_get_type (); + // ... your code ... +} +]| + - The name of the new type, in Camel case + The name of the new type, in Camel case - The name of the new type, in lowercase, with words - separated by '_' + The name of the new type, in lowercase, with words + separated by `_` - the #GBoxedCopyFunc for the new type + the #GBoxedCopyFunc for the new type - the #GBoxedFreeFunc for the new type + the #GBoxedFreeFunc for the new type - - A convenience macro for boxed type implementations. + + A convenience macro for boxed type implementations. + Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the -type_name_get_type() function, e.g. to register value transformations with +`type_name_get_type()` function, e.g. to register value transformations with g_value_register_transform_func(), for instance: |[<!-- language="C" --> @@ -5125,80 +3618,55 @@ G_DEFINE_BOXED_TYPE_WITH_CODE (GdkRectangle, gdk_rectangle, Similarly to the %G_DEFINE_TYPE family of macros, the #GType of the newly defined boxed type is exposed in the `g_define_type_id` variable. - + - The name of the new type, in Camel case + The name of the new type, in Camel case - The name of the new type, in lowercase, with words - separated by '_' + The name of the new type, in lowercase, with words + separated by `_` - the #GBoxedCopyFunc for the new type + the #GBoxedCopyFunc for the new type - the #GBoxedFreeFunc for the new type + the #GBoxedFreeFunc for the new type - Custom code that gets inserted in the *_get_type() function + Custom code that gets inserted in the `*_get_type()` function - - A convenience macro for dynamic type implementations, which declares a + + A convenience macro for dynamic type implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these) and a static variable named -`t_n`_parent_class pointing to the parent class. Furthermore, -it defines a `*_get_type()` and a static `*_register_type()` functions -for use in your `module_init()`. +`t_n`_parent_class pointing to the parent class. + +Furthermore, it defines a `*_get_type()` and a static `*_register_type()` +functions for use in your `module_init()`. See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words + The name of the new type, in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - - A more general version of G_DEFINE_DYNAMIC_TYPE() which + + A more general version of G_DEFINE_DYNAMIC_TYPE() which allows to specify #GTypeFlags and custom code. -|[ +|[<!-- language="C" --> G_DEFINE_DYNAMIC_TYPE_EXTENDED (GtkGadget, gtk_gadget, GTK_TYPE_THING, @@ -5206,8 +3674,10 @@ G_DEFINE_DYNAMIC_TYPE_EXTENDED (GtkGadget, G_IMPLEMENT_INTERFACE_DYNAMIC (TYPE_GIZMO, gtk_gadget_gizmo_init)); ]| + expands to -|[ + +|[<!-- language="C" --> static void gtk_gadget_init (GtkGadget *self); static void gtk_gadget_class_init (GtkGadgetClass *klass); static void gtk_gadget_class_finalize (GtkGadgetClass *klass); @@ -5255,44 +3725,94 @@ gtk_gadget_register_type (GTypeModule *type_module) } } ]| - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words + The name of the new type, in lowercase, with words separated by '_'. - The #GType of the parent type. + The #GType of the parent type. - #GTypeFlags to pass to g_type_module_register_type() + #GTypeFlags to pass to g_type_module_register_type() - Custom code that gets inserted in the *_get_type() function. + Custom code that gets inserted in the *_get_type() function. - - A convenience macro for #GTypeInterface definitions, which declares -a default vtable initialization function and defines a *_get_type() + + A convenience macro for type implementations. + +Similar to G_DEFINE_TYPE(), but defines a final type. + +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + the name of the new type, in Camel case + + + the name of the new type, in lower case, with words + separated by `_` (snake case) + + + the #GType of the parent type + + + + + A convenience macro for type implementations. + +Similar to G_DEFINE_TYPE_WITH_CODE(), but defines a final type and +allows you to insert custom code into the `*_get_type()` function, e.g. +interface implementations via G_IMPLEMENT_INTERFACE(). + +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + the name of the new type, in Camel case + + + the name of the new type, in lower case, with words + separated by `_` (snake case) + + + the #GType of the parent type + + + Custom code that gets inserted in the `type_name_get_type()` function. + + + + + A convenience macro for type implementations. + +Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines a final type. + +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + the name of the new type, in Camel case + + + the name of the new type, in lower case, with words + separated by `_` (snake case) + + + the #GType of the parent type + + + + + A convenience macro for #GTypeInterface definitions, which declares +a default vtable initialization function and defines a `*_get_type()` function. The macro expects the interface initialization function to have the @@ -5304,153 +3824,100 @@ The initialization function has signature the full #GInterfaceInitFunc signature, for brevity and convenience. If you need to use an initialization function with an `iface_data` argument, you must write the #GTypeInterface definitions manually. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words separated by '_'. + The name of the new type, in lowercase, with words separated by `_`. - The #GType of the prerequisite type for the interface, or 0 -(%G_TYPE_INVALID) for no prerequisite type. + The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID +for no prerequisite type. - - A convenience macro for #GTypeInterface definitions. Similar to -G_DEFINE_INTERFACE(), but allows you to insert custom code into the -*_get_type() function, e.g. additional interface implementations -via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. See -G_DEFINE_TYPE_EXTENDED() for a similar example using + + A convenience macro for #GTypeInterface definitions. + +Similar to G_DEFINE_INTERFACE(), but allows you to insert custom code +into the `*_get_type()` function, e.g. additional interface implementations +via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. + +See G_DEFINE_TYPE_EXTENDED() for a similar example using G_DEFINE_TYPE_WITH_CODE(). - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words separated by '_'. + The name of the new type, in lowercase, with words separated by `_`. - The #GType of the prerequisite type for the interface, or 0 -(%G_TYPE_INVALID) for no prerequisite type. + The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID +for no prerequisite type. - Custom code that gets inserted in the *_get_type() function. + Custom code that gets inserted in the `*_get_type()` function. - - A convenience macro for pointer type implementations, which defines a -type_name_get_type() function registering the pointer type. - + + A convenience macro for pointer type implementations, which defines a +`type_name_get_type()` function registering the pointer type. + - The name of the new type, in Camel case + The name of the new type, in Camel case - The name of the new type, in lowercase, with words - separated by '_' + The name of the new type, in lowercase, with words + separated by `_` - - A convenience macro for pointer type implementations. + + A convenience macro for pointer type implementations. Similar to G_DEFINE_POINTER_TYPE(), but allows to insert -custom code into the type_name_get_type() function. - +custom code into the `type_name_get_type()` function. + - The name of the new type, in Camel case + The name of the new type, in Camel case - The name of the new type, in lowercase, with words - separated by '_' + The name of the new type, in lowercase, with words + separated by `_` - Custom code that gets inserted in the *_get_type() function + Custom code that gets inserted in the `*_get_type()` function - - A convenience macro for type implementations, which declares a class + + A convenience macro for type implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these) and a static variable named `t_n_parent_class` -pointing to the parent class. Furthermore, it defines a *_get_type() function. +pointing to the parent class. Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED() for an example. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words - separated by '_'. + The name of the new type, in lowercase, with words + separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - - The most general convenience macro for type implementations, on which + + The most general convenience macro for type implementations, on which G_DEFINE_TYPE(), etc are based. |[<!-- language="C" --> @@ -5462,7 +3929,9 @@ G_DEFINE_TYPE_EXTENDED (GtkGadget, G_IMPLEMENT_INTERFACE (TYPE_GIZMO, gtk_gadget_gizmo_init)); ]| + expands to + |[<!-- language="C" --> static void gtk_gadget_init (GtkGadget *self); static void gtk_gadget_class_init (GtkGadgetClass *klass); @@ -5483,8 +3952,8 @@ static inline gpointer gtk_gadget_get_instance_private (GtkGadget *self) GType gtk_gadget_get_type (void) { - static volatile gsize g_define_type_id__volatile = 0; - if (g_once_init_enter (&g_define_type_id__volatile)) + static gsize static_g_define_type_id = 0; + if (g_once_init_enter (&static_g_define_type_id)) { GType g_define_type_id = g_type_register_static_simple (GTK_TYPE_WIDGET, @@ -5504,1000 +3973,642 @@ gtk_gadget_get_type (void) }; g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info); } - g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); + g_once_init_leave (&static_g_define_type_id, g_define_type_id); } - return g_define_type_id__volatile; + return static_g_define_type_id; } ]| + The only pieces which have to be manually provided are the definitions of the instance and class structure and the definitions of the instance and class init functions. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words - separated by '_'. + The name of the new type, in lowercase, with words + separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - #GTypeFlags to pass to g_type_register_static() + #GTypeFlags to pass to g_type_register_static() - Custom code that gets inserted in the *_get_type() function. + Custom code that gets inserted in the `*_get_type()` function. - - A convenience macro for type implementations. + + A convenience macro for type implementations. + Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the -*_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). +`*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example. - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type in lowercase, with words separated by '_'. + The name of the new type in lowercase, with words separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - Custom code that gets inserted in the *_get_type() function. + Custom code that gets inserted in the `*_get_type()` function. - - A convenience macro for type implementations, which declares a class + + A convenience macro for type implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these), a static variable named `t_n_parent_class` pointing to the parent class, and adds private instance data to the type. -Furthermore, it defines a *_get_type() function. See G_DEFINE_TYPE_EXTENDED() + +Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED() for an example. Note that private structs added with this macros must have a struct -name of the form @TN Private. +name of the form `TN ## Private`. The private instance data can be retrieved using the automatically generated getter function `t_n_get_instance_private()`. See also: G_ADD_PRIVATE() - + - The name of the new type, in Camel case. + The name of the new type, in Camel case. - The name of the new type, in lowercase, with words - separated by '_'. + The name of the new type, in lowercase, with words + separated by `_`. - The #GType of the parent type. + The #GType of the parent type. - - Casts a derived #GEnumClass structure into a #GEnumClass structure. + + Casts a derived #GEnumClass structure into a #GEnumClass structure. - a valid #GEnumClass + a valid #GEnumClass - - Get the type identifier from a given #GEnumClass structure. + + Get the type identifier from a given #GEnumClass structure. - a #GEnumClass + a #GEnumClass - - Get the static type name from a given #GEnumClass structure. + + Get the static type name from a given #GEnumClass structure. - a #GEnumClass + a #GEnumClass - The class of an enumeration type holds information about its + The class of an enumeration type holds information about its possible values. - the parent class + the parent class - the smallest possible value. + the smallest possible value. - the largest possible value. + the largest possible value. - the number of possible values. + the number of possible values. - an array of #GEnumValue structs describing the + an array of #GEnumValue structs describing the individual values. - A structure which contains a single enum value, its name, and its + A structure which contains a single enum value, its name, and its nickname. - the enum value + the enum value - the name of the value + the name of the value - the nickname of the value + the nickname of the value - - Casts a derived #GFlagsClass structure into a #GFlagsClass structure. + + Casts a derived #GFlagsClass structure into a #GFlagsClass structure. - a valid #GFlagsClass + a valid #GFlagsClass - - Get the type identifier from a given #GFlagsClass structure. + + Get the type identifier from a given #GFlagsClass structure. - a #GFlagsClass + a #GFlagsClass - - Get the static type name from a given #GFlagsClass structure. + + Get the static type name from a given #GFlagsClass structure. - a #GFlagsClass + a #GFlagsClass - The class of a flags type holds information about its + The class of a flags type holds information about its possible values. - the parent class + the parent class - a mask covering all possible values. + a mask covering all possible values. - the number of possible values. + the number of possible values. - an array of #GFlagsValue structs describing the + an array of #GFlagsValue structs describing the individual values. - A structure which contains a single flags value, its name, and its + A structure which contains a single flags value, its name, and its nickname. - the flags value + the flags value - the name of the value + the name of the value - the nickname of the value + the nickname of the value - - A convenience macro to ease interface addition in the `_C_` section + + A convenience macro to ease interface addition in the `_C_` section of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE(). See G_DEFINE_TYPE_EXTENDED() for an example. -Note that this macro can only be used together with the G_DEFINE_TYPE_* +Note that this macro can only be used together with the `G_DEFINE_TYPE_*` macros, since it depends on variable names from those macros. - + - The #GType of the interface to add + The #GType of the interface to add - The interface init function, of type #GInterfaceInitFunc + The interface init function, of type #GInterfaceInitFunc - - A convenience macro to ease interface addition in the @_C_ section -of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See G_DEFINE_DYNAMIC_TYPE_EXTENDED() -for an example. + + A convenience macro to ease interface addition in the @_C_ section +of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). + +See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. Note that this macro can only be used together with the G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable names from that macro. - + - The #GType of the interface to add + The #GType of the interface to add - The interface init function + The interface init function - - Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) -pointer. Depending on the current debugging level, this function may invoke + + Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) +pointer. + +Depending on the current debugging level, this function may invoke certain runtime checks to identify invalid casts. - + - Object which is subject to casting. + Object which is subject to casting. - - Casts a derived #GInitiallyUnownedClass structure into a + + Casts a derived #GInitiallyUnownedClass structure into a #GInitiallyUnownedClass structure. - + - a valid #GInitiallyUnownedClass + a valid #GInitiallyUnownedClass - - Get the class structure associated to a #GInitiallyUnowned instance. - + + Get the class structure associated to a #GInitiallyUnowned instance. + - a #GInitiallyUnowned instance. + a #GInitiallyUnowned instance. - + - - Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM + + Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM or derived. - a #GEnumClass + a #GEnumClass - - Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS + + Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS or derived. - a #GFlagsClass + a #GFlagsClass - - Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED. - + + Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED. + - Instance to check for being a %G_TYPE_INITIALLY_UNOWNED. + Instance to check for being a %G_TYPE_INITIALLY_UNOWNED. - - Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type + + Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type %G_TYPE_INITIALLY_UNOWNED or derived. - + - a #GInitiallyUnownedClass + a #GInitiallyUnownedClass - - Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT. - + + Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT. + - Instance to check for being a %G_TYPE_OBJECT. + Instance to check for being a %G_TYPE_OBJECT. - - Checks whether @class "is a" valid #GObjectClass structure of type + + Checks whether @class "is a" valid #GObjectClass structure of type %G_TYPE_OBJECT or derived. - + - a #GObjectClass + a #GObjectClass - - Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM + + Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM or derived. - a #GParamSpec + a #GParamSpec - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether @pclass "is a" valid #GParamSpecClass structure of type + + Checks whether @pclass "is a" valid #GParamSpecClass structure of type %G_TYPE_PARAM or derived. - a #GParamSpecClass + a #GParamSpecClass - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_GTYPE. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_GTYPE. - a #GParamSpec + a #GParamSpec - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OVERRIDE. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OVERRIDE. - a #GParamSpec + a #GParamSpec - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY. Use #GArray instead of #GValueArray - a valid #GParamSpec instance + a valid #GParamSpec instance - - Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VARIANT. + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VARIANT. - a #GParamSpec + a #GParamSpec - + - + - + - + - - Checks if @value is a valid and initialized #GValue structure. - + + Checks if @value is a valid and initialized #GValue structure. + - A #GValue structure. + A #GValue structure. - - All the fields in the GInitiallyUnowned structure -are private to the #GInitiallyUnowned implementation and should never be -accessed directly. - + + A type for objects that have an initially floating reference. + +All the fields in the `GInitiallyUnowned` structure are private to the +implementation and should never be accessed directly. + - + - - The class structure for the GInitiallyUnowned type. - + + The class structure for the GInitiallyUnowned type. + - the parent class + the parent class @@ -6507,7 +4618,7 @@ accessed directly. - + @@ -6519,15 +4630,14 @@ accessed directly. - + - + @@ -6549,7 +4659,7 @@ accessed directly. - + @@ -6571,7 +4681,7 @@ accessed directly. - + @@ -6584,7 +4694,7 @@ accessed directly. - + @@ -6597,7 +4707,7 @@ accessed directly. - + @@ -6616,15 +4726,13 @@ accessed directly. - + - a #GObject + a #GObject @@ -6635,7 +4743,7 @@ accessed directly. - + @@ -6656,11 +4764,11 @@ accessed directly. - A callback function used by the type system to initialize a new -instance of a type. This function initializes all instance members and -allocates any resources required by it. + A callback function used by the type system to initialize a new +instance of a type. + +This function initializes all instance members and allocates any resources +required by it. Initialization of a derived instance involves calling all its parent types instance initializers, so the class member of the instance @@ -6669,245 +4777,167 @@ belongs to the type the current initializer was introduced for. The extended members of @instance are guaranteed to have been filled with zeros before this function is called. - + - The instance to initialize + The instance to initialize - The class of the type the instance is + The class of the type the instance is created for - A callback function used by the type system to finalize an interface. + A callback function used by the type system to finalize an interface. + This function should destroy any internal data and release any resources allocated by the corresponding GInterfaceInitFunc() function. - + - The interface structure to finalize + The interface structure to finalize - - The @interface_data supplied via the #GInterfaceInfo structure + + The @interface_data supplied via the #GInterfaceInfo structure - A structure that provides information to the type system which is + A structure that provides information to the type system which is used specifically for managing interface types. - + - location of the interface initialization function + location of the interface initialization function - location of the interface finalization function + location of the interface finalization function - user-supplied data passed to the interface init/finalize functions + user-supplied data passed to the interface init/finalize functions - A callback function used by the type system to initialize a new -interface. This function should initialize all internal data and -allocate any resources required by the interface. + A callback function used by the type system to initialize a new +interface. + +This function should initialize all internal data and* allocate any +resources required by the interface. The members of @iface_data are guaranteed to have been filled with zeros before this function is called. - + - The interface structure to initialize + The interface structure to initialize - - The @interface_data supplied via the #GInterfaceInfo structure + + The @interface_data supplied via the #GInterfaceInfo structure - Casts a #GObject or derived pointer into a (GObject*) pointer. + Casts a #GObject or derived pointer into a (GObject*) pointer. + Depending on the current debugging level, this function may invoke certain runtime checks to identify invalid casts. - + - Object which is subject to casting. + Object which is subject to casting. - - Casts a derived #GObjectClass structure into a #GObjectClass structure. - + + Casts a derived #GObjectClass structure into a #GObjectClass structure. + - a valid #GObjectClass + a valid #GObjectClass - - Return the name of a class structure's type. - + + Return the name of a class structure's type. + - a valid #GObjectClass + a valid #GObjectClass - - Get the type id of a class structure. - + + Get the type id of a class structure. + - a valid #GObjectClass + a valid #GObjectClass - - Get the class structure associated to a #GObject instance. - + + Get the class structure associated to a #GObject instance. + - a #GObject instance. + a #GObject instance. - - Get the type id of an object. - + + Get the type id of an object. + - Object to return the type id for. + Object to return the type id for. - - Get the name of an object's type. - + + Get the name of an object's type. + - Object to return the type name for. + Object to return the type name for. - - This macro should be used to emit a standard warning about unexpected + + This macro should be used to emit a standard warning about unexpected properties in set_property() and get_property() implementations. - + - the #GObject on which set_property() or get_property() was called + the #GObject on which set_property() or get_property() was called - the numeric id of the property + the numeric id of the property - the #GParamSpec of the property + the #GParamSpec of the property - - + + @@ -6919,21 +4949,14 @@ properties in set_property() and get_property() implementations. - - All the fields in the GObject structure are private -to the #GObject implementation and should never be accessed directly. - + + The base object type. + +All the fields in the `GObject` structure are private to the implementation +and should never be accessed directly. + - Creates a new instance of a #GObject subtype and sets its properties. + Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. Any @@ -6953,162 +4976,114 @@ make use of the %G_GINT64_CONSTANT or %G_GUINT64_CONSTANT macros. Similarly, #gfloat is promoted to #gdouble, so you must ensure that the value you provide is a #gdouble, even for a property of type #gfloat. - + - a new instance of + a new instance of @object_type - the type id of the #GObject subtype to instantiate + the type id of the #GObject subtype to instantiate - the name of the first property + the name of the first property - the value of the first property, followed optionally by more + the value of the first property, followed optionally by more name/value pairs, followed by %NULL - - Creates a new instance of a #GObject subtype and sets its properties. + + Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - + - a new instance of @object_type + a new instance of @object_type - the type id of the #GObject subtype to instantiate + the type id of the #GObject subtype to instantiate - the name of the first property + the name of the first property - the value of the first property, followed optionally by more + the value of the first property, followed optionally by more name/value pairs, followed by %NULL - - Creates a new instance of a #GObject subtype and sets its properties using + + Creates a new instance of a #GObject subtype and sets its properties using the provided arrays. Both arrays must have exactly @n_properties elements, and the names and values correspond by index. Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - + - a new instance of + a new instance of @object_type - the object type to instantiate + the object type to instantiate - the number of properties + the number of properties - the names of each property to be set + the names of each property to be set - the values of each property to be set + the values of each property to be set - - Creates a new instance of a #GObject subtype and sets its properties. + + Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. Use g_object_new_with_properties() instead. deprecated. See #GParameter for more information. - + - a new instance of + a new instance of @object_type - the type id of the #GObject subtype to instantiate + the type id of the #GObject subtype to instantiate - the length of the @parameters array + the length of the @parameters array - an array of #GParameter + an array of #GParameter @@ -7116,7 +5091,7 @@ deprecated. See #GParameter for more information. - + @@ -7124,55 +5099,38 @@ deprecated. See #GParameter for more information. - + - - Find the #GParamSpec with the given name for an + + Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). - + - the #GParamSpec for the property of the + the #GParamSpec for the property of the interface with the name @property_name, or %NULL if no such property exists. - any interface vtable for the + any interface vtable for the interface, or the default vtable for the interface - name of a property to look up. + name of a property to look up. - - Add a property to an interface; this is only useful for interfaces + + Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly @@ -7188,41 +5146,31 @@ vtable initialization function (the @class_init member of been called for any object types implementing this interface. If @pspec is a floating reference, it will be consumed. - + - any interface vtable for the + any interface vtable for the interface, or the default vtable for the interface. - the #GParamSpec for the new property + the #GParamSpec for the new property - - Lists the properties of an interface.Generally, the interface + + Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). - + - a + a pointer to an array of pointers to #GParamSpec structures. The paramspecs are owned by GLib, but the array should be freed with g_free() when you are done with @@ -7233,25 +5181,18 @@ already been loaded, g_type_default_interface_peek(). - any interface vtable for the + any interface vtable for the interface, or the default vtable for the interface - - location to store number of properties returned. + + location to store number of properties returned. - + @@ -7262,7 +5203,7 @@ already been loaded, g_type_default_interface_peek(). - + @@ -7279,7 +5220,7 @@ already been loaded, g_type_default_interface_peek(). - + @@ -7290,7 +5231,7 @@ already been loaded, g_type_default_interface_peek(). - + @@ -7301,7 +5242,7 @@ already been loaded, g_type_default_interface_peek(). - + @@ -7321,9 +5262,7 @@ already been loaded, g_type_default_interface_peek(). - Emits a "notify" signal for the property @property_name on @object. + Emits a "notify" signal for the property @property_name on @object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() @@ -7333,15 +5272,13 @@ Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called. - + - a #GObject + a #GObject @@ -7350,7 +5287,7 @@ called. - + @@ -7369,13 +5306,8 @@ called. - - Increases the reference count of the object by one and sets a + + Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established. @@ -7403,42 +5335,29 @@ however if there are multiple toggle references to an object, none of them will ever be notified until all but one are removed. For this reason, you should only ever use a toggle reference if there is important state in the proxy object. - + - a #GObject + a #GObject - a function to call when this reference is the + a function to call when this reference is the last reference to the object, or is no longer the last reference. - - data to pass to @notify + + data to pass to @notify - - Adds a weak reference from weak_pointer to @object to indicate that + + Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL. @@ -7447,39 +5366,30 @@ Note that as with g_object_weak_ref(), the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use #GWeakRef if thread-safety is required. - + - The object that should be weak referenced. + The object that should be weak referenced. - - The memory address + + The memory address of a pointer. - - Creates a binding between @source_property on @source and @target_property -on @target. Whenever the @source_property is changed the @target_property is + + Creates a binding between @source_property on @source and @target_property +on @target. + +Whenever the @source_property is changed the @target_property is updated using the same value. For instance: -|[ +|[<!-- language="C" --> g_object_bind_property (action, "active", widget, "sensitive", 0); ]| @@ -7496,56 +5406,46 @@ The binding will automatically be removed when either the @source or the @source and the @target you can just call g_object_unref() on the returned #GBinding instance. +Removing the binding by calling g_object_unref() on it must only be done if +the binding, @source and @target are only used from a single thread and it +is clear that both @source and @target outlive the binding. Especially it +is not safe to rely on this if the binding, @source or @target can be +finalized from different threads. Keep another reference to the binding and +use g_binding_unbind() instead to be on the safe side. + A #GObject can have multiple bindings. - + - the #GBinding instance representing the + the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. - the source #GObject + the source #GObject - the property on @source to bind + the property on @source to bind - the target #GObject + the target #GObject - the property on @target to bind + the property on @target to bind - flags to pass to #GBinding + flags to pass to #GBinding - - Complete version of g_object_bind_property(). + + Complete version of g_object_bind_property(). Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by @@ -7570,168 +5470,106 @@ and @transform_from transformation functions; the @notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead. - + - the #GBinding instance representing the + the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. - the source #GObject + the source #GObject - the property on @source to bind + the property on @source to bind - the target #GObject + the target #GObject - the property on @target to bind + the property on @target to bind - flags to pass to #GBinding + flags to pass to #GBinding - - the transformation function + + the transformation function from the @source to the @target, or %NULL to use the default - - the transformation function + + the transformation function from the @target to the @source, or %NULL to use the default - - custom data to be passed to the transformation functions, + + custom data to be passed to the transformation functions, or %NULL - - a function to call when disposing the binding, to free + + a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required - - Creates a binding between @source_property on @source and @target_property + + Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding. This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers. - + - the #GBinding instance representing the + the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. - the source #GObject + the source #GObject - the property on @source to bind + the property on @source to bind - the target #GObject + the target #GObject - the property on @target to bind + the property on @target to bind - flags to pass to #GBinding + flags to pass to #GBinding - a #GClosure wrapping the transformation function + a #GClosure wrapping the transformation function from the @source to the @target, or %NULL to use the default - a #GClosure wrapping the transformation function + a #GClosure wrapping the transformation function from the @target to the @source, or %NULL to use the default - - A convenience function to connect multiple signals at once. + + A convenience function to connect multiple signals at once. The signal specs expected by this function have the form "modifier::signal_name", where modifier can be one of the following: @@ -7754,81 +5592,58 @@ The signal specs expected by this function have the form "signal::destroy", gtk_widget_destroyed, &menu->toplevel, NULL); ]| - + - @object + @object - a #GObject + a #GObject - the spec for the first signal + the spec for the first signal - #GCallback for the first signal, followed by data for the + #GCallback for the first signal, followed by data for the first signal, followed optionally by more signal spec/callback/data triples, followed by %NULL - - A convenience function to disconnect multiple signals at once. + + A convenience function to disconnect multiple signals at once. The signal specs expected by this function have the form "any_signal", which means to disconnect any signal with matching callback and data, or "any_signal::signal_name", which only disconnects the signal named "signal_name". - + - a #GObject + a #GObject - the spec for the first signal + the spec for the first signal - #GCallback for the first signal, followed by data for the first signal, + #GCallback for the first signal, followed by data for the first signal, followed optionally by more signal spec/callback/data triples, followed by %NULL - - This is a variant of g_object_get_data() which returns + + This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -7842,11 +5657,9 @@ is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. - + - the result of calling @dup_func on the value + the result of calling @dup_func on the value associated with @key on @object, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. @@ -7854,45 +5667,25 @@ object. - the #GObject to store user data on + the #GObject to store user data on - a string, naming the user data pointer + a string, naming the user data pointer - - function to dup the value + + function to dup the value - - passed as user_data to @dup_func + + passed as user_data to @dup_func - - This is a variant of g_object_get_qdata() which returns + + This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -7906,11 +5699,9 @@ is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. - + - the result of calling @dup_func on the value + the result of calling @dup_func on the value associated with @quark on @object, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. @@ -7918,64 +5709,41 @@ object. - the #GObject to store user data on + the #GObject to store user data on - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - - function to dup the value + + function to dup the value - - passed as user_data to @dup_func + + passed as user_data to @dup_func - - This function is intended for #GObject implementations to re-enforce + + This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink(). - + - a #GObject + a #GObject - Increases the freeze count on @object. If the freeze count is + Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one @@ -7984,23 +5752,19 @@ object is frozen. This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified. - + - a #GObject + a #GObject - Gets properties of an object. + Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for @@ -8026,63 +5790,47 @@ of three properties: an integer, a string and an object: g_free (strval); g_object_unref (objval); ]| - + - a #GObject + a #GObject - name of the first property to get + name of the first property to get - return location for the first property, followed optionally by more + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - Gets a named field from the objects table of associations (see g_object_set_data()). - + Gets a named field from the objects table of associations (see g_object_set_data()). + - the data if found, + the data if found, or %NULL if no such data exists. - #GObject containing the associations + #GObject containing the associations - name of the key for that association + name of the key for that association - Gets a property of an object. + Gets a property of an object. The @value can be: @@ -8098,164 +5846,120 @@ responsible for freeing the memory by calling g_value_unset(). Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming. - + - a #GObject + a #GObject - the name of the property to get + the name of the property to get - return location for the property value + return location for the property value - This function gets back user data pointers stored via + This function gets back user data pointers stored via g_object_set_qdata(). - + - The user data pointer set, or %NULL + The user data pointer set, or %NULL - The GObject to get a stored user data pointer from + The GObject to get a stored user data pointer from - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - - Gets properties of an object. + + Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the type, for instance by calling g_free() or g_object_unref(). See g_object_get(). - + - a #GObject + a #GObject - name of the first property to get + name of the first property to get - return location for the first property, followed optionally by more + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - Gets @n_properties properties for an @object. + Gets @n_properties properties for an @object. Obtained properties will be set to @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in. - + - a #GObject + a #GObject - the number of properties + the number of properties - the names of each property to get + the names of each property to get - the values of each property to get + the values of each property to get - - Checks whether @object has a [floating][floating-ref] reference. - + + Checks whether @object has a [floating][floating-ref] reference. + - %TRUE if @object has a floating reference + %TRUE if @object has a floating reference - a #GObject + a #GObject - Emits a "notify" signal for the property @property_name on @object. + Emits a "notify" signal for the property @property_name on @object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() @@ -8265,31 +5969,23 @@ Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called. - + - a #GObject + a #GObject - the name of a property installed on the class of @object. + the name of a property installed on the class of @object. - - Emits a "notify" signal for the property specified by @pspec on @object. + + Emits a "notify" signal for the property specified by @pspec on @object. This function omits the property name lookup, hence it is faster than g_object_notify(). @@ -8327,54 +6023,42 @@ and then notify a change on the "foo" property with: |[<!-- language="C" --> g_object_notify_by_pspec (self, properties[PROP_FOO]); ]| - + - a #GObject + a #GObject - the #GParamSpec of a property installed on the class of @object. + the #GParamSpec of a property installed on the class of @object. - Increases the reference count of @object. + Increases the reference count of @object. Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type of @object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit. - + - the same @object + the same @object - a #GObject + a #GObject - Increase the reference count of @object, and possibly remove the + Increase the reference count of @object, and possibly remove the [floating][floating-ref] reference, if @object has a floating reference. In other words, if the object is floating, then this call "assumes @@ -8385,98 +6069,65 @@ adds a new normal reference increasing the reference count by one. Since GLib 2.56, the type of @object will be propagated to the return type under the same conditions as for g_object_ref(). - + - @object + @object - a #GObject + a #GObject - - Removes a reference added with g_object_add_toggle_ref(). The + + Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one. - + - a #GObject + a #GObject - a function to call when this reference is the + a function to call when this reference is the last reference to the object, or is no longer the last reference. - - data to pass to @notify + + data to pass to @notify, or %NULL to + match any toggle refs with the @notify argument. - - Removes a weak reference from @object that was previously added + + Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer(). - + - The object that is weak referenced. + The object that is weak referenced. - - The memory address + + The memory address of a pointer. - - Compares the user data for the key @key on @object with + + Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval. @@ -8486,82 +6137,47 @@ operation, for user data on an object. If the previous value was replaced then ownership of the old value (@oldval) is passed to the caller, including the registered destroy notify for it (passed out in @old_destroy). -It’s up to the caller to free this as needed, which may +It’s up to the caller to free this as needed, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. See g_object_set_data() for guidance on using a small, bounded set of values for @key. - + - %TRUE if the existing value for @key was replaced + %TRUE if the existing value for @key was replaced by @newval, %FALSE otherwise. - the #GObject to store user data on + the #GObject to store user data on - a string, naming the user data pointer + a string, naming the user data pointer - - the old value to compare against + + the old value to compare against - - the new value + + the new value - - a destroy notify for the new value + + a destroy notify for the new value - - destroy notify for the existing value + + destroy notify for the existing value - - Compares the user data for the key @quark on @object with + + Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval. @@ -8571,96 +6187,60 @@ operation, for user data on an object. If the previous value was replaced then ownership of the old value (@oldval) is passed to the caller, including the registered destroy notify for it (passed out in @old_destroy). -It’s up to the caller to free this as needed, which may +It’s up to the caller to free this as needed, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. - + - %TRUE if the existing value for @quark was replaced + %TRUE if the existing value for @quark was replaced by @newval, %FALSE otherwise. - the #GObject to store user data on + the #GObject to store user data on - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - - the old value to compare against + + the old value to compare against - - the new value + + the new value - - a destroy notify for the new value + + a destroy notify for the new value - - destroy notify for the existing value + + destroy notify for the existing value - Releases all references to other objects. This can be used to break + Releases all references to other objects. This can be used to break reference cycles. This function should only be called from object system implementations. - + - a #GObject + a #GObject - Sets properties on an object. + Sets properties on an object. The same caveats about passing integer literals as varargs apply as with g_object_new(). In particular, any integer literals set as the values for @@ -8670,36 +6250,28 @@ properties of type #gint64 or #guint64 must be 64 bits wide, using the Note that the "notify" signals are queued and only emitted (in reverse order) after all properties have been set. See g_object_freeze_notify(). - + - a #GObject + a #GObject - name of the first property to set + name of the first property to set - value for the first property, followed optionally by more + value for the first property, followed optionally by more name/value pairs, followed by %NULL - Each object carries around a table of associations from + Each object carries around a table of associations from strings to pointers. This function lets you set an association. If the object already had an association with that name, @@ -8707,119 +6279,79 @@ the old association will be destroyed. Internally, the @key is converted to a #GQuark using g_quark_from_string(). This means a copy of @key is kept permanently (even after @object has been -finalized) — so it is recommended to only use a small, bounded set of values +finalized) — so it is recommended to only use a small, bounded set of values for @key in your program, to avoid the #GQuark storage growing unbounded. - + - #GObject containing the associations. + #GObject containing the associations. - name of the key + name of the key - - data to associate with that key + + data to associate with that key - - Like g_object_set_data() except it adds notification + + Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed. Note that the @destroy callback is not called if @data is %NULL. - + - #GObject containing the associations + #GObject containing the associations - name of the key + name of the key - - data to associate with that key + + data to associate with that key - - function to call when the association is destroyed + + function to call when the association is destroyed - Sets a property on an object. - + Sets a property on an object. + - a #GObject + a #GObject - the name of the property to set + the name of the property to set - the value + the value - - This sets an opaque, named pointer on an object. + + This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() @@ -8827,154 +6359,103 @@ until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored. - + - The GObject to set store a user data pointer + The GObject to set store a user data pointer - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - - An opaque user data pointer + + An opaque user data pointer - - This function works like g_object_set_qdata(), but in addition, + + This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark. - + - The GObject to set store a user data pointer + The GObject to set store a user data pointer - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - - An opaque user data pointer + + An opaque user data pointer - - Function to invoke with @data as argument, when @data + + Function to invoke with @data as argument, when @data needs to be freed - - Sets properties on an object. - + + Sets properties on an object. + - a #GObject + a #GObject - name of the first property to set + name of the first property to set - value for the first property, followed optionally by more + value for the first property, followed optionally by more name/value pairs, followed by %NULL - - Sets @n_properties properties for an @object. + + Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in. - + - a #GObject + a #GObject - the number of properties + the number of properties - the names of each property to be set + the names of each property to be set - the values of each property to be set + the values of each property to be set @@ -8982,37 +6463,27 @@ properties are passed in. - Remove a specified datum from the object's data associations, + Remove a specified datum from the object's data associations, without invoking the association's destroy handler. - + - the data if found, or %NULL + the data if found, or %NULL if no such data exists. - #GObject containing the associations + #GObject containing the associations - name of the key + name of the key - This function gets back user data pointers stored via + This function gets back user data pointers stored via g_object_set_qdata() and removes the @data from object without invoking its destroy() function (if any was set). @@ -9047,32 +6518,72 @@ Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full(). - + - The user data pointer set, or %NULL + The user data pointer set, or %NULL - The GObject to get a stored user data pointer from + The GObject to get a stored user data pointer from - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer + + If @object is floating, sink it. Otherwise, do nothing. + +In other words, this function will convert a floating reference (if +present) into a full reference. + +Typically you want to use g_object_ref_sink() in order to +automatically do the correct thing with respect to floating or +non-floating references, but there is one specific scenario where +this function is helpful. + +The situation where this function is helpful is when creating an API +that allows the user to provide a callback function that returns a +GObject. We certainly want to allow the user the flexibility to +return a non-floating reference from this callback (for the case +where the object that is being returned already exists). + +At the same time, the API style of some popular GObject-based +libraries (such as Gtk) make it likely that for newly-created GObject +instances, the user can be saved some typing if they are allowed to +return a floating reference. + +Using this function on the return value of the user's callback allows +the user to do whichever is more convenient for them. The caller will +alway receives exactly one full reference to the value: either the +one that was returned in the first place, or a floating reference +that has been converted to a full reference. + +This function has an odd interaction when combined with +g_object_ref_sink() running at the same time in another thread on +the same #GObject instance. If g_object_ref_sink() runs first then +the result will be that the floating reference is converted to a hard +reference. If g_object_take_ref() runs first then the result will be +that the floating reference is converted to a hard reference and an +additional reference on top of that one is added. It is best to avoid +this situation. + + + @object + + + + + a #GObject + + + + - Reverts the effect of a previous call to + Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted. @@ -9081,46 +6592,38 @@ Duplicate notifications for each property are squashed so that at most one in which they have been queued. It is an error to call this function when the freeze count is zero. - - - - - - - a #GObject - - - - - - Decreases the reference count of @object. When its reference count -drops to 0, the object is finalized (i.e. its memory is freed). - -If the pointer to the #GObject may be reused in future (for example, if it is -an instance variable of another object), it is recommended to clear the -pointer to %NULL rather than retain a dangling pointer to a potentially -invalid #GObject instance. Use g_clear_object() for this. - a #GObject + a #GObject + + + + + + Decreases the reference count of @object. When its reference count +drops to 0, the object is finalized (i.e. its memory is freed). + +If the pointer to the #GObject may be reused in future (for example, if it is +an instance variable of another object), it is recommended to clear the +pointer to %NULL rather than retain a dangling pointer to a potentially +invalid #GObject instance. Use g_clear_object() for this. + + + + + + + a #GObject - This function essentially limits the life time of the @closure to + This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized @@ -9129,32 +6632,24 @@ added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the @closure. Usually, this function will be called on closures that use this @object as closure data. - + - #GObject restricting lifetime of @closure + #GObject restricting lifetime of @closure - #GClosure to watch + #GClosure to watch - - Adds a weak reference callback to an object. Weak references are -used for notification when an object is finalized. They are called + + Adds a weak reference callback to an object. Weak references are +used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive). @@ -9163,64 +6658,42 @@ Note that the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use #GWeakRef if thread-safety is required. - + - #GObject to reference weakly + #GObject to reference weakly - callback to invoke before the object is freed + callback to invoke before the object is freed - - extra data to pass to notify + + extra data to pass to notify - - Removes a weak reference callback to an object. - + + Removes a weak reference callback to an object. + - #GObject to remove a weak reference from + #GObject to remove a weak reference from - callback to search for + callback to search for - - data to search for + + data to search for @@ -9229,23 +6702,16 @@ Use #GWeakRef if thread-safety is required. - + - - The notify signal is emitted on an object when one of its properties has + + The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al. -Note that getting this signal doesn’t itself guarantee that the value of +Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results @@ -9257,11 +6723,13 @@ and common practice is to do that only when the value has actually changed. This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this: + |[<!-- language="C" --> g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]| + It is important to note that you must use [canonical parameter names][canonical-parameter-names] as detail strings for the notify signal. @@ -9270,20 +6738,14 @@ detail strings for the notify signal. - the #GParamSpec of the property which changed. + the #GParamSpec of the property which changed. - - The class structure for the GObject type. + + The class structure for the GObject type. |[<!-- language="C" --> // Example of implementing a singleton using a constructor. @@ -9309,11 +6771,9 @@ my_singleton_constructor (GType type, return object; } ]| - + - the parent class + the parent class @@ -9323,7 +6783,7 @@ my_singleton_constructor (GType type, - + @@ -9335,15 +6795,14 @@ my_singleton_constructor (GType type, - + - + @@ -9365,7 +6824,7 @@ my_singleton_constructor (GType type, - + @@ -9387,7 +6846,7 @@ my_singleton_constructor (GType type, - + @@ -9400,7 +6859,7 @@ my_singleton_constructor (GType type, - + @@ -9413,7 +6872,7 @@ my_singleton_constructor (GType type, - + @@ -9432,15 +6891,13 @@ my_singleton_constructor (GType type, - + - a #GObject + a #GObject @@ -9451,7 +6908,7 @@ my_singleton_constructor (GType type, - + @@ -9471,38 +6928,26 @@ my_singleton_constructor (GType type, - Looks up the #GParamSpec for a property of a class. - + Looks up the #GParamSpec for a property of a class. + - the #GParamSpec for the property, or + the #GParamSpec for the property, or %NULL if the class doesn't have a property of that name - a #GObjectClass + a #GObjectClass - the name of the property to look up + the name of the property to look up - - Installs new properties from an array of #GParamSpecs. + + Installs new properties from an array of #GParamSpecs. All properties should be installed during the class initializer. It is possible to install properties after that, but doing so is not @@ -9563,27 +7008,21 @@ my_object_set_foo (MyObject *self, gint foo) } } ]| - + - a #GObjectClass + a #GObjectClass - the length of the #GParamSpecs array + the length of the #GParamSpecs array - the #GParamSpecs array + the #GParamSpecs array defining the new properties @@ -9591,11 +7030,8 @@ my_object_set_foo (MyObject *self, gint foo) - - Installs a new property. + + Installs a new property. All properties should be installed during the class initializer. It is possible to install properties after that, but doing so is not @@ -9605,41 +7041,30 @@ use of properties on the same type on other threads. Note that it is possible to redefine a property in a derived class, by installing a property with the same name. This can be useful at times, e.g. to change the range of allowed values or the default value. - + - a #GObjectClass + a #GObjectClass - the id for the new property + the id for the new property - the #GParamSpec for the new property + the #GParamSpec for the new property - - Get an array of #GParamSpec* for all properties of a class. - + + Get an array of #GParamSpec* for all properties of a class. + - an array of + an array of #GParamSpec* which should be freed after use @@ -9647,28 +7072,17 @@ e.g. to change the range of allowed values or the default value. - a #GObjectClass + a #GObjectClass - - return location for the length of the returned array + + return location for the length of the returned array - - Registers @property_id as referring to a property with the name + + Registers @property_id as referring to a property with the name @name in a parent class or in an interface implemented by @oclass. This allows this class to "override" a property implementation in a parent class or to provide the implementation of a property from @@ -9684,27 +7098,21 @@ instead, so that the @param_id field of the #GParamSpec will be correct. For virtually all uses, this makes no difference. If you need to get the overridden property, you can call g_param_spec_get_redirect_target(). - + - a #GObjectClass + a #GObjectClass - the new property ID + the new property ID - the name of a property registered in a parent class or + the name of a property registered in a parent class or in an interface of this class. @@ -9712,720 +7120,451 @@ g_param_spec_get_redirect_target(). - The GObjectConstructParam struct is an auxiliary -structure used to hand #GParamSpec/#GValue pairs to the @constructor of -a #GObjectClass. - + The GObjectConstructParam struct is an auxiliary structure used to hand +#GParamSpec/#GValue pairs to the @constructor of a #GObjectClass. + - the #GParamSpec of the construct parameter + the #GParamSpec of the construct parameter - the value to set the parameter to + the value to set the parameter to - The type of the @finalize function of #GObjectClass. - + The type of the @finalize function of #GObjectClass. + - the #GObject being finalized + the #GObject being finalized - The type of the @get_property function of #GObjectClass. - + The type of the @get_property function of #GObjectClass. + - a #GObject + a #GObject - the numeric id under which the property was registered with + the numeric id under which the property was registered with g_object_class_install_property(). - a #GValue to return the property value in + a #GValue to return the property value in - the #GParamSpec describing the property + the #GParamSpec describing the property - The type of the @set_property function of #GObjectClass. - + The type of the @set_property function of #GObjectClass. + - a #GObject + a #GObject - the numeric id under which the property was registered with + the numeric id under which the property was registered with g_object_class_install_property(). - the new value for the property + the new value for the property - the #GParamSpec describing the property + the #GParamSpec describing the property - Mask containing the bits of #GParamSpec.flags which are reserved for GLib. - + Mask containing the bits of #GParamSpec.flags which are reserved for GLib. + - - Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into + + Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into a #GParamSpec object. - a valid #GParamSpec + a valid #GParamSpec - - Cast a #GParamSpec instance into a #GParamSpecBoolean. + + Cast a #GParamSpec instance into a #GParamSpecBoolean. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecBoxed. + + Cast a #GParamSpec instance into a #GParamSpecBoxed. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecChar. + + Cast a #GParamSpec instance into a #GParamSpecChar. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure. + + Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure. - a valid #GParamSpecClass + a valid #GParamSpecClass - - Cast a #GParamSpec instance into a #GParamSpecDouble. + + Cast a #GParamSpec instance into a #GParamSpecDouble. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecEnum. + + Cast a #GParamSpec instance into a #GParamSpecEnum. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecFlags. + + Cast a #GParamSpec instance into a #GParamSpecFlags. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecFloat. + + Cast a #GParamSpec instance into a #GParamSpecFloat. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Retrieves the #GParamSpecClass of a #GParamSpec. + + Retrieves the #GParamSpecClass of a #GParamSpec. - a valid #GParamSpec + a valid #GParamSpec - - Casts a #GParamSpec into a #GParamSpecGType. + + Casts a #GParamSpec into a #GParamSpecGType. - a #GParamSpec + a #GParamSpec - - Cast a #GParamSpec instance into a #GParamSpecInt. + + Cast a #GParamSpec instance into a #GParamSpecInt. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecInt64. + + Cast a #GParamSpec instance into a #GParamSpecInt64. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecLong. + + Cast a #GParamSpec instance into a #GParamSpecLong. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Casts a #GParamSpec instance into a #GParamSpecObject. + + Casts a #GParamSpec instance into a #GParamSpecObject. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Casts a #GParamSpec into a #GParamSpecOverride. + + Casts a #GParamSpec into a #GParamSpecOverride. - a #GParamSpec + a #GParamSpec - - Casts a #GParamSpec instance into a #GParamSpecParam. + + Casts a #GParamSpec instance into a #GParamSpecParam. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Casts a #GParamSpec instance into a #GParamSpecPointer. + + Casts a #GParamSpec instance into a #GParamSpecPointer. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Casts a #GParamSpec instance into a #GParamSpecString. + + Casts a #GParamSpec instance into a #GParamSpecString. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Retrieves the #GType of this @pspec. + + Retrieves the #GType of this @pspec. - a valid #GParamSpec + a valid #GParamSpec - - Retrieves the #GType name of this @pspec. + + Retrieves the #GType name of this @pspec. - a valid #GParamSpec + a valid #GParamSpec - - Cast a #GParamSpec instance into a #GParamSpecUChar. + + Cast a #GParamSpec instance into a #GParamSpecUChar. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecUInt. + + Cast a #GParamSpec instance into a #GParamSpecUInt. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecUInt64. + + Cast a #GParamSpec instance into a #GParamSpecUInt64. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecULong. + + Cast a #GParamSpec instance into a #GParamSpecULong. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecUnichar. + + Cast a #GParamSpec instance into a #GParamSpecUnichar. - a valid #GParamSpec instance + a valid #GParamSpec instance - - Cast a #GParamSpec instance into a #GParamSpecValueArray. + + Cast a #GParamSpec instance into a #GParamSpecValueArray. Use #GArray instead of #GValueArray - a valid #GParamSpec instance + a valid #GParamSpec instance - - Retrieves the #GType to initialize a #GValue for this parameter. + + Retrieves the #GType to initialize a #GValue for this parameter. - a valid #GParamSpec + a valid #GParamSpec - - Casts a #GParamSpec into a #GParamSpecVariant. + + Casts a #GParamSpec into a #GParamSpecVariant. - a #GParamSpec + a #GParamSpec - - #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB. + + #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB. Since 2.13.0 - + - Minimum shift count to be used for user defined flags, to be stored in + Minimum shift count to be used for user defined flags, to be stored in #GParamSpec.flags. The maximum allowed is 10. - + - - Evaluates to the @field_name inside the @inst private data + + Evaluates to the @field_name inside the @inst private data structure for @TypeName. -Note that this macro can only be used together with the G_DEFINE_TYPE_* +Note that this macro can only be used together with the `G_DEFINE_TYPE_*` and G_ADD_PRIVATE() macros, since it depends on variable names from those macros. - + - the name of the type in CamelCase + the name of the type in CamelCase - the instance of @TypeName you wish to access + the instance of @TypeName you wish to access - the type of the field in the private data structure + the type of the field in the private data structure - the name of the field in the private data structure + the name of the field in the private data structure - - Evaluates to a pointer to the @field_name inside the @inst private data + + Evaluates to a pointer to the @field_name inside the @inst private data structure for @TypeName. -Note that this macro can only be used together with the G_DEFINE_TYPE_* +Note that this macro can only be used together with the `G_DEFINE_TYPE_*` and G_ADD_PRIVATE() macros, since it depends on variable names from those macros. - + - the name of the type in CamelCase + the name of the type in CamelCase - the instance of @TypeName you wish to access + the instance of @TypeName you wish to access - the name of the field in the private data structure + the name of the field in the private data structure - - Evaluates to the offset of the @field inside the instance private data + + Evaluates to the offset of the @field inside the instance private data structure for @TypeName. -Note that this macro can only be used together with the G_DEFINE_TYPE_* +Note that this macro can only be used together with the `G_DEFINE_TYPE_*` and G_ADD_PRIVATE() macros, since it depends on variable names from those macros. - + - the name of the type in CamelCase + the name of the type in CamelCase - the name of the field in the private data structure + the name of the field in the private data structure - Through the #GParamFlags flag values, certain aspects of parameters -can be configured. See also #G_PARAM_STATIC_STRINGS. - + Through the #GParamFlags flag values, certain aspects of parameters +can be configured. + +See also: %G_PARAM_STATIC_STRINGS + - the parameter is readable + the parameter is readable - the parameter is writable + the parameter is writable - alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE + alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE - the parameter will be set upon object construction + the parameter will be set upon object construction - - the parameter can only be set upon object construction + + the parameter can only be set upon object construction - - upon parameter conversion (see g_param_value_convert()) + + upon parameter conversion (see g_param_value_convert()) strict validation is not required - the string used as name when constructing the + the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8 @@ -10434,59 +7573,32 @@ can be configured. See also #G_PARAM_STATIC_STRINGS. internal - the string used as nick when constructing the + the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter. Since 2.8 - - the string used as blurb when constructing the + + the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8 - - calls to g_object_set_property() for this + + calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves in case the property actually changes. Since: 2.42. - - the parameter is deprecated and will be removed + + the parameter is deprecated and will be removed in a future version. A warning will be generated if it is used while running with G_ENABLE_DIAGNOSTIC=1. Since 2.26 - - #GParamSpec is an object structure that encapsulates the metadata + + #GParamSpec is an object structure that encapsulates the metadata required to specify parameters, such as e.g. #GObject properties. ## Parameter names # {#canonical-parameter-names} @@ -10498,14 +7610,10 @@ for signal naming (see g_signal_new()). When creating and looking up a #GParamSpec, either separator can be used, but they cannot be mixed. Using `-` is considerably more -efficient, and is the ‘canonical form’. Using `_` is discouraged. - - - Creates a new #GParamSpec instance. +efficient, and is the ‘canonical form’. Using `_` is discouraged. + + + Creates a new #GParamSpec instance. See [canonical parameter names][canonical-parameter-names] for details of the rules for @name. Names which violate these rules lead to undefined @@ -10516,75 +7624,56 @@ strings associated with them, the @nick, which should be suitable for use as a label for the property in a property editor, and the @blurb, which should be a somewhat longer description, suitable for e.g. a tooltip. The @nick and @blurb should ideally be localized. - + - a newly allocated #GParamSpec instance + (transfer floating): a newly allocated + #GParamSpec instance, which is initially floating - the #GType for the property; must be derived from #G_TYPE_PARAM + the #GType for the property; must be derived from #G_TYPE_PARAM - the canonical name of the property + the canonical name of the property - the nickname of the property + the nickname of the property - a short description of the property + a short description of the property - a combination of #GParamFlags + a combination of #GParamFlags - - Validate a property name for a #GParamSpec. This can be useful for + + Validate a property name for a #GParamSpec. This can be useful for dynamically-generated properties which need to be validated at run-time before actually trying to create them. See [canonical parameter names][canonical-parameter-names] for details of the rules for valid names. - + - %TRUE if @name is a valid property name, %FALSE otherwise. + %TRUE if @name is a valid property name, %FALSE otherwise. - the canonical name of the property + the canonical name of the property - + @@ -10595,7 +7684,7 @@ the rules for valid names. - + @@ -10609,7 +7698,7 @@ the rules for valid names. - + @@ -10623,7 +7712,7 @@ the rules for valid names. - + @@ -10640,393 +7729,274 @@ the rules for valid names. - Get the short description of a #GParamSpec. - - - the short description of @pspec. + Get the short description of a #GParamSpec. + + + the short description of @pspec. - a valid #GParamSpec + a valid #GParamSpec - - Gets the default value of @pspec as a pointer to a #GValue. + + Gets the default value of @pspec as a pointer to a #GValue. The #GValue will remain valid for the life of @pspec. - + - a pointer to a #GValue which must not be modified + a pointer to a #GValue which must not be modified - a #GParamSpec + a #GParamSpec - Get the name of a #GParamSpec. + Get the name of a #GParamSpec. The name is always an "interned" string (as per g_intern_string()). This allows for pointer-value comparisons. - + - the name of @pspec. + the name of @pspec. - a valid #GParamSpec + a valid #GParamSpec - - Gets the GQuark for the name. - + + Gets the GQuark for the name. + - the GQuark for @pspec->name. + the GQuark for @pspec->name. - a #GParamSpec + a #GParamSpec - Get the nickname of a #GParamSpec. - + Get the nickname of a #GParamSpec. + - the nickname of @pspec. + the nickname of @pspec. - a valid #GParamSpec + a valid #GParamSpec - Gets back user data pointers stored via g_param_spec_set_qdata(). - + Gets back user data pointers stored via g_param_spec_set_qdata(). + - the user data pointer set, or %NULL + the user data pointer set, or %NULL - a valid #GParamSpec + a valid #GParamSpec - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - - If the paramspec redirects operations to another paramspec, + + If the paramspec redirects operations to another paramspec, returns that paramspec. Redirect is used typically for providing a new implementation of a property in a derived type while preserving all the properties from the parent type. Redirection is established by creating a property of type #GParamSpecOverride. See g_object_class_override_property() for an example of the use of this capability. - - - paramspec to which requests on this + + + paramspec to which requests on this paramspec should be redirected, or %NULL if none. - a #GParamSpec + a #GParamSpec - Increments the reference count of @pspec. - - - the #GParamSpec that was passed into this function + Increments the reference count of @pspec. + + + the #GParamSpec that was passed into this function - a valid #GParamSpec + a valid #GParamSpec - - Convenience function to ref and sink a #GParamSpec. - - - the #GParamSpec that was passed into this function + + Convenience function to ref and sink a #GParamSpec. + + + the #GParamSpec that was passed into this function - a valid #GParamSpec + a valid #GParamSpec - Sets an opaque, named pointer on a #GParamSpec. The name is + Sets an opaque, named pointer on a #GParamSpec. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @pspec with g_param_spec_get_qdata(). Setting a previously set user data pointer, overrides (frees) the old pointer set, using %NULL as pointer essentially removes the data stored. - + - the #GParamSpec to set store a user data pointer + the #GParamSpec to set store a user data pointer - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - - an opaque user data pointer + + an opaque user data pointer - - This function works like g_param_spec_set_qdata(), but in addition, + + This function works like g_param_spec_set_qdata(), but in addition, a `void (*destroy) (gpointer)` function may be specified which is called with @data as argument when the @pspec is finalized, or the data is being overwritten by a call to g_param_spec_set_qdata() with the same @quark. - + - the #GParamSpec to set store a user data pointer + the #GParamSpec to set store a user data pointer - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - - an opaque user data pointer + + an opaque user data pointer - - function to invoke with @data as argument, when @data needs to + + function to invoke with @data as argument, when @data needs to be freed - The initial reference count of a newly created #GParamSpec is 1, + The initial reference count of a newly created #GParamSpec is 1, even though no one has explicitly called g_param_spec_ref() on it yet. So the initial reference count is flagged as "floating", until someone calls `g_param_spec_ref (pspec); g_param_spec_sink (pspec);` in sequence on it, taking over the initial reference count (thus ending up with a @pspec that has a reference count of 1 still, but is not flagged "floating" anymore). + + + + + + + a valid #GParamSpec + + + + + + Gets back user data pointers stored via g_param_spec_set_qdata() +and removes the @data from @pspec without invoking its destroy() +function (if any was set). Usually, calling this function is only +required to update user data pointers with a destroy notifier. + + + the user data pointer set, or %NULL + + + + + the #GParamSpec to get a stored user data pointer from + + + + a #GQuark, naming the user data pointer + + + + + + Decrements the reference count of a @pspec. - a valid #GParamSpec - - - - - - Gets back user data pointers stored via g_param_spec_set_qdata() -and removes the @data from @pspec without invoking its destroy() -function (if any was set). Usually, calling this function is only -required to update user data pointers with a destroy notifier. - - - the user data pointer set, or %NULL - - - - - the #GParamSpec to get a stored user data pointer from - - - - a #GQuark, naming the user data pointer - - - - - - Decrements the reference count of a @pspec. - - - - - - - a valid #GParamSpec + a valid #GParamSpec - private #GTypeInstance portion + private #GTypeInstance portion - name of this parameter: always an interned string + name of this parameter: always an interned string - #GParamFlags flags for this parameter + #GParamFlags flags for this parameter - the #GValue type for this parameter + the #GValue type for this parameter - #GType type that uses (introduces) this parameter + #GType type that uses (introduces) this parameter @@ -11045,105 +8015,59 @@ required to update user data pointers with a destroy notifier. - - A #GParamSpec derived structure that contains the meta data for boolean properties. + + A #GParamSpec derived structure that contains the meta data for boolean properties. - private #GParamSpec portion + private #GParamSpec portion - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for boxed properties. + + A #GParamSpec derived structure that contains the meta data for boxed properties. - private #GParamSpec portion + private #GParamSpec portion - - A #GParamSpec derived structure that contains the meta data for character properties. + + A #GParamSpec derived structure that contains the meta data for character properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - The class structure for the GParamSpec type. + + The class structure for the GParamSpec type. Normally, GParamSpec classes are filled by g_param_type_register_static(). - + - the parent class + the parent class - the #GValue type for this parameter + the #GValue type for this parameter - + @@ -11156,7 +8080,7 @@ g_param_type_register_static(). - + @@ -11172,7 +8096,7 @@ g_param_type_register_static(). - + @@ -11188,7 +8112,7 @@ g_param_type_register_static(). - + @@ -11211,311 +8135,170 @@ g_param_type_register_static(). - - A #GParamSpec derived structure that contains the meta data for double properties. + + A #GParamSpec derived structure that contains the meta data for double properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - values closer than @epsilon will be considered identical + values closer than @epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-90. - - A #GParamSpec derived structure that contains the meta data for enum + + A #GParamSpec derived structure that contains the meta data for enum properties. - private #GParamSpec portion + private #GParamSpec portion - the #GEnumClass for the enum + the #GEnumClass for the enum - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for flags + + A #GParamSpec derived structure that contains the meta data for flags properties. - private #GParamSpec portion + private #GParamSpec portion - the #GFlagsClass for the flags + the #GFlagsClass for the flags - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for float properties. + + A #GParamSpec derived structure that contains the meta data for float properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - values closer than @epsilon will be considered identical + values closer than @epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-30. - - A #GParamSpec derived structure that contains the meta data for #GType properties. + + A #GParamSpec derived structure that contains the meta data for #GType properties. - private #GParamSpec portion + private #GParamSpec portion - a #GType whose subtypes can occur as values + a #GType whose subtypes can occur as values - - A #GParamSpec derived structure that contains the meta data for integer properties. + + A #GParamSpec derived structure that contains the meta data for integer properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for 64bit integer properties. + + A #GParamSpec derived structure that contains the meta data for 64bit integer properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for long integer properties. + + A #GParamSpec derived structure that contains the meta data for long integer properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for object properties. + + A #GParamSpec derived structure that contains the meta data for object properties. - private #GParamSpec portion + private #GParamSpec portion - - This is a type of #GParamSpec type that simply redirects operations to -another paramspec. All operations other than getting or -setting the value are redirected, including accessing the nick and -blurb, validating a value, and so forth. See -g_param_spec_get_redirect_target() for retrieving the overridden + + A #GParamSpec derived structure that redirects operations to +other types of #GParamSpec. + +All operations other than getting or setting the value are redirected, +including accessing the nick and blurb, validating a value, and so +forth. + +See g_param_spec_get_redirect_target() for retrieving the overridden property. #GParamSpecOverride is used in implementing g_object_class_override_property(), and will not be directly useful unless you are implementing a new base type similar to GObject. @@ -11526,88 +8309,55 @@ unless you are implementing a new base type similar to GObject. - - A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM + + A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM properties. - private #GParamSpec portion + private #GParamSpec portion - - A #GParamSpec derived structure that contains the meta data for pointer properties. + + A #GParamSpec derived structure that contains the meta data for pointer properties. - private #GParamSpec portion + private #GParamSpec portion - A #GParamSpecPool maintains a collection of #GParamSpecs which can be -quickly accessed by owner and name. The implementation of the #GObject property -system uses such a pool to store the #GParamSpecs of the properties all object -types. - + A #GParamSpecPool maintains a collection of #GParamSpecs which can be +quickly accessed by owner and name. + +The implementation of the #GObject property system uses such a pool to +store the #GParamSpecs of the properties all object types. + - Inserts a #GParamSpec in the pool. - + Inserts a #GParamSpec in the pool. + - a #GParamSpecPool. + a #GParamSpecPool. - the #GParamSpec to insert + the #GParamSpec to insert - a #GType identifying the owner of @pspec + a #GType identifying the owner of @pspec - Gets an array of all #GParamSpecs owned by @owner_type in + Gets an array of all #GParamSpecs owned by @owner_type in the pool. - + - a newly + a newly allocated array containing pointers to all #GParamSpecs owned by @owner_type in the pool @@ -11616,38 +8366,25 @@ the pool. - a #GParamSpecPool + a #GParamSpecPool - the owner to look for + the owner to look for - - return location for the length of the returned array + + return location for the length of the returned array - Gets an #GList of all #GParamSpecs owned by @owner_type in + Gets an #GList of all #GParamSpecs owned by @owner_type in the pool. - + - a + a #GList of all #GParamSpecs owned by @owner_type in the pool#GParamSpecs. @@ -11656,188 +8393,133 @@ the pool. - a #GParamSpecPool + a #GParamSpecPool - the owner to look for + the owner to look for - Looks up a #GParamSpec in the pool. - - - The found #GParamSpec, or %NULL if no + Looks up a #GParamSpec in the pool. + + + The found #GParamSpec, or %NULL if no matching #GParamSpec was found. - a #GParamSpecPool + a #GParamSpecPool - the name to look for + the name to look for - the owner to look for + the owner to look for - If %TRUE, also try to find a #GParamSpec with @param_name + If %TRUE, also try to find a #GParamSpec with @param_name owned by an ancestor of @owner_type. - Removes a #GParamSpec from the pool. - + Removes a #GParamSpec from the pool. + - a #GParamSpecPool + a #GParamSpecPool - the #GParamSpec to remove + the #GParamSpec to remove - - Creates a new #GParamSpecPool. + + Creates a new #GParamSpecPool. If @type_prefixing is %TRUE, lookups in the newly created pool will allow to specify the owner as a colon-separated prefix of the property name, like "GtkContainer:border-width". This feature is deprecated, so you should always set @type_prefixing to %FALSE. - - - a newly allocated #GParamSpecPool. + + + a newly allocated #GParamSpecPool. - Whether the pool will support type-prefixed property names. + Whether the pool will support type-prefixed property names. - - A #GParamSpec derived structure that contains the meta data for string + + A #GParamSpec derived structure that contains the meta data for string properties. - private #GParamSpec portion + private #GParamSpec portion - default value for the property specified + default value for the property specified - a string containing the allowed values for the first byte + a string containing the allowed values for the first byte - a string containing the allowed values for the subsequent bytes + a string containing the allowed values for the subsequent bytes - the replacement byte for bytes which don't match @cset_first or @cset_nth. + the replacement byte for bytes which don't match @cset_first or @cset_nth. - replace empty string by %NULL + replace empty string by %NULL - replace %NULL strings by an empty string + replace %NULL strings by an empty string - This structure is used to provide the type system with the information + This structure is used to provide the type system with the information required to initialize and destruct (finalize) a parameter's class and instances thereof. + The initialized structure is passed to the g_param_type_register_static() The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_param_type_register_static(). - + - Size of the instance (object) structure. + Size of the instance (object) structure. - Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. + Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. - + @@ -11849,14 +8531,12 @@ g_param_type_register_static(). - The #GType of values conforming to this #GParamSpec + The #GType of values conforming to this #GParamSpec - + @@ -11869,7 +8549,7 @@ g_param_type_register_static(). - + @@ -11885,7 +8565,7 @@ g_param_type_register_static(). - + @@ -11901,7 +8581,7 @@ g_param_type_register_static(). - + @@ -11919,209 +8599,110 @@ g_param_type_register_static(). - - A #GParamSpec derived structure that contains the meta data for unsigned character properties. + + A #GParamSpec derived structure that contains the meta data for unsigned character properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for unsigned integer properties. + + A #GParamSpec derived structure that contains the meta data for unsigned integer properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties. + + A #GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for unsigned long integer properties. + + A #GParamSpec derived structure that contains the meta data for unsigned long integer properties. - private #GParamSpec portion + private #GParamSpec portion - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties. + + A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties. - private #GParamSpec portion + private #GParamSpec portion - default value for the property specified + default value for the property specified - - A #GParamSpec derived structure that contains the meta data for #GValueArray properties. + + A #GParamSpec derived structure that contains the meta data for #GValueArray properties. - private #GParamSpec portion + private #GParamSpec portion - a #GParamSpec describing the elements contained in arrays of this property, may be %NULL + a #GParamSpec describing the elements contained in arrays of this property, may be %NULL - if greater than 0, arrays of this property will always have this many elements + if greater than 0, arrays of this property will always have this many elements - - A #GParamSpec derived structure that contains the meta data for #GVariant properties. + + A #GParamSpec derived structure that contains the meta data for #GVariant properties. When comparing values with g_param_values_cmp(), scalar values with the same type will be compared with g_variant_compare(). Other non-%NULL variants will @@ -12129,21 +8710,15 @@ be checked for equality with g_variant_equal(), and their sort order is otherwise undefined. %NULL is ordered before non-%NULL variants. Two %NULL values compare equal. - private #GParamSpec portion + private #GParamSpec portion - a #GVariantType, or %NULL + a #GVariantType, or %NULL - a #GVariant, or %NULL + a #GVariant, or %NULL @@ -12152,183 +8727,128 @@ values compare equal. - - The GParameter struct is an auxiliary structure used + + The GParameter struct is an auxiliary structure used to hand parameter name/value pairs to g_object_newv(). This type is not introspectable. - + - the parameter name + the parameter name - the parameter value + the parameter value - - A mask for all #GSignalFlags bits. - + + A mask for all #GSignalFlags bits. + - A mask for all #GSignalMatchType bits. - + A mask for all #GSignalMatchType bits. + - The signal accumulator is a special callback function that can be used + The signal accumulator is a special callback function that can be used to collect return values of the various callbacks that are called -during a signal emission. The signal accumulator is specified at signal -creation time, if it is left %NULL, no accumulation of callback return -values is performed. The return value of signal emissions is then the -value returned by the last callback. - +during a signal emission. + +The signal accumulator is specified at signal creation time, if it is +left %NULL, no accumulation of callback return values is performed. +The return value of signal emissions is then the value returned by the +last callback. + - The accumulator function returns whether the signal emission - should be aborted. Returning %FALSE means to abort the - current emission and %TRUE is returned for continuation. + The accumulator function returns whether the signal emission + should be aborted. Returning %TRUE will continue with + the signal emission. Returning %FALSE will abort the current emission. + Since 2.62, returning %FALSE will skip to the CLEANUP stage. In this case, + emission will occur as normal in the CLEANUP stage and the handler's + return value will be accumulated. - Signal invocation hint, see #GSignalInvocationHint. + Signal invocation hint, see #GSignalInvocationHint. - Accumulator to collect callback return values in, this + Accumulator to collect callback return values in, this is the return value of the current signal emission. - A #GValue holding the return value of the signal handler. + A #GValue holding the return value of the signal handler. - - Callback data that was specified when creating the signal. + + Callback data that was specified when creating the signal. - A simple function pointer to get invoked when the signal is emitted. This -allows you to tie a hook to the signal type, so that it will trap all -emissions of that signal, from any object. + A simple function pointer to get invoked when the signal is emitted. + +Emission hooks allow you to tie a hook to the signal type, so that it will +trap all emissions of that signal, from any object. You may not attach these to signals created with the #G_SIGNAL_NO_HOOKS flag. - + - whether it wants to stay connected. If it returns %FALSE, the signal + whether it wants to stay connected. If it returns %FALSE, the signal hook is disconnected (and destroyed). - Signal invocation hint, see #GSignalInvocationHint. + Signal invocation hint, see #GSignalInvocationHint. - the number of parameters to the function, including + the number of parameters to the function, including the instance on which the signal was emitted. - the instance on which + the instance on which the signal was emitted, followed by the parameters of the emission. - - user data associated with the hook. + + user data associated with the hook. - The signal flags are used to specify a signal's behaviour, the overall -signal description outlines how especially the RUN flags control the -stages of a signal emission. - + The signal flags are used to specify a signal's behaviour. + - Invoke the object method handler in the first emission stage. + Invoke the object method handler in the first emission stage. - Invoke the object method handler in the third emission stage. + Invoke the object method handler in the third emission stage. - Invoke the object method handler in the last emission stage. + Invoke the object method handler in the last emission stage. - Signals being emitted for an object while currently being in + Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted. - This signal supports "::detail" appendices to the signal name + This signal supports "::detail" appendices to the signal name upon handler connections and emissions. - Action signals are signals that may freely be emitted on alive + Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object. They can also be thought @@ -12336,140 +8856,100 @@ stages of a signal emission. third-party code. - No emissions hooks are supported for this signal. + No emissions hooks are supported for this signal. - - Varargs signal emission will always collect the + + Varargs signal emission will always collect the arguments, even if there are no signal handlers connected. Since 2.30. - The signal is deprecated and will be removed + The signal is deprecated and will be removed in a future version. A warning will be generated if it is connected while running with G_ENABLE_DIAGNOSTIC=1. Since 2.32. + + Only used in #GSignalAccumulator accumulator + functions for the #GSignalInvocationHint::run_type field to mark the first + call to the accumulator function for a signal emission. Since 2.68. + - The #GSignalInvocationHint structure is used to pass on additional information + The #GSignalInvocationHint structure is used to pass on additional information to callbacks during a signal emission. - + - The signal id of the signal invoking the callback + The signal id of the signal invoking the callback - The detail passed on for this emission + The detail passed on for this emission - The stage the signal emission is currently in, this + The stage the signal emission is currently in, this field will contain one of %G_SIGNAL_RUN_FIRST, - %G_SIGNAL_RUN_LAST or %G_SIGNAL_RUN_CLEANUP. + %G_SIGNAL_RUN_LAST or %G_SIGNAL_RUN_CLEANUP and %G_SIGNAL_ACCUMULATOR_FIRST_RUN. + %G_SIGNAL_ACCUMULATOR_FIRST_RUN is only set for the first run of the accumulator + function for a signal emission. - The match types specify what g_signal_handlers_block_matched(), + The match types specify what g_signal_handlers_block_matched(), g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched() match signals by. - + - The signal id must be equal. + The signal id must be equal. - The signal detail must be equal. + The signal detail must be equal. - The closure must be the same. + The closure must be the same. - The C closure callback must be the same. + The C closure callback must be the same. - The closure data must be the same. + The closure data must be the same. - - Only unblocked signals may be matched. + + Only unblocked signals may be matched. - A structure holding in-depth information for a specific signal. It is -filled in by the g_signal_query() function. - + A structure holding in-depth information for a specific signal. + +See also: g_signal_query() + - The signal id of the signal being queried, or 0 if the + The signal id of the signal being queried, or 0 if the signal to be queried was unknown. - The signal name. + The signal name. - The interface/instance type that this signal can be emitted for. + The interface/instance type that this signal can be emitted for. - The signal flags as passed in to g_signal_new(). + The signal flags as passed in to g_signal_new(). - The return type for user callbacks. + The return type for user callbacks. - The number of parameters that user callbacks take. + The number of parameters that user callbacks take. - The individual parameter types for + The individual parameter types for user callbacks, note that the effective callback signature is: |[<!-- language="C" --> @return_type callback (#gpointer data1, @@ -12481,827 +8961,554 @@ filled in by the g_signal_query() function. - - Checks that @g_class is a class structure of the type identified by @g_type + + Checks that @g_class is a class structure of the type identified by @g_type and issues a warning if this is not the case. Returns @g_class casted to a pointer to @c_type. %NULL is not a valid class structure. This macro should only be used in type implementations. - + - Location of a #GTypeClass structure + Location of a #GTypeClass structure - The type to be returned + The type to be returned - The corresponding C type of class structure of @g_type + The corresponding C type of class structure of @g_type - - Checks if @g_class is a class structure of the type identified by + + Checks if @g_class is a class structure of the type identified by @g_type. If @g_class is %NULL, %FALSE will be returned. This macro should only be used in type implementations. - + - Location of a #GTypeClass structure + Location of a #GTypeClass structure - The type to be checked + The type to be checked - - Checks if @instance is a valid #GTypeInstance structure, + + Checks if @instance is a valid #GTypeInstance structure, otherwise issues a warning and returns %FALSE. %NULL is not a valid #GTypeInstance. This macro should only be used in type implementations. - + - Location of a #GTypeInstance structure + Location of a #GTypeInstance structure - - Checks that @instance is an instance of the type identified by @g_type + + Checks that @instance is an instance of the type identified by @g_type and issues a warning if this is not the case. Returns @instance casted to a pointer to @c_type. No warning will be issued if @instance is %NULL, and %NULL will be returned. This macro should only be used in type implementations. - + - Location of a #GTypeInstance structure + Location of a #GTypeInstance structure - The type to be returned + The type to be returned - The corresponding C type of @g_type + The corresponding C type of @g_type - - Checks if @instance is an instance of the fundamental type identified by @g_type. + + Checks if @instance is an instance of the fundamental type identified by @g_type. If @instance is %NULL, %FALSE will be returned. This macro should only be used in type implementations. - + - Location of a #GTypeInstance structure. + Location of a #GTypeInstance structure. - The fundamental type to be checked + The fundamental type to be checked - - Checks if @instance is an instance of the type identified by @g_type. If + + Checks if @instance is an instance of the type identified by @g_type. If @instance is %NULL, %FALSE will be returned. This macro should only be used in type implementations. - + - Location of a #GTypeInstance structure. + Location of a #GTypeInstance structure. - The type to be checked + The type to be checked - - Checks if @value has been initialized to hold values + + Checks if @value has been initialized to hold values of a value type. This macro should only be used in type implementations. - + - a #GValue + a #GValue - - Checks if @value has been initialized to hold values + + Checks if @value has been initialized to hold values of type @g_type. This macro should only be used in type implementations. - + - a #GValue + a #GValue - The type to be checked + The type to be checked - - Gets the private class structure for a particular type. + + Gets the private class structure for a particular type. + The private structure must have been registered in the get_type() function with g_type_add_class_private(). This macro should only be used in type implementations. - + - the class of a type deriving from @private_type + the class of a type deriving from @private_type - the type identifying which private data to retrieve + the type identifying which private data to retrieve - The C type for the private structure + The C type for the private structure - - A bit in the type number that's supposed to be left untouched. - + + A bit in the type number that's supposed to be left untouched. + - - Get the type identifier from a given @class structure. + + Get the type identifier from a given @class structure. This macro should only be used in type implementations. - + - Location of a valid #GTypeClass structure + Location of a valid #GTypeClass structure - - Get the type identifier from a given @instance structure. + + Get the type identifier from a given @instance structure. This macro should only be used in type implementations. - + - Location of a valid #GTypeInstance structure + Location of a valid #GTypeInstance structure - - Get the type identifier from a given @interface structure. + + Get the type identifier from a given @interface structure. This macro should only be used in type implementations. - + - Location of a valid #GTypeInterface structure + Location of a valid #GTypeInterface structure - - The fundamental type which is the ancestor of @type. + + The fundamental type which is the ancestor of @type. + Fundamental types are types that serve as ultimate bases for the derived types, thus they are the roots of distinct inheritance hierarchies. - + - A #GType value. + A #GType value. - - An integer constant that represents the number of identifiers reserved + + An integer constant that represents the number of identifiers reserved for types that are assigned at compile-time. - + - - Shift value used in converting numbers to type IDs. - + + Shift value used in converting numbers to type IDs. + - - Checks if @type has a #GTypeValueTable. - + + Checks if @type has a #GTypeValueTable. + - A #GType value + A #GType value - - Get the class structure of a given @instance, casted + + Get the class structure of a given @instance, casted to a specified ancestor type @g_type of the instance. Note that while calling a GInstanceInitFunc(), the class pointer gets modified, so it might not always return the expected pointer. This macro should only be used in type implementations. - + - Location of the #GTypeInstance structure + Location of the #GTypeInstance structure - The #GType of the class to be returned + The #GType of the class to be returned - The C type of the class structure + The C type of the class structure - - Get the interface structure for interface @g_type of a given @instance. + + Get the interface structure for interface @g_type of a given @instance. This macro should only be used in type implementations. - + - Location of the #GTypeInstance structure + Location of the #GTypeInstance structure - The #GType of the interface to be returned + The #GType of the interface to be returned - The C type of the interface structure + The C type of the interface structure - - Gets the private structure for a particular type. + + Gets the private structure for a particular type. + The private structure must have been registered in the class_init function with g_type_class_add_private(). This macro should only be used in type implementations. Use %G_ADD_PRIVATE and the generated `your_type_get_instance_private()` function instead - + - the instance of a type deriving from @private_type + the instance of a type deriving from @private_type - the type identifying which private data to retrieve + the type identifying which private data to retrieve - The C type for the private structure + The C type for the private structure - - Checks if @type is an abstract type. An abstract type cannot be + + Checks if @type is an abstract type. An abstract type cannot be instantiated and is normally used as an abstract base class for derived classes. - + - A #GType value + A #GType value - + - - Checks if @type is a classed type. - + + Checks if @type is a classed type. + - A #GType value + A #GType value - - Checks if @type is a deep derivable type. A deep derivable type + + Checks if @type is a deep derivable type. A deep derivable type can be used as the base class of a deep (multi-level) class hierarchy. - + - A #GType value + A #GType value - - Checks if @type is a derivable type. A derivable type can + + Checks if @type is a derivable type. A derivable type can be used as the base class of a flat (single-level) class hierarchy. - + - A #GType value + A #GType value - - Checks if @type is derived (or in object-oriented terminology: + + Checks if @type is derived (or in object-oriented terminology: inherited) from another type (this holds true for all non-fundamental types). - + - A #GType value + A #GType value - - Checks whether @type "is a" %G_TYPE_ENUM. + + Checks whether @type "is a" %G_TYPE_ENUM. - a #GType ID. + a #GType ID. - - Checks whether @type "is a" %G_TYPE_FLAGS. + + Checks if @type is a final type. A final type cannot be derived any +further. + + + + a #GType value + + + + + Checks whether @type "is a" %G_TYPE_FLAGS. - a #GType ID. + a #GType ID. - - Checks if @type is a fundamental type. - + + Checks if @type is a fundamental type. + - A #GType value + A #GType value - - Checks if @type can be instantiated. Instantiation is the + + Checks if @type can be instantiated. Instantiation is the process of creating an instance (object) of this type. - + - A #GType value + A #GType value - - Checks if @type is an interface type. + + Checks if @type is an interface type. + An interface type provides a pure API, the implementation of which is provided by another type (which is then said to conform to the interface). GLib interfaces are somewhat analogous to Java interfaces and C++ classes containing only pure virtual functions, with the difference that GType interfaces are not derivable (but see g_type_interface_add_prerequisite() for an alternative). - + - A #GType value + A #GType value - - Check if the passed in type id is a %G_TYPE_OBJECT or derived from it. + + Check if the passed in type id is a %G_TYPE_OBJECT or derived from it. - Type id to check + Type id to check - - Checks whether @type "is a" %G_TYPE_PARAM. + + Checks whether @type "is a" %G_TYPE_PARAM. - a #GType ID + a #GType ID - - Checks whether the passed in type ID can be used for g_value_init(). + + Checks whether the passed in type ID can be used for g_value_init(). + That is, this macro checks whether this type provides an implementation of the #GTypeValueTable functions required for a type to create a #GValue of. - + - A #GType value. + A #GType value. - - Checks if @type is an abstract value type. An abstract value type introduces + + Checks if @type is an abstract value type. An abstract value type introduces a value table, but can't be used for g_value_init() and is normally used as an abstract base type for derived value types. - + - A #GType value + A #GType value - - Checks if @type is a value type and can be used with g_value_init(). - + + Checks if @type is a value type and can be used with g_value_init(). + - A #GType value + A #GType value - - Get the type ID for the fundamental type number @x. + + Get the type ID for the fundamental type number @x. + Use g_type_fundamental_next() instead of this macro to create new fundamental types. - + - the fundamental type number. + the fundamental type number. - + - + - + - + - + - + - - First fundamental type number to create a new fundamental type id with + + First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE. - + - - Last fundamental type number reserved for BSE. - + + Last fundamental type number reserved for BSE. + - - First fundamental type number to create a new fundamental type id with + + First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib. - + - - Last fundamental type number reserved for GLib. - + + Last fundamental type number reserved for GLib. + - - First available fundamental type number to create new fundamental + + First available fundamental type number to create new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL(). - + - A callback function used for notification when the state -of a toggle reference changes. See g_object_add_toggle_ref(). - + A callback function used for notification when the state +of a toggle reference changes. + +See also: g_object_add_toggle_ref() + - - Callback data passed to g_object_add_toggle_ref() + + Callback data passed to g_object_add_toggle_ref() - The object on which g_object_add_toggle_ref() was called. + The object on which g_object_add_toggle_ref() was called. - %TRUE if the toggle reference is now the + %TRUE if the toggle reference is now the last reference to the object. %FALSE if the toggle reference was the last reference and there are now other references. @@ -13310,24 +9517,16 @@ of a toggle reference changes. See g_object_add_toggle_ref(). - + - An opaque structure used as the base of all classes. - + An opaque structure used as the base of all classes. + - - Registers a private structure for an instantiatable type. + + Registers a private structure for an instantiatable type. When an object is allocated, the private structures for the type and all of its parent types are allocated @@ -13391,33 +9590,24 @@ my_object_get_some_field (MyObject *my_object) ]| Use the G_ADD_PRIVATE() macro with the `G_DEFINE_*` family of macros to add instance private data to a type - + - class structure for an instantiatable + class structure for an instantiatable type - size of private structure + size of private structure - - Gets the offset of the private data for instances of @g_class. + + Gets the offset of the private data for instances of @g_class. This is how many bytes you should add to the instance pointer of a class in order to get the private data for the type represented by @@ -13425,24 +9615,20 @@ class in order to get the private data for the type represented by You can only call this function after you have registered a private data area for @g_class using g_type_class_add_private(). - + - the offset, in bytes + the offset, in bytes - a #GTypeClass + a #GTypeClass - + @@ -13456,9 +9642,7 @@ data area for @g_class using g_type_class_add_private(). - This is a convenience function often needed in class initializers. + This is a convenience function often needed in class initializers. It returns the class structure of the immediate parent type of the class passed in. Since derived classes hold a reference count on their parent classes as long as they are instantiated, the returned @@ -13466,77 +9650,59 @@ class will always exist. This function is essentially equivalent to: g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class))) - + - the parent class + the parent class of @g_class - the #GTypeClass structure to + the #GTypeClass structure to retrieve the parent class for - Decrements the reference count of the class structure being passed in. + Decrements the reference count of the class structure being passed in. Once the last reference count of a class has been released, classes may be finalized by the type system, so further dereferencing of a class pointer after g_type_class_unref() are invalid. - + - a #GTypeClass structure to unref + a #GTypeClass structure to unref - - A variant of g_type_class_unref() for use in #GTypeClassCacheFunc + + A variant of g_type_class_unref() for use in #GTypeClassCacheFunc implementations. It unreferences a class without consulting the chain of #GTypeClassCacheFuncs, avoiding the recursion which would occur otherwise. - + - a #GTypeClass structure to unref + a #GTypeClass structure to unref - - + + - + @@ -13545,229 +9711,158 @@ otherwise. - This function is essentially the same as g_type_class_ref(), + This function is essentially the same as g_type_class_ref(), except that the classes reference count isn't incremented. As a consequence, this function may return %NULL if the class of the type passed in does not currently exist (hasn't been referenced before). - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist - type ID of a classed type + type ID of a classed type - - A more efficient version of g_type_class_peek() which works only for + + A more efficient version of g_type_class_peek() which works only for static types. - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist or is dynamically loaded - type ID of a classed type + type ID of a classed type - Increments the reference count of the class structure belonging to + Increments the reference count of the class structure belonging to @type. This function will demand-create the class if it doesn't exist already. - + - the #GTypeClass + the #GTypeClass structure for the given type ID - type ID of a classed type + type ID of a classed type - A callback function which is called when the reference count of a class -drops to zero. It may use g_type_class_ref() to prevent the class from -being freed. You should not call g_type_class_unref() from a -#GTypeClassCacheFunc function to prevent infinite recursion, use -g_type_class_unref_uncached() instead. + A callback function which is called when the reference count of a class +drops to zero. + +It may use g_type_class_ref() to prevent the class from being freed. You +should not call g_type_class_unref() from a #GTypeClassCacheFunc function +to prevent infinite recursion, use g_type_class_unref_uncached() instead. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain. - + - %TRUE to stop further #GTypeClassCacheFuncs from being + %TRUE to stop further #GTypeClassCacheFuncs from being called, %FALSE to continue - - data that was given to the g_type_add_class_cache_func() call + + data that was given to the g_type_add_class_cache_func() call - The #GTypeClass structure which is + The #GTypeClass structure which is unreferenced - - These flags used to be passed to g_type_init_with_debug_flags() which + + These flags used to be passed to g_type_init_with_debug_flags() which is now deprecated. If you need to enable debugging features, use the GOBJECT_DEBUG environment variable. g_type_init() is now done automatically - + - Print no messages + Print no messages - Print messages about object bookkeeping + Print messages about object bookkeeping - Print messages about signal emissions + Print messages about signal emissions - - Keep a count of instances of each type + + Keep a count of instances of each type - Mask covering all debug flags + Mask covering all debug flags - Bit masks used to check or determine characteristics of a type. - + Bit masks used to check or determine characteristics of a type. + - Indicates an abstract type. No instances can be + Indicates an abstract type. No instances can be created for an abstract type - - Indicates an abstract value type, i.e. a type + + Indicates an abstract value type, i.e. a type that introduces a value table, but can't be used for g_value_init() + + Indicates a final type. A final type is a non-derivable + leaf node in a deep derivable type hierarchy tree. Since: 2.70 + - Bit masks used to check or determine specific characteristics of a + Bit masks used to check or determine specific characteristics of a fundamental type. - + - Indicates a classed type + Indicates a classed type - - Indicates an instantiable type (implies classed) + + Indicates an instantiatable type (implies classed) - Indicates a flat derivable type + Indicates a flat derivable type - - Indicates a deep derivable type (implies derivable) + + Indicates a deep derivable type (implies derivable) - A structure that provides information to the type system which is + A structure that provides information to the type system which is used specifically for managing fundamental types. - + - #GTypeFundamentalFlags describing the characteristics of the fundamental type + #GTypeFundamentalFlags describing the characteristics of the fundamental type - This structure is used to provide the type system with the information + This structure is used to provide the type system with the information required to initialize and destruct (finalize) a type's class and its instances. @@ -13776,29 +9871,21 @@ The initialized structure is passed to the g_type_register_static() function g_type_plugin_complete_type_info()). The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_type_register_static(). - + - Size of the class structure (required for interface, classed and instantiatable types) + Size of the class structure (required for interface, classed and instantiatable types) - Location of the base initialization function (optional) + Location of the base initialization function (optional) - Location of the base finalization function (optional) + Location of the base finalization function (optional) - Location of the class initialization function for + Location of the class initialization function for classed and instantiatable types. Location of the default vtable inititalization function for interface types. (optional) This function is used both to fill in virtual functions in the class or default vtable, @@ -13807,55 +9894,41 @@ across invocation of g_type_register_static(). - Location of the class finalization function for + Location of the class finalization function for classed and instantiatable types. Location of the default vtable finalization function for interface types. (optional) - User-supplied data passed to the class init/finalize functions + User-supplied data passed to the class init/finalize functions - Size of the instance (object) structure (required for instantiatable types only) + Size of the instance (object) structure (required for instantiatable types only) - Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. + Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. - Location of the instance initialization function (optional, for instantiatable types only) + Location of the instance initialization function (optional, for instantiatable types only) - A #GTypeValueTable function table for generic handling of GValues + A #GTypeValueTable function table for generic handling of GValues of this type (usually only useful for fundamental types) - An opaque structure used as the base of all type instances. - + An opaque structure used as the base of all type instances. + - + @@ -13870,10 +9943,8 @@ across invocation of g_type_register_static(). - An opaque structure used as the base of all interface types. - + An opaque structure used as the base of all interface types. + @@ -13881,17 +9952,13 @@ across invocation of g_type_register_static(). - Returns the corresponding #GTypeInterface structure of the parent type + Returns the corresponding #GTypeInterface structure of the parent type of the instance type to which @g_iface belongs. This is useful when deriving the implementation of an interface from the parent type and then possibly overriding some methods. - + - the + the corresponding #GTypeInterface structure of the parent type of the instance type to which @g_iface belongs, or %NULL if the parent type doesn't conform to the interface @@ -13899,111 +9966,99 @@ then possibly overriding some methods. - a #GTypeInterface structure + a #GTypeInterface structure - - Adds @prerequisite_type to the list of prerequisites of @interface_type. + + Adds @prerequisite_type to the list of prerequisites of @interface_type. This means that any type implementing @interface_type must also implement @prerequisite_type. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type. - + - #GType value of an interface type + #GType value of an interface type - #GType value of an interface or instantiatable type + #GType value of an interface or instantiatable type - Returns the #GTypePlugin structure for the dynamic interface + Returns the #GTypePlugin structure for the dynamic interface @interface_type which has been added to @instance_type, or %NULL if @interface_type has not been added to @instance_type or does not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). - + - the #GTypePlugin for the dynamic + the #GTypePlugin for the dynamic interface @interface_type of @instance_type - #GType of an instantiatable type + #GType of an instantiatable type - #GType of an interface type + #GType of an interface type + + + + + + Returns the most specific instantiatable prerequisite of an +interface type. If the interface type has no instantiatable +prerequisite, %G_TYPE_INVALID is returned. + +See g_type_interface_add_prerequisite() for more information +about prerequisites. + + + the instantiatable prerequisite type or %G_TYPE_INVALID if none + + + + + an interface type - Returns the #GTypeInterface structure of an interface to which the + Returns the #GTypeInterface structure of an interface to which the passed in class conforms. - + - the #GTypeInterface + the #GTypeInterface structure of @iface_type if implemented by @instance_class, %NULL otherwise - a #GTypeClass structure + a #GTypeClass structure - an interface ID which this class conforms to + an interface ID which this class conforms to - - Returns the prerequisites of an interfaces type. - + + Returns the prerequisites of an interfaces type. + - a + a newly-allocated zero-terminated array of #GType containing the prerequisites of @interface_type @@ -14012,77 +10067,53 @@ passed in class conforms. - an interface type + an interface type - - location to return the number + + location to return the number of prerequisites, or %NULL - - A callback called after an interface vtable is initialized. + + A callback called after an interface vtable is initialized. + See g_type_add_interface_check(). - + - - data passed to g_type_add_interface_check() + + data passed to g_type_add_interface_check() - the interface that has been + the interface that has been initialized - - #GTypeModule provides a simple implementation of the #GTypePlugin -interface. The model of #GTypeModule is a dynamically loaded module -which implements some number of types and interface implementations. + + #GTypeModule provides a simple implementation of the #GTypePlugin +interface. + +The model of #GTypeModule is a dynamically loaded module which +implements some number of types and interface implementations. + When the module is loaded, it registers its types and interfaces using g_type_module_register_type() and g_type_module_add_interface(). As long as any instances of these types and interface implementations are in use, the module is kept loaded. When the types and interfaces are gone, the module may be unloaded. If the types and interfaces become used again, the module will be reloaded. Note that the last -unref cannot happen in module code, since that would lead to the -caller's code being unloaded before g_object_unref() returns to it. +reference cannot be released from within the module code, since that +would lead to the caller's code being unloaded before g_object_unref() +returns to it. Keeping track of whether the module should be loaded or not is done by using a use count - it starts at zero, and whenever it is greater than @@ -14123,9 +10154,7 @@ in #GTypeModuleClass. - Registers an additional interface for a type, whose interface lives + Registers an additional interface for a type, whose interface lives in the given type plugin. If the interface was already registered for the type in this plugin, nothing will be done. @@ -14134,46 +10163,31 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_add_interface_static() instead. This can be used when making a static build of the module. - + - - a #GTypeModule + + a #GTypeModule - type to which to add the interface. + type to which to add the interface. - interface type to add + interface type to add - type information structure + type information structure - - Looks up or registers an enumeration that is implemented with a particular + + Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -14183,33 +10197,22 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - + - the new or existing type ID + the new or existing type ID - - a #GTypeModule + + a #GTypeModule - name for the type + name for the type - an array of #GEnumValue structs for the + an array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -14217,12 +10220,8 @@ instead. This can be used when making a static build of the module. - - Looks up or registers a flags type that is implemented with a particular + + Looks up or registers a flags type that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -14232,33 +10231,22 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - + - the new or existing type ID + the new or existing type ID - - a #GTypeModule + + a #GTypeModule - name for the type + name for the type - an array of #GFlagsValue structs for the + an array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0. @@ -14267,9 +10255,7 @@ instead. This can be used when making a static build of the module. - Looks up or registers a type that is implemented with a particular + Looks up or registers a type that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -14283,113 +10269,82 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - + - the new or existing type ID + the new or existing type ID - - a #GTypeModule + + a #GTypeModule - the type for the parent class + the type for the parent class - name for the type + name for the type - type information structure + type information structure - flags field providing details about the type + flags field providing details about the type - Sets the name for a #GTypeModule - + Sets the name for a #GTypeModule + - a #GTypeModule. + a #GTypeModule. - a human-readable name to use in error messages. + a human-readable name to use in error messages. - Decreases the use count of a #GTypeModule by one. If the + Decreases the use count of a #GTypeModule by one. If the result is zero, the module will be unloaded. (However, the #GTypeModule will not be freed, and types associated with the #GTypeModule are not unregistered. Once a #GTypeModule is initialized, it must exist forever.) - + - a #GTypeModule + a #GTypeModule - Increases the use count of a #GTypeModule by one. If the + Increases the use count of a #GTypeModule by one. If the use count was zero before, the plugin will be loaded. If loading the plugin fails, the use count is reset to its prior value. - + - %FALSE if the plugin needed to be loaded and + %FALSE if the plugin needed to be loaded and loading the plugin failed. - a #GTypeModule + a #GTypeModule @@ -14411,24 +10366,16 @@ its prior value. - the name of the module + the name of the module - - In order to implement dynamic loading of types based on #GTypeModule, + + In order to implement dynamic loading of types based on #GTypeModule, the @load and @unload functions in #GTypeModuleClass must be implemented. - the parent class + the parent class @@ -14490,16 +10437,11 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. - - The GObject type system supports dynamic loading of types. -The #GTypePlugin interface is used to handle the lifecycle -of dynamically loaded types. It goes as follows: + + An interface that handles the lifecycle of dynamically loaded types. + +The GObject type system supports dynamic loading of types. +It goes as follows: 1. The type is initially introduced (usually upon loading the module the first time, or by your main application that knows what modules @@ -14544,11 +10486,8 @@ when the type is needed again. #GTypeModule is an implementation of #GTypePlugin that already implements most of this except for the actual module loading and unloading. It even handles multiple registered types per module. - - Calls the @complete_interface_info function from the + + Calls the @complete_interface_info function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -14557,37 +10496,26 @@ function outside of the GObject type system itself. - the #GTypePlugin + the #GTypePlugin - the #GType of an instantiable type to which the interface + the #GType of an instantiatable type to which the interface is added - the #GType of the interface whose info is completed + the #GType of the interface whose info is completed - the #GInterfaceInfo to fill in + the #GInterfaceInfo to fill in - - Calls the @complete_type_info function from the #GTypePluginClass of @plugin. + + Calls the @complete_type_info function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -14596,35 +10524,25 @@ type system itself. - a #GTypePlugin + a #GTypePlugin - the #GType whose info is completed + the #GType whose info is completed - the #GTypeInfo struct to fill in + the #GTypeInfo struct to fill in - the #GTypeValueTable to fill in + the #GTypeValueTable to fill in - Calls the @unuse_plugin function from the #GTypePluginClass of + Calls the @unuse_plugin function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -14633,17 +10551,13 @@ the GObject type system itself. - a #GTypePlugin + a #GTypePlugin - Calls the @use_plugin function from the #GTypePluginClass of + Calls the @use_plugin function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -14652,148 +10566,106 @@ the GObject type system itself. - a #GTypePlugin + a #GTypePlugin - The #GTypePlugin interface is used by the type system in order to handle + The #GTypePlugin interface is used by the type system in order to handle the lifecycle of dynamically loaded types. - Increases the use count of the plugin. + Increases the use count of the plugin. - Decreases the use count of the plugin. + Decreases the use count of the plugin. - Fills in the #GTypeInfo and + Fills in the #GTypeInfo and #GTypeValueTable structs for the type. The structs are initialized with `memset(s, 0, sizeof (s))` before calling this function. - + - Fills in missing parts of the #GInterfaceInfo + Fills in missing parts of the #GInterfaceInfo for the interface. The structs is initialized with `memset(s, 0, sizeof (s))` before calling this function. - + - - The type of the @complete_interface_info function of #GTypePluginClass. + + The type of the @complete_interface_info function of #GTypePluginClass. - the #GTypePlugin + the #GTypePlugin - the #GType of an instantiable type to which the interface + the #GType of an instantiatable type to which the interface is added - the #GType of the interface whose info is completed + the #GType of the interface whose info is completed - the #GInterfaceInfo to fill in + the #GInterfaceInfo to fill in - - The type of the @complete_type_info function of #GTypePluginClass. + + The type of the @complete_type_info function of #GTypePluginClass. - the #GTypePlugin + the #GTypePlugin - the #GType whose info is completed + the #GType whose info is completed - the #GTypeInfo struct to fill in + the #GTypeInfo struct to fill in - the #GTypeValueTable to fill in + the #GTypeValueTable to fill in - The type of the @unuse_plugin function of #GTypePluginClass. + The type of the @unuse_plugin function of #GTypePluginClass. - the #GTypePlugin whose use count should be decreased + the #GTypePlugin whose use count should be decreased - The type of the @use_plugin function of #GTypePluginClass, which gets called + The type of the @use_plugin function of #GTypePluginClass, which gets called to increase the use count of @plugin. @@ -14801,53 +10673,40 @@ to increase the use count of @plugin. - the #GTypePlugin whose use count should be increased + the #GTypePlugin whose use count should be increased - A structure holding information for a specific type. -It is filled in by the g_type_query() function. - + A structure holding information for a specific type. + +See also: g_type_query() + - the #GType value of the type + the #GType value of the type - the name of the type + the name of the type - the size of the class structure + the size of the class structure - the size of the instance structure + the size of the instance structure - The #GTypeValueTable provides the functions required by the #GValue + The #GTypeValueTable provides the functions required by the #GValue implementation, to serve as a container for values of a type. - + - + @@ -14860,7 +10719,7 @@ implementation, to serve as a container for values of a type. - + @@ -14873,7 +10732,7 @@ implementation, to serve as a container for values of a type. - + @@ -14889,7 +10748,7 @@ implementation, to serve as a container for values of a type. - + @@ -14901,9 +10760,7 @@ implementation, to serve as a container for values of a type. - A string format describing how to collect the contents of + A string format describing how to collect the contents of this value bit-by-bit. Each character in the format represents an argument to be collected, and the characters themselves indicate the type of the argument. Currently supported arguments are: @@ -14919,7 +10776,7 @@ implementation, to serve as a container for values of a type. - + @@ -14940,16 +10797,14 @@ implementation, to serve as a container for values of a type. - Format description of the arguments to collect for @lcopy_value, + Format description of the arguments to collect for @lcopy_value, analogous to @collect_format. Usually, @lcopy_format string consists only of 'p's to provide lcopy_value() with pointers to storage locations. - + @@ -14969,492 +10824,302 @@ implementation, to serve as a container for values of a type. - - Returns the location of the #GTypeValueTable associated with @type. + + Returns the location of the #GTypeValueTable associated with @type. Note that this function should only be used from source code that implements or has internal knowledge of the implementation of @type. - + - location of the #GTypeValueTable associated with @type or + location of the #GTypeValueTable associated with @type or %NULL if there is no #GTypeValueTable associated with @type - a #GType + a #GType - - Checks if @value holds (or contains) a value of @type. + + Checks if @value holds (or contains) a value of @type. This macro will also check for @value != %NULL and issue a warning if the check fails. - + - A #GValue structure. + A #GValue structure. - A #GType value. + A #GType value. - - Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN. + + Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values derived + + Checks whether the given #GValue can hold values derived from type %G_TYPE_BOXED. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_CHAR. + + Checks whether the given #GValue can hold values of type %G_TYPE_CHAR. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE. + + Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM. + + Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS. + + Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT. + + Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE. + + Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_INT. + + Checks whether the given #GValue can hold values of type %G_TYPE_INT. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_INT64. + + Checks whether the given #GValue can hold values of type %G_TYPE_INT64. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_LONG. + + Checks whether the given #GValue can hold values of type %G_TYPE_LONG. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT. - + + Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT. + - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM. + + Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_POINTER. + + Checks whether the given #GValue can hold values of type %G_TYPE_POINTER. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_STRING. + + Checks whether the given #GValue can hold values of type %G_TYPE_STRING. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR. + + Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_UINT. + + Checks whether the given #GValue can hold values of type %G_TYPE_UINT. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_UINT64. + + Checks whether the given #GValue can hold values of type %G_TYPE_UINT64. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_ULONG. + + Checks whether the given #GValue can hold values of type %G_TYPE_ULONG. - a valid #GValue structure + a valid #GValue structure - - Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT. + + Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT. - a valid #GValue structure + a valid #GValue structure - - For string values, indicates that the string contained is canonical and will + + For string values, indicates that the string contained is canonical and will exist for the duration of the process. See g_value_set_interned_string(). - + - - Checks whether @value contains a string which is canonical. + + Checks whether @value contains a string which is canonical. - a valid #GValue structure + a valid #GValue structure - - If passed to G_VALUE_COLLECT(), allocated data won't be copied + + If passed to G_VALUE_COLLECT(), allocated data won't be copied but used verbatim. This does not affect ref-counted types like objects. This does not affect usage of g_value_copy(), the data will be copied if it is not ref-counted. - + - - Get the type identifier of @value. - + + Get the type identifier of @value. + - A #GValue structure. + A #GValue structure. - - Gets the type name of @value. - + + Gets the type name of @value. + - A #GValue structure. + A #GValue structure. - - This is the signature of va_list marshaller functions, an optional + + This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid marshalling the signal argument into GValues. - + - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - - a #GValue to store the return + + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - - additional data specified when + + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -15462,22 +11127,18 @@ marshalling the signal argument into GValues. - - An opaque structure used to hold different types of values. + + An opaque structure used to hold different types of values. + The data within the structure has protected scope: it is accessible only to functions within a #GTypeValueTable structure, or implementations of the g_value_*() API. That is, code portions which implement new fundamental types. + #GValue users cannot make any assumptions about how data is stored within the 2 element @data union, and the @g_type member should only be accessed through the G_VALUE_TYPE() macro. - + @@ -15487,750 +11148,523 @@ only be accessed through the G_VALUE_TYPE() macro. - Copies the value of @src_value into @dest_value. - + Copies the value of @src_value into @dest_value. + - An initialized #GValue structure. + An initialized #GValue structure. - An initialized #GValue structure of the same type as @src_value. + An initialized #GValue structure of the same type as @src_value. - - Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting, + + Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting, the boxed value is duplicated and needs to be later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), return_value); - boxed contents of @value + boxed contents of @value - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing + Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing its reference count. If the contents of the #GValue are %NULL, then %NULL will be returned. - + - object content of @value, + object content of @value, should be unreferenced when no longer needed. - a valid #GValue whose type is derived from %G_TYPE_OBJECT + a valid #GValue whose type is derived from %G_TYPE_OBJECT - - Get the contents of a %G_TYPE_PARAM #GValue, increasing its + + Get the contents of a %G_TYPE_PARAM #GValue, increasing its reference count. - - - #GParamSpec content of @value, should be unreferenced when - no longer needed. + + + #GParamSpec content of @value, should be + unreferenced when no longer needed. - a valid #GValue whose type is derived from %G_TYPE_PARAM + a valid #GValue whose type is derived from %G_TYPE_PARAM - Get a copy the contents of a %G_TYPE_STRING #GValue. + Get a copy the contents of a %G_TYPE_STRING #GValue. - a newly allocated copy of the string content of @value + a newly allocated copy of the string content of @value - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - - Get the contents of a variant #GValue, increasing its refcount. The returned + + Get the contents of a variant #GValue, increasing its refcount. The returned #GVariant is never floating. - variant contents of @value (may be %NULL); + variant contents of @value (may be %NULL); should be unreffed using g_variant_unref() when no longer needed - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - Determines if @value will fit inside the size of a pointer value. + Determines if @value will fit inside the size of a pointer value. This is an internal function introduced mainly for C marshallers. - + - %TRUE if @value will fit inside a pointer value. + %TRUE if @value will fit inside a pointer value. - An initialized #GValue structure. + An initialized #GValue structure. - Get the contents of a %G_TYPE_BOOLEAN #GValue. + Get the contents of a %G_TYPE_BOOLEAN #GValue. - boolean contents of @value + boolean contents of @value - a valid #GValue of type %G_TYPE_BOOLEAN + a valid #GValue of type %G_TYPE_BOOLEAN - Get the contents of a %G_TYPE_BOXED derived #GValue. + Get the contents of a %G_TYPE_BOXED derived #GValue. - boxed contents of @value + boxed contents of @value - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - - Do not use this function; it is broken on platforms where the %char + + Do not use this function; it is broken on platforms where the %char type is unsigned, such as ARM and PowerPC. See g_value_get_schar(). Get the contents of a %G_TYPE_CHAR #GValue. This function's return type is broken, see g_value_get_schar() - character contents of @value + character contents of @value - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - Get the contents of a %G_TYPE_DOUBLE #GValue. + Get the contents of a %G_TYPE_DOUBLE #GValue. - double contents of @value + double contents of @value - a valid #GValue of type %G_TYPE_DOUBLE + a valid #GValue of type %G_TYPE_DOUBLE - Get the contents of a %G_TYPE_ENUM #GValue. + Get the contents of a %G_TYPE_ENUM #GValue. - enum contents of @value + enum contents of @value - a valid #GValue whose type is derived from %G_TYPE_ENUM + a valid #GValue whose type is derived from %G_TYPE_ENUM - Get the contents of a %G_TYPE_FLAGS #GValue. + Get the contents of a %G_TYPE_FLAGS #GValue. - flags contents of @value + flags contents of @value - a valid #GValue whose type is derived from %G_TYPE_FLAGS + a valid #GValue whose type is derived from %G_TYPE_FLAGS - Get the contents of a %G_TYPE_FLOAT #GValue. + Get the contents of a %G_TYPE_FLOAT #GValue. - float contents of @value + float contents of @value - a valid #GValue of type %G_TYPE_FLOAT + a valid #GValue of type %G_TYPE_FLOAT - Get the contents of a %G_TYPE_GTYPE #GValue. + Get the contents of a %G_TYPE_GTYPE #GValue. - the #GType stored in @value + the #GType stored in @value - a valid #GValue of type %G_TYPE_GTYPE + a valid #GValue of type %G_TYPE_GTYPE - Get the contents of a %G_TYPE_INT #GValue. + Get the contents of a %G_TYPE_INT #GValue. - integer contents of @value + integer contents of @value - a valid #GValue of type %G_TYPE_INT + a valid #GValue of type %G_TYPE_INT - Get the contents of a %G_TYPE_INT64 #GValue. + Get the contents of a %G_TYPE_INT64 #GValue. - 64bit integer contents of @value + 64bit integer contents of @value - a valid #GValue of type %G_TYPE_INT64 + a valid #GValue of type %G_TYPE_INT64 - Get the contents of a %G_TYPE_LONG #GValue. + Get the contents of a %G_TYPE_LONG #GValue. - long integer contents of @value + long integer contents of @value - a valid #GValue of type %G_TYPE_LONG + a valid #GValue of type %G_TYPE_LONG - Get the contents of a %G_TYPE_OBJECT derived #GValue. - + Get the contents of a %G_TYPE_OBJECT derived #GValue. + - object contents of @value + object contents of @value - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - Get the contents of a %G_TYPE_PARAM #GValue. - + Get the contents of a %G_TYPE_PARAM #GValue. + - #GParamSpec content of @value + #GParamSpec content of @value - a valid #GValue whose type is derived from %G_TYPE_PARAM + a valid #GValue whose type is derived from %G_TYPE_PARAM - Get the contents of a pointer #GValue. + Get the contents of a pointer #GValue. - pointer contents of @value + pointer contents of @value - a valid #GValue of %G_TYPE_POINTER + a valid #GValue of %G_TYPE_POINTER - Get the contents of a %G_TYPE_CHAR #GValue. + Get the contents of a %G_TYPE_CHAR #GValue. - signed 8 bit integer contents of @value + signed 8 bit integer contents of @value - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - Get the contents of a %G_TYPE_STRING #GValue. + Get the contents of a %G_TYPE_STRING #GValue. - string content of @value + string content of @value - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - Get the contents of a %G_TYPE_UCHAR #GValue. + Get the contents of a %G_TYPE_UCHAR #GValue. - unsigned character contents of @value + unsigned character contents of @value - a valid #GValue of type %G_TYPE_UCHAR + a valid #GValue of type %G_TYPE_UCHAR - Get the contents of a %G_TYPE_UINT #GValue. + Get the contents of a %G_TYPE_UINT #GValue. - unsigned integer contents of @value + unsigned integer contents of @value - a valid #GValue of type %G_TYPE_UINT + a valid #GValue of type %G_TYPE_UINT - Get the contents of a %G_TYPE_UINT64 #GValue. + Get the contents of a %G_TYPE_UINT64 #GValue. - unsigned 64bit integer contents of @value + unsigned 64bit integer contents of @value - a valid #GValue of type %G_TYPE_UINT64 + a valid #GValue of type %G_TYPE_UINT64 - Get the contents of a %G_TYPE_ULONG #GValue. + Get the contents of a %G_TYPE_ULONG #GValue. - unsigned long integer contents of @value + unsigned long integer contents of @value - a valid #GValue of type %G_TYPE_ULONG + a valid #GValue of type %G_TYPE_ULONG - - Get the contents of a variant #GValue. + + Get the contents of a variant #GValue. - variant contents of @value (may be %NULL) + variant contents of @value (may be %NULL) - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - Initializes @value with the default value of @type. - + Initializes @value with the default value of @type. + - the #GValue structure that has been passed in + the #GValue structure that has been passed in - A zero-filled (uninitialized) #GValue structure. + A zero-filled (uninitialized) #GValue structure. - Type the #GValue should hold values of. + Type the #GValue should hold values of. - - Initializes and sets @value from an instantiatable type via the + + Initializes and sets @value from an instantiatable type via the value_table's collect_value() function. Note: The @value will be initialised with the exact type of @instance. If you wish to set the @value's type to a different GType (such as a parent class GType), you need to manually call g_value_init() and g_value_set_instance(). - + - An uninitialized #GValue structure. + An uninitialized #GValue structure. - the instance + the instance - Returns the value contents as pointer. This function asserts that + Returns the value contents as pointer. This function asserts that g_value_fits_pointer() returned %TRUE for the passed in value. This is an internal function introduced mainly for C marshallers. - + - the value contents as pointer + the value contents as pointer - An initialized #GValue structure + An initialized #GValue structure - Clears the current value in @value and resets it to the default value + Clears the current value in @value and resets it to the default value (as if the value had just been initialized). - + - the #GValue structure that has been passed in + the #GValue structure that has been passed in - An initialized #GValue structure. + An initialized #GValue structure. - Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean. + Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean. - a valid #GValue of type %G_TYPE_BOOLEAN + a valid #GValue of type %G_TYPE_BOOLEAN - boolean value to be set + boolean value to be set - Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - - boxed value to be set + + boxed value to be set - - This is an internal function introduced mainly for C marshallers. + + This is an internal function introduced mainly for C marshallers. Use g_value_take_boxed() instead. @@ -16238,29 +11672,17 @@ This is an internal function introduced mainly for C marshallers. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - - duplicated unowned boxed value to be set + + duplicated unowned boxed value to be set - - Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + + Set the contents of a %G_TYPE_CHAR #GValue to @v_char. This function's input type is broken, see g_value_set_schar() @@ -16268,213 +11690,154 @@ This is an internal function introduced mainly for C marshallers. - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - character value to be set + character value to be set - Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double. + Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double. - a valid #GValue of type %G_TYPE_DOUBLE + a valid #GValue of type %G_TYPE_DOUBLE - double value to be set + double value to be set - Set the contents of a %G_TYPE_ENUM #GValue to @v_enum. + Set the contents of a %G_TYPE_ENUM #GValue to @v_enum. - a valid #GValue whose type is derived from %G_TYPE_ENUM + a valid #GValue whose type is derived from %G_TYPE_ENUM - enum value to be set + enum value to be set - Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags. + Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags. - a valid #GValue whose type is derived from %G_TYPE_FLAGS + a valid #GValue whose type is derived from %G_TYPE_FLAGS - flags value to be set + flags value to be set - Set the contents of a %G_TYPE_FLOAT #GValue to @v_float. + Set the contents of a %G_TYPE_FLOAT #GValue to @v_float. - a valid #GValue of type %G_TYPE_FLOAT + a valid #GValue of type %G_TYPE_FLOAT - float value to be set + float value to be set - Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype. + Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype. - a valid #GValue of type %G_TYPE_GTYPE + a valid #GValue of type %G_TYPE_GTYPE - #GType to be set + #GType to be set - Sets @value from an instantiatable type via the + Sets @value from an instantiatable type via the value_table's collect_value() function. - + - An initialized #GValue structure. + An initialized #GValue structure. - - the instance + + the instance - Set the contents of a %G_TYPE_INT #GValue to @v_int. + Set the contents of a %G_TYPE_INT #GValue to @v_int. - a valid #GValue of type %G_TYPE_INT + a valid #GValue of type %G_TYPE_INT - integer value to be set + integer value to be set - Set the contents of a %G_TYPE_INT64 #GValue to @v_int64. + Set the contents of a %G_TYPE_INT64 #GValue to @v_int64. - a valid #GValue of type %G_TYPE_INT64 + a valid #GValue of type %G_TYPE_INT64 - 64bit integer value to be set + 64bit integer value to be set - - Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is + + Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static and interned (canonical, for example from g_intern_string()), and is thus not duplicated when setting the #GValue. @@ -16483,49 +11846,34 @@ g_intern_string()), and is thus not duplicated when setting the #GValue. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - - static string to be set + + static string to be set - Set the contents of a %G_TYPE_LONG #GValue to @v_long. + Set the contents of a %G_TYPE_LONG #GValue to @v_long. - a valid #GValue of type %G_TYPE_LONG + a valid #GValue of type %G_TYPE_LONG - long integer value to be set + long integer value to be set - Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object. + Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object. g_value_set_object() increases the reference count of @v_object (the #GValue holds a reference to @v_object). If you do not wish @@ -16536,169 +11884,111 @@ need it), use g_value_take_object() instead. It is important that your #GValue holds a reference to @v_object (either its own, or one it has taken) to ensure that the object won't be destroyed while the #GValue still exists). - + - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - - object value to be set + + object value to be set - - This is an internal function introduced mainly for C marshallers. + + This is an internal function introduced mainly for C marshallers. Use g_value_take_object() instead. - + - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - - object value to be set + + object value to be set - Set the contents of a %G_TYPE_PARAM #GValue to @param. - + Set the contents of a %G_TYPE_PARAM #GValue to @param. + - a valid #GValue of type %G_TYPE_PARAM + a valid #GValue of type %G_TYPE_PARAM - - the #GParamSpec to be set + + the #GParamSpec to be set - - This is an internal function introduced mainly for C marshallers. + + This is an internal function introduced mainly for C marshallers. Use g_value_take_param() instead. - + - a valid #GValue of type %G_TYPE_PARAM + a valid #GValue of type %G_TYPE_PARAM - - the #GParamSpec to be set + + the #GParamSpec to be set - Set the contents of a pointer #GValue to @v_pointer. + Set the contents of a pointer #GValue to @v_pointer. - a valid #GValue of %G_TYPE_POINTER + a valid #GValue of %G_TYPE_POINTER - - pointer value to be set + + pointer value to be set - Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + Set the contents of a %G_TYPE_CHAR #GValue to @v_char. - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - signed 8 bit integer to be set + signed 8 bit integer to be set - Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + The boxed value is assumed to be static, and is thus not duplicated when setting the #GValue. @@ -16707,27 +11997,17 @@ when setting the #GValue. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - - static boxed value to be set + + static boxed value to be set - - Set the contents of a %G_TYPE_STRING #GValue to @v_string. + + Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static, and is thus not duplicated when setting the #GValue. @@ -16739,55 +12019,34 @@ is more appropriate. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - - static string to be set + + static string to be set - Set the contents of a %G_TYPE_STRING #GValue to @v_string. + Set the contents of a %G_TYPE_STRING #GValue to a copy of @v_string. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - - caller-owned string to be duplicated for the #GValue + + caller-owned string to be duplicated for the #GValue - - This is an internal function introduced mainly for C marshallers. + + This is an internal function introduced mainly for C marshallers. Use g_value_take_string() instead. @@ -16795,120 +12054,85 @@ is more appropriate. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - - duplicated unowned string to be set + + duplicated unowned string to be set - Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar. + Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar. - a valid #GValue of type %G_TYPE_UCHAR + a valid #GValue of type %G_TYPE_UCHAR - unsigned character value to be set + unsigned character value to be set - Set the contents of a %G_TYPE_UINT #GValue to @v_uint. + Set the contents of a %G_TYPE_UINT #GValue to @v_uint. - a valid #GValue of type %G_TYPE_UINT + a valid #GValue of type %G_TYPE_UINT - unsigned integer value to be set + unsigned integer value to be set - Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64. + Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64. - a valid #GValue of type %G_TYPE_UINT64 + a valid #GValue of type %G_TYPE_UINT64 - unsigned 64bit integer value to be set + unsigned 64bit integer value to be set - Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong. + Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong. - a valid #GValue of type %G_TYPE_ULONG + a valid #GValue of type %G_TYPE_ULONG - unsigned long integer value to be set + unsigned long integer value to be set - - Set the contents of a variant #GValue to @variant. + + Set the contents of a variant #GValue to @variant. If the variant is floating, it is consumed. @@ -16916,152 +12140,95 @@ If the variant is floating, it is consumed. - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - - a #GVariant, or %NULL + + a #GVariant, or %NULL - - Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed -and takes over the ownership of the caller’s reference to @v_boxed; -the caller doesn’t have to unref it any more. + + Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed +and takes over the ownership of the caller’s reference to @v_boxed; +the caller doesn’t have to unref it any more. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - - duplicated unowned boxed value to be set + + duplicated unowned boxed value to be set - - Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object -and takes over the ownership of the caller’s reference to @v_object; -the caller doesn’t have to unref it any more (i.e. the reference + + Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object +and takes over the ownership of the caller’s reference to @v_object; +the caller doesn’t have to unref it any more (i.e. the reference count of the object is not increased). If you want the #GValue to hold its own reference to @v_object, use g_value_set_object() instead. - + - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - - object value to be set + + object value to be set - - Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes -over the ownership of the caller’s reference to @param; the caller -doesn’t have to unref it any more. - + + Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes +over the ownership of the caller’s reference to @param; the caller +doesn’t have to unref it any more. + - a valid #GValue of type %G_TYPE_PARAM + a valid #GValue of type %G_TYPE_PARAM - - the #GParamSpec to be set + + the #GParamSpec to be set - - Sets the contents of a %G_TYPE_STRING #GValue to @v_string. + + Sets the contents of a %G_TYPE_STRING #GValue to @v_string. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - - string to take ownership of + + string to take ownership of - - Set the contents of a variant #GValue to @variant, and takes over + + Set the contents of a variant #GValue to @variant, and takes over the ownership of the caller's reference to @variant; the caller doesn't have to unref it any more (i.e. the reference count of the variant is not increased). @@ -17079,284 +12246,190 @@ This is an internal function introduced mainly for C marshallers. - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - - a #GVariant, or %NULL + + a #GVariant, or %NULL - Tries to cast the contents of @src_value into a type appropriate + Tries to cast the contents of @src_value into a type appropriate to store in @dest_value, e.g. to transform a %G_TYPE_INT value into a %G_TYPE_FLOAT value. Performing transformations between value types might incur precision lossage. Especially transformations into strings might reveal seemingly arbitrary results and shouldn't be relied upon for production code (such as rcfile value or object property serialization). - + - Whether a transformation rule was found and could be applied. + Whether a transformation rule was found and could be applied. Upon failing transformations, @dest_value is left untouched. - Source value. + Source value. - Target value. + Target value. - Clears the current value in @value (if any) and "unsets" the type, + Clears the current value in @value (if any) and "unsets" the type, this releases all resources associated with this GValue. An unset value is the same as an uninitialized (zero-filled) #GValue structure. - + - An initialized #GValue structure. + An initialized #GValue structure. - - Registers a value transformation function for use in g_value_transform(). + + Registers a value transformation function for use in g_value_transform(). A previously registered transformation function for @src_type and @dest_type will be replaced. - + - Source type. + Source type. - Target type. + Target type. - a function which transforms values of type @src_type + a function which transforms values of type @src_type into value of type @dest_type - Returns whether a #GValue of type @src_type can be copied into + Returns whether a #GValue of type @src_type can be copied into a #GValue of type @dest_type. - + - %TRUE if g_value_copy() is possible with @src_type and @dest_type. + %TRUE if g_value_copy() is possible with @src_type and @dest_type. - source type to be copied. + source type to be copied. - destination type for copying. + destination type for copying. - - Check whether g_value_transform() is able to transform values + + Check whether g_value_transform() is able to transform values of type @src_type into values of type @dest_type. Note that for the types to be transformable, they must be compatible or a transformation function must be registered. - + - %TRUE if the transformation is possible, %FALSE otherwise. + %TRUE if the transformation is possible, %FALSE otherwise. - Source type. + Source type. - Target type. + Target type. - - A #GValueArray contains an array of #GValue elements. + + A #GValueArray contains an array of #GValue elements. - number of values contained in the array + number of values contained in the array - array of values + array of values - - Allocate and initialize a new #GValueArray, optionally preserve space + + Allocate and initialize a new #GValueArray, optionally preserve space for @n_prealloced elements. New arrays always contain 0 elements, regardless of the value of @n_prealloced. Use #GArray and g_array_sized_new() instead. - a newly allocated #GValueArray with 0 values + a newly allocated #GValueArray with 0 values - number of values to preallocate space for + number of values to preallocate space for - - Insert a copy of @value as last element of @value_array. If @value is + + Insert a copy of @value as last element of @value_array. If @value is %NULL, an uninitialized value is appended. Use #GArray and g_array_append_val() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to add an element to + #GValueArray to add an element to - - #GValue to copy into #GValueArray, or %NULL + + #GValue to copy into #GValueArray, or %NULL - - Construct an exact copy of a #GValueArray by duplicating all its + + Construct an exact copy of a #GValueArray by duplicating all its contents. Use #GArray and g_array_ref() instead. - Newly allocated copy of #GValueArray + Newly allocated copy of #GValueArray - #GValueArray to copy + #GValueArray to copy - - Free a #GValueArray including its contents. + + Free a #GValueArray including its contents. Use #GArray and g_array_unref() instead. @@ -17364,156 +12437,96 @@ contents. - #GValueArray to free + #GValueArray to free - - Return a pointer to the value at @index_ containd in @value_array. + + Return a pointer to the value at @index_ containd in @value_array. Use g_array_index() instead. - pointer to a value at @index_ in @value_array + pointer to a value at @index_ in @value_array - #GValueArray to get a value from + #GValueArray to get a value from - index of the value of interest + index of the value of interest - - Insert a copy of @value at specified position into @value_array. If @value + + Insert a copy of @value at specified position into @value_array. If @value is %NULL, an uninitialized value is inserted. Use #GArray and g_array_insert_val() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to add an element to + #GValueArray to add an element to - insertion position, must be <= value_array->;n_values + insertion position, must be <= value_array->;n_values - - #GValue to copy into #GValueArray, or %NULL + + #GValue to copy into #GValueArray, or %NULL - - Insert a copy of @value as first element of @value_array. If @value is + + Insert a copy of @value as first element of @value_array. If @value is %NULL, an uninitialized value is prepended. Use #GArray and g_array_prepend_val() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to add an element to + #GValueArray to add an element to - - #GValue to copy into #GValueArray, or %NULL + + #GValue to copy into #GValueArray, or %NULL - - Remove the value at position @index_ from @value_array. + + Remove the value at position @index_ from @value_array. Use #GArray and g_array_remove_index() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to remove an element from + #GValueArray to remove an element from - position of value to remove, which must be less than + position of value to remove, which must be less than @value_array->n_values - - Sort @value_array using @compare_func to compare the elements according to + + Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareFunc. The current implementation uses the same sorting algorithm as standard @@ -17521,36 +12534,22 @@ C qsort() function. Use #GArray and g_array_sort(). - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to sort + #GValueArray to sort - - function to compare elements + + function to compare elements - - Sort @value_array using @compare_func to compare the elements according + + Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareDataFunc. The current implementation uses the same sorting algorithm as standard @@ -17558,102 +12557,74 @@ C qsort() function. Use #GArray and g_array_sort_with_data(). - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to sort + #GValueArray to sort - - function to compare elements + + function to compare elements - - extra data argument provided for @compare_func + + extra data argument provided for @compare_func - The type of value transformation functions which can be registered with + The type of value transformation functions which can be registered with g_value_register_transform_func(). @dest_value will be initialized to the correct destination type. - + - Source value. + Source value. - Target value. + Target value. - A #GWeakNotify function can be added to an object as a callback that gets -triggered when the object is finalized. Since the object is already being -finalized when the #GWeakNotify is called, there's not much you could do -with the object, apart from e.g. using its address as hash-index or the like. - + A #GWeakNotify function can be added to an object as a callback that gets +triggered when the object is finalized. + +Since the object is already being disposed when the #GWeakNotify is called, +there's not much you could do with the object, apart from e.g. using its +address as hash-index or the like. + - - data that was provided when the weak reference was established + + data that was provided when the weak reference was established - the object being finalized + the object being disposed - A structure containing a weak reference to a #GObject. It can either -be empty (i.e. point to %NULL), or point to an object for as long as -at least one "strong" reference to that object exists. Before the -object's #GObjectClass.dispose method is called, every #GWeakRef -associated with becomes empty (i.e. points to %NULL). + A structure containing a weak reference to a #GObject. + +A `GWeakRef` can either be empty (i.e. point to %NULL), or point to an +object for as long as at least one "strong" reference to that object +exists. Before the object's #GObjectClass.dispose method is called, +every #GWeakRef associated with becomes empty (i.e. points to %NULL). Like #GValue, #GWeakRef can be statically allocated, stack- or heap-allocated, or embedded in larger structures. @@ -17669,48 +12640,33 @@ before it was disposed will continue to point to %NULL. If #GWeakRefs are taken after the object is disposed and re-referenced, they will continue to point to it until its refcount goes back to zero, at which point they too will be invalidated. - + - + - - Frees resources associated with a non-statically-allocated #GWeakRef. + + Frees resources associated with a non-statically-allocated #GWeakRef. After this call, the #GWeakRef is left in an undefined state. You should only call this on a #GWeakRef that previously had g_weak_ref_init() called on it. - + - - location of a weak reference, which + + location of a weak reference, which may be empty - - If @weak_ref is not empty, atomically acquire a strong + + If @weak_ref is not empty, atomically acquire a strong reference to the object it points to, and return that reference. This function is needed because of the potential race between taking @@ -17719,33 +12675,21 @@ its last reference at the same time in a different thread. The caller should release the resulting reference in the usual way, by using g_object_unref(). - + - the object pointed to + the object pointed to by @weak_ref, or %NULL if it was empty - - location of a weak reference to a #GObject + + location of a weak reference to a #GObject - - Initialise a non-statically-allocated #GWeakRef. + + Initialise a non-statically-allocated #GWeakRef. This function also calls g_weak_ref_set() with @object on the freshly-initialised weak reference. @@ -17754,61 +12698,39 @@ This function should always be matched with a call to g_weak_ref_clear(). It is not necessary to use this function for a #GWeakRef in static storage because it will already be properly initialised. Just use g_weak_ref_set() directly. - + - - uninitialized or empty location for a weak + + uninitialized or empty location for a weak reference - - a #GObject or %NULL + + a #GObject or %NULL - - Change the object to which @weak_ref points, or set it to + + Change the object to which @weak_ref points, or set it to %NULL. You must own a strong reference on @object while calling this function. - + - location for a weak reference + location for a weak reference - - a #GObject or %NULL + + a #GObject or %NULL @@ -17843,13 +12765,8 @@ function. - - Assert that @object is non-%NULL, then release one reference to it with + + Assert that @object is non-%NULL, then release one reference to it with g_object_unref() and assert that it has been finalized (i.e. that there are no more references). @@ -17857,107 +12774,81 @@ If assertions are disabled via `G_DISABLE_ASSERT`, this macro just calls g_object_unref() without any further checks. This macro should only be used in regression tests. - + - an object + an object - Provide a copy of a boxed structure @src_boxed which is of type @boxed_type. + Provide a copy of a boxed structure @src_boxed which is of type @boxed_type. - The newly created copy of the boxed + The newly created copy of the boxed structure. - The type of @src_boxed. + The type of @src_boxed. - The boxed structure to be copied. + The boxed structure to be copied. - Free the boxed structure @boxed which is of type @boxed_type. + Free the boxed structure @boxed which is of type @boxed_type. - The type of @boxed. + The type of @boxed. - The boxed structure to be freed. + The boxed structure to be freed. - - This function creates a new %G_TYPE_BOXED derived type id for a new -boxed type with name @name. Boxed type handling functions have to be -provided to copy and free opaque boxed structures of this type. + + This function creates a new %G_TYPE_BOXED derived type id for a new +boxed type with name @name. + +Boxed type handling functions have to be provided to copy and free +opaque boxed structures of this type. + +For the general case, it is recommended to use #G_DEFINE_BOXED_TYPE +instead of calling g_boxed_type_register_static() directly. The macro +will create the appropriate `*_get_type()` function for the boxed type. - New %G_TYPE_BOXED derived type id for @name. + New %G_TYPE_BOXED derived type id for @name. - Name of the new boxed type. + Name of the new boxed type. - Boxed structure copy function. + Boxed structure copy function. - Boxed structure free function. + Boxed structure free function. - - A #GClosureMarshal function for use with signals with handlers that + + A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled(). @@ -17967,60 +12858,38 @@ accumulator, such as g_signal_accumulator_true_handled(). - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - - The invocation hint given as the last argument to + + The invocation hint given as the last argument to g_closure_invoke(). - - Additional data specified when registering the + + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -18029,54 +12898,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue which can store the returned #gboolean + a #GValue which can store the returned #gboolean - 2 + 2 - a #GValue array holding instance and arg1 + a #GValue array holding instance and arg1 - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. @@ -18084,56 +12933,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue, which can store the returned string + a #GValue, which can store the returned string - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. @@ -18141,56 +12968,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gboolean parameter + a #GValue array holding the instance and the #gboolean parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. @@ -18198,56 +13003,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GBoxed* parameter + a #GValue array holding the instance and the #GBoxed* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. @@ -18255,56 +13038,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar parameter + a #GValue array holding the instance and the #gchar parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. @@ -18312,56 +13073,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gdouble parameter + a #GValue array holding the instance and the #gdouble parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. @@ -18369,56 +13108,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the enumeration parameter + a #GValue array holding the instance and the enumeration parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -18426,56 +13143,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the flags parameter + a #GValue array holding the instance and the flags parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. @@ -18483,56 +13178,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gfloat parameter + a #GValue array holding the instance and the #gfloat parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. @@ -18540,56 +13213,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gint parameter + a #GValue array holding the instance and the #gint parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. @@ -18597,56 +13248,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #glong parameter + a #GValue array holding the instance and the #glong parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. @@ -18654,56 +13283,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GObject* parameter + a #GValue array holding the instance and the #GObject* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. @@ -18711,56 +13318,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GParamSpec* parameter + a #GValue array holding the instance and the #GParamSpec* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. @@ -18768,56 +13353,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gpointer parameter + a #GValue array holding the instance and the #gpointer parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. @@ -18825,56 +13388,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar* parameter + a #GValue array holding the instance and the #gchar* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. @@ -18882,56 +13423,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guchar parameter + a #GValue array holding the instance and the #guchar parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. @@ -18939,56 +13458,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guint parameter + a #GValue array holding the instance and the #guint parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. @@ -18996,56 +13493,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. @@ -19053,57 +13528,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gulong parameter + a #GValue array holding the instance and the #gulong parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. @@ -19111,56 +13563,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GVariant* parameter + a #GValue array holding the instance and the #GVariant* parameter - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A marshaller for a #GCClosure with a callback of type + + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer user_data)`. @@ -19168,280 +13598,170 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 1 + 1 - a #GValue array holding only the instance + a #GValue array holding only the instance - - the invocation hint given as the last argument + + the invocation hint given as the last argument to g_closure_invoke() - - additional data specified when registering the marshaller + + additional data specified when registering the marshaller - - A generic marshaller function implemented via + + A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). Normally this function is not passed explicitly to g_signal_new(), but used automatically by GLib when specifying a %NULL marshaller. - + - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - - The invocation hint given as the last argument to + + The invocation hint given as the last argument to g_closure_invoke(). - - Additional data specified when registering the + + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - - Creates a new closure which invokes @callback_func with @user_data as + + Creates a new closure which invokes @callback_func with @user_data as the last parameter. -@destroy_data will be called as a finalize notifier on the #GClosure. - - - a floating reference to a new #GCClosure - - - - - the function to invoke - - - - user data to pass to @callback_func - - - - destroy notify to be called when @user_data is no longer used - - - - - - A variant of g_cclosure_new() which uses @object as @user_data and -calls g_object_watch_closure() on @object and the created -closure. This function is useful when you have a callback closely -associated with a #GObject, and want the callback to no longer run -after the object is is freed. - - - a new #GCClosure - - - - - the function to invoke - - - - a #GObject pointer to pass to @callback_func - - - - - - A variant of g_cclosure_new_swap() which uses @object as @user_data -and calls g_object_watch_closure() on @object and the created -closure. This function is useful when you have a callback closely -associated with a #GObject, and want the callback to no longer run -after the object is is freed. - - - a new #GCClosure - - - - - the function to invoke - - - - a #GObject pointer to pass to @callback_func - - - - - - Creates a new closure which invokes @callback_func with @user_data as -the first parameter. - @destroy_data will be called as a finalize notifier on the #GClosure. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - - the function to invoke + + the function to invoke - - user data to pass to @callback_func + + user data to pass to @callback_func - destroy notify to be called when @user_data is no longer used + destroy notify to be called when @user_data is no longer used - - Clears a reference to a #GObject. + + A variant of g_cclosure_new() which uses @object as @user_data and +calls g_object_watch_closure() on @object and the created +closure. This function is useful when you have a callback closely +associated with a #GObject, and want the callback to no longer run +after the object is is freed. + + + a new #GCClosure + + + + + the function to invoke + + + + a #GObject pointer to pass to @callback_func + + + + + + A variant of g_cclosure_new_swap() which uses @object as @user_data +and calls g_object_watch_closure() on @object and the created +closure. This function is useful when you have a callback closely +associated with a #GObject, and want the callback to no longer run +after the object is is freed. + + + a new #GCClosure + + + + + the function to invoke + + + + a #GObject pointer to pass to @callback_func + + + + + + Creates a new closure which invokes @callback_func with @user_data as +the first parameter. + +@destroy_data will be called as a finalize notifier on the #GClosure. + + + a floating reference to a new #GCClosure + + + + + the function to invoke + + + + user data to pass to @callback_func + + + + destroy notify to be called when @user_data is no longer used + + + + + + Clears a reference to a #GObject. @object_ptr must not be %NULL. @@ -19451,58 +13771,44 @@ pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts. - + - a pointer to a #GObject reference + a pointer to a #GObject reference - - Disconnects a handler from @instance so it will not be called during + + Disconnects a handler from @instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id_ptr is then set to zero, which is never a valid handler ID value (see g_signal_connect()). If the handler ID is 0 then this function does nothing. -A macro is also included that allows this function to be used without -pointer casts. - +There is also a macro version of this function so that the code +will be inlined. + - A pointer to a handler ID (of type #gulong) of the handler to be disconnected. + A pointer to a handler ID (of type #gulong) of the handler to be disconnected. - The instance to remove the signal handler from. + The instance to remove the signal handler from. + This pointer may be %NULL or invalid, if the handler ID is zero. - - Clears a weak reference to a #GObject. + + Clears a weak reference to a #GObject. @weak_pointer_location must not be %NULL. @@ -19513,20 +13819,15 @@ and the pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts. The function itself is static inline, so its address may vary between compilation units. - + - The memory address of a pointer + The memory address of a pointer - - This function is meant to be called from the `complete_type_info` + + This function is meant to be called from the `complete_type_info` function of a #GTypePlugin implementation, as in the following example: @@ -19552,24 +13853,15 @@ my_enum_complete_type_info (GTypePlugin *plugin, - the type identifier of the type being completed + the type identifier of the type being completed - - the #GTypeInfo struct to be filled in + + the #GTypeInfo struct to be filled in - An array of #GEnumValue structs for the possible + An array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -19577,117 +13869,82 @@ my_enum_complete_type_info (GTypePlugin *plugin, - Returns the #GEnumValue for a value. + Returns the #GEnumValue for a value. - - the #GEnumValue for @value, or %NULL + + the #GEnumValue for @value, or %NULL if @value is not a member of the enumeration - a #GEnumClass + a #GEnumClass - the value to look up + the value to look up - - Looks up a #GEnumValue by name. + + Looks up a #GEnumValue by name. - - the #GEnumValue with name @name, + + the #GEnumValue with name @name, or %NULL if the enumeration doesn't have a member with that name - a #GEnumClass + a #GEnumClass - the name to look up + the name to look up - - Looks up a #GEnumValue by nickname. + + Looks up a #GEnumValue by nickname. - - the #GEnumValue with nickname @nick, + + the #GEnumValue with nickname @nick, or %NULL if the enumeration doesn't have a member with that nickname - a #GEnumClass + a #GEnumClass - the nickname to look up + the nickname to look up - - Registers a new static enumeration type with the name @name. + + Registers a new static enumeration type with the name @name. It is normally more convenient to let [glib-mkenums][glib-mkenums], generate a my_enum_get_type() function from a usual C enumeration definition than to write one yourself using g_enum_register_static(). - The new type identifier. + The new type identifier. - A nul-terminated string used as the name of the new type. + A nul-terminated string used as the name of the new type. - An array of #GEnumValue structs for the possible + An array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. GObject keeps a reference to the data, so it cannot be stack-allocated. @@ -19695,41 +13952,29 @@ definition than to write one yourself using g_enum_register_static(). - - Pretty-prints @value in the form of the enum’s name. + + Pretty-prints @value in the form of the enum’s name. This is intended to be used for debugging purposes. The format of the output may change in the future. - a newly-allocated text string + a newly-allocated text string - the type identifier of a #GEnumClass type + the type identifier of a #GEnumClass type - the value + the value - The GLib type system provides fundamental types for enumeration and + The GLib type system provides fundamental types for enumeration and flags types. (Flags types are like enumerations, but allow their values to be combined by bitwise or). A registered enumeration or flags type associates a name and a nickname with each allowed @@ -19757,11 +14002,8 @@ g_print ("Name: %s\n", enum_value->value_name); g_type_class_unref (enum_class); ]| - - This function is meant to be called from the complete_type_info() + + This function is meant to be called from the complete_type_info() function of a #GTypePlugin implementation, see the example for g_enum_complete_type_info() above. @@ -19770,186 +14012,130 @@ g_enum_complete_type_info() above. - the type identifier of the type being completed + the type identifier of the type being completed - - the #GTypeInfo struct to be filled in + + the #GTypeInfo struct to be filled in - An array of #GFlagsValue structs for the possible + An array of #GFlagsValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. - - Returns the first #GFlagsValue which is set in @value. + + Returns the first #GFlagsValue which is set in @value. - - the first #GFlagsValue which is set in + + the first #GFlagsValue which is set in @value, or %NULL if none is set - a #GFlagsClass + a #GFlagsClass - the value + the value - - Looks up a #GFlagsValue by name. + + Looks up a #GFlagsValue by name. - - the #GFlagsValue with name @name, + + the #GFlagsValue with name @name, or %NULL if there is no flag with that name - a #GFlagsClass + a #GFlagsClass - the name to look up + the name to look up - - Looks up a #GFlagsValue by nickname. + + Looks up a #GFlagsValue by nickname. - - the #GFlagsValue with nickname @nick, + + the #GFlagsValue with nickname @nick, or %NULL if there is no flag with that nickname - a #GFlagsClass + a #GFlagsClass - the nickname to look up + the nickname to look up - - Registers a new static flags type with the name @name. + + Registers a new static flags type with the name @name. It is normally more convenient to let [glib-mkenums][glib-mkenums] generate a my_flags_get_type() function from a usual C enumeration definition than to write one yourself using g_flags_register_static(). - The new type identifier. + The new type identifier. - A nul-terminated string used as the name of the new type. + A nul-terminated string used as the name of the new type. - An array of #GFlagsValue structs for the possible + An array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0. GObject keeps a reference to the data, so it cannot be stack-allocated. - - Pretty-prints @value in the form of the flag names separated by ` | ` and + + Pretty-prints @value in the form of the flag names separated by ` | ` and sorted. Any extra bits will be shown at the end as a hexadecimal number. This is intended to be used for debugging purposes. The format of the output may change in the future. - a newly-allocated text string + a newly-allocated text string - the type identifier of a #GFlagsClass type + the type identifier of a #GFlagsClass type - the value + the value - #GBoxed is a generic wrapper mechanism for arbitrary C structures. The only -thing the type system needs to know about the structures is how to copy them -(a #GBoxedCopyFunc) and how to free them (a #GBoxedFreeFunc) — beyond that -they are treated as opaque chunks of memory. + #GBoxed is a generic wrapper mechanism for arbitrary C structures. + +The only thing the type system needs to know about the structures is how to +copy them (a #GBoxedCopyFunc) and how to free them (a #GBoxedFreeFunc); +beyond that, they are treated as opaque chunks of memory. Boxed types are useful for simple value-holder structures like rectangles or points. They can also be used for wrapping structures defined in non-#GObject @@ -19961,20 +14147,23 @@ In turn, this allows any type which can be boxed to be set as the data in a types, and hence usage of such types as #GObject property values. #GBoxed is designed so that reference counted types can be boxed. Use the -type’s ‘ref’ function as the #GBoxedCopyFunc, and its ‘unref’ function as the +type’s ‘ref’ function as the #GBoxedCopyFunc, and its ‘unref’ function as the #GBoxedFreeFunc. For example, for #GBytes, the #GBoxedCopyFunc is g_bytes_ref(), and the #GBoxedFreeFunc is g_bytes_unref(). - The #GValue structure is basically a variable container that consists + The #GValue structure is basically a variable container that consists of a type identifier and a specific value of that type. + The type identifier within a #GValue structure always determines the type of the associated value. + To create an undefined #GValue structure, simply create a zero-filled #GValue structure. To initialize the #GValue, use the g_value_init() -function. A #GValue cannot be used until it is initialized. +function. A #GValue cannot be used until it is initialized. Before +destruction you must always use g_value_unset() to make sure allocated +memory is freed. + The basic type operations (such as freeing and copying) are determined by the #GTypeValueTable associated with the type ID stored in the #GValue. Other #GValue operations (such as converting values between types) are @@ -20036,12 +14225,38 @@ main (int argc, g_printf ("%s\n", g_value_get_string (&b)); return 0; } +]| + +See also [gobject-Standard-Parameter-and-Value-Types] for more information on +validation of #GValue. + +For letting a #GValue own (and memory manage) arbitrary types or pointers, +they need to become a [boxed type][gboxed]. The example below shows how +the pointer `mystruct` of type `MyStruct` is used as a [boxed type][gboxed]. + +|[<!-- language="C" --> +typedef struct { ... } MyStruct; +G_DEFINE_BOXED_TYPE (MyStruct, my_struct, my_struct_copy, my_struct_free) + +// These two lines normally go in a public header. By GObject convention, +// the naming scheme is NAMESPACE_TYPE_NAME: +#define MY_TYPE_STRUCT (my_struct_get_type ()) +GType my_struct_get_type (void); + +void +foo () +{ + GValue *value = g_new0 (GValue, 1); + g_value_init (value, MY_TYPE_STRUCT); + g_value_set_boxed (value, mystruct); + // [... your code ....] + g_value_unset (value); + g_value_free (value); +} ]| - The GType API is the foundation of the GObject system. It provides the + The GType API is the foundation of the GObject system. It provides the facilities for registering and managing all fundamental data types, user-defined object and interface types. @@ -20076,8 +14291,8 @@ to the buffer in the structure. As mentioned in the [GType conventions][gtype-conventions], type names must be at least three characters long. There is no upper length limit. The first -character must be a letter (a–z or A–Z) or an underscore (‘_’). Subsequent -characters can be letters, numbers or any of ‘-_+’. +character must be a letter (a–z or A–Z) or an underscore (‘_’). Subsequent +characters can be letters, numbers or any of ‘-_+’. @@ -20086,9 +14301,7 @@ characters can be letters, numbers or any of ‘-_+’. - GObject is the fundamental type providing the common attributes and + GObject is the fundamental type providing the common attributes and methods for all object types in GTK+, Pango and other libraries based on GObject. The GObject class provides methods for object construction and destruction, property access methods, and signal @@ -20097,8 +14310,8 @@ support. Signals are described in detail [here][gobject-Signals]. For a tutorial on implementing a new GObject class, see [How to define and implement a new GObject][howto-gobject]. For a list of naming conventions for GObjects and their methods, see the [GType conventions][gtype-conventions]. -For the high-level concepts behind GObject, read [Instantiable classed types: -Objects][gtype-instantiable-classed]. +For the high-level concepts behind GObject, read [Instantiatable classed types: +Objects][gtype-instantiatable-classed]. ## Floating references # {#floating-ref} @@ -20115,15 +14328,18 @@ as a "floating" reference. This means that it is not specifically claimed to be "owned" by any code portion. The main motivation for providing floating references is C convenience. In particular, it allows code to be written as: + |[<!-- language="C" --> container = create_container (); container_add_child (container, create_child()); ]| + If container_add_child() calls g_object_ref_sink() on the passed-in child, no reference of the newly created child is leaked. Without floating references, container_add_child() can only g_object_ref() the new child, so to implement this code without reference leaks, it would have to be written as: + |[<!-- language="C" --> Child *child; container = create_container (); @@ -20131,6 +14347,7 @@ child = create_child (); container_add_child (container, child); g_object_unref (child); ]| + The floating reference can be converted into an ordinary reference by calling g_object_ref_sink(). For already sunken objects (objects that don't have a floating reference anymore), g_object_ref_sink() is equivalent @@ -20177,1373 +14394,934 @@ else ]| - Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN + Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN property. In many cases, it may be more appropriate to use an enum with g_param_spec_enum(), both to improve code clarity by using explicitly named values, and to allow for more values to be added in future without breaking API. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED + Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED derived property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - %G_TYPE_BOXED derived type of this property + %G_TYPE_BOXED derived type of this property - flags for the property specified + flags for the property specified - Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property. - + Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property. + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE + Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM + Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GType derived from %G_TYPE_ENUM + a #GType derived from %G_TYPE_ENUM - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS + Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GType derived from %G_TYPE_FLAGS + a #GType derived from %G_TYPE_FLAGS - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. + Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - - Creates a new #GParamSpecGType instance specifying a + + Creates a new #GParamSpecGType instance specifying a %G_TYPE_GTYPE property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GType whose subtypes are allowed as values + a #GType whose subtypes are allowed as values of the property (use %G_TYPE_NONE for any type) - flags for the property specified + flags for the property specified - Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. + Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property. + Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. + Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT + Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT derived property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - %G_TYPE_OBJECT derived type of this property + %G_TYPE_OBJECT derived type of this property - flags for the property specified + flags for the property specified - - Creates a new property of type #GParamSpecOverride. This is used + + Creates a new property of type #GParamSpecOverride. This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject. - + - the newly created #GParamSpec + the newly created #GParamSpec - the name of the property. + the name of the property. - The property that is being overridden + The property that is being overridden - Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM + Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GType derived from %G_TYPE_PARAM + a #GType derived from %G_TYPE_PARAM - flags for the property specified + flags for the property specified - Creates a new #GParamSpecPointer instance specifying a pointer property. + Creates a new #GParamSpecPointer instance specifying a pointer property. Where possible, it is better to use g_param_spec_object() or g_param_spec_boxed() to expose memory management information. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - flags for the property specified + flags for the property specified - - Creates a new #GParamSpecPool. - -If @type_prefixing is %TRUE, lookups in the newly created pool will -allow to specify the owner as a colon-separated prefix of the -property name, like "GtkContainer:border-width". This feature is -deprecated, so you should always set @type_prefixing to %FALSE. - - - a newly allocated #GParamSpecPool. - - - - - Whether the pool will support type-prefixed property names. - - - - - Creates a new #GParamSpecString instance. + Creates a new #GParamSpecString instance. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - - default value for the property specified + + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property. - + Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property. + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. + Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64 + Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64 property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG + Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT + Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT property. #GValue structures for this property can be accessed with g_value_set_uint() and g_value_get_uint(). See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - - Creates a new #GParamSpecValueArray instance specifying a + + Creates a new #GParamSpecValueArray instance specifying a %G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED type, as such, #GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed(). See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GParamSpec describing the elements contained in + a #GParamSpec describing the elements contained in arrays of this property, may be %NULL - flags for the property specified + flags for the property specified - - Creates a new #GParamSpecVariant instance specifying a #GVariant + + Creates a new #GParamSpecVariant instance specifying a #GVariant property. If @default_value is floating, it is consumed. See g_param_spec_internal() for details on property names. - + - the newly created #GParamSpec + the newly created #GParamSpec - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GVariantType + a #GVariantType - - a #GVariant of type @type to + + a #GVariant of type @type to use as the default value, or %NULL - flags for the property specified + flags for the property specified - - Registers @name as the name of a new static type derived from -#G_TYPE_PARAM. The type system uses the information contained in -the #GParamSpecTypeInfo structure pointed to by @info to manage the -#GParamSpec type and its instances. - + + Registers @name as the name of a new static type derived +from #G_TYPE_PARAM. + +The type system uses the information contained in the #GParamSpecTypeInfo +structure pointed to by @info to manage the #GParamSpec type and its +instances. + - The new type identifier. + The new type identifier. - 0-terminated string used as the name of the new #GParamSpec type. + 0-terminated string used as the name of the new #GParamSpec type. - The #GParamSpecTypeInfo for this #GParamSpec type. + The #GParamSpecTypeInfo for this #GParamSpec type. - Transforms @src_value into @dest_value if possible, and then + Transforms @src_value into @dest_value if possible, and then validates @dest_value, in order for it to conform to @pspec. If @strict_validation is %TRUE this function will only succeed if the transformed @dest_value complied to @pspec without modifications. See also g_value_type_transformable(), g_value_transform() and g_param_value_validate(). - + - %TRUE if transformation and validation were successful, + %TRUE if transformation and validation were successful, %FALSE otherwise and @dest_value is left untouched. - a valid #GParamSpec + a valid #GParamSpec - source #GValue + source #GValue - destination #GValue of correct type for @pspec + destination #GValue of correct type for @pspec - %TRUE requires @dest_value to conform to @pspec + %TRUE requires @dest_value to conform to @pspec without modifications - - Checks whether @value contains the default value as specified in @pspec. - + + Checks whether @value contains the default value as specified in @pspec. + - whether @value contains the canonical default for this @pspec + whether @value contains the canonical default for this @pspec - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - - Sets @value to its default value as specified in @pspec. - + + Sets @value to its default value as specified in @pspec. + - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec; since 2.64, you + a #GValue of correct type for @pspec; since 2.64, you can also pass an empty #GValue, initialized with %G_VALUE_INIT - #GValue provides an abstract container structure which can be + #GValue provides an abstract container structure which can be copied, transformed and compared while holding a value of any (derived) type, which is registered as a #GType with a #GTypeValueTable in its #GTypeInfo structure. Parameter @@ -21553,108 +15331,80 @@ operate on #GValue containers. Parameter names need to start with a letter (a-z or A-Z). Subsequent characters can be letters, numbers or a '-'. -All other characters are replaced by a '-' during construction. +All other characters are replaced by a '-' during construction. + +See also #GValue for more information. - - Ensures that the contents of @value comply with the specifications + + Ensures that the contents of @value comply with the specifications set out by @pspec. For example, a #GParamSpecInt might require that integers stored in @value may not be smaller than -42 and not be greater than +42. If @value contains an integer outside of this range, it is modified accordingly, so the resulting value will fit into the range -42 .. +42. - + - whether modifying @value was necessary to ensure validity + whether modifying @value was necessary to ensure validity - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, + Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, if @value1 is found to be less than, equal to or greater than @value2, respectively. - + - -1, 0 or +1, for a less than, equal to or greater than result + -1, 0 or +1, for a less than, equal to or greater than result - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - - Creates a new %G_TYPE_POINTER derived type id for a new + + Creates a new %G_TYPE_POINTER derived type id for a new pointer type with name @name. - a new %G_TYPE_POINTER derived type id for @name. + a new %G_TYPE_POINTER derived type id for @name. - the name of the new pointer type. + the name of the new pointer type. - - Updates a #GObject pointer to refer to @new_object. It increments the -reference count of @new_object (if non-%NULL), decrements the reference -count of the current value of @object_ptr (if non-%NULL), and assigns -@new_object to @object_ptr. The assignment is not atomic. + + Updates a #GObject pointer to refer to @new_object. -@object_ptr must not be %NULL. +It increments the reference count of @new_object (if non-%NULL), decrements +the reference count of the current value of @object_ptr (if non-%NULL), and +assigns @new_object to @object_ptr. The assignment is not atomic. + +@object_ptr must not be %NULL, but can point to a %NULL value. A macro is also included that allows this function to be used without pointer casts. The function itself is static inline, so its address may vary @@ -21673,34 +15423,27 @@ One convenient usage of this function is in implementing property setters: g_object_notify (foo, "bar"); } ]| - + - a pointer to a #GObject reference + a pointer to a #GObject reference - a pointer to the new #GObject to - assign to it, or %NULL to clear the pointer + a pointer to the new #GObject to + assign to @object_ptr, or %NULL to clear the pointer - - Updates a pointer to weakly refer to @new_object. It assigns @new_object -to @weak_pointer_location and ensures that @weak_pointer_location will -automatically be set to %NULL if @new_object gets destroyed. The assignment -is not atomic. The weak reference is not thread-safe, see -g_object_add_weak_pointer() for details. + + Updates a pointer to weakly refer to @new_object. -@weak_pointer_location must not be %NULL. +It assigns @new_object to @weak_pointer_location and ensures +that @weak_pointer_location will automatically be set to %NULL +if @new_object gets destroyed. The assignment is not atomic. +The weak reference is not thread-safe, see g_object_add_weak_pointer() +for details. + +The @weak_pointer_location argument must not be %NULL. A macro is also included that allows this function to be used without pointer casts. The function itself is static inline, so its address may vary @@ -21719,27 +15462,19 @@ One convenient usage of this function is in implementing property setters: g_object_notify (foo, "bar"); } ]| - + - the memory address of a pointer + the memory address of a pointer - a pointer to the new #GObject to + a pointer to the new #GObject to assign to it, or %NULL to clear the pointer - - A predefined #GSignalAccumulator for signals intended to be used as a + + A predefined #GSignalAccumulator for signals intended to be used as a hook for application code to provide a particular value. Usually only one such value is desired and multiple handlers for the same signal don't make much sense (except for the case of the default @@ -21749,163 +15484,106 @@ usually want the signal connection to override the class handler). This accumulator will use the return value from the first signal handler that is run as the return value for the signal and not run any further handlers (ie: the first handler "wins"). - + - standard #GSignalAccumulator result + standard #GSignalAccumulator result - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - - standard #GSignalAccumulator parameter + + standard #GSignalAccumulator parameter - - A predefined #GSignalAccumulator for signals that return a + + A predefined #GSignalAccumulator for signals that return a boolean values. The behavior that this accumulator gives is that a return of %TRUE stops the signal emission: no further callbacks will be invoked, while a return of %FALSE allows the emission to continue. The idea here is that a %TRUE return indicates that the callback handled the signal, and no further handling is needed. - + - standard #GSignalAccumulator result + standard #GSignalAccumulator result - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - - standard #GSignalAccumulator parameter + + standard #GSignalAccumulator parameter - - Adds an emission hook for a signal, which will get called for any emission + + Adds an emission hook for a signal, which will get called for any emission of that signal, independent of the instance. This is possible only for signals which don't have #G_SIGNAL_NO_HOOKS flag set. - + - the hook id, for later use with g_signal_remove_emission_hook(). + the hook id, for later use with g_signal_remove_emission_hook(). - the signal identifier, as returned by g_signal_lookup(). + the signal identifier, as returned by g_signal_lookup(). - the detail on which to call the hook. + the detail on which to call the hook. - - a #GSignalEmissionHook function. + + a #GSignalEmissionHook function. - - user data for @hook_func. + + user data for @hook_func. - - a #GDestroyNotify for @hook_data. + + a #GDestroyNotify for @hook_data. - - Calls the original class closure of a signal. This function should only + + Calls the original class closure of a signal. This function should only be called from an overridden class closure; see g_signal_override_class_closure() and g_signal_override_class_handler(). - + - the argument list of the signal emission. + the argument list of the signal emission. The first element in the array is a #GValue for the instance the signal is being emitted on. The rest are any arguments to be passed to the signal. @@ -21913,263 +15591,175 @@ g_signal_override_class_handler(). - Location for the return value. + Location for the return value. - - Calls the original class closure of a signal. This function should + + Calls the original class closure of a signal. This function should only be called from an overridden class closure; see g_signal_override_class_closure() and g_signal_override_class_handler(). - + - the instance the signal is being + the instance the signal is being emitted on. - parameters to be passed to the parent class closure, followed by a + parameters to be passed to the parent class closure, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. - - Connects a #GCallback function to a signal for a particular object. + + Connects a #GCallback function to a signal for a particular object. The handler will be called before the default handler of the signal. See [memory management of signal handlers][signal-memory-management] for details on how to handle the return value and memory management of @data. - - - - the instance to connect to. - - - a string of the form "signal-name::detail". - - - the #GCallback to connect. - - - data to pass to @c_handler calls. - - - - - Connects a #GCallback function to a signal for a particular object. - -The handler will be called after the default handler of the signal. - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the #GCallback to connect. + the #GCallback to connect. - data to pass to @c_handler calls. + data to pass to @c_handler calls. - - Connects a closure to a signal for a particular object. - + + Connects a #GCallback function to a signal for a particular object. + +The handler will be called after the default handler of the signal. + + + + the instance to connect to. + + + a string of the form "signal-name::detail". + + + the #GCallback to connect. + + + data to pass to @c_handler calls. + + + + + Connects a closure to a signal for a particular object. + - the handler ID (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the closure to connect. + the closure to connect. - whether the handler should be called before or after the + whether the handler should be called before or after the default handler of the signal. - - Connects a closure to a signal for a particular object. - + + Connects a closure to a signal for a particular object. + - the handler ID (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) - the instance to connect to. + the instance to connect to. - the id of the signal. + the id of the signal. - the detail. + the detail. - the closure to connect. + the closure to connect. - whether the handler should be called before or after the + whether the handler should be called before or after the default handler of the signal. - - Connects a #GCallback function to a signal for a particular object. Similar + + Connects a #GCallback function to a signal for a particular object. Similar to g_signal_connect(), but allows to provide a #GClosureNotify for the data which will be called when the signal handler is disconnected and no longer used. Specify @connect_flags if you need `..._after()` or `..._swapped()` variants of this function. - + - the handler ID (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the #GCallback to connect. + the #GCallback to connect. - - data to pass to @c_handler calls. + + data to pass to @c_handler calls. - - a #GClosureNotify for @data. + + a #GClosureNotify for @data. - a combination of #GConnectFlags. + a combination of #GConnectFlags. - - This is similar to g_signal_connect_data(), but uses a closure which + + This is similar to g_signal_connect_data(), but uses a closure which ensures that the @gobject stays alive during the call to @c_handler by temporarily adding a reference count to @gobject. @@ -22177,56 +15767,37 @@ When the @gobject is destroyed the signal handler will be automatically disconnected. Note that this is not currently threadsafe (ie: emitting a signal while @gobject is being destroyed in another thread is not safe). - + - the handler id. + the handler id. - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the #GCallback to connect. + the #GCallback to connect. - - the object to pass as data + + the object to pass as data to @c_handler. - a combination of #GConnectFlags. + a combination of #GConnectFlags. - - Connects a #GCallback function to a signal for a particular object. + + Connects a #GCallback function to a signal for a particular object. The instance on which the signal is emitted and @data will be swapped when calling the handler. This is useful when calling pre-existing functions to @@ -22252,145 +15823,104 @@ button_clicked_cb (GtkButton *button, GtkWidget *other_widget) g_signal_connect (button, "clicked", (GCallback) button_clicked_cb, other_widget); ]| - + - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the #GCallback to connect. + the #GCallback to connect. - data to pass to @c_handler calls. + data to pass to @c_handler calls. - - Emits a signal. + + Emits a signal. Note that g_signal_emit() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). - + - the instance the signal is being emitted on. + the instance the signal is being emitted on. - the signal id + the signal id - the detail + the detail - parameters to be passed to the signal, followed by a + parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. - - Emits a signal. + + Emits a signal. Note that g_signal_emit_by_name() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). - + - the instance the signal is being emitted on. + the instance the signal is being emitted on. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - parameters to be passed to the signal, followed by a + parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal - is #G_TYPE_NONE, the return value location can be omitted. + is %G_TYPE_NONE, the return value location can be omitted. The + number of parameters to pass to this function is defined when creating the signal. - - Emits a signal. + + Emits a signal. Note that g_signal_emit_valist() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). - + - the instance the signal is being + the instance the signal is being emitted on. - the signal id + the signal id - the detail + the detail - a list of parameters to be passed to the signal, followed by a + a list of parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. @@ -22398,21 +15928,17 @@ if no handlers are connected, in contrast to g_signal_emitv(). - Emits a signal. + Emits a signal. Note that g_signal_emitv() doesn't change @return_value if no handlers are connected, in contrast to g_signal_emit() and g_signal_emit_valist(). - + - argument list for the signal emission. + argument list for the signal emission. The first element in the array is a #GValue for the instance the signal is being emitted on. The rest are any arguments to be passed to the signal. @@ -22420,57 +15946,38 @@ connected, in contrast to g_signal_emit() and g_signal_emit_valist(). - the signal id + the signal id - the detail + the detail - - Location to + + Location to store the return value of the signal emission. This must be provided if the specified signal returns a value, but may be ignored otherwise. - - Returns the invocation hint of the innermost signal emission of instance. - - - the invocation hint of the innermost signal emission. + + Returns the invocation hint of the innermost signal emission of instance. + + + the invocation hint of the innermost + signal emission, or %NULL if not found. - the instance to query + the instance to query - - Blocks a handler of an instance so it will not be called during any + + Blocks a handler of an instance so it will not be called during any signal emissions unless it is unblocked again. Thus "blocking" a signal handler means to temporarily deactivate it, a signal handler has to be unblocked exactly the same amount of times it has been @@ -22478,156 +15985,106 @@ blocked before to become active again. The @handler_id has to be a valid signal handler id, connected to a signal of @instance. - + - The instance to block the signal handler of. + The instance to block the signal handler of. - Handler id of the handler to be blocked. + Handler id of the handler to be blocked. - - Disconnects a handler from an instance so it will not be called during + + Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id becomes invalid and may be reused. The @handler_id has to be a valid signal handler id, connected to a signal of @instance. - + - The instance to remove the signal handler from. + The instance to remove the signal handler from. - Handler id of the handler to be disconnected. + Handler id of the handler to be disconnected. - Finds the first signal handler that matches certain selection criteria. + Finds the first signal handler that matches certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. The match @mask has to be non-0 for successful matches. If no handler was found, 0 is returned. - + - A valid non-0 signal handler id for a successful match. + A valid non-0 signal handler id for a successful match. - The instance owning the signal handler to be found. + The instance owning the signal handler to be found. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handler has to match. - Signal the handler has to be connected to. + Signal the handler has to be connected to. - Signal detail the handler has to be connected to. + Signal detail the handler has to be connected to. - - The closure the handler will invoke. + + The closure the handler will invoke. - - The C closure callback of the handler (useless for non-C closures). + + The C closure callback of the handler (useless for non-C closures). - - The closure data of the handler's closure. + + The closure data of the handler's closure. - - Returns whether @handler_id is the ID of a handler connected to @instance. - + + Returns whether @handler_id is the ID of a handler connected to @instance. + - whether @handler_id identifies a handler connected to @instance. + whether @handler_id identifies a handler connected to @instance. - The instance where a signal handler is sought. + The instance where a signal handler is sought. - the handler ID. + the handler ID. - - Undoes the effect of a previous g_signal_handler_block() call. A + + Undoes the effect of a previous g_signal_handler_block() call. A blocked handler is skipped during signal emissions and will not be invoked, unblocking it (for exactly the amount of times it has been blocked before) reverts its "blocked" state, so the handler will be @@ -22640,194 +16097,125 @@ proceeded yet). The @handler_id has to be a valid id of a signal handler that is connected to a signal of @instance and is currently blocked. - + - The instance to unblock the signal handler of. + The instance to unblock the signal handler of. - Handler id of the handler to be unblocked. + Handler id of the handler to be unblocked. - - Blocks all handlers on an instance that match @func and @data. - + + Blocks all handlers on an instance that match @func and @data. + - The instance to block handlers from. + The instance to block handlers from. - The C closure callback of the handlers (useless for non-C closures). + The C closure callback of the handlers (useless for non-C closures). - The closure data of the handlers' closures. + The closure data of the handlers' closures. - - Blocks all handlers on an instance that match a certain selection criteria. + + Blocks all handlers on an instance that match a certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or %G_SIGNAL_MATCH_DATA match flags is required for successful matches. If no handlers were found, 0 is returned, the number of blocked handlers otherwise. - + - The number of handlers that matched. + The number of handlers that matched. - The instance to block handlers from. + The instance to block handlers from. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. - Signal the handlers have to be connected to. + Signal the handlers have to be connected to. - Signal detail the handlers have to be connected to. + Signal detail the handlers have to be connected to. - - The closure the handlers will invoke. + + The closure the handlers will invoke. - - The C closure callback of the handlers (useless for non-C closures). + + The C closure callback of the handlers (useless for non-C closures). - - The closure data of the handlers' closures. + + The closure data of the handlers' closures. - - Destroy all signal handlers of a type instance. This function is + + Destroy all signal handlers of a type instance. This function is an implementation detail of the #GObject dispose implementation, and should not be used outside of the type system. - + - The instance whose signal handlers are destroyed + The instance whose signal handlers are destroyed - - Disconnects all handlers on an instance that match @data. - + + Disconnects all handlers on an instance that match @data. + - The instance to remove handlers from + The instance to remove handlers from - the closure data of the handlers' closures + the closure data of the handlers' closures - - Disconnects all handlers on an instance that match @func and @data. - + + Disconnects all handlers on an instance that match @func and @data. + - The instance to remove handlers from. + The instance to remove handlers from. - The C closure callback of the handlers (useless for non-C closures). + The C closure callback of the handlers (useless for non-C closures). - The closure data of the handlers' closures. + The closure data of the handlers' closures. - - Disconnects all handlers on an instance that match a certain + + Disconnects all handlers on an instance that match a certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. Passing at least one of the @@ -22835,98 +16223,60 @@ passed as arguments. Passing at least one of the %G_SIGNAL_MATCH_DATA match flags is required for successful matches. If no handlers were found, 0 is returned, the number of disconnected handlers otherwise. - + - The number of handlers that matched. + The number of handlers that matched. - The instance to remove handlers from. + The instance to remove handlers from. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. - Signal the handlers have to be connected to. + Signal the handlers have to be connected to. - Signal detail the handlers have to be connected to. + Signal detail the handlers have to be connected to. - - The closure the handlers will invoke. + + The closure the handlers will invoke. - - The C closure callback of the handlers (useless for non-C closures). + + The C closure callback of the handlers (useless for non-C closures). - - The closure data of the handlers' closures. + + The closure data of the handlers' closures. - - Unblocks all handlers on an instance that match @func and @data. - + + Unblocks all handlers on an instance that match @func and @data. + - The instance to unblock handlers from. + The instance to unblock handlers from. - The C closure callback of the handlers (useless for non-C closures). + The C closure callback of the handlers (useless for non-C closures). - The closure data of the handlers' closures. + The closure data of the handlers' closures. - - Unblocks all handlers on an instance that match a certain selection + + Unblocks all handlers on an instance that match a certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC @@ -22934,73 +16284,45 @@ or %G_SIGNAL_MATCH_DATA match flags is required for successful matches. If no handlers were found, 0 is returned, the number of unblocked handlers otherwise. The match criteria should not apply to any handlers that are not currently blocked. - + - The number of handlers that matched. + The number of handlers that matched. - The instance to unblock handlers from. + The instance to unblock handlers from. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. - Signal the handlers have to be connected to. + Signal the handlers have to be connected to. - Signal detail the handlers have to be connected to. + Signal detail the handlers have to be connected to. - - The closure the handlers will invoke. + + The closure the handlers will invoke. - - The C closure callback of the handlers (useless for non-C closures). + + The C closure callback of the handlers (useless for non-C closures). - - The closure data of the handlers' closures. + + The closure data of the handlers' closures. - - Returns whether there are any handlers connected to @instance for the + + Returns whether there are any handlers connected to @instance for the given signal id and detail. If @detail is 0 then it will only match handlers that were connected @@ -23016,105 +16338,74 @@ One example of when you might use this is when the arguments to the signal are difficult to compute. A class implementor may opt to not emit the signal if no one is attached anyway, thus saving the cost of building the arguments. - + - %TRUE if a handler is connected to the signal, %FALSE + %TRUE if a handler is connected to the signal, %FALSE otherwise. - the object whose signal handlers are sought. + the object whose signal handlers are sought. - the signal id. + the signal id. - the detail. + the detail. - whether blocked handlers should count as match. + whether blocked handlers should count as match. - - Validate a signal name. This can be useful for dynamically-generated signals + + Validate a signal name. This can be useful for dynamically-generated signals which need to be validated at run-time before actually trying to create them. See [canonical parameter names][canonical-parameter-names] for details of the rules for valid names. The rules for signal names are the same as those for property names. - + - %TRUE if @name is a valid signal name, %FALSE otherwise. + %TRUE if @name is a valid signal name, %FALSE otherwise. - the canonical name of the signal + the canonical name of the signal - Lists the signals by id that a certain instance or interface type + Lists the signals by id that a certain instance or interface type created. Further information about the signals can be acquired through g_signal_query(). - + - Newly allocated array of signal IDs. + Newly allocated array of signal IDs. - Instance or interface type. + Instance or interface type. - - Location to store the number of signal ids for @itype. + + Location to store the number of signal ids for @itype. - Given the name of the signal and the type of object it connects to, gets + Given the name of the signal and the type of object it connects to, gets the signal's identifying integer. Emitting the signal by number is somewhat faster than using the name each time. @@ -23125,54 +16416,40 @@ example, using g_type_class_ref()) for this function to work, as signals are always installed during class initialization. See g_signal_new() for details on allowed signal names. - + - the signal's identifying number, or 0 if no signal was found. + the signal's identifying number, or 0 if no signal was found. - the signal's name. + the signal's name. - the type that the signal operates on. + the type that the signal operates on. - Given the signal's identifier, finds its name. + Given the signal's identifier, finds its name. Two different signals may have the same name, if they have differing types. - - - the signal name, or %NULL if the signal number was invalid. + + + the signal name, or %NULL if the signal number was invalid. - the signal's identifying number. + the signal's identifying number. - Creates a new signal. (This is usually done in the class initializer.) + Creates a new signal. (This is usually done in the class initializer.) A signal name consists of segments consisting of ASCII letters and digits, separated by either the `-` or `_` character. The first @@ -23196,96 +16473,63 @@ instead of g_cclosure_marshal_generic(). If @c_marshaller is non-%NULL, you need to also specify a va_marshaller using g_signal_set_va_marshaller() or the generic va_marshaller will be used. - + - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type. - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. - The offset of the function pointer in the class structure + The offset of the function pointer in the class structure for this type. Used to invoke a class method generically. Pass 0 to not associate a class method slot with this signal. - - the accumulator for this signal; may be %NULL. + + the accumulator for this signal; may be %NULL. - - user data for the @accumulator. + + user data for the @accumulator. - - the function to translate arrays of parameter + + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value. - the number of parameter types to follow. + the number of parameter types to follow. - a list of types, one for each parameter. + a list of types, one for each parameter. - - Creates a new signal. (This is usually done in the class initializer.) + + Creates a new signal. (This is usually done in the class initializer.) This is a variant of g_signal_new() that takes a C callback instead of a class offset for the signal's class handler. This function @@ -23301,329 +16545,216 @@ See g_signal_new() for information about signal names. If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - + - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type. - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. - - a #GCallback which acts as class implementation of + + a #GCallback which acts as class implementation of this signal. Used to invoke a class method generically. Pass %NULL to not associate a class method with this signal. - - the accumulator for this signal; may be %NULL. + + the accumulator for this signal; may be %NULL. - - user data for the @accumulator. + + user data for the @accumulator. - - the function to translate arrays of parameter + + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value. - the number of parameter types to follow. + the number of parameter types to follow. - a list of types, one for each parameter. + a list of types, one for each parameter. - - Creates a new signal. (This is usually done in the class initializer.) + + Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - + - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type. - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. - - The closure to invoke on signal emission; may be %NULL. + + The closure to invoke on signal emission; may be %NULL. - - the accumulator for this signal; may be %NULL. + + the accumulator for this signal; may be %NULL. - - user data for the @accumulator. + + user data for the @accumulator. - - the function to translate arrays of parameter + + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value. - the number of parameter types in @args. + the number of parameter types in @args. - va_list of #GType, one for each parameter. + va_list of #GType, one for each parameter. - - Creates a new signal. (This is usually done in the class initializer.) + + Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - + - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST - - The closure to invoke on signal emission; + + The closure to invoke on signal emission; may be %NULL - - the accumulator for this signal; may be %NULL + + the accumulator for this signal; may be %NULL - - user data for the @accumulator + + user data for the @accumulator - - the function to translate arrays of + + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value - the length of @param_types + the length of @param_types - - an array of types, one for - each parameter + + an array of types, one for + each parameter (may be %NULL if @n_params is zero) - - Overrides the class closure (i.e. the default handler) for the given signal + + Overrides the class closure (i.e. the default handler) for the given signal for emissions on instances of @instance_type. @instance_type must be derived from the type to which the signal belongs. See g_signal_chain_from_overridden() and g_signal_chain_from_overridden_handler() for how to chain up to the parent class closure from inside the overridden one. - + - the signal id + the signal id - the instance type on which to override the class closure + the instance type on which to override the class closure for the signal. - the closure. + the closure. - - Overrides the class closure (i.e. the default handler) for the + + Overrides the class closure (i.e. the default handler) for the given signal for emissions on instances of @instance_type with callback @class_handler. @instance_type must be derived from the type to which the signal belongs. @@ -23631,271 +16762,192 @@ type to which the signal belongs. See g_signal_chain_from_overridden() and g_signal_chain_from_overridden_handler() for how to chain up to the parent class closure from inside the overridden one. - + - the name for the signal + the name for the signal - the instance type on which to override the class handler + the instance type on which to override the class handler for the signal. - the handler. + the handler. - Internal function to parse a signal name into its @signal_id + Internal function to parse a signal name into its @signal_id and @detail quark. - + - Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. + Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - The interface/instance type that introduced "signal-name". + The interface/instance type that introduced "signal-name". - - Location to store the signal id. + + Location to store the signal id. - - Location to store the detail quark. + + Location to store the detail quark. - %TRUE forces creation of a #GQuark for the detail. + %TRUE forces creation of a #GQuark for the detail. - Queries the signal system for in-depth information about a + Queries the signal system for in-depth information about a specific signal. This function will fill in a user-provided structure to hold signal-specific information. If an invalid signal id is passed in, the @signal_id member of the #GSignalQuery is 0. All members filled into the #GSignalQuery structure should be considered constant and have to be left untouched. - + - The signal id of the signal to query information for. + The signal id of the signal to query information for. - - A user provided structure that is + + A user provided structure that is filled in with constant values upon success. - - Deletes an emission hook. - + + Deletes an emission hook. + - the id of the signal + the id of the signal - the id of the emission hook, as returned by + the id of the emission hook, as returned by g_signal_add_emission_hook() - - Change the #GSignalCVaMarshaller used for a given signal. This is a + + Change the #GSignalCVaMarshaller used for a given signal. This is a specialised form of the marshaller that can often be used for the common case of a single connected signal handler and avoids the overhead of #GValue. Its use is optional. - + - the signal id + the signal id - the instance type on which to set the marshaller. + the instance type on which to set the marshaller. - the marshaller to set. + the marshaller to set. - - Stops a signal's current emission. + + Stops a signal's current emission. This will prevent the default method from running, if the signal was %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after" flag). Prints a warning if used on a signal which isn't being emitted. - + - the object whose signal handlers you wish to stop. + the object whose signal handlers you wish to stop. - the signal identifier, as returned by g_signal_lookup(). + the signal identifier, as returned by g_signal_lookup(). - the detail which the signal was emitted with. + the detail which the signal was emitted with. - - Stops a signal's current emission. + + Stops a signal's current emission. This is just like g_signal_stop_emission() except it will look up the signal id for you. - + - the object whose signal handlers you wish to stop. + the object whose signal handlers you wish to stop. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - - Creates a new closure which invokes the function found at the offset + + Creates a new closure which invokes the function found at the offset @struct_offset in the class structure of the interface or classed type identified by @itype. - + - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - the #GType identifier of an interface or classed type + the #GType identifier of an interface or classed type - the offset of the member function of @itype's class + the offset of the member function of @itype's class structure which is to be invoked by the new closure - The basic concept of the signal system is that of the emission + The basic concept of the signal system is that of the emission of a signal. Signals are introduced per-type and are identified through strings. Signals introduced for a parent type are available in derived types as well, so basically they are a per-type facility @@ -23981,9 +17033,7 @@ effective memory leaks of the user data if the signal handler is never disconnected for some reason. - Set the callback for a source as a #GClosure. + Set the callback for a source as a #GClosure. If the source is not one of the standard GLib types, the @closure_callback and @closure_marshal fields of the #GSourceFuncs structure must have been @@ -23994,24 +17044,17 @@ filled in with pointers to appropriate functions. - the source + the source - a #GClosure + a #GClosure - - Sets a dummy callback for @source. The callback will do nothing, and + + Sets a dummy callback for @source. The callback will do nothing, and if the source expects a #gboolean return value, it will return %TRUE. (If the source expects any other type of return value, it will return a 0/%NULL value; whatever g_value_init() initializes a #GValue to for @@ -24027,77 +17070,53 @@ functions. - the source + the source - - Return a newly allocated string, which describes the contents of a + + Return a newly allocated string, which describes the contents of a #GValue. The main purpose of this function is to describe #GValue contents for debugging output, the way in which the contents are described may change between different GLib versions. - Newly allocated string. + Newly allocated string. - #GValue which contents are to be described. + #GValue which contents are to be described. - - Adds a #GTypeClassCacheFunc to be called before the reference count of a + + Adds a #GTypeClassCacheFunc to be called before the reference count of a class goes from one to zero. This can be used to prevent premature class destruction. All installed #GTypeClassCacheFunc functions will be chained until one of them returns %TRUE. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain. - + - - data to be passed to @cache_func + + data to be passed to @cache_func - a #GTypeClassCacheFunc + a #GTypeClassCacheFunc - - Registers a private class structure for a classed type; + + Registers a private class structure for a classed type; when the class is allocated, the private structures for the class and all of its parent types are allocated sequentially in the same memory block as the public @@ -24107,28 +17126,23 @@ This function should be called in the type's get_type() function after the type is registered. The private structure can be retrieved using the G_TYPE_CLASS_GET_PRIVATE() macro. - + - GType of a classed type + GType of a classed type - size of private structure + size of private structure - - + + @@ -24141,13 +17155,8 @@ G_TYPE_CLASS_GET_PRIVATE() macro. - - Adds a function to be called after an interface vtable is + + Adds a function to be called after an interface vtable is initialized for any class (i.e. after the @interface_init member of #GInterfaceInfo has been called). @@ -24156,99 +17165,71 @@ that depends on the interfaces of a class. For instance, the implementation of #GObject uses this facility to check that an object implements all of the properties that are defined on its interfaces. - + - - data to pass to @check_func + + data to pass to @check_func - function to be called after each interface + function to be called after each interface is initialized - + - - Adds @interface_type to the dynamic @instantiable_type. The information + + Adds @interface_type to the dynamic @instance_type. The information contained in the #GTypePlugin structure pointed to by @plugin is used to manage the relationship. - + - #GType value of an instantiable type + #GType value of an instantiatable type - #GType value of an interface type + #GType value of an interface type - #GTypePlugin structure to retrieve the #GInterfaceInfo from + #GTypePlugin structure to retrieve the #GInterfaceInfo from - - Adds @interface_type to the static @instantiable_type. + + Adds @interface_type to the static @instance_type. The information contained in the #GInterfaceInfo structure pointed to by @info is used to manage the relationship. - + - #GType value of an instantiable type + #GType value of an instantiatable type - #GType value of an interface type + #GType value of an interface type - #GInterfaceInfo structure for this + #GInterfaceInfo structure for this (@instance_type, @interface_type) combination - - + + @@ -24261,9 +17242,8 @@ pointed to by @info is used to manage the relationship. - - + + @@ -24277,30 +17257,22 @@ pointed to by @info is used to manage the relationship. - Private helper function to aid implementation of the + Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE() macro. - + - %TRUE if @instance is valid, %FALSE otherwise + %TRUE if @instance is valid, %FALSE otherwise - a valid #GTypeInstance structure + a valid #GTypeInstance structure - - + + @@ -24313,9 +17285,8 @@ G_TYPE_CHECK_INSTANCE() macro. - - + + @@ -24328,9 +17299,8 @@ G_TYPE_CHECK_INSTANCE() macro. - - + + @@ -24343,9 +17313,8 @@ G_TYPE_CHECK_INSTANCE() macro. - - + + @@ -24356,7 +17325,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -24366,9 +17335,8 @@ G_TYPE_CHECK_INSTANCE() macro. - - + + @@ -24382,15 +17350,11 @@ G_TYPE_CHECK_INSTANCE() macro. - Return a newly allocated and 0-terminated array of type IDs, listing + Return a newly allocated and 0-terminated array of type IDs, listing the child types of @type. - + - Newly allocated + Newly allocated and 0-terminated array of child types, free with g_free() @@ -24398,37 +17362,23 @@ the child types of @type. - the parent type + the parent type - - location to store the length of + + location to store the length of the returned array, or %NULL - - + + - + @@ -24436,91 +17386,62 @@ the child types of @type. - - This function is essentially the same as g_type_class_ref(), + + This function is essentially the same as g_type_class_ref(), except that the classes reference count isn't incremented. As a consequence, this function may return %NULL if the class of the type passed in does not currently exist (hasn't been referenced before). - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist - type ID of a classed type + type ID of a classed type - - A more efficient version of g_type_class_peek() which works only for + + A more efficient version of g_type_class_peek() which works only for static types. - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist or is dynamically loaded - type ID of a classed type + type ID of a classed type - - Increments the reference count of the class structure belonging to + + Increments the reference count of the class structure belonging to @type. This function will demand-create the class if it doesn't exist already. - + - the #GTypeClass + the #GTypeClass structure for the given type ID - type ID of a classed type + type ID of a classed type - - Creates and initializes an instance of @type if @type is valid and + + Creates and initializes an instance of @type if @type is valid and can be instantiated. The type system only performs basic allocation and structure setups for instances: actual instance creation should happen through functions supplied by the type's fundamental type @@ -24536,54 +17457,38 @@ with zeros. Note: Do not use this function, unless you're implementing a fundamental type. Also language bindings should not use this function, but g_object_new() instead. - + - an allocated and initialized instance, subject to further + an allocated and initialized instance, subject to further treatment by the fundamental type implementation - an instantiatable type to create an instance for + an instantiatable type to create an instance for - - If the interface type @g_type is currently in use, returns its + + If the interface type @g_type is currently in use, returns its default interface vtable. - + - the default + the default vtable for the interface, or %NULL if the type is not currently in use - an interface type + an interface type - - Increments the reference count for the interface type @g_type, + + Increments the reference count for the interface type @g_type, and returns the default interface vtable for the type. If the type is not currently in use, then the default vtable @@ -24593,73 +17498,55 @@ the type (the @base_init and @class_init members of #GTypeInfo). Calling g_type_default_interface_ref() is useful when you want to make sure that signals and properties for an interface have been installed. - + - the default + the default vtable for the interface; call g_type_default_interface_unref() when you are done using the interface. - an interface type + an interface type - - Decrements the reference count for the type corresponding to the + + Decrements the reference count for the type corresponding to the interface default vtable @g_iface. If the type is dynamic, then when no one is using the interface and all references have been released, the finalize function for the interface's default vtable (the @class_finalize member of #GTypeInfo) will be called. - + - the default vtable + the default vtable structure for an interface, as returned by g_type_default_interface_ref() - Returns the length of the ancestry of the passed in type. This + Returns the length of the ancestry of the passed in type. This includes the type itself, so that e.g. a fundamental type has depth 1. - + - the depth of @type + the depth of @type - a #GType + a #GType - Ensures that the indicated @type has been registered with the + Ensures that the indicated @type has been registered with the type system, and its _class_init() method has been run. In theory, simply calling the type's _get_type() method (or using @@ -24671,343 +17558,264 @@ which _get_type() methods do on the first call). As a result, if you write a bare call to a _get_type() macro, it may get optimized out by the compiler. Using g_type_ensure() guarantees that the type's _get_type() method is called. - + - a #GType + a #GType - Frees an instance of a type, returning it to the instance pool for + Frees an instance of a type, returning it to the instance pool for the type, if there is one. Like g_type_create_instance(), this function is reserved for implementors of fundamental types. - + - an instance of a type + an instance of a type - Look up the type ID from a given type name, returning 0 if no type + Look up the type ID from a given type name, returning 0 if no type has been registered under this name (this is the preferred method to find out by name whether a specific type has been registered yet). - + - corresponding type ID or 0 + corresponding type ID or 0 - type name to look up + type name to look up - Internal function, used to extract the fundamental type ID portion. + Internal function, used to extract the fundamental type ID portion. Use G_TYPE_FUNDAMENTAL() instead. - + - fundamental type ID + fundamental type ID - valid type ID + valid type ID - - Returns the next free fundamental type id which can be used to + + Returns the next free fundamental type id which can be used to register a new fundamental type with g_type_register_fundamental(). The returned type ID represents the highest currently registered fundamental type identifier. - + - the next available fundamental type ID to be registered, + the next available fundamental type ID to be registered, or 0 if the type system ran out of fundamental type IDs - - Returns the number of instances allocated of the particular type; + + Returns the number of instances allocated of the particular type; this is only available if GLib is built with debugging support and the instance_count debug flag is set (by setting the GOBJECT_DEBUG variable to include instance-count). - + - the number of instances allocated of the given type; + the number of instances allocated of the given type; if instance counts are not available, returns 0. - a #GType + a #GType - Returns the #GTypePlugin structure for @type. - + Returns the #GTypePlugin structure for @type. + - the corresponding plugin + the corresponding plugin if @type is a dynamic type, %NULL otherwise - #GType to retrieve the plugin for + #GType to retrieve the plugin for - Obtains data which has previously been attached to @type + Obtains data which has previously been attached to @type with g_type_set_qdata(). Note that this does not take subtyping into account; data attached to one type with g_type_set_qdata() cannot be retrieved from a subtype using g_type_get_qdata(). - + - the data, or %NULL if no data was found + the data, or %NULL if no data was found - a #GType + a #GType - a #GQuark id to identify the data + a #GQuark id to identify the data - - Returns an opaque serial number that represents the state of the set + + Returns an opaque serial number that represents the state of the set of registered types. Any time a type is registered this serial changes, which means you can cache information based on type lookups (such as g_type_from_name()) and know if the cache is still valid at a later time by comparing the current serial with the one at the type lookup. - + - An unsigned int, representing the state of type registrations + An unsigned int, representing the state of type registrations - - This function used to initialise the type system. Since GLib 2.36, + + This function used to initialise the type system. Since GLib 2.36, the type system is initialised automatically and this function does nothing. the type system is now initialised automatically - + - - This function used to initialise the type system with debugging + + This function used to initialise the type system with debugging flags. Since GLib 2.36, the type system is initialised automatically and this function does nothing. If you need to enable debugging features, use the GOBJECT_DEBUG environment variable. the type system is now initialised automatically - + - bitwise combination of #GTypeDebugFlags values for + bitwise combination of #GTypeDebugFlags values for debugging purposes - - Adds @prerequisite_type to the list of prerequisites of @interface_type. + + Adds @prerequisite_type to the list of prerequisites of @interface_type. This means that any type implementing @interface_type must also implement @prerequisite_type. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type. - + - #GType value of an interface type + #GType value of an interface type - #GType value of an interface or instantiatable type + #GType value of an interface or instantiatable type - - Returns the #GTypePlugin structure for the dynamic interface + + Returns the #GTypePlugin structure for the dynamic interface @interface_type which has been added to @instance_type, or %NULL if @interface_type has not been added to @instance_type or does not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). - + - the #GTypePlugin for the dynamic + the #GTypePlugin for the dynamic interface @interface_type of @instance_type - #GType of an instantiatable type + #GType of an instantiatable type - #GType of an interface type + #GType of an interface type - - Returns the #GTypeInterface structure of an interface to which the -passed in class conforms. - + + Returns the most specific instantiatable prerequisite of an +interface type. If the interface type has no instantiatable +prerequisite, %G_TYPE_INVALID is returned. + +See g_type_interface_add_prerequisite() for more information +about prerequisites. + - the #GTypeInterface + the instantiatable prerequisite type or %G_TYPE_INVALID if none + + + + + an interface type + + + + + + Returns the #GTypeInterface structure of an interface to which the +passed in class conforms. + + + the #GTypeInterface structure of @iface_type if implemented by @instance_class, %NULL otherwise - a #GTypeClass structure + a #GTypeClass structure - an interface ID which this class conforms to + an interface ID which this class conforms to - - Returns the prerequisites of an interfaces type. - + + Returns the prerequisites of an interfaces type. + - a + a newly-allocated zero-terminated array of #GType containing the prerequisites of @interface_type @@ -25016,35 +17824,22 @@ passed in class conforms. - an interface type + an interface type - - location to return the number + + location to return the number of prerequisites, or %NULL - Return a newly allocated and 0-terminated array of type IDs, listing + Return a newly allocated and 0-terminated array of type IDs, listing the interface types that @type conforms to. - + - Newly allocated + Newly allocated and 0-terminated array of interface types, free with g_free() @@ -25052,81 +17847,57 @@ the interface types that @type conforms to. - the type to list interface types for + the type to list interface types for - - location to store the length of + + location to store the length of the returned array, or %NULL - If @is_a_type is a derivable type, check whether @type is a + If @is_a_type is a derivable type, check whether @type is a descendant of @is_a_type. If @is_a_type is an interface, check whether @type conforms to it. - + - %TRUE if @type is a @is_a_type + %TRUE if @type is a @is_a_type - type to check anchestry for + type to check ancestry for - possible anchestor of @type or interface that @type + possible ancestor of @type or interface that @type could conform to - Get the unique name that is assigned to a type ID. Note that this + Get the unique name that is assigned to a type ID. Note that this function (like all other GType API) cannot cope with invalid type IDs. %G_TYPE_INVALID may be passed to this function, as may be any other validly registered type ID, but randomized type IDs should not be passed in and will most likely lead to a crash. - + - static type name or %NULL + static type name or %NULL - type to return name for + type to return name for - - + + @@ -25136,9 +17907,8 @@ not be passed in and will most likely lead to a crash. - - + + @@ -25149,405 +17919,278 @@ not be passed in and will most likely lead to a crash. - Given a @leaf_type and a @root_type which is contained in its -anchestry, return the type that @root_type is the immediate parent + Given a @leaf_type and a @root_type which is contained in its +ancestry, return the type that @root_type is the immediate parent of. In other words, this function determines the type that is derived directly from @root_type which is also a base class of @leaf_type. Given a root type and a leaf type, this function can be used to determine the types and order in which the leaf type is descended from the root type. - + - immediate child of @root_type and anchestor of @leaf_type + immediate child of @root_type and ancestor of @leaf_type - descendant of @root_type and the type to be returned + descendant of @root_type and the type to be returned - immediate parent of the returned type + immediate parent of the returned type - Return the direct parent type of the passed in type. If the passed + Return the direct parent type of the passed in type. If the passed in type has no parent, i.e. is a fundamental type, 0 is returned. - + - the parent type + the parent type - the derived type + the derived type - Get the corresponding quark of the type IDs name. - + Get the corresponding quark of the type IDs name. + - the type names quark or 0 + the type names quark or 0 - type to return quark of type name for + type to return quark of type name for - Queries the type system for information about a specific type. + Queries the type system for information about a specific type. This function will fill in a user-provided structure to hold type-specific information. If an invalid #GType is passed in, the @type member of the #GTypeQuery is 0. All members filled into the #GTypeQuery structure should be considered constant and have to be left untouched. - + - #GType of a static, classed type + #GType of a static, classed type - - a user provided structure that is + + a user provided structure that is filled in with constant values upon success - - Registers @type_name as the name of a new dynamic type derived from + + Registers @type_name as the name of a new dynamic type derived from @parent_type. The type system uses the information contained in the #GTypePlugin structure pointed to by @plugin to manage the type and its instances (if not abstract). The value of @flags determines the nature (e.g. abstract or not) of the type. - + - the new type identifier or #G_TYPE_INVALID if registration failed + the new type identifier or #G_TYPE_INVALID if registration failed - type from which this type will be derived + type from which this type will be derived - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - #GTypePlugin structure to retrieve the #GTypeInfo from + #GTypePlugin structure to retrieve the #GTypeInfo from - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - - Registers @type_id as the predefined identifier and @type_name as the + + Registers @type_id as the predefined identifier and @type_name as the name of a fundamental type. If @type_id is already registered, or a type named @type_name is already registered, the behaviour is undefined. The type system uses the information contained in the #GTypeInfo structure pointed to by @info and the #GTypeFundamentalInfo structure pointed to by @finfo to manage the type and its instances. The value of @flags determines additional characteristics of the fundamental type. - + - the predefined type identifier + the predefined type identifier - a predefined type identifier + a predefined type identifier - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - #GTypeInfo structure for this type + #GTypeInfo structure for this type - #GTypeFundamentalInfo structure for this type - + #GTypeFundamentalInfo structure for this type + - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - - Registers @type_name as the name of a new static type derived from + + Registers @type_name as the name of a new static type derived from @parent_type. The type system uses the information contained in the #GTypeInfo structure pointed to by @info to manage the type and its instances (if not abstract). The value of @flags determines the nature (e.g. abstract or not) of the type. - + - the new type identifier + the new type identifier - type from which this type will be derived + type from which this type will be derived - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - #GTypeInfo structure for this type + #GTypeInfo structure for this type - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - - Registers @type_name as the name of a new static type derived from + + Registers @type_name as the name of a new static type derived from @parent_type. The value of @flags determines the nature (e.g. abstract or not) of the type. It works by filling a #GTypeInfo struct and calling g_type_register_static(). - + - the new type identifier + the new type identifier - type from which this type will be derived + type from which this type will be derived - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - size of the class structure (see #GTypeInfo) + size of the class structure (see #GTypeInfo) - location of the class initialization function (see #GTypeInfo) + location of the class initialization function (see #GTypeInfo) - size of the instance structure (see #GTypeInfo) + size of the instance structure (see #GTypeInfo) - location of the instance initialization function (see #GTypeInfo) + location of the instance initialization function (see #GTypeInfo) - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - - Removes a previously installed #GTypeClassCacheFunc. The cache + + Removes a previously installed #GTypeClassCacheFunc. The cache maintained by @cache_func has to be empty when calling g_type_remove_class_cache_func() to avoid leaks. - + - - data that was given when adding @cache_func + + data that was given when adding @cache_func - a #GTypeClassCacheFunc + a #GTypeClassCacheFunc - - Removes an interface check function added with + + Removes an interface check function added with g_type_add_interface_check(). - + - - callback data passed to g_type_add_interface_check() + + callback data passed to g_type_add_interface_check() - callback function passed to g_type_add_interface_check() - + callback function passed to g_type_add_interface_check() + - Attaches arbitrary data to a type. - + Attaches arbitrary data to a type. + - a #GType + a #GType - a #GQuark id to identify the data + a #GQuark id to identify the data - - the data + + the data - + @@ -25560,38 +18203,27 @@ g_type_add_interface_check(). - - Returns the location of the #GTypeValueTable associated with @type. + + Returns the location of the #GTypeValueTable associated with @type. Note that this function should only be used from source code that implements or has internal knowledge of the implementation of @type. - + - location of the #GTypeValueTable associated with @type or + location of the #GTypeValueTable associated with @type or %NULL if there is no #GTypeValueTable associated with @type - a #GType + a #GType - The prime purpose of a #GValueArray is for it to be used as an + The prime purpose of a #GValueArray is for it to be used as an object property that holds an array of values. A #GValueArray wraps an array of #GValue elements in order for it to be used as a boxed type through %G_TYPE_VALUE_ARRAY. @@ -25613,97 +18245,66 @@ can be replaced by: g_array_set_clear_func (array, (GDestroyNotify) g_value_unset); ]| - - Registers a value transformation function for use in g_value_transform(). + + Registers a value transformation function for use in g_value_transform(). A previously registered transformation function for @src_type and @dest_type will be replaced. - + - Source type. + Source type. - Target type. + Target type. - a function which transforms values of type @src_type + a function which transforms values of type @src_type into value of type @dest_type - - Returns whether a #GValue of type @src_type can be copied into + + Returns whether a #GValue of type @src_type can be copied into a #GValue of type @dest_type. - + - %TRUE if g_value_copy() is possible with @src_type and @dest_type. + %TRUE if g_value_copy() is possible with @src_type and @dest_type. - source type to be copied. + source type to be copied. - destination type for copying. + destination type for copying. - - Check whether g_value_transform() is able to transform values + + Check whether g_value_transform() is able to transform values of type @src_type into values of type @dest_type. Note that for the types to be transformable, they must be compatible or a transformation function must be registered. - + - %TRUE if the transformation is possible, %FALSE otherwise. + %TRUE if the transformation is possible, %FALSE otherwise. - Source type. + Source type. - Target type. + Target type. diff --git a/Gdk-3.0.gir b/Gdk-3.0.gir index 7cf0694..9688638 100644 --- a/Gdk-3.0.gir +++ b/Gdk-3.0.gir @@ -2,62 +2,38 @@ - + - + - Used to represent native events (XEvents for the X11 + Used to represent native events (XEvents for the X11 backend, MSGs for Win32). - + - - Converts a #GdkAtom into a pointer type. + + Converts a #GdkAtom into a pointer type. - a #GdkAtom. + a #GdkAtom. - - Positioning hints for aligning a window relative to a rectangle. + + Positioning hints for aligning a window relative to a rectangle. These hints determine how the window should be positioned in the case that the window would fall off-screen if placed in its ideal position. @@ -72,88 +48,36 @@ horizontally to fit. In general, when multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing. - - allow flipping anchors horizontally + + allow flipping anchors horizontally - - allow flipping anchors vertically + + allow flipping anchors vertically - - allow sliding window horizontally + + allow sliding window horizontally - - allow sliding window vertically + + allow sliding window vertically - - allow resizing window horizontally + + allow resizing window horizontally - - allow resizing window vertically + + allow resizing window vertically - - allow flipping anchors on both axes + + allow flipping anchors on both axes - - allow sliding window on both axes + + allow sliding window on both axes - - allow resizing window on both axes + + allow resizing window on both axes - - GdkAppLaunchContext is an implementation of #GAppLaunchContext that + + GdkAppLaunchContext is an implementation of #GAppLaunchContext that handles launching an application in a graphical context. It provides startup notification and allows to launch applications on a specific screen or workspace. @@ -173,29 +97,17 @@ if (!g_app_info_launch_default_for_uri ("http://www.gtk.org", context, &erro g_object_unref (context); ]| - - Creates a new #GdkAppLaunchContext. + + Creates a new #GdkAppLaunchContext. Use gdk_display_get_app_launch_context() instead - a new #GdkAppLaunchContext + a new #GdkAppLaunchContext - - Sets the workspace on which applications will be launched when + + Sets the workspace on which applications will be launched when using this context when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec). @@ -209,27 +121,17 @@ be the current workspace. - a #GdkAppLaunchContext + a #GdkAppLaunchContext - the number of a workspace, or -1 + the number of a workspace, or -1 - - Sets the display on which applications will be launched when + + Sets the display on which applications will be launched when using this context. See also gdk_app_launch_context_set_screen(). Use gdk_display_get_app_launch_context() instead @@ -238,25 +140,17 @@ using this context. See also gdk_app_launch_context_set_screen(). - a #GdkAppLaunchContext + a #GdkAppLaunchContext - a #GdkDisplay + a #GdkDisplay - - Sets the icon for applications that are launched with this + + Sets the icon for applications that are launched with this context. Window Managers can use this information when displaying startup @@ -269,28 +163,17 @@ See also gdk_app_launch_context_set_icon_name(). - a #GdkAppLaunchContext + a #GdkAppLaunchContext - - a #GIcon, or %NULL + + a #GIcon, or %NULL - - Sets the icon for applications that are launched with this context. + + Sets the icon for applications that are launched with this context. The @icon_name will be interpreted in the same way as the Icon field in desktop files. See also gdk_app_launch_context_set_icon(). @@ -304,28 +187,17 @@ for the launched application itself. - a #GdkAppLaunchContext + a #GdkAppLaunchContext - - an icon name, or %NULL + + an icon name, or %NULL - - Sets the screen on which applications will be launched when + + Sets the screen on which applications will be launched when using this context. See also gdk_app_launch_context_set_display(). If both @screen and @display are set, the @screen takes priority. @@ -337,25 +209,17 @@ display are used. - a #GdkAppLaunchContext + a #GdkAppLaunchContext - a #GdkScreen + a #GdkScreen - - Sets the timestamp of @context. The timestamp should ideally + + Sets the timestamp of @context. The timestamp should ideally be taken from the event that triggered the launch. Window managers can use this information to avoid moving the @@ -368,89 +232,62 @@ prevention'. - a #GdkAppLaunchContext + a #GdkAppLaunchContext - a timestamp + a timestamp - + - An opaque type representing a string as an index into a table + An opaque type representing a string as an index into a table of strings on the X server. - Determines the string corresponding to an atom. + Determines the string corresponding to an atom. - a newly-allocated string containing the string + a newly-allocated string containing the string corresponding to @atom. When you are done with the return value, you should free it using g_free(). - a #GdkAtom. + a #GdkAtom. - Finds or creates an atom corresponding to a given string. + Finds or creates an atom corresponding to a given string. - the atom corresponding to @atom_name. + the atom corresponding to @atom_name. - a string. + a string. - if %TRUE, GDK is allowed to not create a new atom, but - just return %GDK_NONE if the requested atom doesn’t already + if %TRUE, GDK is allowed to not create a new atom, but + just return %GDK_NONE if the requested atom doesn’t already exists. Currently, the flag is ignored, since checking the existance of an atom is as expensive as creating it. - - Finds or creates an atom corresponding to a given string. + + Finds or creates an atom corresponding to a given string. Note that this function is identical to gdk_atom_intern() except that if a new #GdkAtom is created the string itself is used rather @@ -462,257 +299,122 @@ ever unload the module again (e.g. do not use this function in GTK+ theme engines). - the atom corresponding to @atom_name + the atom corresponding to @atom_name - a static string + a static string - - Flags describing the current capabilities of a device/tool. + + Flags describing the current capabilities of a device/tool. - X axis is present + X axis is present - Y axis is present + Y axis is present - - Pressure axis is present + + Pressure axis is present - - X tilt axis is present + + X tilt axis is present - - Y tilt axis is present + + Y tilt axis is present - - Wheel axis is present + + Wheel axis is present - - Distance axis is present + + Distance axis is present - - Z-axis rotation is present + + Z-axis rotation is present - - Slider axis is present + + Slider axis is present - - An enumeration describing the way in which a device + + An enumeration describing the way in which a device axis (valuator) maps onto the predefined valuator types that GTK+ understands. Note that the X and Y axes are not really needed; pointer devices report their location via the x/y members of events regardless. Whether X and Y are present as axes depends on the GDK backend. - - the axis is ignored. + + the axis is ignored. - the axis is used as the x axis. + the axis is used as the x axis. - the axis is used as the y axis. + the axis is used as the y axis. - - the axis is used for pressure information. + + the axis is used for pressure information. - - the axis is used for x tilt information. + + the axis is used for x tilt information. - - the axis is used for y tilt information. + + the axis is used for y tilt information. - - the axis is used for wheel information. + + the axis is used for wheel information. - - the axis is used for pen/tablet distance information. (Since: 3.22) + + the axis is used for pen/tablet distance information. (Since: 3.22) - - the axis is used for pen rotation information. (Since: 3.22) + + the axis is used for pen rotation information. (Since: 3.22) - - the axis is used for pen slider information. (Since: 3.22) + + the axis is used for pen slider information. (Since: 3.22) - - a constant equal to the numerically highest axis value. + + a constant equal to the numerically highest axis value. - - The middle button. + + The middle button. - - The primary button. This is typically the left mouse button, or the + + The primary button. This is typically the left mouse button, or the right button in a left-handed setup. - - The secondary button. This is typically the right mouse button, or the + + The secondary button. This is typically the right mouse button, or the left button in a left-handed setup. - - A set of values describing the possible byte-orders + + A set of values describing the possible byte-orders for storing pixel values in memory. - - The values are stored with the least-significant byte + + The values are stored with the least-significant byte first. For instance, the 32-bit value 0xffeecc would be stored in memory as 0xcc, 0xee, 0xff, 0x00. - - The values are stored with the most-significant byte + + The values are stored with the most-significant byte first. For instance, the 32-bit value 0xffeecc would be stored in memory as 0x00, 0xff, 0xee, 0xcc. - Represents the current time, and can be used anywhere a time is expected. + Represents the current time, and can be used anywhere a time is expected. @@ -723,109 +425,68 @@ for storing pixel values in memory. - - A #GdkColor is used to describe a color, + + A #GdkColor is used to describe a color, similar to the XColor struct used in the X11 drawing API. Use #GdkRGBA - For allocated colors, the pixel value used to + For allocated colors, the pixel value used to draw this color on the screen. Not used anymore. - The red component of the color. This is + The red component of the color. This is a value between 0 and 65535, with 65535 indicating full intensity - The green component of the color + The green component of the color - The blue component of the color + The blue component of the color - - Makes a copy of a #GdkColor. + + Makes a copy of a #GdkColor. The result must be freed using gdk_color_free(). Use #GdkRGBA - a copy of @color + a copy of @color - a #GdkColor + a #GdkColor - - Compares two colors. + + Compares two colors. Use #GdkRGBA - %TRUE if the two colors compare equal + %TRUE if the two colors compare equal - a #GdkColor + a #GdkColor - another #GdkColor + another #GdkColor - - Frees a #GdkColor created with gdk_color_copy(). + + Frees a #GdkColor created with gdk_color_copy(). Use #GdkRGBA @@ -833,266 +494,150 @@ The result must be freed using gdk_color_free(). - a #GdkColor + a #GdkColor - - A hash function suitable for using for a hash + + A hash function suitable for using for a hash table that stores #GdkColors. Use #GdkRGBA - The hash function applied to @color + The hash function applied to @color - a #GdkColor + a #GdkColor - - Returns a textual specification of @color in the hexadecimal -form “\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits + + Returns a textual specification of @color in the hexadecimal +form “\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits representing the red, green and blue components respectively. The returned string can be parsed by gdk_color_parse(). Use #GdkRGBA - a newly-allocated text string + a newly-allocated text string - a #GdkColor + a #GdkColor - - Parses a textual specification of a color and fill in the + + Parses a textual specification of a color and fill in the @red, @green, and @blue fields of a #GdkColor. The string can either one of a large set of standard names (taken from the X11 `rgb.txt` file), or it can be a hexadecimal -value in the form “\#rgb” “\#rrggbb”, “\#rrrgggbbb” or -“\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits of +value in the form “\#rgb” “\#rrggbb”, “\#rrrgggbbb” or +“\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits of the red, green, and blue components of the color, respectively. -(White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff” -and “\#ffffffffffff”). +(White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff” +and “\#ffffffffffff”). Use #GdkRGBA - %TRUE if the parsing succeeded + %TRUE if the parsing succeeded - the string specifying the color + the string specifying the color - - the #GdkColor to fill in + + the #GdkColor to fill in - - Specifies the crossing mode for #GdkEventCrossing. - - crossing because of pointer motion. + + Specifies the crossing mode for #GdkEventCrossing. + + crossing because of pointer motion. - - crossing because a grab is activated. + + crossing because a grab is activated. - - crossing because a grab is deactivated. + + crossing because a grab is deactivated. - - crossing because a GTK+ grab is activated. + + crossing because a GTK+ grab is activated. - - crossing because a GTK+ grab is deactivated. + + crossing because a GTK+ grab is deactivated. - - crossing because a GTK+ widget changed + + crossing because a GTK+ widget changed state (e.g. sensitivity). - - crossing because a touch sequence has begun, + + crossing because a touch sequence has begun, this event is synthetic as the pointer might have not left the window. - - crossing because a touch sequence has ended, + + crossing because a touch sequence has ended, this event is synthetic as the pointer might have not left the window. - - crossing because of a device switch (i.e. + + crossing because of a device switch (i.e. a mouse taking control of the pointer after a touch device), this event - is synthetic as the pointer didn’t leave the window. + is synthetic as the pointer didn’t leave the window. - - A #GdkCursor represents a cursor. Its contents are private. - - Creates a new cursor from the set of builtin cursors for the default display. + + A #GdkCursor represents a cursor. Its contents are private. + + Creates a new cursor from the set of builtin cursors for the default display. See gdk_cursor_new_for_display(). To make the cursor invisible, use %GDK_BLANK_CURSOR. Use gdk_cursor_new_for_display() instead. - a new #GdkCursor + a new #GdkCursor - cursor to create + cursor to create - - Creates a new cursor from the set of builtin cursors. + + Creates a new cursor from the set of builtin cursors. - a new #GdkCursor, or %NULL on failure + a new #GdkCursor, or %NULL on failure - the #GdkDisplay for which the cursor will be created + the #GdkDisplay for which the cursor will be created - cursor to create + cursor to create - - Creates a new cursor by looking up @name in the current cursor + + Creates a new cursor by looking up @name in the current cursor theme. A recommended set of cursor names that will work across different @@ -1134,33 +679,23 @@ platforms can be found in the CSS specification: - ![](zoom_out_cursor.png) "zoom-out" - a new #GdkCursor, or %NULL if there is no + a new #GdkCursor, or %NULL if there is no cursor with the given name - the #GdkDisplay for which the cursor will be created + the #GdkDisplay for which the cursor will be created - the name of the cursor + the name of the cursor - - Creates a new cursor from a pixbuf. + + Creates a new cursor from a pixbuf. Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. @@ -1172,7 +707,7 @@ gdk_display_get_maximal_cursor_size() give information about cursor sizes. If @x or @y are `-1`, the pixbuf must have -options named “x_hot” and “y_hot”, resp., containing +options named “x_hot” and “y_hot”, resp., containing integer values between `0` and the width resp. height of the pixbuf. (Since: 3.0) @@ -1180,44 +715,30 @@ On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension. - a new #GdkCursor. + a new #GdkCursor. - the #GdkDisplay for which the cursor will be created + the #GdkDisplay for which the cursor will be created - the #GdkPixbuf containing the cursor image + the #GdkPixbuf containing the cursor image - the horizontal offset of the “hotspot” of the cursor. + the horizontal offset of the “hotspot” of the cursor. - the vertical offset of the “hotspot” of the cursor. + the vertical offset of the “hotspot” of the cursor. - - Creates a new cursor from a cairo image surface. + + Creates a new cursor from a cairo image surface. Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. @@ -1232,191 +753,121 @@ On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension. - a new #GdkCursor. + a new #GdkCursor. - the #GdkDisplay for which the cursor will be created + the #GdkDisplay for which the cursor will be created - the cairo image surface containing the cursor pixel data + the cairo image surface containing the cursor pixel data - the horizontal offset of the “hotspot” of the cursor + the horizontal offset of the “hotspot” of the cursor - the vertical offset of the “hotspot” of the cursor + the vertical offset of the “hotspot” of the cursor - - Returns the cursor type for this cursor. + + Returns the cursor type for this cursor. - a #GdkCursorType + a #GdkCursorType - a #GdkCursor + a #GdkCursor - - Returns the display on which the #GdkCursor is defined. + + Returns the display on which the #GdkCursor is defined. - the #GdkDisplay associated to @cursor + the #GdkDisplay associated to @cursor - a #GdkCursor. + a #GdkCursor. - - Returns a #GdkPixbuf with the image used to display the cursor. + + Returns a #GdkPixbuf with the image used to display the cursor. Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, %NULL is returned. - a #GdkPixbuf representing + a #GdkPixbuf representing @cursor, or %NULL - a #GdkCursor + a #GdkCursor - - Returns a cairo image surface with the image used to display the cursor. + + Returns a cairo image surface with the image used to display the cursor. Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, %NULL is returned. - a #cairo_surface_t + a #cairo_surface_t representing @cursor, or %NULL - a #GdkCursor + a #GdkCursor - - Location to store the hotspot x position, + + Location to store the hotspot x position, or %NULL - - Location to store the hotspot y position, + + Location to store the hotspot y position, or %NULL - - Adds a reference to @cursor. + + Adds a reference to @cursor. Use g_object_ref() instead - Same @cursor that was passed in + Same @cursor that was passed in - a #GdkCursor + a #GdkCursor - - Removes a reference from @cursor, deallocating the cursor + + Removes a reference from @cursor, deallocating the cursor if no references remain. Use g_object_unref() instead @@ -1425,794 +876,360 @@ if no references remain. - a #GdkCursor + a #GdkCursor - + - + - - Predefined cursors. + + Predefined cursors. Note that these IDs are directly taken from the X cursor font, and many of these cursors are either not useful, or are not available on other platforms. The recommended way to create cursors is to use gdk_cursor_new_from_name(). - - ![](X_cursor.png) + + ![](X_cursor.png) - - ![](arrow.png) + + ![](arrow.png) - - ![](based_arrow_down.png) + + ![](based_arrow_down.png) - - ![](based_arrow_up.png) + + ![](based_arrow_up.png) - ![](boat.png) + ![](boat.png) - - ![](bogosity.png) + + ![](bogosity.png) - - ![](bottom_left_corner.png) + + ![](bottom_left_corner.png) - - ![](bottom_right_corner.png) + + ![](bottom_right_corner.png) - - ![](bottom_side.png) + + ![](bottom_side.png) - - ![](bottom_tee.png) + + ![](bottom_tee.png) - - ![](box_spiral.png) + + ![](box_spiral.png) - - ![](center_ptr.png) + + ![](center_ptr.png) - - ![](circle.png) + + ![](circle.png) - - ![](clock.png) + + ![](clock.png) - - ![](coffee_mug.png) + + ![](coffee_mug.png) - - ![](cross.png) + + ![](cross.png) - - ![](cross_reverse.png) + + ![](cross_reverse.png) - - ![](crosshair.png) + + ![](crosshair.png) - - ![](diamond_cross.png) + + ![](diamond_cross.png) - ![](dot.png) + ![](dot.png) - - ![](dotbox.png) + + ![](dotbox.png) - - ![](double_arrow.png) + + ![](double_arrow.png) - - ![](draft_large.png) + + ![](draft_large.png) - - ![](draft_small.png) + + ![](draft_small.png) - - ![](draped_box.png) + + ![](draped_box.png) - - ![](exchange.png) + + ![](exchange.png) - - ![](fleur.png) + + ![](fleur.png) - - ![](gobbler.png) + + ![](gobbler.png) - - ![](gumby.png) + + ![](gumby.png) - - ![](hand1.png) + + ![](hand1.png) - - ![](hand2.png) + + ![](hand2.png) - - ![](heart.png) + + ![](heart.png) - ![](icon.png) + ![](icon.png) - - ![](iron_cross.png) + + ![](iron_cross.png) - - ![](left_ptr.png) + + ![](left_ptr.png) - - ![](left_side.png) + + ![](left_side.png) - - ![](left_tee.png) + + ![](left_tee.png) - - ![](leftbutton.png) + + ![](leftbutton.png) - - ![](ll_angle.png) + + ![](ll_angle.png) - - ![](lr_angle.png) + + ![](lr_angle.png) - ![](man.png) + ![](man.png) - - ![](middlebutton.png) + + ![](middlebutton.png) - - ![](mouse.png) + + ![](mouse.png) - - ![](pencil.png) + + ![](pencil.png) - - ![](pirate.png) + + ![](pirate.png) - ![](plus.png) + ![](plus.png) - - ![](question_arrow.png) + + ![](question_arrow.png) - - ![](right_ptr.png) + + ![](right_ptr.png) - - ![](right_side.png) + + ![](right_side.png) - - ![](right_tee.png) + + ![](right_tee.png) - - ![](rightbutton.png) + + ![](rightbutton.png) - - ![](rtl_logo.png) + + ![](rtl_logo.png) - - ![](sailboat.png) + + ![](sailboat.png) - - ![](sb_down_arrow.png) + + ![](sb_down_arrow.png) - - ![](sb_h_double_arrow.png) + + ![](sb_h_double_arrow.png) - - ![](sb_left_arrow.png) + + ![](sb_left_arrow.png) - - ![](sb_right_arrow.png) + + ![](sb_right_arrow.png) - - ![](sb_up_arrow.png) + + ![](sb_up_arrow.png) - - ![](sb_v_double_arrow.png) + + ![](sb_v_double_arrow.png) - - ![](shuttle.png) + + ![](shuttle.png) - - ![](sizing.png) + + ![](sizing.png) - - ![](spider.png) + + ![](spider.png) - - ![](spraycan.png) + + ![](spraycan.png) - ![](star.png) + ![](star.png) - - ![](target.png) + + ![](target.png) - - ![](tcross.png) + + ![](tcross.png) - - ![](top_left_arrow.png) + + ![](top_left_arrow.png) - - ![](top_left_corner.png) + + ![](top_left_corner.png) - - ![](top_right_corner.png) + + ![](top_right_corner.png) - - ![](top_side.png) + + ![](top_side.png) - - ![](top_tee.png) + + ![](top_tee.png) - ![](trek.png) + ![](trek.png) - - ![](ul_angle.png) + + ![](ul_angle.png) - - ![](umbrella.png) + + ![](umbrella.png) - - ![](ur_angle.png) + + ![](ur_angle.png) - - ![](watch.png) + + ![](watch.png) - - ![](xterm.png) + + ![](xterm.png) - - last cursor type + + last cursor type - - Blank cursor. Since 2.16 + + Blank cursor. Since 2.16 - - type of cursors constructed with + + type of cursors constructed with gdk_cursor_new_from_pixbuf() - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + @@ -2225,179 +1242,122 @@ The recommended way to create cursors is to use gdk_cursor_new_from_name(). - + - + - + - + - + - + - + - + - - The #GdkDevice object represents a single input device, such + + The #GdkDevice object represents a single input device, such as a keyboard, a mouse, a touchpad, etc. See the #GdkDeviceManager documentation for more information about the various kinds of master and slave devices, and their relationships. - - Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history(). + + Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history(). - an array of #GdkTimeCoord. + an array of #GdkTimeCoord. - the length of the array. + the length of the array. - - Determines information about the current keyboard grab. + + Determines information about the current keyboard grab. This is not public API and must not be used by applications. The symbol was never meant to be used outside of GTK+ - %TRUE if this application currently has the + %TRUE if this application currently has the keyboard grabbed. - the display for which to get the grab information + the display for which to get the grab information - device to get the grab information from + device to get the grab information from - - location to store current grab window + + location to store current grab window - - location to store boolean indicating whether + + location to store boolean indicating whether the @owner_events flag to gdk_keyboard_grab() or gdk_pointer_grab() was %TRUE. - - Returns the associated device to @device, if @device is of type + + Returns the associated device to @device, if @device is of type %GDK_DEVICE_TYPE_MASTER, it will return the paired pointer or keyboard. @@ -2408,236 +1368,153 @@ If @device is of type %GDK_DEVICE_TYPE_FLOATING, %NULL will be returned, as there is no associated device. - The associated device, or + The associated device, or %NULL - a #GdkDevice + a #GdkDevice - - Returns the axes currently available on the device. + + Returns the axes currently available on the device. - a #GdkDevice + a #GdkDevice - - Interprets an array of double as axis values for a given device, + + Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use. - %TRUE if the given axis use was found, otherwise %FALSE + %TRUE if the given axis use was found, otherwise %FALSE - a #GdkDevice + a #GdkDevice - pointer to an array of axes + pointer to an array of axes - the use to look for + the use to look for - - location to store the found value. + + location to store the found value. - - Returns the axis use for @index_. + + Returns the axis use for @index_. - a #GdkAxisUse specifying how the axis is used. + a #GdkAxisUse specifying how the axis is used. - a pointer #GdkDevice. + a pointer #GdkDevice. - the index of the axis. + the index of the axis. - - Interprets an array of double as axis values for a given device, + + Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis label, as returned by gdk_device_list_axes() - %TRUE if the given axis use was found, otherwise %FALSE. + %TRUE if the given axis use was found, otherwise %FALSE. - a pointer #GdkDevice. + a pointer #GdkDevice. - pointer to an array of axes + pointer to an array of axes - #GdkAtom with the axis label. + #GdkAtom with the axis label. - - location to store the found value. + + location to store the found value. - - Returns the device type for @device. + + Returns the device type for @device. - the #GdkDeviceType for @device. + the #GdkDeviceType for @device. - a #GdkDevice + a #GdkDevice - - Returns the #GdkDisplay to which @device pertains. + + Returns the #GdkDisplay to which @device pertains. - a #GdkDisplay. This memory is owned + a #GdkDisplay. This memory is owned by GTK+, and must not be freed or unreffed. - a #GdkDevice + a #GdkDevice - - Determines whether the pointer follows device motion. + + Determines whether the pointer follows device motion. This is not meaningful for keyboard devices, which don't have a pointer. - %TRUE if the pointer follows device motion + %TRUE if the pointer follows device motion - a #GdkDevice + a #GdkDevice - - Obtains the motion history for a pointer device; given a starting and + + Obtains the motion history for a pointer device; given a starting and ending timestamp, return all events in the motion history for the device in the given range of time. Some windowing systems do not support motion history, in which case, %FALSE will @@ -2649,231 +1526,145 @@ more motion events delivered directly, independent of the windowing system. - %TRUE if the windowing system supports motion history and + %TRUE if the windowing system supports motion history and at least one event was found. - a #GdkDevice + a #GdkDevice - the window with respect to which which the event coordinates will be reported + the window with respect to which which the event coordinates will be reported - starting timestamp for range of events to return + starting timestamp for range of events to return - ending timestamp for the range of events to return + ending timestamp for the range of events to return - - + + location to store a newly-allocated array of #GdkTimeCoord, or %NULL - - location to store the length of + + location to store the length of @events, or %NULL - If @index_ has a valid keyval, this function will return %TRUE + If @index_ has a valid keyval, this function will return %TRUE and fill in @keyval and @modifiers with the keyval settings. - %TRUE if keyval is set for @index. + %TRUE if keyval is set for @index. - a #GdkDevice. + a #GdkDevice. - the index of the macro button to get. + the index of the macro button to get. - - return value for the keyval. + + return value for the keyval. - - return value for modifiers. + + return value for modifiers. - - Gets information about which window the given pointer device is in, based on events + + Gets information about which window the given pointer device is in, based on events that have been received so far from the display server. If another application has a pointer grab, or this application has a grab with owner_events = %FALSE, %NULL may be returned even if the pointer is physically over one of this application's windows. - the last window the device + the last window the device - a #GdkDevice, with a source other than %GDK_SOURCE_KEYBOARD + a #GdkDevice, with a source other than %GDK_SOURCE_KEYBOARD - - Determines the mode of the device. + + Determines the mode of the device. - a #GdkInputSource + a #GdkInputSource - a #GdkDevice + a #GdkDevice - - Returns the number of axes the device currently has. + + Returns the number of axes the device currently has. - the number of axes. + the number of axes. - a pointer #GdkDevice + a pointer #GdkDevice - - Returns the number of keys the device currently has. + + Returns the number of keys the device currently has. - the number of keys. + the number of keys. - a #GdkDevice + a #GdkDevice - - Determines the name of the device. + + Determines the name of the device. - a name + a name - a #GdkDevice + a #GdkDevice - - Gets the current location of @device. As a slave device + + Gets the current location of @device. As a slave device coordinates are those of its master pointer, This function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see gdk_device_grab(). @@ -2883,53 +1674,26 @@ unless there is an ongoing grab on them, see gdk_device_grab(). - pointer device to query status about. + pointer device to query status about. - - location to store the #GdkScreen + + location to store the #GdkScreen the @device is on, or %NULL. - - location to store root window X coordinate of @device, or %NULL. + + location to store root window X coordinate of @device, or %NULL. - - location to store root window Y coordinate of @device, or %NULL. + + location to store root window Y coordinate of @device, or %NULL. - - Gets the current location of @device in double precision. As a slave device's + + Gets the current location of @device in double precision. As a slave device's coordinates are those of its master pointer, this function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them. See gdk_device_grab(). @@ -2939,123 +1703,72 @@ unless there is an ongoing grab on them. See gdk_device_grab(). - pointer device to query status about. + pointer device to query status about. - - location to store the #GdkScreen + + location to store the #GdkScreen the @device is on, or %NULL. - - location to store root window X coordinate of @device, or %NULL. + + location to store root window X coordinate of @device, or %NULL. - - location to store root window Y coordinate of @device, or %NULL. + + location to store root window Y coordinate of @device, or %NULL. - - Returns the product ID of this device, or %NULL if this information couldn't + + Returns the product ID of this device, or %NULL if this information couldn't be obtained. This ID is retrieved from the device, and is thus constant for it. See gdk_device_get_vendor_id() for more information. - the product ID, or %NULL + the product ID, or %NULL - a slave #GdkDevice + a slave #GdkDevice - - Returns the #GdkSeat the device belongs to. + + Returns the #GdkSeat the device belongs to. - A #GdkSeat. This memory is owned by GTK+ and + A #GdkSeat. This memory is owned by GTK+ and must not be freed. - A #GdkDevice + A #GdkDevice - - Determines the type of the device. + + Determines the type of the device. - a #GdkInputSource + a #GdkInputSource - a #GdkDevice + a #GdkDevice - - Gets the current state of a pointer device relative to @window. As a slave -device’s coordinates are those of its master pointer, this + + Gets the current state of a pointer device relative to @window. As a slave +device’s coordinates are those of its master pointer, this function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them. See gdk_device_grab(). @@ -3064,48 +1777,28 @@ unless there is an ongoing grab on them. See gdk_device_grab(). - a #GdkDevice. + a #GdkDevice. - a #GdkWindow. + a #GdkWindow. - - an array of doubles to store the values of + + an array of doubles to store the values of the axes of @device in, or %NULL. - - location to store the modifiers, or %NULL. + + location to store the modifiers, or %NULL. - - Returns the vendor ID of this device, or %NULL if this information couldn't + + Returns the vendor ID of this device, or %NULL if this information couldn't be obtained. This ID is retrieved from the device, and is thus constant for it. @@ -3133,26 +1826,18 @@ compose #GSettings paths to store settings for this device. ]| - the vendor ID, or %NULL + the vendor ID, or %NULL - a slave #GdkDevice + a slave #GdkDevice - - Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns + + Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns %NULL if the window tree under @device is not known to GDK (for example, belongs to another application). As a slave device coordinates are those of its master pointer, This @@ -3160,51 +1845,29 @@ function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see gdk_device_grab(). - the #GdkWindow under the + the #GdkWindow under the device position, or %NULL. - pointer #GdkDevice to query info to. + pointer #GdkDevice to query info to. - - return location for the X coordinate of the device location, + + return location for the X coordinate of the device location, relative to the window origin, or %NULL. - - return location for the Y coordinate of the device location, + + return location for the Y coordinate of the device location, relative to the window origin, or %NULL. - - Obtains the window underneath @device, returning the location of the device in @win_x and @win_y in + + Obtains the window underneath @device, returning the location of the device in @win_x and @win_y in double precision. Returns %NULL if the window tree under @device is not known to GDK (for example, belongs to another application). @@ -3213,53 +1876,29 @@ function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see gdk_device_grab(). - the #GdkWindow under the + the #GdkWindow under the device position, or %NULL. - pointer #GdkDevice to query info to. + pointer #GdkDevice to query info to. - - return location for the X coordinate of the device location, + + return location for the X coordinate of the device location, relative to the window origin, or %NULL. - - return location for the Y coordinate of the device location, + + return location for the Y coordinate of the device location, relative to the window origin, or %NULL. - - Grabs the device so that all events coming from this device are passed to + + Grabs the device so that all events coming from this device are passed to this application until the device is ungrabbed with gdk_device_ungrab(), or the window becomes unviewable. This overrides any previous grab on the device by this client. @@ -3283,37 +1922,27 @@ events that are emitted when the grab ends unvoluntarily. Use gdk_seat_grab() instead. - %GDK_GRAB_SUCCESS if the grab was successful. + %GDK_GRAB_SUCCESS if the grab was successful. - a #GdkDevice. To get the device you can use gtk_get_current_event_device() + a #GdkDevice. To get the device you can use gtk_get_current_event_device() or gdk_event_get_device() if the grab is in reaction to an event. Also, you can use - gdk_device_manager_get_client_pointer() but only in code that isn’t triggered by a - #GdkEvent and there aren’t other means to get a meaningful #GdkDevice to operate on. + gdk_device_manager_get_client_pointer() but only in code that isn’t triggered by a + #GdkEvent and there aren’t other means to get a meaningful #GdkDevice to operate on. - the #GdkWindow which will own the grab (the grab window) + the #GdkWindow which will own the grab (the grab window) - specifies the grab ownership. + specifies the grab ownership. - if %FALSE then all device events are reported with respect to + if %FALSE then all device events are reported with respect to @window and are only reported if selected by @event_mask. If %TRUE then pointer events for this application are reported as normal, but pointer events outside this application are @@ -3322,46 +1951,31 @@ events that are emitted when the grab ends unvoluntarily. - specifies the event mask, which is used in accordance with + specifies the event mask, which is used in accordance with @owner_events. - - the cursor to display while the grab is active if the device is + + the cursor to display while the grab is active if the device is a pointer. If this is %NULL then the normal cursors are used for @window and its descendants, and the cursor for @window is used elsewhere. - the timestamp of the event which led to this pointer grab. This + the timestamp of the event which led to this pointer grab. This usually comes from the #GdkEvent struct, though %GDK_CURRENT_TIME - can be used if the time isn’t known. + can be used if the time isn’t known. - - Returns a #GList of #GdkAtoms, containing the labels for + + Returns a #GList of #GdkAtoms, containing the labels for the axes that @device currently has. - + A #GList of #GdkAtoms, free with g_list_free(). @@ -3369,25 +1983,18 @@ the axes that @device currently has. - a pointer #GdkDevice + a pointer #GdkDevice - - If the device if of type %GDK_DEVICE_TYPE_MASTER, it will return + + If the device if of type %GDK_DEVICE_TYPE_MASTER, it will return the list of slave devices attached to it, otherwise it will return %NULL - + the list of slave devices, or %NULL. The list must be freed with g_list_free(), the contents of the list are owned by GTK+ and should not be freed. @@ -3397,46 +2004,34 @@ the list of slave devices attached to it, otherwise it will return - a #GdkDevice + a #GdkDevice - Specifies how an axis of a device is used. + Specifies how an axis of a device is used. - a pointer #GdkDevice + a pointer #GdkDevice - the index of the axis + the index of the axis - specifies how the axis is used + specifies how the axis is used - Specifies the X key event to generate when a macro button of a device + Specifies the X key event to generate when a macro button of a device is pressed. @@ -3444,36 +2039,26 @@ is pressed. - a #GdkDevice + a #GdkDevice - the index of the macro button to set + the index of the macro button to set - the keyval to generate + the keyval to generate - the modifiers to set + the modifiers to set - Sets a the mode of an input device. The mode controls if the -device is active and whether the device’s range is mapped to the + Sets a the mode of an input device. The mode controls if the +device is active and whether the device’s range is mapped to the entire screen or to a single window. Note: This is only meaningful for floating devices, master devices (and @@ -3481,34 +2066,22 @@ slaves connected to these) drive the pointer cursor, which is not limited by the input mode. - %TRUE if the mode was successfully changed. + %TRUE if the mode was successfully changed. - a #GdkDevice. + a #GdkDevice. - the input mode. + the input mode. - - Release any grab on @device. + + Release any grab on @device. Use gdk_seat_ungrab() instead. @@ -3516,23 +2089,17 @@ by the input mode. - a #GdkDevice + a #GdkDevice - a timestap (e.g. %GDK_CURRENT_TIME). + a timestap (e.g. %GDK_CURRENT_TIME). - Warps @device in @display to the point @x,@y on + Warps @device in @display to the point @x,@y on the screen @screen, unless the device is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer @@ -3549,164 +2116,87 @@ for the color picker in the #GtkColorSelectionDialog. - the device to warp. + the device to warp. - the screen to warp @device to. + the screen to warp @device to. - the X coordinate of the destination. + the X coordinate of the destination. - the Y coordinate of the destination. + the Y coordinate of the destination. - - Associated pointer or keyboard with this device, if any. Devices of type #GDK_DEVICE_TYPE_MASTER + + Associated pointer or keyboard with this device, if any. Devices of type #GDK_DEVICE_TYPE_MASTER always come in keyboard/pointer pairs. Other device types will have a %NULL associated device. - The axes currently available for this device. + The axes currently available for this device. - - The #GdkDeviceManager the #GdkDevice pertains to. + + The #GdkDeviceManager the #GdkDevice pertains to. - - The #GdkDisplay the #GdkDevice pertains to. + + The #GdkDisplay the #GdkDevice pertains to. - - Whether the device is represented by a cursor on the screen. Devices of type + + Whether the device is represented by a cursor on the screen. Devices of type %GDK_DEVICE_TYPE_MASTER will have %TRUE here. - - Source type for the device. + + Source type for the device. - Number of axes in the device. + Number of axes in the device. - - The device name. + + The device name. - - The maximal number of concurrent touches on a touch device. + + The maximal number of concurrent touches on a touch device. Will be 0 if the device is not a touch device or if the number of touches is unknown. - - Product ID of this device, see gdk_device_get_product_id(). + + Product ID of this device, see gdk_device_get_product_id(). - - #GdkSeat of this device. + + #GdkSeat of this device. - - Device role in the device manager. + + Device role in the device manager. - - Vendor ID of this device, see gdk_device_get_vendor_id(). + + Vendor ID of this device, see gdk_device_get_vendor_id(). - The ::changed signal is emitted either when the #GdkDevice + The ::changed signal is emitted either when the #GdkDevice has changed the number of either axes or keys. For example In X this will normally happen when the slave device routing events through the master device changes (for example, user @@ -3718,33 +2208,21 @@ axes and keys. - The ::tool-changed signal is emitted on pen/eraser + The ::tool-changed signal is emitted on pen/eraser #GdkDevices whenever tools enter or leave proximity. - The new current tool + The new current tool - - In addition to a single pointer and keyboard for user interface input, + + In addition to a single pointer and keyboard for user interface input, GDK contains support for a variety of input devices, including graphics tablets, touchscreens and multiple pointers/keyboards interacting simultaneously with the user interface. Such input devices often have @@ -3773,8 +2251,8 @@ Unless gdk_disable_multidevice() is called, the XInput 2 #GdkDeviceManager implementation will be used as the input source. Otherwise either the core or XInput 1 implementations will be used. -For simple applications that don’t have any special interest in -input devices, the so-called “client pointer” +For simple applications that don’t have any special interest in +input devices, the so-called “client pointer” provides a reasonable approximation to a simple setup with a single pointer and keyboard. The device that has been set as the client pointer can be accessed via gdk_device_manager_get_client_pointer(). @@ -3791,27 +2269,27 @@ gdk_device_get_associated_device(). There may be several virtual devices, and several physical devices could be controlling each of these virtual devices. Physical devices may also -be “floating”, which means they are not attached to any virtual device. +be “floating”, which means they are not attached to any virtual device. # Master and slave devices |[ carlos@sacarino:~$ xinput list -⎡ Virtual core pointer id=2 [master pointer (3)] -⎜ ↳ Virtual core XTEST pointer id=4 [slave pointer (2)] -⎜ ↳ Wacom ISDv4 E6 Pen stylus id=10 [slave pointer (2)] -⎜ ↳ Wacom ISDv4 E6 Finger touch id=11 [slave pointer (2)] -⎜ ↳ SynPS/2 Synaptics TouchPad id=13 [slave pointer (2)] -⎜ ↳ TPPS/2 IBM TrackPoint id=14 [slave pointer (2)] -⎜ ↳ Wacom ISDv4 E6 Pen eraser id=16 [slave pointer (2)] -⎣ Virtual core keyboard id=3 [master keyboard (2)] - ↳ Virtual core XTEST keyboard id=5 [slave keyboard (3)] - ↳ Power Button id=6 [slave keyboard (3)] - ↳ Video Bus id=7 [slave keyboard (3)] - ↳ Sleep Button id=8 [slave keyboard (3)] - ↳ Integrated Camera id=9 [slave keyboard (3)] - ↳ AT Translated Set 2 keyboard id=12 [slave keyboard (3)] - ↳ ThinkPad Extra Buttons id=15 [slave keyboard (3)] +⎡ Virtual core pointer id=2 [master pointer (3)] +⎜ ↳ Virtual core XTEST pointer id=4 [slave pointer (2)] +⎜ ↳ Wacom ISDv4 E6 Pen stylus id=10 [slave pointer (2)] +⎜ ↳ Wacom ISDv4 E6 Finger touch id=11 [slave pointer (2)] +⎜ ↳ SynPS/2 Synaptics TouchPad id=13 [slave pointer (2)] +⎜ ↳ TPPS/2 IBM TrackPoint id=14 [slave pointer (2)] +⎜ ↳ Wacom ISDv4 E6 Pen eraser id=16 [slave pointer (2)] +⎣ Virtual core keyboard id=3 [master keyboard (2)] + ↳ Virtual core XTEST keyboard id=5 [slave keyboard (3)] + ↳ Power Button id=6 [slave keyboard (3)] + ↳ Video Bus id=7 [slave keyboard (3)] + ↳ Sleep Button id=8 [slave keyboard (3)] + ↳ Integrated Camera id=9 [slave keyboard (3)] + ↳ AT Translated Set 2 keyboard id=12 [slave keyboard (3)] + ↳ ThinkPad Extra Buttons id=15 [slave keyboard (3)] ]| By default, GDK will automatically listen for events coming from all @@ -3851,84 +2329,58 @@ device that is routing events through it. Whenever the physical device changes, the #GdkDevice:n-axes property will be notified, and gdk_device_list_axes() will return the new device axes. -Devices may also have associated “keys” or +Devices may also have associated “keys” or macro buttons. Such keys can be globally set to map into normal X keyboard events. The mapping is set using gdk_device_set_key(). In GTK+ 3.20, a new #GdkSeat object has been introduced that supersedes #GdkDeviceManager and should be preferred in newly written code. - - Returns the client pointer, that is, the master pointer that acts as the core pointer + + Returns the client pointer, that is, the master pointer that acts as the core pointer for this application. In X11, window managers may change this depending on the interaction pattern under the presence of several pointers. -You should use this function seldomly, only in code that isn’t triggered by a #GdkEvent -and there aren’t other means to get a meaningful #GdkDevice to operate on. +You should use this function seldomly, only in code that isn’t triggered by a #GdkEvent +and there aren’t other means to get a meaningful #GdkDevice to operate on. Use gdk_seat_get_pointer() instead. - The client pointer. This memory is + The client pointer. This memory is owned by GDK and must not be freed or unreferenced. - a #GdkDeviceManager + a #GdkDeviceManager - - Gets the #GdkDisplay associated to @device_manager. + + Gets the #GdkDisplay associated to @device_manager. - the #GdkDisplay to which + the #GdkDisplay to which @device_manager is associated to, or %NULL. This memory is owned by GDK and must not be freed or unreferenced. - a #GdkDeviceManager + a #GdkDeviceManager - - Returns the list of devices of type @type currently attached to + + Returns the list of devices of type @type currently attached to @device_manager. , use gdk_seat_get_pointer(), gdk_seat_get_keyboard() and gdk_seat_get_slaves() instead. - a list of + a list of #GdkDevices. The returned list must be freed with g_list_free (). The list elements are owned by GTK+ and must not be freed or unreffed. @@ -3938,29 +2390,20 @@ and there aren’t other means to get a meaningful #GdkDevice to operate on. - a #GdkDeviceManager + a #GdkDeviceManager - device type to get. + device type to get. - + - The ::device-added signal is emitted either when a new master + The ::device-added signal is emitted either when a new master pointer is created, or when a slave (Hardware) input device is plugged in. @@ -3968,17 +2411,13 @@ is plugged in. - the newly added #GdkDevice. + the newly added #GdkDevice. - The ::device-changed signal is emitted whenever a device + The ::device-changed signal is emitted whenever a device has changed in the hierarchy, either slave devices being disconnected from their master device or connected to another one, or master devices being added or removed @@ -3993,17 +2432,13 @@ if it's attached, it will change to %GDK_DEVICE_TYPE_SLAVE. - the #GdkDevice that changed. + the #GdkDevice that changed. - The ::device-removed signal is emitted either when a master + The ::device-removed signal is emitted either when a master pointer is removed, or when a slave (Hardware) input device is unplugged. @@ -4011,23 +2446,14 @@ is unplugged. - the just removed #GdkDevice. + the just removed #GdkDevice. - - #GdkDevicePad is an interface implemented by devices of type + + #GdkDevicePad is an interface implemented by devices of type %GDK_SOURCE_TABLET_PAD, it allows querying the features provided by the pad device. @@ -4046,173 +2472,101 @@ mode for a given group will be notified through the #GdkEventPadGroupMode event. - - Returns the group the given @feature and @idx belong to, + + Returns the group the given @feature and @idx belong to, or -1 if feature/index do not exist in @pad. - The group number of the queried pad feature. + The group number of the queried pad feature. - a #GdkDevicePad + a #GdkDevicePad - the feature type to get the group from + the feature type to get the group from - the index of the feature to get the group from + the index of the feature to get the group from - - Returns the number of modes that @group may have. + + Returns the number of modes that @group may have. - The number of modes available in @group. + The number of modes available in @group. - a #GdkDevicePad + a #GdkDevicePad - group to get the number of available modes from + group to get the number of available modes from - - Returns the number of features a tablet pad has. + + Returns the number of features a tablet pad has. - The amount of elements of type @feature that this pad has. + The amount of elements of type @feature that this pad has. - a #GdkDevicePad + a #GdkDevicePad - a pad feature + a pad feature - - Returns the number of groups this pad device has. Pads have + + Returns the number of groups this pad device has. Pads have at least one group. A pad group is a subcollection of buttons/strip/rings that is affected collectively by a same current mode. - The number of button/ring/strip groups in the pad. + The number of button/ring/strip groups in the pad. - a #GdkDevicePad + a #GdkDevicePad - - A pad feature. - - a button + + A pad feature. + + a button - - a ring-shaped interactive area + + a ring-shaped interactive area - - a straight interactive area + + a straight interactive area - + - - - Gets the hardware ID of this tool, or 0 if it's not known. When + + + Gets the hardware ID of this tool, or 0 if it's not known. When non-zero, the identificator is unique for the given tool model, meaning that two identical tools will share the same @hardware_id, but will have different serial numbers (see gdk_device_tool_get_serial()). @@ -4223,209 +2577,104 @@ may support multiple devices with the same #GdkDeviceToolType, but having different hardware identificators. - The hardware identificator of this tool. + The hardware identificator of this tool. - a #GdkDeviceTool + a #GdkDeviceTool - - Gets the serial of this tool, this value can be used to identify a + + Gets the serial of this tool, this value can be used to identify a physical tool (eg. a tablet pen) across program executions. - The serial ID for this tool + The serial ID for this tool - a #GdkDeviceTool + a #GdkDeviceTool - - Gets the #GdkDeviceToolType of the tool. + + Gets the #GdkDeviceToolType of the tool. - The physical type for this tool. This can be used to figure out what + The physical type for this tool. This can be used to figure out what sort of pen is being used, such as an airbrush or a pencil. - a #GdkDeviceTool + a #GdkDeviceTool - + - + - + - + - - Indicates the specific type of tool being used being a tablet. Such as an + + Indicates the specific type of tool being used being a tablet. Such as an airbrush, pencil, etc. - - Tool is of an unknown type. + + Tool is of an unknown type. - - Tool is a standard tablet stylus. + + Tool is a standard tablet stylus. - - Tool is standard tablet eraser. + + Tool is standard tablet eraser. - - Tool is a brush stylus. + + Tool is a brush stylus. - - Tool is a pencil stylus. + + Tool is a pencil stylus. - - Tool is an airbrush stylus. + + Tool is an airbrush stylus. - - Tool is a mouse. + + Tool is a mouse. - - Tool is a lens cursor. + + Tool is a lens cursor. - - Indicates the device type. See [above][GdkDeviceManager.description] + + Indicates the device type. See [above][GdkDeviceManager.description] for more information about the meaning of these device types. - - Device is a master (or virtual) device. There will + + Device is a master (or virtual) device. There will be an associated focus indicator on the screen. - - Device is a slave (or physical) device. + + Device is a slave (or physical) device. - - Device is a physical device, currently not attached to + + Device is a physical device, currently not attached to any virtual device. - - #GdkDisplay objects purpose are two fold: + + #GdkDisplay objects purpose are two fold: - To manage and provide information about input devices (pointers and keyboards) @@ -4443,51 +2692,34 @@ Most of the input device handling has been factored out into the separate #GdkDeviceManager object. Every display has a device manager, which you can obtain using gdk_display_get_device_manager(). - - Gets the default #GdkDisplay. This is a convenience + + Gets the default #GdkDisplay. This is a convenience function for: `gdk_display_manager_get_default_display (gdk_display_manager_get ())`. - a #GdkDisplay, or %NULL if + a #GdkDisplay, or %NULL if there is no default display. - Opens a display. + Opens a display. - a #GdkDisplay, or %NULL if the + a #GdkDisplay, or %NULL if the display could not be opened - the name of the display to open + the name of the display to open - - Opens the default display specified by command line arguments or + + Opens the default display specified by command line arguments or environment variables, sets it as the default display, and returns it. gdk_parse_args() must have been called first. If the default display has previously been set, simply returns that. An internal @@ -4496,34 +2728,26 @@ function that should not be used by applications. of GTK+ - the default display, if it + the default display, if it could be opened, otherwise %NULL. - Emits a short beep on @display + Emits a short beep on @display - a #GdkDisplay + a #GdkDisplay - Closes the connection to the windowing system for the given display, + Closes the connection to the windowing system for the given display, and cleans up associated resources. @@ -4531,44 +2755,31 @@ and cleans up associated resources. - a #GdkDisplay + a #GdkDisplay - - Returns %TRUE if there is an ongoing grab on @device for @display. + + Returns %TRUE if there is an ongoing grab on @device for @display. - %TRUE if there is a grab in effect for @device. + %TRUE if there is a grab in effect for @device. - a #GdkDisplay + a #GdkDisplay - a #GdkDevice + a #GdkDevice - Flushes any requests queued for the windowing system; this happens automatically + Flushes any requests queued for the windowing system; this happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitly. A common case where this function @@ -4583,392 +2794,252 @@ handled synchronously, this function will do nothing. - a #GdkDisplay + a #GdkDisplay - - Returns a #GdkAppLaunchContext suitable for launching + + Returns a #GdkAppLaunchContext suitable for launching applications on the given display. - a new #GdkAppLaunchContext for @display. + a new #GdkAppLaunchContext for @display. Free with g_object_unref() when done - a #GdkDisplay + a #GdkDisplay - - Returns the default size to use for cursors on @display. + + Returns the default size to use for cursors on @display. - the default cursor size. + the default cursor size. - a #GdkDisplay + a #GdkDisplay - - Returns the default group leader window for all toplevel windows + + Returns the default group leader window for all toplevel windows on @display. This window is implicitly created by GDK. See gdk_window_set_group(). - The default group leader window + The default group leader window for @display - a #GdkDisplay + a #GdkDisplay - - Get the default #GdkScreen for @display. + + Get the default #GdkScreen for @display. - the default #GdkScreen object for @display + the default #GdkScreen object for @display - a #GdkDisplay + a #GdkDisplay - - Returns the default #GdkSeat for this display. + + Returns the default #GdkSeat for this display. - the default seat. + the default seat. - a #GdkDisplay + a #GdkDisplay - - Returns the #GdkDeviceManager associated to @display. + + Returns the #GdkDeviceManager associated to @display. Use gdk_display_get_default_seat() and #GdkSeat operations. - A #GdkDeviceManager, or + A #GdkDeviceManager, or %NULL. This memory is owned by GDK and must not be freed or unreferenced. - a #GdkDisplay. + a #GdkDisplay. - - Gets the next #GdkEvent to be processed for @display, fetching events from the + + Gets the next #GdkEvent to be processed for @display, fetching events from the windowing system if necessary. - the next #GdkEvent to be processed, or %NULL + the next #GdkEvent to be processed, or %NULL if no events are pending. The returned #GdkEvent should be freed with gdk_event_free(). - a #GdkDisplay + a #GdkDisplay - - Gets the maximal size to use for cursors on @display. + + Gets the maximal size to use for cursors on @display. - a #GdkDisplay + a #GdkDisplay - - the return location for the maximal cursor width + + the return location for the maximal cursor width - - the return location for the maximal cursor height + + the return location for the maximal cursor height - - Gets a monitor associated with this display. + + Gets a monitor associated with this display. - the #GdkMonitor, or %NULL if + the #GdkMonitor, or %NULL if @monitor_num is not a valid monitor number - a #GdkDisplay + a #GdkDisplay - number of the monitor + number of the monitor - - Gets the monitor in which the point (@x, @y) is located, + + Gets the monitor in which the point (@x, @y) is located, or a nearby monitor if the point is not in any monitor. - the monitor containing the point + the monitor containing the point - a #GdkDisplay + a #GdkDisplay - the x coordinate of the point + the x coordinate of the point - the y coordinate of the point + the y coordinate of the point - - Gets the monitor in which the largest area of @window + + Gets the monitor in which the largest area of @window resides, or a monitor close to @window if it is outside of all monitors. - the monitor with the largest overlap with @window + the monitor with the largest overlap with @window - a #GdkDisplay + a #GdkDisplay - a #GdkWindow + a #GdkWindow - - Gets the number of monitors that belong to @display. + + Gets the number of monitors that belong to @display. The returned number is valid until the next emission of the #GdkDisplay::monitor-added or #GdkDisplay::monitor-removed signal. - the number of monitors + the number of monitors - a #GdkDisplay + a #GdkDisplay - - Gets the number of screen managed by the @display. + + Gets the number of screen managed by the @display. The number of screens is always 1. - number of screens. + number of screens. - a #GdkDisplay + a #GdkDisplay - - Gets the name of the display. + + Gets the name of the display. - a string representing the display name. This string is owned + a string representing the display name. This string is owned by GDK and should not be modified or freed. - a #GdkDisplay + a #GdkDisplay - - Gets the current location of the pointer and the current modifier + + Gets the current location of the pointer and the current modifier mask for a given display. Use gdk_device_get_position() instead. @@ -4977,223 +3048,127 @@ mask for a given display. - a #GdkDisplay + a #GdkDisplay - - location to store the screen that the + + location to store the screen that the cursor is on, or %NULL. - - location to store root window X coordinate of pointer, or %NULL. + + location to store root window X coordinate of pointer, or %NULL. - - location to store root window Y coordinate of pointer, or %NULL. + + location to store root window Y coordinate of pointer, or %NULL. - - location to store current modifier mask, or %NULL + + location to store current modifier mask, or %NULL - - Gets the primary monitor for the display. + + Gets the primary monitor for the display. -The primary monitor is considered the monitor where the “main desktop” +The primary monitor is considered the monitor where the “main desktop” lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor. - the primary monitor, or %NULL if no primary + the primary monitor, or %NULL if no primary monitor is configured by the user - a #GdkDisplay + a #GdkDisplay - - Returns a screen object for one of the screens of the display. + + Returns a screen object for one of the screens of the display. There is only one screen; use gdk_display_get_default_screen() to get it. - the #GdkScreen object + the #GdkScreen object - a #GdkDisplay + a #GdkDisplay - the screen number + the screen number - - Obtains the window underneath the mouse pointer, returning the location + + Obtains the window underneath the mouse pointer, returning the location of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL if the window under the mouse pointer is not known to GDK (for example, belongs to another application). Use gdk_device_get_window_at_position() instead. - the window under the mouse + the window under the mouse pointer, or %NULL - a #GdkDisplay + a #GdkDisplay - - return location for x coordinate of the pointer location relative + + return location for x coordinate of the pointer location relative to the window origin, or %NULL - - return location for y coordinate of the pointer location relative + + return location for y coordinate of the pointer location relative & to the window origin, or %NULL - - Returns whether the display has events that are waiting + + Returns whether the display has events that are waiting to be processed. - %TRUE if there are events ready to be processed. + %TRUE if there are events ready to be processed. - a #GdkDisplay + a #GdkDisplay - - Finds out if the display has been closed. + + Finds out if the display has been closed. - %TRUE if the display is closed. + %TRUE if the display is closed. - a #GdkDisplay + a #GdkDisplay - - Release any keyboard grab + + Release any keyboard grab Use gdk_device_ungrab(), together with gdk_device_grab() instead. @@ -5202,34 +3177,22 @@ to be processed. - a #GdkDisplay. + a #GdkDisplay. - a timestap (e.g #GDK_CURRENT_TIME). + a timestap (e.g #GDK_CURRENT_TIME). - - Returns the list of available input devices attached to @display. + + Returns the list of available input devices attached to @display. The list is statically allocated and should not be freed. Use gdk_device_manager_list_devices() instead. - + a list of #GdkDevice @@ -5237,24 +3200,16 @@ The list is statically allocated and should not be freed. - a #GdkDisplay + a #GdkDisplay - - Returns the list of seats known to @display. + + Returns the list of seats known to @display. - the + the list of seats known to the #GdkDisplay @@ -5262,19 +3217,13 @@ The list is statically allocated and should not be freed. - a #GdkDisplay + a #GdkDisplay - - Indicates to the GUI environment that the application has + + Indicates to the GUI environment that the application has finished loading, using a given identifier. GTK+ will call this function automatically for #GtkWindow @@ -5287,80 +3236,52 @@ disable that feature. - a #GdkDisplay + a #GdkDisplay - a startup-notification identifier, for which + a startup-notification identifier, for which notification process should be completed - - Gets a copy of the first #GdkEvent in the @display’s event queue, without + + Gets a copy of the first #GdkEvent in the @display’s event queue, without removing the event from the queue. (Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.) - a copy of the first #GdkEvent on the event + a copy of the first #GdkEvent on the event queue, or %NULL if no events are in the queue. The returned #GdkEvent should be freed with gdk_event_free(). - a #GdkDisplay + a #GdkDisplay - - Test if the pointer is grabbed. + + Test if the pointer is grabbed. Use gdk_display_device_is_grabbed() instead. - %TRUE if an active X pointer grab is in effect + %TRUE if an active X pointer grab is in effect - a #GdkDisplay + a #GdkDisplay - - Release any pointer grab. + + Release any pointer grab. Use gdk_device_ungrab(), together with gdk_device_grab() instead. @@ -5369,25 +3290,17 @@ queue, or %NULL if no events are in the queue. The returned - a #GdkDisplay. + a #GdkDisplay. - a timestap (e.g. %GDK_CURRENT_TIME). + a timestap (e.g. %GDK_CURRENT_TIME). - - Appends a copy of the given event onto the front of the event + + Appends a copy of the given event onto the front of the event queue for @display. @@ -5395,56 +3308,38 @@ queue for @display. - a #GdkDisplay + a #GdkDisplay - a #GdkEvent. + a #GdkEvent. - - Request #GdkEventOwnerChange events for ownership changes + + Request #GdkEventOwnerChange events for ownership changes of the selection named by the given atom. - whether #GdkEventOwnerChange events will + whether #GdkEventOwnerChange events will be sent. - a #GdkDisplay + a #GdkDisplay - the #GdkAtom naming the selection for which + the #GdkAtom naming the selection for which ownership change notification is requested - - Sets the double click distance (two clicks within this distance + + Sets the double click distance (two clicks within this distance count as a double click and result in a #GDK_2BUTTON_PRESS event). See also gdk_display_set_double_click_time(). Applications should not set this, it is a global @@ -5455,25 +3350,17 @@ user-configured setting. - a #GdkDisplay + a #GdkDisplay - distance in pixels + distance in pixels - - Sets the double click time (two clicks within this time interval + + Sets the double click time (two clicks within this time interval count as a double click and result in a #GDK_2BUTTON_PRESS event). Applications should not set this, it is a global user-configured setting. @@ -5483,25 +3370,17 @@ user-configured setting. - a #GdkDisplay + a #GdkDisplay - double click time in milliseconds (thousandths of a second) + double click time in milliseconds (thousandths of a second) - - Issues a request to the clipboard manager to store the + + Issues a request to the clipboard manager to store the clipboard data. On X11, this is a special program that works according to the [FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboard-manager-spec). @@ -5511,30 +3390,19 @@ according to the - a #GdkDisplay + a #GdkDisplay - a #GdkWindow belonging to the clipboard owner + a #GdkWindow belonging to the clipboard owner - a timestamp + a timestamp - - an array of targets + + an array of targets that should be saved, or %NULL if all available targets should be saved. @@ -5542,46 +3410,30 @@ according to the - length of the @targets array + length of the @targets array - - Returns whether the speicifed display supports clipboard -persistance; i.e. if it’s possible to store the clipboard data after an + + Returns whether the speicifed display supports clipboard +persistance; i.e. if it’s possible to store the clipboard data after an application has quit. On X11 this checks if a clipboard daemon is running. - %TRUE if the display supports clipboard persistance. + %TRUE if the display supports clipboard persistance. - a #GdkDisplay + a #GdkDisplay - - Returns %TRUE if gdk_window_set_composited() can be used + + Returns %TRUE if gdk_window_set_composited() can be used to redirect drawing on the window using compositing. Currently this only works on X11 with XComposite and @@ -5590,142 +3442,96 @@ XDamage extensions available. only ever worked on X11. - %TRUE if windows may be composited. + %TRUE if windows may be composited. - a #GdkDisplay + a #GdkDisplay - - Returns %TRUE if cursors can use an 8bit alpha channel + + Returns %TRUE if cursors can use an 8bit alpha channel on @display. Otherwise, cursors are restricted to bilevel alpha (i.e. a mask). - whether cursors can have alpha channels. + whether cursors can have alpha channels. - a #GdkDisplay + a #GdkDisplay - - Returns %TRUE if multicolored cursors are supported + + Returns %TRUE if multicolored cursors are supported on @display. Otherwise, cursors have only a forground and a background color. - whether cursors can have multiple colors. + whether cursors can have multiple colors. - a #GdkDisplay + a #GdkDisplay - - Returns %TRUE if gdk_window_input_shape_combine_mask() can + + Returns %TRUE if gdk_window_input_shape_combine_mask() can be used to modify the input shape of windows on @display. - %TRUE if windows with modified input shape are supported + %TRUE if windows with modified input shape are supported - a #GdkDisplay + a #GdkDisplay - - Returns whether #GdkEventOwnerChange events will be + + Returns whether #GdkEventOwnerChange events will be sent when the owner of a selection changes. - whether #GdkEventOwnerChange events will + whether #GdkEventOwnerChange events will be sent. - a #GdkDisplay + a #GdkDisplay - - Returns %TRUE if gdk_window_shape_combine_mask() can + + Returns %TRUE if gdk_window_shape_combine_mask() can be used to create shaped windows on @display. - %TRUE if shaped windows are supported + %TRUE if shaped windows are supported - a #GdkDisplay + a #GdkDisplay - Flushes any requests queued for the windowing system and waits until all + Flushes any requests queued for the windowing system and waits until all requests have been handled. This is often used for making sure that the display is synchronized with the current state of the program. Calling gdk_display_sync() before gdk_error_trap_pop() makes sure that any errors @@ -5740,21 +3546,13 @@ handled synchronously, this function will do nothing. - a #GdkDisplay + a #GdkDisplay - - Warps the pointer of @display to the point @x,@y on + + Warps the pointer of @display to the point @x,@y on the screen @screen, unless the pointer is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer @@ -5772,135 +3570,98 @@ for the color picker in the #GtkColorSelectionDialog. - a #GdkDisplay + a #GdkDisplay - the screen of @display to warp the pointer to + the screen of @display to warp the pointer to - the x coordinate of the destination + the x coordinate of the destination - the y coordinate of the destination + the y coordinate of the destination - The ::closed signal is emitted when the connection to the windowing + The ::closed signal is emitted when the connection to the windowing system for @display is closed. - %TRUE if the display was closed due to an error + %TRUE if the display was closed due to an error - The ::monitor-added signal is emitted whenever a monitor is + The ::monitor-added signal is emitted whenever a monitor is added. - the monitor that was just added + the monitor that was just added - The ::monitor-removed signal is emitted whenever a monitor is + The ::monitor-removed signal is emitted whenever a monitor is removed. - the monitor that was just removed + the monitor that was just removed - The ::opened signal is emitted when the connection to the windowing + The ::opened signal is emitted when the connection to the windowing system for @display is opened. - The ::seat-added signal is emitted whenever a new seat is made + The ::seat-added signal is emitted whenever a new seat is made known to the windowing system. - the seat that was just added + the seat that was just added - The ::seat-removed signal is emitted whenever a seat is removed + The ::seat-removed signal is emitted whenever a seat is removed by the windowing system. - the seat that was just removed + the seat that was just removed - - The purpose of the #GdkDisplayManager singleton object is to offer + + The purpose of the #GdkDisplayManager singleton object is to offer notification when displays appear or disappear or the default display changes. @@ -5939,12 +3700,8 @@ macros like GDK_IS_X11_DISPLAY() to find out which backend is in use: #endif g_error ("Unsupported GDK backend"); ]| - - Gets the singleton #GdkDisplayManager object. + + Gets the singleton #GdkDisplayManager object. When called for the first time, this function consults the `GDK_BACKEND` environment variable to find out which @@ -5953,48 +3710,32 @@ with multiple backends). Applications can use gdk_set_allowed_backends() to limit what backends can be used. - The global #GdkDisplayManager singleton; + The global #GdkDisplayManager singleton; gdk_parse_args(), gdk_init(), or gdk_init_check() must have been called first. - - Gets the default #GdkDisplay. + + Gets the default #GdkDisplay. - a #GdkDisplay, or %NULL if + a #GdkDisplay, or %NULL if there is no default display. - a #GdkDisplayManager + a #GdkDisplayManager - - List all currently open displays. + + List all currently open displays. - a newly + a newly allocated #GSList of #GdkDisplay objects. Free with g_slist_free() when you are done with it. @@ -6003,63 +3744,43 @@ to limit what backends can be used. - a #GdkDisplayManager + a #GdkDisplayManager - - Opens a display. + + Opens a display. - a #GdkDisplay, or %NULL if the + a #GdkDisplay, or %NULL if the display could not be opened - a #GdkDisplayManager + a #GdkDisplayManager - the name of the display to open + the name of the display to open - - Sets @display as the default display. + + Sets @display as the default display. - a #GdkDisplayManager + a #GdkDisplayManager - a #GdkDisplay + a #GdkDisplay @@ -6068,192 +3789,101 @@ to limit what backends can be used. - The ::display-opened signal is emitted when a display is opened. + The ::display-opened signal is emitted when a display is opened. - the opened display + the opened display - - Used in #GdkDragContext to indicate what the destination + + Used in #GdkDragContext to indicate what the destination should do with the dropped data. - - Means nothing, and should not be used. + + Means nothing, and should not be used. - - Copy the data. + + Copy the data. - - Move the data, i.e. first copy it, then delete + + Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol. - - Add a link to the data. Note that this is only + + Add a link to the data. Note that this is only useful if source and destination agree on what it means. - - Special action which tells the source that the - destination will do something that the source doesn’t understand. + + Special action which tells the source that the + destination will do something that the source doesn’t understand. - - Ask the user what to do with the data. + + Ask the user what to do with the data. - - Used in #GdkDragContext to the reason of a cancelled DND operation. - - There is no suitable drop target. + + Used in #GdkDragContext to the reason of a cancelled DND operation. + + There is no suitable drop target. - - Drag cancelled by the user + + Drag cancelled by the user - - Unspecified error. + + Unspecified error. - - - Determines the bitmask of actions proposed by the source if + + + Determines the bitmask of actions proposed by the source if gdk_drag_context_get_suggested_action() returns %GDK_ACTION_ASK. - the #GdkDragAction flags + the #GdkDragAction flags - a #GdkDragContext + a #GdkDragContext - - Returns the destination window for the DND operation. + + Returns the destination window for the DND operation. - a #GdkWindow + a #GdkWindow - a #GdkDragContext + a #GdkDragContext - Returns the #GdkDevice associated to the drag context. + Returns the #GdkDevice associated to the drag context. - The #GdkDevice associated to @context. + The #GdkDevice associated to @context. - a #GdkDragContext + a #GdkDragContext - - Returns the window on which the drag icon should be rendered + + Returns the window on which the drag icon should be rendered during the drag operation. Note that the window may not be available until the drag operation has begun. GDK will move the window in accordance with the ongoing drag operation. @@ -6261,138 +3891,90 @@ The window is owned by @context and will be destroyed when the drag operation is over. - the drag window, or %NULL + the drag window, or %NULL - a #GdkDragContext + a #GdkDragContext - - Returns the drag protocol that is used by this context. + + Returns the drag protocol that is used by this context. - the drag protocol + the drag protocol - a #GdkDragContext + a #GdkDragContext - - Determines the action chosen by the drag destination. + + Determines the action chosen by the drag destination. - a #GdkDragAction value + a #GdkDragAction value - a #GdkDragContext + a #GdkDragContext - - Returns the #GdkWindow where the DND operation started. + + Returns the #GdkWindow where the DND operation started. - a #GdkWindow + a #GdkWindow - a #GdkDragContext + a #GdkDragContext - - Determines the suggested drag action of the context. + + Determines the suggested drag action of the context. - a #GdkDragAction value + a #GdkDragAction value - a #GdkDragContext + a #GdkDragContext - - Retrieves the list of targets of the context. + + Retrieves the list of targets of the context. - a #GList of targets + a #GList of targets - a #GdkDragContext + a #GdkDragContext - - Requests the drag and drop operation to be managed by @context. + + Requests the drag and drop operation to be managed by @context. When a drag and drop operation becomes managed, the #GdkDragContext will internally handle all input and source-side #GdkEventDND events as required by the windowing system. @@ -6410,36 +3992,26 @@ emit the following signals: cancelled through other means. - #TRUE if the drag and drop operation is managed. + #TRUE if the drag and drop operation is managed. - a #GdkDragContext + a #GdkDragContext - Window to use for IPC messaging/events + Window to use for IPC messaging/events - the actions supported by the drag source + the actions supported by the drag source - Associates a #GdkDevice to @context, so all Drag and Drop events + Associates a #GdkDevice to @context, so all Drag and Drop events for @context are emitted as if they came from this device. @@ -6447,25 +4019,17 @@ for @context are emitted as if they came from this device. - a #GdkDragContext + a #GdkDragContext - a #GdkDevice + a #GdkDevice - - Sets the position of the drag window that will be kept + + Sets the position of the drag window that will be kept under the cursor hotspot. Initially, the hotspot is at the top left corner of the drag window. @@ -6474,29 +4038,21 @@ top left corner of the drag window. - a #GdkDragContext + a #GdkDragContext - x coordinate of the drag window hotspot + x coordinate of the drag window hotspot - y coordinate of the drag window hotspot + y coordinate of the drag window hotspot - A new action is being chosen for the drag and drop operation. + A new action is being chosen for the drag and drop operation. This signal will only be emitted if the #GdkDragContext manages the drag and drop operation. See gdk_drag_context_manage_dnd() @@ -6506,17 +4062,13 @@ for more information. - The action currently chosen + The action currently chosen - The drag and drop operation was cancelled. + The drag and drop operation was cancelled. This signal will only be emitted if the #GdkDragContext manages the drag and drop operation. See gdk_drag_context_manage_dnd() @@ -6526,17 +4078,13 @@ for more information. - The reason the context was cancelled + The reason the context was cancelled - The drag and drop operation was finished, the drag destination + The drag and drop operation was finished, the drag destination finished reading all data. The drag source can now free all miscellaneous data. @@ -6548,9 +4096,7 @@ for more information. - The drag and drop operation was performed on an accepting client. + The drag and drop operation was performed on an accepting client. This signal will only be emitted if the #GdkDragContext manages the drag and drop operation. See gdk_drag_context_manage_dnd() @@ -6560,98 +4106,43 @@ for more information. - the time at which the drop happened. + the time at which the drop happened. - - Used in #GdkDragContext to indicate the protocol according to + + Used in #GdkDragContext to indicate the protocol according to which DND is done. - - no protocol. + + no protocol. - - The Motif DND protocol. No longer supported + + The Motif DND protocol. No longer supported - - The Xdnd protocol. + + The Xdnd protocol. - - An extension to the Xdnd protocol for + + An extension to the Xdnd protocol for unclaimed root window drops. - - The simple WM_DROPFILES protocol. + + The simple WM_DROPFILES protocol. - - The complex OLE2 DND protocol (not implemented). + + The complex OLE2 DND protocol (not implemented). - - Intra-application DND. + + Intra-application DND. - - Wayland DND protocol. + + Wayland DND protocol. - - #GdkDrawingContext is an object that represents the current drawing + + #GdkDrawingContext is an object that represents the current drawing state of a #GdkWindow. It's possible to use a #GdkDrawingContext to draw on a #GdkWindow @@ -6662,12 +4153,8 @@ and will be valid until a call to gdk_window_end_draw_frame(). #GdkDrawingContext is available since GDK 3.22 - - Retrieves a Cairo context to be used to draw on the #GdkWindow + + Retrieves a Cairo context to be used to draw on the #GdkWindow that created the #GdkDrawingContext. The returned context is guaranteed to be valid as long as the @@ -6675,9 +4162,7 @@ The returned context is guaranteed to be valid as long as the gdk_window_begin_draw_frame() and gdk_window_end_draw_frame(). - a Cairo context to be used to draw + a Cairo context to be used to draw the contents of the #GdkWindow. The context is owned by the #GdkDrawingContext and should not be destroyed @@ -6688,129 +4173,74 @@ gdk_window_begin_draw_frame() and gdk_window_end_draw_frame(). - - Retrieves a copy of the clip region used when creating the @context. + + Retrieves a copy of the clip region used when creating the @context. - a Cairo region + a Cairo region - a #GdkDrawingContext + a #GdkDrawingContext - - Retrieves the window that created the drawing @context. + + Retrieves the window that created the drawing @context. - a #GdkWindow + a #GdkWindow - a #GdkDrawingContext + a #GdkDrawingContext - - Checks whether the given #GdkDrawingContext is valid. + + Checks whether the given #GdkDrawingContext is valid. - %TRUE if the context is valid + %TRUE if the context is valid - a #GdkDrawingContext + a #GdkDrawingContext - - The clip region applied to the drawing context. + + The clip region applied to the drawing context. - - The #GdkWindow that created the drawing context. + + The #GdkWindow that created the drawing context. - + - - Use this macro as the return value for continuing the propagation of + + Use this macro as the return value for continuing the propagation of an event handler. - - Use this macro as the return value for stopping the propagation of + + Use this macro as the return value for stopping the propagation of an event handler. - - A #GdkEvent contains a union of all of the event types, + + A #GdkEvent contains a union of all of the event types, and allows access to the data fields in a number of ways. The event type is always the first field in all of the event types, and @@ -6842,330 +4272,213 @@ or: ]| - the #GdkEventType + the #GdkEventType - a #GdkEventAny + a #GdkEventAny - a #GdkEventExpose + a #GdkEventExpose - a #GdkEventVisibility + a #GdkEventVisibility - a #GdkEventMotion + a #GdkEventMotion - a #GdkEventButton + a #GdkEventButton - a #GdkEventTouch + a #GdkEventTouch - a #GdkEventScroll + a #GdkEventScroll - a #GdkEventKey + a #GdkEventKey - a #GdkEventCrossing + a #GdkEventCrossing - a #GdkEventFocus + a #GdkEventFocus - a #GdkEventConfigure + a #GdkEventConfigure - a #GdkEventProperty + a #GdkEventProperty - a #GdkEventSelection + a #GdkEventSelection - a #GdkEventOwnerChange + a #GdkEventOwnerChange - a #GdkEventProximity + a #GdkEventProximity - a #GdkEventDND + a #GdkEventDND - a #GdkEventWindowState + a #GdkEventWindowState - a #GdkEventSetting + a #GdkEventSetting - a #GdkEventGrabBroken + a #GdkEventGrabBroken - a #GdkEventTouchpadSwipe + a #GdkEventTouchpadSwipe - a #GdkEventTouchpadPinch + a #GdkEventTouchpadPinch - a #GdkEventPadButton + a #GdkEventPadButton - a #GdkEventPadAxis + a #GdkEventPadAxis - a #GdkEventPadGroupMode + a #GdkEventPadGroupMode - Creates a new event of the given type. All fields are set to 0. + Creates a new event of the given type. All fields are set to 0. - a newly-allocated #GdkEvent. The returned #GdkEvent + a newly-allocated #GdkEvent. The returned #GdkEvent should be freed with gdk_event_free(). - a #GdkEventType + a #GdkEventType - - If both events contain X/Y information, this function will return %TRUE + + If both events contain X/Y information, this function will return %TRUE and return in @angle the relative angle from @event1 to @event2. The rotation direction for positive angles is from the positive X axis towards the positive Y axis. - %TRUE if the angle could be calculated. + %TRUE if the angle could be calculated. - first #GdkEvent + first #GdkEvent - second #GdkEvent + second #GdkEvent - - return location for the relative angle between both events + + return location for the relative angle between both events - - If both events contain X/Y information, the center of both coordinates + + If both events contain X/Y information, the center of both coordinates will be returned in @x and @y. - %TRUE if the center could be calculated. + %TRUE if the center could be calculated. - first #GdkEvent + first #GdkEvent - second #GdkEvent + second #GdkEvent - - return location for the X coordinate of the center + + return location for the X coordinate of the center - - return location for the Y coordinate of the center + + return location for the Y coordinate of the center - - If both events have X/Y information, the distance between both coordinates + + If both events have X/Y information, the distance between both coordinates (as in a straight line going from @event1 to @event2) will be returned. - %TRUE if the distance could be calculated. + %TRUE if the distance could be calculated. - first #GdkEvent + first #GdkEvent - second #GdkEvent + second #GdkEvent - - return location for the distance + + return location for the distance - Copies a #GdkEvent, copying or incrementing the reference count of the -resources associated with it (e.g. #GdkWindow’s and strings). + Copies a #GdkEvent, copying or incrementing the reference count of the +resources associated with it (e.g. #GdkWindow’s and strings). - a copy of @event. The returned #GdkEvent should be freed with + a copy of @event. The returned #GdkEvent should be freed with gdk_event_free(). - a #GdkEvent + a #GdkEvent - Frees a #GdkEvent, freeing or decrementing any resources associated with it. + Frees a #GdkEvent, freeing or decrementing any resources associated with it. Note that this function should only be called with events returned from functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy() and gdk_event_new(). @@ -7175,182 +4488,109 @@ and gdk_event_new(). - a #GdkEvent. + a #GdkEvent. - Extract the axis value for a particular axis use from + Extract the axis value for a particular axis use from an event structure. - %TRUE if the specified axis was found, otherwise %FALSE + %TRUE if the specified axis was found, otherwise %FALSE - a #GdkEvent + a #GdkEvent - the axis use to look for + the axis use to look for - - location to store the value found + + location to store the value found - - Extract the button number from an event. + + Extract the button number from an event. - %TRUE if the event delivered a button number + %TRUE if the event delivered a button number - a #GdkEvent + a #GdkEvent - - location to store mouse button number + + location to store mouse button number - - Extracts the click count from an event. + + Extracts the click count from an event. - %TRUE if the event delivered a click count + %TRUE if the event delivered a click count - a #GdkEvent + a #GdkEvent - - location to store click count + + location to store click count - Extract the event window relative x/y coordinates from an event. + Extract the event window relative x/y coordinates from an event. - %TRUE if the event delivered event window coordinates + %TRUE if the event delivered event window coordinates - a #GdkEvent + a #GdkEvent - - location to put event window x coordinate + + location to put event window x coordinate - - location to put event window y coordinate + + location to put event window y coordinate - - If the event contains a “device” field, this function will return + + If the event contains a “device” field, this function will return it, else it will return %NULL. - a #GdkDevice, or %NULL. + a #GdkDevice, or %NULL. - a #GdkEvent. + a #GdkEvent. - - If the event was generated by a device that supports + + If the event was generated by a device that supports different tools (eg. a tablet), this function will return a #GdkDeviceTool representing the tool that caused the event. Otherwise, %NULL will be returned. @@ -7360,143 +4600,91 @@ the application lifetime, if settings must be stored persistently across runs, see gdk_device_tool_get_serial() - The current device tool, or %NULL + The current device tool, or %NULL - a #GdkEvent + a #GdkEvent - - If @event if of type %GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE, + + If @event if of type %GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE, %GDK_TOUCH_END or %GDK_TOUCH_CANCEL, returns the #GdkEventSequence to which the event belongs. Otherwise, return %NULL. - the event sequence that the event belongs to + the event sequence that the event belongs to - a #GdkEvent + a #GdkEvent - - Retrieves the type of the event. + + Retrieves the type of the event. - a #GdkEventType + a #GdkEventType - a #GdkEvent + a #GdkEvent - - Extracts the hardware keycode from an event. + + Extracts the hardware keycode from an event. Also see gdk_event_get_scancode(). - %TRUE if the event delivered a hardware keycode + %TRUE if the event delivered a hardware keycode - a #GdkEvent + a #GdkEvent - - location to store the keycode + + location to store the keycode - - Extracts the keyval from an event. + + Extracts the keyval from an event. - %TRUE if the event delivered a key symbol + %TRUE if the event delivered a key symbol - a #GdkEvent + a #GdkEvent - - location to store the keyval + + location to store the keyval - - #event: a #GdkEvent + + #event: a #GdkEvent Returns whether this event is an 'emulated' pointer event (typically from a touch event), as opposed to a real one. - %TRUE if this event is emulated + %TRUE if this event is emulated @@ -7506,79 +4694,47 @@ from a touch event), as opposed to a real one. - Extract the root window relative x/y coordinates from an event. + Extract the root window relative x/y coordinates from an event. - %TRUE if the event delivered root window coordinates + %TRUE if the event delivered root window coordinates - a #GdkEvent + a #GdkEvent - - location to put root window x coordinate + + location to put root window x coordinate - - location to put root window y coordinate + + location to put root window y coordinate - - Gets the keyboard low-level scancode of a key event. + + Gets the keyboard low-level scancode of a key event. This is usually hardware_keycode. On Windows this is the high word of WM_KEY{DOWN,UP} lParam which contains the scancode and some extended flags. - The associated keyboard scancode or 0 + The associated keyboard scancode or 0 - a #GdkEvent + a #GdkEvent - - Returns the screen for the event. The screen is + + Returns the screen for the event. The screen is typically the screen for `event->any.window`, but for events such as mouse events, it is the screen where the pointer was when the event occurs - @@ -7587,69 +4743,43 @@ to which `event->motion.x_root` and `event->motion.y_root` are relative. - the screen for the event + the screen for the event - a #GdkEvent + a #GdkEvent - - Retrieves the scroll deltas from a #GdkEvent + + Retrieves the scroll deltas from a #GdkEvent See also: gdk_event_get_scroll_direction() - %TRUE if the event contains smooth scroll information + %TRUE if the event contains smooth scroll information and %FALSE otherwise - a #GdkEvent + a #GdkEvent - - return location for X delta + + return location for X delta - - return location for Y delta + + return location for Y delta - - Extracts the scroll direction from an event. + + Extracts the scroll direction from an event. If @event is not of type %GDK_SCROLL, the contents of @direction are undefined. @@ -7689,58 +4819,39 @@ gdk_event_get_scroll_deltas(); for instance: ]| - %TRUE if the event delivered a scroll direction + %TRUE if the event delivered a scroll direction and %FALSE otherwise - a #GdkEvent + a #GdkEvent - - location to store the scroll direction + + location to store the scroll direction - Returns the #GdkSeat this event was generated for. + Returns the #GdkSeat this event was generated for. - The #GdkSeat of this event + The #GdkSeat of this event - a #GdkEvent + a #GdkEvent - - This function returns the hardware (slave) #GdkDevice that has + + This function returns the hardware (slave) #GdkDevice that has triggered the event, falling back to the virtual (master) device -(as in gdk_event_get_device()) if the event wasn’t caused by +(as in gdk_event_get_device()) if the event wasn’t caused by interaction with a hardware device. This may happen for example in synthesized crossing events after a #GdkWindow updates its geometry or a grab is acquired/released. @@ -7749,104 +4860,68 @@ If the event does not contain a device field, this function will return %NULL. - a #GdkDevice, or %NULL. + a #GdkDevice, or %NULL. - a #GdkEvent + a #GdkEvent - If the event contains a “state” field, puts that field in @state. Otherwise + If the event contains a “state” field, puts that field in @state. Otherwise stores an empty state (0). Returns %TRUE if there was a state field -in the event. @event may be %NULL, in which case it’s treated +in the event. @event may be %NULL, in which case it’s treated as if the event had no state field. - %TRUE if there was a state field in the event + %TRUE if there was a state field in the event - - a #GdkEvent or %NULL + + a #GdkEvent or %NULL - - return location for state + + return location for state - Returns the time stamp from @event, if there is one; otherwise + Returns the time stamp from @event, if there is one; otherwise returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME. - time stamp field from @event + time stamp field from @event - a #GdkEvent + a #GdkEvent - - Extracts the #GdkWindow associated with an event. + + Extracts the #GdkWindow associated with an event. - The #GdkWindow associated with the event + The #GdkWindow associated with the event - a #GdkEvent + a #GdkEvent - - Check whether a scroll event is a stop scroll event. Scroll sequences + + Check whether a scroll event is a stop scroll event. Scroll sequences with smooth scroll information may provide a stop scroll event once the interaction with the device finishes, e.g. by lifting a finger. This stop scroll event is the signal that a widget may trigger kinetic @@ -7855,25 +4930,19 @@ scrolling based on the current velocity. Stop scroll events always have a a delta of 0/0. - %TRUE if the event is a scroll stop event + %TRUE if the event is a scroll stop event - a #GdkEvent + a #GdkEvent - Appends a copy of the given event onto the front of the event -queue for event->any.window’s display, or the default event + Appends a copy of the given event onto the front of the event +queue for event->any.window’s display, or the default event queue if event->any.window is %NULL. See gdk_display_put_event(). @@ -7881,19 +4950,13 @@ queue if event->any.window is %NULL. See gdk_display_put_event(). - a #GdkEvent. + a #GdkEvent. - - Sets the device for @event to @device. The event must + + Sets the device for @event to @device. The event must have been allocated by GTK+, for instance, by gdk_event_copy(). @@ -7902,53 +4965,34 @@ gdk_event_copy(). - a #GdkEvent + a #GdkEvent - a #GdkDevice + a #GdkDevice - - Sets the device tool for this event, should be rarely used. + + Sets the device tool for this event, should be rarely used. - a #GdkEvent + a #GdkEvent - - tool to set on the event, or %NULL + + tool to set on the event, or %NULL - - Sets the screen for @event to @screen. The event must + + Sets the screen for @event to @screen. The event must have been allocated by GTK+, for instance, by gdk_event_copy(). @@ -7957,25 +5001,17 @@ gdk_event_copy(). - a #GdkEvent + a #GdkEvent - a #GdkScreen + a #GdkScreen - - Sets the slave device for @event to @device. + + Sets the slave device for @event to @device. The event must have been allocated by GTK+, for instance by gdk_event_copy(). @@ -7985,25 +5021,17 @@ for instance by gdk_event_copy(). - a #GdkEvent + a #GdkEvent - a #GdkDevice + a #GdkDevice - - This function returns whether a #GdkEventButton should trigger a + + This function returns whether a #GdkEventButton should trigger a context menu, according to platform conventions. The right mouse button always triggers context menus. Additionally, if gdk_keymap_get_modifier_mask() returns a non-0 mask for @@ -8014,40 +5042,30 @@ This function should always be used instead of simply checking for event->button == %GDK_BUTTON_SECONDARY. - %TRUE if the event should trigger a context menu. + %TRUE if the event should trigger a context menu. - a #GdkEvent, currently only button events are meaningful values + a #GdkEvent, currently only button events are meaningful values - Checks all open displays for a #GdkEvent to process,to be processed + Checks all open displays for a #GdkEvent to process,to be processed on, fetching events from the windowing system if necessary. See gdk_display_get_event(). - the next #GdkEvent to be processed, or %NULL + the next #GdkEvent to be processed, or %NULL if no events are pending. The returned #GdkEvent should be freed with gdk_event_free(). - Sets the function to call to handle all events from GDK. + Sets the function to call to handle all events from GDK. Note that GTK+ uses this to install its own event handler, so it is usually not useful for GTK+ applications. (Although an application @@ -8058,55 +5076,34 @@ events to GTK+.) - - the function to call to handle events from GDK. + + the function to call to handle events from GDK. - - user data to pass to the function. + + user data to pass to the function. - the function to call when the handler function is removed, i.e. when + the function to call when the handler function is removed, i.e. when gdk_event_handler_set() is called with another event handler. - If there is an event waiting in the event queue of some open + If there is an event waiting in the event queue of some open display, returns a copy of it. See gdk_display_peek_event(). - a copy of the first #GdkEvent on some event + a copy of the first #GdkEvent on some event queue, or %NULL if no events are in any queues. The returned #GdkEvent should be freed with gdk_event_free(). - - Request more motion notifies if @event is a motion notify hint event. + + Request more motion notifies if @event is a motion notify hint event. This function should be used instead of gdk_window_get_pointer() to request further motion notifies, because it also works for extension @@ -8129,44 +5126,32 @@ motion events from a %GDK_MOTION_NOTIFY event usually works like this: - a valid #GdkEvent + a valid #GdkEvent - Contains the fields which are common to all event structs. + Contains the fields which are common to all event structs. Any event pointer can safely be cast to a pointer to a #GdkEventAny to access these fields. - the type of the event. + the type of the event. - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - Used for button press and button release events. The + Used for button press and button release events. The @type field will be one of %GDK_BUTTON_PRESS, %GDK_2BUTTON_PRESS, %GDK_3BUTTON_PRESS or %GDK_BUTTON_RELEASE, @@ -8201,199 +5186,137 @@ For a double click to occur, the second button press must occur within button press must also occur within 1/2 second of the first button press. - the type of the event (%GDK_BUTTON_PRESS, %GDK_2BUTTON_PRESS, + the type of the event (%GDK_BUTTON_PRESS, %GDK_2BUTTON_PRESS, %GDK_3BUTTON_PRESS or %GDK_BUTTON_RELEASE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the x coordinate of the pointer relative to the window. + the x coordinate of the pointer relative to the window. - the y coordinate of the pointer relative to the window. + the y coordinate of the pointer relative to the window. - @x, @y translated to the axes of @device, or %NULL if @device is + @x, @y translated to the axes of @device, or %NULL if @device is the mouse. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - the button which was pressed or released, numbered from 1 to 5. + the button which was pressed or released, numbered from 1 to 5. Normally button 1 is the left mouse button, 2 is the middle button, and 3 is the right button. On 2-button mice, the middle button can often be simulated by pressing both mouse buttons together. - the master device that the event originated from. Use + the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device. - the x coordinate of the pointer relative to the root of the + the x coordinate of the pointer relative to the root of the screen. - the y coordinate of the pointer relative to the root of the + the y coordinate of the pointer relative to the root of the screen. - Generated when a window size or position has changed. + Generated when a window size or position has changed. - the type of the event (%GDK_CONFIGURE). + the type of the event (%GDK_CONFIGURE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the new x coordinate of the window, relative to its parent. + the new x coordinate of the window, relative to its parent. - the new y coordinate of the window, relative to its parent. + the new y coordinate of the window, relative to its parent. - the new width of the window. + the new width of the window. - the new height of the window. + the new height of the window. - Generated when the pointer enters or leaves a window. + Generated when the pointer enters or leaves a window. - the type of the event (%GDK_ENTER_NOTIFY or %GDK_LEAVE_NOTIFY). + the type of the event (%GDK_ENTER_NOTIFY or %GDK_LEAVE_NOTIFY). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the window that was entered or left. + the window that was entered or left. - the time of the event in milliseconds. + the time of the event in milliseconds. - the x coordinate of the pointer relative to the window. + the x coordinate of the pointer relative to the window. - the y coordinate of the pointer relative to the window. + the y coordinate of the pointer relative to the window. - the x coordinate of the pointer relative to the root of the screen. + the x coordinate of the pointer relative to the root of the screen. - the y coordinate of the pointer relative to the root of the screen. + the y coordinate of the pointer relative to the root of the screen. - the crossing mode (%GDK_CROSSING_NORMAL, %GDK_CROSSING_GRAB, + the crossing mode (%GDK_CROSSING_NORMAL, %GDK_CROSSING_GRAB, %GDK_CROSSING_UNGRAB, %GDK_CROSSING_GTK_GRAB, %GDK_CROSSING_GTK_UNGRAB or %GDK_CROSSING_STATE_CHANGED). %GDK_CROSSING_GTK_GRAB, %GDK_CROSSING_GTK_UNGRAB, and %GDK_CROSSING_STATE_CHANGED were added in 2.14 and are always synthesized, @@ -8401,161 +5324,113 @@ gdk_event_get_source_device() to get the slave device. - the kind of crossing that happened (%GDK_NOTIFY_INFERIOR, + the kind of crossing that happened (%GDK_NOTIFY_INFERIOR, %GDK_NOTIFY_ANCESTOR, %GDK_NOTIFY_VIRTUAL, %GDK_NOTIFY_NONLINEAR or %GDK_NOTIFY_NONLINEAR_VIRTUAL). - %TRUE if @window is the focus window or an inferior. + %TRUE if @window is the focus window or an inferior. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - Generated during DND operations. + Generated during DND operations. - the type of the event (%GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, + the type of the event (%GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, %GDK_DRAG_MOTION, %GDK_DRAG_STATUS, %GDK_DROP_START or %GDK_DROP_FINISHED). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the #GdkDragContext for the current DND operation. + the #GdkDragContext for the current DND operation. - the time of the event in milliseconds. + the time of the event in milliseconds. - the x coordinate of the pointer relative to the root of the + the x coordinate of the pointer relative to the root of the screen, only set for %GDK_DRAG_MOTION and %GDK_DROP_START. - the y coordinate of the pointer relative to the root of the + the y coordinate of the pointer relative to the root of the screen, only set for %GDK_DRAG_MOTION and %GDK_DROP_START. - Generated when all or part of a window becomes visible and needs to be + Generated when all or part of a window becomes visible and needs to be redrawn. - the type of the event (%GDK_EXPOSE or %GDK_DAMAGE). + the type of the event (%GDK_EXPOSE or %GDK_DAMAGE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - bounding box of @region. + bounding box of @region. - the region that needs to be redrawn. + the region that needs to be redrawn. - the number of contiguous %GDK_EXPOSE events following this one. - The only use for this is “exposure compression”, i.e. handling all + the number of contiguous %GDK_EXPOSE events following this one. + The only use for this is “exposure compression”, i.e. handling all contiguous %GDK_EXPOSE events in one go, though GDK performs some exposure compression so this is not normally needed. - Describes a change of keyboard focus. + Describes a change of keyboard focus. - the type of the event (%GDK_FOCUS_CHANGE). + the type of the event (%GDK_FOCUS_CHANGE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - %TRUE if the window has gained the keyboard focus, %FALSE if + %TRUE if the window has gained the keyboard focus, %FALSE if it has lost the focus. - Specifies the type of function passed to gdk_event_handler_set() to + Specifies the type of function passed to gdk_event_handler_set() to handle all GDK events. @@ -8563,129 +5438,89 @@ handle all GDK events. - the #GdkEvent to process. + the #GdkEvent to process. - - user data set when the event handler was installed with + + user data set when the event handler was installed with gdk_event_handler_set(). - Generated when a pointer or keyboard grab is broken. On X11, this happens + Generated when a pointer or keyboard grab is broken. On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again. Note that implicit grabs (which are initiated by button presses) can also cause #GdkEventGrabBroken events. - the type of the event (%GDK_GRAB_BROKEN) + the type of the event (%GDK_GRAB_BROKEN) - the window which received the event, i.e. the window + the window which received the event, i.e. the window that previously owned the grab - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - %TRUE if a keyboard grab was broken, %FALSE if a pointer + %TRUE if a keyboard grab was broken, %FALSE if a pointer grab was broken - %TRUE if the broken grab was implicit + %TRUE if the broken grab was implicit - If this event is caused by another grab in the same + If this event is caused by another grab in the same application, @grab_window contains the new grab window. Otherwise @grab_window is %NULL. - Describes a key press or key release event. + Describes a key press or key release event. - the type of the event (%GDK_KEY_PRESS or %GDK_KEY_RELEASE). + the type of the event (%GDK_KEY_PRESS or %GDK_KEY_RELEASE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - the key that was pressed or released. See the + the key that was pressed or released. See the `gdk/gdkkeysyms.h` header file for a complete list of GDK key codes. - the length of @string. + the length of @string. - a string containing an approximation of the text that + a string containing an approximation of the text that would result from this keypress. The only correct way to handle text input of text is using input methods (see #GtkIMContext), so this field is deprecated and should never be used. @@ -8699,32 +5534,21 @@ can also cause #GdkEventGrabBroken events. - the raw code of the key that was pressed or released. + the raw code of the key that was pressed or released. - the keyboard group. + the keyboard group. - a flag that indicates if @hardware_keycode is mapped to a + a flag that indicates if @hardware_keycode is mapped to a modifier. Since 2.10 - - A set of bit-flags to indicate which events a window is to receive. + + A set of bit-flags to indicate which events a window is to receive. Most of these masks map onto one or more of the #GdkEventType event types above. @@ -8750,695 +5574,417 @@ with type %GDK_TOUCH_UPDATE, enclosed by two events with type %GDK_TOUCH_BEGIN and %GDK_TOUCH_END (or %GDK_TOUCH_CANCEL). gdk_event_get_event_sequence() returns the event sequence for these events, so different sequences may be distinguished. - - receive expose events + + receive expose events - - receive all pointer motion events + + receive all pointer motion events - - deprecated. see the explanation above + + deprecated. see the explanation above - - receive pointer motion events while any button is pressed + + receive pointer motion events while any button is pressed - - receive pointer motion events while 1 button is pressed + + receive pointer motion events while 1 button is pressed - - receive pointer motion events while 2 button is pressed + + receive pointer motion events while 2 button is pressed - - receive pointer motion events while 3 button is pressed + + receive pointer motion events while 3 button is pressed - - receive button press events + + receive button press events - - receive button release events + + receive button release events - - receive key press events + + receive key press events - - receive key release events + + receive key release events - - receive window enter events + + receive window enter events - - receive window leave events + + receive window leave events - - receive focus change events + + receive focus change events - - receive events about window configuration change + + receive events about window configuration change - - receive property change events + + receive property change events - - receive visibility change events + + receive visibility change events - - receive proximity in events + + receive proximity in events - - receive proximity out events + + receive proximity out events - - receive events about window configuration changes of + + receive events about window configuration changes of child windows - - receive scroll events + + receive scroll events - - receive touch events. Since 3.4 + + receive touch events. Since 3.4 - - receive smooth scrolling events. Since 3.4 + + receive smooth scrolling events. Since 3.4 - - receive touchpad gesture events. Since 3.18 + + receive touchpad gesture events. Since 3.18 - - receive tablet pad events. Since 3.22 + + receive tablet pad events. Since 3.22 - - the combination of all the above event masks. + + the combination of all the above event masks. - Generated when the pointer moves. + Generated when the pointer moves. - the type of the event. + the type of the event. - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the x coordinate of the pointer relative to the window. + the x coordinate of the pointer relative to the window. - the y coordinate of the pointer relative to the window. + the y coordinate of the pointer relative to the window. - @x, @y translated to the axes of @device, or %NULL if @device is + @x, @y translated to the axes of @device, or %NULL if @device is the mouse. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - set to 1 if this event is just a hint, see the + set to 1 if this event is just a hint, see the %GDK_POINTER_MOTION_HINT_MASK value of #GdkEventMask. - the master device that the event originated from. Use + the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device. - the x coordinate of the pointer relative to the root of the + the x coordinate of the pointer relative to the root of the screen. - the y coordinate of the pointer relative to the root of the + the y coordinate of the pointer relative to the root of the screen. - Generated when the owner of a selection changes. On X11, this + Generated when the owner of a selection changes. On X11, this information is only available if the X server supports the XFIXES extension. - the type of the event (%GDK_OWNER_CHANGE). + the type of the event (%GDK_OWNER_CHANGE). - the window which received the event + the window which received the event - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the new owner of the selection, or %NULL if there is none + the new owner of the selection, or %NULL if there is none - the reason for the ownership change as a #GdkOwnerChange value + the reason for the ownership change as a #GdkOwnerChange value - the atom identifying the selection + the atom identifying the selection - the timestamp of the event + the timestamp of the event - the time at which the selection ownership was taken + the time at which the selection ownership was taken over - Generated during %GDK_SOURCE_TABLET_PAD interaction with tactile sensors. + Generated during %GDK_SOURCE_TABLET_PAD interaction with tactile sensors. - the type of the event (%GDK_PAD_RING or %GDK_PAD_STRIP). + the type of the event (%GDK_PAD_RING or %GDK_PAD_STRIP). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the pad group the ring/strip belongs to. A %GDK_SOURCE_TABLET_PAD + the pad group the ring/strip belongs to. A %GDK_SOURCE_TABLET_PAD device may have one or more groups containing a set of buttons/rings/strips each. - number of strip/ring that was interacted. This number is 0-indexed. + number of strip/ring that was interacted. This number is 0-indexed. - The current mode of @group. Different groups in a %GDK_SOURCE_TABLET_PAD + The current mode of @group. Different groups in a %GDK_SOURCE_TABLET_PAD device may have different current modes. - The current value for the given axis. + The current value for the given axis. - Generated during %GDK_SOURCE_TABLET_PAD button presses and releases. + Generated during %GDK_SOURCE_TABLET_PAD button presses and releases. - the type of the event (%GDK_PAD_BUTTON_PRESS or %GDK_PAD_BUTTON_RELEASE). + the type of the event (%GDK_PAD_BUTTON_PRESS or %GDK_PAD_BUTTON_RELEASE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the pad group the button belongs to. A %GDK_SOURCE_TABLET_PAD device + the pad group the button belongs to. A %GDK_SOURCE_TABLET_PAD device may have one or more groups containing a set of buttons/rings/strips each. - The pad button that was pressed. + The pad button that was pressed. - The current mode of @group. Different groups in a %GDK_SOURCE_TABLET_PAD + The current mode of @group. Different groups in a %GDK_SOURCE_TABLET_PAD device may have different current modes. - - Generated during %GDK_SOURCE_TABLET_PAD mode switches in a group. + + Generated during %GDK_SOURCE_TABLET_PAD mode switches in a group. - the type of the event (%GDK_PAD_GROUP_MODE). + the type of the event (%GDK_PAD_GROUP_MODE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the pad group that is switching mode. A %GDK_SOURCE_TABLET_PAD + the pad group that is switching mode. A %GDK_SOURCE_TABLET_PAD device may have one or more groups containing a set of buttons/rings/strips each. - The new mode of @group. Different groups in a %GDK_SOURCE_TABLET_PAD + The new mode of @group. Different groups in a %GDK_SOURCE_TABLET_PAD device may have different current modes. - Describes a property change on a window. + Describes a property change on a window. - the type of the event (%GDK_PROPERTY_NOTIFY). + the type of the event (%GDK_PROPERTY_NOTIFY). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the property that was changed. + the property that was changed. - the time of the event in milliseconds. + the time of the event in milliseconds. - whether the property was changed + whether the property was changed (%GDK_PROPERTY_NEW_VALUE) or deleted (%GDK_PROPERTY_DELETE). - Proximity events are generated when using GDK’s wrapper for the + Proximity events are generated when using GDK’s wrapper for the XInput extension. The XInput extension is an add-on for standard X that allows you to use nonstandard devices such as graphics tablets. A proximity event indicates that the stylus has moved in or out of -contact with the tablet, or perhaps that the user’s finger has moved +contact with the tablet, or perhaps that the user’s finger has moved in or out of contact with a touch screen. This event type will be used pretty rarely. It only is important for XInput aware programs that are drawing their own cursor. - the type of the event (%GDK_PROXIMITY_IN or %GDK_PROXIMITY_OUT). + the type of the event (%GDK_PROXIMITY_IN or %GDK_PROXIMITY_OUT). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the master device that the event originated from. Use + the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device. - Generated from button presses for the buttons 4 to 7. Wheel mice are + Generated from button presses for the buttons 4 to 7. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned. -Some GDK backends can also generate “smooth” scroll events, which +Some GDK backends can also generate “smooth” scroll events, which can be recognized by the %GDK_SCROLL_SMOOTH scroll direction. For these, the scroll deltas can be obtained with gdk_event_get_scroll_deltas(). - the type of the event (%GDK_SCROLL). + the type of the event (%GDK_SCROLL). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the x coordinate of the pointer relative to the window. + the x coordinate of the pointer relative to the window. - the y coordinate of the pointer relative to the window. + the y coordinate of the pointer relative to the window. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - the direction to scroll to (one of %GDK_SCROLL_UP, + the direction to scroll to (one of %GDK_SCROLL_UP, %GDK_SCROLL_DOWN, %GDK_SCROLL_LEFT, %GDK_SCROLL_RIGHT or %GDK_SCROLL_SMOOTH). - the master device that the event originated from. Use + the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device. - the x coordinate of the pointer relative to the root of the + the x coordinate of the pointer relative to the root of the screen. - the y coordinate of the pointer relative to the root of the + the y coordinate of the pointer relative to the root of the screen. - the x coordinate of the scroll delta + the x coordinate of the scroll delta - the y coordinate of the scroll delta + the y coordinate of the scroll delta @@ -9446,109 +5992,73 @@ gdk_event_get_source_device() to get the slave device. - Generated when a selection is requested or ownership of a selection + Generated when a selection is requested or ownership of a selection is taken over by another client application. - the type of the event (%GDK_SELECTION_CLEAR, + the type of the event (%GDK_SELECTION_CLEAR, %GDK_SELECTION_NOTIFY or %GDK_SELECTION_REQUEST). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the selection. + the selection. - the target to which the selection should be converted. + the target to which the selection should be converted. - the property in which to place the result of the conversion. + the property in which to place the result of the conversion. - the time of the event in milliseconds. + the time of the event in milliseconds. - the window on which to place @property or %NULL if none. + the window on which to place @property or %NULL if none. - + - Generated when a setting is modified. + Generated when a setting is modified. - the type of the event (%GDK_SETTING). + the type of the event (%GDK_SETTING). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - what happened to the setting (%GDK_SETTING_ACTION_NEW, + what happened to the setting (%GDK_SETTING_ACTION_NEW, %GDK_SETTING_ACTION_CHANGED or %GDK_SETTING_ACTION_DELETED). - the name of the setting. + the name of the setting. - Used for touch events. + Used for touch events. @type field will be one of %GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE, %GDK_TOUCH_END or %GDK_TOUCH_CANCEL. @@ -9560,289 +6070,198 @@ any number of %GDK_TOUCH_UPDATE events, and ends with a %GDK_TOUCH_END several active sequences at the same time. - the type of the event (%GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE, + the type of the event (%GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE, %GDK_TOUCH_END, %GDK_TOUCH_CANCEL) - the window which received the event + the window which received the event - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the time of the event in milliseconds. + the time of the event in milliseconds. - the x coordinate of the pointer relative to the window + the x coordinate of the pointer relative to the window - the y coordinate of the pointer relative to the window + the y coordinate of the pointer relative to the window - @x, @y translated to the axes of @device, or %NULL if @device is + @x, @y translated to the axes of @device, or %NULL if @device is the mouse - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType - the event sequence that the event belongs to + the event sequence that the event belongs to - whether the event should be used for emulating + whether the event should be used for emulating pointer event - the master device that the event originated from. Use + the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device. - the x coordinate of the pointer relative to the root of the + the x coordinate of the pointer relative to the root of the screen - the y coordinate of the pointer relative to the root of the + the y coordinate of the pointer relative to the root of the screen - Generated during touchpad swipe gestures. + Generated during touchpad swipe gestures. - the type of the event (%GDK_TOUCHPAD_PINCH) + the type of the event (%GDK_TOUCHPAD_PINCH) - the window which received the event + the window which received the event - %TRUE if the event was sent explicitly + %TRUE if the event was sent explicitly - the current phase of the gesture + the current phase of the gesture - The number of fingers triggering the pinch + The number of fingers triggering the pinch - the time of the event in milliseconds + the time of the event in milliseconds - The X coordinate of the pointer + The X coordinate of the pointer - The Y coordinate of the pointer + The Y coordinate of the pointer - Movement delta in the X axis of the swipe focal point + Movement delta in the X axis of the swipe focal point - Movement delta in the Y axis of the swipe focal point + Movement delta in the Y axis of the swipe focal point - The angle change in radians, negative angles + The angle change in radians, negative angles denote counter-clockwise movements - The current scale, relative to that at the time of + The current scale, relative to that at the time of the corresponding %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN event - The X coordinate of the pointer, relative to the + The X coordinate of the pointer, relative to the root of the screen. - The Y coordinate of the pointer, relative to the + The Y coordinate of the pointer, relative to the root of the screen. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - Generated during touchpad swipe gestures. + Generated during touchpad swipe gestures. - the type of the event (%GDK_TOUCHPAD_SWIPE) + the type of the event (%GDK_TOUCHPAD_SWIPE) - the window which received the event + the window which received the event - %TRUE if the event was sent explicitly + %TRUE if the event was sent explicitly - the current phase of the gesture + the current phase of the gesture - The number of fingers triggering the swipe + The number of fingers triggering the swipe - the time of the event in milliseconds + the time of the event in milliseconds - The X coordinate of the pointer + The X coordinate of the pointer - The Y coordinate of the pointer + The Y coordinate of the pointer - Movement delta in the X axis of the swipe focal point + Movement delta in the X axis of the swipe focal point - Movement delta in the Y axis of the swipe focal point + Movement delta in the Y axis of the swipe focal point - The X coordinate of the pointer, relative to the + The X coordinate of the pointer, relative to the root of the screen. - The Y coordinate of the pointer, relative to the + The Y coordinate of the pointer, relative to the root of the screen. - a bit-mask representing the state of + a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See #GdkModifierType. - - Specifies the type of the event. + + Specifies the type of the event. Do not confuse these events with the signals that GTK+ widgets emit. Although many of these events result in corresponding signals being emitted, @@ -9854,534 +6273,251 @@ invalid (eg `Gdk.EventType.2ButtonPress`, where a symbol is not allowed to start with a number). In that case, the aliases %GDK_DOUBLE_BUTTON_PRESS and %GDK_TRIPLE_BUTTON_PRESS can be used instead. - - a special code to indicate a null event. + + a special code to indicate a null event. - - the window manager has requested that the toplevel window be + + the window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar. - - the window has been destroyed. + + the window has been destroyed. - - all or part of the window has become visible and needs to be + + all or part of the window has become visible and needs to be redrawn. - - the pointer (usually a mouse) has moved. + + the pointer (usually a mouse) has moved. - - a mouse button has been pressed. + + a mouse button has been pressed. - - a mouse button has been double-clicked (clicked twice + + a mouse button has been double-clicked (clicked twice within a short period of time). Note that each click also generates a %GDK_BUTTON_PRESS event. - - alias for %GDK_2BUTTON_PRESS, added in 3.6. + + alias for %GDK_2BUTTON_PRESS, added in 3.6. - - a mouse button has been clicked 3 times in a short period + + a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a %GDK_BUTTON_PRESS event. - - alias for %GDK_3BUTTON_PRESS, added in 3.6. + + alias for %GDK_3BUTTON_PRESS, added in 3.6. - - a mouse button has been released. + + a mouse button has been released. - - a key has been pressed. + + a key has been pressed. - - a key has been released. + + a key has been released. - - the pointer has entered the window. + + the pointer has entered the window. - - the pointer has left the window. + + the pointer has left the window. - - the keyboard focus has entered or left the window. + + the keyboard focus has entered or left the window. - - the size, position or stacking order of the window has changed. + + the size, position or stacking order of the window has changed. Note that GTK+ discards these events for %GDK_WINDOW_CHILD windows. - the window has been mapped. + the window has been mapped. - - the window has been unmapped. + + the window has been unmapped. - - a property on the window has been changed or deleted. + + a property on the window has been changed or deleted. - - the application has lost ownership of a selection. + + the application has lost ownership of a selection. - - another application has requested a selection. + + another application has requested a selection. - - a selection has been received. + + a selection has been received. - - an input device has moved into contact with a sensing + + an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet). - - an input device has moved out of contact with a sensing + + an input device has moved out of contact with a sensing surface. - - the mouse has entered the window while a drag is in progress. + + the mouse has entered the window while a drag is in progress. - - the mouse has left the window while a drag is in progress. + + the mouse has left the window while a drag is in progress. - - the mouse has moved in the window while a drag is in + + the mouse has moved in the window while a drag is in progress. - - the status of the drag operation initiated by the window + + the status of the drag operation initiated by the window has changed. - - a drop operation onto the window has started. + + a drop operation onto the window has started. - - the drop operation initiated by the window has completed. + + the drop operation initiated by the window has completed. - - a message has been received from another application. + + a message has been received from another application. - - the window visibility status has changed. + + the window visibility status has changed. - - the scroll wheel was turned + + the scroll wheel was turned - - the state of a window has changed. See #GdkWindowState + + the state of a window has changed. See #GdkWindowState for the possible window states - - a setting has been modified. + + a setting has been modified. - - the owner of a selection has changed. This event type + + the owner of a selection has changed. This event type was added in 2.6 - - a pointer or keyboard grab was broken. This event type + + a pointer or keyboard grab was broken. This event type was added in 2.8. - - the content of the window has been changed. This event type + + the content of the window has been changed. This event type was added in 2.14. - - A new touch event sequence has just started. This event + + A new touch event sequence has just started. This event type was added in 3.4. - - A touch event sequence has been updated. This event type + + A touch event sequence has been updated. This event type was added in 3.4. - - A touch event sequence has finished. This event type + + A touch event sequence has finished. This event type was added in 3.4. - - A touch event sequence has been canceled. This event type + + A touch event sequence has been canceled. This event type was added in 3.4. - - A touchpad swipe gesture event, the current state + + A touchpad swipe gesture event, the current state is determined by its phase field. This event type was added in 3.18. - - A touchpad pinch gesture event, the current state + + A touchpad pinch gesture event, the current state is determined by its phase field. This event type was added in 3.18. - - A tablet pad button press event. This event type + + A tablet pad button press event. This event type was added in 3.22. - - A tablet pad button release event. This event type + + A tablet pad button release event. This event type was added in 3.22. - - A tablet pad axis event from a "ring". This event type was + + A tablet pad axis event from a "ring". This event type was added in 3.22. - - A tablet pad axis event from a "strip". This event type was + + A tablet pad axis event from a "strip". This event type was added in 3.22. - - A tablet pad group mode change. This event type was + + A tablet pad group mode change. This event type was added in 3.22. - - marks the end of the GdkEventType enumeration. Added in 2.18 + + marks the end of the GdkEventType enumeration. Added in 2.18 - - Generated when the window visibility status has changed. + + Generated when the window visibility status has changed. Modern composited windowing systems with pervasive transparency make it impossible to track the visibility of a window reliably, so this event can not be guaranteed to provide useful information. - the type of the event (%GDK_VISIBILITY_NOTIFY). + the type of the event (%GDK_VISIBILITY_NOTIFY). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - the new visibility state (%GDK_VISIBILITY_FULLY_OBSCURED, + the new visibility state (%GDK_VISIBILITY_FULLY_OBSCURED, %GDK_VISIBILITY_PARTIAL or %GDK_VISIBILITY_UNOBSCURED). - Generated when the state of a toplevel window changes. + Generated when the state of a toplevel window changes. - the type of the event (%GDK_WINDOW_STATE). + the type of the event (%GDK_WINDOW_STATE). - the window which received the event. + the window which received the event. - %TRUE if the event was sent explicitly. + %TRUE if the event was sent explicitly. - mask specifying what flags have changed. + mask specifying what flags have changed. - the new window state, a combination of + the new window state, a combination of #GdkWindowState bits. - + - + - + @@ -10389,9 +6525,7 @@ be used instead. - Specifies the type of function used to filter native events before they are + Specifies the type of function used to filter native events before they are converted to GDK events. When a filter is called, @event is unpopulated, except for @@ -10401,80 +6535,39 @@ translation. If the filter translates the event and processing should continue, it should return %GDK_FILTER_TRANSLATE. - a #GdkFilterReturn value. + a #GdkFilterReturn value. - the native event to filter. + the native event to filter. - the GDK event to which the X event will be translated. + the GDK event to which the X event will be translated. - - user data set when the filter was installed. + + user data set when the filter was installed. - - Specifies the result of applying a #GdkFilterFunc to a native event. - - event not handled, continue processing. + + Specifies the result of applying a #GdkFilterFunc to a native event. + + event not handled, continue processing. - - native event translated into a GDK event and stored + + native event translated into a GDK event and stored in the `event` structure that was passed in. - - event handled, terminate processing. + + event handled, terminate processing. - - A #GdkFrameClock tells the application when to update and repaint a + + A #GdkFrameClock tells the application when to update and repaint a window. This may be synced to the vertical refresh rate of the monitor, for example. Even when the frame clock uses a simple timer rather than a hardware-based vertical sync, the frame clock helps @@ -10502,18 +6595,14 @@ timescale as g_get_monotonic_time(), however, it is not the same as g_get_monotonic_time(). The frame time does not advance during the time a frame is being painted, and outside of a frame, an attempt is made so that all calls to gdk_frame_clock_get_frame_time() that -are called at a “similar” time get the same value. This means that +are called at a “similar” time get the same value. This means that if different animations are timed by looking at the difference in time between an initial value from gdk_frame_clock_get_frame_time() and the value inside the #GdkFrameClock::update signal of the clock, they will stay exactly synchronized. - - Starts updates for an animation. Until a matching call to + + Starts updates for an animation. Until a matching call to gdk_frame_clock_end_updating() is made, the frame clock will continually request a new frame with the %GDK_FRAME_CLOCK_PHASE_UPDATE phase. This function may be called multiple times and frames will be @@ -10525,19 +6614,13 @@ number of times. - a #GdkFrameClock + a #GdkFrameClock - - Stops updates for an animation. See the documentation for + + Stops updates for an animation. See the documentation for gdk_frame_clock_begin_updating(). @@ -10545,24 +6628,16 @@ gdk_frame_clock_begin_updating(). - a #GdkFrameClock + a #GdkFrameClock - - Gets the frame timings for the current frame. + + Gets the frame timings for the current frame. - the #GdkFrameTimings for the + the #GdkFrameTimings for the frame currently being processed, or even no frame is being processed, for the previous frame. Before any frames have been processed, returns %NULL. @@ -10570,72 +6645,50 @@ gdk_frame_clock_begin_updating(). - a #GdkFrameClock + a #GdkFrameClock - - A #GdkFrameClock maintains a 64-bit counter that increments for + + A #GdkFrameClock maintains a 64-bit counter that increments for each frame drawn. - inside frame processing, the value of the frame counter + inside frame processing, the value of the frame counter for the current frame. Outside of frame processing, the frame counter for the last frame. - a #GdkFrameClock + a #GdkFrameClock - - Gets the time that should currently be used for animations. Inside -the processing of a frame, it’s the time used to compute the + + Gets the time that should currently be used for animations. Inside +the processing of a frame, it’s the time used to compute the animation position of everything in a frame. Outside of a frame, it's -the time of the conceptual “previous frame,” which may be either -the actual previous frame time, or if that’s too old, an updated +the time of the conceptual “previous frame,” which may be either +the actual previous frame time, or if that’s too old, an updated time. - a timestamp in microseconds, in the timescale of + a timestamp in microseconds, in the timescale of of g_get_monotonic_time(). - a #GdkFrameClock + a #GdkFrameClock - - #GdkFrameClock internally keeps a history of #GdkFrameTimings + + #GdkFrameClock internally keeps a history of #GdkFrameTimings objects for recent frames that can be retrieved with gdk_frame_clock_get_timings(). The set of stored frames is the set from the counter values given by @@ -10643,28 +6696,20 @@ gdk_frame_clock_get_history_start() and gdk_frame_clock_get_frame_counter(), inclusive. - the frame counter value for the oldest frame + the frame counter value for the oldest frame that is available in the internal frame history of the #GdkFrameClock. - a #GdkFrameClock + a #GdkFrameClock - - Using the frame history stored in the frame clock, finds the last + + Using the frame history stored in the frame clock, finds the last known presentation time and refresh interval, and assuming that presentation times are separated by the refresh interval, predicts a presentation time that is a multiple of the refresh @@ -10675,82 +6720,52 @@ interval after the last presentation time, and later than @base_time. - a #GdkFrameClock + a #GdkFrameClock - base time for determining a presentaton time + base time for determining a presentaton time - - a location to store the + + a location to store the determined refresh interval, or %NULL. A default refresh interval of 1/60th of a second will be stored if no history is present. - - a location to store the next + + a location to store the next candidate presentation time after the given base time. 0 will be will be stored if no history is present. - - Retrieves a #GdkFrameTimings object holding timing information + + Retrieves a #GdkFrameTimings object holding timing information for the current frame or a recent frame. The #GdkFrameTimings object may not yet be complete: see gdk_frame_timings_get_complete(). - the #GdkFrameTimings object for + the #GdkFrameTimings object for the specified frame, or %NULL if it is not available. See gdk_frame_clock_get_history_start(). - a #GdkFrameClock + a #GdkFrameClock - the frame counter value identifying the frame to + the frame counter value identifying the frame to be received. - - Asks the frame clock to run a particular phase. The signal + + Asks the frame clock to run a particular phase. The signal corresponding the requested phase will be emitted the next time the frame clock processes. Multiple calls to gdk_frame_clock_request_phase() will be combined together @@ -10766,41 +6781,31 @@ smooth animations. - a #GdkFrameClock + a #GdkFrameClock - the phase that is requested + the phase that is requested - This signal ends processing of the frame. Applications + This signal ends processing of the frame. Applications should generally not handle this signal. - This signal begins processing of the frame. Applications + This signal begins processing of the frame. Applications should generally not handle this signal. - This signal is used to flush pending motion events that + This signal is used to flush pending motion events that are being batched up and compressed together. Applications should not handle this signal. @@ -10808,9 +6813,7 @@ should not handle this signal. - This signal is emitted as the second step of toolkit and + This signal is emitted as the second step of toolkit and application processing of the frame. Any work to update sizes and positions of application elements should be performed. GTK+ normally handles this internally. @@ -10819,9 +6822,7 @@ performed. GTK+ normally handles this internally. - This signal is emitted as the third step of toolkit and + This signal is emitted as the third step of toolkit and application processing of the frame. The frame is repainted. GDK normally handles this internally and produces expose events, which are turned into GTK+ @@ -10831,9 +6832,7 @@ produces expose events, which are turned into GTK+ - This signal is emitted after processing of the frame is + This signal is emitted after processing of the frame is finished, and is handled internally by GTK+ to resume normal event processing. Applications should not handle this signal. @@ -10841,9 +6840,7 @@ event processing. Applications should not handle this signal. - This signal is emitted as the first step of toolkit and + This signal is emitted as the first step of toolkit and application processing of the frame. Animations should be updated using gdk_frame_clock_get_frame_time(). Applications can connect directly to this signal, or @@ -10854,112 +6851,51 @@ interface. - + - - #GdkFrameClockPhase is used to represent the different paint clock + + #GdkFrameClockPhase is used to represent the different paint clock phases that can be requested. The elements of the enumeration correspond to the signals of #GdkFrameClock. - - no phase + + no phase - - corresponds to GdkFrameClock::flush-events. Should not be handled by applications. + + corresponds to GdkFrameClock::flush-events. Should not be handled by applications. - - corresponds to GdkFrameClock::before-paint. Should not be handled by applications. + + corresponds to GdkFrameClock::before-paint. Should not be handled by applications. - - corresponds to GdkFrameClock::update. + + corresponds to GdkFrameClock::update. - - corresponds to GdkFrameClock::layout. + + corresponds to GdkFrameClock::layout. - - corresponds to GdkFrameClock::paint. + + corresponds to GdkFrameClock::paint. - - corresponds to GdkFrameClock::resume-events. Should not be handled by applications. + + corresponds to GdkFrameClock::resume-events. Should not be handled by applications. - - corresponds to GdkFrameClock::after-paint. Should not be handled by applications. + + corresponds to GdkFrameClock::after-paint. Should not be handled by applications. - + - - A #GdkFrameTimings object holds timing information for a single frame -of the application’s displays. To retrieve #GdkFrameTimings objects, + + A #GdkFrameTimings object holds timing information for a single frame +of the application’s displays. To retrieve #GdkFrameTimings objects, use gdk_frame_clock_get_timings() or gdk_frame_clock_get_current_timings(). The information in #GdkFrameTimings is useful for precise synchronization of video with the event or audio streams, and for measuring -quality metrics for the application’s display, such as latency and jitter. +quality metrics for the application’s display, such as latency and jitter. - - The timing information in a #GdkFrameTimings is filled in + + The timing information in a #GdkFrameTimings is filled in incrementally as the frame as drawn and passed off to the window system for processing and display to the user. The accessor functions for #GdkFrameTimings can return 0 to @@ -10970,74 +6906,51 @@ available at all. Once gdk_frame_timings_get_complete() returns will become available and be stored in the #GdkFrameTimings. - %TRUE if all information that will be available + %TRUE if all information that will be available for the frame has been filled in. - a #GdkFrameTimings + a #GdkFrameTimings - - Gets the frame counter value of the #GdkFrameClock when this + + Gets the frame counter value of the #GdkFrameClock when this this frame was drawn. - the frame counter value for this frame + the frame counter value for this frame - a #GdkFrameTimings + a #GdkFrameTimings - - Returns the frame time for the frame. This is the time value + + Returns the frame time for the frame. This is the time value that is typically used to time animations for the frame. See gdk_frame_clock_get_frame_time(). - the frame time for the frame, in the timescale + the frame time for the frame, in the timescale of g_get_monotonic_time() - A #GdkFrameTimings + A #GdkFrameTimings - - Gets the predicted time at which this frame will be displayed. Although + + Gets the predicted time at which this frame will be displayed. Although no predicted time may be available, if one is available, it will be available while the frame is being generated, in contrast to gdk_frame_timings_get_presentation_time(), which is only available @@ -11048,99 +6961,69 @@ that want exact control over latency. For example, a movie player may want this information for Audio/Video synchronization. - The predicted time at which the frame will be presented, + The predicted time at which the frame will be presented, in the timescale of g_get_monotonic_time(), or 0 if no predicted presentation time is available. - a #GdkFrameTimings + a #GdkFrameTimings - - Reurns the presentation time. This is the time at which the frame + + Reurns the presentation time. This is the time at which the frame became visible to the user. - the time the frame was displayed to the user, in the + the time the frame was displayed to the user, in the timescale of g_get_monotonic_time(), or 0 if no presentation time is available. See gdk_frame_timings_get_complete() - a #GdkFrameTimings + a #GdkFrameTimings - - Gets the natural interval between presentation times for + + Gets the natural interval between presentation times for the display that this frame was displayed on. Frame presentation -usually happens during the “vertical blanking interval”. +usually happens during the “vertical blanking interval”. - the refresh interval of the display, in microseconds, + the refresh interval of the display, in microseconds, or 0 if the refresh interval is not available. See gdk_frame_timings_get_complete(). - a #GdkFrameTimings + a #GdkFrameTimings - Increases the reference count of @timings. + Increases the reference count of @timings. - @timings + @timings - a #GdkFrameTimings + a #GdkFrameTimings - - Decreases the reference count of @timings. If @timings + + Decreases the reference count of @timings. If @timings is no longer referenced, it will be freed. @@ -11148,50 +7031,24 @@ is no longer referenced, it will be freed. - a #GdkFrameTimings + a #GdkFrameTimings - - Indicates which monitor (in a multi-head setup) a window should span over + + Indicates which monitor (in a multi-head setup) a window should span over when in fullscreen mode. - - Fullscreen on current monitor only. + + Fullscreen on current monitor only. - - Span across all monitors when fullscreen. + + Span across all monitors when fullscreen. - - #GdkGLContext is an object representing the platform-specific + + #GdkGLContext is an object representing the platform-specific OpenGL drawing context. #GdkGLContexts are created for a #GdkWindow using @@ -11242,12 +7099,8 @@ You can now perform your drawing using OpenGL commands. You can check which #GdkGLContext is the current one by using gdk_gl_context_get_current(); you can also unset any #GdkGLContext that is currently set by calling gdk_gl_context_clear_current(). - - Clears the current #GdkGLContext. + + Clears the current #GdkGLContext. Any OpenGL call after this function returns will be ignored until gdk_gl_context_make_current() is called. @@ -11256,92 +7109,58 @@ until gdk_gl_context_make_current() is called. - - Retrieves the current #GdkGLContext. + + Retrieves the current #GdkGLContext. - the current #GdkGLContext, or %NULL + the current #GdkGLContext, or %NULL - - Retrieves the value set using gdk_gl_context_set_debug_enabled(). + + Retrieves the value set using gdk_gl_context_set_debug_enabled(). - %TRUE if debugging is enabled + %TRUE if debugging is enabled - a #GdkGLContext + a #GdkGLContext - - Retrieves the #GdkDisplay the @context is created for + + Retrieves the #GdkDisplay the @context is created for - a #GdkDisplay or %NULL + a #GdkDisplay or %NULL - a #GdkGLContext + a #GdkGLContext - - Retrieves the value set using gdk_gl_context_set_forward_compatible(). + + Retrieves the value set using gdk_gl_context_set_forward_compatible(). - %TRUE if the context should be forward compatible + %TRUE if the context should be forward compatible - a #GdkGLContext + a #GdkGLContext - - Retrieves the major and minor version requested by calling + + Retrieves the major and minor version requested by calling gdk_gl_context_set_required_version(). @@ -11349,83 +7168,49 @@ gdk_gl_context_set_required_version(). - a #GdkGLContext + a #GdkGLContext - - return location for the major version to request + + return location for the major version to request - - return location for the minor version to request + + return location for the minor version to request - - Retrieves the #GdkGLContext that this @context share data with. + + Retrieves the #GdkGLContext that this @context share data with. - a #GdkGLContext or %NULL + a #GdkGLContext or %NULL - a #GdkGLContext + a #GdkGLContext - - Checks whether the @context is using an OpenGL or OpenGL ES profile. + + Checks whether the @context is using an OpenGL or OpenGL ES profile. - %TRUE if the #GdkGLContext is using an OpenGL ES profile + %TRUE if the #GdkGLContext is using an OpenGL ES profile - a #GdkGLContext + a #GdkGLContext - - Retrieves the OpenGL version of the @context. + + Retrieves the OpenGL version of the @context. The @context must be realized prior to calling this function. @@ -11434,59 +7219,35 @@ The @context must be realized prior to calling this function. - a #GdkGLContext + a #GdkGLContext - - return location for the major version + + return location for the major version - - return location for the minor version + + return location for the minor version - - Retrieves the #GdkWindow used by the @context. + + Retrieves the #GdkWindow used by the @context. - a #GdkWindow or %NULL + a #GdkWindow or %NULL - a #GdkGLContext + a #GdkGLContext - - Whether the #GdkGLContext is in legacy mode or not. + + Whether the #GdkGLContext is in legacy mode or not. The #GdkGLContext must be realized before calling this function. @@ -11504,70 +7265,47 @@ of OpenGL API to use, or whether to do extension discovery, or what kind of shader programs to load. - %TRUE if the GL context is in legacy mode + %TRUE if the GL context is in legacy mode - a #GdkGLContext + a #GdkGLContext - - Makes the @context the current one. + + Makes the @context the current one. - a #GdkGLContext + a #GdkGLContext - - Realizes the given #GdkGLContext. + + Realizes the given #GdkGLContext. It is safe to call this function on a realized #GdkGLContext. - %TRUE if the context is realized + %TRUE if the context is realized - a #GdkGLContext + a #GdkGLContext - - Sets whether the #GdkGLContext should perform extra validations and + + Sets whether the #GdkGLContext should perform extra validations and run time checking. This is useful during development, but has additional overhead. @@ -11579,25 +7317,17 @@ calling this function. - a #GdkGLContext + a #GdkGLContext - whether to enable debugging in the context + whether to enable debugging in the context - - Sets whether the #GdkGLContext should be forward compatible. + + Sets whether the #GdkGLContext should be forward compatible. Forward compatibile contexts must not support OpenGL functionality that has been marked as deprecated in the requested version; non-forward @@ -11612,25 +7342,17 @@ this function. - a #GdkGLContext + a #GdkGLContext - whether the context should be forward compatible + whether the context should be forward compatible - - Sets the major and minor version of OpenGL to request. + + Sets the major and minor version of OpenGL to request. Setting @major and @minor to zero will use the default values. @@ -11642,31 +7364,21 @@ this function. - a #GdkGLContext + a #GdkGLContext - the major version to request + the major version to request - the minor version to request + the minor version to request - - Requests that GDK create a OpenGL ES context instead of an OpenGL one, + + Requests that GDK create a OpenGL ES context instead of an OpenGL one, if the platform and windowing system allows it. The @context must not have been realized. @@ -11684,83 +7396,39 @@ OpenGL ES API, extensions, or shaders. - a #GdkGLContext: + a #GdkGLContext: - whether the context should use OpenGL ES instead of OpenGL, + whether the context should use OpenGL ES instead of OpenGL, or -1 to allow auto-detection - - The #GdkDisplay used to create the #GdkGLContext. + + The #GdkDisplay used to create the #GdkGLContext. - - The #GdkGLContext that this context is sharing data with, or %NULL + + The #GdkGLContext that this context is sharing data with, or %NULL - - The #GdkWindow the gl context is bound to. + + The #GdkWindow the gl context is bound to. - - Error enumeration for #GdkGLContext. - - OpenGL support is not available + + Error enumeration for #GdkGLContext. + + OpenGL support is not available - - The requested visual format is not supported + + The requested visual format is not supported - - The requested profile is not supported + + The requested profile is not supported @@ -11768,9 +7436,7 @@ OpenGL ES API, extensions, or shaders. - + @@ -11778,10 +7444,8 @@ OpenGL ES API, extensions, or shaders. - The #GdkGeometry struct gives the window manager information about -a window’s geometry constraints. Normally you would set these on + The #GdkGeometry struct gives the window manager information about +a window’s geometry constraints. Normally you would set these on the GTK+ level using gtk_window_set_geometry_hints(). #GtkWindow then sets the hints on the #GdkWindow it creates. @@ -11806,10 +7470,10 @@ scrollbar. Then, the @width_inc and @height_inc fields should be set to the size of one character in the terminal. Finally, the base size should be set to the size of one character. The net effect is that the minimum size of the terminal will have a 1x1 character terminal area, and only terminal sizes on -the “character grid” will be allowed. +the “character grid” will be allowed. -Here’s an example of how the terminal example would be implemented, assuming -a terminal area widget called “terminal” and a toplevel window “toplevel”: +Here’s an example of how the terminal example would be implemented, assuming +a terminal area widget called “terminal” and a toplevel window “toplevel”: |[<!-- language="C" --> GdkGeometry hints; @@ -11837,561 +7501,319 @@ window. The most common use of these hints is probably to set @min_aspect and aspect ratio. - minimum width of window (or -1 to use requisition, with + minimum width of window (or -1 to use requisition, with #GtkWindow only) - minimum height of window (or -1 to use requisition, with + minimum height of window (or -1 to use requisition, with #GtkWindow only) - maximum width of window (or -1 to use requisition, with + maximum width of window (or -1 to use requisition, with #GtkWindow only) - maximum height of window (or -1 to use requisition, with + maximum height of window (or -1 to use requisition, with #GtkWindow only) - allowed window widths are @base_width + @width_inc * N where N + allowed window widths are @base_width + @width_inc * N where N is any integer (-1 allowed with #GtkWindow) - allowed window widths are @base_height + @height_inc * N where + allowed window widths are @base_height + @height_inc * N where N is any integer (-1 allowed with #GtkWindow) - width resize increment + width resize increment - height resize increment + height resize increment - minimum width/height ratio + minimum width/height ratio - maximum width/height ratio + maximum width/height ratio - window gravity, see gtk_window_set_gravity() + window gravity, see gtk_window_set_gravity() - - Defines how device grabs interact with other devices. - - All other devices’ events are allowed. + + Defines how device grabs interact with other devices. + + All other devices’ events are allowed. - - Other devices’ events are blocked for the grab window. + + Other devices’ events are blocked for the grab window. - - Other devices’ events are blocked for the whole application. + + Other devices’ events are blocked for the whole application. - - Returned by gdk_device_grab(), gdk_pointer_grab() and gdk_keyboard_grab() to + + Returned by gdk_device_grab(), gdk_pointer_grab() and gdk_keyboard_grab() to indicate success or the reason for the failure of the grab attempt. - - the resource was successfully grabbed. + + the resource was successfully grabbed. - - the resource is actively grabbed by another client. + + the resource is actively grabbed by another client. - - the resource was grabbed more recently than the + + the resource was grabbed more recently than the specified time. - - the grab window or the @confine_to window are not + + the grab window or the @confine_to window are not viewable. - - the resource is frozen by an active grab of another client. + + the resource is frozen by an active grab of another client. - - the grab failed for some other reason. Since 3.16 + + the grab failed for some other reason. Since 3.16 - - Defines the reference point of a window and the meaning of coordinates + + Defines the reference point of a window and the meaning of coordinates passed to gtk_window_move(). See gtk_window_move() and the "implementation notes" section of the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification for more details. - - the reference point is at the top left corner. + + the reference point is at the top left corner. - - the reference point is in the middle of the top edge. + + the reference point is in the middle of the top edge. - - the reference point is at the top right corner. + + the reference point is at the top right corner. - - the reference point is at the middle of the left edge. + + the reference point is at the middle of the left edge. - - the reference point is at the center of the window. + + the reference point is at the center of the window. - - the reference point is at the middle of the right edge. + + the reference point is at the middle of the right edge. - - the reference point is at the lower left corner. + + the reference point is at the lower left corner. - - the reference point is at the middle of the lower edge. + + the reference point is at the middle of the lower edge. - - the reference point is at the lower right corner. + + the reference point is at the lower right corner. - - the reference point is at the top left corner of the + + the reference point is at the top left corner of the window itself, ignoring window manager decorations. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - An enumeration that describes the mode of an input device. - - the device is disabled and will not report any events. + + An enumeration that describes the mode of an input device. + + the device is disabled and will not report any events. - - the device is enabled. The device’s coordinate space + + the device is enabled. The device’s coordinate space maps to the entire screen. - - the device is enabled. The device’s coordinate space + + the device is enabled. The device’s coordinate space is mapped to a single window. The manner in which this window is chosen is undefined, but it will typically be the same way in which the focus window for key events is determined. - - An enumeration describing the type of an input device in general terms. - - the device is a mouse. (This will be reported for the core + + An enumeration describing the type of an input device in general terms. + + the device is a mouse. (This will be reported for the core pointer, even if it is something else, such as a trackball.) - - the device is a stylus of a graphics tablet or similar device. + + the device is a stylus of a graphics tablet or similar device. - - the device is an eraser. Typically, this would be the other end + + the device is an eraser. Typically, this would be the other end of a stylus on a graphics tablet. - - the device is a graphics tablet “puck” or similar device. + + the device is a graphics tablet “puck” or similar device. - - the device is a keyboard. + + the device is a keyboard. - - the device is a direct-input touch device, such + + the device is a direct-input touch device, such as a touchscreen or tablet. This device type has been added in 3.4. - - the device is an indirect touch device, such + + the device is an indirect touch device, such as a touchpad. This device type has been added in 3.4. - - the device is a trackpoint. This device type has been + + the device is a trackpoint. This device type has been added in 3.22 - - the device is a "pad", a collection of buttons, + + the device is a "pad", a collection of buttons, rings and strips found in drawing tablets. This device type has been added in 3.22. @@ -12419,9 +7841,7 @@ specification for more details. - + @@ -12429,15 +7849,11 @@ specification for more details. - + - + @@ -12445,27 +7861,19 @@ specification for more details. - + - + - + - + @@ -12473,27 +7881,19 @@ specification for more details. - + - + - + - + @@ -12505,9 +7905,7 @@ specification for more details. - + @@ -12531,9 +7929,7 @@ specification for more details. - + @@ -12541,9 +7937,7 @@ specification for more details. - + @@ -12551,9 +7945,7 @@ specification for more details. - + @@ -12613,45 +8005,31 @@ specification for more details. - + - + - + - + - + - + - + @@ -12659,39 +8037,27 @@ specification for more details. - + - + - + - + - + - + @@ -12723,15 +8089,11 @@ specification for more details. - + - + @@ -12783,9 +8145,7 @@ specification for more details. - + @@ -12793,9 +8153,7 @@ specification for more details. - + @@ -12807,39 +8165,27 @@ specification for more details. - + - + - + - + - + - + @@ -12847,21 +8193,15 @@ specification for more details. - + - + - + @@ -12873,45 +8213,31 @@ specification for more details. - + - + - + - + - + - + - + @@ -12919,15 +8245,11 @@ specification for more details. - + - + @@ -12935,9 +8257,7 @@ specification for more details. - + @@ -12945,21 +8265,15 @@ specification for more details. - + - + - + @@ -12971,15 +8285,11 @@ specification for more details. - + - + @@ -12991,21 +8301,15 @@ specification for more details. - + - + - + @@ -13013,9 +8317,7 @@ specification for more details. - + @@ -13023,9 +8325,7 @@ specification for more details. - + @@ -13037,39 +8337,27 @@ specification for more details. - + - + - + - + - + - + @@ -13077,15 +8365,11 @@ specification for more details. - + - + @@ -13093,9 +8377,7 @@ specification for more details. - + @@ -13107,15 +8389,11 @@ specification for more details. - + - + @@ -13127,9 +8405,7 @@ specification for more details. - + @@ -13145,543 +8421,363 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -13689,111 +8785,75 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -13813,9 +8873,7 @@ specification for more details. - + @@ -13835,9 +8893,7 @@ specification for more details. - + @@ -13845,9 +8901,7 @@ specification for more details. - + @@ -13855,21 +8909,15 @@ specification for more details. - + - + - + @@ -13901,9 +8949,7 @@ specification for more details. - + @@ -13939,9 +8985,7 @@ specification for more details. - + @@ -13957,15 +9001,11 @@ specification for more details. - + - + @@ -13981,9 +9021,7 @@ specification for more details. - + @@ -13991,9 +9029,7 @@ specification for more details. - + @@ -14005,21 +9041,15 @@ specification for more details. - + - + - + @@ -14027,9 +9057,7 @@ specification for more details. - + @@ -14053,9 +9081,7 @@ specification for more details. - + @@ -14067,15 +9093,11 @@ specification for more details. - + - + @@ -14083,15 +9105,11 @@ specification for more details. - + - + @@ -14107,9 +9125,7 @@ specification for more details. - + @@ -14121,27 +9137,19 @@ specification for more details. - + - + - + - + @@ -14149,9 +9157,7 @@ specification for more details. - + @@ -14159,39 +9165,27 @@ specification for more details. - + - + - + - + - + - + @@ -14199,9 +9193,7 @@ specification for more details. - + @@ -14209,21 +9201,15 @@ specification for more details. - + - + - + @@ -14235,9 +9221,7 @@ specification for more details. - + @@ -14249,15 +9233,11 @@ specification for more details. - + - + @@ -14269,21 +9249,15 @@ specification for more details. - + - + - + @@ -14291,9 +9265,7 @@ specification for more details. - + @@ -14317,9 +9289,7 @@ specification for more details. - + @@ -14331,15 +9301,11 @@ specification for more details. - + - + @@ -14347,15 +9313,11 @@ specification for more details. - + - + @@ -14363,9 +9325,7 @@ specification for more details. - + @@ -14385,27 +9345,19 @@ specification for more details. - + - + - + - + @@ -14413,9 +9365,7 @@ specification for more details. - + @@ -14423,39 +9373,27 @@ specification for more details. - + - + - + - + - + - + @@ -14463,9 +9401,7 @@ specification for more details. - + @@ -14473,21 +9409,15 @@ specification for more details. - + - + - + @@ -14499,9 +9429,7 @@ specification for more details. - + @@ -14513,15 +9441,11 @@ specification for more details. - + - + @@ -14549,9 +9473,7 @@ specification for more details. - + @@ -14603,33 +9525,23 @@ specification for more details. - + - + - + - + - + @@ -14653,9 +9565,7 @@ specification for more details. - + @@ -14847,9 +9757,7 @@ specification for more details. - + @@ -14901,9 +9809,7 @@ specification for more details. - + @@ -14915,9 +9821,7 @@ specification for more details. - + @@ -14925,15 +9829,11 @@ specification for more details. - + - + @@ -14965,237 +9865,159 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -15207,9 +10029,7 @@ specification for more details. - + @@ -15225,15 +10045,11 @@ specification for more details. - + - + @@ -15241,9 +10057,7 @@ specification for more details. - + @@ -15255,21 +10069,15 @@ specification for more details. - + - + - + @@ -15277,9 +10085,7 @@ specification for more details. - + @@ -15299,21 +10105,15 @@ specification for more details. - + - + - + @@ -15345,21 +10145,15 @@ specification for more details. - + - + - + @@ -15371,9 +10165,7 @@ specification for more details. - + @@ -15381,9 +10173,7 @@ specification for more details. - + @@ -15399,15 +10189,11 @@ specification for more details. - + - + @@ -15415,15 +10201,11 @@ specification for more details. - + - + @@ -15431,9 +10213,7 @@ specification for more details. - + @@ -15441,21 +10221,15 @@ specification for more details. - + - + - + @@ -15463,9 +10237,7 @@ specification for more details. - + @@ -15485,21 +10257,15 @@ specification for more details. - + - + - + @@ -15523,9 +10289,7 @@ specification for more details. - + @@ -15537,27 +10301,19 @@ specification for more details. - + - + - + - + @@ -15589,39 +10345,27 @@ specification for more details. - + - + - + - + - + - + @@ -15641,15 +10385,11 @@ specification for more details. - + - + @@ -15657,261 +10397,175 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -15923,111 +10577,75 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -16035,69 +10653,47 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + @@ -16153,15 +10749,11 @@ specification for more details. - + - + @@ -16173,9 +10765,7 @@ specification for more details. - + @@ -16187,15 +10777,11 @@ specification for more details. - + - + @@ -16203,9 +10789,7 @@ specification for more details. - + @@ -16241,27 +10825,19 @@ specification for more details. - + - + - + - + @@ -16269,117 +10845,79 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -16387,93 +10925,63 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -16641,9 +11149,7 @@ specification for more details. - + @@ -16651,9 +11157,7 @@ specification for more details. - + @@ -16669,9 +11173,7 @@ specification for more details. - + @@ -16679,9 +11181,7 @@ specification for more details. - + @@ -16705,9 +11205,7 @@ specification for more details. - + @@ -16715,21 +11213,15 @@ specification for more details. - + - + - + @@ -16793,9 +11285,7 @@ specification for more details. - + @@ -16879,9 +11369,7 @@ specification for more details. - + @@ -16893,9 +11381,7 @@ specification for more details. - + @@ -16903,9 +11389,7 @@ specification for more details. - + @@ -16921,39 +11405,27 @@ specification for more details. - + - + - + - + - + - + @@ -16965,9 +11437,7 @@ specification for more details. - + @@ -16999,9 +11469,7 @@ specification for more details. - + @@ -17021,33 +11489,23 @@ specification for more details. - + - + - + - + - + @@ -17059,9 +11517,7 @@ specification for more details. - + @@ -17069,9 +11525,7 @@ specification for more details. - + @@ -17103,9 +11557,7 @@ specification for more details. - + @@ -17117,15 +11569,11 @@ specification for more details. - + - + @@ -17165,33 +11613,23 @@ specification for more details. - + - + - + - + - + @@ -17199,15 +11637,11 @@ specification for more details. - + - + @@ -17223,21 +11657,15 @@ specification for more details. - + - + - + @@ -17245,9 +11673,7 @@ specification for more details. - + @@ -17279,15 +11705,11 @@ specification for more details. - + - + @@ -17315,9 +11737,7 @@ specification for more details. - + @@ -17329,165 +11749,111 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -17495,21 +11861,15 @@ specification for more details. - + - + - + @@ -17517,21 +11877,15 @@ specification for more details. - + - + - + @@ -17643,9 +11997,7 @@ specification for more details. - + @@ -17661,15 +12013,11 @@ specification for more details. - + - + @@ -17681,21 +12029,15 @@ specification for more details. - + - + - + @@ -17735,21 +12077,15 @@ specification for more details. - + - + - + @@ -17757,9 +12093,7 @@ specification for more details. - + @@ -17771,9 +12105,7 @@ specification for more details. - + @@ -17801,9 +12133,7 @@ specification for more details. - + @@ -17827,9 +12157,7 @@ specification for more details. - + @@ -17849,9 +12177,7 @@ specification for more details. - + @@ -18007,9 +12333,7 @@ specification for more details. - + @@ -18181,9 +12505,7 @@ specification for more details. - + @@ -18191,9 +12513,7 @@ specification for more details. - + @@ -18205,9 +12525,7 @@ specification for more details. - + @@ -18235,75 +12553,51 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + @@ -18343,9 +12637,7 @@ specification for more details. - + @@ -18353,39 +12645,27 @@ specification for more details. - + - + - + - + - + - + @@ -18405,39 +12685,27 @@ specification for more details. - + - + - + - + - + - + @@ -18445,15 +12713,11 @@ specification for more details. - + - + @@ -18469,15 +12733,11 @@ specification for more details. - + - + @@ -18489,9 +12749,7 @@ specification for more details. - + @@ -18499,9 +12757,7 @@ specification for more details. - + @@ -18513,9 +12769,7 @@ specification for more details. - + @@ -18523,21 +12777,15 @@ specification for more details. - + - + - + @@ -18549,9 +12797,7 @@ specification for more details. - + @@ -18563,9 +12809,7 @@ specification for more details. - + @@ -18581,33 +12825,23 @@ specification for more details. - + - + - + - + - + @@ -18635,15 +12869,11 @@ specification for more details. - + - + @@ -18675,9 +12905,7 @@ specification for more details. - + @@ -18701,51 +12929,35 @@ specification for more details. - + - + - + - + - + - + - + - + @@ -18785,21 +12997,15 @@ specification for more details. - + - + - + @@ -18843,9 +13049,7 @@ specification for more details. - + @@ -18861,21 +13065,15 @@ specification for more details. - + - + - + @@ -18883,15 +13081,11 @@ specification for more details. - + - + @@ -18899,21 +13093,15 @@ specification for more details. - + - + - + @@ -18921,15 +13109,11 @@ specification for more details. - + - + @@ -19001,9 +13185,7 @@ specification for more details. - + @@ -19015,9 +13197,7 @@ specification for more details. - + @@ -19045,15 +13225,11 @@ specification for more details. - + - + @@ -19065,15 +13241,11 @@ specification for more details. - + - + @@ -19109,9 +13281,7 @@ specification for more details. - + @@ -19159,9 +13329,7 @@ specification for more details. - + @@ -19197,33 +13365,23 @@ specification for more details. - + - + - + - + - + @@ -19231,33 +13389,23 @@ specification for more details. - + - + - + - + - + @@ -19361,39 +13509,27 @@ specification for more details. - + - + - + - + - + - + @@ -19401,9 +13537,7 @@ specification for more details. - + @@ -19423,1599 +13557,1067 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -21079,9 +14681,7 @@ specification for more details. - + @@ -21105,9 +14705,7 @@ specification for more details. - + @@ -21119,9 +14717,7 @@ specification for more details. - + @@ -21177,33 +14773,23 @@ specification for more details. - + - + - + - + - + @@ -21211,57 +14797,39 @@ specification for more details. - + - + - + - + - + - + - + - + - + @@ -21269,9 +14837,7 @@ specification for more details. - + @@ -21279,21 +14845,15 @@ specification for more details. - + - + - + @@ -21301,21 +14861,15 @@ specification for more details. - + - + - + @@ -21343,9 +14897,7 @@ specification for more details. - + @@ -21353,21 +14905,15 @@ specification for more details. - + - + - + @@ -21375,15 +14921,11 @@ specification for more details. - + - + @@ -21391,21 +14933,15 @@ specification for more details. - + - + - + @@ -21417,15 +14953,11 @@ specification for more details. - + - + @@ -21457,9 +14989,7 @@ specification for more details. - + @@ -21467,15 +14997,11 @@ specification for more details. - + - + @@ -21527,33 +15053,23 @@ specification for more details. - + - + - + - + - + @@ -21569,15 +15085,11 @@ specification for more details. - + - + @@ -21605,27 +15117,19 @@ specification for more details. - + - + - + - + @@ -21641,15 +15145,11 @@ specification for more details. - + - + @@ -21657,15 +15157,11 @@ specification for more details. - + - + @@ -21709,9 +15205,7 @@ specification for more details. - + @@ -21723,33 +15217,23 @@ specification for more details. - + - + - + - + - + @@ -21761,15 +15245,11 @@ specification for more details. - + - + @@ -21777,21 +15257,15 @@ specification for more details. - + - + - + @@ -21831,21 +15305,15 @@ specification for more details. - + - + - + @@ -21865,9 +15333,7 @@ specification for more details. - + @@ -21887,69 +15353,47 @@ specification for more details. - + - + - + - + - + - + - + - + - + - + - + @@ -21969,9 +15413,7 @@ specification for more details. - + @@ -21995,15 +15437,11 @@ specification for more details. - + - + @@ -22047,9 +15485,7 @@ specification for more details. - + @@ -22057,39 +15493,27 @@ specification for more details. - + - + - + - + - + - + @@ -22177,9 +15601,7 @@ specification for more details. - + @@ -22407,9 +15829,7 @@ specification for more details. - + @@ -22417,9 +15837,7 @@ specification for more details. - + @@ -22427,9 +15845,7 @@ specification for more details. - + @@ -22437,9 +15853,7 @@ specification for more details. - + @@ -22447,15 +15861,11 @@ specification for more details. - + - + @@ -22519,9 +15929,7 @@ specification for more details. - + @@ -22533,21 +15941,15 @@ specification for more details. - + - + - + @@ -22563,9 +15965,7 @@ specification for more details. - + @@ -22581,9 +15981,7 @@ specification for more details. - + @@ -22599,15 +15997,11 @@ specification for more details. - + - + @@ -22631,9 +16025,7 @@ specification for more details. - + @@ -22665,9 +16057,7 @@ specification for more details. - + @@ -22691,15 +16081,11 @@ specification for more details. - + - + @@ -22707,21 +16093,15 @@ specification for more details. - + - + - + @@ -22729,9 +16109,7 @@ specification for more details. - + @@ -22775,33 +16153,23 @@ specification for more details. - + - + - + - + - + @@ -22809,9 +16177,7 @@ specification for more details. - + @@ -22835,21 +16201,15 @@ specification for more details. - + - + - + @@ -22857,9 +16217,7 @@ specification for more details. - + @@ -22887,9 +16245,7 @@ specification for more details. - + @@ -22905,9 +16261,7 @@ specification for more details. - + @@ -22915,15 +16269,11 @@ specification for more details. - + - + @@ -22967,15 +16317,11 @@ specification for more details. - + - + @@ -22987,9 +16333,7 @@ specification for more details. - + @@ -22997,9 +16341,7 @@ specification for more details. - + @@ -23011,15 +16353,11 @@ specification for more details. - + - + @@ -23039,9 +16377,7 @@ specification for more details. - + @@ -23081,9 +16417,7 @@ specification for more details. - + @@ -23095,33 +16429,23 @@ specification for more details. - + - + - + - + - + @@ -23129,9 +16453,7 @@ specification for more details. - + @@ -23171,9 +16493,7 @@ specification for more details. - + @@ -23189,33 +16509,23 @@ specification for more details. - + - + - + - + - + @@ -23223,27 +16533,19 @@ specification for more details. - + - + - + - + @@ -23251,9 +16553,7 @@ specification for more details. - + @@ -23261,9 +16561,7 @@ specification for more details. - + @@ -23299,9 +16597,7 @@ specification for more details. - + @@ -23317,9 +16613,7 @@ specification for more details. - + @@ -23327,21 +16621,15 @@ specification for more details. - + - + - + @@ -23353,45 +16641,31 @@ specification for more details. - + - + - + - + - + - + - + @@ -23399,9 +16673,7 @@ specification for more details. - + @@ -23409,9 +16681,7 @@ specification for more details. - + @@ -23423,9 +16693,7 @@ specification for more details. - + @@ -23461,9 +16729,7 @@ specification for more details. - + @@ -23479,21 +16745,15 @@ specification for more details. - + - + - + @@ -23501,9 +16761,7 @@ specification for more details. - + @@ -23535,15 +16793,11 @@ specification for more details. - + - + @@ -23579,9 +16833,7 @@ specification for more details. - + @@ -23601,15 +16853,11 @@ specification for more details. - + - + @@ -23637,9 +16885,7 @@ specification for more details. - + @@ -23679,15 +16925,11 @@ specification for more details. - + - + @@ -23695,64 +16937,38 @@ specification for more details. - - A #GdkKeymap defines the translation from keyboard state + + A #GdkKeymap defines the translation from keyboard state (including a hardware key, a modifier mask, and active keyboard group) to a keyval. This translation has two phases. The first phase is to determine the effective keyboard group and level for the keyboard state; the second phase is to look up the keycode/group/level triplet in the keymap and see what keyval it corresponds to. - - Returns the #GdkKeymap attached to the default display. + + Returns the #GdkKeymap attached to the default display. Use gdk_keymap_get_for_display() instead - the #GdkKeymap attached to the default display. + the #GdkKeymap attached to the default display. - - Returns the #GdkKeymap attached to @display. + + Returns the #GdkKeymap attached to @display. - the #GdkKeymap attached to @display. + the #GdkKeymap attached to @display. - the #GdkDisplay. + the #GdkDisplay. - - Maps the non-virtual modifiers (i.e Mod2, Mod3, ...) which are set + + Maps the non-virtual modifiers (i.e Mod2, Mod3, ...) which are set in @state to the virtual modifiers (i.e. Super, Hyper and Meta) and set the corresponding bits in @state. @@ -23768,71 +16984,47 @@ accelerators. - a #GdkKeymap + a #GdkKeymap - - pointer to the modifier mask to change + + pointer to the modifier mask to change - - Returns whether the Caps Lock modifer is locked. + + Returns whether the Caps Lock modifer is locked. - %TRUE if Caps Lock is on + %TRUE if Caps Lock is on - a #GdkKeymap + a #GdkKeymap - Returns the direction of effective layout of the keymap. + Returns the direction of effective layout of the keymap. - %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL + %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL if it can determine the direction. %PANGO_DIRECTION_NEUTRAL otherwise. - a #GdkKeymap + a #GdkKeymap - - Returns the keyvals bound to @hardware_keycode. + + Returns the keyvals bound to @hardware_keycode. The Nth #GdkKeymapKey in @keys is bound to the Nth keyval in @keyvals. Free the returned arrays with g_free(). When a keycode is pressed by the user, the keyval from @@ -23840,68 +17032,40 @@ this list of entries is selected by considering the effective keyboard group and level. See gdk_keymap_translate_keyboard_state(). - %TRUE if there were any entries + %TRUE if there were any entries - a #GdkKeymap + a #GdkKeymap - a keycode + a keycode - - return + + return location for array of #GdkKeymapKey, or %NULL - - return + + return location for array of keyvals, or %NULL - - length of @keys and @keyvals + + length of @keys and @keyvals - - Obtains a list of keycode/group/level combinations that will + + Obtains a list of keycode/group/level combinations that will generate @keyval. Groups and levels are two kinds of keyboard mode; in general, the level determines whether the top or bottom symbol on a key is used, and the group determines whether the left or @@ -23914,53 +17078,33 @@ The returned array should be freed with g_free(). - %TRUE if keys were found and returned + %TRUE if keys were found and returned - a #GdkKeymap + a #GdkKeymap - a keyval, such as %GDK_KEY_a, %GDK_KEY_Up, %GDK_KEY_Return, etc. + a keyval, such as %GDK_KEY_a, %GDK_KEY_Up, %GDK_KEY_Return, etc. - - return location + + return location for an array of #GdkKeymapKey - - return location for number of elements in returned array + + return location for number of elements in returned array - - Returns the modifier mask the @keymap’s windowing system backend + + Returns the modifier mask the @keymap’s windowing system backend uses for a particular purpose. Note that this function always returns real hardware modifiers, not @@ -23971,151 +17115,101 @@ by gdk_keymap_add_virtual_modifiers() in order to contain the expected result. - the modifier mask used for @intent. + the modifier mask used for @intent. - a #GdkKeymap + a #GdkKeymap - the use case for the modifier mask + the use case for the modifier mask - - Returns the current modifier state. + + Returns the current modifier state. - the current modifier state. + the current modifier state. - a #GdkKeymap + a #GdkKeymap - - Returns whether the Num Lock modifer is locked. + + Returns whether the Num Lock modifer is locked. - %TRUE if Num Lock is on + %TRUE if Num Lock is on - a #GdkKeymap + a #GdkKeymap - - Returns whether the Scroll Lock modifer is locked. + + Returns whether the Scroll Lock modifer is locked. - %TRUE if Scroll Lock is on + %TRUE if Scroll Lock is on - a #GdkKeymap + a #GdkKeymap - - Determines if keyboard layouts for both right-to-left and left-to-right + + Determines if keyboard layouts for both right-to-left and left-to-right languages are in use. - %TRUE if there are layouts in both directions, %FALSE otherwise + %TRUE if there are layouts in both directions, %FALSE otherwise - a #GdkKeymap + a #GdkKeymap - Looks up the keyval mapped to a keycode/group/level triplet. + Looks up the keyval mapped to a keycode/group/level triplet. If no keyval is bound to @key, returns 0. For normal user input, you want to use gdk_keymap_translate_keyboard_state() instead of this function, since the effective group/level may not be the same as the current keyboard state. - a keyval, or 0 if none was mapped to the given @key + a keyval, or 0 if none was mapped to the given @key - a #GdkKeymap + a #GdkKeymap - a #GdkKeymapKey with keycode, group, and level initialized + a #GdkKeymapKey with keycode, group, and level initialized - - Maps the virtual modifiers (i.e. Super, Hyper and Meta) which + + Maps the virtual modifiers (i.e. Super, Hyper and Meta) which are set in @state to their non-virtual counterparts (i.e. Mod2, Mod3,...) and set the corresponding bits in @state. @@ -24123,9 +17217,7 @@ This function is useful when matching key events against accelerators. - %FALSE if two virtual modifiers were mapped to the + %FALSE if two virtual modifiers were mapped to the same non-virtual modifier. Note that %FALSE is also returned if a virtual modifier is mapped to a non-virtual modifier that was already set in @state. @@ -24133,27 +17225,17 @@ accelerators. - a #GdkKeymap + a #GdkKeymap - - pointer to the modifier state to map + + pointer to the modifier state to map - - Translates the contents of a #GdkEventKey into a keyval, effective + + Translates the contents of a #GdkEventKey into a keyval, effective group, and level. Modifiers that affected the translation and are thus unavailable for application use are returned in @consumed_modifiers. @@ -24162,7 +17244,7 @@ groups and levels. The @effective_group is the group that was actually used for the translation; some keys such as Enter are not affected by the active keyboard group. The @level is derived from @state. For convenience, #GdkEventKey already contains the translated -keyval, so this function isn’t as useful as you might think. +keyval, so this function isn’t as useful as you might think. @consumed_modifiers gives modifiers that should be masked outfrom @state when comparing this key press to a hot key. For instance, on a US keyboard, @@ -24185,7 +17267,7 @@ all modifiers that might affect the translation of the key; this allowed accelerators to be stored with irrelevant consumed modifiers, by doing: |[<!-- language="C" --> -// XXX Don’t do this XXX +// XXX Don’t do this XXX if (keyval == accel_keyval && (event->state & ~consumed & ALL_ACCELS_MASK) == (accel_mods & ~consumed)) // Accelerator was pressed @@ -24202,106 +17284,62 @@ you store accelerators, you should always store them with consumed modifiers removed. Store `<Control>plus`, not `<Control><Shift>plus`, - %TRUE if there was a keyval bound to the keycode/state/group + %TRUE if there was a keyval bound to the keycode/state/group - a #GdkKeymap + a #GdkKeymap - a keycode + a keycode - a modifier state + a modifier state - active keyboard group + active keyboard group - - return location for keyval, or %NULL + + return location for keyval, or %NULL - - return location for effective + + return location for effective group, or %NULL - - return location for level, or %NULL + + return location for level, or %NULL - - return location for modifiers + + return location for modifiers that were used to determine the group or level, or %NULL - The ::direction-changed signal gets emitted when the direction of + The ::direction-changed signal gets emitted when the direction of the keymap changes. - The ::keys-changed signal is emitted when the mapping represented by + The ::keys-changed signal is emitted when the mapping represented by @keymap changes. - The ::state-changed signal is emitted when the state of the + The ::state-changed signal is emitted when the state of the keyboard changes, e.g when Caps Lock is turned on or off. See gdk_keymap_get_caps_lock_state(). @@ -24310,158 +17348,97 @@ See gdk_keymap_get_caps_lock_state(). - A #GdkKeymapKey is a hardware key that can be mapped to a keyval. + A #GdkKeymapKey is a hardware key that can be mapped to a keyval. - the hardware keycode. This is an identifying number for a + the hardware keycode. This is an identifying number for a physical key. - indicates movement in a horizontal direction. Usually groups are used + indicates movement in a horizontal direction. Usually groups are used for two different languages. In group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters. - indicates which symbol on the key will be used, in a vertical direction. - So on a standard US keyboard, the key with the number “1” on it also has the + indicates which symbol on the key will be used, in a vertical direction. + So on a standard US keyboard, the key with the number “1” on it also has the exclamation point ("!") character on it. The level indicates whether to use - the “1” or the “!” symbol. The letter keys are considered to have a lowercase + the “1” or the “!” symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed. - + - + - - + + - + - + - - This enum is used with gdk_keymap_get_modifier_mask() + + This enum is used with gdk_keymap_get_modifier_mask() in order to determine what modifiers the currently used windowing system backend uses for particular purposes. For example, on X11/Windows, the Control key is used for invoking menu shortcuts (accelerators), whereas on Apple computers -it’s the Command key (which correspond to %GDK_CONTROL_MASK and +it’s the Command key (which correspond to %GDK_CONTROL_MASK and %GDK_MOD2_MASK, respectively). - - the primary modifier used to invoke + + the primary modifier used to invoke menu accelerators. - - the modifier used to invoke context menus. + + the modifier used to invoke context menus. Note that mouse button 3 always triggers context menus. When this modifier is not 0, it additionally triggers context menus when used with mouse button 1. - - the modifier used to extend selections + + the modifier used to extend selections using `modifier`-click or `modifier`-cursor-key - - the modifier used to modify selections, + + the modifier used to modify selections, which in most cases means toggling the clicked item into or out of the selection. - - when any of these modifiers is pressed, the + + when any of these modifiers is pressed, the key event cannot produce a symbol directly. This is meant to be used for input methods, and for use cases like typeahead search. - - the modifier that switches between keyboard + + the modifier that switches between keyboard groups (AltGr on X11/Windows and Option/Alt on OS X). - - The set of modifier masks accepted + + The set of modifier masks accepted as modifiers in accelerators. Needed because Command is mapped to MOD2 on OSX, which is widely used, but on X11 MOD2 is NumLock and using that for a mod key is problematic at best. Ref: https://bugzilla.gnome.org/show_bug.cgi?id=736125. - - A set of bit-flags to indicate the state of modifier keys and mouse buttons + + A set of bit-flags to indicate the state of modifier keys and mouse buttons in various event types. Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock. @@ -24479,281 +17456,113 @@ remove all reserved values. Also note that the GDK X backend interprets button press events for button 4-7 as scroll events, so %GDK_BUTTON4_MASK and %GDK_BUTTON5_MASK will never be set. - - the Shift key. + + the Shift key. - - a Lock key (depending on the modifier mapping of the + + a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock). - - the Control key. + + the Control key. - - the fourth modifier key (it depends on the modifier + + the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key). - - the fifth modifier key (it depends on the modifier + + the fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). - - the sixth modifier key (it depends on the modifier + + the sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). - - the seventh modifier key (it depends on the modifier + + the seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). - - the eighth modifier key (it depends on the modifier + + the eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). - - the first mouse button. + + the first mouse button. - - the second mouse button. + + the second mouse button. - - the third mouse button. + + the third mouse button. - - the fourth mouse button. + + the fourth mouse button. - - the fifth mouse button. + + the fifth mouse button. - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - the Super modifier. Since 2.10 + + the Super modifier. Since 2.10 - - the Hyper modifier. Since 2.10 + + the Hyper modifier. Since 2.10 - - the Meta modifier. Since 2.10 + + the Meta modifier. Since 2.10 - - A reserved bit flag; do not use in your own code + + A reserved bit flag; do not use in your own code - - not used in GDK itself. GTK+ uses it to differentiate + + not used in GDK itself. GTK+ uses it to differentiate between (keyval, modifiers) pairs from key press and release events. - - a mask covering all modifier types. + + a mask covering all modifier types. - - GdkMonitor objects represent the individual outputs that are + + GdkMonitor objects represent the individual outputs that are associated with a #GdkDisplay. GdkDisplay has APIs to enumerate monitors with gdk_display_get_n_monitors() and gdk_display_get_monitor(), and to find particular monitors with gdk_display_get_primary_monitor() or @@ -24762,85 +17571,55 @@ gdk_display_get_monitor_at_window(). GdkMonitor was introduced in GTK+ 3.22 and supersedes earlier APIs in GdkScreen to obtain monitor-related information. - - Gets the display that this monitor belongs to. + + Gets the display that this monitor belongs to. - the display + the display - a #GdkMonitor + a #GdkMonitor - - Retrieves the size and position of an individual monitor within the -display coordinate space. The returned geometry is in ”application pixels”, -not in ”device pixels” (see gdk_monitor_get_scale_factor()). + + Retrieves the size and position of an individual monitor within the +display coordinate space. The returned geometry is in ”application pixels”, +not in ”device pixels” (see gdk_monitor_get_scale_factor()). - a #GdkMonitor + a #GdkMonitor - - a #GdkRectangle to be filled with the monitor geometry + + a #GdkRectangle to be filled with the monitor geometry - - Gets the height in millimeters of the monitor. + + Gets the height in millimeters of the monitor. - the physical height of the monitor + the physical height of the monitor - a #GdkMonitor + a #GdkMonitor - - Gets the name or PNP ID of the monitor's manufacturer, if available. + + Gets the name or PNP ID of the monitor's manufacturer, if available. Note that this value might also vary depending on actual display backend. @@ -24848,146 +17627,100 @@ display backend. PNP ID registry is located at https://uefi.org/pnp_id_list - the name of the manufacturer, or %NULL + the name of the manufacturer, or %NULL - a #GdkMonitor + a #GdkMonitor - Gets the a string identifying the monitor model, if available. + Gets the a string identifying the monitor model, if available. - the monitor model, or %NULL + the monitor model, or %NULL - a #GdkMonitor + a #GdkMonitor - - Gets the refresh rate of the monitor, if available. + + Gets the refresh rate of the monitor, if available. The value is in milli-Hertz, so a refresh rate of 60Hz is returned as 60000. - the refresh rate in milli-Hertz, or 0 + the refresh rate in milli-Hertz, or 0 - a #GdkMonitor + a #GdkMonitor - - Gets the internal scale factor that maps from monitor coordinates + + Gets the internal scale factor that maps from monitor coordinates to the actual device pixels. On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2). This can be used if you want to create pixel based data for a -particular monitor, but most of the time you’re drawing to a window +particular monitor, but most of the time you’re drawing to a window where it is better to use gdk_window_get_scale_factor() instead. - the scale factor + the scale factor - a #GdkMonitor + a #GdkMonitor - - Gets information about the layout of red, green and blue + + Gets information about the layout of red, green and blue primaries for each pixel in this monitor, if available. - the subpixel layout + the subpixel layout - a #GdkMonitor + a #GdkMonitor - - Gets the width in millimeters of the monitor. + + Gets the width in millimeters of the monitor. - the physical width of the monitor + the physical width of the monitor - a #GdkMonitor + a #GdkMonitor - - Retrieves the size and position of the “work area” on a monitor + + Retrieves the size and position of the “work area” on a monitor within the display coordinate space. The returned geometry is in -”application pixels”, not in ”device pixels” (see +”application pixels”, not in ”device pixels” (see gdk_monitor_get_scale_factor()). The work area should be considered when positioning menus and @@ -25003,50 +17736,32 @@ available, or does not apply. - a #GdkMonitor + a #GdkMonitor - - a #GdkRectangle to be filled with + + a #GdkRectangle to be filled with the monitor workarea - - Gets whether this monitor should be considered primary + + Gets whether this monitor should be considered primary (see gdk_display_get_primary_monitor()). - %TRUE if @monitor is primary + %TRUE if @monitor is primary - a #GdkMonitor + a #GdkMonitor - + @@ -25082,422 +17797,255 @@ available, or does not apply. - + - - Specifies the kind of crossing for #GdkEventCrossing. + + Specifies the kind of crossing for #GdkEventCrossing. See the X11 protocol specification of LeaveNotify for full details of crossing event generation. - - the window is entered from an ancestor or + + the window is entered from an ancestor or left towards an ancestor. - - the pointer moves between an ancestor and an + + the pointer moves between an ancestor and an inferior of the window. - - the window is entered from an inferior or + + the window is entered from an inferior or left towards an inferior. - - the window is entered from or left towards + + the window is entered from or left towards a window which is neither an ancestor nor an inferior. - - the pointer moves between two windows + + the pointer moves between two windows which are not ancestors of each other and the window is part of the ancestor chain between one of these windows and their least common ancestor. - - an unknown type of enter/leave event occurred. + + an unknown type of enter/leave event occurred. - - Specifies why a selection ownership was changed. - - some other app claimed the ownership + + Specifies why a selection ownership was changed. + + some other app claimed the ownership - - the window was destroyed + + the window was destroyed - - the client was closed + + the client was closed - A special value, indicating that the background + A special value, indicating that the background for a window should be inherited from the parent window. - - Extracts a #GdkAtom from a pointer. The #GdkAtom must have been + + Extracts a #GdkAtom from a pointer. The #GdkAtom must have been stored in the pointer with GDK_ATOM_TO_POINTER(). - a pointer containing a #GdkAtom. + a pointer containing a #GdkAtom. - This is the priority that the idle handler processing window updates + This is the priority that the idle handler processing window updates is given in the [GLib Main Loop][glib-The-Main-Event-Loop]. - Defines the x and y coordinates of a point. + Defines the x and y coordinates of a point. - the x coordinate of the point. + the x coordinate of the point. - the y coordinate of the point. + the y coordinate of the point. - - Describes how existing data is combined with new data when + + Describes how existing data is combined with new data when using gdk_property_change(). - - the new data replaces the existing data. + + the new data replaces the existing data. - - the new data is prepended to the existing data. + + the new data is prepended to the existing data. - - the new data is appended to the existing data. + + the new data is appended to the existing data. - - Specifies the type of a property change for a #GdkEventProperty. - - the property value was changed. + + Specifies the type of a property change for a #GdkEventProperty. + + the property value was changed. - - the property was deleted. + + the property was deleted. - - A #GdkRGBA is used to represent a (possibly translucent) -color, in a way that is compatible with cairo’s notion of color. + + A #GdkRGBA is used to represent a (possibly translucent) +color, in a way that is compatible with cairo’s notion of color. - The intensity of the red channel from 0.0 to 1.0 inclusive + The intensity of the red channel from 0.0 to 1.0 inclusive - The intensity of the green channel from 0.0 to 1.0 inclusive + The intensity of the green channel from 0.0 to 1.0 inclusive - The intensity of the blue channel from 0.0 to 1.0 inclusive + The intensity of the blue channel from 0.0 to 1.0 inclusive - The opacity of the color from 0.0 for completely translucent to + The opacity of the color from 0.0 for completely translucent to 1.0 for opaque - Makes a copy of a #GdkRGBA. + Makes a copy of a #GdkRGBA. The result must be freed through gdk_rgba_free(). - A newly allocated #GdkRGBA, with the same contents as @rgba + A newly allocated #GdkRGBA, with the same contents as @rgba - a #GdkRGBA + a #GdkRGBA - Compares two RGBA colors. + Compares two RGBA colors. - %TRUE if the two colors compare equal + %TRUE if the two colors compare equal - a #GdkRGBA pointer + a #GdkRGBA pointer - another #GdkRGBA pointer + another #GdkRGBA pointer - Frees a #GdkRGBA created with gdk_rgba_copy() + Frees a #GdkRGBA created with gdk_rgba_copy() - a #GdkRGBA + a #GdkRGBA - A hash function suitable for using for a hash + A hash function suitable for using for a hash table that stores #GdkRGBAs. - The hash value for @p + The hash value for @p - a #GdkRGBA pointer + a #GdkRGBA pointer - Parses a textual representation of a color, filling in + Parses a textual representation of a color, filling in the @red, @green, @blue and @alpha fields of the @rgba #GdkRGBA. The string can be either one of: - A standard name (Taken from the X11 rgb.txt file). -- A hexadecimal value in the form “\#rgb”, “\#rrggbb”, - “\#rrrgggbbb” or ”\#rrrrggggbbbb” -- A RGB color in the form “rgb(r,g,b)” (In this case the color will +- A hexadecimal value in the form “\#rgb”, “\#rrggbb”, + “\#rrrgggbbb” or ”\#rrrrggggbbbb” +- A RGB color in the form “rgb(r,g,b)” (In this case the color will have full opacity) -- A RGBA color in the form “rgba(r,g,b,a)” +- A RGBA color in the form “rgba(r,g,b,a)” -Where “r”, “g”, “b” and “a” are respectively the red, green, blue and -alpha color values. In the last two cases, “r”, “g”, and “b” are either integers +Where “r”, “g”, “b” and “a” are respectively the red, green, blue and +alpha color values. In the last two cases, “r”, “g”, and “b” are either integers in the range 0 to 255 or percentage values in the range 0% to 100%, and a is a floating point value in the range 0 to 1. - %TRUE if the parsing succeeded + %TRUE if the parsing succeeded - the #GdkRGBA to fill in + the #GdkRGBA to fill in - the string specifying the color + the string specifying the color - Returns a textual specification of @rgba in the form + Returns a textual specification of @rgba in the form `rgb(r,g,b)` or `rgba(r g,b,a)`, -where “r”, “g”, “b” and “a” represent the red, green, -blue and alpha values respectively. “r”, “g”, and “b” are -represented as integers in the range 0 to 255, and “a” +where “r”, “g”, “b” and “a” represent the red, green, +blue and alpha values respectively. “r”, “g”, and “b” are +represented as integers in the range 0 to 255, and “a” is represented as a floating point value in the range 0 to 1. These string forms are string forms that are supported by the CSS3 colors module, and can be parsed by gdk_rgba_parse(). Note that this string representation may lose some -precision, since “r”, “g” and “b” are represented as 8-bit +precision, since “r”, “g” and “b” are represented as 8-bit integers. If this is a concern, you should use a different representation. - A newly allocated text string + A newly allocated text string - a #GdkRGBA + a #GdkRGBA - - Defines the position and size of a rectangle. It is identical to + + Defines the position and size of a rectangle. It is identical to #cairo_rectangle_int_t. @@ -25513,78 +18061,53 @@ different representation. - Checks if the two given rectangles are equal. + Checks if the two given rectangles are equal. - %TRUE if the rectangles are equal. + %TRUE if the rectangles are equal. - a #GdkRectangle + a #GdkRectangle - a #GdkRectangle + a #GdkRectangle - Calculates the intersection of two rectangles. It is allowed for + Calculates the intersection of two rectangles. It is allowed for @dest to be the same as either @src1 or @src2. If the rectangles -do not intersect, @dest’s width and height is set to 0 and its x +do not intersect, @dest’s width and height is set to 0 and its x and y values are undefined. If you are only interested in whether the rectangles intersect, but not in the intersecting area itself, pass %NULL for @dest. - %TRUE if the rectangles intersect. + %TRUE if the rectangles intersect. - a #GdkRectangle + a #GdkRectangle - a #GdkRectangle + a #GdkRectangle - - return location for the + + return location for the intersection of @src1 and @src2, or %NULL - Calculates the union of two rectangles. + Calculates the union of two rectangles. The union of rectangles @src1 and @src2 is the smallest rectangle which includes both @src1 and @src2 within it. It is allowed for @dest to be the same as either @src1 or @src2. @@ -25597,24 +18120,15 @@ zero width or height). - a #GdkRectangle + a #GdkRectangle - a #GdkRectangle + a #GdkRectangle - - return location for the union of @src1 and @src2 + + return location for the union of @src1 and @src2 @@ -25634,15 +18148,8 @@ zero width or height). - - #GdkScreen objects are the GDK representation of the screen on + + #GdkScreen objects are the GDK representation of the screen on which windows can be displayed and on which the pointer moves. X originally identified screens with physical screens, but nowadays it is more common to have a single #GdkScreen which @@ -25653,102 +18160,62 @@ the top level windows are to be displayed on. it is also used to query the screen specification and default settings such as the default visual (gdk_screen_get_system_visual()), the dimensions of the physical monitors (gdk_screen_get_monitor_geometry()), etc. - - Gets the default screen for the default display. (See + + Gets the default screen for the default display. (See gdk_display_get_default ()). - a #GdkScreen, or %NULL if + a #GdkScreen, or %NULL if there is no default display. - - Gets the height of the default screen in pixels. The returned -size is in ”application pixels”, not in ”device pixels” (see + + Gets the height of the default screen in pixels. The returned +size is in ”application pixels”, not in ”device pixels” (see gdk_screen_get_monitor_scale_factor()). Use per-monitor information - the height of the default screen in pixels. + the height of the default screen in pixels. - - Returns the height of the default screen in millimeters. + + Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct. Use per-monitor information - the height of the default screen in millimeters, + the height of the default screen in millimeters, though it is not always correct. - - Gets the width of the default screen in pixels. The returned -size is in ”application pixels”, not in ”device pixels” (see + + Gets the width of the default screen in pixels. The returned +size is in ”application pixels”, not in ”device pixels” (see gdk_screen_get_monitor_scale_factor()). Use per-monitor information - the width of the default screen in pixels. + the width of the default screen in pixels. - - Returns the width of the default screen in millimeters. + + Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct. Use per-monitor information - the width of the default screen in millimeters, + the width of the default screen in millimeters, though it is not always correct. - - Returns the screen’s currently active window. + + Returns the screen’s currently active window. On X11, this is done by inspecting the _NET_ACTIVE_WINDOW property on the root window, as described in the @@ -25764,101 +18231,65 @@ The returned window should be unrefed using g_object_unref() when no longer needed. - the currently active window, + the currently active window, or %NULL. - a #GdkScreen + a #GdkScreen - - Gets the display to which the @screen belongs. + + Gets the display to which the @screen belongs. - the display to which @screen belongs + the display to which @screen belongs - a #GdkScreen + a #GdkScreen - - Gets any options previously set with gdk_screen_set_font_options(). + + Gets any options previously set with gdk_screen_set_font_options(). - the current font options, or %NULL if no + the current font options, or %NULL if no default font options have been set. - a #GdkScreen + a #GdkScreen - - Gets the height of @screen in pixels. The returned size is in -”application pixels”, not in ”device pixels” (see + + Gets the height of @screen in pixels. The returned size is in +”application pixels”, not in ”device pixels” (see gdk_screen_get_monitor_scale_factor()). Use per-monitor information instead - the height of @screen in pixels. + the height of @screen in pixels. - a #GdkScreen + a #GdkScreen - - Returns the height of @screen in millimeters. + + Returns the height of @screen in millimeters. Note that this value is somewhat ill-defined when the screen has multiple monitors of different resolution. It is recommended @@ -25866,102 +18297,66 @@ to use the monitor dimensions instead. Use per-monitor information instead - the heigth of @screen in millimeters. + the heigth of @screen in millimeters. - a #GdkScreen + a #GdkScreen - - Returns the monitor number in which the point (@x,@y) is located. + + Returns the monitor number in which the point (@x,@y) is located. Use gdk_display_get_monitor_at_point() instead - the monitor number in which the point (@x,@y) lies, or + the monitor number in which the point (@x,@y) lies, or a monitor close to (@x,@y) if the point is not in any monitor. - a #GdkScreen. + a #GdkScreen. - the x coordinate in the virtual screen. + the x coordinate in the virtual screen. - the y coordinate in the virtual screen. + the y coordinate in the virtual screen. - - Returns the number of the monitor in which the largest area of the + + Returns the number of the monitor in which the largest area of the bounding rectangle of @window resides. Use gdk_display_get_monitor_at_window() instead - the monitor number in which most of @window is located, + the monitor number in which most of @window is located, or if @window does not intersect any monitors, a monitor, close to @window. - a #GdkScreen. + a #GdkScreen. - a #GdkWindow + a #GdkWindow - - Retrieves the #GdkRectangle representing the size and position of + + Retrieves the #GdkRectangle representing the size and position of the individual monitor within the entire screen area. The returned -geometry is in ”application pixels”, not in ”device pixels” (see +geometry is in ”application pixels”, not in ”device pixels” (see gdk_screen_get_monitor_scale_factor()). Monitor numbers start at 0. To obtain the number of monitors of @@ -25976,174 +18371,109 @@ gdk_screen_get_width() and gdk_screen_get_height(). - a #GdkScreen + a #GdkScreen - the monitor number + the monitor number - - a #GdkRectangle to be filled with + + a #GdkRectangle to be filled with the monitor geometry - - Gets the height in millimeters of the specified monitor. + + Gets the height in millimeters of the specified monitor. Use gdk_monitor_get_height_mm() instead - the height of the monitor, or -1 if not available + the height of the monitor, or -1 if not available - a #GdkScreen + a #GdkScreen - number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) + number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) - - Returns the output name of the specified monitor. + + Returns the output name of the specified monitor. Usually something like VGA, DVI, or TV, not the actual product name of the display device. Use gdk_monitor_get_model() instead - a newly-allocated string containing the name + a newly-allocated string containing the name of the monitor, or %NULL if the name cannot be determined - a #GdkScreen + a #GdkScreen - number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) + number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) - - Returns the internal scale factor that maps from monitor coordinates + + Returns the internal scale factor that maps from monitor coordinates to the actual device pixels. On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2). This can be used if you want to create pixel based data for a -particular monitor, but most of the time you’re drawing to a window +particular monitor, but most of the time you’re drawing to a window where it is better to use gdk_window_get_scale_factor() instead. Use gdk_monitor_get_scale_factor() instead - the scale factor + the scale factor - screen to get scale factor for + screen to get scale factor for - number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) + number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) - - Gets the width in millimeters of the specified monitor, if available. + + Gets the width in millimeters of the specified monitor, if available. Use gdk_monitor_get_width_mm() instead - the width of the monitor, or -1 if not available + the width of the monitor, or -1 if not available - a #GdkScreen + a #GdkScreen - number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) + number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) - - Retrieves the #GdkRectangle representing the size and position of -the “work area” on a monitor within the entire screen area. The returned -geometry is in ”application pixels”, not in ”device pixels” (see + + Retrieves the #GdkRectangle representing the size and position of +the “work area” on a monitor within the entire screen area. The returned +geometry is in ”application pixels”, not in ”device pixels” (see gdk_screen_get_monitor_scale_factor()). The work area should be considered when positioning menus and @@ -26163,90 +18493,53 @@ Monitor numbers start at 0. To obtain the number of monitors of - a #GdkScreen + a #GdkScreen - the monitor number + the monitor number - - a #GdkRectangle to be filled with + + a #GdkRectangle to be filled with the monitor workarea - - Returns the number of monitors which @screen consists of. + + Returns the number of monitors which @screen consists of. Use gdk_display_get_n_monitors() instead - number of monitors which @screen consists of + number of monitors which @screen consists of - a #GdkScreen + a #GdkScreen - - Gets the index of @screen among the screens in the display + + Gets the index of @screen among the screens in the display to which it belongs. (See gdk_screen_get_display()) - the index + the index - a #GdkScreen + a #GdkScreen - - Gets the primary monitor for @screen. The primary monitor -is considered the monitor where the “main desktop” lives. + + Gets the primary monitor for @screen. The primary monitor +is considered the monitor where the “main desktop” lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor. @@ -26256,54 +18549,38 @@ will be 0, defaulting to the first monitor. Use gdk_display_get_primary_monitor() instead - An integer index for the primary monitor, or 0 if none is configured. + An integer index for the primary monitor, or 0 if none is configured. - a #GdkScreen. + a #GdkScreen. - - Gets the resolution for font handling on the screen; see + + Gets the resolution for font handling on the screen; see gdk_screen_set_resolution() for full details. - the current resolution, or -1 if no resolution + the current resolution, or -1 if no resolution has been set. - a #GdkScreen + a #GdkScreen - - Gets a visual to use for creating windows with an alpha channel. + + Gets a visual to use for creating windows with an alpha channel. The windowing system on which GTK+ is running may not support this capability, in which case %NULL will be returned. Even if a non-%NULL value is returned, its -possible that the window’s alpha channel won’t be honored +possible that the window’s alpha channel won’t be honored when displaying the window on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display. @@ -26314,113 +18591,77 @@ For setting an overall opacity for a top-level window, see gdk_window_set_opacity(). - a visual to use for windows + a visual to use for windows with an alpha channel or %NULL if the capability is not available. - a #GdkScreen + a #GdkScreen - - Gets the root window of @screen. + + Gets the root window of @screen. - the root window + the root window - a #GdkScreen + a #GdkScreen - - Retrieves a desktop-wide setting such as double-click time + + Retrieves a desktop-wide setting such as double-click time for the #GdkScreen @screen. FIXME needs a list of valid settings here, or a link to more information. - %TRUE if the setting existed and a value was stored + %TRUE if the setting existed and a value was stored in @value, %FALSE otherwise. - the #GdkScreen where the setting is located + the #GdkScreen where the setting is located - the name of the setting + the name of the setting - location to store the value of the setting + location to store the value of the setting - - Get the system’s default visual for @screen. + + Get the system’s default visual for @screen. This is the visual for the root window of the display. The return value should not be freed. - the system visual + the system visual - a #GdkScreen. + a #GdkScreen. - - Obtains a list of all toplevel windows known to GDK on the screen @screen. + + Obtains a list of all toplevel windows known to GDK on the screen @screen. A toplevel window is a child of the root window (see gdk_get_default_root_window()). @@ -26428,9 +18669,7 @@ The returned list should be freed with g_list_free(), but its elements need not be freed. - + list of toplevel windows, free with g_list_free() @@ -26438,48 +18677,30 @@ its elements need not be freed. - The #GdkScreen where the toplevels are located. + The #GdkScreen where the toplevels are located. - - Gets the width of @screen in pixels. The returned size is in -”application pixels”, not in ”device pixels” (see + + Gets the width of @screen in pixels. The returned size is in +”application pixels”, not in ”device pixels” (see gdk_screen_get_monitor_scale_factor()). Use per-monitor information instead - the width of @screen in pixels. + the width of @screen in pixels. - a #GdkScreen + a #GdkScreen - - Gets the width of @screen in millimeters. + + Gets the width of @screen in millimeters. Note that this value is somewhat ill-defined when the screen has multiple monitors of different resolution. It is recommended @@ -26487,26 +18708,18 @@ to use the monitor dimensions instead. Use per-monitor information instead - the width of @screen in millimeters. + the width of @screen in millimeters. - a #GdkScreen + a #GdkScreen - - Returns a #GList of #GdkWindows representing the current + + Returns a #GList of #GdkWindows representing the current window stack. On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING @@ -26523,9 +18736,7 @@ windows it contains, so it should be freed using g_list_free() and its windows unrefed using g_object_unref() when no longer needed. - a + a list of #GdkWindows for the current window stack, or %NULL. @@ -26533,19 +18744,13 @@ its windows unrefed using g_object_unref() when no longer needed. - a #GdkScreen + a #GdkScreen - - Returns whether windows with an RGBA visual can reasonably + + Returns whether windows with an RGBA visual can reasonably be expected to have their alpha channel drawn correctly on the screen. @@ -26553,37 +18758,27 @@ On X11 this function returns whether a compositing manager is compositing @screen. - Whether windows with RGBA visuals can reasonably be + Whether windows with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen. - a #GdkScreen + a #GdkScreen - - Lists the available visuals for the specified @screen. + + Lists the available visuals for the specified @screen. A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format. -Call g_list_free() on the return value when you’re finished with it. +Call g_list_free() on the return value when you’re finished with it. - + a list of visuals; the list must be freed, but not its contents @@ -26591,45 +18786,29 @@ Call g_list_free() on the return value when you’re finished with it. - the relevant #GdkScreen. + the relevant #GdkScreen. - - Determines the name to pass to gdk_display_open() to get + + Determines the name to pass to gdk_display_open() to get a #GdkDisplay with this screen as the default screen. - a newly allocated string, free with g_free() + a newly allocated string, free with g_free() - a #GdkScreen + a #GdkScreen - - Sets the default font options for the screen. These -options will be set on any #PangoContext’s newly created + + Sets the default font options for the screen. These +options will be set on any #PangoContext’s newly created with gdk_pango_context_get_for_screen(). Changing the default set of font options does not affect contexts that have already been created. @@ -26639,30 +18818,18 @@ have already been created. - a #GdkScreen + a #GdkScreen - - a #cairo_font_options_t, or %NULL to unset any + + a #cairo_font_options_t, or %NULL to unset any previously set default font options. - + - - Sets the resolution for font handling on the screen. This is a + + Sets the resolution for font handling on the screen. This is a scale factor between points specified in a #PangoFontDescription and cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3). @@ -26672,15 +18839,11 @@ font will be 13 units high. (10 * 96. / 72. = 13.3). - a #GdkScreen + a #GdkScreen - the resolution in “dots per inch”. (Physical inches aren’t actually + the resolution in “dots per inch”. (Physical inches aren’t actually involved; the terminology is conventional.) @@ -26693,18 +18856,14 @@ font will be 13 units high. (10 * 96. / 72. = 13.3). - The ::composited-changed signal is emitted when the composited + The ::composited-changed signal is emitted when the composited status of the screen changes - The ::monitors-changed signal is emitted when the number, size + The ::monitors-changed signal is emitted when the number, size or position of the monitors attached to the screen change. Only for X11 and OS X for now. A future implementation for Win32 @@ -26714,172 +18873,99 @@ may be a possibility. - The ::size-changed signal is emitted when the pixel width or + The ::size-changed signal is emitted when the pixel width or height of a screen changes. - - Specifies the direction for #GdkEventScroll. + + Specifies the direction for #GdkEventScroll. - the window is scrolled up. + the window is scrolled up. - - the window is scrolled down. + + the window is scrolled down. - - the window is scrolled to the left. + + the window is scrolled to the left. - - the window is scrolled to the right. + + the window is scrolled to the right. - - the scrolling is determined by the delta values + + the scrolling is determined by the delta values in #GdkEventScroll. See gdk_event_get_scroll_deltas(). Since: 3.4 - - The #GdkSeat object represents a collection of input devices + + The #GdkSeat object represents a collection of input devices that belong to a user. - - Returns the capabilities this #GdkSeat currently has. + + Returns the capabilities this #GdkSeat currently has. - the seat capabilities + the seat capabilities - a #GdkSeat + a #GdkSeat - Returns the #GdkDisplay this seat belongs to. + Returns the #GdkDisplay this seat belongs to. - a #GdkDisplay. This object is owned by GTK+ + a #GdkDisplay. This object is owned by GTK+ and must not be freed. - a #GdkSeat + a #GdkSeat - - Returns the master device that routes keyboard events. + + Returns the master device that routes keyboard events. - a master #GdkDevice with keyboard + a master #GdkDevice with keyboard capabilities. This object is owned by GTK+ and must not be freed. - a #GdkSeat + a #GdkSeat - - Returns the master device that routes pointer events. + + Returns the master device that routes pointer events. - a master #GdkDevice with pointer + a master #GdkDevice with pointer capabilities. This object is owned by GTK+ and must not be freed. - a #GdkSeat + a #GdkSeat - - Returns the slave devices that match the given capabilities. + + Returns the slave devices that match the given capabilities. - A list of #GdkDevices. + A list of #GdkDevices. The list must be freed with g_list_free(), the elements are owned by GDK and must not be freed. @@ -26888,23 +18974,17 @@ that belong to a user. - a #GdkSeat + a #GdkSeat - capabilities to get devices for + capabilities to get devices for - Grabs the seat so that all events corresponding to the given @capabilities + Grabs the seat so that all events corresponding to the given @capabilities are passed to this application until the seat is ungrabbed with gdk_seat_ungrab(), or the window becomes hidden. This overrides any previous grab on the seat by this client. @@ -26930,34 +19010,24 @@ cleaned up when the grab ends, you should handle the #GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily. - %GDK_GRAB_SUCCESS if the grab was successful. + %GDK_GRAB_SUCCESS if the grab was successful. - a #GdkSeat + a #GdkSeat - the #GdkWindow which will own the grab + the #GdkWindow which will own the grab - capabilities that will be grabbed + capabilities that will be grabbed - if %FALSE then all device events are reported with respect to + if %FALSE then all device events are reported with respect to @window and are only reported if selected by @event_mask. If %TRUE then pointer events for this application are reported as normal, but pointer events outside this application are @@ -26965,120 +19035,78 @@ events that are emitted when the grab ends unvoluntarily. @event_mask. In either mode, unreported events are discarded. - - the cursor to display while the grab is active. If + + the cursor to display while the grab is active. If this is %NULL then the normal cursors are used for @window and its descendants, and the cursor for @window is used elsewhere. - - the event that is triggering the grab, or %NULL if none + + the event that is triggering the grab, or %NULL if none is available. - - function to + + function to prepare the window to be grabbed, it can be %NULL if @window is visible before this call. - - user data to pass to @prepare_func + + user data to pass to @prepare_func - Releases a grab added through gdk_seat_grab(). + Releases a grab added through gdk_seat_grab(). - a #GdkSeat + a #GdkSeat - - #GdkDisplay of this seat. + + #GdkDisplay of this seat. - The ::device-added signal is emitted when a new input + The ::device-added signal is emitted when a new input device is related to this seat. - the newly added #GdkDevice. + the newly added #GdkDevice. - The ::device-removed signal is emitted when an + The ::device-removed signal is emitted when an input device is removed (e.g. unplugged). - the just removed #GdkDevice. + the just removed #GdkDevice. - The ::tool-added signal is emitted whenever a new tool + The ::tool-added signal is emitted whenever a new tool is made known to the seat. The tool may later be assigned to a device (i.e. on proximity with a tablet). The device will emit the #GdkDevice::tool-changed signal accordingly. @@ -27089,102 +19117,51 @@ A same tool may be used by several devices. - the new #GdkDeviceTool known to the seat + the new #GdkDeviceTool known to the seat - This signal is emitted whenever a tool is no longer known + This signal is emitted whenever a tool is no longer known to this @seat. - the just removed #GdkDeviceTool + the just removed #GdkDeviceTool - - Flags describing the seat capabilities. - - No input capabilities + + Flags describing the seat capabilities. + + No input capabilities - - The seat has a pointer (e.g. mouse) + + The seat has a pointer (e.g. mouse) - - The seat has touchscreen(s) attached + + The seat has touchscreen(s) attached - - The seat has drawing tablet(s) attached + + The seat has drawing tablet(s) attached - - The seat has keyboard(s) attached + + The seat has keyboard(s) attached - - The union of all pointing capabilities + + The union of all pointing capabilities - - The union of all capabilities + + The union of all capabilities - - Type of the callback used to set up @window so it can be + + Type of the callback used to set up @window so it can be grabbed. A typical action would be ensuring the window is visible, although there's room for other initialization actions. @@ -27194,174 +19171,82 @@ actions. - the #GdkSeat being grabbed + the #GdkSeat being grabbed - the #GdkWindow being grabbed + the #GdkWindow being grabbed - - user data passed in gdk_seat_grab() + + user data passed in gdk_seat_grab() - - Specifies the kind of modification applied to a setting in a + + Specifies the kind of modification applied to a setting in a #GdkEventSetting. - - a setting was added. + + a setting was added. - - a setting was changed. + + a setting was changed. - - a setting was deleted. + + a setting was deleted. - + - + - + - + - + - - This enumeration describes how the red, green and blue components + + This enumeration describes how the red, green and blue components of physical pixels on an output device are laid out. - - The layout is not known + + The layout is not known - - Not organized in this way + + Not organized in this way - - The layout is horizontal, the order is RGB + + The layout is horizontal, the order is RGB - - The layout is horizontal, the order is BGR + + The layout is horizontal, the order is BGR - - The layout is vertical, the order is RGB + + The layout is vertical, the order is RGB - - The layout is vertical, the order is BGR + + The layout is vertical, the order is BGR - A #GdkTimeCoord stores a single event in a motion history. + A #GdkTimeCoord stores a single event in a motion history. - The timestamp for this event. + The timestamp for this event. - the values of the device’s axes. + the values of the device’s axes. - - Specifies the current state of a touchpad gesture. All gestures are + + Specifies the current state of a touchpad gesture. All gestures are guaranteed to begin with an event with phase %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by 0 or several events with phase %GDK_TOUCHPAD_GESTURE_PHASE_UPDATE. @@ -27379,46 +19264,23 @@ to undo any visible/permanent changes that were done throughout the progress of the gesture. See also #GdkEventTouchpadSwipe and #GdkEventTouchpadPinch. - - The gesture has begun. + + The gesture has begun. - - The gesture has been updated. + + The gesture has been updated. - - The gesture was finished, changes + + The gesture was finished, changes should be permanently applied. - - The gesture was cancelled, all + + The gesture was cancelled, all changes should be undone. - - + + @@ -27433,142 +19295,78 @@ See also #GdkEventTouchpadSwipe and #GdkEventTouchpadPinch. - - Specifies the visiblity status of a window for a #GdkEventVisibility. - - the window is completely visible. + + Specifies the visiblity status of a window for a #GdkEventVisibility. + + the window is completely visible. - - the window is partially visible. + + the window is partially visible. - - the window is not visible at all. + + the window is not visible at all. - - A #GdkVisual contains information about + + A #GdkVisual contains information about a particular visual. - - Get the visual with the most available colors for the default + + Get the visual with the most available colors for the default GDK screen. The return value should not be freed. Visual selection should be done using gdk_screen_get_system_visual() and gdk_screen_get_rgba_visual() - best visual + best visual - - Get the best available depth for the default GDK screen. “Best” -means “largest,” i.e. 32 preferred over 24 preferred over 8 bits + + Get the best available depth for the default GDK screen. “Best” +means “largest,” i.e. 32 preferred over 24 preferred over 8 bits per pixel. Visual selection should be done using gdk_screen_get_system_visual() and gdk_screen_get_rgba_visual() - best available depth + best available depth - - Return the best available visual type for the default GDK screen. + + Return the best available visual type for the default GDK screen. Visual selection should be done using gdk_screen_get_system_visual() and gdk_screen_get_rgba_visual() - best visual type + best visual type - - Combines gdk_visual_get_best_with_depth() and + + Combines gdk_visual_get_best_with_depth() and gdk_visual_get_best_with_type(). Visual selection should be done using gdk_screen_get_system_visual() and gdk_screen_get_rgba_visual() - best visual with both @depth + best visual with both @depth and @visual_type, or %NULL if none - a bit depth + a bit depth - a visual type + a visual type - - Get the best visual with depth @depth for the default GDK screen. + + Get the best visual with depth @depth for the default GDK screen. Color visuals and visuals with mutable colormaps are preferred over grayscale or fixed-colormap visuals. The return value should not be freed. %NULL may be returned if no visual supports @depth. @@ -27576,27 +19374,18 @@ not be freed. %NULL may be returned if no visual supports @depth. gdk_screen_get_system_visual() and gdk_screen_get_rgba_visual() - best visual for the given depth + best visual for the given depth - a bit depth + a bit depth - - Get the best visual of the given @visual_type for the default GDK screen. + + Get the best visual of the given @visual_type for the default GDK screen. Visuals with higher color depths are considered better. The return value should not be freed. %NULL may be returned if no visual has type @visual_type. @@ -27604,74 +19393,49 @@ should not be freed. %NULL may be returned if no visual has type gdk_screen_get_system_visual() and gdk_screen_get_rgba_visual() - best visual of the given type + best visual of the given type - a visual type + a visual type - - Get the system’s default visual for the default GDK screen. + + Get the system’s default visual for the default GDK screen. This is the visual for the root window of the display. The return value should not be freed. Use gdk_screen_get_system_visual (gdk_screen_get_default ()). - system visual + system visual - - Returns the number of significant bits per red, green and blue value. + + Returns the number of significant bits per red, green and blue value. Not all GDK backend provide a meaningful value for this function. Use gdk_visual_get_red_pixel_details() and its variants to learn about the pixel layout of TrueColor and DirectColor visuals - The number of significant bits per color value for @visual. + The number of significant bits per color value for @visual. - a #GdkVisual + a #GdkVisual - - Obtains values that are needed to calculate blue pixel values in TrueColor -and DirectColor. The “mask” is the significant bits within the pixel. -The “shift” is the number of bits left we must shift a primary for it + + Obtains values that are needed to calculate blue pixel values in TrueColor +and DirectColor. The “mask” is the significant bits within the pixel. +The “shift” is the number of bits left we must shift a primary for it to be in position (according to the "mask"). Finally, "precision" refers to how much precision the pixel value contains for a particular primary. @@ -27680,54 +19444,25 @@ to how much precision the pixel value contains for a particular primary. - a #GdkVisual + a #GdkVisual - - A pointer to a #guint32 to be filled in, or %NULL + + A pointer to a #guint32 to be filled in, or %NULL - - A pointer to a #gint to be filled in, or %NULL + + A pointer to a #gint to be filled in, or %NULL - - A pointer to a #gint to be filled in, or %NULL + + A pointer to a #gint to be filled in, or %NULL - - Returns the byte order of this visual. + + Returns the byte order of this visual. The information returned by this function is only relevant when working with XImages, and not all backends return @@ -27735,78 +19470,52 @@ meaningful information for this. This information is not useful - A #GdkByteOrder stating the byte order of @visual. + A #GdkByteOrder stating the byte order of @visual. - A #GdkVisual. + A #GdkVisual. - - Returns the size of a colormap for this visual. + + Returns the size of a colormap for this visual. You have to use platform-specific APIs to manipulate colormaps. This information is not useful, since GDK does not provide APIs to operate on colormaps. - The size of a colormap that is suitable for @visual. + The size of a colormap that is suitable for @visual. - A #GdkVisual. + A #GdkVisual. - - Returns the bit depth of this visual. + + Returns the bit depth of this visual. - The bit depth of this visual. + The bit depth of this visual. - A #GdkVisual. + A #GdkVisual. - - Obtains values that are needed to calculate green pixel values in TrueColor -and DirectColor. The “mask” is the significant bits within the pixel. -The “shift” is the number of bits left we must shift a primary for it + + Obtains values that are needed to calculate green pixel values in TrueColor +and DirectColor. The “mask” is the significant bits within the pixel. +The “shift” is the number of bits left we must shift a primary for it to be in position (according to the "mask"). Finally, "precision" refers to how much precision the pixel value contains for a particular primary. @@ -27815,54 +19524,27 @@ to how much precision the pixel value contains for a particular primary. - a #GdkVisual + a #GdkVisual - - A pointer to a #guint32 to be filled in, or %NULL + + A pointer to a #guint32 to be filled in, or %NULL - - A pointer to a #gint to be filled in, or %NULL + + A pointer to a #gint to be filled in, or %NULL - - A pointer to a #gint to be filled in, or %NULL + + A pointer to a #gint to be filled in, or %NULL - - Obtains values that are needed to calculate red pixel values in TrueColor -and DirectColor. The “mask” is the significant bits within the pixel. -The “shift” is the number of bits left we must shift a primary for it + + Obtains values that are needed to calculate red pixel values in TrueColor +and DirectColor. The “mask” is the significant bits within the pixel. +The “shift” is the number of bits left we must shift a primary for it to be in position (according to the "mask"). Finally, "precision" refers to how much precision the pixel value contains for a particular primary. @@ -27871,155 +19553,81 @@ to how much precision the pixel value contains for a particular primary. - A #GdkVisual + A #GdkVisual - - A pointer to a #guint32 to be filled in, or %NULL + + A pointer to a #guint32 to be filled in, or %NULL - - A pointer to a #gint to be filled in, or %NULL + + A pointer to a #gint to be filled in, or %NULL - - A pointer to a #gint to be filled in, or %NULL + + A pointer to a #gint to be filled in, or %NULL - - Gets the screen to which this visual belongs + + Gets the screen to which this visual belongs - the screen to which this visual belongs. + the screen to which this visual belongs. - a #GdkVisual + a #GdkVisual - - Returns the type of visual this is (PseudoColor, TrueColor, etc). + + Returns the type of visual this is (PseudoColor, TrueColor, etc). - A #GdkVisualType stating the type of @visual. + A #GdkVisualType stating the type of @visual. - A #GdkVisual. + A #GdkVisual. - - A set of values that describe the manner in which the pixel values + + A set of values that describe the manner in which the pixel values for a visual are converted into RGB values for display. - - Each pixel value indexes a grayscale value + + Each pixel value indexes a grayscale value directly. - - Each pixel is an index into a color map that + + Each pixel is an index into a color map that maps pixel values into grayscale values. The color map can be changed by an application. - - Each pixel value is an index into a predefined, + + Each pixel value is an index into a predefined, unmodifiable color map that maps pixel values into RGB values. - - Each pixel is an index into a color map that + + Each pixel is an index into a color map that maps pixel values into rgb values. The color map can be changed by an application. - - Each pixel value directly contains red, green, + + Each pixel value directly contains red, green, and blue components. Use gdk_visual_get_red_pixel_details(), etc, to obtain information about how the components are assembled into a pixel value. - - Each pixel value contains red, green, and blue + + Each pixel value contains red, green, and blue components as for %GDK_VISUAL_TRUE_COLOR, but the components are mapped via a color table into the final output table instead of being converted directly. @@ -28032,204 +19640,103 @@ for a visual are converted into RGB values for display. - + - + - - These are hints originally defined by the Motif toolkit. + + These are hints originally defined by the Motif toolkit. The window manager can use them when determining how to decorate the window. The hint must be set before mapping the window. - - all decorations should be applied. + + all decorations should be applied. - - a frame should be drawn around the window. + + a frame should be drawn around the window. - - the frame should have resize handles. + + the frame should have resize handles. - - a titlebar should be placed above the window. + + a titlebar should be placed above the window. - - a button for opening a menu should be included. + + a button for opening a menu should be included. - - a minimize button should be included. + + a minimize button should be included. - - a maximize button should be included. + + a maximize button should be included. - - These are hints originally defined by the Motif toolkit. The window manager + + These are hints originally defined by the Motif toolkit. The window manager can use them when determining the functions to offer for the window. The hint must be set before mapping the window. - all functions should be offered. + all functions should be offered. - - the window should be resizable. + + the window should be resizable. - - the window should be movable. + + the window should be movable. - - the window should be minimizable. + + the window should be minimizable. - - the window should be maximizable. + + the window should be maximizable. - - the window should be closable. + + the window should be closable. - + - Creates a new #GdkWindow using the attributes from + Creates a new #GdkWindow using the attributes from @attributes. See #GdkWindowAttr and #GdkWindowAttributesType for more details. Note: to use this on displays other than the default display, @parent must be specified. - the new #GdkWindow + the new #GdkWindow - - a #GdkWindow, or %NULL to create the window as a child of + + a #GdkWindow, or %NULL to create the window as a child of the default root window for the default display. - attributes of the new window + attributes of the new window - mask indicating which + mask indicating which fields in @attributes are valid - - Obtains the window underneath the mouse pointer, returning the + + Obtains the window underneath the mouse pointer, returning the location of that window in @win_x, @win_y. Returns %NULL if the window under the mouse pointer is not known to GDK (if the window -belongs to another application and a #GdkWindow hasn’t been created +belongs to another application and a #GdkWindow hasn’t been created for it with gdk_window_foreign_new()) NOTE: For multihead-aware widgets or applications use @@ -28237,40 +19744,22 @@ gdk_display_get_window_at_pointer() instead. Use gdk_device_get_window_at_position() instead. - window under the mouse pointer + window under the mouse pointer - - return location for origin of the window under the pointer + + return location for origin of the window under the pointer - - return location for origin of the window under the pointer + + return location for origin of the window under the pointer - Constrains a desired width and height according to a + Constrains a desired width and height according to a set of geometry hints (such as minimum and maximum size). @@ -28278,69 +19767,41 @@ set of geometry hints (such as minimum and maximum size). - a #GdkGeometry structure + a #GdkGeometry structure - a mask indicating what portions of @geometry are set + a mask indicating what portions of @geometry are set - desired width of window + desired width of window - desired height of the window + desired height of the window - - location to store resulting width + + location to store resulting width - - location to store resulting height + + location to store resulting height - - Calls gdk_window_process_updates() for all windows (see #GdkWindow) + + Calls gdk_window_process_updates() for all windows (see #GdkWindow) in the application. - - With update debugging enabled, calls to + + With update debugging enabled, calls to gdk_window_invalidate_region() clear the invalidated region of the screen to a noticeable color, and GDK pauses for a short time before sending exposes to windows during @@ -28352,7 +19813,7 @@ In essence, because the GDK rendering model prevents all flicker, if you are redrawing the same region 400 times you may never notice, aside from noticing a speed problem. Enabling update debugging causes GTK to flicker slowly and noticeably, so you can -see exactly what’s being redrawn when, in what order. +see exactly what’s being redrawn when, in what order. The --gtk-debug=updates command line option passed to GTK+ programs enables this debug option at application startup time. That's @@ -28365,9 +19826,7 @@ updates sometime after application startup time. - %TRUE to turn on update debugging + %TRUE to turn on update debugging @@ -28452,12 +19911,8 @@ updates sometime after application startup time. - - Adds an event filter to @window, allowing you to intercept events + + Adds an event filter to @window, allowing you to intercept events before they reach GDK. This is a low-level operation and makes it easy to break GDK and/or GTK+, so you have to know what you're doing. Pass %NULL for @window to get all events for all windows, @@ -28471,36 +19926,22 @@ XFreeEventData() must not be called within @function. - - a #GdkWindow + + a #GdkWindow - filter callback + filter callback - - data to pass to filter callback + + data to pass to filter callback - Emits a short beep associated to @window in the appropriate + Emits a short beep associated to @window in the appropriate display, if supported. Otherwise, emits a short beep on the display just as gdk_display_beep(). @@ -28509,19 +19950,13 @@ the display just as gdk_display_beep(). - a toplevel #GdkWindow + a toplevel #GdkWindow - - Indicates that you are beginning the process of redrawing @region + + Indicates that you are beginning the process of redrawing @region on @window, and provides you with a #GdkDrawingContext. If @window is a top level #GdkWindow, backed by a native window @@ -28542,7 +19977,7 @@ as individual drawing operations are performed in sequence. When using GTK+, the widget system automatically places calls to gdk_window_begin_draw_frame() and gdk_window_end_draw_frame() around -emissions of the `GtkWidget::draw` signal. That is, if you’re +emissions of the `GtkWidget::draw` signal. That is, if you’re drawing the contents of the widget yourself, you can assume that the widget has a cleared background, is already set as the clip region, and already has a backing store. Therefore in most cases, application @@ -28550,32 +19985,24 @@ code in GTK does not need to call gdk_window_begin_draw_frame() explicitly. - a #GdkDrawingContext context that should be + a #GdkDrawingContext context that should be used to draw the contents of the window; the returned context is owned by GDK. - a #GdkWindow + a #GdkWindow - a Cairo region + a Cairo region - Begins a window move operation (for a toplevel window). + Begins a window move operation (for a toplevel window). This function assumes that the drag is controlled by the client pointer device, use gdk_window_begin_move_drag_for_device() @@ -28586,44 +20013,30 @@ to begin a drag with a different device. - a toplevel #GdkWindow + a toplevel #GdkWindow - the button being used to drag, or 0 for a keyboard-initiated drag + the button being used to drag, or 0 for a keyboard-initiated drag - root window X coordinate of mouse click that began the drag + root window X coordinate of mouse click that began the drag - root window Y coordinate of mouse click that began the drag + root window Y coordinate of mouse click that began the drag - timestamp of mouse click that began the drag + timestamp of mouse click that began the drag - - Begins a window move operation (for a toplevel window). -You might use this function to implement a “window move grip,” for + + Begins a window move operation (for a toplevel window). +You might use this function to implement a “window move grip,” for example. The function works best with window managers that support the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) but has a fallback implementation for other window managers. @@ -28633,50 +20046,33 @@ but has a fallback implementation for other window managers. - a toplevel #GdkWindow + a toplevel #GdkWindow - the device used for the operation + the device used for the operation - the button being used to drag, or 0 for a keyboard-initiated drag + the button being used to drag, or 0 for a keyboard-initiated drag - root window X coordinate of mouse click that began the drag + root window X coordinate of mouse click that began the drag - root window Y coordinate of mouse click that began the drag + root window Y coordinate of mouse click that began the drag - timestamp of mouse click that began the drag + timestamp of mouse click that began the drag - - A convenience wrapper around gdk_window_begin_paint_region() which + + A convenience wrapper around gdk_window_begin_paint_region() which creates a rectangular region for you. See gdk_window_begin_paint_region() for details. Use gdk_window_begin_draw_frame() instead @@ -28686,26 +20082,17 @@ gdk_window_begin_paint_region() for details. - a #GdkWindow + a #GdkWindow - rectangle you intend to draw to + rectangle you intend to draw to - - Indicates that you are beginning the process of redrawing @region. + + Indicates that you are beginning the process of redrawing @region. A backing store (offscreen buffer) large enough to contain @region will be created. The backing store will be initialized with the background color or background surface for @window. Then, all @@ -28726,7 +20113,7 @@ programmer, so you can avoid doing that work yourself. When using GTK+, the widget system automatically places calls to gdk_window_begin_paint_region() and gdk_window_end_paint() around -emissions of the expose_event signal. That is, if you’re writing an +emissions of the expose_event signal. That is, if you’re writing an expose event handler, you can assume that the exposed area in #GdkEventExpose has already been cleared to the window background, is already set as the clip region, and already has a backing store. @@ -28750,24 +20137,17 @@ gdk_window_begin_paint_region(). - a #GdkWindow + a #GdkWindow - region you intend to draw to + region you intend to draw to - - Begins a window resize operation (for a toplevel window). + + Begins a window resize operation (for a toplevel window). This function assumes that the drag is controlled by the client pointer device, use gdk_window_begin_resize_drag_for_device() @@ -28778,50 +20158,34 @@ to begin a drag with a different device. - a toplevel #GdkWindow + a toplevel #GdkWindow - the edge or corner from which the drag is started + the edge or corner from which the drag is started - the button being used to drag, or 0 for a keyboard-initiated drag + the button being used to drag, or 0 for a keyboard-initiated drag - root window X coordinate of mouse click that began the drag + root window X coordinate of mouse click that began the drag - root window Y coordinate of mouse click that began the drag + root window Y coordinate of mouse click that began the drag - timestamp of mouse click that began the drag (use gdk_event_get_time()) + timestamp of mouse click that began the drag (use gdk_event_get_time()) - - Begins a window resize operation (for a toplevel window). -You might use this function to implement a “window resize grip,” for + + Begins a window resize operation (for a toplevel window). +You might use this function to implement a “window resize grip,” for example; in fact #GtkStatusbar uses it. The function works best with window managers that support the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) @@ -28832,57 +20196,37 @@ but has a fallback implementation for other window managers. - a toplevel #GdkWindow + a toplevel #GdkWindow - the edge or corner from which the drag is started + the edge or corner from which the drag is started - the device used for the operation + the device used for the operation - the button being used to drag, or 0 for a keyboard-initiated drag + the button being used to drag, or 0 for a keyboard-initiated drag - root window X coordinate of mouse click that began the drag + root window X coordinate of mouse click that began the drag - root window Y coordinate of mouse click that began the drag + root window Y coordinate of mouse click that began the drag - timestamp of mouse click that began the drag (use gdk_event_get_time()) + timestamp of mouse click that began the drag (use gdk_event_get_time()) - - Does nothing, present only for compatiblity. + + Does nothing, present only for compatiblity. this function is no longer needed @@ -28890,19 +20234,13 @@ but has a fallback implementation for other window managers. - a toplevel #GdkWindow + a toplevel #GdkWindow - - Transforms window coordinates from a parent window to a child + + Transforms window coordinates from a parent window to a child window, where the parent window is the normal parent as returned by gdk_window_get_parent() for normal windows, and the window's embedder as returned by gdk_offscreen_window_get_embedder() for @@ -28924,53 +20262,29 @@ See also: gdk_window_coords_to_parent() - a child window + a child window - X coordinate in parent’s coordinate system + X coordinate in parent’s coordinate system - Y coordinate in parent’s coordinate system + Y coordinate in parent’s coordinate system - - return location for X coordinate in child’s coordinate system + + return location for X coordinate in child’s coordinate system - - return location for Y coordinate in child’s coordinate system + + return location for Y coordinate in child’s coordinate system - - Transforms window coordinates from a child window to its parent + + Transforms window coordinates from a child window to its parent window, where the parent window is the normal parent as returned by gdk_window_get_parent() for normal windows, and the window's embedder as returned by gdk_offscreen_window_get_embedder() for @@ -28992,56 +20306,31 @@ See also: gdk_window_coords_from_parent() - a child window + a child window - X coordinate in child’s coordinate system + X coordinate in child’s coordinate system - Y coordinate in child’s coordinate system + Y coordinate in child’s coordinate system - - return location for X coordinate -in parent’s coordinate system, or %NULL + + return location for X coordinate +in parent’s coordinate system, or %NULL - - return location for Y coordinate -in parent’s coordinate system, or %NULL + + return location for Y coordinate +in parent’s coordinate system, or %NULL - - Creates a new #GdkGLContext matching the + + Creates a new #GdkGLContext matching the framebuffer format to the visual of the #GdkWindow. The context is disconnected from any particular window or surface. @@ -29051,27 +20340,19 @@ Before using the returned #GdkGLContext, you will need to call gdk_gl_context_make_current() or gdk_gl_context_realize(). - the newly created #GdkGLContext, or + the newly created #GdkGLContext, or %NULL on error - a #GdkWindow + a #GdkWindow - - Create a new image surface that is efficient to draw on the + + Create a new image surface that is efficient to draw on the given @window. Initially the surface contents are all 0 (transparent if contents @@ -29101,60 +20382,41 @@ surface's device scale is set to @scale, or to the scale factor of @window if @scale is 0. - a pointer to the newly allocated surface. The caller + a pointer to the newly allocated surface. The caller owns the surface and should call cairo_surface_destroy() when done with it. This function always returns a valid pointer, but it will return a -pointer to a “nil” surface if @other is already in an error state +pointer to a “nil” surface if @other is already in an error state or any other error occurs. - - window to make new surface similar to, or + + window to make new surface similar to, or %NULL if none - the format for the new surface - + the format for the new surface + - width of the new surface + width of the new surface - height of the new surface + height of the new surface - the scale of the new surface, or 0 to use same as @window + the scale of the new surface, or 0 to use same as @window - - Create a new surface that is as compatible as possible with the + + Create a new surface that is as compatible as possible with the given @window. For example the new surface will have the same fallback resolution and font options as @window. Generally, the new surface will also use the same backend as @window, unless that is @@ -29165,48 +20427,36 @@ Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.) - a pointer to the newly allocated surface. The caller + a pointer to the newly allocated surface. The caller owns the surface and should call cairo_surface_destroy() when done with it. This function always returns a valid pointer, but it will return a -pointer to a “nil” surface if @other is already in an error state +pointer to a “nil” surface if @other is already in an error state or any other error occurs. - window to make new surface similar to + window to make new surface similar to - the content for the new surface + the content for the new surface - width of the new surface + width of the new surface - height of the new surface + height of the new surface - Attempt to deiconify (unminimize) @window. On X11 the window manager may + Attempt to deiconify (unminimize) @window. On X11 the window manager may choose to ignore the request to deiconify. When using GTK+, use gtk_window_deiconify() instead of the #GdkWindow variant. Or better yet, you probably want to use gtk_window_present_with_time(), which raises the window, focuses it, @@ -29217,19 +20467,15 @@ unminimizes it, and puts it on the current desktop. - a toplevel #GdkWindow + a toplevel #GdkWindow - Destroys the window system resources associated with @window and decrements @window's + Destroys the window system resources associated with @window and decrements @window's reference count. The window system resources for all children of @window are also -destroyed, but the children’s reference counts are not decremented. +destroyed, but the children’s reference counts are not decremented. Note that a window will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens. @@ -29239,9 +20485,7 @@ reaches zero. You must call this function yourself before that happens. - a #GdkWindow + a #GdkWindow @@ -29257,14 +20501,8 @@ reaches zero. You must call this function yourself before that happens. - - Does nothing, present only for compatiblity. + + Does nothing, present only for compatiblity. this function is no longer needed @@ -29272,19 +20510,13 @@ reaches zero. You must call this function yourself before that happens. - a toplevel #GdkWindow + a toplevel #GdkWindow - - Indicates that the drawing of the contents of @window started with + + Indicates that the drawing of the contents of @window started with gdk_window_begin_frame() has been completed. This function will take care of destroying the #GdkDrawingContext. @@ -29297,23 +20529,17 @@ gdk_window_begin_frame() first. - a #GdkWindow + a #GdkWindow - the #GdkDrawingContext created by gdk_window_begin_draw_frame() + the #GdkDrawingContext created by gdk_window_begin_draw_frame() - Indicates that the backing store created by the most recent call + Indicates that the backing store created by the most recent call to gdk_window_begin_paint_region() should be copied onscreen and deleted, leaving the next-most-recent backing store or no backing store at all as the active paint region. See @@ -29327,19 +20553,13 @@ gdk_window_begin_paint_region() first. - a #GdkWindow + a #GdkWindow - - Tries to ensure that there is a window-system native window for this + + Tries to ensure that there is a window-system native window for this GdkWindow. This may fail in some situations, returning %FALSE. Offscreen window and children of them can never have native windows. @@ -29347,45 +20567,31 @@ Offscreen window and children of them can never have native windows. Some backends may not support native child windows. - %TRUE if the window has a native window, %FALSE otherwise + %TRUE if the window has a native window, %FALSE otherwise - a #GdkWindow + a #GdkWindow - - This function does nothing. + + This function does nothing. - a #GdkWindow + a #GdkWindow - Sets keyboard focus to @window. In most cases, gtk_window_present_with_time() + Sets keyboard focus to @window. In most cases, gtk_window_present_with_time() should be used on a #GtkWindow, rather than calling this function. @@ -29393,26 +20599,17 @@ should be used on a #GtkWindow, rather than calling this function. - a #GdkWindow + a #GdkWindow - timestamp of the event triggering the window focus + timestamp of the event triggering the window focus - - Temporarily freezes a window and all its descendants such that it won't + + Temporarily freezes a window and all its descendants such that it won't receive expose events. The window will begin receiving expose events again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If gdk_window_freeze_toplevel_updates_libgtk_only() @@ -29429,17 +20626,13 @@ for use by GTK+. - a #GdkWindow + a #GdkWindow - Temporarily freezes a window such that it won’t receive expose + Temporarily freezes a window such that it won’t receive expose events. The window will begin receiving expose events again when gdk_window_thaw_updates() is called. If gdk_window_freeze_updates() has been called more than once, gdk_window_thaw_updates() must be called @@ -29450,19 +20643,13 @@ an equal number of times to begin processing exposes. - a #GdkWindow + a #GdkWindow - - Moves the window into fullscreen mode. This means the + + Moves the window into fullscreen mode. This means the window covers the entire screen and is above any panels or task bars. @@ -29471,7 +20658,7 @@ If the window was already fullscreen, then this function does nothing. On X11, asks the window manager to put @window in a fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or -don’t have a concept of “fullscreen”; so you can’t rely on the +don’t have a concept of “fullscreen”; so you can’t rely on the fullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. @@ -29481,18 +20668,13 @@ it to happen. - a toplevel #GdkWindow + a toplevel #GdkWindow - - Moves the window into fullscreen mode on the given monitor. This means + + Moves the window into fullscreen mode on the given monitor. This means the window covers the entire screen and is above any panels or task bars. If the window was already fullscreen, then this function does nothing. @@ -29503,25 +20685,17 @@ If the window was already fullscreen, then this function does nothing. - a toplevel #GdkWindow + a toplevel #GdkWindow - Which monitor to display fullscreen on. + Which monitor to display fullscreen on. - - This function informs GDK that the geometry of an embedded + + This function informs GDK that the geometry of an embedded offscreen window has changed. This is necessary for GDK to keep track of which offscreen window the pointer is in. @@ -29530,77 +20704,53 @@ track of which offscreen window the pointer is in. - an embedded offscreen #GdkWindow + an embedded offscreen #GdkWindow - - Determines whether or not the desktop environment shuld be hinted that + + Determines whether or not the desktop environment shuld be hinted that the window does not want to receive input focus. - whether or not the window should receive input focus. + whether or not the window should receive input focus. - a toplevel #GdkWindow. + a toplevel #GdkWindow. - - Gets the pattern used to clear the background on @window. + + Gets the pattern used to clear the background on @window. Don't use this function - The pattern to use for the + The pattern to use for the background or %NULL if there is no background. - a window + a window - Gets the list of children of @window known to GDK. + Gets the list of children of @window known to GDK. This function only returns children created via GDK, -so for example it’s useless when used with the root window; +so for example it’s useless when used with the root window; it only returns windows an application created itself. The returned list must be freed, but the elements in the list need not be. - + list of child windows inside @window @@ -29608,19 +20758,13 @@ list need not be. - a #GdkWindow + a #GdkWindow - - Gets the list of children of @window known to GDK with a + + Gets the list of children of @window known to GDK with a particular @user_data set on it. The returned list must be freed, but the elements in the @@ -29630,9 +20774,7 @@ The list is returned in (relative) stacking order, i.e. the lowest window is first. - + list of child windows inside @window @@ -29640,89 +20782,60 @@ lowest window is first. - a #GdkWindow + a #GdkWindow - - user data to look for + + user data to look for - Computes the region of a window that potentially can be written + Computes the region of a window that potentially can be written to by drawing primitives. This region may not take into account other factors such as if the window is obscured by other windows, but no area outside of this region will be affected by drawing primitives. - a #cairo_region_t. This must be freed with cairo_region_destroy() + a #cairo_region_t. This must be freed with cairo_region_destroy() when you are done. - a #GdkWindow + a #GdkWindow - - Determines whether @window is composited. + + Determines whether @window is composited. See gdk_window_set_composited(). Compositing is an outdated technology that only ever worked on X11. - %TRUE if the window is composited. + %TRUE if the window is composited. - a #GdkWindow + a #GdkWindow - - Retrieves a #GdkCursor pointer for the cursor currently set on the + + Retrieves a #GdkCursor pointer for the cursor currently set on the specified #GdkWindow, or %NULL. If the return value is %NULL then there is no custom cursor set on the specified window, and it is using the cursor for its parent window. - a #GdkCursor, or %NULL. The + a #GdkCursor, or %NULL. The returned object is owned by the #GdkWindow and should not be unreferenced directly. Use gdk_window_set_cursor() to unset the cursor of the window @@ -29730,57 +20843,38 @@ using the cursor for its parent window. - a #GdkWindow + a #GdkWindow - Returns the decorations set on the GdkWindow with + Returns the decorations set on the GdkWindow with gdk_window_set_decorations(). - %TRUE if the window has decorations set, %FALSE otherwise. + %TRUE if the window has decorations set, %FALSE otherwise. - The toplevel #GdkWindow to get the decorations from + The toplevel #GdkWindow to get the decorations from - - The window decorations will be written here + + The window decorations will be written here - - Retrieves a #GdkCursor pointer for the @device currently set on the + + Retrieves a #GdkCursor pointer for the @device currently set on the specified #GdkWindow, or %NULL. If the return value is %NULL then there is no custom cursor set on the specified window, and it is using the cursor for its parent window. - a #GdkCursor, or %NULL. The + a #GdkCursor, or %NULL. The returned object is owned by the #GdkWindow and should not be unreferenced directly. Use gdk_window_set_cursor() to unset the cursor of the window @@ -29788,268 +20882,157 @@ using the cursor for its parent window. - a #GdkWindow. + a #GdkWindow. - a master, pointer #GdkDevice. + a master, pointer #GdkDevice. - - Returns the event mask for @window corresponding to an specific device. + + Returns the event mask for @window corresponding to an specific device. - device event mask for @window + device event mask for @window - a #GdkWindow. + a #GdkWindow. - a #GdkDevice. + a #GdkDevice. - - Obtains the current device position and modifier state. + + Obtains the current device position and modifier state. The position is given in coordinates relative to the upper left corner of @window. Use gdk_window_get_device_position_double() if you need subpixel precision. - The window underneath @device + The window underneath @device (as with gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK. - a #GdkWindow. + a #GdkWindow. - pointer #GdkDevice to query to. + pointer #GdkDevice to query to. - - return location for the X coordinate of @device, or %NULL. + + return location for the X coordinate of @device, or %NULL. - - return location for the Y coordinate of @device, or %NULL. + + return location for the Y coordinate of @device, or %NULL. - - return location for the modifier mask, or %NULL. + + return location for the modifier mask, or %NULL. - - Obtains the current device position in doubles and modifier state. + + Obtains the current device position in doubles and modifier state. The position is given in coordinates relative to the upper left corner of @window. - The window underneath @device + The window underneath @device (as with gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK. - a #GdkWindow. + a #GdkWindow. - pointer #GdkDevice to query to. + pointer #GdkDevice to query to. - - return location for the X coordinate of @device, or %NULL. + + return location for the X coordinate of @device, or %NULL. - - return location for the Y coordinate of @device, or %NULL. + + return location for the Y coordinate of @device, or %NULL. - - return location for the modifier mask, or %NULL. + + return location for the modifier mask, or %NULL. - - Gets the #GdkDisplay associated with a #GdkWindow. + + Gets the #GdkDisplay associated with a #GdkWindow. - the #GdkDisplay associated with @window + the #GdkDisplay associated with @window - a #GdkWindow + a #GdkWindow - - Finds out the DND protocol supported by a window. + + Finds out the DND protocol supported by a window. - the supported DND protocol. + the supported DND protocol. - the destination window + the destination window - - location of the window + + location of the window where the drop should happen. This may be @window or a proxy window, or %NULL if @window does not support Drag and Drop. - - Obtains the parent of @window, as known to GDK. Works like + + Obtains the parent of @window, as known to GDK. Works like gdk_window_get_parent() for normal windows, but returns the -window’s embedder for offscreen windows. +window’s embedder for offscreen windows. See also: gdk_offscreen_window_get_embedder() - effective parent of @window + effective parent of @window - a #GdkWindow + a #GdkWindow - - Gets the toplevel window that’s an ancestor of @window. + + Gets the toplevel window that’s an ancestor of @window. Works like gdk_window_get_toplevel(), but treats an offscreen window's embedder as its parent, using gdk_window_get_effective_parent(). @@ -30057,116 +21040,79 @@ embedder as its parent, using gdk_window_get_effective_parent(). See also: gdk_offscreen_window_get_embedder() - the effective toplevel window containing @window + the effective toplevel window containing @window - a #GdkWindow + a #GdkWindow - - Get the current event compression setting for this window. + + Get the current event compression setting for this window. - %TRUE if motion events will be compressed + %TRUE if motion events will be compressed - a #GdkWindow + a #GdkWindow - Gets the event mask for @window for all master input devices. See + Gets the event mask for @window for all master input devices. See gdk_window_set_events(). - event mask for @window + event mask for @window - a #GdkWindow + a #GdkWindow - - Determines whether or not the desktop environment should be hinted that the + + Determines whether or not the desktop environment should be hinted that the window does not want to receive input focus when it is mapped. - whether or not the window wants to receive input focus when + whether or not the window wants to receive input focus when it is mapped. - a toplevel #GdkWindow. + a toplevel #GdkWindow. - - Gets the frame clock for the window. The frame clock for a window + + Gets the frame clock for the window. The frame clock for a window never changes unless the window is reparented to a new toplevel window. - the frame clock + the frame clock - window to get frame clock for + window to get frame clock for - - Obtains the bounding box of the window, including window manager + + Obtains the bounding box of the window, including window manager titlebar/borders if any. The frame position is given in root window coordinates. To get the position of the window itself (rather than the frame) in root window coordinates, use gdk_window_get_origin(). @@ -30176,49 +21122,32 @@ the frame) in root window coordinates, use gdk_window_get_origin(). - a toplevel #GdkWindow + a toplevel #GdkWindow - - rectangle to fill with bounding box of the window frame + + rectangle to fill with bounding box of the window frame - - Obtains the #GdkFullscreenMode of the @window. + + Obtains the #GdkFullscreenMode of the @window. - The #GdkFullscreenMode applied to the window when fullscreen. + The #GdkFullscreenMode applied to the window when fullscreen. - a toplevel #GdkWindow + a toplevel #GdkWindow - Any of the return location arguments to this function may be %NULL, -if you aren’t interested in getting the value of that field. + Any of the return location arguments to this function may be %NULL, +if you aren’t interested in getting the value of that field. The X and Y coordinates returned are relative to the parent window of @window, which for toplevels usually means relative to the @@ -30243,179 +21172,103 @@ the 16-bit coordinates of X11. - a #GdkWindow + a #GdkWindow - - return location for X coordinate of window (relative to its parent) + + return location for X coordinate of window (relative to its parent) - - return location for Y coordinate of window (relative to its parent) + + return location for Y coordinate of window (relative to its parent) - - return location for width of window + + return location for width of window - - return location for height of window + + return location for height of window - - Returns the group leader window for @window. See gdk_window_set_group(). + + Returns the group leader window for @window. See gdk_window_set_group(). - the group leader window for @window + the group leader window for @window - a toplevel #GdkWindow + a toplevel #GdkWindow - - Returns the height of the given @window. + + Returns the height of the given @window. On the X11 platform the returned size is the size reported in the most-recently-processed configure event, rather than the current size on the X server. - The height of @window + The height of @window - a #GdkWindow + a #GdkWindow - - Determines whether or not the window manager is hinted that @window + + Determines whether or not the window manager is hinted that @window has modal behaviour. - whether or not the window has the modal hint set. + whether or not the window has the modal hint set. - A toplevel #GdkWindow. + A toplevel #GdkWindow. - Obtains the position of a window in root window coordinates. + Obtains the position of a window in root window coordinates. (Compare with gdk_window_get_position() and gdk_window_get_geometry() which return the position of a window relative to its parent window.) - not meaningful, ignore + not meaningful, ignore - a #GdkWindow + a #GdkWindow - - return location for X coordinate + + return location for X coordinate - - return location for Y coordinate + + return location for Y coordinate - Obtains the parent of @window, as known to GDK. Does not query the + Obtains the parent of @window, as known to GDK. Does not query the X server; thus this returns the parent as passed to gdk_window_new(), -not the actual parent. This should never matter unless you’re using +not the actual parent. This should never matter unless you’re using Xlib calls mixed with GDK calls on the X11 platform. It may also matter for toplevel windows, because the window manager may choose to reparent them. @@ -30426,26 +21279,18 @@ gdk_window_get_parent() will most likely not do what you expect if there are offscreen windows in the hierarchy. - parent of @window + parent of @window - a #GdkWindow + a #GdkWindow - - Returns whether input to the window is passed through to the window + + Returns whether input to the window is passed through to the window below. See gdk_window_set_pass_through() for details @@ -30455,128 +21300,74 @@ See gdk_window_set_pass_through() for details - a #GdkWindow + a #GdkWindow - - Obtains the current pointer position and modifier state. + + Obtains the current pointer position and modifier state. The position is given in coordinates relative to the upper left corner of @window. Use gdk_window_get_device_position() instead. - the window containing the + the window containing the pointer (as with gdk_window_at_pointer()), or %NULL if the window -containing the pointer isn’t known to GDK +containing the pointer isn’t known to GDK - a #GdkWindow + a #GdkWindow - - return location for X coordinate of pointer or %NULL to not + + return location for X coordinate of pointer or %NULL to not return the X coordinate - - return location for Y coordinate of pointer or %NULL to not + + return location for Y coordinate of pointer or %NULL to not return the Y coordinate - - return location for modifier mask or %NULL to not return the + + return location for modifier mask or %NULL to not return the modifier mask - Obtains the position of the window as reported in the + Obtains the position of the window as reported in the most-recently-processed #GdkEventConfigure. Contrast with gdk_window_get_geometry() which queries the X server for the current window position, regardless of which events have been received or processed. -The position coordinates are relative to the window’s parent window. +The position coordinates are relative to the window’s parent window. - a #GdkWindow + a #GdkWindow - - X coordinate of window + + X coordinate of window - - Y coordinate of window + + Y coordinate of window - - Obtains the position of a window position in root + + Obtains the position of a window position in root window coordinates. This is similar to gdk_window_get_origin() but allows you to pass in any position in the window, not just the origin. @@ -30586,47 +21377,29 @@ in any position in the window, not just the origin. - a #GdkWindow + a #GdkWindow - X coordinate in window + X coordinate in window - Y coordinate in window + Y coordinate in window - - return location for X coordinate + + return location for X coordinate - - return location for Y coordinate + + return location for Y coordinate - Obtains the top-left corner of the window manager frame in root + Obtains the top-left corner of the window manager frame in root window coordinates. @@ -30634,37 +21407,21 @@ window coordinates. - a toplevel #GdkWindow + a toplevel #GdkWindow - - return location for X position of window frame + + return location for X position of window frame - - return location for Y position of window frame + + return location for Y position of window frame - - Returns the internal scale factor that maps from window coordiantes + + Returns the internal scale factor that maps from window coordiantes to the actual device pixels. On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2). @@ -30678,194 +21435,137 @@ The scale of a window may change during runtime, if this happens a configure event will be sent to the toplevel window. - the scale factor + the scale factor - window to get scale factor for + window to get scale factor for - - Gets the #GdkScreen associated with a #GdkWindow. + + Gets the #GdkScreen associated with a #GdkWindow. - the #GdkScreen associated with @window + the #GdkScreen associated with @window - a #GdkWindow + a #GdkWindow - - Returns the event mask for @window corresponding to the device class specified + + Returns the event mask for @window corresponding to the device class specified by @source. - source event mask for @window + source event mask for @window - a #GdkWindow + a #GdkWindow - a #GdkInputSource to define the source class. + a #GdkInputSource to define the source class. - Gets the bitwise OR of the currently active window state flags, + Gets the bitwise OR of the currently active window state flags, from the #GdkWindowState enumeration. - window state bitfield + window state bitfield - a #GdkWindow + a #GdkWindow - - Returns %TRUE if the window is aware of the existence of multiple + + Returns %TRUE if the window is aware of the existence of multiple devices. - %TRUE if the window handles multidevice features. + %TRUE if the window handles multidevice features. - a #GdkWindow. + a #GdkWindow. - Gets the toplevel window that’s an ancestor of @window. + Gets the toplevel window that’s an ancestor of @window. Any window type but %GDK_WINDOW_CHILD is considered a toplevel window, as is a %GDK_WINDOW_CHILD window that has a root window as parent. Note that you should use gdk_window_get_effective_toplevel() when -you want to get to a window’s toplevel as seen on screen, because +you want to get to a window’s toplevel as seen on screen, because gdk_window_get_toplevel() will most likely not do what you expect if there are offscreen windows in the hierarchy. - the toplevel window containing @window + the toplevel window containing @window - a #GdkWindow + a #GdkWindow - - This function returns the type hint set for a window. + + This function returns the type hint set for a window. - The type hint set for @window + The type hint set for @window - A toplevel #GdkWindow + A toplevel #GdkWindow - Transfers ownership of the update area from @window to the caller + Transfers ownership of the update area from @window to the caller of the function. That is, after calling this function, @window will no longer have an invalid/dirty region; the update area is removed from @window and handed to you. If a window has no update area, gdk_window_get_update_area() returns %NULL. You are responsible for -calling cairo_region_destroy() on the returned region if it’s non-%NULL. +calling cairo_region_destroy() on the returned region if it’s non-%NULL. - the update area for @window + the update area for @window - a #GdkWindow + a #GdkWindow - Retrieves the user data for @window, which is normally the widget + Retrieves the user data for @window, which is normally the widget that @window belongs to. See gdk_window_set_user_data(). @@ -30873,145 +21573,98 @@ that @window belongs to. See gdk_window_set_user_data(). - a #GdkWindow + a #GdkWindow - - return location for user data + + return location for user data - - Computes the region of the @window that is potentially visible. + + Computes the region of the @window that is potentially visible. This does not necessarily take into account if the window is obscured by other windows, but no area outside of this region is visible. - a #cairo_region_t. This must be freed with cairo_region_destroy() + a #cairo_region_t. This must be freed with cairo_region_destroy() when you are done. - a #GdkWindow + a #GdkWindow - - Gets the #GdkVisual describing the pixel format of @window. + + Gets the #GdkVisual describing the pixel format of @window. - a #GdkVisual + a #GdkVisual - a #GdkWindow + a #GdkWindow - - Returns the width of the given @window. + + Returns the width of the given @window. On the X11 platform the returned size is the size reported in the most-recently-processed configure event, rather than the current size on the X server. - The width of @window + The width of @window - a #GdkWindow + a #GdkWindow - Gets the type of the window. See #GdkWindowType. + Gets the type of the window. See #GdkWindowType. - type of window + type of window - a #GdkWindow + a #GdkWindow - - Checks whether the window has a native window or not. Note that + + Checks whether the window has a native window or not. Note that you can use gdk_window_ensure_native() if a native window is needed. - %TRUE if the @window has a native window, %FALSE otherwise. + %TRUE if the @window has a native window, %FALSE otherwise. - a #GdkWindow + a #GdkWindow - For toplevel windows, withdraws them, so they will no longer be + For toplevel windows, withdraws them, so they will no longer be known to the window manager; for all windows, unmaps them, so -they won’t be displayed. Normally done automatically as +they won’t be displayed. Normally done automatically as part of gtk_widget_hide(). @@ -31019,17 +21672,13 @@ part of gtk_widget_hide(). - a #GdkWindow + a #GdkWindow - Asks to iconify (minimize) @window. The window manager may choose + Asks to iconify (minimize) @window. The window manager may choose to ignore the request, but normally will honor it. Using gtk_window_iconify() is preferred, if you have a #GtkWindow widget. @@ -31040,19 +21689,13 @@ This function only makes sense when @window is a toplevel window. - a toplevel #GdkWindow + a toplevel #GdkWindow - - Like gdk_window_shape_combine_region(), but the shape applies + + Like gdk_window_shape_combine_region(), but the shape applies only to event handling. Mouse events which happen while the pointer position corresponds to an unset bit in the mask will be passed on the window below @window. @@ -31061,7 +21704,7 @@ An input shape is typically used with RGBA windows. The alpha channel of the window defines which pixels are invisible and allows for nicely antialiased borders, and the input shape controls where the window is -“clickable”. +“clickable”. On the X11 platform, this requires version 1.1 of the shape extension. @@ -31074,37 +21717,26 @@ function does nothing. - a #GdkWindow + a #GdkWindow - region of window to be non-transparent + region of window to be non-transparent - X position of @shape_region in @window coordinates + X position of @shape_region in @window coordinates - Y position of @shape_region in @window coordinates + Y position of @shape_region in @window coordinates - - Adds @region to the update area for @window. The update area is the -region that needs to be redrawn, or “dirty region.” The call + + Adds @region to the update area for @window. The update area is the +region that needs to be redrawn, or “dirty region.” The call gdk_window_process_updates() sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of @window in @@ -31112,7 +21744,7 @@ response to those expose events. GDK will call gdk_window_process_all_updates() on your behalf whenever your program returns to the main loop and becomes idle, so -normally there’s no need to do that manually, you just need to +normally there’s no need to do that manually, you just need to invalidate regions that you know should be redrawn. The @child_func parameter controls whether the region of @@ -31125,44 +21757,26 @@ invalidated. - a #GdkWindow + a #GdkWindow - a #cairo_region_t + a #cairo_region_t - - function to use to decide if to + + function to use to decide if to recurse to a child, %NULL means never recurse. - - data passed to @child_func + + data passed to @child_func - A convenience wrapper around gdk_window_invalidate_region() which + A convenience wrapper around gdk_window_invalidate_region() which invalidates a rectangular region. See gdk_window_invalidate_region() for details. @@ -31171,35 +21785,23 @@ gdk_window_invalidate_region() for details. - a #GdkWindow + a #GdkWindow - - rectangle to invalidate or %NULL to invalidate the whole + + rectangle to invalidate or %NULL to invalidate the whole window - whether to also invalidate child windows + whether to also invalidate child windows - - Adds @region to the update area for @window. The update area is the -region that needs to be redrawn, or “dirty region.” The call + + Adds @region to the update area for @window. The update area is the +region that needs to be redrawn, or “dirty region.” The call gdk_window_process_updates() sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of @window in @@ -31207,7 +21809,7 @@ response to those expose events. GDK will call gdk_window_process_all_updates() on your behalf whenever your program returns to the main loop and becomes idle, so -normally there’s no need to do that manually, you just need to +normally there’s no need to do that manually, you just need to invalidate regions that you know should be redrawn. The @invalidate_children parameter controls whether the region of @@ -31221,139 +21823,95 @@ fine grained control over which children are invalidated. - a #GdkWindow + a #GdkWindow - a #cairo_region_t + a #cairo_region_t - %TRUE to also invalidate child windows + %TRUE to also invalidate child windows - - Check to see if a window is destroyed.. + + Check to see if a window is destroyed.. - %TRUE if the window is destroyed + %TRUE if the window is destroyed - a #GdkWindow + a #GdkWindow - - Determines whether or not the window is an input only window. + + Determines whether or not the window is an input only window. - %TRUE if @window is input only + %TRUE if @window is input only - a toplevel #GdkWindow + a toplevel #GdkWindow - - Determines whether or not the window is shaped. + + Determines whether or not the window is shaped. - %TRUE if @window is shaped + %TRUE if @window is shaped - a toplevel #GdkWindow + a toplevel #GdkWindow - Check if the window and all ancestors of the window are + Check if the window and all ancestors of the window are mapped. (This is not necessarily "viewable" in the X sense, since we only check as far as we have GDK window parents, not to the root window.) - %TRUE if the window is viewable + %TRUE if the window is viewable - a #GdkWindow + a #GdkWindow - Checks whether the window has been mapped (with gdk_window_show() or + Checks whether the window has been mapped (with gdk_window_show() or gdk_window_show_unraised()). - %TRUE if the window is mapped + %TRUE if the window is mapped - a #GdkWindow + a #GdkWindow - Lowers @window to the bottom of the Z-order (stacking order), so that + Lowers @window to the bottom of the Z-order (stacking order), so that other windows with the same parent window appear above @window. This is true whether or not the other windows are visible. @@ -31361,7 +21919,7 @@ If @window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_lower() only requests the restack, does not guarantee it. -Note that gdk_window_show() raises the window again, so don’t call this +Note that gdk_window_show() raises the window again, so don’t call this function before gdk_window_show(). (Try gdk_window_show_unraised().) @@ -31369,19 +21927,13 @@ function before gdk_window_show(). (Try gdk_window_show_unraised().) - a #GdkWindow + a #GdkWindow - - If you call this during a paint (e.g. between gdk_window_begin_paint_region() + + If you call this during a paint (e.g. between gdk_window_begin_paint_region() and gdk_window_end_paint() then GDK will mark the current clip region of the window as being drawn. This is required when mixing GL rendering via gdk_cairo_draw_from_gl() and cairo rendering, as otherwise GDK has no way @@ -31395,29 +21947,23 @@ to care about this. - a #GdkWindow + a #GdkWindow - a #cairo_t + a #cairo_t - Maximizes the window. If the window was already maximized, then + Maximizes the window. If the window was already maximized, then this function does nothing. On X11, asks the window manager to maximize @window, if the window manager supports this operation. Not all window managers support -this, and some deliberately ignore it or don’t have a concept of -“maximized”; so you can’t rely on the maximization actually +this, and some deliberately ignore it or don’t have a concept of +“maximized”; so you can’t rely on the maximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. @@ -31428,25 +21974,19 @@ On Windows, reliably maximizes the window. - a toplevel #GdkWindow + a toplevel #GdkWindow - - Merges the input shape masks for any child windows into the + + Merges the input shape masks for any child windows into the input shape mask for @window. i.e. the union of all input masks for @window and its children will become the new input mask for @window. See gdk_window_input_shape_combine_region(). This function is distinct from gdk_window_set_child_input_shapes() -because it includes @window’s input shape mask in the set of +because it includes @window’s input shape mask in the set of shapes to be merged. @@ -31454,24 +21994,19 @@ shapes to be merged. - a #GdkWindow + a #GdkWindow - - Merges the shape masks for any child windows into the + + Merges the shape masks for any child windows into the shape mask for @window. i.e. the union of all masks for @window and its children will become the new mask for @window. See gdk_window_shape_combine_region(). This function is distinct from gdk_window_set_child_shapes() -because it includes @window’s shape mask in the set of shapes to +because it includes @window’s shape mask in the set of shapes to be merged. @@ -31479,23 +22014,19 @@ be merged. - a #GdkWindow + a #GdkWindow - Repositions a window relative to its parent window. + Repositions a window relative to its parent window. For toplevel windows, window managers may ignore or modify the move; you should probably use gtk_window_move() on a #GtkWindow widget anyway, instead of using GDK functions. For child windows, the move will reliably succeed. -If you’re also planning to resize the window, use gdk_window_move_resize() +If you’re also planning to resize the window, use gdk_window_move_resize() to both move and resize simultaneously, for a nicer visual effect. @@ -31503,31 +22034,21 @@ to both move and resize simultaneously, for a nicer visual effect. - a #GdkWindow + a #GdkWindow - X coordinate relative to window’s parent + X coordinate relative to window’s parent - Y coordinate relative to window’s parent + Y coordinate relative to window’s parent - - Move the part of @window indicated by @region by @dy pixels in the Y + + Move the part of @window indicated by @region by @dy pixels in the Y direction and @dx pixels in the X direction. The portions of @region that not covered by the new position of @region are invalidated. @@ -31538,81 +22059,57 @@ Child windows are not moved. - a #GdkWindow + a #GdkWindow - The #cairo_region_t to move + The #cairo_region_t to move - Amount to move in the X direction + Amount to move in the X direction - Amount to move in the Y direction + Amount to move in the Y direction - Equivalent to calling gdk_window_move() and gdk_window_resize(), + Equivalent to calling gdk_window_move() and gdk_window_resize(), except that both operations are performed at once, avoiding strange visual effects. (i.e. the user may be able to see the window first -move, then resize, if you don’t use gdk_window_move_resize().) +move, then resize, if you don’t use gdk_window_move_resize().) - a #GdkWindow + a #GdkWindow - new X position relative to window’s parent + new X position relative to window’s parent - new Y position relative to window’s parent + new Y position relative to window’s parent - new width + new width - new height + new height - - Moves @window to @rect, aligning their anchor points. + + Moves @window to @rect, aligning their anchor points. @rect is relative to the top-left corner of the window that @window is transient for. @rect_anchor and @window_anchor determine anchor points on @@ -31633,60 +22130,42 @@ actually positioned. - the #GdkWindow to move + the #GdkWindow to move - the destination #GdkRectangle to align @window with + the destination #GdkRectangle to align @window with - the point on @rect to align with @window's anchor point + the point on @rect to align with @window's anchor point - the point on @window to align with @rect's anchor point + the point on @window to align with @rect's anchor point - positioning hints to use when limited on space + positioning hints to use when limited on space - horizontal offset to shift @window, i.e. @rect's anchor + horizontal offset to shift @window, i.e. @rect's anchor point - vertical offset to shift @window, i.e. @rect's anchor point + vertical offset to shift @window, i.e. @rect's anchor point - Like gdk_window_get_children(), but does not copy the list of + Like gdk_window_get_children(), but does not copy the list of children, so the list does not need to be freed. - + a reference to the list of child windows in @window @@ -31694,23 +22173,16 @@ children, so the list does not need to be freed. - a #GdkWindow + a #GdkWindow - - Sends one or more expose events to @window. The areas in each + + Sends one or more expose events to @window. The areas in each expose event will cover the entire update area for the window (see gdk_window_invalidate_region() for details). Normally GDK calls -gdk_window_process_all_updates() on your behalf, so there’s no +gdk_window_process_all_updates() on your behalf, so there’s no need to call this function unless you want to force expose events to be delivered immediately and synchronously (vs. the usual case, where GDK delivers them in an idle handler). Occasionally @@ -31721,23 +22193,17 @@ this is useful to produce nicer scrolling behavior, for example. - a #GdkWindow + a #GdkWindow - whether to also process updates for child windows + whether to also process updates for child windows - Raises @window to the top of the Z-order (stacking order), so that + Raises @window to the top of the Z-order (stacking order), so that other windows with the same parent window appear below @window. This is true whether or not the windows are visible. @@ -31750,68 +22216,47 @@ requests the restack, does not guarantee it. - a #GdkWindow + a #GdkWindow - Registers a window as a potential drop destination. + Registers a window as a potential drop destination. - a #GdkWindow. + a #GdkWindow. - - Remove a filter previously added with gdk_window_add_filter(). + + Remove a filter previously added with gdk_window_add_filter(). - a #GdkWindow + a #GdkWindow - previously-added filter function + previously-added filter function - - user data for previously-added filter function + + user data for previously-added filter function - Reparents @window into the given @new_parent. The window being + Reparents @window into the given @new_parent. The window being reparented will be unmapped as a side effect. @@ -31819,41 +22264,31 @@ reparented will be unmapped as a side effect. - a #GdkWindow + a #GdkWindow - new parent to move @window into + new parent to move @window into - X location inside the new parent + X location inside the new parent - Y location inside the new parent + Y location inside the new parent - Resizes @window; for toplevel windows, asks the window manager to resize + Resizes @window; for toplevel windows, asks the window manager to resize the window. The window manager may not allow the resize. When using GTK+, use gtk_window_resize() instead of this low-level GDK function. Windows may not be resized below 1x1. -If you’re also planning to move the window, use gdk_window_move_resize() +If you’re also planning to move the window, use gdk_window_move_resize() to both move and resize simultaneously, for a nicer visual effect. @@ -31861,29 +22296,21 @@ to both move and resize simultaneously, for a nicer visual effect. - a #GdkWindow + a #GdkWindow - new width of the window + new width of the window - new height of the window + new height of the window - Changes the position of @window in the Z-order (stacking order), so that + Changes the position of @window in the Z-order (stacking order), so that it is above @sibling (if @above is %TRUE) or below @sibling (if @above is %FALSE). @@ -31899,39 +22326,28 @@ requests the restack, does not guarantee it. - a #GdkWindow + a #GdkWindow - - a #GdkWindow that is a sibling of @window, or %NULL + + a #GdkWindow that is a sibling of @window, or %NULL - a boolean + a boolean - Scroll the contents of @window, both pixels and children, by the + Scroll the contents of @window, both pixels and children, by the given amount. @window itself does not move. Portions of the window that the scroll operation brings in from offscreen areas are invalidated. The invalidated region may be bigger than what would strictly be necessary. For X11, a minimum area will be invalidated if the window has no -subwindows, or if the edges of the window’s parent do not extend +subwindows, or if the edges of the window’s parent do not extend beyond the edges of the window. In other cases, a multi-step process is used to scroll the window which may produce temporary visual artifacts and unnecessary invalidations. @@ -31941,32 +22357,22 @@ artifacts and unnecessary invalidations. - a #GdkWindow + a #GdkWindow - Amount to scroll in the X direction + Amount to scroll in the X direction - Amount to scroll in the Y direction + Amount to scroll in the Y direction - - Setting @accept_focus to %FALSE hints the desktop environment that the -window doesn’t want to receive input focus. + + Setting @accept_focus to %FALSE hints the desktop environment that the +window doesn’t want to receive input focus. On X, it is the responsibility of the window manager to interpret this hint. ICCCM-compliant window manager usually respect it. @@ -31976,30 +22382,21 @@ hint. ICCCM-compliant window manager usually respect it. - a toplevel #GdkWindow + a toplevel #GdkWindow - %TRUE if the window should receive input focus + %TRUE if the window should receive input focus - - Sets the background color of @window. + + Sets the background color of @window. However, when using GTK+, influence the background of a widget -using a style class or CSS — if you’re an application — or with -gtk_style_context_set_background() — if you're implementing a +using a style class or CSS — if you’re an application — or with +gtk_style_context_set_background() — if you're implementing a custom widget. Don't use this function @@ -32008,26 +22405,17 @@ custom widget. - a #GdkWindow + a #GdkWindow - a #GdkColor + a #GdkColor - - Sets the background of @window. + + Sets the background of @window. A background of %NULL means that the window won't have any background. On the X11 backend it's also possible to inherit the background from the parent @@ -32042,29 +22430,17 @@ when the window is obscured then exposed. - a #GdkWindow + a #GdkWindow - - a pattern to use, or %NULL + + a pattern to use, or %NULL - - Sets the background color of @window. + + Sets the background color of @window. See also gdk_window_set_background_pattern(). Don't use this function @@ -32074,25 +22450,17 @@ See also gdk_window_set_background_pattern(). - a #GdkWindow + a #GdkWindow - a #GdkRGBA color + a #GdkRGBA color - - Sets the input shape mask of @window to the union of input shape masks + + Sets the input shape mask of @window to the union of input shape masks for all children of @window, ignoring the input shape mask of @window itself. Contrast with gdk_window_merge_child_input_shapes() which includes the input shape mask of @window in the masks to be merged. @@ -32102,18 +22470,13 @@ the input shape mask of @window in the masks to be merged. - a #GdkWindow + a #GdkWindow - - Sets the shape mask of @window to the union of shape masks + + Sets the shape mask of @window to the union of shape masks for all children of @window, ignoring the shape mask of @window itself. Contrast with gdk_window_merge_child_shapes() which includes the shape mask of @window in the masks to be merged. @@ -32123,25 +22486,17 @@ the shape mask of @window in the masks to be merged. - a #GdkWindow + a #GdkWindow - - Sets a #GdkWindow as composited, or unsets it. Composited + + Sets a #GdkWindow as composited, or unsets it. Composited windows do not automatically have their contents drawn to the screen. Drawing is redirected to an offscreen buffer and an expose event is emitted on the parent of the composited -window. It is the responsibility of the parent’s expose handler +window. It is the responsibility of the parent’s expose handler to manually merge the off-screen content onto the screen in whatever way it sees fit. @@ -32167,23 +22522,17 @@ attempting to do so. - a #GdkWindow + a #GdkWindow - %TRUE to set the window as composited + %TRUE to set the window as composited - Sets the default mouse pointer for a #GdkWindow. + Sets the default mouse pointer for a #GdkWindow. Note that @cursor must be for the same display as @window. @@ -32198,26 +22547,17 @@ should use this default. - a #GdkWindow + a #GdkWindow - - a cursor + + a cursor - “Decorations” are the features the window manager adds to a toplevel #GdkWindow. + “Decorations” are the features the window manager adds to a toplevel #GdkWindow. This function sets the traditional Motif window manager hints that tell the window manager which decorations you would like your window to have. Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of @@ -32237,25 +22577,17 @@ but very few honor all possible combinations of bits. - a toplevel #GdkWindow + a toplevel #GdkWindow - decoration hint mask + decoration hint mask - - Sets a specific #GdkCursor for a given device when it gets inside @window. + + Sets a specific #GdkCursor for a given device when it gets inside @window. Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument to gdk_window_set_cursor() means that @@ -32267,31 +22599,21 @@ use this default. - a #GdkWindow + a #GdkWindow - a master, pointer #GdkDevice + a master, pointer #GdkDevice - a #GdkCursor + a #GdkCursor - - Sets the event mask for a given device (Normally a floating device, not + + Sets the event mask for a given device (Normally a floating device, not attached to any visible pointer) to @window. For example, an event mask including #GDK_BUTTON_PRESS_MASK means the window should report button press events. The event mask is the bitwise OR of values from the @@ -32304,31 +22626,21 @@ See the [input handling overview][event-masks] for details. - a #GdkWindow + a #GdkWindow - #GdkDevice to enable events for. + #GdkDevice to enable events for. - event mask for @window + event mask for @window - - Determines whether or not extra unprocessed motion events in + + Determines whether or not extra unprocessed motion events in the event queue can be discarded. If %TRUE only the most recent event will be delivered. @@ -32342,23 +22654,17 @@ By default, event compression is enabled. - a #GdkWindow + a #GdkWindow - %TRUE if motion events should be compressed + %TRUE if motion events should be compressed - The event mask for a window determines which events will be reported + The event mask for a window determines which events will be reported for that window from all master input devices. For example, an event mask including #GDK_BUTTON_PRESS_MASK means the window should report button press events. The event mask is the bitwise OR of values from the @@ -32371,27 +22677,19 @@ See the [input handling overview][event-masks] for details. - a #GdkWindow + a #GdkWindow - event mask for @window + event mask for @window - - Setting @focus_on_map to %FALSE hints the desktop environment that the -window doesn’t want to receive input focus when it is mapped. -focus_on_map should be turned off for windows that aren’t triggered + + Setting @focus_on_map to %FALSE hints the desktop environment that the +window doesn’t want to receive input focus when it is mapped. +focus_on_map should be turned off for windows that aren’t triggered interactively (such as popups from network activity). On X, it is the responsibility of the window manager to interpret @@ -32403,25 +22701,17 @@ manager extension specification should respect it. - a toplevel #GdkWindow + a toplevel #GdkWindow - %TRUE if the window should receive input focus when mapped + %TRUE if the window should receive input focus when mapped - - Specifies whether the @window should span over all monitors (in a multi-head + + Specifies whether the @window should span over all monitors (in a multi-head setup) or only the current monitor when in fullscreen mode. The @mode argument is from the #GdkFullscreenMode enumeration. @@ -32435,7 +22725,7 @@ manager to span the @window over these monitors. If the XINERAMA extension is not available or not usable, this function has no effect. -Not all window managers support this, so you can’t rely on the fullscreen +Not all window managers support this, so you can’t rely on the fullscreen window to span over the multiple monitors when #GDK_FULLSCREEN_ON_ALL_MONITORS is specified. @@ -32444,23 +22734,17 @@ is specified. - a toplevel #GdkWindow + a toplevel #GdkWindow - fullscreen mode + fullscreen mode - Sets hints about the window management functions to make available + Sets hints about the window management functions to make available via buttons on the window frame. On the X backend, this function sets the traditional Motif window @@ -32471,7 +22755,7 @@ entirely. The @functions argument is the logical OR of values from the #GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL, then the other bits indicate which functions to disable; if -it doesn’t include #GDK_FUNC_ALL, it indicates which functions to +it doesn’t include #GDK_FUNC_ALL, it indicates which functions to enable. @@ -32479,24 +22763,17 @@ enable. - a toplevel #GdkWindow + a toplevel #GdkWindow - bitmask of operations to allow on @window + bitmask of operations to allow on @window - - Sets the geometry hints for @window. Hints flagged in @geom_mask + + Sets the geometry hints for @window. Hints flagged in @geom_mask are set, hints not flagged in @geom_mask are unset. To unset all hints, use a @geom_mask of 0 and a @geometry of %NULL. @@ -32513,7 +22790,7 @@ of type %GDK_WINDOW_TEMP or windows where override redirect has been turned on via gdk_window_set_override_redirect() since these windows are not resizable by the user. -Since you can’t count on the windowing system doing the +Since you can’t count on the windowing system doing the constraints for programmatic resizes, you should generally call gdk_window_constrain_size() yourself to determine appropriate sizes. @@ -32523,29 +22800,21 @@ appropriate sizes. - a toplevel #GdkWindow + a toplevel #GdkWindow - geometry hints + geometry hints - bitmask indicating fields of @geometry to pay attention to + bitmask indicating fields of @geometry to pay attention to - Sets the group leader window for @window. By default, + Sets the group leader window for @window. By default, GDK sets the group leader for all toplevel windows to a global window implicitly created by GDK. With this function you can override this default. @@ -32561,26 +22830,17 @@ if your application pretends to be multiple applications. - a toplevel #GdkWindow + a toplevel #GdkWindow - - group leader window, or %NULL to restore the default group leader window + + group leader window, or %NULL to restore the default group leader window - Sets a list of icons for the window. One of these will be used + Sets a list of icons for the window. One of these will be used to represent the window when it has been iconified. The icon is usually shown in an icon box or some sort of task bar. Which icon size is shown depends on the window manager. The window manager @@ -32595,15 +22855,11 @@ Note that some platforms don't support window icons. - The #GdkWindow toplevel window to set the icon of. + The #GdkWindow toplevel window to set the icon of. - + A list of pixbufs, of different sizes. @@ -32612,9 +22868,7 @@ Note that some platforms don't support window icons. - Windows may have a name used while minimized, distinct from the + Windows may have a name used while minimized, distinct from the name they display in their titlebar. Most of the time this is a bad idea from a user interface standpoint. But you can set such a name with this function, if you like. @@ -32632,36 +22886,24 @@ Note that some platforms don't support window icons. - a toplevel #GdkWindow + a toplevel #GdkWindow - - name of window while iconified (minimized) + + name of window while iconified (minimized) - - Registers an invalidate handler for a specific window. This + + Registers an invalidate handler for a specific window. This will get called whenever a region in the window or its children is invalidated. This can be used to record the invalidated region, which is useful if you are keeping an offscreen copy of some region and want to keep it up to date. You can also modify the -invalidated region in case you’re doing some effect where +invalidated region in case you’re doing some effect where e.g. a child widget appears in multiple places. @@ -32669,32 +22911,23 @@ e.g. a child widget appears in multiple places. - a #GdkWindow + a #GdkWindow - a #GdkWindowInvalidateHandlerFunc callback function - + a #GdkWindowInvalidateHandlerFunc callback function + - - Set if @window must be kept above other windows. If the + + Set if @window must be kept above other windows. If the window was already above, then this function does nothing. On X11, asks the window manager to keep @window above, if the window manager supports this operation. Not all window managers support -this, and some deliberately ignore it or don’t have a concept of -“keep above”; so you can’t rely on the window being kept above. +this, and some deliberately ignore it or don’t have a concept of +“keep above”; so you can’t rely on the window being kept above. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. @@ -32703,31 +22936,23 @@ and GDK makes a best effort to get it to happen. - a toplevel #GdkWindow + a toplevel #GdkWindow - whether to keep @window above other windows + whether to keep @window above other windows - - Set if @window must be kept below other windows. If the + + Set if @window must be kept below other windows. If the window was already below, then this function does nothing. On X11, asks the window manager to keep @window below, if the window manager supports this operation. Not all window managers support -this, and some deliberately ignore it or don’t have a concept of -“keep below”; so you can’t rely on the window being kept below. +this, and some deliberately ignore it or don’t have a concept of +“keep below”; so you can’t rely on the window being kept below. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. @@ -32736,23 +22961,17 @@ and GDK makes a best effort to get it to happen. - a toplevel #GdkWindow + a toplevel #GdkWindow - whether to keep @window below other windows + whether to keep @window below other windows - The application can use this hint to tell the window manager + The application can use this hint to tell the window manager that a certain window has modal behaviour. The window manager can use this information to handle modal windows in a special way. @@ -32765,25 +22984,17 @@ previously called gdk_window_set_transient_for() - A toplevel #GdkWindow + A toplevel #GdkWindow - %TRUE if the window is modal, %FALSE otherwise. + %TRUE if the window is modal, %FALSE otherwise. - - Set @window to render as partially transparent, + + Set @window to render as partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) @@ -32808,25 +23019,17 @@ Support for non-toplevel windows was added in 3.8. - a top-level or non-native #GdkWindow + a top-level or non-native #GdkWindow - opacity + opacity - - For optimisation purposes, compositing window managers may + + For optimisation purposes, compositing window managers may like to not draw obscured regions of windows, or turn off blending during for these regions. With RGB windows with no transparency, this is just the shape of the window, but with ARGB32 windows, the @@ -32845,30 +23048,20 @@ property in your #GtkWidget::style-updated handler. - a top-level or non-native #GdkWindow + a top-level or non-native #GdkWindow - - a region, or %NULL + + a region, or %NULL - - An override redirect window is not under the control of the window manager. -This means it won’t have a titlebar, won’t be minimizable, etc. - it will + + An override redirect window is not under the control of the window manager. +This means it won’t have a titlebar, won’t be minimizable, etc. - it will be entirely under the control of the application. The window manager -can’t see the override redirect window at all. +can’t see the override redirect window at all. Override redirect should only be used for short-lived temporary windows, such as popup menus. #GtkMenu uses an override redirect @@ -32879,25 +23072,17 @@ window in its implementation, for example. - a toplevel #GdkWindow + a toplevel #GdkWindow - %TRUE if window should be override redirect + %TRUE if window should be override redirect - - Sets whether input to the window is passed through to the window + + Sets whether input to the window is passed through to the window below. The default value of this is %FALSE, which means that pointer @@ -32921,32 +23106,26 @@ enter/leave events on its way to the destination window. - a #GdkWindow + a #GdkWindow - a boolean + a boolean - When using GTK+, typically you should use gtk_window_set_role() instead + When using GTK+, typically you should use gtk_window_set_role() instead of this low-level function. -The window manager and session manager use a window’s role to +The window manager and session manager use a window’s role to distinguish it from other kinds of window in the same application. When an application is restarted after being saved in a previous session, all windows with the same title and role are treated as interchangeable. So if you have two windows with the same title that should be distinguished for session management purposes, you -should set the role on those windows. It doesn’t matter what string +should set the role on those windows. It doesn’t matter what string you use for the role, as long as you have a different role for each non-interchangeable kind of window. @@ -32955,29 +23134,21 @@ non-interchangeable kind of window. - a toplevel #GdkWindow + a toplevel #GdkWindow - a string indicating its role + a string indicating its role - - Newer GTK+ windows using client-side decorations use extra geometry + + Newer GTK+ windows using client-side decorations use extra geometry around their frames for effects like shadows and invisible borders. Window managers that want to maximize windows or snap to edges need to know where the extents of the actual frame lie, so that users -don’t feel like windows are snapping against random invisible edges. +don’t feel like windows are snapping against random invisible edges. Note that this property is automatically updated by GTK+, so this function should only be used by applications which do not use GTK+ @@ -32988,46 +23159,32 @@ to create toplevel windows. - a #GdkWindow + a #GdkWindow - The left extent + The left extent - The right extent + The right extent - The top extent + The top extent - The bottom extent + The bottom extent - - Toggles whether a window should appear in a pager (workspace + + Toggles whether a window should appear in a pager (workspace switcher, or other desktop utility program that displays a small thumbnail representation of the windows on the desktop). If a -window’s semantic type as specified with gdk_window_set_type_hint() +window’s semantic type as specified with gdk_window_set_type_hint() already fully describes the window, this function should not be called in addition, instead you should allow the window to be treated according to standard policy for @@ -33038,26 +23195,18 @@ its semantic type. - a toplevel #GdkWindow + a toplevel #GdkWindow - %TRUE to skip the pager + %TRUE to skip the pager - - Toggles whether a window should appear in a task list or window -list. If a window’s semantic type as specified with + + Toggles whether a window should appear in a task list or window +list. If a window’s semantic type as specified with gdk_window_set_type_hint() already fully describes the window, this function should not be called in addition, instead you should allow the window to be treated according to @@ -33068,25 +23217,17 @@ standard policy for its semantic type. - a toplevel #GdkWindow + a toplevel #GdkWindow - %TRUE to skip the taskbar + %TRUE to skip the taskbar - - Sets the event mask for any floating device (i.e. not attached to any + + Sets the event mask for any floating device (i.e. not attached to any visible pointer) that has the source defined as @source. This event mask will be applied both to currently existing, newly added devices after this call, and devices being attached/detached. @@ -33096,31 +23237,21 @@ after this call, and devices being attached/detached. - a #GdkWindow + a #GdkWindow - a #GdkInputSource to define the source class. + a #GdkInputSource to define the source class. - event mask for @window + event mask for @window - - When using GTK+, typically you should use gtk_window_set_startup_id() + + When using GTK+, typically you should use gtk_window_set_startup_id() instead of this low-level function. @@ -33128,59 +23259,40 @@ instead of this low-level function. - a toplevel #GdkWindow + a toplevel #GdkWindow - a string with startup-notification identifier + a string with startup-notification identifier - - Used to set the bit gravity of the given window to static, and flag + + Used to set the bit gravity of the given window to static, and flag it so all children get static subwindow gravity. This is used if you are implementing scary features that involve deep knowledge of the -windowing system. Don’t worry about it. +windowing system. Don’t worry about it. static gravities haven't worked on anything but X11 for a long time. - %FALSE + %FALSE - a #GdkWindow + a #GdkWindow - %TRUE to turn on static gravity + %TRUE to turn on static gravity - - This function will enable multidevice features in @window. + + This function will enable multidevice features in @window. Multidevice aware windows will need to handle properly multiple, per device enter/leave events, device grabs and grab ownerships. @@ -33190,24 +23302,18 @@ per device enter/leave events, device grabs and grab ownerships. - a #GdkWindow. + a #GdkWindow. - %TRUE to enable multidevice support in @window. + %TRUE to enable multidevice support in @window. - Sets the title of a toplevel window, to be displayed in the titlebar. -If you haven’t explicitly set the icon name for the window + Sets the title of a toplevel window, to be displayed in the titlebar. +If you haven’t explicitly set the icon name for the window (using gdk_window_set_icon_name()), the icon name will be set to @title as well. @title must be in UTF-8 encoding (as with all user-readable strings in GDK/GTK+). @title may not be %NULL. @@ -33217,29 +23323,22 @@ user-readable strings in GDK/GTK+). @title may not be %NULL. - a toplevel #GdkWindow + a toplevel #GdkWindow - title of @window + title of @window - - Indicates to the window manager that @window is a transient dialog + + Indicates to the window manager that @window is a transient dialog associated with the application window @parent. This allows the window manager to do things like center @window on @parent and keep @window above @parent. -See gtk_window_set_transient_for() if you’re using #GtkWindow or +See gtk_window_set_transient_for() if you’re using #GtkWindow or #GtkDialog. @@ -33247,23 +23346,17 @@ See gtk_window_set_transient_for() if you’re using #GtkWindow or - a toplevel #GdkWindow + a toplevel #GdkWindow - another toplevel #GdkWindow + another toplevel #GdkWindow - The application can use this call to provide a hint to the window + The application can use this call to provide a hint to the window manager about the functionality of a window. The window manager can use this information when determining the decoration and behaviour of the window. @@ -33275,25 +23368,17 @@ The hint must be set before the window is mapped. - A toplevel #GdkWindow + A toplevel #GdkWindow - A hint of the function this window will have + A hint of the function this window will have - - Toggles whether a window needs the user's + + Toggles whether a window needs the user's urgent attention. @@ -33301,23 +23386,17 @@ urgent attention. - a toplevel #GdkWindow + a toplevel #GdkWindow - %TRUE if the window is urgent + %TRUE if the window is urgent - For most purposes this function is deprecated in favor of + For most purposes this function is deprecated in favor of g_object_set_data(). However, for historical reasons GTK+ stores the #GtkWidget that owns a #GdkWindow as user data on the #GdkWindow. So, custom widget implementations should use @@ -33330,27 +23409,17 @@ user data is a #GtkWidget, and forward the event to that widget. - a #GdkWindow + a #GdkWindow - - user data + + user data - - Makes pixels in @window outside @shape_region be transparent, + + Makes pixels in @window outside @shape_region be transparent, so that the window may be nonrectangular. If @shape_region is %NULL, the shape will be unset, so the whole @@ -33370,146 +23439,108 @@ This function works on both toplevel and child windows. - a #GdkWindow + a #GdkWindow - - region of window to be non-transparent + + region of window to be non-transparent - X position of @shape_region in @window coordinates + X position of @shape_region in @window coordinates - Y position of @shape_region in @window coordinates + Y position of @shape_region in @window coordinates - Like gdk_window_show_unraised(), but also raises the window to the + Like gdk_window_show_unraised(), but also raises the window to the top of the window stack (moves the window to the front of the Z-order). -This function maps a window so it’s visible onscreen. Its opposite +This function maps a window so it’s visible onscreen. Its opposite is gdk_window_hide(). When implementing a #GtkWidget, you should call this function on the widget's -#GdkWindow as part of the “map” method. +#GdkWindow as part of the “map” method. - a #GdkWindow + a #GdkWindow - Shows a #GdkWindow onscreen, but does not modify its stacking + Shows a #GdkWindow onscreen, but does not modify its stacking order. In contrast, gdk_window_show() will raise the window to the top of the window stack. On the X11 platform, in Xlib terms, this function calls XMapWindow() (it also updates some internal GDK state, which means -that you can’t really use XMapWindow() directly on a GDK window). +that you can’t really use XMapWindow() directly on a GDK window). - a #GdkWindow + a #GdkWindow - - Asks the windowing system to show the window menu. The window menu + + Asks the windowing system to show the window menu. The window menu is the menu shown when right-clicking the titlebar on traditional windows managed by the window manager. This is useful for windows using client-side decorations, activating it with a right-click on the window decorations. - %TRUE if the window menu was shown and %FALSE otherwise. + %TRUE if the window menu was shown and %FALSE otherwise. - a #GdkWindow + a #GdkWindow - a #GdkEvent to show the menu for + a #GdkEvent to show the menu for - “Pins” a window such that it’s on all workspaces and does not scroll + “Pins” a window such that it’s on all workspaces and does not scroll with viewports, for window managers that have scrollable viewports. (When using #GtkWindow, gtk_window_stick() may be more useful.) On the X11 platform, this function depends on window manager support, so may have no effect with many window managers. However, GDK will do the best it can to convince the window manager to stick -the window. For window managers that don’t support this operation, -there’s nothing you can do to force it to happen. +the window. For window managers that don’t support this operation, +there’s nothing you can do to force it to happen. - a toplevel #GdkWindow + a toplevel #GdkWindow - - Thaws a window frozen with + + Thaws a window frozen with gdk_window_freeze_toplevel_updates_libgtk_only(). This function is not part of the GDK public API and is only @@ -33521,42 +23552,32 @@ for use by GTK+. - a #GdkWindow + a #GdkWindow - Thaws a window frozen with gdk_window_freeze_updates(). + Thaws a window frozen with gdk_window_freeze_updates(). - a #GdkWindow + a #GdkWindow - - Moves the window out of fullscreen mode. If the window was not + + Moves the window out of fullscreen mode. If the window was not fullscreen, does nothing. On X11, asks the window manager to move @window out of the fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or -don’t have a concept of “fullscreen”; so you can’t rely on the +don’t have a concept of “fullscreen”; so you can’t rely on the unfullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. @@ -33566,23 +23587,19 @@ it to happen. - a toplevel #GdkWindow + a toplevel #GdkWindow - Unmaximizes the window. If the window wasn’t maximized, then this + Unmaximizes the window. If the window wasn’t maximized, then this function does nothing. On X11, asks the window manager to unmaximize @window, if the window manager supports this operation. Not all window managers -support this, and some deliberately ignore it or don’t have a -concept of “maximized”; so you can’t rely on the unmaximization +support this, and some deliberately ignore it or don’t have a +concept of “maximized”; so you can’t rely on the unmaximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. @@ -33593,17 +23610,13 @@ On Windows, reliably unmaximizes the window. - a toplevel #GdkWindow + a toplevel #GdkWindow - Reverse operation for gdk_window_stick(); see gdk_window_stick(), + Reverse operation for gdk_window_stick(); see gdk_window_stick(), and gtk_window_unstick(). @@ -33611,17 +23624,13 @@ and gtk_window_unstick(). - a toplevel #GdkWindow + a toplevel #GdkWindow - Withdraws a window (unmaps it and asks the window manager to forget about it). + Withdraws a window (unmaps it and asks the window manager to forget about it). This function is not really useful as gdk_window_hide() automatically withdraws toplevel windows before hiding them. @@ -33630,27 +23639,18 @@ withdraws toplevel windows before hiding them. - a toplevel #GdkWindow + a toplevel #GdkWindow - - The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and + + The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and gdk_window_get_cursor() for details. - The ::create-surface signal is emitted when an offscreen window + The ::create-surface signal is emitted when an offscreen window needs its surface (re)created, which happens either when the window is first drawn to, or when the window is being resized. The first signal handler that returns a non-%NULL @@ -33661,30 +23661,22 @@ Note that it is not possible to access the window's previous surface from within any callback of this signal. Calling gdk_offscreen_window_get_surface() will lead to a crash. - the newly created #cairo_surface_t for the offscreen window + the newly created #cairo_surface_t for the offscreen window - the width of the offscreen surface to create + the width of the offscreen surface to create - the height of the offscreen surface to create + the height of the offscreen surface to create - The ::from-embedder signal is emitted to translate coordinates + The ::from-embedder signal is emitted to translate coordinates in the embedder of an offscreen window to the offscreen window. See also #GdkWindow::to-embedder. @@ -33693,46 +23685,27 @@ See also #GdkWindow::to-embedder. - x coordinate in the embedder window + x coordinate in the embedder window - y coordinate in the embedder window + y coordinate in the embedder window - - return location for the x + + return location for the x coordinate in the offscreen window - - return location for the y + + return location for the y coordinate in the offscreen window - - Emitted when the position of @window is finalized after being moved to a + + Emitted when the position of @window is finalized after being moved to a destination rectangle. @window might be flipped over the destination rectangle in order to keep @@ -33747,71 +23720,47 @@ keeping @window on-screen. - - the position of @window after any possible + + the position of @window after any possible flipping or %NULL if the backend can't obtain it - - the final position of @window or %NULL if the + + the final position of @window or %NULL if the backend can't obtain it - %TRUE if the anchors were flipped horizontally + %TRUE if the anchors were flipped horizontally - %TRUE if the anchors were flipped vertically + %TRUE if the anchors were flipped vertically - The ::pick-embedded-child signal is emitted to find an embedded + The ::pick-embedded-child signal is emitted to find an embedded child at the given position. - the #GdkWindow of the + the #GdkWindow of the embedded child at @x, @y, or %NULL - x coordinate in the window + x coordinate in the window - y coordinate in the window + y coordinate in the window - The ::to-embedder signal is emitted to translate coordinates + The ::to-embedder signal is emitted to translate coordinates in an offscreen window to its embedder. See also #GdkWindow::from-embedder. @@ -33820,34 +23769,20 @@ See also #GdkWindow::from-embedder. - x coordinate in the offscreen window + x coordinate in the offscreen window - y coordinate in the offscreen window + y coordinate in the offscreen window - - return location for the x + + return location for the x coordinate in the embedder window - - return location for the y + + return location for the y coordinate in the embedder window @@ -33855,202 +23790,119 @@ See also #GdkWindow::from-embedder. - Attributes to use for a newly-created window. + Attributes to use for a newly-created window. - title of the window (for toplevel windows) + title of the window (for toplevel windows) - event mask (see gdk_window_set_events()) + event mask (see gdk_window_set_events()) - X coordinate relative to parent window (see gdk_window_move()) + X coordinate relative to parent window (see gdk_window_move()) - Y coordinate relative to parent window (see gdk_window_move()) + Y coordinate relative to parent window (see gdk_window_move()) - width of window + width of window - height of window + height of window - #GDK_INPUT_OUTPUT (normal window) or #GDK_INPUT_ONLY (invisible + #GDK_INPUT_OUTPUT (normal window) or #GDK_INPUT_ONLY (invisible window that receives events) - #GdkVisual for window + #GdkVisual for window - type of window + type of window - cursor for the window (see gdk_window_set_cursor()) + cursor for the window (see gdk_window_set_cursor()) - don’t use (see gtk_window_set_wmclass()) + don’t use (see gtk_window_set_wmclass()) - don’t use (see gtk_window_set_wmclass()) + don’t use (see gtk_window_set_wmclass()) - %TRUE to bypass the window manager + %TRUE to bypass the window manager - a hint of the function of the window + a hint of the function of the window - - Used to indicate which fields in the #GdkWindowAttr struct should be honored. -For example, if you filled in the “cursor” and “x” fields of #GdkWindowAttr, -pass “@GDK_WA_X | @GDK_WA_CURSOR” to gdk_window_new(). Fields in + + Used to indicate which fields in the #GdkWindowAttr struct should be honored. +For example, if you filled in the “cursor” and “x” fields of #GdkWindowAttr, +pass “@GDK_WA_X | @GDK_WA_CURSOR” to gdk_window_new(). Fields in #GdkWindowAttr not covered by a bit in this enum are required; for example, the @width/@height, @wclass, and @window_type fields are required, they have no corresponding flag in #GdkWindowAttributesType. - - Honor the title field + + Honor the title field - Honor the X coordinate field + Honor the X coordinate field - Honor the Y coordinate field + Honor the Y coordinate field - - Honor the cursor field + + Honor the cursor field - - Honor the visual field + + Honor the visual field - - Honor the wmclass_class and wmclass_name fields + + Honor the wmclass_class and wmclass_name fields - - Honor the override_redirect field + + Honor the override_redirect field - - Honor the type_hint field + + Honor the type_hint field - A function of this type is passed to gdk_window_invalidate_maybe_recurse(). + A function of this type is passed to gdk_window_invalidate_maybe_recurse(). It gets called for each child of the window to determine whether to recursively invalidate it or now. - %TRUE to invalidate @window recursively + %TRUE to invalidate @window recursively - a #GdkWindow + a #GdkWindow - - user data + + user data - + @@ -34208,85 +24060,35 @@ recursively invalidate it or now. - - Determines a window edge or corner. - - the top left corner. + + Determines a window edge or corner. + + the top left corner. - - the top edge. + + the top edge. - - the top right corner. + + the top right corner. - - the left edge. + + the left edge. - - the right edge. + + the right edge. - - the lower left corner. + + the lower left corner. - - the lower edge. + + the lower edge. - - the lower right corner. + + the lower right corner. - - Used to indicate which fields of a #GdkGeometry struct should be paid + + Used to indicate which fields of a #GdkGeometry struct should be paid attention to. Also, the presence/absence of @GDK_HINT_POS, @GDK_HINT_USER_POS, and @GDK_HINT_USER_SIZE is significant, though they don't directly refer to #GdkGeometry fields. @GDK_HINT_USER_POS will be set @@ -34295,83 +24097,37 @@ automatically by #GtkWindow if you call gtk_window_move(). specified a size/position using a --geometry command-line argument; gtk_window_parse_geometry() automatically sets these flags. - indicates that the program has positioned the window + indicates that the program has positioned the window - - min size fields are set + + min size fields are set - - max size fields are set + + max size fields are set - - base size fields are set + + base size fields are set - - aspect ratio fields are set + + aspect ratio fields are set - - resize increment fields are set + + resize increment fields are set - - window gravity field is set + + window gravity field is set - - indicates that the window’s position was explicitly set + + indicates that the window’s position was explicitly set by the user - - indicates that the window’s size was explicitly set by + + indicates that the window’s size was explicitly set by the user - - Whenever some area of the window is invalidated (directly in the + + Whenever some area of the window is invalidated (directly in the window or in a child window) this gets called with @region in the coordinate space of @window. You can use @region to just keep track of the dirty region, or you can actually change @@ -34383,15 +24139,11 @@ a child in multiple places. - a #GdkWindow + a #GdkWindow - a #cairo_region_t + a #cairo_region_t @@ -34399,387 +24151,162 @@ a child in multiple places. - - Specifies the state of a toplevel window. - - the window is not shown. + + Specifies the state of a toplevel window. + + the window is not shown. - - the window is minimized. + + the window is minimized. - - the window is maximized. + + the window is maximized. - - the window is sticky. + + the window is sticky. - - the window is maximized without + + the window is maximized without decorations. - - the window is kept above other windows. + + the window is kept above other windows. - - the window is kept below other windows. + + the window is kept below other windows. - - the window is presented as focused (with active decorations). + + the window is presented as focused (with active decorations). - - the window is in a tiled state, Since 3.10. Since 3.22.23, this + + the window is in a tiled state, Since 3.10. Since 3.22.23, this is deprecated in favor of per-edge information. - - whether the top edge is tiled, Since 3.22.23 + + whether the top edge is tiled, Since 3.22.23 - - whether the top edge is resizable, Since 3.22.23 + + whether the top edge is resizable, Since 3.22.23 - - whether the right edge is tiled, Since 3.22.23 + + whether the right edge is tiled, Since 3.22.23 - - whether the right edge is resizable, Since 3.22.23 + + whether the right edge is resizable, Since 3.22.23 - - whether the bottom edge is tiled, Since 3.22.23 + + whether the bottom edge is tiled, Since 3.22.23 - - whether the bottom edge is resizable, Since 3.22.23 + + whether the bottom edge is resizable, Since 3.22.23 - - whether the left edge is tiled, Since 3.22.23 + + whether the left edge is tiled, Since 3.22.23 - - whether the left edge is resizable, Since 3.22.23 + + whether the left edge is resizable, Since 3.22.23 - - Describes the kind of window. - - root window; this window has no parent, covers the entire + + Describes the kind of window. + + root window; this window has no parent, covers the entire screen, and is created by the window system - - toplevel window (used to implement #GtkWindow) + + toplevel window (used to implement #GtkWindow) - - child window (used to implement e.g. #GtkEntry) + + child window (used to implement e.g. #GtkEntry) - - override redirect temporary window (used to implement + + override redirect temporary window (used to implement #GtkMenu) - - foreign window (see gdk_window_foreign_new()) + + foreign window (see gdk_window_foreign_new()) - - offscreen window (see + + offscreen window (see [Offscreen Windows][OFFSCREEN-WINDOWS]). Since 2.18 - - subsurface-based window; This window is visually + + subsurface-based window; This window is visually tied to a toplevel, and is moved/stacked with it. Currently this window type is only implemented in Wayland. Since 3.14 - - These are hints for the window manager that indicate what type of function + + These are hints for the window manager that indicate what type of function the window has. The window manager can use this when determining decoration and behaviour of the window. The hint must be set before mapping the window. See the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification for more details about window types. - - Normal toplevel window. + + Normal toplevel window. - - Dialog window. + + Dialog window. - - Window used to implement a menu; GTK+ uses + + Window used to implement a menu; GTK+ uses this hint only for torn-off menus, see #GtkTearoffMenuItem. - - Window used to implement toolbars. + + Window used to implement toolbars. - - Window used to display a splash + + Window used to display a splash screen during application startup. - - Utility windows which are not detached + + Utility windows which are not detached toolbars or dialogs. - - Used for creating dock or panel windows. + + Used for creating dock or panel windows. - - Used for creating the desktop background + + Used for creating the desktop background window. - - A menu that belongs to a menubar. + + A menu that belongs to a menubar. - - A menu that does not belong to a menubar, + + A menu that does not belong to a menubar, e.g. a context menu. - - A tooltip. + + A tooltip. - - A notification - typically a “bubble” + + A notification - typically a “bubble” that belongs to a status icon. - - A popup from a combo box. + + A popup from a combo box. - - A window that is used to implement a DND cursor. + + A window that is used to implement a DND cursor. - - @GDK_INPUT_OUTPUT windows are the standard kind of window you might expect. + + @GDK_INPUT_OUTPUT windows are the standard kind of window you might expect. Such windows receive events and are also displayed on screen. @GDK_INPUT_ONLY windows are invisible; they are usually placed above other -windows in order to trap or filter the events. You can’t draw on +windows in order to trap or filter the events. You can’t draw on @GDK_INPUT_ONLY windows. - - window for graphics and events + + window for graphics and events - - window for events only + + window for events only - - Appends gdk option entries to the passed in option group. This is + + Appends gdk option entries to the passed in option group. This is not public API and must not be used by applications. This symbol was never meant to be used outside of GTK+ @@ -34789,51 +24316,34 @@ not public API and must not be used by applications. - An option group. + An option group. - - Finds or creates an atom corresponding to a given string. + + Finds or creates an atom corresponding to a given string. - the atom corresponding to @atom_name. + the atom corresponding to @atom_name. - a string. + a string. - if %TRUE, GDK is allowed to not create a new atom, but - just return %GDK_NONE if the requested atom doesn’t already + if %TRUE, GDK is allowed to not create a new atom, but + just return %GDK_NONE if the requested atom doesn’t already exists. Currently, the flag is ignored, since checking the existance of an atom is as expensive as creating it. - - Finds or creates an atom corresponding to a given string. + + Finds or creates an atom corresponding to a given string. Note that this function is identical to gdk_atom_intern() except that if a new #GdkAtom is created the string itself is used rather @@ -34845,37 +24355,25 @@ ever unload the module again (e.g. do not use this function in GTK+ theme engines). - the atom corresponding to @atom_name + the atom corresponding to @atom_name - a static string + a static string - Emits a short beep on the default display. + Emits a short beep on the default display. - - Creates a Cairo context for drawing to @window. + + Creates a Cairo context for drawing to @window. Note that calling cairo_reset_clip() on the resulting #cairo_t will produce undefined results, so avoid it at all costs. @@ -34891,27 +24389,19 @@ instead. GTK will automatically do this for you when drawing a widget. gdk_drawing_context_get_cairo_context() instead - A newly created Cairo context. Free with + A newly created Cairo context. Free with cairo_destroy() when you are done drawing. - a #GdkWindow + a #GdkWindow - - This is the main way to draw GL content in GTK+. It takes a render buffer ID + + This is the main way to draw GL content in GTK+. It takes a render buffer ID (@source_type == #GL_RENDERBUFFER) or a texture id (@source_type == #GL_TEXTURE) and draws it onto @cr with an OVER operation, respecting the current clip. The top left corner of the rectangle specified by @x, @y, @width and @height @@ -34933,123 +24423,81 @@ Calling this may change the current GL context. - a cairo context + a cairo context - The window we're rendering for (not necessarily into) + The window we're rendering for (not necessarily into) - The GL ID of the source buffer + The GL ID of the source buffer - The type of the @source + The type of the @source - The scale-factor that the @source buffer is allocated for + The scale-factor that the @source buffer is allocated for - The source x position in @source to start copying from in GL coordinates + The source x position in @source to start copying from in GL coordinates - The source y position in @source to start copying from in GL coordinates + The source y position in @source to start copying from in GL coordinates - The width of the region to draw + The width of the region to draw - The height of the region to draw + The height of the region to draw - - This is a convenience function around cairo_clip_extents(). + + This is a convenience function around cairo_clip_extents(). It rounds the clip extents to integer coordinates and returns a boolean indicating if a clip area exists. - %TRUE if a clip rectangle exists, %FALSE if all of @cr is + %TRUE if a clip rectangle exists, %FALSE if all of @cr is clipped and all drawing can be skipped - a cairo context + a cairo context - - return location for the clip, or %NULL + + return location for the clip, or %NULL - - Retrieves the #GdkDrawingContext that created the Cairo + + Retrieves the #GdkDrawingContext that created the Cairo context @cr. - a #GdkDrawingContext, if any is set + a #GdkDrawingContext, if any is set - a Cairo context + a Cairo context - [Cairo](http://cairographics.org) is a graphics + [Cairo](http://cairographics.org) is a graphics library that supports vector graphics and image compositing that can be used with GDK. GTK+ does all of its drawing using cairo. @@ -35059,89 +24507,60 @@ functions allow use #GdkRectangles with cairo and to use #GdkColors, #GdkRGBAs, #GdkPixbufs and #GdkWindows as sources for drawing operations. - - Adds the given rectangle to the current path of @cr. + + Adds the given rectangle to the current path of @cr. - a cairo context + a cairo context - a #GdkRectangle + a #GdkRectangle - - Adds the given region to the current path of @cr. + + Adds the given region to the current path of @cr. - a cairo context + a cairo context - a #cairo_region_t + a #cairo_region_t - - Creates region that describes covers the area where the given + + Creates region that describes covers the area where the given @surface is more than 50% opaque. This function takes into account device offsets that might be set with cairo_surface_set_device_offset(). - A #cairo_region_t; must be freed with cairo_region_destroy() + A #cairo_region_t; must be freed with cairo_region_destroy() - a cairo surface + a cairo surface - - Sets the specified #GdkColor as the source color of @cr. + + Sets the specified #GdkColor as the source color of @cr. Use gdk_cairo_set_source_rgba() instead @@ -35149,25 +24568,17 @@ set with cairo_surface_set_device_offset(). - a cairo context + a cairo context - a #GdkColor + a #GdkColor - - Sets the given pixbuf as the source pattern for @cr. + + Sets the given pixbuf as the source pattern for @cr. The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y. @@ -35177,62 +24588,42 @@ so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y. - a cairo context + a cairo context - a #GdkPixbuf + a #GdkPixbuf - X coordinate of location to place upper left corner of @pixbuf + X coordinate of location to place upper left corner of @pixbuf - Y coordinate of location to place upper left corner of @pixbuf + Y coordinate of location to place upper left corner of @pixbuf - - Sets the specified #GdkRGBA as the source color of @cr. + + Sets the specified #GdkRGBA as the source color of @cr. - a cairo context + a cairo context - a #GdkRGBA + a #GdkRGBA - - Sets the given window as the source pattern for @cr. + + Sets the given window as the source pattern for @cr. The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned so that the origin of @window is @x, @y. The window contains all its @@ -35246,125 +24637,83 @@ visible part of @window, so use this function with care. - a cairo context + a cairo context - a #GdkWindow + a #GdkWindow - X coordinate of location to place upper left corner of @window + X coordinate of location to place upper left corner of @window - Y coordinate of location to place upper left corner of @window + Y coordinate of location to place upper left corner of @window - - Creates an image surface with the same contents as + + Creates an image surface with the same contents as the pixbuf. - a new cairo surface, must be freed with cairo_surface_destroy() + a new cairo surface, must be freed with cairo_surface_destroy() - a #GdkPixbuf + a #GdkPixbuf - the scale of the new surface, or 0 to use same as @window + the scale of the new surface, or 0 to use same as @window - - The window this will be drawn to, or %NULL + + The window this will be drawn to, or %NULL - - Parses a textual specification of a color and fill in the + + Parses a textual specification of a color and fill in the @red, @green, and @blue fields of a #GdkColor. The string can either one of a large set of standard names (taken from the X11 `rgb.txt` file), or it can be a hexadecimal -value in the form “\#rgb” “\#rrggbb”, “\#rrrgggbbb” or -“\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits of +value in the form “\#rgb” “\#rrggbb”, “\#rrrgggbbb” or +“\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits of the red, green, and blue components of the color, respectively. -(White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff” -and “\#ffffffffffff”). +(White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff” +and “\#ffffffffffff”). Use #GdkRGBA - %TRUE if the parsing succeeded + %TRUE if the parsing succeeded - the string specifying the color + the string specifying the color - - the #GdkColor to fill in + + the #GdkColor to fill in - A #GdkColor represents a color. + A #GdkColor represents a color. When working with cairo, it is often more convenient to use a #GdkRGBA instead, and #GdkColor has been deprecated in favor of #GdkRGBA. - These functions are used to create and destroy cursors. + These functions are used to create and destroy cursors. There is a number of standard cursors, but it is also possible to construct new cursors from pixbufs. There may be limitations as to what kinds of cursors can be @@ -35379,28 +24728,22 @@ bound to a window for users to see them. This is done with gdk_window_set_cursor() or by setting the cursor member of the #GdkWindowAttr passed to gdk_window_new(). - - Disables multidevice support in GDK. This call must happen prior + + Disables multidevice support in GDK. This call must happen prior to gdk_display_open(), gtk_init(), gtk_init_with_args() or gtk_init_check() in order to take effect. -Most common GTK+ applications won’t ever need to call this. Only +Most common GTK+ applications won’t ever need to call this. Only applications that do mixed GDK/Xlib calls could want to disable multidevice support if such Xlib code deals with input devices in -any way and doesn’t observe the presence of XInput 2. +any way and doesn’t observe the presence of XInput 2. - These functions provide a low level interface for drag and drop. + These functions provide a low level interface for drag and drop. The X backend of GDK supports both the Xdnd and Motif drag and drop protocols transparently, the Win32 backend supports the WM_DROPFILES protocol. @@ -35411,9 +24754,7 @@ See the [Drag and Drop][gtk3-Drag-and-Drop] section of the GTK+ documentation for more information. - Aborts a drag without dropping. + Aborts a drag without dropping. This function is called by the drag source. @@ -35425,23 +24766,17 @@ operations. See gdk_drag_context_manage_dnd() for more information. - a #GdkDragContext + a #GdkDragContext - the timestamp for this operation + the timestamp for this operation - Starts a drag and creates a new drag context for it. + Starts a drag and creates a new drag context for it. This function assumes that the drag is controlled by the client pointer device, use gdk_drag_begin_for_device() to begin a drag with a different device. @@ -35449,22 +24784,16 @@ begin a drag with a different device. This function is called by the drag source. - a newly created #GdkDragContext + a newly created #GdkDragContext - the source window for this drag. + the source window for this drag. - the offered targets, + the offered targets, as list of #GdkAtoms @@ -35472,37 +24801,26 @@ This function is called by the drag source. - - Starts a drag and creates a new drag context for it. + + Starts a drag and creates a new drag context for it. This function is called by the drag source. - a newly created #GdkDragContext + a newly created #GdkDragContext - the source window for this drag + the source window for this drag - the device that controls this drag + the device that controls this drag - the offered targets, + the offered targets, as list of #GdkAtoms @@ -35510,61 +24828,43 @@ This function is called by the drag source. - - Starts a drag and creates a new drag context for it. + + Starts a drag and creates a new drag context for it. This function is called by the drag source. - a newly created #GdkDragContext + a newly created #GdkDragContext - the source window for this drag + the source window for this drag - the device that controls this drag + the device that controls this drag - the offered targets, + the offered targets, as list of #GdkAtoms - the x coordinate where the drag nominally started + the x coordinate where the drag nominally started - the y coordinate where the drag nominally started + the y coordinate where the drag nominally started - Drops on the current destination. + Drops on the current destination. This function is called by the drag source. @@ -35576,25 +24876,17 @@ operations. See gdk_drag_context_manage_dnd() for more information. - a #GdkDragContext + a #GdkDragContext - the timestamp for this operation + the timestamp for this operation - - Inform GDK if the drop ended successfully. Passing %FALSE + + Inform GDK if the drop ended successfully. Passing %FALSE for @success may trigger a drag cancellation animation. This function is called by the drag source, and should @@ -35610,50 +24902,34 @@ all subsequent calls will be ignored. - a #GdkDragContext + a #GdkDragContext - whether the drag was ultimatively successful + whether the drag was ultimatively successful - - Returns whether the dropped data has been successfully + + Returns whether the dropped data has been successfully transferred. This function is intended to be used while handling a %GDK_DROP_FINISHED event, its return value is meaningless at other times. - %TRUE if the drop was successful. + %TRUE if the drop was successful. - a #GdkDragContext + a #GdkDragContext - - Finds the destination window and DND protocol to use at the + + Finds the destination window and DND protocol to use at the given pointer position. This function is called by the drag source to obtain the @@ -35664,80 +24940,52 @@ This function is called by the drag source to obtain the - a #GdkDragContext + a #GdkDragContext - a window which may be at the pointer position, but + a window which may be at the pointer position, but should be ignored, since it is put up by the drag source as an icon - the screen where the destination window is sought + the screen where the destination window is sought - the x position of the pointer in root coordinates + the x position of the pointer in root coordinates - the y position of the pointer in root coordinates + the y position of the pointer in root coordinates - - location to store the destination window in + + location to store the destination window in - - location to store the DND protocol in + + location to store the DND protocol in - Returns the selection atom for the current source window. + Returns the selection atom for the current source window. - the selection atom, or %GDK_NONE + the selection atom, or %GDK_NONE - a #GdkDragContext. + a #GdkDragContext. - Updates the drag context when the pointer moves or the + Updates the drag context when the pointer moves or the set of actions changes. This function is called by the drag source. @@ -35750,60 +24998,42 @@ operations. See gdk_drag_context_manage_dnd() for more information. - a #GdkDragContext + a #GdkDragContext - the new destination window, obtained by + the new destination window, obtained by gdk_drag_find_window() - the DND protocol in use, obtained by gdk_drag_find_window() + the DND protocol in use, obtained by gdk_drag_find_window() - the x position of the pointer in root coordinates + the x position of the pointer in root coordinates - the y position of the pointer in root coordinates + the y position of the pointer in root coordinates - the suggested action + the suggested action - the possible actions + the possible actions - the timestamp for this operation + the timestamp for this operation - Selects one of the actions offered by the drag source. + Selects one of the actions offered by the drag source. This function is called by the drag destination in response to gdk_drag_motion() called by the drag source. @@ -35813,30 +25043,22 @@ gdk_drag_motion() called by the drag source. - a #GdkDragContext + a #GdkDragContext - the selected action which will be taken when a drop happens, + the selected action which will be taken when a drop happens, or 0 to indicate that a drop will not be accepted - the timestamp for this operation + the timestamp for this operation - Ends the drag operation after a drop. + Ends the drag operation after a drop. This function is called by the drag destination. @@ -35845,29 +25067,21 @@ This function is called by the drag destination. - a #GdkDragContext + a #GdkDragContext - %TRUE if the data was successfully received + %TRUE if the data was successfully received - the timestamp for this operation + the timestamp for this operation - Accepts or rejects a drop. + Accepts or rejects a drop. This function is called by the drag destination in response to a drop initiated by the drag source. @@ -35877,32 +25091,24 @@ to a drop initiated by the drag source. - a #GdkDragContext + a #GdkDragContext - %TRUE if the drop is accepted + %TRUE if the drop is accepted - the timestamp for this operation + the timestamp for this operation - Removes an error trap pushed with gdk_error_trap_push(). + Removes an error trap pushed with gdk_error_trap_push(). May block until an error has been definitively received or not received from the X server. gdk_error_trap_pop_ignored() -is preferred if you don’t need to know whether an error +is preferred if you don’t need to know whether an error occurred, because it never has to block. If you don't need the return value of gdk_error_trap_pop(), use gdk_error_trap_pop_ignored(). @@ -35912,18 +25118,12 @@ sync for you, so you had to gdk_flush() if your last call to Xlib was not a blocking round trip. - X error code or 0 on success + X error code or 0 on success - - Removes an error trap pushed with gdk_error_trap_push(), but + + Removes an error trap pushed with gdk_error_trap_push(), but without bothering to wait and see whether an error occurred. If an error arrives later asynchronously that was triggered while the trap was pushed, that error will be ignored. @@ -35933,13 +25133,11 @@ trap was pushed, that error will be ignored. - This function allows X errors to be trapped instead of the normal + This function allows X errors to be trapped instead of the normal behavior of exiting the application. It should only be used if it is not possible to avoid the X error in any other way. Errors are ignored on all #GdkDisplay currently known to the -#GdkDisplayManager. If you don’t care which error happens and just +#GdkDisplayManager. If you don’t care which error happens and just want to ignore everything, pop with gdk_error_trap_pop_ignored(). If you need the error code, use gdk_error_trap_pop() which may have to block and wait for the error to arrive from the X server. @@ -35967,30 +25165,20 @@ if (gdk_error_trap_pop ()) - - Checks all open displays for a #GdkEvent to process,to be processed + + Checks all open displays for a #GdkEvent to process,to be processed on, fetching events from the windowing system if necessary. See gdk_display_get_event(). - the next #GdkEvent to be processed, or %NULL + the next #GdkEvent to be processed, or %NULL if no events are pending. The returned #GdkEvent should be freed with gdk_event_free(). - - Sets the function to call to handle all events from GDK. + + Sets the function to call to handle all events from GDK. Note that GTK+ uses this to install its own event handler, so it is usually not useful for GTK+ applications. (Although an application @@ -36001,58 +25189,34 @@ events to GTK+.) - - the function to call to handle events from GDK. + + the function to call to handle events from GDK. - - user data to pass to the function. + + user data to pass to the function. - the function to call when the handler function is removed, i.e. when + the function to call when the handler function is removed, i.e. when gdk_event_handler_set() is called with another event handler. - - If there is an event waiting in the event queue of some open + + If there is an event waiting in the event queue of some open display, returns a copy of it. See gdk_display_peek_event(). - a copy of the first #GdkEvent on some event + a copy of the first #GdkEvent on some event queue, or %NULL if no events are in any queues. The returned #GdkEvent should be freed with gdk_event_free(). - - Request more motion notifies if @event is a motion notify hint event. + + Request more motion notifies if @event is a motion notify hint event. This function should be used instead of gdk_window_get_pointer() to request further motion notifies, because it also works for extension @@ -36075,25 +25239,19 @@ motion events from a %GDK_MOTION_NOTIFY event usually works like this: - a valid #GdkEvent + a valid #GdkEvent - The event structures contain data specific to each type of event in GDK. + The event structures contain data specific to each type of event in GDK. > A common mistake is to forget to set the event mask of a widget so that > the required events are received. See gtk_widget_set_events(). - This section describes functions dealing with events from the window + This section describes functions dealing with events from the window system. In GTK+ applications the events are handled automatically in @@ -36101,147 +25259,91 @@ gtk_main_do_event() and passed on to the appropriate widgets, so these functions are rarely needed. Though some of the fields in the [Event Structures][gdk3-Event-Structures] are useful. - - If both events contain X/Y information, this function will return %TRUE + + If both events contain X/Y information, this function will return %TRUE and return in @angle the relative angle from @event1 to @event2. The rotation direction for positive angles is from the positive X axis towards the positive Y axis. - %TRUE if the angle could be calculated. + %TRUE if the angle could be calculated. - first #GdkEvent + first #GdkEvent - second #GdkEvent + second #GdkEvent - - return location for the relative angle between both events + + return location for the relative angle between both events - - If both events contain X/Y information, the center of both coordinates + + If both events contain X/Y information, the center of both coordinates will be returned in @x and @y. - %TRUE if the center could be calculated. + %TRUE if the center could be calculated. - first #GdkEvent + first #GdkEvent - second #GdkEvent + second #GdkEvent - - return location for the X coordinate of the center + + return location for the X coordinate of the center - - return location for the Y coordinate of the center + + return location for the Y coordinate of the center - - If both events have X/Y information, the distance between both coordinates + + If both events have X/Y information, the distance between both coordinates (as in a straight line going from @event1 to @event2) will be returned. - %TRUE if the distance could be calculated. + %TRUE if the distance could be calculated. - first #GdkEvent + first #GdkEvent - second #GdkEvent + second #GdkEvent - - return location for the distance + + return location for the distance - Checks if any events are ready to be processed for any display. + Checks if any events are ready to be processed for any display. - %TRUE if any events are pending. + %TRUE if any events are pending. - Flushes the output buffers of all display connections and waits + Flushes the output buffers of all display connections and waits until all requests have been processed. This is rarely needed by applications. @@ -36250,15 +25352,11 @@ This is rarely needed by applications. - The functions in this section are intended to be used in test programs. + The functions in this section are intended to be used in test programs. They allow to simulate some user input. - This section describes the GDK initialization functions and miscellaneous + This section describes the GDK initialization functions and miscellaneous utility functions, as well as deprecation facilities. The GDK and GTK+ headers annotate deprecated APIs in a way that produces @@ -36273,94 +25371,64 @@ you want to receive warnings about deprecated APIs. Define the macro %GDK_VERSION_MAX_ALLOWED to specify the newest version whose API you want to use. - - Obtains the root window (parent all other windows are inside) + + Obtains the root window (parent all other windows are inside) for the default display and screen. - the default root window + the default root window - - Gets the name of the display, which usually comes from the + + Gets the name of the display, which usually comes from the `DISPLAY` environment variable or the `--display` command line option. Call gdk_display_get_name (gdk_display_get_default ())) instead. - the name of the display. + the name of the display. - - Gets the display name specified in the command line arguments passed + + Gets the display name specified in the command line arguments passed to gdk_init() or gdk_parse_args(), if any. - the display name, if specified explicitly, + the display name, if specified explicitly, otherwise %NULL this string is owned by GTK+ and must not be modified or freed. - Gets the program class. Unless the program class has explicitly + Gets the program class. Unless the program class has explicitly been set with gdk_set_program_class() or with the `--class` commandline option, the default value is the program name (determined with g_get_prgname()) with the first character converted to uppercase. - the program class. + the program class. - Gets whether event debugging output is enabled. + Gets whether event debugging output is enabled. - %TRUE if event debugging output is enabled. + %TRUE if event debugging output is enabled. - + - Initializes the GDK library and connects to the windowing system. + Initializes the GDK library and connects to the windowing system. If initialization fails, a warning message is output and the application terminates with a call to `exit(1)`. @@ -36374,22 +25442,12 @@ needed by GTK+ applications. - - the number of command line arguments. + + the number of command line arguments. - - the array of command line arguments. + + the array of command line arguments. @@ -36397,9 +25455,7 @@ needed by GTK+ applications. - Initializes the GDK library and connects to the windowing system, + Initializes the GDK library and connects to the windowing system, returning %TRUE on success. Any arguments used by GDK are removed from the array and @argc and @argv @@ -36409,41 +25465,24 @@ GTK+ initializes GDK in gtk_init() and so this function is not usually needed by GTK+ applications. - %TRUE if initialization succeeded. + %TRUE if initialization succeeded. - - the number of command line arguments. + + the number of command line arguments. - - the array of command line arguments. + + the array of command line arguments. - - Grabs the keyboard so that all events are passed to this + + Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with gdk_keyboard_ungrab(). This overrides any previous keyboard grab by this client. @@ -36453,22 +25492,16 @@ are emitted when the grab ends unvoluntarily. Use gdk_device_grab() instead. - %GDK_GRAB_SUCCESS if the grab was successful. + %GDK_GRAB_SUCCESS if the grab was successful. - the #GdkWindow which will own the grab (the grab window). + the #GdkWindow which will own the grab (the grab window). - if %FALSE then all keyboard events are reported with respect to + if %FALSE then all keyboard events are reported with respect to @window. If %TRUE then keyboard events for this application are reported as normal, but keyboard events outside this application are reported with respect to @window. Both key press and key @@ -36477,21 +25510,14 @@ are emitted when the grab ends unvoluntarily. - a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is + a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is available. - - Ungrabs the keyboard on the default display, if it is grabbed by this + + Ungrabs the keyboard on the default display, if it is grabbed by this application. Use gdk_device_ungrab(), together with gdk_device_grab() instead. @@ -36501,18 +25527,14 @@ application. - a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no + a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is available. - Key values are the codes which are sent whenever a key is pressed or released. + Key values are the codes which are sent whenever a key is pressed or released. They appear in the #GdkEventKey.keyval field of the #GdkEventKey structure, which is passed to signal handlers for the #GtkWidget::key-press-event and #GtkWidget::key-release-event signals. @@ -36543,10 +25565,10 @@ is a mapping from #GdkKeymapKey to key values. You can think of a #GdkKeymapKey as a representation of a symbol printed on a physical keyboard key. That is, it contains three pieces of information. First, it contains the hardware keycode; this is an identifying number for a physical key. Second, it contains the -“level” of the key. The level indicates which symbol on the +“level” of the key. The level indicates which symbol on the key will be used, in a vertical direction. So on a standard US keyboard, the key -with the number “1“ on it also has the exclamation point (”!”) character on -it. The level indicates whether to use the “1” or the “!” symbol. The letter +with the number “1“ on it also has the exclamation point (”!”) character on +it. The level indicates whether to use the “1” or the “!” symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed. Third, the #GdkKeymapKey contains a group; groups are not used on standard US keyboards, @@ -36557,14 +25579,14 @@ group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters. -In order to use a keymap to interpret a key event, it’s necessary to first +In order to use a keymap to interpret a key event, it’s necessary to first convert the keyboard state into an effective group and level. This is done via a set of rules that varies widely according to type of keyboard and user configuration. The function gdk_keymap_translate_keyboard_state() accepts a keyboard state -- consisting of hardware keycode pressed, active modifiers, and active group -- applies the appropriate rules, and returns the group/level to be used to index the keymap, along with the modifiers which did not affect the -group and level. i.e. it returns “unconsumed modifiers.” The keyboard group may +group and level. i.e. it returns “unconsumed modifiers.” The keyboard group may differ from the effective group used for keymap lookups because some keys don't have multiple groups - e.g. the Enter key is always in group 0 regardless of keyboard state. @@ -36572,14 +25594,11 @@ keyboard state. Note that gdk_keymap_translate_keyboard_state() also returns the keyval, i.e. it goes ahead and performs the keymap lookup in addition to telling you which effective group/level values were used for the lookup. #GdkEventKey already -contains this keyval, however, so you don’t normally need to call +contains this keyval, however, so you don’t normally need to call gdk_keymap_translate_keyboard_state() just to get the keyval. - - Obtains the upper- and lower-case versions of the keyval @symbol. + + Obtains the upper- and lower-case versions of the keyval @symbol. Examples of keyvals are #GDK_KEY_a, #GDK_KEY_Enter, #GDK_KEY_F1, etc. @@ -36587,221 +25606,156 @@ Examples of keyvals are #GDK_KEY_a, #GDK_KEY_Enter, #GDK_KEY_F1, etc. - a keyval + a keyval - - return location for lowercase version of @symbol + + return location for lowercase version of @symbol - - return location for uppercase version of @symbol + + return location for uppercase version of @symbol - Converts a key name to a key value. + Converts a key name to a key value. The names are the same as those in the `gdk/gdkkeysyms.h` header file -but without the leading “GDK_KEY_”. +but without the leading “GDK_KEY_”. - the corresponding key value, or %GDK_KEY_VoidSymbol + the corresponding key value, or %GDK_KEY_VoidSymbol if the key name is not a valid key - a key name + a key name - Returns %TRUE if the given key value is in lower case. + Returns %TRUE if the given key value is in lower case. - %TRUE if @keyval is in lower case, or if @keyval is not + %TRUE if @keyval is in lower case, or if @keyval is not subject to case conversion. - a key value. + a key value. - Returns %TRUE if the given key value is in upper case. + Returns %TRUE if the given key value is in upper case. - %TRUE if @keyval is in upper case, or if @keyval is not subject to + %TRUE if @keyval is in upper case, or if @keyval is not subject to case conversion. - a key value. + a key value. - Converts a key value into a symbolic name. + Converts a key value into a symbolic name. The names are the same as those in the `gdk/gdkkeysyms.h` header file -but without the leading “GDK_KEY_”. +but without the leading “GDK_KEY_”. - a string containing the name + a string containing the name of the key, or %NULL if @keyval is not a valid key. The string should not be modified. - a key value + a key value - Converts a key value to lower case, if applicable. + Converts a key value to lower case, if applicable. - the lower case form of @keyval, or @keyval itself if it is already + the lower case form of @keyval, or @keyval itself if it is already in lower case or it is not subject to case conversion. - a key value. + a key value. - Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) + Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) character. - the corresponding unicode character, or 0 if there + the corresponding unicode character, or 0 if there is no corresponding character. - a GDK key symbol + a GDK key symbol - Converts a key value to upper case, if applicable. + Converts a key value to upper case, if applicable. - the upper case form of @keyval, or @keyval itself if it is already + the upper case form of @keyval, or @keyval itself if it is already in upper case or it is not subject to case conversion. - a key value. + a key value. - - Lists the available visuals for the default screen. + + Lists the available visuals for the default screen. (See gdk_screen_list_visuals()) A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format. -Call g_list_free() on the return value when you’re finished with it. +Call g_list_free() on the return value when you’re finished with it. Use gdk_screen_list_visuals (gdk_screen_get_default ()). - + a list of visuals; the list must be freed, but not its contents - - Indicates to the GUI environment that the application has finished + + Indicates to the GUI environment that the application has finished loading. If the applications opens windows, this function is -normally called after opening the application’s initial set of +normally called after opening the application’s initial set of windows. GTK+ will call this function automatically after opening the first @@ -36812,12 +25766,8 @@ to disable that feature. - - Indicates to the GUI environment that the application has + + Indicates to the GUI environment that the application has finished loading, using a given identifier. GTK+ will call this function automatically for #GtkWindow @@ -36830,67 +25780,46 @@ disable that feature. - a startup-notification identifier, for which + a startup-notification identifier, for which notification process should be completed - - Gets the window that @window is embedded in. + + Gets the window that @window is embedded in. - the embedding #GdkWindow, or + the embedding #GdkWindow, or %NULL if @window is not an mbedded offscreen window - a #GdkWindow + a #GdkWindow - - Gets the offscreen surface that an offscreen window renders into. + + Gets the offscreen surface that an offscreen window renders into. If you need to keep this around over window resizes, you need to add a reference to it. - The offscreen surface, or + The offscreen surface, or %NULL if not offscreen - a #GdkWindow + a #GdkWindow - - Sets @window to be embedded in @embedder. + + Sets @window to be embedded in @embedder. To fully embed an offscreen window, in addition to calling this function, it is also necessary to handle the #GdkWindow::pick-embedded-child @@ -36902,25 +25831,19 @@ signal on the @embedder and the #GdkWindow::to-embedder and - a #GdkWindow + a #GdkWindow - the #GdkWindow that @window gets embedded in + the #GdkWindow that @window gets embedded in - Creates a #PangoContext for the default GDK screen. + Creates a #PangoContext for the default GDK screen. -The context must be freed when you’re finished with it. +The context must be freed when you’re finished with it. When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for @@ -36930,23 +25853,17 @@ The newly created context will have the default font options (see #cairo_font_options_t) for the default screen; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track -changes to the screen’s font rendering settings. +changes to the screen’s font rendering settings. - a new #PangoContext for the default display + a new #PangoContext for the default display - - Creates a #PangoContext for @display. + + Creates a #PangoContext for @display. -The context must be freed when you’re finished with it. +The context must be freed when you’re finished with it. When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for @@ -36959,28 +25876,20 @@ is more convenient if you want to keep a context around and track changes to the font rendering settings. - a new #PangoContext for @display + a new #PangoContext for @display - the #GdkDisplay for which the context is to be created + the #GdkDisplay for which the context is to be created - - Creates a #PangoContext for @screen. + + Creates a #PangoContext for @screen. -The context must be freed when you’re finished with it. +The context must be freed when you’re finished with it. When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for @@ -36990,34 +25899,28 @@ The newly created context will have the default font options (see #cairo_font_options_t) for the screen; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track -changes to the screen’s font rendering settings. +changes to the screen’s font rendering settings. - a new #PangoContext for @screen + a new #PangoContext for @screen - the #GdkScreen for which the context is to be created. + the #GdkScreen for which the context is to be created. - Pango is the text layout system used by GDK and GTK+. The functions + Pango is the text layout system used by GDK and GTK+. The functions and types in this section are used to obtain clip regions for #PangoLayouts, and to get #PangoContexts that can be used with GDK. Creating a #PangoLayout object is the first step in rendering text, and requires getting a handle to a #PangoContext. For GTK+ programs, -you’ll usually want to use gtk_widget_get_pango_context(), or +you’ll usually want to use gtk_widget_get_pango_context(), or gtk_widget_create_pango_layout(), rather than using the lowlevel gdk_pango_context_get_for_screen(). Once you have a #PangoLayout, you can set the text and attributes of it with Pango functions like @@ -37100,15 +26003,11 @@ g_object_unref (context); ![](rotated-text.png) - - Obtains a clip region which contains the areas where the given ranges + + Obtains a clip region which contains the areas where the given ranges of text would be drawn. @x_origin and @y_origin are the top left point to center the layout. @index_ranges should contain -ranges of bytes in the layout’s text. +ranges of bytes in the layout’s text. Note that the regions returned correspond to logical extents of the text ranges, not ink extents. So the drawn layout may in fact touch areas out of @@ -37116,53 +26015,37 @@ the clip region. The clip region is mainly useful for highlightling parts of text, such as when text is selected. - a clip region containing the given ranges + a clip region containing the given ranges - a #PangoLayout + a #PangoLayout - X pixel where you intend to draw the layout with this clip + X pixel where you intend to draw the layout with this clip - Y pixel where you intend to draw the layout with this clip + Y pixel where you intend to draw the layout with this clip - array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes + array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes - number of ranges in @index_ranges, i.e. half the size of @index_ranges + number of ranges in @index_ranges, i.e. half the size of @index_ranges - - Obtains a clip region which contains the areas where the given + + Obtains a clip region which contains the areas where the given ranges of text would be drawn. @x_origin and @y_origin are the top left position of the layout. @index_ranges -should contain ranges of bytes in the layout’s text. The clip +should contain ranges of bytes in the layout’s text. The clip region will include space to the left or right of the line (to the layout bounding box) if you have indexes above or below the indexes contained inside the line. This is to draw the selection all the way @@ -37175,34 +26058,24 @@ the clip region. The clip region is mainly useful for highlightling parts of text, such as when text is selected. - a clip region containing the given ranges + a clip region containing the given ranges - a #PangoLayoutLine + a #PangoLayoutLine - X pixel where you intend to draw the layout line with this clip + X pixel where you intend to draw the layout line with this clip - baseline pixel where you intend to draw the layout line with this clip + baseline pixel where you intend to draw the layout line with this clip - array of byte indexes into the layout, + array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes @@ -37210,56 +26083,39 @@ of text, such as when text is selected. - number of ranges in @index_ranges, i.e. half the size of @index_ranges + number of ranges in @index_ranges, i.e. half the size of @index_ranges - Parse command line arguments, and store for future + Parse command line arguments, and store for future use by calls to gdk_display_open(). Any arguments used by GDK are removed from the array and @argc and @argv are updated accordingly. -You shouldn’t call this function explicitly if you are using +You shouldn’t call this function explicitly if you are using gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check(). - - the number of command line arguments. + + the number of command line arguments. - - the array of command line arguments. + + the array of command line arguments. - - Transfers image data from a #cairo_surface_t and converts it to an RGB(A) + + Transfers image data from a #cairo_surface_t and converts it to an RGB(A) representation inside a #GdkPixbuf. This allows you to efficiently read individual pixels from cairo surfaces. For #GdkWindows, use gdk_pixbuf_get_from_window() instead. @@ -37268,50 +26124,35 @@ This function will create an RGB pixbuf with 8 bits per channel. The pixbuf will contain an alpha channel if the @surface contains one. - A newly-created pixbuf with a + A newly-created pixbuf with a reference count of 1, or %NULL on error - surface to copy from + surface to copy from - Source X coordinate within @surface + Source X coordinate within @surface - Source Y coordinate within @surface + Source Y coordinate within @surface - Width in pixels of region to get + Width in pixels of region to get - Height in pixels of region to get + Height in pixels of region to get - - Transfers image data from a #GdkWindow and converts it to an RGB(A) + + Transfers image data from a #GdkWindow and converts it to an RGB(A) representation inside a #GdkPixbuf. In other words, copies image data from a server-side drawable to a client-side RGB(A) buffer. This allows you to efficiently read individual pixels on the client side. @@ -37325,75 +26166,56 @@ If the window is off the screen, then there is no image data in the obscured/offscreen regions to be placed in the pixbuf. The contents of portions of the pixbuf corresponding to the offscreen region are undefined. -If the window you’re obtaining data from is partially obscured by +If the window you’re obtaining data from is partially obscured by other windows, then the contents of the pixbuf areas corresponding to the obscured regions are undefined. -If the window is not mapped (typically because it’s iconified/minimized +If the window is not mapped (typically because it’s iconified/minimized or not on the current workspace), then %NULL will be returned. -If memory can’t be allocated for the return value, %NULL will be returned +If memory can’t be allocated for the return value, %NULL will be returned instead. (In short, there are several ways this function can fail, and if it fails it returns %NULL; so check the return value.) - A newly-created pixbuf with a + A newly-created pixbuf with a reference count of 1, or %NULL on error - Source window + Source window - Source X coordinate within @window + Source X coordinate within @window - Source Y coordinate within @window + Source Y coordinate within @window - Width in pixels of region to get + Width in pixels of region to get - Height in pixels of region to get + Height in pixels of region to get - Pixbufs are client-side images. For details on how to create + Pixbufs are client-side images. For details on how to create and manipulate pixbufs, see the #GdkPixbuf API documentation. The functions described here allow to obtain pixbufs from #GdkWindows and cairo surfaces. - - Grabs the pointer (usually a mouse) so that all events are passed to this + + Grabs the pointer (usually a mouse) so that all events are passed to this application until the pointer is ungrabbed with gdk_pointer_ungrab(), or the grab window becomes unviewable. This overrides any previous pointer grab by this client. @@ -37417,22 +26239,16 @@ are emitted when the grab ends unvoluntarily. Use gdk_device_grab() instead. - %GDK_GRAB_SUCCESS if the grab was successful. + %GDK_GRAB_SUCCESS if the grab was successful. - the #GdkWindow which will own the grab (the grab window). + the #GdkWindow which will own the grab (the grab window). - if %FALSE then all pointer events are reported with respect to + if %FALSE then all pointer events are reported with respect to @window and are only reported if selected by @event_mask. If %TRUE then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to @window and only if selected by @@ -37440,53 +26256,34 @@ are emitted when the grab ends unvoluntarily. - specifies the event mask, which is used in accordance with + specifies the event mask, which is used in accordance with @owner_events. Note that only pointer events (i.e. button and motion events) may be selected. - - If non-%NULL, the pointer will be confined to this + + If non-%NULL, the pointer will be confined to this window during the grab. If the pointer is outside @confine_to, it will automatically be moved to the closest edge of @confine_to and enter and leave events will be generated as necessary. - - the cursor to display while the grab is active. If this is %NULL then + + the cursor to display while the grab is active. If this is %NULL then the normal cursors are used for @window and its descendants, and the cursor for @window is used for all other windows. - the timestamp of the event which led to this pointer grab. This usually + the timestamp of the event which led to this pointer grab. This usually comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if - the time isn’t known. + the time isn’t known. - - Returns %TRUE if the pointer on the default display is currently + + Returns %TRUE if the pointer on the default display is currently grabbed by this application. Note that this does not take the inmplicit pointer grab on button @@ -37494,19 +26291,12 @@ presses into account. Use gdk_display_device_is_grabbed() instead. - %TRUE if the pointer is currently grabbed by this application. + %TRUE if the pointer is currently grabbed by this application. - - Ungrabs the pointer on the default display, if it is grabbed by this + + Ungrabs the pointer on the default display, if it is grabbed by this application. Use gdk_device_ungrab(), together with gdk_device_grab() instead. @@ -37516,21 +26306,14 @@ application. - a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no + a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is available. - - Prepare for parsing command line arguments for GDK. This is not + + Prepare for parsing command line arguments for GDK. This is not public API and should not be used in application code. This symbol was never meant to be used outside of GTK+ @@ -37540,19 +26323,17 @@ public API and should not be used in application code. - Each window under X can have any number of associated -“properties” attached to it. + Each window under X can have any number of associated +“properties” attached to it. Properties are arbitrary chunks of data identified by -“atom”s. (An “atom” +“atom”s. (An “atom” is a numeric index into a string table on the X server. They are used to transfer strings efficiently between clients without having to transfer the entire string.) A property has an associated type, which is also identified using an atom. -A property has an associated “format”, +A property has an associated “format”, an integer describing how many bits are in each unit of data inside the property. It must be 8, 16, or 32. When data is transferred between the server and client, @@ -37570,96 +26351,70 @@ and change properties on windows, to convert atoms to and from strings and to manipulate some types of data commonly stored in X window properties. - - Changes the contents of a property on a window. + + Changes the contents of a property on a window. - a #GdkWindow + a #GdkWindow - the property to change + the property to change - the new type for the property. If @mode is + the new type for the property. If @mode is %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this must match the existing type or an error will occur. - the new format for the property. If @mode is + the new format for the property. If @mode is %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this must match the existing format or an error will occur. - a value describing how the new data is to be combined + a value describing how the new data is to be combined with the current data. - the data (a `guchar *` + the data (a `guchar *` `gushort *`, or `gulong *`, depending on @format), cast to a `guchar *`. - the number of elements of size determined by the format, + the number of elements of size determined by the format, contained in @data. - Deletes a property from a window. + Deletes a property from a window. - a #GdkWindow + a #GdkWindow - the property to delete + the property to delete - Retrieves a portion of the contents of a property. If the + Retrieves a portion of the contents of a property. If the property does not exist, then the function returns %FALSE, and %GDK_NONE will be stored in @actual_property_type. @@ -37673,29 +26428,21 @@ XGetWindowProperty() directly until a replacement function for gdk_property_get() is provided. - %TRUE if data was successfully received and stored + %TRUE if data was successfully received and stored in @data, otherwise %FALSE. - a #GdkWindow + a #GdkWindow - the property to retrieve + the property to retrieve - the desired property type, or %GDK_NONE, if any type of data + the desired property type, or %GDK_NONE, if any type of data is acceptable. If this does not match the actual type, then @actual_format and @actual_length will be filled in, a warning will be printed to stderr @@ -37703,16 +26450,12 @@ gdk_property_get() is provided. - the offset into the property at which to begin + the offset into the property at which to begin retrieving data, in 4 byte units. - the length of the data to retrieve in bytes. Data is + the length of the data to retrieve in bytes. Data is considered to be retrieved in 4 byte chunks, so @length will be rounded up to the next highest 4 byte boundary (so be careful not to pass a value that might overflow @@ -37720,39 +26463,22 @@ gdk_property_get() is provided. - if %TRUE, delete the property after retrieving the + if %TRUE, delete the property after retrieving the data. - - location to store the + + location to store the actual type of the property. - - location to store the actual return format of the + + location to store the actual return format of the data; either 8, 16 or 32 bits. - - location to store the length of the retrieved data, in + + location to store the length of the retrieved data, in bytes. Data returned in the 32 bit format is stored in a long variable, so the actual number of 32 bit elements should be be calculated via @@ -37760,13 +26486,8 @@ gdk_property_get() is provided. 64 bit systems. - - location + + location to store a pointer to the data. The retrieved data should be freed with g_free() when you are finished using it. @@ -37775,14 +26496,9 @@ gdk_property_get() is provided. - - This function returns the available bit depths for the default -screen. It’s equivalent to listing the visuals + + This function returns the available bit depths for the default +screen. It’s equivalent to listing the visuals (gdk_list_visuals()) and then looking at the depth field in each visual, removing duplicates. @@ -37794,37 +26510,22 @@ The array returned by this function should not be freed. - - return + + return location for available depths - - return location for number of available depths + + return location for number of available depths - - This function returns the available visual types for the default -screen. It’s equivalent to listing the visuals + + This function returns the available visual types for the default +screen. It’s equivalent to listing the visuals (gdk_list_visuals()) and then looking at the type field in each visual, removing duplicates. @@ -37836,34 +26537,22 @@ The array returned by this function should not be freed. - - return + + return location for the available visual types - - return location for the number of available visual types + + return location for the number of available visual types - GDK provides the #GdkPoint and #GdkRectangle data types for representing pixels -and sets of pixels on the screen. Together with Cairo’s #cairo_region_t data + GDK provides the #GdkPoint and #GdkRectangle data types for representing pixels +and sets of pixels on the screen. Together with Cairo’s #cairo_region_t data type, they make up the central types for representing graphical data. A #GdkPoint represents an x and y coordinate of a point. @@ -37876,19 +26565,15 @@ gdk_rectangle_union(). #cairo_region_t is usually used for managing clipping of graphical operations. - #GdkRGBA is a convenient way to pass rgba colors around. -It’s based on cairo’s way to deal with colors and mirrors its behavior. + #GdkRGBA is a convenient way to pass rgba colors around. +It’s based on cairo’s way to deal with colors and mirrors its behavior. All values are in the range from 0.0 to 1.0 inclusive. So the color (0.0, 0.0, 0.0, 0.0) represents transparent black and (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will be clamped to this range when drawing. - Retrieves the contents of a selection in a given + Retrieves the contents of a selection in a given form. @@ -37896,28 +26581,20 @@ form. - a #GdkWindow. + a #GdkWindow. - an atom identifying the selection to get the + an atom identifying the selection to get the contents of. - the form in which to retrieve the selection. + the form in which to retrieve the selection. - the timestamp to use when retrieving the + the timestamp to use when retrieving the selection. The selection owner may refuse the request if it did not own the selection at the time indicated by the timestamp. @@ -37925,16 +26602,11 @@ form. - - Determines the owner of the given selection. + + Determines the owner of the given selection. - if there is a selection owner + if there is a selection owner for this window, and it is a window known to the current process, the #GdkWindow that owns the selection, otherwise %NULL. Note that the return value may be owned by a different process if a @@ -37944,28 +26616,20 @@ form. - an atom indentifying a selection. + an atom indentifying a selection. - - Determine the owner of the given selection. + + Determine the owner of the given selection. Note that the return value may be owned by a different process if a foreign window was previously created for that window, but a new foreign window will never be created by this call. - if there is a selection owner + if there is a selection owner for this window, and it is a window known to the current process, the #GdkWindow that owns the selection, otherwise %NULL. @@ -37973,149 +26637,100 @@ window, but a new foreign window will never be created by this call. - a #GdkDisplay + a #GdkDisplay - an atom indentifying a selection + an atom indentifying a selection - - Sets the owner of the given selection. + + Sets the owner of the given selection. - %TRUE if the selection owner was successfully + %TRUE if the selection owner was successfully changed to @owner, otherwise %FALSE. - - a #GdkWindow or %NULL to indicate that the + + a #GdkWindow or %NULL to indicate that the the owner for the given should be unset. - an atom identifying a selection. + an atom identifying a selection. - timestamp to use when setting the selection. + timestamp to use when setting the selection. If this is older than the timestamp given last time the owner was set for the given selection, the request will be ignored. - if %TRUE, and the new owner is different + if %TRUE, and the new owner is different from the current owner, the current owner will be sent a SelectionClear event. - - Sets the #GdkWindow @owner as the current owner of the selection @selection. + + Sets the #GdkWindow @owner as the current owner of the selection @selection. - %TRUE if the selection owner was successfully changed to owner, + %TRUE if the selection owner was successfully changed to owner, otherwise %FALSE. - the #GdkDisplay + the #GdkDisplay - - a #GdkWindow or %NULL to indicate that the owner for + + a #GdkWindow or %NULL to indicate that the owner for the given should be unset - an atom identifying a selection + an atom identifying a selection - timestamp to use when setting the selection + timestamp to use when setting the selection If this is older than the timestamp given last time the owner was set for the given selection, the request will be ignored - if %TRUE, and the new owner is different from the current + if %TRUE, and the new owner is different from the current owner, the current owner will be sent a SelectionClear event - - Retrieves selection data that was stored by the selection + + Retrieves selection data that was stored by the selection data in response to a call to gdk_selection_convert(). This function will not be used by applications, who should use the #GtkClipboard API instead. - the length of the retrieved data. + the length of the retrieved data. - the window on which the data is stored + the window on which the data is stored - location to store a pointer to the retrieved data. + location to store a pointer to the retrieved data. If the retrieval failed, %NULL we be stored here, otherwise, it will be non-%NULL and the returned data should be freed with g_free() when you are finished using it. The length of the @@ -38125,127 +26740,92 @@ API instead. - location to store the type of the property + location to store the type of the property - location to store the format of the property + location to store the format of the property - - Sends a response to SelectionRequest event. + + Sends a response to SelectionRequest event. - window to which to deliver response. + window to which to deliver response. - selection that was requested. + selection that was requested. - target that was selected. + target that was selected. - property in which the selection owner stored the + property in which the selection owner stored the data, or %GDK_NONE to indicate that the request was rejected. - timestamp. + timestamp. - - Send a response to SelectionRequest event. + + Send a response to SelectionRequest event. - the #GdkDisplay where @requestor is realized + the #GdkDisplay where @requestor is realized - window to which to deliver response + window to which to deliver response - selection that was requested + selection that was requested - target that was selected + target that was selected - property in which the selection owner stored the data, + property in which the selection owner stored the data, or %GDK_NONE to indicate that the request was rejected - timestamp + timestamp - GDK’s selection functions, based on the [X selection mechanism]( + GDK’s selection functions, based on the [X selection mechanism]( https://www.x.org/releases/X11R7.6/doc/xorg-docs/specs/ICCCM/icccm.html), provide a way to transfer arbitrary chunks of -data between programs. A “selection” is a essentially +data between programs. A “selection” is a essentially a named clipboard, identified by a string interned as a #GdkAtom. By claiming ownership of a selection, an application indicates that it will be responsible for supplying its contents. The most common selections are `PRIMARY` and `CLIPBOARD`. The contents of a selection can be represented in a number of formats, -called “targets”. Each target is identified by an atom. +called “targets”. Each target is identified by an atom. A list of all possible targets supported by the selection owner can be retrieved by requesting the special target `TARGETS`. When a selection is retrieved, the data is accompanied by a type (an atom), and @@ -38265,12 +26845,8 @@ https://www.x.org/releases/X11R7.6/doc/xorg-docs/specs/ICCCM/icccm.html). Note that although much of the selection API design is based on that of X, it will work on other GDK backends too. - - Sets a list of backends that GDK should try to use. + + Sets a list of backends that GDK should try to use. This can be be useful if your application does not work with certain GDK backends. @@ -38303,18 +26879,13 @@ in order to take effect. - a comma-separated list of backends + a comma-separated list of backends - - Set the double click time for the default display. See + + Set the double click time for the default display. See gdk_display_set_double_click_time(). See also gdk_display_set_double_click_distance(). Applications should not set this, it is a @@ -38325,17 +26896,13 @@ global user-configured setting. - double click time in milliseconds (thousandths of a second) + double click time in milliseconds (thousandths of a second) - Sets the program class. The X11 backend uses the program class to set + Sets the program class. The X11 backend uses the program class to set the class name part of the `WM_CLASS` property on toplevel windows; see the ICCCM. @@ -38347,17 +26914,13 @@ line option. - a string. + a string. - Sets whether a trace of received events is output. + Sets whether a trace of received events is output. Note that GTK+ must be compiled with debugging (that is, configured using the `--enable-debug` option) to use this option. @@ -38367,43 +26930,32 @@ to use this option. - %TRUE to output event debugging information. + %TRUE to output event debugging information. - Obtains a desktop-wide setting, such as the double-click time, + Obtains a desktop-wide setting, such as the double-click time, for the default screen. See gdk_screen_get_setting(). - %TRUE if the setting existed and a value was stored + %TRUE if the setting existed and a value was stored in @value, %FALSE otherwise. - the name of the setting. + the name of the setting. - location to store the value of the setting. + location to store the value of the setting. - + @@ -38420,12 +26972,8 @@ for the default screen. See gdk_screen_get_setting(). - - Retrieves a pixel from @window to force the windowing + + Retrieves a pixel from @window to force the windowing system to carry out any pending rendering commands. This function is intended to be used to synchronize with rendering @@ -38436,19 +26984,13 @@ pipelines, to benchmark windowing system rendering operations. - a mapped #GdkWindow + a mapped #GdkWindow - - This function is intended to be used in GTK+ test programs. + + This function is intended to be used in GTK+ test programs. It will warp the mouse pointer to the given (@x,@y) coordinates within @window and simulate a button press or release event. Because the mouse pointer needs to be warped to the target @@ -38462,57 +27004,39 @@ function to call which will generate a button press event followed by its accompanying button release event. - whether all actions necessary for a button event simulation + whether all actions necessary for a button event simulation were carried out successfully - a #GdkWindow to simulate a button event for + a #GdkWindow to simulate a button event for - x coordinate within @window for the button event + x coordinate within @window for the button event - y coordinate within @window for the button event + y coordinate within @window for the button event - Number of the pointer button for the event, usually 1, 2 or 3 + Number of the pointer button for the event, usually 1, 2 or 3 - Keyboard modifiers the event is setup with + Keyboard modifiers the event is setup with - either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE + either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE - - This function is intended to be used in GTK+ test programs. + + This function is intended to be used in GTK+ test programs. If (@x,@y) are > (-1,-1), it will warp the mouse pointer to the given (@x,@y) coordinates within @window and simulate a key press or release event. @@ -38530,105 +27054,70 @@ right function to call which will generate a key press event followed by its accompanying key release event. - whether all actions necessary for a key event simulation + whether all actions necessary for a key event simulation were carried out successfully - a #GdkWindow to simulate a key event for + a #GdkWindow to simulate a key event for - x coordinate within @window for the key event + x coordinate within @window for the key event - y coordinate within @window for the key event + y coordinate within @window for the key event - A GDK keyboard value + A GDK keyboard value - Keyboard modifiers the event is setup with + Keyboard modifiers the event is setup with - either %GDK_KEY_PRESS or %GDK_KEY_RELEASE + either %GDK_KEY_PRESS or %GDK_KEY_RELEASE - - Converts a text property in the given encoding to + + Converts a text property in the given encoding to a list of UTF-8 strings. - the number of strings in the resulting list + the number of strings in the resulting list - a #GdkDisplay + a #GdkDisplay - an atom representing the encoding of the text + an atom representing the encoding of the text - the format of the property + the format of the property - the text to convert + the text to convert - the length of @text, in bytes + the length of @text, in bytes - - location to store the list + + location to store the list of strings or %NULL. The list should be freed with g_strfreev(). @@ -38638,9 +27127,7 @@ a list of UTF-8 strings. - For thread safety, GDK relies on the thread primitives in GLib, + For thread safety, GDK relies on the thread primitives in GLib, and on the thread-safe GLib main loop. GLib is completely thread safe (all global data is automatically @@ -38650,7 +27137,7 @@ accesses to the same #GHashTable from multiple threads. GTK+, however, is not thread safe. You should only use GTK+ and GDK from the thread gtk_init() and gtk_main() were called on. -This is usually referred to as the “main thread”. +This is usually referred to as the “main thread”. Signals on GTK+ and GDK types, as well as non-signal callbacks, are emitted in the main thread. @@ -38692,49 +27179,29 @@ also look at #GTask, which gives you high-level tools to perform expensive tasks from worker threads, and will handle thread management for you. - - A wrapper for the common usage of gdk_threads_add_idle_full() + + A wrapper for the common usage of gdk_threads_add_idle_full() assigning the default priority, #G_PRIORITY_DEFAULT_IDLE. See gdk_threads_add_idle_full(). - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - function to call + function to call - - data to pass to @function + + data to pass to @function - - Adds a function to be called whenever there are no higher priority + + Adds a function to be called whenever there are no higher priority events pending. If the function returns %FALSE it is automatically removed from the list of event sources and will not be called again. @@ -38777,100 +27244,57 @@ some_widget_finalize (GObject *object) ]| - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the idle source. Typically this will be in the + the priority of the idle source. Typically this will be in the range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the idle is removed, or %NULL + + function to call when the idle is removed, or %NULL - - A wrapper for the common usage of gdk_threads_add_timeout_full() + + A wrapper for the common usage of gdk_threads_add_timeout_full() assigning the default priority, #G_PRIORITY_DEFAULT. See gdk_threads_add_timeout_full(). - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the time between calls to the function, in milliseconds + the time between calls to the function, in milliseconds (1/1000ths of a second) - function to call + function to call - - data to pass to @function + + data to pass to @function - - Sets a function to be called at regular intervals holding the GDK lock, + + Sets a function to be called at regular intervals holding the GDK lock, with the given priority. The function is called repeatedly until it returns %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. The @notify function is @@ -38881,7 +27305,7 @@ Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval -(it does not try to “catch up” time lost in delays). +(it does not try to “catch up” time lost in delays). This variant of g_timeout_add_full() can be thought of a MT-safe version for GTK+ widgets for the following use case: @@ -38915,167 +27339,94 @@ static void some_widget_finalize (GObject *object) ]| - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the timeout source. Typically this will be in the + the priority of the timeout source. Typically this will be in the range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. - the time between calls to the function, in milliseconds + the time between calls to the function, in milliseconds (1/1000ths of a second) - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the timeout is removed, or %NULL + + function to call when the timeout is removed, or %NULL - - A wrapper for the common usage of gdk_threads_add_timeout_seconds_full() + + A wrapper for the common usage of gdk_threads_add_timeout_seconds_full() assigning the default priority, #G_PRIORITY_DEFAULT. For details, see gdk_threads_add_timeout_full(). - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the time between calls to the function, in seconds + the time between calls to the function, in seconds - function to call + function to call - - data to pass to @function + + data to pass to @function - - A variant of gdk_threads_add_timeout_full() with second-granularity. + + A variant of gdk_threads_add_timeout_full() with second-granularity. See g_timeout_add_seconds_full() for a discussion of why it is -a good idea to use this function if you don’t need finer granularity. +a good idea to use this function if you don’t need finer granularity. - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the timeout source. Typically this will be in the + the priority of the timeout source. Typically this will be in the range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. - the time between calls to the function, in seconds + the time between calls to the function, in seconds - - function to call + + function to call - - data to pass to @function + + data to pass to @function - - function to call when the timeout is removed, or %NULL + + function to call when the timeout is removed, or %NULL - - This function marks the beginning of a critical section in which + + This function marks the beginning of a critical section in which GDK and GTK+ functions can be called safely and without causing race conditions. Only one thread at a time can be in such a critial section. @@ -39086,13 +27437,8 @@ section. - - Initializes GDK so that it can be used from multiple threads + + Initializes GDK so that it can be used from multiple threads in conjunction with gdk_threads_enter() and gdk_threads_leave(). This call must be made before any use of the main loop from @@ -39104,13 +27450,8 @@ GTK+; to be safe, call it before gtk_init(). - - Leaves a critical region begun with gdk_threads_enter(). + + Leaves a critical region begun with gdk_threads_enter(). All GDK and GTK+ calls should be made from the main thread @@ -39118,15 +27459,8 @@ GTK+; to be safe, call it before gtk_init(). - - Allows the application to replace the standard method that + + Allows the application to replace the standard method that GDK uses to protect its data structures. Normally, GDK creates a single #GMutex that is locked by gdk_threads_enter(), and released by gdk_threads_leave(); using this function an @@ -39143,7 +27477,7 @@ lock that when held, holds the GTK+ lock as well. When GTK+ unlocks the GTK+ lock when entering a recursive main loop, the application must temporarily release its lock as well. -Most threaded GTK+ apps won’t need to use this method. +Most threaded GTK+ apps won’t need to use this method. This method must be called before gdk_threads_init(), and cannot be called multiple times. @@ -39155,54 +27489,39 @@ be called multiple times. - function called to guard GDK + function called to guard GDK - function called to release the guard + function called to release the guard - Convert from a ISO10646 character to a key symbol. + Convert from a ISO10646 character to a key symbol. - the corresponding GDK key symbol, if one exists. + the corresponding GDK key symbol, if one exists. or, if there is no corresponding symbol, wc | 0x01000000 - a ISO10646 encoded character + a ISO10646 encoded character - - Converts an UTF-8 string into the best possible representation + + Converts an UTF-8 string into the best possible representation as a STRING. The representation of characters not in STRING is not specified; it may be as pseudo-escape sequences \x{ABCD}, or it may be in some other form of approximation. - the newly-allocated string, or %NULL if the + the newly-allocated string, or %NULL if the conversion failed. (It should not fail for any properly formed UTF-8 string unless system limits like memory or file descriptors are exceeded.) @@ -39210,31 +27529,27 @@ is not specified; it may be as pseudo-escape sequences - a UTF-8 string + a UTF-8 string - A #GdkVisual describes a particular video hardware display format. + A #GdkVisual describes a particular video hardware display format. It includes information about the number of bits used for each color, the way the bits are translated into an RGB value for display, and the way the bits are stored in memory. For example, a piece of display hardware might support 24-bit color, 16-bit color, or 8-bit color; meaning 24/16/8-bit pixel sizes. For a given pixel size, pixels can -be in different formats; for example the “red” element of an RGB pixel +be in different formats; for example the “red” element of an RGB pixel may be in the top 8 bits of the pixel, or may be in the lower 4 bits. There are several standard visuals. The visual returned by -gdk_screen_get_system_visual() is the system’s default visual, and +gdk_screen_get_system_visual() is the system’s default visual, and the visual returned by gdk_screen_get_rgba_visual() should be used for creating windows with an alpha channel. -A number of functions are provided for determining the “best” available +A number of functions are provided for determining the “best” available visual. For the purposes of making this determination, higher bit depths are considered better, and for visuals of the same bit depth, %GDK_VISUAL_PSEUDO_COLOR is preferred at 8bpp, otherwise, the visual @@ -39244,12 +27559,10 @@ types are ranked in the order of(highest to lowest) %GDK_VISUAL_GRAYSCALE, then %GDK_VISUAL_STATIC_GRAY. - A #GdkWindow is a (usually) rectangular region on the screen. -It’s a low-level object, used to implement high-level objects such as + A #GdkWindow is a (usually) rectangular region on the screen. +It’s a low-level object, used to implement high-level objects such as #GtkWidget and #GtkWindow on the GTK+ level. A #GtkWindow is a toplevel -window, the thing a user might think of as a “window” with a titlebar +window, the thing a user might think of as a “window” with a titlebar and so on; a #GtkWindow may contain many #GdkWindows. For example, each #GtkButton has a #GdkWindow associated with it. @@ -39258,7 +27571,7 @@ each #GtkButton has a #GdkWindow associated with it. Normally, the windowing system takes care of rendering the contents of a child window onto its parent window. This mechanism can be intercepted by calling gdk_window_set_composited() on the child -window. For a “composited” window it is the +window. For a “composited” window it is the responsibility of the application to render the window contents at the right spot. diff --git a/Gdk-4.0.gir b/Gdk-4.0.gir index bee4c60..aacc88b 100644 --- a/Gdk-4.0.gir +++ b/Gdk-4.0.gir @@ -2,7 +2,10 @@ - + @@ -10,22 +13,37 @@ and/or use gtk-doc annotations. --> - + - Defines all possible DND actions. + Defines all possible DND actions. This can be used in [method@Gdk.Drop.status] messages when any drop can be accepted or a more specific drop method is not yet known. + - + + - - Positioning hints for aligning a surface relative to a rectangle. + + Positioning hints for aligning a surface relative to a rectangle. These hints determine how the surface should be positioned in the case that the surface would fall off-screen if placed in its ideal position. @@ -40,36 +58,88 @@ horizontally to fit. In general, when multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing. - - allow flipping anchors horizontally + + allow flipping anchors horizontally - - allow flipping anchors vertically + + allow flipping anchors vertically - - allow sliding surface horizontally + + allow sliding surface horizontally - - allow sliding surface vertically + + allow sliding surface vertically - - allow resizing surface horizontally + + allow resizing surface horizontally - - allow resizing surface vertically + + allow resizing surface vertically - - allow flipping anchors on both axes + + allow flipping anchors on both axes - - allow sliding surface on both axes + + allow sliding surface on both axes - - allow resizing surface on both axes + + allow resizing surface on both axes - - `GdkAppLaunchContext` handles launching an application in a graphical context. + + `GdkAppLaunchContext` handles launching an application in a graphical context. It is an implementation of `GAppLaunchContext` that provides startup notification and allows to launch applications on a specific screen @@ -90,22 +160,33 @@ if (!g_app_info_launch_default_for_uri ("http://www.gtk.org", context, &erro g_object_unref (context); ``` - + - Gets the `GdkDisplay` that @context is for. + Gets the `GdkDisplay` that @context is for. + - the display of @context + the display of @context - a `GdkAppLaunchContext` + a `GdkAppLaunchContext` - - Sets the workspace on which applications will be launched. + + Sets the workspace on which applications will be launched. This only works when running under a window manager that supports multiple workspaces, as described in the @@ -114,44 +195,62 @@ supports multiple workspaces, as described in the When the workspace is not specified or @desktop is set to -1, it is up to the window manager to pick one, typically it will be the current workspace. + - a `GdkAppLaunchContext` + a `GdkAppLaunchContext` - the number of a workspace, or -1 + the number of a workspace, or -1 - Sets the icon for applications that are launched with this + Sets the icon for applications that are launched with this context. Window Managers can use this information when displaying startup notification. See also [method@Gdk.AppLaunchContext.set_icon_name]. + - a `GdkAppLaunchContext` + a `GdkAppLaunchContext` - - a `GIcon` + + a `GIcon` - - Sets the icon for applications that are launched with this context. + + Sets the icon for applications that are launched with this context. The @icon_name will be interpreted in the same way as the Icon field in desktop files. See also [method@Gdk.AppLaunchContext.set_icon]. @@ -160,22 +259,33 @@ If both @icon and @icon_name are set, the @icon_name takes priority. If neither @icon or @icon_name is set, the icon is taken from either the file that is passed to launched application or from the `GAppInfo` for the launched application itself. + - a `GdkAppLaunchContext` + a `GdkAppLaunchContext` - - an icon name + + an icon name - - Sets the timestamp of @context. + + Sets the timestamp of @context. The timestamp should ideally be taken from the event that triggered the launch. @@ -184,199 +294,388 @@ Window managers can use this information to avoid moving the focus to the newly launched application when the user is busy typing in another window. This is also known as 'focus stealing prevention'. + - a `GdkAppLaunchContext` + a `GdkAppLaunchContext` - a timestamp + a timestamp - - - The display that the `GdkAppLaunchContext` is on. + + + The display that the `GdkAppLaunchContext` is on. - - Flags describing the current capabilities of a device/tool. + + Flags describing the current capabilities of a device/tool. - X axis is present + X axis is present - Y axis is present + Y axis is present - - Scroll X delta axis is present + + Scroll X delta axis is present - - Scroll Y delta axis is present + + Scroll Y delta axis is present - - Pressure axis is present + + Pressure axis is present - - X tilt axis is present + + X tilt axis is present - - Y tilt axis is present + + Y tilt axis is present - - Wheel axis is present + + Wheel axis is present - - Distance axis is present + + Distance axis is present - - Z-axis rotation is present + + Z-axis rotation is present - - Slider axis is present + + Slider axis is present - - Defines how device axes are interpreted by GTK. + + Defines how device axes are interpreted by GTK. Note that the X and Y axes are not really needed; pointer devices report their location via the x/y members of events regardless. Whether X and Y are present as axes depends on the GDK backend. - - the axis is ignored. + + the axis is ignored. - the axis is used as the x axis. + the axis is used as the x axis. - the axis is used as the y axis. + the axis is used as the y axis. - - the axis is used as the scroll x delta + + the axis is used as the scroll x delta - - the axis is used as the scroll y delta + + the axis is used as the scroll y delta - - the axis is used for pressure information. + + the axis is used for pressure information. - - the axis is used for x tilt information. + + the axis is used for x tilt information. - - the axis is used for y tilt information. + + the axis is used for y tilt information. - - the axis is used for wheel information. + + the axis is used for wheel information. - - the axis is used for pen/tablet distance information + + the axis is used for pen/tablet distance information - - the axis is used for pen rotation information + + the axis is used for pen rotation information - - the axis is used for pen slider information + + the axis is used for pen slider information - - a constant equal to the numerically highest axis value. + + a constant equal to the numerically highest axis value. - The middle button. + The middle button. + - The primary button. This is typically the left mouse button, or the + The primary button. This is typically the left mouse button, or the right button in a left-handed setup. + - The secondary button. This is typically the right mouse button, or the + The secondary button. This is typically the right mouse button, or the left button in a left-handed setup. + - - An event related to a button on a pointer device. + + An event related to a button on a pointer device. - Extract the button number from a button event. + Extract the button number from a button event. + - the button of @event + the button of @event - a button event + a button event - + + - + + - + + - + + - + + - + + - + + - Represents the current time, and can be used anywhere a time is expected. + Represents the current time, and can be used anywhere a time is expected. + + - - `GdkCairoContext` is an object representing the platform-specific + + `GdkCairoContext` is an object representing the platform-specific draw context. `GdkCairoContext`s are created for a surface using [method@Gdk.Surface.create_cairo_context], and the context can then be used to draw on that surface. - - Retrieves a Cairo context to be used to draw on the `GdkSurface` + + Retrieves a Cairo context to be used to draw on the `GdkSurface` of @context. A call to [method@Gdk.DrawContext.begin_frame] with this @@ -384,21 +683,33 @@ A call to [method@Gdk.DrawContext.begin_frame] with this The returned context is guaranteed to be valid until [method@Gdk.DrawContext.end_frame] is called. + - a Cairo context + a Cairo context to draw on `GdkSurface - a `GdkCairoContext` that is currently drawing + a `GdkCairoContext` that is currently drawing - - The `GdkClipboard` object represents data shared between applications or + + The `GdkClipboard` object represents data shared between applications or inside an application. To get a `GdkClipboard` object, use [method@Gdk.Display.get_clipboard] or @@ -417,72 +728,102 @@ To read textual or image data from a clipboard, use [method@Gdk.Clipboard.read_async], which provides a `GInputStream` object. - Returns the `GdkContentProvider` currently set on @clipboard. + Returns the `GdkContentProvider` currently set on @clipboard. If the @clipboard is empty or its contents are not owned by the current process, %NULL will be returned. + - The content of a clipboard + The content of a clipboard if the clipboard does not maintain any content - a `GdkClipboard` + a `GdkClipboard` - Gets the `GdkDisplay` that the clipboard was created for. + Gets the `GdkDisplay` that the clipboard was created for. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkClipboard` + a `GdkClipboard` - Gets the formats that the clipboard can provide its current contents in. + Gets the formats that the clipboard can provide its current contents in. + - The formats of the clipboard + The formats of the clipboard - a `GdkClipboard` + a `GdkClipboard` - Returns if the clipboard is local. + Returns if the clipboard is local. A clipboard is considered local if it was last claimed by the running application. Note that [method@Gdk.Clipboard.get_content] may return %NULL even on a local clipboard. In this case the clipboard is empty. + - %TRUE if the clipboard is local + %TRUE if the clipboard is local - a `GdkClipboard` + a `GdkClipboard` - Asynchronously requests an input stream to read the @clipboard's + Asynchronously requests an input stream to read the @clipboard's contents from. When the operation is finished @callback will be called. You must then @@ -490,64 +831,109 @@ call [method@Gdk.Clipboard.read_finish] to get the result of the operation. The clipboard will choose the most suitable mime type from the given list to fulfill the request, preferring the ones listed first. + - a `GdkClipboard` + a `GdkClipboard` - a %NULL-terminated array of mime types to choose from + a %NULL-terminated array of mime types to choose from - the I/O priority of the request + the I/O priority of the request - - optional `GCancellable` object + + optional `GCancellable` object - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous clipboard read. + + Finishes an asynchronous clipboard read. See [method@Gdk.Clipboard.read_async]. + - a `GInputStream` + a `GInputStream` - a `GdkClipboard` + a `GdkClipboard` - a `GAsyncResult` + a `GAsyncResult` - - location to store + + location to store the chosen mime type - - Asynchronously request the @clipboard contents converted to a string. + + Asynchronously request the @clipboard contents converted to a string. When the operation is finished @callback will be called. You must then call [method@Gdk.Clipboard.read_text_finish] to get the result. @@ -555,49 +941,83 @@ call [method@Gdk.Clipboard.read_text_finish] to get the result. This is a simple wrapper around [method@Gdk.Clipboard.read_value_async]. Use that function or [method@Gdk.Clipboard.read_async] directly if you need more control over the operation. + - a `GdkClipboard` + a `GdkClipboard` - - optional `GCancellable` object + + optional `GCancellable` object - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous clipboard read. + + Finishes an asynchronous clipboard read. See [method@Gdk.Clipboard.read_text_async]. + - a new string + a new string - a `GdkClipboard` + a `GdkClipboard` - a `GAsyncResult` + a `GAsyncResult` - - Asynchronously request the @clipboard contents converted to a `GdkPixbuf`. + + Asynchronously request the @clipboard contents converted to a `GdkPixbuf`. When the operation is finished @callback will be called. You must then call [method@Gdk.Clipboard.read_texture_finish] to get the result. @@ -605,49 +1025,83 @@ call [method@Gdk.Clipboard.read_texture_finish] to get the result. This is a simple wrapper around [method@Gdk.Clipboard.read_value_async]. Use that function or [method@Gdk.Clipboard.read_async] directly if you need more control over the operation. + - a `GdkClipboard` + a `GdkClipboard` - - optional `GCancellable` object, %NULL to ignore. + + optional `GCancellable` object, %NULL to ignore. - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous clipboard read. + + Finishes an asynchronous clipboard read. See [method@Gdk.Clipboard.read_texture_async]. + - a new `GdkTexture` + a new `GdkTexture` - a `GdkClipboard` + a `GdkClipboard` - a `GAsyncResult` + a `GAsyncResult` - - Asynchronously request the @clipboard contents converted to the given + + Asynchronously request the @clipboard contents converted to the given @type. When the operation is finished @callback will be called. You must then call @@ -656,81 +1110,130 @@ When the operation is finished @callback will be called. You must then call For local clipboard contents that are available in the given `GType`, the value will be copied directly. Otherwise, GDK will try to use [func@content_deserialize_async] to convert the clipboard's data. + - a `GdkClipboard` + a `GdkClipboard` - a `GType` to read + a `GType` to read - the I/O priority of the request + the I/O priority of the request - - optional `GCancellable` object + + optional `GCancellable` object - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous clipboard read. + + Finishes an asynchronous clipboard read. See [method@Gdk.Clipboard.read_value_async]. + - a `GValue` containing the result. + a `GValue` containing the result. - a `GdkClipboard` + a `GdkClipboard` - a `GAsyncResult` + a `GAsyncResult` - - Sets the clipboard to contain the value collected from the given varargs. + + Sets the clipboard to contain the value collected from the given varargs. ```c gdk_clipboard_set (clipboard, GTK_TYPE_TEXT_BUFFER, buffer); ``` + - a `GdkClipboard` + a `GdkClipboard` - type of value to set + type of value to set - value contents conforming to @type + value contents conforming to @type - Sets a new content provider on @clipboard. + Sets a new content provider on @clipboard. The clipboard will claim the `GdkDisplay`'s resources and advertise these new contents to other applications. @@ -742,92 +1245,142 @@ clipboard will then continue reporting its old contents and ignore If the contents are read by either an external application or the @clipboard's read functions, @clipboard will select the best format to transfer the contents and then request that format from @provider. + - %TRUE if setting the clipboard succeeded + %TRUE if setting the clipboard succeeded - a `GdkClipboard` + a `GdkClipboard` - - the new contents of @clipboard + + the new contents of @clipboard or %NULL to clear the clipboard - - Puts the given @text into the clipboard. + + Puts the given @text into the clipboard. + - a `GdkClipboard` + a `GdkClipboard` - Text to put into the clipboard + Text to put into the clipboard - - Puts the given @texture into the clipboard. + + Puts the given @texture into the clipboard. + - a `GdkClipboard` + a `GdkClipboard` - a `GdkTexture` to put into the clipboard + a `GdkTexture` to put into the clipboard - - Sets the clipboard to contain the value collected from the given @args. + + Sets the clipboard to contain the value collected from the given @args. + - a `GdkClipboard` + a `GdkClipboard` - type of value to set + type of value to set - varargs containing the value of @type + varargs containing the value of @type - - Sets the @clipboard to contain the given @value. + + Sets the @clipboard to contain the given @value. + - a `GdkClipboard` + a `GdkClipboard` - a `GValue` to set + a `GValue` to set - Asynchronously instructs the @clipboard to store its contents remotely. + Asynchronously instructs the @clipboard to store its contents remotely. If the clipboard is not local, this function does nothing but report success. @@ -840,97 +1393,158 @@ unless a "clipboard manager" is running. This function is called automatically when a [class@Gtk.Application] is shut down, so you likely don't need to call it. + - a `GdkClipboard` + a `GdkClipboard` - the I/O priority of the request + the I/O priority of the request - - optional `GCancellable` object + + optional `GCancellable` object - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous clipboard store. + + Finishes an asynchronous clipboard store. See [method@Gdk.Clipboard.store_async]. + - %TRUE if storing was successful. + %TRUE if storing was successful. - a `GdkClipboard` + a `GdkClipboard` - a `GAsyncResult` + a `GAsyncResult` - - The `GdkContentProvider` or %NULL if the clipboard is empty or contents are + + The `GdkContentProvider` or %NULL if the clipboard is empty or contents are provided otherwise. - - - The `GdkDisplay` that the clipboard belongs to. + + + The `GdkDisplay` that the clipboard belongs to. - - The possible formats that the clipboard can provide its data in. + + The possible formats that the clipboard can provide its data in. - %TRUE if the contents of the clipboard are owned by this process. + %TRUE if the contents of the clipboard are owned by this process. - Emitted when the clipboard changes ownership. + Emitted when the clipboard changes ownership. - The type of a function that can be registered with gdk_content_register_deserializer(). + The type of a function that can be registered with gdk_content_register_deserializer(). When the function gets called to operate on content, it can call functions on the @deserializer object to obtain the mime type, input stream, user data, etc. for its operation. + - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - A `GdkContentDeserializer` is used to deserialize content received via + + A `GdkContentDeserializer` is used to deserialize content received via inter-application data transfers. The `GdkContentDeserializer` transforms serialized content that is @@ -942,171 +1556,268 @@ deserialization functions, use [func@content_register_deserializer]. Also see [class@Gdk.ContentSerializer]. - - Gets the cancellable for the current operation. + + Gets the cancellable for the current operation. This is the `GCancellable` that was passed to [func@Gdk.content_deserialize_async]. + - the cancellable for the current operation + the cancellable for the current operation - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the `GType` to create an instance of. + + Gets the `GType` to create an instance of. + - the `GType` for the current operation + the `GType` for the current operation - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the input stream for the current operation. + + Gets the input stream for the current operation. This is the stream that was passed to [func@Gdk.content_deserialize_async]. + - the input stream for the current operation + the input stream for the current operation - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the mime type to deserialize from. + + Gets the mime type to deserialize from. + - the mime type for the current operation + the mime type for the current operation - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the I/O priority for the current operation. + + Gets the I/O priority for the current operation. This is the priority that was passed to [func@Gdk.content_deserialize_async]. + - the I/O priority for the current operation + the I/O priority for the current operation - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the data that was associated with the current operation. + + Gets the data that was associated with the current operation. See [method@Gdk.ContentDeserializer.set_task_data]. + - the task data for @deserializer + the task data for @deserializer - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the user data that was passed when the deserializer was registered. + + Gets the user data that was passed when the deserializer was registered. + - the user data for this deserializer + the user data for this deserializer - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Gets the `GValue` to store the deserialized object in. + + Gets the `GValue` to store the deserialized object in. + - the `GValue` for the current operation + the `GValue` for the current operation - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Indicate that the deserialization has ended with an error. + + Indicate that the deserialization has ended with an error. This function consumes @error. + - a `GdkContentDeserializer` + a `GdkContentDeserializer` - a `GError` + a `GError` - - Indicate that the deserialization has been successfully completed. + + Indicate that the deserialization has been successfully completed. + - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - Associate data with the current deserialization operation. + + Associate data with the current deserialization operation. + - a `GdkContentDeserializer` + a `GdkContentDeserializer` - - data to associate with this operation + + data to associate with this operation - destroy notify for @data + destroy notify for @data - - The `GdkContentFormats` structure is used to advertise and negotiate the + + The `GdkContentFormats` structure is used to advertise and negotiate the format of content. You will encounter `GdkContentFormats` when interacting with objects @@ -1138,84 +1849,130 @@ to least important. the types it represents. Instead, new `GdkContentFormats` have to be created. The [struct@Gdk.ContentFormatsBuilder] structure is meant to help in this endeavor. + - Creates a new `GdkContentFormats` from an array of mime types. + Creates a new `GdkContentFormats` from an array of mime types. The mime types must be valid and different from each other or the behavior of the return value is undefined. If you cannot guarantee this, use [struct@Gdk.ContentFormatsBuilder] instead. + - the new `GdkContentFormats`. + the new `GdkContentFormats`. - - Pointer to an + + Pointer to an array of mime types - number of entries in @mime_types. + number of entries in @mime_types. - - Creates a new `GdkContentFormats` for a given `GType`. + + Creates a new `GdkContentFormats` for a given `GType`. + - a new `GdkContentFormats` + a new `GdkContentFormats` - a `GType` + a `GType` - - Checks if a given `GType` is part of the given @formats. + + Checks if a given `GType` is part of the given @formats. + - %TRUE if the `GType` was found + %TRUE if the `GType` was found - a `GdkContentFormats` + a `GdkContentFormats` - the `GType` to search for + the `GType` to search for - - Checks if a given mime type is part of the given @formats. + + Checks if a given mime type is part of the given @formats. + - %TRUE if the mime_type was found + %TRUE if the mime_type was found - a `GdkContentFormats` + a `GdkContentFormats` - the mime type to search for + the mime type to search for - Gets the `GType`s included in @formats. + Gets the `GType`s included in @formats. Note that @formats may not contain any `GType`s, in particular when they are empty. In that case %NULL will be returned. + - + %G_TYPE_INVALID-terminated array of types included in @formats @@ -1223,23 +1980,38 @@ they are empty. In that case %NULL will be returned. - a `GdkContentFormats` + a `GdkContentFormats` - - optional pointer to take the + + optional pointer to take the number of `GType`s contained in the return value - - Gets the mime types included in @formats. + + Gets the mime types included in @formats. Note that @formats may not contain any mime types, in particular when they are empty. In that case %NULL will be returned. + - + %NULL-terminated array of interned strings of mime types included in @formats @@ -1248,213 +2020,322 @@ when they are empty. In that case %NULL will be returned. - a `GdkContentFormats` + a `GdkContentFormats` - - optional pointer to take the + + optional pointer to take the number of mime types contained in the return value - Checks if @first and @second have any matching formats. + Checks if @first and @second have any matching formats. + - %TRUE if a matching format was found. + %TRUE if a matching format was found. - the primary `GdkContentFormats` to intersect + the primary `GdkContentFormats` to intersect - the `GdkContentFormats` to intersect with + the `GdkContentFormats` to intersect with - - Finds the first `GType` from @first that is also contained + + Finds the first `GType` from @first that is also contained in @second. If no matching `GType` is found, %G_TYPE_INVALID is returned. + - The first common `GType` or %G_TYPE_INVALID if none. + The first common `GType` or %G_TYPE_INVALID if none. - the primary `GdkContentFormats` to intersect + the primary `GdkContentFormats` to intersect - the `GdkContentFormats` to intersect with + the `GdkContentFormats` to intersect with - - Finds the first mime type from @first that is also contained + + Finds the first mime type from @first that is also contained in @second. If no matching mime type is found, %NULL is returned. + - The first common mime type or %NULL if none + The first common mime type or %NULL if none - the primary `GdkContentFormats` to intersect + the primary `GdkContentFormats` to intersect - the `GdkContentFormats` to intersect with + the `GdkContentFormats` to intersect with - Prints the given @formats into a string for human consumption. + Prints the given @formats into a string for human consumption. The result of this function can later be parsed with [func@Gdk.ContentFormats.parse]. + - a `GdkContentFormats` + a `GdkContentFormats` - a `GString` to print into + a `GString` to print into - Increases the reference count of a `GdkContentFormats` by one. + Increases the reference count of a `GdkContentFormats` by one. + - the passed in `GdkContentFormats`. + the passed in `GdkContentFormats`. - a `GdkContentFormats` + a `GdkContentFormats` - Prints the given @formats into a human-readable string. + Prints the given @formats into a human-readable string. The resulting string can be parsed with [func@Gdk.ContentFormats.parse]. This is a small wrapper around [method@Gdk.ContentFormats.print] to help when debugging. + - a new string + a new string - a `GdkContentFormats` + a `GdkContentFormats` - Append all missing types from @second to @first, in the order + Append all missing types from @second to @first, in the order they had in @second. + - a new `GdkContentFormats` + a new `GdkContentFormats` - the `GdkContentFormats` to merge into + the `GdkContentFormats` to merge into - the `GdkContentFormats` to merge from + the `GdkContentFormats` to merge from - - Add GTypes for mime types in @formats for which deserializers are + + Add GTypes for mime types in @formats for which deserializers are registered. + - a new `GdkContentFormats` + a new `GdkContentFormats` - a `GdkContentFormats` + a `GdkContentFormats` - - Add mime types for GTypes in @formats for which deserializers are + + Add mime types for GTypes in @formats for which deserializers are registered. + - a new `GdkContentFormats` + a new `GdkContentFormats` - a `GdkContentFormats` + a `GdkContentFormats` - - Add GTypes for the mime types in @formats for which serializers are + + Add GTypes for the mime types in @formats for which serializers are registered. + - a new `GdkContentFormats` + a new `GdkContentFormats` - a `GdkContentFormats` + a `GdkContentFormats` - - Add mime types for GTypes in @formats for which serializers are + + Add mime types for GTypes in @formats for which serializers are registered. + - a new `GdkContentFormats` + a new `GdkContentFormats` - a `GdkContentFormats` + a `GdkContentFormats` - Decreases the reference count of a `GdkContentFormats` by one. + Decreases the reference count of a `GdkContentFormats` by one. If the resulting reference count is zero, frees the formats. + - a `GdkContentFormats` + a `GdkContentFormats` - - Parses the given @string into `GdkContentFormats` and + + Parses the given @string into `GdkContentFormats` and returns the formats. Strings printed via [method@Gdk.ContentFormats.to_string] @@ -1462,147 +2343,234 @@ can be read in again successfully using this function. If @string does not describe valid content formats, %NULL is returned. + - the content formats if @string is valid + the content formats if @string is valid - the string to parse + the string to parse - - A `GdkContentFormatsBuilder` is an auxiliary struct used to create + + A `GdkContentFormatsBuilder` is an auxiliary struct used to create new `GdkContentFormats`, and should not be kept around. + - Create a new `GdkContentFormatsBuilder` object. + Create a new `GdkContentFormatsBuilder` object. The resulting builder would create an empty `GdkContentFormats`. Use addition functions to add types to it. + - a new `GdkContentFormatsBuilder` - + a new `GdkContentFormatsBuilder` + - - Appends all formats from @formats to @builder, skipping those that + + Appends all formats from @formats to @builder, skipping those that already exist. + - a `GdkContentFormatsBuilder` - + a `GdkContentFormatsBuilder` + - the formats to add + the formats to add - - Appends @type to @builder if it has not already been added. + + Appends @type to @builder if it has not already been added. + - a `GdkContentFormats`Builder - + a `GdkContentFormats`Builder + - a `GType` + a `GType` - - Appends @mime_type to @builder if it has not already been added. + + Appends @mime_type to @builder if it has not already been added. + - a `GdkContentFormatsBuilder` - + a `GdkContentFormatsBuilder` + - a mime type + a mime type - - Creates a new `GdkContentFormats` from the current state of the + + Creates a new `GdkContentFormats` from the current state of the given @builder, and frees the @builder instance. + - the newly created `GdkContentFormats` + the newly created `GdkContentFormats` with all the formats added to @builder - a `GdkContentFormatsBuilder` - + a `GdkContentFormatsBuilder` + - Acquires a reference on the given @builder. + Acquires a reference on the given @builder. This function is intended primarily for bindings. `GdkContentFormatsBuilder` objects should not be kept around. + - the given `GdkContentFormatsBuilder` + the given `GdkContentFormatsBuilder` with its reference count increased - + - a `GdkContentFormatsBuilder` - + a `GdkContentFormatsBuilder` + - - Creates a new `GdkContentFormats` from the given @builder. + + Creates a new `GdkContentFormats` from the given @builder. The given `GdkContentFormatsBuilder` is reset once this function returns; you cannot call this function multiple times on the same @builder instance. This function is intended primarily for bindings. C code should use [method@Gdk.ContentFormatsBuilder.free_to_formats]. + - the newly created `GdkContentFormats` + the newly created `GdkContentFormats` with all the formats added to @builder - a `GdkContentFormats`Builder - + a `GdkContentFormats`Builder + - Releases a reference on the given @builder. + Releases a reference on the given @builder. + - a `GdkContentFormatsBuilder` - + a `GdkContentFormatsBuilder` + - - A `GdkContentProvider` is used to provide content for the clipboard or + + A `GdkContentProvider` is used to provide content for the clipboard or for drag-and-drop operations in a number of formats. To create a `GdkContentProvider`, use [ctor@Gdk.ContentProvider.new_for_value] @@ -1611,60 +2579,93 @@ or [ctor@Gdk.ContentProvider.new_for_bytes]. GDK knows how to handle common text and image formats out-of-the-box. See [class@Gdk.ContentSerializer] and [class@Gdk.ContentDeserializer] if you want to add support for application-specific data formats. - - Create a content provider that provides the given @bytes as data for + + + Create a content provider that provides the given @bytes as data for the given @mime_type. + - a new `GdkContentProvider` + a new `GdkContentProvider` - the mime type + the mime type - a `GBytes` with the data for @mime_type + a `GBytes` with the data for @mime_type - - Create a content provider that provides the given @value. + + Create a content provider that provides the given @value. + - a new `GdkContentProvider` + a new `GdkContentProvider` - a `GValue` + a `GValue` - - Create a content provider that provides the value of the given + + Create a content provider that provides the value of the given @type. The value is provided using G_VALUE_COLLECT(), so the same rules apply as when calling g_object_new() or g_object_set(). + - a new `GdkContentProvider` + a new `GdkContentProvider` - Type of value to follow + Type of value to follow - value + value - - Creates a content provider that represents all the given @providers. + + Creates a content provider that represents all the given @providers. Whenever data needs to be written, the union provider will try the given @providers in the given order and the first one supporting a format will @@ -1679,25 +2680,38 @@ gdk_content_provider_new_union ((GdkContentProvider *[2]) { gdk_content_provider_new_typed (G_TYPE_TEXTURE, texture) }, 2); ``` + - a new `GdkContentProvider` + a new `GdkContentProvider` - - + + The `GdkContentProvider`s to present the union of - + - the number of providers + the number of providers + @@ -1711,18 +2725,24 @@ gdk_content_provider_new_union ((GdkContentProvider *[2]) { - Emits the ::content-changed signal. + Emits the ::content-changed signal. + - a `GdkContentProvider` + a `GdkContentProvider` + @@ -1736,64 +2756,92 @@ gdk_content_provider_new_union ((GdkContentProvider *[2]) { - Gets the contents of @provider stored in @value. + Gets the contents of @provider stored in @value. The @value will have been initialized to the `GType` the value should be provided in. This given `GType` does not need to be listed in the formats returned by [method@Gdk.ContentProvider.ref_formats]. However, if the given `GType` is not supported, this operation can fail and `G_IO_ERROR_NOT_SUPPORTED` will be reported. + - %TRUE if the value was set successfully. Otherwise + %TRUE if the value was set successfully. Otherwise @error will be set to describe the failure. - a `GdkContentProvider` + a `GdkContentProvider` - the `GValue` to fill + the `GValue` to fill - Gets the formats that the provider can provide its current contents in. + Gets the formats that the provider can provide its current contents in. + - The formats of the provider + The formats of the provider - a `GdkContentProvider` + a `GdkContentProvider` - - - Gets the formats that the provider suggests other applications to store + + + Gets the formats that the provider suggests other applications to store the data in. An example of such an application would be a clipboard manager. This can be assumed to be a subset of [method@Gdk.ContentProvider.ref_formats]. + - The storable formats of the provider + The storable formats of the provider - a `GdkContentProvider` + a `GdkContentProvider` - - Asynchronously writes the contents of @provider to @stream in the given + + Asynchronously writes the contents of @provider to @stream in the given @mime_type. When the operation is finished @callback will be called. You must then call @@ -1805,131 +2853,206 @@ The given mime type does not need to be listed in the formats returned by not supported, `G_IO_ERROR_NOT_SUPPORTED` will be reported. The given @stream will not be closed. + - a `GdkContentProvider` + a `GdkContentProvider` - the mime type to provide the data in + the mime type to provide the data in - the `GOutputStream` to write to + the `GOutputStream` to write to - I/O priority of the request. + I/O priority of the request. - - optional `GCancellable` object, %NULL to ignore. + + optional `GCancellable` object, %NULL to ignore. - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous write operation. + + Finishes an asynchronous write operation. See [method@Gdk.ContentProvider.write_mime_type_async]. + - %TRUE if the operation was completed successfully. Otherwise + %TRUE if the operation was completed successfully. Otherwise @error will be set to describe the failure. - a `GdkContentProvider` + a `GdkContentProvider` - a `GAsyncResult` + a `GAsyncResult` - - Emits the ::content-changed signal. + + Emits the ::content-changed signal. + - a `GdkContentProvider` + a `GdkContentProvider` - - Gets the contents of @provider stored in @value. + + Gets the contents of @provider stored in @value. The @value will have been initialized to the `GType` the value should be provided in. This given `GType` does not need to be listed in the formats returned by [method@Gdk.ContentProvider.ref_formats]. However, if the given `GType` is not supported, this operation can fail and `G_IO_ERROR_NOT_SUPPORTED` will be reported. + - %TRUE if the value was set successfully. Otherwise + %TRUE if the value was set successfully. Otherwise @error will be set to describe the failure. - a `GdkContentProvider` + a `GdkContentProvider` - the `GValue` to fill + the `GValue` to fill - + - Gets the formats that the provider can provide its current contents in. + Gets the formats that the provider can provide its current contents in. + - The formats of the provider + The formats of the provider - a `GdkContentProvider` + a `GdkContentProvider` - - - Gets the formats that the provider suggests other applications to store + + + Gets the formats that the provider suggests other applications to store the data in. An example of such an application would be a clipboard manager. This can be assumed to be a subset of [method@Gdk.ContentProvider.ref_formats]. + - The storable formats of the provider + The storable formats of the provider - a `GdkContentProvider` + a `GdkContentProvider` - - Asynchronously writes the contents of @provider to @stream in the given + + Asynchronously writes the contents of @provider to @stream in the given @mime_type. When the operation is finished @callback will be called. You must then call @@ -1941,93 +3064,146 @@ The given mime type does not need to be listed in the formats returned by not supported, `G_IO_ERROR_NOT_SUPPORTED` will be reported. The given @stream will not be closed. + - a `GdkContentProvider` + a `GdkContentProvider` - the mime type to provide the data in + the mime type to provide the data in - the `GOutputStream` to write to + the `GOutputStream` to write to - I/O priority of the request. + I/O priority of the request. - - optional `GCancellable` object, %NULL to ignore. + + optional `GCancellable` object, %NULL to ignore. - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an asynchronous write operation. + + Finishes an asynchronous write operation. See [method@Gdk.ContentProvider.write_mime_type_async]. + - %TRUE if the operation was completed successfully. Otherwise + %TRUE if the operation was completed successfully. Otherwise @error will be set to describe the failure. - a `GdkContentProvider` + a `GdkContentProvider` - a `GAsyncResult` + a `GAsyncResult` - - The possible formats that the provider can provide its data in. + + The possible formats that the provider can provide its data in. - - The subset of formats that clipboard managers should store this provider's data in. + + The subset of formats that clipboard managers should store this provider's data in. - Emitted whenever the content provided by this provider has changed. + Emitted whenever the content provided by this provider has changed. - - Class structure for `GdkContentProvider`. + + Class structure for `GdkContentProvider`. + + - a `GdkContentProvider` + a `GdkContentProvider` @@ -2035,6 +3211,7 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + @@ -2050,6 +3227,7 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + @@ -2065,13 +3243,18 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + - The formats of the provider + The formats of the provider - a `GdkContentProvider` + a `GdkContentProvider` @@ -2079,13 +3262,18 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + - The storable formats of the provider + The storable formats of the provider - a `GdkContentProvider` + a `GdkContentProvider` @@ -2093,36 +3281,64 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + - a `GdkContentProvider` + a `GdkContentProvider` - the mime type to provide the data in + the mime type to provide the data in - the `GOutputStream` to write to + the `GOutputStream` to write to - I/O priority of the request. + I/O priority of the request. - - optional `GCancellable` object, %NULL to ignore. + + optional `GCancellable` object, %NULL to ignore. - - callback to call when the request is satisfied - + + callback to call when the request is satisfied + - - the data to pass to callback function + + the data to pass to callback function @@ -2130,18 +3346,25 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + - %TRUE if the operation was completed successfully. Otherwise + %TRUE if the operation was completed successfully. Otherwise @error will be set to describe the failure. - a `GdkContentProvider` + a `GdkContentProvider` - a `GAsyncResult` + a `GAsyncResult` @@ -2149,18 +3372,25 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. + - %TRUE if the value was set successfully. Otherwise + %TRUE if the value was set successfully. Otherwise @error will be set to describe the failure. - a `GdkContentProvider` + a `GdkContentProvider` - the `GValue` to fill + the `GValue` to fill @@ -2173,23 +3403,35 @@ See [method@Gdk.ContentProvider.write_mime_type_async]. - The type of a function that can be registered with gdk_content_register_serializer(). + The type of a function that can be registered with gdk_content_register_serializer(). When the function gets called to operate on content, it can call functions on the @serializer object to obtain the mime type, output stream, user data, etc. for its operation. + - a `GdkContentSerializer` + a `GdkContentSerializer` - - A `GdkContentSerializer` is used to serialize content for + + A `GdkContentSerializer` is used to serialize content for inter-application data transfers. The `GdkContentSerializer` transforms an object that is identified @@ -2202,248 +3444,423 @@ serialization functions, use [func@Gdk.content_register_serializer]. Also see [class@Gdk.ContentDeserializer]. - - Gets the cancellable for the current operation. + + Gets the cancellable for the current operation. This is the `GCancellable` that was passed to [func@content_serialize_async]. + - the cancellable for the current operation + the cancellable for the current operation - a `GdkContentSerializer` + a `GdkContentSerializer` - Gets the `GType` to of the object to serialize. + Gets the `GType` to of the object to serialize. + - the `GType` for the current operation + the `GType` for the current operation - a `GdkContentSerializer` + a `GdkContentSerializer` - - Gets the mime type to serialize to. + + Gets the mime type to serialize to. + - the mime type for the current operation + the mime type for the current operation - a `GdkContentSerializer` + a `GdkContentSerializer` - - Gets the output stream for the current operation. + + Gets the output stream for the current operation. This is the stream that was passed to [func@content_serialize_async]. + - the output stream for the current operation + the output stream for the current operation - a `GdkContentSerializer` + a `GdkContentSerializer` - - Gets the I/O priority for the current operation. + + Gets the I/O priority for the current operation. This is the priority that was passed to [func@content_serialize_async]. + - the I/O priority for the current operation + the I/O priority for the current operation - a `GdkContentSerializer` + a `GdkContentSerializer` - - Gets the data that was associated with the current operation. + + Gets the data that was associated with the current operation. See [method@Gdk.ContentSerializer.set_task_data]. + - the task data for @serializer + the task data for @serializer - a `GdkContentSerializer` + a `GdkContentSerializer` - - Gets the user data that was passed when the serializer was registered. + + Gets the user data that was passed when the serializer was registered. + - the user data for this serializer + the user data for this serializer - a `GdkContentSerializer` + a `GdkContentSerializer` - Gets the `GValue` to read the object to serialize from. + Gets the `GValue` to read the object to serialize from. + - the `GValue` for the current operation + the `GValue` for the current operation - a `GdkContentSerializer` + a `GdkContentSerializer` - - Indicate that the serialization has ended with an error. + + Indicate that the serialization has ended with an error. This function consumes @error. + - a `GdkContentSerializer` + a `GdkContentSerializer` - a `GError` + a `GError` - - Indicate that the serialization has been successfully completed. + + Indicate that the serialization has been successfully completed. + - a `GdkContentSerializer` + a `GdkContentSerializer` - - Associate data with the current serialization operation. + + Associate data with the current serialization operation. + - a `GdkContentSerializer` + a `GdkContentSerializer` - - data to associate with this operation + + data to associate with this operation - destroy notify for @data + destroy notify for @data - - An event caused by a pointing device moving between surfaces. + + An event caused by a pointing device moving between surfaces. - Extracts the notify detail from a crossing event. + Extracts the notify detail from a crossing event. + - the notify detail of @event + the notify detail of @event - a crossing event + a crossing event - Checks if the @event surface is the focus surface. + Checks if the @event surface is the focus surface. + - %TRUE if the surface is the focus surface + %TRUE if the surface is the focus surface - a crossing event + a crossing event - Extracts the crossing mode from a crossing event. + Extracts the crossing mode from a crossing event. + - the mode of @event + the mode of @event - a crossing event + a crossing event - - Specifies the crossing mode for enter and leave events. - - crossing because of pointer motion. + + Specifies the crossing mode for enter and leave events. + + crossing because of pointer motion. - - crossing because a grab is activated. + + crossing because a grab is activated. - - crossing because a grab is deactivated. + + crossing because a grab is deactivated. - - crossing because a GTK grab is activated. + + crossing because a GTK grab is activated. - - crossing because a GTK grab is deactivated. + + crossing because a GTK grab is deactivated. - - crossing because a GTK widget changed + + crossing because a GTK widget changed state (e.g. sensitivity). - - crossing because a touch sequence has begun, + + crossing because a touch sequence has begun, this event is synthetic as the pointer might have not left the surface. - - crossing because a touch sequence has ended, + + crossing because a touch sequence has ended, this event is synthetic as the pointer might have not left the surface. - - crossing because of a device switch (i.e. + + crossing because of a device switch (i.e. a mouse taking control of the pointer after a touch device), this event - is synthetic as the pointer didn’t leave the surface. + is synthetic as the pointer didn’t leave the surface. - - `GdkCursor` is used to create and destroy cursors. + + `GdkCursor` is used to create and destroy cursors. Cursors are immutable objects, so once you created them, there is no way to modify them later. You should create a new cursor when you want to change @@ -2477,8 +3894,11 @@ above, it will try the fallback cursor. Fallback cursors can themselves have fallback cursors again, so it is possible to provide a chain of progressively easier to support cursors. If none of the provided cursors can be supported, the default cursor will be the ultimate fallback. - - Creates a new cursor by looking up @name in the current cursor + + Creates a new cursor by looking up @name in the current cursor theme. A recommended set of cursor names that will work across different @@ -2495,44 +3915,71 @@ platforms can be found in the CSS specification: | ![](w_resize_cursor.png) "w-resize" | ![](ne_resize_cursor.png) "ne-resize" | ![](nw_resize_cursor.png) "nw-resize" | ![](sw_resize_cursor.png) "sw-resize" | | ![](se_resize_cursor.png) "se-resize" | ![](ew_resize_cursor.png) "ew-resize" | ![](ns_resize_cursor.png) "ns-resize" | ![](nesw_resize_cursor.png) "nesw-resize" | | ![](nwse_resize_cursor.png) "nwse-resize" | ![](zoom_in_cursor.png) "zoom-in" | ![](zoom_out_cursor.png) "zoom-out" | | + - a new `GdkCursor`, or %NULL if there is no + a new `GdkCursor`, or %NULL if there is no cursor with the given name - the name of the cursor + the name of the cursor - - %NULL or the `GdkCursor` to fall back to when + + %NULL or the `GdkCursor` to fall back to when this one cannot be supported - - Creates a new cursor from a `GdkTexture`. + + Creates a new cursor from a `GdkTexture`. + - a new `GdkCursor` + a new `GdkCursor` - the texture providing the pixel data + the texture providing the pixel data - the horizontal offset of the “hotspot” of the cursor + the horizontal offset of the “hotspot” of the cursor - the vertical offset of the “hotspot” of the cursor + the vertical offset of the “hotspot” of the cursor - - the `GdkCursor` to fall back to when + + the `GdkCursor` to fall back to when this one cannot be supported @@ -2540,128 +3987,194 @@ platforms can be found in the CSS specification: - Returns the fallback for this @cursor. + Returns the fallback for this @cursor. The fallback will be used if this cursor is not available on a given `GdkDisplay`. For named cursors, this can happen when using nonstandard names or when using an incomplete cursor theme. For textured cursors, this can happen when the texture is too large or when the `GdkDisplay` it is used on does not support textured cursors. + - the fallback of the cursor or %NULL + the fallback of the cursor or %NULL to use the default cursor as fallback - a `GdkCursor` + a `GdkCursor` - Returns the horizontal offset of the hotspot. + Returns the horizontal offset of the hotspot. The hotspot indicates the pixel that will be directly above the cursor. Note that named cursors may have a nonzero hotspot, but this function will only return the hotspot position for cursors created with [ctor@Gdk.Cursor.new_from_texture]. + - the horizontal offset of the hotspot or 0 for named cursors + the horizontal offset of the hotspot or 0 for named cursors - a `GdkCursor` + a `GdkCursor` - Returns the vertical offset of the hotspot. + Returns the vertical offset of the hotspot. The hotspot indicates the pixel that will be directly above the cursor. Note that named cursors may have a nonzero hotspot, but this function will only return the hotspot position for cursors created with [ctor@Gdk.Cursor.new_from_texture]. + - the vertical offset of the hotspot or 0 for named cursors + the vertical offset of the hotspot or 0 for named cursors - a `GdkCursor` + a `GdkCursor` - Returns the name of the cursor. + Returns the name of the cursor. If the cursor is not a named cursor, %NULL will be returned. + - the name of the cursor or %NULL + the name of the cursor or %NULL if it is not a named cursor - a `GdkCursor` + a `GdkCursor` - Returns the texture for the cursor. + Returns the texture for the cursor. If the cursor is a named cursor, %NULL will be returned. + - the texture for cursor or %NULL + the texture for cursor or %NULL if it is a named cursor - a `GdkCursor` + a `GdkCursor` - - - Cursor to fall back to if this cursor cannot be displayed. + + + Cursor to fall back to if this cursor cannot be displayed. - - - X position of the cursor hotspot in the cursor image. + + + X position of the cursor hotspot in the cursor image. - - - Y position of the cursor hotspot in the cursor image. + + + Y position of the cursor hotspot in the cursor image. - + - Name of this this cursor. + Name of this this cursor. The name will be %NULL if the cursor was created from a texture. - - The texture displayed by this cursor. + + The texture displayed by this cursor. The texture will be %NULL if the cursor was created from a name. - + + @@ -2676,328 +4189,506 @@ The texture will be %NULL if the cursor was created from a name. + - + + - + + - + + - + + - - An event related to drag and drop operations. + + An event related to drag and drop operations. - Gets the `GdkDrop` object from a DND event. + Gets the `GdkDrop` object from a DND event. + - the drop + the drop - a DND event + a DND event + - + + + - - An event related to closing a top-level surface. + + An event related to closing a top-level surface. - - The `GdkDevice` object represents an input device, such + + The `GdkDevice` object represents an input device, such as a keyboard, a mouse, or a touchpad. See the [class@Gdk.Seat] documentation for more information about the various kinds of devices, and their relationships. - + - Retrieves whether the Caps Lock modifier of the keyboard is locked. + Retrieves whether the Caps Lock modifier of the keyboard is locked. This is only relevant for keyboard devices. + - %TRUE if Caps Lock is on for @device + %TRUE if Caps Lock is on for @device - a `GdkDevice` + a `GdkDevice` - Retrieves the current tool for @device. + Retrieves the current tool for @device. + - the `GdkDeviceTool` + the `GdkDeviceTool` - a `GdkDevice` + a `GdkDevice` - Returns the direction of effective layout of the keyboard. + Returns the direction of effective layout of the keyboard. This is only relevant for keyboard devices. The direction of a layout is the direction of the majority of its symbols. See [func@Pango.unichar_direction]. + - %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL + %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL if it can determine the direction. %PANGO_DIRECTION_NEUTRAL otherwise - a `GdkDevice` + a `GdkDevice` - Returns the `GdkDisplay` to which @device pertains. + Returns the `GdkDisplay` to which @device pertains. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkDevice` + a `GdkDevice` - Determines whether the pointer follows device motion. + Determines whether the pointer follows device motion. This is not meaningful for keyboard devices, which don't have a pointer. + - %TRUE if the pointer follows device motion + %TRUE if the pointer follows device motion - a `GdkDevice` + a `GdkDevice` - + - Retrieves the current modifier state of the keyboard. + Retrieves the current modifier state of the keyboard. This is only relevant for keyboard devices. + - the current modifier state + the current modifier state - a `GdkDevice` + a `GdkDevice` - The name of the device, suitable for showing in a user interface. + The name of the device, suitable for showing in a user interface. + - a name + a name - a GdkDevice` + a GdkDevice` - + - Retrieves whether the Num Lock modifier of the keyboard is locked. + Retrieves whether the Num Lock modifier of the keyboard is locked. This is only relevant for keyboard devices. + - %TRUE if Num Lock is on for @device + %TRUE if Num Lock is on for @device - a ``GdkDevice` + a ``GdkDevice` - Retrieves the number of touch points associated to @device. + Retrieves the number of touch points associated to @device. + - the number of touch points + the number of touch points - a `GdkDevice` + a `GdkDevice` - Returns the product ID of this device. + Returns the product ID of this device. This ID is retrieved from the device, and does not change. See [method@Gdk.Device.get_vendor_id] for more information. + - the product ID + the product ID - a physical `GdkDevice` + a physical `GdkDevice` - - - Retrieves whether the Scroll Lock modifier of the keyboard is locked. + + + Retrieves whether the Scroll Lock modifier of the keyboard is locked. This is only relevant for keyboard devices. + - %TRUE if Scroll Lock is on for @device + %TRUE if Scroll Lock is on for @device - a `GdkDevice` + a `GdkDevice` - Returns the `GdkSeat` the device belongs to. + Returns the `GdkSeat` the device belongs to. + - a `GdkSeat` + a `GdkSeat` - A `GdkDevice` + A `GdkDevice` - Determines the type of the device. + Determines the type of the device. + - a `GdkInputSource` + a `GdkInputSource` - a `GdkDevice` + a `GdkDevice` - - Obtains the surface underneath @device, returning the location of the + + Obtains the surface underneath @device, returning the location of the device in @win_x and @win_y. Returns %NULL if the surface tree under @device is not known to GDK (for example, belongs to another application). + - the `GdkSurface` under the + the `GdkSurface` under the device position - pointer `GdkDevice` to query info to + pointer `GdkDevice` to query info to - - return location for the X coordinate + + return location for the X coordinate of the device location relative to the surface origin - - return location for the Y coordinate + + return location for the Y coordinate of the device location relative to the surface origin - - Returns the timestamp of the last activity for this device. + + Returns the timestamp of the last activity for this device. In practice, this means the timestamp of the last event that was received from the OS for this device. (GTK may occasionally produce events for a device that are not received from the OS, and will not update the timestamp). + - the timestamp of the last activity for this device + the timestamp of the last activity for this device - a `GdkDevice` + a `GdkDevice` - Returns the vendor ID of this device. + Returns the vendor ID of this device. This ID is retrieved from the device, and does not change. @@ -3024,134 +4715,214 @@ for this device. return settings; } ``` + - the vendor ID + the vendor ID - a physical `GdkDevice` + a physical `GdkDevice` - - - Determines if layouts for both right-to-left and + + + Determines if layouts for both right-to-left and left-to-right languages are in use on the keyboard. This is only relevant for keyboard devices. + - %TRUE if there are layouts with both directions, %FALSE otherwise + %TRUE if there are layouts with both directions, %FALSE otherwise - a `GdkDevice` + a `GdkDevice` - - Whether Caps Lock is on. + + Whether Caps Lock is on. This is only relevant for keyboard devices. - - The direction of the current layout. + + The direction of the current layout. This is only relevant for keyboard devices. - + - The `GdkDisplay` the `GdkDevice` pertains to. + The `GdkDisplay` the `GdkDevice` pertains to. - - Whether the device has both right-to-left and left-to-right layouts. + + Whether the device has both right-to-left and left-to-right layouts. This is only relevant for keyboard devices. - - - Whether the device is represented by a cursor on the screen. + + + Whether the device is represented by a cursor on the screen. - - The current modifier state of the device. + + The current modifier state of the device. This is only relevant for keyboard devices. - Number of axes in the device. + Number of axes in the device. - + - The device name. + The device name. - - Whether Num Lock is on. + + Whether Num Lock is on. This is only relevant for keyboard devices. - - - The maximal number of concurrent touches on a touch device. + + + The maximal number of concurrent touches on a touch device. Will be 0 if the device is not a touch device or if the number of touches is unknown. - - - Product ID of this device. + + + Product ID of this device. See [method@Gdk.Device.get_product_id]. - - Whether Scroll Lock is on. + + Whether Scroll Lock is on. This is only relevant for keyboard devices. - `GdkSeat` of this device. + `GdkSeat` of this device. - + - Source type for the device. + Source type for the device. - - The `GdkDeviceTool` that is currently used with this device. + + The `GdkDeviceTool` that is currently used with this device. - - - Vendor ID of this device. + + + Vendor ID of this device. See [method@Gdk.Device.get_vendor_id]. - Emitted either when the the number of either axes or keys changes. + Emitted either when the the number of either axes or keys changes. On X11 this will normally happen when the physical device routing events through the logical device changes (for @@ -3163,20 +4934,31 @@ and keys on the new physical device. - Emitted on pen/eraser devices whenever tools enter or leave proximity. + Emitted on pen/eraser devices whenever tools enter or leave proximity. - The new current tool + The new current tool - - `GdkDevicePad` is an interface implemented by devices of type + + `GdkDevicePad` is an interface implemented by devices of type %GDK_SOURCE_TABLET_PAD It allows querying the features provided by the pad device. @@ -3193,114 +4975,196 @@ individual pad feature to multiple actions. Only one mode is effective current modes. The number of available modes in a group can be found out through [method@Gdk.DevicePad.get_group_n_modes], and the current mode for a given group will be notified through events of type `GDK_PAD_GROUP_MODE`. + - - Returns the group the given @feature and @idx belong to. + + Returns the group the given @feature and @idx belong to. f the feature or index do not exist in @pad, -1 is returned. + - The group number of the queried pad feature. + The group number of the queried pad feature. - a `GdkDevicePad` + a `GdkDevicePad` - the feature type to get the group from + the feature type to get the group from - the index of the feature to get the group from + the index of the feature to get the group from - - Returns the number of modes that @group may have. + + Returns the number of modes that @group may have. + - The number of modes available in @group. + The number of modes available in @group. - a `GdkDevicePad` + a `GdkDevicePad` - group to get the number of available modes from + group to get the number of available modes from - - Returns the number of features a tablet pad has. + + Returns the number of features a tablet pad has. + - The amount of elements of type @feature that this pad has. + The amount of elements of type @feature that this pad has. - a `GdkDevicePad` + a `GdkDevicePad` - a pad feature + a pad feature - Returns the number of groups this pad device has. + Returns the number of groups this pad device has. Pads have at least one group. A pad group is a subcollection of buttons/strip/rings that is affected collectively by a same current mode. + - The number of button/ring/strip groups in the pad. + The number of button/ring/strip groups in the pad. - a `GdkDevicePad` + a `GdkDevicePad` - - A pad feature. - - a button + + A pad feature. + + a button - - a ring-shaped interactive area + + a ring-shaped interactive area - - a straight interactive area + + a straight interactive area - - - A physical tool associated to a `GdkDevice`. + + + + + A physical tool associated to a `GdkDevice`. - Gets the axes of the tool. + Gets the axes of the tool. + - the axes of @tool + the axes of @tool - a `GdkDeviceTool` + a `GdkDeviceTool` - + - Gets the hardware ID of this tool, or 0 if it's not known. + Gets the hardware ID of this tool, or 0 if it's not known. When non-zero, the identificator is unique for the given tool model, meaning that two identical tools will share the same @hardware_id, @@ -3311,101 +5175,197 @@ This is a more concrete (and device specific) method to identify a `GdkDeviceTool` than [method@Gdk.DeviceTool.get_tool_type], as a tablet may support multiple devices with the same `GdkDeviceToolType`, but different hardware identificators. + - The hardware identificator of this tool. + The hardware identificator of this tool. - a `GdkDeviceTool` + a `GdkDeviceTool` - Gets the serial number of this tool. + Gets the serial number of this tool. This value can be used to identify a physical tool (eg. a tablet pen) across program executions. + - The serial ID for this tool + The serial ID for this tool - a `GdkDeviceTool` + a `GdkDeviceTool` - + - Gets the `GdkDeviceToolType` of the tool. + Gets the `GdkDeviceToolType` of the tool. + - The physical type for this tool. This can be used to + The physical type for this tool. This can be used to figure out what sort of pen is being used, such as an airbrush or a pencil. - a `GdkDeviceTool` + a `GdkDeviceTool` - - - The axes of the tool. + + + The axes of the tool. - - - The hardware ID of the tool. + + + The hardware ID of the tool. - - - The serial number of the tool. + + + The serial number of the tool. - - - The type of the tool. + + + The type of the tool. - - Indicates the specific type of tool being used being a tablet. Such as an + + Indicates the specific type of tool being used being a tablet. Such as an airbrush, pencil, etc. - - Tool is of an unknown type. + + Tool is of an unknown type. - - Tool is a standard tablet stylus. + + Tool is a standard tablet stylus. - - Tool is standard tablet eraser. + + Tool is standard tablet eraser. - - Tool is a brush stylus. + + Tool is a brush stylus. - - Tool is a pencil stylus. + + Tool is a pencil stylus. - - Tool is an airbrush stylus. + + Tool is an airbrush stylus. - - Tool is a mouse. + + Tool is a mouse. - - Tool is a lens cursor. + + Tool is a lens cursor. - - `GdkDisplay` objects are the GDK representation of a workstation. + + `GdkDisplay` objects are the GDK representation of a workstation. Their purpose are two-fold: @@ -3420,77 +5380,111 @@ can be accessed with [method@Gdk.Display.get_default_seat] and Output devices are represented by [class@Gdk.Monitor] objects, which can be accessed with [method@Gdk.Display.get_monitor_at_surface] and similar APIs. - Gets the default `GdkDisplay`. + Gets the default `GdkDisplay`. This is a convenience function for: gdk_display_manager_get_default_display (gdk_display_manager_get ()) + - a `GdkDisplay`, or %NULL if + a `GdkDisplay`, or %NULL if there is no default display - Opens a display. + Opens a display. If opening the display fails, `NULL` is returned. + - a `GdkDisplay` + a `GdkDisplay` - the name of the display to open + the name of the display to open - Emits a short beep on @display + Emits a short beep on @display + - a `GdkDisplay` + a `GdkDisplay` - Closes the connection to the windowing system for the given display. + Closes the connection to the windowing system for the given display. This cleans up associated resources. + - a `GdkDisplay` + a `GdkDisplay` - - Returns %TRUE if there is an ongoing grab on @device for @display. + + Returns %TRUE if there is an ongoing grab on @device for @display. + - %TRUE if there is a grab in effect for @device. + %TRUE if there is a grab in effect for @device. - a `GdkDisplay` + a `GdkDisplay` - a `GdkDevice` + a `GdkDevice` - Flushes any requests queued for the windowing system. + Flushes any requests queued for the windowing system. This happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, @@ -3500,183 +5494,269 @@ from a thread other than the thread where the main loop is running. This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing. + - a `GdkDisplay` + a `GdkDisplay` - - Returns a `GdkAppLaunchContext` suitable for launching + + Returns a `GdkAppLaunchContext` suitable for launching applications on the given display. + - a new `GdkAppLaunchContext` for @display + a new `GdkAppLaunchContext` for @display - a `GdkDisplay` + a `GdkDisplay` - Gets the clipboard used for copy/paste operations. + Gets the clipboard used for copy/paste operations. + - the display's clipboard + the display's clipboard - a `GdkDisplay` + a `GdkDisplay` - - Returns the default `GdkSeat` for this display. + + Returns the default `GdkSeat` for this display. Note that a display may not have a seat. In this case, this function will return %NULL. + - the default seat. + the default seat. - a `GdkDisplay` + a `GdkDisplay` - - Gets the monitor in which the largest area of @surface + + Gets the monitor in which the largest area of @surface resides. Returns a monitor close to @surface if it is outside of all monitors. + - the monitor with the largest + the monitor with the largest overlap with @surface - a `GdkDisplay` + a `GdkDisplay` - a `GdkSurface` + a `GdkSurface` - Gets the list of monitors associated with this display. + Gets the list of monitors associated with this display. Subsequent calls to this function will always return the same list for the same display. You can listen to the GListModel::items-changed signal on this list to monitor changes to the monitor of this display. + - a `GListModel` of `GdkMonitor` + a `GListModel` of `GdkMonitor` - a `GdkDisplay` + a `GdkDisplay` - Gets the name of the display. + Gets the name of the display. + - a string representing the display name. This string is owned + a string representing the display name. This string is owned by GDK and should not be modified or freed. - a `GdkDisplay` + a `GdkDisplay` - - Gets the clipboard used for the primary selection. + + Gets the clipboard used for the primary selection. On backends where the primary clipboard is not supported natively, GDK emulates this clipboard locally. + - the primary clipboard + the primary clipboard - a `GdkDisplay` + a `GdkDisplay` - Retrieves a desktop-wide setting such as double-click time + Retrieves a desktop-wide setting such as double-click time for the @display. + - %TRUE if the setting existed and a value was stored + %TRUE if the setting existed and a value was stored in @value, %FALSE otherwise - a `GdkDisplay` + a `GdkDisplay` - the name of the setting + the name of the setting - location to store the value of the setting + location to store the value of the setting - - Gets the startup notification ID for a Wayland display, or %NULL + + Gets the startup notification ID for a Wayland display, or %NULL if no ID has been defined. + - the startup notification ID for @display + the startup notification ID for @display - a `GdkDisplay` + a `GdkDisplay` - Finds out if the display has been closed. + Finds out if the display has been closed. + - %TRUE if the display is closed. + %TRUE if the display is closed. - a `GdkDisplay` + a `GdkDisplay` - Returns whether surfaces can reasonably be expected to have + Returns whether surfaces can reasonably be expected to have their alpha channel drawn correctly on the screen. Check [method@Gdk.Display.is_rgba] for whether the display @@ -3686,48 +5766,65 @@ On X11 this function returns whether a compositing manager is compositing on @display. On modern displays, this value is always %TRUE. + - Whether surfaces with RGBA visuals can reasonably + Whether surfaces with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen. - a `GdkDisplay` + a `GdkDisplay` - Returns whether surfaces on this @display are created with an + Returns whether surfaces on this @display are created with an alpha channel. Even if a %TRUE is returned, it is possible that the -surface’s alpha channel won’t be honored when displaying the +surface’s alpha channel won’t be honored when displaying the surface on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display. Use [method@Gdk.Display.is_composited] to check if that is the case. On modern displays, this value is always %TRUE. + - %TRUE if surfaces are created with an alpha channel or + %TRUE if surfaces are created with an alpha channel or %FALSE if the display does not support this functionality. - a `GdkDisplay` + a `GdkDisplay` - Returns the list of seats known to @display. + Returns the list of seats known to @display. + - the + the list of seats known to the `GdkDisplay` @@ -3735,13 +5832,17 @@ On modern displays, this value is always %TRUE. - a `GdkDisplay` + a `GdkDisplay` - Returns the keyvals bound to @keycode. + Returns the keyvals bound to @keycode. The Nth `GdkKeymapKey` in @keys is bound to the Nth keyval in @keyvals. @@ -3750,41 +5851,69 @@ this list of entries is selected by considering the effective keyboard group and level. Free the returned arrays with g_free(). + - %TRUE if there were any entries + %TRUE if there were any entries - a `GdkDisplay` + a `GdkDisplay` - a keycode + a keycode - - return + + return location for array of `GdkKeymapKey` - - return + + return location for array of keyvals - - length of @keys and @keyvals + + length of @keys and @keyvals - Obtains a list of keycode/group/level combinations that will + Obtains a list of keycode/group/level combinations that will generate @keyval. Groups and levels are two kinds of keyboard mode; in general, the level @@ -3799,57 +5928,87 @@ Hebrew to English modes, for example. keyboard group. The level is computed from the modifier mask. The returned array should be freed with g_free(). + - %TRUE if keys were found and returned + %TRUE if keys were found and returned - a `GdkDisplay` + a `GdkDisplay` - a keyval, such as %GDK_KEY_a, %GDK_KEY_Up, %GDK_KEY_Return, etc. + a keyval, such as %GDK_KEY_a, %GDK_KEY_Up, %GDK_KEY_Return, etc. - - return location + + return location for an array of `GdkKeymapKey` - - return location for number of elements in returned array + + return location for number of elements in returned array - - Indicates to the GUI environment that the application has + + Indicates to the GUI environment that the application has finished loading, using a given identifier. GTK will call this function automatically for [class@Gtk.Window] with custom startup-notification identifier unless [method@Gtk.Window.set_auto_startup_notification] is called to disable that feature. + - a `GdkDisplay` + a `GdkDisplay` - a startup-notification identifier, for which + a startup-notification identifier, for which notification process should be completed - - Checks that OpenGL is available for @self and ensures that it is + + Checks that OpenGL is available for @self and ensures that it is properly initialized. When this fails, an @error will be set describing the error and this function returns %FALSE. @@ -3863,58 +6022,80 @@ return the same value or error. You never need to call this function, GDK will call it automatically as needed. But you can use it as a check when setting up code that might make use of OpenGL. + - %TRUE if the display supports OpenGL + %TRUE if the display supports OpenGL - a `GdkDisplay` + a `GdkDisplay` - Appends the given event onto the front of the event + Appends the given event onto the front of the event queue for @display. This function is only useful in very special situations and should not be used by applications. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkEvent` + a `GdkEvent` - + - Returns %TRUE if the display supports input shapes. + Returns %TRUE if the display supports input shapes. This means that [method@Gdk.Surface.set_input_region] can be used to modify the input shape of surfaces on @display. On modern displays, this value is always %TRUE. + - %TRUE if surfaces with modified input shape are supported + %TRUE if surfaces with modified input shape are supported - a `GdkDisplay` + a `GdkDisplay` - Flushes any requests queued for the windowing system and waits until all + Flushes any requests queued for the windowing system and waits until all requests have been handled. This is often used for making sure that the display is synchronized @@ -3924,18 +6105,23 @@ generated from earlier requests are handled before the error trap is removed. This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing. + - a `GdkDisplay` + a `GdkDisplay` - Translates the contents of a `GdkEventKey` into a keyval, effective group, + Translates the contents of a `GdkEventKey` into a keyval, effective group, and level. Modifiers that affected the translation and are thus unavailable for @@ -3954,118 +6140,190 @@ should be masked out. This function should rarely be needed, since `GdkEventKey` already contains the translated keyval. It is exported for the benefit of virtualized test environments. + - %TRUE if there was a keyval bound to keycode/state/group. + %TRUE if there was a keyval bound to keycode/state/group. - a `GdkDisplay` + a `GdkDisplay` - a keycode + a keycode - a modifier state + a modifier state - active keyboard group + active keyboard group - - return location for keyval + + return location for keyval - - return location for effective group + + return location for effective group - - return location for level + + return location for level - - return location for modifiers that were used + + return location for modifiers that were used to determine the group or level - - %TRUE if the display properly composites the alpha channel. + + %TRUE if the display properly composites the alpha channel. - - %TRUE if the display supports input shapes. + + %TRUE if the display supports input shapes. - %TRUE if the display supports an alpha channel. + %TRUE if the display supports an alpha channel. - Emitted when the connection to the windowing system for @display is closed. + Emitted when the connection to the windowing system for @display is closed. - %TRUE if the display was closed due to an error + %TRUE if the display was closed due to an error - Emitted when the connection to the windowing system for @display is opened. + Emitted when the connection to the windowing system for @display is opened. - Emitted whenever a new seat is made known to the windowing system. + Emitted whenever a new seat is made known to the windowing system. - the seat that was just added + the seat that was just added - Emitted whenever a seat is removed by the windowing system. + Emitted whenever a seat is removed by the windowing system. - the seat that was just removed + the seat that was just removed - Emitted whenever a setting changes its value. + Emitted whenever a setting changes its value. - the name of the setting that changed + the name of the setting that changed - - A singleton object that offers notification when displays appear or + + A singleton object that offers notification when displays appear or disappear. You can use [func@Gdk.DisplayManager.get] to obtain the `GdkDisplayManager` @@ -4108,7 +6366,9 @@ macros like GDK_IS_X11_DISPLAY() to find out which backend is in use: g_error ("Unsupported GDK backend"); ``` - Gets the singleton `GdkDisplayManager` object. + Gets the singleton `GdkDisplayManager` object. When called for the first time, this function consults the `GDK_BACKEND` environment variable to find out which of the @@ -4117,29 +6377,46 @@ with multiple backends). Applications can use [func@set_allowed_backends] to limit what backends wil be used. + - The global `GdkDisplayManager` singleton + The global `GdkDisplayManager` singleton - + - Gets the default `GdkDisplay`. + Gets the default `GdkDisplay`. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkDisplayManager` + a `GdkDisplayManager` - - List all currently open displays. + + List all currently open displays. + - a newly + a newly allocated `GSList` of `GdkDisplay` objects @@ -4147,65 +6424,100 @@ backends wil be used. - a `GdkDisplayManager` + a `GdkDisplayManager` - - Opens a display. + + Opens a display. + - a `GdkDisplay`, or %NULL + a `GdkDisplay`, or %NULL if the display could not be opened - a `GdkDisplayManager` + a `GdkDisplayManager` - the name of the display to open + the name of the display to open - - Sets @display as the default display. + + Sets @display as the default display. + - a `GdkDisplayManager` + a `GdkDisplayManager` - a `GdkDisplay` + a `GdkDisplay` - - The default display. + + The default display. - Emitted when a display is opened. + Emitted when a display is opened. - the opened display + the opened display - - The `GdkDrag` object represents the source of an ongoing DND operation. + + The `GdkDrag` object represents the source of an ongoing DND operation. A `GdkDrag` is created when a drag is started, and stays alive for duration of the DND operation. After a drag has been started with [func@Gdk.Drag.begin], @@ -4216,7 +6528,9 @@ GTK provides a higher level abstraction based on top of these functions, and so they are not normally needed in GTK applications. See the "Drag and Drop" section of the GTK documentation for more information. - Starts a drag and creates a new drag context for it. + Starts a drag and creates a new drag context for it. This function is called by the drag source. After this call, you probably want to set up the drag icon using the surface returned @@ -4230,39 +6544,56 @@ Note: if @actions include %GDK_ACTION_MOVE, you need to listen for the [signal@Gdk.Drag::dnd-finished] signal and delete the data at the source if [method@Gdk.Drag.get_selected_action] returns %GDK_ACTION_MOVE. + - a newly created `GdkDrag` + a newly created `GdkDrag` - the source surface for this drag + the source surface for this drag - the device that controls this drag + the device that controls this drag - the offered content + the offered content - the actions supported by this drag + the actions supported by this drag - the x offset to @device's position where the drag nominally started + the x offset to @device's position where the drag nominally started - the y offset to @device's position where the drag nominally started + the y offset to @device's position where the drag nominally started - Informs GDK that the drop ended. + Informs GDK that the drop ended. Passing %FALSE for @success may trigger a drag cancellation animation. @@ -4273,209 +6604,313 @@ last call before dropping the reference to the @drag. The `GdkDrag` will only take the first [method@Gdk.Drag.drop_done] call as effective, if this function is called multiple times, all subsequent calls will be ignored. + - a `GdkDrag` + a `GdkDrag` - whether the drag was ultimatively successful + whether the drag was ultimatively successful - Determines the bitmask of possible actions proposed by the source. + Determines the bitmask of possible actions proposed by the source. + - the `GdkDragAction` flags + the `GdkDragAction` flags - a `GdkDrag` + a `GdkDrag` - Returns the `GdkContentProvider` associated to the `GdkDrag` object. + Returns the `GdkContentProvider` associated to the `GdkDrag` object. + - The `GdkContentProvider` associated to @drag. + The `GdkContentProvider` associated to @drag. - a `GdkDrag` + a `GdkDrag` - Returns the `GdkDevice` associated to the `GdkDrag` object. + Returns the `GdkDevice` associated to the `GdkDrag` object. + - The `GdkDevice` associated to @drag. + The `GdkDevice` associated to @drag. - a `GdkDrag` + a `GdkDrag` - Gets the `GdkDisplay` that the drag object was created for. + Gets the `GdkDisplay` that the drag object was created for. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkDrag` + a `GdkDrag` - Returns the surface on which the drag icon should be rendered + Returns the surface on which the drag icon should be rendered during the drag operation. Note that the surface may not be available until the drag operation has begun. GDK will move the surface in accordance with the ongoing drag operation. The surface is owned by @drag and will be destroyed when the drag operation is over. + - the drag surface + the drag surface - a `GdkDrag` + a `GdkDrag` - Retrieves the formats supported by this `GdkDrag` object. + Retrieves the formats supported by this `GdkDrag` object. + - a `GdkContentFormats` + a `GdkContentFormats` - a `GdkDrag` + a `GdkDrag` - + - Determines the action chosen by the drag destination. + Determines the action chosen by the drag destination. + - a `GdkDragAction` value + a `GdkDragAction` value - a `GdkDrag` + a `GdkDrag` - Returns the `GdkSurface` where the drag originates. + Returns the `GdkSurface` where the drag originates. + - The `GdkSurface` where the drag originates + The `GdkSurface` where the drag originates - a `GdkDrag` + a `GdkDrag` - Sets the position of the drag surface that will be kept + Sets the position of the drag surface that will be kept under the cursor hotspot. Initially, the hotspot is at the top left corner of the drag surface. + - a `GdkDrag` + a `GdkDrag` - x coordinate of the drag surface hotspot + x coordinate of the drag surface hotspot - y coordinate of the drag surface hotspot + y coordinate of the drag surface hotspot - The possible actions of this drag. + The possible actions of this drag. - + - The `GdkContentProvider`. + The `GdkContentProvider`. - + - The `GdkDevice` that is performing the drag. + The `GdkDevice` that is performing the drag. - The `GdkDisplay` that the drag belongs to. + The `GdkDisplay` that the drag belongs to. - + - The possible formats that the drag can provide its data in. + The possible formats that the drag can provide its data in. - - The currently selected action of the drag. + + The currently selected action of the drag. - + - The surface where the drag originates. + The surface where the drag originates. - Emitted when the drag operation is cancelled. + Emitted when the drag operation is cancelled. - The reason the drag was cancelled + The reason the drag was cancelled - Emitted when the destination side has finished reading all data. + Emitted when the destination side has finished reading all data. The drag object can now free all miscellaneous data. @@ -4483,90 +6918,177 @@ The drag object can now free all miscellaneous data. - Emitted when the drop operation is performed on an accepting client. + Emitted when the drop operation is performed on an accepting client. - - Used in `GdkDrop` and `GdkDrag` to indicate the actions that the + + Used in `GdkDrop` and `GdkDrag` to indicate the actions that the destination can and should do with the dropped data. - - Copy the data. + + Copy the data. - - Move the data, i.e. first copy it, then delete + + Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol. - - Add a link to the data. Note that this is only + + Add a link to the data. Note that this is only useful if source and destination agree on what it means, and is not supported on all platforms. - - Ask the user what to do with the data. + + Ask the user what to do with the data. - Checks if @action represents a single action or includes + Checks if @action represents a single action or includes multiple actions. When @action is 0 - ie no action was given, %TRUE is returned. + - %TRUE if exactly one action was given + %TRUE if exactly one action was given - a `GdkDragAction` + a `GdkDragAction` - - Used in `GdkDrag` to the reason of a cancelled DND operation. - - There is no suitable drop target. + + Used in `GdkDrag` to the reason of a cancelled DND operation. + + There is no suitable drop target. - - Drag cancelled by the user + + Drag cancelled by the user - - Unspecified error. + + Unspecified error. - - A `GdkDragSurface` is an interface for surfaces used during DND. + + A `GdkDragSurface` is an interface for surfaces used during DND. + - Present @drag_surface. + Present @drag_surface. + - %FALSE if it failed to be presented, otherwise %TRUE. + %FALSE if it failed to be presented, otherwise %TRUE. - the `GdkDragSurface` to show + the `GdkDragSurface` to show - the unconstrained drag_surface width to layout + the unconstrained drag_surface width to layout - the unconstrained drag_surface height to layout + the unconstrained drag_surface height to layout - - The `GdkDragSurfaceInterface` implementation is private to GDK. + + The `GdkDragSurfaceInterface` implementation is private to GDK. + - - Base class for objects implementing different rendering methods. + + Base class for objects implementing different rendering methods. `GdkDrawContext` is the base object used by contexts implementing different rendering methods, such as [class@Gdk.CairoContext] or [class@Gdk.GLContext]. @@ -4576,7 +7098,9 @@ You will always interact with one of those subclasses. A `GdkDrawContext` is always associated with a single toplevel surface. - Indicates that you are beginning the process of redrawing @region + Indicates that you are beginning the process of redrawing @region on the @context's surface. Calling this function begins a drawing operation using @context on the @@ -4600,22 +7124,29 @@ When using GTK, the widget system automatically places calls to gdk_draw_context_begin_frame() and gdk_draw_context_end_frame() via the use of [class@Gsk.Renderer]s, so application code does not need to call these functions explicitly. + - the `GdkDrawContext` used to draw the frame + the `GdkDrawContext` used to draw the frame - minimum region that should be drawn + minimum region that should be drawn - Ends a drawing operation started with gdk_draw_context_begin_frame(). + Ends a drawing operation started with gdk_draw_context_begin_frame(). This makes the drawing available on screen. See [method@Gdk.DrawContext.begin_frame] for more details about drawing. @@ -4623,32 +7154,45 @@ See [method@Gdk.DrawContext.begin_frame] for more details about drawing. When using a [class@Gdk.GLContext], this function may call `glFlush()` implicitly before returning; it is not recommended to call `glFlush()` explicitly before calling this function. + - a `GdkDrawContext` + a `GdkDrawContext` - Retrieves the `GdkDisplay` the @context is created for + Retrieves the `GdkDisplay` the @context is created for + - the `GdkDisplay` + the `GdkDisplay` - a `GdkDrawContext` + a `GdkDrawContext` - - Retrieves the region that is currently being repainted. + + Retrieves the region that is currently being repainted. After a call to [method@Gdk.DrawContext.begin_frame] this function will return a union of the region passed to that function and the area of the @@ -4656,62 +7200,101 @@ surface that the @context determined needs to be repainted. If @context is not in between calls to [method@Gdk.DrawContext.begin_frame] and [method@Gdk.DrawContext.end_frame], %NULL will be returned. + - a Cairo region + a Cairo region - a `GdkDrawContext` + a `GdkDrawContext` - Retrieves the surface that @context is bound to. + Retrieves the surface that @context is bound to. + - a `GdkSurface` + a `GdkSurface` - a `GdkDrawContext` + a `GdkDrawContext` - Returns %TRUE if @context is in the process of drawing to its surface. + Returns %TRUE if @context is in the process of drawing to its surface. This is the case between calls to [method@Gdk.DrawContext.begin_frame] and [method@Gdk.DrawContext.end_frame]. In this situation, drawing commands may be effecting the contents of the @context's surface. + - %TRUE if the context is between [method@Gdk.DrawContext.begin_frame] + %TRUE if the context is between [method@Gdk.DrawContext.begin_frame] and [method@Gdk.DrawContext.end_frame] calls. - a `GdkDrawContext` + a `GdkDrawContext` - - - The `GdkDisplay` used to create the `GdkDrawContext`. + + + The `GdkDisplay` used to create the `GdkDrawContext`. - - - The `GdkSurface` the context is bound to. + + + The `GdkSurface` the context is bound to. - - The `GdkDrop` object represents the target of an ongoing DND operation. + + The `GdkDrop` object represents the target of an ongoing DND operation. Possible drop sites get informed about the status of the ongoing drag operation with events of type %GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, @@ -4726,27 +7309,36 @@ GTK provides a higher level abstraction based on top of these functions, and so they are not normally needed in GTK applications. See the "Drag and Drop" section of the GTK documentation for more information. - Ends the drag operation after a drop. + Ends the drag operation after a drop. The @action must be a single action selected from the actions available via [method@Gdk.Drop.get_actions]. + - a `GdkDrop` + a `GdkDrop` - the action performed by the destination or 0 if the drop failed + the action performed by the destination or 0 if the drop failed - Returns the possible actions for this `GdkDrop`. + Returns the possible actions for this `GdkDrop`. If this value contains multiple actions - i.e. [func@Gdk.DragAction.is_unique] returns %FALSE for the result - @@ -4760,130 +7352,200 @@ This value may change over the lifetime of the [class@Gdk.Drop] both as a response to source side actions as well as to calls to [method@Gdk.Drop.status] or [method@Gdk.Drop.finish]. The source side will not change this value anymore once a drop has started. + - The possible `GdkDragActions` + The possible `GdkDragActions` - a `GdkDrop` + a `GdkDrop` - Returns the `GdkDevice` performing the drop. + Returns the `GdkDevice` performing the drop. + - The `GdkDevice` performing the drop. + The `GdkDevice` performing the drop. - a `GdkDrop` + a `GdkDrop` - Gets the `GdkDisplay` that @self was created for. + Gets the `GdkDisplay` that @self was created for. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkDrop` + a `GdkDrop` - If this is an in-app drag-and-drop operation, returns the `GdkDrag` + If this is an in-app drag-and-drop operation, returns the `GdkDrag` that corresponds to this drop. If it is not, %NULL is returned. + - the corresponding `GdkDrag` + the corresponding `GdkDrag` - a `GdkDrop` + a `GdkDrop` - Returns the `GdkContentFormats` that the drop offers the data + Returns the `GdkContentFormats` that the drop offers the data to be read in. + - The possible `GdkContentFormats` + The possible `GdkContentFormats` - a `GdkDrop` + a `GdkDrop` - Returns the `GdkSurface` performing the drop. + Returns the `GdkSurface` performing the drop. + - The `GdkSurface` performing the drop. + The `GdkSurface` performing the drop. - a `GdkDrop` + a `GdkDrop` - Asynchronously read the dropped data from a `GdkDrop` + Asynchronously read the dropped data from a `GdkDrop` in a format that complies with one of the mime types. + - a `GdkDrop` + a `GdkDrop` - + pointer to an array of mime types - the I/O priority for the read operation + the I/O priority for the read operation - - optional `GCancellable` object + + optional `GCancellable` object - - a `GAsyncReadyCallback` to call when + + a `GAsyncReadyCallback` to call when the request is satisfied - - the data to pass to @callback + + the data to pass to @callback - - Finishes an async drop read operation. + + Finishes an async drop read operation. Note that you must not use blocking read calls on the returned stream in the GTK thread, since some platforms might require communication with @@ -4891,27 +7553,41 @@ GTK to complete the data transfer. You can use async APIs such as g_input_stream_read_bytes_async(). See [method@Gdk.Drop.read_async]. + - the `GInputStream` + the `GInputStream` - a `GdkDrop` + a `GdkDrop` - a `GAsyncResult` + a `GAsyncResult` - - return location for the used mime type + + return location for the used mime type - Asynchronously request the drag operation's contents converted + Asynchronously request the drag operation's contents converted to the given @type. When the operation is finished @callback will be called. You must @@ -4921,57 +7597,94 @@ then call [method@Gdk.Drop.read_value_finish] to get the resulting For local drag-and-drop operations that are available in the given `GType`, the value will be copied directly. Otherwise, GDK will try to use [func@Gdk.content_deserialize_async] to convert the data. + - a `GdkDrop` + a `GdkDrop` - a `GType` to read + a `GType` to read - the I/O priority of the request. + the I/O priority of the request. - - optional `GCancellable` object, %NULL to ignore. + + optional `GCancellable` object, %NULL to ignore. - - callback to call when the request is satisfied + + callback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an async drop read. + + Finishes an async drop read. See [method@Gdk.Drop.read_value_async]. + - a `GValue` containing the result. + a `GValue` containing the result. - a `GdkDrop` + a `GdkDrop` - a `GAsyncResult` + a `GAsyncResult` - Selects all actions that are potentially supported by the destination. + Selects all actions that are potentially supported by the destination. When calling this function, do not restrict the passed in actions to the ones provided by [method@Gdk.Drop.get_actions]. Those actions may @@ -4984,82 +7697,139 @@ This function should be called by drag destinations in response to %GDK_DRAG_ENTER or %GDK_DRAG_MOTION events. If the destination does not yet know the exact actions it supports, it should set any possible actions first and then later call this function again. + - a `GdkDrop` + a `GdkDrop` - Supported actions of the destination, or 0 to indicate + Supported actions of the destination, or 0 to indicate that a drop will not be accepted - A unique action that's a member of @actions indicating the + A unique action that's a member of @actions indicating the preferred action - + - The possible actions for this drop + The possible actions for this drop - + - The `GdkDevice` performing the drop + The `GdkDevice` performing the drop - The `GdkDisplay` that the drop belongs to. + The `GdkDisplay` that the drop belongs to. - + - The `GdkDrag` that initiated this drop + The `GdkDrag` that initiated this drop - + - The possible formats that the drop can provide its data in. + The possible formats that the drop can provide its data in. - + - The `GdkSurface` the drop happens on + The `GdkSurface` the drop happens on + - - Use this macro as the return value for continuing the propagation of + + Use this macro as the return value for continuing the propagation of an event handler. + - Use this macro as the return value for stopping the propagation of + Use this macro as the return value for stopping the propagation of an event handler. + - - `GdkEvent`s are immutable data structures, created by GDK to + + `GdkEvent`s are immutable data structures, created by GDK to represent windowing system events. In GTK applications the events are handled automatically by toplevel widgets and passed on to the event controllers of appropriate widgets, so using `GdkEvent` and its related API is rarely needed. - - Returns the relative angle from @event1 to @event2. + + Returns the relative angle from @event1 to @event2. The relative angle is the angle between the X axis and the line through both events' positions. The rotation direction for positive @@ -5067,137 +7837,226 @@ angles is from the positive X axis towards the positive Y axis. This assumes that both events have X/Y information. If not, this function returns %FALSE. + - %TRUE if the angle could be calculated. + %TRUE if the angle could be calculated. - first `GdkEvent` + first `GdkEvent` - second `GdkEvent` + second `GdkEvent` - - return location for the relative angle between both events + + return location for the relative angle between both events - - Returns the point halfway between the events' positions. + + Returns the point halfway between the events' positions. This assumes that both events have X/Y information. If not, this function returns %FALSE. + - %TRUE if the center could be calculated. + %TRUE if the center could be calculated. - first `GdkEvent` + first `GdkEvent` - second `GdkEvent` + second `GdkEvent` - - return location for the X coordinate of the center + + return location for the X coordinate of the center - - return location for the Y coordinate of the center + + return location for the Y coordinate of the center - - Returns the distance between the event locations. + + Returns the distance between the event locations. This assumes that both events have X/Y information. If not, this function returns %FALSE. + - %TRUE if the distance could be calculated. + %TRUE if the distance could be calculated. - first `GdkEvent` + first `GdkEvent` - second `GdkEvent` + second `GdkEvent` - - return location for the distance + + return location for the distance - Extracts all axis values from an event. + Extracts all axis values from an event. + - %TRUE on success, otherwise %FALSE + %TRUE on success, otherwise %FALSE - a `GdkEvent` + a `GdkEvent` - - the array of values for all axes + + the array of values for all axes - - the length of array + + the length of array - Extract the axis value for a particular axis use from + Extract the axis value for a particular axis use from an event structure. + - %TRUE if the specified axis was found, otherwise %FALSE + %TRUE if the specified axis was found, otherwise %FALSE - a `GdkEvent` + a `GdkEvent` - the axis use to look for + the axis use to look for - - location to store the value found + + location to store the value found - Returns the device of an event. + Returns the device of an event. + - a `GdkDevice` + a `GdkDevice` - a `GdkEvent`. + a `GdkEvent`. - Returns a `GdkDeviceTool` representing the tool that + Returns a `GdkDeviceTool` representing the tool that caused the event. If the was not generated by a device that supports @@ -5207,61 +8066,90 @@ return %NULL. Note: the `GdkDeviceTool` will be constant during the application lifetime, if settings must be stored persistently across runs, see [method@Gdk.DeviceTool.get_serial]. + - The current device tool + The current device tool - a `GdkEvent` + a `GdkEvent` - Retrieves the display associated to the @event. + Retrieves the display associated to the @event. + - a `GdkDisplay` + a `GdkDisplay` - a `GdkEvent` + a `GdkEvent` - - Retuns the event sequence to which the event belongs. + + Retuns the event sequence to which the event belongs. Related touch events are connected in a sequence. Other events typically don't have event sequence information. + - the event sequence that the event belongs to + the event sequence that the event belongs to - a `GdkEvent` + a `GdkEvent` - Retrieves the type of the event. + Retrieves the type of the event. + - a `GdkEvent`Type + a `GdkEvent`Type - a `GdkEvent` + a `GdkEvent` - Retrieves the history of the device that @event is for, as a list of + Retrieves the history of the device that @event is for, as a list of time and coordinates. The history includes positions that are not delivered as separate events @@ -5269,8 +8157,11 @@ to the application because they occurred in the same frame as @event. Note that only motion and scroll events record history, and motion events do it only if one of the mouse buttons is down. + - an + an array of time and coordinates @@ -5278,292 +8169,564 @@ events do it only if one of the mouse buttons is down. - a motion or scroll event + a motion or scroll event - - Return location for the length of the returned array + + Return location for the length of the returned array - - Returns the modifier state field of an event. + + Returns the modifier state field of an event. + - the modifier state of @event + the modifier state of @event - a `GdkEvent` + a `GdkEvent` - - Returns whether this event is an 'emulated' pointer event. + + Returns whether this event is an 'emulated' pointer event. Emulated pointer events typically originate from a touch events. + - %TRUE if this event is emulated + %TRUE if this event is emulated - a `GdkEvent` + a `GdkEvent` - Extract the event surface relative x/y coordinates from an event. + Extract the event surface relative x/y coordinates from an event. + - a `GdkEvent` + a `GdkEvent` - - location to put event surface x coordinate + + location to put event surface x coordinate - - location to put event surface y coordinate + + location to put event surface y coordinate - Returns the seat that originated the event. + Returns the seat that originated the event. + - a `GdkSeat`. + a `GdkSeat`. - a `GdkEvent` + a `GdkEvent` - Extracts the surface associated with an event. + Extracts the surface associated with an event. + - The `GdkSurface` associated with the event + The `GdkSurface` associated with the event - a `GdkEvent` + a `GdkEvent` - Returns the timestamp of @event. + Returns the timestamp of @event. Not all events have timestamps. In that case, this function returns %GDK_CURRENT_TIME. + - timestamp field from @event + timestamp field from @event - a `GdkEvent` + a `GdkEvent` - Increase the ref count of @event. + Increase the ref count of @event. + - @event + @event - a `GdkEvent` + a `GdkEvent` - - Returns whether a `GdkEvent` should trigger a context menu, + + Returns whether a `GdkEvent` should trigger a context menu, according to platform conventions. The right mouse button typically triggers context menus. This function should always be used instead of simply checking for event->button == %GDK_BUTTON_SECONDARY. + - %TRUE if the event should trigger a context menu. + %TRUE if the event should trigger a context menu. - a `GdkEvent`, currently only button events are meaningful values + a `GdkEvent`, currently only button events are meaningful values - Decrease the ref count of @event. + Decrease the ref count of @event. If the last reference is dropped, the structure is freed. + - a `GdkEvent` + a `GdkEvent` - - `GdkEventSequence` is an opaque type representing a sequence + + `GdkEventSequence` is an opaque type representing a sequence of related touch events. + - - Specifies the type of the event. - - the window manager has requested that the toplevel surface be + + Specifies the type of the event. + + the window manager has requested that the toplevel surface be hidden or destroyed, usually when the user clicks on a special icon in the title bar. - - the pointer (usually a mouse) has moved. + + the pointer (usually a mouse) has moved. - - a mouse button has been pressed. + + a mouse button has been pressed. - - a mouse button has been released. + + a mouse button has been released. - - a key has been pressed. + + a key has been pressed. - - a key has been released. + + a key has been released. - - the pointer has entered the surface. + + the pointer has entered the surface. - - the pointer has left the surface. + + the pointer has left the surface. - - the keyboard focus has entered or left the surface. + + the keyboard focus has entered or left the surface. - - an input device has moved into contact with a sensing + + an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet). - - an input device has moved out of contact with a sensing + + an input device has moved out of contact with a sensing surface. - - the mouse has entered the surface while a drag is in progress. + + the mouse has entered the surface while a drag is in progress. - - the mouse has left the surface while a drag is in progress. + + the mouse has left the surface while a drag is in progress. - - the mouse has moved in the surface while a drag is in + + the mouse has moved in the surface while a drag is in progress. - - a drop operation onto the surface has started. + + a drop operation onto the surface has started. - - the scroll wheel was turned + + the scroll wheel was turned - - a pointer or keyboard grab was broken. + + a pointer or keyboard grab was broken. - - A new touch event sequence has just started. + + A new touch event sequence has just started. - - A touch event sequence has been updated. + + A touch event sequence has been updated. - - A touch event sequence has finished. + + A touch event sequence has finished. - - A touch event sequence has been canceled. + + A touch event sequence has been canceled. - - A touchpad swipe gesture event, the current state + + A touchpad swipe gesture event, the current state is determined by its phase field. - - A touchpad pinch gesture event, the current state + + A touchpad pinch gesture event, the current state is determined by its phase field. - - A tablet pad button press event. + + A tablet pad button press event. - - A tablet pad button release event. + + A tablet pad button release event. - - A tablet pad axis event from a "ring". + + A tablet pad axis event from a "ring". - - A tablet pad axis event from a "strip". + + A tablet pad axis event from a "strip". - - A tablet pad group mode change. + + A tablet pad group mode change. - - marks the end of the GdkEventType enumeration. + + marks the end of the GdkEventType enumeration. - + + - + + - + + - + - - An event related to a keyboard focus change. + + An event related to a keyboard focus change. - Extracts whether this event is about focus entering or + Extracts whether this event is about focus entering or leaving the surface. + - %TRUE of the focus is entering + %TRUE of the focus is entering - a focus change event + a focus change event - - A `GdkFrameClock` tells the application when to update and repaint + + A `GdkFrameClock` tells the application when to update and repaint a surface. This may be synced to the vertical refresh rate of the monitor, for example. @@ -5591,47 +8754,65 @@ timescale as g_get_monotonic_time(), however, it is not the same as g_get_monotonic_time(). The frame time does not advance during the time a frame is being painted, and outside of a frame, an attempt is made so that all calls to [method@Gdk.FrameClock.get_frame_time] that -are called at a “similar” time get the same value. This means that +are called at a “similar” time get the same value. This means that if different animations are timed by looking at the difference in time between an initial value from [method@Gdk.FrameClock.get_frame_time] and the value inside the [signal@GdkFrameClock::update] signal of the clock, they will stay exactly synchronized. - - Starts updates for an animation. + + + Starts updates for an animation. Until a matching call to [method@Gdk.FrameClock.end_updating] is made, the frame clock will continually request a new frame with the %GDK_FRAME_CLOCK_PHASE_UPDATE phase. This function may be called multiple times and frames will be requested until gdk_frame_clock_end_updating() is called the same number of times. + - a `GdkFrameClock` + a `GdkFrameClock` - Stops updates for an animation. + Stops updates for an animation. See the documentation for [method@Gdk.FrameClock.begin_updating]. + - a `GdkFrameClock` + a `GdkFrameClock` - - Gets the frame timings for the current frame. + + Gets the frame timings for the current frame. + - the `GdkFrameTimings` for the + the `GdkFrameTimings` for the frame currently being processed, or even no frame is being processed, for the previous frame. Before any frames have been processed, returns %NULL. @@ -5639,63 +8820,91 @@ See the documentation for [method@Gdk.FrameClock.begin_updating]. - a `GdkFrameClock` + a `GdkFrameClock` - Calculates the current frames-per-second, based on the + Calculates the current frames-per-second, based on the frame timings of @frame_clock. + - the current fps, as a `double` + the current fps, as a `double` - a `GdkFrameClock` + a `GdkFrameClock` - - `GdkFrameClock` maintains a 64-bit counter that increments for + + `GdkFrameClock` maintains a 64-bit counter that increments for each frame drawn. + - inside frame processing, the value of the frame counter + inside frame processing, the value of the frame counter for the current frame. Outside of frame processing, the frame counter for the last frame. - a `GdkFrameClock` + a `GdkFrameClock` - - Gets the time that should currently be used for animations. + + Gets the time that should currently be used for animations. -Inside the processing of a frame, it’s the time used to compute the +Inside the processing of a frame, it’s the time used to compute the animation position of everything in a frame. Outside of a frame, it's -the time of the conceptual “previous frame,” which may be either -the actual previous frame time, or if that’s too old, an updated +the time of the conceptual “previous frame,” which may be either +the actual previous frame time, or if that’s too old, an updated time. + - a timestamp in microseconds, in the timescale of + a timestamp in microseconds, in the timescale of of g_get_monotonic_time(). - a `GdkFrameClock` + a `GdkFrameClock` - - Returns the frame counter for the oldest frame available in history. + + Returns the frame counter for the oldest frame available in history. `GdkFrameClock` internally keeps a history of `GdkFrameTimings` objects for recent frames that can be retrieved with @@ -5703,47 +8912,72 @@ objects for recent frames that can be retrieved with is the set from the counter values given by [method@Gdk.FrameClock.get_history_start] and [method@Gdk.FrameClock.get_frame_counter], inclusive. + - the frame counter value for the oldest frame + the frame counter value for the oldest frame that is available in the internal frame history of the `GdkFrameClock` - a `GdkFrameClock` + a `GdkFrameClock` - - Predicts a presentation time, based on history. + + Predicts a presentation time, based on history. Using the frame history stored in the frame clock, finds the last known presentation time and refresh interval, and assuming that presentation times are separated by the refresh interval, predicts a presentation time that is a multiple of the refresh interval after the last presentation time, and later than @base_time. + - a `GdkFrameClock` + a `GdkFrameClock` - base time for determining a presentaton time + base time for determining a presentaton time - - a location to store the + + a location to store the determined refresh interval, or %NULL. A default refresh interval of 1/60th of a second will be stored if no history is present. - - a location to store the next + + a location to store the next candidate presentation time after the given base time. 0 will be will be stored if no history is present. @@ -5751,31 +8985,43 @@ interval after the last presentation time, and later than @base_time. - Retrieves a `GdkFrameTimings` object holding timing information + Retrieves a `GdkFrameTimings` object holding timing information for the current frame or a recent frame. The `GdkFrameTimings` object may not yet be complete: see [method@Gdk.FrameTimings.get_complete] and [method@Gdk.FrameClock.get_history_start]. + - the `GdkFrameTimings` object + the `GdkFrameTimings` object for the specified frame, or %NULL if it is not available - a `GdkFrameClock` + a `GdkFrameClock` - the frame counter value identifying the frame to + the frame counter value identifying the frame to be received - - Asks the frame clock to run a particular phase. + + Asks the frame clock to run a particular phase. The signal corresponding the requested phase will be emitted the next time the frame clock processes. Multiple calls to @@ -5786,22 +9032,29 @@ content and want to continually request the you should use [method@Gdk.FrameClock.begin_updating] instead, since this allows GTK to adjust system parameters to get maximally smooth animations. + - a `GdkFrameClock` + a `GdkFrameClock` - the phase that is requested + the phase that is requested - This signal ends processing of the frame. + This signal ends processing of the frame. Applications should generally not handle this signal. @@ -5809,7 +9062,9 @@ Applications should generally not handle this signal. - Begins processing of the frame. + Begins processing of the frame. Applications should generally not handle this signal. @@ -5817,7 +9072,9 @@ Applications should generally not handle this signal. - Used to flush pending motion events that are being batched up and + Used to flush pending motion events that are being batched up and compressed together. Applications should not handle this signal. @@ -5826,7 +9083,9 @@ Applications should not handle this signal. - Emitted as the second step of toolkit and application processing + Emitted as the second step of toolkit and application processing of the frame. Any work to update sizes and positions of application elements @@ -5836,7 +9095,9 @@ should be performed. GTK normally handles this internally. - Emitted as the third step of toolkit and application processing + Emitted as the third step of toolkit and application processing of the frame. The frame is repainted. GDK normally handles this internally and @@ -5847,7 +9108,9 @@ emits [signal@Gdk.Surface::render] signals which are turned into - Emitted after processing of the frame is finished. + Emitted after processing of the frame is finished. This signal is handled internally by GTK to resume normal event processing. Applications should not handle this signal. @@ -5856,7 +9119,9 @@ event processing. Applications should not handle this signal. - Emitted as the first step of toolkit and application processing + Emitted as the first step of toolkit and application processing of the frame. Animations should be updated using [method@Gdk.FrameClock.get_frame_time]. @@ -5867,48 +9132,112 @@ Applications can connect directly to this signal, or use - - - Used to represent the different paint clock phases that can be requested. + + + + + Used to represent the different paint clock phases that can be requested. The elements of the enumeration correspond to the signals of `GdkFrameClock`. - - no phase + + no phase - - corresponds to GdkFrameClock::flush-events. Should not be handled by applications. + + corresponds to GdkFrameClock::flush-events. Should not be handled by applications. - - corresponds to GdkFrameClock::before-paint. Should not be handled by applications. + + corresponds to GdkFrameClock::before-paint. Should not be handled by applications. - - corresponds to GdkFrameClock::update. + + corresponds to GdkFrameClock::update. - - corresponds to GdkFrameClock::layout. Should not be handled by applicatiosn. + + corresponds to GdkFrameClock::layout. Should not be handled by applicatiosn. - - corresponds to GdkFrameClock::paint. + + corresponds to GdkFrameClock::paint. - - corresponds to GdkFrameClock::resume-events. Should not be handled by applications. + + corresponds to GdkFrameClock::resume-events. Should not be handled by applications. - - corresponds to GdkFrameClock::after-paint. Should not be handled by applications. + + corresponds to GdkFrameClock::after-paint. Should not be handled by applications. - - - A `GdkFrameTimings` object holds timing information for a single frame -of the application’s displays. + + + + + A `GdkFrameTimings` object holds timing information for a single frame +of the application’s displays. To retrieve `GdkFrameTimings` objects, use [method@Gdk.FrameClock.get_timings] or [method@Gdk.FrameClock.get_current_timings]. The information in `GdkFrameTimings` is useful for precise synchronization of video with the event or audio streams, and for measuring quality metrics for the -application’s display, such as latency and jitter. - - Returns whether @timings are complete. +application’s display, such as latency and jitter. + + + Returns whether @timings are complete. The timing information in a `GdkFrameTimings` is filled in incrementally as the frame as drawn and passed off to the @@ -5921,51 +9250,75 @@ available at all. Once this function returns %TRUE for a frame, you can be certain that no further values will become available and be stored in the `GdkFrameTimings`. + - %TRUE if all information that will be available + %TRUE if all information that will be available for the frame has been filled in. - a `GdkFrameTimings` + a `GdkFrameTimings` - - Gets the frame counter value of the `GdkFrameClock` when + + Gets the frame counter value of the `GdkFrameClock` when this frame was drawn. + - the frame counter value for this frame + the frame counter value for this frame - a `GdkFrameTimings` + a `GdkFrameTimings` - - Returns the frame time for the frame. + + Returns the frame time for the frame. This is the time value that is typically used to time animations for the frame. See [method@Gdk.FrameClock.get_frame_time]. + - the frame time for the frame, in the timescale + the frame time for the frame, in the timescale of g_get_monotonic_time() - A `GdkFrameTimings` + A `GdkFrameTimings` - - Gets the predicted time at which this frame will be displayed. + + Gets the predicted time at which this frame will be displayed. Although no predicted time may be available, if one is available, it will be available while the frame is being generated, in contrast @@ -5977,94 +9330,150 @@ In general, if you are simply animating, you should use but this function is useful for applications that want exact control over latency. For example, a movie player may want this information for Audio/Video synchronization. + - The predicted time at which the frame will be presented, + The predicted time at which the frame will be presented, in the timescale of g_get_monotonic_time(), or 0 if no predicted presentation time is available. - a `GdkFrameTimings` + a `GdkFrameTimings` - - Reurns the presentation time. + + Reurns the presentation time. This is the time at which the frame became visible to the user. + - the time the frame was displayed to the user, in the + the time the frame was displayed to the user, in the timescale of g_get_monotonic_time(), or 0 if no presentation time is available. See [method@Gdk.FrameTimings.get_complete] - a `GdkFrameTimings` + a `GdkFrameTimings` - - Gets the natural interval between presentation times for + + Gets the natural interval between presentation times for the display that this frame was displayed on. -Frame presentation usually happens during the “vertical -blanking interval”. +Frame presentation usually happens during the “vertical +blanking interval”. + - the refresh interval of the display, in microseconds, + the refresh interval of the display, in microseconds, or 0 if the refresh interval is not available. See [method@Gdk.FrameTimings.get_complete]. - a `GdkFrameTimings` + a `GdkFrameTimings` - Increases the reference count of @timings. + Increases the reference count of @timings. + - @timings + @timings - a `GdkFrameTimings` + a `GdkFrameTimings` - Decreases the reference count of @timings. + Decreases the reference count of @timings. If @timings is no longer referenced, it will be freed. + - a `GdkFrameTimings` + a `GdkFrameTimings` - - Indicates which monitor a surface should span over when in fullscreen mode. - - Fullscreen on current monitor only. + + Indicates which monitor a surface should span over when in fullscreen mode. + + Fullscreen on current monitor only. - - Span across all monitors when fullscreen. + + Span across all monitors when fullscreen. - - `GdkGLContext` is an object representing a platform-specific + + `GdkGLContext` is an object representing a platform-specific OpenGL draw context. `GdkGLContext`s are created for a surface using @@ -6113,156 +9522,247 @@ You can now perform your drawing using OpenGL commands. You can check which `GdkGLContext` is the current one by using [func@Gdk.GLContext.get_current]; you can also unset any `GdkGLContext` that is currently set by calling [func@Gdk.GLContext.clear_current]. - - Clears the current `GdkGLContext`. + + Clears the current `GdkGLContext`. Any OpenGL call after this function returns will be ignored until [method@Gdk.GLContext.make_current] is called. + - Retrieves the current `GdkGLContext`. + Retrieves the current `GdkGLContext`. + - the current `GdkGLContext` + the current `GdkGLContext` - - Retrieves whether the context is doing extra validations and runtime checking. + + Retrieves whether the context is doing extra validations and runtime checking. See [method@Gdk.GLContext.set_debug_enabled]. + - %TRUE if debugging is enabled + %TRUE if debugging is enabled - a `GdkGLContext` + a `GdkGLContext` - Retrieves the display the @context is created for + Retrieves the display the @context is created for + - a `GdkDisplay` + a `GdkDisplay` - a `GdkGLContext` + a `GdkGLContext` - - Retrieves whether the context is forward-compatible. + + Retrieves whether the context is forward-compatible. See [method@Gdk.GLContext.set_forward_compatible]. + - %TRUE if the context should be forward-compatible + %TRUE if the context should be forward-compatible - a `GdkGLContext` + a `GdkGLContext` - - Retrieves required OpenGL version. + + Retrieves required OpenGL version. See [method@Gdk.GLContext.set_required_version]. + - a `GdkGLContext` + a `GdkGLContext` - - return location for the major version to request + + return location for the major version to request - - return location for the minor version to request + + return location for the minor version to request - + - Used to retrieves the `GdkGLContext` that this @context share data with. + Used to retrieves the `GdkGLContext` that this @context share data with. As many contexts can share data now and no single shared context exists anymore, this function has been deprecated and now always returns %NULL. Use [method@Gdk.GLContext.is_shared] to check if contexts can be shared. + - %NULL + %NULL - a `GdkGLContext` + a `GdkGLContext` - Retrieves the surface used by the @context. + Retrieves the surface used by the @context. + - a `GdkSurface` + a `GdkSurface` - a `GdkGLContext` + a `GdkGLContext` - Checks whether the @context is using an OpenGL or OpenGL ES profile. + Checks whether the @context is using an OpenGL or OpenGL ES profile. + - %TRUE if the `GdkGLContext` is using an OpenGL ES profile + %TRUE if the `GdkGLContext` is using an OpenGL ES profile - a `GdkGLContext` + a `GdkGLContext` - Retrieves the OpenGL version of the @context. + Retrieves the OpenGL version of the @context. The @context must be realized prior to calling this function. + - a `GdkGLContext` + a `GdkGLContext` - - return location for the major version + + return location for the major version - - return location for the minor version + + return location for the minor version - Whether the `GdkGLContext` is in legacy mode or not. + Whether the `GdkGLContext` is in legacy mode or not. The `GdkGLContext` must be realized before calling this function. @@ -6278,19 +9778,28 @@ will return %TRUE. You can use the value returned by this function to decide which kind of OpenGL API to use, or whether to do extension discovery, or what kind of shader programs to load. + - %TRUE if the GL context is in legacy mode + %TRUE if the GL context is in legacy mode - a `GdkGLContext` + a `GdkGLContext` - - Checks if the two GL contexts can share resources. + + Checks if the two GL contexts can share resources. When they can, the texture IDs from @other can be used in @self. This is particularly useful when passing `GdkGLTexture` objects between @@ -6302,72 +9811,102 @@ For other contexts it depends on the GL backend. Both contexts must be realized for this check to succeed. If either one is not, this function will return %FALSE. + - %TRUE if the two GL contexts are compatible. + %TRUE if the two GL contexts are compatible. - a `GdkGLContext` + a `GdkGLContext` - the `GdkGLContext` that should be compatible with @self + the `GdkGLContext` that should be compatible with @self - Makes the @context the current one. + Makes the @context the current one. + - a `GdkGLContext` + a `GdkGLContext` - Realizes the given `GdkGLContext`. + Realizes the given `GdkGLContext`. It is safe to call this function on a realized `GdkGLContext`. + - %TRUE if the context is realized + %TRUE if the context is realized - a `GdkGLContext` + a `GdkGLContext` - - Sets whether the `GdkGLContext` should perform extra validations and + + Sets whether the `GdkGLContext` should perform extra validations and runtime checking. This is useful during development, but has additional overhead. The `GdkGLContext` must not be realized or made current prior to calling this function. + - a `GdkGLContext` + a `GdkGLContext` - whether to enable debugging in the context + whether to enable debugging in the context - - Sets whether the `GdkGLContext` should be forward-compatible. + + Sets whether the `GdkGLContext` should be forward-compatible. Forward-compatible contexts must not support OpenGL functionality that has been marked as deprecated in the requested version; non-forward @@ -6376,47 +9915,64 @@ non deprecated functionality. The `GdkGLContext` must not be realized or made current prior to calling this function. + - a `GdkGLContext` + a `GdkGLContext` - whether the context should be forward-compatible + whether the context should be forward-compatible - - Sets the major and minor version of OpenGL to request. + + Sets the major and minor version of OpenGL to request. Setting @major and @minor to zero will use the default values. The `GdkGLContext` must not be realized or made current prior to calling this function. + - a `GdkGLContext` + a `GdkGLContext` - the major version to request + the major version to request - the minor version to request + the minor version to request - Requests that GDK create an OpenGL ES context instead of an OpenGL one. + Requests that GDK create an OpenGL ES context instead of an OpenGL one. Not all platforms support OpenGL ES. @@ -6429,24 +9985,37 @@ is realized. You should check the return value of [method@Gdk.GLContext.get_use_es] after calling [method@Gdk.GLContext.realize] to decide whether to use the OpenGL or OpenGL ES API, extensions, or shaders. + - a `GdkGLContext` + a `GdkGLContext` - whether the context should use OpenGL ES instead of OpenGL, + whether the context should use OpenGL ES instead of OpenGL, or -1 to allow auto-detection - - - Always %NULL + + + Always %NULL As many contexts can share data now and no single shared context exists anymore, this function has been deprecated and now always returns %NULL. @@ -6455,22 +10024,53 @@ anymore, this function has been deprecated and now always returns %NULL. - - Error enumeration for `GdkGLContext`. - - OpenGL support is not available + + Error enumeration for `GdkGLContext`. + + OpenGL support is not available - - The requested visual format is not supported + + The requested visual format is not supported - - The requested profile is not supported + + The requested profile is not supported - - The shader compilation failed + + The shader compilation failed - - The shader linking failed + + The shader linking failed @@ -6478,243 +10078,421 @@ anymore, this function has been deprecated and now always returns %NULL. - - A GdkTexture representing a GL texture object. + + A GdkTexture representing a GL texture object. + - Creates a new texture for an existing GL texture. + Creates a new texture for an existing GL texture. Note that the GL texture must not be modified until @destroy is called, which will happen when the GdkTexture object is finalized, or due to an explicit call of [method@Gdk.GLTexture.release]. + - A newly-created `GdkTexture` + A newly-created `GdkTexture` - a `GdkGLContext` + a `GdkGLContext` - the ID of a texture that was created with @context + the ID of a texture that was created with @context - the nominal width of the texture + the nominal width of the texture - the nominal height of the texture + the nominal height of the texture - a destroy notify that will be called when the GL resources + a destroy notify that will be called when the GL resources are released - - data that gets passed to @destroy + + data that gets passed to @destroy - Releases the GL resources held by a `GdkGLTexture`. + Releases the GL resources held by a `GdkGLTexture`. The texture contents are still available via the [method@Gdk.Texture.download] function, after this function has been called. + - a `GdkTexture` wrapping a GL texture + a `GdkTexture` wrapping a GL texture - - + + + + + - + + - - An event related to a broken windowing system grab. - - Extracts the grab surface from a grab broken event. + + An event related to a broken windowing system grab. + + Extracts the grab surface from a grab broken event. + - the grab surface of @event + the grab surface of @event - a grab broken event + a grab broken event - - Checks whether the grab broken event is for an implicit grab. + + Checks whether the grab broken event is for an implicit grab. + - %TRUE if the an implicit grab was broken + %TRUE if the an implicit grab was broken - a grab broken event + a grab broken event - - Defines the reference point of a surface and is used in `GdkPopupLayout`. - - the reference point is at the top left corner. + + Defines the reference point of a surface and is used in `GdkPopupLayout`. + + the reference point is at the top left corner. - - the reference point is in the middle of the top edge. + + the reference point is in the middle of the top edge. - - the reference point is at the top right corner. + + the reference point is at the top right corner. - - the reference point is at the middle of the left edge. + + the reference point is at the middle of the left edge. - - the reference point is at the center of the surface. + + the reference point is at the center of the surface. - - the reference point is at the middle of the right edge. + + the reference point is at the middle of the right edge. - - the reference point is at the lower left corner. + + the reference point is at the lower left corner. - - the reference point is at the middle of the lower edge. + + the reference point is at the middle of the lower edge. - - the reference point is at the lower right corner. + + the reference point is at the lower right corner. - - the reference point is at the top left corner of the + + the reference point is at the top left corner of the surface itself, ignoring window manager decorations. - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -6722,7046 +10500,11650 @@ function has been called. - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - - An enumeration describing the type of an input device in general terms. - - the device is a mouse. (This will be reported for the core + + An enumeration describing the type of an input device in general terms. + + the device is a mouse. (This will be reported for the core pointer, even if it is something else, such as a trackball.) - - the device is a stylus of a graphics tablet or similar device. + + the device is a stylus of a graphics tablet or similar device. - - the device is a keyboard. + + the device is a keyboard. - - the device is a direct-input touch device, such + + the device is a direct-input touch device, such as a touchscreen or tablet - - the device is an indirect touch device, such + + the device is an indirect touch device, such as a touchpad - - the device is a trackpoint + + the device is a trackpoint - - the device is a "pad", a collection of buttons, + + the device is a "pad", a collection of buttons, rings and strips found in drawing tablets + + + + - + + + - + + - + + + - + + - + + - + + - + + + - + + - + + - + + - + + + + - + + + + + + + - + + + - + + + - + + + + + + + + + + + + + + + + - + + - + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + - + + + + + + + + + - + + - + + + + + + + + + + + + + + - + + + - + + + + - + + - + + - + + - + + - + + - + + + - + + - + + - + + + + - + + - + + - + + - + + - + + - + + - + + + - + + - + + + - + + + - + + - + + - + + + + - + + - + + + + - + + - + + - + + + - + + + - + + + + - + + - + + - + + - + + - + + - + + + - + + - + + + - + + + + - + + - + + + + - + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + - + + + + + + - + + + - + + + - + + - + + - + + + + + + + + + - + + + + + + + + + + - + + + + + - + + - + + + + + - + + + - + + + + - + + - + + - + + + - + + + + + + + - + + + + - + + - + + + - + + - + + + + + - + + + + - + + - + + - + + - + + + - + + + - + + - + + - + + - + + - + + - + + + - + + + - + + - + + - + + + + - + + + + - + + - + + + + - + + - + + - + + + - + + + + + + + - + + + + - + + - + + + - + + - + + + - + + + + + + - + + - + + - + + - + + + - + + + - + + - + + - + + - + + - + + - + + + - + + + - + + - + + - + + + + - + + + + - + + - + + + + + + + + - + + + + + + + + + + + + + + - + + - + + - + + - + + - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + - + + + + - + + + - + + - + + + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + - + + + + + - + + - + + + - + + + + - + + - + + - + + + - + + + + + + - + + - + + - + + + + + + + + + - + + - + + - + + + + - + + + - + + + + + - + + - + + + - + + - + + + - + + + - + + - + + - + + + - + + + + + + - + + - + + - + + + + + + + - + + + + - + + - + + - + + - + + + + + + + + + - + + - + + - + + - + + - + + - + + + + + + - + + - + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + - + + - + + + + - + + + + - + + - + + + - + + + + + + + + + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - + + + + + - + + + - + + + + + + + - + + + - + + - + + - + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - + + + + - + + + - + + + + + - + + - + + - + + - + + - + + - + + + + - + + + + + + + + + - + + + + + + - + + - + + - + + - + + - + + + + - + + + - + + + + + + + + + - + + + + - + + - + + + + + + + + + + + - + + - + + - + + - + + - + + + - + + - + + + + + - + + - + + - + + + - + + + + + + + + + - + + - + + + + + + + + - + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + - + + - + + - + + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - + + - + + + + - + + - + + - + + + + + + + + + + + - + + - + + - + + + - + + + + - + + + + + + + + - + + + + + + + - + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - + + + + - + + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + - + + + - + + - + + - + + - + + - + + - + + + + + + - + + - + + - + + - + + - + + - + + + - + + - + + + + + - + + - + + + + - + + + - + + + + - + + + - + + - + + - + + + + - + + + + - + + + + + - + + - + + - + + - + + - + + + + + + + + - + + - + + + + + + + + + - + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + - + + - + + - + + + + + + + + + + + + - + + + + + - + + - + + - + + + - + + - + + + - + + - + + - + + + - + + - + + + + + + + + + + + + + + + + + + + - + + + + - + + + + + + + + - + + - + + + + - + + - + + + + + + + + + + - + + + + + + + + + + + + + - + + + + + + + + + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + + - + + - + + - + + + - + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + - + + + + + + + - + + + + - + + + + + + + + + + + + + + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + - + + + - + + - + + - + + + - + + - + + - + + + + + + + + - + + + - + + - + + - + + + - + + - + + + - + + - + + - + + + + - + + - + + + + + + + + + - + + + - + + - + + + + + + + + + + + + + + - + + - + + - + + - + + - + + + + + - + + - + + + + + + + + - + + - + + - + + - + + + + + - + + - + + + - + + - + + + + + + + + + + + + - + + + + - + + - + + - + + - + + - + + + + - + + - + + + - + + - + + - + + + + + + + + + + + - + + - + + - + + + + + + - + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + - + + + + + + + - + + - + + + + + + + + + + + + - + + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - + + + - + + + - + + + - + + - + + + + + + + + + + + + + + + + + - + + + + - + + - + + - + + + + + - + + + + + - + + + + + - + + - + + + + + + + - + + + + + + + + + - + + + + + + + - + + - + + + - + + - + + - + + + - + + + + + + + + + + + + - + + - + + - + + - + + - + + + - + + + + + + + - + + - + + - + + + - + + + + + + + + - + + + + + - + + + - + + - + + + + + + + + + + + + - + + - + + + + - + + + - + + + + - + + - + + + + + + - + + + + + + + + + + + - + + + + - + + - + + - + + - + + - + + + - + + + + + + + + + + + - + + + + + - + + - + + - + + - + + - + + + - + + - + + - + + - + + + - + + + - + + + + + + + + + + - + + + + + - + + + - + + - + + - + + + + - + + - + + - + + - + + - + + - + + - + + + - + + + - + + + + - + + + + + + + + + + - + + + + + - + + - + + - + + + - + + + + + + + + + - + + - + + + + + + + + + + - + + + + + + - + + - + + + + + + + + - + + + + + + + + + + + - + + - + + + - - An event related to a key-based device. - - Extracts the consumed modifiers from a key event. + + An event related to a key-based device. + + Extracts the consumed modifiers from a key event. + - the consumed modifiers or @event + the consumed modifiers or @event - a key event + a key event - Extracts the keycode from a key event. + Extracts the keycode from a key event. + - the keycode of @event + the keycode of @event - a key event + a key event - Extracts the keyval from a key event. + Extracts the keyval from a key event. + - the keyval of @event + the keyval of @event - a key event + a key event - Extracts the layout from a key event. + Extracts the layout from a key event. + - the layout of @event + the layout of @event - a key event + a key event - Extracts the shift level from a key event. + Extracts the shift level from a key event. + - the shift level of @event + the shift level of @event - a key event + a key event - Gets a keyval and modifier combination that will match + Gets a keyval and modifier combination that will match the event. See [method@Gdk.KeyEvent.matches]. + - %TRUE on success + %TRUE on success - a key `GdkEvent` + a key `GdkEvent` - - return location for a keyval + + return location for a keyval - - return location for modifiers + + return location for modifiers - Extracts whether the key event is for a modifier key. + Extracts whether the key event is for a modifier key. + - %TRUE if the @event is for a modifier key + %TRUE if the @event is for a modifier key - a key event + a key event - Matches a key event against a keyval and modifiers. + Matches a key event against a keyval and modifiers. This is typically used to trigger keyboard shortcuts such as Ctrl-C. @@ -13769,83 +22151,137 @@ Partial matches are possible where the combination matches if the currently active group is ignored. Note that we ignore Caps Lock for matching. + - a `GdkKeyMatch` value describing whether @event matches + a `GdkKeyMatch` value describing whether @event matches - a key `GdkEvent` + a key `GdkEvent` - the keyval to match + the keyval to match - the modifiers to match + the modifiers to match - - Describes how well an event matches a given keyval and modifiers. + + Describes how well an event matches a given keyval and modifiers. `GdkKeyMatch` values are returned by [method@Gdk.KeyEvent.matches]. - - The key event does not match + + The key event does not match - - The key event matches if keyboard state + + The key event matches if keyboard state (specifically, the currently active group) is ignored - - The key event matches + + The key event matches - A `GdkKeymapKey` is a hardware key that can be mapped to a keyval. + A `GdkKeymapKey` is a hardware key that can be mapped to a keyval. + - the hardware keycode. This is an identifying number for a + the hardware keycode. This is an identifying number for a physical key. - indicates movement in a horizontal direction. Usually groups are used + indicates movement in a horizontal direction. Usually groups are used for two different languages. In group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters. - indicates which symbol on the key will be used, in a vertical direction. - So on a standard US keyboard, the key with the number “1” on it also has the + indicates which symbol on the key will be used, in a vertical direction. + So on a standard US keyboard, the key with the number “1” on it also has the exclamation point ("!") character on it. The level indicates whether to use - the “1” or the “!” symbol. The letter keys are considered to have a lowercase + the “1” or the “!” symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed. - + + - - A mask covering all entries in `GdkModifierType`. + + A mask covering all entries in `GdkModifierType`. + - + + - - `GdkMemoryFormat` describes a format that bytes can have in memory. + + `GdkMemoryFormat` describes a format that bytes can have in memory. It describes formats by listing the contents of the memory passed to it. So GDK_MEMORY_A8R8G8B8 will be 1 byte (8 bits) of alpha, followed by a @@ -13856,80 +22292,164 @@ on architectures with different endiannesses. Its naming is modelled after [VkFormat](https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#VkFormat) for details). - - 4 bytes; for blue, green, red, alpha. + + 4 bytes; for blue, green, red, alpha. The color values are premultiplied with the alpha value. - - 4 bytes; for alpha, red, green, blue. + + 4 bytes; for alpha, red, green, blue. The color values are premultiplied with the alpha value. - - 4 bytes; for red, green, blue, alpha + + 4 bytes; for red, green, blue, alpha The color values are premultiplied with the alpha value. - - 4 bytes; for blue, green, red, alpha. + + 4 bytes; for blue, green, red, alpha. - - 4 bytes; for alpha, red, green, blue. + + 4 bytes; for alpha, red, green, blue. - - 4 bytes; for red, green, blue, alpha. + + 4 bytes; for red, green, blue, alpha. - - 4 bytes; for alpha, blue, green, red. + + 4 bytes; for alpha, blue, green, red. - - 3 bytes; for red, green, blue. The data is opaque. + + 3 bytes; for red, green, blue. The data is opaque. - - 3 bytes; for blue, green, red. The data is opaque. + + 3 bytes; for blue, green, red. The data is opaque. - - The number of formats. This value will change as + + The number of formats. This value will change as more formats get added, so do not rely on its concrete integer. - - A `GdkTexture` representing image data in memory. + + A `GdkTexture` representing image data in memory. + - Creates a new texture for a blob of image data. + Creates a new texture for a blob of image data. The `GBytes` must contain @stride x @height pixels in the given format. + - A newly-created `GdkTexture` + A newly-created `GdkTexture` - the width of the texture + the width of the texture - the height of the texture + the height of the texture - the format of the data + the format of the data - the `GBytes` containing the pixel data + the `GBytes` containing the pixel data - rowstride for the data + rowstride for the data - - - Flags to indicate the state of modifier keys and mouse buttons + + + + + Flags to indicate the state of modifier keys and mouse buttons in events. Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, @@ -13938,398 +22458,692 @@ Apple, CapsLock or ShiftLock. Note that GDK may add internal values to events which include values outside of this enumeration. Your code should preserve and ignore them. You can use %GDK_MODIFIER_MASK to remove all private values. - - the Shift key. + + the Shift key. - - a Lock key (depending on the modifier mapping of the + + a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock). - - the Control key. + + the Control key. - - the fourth modifier key (it depends on the modifier + + the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key). - - the first mouse button. + + the first mouse button. - - the second mouse button. + + the second mouse button. - - the third mouse button. + + the third mouse button. - - the fourth mouse button. + + the fourth mouse button. - - the fifth mouse button. + + the fifth mouse button. - - the Super modifier + + the Super modifier - - the Hyper modifier + + the Hyper modifier - - the Meta modifier + + the Meta modifier - - `GdkMonitor` objects represent the individual outputs that are + + `GdkMonitor` objects represent the individual outputs that are associated with a `GdkDisplay`. `GdkDisplay` keeps a `GListModel` to enumerate and monitor monitors with [method@Gdk.Display.get_monitors]. You can use [method@Gdk.Display.get_monitor_at_surface] to find a particular monitor. + - Gets the name of the monitor's connector, if available. + Gets the name of the monitor's connector, if available. + - the name of the connector + the name of the connector - a `GdkMonitor` + a `GdkMonitor` - Gets the display that this monitor belongs to. + Gets the display that this monitor belongs to. + - the display + the display - a `GdkMonitor` + a `GdkMonitor` - Retrieves the size and position of the monitor within the + Retrieves the size and position of the monitor within the display coordinate space. -The returned geometry is in ”application pixels”, not in -”device pixels” (see [method@Gdk.Monitor.get_scale_factor]). +The returned geometry is in ”application pixels”, not in +”device pixels” (see [method@Gdk.Monitor.get_scale_factor]). + - a `GdkMonitor` + a `GdkMonitor` - - a `GdkRectangle` to be filled with the monitor geometry + + a `GdkRectangle` to be filled with the monitor geometry - Gets the height in millimeters of the monitor. + Gets the height in millimeters of the monitor. + - the physical height of the monitor + the physical height of the monitor - a `GdkMonitor` + a `GdkMonitor` - + - Gets the name or PNP ID of the monitor's manufacturer. + Gets the name or PNP ID of the monitor's manufacturer. Note that this value might also vary depending on actual display backend. The PNP ID registry is located at [https://uefi.org/pnp_id_list](https://uefi.org/pnp_id_list). + - the name of the manufacturer + the name of the manufacturer - a `GdkMonitor` + a `GdkMonitor` - Gets the string identifying the monitor model, if available. + Gets the string identifying the monitor model, if available. + - the monitor model + the monitor model - a `GdkMonitor` + a `GdkMonitor` - + - Gets the refresh rate of the monitor, if available. + Gets the refresh rate of the monitor, if available. The value is in milli-Hertz, so a refresh rate of 60Hz is returned as 60000. + - the refresh rate in milli-Hertz, or 0 + the refresh rate in milli-Hertz, or 0 - a `GdkMonitor` + a `GdkMonitor` - + - Gets the internal scale factor that maps from monitor coordinates + Gets the internal scale factor that maps from monitor coordinates to device pixels. On traditional systems this is 1, but on very high density outputs it can be a higher value (often 2). This can be used if you want to create pixel based data for a -particular monitor, but most of the time you’re drawing to a surface +particular monitor, but most of the time you’re drawing to a surface where it is better to use [method@Gdk.Surface.get_scale_factor] instead. + - the scale factor + the scale factor - a `GdkMonitor` + a `GdkMonitor` - + - Gets information about the layout of red, green and blue + Gets information about the layout of red, green and blue primaries for pixels. + - the subpixel layout + the subpixel layout - a `GdkMonitor` + a `GdkMonitor` - Gets the width in millimeters of the monitor. + Gets the width in millimeters of the monitor. + - the physical width of the monitor + the physical width of the monitor - a `GdkMonitor` + a `GdkMonitor` - Returns %TRUE if the @monitor object corresponds to a + Returns %TRUE if the @monitor object corresponds to a physical monitor. The @monitor becomes invalid when the physical monitor is unplugged or removed. + - %TRUE if the object corresponds to a physical monitor + %TRUE if the object corresponds to a physical monitor - a `GdkMonitor` + a `GdkMonitor` - - The connector name. + + The connector name. - - - The `GdkDisplay` of the monitor. + + + The `GdkDisplay` of the monitor. - - The geometry of the monitor. + + The geometry of the monitor. - - The height of the monitor, in millimeters. + + The height of the monitor, in millimeters. - - The manufacturer name. + + The manufacturer name. - The model name. + The model name. - - The refresh rate, in milli-Hertz. + + The refresh rate, in milli-Hertz. - - The scale factor. + + The scale factor. - - The subpixel layout. + + The subpixel layout. - Whether the object is still valid. + Whether the object is still valid. - - The width of the monitor, in millimeters. + + The width of the monitor, in millimeters. - Emitted when the output represented by @monitor gets disconnected. + Emitted when the output represented by @monitor gets disconnected. - - - An event related to a pointer or touch device motion. + + + + + An event related to a pointer or touch device motion. - - Specifies the kind of crossing for enter and leave events. + + Specifies the kind of crossing for enter and leave events. See the X11 protocol specification of LeaveNotify for full details of crossing event generation. - - the surface is entered from an ancestor or + + the surface is entered from an ancestor or left towards an ancestor. - - the pointer moves between an ancestor and an + + the pointer moves between an ancestor and an inferior of the surface. - - the surface is entered from an inferior or + + the surface is entered from an inferior or left towards an inferior. - - the surface is entered from or left towards + + the surface is entered from or left towards a surface which is neither an ancestor nor an inferior. - - the pointer moves between two surfaces + + the pointer moves between two surfaces which are not ancestors of each other and the surface is part of the ancestor chain between one of these surfaces and their least common ancestor. - - an unknown type of enter/leave event occurred. + + an unknown type of enter/leave event occurred. - This is the priority that the idle handler processing surface updates + This is the priority that the idle handler processing surface updates is given in the main loop. + - - An event related to a pad-based device. - - Extracts the information from a pad strip or ring event. + + An event related to a pad-based device. + + Extracts the information from a pad strip or ring event. + - a pad strip or ring event + a pad strip or ring event - - Return location for the axis index + + Return location for the axis index - - Return location for the axis value + + Return location for the axis value - Extracts information about the pressed button from + Extracts information about the pressed button from a pad event. + - the button of @event + the button of @event - a pad button event + a pad button event - - Extracts group and mode information from a pad event. + + Extracts group and mode information from a pad event. + - a pad event + a pad event - - return location for the group + + return location for the group - - return location for the mode + + return location for the mode - - `GdkPaintable` is a simple interface used by GTK to represent content that + + `GdkPaintable` is a simple interface used by GTK to represent content that can be painted. The content of a `GdkPaintable` can be painted anywhere at any size @@ -14374,66 +23188,93 @@ useful for implementing subclasses and should not be used by applications: [method@Gdk.Paintable.invalidate_contents], [method@Gdk.Paintable.invalidate_size], [func@Gdk.Paintable.new_empty]. + - Returns a paintable that has the given intrinsic size and draws nothing. + Returns a paintable that has the given intrinsic size and draws nothing. This is often useful for implementing the [vfunc@Gdk.Paintable.get_current_image] virtual function when the paintable is in an incomplete state (like a [class@Gtk.MediaStream] before receiving the first frame). + - a `GdkPaintable` + a `GdkPaintable` - The intrinsic width to report. Can be 0 for no width. + The intrinsic width to report. Can be 0 for no width. - The intrinsic height to report. Can be 0 for no height. + The intrinsic height to report. Can be 0 for no height. - Gets an immutable paintable for the current contents displayed by @paintable. + Gets an immutable paintable for the current contents displayed by @paintable. This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation. If the @paintable is already immutable, it will return itself. + - An immutable paintable for the current + An immutable paintable for the current contents of @paintable - a `GdkPaintable` + a `GdkPaintable` - Get flags for the paintable. + Get flags for the paintable. This is oftentimes useful for optimizations. See [flags@Gdk.PaintableFlags] for the flags and what they mean. + - The `GdkPaintableFlags` for this paintable + The `GdkPaintableFlags` for this paintable - a `GdkPaintable` + a `GdkPaintable` - - Gets the preferred aspect ratio the @paintable would like to be displayed at. + + Gets the preferred aspect ratio the @paintable would like to be displayed at. The aspect ratio is the width divided by the height, so a value of 0.5 means that the @paintable prefers to be displayed twice as high as it @@ -14450,19 +23291,27 @@ should conform to those values, though that is not required. If the @paintable does not have a preferred aspect ratio, it returns 0. Negative values are never returned. + - the intrinsic aspect ratio of @paintable or 0 if none. + the intrinsic aspect ratio of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - - Gets the preferred height the @paintable would like to be displayed at. + + Gets the preferred height the @paintable would like to be displayed at. Consumers of this interface can use this to reserve enough space to draw the paintable. @@ -14472,19 +23321,26 @@ values that may be passed to [method@Gdk.Paintable.snapshot]. If the @paintable does not have a preferred height, it returns 0. Negative values are never returned. + - the intrinsic height of @paintable or 0 if none. + the intrinsic height of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - Gets the preferred width the @paintable would like to be displayed at. + Gets the preferred width the @paintable would like to be displayed at. Consumers of this interface can use this to reserve enough space to draw the paintable. @@ -14494,47 +23350,66 @@ values that may be passed to [method@Gdk.Paintable.snapshot]. If the @paintable does not have a preferred width, it returns 0. Negative values are never returned. + - the intrinsic width of @paintable or 0 if none. + the intrinsic width of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - Snapshots the given paintable with the given @width and @height. + Snapshots the given paintable with the given @width and @height. The paintable is drawn at the current (0,0) offset of the @snapshot. If @width and @height are not larger than zero, this function will do nothing. + - a `GdkPaintable` + a `GdkPaintable` - a `GdkSnapshot` to snapshot to + a `GdkSnapshot` to snapshot to - width to snapshot in + width to snapshot in - height to snapshot in + height to snapshot in - - Compute a concrete size for the `GdkPaintable`. + + Compute a concrete size for the `GdkPaintable`. Applies the sizing algorithm outlined in the [CSS Image spec](https://drafts.csswg.org/css-images-3/#default-sizing) @@ -14544,82 +23419,121 @@ It is not necessary to call this function when both @specified_width and @specified_height are known, but it is useful to call this function in GtkWidget:measure implementations to compute the other dimension when only one dimension is given. + - a `GdkPaintable` + a `GdkPaintable` - the width @paintable could be drawn into or + the width @paintable could be drawn into or 0.0 if unknown - the height @paintable could be drawn into or + the height @paintable could be drawn into or 0.0 if unknown - the width @paintable would be drawn into if + the width @paintable would be drawn into if no other constraints were given - the height @paintable would be drawn into if + the height @paintable would be drawn into if no other constraints were given - - will be set to the concrete width computed + + will be set to the concrete width computed - - will be set to the concrete height computed + + will be set to the concrete height computed - - Gets an immutable paintable for the current contents displayed by @paintable. + + Gets an immutable paintable for the current contents displayed by @paintable. This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation. If the @paintable is already immutable, it will return itself. + - An immutable paintable for the current + An immutable paintable for the current contents of @paintable - a `GdkPaintable` + a `GdkPaintable` - Get flags for the paintable. + Get flags for the paintable. This is oftentimes useful for optimizations. See [flags@Gdk.PaintableFlags] for the flags and what they mean. + - The `GdkPaintableFlags` for this paintable + The `GdkPaintableFlags` for this paintable - a `GdkPaintable` + a `GdkPaintable` - - Gets the preferred aspect ratio the @paintable would like to be displayed at. + + Gets the preferred aspect ratio the @paintable would like to be displayed at. The aspect ratio is the width divided by the height, so a value of 0.5 means that the @paintable prefers to be displayed twice as high as it @@ -14636,19 +23550,27 @@ should conform to those values, though that is not required. If the @paintable does not have a preferred aspect ratio, it returns 0. Negative values are never returned. + - the intrinsic aspect ratio of @paintable or 0 if none. + the intrinsic aspect ratio of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - - Gets the preferred height the @paintable would like to be displayed at. + + Gets the preferred height the @paintable would like to be displayed at. Consumers of this interface can use this to reserve enough space to draw the paintable. @@ -14658,19 +23580,27 @@ values that may be passed to [method@Gdk.Paintable.snapshot]. If the @paintable does not have a preferred height, it returns 0. Negative values are never returned. + - the intrinsic height of @paintable or 0 if none. + the intrinsic height of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - - Gets the preferred width the @paintable would like to be displayed at. + + Gets the preferred width the @paintable would like to be displayed at. Consumers of this interface can use this to reserve enough space to draw the paintable. @@ -14680,19 +23610,27 @@ values that may be passed to [method@Gdk.Paintable.snapshot]. If the @paintable does not have a preferred width, it returns 0. Negative values are never returned. + - the intrinsic width of @paintable or 0 if none. + the intrinsic width of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - - Called by implementations of `GdkPaintable` to invalidate their contents. + + Called by implementations of `GdkPaintable` to invalidate their contents. Unless the contents are invalidated, implementations must guarantee that multiple calls of [method@Gdk.Paintable.snapshot] produce the same output. @@ -14702,18 +23640,24 @@ signal. If a @paintable reports the %GDK_PAINTABLE_STATIC_CONTENTS flag, it must not call this function. + - a `GdkPaintable` + a `GdkPaintable` - - Called by implementations of `GdkPaintable` to invalidate their size. + + Called by implementations of `GdkPaintable` to invalidate their size. As long as the size is not invalidated, @paintable must return the same values for its intrinsic width, height and aspect ratio. @@ -14723,46 +23667,62 @@ signal. If a @paintable reports the %GDK_PAINTABLE_STATIC_SIZE flag, it must not call this function. + - a `GdkPaintable` + a `GdkPaintable` - Snapshots the given paintable with the given @width and @height. + Snapshots the given paintable with the given @width and @height. The paintable is drawn at the current (0,0) offset of the @snapshot. If @width and @height are not larger than zero, this function will do nothing. + - a `GdkPaintable` + a `GdkPaintable` - a `GdkSnapshot` to snapshot to + a `GdkSnapshot` to snapshot to - width to snapshot in + width to snapshot in - height to snapshot in + height to snapshot in - Emitted when the contents of the @paintable change. + Emitted when the contents of the @paintable change. Examples for such an event would be videos changing to the next frame or the icon theme for an icon changing. @@ -14771,7 +23731,9 @@ the icon theme for an icon changing. - Emitted when the intrinsic size of the @paintable changes. + Emitted when the intrinsic size of the @paintable changes. This means the values reported by at least one of [method@Gdk.Paintable.get_intrinsic_width], @@ -14786,23 +23748,42 @@ the contents of a toplevel surface being resized. - - Flags about a paintable object. + + Flags about a paintable object. Implementations use these for optimizations such as caching. - - The size is immutable. + + The size is immutable. The [signal@GdkPaintable::invalidate-size] signal will never be emitted. - - The content is immutable. + + The content is immutable. The [signal@GdkPaintable::invalidate-contents] signal will never be emitted. - - The list of functions that can be implemented for the `GdkPaintable` + + The list of functions that can be implemented for the `GdkPaintable` interface. Note that apart from the [vfunc@Gdk.PaintableInterface.snapshot] function, @@ -14811,29 +23792,39 @@ is a good idea to implement [vfunc@Gdk.PaintableInterface.get_current_image] for non-static paintables and [vfunc@Gdk.PaintableInterface.get_flags] if the image is not dynamic as the default implementation returns no flags and that will make the implementation likely quite slow. + + - a `GdkPaintable` + a `GdkPaintable` - a `GdkSnapshot` to snapshot to + a `GdkSnapshot` to snapshot to - width to snapshot in + width to snapshot in - height to snapshot in + height to snapshot in @@ -14841,14 +23832,19 @@ that will make the implementation likely quite slow. + - An immutable paintable for the current + An immutable paintable for the current contents of @paintable - a `GdkPaintable` + a `GdkPaintable` @@ -14856,13 +23852,18 @@ that will make the implementation likely quite slow. + - The `GdkPaintableFlags` for this paintable + The `GdkPaintableFlags` for this paintable - a `GdkPaintable` + a `GdkPaintable` @@ -14870,13 +23871,18 @@ that will make the implementation likely quite slow. + - the intrinsic width of @paintable or 0 if none. + the intrinsic width of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` @@ -14884,13 +23890,18 @@ that will make the implementation likely quite slow. + - the intrinsic height of @paintable or 0 if none. + the intrinsic height of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` @@ -14898,116 +23909,174 @@ that will make the implementation likely quite slow. + - the intrinsic aspect ratio of @paintable or 0 if none. + the intrinsic aspect ratio of @paintable or 0 if none. - a `GdkPaintable` + a `GdkPaintable` - - A `GdkPopup` is a surface that is attached to another surface. + + A `GdkPopup` is a surface that is attached to another surface. The `GdkPopup` is positioned relative to its parent surface. `GdkPopup`s are typically used to implement menus and similar popups. They can be modal, which is indicated by the [property@GdkPopup:autohide] property. + - Returns whether this popup is set to hide on outside clicks. + Returns whether this popup is set to hide on outside clicks. + - %TRUE if @popup will autohide + %TRUE if @popup will autohide - a `GdkPopup` + a `GdkPopup` - Returns the parent surface of a popup. + Returns the parent surface of a popup. + - the parent surface + the parent surface - a `GdkPopup` + a `GdkPopup` - Obtains the position of the popup relative to its parent. + Obtains the position of the popup relative to its parent. + - the X coordinate of @popup position + the X coordinate of @popup position - a `GdkPopup` + a `GdkPopup` - Obtains the position of the popup relative to its parent. + Obtains the position of the popup relative to its parent. + - the Y coordinate of @popup position + the Y coordinate of @popup position - a `GdkPopup` + a `GdkPopup` - Gets the current popup rectangle anchor. + Gets the current popup rectangle anchor. The value returned may change after calling [method@Gdk.Popup.present], or after the [signal@Gdk.Surface::layout] signal is emitted. + - the current rectangle anchor value of @popup + the current rectangle anchor value of @popup - a `GdkPopup` + a `GdkPopup` - - Gets the current popup surface anchor. + + Gets the current popup surface anchor. The value returned may change after calling [method@Gdk.Popup.present], or after the [signal@Gdk.Surface::layout] signal is emitted. + - the current surface anchor value of @popup + the current surface anchor value of @popup - a `GdkPopup` + a `GdkPopup` - Present @popup after having processed the `GdkPopupLayout` rules. + Present @popup after having processed the `GdkPopupLayout` rules. If the popup was previously now showing, it will be showed, otherwise it will change position according to @layout. @@ -15022,43 +24091,75 @@ and [method@Gdk.Popup.get_surface_anchor] to get the resulting anchors. Presenting may fail, for example if the @popup is set to autohide and is immediately hidden upon being presented. If presenting failed, the [signal@Gdk.Surface::layout] signal will not me emitted. + - %FALSE if it failed to be presented, otherwise %TRUE. + %FALSE if it failed to be presented, otherwise %TRUE. - the `GdkPopup` to show + the `GdkPopup` to show - the unconstrained popup width to layout + the unconstrained popup width to layout - the unconstrained popup height to layout + the unconstrained popup height to layout - the `GdkPopupLayout` object used to layout + the `GdkPopupLayout` object used to layout - + - Whether to hide on outside clicks. + Whether to hide on outside clicks. - + - The parent surface. + The parent surface. - - - The `GdkPopupLayout` struct contains information that is + + + + + The `GdkPopupLayout` struct contains information that is necessary position a [iface@Gdk.Popup] relative to its parent. The positioning requires a negotiation with the windowing system, @@ -15091,8 +24192,11 @@ after the popup has been presented. This can be used to adjust the rendering. For example, [class@Gtk.Popover] changes its arrow position accordingly. But you have to be careful avoid changing the size of the popover, or it has to be presented again. + - Create a popup layout description. + Create a popup layout description. Used together with [method@Gdk.Popup.present] to describe how a popup surface should be placed and behave on-screen. @@ -15104,487 +24208,741 @@ and surface to pin together. The position of @anchor_rect's anchor point can optionally be offset using [method@Gdk.PopupLayout.set_offset], which is equivalent to offsetting the position of surface. + - newly created instance of `GdkPopupLayout` + newly created instance of `GdkPopupLayout` - the anchor `GdkRectangle` to align @surface with + the anchor `GdkRectangle` to align @surface with - the point on @anchor_rect to align with @surface's anchor point + the point on @anchor_rect to align with @surface's anchor point - the point on @surface to align with @rect's anchor point + the point on @surface to align with @rect's anchor point - Makes a copy of @layout. + Makes a copy of @layout. + - a copy of @layout. + a copy of @layout. - a `GdkPopupLayout` + a `GdkPopupLayout` - Check whether @layout and @other has identical layout properties. + Check whether @layout and @other has identical layout properties. + - %TRUE if @layout and @other have identical layout properties, + %TRUE if @layout and @other have identical layout properties, otherwise %FALSE. - a `GdkPopupLayout` + a `GdkPopupLayout` - another `GdkPopupLayout` + another `GdkPopupLayout` - - Get the `GdkAnchorHints`. + + Get the `GdkAnchorHints`. + - the `GdkAnchorHints` + the `GdkAnchorHints` - a `GdkPopupLayout` + a `GdkPopupLayout` - - Get the anchor rectangle. + + Get the anchor rectangle. + - The anchor rectangle + The anchor rectangle - a `GdkPopupLayout` + a `GdkPopupLayout` - Retrieves the offset for the anchor rectangle. + Retrieves the offset for the anchor rectangle. + - a `GdkPopupLayout` + a `GdkPopupLayout` - - return location for the delta X coordinate + + return location for the delta X coordinate - - return location for the delta Y coordinate + + return location for the delta Y coordinate - - Returns the anchor position on the anchor rectangle. + + Returns the anchor position on the anchor rectangle. + - the anchor on the anchor rectangle. + the anchor on the anchor rectangle. - a `GdkPopupLayout` + a `GdkPopupLayout` - - Obtains the shadow widths of this layout. + + Obtains the shadow widths of this layout. + - a `GdkPopupLayout` + a `GdkPopupLayout` - - return location for the left shadow width + + return location for the left shadow width - - return location for the right shadow width + + return location for the right shadow width - - return location for the top shadow width + + return location for the top shadow width - - return location for the bottom shadow width + + return location for the bottom shadow width - - Returns the anchor position on the popup surface. + + Returns the anchor position on the popup surface. + - the anchor on the popup surface. + the anchor on the popup surface. - a `GdkPopupLayout` + a `GdkPopupLayout` - Increases the reference count of @value. + Increases the reference count of @value. + - the same @layout + the same @layout - a `GdkPopupLayout` + a `GdkPopupLayout` - - Set new anchor hints. + + Set new anchor hints. The set @anchor_hints determines how @surface will be moved if the anchor points cause it to move off-screen. For example, %GDK_ANCHOR_FLIP_X will replace %GDK_GRAVITY_NORTH_WEST with %GDK_GRAVITY_NORTH_EAST and vice versa if @surface extends beyond the left or right edges of the monitor. + - a `GdkPopupLayout` + a `GdkPopupLayout` - the new `GdkAnchorHints` + the new `GdkAnchorHints` - - Set the anchor rectangle. + + Set the anchor rectangle. + - a `GdkPopupLayout` + a `GdkPopupLayout` - the new anchor rectangle + the new anchor rectangle - Offset the position of the anchor rectangle with the given delta. + Offset the position of the anchor rectangle with the given delta. + - a `GdkPopupLayout` + a `GdkPopupLayout` - x delta to offset the anchor rectangle with + x delta to offset the anchor rectangle with - y delta to offset the anchor rectangle with + y delta to offset the anchor rectangle with - - Set the anchor on the anchor rectangle. + + Set the anchor on the anchor rectangle. + - a `GdkPopupLayout` + a `GdkPopupLayout` - the new rect anchor + the new rect anchor - - Sets the shadow width of the popup. + + Sets the shadow width of the popup. The shadow width corresponds to the part of the computed surface size that would consist of the shadow margin surrounding the window, would there be any. + - a `GdkPopupLayout` + a `GdkPopupLayout` - width of the left part of the shadow + width of the left part of the shadow - width of the right part of the shadow + width of the right part of the shadow - height of the top part of the shadow + height of the top part of the shadow - height of the bottom part of the shadow + height of the bottom part of the shadow - - Set the anchor on the popup surface. + + Set the anchor on the popup surface. + - a `GdkPopupLayout` + a `GdkPopupLayout` - the new popup surface anchor + the new popup surface anchor - Decreases the reference count of @value. + Decreases the reference count of @value. + - a `GdkPopupLayout` + a `GdkPopupLayout` - - An event related to the proximity of a tool to a device. + + An event related to the proximity of a tool to a device. - - A `GdkRGBA` is used to represent a color, in a way that is compatible -with cairo’s notion of color. + + A `GdkRGBA` is used to represent a color, in a way that is compatible +with cairo’s notion of color. -`GdkRGBA` is a convenient way to pass colors around. It’s based on -cairo’s way to deal with colors and mirrors its behavior. All values +`GdkRGBA` is a convenient way to pass colors around. It’s based on +cairo’s way to deal with colors and mirrors its behavior. All values are in the range from 0.0 to 1.0 inclusive. So the color (0.0, 0.0, 0.0, 0.0) represents transparent black and (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will be clamped to this range when drawing. + - The intensity of the red channel from 0.0 to 1.0 inclusive + The intensity of the red channel from 0.0 to 1.0 inclusive - The intensity of the green channel from 0.0 to 1.0 inclusive + The intensity of the green channel from 0.0 to 1.0 inclusive - The intensity of the blue channel from 0.0 to 1.0 inclusive + The intensity of the blue channel from 0.0 to 1.0 inclusive - The opacity of the color from 0.0 for completely translucent to + The opacity of the color from 0.0 for completely translucent to 1.0 for opaque - Makes a copy of a `GdkRGBA`. + Makes a copy of a `GdkRGBA`. The result must be freed through [method@Gdk.RGBA.free]. + - A newly allocated `GdkRGBA`, with the same contents as @rgba + A newly allocated `GdkRGBA`, with the same contents as @rgba - a `GdkRGBA` + a `GdkRGBA` - Compares two `GdkRGBA` colors. + Compares two `GdkRGBA` colors. + - %TRUE if the two colors compare equal + %TRUE if the two colors compare equal - a `GdkRGBA` + a `GdkRGBA` - another `GdkRGBA` + another `GdkRGBA` - Frees a `GdkRGBA`. + Frees a `GdkRGBA`. + - a `GdkRGBA` + a `GdkRGBA` - A hash function suitable for using for a hash + A hash function suitable for using for a hash table that stores `GdkRGBA`s. + - The hash value for @p + The hash value for @p - a `GdkRGBA` + a `GdkRGBA` - Checks if an @rgba value is transparent. + Checks if an @rgba value is transparent. That is, drawing with the value would not produce any change. + - %TRUE if the @rgba is clear + %TRUE if the @rgba is clear - a `GdkRGBA` + a `GdkRGBA` - Checks if an @rgba value is opaque. + Checks if an @rgba value is opaque. That is, drawing with the value will not retain any results from previous contents. + - %TRUE if the @rgba is opaque + %TRUE if the @rgba is opaque - a `GdkRGBA` + a `GdkRGBA` - Parses a textual representation of a color. + Parses a textual representation of a color. The string can be either one of: - A standard name (Taken from the X11 rgb.txt file). -- A hexadecimal value in the form “\#rgb”, “\#rrggbb”, - “\#rrrgggbbb” or ”\#rrrrggggbbbb” -- A hexadecimal value in the form “\#rgba”, “\#rrggbbaa”, - or ”\#rrrrggggbbbbaaaa” -- A RGB color in the form “rgb(r,g,b)” (In this case the color +- A hexadecimal value in the form “\#rgb”, “\#rrggbb”, + “\#rrrgggbbb” or ”\#rrrrggggbbbb” +- A hexadecimal value in the form “\#rgba”, “\#rrggbbaa”, + or ”\#rrrrggggbbbbaaaa” +- A RGB color in the form “rgb(r,g,b)” (In this case the color will have full opacity) -- A RGBA color in the form “rgba(r,g,b,a)” +- A RGBA color in the form “rgba(r,g,b,a)” -Where “r”, “g”, “b” and “a” are respectively the red, green, -blue and alpha color values. In the last two cases, “r”, “g”, -and “b” are either integers in the range 0 to 255 or percentage +Where “r”, “g”, “b” and “a” are respectively the red, green, +blue and alpha color values. In the last two cases, “r”, “g”, +and “b” are either integers in the range 0 to 255 or percentage values in the range 0% to 100%, and a is a floating point value in the range 0 to 1. + - %TRUE if the parsing succeeded + %TRUE if the parsing succeeded - the `GdkRGBA` to fill in + the `GdkRGBA` to fill in - the string specifying the color + the string specifying the color - Returns a textual specification of @rgba in the form -`rgb(r,g,b)` or `rgba(r,g,b,a)`, where “r”, “g”, “b” and -“a” represent the red, green, blue and alpha values -respectively. “r”, “g”, and “b” are represented as integers -in the range 0 to 255, and “a” is represented as a floating + Returns a textual specification of @rgba in the form +`rgb(r,g,b)` or `rgba(r,g,b,a)`, where “r”, “g”, “b” and +“a” represent the red, green, blue and alpha values +respectively. “r”, “g”, and “b” are represented as integers +in the range 0 to 255, and “a” is represented as a floating point value in the range 0 to 1. These string forms are string forms that are supported by the CSS3 colors module, and can be parsed by [method@Gdk.RGBA.parse]. Note that this string representation may lose some precision, -since “r”, “g” and “b” are represented as 8-bit integers. If +since “r”, “g” and “b” are represented as 8-bit integers. If this is a concern, you should use a different representation. + - A newly allocated text string + A newly allocated text string - a `GdkRGBA` + a `GdkRGBA` - - A `GdkRectangle` data type for representing rectangles. + + A `GdkRectangle` data type for representing rectangles. -`GdkRectangle` is identical to `cairo_rectangle_t`. Together with Cairo’s +`GdkRectangle` is identical to `cairo_rectangle_t`. Together with Cairo’s `cairo_region_t` data type, these are the central types for representing sets of pixels. @@ -15597,90 +24955,138 @@ non-rectangular clipping of graphical operations. The Graphene library has a number of other data types for regions and volumes in 2D and 3D. + - the x coordinate of the top left corner + the x coordinate of the top left corner - the y coordinate of the top left corner + the y coordinate of the top left corner - the width of the rectangle + the width of the rectangle - the height of the rectangle + the height of the rectangle - - Returns %TRUE if @rect contains the point described by @x and @y. + + Returns %TRUE if @rect contains the point described by @x and @y. + - %TRUE if @rect contains the point + %TRUE if @rect contains the point - a `GdkRectangle` + a `GdkRectangle` - X coordinate + X coordinate - Y coordinate + Y coordinate - Checks if the two given rectangles are equal. + Checks if the two given rectangles are equal. + - %TRUE if the rectangles are equal. + %TRUE if the rectangles are equal. - a `GdkRectangle` + a `GdkRectangle` - a `GdkRectangle` + a `GdkRectangle` - Calculates the intersection of two rectangles. + Calculates the intersection of two rectangles. It is allowed for @dest to be the same as either @src1 or @src2. -If the rectangles do not intersect, @dest’s width and height is set +If the rectangles do not intersect, @dest’s width and height is set to 0 and its x and y values are undefined. If you are only interested in whether the rectangles intersect, but not in the intersecting area itself, pass %NULL for @dest. + - %TRUE if the rectangles intersect. + %TRUE if the rectangles intersect. - a `GdkRectangle` + a `GdkRectangle` - a `GdkRectangle` + a `GdkRectangle` - - return location for the + + return location for the intersection of @src1 and @src2 - Calculates the union of two rectangles. + Calculates the union of two rectangles. The union of rectangles @src1 and @src2 is the smallest rectangle which includes both @src1 and @src2 within it. It is allowed for @dest to be @@ -15688,114 +25094,197 @@ the same as either @src1 or @src2. Note that this function does not ignore 'empty' rectangles (ie. with zero width or height). + - a `GdkRectangle` + a `GdkRectangle` - a `GdkRectangle` + a `GdkRectangle` - - return location for the union of @src1 and @src2 + + return location for the union of @src1 and @src2 + - + + - + + - + + - + + - - Specifies the direction for scroll events. + + Specifies the direction for scroll events. - the surface is scrolled up. + the surface is scrolled up. - - the surface is scrolled down. + + the surface is scrolled down. - - the surface is scrolled to the left. + + the surface is scrolled to the left. - - the surface is scrolled to the right. + + the surface is scrolled to the right. - - the scrolling is determined by the delta values + + the scrolling is determined by the delta values in scroll events. See gdk_scroll_event_get_deltas() - - An event related to a scrolling motion. + + An event related to a scrolling motion. - Extracts the scroll deltas of a scroll event. + Extracts the scroll deltas of a scroll event. The deltas will be zero unless the scroll direction is %GDK_SCROLL_SMOOTH. + - a scroll event + a scroll event - - return location for x scroll delta + + return location for x scroll delta - - return location for y scroll delta + + return location for y scroll delta - - Extracts the direction of a scroll event. + + Extracts the direction of a scroll event. + - the scroll direction of @event + the scroll direction of @event - a scroll event + a scroll event - Check whether a scroll event is a stop scroll event. + Check whether a scroll event is a stop scroll event. Scroll sequences with smooth scroll information may provide a stop scroll event once the interaction with the device finishes, @@ -15804,38 +25293,63 @@ that a widget may trigger kinetic scrolling based on the current velocity. Stop scroll events always have a delta of 0/0. + - %TRUE if the event is a scroll stop event + %TRUE if the event is a scroll stop event - a scroll event + a scroll event - - The `GdkSeat` object represents a collection of input devices + + The `GdkSeat` object represents a collection of input devices that belong to a user. - Returns the capabilities this `GdkSeat` currently has. + Returns the capabilities this `GdkSeat` currently has. + - the seat capabilities + the seat capabilities - a `GdkSeat` + a `GdkSeat` - Returns the devices that match the given capabilities. + Returns the devices that match the given capabilities. + - A list + A list of `GdkDevices`. The list must be freed with g_list_free(), the elements are owned by GTK and must not be freed. @@ -15844,62 +25358,92 @@ that belong to a user. - a `GdkSeat` + a `GdkSeat` - capabilities to get devices for + capabilities to get devices for - Returns the `GdkDisplay` this seat belongs to. + Returns the `GdkDisplay` this seat belongs to. + - a `GdkDisplay`. This object + a `GdkDisplay`. This object is owned by GTK and must not be freed. - a `GdkSeat` + a `GdkSeat` - Returns the device that routes keyboard events. + Returns the device that routes keyboard events. + - a `GdkDevice` with keyboard + a `GdkDevice` with keyboard capabilities. This object is owned by GTK and must not be freed. - a `GdkSeat` + a `GdkSeat` - Returns the device that routes pointer events. + Returns the device that routes pointer events. + - a `GdkDevice` with pointer + a `GdkDevice` with pointer capabilities. This object is owned by GTK and must not be freed. - a `GdkSeat` + a `GdkSeat` - Returns all `GdkDeviceTools` that are known to the application. + Returns all `GdkDeviceTools` that are known to the application. + - + A list of tools. Free with g_list_free(). @@ -15907,45 +25451,62 @@ that belong to a user. - a `GdkSeat` + a `GdkSeat` - + - `GdkDisplay` of this seat. + `GdkDisplay` of this seat. - Emitted when a new input device is related to this seat. + Emitted when a new input device is related to this seat. - the newly added `GdkDevice`. + the newly added `GdkDevice`. - Emitted when an input device is removed (e.g. unplugged). + Emitted when an input device is removed (e.g. unplugged). - the just removed `GdkDevice`. + the just removed `GdkDevice`. - Emitted whenever a new tool is made known to the seat. + Emitted whenever a new tool is made known to the seat. The tool may later be assigned to a device (i.e. on proximity with a tablet). The device will emit the @@ -15957,170 +25518,322 @@ A same tool may be used by several devices. - the new `GdkDeviceTool` known to the seat + the new `GdkDeviceTool` known to the seat - Emitted whenever a tool is no longer known to this @seat. + Emitted whenever a tool is no longer known to this @seat. - the just removed `GdkDeviceTool` + the just removed `GdkDeviceTool` - - Flags describing the seat capabilities. - - No input capabilities + + Flags describing the seat capabilities. + + No input capabilities - - The seat has a pointer (e.g. mouse) + + The seat has a pointer (e.g. mouse) - - The seat has touchscreen(s) attached + + The seat has touchscreen(s) attached - - The seat has drawing tablet(s) attached + + The seat has drawing tablet(s) attached - - The seat has keyboard(s) attached + + The seat has keyboard(s) attached - - The seat has drawing tablet pad(s) attached + + The seat has drawing tablet pad(s) attached - - The union of all pointing capabilities + + The union of all pointing capabilities - - The union of all capabilities + + The union of all capabilities - - Base type for snapshot operations. + + Base type for snapshot operations. The subclass of `GdkSnapshot` used by GTK is [class@Gtk.Snapshot]. + - - - This enumeration describes how the red, green and blue components + + + + + This enumeration describes how the red, green and blue components of physical pixels on an output device are laid out. - - The layout is not known + + The layout is not known - - Not organized in this way + + Not organized in this way - - The layout is horizontal, the order is RGB + + The layout is horizontal, the order is RGB - - The layout is horizontal, the order is BGR + + The layout is horizontal, the order is BGR - - The layout is vertical, the order is RGB + + The layout is vertical, the order is RGB - - The layout is vertical, the order is BGR + + The layout is vertical, the order is BGR - - A `GdkSurface` is a rectangular region on the screen. + + A `GdkSurface` is a rectangular region on the screen. -It’s a low-level object, used to implement high-level objects +It’s a low-level object, used to implement high-level objects such as [class@Gtk.Window] or [class@Gtk.Dialog] in GTK. The surfaces you see in practice are either [class@Gdk.Toplevel] or [class@Gdk.Popup], and those interfaces provide much of the required API to interact with these surfaces. Other, more specialized surface types exist, but you will rarely interact with them directly. + - Create a new popup surface. + Create a new popup surface. The surface will be attached to @parent and can be positioned relative to it using [method@Gdk.Popup.present]. + - a new `GdkSurface` + a new `GdkSurface` - the parent surface to attach the surface to + the parent surface to attach the surface to - whether to hide the surface on outside clicks + whether to hide the surface on outside clicks - Creates a new toplevel surface. + Creates a new toplevel surface. + - the new `GdkSurface` + the new `GdkSurface` - the display to create the surface on + the display to create the surface on - Emits a short beep associated to @surface. + Emits a short beep associated to @surface. If the display of @surface does not support per-surface beeps, emits a short beep on the display just as [method@Gdk.Display.beep]. + - a toplevel `GdkSurface` + a toplevel `GdkSurface` - - Creates a new `GdkCairoContext` for rendering on @surface. + + Creates a new `GdkCairoContext` for rendering on @surface. + - the newly created `GdkCairoContext` + the newly created `GdkCairoContext` - a `GdkSurface` + a `GdkSurface` - - Creates a new `GdkGLContext` for the `GdkSurface`. + + Creates a new `GdkGLContext` for the `GdkSurface`. The context is disconnected from any particular surface or surface. If the creation of the `GdkGLContext` failed, @error will be set. Before using the returned `GdkGLContext`, you will need to call [method@Gdk.GLContext.make_current] or [method@Gdk.GLContext.realize]. + - the newly created `GdkGLContext` + the newly created `GdkGLContext` - a `GdkSurface` + a `GdkSurface` - - Create a new Cairo surface that is as compatible as possible with the + + Create a new Cairo surface that is as compatible as possible with the given @surface. For example the new surface will have the same fallback resolution @@ -16133,212 +25846,317 @@ Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.) This function always returns a valid pointer, but it will return a -pointer to a “nil” surface if @other is already in an error state +pointer to a “nil” surface if @other is already in an error state or any other error occurs. + - a pointer to the newly allocated surface. The caller + a pointer to the newly allocated surface. The caller owns the surface and should call cairo_surface_destroy() when done with it. - surface to make new surface similar to + surface to make new surface similar to - the content for the new surface + the content for the new surface - width of the new surface + width of the new surface - height of the new surface + height of the new surface - - Creates a new `GdkVulkanContext` for rendering on @surface. + + Creates a new `GdkVulkanContext` for rendering on @surface. If the creation of the `GdkVulkanContext` failed, @error will be set. + - the newly created `GdkVulkanContext`, or + the newly created `GdkVulkanContext`, or %NULL on error - a `GdkSurface` + a `GdkSurface` - Destroys the window system resources associated with @surface and + Destroys the window system resources associated with @surface and decrements @surface's reference count. The window system resources for all children of @surface are also -destroyed, but the children’s reference counts are not decremented. +destroyed, but the children’s reference counts are not decremented. Note that a surface will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens. + - a `GdkSurface` + a `GdkSurface` - Retrieves a `GdkCursor` pointer for the cursor currently set on the + Retrieves a `GdkCursor` pointer for the cursor currently set on the `GdkSurface`. If the return value is %NULL then there is no custom cursor set on the surface, and it is using the cursor for its parent surface. Use [method@Gdk.Surface.set_cursor] to unset the cursor of the surface. + - a `GdkCursor` + a `GdkCursor` - a `GdkSurface` + a `GdkSurface` - - Retrieves a `GdkCursor` pointer for the @device currently set on the + + Retrieves a `GdkCursor` pointer for the @device currently set on the specified `GdkSurface`. If the return value is %NULL then there is no custom cursor set on the specified surface, and it is using the cursor for its parent surface. Use [method@Gdk.Surface.set_cursor] to unset the cursor of the surface. + - a `GdkCursor` + a `GdkCursor` - a `GdkSurface` + a `GdkSurface` - a pointer `GdkDevice` + a pointer `GdkDevice` - - Obtains the current device position and modifier state. + + Obtains the current device position and modifier state. The position is given in coordinates relative to the upper left corner of @surface. + - %TRUE if the device is over the surface + %TRUE if the device is over the surface - a `GdkSurface` + a `GdkSurface` - pointer `GdkDevice` to query to + pointer `GdkDevice` to query to - - return location for the X coordinate of @device + + return location for the X coordinate of @device - - return location for the Y coordinate of @device + + return location for the Y coordinate of @device - - return location for the modifier mask + + return location for the modifier mask - Gets the `GdkDisplay` associated with a `GdkSurface`. + Gets the `GdkDisplay` associated with a `GdkSurface`. + - the `GdkDisplay` associated with @surface + the `GdkDisplay` associated with @surface - a `GdkSurface` + a `GdkSurface` - + - Gets the frame clock for the surface. + Gets the frame clock for the surface. The frame clock for a surface never changes unless the surface is reparented to a new toplevel surface. + - the frame clock + the frame clock - surface to get frame clock for + surface to get frame clock for - Returns the height of the given @surface. + Returns the height of the given @surface. -Surface size is reported in ”application pixels”, not -”device pixels” (see [method@Gdk.Surface.get_scale_factor]). +Surface size is reported in ”application pixels”, not +”device pixels” (see [method@Gdk.Surface.get_scale_factor]). + - The height of @surface + The height of @surface - a `GdkSurface` + a `GdkSurface` - Checks whether the surface has been mapped. + Checks whether the surface has been mapped. A surface is mapped with [method@Gdk.Toplevel.present] or [method@Gdk.Popup.present]. + - %TRUE if the surface is mapped + %TRUE if the surface is mapped - a `GdkSurface` + a `GdkSurface` - + - Returns the internal scale factor that maps from surface coordinates + Returns the internal scale factor that maps from surface coordinates to the actual device pixels. On traditional systems this is 1, but on very high density outputs @@ -16349,97 +26167,133 @@ pixel-based data the scale value can be used to determine whether to use a pixel resource with higher resolution data. The scale of a surface may change during runtime. + - the scale factor + the scale factor - surface to get scale factor for + surface to get scale factor for - Returns the width of the given @surface. + Returns the width of the given @surface. -Surface size is reported in ”application pixels”, not -”device pixels” (see [method@Gdk.Surface.get_scale_factor]). +Surface size is reported in ”application pixels”, not +”device pixels” (see [method@Gdk.Surface.get_scale_factor]). + - The width of @surface + The width of @surface - a `GdkSurface` + a `GdkSurface` - Hide the surface. + Hide the surface. For toplevel surfaces, withdraws them, so they will no longer be known to the window manager; for all surfaces, unmaps them, so -they won’t be displayed. Normally done automatically as +they won’t be displayed. Normally done automatically as part of [method@Gtk.Widget.hide]. + - a `GdkSurface` + a `GdkSurface` - Check to see if a surface is destroyed. + Check to see if a surface is destroyed. + - %TRUE if the surface is destroyed + %TRUE if the surface is destroyed - a `GdkSurface` + a `GdkSurface` - Forces a [signal@Gdk.Surface::render] signal emission for @surface + Forces a [signal@Gdk.Surface::render] signal emission for @surface to be scheduled. This function is useful for implementations that track invalid regions on their own. + - a `GdkSurface` + a `GdkSurface` - Request a layout phase from the surface's frame clock. + Request a layout phase from the surface's frame clock. See [method@Gdk.FrameClock.request_phase]. + - a `GdkSurface` + a `GdkSurface` - Sets the default mouse pointer for a `GdkSurface`. + Sets the default mouse pointer for a `GdkSurface`. Passing %NULL for the @cursor argument means that @surface will use the cursor of its parent surface. Most surfaces should use this default. @@ -16447,48 +26301,69 @@ Note that @cursor must be for the same display as @surface. Use [ctor@Gdk.Cursor.new_from_name] or [ctor@Gdk.Cursor.new_from_texture] to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. + - a `GdkSurface` + a `GdkSurface` - - a `GdkCursor` + + a `GdkCursor` - - Sets a specific `GdkCursor` for a given device when it gets inside @surface. + + Sets a specific `GdkCursor` for a given device when it gets inside @surface. Passing %NULL for the @cursor argument means that @surface will use the cursor of its parent surface. Most surfaces should use this default. Use [ctor@Gdk.Cursor.new_from_name] or [ctor@Gdk.Cursor.new_from_texture] to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. + - a `GdkSurface` + a `GdkSurface` - a pointer `GdkDevice` + a pointer `GdkDevice` - a `GdkCursor` + a `GdkCursor` - - Apply the region to the surface for the purpose of event + + Apply the region to the surface for the purpose of event handling. Mouse events which happen while the pointer position corresponds @@ -16498,26 +26373,34 @@ to an unset bit in the mask will be passed on the surface below An input region is typically used with RGBA surfaces. The alpha channel of the surface defines which pixels are invisible and allows for nicely antialiased borders, and the input region -controls where the surface is “clickable”. +controls where the surface is “clickable”. Use [method@Gdk.Display.supports_input_shapes] to find out if a particular backend supports input regions. + - a `GdkSurface` + a `GdkSurface` - region of surface to be reactive + region of surface to be reactive - - Marks a region of the `GdkSurface` as opaque. + + Marks a region of the `GdkSurface` as opaque. For optimisation purposes, compositing window managers may like to not draw obscured regions of surfaces, or turn off blending @@ -16532,45 +26415,73 @@ GTK will update this property automatically if the @surface background is opaque, as we know where the opaque regions are. If your surface background is not opaque, please update this property in your [vfunc@Gtk.Widget.css_changed] handler. + - a top-level `GdkSurface` + a top-level `GdkSurface` - - a region, or %NULL to make the entire + + a region, or %NULL to make the entire surface opaque - - Translates coordinates between two surfaces. + + Translates coordinates between two surfaces. Note that this only works if @to and @from are popups or transient-for to the same toplevel (directly or indirectly). + - %TRUE if the coordinates were successfully translated + %TRUE if the coordinates were successfully translated - the origin surface + the origin surface - the target surface + the target surface - - coordinates to translate + + coordinates to translate - - coordinates to translate + + coordinates to translate @@ -16578,146 +26489,257 @@ transient-for to the same toplevel (directly or indirectly). - The mouse pointer for the `GdkSurface`. + The mouse pointer for the `GdkSurface`. - - - The `GdkDisplay` connection of the surface. + + + The `GdkDisplay` connection of the surface. - - - The `GdkFrameClock` of the surface. + + + The `GdkFrameClock` of the surface. - The height of the surface, in pixels. + The height of the surface, in pixels. - Whether the surface is mapped. + Whether the surface is mapped. - - The scale factor of the surface. + + The scale factor of the surface. - The width of the surface in pixels. + The width of the surface in pixels. - Emitted when @surface starts being present on the monitor. + Emitted when @surface starts being present on the monitor. - the monitor + the monitor - Emitted when GDK receives an input event for @surface. + Emitted when GDK receives an input event for @surface. - %TRUE to indicate that the event has been handled + %TRUE to indicate that the event has been handled - an input event + an input event - Emitted when the size of @surface is changed, or when relayout should + Emitted when the size of @surface is changed, or when relayout should be performed. -Surface size is reported in ”application pixels”, not -”device pixels” (see gdk_surface_get_scale_factor()). +Surface size is reported in ”application pixels”, not +”device pixels” (see gdk_surface_get_scale_factor()). - the current width + the current width - the current height + the current height - Emitted when @surface stops being present on the monitor. + Emitted when @surface stops being present on the monitor. - the monitor + the monitor - Emitted when part of the surface needs to be redrawn. + Emitted when part of the surface needs to be redrawn. - %TRUE to indicate that the signal has been handled + %TRUE to indicate that the signal has been handled - the region that needs to be redrawn + the region that needs to be redrawn - - - Determines a surface edge or corner. - - the top left corner. + + + + + Determines a surface edge or corner. + + the top left corner. - - the top edge. + + the top edge. - - the top right corner. + + the top right corner. - - the left edge. + + the left edge. - - the right edge. + + the right edge. - - the lower left corner. + + the lower left corner. - - the lower edge. + + the lower edge. - - the lower right corner. + + the lower right corner. - + + - - `GdkTexture` is the basic element used to refer to pixel data. + + `GdkTexture` is the basic element used to refer to pixel data. It is primarily meant for pixel data that will not change over multiple frames, and will be used for a long time. @@ -16732,40 +26754,61 @@ instance; you can only make a copy of it, via `GdkTexture` is an immutable object: That means you cannot change anything about it other than increasing the reference count via g_object_ref(). + - - Creates a new texture object representing the `GdkPixbuf`. + + Creates a new texture object representing the `GdkPixbuf`. + - a new `GdkTexture` + a new `GdkTexture` - a `GdkPixbuf` + a `GdkPixbuf` - - Creates a new texture by loading an image from a file. + + Creates a new texture by loading an image from a file. The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available. If %NULL is returned, then @error will be set. + - A newly-created `GdkTexture` + A newly-created `GdkTexture` - `GFile` to load + `GFile` to load - - Creates a new texture by loading an image from a resource. + + Creates a new texture by loading an image from a resource. The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available. @@ -16774,19 +26817,26 @@ It is a fatal error if @resource_path does not specify a valid image resource and the program will abort if that happens. If you are unsure about the validity of a resource, use [ctor@Gdk.Texture.new_from_file] to load it. + - A newly-created `GdkTexture` + A newly-created `GdkTexture` - the path of the resource file + the path of the resource file - Downloads the @texture into local memory. + Downloads the @texture into local memory. This may be an expensive operation, as the actual texture data may reside on a GPU or on a remote display server. @@ -16805,231 +26855,357 @@ gdk_texture_download (texture, cairo_image_surface_get_stride (surface)); cairo_surface_mark_dirty (surface); ``` + - a `GdkTexture` + a `GdkTexture` - pointer to enough memory to be filled with the + pointer to enough memory to be filled with the downloaded data of @texture - rowstride in bytes + rowstride in bytes - Returns the height of the @texture, in pixels. + Returns the height of the @texture, in pixels. + - the height of the `GdkTexture` + the height of the `GdkTexture` - a `GdkTexture` + a `GdkTexture` - Returns the width of @texture, in pixels. + Returns the width of @texture, in pixels. + - the width of the `GdkTexture` + the width of the `GdkTexture` - a `GdkTexture` + a `GdkTexture` - Store the given @texture to the @filename as a PNG file. + Store the given @texture to the @filename as a PNG file. This is a utility function intended for debugging and testing. If you want more control over formats, proper error handling or want to store to a `GFile` or other location, you might want to look into using the gdk-pixbuf library. + - %TRUE if saving succeeded, %FALSE on failure. + %TRUE if saving succeeded, %FALSE on failure. - a `GdkTexture` + a `GdkTexture` - the filename to store to + the filename to store to - + - The height of the texture, in pixels. + The height of the texture, in pixels. - + - The width of the texture, in pixels. + The width of the texture, in pixels. - + + + - A `GdkTimeCoord` stores a single event in a motion history. + A `GdkTimeCoord` stores a single event in a motion history. + - The timestamp for this event + The timestamp for this event - Flags indicating what axes are present + Flags indicating what axes are present - axis values + axis values - - + + - + - + - - A `GdkToplevel` is a freestanding toplevel surface. + + A `GdkToplevel` is a freestanding toplevel surface. The `GdkToplevel` interface provides useful APIs for interacting with the windowing system, such as controlling maximization and size of the surface, setting icons and transient parents for dialogs. + - Begins an interactive move operation. + Begins an interactive move operation. You might use this function to implement draggable titlebars. + - a `GdkToplevel` + a `GdkToplevel` - the device used for the operation + the device used for the operation - the button being used to drag, or 0 for a keyboard-initiated drag + the button being used to drag, or 0 for a keyboard-initiated drag - surface X coordinate of mouse click that began the drag + surface X coordinate of mouse click that began the drag - surface Y coordinate of mouse click that began the drag + surface Y coordinate of mouse click that began the drag - timestamp of mouse click that began the drag (use + timestamp of mouse click that began the drag (use [method@Gdk.Event.get_time]) - Begins an interactive resize operation. + Begins an interactive resize operation. -You might use this function to implement a “window resize grip.” +You might use this function to implement a “window resize grip.” + - a `GdkToplevel` + a `GdkToplevel` - the edge or corner from which the drag is started + the edge or corner from which the drag is started - - the device used for the operation + + the device used for the operation - the button being used to drag, or 0 for a keyboard-initiated drag + the button being used to drag, or 0 for a keyboard-initiated drag - surface X coordinate of mouse click that began the drag + surface X coordinate of mouse click that began the drag - surface Y coordinate of mouse click that began the drag + surface Y coordinate of mouse click that began the drag - timestamp of mouse click that began the drag (use + timestamp of mouse click that began the drag (use [method@Gdk.Event.get_time]) - Sets keyboard focus to @surface. + Sets keyboard focus to @surface. In most cases, [method@Gtk.Window.present_with_time] should be used on a [class@Gtk.Window], rather than calling this function. + - a `GdkToplevel` + a `GdkToplevel` - timestamp of the event triggering the surface focus + timestamp of the event triggering the surface focus - Gets the bitwise or of the currently active surface state flags, + Gets the bitwise or of the currently active surface state flags, from the `GdkToplevelState` enumeration. + - surface state bitfield + surface state bitfield - a `GdkToplevel` + a `GdkToplevel` - - Requests that the @toplevel inhibit the system shortcuts. + + Requests that the @toplevel inhibit the system shortcuts. This is asking the desktop environment/windowing system to let all keyboard events reach the surface, as long as it is focused, instead @@ -17050,53 +27226,77 @@ or deny the request or even choose to ignore the request entirely. The caller can be notified whenever the request is granted or revoked by listening to the [property@Gdk.Toplevel:shortcuts-inhibited] property. + - a `GdkToplevel` + a `GdkToplevel` - - the `GdkEvent` that is triggering the inhibit + + the `GdkEvent` that is triggering the inhibit request, or %NULL if none is available - Asks to lower the @toplevel below other windows. + Asks to lower the @toplevel below other windows. The windowing system may choose to ignore the request. + - %TRUE if the surface was lowered + %TRUE if the surface was lowered - a `GdkToplevel` + a `GdkToplevel` - Asks to minimize the @toplevel. + Asks to minimize the @toplevel. The windowing system may choose to ignore the request. + - %TRUE if the surface was minimized + %TRUE if the surface was minimized - a `GdkToplevel` + a `GdkToplevel` - Present @toplevel after having processed the `GdkToplevelLayout` rules. + Present @toplevel after having processed the `GdkToplevelLayout` rules. If the toplevel was previously not showing, it will be showed, otherwise it will change layout according to @layout. @@ -17107,79 +27307,106 @@ surface. Presenting is asynchronous and the specified layout parameters are not guaranteed to be respected. + - the `GdkToplevel` to show + the `GdkToplevel` to show - the `GdkToplevelLayout` object used to layout + the `GdkToplevelLayout` object used to layout - - Restore default system keyboard shortcuts which were previously + + Restore default system keyboard shortcuts which were previously inhibited. This undoes the effect of [method@Gdk.Toplevel.inhibit_system_shortcuts]. + - a `GdkToplevel` + a `GdkToplevel` - Sets the toplevel to be decorated. + Sets the toplevel to be decorated. Setting @decorated to %FALSE hints the desktop environment that the surface has its own, client-side decorations and does not need to have window decorations added. + - a `GdkToplevel` + a `GdkToplevel` - %TRUE to request decorations + %TRUE to request decorations - Sets the toplevel to be deletable. + Sets the toplevel to be deletable. Setting @deletable to %TRUE hints the desktop environment that it should offer the user a way to close the surface. + - a `GdkToplevel` + a `GdkToplevel` - %TRUE to request a delete button + %TRUE to request a delete button - Sets a list of icons for the surface. + Sets a list of icons for the surface. One of these will be used to represent the surface in iconic form. The icon may be shown in window lists or task bars. Which icon @@ -17188,16 +27415,21 @@ can scale the icon but setting several size icons can give better image quality. Note that some platforms don't support surface icons. + - a `GdkToplevel` + a `GdkToplevel` - + A list of textures to use as icon, of different sizes @@ -17207,7 +27439,9 @@ Note that some platforms don't support surface icons. - Sets the toplevel to be modal. + Sets the toplevel to be modal. The application can use this hint to tell the window manager that a certain surface has modal @@ -17216,123 +27450,170 @@ to handle modal surfaces in a special way. You should only use this on surfaces for which you have previously called [method@Gdk.Toplevel.set_transient_for]. + - a `GdkToplevel` + a `GdkToplevel` - %TRUE if the surface is modal, %FALSE otherwise. + %TRUE if the surface is modal, %FALSE otherwise. - Sets the startup notification ID. + Sets the startup notification ID. When using GTK, typically you should use [method@Gtk.Window.set_startup_id] instead of this low-level function. + - a `GdkToplevel` + a `GdkToplevel` - a string with startup-notification identifier + a string with startup-notification identifier - Sets the title of a toplevel surface. + Sets the title of a toplevel surface. The title maybe be displayed in the titlebar, in lists of windows, etc. + - a `GdkToplevel` + a `GdkToplevel` - title of @surface + title of @surface - + - Sets a transient-for parent. + Sets a transient-for parent. Indicates to the window manager that @surface is a transient dialog associated with the application surface @parent. This allows the window manager to do things like center @surface on @parent and keep @surface above @parent. -See [method@Gtk.Window.set_transient_for] if you’re using +See [method@Gtk.Window.set_transient_for] if you’re using [class@Gtk.Window] or [class@Gtk.Dialog]. + - a `GdkToplevel` + a `GdkToplevel` - another toplevel `GdkSurface` + another toplevel `GdkSurface` - - Asks the windowing system to show the window menu. + + Asks the windowing system to show the window menu. The window menu is the menu shown when right-clicking the titlebar on traditional windows managed by the window manager. This is useful for windows using client-side decorations, activating it with a right-click on the window decorations. + - %TRUE if the window menu was shown and %FALSE otherwise. + %TRUE if the window menu was shown and %FALSE otherwise. - a `GdkToplevel` + a `GdkToplevel` - a `GdkEvent` to show the menu for + a `GdkEvent` to show the menu for - - Returns whether the desktop environment supports + + Returns whether the desktop environment supports tiled window states. + - %TRUE if the desktop environment supports tiled window states + %TRUE if the desktop environment supports tiled window states - a `GdkToplevel` + a `GdkToplevel` - + + @@ -17346,36 +27627,54 @@ tiled window states. - - Whether the window manager should add decorations. + + Whether the window manager should add decorations. - - Whether the window manager should allow to close the surface. + + Whether the window manager should allow to close the surface. - The fullscreen mode of the surface. + The fullscreen mode of the surface. - - A list of textures to use as icon. + + A list of textures to use as icon. - Whether the surface is modal. + Whether the surface is modal. - Whether the surface should inhibit keyboard shortcuts. + Whether the surface should inhibit keyboard shortcuts. - - The startup ID of the surface. + + The startup ID of the surface. See [class@Gdk.AppLaunchContext] for more information about startup feedback. @@ -17383,21 +27682,30 @@ startup feedback. - The state of the toplevel. + The state of the toplevel. - The title of the surface. + The title of the surface. - - The transient parent of the surface. + + The transient parent of the surface. - Emitted when the size for the surface needs to be computed, when + Emitted when the size for the surface needs to be computed, when it is present. It will normally be emitted during or after [method@Gdk.Toplevel.present], @@ -17413,16 +27721,32 @@ will result in an arbitrary size being used as a result. - - a `GdkToplevelSize` + + a `GdkToplevelSize` - - - The `GdkToplevelLayout` struct contains information that + + + + + The `GdkToplevelLayout` struct contains information that is necessary to present a sovereign window on screen. The `GdkToplevelLayout` struct is necessary for using @@ -17431,228 +27755,354 @@ The `GdkToplevelLayout` struct is necessary for using Toplevel surfaces are sovereign windows that can be presented to the user in various states (maximized, on all workspaces, etc). + - Create a toplevel layout description. + Create a toplevel layout description. Used together with gdk_toplevel_present() to describe how a toplevel surface should be placed and behave on-screen. -The size is in ”application pixels”, not -”device pixels” (see gdk_surface_get_scale_factor()). +The size is in ”application pixels”, not +”device pixels” (see gdk_surface_get_scale_factor()). + - newly created instance of `GdkToplevelLayout` + newly created instance of `GdkToplevelLayout` - Create a new `GdkToplevelLayout` and copy the contents of @layout into it. + Create a new `GdkToplevelLayout` and copy the contents of @layout into it. + - a copy of @layout. + a copy of @layout. - a `GdkToplevelLayout` + a `GdkToplevelLayout` - Check whether @layout and @other has identical layout properties. + Check whether @layout and @other has identical layout properties. + - %TRUE if @layout and @other have identical layout properties, + %TRUE if @layout and @other have identical layout properties, otherwise %FALSE. - a `GdkToplevelLayout` + a `GdkToplevelLayout` - another `GdkToplevelLayout` + another `GdkToplevelLayout` - - If the layout specifies whether to the toplevel should go fullscreen, + + If the layout specifies whether to the toplevel should go fullscreen, the value pointed to by @fullscreen is set to %TRUE if it should go fullscreen, or %FALSE, if it should go unfullscreen. + - whether the @layout specifies the fullscreen state for the toplevel + whether the @layout specifies the fullscreen state for the toplevel - a ``GdkToplevelLayout` + a ``GdkToplevelLayout` - - location to store whether the toplevel should be fullscreen + + location to store whether the toplevel should be fullscreen - - Returns the monitor that the layout is fullscreening + + Returns the monitor that the layout is fullscreening the surface on. + - the monitor on which @layout fullscreens + the monitor on which @layout fullscreens - a `GdkToplevelLayout` + a `GdkToplevelLayout` - - If the layout specifies whether to the toplevel should go maximized, + + If the layout specifies whether to the toplevel should go maximized, the value pointed to by @maximized is set to %TRUE if it should go fullscreen, or %FALSE, if it should go unmaximized. + - whether the @layout specifies the maximized state for the toplevel + whether the @layout specifies the maximized state for the toplevel - a `GdkToplevelLayout` + a `GdkToplevelLayout` - - set to %TRUE if the toplevel should be maximized + + set to %TRUE if the toplevel should be maximized - - Returns whether the layout should allow the user + + Returns whether the layout should allow the user to resize the surface. + - %TRUE if the layout is resizable + %TRUE if the layout is resizable - a `GdkToplevelLayout` + a `GdkToplevelLayout` - Increases the reference count of @layout. + Increases the reference count of @layout. + - the same @layout + the same @layout - a `GdkToplevelLayout` + a `GdkToplevelLayout` - - Sets whether the layout should cause the surface + + Sets whether the layout should cause the surface to be fullscreen when presented. + - a `GdkToplevelLayout` + a `GdkToplevelLayout` - %TRUE to fullscreen the surface + %TRUE to fullscreen the surface - - the monitor to fullscreen on + + the monitor to fullscreen on - - Sets whether the layout should cause the surface + + Sets whether the layout should cause the surface to be maximized when presented. + - a `GdkToplevelLayout` + a `GdkToplevelLayout` - %TRUE to maximize + %TRUE to maximize - - Sets whether the layout should allow the user + + Sets whether the layout should allow the user to resize the surface after it has been presented. + - a `GdkToplevelLayout` + a `GdkToplevelLayout` - %TRUE to allow resizing + %TRUE to allow resizing - Decreases the reference count of @layout. + Decreases the reference count of @layout. + - a `GdkToplevelLayout` + a `GdkToplevelLayout` - The `GdkToplevelSize` struct contains information that is useful + The `GdkToplevelSize` struct contains information that is useful to compute the size of a toplevel. + - Retrieves the bounds the toplevel is placed within. + Retrieves the bounds the toplevel is placed within. The bounds represent the largest size a toplevel may have while still being able to fit within some type of boundary. Depending on the backend, this may be equivalent to the dimensions of the work area or the monitor on which the window is being presented on, or something else that limits the way a toplevel can be presented. + - a `GdkToplevelSize` + a `GdkToplevelSize` - - return location for width + + return location for width - - return location for height + + return location for height - - Sets the minimum size of the toplevel. + + Sets the minimum size of the toplevel. The minimum size corresponds to the limitations the toplevel can be shrunk to, without resulting in incorrect painting. A user of a `GdkToplevel` should @@ -17661,237 +28111,428 @@ the `GdkToplevelSize` object. The minimum size should be within the bounds (see [method@Gdk.ToplevelSize.get_bounds]). + - a `GdkToplevelSize` + a `GdkToplevelSize` - the minimum width + the minimum width - the minimum height + the minimum height - - Sets the shadows size of the toplevel. + + Sets the shadows size of the toplevel. The shadow width corresponds to the part of the computed surface size that would consist of the shadow margin surrounding the window, would there be any. + - a `GdkToplevelSize` + a `GdkToplevelSize` - width of the left part of the shadow + width of the left part of the shadow - width of the right part of the shadow + width of the right part of the shadow - height of the top part of the shadow + height of the top part of the shadow - height of the bottom part of the shadow + height of the bottom part of the shadow - Sets the size the toplevel prefers to be resized to. + Sets the size the toplevel prefers to be resized to. The size should be within the bounds (see [method@Gdk.ToplevelSize.get_bounds]). The set size should be considered as a hint, and should not be assumed to be respected by the windowing system, or backend. + - a `GdkToplevelSize` + a `GdkToplevelSize` - the width + the width - the height + the height - - Specifies the state of a toplevel surface. + + Specifies the state of a toplevel surface. On platforms that support information about individual edges, the %GDK_TOPLEVEL_STATE_TILED state will be set whenever any of the individual tiled states is set. On platforms that lack that support, the tiled state will give an indication of tiledness without any of the per-edge states being set. - - the surface is minimized + + the surface is minimized - - the surface is maximized + + the surface is maximized - - the surface is sticky + + the surface is sticky - - the surface is maximized without decorations + + the surface is maximized without decorations - - the surface is kept above other surfaces + + the surface is kept above other surfaces - - the surface is kept below other surfaces + + the surface is kept below other surfaces - - the surface is presented as focused (with active decorations) + + the surface is presented as focused (with active decorations) - - the surface is in a tiled state + + the surface is in a tiled state - - whether the top edge is tiled + + whether the top edge is tiled - - whether the top edge is resizable + + whether the top edge is resizable - - whether the right edge is tiled + + whether the right edge is tiled - - whether the right edge is resizable + + whether the right edge is resizable - - whether the bottom edge is tiled + + whether the bottom edge is tiled - - whether the bottom edge is resizable + + whether the bottom edge is resizable - - whether the left edge is tiled + + whether the left edge is tiled - - whether the left edge is resizable + + whether the left edge is resizable - - An event related to a touch-based device. - - Extracts whether a touch event is emulating a pointer event. + + An event related to a touch-based device. + + Extracts whether a touch event is emulating a pointer event. + - %TRUE if @event is emulating + %TRUE if @event is emulating - a touch event + a touch event - - An event related to a gesture on a touchpad device. + + An event related to a gesture on a touchpad device. Unlike touchscreens, where the windowing system sends basic sequences of begin, update, end events, and leaves gesture recognition to the clients, touchpad gestures are typically processed by the system, resulting in these events. - Extracts delta information from a touchpad event. + Extracts delta information from a touchpad event. + - a touchpad event + a touchpad event - - return location for x + + return location for x - - return location for y + + return location for y - - Extracts the touchpad gesture phase from a touchpad event. + + Extracts the touchpad gesture phase from a touchpad event. + - the gesture phase of @event + the gesture phase of @event - a touchpad event + a touchpad event - - Extracts the number of fingers from a touchpad event. + + Extracts the number of fingers from a touchpad event. + - the number of fingers for @event + the number of fingers for @event - a touchpad event + a touchpad event - - Extracts the angle delta from a touchpad pinch event. + + Extracts the angle delta from a touchpad pinch event. + - the angle delta of @event + the angle delta of @event - a touchpad pinch event + a touchpad pinch event - - Extracts the scale from a touchpad pinch event. + + Extracts the scale from a touchpad pinch event. + - the scale of @event + the scale of @event - a touchpad pinch event + a touchpad pinch event - - Specifies the current state of a touchpad gesture. + + Specifies the current state of a touchpad gesture. All gestures are guaranteed to begin with an event with phase %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by 0 or several events @@ -17909,29 +28550,60 @@ a pinch gesture). In these cases, the last event will report the phase %GDK_TOUCHPAD_GESTURE_PHASE_CANCEL, this should be used as a hint to undo any visible/permanent changes that were done throughout the progress of the gesture. - - The gesture has begun. + + The gesture has begun. - - The gesture has been updated. + + The gesture has been updated. - - The gesture was finished, changes + + The gesture was finished, changes should be permanently applied. - - The gesture was cancelled, all + + The gesture was cancelled, all changes should be undone. - + + - - `GdkVulkanContext` is an object representing the platform-specific + + `GdkVulkanContext` is an object representing the platform-specific Vulkan draw context. `GdkVulkanContext`s are created for a surface using @@ -17942,7 +28614,9 @@ Support for `GdkVulkanContext` is platform-specific and context creation can fail, returning %NULL context. - Emitted when the images managed by this context have changed. + Emitted when the images managed by this context have changed. Usually this means that the swapchain had to be recreated, for example in response to a change of the surface size. @@ -17951,14 +28625,30 @@ for example in response to a change of the surface size. - - Error enumeration for `GdkVulkanContext`. - - Vulkan is not supported on this backend or has not been + + Error enumeration for `GdkVulkanContext`. + + Vulkan is not supported on this backend or has not been compiled in. - - Vulkan support is not available on this Surface + + Vulkan support is not available on this Surface @@ -17967,7 +28657,9 @@ for example in response to a change of the surface size. - The main way to draw GL content in GTK. + The main way to draw GL content in GTK. It takes a render buffer ID (@source_type == GL_RENDERBUFFER) or a texture id (@source_type == GL_TEXTURE) and draws it onto @cr with an OVER operation, @@ -17985,203 +28677,309 @@ For GL_RENDERBUFFER the code will always fall back to software for buffers with alpha components, so make sure you use GL_TEXTURE if using alpha. Calling this may change the current GL context. + - a cairo context + a cairo context - The surface we're rendering for (not necessarily into) + The surface we're rendering for (not necessarily into) - The GL ID of the source buffer + The GL ID of the source buffer - The type of the @source + The type of the @source - The scale-factor that the @source buffer is allocated for + The scale-factor that the @source buffer is allocated for - The source x position in @source to start copying from in GL coordinates + The source x position in @source to start copying from in GL coordinates - The source y position in @source to start copying from in GL coordinates + The source y position in @source to start copying from in GL coordinates - The width of the region to draw + The width of the region to draw - The height of the region to draw + The height of the region to draw - Adds the given rectangle to the current path of @cr. + Adds the given rectangle to the current path of @cr. + - a cairo context + a cairo context - a `GdkRectangle` + a `GdkRectangle` - Adds the given region to the current path of @cr. + Adds the given region to the current path of @cr. + - a cairo context + a cairo context - a `cairo_region_t` + a `cairo_region_t` - - Creates region that covers the area where the given + + Creates region that covers the area where the given @surface is more than 50% opaque. This function takes into account device offsets that might be set with cairo_surface_set_device_offset(). + - A `cairo_region_t` + A `cairo_region_t` - a cairo surface + a cairo surface - - Sets the given pixbuf as the source pattern for @cr. + + Sets the given pixbuf as the source pattern for @cr. The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y. + - a cairo context + a cairo context - a `GdkPixbuf` + a `GdkPixbuf` - X coordinate of location to place upper left corner of @pixbuf + X coordinate of location to place upper left corner of @pixbuf - Y coordinate of location to place upper left corner of @pixbuf + Y coordinate of location to place upper left corner of @pixbuf - - Sets the specified `GdkRGBA` as the source color of @cr. + + Sets the specified `GdkRGBA` as the source color of @cr. + - a cairo context + a cairo context - a `GdkRGBA` + a `GdkRGBA` - - Read content from the given input stream and deserialize it, asynchronously. + + Read content from the given input stream and deserialize it, asynchronously. The default I/O priority is %G_PRIORITY_DEFAULT (i.e. 0), and lower numbers indicate a higher priority. When the operation is finished, @callback will be called. You must then call [func@Gdk.content_deserialize_finish] to get the result of the operation. + - a `GInputStream` to read the serialized content from + a `GInputStream` to read the serialized content from - the mime type to deserialize from + the mime type to deserialize from - the GType to deserialize from + the GType to deserialize from - the I/O priority of the operation + the I/O priority of the operation - - optional `GCancellable` object + + optional `GCancellable` object - - callback to call when the operation is done + + callback to call when the operation is done - - data to pass to the callback function + + data to pass to the callback function - - Finishes a content deserialization operation. + + Finishes a content deserialization operation. + - %TRUE if the operation was successful. In this case, + %TRUE if the operation was successful. In this case, @value is set. %FALSE if an error occurred. In this case, @error is set - the `GAsyncResult` + the `GAsyncResult` - return location for the result of the operation + return location for the result of the operation - - Parses the given @string into `GdkContentFormats` and + + Parses the given @string into `GdkContentFormats` and returns the formats. Strings printed via [method@Gdk.ContentFormats.to_string] @@ -18189,148 +28987,245 @@ can be read in again successfully using this function. If @string does not describe valid content formats, %NULL is returned. + - the content formats if @string is valid + the content formats if @string is valid - the string to parse + the string to parse - - Registers a function to deserialize object of a given type. + + Registers a function to deserialize object of a given type. + - the mime type which the function can deserialize from + the mime type which the function can deserialize from - the type of objects that the function creates + the type of objects that the function creates - - the callback - + + the callback + - - data that @deserialize can access + + data that @deserialize can access - destroy notify for @data + destroy notify for @data - - Registers a function to serialize objects of a given type. + + Registers a function to serialize objects of a given type. + - the type of objects that the function can serialize + the type of objects that the function can serialize - the mime type to serialize to + the mime type to serialize to - - the callback + + the callback - - data that @serialize can access + + data that @serialize can access - destroy notify for @data + destroy notify for @data - - Serialize content and write it to the given output stream, asynchronously. + + Serialize content and write it to the given output stream, asynchronously. The default I/O priority is %G_PRIORITY_DEFAULT (i.e. 0), and lower numbers indicate a higher priority. When the operation is finished, @callback will be called. You must then call [func@Gdk.content_serialize_finish] to get the result of the operation. + - a `GOutputStream` to write the serialized content to + a `GOutputStream` to write the serialized content to - the mime type to serialize to + the mime type to serialize to - the content to serialize + the content to serialize - the I/O priority of the operation + the I/O priority of the operation - - optional `GCancellable` object + + optional `GCancellable` object - - callback to call when the operation is done + + callback to call when the operation is done - - data to pass to the callback function + + data to pass to the callback function - - Finishes a content serialization operation. + + Finishes a content serialization operation. + - %TRUE if the operation was successful, %FALSE if an + %TRUE if the operation was successful, %FALSE if an error occurred. In this case, @error is set - the `GAsyncResult` + the `GAsyncResult` - - Checks if @action represents a single action or includes + + Checks if @action represents a single action or includes multiple actions. When @action is 0 - ie no action was given, %TRUE is returned. + - %TRUE if exactly one action was given + %TRUE if exactly one action was given - a `GdkDragAction` + a `GdkDragAction` - Returns the relative angle from @event1 to @event2. + Returns the relative angle from @event1 to @event2. The relative angle is the angle between the X axis and the line through both events' positions. The rotation direction for positive @@ -18338,298 +29233,450 @@ angles is from the positive X axis towards the positive Y axis. This assumes that both events have X/Y information. If not, this function returns %FALSE. + - %TRUE if the angle could be calculated. + %TRUE if the angle could be calculated. - first `GdkEvent` + first `GdkEvent` - second `GdkEvent` + second `GdkEvent` - - return location for the relative angle between both events + + return location for the relative angle between both events - Returns the point halfway between the events' positions. + Returns the point halfway between the events' positions. This assumes that both events have X/Y information. If not, this function returns %FALSE. + - %TRUE if the center could be calculated. + %TRUE if the center could be calculated. - first `GdkEvent` + first `GdkEvent` - second `GdkEvent` + second `GdkEvent` - - return location for the X coordinate of the center + + return location for the X coordinate of the center - - return location for the Y coordinate of the center + + return location for the Y coordinate of the center - - Returns the distance between the event locations. + + Returns the distance between the event locations. This assumes that both events have X/Y information. If not, this function returns %FALSE. + - %TRUE if the distance could be calculated. + %TRUE if the distance could be calculated. - first `GdkEvent` + first `GdkEvent` - second `GdkEvent` + second `GdkEvent` - - return location for the distance + + return location for the distance - + - Canonicalizes the given mime type and interns the result. + Canonicalizes the given mime type and interns the result. If @string is not a valid mime type, %NULL is returned instead. See RFC 2048 for the syntax if mime types. + - An interned string for the canonicalized + An interned string for the canonicalized mime type or %NULL if the string wasn't a valid mime type - string of a potential mime type + string of a potential mime type - - Obtains the upper- and lower-case versions of the keyval @symbol. + + Obtains the upper- and lower-case versions of the keyval @symbol. Examples of keyvals are `GDK_KEY_a`, `GDK_KEY_Enter`, `GDK_KEY_F1`, etc. + - a keyval + a keyval - - return location for lowercase version of @symbol + + return location for lowercase version of @symbol - - return location for uppercase version of @symbol + + return location for uppercase version of @symbol - Converts a key name to a key value. + Converts a key name to a key value. The names are the same as those in the `gdk/gdkkeysyms.h` header file -but without the leading “GDK_KEY_”. +but without the leading “GDK_KEY_”. + - the corresponding key value, or %GDK_KEY_VoidSymbol + the corresponding key value, or %GDK_KEY_VoidSymbol if the key name is not a valid key - a key name + a key name - Returns %TRUE if the given key value is in lower case. + Returns %TRUE if the given key value is in lower case. + - %TRUE if @keyval is in lower case, or if @keyval is not + %TRUE if @keyval is in lower case, or if @keyval is not subject to case conversion. - a key value. + a key value. - Returns %TRUE if the given key value is in upper case. + Returns %TRUE if the given key value is in upper case. + - %TRUE if @keyval is in upper case, or if @keyval is not subject to + %TRUE if @keyval is in upper case, or if @keyval is not subject to case conversion. - a key value. + a key value. - Converts a key value into a symbolic name. + Converts a key value into a symbolic name. The names are the same as those in the `gdk/gdkkeysyms.h` header file -but without the leading “GDK_KEY_”. +but without the leading “GDK_KEY_”. + - a string containing the name + a string containing the name of the key - a key value + a key value - Converts a key value to lower case, if applicable. + Converts a key value to lower case, if applicable. + - the lower case form of @keyval, or @keyval itself if it is already + the lower case form of @keyval, or @keyval itself if it is already in lower case or it is not subject to case conversion. - a key value. + a key value. - Convert from a GDK key symbol to the corresponding Unicode + Convert from a GDK key symbol to the corresponding Unicode character. Note that the conversion does not take the current locale into consideration, which might be expected for particular keyvals, such as %GDK_KEY_KP_Decimal. + - the corresponding unicode character, or 0 if there + the corresponding unicode character, or 0 if there is no corresponding character. - a GDK key symbol + a GDK key symbol - Converts a key value to upper case, if applicable. + Converts a key value to upper case, if applicable. + - the upper case form of @keyval, or @keyval itself if it is already + the upper case form of @keyval, or @keyval itself if it is already in upper case or it is not subject to case conversion. - a key value. + a key value. - - Returns a paintable that has the given intrinsic size and draws nothing. + + Returns a paintable that has the given intrinsic size and draws nothing. This is often useful for implementing the [vfunc@Gdk.Paintable.get_current_image] virtual function when the paintable is in an incomplete state (like a [class@Gtk.MediaStream] before receiving the first frame). + - a `GdkPaintable` + a `GdkPaintable` - The intrinsic width to report. Can be 0 for no width. + The intrinsic width to report. Can be 0 for no width. - The intrinsic height to report. Can be 0 for no height. + The intrinsic height to report. Can be 0 for no height. - - Obtains a clip region which contains the areas where the given ranges + + Obtains a clip region which contains the areas where the given ranges of text would be drawn. @x_origin and @y_origin are the top left point to center the layout. -@index_ranges should contain ranges of bytes in the layout’s text. +@index_ranges should contain ranges of bytes in the layout’s text. Note that the regions returned correspond to logical extents of the text ranges, not ink extents. So the drawn layout may in fact touch areas out of the clip region. The clip region is mainly useful for highlightling parts of text, such as when text is selected. + - a clip region containing the given ranges + a clip region containing the given ranges - a `PangoLayout` + a `PangoLayout` - X pixel where you intend to draw the layout with this clip + X pixel where you intend to draw the layout with this clip - Y pixel where you intend to draw the layout with this clip + Y pixel where you intend to draw the layout with this clip - array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes + array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes - number of ranges in @index_ranges, i.e. half the size of @index_ranges + number of ranges in @index_ranges, i.e. half the size of @index_ranges - - Obtains a clip region which contains the areas where the given + + Obtains a clip region which contains the areas where the given ranges of text would be drawn. @x_origin and @y_origin are the top left position of the layout. -@index_ranges should contain ranges of bytes in the layout’s text. +@index_ranges should contain ranges of bytes in the layout’s text. The clip region will include space to the left or right of the line (to the layout bounding box) if you have indexes above or below the indexes contained inside the line. This is to draw the selection all @@ -18640,91 +29687,131 @@ Note that the regions returned correspond to logical extents of the text ranges, not ink extents. So the drawn line may in fact touch areas out of the clip region. The clip region is mainly useful for highlightling parts of text, such as when text is selected. + - a clip region containing the given ranges + a clip region containing the given ranges - a `PangoLayoutLine` + a `PangoLayoutLine` - X pixel where you intend to draw the layout line with this clip + X pixel where you intend to draw the layout line with this clip - baseline pixel where you intend to draw the layout line with this clip + baseline pixel where you intend to draw the layout line with this clip - array of byte indexes into the layout, where even + array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes - number of ranges in @index_ranges, i.e. half the size of @index_ranges + number of ranges in @index_ranges, i.e. half the size of @index_ranges - - Transfers image data from a `cairo_surface_t` and converts it + + Transfers image data from a `cairo_surface_t` and converts it to a `GdkPixbuf`. This allows you to efficiently read individual pixels from cairo surfaces. This function will create an RGB pixbuf with 8 bits per channel. The pixbuf will contain an alpha channel if the @surface contains one. + - A newly-created pixbuf with a + A newly-created pixbuf with a reference count of 1 - surface to copy from + surface to copy from - Source X coordinate within @surface + Source X coordinate within @surface - Source Y coordinate within @surface + Source Y coordinate within @surface - Width in pixels of region to get + Width in pixels of region to get - Height in pixels of region to get + Height in pixels of region to get - - Creates a new pixbuf from @texture. + + Creates a new pixbuf from @texture. This should generally not be used in newly written code as later stages will almost certainly convert the pixbuf back into a texture to draw it on screen. + - a new `GdkPixbuf` + a new `GdkPixbuf` - a `GdkTexture` + a `GdkTexture` - - Sets a list of backends that GDK should try to use. + + Sets a list of backends that GDK should try to use. This can be useful if your application does not work with certain GDK backends. @@ -18757,36 +29844,50 @@ You can also include a `*` in the list to try all remaining backends. This call must happen prior to functions that open a display, such as [func@Gdk.Display.open], `gtk_init()`, or `gtk_init_check()` in order to take effect. + - a comma-separated list of backends + a comma-separated list of backends - + + - Convert from a Unicode character to a key symbol. + Convert from a Unicode character to a key symbol. + - the corresponding GDK key symbol, if one exists. + the corresponding GDK key symbol, if one exists. or, if there is no corresponding symbol, wc | 0x01000000 - a Unicode character + a Unicode character - + diff --git a/GdkPixbuf-2.0.gir b/GdkPixbuf-2.0.gir index 29c33c2..1103822 100644 --- a/GdkPixbuf-2.0.gir +++ b/GdkPixbuf-2.0.gir @@ -2,178 +2,115 @@ - + - - - This enumeration defines the color spaces that are supported by -the gdk-pixbuf library. Currently only RGB is supported. - - Indicates a red/green/blue additive color space. + + + This enumeration defines the color spaces that are supported by +the gdk-pixbuf library. + +Currently only RGB is supported. + + Indicates a red/green/blue additive color space. - - + + - - + + - - + + - - + + - - + + - + - + - - + + - - + + - - This enumeration describes the different interpolation modes that -can be used with the scaling functions. @GDK_INTERP_NEAREST is -the fastest scaling method, but has horrible quality when -scaling down. @GDK_INTERP_BILINEAR is the best choice if you -aren't sure what to choose, it has a good speed/quality balance. + + Interpolation modes for scaling functions. + +The `GDK_INTERP_NEAREST` mode is the fastest scaling method, but has +horrible quality when scaling down; `GDK_INTERP_BILINEAR` is the best +choice if you aren't sure what to choose, it has a good speed/quality +balance. **Note**: Cubic filtering is missing from the list; hyperbolic interpolation is just as fast and results in higher quality. - - Nearest neighbor sampling; this is the fastest + + Nearest neighbor sampling; this is the fastest and lowest quality mode. Quality is normally unacceptable when scaling down, but may be OK when scaling up. - - This is an accurate simulation of the PostScript + + This is an accurate simulation of the PostScript image operator without any interpolation enabled. Each pixel is rendered as a tiny parallelogram of solid color, the edges of which are implemented with antialiasing. It resembles nearest neighbor for enlargement, and bilinear for reduction. - - Best quality/speed balance; use this mode by + + Best quality/speed balance; use this mode by default. Bilinear interpolation. For enlargement, it is equivalent to point-sampling the ideal bilinear-interpolated image. For reduction, it is equivalent to laying down small tiles and integrating over the coverage area. - - This is the slowest and highest quality + + This is the slowest and highest quality reconstruction function. It is derived from the hyperbolic filters in Wolberg's "Digital Image Warping", and is formally defined as the hyperbolic-filter sampling the ideal hyperbolic-filter interpolated @@ -184,336 +121,231 @@ interpolation is just as fast and results in higher quality. - + - - + + - - + + - - + + - - + + - - + + - - + + - - Macro to test the version of GdkPixbuf being compiled against. + + Macro to test the version of GdkPixbuf being compiled against. - major version (e.g. 2 for version 2.34.0) + major version (e.g. 2 for version 2.34.0) - minor version (e.g. 34 for version 2.34.0) + minor version (e.g. 34 for version 2.34.0) - micro version (e.g. 0 for version 2.34.0) + micro version (e.g. 0 for version 2.34.0) - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - - + - + - + @@ -521,534 +353,522 @@ interpolation is just as fast and results in higher quality. - Major version of gdk-pixbuf library, that is the "0" in + Major version of gdk-pixbuf library, that is the "0" in "0.8.2" for example. - + - - Micro version of gdk-pixbuf library, that is the "2" in + + Micro version of gdk-pixbuf library, that is the "2" in "0.8.2" for example. - + - Minor version of gdk-pixbuf library, that is the "8" in + Minor version of gdk-pixbuf library, that is the "8" in "0.8.2" for example. - + - - + + - - + + - - + + - - Contains the full version of the gdk-pixbuf header as a string. + + Contains the full version of GdkPixbuf as a string. + This is the version being compiled against; contrast with -#gdk_pixbuf_version. - +`gdk_pixbuf_version`. + - - This is the main structure in the gdk-pixbuf library. It is -used to represent images. It contains information about the -image's pixel data, its color space, bits per sample, width and -height, and the rowstride (the number of bytes between the start of -one row and the start of the next). + + A pixel buffer. + +`GdkPixbuf` contains information about an image's pixel data, +its color space, bits per sample, width and height, and the +rowstride (the number of bytes between the start of one row +and the start of the next). + +## Creating new `GdkPixbuf` + +The most basic way to create a pixbuf is to wrap an existing pixel +buffer with a [class@GdkPixbuf.Pixbuf] instance. You can use the +[`ctor@GdkPixbuf.Pixbuf.new_from_data`] function to do this. + +Every time you create a new `GdkPixbuf` instance for some data, you +will need to specify the destroy notification function that will be +called when the data buffer needs to be freed; this will happen when +a `GdkPixbuf` is finalized by the reference counting functions. If +you have a chunk of static data compiled into your application, you +can pass in `NULL` as the destroy notification function so that the +data will not be freed. + +The [`ctor@GdkPixbuf.Pixbuf.new`] constructor function can be used +as a convenience to create a pixbuf with an empty buffer; this is +equivalent to allocating a data buffer using `malloc()` and then +wrapping it with `gdk_pixbuf_new_from_data()`. The `gdk_pixbuf_new()` +function will compute an optimal rowstride so that rendering can be +performed with an efficient algorithm. + +As a special case, you can use the [`ctor@GdkPixbuf.Pixbuf.new_from_xpm_data`] +function to create a pixbuf from inline XPM image data. + +You can also copy an existing pixbuf with the [method@Pixbuf.copy] +function. This is not the same as just acquiring a reference to +the old pixbuf instance: the copy function will actually duplicate +the pixel data in memory and create a new [class@Pixbuf] instance +for it. + +## Reference counting + +`GdkPixbuf` structures are reference counted. This means that an +application can share a single pixbuf among many parts of the +code. When a piece of the program needs to use a pixbuf, it should +acquire a reference to it by calling `g_object_ref()`; when it no +longer needs the pixbuf, it should release the reference it acquired +by calling `g_object_unref()`. The resources associated with a +`GdkPixbuf` will be freed when its reference count drops to zero. +Newly-created `GdkPixbuf` instances start with a reference count +of one. + +## Image Data + +Image data in a pixbuf is stored in memory in an uncompressed, +packed format. Rows in the image are stored top to bottom, and +in each row pixels are stored from left to right. + +There may be padding at the end of a row. + +The "rowstride" value of a pixbuf, as returned by [`method@GdkPixbuf.Pixbuf.get_rowstride`], +indicates the number of bytes between rows. + +**NOTE**: If you are copying raw pixbuf data with `memcpy()` note that the +last row in the pixbuf may not be as wide as the full rowstride, but rather +just as wide as the pixel data needs to be; that is: it is unsafe to do +`memcpy (dest, pixels, rowstride * height)` to copy a whole pixbuf. Use +[method@GdkPixbuf.Pixbuf.copy] instead, or compute the width in bytes of the +last row as: + +```c +last_row = width * ((n_channels * bits_per_sample + 7) / 8); +``` + +The same rule applies when iterating over each row of a `GdkPixbuf` pixels +array. + +The following code illustrates a simple `put_pixel()` +function for RGB pixbufs with 8 bits per channel with an alpha +channel. + +```c +static void +put_pixel (GdkPixbuf *pixbuf, + int x, + int y, + guchar red, + guchar green, + guchar blue, + guchar alpha) +{ + int n_channels = gdk_pixbuf_get_n_channels (pixbuf); + + // Ensure that the pixbuf is valid + g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB); + g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8); + g_assert (gdk_pixbuf_get_has_alpha (pixbuf)); + g_assert (n_channels == 4); + + int width = gdk_pixbuf_get_width (pixbuf); + int height = gdk_pixbuf_get_height (pixbuf); + + // Ensure that the coordinates are in a valid range + g_assert (x >= 0 && x < width); + g_assert (y >= 0 && y < height); + + int rowstride = gdk_pixbuf_get_rowstride (pixbuf); + + // The pixel buffer in the GdkPixbuf instance + guchar *pixels = gdk_pixbuf_get_pixels (pixbuf); + + // The pixel we wish to modify + guchar *p = pixels + y * rowstride + x * n_channels; + p[0] = red; + p[1] = green; + p[2] = blue; + p[3] = alpha; +} +``` + +## Loading images + +The `GdkPixBuf` class provides a simple mechanism for loading +an image from a file in synchronous and asynchronous fashion. + +For GUI applications, it is recommended to use the asynchronous +stream API to avoid blocking the control flow of the application. + +Additionally, `GdkPixbuf` provides the [class@GdkPixbuf.PixbufLoader`] +API for progressive image loading. + +## Saving images + +The `GdkPixbuf` class provides methods for saving image data in +a number of file formats. The formatted data can be written to a +file or to a memory buffer. `GdkPixbuf` can also call a user-defined +callback on the data, which allows to e.g. write the image +to a socket or store it in a database. - Creates a new #GdkPixbuf structure and allocates a buffer for it. The -buffer has an optimal rowstride. Note that the buffer is not cleared; + Creates a new `GdkPixbuf` structure and allocates a buffer for it. + +If the allocation of the buffer failed, this function will return `NULL`. + +The buffer has an optimal rowstride. Note that the buffer is not cleared; you will have to fill it completely yourself. - + - A newly-created #GdkPixbuf with a reference count of 1, or -%NULL if not enough memory could be allocated for the image buffer. + A newly-created pixel buffer - Color space for image + Color space for image - Whether the image should have transparency information + Whether the image should have transparency information - Number of bits per color sample + Number of bits per color sample - Width of image in pixels, must be > 0 + Width of image in pixels, must be > 0 - Height of image in pixels, must be > 0 + Height of image in pixels, must be > 0 - - Creates a new #GdkPixbuf out of in-memory readonly image data. + + Creates a new #GdkPixbuf out of in-memory readonly image data. + Currently only RGB images with 8 bits per sample are supported. -This is the #GBytes variant of gdk_pixbuf_new_from_data(). - + +This is the `GBytes` variant of gdk_pixbuf_new_from_data(), useful +for language bindings. + - A newly-created #GdkPixbuf structure with a reference count of 1. + A newly-created pixbuf - Image data in 8-bit/sample packed format inside a #GBytes + Image data in 8-bit/sample packed format inside a #GBytes - Colorspace for the image data + Colorspace for the image data - Whether the data has an opacity channel + Whether the data has an opacity channel - Number of bits per sample + Number of bits per sample - Width of the image in pixels, must be > 0 + Width of the image in pixels, must be > 0 - Height of the image in pixels, must be > 0 + Height of the image in pixels, must be > 0 - Distance in bytes between row starts + Distance in bytes between row starts - - Creates a new #GdkPixbuf out of in-memory image data. Currently only RGB -images with 8 bits per sample are supported. + + Creates a new #GdkPixbuf out of in-memory image data. + +Currently only RGB images with 8 bits per sample are supported. Since you are providing a pre-allocated pixel buffer, you must also specify a way to free that data. This is done with a function of -type #GdkPixbufDestroyNotify. When a pixbuf created with is +type `GdkPixbufDestroyNotify`. When a pixbuf created with is finalized, your destroy notification function will be called, and it is its responsibility to free the pixel array. -See also gdk_pixbuf_new_from_bytes(). - +See also: [ctor@GdkPixbuf.Pixbuf.new_from_bytes] + - A newly-created #GdkPixbuf structure with a reference count of 1. + A newly-created pixbuf - Image data in 8-bit/sample packed format + Image data in 8-bit/sample packed format - Colorspace for the image data + Colorspace for the image data - Whether the data has an opacity channel + Whether the data has an opacity channel - Number of bits per sample + Number of bits per sample - Width of the image in pixels, must be > 0 + Width of the image in pixels, must be > 0 - Height of the image in pixels, must be > 0 + Height of the image in pixels, must be > 0 - Distance in bytes between row starts + Distance in bytes between row starts - - Function used to free the data when the pixbuf's reference count + + Function used to free the data when the pixbuf's reference count drops to zero, or %NULL if the data should not be freed - - Closure data to pass to the destroy notification function + + Closure data to pass to the destroy notification function - - Creates a new pixbuf by loading an image from a file. The file format is -detected automatically. If %NULL is returned, then @error will be set. -Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains. - - - A newly-created pixbuf with a reference count of 1, or %NULL if -any of several error conditions occurred: the file could not be opened, -there was no loader for the file's format, there was not enough memory to -allocate the image buffer, or the image file contained invalid data. + + Creates a new pixbuf by loading an image from a file. + +The file format is detected automatically. + +If `NULL` is returned, then @error will be set. Possible errors are: + + - the file could not be opened + - there is no loader for the file's format + - there is not enough memory to allocate the image buffer + - the image buffer contains invalid data + +The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`. + + + A newly-created pixbuf - Name of file to load, in the GLib file - name encoding + Name of file to load, in the GLib file + name encoding - - Creates a new pixbuf by loading an image from a file. The file format is -detected automatically. If %NULL is returned, then @error will be set. -Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains. + + Creates a new pixbuf by loading an image from a file. + +The file format is detected automatically. + +If `NULL` is returned, then @error will be set. Possible errors are: + + - the file could not be opened + - there is no loader for the file's format + - there is not enough memory to allocate the image buffer + - the image buffer contains invalid data + +The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`. + The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio. -When preserving the aspect ratio, a @width of -1 will cause the image -to be scaled to the exact given height, and a @height of -1 will cause +When preserving the aspect ratio, a `width` of -1 will cause the image +to be scaled to the exact given height, and a `height` of -1 will cause the image to be scaled to the exact given width. When not preserving -aspect ratio, a @width or @height of -1 means to not scale the image -at all in that dimension. Negative values for @width and @height are +aspect ratio, a `width` or `height` of -1 means to not scale the image +at all in that dimension. Negative values for `width` and `height` are allowed since 2.8. - - - A newly-created pixbuf with a reference count of 1, or %NULL -if any of several error conditions occurred: the file could not be opened, -there was no loader for the file's format, there was not enough memory to -allocate the image buffer, or the image file contained invalid data. + + + A newly-created pixbuf - Name of file to load, in the GLib file + Name of file to load, in the GLib file name encoding - The width the image should have or -1 to not constrain the width + The width the image should have or -1 to not constrain the width - The height the image should have or -1 to not constrain the height + The height the image should have or -1 to not constrain the height - %TRUE to preserve the image's aspect ratio + `TRUE` to preserve the image's aspect ratio - - Creates a new pixbuf by loading an image from a file. -The file format is detected automatically. If %NULL is returned, then -@error will be set. Possible errors are in the #GDK_PIXBUF_ERROR and -#G_FILE_ERROR domains. + + Creates a new pixbuf by loading an image from a file. + +The file format is detected automatically. + +If `NULL` is returned, then @error will be set. Possible errors are: + + - the file could not be opened + - there is no loader for the file's format + - there is not enough memory to allocate the image buffer + - the image buffer contains invalid data + +The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`. The image will be scaled to fit in the requested size, preserving the image's aspect ratio. Note that the returned pixbuf may be smaller -than @width x @height, if the aspect ratio requires it. To load +than `width` x `height`, if the aspect ratio requires it. To load and image at the requested size, regardless of aspect ratio, use -gdk_pixbuf_new_from_file_at_scale(). - - - A newly-created pixbuf with a reference count of 1, or -%NULL if any of several error conditions occurred: the file could not -be opened, there was no loader for the file's format, there was not -enough memory to allocate the image buffer, or the image file contained -invalid data. +[ctor@GdkPixbuf.Pixbuf.new_from_file_at_scale]. + + + A newly-created pixbuf - Name of file to load, in the GLib file + Name of file to load, in the GLib file name encoding - The width the image should have or -1 to not constrain the width + The width the image should have or -1 to not constrain the width - The height the image should have or -1 to not constrain the height + The height the image should have or -1 to not constrain the height - - Create a #GdkPixbuf from a flat representation that is suitable for -storing as inline data in a program. This is useful if you want to -ship a program with images, but don't want to depend on any -external files. + + Creates a `GdkPixbuf` from a flat representation that is suitable for +storing as inline data in a program. + +This is useful if you want to ship a program with images, but don't want +to depend on any external files. + +GdkPixbuf ships with a program called `gdk-pixbuf-csource`, which allows +for conversion of `GdkPixbuf`s into such a inline representation. -gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource], -which allows for conversion of #GdkPixbufs into such a inline representation. In almost all cases, you should pass the `--raw` option to `gdk-pixbuf-csource`. A sample invocation would be: -|[ - gdk-pixbuf-csource --raw --name=myimage_inline myimage.png -]| +``` +gdk-pixbuf-csource --raw --name=myimage_inline myimage.png +``` For the typical case where the inline pixbuf is read-only static data, you don't need to copy the pixel data unless you intend to write to -it, so you can pass %FALSE for @copy_pixels. (If you pass `--rle` to -`gdk-pixbuf-csource`, a copy will be made even if @copy_pixels is %FALSE, -so using this option is generally a bad idea.) +it, so you can pass `FALSE` for `copy_pixels`. If you pass `--rle` to +`gdk-pixbuf-csource`, a copy will be made even if `copy_pixels` is `FALSE`, +so using this option is generally a bad idea. If you create a pixbuf from const inline data compiled into your program, it's probably safe to ignore errors and disable length checks, since things will always succeed: -|[ + +```c pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL); -]| +``` For non-const inline data, you could get out of memory. For untrusted inline data located at runtime, you could have corrupt inline data in addition. - Use #GResource instead. - + Use `GResource` instead. + - A newly-created #GdkPixbuf structure with a reference, - count of 1, or %NULL if an error occurred. + A newly-created pixbuf - Length in bytes of the @data argument or -1 to - disable length checks + Length in bytes of the `data` argument or -1 to + disable length checks - Byte data containing a - serialized #GdkPixdata structure + Byte data containing a + serialized `GdkPixdata` structure - Whether to copy the pixel data, or use direct pointers - @data for the resulting pixbuf + Whether to copy the pixel data, or use direct pointers + `data` for the resulting pixbuf - - Creates a new pixbuf by loading an image from an resource. + + Creates a new pixbuf by loading an image from an resource. -The file format is detected automatically. If %NULL is returned, then +The file format is detected automatically. If `NULL` is returned, then @error will be set. - - - A newly-created pixbuf, or %NULL if any of several error -conditions occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled. + + + A newly-created pixbuf - the path of the resource file + the path of the resource file - - Creates a new pixbuf by loading an image from an resource. + + Creates a new pixbuf by loading an image from an resource. -The file format is detected automatically. If %NULL is returned, then +The file format is detected automatically. If `NULL` is returned, then @error will be set. The image will be scaled to fit in the requested size, optionally @@ -1059,317 +879,202 @@ exact given width. When not preserving aspect ratio, a @width or @height of -1 means to not scale the image at all in that dimension. The stream is not closed. - - - A newly-created pixbuf, or %NULL if any of several error -conditions occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled. + + + A newly-created pixbuf - the path of the resource file + the path of the resource file - The width the image should have or -1 to not constrain the width + The width the image should have or -1 to not constrain the width - The height the image should have or -1 to not constrain the height + The height the image should have or -1 to not constrain the height - %TRUE to preserve the image's aspect ratio + `TRUE` to preserve the image's aspect ratio - - Creates a new pixbuf by loading an image from an input stream. + + Creates a new pixbuf by loading an image from an input stream. -The file format is detected automatically. If %NULL is returned, then -@error will be set. The @cancellable can be used to abort the operation -from another thread. If the operation was cancelled, the error -%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in -the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. +The file format is detected automatically. + +If `NULL` is returned, then `error` will be set. + +The `cancellable` can be used to abort the operation from another thread. +If the operation was cancelled, the error `G_IO_ERROR_CANCELLED` will be +returned. Other possible errors are in the `GDK_PIXBUF_ERROR` and +`G_IO_ERROR` domains. The stream is not closed. - - - A newly-created pixbuf, or %NULL if any of several error -conditions occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled. + + + A newly-created pixbuf - a #GInputStream to load the pixbuf from + a `GInputStream` to load the pixbuf from - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - Creates a new pixbuf by loading an image from an input stream. + + Creates a new pixbuf by loading an image from an input stream. -The file format is detected automatically. If %NULL is returned, then +The file format is detected automatically. If `NULL` is returned, then @error will be set. The @cancellable can be used to abort the operation from another thread. If the operation was cancelled, the error -%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in -the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. +`G_IO_ERROR_CANCELLED` will be returned. Other possible errors are in +the `GDK_PIXBUF_ERROR` and `G_IO_ERROR` domains. The image will be scaled to fit in the requested size, optionally preserving the image's aspect ratio. -When preserving the aspect ratio, a @width of -1 will cause the image to be -scaled to the exact given height, and a @height of -1 will cause the image -to be scaled to the exact given width. If both @width and @height are +When preserving the aspect ratio, a `width` of -1 will cause the image to be +scaled to the exact given height, and a `height` of -1 will cause the image +to be scaled to the exact given width. If both `width` and `height` are given, this function will behave as if the smaller of the two values is passed as -1. -When not preserving aspect ratio, a @width or @height of -1 means to not +When not preserving aspect ratio, a `width` or `height` of -1 means to not scale the image at all in that dimension. The stream is not closed. - - - A newly-created pixbuf, or %NULL if any of several error -conditions occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled. + + + A newly-created pixbuf - a #GInputStream to load the pixbuf from + a `GInputStream` to load the pixbuf from - The width the image should have or -1 to not constrain the width + The width the image should have or -1 to not constrain the width - The height the image should have or -1 to not constrain the height + The height the image should have or -1 to not constrain the height - %TRUE to preserve the image's aspect ratio + `TRUE` to preserve the image's aspect ratio - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - Finishes an asynchronous pixbuf creation operation started with + + Finishes an asynchronous pixbuf creation operation started with gdk_pixbuf_new_from_stream_async(). - - - a #GdkPixbuf or %NULL on error. Free the returned -object with g_object_unref(). + + + the newly created pixbuf - a #GAsyncResult + a `GAsyncResult` - - Creates a new pixbuf by parsing XPM data in memory. This data is commonly -the result of including an XPM file into a program's C source. - + + Creates a new pixbuf by parsing XPM data in memory. + +This data is commonly the result of including an XPM file into a +program's C source. + - A newly-created pixbuf with a reference count of 1. + A newly-created pixbuf - Pointer to inline XPM data. + Pointer to inline XPM data. - - Calculates the rowstride that an image created with those values would -have. This is useful for front-ends and backends that want to sanity -check image values without needing to create them. - + + Calculates the rowstride that an image created with those values would +have. + +This function is useful for front-ends and backends that want to check +image values without needing to create a `GdkPixbuf`. + - the rowstride for the given values, or -1 in case of error. + the rowstride for the given values, or -1 in case of error. - Color space for image + Color space for image - Whether the image should have transparency information + Whether the image should have transparency information - Number of bits per color sample + Number of bits per color sample - Width of image in pixels, must be > 0 + Width of image in pixels, must be > 0 - Height of image in pixels, must be > 0 + Height of image in pixels, must be > 0 - - Parses an image file far enough to determine its format and size. + + Parses an image file far enough to determine its format and size. - A #GdkPixbufFormat describing - the image format of the file or %NULL if the image format wasn't - recognized. The return value is owned by #GdkPixbuf and should - not be freed. + A `GdkPixbufFormat` describing + the image format of the file - The name of the file to identify. + The name of the file to identify. - - Return location for the width of the - image, or %NULL + + Return location for the width of the image - - Return location for the height of the - image, or %NULL + + Return location for the height of the image - - Asynchronously parses an image file far enough to determine its + + Asynchronously parses an image file far enough to determine its format and size. For more details see gdk_pixbuf_get_file_info(), which is the synchronous @@ -1384,114 +1089,61 @@ get the result of the operation. - The name of the file to identify + The name of the file to identify - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - a #GAsyncReadyCallback to call when the file info is available + + a `GAsyncReadyCallback` to call when the file info is available - - the data to pass to the callback function + + the data to pass to the callback function - - Finishes an asynchronous pixbuf parsing operation started with + + Finishes an asynchronous pixbuf parsing operation started with gdk_pixbuf_get_file_info_async(). - - A #GdkPixbufFormat describing the image - format of the file or %NULL if the image format wasn't - recognized. The return value is owned by GdkPixbuf and should - not be freed. + + A `GdkPixbufFormat` describing the + image format of the file - a #GAsyncResult + a `GAsyncResult` - - Return location for the width of the image, or %NULL + + Return location for the width of the image, or `NULL` - - Return location for the height of the image, or %NULL + + Return location for the height of the image, or `NULL` - - Obtains the available information about the image formats supported + + Obtains the available information about the image formats supported by GdkPixbuf. - A list of -#GdkPixbufFormats describing the supported image formats. The list should -be freed when it is no longer needed, but the structures themselves are -owned by #GdkPixbuf and should not be freed. + A list of + support image formats. - - Initalizes the gdk-pixbuf loader modules referenced by the loaders.cache + + Initalizes the gdk-pixbuf loader modules referenced by the `loaders.cache` file present inside that directory. This is to be used by applications that want to ship certain loaders @@ -1510,256 +1162,170 @@ provided modules. - Path to directory where the loaders.cache is installed + Path to directory where the `loaders.cache` is installed - - Creates a new pixbuf by asynchronously loading an image from an input stream. + + Creates a new pixbuf by asynchronously loading an image from an input stream. For more details see gdk_pixbuf_new_from_stream(), which is the synchronous version of this function. When the operation is finished, @callback will be called in the main thread. -You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation. - +You can then call gdk_pixbuf_new_from_stream_finish() to get the result of +the operation. + - a #GInputStream from which to load the pixbuf + a `GInputStream` from which to load the pixbuf - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - a #GAsyncReadyCallback to call when the pixbuf is loaded + + a `GAsyncReadyCallback` to call when the pixbuf is loaded - - the data to pass to the callback function + + the data to pass to the callback function - - Creates a new pixbuf by asynchronously loading an image from an input stream. + + Creates a new pixbuf by asynchronously loading an image from an input stream. For more details see gdk_pixbuf_new_from_stream_at_scale(), which is the synchronous version of this function. When the operation is finished, @callback will be called in the main thread. You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation. - + - a #GInputStream from which to load the pixbuf + a `GInputStream` from which to load the pixbuf - the width the image should have or -1 to not constrain the width + the width the image should have or -1 to not constrain the width - the height the image should have or -1 to not constrain the height + the height the image should have or -1 to not constrain the height - %TRUE to preserve the image's aspect ratio + `TRUE` to preserve the image's aspect ratio - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - a #GAsyncReadyCallback to call when the pixbuf is loaded + + a `GAsyncReadyCallback` to call when the pixbuf is loaded - - the data to pass to the callback function + + the data to pass to the callback function - - Finishes an asynchronous pixbuf save operation started with + + Finishes an asynchronous pixbuf save operation started with gdk_pixbuf_save_to_stream_async(). - + - %TRUE if the pixbuf was saved successfully, %FALSE if an error was set. + `TRUE` if the pixbuf was saved successfully, `FALSE` if an error was set. - a #GAsyncResult + a `GAsyncResult` - Takes an existing pixbuf and adds an alpha channel to it. + Takes an existing pixbuf and adds an alpha channel to it. + If the existing pixbuf already had an alpha channel, the channel values are copied from the original; otherwise, the alpha channel is initialized to 255 (full opacity). -If @substitute_color is %TRUE, then the color specified by (@r, @g, @b) will be -assigned zero opacity. That is, if you pass (255, 255, 255) for the -substitute color, all white pixels will become fully transparent. - +If `substitute_color` is `TRUE`, then the color specified by the +(`r`, `g`, `b`) arguments will be assigned zero opacity. That is, +if you pass `(255, 255, 255)` for the substitute color, all white +pixels will become fully transparent. + +If `substitute_color` is `FALSE`, then the (`r`, `g`, `b`) arguments +will be ignored. + - A newly-created pixbuf with a reference count of 1. + A newly-created pixbuf - A #GdkPixbuf. + A #GdkPixbuf. - Whether to set a color to zero opacity. If this -is %FALSE, then the (@r, @g, @b) arguments will be ignored. + Whether to set a color to zero opacity. - Red value to substitute. + Red value to substitute. - Green value to substitute. + Green value to substitute. - Blue value to substitute. + Blue value to substitute. - - Takes an existing pixbuf and checks for the presence of an -associated "orientation" option, which may be provided by the -jpeg loader (which reads the exif orientation tag) or the -tiff loader (which reads the tiff orientation tag, and -compensates it for the partial transforms performed by -libtiff). If an orientation option/tag is present, the -appropriate transform will be performed so that the pixbuf -is oriented correctly. - - - A newly-created pixbuf, %NULL if -not enough memory could be allocated for it, or a reference to the -input pixbuf (with an increased reference count). + + Takes an existing pixbuf and checks for the presence of an +associated "orientation" option. + +The orientation option may be provided by the JPEG loader (which +reads the exif orientation tag) or the TIFF loader (which reads +the TIFF orientation tag, and compensates it for the partial +transforms performed by libtiff). + +If an orientation option/tag is present, the appropriate transform +will be performed so that the pixbuf is oriented correctly. + + + A newly-created pixbuf - A #GdkPixbuf. + a pixbuf with an orientation option - Creates a transformation of the source image @src by scaling by + Creates a transformation of the source image @src by scaling by @scale_x and @scale_y then translating by @offset_x and @offset_y. + This gives an image in the coordinates of the destination pixbuf. The rectangle (@dest_x, @dest_y, @dest_width, @dest_height) is then alpha blended onto the corresponding rectangle of the @@ -1770,90 +1336,63 @@ image, the data at the edges of the source image is replicated to infinity. ![](composite.png) - + - a #GdkPixbuf + a #GdkPixbuf - the #GdkPixbuf into which to render the results + the #GdkPixbuf into which to render the results - the left coordinate for region to render + the left coordinate for region to render - the top coordinate for region to render + the top coordinate for region to render - the width of the region to render + the width of the region to render - the height of the region to render + the height of the region to render - the offset in the X direction (currently rounded to an integer) + the offset in the X direction (currently rounded to an integer) - the offset in the Y direction (currently rounded to an integer) + the offset in the Y direction (currently rounded to an integer) - the scale factor in the X direction + the scale factor in the X direction - the scale factor in the Y direction + the scale factor in the Y direction - the interpolation type for the transformation. + the interpolation type for the transformation. - overall alpha for source image (0..255) + overall alpha for source image (0..255) - Creates a transformation of the source image @src by scaling by + Creates a transformation of the source image @src by scaling by @scale_x and @scale_y then translating by @offset_x and @offset_y, then alpha blends the rectangle (@dest_x ,@dest_y, @dest_width, @dest_height) of the resulting image with a checkboard of the @@ -1865,493 +1404,340 @@ path is used which omits the alpha blending and just performs the scaling. See gdk_pixbuf_composite_color_simple() for a simpler variant of this function suitable for many tasks. - + - a #GdkPixbuf + a #GdkPixbuf - the #GdkPixbuf into which to render the results + the #GdkPixbuf into which to render the results - the left coordinate for region to render + the left coordinate for region to render - the top coordinate for region to render + the top coordinate for region to render - the width of the region to render + the width of the region to render - the height of the region to render + the height of the region to render - the offset in the X direction (currently rounded to an integer) + the offset in the X direction (currently rounded to an integer) - the offset in the Y direction (currently rounded to an integer) + the offset in the Y direction (currently rounded to an integer) - the scale factor in the X direction + the scale factor in the X direction - the scale factor in the Y direction + the scale factor in the Y direction - the interpolation type for the transformation. + the interpolation type for the transformation. - overall alpha for source image (0..255) + overall alpha for source image (0..255) - the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y) + the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y) - the Y offset for the checkboard + the Y offset for the checkboard - the size of checks in the checkboard (must be a power of two) + the size of checks in the checkboard (must be a power of two) - the color of check at upper left + the color of check at upper left - the color of the other check + the color of the other check - - Creates a new #GdkPixbuf by scaling @src to @dest_width x -@dest_height and alpha blending the result with a checkboard of colors -@color1 and @color2. - + + Creates a new pixbuf by scaling `src` to `dest_width` x `dest_height` +and alpha blending the result with a checkboard of colors `color1` +and `color2`. + - the new #GdkPixbuf, or %NULL if not enough memory could be -allocated for it. + the new pixbuf - a #GdkPixbuf + a #GdkPixbuf - the width of destination image + the width of destination image - the height of destination image + the height of destination image - the interpolation type for the transformation. + the interpolation type for the transformation. - overall alpha for source image (0..255) + overall alpha for source image (0..255) - the size of checks in the checkboard (must be a power of two) + the size of checks in the checkboard (must be a power of two) - the color of check at upper left + the color of check at upper left - the color of the other check + the color of the other check - Creates a new #GdkPixbuf with a copy of the information in the specified -@pixbuf. Note that this does not copy the options set on the original #GdkPixbuf, + Creates a new `GdkPixbuf` with a copy of the information in the specified +`pixbuf`. + +Note that this does not copy the options set on the original `GdkPixbuf`, use gdk_pixbuf_copy_options() for this. - + - A newly-created pixbuf with a reference count of 1, or %NULL if -not enough memory could be allocated. + A newly-created pixbuf - A pixbuf. + A pixbuf. - Copies a rectangular area from @src_pixbuf to @dest_pixbuf. Conversion of -pixbuf formats is done automatically. + Copies a rectangular area from `src_pixbuf` to `dest_pixbuf`. + +Conversion of pixbuf formats is done automatically. If the source rectangle overlaps the destination rectangle on the same pixbuf, it will be overwritten during the copy operation. Therefore, you can not use this function to scroll a pixbuf. - + - Source pixbuf. + Source pixbuf. - Source X coordinate within @src_pixbuf. + Source X coordinate within @src_pixbuf. - Source Y coordinate within @src_pixbuf. + Source Y coordinate within @src_pixbuf. - Width of the area to copy. + Width of the area to copy. - Height of the area to copy. + Height of the area to copy. - Destination pixbuf. + Destination pixbuf. - X coordinate within @dest_pixbuf. + X coordinate within @dest_pixbuf. - Y coordinate within @dest_pixbuf. + Y coordinate within @dest_pixbuf. - - Copy the key/value pair options attached to a #GdkPixbuf to another. + + Copies the key/value pair options attached to a `GdkPixbuf` to another +`GdkPixbuf`. + This is useful to keep original metadata after having manipulated a file. However be careful to remove metadata which you've already applied, such as the "orientation" option after rotating the image. - + - %TRUE on success. + `TRUE` on success. - a #GdkPixbuf to copy options from + the source pixbuf - the #GdkPixbuf to copy options to + the destination pixbuf - Clears a pixbuf to the given RGBA value, converting the RGBA value into -the pixbuf's pixel format. The alpha will be ignored if the pixbuf -doesn't have an alpha channel. - + Clears a pixbuf to the given RGBA value, converting the RGBA value into +the pixbuf's pixel format. + +The alpha component will be ignored if the pixbuf doesn't have an alpha +channel. + - a #GdkPixbuf + a `GdkPixbuf` - RGBA pixel to clear to - (0xffffffff is opaque white, 0x00000000 transparent black) + RGBA pixel to used to clear (`0xffffffff` is opaque white, + `0x00000000` transparent black) - Flips a pixbuf horizontally or vertically and returns the + Flips a pixbuf horizontally or vertically and returns the result in a new pixbuf. - + - the new #GdkPixbuf, or %NULL -if not enough memory could be allocated for it. + the new pixbuf - a #GdkPixbuf + a #GdkPixbuf - %TRUE to flip horizontally, %FALSE to flip vertically + `TRUE` to flip horizontally, `FALSE` to flip vertically - - Queries the number of bits per color sample in a pixbuf. - + + Queries the number of bits per color sample in a pixbuf. + - Number of bits per color sample. + Number of bits per color sample. - A pixbuf. + A pixbuf. - - Returns the length of the pixel data, in bytes. - + + Returns the length of the pixel data, in bytes. + - The length of the pixel data. + The length of the pixel data. - A pixbuf + A pixbuf - Queries the color space of a pixbuf. - + Queries the color space of a pixbuf. + - Color space. + Color space. - A pixbuf. + A pixbuf. - Queries whether a pixbuf has an alpha channel (opacity information). - + Queries whether a pixbuf has an alpha channel (opacity information). + - %TRUE if it has an alpha channel, %FALSE otherwise. + `TRUE` if it has an alpha channel, `FALSE` otherwise. - A pixbuf. + A pixbuf. - Queries the height of a pixbuf. - + Queries the height of a pixbuf. + - Height in pixels. + Height in pixels. - A pixbuf. + A pixbuf. - Queries the number of channels of a pixbuf. - + Queries the number of channels of a pixbuf. + - Number of channels. + Number of channels. - A pixbuf. + A pixbuf. - Looks up @key in the list of options that may have been attached to the + Looks up @key in the list of options that may have been attached to the @pixbuf when it was loaded, or that may have been attached by another function using gdk_pixbuf_set_option(). @@ -2366,46 +1752,30 @@ Since 2.32 the JPEG and PNG loaders set "x-dpi" and "y-dpi" if the file contains image density information in dots per inch. Since 2.36.6, the JPEG loader sets the "comment" option with the comment EXIF tag. - - - the value associated with @key. This is a nul-terminated -string that should not be freed or %NULL if @key was not found. + + + the value associated with `key` - a #GdkPixbuf + a `GdkPixbuf` - a nul-terminated string. + a nul-terminated string. - - Returns a #GHashTable with a list of all the options that may have been -attached to the @pixbuf when it was loaded, or that may have been -attached by another function using gdk_pixbuf_set_option(). - -See gdk_pixbuf_get_option() for more details. - + + Returns a `GHashTable` with a list of all the options that may have been +attached to the `pixbuf` when it was loaded, or that may have been +attached by another function using [method@GdkPixbuf.Pixbuf.set_option]. + - a #GHashTable of key/values + a #GHashTable + of key/values pairs @@ -2413,193 +1783,136 @@ See gdk_pixbuf_get_option() for more details. - a #GdkPixbuf + a `GdkPixbuf` - - Queries a pointer to the pixel data of a pixbuf. - - - A pointer to the pixbuf's pixel data. -Please see the section on [image data][image-data] for information -about how the pixel data is stored in memory. + + Queries a pointer to the pixel data of a pixbuf. This function will cause an implicit copy of the pixbuf data if the -pixbuf was created from read-only data. +pixbuf was created from read-only data. + +Please see the section on [image data](#image-data) for information +about how the pixel data is stored in memory. + + + A pointer to the pixbuf's pixel data. - A pixbuf. + A pixbuf. - - Queries a pointer to the pixel data of a pixbuf. - - - A pointer to the pixbuf's -pixel data. Please see the section on [image data][image-data] -for information about how the pixel data is stored in memory. + + Queries a pointer to the pixel data of a pixbuf. This function will cause an implicit copy of the pixbuf data if the -pixbuf was created from read-only data. +pixbuf was created from read-only data. + +Please see the section on [image data](#image-data) for information +about how the pixel data is stored in memory. + + + A pointer to the pixbuf's +pixel data. - A pixbuf. + A pixbuf. - - The length of the binary data. + + The length of the binary data. - Queries the rowstride of a pixbuf, which is the number of bytes between + Queries the rowstride of a pixbuf, which is the number of bytes between the start of a row and the start of the next row. - + - Distance between row starts. + Distance between row starts. - A pixbuf. + A pixbuf. - Queries the width of a pixbuf. - + Queries the width of a pixbuf. + - Width in pixels. + Width in pixels. - A pixbuf. + A pixbuf. - Creates a new pixbuf which represents a sub-region of @src_pixbuf. + Creates a new pixbuf which represents a sub-region of `src_pixbuf`. + The new pixbuf shares its pixels with the original pixbuf, so writing to one affects both. The new pixbuf holds a reference to -@src_pixbuf, so @src_pixbuf will not be finalized until the new +`src_pixbuf`, so `src_pixbuf` will not be finalized until the new pixbuf is finalized. -Note that if @src_pixbuf is read-only, this function will force it +Note that if `src_pixbuf` is read-only, this function will force it to be mutable. - + - a new pixbuf + a new pixbuf - a #GdkPixbuf + a `GdkPixbuf` - X coord in @src_pixbuf + X coord in @src_pixbuf - Y coord in @src_pixbuf + Y coord in @src_pixbuf - width of region in @src_pixbuf + width of region in @src_pixbuf - height of region in @src_pixbuf + height of region in @src_pixbuf - - Provides a #GBytes buffer containing the raw pixel data; the data -must not be modified. This function allows skipping the implicit -copy that must be made if gdk_pixbuf_get_pixels() is called on a -read-only pixbuf. - + + Provides a #GBytes buffer containing the raw pixel data; the data +must not be modified. + +This function allows skipping the implicit copy that must be made +if gdk_pixbuf_get_pixels() is called on a read-only pixbuf. + - A new reference to a read-only copy of + A new reference to a read-only copy of the pixel data. Note that for mutable pixbufs, this function will incur a one-time copy of the pixel data for conversion into the returned #GBytes. @@ -2607,180 +1920,127 @@ read-only pixbuf. - A pixbuf + A pixbuf - - Provides a read-only pointer to the raw pixel data; must not be -modified. This function allows skipping the implicit copy that -must be made if gdk_pixbuf_get_pixels() is called on a read-only -pixbuf. - + + Provides a read-only pointer to the raw pixel data. + +This function allows skipping the implicit copy that must be made +if gdk_pixbuf_get_pixels() is called on a read-only pixbuf. + - a read-only pointer to the raw pixel data + a read-only pointer to the raw pixel data - A pixbuf + A pixbuf - - Adds a reference to a pixbuf. + + Adds a reference to a pixbuf. Use g_object_ref(). - + - The same as the @pixbuf argument. + The same as the @pixbuf argument. - A pixbuf. + A pixbuf. - - Remove the key/value pair option attached to a #GdkPixbuf. - + + Removes the key/value pair option attached to a `GdkPixbuf`. + - %TRUE if an option was removed, %FALSE if not. + `TRUE` if an option was removed, `FALSE` if not. - a #GdkPixbuf + a `GdkPixbuf` - a nul-terminated string representing the key to remove. + a nul-terminated string representing the key to remove. - - Rotates a pixbuf by a multiple of 90 degrees, and returns the + + Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf. -If @angle is 0, a copy of @src is returned, avoiding any rotation. - +If `angle` is 0, this function will return a copy of `src`. + - the new #GdkPixbuf, or %NULL -if not enough memory could be allocated for it. + the new pixbuf - a #GdkPixbuf + a #GdkPixbuf - the angle to rotate by + the angle to rotate by - - Modifies saturation and optionally pixelates @src, placing the result in -@dest. @src and @dest may be the same pixbuf with no ill effects. If -@saturation is 1.0 then saturation is not changed. If it's less than 1.0, + + Modifies saturation and optionally pixelates `src`, placing the result in +`dest`. + +The `src` and `dest` pixbufs must have the same image format, size, and +rowstride. + +The `src` and `dest` arguments may be the same pixbuf with no ill effects. + +If `saturation` is 1.0 then saturation is not changed. If it's less than 1.0, saturation is reduced (the image turns toward grayscale); if greater than -1.0, saturation is increased (the image gets more vivid colors). If @pixelate -is %TRUE, then pixels are faded in a checkerboard pattern to create a -pixelated image. @src and @dest must have the same image format, size, and -rowstride. - +1.0, saturation is increased (the image gets more vivid colors). + +If `pixelate` is `TRUE`, then pixels are faded in a checkerboard pattern to +create a pixelated image. + - source image + source image - place to write modified version of @src + place to write modified version of @src - saturation factor + saturation factor - whether to pixelate + whether to pixelate - Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico" + Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed. The list of all writable formats can be determined in the following way: -|[ +```c void add_if_writable (GdkPixbufFormat *data, GSList **list) { if (gdk_pixbuf_format_is_writable (data)) @@ -2791,1253 +2051,858 @@ GSList *formats = gdk_pixbuf_get_formats (); GSList *writable_formats = NULL; g_slist_foreach (formats, add_if_writable, &writable_formats); g_slist_free (formats); -]| +``` -If @error is set, %FALSE will be returned. Possible errors include -those in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain. +If `error` is set, `FALSE` will be returned. Possible errors include +those in the `GDK_PIXBUF_ERROR` domain and those in the `G_FILE_ERROR` +domain. -The variable argument list should be %NULL-terminated; if not empty, +The variable argument list should be `NULL`-terminated; if not empty, it should contain pairs of strings that modify the save parameters. For example: -|[ -gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL); -]| -Currently only few parameters exist. JPEG images can be saved with a -"quality" parameter; its value should be in the range [0,100]. JPEG -and PNG density can be set by setting the "x-dpi" and "y-dpi" parameters -to the appropriate values in dots per inch. +```c +gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL); +``` + +Currently only few parameters exist. + +JPEG images can be saved with a "quality" parameter; its value should be +in the range `[0, 100]`. JPEG and PNG density can be set by setting the +"x-dpi" and "y-dpi" parameters to the appropriate values in dots per inch. Text chunks can be attached to PNG images by specifying parameters of the form "tEXt::key", where key is an ASCII string of length 1-79. The values are UTF-8 encoded strings. The PNG compression level can be specified using the "compression" parameter; it's value is in an -integer in the range of [0,9]. +integer in the range of `[0, 9]`. ICC color profiles can also be embedded into PNG, JPEG and TIFF images. The "icc-profile" value should be the complete ICC profile encoded into base64. -|[ -gchar *contents; -gchar *contents_encode; +```c +char *contents; gsize length; -g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL); -contents_encode = g_base64_encode ((const guchar *) contents, length); -gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode, NULL); -]| -TIFF images recognize: (1) a "bits-per-sample" option (integer) which -can be either 1 for saving bi-level CCITTFAX4 images, or 8 for saving -8-bits per sample; (2) a "compression" option (integer) which can be -1 for no compression, 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for -DEFLATE (see the libtiff documentation and tiff.h for all supported -codec values); (3) an "icc-profile" option (zero-terminated string) -containing a base64 encoded ICC color profile. +// icm_path is set elsewhere +g_file_get_contents (icm_path, &contents, &length, NULL); + +char *contents_encode = g_base64_encode ((const guchar *) contents, length); + +gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode, NULL); +``` + +TIFF images recognize: + + 1. a "bits-per-sample" option (integer) which can be either 1 for saving + bi-level CCITTFAX4 images, or 8 for saving 8-bits per sample + 2. a "compression" option (integer) which can be 1 for no compression, + 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for DEFLATE (see the libtiff + documentation and tiff.h for all supported codec values) + 3. an "icc-profile" option (zero-terminated string) containing a base64 + encoded ICC color profile. ICO images can be saved in depth 16, 24, or 32, by using the "depth" parameter. When the ICO saver is given "x_hot" and "y_hot" parameters, it produces a CUR instead of an ICO. - + - whether an error was set + `TRUE` on success, and `FALSE` otherwise - a #GdkPixbuf. + a `GdkPixbuf`. - name of file to save. + name of file to save. - name of file format. + name of file format. - - return location for error, or %NULL + + return location for error - list of key-value save options, followed by %NULL + list of key-value save options, followed by `NULL` - - Saves pixbuf to a new buffer in format @type, which is currently "jpeg", -"png", "tiff", "ico" or "bmp". This is a convenience function that uses -gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer -is not nul-terminated and may contain embedded nuls. -If @error is set, %FALSE will be returned and @buffer will be set to -%NULL. Possible errors include those in the #GDK_PIXBUF_ERROR + + Saves pixbuf to a new buffer in format `type`, which is currently "jpeg", +"png", "tiff", "ico" or "bmp". + +This is a convenience function that uses `gdk_pixbuf_save_to_callback()` +to do the real work. + +Note that the buffer is not `NUL`-terminated and may contain embedded `NUL` +characters. + +If @error is set, `FALSE` will be returned and @buffer will be set to +`NULL`. Possible errors include those in the `GDK_PIXBUF_ERROR` domain. -See gdk_pixbuf_save() for more details. - +See `gdk_pixbuf_save()` for more details. + - whether an error was set + whether an error was set - a #GdkPixbuf. + a `GdkPixbuf`. - - location to receive a pointer + + location to receive a pointer to the new buffer. - - location to receive the size of the new buffer. + + location to receive the size of the new buffer. - name of file format. + name of file format. - - return location for error, or %NULL + + return location for error, or `NULL` - list of key-value save options + list of key-value save options - - Saves pixbuf to a new buffer in format @type, which is currently "jpeg", -"tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer() -for more details. - + + Vector version of `gdk_pixbuf_save_to_buffer()`. + +Saves pixbuf to a new buffer in format @type, which is currently "jpeg", +"tiff", "png", "ico" or "bmp". + +See [method@GdkPixbuf.Pixbuf.save_to_buffer] for more details. + - whether an error was set + whether an error was set - a #GdkPixbuf. + a `GdkPixbuf`. - - + + location to receive a pointer to the new buffer. - - location to receive the size of the new buffer. + + location to receive the size of the new buffer. - name of file format. + name of file format. - - name of options to set, %NULL-terminated + + name of options to set - + - - values for named options + + values for named options - + - - Saves pixbuf in format @type by feeding the produced data to a -callback. Can be used when you want to store the image to something + + Saves pixbuf in format `type` by feeding the produced data to a +callback. + +This function can be used when you want to store the image to something other than a file, such as an in-memory buffer or a socket. -If @error is set, %FALSE will be returned. Possible errors -include those in the #GDK_PIXBUF_ERROR domain and whatever the save + +If @error is set, `FALSE` will be returned. Possible errors +include those in the `GDK_PIXBUF_ERROR` domain and whatever the save function generates. -See gdk_pixbuf_save() for more details. - +See [method@GdkPixbuf.Pixbuf.save] for more details. + - whether an error was set + whether an error was set - a #GdkPixbuf. + a `GdkPixbuf`. - - a function that is called to save each block of data that + + a function that is called to save each block of data that the save routine generates. - - user data to pass to the save function. + + user data to pass to the save function. - name of file format. + name of file format. - - return location for error, or %NULL + + return location for error, or `NULL` - list of key-value save options + list of key-value save options - - Saves pixbuf to a callback in format @type, which is currently "jpeg", -"png", "tiff", "ico" or "bmp". If @error is set, %FALSE will be returned. See -gdk_pixbuf_save_to_callback () for more details. - + + Vector version of `gdk_pixbuf_save_to_callback()`. + +Saves pixbuf to a callback in format @type, which is currently "jpeg", +"png", "tiff", "ico" or "bmp". + +If @error is set, `FALSE` will be returned. + +See [method@GdkPixbuf.Pixbuf.save_to_callback] for more details. + - whether an error was set + whether an error was set - a #GdkPixbuf. + a `GdkPixbuf`. - - a function that is called to save each block of data that + + a function that is called to save each block of data that the save routine generates. - - user data to pass to the save function. + + user data to pass to the save function. - name of file format. + name of file format. - - name of options to set, %NULL-terminated + + name of options to set - - values for named options + + values for named options - - Saves @pixbuf to an output stream. + + Saves `pixbuf` to an output stream. Supported file formats are currently "jpeg", "tiff", "png", "ico" or -"bmp". See gdk_pixbuf_save_to_buffer() for more details. +"bmp". See `gdk_pixbuf_save_to_buffer()` for more details. -The @cancellable can be used to abort the operation from another -thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED -will be returned. Other possible errors are in the #GDK_PIXBUF_ERROR -and %G_IO_ERROR domains. +The `cancellable` can be used to abort the operation from another +thread. If the operation was cancelled, the error `G_IO_ERROR_CANCELLED` +will be returned. Other possible errors are in the `GDK_PIXBUF_ERROR` +and `G_IO_ERROR` domains. -The stream is not closed. - +The stream is not closed at the end of this call. + - %TRUE if the pixbuf was saved successfully, %FALSE if an - error was set. + `TRUE` if the pixbuf was saved successfully, `FALSE` if an + error was set. - a #GdkPixbuf + a `GdkPixbuf` - a #GOutputStream to save the pixbuf to + a `GOutputStream` to save the pixbuf to - name of file format + name of file format - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - return location for error, or %NULL + + return location for error, or `NULL` - list of key-value save options + list of key-value save options - - Saves @pixbuf to an output stream asynchronously. + + Saves `pixbuf` to an output stream asynchronously. For more details see gdk_pixbuf_save_to_stream(), which is the synchronous version of this function. -When the operation is finished, @callback will be called in the main thread. -You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation. - +When the operation is finished, `callback` will be called in the main thread. + +You can then call gdk_pixbuf_save_to_stream_finish() to get the result of +the operation. + - a #GdkPixbuf + a `GdkPixbuf` - a #GOutputStream to which to save the pixbuf + a `GOutputStream` to which to save the pixbuf - name of file format + name of file format - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - a #GAsyncReadyCallback to call when the pixbuf is saved + + a `GAsyncReadyCallback` to call when the pixbuf is saved - - the data to pass to the callback function + + the data to pass to the callback function - list of key-value save options + list of key-value save options - - Saves @pixbuf to an output stream. + + Saves `pixbuf` to an output stream. Supported file formats are currently "jpeg", "tiff", "png", "ico" or -"bmp". See gdk_pixbuf_save_to_stream() for more details. - +"bmp". + +See [method@GdkPixbuf.Pixbuf.save_to_stream] for more details. + - %TRUE if the pixbuf was saved successfully, %FALSE if an - error was set. + `TRUE` if the pixbuf was saved successfully, `FALSE` if an + error was set. - a #GdkPixbuf + a `GdkPixbuf` - a #GOutputStream to save the pixbuf to + a `GOutputStream` to save the pixbuf to - name of file format + name of file format - - name of options to set, %NULL-terminated + + name of options to set - + - - values for named options + + values for named options - + - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - Saves @pixbuf to an output stream asynchronously. + + Saves `pixbuf` to an output stream asynchronously. For more details see gdk_pixbuf_save_to_streamv(), which is the synchronous version of this function. -When the operation is finished, @callback will be called in the main thread. -You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation. - +When the operation is finished, `callback` will be called in the main thread. + +You can then call gdk_pixbuf_save_to_stream_finish() to get the result of +the operation. + - a #GdkPixbuf + a `GdkPixbuf` - a #GOutputStream to which to save the pixbuf + a `GOutputStream` to which to save the pixbuf - name of file format + name of file format - - name of options to set, %NULL-terminated + + name of options to set - + - - values for named options + + values for named options - + - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object, `NULL` to ignore - - a #GAsyncReadyCallback to call when the pixbuf is saved + + a `GAsyncReadyCallback` to call when the pixbuf is saved - - the data to pass to the callback function + + the data to pass to the callback function - Saves pixbuf to a file in @type, which is currently "jpeg", "png", "tiff", "ico" or "bmp". -If @error is set, %FALSE will be returned. -See gdk_pixbuf_save () for more details. - + Vector version of `gdk_pixbuf_save()`. + +Saves pixbuf to a file in `type`, which is currently "jpeg", "png", "tiff", "ico" or "bmp". + +If @error is set, `FALSE` will be returned. + +See [method@GdkPixbuf.Pixbuf.save] for more details. + - whether an error was set + whether an error was set - a #GdkPixbuf. + a `GdkPixbuf`. - name of file to save. + name of file to save. - name of file format. + name of file format. - - name of options to set, %NULL-terminated + + name of options to set - + - - values for named options + + values for named options - + - Creates a transformation of the source image @src by scaling by + Creates a transformation of the source image @src by scaling by @scale_x and @scale_y then translating by @offset_x and @offset_y, then renders the rectangle (@dest_x, @dest_y, @dest_width, @dest_height) of the resulting image onto the destination image replacing the previous contents. -Try to use gdk_pixbuf_scale_simple() first, this function is -the industrial-strength power tool you can fall back to if +Try to use gdk_pixbuf_scale_simple() first; this function is +the industrial-strength power tool you can fall back to, if gdk_pixbuf_scale_simple() isn't powerful enough. If the source rectangle overlaps the destination rectangle on the same pixbuf, it will be overwritten during the scaling which results in rendering artifacts. - + - a #GdkPixbuf + a #GdkPixbuf - the #GdkPixbuf into which to render the results + the #GdkPixbuf into which to render the results - the left coordinate for region to render + the left coordinate for region to render - the top coordinate for region to render + the top coordinate for region to render - the width of the region to render + the width of the region to render - the height of the region to render + the height of the region to render - the offset in the X direction (currently rounded to an integer) + the offset in the X direction (currently rounded to an integer) - the offset in the Y direction (currently rounded to an integer) + the offset in the Y direction (currently rounded to an integer) - the scale factor in the X direction + the scale factor in the X direction - the scale factor in the Y direction + the scale factor in the Y direction - the interpolation type for the transformation. + the interpolation type for the transformation. - Create a new #GdkPixbuf containing a copy of @src scaled to -@dest_width x @dest_height. Leaves @src unaffected. @interp_type -should be #GDK_INTERP_NEAREST if you want maximum speed (but when -scaling down #GDK_INTERP_NEAREST is usually unusably ugly). The -default @interp_type should be #GDK_INTERP_BILINEAR which offers -reasonable quality and speed. + Create a new pixbuf containing a copy of `src` scaled to +`dest_width` x `dest_height`. -You can scale a sub-portion of @src by creating a sub-pixbuf -pointing into @src; see gdk_pixbuf_new_subpixbuf(). +This function leaves `src` unaffected. -If @dest_width and @dest_height are equal to the @src width and height, a -copy of @src is returned, avoiding any scaling. +The `interp_type` should be `GDK_INTERP_NEAREST` if you want maximum +speed (but when scaling down `GDK_INTERP_NEAREST` is usually unusably +ugly). The default `interp_type` should be `GDK_INTERP_BILINEAR` which +offers reasonable quality and speed. -For more complicated scaling/alpha blending see gdk_pixbuf_scale() -and gdk_pixbuf_composite(). - +You can scale a sub-portion of `src` by creating a sub-pixbuf +pointing into `src`; see [method@GdkPixbuf.Pixbuf.new_subpixbuf]. + +If `dest_width` and `dest_height` are equal to the width and height of +`src`, this function will return an unscaled copy of `src`. + +For more complicated scaling/alpha blending see [method@GdkPixbuf.Pixbuf.scale] +and [method@GdkPixbuf.Pixbuf.composite]. + - the new #GdkPixbuf, or %NULL if not enough memory could be -allocated for it. + the new pixbuf - a #GdkPixbuf + a #GdkPixbuf - the width of destination image + the width of destination image - the height of destination image + the height of destination image - the interpolation type for the transformation. + the interpolation type for the transformation. - - Attaches a key/value pair as an option to a #GdkPixbuf. If @key already -exists in the list of options attached to @pixbuf, the new value is -ignored and %FALSE is returned. - + + Attaches a key/value pair as an option to a `GdkPixbuf`. + +If `key` already exists in the list of options attached to the `pixbuf`, +the new value is ignored and `FALSE` is returned. + - %TRUE on success. + `TRUE` on success - a #GdkPixbuf + a `GdkPixbuf` - a nul-terminated string. + a nul-terminated string. - a nul-terminated string. + a nul-terminated string. - - Removes a reference from a pixbuf. + + Removes a reference from a pixbuf. Use g_object_unref(). - + - A pixbuf. + A pixbuf. - - The number of bits per sample. + + The number of bits per sample. + Currently only 8 bit per sample are supported. - + + The color space of the pixbuf. + +Currently, only `GDK_COLORSPACE_RGB` is supported. - + + Whether the pixbuf has an alpha channel. - + + The number of rows of the pixbuf. - - The number of samples per pixel. + + The number of samples per pixel. + Currently, only 3 or 4 samples per pixel are supported. - + - + + A pointer to the pixel data of the pixbuf. - - The number of bytes between the start of a row and -the start of the next row. This number must (obviously) -be at least as large as the width of the pixbuf. + + The number of bytes between the start of a row and +the start of the next row. + +This number must (obviously) be at least as large as the +width of the pixbuf. - + + The number of columns of the pixbuf. - - These values can be passed to -gdk_pixbuf_xlib_render_to_drawable_alpha() to control how the alpha -channel of an image should be handled. This function can create a -bilevel clipping mask (black and white) and use it while painting -the image. In the future, when the X Window System gets an alpha -channel extension, it will be possible to do full alpha -compositing onto arbitrary drawables. For now both cases fall -back to a bilevel clipping mask. - it is unused since 2.42. - - A bilevel clipping mask (black and white) + + Control the alpha channel for drawables. + +These values can be passed to gdk_pixbuf_xlib_render_to_drawable_alpha() +in gdk-pixbuf-xlib to control how the alpha channel of an image should +be handled. + +This function can create a bilevel clipping mask (black and white) and use +it while painting the image. + +In the future, when the X Window System gets an alpha channel extension, +it will be possible to do full alpha compositing onto arbitrary drawables. +For now both cases fall back to a bilevel clipping mask. + There is no user of GdkPixbufAlphaMode in GdkPixbuf, + and the Xlib utility functions have been split out to their own + library, gdk-pixbuf-xlib + + A bilevel clipping mask (black and white) will be created and used to draw the image. Pixels below 0.5 opacity will be considered fully transparent, and all others will be considered fully opaque. - - For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL. + + For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL. In the future it will do full alpha compositing. - - An opaque struct representing an animation. - - Creates a new animation by loading it from a file. The file format is -detected automatically. If the file's format does not support multi-frame -images, then an animation with a single frame will be created. Possible errors -are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains. - - - A newly-created animation with a reference count of 1, or %NULL -if any of several error conditions ocurred: the file could not be opened, -there was no loader for the file's format, there was not enough memory to -allocate the image buffer, or the image file contained invalid data. + + An opaque object representing an animation. + +The GdkPixBuf library provides a simple mechanism to load and +represent animations. An animation is conceptually a series of +frames to be displayed over time. + +The animation may not be represented as a series of frames +internally; for example, it may be stored as a sprite and +instructions for moving the sprite around a background. + +To display an animation you don't need to understand its +representation, however; you just ask `GdkPixbuf` what should +be displayed at a given point in time. + + + Creates a new animation by loading it from a file. + +The file format is detected automatically. + +If the file's format does not support multi-frame images, then an animation +with a single frame will be created. + +Possible errors are in the `GDK_PIXBUF_ERROR` and `G_FILE_ERROR` domains. + + + A newly-created animation - Name of file to load, in the GLib file - name encoding + Name of file to load, in the GLib file + name encoding - - Creates a new pixbuf animation by loading an image from an resource. + + Creates a new pixbuf animation by loading an image from an resource. -The file format is detected automatically. If %NULL is returned, then +The file format is detected automatically. If `NULL` is returned, then @error will be set. - - - A newly-created animation, or %NULL if any of several error -conditions occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled. + + + A newly-created animation - the path of the resource file + the path of the resource file - - Creates a new animation by loading it from an input stream. + + Creates a new animation by loading it from an input stream. -The file format is detected automatically. If %NULL is returned, then -@error will be set. The @cancellable can be used to abort the operation -from another thread. If the operation was cancelled, the error -%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in -the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. +The file format is detected automatically. + +If `NULL` is returned, then @error will be set. + +The @cancellable can be used to abort the operation from another thread. +If the operation was cancelled, the error `G_IO_ERROR_CANCELLED` will be +returned. Other possible errors are in the `GDK_PIXBUF_ERROR` and +`G_IO_ERROR` domains. The stream is not closed. - - - A newly-created pixbuf, or %NULL if any of several error -conditions occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled. + + + A newly-created animation - a #GInputStream to load the pixbuf from + a `GInputStream` to load the pixbuf from - - optional #GCancellable object, %NULL to ignore + + optional `GCancellable` object - - Finishes an asynchronous pixbuf animation creation operation started with -gdk_pixbuf_animation_new_from_stream_async(). - - - a #GdkPixbufAnimation or %NULL on error. Free the returned -object with g_object_unref(). + + Finishes an asynchronous pixbuf animation creation operation started with +[func@GdkPixbuf.PixbufAnimation.new_from_stream_async]. + + + the newly created animation - a #GAsyncResult + a #GAsyncResult - - Creates a new animation by asynchronously loading an image from an input stream. + + Creates a new animation by asynchronously loading an image from an input stream. For more details see gdk_pixbuf_new_from_stream(), which is the synchronous version of this function. -When the operation is finished, @callback will be called in the main thread. +When the operation is finished, `callback` will be called in the main thread. You can then call gdk_pixbuf_animation_new_from_stream_finish() to get the result of the operation. - + - a #GInputStream from which to load the animation + a #GInputStream from which to load the animation - - optional #GCancellable object, %NULL to ignore + + optional #GCancellable object - - a #GAsyncReadyCallback to call when the pixbuf is loaded + + a `GAsyncReadyCallback` to call when the pixbuf is loaded - - the data to pass to the callback function + + the data to pass to the callback function - - Queries the height of the bounding box of a pixbuf animation. - - - Height of the bounding box of the animation. - - - - - An animation. - - - - - - Get an iterator for displaying an animation. The iterator provides -the frames that should be displayed at a given time. It should be -freed after use with g_object_unref(). + + Get an iterator for displaying an animation. + +The iterator provides the frames that should be displayed at a +given time. @start_time would normally come from g_get_current_time(), and marks the beginning of animation playback. After creating an iterator, you @@ -4049,7 +2914,7 @@ gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time the image is updated, you should reinstall the timeout with the new, possibly-changed delay time. -As a shortcut, if @start_time is %NULL, the result of +As a shortcut, if @start_time is `NULL`, the result of g_get_current_time() will be used automatically. To update the image (i.e. possibly change the result of @@ -4060,178 +2925,332 @@ If you're using #GdkPixbufLoader, in addition to updating the image after the delay time, you should also update it whenever you receive the area_updated signal and gdk_pixbuf_animation_iter_on_currently_loading_frame() returns -%TRUE. In this case, the frame currently being fed into the loader +`TRUE`. In this case, the frame currently being fed into the loader has received new data, so needs to be refreshed. The delay time for a frame may also be modified after an area_updated signal, for example if the delay time for a frame is encoded in the data after the frame itself. So your timeout should be reinstalled after any area_updated signal. -A delay time of -1 is possible, indicating "infinite." - +A delay time of -1 is possible, indicating "infinite". + - an iterator to move over the animation + an iterator to move over the animation - a #GdkPixbufAnimation + a #GdkPixbufAnimation - - time when the animation starts playing + + time when the animation starts playing - - - If an animation is really just a plain image (has only one frame), -this function returns that image. If the animation is an animation, -this function returns a reasonable thing to display as a static -unanimated image, which might be the first frame, or something more -sophisticated. If an animation hasn't loaded any frames yet, this -function will return %NULL. - - - unanimated image representing the animation - - - - - a #GdkPixbufAnimation - - - - - - Queries the width of the bounding box of a pixbuf animation. - - - Width of the bounding box of the animation. - - - - - An animation. - - - - - - If you load a file with gdk_pixbuf_animation_new_from_file() and it -turns out to be a plain, unanimated image, then this function will -return %TRUE. Use gdk_pixbuf_animation_get_static_image() to retrieve -the image. - - - %TRUE if the "animation" was really just an image - - - - - a #GdkPixbufAnimation - - - - - - Adds a reference to an animation. - Use g_object_ref(). - - - The same as the @animation argument. - - - - - An animation. - - - - - - Removes a reference from an animation. - Use g_object_unref(). - + + + - An animation. + + + + + + + + + + + + Retrieves a static image for the animation. + +If an animation is really just a plain image (has only one frame), +this function returns that image. + +If the animation is an animation, this function returns a reasonable +image to use as a static unanimated image, which might be the first +frame, or something more sophisticated depending on the file format. + +If an animation hasn't loaded any frames yet, this function will +return `NULL`. + + + unanimated image representing the animation + + + + + a #GdkPixbufAnimation + + + + + + Checks whether the animation is a static image. + +If you load a file with gdk_pixbuf_animation_new_from_file() and it +turns out to be a plain, unanimated image, then this function will +return `TRUE`. Use gdk_pixbuf_animation_get_static_image() to retrieve +the image. + + + `TRUE` if the "animation" was really just an image + + + + + a #GdkPixbufAnimation + + + + + + Queries the height of the bounding box of a pixbuf animation. + + + Height of the bounding box of the animation. + + + + + An animation. + + Get an iterator for displaying an animation. + +The iterator provides the frames that should be displayed at a +given time. + +@start_time would normally come from g_get_current_time(), and marks +the beginning of animation playback. After creating an iterator, you +should immediately display the pixbuf returned by +gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install +a timeout (with g_timeout_add()) or by some other mechanism ensure +that you'll update the image after +gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time +the image is updated, you should reinstall the timeout with the new, +possibly-changed delay time. + +As a shortcut, if @start_time is `NULL`, the result of +g_get_current_time() will be used automatically. + +To update the image (i.e. possibly change the result of +gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation), +call gdk_pixbuf_animation_iter_advance(). + +If you're using #GdkPixbufLoader, in addition to updating the image +after the delay time, you should also update it whenever you +receive the area_updated signal and +gdk_pixbuf_animation_iter_on_currently_loading_frame() returns +`TRUE`. In this case, the frame currently being fed into the loader +has received new data, so needs to be refreshed. The delay time for +a frame may also be modified after an area_updated signal, for +example if the delay time for a frame is encoded in the data after +the frame itself. So your timeout should be reinstalled after any +area_updated signal. + +A delay time of -1 is possible, indicating "infinite". + + + an iterator to move over the animation + + + + + a #GdkPixbufAnimation + + + + time when the animation starts playing + + + + + + Retrieves a static image for the animation. + +If an animation is really just a plain image (has only one frame), +this function returns that image. + +If the animation is an animation, this function returns a reasonable +image to use as a static unanimated image, which might be the first +frame, or something more sophisticated depending on the file format. + +If an animation hasn't loaded any frames yet, this function will +return `NULL`. + + + unanimated image representing the animation + + + + + a #GdkPixbufAnimation + + + + + + Queries the width of the bounding box of a pixbuf animation. + + + Width of the bounding box of the animation. + + + + + An animation. + + + + + + Checks whether the animation is a static image. + +If you load a file with gdk_pixbuf_animation_new_from_file() and it +turns out to be a plain, unanimated image, then this function will +return `TRUE`. Use gdk_pixbuf_animation_get_static_image() to retrieve +the image. + + + `TRUE` if the "animation" was really just an image + + + + + a #GdkPixbufAnimation + + + + + + Adds a reference to an animation. + Use g_object_ref(). + + + The same as the @animation argument. + + + + + An animation. + + + + + + Removes a reference from an animation. + Use g_object_unref(). + + + + + + + An animation. + + + + + + + - - An opaque struct representing an iterator which points to a + + Modules supporting animations must derive a type from +#GdkPixbufAnimation, providing suitable implementations of the +virtual functions. + + + the parent class + + + + + + + `TRUE` if the "animation" was really just an image + + + + + a #GdkPixbufAnimation + + + + + + + + + + unanimated image representing the animation + + + + + a #GdkPixbufAnimation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + an iterator to move over the animation + + + + + a #GdkPixbufAnimation + + + + time when the animation starts playing + + + + + + + + An opaque object representing an iterator which points to a certain position in an animation. - - Possibly advances an animation to a new frame. Chooses the frame based -on the start time passed to gdk_pixbuf_animation_get_iter(). + + + Possibly advances an animation to a new frame. + +Chooses the frame based on the start time passed to +gdk_pixbuf_animation_get_iter(). @current_time would normally come from g_get_current_time(), and must be greater than or equal to the time passed to @@ -4240,230 +3259,337 @@ unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is called. That is, you can't go backward in time; animations only play forward. -As a shortcut, pass %NULL for the current time and g_get_current_time() +As a shortcut, pass `NULL` for the current time and g_get_current_time() will be invoked on your behalf. So you only need to explicitly pass @current_time if you're doing something odd like playing the animation at double speed. -If this function returns %FALSE, there's no need to update the animation +If this function returns `FALSE`, there's no need to update the animation display, assuming the display had been rendered prior to advancing; -if %TRUE, you need to call gdk_pixbuf_animation_iter_get_pixbuf() +if `TRUE`, you need to call gdk_pixbuf_animation_iter_get_pixbuf() and update the display with the new pixbuf. - + - %TRUE if the image may need updating + `TRUE` if the image may need updating - a #GdkPixbufAnimationIter + a #GdkPixbufAnimationIter - - current time + + current time - - - Gets the number of milliseconds the current pixbuf should be displayed, -or -1 if the current pixbuf should be displayed forever. g_timeout_add() -conveniently takes a timeout in milliseconds, so you can use a timeout -to schedule the next update. + + + Gets the number of milliseconds the current pixbuf should be displayed, +or -1 if the current pixbuf should be displayed forever. + +The `g_timeout_add()` function conveniently takes a timeout in milliseconds, +so you can use a timeout to schedule the next update. Note that some formats, like GIF, might clamp the timeout values in the image file to avoid updates that are just too quick. The minimum timeout for GIF images is currently 20 milliseconds. - + - delay time in milliseconds (thousandths of a second) + delay time in milliseconds (thousandths of a second) - an animation iterator + an animation iterator - - - Gets the current pixbuf which should be displayed; the pixbuf might not -be the same size as the animation itself + + + Gets the current pixbuf which should be displayed. + +The pixbuf might not be the same size as the animation itself (gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()). -This pixbuf should be displayed for -gdk_pixbuf_animation_iter_get_delay_time() milliseconds. The caller -of this function does not own a reference to the returned pixbuf; -the returned pixbuf will become invalid when the iterator advances -to the next frame, which may happen anytime you call -gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it -(don't just add a reference), as it may get recycled as you advance -the iterator. - + +This pixbuf should be displayed for gdk_pixbuf_animation_iter_get_delay_time() +milliseconds. + +The caller of this function does not own a reference to the returned +pixbuf; the returned pixbuf will become invalid when the iterator +advances to the next frame, which may happen anytime you call +gdk_pixbuf_animation_iter_advance(). + +Copy the pixbuf to keep it (don't just add a reference), as it may get +recycled as you advance the iterator. + - the pixbuf to be displayed + the pixbuf to be displayed - an animation iterator + an animation iterator - - - Used to determine how to respond to the area_updated signal on -#GdkPixbufLoader when loading an animation. area_updated is emitted -for an area of the frame currently streaming in to the loader. So if -you're on the currently loading frame, you need to redraw the screen for -the updated area. - + + + Used to determine how to respond to the area_updated signal on +#GdkPixbufLoader when loading an animation. + +The `::area_updated` signal is emitted for an area of the frame currently +streaming in to the loader. So if you're on the currently loading frame, +you will need to redraw the screen for the updated area. + - %TRUE if the frame we're on is partially loaded, or the last frame + `TRUE` if the frame we're on is partially loaded, or the last frame - a #GdkPixbufAnimationIter + a #GdkPixbufAnimationIter + + + + + + Possibly advances an animation to a new frame. + +Chooses the frame based on the start time passed to +gdk_pixbuf_animation_get_iter(). + +@current_time would normally come from g_get_current_time(), and +must be greater than or equal to the time passed to +gdk_pixbuf_animation_get_iter(), and must increase or remain +unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is +called. That is, you can't go backward in time; animations only +play forward. + +As a shortcut, pass `NULL` for the current time and g_get_current_time() +will be invoked on your behalf. So you only need to explicitly pass +@current_time if you're doing something odd like playing the animation +at double speed. + +If this function returns `FALSE`, there's no need to update the animation +display, assuming the display had been rendered prior to advancing; +if `TRUE`, you need to call gdk_pixbuf_animation_iter_get_pixbuf() +and update the display with the new pixbuf. + + + `TRUE` if the image may need updating + + + + + a #GdkPixbufAnimationIter + + + + current time + + + + + + Gets the number of milliseconds the current pixbuf should be displayed, +or -1 if the current pixbuf should be displayed forever. + +The `g_timeout_add()` function conveniently takes a timeout in milliseconds, +so you can use a timeout to schedule the next update. + +Note that some formats, like GIF, might clamp the timeout values in the +image file to avoid updates that are just too quick. The minimum timeout +for GIF images is currently 20 milliseconds. + + + delay time in milliseconds (thousandths of a second) + + + + + an animation iterator + + Gets the current pixbuf which should be displayed. + +The pixbuf might not be the same size as the animation itself +(gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()). + +This pixbuf should be displayed for gdk_pixbuf_animation_iter_get_delay_time() +milliseconds. + +The caller of this function does not own a reference to the returned +pixbuf; the returned pixbuf will become invalid when the iterator +advances to the next frame, which may happen anytime you call +gdk_pixbuf_animation_iter_advance(). + +Copy the pixbuf to keep it (don't just add a reference), as it may get +recycled as you advance the iterator. + + + the pixbuf to be displayed + + + + + an animation iterator + + + + + + Used to determine how to respond to the area_updated signal on +#GdkPixbufLoader when loading an animation. + +The `::area_updated` signal is emitted for an area of the frame currently +streaming in to the loader. So if you're on the currently loading frame, +you will need to redraw the screen for the updated area. + + + `TRUE` if the frame we're on is partially loaded, or the last frame + + + + + a #GdkPixbufAnimationIter + + + + + + + + + Modules supporting animations must derive a type from +#GdkPixbufAnimationIter, providing suitable implementations of the +virtual functions. + + + the parent class + + + + + + + delay time in milliseconds (thousandths of a second) + + + + + an animation iterator + + + + + + + + + + the pixbuf to be displayed + + + + + an animation iterator + + + + + + + + + + `TRUE` if the frame we're on is partially loaded, or the last frame + + + + + a #GdkPixbufAnimationIter + + + + + + + + + + `TRUE` if the image may need updating + + + + + a #GdkPixbufAnimationIter + + + + current time + + + + + + - A function of this type is responsible for freeing the pixel array -of a pixbuf. The gdk_pixbuf_new_from_data() function lets you -pass in a pre-allocated pixel array so that a pixbuf can be -created from it; in this case you will need to pass in a function -of #GdkPixbufDestroyNotify so that the pixel data can be freed -when the pixbuf is finalized. + A function of this type is responsible for freeing the pixel array +of a pixbuf. + +The gdk_pixbuf_new_from_data() function lets you pass in a pre-allocated +pixel array so that a pixbuf can be created from it; in this case you +will need to pass in a function of type `GdkPixbufDestroyNotify` so that +the pixel data can be freed when the pixbuf is finalized. - The pixel array of the pixbuf + The pixel array of the pixbuf that is being finalized. - - User closure data. + + User closure data. - - An error code in the #GDK_PIXBUF_ERROR domain. Many gdk-pixbuf -operations can cause errors in this domain, or in the #G_FILE_ERROR -domain. - - An image file was broken somehow. + + An error code in the `GDK_PIXBUF_ERROR` domain. + +Many gdk-pixbuf operations can cause errors in this domain, or in +the `G_FILE_ERROR` domain. + + An image file was broken somehow. - - Not enough memory. + + Not enough memory. - - A bad option was passed to a pixbuf save module. + + A bad option was passed to a pixbuf save module. - - Unknown image type. + + Unknown image type. - - Don't know how to perform the + + Don't know how to perform the given operation on the type of image at hand. - - Generic failure code, something went wrong. + + Generic failure code, something went wrong. - - Only part of the animation was loaded. + + Only part of the animation was loaded. @@ -4471,37 +3597,72 @@ domain. - - + + A `GdkPixbufFormat` contains information about the image format accepted +by a module. + +Only modules should access the fields directly, applications should +use the `gdk_pixbuf_format_*` family of functions. + + + the name of the image format + + + + the signature of the module + + + + the message domain for the `description` + + + + a description of the image format + + + + the MIME types for the image format + + + + + + typical filename extensions for the + image format + + + + + + a combination of `GdkPixbufFormatFlags` + + + + a boolean determining whether the loader is disabled` + + + + a string containing license information, typically set to + shorthands like "GPL", "LGPL", etc. + + - Creates a copy of @format + Creates a copy of `format`. - the newly allocated copy of a #GdkPixbufFormat. Use + the newly allocated copy of a `GdkPixbufFormat`. Use gdk_pixbuf_format_free() to free the resources when done - a #GdkPixbufFormat + a pixbuf format - Frees the resources allocated when copying a #GdkPixbufFormat + Frees the resources allocated when copying a `GdkPixbufFormat` using gdk_pixbuf_format_copy() @@ -4509,299 +3670,262 @@ using gdk_pixbuf_format_copy() - a #GdkPixbufFormat + a pixbuf format - - Returns a description of the format. + + Returns a description of the format. - a description of the format. + a description of the format. - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Returns the filename extensions typically used for files in the + + Returns the filename extensions typically used for files in the given format. - a %NULL-terminated array of filename extensions which must be -freed with g_strfreev() when it is no longer needed. + an array of + filename extensions - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Returns information about the license of the image loader for the format. The -returned string should be a shorthand for a wellknown license, e.g. "LGPL", -"GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. This -string should be freed with g_free() when it's no longer needed. + + Returns information about the license of the image loader for the format. + +The returned string should be a shorthand for a well known license, e.g. +"LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. - a string describing the license of @format. + a string describing the license of the pixbuf format - a #GdkPixbufFormat + a pixbuf format - - Returns the mime types supported by the format. + + Returns the mime types supported by the format. - a %NULL-terminated array of mime types which must be freed with -g_strfreev() when it is no longer needed. + an array of mime types - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Returns the name of the format. + + Returns the name of the format. - the name of the format. + the name of the format. - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Returns whether this image format is disabled. See -gdk_pixbuf_format_set_disabled(). + + Returns whether this image format is disabled. + +See gdk_pixbuf_format_set_disabled(). - whether this image format is disabled. + whether this image format is disabled. - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Returns %TRUE if the save option specified by @option_key is supported when + + Returns `TRUE` if the save option specified by @option_key is supported when saving a pixbuf using the module implementing @format. + See gdk_pixbuf_save() for more information about option keys. - %TRUE if the specified option is supported + `TRUE` if the specified option is supported - a #GdkPixbufFormat + a pixbuf format - the name of an option + the name of an option - - Returns whether this image format is scalable. If a file is in a -scalable format, it is preferable to load it at the desired size, -rather than loading it at the default size and scaling the -resulting pixbuf to the desired size. + + Returns whether this image format is scalable. + +If a file is in a scalable format, it is preferable to load it at +the desired size, rather than loading it at the default size and +scaling the resulting pixbuf to the desired size. - whether this image format is scalable. + whether this image format is scalable. - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Returns whether pixbufs can be saved in the given format. + + Returns whether pixbufs can be saved in the given format. - whether pixbufs can be saved in the given format. + whether pixbufs can be saved in the given format. - a #GdkPixbufFormat + a `GdkPixbufFormat` - - Disables or enables an image format. If a format is disabled, -gdk-pixbuf won't use the image loader for this format to load -images. Applications can use this to avoid using image loaders -with an inappropriate license, see gdk_pixbuf_format_get_license(). + + Disables or enables an image format. + +If a format is disabled, GdkPixbuf won't use the image loader for +this format to load images. + +Applications can use this to avoid using image loaders with an +inappropriate license, see gdk_pixbuf_format_get_license(). - a #GdkPixbufFormat + a `GdkPixbufFormat` - %TRUE to disable the format @format + `TRUE` to disable the format @format - - The GdkPixbufLoader struct contains only private -fields. - + + Flags which allow a module to specify further details about the supported +operations. + + + the module can write out images in the format. + + + the image format is scalable + + + the module is threadsafe. gdk-pixbuf + ignores modules that are not marked as threadsafe. (Since 2.28). + + + + Incremental image loader. + +`GdkPixbufLoader` provides a way for applications to drive the +process of loading an image, by letting them send the image data +directly to the loader instead of having the loader read the data +from a file. Applications can use this functionality instead of +`gdk_pixbuf_new_from_file()` or `gdk_pixbuf_animation_new_from_file()` +when they need to parse image data in small chunks. For example, +it should be used when reading an image from a (potentially) slow +network connection, or when loading an extremely large file. + +To use `GdkPixbufLoader` to load an image, create a new instance, +and call [method@GdkPixbuf.PixbufLoader.write] to send the data +to it. When done, [method@GdkPixbuf.PixbufLoader.close] should be +called to end the stream and finalize everything. + +The loader will emit three important signals throughout the process: + + - [signal@GdkPixbuf.PixbufLoader::size-prepared] will be emitted as + soon as the image has enough information to determine the size of + the image to be used. If you want to scale the image while loading + it, you can call [method@GdkPixbuf.PixbufLoader.set_size] in + response to this signal. + - [signal@GdkPixbuf.PixbufLoader::area-prepared] will be emitted as + soon as the pixbuf of the desired has been allocated. You can obtain + the `GdkPixbuf` instance by calling [method@GdkPixbuf.PixbufLoader.get_pixbuf]. + If you want to use it, simply acquire a reference to it. You can + also call `gdk_pixbuf_loader_get_pixbuf()` later to get the same + pixbuf. + - [signal@GdkPixbuf.PixbufLoader::area-updated] will be emitted every + time a region is updated. This way you can update a partially + completed image. Note that you do not know anything about the + completeness of an image from the updated area. For example, in an + interlaced image you will need to make several passes before the + image is done loading. + +## Loading an animation + +Loading an animation is almost as easy as loading an image. Once the +first [signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been +emitted, you can call [method@GdkPixbuf.PixbufLoader.get_animation] to +get the [class@GdkPixbuf.PixbufAnimation] instance, and then call +and [method@GdkPixbuf.PixbufAnimation.get_iter] to get a +[class@GdkPixbuf.PixbufAnimationIter] to retrieve the pixbuf for the +desired time stamp. + - Creates a new pixbuf loader object. - + Creates a new pixbuf loader object. + - A newly-created pixbuf loader. + A newly-created pixbuf loader. - - Creates a new pixbuf loader object that always attempts to parse -image data as if it were an image of mime type @mime_type, instead of -identifying the type automatically. Useful if you want an error if -the image isn't the expected mime type, for loading image formats -that can't be reliably identified by looking at the data, or if -the user manually forces a specific mime type. + + Creates a new pixbuf loader object that always attempts to parse +image data as if it were an image of MIME type @mime_type, instead of +identifying the type automatically. + +This function is useful if you want an error if the image isn't the +expected MIME type; for loading image formats that can't be reliably +identified by looking at the data; or if the user manually forces a +specific MIME type. The list of supported mime types depends on what image loaders are installed, but typically "image/png", "image/jpeg", "image/gif", @@ -4809,60 +3933,47 @@ are installed, but typically "image/png", "image/jpeg", "image/gif", To obtain the full list of supported mime types, call gdk_pixbuf_format_get_mime_types() on each of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). - + - A newly-created pixbuf loader. + A newly-created pixbuf loader. - the mime type to be loaded + the mime type to be loaded - - Creates a new pixbuf loader object that always attempts to parse + + Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type @image_type, instead of -identifying the type automatically. Useful if you want an error if -the image isn't the expected type, for loading image formats -that can't be reliably identified by looking at the data, or if -the user manually forces a specific type. +identifying the type automatically. + +This function is useful if you want an error if the image isn't the +expected type; for loading image formats that can't be reliably +identified by looking at the data; or if the user manually forces +a specific type. The list of supported image formats depends on what image loaders are installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are among the supported formats. To obtain the full list of supported image formats, call gdk_pixbuf_format_get_name() on each of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). - + - A newly-created pixbuf loader. + A newly-created pixbuf loader. - name of the image format to be loaded with the image + name of the image format to be loaded with the image - + @@ -4873,8 +3984,7 @@ of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). - + @@ -4897,8 +4007,7 @@ of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). - + @@ -4909,8 +4018,7 @@ of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). - + @@ -4927,299 +4035,223 @@ of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats(). - Informs a pixbuf loader that no further writes with + Informs a pixbuf loader that no further writes with gdk_pixbuf_loader_write() will occur, so that it can free its -internal loading structures. Also, tries to parse any data that -hasn't yet been parsed; if the remaining data is partial or -corrupt, an error will be returned. If %FALSE is returned, @error -will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR -domains. If you're just cancelling a load rather than expecting it -to be finished, passing %NULL for @error to ignore it is -reasonable. +internal loading structures. -Remember that this does not unref the loader, so if you plan not to -use it anymore, please g_object_unref() it. - +This function also tries to parse any data that hasn't yet been parsed; +if the remaining data is partial or corrupt, an error will be returned. + +If `FALSE` is returned, `error` will be set to an error from the +`GDK_PIXBUF_ERROR` or `G_FILE_ERROR` domains. + +If you're just cancelling a load rather than expecting it to be finished, +passing `NULL` for `error` to ignore it is reasonable. + +Remember that this function does not release a reference on the loader, so +you will need to explicitly release any reference you hold. + - %TRUE if all image data written so far was successfully - passed out via the update_area signal + `TRUE` if all image data written so far was successfully + passed out via the update_area signal - A pixbuf loader. + A pixbuf loader. - - Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating. -In general it only makes sense to call this function after the "area-prepared" -signal has been emitted by the loader. If the loader doesn't have enough -bytes yet (hasn't emitted the "area-prepared" signal) this function will -return %NULL. - - - The #GdkPixbufAnimation that the loader is loading, or %NULL if -not enough data has been read to determine the information. + + Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating. + +In general it only makes sense to call this function after the +[signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been emitted by +the loader. + +If the loader doesn't have enough bytes yet, and hasn't emitted the `area-prepared` +signal, this function will return `NULL`. + + + The animation that the loader is + currently loading - A pixbuf loader + A pixbuf loader - - Obtains the available information about the format of the + + Obtains the available information about the format of the currently loading image file. - + - A #GdkPixbufFormat or -%NULL. The return value is owned by GdkPixbuf and should not be -freed. + A #GdkPixbufFormat - A pixbuf loader. + A pixbuf loader. - Queries the #GdkPixbuf that a pixbuf loader is currently creating. + Queries the #GdkPixbuf that a pixbuf loader is currently creating. + In general it only makes sense to call this function after the -"area-prepared" signal has been emitted by the loader; this means -that enough data has been read to know the size of the image that -will be allocated. If the loader has not received enough data via -gdk_pixbuf_loader_write(), then this function returns %NULL. The -returned pixbuf will be the same in all future calls to the loader, -so simply calling g_object_ref() should be sufficient to continue -using it. Additionally, if the loader is an animation, it will -return the "static image" of the animation -(see gdk_pixbuf_animation_get_static_image()). - - - The #GdkPixbuf that the loader is creating, or %NULL if not -enough data has been read to determine how to create the image buffer. +[signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been +emitted by the loader; this means that enough data has been read +to know the size of the image that will be allocated. + +If the loader has not received enough data via gdk_pixbuf_loader_write(), +then this function returns `NULL`. + +The returned pixbuf will be the same in all future calls to the loader, +so if you want to keep using it, you should acquire a reference to it. + +Additionally, if the loader is an animation, it will return the "static +image" of the animation (see gdk_pixbuf_animation_get_static_image()). + + + The pixbuf that the loader is + creating - A pixbuf loader. + A pixbuf loader. - - Causes the image to be scaled while it is loaded. The desired -image size can be determined relative to the original size of -the image by calling gdk_pixbuf_loader_set_size() from a + + Causes the image to be scaled while it is loaded. + +The desired image size can be determined relative to the original +size of the image by calling gdk_pixbuf_loader_set_size() from a signal handler for the ::size-prepared signal. Attempts to set the desired image size are ignored after the emission of the ::size-prepared signal. - + - A pixbuf loader. + A pixbuf loader. - The desired width of the image being loaded. + The desired width of the image being loaded. - The desired height of the image being loaded. + The desired height of the image being loaded. - This will cause a pixbuf loader to parse the next @count bytes of -an image. It will return %TRUE if the data was loaded successfully, -and %FALSE if an error occurred. In the latter case, the loader -will be closed, and will not accept further writes. If %FALSE is -returned, @error will be set to an error from the #GDK_PIXBUF_ERROR -or #G_FILE_ERROR domains. - + Parses the next `count` bytes in the given image buffer. + - %TRUE if the write was successful, or %FALSE if the loader -cannot parse the buffer. + `TRUE` if the write was successful, or + `FALSE` if the loader cannot parse the buffer - A pixbuf loader. + A pixbuf loader. - Pointer to image data. + Pointer to image data. - Length of the @buf buffer in bytes. + Length of the @buf buffer in bytes. - - This will cause a pixbuf loader to parse a buffer inside a #GBytes -for an image. It will return %TRUE if the data was loaded successfully, -and %FALSE if an error occurred. In the latter case, the loader -will be closed, and will not accept further writes. If %FALSE is -returned, @error will be set to an error from the #GDK_PIXBUF_ERROR -or #G_FILE_ERROR domains. - -See also: gdk_pixbuf_loader_write() - + + Parses the next contents of the given image buffer. + - %TRUE if the write was successful, or %FALSE if the loader -cannot parse the buffer. + `TRUE` if the write was successful, or `FALSE` if + the loader cannot parse the buffer - A pixbuf loader. + A pixbuf loader. - The image data as a #GBytes + The image data as a `GBytes` buffer. - + - This signal is emitted when the pixbuf loader has allocated the -pixbuf in the desired size. After this signal is emitted, -applications can call gdk_pixbuf_loader_get_pixbuf() to fetch -the partially-loaded pixbuf. + This signal is emitted when the pixbuf loader has allocated the +pixbuf in the desired size. + +After this signal is emitted, applications can call +gdk_pixbuf_loader_get_pixbuf() to fetch the partially-loaded +pixbuf. - This signal is emitted when a significant area of the image being -loaded has been updated. Normally it means that a complete -scanline has been read in, but it could be a different area as -well. Applications can use this signal to know when to repaint + This signal is emitted when a significant area of the image being +loaded has been updated. + +Normally it means that a complete scanline has been read in, but +it could be a different area as well. + +Applications can use this signal to know when to repaint areas of an image that is being loaded. - X offset of upper-left corner of the updated area. + X offset of upper-left corner of the updated area. - Y offset of upper-left corner of the updated area. + Y offset of upper-left corner of the updated area. - Width of updated area. + Width of updated area. - Height of updated area. + Height of updated area. - This signal is emitted when gdk_pixbuf_loader_close() is called. + This signal is emitted when gdk_pixbuf_loader_close() is called. + It can be used by different parts of an application to receive notification when an image loader is closed by the code that drives it. @@ -5228,43 +4260,36 @@ drives it. - This signal is emitted when the pixbuf loader has been fed the + This signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size -of the image that it will create. Applications can call -gdk_pixbuf_loader_set_size() in response to this signal to set -the desired size to which the image should be scaled. +of the image that it will create. + +Applications can call gdk_pixbuf_loader_set_size() in response +to this signal to set the desired size to which the image +should be scaled. - the original width of the image + the original width of the image - the original height of the image + the original height of the image - - + + - + @@ -5283,8 +4308,7 @@ the desired size to which the image should be scaled. - + @@ -5297,8 +4321,7 @@ the desired size to which the image should be scaled. - + @@ -5323,8 +4346,7 @@ the desired size to which the image should be scaled. - + @@ -5336,558 +4358,581 @@ the desired size to which the image should be scaled. - - The possible rotations which can be passed to gdk_pixbuf_rotate_simple(). + + A `GdkPixbufModule` contains the necessary functions to load and save +images in a certain file format. + +If `GdkPixbuf` has been compiled with `GModule` support, it can be extended +by modules which can load (and perhaps also save) new image and animation +formats. + +## Implementing modules + +The `GdkPixbuf` interfaces needed for implementing modules are contained in +`gdk-pixbuf-io.h` (and `gdk-pixbuf-animation.h` if the module supports +animations). They are not covered by the same stability guarantees as the +regular GdkPixbuf API. To underline this fact, they are protected by the +`GDK_PIXBUF_ENABLE_BACKEND` pre-processor symbol. + +Each loadable module must contain a `GdkPixbufModuleFillVtableFunc` function +named `fill_vtable`, which will get called when the module +is loaded and must set the function pointers of the `GdkPixbufModule`. + +In order to make format-checking work before actually loading the modules +(which may require calling `dlopen` to load image libraries), modules export +their signatures (and other information) via the `fill_info` function. An +external utility, `gdk-pixbuf-query-loaders`, uses this to create a text +file containing a list of all available loaders and their signatures. +This file is then read at runtime by `GdkPixbuf` to obtain the list of +available loaders and their signatures. + +Modules may only implement a subset of the functionality available via +`GdkPixbufModule`. If a particular functionality is not implemented, the +`fill_vtable` function will simply not set the corresponding +function pointers of the `GdkPixbufModule` structure. If a module supports +incremental loading (i.e. provides `begin_load`, `stop_load` and +`load_increment`), it doesn't have to implement `load`, since `GdkPixbuf` +can supply a generic `load` implementation wrapping the incremental loading. + +## Installing modules + +Installing a module is a two-step process: + + - copy the module file(s) to the loader directory (normally + `$libdir/gdk-pixbuf-2.0/$version/loaders`, unless overridden by the + environment variable `GDK_PIXBUF_MODULEDIR`) + - call `gdk-pixbuf-query-loaders` to update the module file (normally + `$libdir/gdk-pixbuf-2.0/$version/loaders.cache`, unless overridden + by the environment variable `GDK_PIXBUF_MODULE_FILE`) + + + the name of the module, usually the same as the + usual file extension for images of this type, eg. "xpm", "jpeg" or "png". + + + + the path from which the module is loaded. + + + + the loaded `GModule`. + + + + a `GdkPixbufFormat` holding information about the module. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines the type of the function used to fill a +#GdkPixbufFormat structure with information about a module. + + + + + + + a #GdkPixbufFormat. + + + + + + Defines the type of the function used to set the vtable of a +#GdkPixbufModule when it is loaded. + + + + + + + a #GdkPixbufModule. + + + + + + The signature prefix for a module. + +The signature of a module is a set of prefixes. Prefixes are encoded as +pairs of ordinary strings, where the second string, called the mask, if +not `NULL`, must be of the same length as the first one and may contain +' ', '!', 'x', 'z', and 'n' to indicate bytes that must be matched, +not matched, "don't-care"-bytes, zeros and non-zeros, respectively. + +Each prefix has an associated integer that describes the relevance of +the prefix, with 0 meaning a mismatch and 100 a "perfect match". + +Starting with gdk-pixbuf 2.8, the first byte of the mask may be '*', +indicating an unanchored pattern that matches not only at the beginning, +but also in the middle. Versions prior to 2.8 will interpret the '*' +like an 'x'. + +The signature of a module is stored as an array of +`GdkPixbufModulePatterns`. The array is terminated by a pattern +where the `prefix` is `NULL`. + +```c +GdkPixbufModulePattern *signature[] = { + { "abcdx", " !x z", 100 }, + { "bla", NULL, 90 }, + { NULL, NULL, 0 } +}; +``` + +In the example above, the signature matches e.g. "auud\0" with +relevance 100, and "blau" with relevance 90. + + + the prefix for this pattern + + + + mask containing bytes which modify how the prefix is matched against + test data + + + + relevance of this pattern + + + + + Defines the type of the function that gets called once the initial +setup of @pixbuf is done. + +#GdkPixbufLoader uses a function of this type to emit the +"<link linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" +signal. + + + + + + + the #GdkPixbuf that is currently being loaded. + + + + if an animation is being loaded, the #GdkPixbufAnimation, else %NULL. + + + + the loader. + + + + + + Defines the type of the function that gets called once the size +of the loaded image is known. + +The function is expected to set @width and @height to the desired +size to which the image should be scaled. If a module has no efficient +way to achieve the desired scaling during the loading of the image, it may +either ignore the size request, or only approximate it - gdk-pixbuf will +then perform the required scaling on the completely loaded image. + +If the function sets @width or @height to zero, the module should interpret +this as a hint that it will be closed soon and shouldn't allocate further +resources. This convention is used to implement gdk_pixbuf_get_file_info() +efficiently. + + + + + + + pointer to a location containing the current image width + + + + pointer to a location containing the current image height + + + + the loader. + + + + + + Defines the type of the function that gets called every time a region +of @pixbuf is updated. + +#GdkPixbufLoader uses a function of this type to emit the +"<link linkend="GdkPixbufLoader-area-updated">area_updated</link>" +signal. + + + + + + + the #GdkPixbuf that is currently being loaded. + + + + the X origin of the updated area. + + + + the Y origin of the updated area. + + + + the width of the updated area. + + + + the height of the updated area. + + + + the loader. + + + + + + + + + + + + + + + + + + + The possible rotations which can be passed to gdk_pixbuf_rotate_simple(). + To make them easier to use, their numerical values are the actual degrees. - - No rotation. + + No rotation. - - Rotate by 90 degrees. + + Rotate by 90 degrees. - - Rotate by 180 degrees. + + Rotate by 180 degrees. - - Rotate by 270 degrees. + + Rotate by 270 degrees. - Specifies the type of the function passed to -gdk_pixbuf_save_to_callback(). It is called once for each block of -bytes that is "written" by gdk_pixbuf_save_to_callback(). If -successful it should return %TRUE. If an error occurs it should set -@error and return %FALSE, in which case gdk_pixbuf_save_to_callback() + Save functions used by [method@GdkPixbuf.Pixbuf.save_to_callback]. + +This function is called once for each block of bytes that is "written" +by `gdk_pixbuf_save_to_callback()`. + +If successful it should return `TRUE`; if an error occurs it should set +`error` and return `FALSE`, in which case `gdk_pixbuf_save_to_callback()` will fail with the same error. - + - %TRUE if successful, %FALSE (with @error set) if failed. + `TRUE` if successful, `FALSE` otherwise - bytes to be written. + bytes to be written. - number of bytes in @buf. + number of bytes in @buf. - - A location to return an error. + + A location to return an error. - - user data passed to gdk_pixbuf_save_to_callback(). + + user data passed to gdk_pixbuf_save_to_callback(). - - An opaque struct representing a simple animation. - - - Creates a new, empty animation. - + + An opaque struct representing a simple animation. + + + Creates a new, empty animation. + - a newly allocated #GdkPixbufSimpleAnim + a newly allocated #GdkPixbufSimpleAnim - the width of the animation + the width of the animation - the height of the animation + the height of the animation - the speed of the animation, in frames per second + the speed of the animation, in frames per second - - Adds a new frame to @animation. The @pixbuf must + + Adds a new frame to @animation. The @pixbuf must have the dimensions specified when the animation was constructed. - + - a #GdkPixbufSimpleAnim + a #GdkPixbufSimpleAnim - the pixbuf to add + the pixbuf to add - - Gets whether @animation should loop indefinitely when it reaches the end. - + + Gets whether @animation should loop indefinitely when it reaches the end. + - %TRUE if the animation loops forever, %FALSE otherwise + %TRUE if the animation loops forever, %FALSE otherwise - a #GdkPixbufSimpleAnim + a #GdkPixbufSimpleAnim - - Sets whether @animation should loop indefinitely when it reaches the end. - + + Sets whether @animation should loop indefinitely when it reaches the end. + - a #GdkPixbufSimpleAnim + a #GdkPixbufSimpleAnim - whether to loop the animation + whether to loop the animation - - Whether the animation should loop when it reaches the end. + + Whether the animation should loop when it reaches the end. - - + + - + - - The GdkPixBuf library provides a simple mechanism to load and -represent animations. An animation is conceptually a series of -frames to be displayed over time. The animation may not be -represented as a series of frames internally; for example, it may -be stored as a sprite and instructions for moving the sprite around -a background. To display an animation you don't need to understand -its representation, however; you just ask GdkPixBuf what should -be displayed at a given point in time. - - - The most basic way to create a pixbuf is to wrap an existing pixel -buffer with a #GdkPixbuf structure. You can use the -gdk_pixbuf_new_from_data() function to do this You need to specify -the destroy notification function that will be called when the -data buffer needs to be freed; this will happen when a #GdkPixbuf -is finalized by the reference counting functions If you have a -chunk of static data compiled into your application, you can pass -in %NULL as the destroy notification function so that the data -will not be freed. - -The gdk_pixbuf_new() function can be used as a convenience to -create a pixbuf with an empty buffer. This is equivalent to -allocating a data buffer using malloc() and then wrapping it with -gdk_pixbuf_new_from_data(). The gdk_pixbuf_new() function will -compute an optimal rowstride so that rendering can be performed -with an efficient algorithm. - -As a special case, you can use the gdk_pixbuf_new_from_xpm_data() -function to create a pixbuf from inline XPM image data. - -You can also copy an existing pixbuf with the gdk_pixbuf_copy() -function. This is not the same as just doing a g_object_ref() -on the old pixbuf; the copy function will actually duplicate the -pixel data in memory and create a new #GdkPixbuf structure for it. - - - The GdkPixBuf library provides a simple mechanism for loading -an image from a file in synchronous fashion. This means that the -library takes control of the application while the file is being -loaded; from the user's point of view, the application will block -until the image is done loading. - - -This interface can be used by applications in which blocking is -acceptable while an image is being loaded. It can also be used to -load small images in general. Applications that need progressive -loading can use the #GdkPixbufLoader functionality instead. - - - These functions allow to save a #GdkPixbuf in a number of -file formats. The formatted data can be written to a file -or to a memory buffer. GdkPixBuf can also call a user-defined -callback on the data, which allows to e.g. write the image -to a socket or store it in a database. - - - The #GdkPixbuf structure contains -information that describes an image in memory. - -## Image Data ## {#image-data} - -Image data in a pixbuf is stored in memory in uncompressed, -packed format. Rows in the image are stored top to bottom, and -in each row pixels are stored from left to right. There may be -padding at the end of a row. The "rowstride" value of a pixbuf, -as returned by gdk_pixbuf_get_rowstride(), indicates the number -of bytes between rows. - -## put_pixel() Example ## {#put-pixel} - -The following code illustrates a simple put_pixel() -function for RGB pixbufs with 8 bits per channel with an alpha -channel. It is not included in the gdk-pixbuf library for -performance reasons; rather than making several function calls -for each pixel, your own code can take shortcuts. - -|[<!-- language="C" --> -static void -put_pixel (GdkPixbuf *pixbuf, int x, int y, guchar red, guchar green, guchar blue, guchar alpha) -{ - int width, height, rowstride, n_channels; - guchar *pixels, *p; - - n_channels = gdk_pixbuf_get_n_channels (pixbuf); - - g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB); - g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8); - g_assert (gdk_pixbuf_get_has_alpha (pixbuf)); - g_assert (n_channels == 4); - - width = gdk_pixbuf_get_width (pixbuf); - height = gdk_pixbuf_get_height (pixbuf); - - g_assert (x >= 0 && x < width); - g_assert (y >= 0 && y < height); - - rowstride = gdk_pixbuf_get_rowstride (pixbuf); - pixels = gdk_pixbuf_get_pixels (pixbuf); - - p = pixels + y * rowstride + x * n_channels; - p[0] = red; - p[1] = green; - p[2] = blue; - p[3] = alpha; -} -]| - -This function will not work for pixbufs with images that are -other than 8 bits per sample or channel, but it will work for -most of the pixbufs that GTK+ uses. - -If you are doing memcpy() of raw pixbuf data, note that the last row -in the pixbuf may not be as wide as the full rowstride, but rather -just as wide as the pixel data needs to be. That is, it is unsafe to -do `memcpy (dest, pixels, rowstride * height)` to copy a whole pixbuf. -Use gdk_pixbuf_copy() instead, or compute the width in bytes of the -last row as `width * ((n_channels * bits_per_sample + 7) / 8)`. - - - #GdkPixbufLoader provides a way for applications to drive the -process of loading an image, by letting them send the image data -directly to the loader instead of having the loader read the data -from a file. Applications can use this functionality instead of -gdk_pixbuf_new_from_file() or gdk_pixbuf_animation_new_from_file() -when they need to parse image data in -small chunks. For example, it should be used when reading an -image from a (potentially) slow network connection, or when -loading an extremely large file. - - -To use #GdkPixbufLoader to load an image, just create a new one, and -call gdk_pixbuf_loader_write() to send the data to it. When done, -gdk_pixbuf_loader_close() should be called to end the stream and -finalize everything. The loader will emit three important signals -throughout the process. The first, #GdkPixbufLoader::size-prepared, -will be emitted as soon as the image has enough information to -determine the size of the image to be used. If you want to scale -the image while loading it, you can call gdk_pixbuf_loader_set_size() -in response to this signal. - - -The second signal, #GdkPixbufLoader::area-prepared, will be emitted as -soon as the pixbuf of the desired has been allocated. You can obtain it -by calling gdk_pixbuf_loader_get_pixbuf(). If you want to use it, simply -ref it. You can also call gdk_pixbuf_loader_get_pixbuf() later and get -the same pixbuf. - -The last signal, #GdkPixbufLoader::area-updated, gets emitted every time -a region is updated. This way you can update a partially completed image. -Note that you do not know anything about the completeness of an image -from the updated area. For example, in an interlaced image, you need to -make several passes before the image is done loading. - -# Loading an animation - -Loading an animation is almost as easy as loading an image. Once the first -#GdkPixbufLoader::area-prepared signal has been emitted, you can call -gdk_pixbuf_loader_get_animation() to get the #GdkPixbufAnimation struct -and gdk_pixbuf_animation_get_iter() to get a #GdkPixbufAnimationIter for -displaying it. - - - These macros and variables let you check the version of gdk-pixbuf -you're linking against. - - - Using #GdkPixdata, images can be compiled into an application, -making it unnecessary to refer to external image files at runtime. -GdkPixBuf includes a utility named gdk-pixbuf-csource, which -can be used to convert image files into #GdkPixdata structures suitable -for inclusion in C sources. To convert the #GdkPixdata structures back -into #GdkPixbufs, use gdk_pixbuf_from_pixdata. - -#GdkPixdata should not be used any more. #GResource should be used to save -the original compressed images inside the program's binary. - - - If GdkPixBuf has been compiled with GModule support, it can be extended by -modules which can load (and perhaps also save) new image and animation -formats. Each loadable module must export a -#GdkPixbufModuleFillInfoFunc function named `fill_info` and -a #GdkPixbufModuleFillVtableFunc function named -`fill_vtable`. - -In order to make format-checking work before actually loading the modules -(which may require dlopening image libraries), modules export their -signatures (and other information) via the `fill_info` function. An -external utility, gdk-pixbuf-query-loaders, uses this to create a text -file containing a list of all available loaders and their signatures. -This file is then read at runtime by GdkPixBuf to obtain the list of -available loaders and their signatures. - -Modules may only implement a subset of the functionality available via -#GdkPixbufModule. If a particular functionality is not implemented, the -`fill_vtable` function will simply not set the corresponding -function pointers of the #GdkPixbufModule structure. If a module supports -incremental loading (i.e. provides #begin_load, #stop_load and -#load_increment), it doesn't have to implement #load, since GdkPixBuf can -supply a generic #load implementation wrapping the incremental loading. - -Installing a module is a two-step process: -- copy the module file(s) to the loader directory (normally - `$libdir/gdk-pixbuf-2.0/$version/loaders`, unless overridden by the - environment variable `GDK_PIXBUF_MODULEDIR`) -- call gdk-pixbuf-query-loaders to update the module file (normally - `$libdir/gdk-pixbuf-2.0/$version/loaders.cache`, unless overridden by the - environment variable `GDK_PIXBUF_MODULE_FILE`) - -The GdkPixBuf interfaces needed for implementing modules are contained in -`gdk-pixbuf-io.h` (and `gdk-pixbuf-animation.h` if the module supports -animations). They are not covered by the same stability guarantees as the -regular GdkPixBuf API. To underline this fact, they are protected by -`#ifdef GDK_PIXBUF_ENABLE_BACKEND`. - - + - - #GdkPixbuf structures are reference counted. This means that an -application can share a single pixbuf among many parts of the -code. When a piece of the program needs to keep a pointer to a -pixbuf, it should add a reference to it by calling g_object_ref(). -When it no longer needs the pixbuf, it should subtract a reference -by calling g_object_unref(). The pixbuf will be destroyed when -its reference count drops to zero. Newly-created #GdkPixbuf -structures start with a reference count of one. - -> As #GdkPixbuf is derived from #GObject now, gdk_pixbuf_ref() and -> gdk_pixbuf_unref() are deprecated in favour of g_object_ref() -> and g_object_unref() resp. - -Finalizing a pixbuf means to free its pixel data and to free the -#GdkPixbuf structure itself. Most of the library functions that -create #GdkPixbuf structures create the pixel data by themselves -and define the way it should be freed; you do not need to worry -about those. - -To provide preallocated pixel data, use -gdk_pixbuf_new_from_bytes(). The gdk_pixbuf_new_from_data() API is -an older variant that predates the existence of #GBytes. - - - The GdkPixBuf contains functions to scale pixbufs, to scale -pixbufs and alpha blend against an existing image, and to scale -pixbufs and alpha blend against a solid color or checkerboard. -Alpha blending a checkerboard is a common way to show an image with -an alpha channel in image-viewing and editing software. - -Note that in these functions, the terms ‘alpha blending’ and ‘compositing’ -are used synonymously. - -Since the full-featured functions (gdk_pixbuf_scale(), -gdk_pixbuf_composite(), and gdk_pixbuf_composite_color()) are -rather complex to use and have many arguments, two simple -convenience functions are provided, gdk_pixbuf_scale_simple() and -gdk_pixbuf_composite_color_simple() which create a new pixbuf of a -given size, scale an original image to fit, and then return the -new pixbuf. - -If the destination pixbuf was created from a readonly source, these -operations will force a copy into a mutable buffer. - -Scaling and alpha blending functions take advantage of MMX hardware -acceleration on systems where MMX is supported. If gdk-pixbuf is built -with the Sun mediaLib library, these functions are instead accelerated -using mediaLib, which provides hardware acceleration on Intel, AMD, -and Sparc chipsets. If desired, mediaLib support can be turned off by -setting the `GDK_DISABLE_MEDIALIB` environment variable. - -The alpha blending function used is: - -|[<!-- language="plain" --> -Cd = Cs·As + Cd(1-As) -]| - -where `Cd` is the destination pixel color, `Cs` is the source pixel color, -and `As` is the source pixel alpha. - - - These functions provide miscellaneous utilities for manipulating -pixbufs. The pixel data in pixbufs may of course be manipulated -directly by applications, but several common operations can be -performed by these functions instead. - diff --git a/GdkPixdata-2.0.gir b/GdkPixdata-2.0.gir index d1be983..aa7124f 100644 --- a/GdkPixdata-2.0.gir +++ b/GdkPixdata-2.0.gir @@ -25,63 +25,78 @@ and/or use gtk-doc annotations. --> + c:type="GDK_PIXDATA_HEADER_LENGTH" + deprecated="1" + deprecated-version="2.32"> The length of a #GdkPixdata structure without the @pixel_data pointer. - + line="83">The length of a #GdkPixdata structure without the @pixel_data pointer. + - + A #GdkPixdata contains pixbuf information in a form suitable for -serialization and streaming. - + filename="../gdk-pixbuf/gdk-pixdata.c" + line="25">A pixel buffer suitable for serialization and streaming. + +Using `GdkPixdata`, images can be compiled into an application, +making it unnecessary to refer to external image files at runtime. + +`GdkPixbuf` includes a utility named `gdk-pixbuf-csource`, which +can be used to convert image files into `GdkPixdata` structures suitable +for inclusion in C sources. To convert the `GdkPixdata` structures back +into a `GdkPixbuf`, use `gdk_pixbuf_from_pixdata()`. + `GdkPixdata` should not be used any more. `GResource` + should be used to save the original compressed images inside the + program's binary + magic number. A valid #GdkPixdata structure must have - #GDK_PIXBUF_MAGIC_NUMBER here. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="27">magic number. A valid `GdkPixdata` structure must have + `GDK_PIXBUF_MAGIC_NUMBER` here less than 1 to disable length checks, otherwise - #GDK_PIXDATA_HEADER_LENGTH + length of @pixel_data. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="29">less than 1 to disable length checks, otherwise + `GDK_PIXDATA_HEADER_LENGTH` plus the length of `pixel_data` information about colorspace, sample width and - encoding, in a #GdkPixdataType. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="31">information about colorspace, sample width and + encoding, in a `GdkPixdataType` Distance in bytes between rows. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="33">Distance in bytes between rows Width of the image in pixels. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="34">Width of the image in pixels Height of the image in pixels. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="35">Height of the image in pixels @width x @height pixels, encoded according to @pixdata_type - and @rowstride. + filename="../gdk-pixbuf/gdk-pixdata.c" + line="36">`width` x `height` + pixels, encoded according to `pixdata_type` and `rowstride` @@ -93,39 +108,43 @@ serialization and streaming. throws="1"> Deserializes (reconstruct) a #GdkPixdata structure from a byte stream. + line="199">Deserializes (reconstruct) a #GdkPixdata structure from a byte stream. + The byte stream consists of a straightforward writeout of the -#GdkPixdata fields in network byte order, plus the @pixel_data +`GdkPixdata` fields in network byte order, plus the `pixel_data` bytes the structure points to. -The @pixdata contents are reconstructed byte by byte and are checked -for validity. This function may fail with %GDK_PIXBUF_ERROR_CORRUPT_IMAGE -or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE. - Use #GResource instead. - + +The `pixdata` contents are reconstructed byte by byte and are checked +for validity. + +This function may fail with `GDK_PIXBUF_ERROR_CORRUPT_IMAGE` +or `GDK_PIXBUF_ERROR_UNKNOWN_TYPE`. + Use `GResource` instead. + Upon successful deserialization %TRUE is returned, -%FALSE otherwise. + line="219">Upon successful deserialization `TRUE` is returned, +`FALSE` otherwise. a #GdkPixdata structure to be filled in. + line="201">a #GdkPixdata structure to be filled in. length of the stream used for deserialization. + line="202">length of the stream used for deserialization. stream of bytes containing a + line="203">stream of bytes containing a serialized #GdkPixdata structure. @@ -140,36 +159,39 @@ or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE. deprecated-version="2.32"> Converts a #GdkPixbuf to a #GdkPixdata. If @use_rle is %TRUE, the -pixel data is run-length encoded into newly-allocated memory and a -pointer to that memory is returned. + line="338">Converts a `GdkPixbuf` to a `GdkPixdata`. + +If `use_rle` is `TRUE`, the pixel data is run-length encoded into +newly-allocated memory and a pointer to that memory is returned. Use #GResource instead. - + If @use_rle is %TRUE, a pointer to the - newly-allocated memory for the run-length encoded pixel data, - otherwise %NULL. - + line="349">If `use_rle` is + `TRUE`, a pointer to the newly-allocated memory for the run-length + encoded pixel data, otherwise `NULL`. + + + a #GdkPixdata to fill. + line="340">a `GdkPixdata` to fill. the data to fill @pixdata with. + line="341">the data to fill `pixdata` with. whether to use run-length encoding for the pixel data. + line="342">whether to use run-length encoding for the pixel data. @@ -180,16 +202,16 @@ pointer to that memory is returned. deprecated-version="2.32"> Serializes a #GdkPixdata structure into a byte stream. + line="110">Serializes a #GdkPixdata structure into a byte stream. The byte stream consists of a straightforward writeout of the #GdkPixdata fields in network byte order, plus the @pixel_data bytes the structure points to. Use #GResource instead. - + A + line="120">A newly-allocated string containing the serialized #GdkPixdata structure. @@ -200,7 +222,7 @@ structure. a valid #GdkPixdata structure to serialize. + line="112">a valid #GdkPixdata structure to serialize. transfer-ownership="full"> location to store the resulting stream length in. + line="113">location to store the resulting stream length in. @@ -220,60 +242,61 @@ structure. deprecated-version="2.32"> Generates C source code suitable for compiling images directly + line="711">Generates C source code suitable for compiling images directly into programs. -gdk-pixbuf ships with a program called -[gdk-pixbuf-csource][gdk-pixbuf-csource], which offers a command -line interface to this function. +GdkPixbuf ships with a program called `gdk-pixbuf-csource`, which offers +a command line interface to this function. Use #GResource instead. - + a newly-allocated string containing the C source form - of @pixdata. + line="723">a newly-allocated string buffer containing + the C source form of `pixdata`. a #GdkPixdata to convert to C source. + line="713">a `GdkPixdata` to convert to C source used for naming generated data structures or macros. + line="714">used for naming generated data structures or macros a #GdkPixdataDumpType determining the kind of C - source to be generated. + line="715">the kind of C source to be generated - + An enumeration which is used by gdk_pixdata_to_csource() to + line="109">An enumeration which is used by gdk_pixdata_to_csource() to determine the form of C source to be generated. The three values @GDK_PIXDATA_DUMP_PIXDATA_STREAM, @GDK_PIXDATA_DUMP_PIXDATA_STRUCT and @GDK_PIXDATA_DUMP_MACROS are mutually exclusive, as are @GDK_PIXBUF_DUMP_GTYPES and @GDK_PIXBUF_DUMP_CTYPES. The remaining elements are optional flags that can be freely added. - + Generate pixbuf data stream (a single + line="111">Generate pixbuf data stream (a single string containing a serialized #GdkPixdata structure in network byte order). @@ -282,13 +305,13 @@ elements are optional flags that can be freely added. c:identifier="GDK_PIXDATA_DUMP_PIXDATA_STRUCT"> Generate #GdkPixdata structure (needs + line="114">Generate #GdkPixdata structure (needs the #GdkPixdata structure definition from gdk-pixdata.h). Generate <function>*_ROWSTRIDE</function>, + line="116">Generate <function>*_ROWSTRIDE</function>, <function>*_WIDTH</function>, <function>*_HEIGHT</function>, <function>*_BYTES_PER_PIXEL</function> and <function>*_RLE_PIXEL_DATA</function> or <function>*_PIXEL_DATA</function> @@ -297,41 +320,44 @@ elements are optional flags that can be freely added. Generate GLib data types instead of + line="121">Generate GLib data types instead of standard C data types. Generate standard C data types instead of + line="123">Generate standard C data types instead of GLib data types. Generate static symbols. + line="125">Generate static symbols. Generate const symbols. + line="126">Generate const symbols. Provide a <function>*_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp)</function> + line="127">Provide a <function>*_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp)</function> macro definition to decode run-length encoded image data. - + An enumeration containing three sets of flags for a #GdkPixdata struct: one for the used colorspace, one for the width of the samples and one for the encoding of the pixel data. - + @@ -394,19 +420,6 @@ for the encoding of the pixel data. line="46">mask for the encoding flags of the enum. - - Using #GdkPixdata, images can be compiled into an application, -making it unnecessary to refer to external image files at runtime. -GdkPixBuf includes a utility named gdk-pixbuf-csource, which -can be used to convert image files into #GdkPixdata structures suitable -for inclusion in C sources. To convert the #GdkPixdata structures back -into #GdkPixbufs, use gdk_pixbuf_from_pixdata. - -#GdkPixdata should not be used any more. #GResource should be used to save -the original compressed images inside the program's binary. - throws="1"> Converts a #GdkPixdata to a #GdkPixbuf. If @copy_pixels is %TRUE or -if the pixel data is run-length-encoded, the pixel data is copied into -newly-allocated memory; otherwise it is reused. - Use #GResource instead. - + line="438">Converts a `GdkPixdata` to a `GdkPixbuf`. + +If `copy_pixels` is `TRUE` or if the pixel data is run-length-encoded, +the pixel data is copied into newly-allocated memory; otherwise it is +reused. + Use `GResource` instead. + a new #GdkPixbuf. + line="451">a new pixbuf a #GdkPixdata to convert into a #GdkPixbuf. + line="440">a #GdkPixdata to convert into a `GdkPixbuf`. whether to copy raw pixel data; run-length encoded - pixel data is always copied. + line="441">whether to copy raw pixel data; run-length encoded + pixel data is always copied. diff --git a/GdkWayland-4.0.gir b/GdkWayland-4.0.gir index ce67c89..7b5ab93 100644 --- a/GdkWayland-4.0.gir +++ b/GdkWayland-4.0.gir @@ -8,147 +8,170 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + - The Wayland implementation of `GdkDevice`. + The Wayland implementation of `GdkDevice`. Beyond the regular [class@Gdk.Device] API, the Wayland implementation provides access to Wayland objects such as the `wl_seat` with [method@GdkWayland.WaylandDevice.get_wl_seat], the `wl_keyboard` with [method@GdkWayland.WaylandDevice.get_wl_keyboard] and the `wl_pointer` with [method@GdkWayland.WaylandDevice.get_wl_pointer]. + - Returns the `/dev/input/event*` path of this device. + Returns the `/dev/input/event*` path of this device. For `GdkDevice`s that possibly coalesce multiple hardware devices (eg. mouse, keyboard, touch,...), this function @@ -156,74 +179,81 @@ will return %NULL. This is most notably implemented for devices of type %GDK_SOURCE_PEN, %GDK_SOURCE_TABLET_PAD. + - the `/dev/input/event*` + the `/dev/input/event*` path of this device - a `GdkDevice` + a `GdkDevice` - Returns the Wayland `wl_keyboard` of a `GdkDevice`. + Returns the Wayland `wl_keyboard` of a `GdkDevice`. + - a Wayland `wl_keyboard` + a Wayland `wl_keyboard` - a `GdkDevice` + a `GdkDevice` - Returns the Wayland `wl_pointer` of a `GdkDevice`. + Returns the Wayland `wl_pointer` of a `GdkDevice`. + - a Wayland `wl_pointer` + a Wayland `wl_pointer` - a `GdkDevice` + a `GdkDevice` - Returns the Wayland `wl_seat` of a `GdkDevice`. + Returns the Wayland `wl_seat` of a `GdkDevice`. + - a Wayland `wl_seat` + a Wayland `wl_seat` - a `GdkDevice` + a `GdkDevice` - Returns the `xkb_keymap` of a `GdkDevice`. + Returns the `xkb_keymap` of a `GdkDevice`. + - a `struct xkb_keymap` + a `struct xkb_keymap` - a `GdkDevice` + a `GdkDevice` - + + + - The Wayland implementation of `GdkDisplay`. + The Wayland implementation of `GdkDisplay`. Beyond the regular [class@Gdk.Display] API, the Wayland implementation provides access to Wayland objects such as the `wl_display` with @@ -232,99 +262,106 @@ provides access to Wayland objects such as the `wl_display` with You can find out what Wayland globals are supported by a display with [method@GdkWayland.WaylandDisplay.query_registry]. + - Retrieves the EGL display connection object for the given GDK display. + Retrieves the EGL display connection object for the given GDK display. + - the EGL display + the EGL display - a Wayland display + a Wayland display - Gets the startup notification ID for a Wayland display, or %NULL + Gets the startup notification ID for a Wayland display, or %NULL if no ID has been defined. + - the startup notification ID for @display + the startup notification ID for @display - a `GdkDisplay` + a `GdkDisplay` - Returns the Wayland `wl_compositor` of a `GdkDisplay`. + Returns the Wayland `wl_compositor` of a `GdkDisplay`. + - a Wayland `wl_compositor` + a Wayland `wl_compositor` - a `GdkDisplay` + a `GdkDisplay` - Returns the Wayland `wl_display` of a `GdkDisplay`. + Returns the Wayland `wl_display` of a `GdkDisplay`. + - a Wayland `wl_display` + a Wayland `wl_display` - a `GdkDisplay` + a `GdkDisplay` - Returns %TRUE if the the interface was found in the display + Returns %TRUE if the the interface was found in the display `wl_registry.global` handler. + - %TRUE if the global is offered by the compositor + %TRUE if the global is offered by the compositor - a `GdkDisplay` + a `GdkDisplay` - global interface to query in the registry + global interface to query in the registry - Sets the cursor theme for the given @display. + Sets the cursor theme for the given @display. + - a `GdkDisplay` + a `GdkDisplay` - the new cursor theme + the new cursor theme - the size to use for cursors + the size to use for cursors - Sets the startup notification ID for a display. + Sets the startup notification ID for a display. This is usually taken from the value of the `DESKTOP_STARTUP_ID` environment variable, but in some cases (such as the application not @@ -333,94 +370,109 @@ being launched using exec()) it can come from other sources. The startup ID is also what is used to signal that the startup is complete (for example, when opening a window or when calling [method@Gdk.Display.notify_startup_complete]). + - a `GdkDisplay` + a `GdkDisplay` - the startup notification ID (must be valid utf8) + the startup notification ID (must be valid utf8) - + + + - The Wayland implementation of `GdkGLContext`. + The Wayland implementation of `GdkGLContext`. + - + + + - The Wayland implementation of `GdkMonitor`. + The Wayland implementation of `GdkMonitor`. Beyond the [class@Gdk.Monitor] API, the Wayland implementation offers access to the Wayland `wl_output` object with [method@GdkWayland.WaylandMonitor.get_wl_output]. + - Returns the Wayland `wl_output` of a `GdkMonitor`. + Returns the Wayland `wl_output` of a `GdkMonitor`. + - a Wayland `wl_output` + a Wayland `wl_output` - a `GdkMonitor` + a `GdkMonitor` - + + + - The Wayland implementation of `GdkPopup`. + The Wayland implementation of `GdkPopup`. - The Wayland implementation of `GdkSeat`. + The Wayland implementation of `GdkSeat`. Beyond the regular [class@Gdk.Seat] API, the Wayland implementation provides access to the Wayland `wl_seat` object with [method@GdkWayland.WaylandSeat.get_wl_seat]. + - Returns the Wayland `wl_seat` of a `GdkSeat`. + Returns the Wayland `wl_seat` of a `GdkSeat`. + - a Wayland `wl_seat` + a Wayland `wl_seat` - a `GdkSeat` + a `GdkSeat` - + + + - The Wayland implementation of `GdkSurface`. + The Wayland implementation of `GdkSurface`. Beyond the [class@Gdk.Surface] API, the Wayland implementation offers access to the Wayland `wl_surface` object with [method@GdkWayland.WaylandSurface.get_wl_surface]. - Returns the Wayland `wl_surface` of a `GdkSurface`. + Returns the Wayland `wl_surface` of a `GdkSurface`. + - a Wayland `wl_surface` + a Wayland `wl_surface` - a `GdkSurface` + a `GdkSurface` - The Wayland implementation of `GdkToplevel`. + The Wayland implementation of `GdkToplevel`. Beyond the [iface@Gdk.Toplevel] API, the Wayland implementation has API to set up cross-process parent-child relationships between @@ -428,7 +480,7 @@ surfaces with [method@GdkWayland.WaylandToplevel.export_handle] and [method@GdkWayland.WaylandToplevel.set_transient_for_exported]. - Asynchronously obtains a handle for a surface that can be passed + Asynchronously obtains a handle for a surface that can be passed to other processes. When the handle has been obtained, @callback will be called. @@ -445,48 +497,50 @@ from another surface as transient for this one, see Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future. + - %TRUE if the handle has been requested, %FALSE if + %TRUE if the handle has been requested, %FALSE if an error occurred. - the `GdkToplevel` to obtain a handle for + the `GdkToplevel` to obtain a handle for - callback to call with the handle + callback to call with the handle - user data for @callback + user data for @callback - destroy notify for @user_data + destroy notify for @user_data - Sets the application id on a `GdkToplevel`. + Sets the application id on a `GdkToplevel`. + - a `GdkToplevel` + a `GdkToplevel` - the application id for the @toplevel + the application id for the @toplevel - Marks @toplevel as transient for the surface to which the given + Marks @toplevel as transient for the surface to which the given @parent_handle_str refers. Typically, the handle will originate from a @@ -494,24 +548,25 @@ Typically, the handle will originate from a Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future. + - %TRUE if the surface has been marked as transient, + %TRUE if the surface has been marked as transient, %FALSE if an error occurred. - the `GdkToplevel` to make as transient + the `GdkToplevel` to make as transient - an exported handle for a surface + an exported handle for a surface - Destroys the handle that was obtained with + Destroys the handle that was obtained with gdk_wayland_toplevel_export_handle(). It is an error to call this function on a surface that @@ -519,39 +574,41 @@ does not have a handle. Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future. + - the `GdkToplevel` to unexport + the `GdkToplevel` to unexport - Callback that gets called when the handle for a surface has been + Callback that gets called when the handle for a surface has been obtained from the Wayland compositor. This callback is used in [method@GdkWayland.WaylandToplevel.export_handle]. The @handle can be passed to other processes, for the purpose of marking surfaces as transient for out-of-process surfaces. + - the `GdkToplevel` that is exported + the `GdkToplevel` that is exported - the handle + the handle - user data that was passed to [method@GdkWayland.WaylandToplevel.export_handle] + user data that was passed to [method@GdkWayland.WaylandToplevel.export_handle] diff --git a/GdkX11-4.0.gir b/GdkX11-4.0.gir index 123eecb..5fd0466 100644 --- a/GdkX11-4.0.gir +++ b/GdkX11-4.0.gir @@ -2,204 +2,380 @@ - + - - - Returns the display of a `GdkDisplay`. + + + Returns the display of a `GdkDisplay`. + - a `GdkDisplay` + a `GdkDisplay` - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - - Converts a @gpointer back to an XID that was previously converted + + Converts a @gpointer back to an XID that was previously converted using GDK_XID_TO_POINTER(). + - pointer to extract an XID from + pointer to extract an XID from - - Returns the display of a `GdkSurface`. + + Returns the display of a `GdkSurface`. + - a `GdkSurface` + a `GdkSurface` - - Returns the X window belonging to a `GdkSurface`. + + Returns the X window belonging to a `GdkSurface`. + - a `GdkSurface` + a `GdkSurface` - - - - + + + + + + + + + - + - + - + - + + + - + + - + - + - - + + + - - + + + + + - Tries to open a new display to the X server given by + Tries to open a new display to the X server given by @display_name. If opening the display fails, %NULL is returned. + - The new display + The new display - - name of the X display. + + name of the X display. See the XOpenDisplay() for details. - - Sets the program class. + + Sets the program class. The X11 backend uses the program class to set the class name part of the `WM_CLASS` property on toplevel windows; see the ICCCM. + - a `GdkDisplay` + a `GdkDisplay` - a string + a string - - Sends a startup notification message of type @message_type to + + Sends a startup notification message of type @message_type to @display. This is a convenience function for use by code that implements the @@ -207,293 +383,444 @@ freedesktop startup notification specification. Applications should not normally need to call it directly. See the [Startup Notification Protocol specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt) for definitions of the message types and keys that can be used. + - a `GdkDisplay` + a `GdkDisplay` - startup notification message type ("new", "change", + startup notification message type ("new", "change", or "remove") - a list of key/value pairs (as strings), terminated by a + a list of key/value pairs (as strings), terminated by a %NULL key. (A %NULL value for a key will cause that key to be skipped in the output.) - - Pops the error trap pushed by gdk_x11_display_error_trap_push(). + + Pops the error trap pushed by gdk_x11_display_error_trap_push(). Will XSync() if necessary and will always block until the error is known to have occurred or not occurred, so the error code can be returned. -If you don’t need to use the return value, +If you don’t need to use the return value, gdk_x11_display_error_trap_pop_ignored() would be more efficient. + - X error code or 0 on success + X error code or 0 on success - the display + the display - - Pops the error trap pushed by gdk_x11_display_error_trap_push(). + + Pops the error trap pushed by gdk_x11_display_error_trap_push(). Does not block to see if an error occurred; merely records the range of requests to ignore errors for, and ignores those errors if they arrive asynchronously. + - the display + the display - - Begins a range of X requests on @display for which X error events + + Begins a range of X requests on @display for which X error events will be ignored. Unignored errors (when no trap is pushed) will abort the application. Use gdk_x11_display_error_trap_pop() or gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed with this function. + - a `GdkDisplay` + a `GdkDisplay` - - Returns the default group leader surface for all toplevel surfaces + + Returns the default group leader surface for all toplevel surfaces on @display. This surface is implicitly created by GDK. See gdk_x11_surface_set_group(). + - The default group leader surface + The default group leader surface for @display - a `GdkDisplay` + a `GdkDisplay` - - Retrieves the EGL display connection object for the given GDK display. + + Retrieves the EGL display connection object for the given GDK display. This function returns `NULL` if GDK is using GLX. + - the EGL display object + the EGL display object - an X11 display + an X11 display - - Retrieves the version of the EGL implementation. + + Retrieves the version of the EGL implementation. + - %TRUE if EGL is available + %TRUE if EGL is available - a `GdkDisplay` + a `GdkDisplay` - - return location for the EGL major version + + return location for the EGL major version - - return location for the EGL minor version + + return location for the EGL minor version - - Retrieves the version of the GLX implementation. + + Retrieves the version of the GLX implementation. + - %TRUE if GLX is available + %TRUE if GLX is available - a `GdkDisplay` + a `GdkDisplay` - - return location for the GLX major version + + return location for the GLX major version - - return location for the GLX minor version + + return location for the GLX minor version - - Gets the primary monitor for the display. + + Gets the primary monitor for the display. -The primary monitor is considered the monitor where the “main desktop” +The primary monitor is considered the monitor where the “main desktop” lives. While normal application surfaces typically allow the window manager to place the surfaces, specialized desktop applications such as panels should place themselves on the primary monitor. If no monitor is the designated primary monitor, any monitor (usually the first) may be returned. + - the primary monitor, or any monitor if no + the primary monitor, or any monitor if no primary monitor is configured by the user - a `GdkDisplay` + a `GdkDisplay` - Retrieves the `GdkX11Screen` of the @display. + Retrieves the `GdkX11Screen` of the @display. + - the `GdkX11Screen` + the `GdkX11Screen` - a `GdkX11Display` + a `GdkX11Display` - - Gets the startup notification ID for a display. + + Gets the startup notification ID for a display. + - the startup notification ID for @display + the startup notification ID for @display - a `GdkDisplay` + a `GdkDisplay` - - Returns the timestamp of the last user interaction on + + Returns the timestamp of the last user interaction on @display. The timestamp is taken from events caused by user interaction such as key presses or pointer movements. See gdk_x11_surface_set_user_time(). + - the timestamp of the last user interaction + the timestamp of the last user interaction - a `GdkDisplay` + a `GdkDisplay` - Returns the X cursor belonging to a `GdkCursor`, potentially + Returns the X cursor belonging to a `GdkCursor`, potentially creating the cursor. Be aware that the returned cursor may not be unique to @cursor. It may for example be shared with its fallback cursor. On old X servers that don't support the XCursor extension, all cursors may even fall back to a few default cursors. + - an Xlib Cursor. + an Xlib Cursor. - a `GdkDisplay` + a `GdkDisplay` - a `GdkCursor` + a `GdkCursor` - Returns the X display of a `GdkDisplay`. + Returns the X display of a `GdkDisplay`. + - an X display + an X display - a `GdkDisplay` + a `GdkDisplay` - - Returns the root X window used by `GdkDisplay`. + + Returns the root X window used by `GdkDisplay`. + - an X Window + an X Window - a `GdkDisplay` + a `GdkDisplay` - Returns the X Screen used by `GdkDisplay`. + Returns the X Screen used by `GdkDisplay`. + - an X Screen + an X Screen - a `GdkDisplay` + a `GdkDisplay` - Call XGrabServer() on @display. + Call XGrabServer() on @display. To ungrab the display again, use gdk_x11_display_ungrab(). gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested. + - a `GdkDisplay` + a `GdkDisplay` - - Sets the cursor theme from which the images for cursor + + Sets the cursor theme from which the images for cursor should be taken. If the windowing system supports it, existing cursors created @@ -502,27 +829,40 @@ change. Custom cursors constructed with [ctor@Gdk.Cursor.new_from_texture] will have to be handled by the application (GTK applications can learn about cursor theme changes by listening for change notification for the corresponding `GtkSetting`). + - a `GdkDisplay` + a `GdkDisplay` - - the name of the cursor theme to use, or %NULL + + the name of the cursor theme to use, or %NULL to unset a previously set value - the cursor size to use, or 0 to keep the previous size + the cursor size to use, or 0 to keep the previous size - - Sets the startup notification ID for a display. + + Sets the startup notification ID for a display. This is usually taken from the value of the DESKTOP_STARTUP_ID environment variable, but in some cases (such as the application not @@ -536,115 +876,176 @@ accordingly. The startup ID is also what is used to signal that the startup is complete (for example, when opening a window or when calling gdk_display_notify_startup_complete()). + - a `GdkDisplay` + a `GdkDisplay` - the startup notification ID (must be valid utf8) + the startup notification ID (must be valid utf8) - - Forces a specific window scale for all windows on this display, + + Forces a specific window scale for all windows on this display, instead of using the default or user configured scale. This is can be used to disable scaling support by setting @scale to 1, or to programmatically set the window scale. Once the scale is set by this call it will not change in response to later user configuration changes. + - the display + the display - The new scale value + The new scale value - - Convert a string from the encoding of the current + + Convert a string from the encoding of the current locale into a form suitable for storing in a window property. + - 0 upon success, non-zero upon failure + 0 upon success, non-zero upon failure - the `GdkDisplay` where the encoding is defined + the `GdkDisplay` where the encoding is defined - a nul-terminated string + a nul-terminated string - - location to store the encoding + + location to store the encoding (to be used as the type for the property) - - location to store the format of the property + + location to store the format of the property - - location to store newly + + location to store newly allocated data for the property - - the length of @ctext, in bytes + + the length of @ctext, in bytes - - Convert a text string from the encoding as it is stored + + Convert a text string from the encoding as it is stored in a property into an array of strings in the encoding of the current locale. (The elements of the array represent the nul-separated elements of the original text string.) + - the number of strings stored in list, or 0, + the number of strings stored in list, or 0, if the conversion failed - The `GdkDisplay` where the encoding is defined + The `GdkDisplay` where the encoding is defined - a string representing the encoding. The most + a string representing the encoding. The most common values for this are "STRING", or "COMPOUND_TEXT". This is value used as the type for the property - the format of the property + the format of the property - The text data + The text data - The number of items to transform + The number of items to transform - location to store an array of strings in + location to store an array of strings in the encoding of the current locale. This array should be freed using gdk_x11_free_text_list(). @@ -652,55 +1053,92 @@ nul-separated elements of the original text string.) - Ungrab @display after it has been grabbed with + Ungrab @display after it has been grabbed with gdk_x11_display_grab(). + - a `GdkDisplay` + a `GdkDisplay` - - Converts from UTF-8 to compound text. + + Converts from UTF-8 to compound text. + - %TRUE if the conversion succeeded, otherwise %FALSE + %TRUE if the conversion succeeded, otherwise %FALSE - a `GdkDisplay` + a `GdkDisplay` - a UTF-8 string + a UTF-8 string - - location to store resulting encoding + + location to store resulting encoding - - location to store format of the result + + location to store format of the result - - location to store the data of the result + + location to store the data of the result - - location to store the length of the data stored in @ctext + + location to store the length of the data stored in @ctext - The ::xevent signal is a low level signal that is emitted + The ::xevent signal is a low level signal that is emitted whenever an XEvent has been received. When handlers to this signal return %TRUE, no other handlers will be @@ -716,177 +1154,311 @@ If you are interested in X GenericEvents, bear in mind that XGetEventData() has been already called on the event, and XFreeEventData() will be called afterwards. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - - a pointer to the XEvent to process + + a pointer to the XEvent to process - - - - - - + + + + + + + + + + + + + + + + + - Returns the XID of the Output corresponding to @monitor. + Returns the XID of the Output corresponding to @monitor. + - the XID of @monitor + the XID of @monitor - a `GdkMonitor` + a `GdkMonitor` - Retrieves the size and position of the “work area” on a monitor + Retrieves the size and position of the “work area” on a monitor within the display coordinate space. -The returned geometry is in ”application pixels”, not in ”device pixels” +The returned geometry is in ”application pixels”, not in ”device pixels” (see [method@Gdk.Monitor.get_scale_factor]). + - a `GdkMonitor` + a `GdkMonitor` - - a `GdkRectangle` to be filled with the monitor workarea + + a `GdkRectangle` to be filled with the monitor workarea - - - - Returns the current workspace for @screen when running under a + + + + + + + Returns the current workspace for @screen when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. + - the current workspace, or 0 if workspaces are not supported + the current workspace, or 0 if workspaces are not supported - a `GdkX11Screen` + a `GdkX11Screen` - - Gets the XID of the specified output/monitor. + + Gets the XID of the specified output/monitor. If the X server does not support version 1.2 of the RANDR extension, 0 is returned. + - the XID of the monitor + the XID of the monitor - a `GdkX11Screen` + a `GdkX11Screen` - number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) + number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) - - Returns the number of workspaces for @screen when running under a + + Returns the number of workspaces for @screen when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. + - the number of workspaces, or 0 if workspaces are not supported + the number of workspaces, or 0 if workspaces are not supported - a `GdkX11Screen` + a `GdkX11Screen` - - Returns the index of a `GdkX11Screen`. + + Returns the index of a `GdkX11Screen`. + - the position of @screen among the screens + the position of @screen among the screens of its display - a `GdkX11Screen` + a `GdkX11Screen` - - Returns the name of the window manager for @screen. + + Returns the name of the window manager for @screen. + - the name of the window manager screen @screen, or + the name of the window manager screen @screen, or "unknown" if the window manager is unknown. The string is owned by GDK and should not be freed. - a `GdkX11Screen` + a `GdkX11Screen` - Returns the screen of a `GdkX11Screen`. + Returns the screen of a `GdkX11Screen`. + - an Xlib Screen* + an Xlib Screen* - a `GdkX11Screen` + a `GdkX11Screen` - - This function is specific to the X11 backend of GDK, and indicates + + This function is specific to the X11 backend of GDK, and indicates whether the window manager supports a certain hint from the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. When using this function, keep in mind that the window manager -can change over time; so you shouldn’t use this function in +can change over time; so you shouldn’t use this function in a way that impacts persistent application state. A common bug is that your application can start up before the window manager does when the user logs in, and before the window manager starts gdk_x11_screen_supports_net_wm_hint() will return %FALSE for every property. You can monitor the window_manager_changed signal on `GdkX11Screen` to detect a window manager change. + - %TRUE if the window manager supports @property + %TRUE if the window manager supports @property - the relevant `GdkX11Screen`. + the relevant `GdkX11Screen`. - name of the WM property + name of the WM property @@ -897,173 +1469,264 @@ a window manager change. - - - - Looks up the `GdkSurface` that wraps the given native window handle. + + + + + + + Looks up the `GdkSurface` that wraps the given native window handle. + - the `GdkSurface` wrapper + the `GdkSurface` wrapper for the native window - the `GdkDisplay` corresponding to the + the `GdkDisplay` corresponding to the window handle - an Xlib Window + an Xlib Window - Gets the number of the workspace @surface is on. + Gets the number of the workspace @surface is on. + - the current workspace of @surface + the current workspace of @surface - a `GdkSurface` + a `GdkSurface` - Returns the group this surface belongs to. + Returns the group this surface belongs to. + - The group of this surface; + The group of this surface; - The `GdkSurface` + The `GdkSurface` - Returns the X resource (surface) belonging to a `GdkSurface`. + Returns the X resource (surface) belonging to a `GdkSurface`. + - the ID of @drawable’s X resource. + the ID of @drawable’s X resource. - a native `GdkSurface`. + a native `GdkSurface`. - - Moves the surface to the correct workspace when running under a + + Moves the surface to the correct workspace when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. Will not do anything if the surface is already on all workspaces. + - a `GdkSurface` + a `GdkSurface` - - Moves the surface to the given workspace when running unde a + + Moves the surface to the given workspace when running unde a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. + - a `GdkSurface` + a `GdkSurface` - the number of the workspace to move the surface to + the number of the workspace to move the surface to - - This function can be used to disable frame synchronization for a surface. + + This function can be used to disable frame synchronization for a surface. Normally frame synchronziation will be enabled or disabled based on whether the system has a compositor that supports frame synchronization, but if the surface is not directly managed by the window manager, then frame synchronziation may need to be disabled. This is the case for a surface embedded via the XEMBED protocol. + - a native `GdkSurface` + a native `GdkSurface` - whether frame-synchronization should be enabled + whether frame-synchronization should be enabled - Sets the group leader of @surface to be @leader. + Sets the group leader of @surface to be @leader. See the ICCCM for details. + - a native `GdkSurface` + a native `GdkSurface` - a `GdkSurface` + a `GdkSurface` - - Sets a hint on @surface that pagers should not + + Sets a hint on @surface that pagers should not display it. See the EWMH for details. + - a `GdkSurface` + a `GdkSurface` - %TRUE to skip pagers + %TRUE to skip pagers - - Sets a hint on @surface that taskbars should not + + Sets a hint on @surface that taskbars should not display it. See the EWMH for details. + - a native `GdkSurface` + a native `GdkSurface` - %TRUE to skip taskbars + %TRUE to skip taskbars - - GTK applications can request a dark theme variant. In order to + + GTK applications can request a dark theme variant. In order to make other applications - namely window managers using GTK for themeing - aware of this choice, GTK uses this function to export the requested theme variant as _GTK_THEME_VARIANT property @@ -1072,39 +1735,55 @@ on toplevel surfaces. Note that this property is automatically updated by GTK, so this function should only be used by applications which do not use GTK to create toplevel surfaces. + - a `GdkSurface` + a `GdkSurface` - the theme variant to export + the theme variant to export - - Sets a hint on @surface that it needs user attention. + + Sets a hint on @surface that it needs user attention. See the ICCCM for details. + - a native `GdkSurface` + a native `GdkSurface` - %TRUE to indicate urgenct attention needed + %TRUE to indicate urgenct attention needed - - The application can use this call to update the _NET_WM_USER_TIME + + The application can use this call to update the _NET_WM_USER_TIME property on a toplevel surface. This property stores an Xserver time which represents the time of the last user input event received for this surface. This property may be used by the window @@ -1116,338 +1795,519 @@ timer or some other event. Note that this property is automatically updated by GDK, so this function should only be used by applications which handle input events bypassing GDK. + - A toplevel `GdkSurface` + A toplevel `GdkSurface` - An XServer timestamp to which the property should be set + An XServer timestamp to which the property should be set - - This function modifies or removes an arbitrary X11 window + + This function modifies or removes an arbitrary X11 window property of type UTF8_STRING. If the given @surface is not a toplevel surface, it is ignored. + - a `GdkSurface` + a `GdkSurface` - Property name, will be interned as an X atom + Property name, will be interned as an X atom - - Property value, or %NULL to delete + + Property value, or %NULL to delete - - + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - - Converts an XID into a @gpointer. This is useful with data structures + + Converts an XID into a @gpointer. This is useful with data structures that use pointer arguments such as `GHashTable`. Use GDK_POINTER_TO_XID() to convert the argument back to an XID. + - XID to stuff into the pointer + XID to stuff into the pointer - Returns the device ID as seen by XInput2. + Returns the device ID as seen by XInput2. + - the XInput2 device ID + the XInput2 device ID - a `GdkDevice` + a `GdkDevice` - - Returns the `GdkDevice` that wraps the given device ID. + + Returns the `GdkDevice` that wraps the given device ID. + - The + The `GdkDevice` wrapping the device ID, or %NULL if the given ID - doesn’t currently represent a device. + doesn’t currently represent a device. - a `GdkDeviceManager` + a `GdkDeviceManager` - a device ID, as understood by the XInput2 protocol + a device ID, as understood by the XInput2 protocol - - Frees the data returned from gdk_x11_display_string_to_compound_text(). + + Frees the data returned from gdk_x11_display_string_to_compound_text(). + - The pointer stored in @ctext from a call to + The pointer stored in @ctext from a call to gdk_x11_display_string_to_compound_text(). - Frees the array of strings created by + Frees the array of strings created by gdk_x11_display_text_property_to_text_list(). + - the value stored in the @list parameter by + the value stored in the @list parameter by a call to gdk_x11_display_text_property_to_text_list(). - - Routine to get the current X server time stamp. + + Routine to get the current X server time stamp. + - the time stamp + the time stamp - a `GdkSurface`, used for communication + a `GdkSurface`, used for communication with the server. The surface must have `GDK_PROPERTY_CHANGE_MASK` in its events mask or a hang will result. - - Returns the X atom for a `GdkDisplay` corresponding to @atom_name. + + Returns the X atom for a `GdkDisplay` corresponding to @atom_name. This function caches the result, so if called repeatedly it is much faster than XInternAtom(), which is a round trip to the server each time. + - a X atom for a `GdkDisplay` + a X atom for a `GdkDisplay` - a `GdkDisplay` + a `GdkDisplay` - a string + a string - - Returns the name of an X atom for its display. This + + Returns the name of an X atom for its display. This function is meant mainly for debugging, so for convenience, unlike -XAtomName() and the result doesn’t need to +XAtomName() and the result doesn’t need to be freed. + - name of the X atom; this string is owned by GDK, - so it shouldn’t be modified or freed. + name of the X atom; this string is owned by GDK, + so it shouldn’t be modified or freed. - the `GdkDisplay` where @xatom is defined + the `GdkDisplay` where @xatom is defined - an X atom + an X atom - - Find the `GdkDisplay` corresponding to @xdisplay, if any exists. + + Find the `GdkDisplay` corresponding to @xdisplay, if any exists. + - the `GdkDisplay`, if found, otherwise %NULL. + the `GdkDisplay`, if found, otherwise %NULL. - a pointer to an X Display + a pointer to an X Display - - Sets the `SM_CLIENT_ID` property on the application’s leader window so that -the window manager can save the application’s state using the X11R6 ICCCM + + Sets the `SM_CLIENT_ID` property on the application’s leader window so that +the window manager can save the application’s state using the X11R6 ICCCM session management protocol. See the X Session Management Library documentation for more information on session management and the Inter-Client Communication Conventions Manual + - - the client id assigned by the session manager + + the client id assigned by the session manager when the connection was opened, or %NULL to remove the property. diff --git a/Gio-2.0.gir b/Gio-2.0.gir index ed7f86d..940dfa4 100644 --- a/Gio-2.0.gir +++ b/Gio-2.0.gir @@ -229,7 +229,7 @@ and/or use gtk-doc annotations. --> glib:type-struct="ActionInterface"> #GAction represents a single named action. + line="4684">#GAction represents a single named action. The main interface to an action is that it can be activated with g_action_activate(). This results in the 'activate' signal being @@ -264,7 +264,7 @@ inside of a #GSimpleActionGroup. version="2.38"> Checks if @action_name is valid. + line="11073">Checks if @action_name is valid. @action_name is valid if it consists only of alphanumeric characters, plus '-' and '.'. The empty string is not a valid action name. @@ -275,14 +275,14 @@ It is an error to call this function with a non-utf8 @action_name. %TRUE if @action_name is valid + line="11085">%TRUE if @action_name is valid a potential action name + line="11075">a potential action name @@ -293,7 +293,7 @@ It is an error to call this function with a non-utf8 @action_name. throws="1"> Parses a detailed action name into its separate name and target + line="11090">Parses a detailed action name into its separate name and target components. Detailed action names can have three formats. @@ -321,14 +321,14 @@ empty or contains characters other than alphanumerics, '-' and '.'. %TRUE if successful, else %FALSE with @error set + line="11122">%TRUE if successful, else %FALSE with @error set a detailed action name + line="11092">a detailed action name transfer-ownership="full"> the action name + line="11093">the action name transfer-ownership="full"> the target value, or %NULL for no target + line="11094">the target value, or %NULL for no target @@ -356,7 +356,7 @@ empty or contains characters other than alphanumerics, '-' and '.'. version="2.38"> Formats a detailed action name from @action_name and @target_value. + line="11127">Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. @@ -370,14 +370,14 @@ this function. a detailed format string + line="11143">a detailed format string a valid action name + line="11129">a valid action name allow-none="1"> a #GVariant target value, or %NULL + line="11130">a #GVariant target value, or %NULL @@ -394,7 +394,7 @@ this function. Activates the action. + line="10528">Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter @@ -409,7 +409,7 @@ If the @parameter GVariant is floating, it is consumed. a #GAction + line="10530">a #GAction allow-none="1"> the parameter to the activation + line="10531">the parameter to the activation @@ -428,7 +428,7 @@ If the @parameter GVariant is floating, it is consumed. version="2.30"> Request for the state of @action to be changed to @value. + line="10545">Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See g_action_get_state_type(). @@ -446,13 +446,13 @@ If the @value GVariant is floating, it is consumed. a #GAction + line="10547">a #GAction the new state + line="10548">the new state @@ -460,7 +460,7 @@ If the @value GVariant is floating, it is consumed. Checks if @action is currently enabled. + line="10565">Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. @@ -468,14 +468,14 @@ have its state changed from outside callers. whether the action is enabled + line="10574">whether the action is enabled a #GAction + line="10567">a #GAction @@ -483,19 +483,19 @@ have its state changed from outside callers. Queries the name of @action. + line="10579">Queries the name of @action. the name of the action + line="10585">the name of the action a #GAction + line="10581">a #GAction @@ -505,7 +505,7 @@ have its state changed from outside callers. version="2.28"> Queries the type of the parameter that must be given when activating + line="10590">Queries the type of the parameter that must be given when activating @action. When activating the action using g_action_activate(), the #GVariant @@ -517,14 +517,14 @@ In the case that this function returns %NULL, you must not give any the parameter type + line="10603">the parameter type a #GAction + line="10592">a #GAction @@ -532,7 +532,7 @@ In the case that this function returns %NULL, you must not give any Queries the current state of @action. + line="10608">Queries the current state of @action. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -541,17 +541,17 @@ given by g_action_get_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the current state of the action + line="10621">the current state of the action a #GAction + line="10610">a #GAction @@ -561,7 +561,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Requests a hint about the valid range of values for the state of + line="10626">Requests a hint about the valid range of values for the state of @action. If %NULL is returned it either means that the action is not stateful @@ -583,14 +583,14 @@ g_variant_unref() when it is no longer required. the state range hint + line="10649">the state range hint a #GAction + line="10628">a #GAction @@ -600,7 +600,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Queries the type of the state of @action. + line="10654">Queries the type of the state of @action. If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the @@ -616,14 +616,14 @@ will return %NULL and you must not call g_action_change_state(). the state type, if the action is stateful + line="10671">the state type, if the action is stateful a #GAction + line="10656">a #GAction @@ -631,7 +631,7 @@ will return %NULL and you must not call g_action_change_state(). Activates the action. + line="10528">Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter @@ -646,7 +646,7 @@ If the @parameter GVariant is floating, it is consumed. a #GAction + line="10530">a #GAction allow-none="1"> the parameter to the activation + line="10531">the parameter to the activation @@ -665,7 +665,7 @@ If the @parameter GVariant is floating, it is consumed. version="2.30"> Request for the state of @action to be changed to @value. + line="10545">Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See g_action_get_state_type(). @@ -683,23 +683,24 @@ If the @value GVariant is floating, it is consumed. a #GAction + line="10547">a #GAction the new state + line="10548">the new state Checks if @action is currently enabled. + line="10565">Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. @@ -707,44 +708,48 @@ have its state changed from outside callers. whether the action is enabled + line="10574">whether the action is enabled a #GAction + line="10567">a #GAction - + Queries the name of @action. + line="10579">Queries the name of @action. the name of the action + line="10585">the name of the action a #GAction + line="10581">a #GAction Queries the type of the parameter that must be given when activating + line="10590">Queries the type of the parameter that must be given when activating @action. When activating the action using g_action_activate(), the #GVariant @@ -756,24 +761,25 @@ In the case that this function returns %NULL, you must not give any the parameter type + line="10603">the parameter type a #GAction + line="10592">a #GAction Queries the current state of @action. + line="10608">Queries the current state of @action. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -782,17 +788,17 @@ given by g_action_get_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the current state of the action + line="10621">the current state of the action a #GAction + line="10610">a #GAction @@ -802,7 +808,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Requests a hint about the valid range of values for the state of + line="10626">Requests a hint about the valid range of values for the state of @action. If %NULL is returned it either means that the action is not stateful @@ -824,24 +830,25 @@ g_variant_unref() when it is no longer required. the state range hint + line="10649">the state range hint a #GAction + line="10628">a #GAction Queries the type of the state of @action. + line="10654">Queries the type of the state of @action. If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the @@ -857,19 +864,22 @@ will return %NULL and you must not call g_action_change_state(). the state type, if the action is stateful + line="10671">the state type, if the action is stateful a #GAction + line="10656">a #GAction - + If @action is currently enabled. @@ -878,14 +888,20 @@ If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. - + The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GActionGroup. It is immutable. - + The type of the parameter that must be given when activating the @@ -893,13 +909,19 @@ action. This is immutable, and may be %NULL if no parameter is needed when activating the action. - + The state of the action, or %NULL if the action is stateless. - + The #GVariantType of the state that the action has, or %NULL if the @@ -1005,7 +1027,7 @@ See g_action_map_add_action_entries() for an example. glib:type-struct="ActionGroupInterface"> #GActionGroup represents a group of actions. Actions can be used to + line="4722">#GActionGroup represents a group of actions. Actions can be used to expose functionality in a structured way, either from one part of a program to another, or to the outside world. Action groups are often used together with a #GMenuModel that provides additional @@ -1056,7 +1078,7 @@ calls to g_action_group_query_action(). version="2.28"> Emits the #GActionGroup::action-added signal on @action_group. + line="10676">Emits the #GActionGroup::action-added signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1067,13 +1089,13 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10678">a #GActionGroup the name of an action in the group + line="10679">the name of an action in the group @@ -1083,7 +1105,7 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Emits the #GActionGroup::action-enabled-changed signal on @action_group. + line="10689">Emits the #GActionGroup::action-enabled-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1094,19 +1116,19 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10691">a #GActionGroup the name of an action in the group + line="10692">the name of an action in the group whether or not the action is now enabled + line="10693">whether or not the action is now enabled @@ -1116,7 +1138,7 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Emits the #GActionGroup::action-removed signal on @action_group. + line="10703">Emits the #GActionGroup::action-removed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1127,13 +1149,13 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10705">a #GActionGroup the name of an action in the group + line="10706">the name of an action in the group @@ -1143,7 +1165,7 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Emits the #GActionGroup::action-state-changed signal on @action_group. + line="10716">Emits the #GActionGroup::action-state-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1154,19 +1176,19 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10718">a #GActionGroup the name of an action in the group + line="10719">the name of an action in the group the new state of the named action + line="10720">the new state of the named action @@ -1176,12 +1198,39 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Activate the named action within @action_group. + line="10730">Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no parameters then @parameter must be %NULL. See -g_action_group_get_action_parameter_type(). +g_action_group_get_action_parameter_type(). + +If the #GActionGroup implementation supports asynchronous remote +activation over D-Bus, this call may return before the relevant +D-Bus traffic has been sent, or any replies have been received. In +order to block on such asynchronous activation calls, +g_dbus_connection_flush() should be called prior to the code, which +depends on the result of the action activation. Without flushing +the D-Bus connection, there is no guarantee that the action would +have been activated. + +The following code which runs in a remote app instance, shows an +example of a "quit" action being activated on the primary app +instance over D-Bus. Here g_dbus_connection_flush() is called +before `exit()`. Without g_dbus_connection_flush(), the "quit" action +may fail to be activated on the primary instance. + +|[<!-- language="C" --> +// call "quit" action on primary instance +g_action_group_activate_action (G_ACTION_GROUP (app), "quit", NULL); + +// make sure the action is activated now +g_dbus_connection_flush (...); + +g_debug ("application has been terminated. exiting."); + +exit (0); +]| @@ -1190,13 +1239,13 @@ g_action_group_get_action_parameter_type(). a #GActionGroup + line="10732">a #GActionGroup the name of the action to activate + line="10733">the name of the action to activate allow-none="1"> parameters to the activation + line="10734">parameters to the activation @@ -1215,7 +1264,7 @@ g_action_group_get_action_parameter_type(). version="2.28"> Request for the state of the named action within @action_group to be + line="10774">Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. @@ -1234,19 +1283,19 @@ If the @value GVariant is floating, it is consumed. a #GActionGroup + line="10776">a #GActionGroup the name of the action to request the change on + line="10777">the name of the action to request the change on the new state + line="10778">the new state @@ -1256,7 +1305,7 @@ If the @value GVariant is floating, it is consumed. version="2.28"> Checks if the named action within @action_group is currently enabled. + line="10796">Checks if the named action within @action_group is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. @@ -1264,20 +1313,20 @@ have its state changed from outside callers. whether or not the action is currently enabled + line="10806">whether or not the action is currently enabled a #GActionGroup + line="10798">a #GActionGroup the name of the action to query + line="10799">the name of the action to query @@ -1287,7 +1336,7 @@ have its state changed from outside callers. version="2.28"> Queries the type of the parameter that must be given when activating + line="10811">Queries the type of the parameter that must be given when activating the named action within @action_group. When activating the action using g_action_group_activate_action(), @@ -1304,20 +1353,20 @@ with the same name but a different parameter type. the parameter type + line="10830">the parameter type a #GActionGroup + line="10813">a #GActionGroup the name of the action to query + line="10814">the name of the action to query @@ -1327,7 +1376,7 @@ with the same name but a different parameter type. version="2.28"> Queries the current state of the named action within @action_group. + line="10835">Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -1339,20 +1388,20 @@ g_variant_unref() when it is no longer required. the current state of the action + line="10849">the current state of the action a #GActionGroup + line="10837">a #GActionGroup the name of the action to query + line="10838">the name of the action to query @@ -1362,7 +1411,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Requests a hint about the valid range of values for the state of the + line="10854">Requests a hint about the valid range of values for the state of the named action within @action_group. If %NULL is returned it either means that the action is not stateful @@ -1384,20 +1433,20 @@ g_variant_unref() when it is no longer required. the state range hint + line="10878">the state range hint a #GActionGroup + line="10856">a #GActionGroup the name of the action to query + line="10857">the name of the action to query @@ -1407,7 +1456,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Queries the type of the state of the named action within + line="10883">Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the @@ -1427,20 +1476,20 @@ with the same name but a different state type. the state type, if the action is stateful + line="10905">the state type, if the action is stateful a #GActionGroup + line="10885">a #GActionGroup the name of the action to query + line="10886">the name of the action to query @@ -1448,25 +1497,25 @@ with the same name but a different state type. Checks if the named action exists within @action_group. + line="10910">Checks if the named action exists within @action_group. whether the named action exists + line="10917">whether the named action exists a #GActionGroup + line="10912">a #GActionGroup the name of the action to check for + line="10913">the name of the action to check for @@ -1476,7 +1525,7 @@ with the same name but a different state type. version="2.28"> Lists the actions contained within @action_group. + line="10922">Lists the actions contained within @action_group. The caller is responsible for freeing the list with g_strfreev() when it is no longer required. @@ -1484,7 +1533,7 @@ it is no longer required. a %NULL-terminated array of the names of the + line="10931">a %NULL-terminated array of the names of the actions in the group @@ -1494,7 +1543,7 @@ actions in the group a #GActionGroup + line="10924">a #GActionGroup @@ -1504,7 +1553,7 @@ actions in the group version="2.32"> Queries all aspects of the named action within an @action_group. + line="10937">Queries all aspects of the named action within an @action_group. This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), @@ -1535,20 +1584,20 @@ fields may or may not have been modified. %TRUE if the action exists, else %FALSE + line="10975">%TRUE if the action exists, else %FALSE a #GActionGroup + line="10939">a #GActionGroup the name of an action in the group + line="10940">the name of an action in the group transfer-ownership="full"> if the action is presently enabled + line="10941">if the action is presently enabled allow-none="1"> the parameter type, or %NULL if none needed + line="10942">the parameter type, or %NULL if none needed allow-none="1"> the state type, or %NULL if stateless + line="10943">the state type, or %NULL if stateless allow-none="1"> the state hint, or %NULL if none + line="10944">the state hint, or %NULL if none allow-none="1"> the current state, or %NULL if stateless + line="10945">the current state, or %NULL if stateless @@ -1611,7 +1660,7 @@ fields may or may not have been modified. version="2.28"> Emits the #GActionGroup::action-added signal on @action_group. + line="10676">Emits the #GActionGroup::action-added signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1622,13 +1671,13 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10678">a #GActionGroup the name of an action in the group + line="10679">the name of an action in the group @@ -1638,7 +1687,7 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Emits the #GActionGroup::action-enabled-changed signal on @action_group. + line="10689">Emits the #GActionGroup::action-enabled-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1649,19 +1698,19 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10691">a #GActionGroup the name of an action in the group + line="10692">the name of an action in the group whether or not the action is now enabled + line="10693">whether or not the action is now enabled @@ -1671,7 +1720,7 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Emits the #GActionGroup::action-removed signal on @action_group. + line="10703">Emits the #GActionGroup::action-removed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1682,13 +1731,13 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10705">a #GActionGroup the name of an action in the group + line="10706">the name of an action in the group @@ -1698,7 +1747,7 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Emits the #GActionGroup::action-state-changed signal on @action_group. + line="10716">Emits the #GActionGroup::action-state-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1709,19 +1758,19 @@ This function should only be called by #GActionGroup implementations. a #GActionGroup + line="10718">a #GActionGroup the name of an action in the group + line="10719">the name of an action in the group the new state of the named action + line="10720">the new state of the named action @@ -1731,12 +1780,39 @@ This function should only be called by #GActionGroup implementations. version="2.28"> Activate the named action within @action_group. + line="10730">Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no parameters then @parameter must be %NULL. See -g_action_group_get_action_parameter_type(). +g_action_group_get_action_parameter_type(). + +If the #GActionGroup implementation supports asynchronous remote +activation over D-Bus, this call may return before the relevant +D-Bus traffic has been sent, or any replies have been received. In +order to block on such asynchronous activation calls, +g_dbus_connection_flush() should be called prior to the code, which +depends on the result of the action activation. Without flushing +the D-Bus connection, there is no guarantee that the action would +have been activated. + +The following code which runs in a remote app instance, shows an +example of a "quit" action being activated on the primary app +instance over D-Bus. Here g_dbus_connection_flush() is called +before `exit()`. Without g_dbus_connection_flush(), the "quit" action +may fail to be activated on the primary instance. + +|[<!-- language="C" --> +// call "quit" action on primary instance +g_action_group_activate_action (G_ACTION_GROUP (app), "quit", NULL); + +// make sure the action is activated now +g_dbus_connection_flush (...); + +g_debug ("application has been terminated. exiting."); + +exit (0); +]| @@ -1745,13 +1821,13 @@ g_action_group_get_action_parameter_type(). a #GActionGroup + line="10732">a #GActionGroup the name of the action to activate + line="10733">the name of the action to activate allow-none="1"> parameters to the activation + line="10734">parameters to the activation @@ -1770,7 +1846,7 @@ g_action_group_get_action_parameter_type(). version="2.28"> Request for the state of the named action within @action_group to be + line="10774">Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. @@ -1789,19 +1865,19 @@ If the @value GVariant is floating, it is consumed. a #GActionGroup + line="10776">a #GActionGroup the name of the action to request the change on + line="10777">the name of the action to request the change on the new state + line="10778">the new state @@ -1811,7 +1887,7 @@ If the @value GVariant is floating, it is consumed. version="2.28"> Checks if the named action within @action_group is currently enabled. + line="10796">Checks if the named action within @action_group is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. @@ -1819,20 +1895,20 @@ have its state changed from outside callers. whether or not the action is currently enabled + line="10806">whether or not the action is currently enabled a #GActionGroup + line="10798">a #GActionGroup the name of the action to query + line="10799">the name of the action to query @@ -1842,7 +1918,7 @@ have its state changed from outside callers. version="2.28"> Queries the type of the parameter that must be given when activating + line="10811">Queries the type of the parameter that must be given when activating the named action within @action_group. When activating the action using g_action_group_activate_action(), @@ -1859,20 +1935,20 @@ with the same name but a different parameter type. the parameter type + line="10830">the parameter type a #GActionGroup + line="10813">a #GActionGroup the name of the action to query + line="10814">the name of the action to query @@ -1882,7 +1958,7 @@ with the same name but a different parameter type. version="2.28"> Queries the current state of the named action within @action_group. + line="10835">Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -1894,20 +1970,20 @@ g_variant_unref() when it is no longer required. the current state of the action + line="10849">the current state of the action a #GActionGroup + line="10837">a #GActionGroup the name of the action to query + line="10838">the name of the action to query @@ -1917,7 +1993,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Requests a hint about the valid range of values for the state of the + line="10854">Requests a hint about the valid range of values for the state of the named action within @action_group. If %NULL is returned it either means that the action is not stateful @@ -1939,20 +2015,20 @@ g_variant_unref() when it is no longer required. the state range hint + line="10878">the state range hint a #GActionGroup + line="10856">a #GActionGroup the name of the action to query + line="10857">the name of the action to query @@ -1962,7 +2038,7 @@ g_variant_unref() when it is no longer required. version="2.28"> Queries the type of the state of the named action within + line="10883">Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the @@ -1982,20 +2058,20 @@ with the same name but a different state type. the state type, if the action is stateful + line="10905">the state type, if the action is stateful a #GActionGroup + line="10885">a #GActionGroup the name of the action to query + line="10886">the name of the action to query @@ -2005,25 +2081,25 @@ with the same name but a different state type. version="2.28"> Checks if the named action exists within @action_group. + line="10910">Checks if the named action exists within @action_group. whether the named action exists + line="10917">whether the named action exists a #GActionGroup + line="10912">a #GActionGroup the name of the action to check for + line="10913">the name of the action to check for @@ -2033,7 +2109,7 @@ with the same name but a different state type. version="2.28"> Lists the actions contained within @action_group. + line="10922">Lists the actions contained within @action_group. The caller is responsible for freeing the list with g_strfreev() when it is no longer required. @@ -2041,7 +2117,7 @@ it is no longer required. a %NULL-terminated array of the names of the + line="10931">a %NULL-terminated array of the names of the actions in the group @@ -2051,7 +2127,7 @@ actions in the group a #GActionGroup + line="10924">a #GActionGroup @@ -2061,7 +2137,7 @@ actions in the group version="2.32"> Queries all aspects of the named action within an @action_group. + line="10937">Queries all aspects of the named action within an @action_group. This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), @@ -2092,20 +2168,20 @@ fields may or may not have been modified. %TRUE if the action exists, else %FALSE + line="10975">%TRUE if the action exists, else %FALSE a #GActionGroup + line="10939">a #GActionGroup the name of an action in the group + line="10940">the name of an action in the group transfer-ownership="full"> if the action is presently enabled + line="10941">if the action is presently enabled allow-none="1"> the parameter type, or %NULL if none needed + line="10942">the parameter type, or %NULL if none needed allow-none="1"> the state type, or %NULL if stateless + line="10943">the state type, or %NULL if stateless allow-none="1"> the state hint, or %NULL if none + line="10944">the state hint, or %NULL if none allow-none="1"> the current state, or %NULL if stateless + line="10945">the current state, or %NULL if stateless @@ -2270,20 +2346,20 @@ is still visible and can be queried from the signal handler. whether the named action exists + line="10917">whether the named action exists a #GActionGroup + line="10912">a #GActionGroup the name of the action to check for + line="10913">the name of the action to check for @@ -2295,7 +2371,7 @@ is still visible and can be queried from the signal handler. a %NULL-terminated array of the names of the + line="10931">a %NULL-terminated array of the names of the actions in the group @@ -2305,7 +2381,7 @@ actions in the group a #GActionGroup + line="10924">a #GActionGroup @@ -2317,20 +2393,20 @@ actions in the group whether or not the action is currently enabled + line="10806">whether or not the action is currently enabled a #GActionGroup + line="10798">a #GActionGroup the name of the action to query + line="10799">the name of the action to query @@ -2342,20 +2418,20 @@ actions in the group the parameter type + line="10830">the parameter type a #GActionGroup + line="10813">a #GActionGroup the name of the action to query + line="10814">the name of the action to query @@ -2367,20 +2443,20 @@ actions in the group the state type, if the action is stateful + line="10905">the state type, if the action is stateful a #GActionGroup + line="10885">a #GActionGroup the name of the action to query + line="10886">the name of the action to query @@ -2392,20 +2468,20 @@ actions in the group the state range hint + line="10878">the state range hint a #GActionGroup + line="10856">a #GActionGroup the name of the action to query + line="10857">the name of the action to query @@ -2417,20 +2493,20 @@ actions in the group the current state of the action + line="10849">the current state of the action a #GActionGroup + line="10837">a #GActionGroup the name of the action to query + line="10838">the name of the action to query @@ -2446,19 +2522,19 @@ actions in the group a #GActionGroup + line="10776">a #GActionGroup the name of the action to request the change on + line="10777">the name of the action to request the change on the new state + line="10778">the new state @@ -2474,13 +2550,13 @@ actions in the group a #GActionGroup + line="10732">a #GActionGroup the name of the action to activate + line="10733">the name of the action to activate allow-none="1"> parameters to the activation + line="10734">parameters to the activation @@ -2505,13 +2581,13 @@ actions in the group a #GActionGroup + line="10678">a #GActionGroup the name of an action in the group + line="10679">the name of an action in the group @@ -2527,13 +2603,13 @@ actions in the group a #GActionGroup + line="10705">a #GActionGroup the name of an action in the group + line="10706">the name of an action in the group @@ -2549,19 +2625,19 @@ actions in the group a #GActionGroup + line="10691">a #GActionGroup the name of an action in the group + line="10692">the name of an action in the group whether or not the action is now enabled + line="10693">whether or not the action is now enabled @@ -2577,19 +2653,19 @@ actions in the group a #GActionGroup + line="10718">a #GActionGroup the name of an action in the group + line="10719">the name of an action in the group the new state of the named action + line="10720">the new state of the named action @@ -2601,20 +2677,20 @@ actions in the group %TRUE if the action exists, else %FALSE + line="10975">%TRUE if the action exists, else %FALSE a #GActionGroup + line="10939">a #GActionGroup the name of an action in the group + line="10940">the name of an action in the group transfer-ownership="full"> if the action is presently enabled + line="10941">if the action is presently enabled allow-none="1"> the parameter type, or %NULL if none needed + line="10942">the parameter type, or %NULL if none needed allow-none="1"> the state type, or %NULL if stateless + line="10943">the state type, or %NULL if stateless allow-none="1"> the state hint, or %NULL if none + line="10944">the state hint, or %NULL if none allow-none="1"> the current state, or %NULL if stateless + line="10945">the current state, or %NULL if stateless @@ -2691,14 +2767,14 @@ actions in the group the name of the action + line="10585">the name of the action a #GAction + line="10581">a #GAction @@ -2710,14 +2786,14 @@ actions in the group the parameter type + line="10603">the parameter type a #GAction + line="10592">a #GAction @@ -2729,14 +2805,14 @@ actions in the group the state type, if the action is stateful + line="10671">the state type, if the action is stateful a #GAction + line="10656">a #GAction @@ -2748,14 +2824,14 @@ actions in the group the state range hint + line="10649">the state range hint a #GAction + line="10628">a #GAction @@ -2767,14 +2843,14 @@ actions in the group whether the action is enabled + line="10574">whether the action is enabled a #GAction + line="10567">a #GAction @@ -2783,17 +2859,17 @@ actions in the group - + the current state of the action + line="10621">the current state of the action a #GAction + line="10610">a #GAction @@ -2809,13 +2885,13 @@ actions in the group a #GAction + line="10547">a #GAction the new state + line="10548">the new state @@ -2831,7 +2907,7 @@ actions in the group a #GAction + line="10530">a #GAction allow-none="1"> the parameter to the activation + line="10531">the parameter to the activation @@ -2856,7 +2932,7 @@ actions in the group glib:type-struct="ActionMapInterface"> The GActionMap interface is implemented by #GActionGroup + line="4793">The GActionMap interface is implemented by #GActionGroup implementations that operate by containing a number of named #GAction instances, such as #GSimpleActionGroup. @@ -2869,7 +2945,7 @@ name. Adds an action to the @action_map. + line="10980">Adds an action to the @action_map. If the action map already contains an action with the same name as @action then the old action is dropped from the action map. @@ -2883,13 +2959,13 @@ The action map takes its own reference on @action. a #GActionMap + line="10982">a #GActionMap a #GAction + line="10983">a #GAction @@ -2899,27 +2975,27 @@ The action map takes its own reference on @action. version="2.32"> Looks up the action with the name @action_name in @action_map. + line="11046">Looks up the action with the name @action_name in @action_map. If no such action exists, returns %NULL. - + a #GAction, or %NULL + line="11055">a #GAction, or %NULL a #GActionMap + line="11048">a #GActionMap the name of an action + line="11049">the name of an action @@ -2929,7 +3005,7 @@ If no such action exists, returns %NULL. version="2.32"> Removes the named action from the action map. + line="11060">Removes the named action from the action map. If no action of this name is in the map then nothing happens. @@ -2940,13 +3016,13 @@ If no action of this name is in the map then nothing happens. a #GActionMap + line="11062">a #GActionMap the name of the action + line="11063">the name of the action @@ -2956,7 +3032,7 @@ If no action of this name is in the map then nothing happens. version="2.32"> Adds an action to the @action_map. + line="10980">Adds an action to the @action_map. If the action map already contains an action with the same name as @action then the old action is dropped from the action map. @@ -2970,13 +3046,13 @@ The action map takes its own reference on @action. a #GActionMap + line="10982">a #GActionMap a #GAction + line="10983">a #GAction @@ -2986,7 +3062,7 @@ The action map takes its own reference on @action. version="2.32"> A convenience function for creating multiple #GSimpleAction instances + line="10996">A convenience function for creating multiple #GSimpleAction instances and adding them to a #GActionMap. Each action is constructed as per one #GActionEntry. @@ -3031,13 +3107,13 @@ create_action_group (void) a #GActionMap + line="10998">a #GActionMap a pointer to + line="10999">a pointer to the first item in an array of #GActionEntry structs @@ -3046,7 +3122,7 @@ create_action_group (void) the length of @entries, or -1 if @entries is %NULL-terminated + line="11001">the length of @entries, or -1 if @entries is %NULL-terminated the user data for signal connections + line="11002">the user data for signal connections @@ -3065,27 +3141,27 @@ create_action_group (void) version="2.32"> Looks up the action with the name @action_name in @action_map. + line="11046">Looks up the action with the name @action_name in @action_map. If no such action exists, returns %NULL. - + a #GAction, or %NULL + line="11055">a #GAction, or %NULL a #GActionMap + line="11048">a #GActionMap the name of an action + line="11049">the name of an action @@ -3095,7 +3171,7 @@ If no such action exists, returns %NULL. version="2.32"> Removes the named action from the action map. + line="11060">Removes the named action from the action map. If no action of this name is in the map then nothing happens. @@ -3106,13 +3182,13 @@ If no action of this name is in the map then nothing happens. a #GActionMap + line="11062">a #GActionMap the name of the action + line="11063">the name of the action @@ -3132,23 +3208,23 @@ If no action of this name is in the map then nothing happens. - + a #GAction, or %NULL + line="11055">a #GAction, or %NULL a #GActionMap + line="11048">a #GActionMap the name of an action + line="11049">the name of an action @@ -3164,13 +3240,13 @@ If no action of this name is in the map then nothing happens. a #GActionMap + line="10982">a #GActionMap a #GAction + line="10983">a #GAction @@ -3186,13 +3262,13 @@ If no action of this name is in the map then nothing happens. a #GActionMap + line="11062">a #GActionMap the name of the action + line="11063">the name of the action @@ -3207,7 +3283,7 @@ If no action of this name is in the map then nothing happens. glib:type-struct="AppInfoIface"> #GAppInfo and #GAppLaunchContext are used for describing and launching + line="4813">#GAppInfo and #GAppLaunchContext are used for describing and launching applications installed on the system. As of GLib 2.20, URIs will always be converted to POSIX paths @@ -3261,7 +3337,7 @@ different ideas of what a given URI means. throws="1"> Creates a new #GAppInfo from the given information. + line="11184">Creates a new #GAppInfo from the given information. Note that for @commandline, the quoting rules of the Exec key of the [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) @@ -3272,14 +3348,14 @@ being swallowed by Exec key unquoting. See the specification for exact quoting r new #GAppInfo for given command. + line="11199">new #GAppInfo for given command. the commandline to use + line="11186">the commandline to use the application name, or %NULL to use @commandline + line="11187">the application name, or %NULL to use @commandline flags that can specify details of the created #GAppInfo + line="11188">flags that can specify details of the created #GAppInfo @@ -3302,7 +3378,7 @@ being swallowed by Exec key unquoting. See the specification for exact quoting r Gets a list of all of the applications currently registered + line="11243">Gets a list of all of the applications currently registered on this system. For desktop files, this includes applications that have @@ -3314,7 +3390,7 @@ the `Hidden` key set. a newly allocated #GList of references to #GAppInfos. + line="11255">a newly allocated #GList of references to #GAppInfos. @@ -3324,7 +3400,7 @@ the `Hidden` key set. c:identifier="g_app_info_get_all_for_type"> Gets a list of all #GAppInfos for a given content type, + line="11259">Gets a list of all #GAppInfos for a given content type, including the recommended and fallback #GAppInfos. See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type(). @@ -3332,7 +3408,7 @@ g_app_info_get_fallback_for_type(). #GList of #GAppInfos + line="11268">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -3342,7 +3418,7 @@ g_app_info_get_fallback_for_type(). the content type to find a #GAppInfo for + line="11261">the content type to find a #GAppInfo for @@ -3351,12 +3427,12 @@ g_app_info_get_fallback_for_type(). c:identifier="g_app_info_get_default_for_type"> Gets the default #GAppInfo for a given content type. + line="11286">Gets the default #GAppInfo for a given content type. #GAppInfo for given @content_type or + line="11294">#GAppInfo for given @content_type or %NULL on error. @@ -3364,13 +3440,13 @@ g_app_info_get_fallback_for_type(). the content type to find a #GAppInfo for + line="11288">the content type to find a #GAppInfo for if %TRUE, the #GAppInfo is expected to + line="11289">if %TRUE, the #GAppInfo is expected to support URIs @@ -3380,7 +3456,7 @@ g_app_info_get_fallback_for_type(). c:identifier="g_app_info_get_default_for_uri_scheme"> Gets the default application for handling URIs with + line="11299">Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". @@ -3388,7 +3464,7 @@ of the URI, up to but not including the ':', e.g. "http", #GAppInfo for given @uri_scheme or + line="11308">#GAppInfo for given @uri_scheme or %NULL on error. @@ -3396,7 +3472,7 @@ of the URI, up to but not including the ':', e.g. "http", a string containing a URI scheme. + line="11301">a string containing a URI scheme. @@ -3406,14 +3482,14 @@ of the URI, up to but not including the ':', e.g. "http", version="2.28"> Gets a list of fallback #GAppInfos for a given content type, i.e. + line="11348">Gets a list of fallback #GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly. #GList of #GAppInfos + line="11356">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -3423,7 +3499,7 @@ by MIME type subclassing and not directly. the content type to find a #GAppInfo for + line="11350">the content type to find a #GAppInfo for @@ -3433,7 +3509,7 @@ by MIME type subclassing and not directly. version="2.28"> Gets a list of recommended #GAppInfos for a given content type, i.e. + line="11399">Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. @@ -3443,7 +3519,7 @@ called. #GList of #GAppInfos + line="11410">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -3453,7 +3529,7 @@ called. the content type to find a #GAppInfo for + line="11401">the content type to find a #GAppInfo for @@ -3463,7 +3539,7 @@ called. throws="1"> Utility function that launches the default application + line="11472">Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required. @@ -3475,14 +3551,14 @@ g_app_info_launch_default_for_uri_async() instead. %TRUE on success, %FALSE on error. + line="11487">%TRUE on success, %FALSE on error. the uri to show + line="11474">the uri to show allow-none="1"> an optional #GAppLaunchContext + line="11475">an optional #GAppLaunchContext @@ -3501,7 +3577,7 @@ g_app_info_launch_default_for_uri_async() instead. version="2.50"> Async version of g_app_info_launch_default_for_uri(). + line="11491">Async version of g_app_info_launch_default_for_uri(). This version is useful if you are interested in receiving error information in the case where the application is @@ -3519,7 +3595,7 @@ in receiving error information from their activation. the uri to show + line="11493">the uri to show allow-none="1"> an optional #GAppLaunchContext + line="11494">an optional #GAppLaunchContext allow-none="1"> a #GCancellable + line="11495">a #GCancellable closure="4"> a #GAsyncReadyCallback to call when the request is done + line="11496">a #GAsyncReadyCallback to call when the request is done allow-none="1"> data to pass to @callback + line="11497">data to pass to @callback @@ -3568,19 +3644,19 @@ in receiving error information from their activation. throws="1"> Finishes an asynchronous launch-default-for-uri operation. + line="11514">Finishes an asynchronous launch-default-for-uri operation. %TRUE if the launch was successful, %FALSE if @error is set + line="11521">%TRUE if the launch was successful, %FALSE if @error is set a #GAsyncResult + line="11516">a #GAsyncResult @@ -3590,7 +3666,7 @@ in receiving error information from their activation. version="2.20"> Removes all changes to the type associations done by + line="11611">Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or @@ -3603,7 +3679,7 @@ g_app_info_remove_supports_type(). a content type + line="11613">a content type @@ -3613,26 +3689,26 @@ g_app_info_remove_supports_type(). throws="1"> Adds a content type to the application information to indicate the + line="11148">Adds a content type to the application information to indicate the application is capable of opening files with the given content type. %TRUE on success, %FALSE on error. + line="11157">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11150">a #GAppInfo. a string. + line="11151">a string. @@ -3640,20 +3716,20 @@ application is capable of opening files with the given content type. Obtains the information whether the #GAppInfo can be deleted. + line="11161">Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). %TRUE if @appinfo can be deleted + line="11168">%TRUE if @appinfo can be deleted a #GAppInfo + line="11163">a #GAppInfo @@ -3662,12 +3738,12 @@ See g_app_info_delete(). invoker="can_remove_supports_type"> Checks if a supported content type can be removed from an application. + line="11173">Checks if a supported content type can be removed from an application. %TRUE if it is possible to remove supported + line="11179">%TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. @@ -3675,7 +3751,7 @@ See g_app_info_delete(). a #GAppInfo. + line="11175">a #GAppInfo. @@ -3683,7 +3759,7 @@ See g_app_info_delete(). Tries to delete a #GAppInfo. + line="11203">Tries to delete a #GAppInfo. On some platforms, there may be a difference between user-defined #GAppInfos which can be deleted, and system-wide ones which cannot. @@ -3692,14 +3768,14 @@ See g_app_info_can_delete(). %TRUE if @appinfo has been deleted + line="11213">%TRUE if @appinfo has been deleted a #GAppInfo + line="11205">a #GAppInfo @@ -3707,19 +3783,19 @@ See g_app_info_can_delete(). Creates a duplicate of a #GAppInfo. + line="11218">Creates a duplicate of a #GAppInfo. a duplicate of @appinfo. + line="11224">a duplicate of @appinfo. a #GAppInfo. + line="11220">a #GAppInfo. @@ -3727,40 +3803,53 @@ See g_app_info_can_delete(). Checks if two #GAppInfos are equal. + line="11228">Checks if two #GAppInfos are equal. -Note that the check <emphasis>may not</emphasis> compare each individual +Note that the check *may not* compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields. %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + line="11239">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. the first #GAppInfo. + line="11230">the first #GAppInfo. the second #GAppInfo. + line="11231">the second #GAppInfo. - + + Gets the commandline with which the application will be +started. - - + + a string containing the @appinfo's commandline, + or %NULL if this information is not available + + a #GAppInfo @@ -3768,12 +3857,12 @@ contents is needed, program code must additionally compare relevant fields. Gets a human-readable description of an installed application. + line="11313">Gets a human-readable description of an installed application. - + a string containing a description of the + line="11319">a string containing a description of the application @appinfo, or %NULL if none. @@ -3781,7 +3870,7 @@ application @appinfo, or %NULL if none. a #GAppInfo. + line="11315">a #GAppInfo. @@ -3791,13 +3880,13 @@ application @appinfo, or %NULL if none. version="2.24"> Gets the display name of the application. The display name is often more + line="11324">Gets the display name of the application. The display name is often more descriptive to the user than the name itself. the display name of the application for @appinfo, or the name if + line="11331">the display name of the application for @appinfo, or the name if no display name is available. @@ -3805,18 +3894,28 @@ no display name is available. a #GAppInfo. + line="11326">a #GAppInfo. - + + Gets the executable's name for the installed application. - + a string containing the @appinfo's application +binaries name + + a #GAppInfo @@ -3824,12 +3923,12 @@ no display name is available. Gets the icon for the application. + line="11362">Gets the icon for the application. - + the default #GIcon for @appinfo or %NULL + line="11368">the default #GIcon for @appinfo or %NULL if there is no default icon. @@ -3837,7 +3936,7 @@ if there is no default icon. a #GAppInfo. + line="11364">a #GAppInfo. @@ -3845,7 +3944,7 @@ if there is no default icon. Gets the ID of an application. An id is a string that + line="11373">Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification. @@ -3853,17 +3952,17 @@ desktop file id from the xdg menu specification. Note that the returned ID may be %NULL, depending on how the @appinfo has been constructed. - + a string containing the application's ID. + line="11385">a string containing the application's ID. a #GAppInfo. + line="11375">a #GAppInfo. @@ -3871,19 +3970,19 @@ the @appinfo has been constructed. Gets the installed name of the application. + line="11389">Gets the installed name of the application. the name of the application for @appinfo. + line="11395">the name of the application for @appinfo. a #GAppInfo. + line="11391">a #GAppInfo. @@ -3893,7 +3992,7 @@ the @appinfo has been constructed. version="2.34"> Retrieves the list of content types that @app_info claims to support. + line="11416">Retrieves the list of content types that @app_info claims to support. If this information is not provided by the environment, this function will return %NULL. This function does not take in consideration associations added with @@ -3903,7 +4002,7 @@ the application. + line="11427"> a list of content types. @@ -3913,7 +4012,7 @@ the application. a #GAppInfo that can handle files + line="11418">a #GAppInfo that can handle files @@ -3921,7 +4020,7 @@ the application. Launches the application. Passes @files to the launched application + line="11433">Launches the application. Passes @files to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -3952,14 +4051,14 @@ on information provided in @context. %TRUE on successful launch, %FALSE otherwise. + line="11468">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11435">a #GAppInfo allow-none="1"> a #GList of #GFile objects + line="11436">a #GList of #GFile objects @@ -3979,7 +4078,7 @@ on information provided in @context. allow-none="1"> a #GAppLaunchContext or %NULL + line="11437">a #GAppLaunchContext or %NULL @@ -3987,7 +4086,7 @@ on information provided in @context. Launches the application. This passes the @uris to the launched application + line="11526">Launches the application. This passes the @uris to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -4001,14 +4100,14 @@ no way to detect this. %TRUE on successful launch, %FALSE otherwise. + line="11544">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11528">a #GAppInfo allow-none="1"> a #GList containing URIs to launch. + line="11529">a #GList containing URIs to launch. @@ -4028,7 +4127,7 @@ no way to detect this. allow-none="1"> a #GAppLaunchContext or %NULL + line="11530">a #GAppLaunchContext or %NULL @@ -4038,7 +4137,7 @@ no way to detect this. version="2.60"> Async version of g_app_info_launch_uris(). + line="11548">Async version of g_app_info_launch_uris(). The @callback is invoked immediately after the application launch, but it waits for activation in case of D-Bus–activated applications and also provides @@ -4052,7 +4151,7 @@ g_app_info_launch_default_for_uri_async(). a #GAppInfo + line="11550">a #GAppInfo allow-none="1"> a #GList containing URIs to launch. + line="11551">a #GList containing URIs to launch. @@ -4072,7 +4171,7 @@ g_app_info_launch_default_for_uri_async(). allow-none="1"> a #GAppLaunchContext or %NULL + line="11552">a #GAppLaunchContext or %NULL allow-none="1"> a #GCancellable + line="11553">a #GCancellable closure="4"> a #GAsyncReadyCallback to call when the request is done + line="11554">a #GAsyncReadyCallback to call when the request is done closure="4"> data to pass to @callback + line="11555">data to pass to @callback @@ -4113,25 +4212,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Finishes a g_app_info_launch_uris_async() operation. + line="11568">Finishes a g_app_info_launch_uris_async() operation. %TRUE on successful launch, %FALSE otherwise. + line="11576">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11570">a #GAppInfo a #GAsyncResult + line="11571">a #GAsyncResult @@ -4141,25 +4240,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Removes a supported type from an application, if possible. + line="11599">Removes a supported type from an application, if possible. %TRUE on success, %FALSE on error. + line="11607">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11601">a #GAppInfo. a string. + line="11602">a string. @@ -4169,25 +4268,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Sets the application as the default handler for the given file extension. + line="11625">Sets the application as the default handler for the given file extension. %TRUE on success, %FALSE on error. + line="11634">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11627">a #GAppInfo. a string containing the file extension + line="11628">a string containing the file extension (without the dot). @@ -4198,25 +4297,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Sets the application as the default handler for a given type. + line="11638">Sets the application as the default handler for a given type. %TRUE on success, %FALSE on error. + line="11646">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11640">a #GAppInfo. the content type. + line="11641">the content type. @@ -4226,7 +4325,7 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Sets the application as the last used application for a given type. + line="11650">Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by g_app_info_get_recommended_for_type(), regardless of the default application for that content type. @@ -4234,20 +4333,20 @@ application for that content type. %TRUE on success, %FALSE on error. + line="11661">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11652">a #GAppInfo. the content type. + line="11653">the content type. @@ -4255,20 +4354,20 @@ application for that content type. Checks if the application info should be shown in menus that + line="11665">Checks if the application info should be shown in menus that list available applications. %TRUE if the @appinfo should be shown, %FALSE otherwise. + line="11672">%TRUE if the @appinfo should be shown, %FALSE otherwise. a #GAppInfo. + line="11667">a #GAppInfo. @@ -4276,19 +4375,19 @@ list available applications. Checks if the application accepts files as arguments. + line="11676">Checks if the application accepts files as arguments. %TRUE if the @appinfo supports files. + line="11682">%TRUE if the @appinfo supports files. a #GAppInfo. + line="11678">a #GAppInfo. @@ -4296,19 +4395,19 @@ list available applications. Checks if the application supports reading files and directories from URIs. + line="11686">Checks if the application supports reading files and directories from URIs. %TRUE if the @appinfo supports URIs. + line="11692">%TRUE if the @appinfo supports URIs. a #GAppInfo. + line="11688">a #GAppInfo. @@ -4318,26 +4417,26 @@ list available applications. throws="1"> Adds a content type to the application information to indicate the + line="11148">Adds a content type to the application information to indicate the application is capable of opening files with the given content type. %TRUE on success, %FALSE on error. + line="11157">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11150">a #GAppInfo. a string. + line="11151">a string. @@ -4347,20 +4446,20 @@ application is capable of opening files with the given content type. version="2.20"> Obtains the information whether the #GAppInfo can be deleted. + line="11161">Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). %TRUE if @appinfo can be deleted + line="11168">%TRUE if @appinfo can be deleted a #GAppInfo + line="11163">a #GAppInfo @@ -4369,12 +4468,12 @@ See g_app_info_delete(). c:identifier="g_app_info_can_remove_supports_type"> Checks if a supported content type can be removed from an application. + line="11173">Checks if a supported content type can be removed from an application. %TRUE if it is possible to remove supported + line="11179">%TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. @@ -4382,7 +4481,7 @@ See g_app_info_delete(). a #GAppInfo. + line="11175">a #GAppInfo. @@ -4390,7 +4489,7 @@ See g_app_info_delete(). Tries to delete a #GAppInfo. + line="11203">Tries to delete a #GAppInfo. On some platforms, there may be a difference between user-defined #GAppInfos which can be deleted, and system-wide ones which cannot. @@ -4399,14 +4498,14 @@ See g_app_info_can_delete(). %TRUE if @appinfo has been deleted + line="11213">%TRUE if @appinfo has been deleted a #GAppInfo + line="11205">a #GAppInfo @@ -4414,19 +4513,19 @@ See g_app_info_can_delete(). Creates a duplicate of a #GAppInfo. + line="11218">Creates a duplicate of a #GAppInfo. a duplicate of @appinfo. + line="11224">a duplicate of @appinfo. a #GAppInfo. + line="11220">a #GAppInfo. @@ -4434,29 +4533,29 @@ See g_app_info_can_delete(). Checks if two #GAppInfos are equal. + line="11228">Checks if two #GAppInfos are equal. -Note that the check <emphasis>may not</emphasis> compare each individual +Note that the check *may not* compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields. %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + line="11239">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. the first #GAppInfo. + line="11230">the first #GAppInfo. the second #GAppInfo. + line="11231">the second #GAppInfo. @@ -4466,13 +4565,13 @@ contents is needed, program code must additionally compare relevant fields. Gets the commandline with which the application will be + line="11273">Gets the commandline with which the application will be started. - + a string containing the @appinfo's commandline, + line="11280">a string containing the @appinfo's commandline, or %NULL if this information is not available @@ -4480,7 +4579,7 @@ started. a #GAppInfo + line="11275">a #GAppInfo @@ -4488,12 +4587,12 @@ started. Gets a human-readable description of an installed application. + line="11313">Gets a human-readable description of an installed application. - + a string containing a description of the + line="11319">a string containing a description of the application @appinfo, or %NULL if none. @@ -4501,7 +4600,7 @@ application @appinfo, or %NULL if none. a #GAppInfo. + line="11315">a #GAppInfo. @@ -4511,13 +4610,13 @@ application @appinfo, or %NULL if none. version="2.24"> Gets the display name of the application. The display name is often more + line="11324">Gets the display name of the application. The display name is often more descriptive to the user than the name itself. the display name of the application for @appinfo, or the name if + line="11331">the display name of the application for @appinfo, or the name if no display name is available. @@ -4525,7 +4624,7 @@ no display name is available. a #GAppInfo. + line="11326">a #GAppInfo. @@ -4533,12 +4632,12 @@ no display name is available. Gets the executable's name for the installed application. + line="11337">Gets the executable's name for the installed application. a string containing the @appinfo's application + line="11343">a string containing the @appinfo's application binaries name @@ -4546,7 +4645,7 @@ binaries name a #GAppInfo + line="11339">a #GAppInfo @@ -4554,12 +4653,12 @@ binaries name Gets the icon for the application. + line="11362">Gets the icon for the application. - + the default #GIcon for @appinfo or %NULL + line="11368">the default #GIcon for @appinfo or %NULL if there is no default icon. @@ -4567,7 +4666,7 @@ if there is no default icon. a #GAppInfo. + line="11364">a #GAppInfo. @@ -4575,7 +4674,7 @@ if there is no default icon. Gets the ID of an application. An id is a string that + line="11373">Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification. @@ -4583,17 +4682,17 @@ desktop file id from the xdg menu specification. Note that the returned ID may be %NULL, depending on how the @appinfo has been constructed. - + a string containing the application's ID. + line="11385">a string containing the application's ID. a #GAppInfo. + line="11375">a #GAppInfo. @@ -4601,19 +4700,19 @@ the @appinfo has been constructed. Gets the installed name of the application. + line="11389">Gets the installed name of the application. the name of the application for @appinfo. + line="11395">the name of the application for @appinfo. a #GAppInfo. + line="11391">a #GAppInfo. @@ -4623,7 +4722,7 @@ the @appinfo has been constructed. version="2.34"> Retrieves the list of content types that @app_info claims to support. + line="11416">Retrieves the list of content types that @app_info claims to support. If this information is not provided by the environment, this function will return %NULL. This function does not take in consideration associations added with @@ -4633,7 +4732,7 @@ the application. + line="11427"> a list of content types. @@ -4643,7 +4742,7 @@ the application. a #GAppInfo that can handle files + line="11418">a #GAppInfo that can handle files @@ -4651,7 +4750,7 @@ the application. Launches the application. Passes @files to the launched application + line="11433">Launches the application. Passes @files to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -4682,14 +4781,14 @@ on information provided in @context. %TRUE on successful launch, %FALSE otherwise. + line="11468">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11435">a #GAppInfo allow-none="1"> a #GList of #GFile objects + line="11436">a #GList of #GFile objects @@ -4709,7 +4808,7 @@ on information provided in @context. allow-none="1"> a #GAppLaunchContext or %NULL + line="11437">a #GAppLaunchContext or %NULL @@ -4719,7 +4818,7 @@ on information provided in @context. throws="1"> Launches the application. This passes the @uris to the launched application + line="11526">Launches the application. This passes the @uris to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -4733,14 +4832,14 @@ no way to detect this. %TRUE on successful launch, %FALSE otherwise. + line="11544">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11528">a #GAppInfo allow-none="1"> a #GList containing URIs to launch. + line="11529">a #GList containing URIs to launch. @@ -4760,7 +4859,7 @@ no way to detect this. allow-none="1"> a #GAppLaunchContext or %NULL + line="11530">a #GAppLaunchContext or %NULL @@ -4770,7 +4869,7 @@ no way to detect this. version="2.60"> Async version of g_app_info_launch_uris(). + line="11548">Async version of g_app_info_launch_uris(). The @callback is invoked immediately after the application launch, but it waits for activation in case of D-Bus–activated applications and also provides @@ -4784,7 +4883,7 @@ g_app_info_launch_default_for_uri_async(). a #GAppInfo + line="11550">a #GAppInfo allow-none="1"> a #GList containing URIs to launch. + line="11551">a #GList containing URIs to launch. @@ -4804,7 +4903,7 @@ g_app_info_launch_default_for_uri_async(). allow-none="1"> a #GAppLaunchContext or %NULL + line="11552">a #GAppLaunchContext or %NULL allow-none="1"> a #GCancellable + line="11553">a #GCancellable closure="4"> a #GAsyncReadyCallback to call when the request is done + line="11554">a #GAsyncReadyCallback to call when the request is done allow-none="1"> data to pass to @callback + line="11555">data to pass to @callback @@ -4844,25 +4943,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Finishes a g_app_info_launch_uris_async() operation. + line="11568">Finishes a g_app_info_launch_uris_async() operation. %TRUE on successful launch, %FALSE otherwise. + line="11576">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11570">a #GAppInfo a #GAsyncResult + line="11571">a #GAsyncResult @@ -4872,25 +4971,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Removes a supported type from an application, if possible. + line="11599">Removes a supported type from an application, if possible. %TRUE on success, %FALSE on error. + line="11607">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11601">a #GAppInfo. a string. + line="11602">a string. @@ -4900,25 +4999,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Sets the application as the default handler for the given file extension. + line="11625">Sets the application as the default handler for the given file extension. %TRUE on success, %FALSE on error. + line="11634">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11627">a #GAppInfo. a string containing the file extension + line="11628">a string containing the file extension (without the dot). @@ -4929,25 +5028,25 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Sets the application as the default handler for a given type. + line="11638">Sets the application as the default handler for a given type. %TRUE on success, %FALSE on error. + line="11646">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11640">a #GAppInfo. the content type. + line="11641">the content type. @@ -4957,7 +5056,7 @@ g_app_info_launch_default_for_uri_async(). throws="1"> Sets the application as the last used application for a given type. + line="11650">Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by g_app_info_get_recommended_for_type(), regardless of the default application for that content type. @@ -4965,20 +5064,20 @@ application for that content type. %TRUE on success, %FALSE on error. + line="11661">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11652">a #GAppInfo. the content type. + line="11653">the content type. @@ -4986,20 +5085,20 @@ application for that content type. Checks if the application info should be shown in menus that + line="11665">Checks if the application info should be shown in menus that list available applications. %TRUE if the @appinfo should be shown, %FALSE otherwise. + line="11672">%TRUE if the @appinfo should be shown, %FALSE otherwise. a #GAppInfo. + line="11667">a #GAppInfo. @@ -5007,19 +5106,19 @@ list available applications. Checks if the application accepts files as arguments. + line="11676">Checks if the application accepts files as arguments. %TRUE if the @appinfo supports files. + line="11682">%TRUE if the @appinfo supports files. a #GAppInfo. + line="11678">a #GAppInfo. @@ -5027,19 +5126,19 @@ list available applications. Checks if the application supports reading files and directories from URIs. + line="11686">Checks if the application supports reading files and directories from URIs. %TRUE if the @appinfo supports URIs. + line="11692">%TRUE if the @appinfo supports URIs. a #GAppInfo. + line="11688">a #GAppInfo. @@ -5055,7 +5154,8 @@ list available applications. + glib:nick="none" + glib:name="G_APP_INFO_CREATE_NONE"> No flags. @@ -5063,7 +5163,8 @@ list available applications. + glib:nick="needs-terminal" + glib:name="G_APP_INFO_CREATE_NEEDS_TERMINAL"> Application opens in a terminal window. @@ -5071,7 +5172,8 @@ list available applications. + glib:nick="supports-uris" + glib:name="G_APP_INFO_CREATE_SUPPORTS_URIS"> Application supports URI arguments. @@ -5079,7 +5181,8 @@ list available applications. + glib:nick="supports-startup-notification" + glib:name="G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION"> Application supports startup notification. Since 2.26 @@ -5104,14 +5207,14 @@ list available applications. a duplicate of @appinfo. + line="11224">a duplicate of @appinfo. a #GAppInfo. + line="11220">a #GAppInfo. @@ -5123,20 +5226,20 @@ list available applications. %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + line="11239">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. the first #GAppInfo. + line="11230">the first #GAppInfo. the second #GAppInfo. + line="11231">the second #GAppInfo. @@ -5145,219 +5248,12 @@ list available applications. - + a string containing the application's ID. + line="11385">a string containing the application's ID. - - - a #GAppInfo. - - - - - - - - - - the name of the application for @appinfo. - - - - - a #GAppInfo. - - - - - - - - - - a string containing a description of the -application @appinfo, or %NULL if none. - - - - - a #GAppInfo. - - - - - - - - - - - - - - - - - - - - - - - the default #GIcon for @appinfo or %NULL -if there is no default icon. - - - - - a #GAppInfo. - - - - - - - - - - %TRUE on successful launch, %FALSE otherwise. - - - - - a #GAppInfo - - - - a #GList of #GFile objects - - - - - - a #GAppLaunchContext or %NULL - - - - - - - - - - %TRUE if the @appinfo supports URIs. - - - - - a #GAppInfo. - - - - - - - - - - %TRUE if the @appinfo supports files. - - - - - a #GAppInfo. - - - - - - - - - - %TRUE on successful launch, %FALSE otherwise. - - - - - a #GAppInfo - - - - a #GList containing URIs to launch. - - - - - - a #GAppLaunchContext or %NULL - - - - - - - - - - %TRUE if the @appinfo should be shown, %FALSE otherwise. - - - - - + + + %TRUE on success, %FALSE on error. + line="11395">the name of the application for @appinfo. + + + + + a #GAppInfo. + + + + + + + + + + a string containing a description of the +application @appinfo, or %NULL if none. + + + + + a #GAppInfo. + + + + + + + + + + a string containing the @appinfo's application +binaries name + + + + + a #GAppInfo + + + + + + + + + + the default #GIcon for @appinfo or %NULL +if there is no default icon. + + + + + a #GAppInfo. + + + + + + + + + + %TRUE on successful launch, %FALSE otherwise. a #GAppInfo. + line="11435">a #GAppInfo + + + + a #GList of #GFile objects + + + + + + a #GAppLaunchContext or %NULL + + + + + + + + + + %TRUE if the @appinfo supports URIs. + + + + + a #GAppInfo. + + + + + + + + + + %TRUE if the @appinfo supports files. + + + + + a #GAppInfo. + + + + + + + + + + %TRUE on successful launch, %FALSE otherwise. + + + + + a #GAppInfo + + + + a #GList containing URIs to launch. + + + + + + a #GAppLaunchContext or %NULL + + + + + + + + + + %TRUE if the @appinfo should be shown, %FALSE otherwise. + + + + + a #GAppInfo. + + + + + + + + + + %TRUE on success, %FALSE on error. + + + + + a #GAppInfo. the content type. + line="11641">the content type. @@ -5399,20 +5509,20 @@ if there is no default icon. %TRUE on success, %FALSE on error. + line="11634">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11627">a #GAppInfo. a string containing the file extension + line="11628">a string containing the file extension (without the dot). @@ -5425,20 +5535,20 @@ if there is no default icon. %TRUE on success, %FALSE on error. + line="11157">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11150">a #GAppInfo. a string. + line="11151">a string. @@ -5450,7 +5560,7 @@ if there is no default icon. %TRUE if it is possible to remove supported + line="11179">%TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. @@ -5458,7 +5568,7 @@ if there is no default icon. a #GAppInfo. + line="11175">a #GAppInfo. @@ -5470,20 +5580,20 @@ if there is no default icon. %TRUE on success, %FALSE on error. + line="11607">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11601">a #GAppInfo. a string. + line="11602">a string. @@ -5495,14 +5605,14 @@ if there is no default icon. %TRUE if @appinfo can be deleted + line="11168">%TRUE if @appinfo can be deleted a #GAppInfo + line="11163">a #GAppInfo @@ -5514,14 +5624,14 @@ if there is no default icon. %TRUE if @appinfo has been deleted + line="11213">%TRUE if @appinfo has been deleted a #GAppInfo + line="11205">a #GAppInfo @@ -5530,11 +5640,18 @@ if there is no default icon. - - + + a string containing the @appinfo's commandline, + or %NULL if this information is not available + + a #GAppInfo @@ -5546,7 +5663,7 @@ if there is no default icon. the display name of the application for @appinfo, or the name if + line="11331">the display name of the application for @appinfo, or the name if no display name is available. @@ -5554,7 +5671,7 @@ no display name is available. a #GAppInfo. + line="11326">a #GAppInfo. @@ -5566,20 +5683,20 @@ no display name is available. %TRUE on success, %FALSE on error. + line="11661">%TRUE on success, %FALSE on error. a #GAppInfo. + line="11652">a #GAppInfo. the content type. + line="11653">the content type. @@ -5591,7 +5708,7 @@ no display name is available. + line="11427"> a list of content types. @@ -5601,7 +5718,7 @@ no display name is available. a #GAppInfo that can handle files + line="11418">a #GAppInfo that can handle files @@ -5617,7 +5734,7 @@ no display name is available. a #GAppInfo + line="11550">a #GAppInfo allow-none="1"> a #GList containing URIs to launch. + line="11551">a #GList containing URIs to launch. @@ -5637,7 +5754,7 @@ no display name is available. allow-none="1"> a #GAppLaunchContext or %NULL + line="11552">a #GAppLaunchContext or %NULL allow-none="1"> a #GCancellable + line="11553">a #GCancellable closure="5"> a #GAsyncReadyCallback to call when the request is done + line="11554">a #GAsyncReadyCallback to call when the request is done closure="5"> data to pass to @callback + line="11555">data to pass to @callback @@ -5679,20 +5796,20 @@ no display name is available. %TRUE on successful launch, %FALSE otherwise. + line="11576">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + line="11570">a #GAppInfo a #GAsyncResult + line="11571">a #GAsyncResult @@ -5708,7 +5825,7 @@ no display name is available. glib:get-type="g_app_info_monitor_get_type"> #GAppInfoMonitor is a very simple object used for monitoring the app + line="4870">#GAppInfoMonitor is a very simple object used for monitoring the app info database for changes (ie: newly installed or removed applications). @@ -5730,7 +5847,7 @@ rescanning the list on every change is pointless and expensive. version="2.40"> Gets the #GAppInfoMonitor for the current thread-default main + line="11581">Gets the #GAppInfoMonitor for the current thread-default main context. The #GAppInfoMonitor will emit a "changed" signal in the @@ -5743,7 +5860,7 @@ the same main context as you created it. a reference to a #GAppInfoMonitor + line="11594">a reference to a #GAppInfoMonitor @@ -5773,46 +5890,46 @@ on the same screen as the launching window. Creates a new application launch context. This is not normally used, + line="11752">Creates a new application launch context. This is not normally used, instead you instantiate a subclass of this, such as #GdkAppLaunchContext. a #GAppLaunchContext. + line="11758">a #GAppLaunchContext. Gets the display string for the @context. This is used to ensure new + line="11696">Gets the display string for the @context. This is used to ensure new applications are started on the same display as the launching application, by setting the `DISPLAY` environment variable. - + a display string for the display. + line="11706">a display string for the display. a #GAppLaunchContext + line="11698">a #GAppLaunchContext a #GAppInfo + line="11699">a #GAppInfo a #GList of #GFile objects + line="11700">a #GList of #GFile objects @@ -5823,16 +5940,16 @@ application, by setting the `DISPLAY` environment variable. invoker="get_startup_notify_id"> Initiates startup notification for the application and returns the + line="11725">Initiates startup notification for the application and returns the `DESKTOP_STARTUP_ID` for the launched operation, if supported. Startup notification IDs are defined in the [FreeDesktop.Org Startup Notifications standard](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt). - + a startup notification ID for the application, or %NULL if + line="11737">a startup notification ID for the application, or %NULL if not supported. @@ -5840,19 +5957,19 @@ Startup notification IDs are defined in the a #GAppLaunchContext + line="11727">a #GAppLaunchContext a #GAppInfo + line="11728">a #GAppInfo a #GList of of #GFile objects + line="11729">a #GList of of #GFile objects @@ -5862,7 +5979,7 @@ Startup notification IDs are defined in the Called when an application has failed to launch, so that it can cancel + line="11742">Called when an application has failed to launch, so that it can cancel the application startup notification started in g_app_launch_context_get_startup_notify_id(). @@ -5872,13 +5989,13 @@ the application startup notification started in g_app_launch_context_get_startup a #GAppLaunchContext. + line="11744">a #GAppLaunchContext. the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + line="11745">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -5904,33 +6021,33 @@ the application startup notification started in g_app_launch_context_get_startup c:identifier="g_app_launch_context_get_display"> Gets the display string for the @context. This is used to ensure new + line="11696">Gets the display string for the @context. This is used to ensure new applications are started on the same display as the launching application, by setting the `DISPLAY` environment variable. - + a display string for the display. + line="11706">a display string for the display. a #GAppLaunchContext + line="11698">a #GAppLaunchContext a #GAppInfo + line="11699">a #GAppInfo a #GList of #GFile objects + line="11700">a #GList of #GFile objects @@ -5942,7 +6059,7 @@ application, by setting the `DISPLAY` environment variable. version="2.32"> Gets the complete environment variable list to be passed to + line="11710">Gets the complete environment variable list to be passed to the child process when @context is used to launch an application. This is a %NULL-terminated array of strings, where each string has the form `KEY=VALUE`. @@ -5950,7 +6067,7 @@ the form `KEY=VALUE`. + line="11719"> the child's environment @@ -5960,7 +6077,7 @@ the form `KEY=VALUE`. a #GAppLaunchContext + line="11712">a #GAppLaunchContext @@ -5969,16 +6086,16 @@ the form `KEY=VALUE`. c:identifier="g_app_launch_context_get_startup_notify_id"> Initiates startup notification for the application and returns the + line="11725">Initiates startup notification for the application and returns the `DESKTOP_STARTUP_ID` for the launched operation, if supported. Startup notification IDs are defined in the [FreeDesktop.Org Startup Notifications standard](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt). - + a startup notification ID for the application, or %NULL if + line="11737">a startup notification ID for the application, or %NULL if not supported. @@ -5986,19 +6103,19 @@ Startup notification IDs are defined in the a #GAppLaunchContext + line="11727">a #GAppLaunchContext a #GAppInfo + line="11728">a #GAppInfo a #GList of of #GFile objects + line="11729">a #GList of of #GFile objects @@ -6009,7 +6126,7 @@ Startup notification IDs are defined in the c:identifier="g_app_launch_context_launch_failed"> Called when an application has failed to launch, so that it can cancel + line="11742">Called when an application has failed to launch, so that it can cancel the application startup notification started in g_app_launch_context_get_startup_notify_id(). @@ -6019,13 +6136,13 @@ the application startup notification started in g_app_launch_context_get_startup a #GAppLaunchContext. + line="11744">a #GAppLaunchContext. the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + line="11745">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -6035,7 +6152,7 @@ the application startup notification started in g_app_launch_context_get_startup version="2.32"> Arranges for @variable to be set to @value in the child's + line="11762">Arranges for @variable to be set to @value in the child's environment when @context is used to launch an application. @@ -6045,19 +6162,19 @@ environment when @context is used to launch an application. a #GAppLaunchContext + line="11764">a #GAppLaunchContext the environment variable to set + line="11765">the environment variable to set the value for to set the variable to. + line="11766">the value for to set the variable to. @@ -6067,7 +6184,7 @@ environment when @context is used to launch an application. version="2.32"> Arranges for @variable to be unset in the child's environment + line="11775">Arranges for @variable to be unset in the child's environment when @context is used to launch an application. @@ -6077,13 +6194,13 @@ when @context is used to launch an application. a #GAppLaunchContext + line="11777">a #GAppLaunchContext the environment variable to remove + line="11778">the environment variable to remove @@ -6150,29 +6267,29 @@ platform-specific data about this launch. On UNIX, at least the - + a display string for the display. + line="11706">a display string for the display. a #GAppLaunchContext + line="11698">a #GAppLaunchContext a #GAppInfo + line="11699">a #GAppInfo a #GList of #GFile objects + line="11700">a #GList of #GFile objects @@ -6183,10 +6300,10 @@ platform-specific data about this launch. On UNIX, at least the - + a startup notification ID for the application, or %NULL if + line="11737">a startup notification ID for the application, or %NULL if not supported. @@ -6194,19 +6311,19 @@ platform-specific data about this launch. On UNIX, at least the a #GAppLaunchContext + line="11727">a #GAppLaunchContext a #GAppInfo + line="11728">a #GAppInfo a #GList of of #GFile objects + line="11729">a #GList of of #GFile objects @@ -6224,13 +6341,13 @@ platform-specific data about this launch. On UNIX, at least the a #GAppLaunchContext. + line="11744">a #GAppLaunchContext. the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + line="11745">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -6303,7 +6420,7 @@ platform-specific data about this launch. On UNIX, at least the glib:type-struct="ApplicationClass"> A #GApplication is the foundation of an application. It wraps some + line="4896">A #GApplication is the foundation of an application. It wraps some low-level platform-specific services and is intended to act as the foundation for higher-level application classes such as #GtkApplication or #MxApplication. In general, you should not use @@ -6410,20 +6527,20 @@ vfunc, to parse them in either the primary instance or the local instance, respectively. For an example of opening files with a GApplication, see -[gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c). +[gapplication-example-open.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-open.c). For an example of using actions with GApplication, see -[gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c). +[gapplication-example-actions.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-actions.c). For an example of using extra D-Bus hooks with GApplication, see -[gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c). +[gapplication-example-dbushooks.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-dbushooks.c). Creates a new #GApplication instance. + line="12448">Creates a new #GApplication instance. If non-%NULL, the application id must be valid. See g_application_id_is_valid(). @@ -6434,7 +6551,7 @@ If no application ID is given then some features of #GApplication a new #GApplication instance + line="12461">a new #GApplication instance @@ -6444,13 +6561,13 @@ If no application ID is given then some features of #GApplication allow-none="1"> the application id + line="12450">the application id the application flags + line="12451">the application flags @@ -6460,7 +6577,7 @@ If no application ID is given then some features of #GApplication version="2.32"> Returns the default #GApplication instance for this process. + line="12257">Returns the default #GApplication instance for this process. Normally there is only one #GApplication per process and it becomes the default when it is created. You can exercise more control over @@ -6468,17 +6585,17 @@ this by using g_application_set_default(). If there is no default application then %NULL is returned. - + the default application for this process, or %NULL + line="12268">the default application for this process, or %NULL Checks if @application_id is a valid application identifier. + line="12373">Checks if @application_id is a valid application identifier. A valid ID is required for calls to g_application_new() and g_application_set_application_id(). @@ -6527,14 +6644,14 @@ archiving application, it might be named `org._7_zip.Archiver`. %TRUE if @application_id is valid + line="12423">%TRUE if @application_id is valid a potential application identifier + line="12375">a potential application identifier @@ -6542,7 +6659,7 @@ archiving application, it might be named `org._7_zip.Archiver`. Activates the application. + line="11787">Activates the application. In essence, this results in the #GApplication::activate signal being emitted in the primary instance. @@ -6556,7 +6673,7 @@ The application must be registered before calling this function. a #GApplication + line="11789">a #GApplication @@ -6729,7 +6846,7 @@ See g_application_run() for more details on #GApplication startup. Opens the given files. + line="12465">Opens the given files. In essence, this results in the #GApplication::open signal being emitted in the primary instance. @@ -6751,13 +6868,13 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. a #GApplication + line="12467">a #GApplication an array of #GFiles to open + line="12468">an array of #GFiles to open @@ -6765,13 +6882,13 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. the length of the @files array + line="12469">the length of the @files array a hint (or ""), but never %NULL + line="12470">a hint (or ""), but never %NULL @@ -6825,7 +6942,7 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. version="2.28"> Activates the application. + line="11787">Activates the application. In essence, this results in the #GApplication::activate signal being emitted in the primary instance. @@ -6839,7 +6956,7 @@ The application must be registered before calling this function. a #GApplication + line="11789">a #GApplication @@ -6849,7 +6966,7 @@ The application must be registered before calling this function. version="2.42"> Add an option to be handled by @application. + line="11802">Add an option to be handled by @application. Calling this function is the equivalent of calling g_application_add_main_option_entries() with a single #GOptionEntry @@ -6870,37 +6987,37 @@ See #GOptionEntry for more documentation of the arguments. the #GApplication + line="11804">the #GApplication the long name of an option used to specify it in a commandline + line="11805">the long name of an option used to specify it in a commandline the short name of an option + line="11806">the short name of an option flags from #GOptionFlags + line="11807">flags from #GOptionFlags the type of the option, as a #GOptionArg + line="11808">the type of the option, as a #GOptionArg the description for the option in `--help` output + line="11809">the description for the option in `--help` output allow-none="1"> the placeholder to use for the extra argument + line="11810">the placeholder to use for the extra argument parsed by the option in `--help` output @@ -6920,7 +7037,7 @@ See #GOptionEntry for more documentation of the arguments. version="2.40"> Adds main option entries to be handled by @application. + line="11831">Adds main option entries to be handled by @application. This function is comparable to g_option_context_add_main_entries(). @@ -6982,13 +7099,13 @@ the options with g_variant_dict_lookup(): a #GApplication + line="11833">a #GApplication a + line="11834">a %NULL-terminated list of #GOptionEntrys @@ -7001,7 +7118,7 @@ the options with g_variant_dict_lookup(): version="2.40"> Adds a #GOptionGroup to the commandline handling of @application. + line="11896">Adds a #GOptionGroup to the commandline handling of @application. This function is comparable to g_option_context_add_group(). @@ -7034,13 +7151,13 @@ new functionality whereby unrecognised options are rejected even if the #GApplication + line="11898">the #GApplication a #GOptionGroup + line="11899">a #GOptionGroup @@ -7050,7 +7167,7 @@ new functionality whereby unrecognised options are rejected even if version="2.44"> Marks @application as busy (see g_application_mark_busy()) while + line="11931">Marks @application as busy (see g_application_mark_busy()) while @property on @object is %TRUE. The binding holds a reference to @application while it is active, but @@ -7064,41 +7181,42 @@ finalized. a #GApplication + line="11933">a #GApplication a #GObject + line="11934">a #GObject the name of a boolean property of @object + line="11935">the name of a boolean property of @object Gets the unique identifier for @application. + line="12199">Gets the unique identifier for @application. - + the identifier for @application, owned by @application + line="12205">the identifier for @application, owned by @application a #GApplication + line="12201">a #GApplication @@ -7108,7 +7226,7 @@ finalized. version="2.34"> Gets the #GDBusConnection being used by the application, or %NULL. + line="12210">Gets the #GDBusConnection being used by the application, or %NULL. If #GApplication is using its D-Bus backend then this function will return the #GDBusConnection being used for uniqueness and @@ -7122,17 +7240,17 @@ normally be in use but we were unable to connect to the bus. This function must not be called before the application has been registered. See g_application_get_is_registered(). - + a #GDBusConnection, or %NULL + line="12228">a #GDBusConnection, or %NULL a #GApplication + line="12212">a #GApplication @@ -7142,7 +7260,7 @@ registered. See g_application_get_is_registered(). version="2.34"> Gets the D-Bus object path being used by the application, or %NULL. + line="12233">Gets the D-Bus object path being used by the application, or %NULL. If #GApplication is using its D-Bus backend then this function will return the D-Bus object path that #GApplication is using. If the @@ -7157,51 +7275,53 @@ normally be in use but we were unable to connect to the bus. This function must not be called before the application has been registered. See g_application_get_is_registered(). - + the object path, or %NULL + line="12252">the object path, or %NULL a #GApplication + line="12235">a #GApplication Gets the flags for @application. + line="12273">Gets the flags for @application. See #GApplicationFlags. the flags for @application + line="12281">the flags for @application a #GApplication + line="12275">a #GApplication Gets the current inactivity timeout for the application. + line="12286">Gets the current inactivity timeout for the application. This is the amount of time (in milliseconds) after the last call to g_application_release() before the application stops running. @@ -7209,47 +7329,49 @@ g_application_release() before the application stops running. the timeout, in milliseconds + line="12295">the timeout, in milliseconds a #GApplication + line="12288">a #GApplication Gets the application's current busy state, as set through + line="12300">Gets the application's current busy state, as set through g_application_mark_busy() or g_application_bind_busy_property(). %TRUE if @application is currently marked as busy + line="12307">%TRUE if @application is currently marked as busy a #GApplication + line="12302">a #GApplication Checks if @application is registered. + line="12312">Checks if @application is registered. An application is registered if g_application_register() has been successfully called. @@ -7257,24 +7379,25 @@ successfully called. %TRUE if @application is registered + line="12321">%TRUE if @application is registered a #GApplication + line="12314">a #GApplication Checks if @application is remote. + line="12326">Checks if @application is remote. If @application is remote then it means that another instance of application already exists (the 'primary' instance). Calls to @@ -7288,38 +7411,39 @@ g_application_get_is_registered(). %TRUE if @application is remote + line="12341">%TRUE if @application is remote a #GApplication + line="12328">a #GApplication Gets the resource base path of @application. + line="12346">Gets the resource base path of @application. See g_application_set_resource_base_path() for more information. the base resource path, if one is set + line="12354">the base resource path, if one is set a #GApplication + line="12348">a #GApplication @@ -7327,7 +7451,7 @@ See g_application_set_resource_base_path() for more information. Increases the use count of @application. + line="12359">Increases the use count of @application. Use this function to indicate that the application has a reason to continue to run. For example, g_application_hold() is called by GTK+ @@ -7342,7 +7466,7 @@ To cancel the hold, call g_application_release(). a #GApplication + line="12361">a #GApplication @@ -7352,7 +7476,7 @@ To cancel the hold, call g_application_release(). version="2.38"> Increases the busy count of @application. + line="12427">Increases the busy count of @application. Use this function to indicate that the application is busy, for instance while a long running operation is pending. @@ -7361,7 +7485,9 @@ The busy state will be exposed to other processes, so a session shell will use that information to indicate the state to the user (e.g. with a spinner). -To cancel the busy indication, use g_application_unmark_busy(). +To cancel the busy indication, use g_application_unmark_busy(). + +The application must be registered before calling this function. @@ -7370,7 +7496,7 @@ To cancel the busy indication, use g_application_unmark_busy(). a #GApplication + line="12429">a #GApplication @@ -7378,7 +7504,7 @@ To cancel the busy indication, use g_application_unmark_busy(). Opens the given files. + line="12465">Opens the given files. In essence, this results in the #GApplication::open signal being emitted in the primary instance. @@ -7400,13 +7526,13 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. a #GApplication + line="12467">a #GApplication an array of #GFiles to open + line="12468">an array of #GFiles to open @@ -7414,13 +7540,13 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. the length of the @files array + line="12469">the length of the @files array a hint (or ""), but never %NULL + line="12470">a hint (or ""), but never %NULL @@ -7428,7 +7554,7 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. Immediately quits the application. + line="12491">Immediately quits the application. Upon return to the mainloop, g_application_run() will return, calling only the 'shutdown' function before doing so. @@ -7449,7 +7575,7 @@ unspecified. a #GApplication + line="12493">a #GApplication @@ -7460,7 +7586,7 @@ unspecified. throws="1"> Attempts registration of the application. + line="12513">Attempts registration of the application. This is the point at which the application discovers if it is the primary instance or merely acting as a remote for an already-existing @@ -7494,14 +7620,14 @@ g_application_get_is_remote() for that. %TRUE if registration succeeded + line="12550">%TRUE if registration succeeded a #GApplication + line="12515">a #GApplication allow-none="1"> a #GCancellable, or %NULL + line="12516">a #GCancellable, or %NULL @@ -7518,7 +7644,7 @@ g_application_get_is_remote() for that. Decrease the use count of @application. + line="12555">Decrease the use count of @application. When the use count reaches zero, the application will stop running. @@ -7532,7 +7658,7 @@ call to g_application_hold(). a #GApplication + line="12557">a #GApplication @@ -7540,7 +7666,7 @@ call to g_application_hold(). Runs the application. + line="12568">Runs the application. This function is intended to be run from main() and its return value is intended to be returned by main(). Although you are expected to pass @@ -7578,7 +7704,7 @@ commandline then you should implement your own #GApplication subclass and override local_command_line(). In this case, you most likely want to return %TRUE from your local_command_line() implementation to suppress the default handling. See -[gapplication-example-cmdline2.c][gapplication-example-cmdline2] +[gapplication-example-cmdline2.c][https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline2.c] for an example. If, after the above is done, the use count of the application is zero @@ -7619,20 +7745,20 @@ what their exit status will be. the exit status + line="12651">the exit status a #GApplication + line="12570">a #GApplication the argc from main() (or 0 if @argv is %NULL) + line="12571">the argc from main() (or 0 if @argv is %NULL) allow-none="1"> + line="12572"> the argv from main(), or %NULL @@ -7654,7 +7780,7 @@ what their exit status will be. version="2.40"> Sends a notification on behalf of @application to the desktop shell. + line="12656">Sends a notification on behalf of @application to the desktop shell. There is no guarantee that the notification is displayed immediately, or even at all. @@ -7688,7 +7814,7 @@ g_application_withdraw_notification(). a #GApplication + line="12658">a #GApplication allow-none="1"> id of the notification, or %NULL + line="12659">id of the notification, or %NULL the #GNotification to send + line="12660">the #GNotification to send This used to be how actions were associated with a #GApplication. + line="12693">This used to be how actions were associated with a #GApplication. Now there is #GActionMap for that. Use the #GActionMap interface instead. Never ever mix use of this API with use of #GActionMap on the same @application @@ -7730,7 +7857,7 @@ action group), so you should really use #GActionMap instead. a #GApplication + line="12695">a #GApplication allow-none="1"> a #GActionGroup, or %NULL + line="12696">a #GActionGroup, or %NULL Sets the unique identifier for @application. + line="12710">Sets the unique identifier for @application. The application id can only be modified if @application has not yet been registered. @@ -7764,7 +7892,7 @@ g_application_id_is_valid(). a #GApplication + line="12712">a #GApplication allow-none="1"> the identifier for @application + line="12713">the identifier for @application @@ -7783,7 +7911,7 @@ g_application_id_is_valid(). version="2.32"> Sets or unsets the default application for the process, as returned + line="12727">Sets or unsets the default application for the process, as returned by g_application_get_default(). This function does not take its own reference on @application. If @@ -7800,17 +7928,18 @@ back to %NULL. allow-none="1"> the application to set as default, or %NULL + line="12729">the application to set as default, or %NULL Sets the flags for @application. + line="12742">Sets the flags for @application. The flags can only be modified if @application has not yet been registered. @@ -7824,23 +7953,24 @@ See #GApplicationFlags. a #GApplication + line="12744">a #GApplication the flags for @application + line="12745">the flags for @application Sets the current inactivity timeout for the application. + line="12758">Sets the current inactivity timeout for the application. This is the amount of time (in milliseconds) after the last call to g_application_release() before the application stops running. @@ -7856,13 +7986,13 @@ zero. Any timeouts currently in progress are not impacted. a #GApplication + line="12760">a #GApplication the timeout, in milliseconds + line="12761">the timeout, in milliseconds @@ -7872,7 +8002,7 @@ zero. Any timeouts currently in progress are not impacted. version="2.56"> Adds a description to the @application option context. + line="12776">Adds a description to the @application option context. See g_option_context_set_description() for more information. @@ -7883,7 +8013,7 @@ See g_option_context_set_description() for more information. the #GApplication + line="12778">the #GApplication allow-none="1"> a string to be shown in `--help` output + line="12779">a string to be shown in `--help` output after the list of options, or %NULL @@ -7903,7 +8033,7 @@ See g_option_context_set_description() for more information. version="2.56"> Sets the parameter string to be used by the commandline handling of @application. + line="12790">Sets the parameter string to be used by the commandline handling of @application. This function registers the argument to be passed to g_option_context_new() when the internal #GOptionContext of @application is created. @@ -7917,7 +8047,7 @@ See g_option_context_new() for more information about @parameter_string. the #GApplication + line="12792">the #GApplication allow-none="1"> a string which is displayed + line="12793">a string which is displayed in the first line of `--help` output, after the usage summary `programname [OPTION...]`. @@ -7937,7 +8067,7 @@ See g_option_context_new() for more information about @parameter_string. version="2.56"> Adds a summary to the @application option context. + line="12807">Adds a summary to the @application option context. See g_option_context_set_summary() for more information. @@ -7948,7 +8078,7 @@ See g_option_context_set_summary() for more information. the #GApplication + line="12809">the #GApplication allow-none="1"> a string to be shown in `--help` output + line="12810">a string to be shown in `--help` output before the list of options, or %NULL @@ -7965,10 +8095,11 @@ See g_option_context_set_summary() for more information. Sets (or unsets) the base resource path of @application. + line="12821">Sets (or unsets) the base resource path of @application. The path is used to automatically load various [application resources][gresource] such as menu layouts and action descriptions. @@ -8009,7 +8140,7 @@ before chaining up to the parent implementation. a #GApplication + line="12823">a #GApplication allow-none="1"> the resource path to use + line="12824">the resource path to use @@ -8028,7 +8159,7 @@ before chaining up to the parent implementation. version="2.44"> Destroys a binding between @property and the busy state of + line="12864">Destroys a binding between @property and the busy state of @application that was previously created with g_application_bind_busy_property(). @@ -8039,19 +8170,19 @@ g_application_bind_busy_property(). a #GApplication + line="12866">a #GApplication a #GObject + line="12867">a #GObject the name of a boolean property of @object + line="12868">the name of a boolean property of @object @@ -8061,7 +8192,7 @@ g_application_bind_busy_property(). version="2.38"> Decreases the busy count of @application. + line="12878">Decreases the busy count of @application. When the busy count reaches zero, the new state will be propagated to other processes. @@ -8076,7 +8207,7 @@ call to g_application_mark_busy(). a #GApplication + line="12880">a #GApplication @@ -8086,7 +8217,7 @@ call to g_application_mark_busy(). version="2.40"> Withdraws a notification that was sent with + line="12894">Withdraws a notification that was sent with g_application_send_notification(). This call does nothing if a notification with @id doesn't exist or @@ -8107,13 +8238,13 @@ there is no need to explicitly withdraw the notification in that case. a #GApplication + line="12896">a #GApplication id of a previously sent notification + line="12897">id of a previously sent notification @@ -8121,39 +8252,57 @@ there is no need to explicitly withdraw the notification in that case. + transfer-ownership="none" + setter="set_action_group"> + transfer-ownership="none" + setter="set_application_id" + getter="get_application_id"> - + + transfer-ownership="none" + setter="set_inactivity_timeout" + getter="get_inactivity_timeout"> - + Whether the application is currently marked as busy through g_application_mark_busy() or g_application_bind_busy_property(). - + - + + transfer-ownership="none" + setter="set_resource_base_path" + getter="get_resource_base_path"> @@ -8355,7 +8504,7 @@ after registration. See g_application_register(). a #GApplication + line="11789">a #GApplication @@ -8371,13 +8520,13 @@ after registration. See g_application_register(). a #GApplication + line="12467">a #GApplication an array of #GFiles to open + line="12468">an array of #GFiles to open @@ -8385,13 +8534,13 @@ after registration. See g_application_register(). the length of the @files array + line="12469">the length of the @files array a hint (or ""), but never %NULL + line="12470">a hint (or ""), but never %NULL @@ -8622,7 +8771,7 @@ after registration. See g_application_register(). glib:type-struct="ApplicationCommandLineClass"> #GApplicationCommandLine represents a command-line invocation of + line="5019">#GApplicationCommandLine represents a command-line invocation of an application. It is created by #GApplication and emitted in the #GApplication::command-line signal and virtual function. @@ -8682,7 +8831,7 @@ command_line (GApplication *application, } ]| The complete example can be found here: -[gapplication-example-cmdline.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline.c) +[gapplication-example-cmdline.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline.c) In more complicated cases, the handling of the comandline can be split between the launcher and the primary instance. @@ -8733,7 +8882,7 @@ to the #GApplication::command-line handler which runs in the primary instance. The complete example can be found here: -[gapplication-example-cmdline2.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline2.c) +[gapplication-example-cmdline2.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline2.c) If handling the commandline requires a lot of work, it may be better to defer it. @@ -8775,33 +8924,33 @@ later (in this example, in an idle). Note that it is necessary to hold the application until you are done with the commandline. The complete example can be found here: -[gapplication-example-cmdline3.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline3.c) +[gapplication-example-cmdline3.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline3.c) Gets the stdin of the invoking process. + line="12092">Gets the stdin of the invoking process. The #GInputStream can be used to read data passed to the standard input of the invoking process. This doesn't work on all platforms. Presently, it is only available -on UNIX when using a DBus daemon capable of passing file descriptors. +on UNIX when using a D-Bus daemon capable of passing file descriptors. If stdin is not available then %NULL will be returned. In the future, support may be expanded to other platforms. You must only call this function once per commandline invocation. - + a #GInputStream for stdin + line="12107">a #GInputStream for stdin a #GApplicationCommandLine + line="12094">a #GApplicationCommandLine @@ -8842,7 +8991,7 @@ You must only call this function once per commandline invocation. version="2.36"> Creates a #GFile corresponding to a filename that was given as part + line="11948">Creates a #GFile corresponding to a filename that was given as part of the invocation of @cmdline. This differs from g_file_new_for_commandline_arg() in that it @@ -8852,21 +9001,21 @@ the invoking process rather than the local process. a new #GFile + line="11960">a new #GFile a #GApplicationCommandLine + line="11950">a #GApplicationCommandLine an argument from @cmdline + line="11951">an argument from @cmdline @@ -8876,7 +9025,7 @@ the invoking process rather than the local process. version="2.28"> Gets the list of arguments that was passed on the command line. + line="11965">Gets the list of arguments that was passed on the command line. The strings in the array may contain non-UTF-8 data on UNIX (such as filenames or arguments given in the system locale) but are always in @@ -8891,7 +9040,7 @@ g_strfreev(). + line="11982"> the string array containing the arguments (the argv) @@ -8901,7 +9050,7 @@ g_strfreev(). a #GApplicationCommandLine + line="11967">a #GApplicationCommandLine @@ -8913,7 +9062,7 @@ g_strfreev(). allow-none="1"> the length of the arguments array, or %NULL + line="11968">the length of the arguments array, or %NULL @@ -8923,7 +9072,7 @@ g_strfreev(). version="2.28"> Gets the working directory of the command line invocation. + line="11988">Gets the working directory of the command line invocation. The string may contain non-utf8 data. It is possible that the remote application did not send a working @@ -8935,14 +9084,14 @@ long as @cmdline exists. the current directory, or %NULL + line="12001">the current directory, or %NULL a #GApplicationCommandLine + line="11990">a #GApplicationCommandLine @@ -8953,7 +9102,7 @@ long as @cmdline exists. version="2.28"> Gets the contents of the 'environ' variable of the command line + line="12006">Gets the contents of the 'environ' variable of the command line invocation, as would be returned by g_get_environ(), ie as a %NULL-terminated list of strings in the form 'NAME=VALUE'. The strings may contain non-utf8 data. @@ -8972,7 +9121,7 @@ in the value of a single environment variable. + line="12026"> the environment strings, or %NULL if they were not sent @@ -8982,7 +9131,7 @@ in the value of a single environment variable. a #GApplicationCommandLine + line="12008">a #GApplicationCommandLine @@ -8993,20 +9142,20 @@ in the value of a single environment variable. version="2.28"> Gets the exit status of @cmdline. See + line="12032">Gets the exit status of @cmdline. See g_application_command_line_set_exit_status() for more information. the exit status + line="12039">the exit status a #GApplicationCommandLine + line="12034">a #GApplicationCommandLine @@ -9014,22 +9163,23 @@ g_application_command_line_set_exit_status() for more information. Determines if @cmdline represents a remote invocation. + line="12044">Determines if @cmdline represents a remote invocation. %TRUE if the invocation was remote + line="12050">%TRUE if the invocation was remote a #GApplicationCommandLine + line="12046">a #GApplicationCommandLine @@ -9040,7 +9190,7 @@ g_application_command_line_set_exit_status() for more information. version="2.40"> Gets the options there were passed to g_application_command_line(). + line="12055">Gets the options there were passed to g_application_command_line(). If you did not override local_command_line() then these are the same options that were parsed according to the #GOptionEntrys added to the @@ -9053,14 +9203,14 @@ you don't need to check for %NULL. a #GVariantDict with the options + line="12069">a #GVariantDict with the options a #GApplicationCommandLine + line="12057">a #GApplicationCommandLine @@ -9071,7 +9221,7 @@ you don't need to check for %NULL. version="2.28"> Gets the platform data associated with the invocation of @cmdline. + line="12074">Gets the platform data associated with the invocation of @cmdline. This is a #GVariant dictionary containing information about the context in which the invocation occurred. It typically contains @@ -9083,14 +9233,14 @@ For local invocation, it will be %NULL. the platform data, or %NULL + line="12087">the platform data, or %NULL #GApplicationCommandLine + line="12076">#GApplicationCommandLine @@ -9101,28 +9251,28 @@ For local invocation, it will be %NULL. version="2.34"> Gets the stdin of the invoking process. + line="12092">Gets the stdin of the invoking process. The #GInputStream can be used to read data passed to the standard input of the invoking process. This doesn't work on all platforms. Presently, it is only available -on UNIX when using a DBus daemon capable of passing file descriptors. +on UNIX when using a D-Bus daemon capable of passing file descriptors. If stdin is not available then %NULL will be returned. In the future, support may be expanded to other platforms. You must only call this function once per commandline invocation. - + a #GInputStream for stdin + line="12107">a #GInputStream for stdin a #GApplicationCommandLine + line="12094">a #GApplicationCommandLine @@ -9133,7 +9283,7 @@ You must only call this function once per commandline invocation. version="2.28"> Gets the value of a particular environment variable of the command + line="12112">Gets the value of a particular environment variable of the command line invocation, as would be returned by g_getenv(). The strings may contain non-utf8 data. @@ -9145,24 +9295,24 @@ to invocation messages from other applications). The return value should not be modified or freed and is valid for as long as @cmdline exists. - + the value of the variable, or %NULL if unset or unsent + line="12129">the value of the variable, or %NULL if unset or unsent a #GApplicationCommandLine + line="12114">a #GApplicationCommandLine the environment variable to get + line="12115">the environment variable to get @@ -9173,7 +9323,7 @@ long as @cmdline exists. introspectable="0"> Formats a message and prints it using the stdout print handler in the + line="12134">Formats a message and prints it using the stdout print handler in the invoking process. If @cmdline is a local invocation then this is exactly equivalent to @@ -9187,20 +9337,20 @@ g_print() in the invoking process. a #GApplicationCommandLine + line="12136">a #GApplicationCommandLine a printf-style format string + line="12137">a printf-style format string arguments, as per @format + line="12138">arguments, as per @format @@ -9211,7 +9361,7 @@ g_print() in the invoking process. introspectable="0"> Formats a message and prints it using the stderr print handler in the + line="12151">Formats a message and prints it using the stderr print handler in the invoking process. If @cmdline is a local invocation then this is exactly equivalent to @@ -9225,20 +9375,20 @@ calling g_printerr() in the invoking process. a #GApplicationCommandLine + line="12153">a #GApplicationCommandLine a printf-style format string + line="12154">a printf-style format string arguments, as per @format + line="12155">arguments, as per @format @@ -9248,7 +9398,7 @@ calling g_printerr() in the invoking process. version="2.28"> Sets the exit status that will be used when the invoking process + line="12168">Sets the exit status that will be used when the invoking process exits. The return value of the #GApplication::command-line signal is @@ -9277,14 +9427,14 @@ status of the local #GApplicationCommandLine is used. a #GApplicationCommandLine + line="12170">a #GApplicationCommandLine the exit status + line="12171">the exit status @@ -9296,7 +9446,9 @@ status of the local #GApplicationCommandLine is used. transfer-ownership="none"> - + - + a #GInputStream for stdin + line="12107">a #GInputStream for stdin a #GApplicationCommandLine + line="12094">a #GApplicationCommandLine @@ -9405,22 +9557,24 @@ contains private data only. c:type="GApplicationFlags"> Flags used to define the behaviour of a #GApplication. + line="1471">Flags used to define the behaviour of a #GApplication. + glib:nick="flags-none" + glib:name="G_APPLICATION_FLAGS_NONE"> Default + line="1473">Default + glib:nick="is-service" + glib:name="G_APPLICATION_IS_SERVICE"> Run as a service. In this mode, registration + line="1474">Run as a service. In this mode, registration fails if the service is already running, and the application will initially wait up to 10 seconds for an initial activation message to arrive. @@ -9428,18 +9582,20 @@ contains private data only. + glib:nick="is-launcher" + glib:name="G_APPLICATION_IS_LAUNCHER"> Don't try to become the primary instance. + line="1478">Don't try to become the primary instance. + glib:nick="handles-open" + glib:name="G_APPLICATION_HANDLES_OPEN"> This application handles opening files (in + line="1479">This application handles opening files (in the primary instance). Note that this flag only affects the default implementation of local_command_line(), and has no effect if %G_APPLICATION_HANDLES_COMMAND_LINE is given. @@ -9448,10 +9604,11 @@ contains private data only. + glib:nick="handles-command-line" + glib:name="G_APPLICATION_HANDLES_COMMAND_LINE"> This application handles command line + line="1484">This application handles command line arguments (in the primary instance). Note that this flag only affect the default implementation of local_command_line(). See g_application_run() for details. @@ -9459,10 +9616,11 @@ contains private data only. + glib:nick="send-environment" + glib:name="G_APPLICATION_SEND_ENVIRONMENT"> Send the environment of the + line="1488">Send the environment of the launching process to the primary instance. Set this flag if your application is expected to behave differently depending on certain environment variables. For instance, an editor might be expected @@ -9474,10 +9632,11 @@ contains private data only. + glib:nick="non-unique" + glib:name="G_APPLICATION_NON_UNIQUE"> Make no attempts to do any of the typical + line="1496">Make no attempts to do any of the typical single-instance application negotiation, even if the application ID is given. The application neither attempts to become the owner of the application ID nor does it check if an existing @@ -9487,29 +9646,32 @@ contains private data only. + glib:nick="can-override-app-id" + glib:name="G_APPLICATION_CAN_OVERRIDE_APP_ID"> Allow users to override the + line="1502">Allow users to override the application ID from the command line with `--gapplication-app-id`. Since: 2.48 + glib:nick="allow-replacement" + glib:name="G_APPLICATION_ALLOW_REPLACEMENT"> Allow another instance to take over + line="1505">Allow another instance to take over the bus name. Since: 2.60 + glib:nick="replace" + glib:name="G_APPLICATION_REPLACE"> Take over from another instance. This flag is + line="1507">Take over from another instance. This flag is usually set by passing `--gapplication-replace` on the commandline. Since: 2.60 @@ -9531,7 +9693,8 @@ situation. + glib:nick="need-password" + glib:name="G_ASK_PASSWORD_NEED_PASSWORD"> operation requires a password. @@ -9539,7 +9702,8 @@ situation. + glib:nick="need-username" + glib:name="G_ASK_PASSWORD_NEED_USERNAME"> operation requires a username. @@ -9547,7 +9711,8 @@ situation. + glib:nick="need-domain" + glib:name="G_ASK_PASSWORD_NEED_DOMAIN"> operation requires a domain. @@ -9555,7 +9720,8 @@ situation. + glib:nick="saving-supported" + glib:name="G_ASK_PASSWORD_SAVING_SUPPORTED"> operation supports saving settings. @@ -9563,7 +9729,8 @@ situation. + glib:nick="anonymous-supported" + glib:name="G_ASK_PASSWORD_ANONYMOUS_SUPPORTED"> operation supports anonymous users. @@ -9571,7 +9738,8 @@ situation. + glib:nick="tcrypt" + glib:name="G_ASK_PASSWORD_TCRYPT"> operation takes TCRYPT parameters (Since: 2.58) @@ -9586,7 +9754,7 @@ situation. glib:type-struct="AsyncInitableIface"> This is the asynchronous version of #GInitable; it behaves the same + line="5183">This is the asynchronous version of #GInitable; it behaves the same in all ways except that initialization is asynchronous. For more details see the descriptions on #GInitable. @@ -9692,7 +9860,7 @@ foo_async_initable_iface_init (gpointer g_iface, introspectable="0"> Helper function for constructing #GAsyncInitable object. This is + line="12982">Helper function for constructing #GAsyncInitable object. This is similar to g_object_new() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -9706,13 +9874,13 @@ for any errors. a #GType supporting #GAsyncInitable. + line="12984">a #GType supporting #GAsyncInitable. the [I/O priority][io-priority] of the operation + line="12985">the [I/O priority][io-priority] of the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="12986">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the initialization is + line="12987">a #GAsyncReadyCallback to call when the initialization is finished @@ -9742,7 +9910,7 @@ for any errors. allow-none="1"> the data to pass to callback function + line="12989">the data to pass to callback function allow-none="1"> the name of the first property, or %NULL if no + line="12990">the name of the first property, or %NULL if no properties the value of the first property, followed by other property + line="12992">the value of the first property, followed by other property value pairs, and ended by %NULL. @@ -9770,7 +9938,7 @@ for any errors. introspectable="0"> Helper function for constructing #GAsyncInitable object. This is + line="13021">Helper function for constructing #GAsyncInitable object. This is similar to g_object_new_valist() but also initializes the object asynchronously. @@ -9785,26 +9953,26 @@ for any errors. a #GType supporting #GAsyncInitable. + line="13023">a #GType supporting #GAsyncInitable. the name of the first property, followed by + line="13024">the name of the first property, followed by the value, and other property value pairs, and ended by %NULL. The var args list generated from @first_property_name. + line="13026">The var args list generated from @first_property_name. the [I/O priority][io-priority] of the operation + line="13027">the [I/O priority][io-priority] of the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="13028">optional #GCancellable object, %NULL to ignore. closure="6"> a #GAsyncReadyCallback to call when the initialization is + line="13029">a #GAsyncReadyCallback to call when the initialization is finished @@ -9834,7 +10002,7 @@ the value, and other property value pairs, and ended by %NULL. allow-none="1"> the data to pass to callback function + line="13031">the data to pass to callback function @@ -9846,7 +10014,7 @@ the value, and other property value pairs, and ended by %NULL. deprecated-version="2.54"> Helper function for constructing #GAsyncInitable object. This is + line="13045">Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -9862,25 +10030,25 @@ g_async_initable_init_async() instead. See #GParameter for more information. a #GType supporting #GAsyncInitable. + line="13047">a #GType supporting #GAsyncInitable. the number of parameters in @parameters + line="13048">the number of parameters in @parameters the parameters to use to construct the object + line="13049">the parameters to use to construct the object the [I/O priority][io-priority] of the operation + line="13050">the [I/O priority][io-priority] of the operation optional #GCancellable object, %NULL to ignore. + line="13051">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the initialization is + line="13052">a #GAsyncReadyCallback to call when the initialization is finished @@ -9910,7 +10078,7 @@ g_async_initable_init_async() instead. See #GParameter for more information. the data to pass to callback function + line="13054">the data to pass to callback function @@ -9918,7 +10086,7 @@ g_async_initable_init_async() instead. See #GParameter for more information. Starts asynchronous initialization of the object implementing the + line="12917">Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead. @@ -9962,13 +10130,13 @@ any interface methods. a #GAsyncInitable. + line="12919">a #GAsyncInitable. the [I/O priority][io-priority] of the operation + line="12920">the [I/O priority][io-priority] of the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="12921">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="12922">a #GAsyncReadyCallback to call when the request is satisfied closure="3"> the data to pass to callback function + line="12923">the data to pass to callback function @@ -10009,13 +10177,13 @@ any interface methods. throws="1"> Finishes asynchronous initialization and returns the result. + line="12966">Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). %TRUE if successful. If an error has occurred, this function + line="12976">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -10023,13 +10191,13 @@ will return %FALSE and set @error appropriately if present. a #GAsyncInitable. + line="12968">a #GAsyncInitable. a #GAsyncResult. + line="12969">a #GAsyncResult. @@ -10039,7 +10207,7 @@ will return %FALSE and set @error appropriately if present. version="2.22"> Starts asynchronous initialization of the object implementing the + line="12917">Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead. @@ -10083,13 +10251,13 @@ any interface methods. a #GAsyncInitable. + line="12919">a #GAsyncInitable. the [I/O priority][io-priority] of the operation + line="12920">the [I/O priority][io-priority] of the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="12921">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="12922">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="12923">the data to pass to callback function @@ -10129,13 +10297,13 @@ any interface methods. throws="1"> Finishes asynchronous initialization and returns the result. + line="12966">Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). %TRUE if successful. If an error has occurred, this function + line="12976">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -10143,13 +10311,13 @@ will return %FALSE and set @error appropriately if present. a #GAsyncInitable. + line="12968">a #GAsyncInitable. a #GAsyncResult. + line="12969">a #GAsyncResult. @@ -10160,13 +10328,13 @@ will return %FALSE and set @error appropriately if present. throws="1"> Finishes the async construction for the various g_async_initable_new + line="13006">Finishes the async construction for the various g_async_initable_new calls, returning the created object or %NULL on error. a newly created #GObject, + line="13015">a newly created #GObject, or %NULL on error. Free with g_object_unref(). @@ -10174,13 +10342,13 @@ calls, returning the created object or %NULL on error. the #GAsyncInitable from the callback + line="13008">the #GAsyncInitable from the callback the #GAsyncResult from the callback + line="13009">the #GAsyncResult from the callback @@ -10211,13 +10379,13 @@ initialization may fail. a #GAsyncInitable. + line="12919">a #GAsyncInitable. the [I/O priority][io-priority] of the operation + line="12920">the [I/O priority][io-priority] of the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="12921">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="12922">a #GAsyncReadyCallback to call when the request is satisfied closure="4"> the data to pass to callback function + line="12923">the data to pass to callback function @@ -10259,7 +10427,7 @@ initialization may fail. %TRUE if successful. If an error has occurred, this function + line="12976">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -10267,13 +10435,13 @@ will return %FALSE and set @error appropriately if present. a #GAsyncInitable. + line="12968">a #GAsyncInitable. a #GAsyncResult. + line="12969">a #GAsyncResult. @@ -10290,8 +10458,12 @@ iteration of the [thread-default main context][g-main-context-push-thread-default] where the #GTask was created. All other users of #GAsyncReadyCallback must likewise call it asynchronously in a -later iteration of the main context. - +later iteration of the main context. + +The asynchronous operation is guaranteed to have held a reference to +@source_object from the time when the `*_async()` function was called, until +after this callback returns. + @@ -10331,7 +10503,7 @@ later iteration of the main context. glib:type-struct="AsyncResultIface"> Provides a base class for implementing asynchronous function results. + line="5291">Provides a base class for implementing asynchronous function results. Asynchronous operations are broken up into two separate operations which are chained together by a #GAsyncReadyCallback. To begin @@ -10419,12 +10591,12 @@ as a default. Gets the source object from a #GAsyncResult. + line="13069">Gets the source object from a #GAsyncResult. a new reference to the source + line="13075">a new reference to the source object for the @res, or %NULL if there is none. @@ -10432,7 +10604,7 @@ as a default. a #GAsyncResult + line="13071">a #GAsyncResult @@ -10440,19 +10612,19 @@ as a default. Gets the user data from a #GAsyncResult. + line="13080">Gets the user data from a #GAsyncResult. the user data for @res. + line="13086">the user data for @res. a #GAsyncResult. + line="13082">a #GAsyncResult. @@ -10460,13 +10632,13 @@ as a default. Checks if @res has the given @source_tag (generally a function + line="13090">Checks if @res has the given @source_tag (generally a function pointer indicating the function @res was created by). %TRUE if @res has the indicated @source_tag, %FALSE if + line="13098">%TRUE if @res has the indicated @source_tag, %FALSE if not. @@ -10474,7 +10646,7 @@ pointer indicating the function @res was created by). a #GAsyncResult + line="13092">a #GAsyncResult allow-none="1"> an application-defined tag + line="13093">an application-defined tag @@ -10492,12 +10664,12 @@ pointer indicating the function @res was created by). c:identifier="g_async_result_get_source_object"> Gets the source object from a #GAsyncResult. + line="13069">Gets the source object from a #GAsyncResult. a new reference to the source + line="13075">a new reference to the source object for the @res, or %NULL if there is none. @@ -10505,7 +10677,7 @@ pointer indicating the function @res was created by). a #GAsyncResult + line="13071">a #GAsyncResult @@ -10513,19 +10685,19 @@ pointer indicating the function @res was created by). Gets the user data from a #GAsyncResult. + line="13080">Gets the user data from a #GAsyncResult. the user data for @res. + line="13086">the user data for @res. a #GAsyncResult. + line="13082">a #GAsyncResult. @@ -10535,13 +10707,13 @@ pointer indicating the function @res was created by). version="2.34"> Checks if @res has the given @source_tag (generally a function + line="13090">Checks if @res has the given @source_tag (generally a function pointer indicating the function @res was created by). %TRUE if @res has the indicated @source_tag, %FALSE if + line="13098">%TRUE if @res has the indicated @source_tag, %FALSE if not. @@ -10549,7 +10721,7 @@ pointer indicating the function @res was created by). a #GAsyncResult + line="13092">a #GAsyncResult allow-none="1"> an application-defined tag + line="13093">an application-defined tag @@ -10569,7 +10741,7 @@ pointer indicating the function @res was created by). throws="1"> If @res is a #GSimpleAsyncResult, this is equivalent to + line="13104">If @res is a #GSimpleAsyncResult, this is equivalent to g_simple_async_result_propagate_error(). Otherwise it returns %FALSE. @@ -10583,7 +10755,7 @@ to enable subclasses to chain up correctly. %TRUE if @error is has been filled in with an error from + line="13120">%TRUE if @error is has been filled in with an error from @res, %FALSE if not. @@ -10591,7 +10763,7 @@ to enable subclasses to chain up correctly. a #GAsyncResult + line="13106">a #GAsyncResult @@ -10616,14 +10788,14 @@ to enable subclasses to chain up correctly. the user data for @res. + line="13086">the user data for @res. a #GAsyncResult. + line="13082">a #GAsyncResult. @@ -10635,7 +10807,7 @@ to enable subclasses to chain up correctly. a new reference to the source + line="13075">a new reference to the source object for the @res, or %NULL if there is none. @@ -10643,7 +10815,7 @@ to enable subclasses to chain up correctly. a #GAsyncResult + line="13071">a #GAsyncResult @@ -10655,7 +10827,7 @@ to enable subclasses to chain up correctly. %TRUE if @res has the indicated @source_tag, %FALSE if + line="13098">%TRUE if @res has the indicated @source_tag, %FALSE if not. @@ -10663,7 +10835,7 @@ to enable subclasses to chain up correctly. a #GAsyncResult + line="13092">a #GAsyncResult allow-none="1"> an application-defined tag + line="13093">an application-defined tag @@ -10751,7 +10923,7 @@ to enable subclasses to chain up correctly. glib:type-struct="BufferedInputStreamClass"> Buffered input stream implements #GFilterInputStream and provides + line="5384">Buffered input stream implements #GFilterInputStream and provides for buffered reads. By default, #GBufferedInputStream's buffer size is set at 4 kilobytes. @@ -10770,20 +10942,20 @@ cannot be reduced below the size of the data within the buffer. Creates a new #GInputStream from the given @base_stream, with + line="13213">Creates a new #GInputStream from the given @base_stream, with a buffer set to the default size (4 kilobytes). a #GInputStream for the given @base_stream. + line="13220">a #GInputStream for the given @base_stream. a #GInputStream + line="13215">a #GInputStream @@ -10792,26 +10964,26 @@ a buffer set to the default size (4 kilobytes). c:identifier="g_buffered_input_stream_new_sized"> Creates a new #GBufferedInputStream from the given @base_stream, + line="13224">Creates a new #GBufferedInputStream from the given @base_stream, with a buffer set to @size. a #GInputStream. + line="13232">a #GInputStream. a #GInputStream + line="13226">a #GInputStream a #gsize + line="13227">a #gsize @@ -10819,7 +10991,7 @@ with a buffer set to @size. Tries to read @count bytes from the stream into the buffer. + line="13126">Tries to read @count bytes from the stream into the buffer. Will block during this read. If @count is zero, returns zero and does nothing. A value of @count @@ -10847,7 +11019,7 @@ g_buffered_input_stream_fill_async(). the number of bytes read into @stream's buffer, up to @count, + line="13158">the number of bytes read into @stream's buffer, up to @count, or -1 on error. @@ -10855,13 +11027,13 @@ g_buffered_input_stream_fill_async(). a #GBufferedInputStream + line="13128">a #GBufferedInputStream the number of bytes that will be read from the stream + line="13129">the number of bytes that will be read from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore + line="13130">optional #GCancellable object, %NULL to ignore @@ -10878,7 +11050,7 @@ g_buffered_input_stream_fill_async(). Reads data into @stream's buffer asynchronously, up to @count size. + line="13163">Reads data into @stream's buffer asynchronously, up to @count size. @io_priority can be used to prioritize reads. For the synchronous version of this function, see g_buffered_input_stream_fill(). @@ -10892,19 +11064,19 @@ of bytes that are required to fill the buffer. a #GBufferedInputStream + line="13165">a #GBufferedInputStream the number of bytes that will be read from the stream + line="13166">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + line="13167">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object + line="13168">optional #GCancellable object closure="4"> a #GAsyncReadyCallback + line="13169">a #GAsyncReadyCallback closure="4"> a #gpointer + line="13170">a #gpointer @@ -10942,25 +11114,25 @@ of bytes that are required to fill the buffer. Finishes an asynchronous read. + line="13181">Finishes an asynchronous read. a #gssize of the read stream, or `-1` on an error. + line="13189">a #gssize of the read stream, or `-1` on an error. a #GBufferedInputStream + line="13183">a #GBufferedInputStream a #GAsyncResult + line="13184">a #GAsyncResult @@ -10970,7 +11142,7 @@ of bytes that are required to fill the buffer. throws="1"> Tries to read @count bytes from the stream into the buffer. + line="13126">Tries to read @count bytes from the stream into the buffer. Will block during this read. If @count is zero, returns zero and does nothing. A value of @count @@ -10998,7 +11170,7 @@ g_buffered_input_stream_fill_async(). the number of bytes read into @stream's buffer, up to @count, + line="13158">the number of bytes read into @stream's buffer, up to @count, or -1 on error. @@ -11006,13 +11178,13 @@ g_buffered_input_stream_fill_async(). a #GBufferedInputStream + line="13128">a #GBufferedInputStream the number of bytes that will be read from the stream + line="13129">the number of bytes that will be read from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore + line="13130">optional #GCancellable object, %NULL to ignore @@ -11030,7 +11202,7 @@ g_buffered_input_stream_fill_async(). c:identifier="g_buffered_input_stream_fill_async"> Reads data into @stream's buffer asynchronously, up to @count size. + line="13163">Reads data into @stream's buffer asynchronously, up to @count size. @io_priority can be used to prioritize reads. For the synchronous version of this function, see g_buffered_input_stream_fill(). @@ -11044,19 +11216,19 @@ of bytes that are required to fill the buffer. a #GBufferedInputStream + line="13165">a #GBufferedInputStream the number of bytes that will be read from the stream + line="13166">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + line="13167">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object + line="13168">optional #GCancellable object closure="4"> a #GAsyncReadyCallback + line="13169">a #GAsyncReadyCallback allow-none="1"> a #gpointer + line="13170">a #gpointer @@ -11095,25 +11267,25 @@ of bytes that are required to fill the buffer. throws="1"> Finishes an asynchronous read. + line="13181">Finishes an asynchronous read. a #gssize of the read stream, or `-1` on an error. + line="13189">a #gssize of the read stream, or `-1` on an error. a #GBufferedInputStream + line="13183">a #GBufferedInputStream a #GAsyncResult + line="13184">a #GAsyncResult @@ -11122,40 +11294,41 @@ of bytes that are required to fill the buffer. c:identifier="g_buffered_input_stream_get_available"> Gets the size of the available data within the stream. + line="13193">Gets the size of the available data within the stream. size of the available stream. + line="13199">size of the available stream. #GBufferedInputStream + line="13195">#GBufferedInputStream + c:identifier="g_buffered_input_stream_get_buffer_size" + glib:get-property="buffer-size"> Gets the size of the input buffer. + line="13203">Gets the size of the input buffer. the current buffer size. + line="13209">the current buffer size. a #GBufferedInputStream + line="13205">a #GBufferedInputStream @@ -11163,26 +11336,26 @@ of bytes that are required to fill the buffer. Peeks in the buffer, copying data of size @count into @buffer, + line="13236">Peeks in the buffer, copying data of size @count into @buffer, offset @offset bytes. a #gsize of the number of bytes peeked, or -1 on error. + line="13247">a #gsize of the number of bytes peeked, or -1 on error. a #GBufferedInputStream + line="13238">a #GBufferedInputStream a pointer to + line="13239">a pointer to an allocated chunk of memory @@ -11191,13 +11364,13 @@ offset @offset bytes. a #gsize + line="13241">a #gsize a #gsize + line="13242">a #gsize @@ -11206,14 +11379,14 @@ offset @offset bytes. c:identifier="g_buffered_input_stream_peek_buffer"> Returns the buffer with the currently available bytes. The returned + line="13251">Returns the buffer with the currently available bytes. The returned buffer must not be modified and will become invalid when reading from the stream or filling the buffer. + line="13260"> read-only buffer @@ -11223,7 +11396,7 @@ the stream or filling the buffer. a #GBufferedInputStream + line="13253">a #GBufferedInputStream transfer-ownership="full"> a #gsize to get the number of bytes available in the buffer + line="13254">a #gsize to get the number of bytes available in the buffer @@ -11242,7 +11415,7 @@ the stream or filling the buffer. throws="1"> Tries to read a single byte from the stream or the buffer. Will block + line="13265">Tries to read a single byte from the stream or the buffer. Will block during this read. On success, the byte read from the stream is returned. On end of stream @@ -11259,14 +11432,14 @@ On error -1 is returned and @error is set accordingly. the byte read from the @stream, or -1 on end of stream or error. + line="13285">the byte read from the @stream, or -1 on end of stream or error. a #GBufferedInputStream + line="13267">a #GBufferedInputStream allow-none="1"> optional #GCancellable object, %NULL to ignore + line="13268">optional #GCancellable object, %NULL to ignore + c:identifier="g_buffered_input_stream_set_buffer_size" + glib:set-property="buffer-size"> Sets the size of the internal buffer of @stream to @size, or to the + line="13289">Sets the size of the internal buffer of @stream to @size, or to the size of the contents of the buffer. The buffer can never be resized smaller than its current contents. @@ -11295,13 +11469,13 @@ smaller than its current contents. a #GBufferedInputStream + line="13291">a #GBufferedInputStream a #gsize + line="13292">a #gsize @@ -11309,7 +11483,9 @@ smaller than its current contents. + transfer-ownership="none" + setter="set_buffer_size" + getter="get_buffer_size"> @@ -11333,7 +11509,7 @@ smaller than its current contents. the number of bytes read into @stream's buffer, up to @count, + line="13158">the number of bytes read into @stream's buffer, up to @count, or -1 on error. @@ -11341,13 +11517,13 @@ smaller than its current contents. a #GBufferedInputStream + line="13128">a #GBufferedInputStream the number of bytes that will be read from the stream + line="13129">the number of bytes that will be read from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore + line="13130">optional #GCancellable object, %NULL to ignore @@ -11372,19 +11548,19 @@ smaller than its current contents. a #GBufferedInputStream + line="13165">a #GBufferedInputStream the number of bytes that will be read from the stream + line="13166">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + line="13167">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object + line="13168">optional #GCancellable object closure="5"> a #GAsyncReadyCallback + line="13169">a #GAsyncReadyCallback closure="5"> a #gpointer + line="13170">a #gpointer @@ -11426,20 +11602,20 @@ smaller than its current contents. a #gssize of the read stream, or `-1` on an error. + line="13189">a #gssize of the read stream, or `-1` on an error. a #GBufferedInputStream + line="13183">a #GBufferedInputStream a #GAsyncResult + line="13184">a #GAsyncResult @@ -11500,7 +11676,7 @@ smaller than its current contents. glib:type-struct="BufferedOutputStreamClass"> Buffered output stream implements #GFilterOutputStream and provides + line="5407">Buffered output stream implements #GFilterOutputStream and provides for buffered writes. By default, #GBufferedOutputStream's buffer size is set at 4 kilobytes. @@ -11519,19 +11695,19 @@ size cannot be reduced below the size of the data within the buffer. Creates a new buffered output stream for a base stream. + line="13321">Creates a new buffered output stream for a base stream. a #GOutputStream for the given @base_stream. + line="13327">a #GOutputStream for the given @base_stream. a #GOutputStream. + line="13323">a #GOutputStream. @@ -11540,39 +11716,40 @@ size cannot be reduced below the size of the data within the buffer. c:identifier="g_buffered_output_stream_new_sized"> Creates a new buffered output stream with a given buffer size. + line="13331">Creates a new buffered output stream with a given buffer size. a #GOutputStream with an internal buffer set to @size. + line="13338">a #GOutputStream with an internal buffer set to @size. a #GOutputStream. + line="13333">a #GOutputStream. a #gsize. + line="13334">a #gsize. + c:identifier="g_buffered_output_stream_get_auto_grow" + glib:get-property="auto-grow"> Checks if the buffer automatically grows as data is added. + line="13300">Checks if the buffer automatically grows as data is added. %TRUE if the @stream's buffer automatically grows, + line="13306">%TRUE if the @stream's buffer automatically grows, %FALSE otherwise. @@ -11580,37 +11757,39 @@ size cannot be reduced below the size of the data within the buffer. a #GBufferedOutputStream. + line="13302">a #GBufferedOutputStream. + c:identifier="g_buffered_output_stream_get_buffer_size" + glib:get-property="buffer-size"> Gets the size of the buffer in the @stream. + line="13311">Gets the size of the buffer in the @stream. the current size of the buffer. + line="13317">the current size of the buffer. a #GBufferedOutputStream. + line="13313">a #GBufferedOutputStream. + c:identifier="g_buffered_output_stream_set_auto_grow" + glib:set-property="auto-grow"> Sets whether or not the @stream's buffer should automatically grow. + line="13342">Sets whether or not the @stream's buffer should automatically grow. If @auto_grow is true, then each write will just make the buffer larger, and you must manually flush the buffer to actually write out the data to the underlying stream. @@ -11622,22 +11801,23 @@ the data to the underlying stream. a #GBufferedOutputStream. + line="13344">a #GBufferedOutputStream. a #gboolean. + line="13345">a #gboolean. + c:identifier="g_buffered_output_stream_set_buffer_size" + glib:set-property="buffer-size"> Sets the size of the internal buffer to @size. + line="13354">Sets the size of the internal buffer to @size. @@ -11646,24 +11826,30 @@ the data to the underlying stream. a #GBufferedOutputStream. + line="13356">a #GBufferedOutputStream. a #gsize. + line="13357">a #gsize. - + + transfer-ownership="none" + setter="set_buffer_size" + getter="get_buffer_size"> @@ -11862,7 +12048,8 @@ the connection was disconnected. + glib:nick="none" + glib:name="G_BUS_NAME_OWNER_FLAGS_NONE"> No flags set. @@ -11870,7 +12057,8 @@ the connection was disconnected. + glib:nick="allow-replacement" + glib:name="G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT"> Allow another message bus connection to claim the name. @@ -11878,7 +12066,8 @@ the connection was disconnected. + glib:nick="replace" + glib:name="G_BUS_NAME_OWNER_FLAGS_REPLACE"> If another message bus connection owns the name and have @@ -11887,7 +12076,8 @@ specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the + glib:nick="do-not-queue" + glib:name="G_BUS_NAME_OWNER_FLAGS_DO_NOT_QUEUE"> If another message bus connection owns the name, immediately @@ -11945,7 +12135,8 @@ established has been closed. In that case, @connection will be + glib:nick="none" + glib:name="G_BUS_NAME_WATCHER_FLAGS_NONE"> No flags set. @@ -11953,7 +12144,8 @@ established has been closed. In that case, @connection will be + glib:nick="auto-start" + glib:name="G_BUS_NAME_WATCHER_FLAGS_AUTO_START"> If no-one owns the name when @@ -11972,7 +12164,8 @@ name. + glib:nick="starter" + glib:name="G_BUS_TYPE_STARTER"> An alias for the message bus that activated the process, if any. @@ -11980,7 +12173,8 @@ name. + glib:nick="none" + glib:name="G_BUS_TYPE_NONE"> Not a message bus. @@ -11988,7 +12182,8 @@ name. + glib:nick="system" + glib:name="G_BUS_TYPE_SYSTEM"> The system-wide message bus. @@ -11996,7 +12191,8 @@ name. + glib:nick="session" + glib:name="G_BUS_TYPE_SESSION"> The login session message bus. @@ -12011,49 +12207,53 @@ name. glib:get-type="g_bytes_icon_get_type"> #GBytesIcon specifies an image held in memory in a common format (usually + line="5430">#GBytesIcon specifies an image held in memory in a common format (usually png) to be used as icon. Creates a new icon for a bytes. + line="13708">Creates a new icon for a bytes. + +This cannot fail, but loading and interpreting the bytes may fail later on +(for example, if g_loadable_icon_load() is called) if the image is invalid. a #GIcon for the given - @bytes, or %NULL on error. + line="13717">a #GIcon for the given + @bytes. a #GBytes. + line="13710">a #GBytes. Gets the #GBytes associated with the given @icon. + line="13697">Gets the #GBytes associated with the given @icon. a #GBytes, or %NULL. + line="13703">a #GBytes. a #GIcon. + line="13699">a #GIcon. @@ -12061,7 +12261,8 @@ png) to be used as icon. + transfer-ownership="none" + getter="get_bytes"> The bytes containing the icon. @@ -12230,14 +12431,14 @@ png) to be used as icon. glib:type-struct="CancellableClass"> GCancellable is a thread-safe operation cancellation stack used + line="5443">GCancellable is a thread-safe operation cancellation stack used throughout GIO to allow for cancellation of synchronous and asynchronous operations. Creates a new #GCancellable object. + line="13876">Creates a new #GCancellable object. Applications that want to start one or more operations that should be cancellable should create a #GCancellable @@ -12249,19 +12450,19 @@ operations or in multiple concurrent operations. a #GCancellable. + line="13888">a #GCancellable. Gets the top cancellable from the stack. + line="13802">Gets the top cancellable from the stack. a #GCancellable from the top + line="13807">a #GCancellable from the top of the stack, or %NULL if the stack is empty. @@ -12283,7 +12484,7 @@ of the stack, or %NULL if the stack is empty. Will set @cancellable to cancelled, and will emit the + line="13723">Will set @cancellable to cancelled, and will emit the #GCancellable::cancelled signal. (However, see the warning about race conditions in the documentation for that signal if you are planning to connect to it.) @@ -12310,7 +12511,7 @@ the application returns to the main loop. allow-none="1"> a #GCancellable object. + line="13725">a #GCancellable object. @@ -12320,7 +12521,7 @@ the application returns to the main loop. version="2.22"> Convenience function to connect to the #GCancellable::cancelled + line="13746">Convenience function to connect to the #GCancellable::cancelled signal. Also handles the race condition that may happen if the cancellable is cancelled right before connecting. @@ -12342,7 +12543,7 @@ code that unconditionally invokes e.g. g_cancellable_cancel(). The id of the signal handler or 0 if @cancellable has already + line="13772">The id of the signal handler or 0 if @cancellable has already been cancelled. @@ -12353,7 +12554,7 @@ code that unconditionally invokes e.g. g_cancellable_cancel(). allow-none="1"> A #GCancellable. + line="13748">A #GCancellable. destroy="2"> The #GCallback to connect. + line="13749">The #GCallback to connect. allow-none="1"> Data to pass to @callback. + line="13750">Data to pass to @callback. scope="async"> Free function for @data or %NULL. + line="13751">Free function for @data or %NULL. @@ -12392,7 +12593,7 @@ code that unconditionally invokes e.g. g_cancellable_cancel(). version="2.22"> Disconnects a handler from a cancellable instance similar to + line="13778">Disconnects a handler from a cancellable instance similar to g_signal_handler_disconnect(). Additionally, in the event that a signal handler is currently running, this call will block until the handler has finished. Calling this function from a @@ -12417,13 +12618,13 @@ nothing. allow-none="1"> A #GCancellable or %NULL. + line="13780">A #GCancellable or %NULL. Handler id of the handler to be disconnected, or `0`. + line="13781">Handler id of the handler to be disconnected, or `0`. @@ -12431,7 +12632,7 @@ nothing. Gets the file descriptor for a cancellable job. This can be used to + line="13812">Gets the file descriptor for a cancellable job. This can be used to implement cancellable operations on Unix systems. The returned fd will turn readable when @cancellable is cancelled. @@ -12448,7 +12649,7 @@ See also g_cancellable_make_pollfd(). A valid file descriptor. `-1` if the file descriptor + line="13830">A valid file descriptor. `-1` if the file descriptor is not supported, or on errors. @@ -12459,7 +12660,7 @@ is not supported, or on errors. allow-none="1"> a #GCancellable. + line="13814">a #GCancellable. @@ -12467,12 +12668,12 @@ is not supported, or on errors. Checks if a cancellable job has been cancelled. + line="13835">Checks if a cancellable job has been cancelled. %TRUE if @cancellable is cancelled, + line="13841">%TRUE if @cancellable is cancelled, FALSE if called with %NULL or if item is not cancelled. @@ -12483,7 +12684,7 @@ FALSE if called with %NULL or if item is not cancelled. allow-none="1"> a #GCancellable or %NULL + line="13837">a #GCancellable or %NULL @@ -12493,7 +12694,7 @@ FALSE if called with %NULL or if item is not cancelled. version="2.22"> Creates a #GPollFD corresponding to @cancellable; this can be passed + line="13846">Creates a #GPollFD corresponding to @cancellable; this can be passed to g_poll() and used to poll for cancellation. This is useful both for unix systems without a native poll and for portability to windows. @@ -12515,7 +12716,7 @@ with g_cancellable_reset(). %TRUE if @pollfd was successfully initialized, %FALSE on + line="13870">%TRUE if @pollfd was successfully initialized, %FALSE on failure to prepare the cancellable. @@ -12526,13 +12727,13 @@ with g_cancellable_reset(). allow-none="1"> a #GCancellable or %NULL + line="13848">a #GCancellable or %NULL a pointer to a #GPollFD + line="13849">a pointer to a #GPollFD @@ -12540,7 +12741,7 @@ with g_cancellable_reset(). Pops @cancellable off the cancellable stack (verifying that @cancellable + line="13892">Pops @cancellable off the cancellable stack (verifying that @cancellable is on the top of the stack). @@ -12553,7 +12754,7 @@ is on the top of the stack). allow-none="1"> a #GCancellable object + line="13894">a #GCancellable object @@ -12561,7 +12762,7 @@ is on the top of the stack). Pushes @cancellable onto the cancellable stack. The current + line="13901">Pushes @cancellable onto the cancellable stack. The current cancellable can then be received using g_cancellable_get_current(). This is useful when implementing cancellable operations in @@ -12580,7 +12781,7 @@ so you rarely have to call this yourself. allow-none="1"> a #GCancellable object + line="13903">a #GCancellable object @@ -12590,7 +12791,7 @@ so you rarely have to call this yourself. version="2.22"> Releases a resources previously allocated by g_cancellable_get_fd() + line="13916">Releases a resources previously allocated by g_cancellable_get_fd() or g_cancellable_make_pollfd(). For compatibility reasons with older releases, calling this function @@ -12610,7 +12811,7 @@ descriptors when many #GCancellables are used at the same time. allow-none="1"> a #GCancellable + line="13918">a #GCancellable @@ -12618,7 +12819,7 @@ descriptors when many #GCancellables are used at the same time. Resets @cancellable to its uncancelled state. + line="13934">Resets @cancellable to its uncancelled state. If cancellable is currently in use by any cancellable operation then the behavior of this function is undefined. @@ -12640,7 +12841,7 @@ create a fresh cancellable for further async operations. allow-none="1"> a #GCancellable object. + line="13936">a #GCancellable object. @@ -12650,13 +12851,13 @@ create a fresh cancellable for further async operations. throws="1"> If the @cancellable is cancelled, sets the error to notify + line="13952">If the @cancellable is cancelled, sets the error to notify that the operation was cancelled. %TRUE if @cancellable was cancelled, %FALSE if it was not + line="13960">%TRUE if @cancellable was cancelled, %FALSE if it was not @@ -12666,7 +12867,7 @@ that the operation was cancelled. allow-none="1"> a #GCancellable or %NULL + line="13954">a #GCancellable or %NULL @@ -12676,7 +12877,7 @@ that the operation was cancelled. version="2.28"> Creates a source that triggers if @cancellable is cancelled and + line="13964">Creates a source that triggers if @cancellable is cancelled and calls its callback of type #GCancellableSourceFunc. This is primarily useful for attaching to another (non-cancellable) source with g_source_add_child_source() to add cancellability to it. @@ -12689,7 +12890,7 @@ The new #GSource will hold a reference to the #GCancellable. the new #GSource. + line="13978">the new #GSource. @@ -12699,7 +12900,7 @@ The new #GSource will hold a reference to the #GCancellable. allow-none="1"> a #GCancellable, or %NULL + line="13966">a #GCancellable, or %NULL @@ -12843,13 +13044,13 @@ cancellable signal should not do something that can block. version="2.28"> This is the function type of the callback used for the #GSource + line="571">This is the function type of the callback used for the #GSource returned by g_cancellable_source_new(). - + it should return %FALSE if the source should be removed. + line="579">it should return %FALSE if the source should be removed. @@ -12859,7 +13060,7 @@ returned by g_cancellable_source_new(). allow-none="1"> the #GCancellable + line="573">the #GCancellable closure="1"> data passed in by the user. + line="574">data passed in by the user. @@ -12883,7 +13084,7 @@ returned by g_cancellable_source_new(). glib:type-struct="CharsetConverterClass"> #GCharsetConverter is an implementation of #GConverter based on + line="5454">#GCharsetConverter is an implementation of #GConverter based on GIConv. @@ -12894,25 +13095,25 @@ GIConv. throws="1"> Creates a new #GCharsetConverter. + line="14005">Creates a new #GCharsetConverter. a new #GCharsetConverter or %NULL on error. + line="14013">a new #GCharsetConverter or %NULL on error. destination charset + line="14007">destination charset source charset + line="14008">source charset @@ -12922,51 +13123,53 @@ GIConv. version="2.24"> Gets the number of fallbacks that @converter has applied so far. + line="13983">Gets the number of fallbacks that @converter has applied so far. the number of fallbacks that @converter has applied + line="13989">the number of fallbacks that @converter has applied a #GCharsetConverter + line="13985">a #GCharsetConverter Gets the #GCharsetConverter:use-fallback property. + line="13994">Gets the #GCharsetConverter:use-fallback property. %TRUE if fallbacks are used by @converter + line="14000">%TRUE if fallbacks are used by @converter a #GCharsetConverter + line="13996">a #GCharsetConverter Sets the #GCharsetConverter:use-fallback property. + line="14018">Sets the #GCharsetConverter:use-fallback property. @@ -12975,13 +13178,13 @@ GIConv. a #GCharsetConverter + line="14020">a #GCharsetConverter %TRUE to use fallbacks + line="14021">%TRUE to use fallbacks @@ -13001,7 +13204,9 @@ GIConv. + transfer-ownership="none" + setter="set_use_fallback" + getter="get_use_fallback"> @@ -13022,7 +13227,7 @@ GIConv. glib:type-struct="ConverterIface"> #GConverter is implemented by objects that convert + line="5481">#GConverter is implemented by objects that convert binary data in various ways. The conversion can be stateful and may fail at any place. @@ -13036,7 +13241,7 @@ replace. throws="1"> This is the main operation used when converting data. It is to be called + line="14265">This is the main operation used when converting data. It is to be called multiple times in a loop, and each time it will do some work, i.e. producing some output (in @outbuf) or consuming some input (from @inbuf) or both. If its not possible to do any work an error is returned. @@ -13122,14 +13327,14 @@ to produce as much output as possible and then return an error a #GConverterResult, %G_CONVERTER_ERROR on error. + line="14362">a #GConverterResult, %G_CONVERTER_ERROR on error. a #GConverter. + line="14267">a #GConverter. the buffer + line="14268">the buffer containing the data to convert. @@ -13147,7 +13352,7 @@ to produce as much output as possible and then return an error the number of bytes in @inbuf + line="14270">the number of bytes in @inbuf a buffer to write + line="14271">a buffer to write converted data in. @@ -13165,13 +13370,13 @@ to produce as much output as possible and then return an error the number of bytes in @outbuf, must be at least one + line="14273">the number of bytes in @outbuf, must be at least one a #GConverterFlags controlling the conversion details + line="14274">a #GConverterFlags controlling the conversion details will be set to the number of bytes read from @inbuf on success + line="14275">will be set to the number of bytes read from @inbuf on success will be set to the number of bytes written to @outbuf on success + line="14276">will be set to the number of bytes written to @outbuf on success @@ -13197,7 +13402,7 @@ to produce as much output as possible and then return an error Resets all internal state in the converter, making it behave + line="14411">Resets all internal state in the converter, making it behave as if it was just created. If the converter has any internal state that would produce output then that output is lost. @@ -13208,7 +13413,7 @@ state that would produce output then that output is lost. a #GConverter. + line="14413">a #GConverter. @@ -13219,7 +13424,7 @@ state that would produce output then that output is lost. throws="1"> This is the main operation used when converting data. It is to be called + line="14265">This is the main operation used when converting data. It is to be called multiple times in a loop, and each time it will do some work, i.e. producing some output (in @outbuf) or consuming some input (from @inbuf) or both. If its not possible to do any work an error is returned. @@ -13305,20 +13510,20 @@ to produce as much output as possible and then return an error a #GConverterResult, %G_CONVERTER_ERROR on error. + line="14362">a #GConverterResult, %G_CONVERTER_ERROR on error. a #GConverter. + line="14267">a #GConverter. the buffer + line="14268">the buffer containing the data to convert. @@ -13327,13 +13532,13 @@ to produce as much output as possible and then return an error the number of bytes in @inbuf + line="14270">the number of bytes in @inbuf a buffer to write + line="14271">a buffer to write converted data in. @@ -13342,13 +13547,13 @@ to produce as much output as possible and then return an error the number of bytes in @outbuf, must be at least one + line="14273">the number of bytes in @outbuf, must be at least one a #GConverterFlags controlling the conversion details + line="14274">a #GConverterFlags controlling the conversion details will be set to the number of bytes read from @inbuf on success + line="14275">will be set to the number of bytes read from @inbuf on success will be set to the number of bytes written to @outbuf on success + line="14276">will be set to the number of bytes written to @outbuf on success @@ -13374,7 +13579,7 @@ to produce as much output as possible and then return an error Resets all internal state in the converter, making it behave + line="14411">Resets all internal state in the converter, making it behave as if it was just created. If the converter has any internal state that would produce output then that output is lost. @@ -13385,7 +13590,7 @@ state that would produce output then that output is lost. a #GConverter. + line="14413">a #GConverter. @@ -13402,7 +13607,8 @@ state that would produce output then that output is lost. + glib:nick="none" + glib:name="G_CONVERTER_NO_FLAGS"> No flags. @@ -13410,7 +13616,8 @@ state that would produce output then that output is lost. + glib:nick="input-at-end" + glib:name="G_CONVERTER_INPUT_AT_END"> At end of input data @@ -13418,7 +13625,8 @@ state that would produce output then that output is lost. + glib:nick="flush" + glib:name="G_CONVERTER_FLUSH"> Flush data @@ -13446,14 +13654,14 @@ and may fail at any place. a #GConverterResult, %G_CONVERTER_ERROR on error. + line="14362">a #GConverterResult, %G_CONVERTER_ERROR on error. a #GConverter. + line="14267">a #GConverter. allow-none="1"> the buffer + line="14268">the buffer containing the data to convert. @@ -13471,7 +13679,7 @@ and may fail at any place. the number of bytes in @inbuf + line="14270">the number of bytes in @inbuf allow-none="1"> a buffer to write + line="14271">a buffer to write converted data in. @@ -13489,13 +13697,13 @@ and may fail at any place. the number of bytes in @outbuf, must be at least one + line="14273">the number of bytes in @outbuf, must be at least one a #GConverterFlags controlling the conversion details + line="14274">a #GConverterFlags controlling the conversion details transfer-ownership="full"> will be set to the number of bytes read from @inbuf on success + line="14275">will be set to the number of bytes read from @inbuf on success transfer-ownership="full"> will be set to the number of bytes written to @outbuf on success + line="14276">will be set to the number of bytes written to @outbuf on success @@ -13529,7 +13737,7 @@ and may fail at any place. a #GConverter. + line="14413">a #GConverter. @@ -13545,7 +13753,7 @@ and may fail at any place. glib:type-struct="ConverterInputStreamClass"> Converter input stream implements #GInputStream and allows + line="5499">Converter input stream implements #GInputStream and allows conversion of data of various types during reading. As of GLib 2.34, #GConverterInputStream implements @@ -13555,40 +13763,41 @@ As of GLib 2.34, #GConverterInputStream implements Creates a new converter input stream for the @base_stream. + line="14378">Creates a new converter input stream for the @base_stream. a new #GInputStream. + line="14385">a new #GInputStream. a #GInputStream + line="14380">a #GInputStream a #GConverter + line="14381">a #GConverter Gets the #GConverter that is used by @converter_stream. + line="14367">Gets the #GConverter that is used by @converter_stream. the converter of the converter input stream + line="14373">the converter of the converter input stream @@ -13596,7 +13805,7 @@ As of GLib 2.34, #GConverterInputStream implements transfer-ownership="none"> a #GConverterInputStream + line="14369">a #GConverterInputStream @@ -13604,7 +13813,8 @@ As of GLib 2.34, #GConverterInputStream implements + transfer-ownership="none" + getter="get_converter"> @@ -13677,7 +13887,7 @@ As of GLib 2.34, #GConverterInputStream implements glib:type-struct="ConverterOutputStreamClass"> Converter output stream implements #GOutputStream and allows + line="5513">Converter output stream implements #GOutputStream and allows conversion of data of various types during reading. As of GLib 2.34, #GConverterOutputStream implements @@ -13687,40 +13897,41 @@ As of GLib 2.34, #GConverterOutputStream implements Creates a new converter output stream for the @base_stream. + line="14400">Creates a new converter output stream for the @base_stream. a new #GOutputStream. + line="14407">a new #GOutputStream. a #GOutputStream + line="14402">a #GOutputStream a #GConverter + line="14403">a #GConverter Gets the #GConverter that is used by @converter_stream. + line="14389">Gets the #GConverter that is used by @converter_stream. the converter of the converter output stream + line="14395">the converter of the converter output stream @@ -13728,7 +13939,7 @@ As of GLib 2.34, #GConverterOutputStream implements transfer-ownership="none"> a #GConverterOutputStream + line="14391">a #GConverterOutputStream @@ -13737,7 +13948,8 @@ As of GLib 2.34, #GConverterOutputStream implements + transfer-ownership="none" + getter="get_converter"> @@ -13813,7 +14025,8 @@ As of GLib 2.34, #GConverterOutputStream implements + glib:nick="error" + glib:name="G_CONVERTER_ERROR"> There was an error during conversion. @@ -13821,7 +14034,8 @@ As of GLib 2.34, #GConverterOutputStream implements + glib:nick="converted" + glib:name="G_CONVERTER_CONVERTED"> Some data was consumed or produced @@ -13829,7 +14043,8 @@ As of GLib 2.34, #GConverterOutputStream implements + glib:nick="finished" + glib:name="G_CONVERTER_FINISHED"> The conversion is finished @@ -13837,7 +14052,8 @@ As of GLib 2.34, #GConverterOutputStream implements + glib:nick="flushed" + glib:name="G_CONVERTER_FLUSHED"> Flushing is finished @@ -13853,7 +14069,7 @@ As of GLib 2.34, #GConverterOutputStream implements glib:type-struct="CredentialsClass"> The #GCredentials type is a reference-counted wrapper for native + line="5527">The #GCredentials type is a reference-counted wrapper for native credentials. This information is typically used for identifying, authenticating and authorizing other processes. @@ -13891,13 +14107,13 @@ credential type is a `ucred_t`. This corresponds to Creates a new #GCredentials object with credentials matching the + line="14495">Creates a new #GCredentials object with credentials matching the the current process. A #GCredentials. Free with g_object_unref(). + line="14501">A #GCredentials. Free with g_object_unref(). @@ -13907,7 +14123,7 @@ the current process. introspectable="0"> Gets a pointer to native credentials of type @native_type from + line="14423">Gets a pointer to native credentials of type @native_type from @credentials. It is a programming error (which will cause a warning to be @@ -13917,23 +14133,23 @@ the OS or if @native_type isn't supported by the OS. The pointer to native credentials or %NULL if the -operation there is no #GCredentials support for the OS or if -@native_type isn't supported by the OS. Do not free the returned -data, it is owned by @credentials. + line="14435">The pointer to native credentials or + %NULL if there is no #GCredentials support for the OS or if @native_type + isn't supported by the OS. Do not free the returned data, it is owned + by @credentials. A #GCredentials. + line="14425">A #GCredentials. The type of native credentials to get. + line="14426">The type of native credentials to get. @@ -13944,7 +14160,7 @@ data, it is owned by @credentials. throws="1"> Tries to get the UNIX process identifier from @credentials. This + line="14443">Tries to get the UNIX process identifier from @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the @@ -13955,14 +14171,14 @@ about the UNIX process ID (for example this is the case for The UNIX process ID, or -1 if @error is set. + line="14456">The UNIX process ID, or `-1` if @error is set. A #GCredentials + line="14445">A #GCredentials @@ -13973,7 +14189,7 @@ about the UNIX process ID (for example this is the case for throws="1"> Tries to get the UNIX user identifier from @credentials. This + line="14461">Tries to get the UNIX user identifier from @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the @@ -13983,14 +14199,14 @@ about the UNIX user. The UNIX user identifier or -1 if @error is set. + line="14473">The UNIX user identifier or `-1` if @error is set. A #GCredentials + line="14463">A #GCredentials @@ -14001,7 +14217,7 @@ about the UNIX user. throws="1"> Checks if @credentials and @other_credentials is the same user. + line="14478">Checks if @credentials and @other_credentials is the same user. This operation can fail if #GCredentials is not supported on the the OS. @@ -14009,7 +14225,7 @@ the OS. %TRUE if @credentials and @other_credentials has the same + line="14489">%TRUE if @credentials and @other_credentials has the same user, %FALSE otherwise or if @error is set. @@ -14017,13 +14233,13 @@ user, %FALSE otherwise or if @error is set. A #GCredentials. + line="14480">A #GCredentials. A #GCredentials. + line="14481">A #GCredentials. @@ -14033,7 +14249,7 @@ user, %FALSE otherwise or if @error is set. version="2.26"> Copies the native credentials of type @native_type from @native + line="14506">Copies the native credentials of type @native_type from @native into @credentials. It is a programming error (which will cause a warning to be @@ -14047,19 +14263,19 @@ the OS or if @native_type isn't supported by the OS. A #GCredentials. + line="14508">A #GCredentials. The type of native credentials to set. + line="14509">The type of native credentials to set. A pointer to native credentials. + line="14510">A pointer to native credentials. @@ -14070,7 +14286,7 @@ the OS or if @native_type isn't supported by the OS. throws="1"> Tries to set the UNIX user identifier on @credentials. This method + line="14523">Tries to set the UNIX user identifier on @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the @@ -14081,20 +14297,20 @@ use of "spoofed" credentials. %TRUE if @uid was set, %FALSE if error is set. + line="14537">%TRUE if @uid was set, %FALSE if error is set. A #GCredentials. + line="14525">A #GCredentials. The UNIX user identifier to set. + line="14526">The UNIX user identifier to set. @@ -14104,21 +14320,21 @@ use of "spoofed" credentials. version="2.26"> Creates a human-readable textual representation of @credentials + line="14542">Creates a human-readable textual representation of @credentials that can be used in logging and debug messages. The format of the returned string may change in future GLib release. A string that should be freed with g_free(). + line="14550">A string that should be freed with g_free(). A #GCredentials object. + line="14544">A #GCredentials object. @@ -14141,62 +14357,69 @@ returned string may change in future GLib release. c:type="GCredentialsType"> Enumeration describing different kinds of native credential types. + line="1431">Enumeration describing different kinds of native credential types. + glib:nick="invalid" + glib:name="G_CREDENTIALS_TYPE_INVALID"> Indicates an invalid native credential type. + line="1433">Indicates an invalid native credential type. + glib:nick="linux-ucred" + glib:name="G_CREDENTIALS_TYPE_LINUX_UCRED"> The native credentials type is a `struct ucred`. + line="1434">The native credentials type is a `struct ucred`. + glib:nick="freebsd-cmsgcred" + glib:name="G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED"> The native credentials type is a `struct cmsgcred`. + line="1435">The native credentials type is a `struct cmsgcred`. + glib:nick="openbsd-sockpeercred" + glib:name="G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED"> The native credentials type is a `struct sockpeercred`. Added in 2.30. + line="1436">The native credentials type is a `struct sockpeercred`. Added in 2.30. + glib:nick="solaris-ucred" + glib:name="G_CREDENTIALS_TYPE_SOLARIS_UCRED"> The native credentials type is a `ucred_t`. Added in 2.40. + line="1437">The native credentials type is a `ucred_t`. Added in 2.40. + glib:nick="netbsd-unpcbid" + glib:name="G_CREDENTIALS_TYPE_NETBSD_UNPCBID"> The native credentials type is a `struct unpcbid`. Added in 2.42. + line="1438">The native credentials type is a `struct unpcbid`. Added in 2.42. + glib:nick="apple-xucred" + glib:name="G_CREDENTIALS_TYPE_APPLE_XUCRED"> The native credentials type is a `struct xucred`. Added in 2.66. + line="1439">The native credentials type is a `struct xucred`. Added in 2.66. + + The value returned by handlers of the signals generated by +the `gdbus-codegen` tool to indicate that a method call has been +handled by an implementation. It is equal to %TRUE, but using +this macro is sometimes more readable. + +In code that needs to be backwards-compatible with older GLib, +use %TRUE instead, often written like this: + +|[ + g_dbus_method_invocation_return_error (invocation, ...); + return TRUE; // handled +]| + + + + + The value returned by handlers of the signals generated by +the `gdbus-codegen` tool to indicate that a method call has not been +handled by an implementation. It is equal to %FALSE, but using +this macro is sometimes more readable. + +In code that needs to be backwards-compatible with older GLib, +use %FALSE instead. + + + @@ -14576,7 +14836,7 @@ returned string may change in future GLib release. glib:get-type="g_dbus_action_group_get_type"> #GDBusActionGroup is an implementation of the #GActionGroup + line="5649">#GDBusActionGroup is an implementation of the #GActionGroup interface that can be used as a proxy for an action group that is exported over D-Bus with g_dbus_connection_export_action_group(). @@ -14586,7 +14846,7 @@ that is exported over D-Bus with g_dbus_connection_export_action_group(). version="2.32"> Obtains a #GDBusActionGroup for the action group which is exported at + line="15366">Obtains a #GDBusActionGroup for the action group which is exported at the given @bus_name and @object_path. The thread default main context is taken at the time of this call. @@ -14603,14 +14863,14 @@ g_action_group_list_actions() to get the initial list. a #GDBusActionGroup + line="15387">a #GDBusActionGroup A #GDBusConnection + line="15368">A #GDBusConnection allow-none="1"> the bus name which exports the action + line="15369">the bus name which exports the action group or %NULL if @connection is not a message bus connection the object path at which the action group is exported + line="15371">the object path at which the action group is exported @@ -14646,7 +14906,7 @@ g_action_group_list_actions() to get the initial list. The reference count or -1 if statically allocated. - + version="2.26"> If @info is statically allocated does nothing. Otherwise increases + line="15506">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="15513">The same @info. A #GDBusNodeInfo + line="15508">A #GDBusNodeInfo @@ -14696,7 +14956,7 @@ the reference count. version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + line="15518">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -14707,7 +14967,7 @@ the memory used is freed. A #GDBusAnnotationInfo. + line="15520">A #GDBusAnnotationInfo. @@ -14717,14 +14977,14 @@ the memory used is freed. version="2.26"> Looks up the value of an annotation. + line="15492">Looks up the value of an annotation. The cost of this function is O(n) in number of annotations. - + The value or %NULL if not found. Do not free, it is owned by @annotations. + line="15501">The value or %NULL if not found. Do not free, it is owned by @annotations. @@ -14734,7 +14994,7 @@ The cost of this function is O(n) in number of annotations. allow-none="1"> A %NULL-terminated array of annotations or %NULL. + line="15494">A %NULL-terminated array of annotations or %NULL. @@ -14742,7 +15002,7 @@ The cost of this function is O(n) in number of annotations. The name of the annotation to look up. + line="15495">The name of the annotation to look up. @@ -14762,7 +15022,7 @@ The cost of this function is O(n) in number of annotations. The reference count or -1 if statically allocated. - + If @info is statically allocated does nothing. Otherwise increases + line="15530">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="15537">The same @info. A #GDBusArgInfo + line="15532">A #GDBusArgInfo @@ -14808,7 +15068,7 @@ the reference count. If @info is statically allocated, does nothing. Otherwise decreases + line="15542">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -14819,7 +15079,7 @@ the memory used is freed. A #GDBusArgInfo. + line="15544">A #GDBusArgInfo. @@ -14834,7 +15094,7 @@ the memory used is freed. glib:get-type="g_dbus_auth_observer_get_type"> The #GDBusAuthObserver type provides a mechanism for participating + line="5678">The #GDBusAuthObserver type provides a mechanism for participating in how a #GDBusServer (or a #GDBusConnection) authenticates remote peers. Simply instantiate a #GDBusAuthObserver and connect to the signals you are interested in. Note that new signals may be added @@ -14870,7 +15130,9 @@ By default, a #GDBusServer or server-side #GDBusConnection will accept connections from any successfully authenticated user (but not from anonymous connections using the `ANONYMOUS` mechanism). If you only want to allow D-Bus connections from processes owned by the same uid -as the server, you would use a signal handler like the following: +as the server, since GLib 2.68, you should use the +%G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag. It’s equivalent +to the following signal handler: |[<!-- language="C" --> static gboolean @@ -14899,12 +15161,12 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, version="2.26"> Creates a new #GDBusAuthObserver object. + line="15579">Creates a new #GDBusAuthObserver object. A #GDBusAuthObserver. Free with g_object_unref(). + line="15584">A #GDBusAuthObserver. Free with g_object_unref(). @@ -14913,25 +15175,25 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, version="2.34"> Emits the #GDBusAuthObserver::allow-mechanism signal on @observer. + line="15554">Emits the #GDBusAuthObserver::allow-mechanism signal on @observer. %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. + line="15561">%TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. A #GDBusAuthObserver. + line="15556">A #GDBusAuthObserver. The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. + line="15557">The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. @@ -14941,25 +15203,25 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, version="2.26"> Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer. + line="15566">Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer. %TRUE if the peer is authorized, %FALSE if not. + line="15574">%TRUE if the peer is authorized, %FALSE if not. A #GDBusAuthObserver. + line="15568">A #GDBusAuthObserver. A #GIOStream for the #GDBusConnection. + line="15569">A #GIOStream for the #GDBusConnection. Credentials received from the peer or %NULL. + line="15570">Credentials received from the peer or %NULL. @@ -15031,32 +15293,35 @@ is authorized. c:type="GDBusCallFlags"> Flags used in g_dbus_connection_call() and similar APIs. + line="1241">Flags used in g_dbus_connection_call() and similar APIs. + glib:nick="none" + glib:name="G_DBUS_CALL_FLAGS_NONE"> No flags set. + line="1243">No flags set. + glib:nick="no-auto-start" + glib:name="G_DBUS_CALL_FLAGS_NO_AUTO_START"> The bus must not launch + line="1244">The bus must not launch an owner for the destination name in response to this method invocation. + glib:nick="allow-interactive-authorization" + glib:name="G_DBUS_CALL_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION"> the caller is prepared to + line="1247">the caller is prepared to wait for interactive authorization. Since 2.46. @@ -15067,22 +15332,24 @@ wait for interactive authorization. Since 2.46. c:type="GDBusCapabilityFlags"> Capabilities negotiated with the remote peer. + line="1226">Capabilities negotiated with the remote peer. + glib:nick="none" + glib:name="G_DBUS_CAPABILITY_FLAGS_NONE"> No flags set. + line="1228">No flags set. + glib:nick="unix-fd-passing" + glib:name="G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING"> The connection + line="1229">The connection supports exchanging UNIX file descriptors with the remote peer. @@ -15095,7 +15362,7 @@ supports exchanging UNIX file descriptors with the remote peer. glib:get-type="g_dbus_connection_get_type"> The #GDBusConnection type is used for D-Bus connections to remote + line="5748">The #GDBusConnection type is used for D-Bus connections to remote peers such as a message buses. It is a low-level API that offers a lot of flexibility. For instance, it lets you establish a connection over any transport that can by represented as a #GIOStream. @@ -15128,22 +15395,22 @@ free it with g_object_unref(). ## An example D-Bus server # {#gdbus-server} Here is an example for a D-Bus server: -[gdbus-example-server.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-server.c) +[gdbus-example-server.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-server.c) ## An example for exporting a subtree # {#gdbus-subtree-server} Here is an example for exporting a subtree: -[gdbus-example-subtree.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-subtree.c) +[gdbus-example-subtree.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-subtree.c) ## An example for file descriptor passing # {#gdbus-unix-fd-client} Here is an example for passing UNIX file descriptors: -[gdbus-unix-fd-client.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-unix-fd-client.c) +[gdbus-unix-fd-client.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-unix-fd-client.c) ## An example for exporting a GObject # {#gdbus-export} Here is an example for exporting a #GObject: -[gdbus-example-export.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-export.c) +[gdbus-example-export.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-export.c) Finishes an operation started with g_dbus_connection_new(). + line="16244">Finishes an operation started with g_dbus_connection_new(). a #GDBusConnection or %NULL if @error is set. Free + line="16252">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). @@ -15165,7 +15432,7 @@ Here is an example for exporting a #GObject: a #GAsyncResult obtained from the #GAsyncReadyCallback + line="16246">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new(). @@ -15177,20 +15444,20 @@ Here is an example for exporting a #GObject: throws="1"> Finishes an operation started with g_dbus_connection_new_for_address(). + line="16294">Finishes an operation started with g_dbus_connection_new_for_address(). a #GDBusConnection or %NULL if @error is set. Free with - g_object_unref(). + line="16302">a #GDBusConnection or %NULL if @error is set. + Free with g_object_unref(). a #GAsyncResult obtained from the #GAsyncReadyCallback passed + line="16296">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new() @@ -15202,7 +15469,7 @@ Here is an example for exporting a #GObject: throws="1"> Synchronously connects and sets up a D-Bus client connection for + line="16308">Synchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by @address which must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -15210,8 +15477,9 @@ which must be in the This constructor can only be used to initiate client-side connections - use g_dbus_connection_new_sync() if you need to act as the server. In particular, @flags cannot contain the -%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or -%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags. +%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER, +%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS or +%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flags. This is a synchronous failable constructor. See g_dbus_connection_new_for_address() for the asynchronous version. @@ -15222,21 +15490,21 @@ authentication process. a #GDBusConnection or %NULL if @error is set. Free with - g_object_unref(). + line="16334">a #GDBusConnection or %NULL if @error is set. + Free with g_object_unref(). a D-Bus address + line="16310">a D-Bus address flags describing how to make the connection + line="16311">flags describing how to make the connection allow-none="1"> a #GDBusAuthObserver or %NULL + line="16312">a #GDBusAuthObserver or %NULL allow-none="1"> a #GCancellable or %NULL + line="16313">a #GCancellable or %NULL @@ -15265,7 +15533,7 @@ authentication process. throws="1"> Synchronously sets up a D-Bus connection for exchanging D-Bus messages + line="16340">Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. If @stream is a #GSocketConnection, then the corresponding #GSocket @@ -15284,14 +15552,15 @@ g_dbus_connection_new() for the asynchronous version. a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). + line="16365">a #GDBusConnection or %NULL if @error is set. + Free with g_object_unref(). a #GIOStream + line="16342">a #GIOStream allow-none="1"> the GUID to use if authenticating as a server or %NULL + line="16343">the GUID to use if authenticating as a server or %NULL flags describing how to make the connection + line="16344">flags describing how to make the connection allow-none="1"> a #GDBusAuthObserver or %NULL + line="16345">a #GDBusAuthObserver or %NULL allow-none="1"> a #GCancellable or %NULL + line="16346">a #GCancellable or %NULL @@ -15332,7 +15601,7 @@ g_dbus_connection_new() for the asynchronous version. Asynchronously sets up a D-Bus connection for exchanging D-Bus messages + line="16209">Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. If @stream is a #GSocketConnection, then the corresponding #GSocket @@ -15360,7 +15629,7 @@ version. a #GIOStream + line="16211">a #GIOStream allow-none="1"> the GUID to use if authenticating as a server or %NULL + line="16212">the GUID to use if authenticating as a server or %NULL flags describing how to make the connection + line="16213">flags describing how to make the connection allow-none="1"> a #GDBusAuthObserver or %NULL + line="16214">a #GDBusAuthObserver or %NULL allow-none="1"> a #GCancellable or %NULL + line="16215">a #GCancellable or %NULL closure="6"> a #GAsyncReadyCallback to call when the request is satisfied + line="16216">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to @callback + line="16217">the data to pass to @callback @@ -15423,7 +15692,7 @@ version. version="2.26"> Asynchronously connects and sets up a D-Bus client connection for + line="16258">Asynchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by @address which must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -15431,8 +15700,9 @@ which must be in the This constructor can only be used to initiate client-side connections - use g_dbus_connection_new() if you need to act as the server. In particular, @flags cannot contain the -%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or -%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags. +%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER, +%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS or +%G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flags. When the operation is finished, @callback will be invoked. You can then call g_dbus_connection_new_for_address_finish() to get the result of @@ -15452,13 +15722,13 @@ version. a D-Bus address + line="16260">a D-Bus address flags describing how to make the connection + line="16261">flags describing how to make the connection allow-none="1"> a #GDBusAuthObserver or %NULL + line="16262">a #GDBusAuthObserver or %NULL allow-none="1"> a #GCancellable or %NULL + line="16263">a #GCancellable or %NULL closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + line="16264">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to @callback + line="16265">the data to pass to @callback @@ -15506,7 +15776,7 @@ version. version="2.26"> Adds a message filter. Filters are handlers that are run on all + line="15589">Adds a message filter. Filters are handlers that are run on all incoming and outgoing messages, prior to standard dispatch. Filters are run in the order that they were added. The same handler can be added as a filter more than once, in which case it will be run more @@ -15537,7 +15807,7 @@ destroyed.) a filter identifier that can be used with + line="15625">a filter identifier that can be used with g_dbus_connection_remove_filter() @@ -15545,7 +15815,7 @@ destroyed.) a #GDBusConnection + line="15591">a #GDBusConnection destroy="2"> a filter function + line="15592">a filter function @@ -15565,7 +15835,7 @@ destroyed.) allow-none="1"> user data to pass to @filter_function + line="15593">user data to pass to @filter_function scope="async"> function to free @user_data with when filter + line="15594">function to free @user_data with when filter is removed or %NULL @@ -15582,7 +15852,7 @@ destroyed.) Asynchronously invokes the @method_name method on the + line="15631">Asynchronously invokes the @method_name method on the @interface_name D-Bus interface on the remote object at @object_path owned by @bus_name. @@ -15635,7 +15905,7 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. a #GDBusConnection + line="15633">a #GDBusConnection allow-none="1"> a unique or well-known bus name or %NULL if + line="15634">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + line="15636">path of remote object D-Bus interface to invoke method on + line="15637">D-Bus interface to invoke method on the name of the method to invoke + line="15638">the name of the method to invoke allow-none="1"> a #GVariant tuple with parameters for the method + line="15639">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -15682,20 +15952,20 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. allow-none="1"> the expected type of the reply (which will be a + line="15641">the expected type of the reply (which will be a tuple), or %NULL flags from the #GDBusCallFlags enumeration + line="15643">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + line="15644">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -15705,7 +15975,7 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. allow-none="1"> a #GCancellable or %NULL + line="15646">a #GCancellable or %NULL closure="10"> a #GAsyncReadyCallback to call when the request + line="15647">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation @@ -15727,7 +15997,7 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. allow-none="1"> the data to pass to @callback + line="15650">the data to pass to @callback @@ -15738,26 +16008,26 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. throws="1"> Finishes an operation started with g_dbus_connection_call(). + line="15702">Finishes an operation started with g_dbus_connection_call(). %NULL if @error is set. Otherwise a #GVariant tuple with - return values. Free with g_variant_unref(). + line="15710">%NULL if @error is set. Otherwise a non-floating + #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + line="15704">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call() + line="15705">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call() @@ -15768,7 +16038,7 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. throws="1"> Synchronously invokes the @method_name method on the + line="15716">Synchronously invokes the @method_name method on the @interface_name D-Bus interface on the remote object at @object_path owned by @bus_name. @@ -15808,15 +16078,15 @@ this method. %NULL if @error is set. Otherwise a #GVariant tuple with - return values. Free with g_variant_unref(). + line="15770">%NULL if @error is set. Otherwise a non-floating + #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + line="15718">a #GDBusConnection allow-none="1"> a unique or well-known bus name or %NULL if + line="15719">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + line="15721">path of remote object D-Bus interface to invoke method on + line="15722">D-Bus interface to invoke method on the name of the method to invoke + line="15723">the name of the method to invoke allow-none="1"> a #GVariant tuple with parameters for the method + line="15724">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -15863,19 +16133,19 @@ this method. allow-none="1"> the expected type of the reply, or %NULL + line="15726">the expected type of the reply, or %NULL flags from the #GDBusCallFlags enumeration + line="15727">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + line="15728">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -15885,7 +16155,7 @@ this method. allow-none="1"> a #GCancellable or %NULL + line="15730">a #GCancellable or %NULL @@ -15895,7 +16165,19 @@ this method. version="2.30"> Like g_dbus_connection_call() but also takes a #GUnixFDList object. + line="15776">Like g_dbus_connection_call() but also takes a #GUnixFDList object. + +The file descriptors normally correspond to %G_VARIANT_TYPE_HANDLE +values in the body of the message. For example, if a message contains +two file descriptors, @fd_list would have length 2, and +`g_variant_new_handle (0)` and `g_variant_new_handle (1)` would appear +somewhere in the body of the message (not necessarily in that order!) +to represent the file descriptors at indexes 0 and 1 respectively. + +When designing D-Bus APIs that are intended to be interoperable, +please note that non-GDBus implementations of D-Bus can usually only +access file descriptors if they are referenced in this way by a +value of type %G_VARIANT_TYPE_HANDLE in the body of the message. This method is only available on UNIX. @@ -15906,7 +16188,7 @@ This method is only available on UNIX. a #GDBusConnection + line="15778">a #GDBusConnection allow-none="1"> a unique or well-known bus name or %NULL if + line="15779">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + line="15781">path of remote object D-Bus interface to invoke method on + line="15782">D-Bus interface to invoke method on the name of the method to invoke + line="15783">the name of the method to invoke allow-none="1"> a #GVariant tuple with parameters for the method + line="15784">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -15953,19 +16235,19 @@ This method is only available on UNIX. allow-none="1"> the expected type of the reply, or %NULL + line="15786">the expected type of the reply, or %NULL flags from the #GDBusCallFlags enumeration + line="15787">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + line="15788">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -15975,7 +16257,7 @@ This method is only available on UNIX. allow-none="1"> a #GUnixFDList or %NULL + line="15790">a #GUnixFDList or %NULL allow-none="1"> a #GCancellable or %NULL + line="15791">a #GCancellable or %NULL closure="11"> a #GAsyncReadyCallback to call when the request is + line="15792">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't * care about the result of the method invocation @@ -16006,7 +16288,7 @@ This method is only available on UNIX. allow-none="1"> The data to pass to @callback. + line="15795">The data to pass to @callback. @@ -16017,20 +16299,31 @@ This method is only available on UNIX. throws="1"> Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). + line="15817">Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). + +The file descriptors normally correspond to %G_VARIANT_TYPE_HANDLE +values in the body of the message. For example, +if g_variant_get_handle() returns 5, that is intended to be a reference +to the file descriptor that can be accessed by +`g_unix_fd_list_get (*out_fd_list, 5, ...)`. + +When designing D-Bus APIs that are intended to be interoperable, +please note that non-GDBus implementations of D-Bus can usually only +access file descriptors if they are referenced in this way by a +value of type %G_VARIANT_TYPE_HANDLE in the body of the message. %NULL if @error is set. Otherwise a #GVariant tuple with - return values. Free with g_variant_unref(). + line="15838">%NULL if @error is set. Otherwise a non-floating + #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + line="15819">a #GDBusConnection allow-none="1"> return location for a #GUnixFDList or %NULL + line="15820">return location for a #GUnixFDList or %NULL a #GAsyncResult obtained from the #GAsyncReadyCallback passed to + line="15821">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list() @@ -16059,22 +16352,24 @@ This method is only available on UNIX. throws="1"> Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. + line="15844">Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. +See g_dbus_connection_call_with_unix_fd_list() and +g_dbus_connection_call_with_unix_fd_list_finish() for more details. This method is only available on UNIX. %NULL if @error is set. Otherwise a #GVariant tuple with - return values. Free with g_variant_unref(). + line="15869">%NULL if @error is set. Otherwise a non-floating + #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + line="15846">a #GDBusConnection allow-none="1"> a unique or well-known bus name or %NULL + line="15847">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + line="15849">path of remote object D-Bus interface to invoke method on + line="15850">D-Bus interface to invoke method on the name of the method to invoke + line="15851">the name of the method to invoke allow-none="1"> a #GVariant tuple with parameters for + line="15852">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -16121,19 +16416,19 @@ This method is only available on UNIX. allow-none="1"> the expected type of the reply, or %NULL + line="15854">the expected type of the reply, or %NULL flags from the #GDBusCallFlags enumeration + line="15855">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + line="15856">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -16143,7 +16438,7 @@ This method is only available on UNIX. allow-none="1"> a #GUnixFDList or %NULL + line="15858">a #GUnixFDList or %NULL allow-none="1"> return location for a #GUnixFDList or %NULL + line="15859">return location for a #GUnixFDList or %NULL allow-none="1"> a #GCancellable or %NULL + line="15860">a #GCancellable or %NULL @@ -16173,7 +16468,7 @@ This method is only available on UNIX. version="2.26"> Closes @connection. Note that this never causes the process to + line="15875">Closes @connection. Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see #GDBusConnection:exit-on-close). @@ -16205,7 +16500,7 @@ version. a #GDBusConnection + line="15877">a #GDBusConnection allow-none="1"> a #GCancellable or %NULL + line="15878">a #GCancellable or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is + line="15879">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result @@ -16235,7 +16530,7 @@ version. allow-none="1"> The data to pass to @callback + line="15881">The data to pass to @callback @@ -16246,25 +16541,25 @@ version. throws="1"> Finishes an operation started with g_dbus_connection_close(). + line="15912">Finishes an operation started with g_dbus_connection_close(). %TRUE if the operation succeeded, %FALSE if @error is set + line="15921">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + line="15914">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed + line="15915">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close() @@ -16276,7 +16571,7 @@ version. throws="1"> Synchronously closes @connection. The calling thread is blocked + line="15926">Synchronously closes @connection. The calling thread is blocked until this is done. See g_dbus_connection_close() for the asynchronous version of this method and more details about what it does. @@ -16284,14 +16579,14 @@ does. %TRUE if the operation succeeded, %FALSE if @error is set + line="15937">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + line="15928">a #GDBusConnection allow-none="1"> a #GCancellable or %NULL + line="15929">a #GCancellable or %NULL @@ -16311,7 +16606,7 @@ does. throws="1"> Emits a signal. + line="15942">Emits a signal. If the parameters GVariant is floating, it is consumed. @@ -16322,14 +16617,14 @@ This can only fail if @parameters is not compatible with the D-Bus protocol %TRUE unless @error is set + line="15962">%TRUE unless @error is set a #GDBusConnection + line="15944">a #GDBusConnection the unique bus name for the destination + line="15945">the unique bus name for the destination for the signal or %NULL to emit to all listeners path of remote object + line="15947">path of remote object D-Bus interface to emit a signal on + line="15948">D-Bus interface to emit a signal on the name of the signal to emit + line="15949">the name of the signal to emit a #GVariant tuple with parameters for the signal + line="15950">a #GVariant tuple with parameters for the signal or %NULL if not passing parameters @@ -16378,7 +16673,7 @@ This can only fail if @parameters is not compatible with the D-Bus protocol throws="1"> Exports @action_group on @connection at @object_path. + line="15967">Exports @action_group on @connection at @object_path. The implemented D-Bus API should be considered private. It is subject to change in the future. @@ -16403,26 +16698,26 @@ context. the ID of the export (never zero), or 0 in case of failure + line="15996">the ID of the export (never zero), or 0 in case of failure a #GDBusConnection + line="15969">a #GDBusConnection a D-Bus object path + line="15970">a D-Bus object path a #GActionGroup + line="15971">a #GActionGroup @@ -16433,7 +16728,7 @@ context. throws="1"> Exports @menu on @connection at @object_path. + line="16001">Exports @menu on @connection at @object_path. The implemented D-Bus API should be considered private. It is subject to change in the future. @@ -16449,26 +16744,26 @@ this function. the ID of the export (never zero), or 0 in case of failure + line="16021">the ID of the export (never zero), or 0 in case of failure a #GDBusConnection + line="16003">a #GDBusConnection a D-Bus object path + line="16004">a D-Bus object path a #GMenuModel + line="16005">a #GMenuModel @@ -16478,7 +16773,7 @@ this function. version="2.26"> Asynchronously flushes @connection, that is, writes all queued + line="16026">Asynchronously flushes @connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using g_output_stream_flush_async()). This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without @@ -16500,7 +16795,7 @@ version. a #GDBusConnection + line="16028">a #GDBusConnection allow-none="1"> a #GCancellable or %NULL + line="16029">a #GCancellable or %NULL closure="2"> a #GAsyncReadyCallback to call when the + line="16030">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result @@ -16530,7 +16825,7 @@ version. allow-none="1"> The data to pass to @callback + line="16032">The data to pass to @callback @@ -16541,25 +16836,25 @@ version. throws="1"> Finishes an operation started with g_dbus_connection_flush(). + line="16053">Finishes an operation started with g_dbus_connection_flush(). %TRUE if the operation succeeded, %FALSE if @error is set + line="16062">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + line="16055">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed + line="16056">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush() @@ -16571,7 +16866,7 @@ version. throws="1"> Synchronously flushes @connection. The calling thread is blocked + line="16067">Synchronously flushes @connection. The calling thread is blocked until this is done. See g_dbus_connection_flush() for the asynchronous version of this method and more details about what it does. @@ -16579,14 +16874,14 @@ does. %TRUE if the operation succeeded, %FALSE if @error is set + line="16078">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + line="16069">a #GDBusConnection allow-none="1"> a #GCancellable or %NULL + line="16070">a #GCancellable or %NULL Gets the capabilities negotiated with the remote peer + line="16083">Gets the capabilities negotiated with the remote peer zero or more flags from the #GDBusCapabilityFlags enumeration + line="16089">zero or more flags from the #GDBusCapabilityFlags enumeration a #GDBusConnection + line="16085">a #GDBusConnection Gets whether the process is terminated when @connection is + line="16094">Gets whether the process is terminated when @connection is closed by the remote peer. See #GDBusConnection:exit-on-close for more details. whether the process is terminated when @connection is + line="16102">whether the process is terminated when @connection is closed by the remote peer @@ -16642,45 +16939,47 @@ closed by the remote peer. See a #GDBusConnection + line="16096">a #GDBusConnection Gets the flags used to construct this connection + line="16108">Gets the flags used to construct this connection zero or more flags from the #GDBusConnectionFlags enumeration + line="16114">zero or more flags from the #GDBusConnectionFlags enumeration a #GDBusConnection + line="16110">a #GDBusConnection The GUID of the peer performing the role of server when + line="16119">The GUID of the peer performing the role of server when authenticating. See #GDBusConnection:guid for more details. The GUID. Do not free this string, it is owned by + line="16126">The GUID. Do not free this string, it is owned by @connection. @@ -16688,7 +16987,7 @@ authenticating. See #GDBusConnection:guid for more details. a #GDBusConnection + line="16121">a #GDBusConnection @@ -16698,7 +16997,7 @@ authenticating. See #GDBusConnection:guid for more details. version="2.34"> Retrieves the last serial number assigned to a #GDBusMessage on + line="16132">Retrieves the last serial number assigned to a #GDBusMessage on the current thread. This includes messages sent via both low-level API such as g_dbus_connection_send_message() as well as high-level API such as g_dbus_connection_emit_signal(), @@ -16707,7 +17006,7 @@ g_dbus_connection_call() or g_dbus_proxy_call(). the last used serial or zero when no message has been sent + line="16142">the last used serial or zero when no message has been sent within the current thread @@ -16715,7 +17014,7 @@ g_dbus_connection_call() or g_dbus_proxy_call(). a #GDBusConnection + line="16134">a #GDBusConnection @@ -16725,7 +17024,7 @@ g_dbus_connection_call() or g_dbus_proxy_call(). version="2.26"> Gets the credentials of the authenticated peer. This will always + line="16148">Gets the credentials of the authenticated peer. This will always return %NULL unless @connection acted as a server (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed) when set up and the client passed credentials as part of the @@ -16738,7 +17037,7 @@ each application is a client. So this method will always return a #GCredentials or %NULL if not + line="16162">a #GCredentials or %NULL if not available. Do not free this object, it is owned by @connection. @@ -16746,17 +17045,18 @@ each application is a client. So this method will always return a #GDBusConnection + line="16150">a #GDBusConnection Gets the underlying stream used for IO. + line="16168">Gets the underlying stream used for IO. While the #GDBusConnection is active, it will interact with this stream from a worker thread, so it is not safe to interact with @@ -16765,31 +17065,32 @@ the stream directly. the stream used for IO + line="16178">the stream used for IO a #GDBusConnection + line="16170">a #GDBusConnection Gets the unique name of @connection as assigned by the message + line="16183">Gets the unique name of @connection as assigned by the message bus. This can also be used to figure out if @connection is a message bus connection. the unique name or %NULL if @connection is not a message + line="16191">the unique name or %NULL if @connection is not a message bus connection. Do not free this string, it is owned by @connection. @@ -16798,7 +17099,7 @@ message bus connection. a #GDBusConnection + line="16185">a #GDBusConnection @@ -16808,19 +17109,19 @@ message bus connection. version="2.26"> Gets whether @connection is closed. + line="16198">Gets whether @connection is closed. %TRUE if the connection is closed, %FALSE otherwise + line="16204">%TRUE if the connection is closed, %FALSE otherwise a #GDBusConnection + line="16200">a #GDBusConnection @@ -16832,7 +17133,7 @@ message bus connection. throws="1"> Registers callbacks for exported objects at @object_path with the + line="16371">Registers callbacks for exported objects at @object_path with the D-Bus interface that is described in @interface_info. Calls to functions in @vtable (and @user_data_free_func) will happen @@ -16874,7 +17175,7 @@ See this [server][gdbus-server] for an example of how to use this method. 0 if @error is set, otherwise a registration id (never 0) + line="16420">0 if @error is set, otherwise a registration id (never 0) that can be used with g_dbus_connection_unregister_object() @@ -16882,19 +17183,19 @@ See this [server][gdbus-server] for an example of how to use this method. a #GDBusConnection + line="16373">a #GDBusConnection the object path to register at + line="16374">the object path to register at introspection data for the interface + line="16375">introspection data for the interface allow-none="1"> a #GDBusInterfaceVTable to call into or %NULL + line="16376">a #GDBusInterfaceVTable to call into or %NULL @@ -16913,7 +17214,7 @@ See this [server][gdbus-server] for an example of how to use this method. allow-none="1"> data to pass to functions in @vtable + line="16377">data to pass to functions in @vtable scope="async"> function to call when the object path is unregistered + line="16378">function to call when the object path is unregistered @@ -16933,13 +17234,13 @@ See this [server][gdbus-server] for an example of how to use this method. throws="1"> Version of g_dbus_connection_register_object() using closures instead of a + line="16426">Version of g_dbus_connection_register_object() using closures instead of a #GDBusInterfaceVTable for easier binding in other languages. 0 if @error is set, otherwise a registration id (never 0) + line="16439">0 if @error is set, otherwise a registration ID (never 0) that can be used with g_dbus_connection_unregister_object() . @@ -16947,19 +17248,19 @@ that can be used with g_dbus_connection_unregister_object() . A #GDBusConnection. + line="16428">A #GDBusConnection. The object path to register at. + line="16429">The object path to register at. Introspection data for the interface. + line="16430">Introspection data for the interface. allow-none="1"> #GClosure for handling incoming method calls. + line="16431">#GClosure for handling incoming method calls. allow-none="1"> #GClosure for getting a property. + line="16432">#GClosure for getting a property. allow-none="1"> #GClosure for setting a property. + line="16433">#GClosure for setting a property. @@ -16997,7 +17298,7 @@ that can be used with g_dbus_connection_unregister_object() . throws="1"> Registers a whole subtree of dynamic objects. + line="16445">Registers a whole subtree of dynamic objects. The @enumerate and @introspection functions in @vtable are used to convey, to remote callers, what nodes exist in the subtree rooted @@ -17035,34 +17336,34 @@ this method. 0 if @error is set, otherwise a subtree registration id (never 0) -that can be used with g_dbus_connection_unregister_subtree() . + line="16491">0 if @error is set, otherwise a subtree registration ID (never 0) +that can be used with g_dbus_connection_unregister_subtree() a #GDBusConnection + line="16447">a #GDBusConnection the object path to register the subtree at + line="16448">the object path to register the subtree at a #GDBusSubtreeVTable to enumerate, introspect and + line="16449">a #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree flags used to fine tune the behavior of the subtree + line="16451">flags used to fine tune the behavior of the subtree allow-none="1"> data to pass to functions in @vtable + line="16452">data to pass to functions in @vtable scope="async"> function to call when the subtree is unregistered + line="16453">function to call when the subtree is unregistered @@ -17089,7 +17390,7 @@ that can be used with g_dbus_connection_unregister_subtree() . version="2.26"> Removes a filter. + line="16497">Removes a filter. Note that since filters run in a different thread, there is a race condition where it is possible that the filter will be running even @@ -17105,13 +17406,13 @@ called when it is guaranteed that the data is no longer needed. a #GDBusConnection + line="16499">a #GDBusConnection an identifier obtained from g_dbus_connection_add_filter() + line="16500">an identifier obtained from g_dbus_connection_add_filter() @@ -17122,14 +17423,16 @@ called when it is guaranteed that the data is no longer needed. throws="1"> Asynchronously sends @message to the peer represented by @connection. + line="16515">Asynchronously sends @message to the peer represented by @connection. Unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number will be assigned by @connection and set on @message via g_dbus_message_set_serial(). If @out_serial is not %NULL, then the serial number used will be written to this location prior to -submitting the message to the underlying transport. +submitting the message to the underlying transport. While it has a `volatile` +qualifier, this is a historical artifact and the argument passed to it should +not be `volatile`. If @connection is closed then the operation will fail with %G_IO_ERROR_CLOSED. If @message is not well-formed, @@ -17145,7 +17448,7 @@ Note that @message must be unlocked, unless @flags contain the %TRUE if the message was well-formed and queued for + line="16546">%TRUE if the message was well-formed and queued for transmission, %FALSE if @error is set @@ -17153,19 +17456,19 @@ Note that @message must be unlocked, unless @flags contain the a #GDBusConnection + line="16517">a #GDBusConnection a #GDBusMessage + line="16518">a #GDBusMessage flags affecting how the message is sent + line="16519">flags affecting how the message is sent return location for serial number assigned + line="16520">return location for serial number assigned to @message when sending it or %NULL @@ -17187,14 +17490,16 @@ Note that @message must be unlocked, unless @flags contain the version="2.26"> Asynchronously sends @message to the peer represented by @connection. + line="16552">Asynchronously sends @message to the peer represented by @connection. Unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number will be assigned by @connection and set on @message via g_dbus_message_set_serial(). If @out_serial is not %NULL, then the serial number used will be written to this location prior to -submitting the message to the underlying transport. +submitting the message to the underlying transport. While it has a `volatile` +qualifier, this is a historical artifact and the argument passed to it should +not be `volatile`. If @connection is closed then the operation will fail with %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will @@ -17222,25 +17527,25 @@ UNIX file descriptors. a #GDBusConnection + line="16554">a #GDBusConnection a #GDBusMessage + line="16555">a #GDBusMessage flags affecting how the message is sent + line="16556">flags affecting how the message is sent the timeout in milliseconds, -1 to use the default + line="16557">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -17252,7 +17557,7 @@ UNIX file descriptors. allow-none="1"> return location for serial number assigned + line="16559">return location for serial number assigned to @message when sending it or %NULL @@ -17262,7 +17567,7 @@ UNIX file descriptors. allow-none="1"> a #GCancellable or %NULL + line="16561">a #GCancellable or %NULL closure="6"> a #GAsyncReadyCallback to call when the request + line="16562">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result @@ -17283,7 +17588,7 @@ UNIX file descriptors. allow-none="1"> The data to pass to @callback + line="16564">The data to pass to @callback @@ -17294,7 +17599,7 @@ UNIX file descriptors. throws="1"> Finishes an operation started with g_dbus_connection_send_message_with_reply(). + line="16600">Finishes an operation started with g_dbus_connection_send_message_with_reply(). Note that @error is only set if a local in-process error occurred. That is to say that the returned #GDBusMessage object may @@ -17308,20 +17613,20 @@ UNIX file descriptors. a locked #GDBusMessage or %NULL if @error is set + line="16618">a locked #GDBusMessage or %NULL if @error is set a #GDBusConnection + line="16602">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed to + line="16603">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply() @@ -17333,7 +17638,7 @@ UNIX file descriptors. throws="1"> Synchronously sends @message to the peer represented by @connection + line="16623">Synchronously sends @message to the peer represented by @connection and blocks the calling thread until a reply is received or the timeout is reached. See g_dbus_connection_send_message_with_reply() for the asynchronous version of this method. @@ -17343,7 +17648,9 @@ Unless @flags contain the will be assigned by @connection and set on @message via g_dbus_message_set_serial(). If @out_serial is not %NULL, then the serial number used will be written to this location prior to -submitting the message to the underlying transport. +submitting the message to the underlying transport. While it has a `volatile` +qualifier, this is a historical artifact and the argument passed to it should +not be `volatile`. If @connection is closed then the operation will fail with %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will @@ -17365,7 +17672,7 @@ Note that @message must be unlocked, unless @flags contain the a locked #GDBusMessage that is the reply + line="16666">a locked #GDBusMessage that is the reply to @message or %NULL if @error is set @@ -17373,25 +17680,25 @@ Note that @message must be unlocked, unless @flags contain the a #GDBusConnection + line="16625">a #GDBusConnection a #GDBusMessage + line="16626">a #GDBusMessage flags affecting how the message is sent. + line="16627">flags affecting how the message is sent. the timeout in milliseconds, -1 to use the default + line="16628">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -17403,7 +17710,7 @@ Note that @message must be unlocked, unless @flags contain the allow-none="1"> return location for serial number + line="16630">return location for serial number assigned to @message when sending it or %NULL @@ -17413,17 +17720,18 @@ Note that @message must be unlocked, unless @flags contain the allow-none="1"> a #GCancellable or %NULL + line="16632">a #GCancellable or %NULL Sets whether the process should be terminated when @connection is + line="16672">Sets whether the process should be terminated when @connection is closed by the remote peer. See #GDBusConnection:exit-on-close for more details. @@ -17441,13 +17749,13 @@ when the user session ends. a #GDBusConnection + line="16674">a #GDBusConnection whether the process should be terminated + line="16675">whether the process should be terminated when @connection is closed by the remote peer @@ -17458,7 +17766,7 @@ when the user session ends. version="2.26"> Subscribes to signals on @connection and invokes @callback with a whenever + line="16693">Subscribes to signals on @connection and invokes @callback with a whenever the signal is received. Note that @callback will be invoked in the [thread-default main context][g-main-context-push-thread-default] of the thread you are calling this method from. @@ -17511,14 +17819,14 @@ This function can never fail. a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe() + line="16763">a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe() a #GDBusConnection + line="16695">a #GDBusConnection allow-none="1"> sender name to match on (unique or well-known name) + line="16696">sender name to match on (unique or well-known name) or %NULL to listen from all senders @@ -17537,7 +17845,7 @@ This function can never fail. allow-none="1"> D-Bus interface name to match on or %NULL to + line="16698">D-Bus interface name to match on or %NULL to match on all interfaces @@ -17547,7 +17855,7 @@ This function can never fail. allow-none="1"> D-Bus signal name to match on or %NULL to match on + line="16700">D-Bus signal name to match on or %NULL to match on all signals @@ -17557,7 +17865,7 @@ This function can never fail. allow-none="1"> object path to match on or %NULL to match on + line="16702">object path to match on or %NULL to match on all object paths @@ -17567,14 +17875,14 @@ This function can never fail. allow-none="1"> contents of first string argument to match on or %NULL + line="16704">contents of first string argument to match on or %NULL to match on all kinds of arguments #GDBusSignalFlags describing how arg0 is used in subscribing to the + line="16706">#GDBusSignalFlags describing how arg0 is used in subscribing to the signal @@ -17585,7 +17893,7 @@ This function can never fail. destroy="8"> callback to invoke when there is a signal matching the requested data + line="16708">callback to invoke when there is a signal matching the requested data allow-none="1"> user data to pass to @callback + line="16709">user data to pass to @callback scope="async"> function to free @user_data with when + line="16710">function to free @user_data with when subscription is removed or %NULL @@ -17615,7 +17923,7 @@ This function can never fail. version="2.26"> Unsubscribes from signals. + line="16768">Unsubscribes from signals. Note that there may still be D-Bus traffic to process (relating to this signal subscription) in the current thread-default #GMainContext after this @@ -17623,7 +17931,10 @@ function has returned. You should continue to iterate the #GMainContext until the #GDestroyNotify function passed to g_dbus_connection_signal_subscribe() is called, in order to avoid memory leaks through callbacks queued on the #GMainContext after it’s stopped being -iterated. +iterated. +Alternatively, any idle source with a priority lower than %G_PRIORITY_DEFAULT +that was scheduled after unsubscription, also indicates that all resources +of this subscription are released. @@ -17632,13 +17943,13 @@ iterated. a #GDBusConnection + line="16770">a #GDBusConnection a subscription id obtained from + line="16771">a subscription id obtained from g_dbus_connection_signal_subscribe() @@ -17649,7 +17960,7 @@ iterated. version="2.26"> If @connection was created with + line="16791">If @connection was created with %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method starts processing messages. Does nothing on if @connection wasn't created with this flag or if the method has already been called. @@ -17661,7 +17972,7 @@ created with this flag or if the method has already been called. a #GDBusConnection + line="16793">a #GDBusConnection @@ -17671,7 +17982,7 @@ created with this flag or if the method has already been called. version="2.32"> Reverses the effect of a previous call to + line="16804">Reverses the effect of a previous call to g_dbus_connection_export_action_group(). It is an error to call this function with an ID that wasn't returned @@ -17685,13 +17996,13 @@ same ID more than once. a #GDBusConnection + line="16806">a #GDBusConnection the ID from g_dbus_connection_export_action_group() + line="16807">the ID from g_dbus_connection_export_action_group() @@ -17701,7 +18012,7 @@ same ID more than once. version="2.32"> Reverses the effect of a previous call to + line="16820">Reverses the effect of a previous call to g_dbus_connection_export_menu_model(). It is an error to call this function with an ID that wasn't returned @@ -17715,13 +18026,13 @@ same ID more than once. a #GDBusConnection + line="16822">a #GDBusConnection the ID from g_dbus_connection_export_menu_model() + line="16823">the ID from g_dbus_connection_export_menu_model() @@ -17731,25 +18042,25 @@ same ID more than once. version="2.26"> Unregisters an object. + line="16836">Unregisters an object. %TRUE if the object was unregistered, %FALSE otherwise + line="16844">%TRUE if the object was unregistered, %FALSE otherwise a #GDBusConnection + line="16838">a #GDBusConnection a registration id obtained from + line="16839">a registration id obtained from g_dbus_connection_register_object() @@ -17760,25 +18071,25 @@ same ID more than once. version="2.26"> Unregisters a subtree. + line="16849">Unregisters a subtree. %TRUE if the subtree was unregistered, %FALSE otherwise + line="16857">%TRUE if the subtree was unregistered, %FALSE otherwise a #GDBusConnection + line="16851">a #GDBusConnection a subtree registration id obtained from + line="16852">a subtree registration id obtained from g_dbus_connection_register_subtree() @@ -17807,7 +18118,10 @@ when establishing the connection. line="681">A #GDBusAuthObserver object to assist in the authentication process or %NULL. - + Flags from the #GDBusCapabilityFlags enumeration @@ -17823,7 +18137,9 @@ representing connection features negotiated with the other peer. + transfer-ownership="none" + setter="set_exit_on_close" + getter="get_exit_on_close"> A boolean specifying whether the process will be terminated (by @@ -17838,7 +18154,8 @@ and g_bus_get_sync() will (usually) have this property set to %TRUE. version="2.26" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_flags"> Flags from the #GDBusConnectionFlags enumeration. @@ -17848,7 +18165,8 @@ and g_bus_get_sync() will (usually) have this property set to %TRUE. version="2.26" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_guid"> The GUID of the peer performing the role of server when @@ -17856,24 +18174,34 @@ authenticating. If you are constructing a #GDBusConnection and pass %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the -#GDBusConnection:flags property then you MUST also set this +#GDBusConnection:flags property then you **must** also set this property to a valid guid. If you are constructing a #GDBusConnection and pass %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the #GDBusConnection:flags property you will be able to read the GUID of the other peer here after the connection has been successfully -initialized. +initialized. + +Note that the +[D-Bus specification](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses) +uses the term ‘UUID’ to refer to this, whereas GLib consistently uses the +term ‘GUID’ for historical reasons. + +Despite its name, the format of #GDBusConnection:guid does not follow +[RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122) or the Microsoft +GUID format. + transfer-ownership="none" + getter="get_stream"> The underlying #GIOStream used for I/O. + line="771">The underlying #GIOStream used for I/O. If this is passed on construction and is a #GSocketConnection, then the corresponding #GSocket will be put into non-blocking mode. @@ -17883,10 +18211,13 @@ stream from a worker thread, so it is not safe to interact with the stream directly. - + The unique name as assigned by the message bus or %NULL if the + line="787">The unique name as assigned by the message bus or %NULL if the connection is not open or not a message bus connection. @@ -17943,7 +18274,8 @@ once. + glib:nick="none" + glib:name="G_DBUS_CONNECTION_FLAGS_NONE"> No flags set. @@ -17951,7 +18283,8 @@ once. + glib:nick="authentication-client" + glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT"> Perform authentication against server. @@ -17959,7 +18292,8 @@ once. + glib:nick="authentication-server" + glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER"> Perform authentication against client. @@ -17967,7 +18301,8 @@ once. + glib:nick="authentication-allow-anonymous" + glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS"> When @@ -17977,7 +18312,8 @@ method. + glib:nick="message-bus-connection" + glib:name="G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION"> Pass this flag if connecting to a peer that is a @@ -17986,12 +18322,23 @@ message bus. This means that the Hello() method will be invoked as part of the c + glib:nick="delay-message-processing" + glib:name="G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING"> If set, processing of D-Bus messages is delayed until g_dbus_connection_start_message_processing() is called. + + When authenticating +as a server, require the UID of the peer to be the same as the UID of the server. (Since: 2.68) + + glib:nick="failed" + glib:name="G_DBUS_ERROR_FAILED"> A generic error; "something went wrong" - see the error message for @@ -18014,7 +18362,8 @@ more. + glib:nick="no-memory" + glib:name="G_DBUS_ERROR_NO_MEMORY"> There was not enough memory to complete an operation. @@ -18022,7 +18371,8 @@ more. + glib:nick="service-unknown" + glib:name="G_DBUS_ERROR_SERVICE_UNKNOWN"> The bus doesn't know how to launch a service to supply the bus name @@ -18031,7 +18381,8 @@ you wanted. + glib:nick="name-has-no-owner" + glib:name="G_DBUS_ERROR_NAME_HAS_NO_OWNER"> The bus name you referenced doesn't exist (i.e. no application owns @@ -18040,7 +18391,8 @@ it). + glib:nick="no-reply" + glib:name="G_DBUS_ERROR_NO_REPLY"> No reply to a message expecting one, usually means a timeout occurred. @@ -18048,7 +18400,8 @@ it). + glib:nick="io-error" + glib:name="G_DBUS_ERROR_IO_ERROR"> Something went wrong reading or writing to a socket, for example. @@ -18056,7 +18409,8 @@ it). + glib:nick="bad-address" + glib:name="G_DBUS_ERROR_BAD_ADDRESS"> A D-Bus bus address was malformed. @@ -18064,7 +18418,8 @@ it). + glib:nick="not-supported" + glib:name="G_DBUS_ERROR_NOT_SUPPORTED"> Requested operation isn't supported (like ENOSYS on UNIX). @@ -18072,7 +18427,8 @@ it). + glib:nick="limits-exceeded" + glib:name="G_DBUS_ERROR_LIMITS_EXCEEDED"> Some limited resource is exhausted. @@ -18080,7 +18436,8 @@ it). + glib:nick="access-denied" + glib:name="G_DBUS_ERROR_ACCESS_DENIED"> Security restrictions don't allow doing what you're trying to do. @@ -18088,7 +18445,8 @@ it). + glib:nick="auth-failed" + glib:name="G_DBUS_ERROR_AUTH_FAILED"> Authentication didn't work. @@ -18096,7 +18454,8 @@ it). + glib:nick="no-server" + glib:name="G_DBUS_ERROR_NO_SERVER"> Unable to connect to server (probably caused by ECONNREFUSED on a @@ -18105,7 +18464,8 @@ socket). + glib:nick="timeout" + glib:name="G_DBUS_ERROR_TIMEOUT"> Certain timeout errors, possibly ETIMEDOUT on a socket. Note that @@ -18117,7 +18477,8 @@ careful. + glib:nick="no-network" + glib:name="G_DBUS_ERROR_NO_NETWORK"> No network access (probably ENETUNREACH on a socket). @@ -18125,7 +18486,8 @@ careful. + glib:nick="address-in-use" + glib:name="G_DBUS_ERROR_ADDRESS_IN_USE"> Can't bind a socket since its address is in use (i.e. EADDRINUSE). @@ -18133,7 +18495,8 @@ careful. + glib:nick="disconnected" + glib:name="G_DBUS_ERROR_DISCONNECTED"> The connection is disconnected and you're trying to use it. @@ -18141,7 +18504,8 @@ careful. + glib:nick="invalid-args" + glib:name="G_DBUS_ERROR_INVALID_ARGS"> Invalid arguments passed to a method call. @@ -18149,7 +18513,8 @@ careful. + glib:nick="file-not-found" + glib:name="G_DBUS_ERROR_FILE_NOT_FOUND"> Missing file. @@ -18157,7 +18522,8 @@ careful. + glib:nick="file-exists" + glib:name="G_DBUS_ERROR_FILE_EXISTS"> Existing file and the operation you're using does not silently overwrite. @@ -18165,7 +18531,8 @@ careful. + glib:nick="unknown-method" + glib:name="G_DBUS_ERROR_UNKNOWN_METHOD"> Method name you invoked isn't known by the object you invoked it on. @@ -18173,7 +18540,8 @@ careful. + glib:nick="timed-out" + glib:name="G_DBUS_ERROR_TIMED_OUT"> Certain timeout errors, e.g. while starting a service. Warning: this is @@ -18183,7 +18551,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="match-rule-not-found" + glib:name="G_DBUS_ERROR_MATCH_RULE_NOT_FOUND"> Tried to remove or modify a match rule that didn't exist. @@ -18191,7 +18560,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="match-rule-invalid" + glib:name="G_DBUS_ERROR_MATCH_RULE_INVALID"> The match rule isn't syntactically valid. @@ -18199,7 +18569,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-exec-failed" + glib:name="G_DBUS_ERROR_SPAWN_EXEC_FAILED"> While starting a new process, the exec() call failed. @@ -18207,7 +18578,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-fork-failed" + glib:name="G_DBUS_ERROR_SPAWN_FORK_FAILED"> While starting a new process, the fork() call failed. @@ -18215,7 +18587,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-child-exited" + glib:name="G_DBUS_ERROR_SPAWN_CHILD_EXITED"> While starting a new process, the child exited with a status code. @@ -18223,7 +18596,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-child-signaled" + glib:name="G_DBUS_ERROR_SPAWN_CHILD_SIGNALED"> While starting a new process, the child exited on a signal. @@ -18231,7 +18605,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-failed" + glib:name="G_DBUS_ERROR_SPAWN_FAILED"> While starting a new process, something went wrong. @@ -18239,7 +18614,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-setup-failed" + glib:name="G_DBUS_ERROR_SPAWN_SETUP_FAILED"> We failed to setup the environment correctly. @@ -18247,7 +18623,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-config-invalid" + glib:name="G_DBUS_ERROR_SPAWN_CONFIG_INVALID"> We failed to setup the config parser correctly. @@ -18255,7 +18632,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-service-invalid" + glib:name="G_DBUS_ERROR_SPAWN_SERVICE_INVALID"> Bus name was not valid. @@ -18263,7 +18641,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-service-not-found" + glib:name="G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND"> Service file not found in system-services directory. @@ -18271,7 +18650,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-permissions-invalid" + glib:name="G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID"> Permissions are incorrect on the setuid helper. @@ -18279,7 +18659,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-file-invalid" + glib:name="G_DBUS_ERROR_SPAWN_FILE_INVALID"> Service file invalid (Name, User or Exec missing). @@ -18287,7 +18668,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="spawn-no-memory" + glib:name="G_DBUS_ERROR_SPAWN_NO_MEMORY"> Tried to get a UNIX process ID and it wasn't available. @@ -18295,7 +18677,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="unix-process-id-unknown" + glib:name="G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN"> Tried to get a UNIX process ID and it wasn't available. @@ -18303,7 +18686,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="invalid-signature" + glib:name="G_DBUS_ERROR_INVALID_SIGNATURE"> A type signature is not valid. @@ -18311,7 +18695,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="invalid-file-content" + glib:name="G_DBUS_ERROR_INVALID_FILE_CONTENT"> A file contains invalid syntax or is otherwise broken. @@ -18319,7 +18704,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="selinux-security-context-unknown" + glib:name="G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN"> Asked for SELinux security context and it wasn't available. @@ -18327,7 +18713,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="adt-audit-data-unknown" + glib:name="G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN"> Asked for ADT audit data and it wasn't available. @@ -18335,7 +18722,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="object-path-in-use" + glib:name="G_DBUS_ERROR_OBJECT_PATH_IN_USE"> There's already an object with the requested object path. @@ -18343,7 +18731,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="unknown-object" + glib:name="G_DBUS_ERROR_UNKNOWN_OBJECT"> Object you invoked a method on isn't known. Since 2.42 @@ -18351,7 +18740,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="unknown-interface" + glib:name="G_DBUS_ERROR_UNKNOWN_INTERFACE"> Interface you invoked a method on isn't known by the object. Since 2.42 @@ -18359,7 +18749,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="unknown-property" + glib:name="G_DBUS_ERROR_UNKNOWN_PROPERTY"> Property you tried to access isn't known by the object. Since 2.42 @@ -18367,7 +18758,8 @@ can't fix it for compatibility reasons so just be careful. + glib:nick="property-read-only" + glib:name="G_DBUS_ERROR_PROPERTY_READ_ONLY"> Property you tried to set is read-only. Since 2.42 @@ -18377,7 +18769,7 @@ can't fix it for compatibility reasons so just be careful. version="2.26"> Creates a D-Bus error name to use for @error. If @error matches + line="16862">Creates a D-Bus error name to use for @error. If @error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned. @@ -18392,14 +18784,15 @@ This function is typically only used in object mappings to put a A D-Bus error name (never %NULL). Free with g_free(). + line="16878">A D-Bus error name (never %NULL). + Free with g_free(). A #GError. + line="16864">A #GError. @@ -18409,25 +18802,25 @@ This function is typically only used in object mappings to put a version="2.26"> Gets the D-Bus error name used for @error, if any. + line="16884">Gets the D-Bus error name used for @error, if any. This function is guaranteed to return a D-Bus error name for all #GErrors returned from functions handling remote method calls (e.g. g_dbus_connection_call_finish()) unless g_dbus_error_strip_remote_error() has been used on @error. - + an allocated string or %NULL if the D-Bus error name - could not be found. Free with g_free(). + line="16895">an allocated string or %NULL if the + D-Bus error name could not be found. Free with g_free(). a #GError + line="16886">a #GError @@ -18437,13 +18830,13 @@ g_dbus_error_strip_remote_error() has been used on @error. version="2.26"> Checks if @error represents an error received via D-Bus from a remote peer. If so, + line="16901">Checks if @error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error. %TRUE if @error represents an error from a remote peer, + line="16908">%TRUE if @error represents an error from a remote peer, %FALSE otherwise. @@ -18451,7 +18844,7 @@ use g_dbus_error_get_remote_error() to get the name of the error. A #GError. + line="16903">A #GError. @@ -18461,7 +18854,7 @@ use g_dbus_error_get_remote_error() to get the name of the error. version="2.26"> Creates a #GError based on the contents of @dbus_error_name and + line="16914">Creates a #GError based on the contents of @dbus_error_name and @dbus_error_message. Errors registered with g_dbus_error_register_error() will be looked @@ -18491,20 +18884,20 @@ it. An allocated #GError. Free with g_error_free(). + line="16946">An allocated #GError. Free with g_error_free(). D-Bus error name. + line="16916">D-Bus error name. D-Bus error message. + line="16917">D-Bus error message. @@ -18519,7 +18912,7 @@ it. version="2.26"> Creates an association to map between @dbus_error_name and + line="16951">Creates an association to map between @dbus_error_name and #GErrors specified by @error_domain and @error_code. This is typically done in the routine that returns the #GQuark for @@ -18528,7 +18921,7 @@ an error domain. %TRUE if the association was created, %FALSE if it already + line="16963">%TRUE if the association was created, %FALSE if it already exists. @@ -18536,19 +18929,19 @@ exists. A #GQuark for an error domain. + line="16953">A #GQuark for an error domain. An error code. + line="16954">An error code. A D-Bus error name. + line="16955">A D-Bus error name. @@ -18558,7 +18951,10 @@ exists. version="2.26"> Helper function for associating a #GError error domain with D-Bus error names. + line="16969">Helper function for associating a #GError error domain with D-Bus error names. + +While @quark_volatile has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. @@ -18567,19 +18963,19 @@ exists. The error domain name. + line="16971">The error domain name. A pointer where to store the #GQuark. + line="16972">A pointer where to store the #GQuark. A pointer to @num_entries #GDBusErrorEntry struct items. + line="16973">A pointer to @num_entries #GDBusErrorEntry struct items. @@ -18589,7 +18985,7 @@ exists. Number of items to register. + line="16974">Number of items to register. @@ -18600,7 +18996,7 @@ exists. introspectable="0"> Does nothing if @error is %NULL. Otherwise sets *@error to + line="16985">Does nothing if @error is %NULL. Otherwise sets *@error to a new #GError created with g_dbus_error_new_for_dbus_error() with @dbus_error_message prepend with @format (unless %NULL). @@ -18611,19 +19007,19 @@ with @dbus_error_message prepend with @format (unless %NULL). A pointer to a #GError or %NULL. + line="16987">A pointer to a #GError or %NULL. D-Bus error name. + line="16988">D-Bus error name. D-Bus error message. + line="16989">D-Bus error message. allow-none="1"> printf()-style format to prepend to @dbus_error_message or %NULL. + line="16990">printf()-style format to prepend to @dbus_error_message or %NULL. Arguments for @format. + line="16991">Arguments for @format. @@ -18649,7 +19045,7 @@ with @dbus_error_message prepend with @format (unless %NULL). introspectable="0"> Like g_dbus_error_set_dbus_error() but intended for language bindings. + line="17001">Like g_dbus_error_set_dbus_error() but intended for language bindings. @@ -18658,19 +19054,19 @@ with @dbus_error_message prepend with @format (unless %NULL). A pointer to a #GError or %NULL. + line="17003">A pointer to a #GError or %NULL. D-Bus error name. + line="17004">D-Bus error name. D-Bus error message. + line="17005">D-Bus error message. allow-none="1"> printf()-style format to prepend to @dbus_error_message or %NULL. + line="17006">printf()-style format to prepend to @dbus_error_message or %NULL. Arguments for @format. + line="17007">Arguments for @format. @@ -18695,7 +19091,7 @@ with @dbus_error_message prepend with @format (unless %NULL). version="2.26"> Looks for extra information in the error message used to recover + line="17015">Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in @error will correspond exactly to what was received on the wire. @@ -18705,14 +19101,14 @@ This is typically used when presenting errors to the end user. %TRUE if information was stripped, %FALSE otherwise. + line="17026">%TRUE if information was stripped, %FALSE otherwise. A #GError. + line="17017">A #GError. @@ -18722,31 +19118,31 @@ This is typically used when presenting errors to the end user. version="2.26"> Destroys an association previously set up with g_dbus_error_register_error(). + line="17031">Destroys an association previously set up with g_dbus_error_register_error(). %TRUE if the association was destroyed, %FALSE if it wasn't found. + line="17039">%TRUE if the association was destroyed, %FALSE if it wasn't found. A #GQuark for an error domain. + line="17033">A #GQuark for an error domain. An error code. + line="17034">An error code. A D-Bus error name. + line="17035">A D-Bus error name. @@ -18779,19 +19175,19 @@ This is typically used when presenting errors to the end user. glib:type-struct="DBusInterfaceIface"> The #GDBusInterface type is the base type for D-Bus interfaces both + line="5882">The #GDBusInterface type is the base type for D-Bus interfaces both on the service side (see #GDBusInterfaceSkeleton) and client side (see #GDBusProxy). Gets the #GDBusObject that @interface_ belongs to, if any. + line="17163">Gets the #GDBusObject that @interface_ belongs to, if any. - + A #GDBusObject or %NULL. The returned + line="17169">A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). @@ -18799,7 +19195,7 @@ reference should be freed with g_object_unref(). An exported D-Bus interface. + line="17165">An exported D-Bus interface. @@ -18807,20 +19203,20 @@ reference should be freed with g_object_unref(). Gets D-Bus introspection information for the D-Bus interface + line="17175">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. A #GDBusInterfaceInfo. Do not free. + line="17182">A #GDBusInterfaceInfo. Do not free. An exported D-Bus interface. + line="17177">An exported D-Bus interface. @@ -18831,16 +19227,16 @@ implemented by @interface_. introspectable="0"> Gets the #GDBusObject that @interface_ belongs to, if any. + line="17187">Gets the #GDBusObject that @interface_ belongs to, if any. It is not safe to use the returned object if @interface_ or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative. - + A #GDBusObject or %NULL. The returned + line="17197">A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. @@ -18848,7 +19244,7 @@ g_dbus_interface_dup_object() for a thread-safe alternative. An exported D-Bus interface + line="17189">An exported D-Bus interface @@ -18856,7 +19252,7 @@ g_dbus_interface_dup_object() for a thread-safe alternative. Sets the #GDBusObject for @interface_ to @object. + line="17320">Sets the #GDBusObject for @interface_ to @object. Note that @interface_ will hold a weak reference to @object. @@ -18867,7 +19263,7 @@ Note that @interface_ will hold a weak reference to @object. An exported D-Bus interface. + line="17322">An exported D-Bus interface. allow-none="1"> A #GDBusObject or %NULL. + line="17323">A #GDBusObject or %NULL. @@ -18887,12 +19283,12 @@ Note that @interface_ will hold a weak reference to @object. version="2.32"> Gets the #GDBusObject that @interface_ belongs to, if any. + line="17163">Gets the #GDBusObject that @interface_ belongs to, if any. - + A #GDBusObject or %NULL. The returned + line="17169">A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). @@ -18900,7 +19296,7 @@ reference should be freed with g_object_unref(). An exported D-Bus interface. + line="17165">An exported D-Bus interface. @@ -18910,20 +19306,20 @@ reference should be freed with g_object_unref(). version="2.30"> Gets D-Bus introspection information for the D-Bus interface + line="17175">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. A #GDBusInterfaceInfo. Do not free. + line="17182">A #GDBusInterfaceInfo. Do not free. An exported D-Bus interface. + line="17177">An exported D-Bus interface. @@ -18935,16 +19331,16 @@ implemented by @interface_. introspectable="0"> Gets the #GDBusObject that @interface_ belongs to, if any. + line="17187">Gets the #GDBusObject that @interface_ belongs to, if any. It is not safe to use the returned object if @interface_ or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative. - + A #GDBusObject or %NULL. The returned + line="17197">A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. @@ -18952,7 +19348,7 @@ g_dbus_interface_dup_object() for a thread-safe alternative. An exported D-Bus interface + line="17189">An exported D-Bus interface @@ -18962,7 +19358,7 @@ g_dbus_interface_dup_object() for a thread-safe alternative. version="2.30"> Sets the #GDBusObject for @interface_ to @object. + line="17320">Sets the #GDBusObject for @interface_ to @object. Note that @interface_ will hold a weak reference to @object. @@ -18973,7 +19369,7 @@ Note that @interface_ will hold a weak reference to @object. An exported D-Bus interface. + line="17322">An exported D-Bus interface. allow-none="1"> A #GDBusObject or %NULL. + line="17323">A #GDBusObject or %NULL. @@ -19072,14 +19468,14 @@ Note that @interface_ will hold a weak reference to @object. A #GDBusInterfaceInfo. Do not free. + line="17182">A #GDBusInterfaceInfo. Do not free. An exported D-Bus interface. + line="17177">An exported D-Bus interface. @@ -19088,10 +19484,10 @@ Note that @interface_ will hold a weak reference to @object. - + A #GDBusObject or %NULL. The returned + line="17197">A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. @@ -19099,7 +19495,7 @@ Note that @interface_ will hold a weak reference to @object. An exported D-Bus interface + line="17189">An exported D-Bus interface @@ -19115,7 +19511,7 @@ Note that @interface_ will hold a weak reference to @object. An exported D-Bus interface. + line="17322">An exported D-Bus interface. allow-none="1"> A #GDBusObject or %NULL. + line="17323">A #GDBusObject or %NULL. @@ -19133,10 +19529,10 @@ Note that @interface_ will hold a weak reference to @object. - + A #GDBusObject or %NULL. The returned + line="17169">A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). @@ -19144,7 +19540,7 @@ reference should be freed with g_object_unref(). An exported D-Bus interface. + line="17165">An exported D-Bus interface. @@ -19165,7 +19561,7 @@ reference should be freed with g_object_unref(). The reference count or -1 if statically allocated. - + version="2.30"> Builds a lookup-cache to speed up + line="17203">Builds a lookup-cache to speed up g_dbus_interface_info_lookup_method(), g_dbus_interface_info_lookup_signal() and g_dbus_interface_info_lookup_property(). @@ -19228,7 +19624,7 @@ g_dbus_interface_info_cache_release() is called. A #GDBusInterfaceInfo. + line="17205">A #GDBusInterfaceInfo. @@ -19238,7 +19634,7 @@ g_dbus_interface_info_cache_release() is called. version="2.30"> Decrements the usage count for the cache for @info built by + line="17222">Decrements the usage count for the cache for @info built by g_dbus_interface_info_cache_build() (if any) and frees the resources used by the cache if the usage count drops to zero. @@ -19249,7 +19645,7 @@ resources used by the cache if the usage count drops to zero. A GDBusInterfaceInfo + line="17224">A GDBusInterfaceInfo @@ -19259,7 +19655,7 @@ resources used by the cache if the usage count drops to zero. version="2.26"> Appends an XML representation of @info (and its children) to @string_builder. + line="17234">Appends an XML representation of @info (and its children) to @string_builder. This function is typically used for generating introspection XML documents at run-time for handling the @@ -19273,19 +19669,19 @@ method. A #GDBusNodeInfo + line="17236">A #GDBusNodeInfo Indentation level. + line="17237">Indentation level. A #GString to to append XML data to. + line="17238">A #GString to to append XML data to. @@ -19295,28 +19691,28 @@ method. version="2.26"> Looks up information about a method. + line="17251">Looks up information about a method. The cost of this function is O(n) in number of methods unless g_dbus_interface_info_cache_build() has been used on @info. - + A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. + line="17261">A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusInterfaceInfo. + line="17253">A #GDBusInterfaceInfo. A D-Bus method name (typically in CamelCase) + line="17254">A D-Bus method name (typically in CamelCase) @@ -19326,28 +19722,28 @@ g_dbus_interface_info_cache_build() has been used on @info. version="2.26"> Looks up information about a property. + line="17266">Looks up information about a property. The cost of this function is O(n) in number of properties unless g_dbus_interface_info_cache_build() has been used on @info. - + A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. + line="17276">A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusInterfaceInfo. + line="17268">A #GDBusInterfaceInfo. A D-Bus property name (typically in CamelCase). + line="17269">A D-Bus property name (typically in CamelCase). @@ -19357,28 +19753,28 @@ g_dbus_interface_info_cache_build() has been used on @info. version="2.26"> Looks up information about a signal. + line="17281">Looks up information about a signal. The cost of this function is O(n) in number of signals unless g_dbus_interface_info_cache_build() has been used on @info. - + A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. + line="17291">A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusInterfaceInfo. + line="17283">A #GDBusInterfaceInfo. A D-Bus signal name (typically in CamelCase) + line="17284">A D-Bus signal name (typically in CamelCase) @@ -19388,20 +19784,20 @@ g_dbus_interface_info_cache_build() has been used on @info. version="2.26"> If @info is statically allocated does nothing. Otherwise increases + line="17296">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="17303">The same @info. A #GDBusInterfaceInfo + line="17298">A #GDBusInterfaceInfo @@ -19411,7 +19807,7 @@ the reference count. version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + line="17308">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -19422,7 +19818,7 @@ the memory used is freed. A #GDBusInterfaceInfo. + line="17310">A #GDBusInterfaceInfo. @@ -19572,13 +19968,13 @@ the memory used is freed. glib:type-struct="DBusInterfaceSkeletonClass"> Abstract base class for D-Bus interfaces on the service side. + line="5893">Abstract base class for D-Bus interfaces on the service side. If @interface_ has outstanding changes, request for these changes to be + line="17354">If @interface_ has outstanding changes, request for these changes to be emitted immediately. For example, an exported D-Bus interface may queue up property @@ -19594,7 +19990,7 @@ for collapsing multiple property changes into one. A #GDBusInterfaceSkeleton. + line="17356">A #GDBusInterfaceSkeleton. @@ -19618,20 +20014,20 @@ for collapsing multiple property changes into one. Gets D-Bus introspection information for the D-Bus interface + line="17409">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. A #GDBusInterfaceInfo (never %NULL). Do not free. + line="17416">A #GDBusInterfaceInfo (never %NULL). Do not free. A #GDBusInterfaceSkeleton. + line="17411">A #GDBusInterfaceSkeleton. @@ -19642,12 +20038,12 @@ implemented by @interface_. version="2.30"> Gets all D-Bus properties for @interface_. + line="17433">Gets all D-Bus properties for @interface_. A #GVariant of type + line="17439">A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). @@ -19656,7 +20052,7 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + line="17435">A #GDBusInterfaceSkeleton. @@ -19668,21 +20064,21 @@ Free with g_variant_unref(). introspectable="0"> Gets the interface vtable for the D-Bus interface implemented by + line="17446">Gets the interface vtable for the D-Bus interface implemented by @interface_. The returned function pointers should expect @interface_ itself to be passed as @user_data. A #GDBusInterfaceVTable (never %NULL). + line="17454">A #GDBusInterfaceVTable (never %NULL). A #GDBusInterfaceSkeleton. + line="17448">A #GDBusInterfaceSkeleton. @@ -19694,7 +20090,7 @@ itself to be passed as @user_data. throws="1"> Exports @interface_ at @object_path on @connection. + line="17333">Exports @interface_ at @object_path on @connection. This can be called multiple times to export the same @interface_ onto multiple connections however the @object_path provided must be @@ -19705,7 +20101,7 @@ Use g_dbus_interface_skeleton_unexport() to unexport the object. %TRUE if the interface was exported on @connection, otherwise %FALSE with + line="17348">%TRUE if the interface was exported on @connection, otherwise %FALSE with @error set. @@ -19713,20 +20109,20 @@ Use g_dbus_interface_skeleton_unexport() to unexport the object. The D-Bus interface to export. + line="17335">The D-Bus interface to export. A #GDBusConnection to export @interface_ on. + line="17336">A #GDBusConnection to export @interface_ on. The path to export the interface at. + line="17337">The path to export the interface at. @@ -19736,7 +20132,7 @@ Use g_dbus_interface_skeleton_unexport() to unexport the object. version="2.30"> If @interface_ has outstanding changes, request for these changes to be + line="17354">If @interface_ has outstanding changes, request for these changes to be emitted immediately. For example, an exported D-Bus interface may queue up property @@ -19752,7 +20148,7 @@ for collapsing multiple property changes into one. A #GDBusInterfaceSkeleton. + line="17356">A #GDBusInterfaceSkeleton. @@ -19763,12 +20159,12 @@ for collapsing multiple property changes into one. version="2.30"> Gets the first connection that @interface_ is exported on, if any. + line="17371">Gets the first connection that @interface_ is exported on, if any. - + A #GDBusConnection or %NULL if @interface_ is + line="17377">A #GDBusConnection or %NULL if @interface_ is not exported anywhere. Do not free, the object belongs to @interface_. @@ -19776,7 +20172,7 @@ not exported anywhere. Do not free, the object belongs to @interface_. A #GDBusInterfaceSkeleton. + line="17373">A #GDBusInterfaceSkeleton. @@ -19787,12 +20183,12 @@ not exported anywhere. Do not free, the object belongs to @interface_. version="2.32"> Gets a list of the connections that @interface_ is exported on. + line="17383">Gets a list of the connections that @interface_ is exported on. A list of + line="17389">A list of all the connections that @interface_ is exported on. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -19804,7 +20200,7 @@ not exported anywhere. Do not free, the object belongs to @interface_. A #GDBusInterfaceSkeleton. + line="17385">A #GDBusInterfaceSkeleton. @@ -19815,13 +20211,13 @@ not exported anywhere. Do not free, the object belongs to @interface_. version="2.30"> Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior + line="17397">Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior of @interface_ One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. + line="17404">One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. @@ -19829,7 +20225,7 @@ of @interface_ A #GDBusInterfaceSkeleton. + line="17399">A #GDBusInterfaceSkeleton. @@ -19840,20 +20236,20 @@ of @interface_ version="2.30"> Gets D-Bus introspection information for the D-Bus interface + line="17409">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. A #GDBusInterfaceInfo (never %NULL). Do not free. + line="17416">A #GDBusInterfaceInfo (never %NULL). Do not free. A #GDBusInterfaceSkeleton. + line="17411">A #GDBusInterfaceSkeleton. @@ -19864,12 +20260,12 @@ implemented by @interface_. version="2.30"> Gets the object path that @interface_ is exported on, if any. + line="17421">Gets the object path that @interface_ is exported on, if any. - + A string owned by @interface_ or %NULL if @interface_ is not exported + line="17427">A string owned by @interface_ or %NULL if @interface_ is not exported anywhere. Do not free, the string belongs to @interface_. @@ -19877,7 +20273,7 @@ anywhere. Do not free, the string belongs to @interface_. A #GDBusInterfaceSkeleton. + line="17423">A #GDBusInterfaceSkeleton. @@ -19888,12 +20284,12 @@ anywhere. Do not free, the string belongs to @interface_. version="2.30"> Gets all D-Bus properties for @interface_. + line="17433">Gets all D-Bus properties for @interface_. A #GVariant of type + line="17439">A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). @@ -19902,7 +20298,7 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + line="17435">A #GDBusInterfaceSkeleton. @@ -19914,21 +20310,21 @@ Free with g_variant_unref(). introspectable="0"> Gets the interface vtable for the D-Bus interface implemented by + line="17446">Gets the interface vtable for the D-Bus interface implemented by @interface_. The returned function pointers should expect @interface_ itself to be passed as @user_data. A #GDBusInterfaceVTable (never %NULL). + line="17454">A #GDBusInterfaceVTable (never %NULL). A #GDBusInterfaceSkeleton. + line="17448">A #GDBusInterfaceSkeleton. @@ -19939,26 +20335,26 @@ itself to be passed as @user_data. version="2.32"> Checks if @interface_ is exported on @connection. + line="17459">Checks if @interface_ is exported on @connection. %TRUE if @interface_ is exported on @connection, %FALSE otherwise. + line="17466">%TRUE if @interface_ is exported on @connection, %FALSE otherwise. A #GDBusInterfaceSkeleton. + line="17461">A #GDBusInterfaceSkeleton. A #GDBusConnection. + line="17462">A #GDBusConnection. @@ -19968,7 +20364,7 @@ itself to be passed as @user_data. version="2.30"> Sets flags describing what the behavior of @skeleton should be. + line="17471">Sets flags describing what the behavior of @skeleton should be. @@ -19977,14 +20373,14 @@ itself to be passed as @user_data. A #GDBusInterfaceSkeleton. + line="17473">A #GDBusInterfaceSkeleton. Flags from the #GDBusInterfaceSkeletonFlags enumeration. + line="17474">Flags from the #GDBusInterfaceSkeletonFlags enumeration. @@ -19995,7 +20391,7 @@ itself to be passed as @user_data. version="2.30"> Stops exporting @interface_ on all connections it is exported on. + line="17482">Stops exporting @interface_ on all connections it is exported on. To unexport @interface_ from only a single connection, use g_dbus_interface_skeleton_unexport_from_connection() @@ -20007,7 +20403,7 @@ g_dbus_interface_skeleton_unexport_from_connection() A #GDBusInterfaceSkeleton. + line="17484">A #GDBusInterfaceSkeleton. @@ -20018,7 +20414,7 @@ g_dbus_interface_skeleton_unexport_from_connection() version="2.32"> Stops exporting @interface_ on @connection. + line="17495">Stops exporting @interface_ on @connection. To stop exporting on all connections the interface is exported on, use g_dbus_interface_skeleton_unexport(). @@ -20030,14 +20426,14 @@ use g_dbus_interface_skeleton_unexport(). A #GDBusInterfaceSkeleton. + line="17497">A #GDBusInterfaceSkeleton. A #GDBusConnection. + line="17498">A #GDBusConnection. @@ -20048,7 +20444,7 @@ use g_dbus_interface_skeleton_unexport(). transfer-ownership="none"> Flags from the #GDBusInterfaceSkeletonFlags enumeration. + line="851">Flags from the #GDBusInterfaceSkeletonFlags enumeration. @@ -20061,7 +20457,7 @@ use g_dbus_interface_skeleton_unexport(). Emitted when a method is invoked by a remote caller and used to + line="807">Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized. Note that this signal is emitted in a thread dedicated to @@ -20097,14 +20493,14 @@ to was exported in. %TRUE if the call is authorized, %FALSE otherwise. + line="846">%TRUE if the call is authorized, %FALSE otherwise. A #GDBusMethodInvocation. + line="810">A #GDBusMethodInvocation. @@ -20130,14 +20526,14 @@ to was exported in. A #GDBusInterfaceInfo (never %NULL). Do not free. + line="17416">A #GDBusInterfaceInfo (never %NULL). Do not free. A #GDBusInterfaceSkeleton. + line="17411">A #GDBusInterfaceSkeleton. @@ -20150,14 +20546,14 @@ to was exported in. A #GDBusInterfaceVTable (never %NULL). + line="17454">A #GDBusInterfaceVTable (never %NULL). A #GDBusInterfaceSkeleton. + line="17448">A #GDBusInterfaceSkeleton. @@ -20170,7 +20566,7 @@ to was exported in. A #GVariant of type + line="17439">A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). @@ -20179,7 +20575,7 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + line="17435">A #GDBusInterfaceSkeleton. @@ -20196,7 +20592,7 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + line="17356">A #GDBusInterfaceSkeleton. @@ -20239,22 +20635,24 @@ Free with g_variant_unref(). c:type="GDBusInterfaceSkeletonFlags"> Flags describing the behavior of a #GDBusInterfaceSkeleton instance. + line="1749">Flags describing the behavior of a #GDBusInterfaceSkeleton instance. + glib:nick="none" + glib:name="G_DBUS_INTERFACE_SKELETON_FLAGS_NONE"> No flags set. + line="1751">No flags set. + glib:nick="handle-method-invocations-in-thread" + glib:name="G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD"> Each method invocation is handled in + line="1752">Each method invocation is handled in a thread dedicated to the invocation. This means that the method implementation can use blocking IO without blocking any other part of the process. It also means that the method implementation must use locking to access data structures used by other threads. @@ -20347,13 +20745,13 @@ the call, you must return the value of type %G_VARIANT_TYPE_UNIT. glib:get-type="g_dbus_menu_model_get_type"> #GDBusMenuModel is an implementation of #GMenuModel that can be used + line="5917">#GDBusMenuModel is an implementation of #GMenuModel that can be used as a proxy for a menu model that is exported over D-Bus with g_dbus_connection_export_menu_model(). Obtains a #GDBusMenuModel for the menu model which is exported + line="17614">Obtains a #GDBusMenuModel for the menu model which is exported at the given @bus_name and @object_path. The thread default main context is taken at the time of this call. @@ -20365,7 +20763,7 @@ the thread default main context unchanged. a #GDBusMenuModel object. Free with + line="17630">a #GDBusMenuModel object. Free with g_object_unref(). @@ -20373,7 +20771,7 @@ the thread default main context unchanged. a #GDBusConnection + line="17616">a #GDBusConnection allow-none="1"> the bus name which exports the menu model + line="17617">the bus name which exports the menu model or %NULL if @connection is not a message bus connection the object path at which the menu model is exported + line="17619">the object path at which the menu model is exported @@ -20404,17 +20802,17 @@ the thread default main context unchanged. glib:get-type="g_dbus_message_get_type"> A type for representing D-Bus messages that can be sent or received + line="5930">A type for representing D-Bus messages that can be sent or received on a #GDBusConnection. Creates a new empty #GDBusMessage. + line="17910">Creates a new empty #GDBusMessage. A #GDBusMessage. Free with g_object_unref(). + line="17915">A #GDBusMessage. Free with g_object_unref(). @@ -20424,7 +20822,7 @@ on a #GDBusConnection. throws="1"> Creates a new #GDBusMessage from the data stored at @blob. The byte + line="17920">Creates a new #GDBusMessage from the data stored at @blob. The byte order that the message was in can be retrieved using g_dbus_message_get_byte_order(). @@ -20434,7 +20832,7 @@ headers, %G_IO_ERROR_INVALID_ARGUMENT will be returned. A new #GDBusMessage or %NULL if @error is set. Free with + line="17934">A new #GDBusMessage or %NULL if @error is set. Free with g_object_unref(). @@ -20442,7 +20840,7 @@ g_object_unref(). A blob representing a binary D-Bus message. + line="17922">A blob representing a binary D-Bus message. @@ -20450,13 +20848,13 @@ g_object_unref(). The length of @blob. + line="17923">The length of @blob. A #GDBusCapabilityFlags describing what protocol features are supported. + line="17924">A #GDBusCapabilityFlags describing what protocol features are supported. @@ -20466,12 +20864,12 @@ g_object_unref(). version="2.26"> Creates a new #GDBusMessage for a method call. + line="17940">Creates a new #GDBusMessage for a method call. A #GDBusMessage. Free with g_object_unref(). + line="17949">A #GDBusMessage. Free with g_object_unref(). @@ -20481,13 +20879,13 @@ g_object_unref(). allow-none="1"> A valid D-Bus name or %NULL. + line="17942">A valid D-Bus name or %NULL. A valid object path. + line="17943">A valid object path. allow-none="1"> A valid D-Bus interface name or %NULL. + line="17944">A valid D-Bus interface name or %NULL. A valid method name. + line="17945">A valid method name. @@ -20512,31 +20910,31 @@ g_object_unref(). version="2.26"> Creates a new #GDBusMessage for a signal emission. + line="18010">Creates a new #GDBusMessage for a signal emission. A #GDBusMessage. Free with g_object_unref(). + line="18018">A #GDBusMessage. Free with g_object_unref(). A valid object path. + line="18012">A valid object path. A valid D-Bus interface name. + line="18013">A valid D-Bus interface name. A valid signal name. + line="18014">A valid signal name. @@ -20547,13 +20945,13 @@ g_object_unref(). throws="1"> Utility function to calculate how many bytes are needed to + line="17636">Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at @blob. Number of bytes needed or -1 if @error is set (e.g. if + line="17645">Number of bytes needed or -1 if @error is set (e.g. if @blob contains invalid data or not enough data is available to determine the size). @@ -20562,7 +20960,7 @@ determine the size). A blob representing a binary D-Bus message. + line="17638">A blob representing a binary D-Bus message. @@ -20570,7 +20968,7 @@ determine the size). The length of @blob (must be at least 16). + line="17639">The length of @blob (must be at least 16). @@ -20581,7 +20979,7 @@ determine the size). throws="1"> Copies @message. The copy is a deep copy and the returned + line="17652">Copies @message. The copy is a deep copy and the returned #GDBusMessage is completely identical except that it is guaranteed to not be locked. @@ -20591,7 +20989,7 @@ and the per-process or system-wide open files limit is reached. A new #GDBusMessage or %NULL if @error is set. + line="17664">A new #GDBusMessage or %NULL if @error is set. Free with g_object_unref(). @@ -20599,7 +20997,7 @@ and the per-process or system-wide open files limit is reached. A #GDBusMessage. + line="17654">A #GDBusMessage. @@ -20609,12 +21007,12 @@ and the per-process or system-wide open files limit is reached. version="2.26"> Convenience to get the first item in the body of @message. + line="17670">Convenience to get the first item in the body of @message. - + The string item or %NULL if the first item in the body of + line="17676">The string item or %NULL if the first item in the body of @message is not a string. @@ -20622,7 +21020,7 @@ and the per-process or system-wide open files limit is reached. A #GDBusMessage. + line="17672">A #GDBusMessage. @@ -20632,12 +21030,12 @@ and the per-process or system-wide open files limit is reached. version="2.26"> Gets the body of a message. + line="17682">Gets the body of a message. - + A #GVariant or %NULL if the body is + line="17688">A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message. @@ -20645,7 +21043,7 @@ empty. Do not free, it is owned by @message. A #GDBusMessage. + line="17684">A #GDBusMessage. @@ -20654,19 +21052,19 @@ empty. Do not free, it is owned by @message. c:identifier="g_dbus_message_get_byte_order"> Gets the byte order of @message. + line="17694">Gets the byte order of @message. The byte order. + line="17700">The byte order. A #GDBusMessage. + line="17696">A #GDBusMessage. @@ -20676,19 +21074,19 @@ empty. Do not free, it is owned by @message. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. + line="17704">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. - + The value. + line="17710">The value. A #GDBusMessage. + line="17706">A #GDBusMessage. @@ -20698,19 +21096,19 @@ empty. Do not free, it is owned by @message. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. + line="17715">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. - + The value. + line="17721">The value. A #GDBusMessage. + line="17717">A #GDBusMessage. @@ -20720,19 +21118,19 @@ empty. Do not free, it is owned by @message. version="2.26"> Gets the flags for @message. + line="17726">Gets the flags for @message. Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). + line="17732">Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). A #GDBusMessage. + line="17728">A #GDBusMessage. @@ -20742,7 +21140,7 @@ empty. Do not free, it is owned by @message. version="2.26"> Gets a header field on @message. + line="17737">Gets a header field on @message. The caller is responsible for checking the type of the returned #GVariant matches what is expected. @@ -20750,7 +21148,7 @@ matches what is expected. A #GVariant with the value if the header was found, %NULL + line="17747">A #GVariant with the value if the header was found, %NULL otherwise. Do not free, it is owned by @message. @@ -20758,13 +21156,13 @@ otherwise. Do not free, it is owned by @message. A #GDBusMessage. + line="17739">A #GDBusMessage. A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) + line="17740">A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) @@ -20775,12 +21173,12 @@ otherwise. Do not free, it is owned by @message. version="2.26"> Gets an array of all header fields on @message that are set. + line="17753">Gets an array of all header fields on @message that are set. An array of header fields + line="17759">An array of header fields terminated by %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a #guchar. Free with g_free(). @@ -20791,7 +21189,7 @@ is a #guchar. Free with g_free(). A #GDBusMessage. + line="17755">A #GDBusMessage. @@ -20801,43 +21199,44 @@ is a #guchar. Free with g_free(). version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. + line="17766">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. - + The value. + line="17772">The value. A #GDBusMessage. + line="17768">A #GDBusMessage. Checks whether @message is locked. To monitor changes to this + line="17777">Checks whether @message is locked. To monitor changes to this value, conncet to the #GObject::notify signal to listen for changes on the #GDBusMessage:locked property. %TRUE if @message is locked, %FALSE otherwise. + line="17785">%TRUE if @message is locked, %FALSE otherwise. A #GDBusMessage. + line="17779">A #GDBusMessage. @@ -20847,19 +21246,19 @@ on the #GDBusMessage:locked property. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. + line="17790">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. - + The value. + line="17796">The value. A #GDBusMessage. + line="17792">A #GDBusMessage. @@ -20869,19 +21268,19 @@ on the #GDBusMessage:locked property. version="2.26"> Gets the type of @message. + line="17801">Gets the type of @message. A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). + line="17807">A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). A #GDBusMessage. + line="17803">A #GDBusMessage. @@ -20891,19 +21290,19 @@ on the #GDBusMessage:locked property. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. + line="17812">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. The value. + line="17818">The value. A #GDBusMessage. + line="17814">A #GDBusMessage. @@ -20913,19 +21312,19 @@ on the #GDBusMessage:locked property. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. + line="17823">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. - + The value. + line="17829">The value. A #GDBusMessage. + line="17825">A #GDBusMessage. @@ -20935,19 +21334,19 @@ on the #GDBusMessage:locked property. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. + line="17834">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. The value. + line="17840">The value. A #GDBusMessage. + line="17836">A #GDBusMessage. @@ -20957,19 +21356,19 @@ on the #GDBusMessage:locked property. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. + line="17845">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. - + The value. + line="17851">The value. A #GDBusMessage. + line="17847">A #GDBusMessage. @@ -20979,19 +21378,19 @@ on the #GDBusMessage:locked property. version="2.26"> Gets the serial for @message. + line="17856">Gets the serial for @message. A #guint32. + line="17862">A #guint32. A #GDBusMessage. + line="17858">A #GDBusMessage. @@ -21001,19 +21400,21 @@ on the #GDBusMessage:locked property. version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + line="17867">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + +This will always be non-%NULL, but may be an empty string. The value. + line="17875">The value. A #GDBusMessage. + line="17869">A #GDBusMessage. @@ -21023,14 +21424,20 @@ on the #GDBusMessage:locked property. version="2.26"> Gets the UNIX file descriptors associated with @message, if any. + line="17880">Gets the UNIX file descriptors associated with @message, if any. -This method is only available on UNIX. +This method is only available on UNIX. + +The file descriptors normally correspond to %G_VARIANT_TYPE_HANDLE +values in the body of the message. For example, +if g_variant_get_handle() returns 5, that is intended to be a reference +to the file descriptor that can be accessed by +`g_unix_fd_list_get (list, 5, ...)`. - + A #GUnixFDList or %NULL if no file descriptors are + line="17894">A #GUnixFDList or %NULL if no file descriptors are associated. Do not free, this object is owned by @message. @@ -21038,7 +21445,7 @@ associated. Do not free, this object is owned by @message. A #GDBusMessage. + line="17882">A #GDBusMessage. @@ -21046,7 +21453,7 @@ associated. Do not free, this object is owned by @message. If @message is locked, does nothing. Otherwise locks the message. + line="17900">If @message is locked, does nothing. Otherwise locks the message. @@ -21055,7 +21462,7 @@ associated. Do not free, this object is owned by @message. A #GDBusMessage. + line="17902">A #GDBusMessage. @@ -21066,12 +21473,12 @@ associated. Do not free, this object is owned by @message. introspectable="0"> Creates a new #GDBusMessage that is an error reply to @method_call_message. + line="17954">Creates a new #GDBusMessage that is an error reply to @method_call_message. A #GDBusMessage. Free with g_object_unref(). + line="17964">A #GDBusMessage. Free with g_object_unref(). @@ -21079,26 +21486,26 @@ associated. Do not free, this object is owned by @message. transfer-ownership="none"> A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + line="17956">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. A valid D-Bus error name. + line="17958">A valid D-Bus error name. The D-Bus error message in a printf() format. + line="17959">The D-Bus error message in a printf() format. Arguments for @error_message_format. + line="17960">Arguments for @error_message_format. @@ -21108,12 +21515,12 @@ create a reply message to. version="2.26"> Creates a new #GDBusMessage that is an error reply to @method_call_message. + line="17969">Creates a new #GDBusMessage that is an error reply to @method_call_message. A #GDBusMessage. Free with g_object_unref(). + line="17978">A #GDBusMessage. Free with g_object_unref(). @@ -21121,20 +21528,20 @@ create a reply message to. transfer-ownership="none"> A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + line="17971">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. A valid D-Bus error name. + line="17973">A valid D-Bus error name. The D-Bus error message. + line="17974">The D-Bus error message. @@ -21145,12 +21552,12 @@ create a reply message to. introspectable="0"> Like g_dbus_message_new_method_error() but intended for language bindings. + line="17983">Like g_dbus_message_new_method_error() but intended for language bindings. A #GDBusMessage. Free with g_object_unref(). + line="17993">A #GDBusMessage. Free with g_object_unref(). @@ -21158,26 +21565,26 @@ create a reply message to. transfer-ownership="none"> A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + line="17985">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. A valid D-Bus error name. + line="17987">A valid D-Bus error name. The D-Bus error message in a printf() format. + line="17988">The D-Bus error message in a printf() format. Arguments for @error_message_format. + line="17989">Arguments for @error_message_format. @@ -21187,12 +21594,12 @@ create a reply message to. version="2.26"> Creates a new #GDBusMessage that is a reply to @method_call_message. + line="17998">Creates a new #GDBusMessage that is a reply to @method_call_message. #GDBusMessage. Free with g_object_unref(). + line="18005">#GDBusMessage. Free with g_object_unref(). @@ -21200,7 +21607,7 @@ create a reply message to. transfer-ownership="none"> A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + line="18000">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. @@ -21209,7 +21616,7 @@ create a reply message to. Produces a human-readable multi-line description of @message. + line="18023">Produces a human-readable multi-line description of @message. The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. Typical output @@ -21245,20 +21652,20 @@ UNIX File Descriptors: A string that should be freed with g_free(). + line="18061">A string that should be freed with g_free(). A #GDBusMessage. + line="18025">A #GDBusMessage. Indentation level. + line="18026">Indentation level. @@ -21268,7 +21675,7 @@ UNIX File Descriptors: version="2.26"> Sets the body @message. As a side-effect the + line="18066">Sets the body @message. As a side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the type string of @body (or cleared if @body is %NULL). @@ -21281,13 +21688,13 @@ If @body is floating, @message assumes ownership of @body. A #GDBusMessage. + line="18068">A #GDBusMessage. Either %NULL or a #GVariant that is a tuple. + line="18069">Either %NULL or a #GVariant that is a tuple. @@ -21296,7 +21703,7 @@ If @body is floating, @message assumes ownership of @body. c:identifier="g_dbus_message_set_byte_order"> Sets the byte order of @message. + line="18081">Sets the byte order of @message. @@ -21305,13 +21712,13 @@ If @body is floating, @message assumes ownership of @body. A #GDBusMessage. + line="18083">A #GDBusMessage. The byte order. + line="18084">The byte order. @@ -21321,7 +21728,7 @@ If @body is floating, @message assumes ownership of @body. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. + line="18090">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. @@ -21330,13 +21737,16 @@ If @body is floating, @message assumes ownership of @body. A #GDBusMessage. + line="18092">A #GDBusMessage. - + The value to set. + line="18093">The value to set. @@ -21346,22 +21756,25 @@ If @body is floating, @message assumes ownership of @body. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. + line="18101">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. - + A #GDBusMessage. + line="18103">A #GDBusMessage. The value to set. + line="18104">The value to set. @@ -21371,7 +21784,7 @@ If @body is floating, @message assumes ownership of @body. version="2.26"> Sets the flags to set on @message. + line="18112">Sets the flags to set on @message. @@ -21380,13 +21793,13 @@ If @body is floating, @message assumes ownership of @body. A #GDBusMessage. + line="18114">A #GDBusMessage. Flags for @message that are set (typically values from the #GDBusMessageFlags + line="18115">Flags for @message that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). @@ -21397,7 +21810,7 @@ enumeration bitwise ORed together). version="2.26"> Sets a header field on @message. + line="18124">Sets a header field on @message. If @value is floating, @message assumes ownership of @value. @@ -21408,13 +21821,13 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18126">A #GDBusMessage. A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) + line="18127">A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) @@ -21424,7 +21837,7 @@ If @value is floating, @message assumes ownership of @value. allow-none="1"> A #GVariant to set the header field or %NULL to clear the header field. + line="18128">A #GVariant to set the header field or %NULL to clear the header field. @@ -21434,7 +21847,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. + line="18138">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. @@ -21443,13 +21856,16 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18140">A #GDBusMessage. - + The value to set. + line="18141">The value to set. @@ -21459,7 +21875,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. + line="18149">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. @@ -21468,13 +21884,16 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18151">A #GDBusMessage. - + The value to set. + line="18152">The value to set. @@ -21484,7 +21903,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Sets @message to be of @type. + line="18160">Sets @message to be of @type. @@ -21493,13 +21912,13 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18162">A #GDBusMessage. A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). + line="18163">A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). @@ -21509,7 +21928,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. + line="18171">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. @@ -21518,13 +21937,13 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18173">A #GDBusMessage. The value to set. + line="18174">The value to set. @@ -21534,7 +21953,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. + line="18182">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. @@ -21543,13 +21962,16 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18184">A #GDBusMessage. - + The value to set. + line="18185">The value to set. @@ -21559,7 +21981,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. + line="18193">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. @@ -21568,13 +21990,13 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18195">A #GDBusMessage. The value to set. + line="18196">The value to set. @@ -21584,7 +22006,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. + line="18204">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. @@ -21593,13 +22015,16 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18206">A #GDBusMessage. - + The value to set. + line="18207">The value to set. @@ -21609,7 +22034,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Sets the serial for @message. + line="18215">Sets the serial for @message. @@ -21618,13 +22043,13 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18217">A #GDBusMessage. A #guint32. + line="18218">A #guint32. @@ -21634,7 +22059,7 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + line="18226">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. @@ -21643,13 +22068,16 @@ If @value is floating, @message assumes ownership of @value. A #GDBusMessage. + line="18228">A #GDBusMessage. - + The value to set. + line="18229">The value to set. @@ -21659,12 +22087,17 @@ If @value is floating, @message assumes ownership of @value. version="2.26"> Sets the UNIX file descriptors associated with @message. As a + line="18237">Sets the UNIX file descriptors associated with @message. As a side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field is set to the number of fds in @fd_list (or cleared if @fd_list is %NULL). -This method is only available on UNIX. +This method is only available on UNIX. + +When designing D-Bus APIs that are intended to be interoperable, +please note that non-GDBus implementations of D-Bus can usually only +access file descriptors if they are referenced by a value of type +%G_VARIANT_TYPE_HANDLE in the body of the message. @@ -21673,7 +22106,7 @@ This method is only available on UNIX. A #GDBusMessage. + line="18239">A #GDBusMessage. allow-none="1"> A #GUnixFDList or %NULL. + line="18240">A #GUnixFDList or %NULL. @@ -21693,13 +22126,13 @@ This method is only available on UNIX. throws="1"> Serializes @message to a blob. The byte order returned by + line="18258">Serializes @message to a blob. The byte order returned by g_dbus_message_get_byte_order() will be used. A pointer to a + line="18268">A pointer to a valid binary D-Bus message of @out_size bytes generated by @message or %NULL if @error is set. Free with g_free(). @@ -21710,7 +22143,7 @@ or %NULL if @error is set. Free with g_free(). A #GDBusMessage. + line="18260">A #GDBusMessage. transfer-ownership="full"> Return location for size of generated blob. + line="18261">Return location for size of generated blob. A #GDBusCapabilityFlags describing what protocol features are supported. + line="18262">A #GDBusCapabilityFlags describing what protocol features are supported. @@ -21736,7 +22169,7 @@ or %NULL if @error is set. Free with g_free(). throws="1"> If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does + line="18275">If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does nothing and returns %FALSE. Otherwise this method encodes the error in @message as a #GError @@ -21747,19 +22180,19 @@ well as the first string item in @message's body. %TRUE if @error was set, %FALSE otherwise. + line="18288">%TRUE if @error was set, %FALSE otherwise. A #GDBusMessage. + line="18277">A #GDBusMessage. - + @@ -21770,22 +22203,24 @@ well as the first string item in @message's body. c:type="GDBusMessageByteOrder"> Enumeration used to describe the byte order of a D-Bus message. + line="1456">Enumeration used to describe the byte order of a D-Bus message. + glib:nick="big-endian" + glib:name="G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN"> The byte order is big endian. + line="1458">The byte order is big endian. + glib:nick="little-endian" + glib:name="G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN"> The byte order is little endian. + line="1459">The byte order is little endian. c:type="GDBusMessageFlags"> Message flags used in #GDBusMessage. + line="1281">Message flags used in #GDBusMessage. + glib:nick="none" + glib:name="G_DBUS_MESSAGE_FLAGS_NONE"> No flags set. + line="1283">No flags set. + glib:nick="no-reply-expected" + glib:name="G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED"> A reply is not expected. + line="1284">A reply is not expected. + glib:nick="no-auto-start" + glib:name="G_DBUS_MESSAGE_FLAGS_NO_AUTO_START"> The bus must not launch an + line="1285">The bus must not launch an owner for the destination name in response to this message. + glib:nick="allow-interactive-authorization" + glib:name="G_DBUS_MESSAGE_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION"> If set on a method + line="1287">If set on a method call, this flag means that the caller is prepared to wait for interactive authorization. Since 2.46. @@ -21944,86 +22383,96 @@ authorization. Since 2.46. c:type="GDBusMessageHeaderField"> Header fields used in #GDBusMessage. + line="1302">Header fields used in #GDBusMessage. + glib:nick="invalid" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_INVALID"> Not a valid header field. + line="1304">Not a valid header field. + glib:nick="path" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_PATH"> The object path. + line="1305">The object path. + glib:nick="interface" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE"> The interface name. + line="1306">The interface name. + glib:nick="member" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_MEMBER"> The method or signal name. + line="1307">The method or signal name. + glib:nick="error-name" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME"> The name of the error that occurred. + line="1308">The name of the error that occurred. + glib:nick="reply-serial" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL"> The serial number the message is a reply to. + line="1309">The serial number the message is a reply to. + glib:nick="destination" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION"> The name the message is intended for. + line="1310">The name the message is intended for. + glib:nick="sender" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_SENDER"> Unique name of the sender of the message (filled in by the bus). + line="1311">Unique name of the sender of the message (filled in by the bus). + glib:nick="signature" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE"> The signature of the message body. + line="1312">The signature of the message body. + glib:nick="num-unix-fds" + glib:name="G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS"> The number of UNIX file descriptors that accompany the message. + line="1313">The number of UNIX file descriptors that accompany the message. c:type="GDBusMessageType"> Message types used in #GDBusMessage. + line="1261">Message types used in #GDBusMessage. + glib:nick="invalid" + glib:name="G_DBUS_MESSAGE_TYPE_INVALID"> Message is of invalid type. + line="1263">Message is of invalid type. + glib:nick="method-call" + glib:name="G_DBUS_MESSAGE_TYPE_METHOD_CALL"> Method call. + line="1264">Method call. + glib:nick="method-return" + glib:name="G_DBUS_MESSAGE_TYPE_METHOD_RETURN"> Method reply. + line="1265">Method reply. + glib:nick="error" + glib:name="G_DBUS_MESSAGE_TYPE_ERROR"> Error reply. + line="1266">Error reply. + glib:nick="signal" + glib:name="G_DBUS_MESSAGE_TYPE_SIGNAL"> Signal emission. + line="1267">Signal emission. The reference count or -1 if statically allocated. - + If @info is statically allocated does nothing. Otherwise increases + line="18293">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="18300">The same @info. A #GDBusMethodInfo + line="18295">A #GDBusMethodInfo @@ -22147,7 +22601,7 @@ the reference count. version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + line="18305">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -22158,7 +22612,7 @@ the memory used is freed. A #GDBusMethodInfo. + line="18307">A #GDBusMethodInfo. @@ -22173,7 +22627,7 @@ the memory used is freed. glib:get-type="g_dbus_method_invocation_get_type"> Instances of the #GDBusMethodInvocation class are used when + line="5940">Instances of the #GDBusMethodInvocation class are used when handling D-Bus method calls. It provides a way to asynchronously return results and errors. @@ -22185,19 +22639,19 @@ it as an argument to the handle_method_call() function in a version="2.26"> Gets the #GDBusConnection the method was invoked on. - + line="18317">Gets the #GDBusConnection the method was invoked on. + A #GDBusConnection. Do not free, it is owned by @invocation. + line="18323">A #GDBusConnection. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18319">A #GDBusMethodInvocation. @@ -22207,24 +22661,24 @@ it as an argument to the handle_method_call() function in a version="2.26"> Gets the name of the D-Bus interface the method was invoked on. + line="18328">Gets the name of the D-Bus interface the method was invoked on. If this method call is a property Get, Set or GetAll call that has been redirected to the method call handler then "org.freedesktop.DBus.Properties" will be returned. See #GDBusInterfaceVTable for more information. - + A string. Do not free, it is owned by @invocation. + line="18339">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18330">A #GDBusMethodInvocation. @@ -22234,7 +22688,7 @@ been redirected to the method call handler then version="2.26"> Gets the #GDBusMessage for the method invocation. This is useful if + line="18344">Gets the #GDBusMessage for the method invocation. This is useful if you need to use low-level protocol features, such as UNIX file descriptor passing, that cannot be properly expressed in the #GVariant API. @@ -22242,18 +22696,18 @@ descriptor passing, that cannot be properly expressed in the See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors. - + #GDBusMessage. Do not free, it is owned by @invocation. + line="18357">#GDBusMessage. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18346">A #GDBusMethodInvocation. @@ -22263,24 +22717,24 @@ UNIX file descriptors. version="2.26"> Gets information about the method call, if any. + line="18362">Gets information about the method call, if any. If this method invocation is a property Get, Set or GetAll call that has been redirected to the method call handler then %NULL will be returned. See g_dbus_method_invocation_get_property_info() and #GDBusInterfaceVTable for more information. - - + + A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. + line="18373">A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18364">A #GDBusMethodInvocation. @@ -22290,19 +22744,19 @@ returned. See g_dbus_method_invocation_get_property_info() and version="2.26"> Gets the name of the method that was invoked. - + line="18378">Gets the name of the method that was invoked. + A string. Do not free, it is owned by @invocation. + line="18384">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18380">A #GDBusMethodInvocation. @@ -22312,19 +22766,19 @@ returned. See g_dbus_method_invocation_get_property_info() and version="2.26"> Gets the object path the method was invoked on. - + line="18389">Gets the object path the method was invoked on. + A string. Do not free, it is owned by @invocation. + line="18395">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18391">A #GDBusMethodInvocation. @@ -22334,20 +22788,20 @@ returned. See g_dbus_method_invocation_get_property_info() and version="2.26"> Gets the parameters of the method invocation. If there are no input + line="18400">Gets the parameters of the method invocation. If there are no input parameters then this will return a GVariant with 0 children rather than NULL. - + A #GVariant tuple. Do not unref this because it is owned by @invocation. + line="18407">A #GVariant tuple. Do not unref this because it is owned by @invocation. A #GDBusMethodInvocation. + line="18402">A #GDBusMethodInvocation. @@ -22357,7 +22811,7 @@ parameters then this will return a GVariant with 0 children rather than NULL. Gets information about the property that this method call is for, if + line="18412">Gets information about the property that this method call is for, if any. This will only be set in the case of an invocation in response to a @@ -22368,18 +22822,18 @@ property_set() vtable pointers being unset. See #GDBusInterfaceVTable for more information. If the call was GetAll, %NULL will be returned. - - + + a #GDBusPropertyInfo or %NULL + line="18428">a #GDBusPropertyInfo or %NULL A #GDBusMethodInvocation + line="18414">A #GDBusMethodInvocation @@ -22389,19 +22843,19 @@ If the call was GetAll, %NULL will be returned. version="2.26"> Gets the bus name that invoked the method. - + line="18433">Gets the bus name that invoked the method. + A string. Do not free, it is owned by @invocation. + line="18439">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + line="18435">A #GDBusMethodInvocation. @@ -22412,19 +22866,19 @@ If the call was GetAll, %NULL will be returned. introspectable="0"> Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). - + line="18444">Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). + A #gpointer. + line="18450">A #gpointer. A #GDBusMethodInvocation. + line="18446">A #GDBusMethodInvocation. @@ -22434,12 +22888,12 @@ If the call was GetAll, %NULL will be returned. version="2.26"> Finishes handling a D-Bus method call by returning an error. + line="18455">Finishes handling a D-Bus method call by returning an error. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + @@ -22447,19 +22901,19 @@ This method will take ownership of @invocation. See A #GDBusMethodInvocation. + line="18457">A #GDBusMethodInvocation. A valid D-Bus error name. + line="18458">A valid D-Bus error name. A valid D-Bus error message. + line="18459">A valid D-Bus error message. @@ -22470,7 +22924,7 @@ This method will take ownership of @invocation. See introspectable="0"> Finishes handling a D-Bus method call by returning an error. + line="18471">Finishes handling a D-Bus method call by returning an error. See g_dbus_error_encode_gerror() for details about what error name will be returned on the wire. In a nutshell, if the given error is @@ -22490,7 +22944,7 @@ This method will take ownership of @invocation. See Since 2.48, if the method call requested for a reply not to be sent then this call will free @invocation but otherwise do nothing (as per the recommendations of the D-Bus specification). - + @@ -22498,31 +22952,31 @@ the recommendations of the D-Bus specification). A #GDBusMethodInvocation. + line="18473">A #GDBusMethodInvocation. A #GQuark for the #GError error domain. + line="18474">A #GQuark for the #GError error domain. The error code. + line="18475">The error code. printf()-style format. + line="18476">printf()-style format. Parameters for @format. + line="18477">Parameters for @format. @@ -22532,12 +22986,12 @@ the recommendations of the D-Bus specification). version="2.26"> Like g_dbus_method_invocation_return_error() but without printf()-style formatting. + line="18504">Like g_dbus_method_invocation_return_error() but without printf()-style formatting. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + @@ -22545,25 +22999,25 @@ This method will take ownership of @invocation. See A #GDBusMethodInvocation. + line="18506">A #GDBusMethodInvocation. A #GQuark for the #GError error domain. + line="18507">A #GQuark for the #GError error domain. The error code. + line="18508">The error code. The error message. + line="18509">The error message. @@ -22574,13 +23028,13 @@ This method will take ownership of @invocation. See introspectable="0"> Like g_dbus_method_invocation_return_error() but intended for + line="18521">Like g_dbus_method_invocation_return_error() but intended for language bindings. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + @@ -22588,31 +23042,31 @@ This method will take ownership of @invocation. See A #GDBusMethodInvocation. + line="18523">A #GDBusMethodInvocation. A #GQuark for the #GError error domain. + line="18524">A #GQuark for the #GError error domain. The error code. + line="18525">The error code. printf()-style format. + line="18526">printf()-style format. #va_list of parameters for @format. + line="18527">#va_list of parameters for @format. @@ -22622,13 +23076,13 @@ This method will take ownership of @invocation. See version="2.26"> Like g_dbus_method_invocation_return_error() but takes a #GError + line="18540">Like g_dbus_method_invocation_return_error() but takes a #GError instead of the error domain, error code and message. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + @@ -22636,13 +23090,13 @@ This method will take ownership of @invocation. See A #GDBusMethodInvocation. + line="18542">A #GDBusMethodInvocation. A #GError. + line="18543">A #GError. @@ -22652,7 +23106,7 @@ This method will take ownership of @invocation. See version="2.26"> Finishes handling a D-Bus method call by returning @parameters. + line="18556">Finishes handling a D-Bus method call by returning @parameters. If the @parameters GVariant is floating, it is consumed. It is an error if @parameters is not of the right format: it must be a tuple @@ -22684,7 +23138,7 @@ Since 2.48, if the method call requested for a reply not to be sent then this call will sink @parameters and free @invocation, but otherwise do nothing (as per the recommendations of the D-Bus specification). - + @@ -22692,7 +23146,7 @@ specification). A #GDBusMethodInvocation. + line="18558">A #GDBusMethodInvocation. allow-none="1"> A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. + line="18559">A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. @@ -22711,14 +23165,14 @@ specification). version="2.30"> Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. + line="18598">Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. This method is only available on UNIX. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + @@ -22726,7 +23180,7 @@ This method will take ownership of @invocation. See A #GDBusMethodInvocation. + line="18600">A #GDBusMethodInvocation. A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. + line="18601">A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. A #GUnixFDList or %NULL. + line="18602">A #GUnixFDList or %NULL. @@ -22755,13 +23209,13 @@ This method will take ownership of @invocation. See introspectable="0"> Like g_dbus_method_invocation_return_gerror() but takes ownership + line="18616">Like g_dbus_method_invocation_return_gerror() but takes ownership of @error so the caller does not need to free it. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + @@ -22769,13 +23223,13 @@ This method will take ownership of @invocation. See A #GDBusMethodInvocation. + line="18618">A #GDBusMethodInvocation. A #GError. + line="18619">A #GError. @@ -22795,7 +23249,7 @@ This method will take ownership of @invocation. See The reference count or -1 if statically allocated. - + Parses @xml_data and returns a #GDBusNodeInfo representing the data. + line="18661">Parses @xml_data and returns a #GDBusNodeInfo representing the data. The introspection XML must contain exactly one top-level <node> element. @@ -22845,7 +23299,7 @@ parser that only accepts a subset of valid XML documents. A #GDBusNodeInfo structure or %NULL if @error is set. Free + line="18675">A #GDBusNodeInfo structure or %NULL if @error is set. Free with g_dbus_node_info_unref(). @@ -22853,7 +23307,7 @@ with g_dbus_node_info_unref(). Valid D-Bus introspection XML. + line="18663">Valid D-Bus introspection XML. @@ -22863,7 +23317,7 @@ with g_dbus_node_info_unref(). version="2.26"> Appends an XML representation of @info (and its children) to @string_builder. + line="18632">Appends an XML representation of @info (and its children) to @string_builder. This function is typically used for generating introspection XML documents at run-time for handling the `org.freedesktop.DBus.Introspectable.Introspect` method. @@ -22875,19 +23329,19 @@ handling the `org.freedesktop.DBus.Introspectable.Introspect` method. A #GDBusNodeInfo. + line="18634">A #GDBusNodeInfo. Indentation level. + line="18635">Indentation level. A #GString to to append XML data to. + line="18636">A #GString to to append XML data to. @@ -22897,27 +23351,27 @@ handling the `org.freedesktop.DBus.Introspectable.Introspect` method. version="2.26"> Looks up information about an interface. + line="18647">Looks up information about an interface. The cost of this function is O(n) in number of interfaces. - + A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info. + line="18656">A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusNodeInfo. + line="18649">A #GDBusNodeInfo. A D-Bus interface name. + line="18650">A D-Bus interface name. @@ -22925,20 +23379,20 @@ The cost of this function is O(n) in number of interfaces. If @info is statically allocated does nothing. Otherwise increases + line="18681">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="18688">The same @info. A #GDBusNodeInfo + line="18683">A #GDBusNodeInfo @@ -22948,7 +23402,7 @@ the reference count. version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + line="18693">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -22959,7 +23413,7 @@ the memory used is freed. A #GDBusNodeInfo. + line="18695">A #GDBusNodeInfo. @@ -22973,7 +23427,7 @@ the memory used is freed. glib:type-struct="DBusObjectIface"> The #GDBusObject type is the base type for D-Bus objects on both + line="5981">The #GDBusObject type is the base type for D-Bus objects on both the service side (see #GDBusObjectSkeleton) and the client side (see #GDBusObjectProxy). It is essentially just a container of interfaces. @@ -22983,13 +23437,13 @@ interfaces. version="2.30"> Gets the D-Bus interface with name @interface_name associated with + line="18705">Gets the D-Bus interface with name @interface_name associated with @object, if any. - + %NULL if not found, otherwise a + line="18713">%NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). @@ -22997,13 +23451,13 @@ interfaces. A #GDBusObject. + line="18707">A #GDBusObject. A D-Bus interface name. + line="18708">A D-Bus interface name. @@ -23013,12 +23467,12 @@ interfaces. version="2.30"> Gets the D-Bus interfaces associated with @object. + line="18719">Gets the D-Bus interfaces associated with @object. A list of #GDBusInterface instances. + line="18725">A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -23029,7 +23483,7 @@ interfaces. A #GDBusObject. + line="18721">A #GDBusObject. @@ -23039,19 +23493,19 @@ interfaces. version="2.30"> Gets the object path for @object. + line="18732">Gets the object path for @object. A string owned by @object. Do not free. + line="18738">A string owned by @object. Do not free. A #GDBusObject. + line="18734">A #GDBusObject. @@ -23089,13 +23543,13 @@ interfaces. version="2.30"> Gets the D-Bus interface with name @interface_name associated with + line="18705">Gets the D-Bus interface with name @interface_name associated with @object, if any. - + %NULL if not found, otherwise a + line="18713">%NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). @@ -23103,13 +23557,13 @@ interfaces. A #GDBusObject. + line="18707">A #GDBusObject. A D-Bus interface name. + line="18708">A D-Bus interface name. @@ -23119,12 +23573,12 @@ interfaces. version="2.30"> Gets the D-Bus interfaces associated with @object. + line="18719">Gets the D-Bus interfaces associated with @object. A list of #GDBusInterface instances. + line="18725">A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -23135,7 +23589,7 @@ interfaces. A #GDBusObject. + line="18721">A #GDBusObject. @@ -23145,19 +23599,19 @@ interfaces. version="2.30"> Gets the object path for @object. + line="18732">Gets the object path for @object. A string owned by @object. Do not free. + line="18738">A string owned by @object. Do not free. A #GDBusObject. + line="18734">A #GDBusObject. @@ -23165,7 +23619,7 @@ interfaces. Emitted when @interface is added to @object. + line="914">Emitted when @interface is added to @object. @@ -23173,7 +23627,7 @@ interfaces. The #GDBusInterface that was added. + line="917">The #GDBusInterface that was added. @@ -23181,7 +23635,7 @@ interfaces. Emitted when @interface is removed from @object. + line="925">Emitted when @interface is removed from @object. @@ -23189,7 +23643,7 @@ interfaces. The #GDBusInterface that was removed. + line="928">The #GDBusInterface that was removed. @@ -23215,14 +23669,14 @@ interfaces. A string owned by @object. Do not free. + line="18738">A string owned by @object. Do not free. A #GDBusObject. + line="18734">A #GDBusObject. @@ -23234,7 +23688,7 @@ interfaces. A list of #GDBusInterface instances. + line="18725">A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -23245,7 +23699,7 @@ interfaces. A #GDBusObject. + line="18721">A #GDBusObject. @@ -23254,10 +23708,10 @@ interfaces. - + %NULL if not found, otherwise a + line="18713">%NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). @@ -23265,13 +23719,13 @@ interfaces. A #GDBusObject. + line="18707">A #GDBusObject. A D-Bus interface name. + line="18708">A D-Bus interface name. @@ -23318,7 +23772,7 @@ interfaces. glib:type-struct="DBusObjectManagerIface"> The #GDBusObjectManager type is the base type for service- and + line="5993">The #GDBusObjectManager type is the base type for service- and client-side implementations of the standardized [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface. @@ -23331,13 +23785,13 @@ and #GDBusObjectManagerServer for the service-side implementation. version="2.30"> Gets the interface proxy for @interface_name at @object_path, if + line="18927">Gets the interface proxy for @interface_name at @object_path, if any. - + A #GDBusInterface instance or %NULL. Free + line="18936">A #GDBusInterface instance or %NULL. Free with g_object_unref(). @@ -23345,19 +23799,19 @@ any. A #GDBusObjectManager. + line="18929">A #GDBusObjectManager. Object path to look up. + line="18930">Object path to look up. D-Bus interface name to look up. + line="18931">D-Bus interface name to look up. @@ -23365,12 +23819,12 @@ any. Gets the #GDBusObjectProxy at @object_path, if any. + line="18942">Gets the #GDBusObjectProxy at @object_path, if any. - + A #GDBusObject or %NULL. Free with + line="18949">A #GDBusObject or %NULL. Free with g_object_unref(). @@ -23378,13 +23832,13 @@ any. A #GDBusObjectManager. + line="18944">A #GDBusObjectManager. Object path to look up. + line="18945">Object path to look up. @@ -23394,19 +23848,19 @@ any. version="2.30"> Gets the object path that @manager is for. + line="18955">Gets the object path that @manager is for. A string owned by @manager. Do not free. + line="18961">A string owned by @manager. Do not free. A #GDBusObjectManager. + line="18957">A #GDBusObjectManager. @@ -23414,12 +23868,12 @@ any. Gets all #GDBusObject objects known to @manager. + line="18966">Gets all #GDBusObject objects known to @manager. A list of + line="18972">A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -23431,7 +23885,7 @@ any. A #GDBusObjectManager. + line="18968">A #GDBusObjectManager. @@ -23503,13 +23957,13 @@ any. version="2.30"> Gets the interface proxy for @interface_name at @object_path, if + line="18927">Gets the interface proxy for @interface_name at @object_path, if any. - + A #GDBusInterface instance or %NULL. Free + line="18936">A #GDBusInterface instance or %NULL. Free with g_object_unref(). @@ -23517,19 +23971,19 @@ any. A #GDBusObjectManager. + line="18929">A #GDBusObjectManager. Object path to look up. + line="18930">Object path to look up. D-Bus interface name to look up. + line="18931">D-Bus interface name to look up. @@ -23539,12 +23993,12 @@ any. version="2.30"> Gets the #GDBusObjectProxy at @object_path, if any. + line="18942">Gets the #GDBusObjectProxy at @object_path, if any. - + A #GDBusObject or %NULL. Free with + line="18949">A #GDBusObject or %NULL. Free with g_object_unref(). @@ -23552,13 +24006,13 @@ any. A #GDBusObjectManager. + line="18944">A #GDBusObjectManager. Object path to look up. + line="18945">Object path to look up. @@ -23568,19 +24022,19 @@ any. version="2.30"> Gets the object path that @manager is for. + line="18955">Gets the object path that @manager is for. A string owned by @manager. Do not free. + line="18961">A string owned by @manager. Do not free. A #GDBusObjectManager. + line="18957">A #GDBusObjectManager. @@ -23590,12 +24044,12 @@ any. version="2.30"> Gets all #GDBusObject objects known to @manager. + line="18966">Gets all #GDBusObject objects known to @manager. A list of + line="18972">A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -23607,7 +24061,7 @@ any. A #GDBusObjectManager. + line="18968">A #GDBusObjectManager. @@ -23615,7 +24069,7 @@ any. Emitted when @interface is added to @object. + line="944">Emitted when @interface is added to @object. This signal exists purely as a convenience to avoid having to connect signals to all objects managed by @manager. @@ -23626,13 +24080,13 @@ connect signals to all objects managed by @manager. The #GDBusObject on which an interface was added. + line="947">The #GDBusObject on which an interface was added. The #GDBusInterface that was added. + line="948">The #GDBusInterface that was added. @@ -23640,7 +24094,7 @@ connect signals to all objects managed by @manager. Emitted when @interface has been removed from @object. + line="959">Emitted when @interface has been removed from @object. This signal exists purely as a convenience to avoid having to connect signals to all objects managed by @manager. @@ -23651,13 +24105,13 @@ connect signals to all objects managed by @manager. The #GDBusObject on which an interface was removed. + line="962">The #GDBusObject on which an interface was removed. The #GDBusInterface that was removed. + line="963">The #GDBusInterface that was removed. @@ -23665,7 +24119,7 @@ connect signals to all objects managed by @manager. Emitted when @object is added to @manager. + line="974">Emitted when @object is added to @manager. @@ -23673,7 +24127,7 @@ connect signals to all objects managed by @manager. The #GDBusObject that was added. + line="977">The #GDBusObject that was added. @@ -23681,7 +24135,7 @@ connect signals to all objects managed by @manager. Emitted when @object is removed from @manager. + line="985">Emitted when @object is removed from @manager. @@ -23689,7 +24143,7 @@ connect signals to all objects managed by @manager. The #GDBusObject that was removed. + line="988">The #GDBusObject that was removed. @@ -23705,7 +24159,7 @@ connect signals to all objects managed by @manager. glib:type-struct="DBusObjectManagerClientClass"> #GDBusObjectManagerClient is used to create, monitor and delete object + line="6008">#GDBusObjectManagerClient is used to create, monitor and delete object proxies for remote objects exported by a #GDBusObjectManagerServer (or any code implementing the [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) @@ -23790,12 +24244,12 @@ same main loop. throws="1"> Finishes an operation started with g_dbus_object_manager_client_new(). + line="18821">Finishes an operation started with g_dbus_object_manager_client_new(). A + line="18828">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -23804,7 +24258,7 @@ same main loop. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). + line="18823">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). @@ -23815,12 +24269,12 @@ same main loop. throws="1"> Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). + line="18862">Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). A + line="18869">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -23829,7 +24283,7 @@ same main loop. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). + line="18864">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). @@ -23840,7 +24294,7 @@ same main loop. throws="1"> Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead + line="18876">Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection. This is a synchronous failable constructor - the calling thread is @@ -23850,7 +24304,7 @@ for the asynchronous version. A + line="18895">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -23859,26 +24313,26 @@ for the asynchronous version. A #GBusType. + line="18878">A #GBusType. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + line="18879">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. The owner of the control object (unique or well-known name). + line="18880">The owner of the control object (unique or well-known name). The object path of the control object. + line="18881">The object path of the control object. destroy="6"> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + line="18882">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. allow-none="1"> User data to pass to @get_proxy_type_func. + line="18883">User data to pass to @get_proxy_type_func. scope="async"> Free function for @get_proxy_type_user_data or %NULL. + line="18884">Free function for @get_proxy_type_user_data or %NULL. allow-none="1"> A #GCancellable or %NULL + line="18885">A #GCancellable or %NULL @@ -23929,7 +24383,7 @@ for the asynchronous version. throws="1"> Creates a new #GDBusObjectManagerClient object. + line="18902">Creates a new #GDBusObjectManagerClient object. This is a synchronous failable constructor - the calling thread is blocked until a reply is received. See g_dbus_object_manager_client_new() @@ -23938,7 +24392,7 @@ for the asynchronous version. A + line="18920">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -23947,13 +24401,13 @@ for the asynchronous version. A #GDBusConnection. + line="18904">A #GDBusConnection. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + line="18905">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. @@ -23963,13 +24417,13 @@ for the asynchronous version. allow-none="1"> The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection. + line="18906">The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection. The object path of the control object. + line="18907">The object path of the control object. destroy="6"> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + line="18908">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. allow-none="1"> User data to pass to @get_proxy_type_func. + line="18909">User data to pass to @get_proxy_type_func. scope="async"> Free function for @get_proxy_type_user_data or %NULL. + line="18910">Free function for @get_proxy_type_user_data or %NULL. allow-none="1"> A #GCancellable or %NULL + line="18911">A #GCancellable or %NULL @@ -24019,7 +24473,7 @@ for the asynchronous version. version="2.30"> Asynchronously creates a new #GDBusObjectManagerClient object. + line="18795">Asynchronously creates a new #GDBusObjectManagerClient object. This is an asynchronous failable constructor. When the result is ready, @callback will be invoked in the @@ -24035,26 +24489,26 @@ g_dbus_object_manager_client_new_sync() for the synchronous version. A #GDBusConnection. + line="18797">A #GDBusConnection. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + line="18798">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. The owner of the control object (unique or well-known name). + line="18799">The owner of the control object (unique or well-known name). The object path of the control object. + line="18800">The object path of the control object. destroy="6"> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + line="18801">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. allow-none="1"> User data to pass to @get_proxy_type_func. + line="18802">User data to pass to @get_proxy_type_func. scope="async"> Free function for @get_proxy_type_user_data or %NULL. + line="18803">Free function for @get_proxy_type_user_data or %NULL. allow-none="1"> A #GCancellable or %NULL + line="18804">A #GCancellable or %NULL closure="9"> A #GAsyncReadyCallback to call when the request is satisfied. + line="18805">A #GAsyncReadyCallback to call when the request is satisfied. allow-none="1"> The data to pass to @callback. + line="18806">The data to pass to @callback. @@ -24124,7 +24578,7 @@ g_dbus_object_manager_client_new_sync() for the synchronous version. version="2.30"> Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a + line="18835">Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a #GDBusConnection. This is an asynchronous failable constructor. When the result is @@ -24141,26 +24595,26 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. A #GBusType. + line="18837">A #GBusType. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + line="18838">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. The owner of the control object (unique or well-known name). + line="18839">The owner of the control object (unique or well-known name). The object path of the control object. + line="18840">The object path of the control object. A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + line="18841">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. User data to pass to @get_proxy_type_func. + line="18842">User data to pass to @get_proxy_type_func. Free function for @get_proxy_type_user_data or %NULL. + line="18843">Free function for @get_proxy_type_user_data or %NULL. A #GCancellable or %NULL + line="18844">A #GCancellable or %NULL A #GAsyncReadyCallback to call when the request is satisfied. + line="18845">A #GAsyncReadyCallback to call when the request is satisfied. The data to pass to @callback. + line="18846">The data to pass to @callback. @@ -24278,15 +24732,16 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. Gets the #GDBusConnection used by @manager. + line="18743">Gets the #GDBusConnection used by @manager. A #GDBusConnection object. Do not free, + line="18749">A #GDBusConnection object. Do not free, the object belongs to @manager. @@ -24294,7 +24749,7 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. A #GDBusObjectManagerClient + line="18745">A #GDBusObjectManagerClient @@ -24302,15 +24757,16 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. Gets the flags that @manager was constructed with. + line="18755">Gets the flags that @manager was constructed with. Zero of more flags from the #GDBusObjectManagerClientFlags + line="18761">Zero of more flags from the #GDBusObjectManagerClientFlags enumeration. @@ -24319,7 +24775,7 @@ enumeration. A #GDBusObjectManagerClient + line="18757">A #GDBusObjectManagerClient @@ -24327,16 +24783,17 @@ enumeration. Gets the name that @manager is for, or %NULL if not a message bus + line="18767">Gets the name that @manager is for, or %NULL if not a message bus connection. A unique or well-known name. Do not free, the string + line="18774">A unique or well-known name. Do not free, the string belongs to @manager. @@ -24344,7 +24801,7 @@ belongs to @manager. A #GDBusObjectManagerClient + line="18769">A #GDBusObjectManagerClient @@ -24352,10 +24809,11 @@ belongs to @manager. The unique name that owns the name that @manager is for or %NULL if + line="18780">The unique name that owns the name that @manager is for or %NULL if no-one currently owns that name. You can connect to the #GObject::notify signal to track changes to the #GDBusObjectManagerClient:name-owner property. @@ -24363,7 +24821,7 @@ no-one currently owns that name. You can connect to the The name owner or %NULL if no name owner + line="18789">The name owner or %NULL if no name owner exists. Free with g_free(). @@ -24371,7 +24829,7 @@ exists. Free with g_free(). A #GDBusObjectManagerClient. + line="18782">A #GDBusObjectManagerClient. @@ -24385,7 +24843,7 @@ exists. Free with g_free(). transfer-ownership="none"> If this property is not %G_BUS_TYPE_NONE, then + line="1043">If this property is not %G_BUS_TYPE_NONE, then #GDBusObjectManagerClient:connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property. @@ -24395,20 +24853,22 @@ of this property. version="2.30" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_connection"> The #GDBusConnection to use. + line="1055">The #GDBusConnection to use. + transfer-ownership="none" + getter="get_flags"> Flags from the #GDBusObjectManagerClientFlags enumeration. + line="1064">Flags from the #GDBusObjectManagerClientFlags enumeration. transfer-ownership="none"> A #GDestroyNotify for the #gpointer user_data in #GDBusObjectManagerClient:get-proxy-type-user-data. + line="1073">A #GDestroyNotify for the #gpointer user_data in #GDBusObjectManagerClient:get-proxy-type-user-data. transfer-ownership="none"> The #GDBusProxyTypeFunc to use when determining what #GType to + line="1082">The #GDBusProxyTypeFunc to use when determining what #GType to use for interface proxies or %NULL. @@ -24439,23 +24899,27 @@ use for interface proxies or %NULL. transfer-ownership="none"> The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func. + line="1092">The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func. + transfer-ownership="none" + getter="get_name"> The well-known name or unique name that the manager is for. + line="1101">The well-known name or unique name that the manager is for. - + The unique name that owns #GDBusObjectManagerClient:name or %NULL if + line="1110">The unique name that owns #GDBusObjectManagerClient:name or %NULL if no-one is currently owning the name. Connect to the #GObject::notify signal to track changes to this property. @@ -24467,7 +24931,7 @@ no-one is currently owning the name. Connect to the transfer-ownership="none"> The object path the manager is for. + line="1121">The object path the manager is for. @@ -24482,7 +24946,7 @@ no-one is currently owning the name. Connect to the version="2.30"> Emitted when one or more D-Bus properties on proxy changes. The + line="996">Emitted when one or more D-Bus properties on proxy changes. The local cache has already been updated when this signal fires. Note that both @changed_properties and @invalidated_properties are guaranteed to never be %NULL (either may be empty though). @@ -24500,25 +24964,25 @@ that @manager was constructed in. The #GDBusObjectProxy on which an interface has properties that are changing. + line="999">The #GDBusObjectProxy on which an interface has properties that are changing. The #GDBusProxy that has properties that are changing. + line="1000">The #GDBusProxy that has properties that are changing. A #GVariant containing the properties that changed (type: `a{sv}`). + line="1001">A #GVariant containing the properties that changed (type: `a{sv}`). A %NULL terminated + line="1002">A %NULL terminated array of properties that were invalidated. @@ -24529,7 +24993,7 @@ that @manager was constructed in. Emitted when a D-Bus signal is received on @interface_proxy. + line="1021">Emitted when a D-Bus signal is received on @interface_proxy. This signal exists purely as a convenience to avoid having to connect signals to all interface proxies managed by @manager. @@ -24544,31 +25008,31 @@ that @manager was constructed in. The #GDBusObjectProxy on which an interface is emitting a D-Bus signal. + line="1024">The #GDBusObjectProxy on which an interface is emitting a D-Bus signal. The #GDBusProxy that is emitting a D-Bus signal. + line="1025">The #GDBusProxy that is emitting a D-Bus signal. The sender of the signal or NULL if the connection is not a bus connection. + line="1026">The sender of the signal or NULL if the connection is not a bus connection. The signal name. + line="1027">The signal name. A #GVariant tuple with parameters for the signal. + line="1028">A #GVariant tuple with parameters for the signal. @@ -24656,22 +25120,24 @@ that @manager was constructed in. c:type="GDBusObjectManagerClientFlags"> Flags used when constructing a #GDBusObjectManagerClient. + line="1767">Flags used when constructing a #GDBusObjectManagerClient. + glib:nick="none" + glib:name="G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_NONE"> No flags set. + line="1769">No flags set. + glib:nick="do-not-auto-start" + glib:name="G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START"> If not set and the + line="1770">If not set and the manager is for a well-known name, then request the bus to launch an owner for the name if no-one owns the name. This flag can only be used in managers for well-known names. @@ -24702,14 +25168,14 @@ that @manager was constructed in. A string owned by @manager. Do not free. + line="18961">A string owned by @manager. Do not free. A #GDBusObjectManager. + line="18957">A #GDBusObjectManager. @@ -24721,7 +25187,7 @@ that @manager was constructed in. A list of + line="18972">A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -24733,7 +25199,7 @@ that @manager was constructed in. A #GDBusObjectManager. + line="18968">A #GDBusObjectManager. @@ -24742,10 +25208,10 @@ that @manager was constructed in. - + A #GDBusObject or %NULL. Free with + line="18949">A #GDBusObject or %NULL. Free with g_object_unref(). @@ -24753,13 +25219,13 @@ that @manager was constructed in. A #GDBusObjectManager. + line="18944">A #GDBusObjectManager. Object path to look up. + line="18945">Object path to look up. @@ -24768,10 +25234,10 @@ that @manager was constructed in. - + A #GDBusInterface instance or %NULL. Free + line="18936">A #GDBusInterface instance or %NULL. Free with g_object_unref(). @@ -24779,19 +25245,19 @@ that @manager was constructed in. A #GDBusObjectManager. + line="18929">A #GDBusObjectManager. Object path to look up. + line="18930">Object path to look up. D-Bus interface name to look up. + line="18931">D-Bus interface name to look up. @@ -24878,7 +25344,7 @@ that @manager was constructed in. glib:type-struct="DBusObjectManagerServerClass"> #GDBusObjectManagerServer is used to export #GDBusObject instances using + line="6091">#GDBusObjectManagerServer is used to export #GDBusObject instances using the standardized [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface. For example, remote D-Bus clients can get all objects @@ -24907,7 +25373,7 @@ interface. version="2.30"> Creates a new #GDBusObjectManagerServer object. + line="19039">Creates a new #GDBusObjectManagerServer object. The returned server isn't yet exported on any connection. To do so, use g_dbus_object_manager_server_set_connection(). Normally you @@ -24918,7 +25384,7 @@ signals being emitted. A #GDBusObjectManagerServer object. Free with g_object_unref(). + line="19051">A #GDBusObjectManagerServer object. Free with g_object_unref(). @@ -24926,7 +25392,7 @@ signals being emitted. The object path to export the manager object at. + line="19041">The object path to export the manager object at. @@ -24936,7 +25402,7 @@ signals being emitted. version="2.30"> Exports @object on @manager. + line="18980">Exports @object on @manager. If there is already a #GDBusObject exported at the object path, then the old object is removed. @@ -24954,14 +25420,14 @@ it is exported. A #GDBusObjectManagerServer. + line="18982">A #GDBusObjectManagerServer. A #GDBusObjectSkeleton. + line="18983">A #GDBusObjectSkeleton. @@ -24971,7 +25437,7 @@ it is exported. version="2.30"> Like g_dbus_object_manager_server_export() but appends a string of + line="19000">Like g_dbus_object_manager_server_export() but appends a string of the form _N (with N being a natural number) to @object's object path if an object with the given path already exists. As such, the #GDBusObjectProxy:g-object-path property of @object may be modified. @@ -24983,29 +25449,30 @@ if an object with the given path already exists. As such, the A #GDBusObjectManagerServer. + line="19002">A #GDBusObjectManagerServer. An object. + line="19003">An object. Gets the #GDBusConnection used by @manager. + line="19014">Gets the #GDBusConnection used by @manager. - + A #GDBusConnection object or %NULL if + line="19020">A #GDBusConnection object or %NULL if @manager isn't exported on a connection. The returned object should be freed with g_object_unref(). @@ -25014,7 +25481,7 @@ if an object with the given path already exists. As such, the A #GDBusObjectManagerServer + line="19016">A #GDBusObjectManagerServer @@ -25025,35 +25492,36 @@ if an object with the given path already exists. As such, the version="2.34"> Returns whether @object is currently exported on @manager. + line="19027">Returns whether @object is currently exported on @manager. %TRUE if @object is exported + line="19034">%TRUE if @object is exported A #GDBusObjectManagerServer. + line="19029">A #GDBusObjectManagerServer. An object. + line="19030">An object. + c:identifier="g_dbus_object_manager_server_set_connection" + glib:set-property="connection"> Exports all objects managed by @manager on @connection. If + line="19056">Exports all objects managed by @manager on @connection. If @connection is %NULL, stops exporting objects. @@ -25063,7 +25531,7 @@ if an object with the given path already exists. As such, the A #GDBusObjectManagerServer. + line="19058">A #GDBusObjectManagerServer. @@ -25073,7 +25541,7 @@ if an object with the given path already exists. As such, the allow-none="1"> A #GDBusConnection or %NULL. + line="19059">A #GDBusConnection or %NULL. @@ -25083,7 +25551,7 @@ if an object with the given path already exists. As such, the version="2.30"> If @manager has an object at @path, removes the object. Otherwise + line="19066">If @manager has an object at @path, removes the object. Otherwise does nothing. Note that @object_path must be in the hierarchy rooted by the @@ -25092,21 +25560,21 @@ object path for @manager. %TRUE if object at @object_path was removed, %FALSE otherwise. + line="19077">%TRUE if object at @object_path was removed, %FALSE otherwise. A #GDBusObjectManagerServer. + line="19068">A #GDBusObjectManagerServer. An object path. + line="19069">An object path. @@ -25114,10 +25582,12 @@ object path for @manager. + transfer-ownership="none" + setter="set_connection" + getter="get_connection"> The #GDBusConnection to export objects on. + line="1130">The #GDBusConnection to export objects on. transfer-ownership="none"> The object path to register the manager object at. + line="1139">The object path to register the manager object at. @@ -25173,7 +25643,7 @@ object path for @manager. glib:type-struct="DBusObjectProxyClass"> A #GDBusObjectProxy is an object used to represent a remote object + line="6121">A #GDBusObjectProxy is an object used to represent a remote object with one or more D-Bus interfaces. Normally, you don't instantiate a #GDBusObjectProxy yourself - typically #GDBusObjectManagerClient is used to obtain it. @@ -25184,26 +25654,26 @@ is used to obtain it. version="2.30"> Creates a new #GDBusObjectProxy for the given connection and + line="19094">Creates a new #GDBusObjectProxy for the given connection and object path. a new #GDBusObjectProxy + line="19102">a new #GDBusObjectProxy a #GDBusConnection + line="19096">a #GDBusConnection the object path + line="19097">the object path @@ -25213,12 +25683,12 @@ object path. version="2.30"> Gets the connection that @proxy is for. + line="19082">Gets the connection that @proxy is for. A #GDBusConnection. Do not free, the + line="19088">A #GDBusConnection. Do not free, the object is owned by @proxy. @@ -25226,7 +25696,7 @@ object path. a #GDBusObjectProxy + line="19084">a #GDBusObjectProxy @@ -25238,7 +25708,7 @@ object path. transfer-ownership="none"> The connection of the proxy. + line="1148">The connection of the proxy. transfer-ownership="none"> The object path of the proxy. + line="1157">The object path of the proxy. @@ -25293,7 +25763,7 @@ object path. glib:type-struct="DBusObjectSkeletonClass"> A #GDBusObjectSkeleton instance is essentially a group of D-Bus + line="6135">A #GDBusObjectSkeleton instance is essentially a group of D-Bus interfaces. The set of exported interfaces on the object may be dynamic and change at runtime. @@ -25305,19 +25775,19 @@ This type is intended to be used with #GDBusObjectManager. version="2.30"> Creates a new #GDBusObjectSkeleton. + line="19136">Creates a new #GDBusObjectSkeleton. A #GDBusObjectSkeleton. Free with g_object_unref(). + line="19142">A #GDBusObjectSkeleton. Free with g_object_unref(). An object path. + line="19138">An object path. @@ -25345,7 +25815,7 @@ This type is intended to be used with #GDBusObjectManager. version="2.30"> Adds @interface_ to @object. + line="19107">Adds @interface_ to @object. If @object already contains a #GDBusInterfaceSkeleton with the same interface name, it is removed before @interface_ is added. @@ -25360,13 +25830,13 @@ it until removed. A #GDBusObjectSkeleton. + line="19109">A #GDBusObjectSkeleton. A #GDBusInterfaceSkeleton. + line="19110">A #GDBusInterfaceSkeleton. @@ -25377,7 +25847,7 @@ it until removed. version="2.30"> This method simply calls g_dbus_interface_skeleton_flush() on all + line="19124">This method simply calls g_dbus_interface_skeleton_flush() on all interfaces belonging to @object. See that method for when flushing is useful. @@ -25388,7 +25858,7 @@ is useful. A #GDBusObjectSkeleton. + line="19126">A #GDBusObjectSkeleton. @@ -25398,7 +25868,7 @@ is useful. version="2.30"> Removes @interface_ from @object. + line="19147">Removes @interface_ from @object. @@ -25407,13 +25877,13 @@ is useful. A #GDBusObjectSkeleton. + line="19149">A #GDBusObjectSkeleton. A #GDBusInterfaceSkeleton. + line="19150">A #GDBusInterfaceSkeleton. @@ -25424,7 +25894,7 @@ is useful. version="2.30"> Removes the #GDBusInterface with @interface_name from @object. + line="19158">Removes the #GDBusInterface with @interface_name from @object. If no D-Bus interface of the given interface exists, this function does nothing. @@ -25436,13 +25906,13 @@ does nothing. A #GDBusObjectSkeleton. + line="19160">A #GDBusObjectSkeleton. A D-Bus interface name. + line="19161">A D-Bus interface name. @@ -25452,7 +25922,7 @@ does nothing. version="2.30"> Sets the object path for @object. + line="19172">Sets the object path for @object. @@ -25461,13 +25931,13 @@ does nothing. A #GDBusObjectSkeleton. + line="19174">A #GDBusObjectSkeleton. A valid D-Bus object path. + line="19175">A valid D-Bus object path. @@ -25479,7 +25949,7 @@ does nothing. transfer-ownership="none"> The object path where the object is exported. + line="1186">The object path where the object is exported. @@ -25492,7 +25962,7 @@ does nothing. Emitted when a method is invoked by a remote caller and used to + line="1166">Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized. This signal is like #GDBusInterfaceSkeleton's @@ -25503,20 +25973,20 @@ The default class handler just returns %TRUE. %TRUE if the call is authorized, %FALSE otherwise. + line="1181">%TRUE if the call is authorized, %FALSE otherwise. The #GDBusInterfaceSkeleton that @invocation is for. + line="1169">The #GDBusInterfaceSkeleton that @invocation is for. A #GDBusMethodInvocation. + line="1170">A #GDBusMethodInvocation. @@ -25582,7 +26052,7 @@ The default class handler just returns %TRUE. The reference count or -1 if statically allocated. - + version="2.26"> If @info is statically allocated does nothing. Otherwise increases + line="19183">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="19190">The same @info. A #GDBusPropertyInfo + line="19185">A #GDBusPropertyInfo @@ -25638,7 +26108,7 @@ the reference count. version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + line="19195">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -25649,7 +26119,7 @@ the memory used is freed. A #GDBusPropertyInfo. + line="19197">A #GDBusPropertyInfo. @@ -25662,30 +26132,33 @@ the memory used is freed. c:type="GDBusPropertyInfoFlags"> Flags describing the access control of a D-Bus property. + line="1332">Flags describing the access control of a D-Bus property. + glib:nick="none" + glib:name="G_DBUS_PROPERTY_INFO_FLAGS_NONE"> No flags set. + line="1334">No flags set. + glib:nick="readable" + glib:name="G_DBUS_PROPERTY_INFO_FLAGS_READABLE"> Property is readable. + line="1335">Property is readable. + glib:nick="writable" + glib:name="G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE"> Property is writable. + line="1336">Property is writable. glib:type-struct="DBusProxyClass"> #GDBusProxy is a base class used for proxies to access a D-Bus + line="6148">#GDBusProxy is a base class used for proxies to access a D-Bus interface on a remote object. A #GDBusProxy can be constructed for both well-known and unique names. @@ -25720,6 +26193,13 @@ then calls will be sent to the well-known name which may result in the message bus launching an owner (unless %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set). +If the proxy is for a stateless D-Bus service, where the name owner may +be started and stopped between calls, the #GDBusProxy:g-name-owner tracking +of #GDBusProxy will cause the proxy to drop signal and property changes from +the service after it has restarted for the first time. When interacting +with a stateless D-Bus service, do not use #GDBusProxy — use direct D-Bus +method calls and signal connections. + The generic #GDBusProxy::g-properties-changed and #GDBusProxy::g-signal signals are not very convenient to work with. Therefore, the recommended way of working with proxies is to subclass @@ -25734,7 +26214,7 @@ and #GObject::notify) are emitted in the of the thread where the instance was constructed. An example using a proxy for a well-known name can be found in -[gdbus-example-watch-proxy.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-proxy.c) +[gdbus-example-watch-proxy.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-watch-proxy.c) @@ -25745,12 +26225,12 @@ An example using a proxy for a well-known name can be found in throws="1"> Finishes creating a #GDBusProxy. + line="19575">Finishes creating a #GDBusProxy. A #GDBusProxy or %NULL if @error is set. + line="19582">A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). @@ -25758,7 +26238,7 @@ An example using a proxy for a well-known name can be found in A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new(). + line="19577">A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new(). @@ -25769,12 +26249,12 @@ An example using a proxy for a well-known name can be found in throws="1"> Finishes creating a #GDBusProxy. + line="19608">Finishes creating a #GDBusProxy. A #GDBusProxy or %NULL if @error is set. + line="19615">A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). @@ -25782,7 +26262,7 @@ An example using a proxy for a well-known name can be found in A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus(). + line="19610">A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus(). @@ -25793,14 +26273,14 @@ An example using a proxy for a well-known name can be found in throws="1"> Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + line="19621">Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. A #GDBusProxy or %NULL if error is set. + line="19637">A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). @@ -25808,13 +26288,13 @@ An example using a proxy for a well-known name can be found in A #GBusType. + line="19623">A #GBusType. Flags used when constructing the proxy. + line="19624">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface + line="19625">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique). + line="19627">A bus name (well-known or unique). An object path. + line="19628">An object path. A D-Bus interface name. + line="19629">A D-Bus interface name. A #GCancellable or %NULL. + line="19630">A #GCancellable or %NULL. @@ -25862,7 +26342,7 @@ An example using a proxy for a well-known name can be found in throws="1"> Creates a proxy for accessing @interface_name on the remote object + line="19643">Creates a proxy for accessing @interface_name on the remote object at @object_path owned by @name at @connection and synchronously loads D-Bus properties unless the %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. @@ -25888,7 +26368,7 @@ and g_dbus_proxy_new_finish() for the asynchronous version. A #GDBusProxy or %NULL if error is set. + line="19677">A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). @@ -25896,13 +26376,13 @@ and g_dbus_proxy_new_finish() for the asynchronous version. A #GDBusConnection. + line="19645">A #GDBusConnection. Flags used when constructing the proxy. + line="19646">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + line="19647">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + line="19648">A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. An object path. + line="19649">An object path. A D-Bus interface name. + line="19650">A D-Bus interface name. A #GCancellable or %NULL. + line="19651">A #GCancellable or %NULL. @@ -25949,7 +26429,7 @@ and g_dbus_proxy_new_finish() for the asynchronous version. Creates a proxy for accessing @interface_name on the remote object + line="19531">Creates a proxy for accessing @interface_name on the remote object at @object_path owned by @name at @connection and asynchronously loads D-Bus properties unless the %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to @@ -25984,13 +26464,13 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. A #GDBusConnection. + line="19533">A #GDBusConnection. Flags used when constructing the proxy. + line="19534">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + line="19535">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + line="19536">A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. An object path. + line="19537">An object path. A D-Bus interface name. + line="19538">A D-Bus interface name. A #GCancellable or %NULL. + line="19539">A #GCancellable or %NULL. Callback function to invoke when the proxy is ready. + line="19540">Callback function to invoke when the proxy is ready. User data to pass to @callback. + line="19541">User data to pass to @callback. @@ -26059,7 +26539,7 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. version="2.26"> Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + line="19588">Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. @@ -26070,13 +26550,13 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. A #GBusType. + line="19590">A #GBusType. Flags used when constructing the proxy. + line="19591">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + line="19592">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique). + line="19593">A bus name (well-known or unique). An object path. + line="19594">An object path. A D-Bus interface name. + line="19595">A D-Bus interface name. A #GCancellable or %NULL. + line="19596">A #GCancellable or %NULL. Callback function to invoke when the proxy is ready. + line="19597">Callback function to invoke when the proxy is ready. User data to pass to @callback. + line="19598">User data to pass to @callback. @@ -26177,7 +26657,7 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. Asynchronously invokes the @method_name method on @proxy. + line="19207">Asynchronously invokes the @method_name method on @proxy. If @method_name contains any dots, then @name is split into interface and method name parts. This allows using @proxy for invoking methods on @@ -26227,13 +26707,13 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. A #GDBusProxy. + line="19209">A #GDBusProxy. Name of method to invoke. + line="19210">Name of method to invoke. allow-none="1"> A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. + line="19211">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + line="19212">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + line="19213">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -26264,7 +26744,7 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. allow-none="1"> A #GCancellable or %NULL. + line="19215">A #GCancellable or %NULL. closure="6"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't + line="19216">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation. @@ -26285,7 +26765,7 @@ care about the result of the method invocation. allow-none="1"> The data to pass to @callback. + line="19218">The data to pass to @callback. @@ -26296,12 +26776,12 @@ care about the result of the method invocation. throws="1"> Finishes an operation started with g_dbus_proxy_call(). + line="19267">Finishes an operation started with g_dbus_proxy_call(). %NULL if @error is set. Otherwise a #GVariant tuple with + line="19275">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). @@ -26309,13 +26789,13 @@ return values. Free with g_variant_unref(). A #GDBusProxy. + line="19269">A #GDBusProxy. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call(). + line="19270">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call(). @@ -26326,7 +26806,7 @@ return values. Free with g_variant_unref(). throws="1"> Synchronously invokes the @method_name method on @proxy. + line="19281">Synchronously invokes the @method_name method on @proxy. If @method_name contains any dots, then @name is split into interface and method name parts. This allows using @proxy for invoking methods on @@ -26364,7 +26844,7 @@ then the return value is checked against the return type. %NULL if @error is set. Otherwise a #GVariant tuple with + line="19328">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). @@ -26372,13 +26852,13 @@ return values. Free with g_variant_unref(). A #GDBusProxy. + line="19283">A #GDBusProxy. Name of method to invoke. + line="19284">Name of method to invoke. allow-none="1"> A #GVariant tuple with parameters for the signal + line="19285">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + line="19287">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + line="19288">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -26410,7 +26890,7 @@ return values. Free with g_variant_unref(). allow-none="1"> A #GCancellable or %NULL. + line="19290">A #GCancellable or %NULL. @@ -26420,7 +26900,7 @@ return values. Free with g_variant_unref(). version="2.30"> Like g_dbus_proxy_call() but also takes a #GUnixFDList object. + line="19334">Like g_dbus_proxy_call() but also takes a #GUnixFDList object. This method is only available on UNIX. @@ -26431,13 +26911,13 @@ This method is only available on UNIX. A #GDBusProxy. + line="19336">A #GDBusProxy. Name of method to invoke. + line="19337">Name of method to invoke. allow-none="1"> A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. + line="19338">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + line="19339">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + line="19340">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -26468,7 +26948,7 @@ This method is only available on UNIX. allow-none="1"> A #GUnixFDList or %NULL. + line="19342">A #GUnixFDList or %NULL. allow-none="1"> A #GCancellable or %NULL. + line="19343">A #GCancellable or %NULL. closure="7"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't + line="19344">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation. @@ -26498,7 +26978,7 @@ care about the result of the method invocation. allow-none="1"> The data to pass to @callback. + line="19346">The data to pass to @callback. @@ -26509,12 +26989,12 @@ care about the result of the method invocation. throws="1"> Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). + line="19356">Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). %NULL if @error is set. Otherwise a #GVariant tuple with + line="19365">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). @@ -26522,7 +27002,7 @@ return values. Free with g_variant_unref(). A #GDBusProxy. + line="19358">A #GDBusProxy. allow-none="1"> Return location for a #GUnixFDList or %NULL. + line="19359">Return location for a #GUnixFDList or %NULL. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). + line="19360">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). @@ -26550,14 +27030,14 @@ return values. Free with g_variant_unref(). throws="1"> Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. + line="19371">Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. This method is only available on UNIX. %NULL if @error is set. Otherwise a #GVariant tuple with + line="19389">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). @@ -26565,13 +27045,13 @@ return values. Free with g_variant_unref(). A #GDBusProxy. + line="19373">A #GDBusProxy. Name of method to invoke. + line="19374">Name of method to invoke. allow-none="1"> A #GVariant tuple with parameters for the signal + line="19375">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + line="19377">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + line="19378">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -26603,7 +27083,7 @@ return values. Free with g_variant_unref(). allow-none="1"> A #GUnixFDList or %NULL. + line="19380">A #GUnixFDList or %NULL. allow-none="1"> Return location for a #GUnixFDList or %NULL. + line="19381">Return location for a #GUnixFDList or %NULL. allow-none="1"> A #GCancellable or %NULL. + line="19382">A #GCancellable or %NULL. @@ -26633,7 +27113,7 @@ return values. Free with g_variant_unref(). version="2.26"> Looks up the value for a property from the cache. This call does no + line="19395">Looks up the value for a property from the cache. This call does no blocking IO. If @proxy has an expected interface (see @@ -26643,7 +27123,7 @@ it, then @value is checked against the type of the property. A reference to the #GVariant instance + line="19407">A reference to the #GVariant instance that holds the value for @property_name or %NULL if the value is not in the cache. The returned reference must be freed with g_variant_unref(). @@ -26652,13 +27132,13 @@ it, then @value is checked against the type of the property. A #GDBusProxy. + line="19397">A #GDBusProxy. Property name. + line="19398">Property name. @@ -26668,12 +27148,12 @@ it, then @value is checked against the type of the property. version="2.26"> Gets the names of all cached properties on @proxy. + line="19414">Gets the names of all cached properties on @proxy. A + line="19420">A %NULL-terminated array of strings or %NULL if @proxy has no cached properties. Free the returned array with g_strfreev(). @@ -26685,7 +27165,7 @@ it, then @value is checked against the type of the property. A #GDBusProxy. + line="19416">A #GDBusProxy. @@ -26695,19 +27175,19 @@ it, then @value is checked against the type of the property. version="2.26"> Gets the connection @proxy is for. + line="19428">Gets the connection @proxy is for. A #GDBusConnection owned by @proxy. Do not free. + line="19434">A #GDBusConnection owned by @proxy. Do not free. A #GDBusProxy. + line="19430">A #GDBusProxy. @@ -26717,7 +27197,7 @@ it, then @value is checked against the type of the property. version="2.26"> Gets the timeout to use if -1 (specifying default timeout) is + line="19439">Gets the timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. @@ -26726,14 +27206,14 @@ See the #GDBusProxy:g-default-timeout property for more details. Timeout to use for @proxy. + line="19449">Timeout to use for @proxy. A #GDBusProxy. + line="19441">A #GDBusProxy. @@ -26743,19 +27223,19 @@ See the #GDBusProxy:g-default-timeout property for more details. version="2.26"> Gets the flags that @proxy was constructed with. + line="19454">Gets the flags that @proxy was constructed with. Flags from the #GDBusProxyFlags enumeration. + line="19460">Flags from the #GDBusProxyFlags enumeration. A #GDBusProxy. + line="19456">A #GDBusProxy. @@ -26765,14 +27245,14 @@ See the #GDBusProxy:g-default-timeout property for more details. version="2.26"> Returns the #GDBusInterfaceInfo, if any, specifying the interface + line="19465">Returns the #GDBusInterfaceInfo, if any, specifying the interface that @proxy conforms to. See the #GDBusProxy:g-interface-info property for more details. A #GDBusInterfaceInfo or %NULL. + line="19473">A #GDBusInterfaceInfo or %NULL. Do not unref the returned object, it is owned by @proxy. @@ -26780,7 +27260,7 @@ property for more details. A #GDBusProxy + line="19467">A #GDBusProxy @@ -26790,19 +27270,19 @@ property for more details. version="2.26"> Gets the D-Bus interface name @proxy is for. + line="19479">Gets the D-Bus interface name @proxy is for. A string owned by @proxy. Do not free. + line="19485">A string owned by @proxy. Do not free. A #GDBusProxy. + line="19481">A #GDBusProxy. @@ -26812,19 +27292,23 @@ property for more details. version="2.26"> Gets the name that @proxy was constructed for. + line="19490">Gets the name that @proxy was constructed for. + +When connected to a message bus, this will usually be non-%NULL. +However, it may be %NULL for a proxy that communicates using a peer-to-peer +pattern. - + A string owned by @proxy. Do not free. + line="19500">A string owned by @proxy. Do not free. A #GDBusProxy. + line="19492">A #GDBusProxy. @@ -26834,7 +27318,7 @@ property for more details. version="2.26"> The unique name that owns the name that @proxy is for or %NULL if + line="19505">The unique name that owns the name that @proxy is for or %NULL if no-one currently owns that name. You may connect to the #GObject::notify signal to track changes to the #GDBusProxy:g-name-owner property. @@ -26842,7 +27326,7 @@ no-one currently owns that name. You may connect to the The name owner or %NULL if no name + line="19514">The name owner or %NULL if no name owner exists. Free with g_free(). @@ -26850,7 +27334,7 @@ no-one currently owns that name. You may connect to the A #GDBusProxy. + line="19507">A #GDBusProxy. @@ -26860,19 +27344,19 @@ no-one currently owns that name. You may connect to the version="2.26"> Gets the object path @proxy is for. + line="19520">Gets the object path @proxy is for. A string owned by @proxy. Do not free. + line="19526">A string owned by @proxy. Do not free. A #GDBusProxy. + line="19522">A #GDBusProxy. @@ -26882,7 +27366,7 @@ no-one currently owns that name. You may connect to the version="2.26"> If @value is not %NULL, sets the cached value for the property with + line="19683">If @value is not %NULL, sets the cached value for the property with name @property_name to the value in @value. If @value is %NULL, then the cached value is removed from the @@ -26923,13 +27407,13 @@ it is more efficient to only transmit the delta using e.g. signals A #GDBusProxy + line="19685">A #GDBusProxy Property name. + line="19686">Property name. Value for the property or %NULL to remove it from the cache. + line="19687">Value for the property or %NULL to remove it from the cache. @@ -26948,7 +27432,7 @@ it is more efficient to only transmit the delta using e.g. signals version="2.26"> Sets the timeout to use if -1 (specifying default timeout) is + line="19727">Sets the timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. @@ -26961,13 +27445,13 @@ See the #GDBusProxy:g-default-timeout property for more details. A #GDBusProxy. + line="19729">A #GDBusProxy. Timeout in milliseconds. + line="19730">Timeout in milliseconds. @@ -26977,7 +27461,7 @@ See the #GDBusProxy:g-default-timeout property for more details. version="2.26"> Ensure that interactions with @proxy conform to the given + line="19742">Ensure that interactions with @proxy conform to the given interface. See the #GDBusProxy:g-interface-info property for more details. @@ -26988,7 +27472,7 @@ details. A #GDBusProxy + line="19744">A #GDBusProxy allow-none="1"> Minimum interface this proxy conforms to + line="19745">Minimum interface this proxy conforms to or %NULL to unset. @@ -27011,7 +27495,7 @@ details. transfer-ownership="none"> If this property is not %G_BUS_TYPE_NONE, then + line="1231">If this property is not %G_BUS_TYPE_NONE, then #GDBusProxy:g-connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property. @@ -27024,7 +27508,7 @@ of this property. transfer-ownership="none"> The #GDBusConnection the proxy is for. + line="1243">The #GDBusConnection the proxy is for. transfer-ownership="none"> The timeout to use if -1 (specifying default timeout) is passed + line="1252">The timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. @@ -27051,7 +27535,7 @@ the default timeout (typically 25 seconds) is used. If set to transfer-ownership="none"> Flags from the #GDBusProxyFlags enumeration. + line="1268">Flags from the #GDBusProxyFlags enumeration. Ensure that interactions with this proxy conform to the given + line="1277">Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given #GDBusInterfaceInfo is said to be the "expected interface". @@ -27093,7 +27577,7 @@ service-side is not considered an ABI break. transfer-ownership="none"> The D-Bus interface name the proxy is for. + line="1309">The D-Bus interface name the proxy is for. transfer-ownership="none"> The well-known or unique name that the proxy is for. + line="1318">The well-known or unique name that the proxy is for. The unique name that owns #GDBusProxy:g-name or %NULL if no-one + line="1327">The unique name that owns #GDBusProxy:g-name or %NULL if no-one currently owns that name. You may connect to #GObject::notify signal to track changes to this property. @@ -27121,7 +27605,7 @@ track changes to this property. transfer-ownership="none"> The object path the proxy is for. + line="1338">The object path the proxy is for. @@ -27133,7 +27617,7 @@ track changes to this property. Emitted when one or more D-Bus properties on @proxy changes. The + line="1195">Emitted when one or more D-Bus properties on @proxy changes. The local cache has already been updated when this signal fires. Note that both @changed_properties and @invalidated_properties are guaranteed to never be %NULL (either may be empty though). @@ -27152,13 +27636,13 @@ This signal corresponds to the A #GVariant containing the properties that changed (type: `a{sv}`) + line="1198">A #GVariant containing the properties that changed (type: `a{sv}`) A %NULL terminated array of properties that was invalidated + line="1199">A %NULL terminated array of properties that was invalidated @@ -27168,7 +27652,7 @@ This signal corresponds to the Emitted when a signal from the remote object and interface that @proxy is for, has been received. + line="1218">Emitted when a signal from the remote object and interface that @proxy is for, has been received. @@ -27179,19 +27663,19 @@ This signal corresponds to the allow-none="1"> The sender of the signal or %NULL if the connection is not a bus connection. + line="1221">The sender of the signal or %NULL if the connection is not a bus connection. The name of the signal. + line="1222">The name of the signal. A #GVariant tuple with parameters for the signal. + line="1223">A #GVariant tuple with parameters for the signal. @@ -27266,7 +27750,8 @@ This signal corresponds to the + glib:nick="none" + glib:name="G_DBUS_PROXY_FLAGS_NONE"> No flags set. @@ -27274,7 +27759,8 @@ This signal corresponds to the + glib:nick="do-not-load-properties" + glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES"> Don't load properties. @@ -27282,7 +27768,8 @@ This signal corresponds to the + glib:nick="do-not-connect-signals" + glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS"> Don't connect to signals on the remote object. @@ -27290,7 +27777,8 @@ This signal corresponds to the + glib:nick="do-not-auto-start" + glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START"> If the proxy is for a well-known name, @@ -27300,7 +27788,8 @@ This flag is only meaningful in proxies for well-known names. + glib:nick="get-invalidated-properties" + glib:name="G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES"> If set, the property value for any __invalidated property__ will be (asynchronously) retrieved upon receiving the [`PropertiesChanged`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. @@ -27308,7 +27797,8 @@ This flag is only meaningful in proxies for well-known names. + glib:nick="do-not-auto-start-at-construction" + glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION"> If the proxy is for a well-known name, @@ -27325,18 +27815,18 @@ and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is not also specified. version="2.30"> Function signature for a function used to determine the #GType to + line="611">Function signature for a function used to determine the #GType to use for an interface proxy (if @interface_name is not %NULL) or object proxy (if @interface_name is %NULL). This function is called in the [thread-default main loop][g-main-context-push-thread-default] that @manager was constructed in. - + A #GType to use for the remote object. The returned type + line="626">A #GType to use for the remote object. The returned type must be a #GDBusProxy or #GDBusObjectProxy -derived type. @@ -27345,14 +27835,14 @@ that @manager was constructed in. A #GDBusObjectManagerClient. + line="613">A #GDBusObjectManagerClient. The object path of the remote object. + line="614">The object path of the remote object. allow-none="1"> The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested. + line="615">The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested. closure="3"> User data. + line="616">User data. @@ -27383,22 +27873,24 @@ that @manager was constructed in. c:type="GDBusSendMessageFlags"> Flags used when sending #GDBusMessages on a #GDBusConnection. + line="1413">Flags used when sending #GDBusMessages on a #GDBusConnection. + glib:nick="none" + glib:name="G_DBUS_SEND_MESSAGE_FLAGS_NONE"> No flags set. + line="1415">No flags set. + glib:nick="preserve-serial" + glib:name="G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL"> Do not automatically + line="1416">Do not automatically assign a serial number from the #GDBusConnection object when sending a message. @@ -27412,7 +27904,7 @@ sending a message. glib:get-type="g_dbus_server_get_type"> #GDBusServer is a helper for listening to and accepting D-Bus + line="6200">#GDBusServer is a helper for listening to and accepting D-Bus connections. This can be used to create a new D-Bus server, allowing two peers to use the D-Bus protocol for their own specialized communication. A server instance provided in this way will not perform message routing or @@ -27421,13 +27913,15 @@ implement the org.freedesktop.DBus interface. To just export an object on a well-known name on a message bus, such as the session or system bus, you should instead use g_bus_own_name(). -An example of peer-to-peer communication with G-DBus can be found -in [gdbus-example-peer.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-peer.c). +An example of peer-to-peer communication with GDBus can be found +in [gdbus-example-peer.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-peer.c). Note that a minimal #GDBusServer will accept connections from any peer. In many use-cases it will be necessary to add a #GDBusAuthObserver that only accepts connections that have successfully authenticated -as the same user that is running the #GDBusServer. +as the same user that is running the #GDBusServer. Since GLib 2.68 this can +be achieved more simply by passing the +%G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag to the server. throws="1"> Creates a new D-Bus server that listens on the first address in + line="19805">Creates a new D-Bus server that listens on the first address in @address that works. Once constructed, you can use g_dbus_server_get_client_address() to @@ -27459,7 +27953,7 @@ asynchronous version. A #GDBusServer or %NULL if @error is set. Free with + line="19835">A #GDBusServer or %NULL if @error is set. Free with g_object_unref(). @@ -27467,19 +27961,19 @@ g_object_unref(). A D-Bus address. + line="19807">A D-Bus address. Flags from the #GDBusServerFlags enumeration. + line="19808">Flags from the #GDBusServerFlags enumeration. A D-Bus GUID. + line="19809">A D-Bus GUID. allow-none="1"> A #GDBusAuthObserver or %NULL. + line="19810">A #GDBusAuthObserver or %NULL. allow-none="1"> A #GCancellable or %NULL. + line="19811">A #GCancellable or %NULL. Gets a + line="19756">Gets a [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses) -string that can be used by clients to connect to @server. +string that can be used by clients to connect to @server. + +This is valid and non-empty if initializing the #GDBusServer succeeded. A D-Bus address string. Do not free, the string is owned + line="19766">A D-Bus address string. Do not free, the string is owned by @server. @@ -27522,51 +28019,53 @@ by @server. A #GDBusServer. + line="19758">A #GDBusServer. Gets the flags for @server. + line="19772">Gets the flags for @server. A set of flags from the #GDBusServerFlags enumeration. + line="19778">A set of flags from the #GDBusServerFlags enumeration. A #GDBusServer. + line="19774">A #GDBusServer. Gets the GUID for @server. + line="19783">Gets the GUID for @server, as provided to g_dbus_server_new_sync(). A D-Bus GUID. Do not free this string, it is owned by @server. + line="19789">A D-Bus GUID. Do not free this string, it is owned by @server. A #GDBusServer. + line="19785">A #GDBusServer. @@ -27576,19 +28075,19 @@ by @server. version="2.26"> Gets whether @server is active. + line="19794">Gets whether @server is active. %TRUE if server is active, %FALSE otherwise. + line="19800">%TRUE if server is active, %FALSE otherwise. A #GDBusServer. + line="19796">A #GDBusServer. @@ -27596,7 +28095,7 @@ by @server. Starts @server. + line="19841">Starts @server. @@ -27605,7 +28104,7 @@ by @server. A #GDBusServer. + line="19843">A #GDBusServer. @@ -27613,7 +28112,7 @@ by @server. Stops @server. + line="19851">Stops @server. @@ -27622,7 +28121,7 @@ by @server. A #GDBusServer. + line="19853">A #GDBusServer. @@ -27630,7 +28129,7 @@ by @server. Whether the server is currently active. + line="1390">Whether the server is currently active. transfer-ownership="none"> The D-Bus address to listen on. + line="1399">The D-Bus address to listen on. transfer-ownership="none"> A #GDBusAuthObserver object to assist in the authentication process or %NULL. + line="1408">A #GDBusAuthObserver object to assist in the authentication process or %NULL. - + The D-Bus address that clients can use. + line="1417">The D-Bus address that clients can use. + transfer-ownership="none" + getter="get_flags"> Flags from the #GDBusServerFlags enumeration. + line="1426">Flags from the #GDBusServerFlags enumeration. + transfer-ownership="none" + getter="get_guid"> The guid of the server. + line="1435">The GUID of the server. + +See #GDBusConnection:guid for more details. Emitted when a new authenticated connection has been made. Use + line="1357">Emitted when a new authenticated connection has been made. Use g_dbus_connection_get_peer_credentials() to figure out what identity (if any), was authenticated. @@ -27706,7 +28212,7 @@ similar from the signal handler. %TRUE to claim @connection, %FALSE to let other handlers + line="1384">%TRUE to claim @connection, %FALSE to let other handlers run. @@ -27714,7 +28220,7 @@ run. A #GDBusConnection for the new connection. + line="1360">A #GDBusConnection for the new connection. @@ -27727,34 +28233,47 @@ run. c:type="GDBusServerFlags"> Flags used when creating a #GDBusServer. + line="1366">Flags used when creating a #GDBusServer. + glib:nick="none" + glib:name="G_DBUS_SERVER_FLAGS_NONE"> No flags set. + line="1368">No flags set. + glib:nick="run-in-thread" + glib:name="G_DBUS_SERVER_FLAGS_RUN_IN_THREAD"> All #GDBusServer::new-connection + line="1369">All #GDBusServer::new-connection signals will run in separated dedicated threads (see signal for details). + glib:nick="authentication-allow-anonymous" + glib:name="G_DBUS_SERVER_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS"> Allow the anonymous + line="1372">Allow the anonymous authentication method. + + Require the UID of the +peer to be the same as the UID of the server when authenticating. (Since: 2.68) + c:type="GDBusSignalFlags"> Flags used when subscribing to signals via g_dbus_connection_signal_subscribe(). + line="1389">Flags used when subscribing to signals via g_dbus_connection_signal_subscribe(). + glib:nick="none" + glib:name="G_DBUS_SIGNAL_FLAGS_NONE"> No flags set. + line="1391">No flags set. + glib:nick="no-match-rule" + glib:name="G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE"> Don't actually send the AddMatch + line="1392">Don't actually send the AddMatch D-Bus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually). + glib:nick="match-arg0-namespace" + glib:name="G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE"> Match first arguments that + line="1395">Match first arguments that contain a bus or interface name with the given namespace. + glib:nick="match-arg0-path" + glib:name="G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH"> Match first arguments that + line="1397">Match first arguments that contain an object path that is either equivalent to the given path, or one of the paths is a subpath of the other. @@ -27879,7 +28402,7 @@ or one of the paths is a subpath of the other. The reference count or -1 if statically allocated. - + If @info is statically allocated does nothing. Otherwise increases + line="19861">If @info is statically allocated does nothing. Otherwise increases the reference count. The same @info. + line="19868">The same @info. A #GDBusSignalInfo + line="19863">A #GDBusSignalInfo @@ -27929,7 +28452,7 @@ the reference count. version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + line="19873">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -27940,7 +28463,7 @@ the memory used is freed. A #GDBusSignalInfo. + line="19875">A #GDBusSignalInfo. @@ -27956,7 +28479,7 @@ the memory used is freed. Subtrees are flat. @node, if non-%NULL, is always exactly one segment of the object path (ie: it never contains a slash). - + A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods. @@ -28013,8 +28536,7 @@ segment of the object path (ie: it never contains a slash). + version="2.26"> The type of the @enumerate function in #GDBusSubtreeVTable. @@ -28025,11 +28547,11 @@ when preparing to dispatch incoming messages in the event that the specified (ie: to verify that the object path is valid). Hierarchies are not supported; the items that you return should not -contain the '/' character. +contain the `/` character. The return value will be freed with g_strfreev(). - + A newly allocated array of strings for node names that are children of @object_path. @@ -28075,22 +28597,24 @@ The return value will be freed with g_strfreev(). c:type="GDBusSubtreeFlags"> Flags passed to g_dbus_connection_register_subtree(). + line="1349">Flags passed to g_dbus_connection_register_subtree(). + glib:nick="none" + glib:name="G_DBUS_SUBTREE_FLAGS_NONE"> No flags set. + line="1351">No flags set. + glib:nick="dispatch-to-unenumerated-nodes" + glib:name="G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES"> Method calls to objects not in the enumerated range + line="1352">Method calls to objects not in the enumerated range will still be dispatched. This is useful if you want to dynamically spawn objects in the subtree. @@ -28119,11 +28643,13 @@ items is that the standard DBus interfaces will returned to the remote introspector in the empty array case, but not in the %NULL case. - + A %NULL-terminated array of pointers to #GDBusInterfaceInfo, or %NULL. - + + + @@ -28169,7 +28695,7 @@ case. filename="gdbusconnection.h" line="512">Virtual table for handling subtrees registered with g_dbus_connection_register_subtree(). - + Function for enumerating child nodes. @@ -28344,68 +28870,70 @@ case. glib:type-struct="DataInputStreamClass"> Data input stream implements #GInputStream and includes functions for + line="5627">Data input stream implements #GInputStream and includes functions for reading structured data directly from a binary input stream. Creates a new data input stream for the @base_stream. + line="14575">Creates a new data input stream for the @base_stream. a new #GDataInputStream. + line="14581">a new #GDataInputStream. a #GInputStream. + line="14577">a #GInputStream. + c:identifier="g_data_input_stream_get_byte_order" + glib:get-property="byte-order"> Gets the byte order for the data input stream. + line="14555">Gets the byte order for the data input stream. the @stream's current #GDataStreamByteOrder. + line="14561">the @stream's current #GDataStreamByteOrder. a given #GDataInputStream. + line="14557">a given #GDataInputStream. + c:identifier="g_data_input_stream_get_newline_type" + glib:get-property="newline-type"> Gets the current newline type for the @stream. + line="14565">Gets the current newline type for the @stream. #GDataStreamNewlineType for the given @stream. + line="14571">#GDataStreamNewlineType for the given @stream. a given #GDataInputStream. + line="14567">a given #GDataInputStream. @@ -28415,12 +28943,12 @@ reading structured data directly from a binary input stream. throws="1"> Reads an unsigned 8-bit/1-byte value from @stream. + line="14585">Reads an unsigned 8-bit/1-byte value from @stream. an unsigned 8-bit/1-byte value read from the @stream or `0` + line="14593">an unsigned 8-bit/1-byte value read from the @stream or `0` if an error occurred. @@ -28428,7 +28956,7 @@ if an error occurred. a given #GDataInputStream. + line="14587">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14588">optional #GCancellable object, %NULL to ignore. @@ -28447,7 +28975,7 @@ if an error occurred. throws="1"> Reads a 16-bit/2-byte value from @stream. + line="14598">Reads a 16-bit/2-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -28455,7 +28983,7 @@ see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order( a signed 16-bit/2-byte value read from @stream or `0` if + line="14609">a signed 16-bit/2-byte value read from @stream or `0` if an error occurred. @@ -28463,7 +28991,7 @@ an error occurred. a given #GDataInputStream. + line="14600">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14601">optional #GCancellable object, %NULL to ignore. @@ -28482,7 +29010,7 @@ an error occurred. throws="1"> Reads a signed 32-bit/4-byte value from @stream. + line="14614">Reads a signed 32-bit/4-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -28494,7 +29022,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a signed 32-bit/4-byte value read from the @stream or `0` if + line="14629">a signed 32-bit/4-byte value read from the @stream or `0` if an error occurred. @@ -28502,7 +29030,7 @@ an error occurred. a given #GDataInputStream. + line="14616">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14617">optional #GCancellable object, %NULL to ignore. @@ -28521,7 +29049,7 @@ an error occurred. throws="1"> Reads a 64-bit/8-byte value from @stream. + line="14634">Reads a 64-bit/8-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -28533,7 +29061,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a signed 64-bit/8-byte value read from @stream or `0` if + line="14649">a signed 64-bit/8-byte value read from @stream or `0` if an error occurred. @@ -28541,7 +29069,7 @@ an error occurred. a given #GDataInputStream. + line="14636">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14637">optional #GCancellable object, %NULL to ignore. @@ -28560,7 +29088,7 @@ an error occurred. throws="1"> Reads a line from the data input stream. Note that no encoding + line="14654">Reads a line from the data input stream. Note that no encoding checks or conversion is performed; the input is not guaranteed to be UTF-8, and may in fact have embedded NUL characters. @@ -28571,7 +29099,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + line="14669"> a NUL terminated byte array with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error @@ -28585,7 +29113,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a given #GDataInputStream. + line="14656">a given #GDataInputStream. allow-none="1"> a #gsize to get the length of the data read in. + line="14657">a #gsize to get the length of the data read in. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14658">optional #GCancellable object, %NULL to ignore. @@ -28615,7 +29143,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.20"> The asynchronous version of g_data_input_stream_read_line(). It is + line="14678">The asynchronous version of g_data_input_stream_read_line(). It is an error to have two outstanding calls to this function. When the operation is finished, @callback will be called. You @@ -28629,13 +29157,13 @@ the result of the operation. a given #GDataInputStream. + line="14680">a given #GDataInputStream. the [I/O priority][io-priority] of the request + line="14681">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14682">optional #GCancellable object, %NULL to ignore. closure="3"> callback to call when the request is satisfied. + line="14683">callback to call when the request is satisfied. allow-none="1"> the data to pass to callback function. + line="14684">the data to pass to callback function. @@ -28675,7 +29203,7 @@ the result of the operation. throws="1"> Finish an asynchronous call started by + line="14697">Finish an asynchronous call started by g_data_input_stream_read_line_async(). Note the warning about string encoding in g_data_input_stream_read_line() applies here as well. @@ -28683,7 +29211,7 @@ well. + line="14709"> a NUL-terminated byte array with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error @@ -28697,13 +29225,13 @@ well. a given #GDataInputStream. + line="14699">a given #GDataInputStream. the #GAsyncResult that was provided to the callback. + line="14700">the #GAsyncResult that was provided to the callback. allow-none="1"> a #gsize to get the length of the data read in. + line="14701">a #gsize to get the length of the data read in. @@ -28725,13 +29253,13 @@ well. throws="1"> Finish an asynchronous call started by + line="14719">Finish an asynchronous call started by g_data_input_stream_read_line_async(). a string with the line that + line="14729">a string with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error will be set. For UTF-8 conversion errors, the set @@ -28743,13 +29271,13 @@ g_data_input_stream_read_line_async(). a given #GDataInputStream. + line="14721">a given #GDataInputStream. the #GAsyncResult that was provided to the callback. + line="14722">the #GAsyncResult that was provided to the callback. allow-none="1"> a #gsize to get the length of the data read in. + line="14723">a #gsize to get the length of the data read in. @@ -28771,7 +29299,7 @@ g_data_input_stream_read_line_async(). throws="1"> Reads a UTF-8 encoded line from the data input stream. + line="14739">Reads a UTF-8 encoded line from the data input stream. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -28780,7 +29308,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a NUL terminated UTF-8 string + line="14752">a NUL terminated UTF-8 string with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error will be set. For UTF-8 @@ -28793,7 +29321,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a given #GDataInputStream. + line="14741">a given #GDataInputStream. allow-none="1"> a #gsize to get the length of the data read in. + line="14742">a #gsize to get the length of the data read in. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14743">optional #GCancellable object, %NULL to ignore. @@ -28823,7 +29351,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Reads an unsigned 16-bit/2-byte value from @stream. + line="14763">Reads an unsigned 16-bit/2-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -28831,7 +29359,7 @@ see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order( an unsigned 16-bit/2-byte value read from the @stream or `0` if + line="14774">an unsigned 16-bit/2-byte value read from the @stream or `0` if an error occurred. @@ -28839,7 +29367,7 @@ an error occurred. a given #GDataInputStream. + line="14765">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14766">optional #GCancellable object, %NULL to ignore. @@ -28858,7 +29386,7 @@ an error occurred. throws="1"> Reads an unsigned 32-bit/4-byte value from @stream. + line="14779">Reads an unsigned 32-bit/4-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -28870,7 +29398,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. an unsigned 32-bit/4-byte value read from the @stream or `0` if + line="14794">an unsigned 32-bit/4-byte value read from the @stream or `0` if an error occurred. @@ -28878,7 +29406,7 @@ an error occurred. a given #GDataInputStream. + line="14781">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14782">optional #GCancellable object, %NULL to ignore. @@ -28897,7 +29425,7 @@ an error occurred. throws="1"> Reads an unsigned 64-bit/8-byte value from @stream. + line="14799">Reads an unsigned 64-bit/8-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order(). @@ -28909,7 +29437,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. an unsigned 64-bit/8-byte read from @stream or `0` if + line="14814">an unsigned 64-bit/8-byte read from @stream or `0` if an error occurred. @@ -28917,7 +29445,7 @@ an error occurred. a given #GDataInputStream. + line="14801">a given #GDataInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14802">optional #GCancellable object, %NULL to ignore. @@ -28938,7 +29466,7 @@ an error occurred. throws="1"> Reads a string from the data input stream, up to the first + line="14819">Reads a string from the data input stream, up to the first occurrence of any of the stop characters. Note that, in contrast to g_data_input_stream_read_until_async(), @@ -28955,7 +29483,7 @@ does not consume the stop character. a string with the data that was read + line="14839">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -28965,13 +29493,13 @@ does not consume the stop character. a given #GDataInputStream. + line="14821">a given #GDataInputStream. characters to terminate the read. + line="14822">characters to terminate the read. allow-none="1"> a #gsize to get the length of the data read in. + line="14823">a #gsize to get the length of the data read in. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14824">optional #GCancellable object, %NULL to ignore. @@ -29003,7 +29531,7 @@ does not consume the stop character. deprecated-version="2.56"> The asynchronous version of g_data_input_stream_read_until(). + line="14848">The asynchronous version of g_data_input_stream_read_until(). It is an error to have two outstanding calls to this function. Note that, in contrast to g_data_input_stream_read_until(), @@ -29028,19 +29556,19 @@ g_data_input_stream_read_upto_async() instead. a given #GDataInputStream. + line="14850">a given #GDataInputStream. characters to terminate the read. + line="14851">characters to terminate the read. the [I/O priority][io-priority] of the request + line="14852">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="14853">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied. + line="14854">callback to call when the request is satisfied. allow-none="1"> the data to pass to callback function. + line="14855">the data to pass to callback function. @@ -29082,7 +29610,7 @@ g_data_input_stream_read_upto_async() instead. throws="1"> Finish an asynchronous call started by + line="14879">Finish an asynchronous call started by g_data_input_stream_read_until_async(). Use g_data_input_stream_read_upto_finish() instead, which has more consistent behaviour regarding the stop character. @@ -29090,7 +29618,7 @@ g_data_input_stream_read_until_async(). a string with the data that was read + line="14890">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -29100,13 +29628,13 @@ g_data_input_stream_read_until_async(). a given #GDataInputStream. + line="14881">a given #GDataInputStream. the #GAsyncResult that was provided to the callback. + line="14882">the #GAsyncResult that was provided to the callback. allow-none="1"> a #gsize to get the length of the data read in. + line="14883">a #gsize to get the length of the data read in. @@ -29128,7 +29656,7 @@ g_data_input_stream_read_until_async(). throws="1"> Reads a string from the data input stream, up to the first + line="14899">Reads a string from the data input stream, up to the first occurrence of any of the stop characters. In contrast to g_data_input_stream_read_until(), this function @@ -29144,7 +29672,7 @@ The returned string will always be nul-terminated on success. a string with the data that was read + line="14922">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error @@ -29154,19 +29682,19 @@ The returned string will always be nul-terminated on success. a #GDataInputStream + line="14901">a #GDataInputStream characters to terminate the read + line="14902">characters to terminate the read length of @stop_chars. May be -1 if @stop_chars is + line="14903">length of @stop_chars. May be -1 if @stop_chars is nul-terminated @@ -29178,7 +29706,7 @@ The returned string will always be nul-terminated on success. allow-none="1"> a #gsize to get the length of the data read in + line="14905">a #gsize to get the length of the data read in allow-none="1"> optional #GCancellable object, %NULL to ignore + line="14906">optional #GCancellable object, %NULL to ignore @@ -29197,7 +29725,7 @@ The returned string will always be nul-terminated on success. version="2.26"> The asynchronous version of g_data_input_stream_read_upto(). + line="14930">The asynchronous version of g_data_input_stream_read_upto(). It is an error to have two outstanding calls to this function. In contrast to g_data_input_stream_read_until(), this function @@ -29219,26 +29747,26 @@ the result of the operation. a #GDataInputStream + line="14932">a #GDataInputStream characters to terminate the read + line="14933">characters to terminate the read length of @stop_chars. May be -1 if @stop_chars is + line="14934">length of @stop_chars. May be -1 if @stop_chars is nul-terminated the [I/O priority][io-priority] of the request + line="14936">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore + line="14937">optional #GCancellable object, %NULL to ignore closure="5"> callback to call when the request is satisfied + line="14938">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="14939">the data to pass to callback function @@ -29278,7 +29806,7 @@ the result of the operation. throws="1"> Finish an asynchronous call started by + line="14960">Finish an asynchronous call started by g_data_input_stream_read_upto_async(). Note that this function does not consume the stop character. You @@ -29290,7 +29818,7 @@ The returned string will always be nul-terminated on success. a string with the data that was read + line="14976">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -29300,13 +29828,13 @@ The returned string will always be nul-terminated on success. a #GDataInputStream + line="14962">a #GDataInputStream the #GAsyncResult that was provided to the callback + line="14963">the #GAsyncResult that was provided to the callback allow-none="1"> a #gsize to get the length of the data read in + line="14964">a #gsize to get the length of the data read in + c:identifier="g_data_input_stream_set_byte_order" + glib:set-property="byte-order"> This function sets the byte order for the given @stream. All subsequent + line="14984">This function sets the byte order for the given @stream. All subsequent reads from the @stream will be read in the given @order. @@ -29336,22 +29865,23 @@ reads from the @stream will be read in the given @order. a given #GDataInputStream. + line="14986">a given #GDataInputStream. a #GDataStreamByteOrder to set. + line="14987">a #GDataStreamByteOrder to set. + c:identifier="g_data_input_stream_set_newline_type" + glib:set-property="newline-type"> Sets the newline type for the @stream. + line="14994">Sets the newline type for the @stream. Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read chunk ends in "CR" we must read an additional byte to know if this is "CR" or @@ -29364,22 +29894,39 @@ chunk ends in "CR" we must read an additional byte to know if this is "CR" or a #GDataInputStream. + line="14996">a #GDataInputStream. the type of new line return as #GDataStreamNewlineType. + line="14997">the type of new line return as #GDataStreamNewlineType. - + + The :byte-order property determines the byte ordering that +is used when reading multi-byte entities (such as integers) +from the stream. - + + The :newline-type property determines what is considered +as a line ending when reading complete lines from the stream. @@ -29452,47 +29999,48 @@ chunk ends in "CR" we must read an additional byte to know if this is "CR" or glib:type-struct="DataOutputStreamClass"> Data output stream implements #GOutputStream and includes functions for + line="5638">Data output stream implements #GOutputStream and includes functions for writing data directly to an output stream. Creates a new data output stream for @base_stream. + line="15017">Creates a new data output stream for @base_stream. #GDataOutputStream. + line="15023">#GDataOutputStream. a #GOutputStream. + line="15019">a #GOutputStream. + c:identifier="g_data_output_stream_get_byte_order" + glib:get-property="byte-order"> Gets the byte order for the stream. + line="15007">Gets the byte order for the stream. the #GDataStreamByteOrder for the @stream. + line="15013">the #GDataStreamByteOrder for the @stream. a #GDataOutputStream. + line="15009">a #GDataOutputStream. @@ -29502,25 +30050,25 @@ writing data directly to an output stream. throws="1"> Puts a byte into the output stream. + line="15027">Puts a byte into the output stream. %TRUE if @data was successfully added to the @stream. + line="15036">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15029">a #GDataOutputStream. a #guchar. + line="15030">a #guchar. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15031">optional #GCancellable object, %NULL to ignore. @@ -29539,25 +30087,25 @@ writing data directly to an output stream. throws="1"> Puts a signed 16-bit integer into the output stream. + line="15040">Puts a signed 16-bit integer into the output stream. %TRUE if @data was successfully added to the @stream. + line="15049">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15042">a #GDataOutputStream. a #gint16. + line="15043">a #gint16. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15044">optional #GCancellable object, %NULL to ignore. @@ -29576,25 +30124,25 @@ writing data directly to an output stream. throws="1"> Puts a signed 32-bit integer into the output stream. + line="15053">Puts a signed 32-bit integer into the output stream. %TRUE if @data was successfully added to the @stream. + line="15062">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15055">a #GDataOutputStream. a #gint32. + line="15056">a #gint32. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15057">optional #GCancellable object, %NULL to ignore. @@ -29613,25 +30161,25 @@ writing data directly to an output stream. throws="1"> Puts a signed 64-bit integer into the stream. + line="15066">Puts a signed 64-bit integer into the stream. %TRUE if @data was successfully added to the @stream. + line="15075">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15068">a #GDataOutputStream. a #gint64. + line="15069">a #gint64. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15070">optional #GCancellable object, %NULL to ignore. @@ -29650,25 +30198,25 @@ writing data directly to an output stream. throws="1"> Puts a string into the output stream. + line="15079">Puts a string into the output stream. %TRUE if @string was successfully added to the @stream. + line="15088">%TRUE if @string was successfully added to the @stream. a #GDataOutputStream. + line="15081">a #GDataOutputStream. a string. + line="15082">a string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15083">optional #GCancellable object, %NULL to ignore. @@ -29687,25 +30235,25 @@ writing data directly to an output stream. throws="1"> Puts an unsigned 16-bit integer into the output stream. + line="15092">Puts an unsigned 16-bit integer into the output stream. %TRUE if @data was successfully added to the @stream. + line="15101">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15094">a #GDataOutputStream. a #guint16. + line="15095">a #guint16. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15096">optional #GCancellable object, %NULL to ignore. @@ -29724,25 +30272,25 @@ writing data directly to an output stream. throws="1"> Puts an unsigned 32-bit integer into the stream. + line="15105">Puts an unsigned 32-bit integer into the stream. %TRUE if @data was successfully added to the @stream. + line="15114">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15107">a #GDataOutputStream. a #guint32. + line="15108">a #guint32. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15109">optional #GCancellable object, %NULL to ignore. @@ -29761,25 +30309,25 @@ writing data directly to an output stream. throws="1"> Puts an unsigned 64-bit integer into the stream. + line="15118">Puts an unsigned 64-bit integer into the stream. %TRUE if @data was successfully added to the @stream. + line="15127">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + line="15120">a #GDataOutputStream. a #guint64. + line="15121">a #guint64. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="15122">optional #GCancellable object, %NULL to ignore. + c:identifier="g_data_output_stream_set_byte_order" + glib:set-property="byte-order"> Sets the byte order of the data output stream to @order. + line="15131">Sets the byte order of the data output stream to @order. @@ -29806,21 +30355,25 @@ writing data directly to an output stream. a #GDataOutputStream. + line="15133">a #GDataOutputStream. a %GDataStreamByteOrder. + line="15134">a %GDataStreamByteOrder. - + Determines the byte ordering that is used when writing + line="1473">Determines the byte ordering that is used when writing multi-byte entities (such as integers) to the stream. @@ -29897,7 +30450,8 @@ across various machine architectures. + glib:nick="big-endian" + glib:name="G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN"> Selects Big Endian byte order. @@ -29905,7 +30459,8 @@ across various machine architectures. + glib:nick="little-endian" + glib:name="G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN"> Selects Little Endian byte order. @@ -29913,7 +30468,8 @@ across various machine architectures. + glib:nick="host-endian" + glib:name="G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN"> Selects endianness based on host machine's architecture. @@ -29929,7 +30485,8 @@ across various machine architectures. + glib:nick="lf" + glib:name="G_DATA_STREAM_NEWLINE_TYPE_LF"> Selects "LF" line endings, common on most modern UNIX platforms. @@ -29937,7 +30494,8 @@ across various machine architectures. + glib:nick="cr" + glib:name="G_DATA_STREAM_NEWLINE_TYPE_CR"> Selects "CR" line endings. @@ -29945,7 +30503,8 @@ across various machine architectures. + glib:nick="cr-lf" + glib:name="G_DATA_STREAM_NEWLINE_TYPE_CR_LF"> Selects "CR, LF" line ending, common on Microsoft Windows. @@ -29953,7 +30512,8 @@ across various machine architectures. + glib:nick="any" + glib:name="G_DATA_STREAM_NEWLINE_TYPE_ANY"> Automatically try to handle any line ending type. @@ -29968,7 +30528,7 @@ across various machine architectures. glib:type-struct="DatagramBasedInterface"> A #GDatagramBased is a networking interface for representing datagram-based + line="5569">A #GDatagramBased is a networking interface for representing datagram-based communications. It is a more or less direct mapping of the core parts of the BSD socket API in a portable GObject interface. It is implemented by #GSocket, which wraps the UNIX socket API on UNIX and winsock2 on Windows. @@ -30021,7 +30581,7 @@ implement your own locking. version="2.48"> Checks on the readiness of @datagram_based to perform operations. The + line="15140">Checks on the readiness of @datagram_based to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @datagram_based. The result is returned. @@ -30061,20 +30621,20 @@ This call never blocks. the #GIOCondition mask of the current state + line="15182">the #GIOCondition mask of the current state a #GDatagramBased + line="15142">a #GDatagramBased a #GIOCondition mask to check + line="15143">a #GIOCondition mask to check @@ -30085,7 +30645,7 @@ This call never blocks. throws="1"> Waits for up to @timeout microseconds for condition to become true on + line="15187">Waits for up to @timeout microseconds for condition to become true on @datagram_based. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @timeout is @@ -30095,26 +30655,26 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). %TRUE if the condition was met, %FALSE otherwise + line="15203">%TRUE if the condition was met, %FALSE otherwise a #GDatagramBased + line="15189">a #GDatagramBased a #GIOCondition mask to wait for + line="15190">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15191">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30124,7 +30684,7 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). allow-none="1"> a #GCancellable + line="15193">a #GCancellable @@ -30134,7 +30694,7 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). version="2.48"> Creates a #GSource that can be attached to a #GMainContext to monitor for + line="15208">Creates a #GSource that can be attached to a #GMainContext to monitor for the availability of the specified @condition on the #GDatagramBased. The #GSource keeps a reference to the @datagram_based. @@ -30152,20 +30712,20 @@ g_cancellable_is_cancelled(). a newly allocated #GSource + line="15229">a newly allocated #GSource a #GDatagramBased + line="15210">a #GDatagramBased a #GIOCondition mask to monitor + line="15211">a #GIOCondition mask to monitor allow-none="1"> a #GCancellable + line="15212">a #GCancellable @@ -30185,7 +30745,7 @@ g_cancellable_is_cancelled(). throws="1"> Receive one or more data messages from @datagram_based in one go. + line="15234">Receive one or more data messages from @datagram_based in one go. @messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage @@ -30239,7 +30799,7 @@ other error. number of messages received, or -1 on error. Note that the number + line="15296">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -30250,13 +30810,13 @@ other error. a #GDatagramBased + line="15236">a #GDatagramBased an array of #GInputMessage structs + line="15237">an array of #GInputMessage structs @@ -30264,19 +30824,19 @@ other error. the number of elements in @messages + line="15238">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation + line="15239">an int containing #GSocketMsgFlags flags for the overall operation the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15240">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30286,7 +30846,7 @@ other error. allow-none="1"> a %GCancellable + line="15242">a %GCancellable @@ -30297,7 +30857,7 @@ other error. throws="1"> Send one or more data messages from @datagram_based in one go. + line="15305">Send one or more data messages from @datagram_based in one go. @messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage @@ -30342,7 +30902,7 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. number of messages sent, or -1 on error. Note that the number of + line="15358">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -30352,13 +30912,13 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. a #GDatagramBased + line="15307">a #GDatagramBased an array of #GOutputMessage structs + line="15308">an array of #GOutputMessage structs @@ -30366,19 +30926,19 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. the number of elements in @messages + line="15309">the number of elements in @messages an int containing #GSocketMsgFlags flags + line="15310">an int containing #GSocketMsgFlags flags the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15311">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30388,7 +30948,7 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. allow-none="1"> a %GCancellable + line="15313">a %GCancellable @@ -30398,7 +30958,7 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. version="2.48"> Checks on the readiness of @datagram_based to perform operations. The + line="15140">Checks on the readiness of @datagram_based to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @datagram_based. The result is returned. @@ -30438,20 +30998,20 @@ This call never blocks. the #GIOCondition mask of the current state + line="15182">the #GIOCondition mask of the current state a #GDatagramBased + line="15142">a #GDatagramBased a #GIOCondition mask to check + line="15143">a #GIOCondition mask to check @@ -30462,7 +31022,7 @@ This call never blocks. throws="1"> Waits for up to @timeout microseconds for condition to become true on + line="15187">Waits for up to @timeout microseconds for condition to become true on @datagram_based. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @timeout is @@ -30472,26 +31032,26 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). %TRUE if the condition was met, %FALSE otherwise + line="15203">%TRUE if the condition was met, %FALSE otherwise a #GDatagramBased + line="15189">a #GDatagramBased a #GIOCondition mask to wait for + line="15190">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15191">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30501,7 +31061,7 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). allow-none="1"> a #GCancellable + line="15193">a #GCancellable @@ -30511,7 +31071,7 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). version="2.48"> Creates a #GSource that can be attached to a #GMainContext to monitor for + line="15208">Creates a #GSource that can be attached to a #GMainContext to monitor for the availability of the specified @condition on the #GDatagramBased. The #GSource keeps a reference to the @datagram_based. @@ -30529,20 +31089,20 @@ g_cancellable_is_cancelled(). a newly allocated #GSource + line="15229">a newly allocated #GSource a #GDatagramBased + line="15210">a #GDatagramBased a #GIOCondition mask to monitor + line="15211">a #GIOCondition mask to monitor allow-none="1"> a #GCancellable + line="15212">a #GCancellable @@ -30562,7 +31122,7 @@ g_cancellable_is_cancelled(). throws="1"> Receive one or more data messages from @datagram_based in one go. + line="15234">Receive one or more data messages from @datagram_based in one go. @messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage @@ -30616,7 +31176,7 @@ other error. number of messages received, or -1 on error. Note that the number + line="15296">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -30627,13 +31187,13 @@ other error. a #GDatagramBased + line="15236">a #GDatagramBased an array of #GInputMessage structs + line="15237">an array of #GInputMessage structs @@ -30641,19 +31201,19 @@ other error. the number of elements in @messages + line="15238">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation + line="15239">an int containing #GSocketMsgFlags flags for the overall operation the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15240">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30663,7 +31223,7 @@ other error. allow-none="1"> a %GCancellable + line="15242">a %GCancellable @@ -30674,7 +31234,7 @@ other error. throws="1"> Send one or more data messages from @datagram_based in one go. + line="15305">Send one or more data messages from @datagram_based in one go. @messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage @@ -30719,7 +31279,7 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. number of messages sent, or -1 on error. Note that the number of + line="15358">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -30729,13 +31289,13 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. a #GDatagramBased + line="15307">a #GDatagramBased an array of #GOutputMessage structs + line="15308">an array of #GOutputMessage structs @@ -30743,19 +31303,19 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. the number of elements in @messages + line="15309">the number of elements in @messages an int containing #GSocketMsgFlags flags + line="15310">an int containing #GSocketMsgFlags flags the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15311">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30765,7 +31325,7 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. allow-none="1"> a %GCancellable + line="15313">a %GCancellable @@ -30795,7 +31355,7 @@ documented in the interface methods. number of messages received, or -1 on error. Note that the number + line="15296">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -30806,13 +31366,13 @@ documented in the interface methods. a #GDatagramBased + line="15236">a #GDatagramBased an array of #GInputMessage structs + line="15237">an array of #GInputMessage structs @@ -30820,19 +31380,19 @@ documented in the interface methods. the number of elements in @messages + line="15238">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation + line="15239">an int containing #GSocketMsgFlags flags for the overall operation the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15240">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30842,7 +31402,7 @@ documented in the interface methods. allow-none="1"> a %GCancellable + line="15242">a %GCancellable @@ -30854,7 +31414,7 @@ documented in the interface methods. number of messages sent, or -1 on error. Note that the number of + line="15358">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -30864,13 +31424,13 @@ documented in the interface methods. a #GDatagramBased + line="15307">a #GDatagramBased an array of #GOutputMessage structs + line="15308">an array of #GOutputMessage structs @@ -30878,19 +31438,19 @@ documented in the interface methods. the number of elements in @messages + line="15309">the number of elements in @messages an int containing #GSocketMsgFlags flags + line="15310">an int containing #GSocketMsgFlags flags the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15311">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -30900,7 +31460,7 @@ documented in the interface methods. allow-none="1"> a %GCancellable + line="15313">a %GCancellable @@ -30912,20 +31472,20 @@ documented in the interface methods. a newly allocated #GSource + line="15229">a newly allocated #GSource a #GDatagramBased + line="15210">a #GDatagramBased a #GIOCondition mask to monitor + line="15211">a #GIOCondition mask to monitor allow-none="1"> a #GCancellable + line="15212">a #GCancellable @@ -30946,20 +31506,20 @@ documented in the interface methods. the #GIOCondition mask of the current state + line="15182">the #GIOCondition mask of the current state a #GDatagramBased + line="15142">a #GDatagramBased a #GIOCondition mask to check + line="15143">a #GIOCondition mask to check @@ -30971,26 +31531,26 @@ documented in the interface methods. %TRUE if the condition was met, %FALSE otherwise + line="15203">%TRUE if the condition was met, %FALSE otherwise a #GDatagramBased + line="15189">a #GDatagramBased a #GIOCondition mask to wait for + line="15190">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, 0 to not block, or -1 + line="15191">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -31000,7 +31560,7 @@ documented in the interface methods. allow-none="1"> a #GCancellable + line="15193">a #GCancellable @@ -31012,13 +31572,13 @@ documented in the interface methods. version="2.48"> This is the function type of the callback used for the #GSource + line="406">This is the function type of the callback used for the #GSource returned by g_datagram_based_create_source(). - + %G_SOURCE_REMOVE if the source should be removed, + line="415">%G_SOURCE_REMOVE if the source should be removed, %G_SOURCE_CONTINUE otherwise @@ -31026,13 +31586,13 @@ returned by g_datagram_based_create_source(). the #GDatagramBased + line="408">the #GDatagramBased the current condition at the source fired + line="409">the current condition at the source fired closure="2"> data passed in by the user + line="410">data passed in by the user @@ -31056,7 +31616,7 @@ returned by g_datagram_based_create_source(). glib:type-struct="DesktopAppInfoClass"> #GDesktopAppInfo is an implementation of #GAppInfo based on + line="6236">#GDesktopAppInfo is an implementation of #GAppInfo based on desktop files. Note that `<gio/gdesktopappinfo.h>` belongs to the UNIX-specific @@ -31067,7 +31627,7 @@ file when using it. Creates a new #GDesktopAppInfo based on a desktop file id. + line="20245">Creates a new #GDesktopAppInfo based on a desktop file id. A desktop file id is the basename of the desktop file, including the .desktop extension. GIO is looking for a desktop file with this name @@ -31082,7 +31642,7 @@ prefix-to-subdirectory mapping that is described in the a new #GDesktopAppInfo, or %NULL if no desktop + line="20261">a new #GDesktopAppInfo, or %NULL if no desktop file with that id exists. @@ -31090,7 +31650,7 @@ prefix-to-subdirectory mapping that is described in the the desktop file id + line="20247">the desktop file id @@ -31099,19 +31659,19 @@ prefix-to-subdirectory mapping that is described in the c:identifier="g_desktop_app_info_new_from_filename"> Creates a new #GDesktopAppInfo. + line="20266">Creates a new #GDesktopAppInfo. a new #GDesktopAppInfo or %NULL on error. + line="20273">a new #GDesktopAppInfo or %NULL on error. the path of a desktop file, in the GLib + line="20268">the path of a desktop file, in the GLib filename encoding @@ -31122,19 +31682,19 @@ prefix-to-subdirectory mapping that is described in the version="2.18"> Creates a new #GDesktopAppInfo. + line="20277">Creates a new #GDesktopAppInfo. a new #GDesktopAppInfo or %NULL on error. + line="20283">a new #GDesktopAppInfo or %NULL on error. an opened #GKeyFile + line="20279">an opened #GKeyFile @@ -31144,7 +31704,7 @@ prefix-to-subdirectory mapping that is described in the version="2.42"> Gets all applications that implement @interface. + line="19972">Gets all applications that implement @interface. An application implements an interface if that interface is listed in the Implements= line of the desktop file of the application. @@ -31152,7 +31712,7 @@ the Implements= line of the desktop file of the application. a list of #GDesktopAppInfo + line="19981">a list of #GDesktopAppInfo objects. @@ -31162,7 +31722,7 @@ objects. the name of the interface + line="19974">the name of the interface @@ -31170,7 +31730,7 @@ objects. Searches desktop files for ones that match @search_string. + line="20288">Searches desktop files for ones that match @search_string. The return value is an array of strvs. Each strv contains a list of applications that matched @search_string with an equal score. The @@ -31189,7 +31749,7 @@ subsequently creating a #GDesktopAppInfo for each result. a + line="20308">a list of strvs. Free each item with g_strfreev() and free the outer list with g_free(). @@ -31202,7 +31762,7 @@ subsequently creating a #GDesktopAppInfo for each result. the search string to use + line="20290">the search string to use @@ -31213,7 +31773,7 @@ subsequently creating a #GDesktopAppInfo for each result. deprecated-version="2.42"> Sets the name of the desktop that the application is running in. + line="20314">Sets the name of the desktop that the application is running in. This is used by g_app_info_should_show() and g_desktop_app_info_get_show_in() to evaluate the `OnlyShowIn` and `NotShowIn` @@ -31230,7 +31790,7 @@ Should be called only once; subsequent calls are ignored. a string specifying what desktop this is + line="20316">a string specifying what desktop this is @@ -31240,7 +31800,7 @@ Should be called only once; subsequent calls are ignored. version="2.38"> Gets the user-visible display name of the "additional application + line="19905">Gets the user-visible display name of the "additional application action" specified by @action_name. This corresponds to the "Name" key within the keyfile group for the @@ -31249,20 +31809,20 @@ action. the locale-specific action name + line="19917">the locale-specific action name a #GDesktopAppInfo + line="19907">a #GDesktopAppInfo the name of the action as from + line="19908">the name of the action as from g_desktop_app_info_list_actions() @@ -31273,14 +31833,14 @@ action. version="2.36"> Looks up a boolean value in the keyfile backing @info. + line="19922">Looks up a boolean value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. the boolean value, or %FALSE if the key + line="19931">the boolean value, or %FALSE if the key is not found @@ -31288,13 +31848,13 @@ The @key is looked up in the "Desktop Entry" group. a #GDesktopAppInfo + line="19924">a #GDesktopAppInfo the key to look up + line="19925">the key to look up @@ -31303,12 +31863,12 @@ The @key is looked up in the "Desktop Entry" group. c:identifier="g_desktop_app_info_get_categories"> Gets the categories from the desktop file. + line="19937">Gets the categories from the desktop file. - + The unparsed Categories key from the desktop file; + line="19943">The unparsed Categories key from the desktop file; i.e. no attempt is made to split it by ';' or validate it. @@ -31316,24 +31876,25 @@ The @key is looked up in the "Desktop Entry" group. a #GDesktopAppInfo + line="19939">a #GDesktopAppInfo When @info was created from a known filename, return it. In some + line="19948">When @info was created from a known filename, return it. In some situations such as the #GDesktopAppInfo returned from g_desktop_app_info_new_from_keyfile(), this function will return %NULL. - + The full path to the file for @info, + line="19956">The full path to the file for @info, or %NULL if not known. @@ -31341,7 +31902,7 @@ g_desktop_app_info_new_from_keyfile(), this function will return %NULL. a #GDesktopAppInfo + line="19950">a #GDesktopAppInfo @@ -31350,19 +31911,19 @@ g_desktop_app_info_new_from_keyfile(), this function will return %NULL. c:identifier="g_desktop_app_info_get_generic_name"> Gets the generic name from the destkop file. + line="19962">Gets the generic name from the desktop file. - + The value of the GenericName key + line="19968">The value of the GenericName key a #GDesktopAppInfo + line="19964">a #GDesktopAppInfo @@ -31371,20 +31932,20 @@ g_desktop_app_info_new_from_keyfile(), this function will return %NULL. c:identifier="g_desktop_app_info_get_is_hidden"> A desktop file is hidden if the Hidden key in it is + line="19987">A desktop file is hidden if the Hidden key in it is set to True. %TRUE if hidden, %FALSE otherwise. + line="19994">%TRUE if hidden, %FALSE otherwise. a #GDesktopAppInfo. + line="19989">a #GDesktopAppInfo. @@ -31394,12 +31955,12 @@ set to True. version="2.32"> Gets the keywords from the desktop file. + line="19998">Gets the keywords from the desktop file. The value of the Keywords key + line="20004">The value of the Keywords key @@ -31408,7 +31969,7 @@ set to True. a #GDesktopAppInfo + line="20000">a #GDesktopAppInfo @@ -31418,7 +31979,7 @@ set to True. version="2.56"> Looks up a localized string value in the keyfile backing @info + line="20009">Looks up a localized string value in the keyfile backing @info translated to the current locale. The @key is looked up in the "Desktop Entry" group. @@ -31426,7 +31987,7 @@ The @key is looked up in the "Desktop Entry" group. a newly allocated string, or %NULL if the key + line="20019">a newly allocated string, or %NULL if the key is not found @@ -31434,13 +31995,13 @@ The @key is looked up in the "Desktop Entry" group. a #GDesktopAppInfo + line="20011">a #GDesktopAppInfo the key to look up + line="20012">the key to look up @@ -31450,21 +32011,21 @@ The @key is looked up in the "Desktop Entry" group. version="2.30"> Gets the value of the NoDisplay key, which helps determine if the + line="20025">Gets the value of the NoDisplay key, which helps determine if the application info should be shown in menus. See #G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY and g_app_info_should_show(). The value of the NoDisplay key + line="20033">The value of the NoDisplay key a #GDesktopAppInfo + line="20027">a #GDesktopAppInfo @@ -31474,7 +32035,7 @@ application info should be shown in menus. See version="2.30"> Checks if the application info should be shown in menus that list available + line="20038">Checks if the application info should be shown in menus that list available applications for a specific name of the desktop, based on the `OnlyShowIn` and `NotShowIn` keys. @@ -31489,7 +32050,7 @@ Note that g_app_info_should_show() for @info will include this check (with %TRUE if the @info should be shown in @desktop_env according to the + line="20055">%TRUE if the @info should be shown in @desktop_env according to the `OnlyShowIn` and `NotShowIn` keys, %FALSE otherwise. @@ -31498,7 +32059,7 @@ otherwise. a #GDesktopAppInfo + line="20040">a #GDesktopAppInfo allow-none="1"> a string specifying a desktop name + line="20041">a string specifying a desktop name @@ -31517,14 +32078,14 @@ otherwise. version="2.34"> Retrieves the StartupWMClass field from @info. This represents the + line="20062">Retrieves the StartupWMClass field from @info. This represents the WM_CLASS property of the main window of the application, if launched through @info. - + the startup WM class, or %NULL if none is set + line="20070">the startup WM class, or %NULL if none is set in the desktop file. @@ -31532,7 +32093,7 @@ in the desktop file. a #GDesktopAppInfo that supports startup notify + line="20064">a #GDesktopAppInfo that supports startup notify @@ -31542,14 +32103,14 @@ in the desktop file. version="2.36"> Looks up a string value in the keyfile backing @info. + line="20076">Looks up a string value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - + a newly allocated string, or %NULL if the key + line="20085">a newly allocated string, or %NULL if the key is not found @@ -31557,13 +32118,13 @@ The @key is looked up in the "Desktop Entry" group. a #GDesktopAppInfo + line="20078">a #GDesktopAppInfo the key to look up + line="20079">the key to look up @@ -31573,14 +32134,14 @@ The @key is looked up in the "Desktop Entry" group. version="2.60"> Looks up a string list value in the keyfile backing @info. + line="20091">Looks up a string list value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. + line="20101"> a %NULL-terminated string array or %NULL if the specified key cannot be found. The array should be freed with g_strfreev(). @@ -31591,13 +32152,13 @@ The @key is looked up in the "Desktop Entry" group. a #GDesktopAppInfo + line="20093">a #GDesktopAppInfo the key to look up + line="20094">the key to look up allow-none="1"> return location for the number of returned strings, or %NULL + line="20095">return location for the number of returned strings, or %NULL @@ -31618,26 +32179,26 @@ The @key is looked up in the "Desktop Entry" group. version="2.36"> Returns whether @key exists in the "Desktop Entry" group + line="20108">Returns whether @key exists in the "Desktop Entry" group of the keyfile backing @info. %TRUE if the @key exists + line="20116">%TRUE if the @key exists a #GDesktopAppInfo + line="20110">a #GDesktopAppInfo the key to look up + line="20111">the key to look up @@ -31647,7 +32208,7 @@ of the keyfile backing @info. version="2.38"> Activates the named application action. + line="20121">Activates the named application action. You may only call this function on action names that were returned from g_desktop_app_info_list_actions(). @@ -31670,13 +32231,13 @@ occur while using this function. a #GDesktopAppInfo + line="20123">a #GDesktopAppInfo the name of the action as from + line="20124">the name of the action as from g_desktop_app_info_list_actions() @@ -31686,7 +32247,7 @@ occur while using this function. allow-none="1"> a #GAppLaunchContext + line="20126">a #GAppLaunchContext @@ -31696,7 +32257,7 @@ occur while using this function. throws="1"> This function performs the equivalent of g_app_info_launch_uris(), + line="20148">This function performs the equivalent of g_app_info_launch_uris(), but is intended primarily for operating system components that launch applications. Ordinary applications should use g_app_info_launch_uris(). @@ -31715,20 +32276,20 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, %TRUE on successful launch, %FALSE otherwise. + line="20177">%TRUE on successful launch, %FALSE otherwise. a #GDesktopAppInfo + line="20150">a #GDesktopAppInfo List of URIs + line="20151">List of URIs @@ -31739,13 +32300,13 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, allow-none="1"> a #GAppLaunchContext + line="20152">a #GAppLaunchContext #GSpawnFlags, used for each process + line="20153">#GSpawnFlags, used for each process a #GSpawnChildSetupFunc, used once + line="20154">a #GSpawnChildSetupFunc, used once for each process. @@ -31768,7 +32329,7 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, closure="3"> User data for @user_setup + line="20156">User data for @user_setup Callback for child processes + line="20157">Callback for child processes @@ -31790,7 +32351,7 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, closure="5"> User data for @callback + line="20158">User data for @callback @@ -31801,7 +32362,7 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, throws="1"> Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows + line="20181">Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows you to pass in file descriptors for the stdin, stdout and stderr streams of the launched process. @@ -31811,20 +32372,20 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. %TRUE on successful launch, %FALSE otherwise. + line="20204">%TRUE on successful launch, %FALSE otherwise. a #GDesktopAppInfo + line="20183">a #GDesktopAppInfo List of URIs + line="20184">List of URIs @@ -31835,13 +32396,13 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. allow-none="1"> a #GAppLaunchContext + line="20185">a #GAppLaunchContext #GSpawnFlags, used for each process + line="20186">#GSpawnFlags, used for each process closure="4"> a #GSpawnChildSetupFunc, used once + line="20187">a #GSpawnChildSetupFunc, used once for each process. @@ -31864,7 +32425,7 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. closure="3"> User data for @user_setup + line="20189">User data for @user_setup closure="6"> Callback for child processes + line="20190">Callback for child processes @@ -31886,25 +32447,25 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. closure="5"> User data for @callback + line="20191">User data for @callback file descriptor to use for child's stdin, or -1 + line="20192">file descriptor to use for child's stdin, or -1 file descriptor to use for child's stdout, or -1 + line="20193">file descriptor to use for child's stdout, or -1 file descriptor to use for child's stderr, or -1 + line="20194">file descriptor to use for child's stderr, or -1 @@ -31914,7 +32475,7 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. version="2.38"> Returns the list of "additional application actions" supported on the + line="20209">Returns the list of "additional application actions" supported on the desktop file, as per the desktop file specification. As per the specification, this is the list of actions that are @@ -31923,7 +32484,7 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. a list of strings, always non-%NULL + line="20219">a list of strings, always non-%NULL @@ -31932,7 +32493,7 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. a #GDesktopAppInfo + line="20211">a #GDesktopAppInfo @@ -31940,10 +32501,11 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. + transfer-ownership="none" + getter="get_filename"> The origin filename of this #GDesktopAppInfo + line="1488">The origin filename of this #GDesktopAppInfo @@ -31965,7 +32527,7 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. glib:type-struct="DesktopAppInfoLookupIface"> #GDesktopAppInfoLookup is an opaque data structure and can only be accessed + line="1495">#GDesktopAppInfoLookup is an opaque data structure and can only be accessed using the following functions. The #GDesktopAppInfoLookup interface is deprecated and unused by GIO. @@ -31976,7 +32538,7 @@ using the following functions. deprecated-version="2.28"> Gets the default application for launching applications + line="20224">Gets the default application for launching applications using this URI scheme for a particular #GDesktopAppInfoLookup implementation. @@ -31990,7 +32552,7 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). #GAppInfo for given @uri_scheme or + line="20238">#GAppInfo for given @uri_scheme or %NULL on error. @@ -31998,13 +32560,13 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). a #GDesktopAppInfoLookup + line="20226">a #GDesktopAppInfoLookup a string containing a URI scheme. + line="20227">a string containing a URI scheme. @@ -32015,7 +32577,7 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). deprecated-version="2.28"> Gets the default application for launching applications + line="20224">Gets the default application for launching applications using this URI scheme for a particular #GDesktopAppInfoLookup implementation. @@ -32029,7 +32591,7 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). #GAppInfo for given @uri_scheme or + line="20238">#GAppInfo for given @uri_scheme or %NULL on error. @@ -32037,13 +32599,13 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). a #GDesktopAppInfoLookup + line="20226">a #GDesktopAppInfoLookup a string containing a URI scheme. + line="20227">a string containing a URI scheme. @@ -32066,7 +32628,7 @@ handlers with URI schemes. #GAppInfo for given @uri_scheme or + line="20238">#GAppInfo for given @uri_scheme or %NULL on error. @@ -32074,14 +32636,14 @@ handlers with URI schemes. a #GDesktopAppInfoLookup + line="20226">a #GDesktopAppInfoLookup a string containing a URI scheme. + line="20227">a string containing a URI scheme. @@ -32132,7 +32694,7 @@ for each, providing the process ID. glib:type-struct="DriveIface"> #GDrive - this represent a piece of hardware connected to the machine. + line="6251">#GDrive - this represent a piece of hardware connected to the machine. It's generally only created for removable hardware or hardware with removable media. @@ -32162,19 +32724,19 @@ For porting from GnomeVFS note that there is no equivalent of Checks if a drive can be ejected. + line="20331">Checks if a drive can be ejected. %TRUE if the @drive can be ejected, %FALSE otherwise. + line="20337">%TRUE if the @drive can be ejected, %FALSE otherwise. a #GDrive. + line="20333">a #GDrive. @@ -32182,12 +32744,12 @@ For porting from GnomeVFS note that there is no equivalent of Checks if a drive can be polled for media changes. + line="20341">Checks if a drive can be polled for media changes. %TRUE if the @drive can be polled for media changes, + line="20347">%TRUE if the @drive can be polled for media changes, %FALSE otherwise. @@ -32195,7 +32757,7 @@ For porting from GnomeVFS note that there is no equivalent of a #GDrive. + line="20343">a #GDrive. @@ -32203,19 +32765,19 @@ For porting from GnomeVFS note that there is no equivalent of Checks if a drive can be started. + line="20352">Checks if a drive can be started. %TRUE if the @drive can be started, %FALSE otherwise. + line="20358">%TRUE if the @drive can be started, %FALSE otherwise. a #GDrive. + line="20354">a #GDrive. @@ -32225,19 +32787,19 @@ For porting from GnomeVFS note that there is no equivalent of version="2.22"> Checks if a drive can be started degraded. + line="20363">Checks if a drive can be started degraded. %TRUE if the @drive can be started degraded, %FALSE otherwise. + line="20369">%TRUE if the @drive can be started degraded, %FALSE otherwise. a #GDrive. + line="20365">a #GDrive. @@ -32245,19 +32807,19 @@ For porting from GnomeVFS note that there is no equivalent of Checks if a drive can be stopped. + line="20374">Checks if a drive can be stopped. %TRUE if the @drive can be stopped, %FALSE otherwise. + line="20380">%TRUE if the @drive can be stopped, %FALSE otherwise. a #GDrive. + line="20376">a #GDrive. @@ -32290,7 +32852,7 @@ For porting from GnomeVFS note that there is no equivalent of deprecated-version="2.22"> Asynchronously ejects a drive. + line="20385">Asynchronously ejects a drive. When the operation is finished, @callback will be called. You can then call g_drive_eject_finish() to obtain the @@ -32304,13 +32866,13 @@ result of the operation. a #GDrive. + line="20387">a #GDrive. flags affecting the unmount if required for eject + line="20388">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20389">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="20390">a #GAsyncReadyCallback, or %NULL. closure="3"> user data to pass to @callback + line="20391">user data to pass to @callback @@ -32363,13 +32925,13 @@ result of the operation. throws="1"> Finishes ejecting a drive. + line="20403">Finishes ejecting a drive. Use g_drive_eject_with_operation_finish() instead. %TRUE if the drive has been ejected successfully, + line="20411">%TRUE if the drive has been ejected successfully, %FALSE otherwise. @@ -32377,13 +32939,13 @@ result of the operation. a #GDrive. + line="20405">a #GDrive. a #GAsyncResult. + line="20406">a #GAsyncResult. @@ -32393,7 +32955,7 @@ result of the operation. version="2.22"> Ejects a drive. This is an asynchronous operation, and is + line="20417">Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the @drive and #GAsyncResult data returned in the @callback. @@ -32404,13 +32966,13 @@ and #GAsyncResult data returned in the @callback. a #GDrive. + line="20419">a #GDrive. flags affecting the unmount if required for eject + line="20420">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to avoid + line="20421">a #GMountOperation or %NULL to avoid user interaction. @@ -32429,7 +32991,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20423">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20424">a #GAsyncReadyCallback, or %NULL. closure="4"> user data passed to @callback. + line="20425">user data passed to @callback. @@ -32461,26 +33023,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a drive. If any errors occurred during the operation, + line="20435">Finishes ejecting a drive. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the drive was successfully ejected. %FALSE otherwise. + line="20445">%TRUE if the drive was successfully ejected. %FALSE otherwise. a #GDrive. + line="20437">a #GDrive. a #GAsyncResult. + line="20438">a #GAsyncResult. @@ -32489,14 +33051,14 @@ and #GAsyncResult data returned in the @callback. invoker="enumerate_identifiers"> Gets the kinds of identifiers that @drive has. + line="20450">Gets the kinds of identifiers that @drive has. Use g_drive_get_identifier() to obtain the identifiers themselves. a %NULL-terminated + line="20458">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -32507,7 +33069,7 @@ themselves. a #GDrive + line="20452">a #GDrive @@ -32515,12 +33077,12 @@ themselves. Gets the icon for @drive. + line="20464">Gets the icon for @drive. #GIcon for the @drive. + line="20470">#GIcon for the @drive. Free the returned object with g_object_unref(). @@ -32528,7 +33090,7 @@ themselves. a #GDrive. + line="20466">a #GDrive. @@ -32536,14 +33098,14 @@ themselves. Gets the identifier of the given kind for @drive. The only + line="20475">Gets the identifier of the given kind for @drive. The only identifier currently available is #G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE. a newly allocated string containing the + line="20484">a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. @@ -32552,13 +33114,13 @@ identifier currently available is a #GDrive + line="20477">a #GDrive the kind of identifier to return + line="20478">the kind of identifier to return @@ -32566,12 +33128,12 @@ identifier currently available is Gets the name of @drive. + line="20490">Gets the name of @drive. a string containing @drive's name. The returned + line="20496">a string containing @drive's name. The returned string should be freed when no longer needed. @@ -32579,7 +33141,7 @@ identifier currently available is a #GDrive. + line="20492">a #GDrive. @@ -32589,19 +33151,19 @@ identifier currently available is version="2.32"> Gets the sort key for @drive, if any. + line="20501">Gets the sort key for @drive, if any. Sorting key for @drive or %NULL if no such key is available. + line="20507">Sorting key for @drive or %NULL if no such key is available. A #GDrive. + line="20503">A #GDrive. @@ -32611,19 +33173,19 @@ identifier currently available is version="2.22"> Gets a hint about how a drive can be started/stopped. + line="20512">Gets a hint about how a drive can be started/stopped. A value from the #GDriveStartStopType enumeration. + line="20518">A value from the #GDriveStartStopType enumeration. a #GDrive. + line="20514">a #GDrive. @@ -32633,12 +33195,12 @@ identifier currently available is version="2.34"> Gets the icon for @drive. + line="20523">Gets the icon for @drive. symbolic #GIcon for the @drive. + line="20529">symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). @@ -32646,7 +33208,7 @@ identifier currently available is a #GDrive. + line="20525">a #GDrive. @@ -32654,7 +33216,7 @@ identifier currently available is Get a list of mountable volumes for @drive. + line="20535">Get a list of mountable volumes for @drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -32662,7 +33224,7 @@ its elements have been unreffed with g_object_unref(). #GList containing any #GVolume objects on the given @drive. + line="20544">#GList containing any #GVolume objects on the given @drive. @@ -32671,7 +33233,7 @@ its elements have been unreffed with g_object_unref(). a #GDrive. + line="20537">a #GDrive. @@ -32679,21 +33241,21 @@ its elements have been unreffed with g_object_unref(). Checks if the @drive has media. Note that the OS may not be polling + line="20548">Checks if the @drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details. %TRUE if @drive has media, %FALSE otherwise. + line="20556">%TRUE if @drive has media, %FALSE otherwise. a #GDrive. + line="20550">a #GDrive. @@ -32701,19 +33263,19 @@ for more details. Check if @drive has any mountable volumes. + line="20560">Check if @drive has any mountable volumes. %TRUE if the @drive contains volumes, %FALSE otherwise. + line="20566">%TRUE if the @drive contains volumes, %FALSE otherwise. a #GDrive. + line="20562">a #GDrive. @@ -32722,12 +33284,12 @@ for more details. invoker="is_media_check_automatic"> Checks if @drive is capable of automatically detecting media changes. + line="20570">Checks if @drive is capable of automatically detecting media changes. %TRUE if the @drive is capable of automatically detecting + line="20576">%TRUE if the @drive is capable of automatically detecting media changes, %FALSE otherwise. @@ -32735,7 +33297,7 @@ for more details. a #GDrive. + line="20572">a #GDrive. @@ -32743,19 +33305,19 @@ for more details. Checks if the @drive supports removable media. + line="20581">Checks if the @drive supports removable media. %TRUE if @drive supports removable media, %FALSE otherwise. + line="20587">%TRUE if @drive supports removable media, %FALSE otherwise. a #GDrive. + line="20583">a #GDrive. @@ -32765,20 +33327,20 @@ for more details. version="2.50"> Checks if the #GDrive and/or its media is considered removable by the user. + line="20591">Checks if the #GDrive and/or its media is considered removable by the user. See g_drive_is_media_removable(). %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + line="20598">%TRUE if @drive and/or its media is considered removable, %FALSE otherwise. a #GDrive. + line="20593">a #GDrive. @@ -32786,7 +33348,7 @@ See g_drive_is_media_removable(). Asynchronously polls @drive to see if media has been inserted or removed. + line="20603">Asynchronously polls @drive to see if media has been inserted or removed. When the operation is finished, @callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the @@ -32799,7 +33361,7 @@ result of the operation. a #GDrive. + line="20605">a #GDrive. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20606">optional #GCancellable object, %NULL to ignore. closure="2"> a #GAsyncReadyCallback, or %NULL. + line="20607">a #GAsyncReadyCallback, or %NULL. closure="2"> user data to pass to @callback + line="20608">user data to pass to @callback @@ -32839,12 +33401,12 @@ result of the operation. throws="1"> Finishes an operation started with g_drive_poll_for_media() on a drive. + line="20618">Finishes an operation started with g_drive_poll_for_media() on a drive. %TRUE if the drive has been poll_for_mediaed successfully, + line="20626">%TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. @@ -32852,13 +33414,13 @@ result of the operation. a #GDrive. + line="20620">a #GDrive. a #GAsyncResult. + line="20621">a #GAsyncResult. @@ -32866,7 +33428,7 @@ result of the operation. Asynchronously starts a drive. + line="20631">Asynchronously starts a drive. When the operation is finished, @callback will be called. You can then call g_drive_start_finish() to obtain the @@ -32879,13 +33441,13 @@ result of the operation. a #GDrive. + line="20633">a #GDrive. flags affecting the start operation. + line="20634">flags affecting the start operation. allow-none="1"> a #GMountOperation or %NULL to avoid + line="20635">a #GMountOperation or %NULL to avoid user interaction. @@ -32904,7 +33466,7 @@ result of the operation. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20637">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20638">a #GAsyncReadyCallback, or %NULL. closure="4"> user data to pass to @callback + line="20639">user data to pass to @callback @@ -32936,12 +33498,12 @@ result of the operation. throws="1"> Finishes starting a drive. + line="20651">Finishes starting a drive. %TRUE if the drive has been started successfully, + line="20659">%TRUE if the drive has been started successfully, %FALSE otherwise. @@ -32949,13 +33511,13 @@ result of the operation. a #GDrive. + line="20653">a #GDrive. a #GAsyncResult. + line="20654">a #GAsyncResult. @@ -32963,7 +33525,7 @@ result of the operation. Asynchronously stops a drive. + line="20665">Asynchronously stops a drive. When the operation is finished, @callback will be called. You can then call g_drive_stop_finish() to obtain the @@ -32976,13 +33538,13 @@ result of the operation. a #GDrive. + line="20667">a #GDrive. flags affecting the unmount if required for stopping. + line="20668">flags affecting the unmount if required for stopping. allow-none="1"> a #GMountOperation or %NULL to avoid + line="20669">a #GMountOperation or %NULL to avoid user interaction. @@ -33001,7 +33563,7 @@ result of the operation. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20671">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20672">a #GAsyncReadyCallback, or %NULL. closure="4"> user data to pass to @callback + line="20673">user data to pass to @callback @@ -33044,12 +33606,12 @@ result of the operation. throws="1"> Finishes stopping a drive. + line="20685">Finishes stopping a drive. %TRUE if the drive has been stopped successfully, + line="20693">%TRUE if the drive has been stopped successfully, %FALSE otherwise. @@ -33057,13 +33619,13 @@ result of the operation. a #GDrive. + line="20687">a #GDrive. a #GAsyncResult. + line="20688">a #GAsyncResult. @@ -33071,19 +33633,19 @@ result of the operation. Checks if a drive can be ejected. + line="20331">Checks if a drive can be ejected. %TRUE if the @drive can be ejected, %FALSE otherwise. + line="20337">%TRUE if the @drive can be ejected, %FALSE otherwise. a #GDrive. + line="20333">a #GDrive. @@ -33092,12 +33654,12 @@ result of the operation. c:identifier="g_drive_can_poll_for_media"> Checks if a drive can be polled for media changes. + line="20341">Checks if a drive can be polled for media changes. %TRUE if the @drive can be polled for media changes, + line="20347">%TRUE if the @drive can be polled for media changes, %FALSE otherwise. @@ -33105,7 +33667,7 @@ result of the operation. a #GDrive. + line="20343">a #GDrive. @@ -33113,19 +33675,19 @@ result of the operation. Checks if a drive can be started. + line="20352">Checks if a drive can be started. %TRUE if the @drive can be started, %FALSE otherwise. + line="20358">%TRUE if the @drive can be started, %FALSE otherwise. a #GDrive. + line="20354">a #GDrive. @@ -33135,19 +33697,19 @@ result of the operation. version="2.22"> Checks if a drive can be started degraded. + line="20363">Checks if a drive can be started degraded. %TRUE if the @drive can be started degraded, %FALSE otherwise. + line="20369">%TRUE if the @drive can be started degraded, %FALSE otherwise. a #GDrive. + line="20365">a #GDrive. @@ -33155,19 +33717,19 @@ result of the operation. Checks if a drive can be stopped. + line="20374">Checks if a drive can be stopped. %TRUE if the @drive can be stopped, %FALSE otherwise. + line="20380">%TRUE if the @drive can be stopped, %FALSE otherwise. a #GDrive. + line="20376">a #GDrive. @@ -33178,7 +33740,7 @@ result of the operation. deprecated-version="2.22"> Asynchronously ejects a drive. + line="20385">Asynchronously ejects a drive. When the operation is finished, @callback will be called. You can then call g_drive_eject_finish() to obtain the @@ -33192,13 +33754,13 @@ result of the operation. a #GDrive. + line="20387">a #GDrive. flags affecting the unmount if required for eject + line="20388">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20389">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="20390">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data to pass to @callback + line="20391">user data to pass to @callback @@ -33239,13 +33801,13 @@ result of the operation. throws="1"> Finishes ejecting a drive. + line="20403">Finishes ejecting a drive. Use g_drive_eject_with_operation_finish() instead. %TRUE if the drive has been ejected successfully, + line="20411">%TRUE if the drive has been ejected successfully, %FALSE otherwise. @@ -33253,13 +33815,13 @@ result of the operation. a #GDrive. + line="20405">a #GDrive. a #GAsyncResult. + line="20406">a #GAsyncResult. @@ -33269,7 +33831,7 @@ result of the operation. version="2.22"> Ejects a drive. This is an asynchronous operation, and is + line="20417">Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the @drive and #GAsyncResult data returned in the @callback. @@ -33280,13 +33842,13 @@ and #GAsyncResult data returned in the @callback. a #GDrive. + line="20419">a #GDrive. flags affecting the unmount if required for eject + line="20420">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to avoid + line="20421">a #GMountOperation or %NULL to avoid user interaction. @@ -33305,7 +33867,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20423">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20424">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data passed to @callback. + line="20425">user data passed to @callback. @@ -33336,26 +33898,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a drive. If any errors occurred during the operation, + line="20435">Finishes ejecting a drive. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the drive was successfully ejected. %FALSE otherwise. + line="20445">%TRUE if the drive was successfully ejected. %FALSE otherwise. a #GDrive. + line="20437">a #GDrive. a #GAsyncResult. + line="20438">a #GAsyncResult. @@ -33364,14 +33926,14 @@ and #GAsyncResult data returned in the @callback. c:identifier="g_drive_enumerate_identifiers"> Gets the kinds of identifiers that @drive has. + line="20450">Gets the kinds of identifiers that @drive has. Use g_drive_get_identifier() to obtain the identifiers themselves. a %NULL-terminated + line="20458">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -33382,7 +33944,7 @@ themselves. a #GDrive + line="20452">a #GDrive @@ -33390,12 +33952,12 @@ themselves. Gets the icon for @drive. + line="20464">Gets the icon for @drive. #GIcon for the @drive. + line="20470">#GIcon for the @drive. Free the returned object with g_object_unref(). @@ -33403,7 +33965,7 @@ themselves. a #GDrive. + line="20466">a #GDrive. @@ -33411,14 +33973,14 @@ themselves. Gets the identifier of the given kind for @drive. The only + line="20475">Gets the identifier of the given kind for @drive. The only identifier currently available is #G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE. a newly allocated string containing the + line="20484">a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. @@ -33427,13 +33989,13 @@ identifier currently available is a #GDrive + line="20477">a #GDrive the kind of identifier to return + line="20478">the kind of identifier to return @@ -33441,12 +34003,12 @@ identifier currently available is Gets the name of @drive. + line="20490">Gets the name of @drive. a string containing @drive's name. The returned + line="20496">a string containing @drive's name. The returned string should be freed when no longer needed. @@ -33454,7 +34016,7 @@ identifier currently available is a #GDrive. + line="20492">a #GDrive. @@ -33464,19 +34026,19 @@ identifier currently available is version="2.32"> Gets the sort key for @drive, if any. + line="20501">Gets the sort key for @drive, if any. Sorting key for @drive or %NULL if no such key is available. + line="20507">Sorting key for @drive or %NULL if no such key is available. A #GDrive. + line="20503">A #GDrive. @@ -33486,19 +34048,19 @@ identifier currently available is version="2.22"> Gets a hint about how a drive can be started/stopped. + line="20512">Gets a hint about how a drive can be started/stopped. A value from the #GDriveStartStopType enumeration. + line="20518">A value from the #GDriveStartStopType enumeration. a #GDrive. + line="20514">a #GDrive. @@ -33508,12 +34070,12 @@ identifier currently available is version="2.34"> Gets the icon for @drive. + line="20523">Gets the icon for @drive. symbolic #GIcon for the @drive. + line="20529">symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). @@ -33521,7 +34083,7 @@ identifier currently available is a #GDrive. + line="20525">a #GDrive. @@ -33529,7 +34091,7 @@ identifier currently available is Get a list of mountable volumes for @drive. + line="20535">Get a list of mountable volumes for @drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -33537,7 +34099,7 @@ its elements have been unreffed with g_object_unref(). #GList containing any #GVolume objects on the given @drive. + line="20544">#GList containing any #GVolume objects on the given @drive. @@ -33546,7 +34108,7 @@ its elements have been unreffed with g_object_unref(). a #GDrive. + line="20537">a #GDrive. @@ -33554,21 +34116,21 @@ its elements have been unreffed with g_object_unref(). Checks if the @drive has media. Note that the OS may not be polling + line="20548">Checks if the @drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details. %TRUE if @drive has media, %FALSE otherwise. + line="20556">%TRUE if @drive has media, %FALSE otherwise. a #GDrive. + line="20550">a #GDrive. @@ -33576,19 +34138,19 @@ for more details. Check if @drive has any mountable volumes. + line="20560">Check if @drive has any mountable volumes. %TRUE if the @drive contains volumes, %FALSE otherwise. + line="20566">%TRUE if the @drive contains volumes, %FALSE otherwise. a #GDrive. + line="20562">a #GDrive. @@ -33597,12 +34159,12 @@ for more details. c:identifier="g_drive_is_media_check_automatic"> Checks if @drive is capable of automatically detecting media changes. + line="20570">Checks if @drive is capable of automatically detecting media changes. %TRUE if the @drive is capable of automatically detecting + line="20576">%TRUE if the @drive is capable of automatically detecting media changes, %FALSE otherwise. @@ -33610,7 +34172,7 @@ for more details. a #GDrive. + line="20572">a #GDrive. @@ -33619,19 +34181,19 @@ for more details. c:identifier="g_drive_is_media_removable"> Checks if the @drive supports removable media. + line="20581">Checks if the @drive supports removable media. %TRUE if @drive supports removable media, %FALSE otherwise. + line="20587">%TRUE if @drive supports removable media, %FALSE otherwise. a #GDrive. + line="20583">a #GDrive. @@ -33641,20 +34203,20 @@ for more details. version="2.50"> Checks if the #GDrive and/or its media is considered removable by the user. + line="20591">Checks if the #GDrive and/or its media is considered removable by the user. See g_drive_is_media_removable(). %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + line="20598">%TRUE if @drive and/or its media is considered removable, %FALSE otherwise. a #GDrive. + line="20593">a #GDrive. @@ -33662,7 +34224,7 @@ See g_drive_is_media_removable(). Asynchronously polls @drive to see if media has been inserted or removed. + line="20603">Asynchronously polls @drive to see if media has been inserted or removed. When the operation is finished, @callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the @@ -33675,7 +34237,7 @@ result of the operation. a #GDrive. + line="20605">a #GDrive. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20606">optional #GCancellable object, %NULL to ignore. closure="2"> a #GAsyncReadyCallback, or %NULL. + line="20607">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data to pass to @callback + line="20608">user data to pass to @callback @@ -33714,12 +34276,12 @@ result of the operation. throws="1"> Finishes an operation started with g_drive_poll_for_media() on a drive. + line="20618">Finishes an operation started with g_drive_poll_for_media() on a drive. %TRUE if the drive has been poll_for_mediaed successfully, + line="20626">%TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. @@ -33727,13 +34289,13 @@ result of the operation. a #GDrive. + line="20620">a #GDrive. a #GAsyncResult. + line="20621">a #GAsyncResult. @@ -33741,7 +34303,7 @@ result of the operation. Asynchronously starts a drive. + line="20631">Asynchronously starts a drive. When the operation is finished, @callback will be called. You can then call g_drive_start_finish() to obtain the @@ -33754,13 +34316,13 @@ result of the operation. a #GDrive. + line="20633">a #GDrive. flags affecting the start operation. + line="20634">flags affecting the start operation. allow-none="1"> a #GMountOperation or %NULL to avoid + line="20635">a #GMountOperation or %NULL to avoid user interaction. @@ -33779,7 +34341,7 @@ result of the operation. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20637">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20638">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data to pass to @callback + line="20639">user data to pass to @callback @@ -33810,12 +34372,12 @@ result of the operation. throws="1"> Finishes starting a drive. + line="20651">Finishes starting a drive. %TRUE if the drive has been started successfully, + line="20659">%TRUE if the drive has been started successfully, %FALSE otherwise. @@ -33823,13 +34385,13 @@ result of the operation. a #GDrive. + line="20653">a #GDrive. a #GAsyncResult. + line="20654">a #GAsyncResult. @@ -33837,7 +34399,7 @@ result of the operation. Asynchronously stops a drive. + line="20665">Asynchronously stops a drive. When the operation is finished, @callback will be called. You can then call g_drive_stop_finish() to obtain the @@ -33850,13 +34412,13 @@ result of the operation. a #GDrive. + line="20667">a #GDrive. flags affecting the unmount if required for stopping. + line="20668">flags affecting the unmount if required for stopping. allow-none="1"> a #GMountOperation or %NULL to avoid + line="20669">a #GMountOperation or %NULL to avoid user interaction. @@ -33875,7 +34437,7 @@ result of the operation. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20671">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20672">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data to pass to @callback + line="20673">user data to pass to @callback @@ -33906,12 +34468,12 @@ result of the operation. throws="1"> Finishes stopping a drive. + line="20685">Finishes stopping a drive. %TRUE if the drive has been stopped successfully, + line="20693">%TRUE if the drive has been stopped successfully, %FALSE otherwise. @@ -33919,13 +34481,13 @@ result of the operation. a #GDrive. + line="20687">a #GDrive. a #GAsyncResult. + line="20688">a #GAsyncResult. @@ -33933,7 +34495,7 @@ result of the operation. Emitted when the drive's state has changed. + line="1506">Emitted when the drive's state has changed. @@ -33941,7 +34503,7 @@ result of the operation. This signal is emitted when the #GDrive have been + line="1514">This signal is emitted when the #GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -33952,7 +34514,7 @@ finalized. Emitted when the physical eject button (if any) of a drive has + line="1525">Emitted when the physical eject button (if any) of a drive has been pressed. @@ -33961,7 +34523,7 @@ been pressed. Emitted when the physical stop button (if any) of a drive has + line="1534">Emitted when the physical stop button (if any) of a drive has been pressed. @@ -34026,7 +34588,7 @@ been pressed. a string containing @drive's name. The returned + line="20496">a string containing @drive's name. The returned string should be freed when no longer needed. @@ -34034,7 +34596,7 @@ been pressed. a #GDrive. + line="20492">a #GDrive. @@ -34046,7 +34608,7 @@ been pressed. #GIcon for the @drive. + line="20470">#GIcon for the @drive. Free the returned object with g_object_unref(). @@ -34054,7 +34616,7 @@ been pressed. a #GDrive. + line="20466">a #GDrive. @@ -34066,14 +34628,14 @@ been pressed. %TRUE if the @drive contains volumes, %FALSE otherwise. + line="20566">%TRUE if the @drive contains volumes, %FALSE otherwise. a #GDrive. + line="20562">a #GDrive. @@ -34085,7 +34647,7 @@ been pressed. #GList containing any #GVolume objects on the given @drive. + line="20544">#GList containing any #GVolume objects on the given @drive. @@ -34094,7 +34656,7 @@ been pressed. a #GDrive. + line="20537">a #GDrive. @@ -34106,14 +34668,14 @@ been pressed. %TRUE if @drive supports removable media, %FALSE otherwise. + line="20587">%TRUE if @drive supports removable media, %FALSE otherwise. a #GDrive. + line="20583">a #GDrive. @@ -34125,14 +34687,14 @@ been pressed. %TRUE if @drive has media, %FALSE otherwise. + line="20556">%TRUE if @drive has media, %FALSE otherwise. a #GDrive. + line="20550">a #GDrive. @@ -34144,7 +34706,7 @@ been pressed. %TRUE if the @drive is capable of automatically detecting + line="20576">%TRUE if the @drive is capable of automatically detecting media changes, %FALSE otherwise. @@ -34152,7 +34714,7 @@ been pressed. a #GDrive. + line="20572">a #GDrive. @@ -34164,14 +34726,14 @@ been pressed. %TRUE if the @drive can be ejected, %FALSE otherwise. + line="20337">%TRUE if the @drive can be ejected, %FALSE otherwise. a #GDrive. + line="20333">a #GDrive. @@ -34183,7 +34745,7 @@ been pressed. %TRUE if the @drive can be polled for media changes, + line="20347">%TRUE if the @drive can be polled for media changes, %FALSE otherwise. @@ -34191,7 +34753,7 @@ been pressed. a #GDrive. + line="20343">a #GDrive. @@ -34207,13 +34769,13 @@ been pressed. a #GDrive. + line="20387">a #GDrive. flags affecting the unmount if required for eject + line="20388">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20389">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="20390">a #GAsyncReadyCallback, or %NULL. closure="4"> user data to pass to @callback + line="20391">user data to pass to @callback @@ -34255,7 +34817,7 @@ been pressed. %TRUE if the drive has been ejected successfully, + line="20411">%TRUE if the drive has been ejected successfully, %FALSE otherwise. @@ -34263,13 +34825,13 @@ been pressed. a #GDrive. + line="20405">a #GDrive. a #GAsyncResult. + line="20406">a #GAsyncResult. @@ -34285,7 +34847,7 @@ been pressed. a #GDrive. + line="20605">a #GDrive. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20606">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="20607">a #GAsyncReadyCallback, or %NULL. closure="3"> user data to pass to @callback + line="20608">user data to pass to @callback @@ -34327,7 +34889,7 @@ been pressed. %TRUE if the drive has been poll_for_mediaed successfully, + line="20626">%TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. @@ -34335,13 +34897,13 @@ been pressed. a #GDrive. + line="20620">a #GDrive. a #GAsyncResult. + line="20621">a #GAsyncResult. @@ -34353,7 +34915,7 @@ been pressed. a newly allocated string containing the + line="20484">a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. @@ -34362,13 +34924,13 @@ been pressed. a #GDrive + line="20477">a #GDrive the kind of identifier to return + line="20478">the kind of identifier to return @@ -34380,7 +34942,7 @@ been pressed. a %NULL-terminated + line="20458">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -34391,7 +34953,7 @@ been pressed. a #GDrive + line="20452">a #GDrive @@ -34403,14 +34965,14 @@ been pressed. A value from the #GDriveStartStopType enumeration. + line="20518">A value from the #GDriveStartStopType enumeration. a #GDrive. + line="20514">a #GDrive. @@ -34422,14 +34984,14 @@ been pressed. %TRUE if the @drive can be started, %FALSE otherwise. + line="20358">%TRUE if the @drive can be started, %FALSE otherwise. a #GDrive. + line="20354">a #GDrive. @@ -34441,14 +35003,14 @@ been pressed. %TRUE if the @drive can be started degraded, %FALSE otherwise. + line="20369">%TRUE if the @drive can be started degraded, %FALSE otherwise. a #GDrive. + line="20365">a #GDrive. @@ -34464,13 +35026,13 @@ been pressed. a #GDrive. + line="20633">a #GDrive. flags affecting the start operation. + line="20634">flags affecting the start operation. allow-none="1"> a #GMountOperation or %NULL to avoid + line="20635">a #GMountOperation or %NULL to avoid user interaction. @@ -34489,7 +35051,7 @@ been pressed. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20637">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback, or %NULL. + line="20638">a #GAsyncReadyCallback, or %NULL. closure="5"> user data to pass to @callback + line="20639">user data to pass to @callback @@ -34522,7 +35084,7 @@ been pressed. %TRUE if the drive has been started successfully, + line="20659">%TRUE if the drive has been started successfully, %FALSE otherwise. @@ -34530,13 +35092,13 @@ been pressed. a #GDrive. + line="20653">a #GDrive. a #GAsyncResult. + line="20654">a #GAsyncResult. @@ -34548,14 +35110,14 @@ been pressed. %TRUE if the @drive can be stopped, %FALSE otherwise. + line="20380">%TRUE if the @drive can be stopped, %FALSE otherwise. a #GDrive. + line="20376">a #GDrive. @@ -34571,13 +35133,13 @@ been pressed. a #GDrive. + line="20667">a #GDrive. flags affecting the unmount if required for stopping. + line="20668">flags affecting the unmount if required for stopping. allow-none="1"> a #GMountOperation or %NULL to avoid + line="20669">a #GMountOperation or %NULL to avoid user interaction. @@ -34596,7 +35158,7 @@ been pressed. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20671">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback, or %NULL. + line="20672">a #GAsyncReadyCallback, or %NULL. closure="5"> user data to pass to @callback + line="20673">user data to pass to @callback @@ -34629,7 +35191,7 @@ been pressed. %TRUE if the drive has been stopped successfully, + line="20693">%TRUE if the drive has been stopped successfully, %FALSE otherwise. @@ -34637,13 +35199,13 @@ been pressed. a #GDrive. + line="20687">a #GDrive. a #GAsyncResult. + line="20688">a #GAsyncResult. @@ -34672,13 +35234,13 @@ been pressed. a #GDrive. + line="20419">a #GDrive. flags affecting the unmount if required for eject + line="20420">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to avoid + line="20421">a #GMountOperation or %NULL to avoid user interaction. @@ -34697,7 +35259,7 @@ been pressed. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="20423">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback, or %NULL. + line="20424">a #GAsyncReadyCallback, or %NULL. closure="5"> user data passed to @callback. + line="20425">user data passed to @callback. @@ -34730,20 +35292,20 @@ been pressed. %TRUE if the drive was successfully ejected. %FALSE otherwise. + line="20445">%TRUE if the drive was successfully ejected. %FALSE otherwise. a #GDrive. + line="20437">a #GDrive. a #GAsyncResult. + line="20438">a #GAsyncResult. @@ -34755,14 +35317,14 @@ been pressed. Sorting key for @drive or %NULL if no such key is available. + line="20507">Sorting key for @drive or %NULL if no such key is available. A #GDrive. + line="20503">A #GDrive. @@ -34774,7 +35336,7 @@ been pressed. symbolic #GIcon for the @drive. + line="20529">symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). @@ -34782,7 +35344,7 @@ been pressed. a #GDrive. + line="20525">a #GDrive. @@ -34794,14 +35356,14 @@ been pressed. %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + line="20598">%TRUE if @drive and/or its media is considered removable, %FALSE otherwise. a #GDrive. + line="20593">a #GDrive. @@ -34819,7 +35381,8 @@ been pressed. + glib:nick="none" + glib:name="G_DRIVE_START_NONE"> No flags set. @@ -34836,7 +35399,8 @@ been pressed. + glib:nick="unknown" + glib:name="G_DRIVE_START_STOP_TYPE_UNKNOWN"> Unknown or drive doesn't support @@ -34845,7 +35409,8 @@ been pressed. + glib:nick="shutdown" + glib:name="G_DRIVE_START_STOP_TYPE_SHUTDOWN"> The stop method will physically @@ -34855,7 +35420,8 @@ been pressed. + glib:nick="network" + glib:name="G_DRIVE_START_STOP_TYPE_NETWORK"> The start/stop methods are used @@ -34864,7 +35430,8 @@ been pressed. + glib:nick="multidisk" + glib:name="G_DRIVE_START_STOP_TYPE_MULTIDISK"> The start/stop methods will @@ -34874,7 +35441,8 @@ been pressed. + glib:nick="password" + glib:name="G_DRIVE_START_STOP_TYPE_PASSWORD"> The start/stop methods will @@ -34891,7 +35459,7 @@ been pressed. glib:type-struct="DtlsClientConnectionInterface"> #GDtlsClientConnection is the client-side subclass of + line="6285">#GDtlsClientConnection is the client-side subclass of #GDtlsConnection, representing a client-side DTLS connection. @@ -34902,13 +35470,13 @@ been pressed. throws="1"> Creates a new #GDtlsClientConnection wrapping @base_socket which is + line="20742">Creates a new #GDtlsClientConnection wrapping @base_socket which is assumed to communicate with the server identified by @server_identity. the new + line="20751">the new #GDtlsClientConnection, or %NULL on error @@ -34916,7 +35484,7 @@ assumed to communicate with the server identified by @server_identity. the #GDatagramBased to wrap + line="20744">the #GDatagramBased to wrap allow-none="1"> the expected identity of the server + line="20745">the expected identity of the server Gets the list of distinguished names of the Certificate Authorities + line="20699">Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be %NULL. @@ -34946,7 +35515,7 @@ subject DN of the certificate authority. the list of + line="20711">the list of CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free(). @@ -34959,22 +35528,23 @@ the free the list with g_list_free(). the #GDtlsClientConnection + line="20701">the #GDtlsClientConnection Gets @conn's expected server identity + line="20718">Gets @conn's expected server identity a #GSocketConnectable describing the + line="20724">a #GSocketConnectable describing the expected server identity, or %NULL if the expected identity is not known. @@ -34983,39 +35553,41 @@ known. the #GDtlsClientConnection + line="20720">the #GDtlsClientConnection Gets @conn's validation flags + line="20731">Gets @conn's validation flags the validation flags + line="20737">the validation flags the #GDtlsClientConnection + line="20733">the #GDtlsClientConnection Sets @conn's expected server identity, which is used both to tell + line="20757">Sets @conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let @conn know what name to look for in the certificate when performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. @@ -35027,23 +35599,24 @@ performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. the #GDtlsClientConnection + line="20759">the #GDtlsClientConnection a #GSocketConnectable describing the expected server identity + line="20760">a #GSocketConnectable describing the expected server identity Sets @conn's validation flags, to override the default set of + line="20771">Sets @conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used. @@ -35054,21 +35627,24 @@ checks performed when validating a server certificate. By default, the #GDtlsClientConnection + line="20773">the #GDtlsClientConnection the #GTlsCertificateFlags to use + line="20774">the #GTlsCertificateFlags to use - + A list of the distinguished names of the Certificate Authorities + line="1555">A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes. @@ -35083,10 +35659,12 @@ subject DN of the certificate authority. version="2.48" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_server_identity" + getter="get_server_identity"> A #GSocketConnectable describing the identity of the server that + line="1570">A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in @@ -35106,10 +35684,12 @@ virtual hosts. version="2.48" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_validation_flags" + getter="get_validation_flags"> What steps to perform when validating a certificate received from + line="1592">What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in any of the ways indicated here will be rejected unless the application overrides the default via #GDtlsConnection::accept-certificate. @@ -35140,7 +35720,7 @@ overrides the default via #GDtlsConnection::accept-certificate. glib:type-struct="DtlsConnectionInterface"> #GDtlsConnection is the base DTLS connection class type, which wraps + line="6297">#GDtlsConnection is the base DTLS connection class type, which wraps a #GDatagramBased and provides DTLS encryption on top of it. Its subclasses, #GDtlsClientConnection and #GDtlsServerConnection, implement client-side and server-side DTLS, respectively. @@ -35159,10 +35739,10 @@ on their base #GDatagramBased if it is a #GSocket — it is up to the caller to do that if they wish. If they do not, and g_socket_close() is called on the base socket, the #GDtlsConnection will not raise a %G_IO_ERROR_NOT_CONNECTED error on further I/O. - + - + @@ -35179,7 +35759,7 @@ error on further I/O. - + @@ -35203,25 +35783,25 @@ error on further I/O. version="2.60"> Gets the name of the application-layer protocol negotiated during + line="20942">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_dtls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + line="20954">the negotiated protocol, or %NULL a #GDtlsConnection + line="20944">a #GDtlsConnection @@ -35232,7 +35812,7 @@ g_dtls_connection_set_advertised_protocols(). throws="1"> Attempts a TLS handshake on @conn. + line="21027">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -35258,18 +35838,18 @@ the initial handshake will no longer do anything. #GDtlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + line="21060">success or failure a #GDtlsConnection + line="21029">a #GDtlsConnection allow-none="1"> a #GCancellable, or %NULL + line="21030">a #GCancellable, or %NULL @@ -35288,9 +35868,9 @@ handshake. version="2.48"> Asynchronously performs a TLS handshake on @conn. See + line="21065">Asynchronously performs a TLS handshake on @conn. See g_dtls_connection_handshake() for more information. - + @@ -35298,13 +35878,13 @@ g_dtls_connection_handshake() for more information. a #GDtlsConnection + line="21067">a #GDtlsConnection the [I/O priority][io-priority] of the request + line="21068">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="21069">a #GCancellable, or %NULL closure="3"> callback to call when the handshake is complete + line="21070">callback to call when the handshake is complete closure="3"> the data to pass to the callback function + line="21071">the data to pass to the callback function @@ -35345,13 +35925,13 @@ g_dtls_connection_handshake() for more information. throws="1"> Finish an asynchronous TLS handshake operation. See + line="21080">Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + line="21089">%TRUE on success, %FALSE on failure, in which case @error will be set. @@ -35359,13 +35939,13 @@ case @error will be set. a #GDtlsConnection + line="21082">a #GDtlsConnection a #GAsyncResult. + line="21083">a #GAsyncResult. @@ -35375,7 +35955,7 @@ case @error will be set. version="2.60"> Sets the list of application-layer protocols to advertise that the + line="21095">Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -35385,7 +35965,7 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + @@ -35393,7 +35973,7 @@ for a list of registered protocol IDs. a #GDtlsConnection + line="21097">a #GDtlsConnection allow-none="1"> a %NULL-terminated + line="21098">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -35416,7 +35996,7 @@ for a list of registered protocol IDs. throws="1"> Shut down part or all of a DTLS connection. + line="21230">Shut down part or all of a DTLS connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to @@ -35432,30 +36012,30 @@ is equivalent to calling g_dtls_connection_close(). If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. - + %TRUE on success, %FALSE otherwise + line="21255">%TRUE on success, %FALSE otherwise a #GDtlsConnection + line="21232">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + line="21233">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + line="21234">%TRUE to stop sending outgoing datagrams a #GCancellable, or %NULL + line="21235">a #GCancellable, or %NULL @@ -35474,9 +36054,9 @@ g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. Asynchronously shut down part or all of the DTLS connection. See + line="21260">Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information. - + @@ -35484,25 +36064,25 @@ g_dtls_connection_shutdown() for more information. a #GDtlsConnection + line="21262">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + line="21263">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + line="21264">%TRUE to stop sending outgoing datagrams the [I/O priority][io-priority] of the request + line="21265">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="21266">a #GCancellable, or %NULL closure="5"> callback to call when the shutdown operation is complete + line="21267">callback to call when the shutdown operation is complete closure="5"> the data to pass to the callback function + line="21268">the data to pass to the callback function @@ -35543,13 +36123,13 @@ g_dtls_connection_shutdown() for more information. throws="1"> Finish an asynchronous TLS shutdown operation. See + line="21277">Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information. - + %TRUE on success, %FALSE on failure, in which + line="21286">%TRUE on success, %FALSE on failure, in which case @error will be set @@ -35557,13 +36137,13 @@ case @error will be set a #GDtlsConnection + line="21279">a #GDtlsConnection a #GAsyncResult + line="21280">a #GAsyncResult @@ -35574,7 +36154,7 @@ case @error will be set throws="1"> Close the DTLS connection. This is equivalent to calling + line="20784">Close the DTLS connection. This is equivalent to calling g_dtls_connection_shutdown() to shut down both sides of the connection. Closing a #GDtlsConnection waits for all buffered but untransmitted data to @@ -35593,18 +36173,18 @@ released as early as possible. If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_close() again to complete closing the #GDtlsConnection. - + %TRUE on success, %FALSE otherwise + line="20810">%TRUE on success, %FALSE otherwise a #GDtlsConnection + line="20786">a #GDtlsConnection allow-none="1"> a #GCancellable, or %NULL + line="20787">a #GCancellable, or %NULL @@ -35623,9 +36203,9 @@ g_dtls_connection_close() again to complete closing the #GDtlsConnection. version="2.48"> Asynchronously close the DTLS connection. See g_dtls_connection_close() for + line="20815">Asynchronously close the DTLS connection. See g_dtls_connection_close() for more information. - + @@ -35633,13 +36213,13 @@ more information. a #GDtlsConnection + line="20817">a #GDtlsConnection the [I/O priority][io-priority] of the request + line="20818">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="20819">a #GCancellable, or %NULL closure="3"> callback to call when the close operation is complete + line="20820">callback to call when the close operation is complete allow-none="1"> the data to pass to the callback function + line="20821">the data to pass to the callback function @@ -35679,13 +36259,13 @@ more information. throws="1"> Finish an asynchronous TLS close operation. See g_dtls_connection_close() + line="20830">Finish an asynchronous TLS close operation. See g_dtls_connection_close() for more information. - + %TRUE on success, %FALSE on failure, in which + line="20839">%TRUE on success, %FALSE on failure, in which case @error will be set @@ -35693,13 +36273,13 @@ case @error will be set a #GDtlsConnection + line="20832">a #GDtlsConnection a #GAsyncResult + line="20833">a #GAsyncResult @@ -35709,13 +36289,13 @@ case @error will be set version="2.48"> Used by #GDtlsConnection implementations to emit the + line="20845">Used by #GDtlsConnection implementations to emit the #GDtlsConnection::accept-certificate signal. - + %TRUE if one of the signal handlers has returned + line="20854">%TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert @@ -35723,42 +36303,43 @@ case @error will be set a #GDtlsConnection + line="20847">a #GDtlsConnection the peer's #GTlsCertificate + line="20848">the peer's #GTlsCertificate the problems with @peer_cert + line="20849">the problems with @peer_cert Gets @conn's certificate, as set by + line="20860">Gets @conn's certificate, as set by g_dtls_connection_set_certificate(). - + @conn's certificate, or %NULL + line="20867">@conn's certificate, or %NULL a #GDtlsConnection + line="20862">a #GDtlsConnection @@ -35769,7 +36350,7 @@ g_dtls_connection_set_certificate(). throws="1"> Query the TLS backend for TLS channel binding data of @type for @conn. + line="20872">Query the TLS backend for TLS channel binding data of @type for @conn. This call retrieves TLS channel binding data as specified in RFC [5056](https://tools.ietf.org/html/rfc5056), RFC @@ -35782,24 +36363,24 @@ is supported by the TLS backend). It does not guarantee that the data will be available though. That could happen if TLS connection does not support @type or the binding data is not available yet due to additional negotiation or input required. - + %TRUE on success, %FALSE otherwise + line="20894">%TRUE on success, %FALSE otherwise a #GDtlsConnection + line="20874">a #GDtlsConnection #GTlsChannelBindingType type of data to fetch + line="20875">#GTlsChannelBindingType type of data to fetch @@ -35811,7 +36392,7 @@ negotiation or input required. allow-none="1"> #GByteArray is + line="20876">#GByteArray is filled with the binding data, or %NULL @@ -35819,177 +36400,240 @@ negotiation or input required. + + Returns the name of the current DTLS ciphersuite, or %NULL if the +connection has not handshaked or has been closed. Beware that the TLS +backend may use any of multiple different naming conventions, because +OpenSSL and GnuTLS have their own ciphersuite naming conventions that +are different from each other and different from the standard, IANA- +registered ciphersuite names. The ciphersuite name is intended to be +displayed to the user for informative purposes only, and parsing it +is not recommended. + + + The name of the current DTLS ciphersuite, or %NULL + + + + + a #GDTlsConnection + + + + Gets the certificate database that @conn uses to verify + line="20917">Gets the certificate database that @conn uses to verify peer certificates. See g_dtls_connection_set_database(). - + the certificate database that @conn uses or %NULL + line="20924">the certificate database that @conn uses or %NULL a #GDtlsConnection + line="20919">a #GDtlsConnection Get the object that will be used to interact with the user. It will be used + line="20929">Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If %NULL is returned, then no user interaction will occur for this connection. - + The interaction object. + line="20937">The interaction object. a connection + line="20931">a connection Gets the name of the application-layer protocol negotiated during + line="20942">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_dtls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + line="20954">the negotiated protocol, or %NULL a #GDtlsConnection + line="20944">a #GDtlsConnection Gets @conn's peer's certificate after the handshake has completed + line="20959">Gets @conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.) - + @conn's peer's certificate, or %NULL + line="20967">@conn's peer's certificate, or %NULL a #GDtlsConnection + line="20961">a #GDtlsConnection Gets the errors associated with validating @conn's peer's + line="20972">Gets the errors associated with validating @conn's peer's certificate, after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.) - + @conn's peer's certificate errors + line="20980">@conn's peer's certificate errors a #GDtlsConnection + line="20974">a #GDtlsConnection + + + + + + Returns the current DTLS protocol version, which may be +%G_TLS_PROTOCOL_VERSION_UNKNOWN if the connection has not handshaked, or +has been closed, or if the TLS backend has implemented a protocol version +that is not a recognized #GTlsProtocolVersion. + + + The current DTLS protocol version + + + + + a #GDTlsConnection Gets @conn rehandshaking mode. See + line="20999">Gets @conn rehandshaking mode. See g_dtls_connection_set_rehandshake_mode() for details. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + %G_TLS_REHANDSHAKE_SAFELY + line="21006">%G_TLS_REHANDSHAKE_SAFELY a #GDtlsConnection + line="21001">a #GDtlsConnection Tests whether or not @conn expects a proper TLS close notification + line="21014">Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_dtls_connection_set_require_close_notify() for details. - + %TRUE if @conn requires a proper TLS close notification. + line="21022">%TRUE if @conn requires a proper TLS close notification. a #GDtlsConnection + line="21016">a #GDtlsConnection @@ -36000,7 +36644,7 @@ g_dtls_connection_set_require_close_notify() for details. throws="1"> Attempts a TLS handshake on @conn. + line="21027">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -36026,18 +36670,18 @@ the initial handshake will no longer do anything. #GDtlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + line="21060">success or failure a #GDtlsConnection + line="21029">a #GDtlsConnection allow-none="1"> a #GCancellable, or %NULL + line="21030">a #GCancellable, or %NULL @@ -36056,9 +36700,9 @@ handshake. version="2.48"> Asynchronously performs a TLS handshake on @conn. See + line="21065">Asynchronously performs a TLS handshake on @conn. See g_dtls_connection_handshake() for more information. - + @@ -36066,13 +36710,13 @@ g_dtls_connection_handshake() for more information. a #GDtlsConnection + line="21067">a #GDtlsConnection the [I/O priority][io-priority] of the request + line="21068">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="21069">a #GCancellable, or %NULL closure="3"> callback to call when the handshake is complete + line="21070">callback to call when the handshake is complete allow-none="1"> the data to pass to the callback function + line="21071">the data to pass to the callback function @@ -36112,13 +36756,13 @@ g_dtls_connection_handshake() for more information. throws="1"> Finish an asynchronous TLS handshake operation. See + line="21080">Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + line="21089">%TRUE on success, %FALSE on failure, in which case @error will be set. @@ -36126,23 +36770,24 @@ case @error will be set. a #GDtlsConnection + line="21082">a #GDtlsConnection a #GAsyncResult. + line="21083">a #GAsyncResult. Sets the list of application-layer protocols to advertise that the + line="21095">Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -36152,7 +36797,7 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + @@ -36160,7 +36805,7 @@ for a list of registered protocol IDs. a #GDtlsConnection + line="21097">a #GDtlsConnection allow-none="1"> a %NULL-terminated + line="21098">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -36179,10 +36824,11 @@ for a list of registered protocol IDs. This sets the certificate that @conn will present to its peer + line="21116">This sets the certificate that @conn will present to its peer during the TLS handshake. For a #GDtlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. @@ -36200,7 +36846,7 @@ or without a certificate; in that case, if you don't provide a certificate, you can tell that the server requested one by the fact that g_dtls_client_connection_get_accepted_cas() will return non-%NULL.) - + @@ -36208,23 +36854,24 @@ non-%NULL.) a #GDtlsConnection + line="21118">a #GDtlsConnection the certificate to use for @conn + line="21119">the certificate to use for @conn Sets the certificate database that is used to verify peer certificates. + line="21144">Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the @@ -36232,7 +36879,7 @@ peer certificate validation will always set the #GDtlsConnection::accept-certificate will always be emitted on client-side connections, unless that bit is not set in #GDtlsClientConnection:validation-flags). - + @@ -36240,7 +36887,7 @@ client-side connections, unless that bit is not set in a #GDtlsConnection + line="21146">a #GDtlsConnection a #GTlsDatabase + line="21147">a #GTlsDatabase Set the object that will be used to interact with the user. It will be used + line="21162">Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. The @interaction argument will normally be a derived subclass of #GTlsInteraction. %NULL can also be provided if no user interaction should occur for this connection. - + @@ -36273,7 +36921,7 @@ should occur for this connection. a connection + line="21164">a connection allow-none="1"> an interaction object, or %NULL + line="21165">an interaction object, or %NULL Since GLib 2.64, changing the rehandshake mode is no longer supported + line="21178">Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + @@ -36309,23 +36958,24 @@ rekey operations. a #GDtlsConnection + line="21180">a #GDtlsConnection the rehandshaking mode + line="21181">the rehandshaking mode Sets whether or not @conn expects a proper TLS close notification + line="21195">Sets whether or not @conn expects a proper TLS close notification before the connection is closed. If this is %TRUE (the default), then @conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a @@ -36350,7 +37000,7 @@ connection; when the application calls g_dtls_connection_close_async() on setting of this property. If you explicitly want to do an unclean close, you can close @conn's #GDtlsConnection:base-socket rather than closing @conn itself. - + @@ -36358,13 +37008,13 @@ than closing @conn itself. a #GDtlsConnection + line="21197">a #GDtlsConnection whether or not to require close notification + line="21198">whether or not to require close notification @@ -36375,7 +37025,7 @@ than closing @conn itself. throws="1"> Shut down part or all of a DTLS connection. + line="21230">Shut down part or all of a DTLS connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to @@ -36391,30 +37041,30 @@ is equivalent to calling g_dtls_connection_close(). If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. - + %TRUE on success, %FALSE otherwise + line="21255">%TRUE on success, %FALSE otherwise a #GDtlsConnection + line="21232">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + line="21233">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + line="21234">%TRUE to stop sending outgoing datagrams a #GCancellable, or %NULL + line="21235">a #GCancellable, or %NULL @@ -36433,9 +37083,9 @@ g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. Asynchronously shut down part or all of the DTLS connection. See + line="21260">Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information. - + @@ -36443,25 +37093,25 @@ g_dtls_connection_shutdown() for more information. a #GDtlsConnection + line="21262">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + line="21263">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + line="21264">%TRUE to stop sending outgoing datagrams the [I/O priority][io-priority] of the request + line="21265">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="21266">a #GCancellable, or %NULL closure="5"> callback to call when the shutdown operation is complete + line="21267">callback to call when the shutdown operation is complete allow-none="1"> the data to pass to the callback function + line="21268">the data to pass to the callback function @@ -36501,13 +37151,13 @@ g_dtls_connection_shutdown() for more information. throws="1"> Finish an asynchronous TLS shutdown operation. See + line="21277">Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information. - + %TRUE on success, %FALSE on failure, in which + line="21286">%TRUE on success, %FALSE on failure, in which case @error will be set @@ -36515,13 +37165,13 @@ case @error will be set a #GDtlsConnection + line="21279">a #GDtlsConnection a #GAsyncResult + line="21280">a #GAsyncResult @@ -36529,10 +37179,11 @@ case @error will be set + transfer-ownership="none" + setter="set_advertised_protocols"> The list of application-layer protocols that the connection + line="1662">The list of application-layer protocols that the connection advertises that it is willing to speak. See g_dtls_connection_set_advertised_protocols(). @@ -36546,27 +37197,40 @@ g_dtls_connection_set_advertised_protocols(). transfer-ownership="none"> The #GDatagramBased that the connection wraps. Note that this may be any + line="1673">The #GDatagramBased that the connection wraps. Note that this may be any implementation of #GDatagramBased, not just a #GSocket. + transfer-ownership="none" + setter="set_certificate" + getter="get_certificate"> The connection's certificate; see + line="1683">The connection's certificate; see g_dtls_connection_set_certificate(). + + The name of the DTLS ciphersuite in use. See g_dtls_connection_get_ciphersuite_name(). + + + transfer-ownership="none" + setter="set_database" + getter="get_database"> The certificate database to use when verifying this TLS connection. + line="1702">The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). @@ -36574,29 +37238,33 @@ used. See g_tls_backend_get_default_database(). + transfer-ownership="none" + setter="set_interaction" + getter="get_interaction"> A #GTlsInteraction object to be used when the connection or certificate + line="1713">A #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. + transfer-ownership="none" + getter="get_negotiated_protocol"> The application-layer protocol negotiated during the TLS + line="1724">The application-layer protocol negotiated during the TLS handshake. See g_dtls_connection_get_negotiated_protocol(). + transfer-ownership="none" + getter="get_peer_certificate"> The connection's peer's certificate, after the TLS handshake has + line="1734">The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of #GDtlsConnection::accept-certificate. @@ -36606,10 +37274,11 @@ detect when a handshake has occurred.) + transfer-ownership="none" + getter="get_peer_certificate_errors"> The errors noticed while verifying + line="1748">The errors noticed while verifying #GDtlsConnection:peer-certificate. Normally this should be 0, but it may not be if #GDtlsClientConnection:validation-flags is not %G_TLS_CERTIFICATE_VALIDATE_ALL, or if @@ -36617,16 +37286,27 @@ it may not be if #GDtlsClientConnection:validation-flags is not behavior. + + The DTLS protocol version in use. See g_dtls_connection_get_protocol_version(). + + + transfer-ownership="none" + setter="set_rehandshake_mode" + getter="get_rehandshake_mode"> The rehandshaking mode. See + line="1771">The rehandshaking mode. See g_dtls_connection_set_rehandshake_mode(). The rehandshake mode is ignored. @@ -36635,17 +37315,19 @@ g_dtls_connection_set_rehandshake_mode(). version="2.48" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_require_close_notify" + getter="get_require_close_notify"> Whether or not proper TLS close notification is required. + line="1782">Whether or not proper TLS close notification is required. See g_dtls_connection_set_require_close_notify(). Emitted during the TLS handshake after the peer certificate has + line="1614">Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. @@ -36681,7 +37363,7 @@ handler until the UI thread returns an answer. %TRUE to accept @peer_cert (which will also + line="1654">%TRUE to accept @peer_cert (which will also immediately end the signal emission). %FALSE to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it. @@ -36691,13 +37373,13 @@ no one else overrides it. the peer's #GTlsCertificate + line="1617">the peer's #GTlsCertificate the problems with @peer_cert. + line="1618">the problems with @peer_cert. @@ -36710,7 +37392,7 @@ no one else overrides it. Virtual method table for a #GDtlsConnection implementation. - + - + @@ -36738,18 +37420,18 @@ no one else overrides it. - + success or failure + line="21060">success or failure a #GDtlsConnection + line="21029">a #GDtlsConnection allow-none="1"> a #GCancellable, or %NULL + line="21030">a #GCancellable, or %NULL @@ -36766,7 +37448,7 @@ no one else overrides it. - + @@ -36774,13 +37456,13 @@ no one else overrides it. a #GDtlsConnection + line="21067">a #GDtlsConnection the [I/O priority][io-priority] of the request + line="21068">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="21069">a #GCancellable, or %NULL closure="4"> callback to call when the handshake is complete + line="21070">callback to call when the handshake is complete closure="4"> the data to pass to the callback function + line="21071">the data to pass to the callback function @@ -36818,11 +37500,11 @@ no one else overrides it. - + %TRUE on success, %FALSE on failure, in which + line="21089">%TRUE on success, %FALSE on failure, in which case @error will be set. @@ -36830,13 +37512,13 @@ case @error will be set. a #GDtlsConnection + line="21082">a #GDtlsConnection a #GAsyncResult. + line="21083">a #GAsyncResult. @@ -36844,30 +37526,30 @@ case @error will be set. - + %TRUE on success, %FALSE otherwise + line="21255">%TRUE on success, %FALSE otherwise a #GDtlsConnection + line="21232">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + line="21233">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + line="21234">%TRUE to stop sending outgoing datagrams allow-none="1"> a #GCancellable, or %NULL + line="21235">a #GCancellable, or %NULL @@ -36884,7 +37566,7 @@ case @error will be set. - + @@ -36892,25 +37574,25 @@ case @error will be set. a #GDtlsConnection + line="21262">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + line="21263">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + line="21264">%TRUE to stop sending outgoing datagrams the [I/O priority][io-priority] of the request + line="21265">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="21266">a #GCancellable, or %NULL closure="6"> callback to call when the shutdown operation is complete + line="21267">callback to call when the shutdown operation is complete closure="6"> the data to pass to the callback function + line="21268">the data to pass to the callback function @@ -36948,11 +37630,11 @@ case @error will be set. - + %TRUE on success, %FALSE on failure, in which + line="21286">%TRUE on success, %FALSE on failure, in which case @error will be set @@ -36960,13 +37642,13 @@ case @error will be set a #GDtlsConnection + line="21279">a #GDtlsConnection a #GAsyncResult + line="21280">a #GAsyncResult @@ -36974,7 +37656,7 @@ case @error will be set - + @@ -36982,7 +37664,7 @@ case @error will be set a #GDtlsConnection + line="21097">a #GDtlsConnection allow-none="1"> a %NULL-terminated + line="21098">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -37002,18 +37684,18 @@ case @error will be set - + the negotiated protocol, or %NULL + line="20954">the negotiated protocol, or %NULL a #GDtlsConnection + line="20944">a #GDtlsConnection @@ -37021,7 +37703,7 @@ case @error will be set - + @@ -37051,7 +37733,7 @@ case @error will be set glib:type-struct="DtlsServerConnectionInterface"> #GDtlsServerConnection is the server-side subclass of #GDtlsConnection, + line="6326">#GDtlsServerConnection is the server-side subclass of #GDtlsConnection, representing a server-side DTLS connection. @@ -37062,12 +37744,12 @@ representing a server-side DTLS connection. throws="1"> Creates a new #GDtlsServerConnection wrapping @base_socket. + line="21292">Creates a new #GDtlsServerConnection wrapping @base_socket. the new + line="21300">the new #GDtlsServerConnection, or %NULL on error @@ -37075,7 +37757,7 @@ representing a server-side DTLS connection. the #GDatagramBased to wrap + line="21294">the #GDatagramBased to wrap allow-none="1"> the default server certificate, or %NULL + line="21295">the default server certificate, or %NULL @@ -37095,7 +37777,7 @@ representing a server-side DTLS connection. transfer-ownership="none"> The #GTlsAuthenticationMode for the server. This can be changed + line="1792">The #GTlsAuthenticationMode for the server. This can be changed before calling g_dtls_connection_handshake() if you want to rehandshake with a different mode from the initial handshake. @@ -37177,7 +37859,7 @@ rehandshake with a different mode from the initial handshake. glib:type-struct="EmblemClass"> #GEmblem is an implementation of #GIcon that supports + line="6338">#GEmblem is an implementation of #GIcon that supports having an emblem, which is an icon with additional properties. It can than be added to a #GEmblemedIcon. @@ -37188,19 +37870,19 @@ supported. More may be added in the future. Creates a new emblem for @icon. + line="21329">Creates a new emblem for @icon. a new #GEmblem. + line="21335">a new #GEmblem. a GIcon containing the icon. + line="21331">a GIcon containing the icon. @@ -37210,38 +37892,41 @@ supported. More may be added in the future. version="2.18"> Creates a new emblem for @icon. + line="21340">Creates a new emblem for @icon. a new #GEmblem. + line="21347">a new #GEmblem. a GIcon containing the icon. + line="21342">a GIcon containing the icon. a GEmblemOrigin enum defining the emblem's origin + line="21343">a GEmblemOrigin enum defining the emblem's origin - + Gives back the icon from @emblem. + line="21306">Gives back the icon from @emblem. a #GIcon. The returned object belongs to + line="21312">a #GIcon. The returned object belongs to the emblem and should not be modified or freed. @@ -37249,29 +37934,30 @@ supported. More may be added in the future. a #GEmblem from which the icon should be extracted. + line="21308">a #GEmblem from which the icon should be extracted. Gets the origin of the emblem. + line="21318">Gets the origin of the emblem. the origin of the emblem + line="21324">the origin of the emblem a #GEmblem + line="21320">a #GEmblem @@ -37279,13 +37965,15 @@ supported. More may be added in the future. + transfer-ownership="none" + getter="get_icon"> + transfer-ownership="none" + getter="get_origin"> @@ -37307,7 +37995,8 @@ to #GEmblem. + glib:nick="unknown" + glib:name="G_EMBLEM_ORIGIN_UNKNOWN"> Emblem of unknown origin @@ -37315,7 +38004,8 @@ to #GEmblem. + glib:nick="device" + glib:name="G_EMBLEM_ORIGIN_DEVICE"> Emblem adds device-specific information @@ -37323,7 +38013,8 @@ to #GEmblem. + glib:nick="livemetadata" + glib:name="G_EMBLEM_ORIGIN_LIVEMETADATA"> Emblem depicts live metadata, such as "readonly" @@ -37331,7 +38022,8 @@ to #GEmblem. + glib:nick="tag" + glib:name="G_EMBLEM_ORIGIN_TAG"> Emblem comes from a user-defined tag, e.g. set by nautilus (in the future) @@ -37346,7 +38038,7 @@ to #GEmblem. glib:type-struct="EmblemedIconClass"> #GEmblemedIcon is an implementation of #GIcon that supports + line="6353">#GEmblemedIcon is an implementation of #GIcon that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via g_emblemed_icon_add_emblem(). @@ -37359,19 +38051,19 @@ of the emblems. See also #GEmblem for more information. version="2.18"> Creates a new emblemed icon for @icon with the emblem @emblem. + line="21396">Creates a new emblemed icon for @icon with the emblem @emblem. a new #GIcon + line="21403">a new #GIcon a #GIcon + line="21398">a #GIcon allow-none="1"> a #GEmblem, or %NULL + line="21399">a #GEmblem, or %NULL @@ -37390,7 +38082,7 @@ of the emblems. See also #GEmblem for more information. version="2.18"> Adds @emblem to the #GList of #GEmblems. + line="21352">Adds @emblem to the #GList of #GEmblems. @@ -37399,13 +38091,13 @@ of the emblems. See also #GEmblem for more information. a #GEmblemedIcon + line="21354">a #GEmblemedIcon a #GEmblem + line="21355">a #GEmblem @@ -37415,7 +38107,7 @@ of the emblems. See also #GEmblem for more information. version="2.28"> Removes all the emblems from @icon. + line="21363">Removes all the emblems from @icon. @@ -37424,7 +38116,7 @@ of the emblems. See also #GEmblem for more information. a #GEmblemedIcon + line="21365">a #GEmblemedIcon @@ -37434,12 +38126,12 @@ of the emblems. See also #GEmblem for more information. version="2.18"> Gets the list of emblems for the @icon. + line="21373">Gets the list of emblems for the @icon. a #GList of + line="21379">a #GList of #GEmblems that is owned by @emblemed @@ -37449,7 +38141,7 @@ of the emblems. See also #GEmblem for more information. a #GEmblemedIcon + line="21375">a #GEmblemedIcon @@ -37459,19 +38151,19 @@ of the emblems. See also #GEmblem for more information. version="2.18"> Gets the main icon for @emblemed. + line="21385">Gets the main icon for @emblemed. a #GIcon that is owned by @emblemed + line="21391">a #GIcon that is owned by @emblemed a #GEmblemedIcon + line="21387">a #GEmblemedIcon @@ -37541,10 +38233,12 @@ of the emblems. See also #GEmblem for more information. c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE"> A key in the "access" namespace for checking deletion privileges. + line="368">A key in the "access" namespace for checking deletion privileges. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + This attribute will be %TRUE if the user is able to delete the file. - + c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE"> A key in the "access" namespace for getting execution privileges. + line="357">A key in the "access" namespace for getting execution privileges. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + This attribute will be %TRUE if the user is able to execute the file. - + c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_READ"> A key in the "access" namespace for getting read privileges. + line="335">A key in the "access" namespace for getting read privileges. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + This attribute will be %TRUE if the user is able to read the file. - + c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME"> A key in the "access" namespace for checking renaming privileges. + line="391">A key in the "access" namespace for checking renaming privileges. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + This attribute will be %TRUE if the user is able to rename the file. - + c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH"> A key in the "access" namespace for checking trashing privileges. + line="379">A key in the "access" namespace for checking trashing privileges. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + This attribute will be %TRUE if the user is able to move the file to the trash. - + c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE"> A key in the "access" namespace for getting write privileges. + line="346">A key in the "access" namespace for getting write privileges. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + This attribute will be %TRUE if the user is able to write to the file. - + c:type="G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE"> A key in the "dos" namespace for checking if the file's archive flag -is set. This attribute is %TRUE if the archive flag is set. This attribute -is only available for DOS file systems. Corresponding #GFileAttributeType -is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + line="772">A key in the "dos" namespace for checking if the file's archive flag +is set. + +This attribute is %TRUE if the archive flag is set. + +This attribute is only available for DOS file systems. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + version="2.60"> A key in the "dos" namespace for checking if the file is a NTFS mount point + line="800">A key in the "dos" namespace for checking if the file is a NTFS mount point (a volume mount or a junction point). + This attribute is %TRUE if file is a reparse point of type [IO_REPARSE_TAG_MOUNT_POINT](https://msdn.microsoft.com/en-us/library/dd541667.aspx). + This attribute is only available for DOS file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_DOS_IS_SYSTEM"> A key in the "dos" namespace for checking if the file's backup flag -is set. This attribute is %TRUE if the backup flag is set. This attribute -is only available for DOS file systems. Corresponding #GFileAttributeType -is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + line="786">A key in the "dos" namespace for checking if the file's backup flag +is set. + +This attribute is %TRUE if the backup flag is set. + +This attribute is only available for DOS file systems. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + version="2.60"> A key in the "dos" namespace for getting the file NTFS reparse tag. + line="817">A key in the "dos" namespace for getting the file NTFS reparse tag. + This value is 0 for files that are not reparse points. + See the [Reparse Tags](https://msdn.microsoft.com/en-us/library/dd541667.aspx) -page for possible reparse tag values. Corresponding #GFileAttributeType -is %G_FILE_ATTRIBUTE_TYPE_UINT32. - +page for possible reparse tag values. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + c:type="G_FILE_ATTRIBUTE_ETAG_VALUE"> A key in the "etag" namespace for getting the value of the file's -entity tag. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_STRING. - + line="294">A key in the "etag" namespace for getting the value of the file's +entity tag. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + A key in the "filesystem" namespace for getting the number of bytes of free space left on the -file system. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT64. - + line="932">A key in the "filesystem" namespace for getting the number of bytes +of free space left on the file system. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. + A key in the "filesystem" namespace for checking if the file system -is read only. Is set to %TRUE if the file system is read only. + line="963">A key in the "filesystem" namespace for checking if the file system +is read only. + +Is set to %TRUE if the file system is read only. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_FILESYSTEM_REMOTE"> A key in the "filesystem" namespace for checking if the file system -is remote. Is set to %TRUE if the file system is remote. + line="986">A key in the "filesystem" namespace for checking if the file system +is remote. + +Is set to %TRUE if the file system is remote. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_FILESYSTEM_SIZE"> A key in the "filesystem" namespace for getting the total size (in bytes) of the file system, -used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType -is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + line="922">A key in the "filesystem" namespace for getting the total size (in +bytes) of the file system, used in g_file_query_filesystem_info(). + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. + c:type="G_FILE_ATTRIBUTE_FILESYSTEM_TYPE"> A key in the "filesystem" namespace for getting the file system's type. + line="954">A key in the "filesystem" namespace for getting the file system's type. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + version="2.32"> A key in the "filesystem" namespace for getting the number of bytes of used on the -file system. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT64. - + line="942">A key in the "filesystem" namespace for getting the number of bytes +used by data on the file system. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. + A key in the "filesystem" namespace for hinting a file manager + line="975">A key in the "filesystem" namespace for hinting a file manager application whether it should preview (e.g. thumbnail) files on the -file system. The value for this key contain a -#GFilesystemPreviewType. - +file system. + +The value for this key contain a #GFilesystemPreviewType. + A key in the "gvfs" namespace that gets the name of the current -GVFS backend in use. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_STRING. - + line="998">A key in the "gvfs" namespace that gets the name of the current +GVFS backend in use. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + A key in the "id" namespace for getting a file identifier. + line="308">A key in the "id" namespace for getting a file identifier. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + An example use would be during listing files, to avoid recursive directory scanning. - + c:type="G_FILE_ATTRIBUTE_ID_FILESYSTEM"> A key in the "id" namespace for getting the file system identifier. + line="320">A key in the "id" namespace for getting the file system identifier. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + An example use would be during drag and drop to see if the source and target are on the same filesystem (default to move) or not (default to copy). - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected. + line="426">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) can be ejected. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. + line="406">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) is mountable. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + version="2.22"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled. + line="513">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) can be polled. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + version="2.22"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started. + line="466">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) can be started. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + version="2.22"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started -degraded. + line="478">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) can be started degraded. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + version="2.22"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped. + line="490">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) can be stopped. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable. + line="416">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) is unmountable. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI"> A key in the "mountable" namespace for getting the HAL UDI for the mountable -file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + line="456">A key in the "mountable" namespace for getting the HAL UDI for the mountable +file. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + version="2.22"> A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) -is automatically polled for media. + line="525">A key in the "mountable" namespace for checking if a file (of +type G_FILE_TYPE_MOUNTABLE) is automatically polled for media. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + version="2.22"> A key in the "mountable" namespace for getting the #GDriveStartStopType. + line="502">A key in the "mountable" namespace for getting the #GDriveStartStopType. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE"> A key in the "mountable" namespace for getting the unix device. + line="436">A key in the "mountable" namespace for getting the unix device. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + version="2.22"> A key in the "mountable" namespace for getting the unix device file. + line="445">A key in the "mountable" namespace for getting the unix device file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_OWNER_GROUP"> A key in the "owner" namespace for getting the file owner's group. + line="855">A key in the "owner" namespace for getting the file owner's group. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_OWNER_USER"> A key in the "owner" namespace for getting the user name of the -file's owner. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_STRING. - + line="835">A key in the "owner" namespace for getting the user name of the +file's owner. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + A key in the "owner" namespace for getting the real name of the -user that owns the file. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_STRING. - + line="845">A key in the "owner" namespace for getting the real name of the +user that owns the file. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + A key in the "preview" namespace for getting a #GIcon that can be -used to get preview of the file. For example, it may be a low -resolution thumbnail without metadata. Corresponding -#GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value -for this key should contain a #GIcon. - + line="904">A key in the "preview" namespace for getting a #GIcon that can be +used to get preview of the file. + +For example, it may be a low resolution thumbnail without metadata. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. + +The value for this key should contain a #GIcon. + version="2.52"> A key in the "recent" namespace for getting time, when the metadata for the -file in `recent:///` was last changed. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_INT64. - + line="1057">A key in the "recent" namespace for getting time, when the metadata for the +file in `recent:///` was last changed. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT64. + A key in the "selinux" namespace for getting the file's SELinux -context. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only -available if GLib has been built with SELinux support. - + line="1008">A key in the "selinux" namespace for getting the file's SELinux +context. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + +Note that this attribute is only available if GLib has been built +with SELinux support. + version="2.20"> A key in the "standard" namespace for getting the amount of disk space -that is consumed by the file (in bytes). This will generally be larger -than the file size (due to block size overhead) but can occasionally be -smaller (for example, for sparse files). + line="243">A key in the "standard" namespace for getting the amount of disk space +that is consumed by the file (in bytes). + +This will generally be larger than the file size (due to block size +overhead) but can occasionally be smaller (for example, for sparse files). + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + c:type="G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE"> A key in the "standard" namespace for getting the content type of the file. + line="209">A key in the "standard" namespace for getting the content type of the file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. + The value for this key should contain a valid content type. - + c:type="G_FILE_ATTRIBUTE_STANDARD_COPY_NAME"> A key in the "standard" namespace for getting the copy name of the file. + line="155">A key in the "standard" namespace for getting the copy name of the file. + The copy name is an optional version of the name. If available it's always in UTF8, and corresponds directly to the original filename (only transcoded to UTF8). This is useful if you want to copy the file to another filesystem that @@ -38018,7 +38787,7 @@ might have a different encoding. If the filename is not a valid string in the encoding selected for the filesystem it is in then the copy name will not be set. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_STANDARD_DESCRIPTION"> A key in the "standard" namespace for getting the description of the file. + line="170">A key in the "standard" namespace for getting the description of the file. + The description is a utf8 string that describes the file, generally containing the filename, but can also contain further information. Example descriptions could be "filename (on hostname)" for a remote file or "filename (in trash)" @@ -38034,7 +38804,7 @@ for a file in the trash. This is useful for instance as the window title when displaying a directory or for a bookmarks menu. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME"> A key in the "standard" namespace for getting the display name of the file. + line="129">A key in the "standard" namespace for getting the display name of the file. + A display name is guaranteed to be in UTF-8 and can thus be displayed in the UI. It is guaranteed to be set on every file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME"> A key in the "standard" namespace for edit name of the file. + line="141">A key in the "standard" namespace for edit name of the file. + An edit name is similar to the display name, but it is meant to be used when you want to rename the file in the UI. The display name might contain information you don't want in the new filename (such as "(invalid unicode)" if the filename was in an invalid encoding). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE"> A key in the "standard" namespace for getting the fast content type. + line="220">A key in the "standard" namespace for getting the fast content type. + The fast content type isn't as reliable as the regular one, as it only uses the filename to guess it, but it is faster to calculate than the regular content type. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_STANDARD_ICON"> A key in the "standard" namespace for getting the icon for the file. + line="185">A key in the "standard" namespace for getting the icon for the file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. + The value for this key should contain a #GIcon. - + c:type="G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP"> A key in the "standard" namespace for checking if a file is a backup file. + line="68">A key in the "standard" namespace for checking if a file is a backup file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN"> A key in the "standard" namespace for checking if a file is hidden. + line="59">A key in the "standard" namespace for checking if a file is hidden. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK"> A key in the "standard" namespace for checking if the file is a symlink. + line="77">A key in the "standard" namespace for checking if the file is a symlink. Typically the actual type is something else, if we followed the symlink to get the type. + On Windows NTFS mountpoints are considered to be symlinks as well. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL"> A key in the "standard" namespace for checking if a file is virtual. + line="90">A key in the "standard" namespace for checking if a file is virtual. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + version="2.46"> A key in the "standard" namespace for checking if a file is + line="99">A key in the "standard" namespace for checking if a file is volatile. This is meant for opaque, non-POSIX-like backends to indicate that the URI is not persistent. Applications should look -at #G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET for the persistent URI. +at %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET for the persistent URI. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_STANDARD_NAME"> A key in the "standard" namespace for getting the name of the file. + line="113">A key in the "standard" namespace for getting the name of the file. + The name is the on-disk filename which may not be in any known encoding, and can thus not be generally displayed as is. It is guaranteed to be set on every file. -Use #G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the + +Use %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the name in a user interface. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + c:type="G_FILE_ATTRIBUTE_STANDARD_SIZE"> A key in the "standard" namespace for getting the file's size (in bytes). + line="234">A key in the "standard" namespace for getting the file's size (in bytes). + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + c:type="G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER"> A key in the "standard" namespace for setting the sort order of a file. + line="278">A key in the "standard" namespace for setting the sort order of a file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32. + An example use would be in file managers, which would use this key to set the order files are displayed. Files with smaller sort order should be sorted first, and files without sort order as if sort order was zero. - + version="2.34"> A key in the "standard" namespace for getting the symbolic icon for the file. + line="196">A key in the "standard" namespace for getting the symbolic icon for the file. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. + The value for this key should contain a #GIcon. - + c:type="G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET"> A key in the "standard" namespace for getting the symlink target, if the file -is a symlink. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + line="258">A key in the "standard" namespace for getting the symlink target, if the file +is a symlink. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. + A key in the "standard" namespace for getting the target URI for the file, in + line="268">A key in the "standard" namespace for getting the target URI for the file, in the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for storing file types. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + The value for this key should contain a #GFileType. - + c:type="G_FILE_ATTRIBUTE_THUMBNAILING_FAILED"> A key in the "thumbnail" namespace for checking if thumbnailing failed. -This attribute is %TRUE if thumbnailing failed. Corresponding -#GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + line="875">A key in the "thumbnail" namespace for checking if thumbnailing failed. + +This attribute is %TRUE if thumbnailing failed. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. + A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. + line="885">A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. + This attribute is %TRUE if the thumbnail is up-to-date with the file it represents, and %FALSE if the file has been modified since the thumbnail was generated. @@ -38255,7 +39052,7 @@ If %G_FILE_ATTRIBUTE_THUMBNAILING_FAILED is %TRUE and this attribute is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_PATH"> A key in the "thumbnail" namespace for getting the path to the thumbnail -image. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + line="866">A key in the "thumbnail" namespace for getting the path to the thumbnail +image. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. + A key in the "time" namespace for getting the time the file was last -accessed. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the -file was last accessed, in seconds since the UNIX epoch. - + line="563">A key in the "time" namespace for getting the time the file was last +accessed. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and +contains the time since the file was last accessed, in seconds since the +UNIX epoch. + c:type="G_FILE_ATTRIBUTE_TIME_ACCESS_USEC"> A key in the "time" namespace for getting the microseconds of the time -the file was last accessed. This should be used in conjunction with -#G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="575">A key in the "time" namespace for getting the microseconds of the time +the file was last accessed. + +This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_ACCESS. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + A key in the "time" namespace for getting the time the file was last -changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, -and contains the time since the file was last changed, in seconds since the -UNIX epoch. + line="587">A key in the "time" namespace for getting the time the file was last +changed. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, +and contains the time since the file was last changed, in seconds since +the UNIX epoch. This corresponds to the traditional UNIX ctime. - + c:type="G_FILE_ATTRIBUTE_TIME_CHANGED_USEC"> A key in the "time" namespace for getting the microseconds of the time -the file was last changed. This should be used in conjunction with -#G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="601">A key in the "time" namespace for getting the microseconds of the time +the file was last changed. + +This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_CHANGED. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + A key in the "time" namespace for getting the time the file was created. + line="613">A key in the "time" namespace for getting the time the file was created. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was created, in seconds since the UNIX epoch. -This may correspond to Linux stx_btime, FreeBSD st_birthtim, NetBSD -st_birthtime or NTFS ctime. - +This may correspond to Linux `stx_btime`, FreeBSD `st_birthtim`, NetBSD +`st_birthtime` or NTFS `ctime`. + c:type="G_FILE_ATTRIBUTE_TIME_CREATED_USEC"> A key in the "time" namespace for getting the microseconds of the time -the file was created. This should be used in conjunction with -#G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="627">A key in the "time" namespace for getting the microseconds of the time +the file was created. + +This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_CREATED. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + A key in the "time" namespace for getting the time the file was last -modified. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the -file was modified, in seconds since the UNIX epoch. - + line="539">A key in the "time" namespace for getting the time the file was last +modified. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and +contains the time since the file was modified, in seconds since the UNIX +epoch. + c:type="G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC"> A key in the "time" namespace for getting the microseconds of the time -the file was last modified. This should be used in conjunction with -#G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="551">A key in the "time" namespace for getting the microseconds of the time +the file was last modified. + +This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_MODIFIED. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + A key in the "trash" namespace. When requested against -items in `trash:///`, will return the date and time when the file -was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss. + line="1043">A key in the "trash" namespace for getting the deletion date and time +of a file inside the `trash:///` folder. + +The format of the returned string is `YYYY-MM-DDThh:mm:ss`. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT"> A key in the "trash" namespace. When requested against -`trash:///` returns the number of (toplevel) items in the trash folder. + line="1021">A key in the "trash" namespace for getting the number of (toplevel) items +that are present in the `trash:///` folder. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + version="2.24"> A key in the "trash" namespace. When requested against -items in `trash:///`, will return the original path to the file before it -was trashed. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + line="1031">A key in the "trash" namespace for getting the original path of a file +inside the `trash:///` folder before it was trashed. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. + A key in the "unix" namespace for getting the number of blocks allocated -for the file. This attribute is only available for UNIX file systems. + line="742">A key in the "unix" namespace for getting the number of blocks allocated +for the file. + +This attribute is only available for UNIX file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + c:type="G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE"> A key in the "unix" namespace for getting the block size for the file -system. This attribute is only available for UNIX file systems. + line="730">A key in the "unix" namespace for getting the block size for the file +system. + +This attribute is only available for UNIX file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_UNIX_DEVICE"> A key in the "unix" namespace for getting the device id of the device the -file is located on (see stat() documentation). This attribute is only -available for UNIX file systems. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="641">A key in the "unix" namespace for getting the device id of the device the +file is located on (see stat() documentation). + +This attribute is only available for UNIX file systems. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + A key in the "unix" namespace for getting the group ID for the file. + line="705">A key in the "unix" namespace for getting the group ID for the file. + This attribute is only available for UNIX file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_UNIX_INODE"> A key in the "unix" namespace for getting the inode of the file. -This attribute is only available for UNIX file systems. Corresponding -#GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + line="653">A key in the "unix" namespace for getting the inode of the file. + +This attribute is only available for UNIX file systems. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. + A key in the "unix" namespace for checking if the file represents a -UNIX mount point. This attribute is %TRUE if the file is a UNIX mount -point. Since 2.58, `/` is considered to be a mount point. + line="754">A key in the "unix" namespace for checking if the file represents a +UNIX mount point. + +This attribute is %TRUE if the file is a UNIX mount point. + +Since 2.58, `/` is considered to be a mount point. + This attribute is only available for UNIX file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_UNIX_MODE"> A key in the "unix" namespace for getting the mode of the file -(e.g. whether the file is a regular file, symlink, etc). See the -documentation for `lstat()`: this attribute is equivalent to the `st_mode` -member of `struct stat`, and includes both the file type and permissions. + line="664">A key in the "unix" namespace for getting the mode of the file +(e.g. whether the file is a regular file, symlink, etc). + +See the documentation for `lstat()`: this attribute is equivalent to +the `st_mode` member of `struct stat`, and includes both the file type +and permissions. + This attribute is only available for UNIX file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_UNIX_NLINK"> A key in the "unix" namespace for getting the number of hard links -for a file. See lstat() documentation. This attribute is only available -for UNIX file systems. Corresponding #GFileAttributeType is -%G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="680">A key in the "unix" namespace for getting the number of hard links +for a file. + +See the documentation for `lstat()`. + +This attribute is only available for UNIX file systems. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + A key in the "unix" namespace for getting the device ID for the file -(if it is a special file). See lstat() documentation. This attribute -is only available for UNIX file systems. Corresponding #GFileAttributeType -is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + line="716">A key in the "unix" namespace for getting the device ID for the file +(if it is a special file). + +See the documentation for `lstat()`. + +This attribute is only available for UNIX file systems. + +Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. + c:type="G_FILE_ATTRIBUTE_UNIX_UID"> A key in the "unix" namespace for getting the user ID for the file. + line="694">A key in the "unix" namespace for getting the user ID for the file. + This attribute is only available for UNIX file systems. + Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + glib:type-struct="FileIface"> #GFile is a high level abstraction for manipulating files on a + line="6368">#GFile is a high level abstraction for manipulating files on a virtual file system. #GFiles are lightweight, immutable objects that do no I/O upon creation. It is necessary to understand that #GFile objects do not represent files, merely an identifier for a @@ -38891,7 +39738,7 @@ for HTTP Etag headers, which are a very similar concept. introspectable="0"> Constructs a #GFile from a series of elements using the correct + line="24395">Constructs a #GFile from a series of elements using the correct separator for filenames. Using this function is equivalent to calling g_build_filename(), @@ -38900,20 +39747,20 @@ followed by g_file_new_for_path() on the result. a new #GFile + line="24406">a new #GFile the first element in the path + line="24397">the first element in the path remaining elements in path, terminated by %NULL + line="24398">remaining elements in path, terminated by %NULL @@ -38922,7 +39769,7 @@ followed by g_file_new_for_path() on the result. c:identifier="g_file_new_for_commandline_arg"> Creates a #GFile with the given argument from the command line. + line="24411">Creates a #GFile with the given argument from the command line. The value of @arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not @@ -38940,7 +39787,7 @@ for you there. It is also always possible to use this function with a new #GFile. + line="24430">a new #GFile. Free the returned object with g_object_unref(). @@ -38948,7 +39795,7 @@ for you there. It is also always possible to use this function with a command line string + line="24413">a command line string @@ -38958,7 +39805,7 @@ for you there. It is also always possible to use this function with version="2.36"> Creates a #GFile with the given argument from the command line. + line="24435">Creates a #GFile with the given argument from the command line. This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an @@ -38973,20 +39820,20 @@ See also g_application_command_line_create_file_for_arg(). a new #GFile + line="24452">a new #GFile a command line string + line="24437">a command line string the current working directory of the commandline + line="24438">the current working directory of the commandline @@ -38994,14 +39841,14 @@ See also g_application_command_line_create_file_for_arg(). Constructs a #GFile for a given path. This operation never + line="24457">Constructs a #GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if @path is malformed. a new #GFile for the given @path. + line="24466">a new #GFile for the given @path. Free the returned object with g_object_unref(). @@ -39009,7 +39856,7 @@ operation if @path is malformed. a string containing a relative or absolute path. + line="24459">a string containing a relative or absolute path. The string must be encoded in the glib filename encoding. @@ -39018,7 +39865,7 @@ operation if @path is malformed. Constructs a #GFile for a given URI. This operation never + line="24471">Constructs a #GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if @uri is malformed or if the uri type is not supported. @@ -39026,7 +39873,7 @@ not supported. a new #GFile for the given @uri. + line="24480">a new #GFile for the given @uri. Free the returned object with g_object_unref(). @@ -39034,7 +39881,7 @@ not supported. a UTF-8 string containing a URI + line="24473">a UTF-8 string containing a URI @@ -39045,7 +39892,7 @@ not supported. throws="1"> Opens a file in the preferred directory for temporary files (as + line="24485">Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it. @@ -39059,7 +39906,7 @@ a temporary file could not be created. a new #GFile. + line="24503">a new #GFile. Free the returned object with g_object_unref(). @@ -39070,7 +39917,7 @@ a temporary file could not be created. allow-none="1"> Template for the file + line="24487">Template for the file name, as in g_file_open_tmp(), or %NULL for a default template @@ -39080,7 +39927,7 @@ a temporary file could not be created. transfer-ownership="full"> on return, a #GFileIOStream for the created file + line="24489">on return, a #GFileIOStream for the created file @@ -39088,7 +39935,7 @@ a temporary file could not be created. Constructs a #GFile with the given @parse_name (i.e. something + line="24648">Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the @parse_name cannot be parsed. @@ -39096,14 +39943,14 @@ the @parse_name cannot be parsed. a new #GFile. + line="24657">a new #GFile. a file name or path to be parsed + line="24650">a file name or path to be parsed @@ -39111,7 +39958,7 @@ the @parse_name cannot be parsed. Gets an output stream for appending data to the file. + line="21408">Gets an output stream for appending data to the file. If the file doesn't already exist it is created. By default files created are generally readable by everyone, @@ -39132,7 +39979,7 @@ possible too, and depend on what kind of filesystem the file is on. a #GFileOutputStream, or %NULL on error. + line="21434">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -39140,13 +39987,13 @@ possible too, and depend on what kind of filesystem the file is on. input #GFile + line="21410">input #GFile a set of #GFileCreateFlags + line="21411">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21412">optional #GCancellable object, %NULL to ignore @@ -39164,7 +40011,7 @@ possible too, and depend on what kind of filesystem the file is on. Asynchronously opens @file for appending. + line="21439">Asynchronously opens @file for appending. For more details, see g_file_append_to() which is the synchronous version of this call. @@ -39180,19 +40027,19 @@ of the operation. input #GFile + line="21441">input #GFile a set of #GFileCreateFlags + line="21442">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21443">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21444">optional #GCancellable object, %NULL to ignore @@ -39213,7 +40060,7 @@ of the operation. closure="4"> a #GAsyncReadyCallback to call + line="21446">a #GAsyncReadyCallback to call when the request is satisfied @@ -39224,7 +40071,7 @@ of the operation. closure="4"> the data to pass to callback function + line="21448">the data to pass to callback function @@ -39234,13 +40081,13 @@ of the operation. throws="1"> Finishes an asynchronous file append operation started with + line="21461">Finishes an asynchronous file append operation started with g_file_append_to_async(). a valid #GFileOutputStream + line="21470">a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -39249,13 +40096,13 @@ g_file_append_to_async(). input #GFile + line="21463">input #GFile #GAsyncResult + line="21464">#GAsyncResult @@ -39263,7 +40110,7 @@ g_file_append_to_async(). Copies the file @source to the location specified by @destination. + line="21715">Copies the file @source to the location specified by @destination. Can not handle recursive copies of directories. If the flag #G_FILE_COPY_OVERWRITE is specified an already @@ -39307,26 +40154,26 @@ file), see g_file_dup(). %TRUE on success, %FALSE otherwise. + line="21768">%TRUE on success, %FALSE otherwise. input #GFile + line="21717">input #GFile destination #GFile + line="21718">destination #GFile set of #GFileCopyFlags + line="21719">set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="21720">optional #GCancellable object, %NULL to ignore @@ -39347,7 +40194,7 @@ file), see g_file_dup(). closure="4"> function to callback with + line="21722">function to callback with progress information, or %NULL if progress information is not needed @@ -39357,7 +40204,7 @@ file), see g_file_dup(). allow-none="1"> user data to pass to @progress_callback + line="21724">user data to pass to @progress_callback @@ -39365,7 +40212,7 @@ file), see g_file_dup(). Copies the file @source to the location specified by @destination + line="21772">Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -39383,25 +40230,25 @@ g_file_copy_finish() to get the result of the operation. input #GFile + line="21774">input #GFile destination #GFile + line="21775">destination #GFile set of #GFileCopyFlags + line="21776">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + line="21777">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21778">optional #GCancellable object, %NULL to ignore @@ -39422,7 +40269,7 @@ g_file_copy_finish() to get the result of the operation. closure="5"> function to callback with progress + line="21780">function to callback with progress information, or %NULL if progress information is not needed @@ -39433,7 +40280,7 @@ g_file_copy_finish() to get the result of the operation. closure="4"> user data to pass to @progress_callback + line="21782">user data to pass to @progress_callback closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + line="21783">a #GAsyncReadyCallback to call when the request is satisfied closure="6"> the data to pass to callback function + line="21784">the data to pass to callback function @@ -39462,25 +40309,25 @@ g_file_copy_finish() to get the result of the operation. Finishes copying the file started with g_file_copy_async(). + line="21822">Finishes copying the file started with g_file_copy_async(). a %TRUE on success, %FALSE on error. + line="21830">a %TRUE on success, %FALSE on error. input #GFile + line="21824">input #GFile a #GAsyncResult + line="21825">a #GAsyncResult @@ -39488,7 +40335,7 @@ g_file_copy_finish() to get the result of the operation. Creates a new file and returns an output stream for writing to it. + line="21834">Creates a new file and returns an output stream for writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -39511,7 +40358,7 @@ of filesystem the file is on. a #GFileOutputStream for the newly created + line="21862">a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -39520,13 +40367,13 @@ of filesystem the file is on. input #GFile + line="21836">input #GFile a set of #GFileCreateFlags + line="21837">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21838">optional #GCancellable object, %NULL to ignore @@ -39544,7 +40391,7 @@ of filesystem the file is on. Asynchronously creates a new file and returns an output stream + line="21868">Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. For more details, see g_file_create() which is @@ -39561,19 +40408,19 @@ of the operation. input #GFile + line="21870">input #GFile a set of #GFileCreateFlags + line="21871">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21872">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21873">optional #GCancellable object, %NULL to ignore @@ -39594,7 +40441,7 @@ of the operation. closure="4"> a #GAsyncReadyCallback to call + line="21875">a #GAsyncReadyCallback to call when the request is satisfied @@ -39605,7 +40452,7 @@ of the operation. closure="4"> the data to pass to callback function + line="21877">the data to pass to callback function @@ -39613,13 +40460,13 @@ of the operation. Finishes an asynchronous file create operation started with + line="21891">Finishes an asynchronous file create operation started with g_file_create_async(). a #GFileOutputStream or %NULL on error. + line="21900">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -39627,13 +40474,13 @@ g_file_create_async(). input #GFile + line="21893">input #GFile a #GAsyncResult + line="21894">a #GAsyncResult @@ -39644,7 +40491,7 @@ g_file_create_async(). throws="1"> Creates a new file and returns a stream for reading and + line="21905">Creates a new file and returns a stream for reading and writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -39671,7 +40518,7 @@ streaming, rather than just opening for reading or writing. a #GFileIOStream for the newly created + line="21937">a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -39680,13 +40527,13 @@ streaming, rather than just opening for reading or writing. a #GFile + line="21907">a #GFile a set of #GFileCreateFlags + line="21908">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21909">optional #GCancellable object, %NULL to ignore @@ -39706,7 +40553,7 @@ streaming, rather than just opening for reading or writing. version="2.22"> Asynchronously creates a new file and returns a stream + line="21944">Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist. For more details, see g_file_create_readwrite() which is @@ -39723,19 +40570,19 @@ the result of the operation. input #GFile + line="21946">input #GFile a set of #GFileCreateFlags + line="21947">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21948">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21949">optional #GCancellable object, %NULL to ignore @@ -39756,7 +40603,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="21951">a #GAsyncReadyCallback to call when the request is satisfied @@ -39767,7 +40614,7 @@ the result of the operation. closure="4"> the data to pass to callback function + line="21953">the data to pass to callback function @@ -39778,13 +40625,13 @@ the result of the operation. throws="1"> Finishes an asynchronous file create operation started with + line="21969">Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). a #GFileIOStream or %NULL on error. + line="21978">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -39792,13 +40639,13 @@ g_file_create_readwrite_async(). input #GFile + line="21971">input #GFile a #GAsyncResult + line="21972">a #GAsyncResult @@ -39806,7 +40653,7 @@ g_file_create_readwrite_async(). Deletes a file. If the @file is a directory, it will only be + line="21984">Deletes a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). If @file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows @@ -39831,14 +40678,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the file was deleted. %FALSE otherwise. + line="22013">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + line="21986">input #GFile allow-none="1"> optional #GCancellable object, + line="21987">optional #GCancellable object, %NULL to ignore @@ -39858,7 +40705,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.34"> Asynchronously delete a file. If the @file is a directory, it will + line="22017">Asynchronously delete a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). @@ -39869,13 +40716,13 @@ g_unlink(). input #GFile + line="22019">input #GFile the [I/O priority][io-priority] of the request + line="22020">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22021">optional #GCancellable object, %NULL to ignore @@ -39896,7 +40743,7 @@ g_unlink(). closure="3"> a #GAsyncReadyCallback to call + line="22023">a #GAsyncReadyCallback to call when the request is satisfied @@ -39907,7 +40754,7 @@ g_unlink(). closure="3"> the data to pass to callback function + line="22025">the data to pass to callback function @@ -39918,25 +40765,25 @@ g_unlink(). throws="1"> Finishes deleting a file started with g_file_delete_async(). + line="22035">Finishes deleting a file started with g_file_delete_async(). %TRUE if the file was deleted. %FALSE otherwise. + line="22043">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + line="22037">input #GFile a #GAsyncResult + line="22038">a #GAsyncResult @@ -39944,7 +40791,7 @@ g_unlink(). Duplicates a #GFile handle. This operation does not duplicate + line="22059">Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file. @@ -39958,7 +40805,7 @@ This call does no blocking I/O. a new #GFile that is a duplicate + line="22074">a new #GFile that is a duplicate of the given #GFile. @@ -39966,7 +40813,7 @@ This call does no blocking I/O. input #GFile + line="22061">input #GFile @@ -39977,7 +40824,7 @@ This call does no blocking I/O. deprecated-version="2.22"> Starts an asynchronous eject on a mountable. + line="22079">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_finish(). @@ -39994,13 +40841,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="22081">input #GFile flags affecting the operation + line="22082">flags affecting the operation allow-none="1"> optional #GCancellable object, + line="22083">optional #GCancellable object, %NULL to ignore @@ -40021,7 +40868,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="22085">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -40032,7 +40879,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> the data to pass to callback function + line="22087">the data to pass to callback function @@ -40044,7 +40891,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous eject operation started by + line="22102">Finishes an asynchronous eject operation started by g_file_eject_mountable(). Use g_file_eject_mountable_with_operation_finish() instead. @@ -40052,7 +40899,7 @@ g_file_eject_mountable(). %TRUE if the @file was ejected successfully. + line="22111">%TRUE if the @file was ejected successfully. %FALSE otherwise. @@ -40060,13 +40907,13 @@ g_file_eject_mountable(). input #GFile + line="22104">input #GFile a #GAsyncResult + line="22105">a #GAsyncResult @@ -40076,7 +40923,7 @@ g_file_eject_mountable(). version="2.22"> Starts an asynchronous eject on a mountable. + line="22118">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish(). @@ -40092,13 +40939,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="22120">input #GFile flags affecting the operation + line="22121">flags affecting the operation allow-none="1"> a #GMountOperation, + line="22122">a #GMountOperation, or %NULL to avoid user interaction @@ -40117,7 +40964,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> optional #GCancellable object, + line="22124">optional #GCancellable object, %NULL to ignore @@ -40129,7 +40976,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="4"> a #GAsyncReadyCallback to call + line="22126">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -40140,7 +40987,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="4"> the data to pass to callback function + line="22128">the data to pass to callback function @@ -40151,13 +40998,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous eject operation started by + line="22143">Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). %TRUE if the @file was ejected successfully. + line="22152">%TRUE if the @file was ejected successfully. %FALSE otherwise. @@ -40165,13 +41012,13 @@ g_file_eject_mountable_with_operation(). input #GFile + line="22145">input #GFile a #GAsyncResult + line="22146">a #GAsyncResult @@ -40181,7 +41028,7 @@ g_file_eject_mountable_with_operation(). throws="1"> Gets the requested information about the files in a directory. + line="22158">Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -40208,7 +41055,7 @@ error will be returned. Other errors are possible too. A #GFileEnumerator if successful, + line="22191">A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). @@ -40216,19 +41063,19 @@ error will be returned. Other errors are possible too. input #GFile + line="22160">input #GFile an attribute query string + line="22161">an attribute query string a set of #GFileQueryInfoFlags + line="22162">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="22163">optional #GCancellable object, %NULL to ignore @@ -40247,7 +41094,7 @@ error will be returned. Other errors are possible too. invoker="enumerate_children_async"> Asynchronously gets the requested information about the files + line="22196">Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -40265,25 +41112,25 @@ the operation. input #GFile + line="22198">input #GFile an attribute query string + line="22199">an attribute query string a set of #GFileQueryInfoFlags + line="22200">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="22201">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22202">optional #GCancellable object, %NULL to ignore @@ -40304,7 +41151,7 @@ the operation. closure="5"> a #GAsyncReadyCallback to call when the + line="22204">a #GAsyncReadyCallback to call when the request is satisfied @@ -40315,7 +41162,7 @@ the operation. closure="5"> the data to pass to callback function + line="22206">the data to pass to callback function @@ -40325,13 +41172,13 @@ the operation. throws="1"> Finishes an async enumerate children operation. + line="22221">Finishes an async enumerate children operation. See g_file_enumerate_children_async(). a #GFileEnumerator or %NULL + line="22230">a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). @@ -40340,13 +41187,13 @@ See g_file_enumerate_children_async(). input #GFile + line="22223">input #GFile a #GAsyncResult + line="22224">a #GAsyncResult @@ -40354,7 +41201,7 @@ See g_file_enumerate_children_async(). Checks if the two given #GFiles refer to the same file. + line="22475">Checks if the two given #GFiles refer to the same file. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename @@ -40365,20 +41212,20 @@ This call does no blocking I/O. %TRUE if @file1 and @file2 are equal. + line="22488">%TRUE if @file1 and @file2 are equal. the first #GFile + line="22477">the first #GFile the second #GFile + line="22478">the second #GFile @@ -40388,7 +41235,7 @@ This call does no blocking I/O. throws="1"> Gets a #GMount for the #GFile. + line="22492">Gets a #GMount for the #GFile. #GMount is returned only for user interesting locations, see #GVolumeMonitor. If the #GFileIface for @file does not have a #mount, @@ -40401,7 +41248,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GMount where the @file is located + line="22509">a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). @@ -40410,7 +41257,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="22494">input #GFile allow-none="1"> optional #GCancellable object, + line="22495">optional #GCancellable object, %NULL to ignore @@ -40429,7 +41276,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. invoker="find_enclosing_mount_async"> Asynchronously gets the mount for the file. + line="22515">Asynchronously gets the mount for the file. For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call. @@ -40445,13 +41292,13 @@ get the result of the operation. a #GFile + line="22517">a #GFile the [I/O priority][io-priority] of the request + line="22518">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22519">optional #GCancellable object, %NULL to ignore @@ -40472,7 +41319,7 @@ get the result of the operation. closure="3"> a #GAsyncReadyCallback to call + line="22521">a #GAsyncReadyCallback to call when the request is satisfied @@ -40483,7 +41330,7 @@ get the result of the operation. closure="3"> the data to pass to callback function + line="22523">the data to pass to callback function @@ -40493,13 +41340,13 @@ get the result of the operation. throws="1"> Finishes an asynchronous find mount request. + line="22536">Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async(). #GMount for given @file or %NULL on error. + line="22545">#GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -40507,24 +41354,47 @@ See g_file_find_enclosing_mount_async(). a #GFile + line="22538">a #GFile a #GAsyncResult + line="22539">a #GAsyncResult - + + Gets the base name (the last component of the path) for a given #GFile. + +If called for the top level of a system (such as the filesystem root +or a uri like sftp://host/) it will return a single directory separator +(and on Windows, possibly a drive letter). + +The base name is a byte string (not UTF-8). It has no defined encoding +or rules other than it may not contain zero bytes. If you want to use +filenames in a user interface you should use the display name that you +can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME +attribute with g_file_query_info(). + +This call does no blocking I/O. - - + + string containing the #GFile's + base name, or %NULL if given #GFile is invalid. The returned string + should be freed with g_free() when no longer needed. + + input #GFile @@ -40534,7 +41404,7 @@ See g_file_find_enclosing_mount_async(). throws="1"> Gets the child of @file for a given @display_name (i.e. a UTF-8 + line="22592">Gets the child of @file for a given @display_name (i.e. a UTF-8 version of the name). If this function fails, it returns %NULL and @error will be set. This is very useful when constructing a #GFile for a new file and the user entered the filename in the @@ -40546,7 +41416,7 @@ This call does no blocking I/O. a #GFile to the specified child, or + line="22607">a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). @@ -40555,13 +41425,13 @@ This call does no blocking I/O. input #GFile + line="22594">input #GFile string to a possible child + line="22595">string to a possible child @@ -40569,7 +41439,7 @@ This call does no blocking I/O. Gets the parent directory for the @file. + line="22613">Gets the parent directory for the @file. If the @file represents the root directory of the file system, then %NULL will be returned. @@ -40578,7 +41448,7 @@ This call does no blocking I/O. a #GFile structure to the + line="22623">a #GFile structure to the parent of the given #GFile or %NULL if there is no parent. Free the returned object with g_object_unref(). @@ -40587,7 +41457,7 @@ This call does no blocking I/O. input #GFile + line="22615">input #GFile @@ -40595,7 +41465,7 @@ This call does no blocking I/O. Gets the parse name of the @file. + line="22629">Gets the parse name of the @file. A parse name is a UTF-8 string that describes the file such that one can get the #GFile back using g_file_parse_name(). @@ -40613,7 +41483,7 @@ This call does no blocking I/O. a string containing the #GFile's parse name. + line="22648">a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. @@ -40622,32 +41492,63 @@ This call does no blocking I/O. input #GFile + line="22631">input #GFile - + + Gets the local pathname for #GFile, if one exists. If non-%NULL, this is +guaranteed to be an absolute, canonical path. It might contain symlinks. + +This call does no blocking I/O. - - + + string containing the #GFile's path, + or %NULL if no such path exists. The returned string should be freed + with g_free() when no longer needed. + + input #GFile - + + Gets the path for @descendant relative to @parent. + +This call does no blocking I/O. - - + + string with the relative path from + @descendant to @parent, or %NULL if @descendant doesn't have @parent as + prefix. The returned string should be freed with g_free() when + no longer needed. + + input #GFile + input #GFile @@ -40655,14 +41556,15 @@ This call does no blocking I/O. Gets the URI for the @file. + line="22685">Gets the URI for the @file. This call does no blocking I/O. a string containing the #GFile's URI. + line="22693">a string containing the #GFile's URI. If the #GFile was constructed + with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed. @@ -40671,7 +41573,7 @@ This call does no blocking I/O. input #GFile + line="22687">input #GFile @@ -40679,28 +41581,31 @@ This call does no blocking I/O. Gets the URI scheme for a #GFile. + line="22700">Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include "file", "http", "ftp", etc. +The scheme can be different from the one used to construct the #GFile, +in that it might be replaced with one that is logically equivalent to the #GFile. + This call does no blocking I/O. - + a string containing the URI scheme for the given - #GFile. The returned string should be freed with g_free() - when no longer needed. + line="22716">a string containing the URI scheme for the given + #GFile or %NULL if the #GFile was constructed with an invalid URI. The + returned string should be freed with g_free() when no longer needed. input #GFile + line="22702">input #GFile @@ -40708,14 +41613,14 @@ This call does no blocking I/O. Checks to see if a #GFile has a given URI scheme. + line="22764">Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O. %TRUE if #GFile's backend supports the + line="22773">%TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. @@ -40724,13 +41629,13 @@ This call does no blocking I/O. input #GFile + line="22766">input #GFile a string containing a URI scheme + line="22767">a string containing a URI scheme @@ -40738,14 +41643,14 @@ This call does no blocking I/O. Creates a hash value for a #GFile. + line="22779">Creates a hash value for a #GFile. This call does no blocking I/O. 0 if @file is not a valid #GFile, otherwise an + line="22787">0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -40755,7 +41660,7 @@ This call does no blocking I/O. #gconstpointer to a #GFile + line="22781">#gconstpointer to a #GFile @@ -40763,7 +41668,7 @@ This call does no blocking I/O. Checks to see if a file is native to the platform. + line="23750">Checks to see if a file is native to the platform. A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, @@ -40778,14 +41683,14 @@ This call does no blocking I/O. %TRUE if @file is native + line="23766">%TRUE if @file is native input #GFile + line="23752">input #GFile @@ -40795,7 +41700,7 @@ This call does no blocking I/O. throws="1"> Creates a directory. Note that this will only create a child directory + line="23958">Creates a directory. Note that this will only create a child directory of the immediate parent directory of the path or URI given by the #GFile. To recursively create directories, see g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting @@ -40813,14 +41718,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on successful creation, %FALSE otherwise. + line="23980">%TRUE on successful creation, %FALSE otherwise. input #GFile + line="23960">input #GFile allow-none="1"> optional #GCancellable object, + line="23961">optional #GCancellable object, %NULL to ignore @@ -40840,7 +41745,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38"> Asynchronously creates a directory. + line="23984">Asynchronously creates a directory. @@ -40849,13 +41754,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="23986">input #GFile the [I/O priority][io-priority] of the request + line="23987">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="23988">optional #GCancellable object, %NULL to ignore @@ -40876,7 +41781,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="23990">a #GAsyncReadyCallback to call when the request is satisfied @@ -40887,7 +41792,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> the data to pass to callback function + line="23992">the data to pass to callback function @@ -40898,26 +41803,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous directory creation, started with + line="24000">Finishes an asynchronous directory creation, started with g_file_make_directory_async(). %TRUE on successful directory creation, %FALSE otherwise. + line="24009">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + line="24002">input #GFile a #GAsyncResult + line="24003">a #GAsyncResult @@ -40927,7 +41832,7 @@ g_file_make_directory_async(). throws="1"> Creates a symbolic link named @file which contains the string + line="24041">Creates a symbolic link named @file which contains the string @symlink_value. If @cancellable is not %NULL, then the operation can be cancelled by @@ -40937,20 +41842,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on the creation of a new symlink, %FALSE otherwise. + line="24057">%TRUE on the creation of a new symlink, %FALSE otherwise. a #GFile with the name of the symlink to create + line="24043">a #GFile with the name of the symlink to create a string with the path for the target + line="24044">a string with the path for the target of the new symlink @@ -40960,7 +41865,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> optional #GCancellable object, + line="24046">optional #GCancellable object, %NULL to ignore @@ -40973,7 +41878,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Recursively measures the disk usage of @file. + line="24061">Recursively measures the disk usage of @file. This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered @@ -40995,7 +41900,7 @@ callback will be invoked. %TRUE if successful, with the out parameters set. + line="24092">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. @@ -41003,13 +41908,13 @@ callback will be invoked. a #GFile + line="24063">a #GFile #GFileMeasureFlags + line="24064">#GFileMeasureFlags allow-none="1"> optional #GCancellable + line="24065">optional #GCancellable closure="3"> a #GFileMeasureProgressCallback + line="24066">a #GFileMeasureProgressCallback @@ -41038,7 +41943,7 @@ callback will be invoked. allow-none="1"> user_data for @progress_callback + line="24067">user_data for @progress_callback allow-none="1"> the number of bytes of disk space used + line="24068">the number of bytes of disk space used allow-none="1"> the number of directories encountered + line="24069">the number of directories encountered allow-none="1"> the number of non-directories encountered + line="24070">the number of non-directories encountered @@ -41082,7 +41987,7 @@ callback will be invoked. introspectable="0"> Recursively measures the disk usage of @file. + line="24098">Recursively measures the disk usage of @file. This is the asynchronous version of g_file_measure_disk_usage(). See there for more information. @@ -41094,19 +41999,19 @@ there for more information. a #GFile + line="24100">a #GFile #GFileMeasureFlags + line="24101">#GFileMeasureFlags the [I/O priority][io-priority] of the request + line="24102">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable + line="24103">optional #GCancellable closure="4"> a #GFileMeasureProgressCallback + line="24104">a #GFileMeasureProgressCallback @@ -41135,7 +42040,7 @@ there for more information. allow-none="1"> user_data for @progress_callback + line="24105">user_data for @progress_callback closure="6"> a #GAsyncReadyCallback to call when complete + line="24106">a #GAsyncReadyCallback to call when complete closure="6"> the data to pass to callback function + line="24107">the data to pass to callback function @@ -41167,14 +42072,14 @@ there for more information. throws="1"> Collects the results from an earlier call to + line="24118">Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information. %TRUE if successful, with the out parameters set. + line="24131">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. @@ -41182,13 +42087,13 @@ more information. a #GFile + line="24120">a #GFile the #GAsyncResult passed to your #GAsyncReadyCallback + line="24121">the #GAsyncResult passed to your #GAsyncReadyCallback allow-none="1"> the number of bytes of disk space used + line="24122">the number of bytes of disk space used allow-none="1"> the number of directories encountered + line="24123">the number of directories encountered allow-none="1"> the number of non-directories encountered + line="24124">the number of non-directories encountered @@ -41231,7 +42136,7 @@ more information. throws="1"> Obtains a directory monitor for the given file. + line="24169">Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported. If @cancellable is not %NULL, then the operation can be cancelled by @@ -41247,7 +42152,7 @@ you must register individual watches with g_file_monitor(). a #GFileMonitor for the given @file, + line="24190">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -41256,13 +42161,13 @@ you must register individual watches with g_file_monitor(). input #GFile + line="24171">input #GFile a set of #GFileMonitorFlags + line="24172">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24173">optional #GCancellable object, %NULL to ignore @@ -41280,7 +42185,7 @@ you must register individual watches with g_file_monitor(). Obtains a file monitor for the given file. If no file notification + line="24213">Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If @cancellable is not %NULL, then the operation can be cancelled by @@ -41298,7 +42203,7 @@ backend and/or filesystem type. a #GFileMonitor for the given @file, + line="24236">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -41307,13 +42212,13 @@ backend and/or filesystem type. input #GFile + line="24215">input #GFile a set of #GFileMonitorFlags + line="24216">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24217">optional #GCancellable object, %NULL to ignore @@ -41332,7 +42237,7 @@ backend and/or filesystem type. invoker="mount_enclosing_volume"> Starts a @mount_operation, mounting the volume that contains + line="24263">Starts a @mount_operation, mounting the volume that contains the file @location. When this operation has completed, @callback will be called with @@ -41350,13 +42255,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24265">input #GFile flags affecting the operation + line="24266">flags affecting the operation allow-none="1"> a #GMountOperation + line="24267">a #GMountOperation or %NULL to avoid user interaction @@ -41375,7 +42280,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> optional #GCancellable object, + line="24269">optional #GCancellable object, %NULL to ignore @@ -41387,7 +42292,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="4"> a #GAsyncReadyCallback to call + line="24271">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -41398,7 +42303,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="4"> the data to pass to callback function + line="24273">the data to pass to callback function @@ -41408,12 +42313,12 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes a mount operation started by g_file_mount_enclosing_volume(). + line="24288">Finishes a mount operation started by g_file_mount_enclosing_volume(). %TRUE if successful. If an error has occurred, + line="24296">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -41422,13 +42327,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24290">input #GFile a #GAsyncResult + line="24291">a #GAsyncResult @@ -41436,7 +42341,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Mounts a file of type G_FILE_TYPE_MOUNTABLE. + line="24302">Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using @mount_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -41455,13 +42360,13 @@ the result of the operation. input #GFile + line="24304">input #GFile flags affecting the operation + line="24305">flags affecting the operation allow-none="1"> a #GMountOperation, + line="24306">a #GMountOperation, or %NULL to avoid user interaction @@ -41480,7 +42385,7 @@ the result of the operation. allow-none="1"> optional #GCancellable object, + line="24308">optional #GCancellable object, %NULL to ignore @@ -41492,7 +42397,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="24310">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -41503,7 +42408,7 @@ the result of the operation. closure="4"> the data to pass to callback function + line="24312">the data to pass to callback function @@ -41513,7 +42418,7 @@ the result of the operation. throws="1"> Finishes a mount operation. See g_file_mount_mountable() for details. + line="24328">Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable(). @@ -41521,7 +42426,7 @@ with g_file_mount_mountable(). a #GFile or %NULL on error. + line="24339">a #GFile or %NULL on error. Free the returned object with g_object_unref(). @@ -41529,13 +42434,13 @@ with g_file_mount_mountable(). input #GFile + line="24330">input #GFile a #GAsyncResult + line="24331">a #GAsyncResult @@ -41543,7 +42448,7 @@ with g_file_mount_mountable(). Tries to move the file or directory @source to the location specified + line="24344">Tries to move the file or directory @source to the location specified by @destination. If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves @@ -41580,26 +42485,26 @@ move operation isn't available). %TRUE on successful move, %FALSE otherwise. + line="24391">%TRUE on successful move, %FALSE otherwise. #GFile pointing to the source location + line="24346">#GFile pointing to the source location #GFile pointing to the destination location + line="24347">#GFile pointing to the destination location set of #GFileCopyFlags + line="24348">set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="24349">optional #GCancellable object, %NULL to ignore @@ -41620,7 +42525,7 @@ move operation isn't available). closure="4"> #GFileProgressCallback + line="24351">#GFileProgressCallback function for updates @@ -41630,7 +42535,7 @@ move operation isn't available). allow-none="1"> gpointer to user data for + line="24353">gpointer to user data for the callback function @@ -41642,7 +42547,7 @@ move operation isn't available). throws="1"> Opens an existing file for reading and writing. The result is + line="24509">Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file. @@ -41662,7 +42567,7 @@ for reading or writing. #GFileIOStream or %NULL on error. + line="24532">#GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -41670,7 +42575,7 @@ for reading or writing. #GFile to open + line="24511">#GFile to open allow-none="1"> a #GCancellable + line="24512">a #GCancellable @@ -41689,7 +42594,7 @@ for reading or writing. version="2.22"> Asynchronously opens @file for reading and writing. + line="24538">Asynchronously opens @file for reading and writing. For more details, see g_file_open_readwrite() which is the synchronous version of this call. @@ -41705,13 +42610,13 @@ the result of the operation. input #GFile + line="24540">input #GFile the [I/O priority][io-priority] of the request + line="24541">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24542">optional #GCancellable object, %NULL to ignore @@ -41732,7 +42637,7 @@ the result of the operation. closure="3"> a #GAsyncReadyCallback to call + line="24544">a #GAsyncReadyCallback to call when the request is satisfied @@ -41743,7 +42648,7 @@ the result of the operation. closure="3"> the data to pass to callback function + line="24546">the data to pass to callback function @@ -41754,13 +42659,13 @@ the result of the operation. throws="1"> Finishes an asynchronous file read operation started with + line="24561">Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). a #GFileIOStream or %NULL on error. + line="24570">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -41768,13 +42673,13 @@ g_file_open_readwrite_async(). input #GFile + line="24563">input #GFile a #GAsyncResult + line="24564">a #GAsyncResult @@ -41784,7 +42689,7 @@ g_file_open_readwrite_async(). version="2.22"> Polls a file of type #G_FILE_TYPE_MOUNTABLE. + line="24679">Polls a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -41801,7 +42706,7 @@ the result of the operation. input #GFile + line="24681">input #GFile allow-none="1"> optional #GCancellable object, %NULL to ignore + line="24682">optional #GCancellable object, %NULL to ignore closure="2"> a #GAsyncReadyCallback to call + line="24683">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -41832,7 +42737,7 @@ the result of the operation. closure="2"> the data to pass to callback function + line="24685">the data to pass to callback function @@ -41843,7 +42748,7 @@ the result of the operation. throws="1"> Finishes a poll operation. See g_file_poll_mountable() for details. + line="24701">Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable(). @@ -41851,7 +42756,7 @@ with g_file_poll_mountable(). %TRUE if the operation finished successfully. %FALSE + line="24712">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -41859,13 +42764,13 @@ otherwise. input #GFile + line="24703">input #GFile a #GAsyncResult + line="24704">a #GAsyncResult @@ -41873,7 +42778,7 @@ otherwise. Checks whether @file has the prefix specified by @prefix. + line="22739">Checks whether @file has the prefix specified by @prefix. In other words, if the names of initial elements of @file's pathname match @prefix. Only full pathname elements are matched, @@ -41891,7 +42796,7 @@ of @prefix. %TRUE if the @file's parent, grandparent, etc is @prefix, + line="22759">%TRUE if the @file's parent, grandparent, etc is @prefix, %FALSE otherwise. @@ -41899,13 +42804,13 @@ of @prefix. input #GFile + line="22742">input #GFile input #GFile + line="22741">input #GFile @@ -41915,7 +42820,7 @@ of @prefix. throws="1"> Similar to g_file_query_info(), but obtains information + line="24819">Similar to g_file_query_info(), but obtains information about the filesystem the @file is on, rather than the file itself. For instance the amount of space available and the type of the filesystem. @@ -41944,7 +42849,7 @@ kind of filesystem the file is on. a #GFileInfo or %NULL if there was an error. + line="24853">a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -41952,13 +42857,13 @@ kind of filesystem the file is on. input #GFile + line="24821">input #GFile an attribute query string + line="24822">an attribute query string allow-none="1"> optional #GCancellable object, + line="24823">optional #GCancellable object, %NULL to ignore @@ -41977,7 +42882,7 @@ kind of filesystem the file is on. invoker="query_filesystem_info_async"> Asynchronously gets the requested information about the filesystem + line="24858">Asynchronously gets the requested information about the filesystem that the specified @file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -41996,19 +42901,19 @@ operation. input #GFile + line="24860">input #GFile an attribute query string + line="24861">an attribute query string the [I/O priority][io-priority] of the request + line="24862">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24863">optional #GCancellable object, %NULL to ignore @@ -42029,7 +42934,7 @@ operation. closure="4"> a #GAsyncReadyCallback to call + line="24865">a #GAsyncReadyCallback to call when the request is satisfied @@ -42040,7 +42945,7 @@ operation. closure="4"> the data to pass to callback function + line="24867">the data to pass to callback function @@ -42050,13 +42955,13 @@ operation. throws="1"> Finishes an asynchronous filesystem info query. + line="24883">Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async(). #GFileInfo for given @file + line="24892">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -42065,13 +42970,13 @@ See g_file_query_filesystem_info_async(). input #GFile + line="24885">input #GFile a #GAsyncResult + line="24886">a #GAsyncResult @@ -42079,7 +42984,7 @@ See g_file_query_filesystem_info_async(). Gets the requested information about specified @file. + line="24898">Gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file). @@ -42113,7 +43018,7 @@ filesystem the file is on. a #GFileInfo for the given @file, or %NULL + line="24938">a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -42121,19 +43026,19 @@ filesystem the file is on. input #GFile + line="24900">input #GFile an attribute query string + line="24901">an attribute query string a set of #GFileQueryInfoFlags + line="24902">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="24903">optional #GCancellable object, %NULL to ignore @@ -42151,7 +43056,7 @@ filesystem the file is on. Asynchronously gets the requested information about specified @file. + line="24943">Asynchronously gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -42168,25 +43073,25 @@ then call g_file_query_info_finish() to get the result of the operation. input #GFile + line="24945">input #GFile an attribute query string + line="24946">an attribute query string a set of #GFileQueryInfoFlags + line="24947">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="24948">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24949">optional #GCancellable object, %NULL to ignore @@ -42207,7 +43112,7 @@ then call g_file_query_info_finish() to get the result of the operation. closure="5"> a #GAsyncReadyCallback to call when the + line="24951">a #GAsyncReadyCallback to call when the request is satisfied @@ -42218,7 +43123,7 @@ then call g_file_query_info_finish() to get the result of the operation. closure="5"> the data to pass to callback function + line="24953">the data to pass to callback function @@ -42228,13 +43133,13 @@ then call g_file_query_info_finish() to get the result of the operation. throws="1"> Finishes an asynchronous file info query. + line="24967">Finishes an asynchronous file info query. See g_file_query_info_async(). #GFileInfo for given @file + line="24976">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -42243,13 +43148,13 @@ See g_file_query_info_async(). input #GFile + line="24969">input #GFile a #GAsyncResult + line="24970">a #GAsyncResult @@ -42259,7 +43164,7 @@ See g_file_query_info_async(). throws="1"> Obtain the list of settable attributes for the file. + line="24982">Obtain the list of settable attributes for the file. Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will @@ -42273,7 +43178,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFileAttributeInfoList describing the settable attributes. + line="25000">a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -42282,7 +43187,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24984">input #GFile allow-none="1"> optional #GCancellable object, + line="24985">optional #GCancellable object, %NULL to ignore @@ -42302,7 +43207,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Obtain the list of attribute namespaces where new attributes + line="25006">Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace). @@ -42313,7 +43218,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFileAttributeInfoList describing the writable namespaces. + line="25021">a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -42322,7 +43227,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25008">input #GFile allow-none="1"> optional #GCancellable object, + line="25009">optional #GCancellable object, %NULL to ignore @@ -42340,7 +43245,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Asynchronously opens @file for reading. + line="25050">Asynchronously opens @file for reading. For more details, see g_file_read() which is the synchronous version of this call. @@ -42356,13 +43261,13 @@ of the operation. input #GFile + line="25052">input #GFile the [I/O priority][io-priority] of the request + line="25053">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25054">optional #GCancellable object, %NULL to ignore @@ -42383,7 +43288,7 @@ of the operation. closure="3"> a #GAsyncReadyCallback to call + line="25056">a #GAsyncReadyCallback to call when the request is satisfied @@ -42394,7 +43299,7 @@ of the operation. closure="3"> the data to pass to callback function + line="25058">the data to pass to callback function @@ -42402,13 +43307,13 @@ of the operation. Finishes an asynchronous file read operation started with + line="25071">Finishes an asynchronous file read operation started with g_file_read_async(). a #GFileInputStream or %NULL on error. + line="25080">a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -42416,13 +43321,13 @@ g_file_read_async(). input #GFile + line="25073">input #GFile a #GAsyncResult + line="25074">a #GAsyncResult @@ -42430,7 +43335,7 @@ g_file_read_async(). Opens a file for reading. The result is a #GFileInputStream that + line="25027">Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -42445,7 +43350,7 @@ on what kind of filesystem the file is on. #GFileInputStream or %NULL on error. + line="25045">#GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -42453,7 +43358,7 @@ on what kind of filesystem the file is on. #GFile to read + line="25029">#GFile to read allow-none="1"> a #GCancellable + line="25030">a #GCancellable @@ -42470,7 +43375,7 @@ on what kind of filesystem the file is on. Returns an output stream for overwriting the file, possibly + line="25085">Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -42515,7 +43420,7 @@ possible too, and depend on what kind of filesystem the file is on. a #GFileOutputStream or %NULL on error. + line="25138">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -42523,7 +43428,7 @@ possible too, and depend on what kind of filesystem the file is on. input #GFile + line="25087">input #GFile allow-none="1"> an optional [entity tag][gfile-etag] + line="25088">an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + line="25090">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25091">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="25092">optional #GCancellable object, %NULL to ignore @@ -42563,7 +43468,7 @@ possible too, and depend on what kind of filesystem the file is on. Asynchronously overwrites the file, replacing the contents, + line="25143">Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first. For more details, see g_file_replace() which is @@ -42580,7 +43485,7 @@ of the operation. input #GFile + line="25145">input #GFile allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + line="25146">an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + line="25148">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25149">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="25150">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25151">optional #GCancellable object, %NULL to ignore @@ -42629,7 +43534,7 @@ of the operation. closure="6"> a #GAsyncReadyCallback to call + line="25153">a #GAsyncReadyCallback to call when the request is satisfied @@ -42640,7 +43545,7 @@ of the operation. closure="6"> the data to pass to callback function + line="25155">the data to pass to callback function @@ -42650,13 +43555,13 @@ of the operation. throws="1"> Finishes an asynchronous file replace operation started with + line="25281">Finishes an asynchronous file replace operation started with g_file_replace_async(). a #GFileOutputStream, or %NULL on error. + line="25290">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -42664,13 +43569,13 @@ g_file_replace_async(). input #GFile + line="25283">input #GFile a #GAsyncResult + line="25284">a #GAsyncResult @@ -42681,7 +43586,7 @@ g_file_replace_async(). throws="1"> Returns an output stream for overwriting the file in readwrite mode, + line="25295">Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -42695,7 +43600,7 @@ rather than just opening for reading or writing. a #GFileIOStream or %NULL on error. + line="25317">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -42703,7 +43608,7 @@ rather than just opening for reading or writing. a #GFile + line="25297">a #GFile allow-none="1"> an optional [entity tag][gfile-etag] + line="25298">an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + line="25300">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25301">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="25302">optional #GCancellable object, %NULL to ignore @@ -42745,7 +43650,7 @@ rather than just opening for reading or writing. version="2.22"> Asynchronously overwrites the file in read-write mode, + line="25323">Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first. @@ -42763,7 +43668,7 @@ the result of the operation. input #GFile + line="25325">input #GFile allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + line="25326">an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + line="25328">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25329">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="25330">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25331">optional #GCancellable object, %NULL to ignore @@ -42812,7 +43717,7 @@ the result of the operation. closure="6"> a #GAsyncReadyCallback to call + line="25333">a #GAsyncReadyCallback to call when the request is satisfied @@ -42823,7 +43728,7 @@ the result of the operation. closure="6"> the data to pass to callback function + line="25335">the data to pass to callback function @@ -42834,13 +43739,13 @@ the result of the operation. throws="1"> Finishes an asynchronous file replace operation started with + line="25352">Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). a #GFileIOStream, or %NULL on error. + line="25361">a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -42848,13 +43753,13 @@ g_file_replace_readwrite_async(). input #GFile + line="25354">input #GFile a #GAsyncResult + line="25355">a #GAsyncResult @@ -42863,14 +43768,14 @@ g_file_replace_readwrite_async(). invoker="resolve_relative_path"> Resolves a relative path for @file to an absolute path. + line="25367">Resolves a relative path for @file to an absolute path. This call does no blocking I/O. #GFile to the resolved path. + line="25376">#GFile to the resolved path. %NULL if @relative_path is %NULL or if @file is invalid. Free the returned object with g_object_unref(). @@ -42879,13 +43784,13 @@ This call does no blocking I/O. input #GFile + line="25369">input #GFile a given relative path string + line="25370">a given relative path string @@ -42893,7 +43798,7 @@ This call does no blocking I/O. Sets an attribute in the file with attribute name @attribute to @value_p. + line="25382">Sets an attribute in the file with attribute name @attribute to @value_p. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. @@ -42905,26 +43810,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the attribute was set, %FALSE otherwise. + line="25403">%TRUE if the attribute was set, %FALSE otherwise. input #GFile + line="25384">input #GFile a string containing the attribute's name + line="25385">a string containing the attribute's name The type of the attribute + line="25386">The type of the attribute allow-none="1"> a pointer to the value (or the pointer + line="25387">a pointer to the value (or the pointer itself if the type is a pointer type) a set of #GFileQueryInfoFlags + line="25389">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25390">optional #GCancellable object, %NULL to ignore @@ -42959,7 +43864,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. invoker="set_attributes_async"> Asynchronously sets the attributes of @file with @info. + line="25538">Asynchronously sets the attributes of @file with @info. For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call. @@ -42975,25 +43880,25 @@ the result of the operation. input #GFile + line="25540">input #GFile a #GFileInfo + line="25541">a #GFileInfo a #GFileQueryInfoFlags + line="25542">a #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="25543">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25544">optional #GCancellable object, %NULL to ignore @@ -43014,7 +43919,7 @@ the result of the operation. closure="5"> a #GAsyncReadyCallback + line="25546">a #GAsyncReadyCallback closure="5"> a #gpointer + line="25547">a #gpointer @@ -43034,25 +43939,25 @@ the result of the operation. throws="1"> Finishes setting an attribute started in g_file_set_attributes_async(). + line="25560">Finishes setting an attribute started in g_file_set_attributes_async(). %TRUE if the attributes were set correctly, %FALSE otherwise. + line="25569">%TRUE if the attributes were set correctly, %FALSE otherwise. input #GFile + line="25562">input #GFile a #GAsyncResult + line="25563">a #GAsyncResult transfer-ownership="full"> a #GFileInfo + line="25564">a #GFileInfo @@ -43071,7 +43976,7 @@ the result of the operation. throws="1"> Tries to set all attributes in the #GFileInfo on the target + line="25573">Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error. If there is any error during this operation then @error will @@ -43087,26 +43992,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %FALSE if there was any error, %TRUE otherwise. + line="25595">%FALSE if there was any error, %TRUE otherwise. input #GFile + line="25575">input #GFile a #GFileInfo + line="25576">a #GFileInfo #GFileQueryInfoFlags + line="25577">#GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25578">optional #GCancellable object, %NULL to ignore @@ -43126,7 +44031,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Renames @file to the specified display name. + line="25599">Renames @file to the specified display name. The display name is converted from UTF-8 to the correct encoding for the target filesystem if possible and the @file is renamed to this. @@ -43145,7 +44050,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile specifying what @file was renamed to, + line="25623">a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -43154,13 +44059,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25601">input #GFile a string + line="25602">a string allow-none="1"> optional #GCancellable object, + line="25603">optional #GCancellable object, %NULL to ignore @@ -43179,7 +44084,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. invoker="set_display_name_async"> Asynchronously sets the display name for a given #GFile. + line="25629">Asynchronously sets the display name for a given #GFile. For more details, see g_file_set_display_name() which is the synchronous version of this call. @@ -43195,19 +44100,19 @@ the result of the operation. input #GFile + line="25631">input #GFile a string + line="25632">a string the [I/O priority][io-priority] of the request + line="25633">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25634">optional #GCancellable object, %NULL to ignore @@ -43228,7 +44133,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="25636">a #GAsyncReadyCallback to call when the request is satisfied @@ -43239,7 +44144,7 @@ the result of the operation. closure="4"> the data to pass to callback function + line="25638">the data to pass to callback function @@ -43249,13 +44154,13 @@ the result of the operation. throws="1"> Finishes setting a display name started with + line="25651">Finishes setting a display name started with g_file_set_display_name_async(). a #GFile or %NULL on error. + line="25660">a #GFile or %NULL on error. Free the returned object with g_object_unref(). @@ -43263,13 +44168,13 @@ g_file_set_display_name_async(). input #GFile + line="25653">input #GFile a #GAsyncResult + line="25654">a #GAsyncResult @@ -43279,7 +44184,7 @@ g_file_set_display_name_async(). version="2.22"> Starts a file of type #G_FILE_TYPE_MOUNTABLE. + line="25665">Starts a file of type #G_FILE_TYPE_MOUNTABLE. Using @start_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -43298,13 +44203,13 @@ the result of the operation. input #GFile + line="25667">input #GFile flags affecting the operation + line="25668">flags affecting the operation allow-none="1"> a #GMountOperation, or %NULL to avoid user interaction + line="25669">a #GMountOperation, or %NULL to avoid user interaction allow-none="1"> optional #GCancellable object, %NULL to ignore + line="25670">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + line="25671">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL closure="4"> the data to pass to callback function + line="25672">the data to pass to callback function @@ -43354,7 +44259,7 @@ the result of the operation. throws="1"> Finishes a start operation. See g_file_start_mountable() for details. + line="25690">Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). @@ -43362,7 +44267,7 @@ with g_file_start_mountable(). %TRUE if the operation finished successfully. %FALSE + line="25701">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -43370,13 +44275,13 @@ otherwise. input #GFile + line="25692">input #GFile a #GAsyncResult + line="25693">a #GAsyncResult @@ -43386,7 +44291,7 @@ otherwise. version="2.22"> Stops a file of type #G_FILE_TYPE_MOUNTABLE. + line="25707">Stops a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -43403,13 +44308,13 @@ the result of the operation. input #GFile + line="25709">input #GFile flags affecting the operation + line="25710">flags affecting the operation allow-none="1"> a #GMountOperation, + line="25711">a #GMountOperation, or %NULL to avoid user interaction. @@ -43428,7 +44333,7 @@ the result of the operation. allow-none="1"> optional #GCancellable object, + line="25713">optional #GCancellable object, %NULL to ignore @@ -43440,7 +44345,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="25715">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -43451,7 +44356,7 @@ the result of the operation. closure="4"> the data to pass to callback function + line="25717">the data to pass to callback function @@ -43462,7 +44367,7 @@ the result of the operation. throws="1"> Finishes a stop operation, see g_file_stop_mountable() for details. + line="25733">Finishes a stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). @@ -43470,7 +44375,7 @@ with g_file_stop_mountable(). %TRUE if the operation finished successfully. + line="25744">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -43478,13 +44383,13 @@ with g_file_stop_mountable(). input #GFile + line="25735">input #GFile a #GAsyncResult + line="25736">a #GAsyncResult @@ -43492,7 +44397,7 @@ with g_file_stop_mountable(). Sends @file to the "Trashcan", if possible. This is similar to + line="25764">Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Not all file systems support trashing, so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the `x-gvfs-notrash` unix @@ -43506,14 +44411,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on successful trash, %FALSE otherwise. + line="25782">%TRUE on successful trash, %FALSE otherwise. #GFile to send to trash + line="25766">#GFile to send to trash allow-none="1"> optional #GCancellable object, + line="25767">optional #GCancellable object, %NULL to ignore @@ -43531,7 +44436,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Asynchronously sends @file to the Trash location, if possible. + line="25786">Asynchronously sends @file to the Trash location, if possible. @@ -43540,13 +44445,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25788">input #GFile the [I/O priority][io-priority] of the request + line="25789">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25790">optional #GCancellable object, %NULL to ignore @@ -43567,7 +44472,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="25792">a #GAsyncReadyCallback to call when the request is satisfied @@ -43578,7 +44483,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> the data to pass to callback function + line="25794">the data to pass to callback function @@ -43589,26 +44494,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous file trashing operation, started with + line="25802">Finishes an asynchronous file trashing operation, started with g_file_trash_async(). %TRUE on successful trash, %FALSE otherwise. + line="25811">%TRUE on successful trash, %FALSE otherwise. input #GFile + line="25804">input #GFile a #GAsyncResult + line="25805">a #GAsyncResult @@ -43619,7 +44524,7 @@ g_file_trash_async(). deprecated-version="2.22"> Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + line="25816">Unmounts a file of type G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -43637,13 +44542,13 @@ the result of the operation. input #GFile + line="25818">input #GFile flags affecting the operation + line="25819">flags affecting the operation allow-none="1"> optional #GCancellable object, + line="25820">optional #GCancellable object, %NULL to ignore @@ -43664,7 +44569,7 @@ the result of the operation. closure="3"> a #GAsyncReadyCallback to call + line="25822">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -43675,7 +44580,7 @@ the result of the operation. closure="3"> the data to pass to callback function + line="25824">the data to pass to callback function @@ -43687,7 +44592,7 @@ the result of the operation. throws="1"> Finishes an unmount operation, see g_file_unmount_mountable() for details. + line="25840">Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable(). @@ -43697,7 +44602,7 @@ with g_file_unmount_mountable(). %TRUE if the operation finished successfully. + line="25851">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -43705,13 +44610,13 @@ with g_file_unmount_mountable(). input #GFile + line="25842">input #GFile a #GAsyncResult + line="25843">a #GAsyncResult @@ -43721,7 +44626,7 @@ with g_file_unmount_mountable(). version="2.22"> Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. + line="25858">Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -43738,13 +44643,13 @@ the result of the operation. input #GFile + line="25860">input #GFile flags affecting the operation + line="25861">flags affecting the operation allow-none="1"> a #GMountOperation, + line="25862">a #GMountOperation, or %NULL to avoid user interaction @@ -43763,7 +44668,7 @@ the result of the operation. allow-none="1"> optional #GCancellable object, + line="25864">optional #GCancellable object, %NULL to ignore @@ -43775,7 +44680,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="25866">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -43786,7 +44691,7 @@ the result of the operation. closure="4"> the data to pass to callback function + line="25868">the data to pass to callback function @@ -43797,7 +44702,7 @@ the result of the operation. throws="1"> Finishes an unmount operation, + line="25884">Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started @@ -43806,7 +44711,7 @@ with g_file_unmount_mountable_with_operation(). %TRUE if the operation finished successfully. + line="25896">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -43814,13 +44719,13 @@ with g_file_unmount_mountable_with_operation(). input #GFile + line="25886">input #GFile a #GAsyncResult + line="25887">a #GAsyncResult @@ -43828,7 +44733,7 @@ with g_file_unmount_mountable_with_operation(). Gets an output stream for appending data to the file. + line="21408">Gets an output stream for appending data to the file. If the file doesn't already exist it is created. By default files created are generally readable by everyone, @@ -43849,7 +44754,7 @@ possible too, and depend on what kind of filesystem the file is on. a #GFileOutputStream, or %NULL on error. + line="21434">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -43857,13 +44762,13 @@ possible too, and depend on what kind of filesystem the file is on. input #GFile + line="21410">input #GFile a set of #GFileCreateFlags + line="21411">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21412">optional #GCancellable object, %NULL to ignore @@ -43881,7 +44786,7 @@ possible too, and depend on what kind of filesystem the file is on. Asynchronously opens @file for appending. + line="21439">Asynchronously opens @file for appending. For more details, see g_file_append_to() which is the synchronous version of this call. @@ -43897,19 +44802,19 @@ of the operation. input #GFile + line="21441">input #GFile a set of #GFileCreateFlags + line="21442">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21443">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21444">optional #GCancellable object, %NULL to ignore @@ -43930,7 +44835,7 @@ of the operation. closure="4"> a #GAsyncReadyCallback to call + line="21446">a #GAsyncReadyCallback to call when the request is satisfied @@ -43940,7 +44845,7 @@ of the operation. allow-none="1"> the data to pass to callback function + line="21448">the data to pass to callback function @@ -43950,13 +44855,13 @@ of the operation. throws="1"> Finishes an asynchronous file append operation started with + line="21461">Finishes an asynchronous file append operation started with g_file_append_to_async(). a valid #GFileOutputStream + line="21470">a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -43965,21 +44870,69 @@ g_file_append_to_async(). input #GFile + line="21463">input #GFile #GAsyncResult + line="21464">#GAsyncResult + + Prepares the file attribute query string for copying to @file. + +This function prepares an attribute query string to be +passed to g_file_query_info() to get a list of attributes +normally copied with the file (see g_file_copy_attributes() +for the detailed description). This function is used by the +implementation of g_file_copy_attributes() and is useful +when one needs to query and set the attributes in two +stages (e.g., for recursive move of a directory). + + + an attribute query string for g_file_query_info(), + or %NULL if an error occurs. + + + + + a #GFile to copy attributes to + + + + a set of #GFileCopyFlags + + + + optional #GCancellable object, + %NULL to ignore + + + + Copies the file @source to the location specified by @destination. + line="21715">Copies the file @source to the location specified by @destination. Can not handle recursive copies of directories. If the flag #G_FILE_COPY_OVERWRITE is specified an already @@ -44023,26 +44976,26 @@ file), see g_file_dup(). %TRUE on success, %FALSE otherwise. + line="21768">%TRUE on success, %FALSE otherwise. input #GFile + line="21717">input #GFile destination #GFile + line="21718">destination #GFile set of #GFileCopyFlags + line="21719">set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="21720">optional #GCancellable object, %NULL to ignore @@ -44063,7 +45016,7 @@ file), see g_file_dup(). closure="4"> function to callback with + line="21722">function to callback with progress information, or %NULL if progress information is not needed @@ -44073,7 +45026,7 @@ file), see g_file_dup(). allow-none="1"> user data to pass to @progress_callback + line="21724">user data to pass to @progress_callback @@ -44081,7 +45034,7 @@ file), see g_file_dup(). Copies the file @source to the location specified by @destination + line="21772">Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -44099,25 +45052,25 @@ g_file_copy_finish() to get the result of the operation. input #GFile + line="21774">input #GFile destination #GFile + line="21775">destination #GFile set of #GFileCopyFlags + line="21776">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + line="21777">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21778">optional #GCancellable object, %NULL to ignore @@ -44138,7 +45091,7 @@ g_file_copy_finish() to get the result of the operation. closure="5"> function to callback with progress + line="21780">function to callback with progress information, or %NULL if progress information is not needed @@ -44149,7 +45102,7 @@ g_file_copy_finish() to get the result of the operation. closure="4"> user data to pass to @progress_callback + line="21782">user data to pass to @progress_callback closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + line="21783">a #GAsyncReadyCallback to call when the request is satisfied closure="6"> the data to pass to callback function + line="21784">the data to pass to callback function @@ -44180,7 +45133,7 @@ g_file_copy_finish() to get the result of the operation. throws="1"> Copies the file attributes from @source to @destination. + line="21799">Copies the file attributes from @source to @destination. Normally only a subset of the file attributes are copied, those that are copies in a normal file copy operation @@ -44188,11 +45141,11 @@ those that are copies in a normal file copy operation if #G_FILE_COPY_ALL_METADATA is specified in @flags, then all the metadata that is possible to copy is copied. This is useful when implementing move by copy + delete source. - + %TRUE if the attributes were copied successfully, + line="21817">%TRUE if the attributes were copied successfully, %FALSE otherwise. @@ -44200,19 +45153,19 @@ is useful when implementing move by copy + delete source. a #GFile with attributes + line="21801">a #GFile with attributes a #GFile to copy attributes to + line="21802">a #GFile to copy attributes to a set of #GFileCopyFlags + line="21803">a set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="21804">optional #GCancellable object, %NULL to ignore @@ -44230,25 +45183,25 @@ is useful when implementing move by copy + delete source. Finishes copying the file started with g_file_copy_async(). + line="21822">Finishes copying the file started with g_file_copy_async(). a %TRUE on success, %FALSE on error. + line="21830">a %TRUE on success, %FALSE on error. input #GFile + line="21824">input #GFile a #GAsyncResult + line="21825">a #GAsyncResult @@ -44256,7 +45209,7 @@ is useful when implementing move by copy + delete source. Creates a new file and returns an output stream for writing to it. + line="21834">Creates a new file and returns an output stream for writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -44279,7 +45232,7 @@ of filesystem the file is on. a #GFileOutputStream for the newly created + line="21862">a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -44288,13 +45241,13 @@ of filesystem the file is on. input #GFile + line="21836">input #GFile a set of #GFileCreateFlags + line="21837">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21838">optional #GCancellable object, %NULL to ignore @@ -44312,7 +45265,7 @@ of filesystem the file is on. Asynchronously creates a new file and returns an output stream + line="21868">Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. For more details, see g_file_create() which is @@ -44329,19 +45282,19 @@ of the operation. input #GFile + line="21870">input #GFile a set of #GFileCreateFlags + line="21871">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21872">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21873">optional #GCancellable object, %NULL to ignore @@ -44362,7 +45315,7 @@ of the operation. closure="4"> a #GAsyncReadyCallback to call + line="21875">a #GAsyncReadyCallback to call when the request is satisfied @@ -44372,7 +45325,7 @@ of the operation. allow-none="1"> the data to pass to callback function + line="21877">the data to pass to callback function @@ -44382,13 +45335,13 @@ of the operation. throws="1"> Finishes an asynchronous file create operation started with + line="21891">Finishes an asynchronous file create operation started with g_file_create_async(). a #GFileOutputStream or %NULL on error. + line="21900">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -44396,13 +45349,13 @@ g_file_create_async(). input #GFile + line="21893">input #GFile a #GAsyncResult + line="21894">a #GAsyncResult @@ -44413,7 +45366,7 @@ g_file_create_async(). throws="1"> Creates a new file and returns a stream for reading and + line="21905">Creates a new file and returns a stream for reading and writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -44440,7 +45393,7 @@ streaming, rather than just opening for reading or writing. a #GFileIOStream for the newly created + line="21937">a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -44449,13 +45402,13 @@ streaming, rather than just opening for reading or writing. a #GFile + line="21907">a #GFile a set of #GFileCreateFlags + line="21908">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21909">optional #GCancellable object, %NULL to ignore @@ -44475,7 +45428,7 @@ streaming, rather than just opening for reading or writing. version="2.22"> Asynchronously creates a new file and returns a stream + line="21944">Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist. For more details, see g_file_create_readwrite() which is @@ -44492,19 +45445,19 @@ the result of the operation. input #GFile + line="21946">input #GFile a set of #GFileCreateFlags + line="21947">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21948">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21949">optional #GCancellable object, %NULL to ignore @@ -44525,7 +45478,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="21951">a #GAsyncReadyCallback to call when the request is satisfied @@ -44535,7 +45488,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="21953">the data to pass to callback function @@ -44546,13 +45499,13 @@ the result of the operation. throws="1"> Finishes an asynchronous file create operation started with + line="21969">Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). a #GFileIOStream or %NULL on error. + line="21978">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -44560,13 +45513,13 @@ g_file_create_readwrite_async(). input #GFile + line="21971">input #GFile a #GAsyncResult + line="21972">a #GAsyncResult @@ -44574,7 +45527,7 @@ g_file_create_readwrite_async(). Deletes a file. If the @file is a directory, it will only be + line="21984">Deletes a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). If @file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows @@ -44599,14 +45552,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the file was deleted. %FALSE otherwise. + line="22013">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + line="21986">input #GFile allow-none="1"> optional #GCancellable object, + line="21987">optional #GCancellable object, %NULL to ignore @@ -44626,7 +45579,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.34"> Asynchronously delete a file. If the @file is a directory, it will + line="22017">Asynchronously delete a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). @@ -44637,13 +45590,13 @@ g_unlink(). input #GFile + line="22019">input #GFile the [I/O priority][io-priority] of the request + line="22020">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22021">optional #GCancellable object, %NULL to ignore @@ -44664,7 +45617,7 @@ g_unlink(). closure="3"> a #GAsyncReadyCallback to call + line="22023">a #GAsyncReadyCallback to call when the request is satisfied @@ -44674,7 +45627,7 @@ g_unlink(). allow-none="1"> the data to pass to callback function + line="22025">the data to pass to callback function @@ -44685,25 +45638,25 @@ g_unlink(). throws="1"> Finishes deleting a file started with g_file_delete_async(). + line="22035">Finishes deleting a file started with g_file_delete_async(). %TRUE if the file was deleted. %FALSE otherwise. + line="22043">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + line="22037">input #GFile a #GAsyncResult + line="22038">a #GAsyncResult @@ -44711,7 +45664,7 @@ g_unlink(). Duplicates a #GFile handle. This operation does not duplicate + line="22059">Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file. @@ -44725,7 +45678,7 @@ This call does no blocking I/O. a new #GFile that is a duplicate + line="22074">a new #GFile that is a duplicate of the given #GFile. @@ -44733,7 +45686,7 @@ This call does no blocking I/O. input #GFile + line="22061">input #GFile @@ -44744,7 +45697,7 @@ This call does no blocking I/O. deprecated-version="2.22"> Starts an asynchronous eject on a mountable. + line="22079">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_finish(). @@ -44761,13 +45714,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="22081">input #GFile flags affecting the operation + line="22082">flags affecting the operation allow-none="1"> optional #GCancellable object, + line="22083">optional #GCancellable object, %NULL to ignore @@ -44788,7 +45741,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="22085">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -44798,7 +45751,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> the data to pass to callback function + line="22087">the data to pass to callback function @@ -44810,7 +45763,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous eject operation started by + line="22102">Finishes an asynchronous eject operation started by g_file_eject_mountable(). Use g_file_eject_mountable_with_operation_finish() instead. @@ -44818,7 +45771,7 @@ g_file_eject_mountable(). %TRUE if the @file was ejected successfully. + line="22111">%TRUE if the @file was ejected successfully. %FALSE otherwise. @@ -44826,13 +45779,13 @@ g_file_eject_mountable(). input #GFile + line="22104">input #GFile a #GAsyncResult + line="22105">a #GAsyncResult @@ -44842,7 +45795,7 @@ g_file_eject_mountable(). version="2.22"> Starts an asynchronous eject on a mountable. + line="22118">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish(). @@ -44858,13 +45811,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="22120">input #GFile flags affecting the operation + line="22121">flags affecting the operation allow-none="1"> a #GMountOperation, + line="22122">a #GMountOperation, or %NULL to avoid user interaction @@ -44883,7 +45836,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> optional #GCancellable object, + line="22124">optional #GCancellable object, %NULL to ignore @@ -44895,7 +45848,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="4"> a #GAsyncReadyCallback to call + line="22126">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -44905,7 +45858,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> the data to pass to callback function + line="22128">the data to pass to callback function @@ -44916,13 +45869,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous eject operation started by + line="22143">Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). %TRUE if the @file was ejected successfully. + line="22152">%TRUE if the @file was ejected successfully. %FALSE otherwise. @@ -44930,13 +45883,13 @@ g_file_eject_mountable_with_operation(). input #GFile + line="22145">input #GFile a #GAsyncResult + line="22146">a #GAsyncResult @@ -44946,7 +45899,7 @@ g_file_eject_mountable_with_operation(). throws="1"> Gets the requested information about the files in a directory. + line="22158">Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -44973,7 +45926,7 @@ error will be returned. Other errors are possible too. A #GFileEnumerator if successful, + line="22191">A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). @@ -44981,19 +45934,19 @@ error will be returned. Other errors are possible too. input #GFile + line="22160">input #GFile an attribute query string + line="22161">an attribute query string a set of #GFileQueryInfoFlags + line="22162">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="22163">optional #GCancellable object, %NULL to ignore @@ -45012,7 +45965,7 @@ error will be returned. Other errors are possible too. c:identifier="g_file_enumerate_children_async"> Asynchronously gets the requested information about the files + line="22196">Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -45030,25 +45983,25 @@ the operation. input #GFile + line="22198">input #GFile an attribute query string + line="22199">an attribute query string a set of #GFileQueryInfoFlags + line="22200">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="22201">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22202">optional #GCancellable object, %NULL to ignore @@ -45069,7 +46022,7 @@ the operation. closure="5"> a #GAsyncReadyCallback to call when the + line="22204">a #GAsyncReadyCallback to call when the request is satisfied @@ -45079,7 +46032,7 @@ the operation. allow-none="1"> the data to pass to callback function + line="22206">the data to pass to callback function @@ -45089,13 +46042,13 @@ the operation. throws="1"> Finishes an async enumerate children operation. + line="22221">Finishes an async enumerate children operation. See g_file_enumerate_children_async(). a #GFileEnumerator or %NULL + line="22230">a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). @@ -45104,13 +46057,13 @@ See g_file_enumerate_children_async(). input #GFile + line="22223">input #GFile a #GAsyncResult + line="22224">a #GAsyncResult @@ -45118,7 +46071,7 @@ See g_file_enumerate_children_async(). Checks if the two given #GFiles refer to the same file. + line="22475">Checks if the two given #GFiles refer to the same file. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename @@ -45129,20 +46082,20 @@ This call does no blocking I/O. %TRUE if @file1 and @file2 are equal. + line="22488">%TRUE if @file1 and @file2 are equal. the first #GFile + line="22477">the first #GFile the second #GFile + line="22478">the second #GFile @@ -45152,7 +46105,7 @@ This call does no blocking I/O. throws="1"> Gets a #GMount for the #GFile. + line="22492">Gets a #GMount for the #GFile. #GMount is returned only for user interesting locations, see #GVolumeMonitor. If the #GFileIface for @file does not have a #mount, @@ -45165,7 +46118,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GMount where the @file is located + line="22509">a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). @@ -45174,7 +46127,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="22494">input #GFile allow-none="1"> optional #GCancellable object, + line="22495">optional #GCancellable object, %NULL to ignore @@ -45193,7 +46146,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_find_enclosing_mount_async"> Asynchronously gets the mount for the file. + line="22515">Asynchronously gets the mount for the file. For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call. @@ -45209,13 +46162,13 @@ get the result of the operation. a #GFile + line="22517">a #GFile the [I/O priority][io-priority] of the request + line="22518">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22519">optional #GCancellable object, %NULL to ignore @@ -45236,7 +46189,7 @@ get the result of the operation. closure="3"> a #GAsyncReadyCallback to call + line="22521">a #GAsyncReadyCallback to call when the request is satisfied @@ -45246,7 +46199,7 @@ get the result of the operation. allow-none="1"> the data to pass to callback function + line="22523">the data to pass to callback function @@ -45256,13 +46209,13 @@ get the result of the operation. throws="1"> Finishes an asynchronous find mount request. + line="22536">Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async(). #GMount for given @file or %NULL on error. + line="22545">#GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -45270,13 +46223,13 @@ See g_file_find_enclosing_mount_async(). a #GFile + line="22538">a #GFile a #GAsyncResult + line="22539">a #GAsyncResult @@ -45284,7 +46237,7 @@ See g_file_find_enclosing_mount_async(). Gets the base name (the last component of the path) for a given #GFile. + line="22550">Gets the base name (the last component of the path) for a given #GFile. If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it will return a single directory separator @@ -45301,7 +46254,7 @@ This call does no blocking I/O. string containing the #GFile's + line="22568">string containing the #GFile's base name, or %NULL if given #GFile is invalid. The returned string should be freed with g_free() when no longer needed. @@ -45310,7 +46263,7 @@ This call does no blocking I/O. input #GFile + line="22552">input #GFile @@ -45318,7 +46271,7 @@ This call does no blocking I/O. Gets a child of @file with basename equal to @name. + line="22574">Gets a child of @file with basename equal to @name. Note that the file with that specific name might not exist, but you can still have a #GFile that points to it. You can use this @@ -45329,7 +46282,7 @@ This call does no blocking I/O. a #GFile to a child specified by @name. + line="22587">a #GFile to a child specified by @name. Free the returned object with g_object_unref(). @@ -45337,13 +46290,13 @@ This call does no blocking I/O. input #GFile + line="22576">input #GFile string containing the child's basename + line="22577">string containing the child's basename @@ -45353,7 +46306,7 @@ This call does no blocking I/O. throws="1"> Gets the child of @file for a given @display_name (i.e. a UTF-8 + line="22592">Gets the child of @file for a given @display_name (i.e. a UTF-8 version of the name). If this function fails, it returns %NULL and @error will be set. This is very useful when constructing a #GFile for a new file and the user entered the filename in the @@ -45365,7 +46318,7 @@ This call does no blocking I/O. a #GFile to the specified child, or + line="22607">a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). @@ -45374,13 +46327,13 @@ This call does no blocking I/O. input #GFile + line="22594">input #GFile string to a possible child + line="22595">string to a possible child @@ -45388,7 +46341,7 @@ This call does no blocking I/O. Gets the parent directory for the @file. + line="22613">Gets the parent directory for the @file. If the @file represents the root directory of the file system, then %NULL will be returned. @@ -45397,7 +46350,7 @@ This call does no blocking I/O. a #GFile structure to the + line="22623">a #GFile structure to the parent of the given #GFile or %NULL if there is no parent. Free the returned object with g_object_unref(). @@ -45406,7 +46359,7 @@ This call does no blocking I/O. input #GFile + line="22615">input #GFile @@ -45414,7 +46367,7 @@ This call does no blocking I/O. Gets the parse name of the @file. + line="22629">Gets the parse name of the @file. A parse name is a UTF-8 string that describes the file such that one can get the #GFile back using g_file_parse_name(). @@ -45432,7 +46385,7 @@ This call does no blocking I/O. a string containing the #GFile's parse name. + line="22648">a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. @@ -45441,7 +46394,7 @@ This call does no blocking I/O. input #GFile + line="22631">input #GFile @@ -45449,7 +46402,7 @@ This call does no blocking I/O. Gets the local pathname for #GFile, if one exists. If non-%NULL, this is + line="22654">Gets the local pathname for #GFile, if one exists. If non-%NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks. This call does no blocking I/O. @@ -45457,7 +46410,7 @@ This call does no blocking I/O. string containing the #GFile's path, + line="22663">string containing the #GFile's path, or %NULL if no such path exists. The returned string should be freed with g_free() when no longer needed. @@ -45466,7 +46419,7 @@ This call does no blocking I/O. input #GFile + line="22656">input #GFile @@ -45474,14 +46427,14 @@ This call does no blocking I/O. Gets the path for @descendant relative to @parent. + line="22669">Gets the path for @descendant relative to @parent. This call does no blocking I/O. string with the relative path from + line="22678">string with the relative path from @descendant to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with g_free() when no longer needed. @@ -45491,13 +46444,13 @@ This call does no blocking I/O. input #GFile + line="22671">input #GFile input #GFile + line="22672">input #GFile @@ -45505,14 +46458,15 @@ This call does no blocking I/O. Gets the URI for the @file. + line="22685">Gets the URI for the @file. This call does no blocking I/O. a string containing the #GFile's URI. + line="22693">a string containing the #GFile's URI. If the #GFile was constructed + with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed. @@ -45521,7 +46475,7 @@ This call does no blocking I/O. input #GFile + line="22687">input #GFile @@ -45529,28 +46483,31 @@ This call does no blocking I/O. Gets the URI scheme for a #GFile. + line="22700">Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include "file", "http", "ftp", etc. +The scheme can be different from the one used to construct the #GFile, +in that it might be replaced with one that is logically equivalent to the #GFile. + This call does no blocking I/O. - + a string containing the URI scheme for the given - #GFile. The returned string should be freed with g_free() - when no longer needed. + line="22716">a string containing the URI scheme for the given + #GFile or %NULL if the #GFile was constructed with an invalid URI. The + returned string should be freed with g_free() when no longer needed. input #GFile + line="22702">input #GFile @@ -45560,7 +46517,7 @@ This call does no blocking I/O. version="2.24"> Checks if @file has a parent, and optionally, if it is @parent. + line="22722">Checks if @file has a parent, and optionally, if it is @parent. If @parent is %NULL then this function returns %TRUE if @file has any parent at all. If @parent is non-%NULL then %TRUE is only returned @@ -45569,7 +46526,7 @@ if @file is an immediate child of @parent. %TRUE if @file is an immediate child of @parent (or any parent in + line="22733">%TRUE if @file is an immediate child of @parent (or any parent in the case that @parent is %NULL). @@ -45577,7 +46534,7 @@ if @file is an immediate child of @parent. input #GFile + line="22724">input #GFile allow-none="1"> the parent to check for, or %NULL + line="22725">the parent to check for, or %NULL @@ -45594,7 +46551,7 @@ if @file is an immediate child of @parent. Checks whether @file has the prefix specified by @prefix. + line="22739">Checks whether @file has the prefix specified by @prefix. In other words, if the names of initial elements of @file's pathname match @prefix. Only full pathname elements are matched, @@ -45612,7 +46569,7 @@ of @prefix. %TRUE if the @file's parent, grandparent, etc is @prefix, + line="22759">%TRUE if the @file's parent, grandparent, etc is @prefix, %FALSE otherwise. @@ -45620,13 +46577,13 @@ of @prefix. input #GFile + line="22741">input #GFile input #GFile + line="22742">input #GFile @@ -45634,14 +46591,14 @@ of @prefix. Checks to see if a #GFile has a given URI scheme. + line="22764">Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O. %TRUE if #GFile's backend supports the + line="22773">%TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. @@ -45650,13 +46607,13 @@ This call does no blocking I/O. input #GFile + line="22766">input #GFile a string containing a URI scheme + line="22767">a string containing a URI scheme @@ -45664,14 +46621,14 @@ This call does no blocking I/O. Creates a hash value for a #GFile. + line="22779">Creates a hash value for a #GFile. This call does no blocking I/O. 0 if @file is not a valid #GFile, otherwise an + line="22787">0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -45681,7 +46638,7 @@ This call does no blocking I/O. #gconstpointer to a #GFile + line="22781">#gconstpointer to a #GFile @@ -45689,7 +46646,7 @@ This call does no blocking I/O. Checks to see if a file is native to the platform. + line="23750">Checks to see if a file is native to the platform. A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, @@ -45704,14 +46661,14 @@ This call does no blocking I/O. %TRUE if @file is native + line="23766">%TRUE if @file is native input #GFile + line="23752">input #GFile @@ -45722,7 +46679,7 @@ This call does no blocking I/O. throws="1"> Loads the contents of @file and returns it as #GBytes. + line="23770">Loads the contents of @file and returns it as #GBytes. If @file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling @@ -45733,18 +46690,18 @@ For resources, @etag_out will be set to %NULL. The data contained in the resulting #GBytes is always zero-terminated, but this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use. - + a #GBytes or %NULL and @error is set + line="23790">a #GBytes or %NULL and @error is set a #GFile + line="23772">a #GFile allow-none="1"> a #GCancellable or %NULL + line="23773">a #GCancellable or %NULL allow-none="1"> a location to place the current + line="23774">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -45776,7 +46733,7 @@ freed with g_bytes_unref() when no longer in use. version="2.56"> Asynchronously loads the contents of @file as #GBytes. + line="23795">Asynchronously loads the contents of @file as #GBytes. If @file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling @@ -45786,7 +46743,7 @@ g_file_load_contents_async() and g_bytes_new_take(). asynchronous operation. See g_file_load_bytes() for more information. - + @@ -45794,7 +46751,7 @@ See g_file_load_bytes() for more information. a #GFile + line="23797">a #GFile allow-none="1"> a #GCancellable or %NULL + line="23798">a #GCancellable or %NULL closure="2"> a #GAsyncReadyCallback to call when the + line="23799">a #GAsyncReadyCallback to call when the request is satisfied @@ -45824,7 +46781,7 @@ See g_file_load_bytes() for more information. allow-none="1"> the data to pass to callback function + line="23801">the data to pass to callback function @@ -45835,7 +46792,7 @@ See g_file_load_bytes() for more information. throws="1"> Completes an asynchronous request to g_file_load_bytes_async(). + line="23818">Completes an asynchronous request to g_file_load_bytes_async(). For resources, @etag_out will be set to %NULL. @@ -45844,24 +46801,24 @@ this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use. See g_file_load_bytes() for more information. - + a #GBytes or %NULL and @error is set + line="23836">a #GBytes or %NULL and @error is set a #GFile + line="23820">a #GFile a #GAsyncResult provided to the callback + line="23821">a #GAsyncResult provided to the callback allow-none="1"> a location to place the current + line="23822">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -45884,7 +46841,7 @@ See g_file_load_bytes() for more information. throws="1"> Loads the content of the file into memory. The data is always + line="23841">Loads the content of the file into memory. The data is always zero-terminated, but this is not included in the resultant @length. The returned @contents should be freed with g_free() when no longer needed. @@ -45892,11 +46849,11 @@ needed. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @file's contents were successfully loaded. + line="23861">%TRUE if the @file's contents were successfully loaded. %FALSE if there were errors. @@ -45904,7 +46861,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="23843">input #GFile allow-none="1"> optional #GCancellable object, %NULL to ignore + line="23844">optional #GCancellable object, %NULL to ignore transfer-ownership="full"> a location to place the contents of the file + line="23845">a location to place the contents of the file @@ -45935,7 +46892,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> a location to place the length of the contents of the file, + line="23846">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -45943,11 +46900,12 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. direction="out" caller-allocates="0" transfer-ownership="full" + nullable="1" optional="1" allow-none="1"> a location to place the current entity tag for the file, + line="23848">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -45957,7 +46915,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_load_contents_async"> Starts an asynchronous load of the @file's contents. + line="23866">Starts an asynchronous load of the @file's contents. For more details, see g_file_load_contents() which is the synchronous version of this call. @@ -45970,7 +46928,7 @@ the @callback. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + @@ -45978,7 +46936,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="23868">input #GFile allow-none="1"> optional #GCancellable object, %NULL to ignore + line="23869">optional #GCancellable object, %NULL to ignore closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="23870">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="23871">the data to pass to callback function @@ -46017,16 +46975,16 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous load of the @file's contents. + line="23889">Finishes an asynchronous load of the @file's contents. The contents are placed in @contents, and @length is set to the size of the @contents string. The @contents should be freed with g_free() when no longer needed. If @etag_out is present, it will be set to the new entity tag for the @file. - + %TRUE if the load was successful. If %FALSE and @error is + line="23906">%TRUE if the load was successful. If %FALSE and @error is present, it will be set appropriately. @@ -46034,13 +46992,13 @@ set to the new entity tag for the @file. input #GFile + line="23891">input #GFile a #GAsyncResult + line="23892">a #GAsyncResult transfer-ownership="full"> a location to place the contents of the file + line="23893">a location to place the contents of the file @@ -46062,7 +47020,7 @@ set to the new entity tag for the @file. allow-none="1"> a location to place the length of the contents of the file, + line="23894">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -46070,11 +47028,12 @@ set to the new entity tag for the @file. direction="out" caller-allocates="0" transfer-ownership="full" + nullable="1" optional="1" allow-none="1"> a location to place the current entity tag for the file, + line="23896">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -46085,7 +47044,7 @@ set to the new entity tag for the @file. introspectable="0"> Reads the partial contents of a file. A #GFileReadMoreCallback should + line="23911">Reads the partial contents of a file. A #GFileReadMoreCallback should be used to stop reading from the file when appropriate, else this function will behave exactly as g_file_load_contents_async(). This operation can be finished by g_file_load_partial_contents_finish(). @@ -46096,7 +47055,7 @@ both the @read_more_callback and the @callback. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + @@ -46104,7 +47063,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="23913">input #GFile allow-none="1"> optional #GCancellable object, %NULL to ignore + line="23914">optional #GCancellable object, %NULL to ignore closure="3"> a + line="23915">a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read @@ -46135,7 +47094,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="23918">a #GAsyncReadyCallback to call when the request is satisfied @@ -46145,7 +47104,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> the data to pass to the callback functions + line="23920">the data to pass to the callback functions @@ -46155,16 +47114,16 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous partial load operation that was started + line="23936">Finishes an asynchronous partial load operation that was started with g_file_load_partial_contents_async(). The data is always zero-terminated, but this is not included in the resultant @length. The returned @contents should be freed with g_free() when no longer needed. - + %TRUE if the load was successful. If %FALSE and @error is + line="23953">%TRUE if the load was successful. If %FALSE and @error is present, it will be set appropriately. @@ -46172,13 +47131,13 @@ needed. input #GFile + line="23938">input #GFile a #GAsyncResult + line="23939">a #GAsyncResult transfer-ownership="full"> a location to place the contents of the file + line="23940">a location to place the contents of the file @@ -46200,7 +47159,7 @@ needed. allow-none="1"> a location to place the length of the contents of the file, + line="23941">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -46208,11 +47167,12 @@ needed. direction="out" caller-allocates="0" transfer-ownership="full" + nullable="1" optional="1" allow-none="1"> a location to place the current entity tag for the file, + line="23943">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -46223,7 +47183,7 @@ needed. throws="1"> Creates a directory. Note that this will only create a child directory + line="23958">Creates a directory. Note that this will only create a child directory of the immediate parent directory of the path or URI given by the #GFile. To recursively create directories, see g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting @@ -46241,14 +47201,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on successful creation, %FALSE otherwise. + line="23980">%TRUE on successful creation, %FALSE otherwise. input #GFile + line="23960">input #GFile allow-none="1"> optional #GCancellable object, + line="23961">optional #GCancellable object, %NULL to ignore @@ -46268,7 +47228,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38"> Asynchronously creates a directory. + line="23984">Asynchronously creates a directory. @@ -46277,13 +47237,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="23986">input #GFile the [I/O priority][io-priority] of the request + line="23987">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="23988">optional #GCancellable object, %NULL to ignore @@ -46304,7 +47264,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="23990">a #GAsyncReadyCallback to call when the request is satisfied @@ -46314,7 +47274,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> the data to pass to callback function + line="23992">the data to pass to callback function @@ -46325,26 +47285,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous directory creation, started with + line="24000">Finishes an asynchronous directory creation, started with g_file_make_directory_async(). %TRUE on successful directory creation, %FALSE otherwise. + line="24009">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + line="24002">input #GFile a #GAsyncResult + line="24003">a #GAsyncResult @@ -46355,7 +47315,7 @@ g_file_make_directory_async(). throws="1"> Creates a directory and any parent directories that may not + line="24014">Creates a directory and any parent directories that may not exist similar to 'mkdir -p'. If the file system does not support creating directories, this function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists, @@ -46372,7 +47332,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if all directories have been successfully created, %FALSE + line="24035">%TRUE if all directories have been successfully created, %FALSE otherwise. @@ -46380,7 +47340,7 @@ otherwise. input #GFile + line="24016">input #GFile allow-none="1"> optional #GCancellable object, + line="24017">optional #GCancellable object, %NULL to ignore @@ -46400,7 +47360,7 @@ otherwise. throws="1"> Creates a symbolic link named @file which contains the string + line="24041">Creates a symbolic link named @file which contains the string @symlink_value. If @cancellable is not %NULL, then the operation can be cancelled by @@ -46410,20 +47370,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on the creation of a new symlink, %FALSE otherwise. + line="24057">%TRUE on the creation of a new symlink, %FALSE otherwise. a #GFile with the name of the symlink to create + line="24043">a #GFile with the name of the symlink to create a string with the path for the target + line="24044">a string with the path for the target of the new symlink @@ -46433,7 +47393,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> optional #GCancellable object, + line="24046">optional #GCancellable object, %NULL to ignore @@ -46446,7 +47406,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Recursively measures the disk usage of @file. + line="24061">Recursively measures the disk usage of @file. This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered @@ -46464,11 +47424,11 @@ in a user interface. periodic progress updates while scanning. See the documentation for #GFileMeasureProgressCallback for information about when and how the callback will be invoked. - + %TRUE if successful, with the out parameters set. + line="24092">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. @@ -46476,13 +47436,13 @@ callback will be invoked. a #GFile + line="24063">a #GFile #GFileMeasureFlags + line="24064">#GFileMeasureFlags allow-none="1"> optional #GCancellable + line="24065">optional #GCancellable closure="3"> a #GFileMeasureProgressCallback + line="24066">a #GFileMeasureProgressCallback @@ -46511,7 +47471,7 @@ callback will be invoked. allow-none="1"> user_data for @progress_callback + line="24067">user_data for @progress_callback allow-none="1"> the number of bytes of disk space used + line="24068">the number of bytes of disk space used allow-none="1"> the number of directories encountered + line="24069">the number of directories encountered allow-none="1"> the number of non-directories encountered + line="24070">the number of non-directories encountered @@ -46555,11 +47515,11 @@ callback will be invoked. introspectable="0"> Recursively measures the disk usage of @file. + line="24098">Recursively measures the disk usage of @file. This is the asynchronous version of g_file_measure_disk_usage(). See there for more information. - + @@ -46567,19 +47527,19 @@ there for more information. a #GFile + line="24100">a #GFile #GFileMeasureFlags + line="24101">#GFileMeasureFlags the [I/O priority][io-priority] of the request + line="24102">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable + line="24103">optional #GCancellable closure="4"> a #GFileMeasureProgressCallback + line="24104">a #GFileMeasureProgressCallback @@ -46608,7 +47568,7 @@ there for more information. allow-none="1"> user_data for @progress_callback + line="24105">user_data for @progress_callback closure="6"> a #GAsyncReadyCallback to call when complete + line="24106">a #GAsyncReadyCallback to call when complete allow-none="1"> the data to pass to callback function + line="24107">the data to pass to callback function @@ -46639,14 +47599,14 @@ there for more information. throws="1"> Collects the results from an earlier call to + line="24118">Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information. - + %TRUE if successful, with the out parameters set. + line="24131">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. @@ -46654,13 +47614,13 @@ more information. a #GFile + line="24120">a #GFile the #GAsyncResult passed to your #GAsyncReadyCallback + line="24121">the #GAsyncResult passed to your #GAsyncReadyCallback allow-none="1"> the number of bytes of disk space used + line="24122">the number of bytes of disk space used allow-none="1"> the number of directories encountered + line="24123">the number of directories encountered allow-none="1"> the number of non-directories encountered + line="24124">the number of non-directories encountered @@ -46704,17 +47664,17 @@ more information. throws="1"> Obtains a file or directory monitor for the given file, + line="24137">Obtains a file or directory monitor for the given file, depending on the type of the file. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFileMonitor for the given @file, + line="24152">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -46723,13 +47683,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24139">input #GFile a set of #GFileMonitorFlags + line="24140">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24141">optional #GCancellable object, %NULL to ignore @@ -46749,7 +47709,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Obtains a directory monitor for the given file. + line="24169">Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported. If @cancellable is not %NULL, then the operation can be cancelled by @@ -46761,11 +47721,11 @@ It does not make sense for @flags to contain directories. It is not possible to monitor all the files in a directory for changes made via hard links; if you want to do this then you must register individual watches with g_file_monitor(). - + a #GFileMonitor for the given @file, + line="24190">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -46774,13 +47734,13 @@ you must register individual watches with g_file_monitor(). input #GFile + line="24171">input #GFile a set of #GFileMonitorFlags + line="24172">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24173">optional #GCancellable object, %NULL to ignore @@ -46800,7 +47760,7 @@ you must register individual watches with g_file_monitor(). throws="1"> Obtains a file monitor for the given file. If no file notification + line="24213">Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If @cancellable is not %NULL, then the operation can be cancelled by @@ -46814,11 +47774,11 @@ changes made through the filename contained in @file to be reported. Using this flag may result in an increase in resource usage, and may not have any effect depending on the #GFileMonitor backend and/or filesystem type. - + a #GFileMonitor for the given @file, + line="24236">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -46827,13 +47787,13 @@ backend and/or filesystem type. input #GFile + line="24215">input #GFile a set of #GFileMonitorFlags + line="24216">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24217">optional #GCancellable object, %NULL to ignore @@ -46852,7 +47812,7 @@ backend and/or filesystem type. c:identifier="g_file_mount_enclosing_volume"> Starts a @mount_operation, mounting the volume that contains + line="24263">Starts a @mount_operation, mounting the volume that contains the file @location. When this operation has completed, @callback will be called with @@ -46870,13 +47830,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24265">input #GFile flags affecting the operation + line="24266">flags affecting the operation allow-none="1"> a #GMountOperation + line="24267">a #GMountOperation or %NULL to avoid user interaction @@ -46895,7 +47855,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> optional #GCancellable object, + line="24269">optional #GCancellable object, %NULL to ignore @@ -46907,7 +47867,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="4"> a #GAsyncReadyCallback to call + line="24271">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -46917,7 +47877,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> the data to pass to callback function + line="24273">the data to pass to callback function @@ -46927,12 +47887,12 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes a mount operation started by g_file_mount_enclosing_volume(). + line="24288">Finishes a mount operation started by g_file_mount_enclosing_volume(). %TRUE if successful. If an error has occurred, + line="24296">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -46941,13 +47901,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24290">input #GFile a #GAsyncResult + line="24291">a #GAsyncResult @@ -46955,7 +47915,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Mounts a file of type G_FILE_TYPE_MOUNTABLE. + line="24302">Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using @mount_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -46974,13 +47934,13 @@ the result of the operation. input #GFile + line="24304">input #GFile flags affecting the operation + line="24305">flags affecting the operation allow-none="1"> a #GMountOperation, + line="24306">a #GMountOperation, or %NULL to avoid user interaction @@ -46999,7 +47959,7 @@ the result of the operation. allow-none="1"> optional #GCancellable object, + line="24308">optional #GCancellable object, %NULL to ignore @@ -47011,7 +47971,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="24310">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -47021,7 +47981,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="24312">the data to pass to callback function @@ -47031,7 +47991,7 @@ the result of the operation. throws="1"> Finishes a mount operation. See g_file_mount_mountable() for details. + line="24328">Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable(). @@ -47039,7 +47999,7 @@ with g_file_mount_mountable(). a #GFile or %NULL on error. + line="24339">a #GFile or %NULL on error. Free the returned object with g_object_unref(). @@ -47047,13 +48007,13 @@ with g_file_mount_mountable(). input #GFile + line="24330">input #GFile a #GAsyncResult + line="24331">a #GAsyncResult @@ -47061,7 +48021,7 @@ with g_file_mount_mountable(). Tries to move the file or directory @source to the location specified + line="24344">Tries to move the file or directory @source to the location specified by @destination. If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves @@ -47098,26 +48058,26 @@ move operation isn't available). %TRUE on successful move, %FALSE otherwise. + line="24391">%TRUE on successful move, %FALSE otherwise. #GFile pointing to the source location + line="24346">#GFile pointing to the source location #GFile pointing to the destination location + line="24347">#GFile pointing to the destination location set of #GFileCopyFlags + line="24348">set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="24349">optional #GCancellable object, %NULL to ignore @@ -47138,7 +48098,7 @@ move operation isn't available). closure="4"> #GFileProgressCallback + line="24351">#GFileProgressCallback function for updates @@ -47148,7 +48108,7 @@ move operation isn't available). allow-none="1"> gpointer to user data for + line="24353">gpointer to user data for the callback function @@ -47160,7 +48120,7 @@ move operation isn't available). throws="1"> Opens an existing file for reading and writing. The result is + line="24509">Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file. @@ -47180,7 +48140,7 @@ for reading or writing. #GFileIOStream or %NULL on error. + line="24532">#GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -47188,7 +48148,7 @@ for reading or writing. #GFile to open + line="24511">#GFile to open allow-none="1"> a #GCancellable + line="24512">a #GCancellable @@ -47207,7 +48167,7 @@ for reading or writing. version="2.22"> Asynchronously opens @file for reading and writing. + line="24538">Asynchronously opens @file for reading and writing. For more details, see g_file_open_readwrite() which is the synchronous version of this call. @@ -47223,13 +48183,13 @@ the result of the operation. input #GFile + line="24540">input #GFile the [I/O priority][io-priority] of the request + line="24541">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24542">optional #GCancellable object, %NULL to ignore @@ -47250,7 +48210,7 @@ the result of the operation. closure="3"> a #GAsyncReadyCallback to call + line="24544">a #GAsyncReadyCallback to call when the request is satisfied @@ -47260,7 +48220,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="24546">the data to pass to callback function @@ -47271,13 +48231,13 @@ the result of the operation. throws="1"> Finishes an asynchronous file read operation started with + line="24561">Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). a #GFileIOStream or %NULL on error. + line="24570">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -47285,13 +48245,13 @@ g_file_open_readwrite_async(). input #GFile + line="24563">input #GFile a #GAsyncResult + line="24564">a #GAsyncResult @@ -47299,7 +48259,7 @@ g_file_open_readwrite_async(). Exactly like g_file_get_path(), but caches the result via + line="24661">Exactly like g_file_get_path(), but caches the result via g_object_set_qdata_full(). This is useful for example in C applications which mix `g_file_*` APIs with native ones. It also avoids an extra duplicated string when possible, so will be @@ -47310,7 +48270,7 @@ This call does no blocking I/O. string containing the #GFile's path, + line="24673">string containing the #GFile's path, or %NULL if no such path exists. The returned string is owned by @file. @@ -47318,7 +48278,7 @@ This call does no blocking I/O. input #GFile + line="24663">input #GFile @@ -47328,7 +48288,7 @@ This call does no blocking I/O. version="2.22"> Polls a file of type #G_FILE_TYPE_MOUNTABLE. + line="24679">Polls a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -47337,7 +48297,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + @@ -47345,7 +48305,7 @@ the result of the operation. input #GFile + line="24681">input #GFile allow-none="1"> optional #GCancellable object, %NULL to ignore + line="24682">optional #GCancellable object, %NULL to ignore closure="2"> a #GAsyncReadyCallback to call + line="24683">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -47375,7 +48335,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="24685">the data to pass to callback function @@ -47386,15 +48346,15 @@ the result of the operation. throws="1"> Finishes a poll operation. See g_file_poll_mountable() for details. + line="24701">Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable(). - + %TRUE if the operation finished successfully. %FALSE + line="24712">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -47402,13 +48362,13 @@ otherwise. input #GFile + line="24703">input #GFile a #GAsyncResult + line="24704">a #GAsyncResult @@ -47418,17 +48378,17 @@ otherwise. throws="1"> Returns the #GAppInfo that is registered as the default + line="24718">Returns the #GAppInfo that is registered as the default application to handle the file specified by @file. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GAppInfo if the handle was found, + line="24731">a #GAppInfo if the handle was found, %NULL if there were errors. When you are done with it, release it with g_object_unref() @@ -47437,7 +48397,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile to open + line="24720">a #GFile to open allow-none="1"> optional #GCancellable object, %NULL to ignore + line="24721">optional #GCancellable object, %NULL to ignore @@ -47456,8 +48416,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.60"> Async version of g_file_query_default_handler(). - + line="24737">Async version of g_file_query_default_handler(). + @@ -47465,13 +48425,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile to open + line="24739">a #GFile to open the [I/O priority][io-priority] of the request + line="24740">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore + line="24741">optional #GCancellable object, %NULL to ignore closure="3"> a #GAsyncReadyCallback to call when the request is done + line="24742">a #GAsyncReadyCallback to call when the request is done allow-none="1"> data to pass to @callback + line="24743">data to pass to @callback @@ -47511,12 +48471,12 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes a g_file_query_default_handler_async() operation. - + line="24751">Finishes a g_file_query_default_handler_async() operation. + a #GAppInfo if the handle was found, + line="24759">a #GAppInfo if the handle was found, %NULL if there were errors. When you are done with it, release it with g_object_unref() @@ -47525,13 +48485,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile to open + line="24753">a #GFile to open a #GAsyncResult + line="24754">a #GAsyncResult @@ -47539,7 +48499,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Utility function to check if a particular file exists. This is + line="24766">Utility function to check if a particular file exists. This is implemented using g_file_query_info() and as such does blocking I/O. Note that in many cases it is [racy to first check for file existence](https://en.wikipedia.org/wiki/Time_of_check_to_time_of_use) @@ -47565,7 +48525,7 @@ that can happen due to races when you execute the operation. %TRUE if the file exists (and can be detected without error), + line="24795">%TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled). @@ -47573,7 +48533,7 @@ that can happen due to races when you execute the operation. input #GFile + line="24768">input #GFile allow-none="1"> optional #GCancellable object, + line="24769">optional #GCancellable object, %NULL to ignore @@ -47593,7 +48553,7 @@ that can happen due to races when you execute the operation. version="2.18"> Utility function to inspect the #GFileType of a file. This is + line="24800">Utility function to inspect the #GFileType of a file. This is implemented using g_file_query_info() and as such does blocking I/O. The primary use case of this method is to check if a file is @@ -47602,7 +48562,7 @@ a regular file, directory, or symlink. The #GFileType of the file and #G_FILE_TYPE_UNKNOWN + line="24813">The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file does not exist @@ -47610,13 +48570,13 @@ a regular file, directory, or symlink. input #GFile + line="24802">input #GFile a set of #GFileQueryInfoFlags passed to g_file_query_info() + line="24803">a set of #GFileQueryInfoFlags passed to g_file_query_info() allow-none="1"> optional #GCancellable object, + line="24804">optional #GCancellable object, %NULL to ignore @@ -47636,7 +48596,7 @@ a regular file, directory, or symlink. throws="1"> Similar to g_file_query_info(), but obtains information + line="24819">Similar to g_file_query_info(), but obtains information about the filesystem the @file is on, rather than the file itself. For instance the amount of space available and the type of the filesystem. @@ -47665,7 +48625,7 @@ kind of filesystem the file is on. a #GFileInfo or %NULL if there was an error. + line="24853">a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -47673,13 +48633,13 @@ kind of filesystem the file is on. input #GFile + line="24821">input #GFile an attribute query string + line="24822">an attribute query string allow-none="1"> optional #GCancellable object, + line="24823">optional #GCancellable object, %NULL to ignore @@ -47698,7 +48658,7 @@ kind of filesystem the file is on. c:identifier="g_file_query_filesystem_info_async"> Asynchronously gets the requested information about the filesystem + line="24858">Asynchronously gets the requested information about the filesystem that the specified @file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -47717,19 +48677,19 @@ operation. input #GFile + line="24860">input #GFile an attribute query string + line="24861">an attribute query string the [I/O priority][io-priority] of the request + line="24862">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24863">optional #GCancellable object, %NULL to ignore @@ -47750,7 +48710,7 @@ operation. closure="4"> a #GAsyncReadyCallback to call + line="24865">a #GAsyncReadyCallback to call when the request is satisfied @@ -47760,7 +48720,7 @@ operation. allow-none="1"> the data to pass to callback function + line="24867">the data to pass to callback function @@ -47770,13 +48730,13 @@ operation. throws="1"> Finishes an asynchronous filesystem info query. + line="24883">Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async(). #GFileInfo for given @file + line="24892">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -47785,13 +48745,13 @@ See g_file_query_filesystem_info_async(). input #GFile + line="24885">input #GFile a #GAsyncResult + line="24886">a #GAsyncResult @@ -47799,7 +48759,7 @@ See g_file_query_filesystem_info_async(). Gets the requested information about specified @file. + line="24898">Gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file). @@ -47833,7 +48793,7 @@ filesystem the file is on. a #GFileInfo for the given @file, or %NULL + line="24938">a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -47841,19 +48801,19 @@ filesystem the file is on. input #GFile + line="24900">input #GFile an attribute query string + line="24901">an attribute query string a set of #GFileQueryInfoFlags + line="24902">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="24903">optional #GCancellable object, %NULL to ignore @@ -47871,7 +48831,7 @@ filesystem the file is on. Asynchronously gets the requested information about specified @file. + line="24943">Asynchronously gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -47888,25 +48848,25 @@ then call g_file_query_info_finish() to get the result of the operation. input #GFile + line="24945">input #GFile an attribute query string + line="24946">an attribute query string a set of #GFileQueryInfoFlags + line="24947">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="24948">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24949">optional #GCancellable object, %NULL to ignore @@ -47927,7 +48887,7 @@ then call g_file_query_info_finish() to get the result of the operation. closure="5"> a #GAsyncReadyCallback to call when the + line="24951">a #GAsyncReadyCallback to call when the request is satisfied @@ -47937,7 +48897,7 @@ then call g_file_query_info_finish() to get the result of the operation. allow-none="1"> the data to pass to callback function + line="24953">the data to pass to callback function @@ -47947,13 +48907,13 @@ then call g_file_query_info_finish() to get the result of the operation. throws="1"> Finishes an asynchronous file info query. + line="24967">Finishes an asynchronous file info query. See g_file_query_info_async(). #GFileInfo for given @file + line="24976">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -47962,13 +48922,13 @@ See g_file_query_info_async(). input #GFile + line="24969">input #GFile a #GAsyncResult + line="24970">a #GAsyncResult @@ -47978,7 +48938,7 @@ See g_file_query_info_async(). throws="1"> Obtain the list of settable attributes for the file. + line="24982">Obtain the list of settable attributes for the file. Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will @@ -47992,7 +48952,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFileAttributeInfoList describing the settable attributes. + line="25000">a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -48001,7 +48961,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="24984">input #GFile allow-none="1"> optional #GCancellable object, + line="24985">optional #GCancellable object, %NULL to ignore @@ -48021,7 +48981,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Obtain the list of attribute namespaces where new attributes + line="25006">Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace). @@ -48032,7 +48992,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFileAttributeInfoList describing the writable namespaces. + line="25021">a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -48041,7 +49001,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25008">input #GFile allow-none="1"> optional #GCancellable object, + line="25009">optional #GCancellable object, %NULL to ignore @@ -48059,7 +49019,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Opens a file for reading. The result is a #GFileInputStream that + line="25027">Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -48074,7 +49034,7 @@ on what kind of filesystem the file is on. #GFileInputStream or %NULL on error. + line="25045">#GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -48082,7 +49042,7 @@ on what kind of filesystem the file is on. #GFile to read + line="25029">#GFile to read allow-none="1"> a #GCancellable + line="25030">a #GCancellable @@ -48099,7 +49059,7 @@ on what kind of filesystem the file is on. Asynchronously opens @file for reading. + line="25050">Asynchronously opens @file for reading. For more details, see g_file_read() which is the synchronous version of this call. @@ -48115,13 +49075,13 @@ of the operation. input #GFile + line="25052">input #GFile the [I/O priority][io-priority] of the request + line="25053">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25054">optional #GCancellable object, %NULL to ignore @@ -48142,7 +49102,7 @@ of the operation. closure="3"> a #GAsyncReadyCallback to call + line="25056">a #GAsyncReadyCallback to call when the request is satisfied @@ -48152,7 +49112,7 @@ of the operation. allow-none="1"> the data to pass to callback function + line="25058">the data to pass to callback function @@ -48160,13 +49120,13 @@ of the operation. Finishes an asynchronous file read operation started with + line="25071">Finishes an asynchronous file read operation started with g_file_read_async(). a #GFileInputStream or %NULL on error. + line="25080">a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -48174,13 +49134,13 @@ g_file_read_async(). input #GFile + line="25073">input #GFile a #GAsyncResult + line="25074">a #GAsyncResult @@ -48188,7 +49148,7 @@ g_file_read_async(). Returns an output stream for overwriting the file, possibly + line="25085">Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -48233,7 +49193,7 @@ possible too, and depend on what kind of filesystem the file is on. a #GFileOutputStream or %NULL on error. + line="25138">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -48241,7 +49201,7 @@ possible too, and depend on what kind of filesystem the file is on. input #GFile + line="25087">input #GFile allow-none="1"> an optional [entity tag][gfile-etag] + line="25088">an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + line="25090">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25091">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="25092">optional #GCancellable object, %NULL to ignore @@ -48281,7 +49241,7 @@ possible too, and depend on what kind of filesystem the file is on. Asynchronously overwrites the file, replacing the contents, + line="25143">Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first. For more details, see g_file_replace() which is @@ -48298,7 +49258,7 @@ of the operation. input #GFile + line="25145">input #GFile allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + line="25146">an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + line="25148">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25149">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="25150">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25151">optional #GCancellable object, %NULL to ignore @@ -48347,7 +49307,7 @@ of the operation. closure="6"> a #GAsyncReadyCallback to call + line="25153">a #GAsyncReadyCallback to call when the request is satisfied @@ -48357,7 +49317,7 @@ of the operation. allow-none="1"> the data to pass to callback function + line="25155">the data to pass to callback function @@ -48367,7 +49327,7 @@ of the operation. throws="1"> Replaces the contents of @file with @contents of @length bytes. + line="25169">Replaces the contents of @file with @contents of @length bytes. If @etag is specified (not %NULL), any existing file must have that etag, or the error %G_IO_ERROR_WRONG_ETAG will be returned. @@ -48383,11 +49343,11 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. The returned @new_etag can be used to verify that the file hasn't changed the next time it is saved over. - + %TRUE if successful. If an error has occurred, this function + line="25201">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -48395,13 +49355,13 @@ changed the next time it is saved over. input #GFile + line="25171">input #GFile a string containing the new contents for @file + line="25172">a string containing the new contents for @file @@ -48409,7 +49369,7 @@ changed the next time it is saved over. the length of @contents in bytes + line="25173">the length of @contents in bytes allow-none="1"> the old [entity-tag][gfile-etag] for the document, + line="25174">the old [entity-tag][gfile-etag] for the document, or %NULL %TRUE if a backup should be created + line="25176">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25177">a set of #GFileCreateFlags a location to a new [entity tag][gfile-etag] + line="25178">a location to a new [entity tag][gfile-etag] for the document. This should be freed with g_free() when no longer needed, or %NULL @@ -48453,7 +49414,7 @@ changed the next time it is saved over. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="25181">optional #GCancellable object, %NULL to ignore @@ -48462,7 +49423,7 @@ changed the next time it is saved over. c:identifier="g_file_replace_contents_async"> Starts an asynchronous replacement of @file with the given + line="25206">Starts an asynchronous replacement of @file with the given @contents of @length bytes. @etag will replace the document's current entity tag. @@ -48481,7 +49442,7 @@ Note that no copy of @contents will be made, so it must stay valid until @callback is called. See g_file_replace_contents_bytes_async() for a #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call. - + @@ -48489,13 +49450,13 @@ contents (without copying) for the duration of the call. input #GFile + line="25208">input #GFile string of contents to replace the file with + line="25209">string of contents to replace the file with @@ -48503,7 +49464,7 @@ contents (without copying) for the duration of the call. the length of @contents in bytes + line="25210">the length of @contents in bytes allow-none="1"> a new [entity tag][gfile-etag] for the @file, or %NULL + line="25211">a new [entity tag][gfile-etag] for the @file, or %NULL %TRUE if a backup should be created + line="25212">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25213">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, %NULL to ignore + line="25214">optional #GCancellable object, %NULL to ignore closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + line="25215">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="25216">the data to pass to callback function @@ -48563,7 +49524,7 @@ contents (without copying) for the duration of the call. version="2.40"> Same as g_file_replace_contents_async() but takes a #GBytes input instead. + line="25240">Same as g_file_replace_contents_async() but takes a #GBytes input instead. This function will keep a ref on @contents until the operation is done. Unlike g_file_replace_contents_async() this allows forgetting about the content without waiting for the callback. @@ -48571,7 +49532,7 @@ content without waiting for the callback. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_replace_contents_finish(). - + @@ -48579,13 +49540,13 @@ g_file_replace_contents_finish(). input #GFile + line="25242">input #GFile a #GBytes + line="25243">a #GBytes allow-none="1"> a new [entity tag][gfile-etag] for the @file, or %NULL + line="25244">a new [entity tag][gfile-etag] for the @file, or %NULL %TRUE if a backup should be created + line="25245">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25246">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, %NULL to ignore + line="25247">optional #GCancellable object, %NULL to ignore closure="6"> a #GAsyncReadyCallback to call when the request is satisfied + line="25248">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="25249">the data to pass to callback function @@ -48645,38 +49606,39 @@ g_file_replace_contents_finish(). throws="1"> Finishes an asynchronous replace of the given @file. See + line="25264">Finishes an asynchronous replace of the given @file. See g_file_replace_contents_async(). Sets @new_etag to the new entity tag for the document, if present. - + %TRUE on success, %FALSE on failure. + line="25277">%TRUE on success, %FALSE on failure. input #GFile + line="25266">input #GFile a #GAsyncResult + line="25267">a #GAsyncResult a location of a new [entity tag][gfile-etag] + line="25268">a location of a new [entity tag][gfile-etag] for the document. This should be freed with g_free() when it is no longer needed, or %NULL @@ -48688,13 +49650,13 @@ tag for the document, if present. throws="1"> Finishes an asynchronous file replace operation started with + line="25281">Finishes an asynchronous file replace operation started with g_file_replace_async(). a #GFileOutputStream, or %NULL on error. + line="25290">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -48702,13 +49664,13 @@ g_file_replace_async(). input #GFile + line="25283">input #GFile a #GAsyncResult + line="25284">a #GAsyncResult @@ -48719,7 +49681,7 @@ g_file_replace_async(). throws="1"> Returns an output stream for overwriting the file in readwrite mode, + line="25295">Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -48733,7 +49695,7 @@ rather than just opening for reading or writing. a #GFileIOStream or %NULL on error. + line="25317">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -48741,7 +49703,7 @@ rather than just opening for reading or writing. a #GFile + line="25297">a #GFile allow-none="1"> an optional [entity tag][gfile-etag] + line="25298">an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + line="25300">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25301">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="25302">optional #GCancellable object, %NULL to ignore @@ -48783,7 +49745,7 @@ rather than just opening for reading or writing. version="2.22"> Asynchronously overwrites the file in read-write mode, + line="25323">Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first. @@ -48801,7 +49763,7 @@ the result of the operation. input #GFile + line="25325">input #GFile allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + line="25326">an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + line="25328">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25329">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="25330">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25331">optional #GCancellable object, %NULL to ignore @@ -48850,7 +49812,7 @@ the result of the operation. closure="6"> a #GAsyncReadyCallback to call + line="25333">a #GAsyncReadyCallback to call when the request is satisfied @@ -48860,7 +49822,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="25335">the data to pass to callback function @@ -48871,13 +49833,13 @@ the result of the operation. throws="1"> Finishes an asynchronous file replace operation started with + line="25352">Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). a #GFileIOStream, or %NULL on error. + line="25361">a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -48885,13 +49847,13 @@ g_file_replace_readwrite_async(). input #GFile + line="25354">input #GFile a #GAsyncResult + line="25355">a #GAsyncResult @@ -48900,14 +49862,14 @@ g_file_replace_readwrite_async(). c:identifier="g_file_resolve_relative_path"> Resolves a relative path for @file to an absolute path. + line="25367">Resolves a relative path for @file to an absolute path. This call does no blocking I/O. #GFile to the resolved path. + line="25376">#GFile to the resolved path. %NULL if @relative_path is %NULL or if @file is invalid. Free the returned object with g_object_unref(). @@ -48916,13 +49878,13 @@ This call does no blocking I/O. input #GFile + line="25369">input #GFile a given relative path string + line="25370">a given relative path string @@ -48932,7 +49894,7 @@ This call does no blocking I/O. throws="1"> Sets an attribute in the file with attribute name @attribute to @value_p. + line="25382">Sets an attribute in the file with attribute name @attribute to @value_p. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. @@ -48944,26 +49906,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the attribute was set, %FALSE otherwise. + line="25403">%TRUE if the attribute was set, %FALSE otherwise. input #GFile + line="25384">input #GFile a string containing the attribute's name + line="25385">a string containing the attribute's name The type of the attribute + line="25386">The type of the attribute allow-none="1"> a pointer to the value (or the pointer + line="25387">a pointer to the value (or the pointer itself if the type is a pointer type) a set of #GFileQueryInfoFlags + line="25389">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25390">optional #GCancellable object, %NULL to ignore @@ -48999,7 +49961,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. + line="25407">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. If @attribute is of a different type, this operation will fail, returning %FALSE. @@ -49010,7 +49972,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the @attribute was successfully set to @value + line="25425">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. @@ -49018,25 +49980,25 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25409">input #GFile a string containing the attribute's name + line="25410">a string containing the attribute's name a string containing the attribute's new value + line="25411">a string containing the attribute's new value a #GFileQueryInfoFlags + line="25412">a #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25413">optional #GCancellable object, %NULL to ignore @@ -49056,7 +50018,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. + line="25430">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -49066,7 +50028,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the @attribute was successfully set to @value + line="25447">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. @@ -49074,25 +50036,25 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25432">input #GFile a string containing the attribute's name + line="25433">a string containing the attribute's name a #gint32 containing the attribute's new value + line="25434">a #gint32 containing the attribute's new value a #GFileQueryInfoFlags + line="25435">a #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25436">optional #GCancellable object, %NULL to ignore @@ -49112,7 +50074,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. + line="25452">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -49122,32 +50084,32 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the @attribute was successfully set, %FALSE otherwise. + line="25469">%TRUE if the @attribute was successfully set, %FALSE otherwise. input #GFile + line="25454">input #GFile a string containing the attribute's name + line="25455">a string containing the attribute's name a #guint64 containing the attribute's new value + line="25456">a #guint64 containing the attribute's new value a #GFileQueryInfoFlags + line="25457">a #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25458">optional #GCancellable object, %NULL to ignore @@ -49167,7 +50129,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. + line="25473">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -49177,32 +50139,32 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the @attribute was successfully set, %FALSE otherwise. + line="25490">%TRUE if the @attribute was successfully set, %FALSE otherwise. input #GFile + line="25475">input #GFile a string containing the attribute's name + line="25476">a string containing the attribute's name a string containing the attribute's value + line="25477">a string containing the attribute's value #GFileQueryInfoFlags + line="25478">#GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25479">optional #GCancellable object, %NULL to ignore @@ -49222,7 +50184,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. + line="25494">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -49232,7 +50194,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the @attribute was successfully set to @value + line="25511">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. @@ -49240,25 +50202,25 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25496">input #GFile a string containing the attribute's name + line="25497">a string containing the attribute's name a #guint32 containing the attribute's new value + line="25498">a #guint32 containing the attribute's new value a #GFileQueryInfoFlags + line="25499">a #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25500">optional #GCancellable object, %NULL to ignore @@ -49278,7 +50240,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. + line="25516">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -49288,7 +50250,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if the @attribute was successfully set to @value + line="25533">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. @@ -49296,25 +50258,25 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25518">input #GFile a string containing the attribute's name + line="25519">a string containing the attribute's name a #guint64 containing the attribute's new value + line="25520">a #guint64 containing the attribute's new value a #GFileQueryInfoFlags + line="25521">a #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25522">optional #GCancellable object, %NULL to ignore @@ -49333,7 +50295,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attributes_async"> Asynchronously sets the attributes of @file with @info. + line="25538">Asynchronously sets the attributes of @file with @info. For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call. @@ -49349,25 +50311,25 @@ the result of the operation. input #GFile + line="25540">input #GFile a #GFileInfo + line="25541">a #GFileInfo a #GFileQueryInfoFlags + line="25542">a #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="25543">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25544">optional #GCancellable object, %NULL to ignore @@ -49388,7 +50350,7 @@ the result of the operation. closure="5"> a #GAsyncReadyCallback + line="25546">a #GAsyncReadyCallback allow-none="1"> a #gpointer + line="25547">a #gpointer @@ -49407,25 +50369,25 @@ the result of the operation. throws="1"> Finishes setting an attribute started in g_file_set_attributes_async(). + line="25560">Finishes setting an attribute started in g_file_set_attributes_async(). %TRUE if the attributes were set correctly, %FALSE otherwise. + line="25569">%TRUE if the attributes were set correctly, %FALSE otherwise. input #GFile + line="25562">input #GFile a #GAsyncResult + line="25563">a #GAsyncResult transfer-ownership="full"> a #GFileInfo + line="25564">a #GFileInfo @@ -49444,7 +50406,7 @@ the result of the operation. throws="1"> Tries to set all attributes in the #GFileInfo on the target + line="25573">Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error. If there is any error during this operation then @error will @@ -49460,26 +50422,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %FALSE if there was any error, %TRUE otherwise. + line="25595">%FALSE if there was any error, %TRUE otherwise. input #GFile + line="25575">input #GFile a #GFileInfo + line="25576">a #GFileInfo #GFileQueryInfoFlags + line="25577">#GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25578">optional #GCancellable object, %NULL to ignore @@ -49499,7 +50461,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Renames @file to the specified display name. + line="25599">Renames @file to the specified display name. The display name is converted from UTF-8 to the correct encoding for the target filesystem if possible and the @file is renamed to this. @@ -49518,7 +50480,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile specifying what @file was renamed to, + line="25623">a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -49527,13 +50489,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25601">input #GFile a string + line="25602">a string allow-none="1"> optional #GCancellable object, + line="25603">optional #GCancellable object, %NULL to ignore @@ -49552,7 +50514,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_display_name_async"> Asynchronously sets the display name for a given #GFile. + line="25629">Asynchronously sets the display name for a given #GFile. For more details, see g_file_set_display_name() which is the synchronous version of this call. @@ -49568,19 +50530,19 @@ the result of the operation. input #GFile + line="25631">input #GFile a string + line="25632">a string the [I/O priority][io-priority] of the request + line="25633">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25634">optional #GCancellable object, %NULL to ignore @@ -49601,7 +50563,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="25636">a #GAsyncReadyCallback to call when the request is satisfied @@ -49611,7 +50573,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="25638">the data to pass to callback function @@ -49621,13 +50583,13 @@ the result of the operation. throws="1"> Finishes setting a display name started with + line="25651">Finishes setting a display name started with g_file_set_display_name_async(). a #GFile or %NULL on error. + line="25660">a #GFile or %NULL on error. Free the returned object with g_object_unref(). @@ -49635,13 +50597,13 @@ g_file_set_display_name_async(). input #GFile + line="25653">input #GFile a #GAsyncResult + line="25654">a #GAsyncResult @@ -49651,7 +50613,7 @@ g_file_set_display_name_async(). version="2.22"> Starts a file of type #G_FILE_TYPE_MOUNTABLE. + line="25665">Starts a file of type #G_FILE_TYPE_MOUNTABLE. Using @start_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -49662,7 +50624,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + @@ -49670,13 +50632,13 @@ the result of the operation. input #GFile + line="25667">input #GFile flags affecting the operation + line="25668">flags affecting the operation allow-none="1"> a #GMountOperation, or %NULL to avoid user interaction + line="25669">a #GMountOperation, or %NULL to avoid user interaction allow-none="1"> optional #GCancellable object, %NULL to ignore + line="25670">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + line="25671">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL allow-none="1"> the data to pass to callback function + line="25672">the data to pass to callback function @@ -49725,15 +50687,15 @@ the result of the operation. throws="1"> Finishes a start operation. See g_file_start_mountable() for details. + line="25690">Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). - + %TRUE if the operation finished successfully. %FALSE + line="25701">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -49741,13 +50703,13 @@ otherwise. input #GFile + line="25692">input #GFile a #GAsyncResult + line="25693">a #GAsyncResult @@ -49757,7 +50719,7 @@ otherwise. version="2.22"> Stops a file of type #G_FILE_TYPE_MOUNTABLE. + line="25707">Stops a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -49766,7 +50728,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_stop_mountable_finish() to get the result of the operation. - + @@ -49774,13 +50736,13 @@ the result of the operation. input #GFile + line="25709">input #GFile flags affecting the operation + line="25710">flags affecting the operation allow-none="1"> a #GMountOperation, + line="25711">a #GMountOperation, or %NULL to avoid user interaction. @@ -49799,7 +50761,7 @@ the result of the operation. allow-none="1"> optional #GCancellable object, + line="25713">optional #GCancellable object, %NULL to ignore @@ -49811,7 +50773,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="25715">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -49821,7 +50783,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="25717">the data to pass to callback function @@ -49832,15 +50794,15 @@ the result of the operation. throws="1"> Finishes a stop operation, see g_file_stop_mountable() for details. + line="25733">Finishes a stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). - + %TRUE if the operation finished successfully. + line="25744">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -49848,13 +50810,13 @@ with g_file_stop_mountable(). input #GFile + line="25735">input #GFile a #GAsyncResult + line="25736">a #GAsyncResult @@ -49864,22 +50826,22 @@ with g_file_stop_mountable(). version="2.22"> Checks if @file supports + line="25750">Checks if @file supports [thread-default contexts][g-main-context-push-thread-default-context]. If this returns %FALSE, you cannot perform asynchronous operations on @file in a thread that has a thread-default context. - + Whether or not @file supports thread-default contexts. + line="25759">Whether or not @file supports thread-default contexts. a #GFile + line="25752">a #GFile @@ -49887,7 +50849,7 @@ If this returns %FALSE, you cannot perform asynchronous operations on Sends @file to the "Trashcan", if possible. This is similar to + line="25764">Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Not all file systems support trashing, so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the `x-gvfs-notrash` unix @@ -49901,14 +50863,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on successful trash, %FALSE otherwise. + line="25782">%TRUE on successful trash, %FALSE otherwise. #GFile to send to trash + line="25766">#GFile to send to trash allow-none="1"> optional #GCancellable object, + line="25767">optional #GCancellable object, %NULL to ignore @@ -49928,7 +50890,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38"> Asynchronously sends @file to the Trash location, if possible. + line="25786">Asynchronously sends @file to the Trash location, if possible. @@ -49937,13 +50899,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + line="25788">input #GFile the [I/O priority][io-priority] of the request + line="25789">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25790">optional #GCancellable object, %NULL to ignore @@ -49964,7 +50926,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. closure="3"> a #GAsyncReadyCallback to call + line="25792">a #GAsyncReadyCallback to call when the request is satisfied @@ -49974,7 +50936,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1"> the data to pass to callback function + line="25794">the data to pass to callback function @@ -49985,26 +50947,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. throws="1"> Finishes an asynchronous file trashing operation, started with + line="25802">Finishes an asynchronous file trashing operation, started with g_file_trash_async(). %TRUE on successful trash, %FALSE otherwise. + line="25811">%TRUE on successful trash, %FALSE otherwise. input #GFile + line="25804">input #GFile a #GAsyncResult + line="25805">a #GAsyncResult @@ -50015,7 +50977,7 @@ g_file_trash_async(). deprecated-version="2.22"> Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + line="25816">Unmounts a file of type G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -50033,13 +50995,13 @@ the result of the operation. input #GFile + line="25818">input #GFile flags affecting the operation + line="25819">flags affecting the operation allow-none="1"> optional #GCancellable object, + line="25820">optional #GCancellable object, %NULL to ignore @@ -50060,7 +51022,7 @@ the result of the operation. closure="3"> a #GAsyncReadyCallback to call + line="25822">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -50070,7 +51032,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="25824">the data to pass to callback function @@ -50082,7 +51044,7 @@ the result of the operation. throws="1"> Finishes an unmount operation, see g_file_unmount_mountable() for details. + line="25840">Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable(). @@ -50092,7 +51054,7 @@ with g_file_unmount_mountable(). %TRUE if the operation finished successfully. + line="25851">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -50100,13 +51062,13 @@ with g_file_unmount_mountable(). input #GFile + line="25842">input #GFile a #GAsyncResult + line="25843">a #GAsyncResult @@ -50116,7 +51078,7 @@ with g_file_unmount_mountable(). version="2.22"> Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. + line="25858">Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -50133,13 +51095,13 @@ the result of the operation. input #GFile + line="25860">input #GFile flags affecting the operation + line="25861">flags affecting the operation allow-none="1"> a #GMountOperation, + line="25862">a #GMountOperation, or %NULL to avoid user interaction @@ -50158,7 +51120,7 @@ the result of the operation. allow-none="1"> optional #GCancellable object, + line="25864">optional #GCancellable object, %NULL to ignore @@ -50170,7 +51132,7 @@ the result of the operation. closure="4"> a #GAsyncReadyCallback to call + line="25866">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -50180,7 +51142,7 @@ the result of the operation. allow-none="1"> the data to pass to callback function + line="25868">the data to pass to callback function @@ -50191,7 +51153,7 @@ the result of the operation. throws="1"> Finishes an unmount operation, + line="25884">Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started @@ -50200,7 +51162,7 @@ with g_file_unmount_mountable_with_operation(). %TRUE if the operation finished successfully. + line="25896">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -50208,13 +51170,13 @@ with g_file_unmount_mountable_with_operation(). input #GFile + line="25886">input #GFile a #GAsyncResult + line="25887">a #GAsyncResult @@ -50254,7 +51216,8 @@ with g_file_unmount_mountable_with_operation(). + glib:nick="none" + glib:name="G_FILE_ATTRIBUTE_INFO_NONE"> no flags set. @@ -50262,7 +51225,8 @@ with g_file_unmount_mountable_with_operation(). + glib:nick="copy-with-file" + glib:name="G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE"> copy the attribute values when the file is copied. @@ -50270,7 +51234,8 @@ with g_file_unmount_mountable_with_operation(). + glib:nick="copy-when-moved" + glib:name="G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED"> copy the attribute values when the file is moved. @@ -50301,19 +51266,19 @@ The registry stores Key-Value pair formats as #GFileAttributeInfos. Creates a new file attribute info list. + line="21510">Creates a new file attribute info list. a #GFileAttributeInfoList. + line="21515">a #GFileAttributeInfoList. Adds a new attribute with @name to the @list, setting + line="21476">Adds a new attribute with @name to the @list, setting its @type and @flags. @@ -50323,26 +51288,26 @@ its @type and @flags. a #GFileAttributeInfoList. + line="21478">a #GFileAttributeInfoList. the name of the attribute to add. + line="21479">the name of the attribute to add. the #GFileAttributeType for the attribute. + line="21480">the #GFileAttributeType for the attribute. #GFileAttributeInfoFlags for the attribute. + line="21481">#GFileAttributeInfoFlags for the attribute. @@ -50351,19 +51316,19 @@ its @type and @flags. Makes a duplicate of a file attribute info list. + line="21488">Makes a duplicate of a file attribute info list. a copy of the given @list. + line="21494">a copy of the given @list. a #GFileAttributeInfoList to duplicate. + line="21490">a #GFileAttributeInfoList to duplicate. @@ -50372,12 +51337,12 @@ its @type and @flags. Gets the file attribute with the name @name from @list. + line="21498">Gets the file attribute with the name @name from @list. a #GFileAttributeInfo for the @name, or %NULL if an + line="21505">a #GFileAttributeInfo for the @name, or %NULL if an attribute isn't found. @@ -50385,14 +51350,14 @@ attribute isn't found. a #GFileAttributeInfoList. + line="21500">a #GFileAttributeInfoList. the name of the attribute to look up. + line="21501">the name of the attribute to look up. @@ -50400,19 +51365,19 @@ attribute isn't found. References a file attribute info list. + line="21519">References a file attribute info list. #GFileAttributeInfoList or %NULL on error. + line="21525">#GFileAttributeInfoList or %NULL on error. a #GFileAttributeInfoList to reference. + line="21521">a #GFileAttributeInfoList to reference. @@ -50421,7 +51386,7 @@ attribute isn't found. Removes a reference from the given @list. If the reference count + line="21529">Removes a reference from the given @list. If the reference count falls to zero, the @list is deleted. @@ -50431,7 +51396,7 @@ falls to zero, the @list is deleted. The #GFileAttributeInfoList to unreference. + line="21531">The #GFileAttributeInfoList to unreference. @@ -50450,7 +51415,7 @@ falls to zero, the @list is deleted. Creates a new file attribute matcher, which matches attributes + line="21591">Creates a new file attribute matcher, which matches attributes against a given string. #GFileAttributeMatchers are reference counted structures, and are created with a reference count of 1. If the number of references falls to 0, the #GFileAttributeMatcher is @@ -50469,18 +51434,18 @@ The wildcard "*" may be used to match all keys and namespaces, or standard namespace. - `"standard::type,unix::*"`: matches the type key in the standard namespace and all keys in the unix namespace. - + a #GFileAttributeMatcher + line="21615">a #GFileAttributeMatcher an attribute string to match. + line="21593">an attribute string to match. @@ -50489,17 +51454,17 @@ The wildcard "*" may be used to match all keys and namespaces, or c:identifier="g_file_attribute_matcher_enumerate_namespace"> Checks if the matcher will match all of the keys in a given namespace. + line="21538">Checks if the matcher will match all of the keys in a given namespace. This will always return %TRUE if a wildcard character is in use (e.g. if matcher was created with "standard::*" and @ns is "standard", or if matcher was created using "*" and namespace is anything.) TODO: this is awkwardly worded. - + %TRUE if the matcher matches all of the entries + line="21550">%TRUE if the matcher matches all of the entries in the given @ns, %FALSE otherwise. @@ -50507,13 +51472,13 @@ in the given @ns, %FALSE otherwise. a #GFileAttributeMatcher. + line="21540">a #GFileAttributeMatcher. a string containing a file attribute namespace. + line="21541">a string containing a file attribute namespace. @@ -50522,12 +51487,12 @@ in the given @ns, %FALSE otherwise. c:identifier="g_file_attribute_matcher_enumerate_next"> Gets the next matched attribute from a #GFileAttributeMatcher. - + line="21555">Gets the next matched attribute from a #GFileAttributeMatcher. + a string containing the next attribute or, %NULL if + line="21561">a string containing the next attribute or, %NULL if no more attribute exist. @@ -50535,7 +51500,7 @@ no more attribute exist. a #GFileAttributeMatcher. + line="21557">a #GFileAttributeMatcher. @@ -50543,27 +51508,27 @@ no more attribute exist. Checks if an attribute will be matched by an attribute matcher. If + line="21566">Checks if an attribute will be matched by an attribute matcher. If the matcher was created with the "*" matching string, this function will always return %TRUE. - + %TRUE if @attribute matches @matcher. %FALSE otherwise. + line="21575">%TRUE if @attribute matches @matcher. %FALSE otherwise. a #GFileAttributeMatcher. + line="21568">a #GFileAttributeMatcher. a file attribute key. + line="21569">a file attribute key. @@ -50572,26 +51537,26 @@ will always return %TRUE. c:identifier="g_file_attribute_matcher_matches_only"> Checks if a attribute matcher only matches a given attribute. Always + line="21579">Checks if a attribute matcher only matches a given attribute. Always returns %FALSE if "*" was used when creating the matcher. - + %TRUE if the matcher only matches @attribute. %FALSE otherwise. + line="21587">%TRUE if the matcher only matches @attribute. %FALSE otherwise. a #GFileAttributeMatcher. + line="21581">a #GFileAttributeMatcher. a file attribute key. + line="21582">a file attribute key. @@ -50599,19 +51564,19 @@ returns %FALSE if "*" was used when creating the matcher. References a file attribute matcher. - + line="21619">References a file attribute matcher. + a #GFileAttributeMatcher. + line="21625">a #GFileAttributeMatcher. a #GFileAttributeMatcher. + line="21621">a #GFileAttributeMatcher. @@ -50619,7 +51584,7 @@ returns %FALSE if "*" was used when creating the matcher. Subtracts all attributes of @subtract from @matcher and returns + line="21629">Subtracts all attributes of @subtract from @matcher and returns a matcher that supports those attributes. Note that currently it is not possible to remove a single @@ -50627,25 +51592,31 @@ attribute when the @matcher matches the whole namespace - or remove a namespace or attribute when the matcher matches everything. This is a limitation of the current implementation, but may be fixed in the future. - - + + A file attribute matcher matching all attributes of + line="21643">A file attribute matcher matching all attributes of @matcher that are not matched by @subtract - + Matcher to subtract from + line="21631">Matcher to subtract from - + The matcher to subtract + line="21632">The matcher to subtract @@ -50655,15 +51626,15 @@ in the future. version="2.32"> Prints what the matcher is matching against. The format will be + line="21648">Prints what the matcher is matching against. The format will be equal to the format passed to g_file_attribute_matcher_new(). The output however, might not be identical, as the matcher may decide to use a different order or omit needless parts. - + a string describing the attributes the matcher matches + line="21657">a string describing the attributes the matcher matches against or %NULL if @matcher was %NULL. @@ -50674,7 +51645,7 @@ decide to use a different order or omit needless parts. allow-none="1"> a #GFileAttributeMatcher. + line="21650">a #GFileAttributeMatcher. @@ -50682,9 +51653,9 @@ decide to use a different order or omit needless parts. Unreferences @matcher. If the reference count falls below 1, + line="21663">Unreferences @matcher. If the reference count falls below 1, the @matcher is automatically freed. - + @@ -50692,7 +51663,7 @@ the @matcher is automatically freed. a #GFileAttributeMatcher. + line="21665">a #GFileAttributeMatcher. @@ -50708,7 +51679,8 @@ the @matcher is automatically freed. + glib:nick="unset" + glib:name="G_FILE_ATTRIBUTE_STATUS_UNSET"> Attribute value is unset (empty). @@ -50716,7 +51688,8 @@ the @matcher is automatically freed. + glib:nick="set" + glib:name="G_FILE_ATTRIBUTE_STATUS_SET"> Attribute value is set. @@ -50724,7 +51697,8 @@ the @matcher is automatically freed. + glib:nick="error-setting" + glib:name="G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING"> Indicates an error in setting the value. @@ -50740,7 +51714,8 @@ the @matcher is automatically freed. + glib:nick="invalid" + glib:name="G_FILE_ATTRIBUTE_TYPE_INVALID"> indicates an invalid or uninitialized type. @@ -50748,7 +51723,8 @@ the @matcher is automatically freed. + glib:nick="string" + glib:name="G_FILE_ATTRIBUTE_TYPE_STRING"> a null terminated UTF8 string. @@ -50756,7 +51732,8 @@ the @matcher is automatically freed. + glib:nick="byte-string" + glib:name="G_FILE_ATTRIBUTE_TYPE_BYTE_STRING"> a zero terminated string of non-zero bytes. @@ -50764,7 +51741,8 @@ the @matcher is automatically freed. + glib:nick="boolean" + glib:name="G_FILE_ATTRIBUTE_TYPE_BOOLEAN"> a boolean value. @@ -50772,7 +51750,8 @@ the @matcher is automatically freed. + glib:nick="uint32" + glib:name="G_FILE_ATTRIBUTE_TYPE_UINT32"> an unsigned 4-byte/32-bit integer. @@ -50780,7 +51759,8 @@ the @matcher is automatically freed. + glib:nick="int32" + glib:name="G_FILE_ATTRIBUTE_TYPE_INT32"> a signed 4-byte/32-bit integer. @@ -50788,7 +51768,8 @@ the @matcher is automatically freed. + glib:nick="uint64" + glib:name="G_FILE_ATTRIBUTE_TYPE_UINT64"> an unsigned 8-byte/64-bit integer. @@ -50796,7 +51777,8 @@ the @matcher is automatically freed. + glib:nick="int64" + glib:name="G_FILE_ATTRIBUTE_TYPE_INT64"> a signed 8-byte/64-bit integer. @@ -50804,7 +51786,8 @@ the @matcher is automatically freed. + glib:nick="object" + glib:name="G_FILE_ATTRIBUTE_TYPE_OBJECT"> a #GObject. @@ -50812,7 +51795,8 @@ the @matcher is automatically freed. + glib:nick="stringv" + glib:name="G_FILE_ATTRIBUTE_TYPE_STRINGV"> a %NULL terminated char **. Since 2.22 @@ -50828,7 +51812,8 @@ the @matcher is automatically freed. + glib:nick="none" + glib:name="G_FILE_COPY_NONE"> No flags set. @@ -50836,7 +51821,8 @@ the @matcher is automatically freed. + glib:nick="overwrite" + glib:name="G_FILE_COPY_OVERWRITE"> Overwrite any existing files @@ -50844,7 +51830,8 @@ the @matcher is automatically freed. + glib:nick="backup" + glib:name="G_FILE_COPY_BACKUP"> Make a backup of any existing files. @@ -50852,7 +51839,8 @@ the @matcher is automatically freed. + glib:nick="nofollow-symlinks" + glib:name="G_FILE_COPY_NOFOLLOW_SYMLINKS"> Don't follow symlinks. @@ -50860,7 +51848,8 @@ the @matcher is automatically freed. + glib:nick="all-metadata" + glib:name="G_FILE_COPY_ALL_METADATA"> Copy all file metadata instead of just default set used for copy (see #GFileInfo). @@ -50868,7 +51857,8 @@ the @matcher is automatically freed. + glib:nick="no-fallback-for-move" + glib:name="G_FILE_COPY_NO_FALLBACK_FOR_MOVE"> Don't use copy and delete fallback if native move not supported. @@ -50876,7 +51866,8 @@ the @matcher is automatically freed. + glib:nick="target-default-perms" + glib:name="G_FILE_COPY_TARGET_DEFAULT_PERMS"> Leaves target file with default perms, instead of setting the source file perms. @@ -50892,7 +51883,8 @@ the @matcher is automatically freed. + glib:nick="none" + glib:name="G_FILE_CREATE_NONE"> No flags set. @@ -50900,7 +51892,8 @@ the @matcher is automatically freed. + glib:nick="private" + glib:name="G_FILE_CREATE_PRIVATE"> Create a file that can only be @@ -50909,7 +51902,8 @@ the @matcher is automatically freed. + glib:nick="replace-destination" + glib:name="G_FILE_CREATE_REPLACE_DESTINATION"> Replace the destination @@ -50933,7 +51927,7 @@ the @matcher is automatically freed. glib:type-struct="FileDescriptorBasedIface"> #GFileDescriptorBased is implemented by streams (implementations of + line="6566">#GFileDescriptorBased is implemented by streams (implementations of #GInputStream or #GOutputStream) that are based on file descriptors. Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific @@ -50943,19 +51937,19 @@ file when using it. Gets the underlying file descriptor. + line="22048">Gets the underlying file descriptor. The file descriptor + line="22054">The file descriptor a #GFileDescriptorBased. + line="22050">a #GFileDescriptorBased. @@ -50965,19 +51959,19 @@ file when using it. version="2.24"> Gets the underlying file descriptor. + line="22048">Gets the underlying file descriptor. The file descriptor + line="22054">The file descriptor a #GFileDescriptorBased. + line="22050">a #GFileDescriptorBased. @@ -51002,14 +51996,14 @@ file when using it. The file descriptor + line="22054">The file descriptor a #GFileDescriptorBased. + line="22050">a #GFileDescriptorBased. @@ -51025,7 +52019,7 @@ file when using it. glib:type-struct="FileEnumeratorClass"> #GFileEnumerator allows you to operate on a set of #GFiles, + line="6583">#GFileEnumerator allows you to operate on a set of #GFiles, returning a #GFileInfo structure for each file enumerated (e.g. g_file_enumerate_children() will return a #GFileEnumerator for each of the children within a directory). @@ -51055,7 +52049,7 @@ on it, and it should be freed with g_object_unref(). Asynchronously closes the file enumerator. + line="22253">Asynchronously closes the file enumerator. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -51069,13 +52063,13 @@ g_file_enumerator_close_finish(). a #GFileEnumerator. + line="22255">a #GFileEnumerator. the [I/O priority][io-priority] of the request + line="22256">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22257">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="22258">a #GAsyncReadyCallback to call when the request is satisfied closure="3"> the data to pass to callback function + line="22259">the data to pass to callback function @@ -51113,7 +52107,7 @@ g_file_enumerator_close_finish(). Finishes closing a file enumerator, started from g_file_enumerator_close_async(). + line="22270">Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report %G_IO_ERROR_CLOSED in @error, and @@ -51127,20 +52121,20 @@ returned. %TRUE if the close operation has finished successfully. + line="22288">%TRUE if the close operation has finished successfully. a #GFileEnumerator. + line="22272">a #GFileEnumerator. a #GAsyncResult. + line="22273">a #GAsyncResult. @@ -51165,7 +52159,7 @@ returned. Returns information for the next file in the enumerated object. + line="22396">Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created. @@ -51180,7 +52174,7 @@ be unset. A #GFileInfo or %NULL on error + line="22414">A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. @@ -51189,7 +52183,7 @@ be unset. a #GFileEnumerator. + line="22398">a #GFileEnumerator. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22399">optional #GCancellable object, %NULL to ignore. @@ -51206,7 +52200,7 @@ be unset. Request information for a number of files from the enumerator asynchronously. + line="22420">Request information for a number of files from the enumerator asynchronously. When all i/o for the operation is finished the @callback will be called with the requested information. @@ -51233,19 +52227,19 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22422">a #GFileEnumerator. the number of file info objects to request + line="22423">the number of file info objects to request the [I/O priority][io-priority] of the request + line="22424">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22425">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="22426">a #GAsyncReadyCallback to call when the request is satisfied closure="4"> the data to pass to callback function + line="22427">the data to pass to callback function @@ -51285,12 +52279,12 @@ priority is %G_PRIORITY_DEFAULT. throws="1"> Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). + line="22451">Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). a #GList of #GFileInfos. You must free the list with + line="22460">a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -51301,13 +52295,13 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22453">a #GFileEnumerator. a #GAsyncResult. + line="22454">a #GAsyncResult. @@ -51315,7 +52309,7 @@ priority is %G_PRIORITY_DEFAULT. Releases all resources used by this enumerator, making the + line="22236">Releases all resources used by this enumerator, making the enumerator return %G_IO_ERROR_CLOSED on all calls. This will be automatically called when the last reference @@ -51325,14 +52319,14 @@ sure resources are released as early as possible. #TRUE on success or #FALSE on error. + line="22249">#TRUE on success or #FALSE on error. a #GFileEnumerator. + line="22238">a #GFileEnumerator. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22239">optional #GCancellable object, %NULL to ignore. @@ -51349,7 +52343,7 @@ sure resources are released as early as possible. Asynchronously closes the file enumerator. + line="22253">Asynchronously closes the file enumerator. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -51363,13 +52357,13 @@ g_file_enumerator_close_finish(). a #GFileEnumerator. + line="22255">a #GFileEnumerator. the [I/O priority][io-priority] of the request + line="22256">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22257">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="22258">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="22259">the data to pass to callback function @@ -51408,7 +52402,7 @@ g_file_enumerator_close_finish(). throws="1"> Finishes closing a file enumerator, started from g_file_enumerator_close_async(). + line="22270">Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report %G_IO_ERROR_CLOSED in @error, and @@ -51422,20 +52416,20 @@ returned. %TRUE if the close operation has finished successfully. + line="22288">%TRUE if the close operation has finished successfully. a #GFileEnumerator. + line="22272">a #GFileEnumerator. a #GAsyncResult. + line="22273">a #GAsyncResult. @@ -51445,7 +52439,7 @@ returned. version="2.36"> Return a new #GFile which refers to the file named by @info in the source + line="22292">Return a new #GFile which refers to the file named by @info in the source directory of @enumerator. This function is primarily intended to be used inside loops with g_file_enumerator_next_file(). @@ -51459,20 +52453,20 @@ This is a convenience method that's equivalent to: a #GFile for the #GFileInfo passed it. + line="22309">a #GFile for the #GFileInfo passed it. a #GFileEnumerator + line="22294">a #GFileEnumerator a #GFileInfo gotten from g_file_enumerator_next_file() + line="22295">a #GFileInfo gotten from g_file_enumerator_next_file() or the async equivalents. @@ -51483,19 +52477,19 @@ This is a convenience method that's equivalent to: version="2.18"> Get the #GFile container which is being enumerated. + line="22314">Get the #GFile container which is being enumerated. the #GFile which is being enumerated. + line="22320">the #GFile which is being enumerated. a #GFileEnumerator + line="22316">a #GFileEnumerator @@ -51503,19 +52497,19 @@ This is a convenience method that's equivalent to: Checks if the file enumerator has pending operations. + line="22325">Checks if the file enumerator has pending operations. %TRUE if the @enumerator has pending operations. + line="22331">%TRUE if the @enumerator has pending operations. a #GFileEnumerator. + line="22327">a #GFileEnumerator. @@ -51523,19 +52517,19 @@ This is a convenience method that's equivalent to: Checks if the file enumerator has been closed. + line="22335">Checks if the file enumerator has been closed. %TRUE if the @enumerator is closed. + line="22341">%TRUE if the @enumerator is closed. a #GFileEnumerator. + line="22337">a #GFileEnumerator. @@ -51546,7 +52540,7 @@ This is a convenience method that's equivalent to: throws="1"> This is a version of g_file_enumerator_next_file() that's easier to + line="22345">This is a version of g_file_enumerator_next_file() that's easier to use correctly from C programs. With g_file_enumerator_next_file(), the gboolean return value signifies "end of iteration or error", which requires allocation of a temporary #GError. @@ -51592,7 +52586,7 @@ out: an open #GFileEnumerator + line="22347">an open #GFileEnumerator Output location for the next #GFileInfo, or %NULL + line="22348">Output location for the next #GFileInfo, or %NULL Output location for the next #GFile, or %NULL + line="22349">Output location for the next #GFile, or %NULL a #GCancellable + line="22350">a #GCancellable @@ -51633,7 +52627,7 @@ out: throws="1"> Returns information for the next file in the enumerated object. + line="22396">Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created. @@ -51648,7 +52642,7 @@ be unset. A #GFileInfo or %NULL on error + line="22414">A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. @@ -51657,7 +52651,7 @@ be unset. a #GFileEnumerator. + line="22398">a #GFileEnumerator. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22399">optional #GCancellable object, %NULL to ignore. @@ -51675,7 +52669,7 @@ be unset. c:identifier="g_file_enumerator_next_files_async"> Request information for a number of files from the enumerator asynchronously. + line="22420">Request information for a number of files from the enumerator asynchronously. When all i/o for the operation is finished the @callback will be called with the requested information. @@ -51702,19 +52696,19 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22422">a #GFileEnumerator. the number of file info objects to request + line="22423">the number of file info objects to request the [I/O priority][io-priority] of the request + line="22424">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22425">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="22426">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="22427">the data to pass to callback function @@ -51753,12 +52747,12 @@ priority is %G_PRIORITY_DEFAULT. throws="1"> Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). + line="22451">Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). a #GList of #GFileInfos. You must free the list with + line="22460">a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -51769,13 +52763,13 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22453">a #GFileEnumerator. a #GAsyncResult. + line="22454">a #GAsyncResult. @@ -51783,7 +52777,7 @@ priority is %G_PRIORITY_DEFAULT. Sets the file enumerator as having pending operations. + line="22466">Sets the file enumerator as having pending operations. @@ -51792,13 +52786,13 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22468">a #GFileEnumerator. a boolean value. + line="22469">a boolean value. @@ -51830,7 +52824,7 @@ priority is %G_PRIORITY_DEFAULT. A #GFileInfo or %NULL on error + line="22414">A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. @@ -51839,7 +52833,7 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22398">a #GFileEnumerator. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22399">optional #GCancellable object, %NULL to ignore. @@ -51883,19 +52877,19 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22422">a #GFileEnumerator. the number of file info objects to request + line="22423">the number of file info objects to request the [I/O priority][io-priority] of the request + line="22424">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22425">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + line="22426">a #GAsyncReadyCallback to call when the request is satisfied closure="5"> the data to pass to callback function + line="22427">the data to pass to callback function @@ -51937,7 +52931,7 @@ priority is %G_PRIORITY_DEFAULT. a #GList of #GFileInfos. You must free the list with + line="22460">a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -51948,13 +52942,13 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22453">a #GFileEnumerator. a #GAsyncResult. + line="22454">a #GAsyncResult. @@ -51970,13 +52964,13 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + line="22255">a #GFileEnumerator. the [I/O priority][io-priority] of the request + line="22256">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="22257">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="22258">a #GAsyncReadyCallback to call when the request is satisfied closure="4"> the data to pass to callback function + line="22259">the data to pass to callback function @@ -52018,20 +53012,20 @@ priority is %G_PRIORITY_DEFAULT. %TRUE if the close operation has finished successfully. + line="22288">%TRUE if the close operation has finished successfully. a #GFileEnumerator. + line="22272">a #GFileEnumerator. a #GAsyncResult. + line="22273">a #GAsyncResult. @@ -52109,7 +53103,7 @@ priority is %G_PRIORITY_DEFAULT. glib:type-struct="FileIOStreamClass"> GFileIOStream provides io streams that both read and write to the same + line="6684">GFileIOStream provides io streams that both read and write to the same file handle. GFileIOStream implements #GSeekable, which allows the io @@ -52156,21 +53150,21 @@ on the output stream. Gets the entity tag for the file when it has been written. + line="23673">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + line="23681">the entity tag for the stream. a #GFileIOStream. + line="23675">a #GFileIOStream. @@ -52181,7 +53175,7 @@ and closed, as the etag can change while writing. throws="1"> Queries a file io stream for the given @attributes. + line="23686">Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -52202,20 +53196,20 @@ be returned. a #GFileInfo for the @stream, or %NULL on error. + line="23711">a #GFileInfo for the @stream, or %NULL on error. a #GFileIOStream. + line="23688">a #GFileIOStream. a file attribute query string. + line="23689">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23690">optional #GCancellable object, %NULL to ignore. @@ -52234,7 +53228,7 @@ be returned. version="2.22"> Asynchronously queries the @stream for a #GFileInfo. When completed, + line="23716">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish(). @@ -52248,19 +53242,19 @@ g_file_io_stream_query_info(). a #GFileIOStream. + line="23718">a #GFileIOStream. a file attribute query string. + line="23719">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + line="23720">the [I/O priority][gio-GIOScheduler] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23721">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="23722">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="23723">the data to pass to callback function @@ -52301,26 +53295,26 @@ g_file_io_stream_query_info(). throws="1"> Finalizes the asynchronous query started + line="23736">Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). A #GFileInfo for the finished query. + line="23745">A #GFileInfo for the finished query. a #GFileIOStream. + line="23738">a #GFileIOStream. a #GAsyncResult. + line="23739">a #GAsyncResult. @@ -52384,21 +53378,21 @@ by g_file_io_stream_query_info_async(). version="2.22"> Gets the entity tag for the file when it has been written. + line="23673">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + line="23681">the entity tag for the stream. a #GFileIOStream. + line="23675">a #GFileIOStream. @@ -52409,7 +53403,7 @@ and closed, as the etag can change while writing. throws="1"> Queries a file io stream for the given @attributes. + line="23686">Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -52430,20 +53424,20 @@ be returned. a #GFileInfo for the @stream, or %NULL on error. + line="23711">a #GFileInfo for the @stream, or %NULL on error. a #GFileIOStream. + line="23688">a #GFileIOStream. a file attribute query string. + line="23689">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23690">optional #GCancellable object, %NULL to ignore. @@ -52462,7 +53456,7 @@ be returned. version="2.22"> Asynchronously queries the @stream for a #GFileInfo. When completed, + line="23716">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish(). @@ -52476,19 +53470,19 @@ g_file_io_stream_query_info(). a #GFileIOStream. + line="23718">a #GFileIOStream. a file attribute query string. + line="23719">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + line="23720">the [I/O priority][gio-GIOScheduler] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23721">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="23722">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="23723">the data to pass to callback function @@ -52528,26 +53522,26 @@ g_file_io_stream_query_info(). throws="1"> Finalizes the asynchronous query started + line="23736">Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). A #GFileInfo for the finished query. + line="23745">A #GFileInfo for the finished query. a #GFileIOStream. + line="23738">a #GFileIOStream. a #GAsyncResult. + line="23739">a #GAsyncResult. @@ -52658,20 +53652,20 @@ by g_file_io_stream_query_info_async(). a #GFileInfo for the @stream, or %NULL on error. + line="23711">a #GFileInfo for the @stream, or %NULL on error. a #GFileIOStream. + line="23688">a #GFileIOStream. a file attribute query string. + line="23689">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23690">optional #GCancellable object, %NULL to ignore. @@ -52696,19 +53690,19 @@ by g_file_io_stream_query_info_async(). a #GFileIOStream. + line="23718">a #GFileIOStream. a file attribute query string. + line="23719">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + line="23720">the [I/O priority][gio-GIOScheduler] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23721">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="23722">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="23723">the data to pass to callback function @@ -52750,20 +53744,20 @@ by g_file_io_stream_query_info_async(). A #GFileInfo for the finished query. + line="23745">A #GFileInfo for the finished query. a #GFileIOStream. + line="23738">a #GFileIOStream. a #GAsyncResult. + line="23739">a #GAsyncResult. @@ -52772,17 +53766,17 @@ by g_file_io_stream_query_info_async(). - + the entity tag for the stream. + line="23681">the entity tag for the stream. a #GFileIOStream. + line="23675">a #GFileIOStream. @@ -52843,7 +53837,7 @@ by g_file_io_stream_query_info_async(). glib:type-struct="FileIconClass"> #GFileIcon specifies an icon by pointing to an image file + line="6617">#GFileIcon specifies an icon by pointing to an image file to be used as icon. @@ -52851,12 +53845,12 @@ to be used as icon. Creates a new icon for a file. + line="22804">Creates a new icon for a file. a #GIcon for the given + line="22810">a #GIcon for the given @file, or %NULL on error. @@ -52864,27 +53858,29 @@ to be used as icon. a #GFile. + line="22806">a #GFile. - + Gets the #GFile associated with the given @icon. + line="22794">Gets the #GFile associated with the given @icon. a #GFile, or %NULL. + line="22800">a #GFile. a #GIcon. + line="22796">a #GIcon. @@ -52892,10 +53888,11 @@ to be used as icon. + transfer-ownership="none" + getter="get_file"> The file containing the icon. + line="1803">The file containing the icon. @@ -52924,7 +53921,7 @@ to be used as icon. a new #GFile that is a duplicate + line="22074">a new #GFile that is a duplicate of the given #GFile. @@ -52932,7 +53929,7 @@ to be used as icon. input #GFile + line="22061">input #GFile @@ -52944,7 +53941,7 @@ to be used as icon. 0 if @file is not a valid #GFile, otherwise an + line="22787">0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -52954,7 +53951,7 @@ to be used as icon. #gconstpointer to a #GFile + line="22781">#gconstpointer to a #GFile @@ -52966,20 +53963,20 @@ to be used as icon. %TRUE if @file1 and @file2 are equal. + line="22488">%TRUE if @file1 and @file2 are equal. the first #GFile + line="22477">the first #GFile the second #GFile + line="22478">the second #GFile @@ -52991,14 +53988,14 @@ to be used as icon. %TRUE if @file is native + line="23766">%TRUE if @file is native input #GFile + line="23752">input #GFile @@ -53010,7 +54007,7 @@ to be used as icon. %TRUE if #GFile's backend supports the + line="22773">%TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. @@ -53019,13 +54016,13 @@ to be used as icon. input #GFile + line="22766">input #GFile a string containing a URI scheme + line="22767">a string containing a URI scheme @@ -53034,19 +54031,19 @@ to be used as icon. - + a string containing the URI scheme for the given - #GFile. The returned string should be freed with g_free() - when no longer needed. + line="22716">a string containing the URI scheme for the given + #GFile or %NULL if the #GFile was constructed with an invalid URI. The + returned string should be freed with g_free() when no longer needed. input #GFile + line="22702">input #GFile @@ -53055,11 +54052,19 @@ to be used as icon. - - + + string containing the #GFile's + base name, or %NULL if given #GFile is invalid. The returned string + should be freed with g_free() when no longer needed. + + input #GFile @@ -53068,11 +54073,19 @@ to be used as icon. - - + + string containing the #GFile's path, + or %NULL if no such path exists. The returned string should be freed + with g_free() when no longer needed. + + input #GFile @@ -53084,7 +54097,8 @@ to be used as icon. a string containing the #GFile's URI. + line="22693">a string containing the #GFile's URI. If the #GFile was constructed + with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed. @@ -53093,7 +54107,7 @@ to be used as icon. input #GFile + line="22687">input #GFile @@ -53105,7 +54119,7 @@ to be used as icon. a string containing the #GFile's parse name. + line="22648">a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. @@ -53114,7 +54128,7 @@ to be used as icon. input #GFile + line="22631">input #GFile @@ -53126,7 +54140,7 @@ to be used as icon. a #GFile structure to the + line="22623">a #GFile structure to the parent of the given #GFile or %NULL if there is no parent. Free the returned object with g_object_unref(). @@ -53135,7 +54149,7 @@ to be used as icon. input #GFile + line="22615">input #GFile @@ -53147,7 +54161,7 @@ to be used as icon. %TRUE if the @file's parent, grandparent, etc is @prefix, + line="22759">%TRUE if the @file's parent, grandparent, etc is @prefix, %FALSE otherwise. @@ -53155,13 +54169,13 @@ to be used as icon. input #GFile + line="22742">input #GFile input #GFile + line="22741">input #GFile @@ -53170,14 +54184,26 @@ to be used as icon. - - + + string with the relative path from + @descendant to @parent, or %NULL if @descendant doesn't have @parent as + prefix. The returned string should be freed with g_free() when + no longer needed. + + input #GFile + input #GFile @@ -53189,7 +54215,7 @@ to be used as icon. #GFile to the resolved path. + line="25376">#GFile to the resolved path. %NULL if @relative_path is %NULL or if @file is invalid. Free the returned object with g_object_unref(). @@ -53198,13 +54224,13 @@ to be used as icon. input #GFile + line="25369">input #GFile a given relative path string + line="25370">a given relative path string @@ -53216,7 +54242,7 @@ to be used as icon. a #GFile to the specified child, or + line="22607">a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). @@ -53225,13 +54251,13 @@ to be used as icon. input #GFile + line="22594">input #GFile string to a possible child + line="22595">string to a possible child @@ -53243,7 +54269,7 @@ to be used as icon. A #GFileEnumerator if successful, + line="22191">A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). @@ -53251,19 +54277,19 @@ to be used as icon. input #GFile + line="22160">input #GFile an attribute query string + line="22161">an attribute query string a set of #GFileQueryInfoFlags + line="22162">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="22163">optional #GCancellable object, %NULL to ignore @@ -53289,25 +54315,25 @@ to be used as icon. input #GFile + line="22198">input #GFile an attribute query string + line="22199">an attribute query string a set of #GFileQueryInfoFlags + line="22200">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="22201">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22202">optional #GCancellable object, %NULL to ignore @@ -53328,7 +54354,7 @@ to be used as icon. closure="6"> a #GAsyncReadyCallback to call when the + line="22204">a #GAsyncReadyCallback to call when the request is satisfied @@ -53339,7 +54365,7 @@ to be used as icon. closure="6"> the data to pass to callback function + line="22206">the data to pass to callback function @@ -53351,7 +54377,7 @@ to be used as icon. a #GFileEnumerator or %NULL + line="22230">a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). @@ -53360,13 +54386,13 @@ to be used as icon. input #GFile + line="22223">input #GFile a #GAsyncResult + line="22224">a #GAsyncResult @@ -53378,7 +54404,7 @@ to be used as icon. a #GFileInfo for the given @file, or %NULL + line="24938">a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -53386,19 +54412,19 @@ to be used as icon. input #GFile + line="24900">input #GFile an attribute query string + line="24901">an attribute query string a set of #GFileQueryInfoFlags + line="24902">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="24903">optional #GCancellable object, %NULL to ignore @@ -53424,25 +54450,25 @@ to be used as icon. input #GFile + line="24945">input #GFile an attribute query string + line="24946">an attribute query string a set of #GFileQueryInfoFlags + line="24947">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="24948">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24949">optional #GCancellable object, %NULL to ignore @@ -53463,7 +54489,7 @@ to be used as icon. closure="6"> a #GAsyncReadyCallback to call when the + line="24951">a #GAsyncReadyCallback to call when the request is satisfied @@ -53474,7 +54500,7 @@ to be used as icon. closure="6"> the data to pass to callback function + line="24953">the data to pass to callback function @@ -53486,7 +54512,7 @@ to be used as icon. #GFileInfo for given @file + line="24976">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -53495,13 +54521,13 @@ to be used as icon. input #GFile + line="24969">input #GFile a #GAsyncResult + line="24970">a #GAsyncResult @@ -53513,7 +54539,7 @@ to be used as icon. a #GFileInfo or %NULL if there was an error. + line="24853">a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -53521,13 +54547,13 @@ to be used as icon. input #GFile + line="24821">input #GFile an attribute query string + line="24822">an attribute query string allow-none="1"> optional #GCancellable object, + line="24823">optional #GCancellable object, %NULL to ignore @@ -53553,19 +54579,19 @@ to be used as icon. input #GFile + line="24860">input #GFile an attribute query string + line="24861">an attribute query string the [I/O priority][io-priority] of the request + line="24862">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24863">optional #GCancellable object, %NULL to ignore @@ -53586,7 +54612,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="24865">a #GAsyncReadyCallback to call when the request is satisfied @@ -53597,7 +54623,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="24867">the data to pass to callback function @@ -53609,7 +54635,7 @@ to be used as icon. #GFileInfo for given @file + line="24892">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -53618,13 +54644,13 @@ to be used as icon. input #GFile + line="24885">input #GFile a #GAsyncResult + line="24886">a #GAsyncResult @@ -53636,7 +54662,7 @@ to be used as icon. a #GMount where the @file is located + line="22509">a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). @@ -53645,7 +54671,7 @@ to be used as icon. input #GFile + line="22494">input #GFile allow-none="1"> optional #GCancellable object, + line="22495">optional #GCancellable object, %NULL to ignore @@ -53671,13 +54697,13 @@ to be used as icon. a #GFile + line="22517">a #GFile the [I/O priority][io-priority] of the request + line="22518">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22519">optional #GCancellable object, %NULL to ignore @@ -53698,7 +54724,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="22521">a #GAsyncReadyCallback to call when the request is satisfied @@ -53709,7 +54735,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="22523">the data to pass to callback function @@ -53721,7 +54747,7 @@ to be used as icon. #GMount for given @file or %NULL on error. + line="22545">#GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -53729,13 +54755,13 @@ to be used as icon. a #GFile + line="22538">a #GFile a #GAsyncResult + line="22539">a #GAsyncResult @@ -53747,7 +54773,7 @@ to be used as icon. a #GFile specifying what @file was renamed to, + line="25623">a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -53756,13 +54782,13 @@ to be used as icon. input #GFile + line="25601">input #GFile a string + line="25602">a string allow-none="1"> optional #GCancellable object, + line="25603">optional #GCancellable object, %NULL to ignore @@ -53788,19 +54814,19 @@ to be used as icon. input #GFile + line="25631">input #GFile a string + line="25632">a string the [I/O priority][io-priority] of the request + line="25633">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25634">optional #GCancellable object, %NULL to ignore @@ -53821,7 +54847,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="25636">a #GAsyncReadyCallback to call when the request is satisfied @@ -53832,7 +54858,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="25638">the data to pass to callback function @@ -53844,7 +54870,7 @@ to be used as icon. a #GFile or %NULL on error. + line="25660">a #GFile or %NULL on error. Free the returned object with g_object_unref(). @@ -53852,13 +54878,13 @@ to be used as icon. input #GFile + line="25653">input #GFile a #GAsyncResult + line="25654">a #GAsyncResult @@ -53870,7 +54896,7 @@ to be used as icon. a #GFileAttributeInfoList describing the settable attributes. + line="25000">a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() input #GFile + line="24984">input #GFile allow-none="1"> optional #GCancellable object, + line="24985">optional #GCancellable object, %NULL to ignore @@ -53918,7 +54944,7 @@ to be used as icon. a #GFileAttributeInfoList describing the writable namespaces. + line="25021">a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() input #GFile + line="25008">input #GFile allow-none="1"> optional #GCancellable object, + line="25009">optional #GCancellable object, %NULL to ignore @@ -53966,26 +54992,26 @@ to be used as icon. %TRUE if the attribute was set, %FALSE otherwise. + line="25403">%TRUE if the attribute was set, %FALSE otherwise. input #GFile + line="25384">input #GFile a string containing the attribute's name + line="25385">a string containing the attribute's name The type of the attribute + line="25386">The type of the attribute allow-none="1"> a pointer to the value (or the pointer + line="25387">a pointer to the value (or the pointer itself if the type is a pointer type) a set of #GFileQueryInfoFlags + line="25389">a set of #GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25390">optional #GCancellable object, %NULL to ignore @@ -54023,26 +55049,26 @@ to be used as icon. %FALSE if there was any error, %TRUE otherwise. + line="25595">%FALSE if there was any error, %TRUE otherwise. input #GFile + line="25575">input #GFile a #GFileInfo + line="25576">a #GFileInfo #GFileQueryInfoFlags + line="25577">#GFileQueryInfoFlags allow-none="1"> optional #GCancellable object, + line="25578">optional #GCancellable object, %NULL to ignore @@ -54068,25 +55094,25 @@ to be used as icon. input #GFile + line="25540">input #GFile a #GFileInfo + line="25541">a #GFileInfo a #GFileQueryInfoFlags + line="25542">a #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + line="25543">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25544">optional #GCancellable object, %NULL to ignore @@ -54107,7 +55133,7 @@ to be used as icon. closure="6"> a #GAsyncReadyCallback + line="25546">a #GAsyncReadyCallback closure="6"> a #gpointer + line="25547">a #gpointer @@ -54129,20 +55155,20 @@ to be used as icon. %TRUE if the attributes were set correctly, %FALSE otherwise. + line="25569">%TRUE if the attributes were set correctly, %FALSE otherwise. input #GFile + line="25562">input #GFile a #GAsyncResult + line="25563">a #GAsyncResult transfer-ownership="full"> a #GFileInfo + line="25564">a #GFileInfo @@ -54163,7 +55189,7 @@ to be used as icon. #GFileInputStream or %NULL on error. + line="25045">#GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -54171,7 +55197,7 @@ to be used as icon. #GFile to read + line="25029">#GFile to read allow-none="1"> a #GCancellable + line="25030">a #GCancellable @@ -54196,13 +55222,13 @@ to be used as icon. input #GFile + line="25052">input #GFile the [I/O priority][io-priority] of the request + line="25053">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25054">optional #GCancellable object, %NULL to ignore @@ -54223,7 +55249,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="25056">a #GAsyncReadyCallback to call when the request is satisfied @@ -54234,7 +55260,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="25058">the data to pass to callback function @@ -54246,7 +55272,7 @@ to be used as icon. a #GFileInputStream or %NULL on error. + line="25080">a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -54254,13 +55280,13 @@ to be used as icon. input #GFile + line="25073">input #GFile a #GAsyncResult + line="25074">a #GAsyncResult @@ -54272,7 +55298,7 @@ to be used as icon. a #GFileOutputStream, or %NULL on error. + line="21434">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -54280,13 +55306,13 @@ to be used as icon. input #GFile + line="21410">input #GFile a set of #GFileCreateFlags + line="21411">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21412">optional #GCancellable object, %NULL to ignore @@ -54312,19 +55338,19 @@ to be used as icon. input #GFile + line="21441">input #GFile a set of #GFileCreateFlags + line="21442">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21443">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21444">optional #GCancellable object, %NULL to ignore @@ -54345,7 +55371,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="21446">a #GAsyncReadyCallback to call when the request is satisfied @@ -54356,7 +55382,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="21448">the data to pass to callback function @@ -54368,7 +55394,7 @@ to be used as icon. a valid #GFileOutputStream + line="21470">a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -54377,13 +55403,13 @@ to be used as icon. input #GFile + line="21463">input #GFile #GAsyncResult + line="21464">#GAsyncResult @@ -54395,7 +55421,7 @@ to be used as icon. a #GFileOutputStream for the newly created + line="21862">a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -54404,13 +55430,13 @@ to be used as icon. input #GFile + line="21836">input #GFile a set of #GFileCreateFlags + line="21837">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21838">optional #GCancellable object, %NULL to ignore @@ -54436,19 +55462,19 @@ to be used as icon. input #GFile + line="21870">input #GFile a set of #GFileCreateFlags + line="21871">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21872">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21873">optional #GCancellable object, %NULL to ignore @@ -54469,7 +55495,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="21875">a #GAsyncReadyCallback to call when the request is satisfied @@ -54480,7 +55506,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="21877">the data to pass to callback function @@ -54492,7 +55518,7 @@ to be used as icon. a #GFileOutputStream or %NULL on error. + line="21900">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -54500,13 +55526,13 @@ to be used as icon. input #GFile + line="21893">input #GFile a #GAsyncResult + line="21894">a #GAsyncResult @@ -54518,7 +55544,7 @@ to be used as icon. a #GFileOutputStream or %NULL on error. + line="25138">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -54526,7 +55552,7 @@ to be used as icon. input #GFile + line="25087">input #GFile allow-none="1"> an optional [entity tag][gfile-etag] + line="25088">an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + line="25090">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25091">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="25092">optional #GCancellable object, %NULL to ignore @@ -54574,7 +55600,7 @@ to be used as icon. input #GFile + line="25145">input #GFile allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + line="25146">an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + line="25148">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25149">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="25150">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25151">optional #GCancellable object, %NULL to ignore @@ -54623,7 +55649,7 @@ to be used as icon. closure="7"> a #GAsyncReadyCallback to call + line="25153">a #GAsyncReadyCallback to call when the request is satisfied @@ -54634,7 +55660,7 @@ to be used as icon. closure="7"> the data to pass to callback function + line="25155">the data to pass to callback function @@ -54646,7 +55672,7 @@ to be used as icon. a #GFileOutputStream, or %NULL on error. + line="25290">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -54654,13 +55680,13 @@ to be used as icon. input #GFile + line="25283">input #GFile a #GAsyncResult + line="25284">a #GAsyncResult @@ -54672,14 +55698,14 @@ to be used as icon. %TRUE if the file was deleted. %FALSE otherwise. + line="22013">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + line="21986">input #GFile allow-none="1"> optional #GCancellable object, + line="21987">optional #GCancellable object, %NULL to ignore @@ -54705,13 +55731,13 @@ to be used as icon. input #GFile + line="22019">input #GFile the [I/O priority][io-priority] of the request + line="22020">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="22021">optional #GCancellable object, %NULL to ignore @@ -54732,7 +55758,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="22023">a #GAsyncReadyCallback to call when the request is satisfied @@ -54743,7 +55769,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="22025">the data to pass to callback function @@ -54755,20 +55781,20 @@ to be used as icon. %TRUE if the file was deleted. %FALSE otherwise. + line="22043">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + line="22037">input #GFile a #GAsyncResult + line="22038">a #GAsyncResult @@ -54780,14 +55806,14 @@ to be used as icon. %TRUE on successful trash, %FALSE otherwise. + line="25782">%TRUE on successful trash, %FALSE otherwise. #GFile to send to trash + line="25766">#GFile to send to trash allow-none="1"> optional #GCancellable object, + line="25767">optional #GCancellable object, %NULL to ignore @@ -54813,13 +55839,13 @@ to be used as icon. input #GFile + line="25788">input #GFile the [I/O priority][io-priority] of the request + line="25789">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25790">optional #GCancellable object, %NULL to ignore @@ -54840,7 +55866,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="25792">a #GAsyncReadyCallback to call when the request is satisfied @@ -54851,7 +55877,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="25794">the data to pass to callback function @@ -54863,20 +55889,20 @@ to be used as icon. %TRUE on successful trash, %FALSE otherwise. + line="25811">%TRUE on successful trash, %FALSE otherwise. input #GFile + line="25804">input #GFile a #GAsyncResult + line="25805">a #GAsyncResult @@ -54888,14 +55914,14 @@ to be used as icon. %TRUE on successful creation, %FALSE otherwise. + line="23980">%TRUE on successful creation, %FALSE otherwise. input #GFile + line="23960">input #GFile allow-none="1"> optional #GCancellable object, + line="23961">optional #GCancellable object, %NULL to ignore @@ -54921,13 +55947,13 @@ to be used as icon. input #GFile + line="23986">input #GFile the [I/O priority][io-priority] of the request + line="23987">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="23988">optional #GCancellable object, %NULL to ignore @@ -54948,7 +55974,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="23990">a #GAsyncReadyCallback to call when the request is satisfied @@ -54959,7 +55985,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="23992">the data to pass to callback function @@ -54971,20 +55997,20 @@ to be used as icon. %TRUE on successful directory creation, %FALSE otherwise. + line="24009">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + line="24002">input #GFile a #GAsyncResult + line="24003">a #GAsyncResult @@ -54996,20 +56022,20 @@ to be used as icon. %TRUE on the creation of a new symlink, %FALSE otherwise. + line="24057">%TRUE on the creation of a new symlink, %FALSE otherwise. a #GFile with the name of the symlink to create + line="24043">a #GFile with the name of the symlink to create a string with the path for the target + line="24044">a string with the path for the target of the new symlink @@ -55019,7 +56045,7 @@ to be used as icon. allow-none="1"> optional #GCancellable object, + line="24046">optional #GCancellable object, %NULL to ignore @@ -55048,26 +56074,26 @@ to be used as icon. %TRUE on success, %FALSE otherwise. + line="21768">%TRUE on success, %FALSE otherwise. input #GFile + line="21717">input #GFile destination #GFile + line="21718">destination #GFile set of #GFileCopyFlags + line="21719">set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="21720">optional #GCancellable object, %NULL to ignore @@ -55088,7 +56114,7 @@ to be used as icon. closure="5"> function to callback with + line="21722">function to callback with progress information, or %NULL if progress information is not needed @@ -55099,7 +56125,7 @@ to be used as icon. allow-none="1"> user data to pass to @progress_callback + line="21724">user data to pass to @progress_callback @@ -55115,25 +56141,25 @@ to be used as icon. input #GFile + line="21774">input #GFile destination #GFile + line="21775">destination #GFile set of #GFileCopyFlags + line="21776">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + line="21777">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21778">optional #GCancellable object, %NULL to ignore @@ -55154,7 +56180,7 @@ to be used as icon. closure="6"> function to callback with progress + line="21780">function to callback with progress information, or %NULL if progress information is not needed @@ -55166,7 +56192,7 @@ to be used as icon. closure="5"> user data to pass to @progress_callback + line="21782">user data to pass to @progress_callback closure="8"> a #GAsyncReadyCallback to call when the request is satisfied + line="21783">a #GAsyncReadyCallback to call when the request is satisfied closure="7"> the data to pass to callback function + line="21784">the data to pass to callback function @@ -55199,20 +56225,20 @@ to be used as icon. a %TRUE on success, %FALSE on error. + line="21830">a %TRUE on success, %FALSE on error. input #GFile + line="21824">input #GFile a #GAsyncResult + line="21825">a #GAsyncResult @@ -55224,26 +56250,26 @@ to be used as icon. %TRUE on successful move, %FALSE otherwise. + line="24391">%TRUE on successful move, %FALSE otherwise. #GFile pointing to the source location + line="24346">#GFile pointing to the source location #GFile pointing to the destination location + line="24347">#GFile pointing to the destination location set of #GFileCopyFlags + line="24348">set of #GFileCopyFlags allow-none="1"> optional #GCancellable object, + line="24349">optional #GCancellable object, %NULL to ignore @@ -55264,7 +56290,7 @@ to be used as icon. closure="5"> #GFileProgressCallback + line="24351">#GFileProgressCallback function for updates @@ -55275,7 +56301,7 @@ to be used as icon. allow-none="1"> gpointer to user data for + line="24353">gpointer to user data for the callback function @@ -55308,13 +56334,13 @@ to be used as icon. input #GFile + line="24304">input #GFile flags affecting the operation + line="24305">flags affecting the operation allow-none="1"> a #GMountOperation, + line="24306">a #GMountOperation, or %NULL to avoid user interaction @@ -55333,7 +56359,7 @@ to be used as icon. allow-none="1"> optional #GCancellable object, + line="24308">optional #GCancellable object, %NULL to ignore @@ -55345,7 +56371,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="24310">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -55356,7 +56382,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="24312">the data to pass to callback function @@ -55368,7 +56394,7 @@ to be used as icon. a #GFile or %NULL on error. + line="24339">a #GFile or %NULL on error. Free the returned object with g_object_unref(). @@ -55376,13 +56402,13 @@ to be used as icon. input #GFile + line="24330">input #GFile a #GAsyncResult + line="24331">a #GAsyncResult @@ -55398,13 +56424,13 @@ to be used as icon. input #GFile + line="25818">input #GFile flags affecting the operation + line="25819">flags affecting the operation allow-none="1"> optional #GCancellable object, + line="25820">optional #GCancellable object, %NULL to ignore @@ -55425,7 +56451,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="25822">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -55436,7 +56462,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="25824">the data to pass to callback function @@ -55448,7 +56474,7 @@ to be used as icon. %TRUE if the operation finished successfully. + line="25851">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -55456,13 +56482,13 @@ to be used as icon. input #GFile + line="25842">input #GFile a #GAsyncResult + line="25843">a #GAsyncResult @@ -55478,13 +56504,13 @@ to be used as icon. input #GFile + line="22081">input #GFile flags affecting the operation + line="22082">flags affecting the operation allow-none="1"> optional #GCancellable object, + line="22083">optional #GCancellable object, %NULL to ignore @@ -55505,7 +56531,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="22085">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -55516,7 +56542,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="22087">the data to pass to callback function @@ -55528,7 +56554,7 @@ to be used as icon. %TRUE if the @file was ejected successfully. + line="22111">%TRUE if the @file was ejected successfully. %FALSE otherwise. @@ -55536,13 +56562,13 @@ to be used as icon. input #GFile + line="22104">input #GFile a #GAsyncResult + line="22105">a #GAsyncResult @@ -55558,13 +56584,13 @@ to be used as icon. input #GFile + line="24265">input #GFile flags affecting the operation + line="24266">flags affecting the operation allow-none="1"> a #GMountOperation + line="24267">a #GMountOperation or %NULL to avoid user interaction @@ -55583,7 +56609,7 @@ to be used as icon. allow-none="1"> optional #GCancellable object, + line="24269">optional #GCancellable object, %NULL to ignore @@ -55595,7 +56621,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="24271">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -55606,7 +56632,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="24273">the data to pass to callback function @@ -55618,7 +56644,7 @@ to be used as icon. %TRUE if successful. If an error has occurred, + line="24296">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -55627,13 +56653,13 @@ to be used as icon. input #GFile + line="24290">input #GFile a #GAsyncResult + line="24291">a #GAsyncResult @@ -55645,7 +56671,7 @@ to be used as icon. a #GFileMonitor for the given @file, + line="24190">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -55654,13 +56680,13 @@ to be used as icon. input #GFile + line="24171">input #GFile a set of #GFileMonitorFlags + line="24172">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24173">optional #GCancellable object, %NULL to ignore @@ -55682,7 +56708,7 @@ to be used as icon. a #GFileMonitor for the given @file, + line="24236">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -55691,13 +56717,13 @@ to be used as icon. input #GFile + line="24215">input #GFile a set of #GFileMonitorFlags + line="24216">a set of #GFileMonitorFlags allow-none="1"> optional #GCancellable object, + line="24217">optional #GCancellable object, %NULL to ignore @@ -55719,7 +56745,7 @@ to be used as icon. #GFileIOStream or %NULL on error. + line="24532">#GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -55727,7 +56753,7 @@ to be used as icon. #GFile to open + line="24511">#GFile to open allow-none="1"> a #GCancellable + line="24512">a #GCancellable @@ -55752,13 +56778,13 @@ to be used as icon. input #GFile + line="24540">input #GFile the [I/O priority][io-priority] of the request + line="24541">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="24542">optional #GCancellable object, %NULL to ignore @@ -55779,7 +56805,7 @@ to be used as icon. closure="4"> a #GAsyncReadyCallback to call + line="24544">a #GAsyncReadyCallback to call when the request is satisfied @@ -55790,7 +56816,7 @@ to be used as icon. closure="4"> the data to pass to callback function + line="24546">the data to pass to callback function @@ -55802,7 +56828,7 @@ to be used as icon. a #GFileIOStream or %NULL on error. + line="24570">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -55810,13 +56836,13 @@ to be used as icon. input #GFile + line="24563">input #GFile a #GAsyncResult + line="24564">a #GAsyncResult @@ -55828,7 +56854,7 @@ to be used as icon. a #GFileIOStream for the newly created + line="21937">a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -55837,13 +56863,13 @@ to be used as icon. a #GFile + line="21907">a #GFile a set of #GFileCreateFlags + line="21908">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="21909">optional #GCancellable object, %NULL to ignore @@ -55869,19 +56895,19 @@ to be used as icon. input #GFile + line="21946">input #GFile a set of #GFileCreateFlags + line="21947">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="21948">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="21949">optional #GCancellable object, %NULL to ignore @@ -55902,7 +56928,7 @@ to be used as icon. closure="5"> a #GAsyncReadyCallback to call + line="21951">a #GAsyncReadyCallback to call when the request is satisfied @@ -55913,7 +56939,7 @@ to be used as icon. closure="5"> the data to pass to callback function + line="21953">the data to pass to callback function @@ -55925,7 +56951,7 @@ to be used as icon. a #GFileIOStream or %NULL on error. + line="21978">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -55933,13 +56959,13 @@ to be used as icon. input #GFile + line="21971">input #GFile a #GAsyncResult + line="21972">a #GAsyncResult @@ -55951,7 +56977,7 @@ to be used as icon. a #GFileIOStream or %NULL on error. + line="25317">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). @@ -55959,7 +56985,7 @@ to be used as icon. a #GFile + line="25297">a #GFile allow-none="1"> an optional [entity tag][gfile-etag] + line="25298">an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + line="25300">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25301">a set of #GFileCreateFlags allow-none="1"> optional #GCancellable object, + line="25302">optional #GCancellable object, %NULL to ignore @@ -56007,7 +57033,7 @@ to be used as icon. input #GFile + line="25325">input #GFile allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + line="25326">an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + line="25328">%TRUE if a backup should be created a set of #GFileCreateFlags + line="25329">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + line="25330">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, + line="25331">optional #GCancellable object, %NULL to ignore @@ -56056,7 +57082,7 @@ to be used as icon. closure="7"> a #GAsyncReadyCallback to call + line="25333">a #GAsyncReadyCallback to call when the request is satisfied @@ -56067,7 +57093,7 @@ to be used as icon. closure="7"> the data to pass to callback function + line="25335">the data to pass to callback function @@ -56079,7 +57105,7 @@ to be used as icon. a #GFileIOStream, or %NULL on error. + line="25361">a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). @@ -56087,13 +57113,13 @@ to be used as icon. input #GFile + line="25354">input #GFile a #GAsyncResult + line="25355">a #GAsyncResult @@ -56109,13 +57135,13 @@ to be used as icon. input #GFile + line="25667">input #GFile flags affecting the operation + line="25668">flags affecting the operation allow-none="1"> a #GMountOperation, or %NULL to avoid user interaction + line="25669">a #GMountOperation, or %NULL to avoid user interaction allow-none="1"> optional #GCancellable object, %NULL to ignore + line="25670">optional #GCancellable object, %NULL to ignore closure="5"> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + line="25671">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL closure="5"> the data to pass to callback function + line="25672">the data to pass to callback function @@ -56166,7 +57192,7 @@ to be used as icon. %TRUE if the operation finished successfully. %FALSE + line="25701">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -56174,13 +57200,13 @@ otherwise. input #GFile + line="25692">input #GFile a #GAsyncResult + line="25693">a #GAsyncResult @@ -56196,13 +57222,13 @@ otherwise. input #GFile + line="25709">input #GFile flags affecting the operation + line="25710">flags affecting the operation allow-none="1"> a #GMountOperation, + line="25711">a #GMountOperation, or %NULL to avoid user interaction. @@ -56221,7 +57247,7 @@ otherwise. allow-none="1"> optional #GCancellable object, + line="25713">optional #GCancellable object, %NULL to ignore @@ -56233,7 +57259,7 @@ otherwise. closure="5"> a #GAsyncReadyCallback to call + line="25715">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -56244,7 +57270,7 @@ otherwise. closure="5"> the data to pass to callback function + line="25717">the data to pass to callback function @@ -56256,7 +57282,7 @@ otherwise. %TRUE if the operation finished successfully. + line="25744">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -56264,13 +57290,13 @@ otherwise. input #GFile + line="25735">input #GFile a #GAsyncResult + line="25736">a #GAsyncResult @@ -56292,13 +57318,13 @@ otherwise. input #GFile + line="25860">input #GFile flags affecting the operation + line="25861">flags affecting the operation allow-none="1"> a #GMountOperation, + line="25862">a #GMountOperation, or %NULL to avoid user interaction @@ -56317,7 +57343,7 @@ otherwise. allow-none="1"> optional #GCancellable object, + line="25864">optional #GCancellable object, %NULL to ignore @@ -56329,7 +57355,7 @@ otherwise. closure="5"> a #GAsyncReadyCallback to call + line="25866">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -56340,7 +57366,7 @@ otherwise. closure="5"> the data to pass to callback function + line="25868">the data to pass to callback function @@ -56352,7 +57378,7 @@ otherwise. %TRUE if the operation finished successfully. + line="25896">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -56360,13 +57386,13 @@ otherwise. input #GFile + line="25886">input #GFile a #GAsyncResult + line="25887">a #GAsyncResult @@ -56382,13 +57408,13 @@ otherwise. input #GFile + line="22120">input #GFile flags affecting the operation + line="22121">flags affecting the operation allow-none="1"> a #GMountOperation, + line="22122">a #GMountOperation, or %NULL to avoid user interaction @@ -56407,7 +57433,7 @@ otherwise. allow-none="1"> optional #GCancellable object, + line="22124">optional #GCancellable object, %NULL to ignore @@ -56419,7 +57445,7 @@ otherwise. closure="5"> a #GAsyncReadyCallback to call + line="22126">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -56430,7 +57456,7 @@ otherwise. closure="5"> the data to pass to callback function + line="22128">the data to pass to callback function @@ -56442,7 +57468,7 @@ otherwise. %TRUE if the @file was ejected successfully. + line="22152">%TRUE if the @file was ejected successfully. %FALSE otherwise. @@ -56450,13 +57476,13 @@ otherwise. input #GFile + line="22145">input #GFile a #GAsyncResult + line="22146">a #GAsyncResult @@ -56472,7 +57498,7 @@ otherwise. input #GFile + line="24681">input #GFile allow-none="1"> optional #GCancellable object, %NULL to ignore + line="24682">optional #GCancellable object, %NULL to ignore closure="3"> a #GAsyncReadyCallback to call + line="24683">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -56503,7 +57529,7 @@ otherwise. closure="3"> the data to pass to callback function + line="24685">the data to pass to callback function @@ -56515,7 +57541,7 @@ otherwise. %TRUE if the operation finished successfully. %FALSE + line="24712">%TRUE if the operation finished successfully. %FALSE otherwise. @@ -56523,13 +57549,13 @@ otherwise. input #GFile + line="24703">input #GFile a #GAsyncResult + line="24704">a #GAsyncResult @@ -56541,7 +57567,7 @@ otherwise. %TRUE if successful, with the out parameters set. + line="24092">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. @@ -56549,13 +57575,13 @@ otherwise. a #GFile + line="24063">a #GFile #GFileMeasureFlags + line="24064">#GFileMeasureFlags allow-none="1"> optional #GCancellable + line="24065">optional #GCancellable closure="4"> a #GFileMeasureProgressCallback + line="24066">a #GFileMeasureProgressCallback @@ -56584,7 +57610,7 @@ otherwise. allow-none="1"> user_data for @progress_callback + line="24067">user_data for @progress_callback allow-none="1"> the number of bytes of disk space used + line="24068">the number of bytes of disk space used allow-none="1"> the number of directories encountered + line="24069">the number of directories encountered allow-none="1"> the number of non-directories encountered + line="24070">the number of non-directories encountered @@ -56633,19 +57659,19 @@ otherwise. a #GFile + line="24100">a #GFile #GFileMeasureFlags + line="24101">#GFileMeasureFlags the [I/O priority][io-priority] of the request + line="24102">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable + line="24103">optional #GCancellable closure="5"> a #GFileMeasureProgressCallback + line="24104">a #GFileMeasureProgressCallback @@ -56674,7 +57700,7 @@ otherwise. allow-none="1"> user_data for @progress_callback + line="24105">user_data for @progress_callback closure="7"> a #GAsyncReadyCallback to call when complete + line="24106">a #GAsyncReadyCallback to call when complete closure="7"> the data to pass to callback function + line="24107">the data to pass to callback function @@ -56707,7 +57733,7 @@ otherwise. %TRUE if successful, with the out parameters set. + line="24131">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. @@ -56715,13 +57741,13 @@ otherwise. a #GFile + line="24120">a #GFile the #GAsyncResult passed to your #GAsyncReadyCallback + line="24121">the #GAsyncResult passed to your #GAsyncReadyCallback allow-none="1"> the number of bytes of disk space used + line="24122">the number of bytes of disk space used allow-none="1"> the number of directories encountered + line="24123">the number of directories encountered allow-none="1"> the number of non-directories encountered + line="24124">the number of non-directories encountered @@ -56770,7 +57796,7 @@ otherwise. glib:type-struct="FileInfoClass"> Functionality for manipulating basic metadata for files. #GFileInfo + line="6628">Functionality for manipulating basic metadata for files. #GFileInfo implements methods for getting information that all files should contain, and allows for manipulation of extended attributes. @@ -56792,26 +57818,31 @@ You may call g_file_query_settable_attributes() and g_file_query_writable_namespaces() to discover the settable attributes of a particular file at runtime. +The direct accessors, such as g_file_info_get_name(), are slightly more +optimized than the generic attribute accessors, such as +g_file_info_get_attribute_byte_string().This optimization will matter +only if calling the API in a tight loop. + #GFileAttributeMatcher allows for searching through a #GFileInfo for attributes. Creates a new file info structure. - + line="23276">Creates a new file info structure. + a #GFileInfo. + line="23281">a #GFileInfo. Clears the status information from @info. - + line="22815">Clears the status information from @info. + @@ -56819,7 +57850,7 @@ attributes. a #GFileInfo. + line="22817">a #GFileInfo. @@ -56827,9 +57858,9 @@ attributes. First clears all of the [GFileAttribute][gio-GFileAttribute] of @dest_info, + line="22823">First clears all of the [GFileAttribute][gio-GFileAttribute] of @dest_info, and then copies all of the file attributes from @src_info to @dest_info. - + @@ -56837,13 +57868,13 @@ and then copies all of the file attributes from @src_info to @dest_info. source to copy attributes from. + line="22825">source to copy attributes from. destination to copy attributes to. + line="22826">destination to copy attributes to. @@ -56851,19 +57882,46 @@ and then copies all of the file attributes from @src_info to @dest_info. Duplicates a file info structure. - + line="22833">Duplicates a file info structure. + a duplicate #GFileInfo of @other. + line="22839">a duplicate #GFileInfo of @other. a #GFileInfo. + line="22835">a #GFileInfo. + + + + + + Gets the access time of the current @info and returns it as a +#GDateTime. + +This requires the %G_FILE_ATTRIBUTE_TIME_ACCESS attribute. If +%G_FILE_ATTRIBUTE_TIME_ACCESS_USEC is provided, the resulting #GDateTime +will have microsecond precision. + + + access time, or %NULL if unknown + + + + + a #GFileInfo. @@ -56872,14 +57930,14 @@ and then copies all of the file attributes from @src_info to @dest_info. c:identifier="g_file_info_get_attribute_as_string"> Gets the value of a attribute, formatted as a string. + line="22859">Gets the value of a attribute, formatted as a string. This escapes things as needed to make the string valid UTF-8. - + a UTF-8 string associated with the given @attribute, or + line="22868">a UTF-8 string associated with the given @attribute, or %NULL if the attribute wasn’t set. When you're done with the string it must be freed with g_free(). @@ -56888,13 +57946,13 @@ UTF-8. a #GFileInfo. + line="22861">a #GFileInfo. a file attribute key. + line="22862">a file attribute key. @@ -56903,26 +57961,26 @@ UTF-8. c:identifier="g_file_info_get_attribute_boolean"> Gets the value of a boolean attribute. If the attribute does not + line="22874">Gets the value of a boolean attribute. If the attribute does not contain a boolean value, %FALSE will be returned. - + the boolean value contained within the attribute. + line="22882">the boolean value contained within the attribute. a #GFileInfo. + line="22876">a #GFileInfo. a file attribute key. + line="22877">a file attribute key. @@ -56931,13 +57989,13 @@ contain a boolean value, %FALSE will be returned. c:identifier="g_file_info_get_attribute_byte_string"> Gets the value of a byte string attribute. If the attribute does + line="22886">Gets the value of a byte string attribute. If the attribute does not contain a byte string, %NULL will be returned. - + the contents of the @attribute value as a byte string, or + line="22894">the contents of the @attribute value as a byte string, or %NULL otherwise. @@ -56945,13 +58003,13 @@ not contain a byte string, %NULL will be returned. a #GFileInfo. + line="22888">a #GFileInfo. a file attribute key. + line="22889">a file attribute key. @@ -56960,12 +58018,12 @@ not contain a byte string, %NULL will be returned. c:identifier="g_file_info_get_attribute_data"> Gets the attribute type, value and status for an attribute key. - + line="22899">Gets the attribute type, value and status for an attribute key. + %TRUE if @info has an attribute named @attribute, + line="22910">%TRUE if @info has an attribute named @attribute, %FALSE otherwise. @@ -56973,13 +58031,13 @@ not contain a byte string, %NULL will be returned. a #GFileInfo + line="22901">a #GFileInfo a file attribute key + line="22902">a file attribute key allow-none="1"> return location for the attribute type, or %NULL + line="22903">return location for the attribute type, or %NULL allow-none="1"> return location for the + line="22904">return location for the attribute value, or %NULL; the attribute value will not be %NULL @@ -57013,7 +58071,7 @@ not contain a byte string, %NULL will be returned. allow-none="1"> return location for the attribute status, or %NULL + line="22906">return location for the attribute status, or %NULL @@ -57022,27 +58080,27 @@ not contain a byte string, %NULL will be returned. c:identifier="g_file_info_get_attribute_int32"> Gets a signed 32-bit integer contained within the attribute. If the + line="22915">Gets a signed 32-bit integer contained within the attribute. If the attribute does not contain a signed 32-bit integer, or is invalid, 0 will be returned. - + a signed 32-bit integer from the attribute. + line="22924">a signed 32-bit integer from the attribute. a #GFileInfo. + line="22917">a #GFileInfo. a file attribute key. + line="22918">a file attribute key. @@ -57051,27 +58109,27 @@ attribute does not contain a signed 32-bit integer, or is invalid, c:identifier="g_file_info_get_attribute_int64"> Gets a signed 64-bit integer contained within the attribute. If the + line="22928">Gets a signed 64-bit integer contained within the attribute. If the attribute does not contain a signed 64-bit integer, or is invalid, 0 will be returned. - + a signed 64-bit integer from the attribute. + line="22937">a signed 64-bit integer from the attribute. a #GFileInfo. + line="22930">a #GFileInfo. a file attribute key. + line="22931">a file attribute key. @@ -57080,13 +58138,13 @@ attribute does not contain a signed 64-bit integer, or is invalid, c:identifier="g_file_info_get_attribute_object"> Gets the value of a #GObject attribute. If the attribute does + line="22941">Gets the value of a #GObject attribute. If the attribute does not contain a #GObject, %NULL will be returned. - + a #GObject associated with the given @attribute, + line="22949">a #GObject associated with the given @attribute, or %NULL otherwise. @@ -57094,13 +58152,13 @@ or %NULL otherwise. a #GFileInfo. + line="22943">a #GFileInfo. a file attribute key. + line="22944">a file attribute key. @@ -57109,12 +58167,12 @@ or %NULL otherwise. c:identifier="g_file_info_get_attribute_status"> Gets the attribute status for an attribute key. - + line="22954">Gets the attribute status for an attribute key. + a #GFileAttributeStatus for the given @attribute, or + line="22961">a #GFileAttributeStatus for the given @attribute, or %G_FILE_ATTRIBUTE_STATUS_UNSET if the key is invalid. @@ -57122,13 +58180,13 @@ or %NULL otherwise. a #GFileInfo + line="22956">a #GFileInfo a file attribute key + line="22957">a file attribute key @@ -57137,13 +58195,13 @@ or %NULL otherwise. c:identifier="g_file_info_get_attribute_string"> Gets the value of a string attribute. If the attribute does + line="22966">Gets the value of a string attribute. If the attribute does not contain a string, %NULL will be returned. - + the contents of the @attribute value as a UTF-8 string, + line="22974">the contents of the @attribute value as a UTF-8 string, or %NULL otherwise. @@ -57151,13 +58209,13 @@ or %NULL otherwise. a #GFileInfo. + line="22968">a #GFileInfo. a file attribute key. + line="22969">a file attribute key. @@ -57167,13 +58225,13 @@ or %NULL otherwise. version="2.22"> Gets the value of a stringv attribute. If the attribute does + line="22979">Gets the value of a stringv attribute. If the attribute does not contain a stringv, %NULL will be returned. - + the contents of the @attribute value as a stringv, + line="22987">the contents of the @attribute value as a stringv, or %NULL otherwise. Do not free. These returned strings are UTF-8. @@ -57183,13 +58241,13 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. a #GFileInfo. + line="22981">a #GFileInfo. a file attribute key. + line="22982">a file attribute key. @@ -57198,12 +58256,12 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. c:identifier="g_file_info_get_attribute_type"> Gets the attribute type for an attribute key. - + line="22993">Gets the attribute type for an attribute key. + a #GFileAttributeType for the given @attribute, or + line="23000">a #GFileAttributeType for the given @attribute, or %G_FILE_ATTRIBUTE_TYPE_INVALID if the key is not set. @@ -57211,13 +58269,13 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. a #GFileInfo. + line="22995">a #GFileInfo. a file attribute key. + line="22996">a file attribute key. @@ -57226,27 +58284,27 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. c:identifier="g_file_info_get_attribute_uint32"> Gets an unsigned 32-bit integer contained within the attribute. If the + line="23005">Gets an unsigned 32-bit integer contained within the attribute. If the attribute does not contain an unsigned 32-bit integer, or is invalid, 0 will be returned. - + an unsigned 32-bit integer from the attribute. + line="23014">an unsigned 32-bit integer from the attribute. a #GFileInfo. + line="23007">a #GFileInfo. a file attribute key. + line="23008">a file attribute key. @@ -57255,27 +58313,27 @@ attribute does not contain an unsigned 32-bit integer, or is invalid, c:identifier="g_file_info_get_attribute_uint64"> Gets a unsigned 64-bit integer contained within the attribute. If the + line="23018">Gets a unsigned 64-bit integer contained within the attribute. If the attribute does not contain an unsigned 64-bit integer, or is invalid, 0 will be returned. - + a unsigned 64-bit integer from the attribute. + line="23027">a unsigned 64-bit integer from the attribute. a #GFileInfo. + line="23020">a #GFileInfo. a file attribute key. + line="23021">a file attribute key. @@ -57284,12 +58342,12 @@ attribute does not contain an unsigned 64-bit integer, or is invalid, c:identifier="g_file_info_get_content_type"> Gets the file's content type. - + line="23031">Gets the file's content type. + a string containing the file's content type, + line="23037">a string containing the file's content type, or %NULL if unknown. @@ -57297,7 +58355,34 @@ or %NULL if unknown. a #GFileInfo. + line="23033">a #GFileInfo. + + + + + + Gets the creation time of the current @info and returns it as a +#GDateTime. + +This requires the %G_FILE_ATTRIBUTE_TIME_CREATED attribute. If +%G_FILE_ATTRIBUTE_TIME_CREATED_USEC is provided, the resulting #GDateTime +will have microsecond precision. + + + creation time, or %NULL if unknown + + + + + a #GFileInfo. @@ -57307,21 +58392,21 @@ or %NULL if unknown. version="2.36"> Returns the #GDateTime representing the deletion date of the file, as + line="23058">Returns the #GDateTime representing the deletion date of the file, as available in G_FILE_ATTRIBUTE_TRASH_DELETION_DATE. If the G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. - + a #GDateTime, or %NULL. + line="23066">a #GDateTime, or %NULL. a #GFileInfo. + line="23060">a #GFileInfo. @@ -57330,19 +58415,19 @@ G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. Gets a display name for a file. This is guaranteed to always be set. - + line="23071">Gets a display name for a file. This is guaranteed to always be set. + a string containing the display name. + line="23077">a string containing the display name. a #GFileInfo. + line="23073">a #GFileInfo. @@ -57350,19 +58435,19 @@ G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. Gets the edit name for a file. - + line="23081">Gets the edit name for a file. + a string containing the edit name. + line="23087">a string containing the edit name. a #GFileInfo. + line="23083">a #GFileInfo. @@ -57370,20 +58455,20 @@ G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. Gets the [entity tag][gfile-etag] for a given + line="23091">Gets the [entity tag][gfile-etag] for a given #GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE. - - + + a string containing the value of the "etag:value" attribute. + line="23098">a string containing the value of the "etag:value" attribute. a #GFileInfo. + line="23093">a #GFileInfo. @@ -57391,20 +58476,20 @@ G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. Gets a file's type (whether it is a regular file, symlink, etc). + line="23102">Gets a file's type (whether it is a regular file, symlink, etc). This is different from the file's content type, see g_file_info_get_content_type(). - + a #GFileType for the given file. + line="23109">a #GFileType for the given file. a #GFileInfo. + line="23104">a #GFileInfo. @@ -57412,19 +58497,19 @@ This is different from the file's content type, see g_file_info_get_content_type Gets the icon for a file. - - + line="23113">Gets the icon for a file. + + #GIcon for the given @info. + line="23119">#GIcon for the given @info. a #GFileInfo. + line="23115">a #GFileInfo. @@ -57432,19 +58517,19 @@ This is different from the file's content type, see g_file_info_get_content_type Checks if a file is a backup file. - + line="23123">Checks if a file is a backup file. + %TRUE if file is a backup file, %FALSE otherwise. + line="23129">%TRUE if file is a backup file, %FALSE otherwise. a #GFileInfo. + line="23125">a #GFileInfo. @@ -57452,19 +58537,19 @@ This is different from the file's content type, see g_file_info_get_content_type Checks if a file is hidden. - + line="23133">Checks if a file is hidden. + %TRUE if the file is a hidden file, %FALSE otherwise. + line="23139">%TRUE if the file is a hidden file, %FALSE otherwise. a #GFileInfo. + line="23135">a #GFileInfo. @@ -57472,19 +58557,19 @@ This is different from the file's content type, see g_file_info_get_content_type Checks if a file is a symlink. - + line="23143">Checks if a file is a symlink. + %TRUE if the given @info is a symlink. + line="23149">%TRUE if the given @info is a symlink. a #GFileInfo. + line="23145">a #GFileInfo. @@ -57494,24 +58579,24 @@ This is different from the file's content type, see g_file_info_get_content_type version="2.62"> Gets the modification time of the current @info and returns it as a + line="23153">Gets the modification time of the current @info and returns it as a #GDateTime. This requires the %G_FILE_ATTRIBUTE_TIME_MODIFIED attribute. If %G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC is provided, the resulting #GDateTime will have microsecond precision. - + modification time, or %NULL if unknown + line="23164">modification time, or %NULL if unknown a #GFileInfo. + line="23155">a #GFileInfo. @@ -57522,11 +58607,11 @@ will have microsecond precision. deprecated-version="2.62"> Gets the modification time of the current @info and sets it + line="23169">Gets the modification time of the current @info and sets it in @result. Use g_file_info_get_modification_date_time() instead, as #GTimeVal is deprecated due to the year 2038 problem. - + @@ -57534,7 +58619,7 @@ in @result. a #GFileInfo. + line="23171">a #GFileInfo. transfer-ownership="none"> a #GTimeVal. + line="23172">a #GTimeVal. @@ -57551,19 +58636,19 @@ in @result. Gets the name for a file. This is guaranteed to always be set. - + line="23182">Gets the name for a file. This is guaranteed to always be set. + a string containing the file name. + line="23188">a string containing the file name. a #GFileInfo. + line="23184">a #GFileInfo. @@ -57571,19 +58656,21 @@ in @result. Gets the file's size. - + line="23192">Gets the file's size (in bytes). The size is retrieved through the value of +the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute and is converted +from #guint64 to #goffset before returning the result. + a #goffset containing the file's size. + line="23200">a #goffset containing the file's size (in bytes). a #GFileInfo. + line="23194">a #GFileInfo. @@ -57591,20 +58678,20 @@ in @result. Gets the value of the sort_order attribute from the #GFileInfo. + line="23204">Gets the value of the sort_order attribute from the #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. - + a #gint32 containing the value of the "standard::sort_order" attribute. + line="23211">a #gint32 containing the value of the "standard::sort_order" attribute. a #GFileInfo. + line="23206">a #GFileInfo. @@ -57614,19 +58701,19 @@ See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. version="2.34"> Gets the symbolic icon for a file. - - + line="23215">Gets the symbolic icon for a file. + + #GIcon for the given @info. + line="23221">#GIcon for the given @info. a #GFileInfo. + line="23217">a #GFileInfo. @@ -57635,19 +58722,19 @@ See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. c:identifier="g_file_info_get_symlink_target"> Gets the symlink target for a given #GFileInfo. - - + line="23226">Gets the symlink target for a given #GFileInfo. + + a string containing the symlink target. + line="23232">a string containing the symlink target. a #GFileInfo. + line="23228">a #GFileInfo. @@ -57655,12 +58742,12 @@ See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. Checks if a file info structure has an attribute named @attribute. - + line="23236">Checks if a file info structure has an attribute named @attribute. + %TRUE if @info has an attribute named @attribute, + line="23243">%TRUE if @info has an attribute named @attribute, %FALSE otherwise. @@ -57668,13 +58755,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. a #GFileInfo. + line="23238">a #GFileInfo. a file attribute key. + line="23239">a file attribute key. @@ -57684,13 +58771,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. version="2.22"> Checks if a file info structure has an attribute in the + line="23248">Checks if a file info structure has an attribute in the specified @name_space. - + %TRUE if @info has an attribute in @name_space, + line="23256">%TRUE if @info has an attribute in @name_space, %FALSE otherwise. @@ -57698,13 +58785,13 @@ specified @name_space. a #GFileInfo. + line="23250">a #GFileInfo. a file attribute namespace. + line="23251">a file attribute namespace. @@ -57713,12 +58800,12 @@ specified @name_space. c:identifier="g_file_info_list_attributes"> Lists the file info structure's attributes. - + line="23262">Lists the file info structure's attributes. + a + line="23270">a null-terminated array of strings of all of the possible attribute types for the given @name_space, or %NULL on error. @@ -57729,7 +58816,7 @@ types for the given @name_space, or %NULL on error. a #GFileInfo. + line="23264">a #GFileInfo. allow-none="1"> a file attribute key's namespace, or %NULL to list + line="23265">a file attribute key's namespace, or %NULL to list all attributes. @@ -57748,8 +58835,8 @@ types for the given @name_space, or %NULL on error. c:identifier="g_file_info_remove_attribute"> Removes all cases of @attribute from @info if it exists. - + line="23285">Removes all cases of @attribute from @info if it exists. + @@ -57757,23 +58844,50 @@ types for the given @name_space, or %NULL on error. a #GFileInfo. + line="23287">a #GFileInfo. a file attribute key. + line="23288">a file attribute key. + + Sets the %G_FILE_ATTRIBUTE_TIME_ACCESS and +%G_FILE_ATTRIBUTE_TIME_ACCESS_USEC attributes in the file info to the +given date/time value. + + + + + + + a #GFileInfo. + + + + a #GDateTime. + + + + Sets the @attribute to contain the given value, if possible. To unset the + line="23307">Sets the @attribute to contain the given value, if possible. To unset the attribute, use %G_FILE_ATTRIBUTE_TYPE_INVALID for @type. - + @@ -57781,25 +58895,25 @@ attribute, use %G_FILE_ATTRIBUTE_TYPE_INVALID for @type. a #GFileInfo. + line="23309">a #GFileInfo. a file attribute key. + line="23310">a file attribute key. a #GFileAttributeType + line="23311">a #GFileAttributeType pointer to the value + line="23312">pointer to the value @@ -57808,9 +58922,9 @@ attribute, use %G_FILE_ATTRIBUTE_TYPE_INVALID for @type. c:identifier="g_file_info_set_attribute_boolean"> Sets the @attribute to contain the given @attr_value, + line="23319">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -57818,19 +58932,19 @@ if possible. a #GFileInfo. + line="23321">a #GFileInfo. a file attribute key. + line="23322">a file attribute key. a boolean value. + line="23323">a boolean value. @@ -57839,9 +58953,9 @@ if possible. c:identifier="g_file_info_set_attribute_byte_string"> Sets the @attribute to contain the given @attr_value, + line="23330">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -57849,19 +58963,19 @@ if possible. a #GFileInfo. + line="23332">a #GFileInfo. a file attribute key. + line="23333">a file attribute key. a byte string. + line="23334">a byte string. @@ -57870,9 +58984,9 @@ if possible. c:identifier="g_file_info_set_attribute_int32"> Sets the @attribute to contain the given @attr_value, + line="23341">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -57880,19 +58994,19 @@ if possible. a #GFileInfo. + line="23343">a #GFileInfo. a file attribute key. + line="23344">a file attribute key. a signed 32-bit integer + line="23345">a signed 32-bit integer @@ -57901,9 +59015,9 @@ if possible. c:identifier="g_file_info_set_attribute_int64"> Sets the @attribute to contain the given @attr_value, + line="23352">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -57911,19 +59025,19 @@ if possible. a #GFileInfo. + line="23354">a #GFileInfo. attribute name to set. + line="23355">attribute name to set. int64 value to set attribute to. + line="23356">int64 value to set attribute to. @@ -57932,8 +59046,8 @@ if possible. c:identifier="g_file_info_set_attribute_mask"> Sets @mask on @info to match specific attribute types. - + line="23363">Sets @mask on @info to match specific attribute types. + @@ -57941,13 +59055,13 @@ if possible. a #GFileInfo. + line="23365">a #GFileInfo. a #GFileAttributeMatcher. + line="23366">a #GFileAttributeMatcher. @@ -57956,9 +59070,9 @@ if possible. c:identifier="g_file_info_set_attribute_object"> Sets the @attribute to contain the given @attr_value, + line="23372">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -57966,19 +59080,19 @@ if possible. a #GFileInfo. + line="23374">a #GFileInfo. a file attribute key. + line="23375">a file attribute key. a #GObject. + line="23376">a #GObject. @@ -57988,36 +59102,36 @@ if possible. version="2.22"> Sets the attribute status for an attribute key. This is only + line="23383">Sets the attribute status for an attribute key. This is only needed by external code that implement g_file_set_attributes_from_info() or similar functions. The attribute must exist in @info for this to work. Otherwise %FALSE is returned and @info is unchanged. - + %TRUE if the status was changed, %FALSE if the key was not set. + line="23396">%TRUE if the status was changed, %FALSE if the key was not set. a #GFileInfo + line="23385">a #GFileInfo a file attribute key + line="23386">a file attribute key a #GFileAttributeStatus + line="23387">a #GFileAttributeStatus @@ -58026,9 +59140,9 @@ is returned and @info is unchanged. c:identifier="g_file_info_set_attribute_string"> Sets the @attribute to contain the given @attr_value, + line="23401">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -58036,19 +59150,19 @@ if possible. a #GFileInfo. + line="23403">a #GFileInfo. a file attribute key. + line="23404">a file attribute key. a UTF-8 string. + line="23405">a UTF-8 string. @@ -58057,11 +59171,11 @@ if possible. c:identifier="g_file_info_set_attribute_stringv"> Sets the @attribute to contain the given @attr_value, + line="23412">Sets the @attribute to contain the given @attr_value, if possible. Sinze: 2.22 - + @@ -58069,19 +59183,19 @@ Sinze: 2.22 a #GFileInfo. + line="23414">a #GFileInfo. a file attribute key + line="23415">a file attribute key a %NULL + line="23416">a %NULL terminated array of UTF-8 strings. @@ -58093,9 +59207,9 @@ Sinze: 2.22 c:identifier="g_file_info_set_attribute_uint32"> Sets the @attribute to contain the given @attr_value, + line="23426">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -58103,19 +59217,19 @@ if possible. a #GFileInfo. + line="23428">a #GFileInfo. a file attribute key. + line="23429">a file attribute key. an unsigned 32-bit integer. + line="23430">an unsigned 32-bit integer. @@ -58124,9 +59238,9 @@ if possible. c:identifier="g_file_info_set_attribute_uint64"> Sets the @attribute to contain the given @attr_value, + line="23437">Sets the @attribute to contain the given @attr_value, if possible. - + @@ -58134,19 +59248,19 @@ if possible. a #GFileInfo. + line="23439">a #GFileInfo. a file attribute key. + line="23440">a file attribute key. an unsigned 64-bit integer. + line="23441">an unsigned 64-bit integer. @@ -58155,9 +59269,9 @@ if possible. c:identifier="g_file_info_set_content_type"> Sets the content type attribute for a given #GFileInfo. + line="23448">Sets the content type attribute for a given #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. - + @@ -58165,24 +59279,51 @@ See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. a #GFileInfo. + line="23450">a #GFileInfo. a content type. See [GContentType][gio-GContentType] + line="23451">a content type. See [GContentType][gio-GContentType] + + Sets the %G_FILE_ATTRIBUTE_TIME_CREATED and +%G_FILE_ATTRIBUTE_TIME_CREATED_USEC attributes in the file info to the +given date/time value. + + + + + + + a #GFileInfo. + + + + a #GDateTime. + + + + Sets the display name for the current #GFileInfo. + line="23471">Sets the display name for the current #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. - + @@ -58190,13 +59331,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. a #GFileInfo. + line="23473">a #GFileInfo. a string containing a display name. + line="23474">a string containing a display name. @@ -58204,9 +59345,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. Sets the edit name for the current file. + line="23481">Sets the edit name for the current file. See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. - + @@ -58214,13 +59355,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. a #GFileInfo. + line="23483">a #GFileInfo. a string containing an edit name. + line="23484">a string containing an edit name. @@ -58228,9 +59369,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. Sets the file type in a #GFileInfo to @type. + line="23491">Sets the file type in a #GFileInfo to @type. See %G_FILE_ATTRIBUTE_STANDARD_TYPE. - + @@ -58238,13 +59379,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_TYPE. a #GFileInfo. + line="23493">a #GFileInfo. a #GFileType. + line="23494">a #GFileType. @@ -58252,9 +59393,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_TYPE. Sets the icon for a given #GFileInfo. + line="23501">Sets the icon for a given #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_ICON. - + @@ -58262,13 +59403,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_ICON. a #GFileInfo. + line="23503">a #GFileInfo. a #GIcon. + line="23504">a #GIcon. @@ -58276,9 +59417,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_ICON. Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden. + line="23511">Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden. See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN. - + @@ -58286,13 +59427,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN. a #GFileInfo. + line="23513">a #GFileInfo. a #gboolean. + line="23514">a #gboolean. @@ -58300,9 +59441,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN. Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink. + line="23521">Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink. See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. - + @@ -58310,13 +59451,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. a #GFileInfo. + line="23523">a #GFileInfo. a #gboolean. + line="23524">a #gboolean. @@ -58326,10 +59467,10 @@ See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. version="2.62"> Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and + line="23531">Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and %G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given date/time value. - + @@ -58337,13 +59478,13 @@ given date/time value. a #GFileInfo. + line="23533">a #GFileInfo. a #GDateTime. + line="23534">a #GDateTime. @@ -58354,12 +59495,12 @@ given date/time value. deprecated-version="2.62"> Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and + line="23544">Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and %G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given time value. Use g_file_info_set_modification_date_time() instead, as #GTimeVal is deprecated due to the year 2038 problem. - + @@ -58367,13 +59508,13 @@ given time value. a #GFileInfo. + line="23546">a #GFileInfo. a #GTimeVal. + line="23547">a #GTimeVal. @@ -58381,9 +59522,9 @@ given time value. Sets the name attribute for the current #GFileInfo. + line="23558">Sets the name attribute for the current #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_NAME. - + @@ -58391,13 +59532,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_NAME. a #GFileInfo. + line="23560">a #GFileInfo. a string containing a name. + line="23561">a string containing a name. @@ -58405,9 +59546,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_NAME. Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info + line="23568">Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info to the given size. - + @@ -58415,13 +59556,13 @@ to the given size. a #GFileInfo. + line="23570">a #GFileInfo. a #goffset containing the file's size. + line="23571">a #goffset containing the file's size. @@ -58429,9 +59570,9 @@ to the given size. Sets the sort order attribute in the file info structure. See + line="23578">Sets the sort order attribute in the file info structure. See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. - + @@ -58439,13 +59580,13 @@ to the given size. a #GFileInfo. + line="23580">a #GFileInfo. a sort order integer. + line="23581">a sort order integer. @@ -58455,9 +59596,9 @@ to the given size. version="2.34"> Sets the symbolic icon for a given #GFileInfo. + line="23588">Sets the symbolic icon for a given #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. - + @@ -58465,13 +59606,13 @@ See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. a #GFileInfo. + line="23590">a #GFileInfo. a #GIcon. + line="23591">a #GIcon. @@ -58480,9 +59621,9 @@ See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. c:identifier="g_file_info_set_symlink_target"> Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info + line="23600">Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info to the given symlink target. - + @@ -58490,13 +59631,13 @@ to the given symlink target. a #GFileInfo. + line="23602">a #GFileInfo. a static string containing a path to a symlink target. + line="23603">a static string containing a path to a symlink target. @@ -58505,9 +59646,9 @@ to the given symlink target. c:identifier="g_file_info_unset_attribute_mask"> Unsets a mask set by g_file_info_set_attribute_mask(), if one + line="23610">Unsets a mask set by g_file_info_set_attribute_mask(), if one is set. - + @@ -58515,7 +59656,7 @@ is set. #GFileInfo. + line="23612">#GFileInfo. @@ -58536,7 +59677,7 @@ is set. glib:type-struct="FileInputStreamClass"> GFileInputStream provides input streams that take their + line="6666">GFileInputStream provides input streams that take their content from a file. GFileInputStream implements #GSeekable, which allows the input @@ -58561,7 +59702,7 @@ To position a file input stream, use g_seekable_seek(). Queries a file input stream the given @attributes. This function blocks + line="23619">Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and @@ -58570,20 +59711,20 @@ any other operations on the stream will fail with %G_IO_ERROR_PENDING. a #GFileInfo, or %NULL on error. + line="23633">a #GFileInfo, or %NULL on error. a #GFileInputStream. + line="23621">a #GFileInputStream. a file attribute query string. + line="23622">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23623">optional #GCancellable object, %NULL to ignore. @@ -58600,7 +59741,7 @@ any other operations on the stream will fail with %G_IO_ERROR_PENDING. Queries the stream information asynchronously. + line="23637">Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation. @@ -58619,19 +59760,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set a #GFileInputStream. + line="23639">a #GFileInputStream. a file attribute query string. + line="23640">a file attribute query string. the [I/O priority][io-priority] of the request + line="23641">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23642">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="23643">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="23644">the data to pass to callback function @@ -58671,25 +59812,25 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set throws="1"> Finishes an asynchronous info query operation. + line="23660">Finishes an asynchronous info query operation. #GFileInfo. + line="23669">#GFileInfo. a #GFileInputStream. + line="23662">a #GFileInputStream. a #GAsyncResult. + line="23663">a #GAsyncResult. @@ -58733,7 +59874,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set throws="1"> Queries a file input stream the given @attributes. This function blocks + line="23619">Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and @@ -58742,20 +59883,20 @@ any other operations on the stream will fail with %G_IO_ERROR_PENDING. a #GFileInfo, or %NULL on error. + line="23633">a #GFileInfo, or %NULL on error. a #GFileInputStream. + line="23621">a #GFileInputStream. a file attribute query string. + line="23622">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23623">optional #GCancellable object, %NULL to ignore. @@ -58773,7 +59914,7 @@ any other operations on the stream will fail with %G_IO_ERROR_PENDING. c:identifier="g_file_input_stream_query_info_async"> Queries the stream information asynchronously. + line="23637">Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation. @@ -58792,19 +59933,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set a #GFileInputStream. + line="23639">a #GFileInputStream. a file attribute query string. + line="23640">a file attribute query string. the [I/O priority][io-priority] of the request + line="23641">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23642">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="23643">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="23644">the data to pass to callback function @@ -58843,25 +59984,25 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set throws="1"> Finishes an asynchronous info query operation. + line="23660">Finishes an asynchronous info query operation. #GFileInfo. + line="23669">#GFileInfo. a #GFileInputStream. + line="23662">a #GFileInputStream. a #GAsyncResult. + line="23663">a #GAsyncResult. @@ -58937,20 +60078,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set a #GFileInfo, or %NULL on error. + line="23633">a #GFileInfo, or %NULL on error. a #GFileInputStream. + line="23621">a #GFileInputStream. a file attribute query string. + line="23622">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23623">optional #GCancellable object, %NULL to ignore. @@ -58975,19 +60116,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set a #GFileInputStream. + line="23639">a #GFileInputStream. a file attribute query string. + line="23640">a file attribute query string. the [I/O priority][io-priority] of the request + line="23641">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="23642">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="23643">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="23644">the data to pass to callback function @@ -59029,20 +60170,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set #GFileInfo. + line="23669">#GFileInfo. a #GFileInputStream. + line="23662">a #GFileInputStream. a #GAsyncResult. + line="23663">a #GAsyncResult. @@ -59105,7 +60246,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set + glib:nick="none" + glib:name="G_FILE_MEASURE_NONE"> No flags set. @@ -59113,7 +60255,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set + glib:nick="report-any-error" + glib:name="G_FILE_MEASURE_REPORT_ANY_ERROR"> Report any error encountered @@ -59123,7 +60266,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set + glib:nick="apparent-size" + glib:name="G_FILE_MEASURE_APPARENT_SIZE"> Tally usage based on apparent file @@ -59134,7 +60278,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set + glib:nick="no-xdev" + glib:name="G_FILE_MEASURE_NO_XDEV"> Do not cross mount point boundaries. @@ -59146,7 +60291,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set version="2.38"> This callback type is used by g_file_measure_disk_usage() to make + line="314">This callback type is used by g_file_measure_disk_usage() to make periodic progress reports when measuring the amount of disk spaced used by a directory. @@ -59173,7 +60318,7 @@ ideally about once every 200ms. The last progress callback may or may not be equal to the final result. Always check the async result to get the final value. - + @@ -59181,25 +60326,25 @@ result. Always check the async result to get the final value. %TRUE if more reports will come + line="316">%TRUE if more reports will come the current cumulative size measurement + line="317">the current cumulative size measurement the number of directories visited so far + line="318">the number of directories visited so far the number of non-directory files encountered + line="319">the number of non-directory files encountered closure="4"> the data passed to the original request for this callback + line="320">the data passed to the original request for this callback @@ -59224,7 +60369,7 @@ result. Always check the async result to get the final value. glib:type-struct="FileMonitorClass"> Monitors a file or directory for changes. + line="6715">Monitors a file or directory for changes. To obtain a #GFileMonitor for a file or directory, use g_file_monitor(), g_file_monitor_file(), or @@ -59242,19 +60387,19 @@ context is still running). Cancels a file monitor. + line="24159">Cancels a file monitor. always %TRUE + line="24165">always %TRUE a #GFileMonitor. + line="24161">a #GFileMonitor. @@ -59282,19 +60427,19 @@ context is still running). Cancels a file monitor. + line="24159">Cancels a file monitor. always %TRUE + line="24165">always %TRUE a #GFileMonitor. + line="24161">a #GFileMonitor. @@ -59302,7 +60447,7 @@ context is still running). Emits the #GFileMonitor::changed signal if a change + line="24196">Emits the #GFileMonitor::changed signal if a change has taken place. Should be called from file monitor implementations only. @@ -59317,25 +60462,25 @@ thread that the monitor was created in. a #GFileMonitor. + line="24198">a #GFileMonitor. a #GFile. + line="24199">a #GFile. a #GFile. + line="24200">a #GFile. a set of #GFileMonitorEvent flags. + line="24201">a set of #GFileMonitorEvent flags. @@ -59343,28 +60488,29 @@ thread that the monitor was created in. Returns whether the monitor is canceled. + line="24242">Returns whether the monitor is canceled. %TRUE if monitor is canceled. %FALSE otherwise. + line="24248">%TRUE if monitor is canceled. %FALSE otherwise. a #GFileMonitor + line="24244">a #GFileMonitor + c:identifier="g_file_monitor_set_rate_limit" + glib:set-property="rate-limit"> Sets the rate limit to which the @monitor will report + line="24252">Sets the rate limit to which the @monitor will report consecutive change events to the same file. @@ -59374,13 +60520,13 @@ consecutive change events to the same file. a #GFileMonitor. + line="24254">a #GFileMonitor. a non-negative integer with the limit in milliseconds + line="24255">a non-negative integer with the limit in milliseconds to poll for changes @@ -59389,7 +60535,10 @@ consecutive change events to the same file. - + @@ -59401,7 +60550,7 @@ consecutive change events to the same file. Emitted when @file has been changed. + line="1810">Emitted when @file has been changed. If using %G_FILE_MONITOR_WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), @@ -59436,7 +60585,7 @@ In all the other cases, @other_file will be set to #NULL. a #GFile. + line="1813">a #GFile. allow-none="1"> a #GFile or #NULL. + line="1814">a #GFile or #NULL. a #GFileMonitorEvent. + line="1815">a #GFileMonitorEvent. @@ -59492,14 +60641,14 @@ In all the other cases, @other_file will be set to #NULL. always %TRUE + line="24165">always %TRUE a #GFileMonitor. + line="24161">a #GFileMonitor. @@ -59556,7 +60705,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="changed" + glib:name="G_FILE_MONITOR_EVENT_CHANGED"> a file changed. @@ -59564,7 +60714,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="changes-done-hint" + glib:name="G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT"> a hint that this was probably the last change in a set of changes. @@ -59572,7 +60723,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="deleted" + glib:name="G_FILE_MONITOR_EVENT_DELETED"> a file was deleted. @@ -59580,7 +60732,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="created" + glib:name="G_FILE_MONITOR_EVENT_CREATED"> a file was created. @@ -59588,7 +60741,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="attribute-changed" + glib:name="G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED"> a file attribute was changed. @@ -59596,7 +60750,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="pre-unmount" + glib:name="G_FILE_MONITOR_EVENT_PRE_UNMOUNT"> the file location will soon be unmounted. @@ -59604,7 +60759,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="unmounted" + glib:name="G_FILE_MONITOR_EVENT_UNMOUNTED"> the file location was unmounted. @@ -59612,7 +60768,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="moved" + glib:name="G_FILE_MONITOR_EVENT_MOVED"> the file was moved -- only sent if the @@ -59621,7 +60778,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="renamed" + glib:name="G_FILE_MONITOR_EVENT_RENAMED"> the file was renamed within the @@ -59631,7 +60789,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="moved-in" + glib:name="G_FILE_MONITOR_EVENT_MOVED_IN"> the file was moved into the @@ -59641,7 +60800,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="moved-out" + glib:name="G_FILE_MONITOR_EVENT_MOVED_OUT"> the file was moved out of the @@ -59659,7 +60819,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="none" + glib:name="G_FILE_MONITOR_NONE"> No flags set. @@ -59667,7 +60828,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="watch-mounts" + glib:name="G_FILE_MONITOR_WATCH_MOUNTS"> Watch for mount events. @@ -59675,7 +60837,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="send-moved" + glib:name="G_FILE_MONITOR_SEND_MOVED"> Pair DELETED and CREATED events caused @@ -59688,7 +60851,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="watch-hard-links" + glib:name="G_FILE_MONITOR_WATCH_HARD_LINKS"> Watch for changes to the file made @@ -59697,7 +60861,8 @@ In all the other cases, @other_file will be set to #NULL. + glib:nick="watch-moves" + glib:name="G_FILE_MONITOR_WATCH_MOVES"> Watch for rename operations on a @@ -59720,7 +60885,7 @@ In all the other cases, @other_file will be set to #NULL. glib:type-struct="FileOutputStreamClass"> GFileOutputStream provides output streams that write their + line="6748">GFileOutputStream provides output streams that write their content to a file. GFileOutputStream implements #GSeekable, which allows the output @@ -59761,21 +60926,21 @@ stream, use g_seekable_truncate(). Gets the entity tag for the file when it has been written. + line="24576">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + line="24584">the entity tag for the stream. a #GFileOutputStream. + line="24578">a #GFileOutputStream. @@ -59783,7 +60948,7 @@ and closed, as the etag can change while writing. Queries a file output stream for the given @attributes. + line="24588">Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -59804,20 +60969,20 @@ be returned. a #GFileInfo for the @stream, or %NULL on error. + line="24613">a #GFileInfo for the @stream, or %NULL on error. a #GFileOutputStream. + line="24590">a #GFileOutputStream. a file attribute query string. + line="24591">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="24592">optional #GCancellable object, %NULL to ignore. @@ -59834,7 +60999,7 @@ be returned. Asynchronously queries the @stream for a #GFileInfo. When completed, + line="24617">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish(). @@ -59848,19 +61013,19 @@ g_file_output_stream_query_info(). a #GFileOutputStream. + line="24619">a #GFileOutputStream. a file attribute query string. + line="24620">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + line="24621">the [I/O priority][gio-GIOScheduler] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="24622">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="24623">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="24624">the data to pass to callback function @@ -59900,26 +61065,26 @@ g_file_output_stream_query_info(). throws="1"> Finalizes the asynchronous query started + line="24635">Finalizes the asynchronous query started by g_file_output_stream_query_info_async(). A #GFileInfo for the finished query. + line="24644">A #GFileInfo for the finished query. a #GFileOutputStream. + line="24637">a #GFileOutputStream. a #GAsyncResult. + line="24638">a #GAsyncResult. @@ -59981,21 +61146,21 @@ by g_file_output_stream_query_info_async(). Gets the entity tag for the file when it has been written. + line="24576">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + line="24584">the entity tag for the stream. a #GFileOutputStream. + line="24578">a #GFileOutputStream. @@ -60005,7 +61170,7 @@ and closed, as the etag can change while writing. throws="1"> Queries a file output stream for the given @attributes. + line="24588">Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -60026,20 +61191,20 @@ be returned. a #GFileInfo for the @stream, or %NULL on error. + line="24613">a #GFileInfo for the @stream, or %NULL on error. a #GFileOutputStream. + line="24590">a #GFileOutputStream. a file attribute query string. + line="24591">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="24592">optional #GCancellable object, %NULL to ignore. @@ -60057,7 +61222,7 @@ be returned. c:identifier="g_file_output_stream_query_info_async"> Asynchronously queries the @stream for a #GFileInfo. When completed, + line="24617">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish(). @@ -60071,19 +61236,19 @@ g_file_output_stream_query_info(). a #GFileOutputStream. + line="24619">a #GFileOutputStream. a file attribute query string. + line="24620">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + line="24621">the [I/O priority][gio-GIOScheduler] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="24622">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="24623">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="24624">the data to pass to callback function @@ -60122,26 +61287,26 @@ g_file_output_stream_query_info(). throws="1"> Finalizes the asynchronous query started + line="24635">Finalizes the asynchronous query started by g_file_output_stream_query_info_async(). A #GFileInfo for the finished query. + line="24644">A #GFileInfo for the finished query. a #GFileOutputStream. + line="24637">a #GFileOutputStream. a #GAsyncResult. + line="24638">a #GAsyncResult. @@ -60253,20 +61418,20 @@ by g_file_output_stream_query_info_async(). a #GFileInfo for the @stream, or %NULL on error. + line="24613">a #GFileInfo for the @stream, or %NULL on error. a #GFileOutputStream. + line="24590">a #GFileOutputStream. a file attribute query string. + line="24591">a file attribute query string. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="24592">optional #GCancellable object, %NULL to ignore. @@ -60291,19 +61456,19 @@ by g_file_output_stream_query_info_async(). a #GFileOutputStream. + line="24619">a #GFileOutputStream. a file attribute query string. + line="24620">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + line="24621">the [I/O priority][gio-GIOScheduler] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="24622">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="24623">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="24624">the data to pass to callback function @@ -60345,20 +61510,20 @@ by g_file_output_stream_query_info_async(). A #GFileInfo for the finished query. + line="24644">A #GFileInfo for the finished query. a #GFileOutputStream. + line="24637">a #GFileOutputStream. a #GAsyncResult. + line="24638">a #GAsyncResult. @@ -60367,17 +61532,17 @@ by g_file_output_stream_query_info_async(). - + the entity tag for the stream. + line="24584">the entity tag for the stream. a #GFileOutputStream. + line="24578">a #GFileOutputStream. @@ -60432,10 +61597,10 @@ by g_file_output_stream_query_info_async(). When doing file operations that may take a while, such as moving + line="283">When doing file operations that may take a while, such as moving a file or copying a file, a progress callback is used to pass how far along that operation is to the application. - + @@ -60443,13 +61608,13 @@ far along that operation is to the application. the current number of bytes in the operation. + line="285">the current number of bytes in the operation. the total number of bytes in the operation. + line="286">the total number of bytes in the operation. closure="2"> user data passed to the callback. + line="287">user data passed to the callback. @@ -60474,7 +61639,8 @@ far along that operation is to the application. + glib:nick="none" + glib:name="G_FILE_QUERY_INFO_NONE"> No flags set. @@ -60482,7 +61648,8 @@ far along that operation is to the application. + glib:nick="nofollow-symlinks" + glib:name="G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS"> Don't follow symlinks. @@ -60491,28 +61658,28 @@ far along that operation is to the application. When loading the partial contents of a file with g_file_load_partial_contents_async(), + line="297">When loading the partial contents of a file with g_file_load_partial_contents_async(), it may become necessary to determine if any more data from the file should be loaded. A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data should be read, or %FALSE otherwise. - + %TRUE if more data should be read back. %FALSE otherwise. + line="308">%TRUE if more data should be read back. %FALSE otherwise. the data as currently read. + line="299">the data as currently read. the size of the data currently read. + line="300">the size of the data currently read. closure="2"> data passed to the callback. + line="301">data passed to the callback. @@ -60546,7 +61713,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="unknown" + glib:name="G_FILE_TYPE_UNKNOWN"> File's type is unknown. @@ -60554,7 +61722,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="regular" + glib:name="G_FILE_TYPE_REGULAR"> File handle represents a regular file. @@ -60562,7 +61731,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="directory" + glib:name="G_FILE_TYPE_DIRECTORY"> File handle represents a directory. @@ -60570,7 +61740,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="symbolic-link" + glib:name="G_FILE_TYPE_SYMBOLIC_LINK"> File handle represents a symbolic link @@ -60579,7 +61750,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="special" + glib:name="G_FILE_TYPE_SPECIAL"> File is a "special" file, such as a socket, fifo, @@ -60588,7 +61760,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="shortcut" + glib:name="G_FILE_TYPE_SHORTCUT"> File is a shortcut (Windows systems). @@ -60596,7 +61769,8 @@ which is why all Windows symlinks will continue to be reported as + glib:nick="mountable" + glib:name="G_FILE_TYPE_MOUNTABLE"> File is a mountable location. @@ -60611,19 +61785,19 @@ which is why all Windows symlinks will continue to be reported as glib:type-struct="FilenameCompleterClass"> Completes partial file and directory names given a partial string by + line="6737">Completes partial file and directory names given a partial string by looking in the file system for clues. Can return a list of possible completion strings for widget implementations. Creates a new filename completer. + line="25927">Creates a new filename completer. a #GFilenameCompleter. + line="25932">a #GFilenameCompleter. @@ -60643,27 +61817,27 @@ completion strings for widget implementations. c:identifier="g_filename_completer_get_completion_suffix"> Obtains a completion for @initial_text from @completer. + line="25902">Obtains a completion for @initial_text from @completer. - + a completed string, or %NULL if no completion exists. - This string is not owned by GIO, so remember to g_free() it - when finished. + line="25909">a completed string, or %NULL if no + completion exists. This string is not owned by GIO, so remember to g_free() + it when finished. the filename completer. + line="25904">the filename completer. text to be completed. + line="25905">text to be completed. @@ -60672,12 +61846,12 @@ completion strings for widget implementations. c:identifier="g_filename_completer_get_completions"> Gets an array of completion strings for a given initial text. + line="25915">Gets an array of completion strings for a given initial text. array of strings with possible completions for @initial_text. + line="25922">array of strings with possible completions for @initial_text. This array must be freed by g_strfreev() when finished. @@ -60687,13 +61861,13 @@ This array must be freed by g_strfreev() when finished. the filename completer. + line="25917">the filename completer. text to be completed. + line="25918">text to be completed. @@ -60702,7 +61876,7 @@ This array must be freed by g_strfreev() when finished. c:identifier="g_filename_completer_set_dirs_only"> If @dirs_only is %TRUE, @completer will only + line="25936">If @dirs_only is %TRUE, @completer will only complete directory names, and not file names. @@ -60712,13 +61886,13 @@ complete directory names, and not file names. the filename completer. + line="25938">the filename completer. a #gboolean. + line="25939">a #gboolean. @@ -60726,7 +61900,7 @@ complete directory names, and not file names. Emitted when the file name completion information comes available. + line="1848">Emitted when the file name completion information comes available. @@ -60789,7 +61963,8 @@ previewed in a file manager. Returned as the value of the key + glib:nick="if-always" + glib:name="G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS"> Only preview files if user has explicitly requested it. @@ -60797,7 +61972,8 @@ previewed in a file manager. Returned as the value of the key + glib:nick="if-local" + glib:name="G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL"> Preview files if user has requested preview of "local" files. @@ -60805,7 +61981,8 @@ previewed in a file manager. Returned as the value of the key + glib:nick="never" + glib:name="G_FILESYSTEM_PREVIEW_TYPE_NEVER"> Never preview files. @@ -60821,59 +61998,62 @@ previewed in a file manager. Returned as the value of the key glib:type-struct="FilterInputStreamClass"> Base class for input stream implementations that perform some + line="6771">Base class for input stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping. + c:identifier="g_filter_input_stream_get_base_stream" + glib:get-property="base-stream"> Gets the base stream for the filter stream. + line="25946">Gets the base stream for the filter stream. a #GInputStream. + line="25952">a #GInputStream. a #GFilterInputStream. + line="25948">a #GFilterInputStream. + c:identifier="g_filter_input_stream_get_close_base_stream" + glib:get-property="close-base-stream"> Returns whether the base stream will be closed when @stream is + line="25956">Returns whether the base stream will be closed when @stream is closed. %TRUE if the base stream will be closed. + line="25963">%TRUE if the base stream will be closed. a #GFilterInputStream. + line="25958">a #GFilterInputStream. + c:identifier="g_filter_input_stream_set_close_base_stream" + glib:set-property="close-base-stream"> Sets whether the base stream will be closed when @stream is closed. + line="25967">Sets whether the base stream will be closed when @stream is closed. @@ -60882,13 +62062,13 @@ closed. a #GFilterInputStream. + line="25969">a #GFilterInputStream. %TRUE to close the base stream. + line="25970">%TRUE to close the base stream. @@ -60896,13 +62076,16 @@ closed. + transfer-ownership="none" + getter="get_base_stream"> + transfer-ownership="none" + setter="set_close_base_stream" + getter="get_close_base_stream"> @@ -60954,50 +62137,52 @@ closed. glib:type-struct="FilterOutputStreamClass"> Base class for output stream implementations that perform some + line="6783">Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping. + c:identifier="g_filter_output_stream_get_base_stream" + glib:get-property="base-stream"> Gets the base stream for the filter stream. + line="25976">Gets the base stream for the filter stream. a #GOutputStream. + line="25982">a #GOutputStream. a #GFilterOutputStream. + line="25978">a #GFilterOutputStream. + c:identifier="g_filter_output_stream_get_close_base_stream" + glib:get-property="close-base-stream"> Returns whether the base stream will be closed when @stream is + line="25986">Returns whether the base stream will be closed when @stream is closed. %TRUE if the base stream will be closed. + line="25993">%TRUE if the base stream will be closed. a #GFilterOutputStream. + line="25988">a #GFilterOutputStream. @@ -61006,7 +62191,7 @@ closed. c:identifier="g_filter_output_stream_set_close_base_stream"> Sets whether the base stream will be closed when @stream is closed. + line="25997">Sets whether the base stream will be closed when @stream is closed. @@ -61015,13 +62200,13 @@ closed. a #GFilterOutputStream. + line="25999">a #GFilterOutputStream. %TRUE to close the base stream. + line="26000">%TRUE to close the base stream. @@ -61029,13 +62214,15 @@ closed. + transfer-ownership="none" + getter="get_base_stream"> + transfer-ownership="none" + getter="get_close_base_stream"> @@ -61247,7 +62434,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="failed" + glib:name="G_IO_ERROR_FAILED"> Generic error condition for when an operation fails @@ -61256,7 +62444,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-found" + glib:name="G_IO_ERROR_NOT_FOUND"> File not found. @@ -61264,7 +62453,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="exists" + glib:name="G_IO_ERROR_EXISTS"> File already exists. @@ -61272,7 +62462,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="is-directory" + glib:name="G_IO_ERROR_IS_DIRECTORY"> File is a directory. @@ -61280,7 +62471,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-directory" + glib:name="G_IO_ERROR_NOT_DIRECTORY"> File is not a directory. @@ -61288,7 +62480,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-empty" + glib:name="G_IO_ERROR_NOT_EMPTY"> File is a directory that isn't empty. @@ -61296,7 +62489,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-regular-file" + glib:name="G_IO_ERROR_NOT_REGULAR_FILE"> File is not a regular file. @@ -61304,7 +62498,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-symbolic-link" + glib:name="G_IO_ERROR_NOT_SYMBOLIC_LINK"> File is not a symbolic link. @@ -61312,7 +62507,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-mountable-file" + glib:name="G_IO_ERROR_NOT_MOUNTABLE_FILE"> File cannot be mounted. @@ -61320,7 +62516,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="filename-too-long" + glib:name="G_IO_ERROR_FILENAME_TOO_LONG"> Filename is too many characters. @@ -61328,7 +62525,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="invalid-filename" + glib:name="G_IO_ERROR_INVALID_FILENAME"> Filename is invalid or contains invalid characters. @@ -61336,7 +62534,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="too-many-links" + glib:name="G_IO_ERROR_TOO_MANY_LINKS"> File contains too many symbolic links. @@ -61344,7 +62543,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="no-space" + glib:name="G_IO_ERROR_NO_SPACE"> No space left on drive. @@ -61352,7 +62552,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="invalid-argument" + glib:name="G_IO_ERROR_INVALID_ARGUMENT"> Invalid argument. @@ -61360,7 +62561,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="permission-denied" + glib:name="G_IO_ERROR_PERMISSION_DENIED"> Permission denied. @@ -61368,7 +62570,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-supported" + glib:name="G_IO_ERROR_NOT_SUPPORTED"> Operation (or one of its parameters) not supported @@ -61376,7 +62579,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-mounted" + glib:name="G_IO_ERROR_NOT_MOUNTED"> File isn't mounted. @@ -61384,7 +62588,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="already-mounted" + glib:name="G_IO_ERROR_ALREADY_MOUNTED"> File is already mounted. @@ -61392,7 +62597,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="closed" + glib:name="G_IO_ERROR_CLOSED"> File was closed. @@ -61400,7 +62606,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="cancelled" + glib:name="G_IO_ERROR_CANCELLED"> Operation was cancelled. See #GCancellable. @@ -61408,7 +62615,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="pending" + glib:name="G_IO_ERROR_PENDING"> Operations are still pending. @@ -61416,7 +62624,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="read-only" + glib:name="G_IO_ERROR_READ_ONLY"> File is read only. @@ -61424,7 +62633,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="cant-create-backup" + glib:name="G_IO_ERROR_CANT_CREATE_BACKUP"> Backup couldn't be created. @@ -61432,7 +62642,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="wrong-etag" + glib:name="G_IO_ERROR_WRONG_ETAG"> File's Entity Tag was incorrect. @@ -61440,7 +62651,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="timed-out" + glib:name="G_IO_ERROR_TIMED_OUT"> Operation timed out. @@ -61448,7 +62660,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="would-recurse" + glib:name="G_IO_ERROR_WOULD_RECURSE"> Operation would be recursive. @@ -61456,7 +62669,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="busy" + glib:name="G_IO_ERROR_BUSY"> File is busy. @@ -61464,7 +62678,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="would-block" + glib:name="G_IO_ERROR_WOULD_BLOCK"> Operation would block. @@ -61472,7 +62687,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="host-not-found" + glib:name="G_IO_ERROR_HOST_NOT_FOUND"> Host couldn't be found (remote operations). @@ -61480,7 +62696,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="would-merge" + glib:name="G_IO_ERROR_WOULD_MERGE"> Operation would merge files. @@ -61488,7 +62705,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="failed-handled" + glib:name="G_IO_ERROR_FAILED_HANDLED"> Operation failed and a helper program has @@ -61497,7 +62715,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="too-many-open-files" + glib:name="G_IO_ERROR_TOO_MANY_OPEN_FILES"> The current process has too many files @@ -61507,7 +62726,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-initialized" + glib:name="G_IO_ERROR_NOT_INITIALIZED"> The object has not been initialized. Since 2.22 @@ -61515,7 +62735,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="address-in-use" + glib:name="G_IO_ERROR_ADDRESS_IN_USE"> The requested address is already in use. Since 2.22 @@ -61523,7 +62744,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="partial-input" + glib:name="G_IO_ERROR_PARTIAL_INPUT"> Need more input to finish operation. Since 2.24 @@ -61531,7 +62753,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="invalid-data" + glib:name="G_IO_ERROR_INVALID_DATA"> The input data was invalid. Since 2.24 @@ -61539,7 +62762,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="dbus-error" + glib:name="G_IO_ERROR_DBUS_ERROR"> A remote object generated an error that @@ -61551,7 +62775,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="host-unreachable" + glib:name="G_IO_ERROR_HOST_UNREACHABLE"> Host unreachable. Since 2.26 @@ -61559,7 +62784,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="network-unreachable" + glib:name="G_IO_ERROR_NETWORK_UNREACHABLE"> Network unreachable. Since 2.26 @@ -61567,7 +62793,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="connection-refused" + glib:name="G_IO_ERROR_CONNECTION_REFUSED"> Connection refused. Since 2.26 @@ -61575,7 +62802,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="proxy-failed" + glib:name="G_IO_ERROR_PROXY_FAILED"> Connection to proxy server failed. Since 2.26 @@ -61583,7 +62811,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="proxy-auth-failed" + glib:name="G_IO_ERROR_PROXY_AUTH_FAILED"> Proxy authentication failed. Since 2.26 @@ -61591,7 +62820,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="proxy-need-auth" + glib:name="G_IO_ERROR_PROXY_NEED_AUTH"> Proxy server needs authentication. Since 2.26 @@ -61599,7 +62829,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="proxy-not-allowed" + glib:name="G_IO_ERROR_PROXY_NOT_ALLOWED"> Proxy connection is not allowed by ruleset. @@ -61608,7 +62839,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="broken-pipe" + glib:name="G_IO_ERROR_BROKEN_PIPE"> Broken pipe. Since 2.36 @@ -61616,7 +62848,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="connection-closed" + glib:name="G_IO_ERROR_CONNECTION_CLOSED"> Connection closed by peer. Note that this @@ -61628,7 +62861,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="not-connected" + glib:name="G_IO_ERROR_NOT_CONNECTED"> Transport endpoint is not connected. Since 2.44 @@ -61636,7 +62870,8 @@ See also #GPollableReturn for a cheaper way of returning + glib:nick="message-too-large" + glib:name="G_IO_ERROR_MESSAGE_TOO_LARGE"> Message too large. Since 2.48. @@ -61645,13 +62880,13 @@ See also #GPollableReturn for a cheaper way of returning #GIOExtension is an opaque data structure and can only be accessed + line="1855">#GIOExtension is an opaque data structure and can only be accessed using the following functions. Gets the name under which @extension was registered. + line="27098">Gets the name under which @extension was registered. Note that the same type may be registered as extension for multiple extension points, under different names. @@ -61659,14 +62894,14 @@ for multiple extension points, under different names. the name of @extension. + line="27107">the name of @extension. a #GIOExtension + line="27100">a #GIOExtension @@ -61674,19 +62909,19 @@ for multiple extension points, under different names. Gets the priority with which @extension was registered. + line="27111">Gets the priority with which @extension was registered. the priority of @extension + line="27117">the priority of @extension a #GIOExtension + line="27113">a #GIOExtension @@ -61694,19 +62929,19 @@ for multiple extension points, under different names. Gets the type associated with @extension. + line="27121">Gets the type associated with @extension. the type of @extension + line="27127">the type of @extension a #GIOExtension + line="27123">a #GIOExtension @@ -61716,20 +62951,20 @@ for multiple extension points, under different names. introspectable="0"> Gets a reference to the class for the type that is + line="27216">Gets a reference to the class for the type that is associated with @extension. the #GTypeClass for the type of @extension + line="27223">the #GTypeClass for the type of @extension a #GIOExtension + line="27218">a #GIOExtension @@ -61738,19 +62973,19 @@ associated with @extension. #GIOExtensionPoint is an opaque data structure and can only be accessed + line="1863">#GIOExtensionPoint is an opaque data structure and can only be accessed using the following functions. Finds a #GIOExtension for an extension point by name. + line="27131">Finds a #GIOExtension for an extension point by name. the #GIOExtension for @extension_point that has the + line="27138">the #GIOExtension for @extension_point that has the given name, or %NULL if there is no extension with that name @@ -61758,13 +62993,13 @@ using the following functions. a #GIOExtensionPoint + line="27133">a #GIOExtensionPoint the name of the extension to get + line="27134">the name of the extension to get @@ -61773,13 +63008,13 @@ using the following functions. c:identifier="g_io_extension_point_get_extensions"> Gets a list of all extensions that implement this extension point. + line="27143">Gets a list of all extensions that implement this extension point. The list is sorted by priority, beginning with the highest priority. a #GList of + line="27150">a #GList of #GIOExtensions. The list is owned by GIO and should not be modified. @@ -61790,7 +63025,7 @@ The list is sorted by priority, beginning with the highest priority. a #GIOExtensionPoint + line="27145">a #GIOExtensionPoint @@ -61799,12 +63034,12 @@ The list is sorted by priority, beginning with the highest priority. c:identifier="g_io_extension_point_get_required_type"> Gets the required type for @extension_point. + line="27156">Gets the required type for @extension_point. the #GType that all implementations must have, + line="27162">the #GType that all implementations must have, or #G_TYPE_INVALID if the extension point has no required type @@ -61812,7 +63047,7 @@ The list is sorted by priority, beginning with the highest priority. a #GIOExtensionPoint + line="27158">a #GIOExtensionPoint @@ -61821,7 +63056,7 @@ The list is sorted by priority, beginning with the highest priority. c:identifier="g_io_extension_point_set_required_type"> Sets the required type for @extension_point to @type. + line="27206">Sets the required type for @extension_point to @type. All implementations must henceforth have this type. @@ -61831,13 +63066,13 @@ All implementations must henceforth have this type. a #GIOExtensionPoint + line="27208">a #GIOExtensionPoint the #GType to require + line="27209">the #GType to require @@ -61845,7 +63080,7 @@ All implementations must henceforth have this type. Registers @type as extension for the extension point with name + line="27167">Registers @type as extension for the extension point with name @extension_point_name. If @type has already been registered as an extension for this @@ -61854,32 +63089,32 @@ extension point, the existing #GIOExtension object is returned. a #GIOExtension object for #GType + line="27180">a #GIOExtension object for #GType the name of the extension point + line="27169">the name of the extension point the #GType to register as extension + line="27170">the #GType to register as extension the name for the extension + line="27171">the name for the extension the priority for the extension + line="27172">the priority for the extension @@ -61887,12 +63122,12 @@ extension point, the existing #GIOExtension object is returned. Looks up an existing extension point. + line="27184">Looks up an existing extension point. the #GIOExtensionPoint, or %NULL if there + line="27190">the #GIOExtensionPoint, or %NULL if there is no registered extension point with the given name. @@ -61900,7 +63135,7 @@ extension point, the existing #GIOExtension object is returned. the name of the extension point + line="27186">the name of the extension point @@ -61908,12 +63143,12 @@ extension point, the existing #GIOExtension object is returned. Registers an extension point. + line="27195">Registers an extension point. the new #GIOExtensionPoint. This object is + line="27201">the new #GIOExtensionPoint. This object is owned by GIO and should not be freed. @@ -61921,7 +63156,7 @@ extension point, the existing #GIOExtension object is returned. The name of the extension point + line="27197">The name of the extension point @@ -61936,7 +63171,7 @@ extension point, the existing #GIOExtension object is returned. glib:type-struct="IOModuleClass"> Provides an interface and default functions for loading and unloading + line="6932">Provides an interface and default functions for loading and unloading modules. This is used internally to make GIO extensible, but can also be used by others to implement module loading. @@ -61944,13 +63179,13 @@ be used by others to implement module loading. Creates a new GIOModule that will load the specific + line="27227">Creates a new GIOModule that will load the specific shared library when in use. a #GIOModule from given @filename, + line="27234">a #GIOModule from given @filename, or %NULL on error. @@ -61958,7 +63193,7 @@ or %NULL on error. filename of the shared library module. + line="27229">filename of the shared library module. @@ -62079,7 +63314,7 @@ for static builds. version="2.30"> Represents a scope for loading IO modules. A scope can be used for blocking + line="1871">Represents a scope for loading IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load. The scope can be used with g_io_modules_load_all_in_directory_with_scope() @@ -62090,7 +63325,7 @@ or g_io_modules_scan_all_in_directory_with_scope(). version="2.30"> Block modules with the given @basename from being loaded when + line="27239">Block modules with the given @basename from being loaded when this scope is used with g_io_modules_scan_all_in_directory_with_scope() or g_io_modules_load_all_in_directory_with_scope(). @@ -62101,13 +63336,13 @@ or g_io_modules_load_all_in_directory_with_scope(). a module loading scope + line="27241">a module loading scope the basename to block + line="27242">the basename to block @@ -62115,7 +63350,7 @@ or g_io_modules_load_all_in_directory_with_scope(). Free a module scope. + line="27252">Free a module scope. @@ -62124,7 +63359,7 @@ or g_io_modules_load_all_in_directory_with_scope(). a module loading scope + line="27254">a module loading scope @@ -62135,7 +63370,7 @@ or g_io_modules_load_all_in_directory_with_scope(). introspectable="0"> Create a new scope for loading of IO modules. A scope can be used for + line="27262">Create a new scope for loading of IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load. Specify the %G_IO_MODULE_SCOPE_BLOCK_DUPLICATES flag to block modules @@ -62145,14 +63380,14 @@ in this scope. the new module scope + line="27273">the new module scope flags for the new scope + line="27264">flags for the new scope @@ -62165,22 +63400,24 @@ in this scope. c:type="GIOModuleScopeFlags"> Flags for use with g_io_module_scope_new(). + line="1862">Flags for use with g_io_module_scope_new(). + glib:nick="none" + glib:name="G_IO_MODULE_SCOPE_NONE"> No module scan flags + line="1864">No module scan flags + glib:nick="block-duplicates" + glib:name="G_IO_MODULE_SCOPE_BLOCK_DUPLICATES"> When using this scope to load or + line="1865">When using this scope to load or scan modules, automatically block a modules which has the same base basename as previously loaded module. @@ -62195,7 +63432,7 @@ in this scope. deprecated="1"> Used from an I/O job to send a callback to be run in the thread + line="27377">Used from an I/O job to send a callback to be run in the thread that the job was started from, waiting for the result (and thus blocking the I/O job). Use g_main_context_invoke(). @@ -62203,14 +63440,14 @@ blocking the I/O job). The return value of @func + line="27388">The return value of @func a #GIOSchedulerJob + line="27379">a #GIOSchedulerJob destroy="2"> a #GSourceFunc callback that will be called in the original thread + line="27380">a #GSourceFunc callback that will be called in the original thread allow-none="1"> data to pass to @func + line="27381">data to pass to @func scope="async"> a #GDestroyNotify for @user_data, or %NULL + line="27382">a #GDestroyNotify for @user_data, or %NULL @@ -62249,7 +63486,7 @@ blocking the I/O job). deprecated="1"> Used from an I/O job to send a callback to be run asynchronously in + line="27393">Used from an I/O job to send a callback to be run asynchronously in the thread that the job was started from. The callback will be run when the main loop is available, but at that time the I/O job might have finished. The return value from the callback is ignored. @@ -62267,7 +63504,7 @@ g_io_scheduler_push_job() or by using refcounting for @user_data. a #GIOSchedulerJob + line="27395">a #GIOSchedulerJob destroy="2"> a #GSourceFunc callback that will be called in the original thread + line="27396">a #GSourceFunc callback that will be called in the original thread allow-none="1"> data to pass to @func + line="27397">data to pass to @func scope="async"> a #GDestroyNotify for @user_data, or %NULL + line="27398">a #GDestroyNotify for @user_data, or %NULL @@ -62305,15 +63542,15 @@ g_io_scheduler_push_job() or by using refcounting for @user_data. I/O Job function. + line="358">I/O Job function. Long-running jobs should periodically check the @cancellable to see if they have been cancelled. - + %TRUE if this function should be called again to + line="369">%TRUE if this function should be called again to complete the job, %FALSE if the job is complete (or cancelled) @@ -62321,7 +63558,7 @@ to see if they have been cancelled. a #GIOSchedulerJob. + line="360">a #GIOSchedulerJob. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="361">optional #GCancellable object, %NULL to ignore. closure="2"> the data to pass to callback function + line="362">the data to pass to callback function @@ -62356,7 +63593,7 @@ to see if they have been cancelled. glib:type-struct="IOStreamClass"> GIOStream represents an object that has both read and write streams. + line="6956">GIOStream represents an object that has both read and write streams. Generally the two streams act as separate input and output streams, but they share some common resources and state. For instance, for seekable streams, both streams may use the same position. @@ -62409,19 +63646,19 @@ stream in (though they are guaranteed not to crash). throws="1"> Finishes an asynchronous io stream splice operation. + line="27613">Finishes an asynchronous io stream splice operation. %TRUE on success, %FALSE otherwise. + line="27621">%TRUE on success, %FALSE otherwise. a #GAsyncResult. + line="27615">a #GAsyncResult. @@ -62429,7 +63666,7 @@ stream in (though they are guaranteed not to crash). Requests an asynchronous close of the stream, releasing resources + line="27491">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation. @@ -62447,13 +63684,13 @@ classes. However, if you override one you must override all. a #GIOStream + line="27493">a #GIOStream the io priority of the request + line="27494">the io priority of the request allow-none="1"> optional cancellable object + line="27495">optional cancellable object closure="3"> callback to call when the request is satisfied + line="27496">callback to call when the request is satisfied closure="3"> the data to pass to callback function + line="27497">the data to pass to callback function @@ -62494,25 +63731,25 @@ classes. However, if you override one you must override all. throws="1"> Closes a stream. + line="27514">Closes a stream. %TRUE if stream was successfully closed, %FALSE otherwise. + line="27523">%TRUE if stream was successfully closed, %FALSE otherwise. a #GIOStream + line="27516">a #GIOStream a #GAsyncResult + line="27517">a #GAsyncResult @@ -62539,13 +63776,13 @@ classes. However, if you override one you must override all. version="2.22"> Gets the input stream for this object. This is used + line="27528">Gets the input stream for this object. This is used for reading. a #GInputStream, owned by the #GIOStream. + line="27535">a #GInputStream, owned by the #GIOStream. Do not free. @@ -62553,7 +63790,7 @@ Do not free. a #GIOStream + line="27530">a #GIOStream @@ -62563,13 +63800,13 @@ Do not free. version="2.22"> Gets the output stream for this object. This is used for + line="27541">Gets the output stream for this object. This is used for writing. a #GOutputStream, owned by the #GIOStream. + line="27548">a #GOutputStream, owned by the #GIOStream. Do not free. @@ -62577,7 +63814,7 @@ Do not free. a #GIOStream + line="27543">a #GIOStream @@ -62587,7 +63824,7 @@ Do not free. version="2.22"> Clears the pending flag on @stream. + line="27436">Clears the pending flag on @stream. @@ -62596,7 +63833,7 @@ Do not free. a #GIOStream + line="27438">a #GIOStream @@ -62607,7 +63844,7 @@ Do not free. throws="1"> Closes the stream, releasing resources related to it. This will also + line="27446">Closes the stream, releasing resources related to it. This will also close the individual input and output streams, if they are not already closed. @@ -62644,14 +63881,14 @@ individual input/output streams. %TRUE on success, %FALSE on failure + line="27486">%TRUE on success, %FALSE on failure a #GIOStream + line="27448">a #GIOStream allow-none="1"> optional #GCancellable object, %NULL to ignore + line="27449">optional #GCancellable object, %NULL to ignore @@ -62670,7 +63907,7 @@ individual input/output streams. version="2.22"> Requests an asynchronous close of the stream, releasing resources + line="27491">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation. @@ -62688,13 +63925,13 @@ classes. However, if you override one you must override all. a #GIOStream + line="27493">a #GIOStream the io priority of the request + line="27494">the io priority of the request allow-none="1"> optional cancellable object + line="27495">optional cancellable object closure="3"> callback to call when the request is satisfied + line="27496">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="27497">the data to pass to callback function @@ -62734,41 +63971,42 @@ classes. However, if you override one you must override all. throws="1"> Closes a stream. + line="27514">Closes a stream. %TRUE if stream was successfully closed, %FALSE otherwise. + line="27523">%TRUE if stream was successfully closed, %FALSE otherwise. a #GIOStream + line="27516">a #GIOStream a #GAsyncResult + line="27517">a #GAsyncResult Gets the input stream for this object. This is used + line="27528">Gets the input stream for this object. This is used for reading. a #GInputStream, owned by the #GIOStream. + line="27535">a #GInputStream, owned by the #GIOStream. Do not free. @@ -62776,23 +64014,24 @@ Do not free. a #GIOStream + line="27530">a #GIOStream Gets the output stream for this object. This is used for + line="27541">Gets the output stream for this object. This is used for writing. a #GOutputStream, owned by the #GIOStream. + line="27548">a #GOutputStream, owned by the #GIOStream. Do not free. @@ -62800,7 +64039,7 @@ Do not free. a #GIOStream + line="27543">a #GIOStream @@ -62810,19 +64049,19 @@ Do not free. version="2.22"> Checks if a stream has pending actions. + line="27554">Checks if a stream has pending actions. %TRUE if @stream has pending actions. + line="27560">%TRUE if @stream has pending actions. a #GIOStream + line="27556">a #GIOStream @@ -62832,19 +64071,19 @@ Do not free. version="2.22"> Checks if a stream is closed. + line="27565">Checks if a stream is closed. %TRUE if the stream is closed. + line="27571">%TRUE if the stream is closed. a #GIOStream + line="27567">a #GIOStream @@ -62855,21 +64094,21 @@ Do not free. throws="1"> Sets @stream to have actions pending. If the pending flag is + line="27576">Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. %TRUE if pending was previously unset and is now set. + line="27586">%TRUE if pending was previously unset and is now set. a #GIOStream + line="27578">a #GIOStream @@ -62879,7 +64118,7 @@ already set or @stream is closed, it will return %FALSE and set version="2.28"> Asynchronously splice the output stream of @stream1 to the input stream of + line="27591">Asynchronously splice the output stream of @stream1 to the input stream of @stream2, and splice the output stream of @stream2 to the input stream of @stream1. @@ -62894,25 +64133,25 @@ result of the operation. a #GIOStream. + line="27593">a #GIOStream. a #GIOStream. + line="27594">a #GIOStream. a set of #GIOStreamSpliceFlags. + line="27595">a set of #GIOStreamSpliceFlags. the io priority of the request. + line="27596">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27597">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback. + line="27598">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="27599">user data passed to @callback. @@ -62949,10 +64188,14 @@ result of the operation. - + - + @@ -62978,7 +64221,7 @@ result of the operation. a #GInputStream, owned by the #GIOStream. + line="27535">a #GInputStream, owned by the #GIOStream. Do not free. @@ -62986,7 +64229,7 @@ Do not free. a #GIOStream + line="27530">a #GIOStream @@ -62998,7 +64241,7 @@ Do not free. a #GOutputStream, owned by the #GIOStream. + line="27548">a #GOutputStream, owned by the #GIOStream. Do not free. @@ -63006,7 +64249,7 @@ Do not free. a #GIOStream + line="27543">a #GIOStream @@ -63041,13 +64284,13 @@ Do not free. a #GIOStream + line="27493">a #GIOStream the io priority of the request + line="27494">the io priority of the request allow-none="1"> optional cancellable object + line="27495">optional cancellable object closure="4"> callback to call when the request is satisfied + line="27496">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="27497">the data to pass to callback function @@ -63089,20 +64332,20 @@ Do not free. %TRUE if stream was successfully closed, %FALSE otherwise. + line="27523">%TRUE if stream was successfully closed, %FALSE otherwise. a #GIOStream + line="27516">a #GIOStream a #GAsyncResult + line="27517">a #GAsyncResult @@ -63203,7 +64446,8 @@ Do not free. + glib:nick="none" + glib:name="G_IO_STREAM_SPLICE_NONE"> Do not close either stream. @@ -63211,7 +64455,8 @@ Do not free. + glib:nick="close-stream1" + glib:name="G_IO_STREAM_SPLICE_CLOSE_STREAM1"> Close the first stream after @@ -63220,7 +64465,8 @@ Do not free. + glib:nick="close-stream2" + glib:name="G_IO_STREAM_SPLICE_CLOSE_STREAM2"> Close the second stream after @@ -63229,7 +64475,8 @@ Do not free. + glib:nick="wait-for-both" + glib:name="G_IO_STREAM_SPLICE_WAIT_FOR_BOTH"> Wait for both splice operations to finish @@ -64517,6 +65764,15 @@ Do not free. + + + + + + + @@ -65358,7 +66614,7 @@ Do not free. glib:type-struct="IconIface"> #GIcon is a very minimal interface for icons. It provides functions + line="6795">#GIcon is a very minimal interface for icons. It provides functions for checking the equality of two icons, hashing of icons and serializing an icon to and from strings. @@ -65392,19 +66648,19 @@ types. version="2.38"> Deserializes a #GIcon previously serialized using g_icon_serialize(). + line="26006">Deserializes a #GIcon previously serialized using g_icon_serialize(). - + a #GIcon, or %NULL when deserialization fails. + line="26012">a #GIcon, or %NULL when deserialization fails. a #GVariant created with g_icon_serialize() + line="26008">a #GVariant created with g_icon_serialize() @@ -65412,12 +66668,12 @@ types. Gets a hash for an icon. + line="26028">Gets a hash for an icon. a #guint containing a hash for the @icon, suitable for + line="26034">a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. @@ -65425,7 +66681,7 @@ use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + line="26030">#gconstpointer to an icon object. @@ -65436,7 +66692,7 @@ use in a #GHashTable or similar data structure. throws="1"> Generate a #GIcon instance from @str. This function can fail if + line="26039">Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion. If your application or library provides one or more #GIcon @@ -65446,7 +66702,7 @@ with the type system prior to calling g_icon_new_for_string(). An object implementing the #GIcon + line="26051">An object implementing the #GIcon interface or %NULL if @error is set. @@ -65454,7 +66710,7 @@ with the type system prior to calling g_icon_new_for_string(). A string obtained via g_icon_to_string(). + line="26041">A string obtained via g_icon_to_string(). @@ -65462,12 +66718,12 @@ with the type system prior to calling g_icon_new_for_string(). Checks if two icons are equal. + line="26017">Checks if two icons are equal. %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + line="26024">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise. @@ -65477,7 +66733,7 @@ with the type system prior to calling g_icon_new_for_string(). allow-none="1"> pointer to the first #GIcon. + line="26019">pointer to the first #GIcon. allow-none="1"> pointer to the second #GIcon. + line="26020">pointer to the second #GIcon. @@ -65494,12 +66750,12 @@ with the type system prior to calling g_icon_new_for_string(). Gets a hash for an icon. + line="26028">Gets a hash for an icon. a #guint containing a hash for the @icon, suitable for + line="26034">a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. @@ -65507,7 +66763,7 @@ use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + line="26030">#gconstpointer to an icon object. @@ -65515,23 +66771,23 @@ use in a #GHashTable or similar data structure. Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved + line="26057">Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace. - + a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. + line="26067">a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. a #GIcon + line="26059">a #GIcon @@ -65542,7 +66798,7 @@ makes sense to transfer the #GVariant between processes on the same machine, introspectable="0"> Generates a textual representation of @icon that can be used for + line="26072">Generates a textual representation of @icon that can be used for serialization such as when passing @icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get @icon back from the returned string. @@ -65562,7 +66818,7 @@ in the following two cases An allocated NUL-terminated UTF8 string or + line="26093">An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. @@ -65570,7 +66826,7 @@ in the following two cases a #GIcon. + line="26074">a #GIcon. @@ -65586,12 +66842,12 @@ in the following two cases Checks if two icons are equal. + line="26017">Checks if two icons are equal. %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + line="26024">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise. @@ -65601,7 +66857,7 @@ in the following two cases allow-none="1"> pointer to the first #GIcon. + line="26019">pointer to the first #GIcon. pointer to the second #GIcon. + line="26020">pointer to the second #GIcon. @@ -65618,23 +66874,23 @@ in the following two cases Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved + line="26057">Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace. - + a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. + line="26067">a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. a #GIcon + line="26059">a #GIcon @@ -65642,7 +66898,7 @@ makes sense to transfer the #GVariant between processes on the same machine, Generates a textual representation of @icon that can be used for + line="26072">Generates a textual representation of @icon that can be used for serialization such as when passing @icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get @icon back from the returned string. @@ -65662,7 +66918,7 @@ in the following two cases An allocated NUL-terminated UTF8 string or + line="26093">An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. @@ -65670,7 +66926,7 @@ in the following two cases a #GIcon. + line="26074">a #GIcon. @@ -65697,7 +66953,7 @@ examples of how to implement this interface. a #guint containing a hash for the @icon, suitable for + line="26034">a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. @@ -65705,7 +66961,7 @@ use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + line="26030">#gconstpointer to an icon object. @@ -65717,7 +66973,7 @@ use in a #GHashTable or similar data structure. %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + line="26024">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise. @@ -65727,7 +66983,7 @@ use in a #GHashTable or similar data structure. allow-none="1"> pointer to the first #GIcon. + line="26019">pointer to the first #GIcon. allow-none="1"> pointer to the second #GIcon. + line="26020">pointer to the second #GIcon. @@ -65748,7 +67004,7 @@ use in a #GHashTable or similar data structure. An allocated NUL-terminated UTF8 string or + line="26093">An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. @@ -65756,7 +67012,7 @@ use in a #GHashTable or similar data structure. a #GIcon. + line="26074">a #GIcon. @@ -65792,17 +67048,17 @@ use in a #GHashTable or similar data structure. - + a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. + line="26067">a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. a #GIcon + line="26059">a #GIcon @@ -65818,7 +67074,7 @@ use in a #GHashTable or similar data structure. glib:type-struct="InetAddressClass"> #GInetAddress represents an IPv4 or IPv6 internet address. Use + line="6831">#GInetAddress represents an IPv4 or IPv6 internet address. Use g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to look up the #GInetAddress for a hostname. Use g_resolver_lookup_by_address() or @@ -65834,13 +67090,13 @@ port number). version="2.22"> Creates a #GInetAddress for the "any" address (unassigned/"don't + line="26348">Creates a #GInetAddress for the "any" address (unassigned/"don't care") for @family. a new #GInetAddress corresponding to the "any" address + line="26355">a new #GInetAddress corresponding to the "any" address for @family. Free the returned object with g_object_unref(). @@ -65849,7 +67105,7 @@ for @family. the address family + line="26350">the address family @@ -65859,14 +67115,14 @@ for @family. version="2.22"> Creates a new #GInetAddress from the given @family and @bytes. + line="26362">Creates a new #GInetAddress from the given @family and @bytes. @bytes should be 4 bytes for %G_SOCKET_FAMILY_IPV4 and 16 bytes for %G_SOCKET_FAMILY_IPV6. a new #GInetAddress corresponding to @family and @bytes. + line="26371">a new #GInetAddress corresponding to @family and @bytes. Free the returned object with g_object_unref(). @@ -65874,7 +67130,7 @@ for @family. raw address data + line="26364">raw address data @@ -65882,7 +67138,7 @@ for @family. the address family of @bytes + line="26365">the address family of @bytes @@ -65892,12 +67148,12 @@ for @family. version="2.22"> Parses @string as an IP address and creates a new #GInetAddress. + line="26377">Parses @string as an IP address and creates a new #GInetAddress. a new #GInetAddress corresponding + line="26383">a new #GInetAddress corresponding to @string, or %NULL if @string could not be parsed. Free the returned object with g_object_unref(). @@ -65906,7 +67162,7 @@ to @string, or %NULL if @string could not be parsed. a string representation of an IP address + line="26379">a string representation of an IP address @@ -65916,12 +67172,12 @@ to @string, or %NULL if @string could not be parsed. version="2.22"> Creates a #GInetAddress for the loopback address for @family. + line="26390">Creates a #GInetAddress for the loopback address for @family. a new #GInetAddress corresponding to the loopback address + line="26396">a new #GInetAddress corresponding to the loopback address for @family. Free the returned object with g_object_unref(). @@ -65930,7 +67186,7 @@ for @family. the address family + line="26392">the address family @@ -65941,12 +67197,12 @@ for @family. introspectable="0"> Gets the raw binary address data from @address. + line="26403">Gets the raw binary address data from @address. a pointer to an internal array of the bytes in @address, + line="26409">a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). @@ -65955,7 +67211,7 @@ array can be gotten with g_inet_address_get_native_size(). a #GInetAddress + line="26405">a #GInetAddress @@ -65963,12 +67219,12 @@ array can be gotten with g_inet_address_get_native_size(). Converts @address to string form. + line="26416">Converts @address to string form. a representation of @address as a string, which should be + line="26422">a representation of @address as a string, which should be freed after use. @@ -65976,7 +67232,7 @@ freed after use. a #GInetAddress + line="26418">a #GInetAddress @@ -65984,257 +67240,268 @@ freed after use. Checks if two #GInetAddress instances are equal, e.g. the same address. + line="26099">Checks if two #GInetAddress instances are equal, e.g. the same address. %TRUE if @address and @other_address are equal, %FALSE otherwise. + line="26106">%TRUE if @address and @other_address are equal, %FALSE otherwise. A #GInetAddress. + line="26101">A #GInetAddress. Another #GInetAddress. + line="26102">Another #GInetAddress. Gets @address's family + line="26111">Gets @address's family @address's family + line="26117">@address's family a #GInetAddress + line="26113">a #GInetAddress Tests whether @address is the "any" address for its family. + line="26122">Tests whether @address is the "any" address for its family. %TRUE if @address is the "any" address for its family. + line="26128">%TRUE if @address is the "any" address for its family. a #GInetAddress + line="26124">a #GInetAddress Tests whether @address is a link-local address (that is, if it + line="26133">Tests whether @address is a link-local address (that is, if it identifies a host on a local network that is not connected to the Internet). %TRUE if @address is a link-local address. + line="26141">%TRUE if @address is a link-local address. a #GInetAddress + line="26135">a #GInetAddress Tests whether @address is the loopback address for its family. + line="26146">Tests whether @address is the loopback address for its family. %TRUE if @address is the loopback address for its family. + line="26152">%TRUE if @address is the loopback address for its family. a #GInetAddress + line="26148">a #GInetAddress Tests whether @address is a global multicast address. + line="26157">Tests whether @address is a global multicast address. %TRUE if @address is a global multicast address. + line="26163">%TRUE if @address is a global multicast address. a #GInetAddress + line="26159">a #GInetAddress Tests whether @address is a link-local multicast address. + line="26168">Tests whether @address is a link-local multicast address. %TRUE if @address is a link-local multicast address. + line="26174">%TRUE if @address is a link-local multicast address. a #GInetAddress + line="26170">a #GInetAddress Tests whether @address is a node-local multicast address. + line="26179">Tests whether @address is a node-local multicast address. %TRUE if @address is a node-local multicast address. + line="26185">%TRUE if @address is a node-local multicast address. a #GInetAddress + line="26181">a #GInetAddress Tests whether @address is an organization-local multicast address. + line="26190">Tests whether @address is an organization-local multicast address. %TRUE if @address is an organization-local multicast address. + line="26196">%TRUE if @address is an organization-local multicast address. a #GInetAddress + line="26192">a #GInetAddress Tests whether @address is a site-local multicast address. + line="26201">Tests whether @address is a site-local multicast address. %TRUE if @address is a site-local multicast address. + line="26207">%TRUE if @address is a site-local multicast address. a #GInetAddress + line="26203">a #GInetAddress Tests whether @address is a multicast address. + line="26212">Tests whether @address is a multicast address. %TRUE if @address is a multicast address. + line="26218">%TRUE if @address is a multicast address. a #GInetAddress + line="26214">a #GInetAddress Tests whether @address is a site-local address such as 10.0.0.1 + line="26223">Tests whether @address is a site-local address such as 10.0.0.1 (that is, the address identifies a host on a local network that can not be reached directly from the Internet, but which may have outgoing Internet connectivity via a NAT or firewall). @@ -66242,14 +67509,14 @@ outgoing Internet connectivity via a NAT or firewall). %TRUE if @address is a site-local address. + line="26232">%TRUE if @address is a site-local address. a #GInetAddress + line="26225">a #GInetAddress @@ -66259,20 +67526,20 @@ outgoing Internet connectivity via a NAT or firewall). version="2.22"> Gets the size of the native raw binary address for @address. This + line="26237">Gets the size of the native raw binary address for @address. This is the size of the data that you get from g_inet_address_to_bytes(). the number of bytes used for the native version of @address. + line="26244">the number of bytes used for the native version of @address. a #GInetAddress + line="26239">a #GInetAddress @@ -66283,12 +67550,12 @@ is the size of the data that you get from g_inet_address_to_bytes(). introspectable="0"> Gets the raw binary address data from @address. + line="26403">Gets the raw binary address data from @address. a pointer to an internal array of the bytes in @address, + line="26409">a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). @@ -66297,7 +67564,7 @@ array can be gotten with g_inet_address_get_native_size(). a #GInetAddress + line="26405">a #GInetAddress @@ -66307,12 +67574,12 @@ array can be gotten with g_inet_address_get_native_size(). version="2.22"> Converts @address to string form. + line="26416">Converts @address to string form. a representation of @address as a string, which should be + line="26422">a representation of @address as a string, which should be freed after use. @@ -66320,7 +67587,7 @@ freed after use. a #GInetAddress + line="26418">a #GInetAddress @@ -66334,84 +67601,107 @@ freed after use. + transfer-ownership="none" + getter="get_family"> - + Whether this is the "any" address for its family. + line="1891">Whether this is the "any" address for its family. See g_inet_address_get_is_any(). - + Whether this is a link-local address. + line="1901">Whether this is a link-local address. See g_inet_address_get_is_link_local(). - + Whether this is the loopback address for its family. + line="1911">Whether this is the loopback address for its family. See g_inet_address_get_is_loopback(). - + Whether this is a global multicast address. + line="1921">Whether this is a global multicast address. See g_inet_address_get_is_mc_global(). + transfer-ownership="none" + getter="get_is_mc_link_local"> Whether this is a link-local multicast address. + line="1931">Whether this is a link-local multicast address. See g_inet_address_get_is_mc_link_local(). + transfer-ownership="none" + getter="get_is_mc_node_local"> Whether this is a node-local multicast address. + line="1941">Whether this is a node-local multicast address. See g_inet_address_get_is_mc_node_local(). + transfer-ownership="none" + getter="get_is_mc_org_local"> Whether this is an organization-local multicast address. + line="1951">Whether this is an organization-local multicast address. See g_inet_address_get_is_mc_org_local(). + transfer-ownership="none" + getter="get_is_mc_site_local"> Whether this is a site-local multicast address. + line="1961">Whether this is a site-local multicast address. See g_inet_address_get_is_mc_site_local(). - + Whether this is a multicast address. + line="1971">Whether this is a multicast address. See g_inet_address_get_is_multicast(). - + Whether this is a site-local address. + line="1981">Whether this is a site-local address. See g_inet_address_get_is_loopback(). @@ -66435,7 +67725,7 @@ See g_inet_address_get_is_loopback(). a representation of @address as a string, which should be + line="26422">a representation of @address as a string, which should be freed after use. @@ -66443,7 +67733,7 @@ freed after use. a #GInetAddress + line="26418">a #GInetAddress @@ -66455,7 +67745,7 @@ freed after use. a pointer to an internal array of the bytes in @address, + line="26409">a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). @@ -66464,7 +67754,7 @@ array can be gotten with g_inet_address_get_native_size(). a #GInetAddress + line="26405">a #GInetAddress @@ -66481,7 +67771,7 @@ array can be gotten with g_inet_address_get_native_size(). glib:type-struct="InetAddressMaskClass"> #GInetAddressMask represents a range of IPv4 or IPv6 addresses + line="6849">#GInetAddressMask represents a range of IPv4 or IPv6 addresses described by a base address and a length indicating how many bits of the base address are relevant for matching purposes. These are often given in string form. Eg, "10.0.0.0/8", or "fe80::/10". @@ -66493,26 +67783,26 @@ often given in string form. Eg, "10.0.0.0/8", or "fe80::/10". throws="1"> Creates a new #GInetAddressMask representing all addresses whose + line="26307">Creates a new #GInetAddressMask representing all addresses whose first @length bits match @addr. a new #GInetAddressMask, or %NULL on error + line="26316">a new #GInetAddressMask, or %NULL on error a #GInetAddress + line="26309">a #GInetAddress number of bits of @addr to use + line="26310">number of bits of @addr to use @@ -66523,7 +67813,7 @@ first @length bits match @addr. throws="1"> Parses @mask_string as an IP address and (optional) length, and + line="26321">Parses @mask_string as an IP address and (optional) length, and creates a new #GInetAddressMask. The length, if present, is delimited by a "/". If it is not present, then the length is assumed to be the full length of the address. @@ -66531,7 +67821,7 @@ assumed to be the full length of the address. a new #GInetAddressMask corresponding to @string, or %NULL + line="26331">a new #GInetAddressMask corresponding to @string, or %NULL on error. @@ -66539,7 +67829,7 @@ on error. an IP address or address/length string + line="26323">an IP address or address/length string @@ -66549,91 +67839,94 @@ on error. version="2.32"> Tests if @mask and @mask2 are the same mask. + line="26249">Tests if @mask and @mask2 are the same mask. whether @mask and @mask2 are the same mask + line="26256">whether @mask and @mask2 are the same mask a #GInetAddressMask + line="26251">a #GInetAddressMask another #GInetAddressMask + line="26252">another #GInetAddressMask Gets @mask's base address + line="26261">Gets @mask's base address @mask's base address + line="26267">@mask's base address a #GInetAddressMask + line="26263">a #GInetAddressMask Gets the #GSocketFamily of @mask's address + line="26272">Gets the #GSocketFamily of @mask's address the #GSocketFamily of @mask's address + line="26278">the #GSocketFamily of @mask's address a #GInetAddressMask + line="26274">a #GInetAddressMask Gets @mask's length + line="26283">Gets @mask's length @mask's length + line="26289">@mask's length a #GInetAddressMask + line="26285">a #GInetAddressMask @@ -66643,12 +67936,12 @@ on error. version="2.32"> Tests if @address falls within the range described by @mask. + line="26294">Tests if @address falls within the range described by @mask. whether @address falls within the range described by + line="26301">whether @address falls within the range described by @mask. @@ -66656,13 +67949,13 @@ on error. a #GInetAddressMask + line="26296">a #GInetAddressMask a #GInetAddress + line="26297">a #GInetAddress @@ -66672,30 +67965,36 @@ on error. version="2.32"> Converts @mask back to its corresponding string form. + line="26337">Converts @mask back to its corresponding string form. a string corresponding to @mask. + line="26343">a string corresponding to @mask. a #GInetAddressMask + line="26339">a #GInetAddressMask - + - + - + @@ -66732,7 +68031,7 @@ on error. glib:type-struct="InetSocketAddressClass"> An IPv4 or IPv6 socket address; that is, the combination of a + line="6861">An IPv4 or IPv6 socket address; that is, the combination of a #GInetAddress and a port number. @@ -66741,25 +68040,25 @@ on error. version="2.22"> Creates a new #GInetSocketAddress for @address and @port. + line="26475">Creates a new #GInetSocketAddress for @address and @port. a new #GInetSocketAddress + line="26482">a new #GInetSocketAddress a #GInetAddress + line="26477">a #GInetAddress a port number + line="26478">a port number @@ -66769,7 +68068,7 @@ on error. version="2.40"> Creates a new #GInetSocketAddress for @address and @port. + line="26487">Creates a new #GInetSocketAddress for @address and @port. If @address is an IPv6 address, it can also contain a scope ID (separated from the address by a `%`). @@ -66777,7 +68076,7 @@ If @address is an IPv6 address, it can also contain a scope ID a new #GInetSocketAddress, + line="26497">a new #GInetSocketAddress, or %NULL if @address cannot be parsed. @@ -66785,28 +68084,29 @@ or %NULL if @address cannot be parsed. the string form of an IP address + line="26489">the string form of an IP address a port number + line="26490">a port number Gets @address's #GInetAddress. + line="26428">Gets @address's #GInetAddress. the #GInetAddress for @address, which must be + line="26434">the #GInetAddress for @address, which must be g_object_ref()'d if it will be stored @@ -66814,75 +68114,78 @@ g_object_ref()'d if it will be stored a #GInetSocketAddress + line="26430">a #GInetSocketAddress Gets the `sin6_flowinfo` field from @address, + line="26440">Gets the `sin6_flowinfo` field from @address, which must be an IPv6 address. the flowinfo field + line="26447">the flowinfo field a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress + line="26442">a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress Gets @address's port. + line="26452">Gets @address's port. the port for @address + line="26458">the port for @address a #GInetSocketAddress + line="26454">a #GInetSocketAddress Gets the `sin6_scope_id` field from @address, + line="26463">Gets the `sin6_scope_id` field from @address, which must be an IPv6 address. the scope id field + line="26470">the scope id field a %G_SOCKET_FAMILY_IPV6 #GInetAddress + line="26465">a %G_SOCKET_FAMILY_IPV6 #GInetAddress @@ -66890,29 +68193,33 @@ which must be an IPv6 address. + transfer-ownership="none" + getter="get_address"> + transfer-ownership="none" + getter="get_flowinfo"> The `sin6_flowinfo` field, for IPv6 addresses. + line="2009">The `sin6_flowinfo` field, for IPv6 addresses. + transfer-ownership="none" + getter="get_port"> + transfer-ownership="none" + getter="get_scope_id"> @@ -66945,7 +68252,7 @@ which must be an IPv6 address. glib:type-struct="InitableIface"> #GInitable is implemented by objects that can fail during + line="6871">#GInitable is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, either via g_initable_init() or g_async_initable_init_async() @@ -66976,14 +68283,14 @@ an exception on failure. introspectable="0"> Helper function for constructing #GInitable object. This is + line="26555">Helper function for constructing #GInitable object. This is similar to g_object_new() but also initializes the object and returns %NULL, setting an error on failure. a newly allocated + line="26570">a newly allocated #GObject, or %NULL on error @@ -66991,7 +68298,7 @@ and returns %NULL, setting an error on failure. a #GType supporting #GInitable. + line="26557">a #GType supporting #GInitable. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26558">optional #GCancellable object, %NULL to ignore. a #GError location to store the error occurring, or %NULL to + line="26559">a #GError location to store the error occurring, or %NULL to ignore. @@ -67016,14 +68323,14 @@ and returns %NULL, setting an error on failure. allow-none="1"> the name of the first property, or %NULL if no + line="26561">the name of the first property, or %NULL if no properties the value if the first property, followed by and other property + line="26563">the value if the first property, followed by and other property value pairs, and ended by %NULL. @@ -67036,14 +68343,14 @@ and returns %NULL, setting an error on failure. throws="1"> Helper function for constructing #GInitable object. This is + line="26576">Helper function for constructing #GInitable object. This is similar to g_object_new_valist() but also initializes the object and returns %NULL, setting an error on failure. a newly allocated + line="26590">a newly allocated #GObject, or %NULL on error @@ -67051,20 +68358,20 @@ and returns %NULL, setting an error on failure. a #GType supporting #GInitable. + line="26578">a #GType supporting #GInitable. the name of the first property, followed by + line="26579">the name of the first property, followed by the value, and other property value pairs, and ended by %NULL. The var args list generated from @first_property_name. + line="26581">The var args list generated from @first_property_name. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26582">optional #GCancellable object, %NULL to ignore. @@ -67086,7 +68393,7 @@ the value, and other property value pairs, and ended by %NULL. throws="1"> Helper function for constructing #GInitable object. This is + line="26596">Helper function for constructing #GInitable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. Use g_object_new_with_properties() and @@ -67095,7 +68402,7 @@ g_initable_init() instead. See #GParameter for more information. a newly allocated + line="26609">a newly allocated #GObject, or %NULL on error @@ -67103,19 +68410,19 @@ g_initable_init() instead. See #GParameter for more information. a #GType supporting #GInitable. + line="26598">a #GType supporting #GInitable. the number of parameters in @parameters + line="26599">the number of parameters in @parameters the parameters to use to construct the object + line="26600">the parameters to use to construct the object @@ -67126,7 +68433,7 @@ g_initable_init() instead. See #GParameter for more information. optional #GCancellable object, %NULL to ignore. + line="26601">optional #GCancellable object, %NULL to ignore. @@ -67134,7 +68441,7 @@ g_initable_init() instead. See #GParameter for more information. Initializes the object implementing the interface. + line="26503">Initializes the object implementing the interface. This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead. @@ -67176,7 +68483,7 @@ instance. %TRUE if successful. If an error has occurred, this function will + line="26549">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -67184,7 +68491,7 @@ instance. a #GInitable. + line="26505">a #GInitable. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26506">optional #GCancellable object, %NULL to ignore. @@ -67204,7 +68511,7 @@ instance. throws="1"> Initializes the object implementing the interface. + line="26503">Initializes the object implementing the interface. This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead. @@ -67246,7 +68553,7 @@ instance. %TRUE if successful. If an error has occurred, this function will + line="26549">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -67254,7 +68561,7 @@ instance. a #GInitable. + line="26505">a #GInitable. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26506">optional #GCancellable object, %NULL to ignore. @@ -67290,7 +68597,7 @@ may fail. %TRUE if successful. If an error has occurred, this function will + line="26549">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -67298,7 +68605,7 @@ may fail. a #GInitable. + line="26505">a #GInitable. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26506">optional #GCancellable object, %NULL to ignore. @@ -67317,7 +68624,7 @@ may fail. Structure used for scatter/gather data input when receiving multiple + line="443">Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty #GInputVectors and the operation will use all the buffers as if they were one buffer, and will set @bytes_received to the total number of bytes @@ -67336,18 +68643,18 @@ this array, which may be zero. Flags relevant to this message will be returned in @flags. For example, `MSG_EOR` or `MSG_TRUNC`. - + return location + line="445">return location for a #GSocketAddress, or %NULL pointer to an + line="447">pointer to an array of input vectors @@ -67356,27 +68663,27 @@ Flags relevant to this message will be returned in @flags. For example, the number of input vectors pointed to by @vectors + line="449">the number of input vectors pointed to by @vectors will be set to the number of bytes that have been + line="450">will be set to the number of bytes that have been received collection of #GSocketMsgFlags for the received message, + line="452">collection of #GSocketMsgFlags for the received message, outputted by the call return location for a + line="454">return location for a caller-allocated array of #GSocketControlMessages, or %NULL return location for the number of + line="457">return location for the number of elements in @control_messages @@ -67402,7 +68709,7 @@ Flags relevant to this message will be returned in @flags. For example, glib:type-struct="InputStreamClass"> #GInputStream has functions to read from a stream (g_input_stream_read()), + line="6904">#GInputStream has functions to read from a stream (g_input_stream_read()), to close a stream (g_input_stream_close()) and to skip some content (g_input_stream_skip()). @@ -67417,7 +68724,7 @@ All of these functions have async variants too. Requests an asynchronous closes of the stream, releasing resources related to it. + line="26659">Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. @@ -67435,13 +68742,13 @@ override one you must override all. A #GInputStream. + line="26661">A #GInputStream. the [I/O priority][io-priority] of the request + line="26662">the [I/O priority][io-priority] of the request allow-none="1"> optional cancellable object + line="26663">optional cancellable object closure="3"> callback to call when the request is satisfied + line="26664">callback to call when the request is satisfied closure="3"> the data to pass to callback function + line="26665">the data to pass to callback function @@ -67479,25 +68786,25 @@ override one you must override all. Finishes closing a stream asynchronously, started from g_input_stream_close_async(). + line="26680">Finishes closing a stream asynchronously, started from g_input_stream_close_async(). %TRUE if the stream was closed successfully. + line="26689">%TRUE if the stream was closed successfully. a #GInputStream. + line="26682">a #GInputStream. a #GAsyncResult. + line="26683">a #GAsyncResult. @@ -67522,7 +68829,7 @@ override one you must override all. Request an asynchronous read of @count bytes from the stream into the buffer + line="26830">Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. @@ -67553,7 +68860,7 @@ override one you must override all. A #GInputStream. + line="26832">A #GInputStream. nullable="1"> + line="26833"> a buffer to read data into (which should be at least count bytes long). - + the number of bytes that will be read from the stream + line="26835">the number of bytes that will be read from the stream the [I/O priority][io-priority] + line="26836">the [I/O priority][io-priority] of the request. @@ -67591,7 +68895,7 @@ of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26838">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="26839">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="26840">the data to pass to callback function @@ -67620,25 +68924,25 @@ of the request. Finishes an asynchronous stream read operation. + line="26953">Finishes an asynchronous stream read operation. number of bytes read in, or -1 on error, or 0 on end of file. + line="26962">number of bytes read in, or -1 on error, or 0 on end of file. a #GInputStream. + line="26955">a #GInputStream. a #GAsyncResult. + line="26956">a #GAsyncResult. @@ -67672,7 +68976,7 @@ of the request. Tries to skip @count bytes from the stream. Will block during the operation. + line="26980">Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some @@ -67690,20 +68994,20 @@ partial result will be returned, without an error. Number of bytes skipped, or -1 on error + line="27002">Number of bytes skipped, or -1 on error a #GInputStream. + line="26982">a #GInputStream. the number of bytes that will be skipped from the stream + line="26983">the number of bytes that will be skipped from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26984">optional #GCancellable object, %NULL to ignore. @@ -67720,7 +69024,7 @@ partial result will be returned, without an error. Request an asynchronous skip of @count bytes from the stream. + line="27006">Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. @@ -67751,19 +69055,19 @@ However, if you override one, you must override all. A #GInputStream. + line="27008">A #GInputStream. the number of bytes that will be skipped from the stream + line="27009">the number of bytes that will be skipped from the stream the [I/O priority][io-priority] of the request + line="27010">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27011">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="27012">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="27013">the data to pass to callback function @@ -67801,25 +69105,25 @@ However, if you override one, you must override all. Finishes a stream skip operation. + line="27041">Finishes a stream skip operation. the size of the bytes skipped, or `-1` on error. + line="27050">the size of the bytes skipped, or `-1` on error. a #GInputStream. + line="27043">a #GInputStream. a #GAsyncResult. + line="27044">a #GAsyncResult. @@ -67827,7 +69131,7 @@ However, if you override one, you must override all. Clears the pending flag on @stream. + line="26617">Clears the pending flag on @stream. @@ -67836,7 +69140,7 @@ However, if you override one, you must override all. input stream + line="26619">input stream @@ -67844,7 +69148,7 @@ However, if you override one, you must override all. Closes the stream, releasing resources related to it. + line="26625">Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. @@ -67871,14 +69175,14 @@ can use a faster close that doesn't block to e.g. check errors. %TRUE on success, %FALSE on failure + line="26655">%TRUE on success, %FALSE on failure A #GInputStream. + line="26627">A #GInputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26628">optional #GCancellable object, %NULL to ignore. @@ -67895,7 +69199,7 @@ can use a faster close that doesn't block to e.g. check errors. Requests an asynchronous closes of the stream, releasing resources related to it. + line="26659">Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. @@ -67913,13 +69217,13 @@ override one you must override all. A #GInputStream. + line="26661">A #GInputStream. the [I/O priority][io-priority] of the request + line="26662">the [I/O priority][io-priority] of the request allow-none="1"> optional cancellable object + line="26663">optional cancellable object closure="3"> callback to call when the request is satisfied + line="26664">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="26665">the data to pass to callback function @@ -67958,25 +69262,25 @@ override one you must override all. throws="1"> Finishes closing a stream asynchronously, started from g_input_stream_close_async(). + line="26680">Finishes closing a stream asynchronously, started from g_input_stream_close_async(). %TRUE if the stream was closed successfully. + line="26689">%TRUE if the stream was closed successfully. a #GInputStream. + line="26682">a #GInputStream. a #GAsyncResult. + line="26683">a #GAsyncResult. @@ -67984,19 +69288,19 @@ override one you must override all. Checks if an input stream has pending actions. + line="26693">Checks if an input stream has pending actions. %TRUE if @stream has pending actions. + line="26699">%TRUE if @stream has pending actions. input stream. + line="26695">input stream. @@ -68004,19 +69308,19 @@ override one you must override all. Checks if an input stream is closed. + line="26703">Checks if an input stream is closed. %TRUE if the stream is closed. + line="26709">%TRUE if the stream is closed. input stream. + line="26705">input stream. @@ -68024,7 +69328,7 @@ override one you must override all. Tries to read @count bytes from the stream into the buffer starting at + line="26713">Tries to read @count bytes from the stream into the buffer starting at @buffer. Will block during this read. If count is zero returns zero and does nothing. A value of @count @@ -68049,14 +69353,14 @@ On error -1 is returned and @error is set accordingly. Number of bytes read, or -1 on error, or 0 on end of file. + line="26744">Number of bytes read, or -1 on error, or 0 on end of file. a #GInputStream. + line="26715">a #GInputStream. transfer-ownership="none"> + line="26716"> a buffer to read data into (which should be at least count bytes long). - + the number of bytes that will be read from the stream + line="26718">the number of bytes that will be read from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26719">optional #GCancellable object, %NULL to ignore. @@ -68096,7 +69397,7 @@ On error -1 is returned and @error is set accordingly. throws="1"> Tries to read @count bytes from the stream into the buffer starting at + line="26748">Tries to read @count bytes from the stream into the buffer starting at @buffer. Will block during this read. This function is similar to g_input_stream_read(), except it tries to @@ -68119,14 +69420,14 @@ write your own loop around g_input_stream_read(). %TRUE on success, %FALSE if there was an error + line="26778">%TRUE on success, %FALSE if there was an error a #GInputStream. + line="26750">a #GInputStream. transfer-ownership="none"> + line="26751"> a buffer to read data into (which should be at least count bytes long). - + the number of bytes that will be read from the stream + line="26753">the number of bytes that will be read from the stream transfer-ownership="full"> location to store the number of bytes that was read from the stream + line="26754">location to store the number of bytes that was read from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26755">optional #GCancellable object, %NULL to ignore. @@ -68175,7 +69473,7 @@ write your own loop around g_input_stream_read(). version="2.44"> Request an asynchronous read of @count bytes from the stream into the + line="26782">Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. This is the asynchronous equivalent of g_input_stream_read_all(). @@ -68193,7 +69491,7 @@ priority. Default priority is %G_PRIORITY_DEFAULT. A #GInputStream + line="26784">A #GInputStream transfer-ownership="none"> + line="26785"> a buffer to read data into (which should be at least count bytes long) - + the number of bytes that will be read from the stream + line="26787">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + line="26788">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore + line="26789">optional #GCancellable object, %NULL to ignore closure="5"> callback to call when the request is satisfied + line="26790">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="26791">the data to pass to callback function @@ -68260,7 +69555,7 @@ priority. Default priority is %G_PRIORITY_DEFAULT. throws="1"> Finishes an asynchronous stream read operation started with + line="26808">Finishes an asynchronous stream read operation started with g_input_stream_read_all_async(). As a special exception to the normal conventions for functions that @@ -68273,20 +69568,20 @@ write your own loop around g_input_stream_read_async(). %TRUE on success, %FALSE if there was an error + line="26825">%TRUE on success, %FALSE if there was an error a #GInputStream + line="26810">a #GInputStream a #GAsyncResult + line="26811">a #GAsyncResult transfer-ownership="full"> location to store the number of bytes that was read from the stream + line="26812">location to store the number of bytes that was read from the stream @@ -68303,7 +69598,7 @@ write your own loop around g_input_stream_read_async(). Request an asynchronous read of @count bytes from the stream into the buffer + line="26830">Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. @@ -68334,7 +69629,7 @@ override one you must override all. A #GInputStream. + line="26832">A #GInputStream. transfer-ownership="none"> + line="26833"> a buffer to read data into (which should be at least count bytes long). - + the number of bytes that will be read from the stream + line="26835">the number of bytes that will be read from the stream the [I/O priority][io-priority] + line="26836">the [I/O priority][io-priority] of the request. @@ -68371,7 +69663,7 @@ of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26838">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="26839">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="26840">the data to pass to callback function @@ -68402,7 +69694,7 @@ of the request. throws="1"> Like g_input_stream_read(), this tries to read @count bytes from + line="26868">Like g_input_stream_read(), this tries to read @count bytes from the stream in a blocking fashion. However, rather than reading into a user-supplied buffer, this will create a new #GBytes containing the data that was read. This may be easier to use from language @@ -68429,20 +69721,20 @@ On error %NULL is returned and @error is set accordingly. a new #GBytes, or %NULL on error + line="26900">a new #GBytes, or %NULL on error a #GInputStream. + line="26870">a #GInputStream. maximum number of bytes that will be read from the stream. Common + line="26871">maximum number of bytes that will be read from the stream. Common values include 4096 and 8192. @@ -68452,7 +69744,7 @@ values include 4096 and 8192. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26873">optional #GCancellable object, %NULL to ignore. @@ -68462,7 +69754,7 @@ values include 4096 and 8192. version="2.34"> Request an asynchronous read of @count bytes from the stream into a + line="26905">Request an asynchronous read of @count bytes from the stream into a new #GBytes. When the operation is finished @callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation. @@ -68490,19 +69782,19 @@ priority. Default priority is %G_PRIORITY_DEFAULT. A #GInputStream. + line="26907">A #GInputStream. the number of bytes that will be read from the stream + line="26908">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + line="26909">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26910">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="26911">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="26912">the data to pass to callback function @@ -68542,25 +69834,25 @@ priority. Default priority is %G_PRIORITY_DEFAULT. throws="1"> Finishes an asynchronous stream read-into-#GBytes operation. + line="26939">Finishes an asynchronous stream read-into-#GBytes operation. the newly-allocated #GBytes, or %NULL on error + line="26948">the newly-allocated #GBytes, or %NULL on error a #GInputStream. + line="26941">a #GInputStream. a #GAsyncResult. + line="26942">a #GAsyncResult. @@ -68570,25 +69862,25 @@ priority. Default priority is %G_PRIORITY_DEFAULT. throws="1"> Finishes an asynchronous stream read operation. + line="26953">Finishes an asynchronous stream read operation. number of bytes read in, or -1 on error, or 0 on end of file. + line="26962">number of bytes read in, or -1 on error, or 0 on end of file. a #GInputStream. + line="26955">a #GInputStream. a #GAsyncResult. + line="26956">a #GAsyncResult. @@ -68598,21 +69890,21 @@ priority. Default priority is %G_PRIORITY_DEFAULT. throws="1"> Sets @stream to have actions pending. If the pending flag is + line="26966">Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. %TRUE if pending was previously unset and is now set. + line="26976">%TRUE if pending was previously unset and is now set. input stream + line="26968">input stream @@ -68620,7 +69912,7 @@ already set or @stream is closed, it will return %FALSE and set Tries to skip @count bytes from the stream. Will block during the operation. + line="26980">Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some @@ -68638,20 +69930,20 @@ partial result will be returned, without an error. Number of bytes skipped, or -1 on error + line="27002">Number of bytes skipped, or -1 on error a #GInputStream. + line="26982">a #GInputStream. the number of bytes that will be skipped from the stream + line="26983">the number of bytes that will be skipped from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26984">optional #GCancellable object, %NULL to ignore. @@ -68668,7 +69960,7 @@ partial result will be returned, without an error. Request an asynchronous skip of @count bytes from the stream. + line="27006">Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. @@ -68699,19 +69991,19 @@ However, if you override one, you must override all. A #GInputStream. + line="27008">A #GInputStream. the number of bytes that will be skipped from the stream + line="27009">the number of bytes that will be skipped from the stream the [I/O priority][io-priority] of the request + line="27010">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27011">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="27012">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="27013">the data to pass to callback function @@ -68750,25 +70042,25 @@ However, if you override one, you must override all. throws="1"> Finishes a stream skip operation. + line="27041">Finishes a stream skip operation. the size of the bytes skipped, or `-1` on error. + line="27050">the size of the bytes skipped, or `-1` on error. a #GInputStream. + line="27043">a #GInputStream. a #GAsyncResult. + line="27044">a #GAsyncResult. @@ -68821,20 +70113,20 @@ However, if you override one, you must override all. Number of bytes skipped, or -1 on error + line="27002">Number of bytes skipped, or -1 on error a #GInputStream. + line="26982">a #GInputStream. the number of bytes that will be skipped from the stream + line="26983">the number of bytes that will be skipped from the stream allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26984">optional #GCancellable object, %NULL to ignore. @@ -68878,7 +70170,7 @@ However, if you override one, you must override all. A #GInputStream. + line="26832">A #GInputStream. nullable="1"> + line="26833"> a buffer to read data into (which should be at least count bytes long). - + the number of bytes that will be read from the stream + line="26835">the number of bytes that will be read from the stream the [I/O priority][io-priority] + line="26836">the [I/O priority][io-priority] of the request. @@ -68916,7 +70205,7 @@ of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="26838">optional #GCancellable object, %NULL to ignore. closure="6"> callback to call when the request is satisfied + line="26839">callback to call when the request is satisfied closure="6"> the data to pass to callback function + line="26840">the data to pass to callback function @@ -68949,20 +70238,20 @@ of the request. number of bytes read in, or -1 on error, or 0 on end of file. + line="26962">number of bytes read in, or -1 on error, or 0 on end of file. a #GInputStream. + line="26955">a #GInputStream. a #GAsyncResult. + line="26956">a #GAsyncResult. @@ -68978,19 +70267,19 @@ of the request. A #GInputStream. + line="27008">A #GInputStream. the number of bytes that will be skipped from the stream + line="27009">the number of bytes that will be skipped from the stream the [I/O priority][io-priority] of the request + line="27010">the [I/O priority][io-priority] of the request allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27011">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="27012">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="27013">the data to pass to callback function @@ -69032,20 +70321,20 @@ of the request. the size of the bytes skipped, or `-1` on error. + line="27050">the size of the bytes skipped, or `-1` on error. a #GInputStream. + line="27043">a #GInputStream. a #GAsyncResult. + line="27044">a #GAsyncResult. @@ -69061,13 +70350,13 @@ of the request. A #GInputStream. + line="26661">A #GInputStream. the [I/O priority][io-priority] of the request + line="26662">the [I/O priority][io-priority] of the request allow-none="1"> optional cancellable object + line="26663">optional cancellable object closure="4"> callback to call when the request is satisfied + line="26664">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="26665">the data to pass to callback function @@ -69109,20 +70398,20 @@ of the request. %TRUE if the stream was closed successfully. + line="26689">%TRUE if the stream was closed successfully. a #GInputStream. + line="26682">a #GInputStream. a #GAsyncResult. + line="26683">a #GAsyncResult. @@ -69177,21 +70466,21 @@ of the request. Structure used for scatter/gather data input. + line="424">Structure used for scatter/gather data input. You generally pass in an array of #GInputVectors and the operation will store the read data starting in the first buffer, switching to the next as needed. - + Pointer to a buffer where data will be written. + line="426">Pointer to a buffer where data will be written. the available size in @buffer. + line="427">the available size in @buffer. @@ -69221,7 +70510,7 @@ first buffer, switching to the next as needed. glib:type-struct="ListModelInterface"> #GListModel is an interface that represents a mutable list of + line="7013">#GListModel is an interface that represents a mutable list of #GObjects. Its main intention is as a model for various widgets in user interfaces, such as list views, but it can also be used as a convenient method of returning lists of data, with support for @@ -69272,7 +70561,7 @@ in effect at the time that the model was created. Get the item at @position. If @position is greater than the number of + line="2105">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 @@ -69281,20 +70570,20 @@ of the list. See g_list_model_get_n_items(). the object at @position. + line="2116">the object at @position. a #GListModel + line="2107">a #GListModel the position of the item to fetch + line="2108">the position of the item to fetch @@ -69304,7 +70593,7 @@ of the list. See g_list_model_get_n_items(). version="2.44"> Gets the type of the items in @list. All items returned from + line="27703">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. @@ -69314,14 +70603,14 @@ model. the #GType of the items contained in @list. + line="27714">the #GType of the items contained in @list. a #GListModel + line="27705">a #GListModel @@ -69329,7 +70618,7 @@ model. Gets the number of items in @list. + line="27719">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 @@ -69338,14 +70627,14 @@ less efficient than iterating the list with increasing values for the number of items in @list. + line="27729">the number of items in @list. a #GListModel + line="27721">a #GListModel @@ -69357,7 +70646,7 @@ less efficient than iterating the list with increasing values for introspectable="0"> Get the item at @position. If @position is greater than the number of + line="27687">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 @@ -69366,20 +70655,20 @@ of the list. See g_list_model_get_n_items(). the item at @position. + line="27698">the item at @position. a #GListModel + line="27689">a #GListModel the position of the item to fetch + line="27690">the position of the item to fetch @@ -69389,7 +70678,7 @@ of the list. See g_list_model_get_n_items(). version="2.44"> Gets the type of the items in @list. All items returned from + line="27703">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. @@ -69399,14 +70688,14 @@ model. the #GType of the items contained in @list. + line="27714">the #GType of the items contained in @list. a #GListModel + line="27705">a #GListModel @@ -69416,7 +70705,7 @@ model. version="2.44"> Gets the number of items in @list. + line="27719">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 @@ -69425,14 +70714,14 @@ less efficient than iterating the list with increasing values for the number of items in @list. + line="27729">the number of items in @list. a #GListModel + line="27721">a #GListModel @@ -69443,7 +70732,7 @@ less efficient than iterating the list with increasing values for version="2.44"> Get the item at @position. If @position is greater than the number of + line="27734">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 @@ -69452,20 +70741,20 @@ of the list. See g_list_model_get_n_items(). the object at @position. + line="27745">the object at @position. a #GListModel + line="27736">a #GListModel the position of the item to fetch + line="27737">the position of the item to fetch @@ -69475,7 +70764,7 @@ of the list. See g_list_model_get_n_items(). version="2.44"> Emits the #GListModel::items-changed signal on @list. + line="27750">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 @@ -69503,25 +70792,25 @@ same contents of the model. a #GListModel + line="27752">a #GListModel the position at which @list changed + line="27753">the position at which @list changed the number of items removed + line="27754">the number of items removed the number of items added + line="27755">the number of items added @@ -69529,7 +70818,7 @@ same contents of the model. This signal is emitted whenever items were added to or removed + line="2074">This signal is emitted whenever items were added to or removed from @list. At @position, @removed items were removed and @added items were added in their place. @@ -69542,19 +70831,19 @@ in the model change. the position at which @list changed + line="2077">the position at which @list changed the number of items removed + line="2078">the number of items removed the number of items added + line="2079">the number of items added @@ -69566,12 +70855,12 @@ in the model change. version="2.44"> The virtual function table for #GListModel. + line="2092">The virtual function table for #GListModel. parent #GTypeInterface + line="2094">parent #GTypeInterface @@ -69580,14 +70869,14 @@ in the model change. the #GType of the items contained in @list. + line="27714">the #GType of the items contained in @list. a #GListModel + line="27705">a #GListModel @@ -69599,14 +70888,14 @@ in the model change. the number of items in @list. + line="27729">the number of items in @list. a #GListModel + line="27721">a #GListModel @@ -69618,20 +70907,20 @@ in the model change. the object at @position. + line="2116">the object at @position. a #GListModel + line="2107">a #GListModel the position of the item to fetch + line="2108">the position of the item to fetch @@ -69647,7 +70936,7 @@ in the model change. glib:type-struct="ListStoreClass"> #GListStore is a simple implementation of #GListModel that stores all + line="7070">#GListStore is a simple implementation of #GListModel that stores all items in memory. It provides insertions, deletions, and lookups in logarithmic time @@ -69657,20 +70946,20 @@ with a fast path for the common case of iterating the list linearly. Creates a new #GListStore with items of type @item_type. @item_type + line="27875">Creates a new #GListStore with items of type @item_type. @item_type must be a subclass of #GObject. a new #GListStore + line="27882">a new #GListStore the #GType of items in the list + line="27877">the #GType of items in the list @@ -69678,7 +70967,7 @@ must be a subclass of #GObject. Appends @item to @store. @item must be of type #GListStore:item-type. + line="27782">Appends @item to @store. @item must be of type #GListStore:item-type. This function takes a ref on @item. @@ -69692,13 +70981,13 @@ efficiently. a #GListStore + line="27784">a #GListStore the new item + line="27785">the new item @@ -69706,7 +70995,7 @@ efficiently. Looks up the given @item in the list store by looping over the items until + line="27798">Looks up the given @item in the list store by looping over the items until the first occurrence of @item. If @item was not found, then @position will not be set, and this method will return %FALSE. @@ -69716,7 +71005,7 @@ g_list_store_find_with_equal_func() with a custom #GEqualFunc instead. Whether @store contains @item. If it was found, @position will be + line="27811">Whether @store contains @item. If it was found, @position will be set to the position where @item occurred for the first time. @@ -69724,13 +71013,13 @@ set to the position where @item occurred for the first time. a #GListStore + line="27800">a #GListStore an item + line="27801">an item allow-none="1"> the first position of @item, if it was found. + line="27802">the first position of @item, if it was found. @@ -69751,7 +71040,7 @@ set to the position where @item occurred for the first time. version="2.64"> Looks up the given @item in the list store by looping over the items and + line="27817">Looks up the given @item in the list store by looping over the items and comparing them with @compare_func until the first occurrence of @item which matches. If @item was not found, then @position will not be set, and this method will return %FALSE. @@ -69759,7 +71048,7 @@ method will return %FALSE. Whether @store contains @item. If it was found, @position will be + line="27829">Whether @store contains @item. If it was found, @position will be set to the position where @item occurred for the first time. @@ -69767,19 +71056,19 @@ set to the position where @item occurred for the first time. a #GListStore + line="27819">a #GListStore an item + line="27820">an item A custom equality check function + line="27821">A custom equality check function allow-none="1"> the first position of @item, if it was found. + line="27822">the first position of @item, if it was found. @@ -69798,7 +71087,7 @@ set to the position where @item occurred for the first time. Inserts @item into @store at @position. @item must be of type + line="27835">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. @@ -69814,19 +71103,19 @@ efficiently. a #GListStore + line="27837">a #GListStore the position at which to insert the new item + line="27838">the position at which to insert the new item the new item + line="27839">the new item @@ -69836,7 +71125,7 @@ efficiently. version="2.44"> Inserts @item into @store at a position to be determined by the + line="27854">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 @@ -69848,20 +71137,20 @@ This function takes a ref on @item. the position at which @item was inserted + line="27870">the position at which @item was inserted a #GListStore + line="27856">a #GListStore the new item + line="27857">the new item closure="2"> pairwise comparison function for sorting + line="27858">pairwise comparison function for sorting allow-none="1"> user data for @compare_func + line="27859">user data for @compare_func @@ -69887,7 +71176,7 @@ This function takes a ref on @item. Removes the item from @store that is at @position. @position must be + line="27887">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 @@ -69900,13 +71189,13 @@ efficiently. a #GListStore + line="27889">a #GListStore the position of the item that is to be removed + line="27890">the position of the item that is to be removed @@ -69916,7 +71205,7 @@ efficiently. version="2.44"> Removes all items from @store. + line="27902">Removes all items from @store. @@ -69925,7 +71214,7 @@ efficiently. a #GListStore + line="27904">a #GListStore @@ -69933,7 +71222,7 @@ efficiently. Sort the items in @store according to @compare_func. + line="27912">Sort the items in @store according to @compare_func. @@ -69942,7 +71231,7 @@ efficiently. a #GListStore + line="27914">a #GListStore closure="1"> pairwise comparison function for sorting + line="27915">pairwise comparison function for sorting allow-none="1"> user data for @compare_func + line="27916">user data for @compare_func @@ -69968,7 +71257,7 @@ efficiently. Changes @store by removing @n_removals items and adding @n_additions + line="27924">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. @@ -69989,25 +71278,25 @@ the list at the time this function is called). a #GListStore + line="27926">a #GListStore the position at which to make the change + line="27927">the position at which to make the change the number of items to remove + line="27928">the number of items to remove the items to add + line="27929">the items to add @@ -70015,7 +71304,7 @@ the list at the time this function is called). the number of items to add + line="27930">the number of items to add @@ -70027,7 +71316,7 @@ the list at the time this function is called). transfer-ownership="none"> The type of items contained in this list store. Items must be + line="2129">The type of items contained in this list store. Items must be subclasses of #GObject. @@ -70048,33 +71337,33 @@ subclasses of #GObject. glib:type-struct="LoadableIconIface"> Extends the #GIcon interface and adds the ability to + line="7084">Extends the #GIcon interface and adds the ability to load icons from streams. Loads a loadable icon. For the asynchronous version of this function, + line="27950">Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async(). a #GInputStream to read the icon from. + line="27964">a #GInputStream to read the icon from. a #GLoadableIcon. + line="27952">a #GLoadableIcon. an integer. + line="27953">an integer. allow-none="1"> a location to store the type of the loaded + line="27954">a location to store the type of the loaded icon, %NULL to ignore. @@ -70095,7 +71384,7 @@ icon, %NULL to ignore. allow-none="1"> optional #GCancellable object, %NULL to + line="27956">optional #GCancellable object, %NULL to ignore. @@ -70104,7 +71393,7 @@ ignore. Loads an icon asynchronously. To finish this function, see + line="27968">Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load(). @@ -70115,13 +71404,13 @@ version of this function, see g_loadable_icon_load(). a #GLoadableIcon. + line="27970">a #GLoadableIcon. an integer. + line="27971">an integer. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27972">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the + line="27973">a #GAsyncReadyCallback to call when the request is satisfied @@ -70152,7 +71441,7 @@ version of this function, see g_loadable_icon_load(). closure="3"> the data to pass to callback function + line="27975">the data to pass to callback function @@ -70160,25 +71449,25 @@ version of this function, see g_loadable_icon_load(). Finishes an asynchronous icon load started in g_loadable_icon_load_async(). + line="27983">Finishes an asynchronous icon load started in g_loadable_icon_load_async(). a #GInputStream to read the icon from. + line="27994">a #GInputStream to read the icon from. a #GLoadableIcon. + line="27985">a #GLoadableIcon. a #GAsyncResult. + line="27986">a #GAsyncResult. allow-none="1"> a location to store the type of the loaded + line="27987">a location to store the type of the loaded icon, %NULL to ignore. @@ -70198,26 +71487,26 @@ version of this function, see g_loadable_icon_load(). Loads a loadable icon. For the asynchronous version of this function, + line="27950">Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async(). a #GInputStream to read the icon from. + line="27964">a #GInputStream to read the icon from. a #GLoadableIcon. + line="27952">a #GLoadableIcon. an integer. + line="27953">an integer. allow-none="1"> a location to store the type of the loaded + line="27954">a location to store the type of the loaded icon, %NULL to ignore. @@ -70238,7 +71527,7 @@ icon, %NULL to ignore. allow-none="1"> optional #GCancellable object, %NULL to + line="27956">optional #GCancellable object, %NULL to ignore. @@ -70247,7 +71536,7 @@ ignore. Loads an icon asynchronously. To finish this function, see + line="27968">Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load(). @@ -70258,13 +71547,13 @@ version of this function, see g_loadable_icon_load(). a #GLoadableIcon. + line="27970">a #GLoadableIcon. an integer. + line="27971">an integer. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27972">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the + line="27973">a #GAsyncReadyCallback to call when the request is satisfied @@ -70294,7 +71583,7 @@ version of this function, see g_loadable_icon_load(). allow-none="1"> the data to pass to callback function + line="27975">the data to pass to callback function @@ -70304,25 +71593,25 @@ version of this function, see g_loadable_icon_load(). throws="1"> Finishes an asynchronous icon load started in g_loadable_icon_load_async(). + line="27983">Finishes an asynchronous icon load started in g_loadable_icon_load_async(). a #GInputStream to read the icon from. + line="27994">a #GInputStream to read the icon from. a #GLoadableIcon. + line="27985">a #GLoadableIcon. a #GAsyncResult. + line="27986">a #GAsyncResult. allow-none="1"> a location to store the type of the loaded + line="27987">a location to store the type of the loaded icon, %NULL to ignore. @@ -70359,20 +71648,20 @@ version of this function, see g_loadable_icon_load(). a #GInputStream to read the icon from. + line="27964">a #GInputStream to read the icon from. a #GLoadableIcon. + line="27952">a #GLoadableIcon. an integer. + line="27953">an integer. allow-none="1"> a location to store the type of the loaded + line="27954">a location to store the type of the loaded icon, %NULL to ignore. @@ -70393,7 +71682,7 @@ icon, %NULL to ignore. allow-none="1"> optional #GCancellable object, %NULL to + line="27956">optional #GCancellable object, %NULL to ignore. @@ -70410,13 +71699,13 @@ ignore. a #GLoadableIcon. + line="27970">a #GLoadableIcon. an integer. + line="27971">an integer. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27972">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the + line="27973">a #GAsyncReadyCallback to call when the request is satisfied @@ -70447,7 +71736,7 @@ ignore. closure="4"> the data to pass to callback function + line="27975">the data to pass to callback function @@ -70459,20 +71748,20 @@ ignore. a #GInputStream to read the icon from. + line="27994">a #GInputStream to read the icon from. a #GLoadableIcon. + line="27985">a #GLoadableIcon. a #GAsyncResult. + line="27986">a #GAsyncResult. allow-none="1"> a location to store the type of the loaded + line="27987">a location to store the type of the loaded icon, %NULL to ignore. @@ -70814,7 +72103,7 @@ See also g_menu_item_set_link(). glib:type-struct="MemoryInputStreamClass"> #GMemoryInputStream is a class for using arbitrary + line="7095">#GMemoryInputStream is a class for using arbitrary memory chunks as input for GIO streaming input operations. As of GLib 2.34, #GMemoryInputStream implements @@ -70825,12 +72114,12 @@ As of GLib 2.34, #GMemoryInputStream implements Creates a new empty #GMemoryInputStream. + line="28029">Creates a new empty #GMemoryInputStream. a new #GInputStream + line="28034">a new #GInputStream @@ -70839,19 +72128,19 @@ As of GLib 2.34, #GMemoryInputStream implements version="2.34"> Creates a new #GMemoryInputStream with data from the given @bytes. + line="28038">Creates a new #GMemoryInputStream with data from the given @bytes. new #GInputStream read from @bytes + line="28044">new #GInputStream read from @bytes a #GBytes + line="28040">a #GBytes @@ -70860,19 +72149,19 @@ As of GLib 2.34, #GMemoryInputStream implements c:identifier="g_memory_input_stream_new_from_data"> Creates a new #GMemoryInputStream with data in memory of a given size. + line="28049">Creates a new #GMemoryInputStream with data in memory of a given size. new #GInputStream read from @data of @len bytes. + line="28057">new #GInputStream read from @data of @len bytes. input data + line="28051">input data @@ -70880,7 +72169,7 @@ As of GLib 2.34, #GMemoryInputStream implements length of the data, may be -1 if @data is a nul-terminated string + line="28052">length of the data, may be -1 if @data is a nul-terminated string function that is called to free @data, or %NULL + line="28053">function that is called to free @data, or %NULL @@ -70900,7 +72189,7 @@ As of GLib 2.34, #GMemoryInputStream implements version="2.34"> Appends @bytes to data that can be read from the input stream. + line="28007">Appends @bytes to data that can be read from the input stream. @@ -70909,13 +72198,13 @@ As of GLib 2.34, #GMemoryInputStream implements a #GMemoryInputStream + line="28009">a #GMemoryInputStream input data + line="28010">input data @@ -70923,7 +72212,7 @@ As of GLib 2.34, #GMemoryInputStream implements Appends @data to data that can be read from the input stream + line="28018">Appends @data to data that can be read from the input stream @@ -70932,13 +72221,13 @@ As of GLib 2.34, #GMemoryInputStream implements a #GMemoryInputStream + line="28020">a #GMemoryInputStream input data + line="28021">input data @@ -70946,7 +72235,7 @@ As of GLib 2.34, #GMemoryInputStream implements length of the data, may be -1 if @data is a nul-terminated string + line="28022">length of the data, may be -1 if @data is a nul-terminated string function that is called to free @data, or %NULL + line="28023">function that is called to free @data, or %NULL @@ -71031,7 +72320,7 @@ As of GLib 2.34, #GMemoryInputStream implements glib:type-struct="MemoryMonitorInterface"> #GMemoryMonitor will monitor system memory and suggest to the application + line="7109">#GMemoryMonitor will monitor system memory and suggest to the application when to free memory so as to leave more room for other applications. It is implemented on Linux using the [Low Memory Monitor](https://gitlab.freedesktop.org/hadess/low-memory-monitor/) ([API documentation](https://hadess.pages.freedesktop.org/low-memory-monitor/)). @@ -71039,13 +72328,14 @@ It is implemented on Linux using the [Low Memory Monitor](https://gitlab.freedes There is also an implementation for use inside Flatpak sandboxes. Possible actions to take when the signal is received are: -- Free caches -- Save files that haven't been looked at in a while to disk, ready to be reopened when needed -- Run a garbage collection cycle -- Try and compress fragmented allocations -- Exit on idle if the process has no reason to stay around -- Call [`malloc_trim(3)`](man:malloc_trim) to return cached heap pages to - the kernel (if supported by your libc) + + - Free caches + - Save files that haven't been looked at in a while to disk, ready to be reopened when needed + - Run a garbage collection cycle + - Try and compress fragmented allocations + - Exit on idle if the process has no reason to stay around + - Call [`malloc_trim(3)`](man:malloc_trim) to return cached heap pages to + the kernel (if supported by your libc) Note that some actions may not always improve system performance, and so should be profiled for your application. `malloc_trim()`, for example, may @@ -71083,12 +72373,12 @@ signal, and unref the #GMemoryMonitor itself when exiting. version="2.64"> Gets a reference to the default #GMemoryMonitor for the system. + line="28061">Gets a reference to the default #GMemoryMonitor for the system. a new reference to the default #GMemoryMonitor + line="28066">a new reference to the default #GMemoryMonitor @@ -71110,7 +72400,7 @@ signal, and unref the #GMemoryMonitor itself when exiting. Emitted when the system is running low on free memory. The signal + line="2149">Emitted when the system is running low on free memory. The signal handler should then take the appropriate action depending on the warning level. See the #GMemoryMonitorWarningLevel documentation for details. @@ -71121,7 +72411,7 @@ details. the #GMemoryMonitorWarningLevel warning level + line="2152">the #GMemoryMonitorWarningLevel warning level @@ -71133,12 +72423,12 @@ details. version="2.64"> The virtual function table for #GMemoryMonitor. + line="2163">The virtual function table for #GMemoryMonitor. The parent interface. + line="2165">The parent interface. @@ -71166,7 +72456,7 @@ details. c:type="GMemoryMonitorWarningLevel"> Memory availability warning levels. + line="2075">Memory availability warning levels. Note that because new values might be added, it is recommended that applications check #GMemoryMonitorWarningLevel as ranges, for example: @@ -71177,20 +72467,22 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) + glib:nick="low" + glib:name="G_MEMORY_MONITOR_WARNING_LEVEL_LOW"> Memory on the device is low, processes + line="2077">Memory on the device is low, processes should free up unneeded resources (for example, in-memory caches) so they can be used elsewhere. + glib:nick="medium" + glib:name="G_MEMORY_MONITOR_WARNING_LEVEL_MEDIUM"> Same as @G_MEMORY_MONITOR_WARNING_LEVEL_LOW + line="2080">Same as @G_MEMORY_MONITOR_WARNING_LEVEL_LOW but the device has even less free memory, so processes should try harder to free up unneeded resources. If your process does not need to stay running, it is a good time for it to quit. @@ -71198,10 +72490,11 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) + glib:nick="critical" + glib:name="G_MEMORY_MONITOR_WARNING_LEVEL_CRITICAL"> The system will soon start terminating + line="2084">The system will soon start terminating processes to reclaim memory, including background processes. @@ -71214,7 +72507,7 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) glib:type-struct="MemoryOutputStreamClass"> #GMemoryOutputStream is a class for using arbitrary + line="7166">#GMemoryOutputStream is a class for using arbitrary memory chunks as output for GIO streaming output operations. As of GLib 2.34, #GMemoryOutputStream trivially implements @@ -71227,7 +72520,7 @@ As of GLib 2.34, #GMemoryOutputStream trivially implements introspectable="0"> Creates a new #GMemoryOutputStream. + line="28121">Creates a new #GMemoryOutputStream. In most cases this is not the function you want. See g_memory_output_stream_new_resizable() instead. @@ -71272,7 +72565,7 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); A newly created #GMemoryOutputStream object. + line="28172">A newly created #GMemoryOutputStream object. @@ -71282,13 +72575,13 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); allow-none="1"> pointer to a chunk of memory to use, or %NULL + line="28123">pointer to a chunk of memory to use, or %NULL the size of @data + line="28124">the size of @data a function with realloc() semantics (like g_realloc()) + line="28125">a function with realloc() semantics (like g_realloc()) to be called when @data needs to be grown, or %NULL @@ -71310,7 +72603,7 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); scope="async"> a function to be called on @data when the stream is + line="28127">a function to be called on @data when the stream is finalized, or %NULL @@ -71321,17 +72614,19 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); version="2.36"> Creates a new #GMemoryOutputStream, using g_realloc() and g_free() + line="28176">Creates a new #GMemoryOutputStream, using g_realloc() and g_free() for memory allocation. - + Gets any loaded data from the @ostream. + line="28071">Gets any loaded data from the @ostream. Note that the returned pointer may become invalid on the next write or truncate operation on the stream. @@ -71339,7 +72634,7 @@ write or truncate operation on the stream. pointer to the stream's data, or %NULL if the data + line="28080">pointer to the stream's data, or %NULL if the data has been stolen @@ -71347,38 +72642,41 @@ write or truncate operation on the stream. a #GMemoryOutputStream + line="28073">a #GMemoryOutputStream Returns the number of bytes from the start up to including the last + line="28085">Returns the number of bytes from the start up to including the last byte written in the stream that has not been truncated away. the number of bytes written to the stream + line="28092">the number of bytes written to the stream a #GMemoryOutputStream + line="28087">a #GMemoryOutputStream - + Gets the size of the currently allocated data area (available from + line="28097">Gets the size of the currently allocated data area (available from g_memory_output_stream_get_data()). You probably don't want to use this function on resizable streams. @@ -71397,14 +72695,14 @@ stream, use g_memory_output_stream_get_data_size(). the number of bytes allocated for the data buffer + line="28117">the number of bytes allocated for the data buffer a #GMemoryOutputStream + line="28099">a #GMemoryOutputStream @@ -71414,20 +72712,20 @@ stream, use g_memory_output_stream_get_data_size(). version="2.34"> Returns data from the @ostream as a #GBytes. @ostream must be + line="28186">Returns data from the @ostream as a #GBytes. @ostream must be closed before calling this function. the stream's data + line="28193">the stream's data a #GMemoryOutputStream + line="28188">a #GMemoryOutputStream @@ -71437,7 +72735,7 @@ closed before calling this function. version="2.26"> Gets any loaded data from the @ostream. Ownership of the data + line="28198">Gets any loaded data from the @ostream. Ownership of the data is transferred to the caller; when no longer needed it must be freed using the free function set in @ostream's #GMemoryOutputStream:destroy-function property. @@ -71447,7 +72745,7 @@ freed using the free function set in @ostream's the stream's data, or %NULL if it has previously + line="28209">the stream's data, or %NULL if it has previously been stolen @@ -71455,7 +72753,7 @@ freed using the free function set in @ostream's a #GMemoryOutputStream + line="28200">a #GMemoryOutputStream @@ -71464,16 +72762,20 @@ freed using the free function set in @ostream's version="2.24" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_data"> Pointer to buffer where data will be written. + line="2175">Pointer to buffer where data will be written. - + Size of data written to the buffer. + line="2184">Size of data written to the buffer. Function called with the buffer as argument when the stream is destroyed. + line="2193">Function called with the buffer as argument when the stream is destroyed. Function with realloc semantics called to enlarge the buffer. + line="2202">Function with realloc semantics called to enlarge the buffer. + transfer-ownership="none" + getter="get_size"> Current size of the data buffer. + line="2211">Current size of the data buffer. @@ -71578,7 +72881,7 @@ freed using the free function set in @ostream's glib:get-type="g_menu_get_type"> #GMenu is a simple implementation of #GMenuModel. + line="7180">#GMenu is a simple implementation of #GMenuModel. You populate a #GMenu by adding #GMenuItem instances to it. There are some convenience functions to allow you to directly @@ -71589,21 +72892,21 @@ g_menu_insert_submenu(). Creates a new #GMenu. + line="29096">Creates a new #GMenu. The new menu has no items. a new #GMenu + line="29103">a new #GMenu Convenience function for appending a normal menu item to the end of + line="28229">Convenience function for appending a normal menu item to the end of @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. @@ -71614,7 +72917,7 @@ flexible alternative. a #GMenu + line="28231">a #GMenu allow-none="1"> the section label, or %NULL + line="28232">the section label, or %NULL allow-none="1"> the detailed action string, or %NULL + line="28233">the detailed action string, or %NULL @@ -71642,7 +72945,7 @@ flexible alternative. version="2.32"> Appends @item to the end of @menu. + line="28243">Appends @item to the end of @menu. See g_menu_insert_item() for more information. @@ -71653,13 +72956,13 @@ See g_menu_insert_item() for more information. a #GMenu + line="28245">a #GMenu a #GMenuItem to append + line="28246">a #GMenuItem to append @@ -71669,7 +72972,7 @@ See g_menu_insert_item() for more information. version="2.32"> Convenience function for appending a section menu item to the end of + line="28256">Convenience function for appending a section menu item to the end of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. @@ -71680,7 +72983,7 @@ more flexible alternative. a #GMenu + line="28258">a #GMenu allow-none="1"> the section label, or %NULL + line="28259">the section label, or %NULL a #GMenuModel with the items of the section + line="28260">a #GMenuModel with the items of the section @@ -71705,7 +73008,7 @@ more flexible alternative. version="2.32"> Convenience function for appending a submenu menu item to the end of + line="28270">Convenience function for appending a submenu menu item to the end of @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. @@ -71716,7 +73019,7 @@ more flexible alternative. a #GMenu + line="28272">a #GMenu allow-none="1"> the section label, or %NULL + line="28273">the section label, or %NULL a #GMenuModel with the items of the submenu + line="28274">a #GMenuModel with the items of the submenu @@ -71739,7 +73042,7 @@ more flexible alternative. Marks @menu as frozen. + line="28358">Marks @menu as frozen. After the menu is frozen, it is an error to attempt to make any changes to it. In effect this means that the #GMenu API must no @@ -71755,7 +73058,7 @@ This function causes g_menu_model_is_mutable() to begin returning a #GMenu + line="28360">a #GMenu @@ -71763,7 +73066,7 @@ This function causes g_menu_model_is_mutable() to begin returning Convenience function for inserting a normal menu item into @menu. + line="28375">Convenience function for inserting a normal menu item into @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. @@ -71774,13 +73077,13 @@ alternative. a #GMenu + line="28377">a #GMenu the position at which to insert the item + line="28378">the position at which to insert the item allow-none="1"> the section label, or %NULL + line="28379">the section label, or %NULL allow-none="1"> the detailed action string, or %NULL + line="28380">the detailed action string, or %NULL @@ -71808,7 +73111,7 @@ alternative. version="2.32"> Inserts @item into @menu. + line="28390">Inserts @item into @menu. The "insertion" is actually done by copying all of the attribute and link values of @item and using them to form a new item within @menu. @@ -71833,19 +73136,19 @@ each of these functions. a #GMenu + line="28392">a #GMenu the position at which to insert the item + line="28393">the position at which to insert the item the #GMenuItem to insert + line="28394">the #GMenuItem to insert @@ -71855,7 +73158,7 @@ each of these functions. version="2.32"> Convenience function for inserting a section menu item into @menu. + line="28418">Convenience function for inserting a section menu item into @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. @@ -71866,13 +73169,13 @@ flexible alternative. a #GMenu + line="28420">a #GMenu the position at which to insert the item + line="28421">the position at which to insert the item allow-none="1"> the section label, or %NULL + line="28422">the section label, or %NULL a #GMenuModel with the items of the section + line="28423">a #GMenuModel with the items of the section @@ -71897,7 +73200,7 @@ flexible alternative. version="2.32"> Convenience function for inserting a submenu menu item into @menu. + line="28433">Convenience function for inserting a submenu menu item into @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. @@ -71908,13 +73211,13 @@ flexible alternative. a #GMenu + line="28435">a #GMenu the position at which to insert the item + line="28436">the position at which to insert the item allow-none="1"> the section label, or %NULL + line="28437">the section label, or %NULL a #GMenuModel with the items of the submenu + line="28438">a #GMenuModel with the items of the submenu @@ -71937,7 +73240,7 @@ flexible alternative. Convenience function for prepending a normal menu item to the start + line="29108">Convenience function for prepending a normal menu item to the start of @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. @@ -71948,7 +73251,7 @@ flexible alternative. a #GMenu + line="29110">a #GMenu allow-none="1"> the section label, or %NULL + line="29111">the section label, or %NULL allow-none="1"> the detailed action string, or %NULL + line="29112">the detailed action string, or %NULL @@ -71976,7 +73279,7 @@ flexible alternative. version="2.32"> Prepends @item to the start of @menu. + line="29122">Prepends @item to the start of @menu. See g_menu_insert_item() for more information. @@ -71987,13 +73290,13 @@ See g_menu_insert_item() for more information. a #GMenu + line="29124">a #GMenu a #GMenuItem to prepend + line="29125">a #GMenuItem to prepend @@ -72003,7 +73306,7 @@ See g_menu_insert_item() for more information. version="2.32"> Convenience function for prepending a section menu item to the start + line="29135">Convenience function for prepending a section menu item to the start of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. @@ -72014,7 +73317,7 @@ a more flexible alternative. a #GMenu + line="29137">a #GMenu allow-none="1"> the section label, or %NULL + line="29138">the section label, or %NULL a #GMenuModel with the items of the section + line="29139">a #GMenuModel with the items of the section @@ -72039,7 +73342,7 @@ a more flexible alternative. version="2.32"> Convenience function for prepending a submenu menu item to the start + line="29149">Convenience function for prepending a submenu menu item to the start of @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. @@ -72050,7 +73353,7 @@ a more flexible alternative. a #GMenu + line="29151">a #GMenu allow-none="1"> the section label, or %NULL + line="29152">the section label, or %NULL a #GMenuModel with the items of the submenu + line="29153">a #GMenuModel with the items of the submenu @@ -72073,7 +73376,7 @@ a more flexible alternative. Removes an item from the menu. + line="29163">Removes an item from the menu. @position gives the index of the item to remove. @@ -72091,13 +73394,13 @@ identity of the item itself is not preserved). a #GMenu + line="29165">a #GMenu the position of the item to remove + line="29166">the position of the item to remove @@ -72107,7 +73410,7 @@ identity of the item itself is not preserved). version="2.38"> Removes all items in the menu. + line="29183">Removes all items in the menu. @@ -72116,7 +73419,7 @@ identity of the item itself is not preserved). a #GMenu + line="29185">a #GMenu @@ -72133,13 +73436,13 @@ identity of the item itself is not preserved). glib:type-struct="MenuAttributeIterClass"> #GMenuAttributeIter is an opaque structure type. You must access it + line="2230">#GMenuAttributeIter is an opaque structure type. You must access it using the functions below. This function combines g_menu_attribute_iter_next() with + line="28298">This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). First the iterator is advanced to the next (possibly first) attribute. @@ -72158,7 +73461,7 @@ be unreffed using g_variant_unref() when it is no longer in use. %TRUE on success, or %FALSE if there is no additional + line="28320">%TRUE on success, or %FALSE if there is no additional attribute @@ -72166,7 +73469,7 @@ be unreffed using g_variant_unref() when it is no longer in use. a #GMenuAttributeIter + line="28300">a #GMenuAttributeIter allow-none="1"> the type of the attribute + line="28301">the type of the attribute allow-none="1"> the attribute value + line="28302">the attribute value @@ -72198,7 +73501,7 @@ be unreffed using g_variant_unref() when it is no longer in use. version="2.32"> Gets the name of the attribute at the current iterator position, as + line="28284">Gets the name of the attribute at the current iterator position, as a string. The iterator is not advanced. @@ -72206,14 +73509,14 @@ The iterator is not advanced. the name of the attribute + line="28293">the name of the attribute a #GMenuAttributeIter + line="28286">a #GMenuAttributeIter @@ -72223,7 +73526,7 @@ The iterator is not advanced. version="2.32"> This function combines g_menu_attribute_iter_next() with + line="28298">This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). First the iterator is advanced to the next (possibly first) attribute. @@ -72242,7 +73545,7 @@ be unreffed using g_variant_unref() when it is no longer in use. %TRUE on success, or %FALSE if there is no additional + line="28320">%TRUE on success, or %FALSE if there is no additional attribute @@ -72250,7 +73553,7 @@ be unreffed using g_variant_unref() when it is no longer in use. a #GMenuAttributeIter + line="28300">a #GMenuAttributeIter allow-none="1"> the type of the attribute + line="28301">the type of the attribute allow-none="1"> the attribute value + line="28302">the attribute value @@ -72282,21 +73585,21 @@ be unreffed using g_variant_unref() when it is no longer in use. version="2.32"> Gets the value of the attribute at the current iterator position. + line="28326">Gets the value of the attribute at the current iterator position. The iterator is not advanced. the value of the current attribute + line="28334">the value of the current attribute a #GMenuAttributeIter + line="28328">a #GMenuAttributeIter @@ -72306,7 +73609,7 @@ The iterator is not advanced. version="2.32"> Attempts to advance the iterator to the next (possibly first) + line="28339">Attempts to advance the iterator to the next (possibly first) attribute. %TRUE is returned on success, or %FALSE if there are no more @@ -72319,14 +73622,14 @@ attribute exists at all). %TRUE on success, or %FALSE when there are no more attributes + line="28353">%TRUE on success, or %FALSE when there are no more attributes a #GMenuAttributeIter + line="28341">a #GMenuAttributeIter @@ -72352,7 +73655,7 @@ attribute exists at all). %TRUE on success, or %FALSE if there is no additional + line="28320">%TRUE on success, or %FALSE if there is no additional attribute @@ -72360,7 +73663,7 @@ attribute exists at all). a #GMenuAttributeIter + line="28300">a #GMenuAttributeIter allow-none="1"> the type of the attribute + line="28301">the type of the attribute allow-none="1"> the attribute value + line="28302">the attribute value @@ -72403,12 +73706,12 @@ attribute exists at all). glib:get-type="g_menu_item_get_type"> #GMenuItem is an opaque structure type. You must access it using the + line="2240">#GMenuItem is an opaque structure type. You must access it using the functions below. Creates a new #GMenuItem. + line="28500">Creates a new #GMenuItem. If @label is non-%NULL it is used to set the "label" attribute of the new item. @@ -72420,7 +73723,7 @@ g_menu_item_set_detailed_action() for more information. a new #GMenuItem + line="28514">a new #GMenuItem @@ -72430,7 +73733,7 @@ g_menu_item_set_detailed_action() for more information. allow-none="1"> the section label, or %NULL + line="28502">the section label, or %NULL allow-none="1"> the detailed action string, or %NULL + line="28503">the detailed action string, or %NULL @@ -72449,7 +73752,7 @@ g_menu_item_set_detailed_action() for more information. version="2.34"> Creates a #GMenuItem as an exact copy of an existing menu item in a + line="28519">Creates a #GMenuItem as an exact copy of an existing menu item in a #GMenuModel. @item_index must be valid (ie: be sure to call @@ -72458,20 +73761,20 @@ g_menu_model_get_n_items() first). a new #GMenuItem. + line="28530">a new #GMenuItem. a #GMenuModel + line="28521">a #GMenuModel the index of an item in @model + line="28522">the index of an item in @model @@ -72481,7 +73784,7 @@ g_menu_model_get_n_items() first). version="2.32"> Creates a new #GMenuItem representing a section. + line="28535">Creates a new #GMenuItem representing a section. This is a convenience API around g_menu_item_new() and g_menu_item_set_section(). @@ -72545,7 +73848,7 @@ purpose of understanding what is really going on). a new #GMenuItem + line="28601">a new #GMenuItem @@ -72555,13 +73858,13 @@ purpose of understanding what is really going on). allow-none="1"> the section label, or %NULL + line="28537">the section label, or %NULL a #GMenuModel with the items of the section + line="28538">a #GMenuModel with the items of the section @@ -72571,7 +73874,7 @@ purpose of understanding what is really going on). version="2.32"> Creates a new #GMenuItem representing a submenu. + line="28606">Creates a new #GMenuItem representing a submenu. This is a convenience API around g_menu_item_new() and g_menu_item_set_submenu(). @@ -72579,7 +73882,7 @@ g_menu_item_set_submenu(). a new #GMenuItem + line="28616">a new #GMenuItem @@ -72589,13 +73892,13 @@ g_menu_item_set_submenu(). allow-none="1"> the section label, or %NULL + line="28608">the section label, or %NULL a #GMenuModel with the items of the submenu + line="28609">a #GMenuModel with the items of the submenu @@ -72606,7 +73909,7 @@ g_menu_item_set_submenu(). introspectable="0"> Queries the named @attribute on @menu_item. + line="28448">Queries the named @attribute on @menu_item. If the attribute exists and matches the #GVariantType corresponding to @format_string then @format_string is used to deconstruct the @@ -72619,7 +73922,7 @@ returned. %TRUE if the named attribute was found with the expected + line="28465">%TRUE if the named attribute was found with the expected type @@ -72627,25 +73930,25 @@ returned. a #GMenuItem + line="28450">a #GMenuItem the attribute name to query + line="28451">the attribute name to query a #GVariant format string + line="28452">a #GVariant format string positional parameters, as per @format_string + line="28453">positional parameters, as per @format_string @@ -72655,29 +73958,29 @@ returned. version="2.34"> Queries the named @attribute on @menu_item. + line="28471">Queries the named @attribute on @menu_item. If @expected_type is specified and the attribute does not have this type, %NULL is returned. %NULL is also returned if the attribute simply does not exist. - + the attribute value, or %NULL + line="28483">the attribute value, or %NULL a #GMenuItem + line="28473">a #GMenuItem the attribute name to query + line="28474">the attribute name to query allow-none="1"> the expected type of the attribute + line="28475">the expected type of the attribute @@ -72696,25 +73999,25 @@ simply does not exist. version="2.34"> Queries the named @link on @menu_item. + line="28488">Queries the named @link on @menu_item. - + the link, or %NULL + line="28495">the link, or %NULL a #GMenuItem + line="28490">a #GMenuItem the link name to query + line="28491">the link name to query @@ -72725,7 +74028,7 @@ simply does not exist. introspectable="0"> Sets or unsets the "action" and "target" attributes of @menu_item. + line="28621">Sets or unsets the "action" and "target" attributes of @menu_item. If @action is %NULL then both the "action" and "target" attributes are unset (and @format_string is ignored along with the positional @@ -72752,7 +74055,7 @@ description of the semantics of the action and target attributes. a #GMenuItem + line="28623">a #GMenuItem allow-none="1"> the name of the action for this item + line="28624">the name of the action for this item allow-none="1"> a GVariant format string + line="28625">a GVariant format string positional parameters, as per @format_string + line="28626">positional parameters, as per @format_string @@ -72786,7 +74089,7 @@ description of the semantics of the action and target attributes. version="2.32"> Sets or unsets the "action" and "target" attributes of @menu_item. + line="28652">Sets or unsets the "action" and "target" attributes of @menu_item. If @action is %NULL then both the "action" and "target" attributes are unset (and @target_value is ignored). @@ -72830,7 +74133,7 @@ probably more convenient for most uses. a #GMenuItem + line="28654">a #GMenuItem allow-none="1"> the name of the action for this item + line="28655">the name of the action for this item allow-none="1"> a #GVariant to use as the action target + line="28656">a #GVariant to use as the action target @@ -72859,7 +74162,7 @@ probably more convenient for most uses. introspectable="0"> Sets or unsets an attribute on @menu_item. + line="28699">Sets or unsets an attribute on @menu_item. The attribute to set or unset is specified by @attribute. This can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, @@ -72884,13 +74187,13 @@ that directly accepts a #GVariant. a #GMenuItem + line="28701">a #GMenuItem the attribute to set + line="28702">the attribute to set allow-none="1"> a #GVariant format string, or %NULL + line="28703">a #GVariant format string, or %NULL positional parameters, as per @format_string + line="28704">positional parameters, as per @format_string @@ -72915,7 +74218,7 @@ that directly accepts a #GVariant. version="2.32"> Sets or unsets an attribute on @menu_item. + line="28728">Sets or unsets an attribute on @menu_item. The attribute to set or unset is specified by @attribute. This can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, @@ -72942,13 +74245,13 @@ the same. a #GMenuItem + line="28730">a #GMenuItem the attribute to set + line="28731">the attribute to set allow-none="1"> a #GVariant to use as the value, or %NULL + line="28732">a #GVariant to use as the value, or %NULL @@ -72967,7 +74270,7 @@ the same. version="2.32"> Sets the "action" and possibly the "target" attribute of @menu_item. + line="28758">Sets the "action" and possibly the "target" attribute of @menu_item. The format of @detailed_action is the same format parsed by g_action_parse_detailed_name(). @@ -72986,13 +74289,13 @@ the semantics of the action and target attributes. a #GMenuItem + line="28760">a #GMenuItem the "detailed" action string + line="28761">the "detailed" action string @@ -73002,7 +74305,7 @@ the semantics of the action and target attributes. version="2.38"> Sets (or unsets) the icon on @menu_item. + line="28779">Sets (or unsets) the icon on @menu_item. This call is the same as calling g_icon_serialize() and using the result as the value to g_menu_item_set_attribute_value() for @@ -73022,13 +74325,13 @@ If @icon is %NULL then the icon is unset. a #GMenuItem + line="28781">a #GMenuItem a #GIcon, or %NULL + line="28782">a #GIcon, or %NULL @@ -73038,7 +74341,7 @@ If @icon is %NULL then the icon is unset. version="2.32"> Sets or unsets the "label" attribute of @menu_item. + line="28801">Sets or unsets the "label" attribute of @menu_item. If @label is non-%NULL it is used as the label for the menu item. If it is %NULL then the label attribute is unset. @@ -73050,7 +74353,7 @@ it is %NULL then the label attribute is unset. a #GMenuItem + line="28803">a #GMenuItem allow-none="1"> the label to set, or %NULL to unset + line="28804">the label to set, or %NULL to unset @@ -73069,7 +74372,7 @@ it is %NULL then the label attribute is unset. version="2.32"> Creates a link from @menu_item to @model if non-%NULL, or unsets it. + line="28815">Creates a link from @menu_item to @model if non-%NULL, or unsets it. Links are used to establish a relationship between a particular menu item and another menu. For example, %G_MENU_LINK_SUBMENU is used to @@ -73087,13 +74390,13 @@ must not end with a '-', and must not contain consecutive dashes. a #GMenuItem + line="28817">a #GMenuItem type of link to establish or unset + line="28818">type of link to establish or unset allow-none="1"> the #GMenuModel to link to (or %NULL to unset) + line="28819">the #GMenuModel to link to (or %NULL to unset) @@ -73112,7 +74415,7 @@ must not end with a '-', and must not contain consecutive dashes. version="2.32"> Sets or unsets the "section" link of @menu_item to @section. + line="28836">Sets or unsets the "section" link of @menu_item to @section. The effect of having one menu appear as a section of another is exactly as it sounds: the items from @section become a direct part of @@ -73127,7 +74430,7 @@ section. a #GMenuItem + line="28838">a #GMenuItem allow-none="1"> a #GMenuModel, or %NULL + line="28839">a #GMenuModel, or %NULL @@ -73146,7 +74449,7 @@ section. version="2.32"> Sets or unsets the "submenu" link of @menu_item to @submenu. + line="28853">Sets or unsets the "submenu" link of @menu_item to @submenu. If @submenu is non-%NULL, it is linked to. If it is %NULL then the link is unset. @@ -73161,7 +74464,7 @@ exactly as it sounds. a #GMenuItem + line="28855">a #GMenuItem allow-none="1"> a #GMenuModel, or %NULL + line="28856">a #GMenuModel, or %NULL @@ -73187,13 +74490,13 @@ exactly as it sounds. glib:type-struct="MenuLinkIterClass"> #GMenuLinkIter is an opaque structure type. You must access it using + line="2250">#GMenuLinkIter is an opaque structure type. You must access it using the functions below. This function combines g_menu_link_iter_next() with + line="28883">This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). First the iterator is advanced to the next (possibly first) link. @@ -73211,14 +74514,14 @@ be unreffed using g_object_unref() when it is no longer in use. %TRUE on success, or %FALSE if there is no additional link + line="28904">%TRUE on success, or %FALSE if there is no additional link a #GMenuLinkIter + line="28885">a #GMenuLinkIter allow-none="1"> the name of the link + line="28886">the name of the link allow-none="1"> the linked #GMenuModel + line="28887">the linked #GMenuModel @@ -73250,21 +74553,21 @@ be unreffed using g_object_unref() when it is no longer in use. version="2.32"> Gets the name of the link at the current iterator position. + line="28870">Gets the name of the link at the current iterator position. The iterator is not advanced. the type of the link + line="28878">the type of the link a #GMenuLinkIter + line="28872">a #GMenuLinkIter @@ -73274,7 +74577,7 @@ The iterator is not advanced. version="2.32"> This function combines g_menu_link_iter_next() with + line="28883">This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). First the iterator is advanced to the next (possibly first) link. @@ -73292,14 +74595,14 @@ be unreffed using g_object_unref() when it is no longer in use. %TRUE on success, or %FALSE if there is no additional link + line="28904">%TRUE on success, or %FALSE if there is no additional link a #GMenuLinkIter + line="28885">a #GMenuLinkIter allow-none="1"> the name of the link + line="28886">the name of the link allow-none="1"> the linked #GMenuModel + line="28887">the linked #GMenuModel @@ -73331,21 +74634,21 @@ be unreffed using g_object_unref() when it is no longer in use. version="2.32"> Gets the linked #GMenuModel at the current iterator position. + line="28909">Gets the linked #GMenuModel at the current iterator position. The iterator is not advanced. the #GMenuModel that is linked to + line="28917">the #GMenuModel that is linked to a #GMenuLinkIter + line="28911">a #GMenuLinkIter @@ -73353,7 +74656,7 @@ The iterator is not advanced. Attempts to advance the iterator to the next (possibly first) + line="28922">Attempts to advance the iterator to the next (possibly first) link. %TRUE is returned on success, or %FALSE if there are no more links. @@ -73365,14 +74668,14 @@ at all). %TRUE on success, or %FALSE when there are no more links + line="28935">%TRUE on success, or %FALSE when there are no more links a #GMenuLinkIter + line="28924">a #GMenuLinkIter @@ -73397,14 +74700,14 @@ at all). %TRUE on success, or %FALSE if there is no additional link + line="28904">%TRUE on success, or %FALSE if there is no additional link a #GMenuLinkIter + line="28885">a #GMenuLinkIter allow-none="1"> the name of the link + line="28886">the name of the link allow-none="1"> the linked #GMenuModel + line="28887">the linked #GMenuModel @@ -73449,7 +74752,7 @@ at all). glib:type-struct="MenuModelClass"> #GMenuModel represents the contents of a menu -- an ordered list of + line="7213">#GMenuModel represents the contents of a menu -- an ordered list of menu items. The items are associated with actions, which can be activated through them. Items can be grouped in sections, and may have submenus associated with them. Both items and sections usually @@ -73568,7 +74871,7 @@ target value of the menu item. version="2.32"> Queries the item at position @item_index in @model for the attribute + line="28971">Queries the item at position @item_index in @model for the attribute specified by @attribute. If @expected_type is non-%NULL then it specifies the expected type of @@ -73580,29 +74883,29 @@ expected type is unspecified) then the value is returned. If the attribute does not exist, or does not match the expected type then %NULL is returned. - + the value of the attribute + line="28991">the value of the attribute a #GMenuModel + line="28973">a #GMenuModel the index of the item + line="28974">the index of the item the attribute to query + line="28975">the attribute to query allow-none="1"> the expected type of the attribute, or + line="28976">the expected type of the attribute, or %NULL @@ -73657,35 +74960,35 @@ then %NULL is returned. version="2.32"> Queries the item at position @item_index in @model for the link + line="28996">Queries the item at position @item_index in @model for the link specified by @link. If the link exists, the linked #GMenuModel is returned. If the link does not exist, %NULL is returned. - + the linked #GMenuModel, or %NULL + line="29008">the linked #GMenuModel, or %NULL a #GMenuModel + line="28998">a #GMenuModel the index of the item + line="28999">the index of the item the link to query + line="29000">the link to query @@ -73728,19 +75031,19 @@ does not exist, %NULL is returned. Query the number of items in @model. + line="29013">Query the number of items in @model. the number of items + line="29019">the number of items a #GMenuModel + line="29015">a #GMenuModel @@ -73748,7 +75051,7 @@ does not exist, %NULL is returned. Queries if @model is mutable. + line="29024">Queries if @model is mutable. An immutable #GMenuModel will never emit the #GMenuModel::items-changed signal. Consumers of the model may make optimisations accordingly. @@ -73756,7 +75059,7 @@ signal. Consumers of the model may make optimisations accordingly. %TRUE if the model is mutable (ie: "items-changed" may be + line="29033">%TRUE if the model is mutable (ie: "items-changed" may be emitted). @@ -73764,7 +75067,7 @@ signal. Consumers of the model may make optimisations accordingly. a #GMenuModel + line="29026">a #GMenuModel @@ -73774,7 +75077,7 @@ signal. Consumers of the model may make optimisations accordingly. version="2.32"> Creates a #GMenuAttributeIter to iterate over the attributes of + line="29066">Creates a #GMenuAttributeIter to iterate over the attributes of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. @@ -73782,20 +75085,20 @@ You must free the iterator with g_object_unref() when you are done. a new #GMenuAttributeIter + line="29076">a new #GMenuAttributeIter a #GMenuModel + line="29068">a #GMenuModel the index of the item + line="29069">the index of the item @@ -73805,7 +75108,7 @@ You must free the iterator with g_object_unref() when you are done. version="2.32"> Creates a #GMenuLinkIter to iterate over the links of the item at + line="29081">Creates a #GMenuLinkIter to iterate over the links of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. @@ -73813,20 +75116,20 @@ You must free the iterator with g_object_unref() when you are done. a new #GMenuLinkIter + line="29091">a new #GMenuLinkIter a #GMenuModel + line="29083">a #GMenuModel the index of the item + line="29084">the index of the item @@ -73837,7 +75140,7 @@ You must free the iterator with g_object_unref() when you are done. introspectable="0"> Queries item at position @item_index in @model for the attribute + line="28940">Queries item at position @item_index in @model for the attribute specified by @attribute. If the attribute exists and matches the #GVariantType corresponding @@ -73857,7 +75160,7 @@ particular, no '&' characters are allowed in @format_string. %TRUE if the named attribute was found with the expected + line="28965">%TRUE if the named attribute was found with the expected type @@ -73865,31 +75168,31 @@ particular, no '&' characters are allowed in @format_string. a #GMenuModel + line="28942">a #GMenuModel the index of the item + line="28943">the index of the item the attribute to query + line="28944">the attribute to query a #GVariant format string + line="28945">a #GVariant format string positional parameters, as per @format_string + line="28946">positional parameters, as per @format_string @@ -73899,7 +75202,7 @@ particular, no '&' characters are allowed in @format_string. version="2.32"> Queries the item at position @item_index in @model for the attribute + line="28971">Queries the item at position @item_index in @model for the attribute specified by @attribute. If @expected_type is non-%NULL then it specifies the expected type of @@ -73911,29 +75214,29 @@ expected type is unspecified) then the value is returned. If the attribute does not exist, or does not match the expected type then %NULL is returned. - + the value of the attribute + line="28991">the value of the attribute a #GMenuModel + line="28973">a #GMenuModel the index of the item + line="28974">the index of the item the attribute to query + line="28975">the attribute to query allow-none="1"> the expected type of the attribute, or + line="28976">the expected type of the attribute, or %NULL @@ -73953,35 +75256,35 @@ then %NULL is returned. version="2.32"> Queries the item at position @item_index in @model for the link + line="28996">Queries the item at position @item_index in @model for the link specified by @link. If the link exists, the linked #GMenuModel is returned. If the link does not exist, %NULL is returned. - + the linked #GMenuModel, or %NULL + line="29008">the linked #GMenuModel, or %NULL a #GMenuModel + line="28998">a #GMenuModel the index of the item + line="28999">the index of the item the link to query + line="29000">the link to query @@ -73991,19 +75294,19 @@ does not exist, %NULL is returned. version="2.32"> Query the number of items in @model. + line="29013">Query the number of items in @model. the number of items + line="29019">the number of items a #GMenuModel + line="29015">a #GMenuModel @@ -74013,7 +75316,7 @@ does not exist, %NULL is returned. version="2.32"> Queries if @model is mutable. + line="29024">Queries if @model is mutable. An immutable #GMenuModel will never emit the #GMenuModel::items-changed signal. Consumers of the model may make optimisations accordingly. @@ -74021,7 +75324,7 @@ signal. Consumers of the model may make optimisations accordingly. %TRUE if the model is mutable (ie: "items-changed" may be + line="29033">%TRUE if the model is mutable (ie: "items-changed" may be emitted). @@ -74029,7 +75332,7 @@ signal. Consumers of the model may make optimisations accordingly. a #GMenuModel + line="29026">a #GMenuModel @@ -74039,7 +75342,7 @@ signal. Consumers of the model may make optimisations accordingly. version="2.32"> Requests emission of the #GMenuModel::items-changed signal on @model. + line="29039">Requests emission of the #GMenuModel::items-changed signal on @model. This function should never be called except by #GMenuModel subclasses. Any other calls to this function will very likely lead @@ -74062,25 +75365,25 @@ user code is running without returning to the mainloop. a #GMenuModel + line="29041">a #GMenuModel the position of the change + line="29042">the position of the change the number of items removed + line="29043">the number of items removed the number of items added + line="29044">the number of items added @@ -74090,7 +75393,7 @@ user code is running without returning to the mainloop. version="2.32"> Creates a #GMenuAttributeIter to iterate over the attributes of + line="29066">Creates a #GMenuAttributeIter to iterate over the attributes of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. @@ -74098,20 +75401,20 @@ You must free the iterator with g_object_unref() when you are done. a new #GMenuAttributeIter + line="29076">a new #GMenuAttributeIter a #GMenuModel + line="29068">a #GMenuModel the index of the item + line="29069">the index of the item @@ -74121,7 +75424,7 @@ You must free the iterator with g_object_unref() when you are done. version="2.32"> Creates a #GMenuLinkIter to iterate over the links of the item at + line="29081">Creates a #GMenuLinkIter to iterate over the links of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. @@ -74129,20 +75432,20 @@ You must free the iterator with g_object_unref() when you are done. a new #GMenuLinkIter + line="29091">a new #GMenuLinkIter a #GMenuModel + line="29083">a #GMenuModel the index of the item + line="29084">the index of the item @@ -74156,7 +75459,7 @@ You must free the iterator with g_object_unref() when you are done. Emitted when a change has occurred to the menu. + line="2270">Emitted when a change has occurred to the menu. The only changes that can occur to a menu is that items are removed or added. Items may not change (except by being removed and added @@ -74183,19 +75486,19 @@ reported. The signal is emitted after the modification. the position of the change + line="2273">the position of the change the number of items removed + line="2274">the number of items removed the number of items added + line="2275">the number of items added @@ -74214,7 +75517,7 @@ reported. The signal is emitted after the modification. %TRUE if the model is mutable (ie: "items-changed" may be + line="29033">%TRUE if the model is mutable (ie: "items-changed" may be emitted). @@ -74222,7 +75525,7 @@ reported. The signal is emitted after the modification. a #GMenuModel + line="29026">a #GMenuModel @@ -74234,14 +75537,14 @@ reported. The signal is emitted after the modification. the number of items + line="29019">the number of items a #GMenuModel + line="29015">a #GMenuModel @@ -74287,20 +75590,20 @@ reported. The signal is emitted after the modification. a new #GMenuAttributeIter + line="29076">a new #GMenuAttributeIter a #GMenuModel + line="29068">a #GMenuModel the index of the item + line="29069">the index of the item @@ -74309,29 +75612,29 @@ reported. The signal is emitted after the modification. - + the value of the attribute + line="28991">the value of the attribute a #GMenuModel + line="28973">a #GMenuModel the index of the item + line="28974">the index of the item the attribute to query + line="28975">the attribute to query allow-none="1"> the expected type of the attribute, or + line="28976">the expected type of the attribute, or %NULL @@ -74387,20 +75690,20 @@ reported. The signal is emitted after the modification. a new #GMenuLinkIter + line="29091">a new #GMenuLinkIter a #GMenuModel + line="29083">a #GMenuModel the index of the item + line="29084">the index of the item @@ -74409,29 +75712,29 @@ reported. The signal is emitted after the modification. - + the linked #GMenuModel, or %NULL + line="29008">the linked #GMenuModel, or %NULL a #GMenuModel + line="28998">a #GMenuModel the index of the item + line="28999">the index of the item the link to query + line="29000">the link to query @@ -74449,7 +75752,7 @@ reported. The signal is emitted after the modification. glib:type-struct="MountIface"> The #GMount interface represents user-visible mounts. Note, when + line="7336">The #GMount interface represents user-visible mounts. Note, when porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume. #GMount is a "mounted" filesystem that you can access. Mounted is in @@ -74472,19 +75775,19 @@ is called, then it will be filled with any error information. Checks if @mount can be ejected. + line="29193">Checks if @mount can be ejected. %TRUE if the @mount can be ejected. + line="29199">%TRUE if the @mount can be ejected. a #GMount. + line="29195">a #GMount. @@ -74492,19 +75795,19 @@ is called, then it will be filled with any error information. Checks if @mount can be unmounted. + line="29203">Checks if @mount can be unmounted. %TRUE if the @mount can be unmounted. + line="29209">%TRUE if the @mount can be unmounted. a #GMount. + line="29205">a #GMount. @@ -74526,7 +75829,7 @@ is called, then it will be filled with any error information. deprecated-version="2.22"> Ejects a mount. This is an asynchronous operation, and is + line="29213">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_eject_with_operation() instead. @@ -74538,13 +75841,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29215">a #GMount. flags affecting the unmount if required for eject + line="29216">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29217">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="29218">a #GAsyncReadyCallback, or %NULL. closure="3"> user data passed to @callback. + line="29219">user data passed to @callback. @@ -74586,27 +75889,27 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + line="29229">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_eject_with_operation_finish() instead. %TRUE if the mount was successfully ejected. %FALSE otherwise. + line="29239">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + line="29231">a #GMount. a #GAsyncResult. + line="29232">a #GAsyncResult. @@ -74616,7 +75919,7 @@ and #GAsyncResult data returned in the @callback. version="2.22"> Ejects a mount. This is an asynchronous operation, and is + line="29244">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -74627,13 +75930,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29246">a #GMount. flags affecting the unmount if required for eject + line="29247">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to avoid + line="29248">a #GMountOperation or %NULL to avoid user interaction. @@ -74652,7 +75955,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29250">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29251">a #GAsyncReadyCallback, or %NULL. closure="4"> user data passed to @callback. + line="29252">user data passed to @callback. @@ -74684,26 +75987,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + line="29262">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the mount was successfully ejected. %FALSE otherwise. + line="29272">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + line="29264">a #GMount. a #GAsyncResult. + line="29265">a #GAsyncResult. @@ -74712,14 +76015,14 @@ and #GAsyncResult data returned in the @callback. invoker="get_default_location"> Gets the default location of @mount. The default location of the given + line="29277">Gets the default location of @mount. The default location of the given @mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume). a #GFile. + line="29285">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -74728,7 +76031,7 @@ the home directory, or the root of the volume). a #GMount. + line="29279">a #GMount. @@ -74736,7 +76039,7 @@ the home directory, or the root of the volume). Gets the drive for the @mount. + line="29291">Gets the drive for the @mount. This is a convenience method for getting the #GVolume and then using that object to get the #GDrive. @@ -74744,7 +76047,7 @@ using that object to get the #GDrive. a #GDrive or %NULL if @mount is not + line="29300">a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -74754,7 +76057,7 @@ using that object to get the #GDrive. a #GMount. + line="29293">a #GMount. @@ -74762,12 +76065,12 @@ using that object to get the #GDrive. Gets the icon for @mount. + line="29307">Gets the icon for @mount. a #GIcon. + line="29313">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -74776,7 +76079,7 @@ using that object to get the #GDrive. a #GMount. + line="29309">a #GMount. @@ -74784,12 +76087,12 @@ using that object to get the #GDrive. Gets the name of @mount. + line="29319">Gets the name of @mount. the name for the given @mount. + line="29325">the name for the given @mount. The returned string should be freed with g_free() when no longer needed. @@ -74798,7 +76101,7 @@ using that object to get the #GDrive. a #GMount. + line="29321">a #GMount. @@ -74806,12 +76109,12 @@ using that object to get the #GDrive. Gets the root directory on @mount. + line="29331">Gets the root directory on @mount. a #GFile. + line="29337">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -74820,7 +76123,7 @@ using that object to get the #GDrive. a #GMount. + line="29333">a #GMount. @@ -74830,19 +76133,19 @@ using that object to get the #GDrive. version="2.32"> Gets the sort key for @mount, if any. + line="29343">Gets the sort key for @mount, if any. Sorting key for @mount or %NULL if no such key is available. + line="29349">Sorting key for @mount or %NULL if no such key is available. A #GMount. + line="29345">A #GMount. @@ -74852,12 +76155,12 @@ using that object to get the #GDrive. version="2.34"> Gets the symbolic icon for @mount. + line="29354">Gets the symbolic icon for @mount. a #GIcon. + line="29360">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -74866,7 +76169,7 @@ using that object to get the #GDrive. a #GMount. + line="29356">a #GMount. @@ -74874,7 +76177,7 @@ using that object to get the #GDrive. Gets the UUID for the @mount. The reference is typically based on + line="29367">Gets the UUID for the @mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. @@ -74882,7 +76185,7 @@ available. the UUID for @mount or %NULL if no UUID + line="29376">the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -74892,7 +76195,7 @@ available. a #GMount. + line="29369">a #GMount. @@ -74900,12 +76203,12 @@ available. Gets the volume for the @mount. + line="29383">Gets the volume for the @mount. a #GVolume or %NULL if @mount is not + line="29389">a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -74915,7 +76218,7 @@ available. a #GMount. + line="29385">a #GMount. @@ -74925,7 +76228,7 @@ available. version="2.18"> Tries to guess the type of content stored on @mount. Returns one or + line="29396">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -74944,13 +76247,13 @@ is finished by calling g_mount_guess_content_type_finish() with the a #GMount + line="29398">a #GMount Whether to force a rescan of the content. + line="29399">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -74960,7 +76263,7 @@ is finished by calling g_mount_guess_content_type_finish() with the allow-none="1"> optional #GCancellable object, %NULL to ignore + line="29401">optional #GCancellable object, %NULL to ignore a #GAsyncReadyCallback + line="29402">a #GAsyncReadyCallback user data passed to @callback + line="29403">user data passed to @callback @@ -74992,7 +76295,7 @@ is finished by calling g_mount_guess_content_type_finish() with the throws="1"> Finishes guessing content types of @mount. If any errors occurred + line="29421">Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content @@ -75001,7 +76304,7 @@ guessing. a %NULL-terminated array of content types or %NULL on error. + line="29434">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -75011,13 +76314,13 @@ guessing. a #GMount + line="29423">a #GMount a #GAsyncResult + line="29424">a #GAsyncResult @@ -75028,7 +76331,7 @@ guessing. throws="1"> Tries to guess the type of content stored on @mount. Returns one or + line="29440">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -75041,7 +76344,7 @@ see g_mount_guess_content_type() for the asynchronous version. a %NULL-terminated array of content types or %NULL on error. + line="29459">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -75051,13 +76354,13 @@ see g_mount_guess_content_type() for the asynchronous version. a #GMount + line="29442">a #GMount Whether to force a rescan of the content. + line="29443">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -75067,7 +76370,7 @@ see g_mount_guess_content_type() for the asynchronous version. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="29445">optional #GCancellable object, %NULL to ignore @@ -75086,7 +76389,7 @@ see g_mount_guess_content_type() for the asynchronous version. Remounts a mount. This is an asynchronous operation, and is + line="29700">Remounts a mount. This is an asynchronous operation, and is finished by calling g_mount_remount_finish() with the @mount and #GAsyncResults data returned in the @callback. @@ -75103,13 +76406,13 @@ unmounted. a #GMount. + line="29702">a #GMount. flags affecting the operation + line="29703">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid + line="29704">a #GMountOperation or %NULL to avoid user interaction. @@ -75128,7 +76431,7 @@ unmounted. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29706">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29707">a #GAsyncReadyCallback, or %NULL. closure="4"> user data passed to @callback. + line="29708">user data passed to @callback. @@ -75159,26 +76462,26 @@ unmounted. throws="1"> Finishes remounting a mount. If any errors occurred during the operation, + line="29722">Finishes remounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the mount was successfully remounted. %FALSE otherwise. + line="29732">%TRUE if the mount was successfully remounted. %FALSE otherwise. a #GMount. + line="29724">a #GMount. a #GAsyncResult. + line="29725">a #GAsyncResult. @@ -75189,7 +76492,7 @@ unmounted. deprecated-version="2.22"> Unmounts a mount. This is an asynchronous operation, and is + line="29749">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_unmount_with_operation() instead. @@ -75201,13 +76504,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29751">a #GMount. flags affecting the operation + line="29752">flags affecting the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29753">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="29754">a #GAsyncReadyCallback, or %NULL. closure="3"> user data passed to @callback. + line="29755">user data passed to @callback. @@ -75249,27 +76552,27 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + line="29765">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_unmount_with_operation_finish() instead. %TRUE if the mount was successfully unmounted. %FALSE otherwise. + line="29775">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + line="29767">a #GMount. a #GAsyncResult. + line="29768">a #GAsyncResult. @@ -75279,7 +76582,7 @@ and #GAsyncResult data returned in the @callback. version="2.22"> Unmounts a mount. This is an asynchronous operation, and is + line="29780">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -75290,13 +76593,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29782">a #GMount. flags affecting the operation + line="29783">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid + line="29784">a #GMountOperation or %NULL to avoid user interaction. @@ -75315,7 +76618,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29786">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29787">a #GAsyncReadyCallback, or %NULL. closure="4"> user data passed to @callback. + line="29788">user data passed to @callback. @@ -75347,26 +76650,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + line="29798">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the mount was successfully unmounted. %FALSE otherwise. + line="29808">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + line="29800">a #GMount. a #GAsyncResult. + line="29801">a #GAsyncResult. @@ -75385,19 +76688,19 @@ and #GAsyncResult data returned in the @callback. Checks if @mount can be ejected. + line="29193">Checks if @mount can be ejected. %TRUE if the @mount can be ejected. + line="29199">%TRUE if the @mount can be ejected. a #GMount. + line="29195">a #GMount. @@ -75405,19 +76708,19 @@ and #GAsyncResult data returned in the @callback. Checks if @mount can be unmounted. + line="29203">Checks if @mount can be unmounted. %TRUE if the @mount can be unmounted. + line="29209">%TRUE if the @mount can be unmounted. a #GMount. + line="29205">a #GMount. @@ -75428,7 +76731,7 @@ and #GAsyncResult data returned in the @callback. deprecated-version="2.22"> Ejects a mount. This is an asynchronous operation, and is + line="29213">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_eject_with_operation() instead. @@ -75440,13 +76743,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29215">a #GMount. flags affecting the unmount if required for eject + line="29216">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29217">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="29218">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data passed to @callback. + line="29219">user data passed to @callback. @@ -75487,27 +76790,27 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + line="29229">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_eject_with_operation_finish() instead. %TRUE if the mount was successfully ejected. %FALSE otherwise. + line="29239">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + line="29231">a #GMount. a #GAsyncResult. + line="29232">a #GAsyncResult. @@ -75517,7 +76820,7 @@ and #GAsyncResult data returned in the @callback. version="2.22"> Ejects a mount. This is an asynchronous operation, and is + line="29244">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -75528,13 +76831,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29246">a #GMount. flags affecting the unmount if required for eject + line="29247">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to avoid + line="29248">a #GMountOperation or %NULL to avoid user interaction. @@ -75553,7 +76856,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29250">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29251">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data passed to @callback. + line="29252">user data passed to @callback. @@ -75584,26 +76887,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + line="29262">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the mount was successfully ejected. %FALSE otherwise. + line="29272">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + line="29264">a #GMount. a #GAsyncResult. + line="29265">a #GAsyncResult. @@ -75612,14 +76915,14 @@ and #GAsyncResult data returned in the @callback. c:identifier="g_mount_get_default_location"> Gets the default location of @mount. The default location of the given + line="29277">Gets the default location of @mount. The default location of the given @mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume). a #GFile. + line="29285">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -75628,7 +76931,7 @@ the home directory, or the root of the volume). a #GMount. + line="29279">a #GMount. @@ -75636,7 +76939,7 @@ the home directory, or the root of the volume). Gets the drive for the @mount. + line="29291">Gets the drive for the @mount. This is a convenience method for getting the #GVolume and then using that object to get the #GDrive. @@ -75644,7 +76947,7 @@ using that object to get the #GDrive. a #GDrive or %NULL if @mount is not + line="29300">a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -75654,7 +76957,7 @@ using that object to get the #GDrive. a #GMount. + line="29293">a #GMount. @@ -75662,12 +76965,12 @@ using that object to get the #GDrive. Gets the icon for @mount. + line="29307">Gets the icon for @mount. a #GIcon. + line="29313">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -75676,7 +76979,7 @@ using that object to get the #GDrive. a #GMount. + line="29309">a #GMount. @@ -75684,12 +76987,12 @@ using that object to get the #GDrive. Gets the name of @mount. + line="29319">Gets the name of @mount. the name for the given @mount. + line="29325">the name for the given @mount. The returned string should be freed with g_free() when no longer needed. @@ -75698,7 +77001,7 @@ using that object to get the #GDrive. a #GMount. + line="29321">a #GMount. @@ -75706,12 +77009,12 @@ using that object to get the #GDrive. Gets the root directory on @mount. + line="29331">Gets the root directory on @mount. a #GFile. + line="29337">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -75720,7 +77023,7 @@ using that object to get the #GDrive. a #GMount. + line="29333">a #GMount. @@ -75730,19 +77033,19 @@ using that object to get the #GDrive. version="2.32"> Gets the sort key for @mount, if any. + line="29343">Gets the sort key for @mount, if any. Sorting key for @mount or %NULL if no such key is available. + line="29349">Sorting key for @mount or %NULL if no such key is available. A #GMount. + line="29345">A #GMount. @@ -75752,12 +77055,12 @@ using that object to get the #GDrive. version="2.34"> Gets the symbolic icon for @mount. + line="29354">Gets the symbolic icon for @mount. a #GIcon. + line="29360">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -75766,7 +77069,7 @@ using that object to get the #GDrive. a #GMount. + line="29356">a #GMount. @@ -75774,7 +77077,7 @@ using that object to get the #GDrive. Gets the UUID for the @mount. The reference is typically based on + line="29367">Gets the UUID for the @mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. @@ -75782,7 +77085,7 @@ available. the UUID for @mount or %NULL if no UUID + line="29376">the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -75792,7 +77095,7 @@ available. a #GMount. + line="29369">a #GMount. @@ -75800,12 +77103,12 @@ available. Gets the volume for the @mount. + line="29383">Gets the volume for the @mount. a #GVolume or %NULL if @mount is not + line="29389">a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -75815,7 +77118,7 @@ available. a #GMount. + line="29385">a #GMount. @@ -75825,7 +77128,7 @@ available. version="2.18"> Tries to guess the type of content stored on @mount. Returns one or + line="29396">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -75844,13 +77147,13 @@ is finished by calling g_mount_guess_content_type_finish() with the a #GMount + line="29398">a #GMount Whether to force a rescan of the content. + line="29399">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -75860,7 +77163,7 @@ is finished by calling g_mount_guess_content_type_finish() with the allow-none="1"> optional #GCancellable object, %NULL to ignore + line="29401">optional #GCancellable object, %NULL to ignore a #GAsyncReadyCallback + line="29402">a #GAsyncReadyCallback user data passed to @callback + line="29403">user data passed to @callback @@ -75891,7 +77194,7 @@ is finished by calling g_mount_guess_content_type_finish() with the throws="1"> Finishes guessing content types of @mount. If any errors occurred + line="29421">Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content @@ -75900,7 +77203,7 @@ guessing. a %NULL-terminated array of content types or %NULL on error. + line="29434">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -75910,13 +77213,13 @@ guessing. a #GMount + line="29423">a #GMount a #GAsyncResult + line="29424">a #GAsyncResult @@ -75927,7 +77230,7 @@ guessing. throws="1"> Tries to guess the type of content stored on @mount. Returns one or + line="29440">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -75940,7 +77243,7 @@ see g_mount_guess_content_type() for the asynchronous version. a %NULL-terminated array of content types or %NULL on error. + line="29459">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -75950,13 +77253,13 @@ see g_mount_guess_content_type() for the asynchronous version. a #GMount + line="29442">a #GMount Whether to force a rescan of the content. + line="29443">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -75966,7 +77269,7 @@ see g_mount_guess_content_type() for the asynchronous version. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="29445">optional #GCancellable object, %NULL to ignore @@ -75976,7 +77279,7 @@ see g_mount_guess_content_type() for the asynchronous version. version="2.20"> Determines if @mount is shadowed. Applications or libraries should + line="29465">Determines if @mount is shadowed. Applications or libraries should avoid displaying @mount in the user interface if it is shadowed. A mount is said to be shadowed if there exists one or more user @@ -76003,14 +77306,14 @@ activation root on a #GVolume is set. %TRUE if @mount is shadowed. + line="29493">%TRUE if @mount is shadowed. A #GMount. + line="29467">A #GMount. @@ -76018,7 +77321,7 @@ activation root on a #GVolume is set. Remounts a mount. This is an asynchronous operation, and is + line="29700">Remounts a mount. This is an asynchronous operation, and is finished by calling g_mount_remount_finish() with the @mount and #GAsyncResults data returned in the @callback. @@ -76035,13 +77338,13 @@ unmounted. a #GMount. + line="29702">a #GMount. flags affecting the operation + line="29703">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid + line="29704">a #GMountOperation or %NULL to avoid user interaction. @@ -76060,7 +77363,7 @@ unmounted. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29706">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29707">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data passed to @callback. + line="29708">user data passed to @callback. @@ -76090,26 +77393,26 @@ unmounted. throws="1"> Finishes remounting a mount. If any errors occurred during the operation, + line="29722">Finishes remounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the mount was successfully remounted. %FALSE otherwise. + line="29732">%TRUE if the mount was successfully remounted. %FALSE otherwise. a #GMount. + line="29724">a #GMount. a #GAsyncResult. + line="29725">a #GAsyncResult. @@ -76117,7 +77420,7 @@ unmounted. Increments the shadow count on @mount. Usually used by + line="29736">Increments the shadow count on @mount. Usually used by #GVolumeMonitor implementations when creating a shadow mount for @mount, see g_mount_is_shadowed() for more information. The caller will need to emit the #GMount::changed signal on @mount manually. @@ -76129,7 +77432,7 @@ will need to emit the #GMount::changed signal on @mount manually. A #GMount. + line="29738">A #GMount. @@ -76140,7 +77443,7 @@ will need to emit the #GMount::changed signal on @mount manually. deprecated-version="2.22"> Unmounts a mount. This is an asynchronous operation, and is + line="29749">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_unmount_with_operation() instead. @@ -76152,13 +77455,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29751">a #GMount. flags affecting the operation + line="29752">flags affecting the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29753">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback, or %NULL. + line="29754">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data passed to @callback. + line="29755">user data passed to @callback. @@ -76199,27 +77502,27 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + line="29765">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_unmount_with_operation_finish() instead. %TRUE if the mount was successfully unmounted. %FALSE otherwise. + line="29775">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + line="29767">a #GMount. a #GAsyncResult. + line="29768">a #GAsyncResult. @@ -76229,7 +77532,7 @@ and #GAsyncResult data returned in the @callback. version="2.22"> Unmounts a mount. This is an asynchronous operation, and is + line="29780">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -76240,13 +77543,13 @@ and #GAsyncResult data returned in the @callback. a #GMount. + line="29782">a #GMount. flags affecting the operation + line="29783">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid + line="29784">a #GMountOperation or %NULL to avoid user interaction. @@ -76265,7 +77568,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29786">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29787">a #GAsyncReadyCallback, or %NULL. allow-none="1"> user data passed to @callback. + line="29788">user data passed to @callback. @@ -76296,26 +77599,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + line="29798">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the mount was successfully unmounted. %FALSE otherwise. + line="29808">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + line="29800">a #GMount. a #GAsyncResult. + line="29801">a #GAsyncResult. @@ -76323,7 +77626,7 @@ and #GAsyncResult data returned in the @callback. Decrements the shadow count on @mount. Usually used by + line="29813">Decrements the shadow count on @mount. Usually used by #GVolumeMonitor implementations when destroying a shadow mount for @mount, see g_mount_is_shadowed() for more information. The caller will need to emit the #GMount::changed signal on @mount manually. @@ -76335,7 +77638,7 @@ will need to emit the #GMount::changed signal on @mount manually. A #GMount. + line="29815">A #GMount. @@ -76343,7 +77646,7 @@ will need to emit the #GMount::changed signal on @mount manually. Emitted when the mount has been changed. + line="2300">Emitted when the mount has been changed. @@ -76351,7 +77654,7 @@ will need to emit the #GMount::changed signal on @mount manually. This signal may be emitted when the #GMount is about to be + line="2308">This signal may be emitted when the #GMount is about to be unmounted. This signal depends on the backend and is only emitted if @@ -76363,7 +77666,7 @@ GIO was used to unmount. This signal is emitted when the #GMount have been + line="2322">This signal is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -76417,7 +77720,7 @@ finalized. a #GFile. + line="29337">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -76426,7 +77729,7 @@ finalized. a #GMount. + line="29333">a #GMount. @@ -76438,7 +77741,7 @@ finalized. the name for the given @mount. + line="29325">the name for the given @mount. The returned string should be freed with g_free() when no longer needed. @@ -76447,7 +77750,7 @@ finalized. a #GMount. + line="29321">a #GMount. @@ -76459,7 +77762,7 @@ finalized. a #GIcon. + line="29313">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -76468,7 +77771,7 @@ finalized. a #GMount. + line="29309">a #GMount. @@ -76480,7 +77783,7 @@ finalized. the UUID for @mount or %NULL if no UUID + line="29376">the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -76490,7 +77793,7 @@ finalized. a #GMount. + line="29369">a #GMount. @@ -76502,7 +77805,7 @@ finalized. a #GVolume or %NULL if @mount is not + line="29389">a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -76512,7 +77815,7 @@ finalized. a #GMount. + line="29385">a #GMount. @@ -76524,7 +77827,7 @@ finalized. a #GDrive or %NULL if @mount is not + line="29300">a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -76534,7 +77837,7 @@ finalized. a #GMount. + line="29293">a #GMount. @@ -76546,14 +77849,14 @@ finalized. %TRUE if the @mount can be unmounted. + line="29209">%TRUE if the @mount can be unmounted. a #GMount. + line="29205">a #GMount. @@ -76565,14 +77868,14 @@ finalized. %TRUE if the @mount can be ejected. + line="29199">%TRUE if the @mount can be ejected. a #GMount. + line="29195">a #GMount. @@ -76588,13 +77891,13 @@ finalized. a #GMount. + line="29751">a #GMount. flags affecting the operation + line="29752">flags affecting the operation allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29753">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29754">a #GAsyncReadyCallback, or %NULL. closure="4"> user data passed to @callback. + line="29755">user data passed to @callback. @@ -76636,20 +77939,20 @@ finalized. %TRUE if the mount was successfully unmounted. %FALSE otherwise. + line="29775">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + line="29767">a #GMount. a #GAsyncResult. + line="29768">a #GAsyncResult. @@ -76665,13 +77968,13 @@ finalized. a #GMount. + line="29215">a #GMount. flags affecting the unmount if required for eject + line="29216">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29217">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback, or %NULL. + line="29218">a #GAsyncReadyCallback, or %NULL. closure="4"> user data passed to @callback. + line="29219">user data passed to @callback. @@ -76713,20 +78016,20 @@ finalized. %TRUE if the mount was successfully ejected. %FALSE otherwise. + line="29239">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + line="29231">a #GMount. a #GAsyncResult. + line="29232">a #GAsyncResult. @@ -76742,13 +78045,13 @@ finalized. a #GMount. + line="29702">a #GMount. flags affecting the operation + line="29703">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid + line="29704">a #GMountOperation or %NULL to avoid user interaction. @@ -76767,7 +78070,7 @@ finalized. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29706">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback, or %NULL. + line="29707">a #GAsyncReadyCallback, or %NULL. closure="5"> user data passed to @callback. + line="29708">user data passed to @callback. @@ -76800,20 +78103,20 @@ finalized. %TRUE if the mount was successfully remounted. %FALSE otherwise. + line="29732">%TRUE if the mount was successfully remounted. %FALSE otherwise. a #GMount. + line="29724">a #GMount. a #GAsyncResult. + line="29725">a #GAsyncResult. @@ -76829,13 +78132,13 @@ finalized. a #GMount + line="29398">a #GMount Whether to force a rescan of the content. + line="29399">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -76845,7 +78148,7 @@ finalized. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="29401">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback + line="29402">a #GAsyncReadyCallback closure="4"> user data passed to @callback + line="29403">user data passed to @callback @@ -76878,7 +78181,7 @@ finalized. a %NULL-terminated array of content types or %NULL on error. + line="29434">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -76888,13 +78191,13 @@ finalized. a #GMount + line="29423">a #GMount a #GAsyncResult + line="29424">a #GAsyncResult @@ -76906,7 +78209,7 @@ finalized. a %NULL-terminated array of content types or %NULL on error. + line="29459">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -76916,13 +78219,13 @@ finalized. a #GMount + line="29442">a #GMount Whether to force a rescan of the content. + line="29443">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -76932,7 +78235,7 @@ finalized. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="29445">optional #GCancellable object, %NULL to ignore @@ -76961,13 +78264,13 @@ finalized. a #GMount. + line="29782">a #GMount. flags affecting the operation + line="29783">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid + line="29784">a #GMountOperation or %NULL to avoid user interaction. @@ -76986,7 +78289,7 @@ finalized. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29786">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback, or %NULL. + line="29787">a #GAsyncReadyCallback, or %NULL. closure="5"> user data passed to @callback. + line="29788">user data passed to @callback. @@ -77019,20 +78322,20 @@ finalized. %TRUE if the mount was successfully unmounted. %FALSE otherwise. + line="29808">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + line="29800">a #GMount. a #GAsyncResult. + line="29801">a #GAsyncResult. @@ -77048,13 +78351,13 @@ finalized. a #GMount. + line="29246">a #GMount. flags affecting the unmount if required for eject + line="29247">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to avoid + line="29248">a #GMountOperation or %NULL to avoid user interaction. @@ -77073,7 +78376,7 @@ finalized. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="29250">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback, or %NULL. + line="29251">a #GAsyncReadyCallback, or %NULL. closure="5"> user data passed to @callback. + line="29252">user data passed to @callback. @@ -77106,20 +78409,20 @@ finalized. %TRUE if the mount was successfully ejected. %FALSE otherwise. + line="29272">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + line="29264">a #GMount. a #GAsyncResult. + line="29265">a #GAsyncResult. @@ -77131,7 +78434,7 @@ finalized. a #GFile. + line="29285">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -77140,7 +78443,7 @@ finalized. a #GMount. + line="29279">a #GMount. @@ -77152,14 +78455,14 @@ finalized. Sorting key for @mount or %NULL if no such key is available. + line="29349">Sorting key for @mount or %NULL if no such key is available. A #GMount. + line="29345">A #GMount. @@ -77171,7 +78474,7 @@ finalized. a #GIcon. + line="29360">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -77180,7 +78483,7 @@ finalized. a #GMount. + line="29356">a #GMount. @@ -77197,7 +78500,8 @@ finalized. + glib:nick="none" + glib:name="G_MOUNT_MOUNT_NONE"> No flags set. @@ -77212,7 +78516,7 @@ finalized. glib:type-struct="MountOperationClass"> #GMountOperation provides a mechanism for interacting with the user. + line="7364">#GMountOperation provides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. It can also be used to ask the user questions or show a list of applications @@ -77237,12 +78541,12 @@ improvements and auditing fixes. Creates a new mount operation. + line="29595">Creates a new mount operation. a #GMountOperation. + line="29600">a #GMountOperation. @@ -77315,7 +78619,7 @@ improvements and auditing fixes. Emits the #GMountOperation::reply signal. + line="29604">Emits the #GMountOperation::reply signal. @@ -77324,13 +78628,13 @@ improvements and auditing fixes. a #GMountOperation + line="29606">a #GMountOperation a #GMountOperationResult + line="29607">a #GMountOperationResult @@ -77397,36 +78701,39 @@ improvements and auditing fixes. + c:identifier="g_mount_operation_get_anonymous" + glib:get-property="anonymous"> Check to see whether the mount operation is being used + line="29498">Check to see whether the mount operation is being used for an anonymous user. %TRUE if mount operation is anonymous. + line="29505">%TRUE if mount operation is anonymous. a #GMountOperation. + line="29500">a #GMountOperation. - + Gets a choice from the mount operation. + line="29509">Gets a choice from the mount operation. an integer containing an index of the user's choice from + line="29515">an integer containing an index of the user's choice from the choice's list, or `0`. @@ -77434,158 +78741,166 @@ the choice's list, or `0`. a #GMountOperation. + line="29511">a #GMountOperation. - + Gets the domain of the mount operation. + line="29520">Gets the domain of the mount operation. - + a string set to the domain. + line="29526">a string set to the domain. a #GMountOperation. + line="29522">a #GMountOperation. Check to see whether the mount operation is being used + line="29530">Check to see whether the mount operation is being used for a TCRYPT hidden volume. %TRUE if mount operation is for hidden volume. + line="29537">%TRUE if mount operation is for hidden volume. a #GMountOperation. + line="29532">a #GMountOperation. Check to see whether the mount operation is being used + line="29542">Check to see whether the mount operation is being used for a TCRYPT system volume. %TRUE if mount operation is for system volume. + line="29549">%TRUE if mount operation is for system volume. a #GMountOperation. + line="29544">a #GMountOperation. + c:identifier="g_mount_operation_get_password" + glib:get-property="password"> Gets a password from the mount operation. + line="29554">Gets a password from the mount operation. - + a string containing the password within @op. + line="29560">a string containing the password within @op. a #GMountOperation. + line="29556">a #GMountOperation. + c:identifier="g_mount_operation_get_password_save" + glib:get-property="password-save"> Gets the state of saving passwords for the mount operation. + line="29564">Gets the state of saving passwords for the mount operation. a #GPasswordSave flag. + line="29570">a #GPasswordSave flag. a #GMountOperation. + line="29566">a #GMountOperation. Gets a PIM from the mount operation. + line="29574">Gets a PIM from the mount operation. The VeraCrypt PIM within @op. + line="29580">The VeraCrypt PIM within @op. a #GMountOperation. + line="29576">a #GMountOperation. + c:identifier="g_mount_operation_get_username" + glib:get-property="username"> Get the user name from the mount operation. + line="29585">Get the user name from the mount operation. - + a string containing the user name. + line="29591">a string containing the user name. a #GMountOperation. + line="29587">a #GMountOperation. @@ -77593,7 +78908,7 @@ for a TCRYPT system volume. Emits the #GMountOperation::reply signal. + line="29604">Emits the #GMountOperation::reply signal. @@ -77602,22 +78917,23 @@ for a TCRYPT system volume. a #GMountOperation + line="29606">a #GMountOperation a #GMountOperationResult + line="29607">a #GMountOperationResult + c:identifier="g_mount_operation_set_anonymous" + glib:set-property="anonymous"> Sets the mount operation to use an anonymous user if @anonymous is %TRUE. + line="29613">Sets the mount operation to use an anonymous user if @anonymous is %TRUE. @@ -77626,21 +78942,23 @@ for a TCRYPT system volume. a #GMountOperation. + line="29615">a #GMountOperation. boolean value. + line="29616">boolean value. - + Sets a default choice for the mount operation. + line="29622">Sets a default choice for the mount operation. @@ -77649,21 +78967,23 @@ for a TCRYPT system volume. a #GMountOperation. + line="29624">a #GMountOperation. an integer. + line="29625">an integer. - + Sets the mount operation's domain. + line="29631">Sets the mount operation's domain. @@ -77672,23 +78992,27 @@ for a TCRYPT system volume. a #GMountOperation. + line="29633">a #GMountOperation. - + the domain to set. + line="29634">the domain to set. Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE. + line="29640">Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE. @@ -77697,23 +79021,24 @@ for a TCRYPT system volume. a #GMountOperation. + line="29642">a #GMountOperation. boolean value. + line="29643">boolean value. Sets the mount operation to use a system volume if @system_volume is %TRUE. + line="29651">Sets the mount operation to use a system volume if @system_volume is %TRUE. @@ -77722,22 +79047,23 @@ for a TCRYPT system volume. a #GMountOperation. + line="29653">a #GMountOperation. boolean value. + line="29654">boolean value. + c:identifier="g_mount_operation_set_password" + glib:set-property="password"> Sets the mount operation's password to @password. + line="29662">Sets the mount operation's password to @password. @@ -77746,22 +79072,26 @@ for a TCRYPT system volume. a #GMountOperation. + line="29664">a #GMountOperation. - + password to set. + line="29665">password to set. + c:identifier="g_mount_operation_set_password_save" + glib:set-property="password-save"> Sets the state of saving passwords for the mount operation. + line="29671">Sets the state of saving passwords for the mount operation. @@ -77770,23 +79100,24 @@ for a TCRYPT system volume. a #GMountOperation. + line="29673">a #GMountOperation. a set of #GPasswordSave flags. + line="29674">a set of #GPasswordSave flags. Sets the mount operation's PIM to @pim. + line="29680">Sets the mount operation's PIM to @pim. @@ -77795,22 +79126,23 @@ for a TCRYPT system volume. a #GMountOperation. + line="29682">a #GMountOperation. an unsigned integer. + line="29683">an unsigned integer. + c:identifier="g_mount_operation_set_username" + glib:set-property="username"> Sets the user name within @op to @username. + line="29691">Sets the user name within @op to @username. @@ -77819,86 +79151,119 @@ for a TCRYPT system volume. a #GMountOperation. + line="29693">a #GMountOperation. - + input username. + line="29694">input username. - + Whether to use an anonymous user when authenticating. + line="2442">Whether to use an anonymous user when authenticating. - + The index of the user's choice when a question is asked during the + line="2449">The index of the user's choice when a question is asked during the mount operation. See the #GMountOperation::ask-question signal. - + The domain to use for the mount operation. + line="2457">The domain to use for the mount operation. + transfer-ownership="none" + setter="set_is_tcrypt_hidden_volume" + getter="get_is_tcrypt_hidden_volume"> Whether the device to be unlocked is a TCRYPT hidden volume. + line="2464">Whether the device to be unlocked is a TCRYPT hidden volume. See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Hidden%20Volume.html). + transfer-ownership="none" + setter="set_is_tcrypt_system_volume" + getter="get_is_tcrypt_system_volume"> Whether the device to be unlocked is a TCRYPT system volume. + line="2474">Whether the device to be unlocked is a TCRYPT system volume. In this context, a system volume is a volume with a bootloader and operating system installed. This is only supported for Windows operating systems. For further documentation, see [the VeraCrypt documentation](https://www.veracrypt.fr/en/System%20Encryption.html). - + The password that is used for authentication when carrying out + line="2487">The password that is used for authentication when carrying out the mount operation. - + Determines if and how the password information should be saved. + line="2495">Determines if and how the password information should be saved. + transfer-ownership="none" + setter="set_pim" + getter="get_pim"> The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See + line="2502">The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Personal%20Iterations%20Multiplier%20(PIM).html). - + The user name that is used for authentication when carrying out + line="2512">The user name that is used for authentication when carrying out the mount operation. @@ -77911,7 +79276,7 @@ the mount operation. Emitted by the backend when e.g. a device becomes unavailable + line="2333">Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress. Implementations of GMountOperation should handle this signal @@ -77923,7 +79288,7 @@ by dismissing open password dialogs. Emitted when a mount operation asks the user for a password. + line="2346">Emitted when a mount operation asks the user for a password. If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the @@ -77935,25 +79300,25 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user. + line="2349">string containing a message to display to the user. string containing the default user name. + line="2350">string containing the default user name. string containing the default domain. + line="2351">string containing the default domain. a set of #GAskPasswordFlags. + line="2352">a set of #GAskPasswordFlags. @@ -77961,7 +79326,7 @@ primary text in a #GtkMessageDialog. Emitted when asking the user a question and gives a list of + line="2362">Emitted when asking the user a question and gives a list of choices for the user to choose from. If the message contains a line break, the first line should be @@ -77974,13 +79339,13 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user. + line="2365">string containing a message to display to the user. an array of strings for each possible choice. + line="2366">an array of strings for each possible choice. @@ -77990,7 +79355,7 @@ primary text in a #GtkMessageDialog. Emitted when the user has replied to the mount operation. + line="2377">Emitted when the user has replied to the mount operation. @@ -77998,7 +79363,7 @@ primary text in a #GtkMessageDialog. a #GMountOperationResult indicating how the request was handled + line="2380">a #GMountOperationResult indicating how the request was handled @@ -78006,7 +79371,7 @@ primary text in a #GtkMessageDialog. Emitted when one or more processes are blocking an operation + line="2386">Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a #GMount or stopping a #GDrive. Note that this signal may be emitted several times to update the @@ -78025,13 +79390,13 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user. + line="2389">string containing a message to display to the user. an array of #GPid for processes + line="2390">an array of #GPid for processes blocking the operation. @@ -78040,7 +79405,7 @@ primary text in a #GtkMessageDialog. an array of strings for each possible choice. + line="2392">an array of strings for each possible choice. @@ -78050,7 +79415,7 @@ primary text in a #GtkMessageDialog. Emitted when an unmount operation has been busy for more than some time + line="2411">Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds). When unmounting or ejecting a volume, the kernel might need to flush @@ -78073,20 +79438,20 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user + line="2414">string containing a message to display to the user the estimated time left before the operation completes, + line="2415">the estimated time left before the operation completes, in microseconds, or -1 the amount of bytes to be written before the operation + line="2417">the amount of bytes to be written before the operation completes (or -1 if such amount is not known), or zero if the operation is completed @@ -78167,13 +79532,13 @@ primary text in a #GtkMessageDialog. a #GMountOperation + line="29606">a #GMountOperation a #GMountOperationResult + line="29607">a #GMountOperationResult @@ -78344,7 +79709,8 @@ information is send by the mounting operation. + glib:nick="handled" + glib:name="G_MOUNT_OPERATION_HANDLED"> The request was fulfilled and the @@ -78353,7 +79719,8 @@ information is send by the mounting operation. + glib:nick="aborted" + glib:name="G_MOUNT_OPERATION_ABORTED"> The user requested the mount operation @@ -78362,7 +79729,8 @@ information is send by the mounting operation. + glib:nick="unhandled" + glib:name="G_MOUNT_OPERATION_UNHANDLED"> The request was unhandled (i.e. not @@ -78379,7 +79747,8 @@ information is send by the mounting operation. + glib:nick="none" + glib:name="G_MOUNT_UNMOUNT_NONE"> No flags set. @@ -78387,7 +79756,8 @@ information is send by the mounting operation. + glib:nick="force" + glib:name="G_MOUNT_UNMOUNT_FORCE"> Unmount even if there are outstanding @@ -78546,7 +79916,7 @@ See [Extending GIO][extending-gio]. glib:type-struct="NativeSocketAddressClass"> A socket address of some unknown native type. + line="7393">A socket address of some unknown native type. version="2.46"> Creates a new #GNativeSocketAddress for @native and @len. + line="29826">Creates a new #GNativeSocketAddress for @native and @len. a new #GNativeSocketAddress + line="29833">a new #GNativeSocketAddress @@ -78569,13 +79939,13 @@ See [Extending GIO][extending-gio]. allow-none="1"> a native address object + line="29828">a native address object the length of @native, in bytes + line="29829">the length of @native, in bytes @@ -78647,7 +80017,7 @@ See [Extending GIO][extending-gio]. glib:type-struct="NetworkAddressClass"> #GNetworkAddress provides an easy way to resolve a hostname and + line="7402">#GNetworkAddress provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families. @@ -78664,7 +80034,7 @@ interface. version="2.22"> Creates a new #GSocketConnectable for connecting to the given + line="29872">Creates a new #GSocketConnectable for connecting to the given @hostname and @port. Note that depending on the configuration of the machine, a @@ -78676,20 +80046,20 @@ is guaranteed to resolve to both addresses. the new #GNetworkAddress + line="29886">the new #GNetworkAddress the hostname + line="29874">the hostname the port + line="29875">the port @@ -78699,7 +80069,7 @@ is guaranteed to resolve to both addresses. version="2.44"> Creates a new #GSocketConnectable for connecting to the local host + line="29891">Creates a new #GSocketConnectable for connecting to the local host over a loopback connection to the given @port. This is intended for use in connecting to local services which may be running on IPv4 or IPv6. @@ -78715,14 +80085,14 @@ a #GNetworkAddress created with this constructor. the new #GNetworkAddress + line="29908">the new #GNetworkAddress the port + line="29893">the port @@ -78733,7 +80103,7 @@ a #GNetworkAddress created with this constructor. throws="1"> Creates a new #GSocketConnectable for connecting to the given + line="29913">Creates a new #GSocketConnectable for connecting to the given @hostname and @port. May fail and return %NULL in case parsing @host_and_port fails. @@ -78758,7 +80128,7 @@ which is generally quite sparse on platforms other than Linux.) the new + line="29941">the new #GNetworkAddress, or %NULL on error @@ -78766,13 +80136,13 @@ which is generally quite sparse on platforms other than Linux.) the hostname and optionally a port + line="29915">the hostname and optionally a port the default port if not in @host_and_port + line="29916">the default port if not in @host_and_port @@ -78783,7 +80153,7 @@ which is generally quite sparse on platforms other than Linux.) throws="1"> Creates a new #GSocketConnectable for connecting to the given + line="29947">Creates a new #GSocketConnectable for connecting to the given @uri. May fail and return %NULL in case parsing @uri fails. Using this rather than g_network_address_new() or @@ -78793,7 +80163,7 @@ when to use application-specific proxy protocols. the new + line="29960">the new #GNetworkAddress, or %NULL on error @@ -78801,80 +80171,83 @@ when to use application-specific proxy protocols. the hostname and optionally a port + line="29949">the hostname and optionally a port The default port if none is found in the URI + line="29950">The default port if none is found in the URI Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, + line="29838">Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, depending on what @addr was created with. @addr's hostname + line="29845">@addr's hostname a #GNetworkAddress + line="29840">a #GNetworkAddress Gets @addr's port number + line="29850">Gets @addr's port number @addr's port (which may be 0) + line="29856">@addr's port (which may be 0) a #GNetworkAddress + line="29852">a #GNetworkAddress Gets @addr's scheme + line="29861">Gets @addr's scheme - + @addr's scheme (%NULL if not built from URI) + line="29867">@addr's scheme (%NULL if not built from URI) a #GNetworkAddress + line="29863">a #GNetworkAddress @@ -78882,19 +80255,22 @@ depending on what @addr was created with. + transfer-ownership="none" + getter="get_hostname"> + transfer-ownership="none" + getter="get_port"> + transfer-ownership="none" + getter="get_scheme"> @@ -78924,43 +80300,47 @@ depending on what @addr was created with. c:type="GNetworkConnectivity"> The host's network connectivity state, as reported by #GNetworkMonitor. + line="2027">The host's network connectivity state, as reported by #GNetworkMonitor. + glib:nick="local" + glib:name="G_NETWORK_CONNECTIVITY_LOCAL"> The host is not configured with a + line="2029">The host is not configured with a route to the Internet; it may or may not be connected to a local network. + glib:nick="limited" + glib:name="G_NETWORK_CONNECTIVITY_LIMITED"> The host is connected to a network, but + line="2032">The host is connected to a network, but does not appear to be able to reach the full Internet, perhaps due to upstream network problems. + glib:nick="portal" + glib:name="G_NETWORK_CONNECTIVITY_PORTAL"> The host is behind a captive portal and + line="2035">The host is behind a captive portal and cannot reach the full Internet. + glib:nick="full" + glib:name="G_NETWORK_CONNECTIVITY_FULL"> The host is connected to a network, and + line="2037">The host is connected to a network, and appears to be able to reach the full Internet. @@ -78973,7 +80353,7 @@ depending on what @addr was created with. glib:type-struct="NetworkMonitorInterface"> #GNetworkMonitor provides an easy-to-use cross-platform API + line="7446">#GNetworkMonitor provides an easy-to-use cross-platform API for monitoring network connectivity. On Linux, the available implementations are based on the kernel's netlink interface and on NetworkManager. @@ -78986,12 +80366,13 @@ There is also an implementation for use inside Flatpak sandboxes. version="2.32"> Gets the default #GNetworkMonitor for the system. + line="30092">Gets the default #GNetworkMonitor for the system. a #GNetworkMonitor + line="30097">a #GNetworkMonitor, which will be + a dummy object if no network monitor is available @@ -79001,7 +80382,7 @@ There is also an implementation for use inside Flatpak sandboxes. throws="1"> Attempts to determine whether or not the host pointed to by + line="29999">Attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -79022,20 +80403,20 @@ want to block, you should use g_network_monitor_can_reach_async(). %TRUE if @connectable is reachable, %FALSE if not. + line="30024">%TRUE if @connectable is reachable, %FALSE if not. a #GNetworkMonitor + line="30001">a #GNetworkMonitor a #GSocketConnectable + line="30002">a #GSocketConnectable allow-none="1"> a #GCancellable, or %NULL + line="30003">a #GCancellable, or %NULL @@ -79052,7 +80433,7 @@ want to block, you should use g_network_monitor_can_reach_async(). Asynchronously attempts to determine whether or not the host + line="30029">Asynchronously attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -79069,13 +80450,13 @@ to get the result of the operation. a #GNetworkMonitor + line="30031">a #GNetworkMonitor a #GSocketConnectable + line="30032">a #GSocketConnectable allow-none="1"> a #GCancellable, or %NULL + line="30033">a #GCancellable, or %NULL closure="3"> a #GAsyncReadyCallback to call when the + line="30034">a #GAsyncReadyCallback to call when the request is satisfied @@ -79106,7 +80487,7 @@ to get the result of the operation. closure="3"> the data to pass to callback function + line="30036">the data to pass to callback function @@ -79116,26 +80497,26 @@ to get the result of the operation. throws="1"> Finishes an async network connectivity test. + line="30050">Finishes an async network connectivity test. See g_network_monitor_can_reach_async(). %TRUE if network is reachable, %FALSE if not. + line="30059">%TRUE if network is reachable, %FALSE if not. a #GNetworkMonitor + line="30052">a #GNetworkMonitor a #GAsyncResult + line="30053">a #GAsyncResult @@ -79160,7 +80541,7 @@ See g_network_monitor_can_reach_async(). throws="1"> Attempts to determine whether or not the host pointed to by + line="29999">Attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -79181,20 +80562,20 @@ want to block, you should use g_network_monitor_can_reach_async(). %TRUE if @connectable is reachable, %FALSE if not. + line="30024">%TRUE if @connectable is reachable, %FALSE if not. a #GNetworkMonitor + line="30001">a #GNetworkMonitor a #GSocketConnectable + line="30002">a #GSocketConnectable allow-none="1"> a #GCancellable, or %NULL + line="30003">a #GCancellable, or %NULL @@ -79212,7 +80593,7 @@ want to block, you should use g_network_monitor_can_reach_async(). c:identifier="g_network_monitor_can_reach_async"> Asynchronously attempts to determine whether or not the host + line="30029">Asynchronously attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -79229,13 +80610,13 @@ to get the result of the operation. a #GNetworkMonitor + line="30031">a #GNetworkMonitor a #GSocketConnectable + line="30032">a #GSocketConnectable allow-none="1"> a #GCancellable, or %NULL + line="30033">a #GCancellable, or %NULL closure="3"> a #GAsyncReadyCallback to call when the + line="30034">a #GAsyncReadyCallback to call when the request is satisfied @@ -79265,7 +80646,7 @@ to get the result of the operation. allow-none="1"> the data to pass to callback function + line="30036">the data to pass to callback function @@ -79275,36 +80656,37 @@ to get the result of the operation. throws="1"> Finishes an async network connectivity test. + line="30050">Finishes an async network connectivity test. See g_network_monitor_can_reach_async(). %TRUE if network is reachable, %FALSE if not. + line="30059">%TRUE if network is reachable, %FALSE if not. a #GNetworkMonitor + line="30052">a #GNetworkMonitor a #GAsyncResult + line="30053">a #GAsyncResult Gets a more detailed networking state than + line="30063">Gets a more detailed networking state than g_network_monitor_get_network_available(). If #GNetworkMonitor:network-available is %FALSE, then the @@ -79327,24 +80709,25 @@ back to their "offline" behavior if the connection attempt fails. the network connectivity state + line="30087">the network connectivity state the #GNetworkMonitor + line="30065">the #GNetworkMonitor Checks if the network is available. "Available" here means that the + line="30103">Checks if the network is available. "Available" here means that the system has a default route available for at least one of IPv4 or IPv6. It does not necessarily imply that the public Internet is reachable. See #GNetworkMonitor:network-available for more details. @@ -79352,55 +80735,60 @@ reachable. See #GNetworkMonitor:network-available for more details. whether the network is available + line="30112">whether the network is available the #GNetworkMonitor + line="30105">the #GNetworkMonitor Checks if the network is metered. + line="30117">Checks if the network is metered. See #GNetworkMonitor:network-metered for more details. whether the connection is metered + line="30124">whether the connection is metered the #GNetworkMonitor + line="30119">the #GNetworkMonitor - + More detailed information about the host's network connectivity. + line="2557">More detailed information about the host's network connectivity. See g_network_monitor_get_connectivity() and #GNetworkConnectivity for more details. + transfer-ownership="none" + getter="get_network_available"> Whether the network is considered available. That is, whether the + line="2568">Whether the network is considered available. That is, whether the system has a default route for at least one of IPv4 or IPv6. Real-world networks are of course much more complicated than @@ -79421,10 +80809,11 @@ See also #GNetworkMonitor::network-changed. + transfer-ownership="none" + getter="get_network_metered"> Whether the network is considered metered. That is, whether the + line="2593">Whether the network is considered metered. That is, whether the system has traffic flowing through the default connection that is subject to limitations set by service providers. For example, traffic might be billed by the amount of data transmitted, or there might be a @@ -79446,7 +80835,7 @@ See also #GNetworkMonitor:network-available. Emitted when the network configuration changes. + line="2546">Emitted when the network configuration changes. @@ -79454,7 +80843,7 @@ See also #GNetworkMonitor:network-available. the current value of #GNetworkMonitor:network-available + line="2549">the current value of #GNetworkMonitor:network-available @@ -79466,12 +80855,12 @@ See also #GNetworkMonitor:network-available. version="2.32"> The virtual function table for #GNetworkMonitor. + line="2618">The virtual function table for #GNetworkMonitor. The parent interface. + line="2620">The parent interface. @@ -79496,20 +80885,20 @@ See also #GNetworkMonitor:network-available. %TRUE if @connectable is reachable, %FALSE if not. + line="30024">%TRUE if @connectable is reachable, %FALSE if not. a #GNetworkMonitor + line="30001">a #GNetworkMonitor a #GSocketConnectable + line="30002">a #GSocketConnectable allow-none="1"> a #GCancellable, or %NULL + line="30003">a #GCancellable, or %NULL @@ -79534,13 +80923,13 @@ See also #GNetworkMonitor:network-available. a #GNetworkMonitor + line="30031">a #GNetworkMonitor a #GSocketConnectable + line="30032">a #GSocketConnectable allow-none="1"> a #GCancellable, or %NULL + line="30033">a #GCancellable, or %NULL closure="4"> a #GAsyncReadyCallback to call when the + line="30034">a #GAsyncReadyCallback to call when the request is satisfied @@ -79571,7 +80960,7 @@ See also #GNetworkMonitor:network-available. closure="4"> the data to pass to callback function + line="30036">the data to pass to callback function @@ -79583,20 +80972,20 @@ See also #GNetworkMonitor:network-available. %TRUE if network is reachable, %FALSE if not. + line="30059">%TRUE if network is reachable, %FALSE if not. a #GNetworkMonitor + line="30052">a #GNetworkMonitor a #GAsyncResult + line="30053">a #GAsyncResult @@ -79612,7 +81001,7 @@ See also #GNetworkMonitor:network-available. glib:type-struct="NetworkServiceClass"> Like #GNetworkAddress does with hostnames, #GNetworkService + line="7461">Like #GNetworkAddress does with hostnames, #GNetworkService provides an easy way to resolve a SRV record, and then attempt to connect to one of the hosts that implements that service, handling service priority/weighting, multiple IP addresses, and multiple @@ -79628,133 +81017,138 @@ interface. version="2.22"> Creates a new #GNetworkService representing the given @service, + line="30175">Creates a new #GNetworkService representing the given @service, @protocol, and @domain. This will initially be unresolved; use the #GSocketConnectable interface to resolve it. a new #GNetworkService + line="30185">a new #GNetworkService the service type to look up (eg, "ldap") + line="30177">the service type to look up (eg, "ldap") the networking protocol to use for @service (eg, "tcp") + line="30178">the networking protocol to use for @service (eg, "tcp") the DNS domain to look up the service in + line="30179">the DNS domain to look up the service in Gets the domain that @srv serves. This might be either UTF-8 or + line="30129">Gets the domain that @srv serves. This might be either UTF-8 or ASCII-encoded, depending on what @srv was created with. @srv's domain name + line="30136">@srv's domain name a #GNetworkService + line="30131">a #GNetworkService Gets @srv's protocol name (eg, "tcp"). + line="30141">Gets @srv's protocol name (eg, "tcp"). @srv's protocol name + line="30147">@srv's protocol name a #GNetworkService + line="30143">a #GNetworkService Gets the URI scheme used to resolve proxies. By default, the service name + line="30152">Gets the URI scheme used to resolve proxies. By default, the service name is used as scheme. @srv's scheme name + line="30159">@srv's scheme name a #GNetworkService + line="30154">a #GNetworkService Gets @srv's service name (eg, "ldap"). + line="30164">Gets @srv's service name (eg, "ldap"). @srv's service name + line="30170">@srv's service name a #GNetworkService + line="30166">a #GNetworkService Set's the URI scheme used to resolve proxies. By default, the service name + line="30190">Set's the URI scheme used to resolve proxies. By default, the service name is used as scheme. @@ -79764,13 +81158,13 @@ is used as scheme. a #GNetworkService + line="30192">a #GNetworkService a URI scheme + line="30193">a URI scheme @@ -79778,22 +81172,29 @@ is used as scheme. + transfer-ownership="none" + getter="get_domain"> + transfer-ownership="none" + getter="get_protocol"> - + + transfer-ownership="none" + getter="get_service"> @@ -79825,7 +81226,7 @@ is used as scheme. glib:get-type="g_notification_get_type"> #GNotification is a mechanism for creating a notification to be shown + line="7478">#GNotification is a mechanism for creating a notification to be shown to the user -- typically as a pop-up notification presented by the desktop environment shell. @@ -79838,6 +81239,29 @@ Since the user may click on a notification while the application is not running, applications using #GNotification should be able to be started as a D-Bus service, using #GApplication. +In order for #GNotification to work, the application must have installed +a `.desktop` file. For example: +|[ + [Desktop Entry] + Name=Test Application + Comment=Description of what Test Application does + Exec=gnome-test-application + Icon=org.gnome.TestApplication + Terminal=false + Type=Application + Categories=GNOME;GTK;TestApplication Category; + StartupNotify=true + DBusActivatable=true + X-GNOME-UsesNotifications=true +]| + +The `X-GNOME-UsesNotifications` key indicates to GNOME Control Center +that this application uses notifications, so it can be listed in the +Control Center’s ‘Notifications’ panel. + +The `.desktop` file must be named as `org.gnome.TestApplication.desktop`, +where `org.gnome.TestApplication` is the ID passed to g_application_new(). + User interaction with a notification (either the default action, or buttons) must be associated with actions on the application (ie: "app." actions). It is not possible to route user interaction @@ -79849,7 +81273,7 @@ A notification can be sent with g_application_send_notification(). Creates a new #GNotification with @title as its title. + line="30270">Creates a new #GNotification with @title as its title. After populating @notification with more details, it can be sent to the desktop shell with g_application_send_notification(). Changing @@ -79859,14 +81283,14 @@ resending @notification. a new #GNotification instance + line="30281">a new #GNotification instance the title of the notification + line="30272">the title of the notification @@ -79876,7 +81300,7 @@ resending @notification. version="2.40"> Adds a button to @notification that activates the action in + line="30214">Adds a button to @notification that activates the action in @detailed_action when clicked. That action must be an application-wide action (starting with "app."). If @detailed_action contains a target, the action will be activated with that target as @@ -79884,7 +81308,7 @@ its parameter. See g_action_parse_detailed_name() for a description of the format for @detailed_action. - + @@ -79892,19 +81316,19 @@ for @detailed_action. a #GNotification + line="30216">a #GNotification label of the button + line="30217">label of the button a detailed action name + line="30218">a detailed action name @@ -79916,14 +81340,14 @@ for @detailed_action. introspectable="0"> Adds a button to @notification that activates @action when clicked. + line="30233">Adds a button to @notification that activates @action when clicked. @action must be an application-wide action (it must start with "app."). If @target_format is given, it is used to collect remaining positional parameters into a #GVariant instance, similar to g_variant_new(). @action will be activated with that #GVariant as its parameter. - + @@ -79931,19 +81355,19 @@ parameter. a #GNotification + line="30235">a #GNotification label of the button + line="30236">label of the button an action name + line="30237">an action name allow-none="1"> a #GVariant format string, or %NULL + line="30238">a #GVariant format string, or %NULL positional parameters, as determined by @target_format + line="30239">positional parameters, as determined by @target_format @@ -79969,12 +81393,12 @@ parameter. version="2.40"> Adds a button to @notification that activates @action when clicked. + line="30253">Adds a button to @notification that activates @action when clicked. @action must be an application-wide action (it must start with "app."). If @target is non-%NULL, @action will be activated with @target as its parameter. - + @@ -79982,19 +81406,19 @@ its parameter. a #GNotification + line="30255">a #GNotification label of the button + line="30256">label of the button an action name + line="30257">an action name allow-none="1"> a #GVariant to use as @action's parameter, or %NULL + line="30258">a #GVariant to use as @action's parameter, or %NULL @@ -80013,7 +81437,7 @@ its parameter. version="2.40"> Sets the body of @notification to @body. + line="30286">Sets the body of @notification to @body. @@ -80022,7 +81446,7 @@ its parameter. a #GNotification + line="30288">a #GNotification allow-none="1"> the new body for @notification, or %NULL + line="30289">the new body for @notification, or %NULL + + + + + + Sets the type of @notification to @category. Categories have a main +type like `email`, `im` or `device` and can have a detail separated +by a `.`, e.g. `im.received` or `email.arrived`. Setting the category +helps the notification server to select proper feedback to the user. + +Standard categories are [listed in the specification](https://specifications.freedesktop.org/notification-spec/latest/ar01s06.html). + + + + + + + a #GNotification + + + + the category for @notification, or %NULL for no category @@ -80041,7 +81498,7 @@ its parameter. version="2.40"> Sets the default action of @notification to @detailed_action. This + line="30313">Sets the default action of @notification to @detailed_action. This action is activated when the notification is clicked on. The action in @detailed_action must be an application-wide action (it @@ -80050,43 +81507,6 @@ given action will be activated with that target as its parameter. See g_action_parse_detailed_name() for a description of the format for @detailed_action. -When no default action is set, the application that the notification -was sent on is activated. - - - - - - - a #GNotification - - - - a detailed action name - - - - - - Sets the default action of @notification to @action. This action is -activated when the notification is clicked on. It must be an -application-wide action (it must start with "app."). - -If @target_format is given, it is used to collect remaining -positional parameters into a #GVariant instance, similar to -g_variant_new(). @action will be activated with that #GVariant as its -parameter. - When no default action is set, the application that the notification was sent on is activated. @@ -80097,13 +81517,50 @@ was sent on is activated. a #GNotification + line="30315">a #GNotification + + + + a detailed action name + + + + + + Sets the default action of @notification to @action. This action is +activated when the notification is clicked on. It must be an +application-wide action (it must start with "app."). + +If @target_format is given, it is used to collect remaining +positional parameters into a #GVariant instance, similar to +g_variant_new(). @action will be activated with that #GVariant as its +parameter. + +When no default action is set, the application that the notification +was sent on is activated. + + + + + + + a #GNotification an action name + line="30337">an action name allow-none="1"> a #GVariant format string, or %NULL + line="30338">a #GVariant format string, or %NULL positional parameters, as determined by @target_format + line="30339">positional parameters, as determined by @target_format @@ -80129,7 +81586,7 @@ was sent on is activated. version="2.40"> Sets the default action of @notification to @action. This action is + line="30357">Sets the default action of @notification to @action. This action is activated when the notification is clicked on. It must be an application-wide action (start with "app."). @@ -80138,7 +81595,7 @@ its parameter. When no default action is set, the application that the notification was sent on is activated. - + @@ -80146,13 +81603,13 @@ was sent on is activated. a #GNotification + line="30359">a #GNotification an action name + line="30360">an action name allow-none="1"> a #GVariant to use as @action's parameter, or %NULL + line="30361">a #GVariant to use as @action's parameter, or %NULL @@ -80171,7 +81628,7 @@ was sent on is activated. version="2.40"> Sets the icon of @notification to @icon. + line="30377">Sets the icon of @notification to @icon. @@ -80180,13 +81637,13 @@ was sent on is activated. a #GNotification + line="30379">a #GNotification the icon to be shown in @notification, as a #GIcon + line="30380">the icon to be shown in @notification, as a #GIcon @@ -80194,7 +81651,7 @@ was sent on is activated. Sets the priority of @notification to @priority. See + line="30388">Sets the priority of @notification to @priority. See #GNotificationPriority for possible values. @@ -80204,13 +81661,13 @@ was sent on is activated. a #GNotification + line="30390">a #GNotification a #GNotificationPriority + line="30391">a #GNotificationPriority @@ -80220,7 +81677,7 @@ was sent on is activated. version="2.40"> Sets the title of @notification to @title. + line="30398">Sets the title of @notification to @title. @@ -80229,13 +81686,13 @@ was sent on is activated. a #GNotification + line="30400">a #GNotification the new title for @notification + line="30401">the new title for @notification @@ -80247,7 +81704,7 @@ was sent on is activated. deprecated-version="2.42"> Deprecated in favor of g_notification_set_priority(). + line="30409">Deprecated in favor of g_notification_set_priority(). Since 2.42, this has been deprecated in favour of g_notification_set_priority(). @@ -80258,13 +81715,13 @@ was sent on is activated. a #GNotification + line="30411">a #GNotification %TRUE if @notification is urgent + line="30412">%TRUE if @notification is urgent @@ -80277,44 +81734,48 @@ was sent on is activated. c:type="GNotificationPriority"> Priority levels for #GNotifications. + line="2001">Priority levels for #GNotifications. + glib:nick="normal" + glib:name="G_NOTIFICATION_PRIORITY_NORMAL"> the default priority, to be used for the + line="2006">the default priority, to be used for the majority of notifications (for example email messages, software updates, completed download/sync operations) + glib:nick="low" + glib:name="G_NOTIFICATION_PRIORITY_LOW"> for notifications that do not require + line="2003">for notifications that do not require immediate attention - typically used for contextual background information, such as contact birthdays or local weather + glib:nick="high" + glib:name="G_NOTIFICATION_PRIORITY_HIGH"> for events that require more attention, + line="2009">for events that require more attention, usually because responses are time-sensitive (for example chat and SMS messages or alarms) + glib:nick="urgent" + glib:name="G_NOTIFICATION_PRIORITY_URGENT"> for urgent notifications, or notifications + line="2012">for urgent notifications, or notifications that require a response in a short space of time (for example phone calls or emergency warnings) @@ -80349,43 +81810,43 @@ was sent on is activated. Structure used for scatter/gather data output when sending multiple + line="516">Structure used for scatter/gather data output when sending multiple messages or packets in one go. You generally pass in an array of #GOutputVectors and the operation will use all the buffers as if they were one buffer. If @address is %NULL then the message is sent to the default receiver (as previously set by g_socket_connect()). - + a #GSocketAddress, or %NULL + line="518">a #GSocketAddress, or %NULL pointer to an array of output vectors + line="519">pointer to an array of output vectors the number of output vectors pointed to by @vectors. + line="520">the number of output vectors pointed to by @vectors. initialize to 0. Will be set to the number of bytes + line="521">initialize to 0. Will be set to the number of bytes that have been sent a pointer + line="523">a pointer to an array of #GSocketControlMessages, or %NULL. @@ -80394,7 +81855,7 @@ If @address is %NULL then the message is sent to the default receiver number of elements in @control_messages. + line="525">number of elements in @control_messages. @@ -80408,7 +81869,7 @@ If @address is %NULL then the message is sent to the default receiver glib:type-struct="OutputStreamClass"> #GOutputStream has functions to write to a stream (g_output_stream_write()), + line="7532">#GOutputStream has functions to write to a stream (g_output_stream_write()), to close a stream (g_output_stream_close()) and to flush pending writes (g_output_stream_flush()). @@ -80423,7 +81884,7 @@ All of these functions have async variants too. Requests an asynchronous close of the stream, releasing resources + line="30483">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation. @@ -80441,13 +81902,13 @@ classes. However, if you override one you must override all. A #GOutputStream. + line="30485">A #GOutputStream. the io priority of the request. + line="30486">the io priority of the request. allow-none="1"> optional cancellable object + line="30487">optional cancellable object closure="3"> callback to call when the request is satisfied + line="30488">callback to call when the request is satisfied closure="3"> the data to pass to callback function + line="30489">the data to pass to callback function @@ -80485,25 +81946,25 @@ classes. However, if you override one you must override all. Closes an output stream. + line="30504">Closes an output stream. %TRUE if stream was successfully closed, %FALSE otherwise. + line="30513">%TRUE if stream was successfully closed, %FALSE otherwise. a #GOutputStream. + line="30506">a #GOutputStream. a #GAsyncResult. + line="30507">a #GAsyncResult. @@ -80528,7 +81989,7 @@ classes. However, if you override one you must override all. Forces a write of all user-space buffered data for the given + line="30517">Forces a write of all user-space buffered data for the given @stream. Will block during the operation. Closing the stream will implicitly cause a flush. @@ -80541,14 +82002,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on success, %FALSE on error + line="30533">%TRUE on success, %FALSE on error a #GOutputStream. + line="30519">a #GOutputStream. allow-none="1"> optional cancellable object + line="30520">optional cancellable object @@ -80565,7 +82026,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Forces an asynchronous write of all user-space buffered data for + line="30537">Forces an asynchronous write of all user-space buffered data for the given @stream. For behaviour details see g_output_stream_flush(). @@ -80580,13 +82041,13 @@ result of the operation. a #GOutputStream. + line="30539">a #GOutputStream. the io priority of the request. + line="30540">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30541">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="30542">a #GAsyncReadyCallback to call when the request is satisfied closure="3"> the data to pass to callback function + line="30543">the data to pass to callback function @@ -80624,25 +82085,25 @@ result of the operation. Finishes flushing an output stream. + line="30555">Finishes flushing an output stream. %TRUE if flush operation succeeded, %FALSE otherwise. + line="30564">%TRUE if flush operation succeeded, %FALSE otherwise. a #GOutputStream. + line="30557">a #GOutputStream. a GAsyncResult. + line="30558">a GAsyncResult. @@ -80650,12 +82111,12 @@ result of the operation. Splices an input stream into an output stream. + line="30644">Splices an input stream into an output stream. a #gssize containing the size of the data spliced, or + line="30655">a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -80666,19 +82127,19 @@ result of the operation. a #GOutputStream. + line="30646">a #GOutputStream. a #GInputStream. + line="30647">a #GInputStream. a set of #GOutputStreamSpliceFlags. + line="30648">a set of #GOutputStreamSpliceFlags. @@ -80688,7 +82149,7 @@ result of the operation. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30649">optional #GCancellable object, %NULL to ignore. @@ -80696,7 +82157,7 @@ result of the operation. Splices a stream asynchronously. + line="30663">Splices a stream asynchronously. When the operation is finished @callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation. @@ -80711,26 +82172,26 @@ g_output_stream_splice(). a #GOutputStream. + line="30665">a #GOutputStream. a #GInputStream. + line="30666">a #GInputStream. a set of #GOutputStreamSpliceFlags. + line="30667">a set of #GOutputStreamSpliceFlags. the io priority of the request. + line="30668">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30669">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback. + line="30670">a #GAsyncReadyCallback. closure="5"> user data passed to @callback. + line="30671">user data passed to @callback. @@ -80768,12 +82229,12 @@ g_output_stream_splice(). Finishes an asynchronous stream splice operation. + line="30683">Finishes an asynchronous stream splice operation. a #gssize of the number of bytes spliced. Note that if the + line="30692">a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -80783,13 +82244,13 @@ g_output_stream_splice(). a #GOutputStream. + line="30685">a #GOutputStream. a #GAsyncResult. + line="30686">a #GAsyncResult. @@ -80797,7 +82258,7 @@ g_output_stream_splice(). Request an asynchronous write of @count bytes from @buffer into + line="30847">Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_finish() to get the result of the operation. @@ -80840,7 +82301,7 @@ the contents (without copying) for the duration of the call. A #GOutputStream. + line="30849">A #GOutputStream. allow-none="1"> the buffer containing the data to write. + line="30850">the buffer containing the data to write. @@ -80857,13 +82318,13 @@ the contents (without copying) for the duration of the call. the number of bytes to write + line="30851">the number of bytes to write the io priority of the request. + line="30852">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30853">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="30854">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="30855">the data to pass to callback function @@ -80901,25 +82362,25 @@ the contents (without copying) for the duration of the call. Finishes a stream write operation. + line="30956">Finishes a stream write operation. a #gssize containing the number of bytes written to the stream. + line="30965">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + line="30958">a #GOutputStream. a #GAsyncResult. + line="30959">a #GAsyncResult. @@ -80927,7 +82388,7 @@ the contents (without copying) for the duration of the call. Tries to write @count bytes from @buffer into the stream. Will block + line="30727">Tries to write @count bytes from @buffer into the stream. Will block during the operation. If count is 0, returns 0 and does nothing. A value of @count @@ -80951,14 +82412,14 @@ On error -1 is returned and @error is set accordingly. Number of bytes written, or -1 on error + line="30756">Number of bytes written, or -1 on error a #GOutputStream. + line="30729">a #GOutputStream. allow-none="1"> the buffer containing the data to write. + line="30730">the buffer containing the data to write. @@ -80975,7 +82436,7 @@ On error -1 is returned and @error is set accordingly. the number of bytes to write + line="30731">the number of bytes to write allow-none="1"> optional cancellable object + line="30732">optional cancellable object @@ -80994,7 +82455,7 @@ On error -1 is returned and @error is set accordingly. version="2.60"> Request an asynchronous write of the bytes contained in @n_vectors @vectors into + line="31100">Request an asynchronous write of the bytes contained in @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_finish() to get the result of the operation. @@ -81032,13 +82493,13 @@ until @callback is called. A #GOutputStream. + line="31102">A #GOutputStream. the buffer containing the #GOutputVectors to write. + line="31103">the buffer containing the #GOutputVectors to write. @@ -81048,13 +82509,13 @@ until @callback is called. the number of vectors to write + line="31104">the number of vectors to write the I/O priority of the request. + line="31105">the I/O priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="31106">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="31107">callback to call when the request is satisfied closure="5"> the data to pass to callback function + line="31108">the data to pass to callback function @@ -81095,25 +82556,25 @@ until @callback is called. throws="1"> Finishes a stream writev operation. + line="31145">Finishes a stream writev operation. %TRUE on success, %FALSE if there was an error + line="31155">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="31147">a #GOutputStream. a #GAsyncResult. + line="31148">a #GAsyncResult. allow-none="1"> location to store the number of bytes that were written to the stream + line="31149">location to store the number of bytes that were written to the stream @@ -81135,7 +82596,7 @@ until @callback is called. throws="1"> Tries to write the bytes contained in the @n_vectors @vectors into the + line="30969">Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. If @n_vectors is 0 or the sum of all bytes in @vectors is 0, returns 0 and @@ -81162,20 +82623,20 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. %TRUE on success, %FALSE if there was an error + line="31003">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="30971">a #GOutputStream. the buffer containing the #GOutputVectors to write. + line="30972">the buffer containing the #GOutputVectors to write. @@ -81185,7 +82646,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. the number of vectors to write + line="30973">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="30974">location to store the number of bytes that were written to the stream @@ -81206,7 +82667,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. allow-none="1"> optional cancellable object + line="30976">optional cancellable object @@ -81215,7 +82676,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. c:identifier="g_output_stream_clear_pending"> Clears the pending flag on @stream. + line="30435">Clears the pending flag on @stream. @@ -81224,7 +82685,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. output stream + line="30437">output stream @@ -81232,7 +82693,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. Closes the stream, releasing resources related to it. + line="30443">Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. @@ -81265,14 +82726,14 @@ data will reach the target. %TRUE on success, %FALSE on failure + line="30479">%TRUE on success, %FALSE on failure A #GOutputStream. + line="30445">A #GOutputStream. allow-none="1"> optional cancellable object + line="30446">optional cancellable object @@ -81289,7 +82750,7 @@ data will reach the target. Requests an asynchronous close of the stream, releasing resources + line="30483">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation. @@ -81307,13 +82768,13 @@ classes. However, if you override one you must override all. A #GOutputStream. + line="30485">A #GOutputStream. the io priority of the request. + line="30486">the io priority of the request. allow-none="1"> optional cancellable object + line="30487">optional cancellable object closure="3"> callback to call when the request is satisfied + line="30488">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="30489">the data to pass to callback function @@ -81352,25 +82813,25 @@ classes. However, if you override one you must override all. throws="1"> Closes an output stream. + line="30504">Closes an output stream. %TRUE if stream was successfully closed, %FALSE otherwise. + line="30513">%TRUE if stream was successfully closed, %FALSE otherwise. a #GOutputStream. + line="30506">a #GOutputStream. a #GAsyncResult. + line="30507">a #GAsyncResult. @@ -81378,7 +82839,7 @@ classes. However, if you override one you must override all. Forces a write of all user-space buffered data for the given + line="30517">Forces a write of all user-space buffered data for the given @stream. Will block during the operation. Closing the stream will implicitly cause a flush. @@ -81391,14 +82852,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE on success, %FALSE on error + line="30533">%TRUE on success, %FALSE on error a #GOutputStream. + line="30519">a #GOutputStream. allow-none="1"> optional cancellable object + line="30520">optional cancellable object @@ -81415,7 +82876,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Forces an asynchronous write of all user-space buffered data for + line="30537">Forces an asynchronous write of all user-space buffered data for the given @stream. For behaviour details see g_output_stream_flush(). @@ -81430,13 +82891,13 @@ result of the operation. a #GOutputStream. + line="30539">a #GOutputStream. the io priority of the request. + line="30540">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30541">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="30542">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="30543">the data to pass to callback function @@ -81475,25 +82936,25 @@ result of the operation. throws="1"> Finishes flushing an output stream. + line="30555">Finishes flushing an output stream. %TRUE if flush operation succeeded, %FALSE otherwise. + line="30564">%TRUE if flush operation succeeded, %FALSE otherwise. a #GOutputStream. + line="30557">a #GOutputStream. a GAsyncResult. + line="30558">a GAsyncResult. @@ -81501,19 +82962,19 @@ result of the operation. Checks if an output stream has pending actions. + line="30568">Checks if an output stream has pending actions. %TRUE if @stream has pending actions. + line="30574">%TRUE if @stream has pending actions. a #GOutputStream. + line="30570">a #GOutputStream. @@ -81521,19 +82982,19 @@ result of the operation. Checks if an output stream has already been closed. + line="30578">Checks if an output stream has already been closed. %TRUE if @stream is closed. %FALSE otherwise. + line="30584">%TRUE if @stream is closed. %FALSE otherwise. a #GOutputStream. + line="30580">a #GOutputStream. @@ -81543,7 +83004,7 @@ result of the operation. version="2.24"> Checks if an output stream is being closed. This can be + line="30588">Checks if an output stream is being closed. This can be used inside e.g. a flush implementation to see if the flush (or other i/o operation) is called from within the closing operation. @@ -81551,14 +83012,14 @@ the closing operation. %TRUE if @stream is being closed. %FALSE otherwise. + line="30597">%TRUE if @stream is being closed. %FALSE otherwise. a #GOutputStream. + line="30590">a #GOutputStream. @@ -81569,7 +83030,7 @@ the closing operation. introspectable="0"> This is a utility function around g_output_stream_write_all(). It + line="30602">This is a utility function around g_output_stream_write_all(). It uses g_strdup_vprintf() to turn @format and @... into a string that is then written to @stream. @@ -81585,14 +83046,14 @@ or g_output_stream_write_all(). %TRUE on success, %FALSE if there was an error + line="30626">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="30604">a #GOutputStream. allow-none="1"> location to store the number of bytes that was + line="30605">location to store the number of bytes that was written to the stream @@ -81613,25 +83074,25 @@ or g_output_stream_write_all(). allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30607">optional #GCancellable object, %NULL to ignore. location to store the error occurring, or %NULL to ignore + line="30608">location to store the error occurring, or %NULL to ignore the format string. See the printf() documentation + line="30609">the format string. See the printf() documentation the parameters to insert into the format string + line="30610">the parameters to insert into the format string @@ -81641,21 +83102,21 @@ or g_output_stream_write_all(). throws="1"> Sets @stream to have actions pending. If the pending flag is + line="30630">Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. %TRUE if pending was previously unset and is now set. + line="30640">%TRUE if pending was previously unset and is now set. a #GOutputStream. + line="30632">a #GOutputStream. @@ -81663,12 +83124,12 @@ already set or @stream is closed, it will return %FALSE and set Splices an input stream into an output stream. + line="30644">Splices an input stream into an output stream. a #gssize containing the size of the data spliced, or + line="30655">a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -81679,19 +83140,19 @@ already set or @stream is closed, it will return %FALSE and set a #GOutputStream. + line="30646">a #GOutputStream. a #GInputStream. + line="30647">a #GInputStream. a set of #GOutputStreamSpliceFlags. + line="30648">a set of #GOutputStreamSpliceFlags. @@ -81701,7 +83162,7 @@ already set or @stream is closed, it will return %FALSE and set allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30649">optional #GCancellable object, %NULL to ignore. @@ -81709,7 +83170,7 @@ already set or @stream is closed, it will return %FALSE and set Splices a stream asynchronously. + line="30663">Splices a stream asynchronously. When the operation is finished @callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation. @@ -81724,26 +83185,26 @@ g_output_stream_splice(). a #GOutputStream. + line="30665">a #GOutputStream. a #GInputStream. + line="30666">a #GInputStream. a set of #GOutputStreamSpliceFlags. + line="30667">a set of #GOutputStreamSpliceFlags. the io priority of the request. + line="30668">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30669">optional #GCancellable object, %NULL to ignore. closure="5"> a #GAsyncReadyCallback. + line="30670">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="30671">user data passed to @callback. @@ -81782,12 +83243,12 @@ g_output_stream_splice(). throws="1"> Finishes an asynchronous stream splice operation. + line="30683">Finishes an asynchronous stream splice operation. a #gssize of the number of bytes spliced. Note that if the + line="30692">a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -81797,13 +83258,13 @@ g_output_stream_splice(). a #GOutputStream. + line="30685">a #GOutputStream. a #GAsyncResult. + line="30686">a #GAsyncResult. @@ -81814,7 +83275,7 @@ g_output_stream_splice(). introspectable="0"> This is a utility function around g_output_stream_write_all(). It + line="30699">This is a utility function around g_output_stream_write_all(). It uses g_strdup_vprintf() to turn @format and @args into a string that is then written to @stream. @@ -81830,14 +83291,14 @@ or g_output_stream_write_all(). %TRUE on success, %FALSE if there was an error + line="30723">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="30701">a #GOutputStream. allow-none="1"> location to store the number of bytes that was + line="30702">location to store the number of bytes that was written to the stream @@ -81858,25 +83319,25 @@ or g_output_stream_write_all(). allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30704">optional #GCancellable object, %NULL to ignore. location to store the error occurring, or %NULL to ignore + line="30705">location to store the error occurring, or %NULL to ignore the format string. See the printf() documentation + line="30706">the format string. See the printf() documentation the parameters to insert into the format string + line="30707">the parameters to insert into the format string @@ -81884,7 +83345,7 @@ or g_output_stream_write_all(). Tries to write @count bytes from @buffer into the stream. Will block + line="30727">Tries to write @count bytes from @buffer into the stream. Will block during the operation. If count is 0, returns 0 and does nothing. A value of @count @@ -81908,20 +83369,20 @@ On error -1 is returned and @error is set accordingly. Number of bytes written, or -1 on error + line="30756">Number of bytes written, or -1 on error a #GOutputStream. + line="30729">a #GOutputStream. the buffer containing the data to write. + line="30730">the buffer containing the data to write. @@ -81929,7 +83390,7 @@ On error -1 is returned and @error is set accordingly. the number of bytes to write + line="30731">the number of bytes to write allow-none="1"> optional cancellable object + line="30732">optional cancellable object @@ -81948,7 +83409,7 @@ On error -1 is returned and @error is set accordingly. throws="1"> Tries to write @count bytes from @buffer into the stream. Will block + line="30760">Tries to write @count bytes from @buffer into the stream. Will block during the operation. This function is similar to g_output_stream_write(), except it tries to @@ -81971,20 +83432,20 @@ g_output_stream_write(). %TRUE on success, %FALSE if there was an error + line="30790">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="30762">a #GOutputStream. the buffer containing the data to write. + line="30763">the buffer containing the data to write. @@ -81992,7 +83453,7 @@ g_output_stream_write(). the number of bytes to write + line="30764">the number of bytes to write allow-none="1"> location to store the number of bytes that was + line="30765">location to store the number of bytes that was written to the stream @@ -82013,7 +83474,7 @@ g_output_stream_write(). allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30767">optional #GCancellable object, %NULL to ignore. @@ -82023,7 +83484,7 @@ g_output_stream_write(). version="2.44"> Request an asynchronous write of @count bytes from @buffer into + line="30794">Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_all_finish() to get the result of the operation. @@ -82046,13 +83507,13 @@ until @callback is called. A #GOutputStream + line="30796">A #GOutputStream the buffer containing the data to write + line="30797">the buffer containing the data to write @@ -82060,13 +83521,13 @@ until @callback is called. the number of bytes to write + line="30798">the number of bytes to write the io priority of the request + line="30799">the io priority of the request allow-none="1"> optional #GCancellable object, %NULL to ignore + line="30800">optional #GCancellable object, %NULL to ignore closure="5"> callback to call when the request is satisfied + line="30801">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="30802">the data to pass to callback function @@ -82106,7 +83567,7 @@ until @callback is called. throws="1"> Finishes an asynchronous stream write operation started with + line="30824">Finishes an asynchronous stream write operation started with g_output_stream_write_all_async(). As a special exception to the normal conventions for functions that @@ -82120,20 +83581,20 @@ g_output_stream_write_async(). %TRUE on success, %FALSE if there was an error + line="30842">%TRUE on success, %FALSE if there was an error a #GOutputStream + line="30826">a #GOutputStream a #GAsyncResult + line="30827">a #GAsyncResult allow-none="1"> location to store the number of bytes that was written to the stream + line="30828">location to store the number of bytes that was written to the stream @@ -82152,7 +83613,7 @@ g_output_stream_write_async(). Request an asynchronous write of @count bytes from @buffer into + line="30847">Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_finish() to get the result of the operation. @@ -82195,13 +83656,13 @@ the contents (without copying) for the duration of the call. A #GOutputStream. + line="30849">A #GOutputStream. the buffer containing the data to write. + line="30850">the buffer containing the data to write. @@ -82209,13 +83670,13 @@ the contents (without copying) for the duration of the call. the number of bytes to write + line="30851">the number of bytes to write the io priority of the request. + line="30852">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30853">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="30854">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="30855">the data to pass to callback function @@ -82254,7 +83715,7 @@ the contents (without copying) for the duration of the call. throws="1"> A wrapper function for g_output_stream_write() which takes a + line="30895">A wrapper function for g_output_stream_write() which takes a #GBytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of #GBytes is helpful over a bare pointer interface. @@ -82269,20 +83730,20 @@ data in the output stream. Number of bytes written, or -1 on error + line="30914">Number of bytes written, or -1 on error a #GOutputStream. + line="30897">a #GOutputStream. the #GBytes to write + line="30898">the #GBytes to write allow-none="1"> optional cancellable object + line="30899">optional cancellable object @@ -82300,7 +83761,7 @@ data in the output stream. c:identifier="g_output_stream_write_bytes_async"> This function is similar to g_output_stream_write_async(), but + line="30918">This function is similar to g_output_stream_write_async(), but takes a #GBytes as input. Due to the refcounted nature of #GBytes, this allows the stream to avoid taking a copy of the data. @@ -82321,19 +83782,19 @@ g_output_stream_write_bytes(). A #GOutputStream. + line="30920">A #GOutputStream. The bytes to write + line="30921">The bytes to write the io priority of the request. + line="30922">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30923">optional #GCancellable object, %NULL to ignore. closure="4"> callback to call when the request is satisfied + line="30924">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="30925">the data to pass to callback function @@ -82372,25 +83833,25 @@ g_output_stream_write_bytes(). throws="1"> Finishes a stream write-from-#GBytes operation. + line="30943">Finishes a stream write-from-#GBytes operation. a #gssize containing the number of bytes written to the stream. + line="30952">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + line="30945">a #GOutputStream. a #GAsyncResult. + line="30946">a #GAsyncResult. @@ -82400,25 +83861,25 @@ g_output_stream_write_bytes(). throws="1"> Finishes a stream write operation. + line="30956">Finishes a stream write operation. a #gssize containing the number of bytes written to the stream. + line="30965">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + line="30958">a #GOutputStream. a #GAsyncResult. + line="30959">a #GAsyncResult. @@ -82429,7 +83890,7 @@ g_output_stream_write_bytes(). throws="1"> Tries to write the bytes contained in the @n_vectors @vectors into the + line="30969">Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. If @n_vectors is 0 or the sum of all bytes in @vectors is 0, returns 0 and @@ -82456,20 +83917,20 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. %TRUE on success, %FALSE if there was an error + line="31003">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="30971">a #GOutputStream. the buffer containing the #GOutputVectors to write. + line="30972">the buffer containing the #GOutputVectors to write. @@ -82479,7 +83940,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. the number of vectors to write + line="30973">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="30974">location to store the number of bytes that were written to the stream @@ -82500,7 +83961,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. allow-none="1"> optional cancellable object + line="30976">optional cancellable object @@ -82511,7 +83972,7 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. throws="1"> Tries to write the bytes contained in the @n_vectors @vectors into the + line="31008">Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. This function is similar to g_output_stream_writev(), except it tries to @@ -82537,20 +83998,20 @@ function. %TRUE on success, %FALSE if there was an error + line="31041">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="31010">a #GOutputStream. the buffer containing the #GOutputVectors to write. + line="31011">the buffer containing the #GOutputVectors to write. @@ -82558,7 +84019,7 @@ function. the number of vectors to write + line="31012">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="31013">location to store the number of bytes that were written to the stream @@ -82579,7 +84040,7 @@ function. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="31015">optional #GCancellable object, %NULL to ignore. @@ -82589,7 +84050,7 @@ function. version="2.60"> Request an asynchronous write of the bytes contained in the @n_vectors @vectors into + line="31046">Request an asynchronous write of the bytes contained in the @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_all_finish() to get the result of the operation. @@ -82613,13 +84074,13 @@ of @vectors might be changed by this function. A #GOutputStream + line="31048">A #GOutputStream the buffer containing the #GOutputVectors to write. + line="31049">the buffer containing the #GOutputVectors to write. @@ -82627,13 +84088,13 @@ of @vectors might be changed by this function. the number of vectors to write + line="31050">the number of vectors to write the I/O priority of the request + line="31051">the I/O priority of the request allow-none="1"> optional #GCancellable object, %NULL to ignore + line="31052">optional #GCancellable object, %NULL to ignore closure="5"> callback to call when the request is satisfied + line="31053">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="31054">the data to pass to callback function @@ -82673,7 +84134,7 @@ of @vectors might be changed by this function. throws="1"> Finishes an asynchronous stream write operation started with + line="31077">Finishes an asynchronous stream write operation started with g_output_stream_writev_all_async(). As a special exception to the normal conventions for functions that @@ -82687,20 +84148,20 @@ g_output_stream_writev_async(). %TRUE on success, %FALSE if there was an error + line="31095">%TRUE on success, %FALSE if there was an error a #GOutputStream + line="31079">a #GOutputStream a #GAsyncResult + line="31080">a #GAsyncResult allow-none="1"> location to store the number of bytes that were written to the stream + line="31081">location to store the number of bytes that were written to the stream @@ -82721,7 +84182,7 @@ g_output_stream_writev_async(). version="2.60"> Request an asynchronous write of the bytes contained in @n_vectors @vectors into + line="31100">Request an asynchronous write of the bytes contained in @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_finish() to get the result of the operation. @@ -82759,13 +84220,13 @@ until @callback is called. A #GOutputStream. + line="31102">A #GOutputStream. the buffer containing the #GOutputVectors to write. + line="31103">the buffer containing the #GOutputVectors to write. @@ -82775,13 +84236,13 @@ until @callback is called. the number of vectors to write + line="31104">the number of vectors to write the I/O priority of the request. + line="31105">the I/O priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="31106">optional #GCancellable object, %NULL to ignore. closure="5"> callback to call when the request is satisfied + line="31107">callback to call when the request is satisfied allow-none="1"> the data to pass to callback function + line="31108">the data to pass to callback function @@ -82821,25 +84282,25 @@ until @callback is called. throws="1"> Finishes a stream writev operation. + line="31145">Finishes a stream writev operation. %TRUE on success, %FALSE if there was an error + line="31155">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="31147">a #GOutputStream. a #GAsyncResult. + line="31148">a #GAsyncResult. allow-none="1"> location to store the number of bytes that were written to the stream + line="31149">location to store the number of bytes that were written to the stream @@ -82875,14 +84336,14 @@ until @callback is called. Number of bytes written, or -1 on error + line="30756">Number of bytes written, or -1 on error a #GOutputStream. + line="30729">a #GOutputStream. allow-none="1"> the buffer containing the data to write. + line="30730">the buffer containing the data to write. @@ -82899,7 +84360,7 @@ until @callback is called. the number of bytes to write + line="30731">the number of bytes to write allow-none="1"> optional cancellable object + line="30732">optional cancellable object @@ -82920,7 +84381,7 @@ until @callback is called. a #gssize containing the size of the data spliced, or + line="30655">a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -82931,19 +84392,19 @@ until @callback is called. a #GOutputStream. + line="30646">a #GOutputStream. a #GInputStream. + line="30647">a #GInputStream. a set of #GOutputStreamSpliceFlags. + line="30648">a set of #GOutputStreamSpliceFlags. @@ -82953,7 +84414,7 @@ until @callback is called. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30649">optional #GCancellable object, %NULL to ignore. @@ -82965,14 +84426,14 @@ until @callback is called. %TRUE on success, %FALSE on error + line="30533">%TRUE on success, %FALSE on error a #GOutputStream. + line="30519">a #GOutputStream. allow-none="1"> optional cancellable object + line="30520">optional cancellable object @@ -83016,7 +84477,7 @@ until @callback is called. A #GOutputStream. + line="30849">A #GOutputStream. allow-none="1"> the buffer containing the data to write. + line="30850">the buffer containing the data to write. @@ -83033,13 +84494,13 @@ until @callback is called. the number of bytes to write + line="30851">the number of bytes to write the io priority of the request. + line="30852">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30853">optional #GCancellable object, %NULL to ignore. closure="6"> callback to call when the request is satisfied + line="30854">callback to call when the request is satisfied closure="6"> the data to pass to callback function + line="30855">the data to pass to callback function @@ -83081,20 +84542,20 @@ until @callback is called. a #gssize containing the number of bytes written to the stream. + line="30965">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + line="30958">a #GOutputStream. a #GAsyncResult. + line="30959">a #GAsyncResult. @@ -83110,26 +84571,26 @@ until @callback is called. a #GOutputStream. + line="30665">a #GOutputStream. a #GInputStream. + line="30666">a #GInputStream. a set of #GOutputStreamSpliceFlags. + line="30667">a set of #GOutputStreamSpliceFlags. the io priority of the request. + line="30668">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30669">optional #GCancellable object, %NULL to ignore. closure="6"> a #GAsyncReadyCallback. + line="30670">a #GAsyncReadyCallback. closure="6"> user data passed to @callback. + line="30671">user data passed to @callback. @@ -83171,7 +84632,7 @@ until @callback is called. a #gssize of the number of bytes spliced. Note that if the + line="30692">a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -83181,13 +84642,13 @@ until @callback is called. a #GOutputStream. + line="30685">a #GOutputStream. a #GAsyncResult. + line="30686">a #GAsyncResult. @@ -83203,13 +84664,13 @@ until @callback is called. a #GOutputStream. + line="30539">a #GOutputStream. the io priority of the request. + line="30540">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="30541">optional #GCancellable object, %NULL to ignore. closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="30542">a #GAsyncReadyCallback to call when the request is satisfied closure="4"> the data to pass to callback function + line="30543">the data to pass to callback function @@ -83251,20 +84712,20 @@ until @callback is called. %TRUE if flush operation succeeded, %FALSE otherwise. + line="30564">%TRUE if flush operation succeeded, %FALSE otherwise. a #GOutputStream. + line="30557">a #GOutputStream. a GAsyncResult. + line="30558">a GAsyncResult. @@ -83280,13 +84741,13 @@ until @callback is called. A #GOutputStream. + line="30485">A #GOutputStream. the io priority of the request. + line="30486">the io priority of the request. allow-none="1"> optional cancellable object + line="30487">optional cancellable object closure="4"> callback to call when the request is satisfied + line="30488">callback to call when the request is satisfied closure="4"> the data to pass to callback function + line="30489">the data to pass to callback function @@ -83328,20 +84789,20 @@ until @callback is called. %TRUE if stream was successfully closed, %FALSE otherwise. + line="30513">%TRUE if stream was successfully closed, %FALSE otherwise. a #GOutputStream. + line="30506">a #GOutputStream. a #GAsyncResult. + line="30507">a #GAsyncResult. @@ -83353,20 +84814,20 @@ until @callback is called. %TRUE on success, %FALSE if there was an error + line="31003">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="30971">a #GOutputStream. the buffer containing the #GOutputVectors to write. + line="30972">the buffer containing the #GOutputVectors to write. @@ -83376,7 +84837,7 @@ until @callback is called. the number of vectors to write + line="30973">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="30974">location to store the number of bytes that were written to the stream @@ -83397,7 +84858,7 @@ until @callback is called. allow-none="1"> optional cancellable object + line="30976">optional cancellable object @@ -83413,13 +84874,13 @@ until @callback is called. A #GOutputStream. + line="31102">A #GOutputStream. the buffer containing the #GOutputVectors to write. + line="31103">the buffer containing the #GOutputVectors to write. @@ -83429,13 +84890,13 @@ until @callback is called. the number of vectors to write + line="31104">the number of vectors to write the I/O priority of the request. + line="31105">the I/O priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="31106">optional #GCancellable object, %NULL to ignore. closure="6"> callback to call when the request is satisfied + line="31107">callback to call when the request is satisfied closure="6"> the data to pass to callback function + line="31108">the data to pass to callback function @@ -83477,20 +84938,20 @@ until @callback is called. %TRUE on success, %FALSE if there was an error + line="31155">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="31147">a #GOutputStream. a #GAsyncResult. + line="31148">a #GAsyncResult. allow-none="1"> location to store the number of bytes that were written to the stream + line="31149">location to store the number of bytes that were written to the stream @@ -83563,7 +85024,8 @@ until @callback is called. + glib:nick="none" + glib:name="G_OUTPUT_STREAM_SPLICE_NONE"> Do not close either stream. @@ -83571,7 +85033,8 @@ until @callback is called. + glib:nick="close-source" + glib:name="G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE"> Close the source stream after @@ -83580,7 +85043,8 @@ until @callback is called. + glib:nick="close-target" + glib:name="G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET"> Close the target stream after @@ -83590,21 +85054,21 @@ until @callback is called. Structure used for scatter/gather data output. + line="497">Structure used for scatter/gather data output. You generally pass in an array of #GOutputVectors and the operation will use all the buffers as if they were one buffer. - + Pointer to a buffer of data to read. + line="499">Pointer to a buffer of data to read. the size of @buffer. + line="500">the size of @buffer. @@ -83671,6 +85135,35 @@ one buffer. + + + + + + + + + Extension point for power profile usage monitoring functionality. +See [Extending GIO][extending-gio]. + + + + + + + + + + @@ -83802,7 +85295,8 @@ to, and later retrieves it again from there. + glib:nick="never" + glib:name="G_PASSWORD_SAVE_NEVER"> never save a password. @@ -83810,7 +85304,8 @@ to, and later retrieves it again from there. + glib:nick="for-session" + glib:name="G_PASSWORD_SAVE_FOR_SESSION"> save a password for the session. @@ -83818,7 +85313,8 @@ to, and later retrieves it again from there. + glib:nick="permanently" + glib:name="G_PASSWORD_SAVE_PERMANENTLY"> save a password permanently. @@ -83834,7 +85330,7 @@ to, and later retrieves it again from there. glib:type-struct="PermissionClass"> A #GPermission represents the status of the caller's permission to + line="7551">A #GPermission represents the status of the caller's permission to perform a certain action. You can query if the action is currently allowed and if it is @@ -83856,7 +85352,7 @@ when that button is clicked. throws="1"> Attempts to acquire the permission represented by @permission. + line="31160">Attempts to acquire the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is @@ -83875,14 +85371,14 @@ the non-blocking version. %TRUE if the permission was successfully acquired + line="31182">%TRUE if the permission was successfully acquired a #GPermission instance + line="31162">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31163">a #GCancellable, or %NULL @@ -83901,7 +85397,7 @@ the non-blocking version. version="2.26"> Attempts to acquire the permission represented by @permission. + line="31187">Attempts to acquire the permission represented by @permission. This is the first half of the asynchronous version of g_permission_acquire(). @@ -83913,7 +85409,7 @@ g_permission_acquire(). a #GPermission instance + line="31189">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31190">a #GCancellable, or %NULL closure="2"> the #GAsyncReadyCallback to call when done + line="31191">the #GAsyncReadyCallback to call when done closure="2"> the user data to pass to @callback + line="31192">the user data to pass to @callback @@ -83954,7 +85450,7 @@ g_permission_acquire(). throws="1"> Collects the result of attempting to acquire the permission + line="31203">Collects the result of attempting to acquire the permission represented by @permission. This is the second half of the asynchronous version of @@ -83963,20 +85459,20 @@ g_permission_acquire(). %TRUE if the permission was successfully acquired + line="31215">%TRUE if the permission was successfully acquired a #GPermission instance + line="31205">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + line="31206">the #GAsyncResult given to the #GAsyncReadyCallback @@ -83987,7 +85483,7 @@ g_permission_acquire(). throws="1"> Attempts to release the permission represented by @permission. + line="31276">Attempts to release the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the @@ -84006,14 +85502,14 @@ the non-blocking version. %TRUE if the permission was successfully released + line="31298">%TRUE if the permission was successfully released a #GPermission instance + line="31278">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31279">a #GCancellable, or %NULL @@ -84032,7 +85528,7 @@ the non-blocking version. version="2.26"> Attempts to release the permission represented by @permission. + line="31303">Attempts to release the permission represented by @permission. This is the first half of the asynchronous version of g_permission_release(). @@ -84044,7 +85540,7 @@ g_permission_release(). a #GPermission instance + line="31305">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31306">a #GCancellable, or %NULL closure="2"> the #GAsyncReadyCallback to call when done + line="31307">the #GAsyncReadyCallback to call when done closure="2"> the user data to pass to @callback + line="31308">the user data to pass to @callback @@ -84085,7 +85581,7 @@ g_permission_release(). throws="1"> Collects the result of attempting to release the permission + line="31319">Collects the result of attempting to release the permission represented by @permission. This is the second half of the asynchronous version of @@ -84094,20 +85590,20 @@ g_permission_release(). %TRUE if the permission was successfully released + line="31331">%TRUE if the permission was successfully released a #GPermission instance + line="31321">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + line="31322">the #GAsyncResult given to the #GAsyncReadyCallback @@ -84118,7 +85614,7 @@ g_permission_release(). throws="1"> Attempts to acquire the permission represented by @permission. + line="31160">Attempts to acquire the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is @@ -84137,14 +85633,14 @@ the non-blocking version. %TRUE if the permission was successfully acquired + line="31182">%TRUE if the permission was successfully acquired a #GPermission instance + line="31162">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31163">a #GCancellable, or %NULL @@ -84163,7 +85659,7 @@ the non-blocking version. version="2.26"> Attempts to acquire the permission represented by @permission. + line="31187">Attempts to acquire the permission represented by @permission. This is the first half of the asynchronous version of g_permission_acquire(). @@ -84175,7 +85671,7 @@ g_permission_acquire(). a #GPermission instance + line="31189">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31190">a #GCancellable, or %NULL closure="2"> the #GAsyncReadyCallback to call when done + line="31191">the #GAsyncReadyCallback to call when done allow-none="1"> the user data to pass to @callback + line="31192">the user data to pass to @callback @@ -84215,7 +85711,7 @@ g_permission_acquire(). throws="1"> Collects the result of attempting to acquire the permission + line="31203">Collects the result of attempting to acquire the permission represented by @permission. This is the second half of the asynchronous version of @@ -84224,92 +85720,95 @@ g_permission_acquire(). %TRUE if the permission was successfully acquired + line="31215">%TRUE if the permission was successfully acquired a #GPermission instance + line="31205">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + line="31206">the #GAsyncResult given to the #GAsyncReadyCallback Gets the value of the 'allowed' property. This property is %TRUE if + line="31220">Gets the value of the 'allowed' property. This property is %TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform. the value of the 'allowed' property + line="31228">the value of the 'allowed' property a #GPermission instance + line="31222">a #GPermission instance Gets the value of the 'can-acquire' property. This property is %TRUE + line="31233">Gets the value of the 'can-acquire' property. This property is %TRUE if it is generally possible to acquire the permission by calling g_permission_acquire(). the value of the 'can-acquire' property + line="31241">the value of the 'can-acquire' property a #GPermission instance + line="31235">a #GPermission instance Gets the value of the 'can-release' property. This property is %TRUE + line="31246">Gets the value of the 'can-release' property. This property is %TRUE if it is generally possible to release the permission by calling g_permission_release(). the value of the 'can-release' property + line="31254">the value of the 'can-release' property a #GPermission instance + line="31248">a #GPermission instance @@ -84319,7 +85818,7 @@ g_permission_release(). version="2.26"> This function is called by the #GPermission implementation to update + line="31259">This function is called by the #GPermission implementation to update the properties of the permission. You should never call this function except from a #GPermission implementation. @@ -84332,25 +85831,25 @@ GObject notify signals are generated, as appropriate. a #GPermission instance + line="31261">a #GPermission instance the new value for the 'allowed' property + line="31262">the new value for the 'allowed' property the new value for the 'can-acquire' property + line="31263">the new value for the 'can-acquire' property the new value for the 'can-release' property + line="31264">the new value for the 'can-release' property @@ -84361,7 +85860,7 @@ GObject notify signals are generated, as appropriate. throws="1"> Attempts to release the permission represented by @permission. + line="31276">Attempts to release the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the @@ -84380,14 +85879,14 @@ the non-blocking version. %TRUE if the permission was successfully released + line="31298">%TRUE if the permission was successfully released a #GPermission instance + line="31278">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31279">a #GCancellable, or %NULL @@ -84406,7 +85905,7 @@ the non-blocking version. version="2.26"> Attempts to release the permission represented by @permission. + line="31303">Attempts to release the permission represented by @permission. This is the first half of the asynchronous version of g_permission_release(). @@ -84418,7 +85917,7 @@ g_permission_release(). a #GPermission instance + line="31305">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31306">a #GCancellable, or %NULL closure="2"> the #GAsyncReadyCallback to call when done + line="31307">the #GAsyncReadyCallback to call when done allow-none="1"> the user data to pass to @callback + line="31308">the user data to pass to @callback @@ -84458,7 +85957,7 @@ g_permission_release(). throws="1"> Collects the result of attempting to release the permission + line="31319">Collects the result of attempting to release the permission represented by @permission. This is the second half of the asynchronous version of @@ -84467,42 +85966,46 @@ g_permission_release(). %TRUE if the permission was successfully released + line="31331">%TRUE if the permission was successfully released a #GPermission instance + line="31321">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + line="31322">the #GAsyncResult given to the #GAsyncReadyCallback - + %TRUE if the caller currently has permission to perform the action that + line="2661">%TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform. - + %TRUE if it is generally possible to acquire the permission by calling + line="2669">%TRUE if it is generally possible to acquire the permission by calling g_permission_acquire(). - + %TRUE if it is generally possible to release the permission by calling + line="2677">%TRUE if it is generally possible to release the permission by calling g_permission_release(). @@ -84526,14 +86029,14 @@ g_permission_release(). %TRUE if the permission was successfully acquired + line="31182">%TRUE if the permission was successfully acquired a #GPermission instance + line="31162">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31163">a #GCancellable, or %NULL @@ -84558,7 +86061,7 @@ g_permission_release(). a #GPermission instance + line="31189">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31190">a #GCancellable, or %NULL closure="3"> the #GAsyncReadyCallback to call when done + line="31191">the #GAsyncReadyCallback to call when done closure="3"> the user data to pass to @callback + line="31192">the user data to pass to @callback @@ -84600,20 +86103,20 @@ g_permission_release(). %TRUE if the permission was successfully acquired + line="31215">%TRUE if the permission was successfully acquired a #GPermission instance + line="31205">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + line="31206">the #GAsyncResult given to the #GAsyncReadyCallback @@ -84625,14 +86128,14 @@ g_permission_release(). %TRUE if the permission was successfully released + line="31298">%TRUE if the permission was successfully released a #GPermission instance + line="31278">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31279">a #GCancellable, or %NULL @@ -84657,7 +86160,7 @@ g_permission_release(). a #GPermission instance + line="31305">a #GPermission instance allow-none="1"> a #GCancellable, or %NULL + line="31306">a #GCancellable, or %NULL closure="3"> the #GAsyncReadyCallback to call when done + line="31307">the #GAsyncReadyCallback to call when done closure="3"> the user data to pass to @callback + line="31308">the user data to pass to @callback @@ -84699,20 +86202,20 @@ g_permission_release(). %TRUE if the permission was successfully released + line="31331">%TRUE if the permission was successfully released a #GPermission instance + line="31321">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + line="31322">the #GAsyncResult given to the #GAsyncReadyCallback @@ -84736,7 +86239,7 @@ g_permission_release(). glib:type-struct="PollableInputStreamInterface"> #GPollableInputStream is implemented by #GInputStreams that + line="7576">#GPollableInputStream is implemented by #GInputStreams that can be polled for readiness to read. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. @@ -84745,7 +86248,7 @@ UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. Checks if @stream is actually pollable. Some classes may implement + line="31336">Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableInputStream methods is undefined. @@ -84756,14 +86259,14 @@ a stream cannot switch from pollable to non-pollable or vice versa. %TRUE if @stream is pollable, %FALSE if not. + line="31348">%TRUE if @stream is pollable, %FALSE if not. a #GPollableInputStream. + line="31338">a #GPollableInputStream. @@ -84773,7 +86276,7 @@ a stream cannot switch from pollable to non-pollable or vice versa. version="2.28"> Creates a #GSource that triggers when @stream can be read, or + line="31353">Creates a #GSource that triggers when @stream can be read, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -84785,14 +86288,14 @@ rather than g_input_stream_read() from the callback. a new #GSource + line="31367">a new #GSource a #GPollableInputStream. + line="31355">a #GPollableInputStream. allow-none="1"> a #GCancellable, or %NULL + line="31356">a #GCancellable, or %NULL @@ -84809,7 +86312,7 @@ rather than g_input_stream_read() from the callback. Checks if @stream can be read. + line="31372">Checks if @stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() @@ -84821,7 +86324,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a %TRUE if @stream is readable, %FALSE if not. If an error + line="31385">%TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -84831,7 +86334,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a a #GPollableInputStream. + line="31374">a #GPollableInputStream. @@ -84841,7 +86344,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a throws="1"> Attempts to read up to @count bytes from @stream into @buffer, as + line="31393">Attempts to read up to @count bytes from @stream into @buffer, as with g_input_stream_read(). If @stream is not currently readable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a #GSource @@ -84856,7 +86359,7 @@ to having been cancelled. the number of bytes read, or -1 on error (including + line="31414">the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). @@ -84864,17 +86367,18 @@ to having been cancelled. a #GPollableInputStream + line="31395">a #GPollableInputStream + nullable="1"> a buffer to - read data into (which should be at least @count bytes long). + line="31396">a + buffer to read data into (which should be at least @count bytes long). @@ -84882,7 +86386,7 @@ to having been cancelled. the number of bytes you want to read + line="31398">the number of bytes you want to read @@ -84892,7 +86396,7 @@ to having been cancelled. version="2.28"> Checks if @stream is actually pollable. Some classes may implement + line="31336">Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableInputStream methods is undefined. @@ -84903,14 +86407,14 @@ a stream cannot switch from pollable to non-pollable or vice versa. %TRUE if @stream is pollable, %FALSE if not. + line="31348">%TRUE if @stream is pollable, %FALSE if not. a #GPollableInputStream. + line="31338">a #GPollableInputStream. @@ -84920,7 +86424,7 @@ a stream cannot switch from pollable to non-pollable or vice versa. version="2.28"> Creates a #GSource that triggers when @stream can be read, or + line="31353">Creates a #GSource that triggers when @stream can be read, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -84932,14 +86436,14 @@ rather than g_input_stream_read() from the callback. a new #GSource + line="31367">a new #GSource a #GPollableInputStream. + line="31355">a #GPollableInputStream. allow-none="1"> a #GCancellable, or %NULL + line="31356">a #GCancellable, or %NULL @@ -84958,7 +86462,7 @@ rather than g_input_stream_read() from the callback. version="2.28"> Checks if @stream can be read. + line="31372">Checks if @stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() @@ -84970,7 +86474,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a %TRUE if @stream is readable, %FALSE if not. If an error + line="31385">%TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -84980,7 +86484,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a a #GPollableInputStream. + line="31374">a #GPollableInputStream. @@ -84990,7 +86494,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a throws="1"> Attempts to read up to @count bytes from @stream into @buffer, as + line="31393">Attempts to read up to @count bytes from @stream into @buffer, as with g_input_stream_read(). If @stream is not currently readable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a #GSource @@ -85005,7 +86509,7 @@ to having been cancelled. the number of bytes read, or -1 on error (including + line="31414">the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). @@ -85013,14 +86517,17 @@ to having been cancelled. a #GPollableInputStream + line="31395">a #GPollableInputStream - + a buffer to - read data into (which should be at least @count bytes long). + line="31396">a + buffer to read data into (which should be at least @count bytes long). @@ -85028,7 +86535,7 @@ to having been cancelled. the number of bytes you want to read + line="31398">the number of bytes you want to read allow-none="1"> a #GCancellable, or %NULL + line="31399">a #GCancellable, or %NULL @@ -85072,14 +86579,14 @@ readable. %TRUE if @stream is pollable, %FALSE if not. + line="31348">%TRUE if @stream is pollable, %FALSE if not. a #GPollableInputStream. + line="31338">a #GPollableInputStream. @@ -85091,7 +86598,7 @@ readable. %TRUE if @stream is readable, %FALSE if not. If an error + line="31385">%TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -85101,7 +86608,7 @@ readable. a #GPollableInputStream. + line="31374">a #GPollableInputStream. @@ -85113,14 +86620,14 @@ readable. a new #GSource + line="31367">a new #GSource a #GPollableInputStream. + line="31355">a #GPollableInputStream. allow-none="1"> a #GCancellable, or %NULL + line="31356">a #GCancellable, or %NULL @@ -85141,7 +86648,7 @@ readable. the number of bytes read, or -1 on error (including + line="31414">the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). @@ -85149,17 +86656,18 @@ readable. a #GPollableInputStream + line="31395">a #GPollableInputStream + nullable="1"> a buffer to - read data into (which should be at least @count bytes long). + line="31396">a + buffer to read data into (which should be at least @count bytes long). @@ -85167,7 +86675,7 @@ readable. the number of bytes you want to read + line="31398">the number of bytes you want to read @@ -85183,7 +86691,7 @@ readable. glib:type-struct="PollableOutputStreamInterface"> #GPollableOutputStream is implemented by #GOutputStreams that + line="7591">#GPollableOutputStream is implemented by #GOutputStreams that can be polled for readiness to write. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. @@ -85192,7 +86700,7 @@ UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. Checks if @stream is actually pollable. Some classes may implement + line="31419">Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableOutputStream methods is undefined. @@ -85203,14 +86711,14 @@ a stream cannot switch from pollable to non-pollable or vice versa. %TRUE if @stream is pollable, %FALSE if not. + line="31431">%TRUE if @stream is pollable, %FALSE if not. a #GPollableOutputStream. + line="31421">a #GPollableOutputStream. @@ -85220,7 +86728,7 @@ a stream cannot switch from pollable to non-pollable or vice versa. version="2.28"> Creates a #GSource that triggers when @stream can be written, or + line="31436">Creates a #GSource that triggers when @stream can be written, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -85232,14 +86740,14 @@ rather than g_output_stream_write() from the callback. a new #GSource + line="31450">a new #GSource a #GPollableOutputStream. + line="31438">a #GPollableOutputStream. allow-none="1"> a #GCancellable, or %NULL + line="31439">a #GCancellable, or %NULL @@ -85256,7 +86764,7 @@ rather than g_output_stream_write() from the callback. Checks if @stream can be written. + line="31455">Checks if @stream can be written. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_output_stream_write() @@ -85268,7 +86776,7 @@ g_pollable_output_stream_write_nonblocking(), which will return a %TRUE if @stream is writable, %FALSE if not. If an error + line="31468">%TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -85278,7 +86786,7 @@ g_pollable_output_stream_write_nonblocking(), which will return a a #GPollableOutputStream. + line="31457">a #GPollableOutputStream. @@ -85288,7 +86796,7 @@ g_pollable_output_stream_write_nonblocking(), which will return a throws="1"> Attempts to write up to @count bytes from @buffer to @stream, as + line="31476">Attempts to write up to @count bytes from @buffer to @stream, as with g_output_stream_write(). If @stream is not currently writable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -85307,7 +86815,7 @@ transports like D/TLS require that you re-send the same @buffer and the number of bytes written, or -1 on error (including + line="31501">the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). @@ -85315,7 +86823,7 @@ transports like D/TLS require that you re-send the same @buffer and a #GPollableOutputStream + line="31478">a #GPollableOutputStream a buffer to write + line="31479">a buffer to write data from @@ -85333,7 +86841,7 @@ transports like D/TLS require that you re-send the same @buffer and the number of bytes you want to write + line="31481">the number of bytes you want to write @@ -85344,7 +86852,7 @@ transports like D/TLS require that you re-send the same @buffer and throws="1"> Attempts to write the bytes contained in the @n_vectors @vectors to @stream, + line="31506">Attempts to write the bytes contained in the @n_vectors @vectors to @stream, as with g_output_stream_writev(). If @stream is not currently writable, this will immediately return %@G_POLLABLE_RETURN_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -85364,7 +86872,7 @@ transports like D/TLS require that you re-send the same @vectors and %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + line="31533">%@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -85374,13 +86882,13 @@ be set. a #GPollableOutputStream + line="31508">a #GPollableOutputStream the buffer containing the #GOutputVectors to write. + line="31509">the buffer containing the #GOutputVectors to write. @@ -85390,7 +86898,7 @@ be set. the number of vectors to write + line="31510">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="31511">location to store the number of bytes that were written to the stream @@ -85412,7 +86920,7 @@ be set. version="2.28"> Checks if @stream is actually pollable. Some classes may implement + line="31419">Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableOutputStream methods is undefined. @@ -85423,14 +86931,14 @@ a stream cannot switch from pollable to non-pollable or vice versa. %TRUE if @stream is pollable, %FALSE if not. + line="31431">%TRUE if @stream is pollable, %FALSE if not. a #GPollableOutputStream. + line="31421">a #GPollableOutputStream. @@ -85440,7 +86948,7 @@ a stream cannot switch from pollable to non-pollable or vice versa. version="2.28"> Creates a #GSource that triggers when @stream can be written, or + line="31436">Creates a #GSource that triggers when @stream can be written, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -85452,14 +86960,14 @@ rather than g_output_stream_write() from the callback. a new #GSource + line="31450">a new #GSource a #GPollableOutputStream. + line="31438">a #GPollableOutputStream. allow-none="1"> a #GCancellable, or %NULL + line="31439">a #GCancellable, or %NULL @@ -85478,7 +86986,7 @@ rather than g_output_stream_write() from the callback. version="2.28"> Checks if @stream can be written. + line="31455">Checks if @stream can be written. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_output_stream_write() @@ -85490,7 +86998,7 @@ g_pollable_output_stream_write_nonblocking(), which will return a %TRUE if @stream is writable, %FALSE if not. If an error + line="31468">%TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -85500,7 +87008,7 @@ g_pollable_output_stream_write_nonblocking(), which will return a a #GPollableOutputStream. + line="31457">a #GPollableOutputStream. @@ -85510,7 +87018,7 @@ g_pollable_output_stream_write_nonblocking(), which will return a throws="1"> Attempts to write up to @count bytes from @buffer to @stream, as + line="31476">Attempts to write up to @count bytes from @buffer to @stream, as with g_output_stream_write(). If @stream is not currently writable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -85529,7 +87037,7 @@ transports like D/TLS require that you re-send the same @buffer and the number of bytes written, or -1 on error (including + line="31501">the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). @@ -85537,13 +87045,13 @@ transports like D/TLS require that you re-send the same @buffer and a #GPollableOutputStream + line="31478">a #GPollableOutputStream a buffer to write + line="31479">a buffer to write data from @@ -85552,7 +87060,7 @@ transports like D/TLS require that you re-send the same @buffer and the number of bytes you want to write + line="31481">the number of bytes you want to write a #GCancellable, or %NULL + line="31482">a #GCancellable, or %NULL @@ -85572,7 +87080,7 @@ transports like D/TLS require that you re-send the same @buffer and throws="1"> Attempts to write the bytes contained in the @n_vectors @vectors to @stream, + line="31506">Attempts to write the bytes contained in the @n_vectors @vectors to @stream, as with g_output_stream_writev(). If @stream is not currently writable, this will immediately return %@G_POLLABLE_RETURN_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -85592,7 +87100,7 @@ transports like D/TLS require that you re-send the same @vectors and %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + line="31533">%@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -85602,13 +87110,13 @@ be set. a #GPollableOutputStream + line="31508">a #GPollableOutputStream the buffer containing the #GOutputVectors to write. + line="31509">the buffer containing the #GOutputVectors to write. @@ -85618,7 +87126,7 @@ be set. the number of vectors to write + line="31510">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="31511">location to store the number of bytes that were written to the stream @@ -85639,7 +87147,7 @@ be set. allow-none="1"> a #GCancellable, or %NULL + line="31513">a #GCancellable, or %NULL @@ -85680,14 +87188,14 @@ override this where possible to avoid having to allocate a #GError to return %TRUE if @stream is pollable, %FALSE if not. + line="31431">%TRUE if @stream is pollable, %FALSE if not. a #GPollableOutputStream. + line="31421">a #GPollableOutputStream. @@ -85700,7 +87208,7 @@ override this where possible to avoid having to allocate a #GError to return %TRUE if @stream is writable, %FALSE if not. If an error + line="31468">%TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -85710,7 +87218,7 @@ override this where possible to avoid having to allocate a #GError to return a #GPollableOutputStream. + line="31457">a #GPollableOutputStream. @@ -85723,14 +87231,14 @@ override this where possible to avoid having to allocate a #GError to return a new #GSource + line="31450">a new #GSource a #GPollableOutputStream. + line="31438">a #GPollableOutputStream. @@ -85740,7 +87248,7 @@ override this where possible to avoid having to allocate a #GError to return allow-none="1"> a #GCancellable, or %NULL + line="31439">a #GCancellable, or %NULL @@ -85752,7 +87260,7 @@ override this where possible to avoid having to allocate a #GError to return the number of bytes written, or -1 on error (including + line="31501">the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). @@ -85760,7 +87268,7 @@ override this where possible to avoid having to allocate a #GError to return a #GPollableOutputStream + line="31478">a #GPollableOutputStream @@ -85770,7 +87278,7 @@ override this where possible to avoid having to allocate a #GError to return allow-none="1"> a buffer to write + line="31479">a buffer to write data from @@ -85779,7 +87287,7 @@ override this where possible to avoid having to allocate a #GError to return the number of bytes you want to write + line="31481">the number of bytes you want to write @@ -85791,7 +87299,7 @@ override this where possible to avoid having to allocate a #GError to return %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + line="31533">%@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -85801,14 +87309,14 @@ be set. a #GPollableOutputStream + line="31508">a #GPollableOutputStream the buffer containing the #GOutputVectors to write. + line="31509">the buffer containing the #GOutputVectors to write. @@ -85818,7 +87326,7 @@ be set. the number of vectors to write + line="31510">the number of vectors to write allow-none="1"> location to store the number of bytes that were + line="31511">location to store the number of bytes that were written to the stream @@ -85844,7 +87352,7 @@ be set. c:type="GPollableReturn"> Return value for various IO operations that signal errors via the + line="2051">Return value for various IO operations that signal errors via the return value and not necessarily via a #GError. This enum exists to be able to return errors to callers without having to @@ -85856,26 +87364,29 @@ operation to give details about the error that happened. + glib:nick="failed" + glib:name="G_POLLABLE_RETURN_FAILED"> Generic error condition for when an operation fails. + line="2053">Generic error condition for when an operation fails. + glib:nick="ok" + glib:name="G_POLLABLE_RETURN_OK"> The operation was successfully finished. + line="2054">The operation was successfully finished. + glib:nick="would-block" + glib:name="G_POLLABLE_RETURN_WOULD_BLOCK"> The operation would block. + line="2055">The operation would block. version="2.28"> This is the function type of the callback used for the #GSource + line="586">This is the function type of the callback used for the #GSource returned by g_pollable_input_stream_create_source() and g_pollable_output_stream_create_source(). - + it should return %FALSE if the source should be removed. + line="595">it should return %FALSE if the source should be removed. the #GPollableInputStream or #GPollableOutputStream + line="588">the #GPollableInputStream or #GPollableOutputStream closure="1"> data passed in by the user. + line="589">data passed in by the user. + + #GPowerProfileMonitor makes it possible for applications as well as OS components +to monitor system power profiles and act upon them. It currently only exports +whether the system is in “Power Saver” mode (known as “Low Power” mode on +some systems). + +When in “Low Power” mode, it is recommended that applications: +- disabling automatic downloads +- reduce the rate of refresh from online sources such as calendar or + email synchronisation +- if the application has expensive visual effects, reduce them + +It is also likely that OS components providing services to applications will +lower their own background activity, for the sake of the system. + +There are a variety of tools that exist for power consumption analysis, but those +usually depend on the OS and hardware used. On Linux, one could use `upower` to +monitor the battery discharge rate, `powertop` to check on the background activity +or activity at all), `sysprof` to inspect CPU usage, and `intel_gpu_time` to +profile GPU usage. + +Don't forget to disconnect the #GPowerProfileMonitor::notify::power-saver-enabled +signal, and unref the #GPowerProfileMonitor itself when exiting. + + + + Gets a reference to the default #GPowerProfileMonitor for the system. + + + a new reference to the default #GPowerProfileMonitor + + + + + Gets whether the system is in “Power Saver” mode. + +You are expected to listen to the +#GPowerProfileMonitor::notify::power-saver-enabled signal to know when the profile has +changed. + + + Whether the system is in “Power Saver” mode. + + + + + a #GPowerProfileMonitor + + + + + + Whether “Power Saver” mode is enabled on the system. + + + + + The virtual function table for #GPowerProfileMonitor. + + + The parent interface. + + + glib:get-type="g_property_action_get_type"> A #GPropertyAction is a way to get a #GAction with a state value + line="7649">A #GPropertyAction is a way to get a #GAction with a state value reflecting and controlling the value of a #GObject property. The state of the action will correspond to the value of the property. @@ -85978,7 +87588,7 @@ combine its use with g_settings_bind(). version="2.38"> Creates a #GAction corresponding to the value of property + line="31685">Creates a #GAction corresponding to the value of property @property_name on @object. The property must be existent and readable and writable (and not @@ -85990,27 +87600,27 @@ until the action is destroyed. a new #GPropertyAction + line="31701">a new #GPropertyAction the name of the action to create + line="31687">the name of the action to create the object that has the property + line="31688">the object that has the property to wrap the name of the property + line="31690">the name of the property @@ -86018,7 +87628,7 @@ until the action is destroyed. If @action is currently enabled. + line="2723">If @action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. @@ -86031,7 +87641,7 @@ g_action_change_state() have no effect. transfer-ownership="none"> If %TRUE, the state of the action will be the negation of the + line="2735">If %TRUE, the state of the action will be the negation of the property value, provided the property is boolean. @@ -86042,7 +87652,7 @@ property value, provided the property is boolean. transfer-ownership="none"> The name of the action. This is mostly meaningful for identifying + line="2745">The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GActionMap. @@ -86054,7 +87664,7 @@ the action once it has been added to a #GActionMap. transfer-ownership="none"> The object to wrap a property on. + line="2755">The object to wrap a property on. The object must be a non-%NULL #GObject with properties. @@ -86062,7 +87672,7 @@ The object must be a non-%NULL #GObject with properties. The type of the parameter that must be given when activating the + line="2766">The type of the parameter that must be given when activating the action. @@ -86074,7 +87684,7 @@ action. transfer-ownership="none"> The name of the property to wrap on the object. + line="2776">The name of the property to wrap on the object. The property must exist on the passed-in object and it must be readable and writable (and not construct-only). @@ -86083,13 +87693,13 @@ readable and writable (and not construct-only). The state of the action, or %NULL if the action is stateless. + line="2788">The state of the action, or %NULL if the action is stateless. The #GVariantType of the state that the action has, or %NULL if the + line="2797">The #GVariantType of the state that the action has, or %NULL if the action is stateless. @@ -86103,7 +87713,7 @@ action is stateless. glib:type-struct="ProxyInterface"> A #GProxy handles connecting to a remote host via a given type of + line="7711">A #GProxy handles connecting to a remote host via a given type of proxy server. It is implemented by the 'gio-proxy' extension point. The extensions are named after their proxy protocol name. As an example, a SOCKS5 proxy implementation can be retrieved with the @@ -86115,13 +87725,13 @@ g_io_extension_point_get_extension_by_name(). version="2.26"> Find the `gio-proxy` extension point for a proxy implementation that supports + line="31860">Find the `gio-proxy` extension point for a proxy implementation that supports the specified protocol. - + return a #GProxy or NULL if protocol + line="31867">return a #GProxy or NULL if protocol is not supported. @@ -86129,7 +87739,7 @@ the specified protocol. the proxy protocol name (e.g. http, socks, etc) + line="31862">the proxy protocol name (e.g. http, socks, etc) @@ -86140,7 +87750,7 @@ the specified protocol. throws="1"> Given @connection to communicate with a proxy (eg, a + line="31812">Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload. @@ -86148,7 +87758,7 @@ required, wraps the #GIOStream to handle proxy payload. a #GIOStream that will replace @connection. This might + line="31825">a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. @@ -86157,19 +87767,19 @@ required, wraps the #GIOStream to handle proxy payload. a #GProxy + line="31814">a #GProxy a #GIOStream + line="31815">a #GIOStream a #GProxyAddress + line="31816">a #GProxyAddress allow-none="1"> a #GCancellable + line="31817">a #GCancellable @@ -86188,7 +87798,7 @@ required, wraps the #GIOStream to handle proxy payload. version="2.26"> Asynchronous version of g_proxy_connect(). + line="31832">Asynchronous version of g_proxy_connect(). @@ -86197,19 +87807,19 @@ required, wraps the #GIOStream to handle proxy payload. a #GProxy + line="31834">a #GProxy a #GIOStream + line="31835">a #GIOStream a #GProxyAddress + line="31836">a #GProxyAddress allow-none="1"> a #GCancellable + line="31837">a #GCancellable closure="4"> a #GAsyncReadyCallback + line="31838">a #GAsyncReadyCallback closure="4"> callback data + line="31839">callback data @@ -86250,25 +87860,25 @@ required, wraps the #GIOStream to handle proxy payload. throws="1"> See g_proxy_connect(). + line="31847">See g_proxy_connect(). a #GIOStream. + line="31855">a #GIOStream. a #GProxy + line="31849">a #GProxy a #GAsyncResult + line="31850">a #GAsyncResult @@ -86278,7 +87888,7 @@ required, wraps the #GIOStream to handle proxy payload. version="2.26"> Some proxy protocols expect to be passed a hostname, which they + line="31959">Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return %FALSE if @proxy is implementing such a protocol. When %FALSE is returned, the caller @@ -86289,14 +87899,14 @@ g_proxy_connect() or g_proxy_connect_async(). %TRUE if hostname resolution is supported. + line="31971">%TRUE if hostname resolution is supported. a #GProxy + line="31961">a #GProxy @@ -86307,7 +87917,7 @@ g_proxy_connect() or g_proxy_connect_async(). throws="1"> Given @connection to communicate with a proxy (eg, a + line="31812">Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload. @@ -86315,7 +87925,7 @@ required, wraps the #GIOStream to handle proxy payload. a #GIOStream that will replace @connection. This might + line="31825">a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. @@ -86324,19 +87934,19 @@ required, wraps the #GIOStream to handle proxy payload. a #GProxy + line="31814">a #GProxy a #GIOStream + line="31815">a #GIOStream a #GProxyAddress + line="31816">a #GProxyAddress allow-none="1"> a #GCancellable + line="31817">a #GCancellable @@ -86355,7 +87965,7 @@ required, wraps the #GIOStream to handle proxy payload. version="2.26"> Asynchronous version of g_proxy_connect(). + line="31832">Asynchronous version of g_proxy_connect(). @@ -86364,19 +87974,19 @@ required, wraps the #GIOStream to handle proxy payload. a #GProxy + line="31834">a #GProxy a #GIOStream + line="31835">a #GIOStream a #GProxyAddress + line="31836">a #GProxyAddress allow-none="1"> a #GCancellable + line="31837">a #GCancellable closure="4"> a #GAsyncReadyCallback + line="31838">a #GAsyncReadyCallback allow-none="1"> callback data + line="31839">callback data @@ -86416,25 +88026,25 @@ required, wraps the #GIOStream to handle proxy payload. throws="1"> See g_proxy_connect(). + line="31847">See g_proxy_connect(). a #GIOStream. + line="31855">a #GIOStream. a #GProxy + line="31849">a #GProxy a #GAsyncResult + line="31850">a #GAsyncResult @@ -86444,7 +88054,7 @@ required, wraps the #GIOStream to handle proxy payload. version="2.26"> Some proxy protocols expect to be passed a hostname, which they + line="31959">Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return %FALSE if @proxy is implementing such a protocol. When %FALSE is returned, the caller @@ -86455,14 +88065,14 @@ g_proxy_connect() or g_proxy_connect_async(). %TRUE if hostname resolution is supported. + line="31971">%TRUE if hostname resolution is supported. a #GProxy + line="31961">a #GProxy @@ -86478,7 +88088,7 @@ g_proxy_connect() or g_proxy_connect_async(). glib:type-struct="ProxyAddressClass"> Support for proxied #GInetSocketAddress. + line="7727">Support for proxied #GInetSocketAddress. version="2.26"> Creates a new #GProxyAddress for @inetaddr with @protocol that should + line="31788">Creates a new #GProxyAddress for @inetaddr with @protocol that should tunnel through @dest_hostname and @dest_port. (Note that this method doesn't set the #GProxyAddress:uri or @@ -86496,38 +88106,38 @@ directly if you want to set those.) a new #GProxyAddress + line="31807">a new #GProxyAddress The proxy server #GInetAddress. + line="31790">The proxy server #GInetAddress. The proxy server port. + line="31791">The proxy server port. The proxy protocol to support, in lower case (e.g. socks, http). + line="31792">The proxy protocol to support, in lower case (e.g. socks, http). The destination hostname the proxy should tunnel to. + line="31793">The destination hostname the proxy should tunnel to. The destination port to tunnel to. + line="31794">The destination port to tunnel to. allow-none="1"> The username to authenticate to the proxy server + line="31795">The username to authenticate to the proxy server (or %NULL). @@ -86546,7 +88156,7 @@ directly if you want to set those.) allow-none="1"> The password to authenticate to the proxy server + line="31797">The password to authenticate to the proxy server (or %NULL). @@ -86554,159 +88164,166 @@ directly if you want to set those.) Gets @proxy's destination hostname; that is, the name of the host + line="31706">Gets @proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself. the @proxy's destination hostname + line="31714">the @proxy's destination hostname a #GProxyAddress + line="31708">a #GProxyAddress Gets @proxy's destination port; that is, the port on the + line="31719">Gets @proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself. the @proxy's destination port + line="31727">the @proxy's destination port a #GProxyAddress + line="31721">a #GProxyAddress Gets the protocol that is being spoken to the destination + line="31732">Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp". the @proxy's destination protocol + line="31739">the @proxy's destination protocol a #GProxyAddress + line="31734">a #GProxyAddress Gets @proxy's password. + line="31744">Gets @proxy's password. - + the @proxy's password + line="31750">the @proxy's password a #GProxyAddress + line="31746">a #GProxyAddress Gets @proxy's protocol. eg, "socks" or "http" + line="31755">Gets @proxy's protocol. eg, "socks" or "http" the @proxy's protocol + line="31761">the @proxy's protocol a #GProxyAddress + line="31757">a #GProxyAddress Gets the proxy URI that @proxy was constructed from. + line="31766">Gets the proxy URI that @proxy was constructed from. - + the @proxy's URI, or %NULL if unknown + line="31772">the @proxy's URI, or %NULL if unknown a #GProxyAddress + line="31768">a #GProxyAddress Gets @proxy's username. + line="31777">Gets @proxy's username. - + the @proxy's username + line="31783">the @proxy's username a #GProxyAddress + line="31779">a #GProxyAddress @@ -86714,53 +88331,60 @@ server; eg, "http" or "ftp". + transfer-ownership="none" + getter="get_destination_hostname"> + transfer-ownership="none" + getter="get_destination_port"> + transfer-ownership="none" + getter="get_destination_protocol"> The protocol being spoke to the destination host, or %NULL if + line="2816">The protocol being spoke to the destination host, or %NULL if the #GProxyAddress doesn't know. + transfer-ownership="none" + getter="get_password"> + transfer-ownership="none" + getter="get_protocol"> + transfer-ownership="none" + getter="get_uri"> The URI string that the proxy was constructed from (or %NULL + line="2826">The URI string that the proxy was constructed from (or %NULL if the creator didn't specify this). + transfer-ownership="none" + getter="get_username"> @@ -86776,7 +88400,7 @@ if the creator didn't specify this). version="2.26"> Class structure for #GProxyAddress. + line="2836">Class structure for #GProxyAddress. @@ -86791,7 +88415,7 @@ if the creator didn't specify this). glib:type-struct="ProxyAddressEnumeratorClass"> #GProxyAddressEnumerator is a wrapper around #GSocketAddressEnumerator which + line="7736">#GProxyAddressEnumerator is a wrapper around #GSocketAddressEnumerator which takes the #GSocketAddress instances returned by the #GSocketAddressEnumerator and wraps them in #GProxyAddress instances, using the given #GProxyAddressEnumerator:proxy-resolver. @@ -86814,7 +88438,7 @@ with one. transfer-ownership="none"> The default port to use if #GProxyAddressEnumerator:uri does not + line="2845">The default port to use if #GProxyAddressEnumerator:uri does not specify one. @@ -86825,7 +88449,7 @@ specify one. transfer-ownership="none"> The proxy resolver to use. + line="2855">The proxy resolver to use. a #GIOStream that will replace @connection. This might + line="31825">a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. @@ -86950,19 +88574,19 @@ specify one. a #GProxy + line="31814">a #GProxy a #GIOStream + line="31815">a #GIOStream a #GProxyAddress + line="31816">a #GProxyAddress allow-none="1"> a #GCancellable + line="31817">a #GCancellable @@ -86987,19 +88611,19 @@ specify one. a #GProxy + line="31834">a #GProxy a #GIOStream + line="31835">a #GIOStream a #GProxyAddress + line="31836">a #GProxyAddress allow-none="1"> a #GCancellable + line="31837">a #GCancellable closure="5"> a #GAsyncReadyCallback + line="31838">a #GAsyncReadyCallback closure="5"> callback data + line="31839">callback data @@ -87041,20 +88665,20 @@ specify one. a #GIOStream. + line="31855">a #GIOStream. a #GProxy + line="31849">a #GProxy a #GAsyncResult + line="31850">a #GAsyncResult @@ -87066,14 +88690,14 @@ specify one. %TRUE if hostname resolution is supported. + line="31971">%TRUE if hostname resolution is supported. a #GProxy + line="31961">a #GProxy @@ -87089,7 +88713,7 @@ specify one. glib:type-struct="ProxyResolverInterface"> #GProxyResolver provides synchronous and asynchronous network proxy + line="7753">#GProxyResolver provides synchronous and asynchronous network proxy resolution. #GProxyResolver is used within #GSocketClient through the method g_socket_connectable_proxy_enumerate(). @@ -87102,12 +88726,13 @@ Flatpak portals. version="2.26"> Gets the default #GProxyResolver for the system. + line="31873">Gets the default #GProxyResolver for the system. the default #GProxyResolver. + line="31878">the default #GProxyResolver, which + will be a dummy object if no proxy resolver is available @@ -87116,21 +88741,21 @@ Flatpak portals. version="2.26"> Checks if @resolver can be used on this system. (This is used + line="31884">Checks if @resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns %TRUE for this method.) %TRUE if @resolver is supported. + line="31892">%TRUE if @resolver is supported. a #GProxyResolver + line="31886">a #GProxyResolver @@ -87138,7 +88763,7 @@ resolver that returns %TRUE for this method.) Looks into the system proxy configuration to determine what proxy, + line="31897">Looks into the system proxy configuration to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the form `<protocol>://[user[:password]@]host:port` or `direct://`, where <protocol> could be http, rtsp, socks @@ -87157,7 +88782,7 @@ returned array of proxies. A + line="31920">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -87168,13 +88793,13 @@ returned array of proxies. a #GProxyResolver + line="31899">a #GProxyResolver a URI representing the destination to connect to + line="31900">a URI representing the destination to connect to allow-none="1"> a #GCancellable, or %NULL + line="31901">a #GCancellable, or %NULL @@ -87193,7 +88818,7 @@ returned array of proxies. version="2.26"> Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more + line="31927">Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details. @@ -87203,13 +88828,13 @@ details. a #GProxyResolver + line="31929">a #GProxyResolver a URI representing the destination to connect to + line="31930">a URI representing the destination to connect to allow-none="1"> a #GCancellable, or %NULL + line="31931">a #GCancellable, or %NULL closure="3"> callback to call after resolution completes + line="31932">callback to call after resolution completes closure="3"> data for @callback + line="31933">data for @callback @@ -87250,14 +88875,14 @@ details. throws="1"> Call this function to obtain the array of proxy URIs when + line="31942">Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details. A + line="31952">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -87268,13 +88893,13 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + line="31944">a #GProxyResolver the result passed to your #GAsyncReadyCallback + line="31945">the result passed to your #GAsyncReadyCallback @@ -87284,21 +88909,21 @@ g_proxy_resolver_lookup() for more details. version="2.26"> Checks if @resolver can be used on this system. (This is used + line="31884">Checks if @resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns %TRUE for this method.) %TRUE if @resolver is supported. + line="31892">%TRUE if @resolver is supported. a #GProxyResolver + line="31886">a #GProxyResolver @@ -87309,7 +88934,7 @@ resolver that returns %TRUE for this method.) throws="1"> Looks into the system proxy configuration to determine what proxy, + line="31897">Looks into the system proxy configuration to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the form `<protocol>://[user[:password]@]host:port` or `direct://`, where <protocol> could be http, rtsp, socks @@ -87328,7 +88953,7 @@ returned array of proxies. A + line="31920">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -87339,13 +88964,13 @@ returned array of proxies. a #GProxyResolver + line="31899">a #GProxyResolver a URI representing the destination to connect to + line="31900">a URI representing the destination to connect to allow-none="1"> a #GCancellable, or %NULL + line="31901">a #GCancellable, or %NULL @@ -87364,7 +88989,7 @@ returned array of proxies. version="2.26"> Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more + line="31927">Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details. @@ -87374,13 +88999,13 @@ details. a #GProxyResolver + line="31929">a #GProxyResolver a URI representing the destination to connect to + line="31930">a URI representing the destination to connect to allow-none="1"> a #GCancellable, or %NULL + line="31931">a #GCancellable, or %NULL closure="3"> callback to call after resolution completes + line="31932">callback to call after resolution completes allow-none="1"> data for @callback + line="31933">data for @callback @@ -87420,14 +89045,14 @@ details. throws="1"> Call this function to obtain the array of proxy URIs when + line="31942">Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details. A + line="31952">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -87438,13 +89063,13 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + line="31944">a #GProxyResolver the result passed to your #GAsyncReadyCallback + line="31945">the result passed to your #GAsyncReadyCallback @@ -87455,12 +89080,12 @@ g_proxy_resolver_lookup() for more details. glib:is-gtype-struct-for="ProxyResolver"> The virtual function table for #GProxyResolver. + line="2864">The virtual function table for #GProxyResolver. The parent interface. + line="2866">The parent interface. @@ -87469,14 +89094,14 @@ g_proxy_resolver_lookup() for more details. %TRUE if @resolver is supported. + line="31892">%TRUE if @resolver is supported. a #GProxyResolver + line="31886">a #GProxyResolver @@ -87488,7 +89113,7 @@ g_proxy_resolver_lookup() for more details. A + line="31920">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -87499,13 +89124,13 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + line="31899">a #GProxyResolver a URI representing the destination to connect to + line="31900">a URI representing the destination to connect to allow-none="1"> a #GCancellable, or %NULL + line="31901">a #GCancellable, or %NULL @@ -87530,13 +89155,13 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + line="31929">a #GProxyResolver a URI representing the destination to connect to + line="31930">a URI representing the destination to connect to allow-none="1"> a #GCancellable, or %NULL + line="31931">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="31932">callback to call after resolution completes closure="4"> data for @callback + line="31933">data for @callback @@ -87578,7 +89203,7 @@ g_proxy_resolver_lookup() for more details. A + line="31952">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -87589,13 +89214,13 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + line="31944">a #GProxyResolver the result passed to your #GAsyncReadyCallback + line="31945">the result passed to your #GAsyncReadyCallback @@ -87688,7 +89313,7 @@ The function should have the same semantics as realloc(). glib:type-struct="RemoteActionGroupInterface"> The GRemoteActionGroup interface is implemented by #GActionGroup + line="7768">The GRemoteActionGroup interface is implemented by #GActionGroup instances that either transmit action invocations to other processes or receive action invocations in the local process from other processes. @@ -87716,7 +89341,7 @@ invocations that arrive by way of D-Bus. version="2.32"> Activates the remote action. + line="31976">Activates the remote action. This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the @@ -87733,13 +89358,13 @@ interaction timestamp or startup notification information. a #GDBusActionGroup + line="31978">a #GDBusActionGroup the name of the action to activate + line="31979">the name of the action to activate the optional parameter to the activation + line="31980">the optional parameter to the activation the platform data to send + line="31981">the platform data to send @@ -87764,7 +89389,7 @@ interaction timestamp or startup notification information. version="2.32"> Changes the state of a remote action. + line="31997">Changes the state of a remote action. This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the @@ -87781,25 +89406,25 @@ user interaction timestamp or startup notification information. a #GRemoteActionGroup + line="31999">a #GRemoteActionGroup the name of the action to change the state of + line="32000">the name of the action to change the state of the new requested value for the state + line="32001">the new requested value for the state the platform data to send + line="32002">the platform data to send @@ -87809,7 +89434,7 @@ user interaction timestamp or startup notification information. version="2.32"> Activates the remote action. + line="31976">Activates the remote action. This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the @@ -87826,13 +89451,13 @@ interaction timestamp or startup notification information. a #GDBusActionGroup + line="31978">a #GDBusActionGroup the name of the action to activate + line="31979">the name of the action to activate the optional parameter to the activation + line="31980">the optional parameter to the activation the platform data to send + line="31981">the platform data to send @@ -87857,7 +89482,7 @@ interaction timestamp or startup notification information. version="2.32"> Changes the state of a remote action. + line="31997">Changes the state of a remote action. This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the @@ -87874,25 +89499,25 @@ user interaction timestamp or startup notification information. a #GRemoteActionGroup + line="31999">a #GRemoteActionGroup the name of the action to change the state of + line="32000">the name of the action to change the state of the new requested value for the state + line="32001">the new requested value for the state the platform data to send + line="32002">the platform data to send @@ -87904,7 +89529,7 @@ user interaction timestamp or startup notification information. version="2.32"> The virtual function table for #GRemoteActionGroup. + line="2886">The virtual function table for #GRemoteActionGroup. @@ -87919,13 +89544,13 @@ user interaction timestamp or startup notification information. a #GDBusActionGroup + line="31978">a #GDBusActionGroup the name of the action to activate + line="31979">the name of the action to activate the optional parameter to the activation + line="31980">the optional parameter to the activation the platform data to send + line="31981">the platform data to send @@ -87956,25 +89581,25 @@ user interaction timestamp or startup notification information. a #GRemoteActionGroup + line="31999">a #GRemoteActionGroup the name of the action to change the state of + line="32000">the name of the action to change the state of the new requested value for the state + line="32001">the new requested value for the state the platform data to send + line="32002">the platform data to send @@ -87991,7 +89616,7 @@ user interaction timestamp or startup notification information. glib:type-struct="ResolverClass"> #GResolver provides cancellable synchronous and asynchronous DNS + line="7800">#GResolver provides cancellable synchronous and asynchronous DNS resolution, for hostnames (g_resolver_lookup_by_address(), g_resolver_lookup_by_name() and their async variants) and SRV (service) records (g_resolver_lookup_service()). @@ -88006,7 +89631,7 @@ making it easy to connect to a remote host/service. introspectable="0"> Frees @addresses (which should be the return value from + line="32028">Frees @addresses (which should be the return value from g_resolver_lookup_by_name() or g_resolver_lookup_by_name_finish()). (This is a convenience method; you can also simply free the results by hand.) @@ -88018,7 +89643,7 @@ by hand.) a #GList of #GInetAddress + line="32030">a #GList of #GInetAddress @@ -88031,7 +89656,7 @@ by hand.) introspectable="0"> Frees @targets (which should be the return value from + line="32041">Frees @targets (which should be the return value from g_resolver_lookup_service() or g_resolver_lookup_service_finish()). (This is a convenience method; you can also simply free the results by hand.) @@ -88043,7 +89668,7 @@ results by hand.) a #GList of #GSrvTarget + line="32043">a #GList of #GSrvTarget @@ -88055,14 +89680,14 @@ results by hand.) version="2.22"> Gets the default #GResolver. You should unref it when you are done + line="32054">Gets the default #GResolver. You should unref it when you are done with it. #GResolver may use its reference count as a hint about how many threads it should allocate for concurrent DNS resolutions. the default #GResolver. + line="32061">the default #GResolver. @@ -88072,7 +89697,7 @@ many threads it should allocate for concurrent DNS resolutions. throws="1"> Synchronously reverse-resolves @address to determine its + line="32066">Synchronously reverse-resolves @address to determine its associated hostname. If the DNS resolution fails, @error (if non-%NULL) will be set to @@ -88085,7 +89710,7 @@ operation, in which case @error (if non-%NULL) will be set to a hostname (either ASCII-only, or in ASCII-encoded + line="32083">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. @@ -88093,13 +89718,13 @@ operation, in which case @error (if non-%NULL) will be set to a #GResolver + line="32068">a #GResolver the address to reverse-resolve + line="32069">the address to reverse-resolve a #GCancellable, or %NULL + line="32070">a #GCancellable, or %NULL @@ -88118,7 +89743,7 @@ operation, in which case @error (if non-%NULL) will be set to version="2.22"> Begins asynchronously reverse-resolving @address to determine its + line="32089">Begins asynchronously reverse-resolving @address to determine its associated hostname, and eventually calls @callback, which must call g_resolver_lookup_by_address_finish() to get the final result. @@ -88129,13 +89754,13 @@ call g_resolver_lookup_by_address_finish() to get the final result. a #GResolver + line="32091">a #GResolver the address to reverse-resolve + line="32092">the address to reverse-resolve allow-none="1"> a #GCancellable, or %NULL + line="32093">a #GCancellable, or %NULL closure="3"> callback to call after resolution completes + line="32094">callback to call after resolution completes closure="3"> data for @callback + line="32095">data for @callback @@ -88176,7 +89801,7 @@ call g_resolver_lookup_by_address_finish() to get the final result. throws="1"> Retrieves the result of a previous call to + line="32105">Retrieves the result of a previous call to g_resolver_lookup_by_address_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -88186,7 +89811,7 @@ a value from #GResolverError. If the operation was cancelled, a hostname (either ASCII-only, or in ASCII-encoded + line="32118">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. @@ -88194,13 +89819,13 @@ form), or %NULL on error. a #GResolver + line="32107">a #GResolver the result passed to your #GAsyncReadyCallback + line="32108">the result passed to your #GAsyncReadyCallback @@ -88211,7 +89836,7 @@ form), or %NULL on error. throws="1"> Synchronously resolves @hostname to determine its associated IP + line="32124">Synchronously resolves @hostname to determine its associated IP address(es). @hostname may be an ASCII-only or UTF-8 hostname, or the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()). @@ -88238,7 +89863,7 @@ address, it may be easier to create a #GNetworkAddress and use its a non-empty #GList + line="32155">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -88250,13 +89875,13 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32126">a #GResolver the hostname to look up + line="32127">the hostname to look up allow-none="1"> a #GCancellable, or %NULL + line="32128">a #GCancellable, or %NULL @@ -88275,7 +89900,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) version="2.22"> Begins asynchronously resolving @hostname to determine its + line="32163">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -88287,13 +89912,13 @@ See g_resolver_lookup_by_name() for more details. a #GResolver + line="32165">a #GResolver the hostname to look up the address of + line="32166">the hostname to look up the address of allow-none="1"> a #GCancellable, or %NULL + line="32167">a #GCancellable, or %NULL closure="3"> callback to call after resolution completes + line="32168">callback to call after resolution completes closure="3"> data for @callback + line="32169">data for @callback @@ -88334,7 +89959,7 @@ See g_resolver_lookup_by_name() for more details. throws="1"> Retrieves the result of a call to + line="32180">Retrieves the result of a call to g_resolver_lookup_by_name_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -88344,7 +89969,7 @@ a value from #GResolverError. If the operation was cancelled, a #GList + line="32193">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -88355,13 +89980,13 @@ for more details. a #GResolver + line="32182">a #GResolver the result passed to your #GAsyncReadyCallback + line="32183">the result passed to your #GAsyncReadyCallback @@ -88372,14 +89997,14 @@ for more details. throws="1"> This differs from g_resolver_lookup_by_name() in that you can modify + line="32200">This differs from g_resolver_lookup_by_name() in that you can modify the lookup behavior with @flags. For example this can be used to limit results with #G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY. a non-empty #GList + line="32212">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -88391,19 +90016,19 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32202">a #GResolver the hostname to look up + line="32203">the hostname to look up extra #GResolverNameLookupFlags for the lookup + line="32204">extra #GResolverNameLookupFlags for the lookup @@ -88413,7 +90038,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) allow-none="1"> a #GCancellable, or %NULL + line="32205">a #GCancellable, or %NULL @@ -88423,7 +90048,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) version="2.60"> Begins asynchronously resolving @hostname to determine its + line="32220">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_with_flags_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -88435,19 +90060,19 @@ See g_resolver_lookup_by_name() for more details. a #GResolver + line="32222">a #GResolver the hostname to look up the address of + line="32223">the hostname to look up the address of extra #GResolverNameLookupFlags for the lookup + line="32224">extra #GResolverNameLookupFlags for the lookup @@ -88457,7 +90082,7 @@ See g_resolver_lookup_by_name() for more details. allow-none="1"> a #GCancellable, or %NULL + line="32225">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="32226">callback to call after resolution completes closure="4"> data for @callback + line="32227">data for @callback @@ -88489,7 +90114,7 @@ See g_resolver_lookup_by_name() for more details. throws="1"> Retrieves the result of a call to + line="32238">Retrieves the result of a call to g_resolver_lookup_by_name_with_flags_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -88499,7 +90124,7 @@ a value from #GResolverError. If the operation was cancelled, a #GList + line="32251">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -88510,13 +90135,13 @@ for more details. a #GResolver + line="32240">a #GResolver the result passed to your #GAsyncReadyCallback + line="32241">the result passed to your #GAsyncReadyCallback @@ -88527,7 +90152,7 @@ for more details. throws="1"> Synchronously performs a DNS record lookup for the given @rrname and returns + line="32258">Synchronously performs a DNS record lookup for the given @rrname and returns a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. @@ -88541,7 +90166,7 @@ operation, in which case @error (if non-%NULL) will be set to a non-empty #GList of + line="32277">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -88553,19 +90178,19 @@ g_variant_unref() to do this.) a #GResolver + line="32260">a #GResolver the DNS name to look up the record for + line="32261">the DNS name to look up the record for the type of DNS record to look up + line="32262">the type of DNS record to look up allow-none="1"> a #GCancellable, or %NULL + line="32263">a #GCancellable, or %NULL @@ -88584,7 +90209,7 @@ g_variant_unref() to do this.) version="2.34"> Begins asynchronously performing a DNS lookup for the given + line="32285">Begins asynchronously performing a DNS lookup for the given @rrname, and eventually calls @callback, which must call g_resolver_lookup_records_finish() to get the final result. See g_resolver_lookup_records() for more details. @@ -88596,19 +90221,19 @@ g_resolver_lookup_records() for more details. a #GResolver + line="32287">a #GResolver the DNS name to look up the record for + line="32288">the DNS name to look up the record for the type of DNS record to look up + line="32289">the type of DNS record to look up allow-none="1"> a #GCancellable, or %NULL + line="32290">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="32291">callback to call after resolution completes closure="4"> data for @callback + line="32292">data for @callback @@ -88649,7 +90274,7 @@ g_resolver_lookup_records() for more details. throws="1"> Retrieves the result of a previous call to + line="32303">Retrieves the result of a previous call to g_resolver_lookup_records_async(). Returns a non-empty list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain. @@ -88661,7 +90286,7 @@ a value from #GResolverError. If the operation was cancelled, a non-empty #GList of + line="32318">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -88673,13 +90298,13 @@ g_variant_unref() to do this.) a #GResolver + line="32305">a #GResolver the result passed to your #GAsyncReadyCallback + line="32306">the result passed to your #GAsyncReadyCallback @@ -88747,7 +90372,7 @@ g_variant_unref() to do this.) throws="1"> Retrieves the result of a previous call to + line="32385">Retrieves the result of a previous call to g_resolver_lookup_service_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -88757,7 +90382,7 @@ a value from #GResolverError. If the operation was cancelled, a non-empty #GList of + line="32398">a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -88768,13 +90393,13 @@ details. a #GResolver + line="32387">a #GResolver the result passed to your #GAsyncReadyCallback + line="32388">the result passed to your #GAsyncReadyCallback @@ -88796,7 +90421,7 @@ details. throws="1"> Synchronously reverse-resolves @address to determine its + line="32066">Synchronously reverse-resolves @address to determine its associated hostname. If the DNS resolution fails, @error (if non-%NULL) will be set to @@ -88809,7 +90434,7 @@ operation, in which case @error (if non-%NULL) will be set to a hostname (either ASCII-only, or in ASCII-encoded + line="32083">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. @@ -88817,13 +90442,13 @@ operation, in which case @error (if non-%NULL) will be set to a #GResolver + line="32068">a #GResolver the address to reverse-resolve + line="32069">the address to reverse-resolve a #GCancellable, or %NULL + line="32070">a #GCancellable, or %NULL @@ -88842,7 +90467,7 @@ operation, in which case @error (if non-%NULL) will be set to version="2.22"> Begins asynchronously reverse-resolving @address to determine its + line="32089">Begins asynchronously reverse-resolving @address to determine its associated hostname, and eventually calls @callback, which must call g_resolver_lookup_by_address_finish() to get the final result. @@ -88853,13 +90478,13 @@ call g_resolver_lookup_by_address_finish() to get the final result. a #GResolver + line="32091">a #GResolver the address to reverse-resolve + line="32092">the address to reverse-resolve allow-none="1"> a #GCancellable, or %NULL + line="32093">a #GCancellable, or %NULL closure="3"> callback to call after resolution completes + line="32094">callback to call after resolution completes allow-none="1"> data for @callback + line="32095">data for @callback @@ -88899,7 +90524,7 @@ call g_resolver_lookup_by_address_finish() to get the final result. throws="1"> Retrieves the result of a previous call to + line="32105">Retrieves the result of a previous call to g_resolver_lookup_by_address_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -88909,7 +90534,7 @@ a value from #GResolverError. If the operation was cancelled, a hostname (either ASCII-only, or in ASCII-encoded + line="32118">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. @@ -88917,13 +90542,13 @@ form), or %NULL on error. a #GResolver + line="32107">a #GResolver the result passed to your #GAsyncReadyCallback + line="32108">the result passed to your #GAsyncReadyCallback @@ -88934,7 +90559,7 @@ form), or %NULL on error. throws="1"> Synchronously resolves @hostname to determine its associated IP + line="32124">Synchronously resolves @hostname to determine its associated IP address(es). @hostname may be an ASCII-only or UTF-8 hostname, or the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()). @@ -88961,7 +90586,7 @@ address, it may be easier to create a #GNetworkAddress and use its a non-empty #GList + line="32155">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -88973,13 +90598,13 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32126">a #GResolver the hostname to look up + line="32127">the hostname to look up allow-none="1"> a #GCancellable, or %NULL + line="32128">a #GCancellable, or %NULL @@ -88998,7 +90623,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) version="2.22"> Begins asynchronously resolving @hostname to determine its + line="32163">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -89010,13 +90635,13 @@ See g_resolver_lookup_by_name() for more details. a #GResolver + line="32165">a #GResolver the hostname to look up the address of + line="32166">the hostname to look up the address of allow-none="1"> a #GCancellable, or %NULL + line="32167">a #GCancellable, or %NULL closure="3"> callback to call after resolution completes + line="32168">callback to call after resolution completes allow-none="1"> data for @callback + line="32169">data for @callback @@ -89056,7 +90681,7 @@ See g_resolver_lookup_by_name() for more details. throws="1"> Retrieves the result of a call to + line="32180">Retrieves the result of a call to g_resolver_lookup_by_name_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -89066,7 +90691,7 @@ a value from #GResolverError. If the operation was cancelled, a #GList + line="32193">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -89077,13 +90702,13 @@ for more details. a #GResolver + line="32182">a #GResolver the result passed to your #GAsyncReadyCallback + line="32183">the result passed to your #GAsyncReadyCallback @@ -89094,14 +90719,14 @@ for more details. throws="1"> This differs from g_resolver_lookup_by_name() in that you can modify + line="32200">This differs from g_resolver_lookup_by_name() in that you can modify the lookup behavior with @flags. For example this can be used to limit results with #G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY. a non-empty #GList + line="32212">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -89113,19 +90738,19 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32202">a #GResolver the hostname to look up + line="32203">the hostname to look up extra #GResolverNameLookupFlags for the lookup + line="32204">extra #GResolverNameLookupFlags for the lookup @@ -89135,7 +90760,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) allow-none="1"> a #GCancellable, or %NULL + line="32205">a #GCancellable, or %NULL @@ -89145,7 +90770,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) version="2.60"> Begins asynchronously resolving @hostname to determine its + line="32220">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_with_flags_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -89157,19 +90782,19 @@ See g_resolver_lookup_by_name() for more details. a #GResolver + line="32222">a #GResolver the hostname to look up the address of + line="32223">the hostname to look up the address of extra #GResolverNameLookupFlags for the lookup + line="32224">extra #GResolverNameLookupFlags for the lookup @@ -89179,7 +90804,7 @@ See g_resolver_lookup_by_name() for more details. allow-none="1"> a #GCancellable, or %NULL + line="32225">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="32226">callback to call after resolution completes allow-none="1"> data for @callback + line="32227">data for @callback @@ -89210,7 +90835,7 @@ See g_resolver_lookup_by_name() for more details. throws="1"> Retrieves the result of a call to + line="32238">Retrieves the result of a call to g_resolver_lookup_by_name_with_flags_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -89220,7 +90845,7 @@ a value from #GResolverError. If the operation was cancelled, a #GList + line="32251">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -89231,13 +90856,13 @@ for more details. a #GResolver + line="32240">a #GResolver the result passed to your #GAsyncReadyCallback + line="32241">the result passed to your #GAsyncReadyCallback @@ -89248,7 +90873,7 @@ for more details. throws="1"> Synchronously performs a DNS record lookup for the given @rrname and returns + line="32258">Synchronously performs a DNS record lookup for the given @rrname and returns a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. @@ -89262,7 +90887,7 @@ operation, in which case @error (if non-%NULL) will be set to a non-empty #GList of + line="32277">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -89274,19 +90899,19 @@ g_variant_unref() to do this.) a #GResolver + line="32260">a #GResolver the DNS name to look up the record for + line="32261">the DNS name to look up the record for the type of DNS record to look up + line="32262">the type of DNS record to look up allow-none="1"> a #GCancellable, or %NULL + line="32263">a #GCancellable, or %NULL @@ -89305,7 +90930,7 @@ g_variant_unref() to do this.) version="2.34"> Begins asynchronously performing a DNS lookup for the given + line="32285">Begins asynchronously performing a DNS lookup for the given @rrname, and eventually calls @callback, which must call g_resolver_lookup_records_finish() to get the final result. See g_resolver_lookup_records() for more details. @@ -89317,19 +90942,19 @@ g_resolver_lookup_records() for more details. a #GResolver + line="32287">a #GResolver the DNS name to look up the record for + line="32288">the DNS name to look up the record for the type of DNS record to look up + line="32289">the type of DNS record to look up allow-none="1"> a #GCancellable, or %NULL + line="32290">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="32291">callback to call after resolution completes allow-none="1"> data for @callback + line="32292">data for @callback @@ -89369,7 +90994,7 @@ g_resolver_lookup_records() for more details. throws="1"> Retrieves the result of a previous call to + line="32303">Retrieves the result of a previous call to g_resolver_lookup_records_async(). Returns a non-empty list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain. @@ -89381,7 +91006,7 @@ a value from #GResolverError. If the operation was cancelled, a non-empty #GList of + line="32318">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -89393,13 +91018,13 @@ g_variant_unref() to do this.) a #GResolver + line="32305">a #GResolver the result passed to your #GAsyncReadyCallback + line="32306">the result passed to your #GAsyncReadyCallback @@ -89410,7 +91035,7 @@ g_variant_unref() to do this.) throws="1"> Synchronously performs a DNS SRV lookup for the given @service and + line="32326">Synchronously performs a DNS SRV lookup for the given @service and @protocol in the given @domain and returns an array of #GSrvTarget. @domain may be an ASCII-only or UTF-8 hostname. Note also that the @service and @protocol arguments do not include the leading underscore @@ -89435,7 +91060,7 @@ interface. a non-empty #GList of + line="32357">a non-empty #GList of #GSrvTarget, or %NULL on error. You must free each of the targets and the list when you are done with it. (You can use g_resolver_free_targets() to do this.) @@ -89447,25 +91072,25 @@ this.) a #GResolver + line="32328">a #GResolver the service type to look up (eg, "ldap") + line="32329">the service type to look up (eg, "ldap") the networking protocol to use for @service (eg, "tcp") + line="32330">the networking protocol to use for @service (eg, "tcp") the DNS domain to look up the service in + line="32331">the DNS domain to look up the service in allow-none="1"> a #GCancellable, or %NULL + line="32332">a #GCancellable, or %NULL @@ -89484,7 +91109,7 @@ this.) version="2.22"> Begins asynchronously performing a DNS SRV lookup for the given + line="32365">Begins asynchronously performing a DNS SRV lookup for the given @service and @protocol in the given @domain, and eventually calls @callback, which must call g_resolver_lookup_service_finish() to get the final result. See g_resolver_lookup_service() for more @@ -89497,25 +91122,25 @@ details. a #GResolver + line="32367">a #GResolver the service type to look up (eg, "ldap") + line="32368">the service type to look up (eg, "ldap") the networking protocol to use for @service (eg, "tcp") + line="32369">the networking protocol to use for @service (eg, "tcp") the DNS domain to look up the service in + line="32370">the DNS domain to look up the service in allow-none="1"> a #GCancellable, or %NULL + line="32371">a #GCancellable, or %NULL closure="5"> callback to call after resolution completes + line="32372">callback to call after resolution completes allow-none="1"> data for @callback + line="32373">data for @callback @@ -89555,7 +91180,7 @@ details. throws="1"> Retrieves the result of a previous call to + line="32385">Retrieves the result of a previous call to g_resolver_lookup_service_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -89565,7 +91190,7 @@ a value from #GResolverError. If the operation was cancelled, a non-empty #GList of + line="32398">a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -89576,13 +91201,13 @@ details. a #GResolver + line="32387">a #GResolver the result passed to your #GAsyncReadyCallback + line="32388">the result passed to your #GAsyncReadyCallback @@ -89592,7 +91217,7 @@ details. version="2.22"> Sets @resolver to be the application's default resolver (reffing + line="32405">Sets @resolver to be the application's default resolver (reffing @resolver, and unreffing the previous default resolver, if any). Future calls to g_resolver_get_default() will return this resolver. @@ -89609,7 +91234,7 @@ itself as the default resolver for all later code to use. the new default #GResolver + line="32407">the new default #GResolver @@ -89623,7 +91248,7 @@ itself as the default resolver for all later code to use. Emitted when the resolver notices that the system resolver + line="2908">Emitted when the resolver notices that the system resolver configuration has changed. @@ -89656,7 +91281,7 @@ configuration has changed. a non-empty #GList + line="32155">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -89668,13 +91293,13 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32126">a #GResolver the hostname to look up + line="32127">the hostname to look up allow-none="1"> a #GCancellable, or %NULL + line="32128">a #GCancellable, or %NULL @@ -89699,13 +91324,13 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32165">a #GResolver the hostname to look up the address of + line="32166">the hostname to look up the address of allow-none="1"> a #GCancellable, or %NULL + line="32167">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="32168">callback to call after resolution completes closure="4"> data for @callback + line="32169">data for @callback @@ -89747,7 +91372,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GList + line="32193">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -89758,13 +91383,13 @@ for more details. a #GResolver + line="32182">a #GResolver the result passed to your #GAsyncReadyCallback + line="32183">the result passed to your #GAsyncReadyCallback @@ -89776,7 +91401,7 @@ for more details. a hostname (either ASCII-only, or in ASCII-encoded + line="32083">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. @@ -89784,13 +91409,13 @@ for more details. a #GResolver + line="32068">a #GResolver the address to reverse-resolve + line="32069">the address to reverse-resolve allow-none="1"> a #GCancellable, or %NULL + line="32070">a #GCancellable, or %NULL @@ -89815,13 +91440,13 @@ for more details. a #GResolver + line="32091">a #GResolver the address to reverse-resolve + line="32092">the address to reverse-resolve allow-none="1"> a #GCancellable, or %NULL + line="32093">a #GCancellable, or %NULL closure="4"> callback to call after resolution completes + line="32094">callback to call after resolution completes closure="4"> data for @callback + line="32095">data for @callback @@ -89863,7 +91488,7 @@ for more details. a hostname (either ASCII-only, or in ASCII-encoded + line="32118">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. @@ -89871,13 +91496,13 @@ form), or %NULL on error. a #GResolver + line="32107">a #GResolver the result passed to your #GAsyncReadyCallback + line="32108">the result passed to your #GAsyncReadyCallback @@ -89950,7 +91575,7 @@ form), or %NULL on error. a non-empty #GList of + line="32398">a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -89961,13 +91586,13 @@ details. a #GResolver + line="32387">a #GResolver the result passed to your #GAsyncReadyCallback + line="32388">the result passed to your #GAsyncReadyCallback @@ -89979,7 +91604,7 @@ details. a non-empty #GList of + line="32277">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -89991,19 +91616,19 @@ g_variant_unref() to do this.) a #GResolver + line="32260">a #GResolver the DNS name to look up the record for + line="32261">the DNS name to look up the record for the type of DNS record to look up + line="32262">the type of DNS record to look up allow-none="1"> a #GCancellable, or %NULL + line="32263">a #GCancellable, or %NULL @@ -90028,19 +91653,19 @@ g_variant_unref() to do this.) a #GResolver + line="32287">a #GResolver the DNS name to look up the record for + line="32288">the DNS name to look up the record for the type of DNS record to look up + line="32289">the type of DNS record to look up allow-none="1"> a #GCancellable, or %NULL + line="32290">a #GCancellable, or %NULL closure="5"> callback to call after resolution completes + line="32291">callback to call after resolution completes closure="5"> data for @callback + line="32292">data for @callback @@ -90082,7 +91707,7 @@ g_variant_unref() to do this.) a non-empty #GList of + line="32318">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -90094,13 +91719,13 @@ g_variant_unref() to do this.) a #GResolver + line="32305">a #GResolver the result passed to your #GAsyncReadyCallback + line="32306">the result passed to your #GAsyncReadyCallback @@ -90116,19 +91741,19 @@ g_variant_unref() to do this.) a #GResolver + line="32222">a #GResolver the hostname to look up the address of + line="32223">the hostname to look up the address of extra #GResolverNameLookupFlags for the lookup + line="32224">extra #GResolverNameLookupFlags for the lookup @@ -90138,7 +91763,7 @@ g_variant_unref() to do this.) allow-none="1"> a #GCancellable, or %NULL + line="32225">a #GCancellable, or %NULL closure="5"> callback to call after resolution completes + line="32226">callback to call after resolution completes closure="5"> data for @callback + line="32227">data for @callback @@ -90171,7 +91796,7 @@ g_variant_unref() to do this.) a #GList + line="32251">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -90182,13 +91807,13 @@ for more details. a #GResolver + line="32240">a #GResolver the result passed to your #GAsyncReadyCallback + line="32241">the result passed to your #GAsyncReadyCallback @@ -90200,7 +91825,7 @@ for more details. a non-empty #GList + line="32212">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -90212,19 +91837,19 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + line="32202">a #GResolver the hostname to look up + line="32203">the hostname to look up extra #GResolverNameLookupFlags for the lookup + line="32204">extra #GResolverNameLookupFlags for the lookup @@ -90234,7 +91859,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) allow-none="1"> a #GCancellable, or %NULL + line="32205">a #GCancellable, or %NULL @@ -90254,7 +91879,8 @@ from a #GResolver routine. + glib:nick="not-found" + glib:name="G_RESOLVER_ERROR_NOT_FOUND"> the requested name/address/service was not @@ -90263,7 +91889,8 @@ from a #GResolver routine. + glib:nick="temporary-failure" + glib:name="G_RESOLVER_ERROR_TEMPORARY_FAILURE"> the requested information could not @@ -90272,7 +91899,8 @@ from a #GResolver routine. + glib:nick="internal" + glib:name="G_RESOLVER_ERROR_INTERNAL"> unknown error @@ -90282,11 +91910,11 @@ from a #GResolver routine. version="2.22"> Gets the #GResolver Error Quark. + line="32018">Gets the #GResolver Error Quark. a #GQuark. + line="32023">a #GQuark. @@ -90302,7 +91930,8 @@ from a #GResolver routine. + glib:nick="default" + glib:name="G_RESOLVER_NAME_LOOKUP_FLAGS_DEFAULT"> default behavior (same as g_resolver_lookup_by_name()) @@ -90310,7 +91939,8 @@ from a #GResolver routine. + glib:nick="ipv4-only" + glib:name="G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY"> only resolve ipv4 addresses @@ -90318,7 +91948,8 @@ from a #GResolver routine. + glib:nick="ipv6-only" + glib:name="G_RESOLVER_NAME_LOOKUP_FLAGS_IPV6_ONLY"> only resolve ipv6 addresses @@ -90367,7 +91998,8 @@ as a `guint32`, and the TTL as a `guint32`. + glib:nick="srv" + glib:name="G_RESOLVER_RECORD_SRV"> look up DNS SRV records for a domain @@ -90375,7 +92007,8 @@ as a `guint32`, and the TTL as a `guint32`. + glib:nick="mx" + glib:name="G_RESOLVER_RECORD_MX"> look up DNS MX records for a domain @@ -90383,7 +92016,8 @@ as a `guint32`, and the TTL as a `guint32`. + glib:nick="txt" + glib:name="G_RESOLVER_RECORD_TXT"> look up DNS TXT records for a name @@ -90391,7 +92025,8 @@ as a `guint32`, and the TTL as a `guint32`. + glib:nick="soa" + glib:name="G_RESOLVER_RECORD_SOA"> look up DNS SOA records for a zone @@ -90399,7 +92034,8 @@ as a `guint32`, and the TTL as a `guint32`. + glib:nick="ns" + glib:name="G_RESOLVER_RECORD_NS"> look up DNS NS records for a domain @@ -90413,7 +92049,7 @@ as a `guint32`, and the TTL as a `guint32`. c:symbol-prefix="resource"> Applications and libraries often contain binary or textual data that is + line="7816">Applications and libraries often contain binary or textual data that is really part of the application, rather than user data. For instance #GtkBuilder .ui files, splashscreen images, GMenu markup XML, CSS files, icons, etc. These are often shipped as files in `$datadir/appname`, or @@ -90441,12 +92077,16 @@ the `XMLLINT` environment variable must be set to the full path to the xmllint executable, or xmllint must be in the `PATH`; otherwise the preprocessing step is skipped. -`to-pixdata` which will use the gdk-pixbuf-pixdata command to convert -images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside -the resource file, rather than an (uncompressed) copy of it. For this, the gdk-pixbuf-pixdata -program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be -set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will -abort. +`to-pixdata` (deprecated since gdk-pixbuf 2.32) which will use the +`gdk-pixbuf-pixdata` command to convert images to the #GdkPixdata format, +which allows you to create pixbufs directly using the data inside the +resource file, rather than an (uncompressed) copy of it. For this, the +`gdk-pixbuf-pixdata` program must be in the `PATH`, or the +`GDK_PIXBUF_PIXDATA` environment variable must be set to the full path to the +`gdk-pixbuf-pixdata` executable; otherwise the resource compiler will abort. +`to-pixdata` has been deprecated since gdk-pixbuf 2.32, as #GResource +supports embedding modern image formats just as well. Instead of using it, +embed a PNG or SVG file in your #GResource. `json-stripblanks` which will use the `json-glib-format` command to strip ignorable whitespace from the JSON file. For this to work, the @@ -90524,7 +92164,7 @@ When debugging a program or testing a change to an installed version, it is ofte replace resources in the program or library, without recompiling, for debugging or quick hacking and testing purposes. Since GLib 2.50, it is possible to use the `G_RESOURCE_OVERLAYS` environment variable to selectively overlay resources with replacements from the filesystem. It is a %G_SEARCHPATH_SEPARATOR-separated list of substitutions to perform -during resource lookups. +during resource lookups. It is ignored when running in a setuid process. A substitution has the form @@ -90552,7 +92192,7 @@ location of a single resource with an individual file. throws="1"> Creates a GResource from a reference to the binary resource bundle. + line="32524">Creates a GResource from a reference to the binary resource bundle. This will keep a reference to @data while the resource lives, so the data should not be modified or freed. @@ -90568,14 +92208,14 @@ If @data is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. a new #GResource, or %NULL on error + line="32542">a new #GResource, or %NULL on error A #GBytes + line="32526">A #GBytes @@ -90586,7 +92226,7 @@ If @data is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. version="2.32"> Registers the resource with the process-global set of resources. + line="32673">Registers the resource with the process-global set of resources. Once a resource is registered the files in it can be accessed with the global resource lookup functions like g_resources_lookup_data(). @@ -90597,7 +92237,7 @@ with the global resource lookup functions like g_resources_lookup_data(). A #GResource + line="32675">A #GResource @@ -90608,7 +92248,7 @@ with the global resource lookup functions like g_resources_lookup_data(). version="2.32"> Unregisters the resource from the process-global set of resources. + line="32685">Unregisters the resource from the process-global set of resources. @@ -90617,7 +92257,7 @@ with the global resource lookup functions like g_resources_lookup_data(). A #GResource + line="32687">A #GResource @@ -90628,7 +92268,7 @@ with the global resource lookup functions like g_resources_lookup_data(). throws="1"> Returns all the names of children at the specified @path in the resource. + line="32423">Returns all the names of children at the specified @path in the resource. The return result is a %NULL terminated list of strings which should be released with g_strfreev(). @@ -90640,7 +92280,7 @@ If @path is invalid or does not exist in the #GResource, an array of constant strings + line="32439">an array of constant strings @@ -90649,19 +92289,19 @@ If @path is invalid or does not exist in the #GResource, A #GResource + line="32425">A #GResource A pathname inside the resource + line="32426">A pathname inside the resource A #GResourceLookupFlags + line="32427">A #GResourceLookupFlags @@ -90672,7 +92312,7 @@ If @path is invalid or does not exist in the #GResource, throws="1"> Looks for a file at the specified @path in the resource and + line="32454">Looks for a file at the specified @path in the resource and if found returns information about it. @lookup_flags controls the behaviour of the lookup. @@ -90680,26 +92320,26 @@ if found returns information about it. %TRUE if the file was found. %FALSE if there were errors + line="32470">%TRUE if the file was found. %FALSE if there were errors A #GResource + line="32456">A #GResource A pathname inside the resource + line="32457">A pathname inside the resource A #GResourceLookupFlags + line="32458">A #GResourceLookupFlags a location to place the length of the contents of the file, + line="32459">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -90722,7 +92362,7 @@ if found returns information about it. allow-none="1"> a location to place the flags about the file, + line="32461">a location to place the flags about the file, or %NULL if the length is not needed @@ -90734,7 +92374,7 @@ if found returns information about it. throws="1"> Looks for a file at the specified @path in the resource and + line="32496">Looks for a file at the specified @path in the resource and returns a #GBytes that lets you directly access the data in memory. @@ -90752,7 +92392,7 @@ the heap and automatically uncompress the data. #GBytes or %NULL on error. + line="32518">#GBytes or %NULL on error. Free the returned object with g_bytes_unref() @@ -90760,19 +92400,19 @@ the heap and automatically uncompress the data. A #GResource + line="32498">A #GResource A pathname inside the resource + line="32499">A pathname inside the resource A #GResourceLookupFlags + line="32500">A #GResourceLookupFlags @@ -90783,7 +92423,7 @@ the heap and automatically uncompress the data. throws="1"> Looks for a file at the specified @path in the resource and + line="32547">Looks for a file at the specified @path in the resource and returns a #GInputStream that lets you read the data. @lookup_flags controls the behaviour of the lookup. @@ -90791,7 +92431,7 @@ returns a #GInputStream that lets you read the data. #GInputStream or %NULL on error. + line="32559">#GInputStream or %NULL on error. Free the returned object with g_object_unref() @@ -90799,19 +92439,19 @@ returns a #GInputStream that lets you read the data. A #GResource + line="32549">A #GResource A pathname inside the resource + line="32550">A pathname inside the resource A #GResourceLookupFlags + line="32551">A #GResourceLookupFlags @@ -90819,20 +92459,20 @@ returns a #GInputStream that lets you read the data. Atomically increments the reference count of @resource by one. This + line="32565">Atomically increments the reference count of @resource by one. This function is MT-safe and may be called from any thread. The passed in #GResource + line="32572">The passed in #GResource A #GResource + line="32567">A #GResource @@ -90840,7 +92480,7 @@ function is MT-safe and may be called from any thread. Atomically decrements the reference count of @resource by one. If the + line="32577">Atomically decrements the reference count of @resource by one. If the reference count drops to 0, all memory allocated by the resource is released. This function is MT-safe and may be called from any thread. @@ -90852,7 +92492,7 @@ thread. A #GResource + line="32579">A #GResource @@ -90863,7 +92503,7 @@ thread. throws="1"> Loads a binary resource bundle and creates a #GResource representation of it, allowing + line="32475">Loads a binary resource bundle and creates a #GResource representation of it, allowing you to query it for data. If you want to use this resource in the global resource namespace you need @@ -90877,14 +92517,14 @@ returned. a new #GResource, or %NULL on error + line="32491">a new #GResource, or %NULL on error the path of a filename to load, in the GLib filename encoding + line="32477">the path of a filename to load, in the GLib filename encoding @@ -90903,7 +92543,8 @@ from a #GResource routine. + glib:nick="not-found" + glib:name="G_RESOURCE_ERROR_NOT_FOUND"> no file was found at the requested path @@ -90911,7 +92552,8 @@ from a #GResource routine. + glib:nick="internal" + glib:name="G_RESOURCE_ERROR_INTERNAL"> unknown error @@ -90921,11 +92563,11 @@ from a #GResource routine. version="2.32"> Gets the #GResource Error Quark. + line="32444">Gets the #GResource Error Quark. a #GQuark + line="32449">a #GQuark @@ -90942,7 +92584,8 @@ bundle. + glib:nick="none" + glib:name="G_RESOURCE_FLAGS_NONE"> No flags set. @@ -90950,7 +92593,8 @@ bundle. + glib:nick="compressed" + glib:name="G_RESOURCE_FLAGS_COMPRESSED"> The file is compressed. @@ -90967,7 +92611,8 @@ bundle. + glib:nick="none" + glib:name="G_RESOURCE_LOOKUP_FLAGS_NONE"> No flags set. @@ -91420,7 +93065,7 @@ bundle. glib:type-struct="SeekableIface"> #GSeekable is implemented by streams (implementations of + line="7962">#GSeekable is implemented by streams (implementations of #GInputStream or #GOutputStream) that support seeking. Seekable streams largely fall into two categories: resizable and @@ -91438,19 +93083,19 @@ usually cause the stream to resize by introducing zero bytes. Tests if the stream supports the #GSeekableIface. + line="32695">Tests if the stream supports the #GSeekableIface. %TRUE if @seekable can be seeked. %FALSE otherwise. + line="32701">%TRUE if @seekable can be seeked. %FALSE otherwise. a #GSeekable. + line="32697">a #GSeekable. @@ -91458,20 +93103,20 @@ usually cause the stream to resize by introducing zero bytes. Tests if the length of the stream can be adjusted with + line="32705">Tests if the length of the stream can be adjusted with g_seekable_truncate(). %TRUE if the stream can be truncated, %FALSE otherwise. + line="32712">%TRUE if the stream can be truncated, %FALSE otherwise. a #GSeekable. + line="32707">a #GSeekable. @@ -91479,7 +93124,7 @@ g_seekable_truncate(). Seeks in the stream by the given @offset, modified by @type. + line="32716">Seeks in the stream by the given @offset, modified by @type. Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If @@ -91497,7 +93142,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if successful. If an error + line="32740">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -91506,19 +93151,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GSeekable. + line="32718">a #GSeekable. a #goffset. + line="32719">a #goffset. a #GSeekType. + line="32720">a #GSeekType. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="32721">optional #GCancellable object, %NULL to ignore. @@ -91535,19 +93180,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Tells the current position within the stream. + line="32746">Tells the current position within the stream. the offset from the beginning of the buffer. + line="32752">the (positive or zero) offset from the beginning of the +buffer, zero if the target is not seekable. a #GSeekable. + line="32748">a #GSeekable. @@ -91555,7 +93201,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Sets the length of the stream to @offset. If the stream was previously + line="32757">Sets the length of the stream to @offset. If the stream was previously larger than @offset, the extra data is discarded. If the stream was previously shorter than @offset, it is extended with NUL ('\0') bytes. @@ -91568,7 +93214,7 @@ partial result will be returned, without an error. %TRUE if successful. If an error + line="32775">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -91577,13 +93223,13 @@ partial result will be returned, without an error. a #GSeekable. + line="32759">a #GSeekable. new length for @seekable, in bytes. + line="32760">new length for @seekable, in bytes. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="32761">optional #GCancellable object, %NULL to ignore. @@ -91600,19 +93246,19 @@ partial result will be returned, without an error. Tests if the stream supports the #GSeekableIface. + line="32695">Tests if the stream supports the #GSeekableIface. %TRUE if @seekable can be seeked. %FALSE otherwise. + line="32701">%TRUE if @seekable can be seeked. %FALSE otherwise. a #GSeekable. + line="32697">a #GSeekable. @@ -91620,20 +93266,20 @@ partial result will be returned, without an error. Tests if the length of the stream can be adjusted with + line="32705">Tests if the length of the stream can be adjusted with g_seekable_truncate(). %TRUE if the stream can be truncated, %FALSE otherwise. + line="32712">%TRUE if the stream can be truncated, %FALSE otherwise. a #GSeekable. + line="32707">a #GSeekable. @@ -91641,7 +93287,7 @@ g_seekable_truncate(). Seeks in the stream by the given @offset, modified by @type. + line="32716">Seeks in the stream by the given @offset, modified by @type. Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If @@ -91659,7 +93305,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. %TRUE if successful. If an error + line="32740">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -91668,19 +93314,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GSeekable. + line="32718">a #GSeekable. a #goffset. + line="32719">a #goffset. a #GSeekType. + line="32720">a #GSeekType. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="32721">optional #GCancellable object, %NULL to ignore. @@ -91697,19 +93343,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Tells the current position within the stream. + line="32746">Tells the current position within the stream. the offset from the beginning of the buffer. + line="32752">the (positive or zero) offset from the beginning of the +buffer, zero if the target is not seekable. a #GSeekable. + line="32748">a #GSeekable. @@ -91717,7 +93364,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Sets the length of the stream to @offset. If the stream was previously + line="32757">Sets the length of the stream to @offset. If the stream was previously larger than @offset, the extra data is discarded. If the stream was previously shorter than @offset, it is extended with NUL ('\0') bytes. @@ -91730,7 +93377,7 @@ partial result will be returned, without an error. %TRUE if successful. If an error + line="32775">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -91739,13 +93386,13 @@ partial result will be returned, without an error. a #GSeekable. + line="32759">a #GSeekable. new length for @seekable, in bytes. + line="32760">new length for @seekable, in bytes. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="32761">optional #GCancellable object, %NULL to ignore. @@ -91779,14 +93426,15 @@ partial result will be returned, without an error. the offset from the beginning of the buffer. + line="32752">the (positive or zero) offset from the beginning of the +buffer, zero if the target is not seekable. a #GSeekable. + line="32748">a #GSeekable. @@ -91798,14 +93446,14 @@ partial result will be returned, without an error. %TRUE if @seekable can be seeked. %FALSE otherwise. + line="32701">%TRUE if @seekable can be seeked. %FALSE otherwise. a #GSeekable. + line="32697">a #GSeekable. @@ -91817,7 +93465,7 @@ partial result will be returned, without an error. %TRUE if successful. If an error + line="32740">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -91826,19 +93474,19 @@ partial result will be returned, without an error. a #GSeekable. + line="32718">a #GSeekable. a #goffset. + line="32719">a #goffset. a #GSeekType. + line="32720">a #GSeekType. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="32721">optional #GCancellable object, %NULL to ignore. @@ -91859,14 +93507,14 @@ partial result will be returned, without an error. %TRUE if the stream can be truncated, %FALSE otherwise. + line="32712">%TRUE if the stream can be truncated, %FALSE otherwise. a #GSeekable. + line="32707">a #GSeekable. @@ -91878,7 +93526,7 @@ partial result will be returned, without an error. %TRUE if successful. If an error + line="32775">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -91887,13 +93535,13 @@ partial result will be returned, without an error. a #GSeekable. + line="32759">a #GSeekable. new length for @seekable, in bytes. + line="32760">new length for @seekable, in bytes. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="32761">optional #GCancellable object, %NULL to ignore. @@ -91918,7 +93566,7 @@ partial result will be returned, without an error. glib:type-struct="SettingsClass"> The #GSettings class provides a convenient API for storing and retrieving + line="7985">The #GSettings class provides a convenient API for storing and retrieving application settings. Reads and writes can be considered to be non-blocking. Reading @@ -92000,7 +93648,7 @@ by the [glib-compile-schemas][glib-compile-schemas] utility. The input is a schema description in an XML format. A DTD for the gschema XML format can be found here: -[gschema.dtd](https://git.gnome.org/browse/glib/tree/gio/gschema.dtd) +[gschema.dtd](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/gschema.dtd) The [glib-compile-schemas][glib-compile-schemas] tool expects schema files to have the extension `.gschema.xml`. @@ -92209,7 +93857,7 @@ rules. It should not be committed to version control or included in Creates a new #GSettings object with the schema specified by + line="33541">Creates a new #GSettings object with the schema specified by @schema_id. It is an error for the schema to not exist: schemas are an @@ -92226,14 +93874,14 @@ on the context. See g_main_context_push_thread_default(). a new #GSettings object + line="33559">a new #GSettings object the id of the schema + line="33543">the id of the schema @@ -92243,7 +93891,7 @@ on the context. See g_main_context_push_thread_default(). version="2.32"> Creates a new #GSettings object with a given schema, backend and + line="33564">Creates a new #GSettings object with a given schema, backend and path. It should be extremely rare that you ever want to use this function. @@ -92270,14 +93918,14 @@ have. a new #GSettings object + line="33594">a new #GSettings object a #GSettingsSchema + line="33566">a #GSettingsSchema allow-none="1"> a #GSettingsBackend + line="33567">a #GSettingsBackend allow-none="1"> the path to use + line="33568">the path to use @@ -92305,7 +93953,7 @@ have. version="2.26"> Creates a new #GSettings object with the schema specified by + line="33599">Creates a new #GSettings object with the schema specified by @schema_id and a given #GSettingsBackend. Creating a #GSettings object with a different backend allows accessing @@ -92317,20 +93965,20 @@ settings instead of the settings for this user. a new #GSettings object + line="33613">a new #GSettings object the id of the schema + line="33601">the id of the schema the #GSettingsBackend to use + line="33602">the #GSettingsBackend to use @@ -92340,7 +93988,7 @@ settings instead of the settings for this user. version="2.26"> Creates a new #GSettings object with the schema specified by + line="33618">Creates a new #GSettings object with the schema specified by @schema_id and a given #GSettingsBackend and path. This is a mix of g_settings_new_with_backend() and @@ -92349,26 +93997,26 @@ g_settings_new_with_path(). a new #GSettings object + line="33630">a new #GSettings object the id of the schema + line="33620">the id of the schema the #GSettingsBackend to use + line="33621">the #GSettingsBackend to use the path to use + line="33622">the path to use @@ -92378,7 +94026,7 @@ g_settings_new_with_path(). version="2.26"> Creates a new #GSettings object with the relocatable schema specified + line="33635">Creates a new #GSettings object with the relocatable schema specified by @schema_id and a given path. You only need to do this if you want to directly create a settings @@ -92395,20 +94043,20 @@ characters. a new #GSettings object + line="33654">a new #GSettings object the id of the schema + line="33637">the id of the schema the path to use + line="33638">the path to use @@ -92420,13 +94068,13 @@ characters. deprecated-version="2.40"> Deprecated. + line="33512">Deprecated. Use g_settings_schema_source_list_schemas() instead a list of relocatable + line="33517">a list of relocatable #GSettings schemas that are available, in no defined order. The list must not be modified or freed. @@ -92441,7 +94089,7 @@ characters. deprecated-version="2.40"> Deprecated. + line="33525">Deprecated. Use g_settings_schema_source_list_schemas() instead. If you used g_settings_list_schemas() to check for the presence of a particular schema, use g_settings_schema_source_lookup() instead @@ -92450,7 +94098,7 @@ of your whole loop. a list of #GSettings + line="33530">a list of #GSettings schemas that are available, in no defined order. The list must not be modified or freed. @@ -92461,7 +94109,7 @@ of your whole loop. Ensures that all pending operations are complete for the default backend. + line="34348">Ensures that all pending operations are complete for the default backend. Writes made to a #GSettings are handled asynchronously. For this reason, it is very unlikely that the changes have it to disk by the @@ -92479,7 +94127,7 @@ time the call is done). Removes an existing binding for @property on @object. + line="34364">Removes an existing binding for @property on @object. Note that bindings are automatically removed when the object is finalized, so it is rarely necessary to call this @@ -92492,13 +94140,13 @@ function. the object + line="34366">the object the property whose binding is removed + line="34367">the property whose binding is removed @@ -92565,7 +94213,7 @@ function. Applies any changes that have been made to the settings. This + line="32781">Applies any changes that have been made to the settings. This function does nothing unless @settings is in 'delay-apply' mode; see g_settings_delay(). In the normal case settings are always applied immediately. @@ -92577,7 +94225,7 @@ applied immediately. a #GSettings instance + line="32783">a #GSettings instance @@ -92585,7 +94233,7 @@ applied immediately. Create a binding between the @key in the @settings object + line="32970">Create a binding between the @key in the @settings object and the property @property of @object. The binding uses the default GIO mapping functions to map @@ -92613,31 +94261,31 @@ binding overrides the first one. a #GSettings object + line="32972">a #GSettings object the key to bind + line="32973">the key to bind a #GObject + line="32974">a #GObject the name of the property to bind + line="32975">the name of the property to bind flags for the binding + line="32976">flags for the binding @@ -92648,7 +94296,7 @@ binding overrides the first one. introspectable="0"> Create a binding between the @key in the @settings object + line="33003">Create a binding between the @key in the @settings object and the property @property of @object. The binding uses the provided mapping functions to map between @@ -92666,37 +94314,37 @@ binding overrides the first one. a #GSettings object + line="33005">a #GSettings object the key to bind + line="33006">the key to bind a #GObject + line="33007">a #GObject the name of the property to bind + line="33008">the name of the property to bind flags for the binding + line="33009">flags for the binding a function that gets called to convert values + line="33010">a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mapping @@ -92708,7 +94356,7 @@ binding overrides the first one. destroy="7"> a function that gets called to convert values + line="33012">a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mapping @@ -92719,13 +94367,13 @@ binding overrides the first one. allow-none="1"> data that gets passed to @get_mapping and @set_mapping + line="33014">data that gets passed to @get_mapping and @set_mapping #GDestroyNotify function for @user_data + line="33015">#GDestroyNotify function for @user_data @@ -92735,7 +94383,7 @@ binding overrides the first one. version="2.26"> Create a binding between the writability of @key in the + line="33032">Create a binding between the writability of @key in the @settings object and the property @property of @object. The property must be boolean; "sensitive" or "visible" properties of widgets are the most likely candidates. @@ -92760,31 +94408,31 @@ binding overrides the first one. a #GSettings object + line="33034">a #GSettings object the key to bind + line="33035">the key to bind a #GObject + line="33036">a #GObject the name of a boolean property to bind + line="33037">the name of a boolean property to bind whether to 'invert' the value + line="33038">whether to 'invert' the value @@ -92794,7 +94442,7 @@ binding overrides the first one. version="2.32"> Creates a #GAction corresponding to a given #GSettings key. + line="33062">Creates a #GAction corresponding to a given #GSettings key. The action has the same name as the key. @@ -92812,20 +94460,20 @@ correct type). a new #GAction + line="33082">a new #GAction a #GSettings + line="33064">a #GSettings the name of a key in @settings + line="33065">the name of a key in @settings @@ -92833,7 +94481,7 @@ correct type). Changes the #GSettings object into 'delay-apply' mode. In this + line="33087">Changes the #GSettings object into 'delay-apply' mode. In this mode, changes to @settings are not immediately propagated to the backend, but kept locally until g_settings_apply() is called. @@ -92844,7 +94492,7 @@ backend, but kept locally until g_settings_apply() is called. a #GSettings object + line="33089">a #GSettings object @@ -92855,7 +94503,7 @@ backend, but kept locally until g_settings_apply() is called. introspectable="0"> Gets the value that is stored at @key in @settings. + line="33099">Gets the value that is stored at @key in @settings. A convenience function that combines g_settings_get_value() with g_variant_get(). @@ -92871,25 +94519,25 @@ the type given in the schema. a #GSettings object + line="33101">a #GSettings object the key to get the value for + line="33102">the key to get the value for a #GVariant format string + line="33103">a #GVariant format string arguments as per @format + line="33104">arguments as per @format @@ -92899,7 +94547,7 @@ the type given in the schema. version="2.26"> Gets the value that is stored at @key in @settings. + line="33119">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for booleans. @@ -92909,20 +94557,20 @@ having a boolean type in the schema for @settings. a boolean + line="33131">a boolean a #GSettings object + line="33121">a #GSettings object the key to get the value for + line="33122">the key to get the value for @@ -92932,7 +94580,7 @@ having a boolean type in the schema for @settings. version="2.26"> Creates a child settings object which has a base path of + line="33136">Creates a child settings object which has a base path of `base-path/@name`, where `base-path` is the base path of @settings. @@ -92942,20 +94590,20 @@ in the schema of @settings using a <child> element. a 'child' settings object + line="33148">a 'child' settings object a #GSettings object + line="33138">a #GSettings object the name of the child schema + line="33139">the name of the child schema @@ -92965,7 +94613,7 @@ in the schema of @settings using a <child> element. version="2.40"> Gets the "default value" of a key. + line="33153">Gets the "default value" of a key. This is the value that would be read if g_settings_reset() were to be called on the key. @@ -92990,20 +94638,20 @@ schema for @settings. the default value + line="33180">the default value a #GSettings object + line="33155">a #GSettings object the key to get the default value for + line="33156">the key to get the default value for @@ -93013,7 +94661,7 @@ schema for @settings. version="2.26"> Gets the value that is stored at @key in @settings. + line="33185">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for doubles. @@ -93023,20 +94671,20 @@ having a 'double' type in the schema for @settings. a double + line="33197">a double a #GSettings object + line="33187">a #GSettings object the key to get the value for + line="33188">the key to get the value for @@ -93046,7 +94694,7 @@ having a 'double' type in the schema for @settings. version="2.26"> Gets the value that is stored in @settings for @key and converts it + line="33202">Gets the value that is stored in @settings for @key and converts it to the enum value that it represents. In order to use this function the type of the value must be a string @@ -93062,20 +94710,20 @@ default value. the enum value + line="33220">the enum value a #GSettings object + line="33204">a #GSettings object the key to get the value for + line="33205">the key to get the value for @@ -93085,7 +94733,7 @@ default value. version="2.26"> Gets the value that is stored in @settings for @key and converts it + line="33225">Gets the value that is stored in @settings for @key and converts it to the flags value that it represents. In order to use this function the type of the value must be an array @@ -93101,43 +94749,44 @@ value. the flags value + line="33243">the flags value a #GSettings object + line="33227">a #GSettings object the key to get the value for + line="33228">the key to get the value for Returns whether the #GSettings object has any unapplied + line="33248">Returns whether the #GSettings object has any unapplied changes. This can only be the case if it is in 'delayed-apply' mode. %TRUE if @settings has unapplied changes + line="33255">%TRUE if @settings has unapplied changes a #GSettings object + line="33250">a #GSettings object @@ -93145,7 +94794,7 @@ changes. This can only be the case if it is in 'delayed-apply' mode. Gets the value that is stored at @key in @settings. + line="33260">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 32-bit integers. @@ -93155,20 +94804,20 @@ having a int32 type in the schema for @settings. an integer + line="33272">an integer a #GSettings object + line="33262">a #GSettings object the key to get the value for + line="33263">the key to get the value for @@ -93178,7 +94827,7 @@ having a int32 type in the schema for @settings. version="2.50"> Gets the value that is stored at @key in @settings. + line="33277">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 64-bit integers. @@ -93188,20 +94837,20 @@ having a int64 type in the schema for @settings. a 64-bit integer + line="33289">a 64-bit integer a #GSettings object + line="33279">a #GSettings object the key to get the value for + line="33280">the key to get the value for @@ -93209,7 +94858,7 @@ having a int64 type in the schema for @settings. Gets the value that is stored at @key in @settings, subject to + line="33294">Gets the value that is stored at @key in @settings, subject to application-level validation/mapping. You should use this function when the application needs to perform @@ -93240,20 +94889,20 @@ just as any other value would be. the result, which may be %NULL + line="33330">the result, which may be %NULL a #GSettings object + line="33296">a #GSettings object the key to get the value for + line="33297">the key to get the value for closure="2"> the function to map the value in the + line="33298">the function to map the value in the settings database to the value used by the application @@ -93272,7 +94921,7 @@ just as any other value would be. allow-none="1"> user data for @mapping + line="33300">user data for @mapping @@ -93284,7 +94933,7 @@ just as any other value would be. deprecated-version="2.40"> Queries the range of a key. + line="33334">Queries the range of a key. Use g_settings_schema_key_get_range() instead. @@ -93294,13 +94943,13 @@ just as any other value would be. a #GSettings + line="33336">a #GSettings the key to query the range of + line="33337">the key to query the range of @@ -93310,7 +94959,7 @@ just as any other value would be. version="2.26"> Gets the value that is stored at @key in @settings. + line="33346">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for strings. @@ -93320,20 +94969,20 @@ having a string type in the schema for @settings. a newly-allocated string + line="33358">a newly-allocated string a #GSettings object + line="33348">a #GSettings object the key to get the value for + line="33349">the key to get the value for @@ -93343,7 +94992,7 @@ having a string type in the schema for @settings. version="2.26"> A convenience variant of g_settings_get() for string arrays. + line="33363">A convenience variant of g_settings_get() for string arrays. It is a programmer error to give a @key that isn't specified as having an array of strings type in the schema for @settings. @@ -93351,7 +95000,7 @@ having an array of strings type in the schema for @settings. a + line="33373">a newly-allocated, %NULL-terminated array of strings, the value that is stored at @key in @settings. @@ -93362,13 +95011,13 @@ is stored at @key in @settings. a #GSettings object + line="33365">a #GSettings object the key to get the value for + line="33366">the key to get the value for @@ -93378,7 +95027,7 @@ is stored at @key in @settings. version="2.30"> Gets the value that is stored at @key in @settings. + line="33380">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 32-bit unsigned integers. @@ -93389,20 +95038,20 @@ having a uint32 type in the schema for @settings. an unsigned integer + line="33393">an unsigned integer a #GSettings object + line="33382">a #GSettings object the key to get the value for + line="33383">the key to get the value for @@ -93412,7 +95061,7 @@ having a uint32 type in the schema for @settings. version="2.50"> Gets the value that is stored at @key in @settings. + line="33398">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 64-bit unsigned integers. @@ -93423,20 +95072,20 @@ having a uint64 type in the schema for @settings. a 64-bit unsigned integer + line="33411">a 64-bit unsigned integer a #GSettings object + line="33400">a #GSettings object the key to get the value for + line="33401">the key to get the value for @@ -93446,7 +95095,7 @@ having a uint64 type in the schema for @settings. version="2.40"> Checks the "user value" of a key, if there is one. + line="33416">Checks the "user value" of a key, if there is one. The user value of a key is the last value that was set by the user. @@ -93468,20 +95117,20 @@ schema for @settings. the user's value, if set + line="33440">the user's value, if set a #GSettings object + line="33418">a #GSettings object the key to get the user value for + line="33419">the key to get the user value for @@ -93491,7 +95140,7 @@ schema for @settings. version="2.26"> Gets the value that is stored in @settings for @key. + line="33445">Gets the value that is stored in @settings for @key. It is a programmer error to give a @key that isn't contained in the schema for @settings. @@ -93499,20 +95148,20 @@ schema for @settings. a new #GVariant + line="33455">a new #GVariant a #GSettings object + line="33447">a #GSettings object the key to get the value for + line="33448">the key to get the value for @@ -93522,25 +95171,25 @@ schema for @settings. version="2.26"> Finds out if a key can be written or not + line="33460">Finds out if a key can be written or not %TRUE if the key @name is writable + line="33467">%TRUE if the key @name is writable a #GSettings object + line="33462">a #GSettings object the name of a key + line="33463">the name of a key @@ -93548,7 +95197,7 @@ schema for @settings. Gets the list of children on @settings. + line="33472">Gets the list of children on @settings. The list is exactly the list of strings for which it is not an error to call g_settings_get_child(). @@ -93563,7 +95212,7 @@ with it. a list of the children on + line="33488">a list of the children on @settings, in no defined order @@ -93573,7 +95222,7 @@ with it. a #GSettings object + line="33474">a #GSettings object @@ -93584,7 +95233,7 @@ with it. deprecated-version="2.46"> Introspects the list of keys on @settings. + line="33493">Introspects the list of keys on @settings. You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This @@ -93597,7 +95246,7 @@ with it. a list of the keys on + line="33506">a list of the keys on @settings, in no defined order @@ -93607,7 +95256,7 @@ with it. a #GSettings object + line="33495">a #GSettings object @@ -93619,33 +95268,33 @@ with it. deprecated-version="2.40"> Checks if the given @value is of the correct type and within the + line="33659">Checks if the given @value is of the correct type and within the permitted range for @key. Use g_settings_schema_key_range_check() instead. %TRUE if @value is valid for @key + line="33668">%TRUE if @value is valid for @key a #GSettings + line="33661">a #GSettings the key to check + line="33662">the key to check the value to check + line="33663">the value to check @@ -93653,7 +95302,7 @@ permitted range for @key. Resets @key to its default value. + line="33674">Resets @key to its default value. This call resets the key, as much as possible, to its default value. That might be the value specified in the schema or the one set by the @@ -93666,13 +95315,13 @@ administrator. a #GSettings object + line="33676">a #GSettings object the name of a key + line="33677">the name of a key @@ -93680,7 +95329,7 @@ administrator. Reverts all non-applied changes to the settings. This function + line="33687">Reverts all non-applied changes to the settings. This function does nothing unless @settings is in 'delay-apply' mode; see g_settings_delay(). In the normal case settings are always applied immediately. @@ -93694,7 +95343,7 @@ Change notifications will be emitted for affected keys. a #GSettings instance + line="33689">a #GSettings instance @@ -93705,7 +95354,7 @@ Change notifications will be emitted for affected keys. introspectable="0"> Sets @key in @settings to @value. + line="34108">Sets @key in @settings to @value. A convenience function that combines g_settings_set_value() with g_variant_new(). @@ -93717,7 +95366,7 @@ the type given in the schema. %TRUE if setting the key succeeded, + line="34124">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -93725,25 +95374,25 @@ the type given in the schema. a #GSettings object + line="34110">a #GSettings object the name of the key to set + line="34111">the name of the key to set a #GVariant format string + line="34112">a #GVariant format string arguments as per @format + line="34113">arguments as per @format @@ -93753,7 +95402,7 @@ the type given in the schema. version="2.26"> Sets @key in @settings to @value. + line="34130">Sets @key in @settings to @value. A convenience variant of g_settings_set() for booleans. @@ -93763,7 +95412,7 @@ having a boolean type in the schema for @settings. %TRUE if setting the key succeeded, + line="34143">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -93771,19 +95420,19 @@ having a boolean type in the schema for @settings. a #GSettings object + line="34132">a #GSettings object the name of the key to set + line="34133">the name of the key to set the value to set it to + line="34134">the value to set it to @@ -93793,7 +95442,7 @@ having a boolean type in the schema for @settings. version="2.26"> Sets @key in @settings to @value. + line="34149">Sets @key in @settings to @value. A convenience variant of g_settings_set() for doubles. @@ -93803,7 +95452,7 @@ having a 'double' type in the schema for @settings. %TRUE if setting the key succeeded, + line="34162">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -93811,19 +95460,19 @@ having a 'double' type in the schema for @settings. a #GSettings object + line="34151">a #GSettings object the name of the key to set + line="34152">the name of the key to set the value to set it to + line="34153">the value to set it to @@ -93831,7 +95480,7 @@ having a 'double' type in the schema for @settings. Looks up the enumerated type nick for @value and writes it to @key, + line="34168">Looks up the enumerated type nick for @value and writes it to @key, within @settings. It is a programmer error to give a @key that isn't contained in the @@ -93845,26 +95494,26 @@ g_settings_get_string() will return the 'nick' associated with %TRUE, if the set succeeds + line="34185">%TRUE, if the set succeeds a #GSettings object + line="34170">a #GSettings object a key, within @settings + line="34171">a key, within @settings an enumerated value + line="34172">an enumerated value @@ -93872,7 +95521,7 @@ g_settings_get_string() will return the 'nick' associated with Looks up the flags type nicks for the bits specified by @value, puts + line="34189">Looks up the flags type nicks for the bits specified by @value, puts them in an array of strings and writes the array to @key, within @settings. @@ -93887,26 +95536,26 @@ bit in @value. %TRUE, if the set succeeds + line="34207">%TRUE, if the set succeeds a #GSettings object + line="34191">a #GSettings object a key, within @settings + line="34192">a key, within @settings a flags value + line="34193">a flags value @@ -93914,7 +95563,7 @@ bit in @value. Sets @key in @settings to @value. + line="34211">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 32-bit integers. @@ -93924,7 +95573,7 @@ having a int32 type in the schema for @settings. %TRUE if setting the key succeeded, + line="34224">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -93932,19 +95581,19 @@ having a int32 type in the schema for @settings. a #GSettings object + line="34213">a #GSettings object the name of the key to set + line="34214">the name of the key to set the value to set it to + line="34215">the value to set it to @@ -93954,7 +95603,7 @@ having a int32 type in the schema for @settings. version="2.50"> Sets @key in @settings to @value. + line="34230">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 64-bit integers. @@ -93964,7 +95613,7 @@ having a int64 type in the schema for @settings. %TRUE if setting the key succeeded, + line="34243">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -93972,19 +95621,19 @@ having a int64 type in the schema for @settings. a #GSettings object + line="34232">a #GSettings object the name of the key to set + line="34233">the name of the key to set the value to set it to + line="34234">the value to set it to @@ -93994,7 +95643,7 @@ having a int64 type in the schema for @settings. version="2.26"> Sets @key in @settings to @value. + line="34249">Sets @key in @settings to @value. A convenience variant of g_settings_set() for strings. @@ -94004,7 +95653,7 @@ having a string type in the schema for @settings. %TRUE if setting the key succeeded, + line="34262">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -94012,19 +95661,19 @@ having a string type in the schema for @settings. a #GSettings object + line="34251">a #GSettings object the name of the key to set + line="34252">the name of the key to set the value to set it to + line="34253">the value to set it to @@ -94034,7 +95683,7 @@ having a string type in the schema for @settings. version="2.26"> Sets @key in @settings to @value. + line="34268">Sets @key in @settings to @value. A convenience variant of g_settings_set() for string arrays. If @value is %NULL, then @key is set to be the empty array. @@ -94045,7 +95694,7 @@ having an array of strings type in the schema for @settings. %TRUE if setting the key succeeded, + line="34282">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -94053,13 +95702,13 @@ having an array of strings type in the schema for @settings. a #GSettings object + line="34270">a #GSettings object the name of the key to set + line="34271">the name of the key to set allow-none="1"> the value to set it to, or %NULL + line="34272">the value to set it to, or %NULL @@ -94080,7 +95729,7 @@ having an array of strings type in the schema for @settings. version="2.30"> Sets @key in @settings to @value. + line="34288">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 32-bit unsigned integers. @@ -94091,7 +95740,7 @@ having a uint32 type in the schema for @settings. %TRUE if setting the key succeeded, + line="34302">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -94099,19 +95748,19 @@ having a uint32 type in the schema for @settings. a #GSettings object + line="34290">a #GSettings object the name of the key to set + line="34291">the name of the key to set the value to set it to + line="34292">the value to set it to @@ -94121,7 +95770,7 @@ having a uint32 type in the schema for @settings. version="2.50"> Sets @key in @settings to @value. + line="34308">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 64-bit unsigned integers. @@ -94132,7 +95781,7 @@ having a uint64 type in the schema for @settings. %TRUE if setting the key succeeded, + line="34322">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -94140,19 +95789,19 @@ having a uint64 type in the schema for @settings. a #GSettings object + line="34310">a #GSettings object the name of the key to set + line="34311">the name of the key to set the value to set it to + line="34312">the value to set it to @@ -94162,7 +95811,7 @@ having a uint64 type in the schema for @settings. version="2.26"> Sets @key in @settings to @value. + line="34328">Sets @key in @settings to @value. It is a programmer error to give a @key that isn't contained in the schema for @settings or for @value to have the incorrect type, per @@ -94173,7 +95822,7 @@ If @value is floating then this function consumes the reference. %TRUE if setting the key succeeded, + line="34342">%TRUE if setting the key succeeded, %FALSE if the key was not writable @@ -94181,19 +95830,19 @@ If @value is floating then this function consumes the reference. a #GSettings object + line="34330">a #GSettings object the name of the key to set + line="34331">the name of the key to set a #GVariant of the correct type + line="34332">a #GVariant of the correct type @@ -94204,20 +95853,22 @@ If @value is floating then this function consumes the reference. transfer-ownership="none"> The name of the context that the settings are stored in. + line="3015">The name of the context that the settings are stored in. Whether the #GSettings object is in 'delay-apply' mode. See + line="3022">Whether the #GSettings object is in 'delay-apply' mode. See g_settings_delay() for details. - + If this property is %TRUE, the #GSettings object has outstanding + line="3032">If this property is %TRUE, the #GSettings object has outstanding changes that will be applied when g_settings_apply() is called. @@ -94227,7 +95878,7 @@ changes that will be applied when g_settings_apply() is called. transfer-ownership="none"> The path within the backend where the settings are stored. + line="3040">The path within the backend where the settings are stored. transfer-ownership="none"> The name of the schema that describes the types of keys + line="3047">The name of the schema that describes the types of keys for this #GSettings object. The type of this property is *not* #GSettingsSchema. @@ -94257,7 +95908,7 @@ version, this property may instead refer to a #GSettingsSchema. transfer-ownership="none"> The name of the schema that describes the types of keys + line="3065">The name of the schema that describes the types of keys for this #GSettings object. @@ -94267,7 +95918,7 @@ for this #GSettings object. transfer-ownership="none"> The #GSettingsSchema describing the types of keys for this + line="3073">The #GSettingsSchema describing the types of keys for this #GSettings object. Ideally, this property would be called 'schema'. #GSettingsSchema @@ -94285,7 +95936,7 @@ than the schema itself. Take care. The "change-event" signal is emitted once per change event that + line="2925">The "change-event" signal is emitted once per change event that affects this settings object. You should connect to this signal only if you are interested in viewing groups of changes before they are split out into multiple emissions of the "changed" signal. @@ -94303,7 +95954,7 @@ for each affected key. If any other connected handler returns %TRUE to stop other handlers from being invoked for the + line="2948">%TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further. @@ -94314,7 +95965,7 @@ for each affected key. If any other connected handler returns allow-none="1"> + line="2928"> an array of #GQuarks for the changed keys, or %NULL @@ -94323,7 +95974,7 @@ for each affected key. If any other connected handler returns the length of the @keys array, or 0 + line="2930">the length of the @keys array, or 0 @@ -94331,7 +95982,7 @@ for each affected key. If any other connected handler returns The "changed" signal is emitted when a key has potentially changed. + line="2953">The "changed" signal is emitted when a key has potentially changed. You should call one of the g_settings_get() calls to check the new value. @@ -94348,7 +95999,7 @@ least once while a signal handler was already connected for @key. the name of the key that changed + line="2956">the name of the key that changed @@ -94356,7 +96007,7 @@ least once while a signal handler was already connected for @key. The "writable-change-event" signal is emitted once per writability + line="2971">The "writable-change-event" signal is emitted once per writability change event that affects this settings object. You should connect to this signal if you are interested in viewing groups of changes before they are split out into multiple emissions of the @@ -94377,7 +96028,7 @@ will be suppressed. %TRUE to stop other handlers from being invoked for the + line="2995">%TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further. @@ -94385,7 +96036,7 @@ will be suppressed. the quark of the key, or 0 + line="2974">the quark of the key, or 0 @@ -94393,7 +96044,7 @@ will be suppressed. The "writable-changed" signal is emitted when the writability of a + line="3000">The "writable-changed" signal is emitted when the writability of a key has potentially changed. You should call g_settings_is_writable() in order to determine the new status. @@ -94407,7 +96058,7 @@ callbacks when the writability of "x" changes. the key + line="3003">the key @@ -94423,7 +96074,7 @@ callbacks when the writability of "x" changes. glib:type-struct="SettingsBackendClass"> The #GSettingsBackend interface defines a generic interface for + line="8280">The #GSettingsBackend interface defines a generic interface for non-strictly-typed data that is stored in a hierarchy. To implement an alternative storage backend for #GSettings, you need to implement the #GSettingsBackend interface and then make it implement the @@ -94453,7 +96104,7 @@ C preprocessor symbol %G_SETTINGS_ENABLE_BACKEND before including version="2.26"> Calculate the longest common prefix of all keys in a tree and write + line="32839">Calculate the longest common prefix of all keys in a tree and write out an array of the key names relative to that prefix and, optionally, the value to store at each of those keys. @@ -94468,7 +96119,7 @@ g_free(). You should not attempt to free or unref the contents of a #GTree containing the changes + line="32841">a #GTree containing the changes the location to save the path + line="32842">the location to save the path the + line="32843">the location to save the relative keys @@ -94500,7 +96151,7 @@ g_free(). You should not attempt to free or unref the contents of allow-none="1"> + line="32845"> the location to save the values, or %NULL @@ -94513,7 +96164,7 @@ g_free(). You should not attempt to free or unref the contents of version="2.28"> Returns the default #GSettingsBackend. It is possible to override + line="32860">Returns the default #GSettingsBackend. It is possible to override the default by setting the `GSETTINGS_BACKEND` environment variable to the name of a settings backend. @@ -94522,7 +96173,9 @@ The user gets a reference to the backend. the default #GSettingsBackend + line="32869">the default #GSettingsBackend, + which will be a dummy (memory) settings backend if no other settings + backend is available. @@ -94698,7 +96351,7 @@ The user gets a reference to the backend. version="2.26"> Signals that a single key has possibly changed. Backend + line="32792">Signals that a single key has possibly changed. Backend implementations should call this if a key has possibly changed its value. @@ -94728,13 +96381,13 @@ value that was passed to that call. a #GSettingsBackend implementation + line="32794">a #GSettingsBackend implementation the name of the key + line="32795">the name of the key allow-none="1"> the origin tag + line="32796">the origin tag @@ -94753,7 +96406,7 @@ value that was passed to that call. version="2.26"> This call is a convenience wrapper. It gets the list of changes from + line="32825">This call is a convenience wrapper. It gets the list of changes from @tree, computes the longest common prefix and calls g_settings_backend_changed(). @@ -94764,13 +96417,13 @@ g_settings_backend_changed(). a #GSettingsBackend implementation + line="32827">a #GSettingsBackend implementation a #GTree containing the changes + line="32828">a #GTree containing the changes allow-none="1"> the origin tag + line="32829">the origin tag @@ -94789,7 +96442,7 @@ g_settings_backend_changed(). version="2.26"> Signals that a list of keys have possibly changed. Backend + line="32876">Signals that a list of keys have possibly changed. Backend implementations should call this if keys have possibly changed their values. @@ -94818,19 +96471,19 @@ keys that were changed) but this is not strictly required. a #GSettingsBackend implementation + line="32878">a #GSettingsBackend implementation the path containing the changes + line="32879">the path containing the changes the %NULL-terminated list of changed keys + line="32880">the %NULL-terminated list of changed keys @@ -94841,7 +96494,7 @@ keys that were changed) but this is not strictly required. allow-none="1"> the origin tag + line="32881">the origin tag @@ -94851,7 +96504,7 @@ keys that were changed) but this is not strictly required. version="2.26"> Signals that all keys below a given path may have possibly changed. + line="32909">Signals that all keys below a given path may have possibly changed. Backend implementations should call this if an entire path of keys have possibly changed their values. @@ -94880,13 +96533,13 @@ single key in the application will be notified of a possible change. a #GSettingsBackend implementation + line="32911">a #GSettingsBackend implementation the path containing the changes + line="32912">the path containing the changes allow-none="1"> the origin tag + line="32913">the origin tag @@ -94905,7 +96558,7 @@ single key in the application will be notified of a possible change. version="2.26"> Signals that the writability of all keys below a given path may have + line="32941">Signals that the writability of all keys below a given path may have changed. Since GSettings performs no locking operations for itself, this call @@ -94918,13 +96571,13 @@ will always be made in response to external events. a #GSettingsBackend implementation + line="32943">a #GSettingsBackend implementation the name of the path + line="32944">the name of the path @@ -94934,7 +96587,7 @@ will always be made in response to external events. version="2.26"> Signals that the writability of a single key has possibly changed. + line="32956">Signals that the writability of a single key has possibly changed. Since GSettings performs no locking operations for itself, this call will always be made in response to external events. @@ -94946,13 +96599,13 @@ will always be made in response to external events. a #GSettingsBackend implementation + line="32958">a #GSettingsBackend implementation the name of the key + line="32959">the name of the key @@ -95184,7 +96837,8 @@ directions. + glib:nick="default" + glib:name="G_SETTINGS_BIND_DEFAULT"> Equivalent to `G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET` @@ -95192,7 +96846,8 @@ directions. + glib:nick="get" + glib:name="G_SETTINGS_BIND_GET"> Update the #GObject property when the setting changes. @@ -95201,7 +96856,8 @@ directions. + glib:nick="set" + glib:name="G_SETTINGS_BIND_SET"> Update the setting when the #GObject property changes. @@ -95210,7 +96866,8 @@ directions. + glib:nick="no-sensitivity" + glib:name="G_SETTINGS_BIND_NO_SENSITIVITY"> Do not try to bind a "sensitivity" property to the writability of the setting @@ -95218,7 +96875,8 @@ directions. + glib:nick="get-no-changes" + glib:name="G_SETTINGS_BIND_GET_NO_CHANGES"> When set in addition to #G_SETTINGS_BIND_GET, set the #GObject property @@ -95227,7 +96885,8 @@ directions. + glib:nick="invert-boolean" + glib:name="G_SETTINGS_BIND_INVERT_BOOLEAN"> When passed to g_settings_bind(), uses a pair of mapping functions that invert @@ -95452,7 +97111,7 @@ g_settings_get_mapped() c:symbol-prefix="settings_schema"> The #GSettingsSchemaSource and #GSettingsSchema APIs provide a + line="8314">The #GSettingsSchemaSource and #GSettingsSchema APIs provide a mechanism for advanced control over the loading of schemas and a mechanism for introspecting their content. @@ -95546,19 +97205,19 @@ itself before attempting to create the settings source. Get the ID of @schema. + line="33700">Get the ID of @schema. the ID + line="33706">the ID a #GSettingsSchema + line="33702">a #GSettingsSchema @@ -95568,7 +97227,7 @@ itself before attempting to create the settings source. version="2.40"> Gets the key named @name from @schema. + line="33710">Gets the key named @name from @schema. It is a programmer error to request a key that does not exist. See g_settings_schema_list_keys(). @@ -95576,20 +97235,20 @@ g_settings_schema_list_keys(). the #GSettingsSchemaKey for @name + line="33720">the #GSettingsSchemaKey for @name a #GSettingsSchema + line="33712">a #GSettingsSchema the name of a key + line="33713">the name of a key @@ -95599,7 +97258,7 @@ g_settings_schema_list_keys(). version="2.32"> Gets the path associated with @schema, or %NULL. + line="33725">Gets the path associated with @schema, or %NULL. Schemas may be single-instance or relocatable. Single-instance schemas correspond to exactly one set of keys in the backend @@ -95609,17 +97268,17 @@ Relocatable schemas can be referenced by other schemas and can therefore describe multiple sets of keys at different locations. For relocatable schemas, this function will return %NULL. - + the path of the schema, or %NULL + line="33739">the path of the schema, or %NULL a #GSettingsSchema + line="33727">a #GSettingsSchema @@ -95629,25 +97288,25 @@ relocatable schemas, this function will return %NULL. version="2.40"> Checks if @schema has a key named @name. + line="33744">Checks if @schema has a key named @name. %TRUE if such a key exists + line="33751">%TRUE if such a key exists a #GSettingsSchema + line="33746">a #GSettingsSchema the name of a key + line="33747">the name of a key @@ -95657,7 +97316,7 @@ relocatable schemas, this function will return %NULL. version="2.44"> Gets the list of children in @schema. + line="33922">Gets the list of children in @schema. You should free the return value with g_strfreev() when you are done with it. @@ -95665,7 +97324,7 @@ with it. a list of the children on + line="33931">a list of the children on @settings, in no defined order @@ -95675,7 +97334,7 @@ with it. a #GSettingsSchema + line="33924">a #GSettingsSchema @@ -95685,7 +97344,7 @@ with it. version="2.46"> Introspects the list of keys on @schema. + line="33937">Introspects the list of keys on @schema. You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This @@ -95694,7 +97353,7 @@ function is intended for introspection reasons. a list of the keys on + line="33947">a list of the keys on @schema, in no defined order @@ -95704,7 +97363,7 @@ function is intended for introspection reasons. a #GSettingsSchema + line="33939">a #GSettingsSchema @@ -95712,19 +97371,19 @@ function is intended for introspection reasons. Increase the reference count of @schema, returning a new reference. + line="33953">Increase the reference count of @schema, returning a new reference. a new reference to @schema + line="33959">a new reference to @schema a #GSettingsSchema + line="33955">a #GSettingsSchema @@ -95734,7 +97393,7 @@ function is intended for introspection reasons. version="2.32"> Decrease the reference count of @schema, possibly freeing it. + line="34098">Decrease the reference count of @schema, possibly freeing it. @@ -95743,7 +97402,7 @@ function is intended for introspection reasons. a #GSettingsSchema + line="34100">a #GSettingsSchema @@ -95756,7 +97415,7 @@ function is intended for introspection reasons. c:symbol-prefix="settings_schema_key"> #GSettingsSchemaKey is an opaque data structure and can only be accessed + line="3095">#GSettingsSchemaKey is an opaque data structure and can only be accessed using the following functions. version="2.40"> Gets the default value for @key. + line="33756">Gets the default value for @key. Note that this is the default value according to the schema. System administrator defaults and lockdown are not visible via this API. @@ -95772,14 +97431,14 @@ administrator defaults and lockdown are not visible via this API. the default value for the key + line="33765">the default value for the key a #GSettingsSchemaKey + line="33758">a #GSettingsSchemaKey @@ -95789,7 +97448,7 @@ administrator defaults and lockdown are not visible via this API. version="2.34"> Gets the description for @key. + line="33770">Gets the description for @key. If no description has been provided in the schema for @key, returns %NULL. @@ -95804,17 +97463,17 @@ the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory. - + the description for @key, or %NULL + line="33789">the description for @key, or %NULL a #GSettingsSchemaKey + line="33772">a #GSettingsSchemaKey @@ -95824,19 +97483,19 @@ directory. version="2.44"> Gets the name of @key. + line="33794">Gets the name of @key. the name of @key. + line="33800">the name of @key. a #GSettingsSchemaKey + line="33796">a #GSettingsSchemaKey @@ -95846,7 +97505,7 @@ directory. version="2.40"> Queries the range of a key. + line="33805">Queries the range of a key. This function will return a #GVariant that fully describes the range of values that are valid for @key. @@ -95886,14 +97545,14 @@ no longer needed. a #GVariant describing the range + line="33846">a #GVariant describing the range a #GSettingsSchemaKey + line="33807">a #GSettingsSchemaKey @@ -95903,7 +97562,7 @@ no longer needed. version="2.34"> Gets the summary for @key. + line="33851">Gets the summary for @key. If no summary has been provided in the schema for @key, returns %NULL. @@ -95917,17 +97576,17 @@ the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory. - + the summary for @key, or %NULL + line="33869">the summary for @key, or %NULL a #GSettingsSchemaKey + line="33853">a #GSettingsSchemaKey @@ -95937,19 +97596,19 @@ directory. version="2.40"> Gets the #GVariantType of @key. + line="33874">Gets the #GVariantType of @key. the type of @key + line="33880">the type of @key a #GSettingsSchemaKey + line="33876">a #GSettingsSchemaKey @@ -95959,29 +97618,29 @@ directory. version="2.40"> Checks if the given @value is of the correct type and within the + line="33885">Checks if the given @value is within the permitted range for @key. -It is a programmer error if @value is not of the correct type -- you +It is a programmer error if @value is not of the correct type — you must check for this first. %TRUE if @value is valid for @key + line="33896">%TRUE if @value is valid for @key a #GSettingsSchemaKey + line="33887">a #GSettingsSchemaKey the value to check + line="33888">the value to check @@ -95991,19 +97650,19 @@ must check for this first. version="2.40"> Increase the reference count of @key, returning a new reference. + line="33901">Increase the reference count of @key, returning a new reference. a new reference to @key + line="33907">a new reference to @key a #GSettingsSchemaKey + line="33903">a #GSettingsSchemaKey @@ -96013,7 +97672,7 @@ must check for this first. version="2.40"> Decrease the reference count of @key, possibly freeing it. + line="33912">Decrease the reference count of @key, possibly freeing it. @@ -96022,7 +97681,7 @@ must check for this first. a #GSettingsSchemaKey + line="33914">a #GSettingsSchemaKey @@ -96036,7 +97695,7 @@ must check for this first. c:symbol-prefix="settings_schema_source"> This is an opaque structure type. You may not access it directly. + line="3103">This is an opaque structure type. You may not access it directly. throws="1"> Attempts to create a new schema source corresponding to the contents + line="34034">Attempts to create a new schema source corresponding to the contents of the given directory. This function is not required for normal uses of #GSettings but it @@ -96083,7 +97742,7 @@ returned by g_settings_schema_source_get_default(). the filename of a directory + line="34036">the filename of a directory allow-none="1"> a #GSettingsSchemaSource, or %NULL + line="34037">a #GSettingsSchemaSource, or %NULL %TRUE, if the directory is trusted + line="34038">%TRUE, if the directory is trusted @@ -96108,7 +97767,7 @@ returned by g_settings_schema_source_get_default(). version="2.40"> Lists the schemas in a given source. + line="33986">Lists the schemas in a given source. If @recursive is %TRUE then include parent sources. If %FALSE then only include the schemas from one source (ie: one directory). You @@ -96128,13 +97787,13 @@ use by database editors, commandline tools, etc. a #GSettingsSchemaSource + line="33988">a #GSettingsSchemaSource if we should recurse + line="33989">if we should recurse transfer-ownership="full"> the + line="33990">the list of non-relocatable schemas, in no defined order @@ -96155,7 +97814,7 @@ use by database editors, commandline tools, etc. transfer-ownership="full"> the list + line="33992">the list of relocatable schemas, in no defined order @@ -96168,7 +97827,7 @@ use by database editors, commandline tools, etc. version="2.32"> Looks up a schema with the identifier @schema_id in @source. + line="34012">Looks up a schema with the identifier @schema_id in @source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -96182,26 +97841,26 @@ If the schema isn't found, %NULL is returned. a new #GSettingsSchema + line="34029">a new #GSettingsSchema a #GSettingsSchemaSource + line="34014">a #GSettingsSchemaSource a schema ID + line="34015">a schema ID %TRUE if the lookup should be recursive + line="34016">%TRUE if the lookup should be recursive @@ -96211,19 +97870,19 @@ If the schema isn't found, %NULL is returned. version="2.32"> Increase the reference count of @source, returning a new reference. + line="34077">Increase the reference count of @source, returning a new reference. a new reference to @source + line="34083">a new reference to @source a #GSettingsSchemaSource + line="34079">a #GSettingsSchemaSource @@ -96233,7 +97892,7 @@ If the schema isn't found, %NULL is returned. version="2.32"> Decrease the reference count of @source, possibly freeing it. + line="34088">Decrease the reference count of @source, possibly freeing it. @@ -96242,7 +97901,7 @@ If the schema isn't found, %NULL is returned. a #GSettingsSchemaSource + line="34090">a #GSettingsSchemaSource @@ -96252,7 +97911,7 @@ If the schema isn't found, %NULL is returned. version="2.32"> Gets the default system schema source. + line="33964">Gets the default system schema source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -96269,7 +97928,7 @@ recursively. the default schema source + line="33981">the default schema source @@ -96282,7 +97941,7 @@ recursively. glib:get-type="g_simple_action_get_type"> A #GSimpleAction is the obvious simple implementation of the #GAction + line="8415">A #GSimpleAction is the obvious simple implementation of the #GAction interface. This is the easiest way to create an action for purposes of adding it to a #GSimpleActionGroup. @@ -96293,7 +97952,7 @@ See also #GtkAction. version="2.28"> Creates a new action. + line="34451">Creates a new action. The created action is stateless. See g_simple_action_new_stateful() to create an action that has state. @@ -96301,14 +97960,14 @@ an action that has state. a new #GSimpleAction + line="34462">a new #GSimpleAction the name of the action + line="34453">the name of the action allow-none="1"> the type of parameter that will be passed to + line="34454">the type of parameter that will be passed to handlers for the #GSimpleAction::activate signal, or %NULL for no parameter @@ -96328,7 +97987,7 @@ an action that has state. version="2.28"> Creates a new stateful action. + line="34467">Creates a new stateful action. All future state values must have the same #GVariantType as the initial @state. @@ -96338,14 +97997,14 @@ If the @state #GVariant is floating, it is consumed. a new #GSimpleAction + line="34481">a new #GSimpleAction the name of the action + line="34469">the name of the action allow-none="1"> the type of the parameter that will be passed to + line="34470">the type of the parameter that will be passed to handlers for the #GSimpleAction::activate signal, or %NULL for no parameter the initial state of the action + line="34472">the initial state of the action Sets the action as enabled or not. + line="34486">Sets the action as enabled or not. An action must be enabled in order to be activated or in order to have its state changed from outside callers. @@ -96386,23 +98046,24 @@ of the action should not attempt to modify its enabled flag. a #GSimpleAction + line="34488">a #GSimpleAction whether the action is enabled + line="34489">whether the action is enabled Sets the state of the action. + line="34503">Sets the state of the action. This directly updates the 'state' property to the given value. @@ -96420,13 +98081,13 @@ If the @value GVariant is floating, it is consumed. a #GSimpleAction + line="34505">a #GSimpleAction the new #GVariant for the state + line="34506">the new #GVariant for the state @@ -96436,7 +98097,7 @@ If the @value GVariant is floating, it is consumed. version="2.44"> Sets the state hint for the action. + line="34523">Sets the state hint for the action. See g_action_get_state_hint() for more information about action state hints. @@ -96448,7 +98109,7 @@ action state hints. a #GSimpleAction + line="34525">a #GSimpleAction allow-none="1"> a #GVariant representing the state hint + line="34526">a #GVariant representing the state hint @@ -96465,10 +98126,11 @@ action state hints. + transfer-ownership="none" + setter="set_enabled"> If @action is currently enabled. + line="3187">If @action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. @@ -96481,7 +98143,7 @@ g_action_change_state() have no effect. transfer-ownership="none"> The name of the action. This is mostly meaningful for identifying + line="3199">The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GSimpleActionGroup. @@ -96492,7 +98154,7 @@ the action once it has been added to a #GSimpleActionGroup. transfer-ownership="none"> The type of the parameter that must be given when activating the + line="3209">The type of the parameter that must be given when activating the action. @@ -96500,23 +98162,24 @@ action. version="2.28" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_state"> The state of the action, or %NULL if the action is stateless. + line="3219">The state of the action, or %NULL if the action is stateless. The #GVariantType of the state that the action has, or %NULL if the + line="3228">The #GVariantType of the state that the action has, or %NULL if the action is stateless. Indicates that the action was just activated. + line="3120">Indicates that the action was just activated. @parameter will always be of the expected type, i.e. the parameter type specified when the action was created. If an incorrect type is given when @@ -96539,7 +98202,7 @@ of #GSimpleAction to connect only one handler or the other. allow-none="1"> the parameter to the activation, or %NULL if it has + line="3123">the parameter to the activation, or %NULL if it has no parameter @@ -96548,7 +98211,7 @@ of #GSimpleAction to connect only one handler or the other. Indicates that the action just received a request to change its + line="3144">Indicates that the action just received a request to change its state. @value will always be of the correct state type, i.e. the type of the @@ -96591,7 +98254,7 @@ It could set it to any value at all, or take some other action. allow-none="1"> the requested value for the state + line="3147">the requested value for the state @@ -96607,7 +98270,7 @@ It could set it to any value at all, or take some other action. glib:type-struct="SimpleActionGroupClass"> #GSimpleActionGroup is a hash table filled with #GAction objects, + line="8429">#GSimpleActionGroup is a hash table filled with #GAction objects, implementing the #GActionGroup and #GActionMap interfaces. @@ -96617,12 +98280,12 @@ implementing the #GActionGroup and #GActionMap interfaces. version="2.28"> Creates a new, empty, #GSimpleActionGroup. + line="34427">Creates a new, empty, #GSimpleActionGroup. a new #GSimpleActionGroup + line="34432">a new #GSimpleActionGroup @@ -96633,7 +98296,7 @@ implementing the #GActionGroup and #GActionMap interfaces. deprecated-version="2.38"> A convenience function for creating multiple #GSimpleAction instances + line="34379">A convenience function for creating multiple #GSimpleAction instances and adding them to the action group. Use g_action_map_add_action_entries() @@ -96644,13 +98307,13 @@ and adding them to the action group. a #GSimpleActionGroup + line="34381">a #GSimpleActionGroup a pointer to the first item in + line="34382">a pointer to the first item in an array of #GActionEntry structs @@ -96659,7 +98322,7 @@ and adding them to the action group. the length of @entries, or -1 + line="34384">the length of @entries, or -1 allow-none="1"> the user data for signal connections + line="34385">the user data for signal connections @@ -96680,7 +98343,7 @@ and adding them to the action group. deprecated-version="2.38"> Adds an action to the action group. + line="34395">Adds an action to the action group. If the action group already contains an action with the same name as @action then the old action is dropped from the group. @@ -96695,13 +98358,13 @@ The action group takes its own reference on @action. a #GSimpleActionGroup + line="34397">a #GSimpleActionGroup a #GAction + line="34398">a #GAction @@ -96713,7 +98376,7 @@ The action group takes its own reference on @action. deprecated-version="2.38"> Looks up the action with the name @action_name in the group. + line="34412">Looks up the action with the name @action_name in the group. If no such action exists, returns %NULL. Use g_action_map_lookup_action() @@ -96721,20 +98384,20 @@ If no such action exists, returns %NULL. a #GAction, or %NULL + line="34421">a #GAction, or %NULL a #GSimpleActionGroup + line="34414">a #GSimpleActionGroup the name of an action + line="34415">the name of an action @@ -96746,7 +98409,7 @@ If no such action exists, returns %NULL. deprecated-version="2.38"> Removes the named action from the action group. + line="34437">Removes the named action from the action group. If no action of this name is in the group then nothing happens. Use g_action_map_remove_action() @@ -96758,13 +98421,13 @@ If no action of this name is in the group then nothing happens. a #GSimpleActionGroup + line="34439">a #GSimpleActionGroup the name of the action + line="34440">the name of the action @@ -96804,7 +98467,7 @@ If no action of this name is in the group then nothing happens. glib:type-struct="SimpleAsyncResultClass"> As of GLib 2.46, #GSimpleAsyncResult is deprecated in favor of + line="8440">As of GLib 2.46, #GSimpleAsyncResult is deprecated in favor of #GTask, which provides a simpler API. #GSimpleAsyncResult implements #GAsyncResult. @@ -96977,7 +98640,7 @@ baker_bake_cake_finish (Baker *self, deprecated-version="2.46"> Creates a #GSimpleAsyncResult. + line="34688">Creates a #GSimpleAsyncResult. The common convention is to create the #GSimpleAsyncResult in the function that starts the asynchronous operation and use that same @@ -96992,7 +98655,7 @@ this function returns. a #GSimpleAsyncResult. + line="34706">a #GSimpleAsyncResult. @@ -97002,7 +98665,7 @@ this function returns. allow-none="1"> a #GObject, or %NULL. + line="34690">a #GObject, or %NULL. closure="2"> a #GAsyncReadyCallback. + line="34691">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="34692">user data passed to @callback. allow-none="1"> the asynchronous function. + line="34693">the asynchronous function. @@ -97043,13 +98706,13 @@ this function returns. deprecated-version="2.46"> Creates a new #GSimpleAsyncResult with a set error. + line="34711">Creates a new #GSimpleAsyncResult with a set error. Use g_task_new() and g_task_return_new_error() instead. a #GSimpleAsyncResult. + line="34723">a #GSimpleAsyncResult. @@ -97059,7 +98722,7 @@ this function returns. allow-none="1"> a #GObject, or %NULL. + line="34713">a #GObject, or %NULL. closure="2"> a #GAsyncReadyCallback. + line="34714">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="34715">user data passed to @callback. a #GQuark. + line="34716">a #GQuark. an error code. + line="34717">an error code. a string with format characters. + line="34718">a string with format characters. a list of values to insert into @format. + line="34719">a list of values to insert into @format. @@ -97114,13 +98777,13 @@ this function returns. deprecated-version="2.46"> Creates a #GSimpleAsyncResult from an error condition. + line="34728">Creates a #GSimpleAsyncResult from an error condition. Use g_task_new() and g_task_return_error() instead. a #GSimpleAsyncResult. + line="34737">a #GSimpleAsyncResult. @@ -97130,7 +98793,7 @@ this function returns. allow-none="1"> a #GObject, or %NULL. + line="34730">a #GObject, or %NULL. closure="2"> a #GAsyncReadyCallback. + line="34731">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="34732">user data passed to @callback. a #GError + line="34733">a #GError @@ -97169,14 +98832,14 @@ this function returns. deprecated-version="2.46"> Creates a #GSimpleAsyncResult from an error condition, and takes over the + line="34742">Creates a #GSimpleAsyncResult from an error condition, and takes over the caller's ownership of @error, so the caller does not need to free it anymore. Use g_task_new() and g_task_return_error() instead. a #GSimpleAsyncResult + line="34752">a #GSimpleAsyncResult @@ -97186,7 +98849,7 @@ caller's ownership of @error, so the caller does not need to free it anymore. a #GObject, or %NULL + line="34744">a #GObject, or %NULL a #GAsyncReadyCallback + line="34745">a #GAsyncReadyCallback user data passed to @callback + line="34746">user data passed to @callback a #GError + line="34747">a #GError @@ -97224,7 +98887,7 @@ caller's ownership of @error, so the caller does not need to free it anymore. Ensures that the data passed to the _finish function of an async + line="34663">Ensures that the data passed to the _finish function of an async operation is consistent. Three checks are performed. First, @result is checked to ensure that it is really a @@ -97241,14 +98904,14 @@ check is skipped.) #TRUE if all checks passed or #FALSE if any failed. + line="34682">#TRUE if all checks passed or #FALSE if any failed. the #GAsyncResult passed to the _finish function. + line="34665">the #GAsyncResult passed to the _finish function. allow-none="1"> the #GObject passed to the _finish function. + line="34666">the #GObject passed to the _finish function. allow-none="1"> the asynchronous function. + line="34667">the asynchronous function. @@ -97277,7 +98940,7 @@ check is skipped.) deprecated-version="2.46"> Completes an asynchronous I/O job immediately. Must be called in + line="34586">Completes an asynchronous I/O job immediately. Must be called in the thread where the asynchronous result was to be delivered, as it invokes the callback directly. If you are in a different thread use g_simple_async_result_complete_in_idle(). @@ -97293,7 +98956,7 @@ is needed to complete the call. a #GSimpleAsyncResult. + line="34588">a #GSimpleAsyncResult. @@ -97304,7 +98967,7 @@ is needed to complete the call. deprecated-version="2.46"> Completes an asynchronous function in an idle handler in the + line="34602">Completes an asynchronous function in an idle handler in the [thread-default main context][g-main-context-push-thread-default] of the thread that @simple was initially created in (and re-pushes that context around the invocation of the callback). @@ -97320,7 +98983,7 @@ is needed to complete the call. a #GSimpleAsyncResult. + line="34604">a #GSimpleAsyncResult. @@ -97331,13 +98994,13 @@ is needed to complete the call. deprecated-version="2.46"> Gets the operation result boolean from within the asynchronous result. + line="34618">Gets the operation result boolean from within the asynchronous result. Use #GTask and g_task_propagate_boolean() instead. %TRUE if the operation's result was %TRUE, %FALSE + line="34624">%TRUE if the operation's result was %TRUE, %FALSE if the operation's result was %FALSE. @@ -97345,7 +99008,7 @@ is needed to complete the call. a #GSimpleAsyncResult. + line="34620">a #GSimpleAsyncResult. @@ -97357,20 +99020,20 @@ is needed to complete the call. deprecated-version="2.46"> Gets a pointer result as returned by the asynchronous function. + line="34630">Gets a pointer result as returned by the asynchronous function. Use #GTask and g_task_propagate_pointer() instead. a pointer from the result. + line="34636">a pointer from the result. a #GSimpleAsyncResult. + line="34632">a #GSimpleAsyncResult. @@ -97381,20 +99044,20 @@ is needed to complete the call. deprecated-version="2.46"> Gets a gssize from the asynchronous result. + line="34641">Gets a gssize from the asynchronous result. Use #GTask and g_task_propagate_int() instead. a gssize returned from the asynchronous function. + line="34647">a gssize returned from the asynchronous function. a #GSimpleAsyncResult. + line="34643">a #GSimpleAsyncResult. @@ -97406,20 +99069,20 @@ is needed to complete the call. deprecated-version="2.46."> Gets the source tag for the #GSimpleAsyncResult. + line="34652">Gets the source tag for the #GSimpleAsyncResult. Use #GTask and g_task_get_source_tag() instead. a #gpointer to the source object for the #GSimpleAsyncResult. + line="34658">a #gpointer to the source object for the #GSimpleAsyncResult. a #GSimpleAsyncResult. + line="34654">a #GSimpleAsyncResult. @@ -97431,7 +99094,7 @@ is needed to complete the call. throws="1"> Propagates an error from within the simple asynchronous result to + line="34758">Propagates an error from within the simple asynchronous result to a given destination. If the #GCancellable given to a prior call to @@ -97442,14 +99105,14 @@ function will return %TRUE with @dest set appropriately. %TRUE if the error was propagated to @dest. %FALSE otherwise. + line="34770">%TRUE if the error was propagated to @dest. %FALSE otherwise. a #GSimpleAsyncResult. + line="34760">a #GSimpleAsyncResult. @@ -97461,7 +99124,7 @@ function will return %TRUE with @dest set appropriately. deprecated-version="2.46"> Runs the asynchronous job in a separate thread and then calls + line="34775">Runs the asynchronous job in a separate thread and then calls g_simple_async_result_complete_in_idle() on @simple to return the result to the appropriate main loop. @@ -97476,20 +99139,20 @@ is needed to run the job and report its completion. a #GSimpleAsyncResult. + line="34777">a #GSimpleAsyncResult. a #GSimpleAsyncThreadFunc. + line="34778">a #GSimpleAsyncThreadFunc. the io priority of the request. + line="34779">the io priority of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="34780">optional #GCancellable object, %NULL to ignore. @@ -97510,7 +99173,7 @@ is needed to run the job and report its completion. deprecated-version="2.46"> Sets a #GCancellable to check before dispatching results. + line="34793">Sets a #GCancellable to check before dispatching results. This function has one very specific purpose: the provided cancellable is checked at the time of g_simple_async_result_propagate_error() If @@ -97534,7 +99197,7 @@ unrelated g_simple_async_result_set_handle_cancellation() function. a #GSimpleAsyncResult + line="34795">a #GSimpleAsyncResult allow-none="1"> a #GCancellable to check, or %NULL to unset + line="34796">a #GCancellable to check, or %NULL to unset @@ -97555,7 +99218,7 @@ unrelated g_simple_async_result_set_handle_cancellation() function. deprecated-version="2.46"> Sets an error within the asynchronous result without a #GError. + line="34819">Sets an error within the asynchronous result without a #GError. Use #GTask and g_task_return_new_error() instead. @@ -97565,31 +99228,31 @@ unrelated g_simple_async_result_set_handle_cancellation() function. a #GSimpleAsyncResult. + line="34821">a #GSimpleAsyncResult. a #GQuark (usually #G_IO_ERROR). + line="34822">a #GQuark (usually #G_IO_ERROR). an error code. + line="34823">an error code. a formatted error reporting string. + line="34824">a formatted error reporting string. a list of variables to fill in @format. + line="34825">a list of variables to fill in @format. @@ -97601,7 +99264,7 @@ unrelated g_simple_async_result_set_handle_cancellation() function. deprecated-version="2.46"> Sets an error within the asynchronous result without a #GError. + line="34833">Sets an error within the asynchronous result without a #GError. Unless writing a binding, see g_simple_async_result_set_error(). Use #GTask and g_task_return_error() instead. @@ -97612,31 +99275,31 @@ Unless writing a binding, see g_simple_async_result_set_error(). a #GSimpleAsyncResult. + line="34835">a #GSimpleAsyncResult. a #GQuark (usually #G_IO_ERROR). + line="34836">a #GQuark (usually #G_IO_ERROR). an error code. + line="34837">an error code. a formatted error reporting string. + line="34838">a formatted error reporting string. va_list of arguments. + line="34839">va_list of arguments. @@ -97647,7 +99310,7 @@ Unless writing a binding, see g_simple_async_result_set_error(). deprecated-version="2.46"> Sets the result from a #GError. + line="34848">Sets the result from a #GError. Use #GTask and g_task_return_error() instead. @@ -97657,13 +99320,13 @@ Unless writing a binding, see g_simple_async_result_set_error(). a #GSimpleAsyncResult. + line="34850">a #GSimpleAsyncResult. #GError. + line="34851">#GError. @@ -97674,7 +99337,7 @@ Unless writing a binding, see g_simple_async_result_set_error(). deprecated-version="2.46"> Sets whether to handle cancellation within the asynchronous operation. + line="34859">Sets whether to handle cancellation within the asynchronous operation. This function has nothing to do with g_simple_async_result_set_check_cancellable(). It only refers to the @@ -97687,13 +99350,13 @@ g_simple_async_result_set_check_cancellable(). It only refers to the a #GSimpleAsyncResult. + line="34861">a #GSimpleAsyncResult. a #gboolean. + line="34862">a #gboolean. @@ -97704,7 +99367,7 @@ g_simple_async_result_set_check_cancellable(). It only refers to the deprecated-version="2.46"> Sets the operation result to a boolean within the asynchronous result. + line="34874">Sets the operation result to a boolean within the asynchronous result. Use #GTask and g_task_return_boolean() instead. @@ -97714,13 +99377,13 @@ g_simple_async_result_set_check_cancellable(). It only refers to the a #GSimpleAsyncResult. + line="34876">a #GSimpleAsyncResult. a #gboolean. + line="34877">a #gboolean. @@ -97732,7 +99395,7 @@ g_simple_async_result_set_check_cancellable(). It only refers to the deprecated-version="2.46"> Sets the operation result within the asynchronous result to a pointer. + line="34885">Sets the operation result within the asynchronous result to a pointer. Use #GTask and g_task_return_pointer() instead. @@ -97742,7 +99405,7 @@ g_simple_async_result_set_check_cancellable(). It only refers to the a #GSimpleAsyncResult. + line="34887">a #GSimpleAsyncResult. a pointer result from an asynchronous function. + line="34888">a pointer result from an asynchronous function. a #GDestroyNotify function. + line="34889">a #GDestroyNotify function. @@ -97770,7 +99433,7 @@ g_simple_async_result_set_check_cancellable(). It only refers to the deprecated-version="2.46"> Sets the operation result within the asynchronous result to + line="34897">Sets the operation result within the asynchronous result to the given @op_res. Use #GTask and g_task_return_int() instead. @@ -97781,13 +99444,13 @@ the given @op_res. a #GSimpleAsyncResult. + line="34899">a #GSimpleAsyncResult. a #gssize. + line="34900">a #gssize. @@ -97800,7 +99463,7 @@ the given @op_res. deprecated-version="2.46"> Sets the result from @error, and takes over the caller's ownership + line="34909">Sets the result from @error, and takes over the caller's ownership of @error, so the caller does not need to free it any more. Use #GTask and g_task_return_error() instead. @@ -97811,13 +99474,13 @@ of @error, so the caller does not need to free it any more. a #GSimpleAsyncResult + line="34911">a #GSimpleAsyncResult a #GError + line="34912">a #GError @@ -97832,9 +99495,9 @@ of @error, so the caller does not need to free it any more. Simple thread function that runs an asynchronous operation and + line="376">Simple thread function that runs an asynchronous operation and checks for cancellation. - + @@ -97842,13 +99505,13 @@ checks for cancellation. a #GSimpleAsyncResult. + line="378">a #GSimpleAsyncResult. a #GObject. + line="379">a #GObject. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="380">optional #GCancellable object, %NULL to ignore. @@ -97871,7 +99534,7 @@ checks for cancellation. glib:get-type="g_simple_io_stream_get_type"> GSimpleIOStream creates a #GIOStream from an arbitrary #GInputStream and + line="8614">GSimpleIOStream creates a #GIOStream from an arbitrary #GInputStream and #GOutputStream. This allows any pair of input and output streams to be used with #GIOStream methods. @@ -97884,26 +99547,26 @@ to take advantage of the methods provided by #GIOStream. version="2.44"> Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. + line="34922">Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. See also #GIOStream. a new #GSimpleIOStream instance. + line="34930">a new #GSimpleIOStream instance. a #GInputStream. + line="34924">a #GInputStream. a #GOutputStream. + line="34925">a #GOutputStream. @@ -97931,7 +99594,7 @@ See also #GIOStream. glib:get-type="g_simple_permission_get_type"> #GSimplePermission is a trivial implementation of #GPermission that + line="8633">#GSimplePermission is a trivial implementation of #GPermission that represents a permission that is either always or never allowed. The value is given at construction and doesn't change. @@ -97941,20 +99604,20 @@ Calling request or release will result in errors. version="2.26"> Creates a new #GPermission instance that represents an action that is + line="34935">Creates a new #GPermission instance that represents an action that is either always or never allowed. the #GSimplePermission, as a #GPermission + line="34942">the #GSimplePermission, as a #GPermission %TRUE if the action is allowed + line="34937">%TRUE if the action is allowed @@ -97970,7 +99633,7 @@ either always or never allowed. glib:type-struct="SimpleProxyResolverClass"> #GSimpleProxyResolver is a simple #GProxyResolver implementation + line="8647">#GSimpleProxyResolver is a simple #GProxyResolver implementation that handles a single default proxy, multiple URI-scheme-specific proxies, and a list of hosts that proxies should not be used for. @@ -97985,7 +99648,7 @@ with g_socket_client_set_proxy_resolver(). version="2.36"> Creates a new #GSimpleProxyResolver. See + line="34947">Creates a new #GSimpleProxyResolver. See #GSimpleProxyResolver:default-proxy and #GSimpleProxyResolver:ignore-hosts for more details on how the arguments are interpreted. @@ -97993,7 +99656,7 @@ arguments are interpreted. a new #GSimpleProxyResolver + line="34959">a new #GSimpleProxyResolver @@ -98003,7 +99666,7 @@ arguments are interpreted. allow-none="1"> the default proxy to use, eg + line="34949">the default proxy to use, eg "socks://192.168.1.1" @@ -98013,7 +99676,7 @@ arguments are interpreted. allow-none="1"> an optional list of hosts/IP addresses + line="34951">an optional list of hosts/IP addresses to not use a proxy for. @@ -98021,10 +99684,11 @@ arguments are interpreted. Sets the default proxy on @resolver, to be used for any URIs that + line="34964">Sets the default proxy on @resolver, to be used for any URIs that don't match #GSimpleProxyResolver:ignore-hosts or a proxy set via g_simple_proxy_resolver_set_uri_proxy(). @@ -98039,23 +99703,24 @@ the socks5, socks4a, and socks4 proxy types. a #GSimpleProxyResolver + line="34966">a #GSimpleProxyResolver the default proxy to use + line="34967">the default proxy to use Sets the list of ignored hosts. + line="34981">Sets the list of ignored hosts. See #GSimpleProxyResolver:ignore-hosts for more details on how the @ignore_hosts argument is interpreted. @@ -98067,13 +99732,13 @@ See #GSimpleProxyResolver:ignore-hosts for more details on how the a #GSimpleProxyResolver + line="34983">a #GSimpleProxyResolver %NULL-terminated list of hosts/IP addresses + line="34984">%NULL-terminated list of hosts/IP addresses to not use a proxy for @@ -98084,7 +99749,7 @@ See #GSimpleProxyResolver:ignore-hosts for more details on how the version="2.36"> Adds a URI-scheme-specific proxy to @resolver; URIs whose scheme + line="34996">Adds a URI-scheme-specific proxy to @resolver; URIs whose scheme matches @uri_scheme (and which don't match #GSimpleProxyResolver:ignore-hosts) will be proxied via @proxy. @@ -98100,27 +99765,30 @@ types. a #GSimpleProxyResolver + line="34998">a #GSimpleProxyResolver the URI scheme to add a proxy for + line="34999">the URI scheme to add a proxy for the proxy to use for @uri_scheme + line="35000">the proxy to use for @uri_scheme - + The default proxy URI that will be used for any URI that doesn't + line="3269">The default proxy URI that will be used for any URI that doesn't match #GSimpleProxyResolver:ignore-hosts, and doesn't match any of the schemes set with g_simple_proxy_resolver_set_uri_proxy(). @@ -98129,10 +99797,13 @@ Note that as a special case, if this URI starts with to all three of the socks5, socks4a, and socks4 proxy types. - + A list of hostnames and IP addresses that the resolver should + line="3282">A list of hostnames and IP addresses that the resolver should allow direct connections to. Entries can be in one of 4 formats: @@ -98241,7 +99912,7 @@ commonly used by other applications. glib:type-struct="SocketClass"> A #GSocket is a low-level networking primitive. It is a more or less + line="8666">A #GSocket is a low-level networking primitive. It is a more or less direct mapping of the BSD socket API in a portable GObject based API. It supports both the UNIX socket implementations and winsock2 on Windows. @@ -98301,7 +99972,7 @@ locking. throws="1"> Creates a new #GSocket with the defined family, type and protocol. + line="36911">Creates a new #GSocket with the defined family, type and protocol. If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type for the family and type is used. @@ -98318,7 +99989,7 @@ know the protocol number used for it. a #GSocket or %NULL on error. + line="36932">a #GSocket or %NULL on error. Free the returned object with g_object_unref(). @@ -98326,19 +99997,19 @@ know the protocol number used for it. the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4. + line="36913">the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4. the socket type to use. + line="36914">the socket type to use. the id of the protocol to use, or 0 for default. + line="36915">the id of the protocol to use, or 0 for default. @@ -98349,7 +100020,7 @@ know the protocol number used for it. throws="1"> Creates a new #GSocket from a native file descriptor + line="36938">Creates a new #GSocket from a native file descriptor or winsock SOCKET handle. This reads all the settings from the file descriptor so that @@ -98366,7 +100037,7 @@ descriptor. Instead, a GError will be set with code %G_IO_ERROR_FAILED a #GSocket or %NULL on error. + line="36957">a #GSocket or %NULL on error. Free the returned object with g_object_unref(). @@ -98374,7 +100045,7 @@ descriptor. Instead, a GError will be set with code %G_IO_ERROR_FAILED a native socket file descriptor. + line="36940">a native socket file descriptor. @@ -98385,7 +100056,7 @@ descriptor. Instead, a GError will be set with code %G_IO_ERROR_FAILED throws="1"> Accept incoming connections on a connection-based socket. This removes + line="35015">Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a #GSocket object for it. @@ -98399,7 +100070,7 @@ To be notified of an incoming connection, wait for the %G_IO_IN condition. a new #GSocket, or %NULL on error. + line="35032">a new #GSocket, or %NULL on error. Free the returned object with g_object_unref(). @@ -98407,7 +100078,7 @@ To be notified of an incoming connection, wait for the %G_IO_IN condition. a #GSocket. + line="35017">a #GSocket. allow-none="1"> a %GCancellable or %NULL + line="35018">a %GCancellable or %NULL @@ -98427,7 +100098,7 @@ To be notified of an incoming connection, wait for the %G_IO_IN condition. throws="1"> When a socket is created it is attached to an address family, but it + line="35157">When a socket is created it is attached to an address family, but it doesn't have an address in this family. g_socket_bind() assigns the address (sometimes called name) of the socket. @@ -98454,26 +100125,26 @@ UDP packets to an address with multiple listeners is not defined.) %TRUE on success, %FALSE on error. + line="35188">%TRUE on success, %FALSE on error. a #GSocket. + line="35159">a #GSocket. a #GSocketAddress specifying the local address. + line="35160">a #GSocketAddress specifying the local address. whether to allow reusing this address + line="35161">whether to allow reusing this address @@ -98484,21 +100155,21 @@ UDP packets to an address with multiple listeners is not defined.) throws="1"> Checks and resets the pending connect error for the socket. + line="35193">Checks and resets the pending connect error for the socket. This is used to check for errors when g_socket_connect() is used in non-blocking mode. %TRUE if no error, %FALSE otherwise, setting @error to the error + line="35202">%TRUE if no error, %FALSE otherwise, setting @error to the error a #GSocket + line="35195">a #GSocket @@ -98509,7 +100180,7 @@ used in non-blocking mode. throws="1"> Closes the socket, shutting down any active connection. + line="35790">Closes the socket, shutting down any active connection. Closing a socket does not wait for all outstanding I/O operations to finish, so the caller should not rely on them to be guaranteed @@ -98542,14 +100213,14 @@ does.) %TRUE on success, %FALSE on error + line="35825">%TRUE on success, %FALSE on error a #GSocket + line="35792">a #GSocket @@ -98559,7 +100230,7 @@ does.) version="2.22"> Checks on the readiness of @socket to perform operations. + line="35830">Checks on the readiness of @socket to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @socket. The result is returned. @@ -98580,20 +100251,20 @@ This call never blocks. the @GIOCondition mask of the current state + line="35853">the @GIOCondition mask of the current state a #GSocket + line="35832">a #GSocket a #GIOCondition mask to check + line="35833">a #GIOCondition mask to check @@ -98604,7 +100275,7 @@ This call never blocks. throws="1"> Waits for up to @timeout_us microseconds for @condition to become true + line="35858">Waits for up to @timeout_us microseconds for @condition to become true on @socket. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @@ -98624,26 +100295,26 @@ exact number of milliseconds. %TRUE if the condition was met, %FALSE otherwise + line="35883">%TRUE if the condition was met, %FALSE otherwise a #GSocket + line="35860">a #GSocket a #GIOCondition mask to wait for + line="35861">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, or -1 + line="35862">the maximum time (in microseconds) to wait, or -1 allow-none="1"> a #GCancellable, or %NULL + line="35863">a #GCancellable, or %NULL @@ -98663,7 +100334,7 @@ exact number of milliseconds. throws="1"> Waits for @condition to become true on @socket. When the condition + line="35888">Waits for @condition to become true on @socket. When the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if the @@ -98677,20 +100348,20 @@ See also g_socket_condition_timed_wait(). %TRUE if the condition was met, %FALSE otherwise + line="35906">%TRUE if the condition was met, %FALSE otherwise a #GSocket + line="35890">a #GSocket a #GIOCondition mask to wait for + line="35891">a #GIOCondition mask to wait for allow-none="1"> a #GCancellable, or %NULL + line="35892">a #GCancellable, or %NULL @@ -98710,7 +100381,7 @@ See also g_socket_condition_timed_wait(). throws="1"> Connect the socket to the specified remote address. + line="35911">Connect the socket to the specified remote address. For connection oriented socket this generally means we attempt to make a connection to the @address. For a connection-less socket it sets @@ -98730,20 +100401,20 @@ checked with g_socket_check_connect_result(). %TRUE if connected, %FALSE on error. + line="35935">%TRUE if connected, %FALSE on error. a #GSocket. + line="35913">a #GSocket. a #GSocketAddress specifying the remote address. + line="35914">a #GSocketAddress specifying the remote address. allow-none="1"> a %GCancellable or %NULL + line="35915">a %GCancellable or %NULL @@ -98762,20 +100433,20 @@ checked with g_socket_check_connect_result(). version="2.22"> Creates a #GSocketConnection subclass of the right type for + line="36031">Creates a #GSocketConnection subclass of the right type for @socket. a #GSocketConnection + line="36038">a #GSocketConnection a #GSocket + line="36033">a #GSocket @@ -98786,7 +100457,7 @@ checked with g_socket_check_connect_result(). introspectable="0"> Creates a #GSource that can be attached to a %GMainContext to monitor + line="36205">Creates a #GSource that can be attached to a %GMainContext to monitor for the availability of the specified @condition on the socket. The #GSource keeps a reference to the @socket. @@ -98810,20 +100481,20 @@ you call will then fail with a %G_IO_ERROR_TIMED_OUT. a newly allocated %GSource, free with g_source_unref(). + line="36232">a newly allocated %GSource, free with g_source_unref(). a #GSocket + line="36207">a #GSocket a #GIOCondition mask to monitor + line="36208">a #GIOCondition mask to monitor allow-none="1"> a %GCancellable or %NULL + line="36209">a %GCancellable or %NULL @@ -98842,7 +100513,7 @@ you call will then fail with a %G_IO_ERROR_TIMED_OUT. version="2.32"> Get the amount of data pending in the OS input buffer, without blocking. + line="36237">Get the amount of data pending in the OS input buffer, without blocking. If @socket is a UDP or SCTP socket, this will return the size of just the next packet, even if additional packets are buffered after @@ -98858,7 +100529,7 @@ exactly the right size. the number of bytes that can be read from the socket + line="36254">the number of bytes that can be read from the socket without blocking or truncating, or -1 on error. @@ -98866,54 +100537,56 @@ without blocking or truncating, or -1 on error. a #GSocket + line="36239">a #GSocket Gets the blocking mode of the socket. For details on blocking I/O, + line="36260">Gets the blocking mode of the socket. For details on blocking I/O, see g_socket_set_blocking(). %TRUE if blocking I/O is used, %FALSE otherwise. + line="36267">%TRUE if blocking I/O is used, %FALSE otherwise. a #GSocket. + line="36262">a #GSocket. Gets the broadcast setting on @socket; if %TRUE, + line="36272">Gets the broadcast setting on @socket; if %TRUE, it is possible to send packets to broadcast addresses. the broadcast setting on @socket + line="36280">the broadcast setting on @socket a #GSocket. + line="36274">a #GSocket. @@ -98924,7 +100597,7 @@ addresses. throws="1"> Returns the credentials of the foreign process connected to this + line="36285">Returns the credentials of the foreign process connected to this socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX sockets). @@ -98948,7 +100621,7 @@ g_unix_connection_receive_credentials() functions. %NULL if @error is set, otherwise a #GCredentials object + line="36311">%NULL if @error is set, otherwise a #GCredentials object that must be freed with g_object_unref(). @@ -98956,37 +100629,41 @@ that must be freed with g_object_unref(). a #GSocket. + line="36287">a #GSocket. Gets the socket family of the socket. + line="36317">Gets the socket family of the socket. a #GSocketFamily + line="36323">a #GSocketFamily a #GSocket. + line="36319">a #GSocket. - + Returns the underlying OS socket object. On unix this + line="36328">Returns the underlying OS socket object. On unix this is a socket file descriptor, and on Windows this is a Winsock2 SOCKET handle. This may be useful for doing platform specific or otherwise unusual operations @@ -98995,78 +100672,81 @@ on the socket. the file descriptor of the socket. + line="36338">the file descriptor of the socket. a #GSocket. + line="36330">a #GSocket. Gets the keepalive mode of the socket. For details on this, + line="36343">Gets the keepalive mode of the socket. For details on this, see g_socket_set_keepalive(). %TRUE if keepalive is active, %FALSE otherwise. + line="36350">%TRUE if keepalive is active, %FALSE otherwise. a #GSocket. + line="36345">a #GSocket. Gets the listen backlog setting of the socket. For details on this, + line="36355">Gets the listen backlog setting of the socket. For details on this, see g_socket_set_listen_backlog(). the maximum number of pending connections. + line="36362">the maximum number of pending connections. a #GSocket. + line="36357">a #GSocket. Try to get the local address of a bound socket. This is only + line="36367">Try to get the local address of a bound socket. This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting. a #GSocketAddress or %NULL on error. + line="36376">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). @@ -99074,54 +100754,56 @@ either explicitly or implicitly when connecting. a #GSocket. + line="36369">a #GSocket. Gets the multicast loopback setting on @socket; if %TRUE (the + line="36382">Gets the multicast loopback setting on @socket; if %TRUE (the default), outgoing multicast packets will be looped back to multicast listeners on the same host. the multicast loopback setting on @socket + line="36390">the multicast loopback setting on @socket a #GSocket. + line="36384">a #GSocket. Gets the multicast time-to-live setting on @socket; see + line="36395">Gets the multicast time-to-live setting on @socket; see g_socket_set_multicast_ttl() for more details. the multicast time-to-live setting on @socket + line="36402">the multicast time-to-live setting on @socket a #GSocket. + line="36397">a #GSocket. @@ -99132,7 +100814,7 @@ g_socket_set_multicast_ttl() for more details. throws="1"> Gets the value of an integer-valued option on @socket, as with + line="36407">Gets the value of an integer-valued option on @socket, as with getsockopt(). (If you need to fetch a non-integer-valued option, you will need to call getsockopt() directly.) @@ -99149,7 +100831,7 @@ g_socket_get_option() will handle the conversion internally. success or failure. On failure, @error will be set, and + line="36429">success or failure. On failure, @error will be set, and the system error value (`errno` or WSAGetLastError()) will still be set to the result of the getsockopt() call. @@ -99158,19 +100840,19 @@ g_socket_get_option() will handle the conversion internally. a #GSocket + line="36409">a #GSocket the "API level" of the option (eg, `SOL_SOCKET`) + line="36410">the "API level" of the option (eg, `SOL_SOCKET`) the "name" of the option (eg, `SO_BROADCAST`) + line="36411">the "name" of the option (eg, `SO_BROADCAST`) transfer-ownership="full"> return location for the option value + line="36412">return location for the option value Gets the socket protocol id the socket was created with. + line="36436">Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned. a protocol id, or -1 if unknown + line="36443">a protocol id, or -1 if unknown a #GSocket. + line="36438">a #GSocket. Try to get the remote address of a connected socket. This is only + line="36448">Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected. a #GSocketAddress or %NULL on error. + line="36456">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). @@ -99227,7 +100911,7 @@ useful for connection oriented sockets that have been connected. a #GSocket. + line="36450">a #GSocket. @@ -99237,63 +100921,67 @@ useful for connection oriented sockets that have been connected. version="2.22"> Gets the socket type of the socket. + line="36462">Gets the socket type of the socket. a #GSocketType + line="36468">a #GSocketType a #GSocket. + line="36464">a #GSocket. Gets the timeout setting of the socket. For details on this, see + line="36473">Gets the timeout setting of the socket. For details on this, see g_socket_set_timeout(). the timeout in seconds + line="36480">the timeout in seconds a #GSocket. + line="36475">a #GSocket. - + Gets the unicast time-to-live setting on @socket; see + line="36485">Gets the unicast time-to-live setting on @socket; see g_socket_set_ttl() for more details. the time-to-live setting on @socket + line="36492">the time-to-live setting on @socket a #GSocket. + line="36487">a #GSocket. @@ -99303,19 +100991,19 @@ g_socket_set_ttl() for more details. version="2.22"> Checks whether a socket is closed. + line="36497">Checks whether a socket is closed. %TRUE if socket is closed, %FALSE otherwise + line="36503">%TRUE if socket is closed, %FALSE otherwise a #GSocket + line="36499">a #GSocket @@ -99325,7 +101013,7 @@ g_socket_set_ttl() for more details. version="2.22"> Check whether the socket is connected. This is only useful for + line="36508">Check whether the socket is connected. This is only useful for connection-oriented sockets. If using g_socket_shutdown(), this function will return %TRUE until the @@ -99336,14 +101024,14 @@ g_socket_check_connect_result(). %TRUE if socket is connected, %FALSE otherwise. + line="36520">%TRUE if socket is connected, %FALSE otherwise. a #GSocket. + line="36510">a #GSocket. @@ -99354,7 +101042,7 @@ g_socket_check_connect_result(). throws="1"> Registers @socket to receive multicast messages sent to @group. + line="36525">Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind(). @@ -99372,26 +101060,26 @@ g_socket_join_multicast_group_ssm() instead. %TRUE on success, %FALSE on error. + line="36548">%TRUE on success, %FALSE on error. a #GSocket. + line="36527">a #GSocket. a #GInetAddress specifying the group address to join. + line="36528">a #GInetAddress specifying the group address to join. %TRUE if source-specific multicast should be used + line="36530">%TRUE if source-specific multicast should be used allow-none="1"> Name of the interface to use, or %NULL + line="36529">Name of the interface to use, or %NULL @@ -99411,7 +101099,7 @@ g_socket_join_multicast_group_ssm() instead. throws="1"> Registers @socket to receive multicast messages sent to @group. + line="36553">Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind(). @@ -99430,20 +101118,20 @@ packets from more than one source. %TRUE on success, %FALSE on error. + line="36578">%TRUE on success, %FALSE on error. a #GSocket. + line="36555">a #GSocket. a #GInetAddress specifying the group address to join. + line="36556">a #GInetAddress specifying the group address to join. allow-none="1"> a #GInetAddress specifying the + line="36557">a #GInetAddress specifying the source-specific multicast address or %NULL to ignore. @@ -99462,7 +101150,7 @@ source-specific multicast address or %NULL to ignore. allow-none="1"> Name of the interface to use, or %NULL + line="36559">Name of the interface to use, or %NULL @@ -99473,7 +101161,7 @@ source-specific multicast address or %NULL to ignore. throws="1"> Removes @socket from the multicast group defined by @group, @iface, + line="36583">Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group). @@ -99486,26 +101174,26 @@ g_socket_leave_multicast_group_ssm() instead. %TRUE on success, %FALSE on error. + line="36601">%TRUE on success, %FALSE on error. a #GSocket. + line="36585">a #GSocket. a #GInetAddress specifying the group address to leave. + line="36586">a #GInetAddress specifying the group address to leave. %TRUE if source-specific multicast was used + line="36588">%TRUE if source-specific multicast was used allow-none="1"> Interface used + line="36587">Interface used @@ -99525,7 +101213,7 @@ g_socket_leave_multicast_group_ssm() instead. throws="1"> Removes @socket from the multicast group defined by @group, @iface, + line="36606">Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group). @@ -99535,20 +101223,20 @@ unicast messages after calling this. %TRUE on success, %FALSE on error. + line="36622">%TRUE on success, %FALSE on error. a #GSocket. + line="36608">a #GSocket. a #GInetAddress specifying the group address to leave. + line="36609">a #GInetAddress specifying the group address to leave. allow-none="1"> a #GInetAddress specifying the + line="36610">a #GInetAddress specifying the source-specific multicast address or %NULL to ignore. @@ -99567,7 +101255,7 @@ source-specific multicast address or %NULL to ignore. allow-none="1"> Name of the interface to use, or %NULL + line="36612">Name of the interface to use, or %NULL @@ -99578,7 +101266,7 @@ source-specific multicast address or %NULL to ignore. throws="1"> Marks the socket as a server socket, i.e. a socket that is used + line="36627">Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using g_socket_accept(). Before calling this the socket must be bound to a local address using @@ -99590,14 +101278,14 @@ g_socket_set_listen_backlog(). %TRUE on success, %FALSE on error. + line="36641">%TRUE on success, %FALSE on error. a #GSocket. + line="36629">a #GSocket. @@ -99608,7 +101296,7 @@ g_socket_set_listen_backlog(). throws="1"> Receive data (up to @size bytes) from a socket. This is mainly used by + line="36963">Receive data (up to @size bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_receive_from() with @address set to %NULL. @@ -99635,7 +101323,7 @@ On error -1 is returned and @error is set accordingly. Number of bytes read, or 0 if the connection was closed by + line="36996">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error @@ -99643,7 +101331,7 @@ the peer, or -1 on error a #GSocket + line="36965">a #GSocket transfer-ownership="none"> + line="36966"> a buffer to read data into (which should be at least @size bytes long). @@ -99664,7 +101352,7 @@ the peer, or -1 on error transfer-ownership="full"> the number of bytes you want to read from the socket + line="36968">the number of bytes you want to read from the socket allow-none="1"> a %GCancellable or %NULL + line="36969">a %GCancellable or %NULL @@ -99684,7 +101372,7 @@ the peer, or -1 on error throws="1"> Receive data (up to @size bytes) from a socket. + line="37002">Receive data (up to @size bytes) from a socket. If @address is non-%NULL then @address will be set equal to the source address of the received packet. @@ -99695,7 +101383,7 @@ See g_socket_receive() for additional information. Number of bytes read, or 0 if the connection was closed by + line="37021">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error @@ -99703,7 +101391,7 @@ the peer, or -1 on error a #GSocket + line="37004">a #GSocket allow-none="1"> a pointer to a #GSocketAddress + line="37005">a pointer to a #GSocketAddress pointer, or %NULL @@ -99724,7 +101412,7 @@ the peer, or -1 on error transfer-ownership="none"> + line="37007"> a buffer to read data into (which should be at least @size bytes long). @@ -99736,7 +101424,7 @@ the peer, or -1 on error transfer-ownership="full"> the number of bytes you want to read from the socket + line="37009">the number of bytes you want to read from the socket allow-none="1"> a %GCancellable or %NULL + line="37010">a %GCancellable or %NULL @@ -99756,7 +101444,7 @@ the peer, or -1 on error throws="1"> Receive data from a socket. For receiving multiple messages, see + line="37027">Receive data from a socket. For receiving multiple messages, see g_socket_receive_messages(); for easier use, see g_socket_receive() and g_socket_receive_from(). @@ -99819,7 +101507,7 @@ On error -1 is returned and @error is set accordingly. Number of bytes read, or 0 if the connection was closed by + line="37104">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error @@ -99827,7 +101515,7 @@ the peer, or -1 on error a #GSocket + line="37029">a #GSocket allow-none="1"> a pointer to a #GSocketAddress + line="37030">a pointer to a #GSocketAddress pointer, or %NULL an array of #GInputVector structs + line="37032">an array of #GInputVector structs @@ -99853,7 +101541,7 @@ the peer, or -1 on error the number of elements in @vectors, or -1 + line="37033">the number of elements in @vectors, or -1 allow-none="1"> a pointer + line="37034">a pointer which may be filled with an array of #GSocketControlMessages, or %NULL transfer-ownership="full"> a pointer which will be filled with the number of + line="37036">a pointer which will be filled with the number of elements in @messages, or %NULL @@ -99890,7 +101578,7 @@ the peer, or -1 on error transfer-ownership="full"> a pointer to an int containing #GSocketMsgFlags flags, + line="37038">a pointer to an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -99901,7 +101589,7 @@ the peer, or -1 on error allow-none="1"> a %GCancellable or %NULL + line="37041">a %GCancellable or %NULL @@ -99912,7 +101600,7 @@ the peer, or -1 on error throws="1"> Receive multiple data messages from @socket in one go. This is the most + line="37110">Receive multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_receive(), g_socket_receive_from(), and g_socket_receive_message(). @@ -99964,7 +101652,7 @@ messages successfully received before the error will be returned. number of messages received, or -1 on error. Note that the number + line="37170">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if in non-blocking mode, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -99975,13 +101663,13 @@ messages successfully received before the error will be returned. a #GSocket + line="37112">a #GSocket an array of #GInputMessage structs + line="37113">an array of #GInputMessage structs @@ -99989,13 +101677,13 @@ messages successfully received before the error will be returned. the number of elements in @messages + line="37114">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation, + line="37115">an int containing #GSocketMsgFlags flags for the overall operation, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -100006,7 +101694,7 @@ messages successfully received before the error will be returned. allow-none="1"> a %GCancellable or %NULL + line="37118">a %GCancellable or %NULL @@ -100017,14 +101705,14 @@ messages successfully received before the error will be returned. throws="1"> This behaves exactly the same as g_socket_receive(), except that + line="37179">This behaves exactly the same as g_socket_receive(), except that the choice of blocking or non-blocking behavior is determined by the @blocking argument rather than by @socket's properties. Number of bytes read, or 0 if the connection was closed by + line="37193">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error @@ -100032,7 +101720,7 @@ the peer, or -1 on error a #GSocket + line="37181">a #GSocket transfer-ownership="none"> + line="37182"> a buffer to read data into (which should be at least @size bytes long). @@ -100053,13 +101741,13 @@ the peer, or -1 on error transfer-ownership="full"> the number of bytes you want to read from the socket + line="37184">the number of bytes you want to read from the socket whether to do blocking or non-blocking I/O + line="37185">whether to do blocking or non-blocking I/O allow-none="1"> a %GCancellable or %NULL + line="37186">a %GCancellable or %NULL @@ -100079,7 +101767,7 @@ the peer, or -1 on error throws="1"> Tries to send @size bytes from @buffer on the socket. This is + line="37199">Tries to send @size bytes from @buffer on the socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_send_to() with @address set to %NULL. @@ -100097,7 +101785,7 @@ On error -1 is returned and @error is set accordingly. Number of bytes written (which may be less than @size), or -1 + line="37223">Number of bytes written (which may be less than @size), or -1 on error @@ -100105,13 +101793,13 @@ on error a #GSocket + line="37201">a #GSocket the buffer + line="37202">the buffer containing the data to send. @@ -100120,7 +101808,7 @@ on error the number of bytes to send + line="37204">the number of bytes to send allow-none="1"> a %GCancellable or %NULL + line="37205">a %GCancellable or %NULL @@ -100140,7 +101828,7 @@ on error throws="1"> Send data to @address on @socket. For sending multiple messages see + line="37229">Send data to @address on @socket. For sending multiple messages see g_socket_send_messages(); for easier use, see g_socket_send() and g_socket_send_to(). @@ -100176,12 +101864,17 @@ will be returned. To be notified when space is available, wait for the notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.) +The sum of the sizes of each #GOutputVector in vectors must not be +greater than %G_MAXSSIZE. If the message can be larger than this, +then it is mandatory to use the g_socket_send_message_with_timeout() +function. + On error -1 is returned and @error is set accordingly. Number of bytes written (which may be less than @size), or -1 + line="37286">Number of bytes written (which may be less than @size), or -1 on error @@ -100189,7 +101882,7 @@ on error a #GSocket + line="37231">a #GSocket allow-none="1"> a #GSocketAddress, or %NULL + line="37232">a #GSocketAddress, or %NULL an array of #GOutputVector structs + line="37233">an array of #GOutputVector structs @@ -100212,7 +101905,7 @@ on error the number of elements in @vectors, or -1 + line="37234">the number of elements in @vectors, or -1 allow-none="1"> a pointer to an + line="37235">a pointer to an array of #GSocketControlMessages, or %NULL. number of elements in @messages, or -1. + line="37237">number of elements in @messages, or -1. an int containing #GSocketMsgFlags flags, which may additionally + line="37238">an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -100249,7 +101942,7 @@ on error allow-none="1"> a %GCancellable or %NULL + line="37240">a %GCancellable or %NULL @@ -100260,7 +101953,7 @@ on error throws="1"> This behaves exactly the same as g_socket_send_message(), except that + line="37292">This behaves exactly the same as g_socket_send_message(), except that the choice of timeout behavior is determined by the @timeout_us argument rather than by @socket's properties. @@ -100271,7 +101964,7 @@ returned. @bytes_written will contain 0 in both cases. %G_POLLABLE_RETURN_OK if all data was successfully written, + line="37316">%G_POLLABLE_RETURN_OK if all data was successfully written, %G_POLLABLE_RETURN_WOULD_BLOCK if the socket is currently not writable, or %G_POLLABLE_RETURN_FAILED if an error happened and @error is set. @@ -100280,7 +101973,7 @@ returned. @bytes_written will contain 0 in both cases. a #GSocket + line="37294">a #GSocket allow-none="1"> a #GSocketAddress, or %NULL + line="37295">a #GSocketAddress, or %NULL an array of #GOutputVector structs + line="37296">an array of #GOutputVector structs @@ -100305,7 +101998,7 @@ returned. @bytes_written will contain 0 in both cases. the number of elements in @vectors, or -1 + line="37297">the number of elements in @vectors, or -1 allow-none="1"> a pointer to an + line="37298">a pointer to an array of #GSocketControlMessages, or %NULL. number of elements in @messages, or -1. + line="37300">number of elements in @messages, or -1. an int containing #GSocketMsgFlags flags, which may additionally + line="37301">an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) the maximum time (in microseconds) to wait, or -1 + line="37303">the maximum time (in microseconds) to wait, or -1 allow-none="1"> location to store the number of bytes that were written to the socket + line="37304">location to store the number of bytes that were written to the socket allow-none="1"> a %GCancellable or %NULL + line="37305">a %GCancellable or %NULL @@ -100370,7 +102063,7 @@ returned. @bytes_written will contain 0 in both cases. throws="1"> Send multiple data messages from @socket in one go. This is the most + line="37323">Send multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_send(), g_socket_send_to(), and g_socket_send_message(). @@ -100408,7 +102101,7 @@ successfully sent before the error will be returned. number of messages sent, or -1 on error. Note that the number of + line="37368">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if the socket is non-blocking or if @num_messages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to send the remaining messages. @@ -100418,13 +102111,13 @@ successfully sent before the error will be returned. a #GSocket + line="37325">a #GSocket an array of #GOutputMessage structs + line="37326">an array of #GOutputMessage structs @@ -100432,13 +102125,13 @@ successfully sent before the error will be returned. the number of elements in @messages + line="37327">the number of elements in @messages an int containing #GSocketMsgFlags flags, which may additionally + line="37328">an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -100448,7 +102141,7 @@ successfully sent before the error will be returned. allow-none="1"> a %GCancellable or %NULL + line="37330">a %GCancellable or %NULL @@ -100459,7 +102152,7 @@ successfully sent before the error will be returned. throws="1"> Tries to send @size bytes from @buffer to @address. If @address is + line="37376">Tries to send @size bytes from @buffer to @address. If @address is %NULL then the message is sent to the default receiver (set by g_socket_connect()). @@ -100468,7 +102161,7 @@ See g_socket_send() for additional information. Number of bytes written (which may be less than @size), or -1 + line="37392">Number of bytes written (which may be less than @size), or -1 on error @@ -100476,7 +102169,7 @@ on error a #GSocket + line="37378">a #GSocket allow-none="1"> a #GSocketAddress, or %NULL + line="37379">a #GSocketAddress, or %NULL the buffer + line="37380">the buffer containing the data to send. @@ -100500,7 +102193,7 @@ on error the number of bytes to send + line="37382">the number of bytes to send allow-none="1"> a %GCancellable or %NULL + line="37383">a %GCancellable or %NULL @@ -100520,14 +102213,14 @@ on error throws="1"> This behaves exactly the same as g_socket_send(), except that + line="37398">This behaves exactly the same as g_socket_send(), except that the choice of blocking or non-blocking behavior is determined by the @blocking argument rather than by @socket's properties. Number of bytes written (which may be less than @size), or -1 + line="37412">Number of bytes written (which may be less than @size), or -1 on error @@ -100535,13 +102228,13 @@ on error a #GSocket + line="37400">a #GSocket the buffer + line="37401">the buffer containing the data to send. @@ -100550,13 +102243,13 @@ on error the number of bytes to send + line="37403">the number of bytes to send whether to do blocking or non-blocking I/O + line="37404">whether to do blocking or non-blocking I/O allow-none="1"> a %GCancellable or %NULL + line="37405">a %GCancellable or %NULL Sets the blocking mode of the socket. In blocking mode + line="37488">Sets the blocking mode of the socket. In blocking mode all operations (which don’t take an explicit blocking parameter) block until they succeed or there is an error. In non-blocking mode all functions return results immediately or @@ -100592,23 +102286,24 @@ is a GSocket level feature. a #GSocket. + line="37490">a #GSocket. Whether to use blocking I/O or not. + line="37491">Whether to use blocking I/O or not. Sets whether @socket should allow sending to broadcast addresses. + line="37507">Sets whether @socket should allow sending to broadcast addresses. This is %FALSE by default. @@ -100618,13 +102313,13 @@ This is %FALSE by default. a #GSocket. + line="37509">a #GSocket. whether @socket should allow sending to broadcast + line="37510">whether @socket should allow sending to broadcast addresses @@ -100632,10 +102327,11 @@ This is %FALSE by default. Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When + line="37520">Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When this flag is set on a socket, the system will attempt to verify that the remote socket endpoint is still present if a sufficiently long period of time passes with no data being exchanged. If the system is unable to @@ -100658,23 +102354,24 @@ garbage-collected if clients crash or become unreachable. a #GSocket. + line="37522">a #GSocket. Value for the keepalive flag + line="37523">Value for the keepalive flag Sets the maximum number of outstanding connections allowed + line="37545">Sets the maximum number of outstanding connections allowed when listening on this socket. If more clients than this are connecting to the socket and the application is not handling them on time then the new connections will be refused. @@ -100689,23 +102386,24 @@ effect if called after that. a #GSocket. + line="37547">a #GSocket. the maximum number of pending connections. + line="37548">the maximum number of pending connections. Sets whether outgoing multicast packets will be received by sockets + line="37562">Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is %TRUE by default. @@ -100716,13 +102414,13 @@ by default. a #GSocket. + line="37564">a #GSocket. whether @socket should receive messages sent to its + line="37565">whether @socket should receive messages sent to its multicast groups from the local host @@ -100730,10 +102428,11 @@ by default. Sets the time-to-live for outgoing multicast datagrams on @socket. + line="37576">Sets the time-to-live for outgoing multicast datagrams on @socket. By default, this is 1, meaning that multicast packets will not leave the local network. @@ -100744,13 +102443,13 @@ the local network. a #GSocket. + line="37578">a #GSocket. the time-to-live value for all multicast datagrams on @socket + line="37579">the time-to-live value for all multicast datagrams on @socket @@ -100761,7 +102460,7 @@ the local network. throws="1"> Sets the value of an integer-valued option on @socket, as with + line="37589">Sets the value of an integer-valued option on @socket, as with setsockopt(). (If you need to set a non-integer-valued option, you will need to call setsockopt() directly.) @@ -100774,7 +102473,7 @@ headers. success or failure. On failure, @error will be set, and + line="37607">success or failure. On failure, @error will be set, and the system error value (`errno` or WSAGetLastError()) will still be set to the result of the setsockopt() call. @@ -100783,35 +102482,36 @@ headers. a #GSocket + line="37591">a #GSocket the "API level" of the option (eg, `SOL_SOCKET`) + line="37592">the "API level" of the option (eg, `SOL_SOCKET`) the "name" of the option (eg, `SO_BROADCAST`) + line="37593">the "name" of the option (eg, `SO_BROADCAST`) the value to set the option to + line="37594">the value to set the option to Sets the time in seconds after which I/O operations on @socket will + line="37614">Sets the time in seconds after which I/O operations on @socket will time out if they have not yet completed. On a blocking socket, this means that any blocking #GSocket @@ -100839,21 +102539,24 @@ cause the timeout to be reset. a #GSocket. + line="37616">a #GSocket. the timeout for @socket, in seconds, or 0 for none + line="37617">the timeout for @socket, in seconds, or 0 for none - + Sets the time-to-live for outgoing unicast packets on @socket. + line="37644">Sets the time-to-live for outgoing unicast packets on @socket. By default the platform-specific default value is used. @@ -100863,13 +102566,13 @@ By default the platform-specific default value is used. a #GSocket. + line="37646">a #GSocket. the time-to-live value for all unicast packets on @socket + line="37647">the time-to-live value for all unicast packets on @socket @@ -100880,7 +102583,7 @@ By default the platform-specific default value is used. throws="1"> Shut down part or all of a full-duplex connection. + line="37656">Shut down part or all of a full-duplex connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. @@ -100898,26 +102601,26 @@ other side saw all sent data. %TRUE on success, %FALSE on error + line="37678">%TRUE on success, %FALSE on error a #GSocket + line="37658">a #GSocket whether to shut down the read side + line="37659">whether to shut down the read side whether to shut down the write side + line="37660">whether to shut down the write side @@ -100927,7 +102630,7 @@ other side saw all sent data. version="2.22"> Checks if a socket is capable of speaking IPv4. + line="37683">Checks if a socket is capable of speaking IPv4. IPv4 sockets are capable of speaking IPv4. On some operating systems and under some combinations of circumstances IPv6 sockets are also @@ -100940,94 +102643,123 @@ of speaking IPv4. %TRUE if this socket can be used with IPv4. + line="37697">%TRUE if this socket can be used with IPv4. a #GSocket + line="37685">a #GSocket - + + transfer-ownership="none" + setter="set_broadcast" + getter="get_broadcast"> Whether the socket should allow sending to broadcast addresses. + line="3322">Whether the socket should allow sending to broadcast addresses. + transfer-ownership="none" + getter="get_family"> + transfer-ownership="none" + getter="get_fd"> - + - + - + + transfer-ownership="none" + setter="set_multicast_loopback" + getter="get_multicast_loopback"> Whether outgoing multicast packets loop back to the local host. + line="3331">Whether outgoing multicast packets loop back to the local host. + transfer-ownership="none" + setter="set_multicast_ttl" + getter="get_multicast_ttl"> Time-to-live out outgoing multicast packets + line="3340">Time-to-live out outgoing multicast packets + transfer-ownership="none" + getter="get_protocol"> - + + transfer-ownership="none" + setter="set_timeout" + getter="get_timeout"> The timeout in seconds on socket I/O + line="3349">The timeout in seconds on socket I/O + transfer-ownership="none" + setter="set_ttl" + getter="get_ttl"> Time-to-live for outgoing unicast packets + line="3358">Time-to-live for outgoing unicast packets glib:type-struct="SocketAddressClass"> #GSocketAddress is the equivalent of struct sockaddr in the BSD + line="8728">#GSocketAddress is the equivalent of struct sockaddr in the BSD sockets API. This is an abstract class; use #GInetSocketAddress for internet sockets, or #GUnixSocketAddress for UNIX domain sockets. @@ -101063,13 +102795,13 @@ for internet sockets, or #GUnixSocketAddress for UNIX domain sockets. version="2.22"> Creates a #GSocketAddress subclass corresponding to the native + line="35122">Creates a #GSocketAddress subclass corresponding to the native struct sockaddr @native. a new #GSocketAddress if @native could successfully + line="35130">a new #GSocketAddress if @native could successfully be converted, otherwise %NULL @@ -101077,13 +102809,13 @@ struct sockaddr @native. a pointer to a struct sockaddr + line="35124">a pointer to a struct sockaddr the size of the memory location pointed to by @native + line="35125">the size of the memory location pointed to by @native @@ -101091,19 +102823,19 @@ struct sockaddr @native. Gets the socket family type of @address. + line="35097">Gets the socket family type of @address. the socket family type of @address + line="35103">the socket family type of @address a #GSocketAddress + line="35099">a #GSocketAddress @@ -101113,14 +102845,14 @@ struct sockaddr @native. version="2.22"> Gets the size of @address's native struct sockaddr. + line="35108">Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). the size of the native struct sockaddr that + line="35116">the size of the native struct sockaddr that @address represents @@ -101128,7 +102860,7 @@ g_socket_address_to_native(). a #GSocketAddress + line="35110">a #GSocketAddress @@ -101139,7 +102871,7 @@ g_socket_address_to_native(). throws="1"> Converts a #GSocketAddress to a native struct sockaddr, which can + line="35136">Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a %G_IO_ERROR_NO_SPACE error @@ -101149,14 +102881,14 @@ then a %G_IO_ERROR_NOT_SUPPORTED error is returned. %TRUE if @dest was filled in, %FALSE on error + line="35152">%TRUE if @dest was filled in, %FALSE on error a #GSocketAddress + line="35138">a #GSocketAddress allow-none="1"> a pointer to a memory location that will contain the native + line="35139">a pointer to a memory location that will contain the native struct sockaddr the size of @dest. Must be at least as large as + line="35141">the size of @dest. Must be at least as large as g_socket_address_get_native_size() @@ -101180,22 +102912,23 @@ struct sockaddr Gets the socket family type of @address. + line="35097">Gets the socket family type of @address. the socket family type of @address + line="35103">the socket family type of @address a #GSocketAddress + line="35099">a #GSocketAddress @@ -101205,14 +102938,14 @@ struct sockaddr version="2.22"> Gets the size of @address's native struct sockaddr. + line="35108">Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). the size of the native struct sockaddr that + line="35116">the size of the native struct sockaddr that @address represents @@ -101220,7 +102953,7 @@ g_socket_address_to_native(). a #GSocketAddress + line="35110">a #GSocketAddress @@ -101231,7 +102964,7 @@ g_socket_address_to_native(). throws="1"> Converts a #GSocketAddress to a native struct sockaddr, which can + line="35136">Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a %G_IO_ERROR_NO_SPACE error @@ -101241,14 +102974,14 @@ then a %G_IO_ERROR_NOT_SUPPORTED error is returned. %TRUE if @dest was filled in, %FALSE on error + line="35152">%TRUE if @dest was filled in, %FALSE on error a #GSocketAddress + line="35138">a #GSocketAddress allow-none="1"> a pointer to a memory location that will contain the native + line="35139">a pointer to a memory location that will contain the native struct sockaddr the size of @dest. Must be at least as large as + line="35141">the size of @dest. Must be at least as large as g_socket_address_get_native_size() - + @@ -101290,14 +103023,14 @@ struct sockaddr the socket family type of @address + line="35103">the socket family type of @address a #GSocketAddress + line="35099">a #GSocketAddress @@ -101309,7 +103042,7 @@ struct sockaddr the size of the native struct sockaddr that + line="35116">the size of the native struct sockaddr that @address represents @@ -101317,7 +103050,7 @@ struct sockaddr a #GSocketAddress + line="35110">a #GSocketAddress @@ -101329,14 +103062,14 @@ struct sockaddr %TRUE if @dest was filled in, %FALSE on error + line="35152">%TRUE if @dest was filled in, %FALSE on error a #GSocketAddress + line="35138">a #GSocketAddress allow-none="1"> a pointer to a memory location that will contain the native + line="35139">a pointer to a memory location that will contain the native struct sockaddr the size of @dest. Must be at least as large as + line="35141">the size of @dest. Must be at least as large as g_socket_address_get_native_size() @@ -101370,7 +103103,7 @@ struct sockaddr glib:type-struct="SocketAddressEnumeratorClass"> #GSocketAddressEnumerator is an enumerator type for #GSocketAddress + line="8740">#GSocketAddressEnumerator is an enumerator type for #GSocketAddress instances. It is returned by enumeration functions such as g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator to list each #GSocketAddress which could be used to connect to that @@ -101388,7 +103121,7 @@ be unreffed. Retrieves the next #GSocketAddress from @enumerator. Note that this + line="35038">Retrieves the next #GSocketAddress from @enumerator. Note that this may block for some amount of time. (Eg, a #GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid @@ -101405,7 +103138,7 @@ ignored. a #GSocketAddress (owned by the caller), or %NULL on + line="35058">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -101414,7 +103147,7 @@ ignored. a #GSocketAddressEnumerator + line="35040">a #GSocketAddressEnumerator @@ -101424,7 +103157,7 @@ ignored. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35041">optional #GCancellable object, %NULL to ignore. @@ -101432,7 +103165,7 @@ ignored. Asynchronously retrieves the next #GSocketAddress from @enumerator + line="35064">Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result. @@ -101445,7 +103178,7 @@ It is an error to call this multiple times before the previous callback has fini a #GSocketAddressEnumerator + line="35066">a #GSocketAddressEnumerator @@ -101455,7 +103188,7 @@ It is an error to call this multiple times before the previous callback has fini allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35067">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request + line="35068">a #GAsyncReadyCallback to call when the request is satisfied @@ -101477,7 +103210,7 @@ It is an error to call this multiple times before the previous callback has fini closure="2"> the data to pass to callback function + line="35070">the data to pass to callback function @@ -101485,7 +103218,7 @@ It is an error to call this multiple times before the previous callback has fini Retrieves the result of a completed call to + line="35080">Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling. @@ -101493,7 +103226,7 @@ error handling. a #GSocketAddress (owned by the caller), or %NULL on + line="35091">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -101502,14 +103235,14 @@ error handling. a #GSocketAddressEnumerator + line="35082">a #GSocketAddressEnumerator a #GAsyncResult + line="35083">a #GAsyncResult @@ -101519,7 +103252,7 @@ error handling. throws="1"> Retrieves the next #GSocketAddress from @enumerator. Note that this + line="35038">Retrieves the next #GSocketAddress from @enumerator. Note that this may block for some amount of time. (Eg, a #GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid @@ -101536,7 +103269,7 @@ ignored. a #GSocketAddress (owned by the caller), or %NULL on + line="35058">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -101545,7 +103278,7 @@ ignored. a #GSocketAddressEnumerator + line="35040">a #GSocketAddressEnumerator @@ -101555,7 +103288,7 @@ ignored. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35041">optional #GCancellable object, %NULL to ignore. @@ -101564,7 +103297,7 @@ ignored. c:identifier="g_socket_address_enumerator_next_async"> Asynchronously retrieves the next #GSocketAddress from @enumerator + line="35064">Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result. @@ -101577,7 +103310,7 @@ It is an error to call this multiple times before the previous callback has fini a #GSocketAddressEnumerator + line="35066">a #GSocketAddressEnumerator @@ -101587,7 +103320,7 @@ It is an error to call this multiple times before the previous callback has fini allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35067">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request + line="35068">a #GAsyncReadyCallback to call when the request is satisfied @@ -101608,7 +103341,7 @@ It is an error to call this multiple times before the previous callback has fini allow-none="1"> the data to pass to callback function + line="35070">the data to pass to callback function @@ -101618,7 +103351,7 @@ It is an error to call this multiple times before the previous callback has fini throws="1"> Retrieves the result of a completed call to + line="35080">Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling. @@ -101626,7 +103359,7 @@ error handling. a #GSocketAddress (owned by the caller), or %NULL on + line="35091">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -101635,14 +103368,14 @@ error handling. a #GSocketAddressEnumerator + line="35082">a #GSocketAddressEnumerator a #GAsyncResult + line="35083">a #GAsyncResult @@ -101667,7 +103400,7 @@ error handling. a #GSocketAddress (owned by the caller), or %NULL on + line="35058">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -101676,7 +103409,7 @@ error handling. a #GSocketAddressEnumerator + line="35040">a #GSocketAddressEnumerator @@ -101686,7 +103419,7 @@ error handling. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35041">optional #GCancellable object, %NULL to ignore. @@ -101702,7 +103435,7 @@ error handling. a #GSocketAddressEnumerator + line="35066">a #GSocketAddressEnumerator @@ -101712,7 +103445,7 @@ error handling. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35067">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback to call when the request + line="35068">a #GAsyncReadyCallback to call when the request is satisfied @@ -101734,7 +103467,7 @@ error handling. closure="3"> the data to pass to callback function + line="35070">the data to pass to callback function @@ -101746,7 +103479,7 @@ error handling. a #GSocketAddress (owned by the caller), or %NULL on + line="35091">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -101755,14 +103488,14 @@ error handling. a #GSocketAddressEnumerator + line="35082">a #GSocketAddressEnumerator a #GAsyncResult + line="35083">a #GAsyncResult @@ -101867,7 +103600,7 @@ error handling. glib:type-struct="SocketClientClass"> #GSocketClient is a lightweight high-level utility class for connecting to + line="8762">#GSocketClient is a lightweight high-level utility class for connecting to a network host using a connection oriented socket type. You create a #GSocketClient object, set any options you want, and then @@ -101886,12 +103619,12 @@ can just create a new one any time you need one. version="2.22"> Creates a new #GSocketClient with the default options. + line="35622">Creates a new #GSocketClient with the default options. a #GSocketClient. + line="35627">a #GSocketClient. Free the returned object with g_object_unref(). @@ -101920,7 +103653,7 @@ can just create a new one any time you need one. c:identifier="g_socket_client_add_application_proxy"> Enable proxy protocols to be handled by the application. When the + line="35207">Enable proxy protocols to be handled by the application. When the indicated proxy protocol is returned by the #GProxyResolver, #GSocketClient will consider this protocol as supported but will not try to find a #GProxy instance to handle handshaking. The @@ -101947,13 +103680,13 @@ specific handshake. a #GSocketClient + line="35209">a #GSocketClient The proxy protocol + line="35210">The proxy protocol @@ -101964,7 +103697,7 @@ specific handshake. throws="1"> Tries to resolve the @connectable and make a network connection to it. + line="35234">Tries to resolve the @connectable and make a network connection to it. Upon a successful connection, a new #GSocketConnection is constructed and returned. The caller owns this new object and must drop their @@ -101986,20 +103719,20 @@ socket will be bound to this address before connecting. a #GSocketConnection on success, %NULL on error. + line="35260">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + line="35236">a #GSocketClient. a #GSocketConnectable specifying the remote address. + line="35237">a #GSocketConnectable specifying the remote address. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="35238">optional #GCancellable object, %NULL to ignore. @@ -102018,7 +103751,16 @@ socket will be bound to this address before connecting. version="2.22"> This is the asynchronous version of g_socket_client_connect(). + line="35265">This is the asynchronous version of g_socket_client_connect(). + +You may wish to prefer the asynchronous version even in synchronous +command line programs because, since 2.60, it implements +[RFC 8305](https://tools.ietf.org/html/rfc8305) "Happy Eyeballs" +recommendations to work around long connection timeouts in networks +where IPv6 is broken by performing an IPv4 connection simultaneously +without waiting for IPv6 to time out, which is not supported by the +synchronous call. (This is not an API guarantee, and may change in +the future.) When the operation is finished @callback will be called. You can then call g_socket_client_connect_finish() to get @@ -102031,13 +103773,13 @@ the result of the operation. a #GSocketClient + line="35267">a #GSocketClient a #GSocketConnectable specifying the remote address. + line="35268">a #GSocketConnectable specifying the remote address. allow-none="1"> a #GCancellable, or %NULL + line="35269">a #GCancellable, or %NULL closure="3"> a #GAsyncReadyCallback + line="35270">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="35271">user data for the callback @@ -102077,25 +103819,25 @@ the result of the operation. throws="1"> Finishes an async connect operation. See g_socket_client_connect_async() + line="35292">Finishes an async connect operation. See g_socket_client_connect_async() a #GSocketConnection on success, %NULL on error. + line="35301">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + line="35294">a #GSocketClient. a #GAsyncResult. + line="35295">a #GAsyncResult. @@ -102106,7 +103848,7 @@ the result of the operation. throws="1"> This is a helper function for g_socket_client_connect(). + line="35306">This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection to the named host. @@ -102140,26 +103882,26 @@ accordingly. a #GSocketConnection on success, %NULL on error. + line="35345">a #GSocketConnection on success, %NULL on error. a #GSocketClient + line="35308">a #GSocketClient the name and optionally port of the host to connect to + line="35309">the name and optionally port of the host to connect to the default port to connect to + line="35310">the default port to connect to allow-none="1"> a #GCancellable, or %NULL + line="35311">a #GCancellable, or %NULL @@ -102178,7 +103920,7 @@ accordingly. version="2.22"> This is the asynchronous version of g_socket_client_connect_to_host(). + line="35350">This is the asynchronous version of g_socket_client_connect_to_host(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_to_host_finish() to get @@ -102191,19 +103933,19 @@ the result of the operation. a #GSocketClient + line="35352">a #GSocketClient the name and optionally the port of the host to connect to + line="35353">the name and optionally the port of the host to connect to the default port to connect to + line="35354">the default port to connect to allow-none="1"> a #GCancellable, or %NULL + line="35355">a #GCancellable, or %NULL closure="4"> a #GAsyncReadyCallback + line="35356">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="35357">user data for the callback @@ -102243,25 +103985,25 @@ the result of the operation. throws="1"> Finishes an async connect operation. See g_socket_client_connect_to_host_async() + line="35369">Finishes an async connect operation. See g_socket_client_connect_to_host_async() a #GSocketConnection on success, %NULL on error. + line="35378">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + line="35371">a #GSocketClient. a #GAsyncResult. + line="35372">a #GAsyncResult. @@ -102271,7 +104013,7 @@ the result of the operation. throws="1"> Attempts to create a TCP connection to a service. + line="35383">Attempts to create a TCP connection to a service. This call looks up the SRV record for @service at @domain for the "tcp" protocol. It then attempts to connect, in turn, to each of @@ -102289,26 +104031,26 @@ accordingly. a #GSocketConnection if successful, or %NULL on error + line="35406">a #GSocketConnection if successful, or %NULL on error a #GSocketConnection + line="35385">a #GSocketConnection a domain name + line="35386">a domain name the name of the service to connect to + line="35387">the name of the service to connect to allow-none="1"> a #GCancellable, or %NULL + line="35388">a #GCancellable, or %NULL @@ -102327,7 +104069,7 @@ accordingly. version="2.22"> This is the asynchronous version of + line="35410">This is the asynchronous version of g_socket_client_connect_to_service(). @@ -102337,19 +104079,19 @@ g_socket_client_connect_to_service(). a #GSocketClient + line="35412">a #GSocketClient a domain name + line="35413">a domain name the name of the service to connect to + line="35414">the name of the service to connect to allow-none="1"> a #GCancellable, or %NULL + line="35415">a #GCancellable, or %NULL closure="4"> a #GAsyncReadyCallback + line="35416">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="35417">user data for the callback @@ -102389,25 +104131,25 @@ g_socket_client_connect_to_service(). throws="1"> Finishes an async connect operation. See g_socket_client_connect_to_service_async() + line="35426">Finishes an async connect operation. See g_socket_client_connect_to_service_async() a #GSocketConnection on success, %NULL on error. + line="35435">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + line="35428">a #GSocketClient. a #GAsyncResult. + line="35429">a #GAsyncResult. @@ -102418,7 +104160,7 @@ g_socket_client_connect_to_service(). throws="1"> This is a helper function for g_socket_client_connect(). + line="35440">This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection with a network URI. @@ -102443,26 +104185,26 @@ accordingly. a #GSocketConnection on success, %NULL on error. + line="35470">a #GSocketConnection on success, %NULL on error. a #GSocketClient + line="35442">a #GSocketClient A network URI + line="35443">A network URI the default port to connect to + line="35444">the default port to connect to allow-none="1"> a #GCancellable, or %NULL + line="35445">a #GCancellable, or %NULL @@ -102481,7 +104223,7 @@ accordingly. version="2.26"> This is the asynchronous version of g_socket_client_connect_to_uri(). + line="35475">This is the asynchronous version of g_socket_client_connect_to_uri(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_to_uri_finish() to get @@ -102494,19 +104236,19 @@ the result of the operation. a #GSocketClient + line="35477">a #GSocketClient a network uri + line="35478">a network uri the default port to connect to + line="35479">the default port to connect to allow-none="1"> a #GCancellable, or %NULL + line="35480">a #GCancellable, or %NULL closure="4"> a #GAsyncReadyCallback + line="35481">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="35482">user data for the callback @@ -102546,136 +104288,141 @@ the result of the operation. throws="1"> Finishes an async connect operation. See g_socket_client_connect_to_uri_async() + line="35494">Finishes an async connect operation. See g_socket_client_connect_to_uri_async() a #GSocketConnection on success, %NULL on error. + line="35503">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + line="35496">a #GSocketClient. a #GAsyncResult. + line="35497">a #GAsyncResult. Gets the proxy enable state; see g_socket_client_set_enable_proxy() + line="35508">Gets the proxy enable state; see g_socket_client_set_enable_proxy() whether proxying is enabled + line="35514">whether proxying is enabled a #GSocketClient. + line="35510">a #GSocketClient. Gets the socket family of the socket client. + line="35519">Gets the socket family of the socket client. See g_socket_client_set_family() for details. a #GSocketFamily + line="35527">a #GSocketFamily a #GSocketClient. + line="35521">a #GSocketClient. Gets the local address of the socket client. + line="35532">Gets the local address of the socket client. See g_socket_client_set_local_address() for details. - + a #GSocketAddress or %NULL. Do not free. + line="35540">a #GSocketAddress or %NULL. Do not free. a #GSocketClient. + line="35534">a #GSocketClient. Gets the protocol name type of the socket client. + line="35545">Gets the protocol name type of the socket client. See g_socket_client_set_protocol() for details. a #GSocketProtocol + line="35553">a #GSocketProtocol a #GSocketClient + line="35547">a #GSocketClient Gets the #GProxyResolver being used by @client. Normally, this will + line="35558">Gets the #GProxyResolver being used by @client. Normally, this will be the resolver returned by g_proxy_resolver_get_default(), but you can override it with g_socket_client_set_proxy_resolver(). The #GProxyResolver being used by + line="35566">The #GProxyResolver being used by @client. @@ -102683,7 +104430,7 @@ can override it with g_socket_client_set_proxy_resolver(). a #GSocketClient. + line="35560">a #GSocketClient. @@ -102693,101 +104440,105 @@ can override it with g_socket_client_set_proxy_resolver(). version="2.22"> Gets the socket type of the socket client. + line="35572">Gets the socket type of the socket client. See g_socket_client_set_socket_type() for details. a #GSocketFamily + line="35580">a #GSocketFamily a #GSocketClient. + line="35574">a #GSocketClient. Gets the I/O timeout time for sockets created by @client. + line="35585">Gets the I/O timeout time for sockets created by @client. See g_socket_client_set_timeout() for details. the timeout in seconds + line="35593">the timeout in seconds a #GSocketClient + line="35587">a #GSocketClient Gets whether @client creates TLS connections. See + line="35598">Gets whether @client creates TLS connections. See g_socket_client_set_tls() for details. whether @client uses TLS + line="35605">whether @client uses TLS a #GSocketClient. + line="35600">a #GSocketClient. Gets the TLS validation flags used creating TLS connections via + line="35610">Gets the TLS validation flags used creating TLS connections via @client. the TLS validation flags + line="35617">the TLS validation flags a #GSocketClient. + line="35612">a #GSocketClient. Sets whether or not @client attempts to make connections via a + line="35633">Sets whether or not @client attempts to make connections via a proxy server. When enabled (the default), #GSocketClient will use a #GProxyResolver to determine if a proxy protocol such as SOCKS is needed, and automatically do the necessary proxy negotiation. @@ -102801,23 +104552,24 @@ See also g_socket_client_set_proxy_resolver(). a #GSocketClient. + line="35635">a #GSocketClient. whether to enable proxies + line="35636">whether to enable proxies Sets the socket family of the socket client. + line="35649">Sets the socket family of the socket client. If this is set to something other than %G_SOCKET_FAMILY_INVALID then the sockets created by this object will be of the specified family. @@ -102833,23 +104585,24 @@ be an ipv6 mapped to ipv4 address. a #GSocketClient. + line="35651">a #GSocketClient. a #GSocketFamily + line="35652">a #GSocketFamily Sets the local address of the socket client. + line="35667">Sets the local address of the socket client. The sockets created by this object will bound to the specified address (if not %NULL) before connecting. @@ -102864,7 +104617,7 @@ a specific interface. a #GSocketClient. + line="35669">a #GSocketClient. allow-none="1"> a #GSocketAddress, or %NULL + line="35670">a #GSocketAddress, or %NULL Sets the protocol of the socket client. + line="35684">Sets the protocol of the socket client. The sockets created by this object will use of the specified protocol. @@ -102897,23 +104651,24 @@ protocol for the socket family and type. a #GSocketClient. + line="35686">a #GSocketClient. a #GSocketProtocol + line="35687">a #GSocketProtocol Overrides the #GProxyResolver used by @client. You can call this if + line="35700">Overrides the #GProxyResolver used by @client. You can call this if you want to use specific proxies, rather than using the system default proxy settings. @@ -102928,7 +104683,7 @@ changed by this function (but which is %TRUE by default) a #GSocketClient. + line="35702">a #GSocketClient. allow-none="1"> a #GProxyResolver, or %NULL for the + line="35703">a #GProxyResolver, or %NULL for the default. @@ -102948,7 +104703,7 @@ changed by this function (but which is %TRUE by default) version="2.22"> Sets the socket type of the socket client. + line="35718">Sets the socket type of the socket client. The sockets created by this object will be of the specified type. @@ -102962,23 +104717,24 @@ as GSocketClient is used for connection oriented services. a #GSocketClient. + line="35720">a #GSocketClient. a #GSocketType + line="35721">a #GSocketType Sets the I/O timeout for sockets created by @client. @timeout is a + line="35734">Sets the I/O timeout for sockets created by @client. @timeout is a time in seconds, or 0 for no timeout (the default). The timeout value affects the initial connection attempt as well, @@ -102992,23 +104748,24 @@ to fail with %G_IO_ERROR_TIMED_OUT. a #GSocketClient. + line="35736">a #GSocketClient. the timeout + line="35737">the timeout Sets whether @client creates TLS (aka SSL) connections. If @tls is + line="35750">Sets whether @client creates TLS (aka SSL) connections. If @tls is %TRUE, @client will wrap its connections in a #GTlsClientConnection and perform a TLS handshake when connecting. @@ -103034,23 +104791,24 @@ starts. a #GSocketClient. + line="35752">a #GSocketClient. whether to use TLS + line="35753">whether to use TLS Sets the TLS validation flags used when creating TLS connections + line="35778">Sets the TLS validation flags used when creating TLS connections via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. @@ -103060,13 +104818,13 @@ via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. a #GSocketClient. + line="35780">a #GSocketClient. the validation flags + line="35781">the validation flags @@ -103074,53 +104832,69 @@ via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. + transfer-ownership="none" + setter="set_enable_proxy" + getter="get_enable_proxy"> + transfer-ownership="none" + setter="set_family" + getter="get_family"> + transfer-ownership="none" + setter="set_local_address" + getter="get_local_address"> + transfer-ownership="none" + setter="set_protocol" + getter="get_protocol"> + transfer-ownership="none" + setter="set_proxy_resolver" + getter="get_proxy_resolver"> The proxy resolver to use + line="3436">The proxy resolver to use + transfer-ownership="none" + setter="set_timeout" + getter="get_timeout"> + transfer-ownership="none" + setter="set_tls" + getter="get_tls"> + transfer-ownership="none" + setter="set_tls_validation_flags" + getter="get_tls_validation_flags"> Emitted when @client's activity on @connectable changes state. + line="3375">Emitted when @client's activity on @connectable changes state. Among other things, this can be used to provide progress information about a network connection in the UI. The meanings of the different @event values are as follows: @@ -103182,7 +104956,7 @@ Each event except %G_SOCKET_CLIENT_COMPLETE may be emitted multiple times (or not at all) for a given connectable (in particular, if @client ends up attempting to connect to more than one address). However, if @client emits the #GSocketClient::event -signal at all for a given connectable, that it will always emit +signal at all for a given connectable, then it will always emit it with %G_SOCKET_CLIENT_COMPLETE when it is done. Note that there may be additional #GSocketClientEvent values in @@ -103194,13 +104968,13 @@ the future; unrecognized @event values should be ignored. the event that is occurring + line="3378">the event that is occurring the #GSocketConnectable that @event is occurring on + line="3379">the #GSocketConnectable that @event is occurring on allow-none="1"> the current representation of the connection + line="3380">the current representation of the connection @@ -103284,87 +105058,96 @@ the future; unrecognized @event values should be ignored. c:type="GSocketClientEvent"> Describes an event occurring on a #GSocketClient. See the + line="1878">Describes an event occurring on a #GSocketClient. See the #GSocketClient::event signal for more details. Additional values may be added to this type in the future. + glib:nick="resolving" + glib:name="G_SOCKET_CLIENT_RESOLVING"> The client is doing a DNS lookup. + line="1880">The client is doing a DNS lookup. + glib:nick="resolved" + glib:name="G_SOCKET_CLIENT_RESOLVED"> The client has completed a DNS lookup. + line="1881">The client has completed a DNS lookup. + glib:nick="connecting" + glib:name="G_SOCKET_CLIENT_CONNECTING"> The client is connecting to a remote + line="1882">The client is connecting to a remote host (either a proxy or the destination server). + glib:nick="connected" + glib:name="G_SOCKET_CLIENT_CONNECTED"> The client has connected to a remote + line="1884">The client has connected to a remote host. + glib:nick="proxy-negotiating" + glib:name="G_SOCKET_CLIENT_PROXY_NEGOTIATING"> The client is negotiating + line="1886">The client is negotiating with a proxy to connect to the destination server. + glib:nick="proxy-negotiated" + glib:name="G_SOCKET_CLIENT_PROXY_NEGOTIATED"> The client has negotiated + line="1888">The client has negotiated with the proxy server. + glib:nick="tls-handshaking" + glib:name="G_SOCKET_CLIENT_TLS_HANDSHAKING"> The client is performing a + line="1890">The client is performing a TLS handshake. + glib:nick="tls-handshaked" + glib:name="G_SOCKET_CLIENT_TLS_HANDSHAKED"> The client has performed a + line="1892">The client has performed a TLS handshake. + glib:nick="complete" + glib:name="G_SOCKET_CLIENT_COMPLETE"> The client is done with a particular + line="1894">The client is done with a particular #GSocketConnectable. @@ -103381,7 +105164,7 @@ Additional values may be added to this type in the future. glib:type-struct="SocketConnectableIface"> Objects that describe one or more potential socket endpoints + line="8786">Objects that describe one or more potential socket endpoints implement #GSocketConnectable. Callers can then use g_socket_connectable_enumerate() to get a #GSocketAddressEnumerator to try out each socket address in turn until one succeeds, as shown @@ -103442,12 +105225,12 @@ connect_to_host (const char *hostname, Creates a #GSocketAddressEnumerator for @connectable. + line="35940">Creates a #GSocketAddressEnumerator for @connectable. a new #GSocketAddressEnumerator. + line="35946">a new #GSocketAddressEnumerator. @@ -103455,7 +105238,7 @@ connect_to_host (const char *hostname, a #GSocketConnectable + line="35942">a #GSocketConnectable @@ -103465,7 +105248,7 @@ connect_to_host (const char *hostname, version="2.26"> Creates a #GSocketAddressEnumerator for @connectable that will + line="35951">Creates a #GSocketAddressEnumerator for @connectable that will return a #GProxyAddress for each of its addresses that you must connect to via a proxy. @@ -103476,7 +105259,7 @@ calling g_socket_connectable_enumerate(). a new #GSocketAddressEnumerator. + line="35963">a new #GSocketAddressEnumerator. @@ -103484,7 +105267,7 @@ calling g_socket_connectable_enumerate(). a #GSocketConnectable + line="35953">a #GSocketConnectable @@ -103492,7 +105275,7 @@ calling g_socket_connectable_enumerate(). Format a #GSocketConnectable as a string. This is a human-readable format for + line="35968">Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user. @@ -103503,14 +105286,14 @@ the implementation’s type name will be returned as a fallback. the formatted string + line="35980">the formatted string a #GSocketConnectable + line="35970">a #GSocketConnectable @@ -103520,12 +105303,12 @@ the implementation’s type name will be returned as a fallback. version="2.22"> Creates a #GSocketAddressEnumerator for @connectable. + line="35940">Creates a #GSocketAddressEnumerator for @connectable. a new #GSocketAddressEnumerator. + line="35946">a new #GSocketAddressEnumerator. @@ -103533,7 +105316,7 @@ the implementation’s type name will be returned as a fallback. a #GSocketConnectable + line="35942">a #GSocketConnectable @@ -103543,7 +105326,7 @@ the implementation’s type name will be returned as a fallback. version="2.26"> Creates a #GSocketAddressEnumerator for @connectable that will + line="35951">Creates a #GSocketAddressEnumerator for @connectable that will return a #GProxyAddress for each of its addresses that you must connect to via a proxy. @@ -103554,7 +105337,7 @@ calling g_socket_connectable_enumerate(). a new #GSocketAddressEnumerator. + line="35963">a new #GSocketAddressEnumerator. @@ -103562,7 +105345,7 @@ calling g_socket_connectable_enumerate(). a #GSocketConnectable + line="35953">a #GSocketConnectable @@ -103572,7 +105355,7 @@ calling g_socket_connectable_enumerate(). version="2.48"> Format a #GSocketConnectable as a string. This is a human-readable format for + line="35968">Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user. @@ -103583,14 +105366,14 @@ the implementation’s type name will be returned as a fallback. the formatted string + line="35980">the formatted string a #GSocketConnectable + line="35970">a #GSocketConnectable @@ -103616,7 +105399,7 @@ and #GProxyAddressEnumerator a new #GSocketAddressEnumerator. + line="35946">a new #GSocketAddressEnumerator. @@ -103624,7 +105407,7 @@ and #GProxyAddressEnumerator a #GSocketConnectable + line="35942">a #GSocketConnectable @@ -103636,7 +105419,7 @@ and #GProxyAddressEnumerator a new #GSocketAddressEnumerator. + line="35963">a new #GSocketAddressEnumerator. @@ -103644,7 +105427,7 @@ and #GProxyAddressEnumerator a #GSocketConnectable + line="35953">a #GSocketConnectable @@ -103656,14 +105439,14 @@ and #GProxyAddressEnumerator the formatted string + line="35980">the formatted string a #GSocketConnectable + line="35970">a #GSocketConnectable @@ -103680,7 +105463,7 @@ and #GProxyAddressEnumerator glib:type-struct="SocketConnectionClass"> #GSocketConnection is a #GIOStream for a connected socket. They + line="8851">#GSocketConnection is a #GIOStream for a connected socket. They can be created either by #GSocketClient when connecting to a host, or by #GSocketListener when accepting a new client. @@ -103702,7 +105485,7 @@ substreams of the #GIOStream separately will not close the underlying version="2.22"> Looks up the #GType to be used when creating socket connections on + line="36043">Looks up the #GType to be used when creating socket connections on sockets with the specified @family, @type and @protocol_id. If no type is registered, the #GSocketConnection base type is returned. @@ -103710,26 +105493,26 @@ If no type is registered, the #GSocketConnection base type is returned. a #GType + line="36054">a #GType a #GSocketFamily + line="36045">a #GSocketFamily a #GSocketType + line="36046">a #GSocketType a protocol id + line="36047">a protocol id @@ -103739,7 +105522,7 @@ If no type is registered, the #GSocketConnection base type is returned. version="2.22"> Looks up the #GType to be used when creating socket connections on + line="36059">Looks up the #GType to be used when creating socket connections on sockets with the specified @family, @type and @protocol. If no type is registered, the #GSocketConnection base type is returned. @@ -103751,25 +105534,25 @@ If no type is registered, the #GSocketConnection base type is returned. a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION + line="36061">a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION a #GSocketFamily + line="36062">a #GSocketFamily a #GSocketType + line="36063">a #GSocketType a protocol id + line="36064">a protocol id @@ -103780,25 +105563,25 @@ If no type is registered, the #GSocketConnection base type is returned. throws="1"> Connect @connection to the specified remote address. + line="35985">Connect @connection to the specified remote address. %TRUE if the connection succeeded, %FALSE on error + line="35994">%TRUE if the connection succeeded, %FALSE on error a #GSocketConnection + line="35987">a #GSocketConnection a #GSocketAddress specifying the remote address. + line="35988">a #GSocketAddress specifying the remote address. allow-none="1"> a %GCancellable or %NULL + line="35989">a %GCancellable or %NULL @@ -103817,7 +105600,7 @@ If no type is registered, the #GSocketConnection base type is returned. version="2.32"> Asynchronously connect @connection to the specified remote address. + line="35999">Asynchronously connect @connection to the specified remote address. This clears the #GSocket:blocking flag on @connection's underlying socket if it is currently set. @@ -103831,13 +105614,13 @@ Use g_socket_connection_connect_finish() to retrieve the result. a #GSocketConnection + line="36001">a #GSocketConnection a #GSocketAddress specifying the remote address. + line="36002">a #GSocketAddress specifying the remote address. allow-none="1"> a %GCancellable or %NULL + line="36003">a %GCancellable or %NULL closure="3"> a #GAsyncReadyCallback + line="36004">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="36005">user data for the callback @@ -103877,25 +105660,25 @@ Use g_socket_connection_connect_finish() to retrieve the result. throws="1"> Gets the result of a g_socket_connection_connect_async() call. + line="36018">Gets the result of a g_socket_connection_connect_async() call. %TRUE if the connection succeeded, %FALSE on error + line="36026">%TRUE if the connection succeeded, %FALSE on error a #GSocketConnection + line="36020">a #GSocketConnection the #GAsyncResult + line="36021">the #GAsyncResult @@ -103906,12 +105689,12 @@ Use g_socket_connection_connect_finish() to retrieve the result. throws="1"> Try to get the local address of a socket connection. + line="36075">Try to get the local address of a socket connection. a #GSocketAddress or %NULL on error. + line="36082">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). @@ -103919,7 +105702,7 @@ Use g_socket_connection_connect_finish() to retrieve the result. a #GSocketConnection + line="36077">a #GSocketConnection @@ -103930,7 +105713,7 @@ Use g_socket_connection_connect_finish() to retrieve the result. throws="1"> Try to get the remote address of a socket connection. + line="36088">Try to get the remote address of a socket connection. Since GLib 2.40, when used with g_socket_client_connect() or g_socket_client_connect_async(), during emission of @@ -103942,7 +105725,7 @@ applications to print e.g. "Connecting to example.com a #GSocketAddress or %NULL on error. + line="36102">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). @@ -103950,31 +105733,32 @@ applications to print e.g. "Connecting to example.com a #GSocketConnection + line="36090">a #GSocketConnection Gets the underlying #GSocket object of the connection. + line="36108">Gets the underlying #GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the #GSocketConnection APIs. a #GSocket or %NULL on error. + line="36116">a #GSocket or %NULL on error. a #GSocketConnection + line="36110">a #GSocketConnection @@ -103984,20 +105768,20 @@ not supported by the #GSocketConnection APIs. version="2.32"> Checks if @connection is connected. This is equivalent to calling + line="36121">Checks if @connection is connected. This is equivalent to calling g_socket_is_connected() on @connection's underlying #GSocket. whether @connection is connected + line="36128">whether @connection is connected a #GSocketConnection + line="36123">a #GSocketConnection @@ -104005,7 +105789,8 @@ g_socket_is_connected() on @connection's underlying #GSocket. + transfer-ownership="none" + getter="get_socket"> @@ -104088,7 +105873,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. glib:type-struct="SocketControlMessageClass"> A #GSocketControlMessage is a special-purpose utility message that + line="8878">A #GSocketControlMessage is a special-purpose utility message that can be sent to or received from a #GSocket. These types of messages are often called "ancillary data". @@ -104114,7 +105899,7 @@ g_socket_receive_message() to read such a message. version="2.22"> Tries to deserialize a socket control message of a given + line="36133">Tries to deserialize a socket control message of a given @level and @type. This will ask all known (to GType) subclasses of #GSocketControlMessage if they can understand this kind of message and if so deserialize it into a #GSocketControlMessage. @@ -104125,32 +105910,32 @@ will be returned. the deserialized message or %NULL + line="36148">the deserialized message or %NULL a socket level + line="36135">a socket level a socket control message type for the given @level + line="36136">a socket control message type for the given @level the size of the data in bytes + line="36137">the size of the data in bytes pointer to the message data + line="36138">pointer to the message data @@ -104160,20 +105945,20 @@ will be returned. Returns the "level" (i.e. the originating protocol) of the control message. + line="36153">Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. an integer describing the level + line="36160">an integer describing the level a #GSocketControlMessage + line="36155">a #GSocketControlMessage @@ -104181,20 +105966,20 @@ This is often SOL_SOCKET. Returns the space required for the control message, not including + line="36177">Returns the space required for the control message, not including headers or alignment. The number of bytes required. + line="36184">The number of bytes required. a #GSocketControlMessage + line="36179">a #GSocketControlMessage @@ -104213,7 +105998,7 @@ headers or alignment. Converts the data in the message to bytes placed in the + line="36189">Converts the data in the message to bytes placed in the message. @data is guaranteed to have enough space to fit the size @@ -104227,13 +106012,13 @@ object. a #GSocketControlMessage + line="36191">a #GSocketControlMessage A buffer to write data to + line="36192">A buffer to write data to @@ -104243,20 +106028,20 @@ object. version="2.22"> Returns the "level" (i.e. the originating protocol) of the control message. + line="36153">Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. an integer describing the level + line="36160">an integer describing the level a #GSocketControlMessage + line="36155">a #GSocketControlMessage @@ -104266,20 +106051,20 @@ This is often SOL_SOCKET. version="2.22"> Returns the protocol specific type of the control message. + line="36165">Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS. an integer describing the type of control message + line="36172">an integer describing the type of control message a #GSocketControlMessage + line="36167">a #GSocketControlMessage @@ -104289,20 +106074,20 @@ For instance, for UNIX fd passing this would be SCM_RIGHTS. version="2.22"> Returns the space required for the control message, not including + line="36177">Returns the space required for the control message, not including headers or alignment. The number of bytes required. + line="36184">The number of bytes required. a #GSocketControlMessage + line="36179">a #GSocketControlMessage @@ -104312,7 +106097,7 @@ headers or alignment. version="2.22"> Converts the data in the message to bytes placed in the + line="36189">Converts the data in the message to bytes placed in the message. @data is guaranteed to have enough space to fit the size @@ -104326,13 +106111,13 @@ object. a #GSocketControlMessage + line="36191">a #GSocketControlMessage A buffer to write data to + line="36192">A buffer to write data to @@ -104361,14 +106146,14 @@ object. The number of bytes required. + line="36184">The number of bytes required. a #GSocketControlMessage + line="36179">a #GSocketControlMessage @@ -104381,14 +106166,14 @@ object. an integer describing the level + line="36160">an integer describing the level a #GSocketControlMessage + line="36155">a #GSocketControlMessage @@ -104419,14 +106204,14 @@ object. a #GSocketControlMessage + line="36191">a #GSocketControlMessage A buffer to write data to + line="36192">A buffer to write data to @@ -104513,7 +106298,8 @@ if available.) + glib:nick="invalid" + glib:name="G_SOCKET_FAMILY_INVALID"> no address family @@ -104521,7 +106307,8 @@ if available.) + glib:nick="unix" + glib:name="G_SOCKET_FAMILY_UNIX"> the UNIX domain family @@ -104529,7 +106316,8 @@ if available.) + glib:nick="ipv4" + glib:name="G_SOCKET_FAMILY_IPV4"> the IPv4 family @@ -104537,7 +106325,8 @@ if available.) + glib:nick="ipv6" + glib:name="G_SOCKET_FAMILY_IPV6"> the IPv6 family @@ -104553,7 +106342,7 @@ if available.) glib:type-struct="SocketListenerClass"> A #GSocketListener is an object that keeps track of a set + line="8910">A #GSocketListener is an object that keeps track of a set of server sockets and helps you accept sockets from any of the socket, either sync or async. @@ -104573,14 +106362,14 @@ that make this even easier. version="2.22"> Creates a new #GSocketListener with no sockets to listen for. + line="36884">Creates a new #GSocketListener with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port(). a new #GSocketListener. + line="36891">a new #GSocketListener. @@ -104618,7 +106407,7 @@ or g_socket_listener_add_inet_port(). throws="1"> Blocks waiting for a client to connect to any of the sockets added + line="36646">Blocks waiting for a client to connect to any of the sockets added to the listener. Returns a #GSocketConnection for the socket that was accepted. @@ -104633,14 +106422,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GSocketConnection on success, %NULL on error. + line="36665">a #GSocketConnection on success, %NULL on error. a #GSocketListener + line="36648">a #GSocketListener allow-none="1"> location where #GObject pointer will be stored, or %NULL + line="36649">location where #GObject pointer will be stored, or %NULL allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="36650">optional #GCancellable object, %NULL to ignore. @@ -104671,10 +106460,10 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.22"> This is the asynchronous version of g_socket_listener_accept(). + line="36670">This is the asynchronous version of g_socket_listener_accept(). When the operation is finished @callback will be -called. You can then call g_socket_listener_accept_socket() +called. You can then call g_socket_listener_accept_finish() to get the result of the operation. @@ -104684,7 +106473,7 @@ to get the result of the operation. a #GSocketListener + line="36672">a #GSocketListener allow-none="1"> a #GCancellable, or %NULL + line="36673">a #GCancellable, or %NULL closure="2"> a #GAsyncReadyCallback + line="36674">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="36675">user data for the callback @@ -104724,25 +106513,25 @@ to get the result of the operation. throws="1"> Finishes an async accept operation. See g_socket_listener_accept_async() + line="36687">Finishes an async accept operation. See g_socket_listener_accept_async() a #GSocketConnection on success, %NULL on error. + line="36697">a #GSocketConnection on success, %NULL on error. a #GSocketListener + line="36689">a #GSocketListener a #GAsyncResult. + line="36690">a #GAsyncResult. allow-none="1"> Optional #GObject identifying this source + line="36691">Optional #GObject identifying this source @@ -104765,7 +106554,7 @@ to get the result of the operation. throws="1"> Blocks waiting for a client to connect to any of the sockets added + line="36702">Blocks waiting for a client to connect to any of the sockets added to the listener. Returns the #GSocket that was accepted. If you want to accept the high-level #GSocketConnection, not a #GSocket, @@ -104783,14 +106572,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GSocket on success, %NULL on error. + line="36724">a #GSocket on success, %NULL on error. a #GSocketListener + line="36704">a #GSocketListener allow-none="1"> location where #GObject pointer will be stored, or %NULL. + line="36705">location where #GObject pointer will be stored, or %NULL. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="36706">optional #GCancellable object, %NULL to ignore. @@ -104821,7 +106610,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.22"> This is the asynchronous version of g_socket_listener_accept_socket(). + line="36729">This is the asynchronous version of g_socket_listener_accept_socket(). When the operation is finished @callback will be called. You can then call g_socket_listener_accept_socket_finish() @@ -104834,7 +106623,7 @@ to get the result of the operation. a #GSocketListener + line="36731">a #GSocketListener allow-none="1"> a #GCancellable, or %NULL + line="36732">a #GCancellable, or %NULL closure="2"> a #GAsyncReadyCallback + line="36733">a #GAsyncReadyCallback allow-none="1"> user data for the callback + line="36734">user data for the callback @@ -104874,25 +106663,25 @@ to get the result of the operation. throws="1"> Finishes an async accept operation. See g_socket_listener_accept_socket_async() + line="36746">Finishes an async accept operation. See g_socket_listener_accept_socket_async() a #GSocket on success, %NULL on error. + line="36756">a #GSocket on success, %NULL on error. a #GSocketListener + line="36748">a #GSocketListener a #GAsyncResult. + line="36749">a #GAsyncResult. allow-none="1"> Optional #GObject identifying this source + line="36750">Optional #GObject identifying this source @@ -104915,7 +106704,7 @@ to get the result of the operation. throws="1"> Creates a socket of type @type and protocol @protocol, binds + line="36761">Creates a socket of type @type and protocol @protocol, binds it to @address and adds it to the set of sockets we're accepting sockets from. @@ -104942,32 +106731,32 @@ references may be held internally. %TRUE on success, %FALSE on error. + line="36795">%TRUE on success, %FALSE on error. a #GSocketListener + line="36763">a #GSocketListener a #GSocketAddress + line="36764">a #GSocketAddress a #GSocketType + line="36765">a #GSocketType a #GSocketProtocol + line="36766">a #GSocketProtocol allow-none="1"> Optional #GObject identifying this source + line="36767">Optional #GObject identifying this source allow-none="1"> location to store the address that was bound to, or %NULL. + line="36768">location to store the address that was bound to, or %NULL. @@ -104998,7 +106787,7 @@ references may be held internally. throws="1"> Listens for TCP connections on any available port number for both + line="36800">Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each is available). This is useful if you need to have a socket for incoming connections @@ -105012,14 +106801,14 @@ different things depending on what address is connected to. the port number, or 0 in case of failure. + line="36818">the port number, or 0 in case of failure. a #GSocketListener + line="36802">a #GSocketListener allow-none="1"> Optional #GObject identifying this source + line="36803">Optional #GObject identifying this source @@ -105039,7 +106828,7 @@ different things depending on what address is connected to. throws="1"> Helper function for g_socket_listener_add_address() that + line="36823">Helper function for g_socket_listener_add_address() that creates a TCP/IP socket listening on IPv4 and IPv6 (if supported) on the specified port on all interfaces. @@ -105055,20 +106844,20 @@ references may be held internally. %TRUE on success, %FALSE on error. + line="36843">%TRUE on success, %FALSE on error. a #GSocketListener + line="36825">a #GSocketListener an IP port number (non-zero) + line="36826">an IP port number (non-zero) allow-none="1"> Optional #GObject identifying this source + line="36827">Optional #GObject identifying this source @@ -105088,7 +106877,7 @@ references may be held internally. throws="1"> Adds @socket to the set of sockets that we try to accept + line="36848">Adds @socket to the set of sockets that we try to accept new clients from. The socket must be bound to a local address and listened to. @@ -105105,20 +106894,20 @@ if references to it were held elsewhere. %TRUE on success, %FALSE on error. + line="36869">%TRUE on success, %FALSE on error. a #GSocketListener + line="36850">a #GSocketListener a listening #GSocket + line="36851">a listening #GSocket allow-none="1"> Optional #GObject identifying this source + line="36852">Optional #GObject identifying this source @@ -105137,7 +106926,7 @@ if references to it were held elsewhere. version="2.22"> Closes all the sockets in the listener. + line="36874">Closes all the sockets in the listener. @@ -105146,7 +106935,7 @@ if references to it were held elsewhere. a #GSocketListener + line="36876">a #GSocketListener @@ -105156,7 +106945,7 @@ if references to it were held elsewhere. version="2.22"> Sets the listen backlog on the sockets in the listener. This must be called + line="36896">Sets the listen backlog on the sockets in the listener. This must be called before adding any sockets, addresses or ports to the #GSocketListener (for example, by calling g_socket_listener_add_inet_port()) to be effective. @@ -105169,13 +106958,13 @@ See g_socket_set_listen_backlog() for details a #GSocketListener + line="36898">a #GSocketListener an integer + line="36899">an integer @@ -105195,7 +106984,7 @@ See g_socket_set_listen_backlog() for details Emitted when @listener's activity on @socket changes state. + line="3445">Emitted when @listener's activity on @socket changes state. Note that when @listener is used to listen on both IPv4 and IPv6, a separate set of signals will be emitted for each, and the order they happen in is undefined. @@ -105206,13 +106995,13 @@ the order they happen in is undefined. the event that is occurring + line="3448">the event that is occurring the #GSocket the event is occurring on + line="3449">the #GSocket the event is occurring on @@ -105308,42 +107097,46 @@ the order they happen in is undefined. c:type="GSocketListenerEvent"> Describes an event occurring on a #GSocketListener. See the + line="1916">Describes an event occurring on a #GSocketListener. See the #GSocketListener::event signal for more details. Additional values may be added to this type in the future. + glib:nick="binding" + glib:name="G_SOCKET_LISTENER_BINDING"> The listener is about to bind a socket. + line="1918">The listener is about to bind a socket. + glib:nick="bound" + glib:name="G_SOCKET_LISTENER_BOUND"> The listener has bound a socket. + line="1919">The listener has bound a socket. + glib:nick="listening" + glib:name="G_SOCKET_LISTENER_LISTENING"> The listener is about to start + line="1920">The listener is about to start listening on this socket. + glib:nick="listened" + glib:name="G_SOCKET_LISTENER_LISTENED"> The listener is now listening on + line="1922">The listener is now listening on this socket. @@ -105367,7 +107160,8 @@ the right system header and pass in the flag. + glib:nick="none" + glib:name="G_SOCKET_MSG_NONE"> No flags. @@ -105375,7 +107169,8 @@ the right system header and pass in the flag. + glib:nick="oob" + glib:name="G_SOCKET_MSG_OOB"> Request to send/receive out of band data. @@ -105383,7 +107178,8 @@ the right system header and pass in the flag. + glib:nick="peek" + glib:name="G_SOCKET_MSG_PEEK"> Read data from the socket without removing it from @@ -105392,7 +107188,8 @@ the right system header and pass in the flag. + glib:nick="dontroute" + glib:name="G_SOCKET_MSG_DONTROUTE"> Don't use a gateway to send out the packet, @@ -105419,7 +107216,8 @@ use protocols not listed here. + glib:nick="unknown" + glib:name="G_SOCKET_PROTOCOL_UNKNOWN"> The protocol type is unknown @@ -105427,7 +107225,8 @@ use protocols not listed here. + glib:nick="default" + glib:name="G_SOCKET_PROTOCOL_DEFAULT"> The default protocol for the family/type @@ -105435,7 +107234,8 @@ use protocols not listed here. + glib:nick="tcp" + glib:name="G_SOCKET_PROTOCOL_TCP"> TCP over IP @@ -105443,7 +107243,8 @@ use protocols not listed here. + glib:nick="udp" + glib:name="G_SOCKET_PROTOCOL_UDP"> UDP over IP @@ -105451,7 +107252,8 @@ use protocols not listed here. + glib:nick="sctp" + glib:name="G_SOCKET_PROTOCOL_SCTP"> SCTP over IP @@ -105467,7 +107269,7 @@ use protocols not listed here. glib:type-struct="SocketServiceClass"> A #GSocketService is an object that represents a service that + line="8936">A #GSocketService is an object that represents a service that is provided to the network or over local sockets. When a new connection is made to the service the #GSocketService::incoming signal is emitted. @@ -105499,7 +107301,7 @@ handle incoming clients. version="2.22"> Creates a new #GSocketService with no sockets to listen for. + line="37432">Creates a new #GSocketService with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port(). @@ -105510,7 +107312,7 @@ called before. a new #GSocketService. + line="37443">a new #GSocketService. @@ -105536,7 +107338,7 @@ called before. version="2.22"> Check whether the service is active or not. An active + line="37418">Check whether the service is active or not. An active service will accept new clients that connect, while a non-active service will let connecting clients queue up until the service is started. @@ -105544,14 +107346,14 @@ up until the service is started. %TRUE if the service is active, %FALSE otherwise + line="37427">%TRUE if the service is active, %FALSE otherwise a #GSocketService + line="37420">a #GSocketService @@ -105561,7 +107363,7 @@ up until the service is started. version="2.22"> Restarts the service, i.e. start accepting connections + line="37448">Restarts the service, i.e. start accepting connections from the added sockets when the mainloop runs. This only needs to be called after the service has been stopped from g_socket_service_stop(). @@ -105576,7 +107378,7 @@ handling an incoming client request. a #GSocketService + line="37450">a #GSocketService @@ -105584,7 +107386,7 @@ handling an incoming client request. Stops the service, i.e. stops accepting connections + line="37464">Stops the service, i.e. stops accepting connections from the added sockets when the mainloop runs. This call is thread-safe, so it may be called from a thread @@ -105607,7 +107409,7 @@ when a new socket is added. a #GSocketService + line="37466">a #GSocketService @@ -105619,7 +107421,7 @@ when a new socket is added. transfer-ownership="none"> Whether the service is currently accepting connections. + line="3480">Whether the service is currently accepting connections. @@ -105631,7 +107433,7 @@ when a new socket is added. The ::incoming signal is emitted when a new incoming connection + line="3460">The ::incoming signal is emitted when a new incoming connection to @service needs to be handled. The handler must initiate the handling of @connection, but may not block; in essence, asynchronous operations must be used. @@ -105641,14 +107443,14 @@ so you need to ref it yourself if you are planning to use it. %TRUE to stop other handlers from being called + line="3475">%TRUE to stop other handlers from being called a new #GSocketConnection object + line="3463">a new #GSocketConnection object allow-none="1"> the source_object passed to + line="3464">the source_object passed to g_socket_listener_add_address() @@ -105752,26 +107554,26 @@ so you need to ref it yourself if you are planning to use it. version="2.22"> This is the function type of the callback used for the #GSource + line="389">This is the function type of the callback used for the #GSource returned by g_socket_create_source(). - + it should return %FALSE if the source should be removed. + line="398">it should return %FALSE if the source should be removed. the #GSocket + line="391">the #GSocket the current condition at the source fired. + line="392">the current condition at the source fired. closure="2"> data passed in by the user. + line="393">data passed in by the user. @@ -105798,7 +107600,8 @@ all the socket types. + glib:nick="invalid" + glib:name="G_SOCKET_TYPE_INVALID"> Type unknown or wrong @@ -105806,7 +107609,8 @@ all the socket types. + glib:nick="stream" + glib:name="G_SOCKET_TYPE_STREAM"> Reliable connection-based byte streams (e.g. TCP). @@ -105814,7 +107618,8 @@ all the socket types. + glib:nick="datagram" + glib:name="G_SOCKET_TYPE_DATAGRAM"> Connectionless, unreliable datagram passing. @@ -105823,7 +107628,8 @@ all the socket types. + glib:nick="seqpacket" + glib:name="G_SOCKET_TYPE_SEQPACKET"> Reliable connection-based passing of datagrams @@ -105837,7 +107643,7 @@ all the socket types. c:symbol-prefix="srv_target"> SRV (service) records are used by some network protocols to provide + line="8974">SRV (service) records are used by some network protocols to provide service-specific aliasing and load-balancing. For example, XMPP (Jabber) uses SRV records to locate the XMPP server for a domain; rather than connecting directly to "example.com" or assuming a @@ -105855,7 +107661,7 @@ to the remote service, you can use #GNetworkService's Creates a new #GSrvTarget with the given parameters. + line="37785">Creates a new #GSrvTarget with the given parameters. You should not need to use this; normally #GSrvTargets are created by #GResolver. @@ -105863,32 +107669,32 @@ created by #GResolver. a new #GSrvTarget. + line="37797">a new #GSrvTarget. the host that the service is running on + line="37787">the host that the service is running on the port that the service is running on + line="37788">the port that the service is running on the target's priority + line="37789">the target's priority the target's weight + line="37790">the target's weight @@ -105896,19 +107702,19 @@ created by #GResolver. Copies @target + line="37702">Copies @target a copy of @target + line="37708">a copy of @target a #GSrvTarget + line="37704">a #GSrvTarget @@ -105916,7 +107722,7 @@ created by #GResolver. Frees @target + line="37713">Frees @target @@ -105925,7 +107731,7 @@ created by #GResolver. a #GSrvTarget + line="37715">a #GSrvTarget @@ -105935,7 +107741,7 @@ created by #GResolver. version="2.22"> Gets @target's hostname (in ASCII form; if you are going to present + line="37723">Gets @target's hostname (in ASCII form; if you are going to present this to the user, you should use g_hostname_is_ascii_encoded() to check if it contains encoded Unicode segments, and use g_hostname_to_unicode() to convert it if it does.) @@ -105943,14 +107749,14 @@ g_hostname_to_unicode() to convert it if it does.) @target's hostname + line="37732">@target's hostname a #GSrvTarget + line="37725">a #GSrvTarget @@ -105960,19 +107766,19 @@ g_hostname_to_unicode() to convert it if it does.) version="2.22"> Gets @target's port + line="37737">Gets @target's port @target's port + line="37743">@target's port a #GSrvTarget + line="37739">a #GSrvTarget @@ -105982,21 +107788,21 @@ g_hostname_to_unicode() to convert it if it does.) version="2.22"> Gets @target's priority. You should not need to look at this; + line="37748">Gets @target's priority. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. @target's priority + line="37756">@target's priority a #GSrvTarget + line="37750">a #GSrvTarget @@ -106006,21 +107812,21 @@ RFC 2782. version="2.22"> Gets @target's weight. You should not need to look at this; + line="37761">Gets @target's weight. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. @target's weight + line="37769">@target's weight a #GSrvTarget + line="37763">a #GSrvTarget @@ -106031,12 +107837,12 @@ RFC 2782. introspectable="0"> Sorts @targets in place according to the algorithm in RFC 2782. + line="37774">Sorts @targets in place according to the algorithm in RFC 2782. the head of the sorted list. + line="37780">the head of the sorted list. @@ -106045,7 +107851,7 @@ RFC 2782. a #GList of #GSrvTarget + line="37776">a #GList of #GSrvTarget @@ -106056,7 +107862,7 @@ RFC 2782. #GStaticResource is an opaque data structure and can only be accessed + line="3496">#GStaticResource is an opaque data structure and can only be accessed using the following functions. @@ -106077,7 +107883,7 @@ using the following functions. Finalized a GResource initialized by g_static_resource_init(). + line="37802">Finalized a GResource initialized by g_static_resource_init(). This is normally used by code generated by [glib-compile-resources][glib-compile-resources] @@ -106090,7 +107896,7 @@ and is not typically used by other code. pointer to a static #GStaticResource + line="37804">pointer to a static #GStaticResource @@ -106100,7 +107906,7 @@ and is not typically used by other code. version="2.32"> Gets the GResource that was registered by a call to g_static_resource_init(). + line="37816">Gets the GResource that was registered by a call to g_static_resource_init(). This is normally used by code generated by [glib-compile-resources][glib-compile-resources] @@ -106109,14 +107915,14 @@ and is not typically used by other code. a #GResource + line="37826">a #GResource pointer to a static #GStaticResource + line="37818">pointer to a static #GStaticResource @@ -106124,7 +107930,7 @@ and is not typically used by other code. Initializes a GResource from static data using a + line="37831">Initializes a GResource from static data using a GStaticResource. This is normally used by code generated by @@ -106138,7 +107944,7 @@ and is not typically used by other code. pointer to a static #GStaticResource + line="37833">pointer to a static #GStaticResource @@ -106153,7 +107959,7 @@ and is not typically used by other code. glib:get-type="g_subprocess_get_type"> #GSubprocess allows the creation of and interaction with child + line="8996">#GSubprocess allows the creation of and interaction with child processes. Processes can be communicated with using standard GIO-style APIs (ie: @@ -106215,7 +108021,7 @@ are similar to the familiar WIFEXITED-style POSIX macros). introspectable="0"> Create a new process with the given flags and varargs argument + line="38520">Create a new process with the given flags and varargs argument list. By default, matching the g_spawn_async() defaults, the child's stdin will be set to the system null device, and stdout/stderr will be inherited from the parent. You can use @@ -106226,7 +108032,7 @@ The argument list must be terminated with %NULL. A newly created #GSubprocess, or %NULL on error (and @error + line="38535">A newly created #GSubprocess, or %NULL on error (and @error will be set) @@ -106234,7 +108040,7 @@ The argument list must be terminated with %NULL. flags that define the behaviour of the subprocess + line="38522">flags that define the behaviour of the subprocess allow-none="1"> return location for an error, or %NULL + line="38523">return location for an error, or %NULL first commandline argument to pass to the subprocess + line="38524">first commandline argument to pass to the subprocess more commandline arguments, followed by %NULL + line="38525">more commandline arguments, followed by %NULL @@ -106267,14 +108073,14 @@ The argument list must be terminated with %NULL. throws="1"> Create a new process with the given flags and argument list. + line="38541">Create a new process with the given flags and argument list. The argument list is expected to be %NULL-terminated. A newly created #GSubprocess, or %NULL on error (and @error + line="38551">A newly created #GSubprocess, or %NULL on error (and @error will be set) @@ -106282,7 +108088,7 @@ The argument list is expected to be %NULL-terminated. commandline arguments for the subprocess + line="38543">commandline arguments for the subprocess @@ -106290,7 +108096,7 @@ The argument list is expected to be %NULL-terminated. flags that define the behaviour of the subprocess + line="38544">flags that define the behaviour of the subprocess @@ -106301,7 +108107,7 @@ The argument list is expected to be %NULL-terminated. throws="1"> Communicate with the subprocess until it terminates, and all input + line="37846">Communicate with the subprocess until it terminates, and all input and output has been completed. If @stdin_buf is given, the subprocess must have been created with @@ -106346,14 +108152,14 @@ attempt to interact with the pipes while the operation is in progress %TRUE if successful + line="37897">%TRUE if successful a #GSubprocess + line="37848">a #GSubprocess data to send to the stdin of the subprocess, or %NULL + line="37849">data to send to the stdin of the subprocess, or %NULL a #GCancellable + line="37850">a #GCancellable data read from the subprocess stdout + line="37851">data read from the subprocess stdout data read from the subprocess stderr + line="37852">data read from the subprocess stderr @@ -106404,7 +108210,7 @@ attempt to interact with the pipes while the operation is in progress c:identifier="g_subprocess_communicate_async"> Asynchronous version of g_subprocess_communicate(). Complete + line="37902">Asynchronous version of g_subprocess_communicate(). Complete invocation with g_subprocess_communicate_finish(). @@ -106414,7 +108220,7 @@ invocation with g_subprocess_communicate_finish(). Self + line="37904">Self allow-none="1"> Input data, or %NULL + line="37905">Input data, or %NULL allow-none="1"> Cancellable + line="37906">Cancellable closure="3"> Callback + line="37907">Callback allow-none="1"> User data + line="37908">User data @@ -106462,7 +108268,7 @@ invocation with g_subprocess_communicate_finish(). throws="1"> Complete an invocation of g_subprocess_communicate_async(). + line="37915">Complete an invocation of g_subprocess_communicate_async(). @@ -106471,13 +108277,13 @@ invocation with g_subprocess_communicate_finish(). Self + line="37917">Self Result + line="37918">Result allow-none="1"> Return location for stdout data + line="37919">Return location for stdout data allow-none="1"> Return location for stderr data + line="37920">Return location for stderr data @@ -106511,7 +108317,7 @@ invocation with g_subprocess_communicate_finish(). throws="1"> Like g_subprocess_communicate(), but validates the output of the + line="37927">Like g_subprocess_communicate(), but validates the output of the process as UTF-8, and returns it as a regular NUL terminated string. On error, @stdout_buf and @stderr_buf will be set to undefined values and @@ -106524,7 +108330,7 @@ should not be used. a #GSubprocess + line="37929">a #GSubprocess allow-none="1"> data to send to the stdin of the subprocess, or %NULL + line="37930">data to send to the stdin of the subprocess, or %NULL allow-none="1"> a #GCancellable + line="37931">a #GCancellable allow-none="1"> data read from the subprocess stdout + line="37932">data read from the subprocess stdout allow-none="1"> data read from the subprocess stderr + line="37933">data read from the subprocess stderr @@ -106575,7 +108381,7 @@ should not be used. c:identifier="g_subprocess_communicate_utf8_async"> Asynchronous version of g_subprocess_communicate_utf8(). Complete + line="37944">Asynchronous version of g_subprocess_communicate_utf8(). Complete invocation with g_subprocess_communicate_utf8_finish(). @@ -106585,7 +108391,7 @@ invocation with g_subprocess_communicate_utf8_finish(). Self + line="37946">Self allow-none="1"> Input data, or %NULL + line="37947">Input data, or %NULL allow-none="1"> Cancellable + line="37948">Cancellable closure="3"> Callback + line="37949">Callback allow-none="1"> User data + line="37950">User data @@ -106633,7 +108439,7 @@ invocation with g_subprocess_communicate_utf8_finish(). throws="1"> Complete an invocation of g_subprocess_communicate_utf8_async(). + line="37957">Complete an invocation of g_subprocess_communicate_utf8_async(). @@ -106642,13 +108448,13 @@ invocation with g_subprocess_communicate_utf8_finish(). Self + line="37959">Self Result + line="37960">Result allow-none="1"> Return location for stdout data + line="37961">Return location for stdout data allow-none="1"> Return location for stderr data + line="37962">Return location for stderr data @@ -106682,7 +108488,7 @@ invocation with g_subprocess_communicate_utf8_finish(). version="2.40"> Use an operating-system specific method to attempt an immediate, + line="37969">Use an operating-system specific method to attempt an immediate, forceful termination of the process. There is no mechanism to determine whether or not the request itself was successful; however, you can use g_subprocess_wait() to monitor the status of @@ -106697,7 +108503,7 @@ On Unix, this function sends %SIGKILL. a #GSubprocess + line="37971">a #GSubprocess @@ -106707,7 +108513,7 @@ On Unix, this function sends %SIGKILL. version="2.40"> Check the exit status of the subprocess, given that it exited + line="37985">Check the exit status of the subprocess, given that it exited normally. This is the value passed to the exit() system call or the return value from main. @@ -106719,14 +108525,14 @@ unless g_subprocess_get_if_exited() returned %TRUE. the exit status + line="37998">the exit status a #GSubprocess + line="37987">a #GSubprocess @@ -106736,14 +108542,14 @@ unless g_subprocess_get_if_exited() returned %TRUE. version="2.40"> On UNIX, returns the process ID as a decimal string. + line="38003">On UNIX, returns the process ID as a decimal string. On Windows, returns the result of GetProcessId() also as a string. If the subprocess has terminated, this will return %NULL. the subprocess identifier, or %NULL if the subprocess + line="38011">the subprocess identifier, or %NULL if the subprocess has terminated @@ -106751,7 +108557,7 @@ If the subprocess has terminated, this will return %NULL. a #GSubprocess + line="38005">a #GSubprocess @@ -106761,7 +108567,7 @@ If the subprocess has terminated, this will return %NULL. version="2.40"> Check if the given subprocess exited normally (ie: by way of exit() + line="38017">Check if the given subprocess exited normally (ie: by way of exit() or return from main()). This is equivalent to the system WIFEXITED macro. @@ -106772,14 +108578,14 @@ returned. %TRUE if the case of a normal exit + line="38029">%TRUE if the case of a normal exit a #GSubprocess + line="38019">a #GSubprocess @@ -106789,7 +108595,7 @@ returned. version="2.40"> Check if the given subprocess terminated in response to a signal. + line="38034">Check if the given subprocess terminated in response to a signal. This is equivalent to the system WIFSIGNALED macro. @@ -106799,14 +108605,14 @@ returned. %TRUE if the case of termination due to a signal + line="38045">%TRUE if the case of termination due to a signal a #GSubprocess + line="38036">a #GSubprocess @@ -106816,11 +108622,11 @@ returned. version="2.40"> Gets the raw status code of the process, as from waitpid(). + line="38050">Gets the raw status code of the process, as from waitpid(). This value has no particular meaning, but it can be used with the macros defined by the system headers such as WIFEXITED. It can also -be used with g_spawn_check_exit_status(). +be used with g_spawn_check_wait_status(). It is more likely that you want to use g_subprocess_get_if_exited() followed by g_subprocess_get_exit_status(). @@ -106831,14 +108637,14 @@ returned. the (meaningless) waitpid() exit status from the kernel + line="38066">the (meaningless) waitpid() exit status from the kernel a #GSubprocess + line="38052">a #GSubprocess @@ -106848,23 +108654,23 @@ returned. version="2.40"> Gets the #GInputStream from which to read the stderr output of + line="38071">Gets the #GInputStream from which to read the stderr output of @subprocess. -The process must have been created with -%G_SUBPROCESS_FLAGS_STDERR_PIPE. +The process must have been created with %G_SUBPROCESS_FLAGS_STDERR_PIPE, +otherwise %NULL will be returned. - + the stderr pipe + line="38081">the stderr pipe a #GSubprocess + line="38073">a #GSubprocess @@ -106874,23 +108680,23 @@ The process must have been created with version="2.40"> Gets the #GOutputStream that you can write to in order to give data + line="38086">Gets the #GOutputStream that you can write to in order to give data to the stdin of @subprocess. -The process must have been created with -%G_SUBPROCESS_FLAGS_STDIN_PIPE. +The process must have been created with %G_SUBPROCESS_FLAGS_STDIN_PIPE and +not %G_SUBPROCESS_FLAGS_STDIN_INHERIT, otherwise %NULL will be returned. - + the stdout pipe + line="38096">the stdout pipe a #GSubprocess + line="38088">a #GSubprocess @@ -106900,23 +108706,23 @@ The process must have been created with version="2.40"> Gets the #GInputStream from which to read the stdout output of + line="38101">Gets the #GInputStream from which to read the stdout output of @subprocess. -The process must have been created with -%G_SUBPROCESS_FLAGS_STDOUT_PIPE. +The process must have been created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE, +otherwise %NULL will be returned. - + the stdout pipe + line="38111">the stdout pipe a #GSubprocess + line="38103">a #GSubprocess @@ -106926,7 +108732,7 @@ The process must have been created with version="2.40"> Checks if the process was "successful". A process is considered + line="38116">Checks if the process was "successful". A process is considered successful if it exited cleanly with an exit status of 0, either by way of the exit() system call or return from main(). @@ -106936,14 +108742,14 @@ returned. %TRUE if the process exited cleanly with a exit status of 0 + line="38127">%TRUE if the process exited cleanly with a exit status of 0 a #GSubprocess + line="38118">a #GSubprocess @@ -106953,7 +108759,7 @@ returned. version="2.40"> Get the signal number that caused the subprocess to terminate, given + line="38132">Get the signal number that caused the subprocess to terminate, given that it terminated due to a signal. This is equivalent to the system WTERMSIG macro. @@ -106964,14 +108770,14 @@ unless g_subprocess_get_if_signaled() returned %TRUE. the signal causing termination + line="38144">the signal causing termination a #GSubprocess + line="38134">a #GSubprocess @@ -106981,7 +108787,7 @@ unless g_subprocess_get_if_signaled() returned %TRUE. version="2.40"> Sends the UNIX signal @signal_num to the subprocess, if it is still + line="38557">Sends the UNIX signal @signal_num to the subprocess, if it is still running. This API is race-free. If the subprocess has terminated, it will not @@ -106996,13 +108802,13 @@ This API is not available on Windows. a #GSubprocess + line="38559">a #GSubprocess the signal number to send + line="38560">the signal number to send @@ -107013,7 +108819,7 @@ This API is not available on Windows. throws="1"> Synchronously wait for the subprocess to terminate. + line="38574">Synchronously wait for the subprocess to terminate. After the process terminates you can query its exit status with functions such as g_subprocess_get_if_exited() and @@ -107028,14 +108834,14 @@ g_subprocess_force_exit() if it is desirable. %TRUE on success, %FALSE if @cancellable was cancelled + line="38592">%TRUE on success, %FALSE if @cancellable was cancelled a #GSubprocess + line="38576">a #GSubprocess allow-none="1"> a #GCancellable + line="38577">a #GCancellable @@ -107054,7 +108860,7 @@ g_subprocess_force_exit() if it is desirable. version="2.40"> Wait for the subprocess to terminate. + line="38597">Wait for the subprocess to terminate. This is the asynchronous version of g_subprocess_wait(). @@ -107065,7 +108871,7 @@ This is the asynchronous version of g_subprocess_wait(). a #GSubprocess + line="38599">a #GSubprocess allow-none="1"> a #GCancellable, or %NULL + line="38600">a #GCancellable, or %NULL closure="2"> a #GAsyncReadyCallback to call when the operation is complete + line="38601">a #GAsyncReadyCallback to call when the operation is complete allow-none="1"> user_data for @callback + line="38602">user_data for @callback @@ -107105,12 +108911,12 @@ This is the asynchronous version of g_subprocess_wait(). throws="1"> Combines g_subprocess_wait() with g_spawn_check_exit_status(). + line="38612">Combines g_subprocess_wait() with g_spawn_check_wait_status(). %TRUE on success, %FALSE if process exited abnormally, or + line="38620">%TRUE on success, %FALSE if process exited abnormally, or @cancellable was cancelled @@ -107118,7 +108924,7 @@ This is the asynchronous version of g_subprocess_wait(). a #GSubprocess + line="38614">a #GSubprocess allow-none="1"> a #GCancellable + line="38615">a #GCancellable @@ -107137,7 +108943,7 @@ This is the asynchronous version of g_subprocess_wait(). version="2.40"> Combines g_subprocess_wait_async() with g_spawn_check_exit_status(). + line="38626">Combines g_subprocess_wait_async() with g_spawn_check_wait_status(). This is the asynchronous version of g_subprocess_wait_check(). @@ -107148,7 +108954,7 @@ This is the asynchronous version of g_subprocess_wait_check(). a #GSubprocess + line="38628">a #GSubprocess allow-none="1"> a #GCancellable, or %NULL + line="38629">a #GCancellable, or %NULL closure="2"> a #GAsyncReadyCallback to call when the operation is complete + line="38630">a #GAsyncReadyCallback to call when the operation is complete allow-none="1"> user_data for @callback + line="38631">user_data for @callback @@ -107188,26 +108994,26 @@ This is the asynchronous version of g_subprocess_wait_check(). throws="1"> Collects the result of a previous call to + line="38641">Collects the result of a previous call to g_subprocess_wait_check_async(). %TRUE if successful, or %FALSE with @error set + line="38650">%TRUE if successful, or %FALSE with @error set a #GSubprocess + line="38643">a #GSubprocess the #GAsyncResult passed to your #GAsyncReadyCallback + line="38644">the #GAsyncResult passed to your #GAsyncReadyCallback @@ -107218,26 +109024,26 @@ g_subprocess_wait_check_async(). throws="1"> Collects the result of a previous call to + line="38655">Collects the result of a previous call to g_subprocess_wait_async(). %TRUE if successful, or %FALSE with @error set + line="38664">%TRUE if successful, or %FALSE with @error set a #GSubprocess + line="38657">a #GSubprocess the #GAsyncResult passed to your #GAsyncReadyCallback + line="38658">the #GAsyncResult passed to your #GAsyncReadyCallback @@ -107266,7 +109072,7 @@ g_subprocess_wait_async(). c:type="GSubprocessFlags"> Flags to define the behaviour of a #GSubprocess. + line="1951">Flags to define the behaviour of a #GSubprocess. Note that the default for stdin is to redirect from `/dev/null`. For stdout and stderr the default are for them to inherit the @@ -107278,85 +109084,94 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and + glib:nick="none" + glib:name="G_SUBPROCESS_FLAGS_NONE"> No flags. + line="1953">No flags. + glib:nick="stdin-pipe" + glib:name="G_SUBPROCESS_FLAGS_STDIN_PIPE"> create a pipe for the stdin of the + line="1954">create a pipe for the stdin of the spawned process that can be accessed with g_subprocess_get_stdin_pipe(). + glib:nick="stdin-inherit" + glib:name="G_SUBPROCESS_FLAGS_STDIN_INHERIT"> stdin is inherited from the + line="1957">stdin is inherited from the calling process. + glib:nick="stdout-pipe" + glib:name="G_SUBPROCESS_FLAGS_STDOUT_PIPE"> create a pipe for the stdout of the + line="1959">create a pipe for the stdout of the spawned process that can be accessed with g_subprocess_get_stdout_pipe(). + glib:nick="stdout-silence" + glib:name="G_SUBPROCESS_FLAGS_STDOUT_SILENCE"> silence the stdout of the spawned + line="1962">silence the stdout of the spawned process (ie: redirect to `/dev/null`). + glib:nick="stderr-pipe" + glib:name="G_SUBPROCESS_FLAGS_STDERR_PIPE"> create a pipe for the stderr of the + line="1964">create a pipe for the stderr of the spawned process that can be accessed with g_subprocess_get_stderr_pipe(). + glib:nick="stderr-silence" + glib:name="G_SUBPROCESS_FLAGS_STDERR_SILENCE"> silence the stderr of the spawned + line="1967">silence the stderr of the spawned process (ie: redirect to `/dev/null`). + glib:nick="stderr-merge" + glib:name="G_SUBPROCESS_FLAGS_STDERR_MERGE"> merge the stderr of the spawned + line="1969">merge the stderr of the spawned process with whatever the stdout happens to be. This is a good way of directing both streams to a common log file, for example. + glib:nick="inherit-fds" + glib:name="G_SUBPROCESS_FLAGS_INHERIT_FDS"> spawned processes will inherit the + line="1972">spawned processes will inherit the file descriptors of their parent, unless those descriptors have been explicitly marked as close-on-exec. This flag has no effect over the "standard" file descriptors (stdin, stdout, stderr). @@ -107371,7 +109186,7 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:get-type="g_subprocess_launcher_get_type"> This class contains a set of options for launching child processes, + line="9062">This class contains a set of options for launching child processes, such as where its standard input and output will be directed, the argument list, the environment, and more. @@ -107384,7 +109199,7 @@ a similar configuration. version="2.40"> Creates a new #GSubprocessLauncher. + line="38185">Creates a new #GSubprocessLauncher. The launcher is created with the default options. A copy of the environment of the calling process is made at the time of this call @@ -107397,26 +109212,54 @@ and will be used as the environment that the process is launched in. #GSubprocessFlags + line="38187">#GSubprocessFlags + + Closes all the file descriptors previously passed to the object with +g_subprocess_launcher_take_fd(), g_subprocess_launcher_take_stderr_fd(), etc. + +After calling this method, any subsequent calls to g_subprocess_launcher_spawn() or g_subprocess_launcher_spawnv() will +return %G_IO_ERROR_CLOSED. This method is idempotent if +called more than once. + +This function is called automatically when the #GSubprocessLauncher +is disposed, but is provided separately so that garbage collected +language bindings can call it earlier to guarantee when FDs are closed. + + + + + + + a #GSubprocessLauncher + + + + Returns the value of the environment variable @variable in the + line="38168">Returns the value of the environment variable @variable in the environment of processes launched from this launcher. On UNIX, the returned string can be an arbitrary byte string. On Windows, it will be UTF-8. - + the value of the environment variable, + line="38179">the value of the environment variable, %NULL if unset @@ -107424,13 +109267,13 @@ On Windows, it will be UTF-8. a #GSubprocessLauncher + line="38170">a #GSubprocessLauncher the environment variable to get + line="38171">the environment variable to get @@ -107441,7 +109284,7 @@ On Windows, it will be UTF-8. introspectable="0"> Sets up a child setup function. + line="38199">Sets up a child setup function. The child setup function will be called after fork() but before exec() on the child's side. @@ -107454,7 +109297,7 @@ given. %NULL can be given as @child_setup to disable the functionality. Child setup functions are only available on UNIX. - + @@ -107462,7 +109305,7 @@ Child setup functions are only available on UNIX. a #GSubprocessLauncher + line="38201">a #GSubprocessLauncher destroy="2"> a #GSpawnChildSetupFunc to use as the child setup function + line="38202">a #GSpawnChildSetupFunc to use as the child setup function @@ -107482,7 +109325,7 @@ Child setup functions are only available on UNIX. allow-none="1"> user data for @child_setup + line="38203">user data for @child_setup scope="async"> a #GDestroyNotify for @user_data + line="38204">a #GDestroyNotify for @user_data @@ -107500,7 +109343,7 @@ Child setup functions are only available on UNIX. version="2.40"> Sets the current working directory that processes will be launched + line="38224">Sets the current working directory that processes will be launched with. By default processes are launched with the current working directory @@ -107513,13 +109356,13 @@ of the launching process at the time of launch. a #GSubprocessLauncher + line="38226">a #GSubprocessLauncher the cwd for launched processes + line="38227">the cwd for launched processes @@ -107529,7 +109372,7 @@ of the launching process at the time of launch. version="2.40"> Replace the entire environment of processes launched from this + line="38239">Replace the entire environment of processes launched from this launcher with the given 'environ' variable. Typically you will build this variable by using g_listenv() to copy @@ -107556,13 +109399,13 @@ On Windows, they should be in UTF-8. a #GSubprocessLauncher + line="38241">a #GSubprocessLauncher + line="38242"> the replacement environment @@ -107575,7 +109418,7 @@ On Windows, they should be in UTF-8. version="2.40"> Sets the flags on the launcher. + line="38269">Sets the flags on the launcher. The default flags are %G_SUBPROCESS_FLAGS_NONE. @@ -107595,13 +109438,13 @@ g_subprocess_launcher_take_stdout_fd(). a #GSubprocessLauncher + line="38271">a #GSubprocessLauncher #GSubprocessFlags + line="38272">#GSubprocessFlags @@ -107611,7 +109454,7 @@ g_subprocess_launcher_take_stdout_fd(). version="2.40"> Sets the file path to use as the stderr for spawned processes. + line="38291">Sets the file path to use as the stderr for spawned processes. If @path is %NULL then any previously given path is unset. @@ -107633,7 +109476,7 @@ This feature is only available on UNIX. a #GSubprocessLauncher + line="38293">a #GSubprocessLauncher allow-none="1"> a filename or %NULL + line="38294">a filename or %NULL @@ -107652,7 +109495,7 @@ This feature is only available on UNIX. version="2.40"> Sets the file path to use as the stdin for spawned processes. + line="38315">Sets the file path to use as the stdin for spawned processes. If @path is %NULL then any previously given path is unset. @@ -107670,7 +109513,7 @@ This feature is only available on UNIX. a #GSubprocessLauncher + line="38317">a #GSubprocessLauncher @@ -107683,7 +109526,7 @@ This feature is only available on UNIX. version="2.40"> Sets the file path to use as the stdout for spawned processes. + line="38335">Sets the file path to use as the stdout for spawned processes. If @path is %NULL then any previously given path is unset. @@ -107702,7 +109545,7 @@ This feature is only available on UNIX. a #GSubprocessLauncher + line="38337">a #GSubprocessLauncher allow-none="1"> a filename or %NULL + line="38338">a filename or %NULL @@ -107721,7 +109564,7 @@ This feature is only available on UNIX. version="2.40"> Sets the environment variable @variable in the environment of + line="38356">Sets the environment variable @variable in the environment of processes launched from this launcher. On UNIX, both the variable's name and value can be arbitrary byte @@ -107735,26 +109578,26 @@ On Windows, they should be in UTF-8. a #GSubprocessLauncher + line="38358">a #GSubprocessLauncher the environment variable to set, + line="38359">the environment variable to set, must not contain '=' the new value for the variable + line="38361">the new value for the variable whether to change the variable if it already exists + line="38362">whether to change the variable if it already exists @@ -107765,37 +109608,37 @@ On Windows, they should be in UTF-8. introspectable="0"> Creates a #GSubprocess given a provided varargs list of arguments. + line="38375">Creates a #GSubprocess given a provided varargs list of arguments. A new #GSubprocess, or %NULL on error (and @error will be set) + line="38385">A new #GSubprocess, or %NULL on error (and @error will be set) a #GSubprocessLauncher + line="38377">a #GSubprocessLauncher Error + line="38378">Error Command line arguments + line="38379">Command line arguments Continued arguments, %NULL terminated + line="38380">Continued arguments, %NULL terminated @@ -107806,25 +109649,25 @@ On Windows, they should be in UTF-8. throws="1"> Creates a #GSubprocess given a provided array of arguments. + line="38389">Creates a #GSubprocess given a provided array of arguments. A new #GSubprocess, or %NULL on error (and @error will be set) + line="38398">A new #GSubprocess, or %NULL on error (and @error will be set) a #GSubprocessLauncher + line="38391">a #GSubprocessLauncher Command line arguments + line="38392">Command line arguments @@ -107834,17 +109677,17 @@ On Windows, they should be in UTF-8. Transfer an arbitrary file descriptor from parent process to the -child. This function takes "ownership" of the fd; it will be closed + line="38402">Transfer an arbitrary file descriptor from parent process to the +child. This function takes ownership of the @source_fd; it will be closed in the parent when @self is freed. By default, all file descriptors from the parent will be closed. -This function allows you to create (for example) a custom pipe() or -socketpair() before launching the process, and choose the target +This function allows you to create (for example) a custom `pipe()` or +`socketpair()` before launching the process, and choose the target descriptor in the child. An example use case is GNUPG, which has a command line argument ---passphrase-fd providing a file descriptor number where it expects +`--passphrase-fd` providing a file descriptor number where it expects the passphrase to be written. @@ -107854,19 +109697,19 @@ the passphrase to be written. a #GSubprocessLauncher + line="38404">a #GSubprocessLauncher File descriptor in parent process + line="38405">File descriptor in parent process Target descriptor for child process + line="38406">Target descriptor for child process @@ -107876,7 +109719,7 @@ the passphrase to be written. version="2.40"> Sets the file descriptor to use as the stderr for spawned processes. + line="38423">Sets the file descriptor to use as the stderr for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -107900,13 +109743,13 @@ This feature is only available on UNIX. a #GSubprocessLauncher + line="38425">a #GSubprocessLauncher a file descriptor, or -1 + line="38426">a file descriptor, or -1 @@ -107916,7 +109759,7 @@ This feature is only available on UNIX. version="2.40"> Sets the file descriptor to use as the stdin for spawned processes. + line="38449">Sets the file descriptor to use as the stdin for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -107942,13 +109785,13 @@ This feature is only available on UNIX. a #GSubprocessLauncher + line="38451">a #GSubprocessLauncher a file descriptor, or -1 + line="38452">a file descriptor, or -1 @@ -107958,7 +109801,7 @@ This feature is only available on UNIX. version="2.40"> Sets the file descriptor to use as the stdout for spawned processes. + line="38477">Sets the file descriptor to use as the stdout for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -107983,13 +109826,13 @@ This feature is only available on UNIX. a #GSubprocessLauncher + line="38479">a #GSubprocessLauncher a file descriptor, or -1 + line="38480">a file descriptor, or -1 @@ -107999,7 +109842,7 @@ This feature is only available on UNIX. version="2.40"> Removes the environment variable @variable from the environment of + line="38504">Removes the environment variable @variable from the environment of processes launched from this launcher. On UNIX, the variable's name can be an arbitrary byte string not @@ -108012,13 +109855,13 @@ containing '='. On Windows, it should be in UTF-8. a #GSubprocessLauncher + line="38506">a #GSubprocessLauncher the environment variable to unset, + line="38507">the environment variable to unset, must not contain '=' @@ -108306,7 +110149,7 @@ See [Extending GIO][extending-gio]. c:type="G_TLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT"> The purpose used to verify the client certificate in a TLS connection. + line="4590">The purpose used to verify the client certificate in a TLS connection. Used by TLS servers. @@ -108316,7 +110159,7 @@ Used by TLS servers. c:type="G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER"> The purpose used to verify the server certificate in a TLS connection. This + line="4598">The purpose used to verify the server certificate in a TLS connection. This is the most common purpose in use. Used by TLS clients. @@ -108447,7 +110290,7 @@ is the most common purpose in use. Used by TLS clients. glib:type-struct="TaskClass"> A #GTask represents and manages a cancellable "task". + line="9081">A #GTask represents and manages a cancellable "task". ## Asynchronous operations @@ -108947,7 +110790,7 @@ in several ways: Creates a #GTask acting on @source_object, which will eventually be + line="38835">Creates a #GTask acting on @source_object, which will eventually be used to invoke @callback in the current [thread-default main context][g-main-context-push-thread-default]. @@ -108967,7 +110810,7 @@ g_task_set_check_cancellable() to change it. a #GTask. + line="38860">a #GTask. @@ -108977,7 +110820,7 @@ g_task_set_check_cancellable() to change it. allow-none="1"> the #GObject that owns + line="38837">the #GObject that owns this task, or %NULL. @@ -108987,7 +110830,7 @@ g_task_set_check_cancellable() to change it. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="38839">optional #GCancellable object, %NULL to ignore. closure="3"> a #GAsyncReadyCallback. + line="38840">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="38841">user data passed to @callback. @@ -109015,14 +110858,14 @@ g_task_set_check_cancellable() to change it. Checks that @result is a #GTask, and that @source_object is its + line="38819">Checks that @result is a #GTask, and that @source_object is its source object (or that @source_object is %NULL and @result has no source object). This can be used in g_return_if_fail() checks. %TRUE if @result and @source_object are valid, %FALSE + line="38829">%TRUE if @result and @source_object are valid, %FALSE if not @@ -109030,7 +110873,7 @@ if not A #GAsyncResult + line="38821">A #GAsyncResult allow-none="1"> the source object + line="38822">the source object expected to be associated with the task @@ -109050,7 +110893,7 @@ if not version="2.36"> Creates a #GTask and then immediately calls g_task_return_error() + line="38942">Creates a #GTask and then immediately calls g_task_return_error() on it. Use this in the wrapper function of an asynchronous method when you want to avoid even calling the virtual method. You can then use g_async_result_is_tagged() in the finish method wrapper to @@ -109069,7 +110912,7 @@ See also g_task_report_new_error(). allow-none="1"> the #GObject that owns + line="38944">the #GObject that owns this task, or %NULL. @@ -109081,7 +110924,7 @@ See also g_task_report_new_error(). closure="2"> a #GAsyncReadyCallback. + line="38946">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="38947">user data passed to @callback. allow-none="1"> an opaque pointer indicating the source of this task + line="38948">an opaque pointer indicating the source of this task error to report + line="38949">error to report @@ -109116,7 +110959,7 @@ See also g_task_report_new_error(). introspectable="0"> Creates a #GTask and then immediately calls + line="38964">Creates a #GTask and then immediately calls g_task_return_new_error() on it. Use this in the wrapper function of an asynchronous method when you want to avoid even calling the virtual method. You can then use g_async_result_is_tagged() in the @@ -109136,7 +110979,7 @@ See also g_task_report_error(). allow-none="1"> the #GObject that owns + line="38966">the #GObject that owns this task, or %NULL. @@ -109148,7 +110991,7 @@ See also g_task_report_error(). closure="2"> a #GAsyncReadyCallback. + line="38968">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="38969">user data passed to @callback. allow-none="1"> an opaque pointer indicating the source of this task + line="38970">an opaque pointer indicating the source of this task a #GQuark. + line="38971">a #GQuark. an error code. + line="38972">an error code. a string with format characters. + line="38973">a string with format characters. a list of values to insert into @format. + line="38974">a list of values to insert into @format. @@ -109201,7 +111044,7 @@ See also g_task_report_error(). introspectable="0"> A utility function for dealing with async operations where you need + line="38669">A utility function for dealing with async operations where you need to wait for a #GSource to trigger. Attaches @source to @task's #GMainContext with @task's [priority][io-priority], and sets @source's callback to @callback, with @task as the callback's `user_data`. @@ -109218,19 +111061,19 @@ This takes a reference on @task until @source is destroyed. a #GTask + line="38671">a #GTask the source to attach + line="38672">the source to attach the callback to invoke when @source triggers + line="38673">the callback to invoke when @source triggers @@ -109240,19 +111083,19 @@ This takes a reference on @task until @source is destroyed. version="2.36"> Gets @task's #GCancellable + line="38689">Gets @task's #GCancellable @task's #GCancellable + line="38695">@task's #GCancellable a #GTask + line="38691">a #GTask @@ -109262,7 +111105,7 @@ This takes a reference on @task until @source is destroyed. version="2.36"> Gets @task's check-cancellable flag. See + line="38700">Gets @task's check-cancellable flag. See g_task_set_check_cancellable() for more details. @@ -109272,31 +111115,32 @@ g_task_set_check_cancellable() for more details. the #GTask + line="38702">the #GTask Gets the value of #GTask:completed. This changes from %FALSE to %TRUE after + line="38711">Gets the value of #GTask:completed. This changes from %FALSE to %TRUE after the task’s callback is invoked, and will return %FALSE if called from inside the callback. %TRUE if the task has completed, %FALSE otherwise. + line="38719">%TRUE if the task has completed, %FALSE otherwise. a #GTask. + line="38713">a #GTask. @@ -109306,7 +111150,7 @@ the callback. version="2.36"> Gets the #GMainContext that @task will return its result in (that + line="38724">Gets the #GMainContext that @task will return its result in (that is, the context that was the [thread-default main context][g-main-context-push-thread-default] at the point when @task was created). @@ -109317,14 +111161,14 @@ context is the default #GMainContext. @task's #GMainContext + line="38736">@task's #GMainContext a #GTask + line="38726">a #GTask @@ -109332,19 +111176,19 @@ context is the default #GMainContext. Gets @task’s name. See g_task_set_name(). + line="38741">Gets @task’s name. See g_task_set_name(). @task’s name, or %NULL + line="38747">@task’s name, or %NULL a #GTask + line="38743">a #GTask @@ -109354,19 +111198,19 @@ context is the default #GMainContext. version="2.36"> Gets @task's priority + line="38752">Gets @task's priority @task's priority + line="38758">@task's priority a #GTask + line="38754">a #GTask @@ -109376,7 +111220,7 @@ context is the default #GMainContext. version="2.36"> Gets @task's return-on-cancel flag. See + line="38763">Gets @task's return-on-cancel flag. See g_task_set_return_on_cancel() for more details. @@ -109386,7 +111230,7 @@ g_task_set_return_on_cancel() for more details. the #GTask + line="38765">the #GTask @@ -109396,20 +111240,20 @@ g_task_set_return_on_cancel() for more details. version="2.36"> Gets the source object from @task. Like + line="38774">Gets the source object from @task. Like g_async_result_get_source_object(), but does not ref the object. @task's source object, or %NULL + line="38781">@task's source object, or %NULL a #GTask + line="38776">a #GTask @@ -109419,19 +111263,19 @@ g_async_result_get_source_object(), but does not ref the object. version="2.36"> Gets @task's source tag. See g_task_set_source_tag(). + line="38786">Gets @task's source tag. See g_task_set_source_tag(). @task's source tag + line="38792">@task's source tag a #GTask + line="38788">a #GTask @@ -109441,19 +111285,19 @@ g_async_result_get_source_object(), but does not ref the object. version="2.36"> Gets @task's `task_data`. + line="38797">Gets @task's `task_data`. @task's `task_data`. + line="38803">@task's `task_data`. a #GTask + line="38799">a #GTask @@ -109461,19 +111305,19 @@ g_async_result_get_source_object(), but does not ref the object. Tests if @task resulted in an error. + line="38808">Tests if @task resulted in an error. %TRUE if the task resulted in an error, %FALSE otherwise. + line="38814">%TRUE if the task resulted in an error, %FALSE otherwise. a #GTask. + line="38810">a #GTask. @@ -109484,7 +111328,7 @@ g_async_result_get_source_object(), but does not ref the object. throws="1"> Gets the result of @task as a #gboolean. + line="38865">Gets the result of @task as a #gboolean. If the task resulted in an error, or was cancelled, then this will instead return %FALSE and set @error. @@ -109495,14 +111339,14 @@ error) to the caller, you may only call it once. the task result, or %FALSE on error + line="38878">the task result, or %FALSE on error a #GTask. + line="38867">a #GTask. @@ -109513,7 +111357,7 @@ error) to the caller, you may only call it once. throws="1"> Gets the result of @task as an integer (#gssize). + line="38883">Gets the result of @task as an integer (#gssize). If the task resulted in an error, or was cancelled, then this will instead return -1 and set @error. @@ -109524,14 +111368,14 @@ error) to the caller, you may only call it once. the task result, or -1 on error + line="38896">the task result, or -1 on error a #GTask. + line="38885">a #GTask. @@ -109542,7 +111386,7 @@ error) to the caller, you may only call it once. throws="1"> Gets the result of @task as a pointer, and transfers ownership + line="38901">Gets the result of @task as a pointer, and transfers ownership of that value to the caller. If the task resulted in an error, or was cancelled, then this will @@ -109554,14 +111398,14 @@ error) to the caller, you may only call it once. the task result, or %NULL on error + line="38915">the task result, or %NULL on error a #GTask + line="38903">a #GTask @@ -109572,7 +111416,7 @@ error) to the caller, you may only call it once. throws="1"> Gets the result of @task as a #GValue, and transfers ownership of + line="38920">Gets the result of @task as a #GValue, and transfers ownership of that value to the caller. As with g_task_return_value(), this is a generic low-level method; g_task_propagate_pointer() and the like will usually be more useful for C code. @@ -109586,14 +111430,14 @@ error) to the caller, you may only call it once. %TRUE if @task succeeded, %FALSE on error. + line="38937">%TRUE if @task succeeded, %FALSE on error. a #GTask + line="38922">a #GTask transfer-ownership="none"> return location for the #GValue + line="38923">return location for the #GValue @@ -109612,7 +111456,7 @@ error) to the caller, you may only call it once. version="2.36"> Sets @task's result to @result and completes the task (see + line="38990">Sets @task's result to @result and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -109623,13 +111467,13 @@ means). a #GTask. + line="38992">a #GTask. the #gboolean result of a task function. + line="38993">the #gboolean result of a task function. @@ -109639,7 +111483,7 @@ means). version="2.36"> Sets @task's result to @error (which @task assumes ownership of) + line="39003">Sets @task's result to @error (which @task assumes ownership of) and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -109658,13 +111502,13 @@ See also g_task_return_new_error(). a #GTask. + line="39005">a #GTask. the #GError result of a task function. + line="39006">the #GError result of a task function. @@ -109674,7 +111518,7 @@ See also g_task_return_new_error(). version="2.36"> Checks if @task's #GCancellable has been cancelled, and if so, sets + line="39024">Checks if @task's #GCancellable has been cancelled, and if so, sets @task's error accordingly and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -109682,14 +111526,14 @@ means). %TRUE if @task has been cancelled, %FALSE if not + line="39033">%TRUE if @task has been cancelled, %FALSE if not a #GTask + line="39026">a #GTask @@ -109699,7 +111543,7 @@ means). version="2.36"> Sets @task's result to @result and completes the task (see + line="39038">Sets @task's result to @result and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -109710,13 +111554,13 @@ means). a #GTask. + line="39040">a #GTask. the integer (#gssize) result of a task function. + line="39041">the integer (#gssize) result of a task function. @@ -109727,7 +111571,7 @@ means). introspectable="0"> Sets @task's result to a new #GError created from @domain, @code, + line="39051">Sets @task's result to a new #GError created from @domain, @code, @format, and the remaining arguments, and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -109741,31 +111585,31 @@ See also g_task_return_error(). a #GTask. + line="39053">a #GTask. a #GQuark. + line="39054">a #GQuark. an error code. + line="39055">an error code. a string with format characters. + line="39056">a string with format characters. a list of values to insert into @format. + line="39057">a list of values to insert into @format. @@ -109775,7 +111619,7 @@ See also g_task_return_error(). version="2.36"> Sets @task's result to @result and completes the task. If @result + line="39070">Sets @task's result to @result and completes the task. If @result is not %NULL, then @result_destroy will be used to free @result if the caller does not take ownership of it with g_task_propagate_pointer(). @@ -109801,7 +111645,7 @@ reference on it. a #GTask + line="39072">a #GTask allow-none="1"> the pointer result of a task + line="39073">the pointer result of a task function @@ -109821,7 +111665,7 @@ reference on it. scope="async"> a #GDestroyNotify function. + line="39075">a #GDestroyNotify function. @@ -109831,7 +111675,7 @@ reference on it. version="2.64"> Sets @task's result to @result (by copying it) and completes the task. + line="39100">Sets @task's result to @result (by copying it) and completes the task. If @result is %NULL then a #GValue of type #G_TYPE_POINTER with a value of %NULL will be used for the result. @@ -109847,7 +111691,7 @@ like will normally be much easier to use. a #GTask + line="39102">a #GTask allow-none="1"> the #GValue result of + line="39103">the #GValue result of a task function @@ -109867,7 +111711,7 @@ like will normally be much easier to use. version="2.36"> Runs @task_func in another thread. When @task_func returns, @task's + line="39119">Runs @task_func in another thread. When @task_func returns, @task's #GAsyncReadyCallback will be invoked in @task's #GMainContext. This takes a ref on @task until the task completes. @@ -109876,9 +111720,9 @@ See #GTaskThreadFunc for more details about how @task_func is handled. Although GLib currently rate-limits the tasks queued via g_task_run_in_thread(), you should not assume that it will always -do this. If you have a very large number of tasks to run, but don't -want them to all run at once, you should only queue a limited -number of them at a time. +do this. If you have a very large number of tasks to run (several tens of +tasks), but don't want them to all run at once, you should only queue a +limited number of them (around ten) at a time. @@ -109887,13 +111731,13 @@ number of them at a time. a #GTask + line="39121">a #GTask a #GTaskThreadFunc + line="39122">a #GTaskThreadFunc @@ -109903,7 +111747,7 @@ number of them at a time. version="2.36"> Runs @task_func in another thread, and waits for it to return or be + line="39141">Runs @task_func in another thread, and waits for it to return or be cancelled. You can use g_task_propagate_pointer(), etc, afterward to get the result of @task_func. @@ -109927,13 +111771,13 @@ limited number of them at a time. a #GTask + line="39143">a #GTask a #GTaskThreadFunc + line="39144">a #GTaskThreadFunc @@ -109943,7 +111787,7 @@ limited number of them at a time. version="2.36"> Sets or clears @task's check-cancellable flag. If this is %TRUE + line="39167">Sets or clears @task's check-cancellable flag. If this is %TRUE (the default), then g_task_propagate_pointer(), etc, and g_task_had_error() will check the task's #GCancellable first, and if it has been cancelled, then they will consider the task to have @@ -109965,13 +111809,13 @@ you must leave check-cancellable set %TRUE. the #GTask + line="39169">the #GTask whether #GTask will check the state of + line="39170">whether #GTask will check the state of its #GCancellable for you. @@ -109980,7 +111824,7 @@ you must leave check-cancellable set %TRUE. Sets @task’s name, used in debugging and profiling. The name defaults to + line="39192">Sets @task’s name, used in debugging and profiling. The name defaults to %NULL. The task name should describe in a human readable way what the task does. @@ -109997,7 +111841,7 @@ other than the one it was constructed in. a #GTask + line="39194">a #GTask allow-none="1"> a human readable name for the task, or %NULL to unset it + line="39195">a human readable name for the task, or %NULL to unset it @@ -110016,7 +111860,7 @@ other than the one it was constructed in. version="2.36"> Sets @task's priority. If you do not call this, it will default to + line="39211">Sets @task's priority. If you do not call this, it will default to %G_PRIORITY_DEFAULT. This will affect the priority of #GSources created with @@ -110031,13 +111875,13 @@ g_task_get_priority(). the #GTask + line="39213">the #GTask the [priority][io-priority] of the request + line="39214">the [priority][io-priority] of the request @@ -110047,7 +111891,7 @@ g_task_get_priority(). version="2.36"> Sets or clears @task's return-on-cancel flag. This is only + line="39228">Sets or clears @task's return-on-cancel flag. This is only meaningful for tasks run via g_task_run_in_thread() or g_task_run_in_thread_sync(). @@ -110079,7 +111923,7 @@ will also be completed right away. %TRUE if @task's return-on-cancel flag was changed to + line="39263">%TRUE if @task's return-on-cancel flag was changed to match @return_on_cancel. %FALSE if @task has already been cancelled. @@ -110088,13 +111932,13 @@ will also be completed right away. the #GTask + line="39230">the #GTask whether the task returns automatically when + line="39231">whether the task returns automatically when it is cancelled. @@ -110105,7 +111949,7 @@ will also be completed right away. version="2.36"> Sets @task's source tag. You can use this to tag a task return + line="39270">Sets @task's source tag. You can use this to tag a task return value with a particular pointer (usually a pointer to the function doing the tagging) and then later check it using g_task_get_source_tag() (or g_async_result_is_tagged()) in the @@ -110119,7 +111963,7 @@ particular place. the #GTask + line="39272">the #GTask allow-none="1"> an opaque pointer indicating the source of this task + line="39273">an opaque pointer indicating the source of this task @@ -110138,7 +111982,7 @@ particular place. version="2.36"> Sets @task's task data (freeing the existing task data, if any). + line="39286">Sets @task's task data (freeing the existing task data, if any). @@ -110147,7 +111991,7 @@ particular place. the #GTask + line="39288">the #GTask allow-none="1"> task-specific data + line="39289">task-specific data scope="async"> #GDestroyNotify for @task_data + line="39290">#GDestroyNotify for @task_data - + Whether the task has completed, meaning its callback (if set) has been + line="3512">Whether the task has completed, meaning its callback (if set) has been invoked. This can only happen after g_task_return_pointer(), g_task_return_error() or one of the other return functions have been called on the task. @@ -110195,7 +112042,7 @@ context as the task’s callback, immediately after that callback is invoked. The prototype for a task function to be run in a thread via + line="3529">The prototype for a task function to be run in a thread via g_task_run_in_thread() or g_task_run_in_thread_sync(). If the return-on-cancel flag is set on @task, and @cancellable gets @@ -110218,13 +112065,13 @@ Other than in that case, @task will be completed when the the #GTask + line="3531">the #GTask @task's source object + line="3532">@task's source object @task's task data + line="3533">@task's task data @task's #GCancellable, or %NULL + line="3534">@task's #GCancellable, or %NULL @@ -110257,38 +112104,40 @@ Other than in that case, @task will be completed when the glib:type-struct="TcpConnectionClass"> This is the subclass of #GSocketConnection that is created + line="9586">This is the subclass of #GSocketConnection that is created for TCP/IP sockets. Checks if graceful disconnects are used. See + line="39298">Checks if graceful disconnects are used. See g_tcp_connection_set_graceful_disconnect(). %TRUE if graceful disconnect is used on close, %FALSE otherwise + line="39305">%TRUE if graceful disconnect is used on close, %FALSE otherwise a #GTcpConnection + line="39300">a #GTcpConnection This enables graceful disconnects on close. A graceful disconnect + line="39310">This enables graceful disconnects on close. A graceful disconnect means that we signal the receiving end that the connection is terminated and wait for it to close the connection before closing the connection. @@ -110305,20 +112154,22 @@ take a while. For this reason it is disabled by default. a #GTcpConnection + line="39312">a #GTcpConnection Whether to do graceful disconnects or not + line="39313">Whether to do graceful disconnects or not + transfer-ownership="none" + setter="set_graceful_disconnect" + getter="get_graceful_disconnect"> @@ -110351,7 +112202,7 @@ take a while. For this reason it is disabled by default. glib:type-struct="TcpWrapperConnectionClass"> A #GTcpWrapperConnection can be used to wrap a #GIOStream that is + line="9600">A #GTcpWrapperConnection can be used to wrap a #GIOStream that is based on a #GSocket, but which is not actually a #GSocketConnection. This is used by #GSocketClient so that it can always return a #GSocketConnection, even when the connection it has @@ -110362,46 +112213,47 @@ actually created is not directly a #GSocketConnection. version="2.28"> Wraps @base_io_stream and @socket together as a #GSocketConnection. + line="39339">Wraps @base_io_stream and @socket together as a #GSocketConnection. the new #GSocketConnection. + line="39346">the new #GSocketConnection. the #GIOStream to wrap + line="39341">the #GIOStream to wrap the #GSocket associated with @base_io_stream + line="39342">the #GSocket associated with @base_io_stream + c:identifier="g_tcp_wrapper_connection_get_base_io_stream" + glib:get-property="base-io-stream"> Gets @conn's base #GIOStream + line="39329">Gets @conn's base #GIOStream @conn's base #GIOStream + line="39335">@conn's base #GIOStream a #GTcpWrapperConnection + line="39331">a #GTcpWrapperConnection @@ -110409,7 +112261,8 @@ actually created is not directly a #GSocketConnection. + transfer-ownership="none" + getter="get_base_io_stream"> @@ -110442,7 +112295,7 @@ actually created is not directly a #GSocketConnection. glib:get-type="g_test_dbus_get_type"> A helper class for testing code which uses D-Bus without touching the user's + line="9618">A helper class for testing code which uses D-Bus without touching the user's session bus. Note that #GTestDBus modifies the user’s environment, calling setenv(). @@ -110486,7 +112339,7 @@ you can proceed to set up a GTest fixture using the #GTestDBus scaffolding. An example of a test fixture for D-Bus services can be found here: -[gdbus-test-fixture.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-test-fixture.c) +[gdbus-test-fixture.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-test-fixture.c) Note that these examples only deal with isolating the D-Bus aspect of your service. To successfully run isolated unit tests on your service you may need @@ -110517,19 +112370,19 @@ do the following in the directory holding schemas: Create a new #GTestDBus object. + line="39395">Create a new #GTestDBus object. a new #GTestDBus. + line="39401">a new #GTestDBus. a #GTestDBusFlags + line="39397">a #GTestDBusFlags @@ -110537,7 +112390,7 @@ do the following in the directory holding schemas: Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test + line="39418">Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test won't use user's session bus. This is useful for unit tests that want to verify behaviour when no session @@ -110552,7 +112405,7 @@ g_test_dbus_up() before acquiring the session bus. c:identifier="g_test_dbus_add_service_dir"> Add a path where dbus-daemon will look up .service files. This can't be + line="39351">Add a path where dbus-daemon will look up .service files. This can't be called after g_test_dbus_up(). @@ -110562,13 +112415,13 @@ called after g_test_dbus_up(). a #GTestDBus + line="39353">a #GTestDBus path to a directory containing .service files + line="39354">path to a directory containing .service files @@ -110576,7 +112429,7 @@ called after g_test_dbus_up(). Stop the session bus started by g_test_dbus_up(). + line="39361">Stop the session bus started by g_test_dbus_up(). This will wait for the singleton returned by g_bus_get() or g_bus_get_sync() to be destroyed. This is done to ensure that the next unit test won't get a @@ -110589,7 +112442,7 @@ leaked singleton from this test. a #GTestDBus + line="39363">a #GTestDBus @@ -110598,41 +112451,43 @@ leaked singleton from this test. c:identifier="g_test_dbus_get_bus_address"> Get the address on which dbus-daemon is running. If g_test_dbus_up() has not + line="39373">Get the address on which dbus-daemon is running. If g_test_dbus_up() has not been called yet, %NULL is returned. This can be used with g_dbus_connection_new_for_address(). the address of the bus, or %NULL. + line="39381">the address of the bus, or %NULL. a #GTestDBus + line="39375">a #GTestDBus - + Get the flags of the #GTestDBus object. + line="39385">Get the flags of the #GTestDBus object. the value of #GTestDBus:flags property + line="39391">the value of #GTestDBus:flags property a #GTestDBus + line="39387">a #GTestDBus @@ -110640,7 +112495,7 @@ g_dbus_connection_new_for_address(). Stop the session bus started by g_test_dbus_up(). + line="39405">Stop the session bus started by g_test_dbus_up(). Unlike g_test_dbus_down(), this won't verify the #GDBusConnection singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit @@ -110654,7 +112509,7 @@ can use this function but should still call g_test_dbus_down() when done. a #GTestDBus + line="39407">a #GTestDBus @@ -110662,7 +112517,7 @@ can use this function but should still call g_test_dbus_down() when done. Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this + line="39430">Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this call, it is safe for unit tests to start sending messages on the session bus. If this function is called from setup callback of g_test_add(), @@ -110678,7 +112533,7 @@ must be called after g_test_run(). a #GTestDBus + line="39432">a #GTestDBus @@ -110687,10 +112542,11 @@ must be called after g_test_run(). version="2.34" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_flags"> #GTestDBusFlags specifying the behaviour of the D-Bus session. + line="3574">#GTestDBusFlags specifying the behaviour of the D-Bus session. @@ -110701,14 +112557,15 @@ must be called after g_test_run(). c:type="GTestDBusFlags"> Flags to define future #GTestDBus behaviour. + line="1939">Flags to define future #GTestDBus behaviour. + glib:nick="none" + glib:name="G_TEST_DBUS_NONE"> No flags. + line="1941">No flags. glib:type-struct="ThemedIconClass"> #GThemedIcon is an implementation of #GIcon that supports icon themes. + line="9698">#GThemedIcon is an implementation of #GIcon that supports icon themes. #GThemedIcon contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. #GThemedIcon does not provide actual pixmaps for icons, just the icon names. @@ -110732,19 +112589,19 @@ themes that inherit other themes. Creates a new themed icon for @iconname. + line="39467">Creates a new themed icon for @iconname. a new #GThemedIcon. + line="39473">a new #GThemedIcon. a string containing an icon name. + line="39469">a string containing an icon name. @@ -110753,19 +112610,19 @@ themes that inherit other themes. c:identifier="g_themed_icon_new_from_names"> Creates a new themed icon for @iconnames. + line="39477">Creates a new themed icon for @iconnames. a new #GThemedIcon + line="39485">a new #GThemedIcon an array of strings containing icon names. + line="39479">an array of strings containing icon names. @@ -110773,7 +112630,7 @@ themes that inherit other themes. the length of the @iconnames array, or -1 if @iconnames is + line="39480">the length of the @iconnames array, or -1 if @iconnames is %NULL-terminated @@ -110783,7 +112640,7 @@ themes that inherit other themes. c:identifier="g_themed_icon_new_with_default_fallbacks"> Creates a new themed icon for @iconname, and all the names + line="39489">Creates a new themed icon for @iconname, and all the names that can be created by shortening @iconname at '-' characters. In the following example, @icon1 and @icon2 are equivalent: @@ -110802,14 +112659,14 @@ icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); a new #GThemedIcon. + line="39509">a new #GThemedIcon. a string containing an icon name + line="39491">a string containing an icon name @@ -110817,7 +112674,7 @@ icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); Append a name to the list of icons from within @icon. + line="39445">Append a name to the list of icons from within @icon. Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). @@ -110829,26 +112686,28 @@ to g_icon_hash(). a #GThemedIcon + line="39447">a #GThemedIcon name of icon to append to list of icons from within @icon. + line="39448">name of icon to append to list of icons from within @icon. - + Gets the names of icons from within @icon. + line="39457">Gets the names of icons from within @icon. a list of icon names. + line="39463">a list of icon names. @@ -110857,7 +112716,7 @@ to g_icon_hash(). a #GThemedIcon. + line="39459">a #GThemedIcon. @@ -110867,7 +112726,7 @@ to g_icon_hash(). version="2.18"> Prepend a name to the list of icons from within @icon. + line="39513">Prepend a name to the list of icons from within @icon. Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). @@ -110879,13 +112738,13 @@ to g_icon_hash(). a #GThemedIcon + line="39515">a #GThemedIcon name of icon to prepend to list of icons from within @icon. + line="39516">name of icon to prepend to list of icons from within @icon. @@ -110897,16 +112756,17 @@ to g_icon_hash(). transfer-ownership="none"> The icon name. + line="3583">The icon name. + transfer-ownership="none" + getter="get_names"> A %NULL-terminated array of icon names. + line="3590">A %NULL-terminated array of icon names. @@ -110917,7 +112777,7 @@ to g_icon_hash(). transfer-ownership="none"> Whether to use the default fallbacks found by shortening the icon name + line="3597">Whether to use the default fallbacks found by shortening the icon name at '-' characters. If the "names" array has more than one element, ignores any past the first. @@ -110951,7 +112811,7 @@ would become glib:type-struct="ThreadedSocketServiceClass"> A #GThreadedSocketService is a simple subclass of #GSocketService + line="9714">A #GThreadedSocketService is a simple subclass of #GSocketService that handles incoming connections by creating a worker thread and dispatching the connection to it by emitting the #GThreadedSocketService::run signal in the new thread. @@ -110972,20 +112832,20 @@ or subclass and override the default handler. version="2.22"> Creates a new #GThreadedSocketService with no listeners. Listeners + line="39555">Creates a new #GThreadedSocketService with no listeners. Listeners must be added with one of the #GSocketListener "add" methods. a new #GSocketService. + line="39563">a new #GSocketService. the maximal number of threads to execute concurrently + line="39557">the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit @@ -111025,21 +112885,21 @@ must be added with one of the #GSocketListener "add" methods. The ::run signal is emitted in a worker thread in response to an + line="3618">The ::run signal is emitted in a worker thread in response to an incoming connection. This thread is dedicated to handling @connection and may perform blocking IO. The signal handler need not return until the connection is closed. %TRUE to stop further signal handlers from being called + line="3629">%TRUE to stop further signal handlers from being called a new #GSocketConnection object. + line="3621">a new #GSocketConnection object. allow-none="1"> the source_object passed to g_socket_listener_add_address(). + line="3622">the source_object passed to g_socket_listener_add_address(). @@ -111134,30 +112994,33 @@ not return until the connection is closed. c:type="GTlsAuthenticationMode"> The client authentication mode for a #GTlsServerConnection. + line="1606">The client authentication mode for a #GTlsServerConnection. + glib:nick="none" + glib:name="G_TLS_AUTHENTICATION_NONE"> client authentication not required + line="1608">client authentication not required + glib:nick="requested" + glib:name="G_TLS_AUTHENTICATION_REQUESTED"> client authentication is requested + line="1609">client authentication is requested + glib:nick="required" + glib:name="G_TLS_AUTHENTICATION_REQUIRED"> client authentication is required + line="1610">client authentication is required glib:type-struct="TlsBackendInterface"> TLS (Transport Layer Security, aka SSL) and DTLS backend. + line="9776">TLS (Transport Layer Security, aka SSL) and DTLS backend. Gets the default #GTlsBackend for the system. + line="39592">Gets the default #GTlsBackend for the system. a #GTlsBackend + line="39597">a #GTlsBackend, which will be a + dummy object if no TLS backend is available @@ -111190,12 +113054,12 @@ not return until the connection is closed. version="2.30"> Gets the default #GTlsDatabase used to verify TLS connections. + line="39603">Gets the default #GTlsDatabase used to verify TLS connections. the default database, which should be + line="39609">the default database, which should be unreffed when done. @@ -111203,7 +113067,7 @@ not return until the connection is closed. the #GTlsBackend + line="39605">the #GTlsBackend @@ -111213,20 +113077,20 @@ not return until the connection is closed. version="2.48"> Checks if DTLS is supported. DTLS support may not be available even if TLS + line="39680">Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa. whether DTLS is supported + line="39687">whether DTLS is supported the #GTlsBackend + line="39682">the #GTlsBackend @@ -111236,20 +113100,20 @@ support is available, and vice-versa. version="2.28"> Checks if TLS is supported; if this returns %FALSE for the default + line="39692">Checks if TLS is supported; if this returns %FALSE for the default #GTlsBackend, it means no "real" TLS backend is available. whether or not TLS is supported + line="39699">whether or not TLS is supported the #GTlsBackend + line="39694">the #GTlsBackend @@ -111259,12 +113123,12 @@ support is available, and vice-versa. version="2.28"> Gets the #GType of @backend's #GTlsCertificate implementation. + line="39568">Gets the #GType of @backend's #GTlsCertificate implementation. the #GType of @backend's #GTlsCertificate + line="39574">the #GType of @backend's #GTlsCertificate implementation. @@ -111272,7 +113136,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39570">the #GTlsBackend @@ -111282,12 +113146,12 @@ support is available, and vice-versa. version="2.28"> Gets the #GType of @backend's #GTlsClientConnection implementation. + line="39580">Gets the #GType of @backend's #GTlsClientConnection implementation. the #GType of @backend's #GTlsClientConnection + line="39586">the #GType of @backend's #GTlsClientConnection implementation. @@ -111295,7 +113159,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39582">the #GTlsBackend @@ -111305,12 +113169,12 @@ support is available, and vice-versa. version="2.30"> Gets the default #GTlsDatabase used to verify TLS connections. + line="39603">Gets the default #GTlsDatabase used to verify TLS connections. the default database, which should be + line="39609">the default database, which should be unreffed when done. @@ -111318,7 +113182,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39605">the #GTlsBackend @@ -111328,12 +113192,12 @@ support is available, and vice-versa. version="2.48"> Gets the #GType of @backend’s #GDtlsClientConnection implementation. + line="39615">Gets the #GType of @backend’s #GDtlsClientConnection implementation. the #GType of @backend’s #GDtlsClientConnection + line="39621">the #GType of @backend’s #GDtlsClientConnection implementation, or %G_TYPE_INVALID if this backend doesn’t support DTLS. @@ -111341,7 +113205,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39617">the #GTlsBackend @@ -111351,12 +113215,12 @@ support is available, and vice-versa. version="2.48"> Gets the #GType of @backend’s #GDtlsServerConnection implementation. + line="39627">Gets the #GType of @backend’s #GDtlsServerConnection implementation. the #GType of @backend’s #GDtlsServerConnection + line="39633">the #GType of @backend’s #GDtlsServerConnection implementation, or %G_TYPE_INVALID if this backend doesn’t support DTLS. @@ -111364,7 +113228,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39629">the #GTlsBackend @@ -111374,19 +113238,19 @@ support is available, and vice-versa. version="2.30"> Gets the #GType of @backend's #GTlsFileDatabase implementation. + line="39639">Gets the #GType of @backend's #GTlsFileDatabase implementation. the #GType of backend's #GTlsFileDatabase implementation. + line="39645">the #GType of backend's #GTlsFileDatabase implementation. the #GTlsBackend + line="39641">the #GTlsBackend @@ -111396,12 +113260,12 @@ support is available, and vice-versa. version="2.28"> Gets the #GType of @backend's #GTlsServerConnection implementation. + line="39650">Gets the #GType of @backend's #GTlsServerConnection implementation. the #GType of @backend's #GTlsServerConnection + line="39656">the #GType of @backend's #GTlsServerConnection implementation. @@ -111409,7 +113273,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39652">the #GTlsBackend @@ -111419,7 +113283,7 @@ support is available, and vice-versa. version="2.60"> Set the default #GTlsDatabase used to verify TLS connections + line="39662">Set the default #GTlsDatabase used to verify TLS connections Any subsequent call to g_tls_backend_get_default_database() will return the database set in this call. Existing databases and connections are not @@ -111435,7 +113299,7 @@ database as if g_tls_backend_set_default_database() had never been called. the #GTlsBackend + line="39664">the #GTlsBackend allow-none="1"> the #GTlsDatabase + line="39665">the #GTlsDatabase @@ -111454,20 +113318,20 @@ database as if g_tls_backend_set_default_database() had never been called. version="2.48"> Checks if DTLS is supported. DTLS support may not be available even if TLS + line="39680">Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa. whether DTLS is supported + line="39687">whether DTLS is supported the #GTlsBackend + line="39682">the #GTlsBackend @@ -111477,20 +113341,20 @@ support is available, and vice-versa. version="2.28"> Checks if TLS is supported; if this returns %FALSE for the default + line="39692">Checks if TLS is supported; if this returns %FALSE for the default #GTlsBackend, it means no "real" TLS backend is available. whether or not TLS is supported + line="39699">whether or not TLS is supported the #GTlsBackend + line="39694">the #GTlsBackend @@ -111516,14 +113380,14 @@ support is available, and vice-versa. whether or not TLS is supported + line="39699">whether or not TLS is supported the #GTlsBackend + line="39694">the #GTlsBackend @@ -111567,7 +113431,7 @@ support is available, and vice-versa. the default database, which should be + line="39609">the default database, which should be unreffed when done. @@ -111575,7 +113439,7 @@ support is available, and vice-versa. the #GTlsBackend + line="39605">the #GTlsBackend @@ -111587,14 +113451,14 @@ support is available, and vice-versa. whether DTLS is supported + line="39687">whether DTLS is supported the #GTlsBackend + line="39682">the #GTlsBackend @@ -111628,7 +113492,7 @@ support is available, and vice-versa. glib:type-struct="TlsCertificateClass"> A certificate used for TLS authentication and encryption. + line="9788">A certificate used for TLS authentication and encryption. This can represent either a certificate only (eg, the certificate received by a client from a server), or the combination of a certificate and a private key (which is needed when acting as a @@ -111640,7 +113504,7 @@ a certificate and a private key (which is needed when acting as a throws="1"> Creates a #GTlsCertificate from the PEM-encoded data in @file. The + line="39819">Creates a #GTlsCertificate from the PEM-encoded data in @file. The returned certificate will be the first certificate found in @file. As of GLib 2.44, if @file contains more certificates it will try to load a certificate chain. All certificates will be verified in the order @@ -111657,14 +113521,14 @@ g_tls_certificate_new_from_pem(). the new certificate, or %NULL on error + line="39838">the new certificate, or %NULL on error file containing a PEM-encoded certificate to import + line="39821">file containing a PEM-encoded certificate to import @@ -111675,7 +113539,7 @@ g_tls_certificate_new_from_pem(). throws="1"> Creates a #GTlsCertificate from the PEM-encoded data in @cert_file + line="39843">Creates a #GTlsCertificate from the PEM-encoded data in @cert_file and @key_file. The returned certificate will be the first certificate found in @cert_file. As of GLib 2.44, if @cert_file contains more certificates it will try to load a certificate chain. All @@ -111693,21 +113557,21 @@ g_tls_certificate_new_from_pem(). the new certificate, or %NULL on error + line="39866">the new certificate, or %NULL on error file containing one or more PEM-encoded + line="39845">file containing one or more PEM-encoded certificates to import file containing a PEM-encoded private key + line="39847">file containing a PEM-encoded private key to import @@ -111719,7 +113583,7 @@ g_tls_certificate_new_from_pem(). throws="1"> Creates a #GTlsCertificate from the PEM-encoded data in @data. If + line="39871">Creates a #GTlsCertificate from the PEM-encoded data in @data. If @data includes both a certificate and a private key, then the returned certificate will include the private key data as well. (See the #GTlsCertificate:private-key-pem property for information about @@ -111737,40 +113601,95 @@ the file will still be returned. the new certificate, or %NULL if @data is invalid + line="39892">the new certificate, or %NULL if @data is invalid PEM-encoded certificate data + line="39873">PEM-encoded certificate data the length of @data, or -1 if it's 0-terminated. + line="39874">the length of @data, or -1 if it's 0-terminated. + + Creates a #GTlsCertificate from a +[PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) URI. + +An example @pkcs11_uri would be `pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01` + +Where the token’s layout is: + +|[ +Object 0: + URL: pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01;object=private%20key;type=private + Type: Private key (RSA-2048) + ID: 01 + +Object 1: + URL: pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01;object=Certificate%20for%20Authentication;type=cert + Type: X.509 Certificate (RSA-2048) + ID: 01 +]| + +In this case the certificate and private key would both be detected and used as expected. +@pkcs_uri may also just reference an X.509 certificate object and then optionally +@private_key_pkcs11_uri allows using a private key exposed under a different URI. + +Note that the private key is not accessed until usage and may fail or require a PIN later. + + + the new certificate, or %NULL on error + + + + + A PKCS \#11 URI + + + + A PKCS \#11 URI + + + + Creates one or more #GTlsCertificates from the PEM-encoded + line="39801">Creates one or more #GTlsCertificates from the PEM-encoded data in @file. If @file cannot be read or parsed, the function will return %NULL and set @error. If @file does not contain any PEM-encoded certificates, this will return an empty list and not set @error. - + a + line="39812">a #GList containing #GTlsCertificate objects. You must free the list and its contents when you are done with it. @@ -111781,7 +113700,7 @@ and its contents when you are done with it. file containing PEM-encoded certificates to import + line="39803">file containing PEM-encoded certificates to import @@ -111789,7 +113708,7 @@ and its contents when you are done with it. This verifies @cert and returns a set of #GTlsCertificateFlags + line="39933">This verifies @cert and returns a set of #GTlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system @@ -111807,19 +113726,26 @@ in its chain) must be signed by it, or else value. (All other #GTlsCertificateFlags values will always be set or unset -as appropriate.) +as appropriate.) + +Because TLS session context is not used, #GTlsCertificate may not +perform as many checks on the certificates as #GTlsConnection would. +For example, certificate constraints cannot be honored, and some +revocation checks cannot be performed. The best way to verify TLS +certificates used by a TLS connection is to let #GTlsConnection +handle the verification. the appropriate #GTlsCertificateFlags + line="39966">the appropriate #GTlsCertificateFlags a #GTlsCertificate + line="39935">a #GTlsCertificate allow-none="1"> the expected peer identity + line="39936">the expected peer identity allow-none="1"> the certificate of a trusted authority + line="39937">the certificate of a trusted authority + + Gets the value of #GTlsCertificate:dns-names. + + + A #GPtrArray of +#GBytes elements, or %NULL if it's not available. + + + + + + + a #GTlsCertificate + + + + + + Gets the value of #GTlsCertificate:ip-addresses. + + + A #GPtrArray +of #GInetAddress elements, or %NULL if it's not available. + + + + + + + a #GTlsCertificate + + + + Gets the #GTlsCertificate representing @cert's issuer, if known - - + line="39728">Gets the #GTlsCertificate representing @cert's issuer, if known + + The certificate of @cert's issuer, + line="39734">The certificate of @cert's issuer, or %NULL if @cert is self-signed or signed with an unknown certificate. @@ -111861,7 +113840,99 @@ certificate. a #GTlsCertificate + line="39730">a #GTlsCertificate + + + + + + Returns the issuer name from the certificate. + + + The issuer name, or %NULL if it's not available. + + + + + a #GTlsCertificate + + + + + + Returns the time at which the certificate became or will become invalid. + + + The not-valid-after date, or %NULL if it's not available. + + + + + a #GTlsCertificate + + + + + + Returns the time at which the certificate became or will become valid. + + + The not-valid-before date, or %NULL if it's not available. + + + + + a #GTlsCertificate + + + + + + Returns the subject name from the certificate. + + + The subject name, or %NULL if it's not available. + + + + + a #GTlsCertificate @@ -111871,29 +113942,29 @@ certificate. version="2.34"> Check if two #GTlsCertificate objects represent the same certificate. + line="39785">Check if two #GTlsCertificate objects represent the same certificate. The raw DER byte data of the two certificates are checked for equality. This has the effect that two certificates may compare equal even if their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or #GTlsCertificate:private-key-pem properties differ. - + whether the same or not + line="39796">whether the same or not first certificate to compare + line="39787">first certificate to compare second certificate to compare + line="39788">second certificate to compare @@ -111903,7 +113974,7 @@ their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or version="2.28"> This verifies @cert and returns a set of #GTlsCertificateFlags + line="39933">This verifies @cert and returns a set of #GTlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system @@ -111921,19 +113992,26 @@ in its chain) must be signed by it, or else value. (All other #GTlsCertificateFlags values will always be set or unset -as appropriate.) - +as appropriate.) + +Because TLS session context is not used, #GTlsCertificate may not +perform as many checks on the certificates as #GTlsConnection would. +For example, certificate constraints cannot be honored, and some +revocation checks cannot be performed. The best way to verify TLS +certificates used by a TLS connection is to let #GTlsConnection +handle the verification. + the appropriate #GTlsCertificateFlags + line="39966">the appropriate #GTlsCertificateFlags a #GTlsCertificate + line="39935">a #GTlsCertificate allow-none="1"> the expected peer identity + line="39936">the expected peer identity allow-none="1"> the certificate of a trusted authority + line="39937">the certificate of a trusted authority @@ -111963,7 +114041,7 @@ as appropriate.) transfer-ownership="none"> The DER (binary) encoded representation of the certificate. + line="3653">The DER (binary) encoded representation of the certificate. This property and the #GTlsCertificate:certificate-pem property represent the same data, just in different forms. @@ -111977,63 +114055,179 @@ represent the same data, just in different forms. transfer-ownership="none"> The PEM (ASCII) encoded representation of the certificate. + line="3664">The PEM (ASCII) encoded representation of the certificate. This property and the #GTlsCertificate:certificate property represent the same data, just in different forms. + + The DNS names from the certificate's Subject Alternative Names (SANs), +%NULL if unavailable. + + + + + + The IP addresses from the certificate's Subject Alternative Names (SANs), +%NULL if unavailable. + + + + + transfer-ownership="none" + getter="get_issuer"> A #GTlsCertificate representing the entity that issued this + line="3695">A #GTlsCertificate representing the entity that issued this certificate. If %NULL, this means that the certificate is either self-signed, or else the certificate of the issuer is not -available. +available. + +Beware the issuer certificate may not be the same as the +certificate that would actually be used to construct a valid +certification path during certificate verification. +[RFC 4158](https://datatracker.ietf.org/doc/html/rfc4158) explains +why an issuer certificate cannot be naively assumed to be part of the +the certification path (though GLib's TLS backends may not follow the +path building strategies outlined in this RFC). Due to the complexity +of certification path building, GLib does not provide any way to know +which certification path will actually be used. Accordingly, this +property cannot be used to make security-related decisions. Only +GLib itself should make security decisions about TLS certificates. - + The issuer from the certificate, +%NULL if unavailable. + + + + The time at which this cert is no longer valid, +%NULL if unavailable. + + + + The time at which this cert is considered to be valid, +%NULL if unavailable. + + + The DER (binary) encoded representation of the certificate's -private key, in either PKCS#1 format or unencrypted PKCS#8 -format. This property (or the #GTlsCertificate:private-key-pem -property) can be set when constructing a key (eg, from a file), -but cannot be read. + line="3749">A URI referencing the [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) +objects containing an X.509 certificate and optionally a private key. -PKCS#8 format is supported since 2.32; earlier releases only -support PKCS#1. You can use the `openssl rsa` -tool to convert PKCS#8 keys to PKCS#1. +If %NULL, the certificate is either not backed by PKCS \#11 or the +#GTlsBackend does not support PKCS \#11. + + + + The DER (binary) encoded representation of the certificate's +private key, in either [PKCS \#1 format](https://datatracker.ietf.org/doc/html/rfc8017) +or unencrypted [PKCS \#8 format.](https://datatracker.ietf.org/doc/html/rfc5208) +PKCS \#8 format is supported since 2.32; earlier releases only +support PKCS \#1. You can use the `openssl rsa` tool to convert +PKCS \#8 keys to PKCS \#1. + +This property (or the #GTlsCertificate:private-key-pem property) +can be set when constructing a key (for example, from a file). +Since GLib 2.70, it is now also readable; however, be aware that if +the private key is backed by a PKCS \#11 URI – for example, if it +is stored on a smartcard – then this property will be %NULL. If so, +the private key must be referenced via its PKCS \#11 URI, +#GTlsCertificate:private-key-pkcs11-uri. You must check both +properties to see if the certificate really has a private key. +When this property is read, the output format will be unencrypted +PKCS \#8. The PEM (ASCII) encoded representation of the certificate's -private key in either PKCS#1 format ("`BEGIN RSA PRIVATE -KEY`") or unencrypted PKCS#8 format ("`BEGIN -PRIVATE KEY`"). This property (or the -#GTlsCertificate:private-key property) can be set when -constructing a key (eg, from a file), but cannot be read. + line="3787">The PEM (ASCII) encoded representation of the certificate's +private key in either [PKCS \#1 format](https://datatracker.ietf.org/doc/html/rfc8017) +("`BEGIN RSA PRIVATE KEY`") or unencrypted +[PKCS \#8 format](https://datatracker.ietf.org/doc/html/rfc5208) +("`BEGIN PRIVATE KEY`"). PKCS \#8 format is supported since 2.32; +earlier releases only support PKCS \#1. You can use the `openssl rsa` +tool to convert PKCS \#8 keys to PKCS \#1. -PKCS#8 format is supported since 2.32; earlier releases only -support PKCS#1. You can use the `openssl rsa` -tool to convert PKCS#8 keys to PKCS#1. +This property (or the #GTlsCertificate:private-key property) +can be set when constructing a key (for example, from a file). +Since GLib 2.70, it is now also readable; however, be aware that if +the private key is backed by a PKCS \#11 URI - for example, if it +is stored on a smartcard - then this property will be %NULL. If so, +the private key must be referenced via its PKCS \#11 URI, +#GTlsCertificate:private-key-pkcs11-uri. You must check both +properties to see if the certificate really has a private key. +When this property is read, the output format will be unencrypted +PKCS \#8. + + + + A URI referencing a [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) +object containing a private key. + + + + The subject from the cert, +%NULL if unavailable. @@ -112056,14 +114250,14 @@ tool to convert PKCS#8 keys to PKCS#1. the appropriate #GTlsCertificateFlags + line="39966">the appropriate #GTlsCertificateFlags a #GTlsCertificate + line="39935">a #GTlsCertificate allow-none="1"> the expected peer identity + line="39936">the expected peer identity allow-none="1"> the certificate of a trusted authority + line="39937">the certificate of a trusted authority @@ -112100,7 +114294,7 @@ tool to convert PKCS#8 keys to PKCS#1. c:type="GTlsCertificateFlags"> A set of flags describing TLS certification validation. This can be + line="1568">A set of flags describing TLS certification validation. This can be used to set which validation steps to perform (eg, with g_tls_client_connection_set_validation_flags()), or to describe why a particular certificate was rejected (eg, in @@ -112108,72 +114302,80 @@ a particular certificate was rejected (eg, in + glib:nick="unknown-ca" + glib:name="G_TLS_CERTIFICATE_UNKNOWN_CA"> The signing certificate authority is + line="1570">The signing certificate authority is not known. + glib:nick="bad-identity" + glib:name="G_TLS_CERTIFICATE_BAD_IDENTITY"> The certificate does not match the + line="1572">The certificate does not match the expected identity of the site that it was retrieved from. + glib:nick="not-activated" + glib:name="G_TLS_CERTIFICATE_NOT_ACTIVATED"> The certificate's activation time + line="1574">The certificate's activation time is still in the future + glib:nick="expired" + glib:name="G_TLS_CERTIFICATE_EXPIRED"> The certificate has expired + line="1576">The certificate has expired + glib:nick="revoked" + glib:name="G_TLS_CERTIFICATE_REVOKED"> The certificate has been revoked + line="1577">The certificate has been revoked according to the #GTlsConnection's certificate revocation list. + glib:nick="insecure" + glib:name="G_TLS_CERTIFICATE_INSECURE"> The certificate's algorithm is + line="1579">The certificate's algorithm is considered insecure. + glib:nick="generic-error" + glib:name="G_TLS_CERTIFICATE_GENERIC_ERROR"> Some other error occurred validating + line="1581">Some other error occurred validating the certificate + glib:nick="validate-all" + glib:name="G_TLS_CERTIFICATE_VALIDATE_ALL"> the combination of all of the above + line="1583">the combination of all of the above flags @@ -112189,16 +114391,17 @@ a particular certificate was rejected (eg, in c:type="GTlsCertificateRequestFlags"> Flags for g_tls_interaction_request_certificate(), + line="1814">Flags for g_tls_interaction_request_certificate(), g_tls_interaction_request_certificate_async(), and g_tls_interaction_invoke_request_certificate(). + glib:nick="none" + glib:name="G_TLS_CERTIFICATE_REQUEST_NONE"> No flags + line="1816">No flags glib:error-domain="g-tls-channel-binding-error-quark"> An error code used with %G_TLS_CHANNEL_BINDING_ERROR in a #GError to + line="1644">An error code used with %G_TLS_CHANNEL_BINDING_ERROR in a #GError to indicate a TLS channel binding retrieval error. + glib:nick="not-implemented" + glib:name="G_TLS_CHANNEL_BINDING_ERROR_NOT_IMPLEMENTED"> Either entire binding + line="1646">Either entire binding retrieval facility or specific binding type is not implemented in the TLS backend. + glib:nick="invalid-state" + glib:name="G_TLS_CHANNEL_BINDING_ERROR_INVALID_STATE"> The handshake is not yet + line="1649">The handshake is not yet complete on the connection which is a strong requirement for any existing binding type. + glib:nick="not-available" + glib:name="G_TLS_CHANNEL_BINDING_ERROR_NOT_AVAILABLE"> Handshake is complete but + line="1652">Handshake is complete but binding data is not available. That normally indicates the TLS implementation failed to provide the binding data. For example, some implementations do not provide a peer certificate for resumed connections. @@ -112245,10 +114451,11 @@ indicate a TLS channel binding retrieval error. + glib:nick="not-supported" + glib:name="G_TLS_CHANNEL_BINDING_ERROR_NOT_SUPPORTED"> Binding type is not supported + line="1656">Binding type is not supported on the current connection. This error could be triggered when requesting `tls-server-end-point` binding data for a certificate which has no hash function or uses multiple hash functions. @@ -112256,10 +114463,11 @@ indicate a TLS channel binding retrieval error. + glib:nick="general-error" + glib:name="G_TLS_CHANNEL_BINDING_ERROR_GENERAL_ERROR"> Any other backend error + line="1660">Any other backend error preventing binding data retrieval. version="2.66"> Gets the TLS channel binding error quark. + line="39971">Gets the TLS channel binding error quark. a #GQuark. + line="39976">a #GQuark. @@ -112283,26 +114491,28 @@ indicate a TLS channel binding retrieval error. c:type="GTlsChannelBindingType"> The type of TLS channel binding data to retrieve from #GTlsConnection + line="1622">The type of TLS channel binding data to retrieve from #GTlsConnection or #GDtlsConnection, as documented by RFC 5929. The [`tls-unique-for-telnet`](https://tools.ietf.org/html/rfc5929#section-5) binding type is not currently implemented. + glib:nick="unique" + glib:name="G_TLS_CHANNEL_BINDING_TLS_UNIQUE"> [`tls-unique`](https://tools.ietf.org/html/rfc5929#section-3) binding + line="1624">[`tls-unique`](https://tools.ietf.org/html/rfc5929#section-3) binding type + glib:nick="server-end-point" + glib:name="G_TLS_CHANNEL_BINDING_TLS_SERVER_END_POINT"> [`tls-server-end-point`](https://tools.ietf.org/html/rfc5929#section-4) + line="1627">[`tls-server-end-point`](https://tools.ietf.org/html/rfc5929#section-4) binding type @@ -112315,7 +114525,7 @@ binding type is not currently implemented. glib:type-struct="TlsClientConnectionInterface"> #GTlsClientConnection is the client-side subclass of + line="9805">#GTlsClientConnection is the client-side subclass of #GTlsConnection, representing a client-side TLS connection. @@ -112325,7 +114535,7 @@ binding type is not currently implemented. throws="1"> Creates a new #GTlsClientConnection wrapping @base_io_stream (which + line="40075">Creates a new #GTlsClientConnection wrapping @base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by @server_identity. @@ -112336,7 +114546,7 @@ this function has returned. the new + line="40089">the new #GTlsClientConnection, or %NULL on error @@ -112344,7 +114554,7 @@ this function has returned. the #GIOStream to wrap + line="40077">the #GIOStream to wrap allow-none="1"> the expected identity of the server + line="40078">the expected identity of the server @@ -112363,7 +114573,7 @@ this function has returned. version="2.46"> Possibly copies session state from one connection to another, for use + line="39981">Possibly copies session state from one connection to another, for use in TLS session resumption. This is not normally needed, but may be used when the same session needs to be used between different endpoints, as is required by some protocols, such as FTP over TLS. @@ -112399,13 +114609,13 @@ ticket to be copied without regard for privacy considerations. a #GTlsClientConnection + line="39983">a #GTlsClientConnection a #GTlsClientConnection + line="39984">a #GTlsClientConnection @@ -112415,7 +114625,7 @@ ticket to be copied without regard for privacy considerations. version="2.46"> Possibly copies session state from one connection to another, for use + line="39981">Possibly copies session state from one connection to another, for use in TLS session resumption. This is not normally needed, but may be used when the same session needs to be used between different endpoints, as is required by some protocols, such as FTP over TLS. @@ -112451,23 +114661,24 @@ ticket to be copied without regard for privacy considerations. a #GTlsClientConnection + line="39983">a #GTlsClientConnection a #GTlsClientConnection + line="39984">a #GTlsClientConnection Gets the list of distinguished names of the Certificate Authorities + line="40019">Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be %NULL. @@ -112478,7 +114689,7 @@ subject DN of the certificate authority. the list of + line="40031">the list of CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free(). @@ -112491,22 +114702,23 @@ the free the list with g_list_free(). the #GTlsClientConnection + line="40021">the #GTlsClientConnection Gets @conn's expected server identity + line="40038">Gets @conn's expected server identity - + a #GSocketConnectable describing the + line="40044">a #GSocketConnectable describing the expected server identity, or %NULL if the expected identity is not known. @@ -112515,65 +114727,68 @@ known. the #GTlsClientConnection + line="40040">the #GTlsClientConnection SSL 3.0 is no longer supported. See + line="40051">SSL 3.0 is no longer supported. See g_tls_client_connection_set_use_ssl3() for details. SSL 3.0 is insecure. %FALSE + line="40058">%FALSE the #GTlsClientConnection + line="40053">the #GTlsClientConnection Gets @conn's validation flags + line="40064">Gets @conn's validation flags the validation flags + line="40070">the validation flags the #GTlsClientConnection + line="40066">the #GTlsClientConnection Sets @conn's expected server identity, which is used both to tell + line="40095">Sets @conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let @conn know what name to look for in the certificate when performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. @@ -112585,25 +114800,26 @@ performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. the #GTlsClientConnection + line="40097">the #GTlsClientConnection a #GSocketConnectable describing the expected server identity + line="40098">a #GSocketConnectable describing the expected server identity Since GLib 2.42.1, SSL 3.0 is no longer supported. + line="40109">Since GLib 2.42.1, SSL 3.0 is no longer supported. From GLib 2.42.1 through GLib 2.62, this function could be used to force use of TLS 1.0, the lowest-supported TLS protocol version at @@ -112622,23 +114838,24 @@ Since GLib 2.64, this function does nothing. the #GTlsClientConnection + line="40111">the #GTlsClientConnection a #gboolean, ignored + line="40112">a #gboolean, ignored Sets @conn's validation flags, to override the default set of + line="40130">Sets @conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used. @@ -112649,21 +114866,24 @@ checks performed when validating a server certificate. By default, the #GTlsClientConnection + line="40132">the #GTlsClientConnection the #GTlsCertificateFlags to use + line="40133">the #GTlsCertificateFlags to use - + A list of the distinguished names of the Certificate Authorities + line="3843">A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes. @@ -112678,10 +114898,12 @@ subject DN of the certificate authority. version="2.28" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_server_identity" + getter="get_server_identity"> A #GSocketConnectable describing the identity of the server that + line="3858">A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in @@ -112703,10 +114925,12 @@ virtual hosts. deprecated-version="2.56" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_use_ssl3" + getter="get_use_ssl3"> SSL 3.0 is no longer supported. See + line="3880">SSL 3.0 is no longer supported. See g_tls_client_connection_set_use_ssl3() for details. SSL 3.0 is insecure. @@ -112715,10 +114939,12 @@ g_tls_client_connection_set_use_ssl3() for details. version="2.28" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_validation_flags" + getter="get_validation_flags"> What steps to perform when validating a certificate received from + line="3891">What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in any of the ways indicated here will be rejected unless the application overrides the default via #GTlsConnection::accept-certificate. @@ -112749,13 +114975,13 @@ overrides the default via #GTlsConnection::accept-certificate. a #GTlsClientConnection + line="39983">a #GTlsClientConnection a #GTlsClientConnection + line="39984">a #GTlsClientConnection @@ -112773,15 +114999,15 @@ overrides the default via #GTlsConnection::accept-certificate. glib:type-struct="TlsConnectionClass"> #GTlsConnection is the base TLS connection class type, which wraps + line="9815">#GTlsConnection is the base TLS connection class type, which wraps a #GIOStream and provides TLS encryption on top of it. Its subclasses, #GTlsClientConnection and #GTlsServerConnection, implement client-side and server-side TLS, respectively. For DTLS (Datagram TLS) support, see #GDtlsConnection. - + - + @@ -112798,7 +115024,7 @@ For DTLS (Datagram TLS) support, see #GDtlsConnection. - + @@ -112817,13 +115043,41 @@ For DTLS (Datagram TLS) support, see #GDtlsConnection. + + Gets the name of the application-layer protocol negotiated during +the handshake. + +If the peer did not use the ALPN extension, or did not advertise a +protocol that matched one of @conn's protocols, or the TLS backend +does not support ALPN, then this will be %NULL. See +g_tls_connection_set_advertised_protocols(). + + + the negotiated protocol, or %NULL + + + + + a #GTlsConnection + + + + Attempts a TLS handshake on @conn. + line="40338">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -112854,18 +115108,18 @@ function manually is not recommended. #GTlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + line="40376">success or failure a #GTlsConnection + line="40340">a #GTlsConnection allow-none="1"> a #GCancellable, or %NULL + line="40341">a #GCancellable, or %NULL @@ -112884,9 +115138,9 @@ handshake. version="2.28"> Asynchronously performs a TLS handshake on @conn. See + line="40381">Asynchronously performs a TLS handshake on @conn. See g_tls_connection_handshake() for more information. - + @@ -112894,13 +115148,13 @@ g_tls_connection_handshake() for more information. a #GTlsConnection + line="40383">a #GTlsConnection the [I/O priority][io-priority] of the request + line="40384">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="40385">a #GCancellable, or %NULL closure="3"> callback to call when the handshake is complete + line="40386">callback to call when the handshake is complete closure="3"> the data to pass to the callback function + line="40387">the data to pass to the callback function @@ -112941,13 +115195,13 @@ g_tls_connection_handshake() for more information. throws="1"> Finish an asynchronous TLS handshake operation. See + line="40396">Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + line="40405">%TRUE on success, %FALSE on failure, in which case @error will be set. @@ -112955,13 +115209,13 @@ case @error will be set. a #GTlsConnection + line="40398">a #GTlsConnection a #GAsyncResult. + line="40399">a #GAsyncResult. @@ -112971,13 +115225,13 @@ case @error will be set. version="2.28"> Used by #GTlsConnection implementations to emit the + line="40143">Used by #GTlsConnection implementations to emit the #GTlsConnection::accept-certificate signal. - + %TRUE if one of the signal handlers has returned + line="40152">%TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert @@ -112985,42 +115239,43 @@ case @error will be set. a #GTlsConnection + line="40145">a #GTlsConnection the peer's #GTlsCertificate + line="40146">the peer's #GTlsCertificate the problems with @peer_cert + line="40147">the problems with @peer_cert Gets @conn's certificate, as set by + line="40158">Gets @conn's certificate, as set by g_tls_connection_set_certificate(). - + @conn's certificate, or %NULL + line="40165">@conn's certificate, or %NULL a #GTlsConnection + line="40160">a #GTlsConnection @@ -113031,7 +115286,7 @@ g_tls_connection_set_certificate(). throws="1"> Query the TLS backend for TLS channel binding data of @type for @conn. + line="40170">Query the TLS backend for TLS channel binding data of @type for @conn. This call retrieves TLS channel binding data as specified in RFC [5056](https://tools.ietf.org/html/rfc5056), RFC @@ -113044,24 +115299,24 @@ is supported by the TLS backend). It does not guarantee that the data will be available though. That could happen if TLS connection does not support @type or the binding data is not available yet due to additional negotiation or input required. - + %TRUE on success, %FALSE otherwise + line="40192">%TRUE on success, %FALSE otherwise a #GTlsConnection + line="40172">a #GTlsConnection #GTlsChannelBindingType type of data to fetch + line="40173">#GTlsChannelBindingType type of data to fetch @@ -113073,7 +115328,7 @@ negotiation or input required. allow-none="1"> #GByteArray is + line="40174">#GByteArray is filled with the binding data, or %NULL @@ -113081,170 +115336,233 @@ negotiation or input required. + + Returns the name of the current TLS ciphersuite, or %NULL if the +connection has not handshaked or has been closed. Beware that the TLS +backend may use any of multiple different naming conventions, because +OpenSSL and GnuTLS have their own ciphersuite naming conventions that +are different from each other and different from the standard, IANA- +registered ciphersuite names. The ciphersuite name is intended to be +displayed to the user for informative purposes only, and parsing it +is not recommended. + + + The name of the current TLS ciphersuite, or %NULL + + + + + a #GTlsConnection + + + + Gets the certificate database that @conn uses to verify + line="40215">Gets the certificate database that @conn uses to verify peer certificates. See g_tls_connection_set_database(). - + the certificate database that @conn uses or %NULL + line="40222">the certificate database that @conn uses or %NULL a #GTlsConnection + line="40217">a #GTlsConnection Get the object that will be used to interact with the user. It will be used + line="40227">Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If %NULL is returned, then no user interaction will occur for this connection. - + The interaction object. + line="40235">The interaction object. a connection + line="40229">a connection Gets the name of the application-layer protocol negotiated during + line="40240">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_tls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + line="40252">the negotiated protocol, or %NULL a #GTlsConnection + line="40242">a #GTlsConnection Gets @conn's peer's certificate after the handshake has completed + line="40257">Gets @conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GTlsConnection::accept-certificate.) - + @conn's peer's certificate, or %NULL + line="40265">@conn's peer's certificate, or %NULL a #GTlsConnection + line="40259">a #GTlsConnection Gets the errors associated with validating @conn's peer's + line="40270">Gets the errors associated with validating @conn's peer's certificate, after the handshake has completed or failed. (It is not set during the emission of #GTlsConnection::accept-certificate.) - + @conn's peer's certificate errors + line="40278">@conn's peer's certificate errors a #GTlsConnection + line="40272">a #GTlsConnection + + + + + + Returns the current TLS protocol version, which may be +%G_TLS_PROTOCOL_VERSION_UNKNOWN if the connection has not handshaked, or +has been closed, or if the TLS backend has implemented a protocol version +that is not a recognized #GTlsProtocolVersion. + + + The current TLS protocol version + + + + + a #GTlsConnection Gets @conn rehandshaking mode. See + line="40297">Gets @conn rehandshaking mode. See g_tls_connection_set_rehandshake_mode() for details. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + %G_TLS_REHANDSHAKE_SAFELY + line="40304">%G_TLS_REHANDSHAKE_SAFELY a #GTlsConnection + line="40299">a #GTlsConnection Tests whether or not @conn expects a proper TLS close notification + line="40312">Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_tls_connection_set_require_close_notify() for details. - + %TRUE if @conn requires a proper TLS close + line="40320">%TRUE if @conn requires a proper TLS close notification. @@ -113252,32 +115570,33 @@ notification. a #GTlsConnection + line="40314">a #GTlsConnection Gets whether @conn uses the system certificate database to verify + line="40326">Gets whether @conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Use g_tls_connection_get_database() instead - + whether @conn uses the system certificate database + line="40333">whether @conn uses the system certificate database a #GTlsConnection + line="40328">a #GTlsConnection @@ -113288,7 +115607,7 @@ peer certificates. See g_tls_connection_set_use_system_certdb(). throws="1"> Attempts a TLS handshake on @conn. + line="40338">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -113319,18 +115638,18 @@ function manually is not recommended. #GTlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + line="40376">success or failure a #GTlsConnection + line="40340">a #GTlsConnection allow-none="1"> a #GCancellable, or %NULL + line="40341">a #GCancellable, or %NULL @@ -113349,9 +115668,9 @@ handshake. version="2.28"> Asynchronously performs a TLS handshake on @conn. See + line="40381">Asynchronously performs a TLS handshake on @conn. See g_tls_connection_handshake() for more information. - + @@ -113359,13 +115678,13 @@ g_tls_connection_handshake() for more information. a #GTlsConnection + line="40383">a #GTlsConnection the [I/O priority][io-priority] of the request + line="40384">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="40385">a #GCancellable, or %NULL closure="3"> callback to call when the handshake is complete + line="40386">callback to call when the handshake is complete allow-none="1"> the data to pass to the callback function + line="40387">the data to pass to the callback function @@ -113405,13 +115724,13 @@ g_tls_connection_handshake() for more information. throws="1"> Finish an asynchronous TLS handshake operation. See + line="40396">Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + line="40405">%TRUE on success, %FALSE on failure, in which case @error will be set. @@ -113419,23 +115738,24 @@ case @error will be set. a #GTlsConnection + line="40398">a #GTlsConnection a #GAsyncResult. + line="40399">a #GAsyncResult. Sets the list of application-layer protocols to advertise that the + line="40411">Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -113445,7 +115765,7 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + @@ -113453,7 +115773,7 @@ for a list of registered protocol IDs. a #GTlsConnection + line="40413">a #GTlsConnection allow-none="1"> a %NULL-terminated + line="40414">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -113472,10 +115792,11 @@ for a list of registered protocol IDs. This sets the certificate that @conn will present to its peer + line="40432">This sets the certificate that @conn will present to its peer during the TLS handshake. For a #GTlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. @@ -113493,7 +115814,7 @@ or without a certificate; in that case, if you don't provide a certificate, you can tell that the server requested one by the fact that g_tls_client_connection_get_accepted_cas() will return non-%NULL.) - + @@ -113501,23 +115822,24 @@ non-%NULL.) a #GTlsConnection + line="40434">a #GTlsConnection the certificate to use for @conn + line="40435">the certificate to use for @conn Sets the certificate database that is used to verify peer certificates. + line="40460">Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the @@ -113525,7 +115847,7 @@ peer certificate validation will always set the #GTlsConnection::accept-certificate will always be emitted on client-side connections, unless that bit is not set in #GTlsClientConnection:validation-flags). - + @@ -113533,7 +115855,7 @@ client-side connections, unless that bit is not set in a #GTlsConnection + line="40462">a #GTlsConnection a #GTlsDatabase + line="40463">a #GTlsDatabase Set the object that will be used to interact with the user. It will be used + line="40478">Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. The @interaction argument will normally be a derived subclass of #GTlsInteraction. %NULL can also be provided if no user interaction should occur for this connection. - + @@ -113566,7 +115889,7 @@ should occur for this connection. a connection + line="40480">a connection allow-none="1"> an interaction object, or %NULL + line="40481">an interaction object, or %NULL Since GLib 2.64, changing the rehandshake mode is no longer supported + line="40494">Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + @@ -113602,23 +115926,24 @@ rekey operations. a #GTlsConnection + line="40496">a #GTlsConnection the rehandshaking mode + line="40497">the rehandshaking mode Sets whether or not @conn expects a proper TLS close notification + line="40511">Sets whether or not @conn expects a proper TLS close notification before the connection is closed. If this is %TRUE (the default), then @conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a @@ -113645,7 +115970,7 @@ setting of this property. If you explicitly want to do an unclean close, you can close @conn's #GTlsConnection:base-io-stream rather than closing @conn itself, but note that this may only be done when no other operations are pending on @conn or the base I/O stream. - + @@ -113653,24 +115978,25 @@ operations are pending on @conn or the base I/O stream. a #GTlsConnection + line="40513">a #GTlsConnection whether or not to require close notification + line="40514">whether or not to require close notification Sets whether @conn uses the system certificate database to verify + line="40548">Sets whether @conn uses the system certificate database to verify peer certificates. This is %TRUE by default. If set to %FALSE, then peer certificate validation will always set the %G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning @@ -113678,7 +116004,7 @@ peer certificate validation will always set the client-side connections, unless that bit is not set in #GTlsClientConnection:validation-flags). Use g_tls_connection_set_database() instead - + @@ -113686,13 +116012,13 @@ client-side connections, unless that bit is not set in a #GTlsConnection + line="40550">a #GTlsConnection whether to use the system certificate database + line="40551">whether to use the system certificate database @@ -113700,10 +116026,11 @@ client-side connections, unless that bit is not set in + transfer-ownership="none" + setter="set_advertised_protocols"> The list of application-layer protocols that the connection + line="3961">The list of application-layer protocols that the connection advertises that it is willing to speak. See g_tls_connection_set_advertised_protocols(). @@ -113717,7 +116044,7 @@ g_tls_connection_set_advertised_protocols(). transfer-ownership="none"> The #GIOStream that the connection wraps. The connection holds a reference + line="3972">The #GIOStream that the connection wraps. The connection holds a reference to this stream, and may run operations on the stream from other threads throughout its lifetime. Consequently, after the #GIOStream has been constructed, application code may only run its own operations on this @@ -113727,20 +116054,33 @@ stream when no #GIOStream operations are running. + transfer-ownership="none" + setter="set_certificate" + getter="get_certificate"> The connection's certificate; see + line="3985">The connection's certificate; see g_tls_connection_set_certificate(). + + The name of the TLS ciphersuite in use. See g_tls_connection_get_ciphersuite_name(). + + + transfer-ownership="none" + setter="set_database" + getter="get_database"> The certificate database to use when verifying this TLS connection. + line="4004">The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). @@ -113748,29 +116088,33 @@ used. See g_tls_backend_get_default_database(). + transfer-ownership="none" + setter="set_interaction" + getter="get_interaction"> A #GTlsInteraction object to be used when the connection or certificate + line="4015">A #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. + transfer-ownership="none" + getter="get_negotiated_protocol"> The application-layer protocol negotiated during the TLS + line="4026">The application-layer protocol negotiated during the TLS handshake. See g_tls_connection_get_negotiated_protocol(). + transfer-ownership="none" + getter="get_peer_certificate"> The connection's peer's certificate, after the TLS handshake has + line="4036">The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of #GTlsConnection::accept-certificate. @@ -113780,10 +116124,11 @@ detect when a handshake has occurred.) + transfer-ownership="none" + getter="get_peer_certificate_errors"> The errors noticed while verifying + line="4050">The errors noticed while verifying #GTlsConnection:peer-certificate. Normally this should be 0, but it may not be if #GTlsClientConnection:validation-flags is not %G_TLS_CERTIFICATE_VALIDATE_ALL, or if @@ -113791,16 +116136,27 @@ it may not be if #GTlsClientConnection:validation-flags is not behavior. + + The TLS protocol version in use. See g_tls_connection_get_protocol_version(). + + + transfer-ownership="none" + setter="set_rehandshake_mode" + getter="get_rehandshake_mode"> The rehandshaking mode. See + line="4073">The rehandshaking mode. See g_tls_connection_set_rehandshake_mode(). The rehandshake mode is ignored. @@ -113809,10 +116165,12 @@ g_tls_connection_set_rehandshake_mode(). version="2.28" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_require_close_notify" + getter="get_require_close_notify"> Whether or not proper TLS close notification is required. + line="4084">Whether or not proper TLS close notification is required. See g_tls_connection_set_require_close_notify(). @@ -113821,10 +116179,12 @@ See g_tls_connection_set_require_close_notify(). deprecated-version="2.30" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_use_system_certdb" + getter="get_use_system_certdb"> Whether or not the system certificate database will be used to + line="4094">Whether or not the system certificate database will be used to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Use GTlsConnection:database instead @@ -113839,7 +116199,7 @@ g_tls_connection_set_use_system_certdb(). Emitted during the TLS handshake after the peer certificate has + line="3913">Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. @@ -113875,7 +116235,7 @@ handler until the UI thread returns an answer. %TRUE to accept @peer_cert (which will also + line="3953">%TRUE to accept @peer_cert (which will also immediately end the signal emission). %FALSE to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it. @@ -113885,13 +116245,13 @@ no one else overrides it. the peer's #GTlsCertificate + line="3916">the peer's #GTlsCertificate the problems with @peer_cert. + line="3917">the problems with @peer_cert. @@ -113899,14 +116259,21 @@ no one else overrides it. - + glib:is-gtype-struct-for="TlsConnection" + version="2.28"> + The class structure for the #GTlsConnection type. + + The parent class. - + @@ -113925,18 +116292,18 @@ no one else overrides it. - + success or failure + line="40376">success or failure a #GTlsConnection + line="40340">a #GTlsConnection allow-none="1"> a #GCancellable, or %NULL + line="40341">a #GCancellable, or %NULL @@ -113953,7 +116320,7 @@ no one else overrides it. - + @@ -113961,13 +116328,13 @@ no one else overrides it. a #GTlsConnection + line="40383">a #GTlsConnection the [I/O priority][io-priority] of the request + line="40384">the [I/O priority][io-priority] of the request allow-none="1"> a #GCancellable, or %NULL + line="40385">a #GCancellable, or %NULL closure="4"> callback to call when the handshake is complete + line="40386">callback to call when the handshake is complete closure="4"> the data to pass to the callback function + line="40387">the data to pass to the callback function @@ -114005,11 +116372,11 @@ no one else overrides it. - + %TRUE on success, %FALSE on failure, in which + line="40405">%TRUE on success, %FALSE on failure, in which case @error will be set. @@ -114017,13 +116384,13 @@ case @error will be set. a #GTlsConnection + line="40398">a #GTlsConnection a #GAsyncResult. + line="40399">a #GAsyncResult. @@ -114031,7 +116398,7 @@ case @error will be set. - + @@ -114051,8 +116418,27 @@ case @error will be set. + + + + + the negotiated protocol, or %NULL + + + + + a #GTlsConnection + + + + + - + @@ -114073,7 +116459,7 @@ case @error will be set. glib:type-struct="TlsDatabaseClass"> #GTlsDatabase is used to look up certificates and other information + line="9831">#GTlsDatabase is used to look up certificates and other information from a certificate or key store. It is an abstract base class which TLS library specific subtypes override. @@ -114088,7 +116474,7 @@ Most common client applications will not directly interact with version="2.30"> Create a handle string for the certificate. The database will only be able + line="40565">Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, %NULL will be returned. @@ -114100,7 +116486,7 @@ then it is not guaranteed that this handle will continue to point to it. a newly allocated string containing the + line="40579">a newly allocated string containing the handle. @@ -114108,13 +116494,13 @@ handle. a #GTlsDatabase + line="40567">a #GTlsDatabase certificate for which to create a handle. + line="40568">certificate for which to create a handle. @@ -114125,7 +116511,7 @@ handle. throws="1"> Look up a certificate by its handle. + line="40585">Look up a certificate by its handle. The handle should have been created by calling g_tls_database_create_certificate_handle() on a #GTlsDatabase object of @@ -114141,7 +116527,7 @@ the lookup operation asynchronously. a newly allocated + line="40607">a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -114149,13 +116535,13 @@ the lookup operation asynchronously. a #GTlsDatabase + line="40587">a #GTlsDatabase a certificate handle + line="40588">a certificate handle allow-none="1"> used to interact with the user if necessary + line="40589">used to interact with the user if necessary Flags which affect the lookup. + line="40590">Flags which affect the lookup. @@ -114180,7 +116566,7 @@ the lookup operation asynchronously. allow-none="1"> a #GCancellable, or %NULL + line="40591">a #GCancellable, or %NULL @@ -114190,7 +116576,7 @@ the lookup operation asynchronously. version="2.30"> Asynchronously look up a certificate by its handle in the database. See + line="40613">Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information. @@ -114200,13 +116586,13 @@ g_tls_database_lookup_certificate_for_handle() for more information. a #GTlsDatabase + line="40615">a #GTlsDatabase a certificate handle + line="40616">a certificate handle allow-none="1"> used to interact with the user if necessary + line="40617">used to interact with the user if necessary Flags which affect the lookup. + line="40618">Flags which affect the lookup. @@ -114231,7 +116617,7 @@ g_tls_database_lookup_certificate_for_handle() for more information. allow-none="1"> a #GCancellable, or %NULL + line="40619">a #GCancellable, or %NULL closure="5"> callback to call when the operation completes + line="40620">callback to call when the operation completes closure="5"> the data to pass to the callback function + line="40621">the data to pass to the callback function @@ -114263,7 +116649,7 @@ g_tls_database_lookup_certificate_for_handle() for more information. throws="1"> Finish an asynchronous lookup of a certificate by its handle. See + line="40630">Finish an asynchronous lookup of a certificate by its handle. See g_tls_database_lookup_certificate_for_handle() for more information. If the handle is no longer valid, or does not point to a certificate in @@ -114272,7 +116658,7 @@ this database, then %NULL will be returned. a newly allocated #GTlsCertificate object. + line="40642">a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. @@ -114280,13 +116666,13 @@ Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40632">a #GTlsDatabase a #GAsyncResult. + line="40633">a #GAsyncResult. @@ -114297,19 +116683,31 @@ Use g_object_unref() to release the certificate. throws="1"> Look up the issuer of @certificate in the database. + line="40648">Look up the issuer of @certificate in the database. The +#GTlsCertificate:issuer property of @certificate is not modified, and +the two certificates are not hooked into a chain. -The #GTlsCertificate:issuer property -of @certificate is not modified, and the two certificates are not hooked -into a chain. +This function can block. Use g_tls_database_lookup_certificate_issuer_async() +to perform the lookup operation asynchronously. -This function can block, use g_tls_database_lookup_certificate_issuer_async() to perform -the lookup operation asynchronously. +Beware this function cannot be used to build certification paths. The +issuer certificate returned by this function may not be the same as +the certificate that would actually be used to construct a valid +certification path during certificate verification. +[RFC 4158](https://datatracker.ietf.org/doc/html/rfc4158) explains +why an issuer certificate cannot be naively assumed to be part of the +the certification path (though GLib's TLS backends may not follow the +path building strategies outlined in this RFC). Due to the complexity +of certification path building, GLib does not provide any way to know +which certification path will actually be used when verifying a TLS +certificate. Accordingly, this function cannot be used to make +security-related decisions. Only GLib itself should make security +decisions about TLS certificates. a newly allocated issuer #GTlsCertificate, + line="40678">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -114317,13 +116715,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40650">a #GTlsDatabase a #GTlsCertificate + line="40651">a #GTlsCertificate allow-none="1"> used to interact with the user if necessary + line="40652">used to interact with the user if necessary flags which affect the lookup operation + line="40653">flags which affect the lookup operation @@ -114348,7 +116746,7 @@ or %NULL. Use g_object_unref() to release the certificate. allow-none="1"> a #GCancellable, or %NULL + line="40654">a #GCancellable, or %NULL @@ -114358,7 +116756,7 @@ or %NULL. Use g_object_unref() to release the certificate. version="2.30"> Asynchronously look up the issuer of @certificate in the database. See + line="40684">Asynchronously look up the issuer of @certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information. @@ -114368,13 +116766,13 @@ g_tls_database_lookup_certificate_issuer() for more information. a #GTlsDatabase + line="40686">a #GTlsDatabase a #GTlsCertificate + line="40687">a #GTlsCertificate allow-none="1"> used to interact with the user if necessary + line="40688">used to interact with the user if necessary flags which affect the lookup operation + line="40689">flags which affect the lookup operation @@ -114399,7 +116797,7 @@ g_tls_database_lookup_certificate_issuer() for more information. allow-none="1"> a #GCancellable, or %NULL + line="40690">a #GCancellable, or %NULL closure="5"> callback to call when the operation completes + line="40691">callback to call when the operation completes closure="5"> the data to pass to the callback function + line="40692">the data to pass to the callback function @@ -114431,13 +116829,13 @@ g_tls_database_lookup_certificate_issuer() for more information. throws="1"> Finish an asynchronous lookup issuer operation. See + line="40701">Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. a newly allocated issuer #GTlsCertificate, + line="40710">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -114445,13 +116843,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40703">a #GTlsDatabase a #GAsyncResult. + line="40704">a #GAsyncResult. @@ -114462,7 +116860,7 @@ or %NULL. Use g_object_unref() to release the certificate. throws="1"> Look up certificates issued by this issuer in the database. + line="40716">Look up certificates issued by this issuer in the database. This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. @@ -114470,7 +116868,7 @@ the lookup operation asynchronously. a newly allocated list of #GTlsCertificate + line="40730">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -114480,13 +116878,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40718">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + line="40719">a #GByteArray which holds the DER encoded issuer DN. @@ -114497,13 +116895,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> used to interact with the user if necessary + line="40720">used to interact with the user if necessary Flags which affect the lookup operation. + line="40721">Flags which affect the lookup operation. @@ -114513,7 +116911,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> a #GCancellable, or %NULL + line="40722">a #GCancellable, or %NULL @@ -114523,7 +116921,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele version="2.30"> Asynchronously look up certificates issued by this issuer in the database. See + line="40736">Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information. The database may choose to hold a reference to the issuer byte array for the duration @@ -114537,13 +116935,13 @@ this time. a #GTlsDatabase + line="40738">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + line="40739">a #GByteArray which holds the DER encoded issuer DN. @@ -114554,13 +116952,13 @@ this time. allow-none="1"> used to interact with the user if necessary + line="40740">used to interact with the user if necessary Flags which affect the lookup operation. + line="40741">Flags which affect the lookup operation. @@ -114570,7 +116968,7 @@ this time. allow-none="1"> a #GCancellable, or %NULL + line="40742">a #GCancellable, or %NULL closure="5"> callback to call when the operation completes + line="40743">callback to call when the operation completes closure="5"> the data to pass to the callback function + line="40744">the data to pass to the callback function @@ -114602,13 +117000,13 @@ this time. throws="1"> Finish an asynchronous lookup of certificates. See + line="40757">Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. a newly allocated list of #GTlsCertificate + line="40766">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -114618,13 +117016,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40759">a #GTlsDatabase a #GAsyncResult. + line="40760">a #GAsyncResult. @@ -114635,15 +117033,11 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele throws="1"> Determines the validity of a certificate chain after looking up and -adding any missing certificates to the chain. + line="40772">Determines the validity of a certificate chain, outside the context +of a TLS session. @chain is a chain of #GTlsCertificate objects each pointing to the next -certificate in the chain by its #GTlsCertificate:issuer property. The chain may initially -consist of one or more certificates. After the verification process is -complete, @chain may be modified by adding missing certificates, or removing -extra certificates. If a certificate anchor was found, then it is added to -the @chain. +certificate in the chain by its #GTlsCertificate:issuer property. @purpose describes the purpose (or usage) for which the certificate is being used. Typically @purpose will be set to #G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER @@ -114670,13 +117064,32 @@ before it completes) then the return value will be accordingly. @error is not set when @chain is successfully analyzed but found to be invalid. -This function can block, use g_tls_database_verify_chain_async() to perform -the verification operation asynchronously. +Prior to GLib 2.48, GLib's default TLS backend modified @chain to +represent the certification path built by #GTlsDatabase during +certificate verification by adjusting the #GTlsCertificate:issuer +property of each certificate in @chain. Since GLib 2.48, this no +longer occurs, so you cannot rely on #GTlsCertificate:issuer to +represent the actual certification path used during certificate +verification. + +Because TLS session context is not used, #GTlsDatabase may not +perform as many checks on the certificates as #GTlsConnection would. +For example, certificate constraints cannot be honored, and some +revocation checks cannot be performed. The best way to verify TLS +certificates used by a TLS connection is to let #GTlsConnection +handle the verification. + +The TLS backend may attempt to look up and add missing certificates +to the chain. Since GLib 2.70, this may involve HTTP requests to +download missing certificates. + +This function can block. Use g_tls_database_verify_chain_async() to +perform the verification operation asynchronously. the appropriate #GTlsCertificateFlags which represents the + line="40836">the appropriate #GTlsCertificateFlags which represents the result of verification. @@ -114684,19 +117097,19 @@ result of verification. a #GTlsDatabase + line="40774">a #GTlsDatabase a #GTlsCertificate chain + line="40775">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + line="40776">the purpose that this certificate chain will be used for. allow-none="1"> the expected peer identity + line="40777">the expected peer identity allow-none="1"> used to interact with the user if necessary + line="40778">used to interact with the user if necessary additional verify flags + line="40779">additional verify flags @@ -114730,7 +117143,7 @@ result of verification. allow-none="1"> a #GCancellable, or %NULL + line="40780">a #GCancellable, or %NULL @@ -114740,7 +117153,7 @@ result of verification. version="2.30"> Asynchronously determines the validity of a certificate chain after + line="40842">Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information. @@ -114751,19 +117164,19 @@ g_tls_database_verify_chain() for more information. a #GTlsDatabase + line="40844">a #GTlsDatabase a #GTlsCertificate chain + line="40845">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + line="40846">the purpose that this certificate chain will be used for. allow-none="1"> the expected peer identity + line="40847">the expected peer identity allow-none="1"> used to interact with the user if necessary + line="40848">used to interact with the user if necessary additional verify flags + line="40849">additional verify flags @@ -114797,7 +117210,7 @@ g_tls_database_verify_chain() for more information. allow-none="1"> a #GCancellable, or %NULL + line="40850">a #GCancellable, or %NULL closure="7"> callback to call when the operation completes + line="40851">callback to call when the operation completes closure="7"> the data to pass to the callback function + line="40852">the data to pass to the callback function @@ -114829,7 +117242,7 @@ g_tls_database_verify_chain() for more information. throws="1"> Finish an asynchronous verify chain operation. See + line="40862">Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information. If @chain is found to be valid, then the return value will be 0. If @@ -114844,7 +117257,7 @@ but found to be invalid. the appropriate #GTlsCertificateFlags which represents the + line="40880">the appropriate #GTlsCertificateFlags which represents the result of verification. @@ -114852,13 +117265,13 @@ result of verification. a #GTlsDatabase + line="40864">a #GTlsDatabase a #GAsyncResult. + line="40865">a #GAsyncResult. @@ -114868,7 +117281,7 @@ result of verification. version="2.30"> Create a handle string for the certificate. The database will only be able + line="40565">Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, %NULL will be returned. @@ -114880,7 +117293,7 @@ then it is not guaranteed that this handle will continue to point to it. a newly allocated string containing the + line="40579">a newly allocated string containing the handle. @@ -114888,13 +117301,13 @@ handle. a #GTlsDatabase + line="40567">a #GTlsDatabase certificate for which to create a handle. + line="40568">certificate for which to create a handle. @@ -114905,7 +117318,7 @@ handle. throws="1"> Look up a certificate by its handle. + line="40585">Look up a certificate by its handle. The handle should have been created by calling g_tls_database_create_certificate_handle() on a #GTlsDatabase object of @@ -114921,7 +117334,7 @@ the lookup operation asynchronously. a newly allocated + line="40607">a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -114929,13 +117342,13 @@ the lookup operation asynchronously. a #GTlsDatabase + line="40587">a #GTlsDatabase a certificate handle + line="40588">a certificate handle allow-none="1"> used to interact with the user if necessary + line="40589">used to interact with the user if necessary Flags which affect the lookup. + line="40590">Flags which affect the lookup. @@ -114960,7 +117373,7 @@ the lookup operation asynchronously. allow-none="1"> a #GCancellable, or %NULL + line="40591">a #GCancellable, or %NULL @@ -114970,7 +117383,7 @@ the lookup operation asynchronously. version="2.30"> Asynchronously look up a certificate by its handle in the database. See + line="40613">Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information. @@ -114980,13 +117393,13 @@ g_tls_database_lookup_certificate_for_handle() for more information. a #GTlsDatabase + line="40615">a #GTlsDatabase a certificate handle + line="40616">a certificate handle allow-none="1"> used to interact with the user if necessary + line="40617">used to interact with the user if necessary Flags which affect the lookup. + line="40618">Flags which affect the lookup. @@ -115011,7 +117424,7 @@ g_tls_database_lookup_certificate_for_handle() for more information. allow-none="1"> a #GCancellable, or %NULL + line="40619">a #GCancellable, or %NULL closure="5"> callback to call when the operation completes + line="40620">callback to call when the operation completes allow-none="1"> the data to pass to the callback function + line="40621">the data to pass to the callback function @@ -115042,7 +117455,7 @@ g_tls_database_lookup_certificate_for_handle() for more information. throws="1"> Finish an asynchronous lookup of a certificate by its handle. See + line="40630">Finish an asynchronous lookup of a certificate by its handle. See g_tls_database_lookup_certificate_for_handle() for more information. If the handle is no longer valid, or does not point to a certificate in @@ -115051,7 +117464,7 @@ this database, then %NULL will be returned. a newly allocated #GTlsCertificate object. + line="40642">a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. @@ -115059,13 +117472,13 @@ Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40632">a #GTlsDatabase a #GAsyncResult. + line="40633">a #GAsyncResult. @@ -115076,19 +117489,31 @@ Use g_object_unref() to release the certificate. throws="1"> Look up the issuer of @certificate in the database. + line="40648">Look up the issuer of @certificate in the database. The +#GTlsCertificate:issuer property of @certificate is not modified, and +the two certificates are not hooked into a chain. -The #GTlsCertificate:issuer property -of @certificate is not modified, and the two certificates are not hooked -into a chain. +This function can block. Use g_tls_database_lookup_certificate_issuer_async() +to perform the lookup operation asynchronously. -This function can block, use g_tls_database_lookup_certificate_issuer_async() to perform -the lookup operation asynchronously. +Beware this function cannot be used to build certification paths. The +issuer certificate returned by this function may not be the same as +the certificate that would actually be used to construct a valid +certification path during certificate verification. +[RFC 4158](https://datatracker.ietf.org/doc/html/rfc4158) explains +why an issuer certificate cannot be naively assumed to be part of the +the certification path (though GLib's TLS backends may not follow the +path building strategies outlined in this RFC). Due to the complexity +of certification path building, GLib does not provide any way to know +which certification path will actually be used when verifying a TLS +certificate. Accordingly, this function cannot be used to make +security-related decisions. Only GLib itself should make security +decisions about TLS certificates. a newly allocated issuer #GTlsCertificate, + line="40678">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -115096,13 +117521,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40650">a #GTlsDatabase a #GTlsCertificate + line="40651">a #GTlsCertificate allow-none="1"> used to interact with the user if necessary + line="40652">used to interact with the user if necessary flags which affect the lookup operation + line="40653">flags which affect the lookup operation @@ -115127,7 +117552,7 @@ or %NULL. Use g_object_unref() to release the certificate. allow-none="1"> a #GCancellable, or %NULL + line="40654">a #GCancellable, or %NULL @@ -115137,7 +117562,7 @@ or %NULL. Use g_object_unref() to release the certificate. version="2.30"> Asynchronously look up the issuer of @certificate in the database. See + line="40684">Asynchronously look up the issuer of @certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information. @@ -115147,13 +117572,13 @@ g_tls_database_lookup_certificate_issuer() for more information. a #GTlsDatabase + line="40686">a #GTlsDatabase a #GTlsCertificate + line="40687">a #GTlsCertificate allow-none="1"> used to interact with the user if necessary + line="40688">used to interact with the user if necessary flags which affect the lookup operation + line="40689">flags which affect the lookup operation @@ -115178,7 +117603,7 @@ g_tls_database_lookup_certificate_issuer() for more information. allow-none="1"> a #GCancellable, or %NULL + line="40690">a #GCancellable, or %NULL closure="5"> callback to call when the operation completes + line="40691">callback to call when the operation completes allow-none="1"> the data to pass to the callback function + line="40692">the data to pass to the callback function @@ -115209,13 +117634,13 @@ g_tls_database_lookup_certificate_issuer() for more information. throws="1"> Finish an asynchronous lookup issuer operation. See + line="40701">Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. a newly allocated issuer #GTlsCertificate, + line="40710">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -115223,13 +117648,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40703">a #GTlsDatabase a #GAsyncResult. + line="40704">a #GAsyncResult. @@ -115240,7 +117665,7 @@ or %NULL. Use g_object_unref() to release the certificate. throws="1"> Look up certificates issued by this issuer in the database. + line="40716">Look up certificates issued by this issuer in the database. This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. @@ -115248,7 +117673,7 @@ the lookup operation asynchronously. a newly allocated list of #GTlsCertificate + line="40730">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -115258,13 +117683,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40718">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + line="40719">a #GByteArray which holds the DER encoded issuer DN. @@ -115275,13 +117700,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> used to interact with the user if necessary + line="40720">used to interact with the user if necessary Flags which affect the lookup operation. + line="40721">Flags which affect the lookup operation. @@ -115291,7 +117716,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> a #GCancellable, or %NULL + line="40722">a #GCancellable, or %NULL @@ -115301,7 +117726,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele version="2.30"> Asynchronously look up certificates issued by this issuer in the database. See + line="40736">Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information. The database may choose to hold a reference to the issuer byte array for the duration @@ -115315,13 +117740,13 @@ this time. a #GTlsDatabase + line="40738">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + line="40739">a #GByteArray which holds the DER encoded issuer DN. @@ -115332,13 +117757,13 @@ this time. allow-none="1"> used to interact with the user if necessary + line="40740">used to interact with the user if necessary Flags which affect the lookup operation. + line="40741">Flags which affect the lookup operation. @@ -115348,7 +117773,7 @@ this time. allow-none="1"> a #GCancellable, or %NULL + line="40742">a #GCancellable, or %NULL closure="5"> callback to call when the operation completes + line="40743">callback to call when the operation completes allow-none="1"> the data to pass to the callback function + line="40744">the data to pass to the callback function @@ -115379,13 +117804,13 @@ this time. throws="1"> Finish an asynchronous lookup of certificates. See + line="40757">Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. a newly allocated list of #GTlsCertificate + line="40766">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -115395,13 +117820,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40759">a #GTlsDatabase a #GAsyncResult. + line="40760">a #GAsyncResult. @@ -115412,15 +117837,11 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele throws="1"> Determines the validity of a certificate chain after looking up and -adding any missing certificates to the chain. + line="40772">Determines the validity of a certificate chain, outside the context +of a TLS session. @chain is a chain of #GTlsCertificate objects each pointing to the next -certificate in the chain by its #GTlsCertificate:issuer property. The chain may initially -consist of one or more certificates. After the verification process is -complete, @chain may be modified by adding missing certificates, or removing -extra certificates. If a certificate anchor was found, then it is added to -the @chain. +certificate in the chain by its #GTlsCertificate:issuer property. @purpose describes the purpose (or usage) for which the certificate is being used. Typically @purpose will be set to #G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER @@ -115447,13 +117868,32 @@ before it completes) then the return value will be accordingly. @error is not set when @chain is successfully analyzed but found to be invalid. -This function can block, use g_tls_database_verify_chain_async() to perform -the verification operation asynchronously. +Prior to GLib 2.48, GLib's default TLS backend modified @chain to +represent the certification path built by #GTlsDatabase during +certificate verification by adjusting the #GTlsCertificate:issuer +property of each certificate in @chain. Since GLib 2.48, this no +longer occurs, so you cannot rely on #GTlsCertificate:issuer to +represent the actual certification path used during certificate +verification. + +Because TLS session context is not used, #GTlsDatabase may not +perform as many checks on the certificates as #GTlsConnection would. +For example, certificate constraints cannot be honored, and some +revocation checks cannot be performed. The best way to verify TLS +certificates used by a TLS connection is to let #GTlsConnection +handle the verification. + +The TLS backend may attempt to look up and add missing certificates +to the chain. Since GLib 2.70, this may involve HTTP requests to +download missing certificates. + +This function can block. Use g_tls_database_verify_chain_async() to +perform the verification operation asynchronously. the appropriate #GTlsCertificateFlags which represents the + line="40836">the appropriate #GTlsCertificateFlags which represents the result of verification. @@ -115461,19 +117901,19 @@ result of verification. a #GTlsDatabase + line="40774">a #GTlsDatabase a #GTlsCertificate chain + line="40775">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + line="40776">the purpose that this certificate chain will be used for. allow-none="1"> the expected peer identity + line="40777">the expected peer identity allow-none="1"> used to interact with the user if necessary + line="40778">used to interact with the user if necessary additional verify flags + line="40779">additional verify flags @@ -115507,7 +117947,7 @@ result of verification. allow-none="1"> a #GCancellable, or %NULL + line="40780">a #GCancellable, or %NULL @@ -115517,7 +117957,7 @@ result of verification. version="2.30"> Asynchronously determines the validity of a certificate chain after + line="40842">Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information. @@ -115528,19 +117968,19 @@ g_tls_database_verify_chain() for more information. a #GTlsDatabase + line="40844">a #GTlsDatabase a #GTlsCertificate chain + line="40845">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + line="40846">the purpose that this certificate chain will be used for. allow-none="1"> the expected peer identity + line="40847">the expected peer identity allow-none="1"> used to interact with the user if necessary + line="40848">used to interact with the user if necessary additional verify flags + line="40849">additional verify flags @@ -115574,7 +118014,7 @@ g_tls_database_verify_chain() for more information. allow-none="1"> a #GCancellable, or %NULL + line="40850">a #GCancellable, or %NULL closure="7"> callback to call when the operation completes + line="40851">callback to call when the operation completes allow-none="1"> the data to pass to the callback function + line="40852">the data to pass to the callback function @@ -115605,7 +118045,7 @@ g_tls_database_verify_chain() for more information. throws="1"> Finish an asynchronous verify chain operation. See + line="40862">Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information. If @chain is found to be valid, then the return value will be 0. If @@ -115620,7 +118060,7 @@ but found to be invalid. the appropriate #GTlsCertificateFlags which represents the + line="40880">the appropriate #GTlsCertificateFlags which represents the result of verification. @@ -115628,13 +118068,13 @@ result of verification. a #GTlsDatabase + line="40864">a #GTlsDatabase a #GAsyncResult. + line="40865">a #GAsyncResult. @@ -115652,7 +118092,7 @@ result of verification. version="2.30"> The class for #GTlsDatabase. Derived classes should implement the various + line="4114">The class for #GTlsDatabase. Derived classes should implement the various virtual methods. _async and _finish methods have a default implementation that runs the corresponding sync method in a thread. @@ -115665,7 +118105,7 @@ implementation that runs the corresponding sync method in a thread. the appropriate #GTlsCertificateFlags which represents the + line="40836">the appropriate #GTlsCertificateFlags which represents the result of verification. @@ -115673,19 +118113,19 @@ result of verification. a #GTlsDatabase + line="40774">a #GTlsDatabase a #GTlsCertificate chain + line="40775">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + line="40776">the purpose that this certificate chain will be used for. allow-none="1"> the expected peer identity + line="40777">the expected peer identity allow-none="1"> used to interact with the user if necessary + line="40778">used to interact with the user if necessary additional verify flags + line="40779">additional verify flags @@ -115719,7 +118159,7 @@ result of verification. allow-none="1"> a #GCancellable, or %NULL + line="40780">a #GCancellable, or %NULL @@ -115735,19 +118175,19 @@ result of verification. a #GTlsDatabase + line="40844">a #GTlsDatabase a #GTlsCertificate chain + line="40845">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + line="40846">the purpose that this certificate chain will be used for. allow-none="1"> the expected peer identity + line="40847">the expected peer identity allow-none="1"> used to interact with the user if necessary + line="40848">used to interact with the user if necessary additional verify flags + line="40849">additional verify flags @@ -115781,7 +118221,7 @@ result of verification. allow-none="1"> a #GCancellable, or %NULL + line="40850">a #GCancellable, or %NULL closure="8"> callback to call when the operation completes + line="40851">callback to call when the operation completes closure="8"> the data to pass to the callback function + line="40852">the data to pass to the callback function @@ -115814,7 +118254,7 @@ result of verification. the appropriate #GTlsCertificateFlags which represents the + line="40880">the appropriate #GTlsCertificateFlags which represents the result of verification. @@ -115822,13 +118262,13 @@ result of verification. a #GTlsDatabase + line="40864">a #GTlsDatabase a #GAsyncResult. + line="40865">a #GAsyncResult. @@ -115840,7 +118280,7 @@ result of verification. a newly allocated string containing the + line="40579">a newly allocated string containing the handle. @@ -115848,13 +118288,13 @@ handle. a #GTlsDatabase + line="40567">a #GTlsDatabase certificate for which to create a handle. + line="40568">certificate for which to create a handle. @@ -115866,7 +118306,7 @@ handle. a newly allocated + line="40607">a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -115874,13 +118314,13 @@ handle. a #GTlsDatabase + line="40587">a #GTlsDatabase a certificate handle + line="40588">a certificate handle allow-none="1"> used to interact with the user if necessary + line="40589">used to interact with the user if necessary Flags which affect the lookup. + line="40590">Flags which affect the lookup. @@ -115905,7 +118345,7 @@ handle. allow-none="1"> a #GCancellable, or %NULL + line="40591">a #GCancellable, or %NULL @@ -115921,13 +118361,13 @@ handle. a #GTlsDatabase + line="40615">a #GTlsDatabase a certificate handle + line="40616">a certificate handle allow-none="1"> used to interact with the user if necessary + line="40617">used to interact with the user if necessary Flags which affect the lookup. + line="40618">Flags which affect the lookup. @@ -115952,7 +118392,7 @@ handle. allow-none="1"> a #GCancellable, or %NULL + line="40619">a #GCancellable, or %NULL closure="6"> callback to call when the operation completes + line="40620">callback to call when the operation completes closure="6"> the data to pass to the callback function + line="40621">the data to pass to the callback function @@ -115985,7 +118425,7 @@ handle. a newly allocated #GTlsCertificate object. + line="40642">a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. @@ -115993,13 +118433,13 @@ Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40632">a #GTlsDatabase a #GAsyncResult. + line="40633">a #GAsyncResult. @@ -116011,7 +118451,7 @@ Use g_object_unref() to release the certificate. a newly allocated issuer #GTlsCertificate, + line="40678">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -116019,13 +118459,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40650">a #GTlsDatabase a #GTlsCertificate + line="40651">a #GTlsCertificate allow-none="1"> used to interact with the user if necessary + line="40652">used to interact with the user if necessary flags which affect the lookup operation + line="40653">flags which affect the lookup operation @@ -116050,7 +118490,7 @@ or %NULL. Use g_object_unref() to release the certificate. allow-none="1"> a #GCancellable, or %NULL + line="40654">a #GCancellable, or %NULL @@ -116066,13 +118506,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40686">a #GTlsDatabase a #GTlsCertificate + line="40687">a #GTlsCertificate allow-none="1"> used to interact with the user if necessary + line="40688">used to interact with the user if necessary flags which affect the lookup operation + line="40689">flags which affect the lookup operation @@ -116097,7 +118537,7 @@ or %NULL. Use g_object_unref() to release the certificate. allow-none="1"> a #GCancellable, or %NULL + line="40690">a #GCancellable, or %NULL closure="6"> callback to call when the operation completes + line="40691">callback to call when the operation completes closure="6"> the data to pass to the callback function + line="40692">the data to pass to the callback function @@ -116130,7 +118570,7 @@ or %NULL. Use g_object_unref() to release the certificate. a newly allocated issuer #GTlsCertificate, + line="40710">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. @@ -116138,13 +118578,13 @@ or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + line="40703">a #GTlsDatabase a #GAsyncResult. + line="40704">a #GAsyncResult. @@ -116156,7 +118596,7 @@ or %NULL. Use g_object_unref() to release the certificate. a newly allocated list of #GTlsCertificate + line="40730">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -116166,13 +118606,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40718">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + line="40719">a #GByteArray which holds the DER encoded issuer DN. @@ -116183,13 +118623,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> used to interact with the user if necessary + line="40720">used to interact with the user if necessary Flags which affect the lookup operation. + line="40721">Flags which affect the lookup operation. @@ -116199,7 +118639,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> a #GCancellable, or %NULL + line="40722">a #GCancellable, or %NULL @@ -116215,13 +118655,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40738">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + line="40739">a #GByteArray which holds the DER encoded issuer DN. @@ -116232,13 +118672,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> used to interact with the user if necessary + line="40740">used to interact with the user if necessary Flags which affect the lookup operation. + line="40741">Flags which affect the lookup operation. @@ -116248,7 +118688,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele allow-none="1"> a #GCancellable, or %NULL + line="40742">a #GCancellable, or %NULL callback to call when the operation completes + line="40743">callback to call when the operation completes the data to pass to the callback function + line="40744">the data to pass to the callback function @@ -116281,7 +118721,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a newly allocated list of #GTlsCertificate + line="40766">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -116291,13 +118731,13 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + line="40759">a #GTlsDatabase a #GAsyncResult. + line="40760">a #GAsyncResult. @@ -116316,24 +118756,26 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele c:type="GTlsDatabaseLookupFlags"> Flags for g_tls_database_lookup_certificate_for_handle(), + line="1797">Flags for g_tls_database_lookup_certificate_for_handle(), g_tls_database_lookup_certificate_issuer(), and g_tls_database_lookup_certificates_issued_by(). + glib:nick="none" + glib:name="G_TLS_DATABASE_LOOKUP_NONE"> No lookup flags + line="1799">No lookup flags + glib:nick="keypair" + glib:name="G_TLS_DATABASE_LOOKUP_KEYPAIR"> Restrict lookup to certificates that have + line="1800">Restrict lookup to certificates that have a private key. @@ -116349,14 +118791,15 @@ and g_tls_database_lookup_certificates_issued_by(). c:type="GTlsDatabaseVerifyFlags"> Flags for g_tls_database_verify_chain(). + line="1785">Flags for g_tls_database_verify_chain(). + glib:nick="none" + glib:name="G_TLS_DATABASE_VERIFY_NONE"> No verification flags + line="1787">No verification flags glib:error-domain="g-tls-error-quark"> An error code used with %G_TLS_ERROR in a #GError returned from a + line="1532">An error code used with %G_TLS_ERROR in a #GError returned from a TLS-related routine. + glib:nick="unavailable" + glib:name="G_TLS_ERROR_UNAVAILABLE"> No TLS provider is available + line="1534">No TLS provider is available + glib:nick="misc" + glib:name="G_TLS_ERROR_MISC"> Miscellaneous TLS error + line="1535">Miscellaneous TLS error + glib:nick="bad-certificate" + glib:name="G_TLS_ERROR_BAD_CERTIFICATE"> The certificate presented could not + line="1536">The certificate presented could not be parsed or failed validation. + glib:nick="not-tls" + glib:name="G_TLS_ERROR_NOT_TLS"> The TLS handshake failed because the + line="1538">The TLS handshake failed because the peer does not seem to be a TLS server. + glib:nick="handshake" + glib:name="G_TLS_ERROR_HANDSHAKE"> The TLS handshake failed because the + line="1540">The TLS handshake failed because the peer's certificate was not acceptable. + glib:nick="certificate-required" + glib:name="G_TLS_ERROR_CERTIFICATE_REQUIRED"> The TLS handshake failed because + line="1542">The TLS handshake failed because the server requested a client-side certificate, but none was provided. See g_tls_connection_set_certificate(). + glib:nick="eof" + glib:name="G_TLS_ERROR_EOF"> The TLS connection was closed without proper + line="1545">The TLS connection was closed without proper notice, which may indicate an attack. See g_tls_connection_set_require_close_notify(). + glib:nick="inappropriate-fallback" + glib:name="G_TLS_ERROR_INAPPROPRIATE_FALLBACK"> The TLS handshake failed + line="1548">The TLS handshake failed because the client sent the fallback SCSV, indicating a protocol downgrade attack. Since: 2.60 Gets the TLS error quark. + line="40886">Gets the TLS error quark. a #GQuark. + line="40891">a #GQuark. @@ -116463,7 +118914,7 @@ TLS-related routine. glib:type-struct="TlsFileDatabaseInterface"> #GTlsFileDatabase is implemented by #GTlsDatabase objects which load + line="9850">#GTlsFileDatabase is implemented by #GTlsDatabase objects which load their certificate information from a file. It is an interface which TLS library specific subtypes implement. @@ -116474,7 +118925,7 @@ TLS library specific subtypes implement. throws="1"> Creates a new #GTlsFileDatabase which uses anchor certificate authorities + line="40896">Creates a new #GTlsFileDatabase which uses anchor certificate authorities in @anchors to verify certificate chains. The certificates in @anchors must be PEM encoded. @@ -116482,7 +118933,7 @@ The certificates in @anchors must be PEM encoded. the new + line="40906">the new #GTlsFileDatabase, or %NULL on error @@ -116490,7 +118941,7 @@ The certificates in @anchors must be PEM encoded. filename of anchor certificate authorities. + line="40898">filename of anchor certificate authorities. @@ -116502,7 +118953,7 @@ The certificates in @anchors must be PEM encoded. transfer-ownership="none"> The path to a file containing PEM encoded certificate authority + line="4161">The path to a file containing PEM encoded certificate authority root anchors. The certificates in this file will be treated as root authorities for the purpose of verifying other certificates via the g_tls_database_verify_chain() operation. @@ -116538,7 +118989,7 @@ via the g_tls_database_verify_chain() operation. glib:type-struct="TlsInteractionClass"> #GTlsInteraction provides a mechanism for the TLS connection and database + line="9863">#GTlsInteraction provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords. To use a #GTlsInteraction with a TLS connection use @@ -116565,7 +119016,7 @@ it must also implement the corresponding finish method. throws="1"> Run synchronous interaction to ask the user for a password. In general, + line="40912">Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -116582,20 +119033,20 @@ not support immediate cancellation. The status of the ask password interaction. + line="40933">The status of the ask password interaction. a #GTlsInteraction object + line="40914">a #GTlsInteraction object a #GTlsPassword object + line="40915">a #GTlsPassword object allow-none="1"> an optional #GCancellable cancellation object + line="40916">an optional #GCancellable cancellation object @@ -116614,7 +119065,7 @@ not support immediate cancellation. version="2.30"> Run asynchronous interaction to ask the user for a password. In general, + line="40938">Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -116637,13 +119088,13 @@ Certain implementations may not support immediate cancellation. a #GTlsInteraction object + line="40940">a #GTlsInteraction object a #GTlsPassword object + line="40941">a #GTlsPassword object allow-none="1"> an optional #GCancellable cancellation object + line="40942">an optional #GCancellable cancellation object closure="3"> will be called when the interaction completes + line="40943">will be called when the interaction completes closure="3"> data to pass to the @callback + line="40944">data to pass to the @callback @@ -116684,7 +119135,7 @@ Certain implementations may not support immediate cancellation. throws="1"> Complete an ask password user interaction request. This should be once + line="40966">Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed @@ -116697,20 +119148,20 @@ contains a %G_IO_ERROR_CANCELLED error code. The status of the ask password interaction. + line="40982">The status of the ask password interaction. a #GTlsInteraction object + line="40968">a #GTlsInteraction object the result passed to the callback + line="40969">the result passed to the callback @@ -116721,7 +119172,7 @@ contains a %G_IO_ERROR_CANCELLED error code. throws="1"> Run synchronous interaction to ask the user to choose a certificate to use + line="41053">Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -116741,26 +119192,26 @@ not support immediate cancellation. The status of the request certificate interaction. + line="41078">The status of the request certificate interaction. a #GTlsInteraction object + line="41055">a #GTlsInteraction object a #GTlsConnection object + line="41056">a #GTlsConnection object flags providing more information about the request + line="41057">flags providing more information about the request @@ -116770,7 +119221,7 @@ not support immediate cancellation. allow-none="1"> an optional #GCancellable cancellation object + line="41058">an optional #GCancellable cancellation object @@ -116780,7 +119231,7 @@ not support immediate cancellation. version="2.40"> Run asynchronous interaction to ask the user for a certificate to use with + line="41083">Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -116796,19 +119247,19 @@ request, which will usually abort the TLS connection. a #GTlsInteraction object + line="41085">a #GTlsInteraction object a #GTlsConnection object + line="41086">a #GTlsConnection object flags providing more information about the request + line="41087">flags providing more information about the request @@ -116818,7 +119269,7 @@ request, which will usually abort the TLS connection. allow-none="1"> an optional #GCancellable cancellation object + line="41088">an optional #GCancellable cancellation object closure="4"> will be called when the interaction completes + line="41089">will be called when the interaction completes closure="4"> data to pass to the @callback + line="41090">data to pass to the @callback @@ -116850,7 +119301,7 @@ request, which will usually abort the TLS connection. throws="1"> Complete a request certificate user interaction request. This should be once + line="41105">Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsConnection @@ -116864,20 +119315,20 @@ contains a %G_IO_ERROR_CANCELLED error code. The status of the request certificate interaction. + line="41122">The status of the request certificate interaction. a #GTlsInteraction object + line="41107">a #GTlsInteraction object the result passed to the callback + line="41108">the result passed to the callback @@ -116888,7 +119339,7 @@ contains a %G_IO_ERROR_CANCELLED error code. throws="1"> Run synchronous interaction to ask the user for a password. In general, + line="40912">Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -116905,20 +119356,20 @@ not support immediate cancellation. The status of the ask password interaction. + line="40933">The status of the ask password interaction. a #GTlsInteraction object + line="40914">a #GTlsInteraction object a #GTlsPassword object + line="40915">a #GTlsPassword object allow-none="1"> an optional #GCancellable cancellation object + line="40916">an optional #GCancellable cancellation object @@ -116937,7 +119388,7 @@ not support immediate cancellation. version="2.30"> Run asynchronous interaction to ask the user for a password. In general, + line="40938">Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -116960,13 +119411,13 @@ Certain implementations may not support immediate cancellation. a #GTlsInteraction object + line="40940">a #GTlsInteraction object a #GTlsPassword object + line="40941">a #GTlsPassword object allow-none="1"> an optional #GCancellable cancellation object + line="40942">an optional #GCancellable cancellation object closure="3"> will be called when the interaction completes + line="40943">will be called when the interaction completes allow-none="1"> data to pass to the @callback + line="40944">data to pass to the @callback @@ -117006,7 +119457,7 @@ Certain implementations may not support immediate cancellation. throws="1"> Complete an ask password user interaction request. This should be once + line="40966">Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed @@ -117019,20 +119470,20 @@ contains a %G_IO_ERROR_CANCELLED error code. The status of the ask password interaction. + line="40982">The status of the ask password interaction. a #GTlsInteraction object + line="40968">a #GTlsInteraction object the result passed to the callback + line="40969">the result passed to the callback @@ -117043,7 +119494,7 @@ contains a %G_IO_ERROR_CANCELLED error code. throws="1"> Invoke the interaction to ask the user for a password. It invokes this + line="40987">Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the #GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by #GTlsConnection or #GTlsDatabase to ask the user @@ -117066,20 +119517,20 @@ not support immediate cancellation. The status of the ask password interaction. + line="41014">The status of the ask password interaction. a #GTlsInteraction object + line="40989">a #GTlsInteraction object a #GTlsPassword object + line="40990">a #GTlsPassword object allow-none="1"> an optional #GCancellable cancellation object + line="40991">an optional #GCancellable cancellation object @@ -117099,7 +119550,7 @@ not support immediate cancellation. throws="1"> Invoke the interaction to ask the user to choose a certificate to + line="41019">Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the #GMainContext returned by g_main_context_get_thread_default() when the interaction is @@ -117123,26 +119574,26 @@ not support immediate cancellation. The status of the certificate request interaction. + line="41048">The status of the certificate request interaction. a #GTlsInteraction object + line="41021">a #GTlsInteraction object a #GTlsConnection object + line="41022">a #GTlsConnection object flags providing more information about the request + line="41023">flags providing more information about the request @@ -117152,7 +119603,7 @@ not support immediate cancellation. allow-none="1"> an optional #GCancellable cancellation object + line="41024">an optional #GCancellable cancellation object @@ -117163,7 +119614,7 @@ not support immediate cancellation. throws="1"> Run synchronous interaction to ask the user to choose a certificate to use + line="41053">Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -117183,26 +119634,26 @@ not support immediate cancellation. The status of the request certificate interaction. + line="41078">The status of the request certificate interaction. a #GTlsInteraction object + line="41055">a #GTlsInteraction object a #GTlsConnection object + line="41056">a #GTlsConnection object flags providing more information about the request + line="41057">flags providing more information about the request @@ -117212,7 +119663,7 @@ not support immediate cancellation. allow-none="1"> an optional #GCancellable cancellation object + line="41058">an optional #GCancellable cancellation object @@ -117222,7 +119673,7 @@ not support immediate cancellation. version="2.40"> Run asynchronous interaction to ask the user for a certificate to use with + line="41083">Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -117238,19 +119689,19 @@ request, which will usually abort the TLS connection. a #GTlsInteraction object + line="41085">a #GTlsInteraction object a #GTlsConnection object + line="41086">a #GTlsConnection object flags providing more information about the request + line="41087">flags providing more information about the request @@ -117260,7 +119711,7 @@ request, which will usually abort the TLS connection. allow-none="1"> an optional #GCancellable cancellation object + line="41088">an optional #GCancellable cancellation object closure="4"> will be called when the interaction completes + line="41089">will be called when the interaction completes allow-none="1"> data to pass to the @callback + line="41090">data to pass to the @callback @@ -117291,7 +119742,7 @@ request, which will usually abort the TLS connection. throws="1"> Complete a request certificate user interaction request. This should be once + line="41105">Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsConnection @@ -117305,20 +119756,20 @@ contains a %G_IO_ERROR_CANCELLED error code. The status of the request certificate interaction. + line="41122">The status of the request certificate interaction. a #GTlsInteraction object + line="41107">a #GTlsInteraction object the result passed to the callback + line="41108">the result passed to the callback @@ -117336,7 +119787,7 @@ contains a %G_IO_ERROR_CANCELLED error code. version="2.30"> The class for #GTlsInteraction. Derived classes implement the various + line="4183">The class for #GTlsInteraction. Derived classes implement the various virtual interaction methods to handle TLS interactions. Derived classes can choose to implement whichever interactions methods they'd @@ -117360,20 +119811,20 @@ If the user cancels an interaction, then the result should be The status of the ask password interaction. + line="40933">The status of the ask password interaction. a #GTlsInteraction object + line="40914">a #GTlsInteraction object a #GTlsPassword object + line="40915">a #GTlsPassword object an optional #GCancellable cancellation object + line="40916">an optional #GCancellable cancellation object @@ -117398,13 +119849,13 @@ If the user cancels an interaction, then the result should be a #GTlsInteraction object + line="40940">a #GTlsInteraction object a #GTlsPassword object + line="40941">a #GTlsPassword object an optional #GCancellable cancellation object + line="40942">an optional #GCancellable cancellation object will be called when the interaction completes + line="40943">will be called when the interaction completes data to pass to the @callback + line="40944">data to pass to the @callback @@ -117446,20 +119897,20 @@ If the user cancels an interaction, then the result should be The status of the ask password interaction. + line="40982">The status of the ask password interaction. a #GTlsInteraction object + line="40968">a #GTlsInteraction object the result passed to the callback + line="40969">the result passed to the callback @@ -117471,26 +119922,26 @@ If the user cancels an interaction, then the result should be The status of the request certificate interaction. + line="41078">The status of the request certificate interaction. a #GTlsInteraction object + line="41055">a #GTlsInteraction object a #GTlsConnection object + line="41056">a #GTlsConnection object flags providing more information about the request + line="41057">flags providing more information about the request @@ -117500,7 +119951,7 @@ If the user cancels an interaction, then the result should be allow-none="1"> an optional #GCancellable cancellation object + line="41058">an optional #GCancellable cancellation object @@ -117516,19 +119967,19 @@ If the user cancels an interaction, then the result should be a #GTlsInteraction object + line="41085">a #GTlsInteraction object a #GTlsConnection object + line="41086">a #GTlsConnection object flags providing more information about the request + line="41087">flags providing more information about the request @@ -117538,7 +119989,7 @@ If the user cancels an interaction, then the result should be allow-none="1"> an optional #GCancellable cancellation object + line="41088">an optional #GCancellable cancellation object will be called when the interaction completes + line="41089">will be called when the interaction completes data to pass to the @callback + line="41090">data to pass to the @callback @@ -117571,20 +120022,20 @@ If the user cancels an interaction, then the result should be The status of the request certificate interaction. + line="41122">The status of the request certificate interaction. a #GTlsInteraction object + line="41107">a #GTlsInteraction object the result passed to the callback + line="41108">the result passed to the callback @@ -117608,33 +120059,36 @@ If the user cancels an interaction, then the result should be c:type="GTlsInteractionResult"> #GTlsInteractionResult is returned by various functions in #GTlsInteraction + line="1729">#GTlsInteractionResult is returned by various functions in #GTlsInteraction when finishing an interaction request. + glib:nick="unhandled" + glib:name="G_TLS_INTERACTION_UNHANDLED"> The interaction was unhandled (i.e. not + line="1731">The interaction was unhandled (i.e. not implemented). + glib:nick="handled" + glib:name="G_TLS_INTERACTION_HANDLED"> The interaction completed, and resulting data + line="1733">The interaction completed, and resulting data is available. + glib:nick="failed" + glib:name="G_TLS_INTERACTION_FAILED"> The interaction has failed, or was cancelled. + line="1735">The interaction has failed, or was cancelled. and the operation should be aborted. @@ -117648,30 +120102,30 @@ when finishing an interaction request. glib:type-struct="TlsPasswordClass"> Holds a password used in TLS. + line="9891">Holds a password used in TLS. Create a new #GTlsPassword object. + line="41178">Create a new #GTlsPassword object. The newly allocated password object + line="41185">The newly allocated password object the password flags + line="41180">the password flags description of what the password is for + line="41181">description of what the password is for @@ -117690,7 +120144,7 @@ when finishing an interaction request. Get the password value. If @length is not %NULL then it will be + line="41149">Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a @@ -117699,23 +120153,25 @@ certain fixed length.) The password value (owned by the password object). - + line="41160">The password value (owned by the password object). + + + a #GTlsPassword object + line="41151">a #GTlsPassword object + direction="out" + caller-allocates="0" + transfer-ownership="full"> location to place the length of the password. + line="41152">location to place the length of the password. @@ -117723,7 +120179,7 @@ certain fixed length.) Provide the value for this password. + line="41229">Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. @@ -117740,13 +120196,13 @@ considered part of the password in this case.) a #GTlsPassword object + line="41231">a #GTlsPassword object the value for the password + line="41232">the value for the password @@ -117754,7 +120210,7 @@ considered part of the password in this case.) the length of the password, or -1 + line="41233">the length of the password, or -1 scope="async"> a function to use to free the password. + line="41234">a function to use to free the password. Get a description string about what the password will be used for. + line="41127">Get a description string about what the password will be used for. The description of the password. + line="41133">The description of the password. a #GTlsPassword object + line="41129">a #GTlsPassword object Get flags about the password. + line="41138">Get flags about the password. The flags about the password. + line="41144">The flags about the password. a #GTlsPassword object + line="41140">a #GTlsPassword object @@ -117818,7 +120276,7 @@ considered part of the password in this case.) version="2.30"> Get the password value. If @length is not %NULL then it will be + line="41149">Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a @@ -117827,57 +120285,61 @@ certain fixed length.) The password value (owned by the password object). - + line="41160">The password value (owned by the password object). + + + a #GTlsPassword object + line="41151">a #GTlsPassword object + direction="out" + caller-allocates="0" + transfer-ownership="full"> location to place the length of the password. + line="41152">location to place the length of the password. Get a user readable translated warning. Usually this warning is a + line="41165">Get a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags(). The warning. + line="41173">The warning. a #GTlsPassword object + line="41167">a #GTlsPassword object Set a description string about what the password will be used for. + line="41189">Set a description string about what the password will be used for. @@ -117886,23 +120348,24 @@ g_tls_password_get_flags(). a #GTlsPassword object + line="41191">a #GTlsPassword object The description of the password + line="41192">The description of the password Set flags about the password. + line="41200">Set flags about the password. @@ -117911,13 +120374,13 @@ g_tls_password_get_flags(). a #GTlsPassword object + line="41202">a #GTlsPassword object The flags about the password + line="41203">The flags about the password @@ -117927,7 +120390,7 @@ g_tls_password_get_flags(). version="2.30"> Set the value for this password. The @value will be copied by the password + line="41211">Set the value for this password. The @value will be copied by the password object. Specify the @length, for a non-nul-terminated password. Pass -1 as @@ -117942,13 +120405,13 @@ considered part of the password in this case.) a #GTlsPassword object + line="41213">a #GTlsPassword object the new password value + line="41214">the new password value @@ -117956,7 +120419,7 @@ considered part of the password in this case.) the length of the password, or -1 + line="41215">the length of the password, or -1 @@ -117966,7 +120429,7 @@ considered part of the password in this case.) version="2.30"> Provide the value for this password. + line="41229">Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. @@ -117983,13 +120446,13 @@ considered part of the password in this case.) a #GTlsPassword object + line="41231">a #GTlsPassword object the value for the password + line="41232">the value for the password @@ -117997,7 +120460,7 @@ considered part of the password in this case.) the length of the password, or -1 + line="41233">the length of the password, or -1 scope="async"> a function to use to free the password. + line="41234">a function to use to free the password. Set a user readable translated warning. Usually this warning is a + line="41250">Set a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags(). @@ -118028,24 +120492,36 @@ g_tls_password_get_flags(). a #GTlsPassword object + line="41252">a #GTlsPassword object The user readable warning + line="41253">The user readable warning - + - + - + @@ -118071,23 +120547,25 @@ g_tls_password_get_flags(). The password value (owned by the password object). - + line="41160">The password value (owned by the password object). + + + a #GTlsPassword object + line="41151">a #GTlsPassword object + direction="out" + caller-allocates="0" + transfer-ownership="full"> location to place the length of the password. + line="41152">location to place the length of the password. @@ -118103,13 +120581,13 @@ g_tls_password_get_flags(). a #GTlsPassword object + line="41231">a #GTlsPassword object the value for the password + line="41232">the value for the password @@ -118117,7 +120595,7 @@ g_tls_password_get_flags(). the length of the password, or -1 + line="41233">the length of the password, or -1 scope="async"> a function to use to free the password. + line="41234">a function to use to free the password. @@ -118159,47 +120637,170 @@ g_tls_password_get_flags(). c:type="GTlsPasswordFlags"> Various flags for the password. + line="1698">Various flags for the password. + glib:nick="none" + glib:name="G_TLS_PASSWORD_NONE"> No flags + line="1700">No flags + glib:nick="retry" + glib:name="G_TLS_PASSWORD_RETRY"> The password was wrong, and the user should retry. + line="1701">The password was wrong, and the user should retry. + glib:nick="many-tries" + glib:name="G_TLS_PASSWORD_MANY_TRIES"> Hint to the user that the password has been + line="1702">Hint to the user that the password has been wrong many times, and the user may not have many chances left. + glib:nick="final-try" + glib:name="G_TLS_PASSWORD_FINAL_TRY"> Hint to the user that this is the last try to get + line="1704">Hint to the user that this is the last try to get this password right. + + For PKCS #11, the user PIN is required. + Since: 2.70. + + + For PKCS #11, the security officer + PIN is required. Since: 2.70. + + + For PKCS #11, the context-specific + PIN is required. Since: 2.70. + + + The TLS or DTLS protocol version used by a #GTlsConnection or +#GDtlsConnection. The integer values of these versions are sequential +to ensure newer known protocol versions compare greater than older +known versions. Any known DTLS protocol version will compare greater +than any SSL or TLS protocol version. The protocol version may be +%G_TLS_PROTOCOL_VERSION_UNKNOWN if the TLS backend supports a newer +protocol version that GLib does not yet know about. This means that +it's possible for an unknown DTLS protocol version to compare less +than the TLS protocol versions. + + No protocol version or unknown protocol version + + + SSL 3.0, which is insecure and should not be used + + + TLS 1.0, which is insecure and should not be used + + + TLS 1.1, which is insecure and should not be used + + + TLS 1.2, defined by [RFC 5246](https://datatracker.ietf.org/doc/html/rfc5246) + + + TLS 1.3, defined by [RFC 8446](https://datatracker.ietf.org/doc/html/rfc8446) + + + DTLS 1.0, which is insecure and should not be used + + + DTLS 1.2, defined by [RFC 6347](https://datatracker.ietf.org/doc/html/rfc6347) + + c:type="GTlsRehandshakeMode"> When to allow rehandshaking. See + line="1677">When to allow rehandshaking. See g_tls_connection_set_rehandshake_mode(). Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed @@ -118217,26 +120818,29 @@ g_tls_connection_set_rehandshake_mode(). + glib:nick="never" + glib:name="G_TLS_REHANDSHAKE_NEVER"> Never allow rehandshaking + line="1679">Never allow rehandshaking + glib:nick="safely" + glib:name="G_TLS_REHANDSHAKE_SAFELY"> Allow safe rehandshaking only + line="1680">Allow safe rehandshaking only + glib:nick="unsafely" + glib:name="G_TLS_REHANDSHAKE_UNSAFELY"> Allow unsafe rehandshaking + line="1681">Allow unsafe rehandshaking glib:type-struct="TlsServerConnectionInterface"> #GTlsServerConnection is the server-side subclass of #GTlsConnection, + line="9901">#GTlsServerConnection is the server-side subclass of #GTlsConnection, representing a server-side TLS connection. @@ -118258,7 +120862,7 @@ representing a server-side TLS connection. throws="1"> Creates a new #GTlsServerConnection wrapping @base_io_stream (which + line="41263">Creates a new #GTlsServerConnection wrapping @base_io_stream (which must have pollable input and output streams). See the documentation for #GTlsConnection:base-io-stream for restrictions @@ -118268,7 +120872,7 @@ this function has returned. the new + line="41276">the new #GTlsServerConnection, or %NULL on error @@ -118276,7 +120880,7 @@ this function has returned. the #GIOStream to wrap + line="41265">the #GIOStream to wrap allow-none="1"> the default server certificate, or %NULL + line="41266">the default server certificate, or %NULL @@ -118296,7 +120900,7 @@ this function has returned. transfer-ownership="none"> The #GTlsAuthenticationMode for the server. This can be changed + line="4233">The #GTlsAuthenticationMode for the server. This can be changed before calling g_tls_connection_handshake() if you want to rehandshake with a different mode from the initial handshake. @@ -118534,7 +121138,7 @@ rehandshake with a different mode from the initial handshake. glib:type-struct="UnixConnectionClass"> This is the subclass of #GSocketConnection that is created + line="9913">This is the subclass of #GSocketConnection that is created for UNIX domain sockets. It contains functions to do some of the UNIX socket specific @@ -118550,7 +121154,7 @@ pkg-config file when using it. throws="1"> Receives credentials from the sending end of the connection. The + line="41282">Receives credentials from the sending end of the connection. The sending end has to call g_unix_connection_send_credentials() (or similar) for this to work. @@ -118572,7 +121176,7 @@ Other ways to exchange credentials with a foreign peer includes the Received credentials on success (free with + line="41307">Received credentials on success (free with g_object_unref()), %NULL if @error is set. @@ -118580,7 +121184,7 @@ g_object_unref()), %NULL if @error is set. A #GUnixConnection. + line="41284">A #GUnixConnection. allow-none="1"> A #GCancellable or %NULL. + line="41285">A #GCancellable or %NULL. @@ -118599,7 +121203,7 @@ g_object_unref()), %NULL if @error is set. version="2.32"> Asynchronously receive credentials. + line="41313">Asynchronously receive credentials. For more details, see g_unix_connection_receive_credentials() which is the synchronous version of this call. @@ -118614,7 +121218,7 @@ g_unix_connection_receive_credentials_finish() to get the result of the operatio A #GUnixConnection. + line="41315">A #GUnixConnection. optional #GCancellable object, %NULL to ignore. + line="41316">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request is satisfied + line="41317">a #GAsyncReadyCallback to call when the request is satisfied the data to pass to callback function + line="41318">the data to pass to callback function @@ -118654,13 +121258,13 @@ g_unix_connection_receive_credentials_finish() to get the result of the operatio throws="1"> Finishes an asynchronous receive credentials operation started with + line="41332">Finishes an asynchronous receive credentials operation started with g_unix_connection_receive_credentials_async(). a #GCredentials, or %NULL on error. + line="41341">a #GCredentials, or %NULL on error. Free the returned object with g_object_unref(). @@ -118668,13 +121272,13 @@ g_unix_connection_receive_credentials_async(). A #GUnixConnection. + line="41334">A #GUnixConnection. a #GAsyncResult. + line="41335">a #GAsyncResult. @@ -118685,7 +121289,7 @@ g_unix_connection_receive_credentials_async(). throws="1"> Receives a file descriptor from the sending end of the connection. + line="41347">Receives a file descriptor from the sending end of the connection. The sending end has to call g_unix_connection_send_fd() for this to work. @@ -118696,14 +121300,14 @@ implementations. a file descriptor on success, -1 on error. + line="41361">a file descriptor on success, -1 on error. a #GUnixConnection + line="41349">a #GUnixConnection allow-none="1"> optional #GCancellable object, %NULL to ignore + line="41350">optional #GCancellable object, %NULL to ignore @@ -118723,7 +121327,7 @@ implementations. throws="1"> Passes the credentials of the current user the receiving side + line="41366">Passes the credentials of the current user the receiving side of the connection. The receiving end has to call g_unix_connection_receive_credentials() (or similar) to accept the credentials. @@ -118746,14 +121350,14 @@ Other ways to exchange credentials with a foreign peer includes the %TRUE on success, %FALSE if @error is set. + line="41392">%TRUE on success, %FALSE if @error is set. A #GUnixConnection. + line="41368">A #GUnixConnection. A #GCancellable or %NULL. + line="41369">A #GCancellable or %NULL. @@ -118772,7 +121376,7 @@ Other ways to exchange credentials with a foreign peer includes the version="2.32"> Asynchronously send credentials. + line="41397">Asynchronously send credentials. For more details, see g_unix_connection_send_credentials() which is the synchronous version of this call. @@ -118787,7 +121391,7 @@ g_unix_connection_send_credentials_finish() to get the result of the operation.< A #GUnixConnection. + line="41399">A #GUnixConnection. optional #GCancellable object, %NULL to ignore. + line="41400">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request is satisfied + line="41401">a #GAsyncReadyCallback to call when the request is satisfied the data to pass to callback function + line="41402">the data to pass to callback function @@ -118827,26 +121431,26 @@ g_unix_connection_send_credentials_finish() to get the result of the operation.< throws="1"> Finishes an asynchronous send credentials operation started with + line="41416">Finishes an asynchronous send credentials operation started with g_unix_connection_send_credentials_async(). %TRUE if the operation was successful, otherwise %FALSE. + line="41425">%TRUE if the operation was successful, otherwise %FALSE. A #GUnixConnection. + line="41418">A #GUnixConnection. a #GAsyncResult. + line="41419">a #GAsyncResult. @@ -118857,7 +121461,7 @@ g_unix_connection_send_credentials_async(). throws="1"> Passes a file descriptor to the receiving side of the + line="41430">Passes a file descriptor to the receiving side of the connection. The receiving end has to call g_unix_connection_receive_fd() to accept the file descriptor. @@ -118868,20 +121472,20 @@ implementations. a %TRUE on success, %NULL on error. + line="41445">a %TRUE on success, %NULL on error. a #GUnixConnection + line="41432">a #GUnixConnection a file descriptor + line="41433">a file descriptor allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="41434">optional #GCancellable object, %NULL to ignore. @@ -118925,7 +121529,7 @@ implementations. glib:type-struct="UnixCredentialsMessageClass"> This #GSocketControlMessage contains a #GCredentials instance. It + line="9934">This #GSocketControlMessage contains a #GCredentials instance. It may be sent using g_socket_send_message() and received using g_socket_receive_message() over UNIX sockets (ie: sockets in the %G_SOCKET_FAMILY_UNIX family). @@ -118942,12 +121546,12 @@ g_socket_get_credentials(). version="2.26"> Creates a new #GUnixCredentialsMessage with credentials matching the current processes. + line="41471">Creates a new #GUnixCredentialsMessage with credentials matching the current processes. a new #GUnixCredentialsMessage + line="41476">a new #GUnixCredentialsMessage @@ -118956,19 +121560,19 @@ g_socket_get_credentials(). version="2.26"> Creates a new #GUnixCredentialsMessage holding @credentials. + line="41481">Creates a new #GUnixCredentialsMessage holding @credentials. a new #GUnixCredentialsMessage + line="41487">a new #GUnixCredentialsMessage A #GCredentials object. + line="41483">A #GCredentials object. @@ -118978,33 +121582,34 @@ g_socket_get_credentials(). version="2.26"> Checks if passing #GCredentials on a #GSocket is supported on this platform. + line="41461">Checks if passing #GCredentials on a #GSocket is supported on this platform. %TRUE if supported, %FALSE otherwise + line="41466">%TRUE if supported, %FALSE otherwise Gets the credentials stored in @message. + line="41450">Gets the credentials stored in @message. A #GCredentials instance. Do not free, it is owned by @message. + line="41456">A #GCredentials instance. Do not free, it is owned by @message. A #GUnixCredentialsMessage. + line="41452">A #GUnixCredentialsMessage. @@ -119014,10 +121619,11 @@ g_socket_get_credentials(). version="2.26" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_credentials"> The credentials stored in the message. + line="4252">The credentials stored in the message. @@ -119071,7 +121677,7 @@ g_socket_get_credentials(). glib:type-struct="UnixFDListClass"> A #GUnixFDList contains a list of file descriptors. It owns the file + line="9955">A #GUnixFDList contains a list of file descriptors. It owns the file descriptors that it contains, closing them when finalized. It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in @@ -119085,12 +121691,12 @@ file when using it. Creates a new #GUnixFDList containing no file descriptors. + line="41553">Creates a new #GUnixFDList containing no file descriptors. a new #GUnixFDList + line="41558">a new #GUnixFDList @@ -119099,7 +121705,7 @@ file when using it. version="2.24"> Creates a new #GUnixFDList containing the file descriptors given in + line="41563">Creates a new #GUnixFDList containing the file descriptors given in @fds. The file descriptors become the property of the new list and may no longer be used by the caller. The array itself is owned by the caller. @@ -119111,14 +121717,14 @@ If @n_fds is -1 then @fds must be terminated with -1. a new #GUnixFDList + line="41577">a new #GUnixFDList the initial list of file descriptors + line="41565">the initial list of file descriptors @@ -119126,7 +121732,7 @@ If @n_fds is -1 then @fds must be terminated with -1. the length of #fds, or -1 + line="41566">the length of #fds, or -1 @@ -119137,7 +121743,7 @@ If @n_fds is -1 then @fds must be terminated with -1. throws="1"> Adds a file descriptor to @list. + line="41492">Adds a file descriptor to @list. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in @list will be closed @@ -119153,7 +121759,7 @@ duplicated copy of the same file descriptor. the index of the appended fd in case of success, else -1 + line="41511">the index of the appended fd in case of success, else -1 (and @error is set) @@ -119161,13 +121767,13 @@ duplicated copy of the same file descriptor. a #GUnixFDList + line="41494">a #GUnixFDList a valid open file descriptor + line="41495">a valid open file descriptor @@ -119178,7 +121784,7 @@ duplicated copy of the same file descriptor. throws="1"> Gets a file descriptor out of @list. + line="41517">Gets a file descriptor out of @list. @index_ specifies the index of the file descriptor to get. It is a programmer error for @index_ to be out of range; see @@ -119194,20 +121800,20 @@ system-wide file descriptor limit. the file descriptor, or -1 in case of error + line="41536">the file descriptor, or -1 in case of error a #GUnixFDList + line="41519">a #GUnixFDList the index into the list + line="41520">the index into the list @@ -119217,20 +121823,20 @@ system-wide file descriptor limit. version="2.24"> Gets the length of @list (ie: the number of file descriptors + line="41541">Gets the length of @list (ie: the number of file descriptors contained within). the length of @list + line="41548">the length of @list a #GUnixFDList + line="41543">a #GUnixFDList @@ -119240,7 +121846,7 @@ contained within). version="2.24"> Returns the array of file descriptors that is contained in this + line="41582">Returns the array of file descriptors that is contained in this object. After this call, the descriptors remain the property of @list. The @@ -119257,7 +121863,7 @@ descriptors contained in @list, an empty array is returned. an array of file + line="41602">an array of file descriptors @@ -119267,7 +121873,7 @@ descriptors contained in @list, an empty array is returned. a #GUnixFDList + line="41584">a #GUnixFDList allow-none="1"> pointer to the length of the returned + line="41585">pointer to the length of the returned array, or %NULL @@ -119289,7 +121895,7 @@ descriptors contained in @list, an empty array is returned. version="2.24"> Returns the array of file descriptors that is contained in this + line="41608">Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in @@ -119311,7 +121917,7 @@ descriptors contained in @list, an empty array is returned. an array of file + line="41633">an array of file descriptors @@ -119321,7 +121927,7 @@ descriptors contained in @list, an empty array is returned. a #GUnixFDList + line="41610">a #GUnixFDList allow-none="1"> pointer to the length of the returned + line="41611">pointer to the length of the returned array, or %NULL @@ -119405,7 +122011,7 @@ descriptors contained in @list, an empty array is returned. glib:type-struct="UnixFDMessageClass"> This #GSocketControlMessage contains a #GUnixFDList. + line="9975">This #GSocketControlMessage contains a #GUnixFDList. It may be sent using g_socket_send_message() and received using g_socket_receive_message() over UNIX sockets (ie: sockets in the %G_SOCKET_FAMILY_UNIX family). The file descriptors are copied @@ -119424,13 +122030,13 @@ file when using it. version="2.22"> Creates a new #GUnixFDMessage containing an empty file descriptor + line="41672">Creates a new #GUnixFDMessage containing an empty file descriptor list. a new #GUnixFDMessage + line="41678">a new #GUnixFDMessage @@ -119439,19 +122045,19 @@ list. version="2.24"> Creates a new #GUnixFDMessage containing @list. + line="41683">Creates a new #GUnixFDMessage containing @list. a new #GUnixFDMessage + line="41689">a new #GUnixFDMessage a #GUnixFDList + line="41685">a #GUnixFDList @@ -119462,7 +122068,7 @@ list. throws="1"> Adds a file descriptor to @message. + line="41639">Adds a file descriptor to @message. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in @message will be closed @@ -119474,44 +122080,45 @@ system-wide file descriptor limit. %TRUE in case of success, else %FALSE (and @error is set) + line="41654">%TRUE in case of success, else %FALSE (and @error is set) a #GUnixFDMessage + line="41641">a #GUnixFDMessage a valid open file descriptor + line="41642">a valid open file descriptor Gets the #GUnixFDList contained in @message. This function does not + line="41659">Gets the #GUnixFDList contained in @message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of @message. the #GUnixFDList from @message + line="41667">the #GUnixFDList from @message a #GUnixFDMessage + line="41661">a #GUnixFDMessage @@ -119521,7 +122128,7 @@ the lifetime of @message. version="2.22"> Returns the array of file descriptors that is contained in this + line="41694">Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in @@ -119542,7 +122149,7 @@ descriptors contained in @message, an empty array is returned. an array of file + line="41718">an array of file descriptors @@ -119552,7 +122159,7 @@ descriptors contained in @message, an empty array is returned. a #GUnixFDMessage + line="41696">a #GUnixFDMessage allow-none="1"> pointer to the length of the returned + line="41697">pointer to the length of the returned array, or %NULL @@ -119572,7 +122179,8 @@ descriptors contained in @message, an empty array is returned. + transfer-ownership="none" + getter="get_fd_list"> @@ -119621,7 +122229,7 @@ descriptors contained in @message, an empty array is returned. glib:type-struct="UnixInputStreamClass"> #GUnixInputStream implements #GInputStream for reading from a UNIX + line="9998">#GUnixInputStream implements #GInputStream for reading from a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back @@ -119636,7 +122244,7 @@ file when using it. Creates a new #GUnixInputStream for the given @fd. + line="41747">Creates a new #GUnixInputStream for the given @fd. If @close_fd is %TRUE, the file descriptor will be closed when the stream is closed. @@ -119644,75 +122252,78 @@ when the stream is closed. a new #GUnixInputStream + line="41757">a new #GUnixInputStream a UNIX file descriptor + line="41749">a UNIX file descriptor %TRUE to close the file descriptor when done + line="41750">%TRUE to close the file descriptor when done Returns whether the file descriptor of @stream will be + line="41724">Returns whether the file descriptor of @stream will be closed when the stream is closed. %TRUE if the file descriptor is closed when done + line="41731">%TRUE if the file descriptor is closed when done a #GUnixInputStream + line="41726">a #GUnixInputStream Return the UNIX file descriptor that the stream reads from. + line="41736">Return the UNIX file descriptor that the stream reads from. The file descriptor of @stream + line="41742">The file descriptor of @stream a #GUnixInputStream + line="41738">a #GUnixInputStream Sets whether the file descriptor of @stream shall be closed + line="41761">Sets whether the file descriptor of @stream shall be closed when the stream is closed. @@ -119722,13 +122333,13 @@ when the stream is closed. a #GUnixInputStream + line="41763">a #GUnixInputStream %TRUE to close the file descriptor when done + line="41764">%TRUE to close the file descriptor when done @@ -119736,20 +122347,23 @@ when the stream is closed. + transfer-ownership="none" + setter="set_close_fd" + getter="get_close_fd"> Whether to close the file descriptor when the stream is closed. + line="4277">Whether to close the file descriptor when the stream is closed. + transfer-ownership="none" + getter="get_fd"> The file descriptor that the stream reads from. + line="4286">The file descriptor that the stream reads from. @@ -119840,7 +122454,7 @@ This corresponds roughly to a mtab entry. deprecated-version="2.44"> Deprecated alias for g_unix_mount_monitor_get(). + line="42060">Deprecated alias for g_unix_mount_monitor_get(). This function was never a true constructor, which is why it was renamed. @@ -119849,7 +122463,7 @@ renamed. a #GUnixMountMonitor. + line="42068">a #GUnixMountMonitor. @@ -119858,7 +122472,7 @@ renamed. version="2.44"> Gets the #GUnixMountMonitor for the current thread-default main + line="42042">Gets the #GUnixMountMonitor for the current thread-default main context. The mount monitor can be used to monitor for changes to the list of @@ -119871,7 +122485,7 @@ the same main context as you called this function. the #GUnixMountMonitor. + line="42055">the #GUnixMountMonitor. @@ -119882,7 +122496,7 @@ the same main context as you called this function. deprecated-version="2.44"> This function does nothing. + line="42073">This function does nothing. Before 2.44, this was a partially-effective way of controlling the rate at which events would be reported under some uncommon @@ -119898,13 +122512,13 @@ the monitor. a #GUnixMountMonitor + line="42075">a #GUnixMountMonitor a integer with the limit in milliseconds to + line="42076">a integer with the limit in milliseconds to poll for changes. @@ -119913,7 +122527,7 @@ the monitor. Emitted when the unix mount points have changed. + line="4295">Emitted when the unix mount points have changed. @@ -119921,7 +122535,7 @@ the monitor. Emitted when the unix mounts have changed. + line="4303">Emitted when the unix mounts have changed. @@ -119946,12 +122560,12 @@ This corresponds roughly to a fstab entry. Compares two unix mount points. + line="42110">Compares two unix mount points. 1, 0 or -1 if @mount1 is greater than, equal to, + line="42117">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. @@ -119959,13 +122573,13 @@ or less than @mount2, respectively. a #GUnixMount. + line="42112">a #GUnixMount. a #GUnixMount. + line="42113">a #GUnixMount. @@ -119975,19 +122589,19 @@ or less than @mount2, respectively. version="2.54"> Makes a copy of @mount_point. + line="42122">Makes a copy of @mount_point. a new #GUnixMountPoint + line="42128">a new #GUnixMountPoint a #GUnixMountPoint. + line="42124">a #GUnixMountPoint. @@ -119995,7 +122609,7 @@ or less than @mount2, respectively. Frees a unix mount point. + line="42133">Frees a unix mount point. @@ -120004,7 +122618,7 @@ or less than @mount2, respectively. unix mount point to free. + line="42135">unix mount point to free. @@ -120013,19 +122627,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_get_device_path"> Gets the device path for a unix mount point. + line="42141">Gets the device path for a unix mount point. a string containing the device path. + line="42147">a string containing the device path. a #GUnixMountPoint. + line="42143">a #GUnixMountPoint. @@ -120033,19 +122647,19 @@ or less than @mount2, respectively. Gets the file system type for the mount point. + line="42151">Gets the file system type for the mount point. a string containing the file system type. + line="42157">a string containing the file system type. a #GUnixMountPoint. + line="42153">a #GUnixMountPoint. @@ -120054,19 +122668,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_get_mount_path"> Gets the mount path for a unix mount point. + line="42161">Gets the mount path for a unix mount point. a string containing the mount path. + line="42167">a string containing the mount path. a #GUnixMountPoint. + line="42163">a #GUnixMountPoint. @@ -120076,19 +122690,19 @@ or less than @mount2, respectively. version="2.32"> Gets the options for the mount point. + line="42171">Gets the options for the mount point. - + a string containing the options. + line="42177">a string containing the options. a #GUnixMountPoint. + line="42173">a #GUnixMountPoint. @@ -120097,19 +122711,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_guess_can_eject"> Guesses whether a Unix mount point can be ejected. + line="42182">Guesses whether a Unix mount point can be ejected. %TRUE if @mount_point is deemed to be ejectable. + line="42188">%TRUE if @mount_point is deemed to be ejectable. a #GUnixMountPoint + line="42184">a #GUnixMountPoint @@ -120117,19 +122731,19 @@ or less than @mount2, respectively. Guesses the icon of a Unix mount point. + line="42192">Guesses the icon of a Unix mount point. a #GIcon + line="42198">a #GIcon a #GUnixMountPoint + line="42194">a #GUnixMountPoint @@ -120137,13 +122751,13 @@ or less than @mount2, respectively. Guesses the name of a Unix mount point. + line="42202">Guesses the name of a Unix mount point. The result is a translated string. A newly allocated string that must + line="42209">A newly allocated string that must be freed with g_free() @@ -120151,7 +122765,7 @@ The result is a translated string. a #GUnixMountPoint + line="42204">a #GUnixMountPoint @@ -120161,19 +122775,19 @@ The result is a translated string. version="2.34"> Guesses the symbolic icon of a Unix mount point. + line="42214">Guesses the symbolic icon of a Unix mount point. a #GIcon + line="42220">a #GIcon a #GUnixMountPoint + line="42216">a #GUnixMountPoint @@ -120181,19 +122795,19 @@ The result is a translated string. Checks if a unix mount point is a loopback device. + line="42237">Checks if a unix mount point is a loopback device. %TRUE if the mount point is a loopback. %FALSE otherwise. + line="42243">%TRUE if the mount point is a loopback. %FALSE otherwise. a #GUnixMountPoint. + line="42239">a #GUnixMountPoint. @@ -120201,19 +122815,19 @@ The result is a translated string. Checks if a unix mount point is read only. + line="42247">Checks if a unix mount point is read only. %TRUE if a mount point is read only. + line="42253">%TRUE if a mount point is read only. a #GUnixMountPoint. + line="42249">a #GUnixMountPoint. @@ -120222,19 +122836,19 @@ The result is a translated string. c:identifier="g_unix_mount_point_is_user_mountable"> Checks if a unix mount point is mountable by the user. + line="42257">Checks if a unix mount point is mountable by the user. %TRUE if the mount point is user mountable. + line="42263">%TRUE if the mount point is user mountable. a #GUnixMountPoint. + line="42259">a #GUnixMountPoint. @@ -120242,7 +122856,7 @@ The result is a translated string. Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it + line="42092">Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking if the mount points have changed since with g_unix_mount_points_changed_since(). @@ -120252,7 +122866,7 @@ is returned. a #GUnixMountPoint, or %NULL if no match + line="42104">a #GUnixMountPoint, or %NULL if no match is found. @@ -120260,7 +122874,7 @@ is found. path for a possible unix mount point. + line="42094">path for a possible unix mount point. allow-none="1"> guint64 to contain a timestamp. + line="42095">guint64 to contain a timestamp. @@ -120286,7 +122900,7 @@ is found. glib:type-struct="UnixOutputStreamClass"> #GUnixOutputStream implements #GOutputStream for writing to a UNIX + line="10029">#GUnixOutputStream implements #GOutputStream for writing to a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back @@ -120301,7 +122915,7 @@ when using it. Creates a new #GUnixOutputStream for the given @fd. + line="42338">Creates a new #GUnixOutputStream for the given @fd. If @close_fd, is %TRUE, the file descriptor will be closed when the output stream is destroyed. @@ -120309,75 +122923,78 @@ the output stream is destroyed. a new #GOutputStream + line="42348">a new #GOutputStream a UNIX file descriptor + line="42340">a UNIX file descriptor %TRUE to close the file descriptor when done + line="42341">%TRUE to close the file descriptor when done Returns whether the file descriptor of @stream will be + line="42315">Returns whether the file descriptor of @stream will be closed when the stream is closed. %TRUE if the file descriptor is closed when done + line="42322">%TRUE if the file descriptor is closed when done a #GUnixOutputStream + line="42317">a #GUnixOutputStream Return the UNIX file descriptor that the stream writes to. + line="42327">Return the UNIX file descriptor that the stream writes to. The file descriptor of @stream + line="42333">The file descriptor of @stream a #GUnixOutputStream + line="42329">a #GUnixOutputStream Sets whether the file descriptor of @stream shall be closed + line="42352">Sets whether the file descriptor of @stream shall be closed when the stream is closed. @@ -120387,13 +123004,13 @@ when the stream is closed. a #GUnixOutputStream + line="42354">a #GUnixOutputStream %TRUE to close the file descriptor when done + line="42355">%TRUE to close the file descriptor when done @@ -120401,20 +123018,23 @@ when the stream is closed. + transfer-ownership="none" + setter="set_close_fd" + getter="get_close_fd"> Whether to close the file descriptor when the stream is closed. + line="4331">Whether to close the file descriptor when the stream is closed. + transfer-ownership="none" + getter="get_fd"> The file descriptor that the stream writes to. + line="4340">The file descriptor that the stream writes to. @@ -120487,7 +123107,7 @@ when the stream is closed. glib:type-struct="UnixSocketAddressClass"> Support for UNIX-domain (also known as local) sockets. + line="10047">Support for UNIX-domain (also known as local) sockets. UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not @@ -120508,7 +123128,7 @@ when using it. version="2.22"> Creates a new #GUnixSocketAddress for @path. + line="42426">Creates a new #GUnixSocketAddress for @path. To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract(). @@ -120516,14 +123136,14 @@ use g_unix_socket_address_new_abstract(). a new #GUnixSocketAddress + line="42435">a new #GUnixSocketAddress the socket path + line="42428">the socket path @@ -120533,21 +123153,21 @@ use g_unix_socket_address_new_abstract(). deprecated="1"> Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED + line="42440">Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED #GUnixSocketAddress for @path. Use g_unix_socket_address_new_with_type(). a new #GUnixSocketAddress + line="42448">a new #GUnixSocketAddress the abstract name + line="42442">the abstract name @@ -120555,7 +123175,7 @@ use g_unix_socket_address_new_abstract(). the length of @path, or -1 + line="42443">the length of @path, or -1 @@ -120565,7 +123185,7 @@ use g_unix_socket_address_new_abstract(). version="2.26"> Creates a new #GUnixSocketAddress of type @type with name @path. + line="42453">Creates a new #GUnixSocketAddress of type @type with name @path. If @type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to calling g_unix_socket_address_new(). @@ -120600,14 +123220,14 @@ its listening socket. a new #GUnixSocketAddress + line="42491">a new #GUnixSocketAddress the name + line="42455">the name @@ -120615,13 +123235,13 @@ its listening socket. the length of @path, or -1 + line="42456">the length of @path, or -1 a #GUnixSocketAddressType + line="42457">a #GUnixSocketAddressType @@ -120632,33 +123252,34 @@ its listening socket. version="2.22"> Checks if abstract UNIX domain socket names are supported. + line="42364">Checks if abstract UNIX domain socket names are supported. %TRUE if supported, %FALSE otherwise + line="42369">%TRUE if supported, %FALSE otherwise Gets @address's type. + line="42374">Gets @address's type. a #GUnixSocketAddressType + line="42380">a #GUnixSocketAddressType a #GInetSocketAddress + line="42376">a #GInetSocketAddress @@ -120669,30 +123290,31 @@ its listening socket. deprecated="1"> Tests if @address is abstract. + line="42385">Tests if @address is abstract. Use g_unix_socket_address_get_address_type() %TRUE if the address is abstract, %FALSE otherwise + line="42391">%TRUE if the address is abstract, %FALSE otherwise a #GInetSocketAddress + line="42387">a #GInetSocketAddress Gets @address's path, or for abstract sockets the "name". + line="42397">Gets @address's path, or for abstract sockets the "name". Guaranteed to be zero-terminated, but an abstract socket may contain embedded zeros, and thus you should use @@ -120702,14 +123324,14 @@ of this string. the path for @address + line="42408">the path for @address a #GInetSocketAddress + line="42399">a #GInetSocketAddress @@ -120719,21 +123341,21 @@ of this string. version="2.22"> Gets the length of @address's path. + line="42413">Gets the length of @address's path. For details, see g_unix_socket_address_get_path(). the length of the path + line="42421">the length of the path a #GInetSocketAddress + line="42415">a #GInetSocketAddress @@ -120745,7 +123367,7 @@ For details, see g_unix_socket_address_get_path(). transfer-ownership="none"> Whether or not this is an abstract address + line="4357">Whether or not this is an abstract address Use #GUnixSocketAddress:address-type, which distinguishes between zero-padded and non-zero-padded abstract addresses. @@ -120754,13 +123376,15 @@ abstract addresses. + transfer-ownership="none" + getter="get_address_type"> + transfer-ownership="none" + getter="get_path"> + glib:nick="invalid" + glib:name="G_UNIX_SOCKET_ADDRESS_INVALID"> invalid @@ -120823,7 +123448,8 @@ pass an appropriate smaller length to bind() or connect(). This is + glib:nick="anonymous" + glib:name="G_UNIX_SOCKET_ADDRESS_ANONYMOUS"> anonymous @@ -120831,7 +123457,8 @@ pass an appropriate smaller length to bind() or connect(). This is + glib:nick="path" + glib:name="G_UNIX_SOCKET_ADDRESS_PATH"> a filesystem path @@ -120839,7 +123466,8 @@ pass an appropriate smaller length to bind() or connect(). This is + glib:nick="abstract" + glib:name="G_UNIX_SOCKET_ADDRESS_ABSTRACT"> an abstract name @@ -120847,7 +123475,8 @@ pass an appropriate smaller length to bind() or connect(). This is + glib:nick="abstract-padded" + glib:name="G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED"> an abstract name, 0-padded @@ -121016,29 +123645,30 @@ See [Extending GIO][extending-gio]. glib:type-struct="VfsClass"> Entry point for using GIO functionality. + line="10069">Entry point for using GIO functionality. Gets the default #GVfs for the system. + line="42496">Gets the default #GVfs for the system. a #GVfs. + line="42501">a #GVfs, which will be the local + file system #GVfs if no other implementation is available. Gets the local #GVfs for the system. + line="42534">Gets the local #GVfs for the system. a #GVfs. + line="42539">a #GVfs. @@ -121074,12 +123704,12 @@ See [Extending GIO][extending-gio]. Gets a #GFile for @path. + line="42506">Gets a #GFile for @path. a #GFile. + line="42513">a #GFile. Free the returned object with g_object_unref(). @@ -121087,13 +123717,13 @@ See [Extending GIO][extending-gio]. a #GVfs. + line="42508">a #GVfs. a string containing a VFS path. + line="42509">a string containing a VFS path. @@ -121101,7 +123731,7 @@ See [Extending GIO][extending-gio]. Gets a #GFile for @uri. + line="42518">Gets a #GFile for @uri. This operation never fails, but the returned object might not support any I/O operation if the URI @@ -121110,7 +123740,7 @@ is malformed or if the URI scheme is not supported. a #GFile. + line="42529">a #GFile. Free the returned object with g_object_unref(). @@ -121118,13 +123748,13 @@ is malformed or if the URI scheme is not supported. a#GVfs. + line="42520">a#GVfs. a string containing a URI + line="42521">a string containing a URI @@ -121133,12 +123763,12 @@ is malformed or if the URI scheme is not supported. invoker="get_supported_uri_schemes"> Gets a list of URI schemes supported by @vfs. + line="42543">Gets a list of URI schemes supported by @vfs. a %NULL-terminated array of strings. + line="42549">a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -121149,7 +123779,7 @@ is malformed or if the URI scheme is not supported. a #GVfs. + line="42545">a #GVfs. @@ -121157,12 +123787,12 @@ is malformed or if the URI scheme is not supported. Checks if the VFS is active. + line="42555">Checks if the VFS is active. %TRUE if construction of the @vfs was successful + line="42561">%TRUE if construction of the @vfs was successful and it is now active. @@ -121170,7 +123800,7 @@ is malformed or if the URI scheme is not supported. a #GVfs. + line="42557">a #GVfs. @@ -121275,14 +123905,14 @@ is malformed or if the URI scheme is not supported. This operation never fails, but the returned object might + line="42566">This operation never fails, but the returned object might not support any I/O operations if the @parse_name cannot be parsed by the #GVfs module. a #GFile for the given @parse_name. + line="42575">a #GFile for the given @parse_name. Free the returned object with g_object_unref(). @@ -121290,13 +123920,13 @@ be parsed by the #GVfs module. a #GVfs. + line="42568">a #GVfs. a string to be parsed by the VFS module. + line="42569">a string to be parsed by the VFS module. @@ -121304,12 +123934,12 @@ be parsed by the #GVfs module. Gets a #GFile for @path. + line="42506">Gets a #GFile for @path. a #GFile. + line="42513">a #GFile. Free the returned object with g_object_unref(). @@ -121317,13 +123947,13 @@ be parsed by the #GVfs module. a #GVfs. + line="42508">a #GVfs. a string containing a VFS path. + line="42509">a string containing a VFS path. @@ -121331,7 +123961,7 @@ be parsed by the #GVfs module. Gets a #GFile for @uri. + line="42518">Gets a #GFile for @uri. This operation never fails, but the returned object might not support any I/O operation if the URI @@ -121340,7 +123970,7 @@ is malformed or if the URI scheme is not supported. a #GFile. + line="42529">a #GFile. Free the returned object with g_object_unref(). @@ -121348,13 +123978,13 @@ is malformed or if the URI scheme is not supported. a#GVfs. + line="42520">a#GVfs. a string containing a URI + line="42521">a string containing a URI @@ -121363,12 +123993,12 @@ is malformed or if the URI scheme is not supported. c:identifier="g_vfs_get_supported_uri_schemes"> Gets a list of URI schemes supported by @vfs. + line="42543">Gets a list of URI schemes supported by @vfs. a %NULL-terminated array of strings. + line="42549">a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -121379,7 +124009,7 @@ is malformed or if the URI scheme is not supported. a #GVfs. + line="42545">a #GVfs. @@ -121387,12 +124017,12 @@ is malformed or if the URI scheme is not supported. Checks if the VFS is active. + line="42555">Checks if the VFS is active. %TRUE if construction of the @vfs was successful + line="42561">%TRUE if construction of the @vfs was successful and it is now active. @@ -121400,7 +124030,7 @@ is malformed or if the URI scheme is not supported. a #GVfs. + line="42557">a #GVfs. @@ -121408,14 +124038,14 @@ is malformed or if the URI scheme is not supported. This operation never fails, but the returned object might + line="42566">This operation never fails, but the returned object might not support any I/O operations if the @parse_name cannot be parsed by the #GVfs module. a #GFile for the given @parse_name. + line="42575">a #GFile for the given @parse_name. Free the returned object with g_object_unref(). @@ -121423,13 +124053,13 @@ be parsed by the #GVfs module. a #GVfs. + line="42568">a #GVfs. a string to be parsed by the VFS module. + line="42569">a string to be parsed by the VFS module. @@ -121439,7 +124069,7 @@ be parsed by the #GVfs module. version="2.50"> Registers @uri_func and @parse_name_func as the #GFile URI and parse name + line="42580">Registers @uri_func and @parse_name_func as the #GFile URI and parse name lookup functions for URIs with a scheme matching @scheme. Note that @scheme is registered only within the running application, as opposed to desktop-wide as it happens with GVfs backends. @@ -121463,7 +124093,7 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). %TRUE if @scheme was successfully registered, or %FALSE if a handler + line="42617">%TRUE if @scheme was successfully registered, or %FALSE if a handler for @scheme already exists. @@ -121471,13 +124101,13 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). a #GVfs + line="42582">a #GVfs an URI scheme, e.g. "http" + line="42583">an URI scheme, e.g. "http" destroy="3"> a #GVfsFileLookupFunc + line="42584">a #GVfsFileLookupFunc allow-none="1"> custom data passed to be passed to @uri_func, or %NULL + line="42585">custom data passed to be passed to @uri_func, or %NULL scope="async"> function to be called when unregistering the + line="42586">function to be called when unregistering the URI scheme, or when @vfs is disposed, to free the resources used by the URI lookup function @@ -121522,7 +124152,7 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). destroy="6"> a #GVfsFileLookupFunc + line="42589">a #GVfsFileLookupFunc allow-none="1"> custom data passed to be passed to + line="42590">custom data passed to be passed to @parse_name_func, or %NULL @@ -121542,7 +124172,7 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). scope="async"> function to be called when unregistering the + line="42592">function to be called when unregistering the URI scheme, or when @vfs is disposed, to free the resources used by the parse name lookup function @@ -121554,13 +124184,13 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). version="2.50"> Unregisters the URI handler for @scheme previously registered with + line="42623">Unregisters the URI handler for @scheme previously registered with g_vfs_register_uri_scheme(). %TRUE if @scheme was successfully unregistered, or %FALSE if a + line="42631">%TRUE if @scheme was successfully unregistered, or %FALSE if a handler for @scheme does not exist. @@ -121568,13 +124198,13 @@ g_vfs_register_uri_scheme(). a #GVfs + line="42625">a #GVfs an URI scheme, e.g. "http" + line="42626">an URI scheme, e.g. "http" @@ -121594,7 +124224,7 @@ g_vfs_register_uri_scheme(). %TRUE if construction of the @vfs was successful + line="42561">%TRUE if construction of the @vfs was successful and it is now active. @@ -121602,7 +124232,7 @@ g_vfs_register_uri_scheme(). a #GVfs. + line="42557">a #GVfs. @@ -121614,7 +124244,7 @@ g_vfs_register_uri_scheme(). a #GFile. + line="42513">a #GFile. Free the returned object with g_object_unref(). @@ -121622,13 +124252,13 @@ g_vfs_register_uri_scheme(). a #GVfs. + line="42508">a #GVfs. a string containing a VFS path. + line="42509">a string containing a VFS path. @@ -121640,7 +124270,7 @@ g_vfs_register_uri_scheme(). a #GFile. + line="42529">a #GFile. Free the returned object with g_object_unref(). @@ -121648,13 +124278,13 @@ g_vfs_register_uri_scheme(). a#GVfs. + line="42520">a#GVfs. a string containing a URI + line="42521">a string containing a URI @@ -121666,7 +124296,7 @@ g_vfs_register_uri_scheme(). a %NULL-terminated array of strings. + line="42549">a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -121677,7 +124307,7 @@ g_vfs_register_uri_scheme(). a #GVfs. + line="42545">a #GVfs. @@ -121689,7 +124319,7 @@ g_vfs_register_uri_scheme(). a #GFile for the given @parse_name. + line="42575">a #GFile for the given @parse_name. Free the returned object with g_object_unref(). @@ -121697,13 +124327,13 @@ g_vfs_register_uri_scheme(). a #GVfs. + line="42568">a #GVfs. a string to be parsed by the VFS module. + line="42569">a string to be parsed by the VFS module. @@ -121947,7 +124577,7 @@ created for @uri, or %NULL to continue with the default implementation. glib:type-struct="VolumeIface"> The #GVolume interface represents user-visible objects that can be + line="10078">The #GVolume interface represents user-visible objects that can be mounted. Note, when porting from GnomeVFS, #GVolume is the moral equivalent of #GnomeVFSDrive. @@ -121992,19 +124622,19 @@ libhal_manager_find_device_string_match(). Checks if a volume can be ejected. + line="42637">Checks if a volume can be ejected. %TRUE if the @volume can be ejected. %FALSE otherwise + line="42643">%TRUE if the @volume can be ejected. %FALSE otherwise a #GVolume + line="42639">a #GVolume @@ -122012,19 +124642,19 @@ libhal_manager_find_device_string_match(). Checks if a volume can be mounted. + line="42647">Checks if a volume can be mounted. %TRUE if the @volume can be mounted. %FALSE otherwise + line="42653">%TRUE if the @volume can be mounted. %FALSE otherwise a #GVolume + line="42649">a #GVolume @@ -122046,7 +124676,7 @@ libhal_manager_find_device_string_match(). deprecated-version="2.22"> Ejects a volume. This is an asynchronous operation, and is + line="42657">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback. Use g_volume_eject_with_operation() instead. @@ -122058,13 +124688,13 @@ and #GAsyncResult returned in the @callback. a #GVolume + line="42659">a #GVolume flags affecting the unmount if required for eject + line="42660">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42661">optional #GCancellable object, %NULL to ignore closure="3"> a #GAsyncReadyCallback, or %NULL + line="42662">a #GAsyncReadyCallback, or %NULL closure="3"> user data that gets passed to @callback + line="42663">user data that gets passed to @callback @@ -122106,27 +124736,27 @@ and #GAsyncResult returned in the @callback. throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + line="42673">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_volume_eject_with_operation_finish() instead. %TRUE, %FALSE if operation failed + line="42682">%TRUE, %FALSE if operation failed pointer to a #GVolume + line="42675">pointer to a #GVolume a #GAsyncResult + line="42676">a #GAsyncResult @@ -122136,7 +124766,7 @@ and #GAsyncResult returned in the @callback. version="2.22"> Ejects a volume. This is an asynchronous operation, and is + line="42687">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback. @@ -122147,13 +124777,13 @@ and #GAsyncResult data returned in the @callback. a #GVolume + line="42689">a #GVolume flags affecting the unmount if required for eject + line="42690">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to + line="42691">a #GMountOperation or %NULL to avoid user interaction @@ -122172,7 +124802,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42693">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback, or %NULL + line="42694">a #GAsyncReadyCallback, or %NULL closure="4"> user data passed to @callback + line="42695">user data passed to @callback @@ -122204,26 +124834,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + line="42705">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the volume was successfully ejected. %FALSE otherwise + line="42714">%TRUE if the volume was successfully ejected. %FALSE otherwise a #GVolume + line="42707">a #GVolume a #GAsyncResult + line="42708">a #GAsyncResult @@ -122232,13 +124862,13 @@ and #GAsyncResult data returned in the @callback. invoker="enumerate_identifiers"> Gets the kinds of [identifiers][volume-identifier] that @volume has. + line="42719">Gets the kinds of [identifiers][volume-identifier] that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves. a %NULL-terminated array + line="42726">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -122248,7 +124878,7 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. a #GVolume + line="42721">a #GVolume @@ -122258,7 +124888,7 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. version="2.18"> Gets the activation root for a #GVolume if it is known ahead of + line="42731">Gets the activation root for a #GVolume if it is known ahead of mount time. Returns %NULL otherwise. If not %NULL and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always @@ -122288,7 +124918,7 @@ g_mount_is_shadowed() for more details. the activation root of @volume + line="42762">the activation root of @volume or %NULL. Use g_object_unref() to free. @@ -122296,7 +124926,7 @@ g_mount_is_shadowed() for more details. a #GVolume + line="42733">a #GVolume @@ -122304,12 +124934,12 @@ g_mount_is_shadowed() for more details. Gets the drive for the @volume. + line="42768">Gets the drive for the @volume. a #GDrive or %NULL if @volume is not + line="42774">a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -122318,7 +124948,7 @@ g_mount_is_shadowed() for more details. a #GVolume + line="42770">a #GVolume @@ -122326,12 +124956,12 @@ g_mount_is_shadowed() for more details. Gets the icon for @volume. + line="42780">Gets the icon for @volume. a #GIcon. + line="42786">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -122340,7 +124970,7 @@ g_mount_is_shadowed() for more details. a #GVolume + line="42782">a #GVolume @@ -122348,14 +124978,14 @@ g_mount_is_shadowed() for more details. Gets the identifier of the given kind for @volume. + line="42792">Gets the identifier of the given kind for @volume. See the [introduction][volume-identifier] for more information about volume identifiers. a newly allocated string containing the + line="42801">a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier @@ -122364,13 +124994,13 @@ information about volume identifiers. a #GVolume + line="42794">a #GVolume the kind of identifier to return + line="42795">the kind of identifier to return @@ -122378,12 +125008,12 @@ information about volume identifiers. Gets the mount for the @volume. + line="42807">Gets the mount for the @volume. a #GMount or %NULL if @volume isn't mounted. + line="42813">a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -122392,7 +125022,7 @@ information about volume identifiers. a #GVolume + line="42809">a #GVolume @@ -122400,12 +125030,12 @@ information about volume identifiers. Gets the name of @volume. + line="42819">Gets the name of @volume. the name for the given @volume. The returned string should + line="42825">the name for the given @volume. The returned string should be freed with g_free() when no longer needed. @@ -122413,7 +125043,7 @@ information about volume identifiers. a #GVolume + line="42821">a #GVolume @@ -122423,19 +125053,19 @@ information about volume identifiers. version="2.32"> Gets the sort key for @volume, if any. + line="42830">Gets the sort key for @volume, if any. Sorting key for @volume or %NULL if no such key is available + line="42836">Sorting key for @volume or %NULL if no such key is available a #GVolume + line="42832">a #GVolume @@ -122445,12 +125075,12 @@ information about volume identifiers. version="2.34"> Gets the symbolic icon for @volume. + line="42841">Gets the symbolic icon for @volume. a #GIcon. + line="42847">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -122459,7 +125089,7 @@ information about volume identifiers. a #GVolume + line="42843">a #GVolume @@ -122467,7 +125097,7 @@ information about volume identifiers. Gets the UUID for the @volume. The reference is typically based on + line="42854">Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns %NULL if there is no UUID available. @@ -122475,7 +125105,7 @@ available. the UUID for @volume or %NULL if no UUID + line="42863">the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -122485,7 +125115,7 @@ available. a #GVolume + line="42856">a #GVolume @@ -122493,7 +125123,7 @@ available. Finishes mounting a volume. If any errors occurred during the operation, + line="43001">Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume @@ -122504,20 +125134,20 @@ function; there's no need to listen for the 'mount-added' signal on %TRUE, %FALSE if operation failed + line="43015">%TRUE, %FALSE if operation failed a #GVolume + line="43003">a #GVolume a #GAsyncResult + line="43004">a #GAsyncResult @@ -122525,7 +125155,7 @@ function; there's no need to listen for the 'mount-added' signal on Mounts a volume. This is an asynchronous operation, and is + line="42986">Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback. @@ -122536,13 +125166,13 @@ and #GAsyncResult returned in the @callback. a #GVolume + line="42988">a #GVolume flags affecting the operation + line="42989">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid user interaction + line="42990">a #GMountOperation or %NULL to avoid user interaction allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42991">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback, or %NULL + line="42992">a #GAsyncReadyCallback, or %NULL closure="4"> user data that gets passed to @callback + line="42993">user data that gets passed to @callback @@ -122600,19 +125230,19 @@ and #GAsyncResult returned in the @callback. Returns whether the volume should be automatically mounted. + line="43019">Returns whether the volume should be automatically mounted. %TRUE if the volume should be automatically mounted + line="43025">%TRUE if the volume should be automatically mounted a #GVolume + line="43021">a #GVolume @@ -122620,19 +125250,19 @@ and #GAsyncResult returned in the @callback. Checks if a volume can be ejected. + line="42637">Checks if a volume can be ejected. %TRUE if the @volume can be ejected. %FALSE otherwise + line="42643">%TRUE if the @volume can be ejected. %FALSE otherwise a #GVolume + line="42639">a #GVolume @@ -122640,19 +125270,19 @@ and #GAsyncResult returned in the @callback. Checks if a volume can be mounted. + line="42647">Checks if a volume can be mounted. %TRUE if the @volume can be mounted. %FALSE otherwise + line="42653">%TRUE if the @volume can be mounted. %FALSE otherwise a #GVolume + line="42649">a #GVolume @@ -122663,7 +125293,7 @@ and #GAsyncResult returned in the @callback. deprecated-version="2.22"> Ejects a volume. This is an asynchronous operation, and is + line="42657">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback. Use g_volume_eject_with_operation() instead. @@ -122675,13 +125305,13 @@ and #GAsyncResult returned in the @callback. a #GVolume + line="42659">a #GVolume flags affecting the unmount if required for eject + line="42660">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42661">optional #GCancellable object, %NULL to ignore closure="3"> a #GAsyncReadyCallback, or %NULL + line="42662">a #GAsyncReadyCallback, or %NULL allow-none="1"> user data that gets passed to @callback + line="42663">user data that gets passed to @callback @@ -122722,27 +125352,27 @@ and #GAsyncResult returned in the @callback. throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + line="42673">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_volume_eject_with_operation_finish() instead. %TRUE, %FALSE if operation failed + line="42682">%TRUE, %FALSE if operation failed pointer to a #GVolume + line="42675">pointer to a #GVolume a #GAsyncResult + line="42676">a #GAsyncResult @@ -122752,7 +125382,7 @@ and #GAsyncResult returned in the @callback. version="2.22"> Ejects a volume. This is an asynchronous operation, and is + line="42687">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback. @@ -122763,13 +125393,13 @@ and #GAsyncResult data returned in the @callback. a #GVolume + line="42689">a #GVolume flags affecting the unmount if required for eject + line="42690">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to + line="42691">a #GMountOperation or %NULL to avoid user interaction @@ -122788,7 +125418,7 @@ and #GAsyncResult data returned in the @callback. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42693">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback, or %NULL + line="42694">a #GAsyncReadyCallback, or %NULL allow-none="1"> user data passed to @callback + line="42695">user data passed to @callback @@ -122819,26 +125449,26 @@ and #GAsyncResult data returned in the @callback. throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + line="42705">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. %TRUE if the volume was successfully ejected. %FALSE otherwise + line="42714">%TRUE if the volume was successfully ejected. %FALSE otherwise a #GVolume + line="42707">a #GVolume a #GAsyncResult + line="42708">a #GAsyncResult @@ -122847,13 +125477,13 @@ and #GAsyncResult data returned in the @callback. c:identifier="g_volume_enumerate_identifiers"> Gets the kinds of [identifiers][volume-identifier] that @volume has. + line="42719">Gets the kinds of [identifiers][volume-identifier] that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves. a %NULL-terminated array + line="42726">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -122863,7 +125493,7 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. a #GVolume + line="42721">a #GVolume @@ -122873,7 +125503,7 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. version="2.18"> Gets the activation root for a #GVolume if it is known ahead of + line="42731">Gets the activation root for a #GVolume if it is known ahead of mount time. Returns %NULL otherwise. If not %NULL and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always @@ -122903,7 +125533,7 @@ g_mount_is_shadowed() for more details. the activation root of @volume + line="42762">the activation root of @volume or %NULL. Use g_object_unref() to free. @@ -122911,7 +125541,7 @@ g_mount_is_shadowed() for more details. a #GVolume + line="42733">a #GVolume @@ -122919,12 +125549,12 @@ g_mount_is_shadowed() for more details. Gets the drive for the @volume. + line="42768">Gets the drive for the @volume. a #GDrive or %NULL if @volume is not + line="42774">a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -122933,7 +125563,7 @@ g_mount_is_shadowed() for more details. a #GVolume + line="42770">a #GVolume @@ -122941,12 +125571,12 @@ g_mount_is_shadowed() for more details. Gets the icon for @volume. + line="42780">Gets the icon for @volume. a #GIcon. + line="42786">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -122955,7 +125585,7 @@ g_mount_is_shadowed() for more details. a #GVolume + line="42782">a #GVolume @@ -122963,14 +125593,14 @@ g_mount_is_shadowed() for more details. Gets the identifier of the given kind for @volume. + line="42792">Gets the identifier of the given kind for @volume. See the [introduction][volume-identifier] for more information about volume identifiers. a newly allocated string containing the + line="42801">a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier @@ -122979,13 +125609,13 @@ information about volume identifiers. a #GVolume + line="42794">a #GVolume the kind of identifier to return + line="42795">the kind of identifier to return @@ -122993,12 +125623,12 @@ information about volume identifiers. Gets the mount for the @volume. + line="42807">Gets the mount for the @volume. a #GMount or %NULL if @volume isn't mounted. + line="42813">a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -123007,7 +125637,7 @@ information about volume identifiers. a #GVolume + line="42809">a #GVolume @@ -123015,12 +125645,12 @@ information about volume identifiers. Gets the name of @volume. + line="42819">Gets the name of @volume. the name for the given @volume. The returned string should + line="42825">the name for the given @volume. The returned string should be freed with g_free() when no longer needed. @@ -123028,7 +125658,7 @@ information about volume identifiers. a #GVolume + line="42821">a #GVolume @@ -123038,19 +125668,19 @@ information about volume identifiers. version="2.32"> Gets the sort key for @volume, if any. + line="42830">Gets the sort key for @volume, if any. Sorting key for @volume or %NULL if no such key is available + line="42836">Sorting key for @volume or %NULL if no such key is available a #GVolume + line="42832">a #GVolume @@ -123060,12 +125690,12 @@ information about volume identifiers. version="2.34"> Gets the symbolic icon for @volume. + line="42841">Gets the symbolic icon for @volume. a #GIcon. + line="42847">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -123074,7 +125704,7 @@ information about volume identifiers. a #GVolume + line="42843">a #GVolume @@ -123082,7 +125712,7 @@ information about volume identifiers. Gets the UUID for the @volume. The reference is typically based on + line="42854">Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns %NULL if there is no UUID available. @@ -123090,7 +125720,7 @@ available. the UUID for @volume or %NULL if no UUID + line="42863">the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -123100,7 +125730,7 @@ available. a #GVolume + line="42856">a #GVolume @@ -123108,7 +125738,7 @@ available. Mounts a volume. This is an asynchronous operation, and is + line="42986">Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback. @@ -123119,13 +125749,13 @@ and #GAsyncResult returned in the @callback. a #GVolume + line="42988">a #GVolume flags affecting the operation + line="42989">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid user interaction + line="42990">a #GMountOperation or %NULL to avoid user interaction allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42991">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback, or %NULL + line="42992">a #GAsyncReadyCallback, or %NULL allow-none="1"> user data that gets passed to @callback + line="42993">user data that gets passed to @callback @@ -123173,7 +125803,7 @@ and #GAsyncResult returned in the @callback. throws="1"> Finishes mounting a volume. If any errors occurred during the operation, + line="43001">Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume @@ -123184,20 +125814,20 @@ function; there's no need to listen for the 'mount-added' signal on %TRUE, %FALSE if operation failed + line="43015">%TRUE, %FALSE if operation failed a #GVolume + line="43003">a #GVolume a #GAsyncResult + line="43004">a #GAsyncResult @@ -123205,19 +125835,19 @@ function; there's no need to listen for the 'mount-added' signal on Returns whether the volume should be automatically mounted. + line="43019">Returns whether the volume should be automatically mounted. %TRUE if the volume should be automatically mounted + line="43025">%TRUE if the volume should be automatically mounted a #GVolume + line="43021">a #GVolume @@ -123225,7 +125855,7 @@ function; there's no need to listen for the 'mount-added' signal on Emitted when the volume has been changed. + line="4368">Emitted when the volume has been changed. @@ -123233,7 +125863,7 @@ function; there's no need to listen for the 'mount-added' signal on This signal is emitted when the #GVolume have been removed. If + line="4375">This signal is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -123286,7 +125916,7 @@ release them so the object can be finalized. the name for the given @volume. The returned string should + line="42825">the name for the given @volume. The returned string should be freed with g_free() when no longer needed. @@ -123294,7 +125924,7 @@ release them so the object can be finalized. a #GVolume + line="42821">a #GVolume @@ -123306,7 +125936,7 @@ release them so the object can be finalized. a #GIcon. + line="42786">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -123315,7 +125945,7 @@ release them so the object can be finalized. a #GVolume + line="42782">a #GVolume @@ -123327,7 +125957,7 @@ release them so the object can be finalized. the UUID for @volume or %NULL if no UUID + line="42863">the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -123337,7 +125967,7 @@ release them so the object can be finalized. a #GVolume + line="42856">a #GVolume @@ -123349,7 +125979,7 @@ release them so the object can be finalized. a #GDrive or %NULL if @volume is not + line="42774">a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -123358,7 +125988,7 @@ release them so the object can be finalized. a #GVolume + line="42770">a #GVolume @@ -123370,7 +126000,7 @@ release them so the object can be finalized. a #GMount or %NULL if @volume isn't mounted. + line="42813">a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -123379,7 +126009,7 @@ release them so the object can be finalized. a #GVolume + line="42809">a #GVolume @@ -123391,14 +126021,14 @@ release them so the object can be finalized. %TRUE if the @volume can be mounted. %FALSE otherwise + line="42653">%TRUE if the @volume can be mounted. %FALSE otherwise a #GVolume + line="42649">a #GVolume @@ -123410,14 +126040,14 @@ release them so the object can be finalized. %TRUE if the @volume can be ejected. %FALSE otherwise + line="42643">%TRUE if the @volume can be ejected. %FALSE otherwise a #GVolume + line="42639">a #GVolume @@ -123433,13 +126063,13 @@ release them so the object can be finalized. a #GVolume + line="42988">a #GVolume flags affecting the operation + line="42989">flags affecting the operation allow-none="1"> a #GMountOperation or %NULL to avoid user interaction + line="42990">a #GMountOperation or %NULL to avoid user interaction allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42991">optional #GCancellable object, %NULL to ignore closure="5"> a #GAsyncReadyCallback, or %NULL + line="42992">a #GAsyncReadyCallback, or %NULL closure="5"> user data that gets passed to @callback + line="42993">user data that gets passed to @callback @@ -123490,20 +126120,20 @@ release them so the object can be finalized. %TRUE, %FALSE if operation failed + line="43015">%TRUE, %FALSE if operation failed a #GVolume + line="43003">a #GVolume a #GAsyncResult + line="43004">a #GAsyncResult @@ -123519,13 +126149,13 @@ release them so the object can be finalized. a #GVolume + line="42659">a #GVolume flags affecting the unmount if required for eject + line="42660">flags affecting the unmount if required for eject allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42661">optional #GCancellable object, %NULL to ignore closure="4"> a #GAsyncReadyCallback, or %NULL + line="42662">a #GAsyncReadyCallback, or %NULL closure="4"> user data that gets passed to @callback + line="42663">user data that gets passed to @callback @@ -123567,20 +126197,20 @@ release them so the object can be finalized. %TRUE, %FALSE if operation failed + line="42682">%TRUE, %FALSE if operation failed pointer to a #GVolume + line="42675">pointer to a #GVolume a #GAsyncResult + line="42676">a #GAsyncResult @@ -123592,7 +126222,7 @@ release them so the object can be finalized. a newly allocated string containing the + line="42801">a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier @@ -123601,13 +126231,13 @@ release them so the object can be finalized. a #GVolume + line="42794">a #GVolume the kind of identifier to return + line="42795">the kind of identifier to return @@ -123619,7 +126249,7 @@ release them so the object can be finalized. a %NULL-terminated array + line="42726">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -123629,7 +126259,7 @@ release them so the object can be finalized. a #GVolume + line="42721">a #GVolume @@ -123641,14 +126271,14 @@ release them so the object can be finalized. %TRUE if the volume should be automatically mounted + line="43025">%TRUE if the volume should be automatically mounted a #GVolume + line="43021">a #GVolume @@ -123660,7 +126290,7 @@ release them so the object can be finalized. the activation root of @volume + line="42762">the activation root of @volume or %NULL. Use g_object_unref() to free. @@ -123668,7 +126298,7 @@ release them so the object can be finalized. a #GVolume + line="42733">a #GVolume @@ -123684,13 +126314,13 @@ release them so the object can be finalized. a #GVolume + line="42689">a #GVolume flags affecting the unmount if required for eject + line="42690">flags affecting the unmount if required for eject allow-none="1"> a #GMountOperation or %NULL to + line="42691">a #GMountOperation or %NULL to avoid user interaction @@ -123709,7 +126339,7 @@ release them so the object can be finalized. allow-none="1"> optional #GCancellable object, %NULL to ignore + line="42693">optional #GCancellable object, %NULL to ignore closure="5"> a #GAsyncReadyCallback, or %NULL + line="42694">a #GAsyncReadyCallback, or %NULL closure="5"> user data passed to @callback + line="42695">user data passed to @callback @@ -123742,20 +126372,20 @@ release them so the object can be finalized. %TRUE if the volume was successfully ejected. %FALSE otherwise + line="42714">%TRUE if the volume was successfully ejected. %FALSE otherwise a #GVolume + line="42707">a #GVolume a #GAsyncResult + line="42708">a #GAsyncResult @@ -123767,14 +126397,14 @@ release them so the object can be finalized. Sorting key for @volume or %NULL if no such key is available + line="42836">Sorting key for @volume or %NULL if no such key is available a #GVolume + line="42832">a #GVolume @@ -123786,7 +126416,7 @@ release them so the object can be finalized. a #GIcon. + line="42847">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -123795,7 +126425,7 @@ release them so the object can be finalized. a #GVolume + line="42843">a #GVolume @@ -123811,7 +126441,7 @@ release them so the object can be finalized. glib:type-struct="VolumeMonitorClass"> #GVolumeMonitor is for listing the user interesting devices and volumes + line="10127">#GVolumeMonitor is for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar. @@ -123829,7 +126459,7 @@ a main loop must be running. deprecated-version="2.20"> This function should be called by any #GVolumeMonitor + line="42870">This function should be called by any #GVolumeMonitor implementation when a new #GMount object is created that is not associated with a #GVolume object. It must be called just before emitting the @mount_added signal. @@ -123866,7 +126496,7 @@ g_mount_shadow() and g_mount_unshadow() functions. the #GVolume object that is the parent for @mount or %NULL + line="42903">the #GVolume object that is the parent for @mount or %NULL if no wants to adopt the #GMount. @@ -123874,7 +126504,7 @@ if no wants to adopt the #GMount. a #GMount object to find a parent for + line="42872">a #GMount object to find a parent for @@ -123882,12 +126512,12 @@ if no wants to adopt the #GMount. Gets the volume monitor used by gio. + line="42913">Gets the volume monitor used by gio. a reference to the #GVolumeMonitor used by gio. Call + line="42918">a reference to the #GVolumeMonitor used by gio. Call g_object_unref() when done with it. @@ -123966,7 +126596,7 @@ if no wants to adopt the #GMount. invoker="get_connected_drives"> Gets a list of drives connected to the system. + line="42923">Gets a list of drives connected to the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -123974,7 +126604,7 @@ its elements have been unreffed with g_object_unref(). a #GList of connected #GDrive objects. + line="42932">a #GList of connected #GDrive objects. @@ -123983,7 +126613,7 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42925">a #GVolumeMonitor. @@ -123991,12 +126621,12 @@ its elements have been unreffed with g_object_unref(). Finds a #GMount object by its UUID (see g_mount_get_uuid()) + line="42936">Finds a #GMount object by its UUID (see g_mount_get_uuid()) - + a #GMount or %NULL if no such mount is available. + line="42943">a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). @@ -124004,13 +126634,13 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42938">a #GVolumeMonitor. the UUID to look for + line="42939">the UUID to look for @@ -124018,7 +126648,7 @@ its elements have been unreffed with g_object_unref(). Gets a list of the mounts on the system. + line="42948">Gets a list of the mounts on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -124026,7 +126656,7 @@ its elements have been unreffed with g_object_unref(). a #GList of #GMount objects. + line="42957">a #GList of #GMount objects. @@ -124035,7 +126665,7 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42950">a #GVolumeMonitor. @@ -124043,12 +126673,12 @@ its elements have been unreffed with g_object_unref(). Finds a #GVolume object by its UUID (see g_volume_get_uuid()) + line="42961">Finds a #GVolume object by its UUID (see g_volume_get_uuid()) - + a #GVolume or %NULL if no such volume is available. + line="42968">a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). @@ -124056,13 +126686,13 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42963">a #GVolumeMonitor. the UUID to look for + line="42964">the UUID to look for @@ -124070,7 +126700,7 @@ its elements have been unreffed with g_object_unref(). Gets a list of the volumes on the system. + line="42973">Gets a list of the volumes on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -124078,7 +126708,7 @@ its elements have been unreffed with g_object_unref(). a #GList of #GVolume objects. + line="42982">a #GList of #GVolume objects. @@ -124087,7 +126717,7 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42975">a #GVolumeMonitor. @@ -124194,7 +126824,7 @@ its elements have been unreffed with g_object_unref(). c:identifier="g_volume_monitor_get_connected_drives"> Gets a list of drives connected to the system. + line="42923">Gets a list of drives connected to the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -124202,7 +126832,7 @@ its elements have been unreffed with g_object_unref(). a #GList of connected #GDrive objects. + line="42932">a #GList of connected #GDrive objects. @@ -124211,7 +126841,7 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42925">a #GVolumeMonitor. @@ -124220,12 +126850,12 @@ its elements have been unreffed with g_object_unref(). c:identifier="g_volume_monitor_get_mount_for_uuid"> Finds a #GMount object by its UUID (see g_mount_get_uuid()) + line="42936">Finds a #GMount object by its UUID (see g_mount_get_uuid()) - + a #GMount or %NULL if no such mount is available. + line="42943">a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). @@ -124233,13 +126863,13 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42938">a #GVolumeMonitor. the UUID to look for + line="42939">the UUID to look for @@ -124247,7 +126877,7 @@ its elements have been unreffed with g_object_unref(). Gets a list of the mounts on the system. + line="42948">Gets a list of the mounts on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -124255,7 +126885,7 @@ its elements have been unreffed with g_object_unref(). a #GList of #GMount objects. + line="42957">a #GList of #GMount objects. @@ -124264,7 +126894,7 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42950">a #GVolumeMonitor. @@ -124273,12 +126903,12 @@ its elements have been unreffed with g_object_unref(). c:identifier="g_volume_monitor_get_volume_for_uuid"> Finds a #GVolume object by its UUID (see g_volume_get_uuid()) + line="42961">Finds a #GVolume object by its UUID (see g_volume_get_uuid()) - + a #GVolume or %NULL if no such volume is available. + line="42968">a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). @@ -124286,13 +126916,13 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42963">a #GVolumeMonitor. the UUID to look for + line="42964">the UUID to look for @@ -124300,7 +126930,7 @@ its elements have been unreffed with g_object_unref(). Gets a list of the volumes on the system. + line="42973">Gets a list of the volumes on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). @@ -124308,7 +126938,7 @@ its elements have been unreffed with g_object_unref(). a #GList of #GVolume objects. + line="42982">a #GList of #GVolume objects. @@ -124317,7 +126947,7 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + line="42975">a #GVolumeMonitor. @@ -124331,7 +126961,7 @@ its elements have been unreffed with g_object_unref(). Emitted when a drive changes. + line="4384">Emitted when a drive changes. @@ -124339,7 +126969,7 @@ its elements have been unreffed with g_object_unref(). the drive that changed + line="4387">the drive that changed @@ -124347,7 +126977,7 @@ its elements have been unreffed with g_object_unref(). Emitted when a drive is connected to the system. + line="4393">Emitted when a drive is connected to the system. @@ -124355,7 +126985,7 @@ its elements have been unreffed with g_object_unref(). a #GDrive that was connected. + line="4396">a #GDrive that was connected. @@ -124363,7 +126993,7 @@ its elements have been unreffed with g_object_unref(). Emitted when a drive is disconnected from the system. + line="4402">Emitted when a drive is disconnected from the system. @@ -124371,7 +127001,7 @@ its elements have been unreffed with g_object_unref(). a #GDrive that was disconnected. + line="4405">a #GDrive that was disconnected. @@ -124379,7 +127009,7 @@ its elements have been unreffed with g_object_unref(). Emitted when the eject button is pressed on @drive. + line="4411">Emitted when the eject button is pressed on @drive. @@ -124387,7 +127017,7 @@ its elements have been unreffed with g_object_unref(). the drive where the eject button was pressed + line="4414">the drive where the eject button was pressed @@ -124395,7 +127025,7 @@ its elements have been unreffed with g_object_unref(). Emitted when the stop button is pressed on @drive. + line="4422">Emitted when the stop button is pressed on @drive. @@ -124403,7 +127033,7 @@ its elements have been unreffed with g_object_unref(). the drive where the stop button was pressed + line="4425">the drive where the stop button was pressed @@ -124411,7 +127041,7 @@ its elements have been unreffed with g_object_unref(). Emitted when a mount is added. + line="4433">Emitted when a mount is added. @@ -124419,7 +127049,7 @@ its elements have been unreffed with g_object_unref(). a #GMount that was added. + line="4436">a #GMount that was added. @@ -124427,7 +127057,7 @@ its elements have been unreffed with g_object_unref(). Emitted when a mount changes. + line="4442">Emitted when a mount changes. @@ -124435,7 +127065,7 @@ its elements have been unreffed with g_object_unref(). a #GMount that changed. + line="4445">a #GMount that changed. @@ -124443,7 +127073,7 @@ its elements have been unreffed with g_object_unref(). May be emitted when a mount is about to be removed. + line="4451">May be emitted when a mount is about to be removed. This signal depends on the backend and is only emitted if GIO was used to unmount. @@ -124454,7 +127084,7 @@ GIO was used to unmount. a #GMount that is being unmounted. + line="4454">a #GMount that is being unmounted. @@ -124462,7 +127092,7 @@ GIO was used to unmount. Emitted when a mount is removed. + line="4463">Emitted when a mount is removed. @@ -124470,7 +127100,7 @@ GIO was used to unmount. a #GMount that was removed. + line="4466">a #GMount that was removed. @@ -124478,7 +127108,7 @@ GIO was used to unmount. Emitted when a mountable volume is added to the system. + line="4472">Emitted when a mountable volume is added to the system. @@ -124486,7 +127116,7 @@ GIO was used to unmount. a #GVolume that was added. + line="4475">a #GVolume that was added. @@ -124494,7 +127124,7 @@ GIO was used to unmount. Emitted when mountable volume is changed. + line="4481">Emitted when mountable volume is changed. @@ -124502,7 +127132,7 @@ GIO was used to unmount. a #GVolume that changed. + line="4484">a #GVolume that changed. @@ -124510,7 +127140,7 @@ GIO was used to unmount. Emitted when a mountable volume is removed from the system. + line="4490">Emitted when a mountable volume is removed from the system. @@ -124518,7 +127148,7 @@ GIO was used to unmount. a #GVolume that was removed. + line="4493">a #GVolume that was removed. @@ -124705,7 +127335,7 @@ GIO was used to unmount. a #GList of connected #GDrive objects. + line="42932">a #GList of connected #GDrive objects. @@ -124714,7 +127344,7 @@ GIO was used to unmount. a #GVolumeMonitor. + line="42925">a #GVolumeMonitor. @@ -124726,7 +127356,7 @@ GIO was used to unmount. a #GList of #GVolume objects. + line="42982">a #GList of #GVolume objects. @@ -124735,7 +127365,7 @@ GIO was used to unmount. a #GVolumeMonitor. + line="42975">a #GVolumeMonitor. @@ -124747,7 +127377,7 @@ GIO was used to unmount. a #GList of #GMount objects. + line="42957">a #GList of #GMount objects. @@ -124756,7 +127386,7 @@ GIO was used to unmount. a #GVolumeMonitor. + line="42950">a #GVolumeMonitor. @@ -124765,10 +127395,10 @@ GIO was used to unmount. - + a #GVolume or %NULL if no such volume is available. + line="42968">a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). @@ -124776,13 +127406,13 @@ GIO was used to unmount. a #GVolumeMonitor. + line="42963">a #GVolumeMonitor. the UUID to look for + line="42964">the UUID to look for @@ -124791,10 +127421,10 @@ GIO was used to unmount. - + a #GMount or %NULL if no such mount is available. + line="42943">a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). @@ -124802,13 +127432,13 @@ GIO was used to unmount. a #GVolumeMonitor. + line="42938">a #GVolumeMonitor. the UUID to look for + line="42939">the UUID to look for @@ -124974,7 +127604,8 @@ GIO was used to unmount. glib:type-struct="ZlibCompressorClass"> Zlib decompression + line="10218">#GZlibCompressor is an implementation of #GConverter that +compresses data using zlib. version="2.24"> Creates a new #GZlibCompressor. + line="43824">Creates a new #GZlibCompressor. a new #GZlibCompressor + line="43831">a new #GZlibCompressor The format to use for the compressed data + line="43826">The format to use for the compressed data compression level (0-9), -1 for default + line="43827">compression level (0-9), -1 for default Returns the #GZlibCompressor:file-info property. + line="43813">Returns the #GZlibCompressor:file-info property. - + a #GFileInfo, or %NULL + line="43819">a #GFileInfo, or %NULL a #GZlibCompressor + line="43815">a #GZlibCompressor Sets @file_info in @compressor. If non-%NULL, and @compressor's + line="43836">Sets @file_info in @compressor. If non-%NULL, and @compressor's #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP, it will be used to set the file name and modification time in the GZIP header of the compressed data. @@ -125048,7 +127681,7 @@ or after resetting it with g_converter_reset(). a #GZlibCompressor + line="43838">a #GZlibCompressor allow-none="1"> a #GFileInfo + line="43839">a #GFileInfo @@ -125065,10 +127698,12 @@ or after resetting it with g_converter_reset(). + transfer-ownership="none" + setter="set_file_info" + getter="get_file_info"> If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is + line="4560">If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is %G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name and modification time from the file info to the GZIP header. @@ -125106,7 +127741,8 @@ and #GZlibCompressor. + glib:nick="zlib" + glib:name="G_ZLIB_COMPRESSOR_FORMAT_ZLIB"> deflate compression with zlib header @@ -125114,7 +127750,8 @@ and #GZlibCompressor. + glib:nick="gzip" + glib:name="G_ZLIB_COMPRESSOR_FORMAT_GZIP"> gzip file format @@ -125122,7 +127759,8 @@ and #GZlibCompressor. + glib:nick="raw" + glib:name="G_ZLIB_COMPRESSOR_FORMAT_RAW"> deflate compression with no header @@ -125137,7 +127775,8 @@ and #GZlibCompressor. glib:type-struct="ZlibDecompressorClass"> Zlib decompression + line="10228">#GZlibDecompressor is an implementation of #GConverter that +decompresses data compressed with zlib. version="2.24"> Creates a new #GZlibDecompressor. + line="43869">Creates a new #GZlibDecompressor. a new #GZlibDecompressor + line="43875">a new #GZlibDecompressor The format to use for the compressed data + line="43871">The format to use for the compressed data Retrieves the #GFileInfo constructed from the GZIP header data + line="43854">Retrieves the #GFileInfo constructed from the GZIP header data of compressed data processed by @compressor, or %NULL if @decompressor's #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP, or the header data was not fully processed yet, or it not present in the data stream at all. - + a #GFileInfo, or %NULL + line="43864">a #GFileInfo, or %NULL a #GZlibDecompressor + line="43856">a #GZlibDecompressor - + A #GFileInfo containing the information found in the GZIP header + line="4578">A #GFileInfo containing the information found in the GZIP header of the data stream processed, or %NULL if the header was not yet fully processed, is not present at all, or the compressor's #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP. @@ -125218,7 +127861,7 @@ fully processed, is not present at all, or the compressor's version="2.38"> Checks if @action_name is valid. + line="11073">Checks if @action_name is valid. @action_name is valid if it consists only of alphanumeric characters, plus '-' and '.'. The empty string is not a valid action name. @@ -125229,14 +127872,14 @@ It is an error to call this function with a non-utf8 @action_name. %TRUE if @action_name is valid + line="11085">%TRUE if @action_name is valid a potential action name + line="11075">a potential action name @@ -125248,7 +127891,7 @@ It is an error to call this function with a non-utf8 @action_name. throws="1"> Parses a detailed action name into its separate name and target + line="11090">Parses a detailed action name into its separate name and target components. Detailed action names can have three formats. @@ -125276,14 +127919,14 @@ empty or contains characters other than alphanumerics, '-' and '.'. %TRUE if successful, else %FALSE with @error set + line="11122">%TRUE if successful, else %FALSE with @error set a detailed action name + line="11092">a detailed action name transfer-ownership="full"> the action name + line="11093">the action name transfer-ownership="full"> the target value, or %NULL for no target + line="11094">the target value, or %NULL for no target @@ -125312,7 +127955,7 @@ empty or contains characters other than alphanumerics, '-' and '.'. version="2.38"> Formats a detailed action name from @action_name and @target_value. + line="11127">Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. @@ -125326,14 +127969,14 @@ this function. a detailed format string + line="11143">a detailed format string a valid action name + line="11129">a valid action name allow-none="1"> a #GVariant target value, or %NULL + line="11130">a #GVariant target value, or %NULL @@ -125353,7 +127996,7 @@ this function. throws="1"> Creates a new #GAppInfo from the given information. + line="11184">Creates a new #GAppInfo from the given information. Note that for @commandline, the quoting rules of the Exec key of the [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) @@ -125364,14 +128007,14 @@ being swallowed by Exec key unquoting. See the specification for exact quoting r new #GAppInfo for given command. + line="11199">new #GAppInfo for given command. the commandline to use + line="11186">the commandline to use the application name, or %NULL to use @commandline + line="11187">the application name, or %NULL to use @commandline flags that can specify details of the created #GAppInfo + line="11188">flags that can specify details of the created #GAppInfo @@ -125396,7 +128039,7 @@ being swallowed by Exec key unquoting. See the specification for exact quoting r moved-to="AppInfo.get_all"> Gets a list of all of the applications currently registered + line="11243">Gets a list of all of the applications currently registered on this system. For desktop files, this includes applications that have @@ -125408,7 +128051,7 @@ the `Hidden` key set. a newly allocated #GList of references to #GAppInfos. + line="11255">a newly allocated #GList of references to #GAppInfos. @@ -125419,7 +128062,7 @@ the `Hidden` key set. moved-to="AppInfo.get_all_for_type"> Gets a list of all #GAppInfos for a given content type, + line="11259">Gets a list of all #GAppInfos for a given content type, including the recommended and fallback #GAppInfos. See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type(). @@ -125427,7 +128070,7 @@ g_app_info_get_fallback_for_type(). #GList of #GAppInfos + line="11268">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -125437,7 +128080,7 @@ g_app_info_get_fallback_for_type(). the content type to find a #GAppInfo for + line="11261">the content type to find a #GAppInfo for @@ -125447,12 +128090,12 @@ g_app_info_get_fallback_for_type(). moved-to="AppInfo.get_default_for_type"> Gets the default #GAppInfo for a given content type. + line="11286">Gets the default #GAppInfo for a given content type. #GAppInfo for given @content_type or + line="11294">#GAppInfo for given @content_type or %NULL on error. @@ -125460,13 +128103,13 @@ g_app_info_get_fallback_for_type(). the content type to find a #GAppInfo for + line="11288">the content type to find a #GAppInfo for if %TRUE, the #GAppInfo is expected to + line="11289">if %TRUE, the #GAppInfo is expected to support URIs @@ -125477,7 +128120,7 @@ g_app_info_get_fallback_for_type(). moved-to="AppInfo.get_default_for_uri_scheme"> Gets the default application for handling URIs with + line="11299">Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". @@ -125485,7 +128128,7 @@ of the URI, up to but not including the ':', e.g. "http", #GAppInfo for given @uri_scheme or + line="11308">#GAppInfo for given @uri_scheme or %NULL on error. @@ -125493,7 +128136,7 @@ of the URI, up to but not including the ':', e.g. "http", a string containing a URI scheme. + line="11301">a string containing a URI scheme. @@ -125504,14 +128147,14 @@ of the URI, up to but not including the ':', e.g. "http", version="2.28"> Gets a list of fallback #GAppInfos for a given content type, i.e. + line="11348">Gets a list of fallback #GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly. #GList of #GAppInfos + line="11356">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -125521,7 +128164,7 @@ by MIME type subclassing and not directly. the content type to find a #GAppInfo for + line="11350">the content type to find a #GAppInfo for @@ -125532,7 +128175,7 @@ by MIME type subclassing and not directly. version="2.28"> Gets a list of recommended #GAppInfos for a given content type, i.e. + line="11399">Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. @@ -125542,7 +128185,7 @@ called. #GList of #GAppInfos + line="11410">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -125552,7 +128195,7 @@ called. the content type to find a #GAppInfo for + line="11401">the content type to find a #GAppInfo for @@ -125563,7 +128206,7 @@ called. throws="1"> Utility function that launches the default application + line="11472">Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required. @@ -125575,14 +128218,14 @@ g_app_info_launch_default_for_uri_async() instead. %TRUE on success, %FALSE on error. + line="11487">%TRUE on success, %FALSE on error. the uri to show + line="11474">the uri to show allow-none="1"> an optional #GAppLaunchContext + line="11475">an optional #GAppLaunchContext @@ -125602,7 +128245,7 @@ g_app_info_launch_default_for_uri_async() instead. version="2.50"> Async version of g_app_info_launch_default_for_uri(). + line="11491">Async version of g_app_info_launch_default_for_uri(). This version is useful if you are interested in receiving error information in the case where the application is @@ -125620,7 +128263,7 @@ in receiving error information from their activation. the uri to show + line="11493">the uri to show allow-none="1"> an optional #GAppLaunchContext + line="11494">an optional #GAppLaunchContext allow-none="1"> a #GCancellable + line="11495">a #GCancellable closure="4"> a #GAsyncReadyCallback to call when the request is done + line="11496">a #GAsyncReadyCallback to call when the request is done allow-none="1"> data to pass to @callback + line="11497">data to pass to @callback @@ -125670,19 +128313,19 @@ in receiving error information from their activation. throws="1"> Finishes an asynchronous launch-default-for-uri operation. + line="11514">Finishes an asynchronous launch-default-for-uri operation. %TRUE if the launch was successful, %FALSE if @error is set + line="11521">%TRUE if the launch was successful, %FALSE if @error is set a #GAsyncResult + line="11516">a #GAsyncResult @@ -125693,7 +128336,7 @@ in receiving error information from their activation. version="2.20"> Removes all changes to the type associations done by + line="11611">Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or @@ -125706,7 +128349,7 @@ g_app_info_remove_supports_type(). a content type + line="11613">a content type @@ -125719,7 +128362,7 @@ g_app_info_remove_supports_type(). deprecated-version="2.54"> Helper function for constructing #GAsyncInitable object. This is + line="13045">Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -125735,25 +128378,25 @@ g_async_initable_init_async() instead. See #GParameter for more information. a #GType supporting #GAsyncInitable. + line="13047">a #GType supporting #GAsyncInitable. the number of parameters in @parameters + line="13048">the number of parameters in @parameters the parameters to use to construct the object + line="13049">the parameters to use to construct the object the [I/O priority][io-priority] of the operation + line="13050">the [I/O priority][io-priority] of the operation optional #GCancellable object, %NULL to ignore. + line="13051">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the initialization is + line="13052">a #GAsyncReadyCallback to call when the initialization is finished @@ -125783,7 +128426,7 @@ g_async_initable_init_async() instead. See #GParameter for more information. the data to pass to callback function + line="13054">the data to pass to callback function @@ -125791,7 +128434,7 @@ g_async_initable_init_async() instead. See #GParameter for more information. Asynchronously connects to the message bus specified by @bus_type. + line="13363">Asynchronously connects to the message bus specified by @bus_type. When the operation is finished, @callback will be invoked. You can then call g_bus_get_finish() to get the result of the operation. @@ -125806,7 +128449,7 @@ the synchronous version. a #GBusType + line="13365">a #GBusType allow-none="1"> a #GCancellable or %NULL + line="13366">a #GCancellable or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="13367">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> the data to pass to @callback + line="13368">the data to pass to @callback @@ -125846,7 +128489,7 @@ the synchronous version. throws="1"> Finishes an operation started with g_bus_get(). + line="13382">Finishes an operation started with g_bus_get(). The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the @@ -125860,7 +128503,7 @@ the #GDBusConnection:exit-on-close property set to %TRUE. a #GDBusConnection or %NULL if @error is set. + line="13399">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). @@ -125868,7 +128511,7 @@ the #GDBusConnection:exit-on-close property set to %TRUE. a #GAsyncResult obtained from the #GAsyncReadyCallback passed + line="13384">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get() @@ -125880,7 +128523,7 @@ the #GDBusConnection:exit-on-close property set to %TRUE. throws="1"> Synchronously connects to the message bus specified by @bus_type. + line="13405">Synchronously connects to the message bus specified by @bus_type. Note that the returned object may shared with other callers, e.g. if two separate parts of a process calls this function with the same @bus_type, they will share the same object. @@ -125900,7 +128543,7 @@ the #GDBusConnection:exit-on-close property set to %TRUE. a #GDBusConnection or %NULL if @error is set. + line="13428">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). @@ -125908,7 +128551,7 @@ the #GDBusConnection:exit-on-close property set to %TRUE. a #GBusType + line="13407">a #GBusType allow-none="1"> a #GCancellable or %NULL + line="13408">a #GCancellable or %NULL @@ -125929,7 +128572,7 @@ the #GDBusConnection:exit-on-close property set to %TRUE. introspectable="0"> Starts acquiring @name on the bus specified by @bus_type and calls + line="13434">Starts acquiring @name on the bus specified by @bus_type and calls @name_acquired_handler and @name_lost_handler when the name is acquired respectively lost. Callbacks will be invoked in the [thread-default main context][g-main-context-push-thread-default] @@ -125982,7 +128625,7 @@ unregister the objects (if any) in @name_lost_handler. an identifier (never 0) that can be used with + line="13495">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name. @@ -125990,19 +128633,19 @@ unregister the objects (if any) in @name_lost_handler. the type of bus to own a name on + line="13436">the type of bus to own a name on the well-known name to own + line="13437">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + line="13438">a set of flags from the #GBusNameOwnerFlags enumeration allow-none="1"> handler to invoke when connected to the bus of type @bus_type or %NULL + line="13439">handler to invoke when connected to the bus of type @bus_type or %NULL allow-none="1"> handler to invoke when @name is acquired or %NULL + line="13440">handler to invoke when @name is acquired or %NULL @@ -126033,7 +128676,7 @@ unregister the objects (if any) in @name_lost_handler. destroy="7"> handler to invoke when @name is lost or %NULL + line="13441">handler to invoke when @name is lost or %NULL allow-none="1"> user data to pass to handlers + line="13442">user data to pass to handlers scope="async"> function for freeing @user_data or %NULL + line="13443">function for freeing @user_data or %NULL @@ -126064,13 +128707,13 @@ unregister the objects (if any) in @name_lost_handler. introspectable="0"> Like g_bus_own_name() but takes a #GDBusConnection instead of a + line="13501">Like g_bus_own_name() but takes a #GDBusConnection instead of a #GBusType. an identifier (never 0) that can be used with + line="13514">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name @@ -126078,19 +128721,19 @@ unregister the objects (if any) in @name_lost_handler. a #GDBusConnection + line="13503">a #GDBusConnection the well-known name to own + line="13504">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + line="13505">a set of flags from the #GBusNameOwnerFlags enumeration allow-none="1"> handler to invoke when @name is acquired or %NULL + line="13506">handler to invoke when @name is acquired or %NULL @@ -126112,7 +128755,7 @@ unregister the objects (if any) in @name_lost_handler. destroy="6"> handler to invoke when @name is lost or %NULL + line="13507">handler to invoke when @name is lost or %NULL allow-none="1"> user data to pass to handlers + line="13508">user data to pass to handlers scope="async"> function for freeing @user_data or %NULL + line="13509">function for freeing @user_data or %NULL @@ -126142,13 +128785,13 @@ unregister the objects (if any) in @name_lost_handler. version="2.26"> Version of g_bus_own_name_on_connection() using closures instead of + line="13520">Version of g_bus_own_name_on_connection() using closures instead of callbacks for easier binding in other languages. an identifier (never 0) that can be used with + line="13533">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name. @@ -126156,19 +128799,19 @@ callbacks for easier binding in other languages. a #GDBusConnection + line="13522">a #GDBusConnection the well-known name to own + line="13523">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + line="13524">a set of flags from the #GBusNameOwnerFlags enumeration allow-none="1"> #GClosure to invoke when @name is + line="13525">#GClosure to invoke when @name is acquired or %NULL @@ -126187,7 +128830,7 @@ callbacks for easier binding in other languages. allow-none="1"> #GClosure to invoke when @name is lost + line="13527">#GClosure to invoke when @name is lost or %NULL @@ -126199,13 +128842,13 @@ callbacks for easier binding in other languages. version="2.26"> Version of g_bus_own_name() using closures instead of callbacks for + line="13539">Version of g_bus_own_name() using closures instead of callbacks for easier binding in other languages. an identifier (never 0) that can be used with + line="13554">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name. @@ -126213,19 +128856,19 @@ easier binding in other languages. the type of bus to own a name on + line="13541">the type of bus to own a name on the well-known name to own + line="13542">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + line="13543">a set of flags from the #GBusNameOwnerFlags enumeration allow-none="1"> #GClosure to invoke when connected to + line="13544">#GClosure to invoke when connected to the bus of type @bus_type or %NULL @@ -126244,7 +128887,7 @@ easier binding in other languages. allow-none="1"> #GClosure to invoke when @name is + line="13546">#GClosure to invoke when @name is acquired or %NULL @@ -126254,7 +128897,7 @@ easier binding in other languages. allow-none="1"> #GClosure to invoke when @name is lost or + line="13548">#GClosure to invoke when @name is lost or %NULL @@ -126265,7 +128908,7 @@ easier binding in other languages. version="2.26"> Stops owning a name. + line="13560">Stops owning a name. Note that there may still be D-Bus traffic to process (relating to owning and unowning the name) in the current thread-default #GMainContext after @@ -126281,7 +128924,7 @@ after it’s stopped being iterated. an identifier obtained from g_bus_own_name() + line="13562">an identifier obtained from g_bus_own_name() @@ -126291,7 +128934,7 @@ after it’s stopped being iterated. version="2.26"> Stops watching a name. + line="13577">Stops watching a name. Note that there may still be D-Bus traffic to process (relating to watching and unwatching the name) in the current thread-default #GMainContext after @@ -126307,7 +128950,7 @@ after it’s stopped being iterated. An identifier obtained from g_bus_watch_name() + line="13579">An identifier obtained from g_bus_watch_name() @@ -126319,7 +128962,7 @@ after it’s stopped being iterated. introspectable="0"> Starts watching @name on the bus specified by @bus_type and calls + line="13594">Starts watching @name on the bus specified by @bus_type and calls @name_appeared_handler and @name_vanished_handler when the name is known to have an owner respectively known to lose its owner. Callbacks will be invoked in the @@ -126352,7 +128995,7 @@ Basically, the application should create object proxies in An identifier (never 0) that can be used with + line="13634">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. @@ -126360,19 +129003,19 @@ g_bus_unwatch_name() to stop watching the name. The type of bus to watch a name on. + line="13596">The type of bus to watch a name on. The name (well-known or unique) to watch. + line="13597">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + line="13598">Flags from the #GBusNameWatcherFlags enumeration. allow-none="1"> Handler to invoke when @name is known to exist or %NULL. + line="13599">Handler to invoke when @name is known to exist or %NULL. @@ -126394,7 +129037,7 @@ g_bus_unwatch_name() to stop watching the name. destroy="6"> Handler to invoke when @name is known to not exist or %NULL. + line="13600">Handler to invoke when @name is known to not exist or %NULL. @@ -126404,7 +129047,7 @@ g_bus_unwatch_name() to stop watching the name. allow-none="1"> User data to pass to handlers. + line="13601">User data to pass to handlers. scope="async"> Function for freeing @user_data or %NULL. + line="13602">Function for freeing @user_data or %NULL. @@ -126426,13 +129069,13 @@ g_bus_unwatch_name() to stop watching the name. introspectable="0"> Like g_bus_watch_name() but takes a #GDBusConnection instead of a + line="13640">Like g_bus_watch_name() but takes a #GDBusConnection instead of a #GBusType. An identifier (never 0) that can be used with + line="13653">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. @@ -126440,19 +129083,19 @@ g_bus_unwatch_name() to stop watching the name. A #GDBusConnection. + line="13642">A #GDBusConnection. The name (well-known or unique) to watch. + line="13643">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + line="13644">Flags from the #GBusNameWatcherFlags enumeration. allow-none="1"> Handler to invoke when @name is known to exist or %NULL. + line="13645">Handler to invoke when @name is known to exist or %NULL. @@ -126474,7 +129117,7 @@ g_bus_unwatch_name() to stop watching the name. destroy="6"> Handler to invoke when @name is known to not exist or %NULL. + line="13646">Handler to invoke when @name is known to not exist or %NULL. @@ -126484,7 +129127,7 @@ g_bus_unwatch_name() to stop watching the name. allow-none="1"> User data to pass to handlers. + line="13647">User data to pass to handlers. scope="async"> Function for freeing @user_data or %NULL. + line="13648">Function for freeing @user_data or %NULL. @@ -126505,13 +129148,13 @@ g_bus_unwatch_name() to stop watching the name. version="2.26"> Version of g_bus_watch_name_on_connection() using closures instead of callbacks for + line="13659">Version of g_bus_watch_name_on_connection() using closures instead of callbacks for easier binding in other languages. An identifier (never 0) that can be used with + line="13672">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. @@ -126519,19 +129162,19 @@ g_bus_unwatch_name() to stop watching the name. A #GDBusConnection. + line="13661">A #GDBusConnection. The name (well-known or unique) to watch. + line="13662">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + line="13663">Flags from the #GBusNameWatcherFlags enumeration. allow-none="1"> #GClosure to invoke when @name is known + line="13664">#GClosure to invoke when @name is known to exist or %NULL. @@ -126550,7 +129193,7 @@ to exist or %NULL. allow-none="1"> #GClosure to invoke when @name is known + line="13666">#GClosure to invoke when @name is known to not exist or %NULL. @@ -126562,13 +129205,13 @@ to not exist or %NULL. version="2.26"> Version of g_bus_watch_name() using closures instead of callbacks for + line="13678">Version of g_bus_watch_name() using closures instead of callbacks for easier binding in other languages. An identifier (never 0) that can be used with + line="13691">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. @@ -126576,19 +129219,19 @@ g_bus_unwatch_name() to stop watching the name. The type of bus to watch a name on. + line="13680">The type of bus to watch a name on. The name (well-known or unique) to watch. + line="13681">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + line="13682">Flags from the #GBusNameWatcherFlags enumeration. allow-none="1"> #GClosure to invoke when @name is known + line="13683">#GClosure to invoke when @name is known to exist or %NULL. @@ -126607,7 +129250,7 @@ to exist or %NULL. allow-none="1"> #GClosure to invoke when @name is known + line="13685">#GClosure to invoke when @name is known to not exist or %NULL. @@ -126617,13 +129260,13 @@ to not exist or %NULL. c:identifier="g_content_type_can_be_executable"> Checks if a content type can be executable. Note that for instance + line="14029">Checks if a content type can be executable. Note that for instance things like text files can be executables (i.e. scripts and batch files). %TRUE if the file type corresponds to a type that + line="14036">%TRUE if the file type corresponds to a type that can be executable, %FALSE otherwise. @@ -126631,7 +129274,7 @@ things like text files can be executables (i.e. scripts and batch files). a content type string + line="14031">a content type string @@ -126639,12 +129282,12 @@ things like text files can be executables (i.e. scripts and batch files). Compares two content types for equality. + line="14041">Compares two content types for equality. %TRUE if the two strings are identical or equivalent, + line="14048">%TRUE if the two strings are identical or equivalent, %FALSE otherwise. @@ -126652,13 +129295,13 @@ things like text files can be executables (i.e. scripts and batch files). a content type string + line="14043">a content type string a content type string + line="14044">a content type string @@ -126668,12 +129311,12 @@ things like text files can be executables (i.e. scripts and batch files). version="2.18"> Tries to find a content type based on the mime type name. + line="14053">Tries to find a content type based on the mime type name. Newly allocated string with content type or + line="14059">Newly allocated string with content type or %NULL. Free with g_free() @@ -126681,7 +129324,7 @@ things like text files can be executables (i.e. scripts and batch files). a mime type string + line="14055">a mime type string @@ -126690,12 +129333,12 @@ things like text files can be executables (i.e. scripts and batch files). c:identifier="g_content_type_get_description"> Gets the human readable description of the content type. + line="14065">Gets the human readable description of the content type. a short description of the content type @type. Free the + line="14071">a short description of the content type @type. Free the returned string with g_free() @@ -126703,7 +129346,7 @@ things like text files can be executables (i.e. scripts and batch files). a content type string + line="14067">a content type string @@ -126713,7 +129356,7 @@ things like text files can be executables (i.e. scripts and batch files). version="2.34"> Gets the generic icon name for a content type. + line="14076">Gets the generic icon name for a content type. See the [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) @@ -126722,7 +129365,7 @@ specification for more on the generic icon name. the registered generic icon name for the given @type, + line="14086">the registered generic icon name for the given @type, or %NULL if unknown. Free with g_free() @@ -126730,7 +129373,7 @@ specification for more on the generic icon name. a content type string + line="14078">a content type string @@ -126739,12 +129382,12 @@ specification for more on the generic icon name. c:identifier="g_content_type_get_icon"> Gets the icon for a content type. + line="14092">Gets the icon for a content type. #GIcon corresponding to the content type. Free the returned + line="14098">#GIcon corresponding to the content type. Free the returned object with g_object_unref() @@ -126752,7 +129395,7 @@ specification for more on the generic icon name. a content type string + line="14094">a content type string @@ -126762,13 +129405,13 @@ specification for more on the generic icon name. version="2.60"> Get the list of directories which MIME data is loaded from. See + line="14103">Get the list of directories which MIME data is loaded from. See g_content_type_set_mime_dirs() for details. %NULL-terminated list of + line="14109">%NULL-terminated list of directories to load MIME data from, including any `mime/` subdirectory, and with the first directory to try listed first @@ -126780,12 +129423,12 @@ g_content_type_set_mime_dirs() for details. c:identifier="g_content_type_get_mime_type"> Gets the mime type for the content type, if one is registered. + line="14116">Gets the mime type for the content type, if one is registered. the registered mime type for the + line="14122">the registered mime type for the given @type, or %NULL if unknown; free with g_free(). @@ -126793,7 +129436,7 @@ g_content_type_set_mime_dirs() for details. a content type string + line="14118">a content type string @@ -126803,12 +129446,12 @@ g_content_type_set_mime_dirs() for details. version="2.34"> Gets the symbolic icon for a content type. + line="14127">Gets the symbolic icon for a content type. symbolic #GIcon corresponding to the content type. + line="14133">symbolic #GIcon corresponding to the content type. Free the returned object with g_object_unref() @@ -126816,7 +129459,7 @@ g_content_type_set_mime_dirs() for details. a content type string + line="14129">a content type string @@ -126824,7 +129467,7 @@ g_content_type_set_mime_dirs() for details. Guesses the content type based on example data. If the function is + line="14139">Guesses the content type based on example data. If the function is uncertain, @result_uncertain will be set to %TRUE. Either @filename or @data may be %NULL, in which case the guess will be based solely on the other argument. @@ -126832,7 +129475,7 @@ on the other argument. a string indicating a guessed content type for the + line="14152">a string indicating a guessed content type for the given data. Free with g_free() @@ -126843,7 +129486,7 @@ on the other argument. allow-none="1"> a string, or %NULL + line="14141">a string, or %NULL allow-none="1"> a stream of data, or %NULL + line="14142">a stream of data, or %NULL @@ -126860,7 +129503,7 @@ on the other argument. the size of @data + line="14143">the size of @data allow-none="1"> return location for the certainty + line="14144">return location for the certainty of the result, or %NULL @@ -126882,7 +129525,7 @@ on the other argument. version="2.18"> Tries to guess the type of the tree with root @root, by + line="14157">Tries to guess the type of the tree with root @root, by looking at the files it contains. The result is an array of content types, with the best guess coming first. @@ -126898,7 +129541,7 @@ g_mount_guess_content_type(). an %NULL-terminated + line="14174">an %NULL-terminated array of zero or more content types. Free with g_strfreev() @@ -126908,7 +129551,7 @@ g_mount_guess_content_type(). the root of the tree to guess a type for + line="14159">the root of the tree to guess a type for @@ -126916,12 +129559,12 @@ g_mount_guess_content_type(). Determines if @type is a subset of @supertype. + line="14180">Determines if @type is a subset of @supertype. %TRUE if @type is a kind of @supertype, + line="14187">%TRUE if @type is a kind of @supertype, %FALSE otherwise. @@ -126929,13 +129572,13 @@ g_mount_guess_content_type(). a content type string + line="14182">a content type string a content type string + line="14183">a content type string @@ -126945,13 +129588,13 @@ g_mount_guess_content_type(). version="2.52"> Determines if @type is a subset of @mime_type. + line="14192">Determines if @type is a subset of @mime_type. Convenience wrapper around g_content_type_is_a(). %TRUE if @type is a kind of @mime_type, + line="14200">%TRUE if @type is a kind of @mime_type, %FALSE otherwise. @@ -126959,13 +129602,13 @@ Convenience wrapper around g_content_type_is_a(). a content type string + line="14194">a content type string a mime type string + line="14195">a mime type string @@ -126974,7 +129617,7 @@ Convenience wrapper around g_content_type_is_a(). c:identifier="g_content_type_is_unknown"> Checks if the content type is the generic "unknown" type. + line="14206">Checks if the content type is the generic "unknown" type. On UNIX this is the "application/octet-stream" mimetype, while on win32 it is "*" and on OSX it is a dynamic type or octet-stream. @@ -126982,14 +129625,14 @@ or octet-stream. %TRUE if the type is the unknown type. + line="14215">%TRUE if the type is the unknown type. a content type string + line="14208">a content type string @@ -126999,7 +129642,7 @@ or octet-stream. version="2.60"> Set the list of directories used by GIO to load the MIME database. + line="14219">Set the list of directories used by GIO to load the MIME database. If @dirs is %NULL, the directories used are the default: - the `mime` subdirectory of the directory in `$XDG_DATA_HOME` @@ -127033,7 +129676,7 @@ with @dirs set to %NULL before calling g_test_init(), for instance: allow-none="1"> %NULL-terminated list of + line="14221">%NULL-terminated list of directories to load MIME data from, including any `mime/` subdirectory, and with the first directory to try listed first @@ -127046,14 +129689,14 @@ with @dirs set to %NULL before calling g_test_init(), for instance: c:identifier="g_content_types_get_registered"> Gets a list of strings containing all the registered content types + line="14253">Gets a list of strings containing all the registered content types known to the system. The list and its data should be freed using `g_list_free_full (list, g_free)`. list of the registered + line="14260">list of the registered content types @@ -127065,7 +129708,7 @@ known to the system. The list and its data should be freed using version="2.36"> Escape @string so it can appear in a D-Bus address as the value + line="15392">Escape @string so it can appear in a D-Bus address as the value part of a key-value pair. For instance, if @string is `/run/bus-for-:0`, @@ -127076,7 +129719,7 @@ which could be used in a D-Bus address like a copy of @string with all + line="15405">a copy of @string with all non-optionally-escaped bytes escaped @@ -127084,7 +129727,7 @@ which could be used in a D-Bus address like an unescaped string to be included in a D-Bus address + line="15394">an unescaped string to be included in a D-Bus address as the value in a key-value pair @@ -127096,7 +129739,7 @@ which could be used in a D-Bus address like throws="1"> Synchronously looks up the D-Bus address for the well-known message + line="15411">Synchronously looks up the D-Bus address for the well-known message bus instance specified by @bus_type. This may involve using various platform specific mechanisms. @@ -127106,7 +129749,7 @@ The returned address will be in the a valid D-Bus address string for @bus_type or + line="15424">a valid D-Bus address string for @bus_type or %NULL if @error is set @@ -127114,7 +129757,7 @@ The returned address will be in the a #GBusType + line="15413">a #GBusType a #GCancellable or %NULL + line="15414">a #GCancellable or %NULL @@ -127133,7 +129776,7 @@ The returned address will be in the version="2.26"> Asynchronously connects to an endpoint specified by @address and + line="15430">Asynchronously connects to an endpoint specified by @address and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation. @address must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -127152,7 +129795,7 @@ g_dbus_address_get_stream_sync() for the synchronous version. A valid D-Bus address. + line="15432">A valid D-Bus address. allow-none="1"> A #GCancellable or %NULL. + line="15433">A #GCancellable or %NULL. closure="3"> A #GAsyncReadyCallback to call when the request is satisfied. + line="15434">A #GAsyncReadyCallback to call when the request is satisfied. allow-none="1"> Data to pass to @callback. + line="15435">Data to pass to @callback. @@ -127192,30 +129835,34 @@ g_dbus_address_get_stream_sync() for the synchronous version. throws="1"> Finishes an operation started with g_dbus_address_get_stream(). + line="15453">Finishes an operation started with g_dbus_address_get_stream(). + +A server is not required to set a GUID, so @out_guid may be set to %NULL +even on success. A #GIOStream or %NULL if @error is set. + line="15464">A #GIOStream or %NULL if @error is set. A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream(). + line="15455">A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream(). %NULL or return location to store the GUID extracted from @address, if any. + line="15456">%NULL or return location to store the GUID extracted from @address, if any. @@ -127226,36 +129873,40 @@ g_dbus_address_get_stream_sync() for the synchronous version. throws="1"> Synchronously connects to an endpoint specified by @address and + line="15469">Synchronously connects to an endpoint specified by @address and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation. @address must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). +A server is not required to set a GUID, so @out_guid may be set to %NULL +even on success. + This is a synchronous failable function. See g_dbus_address_get_stream() for the asynchronous version. A #GIOStream or %NULL if @error is set. + line="15487">A #GIOStream or %NULL if @error is set. A valid D-Bus address. + line="15471">A valid D-Bus address. %NULL or return location to store the GUID extracted from @address, if any. + line="15472">%NULL or return location to store the GUID extracted from @address, if any. allow-none="1"> A #GCancellable or %NULL. + line="15473">A #GCancellable or %NULL. @@ -127275,14 +129926,14 @@ g_dbus_address_get_stream() for the asynchronous version. version="2.26"> Looks up the value of an annotation. + line="15492">Looks up the value of an annotation. The cost of this function is O(n) in number of annotations. - + The value or %NULL if not found. Do not free, it is owned by @annotations. + line="15501">The value or %NULL if not found. Do not free, it is owned by @annotations. @@ -127292,7 +129943,7 @@ The cost of this function is O(n) in number of annotations. allow-none="1"> A %NULL-terminated array of annotations or %NULL. + line="15494">A %NULL-terminated array of annotations or %NULL. @@ -127300,7 +129951,7 @@ The cost of this function is O(n) in number of annotations. The name of the annotation to look up. + line="15495">The name of the annotation to look up. @@ -127311,7 +129962,7 @@ The cost of this function is O(n) in number of annotations. version="2.26"> Creates a D-Bus error name to use for @error. If @error matches + line="16862">Creates a D-Bus error name to use for @error. If @error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned. @@ -127326,14 +129977,15 @@ This function is typically only used in object mappings to put a A D-Bus error name (never %NULL). Free with g_free(). + line="16878">A D-Bus error name (never %NULL). + Free with g_free(). A #GError. + line="16864">A #GError. @@ -127344,25 +129996,25 @@ This function is typically only used in object mappings to put a version="2.26"> Gets the D-Bus error name used for @error, if any. + line="16884">Gets the D-Bus error name used for @error, if any. This function is guaranteed to return a D-Bus error name for all #GErrors returned from functions handling remote method calls (e.g. g_dbus_connection_call_finish()) unless g_dbus_error_strip_remote_error() has been used on @error. - + an allocated string or %NULL if the D-Bus error name - could not be found. Free with g_free(). + line="16895">an allocated string or %NULL if the + D-Bus error name could not be found. Free with g_free(). a #GError + line="16886">a #GError @@ -127373,13 +130025,13 @@ g_dbus_error_strip_remote_error() has been used on @error. version="2.26"> Checks if @error represents an error received via D-Bus from a remote peer. If so, + line="16901">Checks if @error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error. %TRUE if @error represents an error from a remote peer, + line="16908">%TRUE if @error represents an error from a remote peer, %FALSE otherwise. @@ -127387,7 +130039,7 @@ use g_dbus_error_get_remote_error() to get the name of the error. A #GError. + line="16903">A #GError. @@ -127398,7 +130050,7 @@ use g_dbus_error_get_remote_error() to get the name of the error. version="2.26"> Creates a #GError based on the contents of @dbus_error_name and + line="16914">Creates a #GError based on the contents of @dbus_error_name and @dbus_error_message. Errors registered with g_dbus_error_register_error() will be looked @@ -127428,20 +130080,20 @@ it. An allocated #GError. Free with g_error_free(). + line="16946">An allocated #GError. Free with g_error_free(). D-Bus error name. + line="16916">D-Bus error name. D-Bus error message. + line="16917">D-Bus error message. @@ -127459,7 +130111,7 @@ it. version="2.26"> Creates an association to map between @dbus_error_name and + line="16951">Creates an association to map between @dbus_error_name and #GErrors specified by @error_domain and @error_code. This is typically done in the routine that returns the #GQuark for @@ -127468,7 +130120,7 @@ an error domain. %TRUE if the association was created, %FALSE if it already + line="16963">%TRUE if the association was created, %FALSE if it already exists. @@ -127476,19 +130128,19 @@ exists. A #GQuark for an error domain. + line="16953">A #GQuark for an error domain. An error code. + line="16954">An error code. A D-Bus error name. + line="16955">A D-Bus error name. @@ -127499,7 +130151,10 @@ exists. version="2.26"> Helper function for associating a #GError error domain with D-Bus error names. + line="16969">Helper function for associating a #GError error domain with D-Bus error names. + +While @quark_volatile has a `volatile` qualifier, this is a historical +artifact and the argument passed to it should not be `volatile`. @@ -127508,19 +130163,19 @@ exists. The error domain name. + line="16971">The error domain name. A pointer where to store the #GQuark. + line="16972">A pointer where to store the #GQuark. A pointer to @num_entries #GDBusErrorEntry struct items. + line="16973">A pointer to @num_entries #GDBusErrorEntry struct items. @@ -127530,7 +130185,7 @@ exists. Number of items to register. + line="16974">Number of items to register. @@ -127541,7 +130196,7 @@ exists. version="2.26"> Looks for extra information in the error message used to recover + line="17015">Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in @error will correspond exactly to what was received on the wire. @@ -127551,14 +130206,14 @@ This is typically used when presenting errors to the end user. %TRUE if information was stripped, %FALSE otherwise. + line="17026">%TRUE if information was stripped, %FALSE otherwise. A #GError. + line="17017">A #GError. @@ -127569,50 +130224,117 @@ This is typically used when presenting errors to the end user. version="2.26"> Destroys an association previously set up with g_dbus_error_register_error(). + line="17031">Destroys an association previously set up with g_dbus_error_register_error(). %TRUE if the association was destroyed, %FALSE if it wasn't found. + line="17039">%TRUE if the association was destroyed, %FALSE if it wasn't found. A #GQuark for an error domain. + line="17033">A #GQuark for an error domain. An error code. + line="17034">An error code. A D-Bus error name. + line="17035">A D-Bus error name. + + This is a language binding friendly version of g_dbus_escape_object_path_bytestring(). + + + an escaped version of @s. Free with g_free(). + + + + + the string to escape + + + + + + Escapes @bytes for use in a D-Bus object path component. +@bytes is an array of zero or more nonzero bytes in an +unspecified encoding, followed by a single zero byte. + +The escaping method consists of replacing all non-alphanumeric +characters (see g_ascii_isalnum()) with their hexadecimal value +preceded by an underscore (`_`). For example: +`foo.bar.baz` will become `foo_2ebar_2ebaz`. + +This method is appropriate to use when the input is nearly +a valid object path component but is not when your input +is far from being a valid object path component. +Other escaping algorithms are also valid to use with +D-Bus object paths. + +This can be reversed with g_dbus_unescape_object_path(). + + + an escaped version of @bytes. Free with g_free(). + + + + + the string of bytes to escape + + + + + + Generate a D-Bus GUID that can be used with + line="17081">Generate a D-Bus GUID that can be used with e.g. g_dbus_connection_new(). -See the D-Bus specification regarding what strings are valid D-Bus -GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). +See the +[D-Bus specification](https://dbus.freedesktop.org/doc/dbus-specification.html#uuids) +regarding what strings are valid D-Bus GUIDs. The specification refers to +these as ‘UUIDs’ whereas GLib (for historical reasons) refers to them as +‘GUIDs’. The terms are interchangeable. + +Note that D-Bus GUIDs do not follow +[RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122). A valid D-Bus GUID. Free with g_free(). + line="17096">A valid D-Bus GUID. Free with g_free(). @@ -127621,7 +130343,7 @@ GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). version="2.30"> Converts a #GValue to a #GVariant of the type indicated by the @type + line="17101">Converts a #GValue to a #GVariant of the type indicated by the @type parameter. The conversion is using the following rules: @@ -127649,26 +130371,26 @@ returned (e.g. 0 for scalar types, the empty string for string types, See the g_dbus_gvariant_to_gvalue() function for how to convert a #GVariant to a #GValue. - + A #GVariant (never floating) of #GVariantType @type holding - the data from @gvalue or %NULL in case of failure. Free with - g_variant_unref(). + line="17135">A #GVariant (never floating) of + #GVariantType @type holding the data from @gvalue or an empty #GVariant + in case of failure. Free with g_variant_unref(). A #GValue to convert to a #GVariant + line="17103">A #GValue to convert to a #GVariant A #GVariantType + line="17104">A #GVariantType @@ -127678,7 +130400,7 @@ See the g_dbus_gvariant_to_gvalue() function for how to convert a version="2.30"> Converts a #GVariant to a #GValue. If @value is floating, it is consumed. + line="17142">Converts a #GVariant to a #GValue. If @value is floating, it is consumed. The rules specified in the g_dbus_gvalue_to_gvariant() function are used - this function is essentially its reverse form. So, a #GVariant @@ -127689,7 +130411,7 @@ variant, tuple, dict entry) will be converted to a #GValue containing that The conversion never fails - a valid #GValue is always returned in @out_gvalue. - + @@ -127697,7 +130419,7 @@ The conversion never fails - a valid #GValue is always returned in A #GVariant. + line="17144">A #GVariant. Return location pointing to a zero-filled (uninitialized) #GValue. + line="17145">Return location pointing to a zero-filled (uninitialized) #GValue. @@ -127716,7 +130438,7 @@ The conversion never fails - a valid #GValue is always returned in version="2.26"> Checks if @string is a + line="17509">Checks if @string is a [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). This doesn't check if @string is actually supported by #GDBusServer @@ -127726,14 +130448,40 @@ checks. %TRUE if @string is a valid D-Bus address, %FALSE otherwise. + line="17520">%TRUE if @string is a valid D-Bus address, %FALSE otherwise. A string. + line="17511">A string. + + + + + + Check whether @string is a valid D-Bus error name. + +This function returns the same result as g_dbus_is_interface_name(), +because D-Bus error names are defined to have exactly the +same syntax as interface names. + + + %TRUE if valid, %FALSE otherwise. + + + + + The string to check. @@ -127741,22 +130489,22 @@ checks. Checks if @string is a D-Bus GUID. + line="17540">Checks if @string is a D-Bus GUID. -See the D-Bus specification regarding what strings are valid D-Bus -GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). +See the documentation for g_dbus_generate_guid() for more information about +the format of a GUID. %TRUE if @string is a guid, %FALSE otherwise. + line="17549">%TRUE if @string is a GUID, %FALSE otherwise. The string to check. + line="17542">The string to check. @@ -127766,19 +130514,19 @@ GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). version="2.26"> Checks if @string is a valid D-Bus interface name. + line="17554">Checks if @string is a valid D-Bus interface name. %TRUE if valid, %FALSE otherwise. + line="17560">%TRUE if valid, %FALSE otherwise. The string to check. + line="17556">The string to check. @@ -127788,19 +130536,19 @@ GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). version="2.26"> Checks if @string is a valid D-Bus member (e.g. signal or method) name. + line="17565">Checks if @string is a valid D-Bus member (e.g. signal or method) name. %TRUE if valid, %FALSE otherwise. + line="17571">%TRUE if valid, %FALSE otherwise. The string to check. + line="17567">The string to check. @@ -127808,19 +130556,19 @@ GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). Checks if @string is a valid D-Bus bus name (either unique or well-known). + line="17576">Checks if @string is a valid D-Bus bus name (either unique or well-known). %TRUE if valid, %FALSE otherwise. + line="17582">%TRUE if valid, %FALSE otherwise. The string to check. + line="17578">The string to check. @@ -127831,7 +130579,7 @@ GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). throws="1"> Like g_dbus_is_address() but also checks if the library supports the + line="17587">Like g_dbus_is_address() but also checks if the library supports the transports in @string and that key/value pairs for each transport are valid. See the specification of the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -127839,7 +130587,7 @@ are valid. See the specification of the %TRUE if @string is a valid D-Bus address that is + line="17597">%TRUE if @string is a valid D-Bus address that is supported by this library, %FALSE if @error is set. @@ -127847,7 +130595,7 @@ supported by this library, %FALSE if @error is set. A string. + line="17589">A string. @@ -127857,19 +130605,52 @@ supported by this library, %FALSE if @error is set. version="2.26"> Checks if @string is a valid D-Bus unique bus name. + line="17603">Checks if @string is a valid D-Bus unique bus name. %TRUE if valid, %FALSE otherwise. + line="17609">%TRUE if valid, %FALSE otherwise. The string to check. + line="17605">The string to check. + + + + + + Unescapes an string that was previously escaped with +g_dbus_escape_object_path(). If the string is in a format that could +not have been returned by g_dbus_escape_object_path(), this function +returns %NULL. + +Encoding alphanumeric characters which do not need to be +encoded is not allowed (e.g `_63` is not valid, the string +should contain `c` instead). + + + an + unescaped version of @s, or %NULL if @s is not a string returned + from g_dbus_escape_object_path(). Free with g_free(). + + + + + + + the string to unescape @@ -127881,13 +130662,13 @@ supported by this library, %FALSE if @error is set. throws="1"> Creates a new #GDtlsClientConnection wrapping @base_socket which is + line="20742">Creates a new #GDtlsClientConnection wrapping @base_socket which is assumed to communicate with the server identified by @server_identity. the new + line="20751">the new #GDtlsClientConnection, or %NULL on error @@ -127895,7 +130676,7 @@ assumed to communicate with the server identified by @server_identity. the #GDatagramBased to wrap + line="20744">the #GDatagramBased to wrap allow-none="1"> the expected identity of the server + line="20745">the expected identity of the server @@ -127916,12 +130697,12 @@ assumed to communicate with the server identified by @server_identity. throws="1"> Creates a new #GDtlsServerConnection wrapping @base_socket. + line="21292">Creates a new #GDtlsServerConnection wrapping @base_socket. the new + line="21300">the new #GDtlsServerConnection, or %NULL on error @@ -127929,7 +130710,7 @@ assumed to communicate with the server identified by @server_identity. the #GDatagramBased to wrap + line="21294">the #GDatagramBased to wrap allow-none="1"> the default server certificate, or %NULL + line="21295">the default server certificate, or %NULL @@ -127946,7 +130727,7 @@ assumed to communicate with the server identified by @server_identity. #GIOExtensionPoint provides a mechanism for modules to extend the + line="4624">#GIOExtensionPoint provides a mechanism for modules to extend the functionality of the library or application that loaded it in an organized fashion. @@ -128003,7 +130784,7 @@ g_io_extension_point_implement() to implement an extension point. moved-to="File.new_for_commandline_arg"> Creates a #GFile with the given argument from the command line. + line="24411">Creates a #GFile with the given argument from the command line. The value of @arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not @@ -128021,7 +130802,7 @@ for you there. It is also always possible to use this function with a new #GFile. + line="24430">a new #GFile. Free the returned object with g_object_unref(). @@ -128029,7 +130810,7 @@ for you there. It is also always possible to use this function with a command line string + line="24413">a command line string @@ -128040,7 +130821,7 @@ for you there. It is also always possible to use this function with version="2.36"> Creates a #GFile with the given argument from the command line. + line="24435">Creates a #GFile with the given argument from the command line. This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an @@ -128055,20 +130836,20 @@ See also g_application_command_line_create_file_for_arg(). a new #GFile + line="24452">a new #GFile a command line string + line="24437">a command line string the current working directory of the commandline + line="24438">the current working directory of the commandline @@ -128078,14 +130859,14 @@ See also g_application_command_line_create_file_for_arg(). moved-to="File.new_for_path"> Constructs a #GFile for a given path. This operation never + line="24457">Constructs a #GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if @path is malformed. a new #GFile for the given @path. + line="24466">a new #GFile for the given @path. Free the returned object with g_object_unref(). @@ -128093,7 +130874,7 @@ operation if @path is malformed. a string containing a relative or absolute path. + line="24459">a string containing a relative or absolute path. The string must be encoded in the glib filename encoding. @@ -128104,7 +130885,7 @@ operation if @path is malformed. moved-to="File.new_for_uri"> Constructs a #GFile for a given URI. This operation never + line="24471">Constructs a #GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if @uri is malformed or if the uri type is not supported. @@ -128112,7 +130893,7 @@ not supported. a new #GFile for the given @uri. + line="24480">a new #GFile for the given @uri. Free the returned object with g_object_unref(). @@ -128120,7 +130901,7 @@ not supported. a UTF-8 string containing a URI + line="24473">a UTF-8 string containing a URI @@ -128132,7 +130913,7 @@ not supported. throws="1"> Opens a file in the preferred directory for temporary files (as + line="24485">Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it. @@ -128146,7 +130927,7 @@ a temporary file could not be created. a new #GFile. + line="24503">a new #GFile. Free the returned object with g_object_unref(). @@ -128157,7 +130938,7 @@ a temporary file could not be created. allow-none="1"> Template for the file + line="24487">Template for the file name, as in g_file_open_tmp(), or %NULL for a default template @@ -128167,7 +130948,7 @@ a temporary file could not be created. transfer-ownership="full"> on return, a #GFileIOStream for the created file + line="24489">on return, a #GFileIOStream for the created file @@ -128177,7 +130958,7 @@ a temporary file could not be created. moved-to="File.parse_name"> Constructs a #GFile with the given @parse_name (i.e. something + line="24648">Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the @parse_name cannot be parsed. @@ -128185,14 +130966,14 @@ the @parse_name cannot be parsed. a new #GFile. + line="24657">a new #GFile. a file name or path to be parsed + line="24650">a file name or path to be parsed @@ -128200,7 +130981,7 @@ the @parse_name cannot be parsed. These functions support exporting a #GActionGroup on D-Bus. + line="4777">These functions support exporting a #GActionGroup on D-Bus. The D-Bus interface that is used is a private implementation detail. @@ -128210,7 +130991,7 @@ g_dbus_action_group_get() to obtain a #GDBusActionGroup. A content type is a platform specific string that defines the type + line="5464">A content type is a platform specific string that defines the type of a file. On UNIX it is a [MIME type](http://www.wikipedia.org/wiki/Internet_media_type) like `text/plain` or `image/png`. @@ -128223,7 +131004,7 @@ such as `com.apple.application`. Routines for working with D-Bus addresses. A D-Bus address is a string + line="5662">Routines for working with D-Bus addresses. A D-Bus address is a string like `unix:tmpdir=/tmp/my-app-name`. The exact format of addresses is explained in detail in the [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -128234,7 +131015,7 @@ currently not supported. All facilities that return errors from remote methods (such as + line="5805">All facilities that return errors from remote methods (such as g_dbus_connection_call_sync()) use #GError to represent both D-Bus errors (e.g. errors returned from the other peer) and locally in-process generated errors. @@ -128281,12 +131062,12 @@ G_STATIC_ASSERT (G_N_ELEMENTS (foo_bar_error_entries) == FOO_BAR_N_ERRORS); GQuark foo_bar_error_quark (void) { - static volatile gsize quark_volatile = 0; + static gsize quark = 0; g_dbus_error_register_error_domain ("foo-bar-error-quark", - &quark_volatile, + &quark, foo_bar_error_entries, G_N_ELEMENTS (foo_bar_error_entries)); - return (GQuark) quark_volatile; + return (GQuark) quark; } ]| With this setup, a D-Bus peer can transparently pass e.g. %FOO_BAR_ERROR_ANOTHER_ERROR and @@ -128306,7 +131087,7 @@ generated locally in-process by e.g. #GDBusConnection should use the Various data structures and convenience routines to parse and + line="5902">Various data structures and convenience routines to parse and generate D-Bus introspection XML. Introspection information is used when registering objects with g_dbus_connection_register_object(). @@ -128316,28 +131097,28 @@ The format of D-Bus introspection XML is specified in the Convenience API for owning bus names. + line="5955">Convenience API for owning bus names. A simple example for owning a name can be found in -[gdbus-example-own-name.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-own-name.c) +[gdbus-example-own-name.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-own-name.c) Convenience API for watching bus names. + line="5968">Convenience API for watching bus names. A simple example for watching a name can be found in -[gdbus-example-watch-name.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-name.c) +[gdbus-example-watch-name.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-watch-name.c) Various utility routines related to D-Bus. + line="6226">Various utility routines related to D-Bus. File attributes in GIO consist of a list of key-value pairs. + line="6458">File attributes in GIO consist of a list of key-value pairs. Keys are strings that contain a key namespace and a key name, separated by a colon, e.g. "namespace::keyname". Namespaces are included to sort @@ -128440,12 +131221,12 @@ where `nn` is a 2-digit hexadecimal number. Contains helper functions for reporting errors to the user. + line="6923">Contains helper functions for reporting errors to the user. As of GLib 2.36, #GIOScheduler is deprecated in favor of + line="6943">As of GLib 2.36, #GIOScheduler is deprecated in favor of #GThreadPool and #GTask. Schedules asynchronous I/O operations. #GIOScheduler integrates @@ -128454,7 +131235,7 @@ into the main event loop (#GMainLoop) and uses threads. These functions support exporting a #GMenuModel on D-Bus. + line="7197">These functions support exporting a #GMenuModel on D-Bus. The D-Bus interface that is used is a private implementation detail. @@ -128464,7 +131245,7 @@ g_dbus_menu_model_get() to obtain a #GDBusMenuModel. The `<gio/gnetworking.h>` header can be included to get + line="7420">The `<gio/gnetworking.h>` header can be included to get various low-level networking-related system headers, automatically taking care of certain portability issues for you. @@ -128485,13 +131266,13 @@ may not take effect. Utility functions for #GPollableInputStream and + line="7606">Utility functions for #GPollableInputStream and #GPollableOutputStream implementations. #GTlsConnection and related classes provide TLS (Transport Layer + line="9739">#GTlsConnection and related classes provide TLS (Transport Layer Security, previously known as SSL, Secure Sockets Layer) support for gio-based network streams. @@ -128523,7 +131304,7 @@ connections. Routines for managing mounted UNIX mount points and paths. + line="10016">Routines for managing mounted UNIX mount points and paths. Note that `<gio/gunixmounts.h>` belongs to the UNIX-specific GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config @@ -128532,7 +131313,7 @@ file when using it. #GWin32InputStream implements #GInputStream for reading from a + line="10147">#GWin32InputStream implements #GInputStream for reading from a Windows file handle. Note that `<gio/gwin32inputstream.h>` belongs to the Windows-specific GIO @@ -128542,7 +131323,7 @@ when using it. #GWin32OutputStream implements #GOutputStream for writing to a + line="10162">#GWin32OutputStream implements #GOutputStream for writing to a Windows file handle. Note that `<gio/gwin32outputstream.h>` belongs to the Windows-specific GIO @@ -128552,7 +131333,7 @@ when using it. #GWin32RegistryKey represents a single Windows Registry key. + line="10177">#GWin32RegistryKey represents a single Windows Registry key. #GWin32RegistryKey is used by a number of helper functions that read Windows Registry. All keys are opened with read-only access, and at @@ -128584,18 +131365,6 @@ Key and value names are not case sensitive. Full key name (excluding the pre-defined ancestor's name) can't exceed 255 UTF-16 characters, give or take. Value name can't exceed 16383 UTF-16 characters. Tree depth is limited to 512 levels. - - - #GZlibCompressor is an implementation of #GConverter that -compresses data using zlib. - - - #GZlibDecompressor is an implementation of #GConverter that -decompresses data compressed with zlib. version="2.38"> Deserializes a #GIcon previously serialized using g_icon_serialize(). + line="26006">Deserializes a #GIcon previously serialized using g_icon_serialize(). - + a #GIcon, or %NULL when deserialization fails. + line="26012">a #GIcon, or %NULL when deserialization fails. a #GVariant created with g_icon_serialize() + line="26008">a #GVariant created with g_icon_serialize() @@ -128623,12 +131392,12 @@ decompresses data compressed with zlib. Gets a hash for an icon. + line="26028">Gets a hash for an icon. a #guint containing a hash for the @icon, suitable for + line="26034">a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. @@ -128636,7 +131405,7 @@ use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + line="26030">#gconstpointer to an icon object. @@ -128648,7 +131417,7 @@ use in a #GHashTable or similar data structure. throws="1"> Generate a #GIcon instance from @str. This function can fail if + line="26039">Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion. If your application or library provides one or more #GIcon @@ -128658,7 +131427,7 @@ with the type system prior to calling g_icon_new_for_string(). An object implementing the #GIcon + line="26051">An object implementing the #GIcon interface or %NULL if @error is set. @@ -128666,7 +131435,7 @@ with the type system prior to calling g_icon_new_for_string(). A string obtained via g_icon_to_string(). + line="26041">A string obtained via g_icon_to_string(). @@ -128680,7 +131449,7 @@ with the type system prior to calling g_icon_new_for_string(). throws="1"> Helper function for constructing #GInitable object. This is + line="26596">Helper function for constructing #GInitable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. Use g_object_new_with_properties() and @@ -128689,7 +131458,7 @@ g_initable_init() instead. See #GParameter for more information. a newly allocated + line="26609">a newly allocated #GObject, or %NULL on error @@ -128697,19 +131466,19 @@ g_initable_init() instead. See #GParameter for more information. a #GType supporting #GInitable. + line="26598">a #GType supporting #GInitable. the number of parameters in @parameters + line="26599">the number of parameters in @parameters the parameters to use to construct the object + line="26600">the parameters to use to construct the object @@ -128720,7 +131489,7 @@ g_initable_init() instead. See #GParameter for more information. optional #GCancellable object, %NULL to ignore. + line="26601">optional #GCancellable object, %NULL to ignore. @@ -128728,7 +131497,7 @@ g_initable_init() instead. See #GParameter for more information. Converts errno.h error codes into GIO error codes. The fallback + line="27054">Converts errno.h error codes into GIO error codes. The fallback value %G_IO_ERROR_FAILED is returned for error codes not currently handled (but note that future GLib releases may return a more specific value instead). @@ -128739,14 +131508,14 @@ calls, you should save its value as soon as the call which sets it #GIOErrorEnum value for the given errno.h error number. + line="27066">#GIOErrorEnum value for the given errno.h error number. Error number as defined in errno.h. + line="27056">Error number as defined in errno.h. @@ -128754,11 +131523,11 @@ calls, you should save its value as soon as the call which sets it Gets the GIO Error Quark. + line="27089">Gets the GIO Error Quark. a #GQuark. + line="27094">a #GQuark. @@ -128767,7 +131536,7 @@ calls, you should save its value as soon as the call which sets it moved-to="IOExtensionPoint.implement"> Registers @type as extension for the extension point with name + line="27167">Registers @type as extension for the extension point with name @extension_point_name. If @type has already been registered as an extension for this @@ -128776,32 +131545,32 @@ extension point, the existing #GIOExtension object is returned. a #GIOExtension object for #GType + line="27180">a #GIOExtension object for #GType the name of the extension point + line="27169">the name of the extension point the #GType to register as extension + line="27170">the #GType to register as extension the name for the extension + line="27171">the name for the extension the priority for the extension + line="27172">the priority for the extension @@ -128811,12 +131580,12 @@ extension point, the existing #GIOExtension object is returned. moved-to="IOExtensionPoint.lookup"> Looks up an existing extension point. + line="27184">Looks up an existing extension point. the #GIOExtensionPoint, or %NULL if there + line="27190">the #GIOExtensionPoint, or %NULL if there is no registered extension point with the given name. @@ -128824,7 +131593,7 @@ extension point, the existing #GIOExtension object is returned. the name of the extension point + line="27186">the name of the extension point @@ -128834,12 +131603,12 @@ extension point, the existing #GIOExtension object is returned. moved-to="IOExtensionPoint.register"> Registers an extension point. + line="27195">Registers an extension point. the new #GIOExtensionPoint. This object is + line="27201">the new #GIOExtensionPoint. This object is owned by GIO and should not be freed. @@ -128847,7 +131616,7 @@ extension point, the existing #GIOExtension object is returned. The name of the extension point + line="27197">The name of the extension point @@ -128856,7 +131625,7 @@ extension point, the existing #GIOExtension object is returned. c:identifier="g_io_modules_load_all_in_directory"> Loads all the modules in the specified directory. + line="27278">Loads all the modules in the specified directory. If don't require all modules to be initialized (and thus registering all gtypes) then you can use g_io_modules_scan_all_in_directory() @@ -128865,7 +131634,7 @@ which allows delayed/lazy loading of modules. a list of #GIOModules loaded + line="27289">a list of #GIOModules loaded from the directory, All the modules are loaded into memory, if you want to unload them (enabling on-demand loading) you must call @@ -128879,7 +131648,7 @@ which allows delayed/lazy loading of modules. pathname for a directory containing modules + line="27280">pathname for a directory containing modules to load. @@ -128890,7 +131659,7 @@ which allows delayed/lazy loading of modules. version="2.30"> Loads all the modules in the specified directory. + line="27298">Loads all the modules in the specified directory. If don't require all modules to be initialized (and thus registering all gtypes) then you can use g_io_modules_scan_all_in_directory() @@ -128899,7 +131668,7 @@ which allows delayed/lazy loading of modules. a list of #GIOModules loaded + line="27310">a list of #GIOModules loaded from the directory, All the modules are loaded into memory, if you want to unload them (enabling on-demand loading) you must call @@ -128913,14 +131682,14 @@ which allows delayed/lazy loading of modules. pathname for a directory containing modules + line="27300">pathname for a directory containing modules to load. a scope to use when scanning the modules. + line="27302">a scope to use when scanning the modules. @@ -128930,7 +131699,7 @@ which allows delayed/lazy loading of modules. version="2.24"> Scans all the modules in the specified directory, ensuring that + line="27320">Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered. This may not actually load and initialize all the types in each @@ -128949,7 +131718,7 @@ use g_io_modules_load_all_in_directory(). pathname for a directory containing modules + line="27322">pathname for a directory containing modules to scan. @@ -128960,7 +131729,7 @@ use g_io_modules_load_all_in_directory(). version="2.30"> Scans all the modules in the specified directory, ensuring that + line="27341">Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered. This may not actually load and initialize all the types in each @@ -128979,14 +131748,14 @@ use g_io_modules_load_all_in_directory(). pathname for a directory containing modules + line="27343">pathname for a directory containing modules to scan. a scope to use when scanning the modules + line="27345">a scope to use when scanning the modules @@ -128996,7 +131765,7 @@ use g_io_modules_load_all_in_directory(). deprecated="1"> Cancels all cancellable I/O jobs. + line="27363">Cancels all cancellable I/O jobs. A job is cancellable if a #GCancellable was passed into g_io_scheduler_push_job(). @@ -129013,7 +131782,7 @@ gioscheduler. deprecated="1"> Schedules the I/O job to run in another thread. + line="27414">Schedules the I/O job to run in another thread. @notify will be called on @user_data after @job_func has returned, regardless whether the job was cancelled or has run to completion. @@ -129034,7 +131803,7 @@ g_io_scheduler_cancel_all_jobs(). destroy="2"> a #GIOSchedulerJobFunc. + line="27416">a #GIOSchedulerJobFunc. allow-none="1"> data to pass to @job_func + line="27417">data to pass to @job_func scope="async"> a #GDestroyNotify for @user_data, or %NULL + line="27418">a #GDestroyNotify for @user_data, or %NULL the [I/O priority][io-priority] + line="27419">the [I/O priority][io-priority] of the request. @@ -129069,7 +131838,7 @@ of the request. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="27421">optional #GCancellable object, %NULL to ignore. @@ -129078,7 +131847,7 @@ of the request. c:identifier="g_keyfile_settings_backend_new"> Creates a keyfile-backed #GSettingsBackend. + line="27626">Creates a keyfile-backed #GSettingsBackend. The filename of the keyfile to use is given by @filename. @@ -129131,20 +131900,20 @@ the same location. a keyfile-backed #GSettingsBackend + line="27683">a keyfile-backed #GSettingsBackend the filename of the keyfile + line="27628">the filename of the keyfile the path under which all settings keys appear + line="27629">the path under which all settings keys appear allow-none="1"> the group name corresponding to + line="27630">the group name corresponding to @root_path, or %NULL @@ -129165,12 +131934,12 @@ the same location. version="2.64"> Gets a reference to the default #GMemoryMonitor for the system. + line="28061">Gets a reference to the default #GMemoryMonitor for the system. a new reference to the default #GMemoryMonitor + line="28066">a new reference to the default #GMemoryMonitor @@ -129179,7 +131948,7 @@ the same location. version="2.28"> Creates a memory-backed #GSettingsBackend. + line="28215">Creates a memory-backed #GSettingsBackend. This backend allows changes to settings, but does not write them to any backing storage, so the next time you run your application, @@ -129188,7 +131957,7 @@ the memory backend will start out with the default values again. a newly created #GSettingsBackend + line="28224">a newly created #GSettingsBackend @@ -129198,12 +131967,13 @@ the memory backend will start out with the default values again. version="2.32"> Gets the default #GNetworkMonitor for the system. + line="30092">Gets the default #GNetworkMonitor for the system. a #GNetworkMonitor + line="30097">a #GNetworkMonitor, which will be + a dummy object if no network monitor is available @@ -129212,7 +131982,7 @@ the memory backend will start out with the default values again. version="2.36"> Initializes the platform networking libraries (eg, on Windows, this + line="30202">Initializes the platform networking libraries (eg, on Windows, this calls WSAStartup()). GLib will call this itself if it is needed, so you only need to call it if you directly call system networking functions (without calling any GLib networking functions first). @@ -129226,7 +131996,7 @@ functions (without calling any GLib networking functions first). version="2.28"> Creates a readonly #GSettingsBackend. + line="30422">Creates a readonly #GSettingsBackend. This backend does not allow changes to settings, so all settings will always have their default values. @@ -129234,7 +132004,7 @@ will always have their default values. a newly created #GSettingsBackend + line="30430">a newly created #GSettingsBackend @@ -129243,7 +132013,7 @@ will always have their default values. version="2.28"> Utility method for #GPollableInputStream and #GPollableOutputStream + line="31541">Utility method for #GPollableInputStream and #GPollableOutputStream implementations. Creates a new #GSource that expects a callback of type #GPollableSourceFunc. The new source does not actually do anything on its own; use g_source_add_child_source() to add other @@ -129252,14 +132022,14 @@ sources to it to cause it to trigger. the new #GSource. + line="31551">the new #GSource. the stream associated with the new source + line="31543">the stream associated with the new source @@ -129269,7 +132039,7 @@ sources to it to cause it to trigger. version="2.34"> Utility method for #GPollableInputStream and #GPollableOutputStream + line="31556">Utility method for #GPollableInputStream and #GPollableOutputStream implementations. Creates a new #GSource, as with g_pollable_source_new(), but also attaching @child_source (with a dummy callback), and @cancellable, if they are non-%NULL. @@ -129277,14 +132047,14 @@ dummy callback), and @cancellable, if they are non-%NULL. the new #GSource. + line="31568">the new #GSource. the stream associated with the + line="31558">the stream associated with the new source @@ -129294,7 +132064,7 @@ dummy callback), and @cancellable, if they are non-%NULL. allow-none="1"> optional child source to attach + line="31560">optional child source to attach allow-none="1"> optional #GCancellable to attach + line="31561">optional #GCancellable to attach @@ -129314,7 +132084,7 @@ dummy callback), and @cancellable, if they are non-%NULL. throws="1"> Tries to read from @stream, as with g_input_stream_read() (if + line="31573">Tries to read from @stream, as with g_input_stream_read() (if @blocking is %TRUE) or g_pollable_input_stream_read_nonblocking() (if @blocking is %FALSE). This can be used to more easily share code between blocking and non-blocking implementations of a method. @@ -129327,20 +132097,20 @@ returns %TRUE, or else the behavior is undefined. If @blocking is the number of bytes read, or -1 on error. + line="31593">the number of bytes read, or -1 on error. a #GInputStream + line="31575">a #GInputStream a buffer to + line="31576">a buffer to read data into @@ -129349,13 +132119,13 @@ returns %TRUE, or else the behavior is undefined. If @blocking is the number of bytes to read + line="31578">the number of bytes to read whether to do blocking I/O + line="31579">whether to do blocking I/O optional #GCancellable object, %NULL to ignore. + line="31580">optional #GCancellable object, %NULL to ignore. @@ -129375,7 +132145,7 @@ returns %TRUE, or else the behavior is undefined. If @blocking is throws="1"> Tries to write to @stream, as with g_output_stream_write() (if + line="31598">Tries to write to @stream, as with g_output_stream_write() (if @blocking is %TRUE) or g_pollable_output_stream_write_nonblocking() (if @blocking is %FALSE). This can be used to more easily share code between blocking and non-blocking implementations of a method. @@ -129389,20 +132159,20 @@ need to be a #GPollableOutputStream. the number of bytes written, or -1 on error. + line="31619">the number of bytes written, or -1 on error. a #GOutputStream. + line="31600">a #GOutputStream. the buffer + line="31601">the buffer containing the data to write. @@ -129411,13 +132181,13 @@ need to be a #GPollableOutputStream. the number of bytes to write + line="31603">the number of bytes to write whether to do blocking I/O + line="31604">whether to do blocking I/O allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="31605">optional #GCancellable object, %NULL to ignore. @@ -129437,7 +132207,7 @@ need to be a #GPollableOutputStream. throws="1"> Tries to write @count bytes to @stream, as with + line="31624">Tries to write @count bytes to @stream, as with g_output_stream_write_all(), but using g_pollable_stream_write() rather than g_output_stream_write(). @@ -129459,20 +132229,20 @@ need to be a #GPollableOutputStream. %TRUE on success, %FALSE if there was an error + line="31655">%TRUE on success, %FALSE if there was an error a #GOutputStream. + line="31626">a #GOutputStream. the buffer + line="31627">the buffer containing the data to write. @@ -129481,13 +132251,13 @@ need to be a #GPollableOutputStream. the number of bytes to write + line="31629">the number of bytes to write whether to do blocking I/O + line="31630">whether to do blocking I/O transfer-ownership="full"> location to store the number of bytes that was + line="31631">location to store the number of bytes that was written to the stream @@ -129506,24 +132276,39 @@ need to be a #GPollableOutputStream. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="31633">optional #GCancellable object, %NULL to ignore. + + Gets a reference to the default #GPowerProfileMonitor for the system. + + + a new reference to the default #GPowerProfileMonitor + + + Find the `gio-proxy` extension point for a proxy implementation that supports + line="31860">Find the `gio-proxy` extension point for a proxy implementation that supports the specified protocol. - + return a #GProxy or NULL if protocol + line="31867">return a #GProxy or NULL if protocol is not supported. @@ -129531,7 +132316,7 @@ the specified protocol. the proxy protocol name (e.g. http, socks, etc) + line="31862">the proxy protocol name (e.g. http, socks, etc) @@ -129542,12 +132327,13 @@ the specified protocol. version="2.26"> Gets the default #GProxyResolver for the system. + line="31873">Gets the default #GProxyResolver for the system. the default #GProxyResolver. + line="31878">the default #GProxyResolver, which + will be a dummy object if no proxy resolver is available @@ -129557,11 +132343,11 @@ the specified protocol. version="2.22"> Gets the #GResolver Error Quark. + line="32018">Gets the #GResolver Error Quark. a #GQuark. + line="32023">a #GQuark. @@ -129571,11 +132357,11 @@ the specified protocol. version="2.32"> Gets the #GResource Error Quark. + line="32444">Gets the #GResource Error Quark. a #GQuark + line="32449">a #GQuark @@ -129586,7 +132372,7 @@ the specified protocol. throws="1"> Loads a binary resource bundle and creates a #GResource representation of it, allowing + line="32475">Loads a binary resource bundle and creates a #GResource representation of it, allowing you to query it for data. If you want to use this resource in the global resource namespace you need @@ -129600,14 +132386,14 @@ returned. a new #GResource, or %NULL on error + line="32491">a new #GResource, or %NULL on error the path of a filename to load, in the GLib filename encoding + line="32477">the path of a filename to load, in the GLib filename encoding @@ -129618,7 +132404,7 @@ returned. throws="1"> Returns all the names of children at the specified @path in the set of + line="32590">Returns all the names of children at the specified @path in the set of globally registered resources. The return result is a %NULL terminated list of strings which should be released with g_strfreev(). @@ -129628,7 +132414,7 @@ be released with g_strfreev(). an array of constant strings + line="32603">an array of constant strings @@ -129637,13 +132423,13 @@ be released with g_strfreev(). A pathname inside the resource + line="32592">A pathname inside the resource A #GResourceLookupFlags + line="32593">A #GResourceLookupFlags @@ -129654,7 +132440,7 @@ be released with g_strfreev(). throws="1"> Looks for a file at the specified @path in the set of + line="32608">Looks for a file at the specified @path in the set of globally registered resources and if found returns information about it. @lookup_flags controls the behaviour of the lookup. @@ -129662,20 +132448,20 @@ globally registered resources and if found returns information about it. %TRUE if the file was found. %FALSE if there were errors + line="32623">%TRUE if the file was found. %FALSE if there were errors A pathname inside the resource + line="32610">A pathname inside the resource A #GResourceLookupFlags + line="32611">A #GResourceLookupFlags a location to place the length of the contents of the file, + line="32612">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -129698,7 +132484,7 @@ globally registered resources and if found returns information about it. allow-none="1"> a location to place the #GResourceFlags about the file, + line="32614">a location to place the #GResourceFlags about the file, or %NULL if the flags are not needed @@ -129710,7 +132496,7 @@ globally registered resources and if found returns information about it. throws="1"> Looks for a file at the specified @path in the set of + line="32628">Looks for a file at the specified @path in the set of globally registered resources and returns a #GBytes that lets you directly access the data in memory. @@ -129728,7 +132514,7 @@ the heap and automatically uncompress the data. #GBytes or %NULL on error. + line="32649">#GBytes or %NULL on error. Free the returned object with g_bytes_unref() @@ -129736,13 +132522,13 @@ the heap and automatically uncompress the data. A pathname inside the resource + line="32630">A pathname inside the resource A #GResourceLookupFlags + line="32631">A #GResourceLookupFlags @@ -129753,7 +132539,7 @@ the heap and automatically uncompress the data. throws="1"> Looks for a file at the specified @path in the set of + line="32655">Looks for a file at the specified @path in the set of globally registered resources and returns a #GInputStream that lets you read the data. @@ -129762,7 +132548,7 @@ that lets you read the data. #GInputStream or %NULL on error. + line="32667">#GInputStream or %NULL on error. Free the returned object with g_object_unref() @@ -129770,13 +132556,13 @@ that lets you read the data. A pathname inside the resource + line="32657">A pathname inside the resource A #GResourceLookupFlags + line="32658">A #GResourceLookupFlags @@ -129786,7 +132572,7 @@ that lets you read the data. version="2.32"> Registers the resource with the process-global set of resources. + line="32673">Registers the resource with the process-global set of resources. Once a resource is registered the files in it can be accessed with the global resource lookup functions like g_resources_lookup_data(). @@ -129797,7 +132583,7 @@ with the global resource lookup functions like g_resources_lookup_data(). A #GResource + line="32675">A #GResource @@ -129807,7 +132593,7 @@ with the global resource lookup functions like g_resources_lookup_data(). version="2.32"> Unregisters the resource from the process-global set of resources. + line="32685">Unregisters the resource from the process-global set of resources. @@ -129816,7 +132602,7 @@ with the global resource lookup functions like g_resources_lookup_data(). A #GResource + line="32687">A #GResource @@ -129827,7 +132613,7 @@ with the global resource lookup functions like g_resources_lookup_data(). version="2.32"> Gets the default system schema source. + line="33964">Gets the default system schema source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -129844,7 +132630,7 @@ recursively. the default schema source + line="33981">the default schema source @@ -129855,7 +132641,7 @@ recursively. deprecated-version="2.46"> Reports an error in an asynchronous function in an idle function by + line="34537">Reports an error in an asynchronous function in an idle function by directly setting the contents of the #GAsyncResult with the given error information. Use g_task_report_error(). @@ -129870,7 +132656,7 @@ information. allow-none="1"> a #GObject, or %NULL. + line="34539">a #GObject, or %NULL. closure="2"> a #GAsyncReadyCallback. + line="34540">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="34541">user data passed to @callback. a #GQuark containing the error domain (usually #G_IO_ERROR). + line="34542">a #GQuark containing the error domain (usually #G_IO_ERROR). a specific error code. + line="34543">a specific error code. a formatted error reporting string. + line="34544">a formatted error reporting string. a list of variables to fill in @format. + line="34545">a list of variables to fill in @format. @@ -129925,7 +132711,7 @@ information. deprecated-version="2.46"> Reports an error in an idle function. Similar to + line="34555">Reports an error in an idle function. Similar to g_simple_async_report_error_in_idle(), but takes a #GError rather than building a new one. Use g_task_report_error(). @@ -129940,7 +132726,7 @@ than building a new one. allow-none="1"> a #GObject, or %NULL + line="34557">a #GObject, or %NULL closure="2"> a #GAsyncReadyCallback. + line="34558">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="34559">user data passed to @callback. the #GError to report + line="34560">the #GError to report @@ -129979,7 +132765,7 @@ than building a new one. deprecated-version="2.46"> Reports an error in an idle function. Similar to + line="34570">Reports an error in an idle function. Similar to g_simple_async_report_gerror_in_idle(), but takes over the caller's ownership of @error, so the caller does not have to free it any more. Use g_task_report_error(). @@ -129994,7 +132780,7 @@ ownership of @error, so the caller does not have to free it any more. allow-none="1"> a #GObject, or %NULL + line="34572">a #GObject, or %NULL closure="2"> a #GAsyncReadyCallback. + line="34573">a #GAsyncReadyCallback. allow-none="1"> user data passed to @callback. + line="34574">user data passed to @callback. the #GError to report + line="34575">the #GError to report @@ -130032,12 +132818,12 @@ ownership of @error, so the caller does not have to free it any more. introspectable="0"> Sorts @targets in place according to the algorithm in RFC 2782. + line="37774">Sorts @targets in place according to the algorithm in RFC 2782. the head of the sorted list. + line="37780">the head of the sorted list. @@ -130046,7 +132832,7 @@ ownership of @error, so the caller does not have to free it any more. a #GList of #GSrvTarget + line="37776">a #GList of #GSrvTarget @@ -130059,12 +132845,13 @@ ownership of @error, so the caller does not have to free it any more. version="2.28"> Gets the default #GTlsBackend for the system. + line="39592">Gets the default #GTlsBackend for the system. a #GTlsBackend + line="39597">a #GTlsBackend, which will be a + dummy object if no TLS backend is available @@ -130074,11 +132861,11 @@ ownership of @error, so the caller does not have to free it any more. version="2.66"> Gets the TLS channel binding error quark. + line="39971">Gets the TLS channel binding error quark. a #GQuark. + line="39976">a #GQuark. @@ -130089,7 +132876,7 @@ ownership of @error, so the caller does not have to free it any more. throws="1"> Creates a new #GTlsClientConnection wrapping @base_io_stream (which + line="40075">Creates a new #GTlsClientConnection wrapping @base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by @server_identity. @@ -130100,7 +132887,7 @@ this function has returned. the new + line="40089">the new #GTlsClientConnection, or %NULL on error @@ -130108,7 +132895,7 @@ this function has returned. the #GIOStream to wrap + line="40077">the #GIOStream to wrap allow-none="1"> the expected identity of the server + line="40078">the expected identity of the server @@ -130128,11 +132915,11 @@ this function has returned. version="2.28"> Gets the TLS error quark. + line="40886">Gets the TLS error quark. a #GQuark. + line="40891">a #GQuark. @@ -130143,7 +132930,7 @@ this function has returned. throws="1"> Creates a new #GTlsFileDatabase which uses anchor certificate authorities + line="40896">Creates a new #GTlsFileDatabase which uses anchor certificate authorities in @anchors to verify certificate chains. The certificates in @anchors must be PEM encoded. @@ -130151,7 +132938,7 @@ The certificates in @anchors must be PEM encoded. the new + line="40906">the new #GTlsFileDatabase, or %NULL on error @@ -130159,7 +132946,7 @@ The certificates in @anchors must be PEM encoded. filename of anchor certificate authorities. + line="40898">filename of anchor certificate authorities. @@ -130171,7 +132958,7 @@ The certificates in @anchors must be PEM encoded. throws="1"> Creates a new #GTlsServerConnection wrapping @base_io_stream (which + line="41263">Creates a new #GTlsServerConnection wrapping @base_io_stream (which must have pollable input and output streams). See the documentation for #GTlsConnection:base-io-stream for restrictions @@ -130181,7 +132968,7 @@ this function has returned. the new + line="41276">the new #GTlsServerConnection, or %NULL on error @@ -130189,7 +132976,7 @@ this function has returned. the #GIOStream to wrap + line="41265">the #GIOStream to wrap allow-none="1"> the default server certificate, or %NULL + line="41266">the default server certificate, or %NULL @@ -130207,7 +132994,7 @@ this function has returned. c:identifier="g_unix_is_mount_path_system_internal"> Determines if @mount_path is considered an implementation of the + line="41773">Determines if @mount_path is considered an implementation of the OS. This is primarily used for hiding mountable and mounted volumes that only are used in the OS and has little to no relevance to the casual user. @@ -130215,7 +133002,7 @@ casual user. %TRUE if @mount_path is considered an implementation detail + line="41782">%TRUE if @mount_path is considered an implementation detail of the OS. @@ -130223,7 +133010,7 @@ casual user. a mount path, e.g. `/media/disk` or `/usr` + line="41775">a mount path, e.g. `/media/disk` or `/usr` @@ -130233,7 +133020,7 @@ casual user. version="2.56"> Determines if @device_path is considered a block device path which is only + line="41787">Determines if @device_path is considered a block device path which is only used in implementation of the OS. This is primarily used for hiding mounted volumes that are intended as APIs for programs to read, and system administrators at a shell; rather than something that should, for example, @@ -130244,7 +133031,7 @@ The list of device paths considered ‘system’ ones may change over time. %TRUE if @device_path is considered an implementation detail of + line="41799">%TRUE if @device_path is considered an implementation detail of the OS. @@ -130252,7 +133039,7 @@ The list of device paths considered ‘system’ ones may change over time. a device path, e.g. `/dev/loop0` or `nfsd` + line="41789">a device path, e.g. `/dev/loop0` or `nfsd` @@ -130262,7 +133049,7 @@ The list of device paths considered ‘system’ ones may change over time. Determines if @fs_type is considered a type of file system which is only + line="41805">Determines if @fs_type is considered a type of file system which is only used in implementation of the OS. This is primarily used for hiding mounted volumes that are intended as APIs for programs to read, and system administrators at a shell; rather than something that should, for example, @@ -130273,14 +133060,14 @@ The list of file system types considered ‘system’ ones may change over time. %TRUE if @fs_type is considered an implementation detail of the OS. + line="41817">%TRUE if @fs_type is considered an implementation detail of the OS. a file system type, e.g. `procfs` or `tmpfs` + line="41807">a file system type, e.g. `procfs` or `tmpfs` @@ -130288,24 +133075,26 @@ The list of file system types considered ‘system’ ones may change over time. Gets a #GUnixMountEntry for a given mount path. If @time_read + line="41822">Gets a #GUnixMountEntry for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking if the mounts have changed since with g_unix_mounts_changed_since(). If more mounts have the same mount path, the last matching mount -is returned. +is returned. + +This will return %NULL if there is no mount point at @mount_path. - + a #GUnixMountEntry. + line="41836">a #GUnixMountEntry. path for a possible unix mount. + line="41824">path for a possible unix mount. allow-none="1"> guint64 to contain a timestamp. + line="41825">guint64 to contain a timestamp. @@ -130324,12 +133113,12 @@ is returned. Compares two unix mounts. + line="41840">Compares two unix mounts. 1, 0 or -1 if @mount1 is greater than, equal to, + line="41847">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. @@ -130337,13 +133126,13 @@ or less than @mount2, respectively. first #GUnixMountEntry to compare. + line="41842">first #GUnixMountEntry to compare. second #GUnixMountEntry to compare. + line="41843">second #GUnixMountEntry to compare. @@ -130353,19 +133142,19 @@ or less than @mount2, respectively. version="2.54"> Makes a copy of @mount_entry. + line="41852">Makes a copy of @mount_entry. a new #GUnixMountEntry + line="41858">a new #GUnixMountEntry a #GUnixMountEntry. + line="41854">a #GUnixMountEntry. @@ -130375,24 +133164,27 @@ or less than @mount2, respectively. version="2.52"> Gets a #GUnixMountEntry for a given file path. If @time_read + line="41863">Gets a #GUnixMountEntry for a given file path. If @time_read is set, it will be filled with a unix timestamp for checking if the mounts have changed since with g_unix_mounts_changed_since(). If more mounts have the same mount path, the last matching mount -is returned. +is returned. + +This will return %NULL if looking up the mount entry fails, if +@file_path doesn’t exist or there is an I/O error. - + a #GUnixMountEntry. + line="41878">a #GUnixMountEntry. file path on some unix mount. + line="41865">file path on some unix mount. allow-none="1"> guint64 to contain a timestamp. + line="41866">guint64 to contain a timestamp. @@ -130411,7 +133203,7 @@ is returned. Frees a unix mount. + line="41883">Frees a unix mount. @@ -130420,7 +133212,7 @@ is returned. a #GUnixMountEntry. + line="41885">a #GUnixMountEntry. @@ -130429,19 +133221,19 @@ is returned. c:identifier="g_unix_mount_get_device_path"> Gets the device path for a unix mount. + line="41891">Gets the device path for a unix mount. a string containing the device path. + line="41897">a string containing the device path. a #GUnixMount. + line="41893">a #GUnixMount. @@ -130450,19 +133242,19 @@ is returned. c:identifier="g_unix_mount_get_fs_type"> Gets the filesystem type for the unix mount. + line="41901">Gets the filesystem type for the unix mount. a string containing the file system type. + line="41907">a string containing the file system type. a #GUnixMount. + line="41903">a #GUnixMount. @@ -130471,19 +133263,19 @@ is returned. c:identifier="g_unix_mount_get_mount_path"> Gets the mount path for a unix mount. + line="41911">Gets the mount path for a unix mount. the mount path for @mount_entry. + line="41917">the mount path for @mount_entry. input #GUnixMountEntry to get the mount path for. + line="41913">input #GUnixMountEntry to get the mount path for. @@ -130493,7 +133285,7 @@ is returned. version="2.58"> Gets a comma-separated list of mount options for the unix mount. For example, + line="41921">Gets a comma-separated list of mount options for the unix mount. For example, `rw,relatime,seclabel,data=ordered`. This is similar to g_unix_mount_point_get_options(), but it takes @@ -130502,7 +133294,7 @@ a #GUnixMountEntry as an argument. a string containing the options, or %NULL if not + line="41931">a string containing the options, or %NULL if not available. @@ -130510,7 +133302,7 @@ available. a #GUnixMountEntry. + line="41923">a #GUnixMountEntry. @@ -130520,7 +133312,7 @@ available. version="2.60"> Gets the root of the mount within the filesystem. This is useful e.g. for + line="41937">Gets the root of the mount within the filesystem. This is useful e.g. for mounts created by bind operation, or btrfs subvolumes. For example, the root path is equal to "/" for mount created by @@ -130530,14 +133322,14 @@ For example, the root path is equal to "/" for mount created by a string containing the root, or %NULL if not supported. + line="41948">a string containing the root, or %NULL if not supported. a #GUnixMountEntry. + line="41939">a #GUnixMountEntry. @@ -130546,19 +133338,19 @@ For example, the root path is equal to "/" for mount created by c:identifier="g_unix_mount_guess_can_eject"> Guesses whether a Unix mount can be ejected. + line="41953">Guesses whether a Unix mount can be ejected. %TRUE if @mount_entry is deemed to be ejectable. + line="41959">%TRUE if @mount_entry is deemed to be ejectable. a #GUnixMountEntry + line="41955">a #GUnixMountEntry @@ -130567,19 +133359,19 @@ For example, the root path is equal to "/" for mount created by c:identifier="g_unix_mount_guess_icon"> Guesses the icon of a Unix mount. + line="41963">Guesses the icon of a Unix mount. a #GIcon + line="41969">a #GIcon a #GUnixMountEntry + line="41965">a #GUnixMountEntry @@ -130588,13 +133380,13 @@ For example, the root path is equal to "/" for mount created by c:identifier="g_unix_mount_guess_name"> Guesses the name of a Unix mount. + line="41973">Guesses the name of a Unix mount. The result is a translated string. A newly allocated string that must + line="41980">A newly allocated string that must be freed with g_free() @@ -130602,7 +133394,7 @@ The result is a translated string. a #GUnixMountEntry + line="41975">a #GUnixMountEntry @@ -130611,19 +133403,19 @@ The result is a translated string. c:identifier="g_unix_mount_guess_should_display"> Guesses whether a Unix mount should be displayed in the UI. + line="41985">Guesses whether a Unix mount should be displayed in the UI. %TRUE if @mount_entry is deemed to be displayable. + line="41991">%TRUE if @mount_entry is deemed to be displayable. a #GUnixMountEntry + line="41987">a #GUnixMountEntry @@ -130633,19 +133425,19 @@ The result is a translated string. version="2.34"> Guesses the symbolic icon of a Unix mount. + line="41995">Guesses the symbolic icon of a Unix mount. a #GIcon + line="42001">a #GIcon a #GUnixMountEntry + line="41997">a #GUnixMountEntry @@ -130654,19 +133446,19 @@ The result is a translated string. c:identifier="g_unix_mount_is_readonly"> Checks if a unix mount is mounted read only. + line="42017">Checks if a unix mount is mounted read only. %TRUE if @mount_entry is read only. + line="42023">%TRUE if @mount_entry is read only. a #GUnixMount. + line="42019">a #GUnixMount. @@ -130675,7 +133467,7 @@ The result is a translated string. c:identifier="g_unix_mount_is_system_internal"> Checks if a Unix mount is a system mount. This is the Boolean OR of + line="42027">Checks if a Unix mount is a system mount. This is the Boolean OR of g_unix_is_system_fs_type(), g_unix_is_system_device_path() and g_unix_is_mount_path_system_internal() on @mount_entry’s properties. @@ -130685,14 +133477,14 @@ file system types and device paths are ignored. %TRUE if the unix mount is for a system path. + line="42038">%TRUE if the unix mount is for a system path. a #GUnixMount. + line="42029">a #GUnixMount. @@ -130703,7 +133495,7 @@ file system types and device paths are ignored. version="2.66"> Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it + line="42092">Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking if the mount points have changed since with g_unix_mount_points_changed_since(). @@ -130713,7 +133505,7 @@ is returned. a #GUnixMountPoint, or %NULL if no match + line="42104">a #GUnixMountPoint, or %NULL if no match is found. @@ -130721,7 +133513,7 @@ is found. path for a possible unix mount point. + line="42094">path for a possible unix mount point. allow-none="1"> guint64 to contain a timestamp. + line="42095">guint64 to contain a timestamp. @@ -130741,19 +133533,19 @@ is found. c:identifier="g_unix_mount_points_changed_since"> Checks if the unix mount points have changed since a given unix time. + line="42267">Checks if the unix mount points have changed since a given unix time. %TRUE if the mount points have changed since @time. + line="42273">%TRUE if the mount points have changed since @time. guint64 to contain a timestamp. + line="42269">guint64 to contain a timestamp. @@ -130762,7 +133554,7 @@ is found. c:identifier="g_unix_mount_points_get"> Gets a #GList of #GUnixMountPoint containing the unix mount points. + line="42277">Gets a #GList of #GUnixMountPoint containing the unix mount points. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with g_unix_mount_points_changed_since(). @@ -130770,7 +133562,7 @@ g_unix_mount_points_changed_since(). + line="42286"> a #GList of the UNIX mountpoints. @@ -130785,7 +133577,7 @@ g_unix_mount_points_changed_since(). allow-none="1"> guint64 to contain a timestamp. + line="42279">guint64 to contain a timestamp. @@ -130794,19 +133586,19 @@ g_unix_mount_points_changed_since(). c:identifier="g_unix_mounts_changed_since"> Checks if the unix mounts have changed since a given unix time. + line="42291">Checks if the unix mounts have changed since a given unix time. %TRUE if the mounts have changed since @time. + line="42297">%TRUE if the mounts have changed since @time. guint64 to contain a timestamp. + line="42293">guint64 to contain a timestamp. @@ -130814,7 +133606,7 @@ g_unix_mount_points_changed_since(). Gets a #GList of #GUnixMountEntry containing the unix mounts. + line="42301">Gets a #GList of #GUnixMountEntry containing the unix mounts. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with g_unix_mounts_changed_since(). @@ -130822,7 +133614,7 @@ with g_unix_mounts_changed_since(). + line="42310"> a #GList of the UNIX mounts. @@ -130837,7 +133629,7 @@ with g_unix_mounts_changed_since(). allow-none="1"> guint64 to contain a timestamp, or %NULL + line="42303">guint64 to contain a timestamp, or %NULL diff --git a/Graphene-1.0.gir b/Graphene-1.0.gir index 7826cfa..3f5e9e8 100644 --- a/Graphene-1.0.gir +++ b/Graphene-1.0.gir @@ -2135,18 +2135,6 @@ a #graphene_frustum_t. - - - - - - - - - - - - version="1.10"> Intersects the given #graphene_ray_t @r with the given + line="486">Intersects the given #graphene_ray_t @r with the given #graphene_box_t @b. the type of intersection + line="495">the type of intersection @@ -7435,13 +7423,13 @@ values of another #graphene_ray_t. a #graphene_ray_t + line="488">a #graphene_ray_t a #graphene_box_t + line="489">a #graphene_box_t transfer-ownership="full"> the distance of the point on the ray that intersects the box + line="490">the distance of the point on the ray that intersects the box @@ -7499,13 +7487,13 @@ values of another #graphene_ray_t. version="1.10"> Intersects the given #graphene_ray_t @r with the given + line="636">Intersects the given #graphene_ray_t @r with the given #graphene_triangle_t @t. the type of intersection + line="645">the type of intersection @@ -7513,13 +7501,13 @@ values of another #graphene_ray_t. a #graphene_ray_t + line="638">a #graphene_ray_t a #graphene_triangle_t + line="639">a #graphene_triangle_t transfer-ownership="full"> the distance of the point on the ray that intersects the triangle + line="640">the distance of the point on the ray that intersects the triangle @@ -7538,7 +7526,7 @@ values of another #graphene_ray_t. version="1.10"> Checks whether the given #graphene_ray_t @r intersects the + line="615">Checks whether the given #graphene_ray_t @r intersects the given #graphene_box_t @b. See also: graphene_ray_intersect_box() @@ -7546,20 +7534,20 @@ See also: graphene_ray_intersect_box() `true` if the ray intersects the box + line="625">`true` if the ray intersects the box a #graphene_ray_t + line="617">a #graphene_ray_t a #graphene_box_t + line="618">a #graphene_box_t @@ -7600,7 +7588,7 @@ See also: graphene_ray_intersect_sphere() version="1.10"> Checks whether the given #graphene_ray_t @r intersects the + line="736">Checks whether the given #graphene_ray_t @r intersects the given #graphene_triangle_t @b. See also: graphene_ray_intersect_triangle() @@ -7608,20 +7596,20 @@ See also: graphene_ray_intersect_triangle() `true` if the ray intersects the triangle + line="746">`true` if the ray intersects the triangle a #graphene_ray_t + line="738">a #graphene_ray_t a #graphene_triangle_t + line="739">a #graphene_triangle_t @@ -8725,10 +8713,6 @@ a size of 0, 0. - - - - - + @@ -8771,7 +8755,7 @@ declaring it, e.g.: - + diff --git a/Gsk-4.0.gir b/Gsk-4.0.gir index 2cc08f4..1f9ea71 100644 --- a/Gsk-4.0.gir +++ b/Gsk-4.0.gir @@ -2,207 +2,391 @@ - + - - - The blend modes available for render nodes. + + + The blend modes available for render nodes. The implementation of each blend mode is deferred to the rendering pipeline. See <https://www.w3.org/TR/compositing-1/#blending> for more information on blending and blend modes. - - The default blend mode, which specifies no blending + + The default blend mode, which specifies no blending - - The source color is multiplied by the destination + + The source color is multiplied by the destination and replaces the destination - - Multiplies the complements of the destination and source + + Multiplies the complements of the destination and source color values, then complements the result. - - Multiplies or screens the colors, depending on the + + Multiplies or screens the colors, depending on the destination color value. This is the inverse of hard-list - - Selects the darker of the destination and source colors + + Selects the darker of the destination and source colors - - Selects the lighter of the destination and source colors + + Selects the lighter of the destination and source colors - - Brightens the destination color to reflect the source color + + Brightens the destination color to reflect the source color - - Darkens the destination color to reflect the source color + + Darkens the destination color to reflect the source color - - Multiplies or screens the colors, depending on the source color value + + Multiplies or screens the colors, depending on the source color value - - Darkens or lightens the colors, depending on the source color value + + Darkens or lightens the colors, depending on the source color value - - Subtracts the darker of the two constituent colors from the lighter color + + Subtracts the darker of the two constituent colors from the lighter color - - Produces an effect similar to that of the difference mode but lower in contrast + + Produces an effect similar to that of the difference mode but lower in contrast - - Creates a color with the hue and saturation of the source color and the luminosity of the destination color + + Creates a color with the hue and saturation of the source color and the luminosity of the destination color - - Creates a color with the hue of the source color and the saturation and luminosity of the destination color + + Creates a color with the hue of the source color and the saturation and luminosity of the destination color - - Creates a color with the saturation of the source color and the hue and luminosity of the destination color + + Creates a color with the saturation of the source color and the hue and luminosity of the destination color - - Creates a color with the luminosity of the source color and the hue and saturation of the destination color + + Creates a color with the luminosity of the source color and the hue and saturation of the destination color - - A render node applying a blending function between its two child nodes. + + A render node applying a blending function between its two child nodes. - Creates a `GskRenderNode` that will use @blend_mode to blend the @top + Creates a `GskRenderNode` that will use @blend_mode to blend the @top node onto the @bottom node. + - A new `GskRenderNode` + A new `GskRenderNode` - The bottom node to be drawn + The bottom node to be drawn - The node to be blended onto the @bottom node + The node to be blended onto the @bottom node - The blend mode to use + The blend mode to use - - Retrieves the blend mode used by @node. + + Retrieves the blend mode used by @node. + - the blend mode + the blend mode - a blending `GskRenderNode` + a blending `GskRenderNode` - - Retrieves the bottom `GskRenderNode` child of the @node. + + Retrieves the bottom `GskRenderNode` child of the @node. + - the bottom child node + the bottom child node - a blending `GskRenderNode` + a blending `GskRenderNode` - Retrieves the top `GskRenderNode` child of the @node. + Retrieves the top `GskRenderNode` child of the @node. + - the top child node + the top child node - a blending `GskRenderNode` + a blending `GskRenderNode` - - A render node applying a blur effect to its single child. + + A render node applying a blur effect to its single child. - Creates a render node that blurs the child. + Creates a render node that blurs the child. + - a new `GskRenderNode` + a new `GskRenderNode` - the child node to blur + the child node to blur - the blur radius + the blur radius - Retrieves the child `GskRenderNode` of the blur @node. + Retrieves the child `GskRenderNode` of the blur @node. + - the blurred child node + the blurred child node - a blur `GskRenderNode` + a blur `GskRenderNode` - Retrieves the blur radius of the @node. + Retrieves the blur radius of the @node. + - the blur radius + the blur radius - a blur `GskRenderNode` + a blur `GskRenderNode` - - A render node for a border. + + A render node for a border. - Creates a `GskRenderNode` that will stroke a border rectangle inside the + Creates a `GskRenderNode` that will stroke a border rectangle inside the given @outline. The 4 sides of the border can have different widths and colors. + - A new `GskRenderNode` + A new `GskRenderNode` - a `GskRoundedRect` describing the outline of the border + a `GskRoundedRect` describing the outline of the border - the stroke width of the border on + the stroke width of the border on the top, right, bottom and left side respectively. - the color used on the top, right, + the color used on the top, right, bottom and left side. @@ -211,36 +395,55 @@ The 4 sides of the border can have different widths and colors. - Retrieves the colors of the border. + Retrieves the colors of the border. + - an array of 4 `GdkRGBA` structs + an array of 4 `GdkRGBA` structs for the top, right, bottom and left color of the border - a `GskRenderNode` for a border + a `GskRenderNode` for a border - Retrieves the outline of the border. + Retrieves the outline of the border. + - the outline of the border + the outline of the border - a `GskRenderNode` for a border + a `GskRenderNode` for a border - Retrieves the stroke widths of the border. + Retrieves the stroke widths of the border. + - an array of 4 floats + an array of 4 floats for the top, right, bottom and left stroke width of the border, respectively @@ -249,87 +452,139 @@ The 4 sides of the border can have different widths and colors. - a `GskRenderNode` for a border + a `GskRenderNode` for a border - + + - + + - + + - - A render node for a Cairo surface. + + A render node for a Cairo surface. - Creates a `GskRenderNode` that will render a cairo surface + Creates a `GskRenderNode` that will render a cairo surface into the area given by @bounds. You can draw to the cairo surface using [method@Gsk.CairoNode.get_draw_context]. + - A new `GskRenderNode` + A new `GskRenderNode` - the rectangle to render to + the rectangle to render to - - Creates a Cairo context for drawing using the surface associated + + Creates a Cairo context for drawing using the surface associated to the render node. If no surface exists yet, a surface will be created optimized for rendering to @renderer. + - a Cairo context used for drawing; use + a Cairo context used for drawing; use cairo_destroy() when done drawing - a `GskRenderNode` for a Cairo surface + a `GskRenderNode` for a Cairo surface - Retrieves the Cairo surface used by the render node. + Retrieves the Cairo surface used by the render node. + - a Cairo surface + a Cairo surface - a `GskRenderNode` for a Cairo surface + a `GskRenderNode` for a Cairo surface - - A GSK renderer that is using cairo. + + A GSK renderer that is using cairo. Since it is using cairo, this renderer cannot support 3D transformations. + - Creates a new Cairo renderer. + Creates a new Cairo renderer. The Cairo renderer is the fallback renderer drawing in ways similar to how GTK 3 drew its content. Its primary use is as comparison tool. @@ -337,64 +592,113 @@ to how GTK 3 drew its content. Its primary use is as comparison tool. The Cairo renderer is incomplete. It cannot render 3D transformed content and will instead render an error marker. Its usage should be avoided. + - a new Cairo renderer. + a new Cairo renderer. - - - A render node applying a rectangular clip to its single child node. + + + + + A render node applying a rectangular clip to its single child node. - Creates a `GskRenderNode` that will clip the @child to the area + Creates a `GskRenderNode` that will clip the @child to the area given by @clip. + - A new `GskRenderNode` + A new `GskRenderNode` - The node to draw + The node to draw - The clip to apply + The clip to apply - Gets the child node that is getting clipped by the given @node. + Gets the child node that is getting clipped by the given @node. + - The child that is getting clipped + The child that is getting clipped - a clip @GskRenderNode + a clip @GskRenderNode - Retrieves the clip rectangle for @node. + Retrieves the clip rectangle for @node. + - a clip rectangle + a clip rectangle - a `GskClipNode` + a `GskClipNode` - - A render node controlling the color matrix of its single child node. + + A render node controlling the color matrix of its single child node. - Creates a `GskRenderNode` that will drawn the @child with + Creates a `GskRenderNode` that will drawn the @child with @color_matrix. In particular, the node will transform the operation @@ -402,137 +706,221 @@ In particular, the node will transform the operation pixel = color_matrix * pixel + color_offset for every pixel. + - A new `GskRenderNode` + A new `GskRenderNode` - The node to draw + The node to draw - The matrix to apply + The matrix to apply - Values to add to the color + Values to add to the color - Gets the child node that is getting its colors modified by the given @node. + Gets the child node that is getting its colors modified by the given @node. + - The child that is getting its colors modified + The child that is getting its colors modified - a color matrix `GskRenderNode` + a color matrix `GskRenderNode` - - Retrieves the color matrix used by the @node. + + Retrieves the color matrix used by the @node. + - a 4x4 color matrix + a 4x4 color matrix - a color matrix `GskRenderNode` + a color matrix `GskRenderNode` - - Retrieves the color offset used by the @node. + + Retrieves the color offset used by the @node. + - a color vector + a color vector - a color matrix `GskRenderNode` + a color matrix `GskRenderNode` - - A render node for a solid color. + + A render node for a solid color. - Creates a `GskRenderNode` that will render the color specified by @rgba into + Creates a `GskRenderNode` that will render the color specified by @rgba into the area given by @bounds. + - A new `GskRenderNode` + A new `GskRenderNode` - a `GdkRGBA` specifying a color + a `GdkRGBA` specifying a color - the rectangle to render the color into + the rectangle to render the color into - Retrieves the color of the given @node. + Retrieves the color of the given @node. + - the color of the node + the color of the node - a `GskRenderNode` + a `GskRenderNode` - A color stop in a gradient node. + A color stop in a gradient node. + - the offset of the color stop + the offset of the color stop - the color at the given offset + the color at the given offset - - A render node for a conic gradient. + + A render node for a conic gradient. - Creates a `GskRenderNode` that draws a conic gradient. + Creates a `GskRenderNode` that draws a conic gradient. The conic gradient starts around @center in the direction of @rotation. A rotation of 0 means that the gradient points up. Color stops are then added clockwise. + - A new `GskRenderNode` + A new `GskRenderNode` - the bounds of the node + the bounds of the node - the center of the gradient + the center of the gradient - the rotation of the gradient in degrees + the rotation of the gradient in degrees - a pointer to an array of + a pointer to an array of `GskColorStop` defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1. @@ -541,284 +929,494 @@ that the gradient points up. Color stops are then added clockwise. - the number of elements in @color_stops + the number of elements in @color_stops - - Retrieves the angle for the gradient in radians, normalized in [0, 2 * PI]. + + Retrieves the angle for the gradient in radians, normalized in [0, 2 * PI]. The angle is starting at the top and going clockwise, as expressed in the css specification: angle = 90 - gsk_conic_gradient_node_get_rotation() + - the angle for the gradient + the angle for the gradient - a `GskRenderNode` for a conic gradient + a `GskRenderNode` for a conic gradient - - Retrieves the center pointer for the gradient. + + Retrieves the center pointer for the gradient. + - the center point for the gradient + the center point for the gradient - a `GskRenderNode` for a conic gradient + a `GskRenderNode` for a conic gradient - - Retrieves the color stops in the gradient. + + Retrieves the color stops in the gradient. + - the color stops in the gradient + the color stops in the gradient - a `GskRenderNode` for a conic gradient + a `GskRenderNode` for a conic gradient - - the number of color stops in the returned array + + the number of color stops in the returned array - - Retrieves the number of color stops in the gradient. + + Retrieves the number of color stops in the gradient. + - the number of color stops + the number of color stops - a `GskRenderNode` for a conic gradient + a `GskRenderNode` for a conic gradient - - Retrieves the rotation for the gradient in degrees. + + Retrieves the rotation for the gradient in degrees. + - the rotation for the gradient + the rotation for the gradient - a `GskRenderNode` for a conic gradient + a `GskRenderNode` for a conic gradient - - A render node that can contain other render nodes. + + A render node that can contain other render nodes. - Creates a new `GskRenderNode` instance for holding the given @children. + Creates a new `GskRenderNode` instance for holding the given @children. The new node will acquire a reference to each of the children. + - the new `GskRenderNode` + the new `GskRenderNode` - The children of the node + The children of the node - Number of children in the @children array + Number of children in the @children array - Gets one of the children of @container. + Gets one of the children of @container. + - the @idx'th child of @container + the @idx'th child of @container - a container `GskRenderNode` + a container `GskRenderNode` - the position of the child to get + the position of the child to get - - Retrieves the number of direct children of @node. + + Retrieves the number of direct children of @node. + - the number of children of the `GskRenderNode` + the number of children of the `GskRenderNode` - a container `GskRenderNode` + a container `GskRenderNode` - - The corner indices used by `GskRoundedRect`. - - The top left corner + + The corner indices used by `GskRoundedRect`. + + The top left corner - - The top right corner + + The top right corner - - The bottom right corner + + The bottom right corner - - The bottom left corner + + The bottom left corner - - A render node cross fading between two child nodes. + + A render node cross fading between two child nodes. - Creates a `GskRenderNode` that will do a cross-fade between @start and @end. + Creates a `GskRenderNode` that will do a cross-fade between @start and @end. + - A new `GskRenderNode` + A new `GskRenderNode` - The start node to be drawn + The start node to be drawn - The node to be cross_fadeed onto the @start node + The node to be cross_fadeed onto the @start node - How far the fade has progressed from start to end. The value will + How far the fade has progressed from start to end. The value will be clamped to the range [0 ... 1] - - Retrieves the child `GskRenderNode` at the end of the cross-fade. + + Retrieves the child `GskRenderNode` at the end of the cross-fade. + - a `GskRenderNode` + a `GskRenderNode` - a cross-fading `GskRenderNode` + a cross-fading `GskRenderNode` - - Retrieves the progress value of the cross fade. + + Retrieves the progress value of the cross fade. + - the progress value, between 0 and 1 + the progress value, between 0 and 1 - a cross-fading `GskRenderNode` + a cross-fading `GskRenderNode` - - Retrieves the child `GskRenderNode` at the beginning of the cross-fade. + + Retrieves the child `GskRenderNode` at the beginning of the cross-fade. + - a `GskRenderNode` + a `GskRenderNode` - a cross-fading `GskRenderNode` + a cross-fading `GskRenderNode` - - A render node that emits a debugging message when drawing its + + A render node that emits a debugging message when drawing its child node. - Creates a `GskRenderNode` that will add debug information about + Creates a `GskRenderNode` that will add debug information about the given @child. Adding this node has no visual effect. + - A new `GskRenderNode` + A new `GskRenderNode` - The child to add debug info for + The child to add debug info for - The debug message + The debug message - Gets the child node that is getting drawn by the given @node. + Gets the child node that is getting drawn by the given @node. + - the child `GskRenderNode` + the child `GskRenderNode` - a debug `GskRenderNode` + a debug `GskRenderNode` - Gets the debug message that was set on this node + Gets the debug message that was set on this node + - The debug message + The debug message - a debug `GskRenderNode` + a debug `GskRenderNode` - - A GSK renderer that is using OpenGL. + + A GSK renderer that is using OpenGL. + - Creates a new `GskRenderer` using OpenGL. + Creates a new `GskRenderer` using OpenGL. + - a new GL renderer + a new GL renderer - - - A `GskGLShader` is a snippet of GLSL that is meant to run in the + + + + + A `GskGLShader` is a snippet of GLSL that is meant to run in the fragment shader of the rendering pipeline. A fragment shader gets the coordinates being rendered as input and @@ -931,35 +1529,54 @@ void mainImage(out vec4 fragColor, fragColor = position * source1 + (1.0 - position) * source2; } ``` - - Creates a `GskGLShader` that will render pixels using the specified code. + + + Creates a `GskGLShader` that will render pixels using the specified code. + - A new `GskGLShader` + A new `GskGLShader` - GLSL sourcecode for the shader, as a `GBytes` + GLSL sourcecode for the shader, as a `GBytes` - - Creates a `GskGLShader` that will render pixels using the specified code. + + Creates a `GskGLShader` that will render pixels using the specified code. + - A new `GskGLShader` + A new `GskGLShader` - path to a resource that contains the GLSL sourcecode for + path to a resource that contains the GLSL sourcecode for the shader - Tries to compile the @shader for the given @renderer. + Tries to compile the @shader for the given @renderer. If there is a problem, this function returns %FALSE and reports an error. You should use this function before relying on the shader @@ -971,41 +1588,62 @@ change the current GL context) and requires the renderer to be set up. This means that the widget has to be realized. Commonly you want to call this from the realize signal of a widget, or during widget snapshot. + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GskGLShader` + a `GskGLShader` - a `GskRenderer` + a `GskRenderer` - - Looks for a uniform by the name @name, and returns the index + + Looks for a uniform by the name @name, and returns the index of the uniform, or -1 if it was not found. + - The index of the uniform, or -1 + The index of the uniform, or -1 - a `GskGLShader` + a `GskGLShader` - uniform name + uniform name - - Formats the uniform data as needed for feeding the named uniforms + + Formats the uniform data as needed for feeding the named uniforms values into the shader. The argument list is a list of pairs of names, and values for the types @@ -1014,25 +1652,36 @@ primitive values and `graphene_vecN_t *` for vecN uniforms). Any uniforms of the shader that are not included in the argument list are zero-initialized. + - A newly allocated block of data which can be + A newly allocated block of data which can be passed to [ctor@Gsk.GLShaderNode.new]. - a `GskGLShader` + a `GskGLShader` - name-Value pairs for the uniforms of @shader, ending with + name-Value pairs for the uniforms of @shader, ending with a %NULL name - - Formats the uniform data as needed for feeding the named uniforms + + Formats the uniform data as needed for feeding the named uniforms values into the shader. The argument list is a list of pairs of names, and values for the @@ -1043,337 +1692,510 @@ It is an error to pass a uniform name that is not declared by the shader. Any uniforms of the shader that are not included in the argument list are zero-initialized. + - A newly allocated block of data which can be + A newly allocated block of data which can be passed to [ctor@Gsk.GLShaderNode.new]. - a `GskGLShader` + a `GskGLShader` - name-Value pairs for the uniforms of @shader, ending + name-Value pairs for the uniforms of @shader, ending with a %NULL name - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of bool type. + - The value + The value - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of float type. + - The value + The value - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of int type. + - The value + The value - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of uint type. + - The value + The value - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of vec2 type. + - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - location to store the uniform value in + location to store the uniform value in - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of vec3 type. + - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - location to store the uniform value in + location to store the uniform value in - Gets the value of the uniform @idx in the @args block. + Gets the value of the uniform @idx in the @args block. The uniform must be of vec4 type. + - a `GskGLShader` + a `GskGLShader` - uniform arguments + uniform arguments - index of the uniform + index of the uniform - location to store set the uniform value in + location to store set the uniform value in - Get the size of the data block used to specify arguments for this shader. + Get the size of the data block used to specify arguments for this shader. + - The size of the data block + The size of the data block - a `GskGLShader` + a `GskGLShader` - - Returns the number of textures that the shader requires. + + Returns the number of textures that the shader requires. This can be used to check that the a passed shader works in your usecase. It is determined by looking at the highest u_textureN value that the shader defines. + - The number of texture inputs required by @shader + The number of texture inputs required by @shader - a `GskGLShader` + a `GskGLShader` - - Get the number of declared uniforms for this shader. + + Get the number of declared uniforms for this shader. + - The number of declared uniforms + The number of declared uniforms - a `GskGLShader` + a `GskGLShader` - Gets the resource path for the GLSL sourcecode being used + Gets the resource path for the GLSL sourcecode being used to render this shader. + - The resource path for the shader + The resource path for the shader - a `GskGLShader` + a `GskGLShader` - Gets the GLSL sourcecode being used to render this shader. + Gets the GLSL sourcecode being used to render this shader. + - The source code for the shader + The source code for the shader - a `GskGLShader` + a `GskGLShader` - - Get the name of the declared uniform for this shader at index @idx. + + Get the name of the declared uniform for this shader at index @idx. + - The name of the declared uniform + The name of the declared uniform - a `GskGLShader` + a `GskGLShader` - index of the uniform + index of the uniform - - Get the offset into the data block where data for this uniforms is stored. + + Get the offset into the data block where data for this uniforms is stored. + - The data offset + The data offset - a `GskGLShader` + a `GskGLShader` - index of the uniform + index of the uniform - - Get the type of the declared uniform for this shader at index @idx. + + Get the type of the declared uniform for this shader at index @idx. + - The type of the declared uniform + The type of the declared uniform - a `GskGLShader` + a `GskGLShader` - index of the uniform + index of the uniform - - - Resource containing the source code for the shader. + + + Resource containing the source code for the shader. If the shader source is not coming from a resource, this will be %NULL. - + - + + - - A render node using a GL shader when drawing its children nodes. + + A render node using a GL shader when drawing its children nodes. - Creates a `GskRenderNode` that will render the given @shader into the + Creates a `GskRenderNode` that will render the given @shader into the area given by @bounds. The @args is a block of data to use for uniform input, as per types and @@ -1390,330 +2212,543 @@ If the renderer doesn't support GL shaders, or if there is any problem when compiling the shader, then the node will draw pink. You should use [method@Gsk.GLShader.compile] to ensure the @shader will work for the renderer before using it. + - A new `GskRenderNode` + A new `GskRenderNode` - the `GskGLShader` + the `GskGLShader` - the rectangle to render the shader into + the rectangle to render the shader into - Arguments for the uniforms + Arguments for the uniforms - array of child nodes, these will + array of child nodes, these will be rendered to textures and used as input. - Length of @children (currenly the GL backend supports + Length of @children (currenly the GL backend supports up to 4 children) - Gets args for the node. + Gets args for the node. + - A `GBytes` with the uniform arguments + A `GBytes` with the uniform arguments - a `GskRenderNode` for a gl shader + a `GskRenderNode` for a gl shader - Gets one of the children. + Gets one of the children. + - the @idx'th child of @node + the @idx'th child of @node - a `GskRenderNode` for a gl shader + a `GskRenderNode` for a gl shader - the position of the child to get + the position of the child to get - - Returns the number of children + + Returns the number of children + - The number of children + The number of children - a `GskRenderNode` for a gl shader + a `GskRenderNode` for a gl shader - Gets shader code for the node. + Gets shader code for the node. + - the `GskGLShader` shader + the `GskGLShader` shader - a `GskRenderNode` for a gl shader + a `GskRenderNode` for a gl shader - - This defines the types of the uniforms that `GskGLShaders` + + This defines the types of the uniforms that `GskGLShaders` declare. It defines both what the type is called in the GLSL shader code, and what the corresponding C type is on the Gtk side. - - No type, used for uninitialized or unspecified values. + + No type, used for uninitialized or unspecified values. - - A float uniform + + A float uniform - - A GLSL int / gint32 uniform + + A GLSL int / gint32 uniform - - A GLSL uint / guint32 uniform + + A GLSL uint / guint32 uniform - - A GLSL bool / gboolean uniform + + A GLSL bool / gboolean uniform - - A GLSL vec2 / graphene_vec2_t uniform + + A GLSL vec2 / graphene_vec2_t uniform - - A GLSL vec3 / graphene_vec3_t uniform + + A GLSL vec3 / graphene_vec3_t uniform - - A GLSL vec4 / graphene_vec4_t uniform + + A GLSL vec4 / graphene_vec4_t uniform - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - - A render node for an inset shadow. + + A render node for an inset shadow. - Creates a `GskRenderNode` that will render an inset shadow + Creates a `GskRenderNode` that will render an inset shadow into the box given by @outline. + - A new `GskRenderNode` + A new `GskRenderNode` - outline of the region containing the shadow + outline of the region containing the shadow - color of the shadow + color of the shadow - horizontal offset of shadow + horizontal offset of shadow - vertical offset of shadow + vertical offset of shadow - how far the shadow spreads towards the inside + how far the shadow spreads towards the inside - how much blur to apply to the shadow + how much blur to apply to the shadow - - Retrieves the blur radius to apply to the shadow. + + Retrieves the blur radius to apply to the shadow. + - the blur radius, in pixels + the blur radius, in pixels - a `GskRenderNode` for an inset shadow + a `GskRenderNode` for an inset shadow - Retrieves the color of the inset shadow. + Retrieves the color of the inset shadow. + - the color of the shadow + the color of the shadow - a `GskRenderNode` for an inset shadow + a `GskRenderNode` for an inset shadow - Retrieves the horizontal offset of the inset shadow. + Retrieves the horizontal offset of the inset shadow. + - an offset, in pixels + an offset, in pixels - a `GskRenderNode` for an inset shadow + a `GskRenderNode` for an inset shadow - Retrieves the vertical offset of the inset shadow. + Retrieves the vertical offset of the inset shadow. + - an offset, in pixels + an offset, in pixels - a `GskRenderNode` for an inset shadow + a `GskRenderNode` for an inset shadow - - Retrieves the outline rectangle of the inset shadow. + + Retrieves the outline rectangle of the inset shadow. + - a rounded rectangle + a rounded rectangle - a `GskRenderNode` for an inset shadow + a `GskRenderNode` for an inset shadow - - Retrieves how much the shadow spreads inwards. + + Retrieves how much the shadow spreads inwards. + - the size of the shadow, in pixels + the size of the shadow, in pixels - a `GskRenderNode` for an inset shadow + a `GskRenderNode` for an inset shadow - - A render node for a linear gradient. + + A render node for a linear gradient. - Creates a `GskRenderNode` that will create a linear gradient from the given + Creates a `GskRenderNode` that will create a linear gradient from the given points and color stops, and render that into the area given by @bounds. + - A new `GskRenderNode` + A new `GskRenderNode` - the rectangle to render the linear gradient into + the rectangle to render the linear gradient into - the point at which the linear gradient will begin + the point at which the linear gradient will begin - the point at which the linear gradient will finish + the point at which the linear gradient will finish - a pointer to an array of + a pointer to an array of `GskColorStop` defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1. @@ -1722,371 +2757,611 @@ points and color stops, and render that into the area given by @bounds. - the number of elements in @color_stops + the number of elements in @color_stops - - Retrieves the color stops in the gradient. + + Retrieves the color stops in the gradient. + - the color stops in the gradient + the color stops in the gradient - a `GskRenderNode` for a linear gradient + a `GskRenderNode` for a linear gradient - - the number of color stops in the returned array + + the number of color stops in the returned array - Retrieves the final point of the linear gradient. + Retrieves the final point of the linear gradient. + - the final point + the final point - a `GskRenderNode` for a linear gradient + a `GskRenderNode` for a linear gradient - - Retrieves the number of color stops in the gradient. + + Retrieves the number of color stops in the gradient. + - the number of color stops + the number of color stops - a `GskRenderNode` for a linear gradient + a `GskRenderNode` for a linear gradient - - Retrieves the initial point of the linear gradient. + + Retrieves the initial point of the linear gradient. + - the initial point + the initial point - a `GskRenderNode` for a linear gradient + a `GskRenderNode` for a linear gradient - + + - + + - + + - - - Creates a new `GskRenderer` using the new OpenGL renderer. + + + + Creates a new `GskRenderer` using the new OpenGL renderer. + - a new NGL renderer + a new NGL renderer - - - A render node controlling the opacity of its single child node. + + + + + A render node controlling the opacity of its single child node. - Creates a `GskRenderNode` that will drawn the @child with reduced + Creates a `GskRenderNode` that will drawn the @child with reduced @opacity. + - A new `GskRenderNode` + A new `GskRenderNode` - The node to draw + The node to draw - The opacity to apply + The opacity to apply - Gets the child node that is getting opacityed by the given @node. + Gets the child node that is getting opacityed by the given @node. + - The child that is getting opacityed + The child that is getting opacityed - a `GskRenderNode` for an opacity + a `GskRenderNode` for an opacity - Gets the transparency factor for an opacity node. + Gets the transparency factor for an opacity node. + - the opacity factor + the opacity factor - a `GskRenderNode` for an opacity + a `GskRenderNode` for an opacity - - A render node for an outset shadow. + + A render node for an outset shadow. - Creates a `GskRenderNode` that will render an outset shadow + Creates a `GskRenderNode` that will render an outset shadow around the box given by @outline. + - A new `GskRenderNode` + A new `GskRenderNode` - outline of the region surrounded by shadow + outline of the region surrounded by shadow - color of the shadow + color of the shadow - horizontal offset of shadow + horizontal offset of shadow - vertical offset of shadow + vertical offset of shadow - how far the shadow spreads towards the inside + how far the shadow spreads towards the inside - how much blur to apply to the shadow + how much blur to apply to the shadow - - Retrieves the blur radius of the shadow. + + Retrieves the blur radius of the shadow. + - the blur radius, in pixels + the blur radius, in pixels - a `GskRenderNode` for an outset shadow + a `GskRenderNode` for an outset shadow - Retrieves the color of the outset shadow. + Retrieves the color of the outset shadow. + - a color + a color - a `GskRenderNode` for an outset shadow + a `GskRenderNode` for an outset shadow - Retrieves the horizontal offset of the outset shadow. + Retrieves the horizontal offset of the outset shadow. + - an offset, in pixels + an offset, in pixels - a `GskRenderNode` for an outset shadow + a `GskRenderNode` for an outset shadow - Retrieves the vertical offset of the outset shadow. + Retrieves the vertical offset of the outset shadow. + - an offset, in pixels + an offset, in pixels - a `GskRenderNode` for an outset shadow + a `GskRenderNode` for an outset shadow - - Retrieves the outline rectangle of the outset shadow. + + Retrieves the outline rectangle of the outset shadow. + - a rounded rectangle + a rounded rectangle - a `GskRenderNode` for an outset shadow + a `GskRenderNode` for an outset shadow - - Retrieves how much the shadow spreads outwards. + + Retrieves how much the shadow spreads outwards. + - the size of the shadow, in pixels + the size of the shadow, in pixels - a `GskRenderNode` for an outset shadow + a `GskRenderNode` for an outset shadow - Type of callback that is called when an error occurs + Type of callback that is called when an error occurs during node deserialization. + - start of the error location + start of the error location - end of the error location + end of the error location - the error + the error - - user data + + user data - A location in a parse buffer. + A location in a parse buffer. + - the offset of the location in the parse buffer, as bytes + the offset of the location in the parse buffer, as bytes - the offset of the location in the parse buffer, as characters + the offset of the location in the parse buffer, as characters - the line of the location in the parse buffer + the line of the location in the parse buffer - the position in the line, as bytes + the position in the line, as bytes - the position in the line, as characters + the position in the line, as characters - + + - - Initializes a `GskRoundedRect` when declaring it. + + Initializes a `GskRoundedRect` when declaring it. All corner sizes will be initialized to 0. + - the X coordinate of the origin + the X coordinate of the origin - the Y coordinate of the origin + the Y coordinate of the origin - the width + the width - the height + the height - - A render node for a radial gradient. + + A render node for a radial gradient. - Creates a `GskRenderNode` that draws a radial gradient. + Creates a `GskRenderNode` that draws a radial gradient. The radial gradient starts around @center. The size of the gradient is dictated by @hradius in horizontal orientation and by @vradius in vertial orientation. + - A new `GskRenderNode` + A new `GskRenderNode` - the bounds of the node + the bounds of the node - the center of the gradient + the center of the gradient - the horizontal radius + the horizontal radius - the vertical radius + the vertical radius - a percentage >= 0 that defines the start of the gradient around @center + a percentage >= 0 that defines the start of the gradient around @center - a percentage >= 0 that defines the end of the gradient around @center + a percentage >= 0 that defines the end of the gradient around @center - a pointer to an array of + a pointer to an array of `GskColorStop` defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1. @@ -2095,111 +3370,185 @@ in horizontal orientation and by @vradius in vertial orientation. - the number of elements in @color_stops + the number of elements in @color_stops - - Retrieves the center pointer for the gradient. + + Retrieves the center pointer for the gradient. + - the center point for the gradient + the center point for the gradient - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - Retrieves the color stops in the gradient. + + Retrieves the color stops in the gradient. + - the color stops in the gradient + the color stops in the gradient - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - the number of color stops in the returned array + + the number of color stops in the returned array - Retrieves the end value for the gradient. + Retrieves the end value for the gradient. + - the end value for the gradient + the end value for the gradient - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - Retrieves the horizonal radius for the gradient. + + Retrieves the horizonal radius for the gradient. + - the horizontal radius for the gradient + the horizontal radius for the gradient - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - Retrieves the number of color stops in the gradient. + + Retrieves the number of color stops in the gradient. + - the number of color stops + the number of color stops - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - Retrieves the start value for the gradient. + + Retrieves the start value for the gradient. + - the start value for the gradient + the start value for the gradient - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - Retrieves the vertical radius for the gradient. + + Retrieves the vertical radius for the gradient. + - the vertical radius for the gradient + the vertical radius for the gradient - a `GskRenderNode` for a radial gradient + a `GskRenderNode` for a radial gradient - - `GskRenderNode` is the basic block in a scene graph to be + + `GskRenderNode` is the basic block in a scene graph to be rendered using `GskRenderer`. Each node has a parent, except the top-level node; each node may have @@ -2213,30 +3562,52 @@ to a [class@Gsk.Renderer] it's safe to release any reference you have on them. All [class@Gsk.RenderNode]s are immutable, you can only specify their properties during construction. - Loads data previously created via gsk_render_node_serialize(). + Loads data previously created via gsk_render_node_serialize(). For a discussion of the supported format, see that function. + - a new `GskRenderNode` + a new `GskRenderNode` - the bytes containing the data + the bytes containing the data - - Callback on parsing errors + + Callback on parsing errors - - user_data for @error_func + + user_data for @error_func - Draw the contents of @node to the given cairo context. + Draw the contents of @node to the given cairo context. Typically, you'll use this function to implement fallback rendering of `GskRenderNode`s on an intermediate Cairo context, instead of using @@ -2244,66 +3615,98 @@ the drawing context associated to a `GdkSurface`'s rendering buffer. For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail. + - a `GskRenderNode` + a `GskRenderNode` - cairo context to draw to + cairo context to draw to - Retrieves the boundaries of the @node. + Retrieves the boundaries of the @node. The node will not draw outside of its boundaries. + - a `GskRenderNode` + a `GskRenderNode` - - return location for the boundaries + + return location for the boundaries - - Returns the type of the @node. + + Returns the type of the @node. + - the type of the `GskRenderNode` + the type of the `GskRenderNode` - a `GskRenderNode` + a `GskRenderNode` - Acquires a reference on the given `GskRenderNode`. + Acquires a reference on the given `GskRenderNode`. + - the `GskRenderNode` with an additional reference + the `GskRenderNode` with an additional reference - a `GskRenderNode` + a `GskRenderNode` - Serializes the @node for later deserialization via + Serializes the @node for later deserialization via gsk_render_node_deserialize(). No guarantees are made about the format used other than that the same version of GTK will be able to deserialize the result of a call to gsk_render_node_serialize() and @@ -2312,139 +3715,304 @@ that were created with previous versions of GTK. The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format. + - a `GBytes` representing the node. + a `GBytes` representing the node. - a `GskRenderNode` + a `GskRenderNode` - Releases a reference on the given `GskRenderNode`. + Releases a reference on the given `GskRenderNode`. If the reference was the last, the resources associated to the @node are freed. + - a `GskRenderNode` + a `GskRenderNode` - - This function is equivalent to calling gsk_render_node_serialize() + + This function is equivalent to calling gsk_render_node_serialize() followed by g_file_set_contents(). See those two functions for details on the arguments. It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection. + - %TRUE if saving was successful + %TRUE if saving was successful - a `GskRenderNode` + a `GskRenderNode` - the file to save it to. + the file to save it to. - - The type of a node determines what the node is rendering. - - Error type. No node will ever have this type. + + The type of a node determines what the node is rendering. + + Error type. No node will ever have this type. - - A node containing a stack of children + + A node containing a stack of children - - A node drawing a `cairo_surface_t` + + A node drawing a `cairo_surface_t` - - A node drawing a single color rectangle + + A node drawing a single color rectangle - - A node drawing a linear gradient + + A node drawing a linear gradient - - A node drawing a repeating linear gradient + + A node drawing a repeating linear gradient - - A node drawing a radial gradient + + A node drawing a radial gradient - - A node drawing a repeating radial gradient + + A node drawing a repeating radial gradient - - A node drawing a conic gradient + + A node drawing a conic gradient - - A node stroking a border around an area + + A node stroking a border around an area - - A node drawing a `GdkTexture` + + A node drawing a `GdkTexture` - - A node drawing an inset shadow + + A node drawing an inset shadow - - A node drawing an outset shadow + + A node drawing an outset shadow - - A node that renders its child after applying a matrix transform + + A node that renders its child after applying a matrix transform - - A node that changes the opacity of its child + + A node that changes the opacity of its child - - A node that applies a color matrix to every pixel + + A node that applies a color matrix to every pixel - - A node that repeats the child's contents + + A node that repeats the child's contents - - A node that clips its child to a rectangular area + + A node that clips its child to a rectangular area - - A node that clips its child to a rounded rectangle + + A node that clips its child to a rounded rectangle - - A node that draws a shadow below its child + + A node that draws a shadow below its child - - A node that blends two children together + + A node that blends two children together - - A node that cross-fades between two children + + A node that cross-fades between two children - - A node containing a glyph string + + A node containing a glyph string - - A node that applies a blur + + A node that applies a blur - - Debug information that does not affect the rendering + + Debug information that does not affect the rendering - - A node that uses OpenGL fragment shaders to render + + A node that uses OpenGL fragment shaders to render - - `GskRenderer` is a class that renders a scene graph defined via a + + `GskRenderer` is a class that renders a scene graph defined via a tree of [class@Gsk.RenderNode] instances. Typically you will use a `GskRenderer` instance to repeatedly call @@ -2455,74 +4023,106 @@ It is necessary to realize a `GskRenderer` instance using [method@Gsk.Renderer.realize] before calling [method@Gsk.Renderer.render], in order to create the appropriate windowing system resources needed to render the scene. - - Creates an appropriate `GskRenderer` instance for the given @surface. + + + Creates an appropriate `GskRenderer` instance for the given @surface. If the `GSK_RENDERER` environment variable is set, GSK will try that renderer first, before trying the backend-specific default. The ultimate fallback is the cairo renderer. The renderer will be realized before it is returned. + - a `GskRenderer` + a `GskRenderer` - a `GdkSurface` + a `GdkSurface` - Retrieves the `GdkSurface` set using gsk_enderer_realize(). + Retrieves the `GdkSurface` set using gsk_enderer_realize(). If the renderer has not been realized yet, %NULL will be returned. + - a `GdkSurface` + a `GdkSurface` - a `GskRenderer` + a `GskRenderer` - Checks whether the @renderer is realized or not. + Checks whether the @renderer is realized or not. + - %TRUE if the `GskRenderer` was realized, and %FALSE otherwise + %TRUE if the `GskRenderer` was realized, and %FALSE otherwise - a `GskRenderer` + a `GskRenderer` - Creates the resources needed by the @renderer to render the scene + Creates the resources needed by the @renderer to render the scene graph. + - a `GskRenderer` + a `GskRenderer` - the `GdkSurface` renderer will be used on + the `GdkSurface` renderer will be used on - Renders the scene graph, described by a tree of `GskRenderNode` instances, + Renders the scene graph, described by a tree of `GskRenderNode` instances, ensuring that the given @region gets redrawn. Renderers must ensure that changes of the contents given by the @root @@ -2532,27 +4132,39 @@ it didn't change. The @renderer will acquire a reference on the `GskRenderNode` tree while the rendering is in progress. + - a `GskRenderer` + a `GskRenderer` - a `GskRenderNode` + a `GskRenderNode` - - the `cairo_region_t` that must be redrawn or %NULL + + the `cairo_region_t` that must be redrawn or %NULL for the whole window - Renders the scene graph, described by a tree of `GskRenderNode` instances, + Renders the scene graph, described by a tree of `GskRenderNode` instances, to a `GdkTexture`. The @renderer will acquire a reference on the `GskRenderNode` tree while @@ -2560,126 +4172,213 @@ the rendering is in progress. If you want to apply any transformations to @root, you should put it into a transform node and pass that node instead. + - a `GdkTexture` with the rendered contents of @root. + a `GdkTexture` with the rendered contents of @root. - a realized `GskRenderer` + a realized `GskRenderer` - a `GskRenderNode` + a `GskRenderNode` - - the section to draw or %NULL to use @root's bounds + + the section to draw or %NULL to use @root's bounds - Releases all the resources created by gsk_renderer_realize(). + Releases all the resources created by gsk_renderer_realize(). + - a `GskRenderer` + a `GskRenderer` - - Whether the renderer has been associated with a surface. + + Whether the renderer has been associated with a surface. - - The surface associated with renderer. + + The surface associated with renderer. - - - A render node repeating its single child node. + + + + + A render node repeating its single child node. - Creates a `GskRenderNode` that will repeat the drawing of @child across + Creates a `GskRenderNode` that will repeat the drawing of @child across the given @bounds. + - A new `GskRenderNode` + A new `GskRenderNode` - The bounds of the area to be painted + The bounds of the area to be painted - The child to repeat + The child to repeat - - The area of the child to repeat or %NULL to + + The area of the child to repeat or %NULL to use the child's bounds - Retrieves the child of @node. + Retrieves the child of @node. + - a `GskRenderNode` + a `GskRenderNode` - a repeat `GskRenderNode` + a repeat `GskRenderNode` - - Retrieves the bounding rectangle of the child of @node. + + Retrieves the bounding rectangle of the child of @node. + - a bounding rectangle + a bounding rectangle - a repeat `GskRenderNode` + a repeat `GskRenderNode` - - A render node for a repeating linear gradient. - - Creates a `GskRenderNode` that will create a repeating linear gradient + + A render node for a repeating linear gradient. + + Creates a `GskRenderNode` that will create a repeating linear gradient from the given points and color stops, and render that into the area given by @bounds. + - A new `GskRenderNode` + A new `GskRenderNode` - the rectangle to render the linear gradient into + the rectangle to render the linear gradient into - the point at which the linear gradient will begin + the point at which the linear gradient will begin - the point at which the linear gradient will finish + the point at which the linear gradient will finish - a pointer to an array of + a pointer to an array of `GskColorStop` defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1. @@ -2688,51 +4387,81 @@ given by @bounds. - the number of elements in @color_stops + the number of elements in @color_stops - - A render node for a repeating radial gradient. - - Creates a `GskRenderNode` that draws a repeating radial gradient. + + A render node for a repeating radial gradient. + + Creates a `GskRenderNode` that draws a repeating radial gradient. The radial gradient starts around @center. The size of the gradient is dictated by @hradius in horizontal orientation and by @vradius in vertial orientation. + - A new `GskRenderNode` + A new `GskRenderNode` - the bounds of the node + the bounds of the node - the center of the gradient + the center of the gradient - the horizontal radius + the horizontal radius - the vertical radius + the vertical radius - a percentage >= 0 that defines the start of the gradient around @center + a percentage >= 0 that defines the start of the gradient around @center - a percentage >= 0 that defines the end of the gradient around @center + a percentage >= 0 that defines the end of the gradient around @center - a pointer to an array of + a pointer to an array of `GskColorStop` defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1. @@ -2741,61 +4470,96 @@ in vertial orientation. - the number of elements in @color_stops + the number of elements in @color_stops - - A render node applying a rounded rectangle clip to its single child. + + A render node applying a rounded rectangle clip to its single child. - Creates a `GskRenderNode` that will clip the @child to the area + Creates a `GskRenderNode` that will clip the @child to the area given by @clip. + - A new `GskRenderNode` + A new `GskRenderNode` - The node to draw + The node to draw - The clip to apply + The clip to apply - Gets the child node that is getting clipped by the given @node. + Gets the child node that is getting clipped by the given @node. + - The child that is getting clipped + The child that is getting clipped - a rounded clip `GskRenderNode` + a rounded clip `GskRenderNode` - Retrieves the rounded rectangle used to clip the contents of the @node. + Retrieves the rounded rectangle used to clip the contents of the @node. + - a rounded rectangle + a rounded rectangle - a rounded clip `GskRenderNode` + a rounded clip `GskRenderNode` - A rectangular region with rounded corners. + A rectangular region with rounded corners. Application code should normalize rectangles using [method@Gsk.RoundedRect.normalize]; this function will ensure that @@ -2808,204 +4572,305 @@ will always return a normalized one. The algorithm used for normalizing corner sizes is described in [the CSS specification](https://drafts.csswg.org/css-backgrounds-3/#border-radius). + - the bounds of the rectangle + the bounds of the rectangle - the size of the 4 rounded corners + the size of the 4 rounded corners - - Checks if the given @point is inside the rounded rectangle. + + Checks if the given @point is inside the rounded rectangle. + - %TRUE if the @point is inside the rounded rectangle + %TRUE if the @point is inside the rounded rectangle - a `GskRoundedRect` + a `GskRoundedRect` - the point to check + the point to check - - Checks if the given @rect is contained inside the rounded rectangle. + + Checks if the given @rect is contained inside the rounded rectangle. + - %TRUE if the @rect is fully contained inside the rounded rectangle + %TRUE if the @rect is fully contained inside the rounded rectangle - a `GskRoundedRect` + a `GskRoundedRect` - the rectangle to check + the rectangle to check - Initializes the given `GskRoundedRect` with the given values. + Initializes the given `GskRoundedRect` with the given values. This function will implicitly normalize the `GskRoundedRect` before returning. + - the initialized rectangle + the initialized rectangle - The `GskRoundedRect` to initialize + The `GskRoundedRect` to initialize - a `graphene_rect_t` describing the bounds + a `graphene_rect_t` describing the bounds - the rounding radius of the top left corner + the rounding radius of the top left corner - the rounding radius of the top right corner + the rounding radius of the top right corner - the rounding radius of the bottom right corner + the rounding radius of the bottom right corner - the rounding radius of the bottom left corner + the rounding radius of the bottom left corner - Initializes @self using the given @src rectangle. + Initializes @self using the given @src rectangle. This function will not normalize the `GskRoundedRect`, so make sure the source is normalized. + - the initialized rectangle + the initialized rectangle - a `GskRoundedRect` + a `GskRoundedRect` - a `GskRoundedRect` + a `GskRoundedRect` - - Initializes @self to the given @bounds and sets the radius + + Initializes @self to the given @bounds and sets the radius of all four corners to @radius. + - the initialized rectangle + the initialized rectangle - a `GskRoundedRect` + a `GskRoundedRect` - a `graphene_rect_t` + a `graphene_rect_t` - the border radius + the border radius - - Checks if part of the given @rect is contained inside the rounded rectangle. + + Checks if part of the given @rect is contained inside the rounded rectangle. + - %TRUE if the @rect intersects with the rounded rectangle + %TRUE if the @rect intersects with the rounded rectangle - a `GskRoundedRect` + a `GskRoundedRect` - the rectangle to check + the rectangle to check - - Checks if all corners of @self are right angles and the + + Checks if all corners of @self are right angles and the rectangle covers all of its bounds. This information can be used to decide if [ctor@Gsk.ClipNode.new] or [ctor@Gsk.RoundedClipNode.new] should be called. + - %TRUE if the rectangle is rectilinear + %TRUE if the rectangle is rectilinear - the `GskRoundedRect` to check + the `GskRoundedRect` to check - Normalizes the passed rectangle. + Normalizes the passed rectangle. This function will ensure that the bounds of the rectangle are normalized and ensure that the corner values are positive and the corners do not overlap. + - the normalized rectangle + the normalized rectangle - a `GskRoundedRect` + a `GskRoundedRect` - Offsets the bound's origin by @dx and @dy. + Offsets the bound's origin by @dx and @dy. The size and corners of the rectangle are unchanged. + - the offset rectangle + the offset rectangle - a `GskRoundedRect` + a `GskRoundedRect` - the horizontal offset + the horizontal offset - the vertical offset + the vertical offset - Shrinks (or grows) the given rectangle by moving the 4 sides + Shrinks (or grows) the given rectangle by moving the 4 sides according to the offsets given. The corner radii will be changed in a way that tries to keep @@ -3013,62 +4878,116 @@ the center of the corner circle intact. This emulates CSS behavior. This function also works for growing rectangles if you pass negative values for the @top, @right, @bottom or @left. + - the resized `GskRoundedRect` + the resized `GskRoundedRect` - The `GskRoundedRect` to shrink or grow + The `GskRoundedRect` to shrink or grow - How far to move the top side downwards + How far to move the top side downwards - How far to move the right side to the left + How far to move the right side to the left - How far to move the bottom side upwards + How far to move the bottom side upwards - How far to move the left side to the right + How far to move the left side to the right - - The filters used when scaling texture data. + + The filters used when scaling texture data. The actual implementation of each filter is deferred to the rendering pipeline. - - linear interpolation filter + + linear interpolation filter - - nearest neighbor interpolation filter + + nearest neighbor interpolation filter - - linear interpolation along each axis, + + linear interpolation along each axis, plus mipmap generation, with linear interpolation along the mipmap levels - - Errors that can happen during (de)serialization. - - The format can not be identified + + Errors that can happen during (de)serialization. + + The format can not be identified - - The version of the data is not + + The version of the data is not understood - - The given data may not exist in + + The given data may not exist in a proper serialization @@ -3077,214 +4996,315 @@ rendering pipeline. - - An object to build the uniforms data for a `GskGLShader`. + + An object to build the uniforms data for a `GskGLShader`. + - Allocates a builder that can be used to construct a new uniform data + Allocates a builder that can be used to construct a new uniform data chunk. + - The newly allocated builder, free with + The newly allocated builder, free with [method@Gsk.ShaderArgsBuilder.unref] - a `GskGLShader` + a `GskGLShader` - - optional `GBytes` with initial values + + optional `GBytes` with initial values - - Creates a new `GBytes` args from the current state of the + + Creates a new `GBytes` args from the current state of the given @builder, and frees the @builder instance. Any uniforms of the shader that have not been explicitly set on the @builder are zero-initialized. + - the newly allocated buffer with + the newly allocated buffer with all the args added to @builder - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - Increases the reference count of a `GskShaderArgsBuilder` by one. + Increases the reference count of a `GskShaderArgsBuilder` by one. + - the passed in `GskShaderArgsBuilder` + the passed in `GskShaderArgsBuilder` - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - Sets the value of the uniform @idx. + Sets the value of the uniform @idx. The uniform must be of bool type. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform to + value to set the uniform to - - Sets the value of the uniform @idx. + + Sets the value of the uniform @idx. The uniform must be of float type. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform to + value to set the uniform to - Sets the value of the uniform @idx. + Sets the value of the uniform @idx. The uniform must be of int type. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform to + value to set the uniform to - Sets the value of the uniform @idx. + Sets the value of the uniform @idx. The uniform must be of uint type. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform to + value to set the uniform to - Sets the value of the uniform @idx. + Sets the value of the uniform @idx. The uniform must be of vec2 type. + - A `GskShaderArgsBuilder` + A `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform too + value to set the uniform too - Sets the value of the uniform @idx. + Sets the value of the uniform @idx. The uniform must be of vec3 type. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform too + value to set the uniform too - Sets the value of the uniform @idx. + Sets the value of the uniform @idx. The uniform must be of vec4 type. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - index of the uniform + index of the uniform - value to set the uniform too + value to set the uniform too - Creates a new `GBytes` args from the current state of the + Creates a new `GBytes` args from the current state of the given @builder. Any uniforms of the shader that have not been explicitly set on @@ -3295,273 +5315,439 @@ you cannot call this function multiple times on the same @builder instance. This function is intended primarily for bindings. C code should use [method@Gsk.ShaderArgsBuilder.free_to_args]. + - the newly allocated buffer with + the newly allocated buffer with all the args added to @builder - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - Decreases the reference count of a `GskShaderArgBuilder` by one. + Decreases the reference count of a `GskShaderArgBuilder` by one. If the resulting reference count is zero, frees the builder. + - a `GskShaderArgsBuilder` + a `GskShaderArgsBuilder` - The shadow parameters in a shadow node. + The shadow parameters in a shadow node. + - the color of the shadow + the color of the shadow - the horizontal offset of the shadow + the horizontal offset of the shadow - the vertical offset of the shadow + the vertical offset of the shadow - the radius of the shadow + the radius of the shadow - - A render node drawing one or more shadows behind its single child node. + + A render node drawing one or more shadows behind its single child node. - Creates a `GskRenderNode` that will draw a @child with the given + Creates a `GskRenderNode` that will draw a @child with the given @shadows below it. + - A new `GskRenderNode` + A new `GskRenderNode` - The node to draw + The node to draw - The shadows to apply + The shadows to apply - number of entries in the @shadows array + number of entries in the @shadows array - Retrieves the child `GskRenderNode` of the shadow @node. + Retrieves the child `GskRenderNode` of the shadow @node. + - the child render node + the child render node - a shadow `GskRenderNode` + a shadow `GskRenderNode` - - Retrieves the number of shadows in the @node. + + Retrieves the number of shadows in the @node. + - the number of shadows. + the number of shadows. - a shadow `GskRenderNode` + a shadow `GskRenderNode` - Retrieves the shadow data at the given index @i. + Retrieves the shadow data at the given index @i. + - the shadow data + the shadow data - a shadow `GskRenderNode` + a shadow `GskRenderNode` - the given index + the given index - - A render node drawing a set of glyphs. + + A render node drawing a set of glyphs. - Creates a render node that renders the given glyphs. + Creates a render node that renders the given glyphs. Note that @color may not be used if the font contains color glyphs. + - a new `GskRenderNode` + a new `GskRenderNode` - the `PangoFont` containing the glyphs + the `PangoFont` containing the glyphs - the `PangoGlyphString` to render + the `PangoGlyphString` to render - the foreground color to render with + the foreground color to render with - offset of the baseline + offset of the baseline - Retrieves the color used by the text @node. + Retrieves the color used by the text @node. + - the text color + the text color - a text `GskRenderNode` + a text `GskRenderNode` - Returns the font used by the text @node. + Returns the font used by the text @node. + - the font + the font - The `GskRenderNode` + The `GskRenderNode` - Retrieves the glyph information in the @node. + Retrieves the glyph information in the @node. + - the glyph information + the glyph information - a text `GskRenderNode` + a text `GskRenderNode` - - the number of glyphs returned + + the number of glyphs returned - - Retrieves the number of glyphs in the text node. + + Retrieves the number of glyphs in the text node. + - the number of glyphs + the number of glyphs - a text `GskRenderNode` + a text `GskRenderNode` - Retrieves the offset applied to the text. + Retrieves the offset applied to the text. + - a point with the horizontal and vertical offsets + a point with the horizontal and vertical offsets - a text `GskRenderNode` + a text `GskRenderNode` - - Checks whether the text @node has color glyphs. + + Checks whether the text @node has color glyphs. + - %TRUE if the text node has color glyphs + %TRUE if the text node has color glyphs - a text `GskRenderNode` + a text `GskRenderNode` - - A render node for a `GdkTexture`. + + A render node for a `GdkTexture`. - Creates a `GskRenderNode` that will render the given + Creates a `GskRenderNode` that will render the given @texture into the area given by @bounds. + - A new `GskRenderNode` + A new `GskRenderNode` - the `GdkTexture` + the `GdkTexture` - the rectangle to render the texture into + the rectangle to render the texture into - Retrieves the `GdkTexture` used when creating this `GskRenderNode`. + Retrieves the `GdkTexture` used when creating this `GskRenderNode`. + - the `GdkTexture` + the `GdkTexture` - a `GskRenderNode` of type %GSK_TEXTURE_NODE + a `GskRenderNode` of type %GSK_TEXTURE_NODE - - `GskTransform` is an object to describe transform matrices. + + `GskTransform` is an object to describe transform matrices. Unlike `graphene_matrix_t`, `GskTransform` retains the steps in how a transform was constructed, and allows inspecting them. It is modeled @@ -3570,95 +5756,156 @@ after the way CSS describes transforms. `GskTransform` objects are immutable and cannot be changed after creation. This means code can safely expose them as properties of objects without having to worry about others changing them. + + - Checks two transforms for equality. + Checks two transforms for equality. + - %TRUE if the two transforms perform the same operation + %TRUE if the two transforms perform the same operation - - the first transform + + the first transform - - the second transform + + the second transform - Returns the category this transform belongs to. + Returns the category this transform belongs to. + - The category of the transform + The category of the transform - - A `GskTransform` + + A `GskTransform` - Inverts the given transform. + Inverts the given transform. If @self is not invertible, %NULL is returned. Note that inverting %NULL also returns %NULL, which is the correct inverse of %NULL. If you need to differentiate between those cases, you should check @self is not %NULL before calling this function. + - The inverted transform + The inverted transform - - Transform to invert + + Transform to invert - Multiplies @next with the given @matrix. + Multiplies @next with the given @matrix. + - The new transform + The new transform - - the next transform + + the next transform - the matrix to multiply @next with + the matrix to multiply @next with - Applies a perspective projection transform. + Applies a perspective projection transform. This transform scales points in X and Y based on their Z value, scaling points with positive Z values away from the origin, and those with negative Z values towards the origin. Points on the z=0 plane are unchanged. + - The new transform + The new transform - - the next transform + + the next transform - distance of the z=0 plane. Lower values give a more + distance of the z=0 plane. Lower values give a more flattened pyramid and therefore a more pronounced perspective effect. @@ -3666,128 +5913,206 @@ on the z=0 plane are unchanged. - Converts @self into a human-readable string representation suitable + Converts @self into a human-readable string representation suitable for printing. The result of this function can later be parsed with [func@Gsk.Transform.parse]. + - - a `GskTransform` + + a `GskTransform` - The string to print into + The string to print into - Acquires a reference on the given `GskTransform`. + Acquires a reference on the given `GskTransform`. + - the `GskTransform` with an additional reference + the `GskTransform` with an additional reference - - a `GskTransform` + + a `GskTransform` - Rotates @next @angle degrees in 2D - or in 3D-speak, around the z axis. + Rotates @next @angle degrees in 2D - or in 3D-speak, around the z axis. + - The new transform + The new transform - - the next transform + + the next transform - the rotation angle, in degrees (clockwise) + the rotation angle, in degrees (clockwise) - Rotates @next @angle degrees around @axis. + Rotates @next @angle degrees around @axis. For a rotation in 2D space, use [method@Gsk.Transform.rotate] + - The new transform + The new transform - - the next transform + + the next transform - the rotation angle, in degrees (clockwise) + the rotation angle, in degrees (clockwise) - The rotation axis + The rotation axis - Scales @next in 2-dimensional space by the given factors. + Scales @next in 2-dimensional space by the given factors. Use [method@Gsk.Transform.scale_3d] to scale in all 3 dimensions. + - The new transform + The new transform - - the next transform + + the next transform - scaling factor on the X axis + scaling factor on the X axis - scaling factor on the Y axis + scaling factor on the Y axis - Scales @next by the given factors. + Scales @next by the given factors. + - The new transform + The new transform - - the next transform + + the next transform - scaling factor on the X axis + scaling factor on the X axis - scaling factor on the Y axis + scaling factor on the Y axis - scaling factor on the Z axis + scaling factor on the Z axis - Converts a `GskTransform` to a 2D transformation matrix. + Converts a `GskTransform` to a 2D transformation matrix. @self must be a 2D transformation. If you are not sure, use gsk_transform_get_category() >= @@ -3804,42 +6129,77 @@ The returned values have the following layout: This function can be used to convert between a `GskTransform` and a matrix type from other 2D drawing libraries, in particular Cairo. + - a 2D `GskTransform` + a 2D `GskTransform` - - return location for the xx member + + return location for the xx member - - return location for the yx member + + return location for the yx member - - return location for the xy member + + return location for the xy member - - return location for the yy member + + return location for the yy member - - return location for the x0 member + + return location for the x0 member - - return location for the y0 member + + return location for the y0 member - Converts a `GskTransform` to 2D affine transformation factors. + Converts a `GskTransform` to 2D affine transformation factors. @self must be a 2D transformation. If you are not sure, use @@ -3847,73 +6207,121 @@ sure, use gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D_AFFINE to check. + - a `GskTransform` + a `GskTransform` - - return location for the scale + + return location for the scale factor in the x direction - - return location for the scale + + return location for the scale factor in the y direction - - return location for the translation + + return location for the translation in the x direction - - return location for the translation + + return location for the translation in the y direction - Computes the actual value of @self and stores it in @out_matrix. + Computes the actual value of @self and stores it in @out_matrix. The previous value of @out_matrix will be ignored. + - - a `GskTransform` + + a `GskTransform` - - The matrix to set + + The matrix to set - Converts a matrix into a string that is suitable for printing. + Converts a matrix into a string that is suitable for printing. The resulting string can be parsed with [func@Gsk.Transform.parse]. This is a wrapper around [method@Gsk.Transform.print]. + - A new string for @self + A new string for @self - - a `GskTransform` + + a `GskTransform` - Converts a `GskTransform` to a translation operation. + Converts a `GskTransform` to a translation operation. @self must be a 2D transformation. If you are not sure, use @@ -3921,138 +6329,226 @@ sure, use gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D_TRANSLATE to check. + - a `GskTransform` + a `GskTransform` - - return location for the translation + + return location for the translation in the x direction - - return location for the translation + + return location for the translation in the y direction - Applies all the operations from @other to @next. + Applies all the operations from @other to @next. + - The new transform + The new transform - - Transform to apply @other to + + Transform to apply @other to - - Transform to apply + + Transform to apply - - Transforms a `graphene_rect_t` using the given transform @self. + + Transforms a `graphene_rect_t` using the given transform @self. The result is the bounding box containing the coplanar quad. + - a `GskTransform` + a `GskTransform` - a `graphene_rect_t` + a `graphene_rect_t` - - return location for the bounds + + return location for the bounds of the transformed rectangle - - Transforms a `graphene_point_t` using the given transform @self. + + Transforms a `graphene_point_t` using the given transform @self. + - a `GskTransform` + a `GskTransform` - a `graphene_point_t` + a `graphene_point_t` - - return location for + + return location for the transformed point - Translates @next in 2-dimensional space by @point. + Translates @next in 2-dimensional space by @point. + - The new transform + The new transform - - the next transform + + the next transform - the point to translate the transform by + the point to translate the transform by - Translates @next by @point. + Translates @next by @point. + - The new transform + The new transform - - the next transform + + the next transform - the point to translate the transform by + the point to translate the transform by - Releases a reference on the given `GskTransform`. + Releases a reference on the given `GskTransform`. If the reference was the last, the resources associated to the @self are freed. + - - a `GskTransform` + + a `GskTransform` - Parses the given @string into a transform and puts it in + Parses the given @string into a transform and puts it in @out_transform. Strings printed via [method@Gsk.Transform.to_string] @@ -4060,24 +6556,39 @@ can be read in again successfully using this function. If @string does not describe a valid transform, %FALSE is returned and %NULL is put in @out_transform. + - %TRUE if @string described a valid transform. + %TRUE if @string described a valid transform. - the string to parse + the string to parse - - The location to put the transform in + + The location to put the transform in - - The categories of matrices relevant for GSK and GTK. + + The categories of matrices relevant for GSK and GTK. Note that any category includes matrices of all later categories. So if you want to for example check if a matrix is a 2D matrix, @@ -4087,89 +6598,162 @@ Also keep in mind that rounding errors may cause matrices to not conform to their categories. Otherwise, matrix operations done via multiplication will not worsen categories. So for the matrix multiplication `C = A * B`, `category(C) = MIN (category(A), category(B))`. - - The category of the matrix has not been + + The category of the matrix has not been determined. - - Analyzing the matrix concluded that it does + + Analyzing the matrix concluded that it does not fit in any other category. - - The matrix is a 3D matrix. This means that + + The matrix is a 3D matrix. This means that the w column (the last column) has the values (0, 0, 0, 1). - - The matrix is a 2D matrix. This is equivalent + + The matrix is a 2D matrix. This is equivalent to graphene_matrix_is_2d() returning %TRUE. In particular, this means that Cairo can deal with the matrix. - - The matrix is a combination of 2D scale + + The matrix is a combination of 2D scale and 2D translation operations. In particular, this means that any rectangle can be transformed exactly using this matrix. - - The matrix is a 2D translation. + + The matrix is a 2D translation. - - The matrix is the identity matrix. + + The matrix is the identity matrix. - - A render node applying a `GskTransform` to its single child node. + + A render node applying a `GskTransform` to its single child node. - Creates a `GskRenderNode` that will transform the given @child + Creates a `GskRenderNode` that will transform the given @child with the given @transform. + - A new `GskRenderNode` + A new `GskRenderNode` - The node to transform + The node to transform - The transform to apply + The transform to apply - Gets the child node that is getting transformed by the given @node. + Gets the child node that is getting transformed by the given @node. + - The child that is getting transformed + The child that is getting transformed - a `GskRenderNode` for a transform + a `GskRenderNode` for a transform - - Retrieves the `GskTransform` used by the @node. + + Retrieves the `GskTransform` used by the @node. + - a `GskTransform` + a `GskTransform` - a `GskRenderNode` for a transform + a `GskRenderNode` for a transform - + - - Parses the given @string into a transform and puts it in + + Parses the given @string into a transform and puts it in @out_transform. Strings printed via [method@Gsk.Transform.to_string] @@ -4177,17 +6761,27 @@ can be read in again successfully using this function. If @string does not describe a valid transform, %FALSE is returned and %NULL is put in @out_transform. + - %TRUE if @string described a valid transform. + %TRUE if @string described a valid transform. - the string to parse + the string to parse - - The location to put the transform in + + The location to put the transform in diff --git a/Gtk-3.0.gir b/Gtk-3.0.gir index 4449349..3acadf7 100644 --- a/Gtk-3.0.gir +++ b/Gtk-3.0.gir @@ -2,10 +2,7 @@ - + @@ -13,18 +10,12 @@ and/or use gtk-doc annotations. --> - + - A #GtkAllocation-struct of a widget represents region + A #GtkAllocation-struct of a widget represents region which has been allocated to the widget by its parent. It is a subregion of its parents allocation. See -[GtkWidget’s geometry management section][geometry-management] for +[GtkWidget’s geometry management section][geometry-management] for more information. @@ -33,135 +24,105 @@ more information. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -175,315 +136,245 @@ more information. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -497,115 +388,85 @@ more information. - + - + - + - + - + - + - + - + - + - + - + - - The GtkAboutDialog offers a simple way to display information about + + The GtkAboutDialog offers a simple way to display information about a program like its logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically @@ -641,21 +502,15 @@ gtk_show_about_dialog (NULL, It is also possible to show a #GtkAboutDialog like any other #GtkDialog, e.g. using gtk_dialog_run(). In this case, you might need to know that -the “Close” button returns the #GTK_RESPONSE_CANCEL response id. +the “Close” button returns the #GTK_RESPONSE_CANCEL response id. - - Creates a new #GtkAboutDialog. + + Creates a new #GtkAboutDialog. - a newly created #GtkAboutDialog + a newly created #GtkAboutDialog @@ -673,51 +528,35 @@ the “Close” button returns the #GTK_RESPONSE_CANCEL response id. - - Creates a new section in the Credits page. + + Creates a new section in the Credits page. - A #GtkAboutDialog + A #GtkAboutDialog - The name of the section + The name of the section - The people who belong to that section + The people who belong to that section - - Returns the string which are displayed in the artists tab + + Returns the string which are displayed in the artists tab of the secondary credits dialog. - A + A %NULL-terminated string array containing the artists. The array is owned by the about dialog and must not be modified. @@ -726,25 +565,17 @@ of the secondary credits dialog. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the string which are displayed in the authors tab + + Returns the string which are displayed in the authors tab of the secondary credits dialog. - A + A %NULL-terminated string array containing the authors. The array is owned by the about dialog and must not be modified. @@ -753,71 +584,47 @@ of the secondary credits dialog. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the comments string. + + Returns the comments string. - The comments. The string is owned by the about + The comments. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the copyright string. + + Returns the copyright string. - The copyright string. The string is owned by the about + The copyright string. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the string which are displayed in the documenters + + Returns the string which are displayed in the documenters tab of the secondary credits dialog. - A + A %NULL-terminated string array containing the documenters. The array is owned by the about dialog and must not be modified. @@ -826,251 +633,165 @@ tab of the secondary credits dialog. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the license information. + + Returns the license information. - The license information. The string is owned by the about + The license information. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Retrieves the license set using gtk_about_dialog_set_license_type() + + Retrieves the license set using gtk_about_dialog_set_license_type() - a #GtkLicense value + a #GtkLicense value - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the pixbuf displayed as logo in the about dialog. + + Returns the pixbuf displayed as logo in the about dialog. - the pixbuf displayed as logo. The + the pixbuf displayed as logo. The pixbuf is owned by the about dialog. If you want to keep a reference to it, you have to call g_object_ref() on it. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the icon name displayed as logo in the about dialog. + + Returns the icon name displayed as logo in the about dialog. - the icon name displayed as logo. The string is + the icon name displayed as logo. The string is owned by the dialog. If you want to keep a reference to it, you have to call g_strdup() on it. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the program name displayed in the about dialog. + + Returns the program name displayed in the about dialog. - The program name. The string is owned by the about + The program name. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the translator credits string which is displayed + + Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog. - The translator credits string. The string is + The translator credits string. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the version string. + + Returns the version string. - The version string. The string is owned by the about + The version string. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the website URL. + + Returns the website URL. - The website URL. The string is owned by the about + The website URL. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns the label used for the website link. + + Returns the label used for the website link. - The label used for the website link. The string is + The label used for the website link. The string is owned by the about dialog and must not be modified. - a #GtkAboutDialog + a #GtkAboutDialog - - Returns whether the license text in @about is + + Returns whether the license text in @about is automatically wrapped. - %TRUE if the license text is wrapped + %TRUE if the license text is wrapped - a #GtkAboutDialog + a #GtkAboutDialog - - Sets the strings which are displayed in the artists tab + + Sets the strings which are displayed in the artists tab of the secondary credits dialog. @@ -1078,27 +799,19 @@ of the secondary credits dialog. - a #GtkAboutDialog + a #GtkAboutDialog - a %NULL-terminated array of strings + a %NULL-terminated array of strings - - Sets the strings which are displayed in the authors tab + + Sets the strings which are displayed in the authors tab of the secondary credits dialog. @@ -1106,27 +819,19 @@ of the secondary credits dialog. - a #GtkAboutDialog + a #GtkAboutDialog - a %NULL-terminated array of strings + a %NULL-terminated array of strings - - Sets the comments string to display in the about dialog. + + Sets the comments string to display in the about dialog. This should be a short string of one or two lines. @@ -1134,28 +839,17 @@ This should be a short string of one or two lines. - a #GtkAboutDialog + a #GtkAboutDialog - - a comments string + + a comments string - - Sets the copyright string to display in the about dialog. + + Sets the copyright string to display in the about dialog. This should be a short string of one or two lines. @@ -1163,28 +857,17 @@ This should be a short string of one or two lines. - a #GtkAboutDialog + a #GtkAboutDialog - - the copyright string + + the copyright string - - Sets the strings which are displayed in the documenters tab + + Sets the strings which are displayed in the documenters tab of the secondary credits dialog. @@ -1192,27 +875,19 @@ of the secondary credits dialog. - a #GtkAboutDialog + a #GtkAboutDialog - a %NULL-terminated array of strings + a %NULL-terminated array of strings - - Sets the license information to be displayed in the secondary + + Sets the license information to be displayed in the secondary license dialog. If @license is %NULL, the license button is hidden. @@ -1221,28 +896,17 @@ hidden. - a #GtkAboutDialog + a #GtkAboutDialog - - the license information or %NULL + + the license information or %NULL - - Sets the license of the application showing the @about dialog from a + + Sets the license of the application showing the @about dialog from a list of known licenses. This function overrides the license set using @@ -1253,25 +917,17 @@ gtk_about_dialog_set_license(). - a #GtkAboutDialog + a #GtkAboutDialog - the type of license + the type of license - - Sets the pixbuf to be displayed as logo in the about dialog. + + Sets the pixbuf to be displayed as logo in the about dialog. If it is %NULL, the default window icon set with gtk_window_set_default_icon() will be used. @@ -1280,28 +936,17 @@ gtk_window_set_default_icon() will be used. - a #GtkAboutDialog + a #GtkAboutDialog - - a #GdkPixbuf, or %NULL + + a #GdkPixbuf, or %NULL - - Sets the pixbuf to be displayed as logo in the about dialog. + + Sets the pixbuf to be displayed as logo in the about dialog. If it is %NULL, the default window icon set with gtk_window_set_default_icon() will be used. @@ -1310,28 +955,17 @@ gtk_window_set_default_icon() will be used. - a #GtkAboutDialog + a #GtkAboutDialog - - an icon name, or %NULL + + an icon name, or %NULL - - Sets the name to display in the about dialog. + + Sets the name to display in the about dialog. If this is not set, it defaults to g_get_application_name(). @@ -1339,25 +973,17 @@ If this is not set, it defaults to g_get_application_name(). - a #GtkAboutDialog + a #GtkAboutDialog - the program name + the program name - - Sets the translator credits string which is displayed in + + Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog. The intended use for this string is to display the translator @@ -1369,9 +995,9 @@ GtkWidget *about = gtk_about_dialog_new (); gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about), _("translator-credits")); ]| -It is a good idea to use the customary msgid “translator-credits” for this +It is a good idea to use the customary msgid “translator-credits” for this purpose, since translators will already know the purpose of that msgid, and -since #GtkAboutDialog will detect if “translator-credits” is untranslated +since #GtkAboutDialog will detect if “translator-credits” is untranslated and hide the tab. @@ -1379,109 +1005,68 @@ and hide the tab. - a #GtkAboutDialog + a #GtkAboutDialog - - the translator credits + + the translator credits - - Sets the version string to display in the about dialog. + + Sets the version string to display in the about dialog. - a #GtkAboutDialog + a #GtkAboutDialog - - the version string + + the version string - - Sets the URL to use for the website link. + + Sets the URL to use for the website link. - a #GtkAboutDialog + a #GtkAboutDialog - - a URL string starting with "http://" + + a URL string starting with "http://" - - Sets the label to be used for the website link. + + Sets the label to be used for the website link. - a #GtkAboutDialog + a #GtkAboutDialog - the label used for the website link + the label used for the website link - - Sets whether the license text in @about is + + Sets whether the license text in @about is automatically wrapped. @@ -1489,85 +1074,51 @@ automatically wrapped. - a #GtkAboutDialog + a #GtkAboutDialog - whether to wrap the license + whether to wrap the license - - The people who contributed artwork to the program, as a %NULL-terminated + + The people who contributed artwork to the program, as a %NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. - - The authors of the program, as a %NULL-terminated array of strings. + + The authors of the program, as a %NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. - - Comments about the program. This string is displayed in a label + + Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features. - - Copyright information for the program. + + Copyright information for the program. - - The people documenting the program, as a %NULL-terminated array of strings. + + The people documenting the program, as a %NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. - - The license of the program. This string is displayed in a + + The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the "wrap-license" property is set to %TRUE; @@ -1577,13 +1128,8 @@ When setting this property to a non-%NULL value, the as a side effect. - - The license of the program, as a value of the %GtkLicense enumeration. + + The license of the program, as a value of the %GtkLicense enumeration. The #GtkAboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license @@ -1600,82 +1146,42 @@ For any other #GtkLicense value, the contents of the a side effect. - - A logo for the about box. If it is %NULL, the default window icon + + A logo for the about box. If it is %NULL, the default window icon set with gtk_window_set_default_icon() will be used. - - A named icon to use as the logo for the about box. This property + + A named icon to use as the logo for the about box. This property overrides the #GtkAboutDialog:logo property. - - The name of the program. + + The name of the program. If this is not set, it defaults to g_get_application_name(). - - Credits to the translators. This string should be marked as translatable. + + Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. - - The version of the program. + + The version of the program. - - The URL for the link to the website of the program. + + The URL for the link to the website of the program. This should be a string starting with "http://. - - The label for the link to the website of the program. + + The label for the link to the website of the program. - - Whether to wrap the text in the license dialog. + + Whether to wrap the text in the license dialog. @@ -1685,30 +1191,22 @@ This should be a string starting with "http://. - The signal which gets emitted to activate a URI. + The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri_on_window(). - %TRUE if the link has been activated + %TRUE if the link has been activated - the URI that is activated + the URI that is activated - + @@ -1762,99 +1260,58 @@ which is to call gtk_show_uri_on_window(). - + - - Accelerator flags used with gtk_accel_group_connect(). - - Accelerator is visible + + Accelerator flags used with gtk_accel_group_connect(). + + Accelerator is visible - - Accelerator not removable + + Accelerator not removable - - Mask + + Mask - - A #GtkAccelGroup represents a group of keyboard accelerators, + + A #GtkAccelGroup represents a group of keyboard accelerators, typically attached to a toplevel #GtkWindow (with -gtk_window_add_accel_group()). Usually you won’t need to create a +gtk_window_add_accel_group()). Usually you won’t need to create a #GtkAccelGroup directly; instead, when using #GtkUIManager, GTK+ automatically sets up the accelerators for your menus in the ui -manager’s #GtkAccelGroup. +manager’s #GtkAccelGroup. -Note that “accelerators” are different from -“mnemonics”. Accelerators are shortcuts for -activating a menu item; they appear alongside the menu item they’re a -shortcut for. For example “Ctrl+Q” might appear alongside the “Quit” +Note that “accelerators” are different from +“mnemonics”. Accelerators are shortcuts for +activating a menu item; they appear alongside the menu item they’re a +shortcut for. For example “Ctrl+Q” might appear alongside the “Quit” menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined characters. See gtk_label_new_with_mnemonic(). Menu items can have both accelerators and mnemonics, of course. - Creates a new #GtkAccelGroup. + Creates a new #GtkAccelGroup. - a new #GtkAccelGroup object + a new #GtkAccelGroup object - - Finds the #GtkAccelGroup to which @closure is connected; + + Finds the #GtkAccelGroup to which @closure is connected; see gtk_accel_group_connect(). - the #GtkAccelGroup to which @closure + the #GtkAccelGroup to which @closure is connected, or %NULL - a #GClosure + a #GClosure @@ -1880,56 +1337,40 @@ see gtk_accel_group_connect(). - Finds the first accelerator in @accel_group that matches + Finds the first accelerator in @accel_group that matches @accel_key and @accel_mods, and activates it. - %TRUE if an accelerator was activated and handled + %TRUE if an accelerator was activated and handled this keypress - a #GtkAccelGroup + a #GtkAccelGroup - the quark for the accelerator name + the quark for the accelerator name - the #GObject, usually a #GtkWindow, on which + the #GObject, usually a #GtkWindow, on which to activate the accelerator - accelerator keyval from a key event + accelerator keyval from a key event - keyboard state mask from a key event + keyboard state mask from a key event - Installs an accelerator in this group. When @accel_group is being + Installs an accelerator in this group. When @accel_group is being activated in response to a call to gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate() match those of this connection. @@ -1944,42 +1385,29 @@ only be connected to one accelerator group. - the accelerator group to install an accelerator in + the accelerator group to install an accelerator in - key value of the accelerator + key value of the accelerator - modifier combination of the accelerator + modifier combination of the accelerator - a flag mask to configure this accelerator + a flag mask to configure this accelerator - closure to be executed upon accelerator activation + closure to be executed upon accelerator activation - - Installs an accelerator in this group, using an accelerator path + + Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers (see gtk_accel_map_add_entry()). When @accel_group is being activated in response to a call to gtk_accel_groups_activate(), @closure will @@ -1997,185 +1425,123 @@ first with g_intern_static_string(). - the accelerator group to install an accelerator in + the accelerator group to install an accelerator in - path used for determining key and modifiers + path used for determining key and modifiers - closure to be executed upon accelerator activation + closure to be executed upon accelerator activation - Removes an accelerator previously installed through + Removes an accelerator previously installed through gtk_accel_group_connect(). Since 2.20 @closure can be %NULL. - %TRUE if the closure was found and got disconnected + %TRUE if the closure was found and got disconnected - the accelerator group to remove an accelerator from + the accelerator group to remove an accelerator from - - the closure to remove from this accelerator + + the closure to remove from this accelerator group, or %NULL to remove all closures - - Removes an accelerator previously installed through + + Removes an accelerator previously installed through gtk_accel_group_connect(). - %TRUE if there was an accelerator which could be + %TRUE if there was an accelerator which could be removed, %FALSE otherwise - the accelerator group to install an accelerator in + the accelerator group to install an accelerator in - key value of the accelerator + key value of the accelerator - modifier combination of the accelerator + modifier combination of the accelerator - Finds the first entry in an accelerator group for which + Finds the first entry in an accelerator group for which @find_func returns %TRUE and returns its #GtkAccelKey. - the key of the first entry passing + the key of the first entry passing @find_func. The key is owned by GTK+ and must not be freed. - a #GtkAccelGroup + a #GtkAccelGroup - - a function to filter the entries + + a function to filter the entries of @accel_group with - - data to pass to @find_func + + data to pass to @find_func - - Locks are added and removed using gtk_accel_group_lock() and + + Locks are added and removed using gtk_accel_group_lock() and gtk_accel_group_unlock(). - %TRUE if there are 1 or more locks on the @accel_group, + %TRUE if there are 1 or more locks on the @accel_group, %FALSE otherwise. - a #GtkAccelGroup + a #GtkAccelGroup - - Gets a #GdkModifierType representing the mask for this + + Gets a #GdkModifierType representing the mask for this @accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc. - the modifier mask for this accel group. + the modifier mask for this accel group. - a #GtkAccelGroup + a #GtkAccelGroup - Locks the given accelerator group. + Locks the given accelerator group. Locking an acelerator group prevents the accelerators contained within it to be changed during runtime. Refer to @@ -2190,23 +1556,17 @@ of times. - a #GtkAccelGroup + a #GtkAccelGroup - Queries an accelerator group for all entries matching @accel_key + Queries an accelerator group for all entries matching @accel_key and @accel_mods. - an array of + an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed. @@ -2215,50 +1575,33 @@ and @accel_mods. - the accelerator group to query + the accelerator group to query - key value of the accelerator + key value of the accelerator - modifier combination of the accelerator + modifier combination of the accelerator - - location to return the number + + location to return the number of entries found, or %NULL - Undoes the last call to gtk_accel_group_lock() on this @accel_group. + Undoes the last call to gtk_accel_group_lock() on this @accel_group. - a #GtkAccelGroup + a #GtkAccelGroup @@ -2276,41 +1619,29 @@ and @accel_mods. - The accel-activate signal is an implementation detail of + The accel-activate signal is an implementation detail of #GtkAccelGroup and not meant to be used by applications. - %TRUE if the accelerator was activated + %TRUE if the accelerator was activated - the object on which the accelerator was activated + the object on which the accelerator was activated - the accelerator keyval + the accelerator keyval - the modifier combination of the accelerator + the modifier combination of the accelerator - The accel-changed signal is emitted when an entry + The accel-changed signal is emitted when an entry is added to or removed from the accel group. Widgets like #GtkAccelLabel which display an associated @@ -2321,21 +1652,15 @@ their visual representation if the @accel_closure is theirs. - the accelerator keyval + the accelerator keyval - the modifier combination of the accelerator + the modifier combination of the accelerator - the #GClosure of the accelerator + the #GClosure of the accelerator @@ -2361,14 +1686,10 @@ their visual representation if the @accel_closure is theirs. - + - The parent class. + The parent class. @@ -2438,9 +1759,7 @@ their visual representation if the @accel_closure is theirs. - + @@ -2452,52 +1771,32 @@ their visual representation if the @accel_closure is theirs. - + - + - The accelerator keyval + The accelerator keyval - The accelerator modifiers + The accelerator modifiers - The accelerator flags + The accelerator flags - - The #GtkAccelLabel widget is a subclass of #GtkLabel that also displays an -accelerator key on the right of the label text, e.g. “Ctrl+S”. + + The #GtkAccelLabel widget is a subclass of #GtkLabel that also displays an +accelerator key on the right of the label text, e.g. “Ctrl+S”. It is commonly used in menus to show the keyboard short-cuts for commands. The accelerator key to display is typically not set explicitly (although it @@ -2506,10 +1805,10 @@ the accelerators which have been added to a particular widget. This widget is set by calling gtk_accel_label_set_accel_widget(). For example, a #GtkMenuItem widget may have an accelerator added to emit -the “activate” signal when the “Ctrl+S” key combination is pressed. +the “activate” signal when the “Ctrl+S” key combination is pressed. A #GtkAccelLabel is created and added to the #GtkMenuItem, and gtk_accel_label_set_accel_widget() is called with the #GtkMenuItem as the -second argument. The #GtkAccelLabel will now display “Ctrl+S” after its label. +second argument. The #GtkAccelLabel will now display “Ctrl+S” after its label. Note that creating a #GtkMenuItem with gtk_menu_item_new_with_label() (or one of the similar functions for #GtkCheckMenuItem and #GtkRadioMenuItem) @@ -2551,7 +1850,7 @@ though it is almost always used to display just one accelerator key. |[<!-- language="plain" --> label -╰── accelerator +╰── accelerator ]| Like #GtkLabel, GtkAccelLabel has a main CSS node with the name label. @@ -2560,31 +1859,21 @@ It adds a subnode with name accelerator. - Creates a new #GtkAccelLabel. + Creates a new #GtkAccelLabel. - a new #GtkAccelLabel. + a new #GtkAccelLabel. - the label string. Must be non-%NULL. + the label string. Must be non-%NULL. - - Gets the keyval and modifier mask set with + + Gets the keyval and modifier mask set with gtk_accel_label_set_accel(). @@ -2592,104 +1881,68 @@ gtk_accel_label_set_accel(). - a #GtkAccelLabel + a #GtkAccelLabel - - return location for the keyval + + return location for the keyval - - return location for the modifier mask + + return location for the modifier mask - - Fetches the widget monitored by this accelerator label. See + + Fetches the widget monitored by this accelerator label. See gtk_accel_label_set_accel_widget(). - the object monitored by the accelerator label, or %NULL. + the object monitored by the accelerator label, or %NULL. - a #GtkAccelLabel + a #GtkAccelLabel - - Returns the width needed to display the accelerator key(s). + + Returns the width needed to display the accelerator key(s). This is used by menus to align all of the #GtkMenuItem widgets, and shouldn't be needed by applications. - the width needed to display the accelerator key(s). + the width needed to display the accelerator key(s). - a #GtkAccelLabel. + a #GtkAccelLabel. - Recreates the string representing the accelerator keys. + Recreates the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget. - always returns %FALSE. + always returns %FALSE. - a #GtkAccelLabel. + a #GtkAccelLabel. - - Manually sets a keyval and modifier mask as the accelerator rendered + + Manually sets a keyval and modifier mask as the accelerator rendered by @accel_label. If a keyval and modifier are explicitly set then these values are @@ -2702,30 +1955,21 @@ Providing an @accelerator_key of 0 removes the manual setting. - a #GtkAccelLabel + a #GtkAccelLabel - a keyval, or 0 + a keyval, or 0 - the modifier mask for the accel + the modifier mask for the accel - - Sets the closure to be monitored by this accelerator label. The closure + + Sets the closure to be monitored by this accelerator label. The closure must be connected to an accelerator group; see gtk_accel_group_connect(). Passing %NULL for @accel_closure will dissociate @accel_label from its current closure, if any. @@ -2735,28 +1979,18 @@ current closure, if any. - a #GtkAccelLabel + a #GtkAccelLabel - - the closure to monitor for accelerator changes, + + the closure to monitor for accelerator changes, or %NULL - - Sets the widget to be monitored by this accelerator label. Passing %NULL for + + Sets the widget to be monitored by this accelerator label. Passing %NULL for @accel_widget will dissociate @accel_label from its current widget, if any. @@ -2764,18 +1998,11 @@ or %NULL - a #GtkAccelLabel + a #GtkAccelLabel - - the widget to be monitored, or %NULL + + the widget to be monitored, or %NULL @@ -2793,9 +2020,7 @@ or %NULL - + @@ -2851,24 +2076,14 @@ or %NULL - + - - Accelerator maps are used to define runtime configurable accelerators. + + Accelerator maps are used to define runtime configurable accelerators. Functions for manipulating them are are usually used by higher level convenience mechanisms like #GtkUIManager and are thus considered -“low-level”. You’ll want to use them if you’re manually creating menus that +“low-level”. You’ll want to use them if you’re manually creating menus that should have user-configurable accelerators. An accelerator is uniquely defined by: @@ -2877,15 +2092,15 @@ An accelerator is uniquely defined by: - accelerator modifiers The accelerator path must consist of -“<WINDOWTYPE>/Category1/Category2/.../Action”, where WINDOWTYPE +“<WINDOWTYPE>/Category1/Category2/.../Action”, where WINDOWTYPE should be a unique application-specific identifier that corresponds to the kind of window the accelerator is being used in, e.g. -“Gimp-Image”, “Abiword-Document” or “Gnumeric-Settings”. -The “Category1/.../Action” portion is most appropriately chosen by +“Gimp-Image”, “Abiword-Document” or “Gnumeric-Settings”. +The “Category1/.../Action” portion is most appropriately chosen by the action the accelerator triggers, i.e. for accelerators on menu -items, choose the item’s menu path, e.g. “File/Save As”, -“Image/View/Zoom” or “Edit/Select All”. So a full valid accelerator -path may look like: “<Gimp-Toolbox>/File/Dialogs/Tool Options...”. +items, choose the item’s menu path, e.g. “File/Save As”, +“Image/View/Zoom” or “Edit/Select All”. So a full valid accelerator +path may look like: “<Gimp-Toolbox>/File/Dialogs/Tool Options...”. All accelerators are stored inside one global #GtkAccelMap that can be obtained using gtk_accel_map_get(). See @@ -2920,9 +2135,7 @@ monitor only single accelerator path by using it as a detail of the #GtkAccelMap::changed signal. - Registers a new accelerator with the global accelerator map. + Registers a new accelerator with the global accelerator map. This function should only be called once per @accel_path with the canonical @accel_key and @accel_mods for this path. To change the accelerator during runtime programatically, use @@ -2940,35 +2153,27 @@ g_intern_static_string(). - valid accelerator path + valid accelerator path - the accelerator key + the accelerator key - the accelerator modifiers + the accelerator modifiers - Adds a filter to the global list of accel path filters. + Adds a filter to the global list of accel path filters. Accel map entries whose accel path matches one of the filters are skipped by gtk_accel_map_foreach(). This function is intended for GTK+ modules that create their own -menus, but don’t want them to be saved into the applications accelerator +menus, but don’t want them to be saved into the applications accelerator map dump. @@ -2976,17 +2181,13 @@ map dump. - a pattern (see #GPatternSpec) + a pattern (see #GPatternSpec) - Changes the @accel_key and @accel_mods currently associated with @accel_path. + Changes the @accel_key and @accel_mods currently associated with @accel_path. Due to conflicts with other accelerators, a change may not always be possible, @replace indicates whether other accelerators may be deleted to resolve such conflicts. A change will only occur if all conflicts could be resolved (which @@ -2998,43 +2199,31 @@ pass a static string, you can save some memory by interning it first with g_intern_static_string(). - %TRUE if the accelerator could be changed, %FALSE otherwise + %TRUE if the accelerator could be changed, %FALSE otherwise - a valid accelerator path + a valid accelerator path - the new accelerator key + the new accelerator key - the new accelerator modifiers + the new accelerator modifiers - %TRUE if other accelerators may be deleted upon conflicts + %TRUE if other accelerators may be deleted upon conflicts - Loops over the entries in the accelerator map whose accel path -doesn’t match any of the filters added with gtk_accel_map_add_filter(), + Loops over the entries in the accelerator map whose accel path +doesn’t match any of the filters added with gtk_accel_map_add_filter(), and execute @foreach_func on each. The signature of @foreach_func is that of #GtkAccelMapForeach, the @changed parameter indicates whether this accelerator was changed during runtime (thus, would need @@ -3044,31 +2233,19 @@ saving during an accelerator map dump). - - data to be passed into @foreach_func + + data to be passed into @foreach_func - - function to be executed for each accel + + function to be executed for each accel map entry which is not filtered out - - Loops over all entries in the accelerator map, and execute + + Loops over all entries in the accelerator map, and execute @foreach_func on each. The signature of @foreach_func is that of #GtkAccelMapForeach, the @changed parameter indicates whether this accelerator was changed during runtime (thus, would need @@ -3078,45 +2255,30 @@ saving during an accelerator map dump). - - data to be passed into @foreach_func + + data to be passed into @foreach_func - - function to be executed for each accel + + function to be executed for each accel map entry - Gets the singleton global #GtkAccelMap object. This object + Gets the singleton global #GtkAccelMap object. This object is useful only for notification of changes to the accelerator -map via the ::changed signal; it isn’t a parameter to the +map via the ::changed signal; it isn’t a parameter to the other accelerator map functions. - the global #GtkAccelMap object + the global #GtkAccelMap object - Parses a file previously saved with gtk_accel_map_save() for + Parses a file previously saved with gtk_accel_map_save() for accelerator specifications, and propagates them accordingly. @@ -3124,18 +2286,14 @@ accelerator specifications, and propagates them accordingly. - a file containing accelerator specifications, + a file containing accelerator specifications, in the GLib file name encoding - Filedescriptor variant of gtk_accel_map_load(). + Filedescriptor variant of gtk_accel_map_load(). Note that the file descriptor will not be closed by this function. @@ -3144,36 +2302,26 @@ Note that the file descriptor will not be closed by this function. - a valid readable file descriptor + a valid readable file descriptor - #GScanner variant of gtk_accel_map_load(). + #GScanner variant of gtk_accel_map_load(). - a #GScanner which has already been provided with an input file + a #GScanner which has already been provided with an input file - - Locks the given accelerator path. If the accelerator map doesn’t yet contain + + Locks the given accelerator path. If the accelerator map doesn’t yet contain an entry for @accel_path, a new one is created. Locking an accelerator path prevents its accelerator from being changed @@ -3195,48 +2343,31 @@ have to be unlocked. - a valid accelerator path + a valid accelerator path - Looks up the accelerator entry for @accel_path and fills in @key. + Looks up the accelerator entry for @accel_path and fills in @key. - %TRUE if @accel_path is known, %FALSE otherwise + %TRUE if @accel_path is known, %FALSE otherwise - a valid accelerator path + a valid accelerator path - - the accelerator key to be filled in (optional) + + the accelerator key to be filled in (optional) - Saves current accelerator specifications (accelerator path, key + Saves current accelerator specifications (accelerator path, key and modifiers) to @file_name. The file is written in a format suitable to be read back in by gtk_accel_map_load(). @@ -3246,18 +2377,14 @@ gtk_accel_map_load(). - the name of the file to contain + the name of the file to contain accelerator specifications, in the GLib file name encoding - Filedescriptor variant of gtk_accel_map_save(). + Filedescriptor variant of gtk_accel_map_save(). Note that the file descriptor will not be closed by this function. @@ -3266,19 +2393,13 @@ Note that the file descriptor will not be closed by this function. - a valid writable file descriptor + a valid writable file descriptor - - Undoes the last call to gtk_accel_map_lock_path() on this @accel_path. + + Undoes the last call to gtk_accel_map_lock_path() on this @accel_path. Refer to gtk_accel_map_lock_path() for information about accelerator path locking. @@ -3286,17 +2407,13 @@ Refer to gtk_accel_map_lock_path() for information about accelerator path lockin - a valid accelerator path + a valid accelerator path - Notifies of a change in the global accelerator map. + Notifies of a change in the global accelerator map. The path is also used as the detail for the signal, so it is possible to connect to changed::`accel_path`. @@ -3305,30 +2422,21 @@ changed::`accel_path`. - the path of the accelerator that changed + the path of the accelerator that changed - the key value for the new accelerator + the key value for the new accelerator - the modifier mask for the new accelerator + the modifier mask for the new accelerator - + @@ -3337,53 +2445,32 @@ changed::`accel_path`. - - User data passed to gtk_accel_map_foreach() or + + User data passed to gtk_accel_map_foreach() or gtk_accel_map_foreach_unfiltered() - Accel path of the current accelerator + Accel path of the current accelerator - Key of the current accelerator + Key of the current accelerator - Modifiers of the current accelerator + Modifiers of the current accelerator - Changed flag of the accelerator (if %TRUE, accelerator has changed + Changed flag of the accelerator (if %TRUE, accelerator has changed during runtime and would need to be saved during an accelerator dump) - - The #GtkAccessible class is the base class for accessible + + The #GtkAccessible class is the base class for accessible implementations for #GtkWidget subclasses. It is a thin wrapper around #AtkObject, which adds facilities for associating a widget with its accessible object. @@ -3395,13 +2482,8 @@ the connection between the widget class and its corresponding acccessible implementation, override the get_accessible vfunc in #GtkWidgetClass. - - This function specifies the callback function to be called + + This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed. Use gtk_accessible_set_widget() and its vfuncs. @@ -3410,9 +2492,7 @@ when the widget corresponding to a GtkAccessible is destroyed. - a #GtkAccessible + a #GtkAccessible @@ -3439,13 +2519,8 @@ when the widget corresponding to a GtkAccessible is destroyed. - - This function specifies the callback function to be called + + This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed. Use gtk_accessible_set_widget() and its vfuncs. @@ -3454,47 +2529,33 @@ when the widget corresponding to a GtkAccessible is destroyed. - a #GtkAccessible + a #GtkAccessible - - Gets the #GtkWidget corresponding to the #GtkAccessible. + + Gets the #GtkWidget corresponding to the #GtkAccessible. The returned widget does not have a reference added, so you do not need to unref it. - pointer to the #GtkWidget + pointer to the #GtkWidget corresponding to the #GtkAccessible, or %NULL. - a #GtkAccessible + a #GtkAccessible - - Sets the #GtkWidget corresponding to the #GtkAccessible. + + Sets the #GtkWidget corresponding to the #GtkAccessible. @accessible will not hold a reference to @widget. -It is the caller’s responsibility to ensure that when @widget +It is the caller’s responsibility to ensure that when @widget is destroyed, the widget is unset by calling this function again with @widget set to %NULL. @@ -3503,18 +2564,11 @@ again with @widget set to %NULL. - a #GtkAccessible + a #GtkAccessible - - a #GtkWidget or %NULL to unset + + a #GtkWidget or %NULL to unset @@ -3529,9 +2583,7 @@ again with @widget set to %NULL. - + @@ -3544,9 +2596,7 @@ again with @widget set to %NULL. - a #GtkAccessible + a #GtkAccessible @@ -3595,21 +2645,11 @@ again with @widget set to %NULL. - + - - > In GTK+ 3.10, GtkAction has been deprecated. Use #GAction + + > In GTK+ 3.10, GtkAction has been deprecated. Use #GAction > instead, and associate actions with #GtkActionable widgets. Use > #GMenuModel for creating menus with gtk_menu_new_from_model(). @@ -3643,12 +2683,12 @@ The action will also have some state information: Apart from regular actions, there are [toggle actions][GtkToggleAction], which can be toggled between two states and [radio actions][GtkRadioAction], of which only one in a group -can be in the “active” state. Other actions can be implemented as #GtkAction +can be in the “active” state. Other actions can be implemented as #GtkAction subclasses. Each action can have one or more proxy widgets. To act as an action proxy, widget needs to implement #GtkActivatable interface. Proxies mirror the state -of the action and should change when the action’s state changes. Properties +of the action and should change when the action’s state changes. Properties that are always mirrored by proxies are #GtkAction:sensitive and #GtkAction:visible. #GtkAction:gicon, #GtkAction:icon-name, #GtkAction:label, #GtkAction:short-label and #GtkAction:stock-id properties are only mirorred @@ -3658,14 +2698,8 @@ if proxy widget has #GtkActivatable:use-action-appearance property set to When the proxy is activated, it should activate its action. - - Creates a new #GtkAction object. To add the action to a + + Creates a new #GtkAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). See the [UI Definition section][XML-UI] for information on allowed action @@ -3674,57 +2708,32 @@ names. #GtkActionable or creating a #GtkMenu with gtk_menu_new_from_model() - a new #GtkAction + a new #GtkAction - A unique name for the action + A unique name for the action - - the label displayed in menu items and on buttons, + + the label displayed in menu items and on buttons, or %NULL - - a tooltip for the action, or %NULL + + a tooltip for the action, or %NULL - - the stock icon to display in widgets representing + + the stock icon to display in widgets representing the action, or %NULL - - Emits the “activate” signal on the specified action, if it isn't + + Emits the “activate” signal on the specified action, if it isn't insensitive. This gets called by the proxy widgets when they get activated. @@ -3736,9 +2745,7 @@ It can also be used to manually activate an action. - the action object + the action object @@ -3757,83 +2764,53 @@ It can also be used to manually activate an action. - - If @action provides a #GtkMenu widget as a submenu for the menu + + If @action provides a #GtkMenu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu. Use #GAction and #GMenuModel instead, and create a #GtkMenu with gtk_menu_new_from_model() - the menu item provided by the + the menu item provided by the action, or %NULL. - a #GtkAction + a #GtkAction - - Creates a menu item widget that proxies for the given action. + + Creates a menu item widget that proxies for the given action. Use g_menu_item_new() and associate it with a #GAction instead. - a menu item connected to the action. + a menu item connected to the action. - the action object + the action object - - Creates a toolbar item widget that proxies for the given action. + + Creates a toolbar item widget that proxies for the given action. Use a #GtkToolItem and associate it with a #GAction using gtk_actionable_set_action_name() instead - a toolbar item connected to the action. + a toolbar item connected to the action. - the action object + the action object @@ -3852,14 +2829,8 @@ gtk_actionable_set_action_name() instead - - Emits the “activate” signal on the specified action, if it isn't + + Emits the “activate” signal on the specified action, if it isn't insensitive. This gets called by the proxy widgets when they get activated. @@ -3871,21 +2842,13 @@ It can also be used to manually activate an action. - the action object + the action object - - Disable activation signals from the action + + Disable activation signals from the action This is needed when updating the state of your proxy #GtkActivatable widget could result in calling gtk_action_activate(), @@ -3899,27 +2862,19 @@ cases (updating toggle state for instance). - a #GtkAction + a #GtkAction - - Installs the accelerator for @action if @action has an + + Installs the accelerator for @action if @action has an accel path and group. See gtk_action_set_accel_path() and gtk_action_set_accel_group() Since multiple proxies may independently trigger the installation of the accelerator, the @action counts the number of times this -function has been called and doesn’t remove the accelerator until +function has been called and doesn’t remove the accelerator until gtk_action_disconnect_accelerator() has been called as many times. Use #GAction and the accelerator group on an associated #GtkMenu instead @@ -3929,136 +2884,86 @@ gtk_action_disconnect_accelerator() has been called as many times. - a #GtkAction + a #GtkAction - - This function is intended for use by action implementations to + + This function is intended for use by action implementations to create icons displayed in the proxy widgets. Use g_menu_item_set_icon() to set an icon on a #GMenuItem, or gtk_container_add() to add a #GtkImage to a #GtkButton - a widget that displays the icon for this action. + a widget that displays the icon for this action. - the action object + the action object - the size of the icon (#GtkIconSize) that should + the size of the icon (#GtkIconSize) that should be created. - + - - If @action provides a #GtkMenu widget as a submenu for the menu + + If @action provides a #GtkMenu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu. Use #GAction and #GMenuModel instead, and create a #GtkMenu with gtk_menu_new_from_model() - the menu item provided by the + the menu item provided by the action, or %NULL. - a #GtkAction + a #GtkAction - - Creates a menu item widget that proxies for the given action. + + Creates a menu item widget that proxies for the given action. Use g_menu_item_new() and associate it with a #GAction instead. - a menu item connected to the action. + a menu item connected to the action. - the action object + the action object - - Creates a toolbar item widget that proxies for the given action. + + Creates a toolbar item widget that proxies for the given action. Use a #GtkToolItem and associate it with a #GAction using gtk_actionable_set_action_name() instead - a toolbar item connected to the action. + a toolbar item connected to the action. - the action object + the action object - - Undoes the effect of one call to gtk_action_connect_accelerator(). + + Undoes the effect of one call to gtk_action_connect_accelerator(). Use #GAction and the accelerator group on an associated #GtkMenu instead @@ -4067,243 +2972,153 @@ gtk_actionable_set_action_name() instead - a #GtkAction + a #GtkAction - - Returns the accel closure for this action. + + Returns the accel closure for this action. Use #GAction and #GtkMenu instead, which have no equivalent for getting the accel closure - the accel closure for this action. The + the accel closure for this action. The returned closure is owned by GTK+ and must not be unreffed or modified. - the action object + the action object - - Returns the accel path for this action. + + Returns the accel path for this action. Use #GAction and the accelerator path on an associated #GtkMenu instead - the accel path for this action, or %NULL + the accel path for this action, or %NULL if none is set. The returned string is owned by GTK+ and must not be freed or modified. - the action object + the action object - - Returns whether @action's menu item proxies will always + + Returns whether @action's menu item proxies will always show their image, if available. Use g_menu_item_get_attribute_value() on a #GMenuItem instead - %TRUE if the menu item proxies will always show their image + %TRUE if the menu item proxies will always show their image - a #GtkAction + a #GtkAction - - Gets the gicon of @action. + + Gets the gicon of @action. Use #GAction instead, and g_menu_item_get_attribute_value() to get an icon from a #GMenuItem associated with a #GAction - The action’s #GIcon if one is set. + The action’s #GIcon if one is set. - a #GtkAction + a #GtkAction - - Gets the icon name of @action. + + Gets the icon name of @action. Use #GAction instead, and g_menu_item_get_attribute_value() to get an icon from a #GMenuItem associated with a #GAction - the icon name + the icon name - a #GtkAction + a #GtkAction - - Checks whether @action is important or not + + Checks whether @action is important or not Use #GAction instead, and control and monitor whether labels are shown directly - whether @action is important + whether @action is important - a #GtkAction + a #GtkAction - - Gets the label text of @action. + + Gets the label text of @action. Use #GAction instead, and get a label from a menu item with g_menu_item_get_attribute_value(). For #GtkActionable widgets, use the widget-specific API to get a label - the label text + the label text - a #GtkAction + a #GtkAction - - Returns the name of the action. + + Returns the name of the action. Use g_action_get_name() on a #GAction instead - the name of the action. The string belongs to GTK+ and should not + the name of the action. The string belongs to GTK+ and should not be freed. - the action object + the action object - - Returns the proxy widgets for an action. + + Returns the proxy widgets for an action. See also gtk_activatable_get_related_action(). - a #GSList of proxy widgets. The list is owned by GTK+ + a #GSList of proxy widgets. The list is owned by GTK+ and must not be modified. @@ -4311,261 +3126,163 @@ and must not be modified. - the action object + the action object - - Returns whether the action itself is sensitive. Note that this doesn’t + + Returns whether the action itself is sensitive. Note that this doesn’t necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that. Use g_action_get_enabled() on a #GAction instead - %TRUE if the action itself is sensitive. + %TRUE if the action itself is sensitive. - the action object + the action object - - Gets the short label text of @action. + + Gets the short label text of @action. Use #GAction instead, which has no equivalent of short labels - the short label text. + the short label text. - a #GtkAction + a #GtkAction - - Gets the stock id of @action. + + Gets the stock id of @action. Use #GAction instead, which has no equivalent of stock items - the stock id + the stock id - a #GtkAction + a #GtkAction - - Gets the tooltip text of @action. + + Gets the tooltip text of @action. Use #GAction instead, and get tooltips from associated #GtkActionable widgets with gtk_widget_get_tooltip_text() - the tooltip text + the tooltip text - a #GtkAction + a #GtkAction - - Returns whether the action itself is visible. Note that this doesn’t + + Returns whether the action itself is visible. Note that this doesn’t necessarily mean effective visibility. See gtk_action_is_sensitive() for that. Use #GAction instead, and control and monitor the state of #GtkActionable widgets directly - %TRUE if the action itself is visible. + %TRUE if the action itself is visible. - the action object + the action object - - Checks whether @action is visible when horizontal + + Checks whether @action is visible when horizontal Use #GAction instead, and control and monitor the visibility of associated widgets and menu items directly - whether @action is visible when horizontal + whether @action is visible when horizontal - a #GtkAction + a #GtkAction - - Checks whether @action is visible when horizontal + + Checks whether @action is visible when horizontal Use #GAction instead, and control and monitor the visibility of associated widgets and menu items directly - whether @action is visible when horizontal + whether @action is visible when horizontal - a #GtkAction + a #GtkAction - - Returns whether the action is effectively sensitive. + + Returns whether the action is effectively sensitive. Use g_action_get_enabled() on a #GAction instead - %TRUE if the action and its associated action group + %TRUE if the action and its associated action group are both sensitive. - the action object + the action object - - Returns whether the action is effectively visible. + + Returns whether the action is effectively visible. Use #GAction instead, and control and monitor the state of #GtkActionable widgets directly - %TRUE if the action and its associated action group + %TRUE if the action and its associated action group are both visible. - the action object + the action object - - Sets the #GtkAccelGroup in which the accelerator for this action + + Sets the #GtkAccelGroup in which the accelerator for this action will be installed. Use #GAction and the accelerator group on an associated #GtkMenu instead @@ -4575,30 +3292,17 @@ will be installed. - the action object + the action object - - a #GtkAccelGroup or %NULL + + a #GtkAccelGroup or %NULL - - Sets the accel path for this action. All proxy widgets associated + + Sets the accel path for this action. All proxy widgets associated with the action will have this accel path, so that their accelerators are consistent. @@ -4613,27 +3317,17 @@ g_intern_static_string(). - the action object + the action object - the accelerator path + the accelerator path - - Sets whether @action's menu item proxies will ignore the + + Sets whether @action's menu item proxies will ignore the #GtkSettings:gtk-menu-images setting and always show their image, if available. Use this if the menu item would be useless or hard to use @@ -4646,27 +3340,17 @@ item should have an image - a #GtkAction + a #GtkAction - %TRUE if menuitem proxies should always show their image + %TRUE if menuitem proxies should always show their image - - Sets the icon of @action. + + Sets the icon of @action. Use #GAction instead, and g_menu_item_set_icon() to set an icon on a #GMenuItem associated with a #GAction, or gtk_container_add() to add a #GtkImage to a #GtkButton @@ -4676,27 +3360,17 @@ add a #GtkImage to a #GtkButton - a #GtkAction + a #GtkAction - the #GIcon to set + the #GIcon to set - - Sets the icon name on @action + + Sets the icon name on @action Use #GAction instead, and g_menu_item_set_icon() to set an icon on a #GMenuItem associated with a #GAction, or gtk_container_add() to add a #GtkImage to a #GtkButton @@ -4706,27 +3380,17 @@ add a #GtkImage to a #GtkButton - a #GtkAction + a #GtkAction - the icon name to set + the icon name to set - - Sets whether the action is important, this attribute is used + + Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not. Use #GAction instead, and control and monitor whether @@ -4737,27 +3401,17 @@ labels are shown directly - the action object + the action object - %TRUE to make the action important + %TRUE to make the action important - - Sets the label of @action. + + Sets the label of @action. Use #GAction instead, and set a label on a menu item with g_menu_item_set_label(). For #GtkActionable widgets, use the widget-specific API to set a label @@ -4767,28 +3421,18 @@ API to set a label - a #GtkAction + a #GtkAction - the label text to set + the label text to set - - Sets the :sensitive property of the action to @sensitive. Note that -this doesn’t necessarily mean effective sensitivity. See + + Sets the :sensitive property of the action to @sensitive. Note that +this doesn’t necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that. Use g_simple_action_set_enabled() on a #GSimpleAction @@ -4799,27 +3443,17 @@ instead - the action object + the action object - %TRUE to make the action sensitive + %TRUE to make the action sensitive - - Sets a shorter label text on @action. + + Sets a shorter label text on @action. Use #GAction instead, which has no equivalent of short labels @@ -4828,27 +3462,17 @@ labels - a #GtkAction + a #GtkAction - the label text to set + the label text to set - - Sets the stock id on @action + + Sets the stock id on @action Use #GAction instead, which has no equivalent of stock items @@ -4857,27 +3481,17 @@ items - a #GtkAction + a #GtkAction - the stock id + the stock id - - Sets the tooltip text on @action + + Sets the tooltip text on @action Use #GAction instead, and set tooltips on associated #GtkActionable widgets with gtk_widget_set_tooltip_text() @@ -4886,28 +3500,18 @@ items - a #GtkAction + a #GtkAction - the tooltip text + the tooltip text - - Sets the :visible property of the action to @visible. Note that -this doesn’t necessarily mean effective visibility. See + + Sets the :visible property of the action to @visible. Note that +this doesn’t necessarily mean effective visibility. See gtk_action_is_visible() for that. Use #GAction instead, and control and monitor the state of @@ -4918,27 +3522,17 @@ for that. - the action object + the action object - %TRUE to make the action visible + %TRUE to make the action visible - - Sets whether @action is visible when horizontal + + Sets whether @action is visible when horizontal Use #GAction instead, and control and monitor the visibility of associated widgets and menu items directly @@ -4947,27 +3541,17 @@ visibility of associated widgets and menu items directly - a #GtkAction + a #GtkAction - whether the action is visible horizontally + whether the action is visible horizontally - - Sets whether @action is visible when vertical + + Sets whether @action is visible when vertical Use #GAction instead, and control and monitor the visibility of associated widgets and menu items directly @@ -4976,27 +3560,17 @@ visibility of associated widgets and menu items directly - a #GtkAction + a #GtkAction - whether the action is visible vertically + whether the action is visible vertically - - Reenable activation signals from the action + + Reenable activation signals from the action Use g_simple_action_set_enabled() to enable the #GSimpleAction instead @@ -5005,36 +3579,20 @@ visibility of associated widgets and menu items directly - a #GtkAction + a #GtkAction - - The GtkActionGroup this GtkAction is associated with, or NULL + + The GtkActionGroup this GtkAction is associated with, or NULL (for internal use). Lookup the #GAction using g_action_map_lookup_action() instead - - If %TRUE, the action's menu item proxies will ignore the #GtkSettings:gtk-menu-images + + If %TRUE, the action's menu item proxies will ignore the #GtkSettings:gtk-menu-images setting and always show their image, if available. Use this property if the menu item would be useless or hard to use @@ -5043,15 +3601,8 @@ without their image. #GAction - - The #GIcon displayed in the #GtkAction. + + The #GIcon displayed in the #GtkAction. Note that the stock icon is preferred, if the #GtkAction:stock-id property holds the id of an existing stock icon. @@ -5061,27 +3612,14 @@ This is an appearance property and thus only applies if Use the "icon" attribute on a #GMenuItem instead - - When TRUE, empty menu proxies for this action are hidden. + + When TRUE, empty menu proxies for this action are hidden. There is no corresponding replacement when using #GAction - - The name of the icon from the icon theme. + + The name of the icon from the icon theme. Note that the stock icon is preferred, if the #GtkAction:stock-id property holds the id of an existing stock icon, and the #GIcon is @@ -5092,27 +3630,15 @@ This is an appearance property and thus only applies if Use the "icon" attribute on a #GMenuItem instead - - Whether the action is considered important. When TRUE, toolitem + + Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode. There is no corresponding replacement when using #GAction - - The label used for menu items and buttons that activate + + The label used for menu items and buttons that activate this action. If the label is %NULL, GTK+ uses the stock label specified via the stock-id property. @@ -5121,38 +3647,19 @@ This is an appearance property and thus only applies if Use the "label" attribute on #GMenuItem instead - - A unique name for the action. + + A unique name for the action. Use #GAction:name instead - - Whether the action is enabled. + + Whether the action is enabled. Use #GAction:enabled and #GSimpleAction:enabled instead - - A shorter label that may be used on toolbar buttons. + + A shorter label that may be used on toolbar buttons. This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE. @@ -5160,14 +3667,8 @@ This is an appearance property and thus only applies if #GAction - - The stock icon displayed in widgets representing this action. + + The stock icon displayed in widgets representing this action. This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE. @@ -5175,63 +3676,32 @@ This is an appearance property and thus only applies if #GAction - - A tooltip for this action. + + A tooltip for this action. Use gtk_widget_set_tooltip_text() instead - - Whether the action is visible. + + Whether the action is visible. There is no corresponding replacement when using #GAction - - Whether the toolbar item is visible when the toolbar is in a horizontal orientation. + + Whether the toolbar item is visible when the toolbar is in a horizontal orientation. There is no corresponding replacement when using #GAction - - When %TRUE, toolitem proxies for this action are represented in the + + When %TRUE, toolitem proxies for this action are represented in the toolbar overflow menu. There is no corresponding replacement when using #GAction - - Whether the toolbar item is visible when the toolbar is in a vertical orientation. + + Whether the toolbar item is visible when the toolbar is in a vertical orientation. There is no corresponding replacement when using #GAction @@ -5242,31 +3712,16 @@ toolbar overflow menu. - - The "activate" signal is emitted when the action is activated. + + The "activate" signal is emitted when the action is activated. Use #GSimpleAction::activate instead - - GtkActionBar is designed to present contextual actions. It is + + GtkActionBar is designed to present contextual actions. It is expected to be displayed below the content and expand horizontally to fill the area. @@ -5282,45 +3737,29 @@ GtkActionBar has a single CSS node with name actionbar. - Creates a new #GtkActionBar widget. + Creates a new #GtkActionBar widget. - a new #GtkActionBar + a new #GtkActionBar - - Retrieves the center bar widget of the bar. + + Retrieves the center bar widget of the bar. - the center #GtkWidget or %NULL. + the center #GtkWidget or %NULL. - a #GtkActionBar + a #GtkActionBar - - Adds @child to @action_bar, packed with reference to the + + Adds @child to @action_bar, packed with reference to the end of the @action_bar. @@ -5328,25 +3767,17 @@ end of the @action_bar. - A #GtkActionBar + A #GtkActionBar - the #GtkWidget to be added to @action_bar + the #GtkWidget to be added to @action_bar - - Adds @child to @action_bar, packed with reference to the + + Adds @child to @action_bar, packed with reference to the start of the @action_bar. @@ -5354,43 +3785,28 @@ start of the @action_bar. - A #GtkActionBar + A #GtkActionBar - the #GtkWidget to be added to @action_bar + the #GtkWidget to be added to @action_bar - - Sets the center widget for the #GtkActionBar. + + Sets the center widget for the #GtkActionBar. - a #GtkActionBar + a #GtkActionBar - - a widget to use for the center + + a widget to use for the center @@ -5399,9 +3815,7 @@ start of the @action_bar. - + @@ -5442,14 +3856,10 @@ start of the @action_bar. - + - The parent class. + The parent class. @@ -5460,9 +3870,7 @@ start of the @action_bar. - the action object + the action object @@ -5478,16 +3886,12 @@ start of the @action_bar. - a menu item connected to the action. + a menu item connected to the action. - the action object + the action object @@ -5497,16 +3901,12 @@ start of the @action_bar. - a toolbar item connected to the action. + a toolbar item connected to the action. - the action object + the action object @@ -5548,17 +3948,13 @@ start of the @action_bar. - the menu item provided by the + the menu item provided by the action, or %NULL. - a #GtkAction + a #GtkAction @@ -5597,67 +3993,42 @@ start of the @action_bar. - - #GtkActionEntry structs are used with gtk_action_group_add_actions() to + + #GtkActionEntry structs are used with gtk_action_group_add_actions() to construct actions. - The name of the action. + The name of the action. - The stock id for the action, or the name of an icon from the + The stock id for the action, or the name of an icon from the icon theme. - The label for the action. This field should typically be marked + The label for the action. This field should typically be marked for translation, see gtk_action_group_set_translation_domain(). If @label is %NULL, the label of the stock item with id @stock_id is used. - The accelerator for the action, in the format understood by + The accelerator for the action, in the format understood by gtk_accelerator_parse(). - The tooltip for the action. This field should typically be + The tooltip for the action. This field should typically be marked for translation, see gtk_action_group_set_translation_domain(). - The function to call when the action is activated. + The function to call when the action is activated. - - Actions are organised into groups. An action group is essentially a + + Actions are organised into groups. An action group is essentially a map from names to #GtkAction objects. All actions that would make sense to use in a particular context @@ -5667,7 +4038,7 @@ applications will make use of multiple groups. For example, in an application that can edit multiple documents, one group holding global actions (e.g. quit, about, new), and one group per document holding actions that act on that document (eg. save, cut/copy/paste, etc). Each -window’s menus would be constructed from a combination of two action +window’s menus would be constructed from a combination of two action groups. ## Accelerators ## {#Action-Accel} @@ -5688,10 +4059,10 @@ Note that it is probably more common to define actions and action groups in the code, since they are directly related to what the code can do. The GtkActionGroup implementation of the GtkBuildable interface supports -a custom <accelerator> element, which has attributes named “key“ and -“modifiers“ and allows to specify accelerators. This is similar to the +a custom <accelerator> element, which has attributes named “key“ and +“modifiers“ and allows to specify accelerators. This is similar to the <accelerator> element of #GtkWidget, the main difference is that -it doesn’t allow you to specify a signal. +it doesn’t allow you to specify a signal. ## A #GtkDialog UI definition fragment. ## |[ @@ -5708,941 +4079,550 @@ it doesn’t allow you to specify a signal. ]| - - Creates a new #GtkActionGroup object. The name of the action group + + Creates a new #GtkActionGroup object. The name of the action group is used when associating [keybindings][Action-Accel] with the actions. - + - the new #GtkActionGroup + the new #GtkActionGroup - the name of the action group. + the name of the action group. - - Looks up an action in the action group by name. + + Looks up an action in the action group by name. - the action, or %NULL if no action by that name exists + the action, or %NULL if no action by that name exists - the action group + the action group - the name of the action + the name of the action - - Adds an action object to the action group. Note that this function + + Adds an action object to the action group. Note that this function does not set up the accel path of the action, which can lead to problems if a user tries to modify the accelerator of a menuitem associated with the action. Therefore you must either set the accel path yourself with gtk_action_set_accel_path(), or use `gtk_action_group_add_action_with_accel (..., NULL)`. - + - the action group + the action group - an action + an action - - Adds an action object to the action group and sets up the accelerator. + + Adds an action object to the action group and sets up the accelerator. If @accelerator is %NULL, attempts to use the accelerator associated with the stock_id of the action. Accel paths are set to `<Actions>/group-name/action-name`. - + - the action group + the action group - the action to add + the action to add - - the accelerator for the action, in + + the accelerator for the action, in the format understood by gtk_accelerator_parse(), or "" for no accelerator, or %NULL to use the stock accelerator - - This is a convenience function to create a number of actions and add them + + This is a convenience function to create a number of actions and add them to the action group. -The “activate” signals of the actions are connected to the callbacks +The “activate” signals of the actions are connected to the callbacks and their accel paths are set to `<Actions>/group-name/action-name`. - + - the action group + the action group - an array of action descriptions - + an array of action descriptions + - the number of entries + the number of entries - - data to pass to the action callbacks + + data to pass to the action callbacks - - This variant of gtk_action_group_add_actions() adds a #GDestroyNotify + + This variant of gtk_action_group_add_actions() adds a #GDestroyNotify callback for @user_data. - + - the action group + the action group - an array of action descriptions - + an array of action descriptions + - the number of entries + the number of entries - - data to pass to the action callbacks + + data to pass to the action callbacks - - destroy notification callback for @user_data + + destroy notification callback for @user_data - - This is a convenience routine to create a group of radio actions and + + This is a convenience routine to create a group of radio actions and add them to the action group. -The “changed” signal of the first radio action is connected to the +The “changed” signal of the first radio action is connected to the @on_change callback and the accel paths of the actions are set to `<Actions>/group-name/action-name`. - + - the action group + the action group - an array of radio action descriptions - + an array of radio action descriptions + - the number of entries + the number of entries - the value of the action to activate initially, or -1 if + the value of the action to activate initially, or -1 if no action should be activated - the callback to connect to the changed signal + the callback to connect to the changed signal - - data to pass to the action callbacks + + data to pass to the action callbacks - - This variant of gtk_action_group_add_radio_actions() adds a + + This variant of gtk_action_group_add_radio_actions() adds a #GDestroyNotify callback for @user_data. - + - the action group + the action group - an array of radio action descriptions - + an array of radio action descriptions + - the number of entries + the number of entries - the value of the action to activate initially, or -1 if + the value of the action to activate initially, or -1 if no action should be activated - - the callback to connect to the changed signal + + the callback to connect to the changed signal - - data to pass to the action callbacks + + data to pass to the action callbacks - destroy notification callback for @user_data + destroy notification callback for @user_data - - This is a convenience function to create a number of toggle actions and add them + + This is a convenience function to create a number of toggle actions and add them to the action group. -The “activate” signals of the actions are connected to the callbacks +The “activate” signals of the actions are connected to the callbacks and their accel paths are set to `<Actions>/group-name/action-name`. - + - the action group + the action group - an array of toggle action descriptions - + an array of toggle action descriptions + - the number of entries + the number of entries - - data to pass to the action callbacks + + data to pass to the action callbacks - - This variant of gtk_action_group_add_toggle_actions() adds a + + This variant of gtk_action_group_add_toggle_actions() adds a #GDestroyNotify callback for @user_data. - + - the action group + the action group - an array of toggle action descriptions - + an array of toggle action descriptions + - the number of entries + the number of entries - - data to pass to the action callbacks + + data to pass to the action callbacks - - destroy notification callback for @user_data + + destroy notification callback for @user_data - - Gets the accelerator group. - + + Gets the accelerator group. + - the accelerator group associated with this action + the accelerator group associated with this action group or %NULL if there is none. - a #GtkActionGroup + a #GtkActionGroup - - Looks up an action in the action group by name. - + + Looks up an action in the action group by name. + - the action, or %NULL if no action by that name exists + the action, or %NULL if no action by that name exists - the action group + the action group - the name of the action + the name of the action - - Gets the name of the action group. - + + Gets the name of the action group. + - the name of the action group. + the name of the action group. - the action group + the action group - - Returns %TRUE if the group is sensitive. The constituent actions + + Returns %TRUE if the group is sensitive. The constituent actions can only be logically sensitive (see gtk_action_is_sensitive()) if they are sensitive (see gtk_action_get_sensitive()) and their group is sensitive. - + - %TRUE if the group is sensitive. + %TRUE if the group is sensitive. - the action group + the action group - - Returns %TRUE if the group is visible. The constituent actions + + Returns %TRUE if the group is visible. The constituent actions can only be logically visible (see gtk_action_is_visible()) if they are visible (see gtk_action_get_visible()) and their group is visible. - + - %TRUE if the group is visible. + %TRUE if the group is visible. - the action group + the action group - - Lists the actions in the action group. - + + Lists the actions in the action group. + - an allocated list of the action objects in the action group + an allocated list of the action objects in the action group - the action group + the action group - - Removes an action object from the action group. - + + Removes an action object from the action group. + - the action group + the action group - an action + an action - - Sets the accelerator group to be used by every action in this group. - + + Sets the accelerator group to be used by every action in this group. + - a #GtkActionGroup + a #GtkActionGroup - - a #GtkAccelGroup to set or %NULL + + a #GtkAccelGroup to set or %NULL - - Changes the sensitivity of @action_group - + + Changes the sensitivity of @action_group + - the action group + the action group - new sensitivity + new sensitivity - - Sets a function to be used for translating the @label and @tooltip of + + Sets a function to be used for translating the @label and @tooltip of #GtkActionEntrys added by gtk_action_group_add_actions(). -If you’re using gettext(), it is enough to set the translation domain +If you’re using gettext(), it is enough to set the translation domain with gtk_action_group_set_translation_domain(). - + - a #GtkActionGroup + a #GtkActionGroup - - a #GtkTranslateFunc + + a #GtkTranslateFunc - - data to be passed to @func and @notify + + data to be passed to @func and @notify - a #GDestroyNotify function to be called when @action_group is + a #GDestroyNotify function to be called when @action_group is destroyed and when the translation function is changed again - - Sets the translation domain and uses g_dgettext() for translating the + + Sets the translation domain and uses g_dgettext() for translating the @label and @tooltip of #GtkActionEntrys added by gtk_action_group_add_actions(). -If you’re not using gettext() for localization, see +If you’re not using gettext() for localization, see gtk_action_group_set_translate_func(). - + - a #GtkActionGroup + a #GtkActionGroup - - the translation domain to use for g_dgettext() + + the translation domain to use for g_dgettext() calls, or %NULL to use the domain set with textdomain() - - Changes the visible of @action_group. - + + Changes the visible of @action_group. + - the action group + the action group - new visiblity + new visiblity - - Translates a string using the function set with + + Translates a string using the function set with gtk_action_group_set_translate_func(). This is mainly intended for language bindings. - + - the translation of @string + the translation of @string - a #GtkActionGroup + a #GtkActionGroup - a string + a string - - The accelerator group the actions of this group should use. + + The accelerator group the actions of this group should use. - - A name for the action. + + A name for the action. - - Whether the action group is enabled. + + Whether the action group is enabled. - - Whether the action group is visible. + + Whether the action group is visible. @@ -6651,13 +4631,8 @@ is mainly intended for language bindings. - - The ::connect-proxy signal is emitted after connecting a proxy to + + The ::connect-proxy signal is emitted after connecting a proxy to an action in the group. Note that the proxy may have been connected to a different action before. @@ -6673,26 +4648,17 @@ convenient to use. - the action + the action - the proxy + the proxy - - The ::disconnect-proxy signal is emitted after disconnecting a proxy + + The ::disconnect-proxy signal is emitted after disconnecting a proxy from an action in the group. #GtkUIManager proxies the signal and provides global notification @@ -6703,26 +4669,17 @@ convenient to use. - the action + the action - the proxy + the proxy - - The ::post-activate signal is emitted just after the @action in the + + The ::post-activate signal is emitted just after the @action in the @action_group is activated This is intended for #GtkUIManager to proxy the signal and provide global @@ -6732,20 +4689,13 @@ notification just after any action is activated. - the action + the action - - The ::pre-activate signal is emitted just before the @action in the + + The ::pre-activate signal is emitted just before the @action in the @action_group is activated This is intended for #GtkUIManager to proxy the signal and provide global @@ -6755,45 +4705,32 @@ notification just before any action is activated. - the action + the action - + - The parent class. + The parent class. - + - the action, or %NULL if no action by that name exists + the action, or %NULL if no action by that name exists - the action group + the action group - the name of the action + the name of the action @@ -6801,8 +4738,7 @@ notification just before any action is activated. - + @@ -6810,8 +4746,7 @@ notification just before any action is activated. - + @@ -6819,8 +4754,7 @@ notification just before any action is activated. - + @@ -6828,32 +4762,21 @@ notification just before any action is activated. - + - + - - This interface provides a convenient way of associating widgets with + + This interface provides a convenient way of associating widgets with actions on a #GtkApplicationWindow or #GtkApplication. It primarily consists of two properties: #GtkActionable:action-name @@ -6862,72 +4785,52 @@ for setting these properties. The action will be looked up in action groups that are found among the widgets ancestors. Most commonly, these will be the actions with -the “win.” or “app.” prefix that are associated with the #GtkApplicationWindow +the “win.” or “app.” prefix that are associated with the #GtkApplicationWindow or #GtkApplication, but other action groups that are added with gtk_widget_insert_action_group() will be consulted as well. - - Gets the action name for @actionable. + + Gets the action name for @actionable. See gtk_actionable_set_action_name() for more information. - the action name, or %NULL if none is set + the action name, or %NULL if none is set - a #GtkActionable widget + a #GtkActionable widget - - Gets the current target value of @actionable. + + Gets the current target value of @actionable. See gtk_actionable_set_action_target_value() for more information. - the current target value + the current target value - a #GtkActionable widget + a #GtkActionable widget - - Specifies the name of the action with which this widget should be + + Specifies the name of the action with which this widget should be associated. If @action_name is %NULL then the widget will be unassociated from any previous action. Usually this function is used when the widget is located (or will be located) within the hierarchy of a #GtkApplicationWindow. -Names are of the form “win.save” or “app.quit” for actions on the +Names are of the form “win.save” or “app.quit” for actions on the containing #GtkApplicationWindow or its associated #GtkApplication, respectively. This is the same form used for actions in the #GMenu associated with the window. @@ -6937,43 +4840,32 @@ associated with the window. - a #GtkActionable widget + a #GtkActionable widget - - an action name, or %NULL + + an action name, or %NULL - - Sets the target value of an actionable widget. + + Sets the target value of an actionable widget. If @target_value is %NULL then the target value is unset. The target value has two purposes. First, it is used as the parameter to activation of the action associated with the #GtkActionable widget. Second, it is used to determine if the widget -should be rendered as “active” — the widget is active if the state +should be rendered as “active” — the widget is active if the state is equal to the given target. Consider the example of associating a set of buttons with a #GAction -with string state in a typical “radio button” situation. Each button +with string state in a typical “radio button” situation. Each button will be associated with the same action, but with a different target value for that action. Clicking on a particular button will activate the action with the target of that button, which will typically cause -the action’s state to change to that value. Since the action’s state +the action’s state to change to that value. Since the action’s state is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive). @@ -6983,83 +4875,56 @@ rendered inactive). - a #GtkActionable widget + a #GtkActionable widget - - a #GVariant to set as the target value, or %NULL + + a #GVariant to set as the target value, or %NULL - - Gets the action name for @actionable. + + Gets the action name for @actionable. See gtk_actionable_set_action_name() for more information. - the action name, or %NULL if none is set + the action name, or %NULL if none is set - a #GtkActionable widget + a #GtkActionable widget - - Gets the current target value of @actionable. + + Gets the current target value of @actionable. See gtk_actionable_set_action_target_value() for more information. - the current target value + the current target value - a #GtkActionable widget + a #GtkActionable widget - - Specifies the name of the action with which this widget should be + + Specifies the name of the action with which this widget should be associated. If @action_name is %NULL then the widget will be unassociated from any previous action. Usually this function is used when the widget is located (or will be located) within the hierarchy of a #GtkApplicationWindow. -Names are of the form “win.save” or “app.quit” for actions on the +Names are of the form “win.save” or “app.quit” for actions on the containing #GtkApplicationWindow or its associated #GtkApplication, respectively. This is the same form used for actions in the #GMenu associated with the window. @@ -7069,29 +4934,17 @@ associated with the window. - a #GtkActionable widget + a #GtkActionable widget - - an action name, or %NULL + + an action name, or %NULL - - Sets the target of an actionable widget. + + Sets the target of an actionable widget. This is a convenience function that calls g_variant_new() for @format_string and uses the result to call @@ -7106,46 +4959,36 @@ gtk_actionable_set_detailed_action_name (). - a #GtkActionable widget + a #GtkActionable widget - a GVariant format string + a GVariant format string - arguments appropriate for @format_string + arguments appropriate for @format_string - - Sets the target value of an actionable widget. + + Sets the target value of an actionable widget. If @target_value is %NULL then the target value is unset. The target value has two purposes. First, it is used as the parameter to activation of the action associated with the #GtkActionable widget. Second, it is used to determine if the widget -should be rendered as “active” — the widget is active if the state +should be rendered as “active” — the widget is active if the state is equal to the given target. Consider the example of associating a set of buttons with a #GAction -with string state in a typical “radio button” situation. Each button +with string state in a typical “radio button” situation. Each button will be associated with the same action, but with a different target value for that action. Clicking on a particular button will activate the action with the target of that button, which will typically cause -the action’s state to change to that value. Since the action’s state +the action’s state to change to that value. Since the action’s state is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive). @@ -7155,28 +4998,17 @@ rendered inactive). - a #GtkActionable widget + a #GtkActionable widget - - a #GVariant to set as the target value, or %NULL + + a #GVariant to set as the target value, or %NULL - - Sets the action-name and associated string target value of an + + Sets the action-name and associated string target value of an actionable widget. @detailed_action_name is a string in the format accepted by @@ -7193,15 +5025,11 @@ as the target.) - a #GtkActionable widget + a #GtkActionable widget - the detailed action name + the detailed action name @@ -7213,12 +5041,8 @@ as the target.) - - The interface vtable for #GtkActionable. + + The interface vtable for #GtkActionable. @@ -7227,16 +5051,12 @@ as the target.) - the action name, or %NULL if none is set + the action name, or %NULL if none is set - a #GtkActionable widget + a #GtkActionable widget @@ -7250,18 +5070,11 @@ as the target.) - a #GtkActionable widget + a #GtkActionable widget - - an action name, or %NULL + + an action name, or %NULL @@ -7271,16 +5084,12 @@ as the target.) - the current target value + the current target value - a #GtkActionable widget + a #GtkActionable widget @@ -7294,33 +5103,19 @@ as the target.) - a #GtkActionable widget + a #GtkActionable widget - - a #GVariant to set as the target value, or %NULL + + a #GVariant to set as the target value, or %NULL - - Activatable widgets can be connected to a #GtkAction and reflects + + Activatable widgets can be connected to a #GtkAction and reflects the state of its action. A #GtkActivatable can also provide feedback through its action, as they are responsible for activating their related actions. @@ -7407,7 +5202,7 @@ foo_bar_dispose (GObject *object) G_OBJECT_CLASS (foo_bar_parent_class)->dispose (object); } -... Handle the “related-action” and “use-action-appearance” properties ... +... Handle the “related-action” and “use-action-appearance” properties ... static void foo_bar_set_property (GObject *object, @@ -7555,14 +5350,8 @@ foo_bar_activatable_update (GtkActivatable *activatable, } ]| - - This is called to update the activatable completely, this is called + + This is called to update the activatable completely, this is called internally when the #GtkActivatable:related-action property is set or unset and by the implementing class when #GtkActivatable:use-action-appearance changes. @@ -7572,18 +5361,11 @@ or unset and by the implementing class when - a #GtkActivatable + a #GtkActivatable - - the related #GtkAction or %NULL + + the related #GtkAction or %NULL @@ -7605,14 +5387,8 @@ or unset and by the implementing class when - - This is a utility function for #GtkActivatable implementors. + + This is a utility function for #GtkActivatable implementors. When implementing #GtkActivatable you must call this when handling changes of the #GtkActivatable:related-action, and @@ -7621,7 +5397,7 @@ you must also use this to break references in #GObject->dispose(). This function adds a reference to the currently set related action for you, it also makes sure the #GtkActivatable->update() method is called when the related #GtkAction properties change -and registers to the action’s proxy list. +and registers to the action’s proxy list. > Be careful to call this before setting the local > copy of the #GtkAction property, since this function uses @@ -7633,77 +5409,47 @@ and registers to the action’s proxy list. - a #GtkActivatable + a #GtkActivatable - the #GtkAction to set + the #GtkAction to set - - Gets the related #GtkAction for @activatable. + + Gets the related #GtkAction for @activatable. - the related #GtkAction if one is set. + the related #GtkAction if one is set. - a #GtkActivatable + a #GtkActivatable - - Gets whether this activatable should reset its layout + + Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance. - whether @activatable uses its actions appearance. + whether @activatable uses its actions appearance. - a #GtkActivatable + a #GtkActivatable - - Sets the related action on the @activatable object. + + Sets the related action on the @activatable object. > #GtkActivatable implementors need to handle the #GtkActivatable:related-action > property and call gtk_activatable_do_set_related_action() when it changes. @@ -7713,27 +5459,17 @@ the action changes appearance. - a #GtkActivatable + a #GtkActivatable - the #GtkAction to set + the #GtkAction to set - - Sets whether this activatable should reset its layout and appearance + + Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance > #GtkActivatable implementors need to handle the @@ -7746,27 +5482,17 @@ when setting the related action or when the action changes appearance - a #GtkActivatable + a #GtkActivatable - whether to use the actions appearance + whether to use the actions appearance - - This is called to update the activatable completely, this is called + + This is called to update the activatable completely, this is called internally when the #GtkActivatable:related-action property is set or unset and by the implementing class when #GtkActivatable:use-action-appearance changes. @@ -7776,46 +5502,25 @@ or unset and by the implementing class when - a #GtkActivatable + a #GtkActivatable - - the related #GtkAction or %NULL + + the related #GtkAction or %NULL - - The action that this activatable will activate and receive + + The action that this activatable will activate and receive updates from for various states and possibly appearance. > #GtkActivatable implementors need to handle the this property and > call gtk_activatable_do_set_related_action() when it changes. - - Whether this activatable should reset its layout + + Whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance. @@ -7828,23 +5533,15 @@ should be ignored by the #GtkActivatable when this property is %FALSE. - - > This method can be called with a %NULL action at times. + + > This method can be called with a %NULL action at times. - + @@ -7863,41 +5560,25 @@ should be ignored by the #GtkActivatable when this property is %FALSE. - + - a #GtkActivatable + a #GtkActivatable - - the related #GtkAction or %NULL + + the related #GtkAction or %NULL - - The #GtkAdjustment object represents a value which has an associated lower + + The #GtkAdjustment object represents a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used within several GTK+ widgets, including #GtkSpinButton, #GtkViewport, and #GtkRange (which is a base class for #GtkScrollbar and #GtkScale). @@ -7906,62 +5587,41 @@ The #GtkAdjustment object does not update the value itself. Instead it is left up to the owner of the #GtkAdjustment to control the value. - Creates a new #GtkAdjustment. + Creates a new #GtkAdjustment. - a new #GtkAdjustment + a new #GtkAdjustment - the initial value + the initial value - the minimum value + the minimum value - the maximum value + the maximum value - the step increment + the step increment - the page increment + the page increment - the page size + the page size - - Emits a #GtkAdjustment::changed signal from the #GtkAdjustment. + + Emits a #GtkAdjustment::changed signal from the #GtkAdjustment. This is typically called by the owner of the #GtkAdjustment after it has changed any of the #GtkAdjustment properties other than the value. GTK+ emits #GtkAdjustment::changed itself whenever any @@ -7972,20 +5632,13 @@ changed any of the #GtkAdjustment properties other than the value. - a #GtkAdjustment + a #GtkAdjustment - - Emits a #GtkAdjustment::value-changed signal from the #GtkAdjustment. + + Emits a #GtkAdjustment::value-changed signal from the #GtkAdjustment. This is typically called by the owner of the #GtkAdjustment after it has changed the #GtkAdjustment:value property. GTK+ emits #GtkAdjustment::value-changed itself whenever @@ -7996,20 +5649,13 @@ changed the #GtkAdjustment:value property. - a #GtkAdjustment + a #GtkAdjustment - - Emits a #GtkAdjustment::changed signal from the #GtkAdjustment. + + Emits a #GtkAdjustment::changed signal from the #GtkAdjustment. This is typically called by the owner of the #GtkAdjustment after it has changed any of the #GtkAdjustment properties other than the value. GTK+ emits #GtkAdjustment::changed itself whenever any @@ -8020,17 +5666,13 @@ changed any of the #GtkAdjustment properties other than the value. - a #GtkAdjustment + a #GtkAdjustment - Updates the #GtkAdjustment:value property to ensure that the range + Updates the #GtkAdjustment:value property to ensure that the range between @lower and @upper is in the current page (i.e. between #GtkAdjustment:value and #GtkAdjustment:value + #GtkAdjustment:page-size). If the range is larger than the page size, then only the start of it will @@ -8043,31 +5685,21 @@ A #GtkAdjustment::value-changed signal will be emitted if the value is changed.< - a #GtkAdjustment + a #GtkAdjustment - the lower value + the lower value - the upper value + the upper value - - Sets all properties of the adjustment at once. + + Sets all properties of the adjustment at once. Use this function to avoid multiple emissions of the #GtkAdjustment::changed signal. See gtk_adjustment_set_lower() @@ -8079,214 +5711,142 @@ for an alternative way of compressing multiple emissions of - a #GtkAdjustment + a #GtkAdjustment - the new value + the new value - the new minimum value + the new minimum value - the new maximum value + the new maximum value - the new step increment + the new step increment - the new page increment + the new page increment - the new page size + the new page size - - Retrieves the minimum value of the adjustment. + + Retrieves the minimum value of the adjustment. - The current minimum value of the adjustment + The current minimum value of the adjustment - a #GtkAdjustment + a #GtkAdjustment - - Gets the smaller of step increment and page increment. + + Gets the smaller of step increment and page increment. - the minimum increment of @adjustment + the minimum increment of @adjustment - a #GtkAdjustment + a #GtkAdjustment - - Retrieves the page increment of the adjustment. + + Retrieves the page increment of the adjustment. - The current page increment of the adjustment + The current page increment of the adjustment - a #GtkAdjustment + a #GtkAdjustment - - Retrieves the page size of the adjustment. + + Retrieves the page size of the adjustment. - The current page size of the adjustment + The current page size of the adjustment - a #GtkAdjustment + a #GtkAdjustment - - Retrieves the step increment of the adjustment. + + Retrieves the step increment of the adjustment. - The current step increment of the adjustment. + The current step increment of the adjustment. - a #GtkAdjustment + a #GtkAdjustment - - Retrieves the maximum value of the adjustment. + + Retrieves the maximum value of the adjustment. - The current maximum value of the adjustment + The current maximum value of the adjustment - a #GtkAdjustment + a #GtkAdjustment - Gets the current value of the adjustment. + Gets the current value of the adjustment. See gtk_adjustment_set_value(). - The current value of the adjustment + The current value of the adjustment - a #GtkAdjustment + a #GtkAdjustment - - Sets the minimum value of the adjustment. + + Sets the minimum value of the adjustment. When setting multiple adjustment properties via their individual setters, multiple #GtkAdjustment::changed signals will be emitted. However, since the emission of the #GtkAdjustment::changed signal is tied to the emission of the #GObject::notify signals of the changed -properties, it’s possible to compress the #GtkAdjustment::changed +properties, it’s possible to compress the #GtkAdjustment::changed signals into one by calling g_object_freeze_notify() and g_object_thaw_notify() around the calls to the individual setters. @@ -8299,25 +5859,17 @@ of compressing #GtkAdjustment::changed emissions. - a #GtkAdjustment + a #GtkAdjustment - the new minimum value + the new minimum value - - Sets the page increment of the adjustment. + + Sets the page increment of the adjustment. See gtk_adjustment_set_lower() about how to compress multiple emissions of the #GtkAdjustment::changed signal when setting @@ -8328,25 +5880,17 @@ multiple adjustment properties. - a #GtkAdjustment + a #GtkAdjustment - the new page increment + the new page increment - - Sets the page size of the adjustment. + + Sets the page size of the adjustment. See gtk_adjustment_set_lower() about how to compress multiple emissions of the GtkAdjustment::changed signal when setting @@ -8357,25 +5901,17 @@ multiple adjustment properties. - a #GtkAdjustment + a #GtkAdjustment - the new page size + the new page size - - Sets the step increment of the adjustment. + + Sets the step increment of the adjustment. See gtk_adjustment_set_lower() about how to compress multiple emissions of the #GtkAdjustment::changed signal when setting @@ -8386,25 +5922,17 @@ multiple adjustment properties. - a #GtkAdjustment + a #GtkAdjustment - the new step increment + the new step increment - - Sets the maximum value of the adjustment. + + Sets the maximum value of the adjustment. Note that values will be restricted by `upper - page-size` if the page-size property is nonzero. @@ -8418,23 +5946,17 @@ multiple adjustment properties. - a #GtkAdjustment + a #GtkAdjustment - the new maximum value + the new maximum value - Sets the #GtkAdjustment value. The value is clamped to lie between + Sets the #GtkAdjustment value. The value is clamped to lie between #GtkAdjustment:lower and #GtkAdjustment:upper. Note that for adjustments which are used in a #GtkScrollbar, the @@ -8446,26 +5968,17 @@ effective range of allowed values goes from #GtkAdjustment:lower to - a #GtkAdjustment + a #GtkAdjustment - the new value + the new value - - Emits a #GtkAdjustment::value-changed signal from the #GtkAdjustment. + + Emits a #GtkAdjustment::value-changed signal from the #GtkAdjustment. This is typically called by the owner of the #GtkAdjustment after it has changed the #GtkAdjustment:value property. GTK+ emits #GtkAdjustment::value-changed itself whenever @@ -8476,71 +5989,39 @@ changed the #GtkAdjustment:value property. - a #GtkAdjustment + a #GtkAdjustment - - The minimum value of the adjustment. + + The minimum value of the adjustment. - - The page increment of the adjustment. + + The page increment of the adjustment. - - The page size of the adjustment. + + The page size of the adjustment. Note that the page-size is irrelevant and should be set to zero if the adjustment is used for a simple scalar value, e.g. in a #GtkSpinButton. - - The step increment of the adjustment. + + The step increment of the adjustment. - - The maximum value of the adjustment. + + The maximum value of the adjustment. Note that values will be restricted by `upper - page-size` if the page-size property is nonzero. - - The value of the adjustment. + + The value of the adjustment. @@ -8550,30 +6031,23 @@ property is nonzero. - Emitted when one or more of the #GtkAdjustment properties have been + Emitted when one or more of the #GtkAdjustment properties have been changed, other than the #GtkAdjustment:value property. - Emitted when the #GtkAdjustment:value property has been changed. + Emitted when the #GtkAdjustment:value property has been changed. - + - + @@ -8583,9 +6057,7 @@ changed, other than the #GtkAdjustment:value property. - a #GtkAdjustment + a #GtkAdjustment @@ -8599,9 +6071,7 @@ changed, other than the #GtkAdjustment:value property. - a #GtkAdjustment + a #GtkAdjustment @@ -8640,21 +6110,14 @@ changed, other than the #GtkAdjustment:value property. - + - - Controls how a widget deals with extra space in a single (x or y) + + Controls how a widget deals with extra space in a single (x or y) dimension. -Alignment only matters if the widget receives a “too large” allocation, +Alignment only matters if the widget receives a “too large” allocation, for example if you packed the widget with the #GtkWidget:expand flag inside a #GtkBox, then the widget might get extra space. If you have for example a 16x16 icon inside a 32x32 space, the icon @@ -8667,66 +6130,33 @@ are interpreted relative to text direction. GTK_ALIGN_BASELINE support for it is optional for containers and widgets, and it is only supported for vertical alignment. When its not supported by a child or a container it is treated as @GTK_ALIGN_FILL. - - stretch to fill all space if possible, center if + + stretch to fill all space if possible, center if no meaningful way to stretch - - snap to left or top side, leaving space on right + + snap to left or top side, leaving space on right or bottom - - snap to right or bottom side, leaving space on left + + snap to right or bottom side, leaving space on left or top - - center natural width of widget inside the + + center natural width of widget inside the allocation - - align the widget according to the baseline. Since 3.10. + + align the widget according to the baseline. Since 3.10. - - The #GtkAlignment widget controls the alignment and size of its child widget. + + The #GtkAlignment widget controls the alignment and size of its child widget. It has four settings: xscale, yscale, xalign, and yalign. The scale settings are used to specify how much the child widget should expand to fill the space allocated to the #GtkAlignment. -The values can range from 0 (meaning the child doesn’t expand at all) to +The values can range from 0 (meaning the child doesn’t expand at all) to 1 (meaning the child expands to fill all of the available space). The align settings are used to place the child widget within the available @@ -8741,40 +6171,27 @@ child widget. - - Creates a new #GtkAlignment. + + Creates a new #GtkAlignment. Use #GtkWidget alignment and margin properties - the new #GtkAlignment + the new #GtkAlignment - the horizontal alignment of the child widget, from 0 (left) to 1 + the horizontal alignment of the child widget, from 0 (left) to 1 (right). - the vertical alignment of the child widget, from 0 (top) to 1 + the vertical alignment of the child widget, from 0 (top) to 1 (bottom). - the amount that the child widget expands horizontally to fill up + the amount that the child widget expands horizontally to fill up unused space, from 0 to 1. A value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the @@ -8782,22 +6199,14 @@ child widget. - the amount that the child widget expands vertically to fill up + the amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to @xscale. - - Gets the padding on the different sides of the widget. + + Gets the padding on the different sides of the widget. See gtk_alignment_set_padding (). Use #GtkWidget alignment and margin properties @@ -8806,68 +6215,33 @@ See gtk_alignment_set_padding (). - a #GtkAlignment + a #GtkAlignment - - location to store the padding for + + location to store the padding for the top of the widget, or %NULL - - location to store the padding + + location to store the padding for the bottom of the widget, or %NULL - - location to store the padding + + location to store the padding for the left of the widget, or %NULL - - location to store the padding + + location to store the padding for the right of the widget, or %NULL - - Sets the #GtkAlignment values. + + Sets the #GtkAlignment values. Use #GtkWidget alignment and margin properties @@ -8875,29 +6249,21 @@ See gtk_alignment_set_padding (). - a #GtkAlignment. + a #GtkAlignment. - the horizontal alignment of the child widget, from 0 (left) to 1 + the horizontal alignment of the child widget, from 0 (left) to 1 (right). - the vertical alignment of the child widget, from 0 (top) to 1 + the vertical alignment of the child widget, from 0 (top) to 1 (bottom). - the amount that the child widget expands horizontally to fill up + the amount that the child widget expands horizontally to fill up unused space, from 0 to 1. A value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the @@ -8905,22 +6271,14 @@ See gtk_alignment_set_padding (). - the amount that the child widget expands vertically to fill up + the amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to @xscale. - - Sets the padding on the different sides of the widget. + + Sets the padding on the different sides of the widget. The padding adds blank space to the sides of the widget. For instance, this can be used to indent the child widget towards the right by adding padding on the left. @@ -8931,132 +6289,70 @@ padding on the left. - a #GtkAlignment + a #GtkAlignment - the padding at the top of the widget + the padding at the top of the widget - the padding at the bottom of the widget + the padding at the bottom of the widget - the padding at the left of the widget + the padding at the left of the widget - the padding at the right of the widget. + the padding at the right of the widget. - - The padding to insert at the bottom of the widget. + + The padding to insert at the bottom of the widget. Use gtk_widget_set_margin_bottom() instead - - The padding to insert at the left of the widget. + + The padding to insert at the left of the widget. Use gtk_widget_set_margin_start() instead - - The padding to insert at the right of the widget. + + The padding to insert at the right of the widget. Use gtk_widget_set_margin_end() instead - - The padding to insert at the top of the widget. + + The padding to insert at the top of the widget. Use gtk_widget_set_margin_top() instead - - Horizontal position of child in available space. A value of 0.0 + + Horizontal position of child in available space. A value of 0.0 will flush the child left (or right, in RTL locales); a value of 1.0 will flush the child right (or left, in RTL locales). Use gtk_widget_set_halign() on the child instead - - If available horizontal space is bigger than needed, how much + + If available horizontal space is bigger than needed, how much of it to use for the child. A value of 0.0 means none; a value of 1.0 means all. Use gtk_widget_set_hexpand() on the child instead - - Vertical position of child in available space. A value of 0.0 + + Vertical position of child in available space. A value of 0.0 will flush the child to the top; a value of 1.0 will flush the child to the bottom. Use gtk_widget_set_valign() on the child instead - - If available vertical space is bigger than needed, how much + + If available vertical space is bigger than needed, how much of it to use for the child. A value of 0.0 means none; a value of 1.0 means all. Use gtk_widget_set_vexpand() on the child instead @@ -9069,14 +6365,10 @@ of 1.0 means all. - + - The parent class. + The parent class. @@ -9115,14 +6407,8 @@ of 1.0 means all. - - #GtkAppChooser is an interface that can be implemented by widgets which + + #GtkAppChooser is an interface that can be implemented by widgets which allow the user to choose an application (typically for the purpose of opening a file). The main objects that implement this interface are #GtkAppChooserWidget, #GtkAppChooserDialog and #GtkAppChooserButton. @@ -9140,93 +6426,58 @@ recommended or fallback applications. To obtain the application that has been selected in a #GtkAppChooser, use gtk_app_chooser_get_app_info(). - - Returns the currently selected application. + + Returns the currently selected application. - a #GAppInfo for the currently selected + a #GAppInfo for the currently selected application, or %NULL if none is selected. Free with g_object_unref() - a #GtkAppChooser + a #GtkAppChooser - - Returns the current value of the #GtkAppChooser:content-type property. + + Returns the current value of the #GtkAppChooser:content-type property. - the content type of @self. Free with g_free() + the content type of @self. Free with g_free() - a #GtkAppChooser + a #GtkAppChooser - - Reloads the list of applications. + + Reloads the list of applications. - a #GtkAppChooser + a #GtkAppChooser - - The content type of the #GtkAppChooser object. + + The content type of the #GtkAppChooser object. See [GContentType][gio-GContentType] for more information about content types. - - The #GtkAppChooserButton is a widget that lets the user select + + The #GtkAppChooserButton is a widget that lets the user select an application. It implements the #GtkAppChooser interface. Initially, a #GtkAppChooserButton selects the first application @@ -9254,25 +6505,17 @@ To track changes in the selected application, use the - - Creates a new #GtkAppChooserButton for applications + + Creates a new #GtkAppChooserButton for applications that can handle content of the given type. - a newly created #GtkAppChooserButton + a newly created #GtkAppChooserButton - the content type to show applications for + the content type to show applications for @@ -9291,12 +6534,8 @@ that can handle content of the given type. - - Appends a custom item to the list of applications that is shown + + Appends a custom item to the list of applications that is shown in the popup; the item name must be unique per-widget. Clients can use the provided name as a detail for the #GtkAppChooserButton::custom-item-activated signal, to add a @@ -9308,37 +6547,25 @@ See also gtk_app_chooser_button_append_separator(). - a #GtkAppChooserButton + a #GtkAppChooserButton - the name of the custom item + the name of the custom item - the label for the custom item + the label for the custom item - the icon for the custom item + the icon for the custom item - - Appends a separator to the list of applications that is shown + + Appends a separator to the list of applications that is shown in the popup. @@ -9346,87 +6573,58 @@ in the popup. - a #GtkAppChooserButton + a #GtkAppChooserButton - - Returns the text to display at the top of the dialog. + + Returns the text to display at the top of the dialog. - the text to display at the top of the dialog, + the text to display at the top of the dialog, or %NULL, in which case a default text is displayed - a #GtkAppChooserButton + a #GtkAppChooserButton - - Returns the current value of the #GtkAppChooserButton:show-default-item + + Returns the current value of the #GtkAppChooserButton:show-default-item property. - the value of #GtkAppChooserButton:show-default-item + the value of #GtkAppChooserButton:show-default-item - a #GtkAppChooserButton + a #GtkAppChooserButton - - Returns the current value of the #GtkAppChooserButton:show-dialog-item + + Returns the current value of the #GtkAppChooserButton:show-dialog-item property. - the value of #GtkAppChooserButton:show-dialog-item + the value of #GtkAppChooserButton:show-dialog-item - a #GtkAppChooserButton + a #GtkAppChooserButton - - Selects a custom item previously added with + + Selects a custom item previously added with gtk_app_chooser_button_append_custom_item(). Use gtk_app_chooser_refresh() to bring the selection @@ -9437,24 +6635,17 @@ to its initial state. - a #GtkAppChooserButton + a #GtkAppChooserButton - the name of the custom item + the name of the custom item - - Sets the text to display at the top of the dialog. + + Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text. @@ -9462,25 +6653,17 @@ If the heading is not set, the dialog displays a default text. - a #GtkAppChooserButton + a #GtkAppChooserButton - a string containing Pango markup + a string containing Pango markup - - Sets whether the dropdown menu of this button should show the + + Sets whether the dropdown menu of this button should show the default application for the given content type at top. @@ -9488,25 +6671,17 @@ default application for the given content type at top. - a #GtkAppChooserButton + a #GtkAppChooserButton - the new value for #GtkAppChooserButton:show-default-item + the new value for #GtkAppChooserButton:show-default-item - - Sets whether the dropdown menu of this button should show an + + Sets whether the dropdown menu of this button should show an entry to trigger a #GtkAppChooserDialog. @@ -9514,45 +6689,28 @@ entry to trigger a #GtkAppChooserDialog. - a #GtkAppChooserButton + a #GtkAppChooserButton - the new value for #GtkAppChooserButton:show-dialog-item + the new value for #GtkAppChooserButton:show-dialog-item - The text to show at the top of the dialog that can be + The text to show at the top of the dialog that can be opened from the button. The string may contain Pango markup. - - The #GtkAppChooserButton:show-default-item property determines + + The #GtkAppChooserButton:show-default-item property determines whether the dropdown menu should show the default application on top for the provided content type. - - The #GtkAppChooserButton:show-dialog-item property determines + + The #GtkAppChooserButton:show-dialog-item property determines whether the dropdown menu should show an item that triggers a #GtkAppChooserDialog when clicked. @@ -9561,13 +6719,10 @@ a #GtkAppChooserDialog when clicked. - + - Emitted when a custom item, previously added with + Emitted when a custom item, previously added with gtk_app_chooser_button_append_custom_item(), is activated from the dropdown menu. @@ -9575,22 +6730,16 @@ dropdown menu. - the name of the activated item + the name of the activated item - + - The parent class. + The parent class. @@ -9615,21 +6764,11 @@ dropdown menu. - + - - #GtkAppChooserDialog shows a #GtkAppChooserWidget inside a #GtkDialog. + + #GtkAppChooserDialog shows a #GtkAppChooserWidget inside a #GtkDialog. Note that #GtkAppChooserDialog does not have any interesting methods of its own. Instead, you should get the embedded #GtkAppChooserWidget @@ -9642,131 +6781,83 @@ use gtk_app_chooser_dialog_set_heading(). - - Creates a new #GtkAppChooserDialog for the provided #GFile, + + Creates a new #GtkAppChooserDialog for the provided #GFile, to allow the user to select an application for it. - a newly created #GtkAppChooserDialog + a newly created #GtkAppChooserDialog - - a #GtkWindow, or %NULL + + a #GtkWindow, or %NULL - flags for this dialog + flags for this dialog - a #GFile + a #GFile - - Creates a new #GtkAppChooserDialog for the provided content type, + + Creates a new #GtkAppChooserDialog for the provided content type, to allow the user to select an application for it. - a newly created #GtkAppChooserDialog + a newly created #GtkAppChooserDialog - - a #GtkWindow, or %NULL + + a #GtkWindow, or %NULL - flags for this dialog + flags for this dialog - a content type string + a content type string - - Returns the text to display at the top of the dialog. + + Returns the text to display at the top of the dialog. - the text to display at the top of the dialog, or %NULL, in which + the text to display at the top of the dialog, or %NULL, in which case a default text is displayed - a #GtkAppChooserDialog + a #GtkAppChooserDialog - - Returns the #GtkAppChooserWidget of this dialog. + + Returns the #GtkAppChooserWidget of this dialog. - the #GtkAppChooserWidget of @self + the #GtkAppChooserWidget of @self - a #GtkAppChooserDialog + a #GtkAppChooserDialog - - Sets the text to display at the top of the dialog. + + Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text. @@ -9774,34 +6865,23 @@ If the heading is not set, the dialog displays a default text. - a #GtkAppChooserDialog + a #GtkAppChooserDialog - a string containing Pango markup + a string containing Pango markup - - The GFile used by the #GtkAppChooserDialog. + + The GFile used by the #GtkAppChooserDialog. The dialog's #GtkAppChooserWidget content type will be guessed from the file, if present. - The text to show at the top of the dialog. + The text to show at the top of the dialog. The string may contain Pango markup. @@ -9809,18 +6889,13 @@ The string may contain Pango markup. - + - + - The parent class. + The parent class. @@ -9829,21 +6904,11 @@ The string may contain Pango markup. - + - - #GtkAppChooserWidget is a widget for selecting applications. + + #GtkAppChooserWidget is a widget for selecting applications. It is the main building block for #GtkAppChooserDialog. Most applications only need to use the latter; but you can use this widget as part of a larger widget if you have special needs. @@ -9869,25 +6934,17 @@ GtkAppChooserWidget has a single CSS node with name appchooser. - - Creates a new #GtkAppChooserWidget for applications + + Creates a new #GtkAppChooserWidget for applications that can handle content of the given type. - a newly created #GtkAppChooserWidget + a newly created #GtkAppChooserWidget - the content type to show applications for + the content type to show applications for @@ -9937,149 +6994,98 @@ that can handle content of the given type. - - Returns the text that is shown if there are not applications + + Returns the text that is shown if there are not applications that can handle the content type. - the value of #GtkAppChooserWidget:default-text + the value of #GtkAppChooserWidget:default-text - a #GtkAppChooserWidget + a #GtkAppChooserWidget - - Returns the current value of the #GtkAppChooserWidget:show-all + + Returns the current value of the #GtkAppChooserWidget:show-all property. - the value of #GtkAppChooserWidget:show-all + the value of #GtkAppChooserWidget:show-all - a #GtkAppChooserWidget + a #GtkAppChooserWidget - - Returns the current value of the #GtkAppChooserWidget:show-default + + Returns the current value of the #GtkAppChooserWidget:show-default property. - the value of #GtkAppChooserWidget:show-default + the value of #GtkAppChooserWidget:show-default - a #GtkAppChooserWidget + a #GtkAppChooserWidget - - Returns the current value of the #GtkAppChooserWidget:show-fallback + + Returns the current value of the #GtkAppChooserWidget:show-fallback property. - the value of #GtkAppChooserWidget:show-fallback + the value of #GtkAppChooserWidget:show-fallback - a #GtkAppChooserWidget + a #GtkAppChooserWidget - - Returns the current value of the #GtkAppChooserWidget:show-other + + Returns the current value of the #GtkAppChooserWidget:show-other property. - the value of #GtkAppChooserWidget:show-other + the value of #GtkAppChooserWidget:show-other - a #GtkAppChooserWidget + a #GtkAppChooserWidget - - Returns the current value of the #GtkAppChooserWidget:show-recommended + + Returns the current value of the #GtkAppChooserWidget:show-recommended property. - the value of #GtkAppChooserWidget:show-recommended + the value of #GtkAppChooserWidget:show-recommended - a #GtkAppChooserWidget + a #GtkAppChooserWidget - - Sets the text that is shown if there are not applications + + Sets the text that is shown if there are not applications that can handle the content type. @@ -10087,25 +7093,17 @@ that can handle the content type. - a #GtkAppChooserWidget + a #GtkAppChooserWidget - the new value for #GtkAppChooserWidget:default-text + the new value for #GtkAppChooserWidget:default-text - - Sets whether the app chooser should show all applications + + Sets whether the app chooser should show all applications in a flat list. @@ -10113,25 +7111,17 @@ in a flat list. - a #GtkAppChooserWidget + a #GtkAppChooserWidget - the new value for #GtkAppChooserWidget:show-all + the new value for #GtkAppChooserWidget:show-all - - Sets whether the app chooser should show the default handler + + Sets whether the app chooser should show the default handler for the content type in a separate section. @@ -10139,25 +7129,17 @@ for the content type in a separate section. - a #GtkAppChooserWidget + a #GtkAppChooserWidget - the new value for #GtkAppChooserWidget:show-default + the new value for #GtkAppChooserWidget:show-default - - Sets whether the app chooser should show related applications + + Sets whether the app chooser should show related applications for the content type in a separate section. @@ -10165,25 +7147,17 @@ for the content type in a separate section. - a #GtkAppChooserWidget + a #GtkAppChooserWidget - the new value for #GtkAppChooserWidget:show-fallback + the new value for #GtkAppChooserWidget:show-fallback - - Sets whether the app chooser should show applications + + Sets whether the app chooser should show applications which are unrelated to the content type. @@ -10191,25 +7165,17 @@ which are unrelated to the content type. - a #GtkAppChooserWidget + a #GtkAppChooserWidget - the new value for #GtkAppChooserWidget:show-other + the new value for #GtkAppChooserWidget:show-other - - Sets whether the app chooser should show recommended applications + + Sets whether the app chooser should show recommended applications for the content type in a separate section. @@ -10217,80 +7183,49 @@ for the content type in a separate section. - a #GtkAppChooserWidget + a #GtkAppChooserWidget - the new value for #GtkAppChooserWidget:show-recommended + the new value for #GtkAppChooserWidget:show-recommended - The #GtkAppChooserWidget:default-text property determines the text + The #GtkAppChooserWidget:default-text property determines the text that appears in the widget when there are no applications for the given content type. See also gtk_app_chooser_widget_set_default_text(). - - If the #GtkAppChooserWidget:show-all property is %TRUE, the app + + If the #GtkAppChooserWidget:show-all property is %TRUE, the app chooser presents all applications in a single list, without subsections for default, recommended or related applications. - - The ::show-default property determines whether the app chooser + + The ::show-default property determines whether the app chooser should show the default handler for the content type in a separate section. If %FALSE, the default handler is listed among the recommended applications. - - The #GtkAppChooserWidget:show-fallback property determines whether + + The #GtkAppChooserWidget:show-fallback property determines whether the app chooser should show a section for fallback applications. If %FALSE, the fallback applications are listed among the other applications. - - The #GtkAppChooserWidget:show-other property determines whether + + The #GtkAppChooserWidget:show-other property determines whether the app chooser should show a section for other applications. - - The #GtkAppChooserWidget:show-recommended property determines + + The #GtkAppChooserWidget:show-recommended property determines whether the app chooser should show a section for recommended applications. If %FALSE, the recommended applications are listed among the other applications. @@ -10300,13 +7235,10 @@ among the other applications. - + - Emitted when an application item is activated from the widget's list. + Emitted when an application item is activated from the widget's list. This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, @@ -10316,33 +7248,25 @@ Return or Enter. - the activated #GAppInfo + the activated #GAppInfo - Emitted when an application item is selected from the widget's list. + Emitted when an application item is selected from the widget's list. - the selected #GAppInfo + the selected #GAppInfo - Emitted when a context menu is about to popup over an application item. + Emitted when a context menu is about to popup over an application item. Clients can insert menu items into the provided #GtkMenu object in the callback of this signal; the context menu will be shown over the item if at least one item has been added to the menu. @@ -10351,28 +7275,20 @@ if at least one item has been added to the menu. - the #GtkMenu to populate + the #GtkMenu to populate - the current #GAppInfo + the current #GAppInfo - + - The parent class. + The parent class. @@ -10432,21 +7348,11 @@ if at least one item has been added to the menu. - + - - #GtkApplication is a class that handles many important aspects + + #GtkApplication is a class that handles many important aspects of a GTK+ application in a convenient fashion, without enforcing a one-size-fits-all application model. @@ -10465,8 +7371,8 @@ lock is not touched for local action invocations. In order to have actions invoked in a predictable context it is therefore recommended that the GDK lock be held while invoking actions locally with g_action_group_activate_action(). The same applies to actions -associated with #GtkApplicationWindow and to the “activate” and -“open” #GApplication methods. +associated with #GtkApplicationWindow and to the “activate” and +“open” #GApplication methods. ## Automatic resources ## {#automatic-resources} @@ -10526,9 +7432,7 @@ session while inhibitors are present. - Creates a new #GtkApplication instance. + Creates a new #GtkApplication instance. When using #GtkApplication, it is not necessary to call gtk_init() manually. It is called as soon as the application gets registered as @@ -10554,25 +7458,16 @@ uniqueness) will be disabled. A null application ID is only allowed with GTK+ 3.6 or later. - a new #GtkApplication instance + a new #GtkApplication instance - - The application ID. + + The application ID. - the application flags + the application flags @@ -10605,26 +7500,20 @@ GTK+ 3.6 or later. - - Installs an accelerator that will cause the named action + + Installs an accelerator that will cause the named action to be activated when the key combination specificed by @accelerator is pressed. @accelerator must be a string that can be parsed by gtk_accelerator_parse(), -e.g. "<Primary>q" or “<Control><Alt>p”. +e.g. "<Primary>q" or “<Control><Alt>p”. @action_name must be the name of an action as it would be used in the app menu, i.e. actions that have been added to the application -are referred to with an “app.” prefix, and window-specific actions -with a “win.” prefix. +are referred to with an “app.” prefix, and window-specific actions +with a “win.” prefix. -GtkApplication also extracts accelerators out of “accel” attributes +GtkApplication also extracts accelerators out of “accel” attributes in the #GMenuModels passed to gtk_application_set_app_menu() and gtk_application_set_menubar(), which is usually more convenient than calling this function for each accelerator. @@ -10635,41 +7524,26 @@ than calling this function for each accelerator. - a #GtkApplication + a #GtkApplication - accelerator string + accelerator string - the name of the action to activate + the name of the action to activate - - parameter to pass when activating the action, + + parameter to pass when activating the action, or %NULL if the action does not accept an activation parameter - - Adds a window to @application. + + Adds a window to @application. This call can only happen after the @application has started; typically, you should add new application windows in response @@ -10690,31 +7564,21 @@ any windows. - a #GtkApplication + a #GtkApplication - a #GtkWindow + a #GtkWindow - - Gets the accelerators that are currently associated with + + Gets the accelerators that are currently associated with the given action. - accelerators for @detailed_action_name, as + accelerators for @detailed_action_name, as a %NULL-terminated array. Free with g_strfreev() when no longer needed @@ -10722,26 +7586,18 @@ the given action. - a #GtkApplication + a #GtkApplication - a detailed action name, specifying an action + a detailed action name, specifying an action and target to obtain accelerators for - - Returns the list of actions (possibly empty) that @accel maps to. + + Returns the list of actions (possibly empty) that @accel maps to. Each item in the list is a detailed action name in the usual form. This might be useful to discover if an accel already exists in @@ -10758,172 +7614,118 @@ It is a programmer error to pass an invalid accelerator string. If you are unsure, check it with gtk_accelerator_parse() first. - a %NULL-terminated array of actions for @accel + a %NULL-terminated array of actions for @accel - a #GtkApplication + a #GtkApplication - an accelerator that can be parsed by gtk_accelerator_parse() + an accelerator that can be parsed by gtk_accelerator_parse() - - Gets the “active” window for the application. + + Gets the “active” window for the application. The active window is the one that was most recently focused (within the application). This window may not have the focus at the moment -if another application has it — this is just the most +if another application has it — this is just the most recently-focused window within this application. - the active window, or %NULL if + the active window, or %NULL if there isn't one. - a #GtkApplication + a #GtkApplication - - Returns the menu model that has been set with + + Returns the menu model that has been set with gtk_application_set_app_menu(). - the application menu of @application + the application menu of @application or %NULL if no application menu has been set. - a #GtkApplication + a #GtkApplication - - Gets a menu from automatically loaded resources. + + Gets a menu from automatically loaded resources. See [Automatic resources][automatic-resources] for more information. - Gets the menu with the + Gets the menu with the given id from the automatically loaded resources - a #GtkApplication + a #GtkApplication - the id of the menu to look up + the id of the menu to look up - - Returns the menu model that has been set with + + Returns the menu model that has been set with gtk_application_set_menubar(). - the menubar for windows of @application + the menubar for windows of @application - a #GtkApplication + a #GtkApplication - - Returns the #GtkApplicationWindow with the given ID. + + Returns the #GtkApplicationWindow with the given ID. The ID of a #GtkApplicationWindow can be retrieved with gtk_application_window_get_id(). - the window with ID @id, or + the window with ID @id, or %NULL if there is no window with this ID - a #GtkApplication + a #GtkApplication - an identifier number + an identifier number - - Gets a list of the #GtkWindows associated with @application. + + Gets a list of the #GtkWindows associated with @application. The list is sorted by most recently focused window, such that the first element is the currently focused window. (Useful for choosing a parent @@ -10934,28 +7736,20 @@ only remain valid until the next focus change or window creation or deletion. - a #GList of #GtkWindow + a #GList of #GtkWindow - a #GtkApplication + a #GtkApplication - - Inform the session manager that certain types of actions should be + + Inform the session manager that certain types of actions should be inhibited. This is not guaranteed to work on all platforms and for all types of actions. @@ -10978,9 +7772,7 @@ If @window is given, the session manager may point the user to this window to find out more about why the action is inhibited. - A non-zero cookie that is used to uniquely identify this + A non-zero cookie that is used to uniquely identify this request. It should be used as an argument to gtk_application_uninhibit() in order to remove the request. If the platform does not support inhibiting or the request failed for some reason, 0 is returned. @@ -10988,84 +7780,52 @@ this window to find out more about why the action is inhibited. - the #GtkApplication + the #GtkApplication - - a #GtkWindow, or %NULL + + a #GtkWindow, or %NULL - what types of actions should be inhibited - + what types of actions should be inhibited + - - a short, human-readable string that explains + + a short, human-readable string that explains why these operations are inhibited - - Determines if any of the actions specified in @flags are + + Determines if any of the actions specified in @flags are currently inhibited (possibly by another application). Note that this information may not be available (for example when the application is running in a sandbox). - %TRUE if any of the actions specified in @flags are inhibited + %TRUE if any of the actions specified in @flags are inhibited - the #GtkApplication + the #GtkApplication - what types of actions should be queried - + what types of actions should be queried + - - Lists the detailed action names which have associated accelerators. + + Lists the detailed action names which have associated accelerators. See gtk_application_set_accels_for_action(). - a %NULL-terminated array of strings, + a %NULL-terminated array of strings, free with g_strfreev() when done @@ -11073,19 +7833,13 @@ See gtk_application_set_accels_for_action(). - a #GtkApplication + a #GtkApplication - - Determines if the desktop environment in which the application is + + Determines if the desktop environment in which the application is running would prefer an application menu be shown. If this function returns %TRUE then the application should call @@ -11121,28 +7875,18 @@ gtk_application_set_app_menu() anyway, then this menu will be replaced with your own. - %TRUE if you should set an app menu + %TRUE if you should set an app menu - a #GtkApplication + a #GtkApplication - - Removes an accelerator that has been previously added + + Removes an accelerator that has been previously added with gtk_application_add_accelerator(). Use gtk_application_set_accels_for_action() instead @@ -11151,35 +7895,22 @@ with gtk_application_add_accelerator(). - a #GtkApplication + a #GtkApplication - the name of the action to activate + the name of the action to activate - - parameter to pass when activating the action, + + parameter to pass when activating the action, or %NULL if the action does not accept an activation parameter - - Remove a window from @application. + + Remove a window from @application. If @window belongs to @application then this call is equivalent to setting the #GtkWindow:application property of @window to @@ -11193,25 +7924,17 @@ function. - a #GtkApplication + a #GtkApplication - a #GtkWindow + a #GtkWindow - - Sets zero or more keyboard accelerators that will trigger the + + Sets zero or more keyboard accelerators that will trigger the given action. The first item in @accels will be the primary accelerator, which may be displayed in the UI. @@ -11226,22 +7949,16 @@ g_action_print_detailed_name(). - a #GtkApplication + a #GtkApplication - a detailed action name, specifying an action + a detailed action name, specifying an action and target to associate accelerators with - a list of accelerators in the format + a list of accelerators in the format understood by gtk_accelerator_parse() @@ -11249,12 +7966,8 @@ g_action_print_detailed_name(). - - Sets or unsets the application menu for @application. + + Sets or unsets the application menu for @application. This can only be done in the primary instance of the application, after it has been registered. #GApplication::startup is a good place @@ -11263,8 +7976,8 @@ to call this. The application menu is a single menu containing items that typically impact the application as a whole, rather than acting on a specific window or document. For example, you would expect to see -“Preferences” or “Quit” in an application menu, but not “Save” or -“Print”. +“Preferences” or “Quit” in an application menu, but not “Save” or +“Print”. If supported, the application menu will be rendered by the desktop environment. @@ -11277,28 +7990,17 @@ selecting these menu items. - a #GtkApplication + a #GtkApplication - - a #GMenuModel, or %NULL + + a #GMenuModel, or %NULL - - Sets or unsets the menubar for windows of @application. + + Sets or unsets the menubar for windows of @application. This is a menubar in the traditional sense. @@ -11310,7 +8012,7 @@ Depending on the desktop environment, this may appear at the top of each window, or at the top of the screen. In some environments, if both the application menu and the menubar are set, the application menu will be presented as if it were the first item of the menubar. -Other environments treat the two as completely separate — for example, +Other environments treat the two as completely separate — for example, the application menu may be rendered by the desktop shell while the menubar (if set) remains in each individual window. @@ -11322,28 +8024,17 @@ user selecting these menu items. - a #GtkApplication + a #GtkApplication - - a #GMenuModel, or %NULL + + a #GMenuModel, or %NULL - - Removes an inhibitor that has been established with gtk_application_inhibit(). + + Removes an inhibitor that has been established with gtk_application_inhibit(). Inhibitors are also cleared when the application exits. @@ -11351,15 +8042,11 @@ Inhibitors are also cleared when the application exits. - the #GtkApplication + the #GtkApplication - a cookie that was returned by gtk_application_inhibit() + a cookie that was returned by gtk_application_inhibit() @@ -11373,21 +8060,12 @@ Inhibitors are also cleared when the application exits. - - Set this property to %TRUE to register with the session manager. + + Set this property to %TRUE to register with the session manager. - - This property is %TRUE if GTK+ believes that the screensaver is + + This property is %TRUE if GTK+ believes that the screensaver is currently active. GTK+ only tracks session state (including this) when #GtkApplication::register-session is set to %TRUE. @@ -11401,9 +8079,7 @@ Tracking the screensaver state is supported on Linux. - Emitted when the session manager is about to end the session, only + Emitted when the session manager is about to end the session, only if #GtkApplication::register-session is %TRUE. Applications can connect to this signal and call gtk_application_inhibit() with %GTK_APPLICATION_INHIBIT_LOGOUT to delay the end of the session @@ -11413,26 +8089,20 @@ until state has been saved. - Emitted when a #GtkWindow is added to @application through + Emitted when a #GtkWindow is added to @application through gtk_application_add_window(). - the newly-added #GtkWindow + the newly-added #GtkWindow - Emitted when a #GtkWindow is removed from @application, + Emitted when a #GtkWindow is removed from @application, either as a side-effect of being destroyed or explicitly through gtk_application_remove_window(). @@ -11440,22 +8110,16 @@ through gtk_application_remove_window(). - the #GtkWindow that is being removed + the #GtkWindow that is being removed - + - The parent class. + The parent class. @@ -11496,65 +8160,29 @@ through gtk_application_remove_window(). - - Types of user actions that may be blocked by gtk_application_inhibit(). - - Inhibit ending the user session + + Types of user actions that may be blocked by gtk_application_inhibit(). + + Inhibit ending the user session by logging out or by shutting down the computer - - Inhibit user switching + + Inhibit user switching - - Inhibit suspending the + + Inhibit suspending the session or computer - - Inhibit the session being + + Inhibit the session being marked as idle (and possibly locked) - + - - #GtkApplicationWindow is a #GtkWindow subclass that offers some + + #GtkApplicationWindow is a #GtkWindow subclass that offers some extra functionality for better integration with #GtkApplication features. Notably, it can handle both the application menu as well as the menubar. See gtk_application_set_app_menu() and @@ -11563,8 +8191,8 @@ gtk_application_set_menubar(). This class implements the #GActionGroup and #GActionMap interfaces, to let you add window-specific actions that will be exported by the associated #GtkApplication, together with its application-wide -actions. Window-specific actions are prefixed with the “win.” -prefix and application-wide actions are prefixed with the “app.” +actions. Window-specific actions are prefixed with the “win.” +prefix and application-wide actions are prefixed with the “app.” prefix. Actions must be addressed with the prefixed name when referring to them from a #GMenuModel. @@ -11662,104 +8290,68 @@ The following attributes are used when constructing submenus: - - Creates a new #GtkApplicationWindow. + + Creates a new #GtkApplicationWindow. - a newly created #GtkApplicationWindow + a newly created #GtkApplicationWindow - a #GtkApplication + a #GtkApplication - - Gets the #GtkShortcutsWindow that has been set up with + + Gets the #GtkShortcutsWindow that has been set up with a prior call to gtk_application_window_set_help_overlay(). - the help overlay associated with @window, or %NULL + the help overlay associated with @window, or %NULL - a #GtkApplicationWindow + a #GtkApplicationWindow - - Returns the unique ID of the window. If the window has not yet been added to + + Returns the unique ID of the window. If the window has not yet been added to a #GtkApplication, returns `0`. - the unique ID for @window, or `0` if the window + the unique ID for @window, or `0` if the window has not yet been added to a #GtkApplication - a #GtkApplicationWindow + a #GtkApplicationWindow - - Returns whether the window will display a menubar for the app menu + + Returns whether the window will display a menubar for the app menu and menubar as needed. - %TRUE if @window will display a menubar when needed + %TRUE if @window will display a menubar when needed - a #GtkApplicationWindow + a #GtkApplicationWindow - - Associates a shortcuts window with the application window, and + + Associates a shortcuts window with the application window, and sets up an action with the name win.show-help-overlay to present it. @@ -11770,28 +8362,17 @@ it. - a #GtkApplicationWindow + a #GtkApplicationWindow - - a #GtkShortcutsWindow + + a #GtkShortcutsWindow - - Sets whether the window will display a menubar for the app menu + + Sets whether the window will display a menubar for the app menu and menubar as needed. @@ -11799,26 +8380,17 @@ and menubar as needed. - a #GtkApplicationWindow + a #GtkApplicationWindow - whether to show a menubar when needed + whether to show a menubar when needed - - If this property is %TRUE, the window will display a menubar + + If this property is %TRUE, the window will display a menubar that includes the app menu and menubar, unless these are shown by the desktop shell. See gtk_application_set_app_menu() and gtk_application_set_menubar(). @@ -11831,18 +8403,13 @@ of whether the desktop shell is showing the menus or not. - + - + - The parent class. + The parent class. @@ -11851,21 +8418,11 @@ of whether the desktop shell is showing the menus or not. - + - - GtkArrow should be used to draw simple arrows that need to point in + + GtkArrow should be used to draw simple arrows that need to point in one of the four cardinal directions (up, down, left, or right). The style of the arrow can be one of shadow in, shadow out, etched in, or etched out. Note that these directions and style types may be @@ -11879,52 +8436,36 @@ Arrows are created with a call to gtk_arrow_new(). The direction or style of an arrow can be changed after creation by using gtk_arrow_set(). GtkArrow has been deprecated; you can simply use a #GtkImage with a -suitable icon name, such as “pan-down-symbolic“. When replacing +suitable icon name, such as “pan-down-symbolic“. When replacing GtkArrow by an image, pay attention to the fact that GtkArrow is doing automatic flipping between #GTK_ARROW_LEFT and #GTK_ARROW_RIGHT, depending on the text direction. To get the same effect with an image, -use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which +use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which react to the text direction. - - Creates a new #GtkArrow widget. + + Creates a new #GtkArrow widget. Use a #GtkImage with a suitable icon. - the new #GtkArrow widget. + the new #GtkArrow widget. - a valid #GtkArrowType. + a valid #GtkArrowType. - a valid #GtkShadowType. + a valid #GtkShadowType. - - Sets the direction and style of the #GtkArrow, @arrow. + + Sets the direction and style of the #GtkArrow, @arrow. Use a #GtkImage with a suitable icon. @@ -11932,21 +8473,15 @@ react to the text direction. - a widget of type #GtkArrow. + a widget of type #GtkArrow. - a valid #GtkArrowType. + a valid #GtkArrowType. - a valid #GtkShadowType. + a valid #GtkShadowType. @@ -11964,13 +8499,7 @@ react to the text direction. - + @@ -11978,26 +8507,19 @@ react to the text direction. - + - + - + - + @@ -12035,102 +8557,47 @@ react to the text direction. - - Used to specify the placement of scroll arrows in scrolling menus. - - Place one arrow on each end of the menu. + + Used to specify the placement of scroll arrows in scrolling menus. + + Place one arrow on each end of the menu. - - Place both arrows at the top of the menu. + + Place both arrows at the top of the menu. - - Place both arrows at the bottom of the menu. + + Place both arrows at the bottom of the menu. - - Used to indicate the direction in which an arrow should point. + + Used to indicate the direction in which an arrow should point. - Represents an upward pointing arrow. + Represents an upward pointing arrow. - - Represents a downward pointing arrow. + + Represents a downward pointing arrow. - - Represents a left pointing arrow. + + Represents a left pointing arrow. - - Represents a right pointing arrow. + + Represents a right pointing arrow. - - No arrow. Since 2.10. + + No arrow. Since 2.10. - - The #GtkAspectFrame is useful when you want + + The #GtkAspectFrame is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. #GtkAspectFrame derives from #GtkFrame, so it can draw a label and a frame around the child. The frame will be -“shrink-wrapped” to the size of the child. +“shrink-wrapped” to the size of the child. # CSS nodes @@ -12139,98 +8606,69 @@ GtkAspectFrame uses a CSS node with name frame. - Create a new #GtkAspectFrame. + Create a new #GtkAspectFrame. - the new #GtkAspectFrame. + the new #GtkAspectFrame. - - Label text. + + Label text. - Horizontal alignment of the child within the allocation of + Horizontal alignment of the child within the allocation of the #GtkAspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned) - Vertical alignment of the child within the allocation of + Vertical alignment of the child within the allocation of the #GtkAspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned) - The desired aspect ratio. + The desired aspect ratio. - If %TRUE, @ratio is ignored, and the aspect + If %TRUE, @ratio is ignored, and the aspect ratio is taken from the requistion of the child. - Set parameters for an existing #GtkAspectFrame. + Set parameters for an existing #GtkAspectFrame. - a #GtkAspectFrame + a #GtkAspectFrame - Horizontal alignment of the child within the allocation of + Horizontal alignment of the child within the allocation of the #GtkAspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned) - Vertical alignment of the child within the allocation of + Vertical alignment of the child within the allocation of the #GtkAspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned) - The desired aspect ratio. + The desired aspect ratio. - If %TRUE, @ratio is ignored, and the aspect + If %TRUE, @ratio is ignored, and the aspect ratio is taken from the requistion of the child. @@ -12255,14 +8693,10 @@ GtkAspectFrame uses a CSS node with name frame. - + - The parent class. + The parent class. @@ -12298,21 +8732,11 @@ GtkAspectFrame uses a CSS node with name frame. - + - - A #GtkAssistant is a widget used to represent a generally complex + + A #GtkAssistant is a widget used to represent a generally complex operation splitted in several steps, guiding the user through its pages and controlling the page flow to collect the necessary data. @@ -12323,7 +8747,7 @@ in addition to state information like the page [completion][gtk-assistant-set-page-complete] and [committed][gtk-assistant-commit] status. -If you have a case that doesn’t quite fit in #GtkAssistants way of +If you have a case that doesn’t quite fit in #GtkAssistants way of handling buttons, you can use the #GTK_ASSISTANT_PAGE_CUSTOM page type and handle buttons yourself. @@ -12331,7 +8755,7 @@ type and handle buttons yourself. The GtkAssistant implementation of the #GtkBuildable interface exposes the @action_area as internal children with the name -“action_area”. +“action_area”. To add pages to an assistant in #GtkBuilder, simply add it as a child to the GtkAssistant object, and set its child properties @@ -12344,14 +8768,10 @@ GtkAssistant has a single CSS node with the name assistant. - Creates a new #GtkAssistant. + Creates a new #GtkAssistant. - a newly created #GtkAssistant + a newly created #GtkAssistant @@ -12402,63 +8822,43 @@ GtkAssistant has a single CSS node with the name assistant. - - Adds a widget to the action area of a #GtkAssistant. + + Adds a widget to the action area of a #GtkAssistant. - a #GtkAssistant + a #GtkAssistant - a #GtkWidget + a #GtkWidget - - Appends a page to the @assistant. + + Appends a page to the @assistant. - the index (starting at 0) of the inserted page + the index (starting at 0) of the inserted page - a #GtkAssistant + a #GtkAssistant - a #GtkWidget + a #GtkWidget - Erases the visited page history so the back button is not + Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages. @@ -12473,308 +8873,200 @@ clicked apply on a confirmation page. - a #GtkAssistant + a #GtkAssistant - - Returns the page number of the current page. + + Returns the page number of the current page. - The index (starting from 0) of the current + The index (starting from 0) of the current page in the @assistant, or -1 if the @assistant has no pages, or no current page. - a #GtkAssistant + a #GtkAssistant - - Returns the number of pages in the @assistant + + Returns the number of pages in the @assistant - the number of pages in the @assistant + the number of pages in the @assistant - a #GtkAssistant + a #GtkAssistant - - Returns the child widget contained in page number @page_num. + + Returns the child widget contained in page number @page_num. - the child widget, or %NULL + the child widget, or %NULL if @page_num is out of bounds - a #GtkAssistant + a #GtkAssistant - the index of a page in the @assistant, + the index of a page in the @assistant, or -1 to get the last page - - Gets whether @page is complete. + + Gets whether @page is complete. - %TRUE if @page is complete. + %TRUE if @page is complete. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - Gets whether page has padding. + + Gets whether page has padding. - %TRUE if @page has padding + %TRUE if @page has padding - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - Gets the header image for @page. + + Gets the header image for @page. Since GTK+ 3.2, a header is no longer shown; add your header decoration to the page content instead. - the header image for @page, - or %NULL if there’s no header image for the page + the header image for @page, + or %NULL if there’s no header image for the page - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - Gets the side image for @page. + + Gets the side image for @page. Since GTK+ 3.2, sidebar images are not shown anymore. - the side image for @page, - or %NULL if there’s no side image for the page + the side image for @page, + or %NULL if there’s no side image for the page - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - Gets the title for @page. + + Gets the title for @page. - the title for @page + the title for @page - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - Gets the page type of @page. + + Gets the page type of @page. - the page type of @page + the page type of @page - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - Inserts a page in the @assistant at a given position. + + Inserts a page in the @assistant at a given position. - the index (starting from 0) of the inserted page + the index (starting from 0) of the inserted page - a #GtkAssistant + a #GtkAssistant - a #GtkWidget + a #GtkWidget - the index (starting at 0) at which to insert the page, + the index (starting at 0) at which to insert the page, or -1 to append the page to the @assistant - - Navigate to the next page. + + Navigate to the next page. It is a programming error to call this function when there is no next page. @@ -12787,47 +9079,31 @@ This function is for use when creating pages of the - a #GtkAssistant + a #GtkAssistant - - Prepends a page to the @assistant. + + Prepends a page to the @assistant. - the index (starting at 0) of the inserted page + the index (starting at 0) of the inserted page - a #GtkAssistant + a #GtkAssistant - a #GtkWidget + a #GtkWidget - - Navigate to the previous visited page. + + Navigate to the previous visited page. It is a programming error to call this function when no previous page is available. @@ -12840,70 +9116,48 @@ This function is for use when creating pages of the - a #GtkAssistant + a #GtkAssistant - - Removes a widget from the action area of a #GtkAssistant. + + Removes a widget from the action area of a #GtkAssistant. - a #GtkAssistant + a #GtkAssistant - a #GtkWidget + a #GtkWidget - - Removes the @page_num’s page from @assistant. + + Removes the @page_num’s page from @assistant. - a #GtkAssistant + a #GtkAssistant - the index of a page in the @assistant, + the index of a page in the @assistant, or -1 to remove the last page - - Switches the page to @page_num. + + Switches the page to @page_num. Note that this will only be necessary in custom buttons, as the @assistant flow can be set with @@ -12914,15 +9168,11 @@ gtk_assistant_set_forward_page_func(). - a #GtkAssistant + a #GtkAssistant - index of the page to switch to, starting from 0. + index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the @assistant, nothing will be done. @@ -12930,12 +9180,8 @@ gtk_assistant_set_forward_page_func(). - - Sets the page forwarding function to be @page_func. + + Sets the page forwarding function to be @page_func. This function will be used to determine what will be the next page when the user presses the forward button. @@ -12948,47 +9194,26 @@ next visible page. - a #GtkAssistant + a #GtkAssistant - - the #GtkAssistantPageFunc, or %NULL + + the #GtkAssistantPageFunc, or %NULL to use the default one - - user data for @page_func + + user data for @page_func - destroy notifier for @data + destroy notifier for @data - - Sets whether @page contents are complete. + + Sets whether @page contents are complete. This will make @assistant update the buttons state to be able to continue the task. @@ -12998,31 +9223,21 @@ to be able to continue the task. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - the completeness status of the page + the completeness status of the page - - Sets whether the assistant is adding padding around + + Sets whether the assistant is adding padding around the page. @@ -13030,33 +9245,21 @@ the page. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - whether this page has padding + whether this page has padding - - Sets a header image for @page. + + Sets a header image for @page. Since GTK+ 3.2, a header is no longer shown; add your header decoration to the page content instead. @@ -13065,36 +9268,21 @@ the page. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - the new header image @page + + the new header image @page - - Sets a side image for @page. + + Sets a side image for @page. This image used to be displayed in the side area of the assistant when @page is the current page. @@ -13106,34 +9294,21 @@ when @page is the current page. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - - the new side image @page + + the new side image @page - - Sets a title for @page. + + Sets a title for @page. The title is displayed in the header area of the assistant when @page is the current page. @@ -13143,31 +9318,21 @@ when @page is the current page. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - the new title for @page + the new title for @page - - Sets the page type for @page. + + Sets the page type for @page. The page type determines the page behavior in the @assistant. @@ -13176,31 +9341,21 @@ The page type determines the page behavior in the @assistant. - a #GtkAssistant + a #GtkAssistant - a page of @assistant + a page of @assistant - the new type for @page + the new type for @page - - Forces @assistant to recompute the buttons state. + + Forces @assistant to recompute the buttons state. GTK+ automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the @@ -13215,21 +9370,13 @@ affects the future page flow of the assistant. - a #GtkAssistant + a #GtkAssistant - - %TRUE if the assistant uses a #GtkHeaderBar for action buttons + + %TRUE if the assistant uses a #GtkHeaderBar for action buttons instead of the action-area. For technical reasons, this property is declared as an integer @@ -13243,9 +9390,7 @@ property, but you should only set it to %TRUE or %FALSE. - The ::apply signal is emitted when the apply button is clicked. + The ::apply signal is emitted when the apply button is clicked. The default behavior of the #GtkAssistant is to switch to the page after the current page, unless the current page is the last one. @@ -13261,17 +9406,13 @@ page. - The ::cancel signal is emitted when then the cancel button is clicked. + The ::cancel signal is emitted when then the cancel button is clicked. - The ::close signal is emitted either when the close button of + The ::close signal is emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type %GTK_ASSISTANT_PAGE_CONFIRM) is clicked. @@ -13284,9 +9425,7 @@ page in the flow (of type %GTK_ASSISTANT_PAGE_CONFIRM) is clicked. - The ::prepare signal is emitted when a new page is set as the + The ::prepare signal is emitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparations which are @@ -13296,22 +9435,16 @@ necessary before showing @page. - the current page + the current page - + - The parent class. + The parent class. @@ -13411,107 +9544,60 @@ necessary before showing @page. - A function used by gtk_assistant_set_forward_page_func() to know which -is the next page given a current one. It’s called both for computing the -next page when the user presses the “forward” button and for handling -the behavior of the “last” button. + A function used by gtk_assistant_set_forward_page_func() to know which +is the next page given a current one. It’s called both for computing the +next page when the user presses the “forward” button and for handling +the behavior of the “last” button. - The next page number. + The next page number. - The page number used to calculate the next page. + The page number used to calculate the next page. - - user data. + + user data. - - An enum for determining the page role inside the #GtkAssistant. It's + + An enum for determining the page role inside the #GtkAssistant. It's used to handle buttons sensitivity and visibility. Note that an assistant needs to end its page flow with a page of type %GTK_ASSISTANT_PAGE_CONFIRM, %GTK_ASSISTANT_PAGE_SUMMARY or %GTK_ASSISTANT_PAGE_PROGRESS to be correct. -The Cancel button will only be shown if the page isn’t “committed”. +The Cancel button will only be shown if the page isn’t “committed”. See gtk_assistant_commit() for details. - - The page has regular contents. Both the + + The page has regular contents. Both the Back and forward buttons will be shown. - - The page contains an introduction to the + + The page contains an introduction to the assistant task. Only the Forward button will be shown if there is a next page. - - The page lets the user confirm or deny the + + The page lets the user confirm or deny the changes. The Back and Apply buttons will be shown. - - The page informs the user of the changes + + The page informs the user of the changes done. Only the Close button will be shown. - - Used for tasks that take a long time to + + Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete. Only the back button will be shown. - - Used for when other page types are not + + Used for when other page types are not appropriate. No buttons will be shown, and the application must add its own buttons through gtk_assistant_add_action_widget(). @@ -13519,35 +9605,18 @@ See gtk_assistant_commit() for details. - - Denotes the expansion properties that a widget will have when it (or its + + Denotes the expansion properties that a widget will have when it (or its parent) is resized. - - the widget should expand to take up any extra space in its + + the widget should expand to take up any extra space in its container that has been allocated. - - the widget should shrink as and when possible. + + the widget should shrink as and when possible. - the widget should fill the space allocated to it. + the widget should fill the space allocated to it. @@ -13557,58 +9626,43 @@ container that has been allocated. - - Like gtk_get_binary_age(), but from the headers used at + + Like gtk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. - + - + - - + + - - + + - - + + @@ -13621,96 +9675,72 @@ against at application run time. - + - + - + - + - + - + - + - + - - This macro should be used to emit a warning about and unexpected @type value + + This macro should be used to emit a warning about and unexpected @type value in a #GtkBuildable add_child implementation. - the #GtkBuildable on which the warning ocurred + the #GtkBuildable on which the warning ocurred - the unexpected type value + the unexpected type value @@ -13721,127 +9751,81 @@ in a #GtkBuildable add_child implementation. - + - + - + - + - + - + - + - + - - Whenever a container has some form of natural row it may align + + Whenever a container has some form of natural row it may align children in that row along a common typographical baseline. If the amount of verical space in the row is taller than the total requested height of the baseline-aligned children then it can use a #GtkBaselinePosition to select where to put the baseline inside the extra availible space. - - Align the baseline at the top + + Align the baseline at the top - - Center the baseline + + Center the baseline - - Align the baseline at the bottom + + Align the baseline at the bottom - - The #GtkBin widget is a container with just one child. + + The #GtkBin widget is a container with just one child. It is not very useful itself, but it is useful for deriving subclasses, since it provides common code needed for handling a single child widget. @@ -13851,24 +9835,18 @@ Many GTK+ widgets are subclasses of #GtkBin, including #GtkWindow, - Gets the child of the #GtkBin, or %NULL if the bin contains + Gets the child of the #GtkBin, or %NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it. - the child of @bin, or %NULL if it does + the child of @bin, or %NULL if it does not have a child. - a #GtkBin + a #GtkBin @@ -13880,14 +9858,10 @@ not have a child. - + - The parent class. + The parent class. @@ -13927,16 +9901,12 @@ not have a child. - A #GtkBindingArg holds the data associated with + A #GtkBindingArg holds the data associated with an argument for a key binding signal emission as stored in #GtkBindingSignal. - implementation detail + implementation detail @@ -13953,71 +9923,47 @@ stored in #GtkBindingSignal. - Each key binding element of a binding sets binding list is + Each key binding element of a binding sets binding list is represented by a GtkBindingEntry. - key value to match + key value to match - key modifiers to match + key modifiers to match - binding set this entry belongs to + binding set this entry belongs to - implementation detail + implementation detail - implementation detail + implementation detail - implementation detail + implementation detail - linked list of entries maintained by binding set + linked list of entries maintained by binding set - implementation detail + implementation detail - action signals of this entry + action signals of this entry - - Override or install a new key binding for @keyval with @modifiers on + + Override or install a new key binding for @keyval with @modifiers on @binding_set. When the binding is activated, @signal_name will be emitted on the target widget, with @n_args @Varargs used as arguments. @@ -14046,49 +9992,33 @@ gtk_binding_entry_add_signal (binding_set, - a #GtkBindingSet to install an entry for + a #GtkBindingSet to install an entry for - key value of binding to install + key value of binding to install - key modifier of binding to install + key modifier of binding to install - signal to execute upon activation + signal to execute upon activation - number of arguments to @signal_name + number of arguments to @signal_name - arguments to @signal_name + arguments to @signal_name - - Parses a signal description from @signal_desc and incorporates + + Parses a signal description from @signal_desc and incorporates it into @binding_set. Signal descriptions may either bind a key combination to @@ -14109,32 +10039,23 @@ Key combinations must be in a format that can be parsed by gtk_accelerator_parse(). - %G_TOKEN_NONE if the signal was successfully parsed and added, + %G_TOKEN_NONE if the signal was successfully parsed and added, the expected token otherwise - a #GtkBindingSet + a #GtkBindingSet - a signal description + a signal description - - Override or install a new key binding for @keyval with @modifiers on + + Override or install a new key binding for @keyval with @modifiers on @binding_set. @@ -14142,33 +10063,23 @@ gtk_accelerator_parse(). - a #GtkBindingSet to add a signal to + a #GtkBindingSet to add a signal to - key value + key value - key modifier + key modifier - signal name to be bound + signal name to be bound - + list of #GtkBindingArg signal arguments @@ -14177,9 +10088,7 @@ gtk_accelerator_parse(). - Remove a binding previously installed via + Remove a binding previously installed via gtk_binding_entry_add_signal() on @binding_set. @@ -14187,31 +10096,21 @@ gtk_binding_entry_add_signal() on @binding_set. - a #GtkBindingSet to remove an entry of + a #GtkBindingSet to remove an entry of - key value of binding to remove + key value of binding to remove - key modifier of binding to remove + key modifier of binding to remove - - Install a binding on @binding_set which causes key lookups + + Install a binding on @binding_set which causes key lookups to be aborted, to prevent bindings from lower priority sets to be activated. @@ -14220,30 +10119,22 @@ to be activated. - a #GtkBindingSet to skip an entry of + a #GtkBindingSet to skip an entry of - key value of binding to skip + key value of binding to skip - key modifier of binding to skip + key modifier of binding to skip - A binding set maintains a list of activatable key bindings. + A binding set maintains a list of activatable key bindings. A single binding set can match multiple types of widgets. Similar to style contexts, can be matched by any information contained in a widgets #GtkWidgetPath. When a binding within a set is matched upon @@ -14251,105 +10142,72 @@ activation, an action signal is emitted on the target widget to carry out the actual activation. - unique name of this binding set + unique name of this binding set - unused + unused - unused + unused - unused + unused - unused + unused - the key binding entries in this binding set + the key binding entries in this binding set - implementation detail + implementation detail - whether this binding set stems from a CSS file and is reset upon theme changes + whether this binding set stems from a CSS file and is reset upon theme changes - Find a key binding matching @keyval and @modifiers within + Find a key binding matching @keyval and @modifiers within @binding_set and activate the binding on @object. - %TRUE if a binding was found and activated + %TRUE if a binding was found and activated - a #GtkBindingSet set to activate + a #GtkBindingSet set to activate - key value of the binding + key value of the binding - key modifier of the binding + key modifier of the binding - object to activate when binding found + object to activate when binding found - - This function was used internally by the GtkRC parsing mechanism + + This function was used internally by the GtkRC parsing mechanism to assign match patterns to #GtkBindingSet structures. In GTK+ 3, these match patterns are unused. @@ -14359,360 +10217,210 @@ In GTK+ 3, these match patterns are unused. - a #GtkBindingSet to add a path to + a #GtkBindingSet to add a path to - path type the pattern applies to + path type the pattern applies to - the actual match pattern + the actual match pattern - binding priority + binding priority - - This function returns the binding set named after the type name of + + This function returns the binding set named after the type name of the passed in class structure. New binding sets are created on demand by this function. - the binding set corresponding to + the binding set corresponding to @object_class - - a valid #GObject class + + a valid #GObject class - Find a binding set by its globally unique name. + Find a binding set by its globally unique name. The @set_name can either be a name used for gtk_binding_set_new() or the type name of a class used in gtk_binding_set_by_class(). - %NULL or the specified binding set + %NULL or the specified binding set - unique binding set name + unique binding set name - - GTK+ maintains a global list of binding sets. Each binding set has + + GTK+ maintains a global list of binding sets. Each binding set has a unique name which needs to be specified upon creation. - new binding set + new binding set - unique name of this binding set + unique name of this binding set - A GtkBindingSignal stores the necessary information to + A GtkBindingSignal stores the necessary information to activate a widget in response to a key press via a signal emission. - implementation detail + implementation detail - the action signal to be emitted + the action signal to be emitted - number of arguments specified for the signal + number of arguments specified for the signal - the arguments specified for the signal + the arguments specified for the signal - - + + - + - + - - + + - + - - + + - - A struct that specifies a border around a rectangular area + + A struct that specifies a border around a rectangular area that can be of different width on each side. - The width of the left border + The width of the left border - The width of the right border + The width of the right border - The width of the top border + The width of the top border - The width of the bottom border + The width of the bottom border - Allocates a new #GtkBorder-struct and initializes its elements to zero. + Allocates a new #GtkBorder-struct and initializes its elements to zero. - a newly allocated #GtkBorder-struct. + a newly allocated #GtkBorder-struct. Free with gtk_border_free() - Copies a #GtkBorder-struct. + Copies a #GtkBorder-struct. - a copy of @border_. + a copy of @border_. - a #GtkBorder-struct + a #GtkBorder-struct - Frees a #GtkBorder-struct. + Frees a #GtkBorder-struct. - a #GtkBorder-struct + a #GtkBorder-struct - - Describes how the border of a UI element should be rendered. - - No visible border + + Describes how the border of a UI element should be rendered. + + No visible border - - A single line segment + + A single line segment - - Looks as if the content is sunken into the canvas + + Looks as if the content is sunken into the canvas - - Looks as if the content is coming out of the canvas + + Looks as if the content is coming out of the canvas - - Same as @GTK_BORDER_STYLE_NONE + + Same as @GTK_BORDER_STYLE_NONE - - A series of round dots + + A series of round dots - - A series of square-ended dashes + + A series of square-ended dashes - - Two parallel lines with some space between them + + Two parallel lines with some space between them - - Looks as if it were carved in the canvas + + Looks as if it were carved in the canvas - - Looks as if it were coming out of the canvas + + Looks as if it were coming out of the canvas - - The GtkBox widget arranges child widgets into a single row or column, + + The GtkBox widget arranges child widgets into a single row or column, depending upon the value of its #GtkOrientable:orientation property. Within the other dimension, all children are allocated the same size. Of course, the #GtkWidget:halign and #GtkWidget:valign properties can be used on @@ -14764,121 +10472,83 @@ regardless of text direction. - Creates a new #GtkBox. + Creates a new #GtkBox. - a new #GtkBox. + a new #GtkBox. - the box’s orientation. + the box’s orientation. - the number of pixels to place by default between children. + the number of pixels to place by default between children. - - Gets the value set by gtk_box_set_baseline_position(). + + Gets the value set by gtk_box_set_baseline_position(). - the baseline position + the baseline position - a #GtkBox + a #GtkBox - - Retrieves the center widget of the box. + + Retrieves the center widget of the box. - the center widget + the center widget or %NULL in case no center widget is set. - a #GtkBox + a #GtkBox - Returns whether the box is homogeneous (all children are the + Returns whether the box is homogeneous (all children are the same size). See gtk_box_set_homogeneous(). - %TRUE if the box is homogeneous. + %TRUE if the box is homogeneous. - a #GtkBox + a #GtkBox - Gets the value set by gtk_box_set_spacing(). + Gets the value set by gtk_box_set_spacing(). - spacing between children + spacing between children - a #GtkBox + a #GtkBox - Adds @child to @box, packed with reference to the end of @box. + Adds @child to @box, packed with reference to the end of @box. The @child is packed after (away from end of) any other child packed with reference to the end of @box. @@ -14887,29 +10557,21 @@ packed with reference to the end of @box. - a #GtkBox + a #GtkBox - the #GtkWidget to be added to @box + the #GtkWidget to be added to @box - %TRUE if the new child is to be given extra space allocated + %TRUE if the new child is to be given extra space allocated to @box. The extra space will be divided evenly between all children of @box that use this option - %TRUE if space given to @child by the @expand option is + %TRUE if space given to @child by the @expand option is actually allocated to @child, rather than just padding it. This parameter has no effect if @expand is set to %FALSE. A child is always allocated the full height of a horizontal #GtkBox and the full width @@ -14917,9 +10579,7 @@ packed with reference to the end of @box. - extra space in pixels to put between this child and its + extra space in pixels to put between this child and its neighbors, over and above the global amount specified by #GtkBox:spacing property. If @child is a widget at one of the reference ends of @box, then @padding pixels are also put between @@ -14929,9 +10589,7 @@ packed with reference to the end of @box. - Adds @child to @box, packed with reference to the start of @box. + Adds @child to @box, packed with reference to the start of @box. The @child is packed after any other child packed with reference to the start of @box. @@ -14940,29 +10598,21 @@ to the start of @box. - a #GtkBox + a #GtkBox - the #GtkWidget to be added to @box + the #GtkWidget to be added to @box - %TRUE if the new child is to be given extra space allocated + %TRUE if the new child is to be given extra space allocated to @box. The extra space will be divided evenly between all children that use this option - %TRUE if space given to @child by the @expand option is + %TRUE if space given to @child by the @expand option is actually allocated to @child, rather than just padding it. This parameter has no effect if @expand is set to %FALSE. A child is always allocated the full height of a horizontal #GtkBox and the full width @@ -14970,9 +10620,7 @@ to the start of @box. - extra space in pixels to put between this child and its + extra space in pixels to put between this child and its neighbors, over and above the global amount specified by #GtkBox:spacing property. If @child is a widget at one of the reference ends of @box, then @padding pixels are also put between @@ -14981,79 +10629,50 @@ to the start of @box. - - Obtains information about how @child is packed into @box. + + Obtains information about how @child is packed into @box. - a #GtkBox + a #GtkBox - the #GtkWidget of the child to query + the #GtkWidget of the child to query - - pointer to return location for expand child + + pointer to return location for expand child property - - pointer to return location for fill child + + pointer to return location for fill child property - - pointer to return location for padding + + pointer to return location for padding child property - - pointer to return location for pack-type + + pointer to return location for pack-type child property - Moves @child to a new @position in the list of @box children. + Moves @child to a new @position in the list of @box children. The list contains widgets packed #GTK_PACK_START as well as widgets packed #GTK_PACK_END, in the order that these widgets were added to @box. -A widget’s position in the @box children list determines where +A widget’s position in the @box children list determines where the widget is packed into @box. A child widget at some position in the list will be packed just after all other widgets of the same packing type that appear earlier in the list. @@ -15063,33 +10682,23 @@ same packing type that appear earlier in the list. - a #GtkBox + a #GtkBox - the #GtkWidget to move + the #GtkWidget to move - the new position for @child in the list of children + the new position for @child in the list of children of @box, starting from 0. If negative, indicates the end of the list - - Sets the baseline position of a box. This affects + + Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then @@ -15101,25 +10710,17 @@ extra space available. - a #GtkBox + a #GtkBox - a #GtkBaselinePosition + a #GtkBaselinePosition - - Sets a center widget; that is a child widget that will be + + Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space. @@ -15129,74 +10730,50 @@ of space. - a #GtkBox + a #GtkBox - - the widget to center + + the widget to center - - Sets the way @child is packed into @box. + + Sets the way @child is packed into @box. - a #GtkBox + a #GtkBox - the #GtkWidget of the child to set + the #GtkWidget of the child to set - the new value of the expand child property + the new value of the expand child property - the new value of the fill child property + the new value of the fill child property - the new value of the padding child property + the new value of the padding child property - the new value of the pack-type child property + the new value of the pack-type child property - Sets the #GtkBox:homogeneous property of @box, controlling + Sets the #GtkBox:homogeneous property of @box, controlling whether or not all children of @box are given equal space in the box. @@ -15205,24 +10782,18 @@ in the box. - a #GtkBox + a #GtkBox - a boolean value, %TRUE to create equal allotments, + a boolean value, %TRUE to create equal allotments, %FALSE for variable allotments - Sets the #GtkBox:spacing property of @box, which is the + Sets the #GtkBox:spacing property of @box, which is the number of pixels to place between children of @box. @@ -15230,22 +10801,16 @@ number of pixels to place between children of @box. - a #GtkBox + a #GtkBox - the number of pixels to put between children + the number of pixels to put between children - + @@ -15261,14 +10826,10 @@ number of pixels to place between children of @box. - + - The parent class. + The parent class. @@ -15307,15 +10868,8 @@ number of pixels to place between children of @box. - - GtkBuildable allows objects to extend and customize their deserialization + + GtkBuildable allows objects to extend and customize their deserialization from [GtkBuilder UI descriptions][BUILDER-UI]. The interface includes methods for setting names and properties of objects, parsing custom tags and constructing child objects. @@ -15329,9 +10883,7 @@ An object only needs to implement this interface if it needs to extend the #GtkBuilder format or run any extra routines at deserialization time. - Adds a child to @buildable. @type is an optional string + Adds a child to @buildable. @type is an optional string describing how the child should be added. @@ -15339,77 +10891,50 @@ describing how the child should be added. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - child to add + child to add - - kind of child or %NULL + + kind of child or %NULL - - Constructs a child of @buildable with the name @name. + + Constructs a child of @buildable with the name @name. -#GtkBuilder calls this function if a “constructor” has been +#GtkBuilder calls this function if a “constructor” has been specified in the UI definition. - the constructed child + the constructed child - A #GtkBuildable + A #GtkBuildable - #GtkBuilder used to construct this object + #GtkBuilder used to construct this object - name of child to construct + name of child to construct - - This is similar to gtk_buildable_parser_finished() but is + + This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the @buildable. @@ -15417,49 +10942,29 @@ called once for each custom tag handled by the @buildable. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - the name of the tag + the name of the tag - - user data created in custom_tag_start + + user data created in custom_tag_start - - This is called at the end of each custom element handled by + + This is called at the end of each custom element handled by the buildable. @@ -15467,171 +10972,105 @@ the buildable. - A #GtkBuildable + A #GtkBuildable - #GtkBuilder used to construct this object + #GtkBuilder used to construct this object - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - name of tag + name of tag - - user data that will be passed in to parser functions + + user data that will be passed in to parser functions - - This is called for each unknown element under <child>. + + This is called for each unknown element under <child>. - %TRUE if a object has a custom implementation, %FALSE + %TRUE if a object has a custom implementation, %FALSE if it doesn't. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder used to construct this object + a #GtkBuilder used to construct this object - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - name of tag + name of tag - - a #GMarkupParser to fill in + + a #GMarkupParser to fill in - - return location for user data that will be passed in + + return location for user data that will be passed in to parser functions - - Get the internal child called @childname of the @buildable object. + + Get the internal child called @childname of the @buildable object. - the internal child of the buildable object + the internal child of the buildable object - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - name of child + name of child - Gets the name of the @buildable object. + Gets the name of the @buildable object. #GtkBuilder sets the name based on the [GtkBuilder UI definition][BUILDER-UI] used to construct the @buildable. - the name set with gtk_buildable_set_name() + the name set with gtk_buildable_set_name() - a #GtkBuildable + a #GtkBuildable - - Called when the builder finishes the parsing of a + + Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() @@ -15642,85 +11081,59 @@ is called on a builder. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - - Sets the property name @name to @value on the @buildable object. + + Sets the property name @name to @value on the @buildable object. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - name of property + name of property - value of property + value of property - Sets the name of the @buildable object. + Sets the name of the @buildable object. - a #GtkBuildable + a #GtkBuildable - name to set + name to set - - Adds a child to @buildable. @type is an optional string + + Adds a child to @buildable. @type is an optional string describing how the child should be added. @@ -15728,77 +11141,50 @@ describing how the child should be added. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - child to add + child to add - - kind of child or %NULL + + kind of child or %NULL - - Constructs a child of @buildable with the name @name. + + Constructs a child of @buildable with the name @name. -#GtkBuilder calls this function if a “constructor” has been +#GtkBuilder calls this function if a “constructor” has been specified in the UI definition. - the constructed child + the constructed child - A #GtkBuildable + A #GtkBuildable - #GtkBuilder used to construct this object + #GtkBuilder used to construct this object - name of child to construct + name of child to construct - - This is similar to gtk_buildable_parser_finished() but is + + This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the @buildable. @@ -15806,49 +11192,29 @@ called once for each custom tag handled by the @buildable. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - the name of the tag + the name of the tag - - user data created in custom_tag_start + + user data created in custom_tag_start - - This is called at the end of each custom element handled by + + This is called at the end of each custom element handled by the buildable. @@ -15856,173 +11222,105 @@ the buildable. - A #GtkBuildable + A #GtkBuildable - #GtkBuilder used to construct this object + #GtkBuilder used to construct this object - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - name of tag + name of tag - - user data that will be passed in to parser functions + + user data that will be passed in to parser functions - - This is called for each unknown element under <child>. + + This is called for each unknown element under <child>. - %TRUE if a object has a custom implementation, %FALSE + %TRUE if a object has a custom implementation, %FALSE if it doesn't. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder used to construct this object + a #GtkBuilder used to construct this object - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - name of tag + name of tag - - a #GMarkupParser to fill in + + a #GMarkupParser to fill in - - return location for user data that will be passed in + + return location for user data that will be passed in to parser functions - - Get the internal child called @childname of the @buildable object. + + Get the internal child called @childname of the @buildable object. - the internal child of the buildable object + the internal child of the buildable object - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - name of child + name of child - - Gets the name of the @buildable object. + + Gets the name of the @buildable object. #GtkBuilder sets the name based on the [GtkBuilder UI definition][BUILDER-UI] used to construct the @buildable. - the name set with gtk_buildable_set_name() + the name set with gtk_buildable_set_name() - a #GtkBuildable + a #GtkBuildable - - Called when the builder finishes the parsing of a + + Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() @@ -16033,95 +11331,65 @@ is called on a builder. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - - Sets the property name @name to @value on the @buildable object. + + Sets the property name @name to @value on the @buildable object. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - name of property + name of property - value of property + value of property - - Sets the name of the @buildable object. + + Sets the name of the @buildable object. - a #GtkBuildable + a #GtkBuildable - name to set + name to set - - The #GtkBuildableIface interface contains method that are + + The #GtkBuildableIface interface contains method that are necessary to allow #GtkBuilder to construct an object from a #GtkBuilder UI definition. - the parent class + the parent class @@ -16132,15 +11400,11 @@ a #GtkBuilder UI definition. - a #GtkBuildable + a #GtkBuildable - name to set + name to set @@ -16150,16 +11414,12 @@ a #GtkBuilder UI definition. - the name set with gtk_buildable_set_name() + the name set with gtk_buildable_set_name() - a #GtkBuildable + a #GtkBuildable @@ -16173,30 +11433,19 @@ a #GtkBuilder UI definition. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - child to add + child to add - - kind of child or %NULL + + kind of child or %NULL @@ -16210,27 +11459,19 @@ a #GtkBuilder UI definition. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - name of property + name of property - value of property + value of property @@ -16240,28 +11481,20 @@ a #GtkBuilder UI definition. - the constructed child + the constructed child - A #GtkBuildable + A #GtkBuildable - #GtkBuilder used to construct this object + #GtkBuilder used to construct this object - name of child to construct + name of child to construct @@ -16271,57 +11504,33 @@ a #GtkBuilder UI definition. - %TRUE if a object has a custom implementation, %FALSE + %TRUE if a object has a custom implementation, %FALSE if it doesn't. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder used to construct this object + a #GtkBuilder used to construct this object - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - name of tag + name of tag - - a #GMarkupParser to fill in + + a #GMarkupParser to fill in - - return location for user data that will be passed in + + return location for user data that will be passed in to parser functions @@ -16336,39 +11545,23 @@ a #GtkBuilder UI definition. - A #GtkBuildable + A #GtkBuildable - #GtkBuilder used to construct this object + #GtkBuilder used to construct this object - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - name of tag + name of tag - - user data that will be passed in to parser functions + + user data that will be passed in to parser functions @@ -16382,39 +11575,23 @@ a #GtkBuilder UI definition. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - - child object or %NULL for non-child tags + + child object or %NULL for non-child tags - the name of the tag + the name of the tag - - user data created in custom_tag_start + + user data created in custom_tag_start @@ -16428,15 +11605,11 @@ a #GtkBuilder UI definition. - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder @@ -16446,44 +11619,28 @@ a #GtkBuilder UI definition. - the internal child of the buildable object + the internal child of the buildable object - a #GtkBuildable + a #GtkBuildable - a #GtkBuilder + a #GtkBuilder - name of child + name of child - - A GtkBuilder is an auxiliary object that reads textual descriptions + + A GtkBuilder is an auxiliary object that reads textual descriptions of a user interface and instantiates the described objects. To create a GtkBuilder from a user interface description, call gtk_builder_new_from_file(), gtk_builder_new_from_resource() or @@ -16520,8 +11677,8 @@ used to connect handlers to the named signals in the description. GtkBuilder parses textual descriptions of user interfaces which are specified in an XML format which can be roughly described by the -RELAX NG schema below. We refer to these descriptions as “GtkBuilder -UI definitions” or just “UI definitions” if the context is clear. +RELAX NG schema below. We refer to these descriptions as “GtkBuilder +UI definitions” or just “UI definitions” if the context is clear. Do not confuse GtkBuilder UI Definitions with [GtkUIManager UI Definitions][XML-UI], which are more limited in scope. It is common to use `.ui` as the filename extension for files containing @@ -16529,7 +11686,7 @@ GtkBuilder UI definitions. [RELAX NG Compact Syntax](https://gitlab.gnome.org/GNOME/gtk/-/blob/gtk-3-24/gtk/gtkbuilder.rnc) -The toplevel element is <interface>. It optionally takes a “domain” +The toplevel element is <interface>. It optionally takes a “domain” attribute, which will make the builder look for translated strings using dgettext() in the domain specified. This can also be done by calling gtk_builder_set_translation_domain() on the builder. @@ -16540,32 +11697,32 @@ child objects (most often widgets inside a container, but also e.g. actions in an action group, or columns in a tree model). A <child> element contains an <object> element which describes the child object. The target toolkit version(s) are described by <requires> elements, -the “lib” attribute specifies the widget library in question (currently -the only supported value is “gtk+”) and the “version” attribute specifies -the target version in the form “<major>.<minor>”. The builder will error +the “lib” attribute specifies the widget library in question (currently +the only supported value is “gtk+”) and the “version” attribute specifies +the target version in the form “<major>.<minor>”. The builder will error out if the version requirements are not met. Typically, the specific kind of object represented by an <object> -element is specified by the “class” attribute. If the type has not +element is specified by the “class” attribute. If the type has not been loaded yet, GTK+ tries to find the get_type() function from the class name by applying heuristics. This works in most cases, but if necessary, it is possible to specify the name of the get_type() function explictly with the "type-func" attribute. As a special case, GtkBuilder allows to use an object that has been constructed by a #GtkUIManager in another part of the UI definition by specifying the id of the #GtkUIManager -in the “constructor” attribute and the name of the object in the “id” +in the “constructor” attribute and the name of the object in the “id” attribute. -Objects may be given a name with the “id” attribute, which allows the +Objects may be given a name with the “id” attribute, which allows the application to retrieve them from the builder with gtk_builder_get_object(). An id is also necessary to use the object as property value in other parts of the UI definition. GTK+ reserves ids starting and ending with ___ (3 underscores) for its own purposes. Setting properties of objects is pretty straightforward with the -<property> element: the “name” attribute specifies the name of the +<property> element: the “name” attribute specifies the name of the property, and the content of the element specifies the value. -If the “translatable” attribute is set to a true value, GTK+ uses +If the “translatable” attribute is set to a true value, GTK+ uses gettext() (or dgettext() if the builder has a translation domain set) to find a translation for the value. This happens before the value is parsed, so it can be used for properties of any type, but it is @@ -16575,11 +11732,11 @@ may help the translators. GtkBuilder can parse textual representations for the most common property types: characters, strings, integers, floating-point numbers, -booleans (strings like “TRUE”, “t”, “yes”, “y”, “1” are interpreted -as %TRUE, strings like “FALSE”, “f”, “no”, “n”, “0” are interpreted +booleans (strings like “TRUE”, “t”, “yes”, “y”, “1” are interpreted +as %TRUE, strings like “FALSE”, “f”, “no”, “n”, “0” are interpreted as %FALSE), enumerations (can be specified by their name, nick or integer value), flags (can be specified by their name, nick, integer -value, optionally combined with “|”, e.g. “GTK_VISIBLE|GTK_REALIZED”) +value, optionally combined with “|”, e.g. “GTK_VISIBLE|GTK_REALIZED”) and colors (in a format understood by gdk_rgba_parse()). GVariants can be specified in the format understood by g_variant_parse(), @@ -16588,7 +11745,7 @@ and pixbufs can be specified as a filename of an image file to load. Objects can be referred to by their name and by default refer to objects declared in the local xml fragment and objects exposed via gtk_builder_expose_object(). In general, GtkBuilder allows forward -references to objects — declared in the local xml; an object doesn’t +references to objects — declared in the local xml; an object doesn’t have to be constructed before it can be referred to. The exception to this rule is that an object has to be constructed before it can be used as the value of a construct-only property. @@ -16601,30 +11758,30 @@ property value using the attributes Internally builder implements this using GBinding objects. For more information see g_object_bind_property() -Signal handlers are set up with the <signal> element. The “name” -attribute specifies the name of the signal, and the “handler” attribute +Signal handlers are set up with the <signal> element. The “name” +attribute specifies the name of the signal, and the “handler” attribute specifies the function to connect to the signal. By default, GTK+ tries to find the handler using g_module_symbol(), but this can be changed by passing a custom #GtkBuilderConnectFunc to -gtk_builder_connect_signals_full(). The remaining attributes, “after”, -“swapped” and “object”, have the same meaning as the corresponding +gtk_builder_connect_signals_full(). The remaining attributes, “after”, +“swapped” and “object”, have the same meaning as the corresponding parameters of the g_signal_connect_object() or -g_signal_connect_data() functions. A “last_modification_time” +g_signal_connect_data() functions. A “last_modification_time” attribute is also allowed, but it does not have a meaning to the builder. Sometimes it is necessary to refer to widgets which have implicitly been constructed by GTK+ as part of a composite widget, to set properties on them or to add further children (e.g. the @vbox of -a #GtkDialog). This can be achieved by setting the “internal-child” +a #GtkDialog). This can be achieved by setting the “internal-child” property of the <child> element to a true value. Note that GtkBuilder still requires an <object> element for the internal child, even if it has already been constructed. A number of widgets have different places where a child can be added (e.g. tabs vs. page content in notebooks). This can be reflected in -a UI definition by specifying the “type” attribute on a <child> -The possible values for the “type” attribute are described in the +a UI definition by specifying the “type” attribute on a <child> +The possible values for the “type” attribute are described in the sections describing the widget-specific portions of UI definitions. # A GtkBuilder UI Definition @@ -16663,13 +11820,11 @@ These XML fragments are explained in the documentation of the respective objects. Additionally, since 3.10 a special <template> tag has been added -to the format allowing one to define a widget class’s components. +to the format allowing one to define a widget class’s components. See the [GtkWidget documentation][composite-templates] for details. - Creates a new empty builder object. + Creates a new empty builder object. This function is only useful if you intend to make multiple calls to gtk_builder_add_from_file(), gtk_builder_add_from_resource() @@ -16680,18 +11835,12 @@ Most users will probably want to use gtk_builder_new_from_file(), gtk_builder_new_from_resource() or gtk_builder_new_from_string(). - a new (empty) #GtkBuilder object + a new (empty) #GtkBuilder object - - Builds the [GtkBuilder UI definition][BUILDER-UI] + + Builds the [GtkBuilder UI definition][BUILDER-UI] in the file @filename. If there is an error opening the file or parsing the description then @@ -16699,52 +11848,36 @@ the program will be aborted. You should only ever attempt to parse user interface descriptions that are shipped as part of your program. - a #GtkBuilder containing the described interface + a #GtkBuilder containing the described interface - filename of user interface description file + filename of user interface description file - - Builds the [GtkBuilder UI definition][BUILDER-UI] + + Builds the [GtkBuilder UI definition][BUILDER-UI] at @resource_path. If there is an error locating the resource or parsing the description, then the program will be aborted. - a #GtkBuilder containing the described interface + a #GtkBuilder containing the described interface - a #GResource resource path + a #GResource resource path - - Builds the user interface described by @string (in the + + Builds the user interface described by @string (in the [GtkBuilder UI definition][BUILDER-UI] format). If @string is %NULL-terminated, then @length should be -1. @@ -16755,63 +11888,43 @@ aborted. You should not attempt to parse user interface description from untrusted sources. - a #GtkBuilder containing the interface described by @string + a #GtkBuilder containing the interface described by @string - a user interface (XML) description + a user interface (XML) description - the length of @string, or -1 + the length of @string, or -1 - - Looks up a type by name, using the virtual function that + + Looks up a type by name, using the virtual function that #GtkBuilder has for that purpose. This is mainly used when implementing the #GtkBuildable interface on a type. - the #GType found for @type_name or #G_TYPE_INVALID + the #GType found for @type_name or #G_TYPE_INVALID if no type was found - a #GtkBuilder + a #GtkBuilder - type name to lookup + type name to lookup - - Adds the @callback_symbol to the scope of @builder under the given @callback_name. + + Adds the @callback_symbol to the scope of @builder under the given @callback_name. Using this function overrides the behavior of gtk_builder_connect_signals() for any callback symbols that are added. Using this method allows for better @@ -16823,34 +11936,21 @@ the global namespace. - a #GtkBuilder + a #GtkBuilder - The name of the callback, as expected in the XML + The name of the callback, as expected in the XML - - The callback pointer + + The callback pointer - - A convenience function to add many callbacks instead of calling + + A convenience function to add many callbacks instead of calling gtk_builder_add_callback_symbol() for each symbol. @@ -16858,40 +11958,25 @@ gtk_builder_add_callback_symbol() for each symbol. - a #GtkBuilder + a #GtkBuilder - The name of the callback, as expected in the XML + The name of the callback, as expected in the XML - - The callback pointer + + The callback pointer - A list of callback name and callback symbol pairs terminated with %NULL + A list of callback name and callback symbol pairs terminated with %NULL - - Parses a file containing a [GtkBuilder UI definition][BUILDER-UI] + + Parses a file containing a [GtkBuilder UI definition][BUILDER-UI] and merges it with the current contents of @builder. Most users will probably want to use gtk_builder_new_from_file(). @@ -16900,41 +11985,30 @@ If an error occurs, 0 will be returned and @error will be assigned a #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR domain. -It’s not really reasonable to attempt to handle failures of this +It’s not really reasonable to attempt to handle failures of this call. You should not use this function with untrusted files (ie: files that are not part of your application). Broken #GtkBuilder -files can easily crash your program, and it’s possible that memory +files can easily crash your program, and it’s possible that memory was leaked leading up to the reported failure. The only reasonable thing to do when an error is detected is to call g_error(). - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the name of the file to parse + the name of the file to parse - - Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI] + + Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI] and merges it with the current contents of @builder. Most users will probably want to use gtk_builder_new_from_resource(). @@ -16943,38 +12017,27 @@ If an error occurs, 0 will be returned and @error will be assigned a #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR domain. -It’s not really reasonable to attempt to handle failures of this +It’s not really reasonable to attempt to handle failures of this call. The only reasonable thing to do when an error is detected is to call g_error(). - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the path of the resource file to parse + the path of the resource file to parse - - Parses a string containing a [GtkBuilder UI definition][BUILDER-UI] + + Parses a string containing a [GtkBuilder UI definition][BUILDER-UI] and merges it with the current contents of @builder. Most users will probably want to use gtk_builder_new_from_string(). @@ -16983,44 +12046,31 @@ Upon errors 0 will be returned and @error will be assigned a #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_VARIANT_PARSE_ERROR domain. -It’s not really reasonable to attempt to handle failures of this +It’s not really reasonable to attempt to handle failures of this call. The only reasonable thing to do when an error is detected is to call g_error(). - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - - Parses a file containing a [GtkBuilder UI definition][BUILDER-UI] + + Parses a file containing a [GtkBuilder UI definition][BUILDER-UI] building only the requested objects and merges them with the current contents of @builder. @@ -17033,41 +12083,28 @@ its child (for instance a #GtkTreeView that depends on its #GtkTreeModel), you have to explicitly list all of them in @object_ids. - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the name of the file to parse + the name of the file to parse - nul-terminated array of objects to build + nul-terminated array of objects to build - - Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI] + + Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI] building only the requested objects and merges them with the current contents of @builder. @@ -17080,41 +12117,28 @@ its child (for instance a #GtkTreeView that depends on its #GtkTreeModel), you have to explicitly list all of them in @object_ids. - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the path of the resource file to parse + the path of the resource file to parse - nul-terminated array of objects to build + nul-terminated array of objects to build - - Parses a string containing a [GtkBuilder UI definition][BUILDER-UI] + + Parses a string containing a [GtkBuilder UI definition][BUILDER-UI] building only the requested objects and merges them with the current contents of @builder. @@ -17126,50 +12150,36 @@ its child (for instance a #GtkTreeView that depends on its #GtkTreeModel), you have to explicitly list all of them in @object_ids. - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - nul-terminated array of objects to build + nul-terminated array of objects to build - - This method is a simpler variation of gtk_builder_connect_signals_full(). + + This method is a simpler variation of gtk_builder_connect_signals_full(). It uses symbols explicitly added to @builder with prior calls to gtk_builder_add_callback_symbol(). In the case that symbols are not -explicitly added; it uses #GModule’s introspective features (by opening the module %NULL) -to look at the application’s symbol table. From here it tries to match +explicitly added; it uses #GModule’s introspective features (by opening the module %NULL) +to look at the application’s symbol table. From here it tries to match the signal handler names given in the interface description with symbols in the application and connects the signals. Note that this function can only be called once, subsequent calls will do nothing. @@ -17192,28 +12202,17 @@ gmodule-export-2.0. - a #GtkBuilder + a #GtkBuilder - - user data to pass back with all signals + + user data to pass back with all signals - - This function can be thought of the interpreted language binding + + This function can be thought of the interpreted language binding version of gtk_builder_connect_signals(), except that it does not require GModule to function correctly. @@ -17222,37 +12221,21 @@ require GModule to function correctly. - a #GtkBuilder + a #GtkBuilder - - the function used to connect the signals + + the function used to connect the signals - - arbitrary data that will be passed to the connection function + + arbitrary data that will be passed to the connection function - - Add @object to the @builder object pool so it can be referenced just like any + + Add @object to the @builder object pool so it can be referenced just like any other object built by builder. @@ -17260,81 +12243,55 @@ other object built by builder. - a #GtkBuilder + a #GtkBuilder - the name of the object exposed to the builder + the name of the object exposed to the builder - the object to expose + the object to expose - - Main private entry point for building composite container + + Main private entry point for building composite container components from template XML. This is exported purely to let gtk-builder-tool validate templates, applications have no need to call this function. - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a #GtkBuilder + a #GtkBuilder - the widget that is being extended + the widget that is being extended - the type that the template is for + the type that the template is for - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - - Gets the #GtkApplication associated with the builder. + + Gets the #GtkApplication associated with the builder. The #GtkApplication is used for creating action proxies as requested from XML that the builder is loading. @@ -17344,64 +12301,44 @@ g_application_get_default(). If you want to use another application for constructing proxies, use gtk_builder_set_application(). - the application being used by the builder, + the application being used by the builder, or %NULL - a #GtkBuilder + a #GtkBuilder - - Gets the object named @name. Note that this function does not + + Gets the object named @name. Note that this function does not increment the reference count of the returned object. - the object named @name or %NULL if + the object named @name or %NULL if it could not be found in the object tree. - a #GtkBuilder + a #GtkBuilder - name of object to get + name of object to get - - Gets all objects that have been constructed by @builder. Note that + + Gets all objects that have been constructed by @builder. Note that this function does not increment the reference counts of the returned objects. - a newly-allocated #GSList containing all the objects + a newly-allocated #GSList containing all the objects constructed by the #GtkBuilder instance. It should be freed by g_slist_free() @@ -17410,74 +12347,49 @@ objects. - a #GtkBuilder + a #GtkBuilder - - Gets the translation domain of @builder. + + Gets the translation domain of @builder. - the translation domain. This string is owned + the translation domain. This string is owned by the builder object and must not be modified or freed. - a #GtkBuilder + a #GtkBuilder - - Looks up a type by name, using the virtual function that + + Looks up a type by name, using the virtual function that #GtkBuilder has for that purpose. This is mainly used when implementing the #GtkBuildable interface on a type. - the #GType found for @type_name or #G_TYPE_INVALID + the #GType found for @type_name or #G_TYPE_INVALID if no type was found - a #GtkBuilder + a #GtkBuilder - type name to lookup + type name to lookup - - Fetches a symbol previously added to @builder + + Fetches a symbol previously added to @builder with gtk_builder_add_callback_symbols() This function is intended for possible use in language bindings @@ -17485,32 +12397,22 @@ or for any case that one might be cusomizing signal connections using gtk_builder_connect_signals_full() - The callback symbol in @builder for @callback_name, or %NULL + The callback symbol in @builder for @callback_name, or %NULL - a #GtkBuilder + a #GtkBuilder - The name of the callback + The name of the callback - - Sets the application associated with @builder. + + Sets the application associated with @builder. You only need this function if there is more than one #GApplication in your process. @application cannot be %NULL. @@ -17520,25 +12422,17 @@ in your process. @application cannot be %NULL. - a #GtkBuilder + a #GtkBuilder - a #GtkApplication + a #GtkApplication - - Sets the translation domain of @builder. + + Sets the translation domain of @builder. See #GtkBuilder:translation-domain. @@ -17546,29 +12440,17 @@ See #GtkBuilder:translation-domain. - a #GtkBuilder + a #GtkBuilder - - the translation domain or %NULL + + the translation domain or %NULL - - This function demarshals a value from a string. This function + + This function demarshals a value from a string. This function calls g_value_init() on the @value argument, so it need not be initialised beforehand. @@ -17581,48 +12463,30 @@ Upon errors %FALSE will be returned and @error will be assigned a #GError from the #GTK_BUILDER_ERROR domain. - %TRUE on success + %TRUE on success - a #GtkBuilder + a #GtkBuilder - the #GParamSpec for the property + the #GParamSpec for the property - the string representation of the value + the string representation of the value - - the #GValue to store the result in + + the #GValue to store the result in - - Like gtk_builder_value_from_string(), this function demarshals + + Like gtk_builder_value_from_string(), this function demarshals a value from a string, but takes a #GType instead of #GParamSpec. This function calls g_value_init() on the @value argument, so it need not be initialised beforehand. @@ -17631,48 +12495,30 @@ Upon errors %FALSE will be returned and @error will be assigned a #GError from the #GTK_BUILDER_ERROR domain. - %TRUE on success + %TRUE on success - a #GtkBuilder + a #GtkBuilder - the #GType of the value + the #GType of the value - the string representation of the value + the string representation of the value - - the #GValue to store the result in + + the #GValue to store the result in - - The translation domain used when translating property values that + + The translation domain used when translating property values that have been marked as translatable in interface descriptions. If the translation domain is %NULL, #GtkBuilder uses gettext(), otherwise g_dgettext(). @@ -17685,9 +12531,7 @@ otherwise g_dgettext(). - + @@ -17696,23 +12540,17 @@ otherwise g_dgettext(). - the #GType found for @type_name or #G_TYPE_INVALID + the #GType found for @type_name or #G_TYPE_INVALID if no type was found - a #GtkBuilder + a #GtkBuilder - type name to lookup + type name to lookup @@ -17783,12 +12621,8 @@ otherwise g_dgettext(). - - This is the signature of a function used to connect signals. It is used + + This is the signature of a function used to connect signals. It is used by the gtk_builder_connect_signals() and gtk_builder_connect_signals_full() methods. It is mainly intended for interpreted language bindings, but could be useful where the programmer wants more control over the signal @@ -17800,185 +12634,88 @@ subsequent calls will do nothing. - a #GtkBuilder + a #GtkBuilder - object to connect a signal to + object to connect a signal to - name of the signal + name of the signal - name of the handler + name of the handler - - a #GObject, if non-%NULL, use g_signal_connect_object() + + a #GObject, if non-%NULL, use g_signal_connect_object() - #GConnectFlags to use + #GConnectFlags to use - - user data + + user data - - Error codes that identify various errors that can occur while using + + Error codes that identify various errors that can occur while using #GtkBuilder. - - A type-func attribute didn’t name + + A type-func attribute didn’t name a function that returns a #GType. - - The input contained a tag that #GtkBuilder - can’t handle. + + The input contained a tag that #GtkBuilder + can’t handle. - - An attribute that is required by + + An attribute that is required by #GtkBuilder was missing. - - #GtkBuilder found an attribute that - it doesn’t understand. + + #GtkBuilder found an attribute that + it doesn’t understand. - - #GtkBuilder found a tag that - it doesn’t understand. + + #GtkBuilder found a tag that + it doesn’t understand. - - A required property value was + + A required property value was missing. - - #GtkBuilder couldn’t parse + + #GtkBuilder couldn’t parse some attribute value. - - The input file requires a newer version + + The input file requires a newer version of GTK+. - - An object id occurred twice. + + An object id occurred twice. - - A specified object type is of the same type or + + A specified object type is of the same type or derived from the type of the composite class being extended with builder XML. - - The wrong type was specified in a composite class’s template XML + + The wrong type was specified in a composite class’s template XML - - The specified property is unknown for the object class. + + The specified property is unknown for the object class. - - The specified signal is unknown for the object class. + + The specified signal is unknown for the object class. - - An object id is unknown + + An object id is unknown @@ -17989,16 +12726,8 @@ subsequent calls will do nothing. - - The #GtkButton widget is generally used to trigger a callback function that is + + The #GtkButton widget is generally used to trigger a callback function that is called when the button is pressed. The various signals and how to use them are outlined below. @@ -18026,26 +12755,18 @@ to differentiate themselves from a plain GtkButton. - Creates a new #GtkButton widget. To add a child widget to the button, + Creates a new #GtkButton widget. To add a child widget to the button, use gtk_container_add(). - The newly created #GtkButton widget. + The newly created #GtkButton widget. - - Creates a new button containing an icon from the current icon theme. + + Creates a new button containing an icon from the current icon theme. -If the icon name isn’t known, a “broken image” icon will be +If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. @@ -18053,36 +12774,22 @@ This function is a convenience wrapper around gtk_button_new() and gtk_button_set_image(). - a new #GtkButton displaying the themed icon + a new #GtkButton displaying the themed icon - - an icon name or %NULL + + an icon name or %NULL - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - Creates a new #GtkButton containing the image and text from a + + Creates a new #GtkButton containing the image and text from a [stock item][gtkstock]. Some stock ids have preprocessor macros like #GTK_STOCK_OK and #GTK_STOCK_APPLY. @@ -18093,64 +12800,46 @@ label (as for gtk_button_new_with_mnemonic()). instead. - a new #GtkButton + a new #GtkButton - the name of the stock item + the name of the stock item - - Creates a #GtkButton widget with a #GtkLabel child containing the given + + Creates a #GtkButton widget with a #GtkLabel child containing the given text. - The newly created #GtkButton widget. + The newly created #GtkButton widget. - The text you want the #GtkLabel to hold. + The text you want the #GtkLabel to hold. - - Creates a new #GtkButton containing a label. + + Creates a new #GtkButton containing a label. If characters in @label are preceded by an underscore, they are underlined. -If you need a literal underscore character in a label, use “__” (two +If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button. - a new #GtkButton + a new #GtkButton - The text of the button, with an underscore in front of the + The text of the button, with an underscore in front of the mnemonic character @@ -18168,29 +12857,20 @@ Pressing Alt and that key activates the button. - Emits a #GtkButton::clicked signal to the given #GtkButton. + Emits a #GtkButton::clicked signal to the given #GtkButton. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::enter signal to the given #GtkButton. + + Emits a #GtkButton::enter signal to the given #GtkButton. Use the #GtkWidget::enter-notify-event signal. @@ -18198,20 +12878,13 @@ Pressing Alt and that key activates the button. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::leave signal to the given #GtkButton. + + Emits a #GtkButton::leave signal to the given #GtkButton. Use the #GtkWidget::leave-notify-event signal. @@ -18219,20 +12892,13 @@ Pressing Alt and that key activates the button. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::pressed signal to the given #GtkButton. + + Emits a #GtkButton::pressed signal to the given #GtkButton. Use the #GtkWidget::button-press-event signal. @@ -18240,20 +12906,13 @@ Pressing Alt and that key activates the button. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::released signal to the given #GtkButton. + + Emits a #GtkButton::released signal to the given #GtkButton. Use the #GtkWidget::button-release-event signal. @@ -18261,37 +12920,26 @@ Pressing Alt and that key activates the button. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - Emits a #GtkButton::clicked signal to the given #GtkButton. + Emits a #GtkButton::clicked signal to the given #GtkButton. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::enter signal to the given #GtkButton. + + Emits a #GtkButton::enter signal to the given #GtkButton. Use the #GtkWidget::enter-notify-event signal. @@ -18299,21 +12947,13 @@ Pressing Alt and that key activates the button. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Gets the alignment of the child in the button. + + Gets the alignment of the child in the button. Access the child widget directly if you need to control its alignment. @@ -18322,252 +12962,165 @@ its alignment. - a #GtkButton + a #GtkButton - - return location for horizontal alignment + + return location for horizontal alignment - - return location for vertical alignment + + return location for vertical alignment - - Returns whether the button will ignore the #GtkSettings:gtk-button-images + + Returns whether the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available. - %TRUE if the button will always show the image + %TRUE if the button will always show the image - a #GtkButton + a #GtkButton - - Returns the button’s event window if it is realized, %NULL otherwise. + + Returns the button’s event window if it is realized, %NULL otherwise. This function should be rarely needed. - @button’s event window. + @button’s event window. - a #GtkButton + a #GtkButton - - Returns whether the button grabs focus when it is clicked with the mouse. + + Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click(). Use gtk_widget_get_focus_on_click() instead - %TRUE if the button grabs focus when it is clicked with + %TRUE if the button grabs focus when it is clicked with the mouse. - a #GtkButton + a #GtkButton - - Gets the widget that is currenty set as the image of @button. + + Gets the widget that is currenty set as the image of @button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock(). - a #GtkWidget or %NULL in case + a #GtkWidget or %NULL in case there is no image - a #GtkButton + a #GtkButton - - Gets the position of the image relative to the text + + Gets the position of the image relative to the text inside the button. - the position + the position - a #GtkButton + a #GtkButton - Fetches the text from the label of the button, as set by + Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be %NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container. - The text of the label widget. This string is owned + The text of the label widget. This string is owned by the widget and must not be modified or freed. - a #GtkButton + a #GtkButton - Returns the current relief style of the given #GtkButton. + Returns the current relief style of the given #GtkButton. - The current #GtkReliefStyle + The current #GtkReliefStyle - The #GtkButton you want the #GtkReliefStyle from. + The #GtkButton you want the #GtkReliefStyle from. - - Returns whether the button label is a stock item. + + Returns whether the button label is a stock item. - %TRUE if the button label is used to + %TRUE if the button label is used to select a stock item instead of being used directly as the label text. - a #GtkButton + a #GtkButton - - Returns whether an embedded underline in the button label indicates a + + Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline (). - %TRUE if an embedded underline in the button label + %TRUE if an embedded underline in the button label indicates the mnemonic accelerator keys. - a #GtkButton + a #GtkButton - - Emits a #GtkButton::leave signal to the given #GtkButton. + + Emits a #GtkButton::leave signal to the given #GtkButton. Use the #GtkWidget::leave-notify-event signal. @@ -18575,20 +13128,13 @@ mnemonic. See gtk_button_set_use_underline (). - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::pressed signal to the given #GtkButton. + + Emits a #GtkButton::pressed signal to the given #GtkButton. Use the #GtkWidget::button-press-event signal. @@ -18596,20 +13142,13 @@ mnemonic. See gtk_button_set_use_underline (). - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Emits a #GtkButton::released signal to the given #GtkButton. + + Emits a #GtkButton::released signal to the given #GtkButton. Use the #GtkWidget::button-release-event signal. @@ -18617,21 +13156,13 @@ mnemonic. See gtk_button_set_use_underline (). - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. - - Sets the alignment of the child. This property has no effect unless + + Sets the alignment of the child. This property has no effect unless the child is a #GtkMisc or a #GtkAlignment. Access the child widget directly if you need to control its alignment. @@ -18641,33 +13172,23 @@ its alignment. - a #GtkButton + a #GtkButton - the horizontal position of the child, 0.0 is left aligned, + the horizontal position of the child, 0.0 is left aligned, 1.0 is right aligned - the vertical position of the child, 0.0 is top aligned, + the vertical position of the child, 0.0 is top aligned, 1.0 is bottom aligned - - If %TRUE, the button will ignore the #GtkSettings:gtk-button-images + + If %TRUE, the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available. Use this property if the button would be useless or hard to use @@ -18678,29 +13199,19 @@ without the image. - a #GtkButton + a #GtkButton - %TRUE if the menuitem should always show the image + %TRUE if the menuitem should always show the image - - Sets whether the button will grab focus when it is clicked with the mouse. + + Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where -you don’t want the keyboard focus removed from the main area of the +you don’t want the keyboard focus removed from the main area of the application. Use gtk_widget_set_focus_on_click() instead @@ -18709,27 +13220,19 @@ application. - a #GtkButton + a #GtkButton - whether the button grabs focus when clicked with the mouse + whether the button grabs focus when clicked with the mouse - - Set the image of @button to the given widget. The image will be + + Set the image of @button to the given widget. The image will be displayed if the label text is %NULL or if -#GtkButton:always-show-image is %TRUE. You don’t have to call +#GtkButton:always-show-image is %TRUE. You don’t have to call gtk_widget_show() on @image yourself. @@ -18737,28 +13240,17 @@ gtk_widget_show() on @image yourself. - a #GtkButton + a #GtkButton - - a widget to set as the image for the button, or %NULL to unset + + a widget to set as the image for the button, or %NULL to unset - - Sets the position of the image relative to the text + + Sets the position of the image relative to the text inside the button. @@ -18766,23 +13258,17 @@ inside the button. - a #GtkButton + a #GtkButton - the position + the position - Sets the text of the label of the button to @str. This text is + Sets the text of the label of the button to @str. This text is also used to select the stock item if gtk_button_set_use_stock() is used. @@ -18793,23 +13279,17 @@ This will also clear any previously set labels. - a #GtkButton + a #GtkButton - a string + a string - Sets the relief style of the edges of the given #GtkButton widget. + Sets the relief style of the edges of the given #GtkButton widget. Two styles exist, %GTK_RELIEF_NORMAL and %GTK_RELIEF_NONE. The default style is, as one can guess, %GTK_RELIEF_NORMAL. The deprecated value %GTK_RELIEF_HALF behaves the same as @@ -18820,26 +13300,17 @@ The deprecated value %GTK_RELIEF_HALF behaves the same as - The #GtkButton you want to set relief styles of + The #GtkButton you want to set relief styles of - The GtkReliefStyle as described above + The GtkReliefStyle as described above - - If %TRUE, the label set on the button is used as a + + If %TRUE, the label set on the button is used as a stock id to select the stock item for the button. @@ -18847,24 +13318,17 @@ stock id to select the stock item for the button. - a #GtkButton + a #GtkButton - %TRUE if the button should use a stock item + %TRUE if the button should use a stock item - - If true, an underline in the text of the button label indicates + + If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key. @@ -18872,98 +13336,53 @@ the next character should be used for the mnemonic accelerator key. - a #GtkButton + a #GtkButton - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics - - If %TRUE, the button will ignore the #GtkSettings:gtk-button-images + + If %TRUE, the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available. Use this property if the button would be useless or hard to use without the image. - - The child widget to appear next to the button text. + + The child widget to appear next to the button text. - - The position of the image relative to the text inside the button. + + The position of the image relative to the text inside the button. - + - + - + - - If the child of the button is a #GtkMisc or #GtkAlignment, this property + + If the child of the button is a #GtkMisc or #GtkAlignment, this property can be used to control its horizontal alignment. 0.0 is left aligned, 1.0 is right aligned. Access the child widget directly if you need to control its alignment. - - If the child of the button is a #GtkMisc or #GtkAlignment, this property + + If the child of the button is a #GtkMisc or #GtkAlignment, this property can be used to control its vertical alignment. 0.0 is top aligned, 1.0 is bottom aligned. Access the child widget directly if you need to control @@ -18977,9 +13396,7 @@ its alignment. - The ::activate signal on GtkButton is an action signal and + The ::activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the #GtkButton::clicked signal. @@ -18988,69 +13405,41 @@ Applications should never connect to this signal, but use the - Emitted when the button has been activated (pressed and released). + Emitted when the button has been activated (pressed and released). - - Emitted when the pointer enters the button. + + Emitted when the pointer enters the button. Use the #GtkWidget::enter-notify-event signal. - - Emitted when the pointer leaves the button. + + Emitted when the pointer leaves the button. Use the #GtkWidget::leave-notify-event signal. - - Emitted when the button is pressed. + + Emitted when the button is pressed. Use the #GtkWidget::button-press-event signal. - - Emitted when the button is released. + + Emitted when the button is released. Use the #GtkWidget::button-release-event signal. - + @@ -19059,168 +13448,111 @@ Applications should never connect to this signal, but use the - + - + - + - + - + - Creates a new #GtkButtonBox. + Creates a new #GtkButtonBox. - a new #GtkButtonBox. + a new #GtkButtonBox. - the box's orientation. + the box's orientation. - - Returns whether the child is exempted from homogenous + + Returns whether the child is exempted from homogenous sizing. - %TRUE if the child is not subject to homogenous sizing + %TRUE if the child is not subject to homogenous sizing - a #GtkButtonBox + a #GtkButtonBox - a child of @widget + a child of @widget - - Returns whether @child should appear in a secondary group of children. + + Returns whether @child should appear in a secondary group of children. - whether @child should appear in a secondary group of children. + whether @child should appear in a secondary group of children. - a #GtkButtonBox + a #GtkButtonBox - a child of @widget + a child of @widget - Retrieves the method being used to arrange the buttons in a button box. + Retrieves the method being used to arrange the buttons in a button box. - the method used to lay out buttons in @widget. + the method used to lay out buttons in @widget. - a #GtkButtonBox + a #GtkButtonBox - - Sets whether the child is exempted from homogeous sizing. + + Sets whether the child is exempted from homogeous sizing. - a #GtkButtonBox + a #GtkButtonBox - a child of @widget + a child of @widget - the new value + the new value - - Sets whether @child should appear in a secondary group of children. + + Sets whether @child should appear in a secondary group of children. A typical use of a secondary child is the help button in a dialog. This group appears after the other children if the style @@ -19238,45 +13570,33 @@ other styles, they appear immediately next to the main children. - a #GtkButtonBox + a #GtkButtonBox - a child of @widget + a child of @widget - if %TRUE, the @child appears in a secondary group of the + if %TRUE, the @child appears in a secondary group of the button box. - Changes the way buttons are arranged in their container. + Changes the way buttons are arranged in their container. - a #GtkButtonBox + a #GtkButtonBox - the new layout style + the new layout style @@ -19291,14 +13611,10 @@ other styles, they appear immediately next to the main children. - + - The parent class. + The parent class. @@ -19337,76 +13653,37 @@ other styles, they appear immediately next to the main children. - - Used to dictate the style that a #GtkButtonBox uses to layout the buttons it + + Used to dictate the style that a #GtkButtonBox uses to layout the buttons it contains. - - Buttons are evenly spread across the box. + + Buttons are evenly spread across the box. - - Buttons are placed at the edges of the box. + + Buttons are placed at the edges of the box. - - Buttons are grouped towards the start of the box, + + Buttons are grouped towards the start of the box, (on the left for a HBox, or the top for a VBox). - - Buttons are grouped towards the end of the box, + + Buttons are grouped towards the end of the box, (on the right for a HBox, or the bottom for a VBox). - - Buttons are centered in the box. Since 2.12. + + Buttons are centered in the box. Since 2.12. - - Buttons expand to fill the box. This entails giving + + Buttons expand to fill the box. This entails giving buttons a "linked" appearance, making button sizes homogeneous, and setting spacing to 0 (same as calling gtk_box_set_homogeneous() and gtk_box_set_spacing() manually). Since 3.12. - + - The parent class. + The parent class. @@ -19417,9 +13694,7 @@ contains. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. @@ -19433,9 +13708,7 @@ contains. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. @@ -19449,9 +13722,7 @@ contains. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. @@ -19465,9 +13736,7 @@ contains. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. @@ -19481,9 +13750,7 @@ contains. - The #GtkButton you want to send the signal to. + The #GtkButton you want to send the signal to. @@ -19538,1098 +13805,797 @@ contains. - - The role specifies the desired appearance of a #GtkModelButton. - - A plain button + + The role specifies the desired appearance of a #GtkModelButton. + + A plain button - - A check button + + A check button - - A radio button + + A radio button - - Prebuilt sets of buttons for the dialog. If + + Prebuilt sets of buttons for the dialog. If none of these choices are appropriate, simply use %GTK_BUTTONS_NONE then call gtk_dialog_add_buttons(). > Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO > and %GTK_BUTTONS_OK_CANCEL are discouraged by the > [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/). - - no buttons at all + + no buttons at all - an OK button + an OK button - - a Close button + + a Close button - - a Cancel button + + a Cancel button - - Yes and No buttons + + Yes and No buttons - - OK and Cancel buttons + + OK and Cancel buttons - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - - This macro should be used to emit a standard warning about unexpected + + This macro should be used to emit a standard warning about unexpected properties in set_cell_property() and get_cell_property() implementations. - the #GObject on which set_cell_property() or get_cell_property() + the #GObject on which set_cell_property() or get_cell_property() was called - the numeric id of the property + the numeric id of the property - the #GParamSpec of the property + the #GParamSpec of the property - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - - Returns %TRUE if the version of the GTK+ header files + + Returns %TRUE if the version of the GTK+ header files is the same as or newer than the passed-in version. - major version (e.g. 1 for version 1.2.5) + major version (e.g. 1 for version 1.2.5) - minor version (e.g. 2 for version 1.2.5) + minor version (e.g. 2 for version 1.2.5) - micro version (e.g. 5 for version 1.2.5) + micro version (e.g. 5 for version 1.2.5) - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - - This macro should be used to emit a standard warning about unexpected + + This macro should be used to emit a standard warning about unexpected properties in set_child_property() and get_child_property() implementations. - the #GObject on which set_child_property() or get_child_property() + the #GObject on which set_child_property() or get_child_property() was called - the numeric id of the property + the numeric id of the property - the #GParamSpec of the property + the #GParamSpec of the property - + - + - + - - #GtkCalendar is a widget that displays a Gregorian calendar, one month + + #GtkCalendar is a widget that displays a Gregorian calendar, one month at a time. It can be created with gtk_calendar_new(). The month and year currently displayed can be altered with @@ -20654,14 +14620,10 @@ historically incorrect. - Creates a new calendar, with the current date being selected. + Creates a new calendar, with the current date being selected. - a newly #GtkCalendar widget + a newly #GtkCalendar widget @@ -20743,254 +14705,166 @@ historically incorrect. - Remove all visual markers. + Remove all visual markers. - a #GtkCalendar + a #GtkCalendar - Obtains the selected date from a #GtkCalendar. + Obtains the selected date from a #GtkCalendar. - a #GtkCalendar + a #GtkCalendar - - location to store the year as a decimal + + location to store the year as a decimal number (e.g. 2011), or %NULL - - location to store the month number + + location to store the month number (between 0 and 11), or %NULL - - location to store the day number (between + + location to store the day number (between 1 and 31), or %NULL - - Returns if the @day of the @calendar is already marked. + + Returns if the @day of the @calendar is already marked. - whether the day is marked. + whether the day is marked. - a #GtkCalendar + a #GtkCalendar - the day number between 1 and 31. + the day number between 1 and 31. - - Queries the height of detail cells, in rows. + + Queries the height of detail cells, in rows. See #GtkCalendar:detail-width-chars. - The height of detail cells, in rows. + The height of detail cells, in rows. - a #GtkCalendar. + a #GtkCalendar. - - Queries the width of detail cells, in characters. + + Queries the width of detail cells, in characters. See #GtkCalendar:detail-width-chars. - The width of detail cells, in characters. + The width of detail cells, in characters. - a #GtkCalendar. + a #GtkCalendar. - - Returns the current display options of @calendar. + + Returns the current display options of @calendar. - the display options. - + the display options. + - a #GtkCalendar + a #GtkCalendar - Places a visual marker on a particular day. + Places a visual marker on a particular day. - a #GtkCalendar + a #GtkCalendar - the day number to mark between 1 and 31. + the day number to mark between 1 and 31. - Selects a day from the current month. + Selects a day from the current month. - a #GtkCalendar. + a #GtkCalendar. - the day number between 1 and 31, or 0 to unselect + the day number between 1 and 31, or 0 to unselect the currently selected day. - Shifts the calendar to a different month. + Shifts the calendar to a different month. - a #GtkCalendar + a #GtkCalendar - a month number between 0 and 11. + a month number between 0 and 11. - the year the month is in. + the year the month is in. - - Installs a function which provides Pango markup with detail information + + Installs a function which provides Pango markup with detail information for each day. Examples for such details are holidays or appointments. That information is shown below each day when #GtkCalendar:show-details is set. A tooltip containing with full detail information is provided, if the entire @@ -21006,44 +14880,25 @@ properties. - a #GtkCalendar. + a #GtkCalendar. - - a function providing details for each day. + + a function providing details for each day. - - data to pass to @func invokations. + + data to pass to @func invokations. - a function for releasing @data. + a function for releasing @data. - - Updates the height of detail cells. + + Updates the height of detail cells. See #GtkCalendar:detail-height-rows. @@ -21051,25 +14906,17 @@ See #GtkCalendar:detail-height-rows. - a #GtkCalendar. + a #GtkCalendar. - detail height in rows. + detail height in rows. - - Updates the width of detail cells. + + Updates the width of detail cells. See #GtkCalendar:detail-width-chars. @@ -21077,25 +14924,17 @@ See #GtkCalendar:detail-width-chars. - a #GtkCalendar. + a #GtkCalendar. - detail width in characters. + detail width in characters. - - Sets display options (whether to display the heading and the month + + Sets display options (whether to display the heading and the month headings). @@ -21103,129 +14942,77 @@ headings). - a #GtkCalendar + a #GtkCalendar - the display options to set - + the display options to set + - Removes the visual marker from a particular day. + Removes the visual marker from a particular day. - a #GtkCalendar. + a #GtkCalendar. - the day number to unmark between 1 and 31. + the day number to unmark between 1 and 31. - The selected day (as a number between 1 and 31, or 0 + The selected day (as a number between 1 and 31, or 0 to unselect the currently selected day). This property gets initially set to the current day. - - Height of a detail cell, in rows. + + Height of a detail cell, in rows. A value of 0 allows any width. See gtk_calendar_set_detail_func(). - - Width of a detail cell, in characters. + + Width of a detail cell, in characters. A value of 0 allows any width. See gtk_calendar_set_detail_func(). - The selected month (as a number between 0 and 11). + The selected month (as a number between 0 and 11). This property gets initially set to the current month. - - Determines whether the selected month can be changed. + + Determines whether the selected month can be changed. - - Determines whether day names are displayed. + + Determines whether day names are displayed. - - Determines whether details are shown directly in the widget, or if they are + + Determines whether details are shown directly in the widget, or if they are available only as tooltip. When this property is set days with details are marked. - - Determines whether a heading is displayed. + + Determines whether a heading is displayed. - - Determines whether week numbers are displayed. + + Determines whether week numbers are displayed. - The selected year. + The selected year. This property gets initially set to the current year. @@ -21236,66 +15023,50 @@ This property gets initially set to the current year. - Emitted when the user selects a day. + Emitted when the user selects a day. - Emitted when the user double-clicks a day. + Emitted when the user double-clicks a day. - Emitted when the user clicks a button to change the selected month on a + Emitted when the user clicks a button to change the selected month on a calendar. - Emitted when the user switched to the next month. + Emitted when the user switched to the next month. - Emitted when user switched to the next year. + Emitted when user switched to the next year. - Emitted when the user switched to the previous month. + Emitted when the user switched to the previous month. - Emitted when user switched to the previous year. + Emitted when user switched to the previous year. - + @@ -21424,106 +15195,56 @@ calendar. - - This kind of functions provide Pango markup with detail information for the + + This kind of functions provide Pango markup with detail information for the specified day. Examples for such details are holidays or appointments. The function returns %NULL when no information is available. - Newly allocated string with Pango markup + Newly allocated string with Pango markup with details for the specified day or %NULL. - a #GtkCalendar. + a #GtkCalendar. - the year for which details are needed. + the year for which details are needed. - the month for which details are needed. + the month for which details are needed. - the day of @month for which details are needed. + the day of @month for which details are needed. - - the data passed with gtk_calendar_set_detail_func(). + + the data passed with gtk_calendar_set_detail_func(). - - These options can be used to influence the display and behaviour of a #GtkCalendar. - - Specifies that the month and year should be displayed. + + These options can be used to influence the display and behaviour of a #GtkCalendar. + + Specifies that the month and year should be displayed. - - Specifies that three letter day descriptions should be present. + + Specifies that three letter day descriptions should be present. - - Prevents the user from switching months with the calendar. + + Prevents the user from switching months with the calendar. - - Displays each week numbers of the current year, down the + + Displays each week numbers of the current year, down the left side of the calendar. - - Just show an indicator, not the full details + + Just show an indicator, not the full details text when details are provided. See gtk_calendar_set_detail_func(). @@ -21531,9 +15252,7 @@ text when details are provided. See gtk_calendar_set_detail_func(). - The type of the callback functions used for e.g. iterating over + The type of the callback functions used for e.g. iterating over the children of a container, see gtk_container_foreach(). @@ -21541,30 +15260,16 @@ the children of a container, see gtk_container_foreach(). - the widget to operate on + the widget to operate on - - user-supplied data + + user-supplied data - + @@ -21590,9 +15295,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -21614,24 +15317,16 @@ the children of a container, see gtk_container_foreach(). - - + + - + - + @@ -21639,15 +15334,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -21655,15 +15348,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -21671,63 +15362,44 @@ the children of a container, see gtk_container_foreach(). - + - + - + - + - + - + - + - + - + @@ -21736,53 +15408,41 @@ the children of a container, see gtk_container_foreach(). - + - + - + - + - + - + - - + + @@ -21790,8 +15450,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -21799,25 +15458,21 @@ the children of a container, see gtk_container_foreach(). - + - + - - + + @@ -21825,8 +15480,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -21834,15 +15488,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -21850,15 +15502,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -21868,17 +15518,14 @@ the children of a container, see gtk_container_foreach(). - - + + - + @@ -21886,98 +15533,72 @@ the children of a container, see gtk_container_foreach(). - + - + - - + + - + - - + + - + - + - - + + - + - + - + - + - + @@ -21985,56 +15606,42 @@ the children of a container, see gtk_container_foreach(). - - + + - + - + - + - - + + - + - - + + @@ -22042,35 +15649,29 @@ the children of a container, see gtk_container_foreach(). - + - - + + - + - - + + @@ -22078,42 +15679,35 @@ the children of a container, see gtk_container_foreach(). - + - - + + - + - - + + - + @@ -22124,51 +15718,34 @@ the children of a container, see gtk_container_foreach(). - - + + - + - + - + - + - + - + @@ -22179,23 +15756,18 @@ the children of a container, see gtk_container_foreach(). - + - + - + @@ -22203,15 +15775,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22221,15 +15791,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22239,15 +15807,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22257,15 +15823,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22275,15 +15839,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22293,15 +15855,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22311,15 +15871,13 @@ the children of a container, see gtk_container_foreach(). - + - + @@ -22332,29 +15890,21 @@ the children of a container, see gtk_container_foreach(). - + - + - + - + @@ -22362,8 +15912,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -22371,8 +15920,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -22382,8 +15930,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -22391,8 +15938,7 @@ the children of a container, see gtk_container_foreach(). - + @@ -22401,68 +15947,41 @@ the children of a container, see gtk_container_foreach(). - + - The type of the callback functions used for iterating over the + The type of the callback functions used for iterating over the cell renderers and their allocated areas inside a #GtkCellArea, see gtk_cell_area_foreach_alloc(). - %TRUE to stop iterating over cells. + %TRUE to stop iterating over cells. - the cell renderer to operate on + the cell renderer to operate on - the area allocated to @renderer inside the rectangle + the area allocated to @renderer inside the rectangle provided to gtk_cell_area_foreach_alloc(). - the background area for @renderer inside the + the background area for @renderer inside the background area provided to gtk_cell_area_foreach_alloc(). - - user-supplied data + + user-supplied data - - The #GtkCellArea is an abstract class for #GtkCellLayout widgets + + The #GtkCellArea is an abstract class for #GtkCellLayout widgets (also referred to as "layouting widgets") to interface with an arbitrary number of #GtkCellRenderers and interact with the user for a given #GtkTreeModel row. @@ -22476,7 +15995,7 @@ unless they are implementing a cell-layouting widget themselves. # Requesting area sizes As outlined in -[GtkWidget’s geometry management section][geometry-management], +[GtkWidget’s geometry management section][geometry-management], GTK+ uses a height-for-width geometry management system to compute the sizes of widgets and user interfaces. #GtkCellArea uses the same semantics to calculate the @@ -22490,9 +16009,9 @@ on the other hand might enforce that all areas received the same width and wrap the areas around, requesting height for more cell areas when allocated less width. -It’s also important for areas to maintain some cell +It’s also important for areas to maintain some cell alignments with areas rendered for adjacent rows (cells can -appear “columnized” inside an area even when the size of +appear “columnized” inside an area even when the size of cells are different in each row). For this reason the #GtkCellArea uses a #GtkCellAreaContext object to store the alignments and sizes along the way (as well as the overall largest minimum @@ -22504,7 +16023,7 @@ The #GtkCellAreaContext is an opaque object specific to the The owning cell-layouting widget can create as many contexts as it wishes to calculate sizes of rows which should receive the same size in at least one orientation (horizontally or vertically), -However, it’s important that the same #GtkCellAreaContext which +However, it’s important that the same #GtkCellAreaContext which was used to request the sizes for a given #GtkTreeModel row be used when rendering or processing events for that row. @@ -22527,7 +16046,7 @@ while (valid) gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width); ]| -Note that in this example it’s not important to observe the +Note that in this example it’s not important to observe the returned minimum and natural width of the area for each row unless the cell-layouting object is actually interested in the widths of individual rows. The overall width is however stored @@ -22570,7 +16089,7 @@ the #GtkCellAreaContext. Requesting the height for width (or width for height) of an area is a similar task except in this case the #GtkCellAreaContext does not store the data (actually, it does not know how much space the layouting -widget plans to allocate it for every row. It’s up to the layouting +widget plans to allocate it for every row. It’s up to the layouting widget to render each row of data with the appropriate height and width which was requested by the #GtkCellArea). @@ -22610,7 +16129,7 @@ allocation. In some cases the layouting widget is requested the height for an arbitrary for_width, this is a special case for layouting widgets who need to request size for tens of thousands of rows. For this -case it’s only important that the layouting widget calculate +case it’s only important that the layouting widget calculate one reasonably sized chunk of rows and return that height synchronously. The reasoning here is that any layouting widget is at least capable of synchronously calculating enough height to fill @@ -22678,7 +16197,7 @@ that is currently in progress. The #GtkCellArea drives keyboard focus from cell to cell in a way similar to #GtkWidget. For layouting widgets that support giving -focus to cells it’s important to remember to pass %GTK_CELL_RENDERER_FOCUSED +focus to cells it’s important to remember to pass %GTK_CELL_RENDERER_FOCUSED to the area functions for the row that has focus and to tell the area to paint the focus at render time. @@ -22761,9 +16280,9 @@ in very much the same way that #GtkContainer introduces [child properties][child-properties] for #GtkWidgets. This provides some general interfaces for defining the relationship cell areas have with their cells. For instance in a -#GtkCellAreaBox a cell might “expand” and receive extra space when +#GtkCellAreaBox a cell might “expand” and receive extra space when the area is allocated more than its full natural request, or a cell -might be configured to “align” with adjacent rows which were requested +might be configured to “align” with adjacent rows which were requested and rendered with the same #GtkCellAreaContext. Use gtk_cell_area_class_install_cell_property() to install cell @@ -22779,87 +16298,61 @@ gtk_cell_area_cell_get() or gtk_cell_area_cell_get_valist(). - Activates @area, usually by activating the currently focused + Activates @area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus. - Whether @area was successfully activated. + Whether @area was successfully activated. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext in context with the current row data + the #GtkCellAreaContext in context with the current row data - the #GtkWidget that @area is rendering on + the #GtkWidget that @area is rendering on - the size and location of @area relative to @widget’s allocation + the size and location of @area relative to @widget’s allocation - the #GtkCellRendererState flags for @area for this row of data. + the #GtkCellRendererState flags for @area for this row of data. - if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE + if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE will be activated. - Adds @renderer to @area with the default child cell properties. + Adds @renderer to @area with the default child cell properties. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to add to @area + the #GtkCellRenderer to add to @area - - Applies any connected attributes to the renderers in + + Applies any connected attributes to the renderers in @area by pulling the values from @tree_model. @@ -22867,42 +16360,30 @@ can also activate a widget if it currently has the focus. - a #GtkCellArea + a #GtkCellArea - the #GtkTreeModel to pull values from + the #GtkTreeModel to pull values from - the #GtkTreeIter in @tree_model to apply values for + the #GtkTreeIter in @tree_model to apply values for - whether @iter has children + whether @iter has children - whether @iter is expanded in the view and + whether @iter is expanded in the view and children are visible - This is sometimes needed for cases where rows need to share + This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation. @@ -22915,32 +16396,22 @@ was already used to request all the row widths that are to be displayed. - a newly created #GtkCellAreaContext copy of @context. + a newly created #GtkCellAreaContext copy of @context. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to copy + the #GtkCellAreaContext to copy - - Creates a #GtkCellAreaContext to be used with @area for + + Creates a #GtkCellAreaContext to be used with @area for all purposes. #GtkCellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. @@ -22948,74 +16419,52 @@ one should render and handle events with the same #GtkCellAreaContext which was used to request the size of those rows of data). - a newly created #GtkCellAreaContext which can be used with @area. + a newly created #GtkCellAreaContext which can be used with @area. - a #GtkCellArea + a #GtkCellArea - Delegates event handling to a #GtkCellArea. + Delegates event handling to a #GtkCellArea. - %TRUE if the event was handled by @area. + %TRUE if the event was handled by @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the #GdkEvent to handle + the #GdkEvent to handle - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the #GtkCellRendererState for @area in this row. + the #GtkCellRendererState for @area in this row. - This should be called by the @area’s owning layout widget + This should be called by the @area’s owning layout widget when focus is to be passed to @area, or moved within @area for a given @direction and row data. @@ -23024,67 +16473,43 @@ method to receive and navigate focus in its own way particular to how it lays out cells. - %TRUE if focus remains inside @area as a result of this call. + %TRUE if focus remains inside @area as a result of this call. - a #GtkCellArea + a #GtkCellArea - the #GtkDirectionType + the #GtkDirectionType - Calls @callback for every #GtkCellRenderer in @area. + Calls @callback for every #GtkCellRenderer in @area. - a #GtkCellArea + a #GtkCellArea - - the #GtkCellCallback to call + + the #GtkCellCallback to call - - user provided data pointer + + user provided data pointer - - Calls @callback for every #GtkCellRenderer in @area with the + + Calls @callback for every #GtkCellRenderer in @area with the allocated rectangle inside @cell_area. @@ -23092,51 +16517,31 @@ allocated rectangle inside @cell_area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the @widget relative coordinates and size for @area + the @widget relative coordinates and size for @area - the @widget relative coordinates of the background area + the @widget relative coordinates of the background area - - the #GtkCellAllocCallback to call + + the #GtkCellAllocCallback to call - - user provided data pointer + + user provided data pointer @@ -23164,15 +16569,11 @@ allocated rectangle inside @cell_area. - - Retrieves a cell area’s initial minimum and natural height. + + Retrieves a cell area’s initial minimum and natural height. @area will store some geometrical information in @context along the way; -when requesting sizes over an arbitrary number of rows, it’s not important +when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_height and @natural_height of this call but rather to consult gtk_cell_area_context_get_preferred_height() after a series of requests. @@ -23182,57 +16583,33 @@ requests. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to perform this request with + the #GtkCellAreaContext to perform this request with - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL - - Retrieves a cell area’s minimum and natural height if it would be given + + Retrieves a cell area’s minimum and natural height if it would be given the specified @width. @area stores some geometrical information in @context along the way -while calling gtk_cell_area_get_preferred_width(). It’s important to +while calling gtk_cell_area_get_preferred_width(). It’s important to perform a series of gtk_cell_area_get_preferred_width() requests with @context first and then call gtk_cell_area_get_preferred_height_for_width() on each cell area individually to get the height for width of each @@ -23248,62 +16625,36 @@ gtk_cell_area_context_get_preferred_width(). - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext which has already been requested for widths. + the #GtkCellAreaContext which has already been requested for widths. - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - the width for which to check the height of this area + the width for which to check the height of this area - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL - - Retrieves a cell area’s initial minimum and natural width. + + Retrieves a cell area’s initial minimum and natural width. @area will store some geometrical information in @context along the way; -when requesting sizes over an arbitrary number of rows, it’s not important +when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_width and @natural_width of this call but rather to consult gtk_cell_area_context_get_preferred_width() after a series of requests. @@ -23313,57 +16664,33 @@ requests. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to perform this request with + the #GtkCellAreaContext to perform this request with - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL - - Retrieves a cell area’s minimum and natural width if it would be given + + Retrieves a cell area’s minimum and natural width if it would be given the specified @height. @area stores some geometrical information in @context along the way -while calling gtk_cell_area_get_preferred_height(). It’s important to +while calling gtk_cell_area_get_preferred_height(). It’s important to perform a series of gtk_cell_area_get_preferred_height() requests with @context first and then call gtk_cell_area_get_preferred_width_for_height() on each cell area individually to get the height for width of each @@ -23379,126 +16706,80 @@ gtk_cell_area_context_get_preferred_height(). - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext which has already been requested for widths. + the #GtkCellAreaContext which has already been requested for widths. - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - the height for which to check the width of this area + the height for which to check the width of this area - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL - - Gets whether the area prefers a height-for-width layout + + Gets whether the area prefers a height-for-width layout or a width-for-height layout. - The #GtkSizeRequestMode preferred by @area. + The #GtkSizeRequestMode preferred by @area. - a #GtkCellArea + a #GtkCellArea - - Returns whether the area can do anything when activated, + + Returns whether the area can do anything when activated, after applying new attributes to @area. - whether @area can do anything when activated. + whether @area can do anything when activated. - a #GtkCellArea + a #GtkCellArea - Removes @renderer from @area. + Removes @renderer from @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to remove from @area + the #GtkCellRenderer to remove from @area - Renders @area’s cells according to @area’s layout onto @widget at + Renders @area’s cells according to @area’s layout onto @widget at the given coordinates. @@ -23506,51 +16787,35 @@ the given coordinates. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the #cairo_t to render with + the #cairo_t to render with - the @widget relative coordinates for @area’s background + the @widget relative coordinates for @area’s background - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the #GtkCellRendererState for @area in this row. + the #GtkCellRendererState for @area in this row. - whether @area should paint focus on focused cells for focused rows or not. + whether @area should paint focus on focused cells for focused rows or not. @@ -23578,146 +16843,100 @@ the given coordinates. - - Activates @area, usually by activating the currently focused + + Activates @area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus. - Whether @area was successfully activated. + Whether @area was successfully activated. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext in context with the current row data + the #GtkCellAreaContext in context with the current row data - the #GtkWidget that @area is rendering on + the #GtkWidget that @area is rendering on - the size and location of @area relative to @widget’s allocation + the size and location of @area relative to @widget’s allocation - the #GtkCellRendererState flags for @area for this row of data. + the #GtkCellRendererState flags for @area for this row of data. - if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE + if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE will be activated. - - This is used by #GtkCellArea subclasses when handling events + + This is used by #GtkCellArea subclasses when handling events to activate cells, the base #GtkCellArea class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation. - whether cell activation was successful + whether cell activation was successful - a #GtkCellArea + a #GtkCellArea - the #GtkWidget that @area is rendering onto + the #GtkWidget that @area is rendering onto - the #GtkCellRenderer in @area to activate + the #GtkCellRenderer in @area to activate - the #GdkEvent for which cell activation should occur + the #GdkEvent for which cell activation should occur - the #GdkRectangle in @widget relative coordinates + the #GdkRectangle in @widget relative coordinates of @renderer for the current row. - the #GtkCellRendererState for @renderer + the #GtkCellRendererState for @renderer - Adds @renderer to @area with the default child cell properties. + Adds @renderer to @area with the default child cell properties. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to add to @area + the #GtkCellRenderer to add to @area - - Adds @sibling to @renderer’s focusable area, focus will be drawn + + Adds @sibling to @renderer’s focusable area, focus will be drawn around @renderer and all of its siblings if @renderer can focus for a given row. @@ -23729,32 +16948,21 @@ focusable @renderer. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer expected to have focus + the #GtkCellRenderer expected to have focus - the #GtkCellRenderer to add to @renderer’s focus area + the #GtkCellRenderer to add to @renderer’s focus area - - Adds @renderer to @area, setting cell properties at the same time. + + Adds @renderer to @area, setting cell properties at the same time. See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details. @@ -23762,38 +16970,26 @@ See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer to be placed inside @area + a #GtkCellRenderer to be placed inside @area - the name of the first cell property to set + the name of the first cell property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - - Applies any connected attributes to the renderers in + + Applies any connected attributes to the renderers in @area by pulling the values from @tree_model. @@ -23801,44 +16997,30 @@ See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details. - a #GtkCellArea + a #GtkCellArea - the #GtkTreeModel to pull values from + the #GtkTreeModel to pull values from - the #GtkTreeIter in @tree_model to apply values for + the #GtkTreeIter in @tree_model to apply values for - whether @iter has children + whether @iter has children - whether @iter is expanded in the view and + whether @iter is expanded in the view and children are visible - - Connects an @attribute to apply values from @column for the + + Connects an @attribute to apply values from @column for the #GtkTreeModel in use. @@ -23846,37 +17028,25 @@ See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to connect an attribute for + the #GtkCellRenderer to connect an attribute for - the attribute name + the attribute name - the #GtkTreeModel column to fetch attribute values from + the #GtkTreeModel column to fetch attribute values from - - Disconnects @attribute for the @renderer in @area so that + + Disconnects @attribute for the @renderer in @area so that attribute will no longer be updated with values from the model. @@ -23885,296 +17055,198 @@ model. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to disconnect an attribute for + the #GtkCellRenderer to disconnect an attribute for - the attribute name + the attribute name - - Returns the model column that an attribute has been mapped to, + + Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped. - the model column, or -1 + the model column, or -1 - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer + a #GtkCellRenderer - an attribute on the renderer + an attribute on the renderer - - Gets the values of one or more cell properties for @renderer in @area. + + Gets the values of one or more cell properties for @renderer in @area. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer which is inside @area + a #GtkCellRenderer which is inside @area - the name of the first cell property to get + the name of the first cell property to get - return location for the first cell property, followed + return location for the first cell property, followed optionally by more name/return location pairs, followed by %NULL - - Gets the value of a cell property for @renderer in @area. + + Gets the value of a cell property for @renderer in @area. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer inside @area + a #GtkCellRenderer inside @area - the name of the property to get + the name of the property to get - - a location to return the value + + a location to return the value - - Gets the values of one or more cell properties for @renderer in @area. + + Gets the values of one or more cell properties for @renderer in @area. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer inside @area + a #GtkCellRenderer inside @area - the name of the first property to get + the name of the first property to get - return location for the first property, followed + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - - Sets one or more cell properties for @cell in @area. + + Sets one or more cell properties for @cell in @area. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer which is a cell inside @area + a #GtkCellRenderer which is a cell inside @area - the name of the first cell property to set + the name of the first cell property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - - Sets a cell property for @renderer in @area. + + Sets a cell property for @renderer in @area. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer inside @area + a #GtkCellRenderer inside @area - the name of the cell property to set + the name of the cell property to set - the value to set the cell property to + the value to set the cell property to - - Sets one or more cell properties for @renderer in @area. + + Sets one or more cell properties for @renderer in @area. - a #GtkCellArea + a #GtkCellArea - a #GtkCellRenderer which inside @area + a #GtkCellRenderer which inside @area - the name of the first cell property to set + the name of the first cell property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - - This is sometimes needed for cases where rows need to share + + This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation. @@ -24187,32 +17259,22 @@ was already used to request all the row widths that are to be displayed. - a newly created #GtkCellAreaContext copy of @context. + a newly created #GtkCellAreaContext copy of @context. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to copy + the #GtkCellAreaContext to copy - - Creates a #GtkCellAreaContext to be used with @area for + + Creates a #GtkCellAreaContext to be used with @area for all purposes. #GtkCellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. @@ -24220,74 +17282,52 @@ one should render and handle events with the same #GtkCellAreaContext which was used to request the size of those rows of data). - a newly created #GtkCellAreaContext which can be used with @area. + a newly created #GtkCellAreaContext which can be used with @area. - a #GtkCellArea + a #GtkCellArea - Delegates event handling to a #GtkCellArea. + Delegates event handling to a #GtkCellArea. - %TRUE if the event was handled by @area. + %TRUE if the event was handled by @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the #GdkEvent to handle + the #GdkEvent to handle - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the #GtkCellRendererState for @area in this row. + the #GtkCellRendererState for @area in this row. - This should be called by the @area’s owning layout widget + This should be called by the @area’s owning layout widget when focus is to be passed to @area, or moved within @area for a given @direction and row data. @@ -24296,69 +17336,43 @@ method to receive and navigate focus in its own way particular to how it lays out cells. - %TRUE if focus remains inside @area as a result of this call. + %TRUE if focus remains inside @area as a result of this call. - a #GtkCellArea + a #GtkCellArea - the #GtkDirectionType + the #GtkDirectionType - - Calls @callback for every #GtkCellRenderer in @area. + + Calls @callback for every #GtkCellRenderer in @area. - a #GtkCellArea + a #GtkCellArea - - the #GtkCellCallback to call + + the #GtkCellCallback to call - - user provided data pointer + + user provided data pointer - - Calls @callback for every #GtkCellRenderer in @area with the + + Calls @callback for every #GtkCellRenderer in @area with the allocated rectangle inside @cell_area. @@ -24366,61 +17380,37 @@ allocated rectangle inside @cell_area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the @widget relative coordinates and size for @area + the @widget relative coordinates and size for @area - the @widget relative coordinates of the background area + the @widget relative coordinates of the background area - - the #GtkCellAllocCallback to call + + the #GtkCellAllocCallback to call - - user provided data pointer + + user provided data pointer - - Derives the allocation of @renderer inside @area if @area + + Derives the allocation of @renderer inside @area if @area were to be renderered in @cell_area. @@ -24428,215 +17418,139 @@ were to be renderered in @cell_area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext used to hold sizes for @area. + the #GtkCellAreaContext used to hold sizes for @area. - the #GtkWidget that @area is rendering on + the #GtkWidget that @area is rendering on - the #GtkCellRenderer to get the allocation for + the #GtkCellRenderer to get the allocation for - the whole allocated area for @area in @widget + the whole allocated area for @area in @widget for this row - - where to store the allocation for @renderer + + where to store the allocation for @renderer - - Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally + + Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally returns the full cell allocation for it inside @cell_area. - the #GtkCellRenderer at @x and @y. + the #GtkCellRenderer at @x and @y. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext used to hold sizes for @area. + the #GtkCellAreaContext used to hold sizes for @area. - the #GtkWidget that @area is rendering on + the #GtkWidget that @area is rendering on - the whole allocated area for @area in @widget + the whole allocated area for @area in @widget for this row - the x position + the x position - the y position + the y position - - where to store the inner allocated area of the + + where to store the inner allocated area of the returned cell renderer, or %NULL. - - Gets the current #GtkTreePath string for the currently + + Gets the current #GtkTreePath string for the currently applied #GtkTreeIter, this is implicitly updated when gtk_cell_area_apply_attributes() is called and can be used to interact with renderers from #GtkCellArea subclasses. - The current #GtkTreePath string for the current + The current #GtkTreePath string for the current attributes applied to @area. This string belongs to the area and should not be freed. - a #GtkCellArea + a #GtkCellArea - - Gets the #GtkCellEditable widget currently used + + Gets the #GtkCellEditable widget currently used to edit the currently edited cell. - The currently active #GtkCellEditable widget + The currently active #GtkCellEditable widget - a #GtkCellArea + a #GtkCellArea - - Gets the #GtkCellRenderer in @area that is currently + + Gets the #GtkCellRenderer in @area that is currently being edited. - The currently edited #GtkCellRenderer + The currently edited #GtkCellRenderer - a #GtkCellArea + a #GtkCellArea - - Retrieves the currently focused cell for @area + + Retrieves the currently focused cell for @area - the currently focused cell in @area. + the currently focused cell in @area. - a #GtkCellArea + a #GtkCellArea - - Gets the #GtkCellRenderer which is expected to be focusable + + Gets the #GtkCellRenderer which is expected to be focusable for which @renderer is, or may be a sibling. This is handy for #GtkCellArea subclasses when handling events, @@ -24645,38 +17559,26 @@ then chose to activate the focus cell for which the event cell may have been a sibling. - the #GtkCellRenderer for which @renderer + the #GtkCellRenderer for which @renderer is a sibling, or %NULL. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer + the #GtkCellRenderer - - Gets the focus sibling cell renderers for @renderer. + + Gets the focus sibling cell renderers for @renderer. - A #GList of #GtkCellRenderers. + A #GList of #GtkCellRenderers. The returned list is internal and should not be freed. @@ -24684,28 +17586,20 @@ cell may have been a sibling. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer expected to have focus + the #GtkCellRenderer expected to have focus - - Retrieves a cell area’s initial minimum and natural height. + + Retrieves a cell area’s initial minimum and natural height. @area will store some geometrical information in @context along the way; -when requesting sizes over an arbitrary number of rows, it’s not important +when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_height and @natural_height of this call but rather to consult gtk_cell_area_context_get_preferred_height() after a series of requests. @@ -24715,57 +17609,33 @@ requests. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to perform this request with + the #GtkCellAreaContext to perform this request with - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL - - Retrieves a cell area’s minimum and natural height if it would be given + + Retrieves a cell area’s minimum and natural height if it would be given the specified @width. @area stores some geometrical information in @context along the way -while calling gtk_cell_area_get_preferred_width(). It’s important to +while calling gtk_cell_area_get_preferred_width(). It’s important to perform a series of gtk_cell_area_get_preferred_width() requests with @context first and then call gtk_cell_area_get_preferred_height_for_width() on each cell area individually to get the height for width of each @@ -24781,62 +17651,36 @@ gtk_cell_area_context_get_preferred_width(). - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext which has already been requested for widths. + the #GtkCellAreaContext which has already been requested for widths. - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - the width for which to check the height of this area + the width for which to check the height of this area - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL - - Retrieves a cell area’s initial minimum and natural width. + + Retrieves a cell area’s initial minimum and natural width. @area will store some geometrical information in @context along the way; -when requesting sizes over an arbitrary number of rows, it’s not important +when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_width and @natural_width of this call but rather to consult gtk_cell_area_context_get_preferred_width() after a series of requests. @@ -24846,57 +17690,33 @@ requests. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to perform this request with + the #GtkCellAreaContext to perform this request with - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL - - Retrieves a cell area’s minimum and natural width if it would be given + + Retrieves a cell area’s minimum and natural width if it would be given the specified @height. @area stores some geometrical information in @context along the way -while calling gtk_cell_area_get_preferred_height(). It’s important to +while calling gtk_cell_area_get_preferred_height(). It’s important to perform a series of gtk_cell_area_get_preferred_height() requests with @context first and then call gtk_cell_area_get_preferred_width_for_height() on each cell area individually to get the height for width of each @@ -24912,110 +17732,66 @@ gtk_cell_area_context_get_preferred_height(). - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext which has already been requested for widths. + the #GtkCellAreaContext which has already been requested for widths. - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - the height for which to check the width of this area + the height for which to check the width of this area - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL - - Gets whether the area prefers a height-for-width layout + + Gets whether the area prefers a height-for-width layout or a width-for-height layout. - The #GtkSizeRequestMode preferred by @area. + The #GtkSizeRequestMode preferred by @area. - a #GtkCellArea + a #GtkCellArea - - Checks if @area contains @renderer. + + Checks if @area contains @renderer. - %TRUE if @renderer is in the @area. + %TRUE if @renderer is in the @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to check + the #GtkCellRenderer to check - - This is a convenience function for #GtkCellArea implementations + + This is a convenience function for #GtkCellArea implementations to get the inner area where a given #GtkCellRenderer will be rendered. It removes any padding previously added by gtk_cell_area_request_renderer(). @@ -25024,122 +17800,81 @@ rendered. It removes any padding previously added by gtk_cell_area_request_rende - a #GtkCellArea + a #GtkCellArea - the #GtkWidget that @area is rendering onto + the #GtkWidget that @area is rendering onto - the @widget relative coordinates where one of @area’s cells + the @widget relative coordinates where one of @area’s cells is to be placed - - the return location for the inner cell area + + the return location for the inner cell area - - Returns whether the area can do anything when activated, + + Returns whether the area can do anything when activated, after applying new attributes to @area. - whether @area can do anything when activated. + whether @area can do anything when activated. - a #GtkCellArea + a #GtkCellArea - - Returns whether @sibling is one of @renderer’s focus siblings + + Returns whether @sibling is one of @renderer’s focus siblings (see gtk_cell_area_add_focus_sibling()). - %TRUE if @sibling is a focus sibling of @renderer + %TRUE if @sibling is a focus sibling of @renderer - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer expected to have focus + the #GtkCellRenderer expected to have focus - the #GtkCellRenderer to check against @renderer’s sibling list + the #GtkCellRenderer to check against @renderer’s sibling list - Removes @renderer from @area. + Removes @renderer from @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to remove from @area + the #GtkCellRenderer to remove from @area - - Removes @sibling from @renderer’s focus sibling list + + Removes @sibling from @renderer’s focus sibling list (see gtk_cell_area_add_focus_sibling()). @@ -25147,29 +17882,21 @@ after applying new attributes to @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer expected to have focus + the #GtkCellRenderer expected to have focus - the #GtkCellRenderer to remove from @renderer’s focus area + the #GtkCellRenderer to remove from @renderer’s focus area - Renders @area’s cells according to @area’s layout onto @widget at + Renders @area’s cells according to @area’s layout onto @widget at the given coordinates. @@ -25177,62 +17904,42 @@ the given coordinates. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the #cairo_t to render with + the #cairo_t to render with - the @widget relative coordinates for @area’s background + the @widget relative coordinates for @area’s background - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the #GtkCellRendererState for @area in this row. + the #GtkCellRendererState for @area in this row. - whether @area should paint focus on focused cells for focused rows or not. + whether @area should paint focus on focused cells for focused rows or not. - - This is a convenience function for #GtkCellArea implementations -to request size for cell renderers. It’s important to use this + + This is a convenience function for #GtkCellArea implementations +to request size for cell renderers. It’s important to use this function to request size and then use gtk_cell_area_inner_cell_area() at render and event time since this function will add padding around the cell for focus painting. @@ -25242,66 +17949,38 @@ around the cell for focus painting. - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to request size for + the #GtkCellRenderer to request size for - the #GtkOrientation in which to request size + the #GtkOrientation in which to request size - the #GtkWidget that @area is rendering onto + the #GtkWidget that @area is rendering onto - the allocation contextual size to request for, or -1 if + the allocation contextual size to request for, or -1 if the base request for the orientation is to be returned. - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL - - Explicitly sets the currently focused cell to @renderer. + + Explicitly sets the currently focused cell to @renderer. This is generally called by implementations of #GtkCellAreaClass.focus() or #GtkCellAreaClass.event(), @@ -25313,25 +17992,17 @@ as gtk_tree_view_set_cursor_on_cell(). - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to give focus to + the #GtkCellRenderer to give focus to - - Explicitly stops the editing of the currently edited cell. + + Explicitly stops the editing of the currently edited cell. If @canceled is %TRUE, the currently edited cell renderer will emit the ::editing-canceled signal, otherwise the @@ -25345,44 +18016,31 @@ See gtk_cell_area_get_edited_cell() and gtk_cell_area_get_edit_widget(). - a #GtkCellArea + a #GtkCellArea - whether editing was canceled. + whether editing was canceled. - The widget currently editing the edited cell + The widget currently editing the edited cell This property is read-only and only changes as a result of a call gtk_cell_area_activate_cell(). - The cell in the area that is currently edited + The cell in the area that is currently edited This property is read-only and only changes as a result of a call gtk_cell_area_activate_cell(). - - The cell in the area that currently has focus + + The cell in the area that currently has focus @@ -25392,79 +18050,57 @@ a result of a call gtk_cell_area_activate_cell(). - Indicates that editing has started on @renderer and that @editable + Indicates that editing has started on @renderer and that @editable should be added to the owning cell-layouting widget at @cell_area. - the #GtkCellRenderer that started the edited + the #GtkCellRenderer that started the edited - the #GtkCellEditable widget to add + the #GtkCellEditable widget to add - the #GtkWidget relative #GdkRectangle coordinates + the #GtkWidget relative #GdkRectangle coordinates where @editable should be added - the #GtkTreePath string this edit was initiated for + the #GtkTreePath string this edit was initiated for - This signal is emitted whenever applying attributes to @area from @model + This signal is emitted whenever applying attributes to @area from @model - the #GtkTreeModel to apply the attributes from + the #GtkTreeModel to apply the attributes from - the #GtkTreeIter indicating which row to apply the attributes of + the #GtkTreeIter indicating which row to apply the attributes of - whether the view shows children for this row + whether the view shows children for this row - whether the view is currently showing the children of this row + whether the view is currently showing the children of this row - Indicates that focus changed on this @area. This signal + Indicates that focus changed on this @area. This signal is emitted either as a result of focus handling or event handling. @@ -25477,53 +18113,35 @@ same cell area for a different row of data. - the #GtkCellRenderer that has focus + the #GtkCellRenderer that has focus - the current #GtkTreePath string set for @area + the current #GtkTreePath string set for @area - Indicates that editing finished on @renderer and that @editable + Indicates that editing finished on @renderer and that @editable should be removed from the owning cell-layouting widget. - the #GtkCellRenderer that finished editeding + the #GtkCellRenderer that finished editeding - the #GtkCellEditable widget to remove + the #GtkCellEditable widget to remove - - The #GtkCellAreaBox renders cell renderers into a row or a column + + The #GtkCellAreaBox renders cell renderers into a row or a column depending on its #GtkOrientation. GtkCellAreaBox uses a notion of packing. Packing @@ -25544,48 +18162,30 @@ argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end(). - - Creates a new #GtkCellAreaBox. + + Creates a new #GtkCellAreaBox. - a newly created #GtkCellAreaBox + a newly created #GtkCellAreaBox - - Gets the spacing added between cell renderers. + + Gets the spacing added between cell renderers. - the space added between cell renderers in @box. + the space added between cell renderers in @box. - a #GtkCellAreaBox + a #GtkCellAreaBox - - Adds @renderer to @box, packed with reference to the end of @box. + + Adds @renderer to @box, packed with reference to the end of @box. The @renderer is packed after (away from end of) any other #GtkCellRenderer packed with reference to the end of @box. @@ -25595,44 +18195,30 @@ The @renderer is packed after (away from end of) any other - a #GtkCellAreaBox + a #GtkCellAreaBox - the #GtkCellRenderer to add + the #GtkCellRenderer to add - whether @renderer should receive extra space when the area receives + whether @renderer should receive extra space when the area receives more than its natural size - whether @renderer should be aligned in adjacent rows + whether @renderer should be aligned in adjacent rows - whether @renderer should have the same size in all rows + whether @renderer should have the same size in all rows - - Adds @renderer to @box, packed with reference to the start of @box. + + Adds @renderer to @box, packed with reference to the start of @box. The @renderer is packed after any other #GtkCellRenderer packed with reference to the start of @box. @@ -25642,70 +18228,47 @@ with reference to the start of @box. - a #GtkCellAreaBox + a #GtkCellAreaBox - the #GtkCellRenderer to add + the #GtkCellRenderer to add - whether @renderer should receive extra space when the area receives + whether @renderer should receive extra space when the area receives more than its natural size - whether @renderer should be aligned in adjacent rows + whether @renderer should be aligned in adjacent rows - whether @renderer should have the same size in all rows + whether @renderer should have the same size in all rows - - Sets the spacing to add between cell renderers in @box. + + Sets the spacing to add between cell renderers in @box. - a #GtkCellAreaBox + a #GtkCellAreaBox - the space to add between #GtkCellRenderers + the space to add between #GtkCellRenderers - - The amount of space to reserve between cells. + + The amount of space to reserve between cells. @@ -25715,9 +18278,7 @@ more than its natural size - + @@ -25755,18 +18316,13 @@ more than its natural size - + - + - + @@ -25776,15 +18332,11 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to add to @area + the #GtkCellRenderer to add to @area @@ -25798,15 +18350,11 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellRenderer to remove from @area + the #GtkCellRenderer to remove from @area @@ -25820,27 +18368,15 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - - the #GtkCellCallback to call + + the #GtkCellCallback to call - - user provided data pointer + + user provided data pointer @@ -25854,51 +18390,31 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the @widget relative coordinates and size for @area + the @widget relative coordinates and size for @area - the @widget relative coordinates of the background area + the @widget relative coordinates of the background area - - the #GtkCellAllocCallback to call + + the #GtkCellAllocCallback to call - - user provided data pointer + + user provided data pointer @@ -25908,46 +18424,32 @@ more than its natural size - %TRUE if the event was handled by @area. + %TRUE if the event was handled by @area. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the #GdkEvent to handle + the #GdkEvent to handle - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the #GtkCellRendererState for @area in this row. + the #GtkCellRendererState for @area in this row. @@ -25961,51 +18463,35 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext for this row of data. + the #GtkCellAreaContext for this row of data. - the #GtkWidget that @area is rendering to + the #GtkWidget that @area is rendering to - the #cairo_t to render with + the #cairo_t to render with - the @widget relative coordinates for @area’s background + the @widget relative coordinates for @area’s background - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the #GtkCellRendererState for @area in this row. + the #GtkCellRendererState for @area in this row. - whether @area should paint focus on focused cells for focused rows or not. + whether @area should paint focus on focused cells for focused rows or not. @@ -26019,33 +18505,23 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkTreeModel to pull values from + the #GtkTreeModel to pull values from - the #GtkTreeIter in @tree_model to apply values for + the #GtkTreeIter in @tree_model to apply values for - whether @iter has children + whether @iter has children - whether @iter is expanded in the view and + whether @iter is expanded in the view and children are visible @@ -26056,16 +18532,12 @@ more than its natural size - a newly created #GtkCellAreaContext which can be used with @area. + a newly created #GtkCellAreaContext which can be used with @area. - a #GtkCellArea + a #GtkCellArea @@ -26075,22 +18547,16 @@ more than its natural size - a newly created #GtkCellAreaContext copy of @context. + a newly created #GtkCellAreaContext copy of @context. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to copy + the #GtkCellAreaContext to copy @@ -26100,16 +18566,12 @@ more than its natural size - The #GtkSizeRequestMode preferred by @area. + The #GtkSizeRequestMode preferred by @area. - a #GtkCellArea + a #GtkCellArea @@ -26123,43 +18585,23 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to perform this request with + the #GtkCellAreaContext to perform this request with - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL @@ -26173,49 +18615,27 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext which has already been requested for widths. + the #GtkCellAreaContext which has already been requested for widths. - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - the width for which to check the height of this area + the width for which to check the height of this area - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL @@ -26229,43 +18649,23 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext to perform this request with + the #GtkCellAreaContext to perform this request with - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL @@ -26279,49 +18679,27 @@ more than its natural size - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext which has already been requested for widths. + the #GtkCellAreaContext which has already been requested for widths. - the #GtkWidget where @area will be rendering + the #GtkWidget where @area will be rendering - the height for which to check the width of this area + the height for which to check the width of this area - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL @@ -26381,22 +18759,16 @@ more than its natural size - %TRUE if focus remains inside @area as a result of this call. + %TRUE if focus remains inside @area as a result of this call. - a #GtkCellArea + a #GtkCellArea - the #GtkDirectionType + the #GtkDirectionType @@ -26406,16 +18778,12 @@ more than its natural size - whether @area can do anything when activated. + whether @area can do anything when activated. - a #GtkCellArea + a #GtkCellArea @@ -26425,46 +18793,32 @@ more than its natural size - Whether @area was successfully activated. + Whether @area was successfully activated. - a #GtkCellArea + a #GtkCellArea - the #GtkCellAreaContext in context with the current row data + the #GtkCellAreaContext in context with the current row data - the #GtkWidget that @area is rendering on + the #GtkWidget that @area is rendering on - the size and location of @area relative to @widget’s allocation + the size and location of @area relative to @widget’s allocation - the #GtkCellRendererState flags for @area for this row of data. + the #GtkCellRendererState flags for @area for this row of data. - if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE + if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE will be activated. @@ -26535,77 +18889,51 @@ more than its natural size - - Finds a cell property of a cell area class by name. + + Finds a cell property of a cell area class by name. - the #GParamSpec of the child property + the #GParamSpec of the child property or %NULL if @aclass has no child property with that name. - a #GtkCellAreaClass + a #GtkCellAreaClass - the name of the child property to find + the name of the child property to find - - Installs a cell property on a cell area class. + + Installs a cell property on a cell area class. - a #GtkCellAreaClass + a #GtkCellAreaClass - the id for the property + the id for the property - the #GParamSpec for the property + the #GParamSpec for the property - - Returns all cell properties of a cell area class. + + Returns all cell properties of a cell area class. - a newly + a newly allocated %NULL-terminated array of #GParamSpec*. The array must be freed with g_free(). @@ -26614,47 +18942,30 @@ more than its natural size - a #GtkCellAreaClass + a #GtkCellAreaClass - - location to return the number of cell properties found + + location to return the number of cell properties found - - The #GtkCellAreaContext object is created by a given #GtkCellArea + + The #GtkCellAreaContext object is created by a given #GtkCellArea implementation via its #GtkCellAreaClass.create_context() virtual method and is used to store cell sizes and alignments for a series of #GtkTreeModel rows that are requested and rendered in the same context. #GtkCellLayout widgets can create any number of contexts in which to -request and render groups of data rows. However, it’s important that the +request and render groups of data rows. However, it’s important that the same context which was used to request sizes for a given #GtkTreeModel row also be used for the same row when calling other #GtkCellArea APIs such as gtk_cell_area_render() and gtk_cell_area_event(). - Allocates a width and/or a height for all rows which are to be + Allocates a width and/or a height for all rows which are to be rendered with @context. Usually allocation is performed only horizontally or sometimes @@ -26672,33 +18983,23 @@ Since 3.0 - a #GtkCellAreaContext + a #GtkCellAreaContext - the allocated width for all #GtkTreeModel rows rendered + the allocated width for all #GtkTreeModel rows rendered with @context, or -1. - the allocated height for all #GtkTreeModel rows rendered + the allocated height for all #GtkTreeModel rows rendered with @context, or -1. - - Gets the accumulative preferred height for @width for all rows + + Gets the accumulative preferred height for @width for all rows which have been requested for the same said @width with this context. After gtk_cell_area_context_reset() is called and/or before ever @@ -26709,49 +19010,27 @@ requesting the size of a #GtkCellArea, the returned values are -1. - a #GtkCellAreaContext + a #GtkCellAreaContext - a proposed width for allocation + a proposed width for allocation - - location to store the minimum height, + + location to store the minimum height, or %NULL - - location to store the natural height, + + location to store the natural height, or %NULL - - Gets the accumulative preferred width for @height for all rows which + + Gets the accumulative preferred width for @height for all rows which have been requested for the same said @height with this context. After gtk_cell_area_context_reset() is called and/or before ever @@ -26762,47 +19041,27 @@ requesting the size of a #GtkCellArea, the returned values are -1. - a #GtkCellAreaContext + a #GtkCellAreaContext - a proposed height for allocation + a proposed height for allocation - - location to store the minimum width, + + location to store the minimum width, or %NULL - - location to store the natural width, + + location to store the natural width, or %NULL - Resets any previously cached request and allocation + Resets any previously cached request and allocation data. When underlying #GtkTreeModel data changes its @@ -26832,17 +19091,13 @@ Since 3.0 - a #GtkCellAreaContext + a #GtkCellAreaContext - Allocates a width and/or a height for all rows which are to be + Allocates a width and/or a height for all rows which are to be rendered with @context. Usually allocation is performed only horizontally or sometimes @@ -26860,33 +19115,23 @@ Since 3.0 - a #GtkCellAreaContext + a #GtkCellAreaContext - the allocated width for all #GtkTreeModel rows rendered + the allocated width for all #GtkTreeModel rows rendered with @context, or -1. - the allocated height for all #GtkTreeModel rows rendered + the allocated height for all #GtkTreeModel rows rendered with @context, or -1. - - Fetches the current allocation size for @context. + + Fetches the current allocation size for @context. If the context was not allocated in width or height, or if the context was recently reset with gtk_cell_area_context_reset(), @@ -26897,72 +19142,44 @@ the returned value will be -1. - a #GtkCellAreaContext + a #GtkCellAreaContext - - location to store the allocated width, or %NULL + + location to store the allocated width, or %NULL - - location to store the allocated height, or %NULL + + location to store the allocated height, or %NULL - - Fetches the #GtkCellArea this @context was created by. + + Fetches the #GtkCellArea this @context was created by. This is generally unneeded by layouting widgets; however, it is important for the context implementation itself to fetch information about the area it is being used for. For instance at #GtkCellAreaContextClass.allocate() time -it’s important to know details about any cell spacing +it’s important to know details about any cell spacing that the #GtkCellArea is configured with in order to compute a proper allocation. - the #GtkCellArea this context was created by. + the #GtkCellArea this context was created by. - a #GtkCellAreaContext + a #GtkCellAreaContext - - Gets the accumulative preferred height for all rows which have been + + Gets the accumulative preferred height for all rows which have been requested with this context. After gtk_cell_area_context_reset() is called and/or before ever @@ -26973,43 +19190,23 @@ requesting the size of a #GtkCellArea, the returned values are 0. - a #GtkCellAreaContext + a #GtkCellAreaContext - - location to store the minimum height, + + location to store the minimum height, or %NULL - - location to store the natural height, + + location to store the natural height, or %NULL - - Gets the accumulative preferred height for @width for all rows + + Gets the accumulative preferred height for @width for all rows which have been requested for the same said @width with this context. After gtk_cell_area_context_reset() is called and/or before ever @@ -27020,49 +19217,27 @@ requesting the size of a #GtkCellArea, the returned values are -1. - a #GtkCellAreaContext + a #GtkCellAreaContext - a proposed width for allocation + a proposed width for allocation - - location to store the minimum height, + + location to store the minimum height, or %NULL - - location to store the natural height, + + location to store the natural height, or %NULL - - Gets the accumulative preferred width for all rows which have been + + Gets the accumulative preferred width for all rows which have been requested with this context. After gtk_cell_area_context_reset() is called and/or before ever @@ -27073,43 +19248,23 @@ requesting the size of a #GtkCellArea, the returned values are 0. - a #GtkCellAreaContext + a #GtkCellAreaContext - - location to store the minimum width, + + location to store the minimum width, or %NULL - - location to store the natural width, + + location to store the natural width, or %NULL - - Gets the accumulative preferred width for @height for all rows which + + Gets the accumulative preferred width for @height for all rows which have been requested for the same said @height with this context. After gtk_cell_area_context_reset() is called and/or before ever @@ -27120,49 +19275,27 @@ requesting the size of a #GtkCellArea, the returned values are -1. - a #GtkCellAreaContext + a #GtkCellAreaContext - a proposed height for allocation + a proposed height for allocation - - location to store the minimum width, + + location to store the minimum width, or %NULL - - location to store the natural width, + + location to store the natural width, or %NULL - - Causes the minimum and/or natural height to grow if the new + + Causes the minimum and/or natural height to grow if the new proposed sizes exceed the current minimum and natural height. This is used by #GtkCellAreaContext implementations during @@ -27175,31 +19308,21 @@ gtk_cell_area_get_preferred_height() requests. - a #GtkCellAreaContext + a #GtkCellAreaContext - the proposed new minimum height for @context + the proposed new minimum height for @context - the proposed new natural height for @context + the proposed new natural height for @context - - Causes the minimum and/or natural width to grow if the new + + Causes the minimum and/or natural width to grow if the new proposed sizes exceed the current minimum and natural width. This is used by #GtkCellAreaContext implementations during @@ -27212,29 +19335,21 @@ gtk_cell_area_get_preferred_width() requests. - a #GtkCellAreaContext + a #GtkCellAreaContext - the proposed new minimum width for @context + the proposed new minimum width for @context - the proposed new natural width for @context + the proposed new natural width for @context - Resets any previously cached request and allocation + Resets any previously cached request and allocation data. When underlying #GtkTreeModel data changes its @@ -27264,51 +19379,35 @@ Since 3.0 - a #GtkCellAreaContext + a #GtkCellAreaContext - - The #GtkCellArea this context was created by + + The #GtkCellArea this context was created by - The minimum height for the #GtkCellArea in this context + The minimum height for the #GtkCellArea in this context for all #GtkTreeModel rows that this context was requested for using gtk_cell_area_get_preferred_height(). - The minimum width for the #GtkCellArea in this context + The minimum width for the #GtkCellArea in this context for all #GtkTreeModel rows that this context was requested for using gtk_cell_area_get_preferred_width(). - The natural height for the #GtkCellArea in this context + The natural height for the #GtkCellArea in this context for all #GtkTreeModel rows that this context was requested for using gtk_cell_area_get_preferred_height(). - The natural width for the #GtkCellArea in this context + The natural width for the #GtkCellArea in this context for all #GtkTreeModel rows that this context was requested for using gtk_cell_area_get_preferred_width(). @@ -27317,13 +19416,10 @@ for using gtk_cell_area_get_preferred_width(). - + - + @@ -27336,22 +19432,16 @@ for using gtk_cell_area_get_preferred_width(). - a #GtkCellAreaContext + a #GtkCellAreaContext - the allocated width for all #GtkTreeModel rows rendered + the allocated width for all #GtkTreeModel rows rendered with @context, or -1. - the allocated height for all #GtkTreeModel rows rendered + the allocated height for all #GtkTreeModel rows rendered with @context, or -1. @@ -27366,9 +19456,7 @@ for using gtk_cell_area_get_preferred_width(). - a #GtkCellAreaContext + a #GtkCellAreaContext @@ -27382,38 +19470,20 @@ for using gtk_cell_area_get_preferred_width(). - a #GtkCellAreaContext + a #GtkCellAreaContext - a proposed width for allocation + a proposed width for allocation - - location to store the minimum height, + + location to store the minimum height, or %NULL - - location to store the natural height, + + location to store the natural height, or %NULL @@ -27428,38 +19498,20 @@ for using gtk_cell_area_get_preferred_width(). - a #GtkCellAreaContext + a #GtkCellAreaContext - a proposed height for allocation + a proposed height for allocation - - location to store the minimum width, + + location to store the minimum width, or %NULL - - location to store the natural width, + + location to store the natural width, or %NULL @@ -27515,96 +19567,65 @@ for using gtk_cell_area_get_preferred_width(). - + - The type of the callback functions used for iterating over + The type of the callback functions used for iterating over the cell renderers of a #GtkCellArea, see gtk_cell_area_foreach(). - %TRUE to stop iterating over cells. + %TRUE to stop iterating over cells. - the cell renderer to operate on + the cell renderer to operate on - - user-supplied data + + user-supplied data - - The #GtkCellEditable interface must be implemented for widgets to be usable + + The #GtkCellEditable interface must be implemented for widgets to be usable to edit the contents of a #GtkTreeView cell. It provides a way to specify how temporary widgets should be configured for editing, get the new value, etc. - Emits the #GtkCellEditable::editing-done signal. + Emits the #GtkCellEditable::editing-done signal. - A #GtkCellEditable + A #GtkCellEditable - Emits the #GtkCellEditable::remove-widget signal. + Emits the #GtkCellEditable::remove-widget signal. - A #GtkCellEditable + A #GtkCellEditable - Begins editing on a @cell_editable. + Begins editing on a @cell_editable. The #GtkCellRenderer for the cell creates and returns a #GtkCellEditable from gtk_cell_renderer_start_editing(), configured for the #GtkCellRenderer type. @@ -27620,64 +19641,44 @@ lifetime is temporary and does not persist across other edits and/or cells. - A #GtkCellEditable + A #GtkCellEditable - - The #GdkEvent that began the editing process, or + + The #GdkEvent that began the editing process, or %NULL if editing was initiated programmatically - - Emits the #GtkCellEditable::editing-done signal. + + Emits the #GtkCellEditable::editing-done signal. - A #GtkCellEditable + A #GtkCellEditable - - Emits the #GtkCellEditable::remove-widget signal. + + Emits the #GtkCellEditable::remove-widget signal. - A #GtkCellEditable + A #GtkCellEditable - - Begins editing on a @cell_editable. + + Begins editing on a @cell_editable. The #GtkCellRenderer for the cell creates and returns a #GtkCellEditable from gtk_cell_renderer_start_editing(), configured for the #GtkCellRenderer type. @@ -27693,36 +19694,22 @@ lifetime is temporary and does not persist across other edits and/or cells. - A #GtkCellEditable + A #GtkCellEditable - - The #GdkEvent that began the editing process, or + + The #GdkEvent that began the editing process, or %NULL if editing was initiated programmatically - - Indicates whether editing on the cell has been canceled. + + Indicates whether editing on the cell has been canceled. - This signal is a sign for the cell renderer to update its + This signal is a sign for the cell renderer to update its value from the @cell_editable. Implementations of #GtkCellEditable are responsible for @@ -27738,9 +19725,7 @@ for emitting #GtkCellEditable::editing-done. - This signal is meant to indicate that the cell is finished + This signal is meant to indicate that the cell is finished editing, and the @cell_editable widget is being removed and may subsequently be destroyed. @@ -27757,9 +19742,7 @@ for emitting #GtkCellEditable::remove-widget. - + @@ -27772,9 +19755,7 @@ for emitting #GtkCellEditable::remove-widget. - A #GtkCellEditable + A #GtkCellEditable @@ -27788,9 +19769,7 @@ for emitting #GtkCellEditable::remove-widget. - A #GtkCellEditable + A #GtkCellEditable @@ -27804,18 +19783,11 @@ for emitting #GtkCellEditable::remove-widget. - A #GtkCellEditable + A #GtkCellEditable - - The #GdkEvent that began the editing process, or + + The #GdkEvent that began the editing process, or %NULL if editing was initiated programmatically @@ -27823,15 +19795,8 @@ for emitting #GtkCellEditable::remove-widget. - - #GtkCellLayout is an interface to be implemented by all objects which + + #GtkCellLayout is an interface to be implemented by all objects which want to provide a #GtkTreeViewColumn like API for packing cells, setting attributes and data funcs. @@ -27903,7 +19868,7 @@ combo = g_object_new (GTK_TYPE_COMBO_BOX, "cell-area", my_cell_area, NULL); to use a custom cell area with a combo box. But construct properties are only initialized after instance init() functions have run, which means that using functions which rely on -the existence of the cell area in your subclass’ init() function will +the existence of the cell area in your subclass’ init() function will cause the default cell area to be instantiated. In this case, a provided construct property value will be ignored (with a warning, to alert you to the problem). @@ -27935,52 +19900,38 @@ to support alternative cell areas, you can do so by moving the problematic calls out of init() and into a constructor() for your class. - - Adds an attribute mapping to the list in @cell_layout. + + Adds an attribute mapping to the list in @cell_layout. The @column is the column of the model to get a value from, and the @attribute is the parameter on @cell to be set from the value. So for example if column 2 of the model contains strings, you could have the -“text” attribute of a #GtkCellRendererText get its values from column 2. +“text” attribute of a #GtkCellRendererText get its values from column 2. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - an attribute on the renderer + an attribute on the renderer - the column position on the model to get the attribute from + the column position on the model to get the attribute from - Unsets all the mappings on all renderers on @cell_layout and + Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout. @@ -27988,19 +19939,13 @@ removes all renderers from @cell_layout. - a #GtkCellLayout + a #GtkCellLayout - - Clears all existing attributes previously set with + + Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). @@ -28008,51 +19953,37 @@ gtk_cell_layout_set_attributes(). - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer to clear the attribute mapping on + a #GtkCellRenderer to clear the attribute mapping on - Returns the underlying #GtkCellArea which might be @cell_layout + Returns the underlying #GtkCellArea which might be @cell_layout if called on a #GtkCellArea or might be %NULL if no #GtkCellArea is used by @cell_layout. - the cell area used by @cell_layout, + the cell area used by @cell_layout, or %NULL in case no cell area is used. - a #GtkCellLayout + a #GtkCellLayout - Returns the cell renderers which have been added to @cell_layout. + Returns the cell renderers which have been added to @cell_layout. - + a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. @@ -28062,17 +19993,13 @@ or %NULL in case no cell area is used. - a #GtkCellLayout + a #GtkCellLayout - Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the + Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. @@ -28083,29 +20010,21 @@ Note that reusing the same cell renderer is not supported. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, + Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. @@ -28116,29 +20035,21 @@ Note that reusing the same cell renderer is not supported. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - Re-inserts @cell at @position. + Re-inserts @cell at @position. Note that @cell has already to be packed into @cell_layout for this to function properly. @@ -28148,34 +20059,24 @@ for this to function properly. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer to reorder + a #GtkCellRenderer to reorder - new position to insert @cell at + new position to insert @cell at - - Sets the #GtkCellLayoutDataFunc to use for @cell_layout. + + Sets the #GtkCellLayoutDataFunc to use for @cell_layout. This function is used instead of the standard attributes mapping -for setting the column value, and should set the value of @cell_layout’s +for setting the column value, and should set the value of @cell_layout’s cell renderer(s) as appropriate. @func may be %NULL to remove a previously set function. @@ -28185,92 +20086,59 @@ cell renderer(s) as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - - the #GtkCellLayoutDataFunc to use, or %NULL + + the #GtkCellLayoutDataFunc to use, or %NULL - - user data for @func + + user data for @func - destroy notify for @func_data + destroy notify for @func_data - - Adds an attribute mapping to the list in @cell_layout. + + Adds an attribute mapping to the list in @cell_layout. The @column is the column of the model to get a value from, and the @attribute is the parameter on @cell to be set from the value. So for example if column 2 of the model contains strings, you could have the -“text” attribute of a #GtkCellRendererText get its values from column 2. +“text” attribute of a #GtkCellRendererText get its values from column 2. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - an attribute on the renderer + an attribute on the renderer - the column position on the model to get the attribute from + the column position on the model to get the attribute from - Unsets all the mappings on all renderers on @cell_layout and + Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout. @@ -28278,19 +20146,13 @@ removes all renderers from @cell_layout. - a #GtkCellLayout + a #GtkCellLayout - - Clears all existing attributes previously set with + + Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). @@ -28298,55 +20160,37 @@ gtk_cell_layout_set_attributes(). - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer to clear the attribute mapping on + a #GtkCellRenderer to clear the attribute mapping on - - Returns the underlying #GtkCellArea which might be @cell_layout + + Returns the underlying #GtkCellArea which might be @cell_layout if called on a #GtkCellArea or might be %NULL if no #GtkCellArea is used by @cell_layout. - the cell area used by @cell_layout, + the cell area used by @cell_layout, or %NULL in case no cell area is used. - a #GtkCellLayout + a #GtkCellLayout - - Returns the cell renderers which have been added to @cell_layout. + + Returns the cell renderers which have been added to @cell_layout. - + a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. @@ -28356,19 +20200,13 @@ or %NULL in case no cell area is used. - a #GtkCellLayout + a #GtkCellLayout - - Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the + + Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. @@ -28379,31 +20217,21 @@ Note that reusing the same cell renderer is not supported. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - - Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, + + Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. @@ -28414,31 +20242,21 @@ Note that reusing the same cell renderer is not supported. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - - Re-inserts @cell at @position. + + Re-inserts @cell at @position. Note that @cell has already to be packed into @cell_layout for this to function properly. @@ -28448,32 +20266,21 @@ for this to function properly. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer to reorder + a #GtkCellRenderer to reorder - new position to insert @cell at + new position to insert @cell at - - Sets the attributes in list as the attributes of @cell_layout. + + Sets the attributes in list as the attributes of @cell_layout. The attributes should be in attribute/column order, as in gtk_cell_layout_add_attribute(). All existing attributes are @@ -28484,34 +20291,24 @@ removed, and replaced with the new attributes. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - a %NULL-terminated list of attributes + a %NULL-terminated list of attributes - - Sets the #GtkCellLayoutDataFunc to use for @cell_layout. + + Sets the #GtkCellLayoutDataFunc to use for @cell_layout. This function is used instead of the standard attributes mapping -for setting the column value, and should set the value of @cell_layout’s +for setting the column value, and should set the value of @cell_layout’s cell renderer(s) as appropriate. @func may be %NULL to remove a previously set function. @@ -28521,51 +20318,30 @@ cell renderer(s) as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - - the #GtkCellLayoutDataFunc to use, or %NULL + + the #GtkCellLayoutDataFunc to use, or %NULL - - user data for @func + + user data for @func - destroy notify for @func_data + destroy notify for @func_data - A function which should set the value of @cell_layout’s cell renderer(s) + A function which should set the value of @cell_layout’s cell renderer(s) as appropriate. @@ -28573,44 +20349,28 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - the cell renderer whose value is to be set + the cell renderer whose value is to be set - the model + the model - a #GtkTreeIter indicating the row to set the value for + a #GtkTreeIter indicating the row to set the value for - - user data passed to gtk_cell_layout_set_cell_data_func() + + user data passed to gtk_cell_layout_set_cell_data_func() - + @@ -28623,21 +20383,15 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout @@ -28651,21 +20405,15 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout @@ -28679,9 +20427,7 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout @@ -28695,27 +20441,19 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - an attribute on the renderer + an attribute on the renderer - the column position on the model to get the attribute from + the column position on the model to get the attribute from @@ -28729,42 +20467,23 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer + a #GtkCellRenderer - - the #GtkCellLayoutDataFunc to use, or %NULL + + the #GtkCellLayoutDataFunc to use, or %NULL - - user data for @func + + user data for @func - destroy notify for @func_data + destroy notify for @func_data @@ -28778,15 +20497,11 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer to clear the attribute mapping on + a #GtkCellRenderer to clear the attribute mapping on @@ -28800,21 +20515,15 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout - a #GtkCellRenderer to reorder + a #GtkCellRenderer to reorder - new position to insert @cell at + new position to insert @cell at @@ -28824,9 +20533,7 @@ as appropriate. - + a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. @@ -28836,9 +20543,7 @@ as appropriate. - a #GtkCellLayout + a #GtkCellLayout @@ -28848,58 +20553,45 @@ as appropriate. - the cell area used by @cell_layout, + the cell area used by @cell_layout, or %NULL in case no cell area is used. - a #GtkCellLayout + a #GtkCellLayout - - The #GtkCellRenderer is a base class of a set of objects used for + + The #GtkCellRenderer is a base class of a set of objects used for rendering a cell to a #cairo_t. These objects are used primarily by -the #GtkTreeView widget, though they aren’t tied to them in any +the #GtkTreeView widget, though they aren’t tied to them in any specific way. It is worth noting that #GtkCellRenderer is not a #GtkWidget and cannot be treated as such. The primary use of a #GtkCellRenderer is for drawing a certain graphical elements on a #cairo_t. Typically, one cell renderer is used to -draw many cells on the screen. To this extent, it isn’t expected that a +draw many cells on the screen. To this extent, it isn’t expected that a CellRenderer keep any permanent state around. Instead, any state is set just prior to use using #GObjects property system. Then, the cell is measured using gtk_cell_renderer_get_size(). Finally, the cell is rendered in the correct location using gtk_cell_renderer_render(). There are a number of rules that must be followed when writing a new -#GtkCellRenderer. First and foremost, it’s important that a certain set +#GtkCellRenderer. First and foremost, it’s important that a certain set of properties will always yield a cell renderer of the same size, barring a #GtkStyle change. The #GtkCellRenderer also has a number of generic properties that are expected to be honored by all children. Beyond merely rendering a cell, cell renderers can optionally provide active user interface elements. A cell renderer can be -“activatable” like #GtkCellRendererToggle, +“activatable” like #GtkCellRendererToggle, which toggles when it gets activated by a mouse click, or it can be -“editable” like #GtkCellRendererText, which +“editable” like #GtkCellRendererText, which allows the user to edit the text using a widget implementing the #GtkCellEditable interface, e.g. #GtkEntry. To make a cell renderer activatable or editable, you have to @@ -28907,65 +20599,47 @@ implement the #GtkCellRendererClass.activate or #GtkCellRendererClass.start_editing virtual functions, respectively. Many properties of #GtkCellRenderer and its subclasses have a -corresponding “set” property, e.g. “cell-background-set” corresponds -to “cell-background”. These “set” properties reflect whether a property +corresponding “set” property, e.g. “cell-background-set” corresponds +to “cell-background”. These “set” properties reflect whether a property has been set or not. You should not set them independently. - Passes an activate event to the cell renderer for possible processing. + Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, #GtkCellRendererToggle toggles when it gets a mouse click. - %TRUE if the event was consumed/handled + %TRUE if the event was consumed/handled - a #GtkCellRenderer + a #GtkCellRenderer - a #GdkEvent + a #GdkEvent - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags @@ -28998,12 +20672,8 @@ toggles when it gets a mouse click. - - Gets the aligned area used by @cell inside @cell_area. Used for finding + + Gets the aligned area used by @cell inside @cell_area. Used for finding the appropriate edit and focus rectangle. @@ -29011,94 +20681,55 @@ the appropriate edit and focus rectangle. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - render flags + render flags - cell area which would be passed to gtk_cell_renderer_render() + cell area which would be passed to gtk_cell_renderer_render() - - the return location for the space inside @cell_area + + the return location for the space inside @cell_area that would acually be used to render. - - Retreives a renderer’s natural size when rendered to @widget. + + Retreives a renderer’s natural size when rendered to @widget. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL - - Retreives a cell renderers’s minimum and natural height if it were rendered to + + Retreives a cell renderers’s minimum and natural height if it were rendered to @widget with the specified @width. @@ -29106,100 +20737,54 @@ the appropriate edit and focus rectangle. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the preferred size, or %NULL + + location for storing the preferred size, or %NULL - - Retreives a renderer’s natural size when rendered to @widget. + + Retreives a renderer’s natural size when rendered to @widget. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL - - Retreives a cell renderers’s minimum and natural width if it were rendered to + + Retreives a cell renderers’s minimum and natural width if it were rendered to @widget with the specified @height. @@ -29207,77 +20792,44 @@ the appropriate edit and focus rectangle. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the preferred size, or %NULL + + location for storing the preferred size, or %NULL - - Gets whether the cell renderer prefers a height-for-width layout + + Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. - The #GtkSizeRequestMode preferred by this renderer. + The #GtkSizeRequestMode preferred by this renderer. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - - Obtains the width and height needed to render the cell. Used by view + + Obtains the width and height needed to render the cell. Used by view widgets to determine the appropriate size for the cell_area passed to gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y offsets (if set) of the cell relative to this location. @@ -29291,76 +20843,37 @@ in @x_offset and @y_offset are inclusive of the xpad and ypad properties. - a #GtkCellRenderer + a #GtkCellRenderer - the widget the renderer is rendering to + the widget the renderer is rendering to - - The area a cell will be allocated, or %NULL + + The area a cell will be allocated, or %NULL - - location to return x offset of cell relative to @cell_area, or %NULL + + location to return x offset of cell relative to @cell_area, or %NULL - - location to return y offset of cell relative to @cell_area, or %NULL + + location to return y offset of cell relative to @cell_area, or %NULL - - location to return width needed to render a cell, or %NULL + + location to return width needed to render a cell, or %NULL - - location to return height needed to render a cell, or %NULL + + location to return height needed to render a cell, or %NULL - Invokes the virtual render function of the #GtkCellRenderer. The three + Invokes the virtual render function of the #GtkCellRenderer. The three passed-in rectangles are areas in @cr. Most renderers will draw within @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer should be honored with respect to @cell_area. @background_area includes the @@ -29373,171 +20886,116 @@ so the @background_area rectangles for all cells tile to cover the entire - a #GtkCellRenderer + a #GtkCellRenderer - a cairo context to draw to + a cairo context to draw to - the widget owning @window + the widget owning @window - entire cell area (including tree expanders and maybe + entire cell area (including tree expanders and maybe padding on the sides) - area normally rendered by a cell renderer + area normally rendered by a cell renderer - flags that affect rendering + flags that affect rendering - Starts editing the contents of this @cell, through a new #GtkCellEditable + Starts editing the contents of this @cell, through a new #GtkCellEditable widget created by the #GtkCellRendererClass.start_editing virtual function. - A new #GtkCellEditable for editing this + A new #GtkCellEditable for editing this @cell, or %NULL if editing is not possible - a #GtkCellRenderer + a #GtkCellRenderer - - a #GdkEvent + + a #GdkEvent - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags - Passes an activate event to the cell renderer for possible processing. + Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, #GtkCellRendererToggle toggles when it gets a mouse click. - %TRUE if the event was consumed/handled + %TRUE if the event was consumed/handled - a #GtkCellRenderer + a #GtkCellRenderer - a #GdkEvent + a #GdkEvent - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags - - Gets the aligned area used by @cell inside @cell_area. Used for finding + + Gets the aligned area used by @cell inside @cell_area. Used for finding the appropriate edit and focus rectangle. @@ -29545,216 +21003,118 @@ the appropriate edit and focus rectangle. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - render flags + render flags - cell area which would be passed to gtk_cell_renderer_render() + cell area which would be passed to gtk_cell_renderer_render() - - the return location for the space inside @cell_area + + the return location for the space inside @cell_area that would acually be used to render. - - Fills in @xalign and @yalign with the appropriate values of @cell. + + Fills in @xalign and @yalign with the appropriate values of @cell. - A #GtkCellRenderer + A #GtkCellRenderer - - location to fill in with the x alignment of the cell, or %NULL + + location to fill in with the x alignment of the cell, or %NULL - - location to fill in with the y alignment of the cell, or %NULL + + location to fill in with the y alignment of the cell, or %NULL - - Fills in @width and @height with the appropriate size of @cell. + + Fills in @width and @height with the appropriate size of @cell. - A #GtkCellRenderer + A #GtkCellRenderer - - location to fill in with the fixed width of the cell, or %NULL + + location to fill in with the fixed width of the cell, or %NULL - - location to fill in with the fixed height of the cell, or %NULL + + location to fill in with the fixed height of the cell, or %NULL - - Fills in @xpad and @ypad with the appropriate values of @cell. + + Fills in @xpad and @ypad with the appropriate values of @cell. - A #GtkCellRenderer + A #GtkCellRenderer - - location to fill in with the x padding of the cell, or %NULL + + location to fill in with the x padding of the cell, or %NULL - - location to fill in with the y padding of the cell, or %NULL + + location to fill in with the y padding of the cell, or %NULL - - Retreives a renderer’s natural size when rendered to @widget. + + Retreives a renderer’s natural size when rendered to @widget. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL - - Retreives a cell renderers’s minimum and natural height if it were rendered to + + Retreives a cell renderers’s minimum and natural height if it were rendered to @widget with the specified @width. @@ -29762,148 +21122,80 @@ the appropriate edit and focus rectangle. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the preferred size, or %NULL + + location for storing the preferred size, or %NULL - - Retrieves the minimum and natural size of a cell taking -into account the widget’s preference for height-for-width management. + + Retrieves the minimum and natural size of a cell taking +into account the widget’s preference for height-for-width management. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the natural size, or %NULL + + location for storing the natural size, or %NULL - - Retreives a renderer’s natural size when rendered to @widget. + + Retreives a renderer’s natural size when rendered to @widget. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL - - Retreives a cell renderers’s minimum and natural width if it were rendered to + + Retreives a cell renderers’s minimum and natural width if it were rendered to @widget with the specified @height. @@ -29911,99 +21203,58 @@ into account the widget’s preference for height-for-width management. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the preferred size, or %NULL + + location for storing the preferred size, or %NULL - - Gets whether the cell renderer prefers a height-for-width layout + + Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. - The #GtkSizeRequestMode preferred by this renderer. + The #GtkSizeRequestMode preferred by this renderer. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - - Returns the cell renderer’s sensitivity. + + Returns the cell renderer’s sensitivity. - %TRUE if the cell renderer is sensitive + %TRUE if the cell renderer is sensitive - A #GtkCellRenderer + A #GtkCellRenderer - - Obtains the width and height needed to render the cell. Used by view + + Obtains the width and height needed to render the cell. Used by view widgets to determine the appropriate size for the cell_area passed to gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y offsets (if set) of the cell relative to this location. @@ -30017,162 +21268,89 @@ in @x_offset and @y_offset are inclusive of the xpad and ypad properties. - a #GtkCellRenderer + a #GtkCellRenderer - the widget the renderer is rendering to + the widget the renderer is rendering to - - The area a cell will be allocated, or %NULL + + The area a cell will be allocated, or %NULL - - location to return x offset of cell relative to @cell_area, or %NULL + + location to return x offset of cell relative to @cell_area, or %NULL - - location to return y offset of cell relative to @cell_area, or %NULL + + location to return y offset of cell relative to @cell_area, or %NULL - - location to return width needed to render a cell, or %NULL + + location to return width needed to render a cell, or %NULL - - location to return height needed to render a cell, or %NULL + + location to return height needed to render a cell, or %NULL - - Translates the cell renderer state to #GtkStateFlags, + + Translates the cell renderer state to #GtkStateFlags, based on the cell renderer and widget sensitivity, and the given #GtkCellRendererState. - the widget state flags applying to @cell + the widget state flags applying to @cell - - a #GtkCellRenderer, or %NULL + + a #GtkCellRenderer, or %NULL - - a #GtkWidget, or %NULL + + a #GtkWidget, or %NULL - cell renderer state + cell renderer state - - Returns the cell renderer’s visibility. + + Returns the cell renderer’s visibility. - %TRUE if the cell renderer is visible + %TRUE if the cell renderer is visible - A #GtkCellRenderer + A #GtkCellRenderer - - Checks whether the cell renderer can do something when activated. + + Checks whether the cell renderer can do something when activated. - %TRUE if the cell renderer can do anything when activated + %TRUE if the cell renderer can do anything when activated - A #GtkCellRenderer + A #GtkCellRenderer - Invokes the virtual render function of the #GtkCellRenderer. The three + Invokes the virtual render function of the #GtkCellRenderer. The three passed-in rectangles are areas in @cr. Most renderers will draw within @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer should be honored with respect to @cell_area. @background_area includes the @@ -30185,255 +21363,172 @@ so the @background_area rectangles for all cells tile to cover the entire - a #GtkCellRenderer + a #GtkCellRenderer - a cairo context to draw to + a cairo context to draw to - the widget owning @window + the widget owning @window - entire cell area (including tree expanders and maybe + entire cell area (including tree expanders and maybe padding on the sides) - area normally rendered by a cell renderer + area normally rendered by a cell renderer - flags that affect rendering + flags that affect rendering - - Sets the renderer’s alignment within its available space. + + Sets the renderer’s alignment within its available space. - A #GtkCellRenderer + A #GtkCellRenderer - the x alignment of the cell renderer + the x alignment of the cell renderer - the y alignment of the cell renderer + the y alignment of the cell renderer - - Sets the renderer size to be explicit, independent of the properties set. + + Sets the renderer size to be explicit, independent of the properties set. - A #GtkCellRenderer + A #GtkCellRenderer - the width of the cell renderer, or -1 + the width of the cell renderer, or -1 - the height of the cell renderer, or -1 + the height of the cell renderer, or -1 - - Sets the renderer’s padding. + + Sets the renderer’s padding. - A #GtkCellRenderer + A #GtkCellRenderer - the x padding of the cell renderer + the x padding of the cell renderer - the y padding of the cell renderer + the y padding of the cell renderer - - Sets the cell renderer’s sensitivity. + + Sets the cell renderer’s sensitivity. - A #GtkCellRenderer + A #GtkCellRenderer - the sensitivity of the cell + the sensitivity of the cell - - Sets the cell renderer’s visibility. + + Sets the cell renderer’s visibility. - A #GtkCellRenderer + A #GtkCellRenderer - the visibility of the cell + the visibility of the cell - - Starts editing the contents of this @cell, through a new #GtkCellEditable + + Starts editing the contents of this @cell, through a new #GtkCellEditable widget created by the #GtkCellRendererClass.start_editing virtual function. - A new #GtkCellEditable for editing this + A new #GtkCellEditable for editing this @cell, or %NULL if editing is not possible - a #GtkCellRenderer + a #GtkCellRenderer - - a #GdkEvent + + a #GdkEvent - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags - - Informs the cell renderer that the editing is stopped. + + Informs the cell renderer that the editing is stopped. If @canceled is %TRUE, the cell renderer will emit the #GtkCellRenderer::editing-canceled signal. @@ -30446,48 +21541,28 @@ in response to the #GtkCellEditable::editing-done signal of - A #GtkCellRenderer + A #GtkCellRenderer - %TRUE if the editing has been canceled + %TRUE if the editing has been canceled - + - - Cell background as a #GdkColor + + Cell background as a #GdkColor Use #GtkCellRenderer:cell-background-rgba instead. - - Cell background as a #GdkRGBA + + Cell background as a #GdkRGBA - + @@ -30533,9 +21608,7 @@ in response to the #GtkCellEditable::editing-done signal of - This signal gets emitted when the user cancels the process of editing a + This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape. @@ -30545,15 +21618,13 @@ See also: gtk_cell_renderer_stop_editing(). - This signal gets emitted when a cell starts to be edited. + This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on @editable, e.g. adding a #GtkEntryCompletion or setting up additional columns in a #GtkComboBox. See gtk_cell_editable_start_editing() for information on the lifecycle of -the @editable and a way to do setup that doesn’t depend on the @renderer. +the @editable and a way to do setup that doesn’t depend on the @renderer. Note that GTK+ doesn't guarantee that cell renderers will continue to use the same kind of widget for editing in future @@ -30581,46 +21652,28 @@ text_editing_started (GtkCellRenderer *cell, - the #GtkCellEditable + the #GtkCellEditable - the path identifying the edited cell + the path identifying the edited cell - - #GtkCellRendererAccel displays a keyboard accelerator (i.e. a key + + #GtkCellRendererAccel displays a keyboard accelerator (i.e. a key combination like `Control + a`). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination. The #GtkCellRendererAccel cell renderer was added in GTK+ 2.10. - - Creates a new #GtkCellRendererAccel. + + Creates a new #GtkCellRendererAccel. - the new cell renderer + the new cell renderer @@ -30661,43 +21714,23 @@ The #GtkCellRendererAccel cell renderer was added in GTK+ 2.10. - - The keyval of the accelerator. + + The keyval of the accelerator. - - Determines if the edited accelerators are GTK+ accelerators. If + + Determines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus. - - The modifier mask of the accelerator. + + The modifier mask of the accelerator. - - The hardware keycode of the accelerator. Note that the hardware keycode is + + The hardware keycode of the accelerator. Note that the hardware keycode is only relevant if the key does not have a keyval. Normally, the keyboard configuration should assign keyvals to all keys. @@ -30706,63 +21739,46 @@ configuration should assign keyvals to all keys. - + - Gets emitted when the user has removed the accelerator. + Gets emitted when the user has removed the accelerator. - the path identifying the row of the edited cell + the path identifying the row of the edited cell - Gets emitted when the user has selected a new accelerator. + Gets emitted when the user has selected a new accelerator. - the path identifying the row of the edited cell + the path identifying the row of the edited cell - the new accelerator keyval + the new accelerator keyval - the new acclerator modifier mask + the new acclerator modifier mask - the keycode of the new accelerator + the keycode of the new accelerator - + @@ -30849,60 +21865,36 @@ configuration should assign keyvals to all keys. - - Determines if the edited accelerators are GTK+ accelerators. If + + Determines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus. - - GTK+ accelerators mode + + GTK+ accelerators mode - - Other accelerator mode + + Other accelerator mode - + - + - + - The #GtkSizeRequestMode preferred by this renderer. + The #GtkSizeRequestMode preferred by this renderer. - a #GtkCellRenderer instance + a #GtkCellRenderer instance @@ -30916,37 +21908,19 @@ in the same way as they are in menus. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL @@ -30960,43 +21934,23 @@ in the same way as they are in menus. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the preferred size, or %NULL + + location for storing the preferred size, or %NULL @@ -31010,37 +21964,19 @@ in the same way as they are in menus. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - - location to store the minimum size, or %NULL + + location to store the minimum size, or %NULL - - location to store the natural size, or %NULL + + location to store the natural size, or %NULL @@ -31054,43 +21990,23 @@ in the same way as they are in menus. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the preferred size, or %NULL + + location for storing the preferred size, or %NULL @@ -31104,36 +22020,23 @@ in the same way as they are in menus. - a #GtkCellRenderer instance + a #GtkCellRenderer instance - the #GtkWidget this cell will be rendering to + the #GtkWidget this cell will be rendering to - render flags + render flags - cell area which would be passed to gtk_cell_renderer_render() + cell area which would be passed to gtk_cell_renderer_render() - - the return location for the space inside @cell_area + + the return location for the space inside @cell_area that would acually be used to render. @@ -31148,68 +22051,31 @@ in the same way as they are in menus. - a #GtkCellRenderer + a #GtkCellRenderer - the widget the renderer is rendering to + the widget the renderer is rendering to - - The area a cell will be allocated, or %NULL + + The area a cell will be allocated, or %NULL - - location to return x offset of cell relative to @cell_area, or %NULL + + location to return x offset of cell relative to @cell_area, or %NULL - - location to return y offset of cell relative to @cell_area, or %NULL + + location to return y offset of cell relative to @cell_area, or %NULL - - location to return width needed to render a cell, or %NULL + + location to return width needed to render a cell, or %NULL - - location to return height needed to render a cell, or %NULL + + location to return height needed to render a cell, or %NULL @@ -31223,40 +22089,28 @@ in the same way as they are in menus. - a #GtkCellRenderer + a #GtkCellRenderer - a cairo context to draw to + a cairo context to draw to - the widget owning @window + the widget owning @window - entire cell area (including tree expanders and maybe + entire cell area (including tree expanders and maybe padding on the sides) - area normally rendered by a cell renderer + area normally rendered by a cell renderer - flags that affect rendering + flags that affect rendering @@ -31266,53 +22120,37 @@ in the same way as they are in menus. - %TRUE if the event was consumed/handled + %TRUE if the event was consumed/handled - a #GtkCellRenderer + a #GtkCellRenderer - a #GdkEvent + a #GdkEvent - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags @@ -31322,57 +22160,38 @@ in the same way as they are in menus. - A new #GtkCellEditable for editing this + A new #GtkCellEditable for editing this @cell, or %NULL if editing is not possible - a #GtkCellRenderer + a #GtkCellRenderer - - a #GdkEvent + + a #GdkEvent - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags @@ -31411,8 +22230,7 @@ in the same way as they are in menus. - + @@ -31438,11 +22256,8 @@ in the same way as they are in menus. - - Sets the type to be used for creating accessibles for cells rendered by + + Sets the type to be used for creating accessibles for cells rendered by cell renderers of @renderer_class. Note that multiple accessibles will be created. @@ -31454,36 +22269,22 @@ renderers. - class to set the accessible type for + class to set the accessible type for - The object type that implements the accessible for @widget_class. + The object type that implements the accessible for @widget_class. The type must be a subtype of #GtkRendererCellAccessible - + - - #GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from + + #GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from which it is derived. But while #GtkCellRendererText offers a simple entry to edit the text, #GtkCellRendererCombo offers a #GtkComboBox widget to edit the text. The values to display in the combo box are taken from @@ -31496,53 +22297,32 @@ can be set in a handler for the #GtkCellRenderer::editing-started signal. The #GtkCellRendererCombo cell renderer was added in GTK+ 2.6. - - Creates a new #GtkCellRendererCombo. + + Creates a new #GtkCellRendererCombo. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you can bind a property to a value -in a #GtkTreeModel. For example, you can bind the “text” property +in a #GtkTreeModel. For example, you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the #GtkTreeView. - the new cell renderer + the new cell renderer - - If %TRUE, the cell renderer will include an entry and allow to enter + + If %TRUE, the cell renderer will include an entry and allow to enter values other than the ones in the popup list. - - Holds a tree model containing the possible values for the combo box. + + Holds a tree model containing the possible values for the combo box. Use the text_column property to specify the column holding the values. - - Specifies the model column which holds the possible values for the + + Specifies the model column which holds the possible values for the combo box. Note that this refers to the model specified in the model property, @@ -31557,13 +22337,10 @@ this column to its combo box. - + - This signal is emitted each time after the user selected an item in + This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to GtkComboBox, GtkCellRendererCombo::changed is not emitted for changes made to a selected item in the entry. The argument @new_iter @@ -31579,25 +22356,19 @@ until the combo cell renderer emits the edited or editing_canceled signal. - a string of the path identifying the edited cell + a string of the path identifying the edited cell (relative to the tree view model) - the new iter selected in the combo box + the new iter selected in the combo box (relative to the combo box model) - + @@ -31635,56 +22406,26 @@ until the combo cell renderer emits the edited or editing_canceled signal. - + - - Identifies how the user can interact with a particular cell. - - The cell is just for display - and cannot be interacted with. Note that this doesn’t mean that eg. the - row being drawn can’t be selected -- just that a particular element of + + Identifies how the user can interact with a particular cell. + + The cell is just for display + and cannot be interacted with. Note that this doesn’t mean that eg. the + row being drawn can’t be selected -- just that a particular element of it cannot be individually modified. - - The cell can be clicked. + + The cell can be clicked. - - The cell can be edited or otherwise modified. + + The cell can be edited or otherwise modified. - - A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows + + A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows to render either a given #GdkPixbuf (set via the #GtkCellRendererPixbuf:pixbuf property) or a named icon (set via the #GtkCellRendererPixbuf:icon-name property). @@ -31698,54 +22439,33 @@ and the #GtkCellRendererPixbuf:pixbuf-expander-closed property is set to a pixbuf, it renders that one. - Creates a new #GtkCellRendererPixbuf. Adjust rendering + Creates a new #GtkCellRendererPixbuf. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you can bind a property to a value in a #GtkTreeModel. For example, you -can bind the “pixbuf” property on the cell renderer to a pixbuf value +can bind the “pixbuf” property on the cell renderer to a pixbuf value in the model, thus rendering a different image in each row of the #GtkTreeView. - the new cell renderer + the new cell renderer - - Specifies whether the rendered pixbuf should be colorized + + Specifies whether the rendered pixbuf should be colorized according to the #GtkCellRendererState. Cell renderers always follow state. - - The GIcon representing the icon to display. + + The GIcon representing the icon to display. If the icon theme is changed, the image will be updated automatically. - - The name of the themed icon to display. + + The name of the themed icon to display. This property only has an effect if not overridden by "stock_id" or "pixbuf" properties. @@ -31753,54 +22473,34 @@ or "pixbuf" properties. - + - + - + Use #GtkCellRendererPixbuf:icon-name instead. - - The #GtkIconSize value that specifies the size of the rendered icon. + + The #GtkIconSize value that specifies the size of the rendered icon. - + - + - + @@ -31838,55 +22538,32 @@ or "pixbuf" properties. - + - + - - #GtkCellRendererProgress renders a numeric value as a progress par in a cell. + + #GtkCellRendererProgress renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar. The #GtkCellRendererProgress cell renderer was added in GTK+ 2.6. - - Creates a new #GtkCellRendererProgress. + + Creates a new #GtkCellRendererProgress. - the new cell renderer + the new cell renderer - - Setting this to a non-negative value causes the cell renderer to + + Setting this to a non-negative value causes the cell renderer to enter "activity mode", where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much. @@ -31898,47 +22575,27 @@ To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to %G_MAXINT. - - The "text" property determines the label which will be drawn + + The "text" property determines the label which will be drawn over the progress bar. Setting this property to %NULL causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed. - - The "text-xalign" property controls the horizontal alignment of the + + The "text-xalign" property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts. - - The "text-yalign" property controls the vertical alignment of the + + The "text-yalign" property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom). - - The "value" property determines the percentage to which the + + The "value" property determines the percentage to which the progress bar will be "filled in". @@ -31946,13 +22603,10 @@ progress bar will be "filled in". - + - + @@ -31990,21 +22644,11 @@ progress bar will be "filled in". - + - - #GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from + + #GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from which it is derived. But while #GtkCellRendererText offers a simple entry to edit the text, #GtkCellRendererSpin offers a #GtkSpinButton widget. Of course, that means that the text has to be parseable as a floating point number. @@ -32018,59 +22662,35 @@ can be set in a handler for the #GtkCellRenderer::editing-started signal. The #GtkCellRendererSpin cell renderer was added in GTK+ 2.10. - - Creates a new #GtkCellRendererSpin. + + Creates a new #GtkCellRendererSpin. - a new #GtkCellRendererSpin + a new #GtkCellRendererSpin - - The adjustment that holds the value of the spinbutton. + + The adjustment that holds the value of the spinbutton. This must be non-%NULL for the cell renderer to be editable. - - The acceleration rate when you hold down a button. + + The acceleration rate when you hold down a button. - - The number of decimal places to display. + + The number of decimal places to display. - + - + @@ -32108,21 +22728,11 @@ This must be non-%NULL for the cell renderer to be editable. - + - - GtkCellRendererSpinner renders a spinning animation in a cell, very + + GtkCellRendererSpinner renders a spinning animation in a cell, very similar to #GtkSpinner. It can often be used as an alternative to a #GtkCellRendererProgress for displaying indefinite activity, instead of actual progress. @@ -32133,57 +22743,38 @@ at regular intervals. The usual way to set the cell renderer properties for each cell is to bind them to columns in your tree model using e.g. gtk_tree_view_column_add_attribute(). - - Returns a new cell renderer which will show a spinner to indicate + + Returns a new cell renderer which will show a spinner to indicate activity. - a new #GtkCellRenderer + a new #GtkCellRenderer - - Pulse of the spinner. Increment this value to draw the next frame of the + + Pulse of the spinner. Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout. By default, the #GtkSpinner widget draws one full cycle of the animation, consisting of 12 frames, in 750 milliseconds. - - The #GtkIconSize value that specifies the size of the rendered spinner. + + The #GtkIconSize value that specifies the size of the rendered spinner. - + - + @@ -32221,86 +22812,36 @@ consisting of 12 frames, in 750 milliseconds. - + - - Tells how a cell is to be rendered. - - The cell is currently selected, and + + Tells how a cell is to be rendered. + + The cell is currently selected, and probably has a selection colored background to render to. - - The mouse is hovering over the cell. + + The mouse is hovering over the cell. - - The cell is drawn in an insensitive manner + + The cell is drawn in an insensitive manner - - The cell is in a sorted row + + The cell is in a sorted row - - The cell is in the focus row. + + The cell is in the focus row. - - The cell is in a row that can be expanded. Since 3.4 + + The cell is in a row that can be expanded. Since 3.4 - - The cell is in a row that is expanded. Since 3.4 + + The cell is in a row that is expanded. Since 3.4 - - A #GtkCellRendererText renders a given text in its cell, using the font, color and + + A #GtkCellRendererText renders a given text in its cell, using the font, color and style information provided by its properties. The text will be ellipsized if it is too long and the #GtkCellRendererText:ellipsize property allows it. @@ -32308,20 +22849,16 @@ If the #GtkCellRenderer:mode is %GTK_CELL_RENDERER_MODE_EDITABLE, the #GtkCellRendererText allows to edit its text using an entry. - Creates a new #GtkCellRendererText. Adjust how text is drawn using + Creates a new #GtkCellRendererText. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you can bind a property to a value in a #GtkTreeModel. For example, -you can bind the “text” property on the cell renderer to a string +you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the #GtkTreeView - the new cell renderer + the new cell renderer @@ -32331,8 +22868,7 @@ of the #GtkTreeView - + @@ -32343,12 +22879,9 @@ of the #GtkTreeView - - Sets the height of a renderer to explicitly be determined by the “font” and -“y_pad” property set on it. Further changes in these properties do not + + Sets the height of a renderer to explicitly be determined by the “font” and +“y_pad” property set on it. Further changes in these properties do not affect the height, so they must be accompanied by a subsequent call to this function. Using this function is unflexible, and should really only be used if calculating the size of a cell is too slow (ie, a massive number of cells @@ -32360,15 +22893,11 @@ the height is determined by the properties again. - A #GtkCellRendererText + A #GtkCellRendererText - Number of rows of text each cell renderer is allocated, or -1 + Number of rows of text each cell renderer is allocated, or -1 @@ -32376,13 +22905,8 @@ the height is determined by the properties again. - - Specifies how to align the lines of text with respect to each other. + + Specifies how to align the lines of text with respect to each other. Note that this property describes how to align the lines of text in case there are several of them. The "xalign" property of #GtkCellRenderer, @@ -32392,30 +22916,16 @@ on the other hand, sets the horizontal alignment of the whole text. - + - - Background color as a #GdkColor + + Background color as a #GdkColor Use #GtkCellRendererText:background-rgba instead. - - Background color as a #GdkRGBA + + Background color as a #GdkRGBA @@ -32427,13 +22937,8 @@ on the other hand, sets the horizontal alignment of the whole text. - - Specifies the preferred place to ellipsize the string, if the cell renderer + + Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string. Setting it to %PANGO_ELLIPSIZE_NONE turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width. @@ -32454,30 +22959,16 @@ for another way of making the text fit into a given width. - + - - Foreground color as a #GdkColor + + Foreground color as a #GdkColor Use #GtkCellRendererText:foreground-rgba instead. - - Foreground color as a #GdkRGBA + + Foreground color as a #GdkRGBA @@ -32489,19 +22980,11 @@ for another way of making the text fit into a given width. - + - - The desired maximum width of the cell, in characters. If this property + + The desired maximum width of the cell, in characters. If this property is set to -1, the width will be calculated automatically. For cell renderers that ellipsize or wrap text; this property @@ -32512,9 +22995,7 @@ have received their natural width. - The text that will be displayed in the #GtkCellRenderer if + The text that will be displayed in the #GtkCellRenderer if #GtkCellRendererText:editable is %TRUE and the cell is empty. Since 3.6 @@ -32532,9 +23013,7 @@ Since 3.6 - + @@ -32555,9 +23034,7 @@ Since 3.6 - + @@ -32587,35 +23064,20 @@ Since 3.6 - - The desired width of the cell, in characters. If this property is set to + + The desired width of the cell, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the cell will request either 3 characters or the property value, whichever is greater. - - Specifies how to break the string into multiple lines, if the cell + + Specifies how to break the string into multiple lines, if the cell renderer does not have enough room to display the entire string. This property has no effect unless the wrap-width property is set. - - Specifies the minimum width at which the text is wrapped. The wrap-mode property can + + Specifies the minimum width at which the text is wrapped. The wrap-mode property can be used to influence at what character positions the line breaks can be placed. Setting wrap-width to -1 turns wrapping off. @@ -32624,13 +23086,10 @@ Setting wrap-width to -1 turns wrapping off. - + - This signal is emitted after @renderer has been edited. + This signal is emitted after @renderer has been edited. It is the responsibility of the application to update the model and store @new_text at the position indicated by @path. @@ -32639,23 +23098,17 @@ and store @new_text at the position indicated by @path. - the path identifying the edited cell + the path identifying the edited cell - the new text + the new text - + @@ -32712,40 +23165,26 @@ and store @new_text at the position indicated by @path. - + - - #GtkCellRendererToggle renders a toggle button in a cell. The + + #GtkCellRendererToggle renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the #GtkCellRendererToggle:radio property. When activated, it emits the #GtkCellRendererToggle::toggled signal. - Creates a new #GtkCellRendererToggle. Adjust rendering + Creates a new #GtkCellRendererToggle. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you can bind a property to a value in a #GtkTreeModel. For example, you -can bind the “active” property on the cell renderer to a boolean value +can bind the “active” property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model. - the new cell renderer + the new cell renderer @@ -32755,8 +23194,7 @@ the model. - + @@ -32764,126 +23202,86 @@ the model. - - Returns whether the cell renderer is activatable. See + + Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable(). - %TRUE if the cell renderer is activatable. + %TRUE if the cell renderer is activatable. - a #GtkCellRendererToggle + a #GtkCellRendererToggle - - Returns whether the cell renderer is active. See + + Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active(). - %TRUE if the cell renderer is active. + %TRUE if the cell renderer is active. - a #GtkCellRendererToggle + a #GtkCellRendererToggle - - Returns whether we’re rendering radio toggles rather than checkboxes. + + Returns whether we’re rendering radio toggles rather than checkboxes. - %TRUE if we’re rendering radio toggles rather than checkboxes + %TRUE if we’re rendering radio toggles rather than checkboxes - a #GtkCellRendererToggle + a #GtkCellRendererToggle - - Makes the cell renderer activatable. + + Makes the cell renderer activatable. - a #GtkCellRendererToggle. + a #GtkCellRendererToggle. - the value to set. + the value to set. - - Activates or deactivates a cell renderer. + + Activates or deactivates a cell renderer. - a #GtkCellRendererToggle. + a #GtkCellRendererToggle. - the value to set. + the value to set. - - If @radio is %TRUE, the cell renderer renders a radio toggle + + If @radio is %TRUE, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles). If %FALSE, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just @@ -32896,15 +23294,11 @@ columns with cell renderer properties). - a #GtkCellRendererToggle + a #GtkCellRendererToggle - %TRUE to make the toggle look like a radio button + %TRUE to make the toggle look like a radio button @@ -32928,13 +23322,10 @@ columns with cell renderer properties). - + - The ::toggled signal is emitted when the cell is toggled. + The ::toggled signal is emitted when the cell is toggled. It is the responsibility of the application to update the model with the correct value to store at @path. Often this is simply the @@ -32944,18 +23335,14 @@ opposite of the value currently stored at @path. - string representation of #GtkTreePath describing the + string representation of #GtkTreePath describing the event location - + @@ -33009,21 +23396,11 @@ opposite of the value currently stored at @path. - + - - A #GtkCellView displays a single row of a #GtkTreeModel using a #GtkCellArea + + A #GtkCellView displays a single row of a #GtkTreeModel using a #GtkCellArea and #GtkCellAreaContext. A #GtkCellAreaContext can be provided to the #GtkCellView at construction time in order to keep the cellview in context of a group of cell views, this ensures that the renderers displayed will @@ -33046,23 +23423,15 @@ GtkCellView has a single CSS node with name cellview. - Creates a new #GtkCellView widget. + Creates a new #GtkCellView widget. - A newly created #GtkCellView widget. + A newly created #GtkCellView widget. - - Creates a new #GtkCellView widget with a specific #GtkCellArea + + Creates a new #GtkCellView widget with a specific #GtkCellArea to layout cells and a specific #GtkCellAreaContext. Specifying the same context for a handfull of cells lets @@ -33071,199 +23440,131 @@ in this way alignments with cellviews for other rows are possible. - A newly created #GtkCellView widget. + A newly created #GtkCellView widget. - the #GtkCellArea to layout cells + the #GtkCellArea to layout cells - the #GtkCellAreaContext in which to calculate cell geometry + the #GtkCellAreaContext in which to calculate cell geometry - - Creates a new #GtkCellView widget, adds a #GtkCellRendererText + + Creates a new #GtkCellView widget, adds a #GtkCellRendererText to it, and makes it show @markup. The text can be marked up with the [Pango text markup language][PangoMarkupFormat]. - A newly created #GtkCellView widget. + A newly created #GtkCellView widget. - the text to display in the cell view + the text to display in the cell view - - Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf + + Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf to it, and makes it show @pixbuf. - A newly created #GtkCellView widget. + A newly created #GtkCellView widget. - the image to display in the cell view + the image to display in the cell view - - Creates a new #GtkCellView widget, adds a #GtkCellRendererText + + Creates a new #GtkCellView widget, adds a #GtkCellRendererText to it, and makes it show @text. - A newly created #GtkCellView widget. + A newly created #GtkCellView widget. - the text to display in the cell view + the text to display in the cell view - - Returns a #GtkTreePath referring to the currently + + Returns a #GtkTreePath referring to the currently displayed row. If no row is currently displayed, %NULL is returned. - the currently displayed row or %NULL + the currently displayed row or %NULL - a #GtkCellView + a #GtkCellView - - Gets whether @cell_view is configured to draw all of its + + Gets whether @cell_view is configured to draw all of its cells in a sensitive state. - whether @cell_view draws all of its + whether @cell_view draws all of its cells in a sensitive state - a #GtkCellView + a #GtkCellView - - Gets whether @cell_view is configured to request space + + Gets whether @cell_view is configured to request space to fit the entire #GtkTreeModel. - whether @cell_view requests space to fit + whether @cell_view requests space to fit the entire #GtkTreeModel. - a #GtkCellView + a #GtkCellView - - Returns the model for @cell_view. If no model is used %NULL is + + Returns the model for @cell_view. If no model is used %NULL is returned. - a #GtkTreeModel used or %NULL + a #GtkTreeModel used or %NULL - a #GtkCellView + a #GtkCellView - - Sets @requisition to the size needed by @cell_view to display + + Sets @requisition to the size needed by @cell_view to display the model row pointed to by @path. Combo box formerly used this to calculate the sizes for cellviews, now you can achieve this by either using @@ -33271,43 +23572,26 @@ the #GtkCellView:fit-model property or by setting the currently displayed row of the #GtkCellView and using gtk_widget_get_preferred_size(). - %TRUE + %TRUE - a #GtkCellView + a #GtkCellView - a #GtkTreePath + a #GtkTreePath - - return location for the size + + return location for the size - - Sets the background color of @view. + + Sets the background color of @view. Use gtk_cell_view_set_background_rgba() instead. @@ -33315,52 +23599,36 @@ displayed row of the #GtkCellView and using gtk_widget_get_preferred_size(). - a #GtkCellView + a #GtkCellView - the new background color + the new background color - - Sets the background color of @cell_view. + + Sets the background color of @cell_view. - a #GtkCellView + a #GtkCellView - the new background color + the new background color - - Sets the row of the model that is currently displayed + + Sets the row of the model that is currently displayed by the #GtkCellView. If the path is unset, then the -contents of the cellview “stick” at their last value; +contents of the cellview “stick” at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the model for the #GtkCellView becomes temporarily empty. @@ -33370,28 +23638,17 @@ the #GtkCellView becomes temporarily empty. - a #GtkCellView + a #GtkCellView - - a #GtkTreePath or %NULL to unset. + + a #GtkTreePath or %NULL to unset. - - Sets whether @cell_view should draw all of its + + Sets whether @cell_view should draw all of its cells in a sensitive state, this is used by #GtkComboBox menus to ensure that rows with insensitive cells that contain children appear sensitive in the parent menu item. @@ -33401,28 +23658,20 @@ children appear sensitive in the parent menu item. - a #GtkCellView + a #GtkCellView - whether to draw all cells in a sensitive state. + whether to draw all cells in a sensitive state. - - Sets whether @cell_view should request space to fit the entire #GtkTreeModel. + + Sets whether @cell_view should request space to fit the entire #GtkTreeModel. This is used by #GtkComboBox to ensure that the cell view displayed on -the combo box’s button always gets enough space and does not resize +the combo box’s button always gets enough space and does not resize when selection changes. @@ -33430,25 +23679,17 @@ when selection changes. - a #GtkCellView + a #GtkCellView - whether @cell_view should request space for the whole model. + whether @cell_view should request space for the whole model. - - Sets the model for @cell_view. If @cell_view already has a model + + Sets the model for @cell_view. If @cell_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model. @@ -33457,58 +23698,32 @@ set, it will remove it before setting the new model. If @model is - a #GtkCellView + a #GtkCellView - - a #GtkTreeModel + + a #GtkTreeModel - + - - The background color as a #GdkColor + + The background color as a #GdkColor Use #GtkCellView:background-rgba instead. - - The background color as a #GdkRGBA + + The background color as a #GdkRGBA - - The #GtkCellArea rendering cells + + The #GtkCellArea rendering cells If no area is specified when creating the cell view with gtk_cell_view_new_with_context() a horizontally oriented #GtkCellAreaBox will be used. @@ -33516,13 +23731,8 @@ a horizontally oriented #GtkCellAreaBox will be used. since 3.0 - - The #GtkCellAreaContext used to compute the geometry of the cell view. + + The #GtkCellAreaContext used to compute the geometry of the cell view. A group of cell views can be assigned the same context in order to ensure the sizes and cell alignments match across all the views with @@ -33537,9 +23747,7 @@ since 3.0 - Whether all cells should be draw as sensitive for this view regardless + Whether all cells should be draw as sensitive for this view regardless of the actual cell properties (used to make menus with submenus appear sensitive when the items in submenus might be insensitive). @@ -33547,9 +23755,7 @@ since 3.0 - Whether the view should request enough space to always fit + Whether the view should request enough space to always fit the size of every row in the model (used by the combo box to ensure the combo box size doesnt change when different items are selected). @@ -33558,9 +23764,7 @@ since 3.0 - The model for cell view + The model for cell view since 2.10 @@ -33572,14 +23776,10 @@ since 2.10 - + - The parent class. + The parent class. @@ -33618,16 +23818,8 @@ since 2.10 - - A #GtkCheckButton places a discrete #GtkToggleButton next to a widget, + + A #GtkCheckButton places a discrete #GtkToggleButton next to a widget, (usually a #GtkLabel). See the section on #GtkToggleButton widgets for more information about toggle/check buttons. @@ -33638,8 +23830,8 @@ The important signal ( #GtkToggleButton::toggled ) is also inherited from |[<!-- language="plain" --> checkbutton -├── check -╰── <child> +├── check +╰── <child> ]| A GtkCheckButton with indicator (see gtk_toggle_button_set_mode()) has a @@ -33647,8 +23839,8 @@ main CSS node with name checkbutton and a subnode with name check. |[<!-- language="plain" --> button.check -├── check -╰── <child> +├── check +╰── <child> ]| A GtkCheckButton without indicator changes the name of its main node @@ -33660,57 +23852,39 @@ in this case. - Creates a new #GtkCheckButton. + Creates a new #GtkCheckButton. - a #GtkWidget. + a #GtkWidget. - - Creates a new #GtkCheckButton with a #GtkLabel to the right of it. + + Creates a new #GtkCheckButton with a #GtkLabel to the right of it. - a #GtkWidget. + a #GtkWidget. - the text for the check button. + the text for the check button. - - Creates a new #GtkCheckButton containing a label. The label + + Creates a new #GtkCheckButton containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the check button. - a new #GtkCheckButton + a new #GtkCheckButton - The text of the button, with an underscore in front of the + The text of the button, with an underscore in front of the mnemonic character @@ -33734,9 +23908,7 @@ in @label indicate the mnemonic for the check button. - + @@ -33790,16 +23962,8 @@ in @label indicate the mnemonic for the check button. - - A #GtkCheckMenuItem is a menu item that maintains the state of a boolean + + A #GtkCheckMenuItem is a menu item that maintains the state of a boolean value in addition to a #GtkMenuItem usual role in activating application code. @@ -33811,8 +23975,8 @@ toggles the value. |[<!-- language="plain" --> menuitem -├── check.left -╰── <child> +├── check.left +╰── <child> ]| GtkCheckMenuItem has a main CSS node with name menuitem, and a subnode @@ -33823,57 +23987,39 @@ with name check, which gets the .left or .right style class. - Creates a new #GtkCheckMenuItem. + Creates a new #GtkCheckMenuItem. - a new #GtkCheckMenuItem. + a new #GtkCheckMenuItem. - - Creates a new #GtkCheckMenuItem with a label. + + Creates a new #GtkCheckMenuItem with a label. - a new #GtkCheckMenuItem. + a new #GtkCheckMenuItem. - the string to use for the label. + the string to use for the label. - - Creates a new #GtkCheckMenuItem containing a label. The label + + Creates a new #GtkCheckMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the menu item. - a new #GtkCheckMenuItem + a new #GtkCheckMenuItem - The text of the button, with an underscore in front of the + The text of the button, with an underscore in front of the character @@ -33894,178 +24040,128 @@ in @label indicate the mnemonic for the menu item. - Emits the #GtkCheckMenuItem::toggled signal. + Emits the #GtkCheckMenuItem::toggled signal. - a #GtkCheckMenuItem. + a #GtkCheckMenuItem. - Returns whether the check menu item is active. See + Returns whether the check menu item is active. See gtk_check_menu_item_set_active (). - %TRUE if the menu item is checked. + %TRUE if the menu item is checked. - a #GtkCheckMenuItem + a #GtkCheckMenuItem - - Returns whether @check_menu_item looks like a #GtkRadioMenuItem + + Returns whether @check_menu_item looks like a #GtkRadioMenuItem - Whether @check_menu_item looks like a #GtkRadioMenuItem + Whether @check_menu_item looks like a #GtkRadioMenuItem - a #GtkCheckMenuItem + a #GtkCheckMenuItem - - Retrieves the value set by gtk_check_menu_item_set_inconsistent(). + + Retrieves the value set by gtk_check_menu_item_set_inconsistent(). - %TRUE if inconsistent + %TRUE if inconsistent - a #GtkCheckMenuItem + a #GtkCheckMenuItem - Sets the active state of the menu item’s check box. + Sets the active state of the menu item’s check box. - a #GtkCheckMenuItem. + a #GtkCheckMenuItem. - boolean value indicating whether the check box is active. + boolean value indicating whether the check box is active. - - Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem + + Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem - a #GtkCheckMenuItem + a #GtkCheckMenuItem - whether @check_menu_item is drawn like a #GtkRadioMenuItem + whether @check_menu_item is drawn like a #GtkRadioMenuItem - - If the user has selected a range of elements (such as some text or + + If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a boolean setting, and the current values in that range are inconsistent, you may want to -display the check in an “in between” state. This function turns on -“in between” display. Normally you would turn off the inconsistent +display the check in an “in between” state. This function turns on +“in between” display. Normally you would turn off the inconsistent state again if the user explicitly selects a setting. This has to be done manually, gtk_check_menu_item_set_inconsistent() only affects -visual appearance, it doesn’t affect the semantics of the widget. +visual appearance, it doesn’t affect the semantics of the widget. - a #GtkCheckMenuItem + a #GtkCheckMenuItem - %TRUE to display an “inconsistent” third state check + %TRUE to display an “inconsistent” third state check - Emits the #GtkCheckMenuItem::toggled signal. + Emits the #GtkCheckMenuItem::toggled signal. - a #GtkCheckMenuItem. + a #GtkCheckMenuItem. @@ -34086,9 +24182,7 @@ visual appearance, it doesn’t affect the semantics of the widget. - This signal is emitted when the state of the check box is changed. + This signal is emitted when the state of the check box is changed. A signal handler can use gtk_check_menu_item_get_active() to discover the new state. @@ -34097,15 +24191,8 @@ to discover the new state. - - + + @@ -34113,34 +24200,22 @@ to discover the new state. - + - - + + - + - - + + - + - The parent class. + The parent class. @@ -34151,9 +24226,7 @@ to discover the new state. - a #GtkCheckMenuItem. + a #GtkCheckMenuItem. @@ -34208,26 +24281,17 @@ to discover the new state. - + - - The #GtkClipboard object represents a clipboard of data shared + + The #GtkClipboard object represents a clipboard of data shared between different processes or between different widgets in the same process. Each clipboard is identified by a name encoded as a #GdkAtom. (Conversion to and from strings can be done with gdk_atom_intern() and gdk_atom_name().) The default clipboard -corresponds to the “CLIPBOARD” atom; another commonly used clipboard -is the “PRIMARY” clipboard, which, in X, traditionally contains +corresponds to the “CLIPBOARD” atom; another commonly used clipboard +is the “PRIMARY” clipboard, which, in X, traditionally contains the currently selected text. To support having a number of different formats on the clipboard @@ -34249,7 +24313,7 @@ advertise. When the @clear_func you provided is called, you simply free the data blob. The latter is more useful when the contents of clipboard reflect the internal state of a #GObject (As an example, for the PRIMARY clipboard, when an entry widget -provides the clipboard’s contents the contents are simply the +provides the clipboard’s contents the contents are simply the text within the selected region.) If the contents change, the entry widget can call gtk_clipboard_set_with_owner() to update the timestamp for clipboard ownership, without having to worry @@ -34263,7 +24327,7 @@ then the data needs to be retrieved from the other process, which may take some time. To avoid blocking the user interface, the call to request the selection, gtk_clipboard_request_contents() takes a callback that will be called when the contents are received (or -when the request fails.) If you don’t want to deal with providing +when the request fails.) If you don’t want to deal with providing a separate callback, you can also use gtk_clipboard_wait_for_contents(). What this does is run the GLib main loop recursively waiting for the contents. This can simplify the code flow, but you still have @@ -34279,15 +24343,11 @@ provider, asking for the clipboard in the best available format and converting the results into the UTF-8 encoding. (The standard form for representing strings in GTK+.) - Returns the clipboard object for the given selection. + Returns the clipboard object for the given selection. See gtk_clipboard_get_for_display() for complete details. - the appropriate clipboard object. If no clipboard + the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent and, since it is owned by GTK+, must not be freed or unreffed. @@ -34295,42 +24355,28 @@ See gtk_clipboard_get_for_display() for complete details. - a #GdkAtom which identifies the clipboard to use + a #GdkAtom which identifies the clipboard to use - - Returns the default clipboard object for use with cut/copy/paste menu items + + Returns the default clipboard object for use with cut/copy/paste menu items and keyboard shortcuts. - the default clipboard object. + the default clipboard object. - the #GdkDisplay for which the clipboard is to be retrieved. + the #GdkDisplay for which the clipboard is to be retrieved. - - Returns the clipboard object for the given selection. + + Returns the clipboard object for the given selection. Cut/copy/paste menu items and keyboard shortcuts should use the default clipboard, returned by passing %GDK_SELECTION_CLIPBOARD for @selection. (%GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD @@ -34346,21 +24392,19 @@ user sees as the clipboard. See the [FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboards-spec) -for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY” +for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY” selections under the X window system. On Win32 the #GDK_SELECTION_PRIMARY clipboard is essentially ignored.) -It’s possible to have arbitrary named clipboards; if you do invent +It’s possible to have arbitrary named clipboards; if you do invent new clipboards, you should prefix the selection name with an underscore (because the ICCCM requires that nonstandard atoms are underscore-prefixed), and namespace it as well. For example, -if your application called “Foo” has a special-purpose -clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”. +if your application called “Foo” has a special-purpose +clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”. - the appropriate clipboard object. If no + the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent and, since it is owned by GTK+, must not be freed or unrefd. @@ -34368,23 +24412,17 @@ clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”. - the #GdkDisplay for which the clipboard is to be retrieved or created. + the #GdkDisplay for which the clipboard is to be retrieved or created. - a #GdkAtom which identifies the clipboard to use. + a #GdkAtom which identifies the clipboard to use. - Clears the contents of the clipboard. Generally this should only + Clears the contents of the clipboard. Generally this should only be called between the time you call gtk_clipboard_set_with_owner() or gtk_clipboard_set_with_data(), and when the @clear_func you supplied is called. Otherwise, the @@ -34395,87 +24433,59 @@ clipboard may be owned by someone else. - a #GtkClipboard + a #GtkClipboard - - Gets the #GdkDisplay associated with @clipboard + + Gets the #GdkDisplay associated with @clipboard - the #GdkDisplay associated with @clipboard + the #GdkDisplay associated with @clipboard - a #GtkClipboard + a #GtkClipboard - If the clipboard contents callbacks were set with + If the clipboard contents callbacks were set with gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not subsequently called, returns the owner set by gtk_clipboard_set_with_owner(). - the owner of the clipboard, if any; + the owner of the clipboard, if any; otherwise %NULL. - a #GtkClipboard + a #GtkClipboard - - Gets the selection that this clipboard is for. + + Gets the selection that this clipboard is for. - the selection + the selection - a #GtkClipboard + a #GtkClipboard - - Requests the contents of clipboard as the given target. + + Requests the contents of clipboard as the given target. When the results of the result are later received the supplied callback will be called. @@ -34484,47 +24494,28 @@ will be called. - a #GtkClipboard + a #GtkClipboard - an atom representing the form into which the clipboard + an atom representing the form into which the clipboard owner should convert the selection. - - A function to call when the results are received + + A function to call when the results are received (or the retrieval fails). If the retrieval fails the length field of @selection_data will be negative. - + - - user data to pass to @callback + + user data to pass to @callback - - Requests the contents of the clipboard as image. When the image is + + Requests the contents of the clipboard as image. When the image is later received, it will be converted to a #GdkPixbuf, and @callback will be called. @@ -34539,44 +24530,27 @@ converted into an image. - a #GtkClipboard + a #GtkClipboard - - a function to call when the image is received, + + a function to call when the image is received, or the retrieval fails. (It will always be called one way or the other.) - + - - user data to pass to @callback. + + user data to pass to @callback. - - Requests the contents of the clipboard as rich text. When the rich + + Requests the contents of the clipboard as rich text. When the rich text is later received, @callback will be called. The @text parameter to @callback will contain the resulting rich text if the request succeeded, or %NULL if it failed. The @length -parameter will contain @text’s length. This function can fail for +parameter will contain @text’s length. This function can fail for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into rich text form. @@ -34585,45 +24559,26 @@ contents of the clipboard could not be converted into rich text form. - a #GtkClipboard + a #GtkClipboard - a #GtkTextBuffer + a #GtkTextBuffer - - a function to call when the text is received, + + a function to call when the text is received, or the retrieval fails. (It will always be called one way or the other.) - + - - user data to pass to @callback. + + user data to pass to @callback. - - Requests the contents of the clipboard as list of supported targets. + + Requests the contents of the clipboard as list of supported targets. When the list is later received, @callback will be called. The @targets parameter to @callback will contain the resulting targets if @@ -34634,38 +24589,23 @@ the request succeeded, or %NULL if it failed. - a #GtkClipboard + a #GtkClipboard - - a function to call when the targets are + + a function to call when the targets are received, or the retrieval fails. (It will always be called one way or the other.) - + - - user data to pass to @callback. + + user data to pass to @callback. - Requests the contents of the clipboard as text. When the text is + Requests the contents of the clipboard as text. When the text is later received, it will be converted to UTF-8 if necessary, and @callback will be called. @@ -34679,39 +24619,22 @@ contents of the clipboard could not be converted into text form. - a #GtkClipboard + a #GtkClipboard - - a function to call when the text is received, + + a function to call when the text is received, or the retrieval fails. (It will always be called one way or the other.) - + - - user data to pass to @callback. + + user data to pass to @callback. - - Requests the contents of the clipboard as URIs. When the URIs are + + Requests the contents of the clipboard as URIs. When the URIs are later received @callback will be called. The @uris parameter to @callback will contain the resulting array of @@ -34724,39 +24647,22 @@ contents of the clipboard could not be converted into URI form. - a #GtkClipboard + a #GtkClipboard - - a function to call when the URIs are received, + + a function to call when the URIs are received, or the retrieval fails. (It will always be called one way or the other.) - + - - user data to pass to @callback. + + user data to pass to @callback. - - Hints that the clipboard data should be stored somewhere when the + + Hints that the clipboard data should be stored somewhere when the application exits or when gtk_clipboard_store () is called. This value is reset when the clipboard owner changes. @@ -34768,40 +24674,25 @@ see gdk_display_store_clipboard () for more information. - a #GtkClipboard + a #GtkClipboard - - array containing + + array containing information about which forms should be stored or %NULL to indicate that all forms should be stored. - + - number of elements in @targets + number of elements in @targets - - Sets the contents of the clipboard to the given #GdkPixbuf. + + Sets the contents of the clipboard to the given #GdkPixbuf. GTK+ will take responsibility for responding for requests for the image, and for converting the image into the requested format. @@ -34811,23 +24702,17 @@ requested format. - a #GtkClipboard object + a #GtkClipboard object - a #GdkPixbuf + a #GdkPixbuf - Sets the contents of the clipboard to the given UTF-8 string. GTK+ will + Sets the contents of the clipboard to the given UTF-8 string. GTK+ will make a copy of the text and take responsibility for responding for requests for the text, and for converting the text into the requested format. @@ -34837,101 +24722,65 @@ the requested format. - a #GtkClipboard object + a #GtkClipboard object - a UTF-8 string. + a UTF-8 string. - length of @text, in bytes, or -1, in which case + length of @text, in bytes, or -1, in which case the length will be determined with strlen(). - - Virtually sets the contents of the specified clipboard by providing + + Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested. - %TRUE if setting the clipboard data succeeded. + %TRUE if setting the clipboard data succeeded. If setting the clipboard data failed the provided callback functions will be ignored. - a #GtkClipboard + a #GtkClipboard - array containing information + array containing information about the available forms for the clipboard data - + - number of elements in @targets + number of elements in @targets - function to call to get the actual clipboard data + function to call to get the actual clipboard data - - when the clipboard contents are set again, + + when the clipboard contents are set again, this function will be called, and @get_func will not be subsequently called. - - user data to pass to @get_func and @clear_func. + + user data to pass to @get_func and @clear_func. - - Virtually sets the contents of the specified clipboard by providing + + Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested. @@ -34940,64 +24789,46 @@ is that instead of an generic @user_data pointer, a #GObject is passed in. - %TRUE if setting the clipboard data succeeded. + %TRUE if setting the clipboard data succeeded. If setting the clipboard data failed the provided callback functions will be ignored. - a #GtkClipboard + a #GtkClipboard - array containing information + array containing information about the available forms for the clipboard data - + - number of elements in @targets + number of elements in @targets - function to call to get the actual clipboard data + function to call to get the actual clipboard data - when the clipboard contents are set again, + when the clipboard contents are set again, this function will be called, and @get_func will not be subsequently called - an object that “owns” the data. This object will be passed + an object that “owns” the data. This object will be passed to the callbacks when called - Stores the current clipboard data somewhere so that it will stay + Stores the current clipboard data somewhere so that it will stay around after the application has quit. @@ -35005,25 +24836,18 @@ around after the application has quit. - a #GtkClipboard + a #GtkClipboard - - Requests the contents of the clipboard using the given target. + + Requests the contents of the clipboard using the given target. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. - a newly-allocated #GtkSelectionData object or %NULL + a newly-allocated #GtkSelectionData object or %NULL if retrieving the given target failed. If non-%NULL, this value must be freed with gtk_selection_data_free() when you are finished with it. @@ -35031,34 +24855,24 @@ loop, so events, timeouts, etc, may be dispatched during the wait. - a #GtkClipboard + a #GtkClipboard - an atom representing the form into which the clipboard + an atom representing the form into which the clipboard owner should convert the selection. - - Requests the contents of the clipboard as image and converts + + Requests the contents of the clipboard as image and converts the result to a #GdkPixbuf. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. - a newly-allocated #GdkPixbuf + a newly-allocated #GdkPixbuf object which must be disposed with g_object_unref(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard @@ -35068,26 +24882,18 @@ timeouts, etc, may be dispatched during the wait. - a #GtkClipboard + a #GtkClipboard - - Requests the contents of the clipboard as rich text. This function + + Requests the contents of the clipboard as rich text. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. - a + a newly-allocated binary block of data which must be freed with g_free(), or %NULL if retrieving the selection data failed. (This could happen for various @@ -35100,98 +24906,62 @@ timeouts, etc, may be dispatched during the wait. - a #GtkClipboard + a #GtkClipboard - a #GtkTextBuffer + a #GtkTextBuffer - - return location for the format of the returned data + + return location for the format of the returned data - - return location for the length of the returned data + + return location for the length of the returned data - - Returns a list of targets that are present on the clipboard, or %NULL -if there aren’t any targets available. The returned list must be + + Returns a list of targets that are present on the clipboard, or %NULL +if there aren’t any targets available. The returned list must be freed with g_free(). This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. - %TRUE if any targets are present on the clipboard, + %TRUE if any targets are present on the clipboard, otherwise %FALSE. - a #GtkClipboard + a #GtkClipboard - - location + + location to store an array of targets. The result stored here must be freed with g_free(). - - location to store number of items in @targets. + + location to store number of items in @targets. - Requests the contents of the clipboard as text and converts + Requests the contents of the clipboard as text and converts the result to UTF-8 if necessary. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. - a newly-allocated UTF-8 string which must + a newly-allocated UTF-8 string which must be freed with g_free(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the @@ -35201,26 +24971,18 @@ timeouts, etc, may be dispatched during the wait. - a #GtkClipboard + a #GtkClipboard - - Requests the contents of the clipboard as URIs. This function waits + + Requests the contents of the clipboard as URIs. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. - + a newly-allocated %NULL-terminated array of strings which must be freed with g_strfreev(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, @@ -35232,175 +24994,128 @@ timeouts, etc, may be dispatched during the wait. - a #GtkClipboard + a #GtkClipboard - - Test to see if there is an image available to be pasted + + Test to see if there is an image available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the supported image targets. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. This function is a little faster than calling -gtk_clipboard_wait_for_image() since it doesn’t need to retrieve +gtk_clipboard_wait_for_image() since it doesn’t need to retrieve the actual image data. - %TRUE is there is an image available, %FALSE otherwise. + %TRUE is there is an image available, %FALSE otherwise. - a #GtkClipboard + a #GtkClipboard - - Test to see if there is rich text available to be pasted + + Test to see if there is rich text available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the supported rich text targets. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. This function is a little faster than calling -gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve +gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve the actual text. - %TRUE is there is rich text available, %FALSE otherwise. + %TRUE is there is rich text available, %FALSE otherwise. - a #GtkClipboard + a #GtkClipboard - a #GtkTextBuffer + a #GtkTextBuffer - - Checks if a clipboard supports pasting data of a given type. This -function can be used to determine if a “Paste” menu item should be + + Checks if a clipboard supports pasting data of a given type. This +function can be used to determine if a “Paste” menu item should be insensitive or not. -If you want to see if there’s text available on the clipboard, use +If you want to see if there’s text available on the clipboard, use gtk_clipboard_wait_is_text_available () instead. - %TRUE if the target is available, %FALSE otherwise. + %TRUE if the target is available, %FALSE otherwise. - a #GtkClipboard + a #GtkClipboard - A #GdkAtom indicating which target to look for. + A #GdkAtom indicating which target to look for. - - Test to see if there is text available to be pasted + + Test to see if there is text available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the supported text targets. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. This function is a little faster than calling -gtk_clipboard_wait_for_text() since it doesn’t need to retrieve +gtk_clipboard_wait_for_text() since it doesn’t need to retrieve the actual text. - %TRUE is there is text available, %FALSE otherwise. + %TRUE is there is text available, %FALSE otherwise. - a #GtkClipboard + a #GtkClipboard - - Test to see if there is a list of URIs available to be pasted + + Test to see if there is a list of URIs available to be pasted This is done by requesting the TARGETS atom and checking if it contains the URI targets. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. This function is a little faster than calling -gtk_clipboard_wait_for_uris() since it doesn’t need to retrieve +gtk_clipboard_wait_for_uris() since it doesn’t need to retrieve the actual URI data. - %TRUE is there is an URI list available, %FALSE otherwise. + %TRUE is there is an URI list available, %FALSE otherwise. - a #GtkClipboard + a #GtkClipboard - The ::owner-change signal is emitted when GTK+ receives an + The ::owner-change signal is emitted when GTK+ receives an event that indicates that the ownership of the selection associated with @clipboard has changed. @@ -35408,18 +25123,14 @@ associated with @clipboard has changed. - the @GdkEventOwnerChange event + the @GdkEventOwnerChange event - A function that will be called when the contents of the clipboard are changed + A function that will be called when the contents of the clipboard are changed or cleared. Once this has called, the @user_data_or_owner argument will not be used again. @@ -35428,27 +25139,18 @@ will not be used again. - the #GtkClipboard + the #GtkClipboard - - the @user_data argument passed to gtk_clipboard_set_with_data(), + + the @user_data argument passed to gtk_clipboard_set_with_data(), or the @owner argument passed to gtk_clipboard_set_with_owner() - A function that will be called to provide the contents of the selection. + A function that will be called to provide the contents of the selection. If multiple types of data were advertised, the requested type can be determined from the @info parameter or by checking the target field of @selection_data. If the data could successfully be converted into @@ -35462,45 +25164,30 @@ will be informed that the attempt to get the data failed. - the #GtkClipboard + the #GtkClipboard - a #GtkSelectionData argument in which the requested + a #GtkSelectionData argument in which the requested data should be stored. - the info field corresponding to the requested target from the + the info field corresponding to the requested target from the #GtkTargetEntry array passed to gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner(). - - the @user_data argument passed to + + the @user_data argument passed to gtk_clipboard_set_with_data(), or the @owner argument passed to gtk_clipboard_set_with_owner() - - A function to be called when the results of gtk_clipboard_request_image() + + A function to be called when the results of gtk_clipboard_request_image() are received, or when the request fails. @@ -35508,34 +25195,22 @@ are received, or when the request fails. - the #GtkClipboard + the #GtkClipboard - the received image + the received image - - the @user_data supplied to + + the @user_data supplied to gtk_clipboard_request_image(). - A function to be called when the results of gtk_clipboard_request_contents() + A function to be called when the results of gtk_clipboard_request_contents() are received, or when the request fails. @@ -35543,38 +25218,24 @@ are received, or when the request fails. - the #GtkClipboard + the #GtkClipboard - a #GtkSelectionData containing the data was received. + a #GtkSelectionData containing the data was received. If retrieving the data failed, then then length field of @selection_data will be negative. - - the @user_data supplied to + + the @user_data supplied to gtk_clipboard_request_contents(). - - A function to be called when the results of + + A function to be called when the results of gtk_clipboard_request_rich_text() are received, or when the request fails. @@ -35583,52 +25244,31 @@ fails. - the #GtkClipboard + the #GtkClipboard - The format of the rich text + The format of the rich text - - the rich text received, as + + the rich text received, as a UTF-8 encoded string, or %NULL if retrieving the data failed. - Length of the text. + Length of the text. - - the @user_data supplied to + + the @user_data supplied to gtk_clipboard_request_rich_text(). - - A function to be called when the results of gtk_clipboard_request_targets() + + A function to be called when the results of gtk_clipboard_request_targets() are received, or when the request fails. @@ -35636,47 +25276,29 @@ are received, or when the request fails. - the #GtkClipboard + the #GtkClipboard - - the supported targets, + + the supported targets, as array of #GdkAtom, or %NULL if retrieving the data failed. - the length of the @atoms array. + the length of the @atoms array. - - the @user_data supplied to + + the @user_data supplied to gtk_clipboard_request_targets(). - - A function to be called when the results of gtk_clipboard_request_text() + + A function to be called when the results of gtk_clipboard_request_text() are received, or when the request fails. @@ -35684,40 +25306,23 @@ are received, or when the request fails. - the #GtkClipboard + the #GtkClipboard - - the text received, as a UTF-8 encoded string, or + + the text received, as a UTF-8 encoded string, or %NULL if retrieving the data failed. - - the @user_data supplied to + + the @user_data supplied to gtk_clipboard_request_text(). - - A function to be called when the results of + + A function to be called when the results of gtk_clipboard_request_uris() are received, or when the request fails. @@ -35726,42 +25331,24 @@ fails. - the #GtkClipboard + the #GtkClipboard - the received URIs + the received URIs - - the @user_data supplied to + + the @user_data supplied to gtk_clipboard_request_uris(). - - The #GtkColorButton is a button which displays the currently selected + + The #GtkColorButton is a button which displays the currently selected color and allows to open a color selection dialog to change the color. It is suitable widget for selecting a color in a preference dialog. @@ -35775,12 +25362,8 @@ it from a plain #GtkButton, it gets the .color style class. - - Creates a new color button. + + Creates a new color button. This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button @@ -35789,55 +25372,35 @@ to select a color. The swatch will be updated to reflect the new color when the user finishes. - a new color button + a new color button - - Creates a new color button. + + Creates a new color button. Use gtk_color_button_new_with_rgba() instead. - a new color button + a new color button - A #GdkColor to set the current color with + A #GdkColor to set the current color with - - Creates a new color button. + + Creates a new color button. - a new color button + a new color button - A #GdkRGBA to set the current color with + A #GdkRGBA to set the current color with @@ -35853,39 +25416,23 @@ color when the user finishes. - - Returns the current alpha value. + + Returns the current alpha value. Use gtk_color_chooser_get_rgba() instead. - an integer between 0 and 65535 + an integer between 0 and 65535 - a #GtkColorButton + a #GtkColorButton - - Sets @color to be the current color in the #GtkColorButton widget. + + Sets @color to be the current color in the #GtkColorButton widget. Use gtk_color_chooser_get_rgba() instead. @@ -35893,31 +25440,17 @@ color when the user finishes. - a #GtkColorButton + a #GtkColorButton - - a #GdkColor to fill in with the current color + + a #GdkColor to fill in with the current color - - Sets @rgba to be the current color in the #GtkColorButton widget. + + Sets @rgba to be the current color in the #GtkColorButton widget. Use gtk_color_chooser_get_rgba() instead. @@ -35925,77 +25458,46 @@ color when the user finishes. - a #GtkColorButton + a #GtkColorButton - - a #GdkRGBA to fill in with the current color + + a #GdkRGBA to fill in with the current color - - Gets the title of the color selection dialog. + + Gets the title of the color selection dialog. - An internal string, do not free the return value + An internal string, do not free the return value - a #GtkColorButton + a #GtkColorButton - - Does the color selection dialog use the alpha channel ? + + Does the color selection dialog use the alpha channel ? Use gtk_color_chooser_get_use_alpha() instead. - %TRUE if the color sample uses alpha channel, %FALSE if not + %TRUE if the color sample uses alpha channel, %FALSE if not - a #GtkColorButton + a #GtkColorButton - - Sets the current opacity to be @alpha. + + Sets the current opacity to be @alpha. Use gtk_color_chooser_set_rgba() instead. @@ -36003,26 +25505,17 @@ color when the user finishes. - a #GtkColorButton + a #GtkColorButton - an integer between 0 and 65535 + an integer between 0 and 65535 - - Sets the current color to be @color. + + Sets the current color to be @color. Use gtk_color_chooser_set_rgba() instead. @@ -36030,28 +25523,17 @@ color when the user finishes. - a #GtkColorButton + a #GtkColorButton - A #GdkColor to set the current color with + A #GdkColor to set the current color with - - Sets the current color to be @rgba. + + Sets the current color to be @rgba. Use gtk_color_chooser_set_rgba() instead. @@ -36059,52 +25541,34 @@ color when the user finishes. - a #GtkColorButton + a #GtkColorButton - a #GdkRGBA to set the current color with + a #GdkRGBA to set the current color with - - Sets the title for the color selection dialog. + + Sets the title for the color selection dialog. - a #GtkColorButton + a #GtkColorButton - String containing new window title + String containing new window title - - Sets whether or not the color button should use the alpha channel. + + Sets whether or not the color button should use the alpha channel. Use gtk_color_chooser_set_use_alpha() instead. @@ -36112,56 +25576,30 @@ color when the user finishes. - a #GtkColorButton + a #GtkColorButton - %TRUE if color button should use alpha channel, %FALSE if not + %TRUE if color button should use alpha channel, %FALSE if not - - The selected opacity value (0 fully transparent, 65535 fully opaque). + + The selected opacity value (0 fully transparent, 65535 fully opaque). - - The selected color. + + The selected color. Use #GtkColorButton:rgba instead. - - The RGBA color. + + The RGBA color. - - Set this property to %TRUE to skip the palette + + Set this property to %TRUE to skip the palette in the dialog and go directly to the color editor. This property should be used in cases where the palette @@ -36169,22 +25607,12 @@ in the editor would be redundant, such as when the color button is already part of a palette. - - The title of the color selection dialog + + The title of the color selection dialog - - If this property is set to %TRUE, the color swatch on the button is + + If this property is set to %TRUE, the color swatch on the button is rendered against a checkerboard background to show its opacity and the opacity slider is displayed in the color selection dialog. @@ -36196,9 +25624,7 @@ the opacity slider is displayed in the color selection dialog. - The ::color-set signal is emitted when the user selects a color. + The ::color-set signal is emitted when the user selects a color. When handling this signal, use gtk_color_button_get_rgba() to find out which color was just selected. @@ -36210,9 +25636,7 @@ as well, use the notify::color signal. - + @@ -36263,21 +25687,11 @@ as well, use the notify::color signal. - + - - #GtkColorChooser is an interface that is implemented by widgets + + #GtkColorChooser is an interface that is implemented by widgets for choosing colors. Depending on the situation, colors may be allowed to have alpha (translucency). @@ -36285,9 +25699,7 @@ In GTK+, the main widgets that implement this interface are #GtkColorChooserWidget, #GtkColorChooserDialog and #GtkColorButton. - Adds a palette to the color chooser. If @orientation is horizontal, + Adds a palette to the color chooser. If @orientation is horizontal, the colors are grouped in rows, with @colors_per_line colors in each row. If @horizontal is %FALSE, the colors are grouped in columns instead. @@ -36310,37 +25722,24 @@ If @colors is %NULL, removes all previously added palettes. - a #GtkColorChooser + a #GtkColorChooser - %GTK_ORIENTATION_HORIZONTAL if the palette should + %GTK_ORIENTATION_HORIZONTAL if the palette should be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns - the number of colors to show in each row/column + the number of colors to show in each row/column - the total number of elements in @colors + the total number of elements in @colors - - the colors of the palette, or %NULL + + the colors of the palette, or %NULL @@ -36362,60 +25761,41 @@ If @colors is %NULL, removes all previously added palettes. - Gets the currently-selected color. + Gets the currently-selected color. - a #GtkColorChooser + a #GtkColorChooser - - a #GdkRGBA to fill in with the current color + + a #GdkRGBA to fill in with the current color - Sets the color. + Sets the color. - a #GtkColorChooser + a #GtkColorChooser - the new color + the new color - - Adds a palette to the color chooser. If @orientation is horizontal, + + Adds a palette to the color chooser. If @orientation is horizontal, the colors are grouped in rows, with @colors_per_line colors in each row. If @horizontal is %FALSE, the colors are grouped in columns instead. @@ -36438,162 +25818,104 @@ If @colors is %NULL, removes all previously added palettes. - a #GtkColorChooser + a #GtkColorChooser - %GTK_ORIENTATION_HORIZONTAL if the palette should + %GTK_ORIENTATION_HORIZONTAL if the palette should be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns - the number of colors to show in each row/column + the number of colors to show in each row/column - the total number of elements in @colors + the total number of elements in @colors - - the colors of the palette, or %NULL + + the colors of the palette, or %NULL - - Gets the currently-selected color. + + Gets the currently-selected color. - a #GtkColorChooser + a #GtkColorChooser - - a #GdkRGBA to fill in with the current color + + a #GdkRGBA to fill in with the current color - - Returns whether the color chooser shows the alpha channel. + + Returns whether the color chooser shows the alpha channel. - %TRUE if the color chooser uses the alpha channel, + %TRUE if the color chooser uses the alpha channel, %FALSE if not - a #GtkColorChooser + a #GtkColorChooser - - Sets the color. + + Sets the color. - a #GtkColorChooser + a #GtkColorChooser - the new color + the new color - - Sets whether or not the color chooser should use the alpha channel. + + Sets whether or not the color chooser should use the alpha channel. - a #GtkColorChooser + a #GtkColorChooser - %TRUE if color chooser should use alpha channel, %FALSE if not + %TRUE if color chooser should use alpha channel, %FALSE if not - - The ::rgba property contains the currently selected color, + + The ::rgba property contains the currently selected color, as a #GdkRGBA struct. The property can be set to change the current selection programmatically. - - When ::use-alpha is %TRUE, colors may have alpha (translucency) + + When ::use-alpha is %TRUE, colors may have alpha (translucency) information. When it is %FALSE, the #GdkRGBA struct obtained via the #GtkColorChooser:rgba property will be forced to have alpha == 1. @@ -36603,9 +25925,7 @@ over a non-uniform background (like a checkerboard pattern). - Emitted when a color is activated from the color chooser. + Emitted when a color is activated from the color chooser. This usually happens when the user clicks a color swatch, or a color is selected and the user presses one of the keys Space, Shift+Space, Return or Enter. @@ -36614,60 +25934,33 @@ Space, Shift+Space, Return or Enter. - the color + the color - - The #GtkColorChooserDialog widget is a dialog for choosing + + The #GtkColorChooserDialog widget is a dialog for choosing a color. It implements the #GtkColorChooser interface. - - Creates a new #GtkColorChooserDialog. + + Creates a new #GtkColorChooserDialog. - a new #GtkColorChooserDialog + a new #GtkColorChooserDialog - - Title of the dialog, or %NULL + + Title of the dialog, or %NULL - - Transient parent of the dialog, or %NULL + + Transient parent of the dialog, or %NULL @@ -36679,13 +25972,10 @@ a color. It implements the #GtkColorChooser interface. - + - + @@ -36723,14 +26013,10 @@ a color. It implements the #GtkColorChooser interface. - + - + @@ -36743,18 +26029,11 @@ a color. It implements the #GtkColorChooser interface. - a #GtkColorChooser + a #GtkColorChooser - - a #GdkRGBA to fill in with the current color + + a #GdkRGBA to fill in with the current color @@ -36768,15 +26047,11 @@ a color. It implements the #GtkColorChooser interface. - a #GtkColorChooser + a #GtkColorChooser - the new color + the new color @@ -36790,37 +26065,24 @@ a color. It implements the #GtkColorChooser interface. - a #GtkColorChooser + a #GtkColorChooser - %GTK_ORIENTATION_HORIZONTAL if the palette should + %GTK_ORIENTATION_HORIZONTAL if the palette should be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns - the number of colors to show in each row/column + the number of colors to show in each row/column - the total number of elements in @colors + the total number of elements in @colors - - the colors of the palette, or %NULL + + the colors of the palette, or %NULL @@ -36850,17 +26112,8 @@ a color. It implements the #GtkColorChooser interface. - - The #GtkColorChooserWidget widget lets the user select a + + The #GtkColorChooserWidget widget lets the user select a color. By default, the chooser presents a predefined palette of colors, plus a small number of settable custom colors. It is also possible to select a different color with the @@ -36885,27 +26138,16 @@ GtkColorChooserWidget has a single CSS node with name colorchooser. - - Creates a new #GtkColorChooserWidget. + + Creates a new #GtkColorChooserWidget. - a new #GtkColorChooserWidget + a new #GtkColorChooserWidget - - The ::show-editor property is %TRUE when the color chooser + + The ::show-editor property is %TRUE when the color chooser is showing the single-color editor. It can be set to switch the color chooser into single-color editing mode. @@ -36914,18 +26156,13 @@ the color chooser into single-color editing mode. - + - + - The parent class. + The parent class. @@ -36993,113 +26230,70 @@ the color chooser into single-color editing mode. - + - + - Creates a new GtkColorSelection. + Creates a new GtkColorSelection. - a new #GtkColorSelection + a new #GtkColorSelection - - Parses a color palette string; the string is a colon-separated + + Parses a color palette string; the string is a colon-separated list of color names readable by gdk_color_parse(). - %TRUE if a palette was successfully parsed + %TRUE if a palette was successfully parsed - a string encoding a color palette + a string encoding a color palette - - return location for + + return location for allocated array of #GdkColor - - return location for length of array + + return location for length of array - - Encodes a palette as a string, useful for persistent storage. + + Encodes a palette as a string, useful for persistent storage. - allocated string encoding the palette + allocated string encoding the palette - an array of colors + an array of colors - length of the array + length of the array - - Installs a global function to be called whenever the user + + Installs a global function to be called whenever the user tries to modify the palette in a color selection. This function should save the new palette contents, and update @@ -37107,19 +26301,13 @@ the #GtkSettings:gtk-color-palette GtkSettings property so all GtkColorSelection widgets will be modified. - the previous change palette hook (that was replaced) - + the previous change palette hook (that was replaced) + - a function to call when the custom palette needs saving - + a function to call when the custom palette needs saving + @@ -37134,34 +26322,22 @@ GtkColorSelection widgets will be modified. - - Returns the current alpha value. + + Returns the current alpha value. - an integer between 0 and 65535 + an integer between 0 and 65535 - a #GtkColorSelection + a #GtkColorSelection - - Sets @color to be the current color in the GtkColorSelection widget. + + Sets @color to be the current color in the GtkColorSelection widget. Use gtk_color_selection_get_current_rgba() instead. @@ -37169,121 +26345,77 @@ GtkColorSelection widgets will be modified. - a #GtkColorSelection + a #GtkColorSelection - - a #GdkColor to fill in with the current color + + a #GdkColor to fill in with the current color - - Sets @rgba to be the current color in the GtkColorSelection widget. + + Sets @rgba to be the current color in the GtkColorSelection widget. - a #GtkColorSelection + a #GtkColorSelection - - a #GdkRGBA to fill in with the current color + + a #GdkRGBA to fill in with the current color - - Determines whether the colorsel has an opacity control. + + Determines whether the colorsel has an opacity control. - %TRUE if the @colorsel has an opacity control, + %TRUE if the @colorsel has an opacity control, %FALSE if it does't - a #GtkColorSelection + a #GtkColorSelection - - Determines whether the color selector has a color palette. + + Determines whether the color selector has a color palette. - %TRUE if the selector has a palette, %FALSE if it hasn't + %TRUE if the selector has a palette, %FALSE if it hasn't - a #GtkColorSelection + a #GtkColorSelection - - Returns the previous alpha value. + + Returns the previous alpha value. - an integer between 0 and 65535 + an integer between 0 and 65535 - a #GtkColorSelection + a #GtkColorSelection - - Fills @color in with the original color value. + + Fills @color in with the original color value. Use gtk_color_selection_get_previous_rgba() instead. @@ -37291,77 +26423,49 @@ GtkColorSelection widgets will be modified. - a #GtkColorSelection + a #GtkColorSelection - - a #GdkColor to fill in with the original color value + + a #GdkColor to fill in with the original color value - - Fills @rgba in with the original color value. + + Fills @rgba in with the original color value. - a #GtkColorSelection + a #GtkColorSelection - - a #GdkRGBA to fill in with the original color value + + a #GdkRGBA to fill in with the original color value - - Gets the current state of the @colorsel. + + Gets the current state of the @colorsel. - %TRUE if the user is currently dragging + %TRUE if the user is currently dragging a color around, and %FALSE if the selection has stopped - a #GtkColorSelection + a #GtkColorSelection - - Sets the current opacity to be @alpha. + + Sets the current opacity to be @alpha. The first time this is called, it will also set the original opacity to be @alpha too. @@ -37371,26 +26475,17 @@ the original opacity to be @alpha too. - a #GtkColorSelection + a #GtkColorSelection - an integer between 0 and 65535 + an integer between 0 and 65535 - - Sets the current color to be @color. + + Sets the current color to be @color. The first time this is called, it will also set the original color to be @color too. @@ -37401,25 +26496,17 @@ the original color to be @color too. - a #GtkColorSelection + a #GtkColorSelection - a #GdkColor to set the current color with + a #GdkColor to set the current color with - - Sets the current color to be @rgba. + + Sets the current color to be @rgba. The first time this is called, it will also set the original color to be @rgba too. @@ -37429,72 +26516,51 @@ the original color to be @rgba too. - a #GtkColorSelection + a #GtkColorSelection - A #GdkRGBA to set the current color with + A #GdkRGBA to set the current color with - - Sets the @colorsel to use or not use opacity. + + Sets the @colorsel to use or not use opacity. - a #GtkColorSelection + a #GtkColorSelection - %TRUE if @colorsel can set the opacity, %FALSE otherwise + %TRUE if @colorsel can set the opacity, %FALSE otherwise - - Shows and hides the palette based upon the value of @has_palette. + + Shows and hides the palette based upon the value of @has_palette. - a #GtkColorSelection + a #GtkColorSelection - %TRUE if palette is to be visible, %FALSE otherwise + %TRUE if palette is to be visible, %FALSE otherwise - - Sets the “previous” alpha to be @alpha. + + Sets the “previous” alpha to be @alpha. This function should be called with some hesitations, as it might seem confusing to have that alpha change. @@ -37504,26 +26570,17 @@ as it might seem confusing to have that alpha change. - a #GtkColorSelection + a #GtkColorSelection - an integer between 0 and 65535 + an integer between 0 and 65535 - - Sets the “previous” color to be @color. + + Sets the “previous” color to be @color. This function should be called with some hesitations, as it might seem confusing to have that color change. @@ -37536,25 +26593,17 @@ set this color the first time it is called. - a #GtkColorSelection + a #GtkColorSelection - a #GdkColor to set the previous color with + a #GdkColor to set the previous color with - - Sets the “previous” color to be @rgba. + + Sets the “previous” color to be @rgba. This function should be called with some hesitations, as it might seem confusing to have that color change. @@ -37566,15 +26615,11 @@ set this color the first time it is called. - a #GtkColorSelection + a #GtkColorSelection - a #GdkRGBA to set the previous color with + a #GdkRGBA to set the previous color with @@ -37582,29 +26627,16 @@ set this color the first time it is called. - - The current GdkColor color. + + The current GdkColor color. Use #GtkColorSelection:current-rgba instead. - - The current RGBA color. + + The current RGBA color. - + @@ -37617,45 +26649,32 @@ set this color the first time it is called. - This signal is emitted when the color changes in the #GtkColorSelection + This signal is emitted when the color changes in the #GtkColorSelection according to its update policy. - + - Array of colors + Array of colors - Number of colors in the array + Number of colors in the array - + @@ -37665,29 +26684,21 @@ according to its update policy. - Array of colors + Array of colors - Number of colors in the array + Number of colors in the array - + - The parent class. + The parent class. @@ -37736,59 +26747,35 @@ according to its update policy. - - + + - Creates a new #GtkColorSelectionDialog. - + Creates a new #GtkColorSelectionDialog. + - a #GtkColorSelectionDialog. + a #GtkColorSelectionDialog. - a string containing the title text for the dialog. + a string containing the title text for the dialog. - - Retrieves the #GtkColorSelection widget embedded in the dialog. - + + Retrieves the #GtkColorSelection widget embedded in the dialog. + - the embedded #GtkColorSelection + the embedded #GtkColorSelection - a #GtkColorSelectionDialog - + a #GtkColorSelectionDialog + @@ -37808,22 +26795,17 @@ according to its update policy. - + - - + + - + @@ -37831,8 +26813,7 @@ according to its update policy. - + @@ -37840,8 +26821,7 @@ according to its update policy. - + @@ -37849,35 +26829,21 @@ according to its update policy. - + - - + + - + - - A GtkComboBox is a widget that allows the user to choose from a list of + + A GtkComboBox is a widget that allows the user to choose from a list of valid choices. The GtkComboBox displays the selected choice. When activated, the GtkComboBox displays a popup which allows the user to make a new choice. The style in which the selected value is displayed, @@ -37892,7 +26858,7 @@ would in a tree view. This is possible since GtkComboBox implements the not restricted to a flat list, it can be a real tree, and the popup will reflect the tree structure. -To allow the user to enter values not in the model, the “has-entry” +To allow the user to enter values not in the model, the “has-entry” property allows the GtkComboBox to contain a #GtkEntry. This entry can be accessed by calling gtk_bin_get_child() on the combo box. @@ -37905,12 +26871,12 @@ an entry. |[<!-- language="plain" --> combobox -├── box.linked -│ ╰── button.combo -│ ╰── box -│ ├── cellview -│ ╰── arrow -╰── window.popup +├── box.linked +│ ╰── button.combo +│ ╰── box +│ ├── cellview +│ ╰── arrow +╰── window.popup ]| A normal combobox contains a box with the .linked class, a button @@ -37919,12 +26885,12 @@ an arrow. |[<!-- language="plain" --> combobox -├── box.linked -│ ├── entry.combo -│ ╰── button.combo -│ ╰── box -│ ╰── arrow -╰── window.popup +├── box.linked +│ ├── entry.combo +│ ╰── button.combo +│ ╰── box +│ ╰── arrow +╰── window.popup ]| A GtkComboBox with an entry has a single CSS node with name combobox. It @@ -37937,116 +26903,76 @@ The button also contains another node with name arrow. - Creates a new empty #GtkComboBox. + Creates a new empty #GtkComboBox. - A new #GtkComboBox. + A new #GtkComboBox. - - Creates a new empty #GtkComboBox using @area to layout cells. + + Creates a new empty #GtkComboBox using @area to layout cells. - A new #GtkComboBox. + A new #GtkComboBox. - the #GtkCellArea to use to layout cell renderers + the #GtkCellArea to use to layout cell renderers - - Creates a new empty #GtkComboBox with an entry. + + Creates a new empty #GtkComboBox with an entry. The new combo box will use @area to layout cells. - A new #GtkComboBox. + A new #GtkComboBox. - the #GtkCellArea to use to layout cell renderers + the #GtkCellArea to use to layout cell renderers - - Creates a new empty #GtkComboBox with an entry. + + Creates a new empty #GtkComboBox with an entry. - A new #GtkComboBox. + A new #GtkComboBox. - - Creates a new #GtkComboBox with the model initialized to @model. + + Creates a new #GtkComboBox with the model initialized to @model. - A new #GtkComboBox. + A new #GtkComboBox. - A #GtkTreeModel. + A #GtkTreeModel. - - Creates a new empty #GtkComboBox with an entry + + Creates a new empty #GtkComboBox with an entry and with the model initialized to @model. - A new #GtkComboBox + A new #GtkComboBox - A #GtkTreeModel + A #GtkTreeModel @@ -38076,39 +27002,27 @@ and with the model initialized to @model. - - Returns the index of the currently active item, or -1 if there’s no + + Returns the index of the currently active item, or -1 if there’s no active item. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns `gtk_tree_path_get_indices (path)[0]`, where `path` is the #GtkTreePath of the active item. - An integer which is the index of the currently active item, - or -1 if there’s no active item. + An integer which is the index of the currently active item, + or -1 if there’s no active item. - A #GtkComboBox + A #GtkComboBox - - Returns the ID of the active row of @combo_box. This value is taken + + Returns the ID of the active row of @combo_box. This value is taken from the active row and the column specified by the #GtkComboBox:id-column property of @combo_box (see gtk_combo_box_set_id_column()). @@ -38121,87 +27035,55 @@ no row is active, or if the active row has a %NULL ID value, then %NULL is returned. - the ID of the active row, or %NULL + the ID of the active row, or %NULL - a #GtkComboBox + a #GtkComboBox - - Sets @iter to point to the currently active item, if any item is active. + + Sets @iter to point to the currently active item, if any item is active. Otherwise, @iter is left unchanged. - %TRUE if @iter was set, %FALSE otherwise + %TRUE if @iter was set, %FALSE otherwise - A #GtkComboBox + A #GtkComboBox - - A #GtkTreeIter + + A #GtkTreeIter - - Gets the current value of the :add-tearoffs property. + + Gets the current value of the :add-tearoffs property. - the current value of the :add-tearoffs property. + the current value of the :add-tearoffs property. - a #GtkComboBox + a #GtkComboBox - - Returns whether the combo box sets the dropdown button + + Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model. - %GTK_SENSITIVITY_ON if the dropdown button + %GTK_SENSITIVITY_ON if the dropdown button is sensitive when the model is empty, %GTK_SENSITIVITY_OFF if the button is always insensitive or %GTK_SENSITIVITY_AUTO if it is only sensitive as long as @@ -38210,304 +27092,196 @@ sensitive or not when there are no items in the model. - a #GtkComboBox + a #GtkComboBox - - Returns the column with column span information for @combo_box. + + Returns the column with column span information for @combo_box. - the column span column. + the column span column. - A #GtkComboBox + A #GtkComboBox - - Returns the column which @combo_box is using to get the strings + + Returns the column which @combo_box is using to get the strings from to display in the internal entry. - A column in the data source model of @combo_box. + A column in the data source model of @combo_box. - A #GtkComboBox. + A #GtkComboBox. - - Returns whether the combo box grabs focus when it is clicked + + Returns whether the combo box grabs focus when it is clicked with the mouse. See gtk_combo_box_set_focus_on_click(). Use gtk_widget_get_focus_on_click() instead - %TRUE if the combo box grabs focus when it is + %TRUE if the combo box grabs focus when it is clicked with the mouse. - a #GtkComboBox + a #GtkComboBox - - Returns whether the combo box has an entry. + + Returns whether the combo box has an entry. - whether there is an entry in @combo_box. + whether there is an entry in @combo_box. - a #GtkComboBox + a #GtkComboBox - - Returns the column which @combo_box is using to get string IDs + + Returns the column which @combo_box is using to get string IDs for values from. - A column in the data source model of @combo_box. + A column in the data source model of @combo_box. - A #GtkComboBox + A #GtkComboBox - - Returns the #GtkTreeModel which is acting as data source for @combo_box. + + Returns the #GtkTreeModel which is acting as data source for @combo_box. - A #GtkTreeModel which was passed + A #GtkTreeModel which was passed during construction. - A #GtkComboBox + A #GtkComboBox - - Gets the accessible object corresponding to the combo box’s popup. + + Gets the accessible object corresponding to the combo box’s popup. This function is mostly intended for use by accessibility technologies; applications should have little use for it. - the accessible object corresponding - to the combo box’s popup. + the accessible object corresponding + to the combo box’s popup. - a #GtkComboBox + a #GtkComboBox - - Gets whether the popup uses a fixed width matching + + Gets whether the popup uses a fixed width matching the allocated width of the combo box. - %TRUE if the popup uses a fixed width + %TRUE if the popup uses a fixed width - a #GtkComboBox + a #GtkComboBox - - Returns the current row separator function. + + Returns the current row separator function. - the current row separator function. - + the current row separator function. + - a #GtkComboBox + a #GtkComboBox - - Returns the column with row span information for @combo_box. + + Returns the column with row span information for @combo_box. - the row span column. + the row span column. - A #GtkComboBox + A #GtkComboBox - - Gets the current title of the menu in tearoff mode. See + + Gets the current title of the menu in tearoff mode. See gtk_combo_box_set_add_tearoffs(). - the menu’s title in tearoff mode. This is an internal copy of the + the menu’s title in tearoff mode. This is an internal copy of the string which must not be freed. - a #GtkComboBox + a #GtkComboBox - - Returns the wrap width which is used to determine the number of columns + + Returns the wrap width which is used to determine the number of columns for the popup menu. If the wrap width is larger than 1, the combo box is in table mode. - the wrap width. + the wrap width. - A #GtkComboBox + A #GtkComboBox - - Hides the menu or dropdown list of @combo_box. + + Hides the menu or dropdown list of @combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. @@ -38517,17 +27291,13 @@ applications should have little use for it. - a #GtkComboBox + a #GtkComboBox - Pops up the menu or dropdown list of @combo_box. + Pops up the menu or dropdown list of @combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. @@ -38539,19 +27309,13 @@ Before calling this, @combo_box must be mapped, or nothing will happen. - a #GtkComboBox + a #GtkComboBox - - Pops up the menu or dropdown list of @combo_box, the popup window + + Pops up the menu or dropdown list of @combo_box, the popup window will be grabbed so only @device and its associated pointer/keyboard are the only #GdkDevices able to send events to it. @@ -38560,51 +27324,35 @@ are the only #GdkDevices able to send events to it. - a #GtkComboBox + a #GtkComboBox - a #GdkDevice + a #GdkDevice - - Sets the active item of @combo_box to be the item at @index. + + Sets the active item of @combo_box to be the item at @index. - A #GtkComboBox + A #GtkComboBox - An index in the model passed during construction, or -1 to have + An index in the model passed during construction, or -1 to have no active item - - Changes the active row of @combo_box to the one that has an ID equal to + + Changes the active row of @combo_box to the one that has an ID equal to @active_id, or unsets the active row if @active_id is %NULL. Rows having a %NULL ID string cannot be made active by this function. @@ -38612,37 +27360,24 @@ If the #GtkComboBox:id-column property of @combo_box is unset or if no row has the given ID then the function does nothing and returns %FALSE. - %TRUE if a row with a matching ID was found. If a %NULL + %TRUE if a row with a matching ID was found. If a %NULL @active_id was given to unset the active row, the function always returns %TRUE. - a #GtkComboBox + a #GtkComboBox - - the ID of the row to select, or %NULL + + the ID of the row to select, or %NULL - - Sets the current active item to be the one referenced by @iter, or + + Sets the current active item to be the one referenced by @iter, or unsets the active item if @iter is %NULL. @@ -38650,30 +27385,17 @@ unsets the active item if @iter is %NULL. - A #GtkComboBox + A #GtkComboBox - - The #GtkTreeIter, or %NULL + + The #GtkTreeIter, or %NULL - - Sets whether the popup menu should have a tearoff + + Sets whether the popup menu should have a tearoff menu item. @@ -38681,25 +27403,17 @@ menu item. - a #GtkComboBox + a #GtkComboBox - %TRUE to add tearoff menu items + %TRUE to add tearoff menu items - - Sets whether the dropdown button of the combo box should be + + Sets whether the dropdown button of the combo box should be always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF) or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO). @@ -38708,25 +27422,17 @@ or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO). - a #GtkComboBox + a #GtkComboBox - specify the sensitivity of the dropdown button + specify the sensitivity of the dropdown button - - Sets the column with column span information for @combo_box to be + + Sets the column with column span information for @combo_box to be @column_span. The column span column contains integers which indicate how many columns an item should span. @@ -38735,25 +27441,17 @@ how many columns an item should span. - A #GtkComboBox + A #GtkComboBox - A column in the model passed during construction + A column in the model passed during construction - - Sets the model column which @combo_box should use to get strings from + + Sets the model column which @combo_box should use to get strings from to be @text_column. The column @text_column in the model of @combo_box must be of type %G_TYPE_STRING. @@ -38765,30 +27463,20 @@ This is only relevant if @combo_box has been created with - A #GtkComboBox + A #GtkComboBox - A column in @model to get the strings from for + A column in @model to get the strings from for the internal entry - - Sets whether the combo box will grab focus when it is clicked with + + Sets whether the combo box will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places -like toolbars where you don’t want the keyboard focus removed from +like toolbars where you don’t want the keyboard focus removed from the main area of the application. Use gtk_widget_set_focus_on_click() instead @@ -38797,26 +27485,18 @@ the main area of the application. - a #GtkComboBox + a #GtkComboBox - whether the combo box grabs focus when clicked + whether the combo box grabs focus when clicked with the mouse - - Sets the model column which @combo_box should use to get string IDs + + Sets the model column which @combo_box should use to get string IDs for values from. The column @id_column in the model of @combo_box must be of type %G_TYPE_STRING. @@ -38825,25 +27505,17 @@ must be of type %G_TYPE_STRING. - A #GtkComboBox + A #GtkComboBox - A column in @model to get string IDs for values from + A column in @model to get string IDs for values from - - Sets the model used by @combo_box to be @model. Will unset a previously set + + Sets the model used by @combo_box to be @model. Will unset a previously set model (if applicable). If model is %NULL, then it will unset the model. Note that this function does not clear the cell renderers, you have to @@ -38855,28 +27527,17 @@ cell renderers for the new model. - A #GtkComboBox + A #GtkComboBox - - A #GtkTreeModel + + A #GtkTreeModel - - Specifies whether the popup’s width should be a fixed width + + Specifies whether the popup’s width should be a fixed width matching the allocated width of the combo box. @@ -38884,25 +27545,17 @@ matching the allocated width of the combo box. - a #GtkComboBox + a #GtkComboBox - whether to use a fixed popup width + whether to use a fixed popup width - - Sets the row separator function, which is used to determine + + Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is %NULL, no separators are drawn. This is the default value. @@ -38911,49 +27564,25 @@ function is %NULL, no separators are drawn. This is the default value. - a #GtkComboBox + a #GtkComboBox - - a #GtkTreeViewRowSeparatorFunc - + + a #GtkTreeViewRowSeparatorFunc + - - user data to pass to @func, or %NULL + + user data to pass to @func, or %NULL - - destroy notifier for @data, or %NULL + + destroy notifier for @data, or %NULL - - Sets the column with row span information for @combo_box to be @row_span. + + Sets the column with row span information for @combo_box to be @row_span. The row span column contains integers which indicate how many rows an item should span. @@ -38962,52 +27591,34 @@ an item should span. - A #GtkComboBox. + A #GtkComboBox. - A column in the model passed during construction. + A column in the model passed during construction. - - Sets the menu’s title in tearoff mode. + + Sets the menu’s title in tearoff mode. - a #GtkComboBox + a #GtkComboBox - a title for the menu in tearoff mode + a title for the menu in tearoff mode - - Sets the wrap width of @combo_box to be @width. The wrap width is basically + + Sets the wrap width of @combo_box to be @width. The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table. @@ -39016,190 +27627,103 @@ in a table. - A #GtkComboBox + A #GtkComboBox - Preferred number of columns + Preferred number of columns - - The item which is currently active. If the model is a non-flat treemodel, + + The item which is currently active. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this property has the value `gtk_tree_path_get_indices (path)[0]`, where `path` is the #GtkTreePath of the active item. - - The value of the ID column of the active row. + + The value of the ID column of the active row. - - The add-tearoffs property controls whether generated menus + + The add-tearoffs property controls whether generated menus have tearoff menu items. Note that this only affects menu style combo boxes. - - Whether the dropdown button is sensitive when + + Whether the dropdown button is sensitive when the model is empty. - - The #GtkCellArea used to layout cell renderers for this combo box. + + The #GtkCellArea used to layout cell renderers for this combo box. If no area is specified when creating the combo box with gtk_combo_box_new_with_area() a horizontally oriented #GtkCellAreaBox will be used. - - If this is set to a non-negative value, it must be the index of a column + + If this is set to a non-negative value, it must be the index of a column of type %G_TYPE_INT in the model. The value in that column for each item will determine how many columns that item will span in the popup. Therefore, values in this column must be greater than zero, and the sum of -an item’s column position + span should not exceed #GtkComboBox:wrap-width. +an item’s column position + span should not exceed #GtkComboBox:wrap-width. - - The column in the combo box's model to associate with strings from the entry + + The column in the combo box's model to associate with strings from the entry if the combo was created with #GtkComboBox:has-entry = %TRUE. - - Whether the combo box has an entry. + + Whether the combo box has an entry. - - The has-frame property controls whether a frame + + The has-frame property controls whether a frame is drawn around the entry. - - The column in the combo box's model that provides string + + The column in the combo box's model that provides string IDs for the values in the model, if != -1. - - The model from which the combo box takes the values shown + + The model from which the combo box takes the values shown in the list. - - Whether the popup's width should be a fixed width matching the + + Whether the popup's width should be a fixed width matching the allocated width of the combo box. - Whether the combo boxes dropdown is popped up. + Whether the combo boxes dropdown is popped up. Note that this property is mainly useful, because it allows you to connect to notify::popup-shown. - - If this is set to a non-negative value, it must be the index of a column + + If this is set to a non-negative value, it must be the index of a column of type %G_TYPE_INT in the model. The value in that column for each item will determine how many rows that item will span in the popup. Therefore, values in this column must be greater than zero. - - A title that may be displayed by the window manager + + A title that may be displayed by the window manager when the popup is torn-off. - - If wrap-width is set to a positive value, items in the popup will be laid + + If wrap-width is set to a positive value, items in the popup will be laid out along multiple columns, starting a new row on reaching the wrap width. @@ -39210,9 +27734,7 @@ out along multiple columns, starting a new row on reaching the wrap width. - The changed signal is emitted when the active + The changed signal is emitted when the active item is changed. The can be due to the user selecting a different item from the list, or due to a call to gtk_combo_box_set_active_iter(). @@ -39223,9 +27745,7 @@ with an entry. - For combo boxes that are created with an entry (See GtkComboBox:has-entry). + For combo boxes that are created with an entry (See GtkComboBox:has-entry). A signal which allows you to change how the text displayed in a combo box's entry is displayed. @@ -39258,25 +27778,19 @@ format_entry_text_callback (GtkComboBox *combo, } ]| - a newly allocated string representing @path + a newly allocated string representing @path for the current GtkComboBox model. - the GtkTreePath string from the combo box's current model to format text for + the GtkTreePath string from the combo box's current model to format text for - The ::move-active signal is a + The ::move-active signal is a [keybinding signal][GtkBindingSignal] which gets emitted to move the active selection. @@ -39284,17 +27798,13 @@ which gets emitted to move the active selection. - a #GtkScrollType + a #GtkScrollType - The ::popdown signal is a + The ::popdown signal is a [keybinding signal][GtkBindingSignal] which gets emitted to popdown the combo box list. @@ -39304,9 +27814,7 @@ The default bindings for this signal are Alt+Up and Escape. - The ::popup signal is a + The ::popup signal is a [keybinding signal][GtkBindingSignal] which gets emitted to popup the combo box list. @@ -39316,13 +27824,7 @@ The default binding for this signal is Alt+Down. - + @@ -39331,32 +27833,22 @@ The default binding for this signal is Alt+Down. - + - + - + - + - + - The parent class. + The parent class. @@ -39416,16 +27908,8 @@ The default binding for this signal is Alt+Down. - - A GtkComboBoxText is a simple variant of #GtkComboBox that hides + + A GtkComboBoxText is a simple variant of #GtkComboBox that hides the model-view complexity for simple text-only use cases. To create a GtkComboBoxText, use gtk_combo_box_text_new() or @@ -39436,7 +27920,7 @@ gtk_combo_box_text_append_text(), gtk_combo_box_text_insert_text() or gtk_combo_box_text_prepend_text() and remove options with gtk_combo_box_text_remove(). -If the GtkComboBoxText contains an entry (via the “has-entry” property), +If the GtkComboBoxText contains an entry (via the “has-entry” property), its contents can be retrieved using gtk_combo_box_text_get_active_text(). The entry itself can be accessed by calling gtk_bin_get_child() on the combo box. @@ -39448,9 +27932,9 @@ into this combo box via its GtkCellLayout interface. The GtkComboBoxText implementation of the GtkBuildable interface supports adding items directly using the <items> element and specifying <item> -elements for each item. Each <item> element can specify the “id” +elements for each item. Each <item> element can specify the “id” corresponding to the appended text and also supports the regular -translation attributes “translatable”, “context” and “comments”. +translation attributes “translatable”, “context” and “comments”. Here is a UI definition fragment specifying GtkComboBoxText items: |[ @@ -39467,10 +27951,10 @@ Here is a UI definition fragment specifying GtkComboBoxText items: |[<!-- language="plain" --> combobox -╰── box.linked - ├── entry.combo - ├── button.combo - ╰── window.popup +╰── box.linked + ├── entry.combo + ├── button.combo + ╰── window.popup ]| GtkComboBoxText has a single CSS node with name combobox. It adds @@ -39481,42 +27965,26 @@ children, and the .linked class to the node of its internal box. - - Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying + + Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying strings. - A new #GtkComboBoxText + A new #GtkComboBoxText - - Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying + + Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying strings. The combo box created by this function has an entry. - a new #GtkComboBoxText + a new #GtkComboBoxText - - Appends @text to the list of strings stored in @combo_box. + + Appends @text to the list of strings stored in @combo_box. If @id is non-%NULL then it is used as the ID of the row. This is the same as calling gtk_combo_box_text_insert() with a @@ -39527,34 +27995,21 @@ position of -1. - A #GtkComboBoxText + A #GtkComboBoxText - - a string ID for this value, or %NULL + + a string ID for this value, or %NULL - A string + A string - - Appends @text to the list of strings stored in @combo_box. + + Appends @text to the list of strings stored in @combo_box. This is the same as calling gtk_combo_box_text_insert_text() with a position of -1. @@ -39564,51 +28019,35 @@ position of -1. - A #GtkComboBoxText + A #GtkComboBoxText - A string + A string - - Returns the currently active string in @combo_box, or %NULL + + Returns the currently active string in @combo_box, or %NULL if none is selected. If @combo_box contains an entry, this function will return its contents (which will not necessarily be an item from the list). - a newly allocated string containing the + a newly allocated string containing the currently active text. Must be freed with g_free(). - A #GtkComboBoxText + A #GtkComboBoxText - - Inserts @text at @position in the list of strings stored in @combo_box. + + Inserts @text at @position in the list of strings stored in @combo_box. If @id is non-%NULL then it is used as the ID of the row. See #GtkComboBox:id-column. @@ -39619,40 +28058,25 @@ If @position is negative then @text is appended. - A #GtkComboBoxText + A #GtkComboBoxText - An index to insert @text + An index to insert @text - - a string ID for this value, or %NULL + + a string ID for this value, or %NULL - A string to display + A string to display - - Inserts @text at @position in the list of strings stored in @combo_box. + + Inserts @text at @position in the list of strings stored in @combo_box. If @position is negative then @text is appended. @@ -39664,31 +28088,21 @@ ID string. - A #GtkComboBoxText + A #GtkComboBoxText - An index to insert @text + An index to insert @text - A string + A string - - Prepends @text to the list of strings stored in @combo_box. + + Prepends @text to the list of strings stored in @combo_box. If @id is non-%NULL then it is used as the ID of the row. This is the same as calling gtk_combo_box_text_insert() with a @@ -39699,34 +28113,21 @@ position of 0. - A #GtkComboBox + A #GtkComboBox - - a string ID for this value, or %NULL + + a string ID for this value, or %NULL - a string + a string - - Prepends @text to the list of strings stored in @combo_box. + + Prepends @text to the list of strings stored in @combo_box. This is the same as calling gtk_combo_box_text_insert_text() with a position of 0. @@ -39736,59 +28137,41 @@ position of 0. - A #GtkComboBox + A #GtkComboBox - A string + A string - - Removes the string at @position from @combo_box. + + Removes the string at @position from @combo_box. - A #GtkComboBox + A #GtkComboBox - Index of the item to remove + Index of the item to remove - - Removes all the text entries from the combo box. + + Removes all the text entries from the combo box. - A #GtkComboBoxText + A #GtkComboBoxText @@ -39800,9 +28183,7 @@ position of 0. - + @@ -39840,22 +28221,11 @@ position of 0. - + - - A GTK+ user interface is constructed by nesting widgets inside widgets. + + A GTK+ user interface is constructed by nesting widgets inside widgets. Container widgets are the inner nodes in the resulting tree of widgets: they contain other widgets. So, for example, you might have a #GtkWindow containing a #GtkFrame containing a #GtkLabel. If you wanted an image instead @@ -39895,8 +28265,8 @@ depending on the amount of horizontal space that it is given (and similar for width-for-height). There are some things to keep in mind when implementing container widgets -that make use of GTK+’s height for width geometry management system. First, -it’s important to note that a container must prioritize one of its +that make use of GTK+’s height for width geometry management system. First, +it’s important to note that a container must prioritize one of its dimensions, that is to say that a widget or container can only have a #GtkSizeRequestMode that is %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container @@ -39984,7 +28354,7 @@ allocated using the gtk_distribute_natural_allocation() convenience function. The container will then move on to request the preferred height for each child by using gtk_widget_get_preferred_height_for_width() and using the sizes stored in the #GtkRequestedSize array. -To allocate a height-for-width container, it’s again important +To allocate a height-for-width container, it’s again important to consider that a container must prioritize one dimension over the other. So if a container is a height-for-width container it must first allocate all widgets horizontally using a #GtkRequestedSize array and gtk_distribute_natural_allocation() and then add any @@ -40000,7 +28370,7 @@ while this time considering the allocated height of the widget minus any vertica that the container adds. Then vertical expand space should be added where appropriate and available and the container should go on to actually allocating the child widgets. -See [GtkWidget’s geometry management section][geometry-management] +See [GtkWidget’s geometry management section][geometry-management] to learn more about implementing height-for-width geometry management for widgets. # Child properties @@ -40030,12 +28400,12 @@ a <packing> element for children, which can contain multiple <property& elements that specify child properties for the child. Since 2.16, child properties can also be marked as translatable using -the same “translatable”, “comments” and “context” attributes that are used +the same “translatable”, “comments” and “context” attributes that are used for regular properties. Since 3.16, containers can have a <focus-chain> element containing multiple <widget> elements, one for each child that should be added to the focus -chain. The ”name” attribute gives the id of the widget. +chain. The ”name” attribute gives the id of the widget. An example of these properties in UI definitions: |[ @@ -40059,16 +28429,14 @@ An example of these properties in UI definitions: - Adds @widget to @container. Typically used for simple containers + Adds @widget to @container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; -you can’t place the same widget inside two different containers. +you can’t place the same widget inside two different containers. Note that some containers, such as #GtkScrolledWindow or #GtkListBox, may add intermediate children between the added widget and the @@ -40079,15 +28447,11 @@ container. - a #GtkContainer + a #GtkContainer - a widget to be placed inside @container + a widget to be placed inside @container @@ -40104,25 +28468,19 @@ container. - Returns the type of the children supported by the container. + Returns the type of the children supported by the container. Note that this may return %G_TYPE_NONE to indicate that no more children can be added, e.g. for a #GtkPaned which already has two children. - a #GType. + a #GType. - a #GtkContainer + a #GtkContainer @@ -40142,11 +28500,9 @@ children. - Invokes @callback on each direct child of @container, including -children that are considered “internal” (implementation details -of the container). “Internal” children generally weren’t added + Invokes @callback on each direct child of @container, including +children that are considered “internal” (implementation details +of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself. @@ -40158,30 +28514,18 @@ than gtk_container_forall(). - a #GtkContainer + a #GtkContainer - - a callback + + a callback - - callback user data + + callback user data @@ -40210,42 +28554,32 @@ than gtk_container_forall(). - Returns a newly created widget path representing all the widget hierarchy + Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including @child. - A newly created #GtkWidgetPath + A newly created #GtkWidgetPath - a #GtkContainer + a #GtkContainer - a child of @container + a child of @container - Removes @widget from @container. @widget must be inside @container. + Removes @widget from @container. @widget must be inside @container. Note that @container will own a reference to @widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use @widget again, you need to add a reference to it before removing it from -a container, using g_object_ref(). If you don’t want to use @widget -again it’s usually more efficient to simply destroy it directly +a container, using g_object_ref(). If you don’t want to use @widget +again it’s usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles. @@ -40254,15 +28588,11 @@ container and help break any circular reference count cycles. - a #GtkContainer + a #GtkContainer - a current child of @container + a current child of @container @@ -40291,9 +28621,7 @@ container and help break any circular reference count cycles. - Sets, or unsets if @child is %NULL, the focused child of @container. + Sets, or unsets if @child is %NULL, the focused child of @container. This function emits the GtkContainer::set_focus_child signal of @container. Implementations of #GtkContainer can override the @@ -40307,33 +28635,24 @@ gtk_widget_grab_focus() to manually set the focus to a specific widget. - a #GtkContainer + a #GtkContainer - - a #GtkWidget, or %NULL + + a #GtkWidget, or %NULL - Adds @widget to @container. Typically used for simple containers + Adds @widget to @container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; -you can’t place the same widget inside two different containers. +you can’t place the same widget inside two different containers. Note that some containers, such as #GtkScrolledWindow or #GtkListBox, may add intermediate children between the added widget and the @@ -40344,25 +28663,17 @@ container. - a #GtkContainer + a #GtkContainer - a widget to be placed inside @container + a widget to be placed inside @container - - Adds @widget to @container, setting child properties at the same time. + + Adds @widget to @container, setting child properties at the same time. See gtk_container_add() and gtk_container_child_set() for more details. @@ -40370,27 +28681,19 @@ See gtk_container_add() and gtk_container_child_set() for more details. - a #GtkContainer + a #GtkContainer - a widget to be placed inside @container + a widget to be placed inside @container - the name of the first child property to set + the name of the first child property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name @@ -40407,124 +28710,85 @@ See gtk_container_add() and gtk_container_child_set() for more details. - - Gets the values of one or more child properties for @child and @container. + + Gets the values of one or more child properties for @child and @container. - a #GtkContainer + a #GtkContainer - a widget which is a child of @container + a widget which is a child of @container - the name of the first property to get + the name of the first property to get - return location for the first property, followed + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - - Gets the value of a child property for @child and @container. + + Gets the value of a child property for @child and @container. - a #GtkContainer + a #GtkContainer - a widget which is a child of @container + a widget which is a child of @container - the name of the property to get + the name of the property to get - - a location to return the value + + a location to return the value - - Gets the values of one or more child properties for @child and @container. + + Gets the values of one or more child properties for @child and @container. - a #GtkContainer + a #GtkContainer - a widget which is a child of @container + a widget which is a child of @container - the name of the first property to get + the name of the first property to get - return location for the first property, followed + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - - Emits a #GtkWidget::child-notify signal for the + + Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on the child. @@ -40537,32 +28801,22 @@ Also see gtk_widget_child_notify(). - the #GtkContainer + the #GtkContainer - the child widget + the child widget - the name of a child property installed on + the name of a child property installed on the class of @container - - Emits a #GtkWidget::child-notify signal for the + + Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by @pspec on the child. @@ -40573,168 +28827,119 @@ This is an analogue of g_object_notify_by_pspec() for child properties. - the #GtkContainer + the #GtkContainer - the child widget + the child widget - the #GParamSpec of a child property instealled on + the #GParamSpec of a child property instealled on the class of @container - - Sets one or more child properties for @child and @container. + + Sets one or more child properties for @child and @container. - a #GtkContainer + a #GtkContainer - a widget which is a child of @container + a widget which is a child of @container - the name of the first property to set + the name of the first property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - - Sets a child property for @child and @container. + + Sets a child property for @child and @container. - a #GtkContainer + a #GtkContainer - a widget which is a child of @container + a widget which is a child of @container - the name of the property to set + the name of the property to set - the value to set the property to + the value to set the property to - - Sets one or more child properties for @child and @container. + + Sets one or more child properties for @child and @container. - a #GtkContainer + a #GtkContainer - a widget which is a child of @container + a widget which is a child of @container - the name of the first property to set + the name of the first property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - Returns the type of the children supported by the container. + Returns the type of the children supported by the container. Note that this may return %G_TYPE_NONE to indicate that no more children can be added, e.g. for a #GtkPaned which already has two children. - a #GType. + a #GType. - a #GtkContainer + a #GtkContainer - Invokes @callback on each direct child of @container, including -children that are considered “internal” (implementation details -of the container). “Internal” children generally weren’t added + Invokes @callback on each direct child of @container, including +children that are considered “internal” (implementation details +of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself. @@ -40746,37 +28951,23 @@ than gtk_container_forall(). - a #GtkContainer + a #GtkContainer - - a callback + + a callback - - callback user data + + callback user data - Invokes @callback on each non-internal child of @container. + Invokes @callback on each non-internal child of @container. See gtk_container_forall() for details on what constitutes -an “internal” child. For all practical purposes, this function +an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls. @@ -40791,83 +28982,53 @@ rather than gtk_container_forall(). - a #GtkContainer + a #GtkContainer - - a callback + + a callback - - callback user data + + callback user data - - Retrieves the border width of the container. See + + Retrieves the border width of the container. See gtk_container_set_border_width(). - the current border width + the current border width - a #GtkContainer + a #GtkContainer - Returns the container’s non-internal children. See + Returns the container’s non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child. - a newly-allocated list of the container’s non-internal children. + a newly-allocated list of the container’s non-internal children. - a #GtkContainer + a #GtkContainer - - Retrieves the focus chain of the container, if one has been + + Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores %NULL in @@ -40876,26 +29037,17 @@ of the children. In that case, GTK+ stores %NULL in GtkWidgetClass::focus signal. - %TRUE if the focus chain of the container + %TRUE if the focus chain of the container has been set explicitly. - a #GtkContainer + a #GtkContainer - - location + + location to store the focus chain of the container, or %NULL. You should free this list using g_list_free() when you are done with it, however @@ -40907,139 +29059,96 @@ has been set explicitly. - - Returns the current focus child widget inside @container. This is not the + + Returns the current focus child widget inside @container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus(). - The child widget which will receive the + The child widget which will receive the focus inside @container when the @container is focused, or %NULL if none is set. - a #GtkContainer + a #GtkContainer - - Retrieves the horizontal focus adjustment for the container. See + + Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment (). - the horizontal focus adjustment, or %NULL if + the horizontal focus adjustment, or %NULL if none has been set. - a #GtkContainer + a #GtkContainer - - Retrieves the vertical focus adjustment for the container. See + + Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment(). - the vertical focus adjustment, or + the vertical focus adjustment, or %NULL if none has been set. - a #GtkContainer + a #GtkContainer - - Returns a newly created widget path representing all the widget hierarchy + + Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including @child. - A newly created #GtkWidgetPath + A newly created #GtkWidgetPath - a #GtkContainer + a #GtkContainer - a child of @container + a child of @container - - Returns the resize mode for the container. See + + Returns the resize mode for the container. See gtk_container_set_resize_mode (). - Resize modes are deprecated. They aren’t necessary + Resize modes are deprecated. They aren’t necessary anymore since frame clocks and might introduce obscure bugs if used. - the current resize mode + the current resize mode - a #GtkContainer + a #GtkContainer - - When a container receives a call to the draw function, it must send -synthetic #GtkWidget::draw calls to all children that don’t have their + + When a container receives a call to the draw function, it must send +synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk_container_propagate_draw() once for each child, passing in @@ -41059,37 +29168,29 @@ and then chain to the ::draw implementation from #GtkContainer. - a #GtkContainer + a #GtkContainer - a child of @container + a child of @container - Cairo context as passed to the container. If you want to use @cr - in container’s draw function, consider using cairo_save() and + Cairo context as passed to the container. If you want to use @cr + in container’s draw function, consider using cairo_save() and cairo_restore() before calling this function. - Removes @widget from @container. @widget must be inside @container. + Removes @widget from @container. @widget must be inside @container. Note that @container will own a reference to @widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use @widget again, you need to add a reference to it before removing it from -a container, using g_object_ref(). If you don’t want to use @widget -again it’s usually more efficient to simply destroy it directly +a container, using g_object_ref(). If you don’t want to use @widget +again it’s usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles. @@ -41098,45 +29199,33 @@ container and help break any circular reference count cycles. - a #GtkContainer + a #GtkContainer - a current child of @container + a current child of @container - + - a #GtkContainer + a #GtkContainer - - Sets the border width of the container. + + Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is -#GtkWindow; because toplevel windows can’t leave space outside, +#GtkWindow; because toplevel windows can’t leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, use a specific #GtkWidget:margin property on the child widget, for example @@ -41147,32 +29236,23 @@ the container. To add space to only one side, use a specific - a #GtkContainer + a #GtkContainer - amount of blank space to leave outside + amount of blank space to leave outside the container. Valid values are in the range 0-65535 pixels. - - Sets a focus chain, overriding the one computed automatically by GTK+. + + Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the -container, but this is not enforced by this method, since it’s allowed +container, but this is not enforced by this method, since it’s allowed to set the focus chain before you pack the widgets, or have a widget -in the chain that isn’t always packed. The necessary checks are done +in the chain that isn’t always packed. The necessary checks are done when the focus chain is actually traversed. For overriding focus behavior, use the GtkWidgetClass::focus signal. @@ -41182,15 +29262,11 @@ when the focus chain is actually traversed. - a #GtkContainer + a #GtkContainer - + the new focus chain @@ -41198,11 +29274,8 @@ when the focus chain is actually traversed. - - Sets, or unsets if @child is %NULL, the focused child of @container. + + Sets, or unsets if @child is %NULL, the focused child of @container. This function emits the GtkContainer::set_focus_child signal of @container. Implementations of #GtkContainer can override the @@ -41216,27 +29289,17 @@ gtk_widget_grab_focus() to manually set the focus to a specific widget. - a #GtkContainer + a #GtkContainer - - a #GtkWidget, or %NULL + + a #GtkWidget, or %NULL - - Hooks up an adjustment to focus handling in a container, so when a child + + Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining @@ -41251,25 +29314,18 @@ system as the allocation for immediate children of the container. - a #GtkContainer + a #GtkContainer - an adjustment which should be adjusted when the focus is + an adjustment which should be adjusted when the focus is moved among the descendents of @container - - Hooks up an adjustment to focus handling in a container, so when a + + Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining @@ -41284,27 +29340,18 @@ system as the allocation for immediate children of the container. - a #GtkContainer + a #GtkContainer - an adjustment which should be adjusted when the focus + an adjustment which should be adjusted when the focus is moved among the descendents of @container - - Sets the @reallocate_redraws flag of the container to the given value. + + Sets the @reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation. @@ -41315,31 +29362,22 @@ redrawn if any of their children changed allocation. - a #GtkContainer + a #GtkContainer - the new value for the container’s @reallocate_redraws flag + the new value for the container’s @reallocate_redraws flag - - Sets the resize mode for the container. + + Sets the resize mode for the container. The resize mode of a container determines whether a resize request -will be passed to the container’s parent, queued for later execution +will be passed to the container’s parent, queued for later execution or executed immediately. - Resize modes are deprecated. They aren’t necessary + Resize modes are deprecated. They aren’t necessary anymore since frame clocks and might introduce obscure bugs if used. @@ -41348,26 +29386,17 @@ or executed immediately. - a #GtkContainer + a #GtkContainer - the new resize mode + the new resize mode - - Removes a focus chain explicitly set with gtk_container_set_focus_chain(). + + Removes a focus chain explicitly set with gtk_container_set_focus_chain(). For overriding focus behavior, use the GtkWidgetClass::focus signal. @@ -41376,9 +29405,7 @@ or executed immediately. - a #GtkContainer + a #GtkContainer @@ -41386,10 +29413,7 @@ or executed immediately. - + @@ -41437,34 +29461,24 @@ or executed immediately. - + - + - + - + @@ -41483,8 +29497,7 @@ or executed immediately. - + @@ -41502,55 +29515,37 @@ or executed immediately. - + - - + + - + - + - - + + - + - - Get a list of children. - + + Get a list of children. + @@ -41558,25 +29553,19 @@ or executed immediately. - the container - + the container + - - + + - + @@ -41587,36 +29576,23 @@ or executed immediately. - + - - + + - - + + - - Base class for containers. + + Base class for containers. - The parent class. + The parent class. @@ -41627,15 +29603,11 @@ or executed immediately. - a #GtkContainer + a #GtkContainer - a widget to be placed inside @container + a widget to be placed inside @container @@ -41649,15 +29621,11 @@ or executed immediately. - a #GtkContainer + a #GtkContainer - a current child of @container + a current child of @container @@ -41684,30 +29652,18 @@ or executed immediately. - a #GtkContainer + a #GtkContainer - - a callback + + a callback - - callback user data + + callback user data @@ -41721,18 +29677,11 @@ or executed immediately. - a #GtkContainer + a #GtkContainer - - a #GtkWidget, or %NULL + + a #GtkWidget, or %NULL @@ -41742,16 +29691,12 @@ or executed immediately. - a #GType. + a #GType. - a #GtkContainer + a #GtkContainer @@ -41827,22 +29772,16 @@ or executed immediately. - A newly created #GtkWidgetPath + A newly created #GtkWidgetPath - a #GtkContainer + a #GtkContainer - a child of @container + a child of @container @@ -41915,40 +29854,28 @@ or executed immediately. - - Finds a child property of a container class by name. + + Finds a child property of a container class by name. - the #GParamSpec of the child + the #GParamSpec of the child property or %NULL if @class has no child property with that name. - a #GtkContainerClass + a #GtkContainerClass - the name of the child property to find + the name of the child property to find - - Modifies a subclass of #GtkContainerClass to automatically add and + + Modifies a subclass of #GtkContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this @@ -41956,7 +29883,7 @@ in its class_init function. gtk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So -subclasses must “opt in” to the parent class handling border_width +subclasses must “opt in” to the parent class handling border_width for them. @@ -41964,40 +29891,28 @@ for them. - the class struct of a #GtkContainer subclass + the class struct of a #GtkContainer subclass - - Installs child properties on a container class. + + Installs child properties on a container class. - a #GtkContainerClass + a #GtkContainerClass - the length of the #GParamSpec array + the length of the #GParamSpec array - the #GParamSpec array defining the new + the #GParamSpec array defining the new child properties @@ -42005,46 +29920,32 @@ for them. - - Installs a child property on a container class. + + Installs a child property on a container class. - a #GtkContainerClass + a #GtkContainerClass - the id for the property + the id for the property - the #GParamSpec for the property + the #GParamSpec for the property - - Returns all child properties of a container class. + + Returns all child properties of a container class. - + a newly allocated %NULL-terminated array of #GParamSpec*. The array must be freed with g_free(). @@ -42053,18 +29954,11 @@ for them. - a #GtkContainerClass + a #GtkContainerClass - - location to return the number of child properties found + + location to return the number of child properties found @@ -42073,62 +29967,29 @@ for them. - - Specifies which corner a child widget should be placed in when packed into + + Specifies which corner a child widget should be placed in when packed into a #GtkScrolledWindow. This is effectively the opposite of where the scroll bars are placed. - - Place the scrollbars on the right and bottom of the + + Place the scrollbars on the right and bottom of the widget (default behaviour). - - Place the scrollbars on the top and right of the + + Place the scrollbars on the top and right of the widget. - - Place the scrollbars on the left and bottom of the + + Place the scrollbars on the left and bottom of the widget. - - Place the scrollbars on the top and left of the + + Place the scrollbars on the top and left of the widget. - - GtkCssProvider is an object implementing the #GtkStyleProvider interface. + + GtkCssProvider is an object implementing the #GtkStyleProvider interface. It is able to parse [CSS-like][css-overview] input in order to style widgets. An application can make GTK+ parse a specific CSS style sheet by calling @@ -42154,61 +30015,39 @@ key theme, as defined by #GtkSettings:gtk-key-theme-name. - Returns a newly created #GtkCssProvider. + Returns a newly created #GtkCssProvider. - A new #GtkCssProvider + A new #GtkCssProvider - - Returns the provider containing the style settings used as a + + Returns the provider containing the style settings used as a fallback for all widgets. Use gtk_css_provider_new() instead. - The provider used for fallback styling. + The provider used for fallback styling. This memory is owned by GTK+, and you must not free it. - Loads a theme from the usual theme paths + Loads a theme from the usual theme paths - a #GtkCssProvider with the theme loaded. + a #GtkCssProvider with the theme loaded. This memory is owned by GTK+, and you must not free it. - A theme name + A theme name - - variant to load, for example, "dark", or + + variant to load, for example, "dark", or %NULL for the default @@ -42231,18 +30070,12 @@ fallback for all widgets. - - Loads @data into @css_provider, and by doing so clears any previously loaded + + Loads @data into @css_provider, and by doing so clears any previously loaded information. - %TRUE. The return value is deprecated and %FALSE will only be + %TRUE. The return value is deprecated and %FALSE will only be returned for backwards compatibility reasons if an @error is not %NULL and a loading error occurred. To track errors while loading CSS, connect to the #GtkCssProvider::parsing-error signal. @@ -42250,41 +30083,29 @@ information. - a #GtkCssProvider + a #GtkCssProvider - CSS data loaded in memory + CSS data loaded in memory - the length of @data in bytes, or -1 for NUL terminated strings. If + the length of @data in bytes, or -1 for NUL terminated strings. If @length is not -1, the code will assume it is not NUL terminated and will potentially do a copy. - - Loads the data contained in @file into @css_provider, making it + + Loads the data contained in @file into @css_provider, making it clear any previously loaded information. - %TRUE. The return value is deprecated and %FALSE will only be + %TRUE. The return value is deprecated and %FALSE will only be returned for backwards compatibility reasons if an @error is not %NULL and a loading error occurred. To track errors while loading CSS, connect to the #GtkCssProvider::parsing-error signal. @@ -42292,31 +30113,21 @@ clear any previously loaded information. - a #GtkCssProvider + a #GtkCssProvider - #GFile pointing to a file to load + #GFile pointing to a file to load - - Loads the data contained in @path into @css_provider, making it clear + + Loads the data contained in @path into @css_provider, making it clear any previously loaded information. - %TRUE. The return value is deprecated and %FALSE will only be + %TRUE. The return value is deprecated and %FALSE will only be returned for backwards compatibility reasons if an @error is not %NULL and a loading error occurred. To track errors while loading CSS, connect to the #GtkCssProvider::parsing-error signal. @@ -42324,25 +30135,17 @@ any previously loaded information. - a #GtkCssProvider + a #GtkCssProvider - the path of a filename to load, in the GLib filename encoding + the path of a filename to load, in the GLib filename encoding - - Loads the data contained in the resource at @resource_path into + + Loads the data contained in the resource at @resource_path into the #GtkCssProvider, clearing any previously loaded information. To track errors while loading CSS, connect to the @@ -42353,25 +30156,17 @@ To track errors while loading CSS, connect to the - a #GtkCssProvider + a #GtkCssProvider - a #GResource resource path + a #GResource resource path - - Converts the @provider into a string representation in CSS + + Converts the @provider into a string representation in CSS format. Using gtk_css_provider_load_from_data() with the return value @@ -42380,16 +30175,12 @@ gtk_css_provider_new() will basically create a duplicate of this @provider. - a new string representing the @provider. + a new string representing the @provider. - the provider to write to a string + the provider to write to a string @@ -42401,9 +30192,7 @@ this @provider. - Signals that a parsing error occurred. the @path, @line and @position + Signals that a parsing error occurred. the @path, @line and @position describe the actual location of the error as accurately as possible. Parsing errors are never fatal, so the parsing will resume after @@ -42419,23 +30208,17 @@ than when a loading function was called. - section the error happened in + section the error happened in - The parsing error + The parsing error - + @@ -42484,61 +30267,25 @@ than when a loading function was called. - - Error codes for %GTK_CSS_PROVIDER_ERROR. - - Failed. + + Error codes for %GTK_CSS_PROVIDER_ERROR. + + Failed. - - Syntax error. + + Syntax error. - - Import error. + + Import error. - - Name error. + + Name error. - - Deprecation error. + + Deprecation error. - - Unknown value. + + Unknown value. @@ -42546,29 +30293,16 @@ than when a loading function was called. - + - - Defines a part of a CSS document. Because sections are nested into + + Defines a part of a CSS document. Because sections are nested into one another, you can use gtk_css_section_get_parent() to get the containing region. - - Returns the line in the CSS document where this section end. + + Returns the line in the CSS document where this section end. The line number is 0-indexed, so the first line of the document will return 0. This value may change in future invocations of this function if @@ -42579,26 +30313,18 @@ position and line for sections which failed to parse anything successfully. - the line number + the line number - the section + the section - - Returns the offset in bytes from the start of the current line + + Returns the offset in bytes from the start of the current line returned via gtk_css_section_get_end_line(). This value may change in future invocations of this function if @section is not yet parsed completely. This will for example @@ -42608,51 +30334,35 @@ position and line for sections which failed to parse anything successfully. - the offset in bytes from the start of the line. + the offset in bytes from the start of the line. - the section + the section - - Gets the file that @section was parsed from. If no such file exists, + + Gets the file that @section was parsed from. If no such file exists, for example because the CSS was loaded via @gtk_css_provider_load_from_data(), then %NULL is returned. - the #GFile that @section was parsed from + the #GFile that @section was parsed from or %NULL if @section was parsed from other data - the section + the section - - Gets the parent section for the given @section. The parent section is + + Gets the parent section for the given @section. The parent section is the section that contains this @section. A special case are sections of type #GTK_CSS_SECTION_DOCUMENT. Their parent will either be %NULL if they are the original CSS document that was loaded by @@ -42661,113 +30371,77 @@ gtk_css_provider_load_from_file() or a section of type a different file. - the parent section or %NULL if none + the parent section or %NULL if none - the section + the section - - Gets the type of information that @section describes. + + Gets the type of information that @section describes. - the type of @section + the type of @section - the section + the section - - Returns the line in the CSS document where this section starts. + + Returns the line in the CSS document where this section starts. The line number is 0-indexed, so the first line of the document will return 0. - the line number + the line number - the section + the section - - Returns the offset in bytes from the start of the current line + + Returns the offset in bytes from the start of the current line returned via gtk_css_section_get_start_line(). - the offset in bytes from the start of the line. + the offset in bytes from the start of the line. - the section + the section - Increments the reference count on @section. + Increments the reference count on @section. - @section itself. + @section itself. - a #GtkCssSection + a #GtkCssSection - Decrements the reference count on @section, freeing the + Decrements the reference count on @section, freeing the structure if the reference count reaches 0. @@ -42775,110 +30449,55 @@ structure if the reference count reaches 0. - a #GtkCssSection + a #GtkCssSection - - The different types of sections indicate parts of a CSS document as -parsed by GTK’s CSS parser. They are oriented towards the + + The different types of sections indicate parts of a CSS document as +parsed by GTK’s CSS parser. They are oriented towards the [CSS Grammar](http://www.w3.org/TR/CSS21/grammar.html), but may contain extensions. More types might be added in the future as the parser incorporates more features. - - The section describes a complete document. + + The section describes a complete document. This section time is the only one where gtk_css_section_get_parent() might return %NULL. - - The section defines an import rule. + + The section defines an import rule. - - The section defines a color. This + + The section defines a color. This is a GTK extension to CSS. - - The section defines a binding set. This + + The section defines a binding set. This is a GTK extension to CSS. - - The section defines a CSS ruleset. + + The section defines a CSS ruleset. - - The section defines a CSS selector. + + The section defines a CSS selector. - - The section defines the declaration of + + The section defines the declaration of a CSS variable. - - The section defines the value of a CSS declaration. + + The section defines the value of a CSS declaration. - - The section defines keyframes. See [CSS + + The section defines keyframes. See [CSS Animations](http://dev.w3.org/csswg/css3-animations/#keyframes) for details. Since 3.6 - + @@ -42892,314 +30511,157 @@ more features. - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - See also: #GtkEntry::delete-from-cursor. - - Delete characters. + + See also: #GtkEntry::delete-from-cursor. + + Delete characters. - - Delete only the portion of the word to the - left/right of cursor if we’re in the middle of a word. + + Delete only the portion of the word to the + left/right of cursor if we’re in the middle of a word. - - Delete words. + + Delete words. - - Delete display-lines. Display-lines + + Delete display-lines. Display-lines refers to the visible lines, with respect to to the current line breaks. As opposed to paragraphs, which are defined by line breaks in the input. - - Delete only the portion of the + + Delete only the portion of the display-line to the left/right of cursor. - - Delete to the end of the + + Delete to the end of the paragraph. Like C-k in Emacs (or its reverse). - - Delete entire line. Like C-k in pico. + + Delete entire line. Like C-k in pico. - - Delete only whitespace. Like M-\ in Emacs. + + Delete only whitespace. Like M-\ in Emacs. - - The #GtkDestDefaults enumeration specifies the various + + The #GtkDestDefaults enumeration specifies the various types of action that will be taken on behalf of the user for a drag destination site. - - If set for a widget, GTK+, during a drag over this - widget will check if the drag matches this widget’s list of possible targets + + If set for a widget, GTK+, during a drag over this + widget will check if the drag matches this widget’s list of possible targets and actions. GTK+ will then call gdk_drag_status() as appropriate. - - If set for a widget, GTK+ will draw a highlight on + + If set for a widget, GTK+ will draw a highlight on this widget as long as a drag is over this widget and the widget drag format and action are acceptable. - - If set for a widget, when a drop occurs, GTK+ will - will check if the drag matches this widget’s list of possible targets and + + If set for a widget, when a drop occurs, GTK+ will + will check if the drag matches this widget’s list of possible targets and actions. If so, GTK+ will call gtk_drag_get_data() on behalf of the widget. Whether or not the drop is successful, GTK+ will call gtk_drag_finish(). If the action was a move, then if the drag was successful, then %TRUE will be passed for the @delete parameter to gtk_drag_finish(). - - If set, specifies that all default actions should + + If set, specifies that all default actions should be taken. - - Dialog boxes are a convenient way to prompt the user for a small amount + + Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else -that does not require extensive effort on the user’s part. +that does not require extensive effort on the user’s part. GTK+ treats a dialog as a window split vertically. The top section is a #GtkVBox, and is where widgets such as a #GtkLabel or a #GtkEntry should be packed. The bottom area is known as the -“action area”. This is generally used for +“action area”. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. @@ -43208,11 +30670,11 @@ gtk_dialog_new_with_buttons(). gtk_dialog_new_with_buttons() is recommended; it allows you to set the dialog title, some convenient flags, and add simple buttons. -If “dialog” is a newly created dialog, the two primary areas of the +If “dialog” is a newly created dialog, the two primary areas of the window can be accessed through gtk_dialog_get_content_area() and gtk_dialog_get_action_area(), as can be seen from the example below. -A “modal” dialog (that is, one which freezes the rest of the application +A “modal” dialog (that is, one which freezes the rest of the application from user input), can be created by calling gtk_window_set_modal() on the dialog. Use the GTK_WINDOW() macro to cast the widget returned from gtk_dialog_new() into a #GtkWindow. When using gtk_dialog_new_with_buttons() @@ -43234,8 +30696,8 @@ enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked. -For the simple dialog in the following example, in reality you’d probably -use #GtkMessageDialog to save yourself some effort. But you’d need to +For the simple dialog in the following example, in reality you’d probably +use #GtkMessageDialog to save yourself some effort. But you’d need to create the dialog contents manually if you had more than a simple message in the dialog. @@ -43266,7 +30728,7 @@ quick_message (GtkWindow *parent, gchar *message) G_CALLBACK (gtk_widget_destroy), dialog); - // Add the label, and show everything we’ve added + // Add the label, and show everything we’ve added gtk_container_add (GTK_CONTAINER (content_area), label); gtk_widget_show_all (dialog); @@ -43276,20 +30738,20 @@ quick_message (GtkWindow *parent, gchar *message) # GtkDialog as GtkBuildable The GtkDialog implementation of the #GtkBuildable interface exposes the -@vbox and @action_area as internal children with the names “vbox” and -“action_area”. +@vbox and @action_area as internal children with the names “vbox” and +“action_area”. GtkDialog supports a custom <action-widgets> element, which can contain -multiple <action-widget> elements. The “response” attribute specifies a +multiple <action-widget> elements. The “response” attribute specifies a numeric response, and the content of the element is the id of widget (which should be a child of the dialogs @action_area). To mark a response -as default, set the “default“ attribute of the <action-widget> element +as default, set the “default“ attribute of the <action-widget> element to true. -GtkDialog supports adding action widgets by specifying “action“ as -the “type“ attribute of a <child> element. The widget will be added +GtkDialog supports adding action widgets by specifying “action“ as +the “type“ attribute of a <child> element. The widget will be added either to the action area or the headerbar of the dialog, depending -on the “use-header-bar“ property. The response id has to be associated +on the “use-header-bar“ property. The response id has to be associated with the action widget using the <action-widgets> element. An example of a #GtkDialog UI definition fragment: @@ -43313,26 +30775,18 @@ An example of a #GtkDialog UI definition fragment: - Creates a new dialog box. + Creates a new dialog box. Widgets should not be packed into this #GtkWindow directly, but into the @vbox and @action_area, as described above. - the new dialog as a #GtkWidget + the new dialog as a #GtkWidget - - Creates a new #GtkDialog with title @title (or %NULL for the default + + Creates a new #GtkDialog with title @title (or %NULL for the default title; see gtk_window_set_title()) and transient parent @parent (or %NULL for none; see gtk_window_set_transient_for()). The @flags argument can be used to make the dialog modal (#GTK_DIALOG_MODAL) @@ -43350,7 +30804,7 @@ so be careful relying on ::response when using the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog. -Here’s a simple example: +Here’s a simple example: |[<!-- language="C" --> GtkWidget *main_app_window; // Window the dialog should show up on GtkWidget *dialog; @@ -43366,49 +30820,28 @@ Here’s a simple example: ]| - a new #GtkDialog + a new #GtkDialog - - Title of the dialog, or %NULL + + Title of the dialog, or %NULL - - Transient parent of the dialog, or %NULL + + Transient parent of the dialog, or %NULL - from #GtkDialogFlags + from #GtkDialogFlags - - text to go in first button, or %NULL + + text to go in first button, or %NULL - response ID for first button, then additional buttons, ending with %NULL + response ID for first button, then additional buttons, ending with %NULL @@ -43425,9 +30858,7 @@ Here’s a simple example: - Emits the #GtkDialog::response signal with the given response ID. + Emits the #GtkDialog::response signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or gtk_dialog_run() will be monitoring the ::response signal and take appropriate action. @@ -43437,27 +30868,20 @@ typically either you or gtk_dialog_run() will be monitoring the - a #GtkDialog + a #GtkDialog - response ID - + response ID + - - Adds an activatable widget to the action area of a #GtkDialog, + + Adds an activatable widget to the action area of a #GtkDialog, connecting a signal handler that will emit the #GtkDialog::response signal on the dialog when the widget is activated. The widget is -appended to the end of the dialog’s action area. If you want to add a +appended to the end of the dialog’s action area. If you want to add a non-activatable widget, simply pack it into the @action_area field of the #GtkDialog struct. @@ -43466,67 +30890,47 @@ of the #GtkDialog struct. - a #GtkDialog + a #GtkDialog - an activatable widget + an activatable widget - response ID for @child - + response ID for @child + - Adds a button with the given text and sets things up so that + Adds a button with the given text and sets things up so that clicking the button will emit the #GtkDialog::response signal with the given @response_id. The button is appended to the end of the -dialog’s action area. The button widget is returned, but usually -you don’t need it. +dialog’s action area. The button widget is returned, but usually +you don’t need it. - the #GtkButton widget that was added + the #GtkButton widget that was added - a #GtkDialog + a #GtkDialog - text of button + text of button - response ID for the button - + response ID for the button + - - Adds more buttons, same as calling gtk_dialog_add_button() + + Adds more buttons, same as calling gtk_dialog_add_button() repeatedly. The variable argument list should be %NULL-terminated as with gtk_dialog_new_with_buttons(). Each button must have both text and response ID. @@ -43536,161 +30940,107 @@ text and response ID. - a #GtkDialog + a #GtkDialog - button text + button text - response ID for first button, then more text-response_id pairs + response ID for first button, then more text-response_id pairs - - Returns the action area of @dialog. + + Returns the action area of @dialog. Direct access to the action area is discouraged; use gtk_dialog_add_button(), etc. - the action area + the action area - a #GtkDialog + a #GtkDialog - - Returns the content area of @dialog. + + Returns the content area of @dialog. - the content area #GtkBox. + the content area #GtkBox. - a #GtkDialog + a #GtkDialog - - Returns the header bar of @dialog. Note that the + + Returns the header bar of @dialog. Note that the headerbar is only used by the dialog if the #GtkDialog:use-header-bar property is %TRUE. - the header bar + the header bar - a #GtkDialog + a #GtkDialog - - Gets the response id of a widget in the action area + + Gets the response id of a widget in the action area of a dialog. - the response id of @widget, or %GTK_RESPONSE_NONE - if @widget doesn’t have a response id set. + the response id of @widget, or %GTK_RESPONSE_NONE + if @widget doesn’t have a response id set. - a #GtkDialog + a #GtkDialog - a widget in the action area of @dialog + a widget in the action area of @dialog - - Gets the widget button that uses the given response ID in the action area + + Gets the widget button that uses the given response ID in the action area of a dialog. - the @widget button that uses the given + the @widget button that uses the given @response_id, or %NULL. - a #GtkDialog + a #GtkDialog - the response ID used by the @dialog widget - + the response ID used by the @dialog widget + - Emits the #GtkDialog::response signal with the given response ID. + Emits the #GtkDialog::response signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or gtk_dialog_run() will be monitoring the ::response signal and take appropriate action. @@ -43700,23 +31050,17 @@ typically either you or gtk_dialog_run() will be monitoring the - a #GtkDialog + a #GtkDialog - response ID - + response ID + - Blocks in a recursive main loop until the @dialog either emits the + Blocks in a recursive main loop until the @dialog either emits the #GtkDialog::response signal, or is destroyed. If the dialog is destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the @@ -43733,7 +31077,7 @@ destroyed as windows usually are, and gtk_dialog_run() will return will be modal. You can force gtk_dialog_run() to return at any time by calling gtk_dialog_response() to emit the ::response signal. Destroying the dialog during gtk_dialog_run() is a very bad idea, because your -post-run code won’t know whether the dialog was destroyed or not. +post-run code won’t know whether the dialog was destroyed or not. After gtk_dialog_run() returns, you are responsible for hiding or destroying the dialog if you wish to do so. @@ -43763,29 +31107,18 @@ such as timeouts, IO channel watches, DND drops, etc, will be triggered during a gtk_dialog_run() call. - response ID + response ID - a #GtkDialog + a #GtkDialog - - Sets an alternative button order. If the + + Sets an alternative button order. If the #GtkSettings:gtk-alternative-button-order setting is set to %TRUE, the dialog buttons are reordered according to the order of the response ids passed to this function. @@ -43828,33 +31161,21 @@ gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog), - a #GtkDialog + a #GtkDialog - a response id used by one @dialog’s buttons + a response id used by one @dialog’s buttons - a list of more response ids of @dialog’s buttons, terminated by -1 + a list of more response ids of @dialog’s buttons, terminated by -1 - - Sets an alternative button order. If the + + Sets an alternative button order. If the #GtkSettings:gtk-alternative-button-order setting is set to %TRUE, the dialog buttons are reordered according to the order of the response ids in @new_order. @@ -43869,34 +31190,25 @@ This function is for use by language bindings. - a #GtkDialog + a #GtkDialog - the number of response ids in @new_order + the number of response ids in @new_order - an array of response ids of - @dialog’s buttons + an array of response ids of + @dialog’s buttons - - Sets the last widget in the dialog’s action area with the given @response_id -as the default widget for the dialog. Pressing “Enter” normally activates + + Sets the last widget in the dialog’s action area with the given @response_id +as the default widget for the dialog. Pressing “Enter” normally activates the default widget. @@ -43904,25 +31216,18 @@ the default widget. - a #GtkDialog + a #GtkDialog - a response ID - + a response ID + - - Calls `gtk_widget_set_sensitive (widget, @setting)` -for each widget in the dialog’s action area with the given @response_id. + + Calls `gtk_widget_set_sensitive (widget, @setting)` +for each widget in the dialog’s action area with the given @response_id. A convenient way to sensitize/desensitize dialog buttons. @@ -43930,33 +31235,21 @@ A convenient way to sensitize/desensitize dialog buttons. - a #GtkDialog + a #GtkDialog - a response ID - + a response ID + - %TRUE for sensitive + %TRUE for sensitive - - %TRUE if the dialog uses a #GtkHeaderBar for action buttons + + %TRUE if the dialog uses a #GtkHeaderBar for action buttons instead of the action-area. For technical reasons, this property is declared as an integer @@ -43970,9 +31263,7 @@ property, but you should only set it to %TRUE or %FALSE. - The ::close signal is a + The ::close signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to close the dialog. @@ -43983,9 +31274,7 @@ The default binding for this signal is the Escape key. - Emitted when an action widget is clicked, the dialog receives a + Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls gtk_dialog_response(). On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked. @@ -43994,22 +31283,16 @@ Otherwise, it depends on which action widget was clicked. - the response ID - + the response ID + - + - The parent class. + The parent class. @@ -44020,16 +31303,12 @@ Otherwise, it depends on which action widget was clicked. - a #GtkDialog + a #GtkDialog - response ID - + response ID + @@ -44080,168 +31359,73 @@ Otherwise, it depends on which action widget was clicked. - - Flags used to influence dialog construction. - - Make the constructed dialog modal, + + Flags used to influence dialog construction. + + Make the constructed dialog modal, see gtk_window_set_modal() - - Destroy the dialog when its + + Destroy the dialog when its parent is destroyed, see gtk_window_set_destroy_with_parent() - - Create dialog with actions in header + + Create dialog with actions in header bar instead of action area. Since 3.12. - - Focus movement types. - - Move forward. + + Focus movement types. + + Move forward. - - Move backward. + + Move backward. - Move up. + Move up. - - Move down. + + Move down. - - Move left. + + Move left. - - Move right. + + Move right. - - Gives an indication why a drag operation failed. + + Gives an indication why a drag operation failed. The value can by obtained by connecting to the #GtkWidget::drag-failed signal. - - The drag operation was successful. + + The drag operation was successful. - - No suitable drag target. + + No suitable drag target. - - The user cancelled the drag operation. + + The user cancelled the drag operation. - - The drag operation timed out. + + The drag operation timed out. - - The pointer or keyboard grab used + + The pointer or keyboard grab used for the drag operation was broken. - - The drag operation failed due to some + + The drag operation failed due to some unspecified error. - - The #GtkDrawingArea widget is used for creating custom user interface -elements. It’s essentially a blank widget; you can draw on it. After + + The #GtkDrawingArea widget is used for creating custom user interface +elements. It’s essentially a blank widget; you can draw on it. After creating a drawing area, the application may want to connect to: - Mouse and button press signals to respond to input from @@ -44306,11 +31490,11 @@ draw_callback (GtkWidget *widget, cairo_t *cr, gpointer data) ]| Draw signals are normally delivered when a drawing area first comes -onscreen, or when it’s covered by another window and then uncovered. -You can also force an expose event by adding to the “damage region” -of the drawing area’s window; gtk_widget_queue_draw_area() and +onscreen, or when it’s covered by another window and then uncovered. +You can also force an expose event by adding to the “damage region” +of the drawing area’s window; gtk_widget_queue_draw_area() and gdk_window_invalidate_rect() are equally good ways to do this. -You’ll then get a draw signal for the invalid region. +You’ll then get a draw signal for the invalid region. The available routines for drawing are documented on the [GDK Drawing Primitives][gdk3-Cairo-Interaction] page @@ -44318,7 +31502,7 @@ and the cairo documentation. To receive mouse events on a drawing area, you will need to enable them with gtk_widget_add_events(). To receive keyboard events, you -will need to set the “can-focus” property on the drawing area, and you +will need to set the “can-focus” property on the drawing area, and you should probably draw some user-visible indication that the drawing area is focused. Use gtk_widget_has_focus() in your expose event handler to decide whether to draw the focus indicator. See @@ -44327,14 +31511,10 @@ gtk_render_focus() for one way to draw focus. - Creates a new drawing area. + Creates a new drawing area. - a new #GtkDrawingArea + a new #GtkDrawingArea @@ -44345,9 +31525,7 @@ gtk_render_focus() for one way to draw focus. - + @@ -44385,18 +31563,14 @@ gtk_render_focus() for one way to draw focus. - + - + @@ -44410,303 +31584,232 @@ gtk_render_focus() for one way to draw focus. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - The #GtkEditable interface is an interface which should be implemented by + + The #GtkEditable interface is an interface which should be implemented by text editing widgets, such as #GtkEntry and #GtkSpinButton. It contains functions for generically manipulating an editable widget, a large number of action signals used for key bindings, and several signals that an application can @@ -44754,9 +31857,7 @@ insert_text_handler (GtkEditable *editable, - Deletes a sequence of characters. The characters that are deleted are + Deletes a sequence of characters. The characters that are deleted are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters deleted are those from @start_pos to the end of the text. @@ -44768,29 +31869,21 @@ Note that the positions are specified in characters, not bytes. - a #GtkEditable + a #GtkEditable - start position + start position - end position + end position - Deletes a sequence of characters. The characters that are deleted are + Deletes a sequence of characters. The characters that are deleted are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters deleted are those from @start_pos to the end of the text. @@ -44802,29 +31895,21 @@ Note that the positions are specified in characters, not bytes. - a #GtkEditable + a #GtkEditable - start position + start position - end position + end position - Inserts @new_text_length bytes of @new_text into the contents of the + Inserts @new_text_length bytes of @new_text into the contents of the widget, at position @position. Note that the position is in characters, not in bytes. @@ -44835,38 +31920,25 @@ The function updates @position to point after the newly inserted text. - a #GtkEditable + a #GtkEditable - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - - location of the position text will be inserted at + + location of the position text will be inserted at - Retrieves a sequence of characters. The characters that are retrieved + Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters retrieved are those characters from @start_pos to the end of the text. @@ -44874,108 +31946,71 @@ retrieved are those characters from @start_pos to the end of the text. Note that positions are specified in characters, not bytes. - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string is allocated by the #GtkEditable implementation and should be freed by the caller. - a #GtkEditable + a #GtkEditable - start of text + start of text - end of text + end of text - Retrieves the current position of the cursor relative to the start + Retrieves the current position of the cursor relative to the start of the content of the editable. Note that this position is in characters, not in bytes. - the cursor position + the cursor position - a #GtkEditable + a #GtkEditable - - Retrieves the selection bound of the editable. start_pos will be filled + + Retrieves the selection bound of the editable. start_pos will be filled with the start of the selection and @end_pos with end. If no text was selected both will be identical and %FALSE will be returned. Note that positions are specified in characters, not bytes. - %TRUE if an area is selected, %FALSE otherwise + %TRUE if an area is selected, %FALSE otherwise - a #GtkEditable + a #GtkEditable - - location to store the starting position, or %NULL + + location to store the starting position, or %NULL - - location to store the end position, or %NULL + + location to store the end position, or %NULL - Inserts @new_text_length bytes of @new_text into the contents of the + Inserts @new_text_length bytes of @new_text into the contents of the widget, at position @position. Note that the position is in characters, not in bytes. @@ -44986,38 +32021,25 @@ The function updates @position to point after the newly inserted text. - a #GtkEditable + a #GtkEditable - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - - location of the position text will be inserted at + + location of the position text will be inserted at - Sets the cursor position in the editable to the given value. + Sets the cursor position in the editable to the given value. The cursor is displayed before the character with the given (base 0) index in the contents of the editable. The value must be less than or @@ -45030,23 +32052,17 @@ of the editable. Note that @position is in characters, not in bytes. - a #GtkEditable + a #GtkEditable - the position of the cursor + the position of the cursor - Selects a region of text. The characters that are selected are + Selects a region of text. The characters that are selected are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters selected are those characters from @start_pos to @@ -45059,29 +32075,21 @@ Note that positions are specified in characters, not bytes. - a #GtkEditable + a #GtkEditable - start of region + start of region - end of region + end of region - Copies the contents of the currently selected content in the editable and + Copies the contents of the currently selected content in the editable and puts it on the clipboard. @@ -45089,17 +32097,13 @@ puts it on the clipboard. - a #GtkEditable + a #GtkEditable - Removes the contents of the currently selected content in the editable and + Removes the contents of the currently selected content in the editable and puts it on the clipboard. @@ -45107,36 +32111,27 @@ puts it on the clipboard. - a #GtkEditable + a #GtkEditable - - Deletes the currently selected text of the editable. -This call doesn’t do anything if there is no selected text. + + Deletes the currently selected text of the editable. +This call doesn’t do anything if there is no selected text. - a #GtkEditable + a #GtkEditable - Deletes a sequence of characters. The characters that are deleted are + Deletes a sequence of characters. The characters that are deleted are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters deleted are those from @start_pos to the end of the text. @@ -45148,29 +32143,21 @@ Note that the positions are specified in characters, not bytes. - a #GtkEditable + a #GtkEditable - start position + start position - end position + end position - Retrieves a sequence of characters. The characters that are retrieved + Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters retrieved are those characters from @start_pos to the end of the text. @@ -45178,129 +32165,86 @@ retrieved are those characters from @start_pos to the end of the text. Note that positions are specified in characters, not bytes. - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string is allocated by the #GtkEditable implementation and should be freed by the caller. - a #GtkEditable + a #GtkEditable - start of text + start of text - end of text + end of text - Retrieves whether @editable is editable. See + Retrieves whether @editable is editable. See gtk_editable_set_editable(). - %TRUE if @editable is editable. + %TRUE if @editable is editable. - a #GtkEditable + a #GtkEditable - Retrieves the current position of the cursor relative to the start + Retrieves the current position of the cursor relative to the start of the content of the editable. Note that this position is in characters, not in bytes. - the cursor position + the cursor position - a #GtkEditable + a #GtkEditable - - Retrieves the selection bound of the editable. start_pos will be filled + + Retrieves the selection bound of the editable. start_pos will be filled with the start of the selection and @end_pos with end. If no text was selected both will be identical and %FALSE will be returned. Note that positions are specified in characters, not bytes. - %TRUE if an area is selected, %FALSE otherwise + %TRUE if an area is selected, %FALSE otherwise - a #GtkEditable + a #GtkEditable - - location to store the starting position, or %NULL + + location to store the starting position, or %NULL - - location to store the end position, or %NULL + + location to store the end position, or %NULL - Inserts @new_text_length bytes of @new_text into the contents of the + Inserts @new_text_length bytes of @new_text into the contents of the widget, at position @position. Note that the position is in characters, not in bytes. @@ -45311,39 +32255,25 @@ The function updates @position to point after the newly inserted text. - a #GtkEditable + a #GtkEditable - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - - location of the position text will be inserted at + + location of the position text will be inserted at - - Pastes the content of the clipboard to the current position of the + + Pastes the content of the clipboard to the current position of the cursor in the editable. @@ -45351,17 +32281,13 @@ cursor in the editable. - a #GtkEditable + a #GtkEditable - Selects a region of text. The characters that are selected are + Selects a region of text. The characters that are selected are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, then the characters selected are those characters from @start_pos to @@ -45374,29 +32300,21 @@ Note that positions are specified in characters, not bytes. - a #GtkEditable + a #GtkEditable - start of region + start of region - end of region + end of region - Determines if the user can edit the text in the editable + Determines if the user can edit the text in the editable widget or not. @@ -45404,24 +32322,18 @@ widget or not. - a #GtkEditable + a #GtkEditable - %TRUE if the user is allowed to edit the text + %TRUE if the user is allowed to edit the text in the widget - Sets the cursor position in the editable to the given value. + Sets the cursor position in the editable to the given value. The cursor is displayed before the character with the given (base 0) index in the contents of the editable. The value must be less than or @@ -45434,23 +32346,17 @@ of the editable. Note that @position is in characters, not in bytes. - a #GtkEditable + a #GtkEditable - the position of the cursor + the position of the cursor - The ::changed signal is emitted at the end of a single + The ::changed signal is emitted at the end of a single user-visible operation on the contents of the #GtkEditable. E.g., a paste operation that replaces the contents of the @@ -45463,9 +32369,7 @@ to be emitted). - This signal is emitted when text is deleted from + This signal is emitted when text is deleted from the widget by the user. The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then @@ -45479,23 +32383,17 @@ gtk_editable_delete_text(). - the starting position + the starting position - the end position + the end position - This signal is emitted when text is inserted into + This signal is emitted when text is inserted into the widget by the user. The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then @@ -45507,25 +32405,16 @@ it from being inserted entirely. - the new text to insert + the new text to insert - the length of the new text, in bytes, + the length of the new text, in bytes, or -1 if new_text is nul-terminated - - the position, in characters, + + the position, in characters, at which to insert the new text. this is an in-out parameter. After the signal emission is finished, it should point after the newly inserted text. @@ -45534,9 +32423,7 @@ it from being inserted entirely. - + @@ -45549,30 +32436,19 @@ it from being inserted entirely. - a #GtkEditable + a #GtkEditable - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - - location of the position text will be inserted at + + location of the position text will be inserted at @@ -45586,21 +32462,15 @@ it from being inserted entirely. - a #GtkEditable + a #GtkEditable - start position + start position - end position + end position @@ -45627,30 +32497,19 @@ it from being inserted entirely. - a #GtkEditable + a #GtkEditable - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - - location of the position text will be inserted at + + location of the position text will be inserted at @@ -45664,21 +32523,15 @@ it from being inserted entirely. - a #GtkEditable + a #GtkEditable - start position + start position - end position + end position @@ -45688,30 +32541,22 @@ it from being inserted entirely. - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string is allocated by the #GtkEditable implementation and should be freed by the caller. - a #GtkEditable + a #GtkEditable - start of text + start of text - end of text + end of text @@ -45725,21 +32570,15 @@ it from being inserted entirely. - a #GtkEditable + a #GtkEditable - start of region + start of region - end of region + end of region @@ -45749,38 +32588,20 @@ it from being inserted entirely. - %TRUE if an area is selected, %FALSE otherwise + %TRUE if an area is selected, %FALSE otherwise - a #GtkEditable + a #GtkEditable - - location to store the starting position, or %NULL + + location to store the starting position, or %NULL - - location to store the end position, or %NULL + + location to store the end position, or %NULL @@ -45794,15 +32615,11 @@ it from being inserted entirely. - a #GtkEditable + a #GtkEditable - the position of the cursor + the position of the cursor @@ -45812,40 +32629,28 @@ it from being inserted entirely. - the cursor position + the cursor position - a #GtkEditable + a #GtkEditable - - The #GtkEntry widget is a single line text entry + + The #GtkEntry widget is a single line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible. When using an entry for passwords and other sensitive information, -it can be put into “password mode” using gtk_entry_set_visibility(). -In this mode, entered text is displayed using a “invisible” character. +it can be put into “password mode” using gtk_entry_set_visibility(). +In this mode, entered text is displayed using a “invisible” character. By default, GTK+ picks the best invisible character that is available in the current font, but it can be changed with gtk_entry_set_invisible_char(). Since 2.16, GTK+ displays a warning @@ -45877,13 +32682,13 @@ via the context menu of the entry. |[<!-- language="plain" --> entry[.read-only][.flat][.warning][.error] -├── image.left -├── image.right -├── undershoot.left -├── undershoot.right -├── [selection] -├── [progress[.pulse]] -╰── [window.popup] +├── image.left +├── image.right +├── undershoot.left +├── undershoot.right +├── [selection] +├── [progress[.pulse]] +╰── [window.popup] ]| GtkEntry has a main node with the name entry. Depending on the properties @@ -45915,35 +32720,23 @@ just a single handle for the text cursor, it gets the style class - Creates a new entry. + Creates a new entry. - a new #GtkEntry. + a new #GtkEntry. - - Creates a new entry with the specified text buffer. + + Creates a new entry with the specified text buffer. - a new #GtkEntry + a new #GtkEntry - The buffer to use for the new #GtkEntry. + The buffer to use for the new #GtkEntry. @@ -46136,230 +32929,155 @@ just a single handle for the text cursor, it gets the style class - - Retrieves the value set by gtk_entry_set_activates_default(). + + Retrieves the value set by gtk_entry_set_activates_default(). - %TRUE if the entry will activate the default widget + %TRUE if the entry will activate the default widget - a #GtkEntry + a #GtkEntry - - Gets the value set by gtk_entry_set_alignment(). + + Gets the value set by gtk_entry_set_alignment(). - the alignment + the alignment - a #GtkEntry + a #GtkEntry - - Gets the attribute list that was set on the entry using + + Gets the attribute list that was set on the entry using gtk_entry_set_attributes(), if any. - the attribute list, or %NULL + the attribute list, or %NULL if none was set. - a #GtkEntry + a #GtkEntry - - Get the #GtkEntryBuffer object which holds the text for + + Get the #GtkEntryBuffer object which holds the text for this widget. - A #GtkEntryBuffer object. + A #GtkEntryBuffer object. - a #GtkEntry + a #GtkEntry - - Returns the auxiliary completion object currently in use by @entry. + + Returns the auxiliary completion object currently in use by @entry. - The auxiliary completion object currently + The auxiliary completion object currently in use by @entry. - A #GtkEntry + A #GtkEntry - - Returns the index of the icon which is the source of the current + + Returns the index of the icon which is the source of the current DND operation, or -1. This function is meant to be used in a #GtkWidget::drag-data-get callback. - index of the icon which is the source of the current + index of the icon which is the source of the current DND operation, or -1. - a #GtkEntry + a #GtkEntry - - Retrieves the horizontal cursor adjustment for the entry. + + Retrieves the horizontal cursor adjustment for the entry. See gtk_entry_set_cursor_hadjustment(). - the horizontal cursor adjustment, or %NULL + the horizontal cursor adjustment, or %NULL if none has been set. - a #GtkEntry + a #GtkEntry - Gets the value set by gtk_entry_set_has_frame(). + Gets the value set by gtk_entry_set_has_frame(). - whether the entry has a beveled frame + whether the entry has a beveled frame - a #GtkEntry + a #GtkEntry - - Returns whether the icon is activatable. + + Returns whether the icon is activatable. - %TRUE if the icon is activatable. + %TRUE if the icon is activatable. - a #GtkEntry + a #GtkEntry - Icon position + Icon position - - Gets the area where entry’s icon at @icon_pos is drawn. + + Gets the area where entry’s icon at @icon_pos is drawn. This function is useful when drawing something to the entry in a draw callback. If the entry is not realized or has no icon at the given position, @icon_area is filled with zeros. Otherwise, @icon_area will be filled -with the icon’s allocation, relative to @entry’s allocation. +with the icon’s allocation, relative to @entry’s allocation. See also gtk_entry_get_text_area() @@ -46368,407 +33086,273 @@ See also gtk_entry_get_text_area() - A #GtkEntry + A #GtkEntry - Icon position + Icon position - - Return location for the icon’s area + + Return location for the icon’s area - - Finds the icon at the given position and return its index. The -position’s coordinates are relative to the @entry’s top left corner. -If @x, @y doesn’t lie inside an icon, -1 is returned. + + Finds the icon at the given position and return its index. The +position’s coordinates are relative to the @entry’s top left corner. +If @x, @y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a #GtkWidget::query-tooltip signal handler. - the index of the icon at the given position, or -1 + the index of the icon at the given position, or -1 - a #GtkEntry + a #GtkEntry - the x coordinate of the position to find + the x coordinate of the position to find - the y coordinate of the position to find + the y coordinate of the position to find - - Retrieves the #GIcon used for the icon, or %NULL if there is + + Retrieves the #GIcon used for the icon, or %NULL if there is no icon or if the icon was set by some other method (e.g., by stock, pixbuf, or icon name). - A #GIcon, or %NULL if no icon is set + A #GIcon, or %NULL if no icon is set or if the icon is not a #GIcon - A #GtkEntry + A #GtkEntry - Icon position + Icon position - - Retrieves the icon name used for the icon, or %NULL if there is + + Retrieves the icon name used for the icon, or %NULL if there is no icon or if the icon was set by some other method (e.g., by pixbuf, stock or gicon). - An icon name, or %NULL if no icon is set or if the icon - wasn’t set from an icon name + An icon name, or %NULL if no icon is set or if the icon + wasn’t set from an icon name - A #GtkEntry + A #GtkEntry - Icon position + Icon position - - Retrieves the image used for the icon. + + Retrieves the image used for the icon. Unlike the other methods of setting and getting icon data, this method will work regardless of whether the icon was set using a #GdkPixbuf, a #GIcon, a stock item, or an icon name. - A #GdkPixbuf, or %NULL if no icon is + A #GdkPixbuf, or %NULL if no icon is set for this position. - A #GtkEntry + A #GtkEntry - Icon position + Icon position - - Returns whether the icon appears sensitive or insensitive. + + Returns whether the icon appears sensitive or insensitive. - %TRUE if the icon is sensitive. + %TRUE if the icon is sensitive. - a #GtkEntry + a #GtkEntry - Icon position + Icon position - - Retrieves the stock id used for the icon, or %NULL if there is + + Retrieves the stock id used for the icon, or %NULL if there is no icon or if the icon was set by some other method (e.g., by pixbuf, icon name or gicon). Use gtk_entry_get_icon_name() instead. - A stock id, or %NULL if no icon is set or if the icon - wasn’t set from a stock id + A stock id, or %NULL if no icon is set or if the icon + wasn’t set from a stock id - A #GtkEntry + A #GtkEntry - Icon position + Icon position - - Gets the type of representation being used by the icon + + Gets the type of representation being used by the icon to store image data. If the icon has no image data, the return value will be %GTK_IMAGE_EMPTY. - image representation being used + image representation being used - a #GtkEntry + a #GtkEntry - Icon position + Icon position - - Gets the contents of the tooltip on the icon at the specified + + Gets the contents of the tooltip on the icon at the specified position in @entry. - the tooltip text, or %NULL. Free the returned + the tooltip text, or %NULL. Free the returned string with g_free() when done. - a #GtkEntry + a #GtkEntry - the icon position + the icon position - - Gets the contents of the tooltip on the icon at the specified + + Gets the contents of the tooltip on the icon at the specified position in @entry. - the tooltip text, or %NULL. Free the returned + the tooltip text, or %NULL. Free the returned string with g_free() when done. - a #GtkEntry + a #GtkEntry - the icon position + the icon position - - This function returns the entry’s #GtkEntry:inner-border property. See + + This function returns the entry’s #GtkEntry:inner-border property. See gtk_entry_set_inner_border() for more information. Use the standard border and padding CSS properties (through objects like #GtkStyleContext and #GtkCssProvider); the value returned by this function is ignored by #GtkEntry. - the entry’s #GtkBorder, or + the entry’s #GtkBorder, or %NULL if none was set. - a #GtkEntry + a #GtkEntry - - Gets the value of the #GtkEntry:input-hints property. + + Gets the value of the #GtkEntry:input-hints property. - a #GtkEntry + a #GtkEntry - - Gets the value of the #GtkEntry:input-purpose property. + + Gets the value of the #GtkEntry:input-purpose property. - a #GtkEntry + a #GtkEntry - - Retrieves the character displayed in place of the real characters + + Retrieves the character displayed in place of the real characters for entries with visibility set to false. See gtk_entry_set_invisible_char(). - the current invisible char, or 0, if the entry does not + the current invisible char, or 0, if the entry does not show invisible text at all. - a #GtkEntry + a #GtkEntry - Gets the #PangoLayout used to display the entry. + Gets the #PangoLayout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with gtk_entry_get_layout_offsets(). The returned layout is owned by the entry and must not be @@ -46780,25 +33364,18 @@ gtk_entry_text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents. - the #PangoLayout for this entry + the #PangoLayout for this entry - a #GtkEntry + a #GtkEntry - - Obtains the position of the #PangoLayout used to render text + + Obtains the position of the #PangoLayout used to render text in the entry, in widget coordinates. Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget. @@ -46808,7 +33385,7 @@ Also useful to convert mouse events into coordinates inside the is clicked. Note that as the user scrolls around in the entry the offsets will -change; you’ll need to connect to the “notify::scroll-offset” +change; you’ll need to connect to the “notify::scroll-offset” signal to track this. Remember when using the #PangoLayout functions you need to convert to and from pixels using PANGO_PIXELS() or #PANGO_SCALE. @@ -46823,207 +33400,135 @@ indices in the layout to byte indices in the entry contents. - a #GtkEntry + a #GtkEntry - - location to store X offset of layout, or %NULL + + location to store X offset of layout, or %NULL - - location to store Y offset of layout, or %NULL + + location to store Y offset of layout, or %NULL - Retrieves the maximum allowed length of the text in + Retrieves the maximum allowed length of the text in @entry. See gtk_entry_set_max_length(). This is equivalent to getting @entry's #GtkEntryBuffer and calling gtk_entry_buffer_get_max_length() on it. - the maximum allowed number of characters + the maximum allowed number of characters in #GtkEntry, or 0 if there is no maximum. - a #GtkEntry + a #GtkEntry - - Retrieves the desired maximum width of @entry, in characters. + + Retrieves the desired maximum width of @entry, in characters. See gtk_entry_set_max_width_chars(). - the maximum width of the entry, in characters + the maximum width of the entry, in characters - a #GtkEntry + a #GtkEntry - - Gets the value set by gtk_entry_set_overwrite_mode(). + + Gets the value set by gtk_entry_set_overwrite_mode(). - whether the text is overwritten when typing. + whether the text is overwritten when typing. - a #GtkEntry + a #GtkEntry - - Retrieves the text that will be displayed when @entry is empty and unfocused + + Retrieves the text that will be displayed when @entry is empty and unfocused - a pointer to the placeholder text as a string. This string points to internally allocated + a pointer to the placeholder text as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored. - a #GtkEntry + a #GtkEntry - - Returns the current fraction of the task that’s been completed. + + Returns the current fraction of the task that’s been completed. See gtk_entry_set_progress_fraction(). - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a #GtkEntry + a #GtkEntry - - Retrieves the pulse step set with gtk_entry_set_progress_pulse_step(). + + Retrieves the pulse step set with gtk_entry_set_progress_pulse_step(). - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a #GtkEntry + a #GtkEntry - Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if + Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if any. - the tabstops, or %NULL if none was set. + the tabstops, or %NULL if none was set. - a #GtkEntry + a #GtkEntry - Retrieves the contents of the entry widget. + Retrieves the contents of the entry widget. See also gtk_editable_get_chars(). This is equivalent to getting @entry's #GtkEntryBuffer and calling gtk_entry_buffer_get_text() on it. - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored. @@ -47031,19 +33536,13 @@ gtk_entry_buffer_get_text() on it. - a #GtkEntry + a #GtkEntry - - Gets the area where the entry’s text is drawn. This function is + + Gets the area where the entry’s text is drawn. This function is useful when drawing something to the entry in a draw callback. If the entry is not realized, @text_area is filled with zeros. @@ -47055,96 +33554,65 @@ See also gtk_entry_get_icon_area(). - a #GtkEntry + a #GtkEntry - - Return location for the text area. + + Return location for the text area. - - Retrieves the current length of the text in + + Retrieves the current length of the text in @entry. This is equivalent to getting @entry's #GtkEntryBuffer and calling gtk_entry_buffer_get_length() on it. - the current number of characters + the current number of characters in #GtkEntry, or 0 if there are none. - a #GtkEntry + a #GtkEntry - Retrieves whether the text in @entry is visible. See + Retrieves whether the text in @entry is visible. See gtk_entry_set_visibility(). - %TRUE if the text is currently visible + %TRUE if the text is currently visible - a #GtkEntry + a #GtkEntry - Gets the value set by gtk_entry_set_width_chars(). + Gets the value set by gtk_entry_set_width_chars(). - number of chars to request space for, or negative if unset + number of chars to request space for, or negative if unset - a #GtkEntry + a #GtkEntry - - Causes @entry to have keyboard focus. + + Causes @entry to have keyboard focus. It behaves like gtk_widget_grab_focus(), except that it doesn't select the contents of the entry. @@ -47157,19 +33625,13 @@ such as search-as-you-type entries. - a #GtkEntry + a #GtkEntry - - Allow the #GtkEntry input method to internally handle key press + + Allow the #GtkEntry input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. See gtk_im_context_filter_keypress(). @@ -47181,62 +33643,43 @@ and the default key event handling of the #GtkEntry. See gtk_text_view_reset_im_context() for an example of use. - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a #GtkEntry + a #GtkEntry - the key event + the key event - - Converts from a position in the entry’s #PangoLayout (returned by + + Converts from a position in the entry’s #PangoLayout (returned by gtk_entry_get_layout()) to a position in the entry contents (returned by gtk_entry_get_text()). - byte index into the entry contents + byte index into the entry contents - a #GtkEntry + a #GtkEntry - byte index into the entry layout text + byte index into the entry layout text - - Indicates that some progress is made, but you don’t know how much. -Causes the entry’s progress indicator to enter “activity mode,” + + Indicates that some progress is made, but you don’t know how much. +Causes the entry’s progress indicator to enter “activity mode,” where a block bounces back and forth. Each call to gtk_entry_progress_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by @@ -47247,19 +33690,13 @@ gtk_entry_set_progress_pulse_step()). - a #GtkEntry + a #GtkEntry - - Reset the input method context of the entry if needed. + + Reset the input method context of the entry if needed. This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. @@ -47269,18 +33706,13 @@ would confuse on-going input method behavior. - a #GtkEntry + a #GtkEntry - - If @setting is %TRUE, pressing Enter in the @entry will activate the default + + If @setting is %TRUE, pressing Enter in the @entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons. @@ -47294,25 +33726,17 @@ the default handler for the #GtkEntry::activate signal.) - a #GtkEntry + a #GtkEntry - %TRUE to activate window’s default widget on Enter keypress + %TRUE to activate window’s default widget on Enter keypress - - Sets the alignment for the contents of the entry. This controls + + Sets the alignment for the contents of the entry. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry. @@ -47321,26 +33745,18 @@ text is shorter than the width of the entry. - a #GtkEntry + a #GtkEntry - The horizontal alignment, from 0 (left) to 1 (right). + The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts - - Sets a #PangoAttrList; the attributes in the list are applied to the + + Sets a #PangoAttrList; the attributes in the list are applied to the entry text. @@ -47348,25 +33764,17 @@ entry text. - a #GtkEntry + a #GtkEntry - a #PangoAttrList + a #PangoAttrList - - Set the #GtkEntryBuffer object which holds the text for + + Set the #GtkEntryBuffer object which holds the text for this widget. @@ -47374,25 +33782,17 @@ this widget. - a #GtkEntry + a #GtkEntry - a #GtkEntryBuffer + a #GtkEntryBuffer - - Sets @completion to be the auxiliary completion object to use with @entry. + + Sets @completion to be the auxiliary completion object to use with @entry. All further configuration of the completion mechanism is done on @completion using the #GtkEntryCompletion API. Completion is disabled if @completion is set to %NULL. @@ -47402,28 +33802,17 @@ All further configuration of the completion mechanism is done on - A #GtkEntry + A #GtkEntry - - The #GtkEntryCompletion or %NULL + + The #GtkEntryCompletion or %NULL - - Hooks up an adjustment to the cursor position in an entry, so that when + + Hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment is scrolled to show that position. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment. @@ -47436,83 +33825,56 @@ as the entry. - a #GtkEntry + a #GtkEntry - - an adjustment which should be adjusted when the cursor + + an adjustment which should be adjusted when the cursor is moved, or %NULL - Sets whether the entry has a beveled frame around it. + Sets whether the entry has a beveled frame around it. - a #GtkEntry + a #GtkEntry - new value + new value - - Sets whether the icon is activatable. + + Sets whether the icon is activatable. - A #GtkEntry + A #GtkEntry - Icon position + Icon position - %TRUE if the icon should be activatable + %TRUE if the icon should be activatable - - Sets up the icon at the given position so that GTK+ will start a drag + + Sets up the icon at the given position so that GTK+ will start a drag operation when the user clicks and drags the icon. To handle the drag operation, you need to connect to the usual @@ -47531,39 +33893,27 @@ gets executed after the default handler. - a #GtkEntry + a #GtkEntry - icon position + icon position - the targets (data formats) in which the data can be provided + the targets (data formats) in which the data can be provided - a bitmask of the allowed drag actions + a bitmask of the allowed drag actions - - Sets the icon shown in the entry at the specified position + + Sets the icon shown in the entry at the specified position from the current icon theme. -If the icon isn’t known, a “broken image” icon will be displayed +If the icon isn’t known, a “broken image” icon will be displayed instead. If @icon is %NULL, no icon will be shown in the specified position. @@ -47573,37 +33923,24 @@ If @icon is %NULL, no icon will be shown in the specified position. - A #GtkEntry + A #GtkEntry - The position at which to set the icon + The position at which to set the icon - - The icon to set, or %NULL + + The icon to set, or %NULL - - Sets the icon shown in the entry at the specified position + + Sets the icon shown in the entry at the specified position from the current icon theme. -If the icon name isn’t known, a “broken image” icon will be displayed +If the icon name isn’t known, a “broken image” icon will be displayed instead. If @icon_name is %NULL, no icon will be shown in the specified position. @@ -47613,34 +33950,21 @@ If @icon_name is %NULL, no icon will be shown in the specified position. - A #GtkEntry + A #GtkEntry - The position at which to set the icon + The position at which to set the icon - - An icon name, or %NULL + + An icon name, or %NULL - - Sets the icon shown in the specified position using a pixbuf. + + Sets the icon shown in the specified position using a pixbuf. If @pixbuf is %NULL, no icon will be shown in the specified position. @@ -47649,36 +33973,21 @@ If @pixbuf is %NULL, no icon will be shown in the specified position. - a #GtkEntry + a #GtkEntry - Icon position + Icon position - - A #GdkPixbuf, or %NULL + + A #GdkPixbuf, or %NULL - - Sets the icon shown in the entry at the specified position from + + Sets the icon shown in the entry at the specified position from a stock image. If @stock_id is %NULL, no icon will be shown in the specified position. @@ -47689,66 +33998,43 @@ If @stock_id is %NULL, no icon will be shown in the specified position. - A #GtkEntry + A #GtkEntry - Icon position + Icon position - - The name of the stock item, or %NULL + + The name of the stock item, or %NULL - - Sets the sensitivity for the specified icon. + + Sets the sensitivity for the specified icon. - A #GtkEntry + A #GtkEntry - Icon position + Icon position - Specifies whether the icon should appear + Specifies whether the icon should appear sensitive or insensitive - - Sets @tooltip as the contents of the tooltip for the icon at + + Sets @tooltip as the contents of the tooltip for the icon at the specified position. @tooltip is assumed to be marked up with the [Pango text markup language][PangoMarkupFormat]. @@ -47762,34 +34048,21 @@ gtk_entry_set_icon_tooltip_text(). - a #GtkEntry + a #GtkEntry - the icon position + the icon position - - the contents of the tooltip for the icon, or %NULL + + the contents of the tooltip for the icon, or %NULL - - Sets @tooltip as the contents of the tooltip for the icon + + Sets @tooltip as the contents of the tooltip for the icon at the specified position. Use %NULL for @tooltip to remove an existing tooltip. @@ -47808,37 +34081,22 @@ setting at least one non-empty tooltip on any icon achieves the same result. - a #GtkEntry + a #GtkEntry - the icon position + the icon position - - the contents of the tooltip for the icon, or %NULL + + the contents of the tooltip for the icon, or %NULL - - Sets %entry’s inner-border property to @border, or clears it if %NULL -is passed. The inner-border is the area around the entry’s text, but + + Sets %entry’s inner-border property to @border, or clears it if %NULL +is passed. The inner-border is the area around the entry’s text, but inside its frame. If set, this property overrides the inner-border style property. @@ -47854,28 +34112,17 @@ pixel-exact positioning of the entry is important. - a #GtkEntry + a #GtkEntry - - a #GtkBorder, or %NULL + + a #GtkBorder, or %NULL - - Sets the #GtkEntry:input-hints property, which + + Sets the #GtkEntry:input-hints property, which allows input methods to fine-tune their behaviour. @@ -47883,25 +34130,17 @@ allows input methods to fine-tune their behaviour. - a #GtkEntry + a #GtkEntry - the hints + the hints - - Sets the #GtkEntry:input-purpose property which + + Sets the #GtkEntry:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -47910,26 +34149,19 @@ methods to adjust their behaviour. - a #GtkEntry + a #GtkEntry - the purpose + the purpose - - Sets the character to use in place of the actual text when + + Sets the character to use in place of the actual text when gtk_entry_set_visibility() has been called to set text visibility -to %FALSE. i.e. this is the character used in “password mode” to +to %FALSE. i.e. this is the character used in “password mode” to show the user how many characters have been typed. By default, GTK+ picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback @@ -47940,23 +34172,17 @@ at all; there will be no text on the screen as they type. - a #GtkEntry + a #GtkEntry - a Unicode character + a Unicode character - Sets the maximum allowed length of the contents of the widget. If + Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit. @@ -47969,77 +34195,53 @@ calling gtk_entry_buffer_set_max_length() on it. - a #GtkEntry + a #GtkEntry - the maximum length of the entry, or 0 for no maximum. + the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. - - Sets the desired maximum width in characters of @entry. + + Sets the desired maximum width in characters of @entry. - a #GtkEntry + a #GtkEntry - the new desired maximum width, in characters + the new desired maximum width, in characters - - Sets whether the text is overwritten when typing in the #GtkEntry. + + Sets whether the text is overwritten when typing in the #GtkEntry. - a #GtkEntry + a #GtkEntry - new value + new value - - Sets text to be displayed in @entry when it is empty and unfocused. + + Sets text to be displayed in @entry when it is empty and unfocused. This can be used to give a visual hint of the expected contents of the #GtkEntry. @@ -48054,28 +34256,17 @@ first key event arrives. - a #GtkEntry + a #GtkEntry - - a string to be displayed when @entry is empty and unfocused, or %NULL + + a string to be displayed when @entry is empty and unfocused, or %NULL - - Causes the entry’s progress indicator to “fill in” the given + + Causes the entry’s progress indicator to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive. @@ -48084,25 +34275,17 @@ inclusive. - a #GtkEntry + a #GtkEntry - fraction of the task that’s been completed + fraction of the task that’s been completed - - Sets the fraction of total entry width to move the progress + + Sets the fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse(). @@ -48110,23 +34293,17 @@ bouncing block for each call to gtk_entry_progress_pulse(). - a #GtkEntry + a #GtkEntry - fraction between 0.0 and 1.0 + fraction between 0.0 and 1.0 - Sets a #PangoTabArray; the tabstops in the array are applied to the entry + Sets a #PangoTabArray; the tabstops in the array are applied to the entry text. @@ -48134,23 +34311,17 @@ text. - a #GtkEntry + a #GtkEntry - a #PangoTabArray + a #PangoTabArray - Sets the text in the widget to the given + Sets the text in the widget to the given value, replacing the current contents. See gtk_entry_buffer_set_text(). @@ -48160,23 +34331,17 @@ See gtk_entry_buffer_set_text(). - a #GtkEntry + a #GtkEntry - the new text + the new text - Sets whether the contents of the entry are visible or not. + Sets whether the contents of the entry are visible or not. When visibility is set to %FALSE, characters are displayed as the invisible char, and will also appear that way when the text in the entry widget is copied elsewhere. @@ -48195,24 +34360,18 @@ in addition to setting visibility to %FALSE. - a #GtkEntry + a #GtkEntry - %TRUE if the contents of the entry are displayed + %TRUE if the contents of the entry are displayed as plaintext - Changes the size request of the entry to be about the right size + Changes the size request of the entry to be about the right size for @n_chars characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If @n_chars is -1, the @@ -48223,55 +34382,38 @@ size reverts to the default entry size. - a #GtkEntry + a #GtkEntry - width in chars + width in chars - - Converts from a position in the entry contents (returned + + Converts from a position in the entry contents (returned by gtk_entry_get_text()) to a position in the -entry’s #PangoLayout (returned by gtk_entry_get_layout(), +entry’s #PangoLayout (returned by gtk_entry_get_layout(), with text retrieved via pango_layout_get_text()). - byte index into the entry layout text + byte index into the entry layout text - a #GtkEntry + a #GtkEntry - byte index into the entry contents + byte index into the entry contents - - Unsets the invisible char previously set with + + Unsets the invisible char previously set with gtk_entry_set_invisible_char(). So that the default invisible char is used again. @@ -48280,25 +34422,16 @@ default invisible char is used again. - a #GtkEntry + a #GtkEntry - + - - A list of Pango attributes to apply to the text of the entry. + + A list of Pango attributes to apply to the text of the entry. This is mainly useful to change the size or weight of the text. @@ -48306,32 +34439,19 @@ The #PangoAttribute's @start_index and @end_index must refer to the #GtkEntryBuffer text, i.e. without the preedit string. - + - - Whether password entries will show a warning when Caps Lock is on. + + Whether password entries will show a warning when Caps Lock is on. Note that the warning is shown using a secondary icon, and thus does not work if you are using the secondary icon position for some other purpose. - - The auxiliary completion object to use with the entry. + + The auxiliary completion object to use with the entry. @@ -48340,21 +34460,14 @@ other purpose. - + - - Which IM (input method) module should be used for this entry. + + Which IM (input method) module should be used for this entry. See #GtkIMContext. Setting this to a non-%NULL value overrides the @@ -48362,37 +34475,20 @@ system-wide IM module setting. See the GtkSettings #GtkSettings:gtk-im-module property. - - Sets the text area's border between the text and the frame. + + Sets the text area's border between the text and the frame. Use the standard border and padding CSS properties (through objects like #GtkStyleContext and #GtkCssProvider); the value of this style property is ignored. - - Additional hints (beyond #GtkEntry:input-purpose) that + + Additional hints (beyond #GtkEntry:input-purpose) that allow input methods to fine-tune their behaviour. - - The purpose of this text field. + + The purpose of this text field. This property can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -48402,13 +34498,8 @@ Note that setting the purpose to %GTK_INPUT_PURPOSE_PASSWORD or #GtkEntry:visibility. - - The invisible character is used when masking entry contents (in + + The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the #GtkEntry:invisible-char property, GTK+ determines the character to use from a list of possible candidates, depending on availability @@ -48418,65 +34509,35 @@ This style property allows the theme to prepend a character to the list of candidates. - - Whether the invisible char has been set for the #GtkEntry. + + Whether the invisible char has been set for the #GtkEntry. - - The desired maximum width of the entry, in characters. + + The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically. - - If text is overwritten when typing in the #GtkEntry. + + If text is overwritten when typing in the #GtkEntry. - - The text that will be displayed in the #GtkEntry when it is empty + + The text that will be displayed in the #GtkEntry when it is empty and unfocused. - - If :populate-all is %TRUE, the #GtkEntry::populate-popup + + If :populate-all is %TRUE, the #GtkEntry::populate-popup signal is also emitted for touch popups. - - Whether the primary icon is activatable. + + Whether the primary icon is activatable. GTK+ emits the #GtkEntry::icon-press and #GtkEntry::icon-release signals only on sensitive, activatable icons. @@ -48485,40 +34546,20 @@ Sensitive, but non-activatable icons can be used for purely informational purposes. - - The #GIcon to use for the primary icon for the entry. + + The #GIcon to use for the primary icon for the entry. - - The icon name to use for the primary icon for the entry. + + The icon name to use for the primary icon for the entry. - - A pixbuf to use as the primary icon for the entry. + + A pixbuf to use as the primary icon for the entry. - - Whether the primary icon is sensitive. + + Whether the primary icon is sensitive. An insensitive icon appears grayed out. GTK+ does not emit the #GtkEntry::icon-press and #GtkEntry::icon-release signals and @@ -48528,78 +34569,42 @@ An icon should be set insensitive if the action that would trigger when clicked is currently not available. - - The stock id to use for the primary icon for the entry. + + The stock id to use for the primary icon for the entry. Use #GtkEntry:primary-icon-name instead. - - The representation which is used for the primary icon of the entry. + + The representation which is used for the primary icon of the entry. - - The contents of the tooltip on the primary icon, which is marked up + + The contents of the tooltip on the primary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_entry_set_icon_tooltip_markup(). - - The contents of the tooltip on the primary icon. + + The contents of the tooltip on the primary icon. Also see gtk_entry_set_icon_tooltip_text(). - - The current fraction of the task that's been completed. + + The current fraction of the task that's been completed. - - The fraction of total entry width to move the progress + + The fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse(). - - Whether the secondary icon is activatable. + + Whether the secondary icon is activatable. GTK+ emits the #GtkEntry::icon-press and #GtkEntry::icon-release signals only on sensitive, activatable icons. @@ -48608,40 +34613,20 @@ Sensitive, but non-activatable icons can be used for purely informational purposes. - - The #GIcon to use for the secondary icon for the entry. + + The #GIcon to use for the secondary icon for the entry. - - The icon name to use for the secondary icon for the entry. + + The icon name to use for the secondary icon for the entry. - - An pixbuf to use as the secondary icon for the entry. + + An pixbuf to use as the secondary icon for the entry. - - Whether the secondary icon is sensitive. + + Whether the secondary icon is sensitive. An insensitive icon appears grayed out. GTK+ does not emit the #GtkEntry::icon-press and #GtkEntry::icon-release signals and @@ -48651,45 +34636,24 @@ An icon should be set insensitive if the action that would trigger when clicked is currently not available. - - The stock id to use for the secondary icon for the entry. + + The stock id to use for the secondary icon for the entry. Use #GtkEntry:secondary-icon-name instead. - - The representation which is used for the secondary icon of the entry. + + The representation which is used for the secondary icon of the entry. - - The contents of the tooltip on the secondary icon, which is marked up + + The contents of the tooltip on the secondary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_entry_set_icon_tooltip_markup(). - - The contents of the tooltip on the secondary icon. + + The contents of the tooltip on the secondary icon. Also see gtk_entry_set_icon_tooltip_text(). @@ -48697,15 +34661,8 @@ Also see gtk_entry_set_icon_tooltip_text(). - - Which kind of shadow to draw around the entry when + + Which kind of shadow to draw around the entry when #GtkEntry:has-frame is set to %TRUE. Use CSS to determine the style of the border; the value of this style property is ignored. @@ -48721,18 +34678,11 @@ Also see gtk_entry_set_icon_tooltip_text(). - The length of the text in the #GtkEntry. + The length of the text in the #GtkEntry. - - When %TRUE, pasted multi-line text is truncated to the first line. + + When %TRUE, pasted multi-line text is truncated to the first line. @@ -48741,13 +34691,8 @@ Also see gtk_entry_set_icon_tooltip_text(). - - The horizontal alignment, from 0 (left) to 1 (right). + + The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. @@ -48758,9 +34703,7 @@ Reversed for RTL layouts. - The ::activate signal is emitted when the user hits + The ::activate signal is emitted when the user hits the Enter key. While this signal is used as a @@ -48774,9 +34717,7 @@ The default bindings for this signal are all forms of the Enter key. - The ::backspace signal is a + The ::backspace signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. @@ -48787,9 +34728,7 @@ Backspace and Shift-Backspace. - The ::copy-clipboard signal is a + The ::copy-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to copy the selection to the clipboard. @@ -48800,9 +34739,7 @@ Ctrl-c and Ctrl-Insert. - The ::cut-clipboard signal is a + The ::cut-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cut the selection to the clipboard. @@ -48813,9 +34750,7 @@ Ctrl-x and Shift-Delete. - The ::delete-from-cursor signal is a + The ::delete-from-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a text deletion. @@ -48831,69 +34766,51 @@ deleting a word. - the granularity of the deletion, as a #GtkDeleteType + the granularity of the deletion, as a #GtkDeleteType - the number of @type units to delete + the number of @type units to delete - The ::icon-press signal is emitted when an activatable icon + The ::icon-press signal is emitted when an activatable icon is clicked. - The position of the clicked icon + The position of the clicked icon - the button press event + the button press event - The ::icon-release signal is emitted on the button release from a + The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon. - The position of the clicked icon + The position of the clicked icon - the button release event + the button release event - The ::insert-at-cursor signal is a + The ::insert-at-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates the insertion of a fixed string at the cursor. @@ -48904,20 +34821,13 @@ This signal has no default bindings. - the string to insert + the string to insert - - The ::insert-emoji signal is a + + The ::insert-emoji signal is a [keybinding signal][GtkBindingSignal] which gets emitted to present the Emoji chooser for the @entry. @@ -48927,9 +34837,7 @@ The default bindings for this signal are Ctrl-. and Ctrl-; - The ::move-cursor signal is a + The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. If the cursor is not visible in @entry, this signal causes @@ -48951,29 +34859,21 @@ There are too many key combinations to list them all here. - the granularity of the move, as a #GtkMovementStep + the granularity of the move, as a #GtkMovementStep - the number of @step units to move + the number of @step units to move - %TRUE if the move should extend the selection + %TRUE if the move should extend the selection - The ::paste-clipboard signal is a + The ::paste-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to paste the contents of the clipboard into the text view. @@ -48985,9 +34885,7 @@ Ctrl-v and Shift-Insert. - The ::populate-popup signal gets emitted before showing the + The ::populate-popup signal gets emitted before showing the context menu of the entry. If you need to add items to the context menu, connect @@ -49004,20 +34902,13 @@ type of @widget. - the container that is being populated + the container that is being populated - - If an input method is used, the typed text will not immediately + + If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal. @@ -49025,17 +34916,13 @@ connect to this signal. - the current preedit string + the current preedit string - The ::toggle-overwrite signal is a + The ::toggle-overwrite signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the overwrite mode of the entry. @@ -49045,13 +34932,7 @@ The default bindings for this signal is Insert. - + @@ -49061,34 +34942,20 @@ The default bindings for this signal is Insert. - + - + - + - - The #GtkEntryBuffer class contains the actual text displayed in a + + The #GtkEntryBuffer class contains the actual text displayed in a #GtkEntry widget. A single #GtkEntryBuffer object can be shared by multiple #GtkEntry @@ -49098,45 +34965,30 @@ position, visibility attributes, icon etc. #GtkEntryBuffer may be derived from. Such a derived class might allow text to be stored in an alternate location, such as non-pageable memory, useful in the case of important passwords. Or a derived class could -integrate with an application’s concept of undo/redo. +integrate with an application’s concept of undo/redo. - - Create a new GtkEntryBuffer object. + + Create a new GtkEntryBuffer object. Optionally, specify initial text to set in the buffer. - A new GtkEntryBuffer object. + A new GtkEntryBuffer object. - - initial buffer text, or %NULL + + initial buffer text, or %NULL - number of characters in @initial_chars, or -1 + number of characters in @initial_chars, or -1 - Deletes a sequence of characters from the buffer. @n_chars characters are + Deletes a sequence of characters from the buffer. @n_chars characters are deleted starting at @position. If @n_chars is negative, then all characters until the end of the text are deleted. @@ -49146,28 +34998,20 @@ values. Note that the positions are specified in characters, not bytes. - The number of characters deleted. + The number of characters deleted. - a #GtkEntryBuffer + a #GtkEntryBuffer - position at which to delete text + position at which to delete text - number of characters to delete + number of characters to delete @@ -49190,21 +35034,15 @@ Note that the positions are specified in characters, not bytes. - Retrieves the length in characters of the buffer. + Retrieves the length in characters of the buffer. - The number of characters in the buffer. + The number of characters in the buffer. - a #GtkEntryBuffer + a #GtkEntryBuffer @@ -49224,9 +35062,7 @@ Note that the positions are specified in characters, not bytes. - Inserts @n_chars characters of @chars into the contents of the + Inserts @n_chars characters of @chars into the contents of the buffer, at position @position. If @n_chars is negative, then characters from chars will be inserted @@ -49237,34 +35073,24 @@ coerced to sane values. Note that the position and length are in characters, not in bytes. - The number of characters actually inserted. + The number of characters actually inserted. - a #GtkEntryBuffer + a #GtkEntryBuffer - the position at which to insert text. + the position at which to insert text. - the text to insert into the buffer. + the text to insert into the buffer. - the length of the text in characters, or -1 + the length of the text in characters, or -1 @@ -49289,12 +35115,8 @@ Note that the position and length are in characters, not in bytes. - - Deletes a sequence of characters from the buffer. @n_chars characters are + + Deletes a sequence of characters from the buffer. @n_chars characters are deleted starting at @position. If @n_chars is negative, then all characters until the end of the text are deleted. @@ -49304,183 +35126,123 @@ values. Note that the positions are specified in characters, not bytes. - The number of characters deleted. + The number of characters deleted. - a #GtkEntryBuffer + a #GtkEntryBuffer - position at which to delete text + position at which to delete text - number of characters to delete + number of characters to delete - - Used when subclassing #GtkEntryBuffer + + Used when subclassing #GtkEntryBuffer - a #GtkEntryBuffer + a #GtkEntryBuffer - position at which text was deleted + position at which text was deleted - number of characters deleted + number of characters deleted - - Used when subclassing #GtkEntryBuffer + + Used when subclassing #GtkEntryBuffer - a #GtkEntryBuffer + a #GtkEntryBuffer - position at which text was inserted + position at which text was inserted - text that was inserted + text that was inserted - number of characters inserted + number of characters inserted - - Retrieves the length in bytes of the buffer. + + Retrieves the length in bytes of the buffer. See gtk_entry_buffer_get_length(). - The byte length of the buffer. + The byte length of the buffer. - a #GtkEntryBuffer + a #GtkEntryBuffer - - Retrieves the length in characters of the buffer. + + Retrieves the length in characters of the buffer. - The number of characters in the buffer. + The number of characters in the buffer. - a #GtkEntryBuffer + a #GtkEntryBuffer - - Retrieves the maximum allowed length of the text in + + Retrieves the maximum allowed length of the text in @buffer. See gtk_entry_buffer_set_max_length(). - the maximum allowed number of characters + the maximum allowed number of characters in #GtkEntryBuffer, or 0 if there is no maximum. - a #GtkEntryBuffer + a #GtkEntryBuffer - - Retrieves the contents of the buffer. + + Retrieves the contents of the buffer. The memory pointer returned by this call will not change unless this object emits a signal, or is finalized. - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string points to internally allocated storage in the buffer and must not be freed, modified or stored. @@ -49488,19 +35250,13 @@ unless this object emits a signal, or is finalized. - a #GtkEntryBuffer + a #GtkEntryBuffer - - Inserts @n_chars characters of @chars into the contents of the + + Inserts @n_chars characters of @chars into the contents of the buffer, at position @position. If @n_chars is negative, then characters from chars will be inserted @@ -49511,44 +35267,30 @@ coerced to sane values. Note that the position and length are in characters, not in bytes. - The number of characters actually inserted. + The number of characters actually inserted. - a #GtkEntryBuffer + a #GtkEntryBuffer - the position at which to insert text. + the position at which to insert text. - the text to insert into the buffer. + the text to insert into the buffer. - the length of the text in characters, or -1 + the length of the text in characters, or -1 - - Sets the maximum allowed length of the contents of the buffer. If + + Sets the maximum allowed length of the contents of the buffer. If the current contents are longer than the given length, then they will be truncated to fit. @@ -49557,27 +35299,19 @@ will be truncated to fit. - a #GtkEntryBuffer + a #GtkEntryBuffer - the maximum length of the entry buffer, or 0 for no maximum. + the maximum length of the entry buffer, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. - - Sets the text in the buffer. + + Sets the text in the buffer. This is roughly equivalent to calling gtk_entry_buffer_delete_text() and gtk_entry_buffer_insert_text(). @@ -49589,47 +35323,29 @@ Note that @n_chars is in characters, not in bytes. - a #GtkEntryBuffer + a #GtkEntryBuffer - the new text + the new text - the number of characters in @text, or -1 + the number of characters in @text, or -1 - The length (in characters) of the text in buffer. + The length (in characters) of the text in buffer. - - The maximum length (in characters) of the text in the buffer. + + The maximum length (in characters) of the text in the buffer. - - The contents of the buffer. + + The contents of the buffer. @@ -49639,59 +35355,43 @@ Note that @n_chars is in characters, not in bytes. - This signal is emitted after text is deleted from the buffer. + This signal is emitted after text is deleted from the buffer. - the position the text was deleted at. + the position the text was deleted at. - The number of characters that were deleted. + The number of characters that were deleted. - This signal is emitted after text is inserted into the buffer. + This signal is emitted after text is inserted into the buffer. - the position the text was inserted at. + the position the text was inserted at. - The text that was inserted. + The text that was inserted. - The number of characters that were inserted. + The number of characters that were inserted. - + @@ -49757,16 +35457,12 @@ Note that @n_chars is in characters, not in bytes. - The number of characters in the buffer. + The number of characters in the buffer. - a #GtkEntryBuffer + a #GtkEntryBuffer @@ -49776,34 +35472,24 @@ Note that @n_chars is in characters, not in bytes. - The number of characters actually inserted. + The number of characters actually inserted. - a #GtkEntryBuffer + a #GtkEntryBuffer - the position at which to insert text. + the position at which to insert text. - the text to insert into the buffer. + the text to insert into the buffer. - the length of the text in characters, or -1 + the length of the text in characters, or -1 @@ -49813,28 +35499,20 @@ Note that @n_chars is in characters, not in bytes. - The number of characters deleted. + The number of characters deleted. - a #GtkEntryBuffer + a #GtkEntryBuffer - position at which to delete text + position at which to delete text - number of characters to delete + number of characters to delete @@ -49905,26 +35583,18 @@ Note that @n_chars is in characters, not in bytes. - + - - Class structure for #GtkEntry. All virtual functions have a default + + Class structure for #GtkEntry. All virtual functions have a default implementation. Derived classes may set the virtual function pointers for the signal handlers to %NULL, but must keep @get_text_area_size and @get_frame_size non-%NULL; either use the default implementation, or provide a custom one. - The parent class. + The parent class. @@ -50190,21 +35860,13 @@ a custom one. - - #GtkEntryCompletion is an auxiliary object to be used in conjunction with + + #GtkEntryCompletion is an auxiliary object to be used in conjunction with #GtkEntry to provide the completion functionality. It implements the #GtkCellLayout interface, to allow the user to add extra cells to the #GtkTreeView with completion matches. -“Completion functionality” means that when the user modifies the text +“Completion functionality” means that when the user modifies the text in the entry, #GtkEntryCompletion checks which rows in the model match the current content of the entry, and displays a list of matches. By default, the matching is done by comparing the entry text @@ -50223,7 +35885,7 @@ To add completion functionality to an entry, use gtk_entry_set_completion(). In addition to regular completion matches, which will be inserted into the entry when they are selected, #GtkEntryCompletion also allows to display -“actions” in the popup window. Their appearance is similar to menuitems, +“actions” in the popup window. Their appearance is similar to menuitems, to differentiate them clearly from completion strings. When an action is selected, the #GtkEntryCompletion::action-activated signal is emitted. @@ -50236,46 +35898,32 @@ iter pointing to that model as arguments, other callbacks and signals will generally take the filter model as argument. As long as you are only calling gtk_tree_model_get(), this will make no difference to you. If for some reason, you need the original model, use -gtk_tree_model_filter_get_model(). Don’t forget to use +gtk_tree_model_filter_get_model(). Don’t forget to use gtk_tree_model_filter_convert_iter_to_child_iter() to obtain a matching iter. - - Creates a new #GtkEntryCompletion object. + + Creates a new #GtkEntryCompletion object. - A newly created #GtkEntryCompletion object + A newly created #GtkEntryCompletion object - - Creates a new #GtkEntryCompletion object using the + + Creates a new #GtkEntryCompletion object using the specified @area to layout cells in the underlying #GtkTreeViewColumn for the drop-down menu. - A newly created #GtkEntryCompletion object + A newly created #GtkEntryCompletion object - the #GtkCellArea used to layout cells + the #GtkCellArea used to layout cells @@ -50353,12 +36001,8 @@ specified @area to layout cells in the underlying - - Requests a completion operation, or in other words a refiltering of the + + Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key. The completion list view will be updated accordingly. @@ -50367,51 +36011,35 @@ view will be updated accordingly. - a #GtkEntryCompletion + a #GtkEntryCompletion - - Computes the common prefix that is shared by all rows in @completion + + Computes the common prefix that is shared by all rows in @completion that start with @key. If no row matches @key, %NULL will be returned. Note that a text column must have been set for this function to work, see gtk_entry_completion_set_text_column() for details. - The common prefix all rows starting with + The common prefix all rows starting with @key or %NULL if no row matches @key. - the entry completion + the entry completion - The text to complete for + The text to complete for - - Deletes the action at @index_ from @completion’s action list. + + Deletes the action at @index_ from @completion’s action list. Note that @index_ is a relative position and the position of an action may have changed since it was inserted. @@ -50421,253 +36049,165 @@ action may have changed since it was inserted. - a #GtkEntryCompletion + a #GtkEntryCompletion - the index of the item to delete + the index of the item to delete - - Get the original text entered by the user that triggered -the completion or %NULL if there’s no completion ongoing. + + Get the original text entered by the user that triggered +the completion or %NULL if there’s no completion ongoing. - the prefix for the current completion + the prefix for the current completion - a #GtkEntryCompletion + a #GtkEntryCompletion - - Gets the entry @completion has been attached to. + + Gets the entry @completion has been attached to. - The entry @completion has been attached to + The entry @completion has been attached to - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns whether the common prefix of the possible completions should + + Returns whether the common prefix of the possible completions should be automatically inserted in the entry. - %TRUE if inline completion is turned on + %TRUE if inline completion is turned on - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns %TRUE if inline-selection mode is turned on. + + Returns %TRUE if inline-selection mode is turned on. - %TRUE if inline-selection mode is on + %TRUE if inline-selection mode is on - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns the minimum key length as set for @completion. + + Returns the minimum key length as set for @completion. - The currently used minimum key length + The currently used minimum key length - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns the model the #GtkEntryCompletion is using as data source. + + Returns the model the #GtkEntryCompletion is using as data source. Returns %NULL if the model is unset. - A #GtkTreeModel, or %NULL if none + A #GtkTreeModel, or %NULL if none is currently being used - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns whether the completions should be presented in a popup window. + + Returns whether the completions should be presented in a popup window. - %TRUE if popup completion is turned on + %TRUE if popup completion is turned on - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns whether the completion popup window will be resized to the + + Returns whether the completion popup window will be resized to the width of the entry. - %TRUE if the popup window will be resized to the width of + %TRUE if the popup window will be resized to the width of the entry - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns whether the completion popup window will appear even if there is + + Returns whether the completion popup window will appear even if there is only a single match. - %TRUE if the popup window will appear regardless of the + %TRUE if the popup window will appear regardless of the number of matches - a #GtkEntryCompletion + a #GtkEntryCompletion - - Returns the column in the model of @completion to get strings from. + + Returns the column in the model of @completion to get strings from. - the column containing the strings + the column containing the strings - a #GtkEntryCompletion + a #GtkEntryCompletion - - Inserts an action in @completion’s action item list at position @index_ + + Inserts an action in @completion’s action item list at position @index_ with markup @markup. @@ -50675,31 +36215,21 @@ with markup @markup. - a #GtkEntryCompletion + a #GtkEntryCompletion - the index of the item to insert + the index of the item to insert - markup of the item to insert + markup of the item to insert - - Inserts an action in @completion’s action item list at position @index_ + + Inserts an action in @completion’s action item list at position @index_ with text @text. If you want the action item to have markup, use gtk_entry_completion_insert_action_markup(). @@ -50711,50 +36241,34 @@ the position of an action can change when deleting a different action. - a #GtkEntryCompletion + a #GtkEntryCompletion - the index of the item to insert + the index of the item to insert - text of the item to insert + text of the item to insert - - Requests a prefix insertion. + + Requests a prefix insertion. - a #GtkEntryCompletion + a #GtkEntryCompletion - - Sets whether the common prefix of the possible completions should + + Sets whether the common prefix of the possible completions should be automatically inserted in the entry. @@ -50762,25 +36276,17 @@ be automatically inserted in the entry. - a #GtkEntryCompletion + a #GtkEntryCompletion - %TRUE to do inline completion + %TRUE to do inline completion - - Sets whether it is possible to cycle through the possible completions + + Sets whether it is possible to cycle through the possible completions inside the entry. @@ -50788,25 +36294,17 @@ inside the entry. - a #GtkEntryCompletion + a #GtkEntryCompletion - %TRUE to do inline selection + %TRUE to do inline selection - - Sets the match function for @completion to be @func. The match function + + Sets the match function for @completion to be @func. The match function is used to determine if a row should or should not be in the completion list. @@ -50815,47 +36313,25 @@ list. - a #GtkEntryCompletion + a #GtkEntryCompletion - - the #GtkEntryCompletionMatchFunc to use - + + the #GtkEntryCompletionMatchFunc to use + - - user data for @func + + user data for @func - - destroy notify for @func_data. + + destroy notify for @func_data. - - Requires the length of the search key for @completion to be at least + + Requires the length of the search key for @completion to be at least @length. This is useful for long lists, where completing using a small key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset). @@ -50865,25 +36341,17 @@ key takes a lot of time and will come up with meaningless results anyway - a #GtkEntryCompletion + a #GtkEntryCompletion - the minimum length of the key in order to start completing + the minimum length of the key in order to start completing - - Sets the model for a #GtkEntryCompletion. If @completion already has + + Sets the model for a #GtkEntryCompletion. If @completion already has a model set, it will remove it before setting the new model. If model is %NULL, then it will unset the model. @@ -50892,53 +36360,34 @@ If model is %NULL, then it will unset the model. - a #GtkEntryCompletion + a #GtkEntryCompletion - - the #GtkTreeModel + + the #GtkTreeModel - - Sets whether the completions should be presented in a popup window. + + Sets whether the completions should be presented in a popup window. - a #GtkEntryCompletion + a #GtkEntryCompletion - %TRUE to do popup completion + %TRUE to do popup completion - - Sets whether the completion popup window will be resized to be the same + + Sets whether the completion popup window will be resized to be the same width as the entry. @@ -50946,25 +36395,17 @@ width as the entry. - a #GtkEntryCompletion + a #GtkEntryCompletion - %TRUE to make the width of the popup the same as the entry + %TRUE to make the width of the popup the same as the entry - - Sets whether the completion popup window will appear even if there is + + Sets whether the completion popup window will appear even if there is only a single match. You may want to set this to %FALSE if you are using [inline completion][GtkEntryCompletion--inline-completion]. @@ -50973,26 +36414,18 @@ are using [inline completion][GtkEntryCompletion--inline-completion]. - a #GtkEntryCompletion + a #GtkEntryCompletion - %TRUE if the popup should appear even for a single + %TRUE if the popup should appear even for a single match - - Convenience function for setting up the most used case of this code: a + + Convenience function for setting up the most used case of this code: a completion list with just strings. This function will set up @completion to have a list displaying all (and just) strings in the completion list, and to get those strings from @column in the model of @completion. @@ -51007,102 +36440,60 @@ property directly. - a #GtkEntryCompletion + a #GtkEntryCompletion - the column in the model of @completion to get strings from + the column in the model of @completion to get strings from - - The #GtkCellArea used to layout cell renderers in the treeview column. + + The #GtkCellArea used to layout cell renderers in the treeview column. If no area is specified when creating the entry completion with gtk_entry_completion_new_with_area() a horizontally oriented #GtkCellAreaBox will be used. - - Determines whether the common prefix of the possible completions + + Determines whether the common prefix of the possible completions should be inserted automatically in the entry. Note that this requires text-column to be set, even if you are using a custom match function. - - Determines whether the possible completions on the popup + + Determines whether the possible completions on the popup will appear in the entry as you navigate through them. - + - - Determines whether the possible completions should be + + Determines whether the possible completions should be shown in a popup window. - - Determines whether the completions popup window will be + + Determines whether the completions popup window will be resized to the width of the entry. - - Determines whether the completions popup window will shown + + Determines whether the completions popup window will shown for a single possible completion. You probably want to set this to %FALSE if you are using [inline completion][GtkEntryCompletion--inline-completion]. - - The column of the model containing the strings. + + The column of the model containing the strings. Note that the strings must be UTF-8. @@ -51110,29 +36501,22 @@ Note that the strings must be UTF-8. - + - Gets emitted when an action is activated. + Gets emitted when an action is activated. - the index of the activated action + the index of the activated action - Gets emitted when a match from the cursor is on a match + Gets emitted when a match from the cursor is on a match of the list. The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by @iter. @@ -51140,30 +36524,22 @@ pointed to by @iter. Note that @model is the model that was passed to gtk_entry_completion_set_model(). - %TRUE if the signal has been handled + %TRUE if the signal has been handled - the #GtkTreeModel containing the matches + the #GtkTreeModel containing the matches - a #GtkTreeIter positioned at the selected match + a #GtkTreeIter positioned at the selected match - Gets emitted when the inline autocompletion is triggered. + Gets emitted when the inline autocompletion is triggered. The default behaviour is to make the entry display the whole prefix and select the newly inserted part. @@ -51172,24 +36548,18 @@ smaller part of the @prefix into the entry - e.g. the entry used in the #GtkFileChooser inserts only the part of the prefix up to the next '/'. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - the common prefix of all possible completions + the common prefix of all possible completions - Gets emitted when a match from the list is selected. + Gets emitted when a match from the list is selected. The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by @iter. @@ -51197,30 +36567,22 @@ pointed to by @iter. Note that @model is the model that was passed to gtk_entry_completion_set_model(). - %TRUE if the signal has been handled + %TRUE if the signal has been handled - the #GtkTreeModel containing the matches + the #GtkTreeModel containing the matches - a #GtkTreeIter positioned at the selected match + a #GtkTreeIter positioned at the selected match - Gets emitted when the filter model has zero + Gets emitted when the filter model has zero number of rows in completion_complete method. (In other words when GtkEntryCompletion is out of suggestions) @@ -51229,9 +36591,7 @@ number of rows in completion_complete method. - + @@ -51344,11 +36704,8 @@ number of rows in completion_complete method. - - A function which decides whether the row indicated by @iter matches + + A function which decides whether the row indicated by @iter matches a given @key, and should be displayed as a possible completion for @key. Note that @key is normalized and case-folded (see g_utf8_normalize() and g_utf8_casefold()). If this is not appropriate, match functions @@ -51356,165 +36713,97 @@ have access to the unmodified key via `gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ()))`. - %TRUE if @iter should be displayed as a possible completion + %TRUE if @iter should be displayed as a possible completion for @key - the #GtkEntryCompletion + the #GtkEntryCompletion - the string to match, normalized and case-folded + the string to match, normalized and case-folded - a #GtkTreeIter indicating the row to match + a #GtkTreeIter indicating the row to match - - user data given to gtk_entry_completion_set_match_func() + + user data given to gtk_entry_completion_set_match_func() - + - + - - Specifies the side of the entry at which an icon is placed. - - At the beginning of the entry (depending on the text direction). + + Specifies the side of the entry at which an icon is placed. + + At the beginning of the entry (depending on the text direction). - - At the end of the entry (depending on the text direction). + + At the end of the entry (depending on the text direction). - - The #GtkEventBox widget is a subclass of #GtkBin which also has its + + The #GtkEventBox widget is a subclass of #GtkBin which also has its own window. It is useful since it allows you to catch events for widgets which do not have their own window. - Creates a new #GtkEventBox. + Creates a new #GtkEventBox. - a new #GtkEventBox + a new #GtkEventBox - - Returns whether the event box window is above or below the + + Returns whether the event box window is above or below the windows of its child. See gtk_event_box_set_above_child() for details. - %TRUE if the event box window is above the + %TRUE if the event box window is above the window of its child - a #GtkEventBox + a #GtkEventBox - - Returns whether the event box has a visible window. + + Returns whether the event box has a visible window. See gtk_event_box_set_visible_window() for details. - %TRUE if the event box window is visible + %TRUE if the event box window is visible - a #GtkEventBox + a #GtkEventBox - - Set whether the event box window is positioned above the windows + + Set whether the event box window is positioned above the windows of its child, as opposed to below it. If the window is above, all events inside the event box will go to the event box. If the window is below, events in windows of child widgets will first got to that @@ -51527,25 +36816,17 @@ The default is to keep the window below the child. - a #GtkEventBox + a #GtkEventBox - %TRUE if the event box window is above its child + %TRUE if the event box window is above its child - - Set whether the event box uses a visible or invisible child + + Set whether the event box uses a visible or invisible child window. The default is to use visible windows. In an invisible window event box, the window that the @@ -51570,12 +36851,12 @@ There is one unexpected issue for an invisible event box that has its window below the child. (See gtk_event_box_set_above_child().) Since the input-only window is not an ancestor window of any windows that descendent widgets of the event box create, events on these -windows aren’t propagated up by the windowing system, but only by GTK+. -The practical effect of this is if an event isn’t in the event +windows aren’t propagated up by the windowing system, but only by GTK+. +The practical effect of this is if an event isn’t in the event mask for the descendant window (see gtk_widget_add_events()), -it won’t be received by the event box. +it won’t be received by the event box. -This problem doesn’t occur for visible event boxes, because in +This problem doesn’t occur for visible event boxes, because in that case, the event box window is actually the ancestor of the descendant windows, not just at the same place on the screen. @@ -51584,15 +36865,11 @@ descendant windows, not just at the same place on the screen. - a #GtkEventBox + a #GtkEventBox - %TRUE to make the event box have a visible window + %TRUE to make the event box have a visible window @@ -51610,14 +36887,10 @@ descendant windows, not just at the same place on the screen. - + - The parent class. + The parent class. @@ -51656,100 +36929,61 @@ descendant windows, not just at the same place on the screen. - - #GtkEventController is a base, low-level implementation for event + + #GtkEventController is a base, low-level implementation for event controllers. Those react to a series of #GdkEvents, and possibly trigger actions as a consequence of those. - - Gets the propagation phase at which @controller handles events. + + Gets the propagation phase at which @controller handles events. - the propagation phase + the propagation phase - a #GtkEventController + a #GtkEventController - - Returns the #GtkWidget this controller relates to. + + Returns the #GtkWidget this controller relates to. - a #GtkWidget + a #GtkWidget - a #GtkEventController + a #GtkEventController - - Feeds an events into @controller, so it can be interpreted + + Feeds an events into @controller, so it can be interpreted and the controller actions triggered. - %TRUE if the event was potentially useful to trigger the + %TRUE if the event was potentially useful to trigger the controller action - a #GtkEventController + a #GtkEventController - a #GdkEvent + a #GdkEvent - - Resets the @controller to a clean state. Every interaction + + Resets the @controller to a clean state. Every interaction the controller did through #GtkEventController::handle-event will be dropped at this point. @@ -51758,19 +36992,13 @@ will be dropped at this point. - a #GtkEventController + a #GtkEventController - - Sets the propagation phase at which a controller handles events. + + Sets the propagation phase at which a controller handles events. If @phase is %GTK_PHASE_NONE, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, @@ -51781,55 +37009,29 @@ the events can be managed by calling gtk_event_controller_handle_event(). - a #GtkEventController + a #GtkEventController - a propagation phase + a propagation phase - - The propagation phase at which this controller will handle events. + + The propagation phase at which this controller will handle events. - - The widget receiving the #GdkEvents that the controller will handle. + + The widget receiving the #GdkEvents that the controller will handle. - + - - #GtkEventControllerKey is an event controller meant for situations + + #GtkEventControllerKey is an event controller meant for situations where you need access to key events. This object was added in 3.24. @@ -51859,8 +37061,7 @@ This object was added in 3.24. - + @@ -51871,30 +37072,21 @@ This object was added in 3.24. - - Gets the IM context of a key controller. + + Gets the IM context of a key controller. - the IM context + the IM context - a #GtkEventControllerKey + a #GtkEventControllerKey - + @@ -51924,60 +37116,42 @@ This object was added in 3.24. - This signal is emitted whenever a key is pressed. + This signal is emitted whenever a key is pressed. - %TRUE if the key press was handled, %FALSE otherwise. + %TRUE if the key press was handled, %FALSE otherwise. - the pressed key. + the pressed key. - the raw code of the pressed key. + the raw code of the pressed key. - the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType. + the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType. - This signal is emitted whenever a key is released. + This signal is emitted whenever a key is released. - the released key. + the released key. - the raw code of the released key. + the raw code of the released key. - the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType. + the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType. @@ -51993,118 +37167,74 @@ This object was added in 3.24. - + - - #GtkEventControllerMotion is an event controller meant for situations + + #GtkEventControllerMotion is an event controller meant for situations where you need to track the position of the pointer. This object was added in 3.24. - - Creates a new event controller that will handle motion events + + Creates a new event controller that will handle motion events for the given @widget. - a new #GtkEventControllerMotion + a new #GtkEventControllerMotion - a #GtkWidget + a #GtkWidget - Signals that the pointer has entered the widget. + Signals that the pointer has entered the widget. - the x coordinate + the x coordinate - the y coordinate + the y coordinate - Signals that pointer has left the widget. + Signals that pointer has left the widget. - Emitted when the pointer moves inside the widget. + Emitted when the pointer moves inside the widget. - the x coordinate + the x coordinate - the y coordinate + the y coordinate - + - - #GtkEventControllerScroll is an event controller meant to handle + + #GtkEventControllerScroll is an event controller meant to handle scroll events from mice and touchpads. It is capable of handling both discrete and continuous scroll events, abstracting them both on the #GtkEventControllerScroll::scroll signal (deltas in the @@ -52139,94 +37269,60 @@ was received. This object was added in 3.24. - - Creates a new event controller that will handle scroll events + + Creates a new event controller that will handle scroll events for the given @widget. - a new #GtkEventControllerScroll + a new #GtkEventControllerScroll - a #GtkWidget + a #GtkWidget - behavior flags - + behavior flags + - - Gets the flags conditioning the scroll controller behavior. + + Gets the flags conditioning the scroll controller behavior. - the controller flags. - + the controller flags. + - + - - Sets the flags conditioning scroll controller behavior. + + Sets the flags conditioning scroll controller behavior. - + - behavior flags - + behavior flags + - - The flags affecting event controller behavior + + The flags affecting event controller behavior - Emitted after scroll is finished if the #GTK_EVENT_CONTROLLER_SCROLL_KINETIC + Emitted after scroll is finished if the #GTK_EVENT_CONTROLLER_SCROLL_KINETIC flag is set. @vel_x and @vel_y express the initial velocity that was imprinted by the scroll events. @vel_x and @vel_y are expressed in pixels/ms. @@ -52235,168 +37331,86 @@ pixels/ms. - X velocity + X velocity - Y velocity + Y velocity - Signals that the widget should scroll by the + Signals that the widget should scroll by the amount specified by @dx and @dy. - X delta + X delta - Y delta + Y delta - Signals that a new scrolling operation has begun. It will + Signals that a new scrolling operation has begun. It will only be emitted on devices capable of it. - Signals that a new scrolling operation has finished. It will + Signals that a new scrolling operation has finished. It will only be emitted on devices capable of it. - + - - Describes the behavior of a #GtkEventControllerScroll. - - Don't emit scroll. + + Describes the behavior of a #GtkEventControllerScroll. + + Don't emit scroll. - - Emit scroll with vertical deltas. + + Emit scroll with vertical deltas. - - Emit scroll with horizontal deltas. + + Emit scroll with horizontal deltas. - - Only emit deltas that are multiples of 1. + + Only emit deltas that are multiples of 1. - - Emit #GtkEventControllerScroll::decelerate + + Emit #GtkEventControllerScroll::decelerate after continuous scroll finishes. - - Emit scroll on both axes. + + Emit scroll on both axes. - - Describes the state of a #GdkEventSequence in a #GtkGesture. - - The sequence is handled, but not grabbed. + + Describes the state of a #GdkEventSequence in a #GtkGesture. + + The sequence is handled, but not grabbed. - - The sequence is handled and grabbed. + + The sequence is handled and grabbed. - - The sequence is denied. + + The sequence is denied. - - A #GtkExpander allows the user to hide or show its child by clicking + + A #GtkExpander allows the user to hide or show its child by clicking on an expander triangle similar to the triangles used in a #GtkTreeView. Normally you use an expander as you would use any other descendant @@ -52448,8 +37462,8 @@ create_expander (void) # GtkExpander as GtkBuildable The GtkExpander implementation of the GtkBuildable interface supports -placing a child in the label position by specifying “label” as the -“type” attribute of a <child> element. A normal content child can be +placing a child in the label position by specifying “label” as the +“type” attribute of a <child> element. A normal content child can be specified without specifying a <child> type attribute. An example of a UI definition fragment with GtkExpander: @@ -52468,10 +37482,10 @@ An example of a UI definition fragment with GtkExpander: |[<!-- language="plain" --> expander -├── title -│ ├── arrow -│ ╰── <label widget> -╰── <child> +├── title +│ ├── arrow +│ ╰── <label widget> +╰── <child> ]| GtkExpander has three CSS nodes, the main node with the name expander, @@ -52481,54 +37495,34 @@ expander that is showing its child gets the :checked pseudoclass added to it. - Creates a new expander using @label as the text of the label. + Creates a new expander using @label as the text of the label. - a new #GtkExpander widget. + a new #GtkExpander widget. - - the text of the label + + the text of the label - - Creates a new expander using @label as the text of the label. + + Creates a new expander using @label as the text of the label. If characters in @label are preceded by an underscore, they are underlined. -If you need a literal underscore character in a label, use “__” (two +If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button. - a new #GtkExpander widget. + a new #GtkExpander widget. - - the text of the label with an underscore + + the text of the label with an underscore in front of the mnemonic character @@ -52545,37 +37539,25 @@ Pressing Alt and that key activates the button. - - Queries a #GtkExpander and returns its current state. Returns %TRUE + + Queries a #GtkExpander and returns its current state. Returns %TRUE if the child widget is revealed. See gtk_expander_set_expanded(). - the current state of the expander + the current state of the expander - a #GtkExpander + a #GtkExpander - - Fetches the text from a label widget including any embedded + + Fetches the text from a label widget including any embedded underlines indicating mnemonics and Pango markup, as set by gtk_expander_set_label(). If the label text has not been set the return value will be %NULL. This will be the case if you create an @@ -52588,171 +37570,113 @@ be avoided by fetching the label text directly from the label widget. - The text of the label widget. This string is owned + The text of the label widget. This string is owned by the widget and must not be modified or freed. - a #GtkExpander + a #GtkExpander - - Returns whether the label widget will fill all available + + Returns whether the label widget will fill all available horizontal space allocated to @expander. - %TRUE if the label widget will fill all + %TRUE if the label widget will fill all available horizontal space - a #GtkExpander + a #GtkExpander - - Retrieves the label widget for the frame. See + + Retrieves the label widget for the frame. See gtk_expander_set_label_widget(). - the label widget, + the label widget, or %NULL if there is none - a #GtkExpander + a #GtkExpander - - Returns whether the expander will resize the toplevel widget + + Returns whether the expander will resize the toplevel widget containing the expander upon resizing and collpasing. - the “resize toplevel” setting. + the “resize toplevel” setting. - a #GtkExpander + a #GtkExpander - - Gets the value set by gtk_expander_set_spacing(). + + Gets the value set by gtk_expander_set_spacing(). Use margins on the child instead. - spacing between the expander and child + spacing between the expander and child - a #GtkExpander + a #GtkExpander - - Returns whether the label’s text is interpreted as marked up with + + Returns whether the label’s text is interpreted as marked up with the [Pango text markup language][PangoMarkupFormat]. See gtk_expander_set_use_markup(). - %TRUE if the label’s text will be parsed for markup + %TRUE if the label’s text will be parsed for markup - a #GtkExpander + a #GtkExpander - - Returns whether an embedded underline in the expander label + + Returns whether an embedded underline in the expander label indicates a mnemonic. See gtk_expander_set_use_underline(). - %TRUE if an embedded underline in the expander + %TRUE if an embedded underline in the expander label indicates the mnemonic accelerator keys - a #GtkExpander + a #GtkExpander - - Sets the state of the expander. Set to %TRUE, if you want + + Sets the state of the expander. Set to %TRUE, if you want the child widget to be revealed, and %FALSE if you want the child widget to be hidden. @@ -52761,25 +37685,17 @@ child widget to be hidden. - a #GtkExpander + a #GtkExpander - whether the child widget is revealed + whether the child widget is revealed - - Sets the text of the label of the expander to @label. + + Sets the text of the label of the expander to @label. This will also clear any previously set labels. @@ -52788,28 +37704,17 @@ This will also clear any previously set labels. - a #GtkExpander + a #GtkExpander - - a string + + a string - - Sets whether the label widget should fill all available + + Sets whether the label widget should fill all available horizontal space allocated to @expander. Note that this function has no effect since 3.20. @@ -52819,26 +37724,18 @@ Note that this function has no effect since 3.20. - a #GtkExpander + a #GtkExpander - %TRUE if the label should should fill + %TRUE if the label should should fill all available horizontal space - - Set the label widget for the expander. This is the widget + + Set the label widget for the expander. This is the widget that will appear embedded alongside the expander arrow. @@ -52846,28 +37743,17 @@ that will appear embedded alongside the expander arrow. - a #GtkExpander + a #GtkExpander - - the new label widget + + the new label widget - - Sets whether the expander will resize the toplevel widget + + Sets whether the expander will resize the toplevel widget containing the expander upon resizing and collpasing. @@ -52875,27 +37761,17 @@ containing the expander upon resizing and collpasing. - a #GtkExpander + a #GtkExpander - whether to resize the toplevel + whether to resize the toplevel - - Sets the spacing field of @expander, which is the number of + + Sets the spacing field of @expander, which is the number of pixels to place between expander and the child. Use margins on the child instead. @@ -52904,26 +37780,18 @@ pixels to place between expander and the child. - a #GtkExpander + a #GtkExpander - distance between the expander and child in pixels + distance between the expander and child in pixels - - Sets whether the text of the label contains markup in -[Pango’s text markup language][PangoMarkupFormat]. + + Sets whether the text of the label contains markup in +[Pango’s text markup language][PangoMarkupFormat]. See gtk_label_set_markup(). @@ -52931,25 +37799,17 @@ See gtk_label_set_markup(). - a #GtkExpander + a #GtkExpander - %TRUE if the label’s text should be parsed for markup + %TRUE if the label’s text should be parsed for markup - - If true, an underline in the text of the expander label indicates + + If true, an underline in the text of the expander label indicates the next character should be used for the mnemonic accelerator key. @@ -52957,38 +37817,23 @@ the next character should be used for the mnemonic accelerator key. - a #GtkExpander + a #GtkExpander - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics - + - + - - Whether the label widget should fill all available horizontal space. + + Whether the label widget should fill all available horizontal space. Note that this property is ignored since 3.20. @@ -52996,39 +37841,22 @@ Note that this property is ignored since 3.20. - - When this property is %TRUE, the expander will resize the toplevel + + When this property is %TRUE, the expander will resize the toplevel widget containing the expander upon expanding and collapsing. - - Space to put between the label and the child when the + + Space to put between the label and the child when the expander is expanded. This property is deprecated and ignored. Use margins on the child instead. - + - + @@ -53043,13 +37871,7 @@ expander is expanded. - + @@ -53057,32 +37879,22 @@ expander is expanded. - + - + - + - + - + - The parent class. + The parent class. @@ -53134,139 +37946,113 @@ expander is expanded. - - Used to specify the style of the expanders drawn by a #GtkTreeView. - - The style used for a collapsed subtree. + + Used to specify the style of the expanders drawn by a #GtkTreeView. + + The style used for a collapsed subtree. - - Intermediate style used during animation. + + Intermediate style used during animation. - - Intermediate style used during animation. + + Intermediate style used during animation. - - The style used for an expanded subtree. + + The style used for an expanded subtree. - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -53280,282 +38066,217 @@ expander is expanded. - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -53569,59 +38290,43 @@ expander is expanded. - + - + - + - + - + - - #GtkFileChooser is an interface that can be implemented by file + + #GtkFileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are #GtkFileChooserWidget, #GtkFileChooserDialog, and #GtkFileChooserButton. You do not need to write an object that @@ -53635,7 +38340,7 @@ may be a bit confusing at first that these shortcuts come from various sources and in various flavours, so lets explain the terminology here: - Bookmarks: are created by the user, by dragging folders from the - right pane to the left pane, or by using the “Add”. Bookmarks + right pane to the left pane, or by using the “Add”. Bookmarks can be renamed and deleted by the user. - Shortcuts: can be provided by the application. For example, a Paint @@ -53643,7 +38348,7 @@ sources and in various flavours, so lets explain the terminology here: cannot be modified by the user. - Volumes: are provided by the underlying filesystem abstraction. They are - the “roots” of the filesystem. + the “roots” of the filesystem. # File Names and Encodings @@ -53745,12 +38450,8 @@ If you want to set more than one extra widget in the file chooser, you can a container such as a #GtkBox or a #GtkGrid and include your widgets in it. Then, set the container as the whole extra widget. - - Adds a 'choice' to the file chooser. This is typically implemented + + Adds a 'choice' to the file chooser. This is typically implemented as a combobox or, for boolean choices, as a checkbutton. You can select a value using gtk_file_chooser_set_choice() before the dialog is shown, and you can obtain the user-selected value in the ::response signal handler @@ -53763,53 +38464,33 @@ Compare gtk_file_chooser_set_extra_widget(). - a #GtkFileChooser + a #GtkFileChooser - id for the added choice + id for the added choice - user-visible label for the added choice + user-visible label for the added choice - - ids for the options of the choice, or %NULL for a boolean choice + + ids for the options of the choice, or %NULL for a boolean choice - - user-visible labels for the options, must be the same length as @options + + user-visible labels for the options, must be the same length as @options - - Adds @filter to the list of filters that the user can select between. + + Adds @filter to the list of filters that the user can select between. When a filter is selected, only files that are passed by that filter are displayed. @@ -53821,165 +38502,109 @@ ref and sink it if you want to keep a reference. - a #GtkFileChooser + a #GtkFileChooser - a #GtkFileFilter + a #GtkFileFilter - - Adds a folder to be displayed with the shortcut folders in a file chooser. + + Adds a folder to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a -“/usr/share/mydrawprogram/Clipart” folder to the volume list. +“/usr/share/mydrawprogram/Clipart” folder to the volume list. - %TRUE if the folder could be added successfully, %FALSE + %TRUE if the folder could be added successfully, %FALSE otherwise. In the latter case, the @error will be set as appropriate. - a #GtkFileChooser + a #GtkFileChooser - filename of the folder to add + filename of the folder to add - - Adds a folder URI to be displayed with the shortcut folders in a file + + Adds a folder URI to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a -“file:///usr/share/mydrawprogram/Clipart” folder to the volume list. +“file:///usr/share/mydrawprogram/Clipart” folder to the volume list. - %TRUE if the folder could be added successfully, %FALSE + %TRUE if the folder could be added successfully, %FALSE otherwise. In the latter case, the @error will be set as appropriate. - a #GtkFileChooser + a #GtkFileChooser - URI of the folder to add + URI of the folder to add - - Gets the type of operation that the file chooser is performing; see + + Gets the type of operation that the file chooser is performing; see gtk_file_chooser_set_action(). - the action that the file selector is performing + the action that the file selector is performing - a #GtkFileChooser + a #GtkFileChooser - - Gets the currently selected option in the 'choice' with the given ID. + + Gets the currently selected option in the 'choice' with the given ID. - the ID of the currenly selected option + the ID of the currenly selected option - a #GtkFileChooser + a #GtkFileChooser - the ID of the choice to get + the ID of the choice to get - - Gets whether file choser will offer to create new folders. + + Gets whether file choser will offer to create new folders. See gtk_file_chooser_set_create_folders(). - %TRUE if the Create Folder button should be displayed. + %TRUE if the Create Folder button should be displayed. - a #GtkFileChooser + a #GtkFileChooser - - Gets the current folder of @chooser as a local filename. + + Gets the current folder of @chooser as a local filename. See gtk_file_chooser_set_current_folder(). Note that this is the folder that the file chooser is currently displaying @@ -53991,9 +38616,7 @@ currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the usual way to get the selection. - the full path of the current + the full path of the current folder, or %NULL if the current path cannot be represented as a local filename. Free with g_free(). This function will also return %NULL if the file chooser was unable to load the last folder that @@ -54003,42 +38626,28 @@ gtk_file_chooser_set_current_folder() on a nonexistent folder. - a #GtkFileChooser + a #GtkFileChooser - - Gets the current folder of @chooser as #GFile. + + Gets the current folder of @chooser as #GFile. See gtk_file_chooser_get_current_folder_uri(). - the #GFile for the current folder. + the #GFile for the current folder. - a #GtkFileChooser + a #GtkFileChooser - - Gets the current folder of @chooser as an URI. + + Gets the current folder of @chooser as an URI. See gtk_file_chooser_set_current_folder_uri(). Note that this is the folder that the file chooser is currently displaying @@ -54050,9 +38659,7 @@ currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the usual way to get the selection. - the URI for the current folder. + the URI for the current folder. Free with g_free(). This function will also return %NULL if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling gtk_file_chooser_set_current_folder_uri() on a @@ -54061,98 +38668,68 @@ nonexistent folder. - a #GtkFileChooser + a #GtkFileChooser - - Gets the current name in the file selector, as entered by the user in the -text entry for “Name”. + + Gets the current name in the file selector, as entered by the user in the +text entry for “Name”. This is meant to be used in save dialogs, to get the currently typed filename when the file itself does not exist yet. For example, an application that -adds a custom extra widget to the file chooser for “file format” may want to +adds a custom extra widget to the file chooser for “file format” may want to change the extension of the typed filename based on the chosen format, say, -from “.jpg” to “.png”. +from “.jpg” to “.png”. - The raw text from the file chooser’s “Name” entry. Free this with + The raw text from the file chooser’s “Name” entry. Free this with g_free(). Note that this string is not a full pathname or URI; it is whatever the contents of the entry are. Note also that this string is in -UTF-8 encoding, which is not necessarily the system’s encoding for filenames. +UTF-8 encoding, which is not necessarily the system’s encoding for filenames. - a #GtkFileChooser + a #GtkFileChooser - - Queries whether a file chooser is set to confirm for overwriting when the user + + Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists. - %TRUE if the file chooser will present a confirmation dialog; + %TRUE if the file chooser will present a confirmation dialog; %FALSE otherwise. - a #GtkFileChooser + a #GtkFileChooser - - Gets the current extra widget; see + + Gets the current extra widget; see gtk_file_chooser_set_extra_widget(). - the current extra widget, or %NULL + the current extra widget, or %NULL - a #GtkFileChooser + a #GtkFileChooser - - Gets the #GFile for the currently selected file in + + Gets the #GFile for the currently selected file in the file selector. If multiple files are selected, one of the files will be returned at random. @@ -54160,27 +38737,19 @@ If the file chooser is in folder mode, this function returns the selected folder. - a selected #GFile. You own the returned file; + a selected #GFile. You own the returned file; use g_object_unref() to release it. - a #GtkFileChooser + a #GtkFileChooser - - Gets the filename for the currently selected file in + + Gets the filename for the currently selected file in the file selector. The filename is returned as an absolute path. If multiple files are selected, one of the filenames will be returned at random. @@ -54189,36 +38758,26 @@ If the file chooser is in folder mode, this function returns the selected folder. - The currently selected filename, + The currently selected filename, or %NULL if no file is selected, or the selected file can't be represented with a local filename. Free with g_free(). - a #GtkFileChooser + a #GtkFileChooser - - Lists all the selected files and subfolders in the current folder of + + Lists all the selected files and subfolders in the current folder of @chooser. The returned names are full absolute paths. If files in the current folder cannot be represented as local filenames they will be ignored. (See gtk_file_chooser_get_uris()) - a #GSList + a #GSList containing the filenames of all selected files and subfolders in the current folder. Free the returned list with g_slist_free(), and the filenames with g_free(). @@ -54228,25 +38787,17 @@ gtk_file_chooser_get_uris()) - a #GtkFileChooser + a #GtkFileChooser - - Lists all the selected files and subfolders in the current folder of @chooser + + Lists all the selected files and subfolders in the current folder of @chooser as #GFile. An internal function, see gtk_file_chooser_get_uris(). - a #GSList + a #GSList containing a #GFile for each selected file and subfolder in the current folder. Free the returned list with g_slist_free(), and the files with g_object_unref(). @@ -54256,230 +38807,152 @@ as #GFile. An internal function, see gtk_file_chooser_get_uris(). - a #GtkFileChooser + a #GtkFileChooser - - Gets the current filter; see gtk_file_chooser_set_filter(). + + Gets the current filter; see gtk_file_chooser_set_filter(). - the current filter, or %NULL + the current filter, or %NULL - a #GtkFileChooser + a #GtkFileChooser - - Gets whether only local files can be selected in the + + Gets whether only local files can be selected in the file selector. See gtk_file_chooser_set_local_only() - %TRUE if only local files can be selected. + %TRUE if only local files can be selected. - a #GtkFileChooser + a #GtkFileChooser - - Gets the #GFile that should be previewed in a custom preview + + Gets the #GFile that should be previewed in a custom preview Internal function, see gtk_file_chooser_get_preview_uri(). - the #GFile for the file to preview, + the #GFile for the file to preview, or %NULL if no file is selected. Free with g_object_unref(). - a #GtkFileChooser + a #GtkFileChooser - - Gets the filename that should be previewed in a custom preview + + Gets the filename that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget(). - the filename to preview, or %NULL if + the filename to preview, or %NULL if no file is selected, or if the selected file cannot be represented as a local filename. Free with g_free() - a #GtkFileChooser + a #GtkFileChooser - - Gets the URI that should be previewed in a custom preview + + Gets the URI that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget(). - the URI for the file to preview, + the URI for the file to preview, or %NULL if no file is selected. Free with g_free(). - a #GtkFileChooser + a #GtkFileChooser - - Gets the current preview widget; see + + Gets the current preview widget; see gtk_file_chooser_set_preview_widget(). - the current preview widget, or %NULL + the current preview widget, or %NULL - a #GtkFileChooser + a #GtkFileChooser - - Gets whether the preview widget set by gtk_file_chooser_set_preview_widget() + + Gets whether the preview widget set by gtk_file_chooser_set_preview_widget() should be shown for the current filename. See gtk_file_chooser_set_preview_widget_active(). - %TRUE if the preview widget is active for the current filename. + %TRUE if the preview widget is active for the current filename. - a #GtkFileChooser + a #GtkFileChooser - - Gets whether multiple files can be selected in the file + + Gets whether multiple files can be selected in the file selector. See gtk_file_chooser_set_select_multiple(). - %TRUE if multiple files can be selected. + %TRUE if multiple files can be selected. - a #GtkFileChooser + a #GtkFileChooser - - Gets whether hidden files and folders are displayed in the file selector. + + Gets whether hidden files and folders are displayed in the file selector. See gtk_file_chooser_set_show_hidden(). - %TRUE if hidden files and folders are displayed. + %TRUE if hidden files and folders are displayed. - a #GtkFileChooser + a #GtkFileChooser - - Gets the URI for the currently selected file in + + Gets the URI for the currently selected file in the file selector. If multiple files are selected, one of the filenames will be returned at random. @@ -54487,9 +38960,7 @@ If the file chooser is in folder mode, this function returns the selected folder. - The currently selected URI, or %NULL + The currently selected URI, or %NULL if no file is selected. If gtk_file_chooser_set_local_only() is set to %TRUE (the default) a local URI will be returned for any FUSE locations. Free with g_free() @@ -54497,25 +38968,17 @@ folder. - a #GtkFileChooser + a #GtkFileChooser - - Lists all the selected files and subfolders in the current folder of + + Lists all the selected files and subfolders in the current folder of @chooser. The returned names are full absolute URIs. - a #GSList containing the URIs of all selected + a #GSList containing the URIs of all selected files and subfolders in the current folder. Free the returned list with g_slist_free(), and the filenames with g_free(). @@ -54524,48 +38987,33 @@ folder. - a #GtkFileChooser + a #GtkFileChooser - - Gets whether a stock label should be drawn with the name of the previewed + + Gets whether a stock label should be drawn with the name of the previewed file. See gtk_file_chooser_set_use_preview_label(). - %TRUE if the file chooser is set to display a label with the + %TRUE if the file chooser is set to display a label with the name of the previewed file, %FALSE otherwise. - a #GtkFileChooser + a #GtkFileChooser - - Lists the current set of user-selectable filters; see + + Lists the current set of user-selectable filters; see gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter(). - a + a #GSList containing the current set of user selectable filters. The contents of the list are owned by GTK+, but you must free the list itself with g_slist_free() when you are done with it. @@ -54575,25 +39023,17 @@ gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter(). - a #GtkFileChooser + a #GtkFileChooser - - Queries the list of shortcut folders in the file chooser, as set by + + Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder_uri(). - A list of + A list of folder URIs, or %NULL if there are no shortcut folders. Free the returned list with g_slist_free(), and the URIs with g_free(). @@ -54602,25 +39042,17 @@ returned list with g_slist_free(), and the URIs with g_free(). - a #GtkFileChooser + a #GtkFileChooser - - Queries the list of shortcut folders in the file chooser, as set by + + Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder(). - A list + A list of folder filenames, or %NULL if there are no shortcut folders. Free the returned list with g_slist_free(), and the filenames with g_free(). @@ -54630,75 +39062,50 @@ g_free(). - a #GtkFileChooser + a #GtkFileChooser - - Removes a 'choice' that has been added with gtk_file_chooser_add_choice(). + + Removes a 'choice' that has been added with gtk_file_chooser_add_choice(). - a #GtkFileChooser + a #GtkFileChooser - the ID of the choice to remove + the ID of the choice to remove - - Removes @filter from the list of filters that the user can select between. + + Removes @filter from the list of filters that the user can select between. - a #GtkFileChooser + a #GtkFileChooser - a #GtkFileFilter + a #GtkFileFilter - - Removes a folder from a file chooser’s list of shortcut folders. + + Removes a folder from a file chooser’s list of shortcut folders. - %TRUE if the operation succeeds, %FALSE otherwise. + %TRUE if the operation succeeds, %FALSE otherwise. In the latter case, the @error will be set as appropriate. See also: gtk_file_chooser_add_shortcut_folder() @@ -54706,31 +39113,20 @@ See also: gtk_file_chooser_add_shortcut_folder() - a #GtkFileChooser + a #GtkFileChooser - filename of the folder to remove + filename of the folder to remove - - Removes a folder URI from a file chooser’s list of shortcut folders. + + Removes a folder URI from a file chooser’s list of shortcut folders. - %TRUE if the operation succeeds, %FALSE otherwise. + %TRUE if the operation succeeds, %FALSE otherwise. In the latter case, the @error will be set as appropriate. See also: gtk_file_chooser_add_shortcut_folder_uri() @@ -54738,136 +39134,91 @@ See also: gtk_file_chooser_add_shortcut_folder_uri() - a #GtkFileChooser + a #GtkFileChooser - URI of the folder to remove + URI of the folder to remove - - Selects all the files in the current folder of a file chooser. + + Selects all the files in the current folder of a file chooser. - a #GtkFileChooser + a #GtkFileChooser - - Selects the file referred to by @file. An internal function. See + + Selects the file referred to by @file. An internal function. See _gtk_file_chooser_select_uri(). - Not useful. + Not useful. - a #GtkFileChooser + a #GtkFileChooser - the file to select + the file to select - - Selects a filename. If the file name isn’t in the current + + Selects a filename. If the file name isn’t in the current folder of @chooser, then the current folder of @chooser will be changed to the folder containing @filename. - Not useful. + Not useful. See also: gtk_file_chooser_set_filename() - a #GtkFileChooser + a #GtkFileChooser - the filename to select + the filename to select - - Selects the file to by @uri. If the URI doesn’t refer to a + + Selects the file to by @uri. If the URI doesn’t refer to a file in the current folder of @chooser, then the current folder of @chooser will be changed to the folder containing @filename. - Not useful. + Not useful. - a #GtkFileChooser + a #GtkFileChooser - the URI to select + the URI to select - - Sets the type of operation that the chooser is performing; the + + Sets the type of operation that the chooser is performing; the user interface is adapted to suit the selected action. For example, an option to create a new folder might be shown if the action is %GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is @@ -54878,25 +39229,17 @@ an option to create a new folder might be shown if the action is - a #GtkFileChooser + a #GtkFileChooser - the action that the file selector is performing + the action that the file selector is performing - - Selects an option in a 'choice' that has been added with + + Selects an option in a 'choice' that has been added with gtk_file_chooser_add_choice(). For a boolean choice, the possible options are "true" and "false". @@ -54905,31 +39248,21 @@ possible options are "true" and "false". - a #GtkFileChooser + a #GtkFileChooser - the ID of the choice to set + the ID of the choice to set - the ID of the option to select + the ID of the option to select - - Sets whether file choser will offer to create new folders. + + Sets whether file choser will offer to create new folders. This is only relevant if the action is not set to be %GTK_FILE_CHOOSER_ACTION_OPEN. @@ -54938,25 +39271,17 @@ This is only relevant if the action is not set to be - a #GtkFileChooser + a #GtkFileChooser - %TRUE if the Create Folder button should be displayed + %TRUE if the Create Folder button should be displayed - - Sets the current folder for @chooser from a local filename. + + Sets the current folder for @chooser from a local filename. The user will be shown the full contents of the current folder, plus user interface elements for navigating to other folders. @@ -54965,63 +39290,42 @@ In general, you should not use this function. See the for the rationale behind this. - Not useful. + Not useful. - a #GtkFileChooser + a #GtkFileChooser - the full path of the new current folder + the full path of the new current folder - - Sets the current folder for @chooser from a #GFile. + + Sets the current folder for @chooser from a #GFile. Internal function, see gtk_file_chooser_set_current_folder_uri(). - %TRUE if the folder could be changed successfully, %FALSE + %TRUE if the folder could be changed successfully, %FALSE otherwise. - a #GtkFileChooser + a #GtkFileChooser - the #GFile for the new folder + the #GFile for the new folder - - Sets the current folder for @chooser from an URI. + + Sets the current folder for @chooser from an URI. The user will be shown the full contents of the current folder, plus user interface elements for navigating to other folders. @@ -55030,37 +39334,27 @@ In general, you should not use this function. See the for the rationale behind this. - %TRUE if the folder could be changed successfully, %FALSE + %TRUE if the folder could be changed successfully, %FALSE otherwise. - a #GtkFileChooser + a #GtkFileChooser - the URI for the new current folder + the URI for the new current folder - - Sets the current name in the file selector, as if entered + + Sets the current name in the file selector, as if entered by the user. Note that the name passed in here is a UTF-8 string rather than a filename. This function is meant for -such uses as a suggested name in a “Save As...” dialog. You can -pass “Untitled.doc” or a similarly suitable suggestion for the @name. +such uses as a suggested name in a “Save As...” dialog. You can +pass “Untitled.doc” or a similarly suitable suggestion for the @name. If you want to preselect a particular existing file, you should use gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead. @@ -55072,25 +39366,17 @@ gtk_file_chooser_set_current_name() as well. - a #GtkFileChooser + a #GtkFileChooser - the filename to use, as a UTF-8 string + the filename to use, as a UTF-8 string - - Sets whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present + + Sets whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present a confirmation dialog if the user types a file name that already exists. This is %FALSE by default. @@ -55107,57 +39393,39 @@ for the details. - a #GtkFileChooser + a #GtkFileChooser - - whether to confirm overwriting in save mode + + whether to confirm overwriting in save mode - - Sets an application-supplied widget to provide extra options to the user. + + Sets an application-supplied widget to provide extra options to the user. - a #GtkFileChooser + a #GtkFileChooser - widget for extra options + widget for extra options - - Sets @file as the current filename for the file chooser, by changing -to the file’s parent folder and actually selecting the file in list. If -the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name -will also appear in the dialog’s file name entry. + + Sets @file as the current filename for the file chooser, by changing +to the file’s parent folder and actually selecting the file in list. If +the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name +will also appear in the dialog’s file name entry. -If the file name isn’t in the current folder of @chooser, then the current +If the file name isn’t in the current folder of @chooser, then the current folder of @chooser will be changed to the folder containing @filename. This is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by gtk_file_chooser_select_filename(). @@ -55168,8 +39436,8 @@ for the directory change. If you are implementing a save dialog, you should use this function if you already have a file name to which the user may save; for example, when the user opens an existing file and then -does Save As... If you don’t have -a file name already — for example, if the user just created a new +does Save As... If you don’t have +a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Instead, use something similar to this: |[<!-- language="C" --> @@ -55187,36 +39455,26 @@ else ]| - Not useful. + Not useful. - a #GtkFileChooser + a #GtkFileChooser - the #GFile to set as current + the #GFile to set as current - - Sets @filename as the current filename for the file chooser, by changing to -the file’s parent folder and actually selecting the file in list; all other + + Sets @filename as the current filename for the file chooser, by changing to +the file’s parent folder and actually selecting the file in list; all other files will be unselected. If the @chooser is in -%GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in -the dialog’s file name entry. +%GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in +the dialog’s file name entry. Note that the file must exist, or nothing will be done except for the directory change. @@ -55225,7 +39483,7 @@ You should use this function only when implementing a save dialog for which you already have a file name to which the user may save. For example, when the user opens an existing file and then does Save As... to save a copy or -a modified version. If you don’t have a file name already — for +a modified version. If you don’t have a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Instead, use something similar to this: |[<!-- language="C" --> @@ -55242,36 +39500,26 @@ else ]| In the first case, the file chooser will present the user with useful suggestions -as to where to save his new file. In the second case, the file’s existing location +as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it. - Not useful. + Not useful. - a #GtkFileChooser + a #GtkFileChooser - the filename to set as current + the filename to set as current - - Sets the current filter; only the files that pass the + + Sets the current filter; only the files that pass the filter will be displayed. If the user-selectable list of filters is non-empty, then the filter should be one of the filters in that list. Setting the current filter when the list of @@ -55283,25 +39531,17 @@ set of files without letting the user change it. - a #GtkFileChooser + a #GtkFileChooser - a #GtkFileFilter + a #GtkFileFilter - - Sets whether only local files can be selected in the + + Sets whether only local files can be selected in the file selector. If @local_only is %TRUE (the default), then the selected file or files are guaranteed to be accessible through the operating systems native file @@ -55320,25 +39560,17 @@ filesystem (FUSE). - a #GtkFileChooser + a #GtkFileChooser - %TRUE if only local files can be selected + %TRUE if only local files can be selected - - Sets an application-supplied widget to use to display a custom preview + + Sets an application-supplied widget to use to display a custom preview of the currently selected file. To implement a preview, after setting the preview widget, you connect to the #GtkFileChooser::update-preview signal, and call gtk_file_chooser_get_preview_filename() or @@ -55356,25 +39588,17 @@ will display no preview at all. - a #GtkFileChooser + a #GtkFileChooser - widget for displaying preview. + widget for displaying preview. - - Sets whether the preview widget set by + + Sets whether the preview widget set by gtk_file_chooser_set_preview_widget() should be shown for the current filename. When @active is set to false, the file chooser may display an internally generated preview of the current file @@ -55386,25 +39610,17 @@ gtk_file_chooser_set_preview_widget() for more details. - a #GtkFileChooser + a #GtkFileChooser - whether to display the user-specified preview widget + whether to display the user-specified preview widget - - Sets whether multiple files can be selected in the file selector. This is + + Sets whether multiple files can be selected in the file selector. This is only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER. @@ -55413,53 +39629,37 @@ only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or - a #GtkFileChooser + a #GtkFileChooser - %TRUE if multiple files can be selected. + %TRUE if multiple files can be selected. - - Sets whether hidden files and folders are displayed in the file selector. + + Sets whether hidden files and folders are displayed in the file selector. - a #GtkFileChooser + a #GtkFileChooser - %TRUE if hidden files and folders should be displayed. + %TRUE if hidden files and folders should be displayed. - - Sets the file referred to by @uri as the current file for the file chooser, -by changing to the URI’s parent folder and actually selecting the URI in the -list. If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI’s base -name will also appear in the dialog’s file name entry. + + Sets the file referred to by @uri as the current file for the file chooser, +by changing to the URI’s parent folder and actually selecting the URI in the +list. If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI’s base +name will also appear in the dialog’s file name entry. Note that the URI must exist, or nothing will be done except for the directory change. @@ -55468,7 +39668,7 @@ You should use this function only when implementing a save dialog for which you already have a file name to which the user may save. For example, when the user opens an existing file and then does Save As... to save a copy or a -modified version. If you don’t have a file name already — for example, +modified version. If you don’t have a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Instead, use something similar to this: |[<!-- language="C" --> @@ -55486,36 +39686,26 @@ else In the first case, the file chooser will present the user with useful suggestions -as to where to save his new file. In the second case, the file’s existing location +as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it. - Not useful. + Not useful. - a #GtkFileChooser + a #GtkFileChooser - the URI to set as current + the URI to set as current - - Sets whether the file chooser should display a stock label with the name of + + Sets whether the file chooser should display a stock label with the name of the file that is being previewed; the default is %TRUE. Applications that want to draw the whole preview area themselves should set this to %FALSE and display the name themselves in their preview widget. @@ -55527,44 +39717,30 @@ See also: gtk_file_chooser_set_preview_widget() - a #GtkFileChooser + a #GtkFileChooser - whether to display a stock label with the name of the previewed file + whether to display a stock label with the name of the previewed file - - Unselects all the files in the current folder of a file chooser. + + Unselects all the files in the current folder of a file chooser. - a #GtkFileChooser + a #GtkFileChooser - - Unselects the file referred to by @file. If the file is not in the current + + Unselects the file referred to by @file. If the file is not in the current directory, does not exist, or is otherwise not currently selected, does nothing. @@ -55572,25 +39748,17 @@ directory, does not exist, or is otherwise not currently selected, does nothing. - a #GtkFileChooser + a #GtkFileChooser - a #GFile + a #GFile - - Unselects a currently selected filename. If the filename + + Unselects a currently selected filename. If the filename is not in the current directory, does not exist, or is otherwise not currently selected, does nothing. @@ -55599,25 +39767,17 @@ is otherwise not currently selected, does nothing. - a #GtkFileChooser + a #GtkFileChooser - the filename to unselect + the filename to unselect - - Unselects the file referred to by @uri. If the file + + Unselects the file referred to by @uri. If the file is not in the current directory, does not exist, or is otherwise not currently selected, does nothing. @@ -55626,15 +39786,11 @@ is otherwise not currently selected, does nothing. - a #GtkFileChooser + a #GtkFileChooser - the URI to unselect + the URI to unselect @@ -55642,23 +39798,13 @@ is otherwise not currently selected, does nothing. - - Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode + + Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders. - - Whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode + + Whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present an overwrite confirmation dialog if the user selects a file name that already exists. @@ -55675,9 +39821,7 @@ selects a file name that already exists. - + @@ -55686,15 +39830,11 @@ selects a file name that already exists. - + - This signal gets emitted whenever it is appropriate to present a + This signal gets emitted whenever it is appropriate to present a confirmation dialog when the user has selected a file name that already exists. The signal only gets emitted when the file chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode. @@ -55753,17 +39893,13 @@ if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT) gtk_widget_destroy (chooser); ]| - a #GtkFileChooserConfirmation value that indicates which + a #GtkFileChooserConfirmation value that indicates which action to take after emitting the signal. - This signal is emitted when the current folder in a #GtkFileChooser + This signal is emitted when the current folder in a #GtkFileChooser changes. This can happen due to the user performing some action that changes folders, such as selecting a bookmark or visiting a folder on the file list. It can also happen as a result of calling a function to @@ -55781,9 +39917,7 @@ gtk_file_chooser_get_current_folder_uri(). - This signal is emitted when the user "activates" a file in the file + This signal is emitted when the user "activates" a file in the file chooser. This can happen by double-clicking on a file in the file list, or by pressing `Enter`. @@ -55799,9 +39933,7 @@ gtk_file_chooser_get_uris(). - This signal is emitted when there is a change in the set of selected files + This signal is emitted when there is a change in the set of selected files in a #GtkFileChooser. This can happen when the user modifies the selection with the mouse or the keyboard, or when explicitly calling functions to change the selection. @@ -55820,9 +39952,7 @@ gtk_file_chooser_get_uris(). - This signal is emitted when the preview in a file chooser should be + This signal is emitted when the preview in a file chooser should be regenerated. For example, this can happen when the currently selected file changes. You should use this signal if you want your file chooser to have a preview widget. @@ -55849,64 +39979,31 @@ gtk_file_chooser_get_preview_uri(). - - Describes whether a #GtkFileChooser is being used to open existing files + + Describes whether a #GtkFileChooser is being used to open existing files or to save to a possibly new file. - - Indicates open mode. The file chooser + + Indicates open mode. The file chooser will only let the user pick an existing file. - - Indicates save mode. The file chooser + + Indicates save mode. The file chooser will let the user pick an existing file, or type in a new filename. - - Indicates an Open mode for + + Indicates an Open mode for selecting folders. The file chooser will let the user pick an existing folder. - - Indicates a mode for creating a + + Indicates a mode for creating a new folder. The file chooser will let the user name an existing or new folder. - - The #GtkFileChooserButton is a widget that lets the user select a + + The #GtkFileChooserButton is a widget that lets the user select a file. It implements the #GtkFileChooser interface. Visually, it is a file name with a button to bring up a #GtkFileChooserDialog. The user can then use that dialog to change the file associated with @@ -55938,47 +40035,33 @@ The #GtkFileChooserButton supports the #GtkFileChooserActions # CSS nodes -GtkFileChooserButton has a CSS node with name “filechooserbutton”, containing -a subnode for the internal button with name “button” and style class “.file”. +GtkFileChooserButton has a CSS node with name “filechooserbutton”, containing +a subnode for the internal button with name “button” and style class “.file”. - - Creates a new file-selecting button widget. + + Creates a new file-selecting button widget. - a new button widget. + a new button widget. - the title of the browse dialog. + the title of the browse dialog. - the open mode for the widget. + the open mode for the widget. - - Creates a #GtkFileChooserButton widget which uses @dialog as its + + Creates a #GtkFileChooserButton widget which uses @dialog as its file-picking window. Note that @dialog must be a #GtkDialog (or subclass) which @@ -55990,16 +40073,12 @@ added with response %GTK_RESPONSE_ACCEPT or %GTK_RESPONSE_OK in order for the button to take over the file selected in the dialog. - a new button widget. + a new button widget. - the widget to use as dialog + the widget to use as dialog @@ -56015,88 +40094,56 @@ order for the button to take over the file selected in the dialog. - - Returns whether the button grabs focus when it is clicked with the mouse. + + Returns whether the button grabs focus when it is clicked with the mouse. See gtk_file_chooser_button_set_focus_on_click(). Use gtk_widget_get_focus_on_click() instead - %TRUE if the button grabs focus when it is clicked with + %TRUE if the button grabs focus when it is clicked with the mouse. - a #GtkFileChooserButton + a #GtkFileChooserButton - - Retrieves the title of the browse dialog used by @button. The returned value + + Retrieves the title of the browse dialog used by @button. The returned value should not be modified or freed. - a pointer to the browse dialog’s title. + a pointer to the browse dialog’s title. - the button widget to examine. + the button widget to examine. - - Retrieves the width in characters of the @button widget’s entry and/or label. + + Retrieves the width in characters of the @button widget’s entry and/or label. - an integer width (in characters) that the button will use to size itself. + an integer width (in characters) that the button will use to size itself. - the button widget to examine. + the button widget to examine. - - Sets whether the button will grab focus when it is clicked with the mouse. + + Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where -you don’t want the keyboard focus removed from the main area of the +you don’t want the keyboard focus removed from the main area of the application. Use gtk_widget_set_focus_on_click() instead @@ -56105,109 +40152,69 @@ application. - a #GtkFileChooserButton + a #GtkFileChooserButton - whether the button grabs focus when clicked with the mouse + whether the button grabs focus when clicked with the mouse - - Modifies the @title of the browse dialog used by @button. + + Modifies the @title of the browse dialog used by @button. - the button widget to modify. + the button widget to modify. - the new browse dialog title. + the new browse dialog title. - - Sets the width (in characters) that @button will use to @n_chars. + + Sets the width (in characters) that @button will use to @n_chars. - the button widget to examine. + the button widget to examine. - the new width, in characters. + the new width, in characters. - - Instance of the #GtkFileChooserDialog associated with the button. + + Instance of the #GtkFileChooserDialog associated with the button. - - Title to put on the #GtkFileChooserDialog associated with the button. + + Title to put on the #GtkFileChooserDialog associated with the button. - - The width of the entry and label inside the button, in characters. + + The width of the entry and label inside the button, in characters. - + - The ::file-set signal is emitted when the user selects a file. + The ::file-set signal is emitted when the user selects a file. Note that this signal is only emitted when the user changes the file. @@ -56216,14 +40223,10 @@ changes the file. - + - The parent class. + The parent class. @@ -56272,62 +40275,31 @@ changes the file. - + - - Used as a return value of handlers for the + + Used as a return value of handlers for the #GtkFileChooser::confirm-overwrite signal of a #GtkFileChooser. This value determines whether the file chooser will present the stock -confirmation dialog, accept the user’s choice of a filename, or +confirmation dialog, accept the user’s choice of a filename, or let the user choose another filename. - - The file chooser will present + + The file chooser will present its stock dialog to confirm about overwriting an existing file. - - The file chooser will - terminate and accept the user’s choice of a file name. + + The file chooser will + terminate and accept the user’s choice of a file name. - - The file chooser will + + The file chooser will continue running, so as to let the user select another file name. - - #GtkFileChooserDialog is a dialog box suitable for use with -“File/Open” or “File/Save as” commands. This widget works by + + #GtkFileChooserDialog is a dialog box suitable for use with +“File/Open” or “File/Save as” commands. This widget works by putting a #GtkFileChooserWidget inside a #GtkDialog. It exposes the #GtkFileChooser interface, so you can use all of the #GtkFileChooser functions on the file chooser dialog as well as @@ -56421,14 +40393,14 @@ There are various cases in which you may need to use a #GtkFileChooserDialog: - To select a file for opening. Use #GTK_FILE_CHOOSER_ACTION_OPEN. - To save a file for the first time. Use #GTK_FILE_CHOOSER_ACTION_SAVE, - and suggest a name such as “Untitled” with gtk_file_chooser_set_current_name(). + and suggest a name such as “Untitled” with gtk_file_chooser_set_current_name(). - To save a file under a different name. Use #GTK_FILE_CHOOSER_ACTION_SAVE, and set the existing filename with gtk_file_chooser_set_filename(). - To choose a folder instead of a file. Use #GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER. -Note that old versions of the file chooser’s documentation suggested +Note that old versions of the file chooser’s documentation suggested using gtk_file_chooser_set_current_folder() in various situations, with the intention of letting the application suggest a reasonable default folder. This is no longer @@ -56460,11 +40432,11 @@ dialog = gtk_file_chooser_dialog_new ("Open File", NULL); ]| -This will create buttons for “Cancel” and “Open” that use stock +This will create buttons for “Cancel” and “Open” that use stock response identifiers from #GtkResponseType. For most dialog boxes you can use your own custom response codes rather than the ones in #GtkResponseType, but #GtkFileChooserDialog assumes that -its “accept”-type action, e.g. an “Open” or “Save” button, +its “accept”-type action, e.g. an “Open” or “Save” button, will have one of the following response codes: - #GTK_RESPONSE_ACCEPT @@ -56474,7 +40446,7 @@ will have one of the following response codes: This is because #GtkFileChooserDialog must intercept responses and switch to folders if appropriate, rather than letting the -dialog terminate — the implementation uses these known +dialog terminate — the implementation uses these known response codes to know which responses can be blocked if appropriate. @@ -56485,59 +40457,33 @@ when you use #GtkFileChooserDialog to ensure proper operation. - - Creates a new #GtkFileChooserDialog. This function is analogous to + + Creates a new #GtkFileChooserDialog. This function is analogous to gtk_dialog_new_with_buttons(). - a new #GtkFileChooserDialog + a new #GtkFileChooserDialog - - Title of the dialog, or %NULL + + Title of the dialog, or %NULL - - Transient parent of the dialog, or %NULL + + Transient parent of the dialog, or %NULL - Open or save mode for the dialog + Open or save mode for the dialog - - stock ID or text to go in the first button, or %NULL + + stock ID or text to go in the first button, or %NULL - response ID for the first button, then additional (button, id) pairs, ending with %NULL + response ID for the first button, then additional (button, id) pairs, ending with %NULL @@ -56546,13 +40492,10 @@ gtk_dialog_new_with_buttons(). - + - + @@ -56590,78 +40533,36 @@ gtk_dialog_new_with_buttons(). - + - - These identify the various errors that can occur while calling + + These identify the various errors that can occur while calling #GtkFileChooser functions. - - Indicates that a file does not exist. + + Indicates that a file does not exist. - - Indicates a malformed filename. + + Indicates a malformed filename. - - Indicates a duplicate path (e.g. when + + Indicates a duplicate path (e.g. when adding a bookmark). - - Indicates an incomplete hostname (e.g. "http://foo" without a slash after that). + + Indicates an incomplete hostname (e.g. "http://foo" without a slash after that). - - Registers an error quark for #GtkFileChooser if necessary. + + Registers an error quark for #GtkFileChooser if necessary. - The error quark used for #GtkFileChooser errors. + The error quark used for #GtkFileChooser errors. - - #GtkFileChooserNative is an abstraction of a dialog box suitable -for use with “File/Open” or “File/Save as” commands. By default, this + + #GtkFileChooserNative is an abstraction of a dialog box suitable +for use with “File/Open” or “File/Save as” commands. By default, this just uses a #GtkFileChooserDialog to implement the actual dialog. However, on certain platforms, such as Windows and macOS, the native platform file chooser is used instead. When the application is running in a @@ -56818,119 +40719,71 @@ not supported: * Shortcut folders. - - Creates a new #GtkFileChooserNative. + + Creates a new #GtkFileChooserNative. - a new #GtkFileChooserNative + a new #GtkFileChooserNative - - Title of the native, or %NULL + + Title of the native, or %NULL - - Transient parent of the native, or %NULL + + Transient parent of the native, or %NULL - Open or save mode for the dialog + Open or save mode for the dialog - - text to go in the accept button, or %NULL for the default + + text to go in the accept button, or %NULL for the default - - text to go in the cancel button, or %NULL for the default + + text to go in the cancel button, or %NULL for the default - - Retrieves the custom label text for the accept button. + + Retrieves the custom label text for the accept button. - The custom label, or %NULL for the default. This string + The custom label, or %NULL for the default. This string is owned by GTK+ and should not be modified or freed - a #GtFileChooserNative + a #GtFileChooserNative - - Retrieves the custom label text for the cancel button. + + Retrieves the custom label text for the cancel button. - The custom label, or %NULL for the default. This string + The custom label, or %NULL for the default. This string is owned by GTK+ and should not be modified or freed - a #GtFileChooserNative + a #GtFileChooserNative - - Sets the custom label text for the accept button. + + Sets the custom label text for the accept button. If characters in @label are preceded by an underscore, they are underlined. -If you need a literal underscore character in a label, use “__” (two +If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button. @@ -56940,31 +40793,20 @@ Pressing Alt and that key activates the button. - a #GtFileChooserNative + a #GtFileChooserNative - - custom label or %NULL for the default + + custom label or %NULL for the default - - Sets the custom label text for the cancel button. + + Sets the custom label text for the cancel button. If characters in @label are preceded by an underscore, they are underlined. -If you need a literal underscore character in a label, use “__” (two +If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button. @@ -56974,55 +40816,34 @@ Pressing Alt and that key activates the button. - a #GtFileChooserNative + a #GtFileChooserNative - - custom label or %NULL for the default + + custom label or %NULL for the default - The text used for the label on the accept button in the dialog, or + The text used for the label on the accept button in the dialog, or %NULL to use the default text. - The text used for the label on the cancel button in the dialog, or + The text used for the label on the cancel button in the dialog, or %NULL to use the default text. - + - - #GtkFileChooserWidget is a widget for choosing files. + + #GtkFileChooserWidget is a widget for choosing files. It exposes the #GtkFileChooser interface, and you should use the methods of this interface to interact with the widget. @@ -57035,26 +40856,18 @@ GtkFileChooserWidget has a single CSS node with name filechooser. - - Creates a new #GtkFileChooserWidget. This is a file chooser widget that can + + Creates a new #GtkFileChooserWidget. This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by #GtkFileChooserDialog. - a new #GtkFileChooserWidget + a new #GtkFileChooserWidget - Open or save mode for the widget + Open or save mode for the widget @@ -57069,13 +40882,10 @@ be embedded in custom windows, and it is the same widget that is used by - + - The ::desktop-folder signal is a [keybinding signal][GtkBindingSignal] + The ::desktop-folder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser show the user's Desktop @@ -57087,9 +40897,7 @@ The default binding for this signal is `Alt + D`. - The ::down-folder signal is a [keybinding signal][GtkBindingSignal] + The ::down-folder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser go to a child of the current folder @@ -57104,9 +40912,7 @@ The default binding for this signal is `Alt + Down`. - The ::home-folder signal is a [keybinding signal][GtkBindingSignal] + The ::home-folder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser show the user's home @@ -57118,9 +40924,7 @@ The default binding for this signal is `Alt + Home`. - The ::location-popup signal is a [keybinding signal][GtkBindingSignal] + The ::location-popup signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser show a "Location" prompt which @@ -57136,17 +40940,13 @@ itself for access to home directories. - a string that gets put in the text entry for the file name + a string that gets put in the text entry for the file name - The ::location-popup-on-paste signal is a [keybinding signal][GtkBindingSignal] + The ::location-popup-on-paste signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser show a "Location" prompt when the user @@ -57158,9 +40958,7 @@ The default binding for this signal is `Control + V`. - The ::location-toggle-popup signal is a [keybinding signal][GtkBindingSignal] + The ::location-toggle-popup signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to toggle the visibility of a "Location" prompt which the user @@ -57172,9 +40970,7 @@ The default binding for this signal is `Control + L`. - The ::places-shortcut signal is a [keybinding signal][GtkBindingSignal] + The ::places-shortcut signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to move the focus to the places sidebar. @@ -57185,9 +40981,7 @@ The default binding for this signal is `Alt + P`. - The ::quick-bookmark signal is a [keybinding signal][GtkBindingSignal] + The ::quick-bookmark signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser switch to the bookmark specified @@ -57204,17 +40998,13 @@ bookmark at index 10. - the number of the bookmark to switch to + the number of the bookmark to switch to - The ::recent-shortcut signal is a [keybinding signal][GtkBindingSignal] + The ::recent-shortcut signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser show the Recent location. @@ -57225,9 +41015,7 @@ The default binding for this signal is `Alt + R`. - The ::search-shortcut signal is a [keybinding signal][GtkBindingSignal] + The ::search-shortcut signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser show the search entry. @@ -57238,9 +41026,7 @@ The default binding for this signal is `Alt + S`. - The ::show-hidden signal is a [keybinding signal][GtkBindingSignal] + The ::show-hidden signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser display hidden files. @@ -57251,9 +41037,7 @@ The default binding for this signal is `Control + H`. - The ::up-folder signal is a [keybinding signal][GtkBindingSignal] + The ::up-folder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. This is used to make the file chooser go to the parent of the current folder @@ -57265,14 +41049,30 @@ The default binding for this signal is `Alt + Up`. - + + + + + + + + + + + + + + + + + + + + + - The parent class. + The parent class. @@ -57308,20 +41108,11 @@ The default binding for this signal is `Alt + Up`. - + - - A GtkFileFilter can be used to restrict the files being shown in a + + A GtkFileFilter can be used to restrict the files being shown in a #GtkFileChooser. Files can be filtered based on their name (with gtk_file_filter_add_pattern()), on their mime type (with gtk_file_filter_add_mime_type()), or by a custom filter function @@ -57361,10 +41152,8 @@ rules: ]| - Creates a new #GtkFileFilter with no rules added to it. -Such a filter doesn’t accept any files, so is not + Creates a new #GtkFileFilter with no rules added to it. +Such a filter doesn’t accept any files, so is not particularly useful until you add rules with gtk_file_filter_add_mime_type(), gtk_file_filter_add_pattern(), or gtk_file_filter_add_custom(). To create a filter @@ -57375,147 +41164,96 @@ gtk_file_filter_add_pattern (filter, "*"); ]| - a new #GtkFileFilter + a new #GtkFileFilter - - Deserialize a file filter from an a{sv} variant in + + Deserialize a file filter from an a{sv} variant in the format produced by gtk_file_filter_to_gvariant(). - a new #GtkFileFilter object + a new #GtkFileFilter object - an a{sv} #GVariant + an a{sv} #GVariant - - Adds rule to a filter that allows files based on a custom callback + + Adds rule to a filter that allows files based on a custom callback function. The bitfield @needed which is passed in provides information about what sorts of information that the filter function needs; this allows GTK+ to avoid retrieving expensive information when -it isn’t needed by the filter. +it isn’t needed by the filter. - a #GtkFileFilter + a #GtkFileFilter - bitfield of flags indicating the information that the custom + bitfield of flags indicating the information that the custom filter function needs. - - callback function; if the function returns %TRUE, then + + callback function; if the function returns %TRUE, then the file will be displayed. - - data to pass to @func + + data to pass to @func - function to call to free @data when it is no longer needed. + function to call to free @data when it is no longer needed. - - Adds a rule allowing a given mime type to @filter. + + Adds a rule allowing a given mime type to @filter. - A #GtkFileFilter + A #GtkFileFilter - name of a MIME type + name of a MIME type - - Adds a rule allowing a shell style glob to a filter. + + Adds a rule allowing a shell style glob to a filter. - a #GtkFileFilter + a #GtkFileFilter - a shell style glob + a shell style glob - - Adds a rule allowing image files in the formats supported + + Adds a rule allowing image files in the formats supported by GdkPixbuf. @@ -57523,19 +41261,13 @@ by GdkPixbuf. - a #GtkFileFilter + a #GtkFileFilter - - Tests whether a file should be displayed according to @filter. + + Tests whether a file should be displayed according to @filter. The #GtkFileFilterInfo @filter_info should include the fields returned from gtk_file_filter_get_needed(). @@ -57544,57 +41276,39 @@ is intended principally for use in the implementation of #GtkFileChooser. - %TRUE if the file should be displayed + %TRUE if the file should be displayed - a #GtkFileFilter + a #GtkFileFilter - a #GtkFileFilterInfo containing information + a #GtkFileFilterInfo containing information about a file. - - Gets the human-readable name for the filter. See gtk_file_filter_set_name(). + + Gets the human-readable name for the filter. See gtk_file_filter_set_name(). - The human-readable name of the filter, + The human-readable name of the filter, or %NULL. This value is owned by GTK+ and must not be modified or freed. - a #GtkFileFilter + a #GtkFileFilter - - Gets the fields that need to be filled in for the #GtkFileFilterInfo + + Gets the fields that need to be filled in for the #GtkFileFilterInfo passed to gtk_file_filter_filter() This function will not typically be used by applications; it @@ -57602,27 +41316,19 @@ is intended principally for use in the implementation of #GtkFileChooser. - bitfield of flags indicating needed fields when + bitfield of flags indicating needed fields when calling gtk_file_filter_filter() - a #GtkFileFilter + a #GtkFileFilter - - Sets the human-readable name of the filter; this is the string + + Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters. @@ -57631,169 +41337,97 @@ there is a selectable list of filters. - a #GtkFileFilter + a #GtkFileFilter - - the human-readable-name for the filter, or %NULL + + the human-readable-name for the filter, or %NULL to remove any existing name. - - Serialize a file filter to an a{sv} variant. + + Serialize a file filter to an a{sv} variant. - a new, floating, #GVariant + a new, floating, #GVariant - a #GtkFileFilter + a #GtkFileFilter - - These flags indicate what parts of a #GtkFileFilterInfo struct + + These flags indicate what parts of a #GtkFileFilterInfo struct are filled or need to be filled. - - the filename of the file being tested + + the filename of the file being tested - - the URI for the file being tested + + the URI for the file being tested - - the string that will be used to + + the string that will be used to display the file in the file chooser - - the mime type of the file + + the mime type of the file - The type of function that is used with custom filters, see + The type of function that is used with custom filters, see gtk_file_filter_add_custom(). - %TRUE if the file should be displayed + %TRUE if the file should be displayed - a #GtkFileFilterInfo that is filled according + a #GtkFileFilterInfo that is filled according to the @needed flags passed to gtk_file_filter_add_custom() - - user data passed to gtk_file_filter_add_custom() + + user data passed to gtk_file_filter_add_custom() - A #GtkFileFilterInfo-struct is used to pass information about the + A #GtkFileFilterInfo-struct is used to pass information about the tested file to gtk_file_filter_filter(). - Flags indicating which of the following fields need + Flags indicating which of the following fields need are filled - the filename of the file being tested + the filename of the file being tested - the URI for the file being tested + the URI for the file being tested - the string that will be used to display the file + the string that will be used to display the file in the file chooser - the mime type of the file + the mime type of the file - - The #GtkFixed widget is a container which can place child widgets + + The #GtkFixed widget is a container which can place child widgets at fixed positions and with fixed sizes, given in pixels. #GtkFixed performs no automatic layout management. @@ -57818,7 +41452,7 @@ In addition, #GtkFixed does not pay attention to text direction and thus may produce unwanted results if your app is run under right-to-left languages such as Hebrew or Arabic. That is: normally GTK+ will order containers appropriately for the text direction, e.g. to put labels to the right of the -thing they label when using an RTL language, but it can’t do that with +thing they label when using an RTL language, but it can’t do that with #GtkFixed. So if you need to reorder widgets depending on the text direction, you would need to manually detect it and adjust child positions accordingly. @@ -57837,83 +41471,59 @@ of child widgets and additionally adds custom drawing and scrollability. - Creates a new #GtkFixed. + Creates a new #GtkFixed. - a new #GtkFixed. + a new #GtkFixed. - Moves a child of a #GtkFixed container to the given position. + Moves a child of a #GtkFixed container to the given position. - a #GtkFixed. + a #GtkFixed. - the child widget. + the child widget. - the horizontal position to move the widget to. + the horizontal position to move the widget to. - the vertical position to move the widget to. + the vertical position to move the widget to. - Adds a widget to a #GtkFixed container at the given position. + Adds a widget to a #GtkFixed container at the given position. - a #GtkFixed. + a #GtkFixed. - the widget to add. + the widget to add. - the horizontal position to place the widget at. + the horizontal position to place the widget at. - the vertical position to place the widget at. + the vertical position to place the widget at. @@ -57937,9 +41547,7 @@ of child widgets and additionally adds custom drawing and scrollability. - + @@ -57980,16 +41588,8 @@ of child widgets and additionally adds custom drawing and scrollability. - - A GtkFlowBox positions child widgets in sequence according to its + + A GtkFlowBox positions child widgets in sequence according to its orientation. For instance, with the horizontal orientation, the widgets will be @@ -58021,12 +41621,12 @@ GtkFlowBox was added in GTK+ 3.12. |[<!-- language="plain" --> flowbox -├── flowboxchild -│ ╰── <child> -├── flowboxchild -│ ╰── <child> -┊ -╰── [rubberband] +├── flowboxchild +│ ╰── <child> +├── flowboxchild +│ ╰── <child> +┊ +╰── [rubberband] ]| GtkFlowBox uses a single CSS node with name flowbox. GtkFlowBoxChild @@ -58037,14 +41637,10 @@ For rubberband selection, a subnode with name rubberband is used. - Creates a GtkFlowBox. + Creates a GtkFlowBox. - a new #GtkFlowBox container + a new #GtkFlowBox container @@ -58091,9 +41687,7 @@ For rubberband selection, a subnode with name rubberband is used. - Select all children of @box, if the selection + Select all children of @box, if the selection mode allows it. @@ -58101,9 +41695,7 @@ mode allows it. - a #GtkFlowBox + a #GtkFlowBox @@ -58130,12 +41722,8 @@ mode allows it. - - Unselect all children of @box, if the selection + + Unselect all children of @box, if the selection mode allows it. @@ -58143,19 +41731,13 @@ mode allows it. - a #GtkFlowBox + a #GtkFlowBox - - Binds @model to @box. + + Binds @model to @box. If @box was already bound to a model, that previous binding is destroyed. @@ -58177,261 +41759,162 @@ should be implemented by the model. - a #GtkFlowBox + a #GtkFlowBox - - the #GListModel to be bound to @box + + the #GListModel to be bound to @box - - a function that creates widgets for items - + + a function that creates widgets for items + - - user data passed to @create_widget_func + + user data passed to @create_widget_func - - function for freeing @user_data + + function for freeing @user_data - - Returns whether children activate on single clicks. + + Returns whether children activate on single clicks. - %TRUE if children are activated on single click, + %TRUE if children are activated on single click, %FALSE otherwise - a #GtkFlowBox + a #GtkFlowBox - - Gets the nth child in the @box. + + Gets the nth child in the @box. - the child widget, which will + the child widget, which will always be a #GtkFlowBoxChild or %NULL in case no child widget with the given index exists. - a #GtkFlowBox + a #GtkFlowBox - the position of the child + the position of the child - - Gets the child in the (@x, @y) position. + + Gets the child in the (@x, @y) position. - the child widget, which will + the child widget, which will always be a #GtkFlowBoxChild or %NULL in case no child widget exists for the given x and y coordinates. - a #GtkFlowBox + a #GtkFlowBox - the x coordinate of the child + the x coordinate of the child - the y coordinate of the child + the y coordinate of the child - - Gets the horizontal spacing. + + Gets the horizontal spacing. - the horizontal spacing + the horizontal spacing - a #GtkFlowBox + a #GtkFlowBox - - Returns whether the box is homogeneous (all children are the + + Returns whether the box is homogeneous (all children are the same size). See gtk_box_set_homogeneous(). - %TRUE if the box is homogeneous. + %TRUE if the box is homogeneous. - a #GtkFlowBox + a #GtkFlowBox - - Gets the maximum number of children per line. + + Gets the maximum number of children per line. - the maximum number of children per line + the maximum number of children per line - a #GtkFlowBox + a #GtkFlowBox - - Gets the minimum number of children per line. + + Gets the minimum number of children per line. - the minimum number of children per line + the minimum number of children per line - a #GtkFlowBox + a #GtkFlowBox - - Gets the vertical spacing. + + Gets the vertical spacing. - the vertical spacing + the vertical spacing - a #GtkFlowBox + a #GtkFlowBox - - Creates a list of all selected children. + + Creates a list of all selected children. - + A #GList containing the #GtkWidget for each selected child. Free with g_list_free() when done. @@ -58440,39 +41923,27 @@ same size). See gtk_box_set_homogeneous(). - a #GtkFlowBox + a #GtkFlowBox - - Gets the selection mode of @box. + + Gets the selection mode of @box. - the #GtkSelectionMode + the #GtkSelectionMode - a #GtkFlowBox + a #GtkFlowBox - Inserts the @widget into @box at @position. + Inserts the @widget into @box at @position. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect @@ -58486,31 +41957,21 @@ in the @box, then the @widget will be appended to the end. - a #GtkFlowBox + a #GtkFlowBox - the #GtkWidget to add + the #GtkWidget to add - the position to insert @child in + the position to insert @child in - - Updates the filtering for all children. + + Updates the filtering for all children. Call this function when the result of the filter function on the @box is changed due ot an external @@ -58523,19 +41984,13 @@ term, and the entry with the string has changed. - a #GtkFlowBox + a #GtkFlowBox - - Updates the sorting for all children. + + Updates the sorting for all children. Call this when the result of the sort function on @box is changed due to an external factor. @@ -58545,19 +42000,13 @@ Call this when the result of the sort function on - a #GtkFlowBox + a #GtkFlowBox - - Select all children of @box, if the selection + + Select all children of @box, if the selection mode allows it. @@ -58565,19 +42014,13 @@ mode allows it. - a #GtkFlowBox + a #GtkFlowBox - - Selects a single child of @box, if the selection + + Selects a single child of @box, if the selection mode allows it. @@ -58585,25 +42028,17 @@ mode allows it. - a #GtkFlowBox + a #GtkFlowBox - a child of @box + a child of @box - - Calls a function for each selected child. + + Calls a function for each selected child. Note that the selection cannot be modified from within this function. @@ -58613,37 +42048,21 @@ this function. - a #GtkFlowBox + a #GtkFlowBox - - the function to call for each selected child + + the function to call for each selected child - - user data to pass to the function + + user data to pass to the function - - If @single is %TRUE, children will be activated when you click + + If @single is %TRUE, children will be activated when you click on them, otherwise you need to double-click. @@ -58651,25 +42070,17 @@ on them, otherwise you need to double-click. - a #GtkFlowBox + a #GtkFlowBox - %TRUE to emit child-activated on a single click + %TRUE to emit child-activated on a single click - - Sets the horizontal space to add between children. + + Sets the horizontal space to add between children. See the #GtkFlowBox:column-spacing property. @@ -58677,25 +42088,17 @@ See the #GtkFlowBox:column-spacing property. - a #GtkFlowBox + a #GtkFlowBox - the spacing to use + the spacing to use - - By setting a filter function on the @box one can decide dynamically + + By setting a filter function on the @box one can decide dynamically which of the children to show. For instance, to implement a search function that only shows the children matching the search terms. @@ -58712,47 +42115,26 @@ Note that using a filter function is incompatible with using a model - a #GtkFlowBox + a #GtkFlowBox - - callback that + + callback that lets you filter which children to show - - user data passed to @filter_func + + user data passed to @filter_func - destroy notifier for @user_data + destroy notifier for @user_data - - Hooks up an adjustment to focus handling in @box. + + Hooks up an adjustment to focus handling in @box. The adjustment is also used for autoscrolling during rubberband selection. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment, and @@ -58768,26 +42150,18 @@ of the box. - a #GtkFlowBox + a #GtkFlowBox - an adjustment which should be adjusted + an adjustment which should be adjusted when the focus is moved among the descendents of @container - - Sets the #GtkFlowBox:homogeneous property of @box, controlling + + Sets the #GtkFlowBox:homogeneous property of @box, controlling whether or not all children of @box are given equal space in the box. @@ -58796,27 +42170,19 @@ in the box. - a #GtkFlowBox + a #GtkFlowBox - %TRUE to create equal allotments, + %TRUE to create equal allotments, %FALSE for variable allotments - - Sets the maximum number of children to request and -allocate space for in @box’s orientation. + + Sets the maximum number of children to request and +allocate space for in @box’s orientation. Setting the maximum number of children per line limits the overall natural size request to be no more @@ -58827,51 +42193,35 @@ than @n_children children long in the given orientation. - a #GtkFlowBox + a #GtkFlowBox - the maximum number of children per line + the maximum number of children per line - - Sets the minimum number of children to line up -in @box’s orientation before flowing. + + Sets the minimum number of children to line up +in @box’s orientation before flowing. - a #GtkFlowBox + a #GtkFlowBox - the minimum number of children per line + the minimum number of children per line - - Sets the vertical space to add between children. + + Sets the vertical space to add between children. See the #GtkFlowBox:row-spacing property. @@ -58879,25 +42229,17 @@ See the #GtkFlowBox:row-spacing property. - a #GtkFlowBox + a #GtkFlowBox - the spacing to use + the spacing to use - - Sets how selection works in @box. + + Sets how selection works in @box. See #GtkSelectionMode for details. @@ -58905,25 +42247,17 @@ See #GtkSelectionMode for details. - a #GtkFlowBox + a #GtkFlowBox - the new selection mode + the new selection mode - - By setting a sort function on the @box, one can dynamically + + By setting a sort function on the @box, one can dynamically reorder the children of the box, based on the contents of the children. @@ -58940,46 +42274,25 @@ Note that using a sort function is incompatible with using a model - a #GtkFlowBox + a #GtkFlowBox - - the sort function + + the sort function - - user data passed to @sort_func + + user data passed to @sort_func - destroy notifier for @user_data + destroy notifier for @user_data - - Hooks up an adjustment to focus handling in @box. + + Hooks up an adjustment to focus handling in @box. The adjustment is also used for autoscrolling during rubberband selection. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment, and @@ -58995,26 +42308,18 @@ of the box. - a #GtkFlowBox + a #GtkFlowBox - an adjustment which should be adjusted + an adjustment which should be adjusted when the focus is moved among the descendents of @container - - Unselect all children of @box, if the selection + + Unselect all children of @box, if the selection mode allows it. @@ -59022,19 +42327,13 @@ mode allows it. - a #GtkFlowBox + a #GtkFlowBox - - Unselects a single child of @box, if the selection + + Unselects a single child of @box, if the selection mode allows it. @@ -59042,56 +42341,36 @@ mode allows it. - a #GtkFlowBox + a #GtkFlowBox - a child of @box + a child of @box - - Determines whether children can be activated with a single + + Determines whether children can be activated with a single click, or require a double-click. - The amount of horizontal space between two children. + The amount of horizontal space between two children. - Determines whether all children should be allocated the + Determines whether all children should be allocated the same size. - - The maximum amount of children to request space for consecutively + + The maximum amount of children to request space for consecutively in the given orientation. - - The minimum number of children to allocate consecutively + + The minimum number of children to allocate consecutively in the given orientation. Setting the minimum children per line ensures @@ -59100,24 +42379,18 @@ for the overall minimum width of the box. - The amount of vertical space between two children. + The amount of vertical space between two children. - The selection mode used by the flow box. + The selection mode used by the flow box. - The ::activate-cursor-child signal is a + The ::activate-cursor-child signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the @box. @@ -59125,26 +42398,20 @@ which gets emitted when the user activates the @box. - The ::child-activated signal is emitted when a child has been + The ::child-activated signal is emitted when a child has been activated by the user. - the child that is activated + the child that is activated - The ::move-cursor signal is a + The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. @@ -59160,31 +42427,23 @@ There are too many key combinations to list them all here. - Home/End keys move to the ends of the box - PageUp/PageDown keys move vertically by pages - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the granularity fo the move, as a #GtkMovementStep + the granularity fo the move, as a #GtkMovementStep - the number of @step units to move + the number of @step units to move - The ::select-all signal is a + The ::select-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select all children of the box, if the selection mode permits it. @@ -59195,9 +42454,7 @@ The default bindings for this signal is Ctrl-a. - The ::selected-children-changed signal is emitted when the + The ::selected-children-changed signal is emitted when the set of selected children changes. Use gtk_flow_box_selected_foreach() or @@ -59208,9 +42465,7 @@ selected children. - The ::toggle-cursor-child signal is a + The ::toggle-cursor-child signal is a [keybinding signal][GtkBindingSignal] which toggles the selection of the child that has the focus. @@ -59220,9 +42475,7 @@ The default binding for this signal is Ctrl-Space. - The ::unselect-all signal is a + The ::unselect-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to unselect all children of the box, if the selection mode permits it. @@ -59233,13 +42486,7 @@ The default bindings for this signal is Ctrl-Shift-a. - + @@ -59247,46 +42494,28 @@ The default bindings for this signal is Ctrl-Shift-a. - + - + - + - + - + - - Creates a new #GtkFlowBoxChild, to be used as a child + + Creates a new #GtkFlowBoxChild, to be used as a child of a #GtkFlowBox. - a new #GtkFlowBoxChild + a new #GtkFlowBoxChild @@ -59301,12 +42530,8 @@ of a #GtkFlowBox. - - Marks @child as changed, causing any state that depends on this + + Marks @child as changed, causing any state that depends on this to be updated. This affects sorting and filtering. Note that calls to this method must be in sync with the data @@ -59317,7 +42542,7 @@ gtk_flow_box_child_changed() on the first child, the sort function must only read the new data for the first of the two changed children, otherwise the resorting of the children will be wrong. -This generally means that if you don’t fully control the data +This generally means that if you don’t fully control the data model, you have to duplicate the data that affects the sorting and filtering functions into the widgets themselves. Another alternative is to call gtk_flow_box_invalidate_sort() on any @@ -59328,55 +42553,37 @@ model change, but that is more expensive. - a #GtkFlowBoxChild + a #GtkFlowBoxChild - - Gets the current index of the @child in its #GtkFlowBox container. + + Gets the current index of the @child in its #GtkFlowBox container. - the index of the @child, or -1 if the @child is not + the index of the @child, or -1 if the @child is not in a flow box. - a #GtkFlowBoxChild + a #GtkFlowBoxChild - - Returns whether the @child is currently selected in its + + Returns whether the @child is currently selected in its #GtkFlowBox container. - %TRUE if @child is selected + %TRUE if @child is selected - a #GtkFlowBoxChild + a #GtkFlowBoxChild @@ -59385,9 +42592,7 @@ model change, but that is more expensive. - The ::activate signal is emitted when the user activates + The ::activate signal is emitted when the user activates a child widget in a #GtkFlowBox, either by clicking or double-clicking, or by using the Space or Enter key. @@ -59399,33 +42604,20 @@ it can be used by applications for their own purposes. - - + + - - + + - + - + @@ -59460,9 +42652,7 @@ it can be used by applications for their own purposes. - + @@ -59549,9 +42739,7 @@ it can be used by applications for their own purposes. - a #GtkFlowBox + a #GtkFlowBox @@ -59565,9 +42753,7 @@ it can be used by applications for their own purposes. - a #GtkFlowBox + a #GtkFlowBox @@ -59622,79 +42808,47 @@ it can be used by applications for their own purposes. - - Called for flow boxes that are bound to a #GListModel with + + Called for flow boxes that are bound to a #GListModel with gtk_flow_box_bind_model() for each item that gets added to the model. - a #GtkWidget that represents @item + a #GtkWidget that represents @item - the item from the model for which to create a widget for + the item from the model for which to create a widget for - - user data from gtk_flow_box_bind_model() + + user data from gtk_flow_box_bind_model() - - A function that will be called whenrever a child changes + + A function that will be called whenrever a child changes or is added. It lets you control if the child should be visible or not. - %TRUE if the row should be visible, %FALSE otherwise + %TRUE if the row should be visible, %FALSE otherwise - a #GtkFlowBoxChild that may be filtered + a #GtkFlowBoxChild that may be filtered - - user data + + user data - - A function used by gtk_flow_box_selected_foreach(). + + A function used by gtk_flow_box_selected_foreach(). It will be called on every selected child of the @box. @@ -59702,79 +42856,45 @@ It will be called on every selected child of the @box. - a #GtkFlowBox + a #GtkFlowBox - a #GtkFlowBoxChild + a #GtkFlowBoxChild - - user data + + user data - - A function to compare two children to determine which + + A function to compare two children to determine which should come first. - < 0 if @child1 should be before @child2, 0 if + < 0 if @child1 should be before @child2, 0 if the are equal, and > 0 otherwise - the first child + the first child - the second child + the second child - - user data + + user data - - The #GtkFontButton is a button which displays the currently selected + + The #GtkFontButton is a button which displays the currently selected font an allows to open a font chooser dialog to change the font. It is suitable widget for selecting a font in a preference dialog. @@ -59788,35 +42908,23 @@ GtkFontButton has a single CSS node with name button and style class .font. - Creates a new font picker widget. + Creates a new font picker widget. - a new font picker widget. + a new font picker widget. - - Creates a new font picker widget. + + Creates a new font picker widget. - a new font picker widget. + a new font picker widget. - Name of font to display in font chooser dialog + Name of font to display in font chooser dialog @@ -59832,362 +42940,228 @@ GtkFontButton has a single CSS node with name button and style class .font. - - Retrieves the name of the currently selected font. This name includes + + Retrieves the name of the currently selected font. This name includes style and size information as well. If you want to render something with the font, use this string with pango_font_description_from_string() . -If you’re interested in peeking certain values (family name, +If you’re interested in peeking certain values (family name, style, size, weight) just query these properties from the #PangoFontDescription object. Use gtk_font_chooser_get_font() instead - an internal copy of the font name which must not be freed. + an internal copy of the font name which must not be freed. - a #GtkFontButton + a #GtkFontButton - - Returns whether the font size will be shown in the label. + + Returns whether the font size will be shown in the label. - whether the font size will be shown in the label. + whether the font size will be shown in the label. - a #GtkFontButton + a #GtkFontButton - - Returns whether the name of the font style will be shown in the label. + + Returns whether the name of the font style will be shown in the label. - whether the font style will be shown in the label. + whether the font style will be shown in the label. - a #GtkFontButton + a #GtkFontButton - - Retrieves the title of the font chooser dialog. + + Retrieves the title of the font chooser dialog. - an internal copy of the title string which must not be freed. + an internal copy of the title string which must not be freed. - a #GtkFontButton + a #GtkFontButton - - Returns whether the selected font is used in the label. + + Returns whether the selected font is used in the label. - whether the selected font is used in the label. + whether the selected font is used in the label. - a #GtkFontButton + a #GtkFontButton - - Returns whether the selected size is used in the label. + + Returns whether the selected size is used in the label. - whether the selected size is used in the label. + whether the selected size is used in the label. - a #GtkFontButton + a #GtkFontButton - - Sets or updates the currently-displayed font in font picker dialog. + + Sets or updates the currently-displayed font in font picker dialog. Use gtk_font_chooser_set_font() instead - %TRUE + %TRUE - a #GtkFontButton + a #GtkFontButton - Name of font to display in font chooser dialog + Name of font to display in font chooser dialog - - If @show_size is %TRUE, the font size will be displayed along with the name of the selected font. + + If @show_size is %TRUE, the font size will be displayed along with the name of the selected font. - a #GtkFontButton + a #GtkFontButton - %TRUE if font size should be displayed in dialog. + %TRUE if font size should be displayed in dialog. - - If @show_style is %TRUE, the font style will be displayed along with name of the selected font. + + If @show_style is %TRUE, the font style will be displayed along with name of the selected font. - a #GtkFontButton + a #GtkFontButton - %TRUE if font style should be displayed in label. + %TRUE if font style should be displayed in label. - - Sets the title for the font chooser dialog. + + Sets the title for the font chooser dialog. - a #GtkFontButton + a #GtkFontButton - a string containing the font chooser dialog title + a string containing the font chooser dialog title - - If @use_font is %TRUE, the font name will be written using the selected font. + + If @use_font is %TRUE, the font name will be written using the selected font. - a #GtkFontButton + a #GtkFontButton - If %TRUE, font name will be written using font chosen. + If %TRUE, font name will be written using font chosen. - - If @use_size is %TRUE, the font name will be written using the selected size. + + If @use_size is %TRUE, the font name will be written using the selected size. - a #GtkFontButton + a #GtkFontButton - If %TRUE, font name will be written using the selected size. + If %TRUE, font name will be written using the selected size. - - The name of the currently selected font. + + The name of the currently selected font. Use the #GtkFontChooser::font property instead - - If this property is set to %TRUE, the selected font size will be shown + + If this property is set to %TRUE, the selected font size will be shown in the label. For a more WYSIWYG way to show the selected size, see the ::use-size property. - - If this property is set to %TRUE, the name of the selected font style + + If this property is set to %TRUE, the name of the selected font style will be shown in the label. For a more WYSIWYG way to show the selected style, see the ::use-font property. - - The title of the font chooser dialog. + + The title of the font chooser dialog. - - If this property is set to %TRUE, the label will be drawn + + If this property is set to %TRUE, the label will be drawn in the selected font. - - If this property is set to %TRUE, the label will be drawn + + If this property is set to %TRUE, the label will be drawn with the selected font size. @@ -60198,9 +43172,7 @@ with the selected font size. - The ::font-set signal is emitted when the user selects a font. + The ::font-set signal is emitted when the user selects a font. When handling this signal, use gtk_font_chooser_get_font() to find out which font was just selected. @@ -60212,9 +43184,7 @@ as well, use the notify::font signal. - + @@ -60265,20 +43235,11 @@ as well, use the notify::font signal. - + - - #GtkFontChooser is an interface that can be implemented by widgets + + #GtkFontChooser is an interface that can be implemented by widgets displaying the list of fonts. In GTK+, the main objects that implement this interface are #GtkFontChooserWidget, #GtkFontChooserDialog and #GtkFontButton. The GtkFontChooser interface @@ -60298,112 +43259,76 @@ has been introducted in GTK+ 3.2. - - Gets the #PangoFontFace representing the selected font group + + Gets the #PangoFontFace representing the selected font group details (i.e. family, slant, weight, width, etc). If the selected font is not installed, returns %NULL. - A #PangoFontFace representing the + A #PangoFontFace representing the selected font group details, or %NULL. The returned object is owned by @fontchooser and must not be modified or freed. - a #GtkFontChooser + a #GtkFontChooser - - Gets the #PangoFontFamily representing the selected font family. + + Gets the #PangoFontFamily representing the selected font family. Font families are a collection of font faces. If the selected font is not installed, returns %NULL. - A #PangoFontFamily representing the + A #PangoFontFamily representing the selected font family, or %NULL. The returned object is owned by @fontchooser and must not be modified or freed. - a #GtkFontChooser + a #GtkFontChooser - - Gets the custom font map of this font chooser widget, + + Gets the custom font map of this font chooser widget, or %NULL if it does not have one. - a #PangoFontMap, or %NULL + a #PangoFontMap, or %NULL - a #GtkFontChooser + a #GtkFontChooser - - The selected font size. + + The selected font size. - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a #GtkFontChooser + a #GtkFontChooser - - Adds a filter function that decides which fonts to display + + Adds a filter function that decides which fonts to display in the font chooser. @@ -60411,47 +43336,25 @@ in the font chooser. - a #GtkFontChooser + a #GtkFontChooser - - a #GtkFontFilterFunc, or %NULL + + a #GtkFontFilterFunc, or %NULL - - data to pass to @filter + + data to pass to @filter - function to call to free @data when it is no longer needed + function to call to free @data when it is no longer needed - - Sets a custom font map to use for this font chooser widget. + + Sets a custom font map to use for this font chooser widget. A custom font map can be used to present application-specific fonts instead of or in addition to the normal system fonts. @@ -60481,305 +43384,206 @@ pango_context_set_font_map (context, fontmap); - a #GtkFontChooser + a #GtkFontChooser - - a #PangoFontMap + + a #PangoFontMap - - Gets the currently-selected font name. + + Gets the currently-selected font name. Note that this can be a different string than what you set with gtk_font_chooser_set_font(), as the font chooser widget may normalize font names and thus return a string with a different -structure. For example, “Helvetica Italic Bold 12” could be -normalized to “Helvetica Bold Italic 12”. +structure. For example, “Helvetica Italic Bold 12” could be +normalized to “Helvetica Bold Italic 12”. Use pango_font_description_equal() if you want to compare two font descriptions. - A string with the name + A string with the name of the current font, or %NULL if no font is selected. You must free this string with g_free(). - a #GtkFontChooser + a #GtkFontChooser - - Gets the currently-selected font. + + Gets the currently-selected font. Note that this can be a different string than what you set with gtk_font_chooser_set_font(), as the font chooser widget may normalize font names and thus return a string with a different -structure. For example, “Helvetica Italic Bold 12” could be -normalized to “Helvetica Bold Italic 12”. +structure. For example, “Helvetica Italic Bold 12” could be +normalized to “Helvetica Bold Italic 12”. Use pango_font_description_equal() if you want to compare two font descriptions. - A #PangoFontDescription for the + A #PangoFontDescription for the current font, or %NULL if no font is selected. - a #GtkFontChooser + a #GtkFontChooser - - Gets the #PangoFontFace representing the selected font group + + Gets the #PangoFontFace representing the selected font group details (i.e. family, slant, weight, width, etc). If the selected font is not installed, returns %NULL. - A #PangoFontFace representing the + A #PangoFontFace representing the selected font group details, or %NULL. The returned object is owned by @fontchooser and must not be modified or freed. - a #GtkFontChooser + a #GtkFontChooser - - Gets the #PangoFontFamily representing the selected font family. + + Gets the #PangoFontFamily representing the selected font family. Font families are a collection of font faces. If the selected font is not installed, returns %NULL. - A #PangoFontFamily representing the + A #PangoFontFamily representing the selected font family, or %NULL. The returned object is owned by @fontchooser and must not be modified or freed. - a #GtkFontChooser + a #GtkFontChooser - - Gets the currently-selected font features. + + Gets the currently-selected font features. - the currently selected font features + the currently selected font features - a #GtkFontChooser + a #GtkFontChooser - - Gets the custom font map of this font chooser widget, + + Gets the custom font map of this font chooser widget, or %NULL if it does not have one. - a #PangoFontMap, or %NULL + a #PangoFontMap, or %NULL - a #GtkFontChooser + a #GtkFontChooser - - The selected font size. + + The selected font size. - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a #GtkFontChooser + a #GtkFontChooser - - Gets the language that is used for font features. + + Gets the language that is used for font features. - the currently selected language + the currently selected language - a #GtkFontChooser + a #GtkFontChooser - - Returns the current level of granularity for selecting fonts. + + Returns the current level of granularity for selecting fonts. - the current granularity level + the current granularity level - a #GtkFontChooser + a #GtkFontChooser - - Gets the text displayed in the preview area. + + Gets the text displayed in the preview area. - the text displayed in the + the text displayed in the preview area - a #GtkFontChooser + a #GtkFontChooser - - Returns whether the preview entry is shown or not. + + Returns whether the preview entry is shown or not. - %TRUE if the preview entry is shown + %TRUE if the preview entry is shown or %FALSE if it is hidden. - a #GtkFontChooser + a #GtkFontChooser - - Adds a filter function that decides which fonts to display + + Adds a filter function that decides which fonts to display in the font chooser. @@ -60787,97 +43591,59 @@ in the font chooser. - a #GtkFontChooser + a #GtkFontChooser - - a #GtkFontFilterFunc, or %NULL + + a #GtkFontFilterFunc, or %NULL - - data to pass to @filter + + data to pass to @filter - function to call to free @data when it is no longer needed + function to call to free @data when it is no longer needed - - Sets the currently-selected font. + + Sets the currently-selected font. - a #GtkFontChooser + a #GtkFontChooser - a font name like “Helvetica 12” or “Times Bold 18” + a font name like “Helvetica 12” or “Times Bold 18” - - Sets the currently-selected font from @font_desc. + + Sets the currently-selected font from @font_desc. - a #GtkFontChooser + a #GtkFontChooser - a #PangoFontDescription - + a #PangoFontDescription + - - Sets a custom font map to use for this font chooser widget. + + Sets a custom font map to use for this font chooser widget. A custom font map can be used to present application-specific fonts instead of or in addition to the normal system fonts. @@ -60907,78 +43673,51 @@ pango_context_set_font_map (context, fontmap); - a #GtkFontChooser + a #GtkFontChooser - - a #PangoFontMap + + a #PangoFontMap - - Sets the language to use for font features. + + Sets the language to use for font features. - a #GtkFontChooser + a #GtkFontChooser - a language + a language - - Sets the desired level of granularity for selecting fonts. + + Sets the desired level of granularity for selecting fonts. - a #GtkFontChooser + a #GtkFontChooser - the desired level of granularity + the desired level of granularity - - Sets the text displayed in the preview area. + + Sets the text displayed in the preview area. The @text is used to show how the selected font looks. @@ -60986,103 +43725,65 @@ The @text is used to show how the selected font looks. - a #GtkFontChooser + a #GtkFontChooser - the text to display in the preview area + the text to display in the preview area - - Shows or hides the editable preview entry. + + Shows or hides the editable preview entry. - a #GtkFontChooser + a #GtkFontChooser - whether to show the editable preview entry or not + whether to show the editable preview entry or not - The font description as a string, e.g. "Sans Italic 12". + The font description as a string, e.g. "Sans Italic 12". - The font description as a #PangoFontDescription. + The font description as a #PangoFontDescription. - - The selected font features, in a format that is compatible with + + The selected font features, in a format that is compatible with CSS and with Pango attributes. - - The language for which the #GtkFontChooser:font-features were + + The language for which the #GtkFontChooser:font-features were selected, in a format that is compatible with CSS and with Pango attributes. - - The level of granularity to offer for selecting fonts. + + The level of granularity to offer for selecting fonts. - The string with which to preview the font. + The string with which to preview the font. - - Whether to show an entry to change the preview text. + + Whether to show an entry to change the preview text. - Emitted when a font is activated. + Emitted when a font is activated. This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, Return or Enter. @@ -61091,66 +43792,39 @@ Space, Shift+Space, Return or Enter. - the font name + the font name - - The #GtkFontChooserDialog widget is a dialog for selecting a font. + + The #GtkFontChooserDialog widget is a dialog for selecting a font. It implements the #GtkFontChooser interface. # GtkFontChooserDialog as GtkBuildable The GtkFontChooserDialog implementation of the #GtkBuildable -interface exposes the buttons with the names “select_button” -and “cancel_button”. +interface exposes the buttons with the names “select_button” +and “cancel_button”. - - Creates a new #GtkFontChooserDialog. + + Creates a new #GtkFontChooserDialog. - a new #GtkFontChooserDialog + a new #GtkFontChooserDialog - - Title of the dialog, or %NULL + + Title of the dialog, or %NULL - - Transient parent of the dialog, or %NULL + + Transient parent of the dialog, or %NULL @@ -61159,18 +43833,13 @@ and “cancel_button”. - + - + - The parent class. + The parent class. @@ -61206,14 +43875,10 @@ and “cancel_button”. - + - + @@ -61222,18 +43887,14 @@ and “cancel_button”. - A #PangoFontFamily representing the + A #PangoFontFamily representing the selected font family, or %NULL. The returned object is owned by @fontchooser and must not be modified or freed. - a #GtkFontChooser + a #GtkFontChooser @@ -61243,18 +43904,14 @@ and “cancel_button”. - A #PangoFontFace representing the + A #PangoFontFace representing the selected font group details, or %NULL. The returned object is owned by @fontchooser and must not be modified or freed. - a #GtkFontChooser + a #GtkFontChooser @@ -61264,17 +43921,13 @@ and “cancel_button”. - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a #GtkFontChooser + a #GtkFontChooser @@ -61288,37 +43941,19 @@ and “cancel_button”. - a #GtkFontChooser + a #GtkFontChooser - - a #GtkFontFilterFunc, or %NULL + + a #GtkFontFilterFunc, or %NULL - - data to pass to @filter + + data to pass to @filter - function to call to free @data when it is no longer needed + function to call to free @data when it is no longer needed @@ -61348,18 +43983,11 @@ and “cancel_button”. - a #GtkFontChooser + a #GtkFontChooser - - a #PangoFontMap + + a #PangoFontMap @@ -61369,16 +43997,12 @@ and “cancel_button”. - a #PangoFontMap, or %NULL + a #PangoFontMap, or %NULL - a #GtkFontChooser + a #GtkFontChooser @@ -61390,66 +44014,29 @@ and “cancel_button”. - - This enumeration specifies the granularity of font selection + + This enumeration specifies the granularity of font selection that is desired in a font chooser. This enumeration may be extended in the future; applications should ignore unknown values. - - Allow selecting a font family + + Allow selecting a font family - - Allow selecting a specific font face + + Allow selecting a specific font face - - Allow selecting a specific font size + + Allow selecting a specific font size - + - - Allow selecting specific OpenType font features + + Allow selecting specific OpenType font features - - The #GtkFontChooserWidget widget lists the available fonts, + + The #GtkFontChooserWidget widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the #GtkFontChooserDialog widget to provide a dialog box for selecting fonts. @@ -61471,24 +44058,16 @@ GtkFontChooserWidget has a single CSS node with name fontchooser. - - Creates a new #GtkFontChooserWidget. + + Creates a new #GtkFontChooserWidget. - a new #GtkFontChooserWidget + a new #GtkFontChooserWidget - A toggle action that can be used to switch to the tweak page + A toggle action that can be used to switch to the tweak page of the font chooser widget, which lets the user tweak the OpenType features and variation axes of the selected font. @@ -61500,18 +44079,13 @@ the selected font has any features or axes. - + - + - The parent class. + The parent class. @@ -61579,143 +44153,86 @@ the selected font has any features or axes. - + - The type of function that is used for deciding what fonts get + The type of function that is used for deciding what fonts get shown in a #GtkFontChooser. See gtk_font_chooser_set_filter_func(). - %TRUE if the font should be displayed + %TRUE if the font should be displayed - a #PangoFontFamily + a #PangoFontFamily - a #PangoFontFace belonging to @family + a #PangoFontFace belonging to @family - - user data passed to gtk_font_chooser_set_filter_func() + + user data passed to gtk_font_chooser_set_filter_func() - + - - Creates a new #GtkFontSelection. + + Creates a new #GtkFontSelection. Use #GtkFontChooserWidget instead - a new #GtkFontSelection + a new #GtkFontSelection - - Gets the #PangoFontFace representing the selected font group + + Gets the #PangoFontFace representing the selected font group details (i.e. family, slant, weight, width, etc). Use #GtkFontChooser - A #PangoFontFace representing the + A #PangoFontFace representing the selected font group details. The returned object is owned by @fontsel and must not be modified or freed. - a #GtkFontSelection + a #GtkFontSelection - - This returns the #GtkTreeView which lists all styles available for -the selected font. For example, “Regular”, “Bold”, etc. + + This returns the #GtkTreeView which lists all styles available for +the selected font. For example, “Regular”, “Bold”, etc. Use #GtkFontChooser - A #GtkWidget that is part of @fontsel + A #GtkWidget that is part of @fontsel - a #GtkFontSelection + a #GtkFontSelection - - Gets the #PangoFontFamily representing the selected font family. + + Gets the #PangoFontFamily representing the selected font family. Use #GtkFontChooser - A #PangoFontFamily representing the + A #PangoFontFamily representing the selected font family. Font families are a collection of font faces. The returned object is owned by @fontsel and must not be modified or freed. @@ -61723,206 +44240,131 @@ the selected font. For example, “Regular”, “Bold”, etc. - a #GtkFontSelection + a #GtkFontSelection - - This returns the #GtkTreeView that lists font families, for -example, “Sans”, “Serif”, etc. + + This returns the #GtkTreeView that lists font families, for +example, “Sans”, “Serif”, etc. Use #GtkFontChooser - A #GtkWidget that is part of @fontsel + A #GtkWidget that is part of @fontsel - a #GtkFontSelection + a #GtkFontSelection - - Gets the currently-selected font name. + + Gets the currently-selected font name. Note that this can be a different string than what you set with gtk_font_selection_set_font_name(), as the font selection widget may normalize font names and thus return a string with a different structure. -For example, “Helvetica Italic Bold 12” could be normalized to -“Helvetica Bold Italic 12”. Use pango_font_description_equal() +For example, “Helvetica Italic Bold 12” could be normalized to +“Helvetica Bold Italic 12”. Use pango_font_description_equal() if you want to compare two font descriptions. Use #GtkFontChooser - A string with the name of the current font, or %NULL if + A string with the name of the current font, or %NULL if no font is selected. You must free this string with g_free(). - a #GtkFontSelection + a #GtkFontSelection - - This returns the #GtkEntry used to display the font as a preview. + + This returns the #GtkEntry used to display the font as a preview. Use #GtkFontChooser - A #GtkWidget that is part of @fontsel + A #GtkWidget that is part of @fontsel - a #GtkFontSelection + a #GtkFontSelection - - Gets the text displayed in the preview area. + + Gets the text displayed in the preview area. Use #GtkFontChooser - the text displayed in the preview area. + the text displayed in the preview area. This string is owned by the widget and should not be modified or freed - a #GtkFontSelection + a #GtkFontSelection - - The selected font size. + + The selected font size. Use #GtkFontChooser - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a #GtkFontSelection + a #GtkFontSelection - - This returns the #GtkEntry used to allow the user to edit the font + + This returns the #GtkEntry used to allow the user to edit the font number manually instead of selecting it from the list of font sizes. Use #GtkFontChooser - A #GtkWidget that is part of @fontsel + A #GtkWidget that is part of @fontsel - a #GtkFontSelection + a #GtkFontSelection - - This returns the #GtkTreeView used to list font sizes. + + This returns the #GtkTreeView used to list font sizes. Use #GtkFontChooser - A #GtkWidget that is part of @fontsel + A #GtkWidget that is part of @fontsel - a #GtkFontSelection + a #GtkFontSelection - - Sets the currently-selected font. + + Sets the currently-selected font. Note that the @fontsel needs to know the screen in which it will appear for this to work; this can be guaranteed by simply making sure that the @@ -61930,35 +44372,24 @@ for this to work; this can be guaranteed by simply making sure that the Use #GtkFontChooser - %TRUE if the font could be set successfully; %FALSE if no - such font exists or if the @fontsel doesn’t belong to a particular + %TRUE if the font could be set successfully; %FALSE if no + such font exists or if the @fontsel doesn’t belong to a particular screen yet. - a #GtkFontSelection + a #GtkFontSelection - a font name like “Helvetica 12” or “Times Bold 18” + a font name like “Helvetica 12” or “Times Bold 18” - - Sets the text displayed in the preview area. + + Sets the text displayed in the preview area. The @text is used to show how the selected font looks. Use #GtkFontChooser @@ -61967,15 +44398,11 @@ The @text is used to show how the selected font looks. - a #GtkFontSelection + a #GtkFontSelection - the text to display in the preview area + the text to display in the preview area @@ -61993,9 +44420,7 @@ The @text is used to show how the selected font looks. - + @@ -62033,213 +44458,134 @@ The @text is used to show how the selected font looks. - + - - Creates a new #GtkFontSelectionDialog. + + Creates a new #GtkFontSelectionDialog. Use #GtkFontChooserDialog - a new #GtkFontSelectionDialog + a new #GtkFontSelectionDialog - the title of the dialog window + the title of the dialog window - - Gets the “Cancel” button. + + Gets the “Cancel” button. Use #GtkFontChooserDialog - the #GtkWidget used in the dialog - for the “Cancel” button. + the #GtkWidget used in the dialog + for the “Cancel” button. - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - - Gets the currently-selected font name. + + Gets the currently-selected font name. Note that this can be a different string than what you set with gtk_font_selection_dialog_set_font_name(), as the font selection widget may normalize font names and thus return a string with a different -structure. For example, “Helvetica Italic Bold 12” could be normalized -to “Helvetica Bold Italic 12”. Use pango_font_description_equal() +structure. For example, “Helvetica Italic Bold 12” could be normalized +to “Helvetica Bold Italic 12”. Use pango_font_description_equal() if you want to compare two font descriptions. Use #GtkFontChooserDialog - A string with the name of the current font, or %NULL if no + A string with the name of the current font, or %NULL if no font is selected. You must free this string with g_free(). - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - - Retrieves the #GtkFontSelection widget embedded in the dialog. + + Retrieves the #GtkFontSelection widget embedded in the dialog. Use #GtkFontChooserDialog - the embedded #GtkFontSelection + the embedded #GtkFontSelection - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - - Gets the “OK” button. + + Gets the “OK” button. Use #GtkFontChooserDialog - the #GtkWidget used in the dialog - for the “OK” button. + the #GtkWidget used in the dialog + for the “OK” button. - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - - Gets the text displayed in the preview area. + + Gets the text displayed in the preview area. Use #GtkFontChooserDialog - the text displayed in the preview area. + the text displayed in the preview area. This string is owned by the widget and should not be modified or freed - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - - Sets the currently selected font. + + Sets the currently selected font. Use #GtkFontChooserDialog - %TRUE if the font selected in @fsd is now the + %TRUE if the font selected in @fsd is now the @fontname specified, %FALSE otherwise. - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - a font name like “Helvetica 12” or “Times Bold 18” + a font name like “Helvetica 12” or “Times Bold 18” - - Sets the text displayed in the preview area. + + Sets the text displayed in the preview area. Use #GtkFontChooserDialog @@ -62247,15 +44593,11 @@ if you want to compare two font descriptions. - a #GtkFontSelectionDialog + a #GtkFontSelectionDialog - the text to display in the preview area + the text to display in the preview area @@ -62264,13 +44606,10 @@ if you want to compare two font descriptions. - + - + @@ -62308,26 +44647,14 @@ if you want to compare two font descriptions. - + - + - - The frame widget is a bin that surrounds its child with a decorative + + The frame widget is a bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with gtk_frame_set_label_align(). @@ -62335,8 +44662,8 @@ controlled with gtk_frame_set_label_align(). # GtkFrame as GtkBuildable The GtkFrame implementation of the GtkBuildable interface supports -placing a child in the label position by specifying “label” as the -“type” attribute of a <child> element. A normal content child can +placing a child in the label position by specifying “label” as the +“type” attribute of a <child> element. A normal content child can be specified without specifying a <child> type attribute. An example of a UI definition fragment with GtkFrame: @@ -62355,42 +44682,33 @@ An example of a UI definition fragment with GtkFrame: |[<!-- language="plain" --> frame -├── border[.flat] -├── <label widget> -╰── <child> +├── border[.flat] +├── <label widget> +╰── <child> ]| -GtkFrame has a main CSS node named “frame” and a subnode named “border”. The -“border” node is used to draw the visible border. You can set the appearance -of the border using CSS properties like “border-style” on the “border” node. +GtkFrame has a main CSS node named “frame” and a subnode named “border”. The +“border” node is used to draw the visible border. You can set the appearance +of the border using CSS properties like “border-style” on the “border” node. -The border node can be given the style class “.flat”, which is used by themes +The border node can be given the style class “.flat”, which is used by themes to disable drawing of the border. To do this from code, call -gtk_frame_set_shadow_type() with %GTK_SHADOW_NONE to add the “.flat” class or +gtk_frame_set_shadow_type() with %GTK_SHADOW_NONE to add the “.flat” class or any other shadow type to remove it. - Creates a new #GtkFrame, with optional label @label. + Creates a new #GtkFrame, with optional label @label. If @label is %NULL, the label is omitted. - a new #GtkFrame widget + a new #GtkFrame widget - - the text to use as the label of the frame + + the text to use as the label of the frame @@ -62410,17 +44728,13 @@ If @label is %NULL, the label is omitted. - If the frame’s label widget is a #GtkLabel, returns the + If the frame’s label widget is a #GtkLabel, returns the text in the label widget. (The frame will have a #GtkLabel for the label widget if a non-%NULL argument was passed to gtk_frame_new().) - the text in the label, or %NULL if there + the text in the label, or %NULL if there was no label widget or the lable widget was not a #GtkLabel. This string is owned by GTK+ and must not be modified or freed. @@ -62428,17 +44742,13 @@ to gtk_frame_new().) - a #GtkFrame + a #GtkFrame - Retrieves the X and Y alignment of the frame’s label. See + Retrieves the X and Y alignment of the frame’s label. See gtk_frame_set_label_align(). @@ -62446,85 +44756,54 @@ gtk_frame_set_label_align(). - a #GtkFrame + a #GtkFrame - - location to store X alignment of - frame’s label, or %NULL + + location to store X alignment of + frame’s label, or %NULL - - location to store X alignment of - frame’s label, or %NULL + + location to store X alignment of + frame’s label, or %NULL - - Retrieves the label widget for the frame. See + + Retrieves the label widget for the frame. See gtk_frame_set_label_widget(). - the label widget, or %NULL if + the label widget, or %NULL if there is none. - a #GtkFrame + a #GtkFrame - Retrieves the shadow type of the frame. See + Retrieves the shadow type of the frame. See gtk_frame_set_shadow_type(). - the current shadow type of the frame. + the current shadow type of the frame. - a #GtkFrame + a #GtkFrame - Removes the current #GtkFrame:label-widget. If @label is not %NULL, creates a + Removes the current #GtkFrame:label-widget. If @label is not %NULL, creates a new #GtkLabel with that text and adds it as the #GtkFrame:label-widget. @@ -62532,26 +44811,17 @@ new #GtkLabel with that text and adds it as the #GtkFrame:label-widget. - a #GtkFrame + a #GtkFrame - - the text to use as the label of the frame + + the text to use as the label of the frame - Sets the alignment of the frame widget’s label. The + Sets the alignment of the frame widget’s label. The default values for a newly created frame are 0.0 and 0.5. @@ -62559,35 +44829,26 @@ default values for a newly created frame are 0.0 and 0.5. - a #GtkFrame + a #GtkFrame - The position of the label along the top edge + The position of the label along the top edge of the widget. A value of 0.0 represents left alignment; 1.0 represents right alignment. - The y alignment of the label. A value of 0.0 aligns under + The y alignment of the label. A value of 0.0 aligns under the frame; 1.0 aligns above the frame. If the values are exactly - 0.0 or 1.0 the gap in the frame won’t be painted because the label + 0.0 or 1.0 the gap in the frame won’t be painted because the label will be completely above or below the frame. - - Sets the #GtkFrame:label-widget for the frame. This is the widget that + + Sets the #GtkFrame:label-widget for the frame. This is the widget that will appear embedded in the top edge of the frame as a title. @@ -62595,26 +44856,17 @@ will appear embedded in the top edge of the frame as a title. - a #GtkFrame + a #GtkFrame - - the new label widget + + the new label widget - Sets the #GtkFrame:shadow-type for @frame, i.e. whether it is drawn without + Sets the #GtkFrame:shadow-type for @frame, i.e. whether it is drawn without (%GTK_SHADOW_NONE) or with (other values) a visible border. Values other than %GTK_SHADOW_NONE are treated identically by GtkFrame. The chosen type is applied by removing or adding the .flat class to the CSS node named border. @@ -62624,15 +44876,11 @@ applied by removing or adding the .flat class to the CSS node named border. - a #GtkFrame + a #GtkFrame - the new #GtkShadowType + the new #GtkShadowType @@ -62659,45 +44907,29 @@ applied by removing or adding the .flat class to the CSS node named border. - + - + - + - + - + - + - The parent class. + The parent class. @@ -62752,287 +44984,218 @@ applied by removing or adding the .flat class to the CSS node named border. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - #GtkGLArea is a widget that allows drawing with OpenGL. + + #GtkGLArea is a widget that allows drawing with OpenGL. #GtkGLArea sets up its own #GdkGLContext for the window it creates, and creates a custom GL framebuffer that the widget will do GL rendering onto. @@ -63135,14 +45298,10 @@ you should use the #GtkGLArea::create-context signal. - Creates a new #GtkGLArea widget. + Creates a new #GtkGLArea widget. - a new #GtkGLArea + a new #GtkGLArea @@ -63188,12 +45347,8 @@ you should use the #GtkGLArea::create-context signal. - - Ensures that the @area framebuffer object is made the current draw + + Ensures that the @area framebuffer object is made the current draw and read target, and that all the required buffers for the @area are created and bound to the frambuffer. @@ -63206,151 +45361,97 @@ by application code. - a #GtkGLArea + a #GtkGLArea - - Returns whether the area is in auto render mode or not. + + Returns whether the area is in auto render mode or not. - %TRUE if the @area is auto rendering, %FALSE otherwise + %TRUE if the @area is auto rendering, %FALSE otherwise - a #GtkGLArea + a #GtkGLArea - - Retrieves the #GdkGLContext used by @area. + + Retrieves the #GdkGLContext used by @area. - the #GdkGLContext + the #GdkGLContext - a #GtkGLArea + a #GtkGLArea - - Gets the current error set on the @area. + + Gets the current error set on the @area. - the #GError or %NULL + the #GError or %NULL - a #GtkGLArea + a #GtkGLArea - - Returns whether the area has an alpha component. + + Returns whether the area has an alpha component. - %TRUE if the @area has an alpha component, %FALSE otherwise + %TRUE if the @area has an alpha component, %FALSE otherwise - a #GtkGLArea + a #GtkGLArea - - Returns whether the area has a depth buffer. + + Returns whether the area has a depth buffer. - %TRUE if the @area has a depth buffer, %FALSE otherwise + %TRUE if the @area has a depth buffer, %FALSE otherwise - a #GtkGLArea + a #GtkGLArea - - Returns whether the area has a stencil buffer. + + Returns whether the area has a stencil buffer. - %TRUE if the @area has a stencil buffer, %FALSE otherwise + %TRUE if the @area has a stencil buffer, %FALSE otherwise - a #GtkGLArea + a #GtkGLArea - - Retrieves the required version of OpenGL set + + Retrieves the required version of OpenGL set using gtk_gl_area_set_required_version(). @@ -63358,60 +45459,36 @@ using gtk_gl_area_set_required_version(). - a #GtkGLArea + a #GtkGLArea - - return location for the required major version + + return location for the required major version - - return location for the required minor version + + return location for the required minor version - - Retrieves the value set by gtk_gl_area_set_use_es(). + + Retrieves the value set by gtk_gl_area_set_use_es(). - %TRUE if the #GtkGLArea should create an OpenGL ES context + %TRUE if the #GtkGLArea should create an OpenGL ES context and %FALSE otherwise - a #GtkGLArea + a #GtkGLArea - - Ensures that the #GdkGLContext used by @area is associated with + + Ensures that the #GdkGLContext used by @area is associated with the #GtkGLArea. This function is automatically called before emitting the @@ -63423,19 +45500,13 @@ by application code. - a #GtkGLArea + a #GtkGLArea - - Marks the currently rendered data (if any) as invalid, and queues + + Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget, ensuring that the #GtkGLArea::render signal is emitted during the draw. @@ -63448,19 +45519,13 @@ emit #GtkGLArea::render on each draw. - a #GtkGLArea + a #GtkGLArea - - If @auto_render is %TRUE the #GtkGLArea::render signal will be + + If @auto_render is %TRUE the #GtkGLArea::render signal will be emitted every time the widget draws. This is the default and is useful if drawing the widget is faster. @@ -63475,25 +45540,17 @@ the scene changes seldomly, but takes a long time to redraw. - a #GtkGLArea + a #GtkGLArea - a boolean + a boolean - - Sets an error on the area which will be shown instead of the + + Sets an error on the area which will be shown instead of the GL rendering. This is useful in the #GtkGLArea::create-context signal if GL context creation fails. @@ -63502,28 +45559,17 @@ signal if GL context creation fails. - a #GtkGLArea + a #GtkGLArea - - a new #GError, or %NULL to unset the error + + a new #GError, or %NULL to unset the error - - If @has_alpha is %TRUE the buffer allocated by the widget will have + + If @has_alpha is %TRUE the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget. @@ -63535,25 +45581,17 @@ buffer will fully replace anything below the widget. - a #GtkGLArea + a #GtkGLArea - %TRUE to add an alpha component + %TRUE to add an alpha component - - If @has_depth_buffer is %TRUE the widget will allocate and + + If @has_depth_buffer is %TRUE the widget will allocate and enable a depth buffer for the target framebuffer. Otherwise there will be none. @@ -63562,25 +45600,17 @@ there will be none. - a #GtkGLArea + a #GtkGLArea - %TRUE to add a depth buffer + %TRUE to add a depth buffer - - If @has_stencil_buffer is %TRUE the widget will allocate and + + If @has_stencil_buffer is %TRUE the widget will allocate and enable a stencil buffer for the target framebuffer. Otherwise there will be none. @@ -63589,25 +45619,17 @@ there will be none. - a #GtkGLArea + a #GtkGLArea - %TRUE to add a stencil buffer + %TRUE to add a stencil buffer - - Sets the required version of OpenGL to be used when creating the context + + Sets the required version of OpenGL to be used when creating the context for the widget. This function must be called before the area has been realized. @@ -63617,31 +45639,21 @@ This function must be called before the area has been realized. - a #GtkGLArea + a #GtkGLArea - the major version + the major version - the minor version + the minor version - - Sets whether the @area should create an OpenGL or an OpenGL ES context. + + Sets whether the @area should create an OpenGL or an OpenGL ES context. You should check the capabilities of the #GdkGLContext before drawing with either API. @@ -63651,26 +45663,17 @@ with either API. - a #GtkGLArea + a #GtkGLArea - whether to use OpenGL or OpenGL ES + whether to use OpenGL or OpenGL ES - - If set to %TRUE the #GtkGLArea::render signal will be emitted every time + + If set to %TRUE the #GtkGLArea::render signal will be emitted every time the widget draws. This is the default and is useful if drawing the widget is faster. @@ -63682,22 +45685,15 @@ to redraw. - The #GdkGLContext used by the #GtkGLArea widget. + The #GdkGLContext used by the #GtkGLArea widget. The #GtkGLArea widget is responsible for creating the #GdkGLContext instance. If you need to render with other kinds of buffers (stencil, depth, etc), use render buffers. - - If set to %TRUE the buffer allocated by the widget will have an alpha channel + + If set to %TRUE the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget. @@ -63705,33 +45701,18 @@ If set to %FALSE there will be no alpha channel, and the buffer will fully replace anything below the widget. - - If set to %TRUE the widget will allocate and enable a depth buffer for the + + If set to %TRUE the widget will allocate and enable a depth buffer for the target framebuffer. - - If set to %TRUE the widget will allocate and enable a stencil buffer for the + + If set to %TRUE the widget will allocate and enable a stencil buffer for the target framebuffer. - - If set to %TRUE the widget will try to create a #GdkGLContext using + + If set to %TRUE the widget will try to create a #GdkGLContext using OpenGL ES instead of OpenGL. See also: gdk_gl_context_set_use_es() @@ -63741,9 +45722,7 @@ See also: gdk_gl_context_set_use_es() - The ::create-context signal is emitted when the widget is being + The ::create-context signal is emitted when the widget is being realized, and allows you to override how the GL context is created. This is useful when you want to reuse an existing GL context, or if you want to try creating different kinds of GL @@ -63753,41 +45732,31 @@ If context creation fails then the signal handler can use gtk_gl_area_set_error() to register a more detailed error of how the construction failed. - a newly created #GdkGLContext; + a newly created #GdkGLContext; the #GtkGLArea widget will take ownership of the returned value. - The ::render signal is emitted every time the contents + The ::render signal is emitted every time the contents of the #GtkGLArea should be redrawn. The @context is bound to the @area prior to emitting this function, and the buffers are painted to the window once the emission terminates. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkGLContext used by @area + the #GdkGLContext used by @area - The ::resize signal is emitted once when the widget is realized, and + The ::resize signal is emitted once when the widget is realized, and then each time the widget is changed while realized. This is useful in order to keep GL state up to date with the widget size, like for instance camera properties which may depend on the width/height ratio. @@ -63801,27 +45770,18 @@ The default handler sets up the GL viewport. - the width of the viewport + the width of the viewport - the height of the viewport + the height of the viewport - - The `GtkGLAreaClass` structure contains only private data. + + The `GtkGLAreaClass` structure contains only private data. @@ -63880,27 +45840,21 @@ The default handler sets up the GL viewport. - + - + - + @@ -63914,35 +45868,22 @@ The default handler sets up the GL viewport. - + - + - - #GtkGesture is the base object for gesture recognition, although this + + #GtkGesture is the base object for gesture recognition, although this object is quite generalized to serve as a base for multi-touch gestures, it is suitable to implement single-touch and pointer-based gestures (using the special %NULL #GdkEventSequence value for these). @@ -64032,12 +45973,8 @@ to enable this support are: - If the gesture has %GTK_PHASE_NONE, ensuring events of type %GDK_TOUCHPAD_SWIPE and %GDK_TOUCHPAD_PINCH are handled by the #GtkGesture - - If there are touch sequences being currently handled by @gesture, + + If there are touch sequences being currently handled by @gesture, this function returns %TRUE and fills in @rect with the bounding box containing all active touches. Otherwise, %FALSE will be returned. @@ -64049,106 +45986,65 @@ infinitely small area, @rect width and height will thus be 0 regardless of the number of touchpoints. - %TRUE if there are active touches, %FALSE otherwise + %TRUE if there are active touches, %FALSE otherwise - a #GtkGesture + a #GtkGesture - - bounding box containing all active touches. + + bounding box containing all active touches. - - If there are touch sequences being currently handled by @gesture, + + If there are touch sequences being currently handled by @gesture, this function returns %TRUE and fills in @x and @y with the center of the bounding box containing all active touches. Otherwise, %FALSE will be returned. - %FALSE if no active touches are present, %TRUE otherwise + %FALSE if no active touches are present, %TRUE otherwise - a #GtkGesture + a #GtkGesture - - X coordinate for the bounding box center + + X coordinate for the bounding box center - - Y coordinate for the bounding box center + + Y coordinate for the bounding box center - - Returns the master #GdkDevice that is currently operating + + Returns the master #GdkDevice that is currently operating on @gesture, or %NULL if the gesture is not being interacted. - a #GdkDevice, or %NULL + a #GdkDevice, or %NULL - a #GtkGesture + a #GtkGesture - - Returns all gestures in the group of @gesture + + Returns all gestures in the group of @gesture - The list + The list of #GtkGestures, free with g_list_free() @@ -64156,164 +46052,100 @@ on @gesture, or %NULL if the gesture is not being interacted. - a #GtkGesture + a #GtkGesture - Returns the last event that was processed for @sequence. + Returns the last event that was processed for @sequence. Note that the returned pointer is only valid as long as the @sequence is still interpreted by the @gesture. If in doubt, you should make a copy of the event. - The last event from @sequence + The last event from @sequence - a #GtkGesture + a #GtkGesture - - a #GdkEventSequence + + a #GdkEventSequence - - Returns the #GdkEventSequence that was last updated on @gesture. + + Returns the #GdkEventSequence that was last updated on @gesture. - The last updated sequence + The last updated sequence - a #GtkGesture + a #GtkGesture - - If @sequence is currently being interpreted by @gesture, this + + If @sequence is currently being interpreted by @gesture, this function returns %TRUE and fills in @x and @y with the last coordinates stored for that event sequence. The coordinates are always relative to the widget allocation. - %TRUE if @sequence is currently interpreted + %TRUE if @sequence is currently interpreted - a #GtkGesture + a #GtkGesture - - a #GdkEventSequence, or %NULL for pointer events + + a #GdkEventSequence, or %NULL for pointer events - - return location for X axis of the sequence coordinates + + return location for X axis of the sequence coordinates - - return location for Y axis of the sequence coordinates + + return location for Y axis of the sequence coordinates - - Returns the @sequence state, as seen by @gesture. + + Returns the @sequence state, as seen by @gesture. - The sequence state in @gesture + The sequence state in @gesture - a #GtkGesture + a #GtkGesture - a #GdkEventSequence + a #GdkEventSequence - - Returns the list of #GdkEventSequences currently being interpreted + + Returns the list of #GdkEventSequences currently being interpreted by @gesture. - A list + A list of #GdkEventSequences, the list elements are owned by GTK+ and must not be freed or modified, the list itself must be deleted through g_list_free() @@ -64323,41 +46155,29 @@ by @gesture. - a #GtkGesture + a #GtkGesture - - Returns the user-defined window that receives the events + + Returns the user-defined window that receives the events handled by @gesture. See gtk_gesture_set_window() for more information. - the user defined window, or %NULL if none + the user defined window, or %NULL if none - a #GtkGesture + a #GtkGesture - Adds @gesture to the same group than @group_gesture. Gestures + Adds @gesture to the same group than @group_gesture. Gestures are by default isolated in their own groups. When gestures are grouped, the state of #GdkEventSequences @@ -64374,134 +46194,87 @@ state for that sequence to #GTK_EVENT_SEQUENCE_DENIED. - #GtkGesture to group @gesture with + #GtkGesture to group @gesture with - a #GtkGesture + a #GtkGesture - - Returns %TRUE if @gesture is currently handling events corresponding to + + Returns %TRUE if @gesture is currently handling events corresponding to @sequence. - %TRUE if @gesture is handling @sequence, %FALSE otherwise + %TRUE if @gesture is handling @sequence, %FALSE otherwise - a #GtkGesture + a #GtkGesture - - a #GdkEventSequence or %NULL + + a #GdkEventSequence or %NULL - - Returns %TRUE if the gesture is currently active. + + Returns %TRUE if the gesture is currently active. A gesture is active meanwhile there are touch sequences interacting with it. - %TRUE if gesture is active + %TRUE if gesture is active - a #GtkGesture + a #GtkGesture - - Returns %TRUE if both gestures pertain to the same group. + + Returns %TRUE if both gestures pertain to the same group. - whether the gestures are grouped + whether the gestures are grouped - a #GtkGesture + a #GtkGesture - another #GtkGesture + another #GtkGesture - - Returns %TRUE if the gesture is currently recognized. + + Returns %TRUE if the gesture is currently recognized. A gesture is recognized if there are as many interacting touch sequences as required by @gesture, and #GtkGesture::check returned %TRUE for the sequences being currently interpreted. - %TRUE if gesture is recognized + %TRUE if gesture is recognized - a #GtkGesture + a #GtkGesture - - Sets the state of @sequence in @gesture. Sequences start + + Sets the state of @sequence in @gesture. Sequences start in state #GTK_EVENT_SEQUENCE_NONE, and whenever they change state, they can never go back to that state. Likewise, sequences in state #GTK_EVENT_SEQUENCE_DENIED cannot turn @@ -64509,9 +46282,9 @@ back to a not denied state. With these rules, the lifetime of an event sequence is constrained to the next four: * None -* None → Denied -* None → Claimed -* None → Claimed → Denied +* None → Denied +* None → Claimed +* None → Claimed → Denied Note: Due to event handling ordering, it may be unsafe to set the state on another gesture within a #GtkGesture::begin @@ -64545,70 +46318,48 @@ be initialized to the group's global state when the second gesture processes the event. - %TRUE if @sequence is handled by @gesture, + %TRUE if @sequence is handled by @gesture, and the state is changed successfully - a #GtkGesture + a #GtkGesture - a #GdkEventSequence + a #GdkEventSequence - the sequence state + the sequence state - - Sets the state of all sequences that @gesture is currently + + Sets the state of all sequences that @gesture is currently interacting with. See gtk_gesture_set_sequence_state() for more details on sequence states. - %TRUE if the state of at least one sequence + %TRUE if the state of at least one sequence was changed successfully - a #GtkGesture + a #GtkGesture - the sequence state + the sequence state - - Sets a specific window to receive events about, so @gesture + + Sets a specific window to receive events about, so @gesture will effectively handle only events targeting @window, or a child of it. @window must pertain to gtk_event_controller_get_widget(). @@ -64617,63 +46368,39 @@ a child of it. @window must pertain to gtk_event_controller_get_widget(). - a #GtkGesture + a #GtkGesture - - a #GdkWindow, or %NULL + + a #GdkWindow, or %NULL - Separates @gesture into an isolated group. + Separates @gesture into an isolated group. - a #GtkGesture + a #GtkGesture - - The number of touch points that trigger recognition on this gesture, + + The number of touch points that trigger recognition on this gesture, - - If non-%NULL, the gesture will only listen for events that happen on + + If non-%NULL, the gesture will only listen for events that happen on this #GdkWindow, or a child of it. - This signal is emitted when the gesture is recognized. This means the + This signal is emitted when the gesture is recognized. This means the number of touch sequences matches #GtkGesture:n-points, and the #GtkGesture::check handler(s) returned #TRUE. @@ -64684,21 +46411,14 @@ to the current set of active touches, so don't rely on this being true. - - the #GdkEventSequence that made the gesture to be recognized + + the #GdkEventSequence that made the gesture to be recognized - This signal is emitted whenever a sequence is cancelled. This usually + This signal is emitted whenever a sequence is cancelled. This usually happens on active touches when gtk_event_controller_reset() is called on @gesture (manually, due to grabs...), or the individual @sequence was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()). @@ -64708,21 +46428,14 @@ was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state() - - the #GdkEventSequence that was cancelled + + the #GdkEventSequence that was cancelled - This signal is emitted when @gesture either stopped recognizing the event + This signal is emitted when @gesture either stopped recognizing the event sequences as something to be handled (the #GtkGesture::check handler returned %FALSE), or the number of touch sequences became higher or lower than #GtkGesture:n-points. @@ -64735,280 +46448,171 @@ by checking through gtk_gesture_handles_sequence(). - - the #GdkEventSequence that made gesture recognition to finish + + the #GdkEventSequence that made gesture recognition to finish - This signal is emitted whenever a sequence state changes. See + This signal is emitted whenever a sequence state changes. See gtk_gesture_set_sequence_state() to know more about the expectable sequence lifetimes. - - the #GdkEventSequence that was cancelled + + the #GdkEventSequence that was cancelled - the new sequence state + the new sequence state - This signal is emitted whenever an event is handled while the gesture is + This signal is emitted whenever an event is handled while the gesture is recognized. @sequence is guaranteed to pertain to the set of active touches. - - the #GdkEventSequence that was updated + + the #GdkEventSequence that was updated - + - - #GtkGestureDrag is a #GtkGesture implementation that recognizes drag + + #GtkGestureDrag is a #GtkGesture implementation that recognizes drag operations. The drag operation itself can be tracked throught the #GtkGestureDrag::drag-begin, #GtkGestureDrag::drag-update and #GtkGestureDrag::drag-end signals, or the relevant coordinates be extracted through gtk_gesture_drag_get_offset() and gtk_gesture_drag_get_start_point(). - - Returns a newly created #GtkGesture that recognizes drags. + + Returns a newly created #GtkGesture that recognizes drags. - a newly created #GtkGestureDrag + a newly created #GtkGestureDrag - a #GtkWidget + a #GtkWidget - - If the @gesture is active, this function returns %TRUE and + + If the @gesture is active, this function returns %TRUE and fills in @x and @y with the coordinates of the current point, as an offset to the starting drag point. - %TRUE if the gesture is active + %TRUE if the gesture is active - a #GtkGesture + a #GtkGesture - - X offset for the current point + + X offset for the current point - - Y offset for the current point + + Y offset for the current point - - If the @gesture is active, this function returns %TRUE + + If the @gesture is active, this function returns %TRUE and fills in @x and @y with the drag start coordinates, in window-relative coordinates. - %TRUE if the gesture is active + %TRUE if the gesture is active - a #GtkGesture + a #GtkGesture - - X coordinate for the drag start point + + X coordinate for the drag start point - - Y coordinate for the drag start point + + Y coordinate for the drag start point - This signal is emitted whenever dragging starts. + This signal is emitted whenever dragging starts. - X coordinate, relative to the widget allocation + X coordinate, relative to the widget allocation - Y coordinate, relative to the widget allocation + Y coordinate, relative to the widget allocation - This signal is emitted whenever the dragging is finished. + This signal is emitted whenever the dragging is finished. - X offset, relative to the start point + X offset, relative to the start point - Y offset, relative to the start point + Y offset, relative to the start point - This signal is emitted whenever the dragging point moves. + This signal is emitted whenever the dragging point moves. - X offset, relative to the start point + X offset, relative to the start point - Y offset, relative to the start point + Y offset, relative to the start point - + - - #GtkGestureLongPress is a #GtkGesture implementation able to recognize + + #GtkGestureLongPress is a #GtkGesture implementation able to recognize long presses, triggering the #GtkGestureLongPress::pressed after the timeout is exceeded. @@ -65016,24 +46620,16 @@ If the touchpoint is lifted before the timeout passes, or if it drifts too far of the initial press point, the #GtkGestureLongPress::cancelled signal will be emitted. - - Returns a newly created #GtkGesture that recognizes long presses. + + Returns a newly created #GtkGesture that recognizes long presses. - a newly created #GtkGestureLongPress + a newly created #GtkGestureLongPress - a #GtkWidget + a #GtkWidget @@ -65042,54 +46638,35 @@ signal will be emitted. - This signal is emitted whenever a press moved too far, or was released + This signal is emitted whenever a press moved too far, or was released before #GtkGestureLongPress::pressed happened. - This signal is emitted whenever a press goes unmoved/unreleased longer than + This signal is emitted whenever a press goes unmoved/unreleased longer than what the GTK+ defaults tell. - the X coordinate where the press happened, relative to the widget allocation + the X coordinate where the press happened, relative to the widget allocation - the Y coordinate where the press happened, relative to the widget allocation + the Y coordinate where the press happened, relative to the widget allocation - + - - #GtkGestureMultiPress is a #GtkGesture implementation able to recognize + + #GtkGestureMultiPress is a #GtkGesture implementation able to recognize multiple clicks on a nearby zone, which can be listened for through the #GtkGestureMultiPress::pressed signal. Whenever time or distance between clicks exceed the GTK+ defaults, #GtkGestureMultiPress::stopped is emitted, @@ -65100,69 +46677,44 @@ touch/button press through gtk_gesture_multi_press_set_area(), so any click happening outside that area is considered to be a first click of its own. - - Returns a newly created #GtkGesture that recognizes single and multiple + + Returns a newly created #GtkGesture that recognizes single and multiple presses. - a newly created #GtkGestureMultiPress + a newly created #GtkGestureMultiPress - a #GtkWidget + a #GtkWidget - - If an area was set through gtk_gesture_multi_press_set_area(), + + If an area was set through gtk_gesture_multi_press_set_area(), this function will return %TRUE and fill in @rect with the press area. See gtk_gesture_multi_press_set_area() for more details on what the press area represents. - %TRUE if @rect was filled with the press area + %TRUE if @rect was filled with the press area - a #GtkGestureMultiPress + a #GtkGestureMultiPress - - return location for the press area + + return location for the press area - - If @rect is non-%NULL, the press area will be checked to be + + If @rect is non-%NULL, the press area will be checked to be confined within the rectangle, otherwise the button count will be reset so the press is seen as being the first one. If @rect is %NULL, the area will be reset to an unrestricted @@ -65177,54 +46729,37 @@ akin to an input shape. - a #GtkGestureMultiPress + a #GtkGestureMultiPress - - rectangle to receive coordinates on + + rectangle to receive coordinates on - This signal is emitted whenever a button or touch press happens. + This signal is emitted whenever a button or touch press happens. - how many touch/button presses happened with this one + how many touch/button presses happened with this one - The X coordinate, in widget allocation coordinates + The X coordinate, in widget allocation coordinates - The Y coordinate, in widget allocation coordinates + The Y coordinate, in widget allocation coordinates - This signal is emitted when a button or touch is released. @n_press + This signal is emitted when a button or touch is released. @n_press will report the number of press that is paired to this event, note that #GtkGestureMultiPress::stopped may have been emitted between the press and its release, @n_press will only start over at the next press. @@ -65233,51 +46768,32 @@ press and its release, @n_press will only start over at the next press. - number of press that is paired with this release + number of press that is paired with this release - The X coordinate, in widget allocation coordinates + The X coordinate, in widget allocation coordinates - The Y coordinate, in widget allocation coordinates + The Y coordinate, in widget allocation coordinates - This signal is emitted whenever any time/distance threshold has + This signal is emitted whenever any time/distance threshold has been exceeded. - + - - #GtkGesturePan is a #GtkGesture implementation able to recognize + + #GtkGesturePan is a #GtkGesture implementation able to recognize pan gestures, those are drags that are locked to happen along one axis. The axis that a #GtkGesturePan handles is defined at construct time, and can be changed through @@ -65292,220 +46808,139 @@ Once a panning gesture along the expected axis is recognized, the #GtkGesturePan::pan signal will be emitted as input events are received, containing the offset in the given axis. - - Returns a newly created #GtkGesture that recognizes pan gestures. + + Returns a newly created #GtkGesture that recognizes pan gestures. - a newly created #GtkGesturePan + a newly created #GtkGesturePan - a #GtkWidget + a #GtkWidget - expected orientation + expected orientation - - Returns the orientation of the pan gestures that this @gesture expects. + + Returns the orientation of the pan gestures that this @gesture expects. - the expected orientation for pan gestures + the expected orientation for pan gestures - A #GtkGesturePan + A #GtkGesturePan - - Sets the orientation to be expected on pan gestures. + + Sets the orientation to be expected on pan gestures. - A #GtkGesturePan + A #GtkGesturePan - expected orientation + expected orientation - - The expected orientation of pan gestures. + + The expected orientation of pan gestures. - This signal is emitted once a panning gesture along the + This signal is emitted once a panning gesture along the expected axis is detected. - current direction of the pan gesture + current direction of the pan gesture - Offset along the gesture orientation + Offset along the gesture orientation - + - - #GtkGestureRotate is a #GtkGesture implementation able to recognize + + #GtkGestureRotate is a #GtkGesture implementation able to recognize 2-finger rotations, whenever the angle between both handled sequences changes, the #GtkGestureRotate::angle-changed signal is emitted. - - Returns a newly created #GtkGesture that recognizes 2-touch + + Returns a newly created #GtkGesture that recognizes 2-touch rotation gestures. - a newly created #GtkGestureRotate + a newly created #GtkGestureRotate - a #GtkWidget + a #GtkWidget - - If @gesture is active, this function returns the angle difference + + If @gesture is active, this function returns the angle difference in radians since the gesture was first recognized. If @gesture is not active, 0 is returned. - the angle delta in radians + the angle delta in radians - a #GtkGestureRotate + a #GtkGestureRotate - This signal is emitted when the angle between both tracked points + This signal is emitted when the angle between both tracked points changes. - Current angle in radians + Current angle in radians - Difference with the starting angle, in radians + Difference with the starting angle, in radians - + - - #GtkGestureSingle is a subclass of #GtkGesture, optimized (although + + #GtkGestureSingle is a subclass of #GtkGesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through gtk_gesture_single_get_current_sequence() while the @@ -65518,126 +46953,82 @@ to interact with through gtk_gesture_single_set_button(), or react to any mouse button by setting 0. While the gesture is active, the button being currently pressed can be known through gtk_gesture_single_get_current_button(). - - Returns the button number @gesture listens for, or 0 if @gesture + + Returns the button number @gesture listens for, or 0 if @gesture reacts to any button press. - The button number, or 0 for any button + The button number, or 0 for any button - a #GtkGestureSingle + a #GtkGestureSingle - - Returns the button number currently interacting with @gesture, or 0 if there + + Returns the button number currently interacting with @gesture, or 0 if there is none. - The current button number + The current button number - a #GtkGestureSingle + a #GtkGestureSingle - - Returns the event sequence currently interacting with @gesture. + + Returns the event sequence currently interacting with @gesture. This is only meaningful if gtk_gesture_is_active() returns %TRUE. - the current sequence + the current sequence - a #GtkGestureSingle + a #GtkGestureSingle - - Gets whether a gesture is exclusive. For more information, see + + Gets whether a gesture is exclusive. For more information, see gtk_gesture_single_set_exclusive(). - Whether the gesture is exclusive + Whether the gesture is exclusive - a #GtkGestureSingle + a #GtkGestureSingle - - Returns %TRUE if the gesture is only triggered by touch events. + + Returns %TRUE if the gesture is only triggered by touch events. - %TRUE if the gesture only handles touch events + %TRUE if the gesture only handles touch events - a #GtkGestureSingle + a #GtkGestureSingle - - Sets the button number @gesture listens to. If non-0, every + + Sets the button number @gesture listens to. If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1. @@ -65646,25 +47037,17 @@ Touch events implicitly match with button 1. - a #GtkGestureSingle + a #GtkGestureSingle - button number to listen to, or 0 for any button + button number to listen to, or 0 for any button - - Sets whether @gesture is exclusive. An exclusive gesture will + + Sets whether @gesture is exclusive. An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those. @@ -65674,25 +47057,17 @@ those. - a #GtkGestureSingle + a #GtkGestureSingle - %TRUE to make @gesture exclusive + %TRUE to make @gesture exclusive - - If @touch_only is %TRUE, @gesture will only handle events of type + + If @touch_only is %TRUE, @gesture will only handle events of type #GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If %FALSE, mouse events will be handled too. @@ -65701,193 +47076,117 @@ mouse events will be handled too. - a #GtkGestureSingle + a #GtkGestureSingle - whether @gesture handles only touch events + whether @gesture handles only touch events - - Mouse button number to listen to, or 0 to listen for any button. + + Mouse button number to listen to, or 0 to listen for any button. - - Whether the gesture is exclusive. Exclusive gestures only listen to pointer + + Whether the gesture is exclusive. Exclusive gestures only listen to pointer and pointer emulated events. - - Whether the gesture handles only touch events. + + Whether the gesture handles only touch events. - + - - #GtkGestureStylus is a #GtkGesture implementation specific to stylus + + #GtkGestureStylus is a #GtkGesture implementation specific to stylus input. The provided signals just provide the basic information - - Creates a new #GtkGestureStylus. + + Creates a new #GtkGestureStylus. - a newly created stylus gesture + a newly created stylus gesture - a #GtkWidget + a #GtkWidget - - Returns the current values for the requested @axes. This function + + Returns the current values for the requested @axes. This function must be called from either the #GtkGestureStylus:down, #GtkGestureStylus:motion, #GtkGestureStylus:up or #GtkGestureStylus:proximity signals. - #TRUE if there is a current value for the axes + #TRUE if there is a current value for the axes - a GtkGestureStylus + a GtkGestureStylus - array of requested axes, terminated with #GDK_AXIS_IGNORE + array of requested axes, terminated with #GDK_AXIS_IGNORE - - return location for the axis values + + return location for the axis values - - Returns the current value for the requested @axis. This function + + Returns the current value for the requested @axis. This function must be called from either the #GtkGestureStylus:down, #GtkGestureStylus:motion, #GtkGestureStylus:up or #GtkGestureStylus:proximity signals. - #TRUE if there is a current value for the axis + #TRUE if there is a current value for the axis - a #GtkGestureStylus + a #GtkGestureStylus - requested device axis + requested device axis - - return location for the axis value + + return location for the axis value - - Returns the #GdkDeviceTool currently driving input through this gesture. + + Returns the #GdkDeviceTool currently driving input through this gesture. This function must be called from either the #GtkGestureStylus::down, #GtkGestureStylus::motion, #GtkGestureStylus::up or #GtkGestureStylus::proximity signal handlers. - The current stylus tool + The current stylus tool - a #GtkGestureStylus + a #GtkGestureStylus @@ -65945,22 +47244,11 @@ signal handlers. - + - - #GtkGestureSwipe is a #GtkGesture implementation able to recognize + + #GtkGestureSwipe is a #GtkGesture implementation able to recognize swipes, after a press/move/.../move/release sequence happens, the #GtkGestureSwipe::swipe signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted. @@ -65971,193 +47259,121 @@ gtk_gesture_swipe_get_velocity() can be called on eg. a All velocities are reported in pixels/sec units. - - Returns a newly created #GtkGesture that recognizes swipes. + + Returns a newly created #GtkGesture that recognizes swipes. - a newly created #GtkGestureSwipe + a newly created #GtkGestureSwipe - a #GtkWidget + a #GtkWidget - - If the gesture is recognized, this function returns %TRUE and fill in + + If the gesture is recognized, this function returns %TRUE and fill in @velocity_x and @velocity_y with the recorded velocity, as per the last event(s) processed. - whether velocity could be calculated + whether velocity could be calculated - a #GtkGestureSwipe + a #GtkGestureSwipe - - return value for the velocity in the X axis, in pixels/sec + + return value for the velocity in the X axis, in pixels/sec - - return value for the velocity in the Y axis, in pixels/sec + + return value for the velocity in the Y axis, in pixels/sec - This signal is emitted when the recognized gesture is finished, velocity + This signal is emitted when the recognized gesture is finished, velocity and direction are a product of previously recorded events. - velocity in the X axis, in pixels/sec + velocity in the X axis, in pixels/sec - velocity in the Y axis, in pixels/sec + velocity in the Y axis, in pixels/sec - + - - #GtkGestureZoom is a #GtkGesture implementation able to recognize + + #GtkGestureZoom is a #GtkGesture implementation able to recognize pinch/zoom gestures, whenever the distance between both tracked sequences changes, the #GtkGestureZoom::scale-changed signal is emitted to report the scale factor. - - Returns a newly created #GtkGesture that recognizes zoom + + Returns a newly created #GtkGesture that recognizes zoom in/out gestures (usually known as pinch/zoom). - a newly created #GtkGestureZoom + a newly created #GtkGestureZoom - a #GtkWidget + a #GtkWidget - - If @gesture is active, this function returns the zooming difference + + If @gesture is active, this function returns the zooming difference since the gesture was recognized (hence the starting point is considered 1:1). If @gesture is not active, 1 is returned. - the scale delta + the scale delta - a #GtkGestureZoom + a #GtkGestureZoom - This signal is emitted whenever the distance between both tracked + This signal is emitted whenever the distance between both tracked sequences changes. - Scale delta, taking the initial state as 1:1 + Scale delta, taking the initial state as 1:1 - + - - GtkGradient is a boxed type that represents a gradient. + + GtkGradient is a boxed type that represents a gradient. It is the result of parsing a [gradient expression][gtkcssprovider-gradients]. To obtain the gradient represented by a GtkGradient, it has to @@ -66169,121 +47385,78 @@ It is not normally necessary to deal directly with #GtkGradients, since they are mostly used behind the scenes by #GtkStyleContext and #GtkCssProvider. -#GtkGradient is deprecated. It was used internally by GTK’s CSS engine +#GtkGradient is deprecated. It was used internally by GTK’s CSS engine to represent gradients. As its handling is not conforming to modern web standards, it is not used anymore. If you want to use gradients in your own code, please use Cairo directly. - - - Creates a new linear gradient along the line defined by (x0, y0) and (x1, y1). Before using the gradient + + + Creates a new linear gradient along the line defined by (x0, y0) and (x1, y1). Before using the gradient a number of stop colors must be added through gtk_gradient_add_color_stop(). #GtkGradient is deprecated. - A newly created #GtkGradient + A newly created #GtkGradient - X coordinate of the starting point + X coordinate of the starting point - Y coordinate of the starting point + Y coordinate of the starting point - X coordinate of the end point + X coordinate of the end point - Y coordinate of the end point + Y coordinate of the end point - - Creates a new radial gradient along the two circles defined by (x0, y0, radius0) and + + Creates a new radial gradient along the two circles defined by (x0, y0, radius0) and (x1, y1, radius1). Before using the gradient a number of stop colors must be added through gtk_gradient_add_color_stop(). #GtkGradient is deprecated. - A newly created #GtkGradient + A newly created #GtkGradient - X coordinate of the start circle + X coordinate of the start circle - Y coordinate of the start circle + Y coordinate of the start circle - radius of the start circle + radius of the start circle - X coordinate of the end circle + X coordinate of the end circle - Y coordinate of the end circle + Y coordinate of the end circle - radius of the end circle + radius of the end circle - - Adds a stop color to @gradient. + + Adds a stop color to @gradient. #GtkGradient is deprecated. @@ -66291,96 +47464,62 @@ through gtk_gradient_add_color_stop(). - a #GtkGradient + a #GtkGradient - offset for the color stop + offset for the color stop - color to use + color to use - - Increases the reference count of @gradient. + + Increases the reference count of @gradient. #GtkGradient is deprecated. - The same @gradient + The same @gradient - a #GtkGradient + a #GtkGradient - - If @gradient is resolvable, @resolved_gradient will be filled in + + If @gradient is resolvable, @resolved_gradient will be filled in with the resolved gradient as a cairo_pattern_t, and %TRUE will -be returned. Generally, if @gradient can’t be resolved, it is +be returned. Generally, if @gradient can’t be resolved, it is due to it being defined on top of a named color that doesn't exist in @props. #GtkGradient is deprecated. - %TRUE if the gradient has been resolved + %TRUE if the gradient has been resolved - a #GtkGradient + a #GtkGradient - #GtkStyleProperties to use when resolving named colors + #GtkStyleProperties to use when resolving named colors - - return location for the resolved pattern + + return location for the resolved pattern - + @@ -66394,39 +47533,24 @@ exist in @props. - - Creates a string representation for @gradient that is suitable + + Creates a string representation for @gradient that is suitable for using in GTK CSS files. #GtkGradient is deprecated. - A string representation for @gradient + A string representation for @gradient - the gradient to print + the gradient to print - - Decreases the reference count of @gradient, freeing its memory + + Decreases the reference count of @gradient, freeing its memory if the reference count reaches 0. #GtkGradient is deprecated. @@ -66435,24 +47559,14 @@ if the reference count reaches 0. - a #GtkGradient + a #GtkGradient - - GtkGrid is a container which arranges its child widgets in + + GtkGrid is a container which arranges its child widgets in rows and columns, with arbitrary positions and horizontal/vertical spans. Children are added using gtk_grid_attach(). They can span multiple @@ -66473,24 +47587,18 @@ GtkGrid uses a single CSS node with name grid. - Creates a new grid widget. + Creates a new grid widget. - the new #GtkGrid + the new #GtkGrid - Adds a widget to the grid. + Adds a widget to the grid. The position of @child is determined by @left and @top. The -number of “cells” that @child will occupy is determined by +number of “cells” that @child will occupy is determined by @width and @height. @@ -66498,47 +47606,33 @@ number of “cells” that @child will occupy is determined by - a #GtkGrid + a #GtkGrid - the widget to add + the widget to add - the column number to attach the left side of @child to + the column number to attach the left side of @child to - the row number to attach the top side of @child to + the row number to attach the top side of @child to - the number of columns that @child will span + the number of columns that @child will span - the number of rows that @child will span + the number of rows that @child will span - Adds a widget to the grid. + Adds a widget to the grid. The widget is placed next to @sibling, on the side determined by @side. When @sibling is %NULL, the widget is placed in row (for @@ -66553,223 +47647,147 @@ Attaching widgets labeled [1], [2], [3] with @sibling == %NULL and - a #GtkGrid + a #GtkGrid - the widget to add + the widget to add - - the child of @grid that @child will be placed + + the child of @grid that @child will be placed next to, or %NULL to place @child at the beginning or end - the side of @sibling that @child is positioned next to + the side of @sibling that @child is positioned next to - the number of columns that @child will span + the number of columns that @child will span - the number of rows that @child will span + the number of rows that @child will span - - Returns which row defines the global baseline of @grid. + + Returns which row defines the global baseline of @grid. - the row index defining the global baseline + the row index defining the global baseline - a #GtkGrid + a #GtkGrid - - Gets the child of @grid whose area covers the grid + + Gets the child of @grid whose area covers the grid cell whose upper left corner is at @left, @top. - the child at the given position, or %NULL + the child at the given position, or %NULL - a #GtkGrid + a #GtkGrid - the left edge of the cell + the left edge of the cell - the top edge of the cell + the top edge of the cell - - Returns whether all columns of @grid have the same width. + + Returns whether all columns of @grid have the same width. - whether all columns of @grid have the same width. + whether all columns of @grid have the same width. - a #GtkGrid + a #GtkGrid - - Returns the amount of space between the columns of @grid. + + Returns the amount of space between the columns of @grid. - the column spacing of @grid + the column spacing of @grid - a #GtkGrid + a #GtkGrid - - Returns the baseline position of @row as set + + Returns the baseline position of @row as set by gtk_grid_set_row_baseline_position() or the default value %GTK_BASELINE_POSITION_CENTER. - the baseline position of @row + the baseline position of @row - a #GtkGrid + a #GtkGrid - a row index + a row index - - Returns whether all rows of @grid have the same height. + + Returns whether all rows of @grid have the same height. - whether all rows of @grid have the same height. + whether all rows of @grid have the same height. - a #GtkGrid + a #GtkGrid - Returns the amount of space between the rows of @grid. + Returns the amount of space between the rows of @grid. - the row spacing of @grid + the row spacing of @grid - a #GtkGrid + a #GtkGrid - - Inserts a column at the specified position. + + Inserts a column at the specified position. Children which are attached at or to the right of this position are moved one column to the right. Children which span across this @@ -66780,25 +47798,17 @@ position are grown to span the new column. - a #GtkGrid + a #GtkGrid - the position to insert the column at + the position to insert the column at - - Inserts a row or column at the specified position. + + Inserts a row or column at the specified position. The new row or column is placed next to @sibling, on the side determined by @side. If @side is %GTK_POS_TOP or %GTK_POS_BOTTOM, @@ -66810,32 +47820,22 @@ a column is inserted. - a #GtkGrid + a #GtkGrid - the child of @grid that the new row or column will be + the child of @grid that the new row or column will be placed next to - the side of @sibling that @child is positioned next to + the side of @sibling that @child is positioned next to - - Inserts a row at the specified position. + + Inserts a row at the specified position. Children which are attached at or below this position are moved one row down. Children which span across this @@ -66846,25 +47846,17 @@ position are grown to span the new row. - a #GtkGrid + a #GtkGrid - the position to insert the row at + the position to insert the row at - - Removes a column from the grid. + + Removes a column from the grid. Children that are placed in this column are removed, spanning children that overlap this column have their @@ -66876,25 +47868,17 @@ are moved to the left. - a #GtkGrid + a #GtkGrid - the position of the column to remove + the position of the column to remove - - Removes a row from the grid. + + Removes a row from the grid. Children that are placed in this row are removed, spanning children that overlap this row have their @@ -66906,25 +47890,17 @@ are moved up. - a #GtkGrid + a #GtkGrid - the position of the row to remove + the position of the row to remove - - Sets which row defines the global baseline for the entire grid. + + Sets which row defines the global baseline for the entire grid. Each row in the grid can have its own local baseline, but only one of those is global, meaning it will be the baseline in the parent of the @grid. @@ -66934,73 +47910,51 @@ parent of the @grid. - a #GtkGrid + a #GtkGrid - the row index + the row index - - Sets whether all columns of @grid will have the same width. + + Sets whether all columns of @grid will have the same width. - a #GtkGrid + a #GtkGrid - %TRUE to make columns homogeneous + %TRUE to make columns homogeneous - - Sets the amount of space between columns of @grid. + + Sets the amount of space between columns of @grid. - a #GtkGrid + a #GtkGrid - the amount of space to insert between columns + the amount of space to insert between columns - - Sets how the baseline should be positioned on @row of the + + Sets how the baseline should be positioned on @row of the grid, in case that row is assigned more space than is requested. @@ -67008,68 +47962,49 @@ grid, in case that row is assigned more space than is requested. - a #GtkGrid + a #GtkGrid - a row index + a row index - a #GtkBaselinePosition + a #GtkBaselinePosition - - Sets whether all rows of @grid will have the same height. + + Sets whether all rows of @grid will have the same height. - a #GtkGrid + a #GtkGrid - %TRUE to make rows homogeneous + %TRUE to make rows homogeneous - Sets the amount of space between rows of @grid. + Sets the amount of space between rows of @grid. - a #GtkGrid + a #GtkGrid - the amount of space to insert between rows + the amount of space to insert between rows @@ -67077,9 +48012,7 @@ grid, in case that row is assigned more space than is requested. - + @@ -67098,14 +48031,10 @@ grid, in case that row is assigned more space than is requested. - + - The parent class. + The parent class. @@ -67176,27 +48105,21 @@ grid, in case that row is assigned more space than is requested. - + - + - + @@ -67210,61 +48133,43 @@ grid, in case that row is assigned more space than is requested. - + - + - + - + - + - - #GtkHBox is a container that organizes child widgets into a single row. + + #GtkHBox is a container that organizes child widgets into a single row. Use the #GtkBox packing interface to determine the arrangement, spacing, width, and alignment of #GtkHBox children. @@ -67272,13 +48177,13 @@ spacing, width, and alignment of #GtkHBox children. All children are allocated the same height. GtkHBox has been deprecated. You can use #GtkBox instead, which is a -very quick and easy change. If you have derived your own classes from +very quick and easy change. If you have derived your own classes from GtkHBox, you can simply change the inheritance to derive directly from #GtkBox. No further changes are needed, since the default value of the #GtkOrientable:orientation property is %GTK_ORIENTATION_HORIZONTAL. -If you have a grid-like layout composed of nested boxes, and you don’t +If you have a grid-like layout composed of nested boxes, and you don’t need first-child or last-child styling, the recommendation is to switch to #GtkGrid. For more information about migrating to #GtkGrid, see [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid]. @@ -67286,35 +48191,22 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - - Creates a new #GtkHBox. - You can use gtk_box_new() with %GTK_ORIENTATION_HORIZONTAL instead, - which is a quick and easy change. But the recommendation is to switch to - #GtkGrid, since #GtkBox is going to go away eventually. - See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid]. + + Creates a new #GtkHBox. + You should use gtk_box_new() with a %GTK_ORIENTATION_HORIZONTAL + #GtkOrientable:orientation instead - a new #GtkHBox. + a new #GtkHBox. - %TRUE if all children are to be given equal space allotments. + %TRUE if all children are to be given equal space allotments. - the number of pixels to place by default between children. + the number of pixels to place by default between children. @@ -67323,38 +48215,23 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - + - + - - Creates a new horizontal button box. + + Creates a new horizontal button box. Use gtk_button_box_new() with %GTK_ORIENTATION_HORIZONTAL instead - a new button box #GtkWidget. + a new button box #GtkWidget. @@ -67362,62 +48239,48 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - + - + - + - + - + - + - + @@ -67431,34 +48294,22 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - + - + - - The HPaned widget is a container widget with two + + The HPaned widget is a container widget with two children arranged horizontally. The division between the two panes is adjustable by the user by dragging a handle. See #GtkPaned for details. @@ -67468,19 +48319,12 @@ GtkHPaned has been deprecated, use #GtkPaned instead. - - Create a new #GtkHPaned + + Create a new #GtkHPaned Use gtk_paned_new() with %GTK_ORIENTATION_HORIZONTAL instead - the new #GtkHPaned + the new #GtkHPaned @@ -67488,9 +48332,7 @@ GtkHPaned has been deprecated, use #GtkPaned instead. - + @@ -67503,88 +48345,64 @@ GtkHPaned has been deprecated, use #GtkPaned instead. - + - + - + - + - + - + - + - + - - #GtkHSV is the “color wheel” part of a complete color selector widget. + + #GtkHSV is the “color wheel” part of a complete color selector widget. It allows to select a color by determining its HSV components in an intuitive way. Moving the selection around the outer ring changes the hue, and moving the selection point inside the inner triangle changes value and @@ -67596,21 +48414,15 @@ it was used. - Creates a new HSV color selector. + Creates a new HSV color selector. - A newly-created HSV color selector. + A newly-created HSV color selector. - Converts a color from HSV space to RGB. + Converts a color from HSV space to RGB. Input values must be in the [0.0, 1.0] range; output values will be in the same range. @@ -67620,48 +48432,27 @@ output values will be in the same range. - Hue + Hue - Saturation + Saturation - Value + Value - - Return value for the red component + + Return value for the red component - - Return value for the green component + + Return value for the green component - - Return value for the blue component + + Return value for the blue component @@ -67692,9 +48483,7 @@ output values will be in the same range. - Queries the current color in an HSV color selector. + Queries the current color in an HSV color selector. Returned values will be in the [0.0, 1.0] range. @@ -67702,108 +48491,65 @@ Returned values will be in the [0.0, 1.0] range. - An HSV color selector + An HSV color selector - - Return value for the hue + + Return value for the hue - - Return value for the saturation + + Return value for the saturation - - Return value for the value + + Return value for the value - - Queries the size and ring width of an HSV color selector. + + Queries the size and ring width of an HSV color selector. - An HSV color selector + An HSV color selector - - Return value for the diameter of the hue ring + + Return value for the diameter of the hue ring - - Return value for the width of the hue ring + + Return value for the width of the hue ring - - An HSV color selector can be said to be adjusting if multiple rapid + + An HSV color selector can be said to be adjusting if multiple rapid changes are being made to its value, for example, when the user is adjusting the value with the mouse. This function queries whether the HSV color selector is being adjusted or not. - %TRUE if clients can ignore changes to the color value, + %TRUE if clients can ignore changes to the color value, since they may be transitory, or %FALSE if they should consider the color value status to be final. - A #GtkHSV + A #GtkHSV - Sets the current color in an HSV color selector. + Sets the current color in an HSV color selector. Color component values must be in the [0.0, 1.0] range. @@ -67811,58 +48557,40 @@ Color component values must be in the [0.0, 1.0] range. - An HSV color selector + An HSV color selector - Hue + Hue - Saturation + Saturation - Value + Value - - Sets the size and ring width of an HSV color selector. + + Sets the size and ring width of an HSV color selector. - An HSV color selector + An HSV color selector - Diameter for the hue ring + Diameter for the hue ring - Width of the hue ring + Width of the hue ring @@ -67889,9 +48617,7 @@ Color component values must be in the [0.0, 1.0] range. - + @@ -67961,81 +48687,52 @@ Color component values must be in the [0.0, 1.0] range. - + - + - - The #GtkHScale widget is used to allow the user to select a value using + + The #GtkHScale widget is used to allow the user to select a value using a horizontal slider. To create one, use gtk_hscale_new_with_range(). The position to show the current value, and the number of decimal places -shown can be set using the parent #GtkScale class’s functions. +shown can be set using the parent #GtkScale class’s functions. GtkHScale has been deprecated, use #GtkScale instead. - - Creates a new #GtkHScale. + + Creates a new #GtkHScale. Use gtk_scale_new() with %GTK_ORIENTATION_HORIZONTAL instead - a new #GtkHScale. + a new #GtkHScale. - - the #GtkAdjustment which sets the range of + + the #GtkAdjustment which sets the range of the scale. - - Creates a new horizontal scale widget that lets the user input a + + Creates a new horizontal scale widget that lets the user input a number between @min and @max (including @min and @max) with the -increment @step. @step must be nonzero; it’s the distance the +increment @step. @step must be nonzero; it’s the distance the slider moves when using the arrow keys to adjust the scale value. Note that the way in which the precision is derived works best if @step @@ -68044,28 +48741,20 @@ needs, use gtk_scale_set_digits() to correct it. Use gtk_scale_new_with_range() with %GTK_ORIENTATION_HORIZONTAL instead - a new #GtkHScale + a new #GtkHScale - minimum value + minimum value - maximum value + maximum value - step increment (tick size) used with keyboard shortcuts + step increment (tick size) used with keyboard shortcuts @@ -68074,24 +48763,14 @@ needs, use gtk_scale_set_digits() to correct it. - + - - The #GtkHScrollbar widget is a widget arranged horizontally creating a + + The #GtkHScrollbar widget is a widget arranged horizontally creating a scrollbar. See #GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be added to handle the adjustment of the scrollbar or it may be left %NULL in which case one @@ -68103,29 +48782,17 @@ GtkHScrollbar has been deprecated, use #GtkScrollbar instead. - - Creates a new horizontal scrollbar. + + Creates a new horizontal scrollbar. Use gtk_scrollbar_new() with %GTK_ORIENTATION_HORIZONTAL instead - the new #GtkHScrollbar + the new #GtkHScrollbar - - the #GtkAdjustment to use, or %NULL to create a new adjustment + + the #GtkAdjustment to use, or %NULL to create a new adjustment @@ -68134,24 +48801,14 @@ GtkHScrollbar has been deprecated, use #GtkScrollbar instead. - + - - The #GtkHSeparator widget is a horizontal separator, used to group the + + The #GtkHSeparator widget is a horizontal separator, used to group the widgets within a window. It displays a horizontal line with a shadow to make it appear sunken into the interface. @@ -68165,19 +48822,12 @@ GtkHSeparator has been deprecated, use #GtkSeparator instead. - - Creates a new #GtkHSeparator. + + Creates a new #GtkHSeparator. Use gtk_separator_new() with %GTK_ORIENTATION_HORIZONTAL instead - a new #GtkHSeparator. + a new #GtkHSeparator. @@ -68185,33 +48835,23 @@ GtkHSeparator has been deprecated, use #GtkSeparator instead. - + - - The #GtkHandleBox widget allows a portion of a window to be "torn + + The #GtkHandleBox widget allows a portion of a window to be "torn off". It is a bin widget which displays its child and a handle that -the user can drag to tear off a separate window (the “float -window”) containing the child widget. A thin -“ghost” is drawn in the original location of the +the user can drag to tear off a separate window (the “float +window”) containing the child widget. A thin +“ghost” is drawn in the original location of the handlebox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned -along one of the edges, the “snap edge”. +along one of the edges, the “snap edge”. This either can be specified by the application programmer explicitly, or GTK+ will pick a reasonable default based on the handle position. @@ -68230,19 +48870,12 @@ so the snap edge should be set to %GTK_POS_BOTTOM. - - Create a new handle box. + + Create a new handle box. #GtkHandleBox has been deprecated. - a new #GtkHandleBox. + a new #GtkHandleBox. @@ -68274,115 +48907,73 @@ so the snap edge should be set to %GTK_POS_BOTTOM. - - Whether the handlebox’s child is currently detached. + + Whether the handlebox’s child is currently detached. #GtkHandleBox has been deprecated. - %TRUE if the child is currently detached, otherwise %FALSE + %TRUE if the child is currently detached, otherwise %FALSE - a #GtkHandleBox + a #GtkHandleBox - - Gets the handle position of the handle box. See + + Gets the handle position of the handle box. See gtk_handle_box_set_handle_position(). #GtkHandleBox has been deprecated. - the current handle position. + the current handle position. - a #GtkHandleBox + a #GtkHandleBox - - Gets the type of shadow drawn around the handle box. See + + Gets the type of shadow drawn around the handle box. See gtk_handle_box_set_shadow_type(). #GtkHandleBox has been deprecated. - the type of shadow currently drawn around the handle box. + the type of shadow currently drawn around the handle box. - a #GtkHandleBox + a #GtkHandleBox - - Gets the edge used for determining reattachment of the handle box. + + Gets the edge used for determining reattachment of the handle box. See gtk_handle_box_set_snap_edge(). #GtkHandleBox has been deprecated. - the edge used for determining reattachment, or + the edge used for determining reattachment, or (GtkPositionType)-1 if this is determined (as per default) from the handle position. - a #GtkHandleBox + a #GtkHandleBox - - Sets the side of the handlebox where the handle is drawn. + + Sets the side of the handlebox where the handle is drawn. #GtkHandleBox has been deprecated. @@ -68390,26 +48981,17 @@ See gtk_handle_box_set_snap_edge(). - a #GtkHandleBox + a #GtkHandleBox - the side of the handlebox where the handle should be drawn. + the side of the handlebox where the handle should be drawn. - - Sets the type of shadow to be drawn around the border + + Sets the type of shadow to be drawn around the border of the handle box. #GtkHandleBox has been deprecated. @@ -68418,28 +49000,19 @@ of the handle box. - a #GtkHandleBox + a #GtkHandleBox - the shadow type. + the shadow type. - - Sets the snap edge of a handlebox. The snap edge is + + Sets the snap edge of a handlebox. The snap edge is the edge of the detached child that must be aligned -with the corresponding edge of the “ghost” left +with the corresponding edge of the “ghost” left behind when the child was detached to reattach the torn-off window. Usually, the snap edge should be chosen so that it stays in the same place on @@ -68457,15 +49030,11 @@ it will be %GTK_POS_LEFT. - a #GtkHandleBox + a #GtkHandleBox - the snap edge, or -1 to unset the value; in which + the snap edge, or -1 to unset the value; in which case GTK+ will try to guess an appropriate value in the future. @@ -68493,13 +49062,8 @@ it will be %GTK_POS_LEFT. - - This signal is emitted when the contents of the + + This signal is emitted when the contents of the handlebox are reattached to the main window. #GtkHandleBox has been deprecated. @@ -68507,22 +49071,15 @@ handlebox are reattached to the main window. - the child widget of the handlebox. + the child widget of the handlebox. (this argument provides no extra information and is here only for backwards-compatibility) - - This signal is emitted when the contents of the + + This signal is emitted when the contents of the handlebox are detached from the main window. #GtkHandleBox has been deprecated. @@ -68530,9 +49087,7 @@ handlebox are detached from the main window. - the child widget of the handlebox. + the child widget of the handlebox. (this argument provides no extra information and is here only for backwards-compatibility) @@ -68540,14 +49095,10 @@ handlebox are detached from the main window. - + - The parent class. + The parent class. @@ -68618,16 +49169,8 @@ handlebox are detached from the main window. - - GtkHeaderBar is similar to a horizontal #GtkBox. It allows children to + + GtkHeaderBar is similar to a horizontal #GtkBox. It allows children to be placed at the start or the end. In addition, it allows a title and subtitle to be displayed. The title will be centered with respect to the width of the box, even if the children at either side take up @@ -68646,165 +49189,109 @@ features typical of titlebars while allowing the addition of child widgets. - Creates a new #GtkHeaderBar widget. + Creates a new #GtkHeaderBar widget. - a new #GtkHeaderBar + a new #GtkHeaderBar - - Retrieves the custom title widget of the header. See + + Retrieves the custom title widget of the header. See gtk_header_bar_set_custom_title(). - the custom title widget + the custom title widget of the header, or %NULL if none has been set explicitly. - a #GtkHeaderBar + a #GtkHeaderBar - - Gets the decoration layout set with + + Gets the decoration layout set with gtk_header_bar_set_decoration_layout(). - the decoration layout + the decoration layout - a #GtkHeaderBar + a #GtkHeaderBar - - Retrieves whether the header bar reserves space for + + Retrieves whether the header bar reserves space for a subtitle, regardless if one is currently set or not. - %TRUE if the header bar reserves space + %TRUE if the header bar reserves space for a subtitle - a #GtkHeaderBar + a #GtkHeaderBar - - Returns whether this header bar shows the standard window + + Returns whether this header bar shows the standard window decorations. - %TRUE if the decorations are shown + %TRUE if the decorations are shown - a #GtkHeaderBar + a #GtkHeaderBar - - Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle(). + + Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle(). - the subtitle of the header, or %NULL if none has + the subtitle of the header, or %NULL if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed. - a #GtkHeaderBar + a #GtkHeaderBar - - Retrieves the title of the header. See gtk_header_bar_set_title(). + + Retrieves the title of the header. See gtk_header_bar_set_title(). - the title of the header, or %NULL if none has + the title of the header, or %NULL if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed. - a #GtkHeaderBar + a #GtkHeaderBar - - Adds @child to @bar, packed with reference to the + + Adds @child to @bar, packed with reference to the end of the @bar. @@ -68812,25 +49299,17 @@ end of the @bar. - A #GtkHeaderBar + A #GtkHeaderBar - the #GtkWidget to be added to @bar + the #GtkWidget to be added to @bar - - Adds @child to @bar, packed with reference to the + + Adds @child to @bar, packed with reference to the start of the @bar. @@ -68838,30 +49317,22 @@ start of the @bar. - A #GtkHeaderBar + A #GtkHeaderBar - the #GtkWidget to be added to @bar + the #GtkWidget to be added to @bar - - Sets a custom title for the #GtkHeaderBar. + + Sets a custom title for the #GtkHeaderBar. The title should help a user identify the current view. This supersedes any title set by gtk_header_bar_set_title() or gtk_header_bar_set_subtitle(). To achieve the same style as -the builtin title and subtitle, use the “title” and “subtitle” +the builtin title and subtitle, use the “title” and “subtitle” style classes. You should set the custom title to %NULL, for the header title @@ -68872,28 +49343,17 @@ label to be visible again. - a #GtkHeaderBar + a #GtkHeaderBar - - a custom widget to use for a title + + a custom widget to use for a title - - Sets the decoration layout for this header bar, overriding + + Sets the decoration layout for this header bar, overriding the #GtkSettings:gtk-decoration-layout setting. There can be valid reasons for overriding the setting, such @@ -68908,7 +49368,7 @@ from those on the right. Recognized button names are minimize, maximize, close, icon (the window icon) and menu (a menu button for the fallback app menu). -For example, “menu:minimize,maximize,close” specifies a menu +For example, “menu:minimize,maximize,close” specifies a menu on the left, and minimize, maximize and close buttons on the right. @@ -68916,29 +49376,18 @@ on the left, and minimize, maximize and close buttons on the right. - a #GtkHeaderBar + a #GtkHeaderBar - - a decoration layout, or %NULL to + + a decoration layout, or %NULL to unset the layout - - Sets whether the header bar should reserve space + + Sets whether the header bar should reserve space for a subtitle, even if none is currently set. @@ -68946,25 +49395,17 @@ for a subtitle, even if none is currently set. - a #GtkHeaderBar + a #GtkHeaderBar - %TRUE to reserve space for a subtitle + %TRUE to reserve space for a subtitle - - Sets whether this header bar shows the standard window decorations, + + Sets whether this header bar shows the standard window decorations, including close, maximize, and minimize. @@ -68972,25 +49413,17 @@ including close, maximize, and minimize. - a #GtkHeaderBar + a #GtkHeaderBar - %TRUE to show standard window decorations + %TRUE to show standard window decorations - - Sets the subtitle of the #GtkHeaderBar. The title should give a user + + Sets the subtitle of the #GtkHeaderBar. The title should give a user an additional detail to help him identify the current view. Note that GtkHeaderBar by default reserves room for the subtitle, @@ -69002,28 +49435,17 @@ even if none is currently set. If this is not desired, set the - a #GtkHeaderBar + a #GtkHeaderBar - - a subtitle, or %NULL + + a subtitle, or %NULL - - Sets the title of the #GtkHeaderBar. The title should help a user + + Sets the title of the #GtkHeaderBar. The title should help a user identify the current view. A good title should not include the application name. @@ -69032,18 +49454,11 @@ application name. - a #GtkHeaderBar + a #GtkHeaderBar - - a title, or %NULL + + a title, or %NULL @@ -69051,13 +49466,8 @@ application name. - - The decoration layout for buttons. If this property is + + The decoration layout for buttons. If this property is not set, the #GtkSettings:gtk-decoration-layout setting is used. @@ -69065,31 +49475,17 @@ See gtk_header_bar_set_decoration_layout() for information about the format of this string. - - Set to %TRUE if #GtkHeaderBar:decoration-layout is set. + + Set to %TRUE if #GtkHeaderBar:decoration-layout is set. - - If %TRUE, reserve space for a subtitle, even if none + + If %TRUE, reserve space for a subtitle, even if none is currently set. - - Whether to show window decorations. + + Whether to show window decorations. Which buttons are actually shown and where is determined by the #GtkHeaderBar:decoration-layout property, and by @@ -69110,36 +49506,23 @@ shown if the window can't be closed). - + - + - + - + - + @@ -69180,135 +49563,105 @@ shown if the window can't be closed). - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -69322,116 +49675,85 @@ shown if the window can't be closed). - + - + - + - + - + - + - + - + - + - + - + - - #GtkIMContext defines the interface for GTK+ input methods. An input method + + #GtkIMContext defines the interface for GTK+ input methods. An input method is used by GTK+ text input widgets like #GtkEntry to map from key events to Unicode character strings. @@ -69451,10 +49773,10 @@ output the composed result. This is called preediting, and an input method may provide feedback about this process by displaying the intermediate composition states as preedit text. For instance, the default GTK+ input method implements the input of arbitrary Unicode code points by holding down -the Control and Shift keys and then typing “U” followed by the hexadecimal +the Control and Shift keys and then typing “U” followed by the hexadecimal digits of the code point. When releasing the Control and Shift keys, preediting ends and the character is inserted as text. Ctrl+Shift+u20AC for -example results in the € sign. +example results in the € sign. Additional input methods can be made available for use by GTK+ widgets as loadable modules. An input method module is a small shared library which @@ -69513,9 +49835,7 @@ in order for the new input method to become available to GTK+ applications. - Asks the widget that the input context is attached to to delete + Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal. Note that @offset and @n_chars are in characters not in bytes which differs from the usage other @@ -69533,65 +49853,47 @@ subsitutions in the existing text in response to new input. It is not useful for applications. - %TRUE if the signal was handled. + %TRUE if the signal was handled. - a #GtkIMContext + a #GtkIMContext - offset from cursor position in chars; + offset from cursor position in chars; a negative value means start before the cursor. - number of characters to delete. + number of characters to delete. - Allow an input method to internally handle key press and release + Allow an input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a #GtkIMContext + a #GtkIMContext - the key event + the key event - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change. @@ -69601,17 +49903,13 @@ this change. - a #GtkIMContext + a #GtkIMContext - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change. @@ -69621,17 +49919,13 @@ state to reflect this change. - a #GtkIMContext + a #GtkIMContext - Retrieve the current preedit string for the input context, + Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point. @@ -69641,48 +49935,29 @@ point. - a #GtkIMContext + a #GtkIMContext - - location to store the retrieved + + location to store the retrieved string. The string retrieved must be freed with g_free(). - - location to store the retrieved + + location to store the retrieved attribute list. When you are done with this list, you must unreference it with pango_attr_list_unref(). - - location to store position of cursor (in characters) + + location to store position of cursor (in characters) within the preedit string. - Retrieves context around the insertion point. Input methods + Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed. @@ -69696,38 +49971,24 @@ for a widget to respond to the ::retrieve_surrounding signal, so input methods must be prepared to function without context. - %TRUE if surrounding text was provided; in this case + %TRUE if surrounding text was provided; in this case you must free the result stored in *text. - a #GtkIMContext + a #GtkIMContext - - location to store a UTF-8 encoded + + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - - location to store byte index of the insertion + + location to store byte index of the insertion cursor within @text. @@ -69767,9 +50028,7 @@ methods must be prepared to function without context. - Notify the input method that a change such as a change in cursor + Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state. @@ -69778,9 +50037,7 @@ method to clear the preedit state. - a #GtkIMContext + a #GtkIMContext @@ -69797,9 +50054,7 @@ method to clear the preedit state. - Set the client window for the input context; this is the + Set the client window for the input context; this is the #GdkWindow in which the input appears. This window is used in order to correctly position status windows, and may also be used for purposes internal to the input method. @@ -69809,27 +50064,18 @@ also be used for purposes internal to the input method. - a #GtkIMContext + a #GtkIMContext - - the client window. This may be %NULL to indicate + + the client window. This may be %NULL to indicate that the previous client window no longer exists. - Notify the input method that a change in cursor + Notify the input method that a change in cursor position has been made. The location is relative to the client window. @@ -69838,23 +50084,17 @@ window. - a #GtkIMContext + a #GtkIMContext - new location + new location - Sets surrounding context around the insertion point and preedit + Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the GtkIMContext::retrieve_surrounding signal, and will likely have no effect if called at other times. @@ -69864,37 +50104,27 @@ effect if called at other times. - a #GtkIMContext + a #GtkIMContext - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text. - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - Sets whether the IM context should use the preedit string + Sets whether the IM context should use the preedit string to display feedback. If @use_preedit is FALSE (default is TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window. @@ -69904,24 +50134,17 @@ feedback, such as displaying it in a child of the root window. - a #GtkIMContext + a #GtkIMContext - whether the IM context should use the preedit string. + whether the IM context should use the preedit string. - - Asks the widget that the input context is attached to to delete + + Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal. Note that @offset and @n_chars are in characters not in bytes which differs from the usage other @@ -69939,66 +50162,47 @@ subsitutions in the existing text in response to new input. It is not useful for applications. - %TRUE if the signal was handled. + %TRUE if the signal was handled. - a #GtkIMContext + a #GtkIMContext - offset from cursor position in chars; + offset from cursor position in chars; a negative value means start before the cursor. - number of characters to delete. + number of characters to delete. - - Allow an input method to internally handle key press and release + + Allow an input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a #GtkIMContext + a #GtkIMContext - the key event + the key event - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change. @@ -70008,17 +50212,13 @@ this change. - a #GtkIMContext + a #GtkIMContext - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change. @@ -70028,18 +50228,13 @@ state to reflect this change. - a #GtkIMContext + a #GtkIMContext - - Retrieve the current preedit string for the input context, + + Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point. @@ -70049,49 +50244,29 @@ point. - a #GtkIMContext + a #GtkIMContext - - location to store the retrieved + + location to store the retrieved string. The string retrieved must be freed with g_free(). - - location to store the retrieved + + location to store the retrieved attribute list. When you are done with this list, you must unreference it with pango_attr_list_unref(). - - location to store position of cursor (in characters) + + location to store position of cursor (in characters) within the preedit string. - - Retrieves context around the insertion point. Input methods + + Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed. @@ -70105,47 +50280,31 @@ for a widget to respond to the ::retrieve_surrounding signal, so input methods must be prepared to function without context. - %TRUE if surrounding text was provided; in this case + %TRUE if surrounding text was provided; in this case you must free the result stored in *text. - a #GtkIMContext + a #GtkIMContext - - location to store a UTF-8 encoded + + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - - location to store byte index of the insertion + + location to store byte index of the insertion cursor within @text. - Notify the input method that a change such as a change in cursor + Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state. @@ -70154,18 +50313,13 @@ method to clear the preedit state. - a #GtkIMContext + a #GtkIMContext - - Set the client window for the input context; this is the + + Set the client window for the input context; this is the #GdkWindow in which the input appears. This window is used in order to correctly position status windows, and may also be used for purposes internal to the input method. @@ -70175,28 +50329,18 @@ also be used for purposes internal to the input method. - a #GtkIMContext + a #GtkIMContext - - the client window. This may be %NULL to indicate + + the client window. This may be %NULL to indicate that the previous client window no longer exists. - - Notify the input method that a change in cursor + + Notify the input method that a change in cursor position has been made. The location is relative to the client window. @@ -70205,24 +50349,17 @@ window. - a #GtkIMContext + a #GtkIMContext - new location + new location - - Sets surrounding context around the insertion point and preedit + + Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the GtkIMContext::retrieve_surrounding signal, and will likely have no effect if called at other times. @@ -70232,38 +50369,27 @@ effect if called at other times. - a #GtkIMContext + a #GtkIMContext - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text. - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - - Sets whether the IM context should use the preedit string + + Sets whether the IM context should use the preedit string to display feedback. If @use_preedit is FALSE (default is TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window. @@ -70273,15 +50399,11 @@ feedback, such as displaying it in a child of the root window. - a #GtkIMContext + a #GtkIMContext - whether the IM context should use the preedit string. + whether the IM context should use the preedit string. @@ -70296,9 +50418,7 @@ feedback, such as displaying it in a child of the root window. - The ::commit signal is emitted when a complete input sequence + The ::commit signal is emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting. @@ -70306,45 +50426,33 @@ immediately after a key press or the final result of preediting. - the completed character(s) entered by the user + the completed character(s) entered by the user - The ::delete-surrounding signal is emitted when the input method + The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. - %TRUE if the signal was handled. + %TRUE if the signal was handled. - the character offset from the cursor position of the text + the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor. - the number of characters to be deleted + the number of characters to be deleted - The ::preedit-changed signal is emitted whenever the preedit sequence + The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case gtk_im_context_get_preedit_string() returns the empty string. @@ -70353,41 +50461,31 @@ gtk_im_context_get_preedit_string() returns the empty string. - The ::preedit-end signal is emitted when a preediting sequence + The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled. - The ::preedit-start signal is emitted when a new preediting sequence + The ::preedit-start signal is emitted when a new preediting sequence starts. - The ::retrieve-surrounding signal is emitted when the input method + The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor. The callback should set the input method surrounding context by calling the gtk_im_context_set_surrounding() method. - %TRUE if the signal was handled. + %TRUE if the signal was handled. - + @@ -70464,29 +50562,21 @@ gtk_im_context_set_surrounding() method. - %TRUE if the signal was handled. + %TRUE if the signal was handled. - a #GtkIMContext + a #GtkIMContext - offset from cursor position in chars; + offset from cursor position in chars; a negative value means start before the cursor. - number of characters to delete. + number of characters to delete. @@ -70500,18 +50590,11 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext - - the client window. This may be %NULL to indicate + + the client window. This may be %NULL to indicate that the previous client window no longer exists. @@ -70526,39 +50609,22 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext - - location to store the retrieved + + location to store the retrieved string. The string retrieved must be freed with g_free(). - - location to store the retrieved + + location to store the retrieved attribute list. When you are done with this list, you must unreference it with pango_attr_list_unref(). - - location to store position of cursor (in characters) + + location to store position of cursor (in characters) within the preedit string. @@ -70569,22 +50635,16 @@ gtk_im_context_set_surrounding() method. - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a #GtkIMContext + a #GtkIMContext - the key event + the key event @@ -70598,9 +50658,7 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext @@ -70614,9 +50672,7 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext @@ -70630,9 +50686,7 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext @@ -70646,15 +50700,11 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext - new location + new location @@ -70668,15 +50718,11 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext - whether the IM context should use the preedit string. + whether the IM context should use the preedit string. @@ -70690,29 +50736,21 @@ gtk_im_context_set_surrounding() method. - a #GtkIMContext + a #GtkIMContext - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text. - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. @@ -70722,38 +50760,24 @@ gtk_im_context_set_surrounding() method. - %TRUE if surrounding text was provided; in this case + %TRUE if surrounding text was provided; in this case you must free the result stored in *text. - a #GtkIMContext + a #GtkIMContext - - location to store a UTF-8 encoded + + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - - location to store byte index of the insertion + + location to store byte index of the insertion cursor within @text. @@ -70810,52 +50834,32 @@ gtk_im_context_set_surrounding() method. - Bookkeeping information about a loadable input method. + Bookkeeping information about a loadable input method. - The unique identification string of the input method. + The unique identification string of the input method. - The human-readable name of the input method. + The human-readable name of the input method. - Translation domain to be used with dgettext() + Translation domain to be used with dgettext() - Name of locale directory for use with bindtextdomain() + Name of locale directory for use with bindtextdomain() - A colon-separated list of locales where this input method - should be the default. The asterisk “*” sets the default for all locales. + A colon-separated list of locales where this input method + should be the default. The asterisk “*” sets the default for all locales. - - GtkIMContextSimple is a simple input method context supporting table-based + + GtkIMContextSimple is a simple input method context supporting table-based input methods. It has a built-in table of compose sequences that is derived from the X11 Compose files. @@ -70865,44 +50869,40 @@ following files that is found: ~/.config/gtk-3.0/Compose, ~/.XCompose, Compose file). The syntax of these files is described in the Compose(5) manual page. +## Unicode characters + GtkIMContextSimple also supports numeric entry of Unicode characters by typing Ctrl-Shift-u, followed by a hexadecimal Unicode codepoint. For example, Ctrl-Shift-u 1 2 3 Enter yields U+0123 LATIN SMALL LETTER -G WITH CEDILLA, i.e. ģ. +G WITH CEDILLA, i.e. ģ. - Creates a new #GtkIMContextSimple. + Creates a new #GtkIMContextSimple. - a new #GtkIMContextSimple. + a new #GtkIMContextSimple. - + + Adds an additional table from the X11 compose file. + A #GtkIMContextSimple + The path of compose file - - Adds an additional table to search to the input context. + + Adds an additional table to search to the input context. Each row of the table consists of @max_seq_len key symbols followed by two #guint16 interpreted as the high and low words of a #gunicode value. Tables are searched starting @@ -70917,30 +50917,21 @@ the length of the sequence should be zero.) - A #GtkIMContextSimple + A #GtkIMContextSimple - the table + the table - Maximum length of a sequence in the table - (cannot be greater than #GTK_MAX_COMPOSE_LEN) + Maximum length of a sequence in the table - number of sequences in the table + number of sequences in the table @@ -70949,50 +50940,30 @@ the length of the sequence should be zero.) - + - + - + - + - Creates a new #GtkIMMulticontext. + Creates a new #GtkIMMulticontext. - a new #GtkIMMulticontext. + a new #GtkIMMulticontext. - - Add menuitems for various available input methods to a menu; + + Add menuitems for various available input methods to a menu; the menuitems, when selected, will switch the input method for the context and the global default input method. It is better to use the system-wide input @@ -71005,47 +50976,31 @@ for the context and the global default input method. - a #GtkIMMulticontext + a #GtkIMMulticontext - a #GtkMenuShell + a #GtkMenuShell - - Gets the id of the currently active slave of the @context. + + Gets the id of the currently active slave of the @context. - the id of the currently active slave + the id of the currently active slave - a #GtkIMMulticontext + a #GtkIMMulticontext - - Sets the context id for @context. + + Sets the context id for @context. This causes the currently active slave of @context to be replaced by the slave corresponding to the new context id. @@ -71055,15 +51010,11 @@ replaced by the slave corresponding to the new context id. - a #GtkIMMulticontext + a #GtkIMMulticontext - the id to use + the id to use @@ -71075,9 +51026,7 @@ replaced by the slave corresponding to the new context id. - + @@ -71115,183 +51064,113 @@ replaced by the slave corresponding to the new context id. - + - - Style for input method preedit. See also + + Style for input method preedit. See also #GtkSettings:gtk-im-preedit-style - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Style for input method status. See also + + Style for input method status. See also #GtkSettings:gtk-im-status-style - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - + - + - + - + - + - + - + - + - + - + - + - + @@ -71299,412 +51178,320 @@ replaced by the slave corresponding to the new context id. - Constant to return from a signal handler for the #GtkSpinButton::input + Constant to return from a signal handler for the #GtkSpinButton::input signal in case of conversion failure. - - Like gtk_get_interface_age(), but from the headers used at + + Like gtk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -71718,30 +51505,22 @@ against at application run time. - + - - + + - - + + @@ -71754,1602 +51533,1253 @@ against at application run time. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -73363,2994 +52793,2302 @@ against at application run time. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - - + + - - + + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a + + An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a set of variants of a particular icon (i.e. a #GtkIconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each #GtkStyle has a list of #GtkIconFactory derived from the current theme; those icon factories -are consulted first when searching for an icon. If the theme doesn’t set a +are consulted first when searching for an icon. If the theme doesn’t set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by gtk_icon_factory_add_default() and gtk_icon_factory_remove_default(). Applications with icons should add a default @@ -76417,20 +55155,15 @@ multiple <source> elements. The following attributes are allowed: ]| - - Creates a new #GtkIconFactory. An icon factory manages a collection + + Creates a new #GtkIconFactory. An icon factory manages a collection of #GtkIconSets; a #GtkIconSet manages a set of variants of a particular icon (i.e. a #GtkIconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each #GtkStyle has a list of #GtkIconFactorys derived from the current theme; those icon factories are consulted first when searching for -an icon. If the theme doesn’t set a particular icon, GTK+ looks for +an icon. If the theme doesn’t set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by gtk_icon_factory_add_default() and gtk_icon_factory_remove_default(). Applications with icons should @@ -76439,19 +55172,12 @@ themes to override the icons for the application. Use #GtkIconTheme instead. - a new #GtkIconFactory + a new #GtkIconFactory - - Looks for an icon in the list of default icon factories. For + + Looks for an icon in the list of default icon factories. For display to the user, you should use gtk_style_lookup_icon_set() on the #GtkStyle for the widget that will display the icon, instead of using this function directly, so that themes are taken into @@ -76459,34 +55185,25 @@ account. Use #GtkIconTheme instead. - a #GtkIconSet, or %NULL + a #GtkIconSet, or %NULL - an icon name + an icon name - - Adds the given @icon_set to the icon factory, under the name + + Adds the given @icon_set to the icon factory, under the name @stock_id. @stock_id should be namespaced for your application, -e.g. “myapp-whatever-icon”. Normally applications create a +e.g. “myapp-whatever-icon”. Normally applications create a #GtkIconFactory, then add it to the list of default factories with gtk_icon_factory_add_default(). Then they pass the @stock_id to widgets such as #GtkImage to display the icon. Themes can provide an icon with the same name (such as "myapp-whatever-icon") to -override your application’s default icons. If an icon already +override your application’s default icons. If an icon already existed in @factory for @stock_id, it is unreferenced and replaced with the new @icon_set. Use #GtkIconTheme instead. @@ -76496,32 +55213,21 @@ with the new @icon_set. - a #GtkIconFactory + a #GtkIconFactory - icon name + icon name - icon set + icon set - - Adds an icon factory to the list of icon factories searched by + + Adds an icon factory to the list of icon factories searched by gtk_style_lookup_icon_set(). This means that, for example, gtk_image_new_from_stock() will be able to find icons in @factory. There will normally be an icon factory added for each library or @@ -76534,20 +55240,13 @@ can be overridden by themes. - a #GtkIconFactory + a #GtkIconFactory - - Looks up @stock_id in the icon factory, returning an icon set + + Looks up @stock_id in the icon factory, returning an icon set if found, otherwise %NULL. For display to the user, you should use gtk_style_lookup_icon_set() on the #GtkStyle for the widget that will display the icon, instead of using this @@ -76555,33 +55254,22 @@ function directly, so that themes are taken into account. Use #GtkIconTheme instead. - icon set of @stock_id. + icon set of @stock_id. - a #GtkIconFactory + a #GtkIconFactory - an icon name + an icon name - - Removes an icon factory from the list of default icon + + Removes an icon factory from the list of default icon factories. Not normally used; you might use it for a library that can be unloaded or shut down. Use #GtkIconTheme instead. @@ -76591,9 +55279,7 @@ can be unloaded or shut down. - a #GtkIconFactory previously added with gtk_icon_factory_add_default() + a #GtkIconFactory previously added with gtk_icon_factory_add_default() @@ -76605,20 +55291,15 @@ can be unloaded or shut down. - + - The parent class. + The parent class. - + @@ -76626,8 +55307,7 @@ can be unloaded or shut down. - + @@ -76635,8 +55315,7 @@ can be unloaded or shut down. - + @@ -76644,94 +55323,55 @@ can be unloaded or shut down. - + - + - - Contains information found when looking up an icon in + + Contains information found when looking up an icon in an icon theme. - - Creates a #GtkIconInfo for a #GdkPixbuf. + + Creates a #GtkIconInfo for a #GdkPixbuf. - a #GtkIconInfo + a #GtkIconInfo - a #GtkIconTheme + a #GtkIconTheme - the pixbuf to wrap in a #GtkIconInfo + the pixbuf to wrap in a #GtkIconInfo - - Make a copy of a #GtkIconInfo. + + Make a copy of a #GtkIconInfo. Use g_object_ref() - the new GtkIconInfo + the new GtkIconInfo - a #GtkIconInfo + a #GtkIconInfo - - Free a #GtkIconInfo and associated information + + Free a #GtkIconInfo and associated information Use g_object_unref() @@ -76739,96 +55379,58 @@ an icon theme. - a #GtkIconInfo + a #GtkIconInfo - - This function is deprecated and always returns %FALSE. + + This function is deprecated and always returns %FALSE. Attachment points are deprecated - %FALSE + %FALSE - a #GtkIconInfo + a #GtkIconInfo - - location to store pointer + + location to store pointer to an array of points, or %NULL free the array of points with g_free(). - - location to store the number of points in @points, + + location to store the number of points in @points, or %NULL - - Gets the base scale for the icon. The base scale is a scale + + Gets the base scale for the icon. The base scale is a scale for the icon that was specified by the icon theme creator. For instance an icon drawn for a high-dpi screen with window scale 2 for a base size of 32 will be 64 pixels tall and have a base scale of 2. - the base scale + the base scale - a #GtkIconInfo + a #GtkIconInfo - - Gets the base size for the icon. The base size + + Gets the base size for the icon. The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of @@ -76841,38 +55443,26 @@ Note that for scaled icons the base size does not include the base scale. - the base size, or 0, if no base + the base size, or 0, if no base size is known for the icon. - a #GtkIconInfo + a #GtkIconInfo - - Gets the built-in image for this icon, if any. To allow GTK+ to use + + Gets the built-in image for this icon, if any. To allow GTK+ to use built in icon images, you must pass the %GTK_ICON_LOOKUP_USE_BUILTIN to gtk_icon_theme_lookup_icon(). This function is deprecated, use gtk_icon_theme_add_resource_path() instead of builtin icons. - the built-in image pixbuf, or %NULL. + the built-in image pixbuf, or %NULL. No extra reference is added to the returned pixbuf, so if you want to keep it around, you must use g_object_ref(). The returned image must not be modified. @@ -76880,88 +55470,55 @@ to gtk_icon_theme_lookup_icon(). - a #GtkIconInfo + a #GtkIconInfo - - This function is deprecated and always returns %NULL. + + This function is deprecated and always returns %NULL. Display names are deprecated - %NULL + %NULL - a #GtkIconInfo + a #GtkIconInfo - - This function is deprecated and always returns %FALSE. + + This function is deprecated and always returns %FALSE. Embedded rectangles are deprecated - %FALSE + %FALSE - a #GtkIconInfo + a #GtkIconInfo - - #GdkRectangle in which to store embedded + + #GdkRectangle in which to store embedded rectangle coordinates; coordinates are only stored when this function returns %TRUE. - - Gets the filename for the icon. If the %GTK_ICON_LOOKUP_USE_BUILTIN + + Gets the filename for the icon. If the %GTK_ICON_LOOKUP_USE_BUILTIN flag was passed to gtk_icon_theme_lookup_icon(), there may be no filename if a builtin icon is returned; in this case, you should use gtk_icon_info_get_builtin_pixbuf(). - the filename for the icon, or %NULL + the filename for the icon, or %NULL if gtk_icon_info_get_builtin_pixbuf() should be used instead. The return value is owned by GTK+ and should not be modified or freed. @@ -76969,44 +55526,29 @@ use gtk_icon_info_get_builtin_pixbuf(). - a #GtkIconInfo + a #GtkIconInfo - - Checks if the icon is symbolic or not. This currently uses only + + Checks if the icon is symbolic or not. This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future. - %TRUE if the icon is symbolic, %FALSE otherwise + %TRUE if the icon is symbolic, %FALSE otherwise - a #GtkIconInfo + a #GtkIconInfo - - Renders an icon previously looked up in an icon theme using + + Renders an icon previously looked up in an icon theme using gtk_icon_theme_lookup_icon(); the size will be based on the size passed to gtk_icon_theme_lookup_icon(). Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons @@ -77019,9 +55561,7 @@ the #GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size. - the rendered icon; this may be a newly + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release your reference to the icon. @@ -77029,19 +55569,13 @@ returned by this function will be scaled to the exact size. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - - Asynchronously load, render and scale an icon previously looked up + + Asynchronously load, render and scale an icon previously looked up from the icon theme using gtk_icon_theme_lookup_icon(). For more details, see gtk_icon_info_load_icon() which is the synchronous @@ -77052,55 +55586,29 @@ version of this call. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - - optional #GCancellable object, %NULL to ignore + + optional #GCancellable object, %NULL to ignore - - a #GAsyncReadyCallback to call when the + + a #GAsyncReadyCallback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an async icon load, see gtk_icon_info_load_icon_async(). + + Finishes an async icon load, see gtk_icon_info_load_icon_async(). - the rendered icon; this may be a newly + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release your reference to the icon. @@ -77108,26 +55616,17 @@ version of this call. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - a #GAsyncResult + a #GAsyncResult - - Renders an icon previously looked up in an icon theme using + + Renders an icon previously looked up in an icon theme using gtk_icon_theme_lookup_icon(); the size will be based on the size passed to gtk_icon_theme_lookup_icon(). Note that the resulting surface may not be exactly this size; an icon theme may have icons @@ -77140,9 +55639,7 @@ the #GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size. - the rendered icon; this may be a newly + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use cairo_surface_destroy() to release your reference to the icon. @@ -77150,29 +55647,17 @@ returned by this function will be scaled to the exact size. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - - #GdkWindow to optimize drawing for, or %NULL + + #GdkWindow to optimize drawing for, or %NULL - - Loads an icon, modifying it to match the system colours for the foreground, + + Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk_icon_info_load_icon(). @@ -77182,83 +55667,51 @@ Unless you are implementing a widget, you will want to use g_themed_icon_new_with_default_fallbacks() to load the icon. As implementation details, the icon loaded needs to be of SVG type, -contain the “symbolic” term as the last component of the icon name, -and use the “fg”, “success”, “warning” and “error” CSS styles in the +contain the “symbolic” term as the last component of the icon name, +and use the “fg”, “success”, “warning” and “error” CSS styles in the SVG file itself. See the [Symbolic Icons Specification](http://www.freedesktop.org/wiki/SymbolicIcons) for more information about symbolic icons. - a #GdkPixbuf representing the loaded icon + a #GdkPixbuf representing the loaded icon - a #GtkIconInfo + a #GtkIconInfo - a #GdkRGBA representing the foreground color of the icon + a #GdkRGBA representing the foreground color of the icon - - a #GdkRGBA representing the warning color + + a #GdkRGBA representing the warning color of the icon or %NULL to use the default color - - a #GdkRGBA representing the warning color + + a #GdkRGBA representing the warning color of the icon or %NULL to use the default color - - a #GdkRGBA representing the error color + + a #GdkRGBA representing the error color of the icon or %NULL to use the default color (allow-none) - - a #gboolean, returns whether the + + a #gboolean, returns whether the loaded icon was a symbolic one and whether the @fg color was applied to it. - - Asynchronously load, render and scale a symbolic icon previously looked up + + Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using gtk_icon_theme_lookup_icon(). For more details, see gtk_icon_info_load_symbolic() which is the synchronous @@ -77269,92 +55722,49 @@ version of this call. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - a #GdkRGBA representing the foreground color of the icon + a #GdkRGBA representing the foreground color of the icon - - a #GdkRGBA representing the warning color + + a #GdkRGBA representing the warning color of the icon or %NULL to use the default color - - a #GdkRGBA representing the warning color + + a #GdkRGBA representing the warning color of the icon or %NULL to use the default color - - a #GdkRGBA representing the error color + + a #GdkRGBA representing the error color of the icon or %NULL to use the default color (allow-none) - - optional #GCancellable object, + + optional #GCancellable object, %NULL to ignore - - a #GAsyncReadyCallback to call when the + + a #GAsyncReadyCallback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an async icon load, see gtk_icon_info_load_symbolic_async(). + + Finishes an async icon load, see gtk_icon_info_load_symbolic_async(). - the rendered icon; this may be a newly + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release your reference to the icon. @@ -77362,43 +55772,27 @@ version of this call. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - a #GAsyncResult + a #GAsyncResult - - a #gboolean, returns whether the + + a #gboolean, returns whether the loaded icon was a symbolic one and whether the @fg color was applied to it. - - Loads an icon, modifying it to match the system colors for the foreground, + + Loads an icon, modifying it to match the system colors for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk_icon_info_load_icon(). This function uses the regular foreground color and the symbolic colors -with the names “success_color”, “warning_color” and “error_color” from +with the names “success_color”, “warning_color” and “error_color” from the context. This allows loading symbolic icons that will match the system theme. @@ -77406,45 +55800,28 @@ This allows loading symbolic icons that will match the system theme. See gtk_icon_info_load_symbolic() for more details. - a #GdkPixbuf representing the loaded icon + a #GdkPixbuf representing the loaded icon - a #GtkIconInfo + a #GtkIconInfo - a #GtkStyleContext + a #GtkStyleContext - - a #gboolean, returns whether the + + a #gboolean, returns whether the loaded icon was a symbolic one and whether the @fg color was applied to it. - - Asynchronously load, render and scale a symbolic icon previously + + Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using gtk_icon_theme_lookup_icon(). For more details, see gtk_icon_info_load_symbolic_for_context() @@ -77455,62 +55832,34 @@ which is the synchronous version of this call. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - a #GtkStyleContext + a #GtkStyleContext - - optional #GCancellable object, + + optional #GCancellable object, %NULL to ignore - - a #GAsyncReadyCallback to call when the + + a #GAsyncReadyCallback to call when the request is satisfied - - the data to pass to callback function + + the data to pass to callback function - - Finishes an async icon load, see gtk_icon_info_load_symbolic_for_context_async(). + + Finishes an async icon load, see gtk_icon_info_load_symbolic_for_context_async(). - the rendered icon; this may be a newly + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release your reference to the icon. @@ -77518,41 +55867,23 @@ which is the synchronous version of this call. - a #GtkIconInfo from gtk_icon_theme_lookup_icon() + a #GtkIconInfo from gtk_icon_theme_lookup_icon() - a #GAsyncResult + a #GAsyncResult - - a #gboolean, returns whether the + + a #gboolean, returns whether the loaded icon was a symbolic one and whether the @fg color was applied to it. - - Loads an icon, modifying it to match the system colours for the foreground, + + Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk_icon_info_load_icon(). @@ -77562,53 +55893,32 @@ See gtk_icon_info_load_symbolic() for more details. Use gtk_icon_info_load_symbolic_for_context() instead - a #GdkPixbuf representing the loaded icon + a #GdkPixbuf representing the loaded icon - a #GtkIconInfo + a #GtkIconInfo - a #GtkStyle to take the colors from + a #GtkStyle to take the colors from - the widget state to use for colors + the widget state to use for colors - - a #gboolean, returns whether the + + a #gboolean, returns whether the loaded icon was a symbolic one and whether the @fg color was applied to it. - - Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect() + + Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect() and gtk_icon_info_get_attach_points() should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by gtk_icon_info_load_icon(). @@ -77618,7 +55928,7 @@ respect to the unscaled pixmap for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to the final size of the icon. You can determine if the icon is an SVG icon by using gtk_icon_info_get_filename(), and seeing if it is non-%NULL -and ends in “.svg”. +and ends in “.svg”. This function is provided primarily to allow compatibility wrappers for older API's, and is not expected to be useful for applications. @@ -77629,15 +55939,11 @@ for older API's, and is not expected to be useful for applications. - a #GtkIconInfo + a #GtkIconInfo - whether the coordinates of embedded rectangles + whether the coordinates of embedded rectangles and attached points should be returned in their original (unscaled) form. @@ -77645,173 +55951,93 @@ for older API's, and is not expected to be useful for applications. - + - - Used to specify options for gtk_icon_theme_lookup_icon() - - Never get SVG icons, even if gdk-pixbuf + + Used to specify options for gtk_icon_theme_lookup_icon() + + Never get SVG icons, even if gdk-pixbuf supports them. Cannot be used together with %GTK_ICON_LOOKUP_FORCE_SVG. - - Get SVG icons, even if gdk-pixbuf - doesn’t support them. + + Get SVG icons, even if gdk-pixbuf + doesn’t support them. Cannot be used together with %GTK_ICON_LOOKUP_NO_SVG. - - When passed to + + When passed to gtk_icon_theme_lookup_icon() includes builtin icons as well as files. For a builtin icon, gtk_icon_info_get_filename() is %NULL and you need to call gtk_icon_info_get_builtin_pixbuf(). - - Try to shorten icon name at '-' + + Try to shorten icon name at '-' characters before looking at inherited themes. This flag is only supported in functions that take a single icon name. For more general fallback, see gtk_icon_theme_choose_icon(). Since 2.12. - - Always get the icon scaled to the + + Always get the icon scaled to the requested size. Since 2.14. - - Try to always load regular icons, even + + Try to always load regular icons, even when symbolic icon names are given. Since 3.14. - - Try to always load symbolic icons, even + + Try to always load symbolic icons, even when regular icon names are given. Since 3.14. - - Try to load a variant of the icon for left-to-right + + Try to load a variant of the icon for left-to-right text direction. Since 3.14. - - Try to load a variant of the icon for right-to-left + + Try to load a variant of the icon for right-to-left text direction. Since 3.14. - + - - Creates a new #GtkIconSet. A #GtkIconSet represents a single icon + + Creates a new #GtkIconSet. A #GtkIconSet represents a single icon in various sizes and widget states. It can provide a #GdkPixbuf for a given size and state on request, and automatically caches some of the rendered #GdkPixbuf objects. Normally you would use gtk_widget_render_icon_pixbuf() instead of -using #GtkIconSet directly. The one case where you’d use +using #GtkIconSet directly. The one case where you’d use #GtkIconSet is to create application-specific icon sets to place in a #GtkIconFactory. Use #GtkIconTheme instead. - + - a new #GtkIconSet + a new #GtkIconSet - - Creates a new #GtkIconSet with @pixbuf as the default/fallback -source image. If you don’t add any additional #GtkIconSource to the + + Creates a new #GtkIconSet with @pixbuf as the default/fallback +source image. If you don’t add any additional #GtkIconSource to the icon set, all variants of the icon will be created from @pixbuf, using scaling, pixelation, etc. as required to adjust the icon size or make the icon look insensitive/prelighted. Use #GtkIconTheme instead. - + - a new #GtkIconSet + a new #GtkIconSet - a #GdkPixbuf + a #GdkPixbuf - - Icon sets have a list of #GtkIconSource, which they use as base + + Icon sets have a list of #GtkIconSource, which they use as base icons for rendering icons in different states and sizes. Icons are scaled, made to look insensitive, etc. in gtk_icon_set_render_icon(), but #GtkIconSet needs base images to @@ -77821,14 +56047,14 @@ a #GtkIconSource. This function copies @source, so you can reuse the same source immediately without affecting the icon set. -An example of when you’d use this function: a web browser’s "Back +An example of when you’d use this function: a web browser’s "Back to Previous Page" icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon, and you might add a separate source for each one. -You should nearly always add a “default” icon source with all +You should nearly always add a “default” icon source with all fields wildcarded, which will be used as a fallback if no more specific source matches. #GtkIconSet always prefers more specific icon sources to more generic icon sources. The order in which you @@ -77837,642 +56063,384 @@ add the sources to the icon set does not matter. gtk_icon_set_new_from_pixbuf() creates a new icon set with a default icon source based on the given pixbuf. Use #GtkIconTheme instead. - + - a #GtkIconSet + a #GtkIconSet - a #GtkIconSource + a #GtkIconSource - - Copies @icon_set by value. + + Copies @icon_set by value. Use #GtkIconTheme instead. - + - a new #GtkIconSet identical to the first. + a new #GtkIconSet identical to the first. - a #GtkIconSet + a #GtkIconSet - - Obtains a list of icon sizes this icon set can render. The returned + + Obtains a list of icon sizes this icon set can render. The returned array must be freed with g_free(). Use #GtkIconTheme instead. - + - a #GtkIconSet + a #GtkIconSet - - return location + + return location for array of sizes (#GtkIconSize) - + - - location to store number of elements in returned array + + location to store number of elements in returned array - - Increments the reference count on @icon_set. + + Increments the reference count on @icon_set. Use #GtkIconTheme instead. - + - @icon_set. + @icon_set. - a #GtkIconSet. + a #GtkIconSet. - - Renders an icon using gtk_style_render_icon(). In most cases, + + Renders an icon using gtk_style_render_icon(). In most cases, gtk_widget_render_icon() is better, since it automatically provides most of the arguments from the current widget settings. This -function never returns %NULL; if the icon can’t be rendered +function never returns %NULL; if the icon can’t be rendered (perhaps because an image file fails to load), a default "missing image" icon will be returned instead. Use gtk_icon_set_render_icon_pixbuf() instead - + - a #GdkPixbuf to be displayed + a #GdkPixbuf to be displayed - a #GtkIconSet + a #GtkIconSet - - a #GtkStyle associated with @widget, or %NULL + + a #GtkStyle associated with @widget, or %NULL - text direction + text direction - widget state + widget state - icon size (#GtkIconSize). A size of `(GtkIconSize)-1` - means render at the size of the source and don’t scale. - + icon size (#GtkIconSize). A size of `(GtkIconSize)-1` + means render at the size of the source and don’t scale. + - - widget that will display the icon, or %NULL. + + widget that will display the icon, or %NULL. The only use that is typically made of this is to determine the appropriate #GdkScreen. - - detail to pass to the theme engine, or %NULL. + + detail to pass to the theme engine, or %NULL. Note that passing a detail of anything but %NULL will disable caching. - - Renders an icon using gtk_render_icon_pixbuf(). In most cases, + + Renders an icon using gtk_render_icon_pixbuf(). In most cases, gtk_widget_render_icon_pixbuf() is better, since it automatically provides most of the arguments from the current widget settings. This -function never returns %NULL; if the icon can’t be rendered +function never returns %NULL; if the icon can’t be rendered (perhaps because an image file fails to load), a default "missing image" icon will be returned instead. Use #GtkIconTheme instead. - a #GdkPixbuf to be displayed + a #GdkPixbuf to be displayed - a #GtkIconSet + a #GtkIconSet - a #GtkStyleContext + a #GtkStyleContext - icon size (#GtkIconSize). A size of `(GtkIconSize)-1` - means render at the size of the source and don’t scale. - + icon size (#GtkIconSize). A size of `(GtkIconSize)-1` + means render at the size of the source and don’t scale. + - - Renders an icon using gtk_render_icon_pixbuf() and converts it to a + + Renders an icon using gtk_render_icon_pixbuf() and converts it to a cairo surface. -This function never returns %NULL; if the icon can’t be rendered +This function never returns %NULL; if the icon can’t be rendered (perhaps because an image file fails to load), a default "missing image" icon will be returned instead. Use #GtkIconTheme instead. - a #cairo_surface_t to be displayed + a #cairo_surface_t to be displayed - a #GtkIconSet + a #GtkIconSet - a #GtkStyleContext + a #GtkStyleContext - icon size (#GtkIconSize). A size of `(GtkIconSize)-1` - means render at the size of the source and don’t scale. - + icon size (#GtkIconSize). A size of `(GtkIconSize)-1` + means render at the size of the source and don’t scale. + - the window scale to render for + the window scale to render for - - #GdkWindow to optimize drawing for, or %NULL + + #GdkWindow to optimize drawing for, or %NULL - - Decrements the reference count on @icon_set, and frees memory + + Decrements the reference count on @icon_set, and frees memory if the reference count reaches 0. Use #GtkIconTheme instead. - + - a #GtkIconSet + a #GtkIconSet - - Built-in stock icon sizes. - - Invalid size. + + Built-in stock icon sizes. + + Invalid size. - - Size appropriate for menus (16px). + + Size appropriate for menus (16px). - - Size appropriate for small toolbars (16px). + + Size appropriate for small toolbars (16px). - - Size appropriate for large toolbars (24px) + + Size appropriate for large toolbars (24px) - - Size appropriate for buttons (16px) + + Size appropriate for buttons (16px) - - Size appropriate for drag and drop (32px) + + Size appropriate for drag and drop (32px) - - Size appropriate for dialogs (48px) + + Size appropriate for dialogs (48px) - - Looks up the icon size associated with @name. + + Looks up the icon size associated with @name. Use #GtkIconTheme instead. - + - the icon size (#GtkIconSize) - + the icon size (#GtkIconSize) + - the name to look up. + the name to look up. - - Gets the canonical name of the given icon size. The returned string + + Gets the canonical name of the given icon size. The returned string is statically allocated and should not be freed. Use #GtkIconTheme instead. - + - the name of the given icon size. + the name of the given icon size. - a #GtkIconSize. - + a #GtkIconSize. + - Obtains the pixel size of a semantic icon size @size: + Obtains the pixel size of a semantic icon size @size: #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function -isn’t normally needed, gtk_icon_theme_load_icon() is the usual +isn’t normally needed, gtk_icon_theme_load_icon() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by gtk_icon_size_lookup(), because themes are free to render the pixbuf however they like, including changing the usual size. - + - %TRUE if @size was a valid size + %TRUE if @size was a valid size - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - location to store icon width + + location to store icon width - - location to store icon height + + location to store icon height - - Obtains the pixel size of a semantic icon size, possibly + + Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular #GtkSettings. Normally @size would be #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function -isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual +isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by gtk_icon_size_lookup(), because themes are free to render the pixbuf however they like, including changing the usual size. Use gtk_icon_size_lookup() instead. - + - %TRUE if @size was a valid size + %TRUE if @size was a valid size - a #GtkSettings object, used to determine + a #GtkSettings object, used to determine which set of user preferences to used. - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - location to store icon width + + location to store icon width - - location to store icon height + + location to store icon height - - Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU, + + Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU, etc. Returns the integer value for the size. Use #GtkIconTheme instead. - + - integer value representing the size (#GtkIconSize) - + integer value representing the size (#GtkIconSize) + - name of the icon size + name of the icon size - the icon width + the icon width - the icon height + the icon height - - Registers @alias as another name for @target. + + Registers @alias as another name for @target. So calling gtk_icon_size_from_name() with @alias as argument will return @target. Use #GtkIconTheme instead. - + - an alias for @target + an alias for @target - an existing icon size (#GtkIconSize) - + an existing icon size (#GtkIconSize) + - + - - Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or + + Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or image filename) that serves as the base image for one or more of the icons in a #GtkIconSet, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains -a set of icons that represent “the same” logical concept in different states, +a set of icons that represent “the same” logical concept in different states, different global text directions, and different sizes. -So for example a web browser’s “Back to Previous Page” icon might +So for example a web browser’s “Back to Previous Page” icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would @@ -78487,184 +56455,118 @@ one source pixbuf, just use that function. If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants -they’ll be used to create, and add them to the icon set with +they’ll be used to create, and add them to the icon set with gtk_icon_set_add_source(). By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size. Use #GtkIconTheme instead. - + - a new #GtkIconSource + a new #GtkIconSource - - Creates a copy of @source; mostly useful for language bindings. + + Creates a copy of @source; mostly useful for language bindings. Use #GtkIconTheme instead. - + - a new #GtkIconSource + a new #GtkIconSource - a #GtkIconSource + a #GtkIconSource - - Frees a dynamically-allocated icon source, along with its + + Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields if those are not %NULL. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - - Obtains the text direction this icon source applies to. The return + + Obtains the text direction this icon source applies to. The return value is only useful/meaningful if the text direction is not wildcarded. Use #GtkIconTheme instead. - + - text direction this source matches + text direction this source matches - a #GtkIconSource + a #GtkIconSource - - Gets the value set by gtk_icon_source_set_direction_wildcarded(). + + Gets the value set by gtk_icon_source_set_direction_wildcarded(). Use #GtkIconTheme instead. - + - %TRUE if this icon source is a base for any text direction variant + %TRUE if this icon source is a base for any text direction variant - a #GtkIconSource + a #GtkIconSource - - Retrieves the source filename, or %NULL if none is set. The + + Retrieves the source filename, or %NULL if none is set. The filename is not a copy, and should not be modified or expected to persist beyond the lifetime of the icon source. Use #GtkIconTheme instead. - + - image filename. This string must not + image filename. This string must not be modified or freed. - a #GtkIconSource + a #GtkIconSource - - Retrieves the source icon name, or %NULL if none is set. The + + Retrieves the source icon name, or %NULL if none is set. The icon_name is not a copy, and should not be modified or expected to persist beyond the lifetime of the icon source. Use #GtkIconTheme instead. - + - icon name. This string must not be modified or freed. + icon name. This string must not be modified or freed. - a #GtkIconSource + a #GtkIconSource - - Retrieves the source pixbuf, or %NULL if none is set. + + Retrieves the source pixbuf, or %NULL if none is set. In addition, if a filename source is in use, this function in some cases will return the pixbuf from loaded from the filename. This is, for example, true @@ -78672,133 +56574,83 @@ for the GtkIconSource passed to the #GtkStyle render_icon() virtual function. The reference count on the pixbuf is not incremented. Use #GtkIconTheme instead. - + - source pixbuf + source pixbuf - a #GtkIconSource + a #GtkIconSource - - Obtains the icon size this source applies to. The return value + + Obtains the icon size this source applies to. The return value is only useful/meaningful if the icon size is not wildcarded. Use #GtkIconTheme instead. - + - icon size (#GtkIconSize) this source matches. - + icon size (#GtkIconSize) this source matches. + - a #GtkIconSource + a #GtkIconSource - - Gets the value set by gtk_icon_source_set_size_wildcarded(). + + Gets the value set by gtk_icon_source_set_size_wildcarded(). Use #GtkIconTheme instead. - + - %TRUE if this icon source is a base for any icon size variant + %TRUE if this icon source is a base for any icon size variant - a #GtkIconSource + a #GtkIconSource - - Obtains the widget state this icon source applies to. The return + + Obtains the widget state this icon source applies to. The return value is only useful/meaningful if the widget state is not wildcarded. Use #GtkIconTheme instead. - + - widget state this source matches + widget state this source matches - a #GtkIconSource + a #GtkIconSource - - Gets the value set by gtk_icon_source_set_state_wildcarded(). + + Gets the value set by gtk_icon_source_set_state_wildcarded(). Use #GtkIconTheme instead. - + - %TRUE if this icon source is a base for any widget state variant + %TRUE if this icon source is a base for any widget state variant - a #GtkIconSource + a #GtkIconSource - - Sets the text direction this icon source is intended to be used + + Sets the text direction this icon source is intended to be used with. Setting the text direction on an icon source makes no difference @@ -78806,33 +56658,23 @@ if the text direction is wildcarded. Therefore, you should usually call gtk_icon_source_set_direction_wildcarded() to un-wildcard it in addition to calling this function. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - text direction this source applies to + text direction this source applies to - - If the text direction is wildcarded, this source can be used + + If the text direction is wildcarded, this source can be used as the base image for an icon in any #GtkTextDirection. If the text direction is not wildcarded, then the text direction the icon source applies to should be set @@ -78842,123 +56684,80 @@ will only be used with that text direction. #GtkIconSet prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - %TRUE to wildcard the text direction + %TRUE to wildcard the text direction - - Sets the name of an image file to use as a base image when creating + + Sets the name of an image file to use as a base image when creating icon variants for #GtkIconSet. The filename must be absolute. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - image file to use + image file to use - - Sets the name of an icon to look up in the current icon theme + + Sets the name of an icon to look up in the current icon theme to use as a base image when creating icon variants for #GtkIconSet. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - - name of icon to use + + name of icon to use - - Sets a pixbuf to use as a base image when creating icon variants + + Sets a pixbuf to use as a base image when creating icon variants for #GtkIconSet. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - pixbuf to use as a source + pixbuf to use as a source - - Sets the icon size this icon source is intended to be used + + Sets the icon size this icon source is intended to be used with. Setting the icon size on an icon source makes no difference @@ -78966,33 +56765,23 @@ if the size is wildcarded. Therefore, you should usually call gtk_icon_source_set_size_wildcarded() to un-wildcard it in addition to calling this function. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - icon size (#GtkIconSize) this source applies to - + icon size (#GtkIconSize) this source applies to + - - If the icon size is wildcarded, this source can be used as the base + + If the icon size is wildcarded, this source can be used as the base image for an icon of any size. If the size is not wildcarded, then the size the source applies to should be set with gtk_icon_source_set_size() and the icon source will only be used @@ -79005,33 +56794,23 @@ wildcarded sources, and will use an exact match when possible. an appropriate icon at a given size, but will not change the size of source images that match exactly. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - %TRUE to wildcard the widget state + %TRUE to wildcard the widget state - - Sets the widget state this icon source is intended to be used + + Sets the widget state this icon source is intended to be used with. Setting the widget state on an icon source makes no difference @@ -79039,33 +56818,23 @@ if the state is wildcarded. Therefore, you should usually call gtk_icon_source_set_state_wildcarded() to un-wildcard it in addition to calling this function. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - widget state this source applies to + widget state this source applies to - - If the widget state is wildcarded, this source can be used as the + + If the widget state is wildcarded, this source can be used as the base image for an icon in any #GtkStateType. If the widget state is not wildcarded, then the state the source applies to should be set with gtk_icon_source_set_state() and the icon source will @@ -79079,40 +56848,27 @@ produce an appropriate icon for a given state, for example lightening an image on prelight, but will not modify source images that match exactly. Use #GtkIconTheme instead. - + - a #GtkIconSource + a #GtkIconSource - %TRUE to wildcard the widget state + %TRUE to wildcard the widget state - - #GtkIconTheme provides a facility for looking up icons by name + + #GtkIconTheme provides a facility for looking up icons by name and size. The main reason for using a name rather than simply providing a filename is to allow different icons to be used -depending on what “icon theme” is selected +depending on what “icon theme” is selected by the user. The operation of icon themes on Linux and Unix follows the [Icon Theme Specification](http://www.freedesktop.org/Standards/icon-theme-spec) There is a fallback icon theme, named `hicolor`, where applications @@ -79145,13 +56901,13 @@ out that internally stock images are generally defined in terms of one or more named icons. (An example of the more than one case is icons that depend on writing direction; %GTK_STOCK_GO_FORWARD uses the two themed icons -“gtk-stock-go-forward-ltr” and “gtk-stock-go-forward-rtl”.) +“gtk-stock-go-forward-ltr” and “gtk-stock-go-forward-rtl”.) In many cases, named themes are used indirectly, via #GtkImage or stock items, rather than directly, but looking up icons directly is also simple. The #GtkIconTheme object acts as a database of all the icons in the current theme. You -can create new #GtkIconTheme objects, but it’s much more +can create new #GtkIconTheme objects, but it’s much more efficient to use the standard icon theme for the #GdkScreen so that the icon information is shared with other people looking up icons. @@ -79168,7 +56924,7 @@ pixbuf = gtk_icon_theme_load_icon (icon_theme, &error); if (!pixbuf) { - g_warning ("Couldn’t load icon: %s", error->message); + g_warning ("Couldn’t load icon: %s", error->message); g_error_free (error); } else @@ -79179,33 +56935,23 @@ else ]| - Creates a new icon theme object. Icon theme objects are used + Creates a new icon theme object. Icon theme objects are used to lookup up an icon by name in a particular icon theme. -Usually, you’ll want to use gtk_icon_theme_get_default() +Usually, you’ll want to use gtk_icon_theme_get_default() or gtk_icon_theme_get_for_screen() rather than creating a new icon theme object for scratch. - the newly created #GtkIconTheme object. + the newly created #GtkIconTheme object. - - Registers a built-in icon for icon theme lookups. The idea + + Registers a built-in icon for icon theme lookups. The idea of built-in icons is to allow an application or library that uses themed icons to function requiring files to be present in the file system. For instance, the default -images for all of GTK+’s stock icons are registered +images for all of GTK+’s stock icons are registered as built-icons. In general, if you use gtk_icon_theme_add_builtin_icon() @@ -79222,50 +56968,34 @@ via gdk_pixbuf_new_from_inline(). - the name of the icon to register + the name of the icon to register - the size in pixels at which to register the icon (different + the size in pixels at which to register the icon (different images can be registered for the same icon name at different sizes.) - #GdkPixbuf that contains the image to use for @icon_name + #GdkPixbuf that contains the image to use for @icon_name - - Gets the icon theme for the default screen. See + + Gets the icon theme for the default screen. See gtk_icon_theme_get_for_screen(). - A unique #GtkIconTheme associated with + A unique #GtkIconTheme associated with the default screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it. - - Gets the icon theme object associated with @screen; if this + + Gets the icon theme object associated with @screen; if this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. Icon theme objects are @@ -79275,9 +57005,7 @@ and setting the screen yourself; by using this function a single icon theme object will be shared between users. - A unique #GtkIconTheme associated with + A unique #GtkIconTheme associated with the given screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it. @@ -79285,9 +57013,7 @@ a single icon theme object will be shared between users. - a #GdkScreen + a #GdkScreen @@ -79303,12 +57029,8 @@ a single icon theme object will be shared between users. - - Adds a resource path that will be looked at when looking + + Adds a resource path that will be looked at when looking for icons, similar to search paths. This function should be used to make application-specific icons @@ -79325,25 +57047,17 @@ of a subdirectory are also considered as ultimate fallback. - a #GtkIconTheme + a #GtkIconTheme - a resource path + a resource path - - Appends a directory to the search path. + + Appends a directory to the search path. See gtk_icon_theme_set_search_path(). @@ -79351,25 +57065,17 @@ See gtk_icon_theme_set_search_path(). - a #GtkIconTheme + a #GtkIconTheme - directory name to append to the icon path + directory name to append to the icon path - - Looks up a named icon and returns a #GtkIconInfo containing + + Looks up a named icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() @@ -79380,49 +57086,35 @@ tries them all in the given order before falling back to inherited icon themes. - a #GtkIconInfo object -containing information about the icon, or %NULL if the icon wasn’t + a #GtkIconInfo object +containing information about the icon, or %NULL if the icon wasn’t found. - a #GtkIconTheme + a #GtkIconTheme - %NULL-terminated array of + %NULL-terminated array of icon names to lookup - desired icon size + desired icon size - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up a named icon for a particular window scale and returns + + Looks up a named icon for a particular window scale and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() @@ -79433,88 +57125,62 @@ tries them all in the given order before falling back to inherited icon themes. - a #GtkIconInfo object + a #GtkIconInfo object containing information about the icon, or %NULL if the - icon wasn’t found. + icon wasn’t found. - a #GtkIconTheme + a #GtkIconTheme - %NULL-terminated + %NULL-terminated array of icon names to lookup - desired icon size + desired icon size - desired scale + desired scale - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Gets the name of an icon that is representative of the + + Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.) - the name of an example icon or %NULL. + the name of an example icon or %NULL. Free with g_free(). - a #GtkIconTheme + a #GtkIconTheme - - Returns an array of integers describing the sizes at which + + Returns an array of integers describing the sizes at which the icon is available without scaling. A size of -1 means that the icon is available in a scalable format. The array is zero-terminated. - An newly + An newly allocated array describing the sizes at which the icon is available. The array should be freed with g_free() when it is no longer needed. @@ -79524,105 +57190,67 @@ longer needed. - a #GtkIconTheme + a #GtkIconTheme - the name of an icon + the name of an icon - - Gets the current search path. See gtk_icon_theme_set_search_path(). + + Gets the current search path. See gtk_icon_theme_set_search_path(). - a #GtkIconTheme + a #GtkIconTheme - - + + location to store a list of icon theme path directories or %NULL. The stored value should be freed with g_strfreev(). - - location to store number of elements in @path, or %NULL + + location to store number of elements in @path, or %NULL - - Checks whether an icon theme includes an icon + + Checks whether an icon theme includes an icon for a particular name. - %TRUE if @icon_theme includes an + %TRUE if @icon_theme includes an icon for @icon_name. - a #GtkIconTheme + a #GtkIconTheme - the name of an icon + the name of an icon - - Gets the list of contexts available within the current + + Gets the list of contexts available within the current hierarchy of icon themes. See gtk_icon_theme_list_icons() for details about contexts. - a #GList list + a #GList list holding the names of all the contexts in the theme. You must first free each element in the list with g_free(), then free the list itself with g_list_free(). @@ -79632,32 +57260,24 @@ See gtk_icon_theme_list_icons() for details about contexts. - a #GtkIconTheme + a #GtkIconTheme - - Lists the icons in the current icon theme. Only a subset + + Lists the icons in the current icon theme. Only a subset of the icons can be listed by providing a context string. The set of values for the context string is system dependent, -but will typically include such values as “Applications” and -“MimeTypes”. Contexts are explained in the +but will typically include such values as “Applications” and +“MimeTypes”. Contexts are explained in the [Icon Theme Specification](http://www.freedesktop.org/wiki/Specifications/icon-theme-spec). The standard contexts are listed in the [Icon Naming Specification](http://www.freedesktop.org/wiki/Specifications/icon-naming-spec). Also see gtk_icon_theme_list_contexts(). - a #GList list + a #GList list holding the names of all the icons in the theme. You must first free each element in the list with g_free(), then free the list itself with g_list_free(). @@ -79667,30 +57287,18 @@ Also see gtk_icon_theme_list_contexts(). - a #GtkIconTheme + a #GtkIconTheme - - a string identifying a particular type of + + a string identifying a particular type of icon, or %NULL to list all icons. - - Looks up an icon in an icon theme, scales it to the given size + + Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. This is a convenience function; if more details about the icon are needed, use gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon(). @@ -79704,49 +57312,34 @@ returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory. - the rendered icon; this may be + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release - your reference to the icon. %NULL if the icon isn’t found. + your reference to the icon. %NULL if the icon isn’t found. - a #GtkIconTheme + a #GtkIconTheme - the name of the icon to lookup + the name of the icon to lookup - the desired icon size. The resulting icon may not be + the desired icon size. The resulting icon may not be exactly this size; see gtk_icon_info_load_icon(). - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up an icon in an icon theme for a particular window scale, + + Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a pixbuf. This is a convenience function; if more details about the icon are needed, use gtk_icon_theme_lookup_icon() followed by @@ -79761,55 +57354,38 @@ returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory. - the rendered icon; this may be + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use g_object_unref() to release - your reference to the icon. %NULL if the icon isn’t found. + your reference to the icon. %NULL if the icon isn’t found. - a #GtkIconTheme + a #GtkIconTheme - the name of the icon to lookup + the name of the icon to lookup - the desired icon size. The resulting icon may not be + the desired icon size. The resulting icon may not be exactly this size; see gtk_icon_info_load_icon(). - desired scale + desired scale - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up an icon in an icon theme for a particular window scale, + + Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a cairo surface. This is a convenience function; if more details about the icon are needed, use gtk_icon_theme_lookup_icon() followed by @@ -79820,64 +57396,43 @@ update the icon. This is usually done by connecting to the GtkWidget::style-set signal. - the rendered icon; this may be + the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use cairo_surface_destroy() to - release your reference to the icon. %NULL if the icon isn’t + release your reference to the icon. %NULL if the icon isn’t found. - a #GtkIconTheme + a #GtkIconTheme - the name of the icon to lookup + the name of the icon to lookup - the desired icon size. The resulting icon may not be + the desired icon size. The resulting icon may not be exactly this size; see gtk_icon_info_load_icon(). - desired scale + desired scale - - #GdkWindow to optimize drawing for, or %NULL + + #GdkWindow to optimize drawing for, or %NULL - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up an icon and returns a #GtkIconInfo containing information + + Looks up an icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). @@ -79888,96 +57443,66 @@ gtk_icon_theme_lookup_by_gicon_for_scale(), as the assets loaded for a given scaling factor may be different. - a #GtkIconInfo containing - information about the icon, or %NULL if the icon wasn’t + a #GtkIconInfo containing + information about the icon, or %NULL if the icon wasn’t found. Unref with g_object_unref() - a #GtkIconTheme + a #GtkIconTheme - the #GIcon to look up + the #GIcon to look up - desired icon size + desired icon size - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up an icon and returns a #GtkIconInfo containing information + + Looks up an icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). - a #GtkIconInfo containing - information about the icon, or %NULL if the icon wasn’t + a #GtkIconInfo containing + information about the icon, or %NULL if the icon wasn’t found. Unref with g_object_unref() - a #GtkIconTheme + a #GtkIconTheme - the #GIcon to look up + the #GIcon to look up - desired icon size + desired icon size - the desired scale + the desired scale - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up a named icon and returns a #GtkIconInfo containing + + Looks up a named icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() @@ -79990,98 +57515,68 @@ gtk_icon_theme_lookup_icon_for_scale(), as the assets loaded for a given scaling factor may be different. - a #GtkIconInfo object + a #GtkIconInfo object containing information about the icon, or %NULL if the - icon wasn’t found. + icon wasn’t found. - a #GtkIconTheme + a #GtkIconTheme - the name of the icon to lookup + the name of the icon to lookup - desired icon size + desired icon size - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Looks up a named icon for a particular window scale and returns a + + Looks up a named icon for a particular window scale and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines these two steps if all you need is the pixbuf.) - a #GtkIconInfo object + a #GtkIconInfo object containing information about the icon, or %NULL if the - icon wasn’t found. + icon wasn’t found. - a #GtkIconTheme + a #GtkIconTheme - the name of the icon to lookup + the name of the icon to lookup - desired icon size + desired icon size - the desired scale + the desired scale - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - - Prepends a directory to the search path. + + Prepends a directory to the search path. See gtk_icon_theme_set_search_path(). @@ -80089,50 +57584,34 @@ See gtk_icon_theme_set_search_path(). - a #GtkIconTheme + a #GtkIconTheme - directory name to prepend to the icon path + directory name to prepend to the icon path - - Checks to see if the icon theme has changed; if it has, any + + Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time @icon_theme is accessed. - %TRUE if the icon theme has changed and needed + %TRUE if the icon theme has changed and needed to be reloaded. - a #GtkIconTheme + a #GtkIconTheme - - Sets the name of the icon theme that the #GtkIconTheme object uses + + Sets the name of the icon theme that the #GtkIconTheme object uses overriding system configuration. This function cannot be called on the icon theme objects returned from gtk_icon_theme_get_default() and gtk_icon_theme_get_for_screen(). @@ -80142,30 +57621,19 @@ and gtk_icon_theme_get_for_screen(). - a #GtkIconTheme + a #GtkIconTheme - - name of icon theme to use instead of + + name of icon theme to use instead of configured theme, or %NULL to unset a previously set custom theme - - Sets the screen for an icon theme; the screen is used -to track the user’s currently configured icon theme, + + Sets the screen for an icon theme; the screen is used +to track the user’s currently configured icon theme, which might be different for different screens. @@ -80173,32 +57641,24 @@ which might be different for different screens. - a #GtkIconTheme + a #GtkIconTheme - a #GdkScreen + a #GdkScreen - - Sets the search path for the icon theme object. When looking + + Sets the search path for the icon theme object. When looking for an icon theme, GTK+ will search for a subdirectory of one or more of the directories in @path with the same name as the icon theme containing an index.theme file. (Themes from multiple of the path elements are combined to allow themes to be -extended by adding icons in the user’s home directory.) +extended by adding icons in the user’s home directory.) -In addition if an icon found isn’t found either in the current +In addition if an icon found isn’t found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of @path, then that image will be used for the icon name. @@ -80211,24 +57671,18 @@ rather than directly on the icon path.) - a #GtkIconTheme + a #GtkIconTheme - array of + array of directories that are searched for icon themes - number of elements in @path. + number of elements in @path. @@ -80240,9 +57694,7 @@ rather than directly on the icon path.) - Emitted when the current icon theme is switched or GTK+ detects + Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme. @@ -80250,14 +57702,10 @@ icon theme. - + - The parent class. + The parent class. @@ -80306,29 +57754,13 @@ icon theme. - - Error codes for GtkIconTheme operations. - - The icon specified does not exist in the theme + + Error codes for GtkIconTheme operations. + + The icon specified does not exist in the theme - - An unspecified error occurred. + + An unspecified error occurred. @@ -80339,16 +57771,8 @@ icon theme. - - #GtkIconView provides an alternative view on a #GtkTreeModel. + + #GtkIconView provides an alternative view on a #GtkTreeModel. It displays the model as a grid of icons with labels. Like #GtkTreeView, it allows to select one or multiple items (depending on the selection mode, see gtk_icon_view_set_selection_mode()). @@ -80358,13 +57782,13 @@ rubberband selection, which is controlled by dragging the pointer. Note that if the tree model is backed by an actual tree store (as opposed to a flat list where the mapping to icons is obvious), #GtkIconView will only display the first level of the tree and -ignore the tree’s branches. +ignore the tree’s branches. # CSS nodes |[<!-- language="plain" --> iconview.view -╰── [rubberband] +╰── [rubberband] ]| GtkIconView has a single CSS node with name iconview and style class .view. @@ -80375,58 +57799,38 @@ For rubberband selection, a subnode with name rubberband is used. - Creates a new #GtkIconView widget + Creates a new #GtkIconView widget - A newly created #GtkIconView widget + A newly created #GtkIconView widget - - Creates a new #GtkIconView widget using the + + Creates a new #GtkIconView widget using the specified @area to layout cells inside the icons. - A newly created #GtkIconView widget + A newly created #GtkIconView widget - the #GtkCellArea to use to layout cells + the #GtkCellArea to use to layout cells - - Creates a new #GtkIconView widget with the model @model. + + Creates a new #GtkIconView widget with the model @model. - A newly created #GtkIconView widget. + A newly created #GtkIconView widget. - The model. + The model. @@ -80442,27 +57846,19 @@ specified @area to layout cells inside the icons. - - Activates the item determined by @path. + + Activates the item determined by @path. - A #GtkIconView + A #GtkIconView - The #GtkTreePath to be activated + The #GtkTreePath to be activated @@ -80485,9 +57881,7 @@ specified @area to layout cells inside the icons. - Selects all the icons. @icon_view must has its selection mode set + Selects all the icons. @icon_view must has its selection mode set to #GTK_SELECTION_MULTIPLE. @@ -80495,9 +57889,7 @@ to #GTK_SELECTION_MULTIPLE. - A #GtkIconView. + A #GtkIconView. @@ -80536,28 +57928,20 @@ to #GTK_SELECTION_MULTIPLE. - Unselects all the icons. + Unselects all the icons. - A #GtkIconView. + A #GtkIconView. - - Converts widget coordinates to coordinates for the bin_window, + + Converts widget coordinates to coordinates for the bin_window, as expected by e.g. gtk_icon_view_get_path_at_pos(). @@ -80565,78 +57949,48 @@ as expected by e.g. gtk_icon_view_get_path_at_pos(). - a #GtkIconView + a #GtkIconView - X coordinate relative to the widget + X coordinate relative to the widget - Y coordinate relative to the widget + Y coordinate relative to the widget - - return location for bin_window X coordinate + + return location for bin_window X coordinate - - return location for bin_window Y coordinate + + return location for bin_window Y coordinate - - Creates a #cairo_surface_t representation of the item at @path. + + Creates a #cairo_surface_t representation of the item at @path. This image is used for a drag icon. - a newly-allocated surface of the drag icon. + a newly-allocated surface of the drag icon. - a #GtkIconView + a #GtkIconView - a #GtkTreePath in @icon_view + a #GtkTreePath in @icon_view - - Turns @icon_view into a drop destination for automatic DND. Calling this + + Turns @icon_view into a drop destination for automatic DND. Calling this method sets #GtkIconView:reorderable to %FALSE. @@ -80644,43 +57998,29 @@ method sets #GtkIconView:reorderable to %FALSE. - a #GtkIconView + a #GtkIconView - the table of targets that the drag will + the table of targets that the drag will support - + - the number of items in @targets + the number of items in @targets - the bitmask of possible actions for a drag to this + the bitmask of possible actions for a drag to this widget - - Turns @icon_view into a drag source for automatic DND. Calling this + + Turns @icon_view into a drag source for automatic DND. Calling this method sets #GtkIconView:reorderable to %FALSE. @@ -80688,315 +58028,185 @@ method sets #GtkIconView:reorderable to %FALSE. - a #GtkIconView + a #GtkIconView - Mask of allowed buttons to start drag + Mask of allowed buttons to start drag - the table of targets that the drag will + the table of targets that the drag will support - + - the number of items in @targets + the number of items in @targets - the bitmask of possible actions for a drag from this + the bitmask of possible actions for a drag from this widget - - Gets the setting set by gtk_icon_view_set_activate_on_single_click(). + + Gets the setting set by gtk_icon_view_set_activate_on_single_click(). - %TRUE if item-activated will be emitted on a single click + %TRUE if item-activated will be emitted on a single click - a #GtkIconView + a #GtkIconView - - Fills the bounding rectangle in widget coordinates for the cell specified by + + Fills the bounding rectangle in widget coordinates for the cell specified by @path and @cell. If @cell is %NULL the main cell area is used. This function is only valid if @icon_view is realized. - %FALSE if there is no such item, %TRUE otherwise + %FALSE if there is no such item, %TRUE otherwise - a #GtkIconView + a #GtkIconView - a #GtkTreePath + a #GtkTreePath - - a #GtkCellRenderer or %NULL + + a #GtkCellRenderer or %NULL - - rectangle to fill with cell rect + + rectangle to fill with cell rect - - Returns the value of the ::column-spacing property. + + Returns the value of the ::column-spacing property. - the space between columns + the space between columns - a #GtkIconView + a #GtkIconView - - Returns the value of the ::columns property. + + Returns the value of the ::columns property. - the number of columns, or -1 + the number of columns, or -1 - a #GtkIconView + a #GtkIconView - - Fills in @path and @cell with the current cursor path and cell. -If the cursor isn’t currently set, then *@path will be %NULL. + + Fills in @path and @cell with the current cursor path and cell. +If the cursor isn’t currently set, then *@path will be %NULL. If no cell currently has focus, then *@cell will be %NULL. The returned #GtkTreePath must be freed with gtk_tree_path_free(). - %TRUE if the cursor is set. + %TRUE if the cursor is set. - A #GtkIconView + A #GtkIconView - - Return location for the current + + Return location for the current cursor path, or %NULL - - Return location the current + + Return location the current focus cell, or %NULL - - Determines the destination item for a given position. + + Determines the destination item for a given position. - whether there is an item at the given position. + whether there is an item at the given position. - a #GtkIconView + a #GtkIconView - the position to determine the destination item for + the position to determine the destination item for - the position to determine the destination item for + the position to determine the destination item for - - Return location for the path of the item, + + Return location for the path of the item, or %NULL. - - Return location for the drop position, or %NULL - + + Return location for the drop position, or %NULL + - - Gets information about the item that is highlighted for feedback. + + Gets information about the item that is highlighted for feedback. - a #GtkIconView + a #GtkIconView - - Return location for the path of + + Return location for the path of the highlighted item, or %NULL. - - Return location for the drop position, or %NULL - + + Return location for the drop position, or %NULL + - - Finds the path at the point (@x, @y), relative to bin_window coordinates. + + Finds the path at the point (@x, @y), relative to bin_window coordinates. In contrast to gtk_icon_view_get_path_at_pos(), this function also obtains the cell at the specified position. The returned path should be freed with gtk_tree_path_free(). @@ -81004,360 +58214,230 @@ See gtk_icon_view_convert_widget_to_bin_window_coords() for converting widget coordinates to bin_window coordinates. - %TRUE if an item exists at the specified position + %TRUE if an item exists at the specified position - A #GtkIconView. + A #GtkIconView. - The x position to be identified + The x position to be identified - The y position to be identified + The y position to be identified - - Return location for the path, or %NULL + + Return location for the path, or %NULL - - Return location for the renderer + + Return location for the renderer responsible for the cell at (@x, @y), or %NULL - - Gets the column in which the item @path is currently + + Gets the column in which the item @path is currently displayed. Column numbers start at 0. - The column in which the item is displayed + The column in which the item is displayed - a #GtkIconView + a #GtkIconView - the #GtkTreePath of the item + the #GtkTreePath of the item - - Returns the value of the ::item-orientation property which determines + + Returns the value of the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below. - the relative position of texts and icons + the relative position of texts and icons - a #GtkIconView + a #GtkIconView - - Returns the value of the ::item-padding property. + + Returns the value of the ::item-padding property. - the padding around items + the padding around items - a #GtkIconView + a #GtkIconView - - Gets the row in which the item @path is currently + + Gets the row in which the item @path is currently displayed. Row numbers start at 0. - The row in which the item is displayed + The row in which the item is displayed - a #GtkIconView + a #GtkIconView - the #GtkTreePath of the item + the #GtkTreePath of the item - - Returns the value of the ::item-width property. + + Returns the value of the ::item-width property. - the width of a single item, or -1 + the width of a single item, or -1 - a #GtkIconView + a #GtkIconView - - Returns the value of the ::margin property. + + Returns the value of the ::margin property. - the space at the borders + the space at the borders - a #GtkIconView + a #GtkIconView - - Returns the column with markup text for @icon_view. + + Returns the column with markup text for @icon_view. - the markup column, or -1 if it’s unset. + the markup column, or -1 if it’s unset. - A #GtkIconView. + A #GtkIconView. - - Returns the model the #GtkIconView is based on. Returns %NULL if the + + Returns the model the #GtkIconView is based on. Returns %NULL if the model is unset. - A #GtkTreeModel, or %NULL if none is + A #GtkTreeModel, or %NULL if none is currently being used. - a #GtkIconView + a #GtkIconView - - Finds the path at the point (@x, @y), relative to bin_window coordinates. + + Finds the path at the point (@x, @y), relative to bin_window coordinates. See gtk_icon_view_get_item_at_pos(), if you are also interested in the cell at the specified position. See gtk_icon_view_convert_widget_to_bin_window_coords() for converting widget coordinates to bin_window coordinates. - The #GtkTreePath corresponding + The #GtkTreePath corresponding to the icon or %NULL if no icon exists at that position. - A #GtkIconView. + A #GtkIconView. - The x position to be identified + The x position to be identified - The y position to be identified + The y position to be identified - - Returns the column with pixbufs for @icon_view. + + Returns the column with pixbufs for @icon_view. - the pixbuf column, or -1 if it’s unset. + the pixbuf column, or -1 if it’s unset. - A #GtkIconView. + A #GtkIconView. - - Retrieves whether the user can reorder the list via drag-and-drop. + + Retrieves whether the user can reorder the list via drag-and-drop. See gtk_icon_view_set_reorderable(). - %TRUE if the list can be reordered. + %TRUE if the list can be reordered. - a #GtkIconView + a #GtkIconView - - Returns the value of the ::row-spacing property. + + Returns the value of the ::row-spacing property. - the space between rows + the space between rows - a #GtkIconView + a #GtkIconView - - Creates a list of paths of all selected items. Additionally, if you are + + Creates a list of paths of all selected items. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of #GtkTreeRowReferences. To do this, you can use gtk_tree_row_reference_new(). @@ -81368,118 +58448,78 @@ g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); ]| - A #GList containing a #GtkTreePath for each selected row. + A #GList containing a #GtkTreePath for each selected row. - A #GtkIconView. + A #GtkIconView. - - Gets the selection mode of the @icon_view. + + Gets the selection mode of the @icon_view. - the current selection mode + the current selection mode - A #GtkIconView. + A #GtkIconView. - - Returns the value of the ::spacing property. + + Returns the value of the ::spacing property. - the space between cells + the space between cells - a #GtkIconView + a #GtkIconView - - Returns the column with text for @icon_view. + + Returns the column with text for @icon_view. - the text column, or -1 if it’s unset. + the text column, or -1 if it’s unset. - A #GtkIconView. + A #GtkIconView. - - Returns the column of @icon_view’s model which is being used for -displaying tooltips on @icon_view’s rows. + + Returns the column of @icon_view’s model which is being used for +displaying tooltips on @icon_view’s rows. - the index of the tooltip column that is currently being + the index of the tooltip column that is currently being used, or -1 if this is disabled. - a #GtkIconView + a #GtkIconView - - This function is supposed to be used in a #GtkWidget::query-tooltip + + This function is supposed to be used in a #GtkWidget::query-tooltip signal handler for #GtkIconView. The @x, @y and @keyboard_tip values which are received in the signal handler, should be passed to this function without modification. @@ -81489,189 +58529,108 @@ coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard tooltips the item returned will be the cursor item. When %TRUE, then any of @model, @path and @iter which have been provided will be set to point to that row and the corresponding model. @x and @y will always be converted -to be relative to @icon_view’s bin_window if @keyboard_tooltip is %FALSE. +to be relative to @icon_view’s bin_window if @keyboard_tooltip is %FALSE. - whether or not the given tooltip context points to a item + whether or not the given tooltip context points to a item - an #GtkIconView + an #GtkIconView - - the x coordinate (relative to widget coordinates) + + the x coordinate (relative to widget coordinates) - - the y coordinate (relative to widget coordinates) + + the y coordinate (relative to widget coordinates) - whether this is a keyboard tooltip or not + whether this is a keyboard tooltip or not - - a pointer to receive a + + a pointer to receive a #GtkTreeModel or %NULL - - a pointer to receive a #GtkTreePath or %NULL + + a pointer to receive a #GtkTreePath or %NULL - - a pointer to receive a #GtkTreeIter or %NULL + + a pointer to receive a #GtkTreeIter or %NULL - - Sets @start_path and @end_path to be the first and last visible path. + + Sets @start_path and @end_path to be the first and last visible path. Note that there may be invisible paths in between. Both paths should be freed with gtk_tree_path_free() after use. - %TRUE, if valid paths were placed in @start_path and @end_path + %TRUE, if valid paths were placed in @start_path and @end_path - A #GtkIconView + A #GtkIconView - - Return location for start of region, + + Return location for start of region, or %NULL - - Return location for end of region, or %NULL + + Return location for end of region, or %NULL - - Activates the item determined by @path. + + Activates the item determined by @path. - A #GtkIconView + A #GtkIconView - The #GtkTreePath to be activated + The #GtkTreePath to be activated - - Returns %TRUE if the icon pointed to by @path is currently + + Returns %TRUE if the icon pointed to by @path is currently selected. If @path does not point to a valid location, %FALSE is returned. - %TRUE if @path is selected. + %TRUE if @path is selected. - A #GtkIconView. + A #GtkIconView. - A #GtkTreePath to check selection on. + A #GtkTreePath to check selection on. - - Moves the alignments of @icon_view to the position specified by @path. + + Moves the alignments of @icon_view to the position specified by @path. @row_align determines where the row is placed, and @col_align determines where @column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means @@ -81691,43 +58650,29 @@ centered path will be modified to reflect this change. - A #GtkIconView. + A #GtkIconView. - The path of the item to move to. + The path of the item to move to. - whether to use alignment arguments, or %FALSE. + whether to use alignment arguments, or %FALSE. - The vertical alignment of the item specified by @path. + The vertical alignment of the item specified by @path. - The horizontal alignment of the item specified by @path. + The horizontal alignment of the item specified by @path. - - Selects all the icons. @icon_view must has its selection mode set + + Selects all the icons. @icon_view must has its selection mode set to #GTK_SELECTION_MULTIPLE. @@ -81735,44 +58680,30 @@ to #GTK_SELECTION_MULTIPLE. - A #GtkIconView. + A #GtkIconView. - - Selects the row at @path. + + Selects the row at @path. - A #GtkIconView. + A #GtkIconView. - The #GtkTreePath to be selected. + The #GtkTreePath to be selected. - - Calls a function for each selected icon. Note that the model or + + Calls a function for each selected icon. Note that the model or selection cannot be modified from within this function. @@ -81780,37 +58711,21 @@ selection cannot be modified from within this function. - A #GtkIconView. + A #GtkIconView. - - The function to call for each selected icon. + + The function to call for each selected icon. - - User data to pass to the function. + + User data to pass to the function. - - Causes the #GtkIconView::item-activated signal to be emitted on + + Causes the #GtkIconView::item-activated signal to be emitted on a single click instead of a double click. @@ -81818,25 +58733,17 @@ a single click instead of a double click. - a #GtkIconView + a #GtkIconView - %TRUE to emit item-activated on a single click + %TRUE to emit item-activated on a single click - - Sets the ::column-spacing property which specifies the space + + Sets the ::column-spacing property which specifies the space which is inserted between the columns of the icon view. @@ -81844,25 +58751,17 @@ which is inserted between the columns of the icon view. - a #GtkIconView + a #GtkIconView - the column spacing + the column spacing - - Sets the ::columns property which determines in how + + Sets the ::columns property which determines in how many columns the icons are arranged. If @columns is -1, the number of columns will be chosen automatically to fill the available area. @@ -81872,26 +58771,18 @@ to fill the available area. - a #GtkIconView + a #GtkIconView - the number of columns + the number of columns - - Sets the current keyboard focus to be at @path, and selects it. This is -useful when you want to focus the user’s attention on a particular item. + + Sets the current keyboard focus to be at @path, and selects it. This is +useful when you want to focus the user’s attention on a particular item. If @cell is not %NULL, then focus is given to the cell specified by it. Additionally, if @start_editing is %TRUE, then editing should be started in the specified cell. @@ -81905,75 +58796,46 @@ Please note that editing can only happen when the widget is realized. - A #GtkIconView + A #GtkIconView - A #GtkTreePath + A #GtkTreePath - - One of the cell renderers of @icon_view, or %NULL + + One of the cell renderers of @icon_view, or %NULL - %TRUE if the specified cell should start being edited. + %TRUE if the specified cell should start being edited. - - Sets the item that is highlighted for feedback. + + Sets the item that is highlighted for feedback. - a #GtkIconView + a #GtkIconView - - The path of the item to highlight, or %NULL. + + The path of the item to highlight, or %NULL. - Specifies where to drop, relative to the item - + Specifies where to drop, relative to the item + - - Sets the ::item-orientation property which determines whether the labels + + Sets the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below. @@ -81981,51 +58843,35 @@ are drawn beside the icons instead of below. - a #GtkIconView + a #GtkIconView - the relative position of texts and icons + the relative position of texts and icons - - Sets the #GtkIconView:item-padding property which specifies the padding -around each of the icon view’s items. + + Sets the #GtkIconView:item-padding property which specifies the padding +around each of the icon view’s items. - a #GtkIconView + a #GtkIconView - the item padding + the item padding - - Sets the ::item-width property which specifies the width + + Sets the ::item-width property which specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size. @@ -82034,25 +58880,17 @@ automatically determine a suitable item size. - a #GtkIconView + a #GtkIconView - the width for each item + the width for each item - - Sets the ::margin property which specifies the space + + Sets the ::margin property which specifies the space which is inserted at the top, bottom, left and right of the icon view. @@ -82061,25 +58899,17 @@ of the icon view. - a #GtkIconView + a #GtkIconView - the margin + the margin - - Sets the column with markup information for @icon_view to be + + Sets the column with markup information for @icon_view to be @column. The markup column must be of type #G_TYPE_STRING. If the markup column is set to something, it overrides the text column set by gtk_icon_view_set_text_column(). @@ -82089,25 +58919,17 @@ the text column set by gtk_icon_view_set_text_column(). - A #GtkIconView. + A #GtkIconView. - A column in the currently used model, or -1 to display no text + A column in the currently used model, or -1 to display no text - - Sets the model for a #GtkIconView. + + Sets the model for a #GtkIconView. If the @icon_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model. @@ -82117,28 +58939,17 @@ it will unset the old model. - A #GtkIconView. + A #GtkIconView. - - The model. + + The model. - - Sets the column with pixbufs for @icon_view to be @column. The pixbuf + + Sets the column with pixbufs for @icon_view to be @column. The pixbuf column must be of type #GDK_TYPE_PIXBUF @@ -82146,25 +58957,17 @@ column must be of type #GDK_TYPE_PIXBUF - A #GtkIconView. + A #GtkIconView. - A column in the currently used model, or -1 to disable + A column in the currently used model, or -1 to disable - - This function is a convenience function to allow you to reorder models that + + This function is a convenience function to allow you to reorder models that support the #GtkTreeDragSourceIface and the #GtkTreeDragDestIface. Both #GtkTreeStore and #GtkListStore support these. If @reorderable is %TRUE, then the user can reorder the model by dragging and dropping rows. The @@ -82182,25 +58985,17 @@ handle drag and drop manually. - A #GtkIconView. + A #GtkIconView. - %TRUE, if the list of items can be reordered. + %TRUE, if the list of items can be reordered. - - Sets the ::row-spacing property which specifies the space + + Sets the ::row-spacing property which specifies the space which is inserted between the rows of the icon view. @@ -82208,50 +59003,34 @@ which is inserted between the rows of the icon view. - a #GtkIconView + a #GtkIconView - the row spacing + the row spacing - - Sets the selection mode of the @icon_view. + + Sets the selection mode of the @icon_view. - A #GtkIconView. + A #GtkIconView. - The selection mode + The selection mode - - Sets the ::spacing property which specifies the space + + Sets the ::spacing property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. @@ -82260,25 +59039,17 @@ the text) of an item. - a #GtkIconView + a #GtkIconView - the spacing + the spacing - - Sets the column with text for @icon_view to be @column. The text + + Sets the column with text for @icon_view to be @column. The text column must be of type #G_TYPE_STRING. @@ -82286,25 +59057,17 @@ column must be of type #G_TYPE_STRING. - A #GtkIconView. + A #GtkIconView. - A column in the currently used model, or -1 to display no text + A column in the currently used model, or -1 to display no text - - Sets the tip area of @tooltip to the area which @cell occupies in + + Sets the tip area of @tooltip to the area which @cell occupies in the item pointed to by @path. See also gtk_tooltip_set_tip_area(). See also gtk_icon_view_set_tooltip_column() for a simpler alternative. @@ -82314,42 +59077,27 @@ See also gtk_icon_view_set_tooltip_column() for a simpler alternative. - a #GtkIconView + a #GtkIconView - a #GtkTooltip + a #GtkTooltip - a #GtkTreePath + a #GtkTreePath - - a #GtkCellRenderer or %NULL + + a #GtkCellRenderer or %NULL - - If you only plan to have simple (text-only) tooltips on full items, you + + If you only plan to have simple (text-only) tooltips on full items, you can use this function to have #GtkIconView handle these automatically -for you. @column should be set to the column in @icon_view’s model +for you. @column should be set to the column in @icon_view’s model containing the tooltip texts, or -1 to disable this feature. When enabled, #GtkWidget:has-tooltip will be set to %TRUE and @@ -82363,25 +59111,17 @@ so &, <, etc have to be escaped in the text. - a #GtkIconView + a #GtkIconView - an integer, which is a valid column number for @icon_view’s model + an integer, which is a valid column number for @icon_view’s model - - Sets the tip area of @tooltip to be the area covered by the item at @path. + + Sets the tip area of @tooltip to be the area covered by the item at @path. See also gtk_icon_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area(). @@ -82390,75 +59130,51 @@ See also gtk_tooltip_set_tip_area(). - a #GtkIconView + a #GtkIconView - a #GtkTooltip + a #GtkTooltip - a #GtkTreePath + a #GtkTreePath - - Unselects all the icons. + + Unselects all the icons. - A #GtkIconView. + A #GtkIconView. - - Unselects the row at @path. + + Unselects the row at @path. - A #GtkIconView. + A #GtkIconView. - The #GtkTreePath to be unselected. + The #GtkTreePath to be unselected. - - Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this + + Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this method sets #GtkIconView:reorderable to %FALSE. @@ -82466,19 +59182,13 @@ method sets #GtkIconView:reorderable to %FALSE. - a #GtkIconView + a #GtkIconView - - Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this + + Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this method sets #GtkIconView:reorderable to %FALSE. @@ -82486,105 +59196,57 @@ method sets #GtkIconView:reorderable to %FALSE. - a #GtkIconView + a #GtkIconView - - The activate-on-single-click property specifies whether the "item-activated" signal + + The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click. - - The #GtkCellArea used to layout cell renderers for this view. + + The #GtkCellArea used to layout cell renderers for this view. If no area is specified when creating the icon view with gtk_icon_view_new_with_area() a #GtkCellAreaBox will be used. - - The column-spacing property specifies the space which is inserted between + + The column-spacing property specifies the space which is inserted between the columns of the icon view. - - The columns property contains the number of the columns in which the + + The columns property contains the number of the columns in which the items should be displayed. If it is -1, the number of columns will be chosen automatically to fill the available area. - - The item-orientation property specifies how the cells (i.e. the icon and + + The item-orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other. - - The item-padding property specifies the padding around each + + The item-padding property specifies the padding around each of the icon view's item. - - The item-width property specifies the width to use for each item. + + The item-width property specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size. - - The margin property specifies the space which is inserted + + The margin property specifies the space which is inserted at the edges of the icon view. - - The ::markup-column property contains the number of the model column + + The ::markup-column property contains the number of the model column containing markup information to be displayed. The markup column must be of type #G_TYPE_STRING. If this property and the :text-column property are both set to column numbers, it overrides the text column. @@ -82594,66 +59256,36 @@ If both are set to -1, no texts are displayed. - - The ::pixbuf-column property contains the number of the model column + + The ::pixbuf-column property contains the number of the model column containing the pixbufs which are displayed. The pixbuf column must be of type #GDK_TYPE_PIXBUF. Setting this property to -1 turns off the display of pixbufs. - - The reorderable property specifies if the items can be reordered + + The reorderable property specifies if the items can be reordered by DND. - - The row-spacing property specifies the space which is inserted between + + The row-spacing property specifies the space which is inserted between the rows of the icon view. - - The ::selection-mode property specifies the selection mode of + + The ::selection-mode property specifies the selection mode of icon view. If the mode is #GTK_SELECTION_MULTIPLE, rubberband selection is enabled, for the other modes, only keyboard selection is possible. - - The spacing property specifies the space which is inserted between + + The spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. - - The ::text-column property contains the number of the model column + + The ::text-column property contains the number of the model column containing the texts which are displayed. The text column must be of type #G_TYPE_STRING. If this property and the :markup-column property are both set to -1, no texts are displayed. @@ -82669,9 +59301,7 @@ property are both set to -1, no texts are displayed. - A [keybinding signal][GtkBindingSignal] + A [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the currently focused item. @@ -82685,9 +59315,7 @@ The default bindings for this signal are Space, Return and Enter. - The ::item-activated signal is emitted when the method + The ::item-activated signal is emitted when the method gtk_icon_view_item_activated() is called, when the user double clicks an item with the "activate-on-single-click" property set to %FALSE, or when the user single clicks an item when the @@ -82699,17 +59327,13 @@ Space, Return or Enter is pressed. - the #GtkTreePath for the activated item + the #GtkTreePath for the activated item - The ::move-cursor signal is a + The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. @@ -82728,23 +59352,17 @@ the Shift modifier. - the granularity of the move, as a #GtkMovementStep + the granularity of the move, as a #GtkMovementStep - the number of @step units to move + the number of @step units to move - A [keybinding signal][GtkBindingSignal] + A [keybinding signal][GtkBindingSignal] which gets emitted when the user selects all items. Applications should not connect to it, but may emit it with @@ -82757,9 +59375,7 @@ The default binding for this signal is Ctrl-a. - A [keybinding signal][GtkBindingSignal] + A [keybinding signal][GtkBindingSignal] which gets emitted when the user selects the item that is currently focused. @@ -82773,18 +59389,14 @@ There is no default binding for this signal. - The ::selection-changed signal is emitted when the selection + The ::selection-changed signal is emitted when the selection (i.e. the set of selected items) changes. - A [keybinding signal][GtkBindingSignal] + A [keybinding signal][GtkBindingSignal] which gets emitted when the user toggles whether the currently focused item is selected or not. The exact effect of this depend on the selection mode. @@ -82799,9 +59411,7 @@ There is no default binding for this signal is Ctrl-Space. - A [keybinding signal][GtkBindingSignal] + A [keybinding signal][GtkBindingSignal] which gets emitted when the user unselects all items. Applications should not connect to it, but may emit it with @@ -82814,13 +59424,7 @@ The default binding for this signal is Ctrl-Shift-a. - + @@ -82828,27 +59432,19 @@ The default binding for this signal is Ctrl-Shift-a. - + - + - + - + - + @@ -82861,15 +59457,11 @@ The default binding for this signal is Ctrl-Shift-a. - A #GtkIconView + A #GtkIconView - The #GtkTreePath to be activated + The #GtkTreePath to be activated @@ -82896,9 +59488,7 @@ The default binding for this signal is Ctrl-Shift-a. - A #GtkIconView. + A #GtkIconView. @@ -82912,9 +59502,7 @@ The default binding for this signal is Ctrl-Shift-a. - A #GtkIconView. + A #GtkIconView. @@ -83011,66 +59599,29 @@ The default binding for this signal is Ctrl-Shift-a. - - An enum for determining where a dropped item goes. - - no drop possible + + An enum for determining where a dropped item goes. + + no drop possible - - dropped item replaces the item + + dropped item replaces the item - - droppped item is inserted to the left + + droppped item is inserted to the left - - dropped item is inserted to the right + + dropped item is inserted to the right - - dropped item is inserted above + + dropped item is inserted above - - dropped item is inserted below + + dropped item is inserted below - A function used by gtk_icon_view_selected_foreach() to map all + A function used by gtk_icon_view_selected_foreach() to map all selected rows. It will be called on every selected row in the view. @@ -83078,25 +59629,15 @@ selected rows. It will be called on every selected row in the view. - a #GtkIconView + a #GtkIconView - The #GtkTreePath of a selected row + The #GtkTreePath of a selected row - - user data + + user data @@ -83104,26 +59645,18 @@ selected rows. It will be called on every selected row in the view. - - The #GtkImage widget displays an image. Various kinds of object + + The #GtkImage widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a #GdkPixbuf ("pixel buffer") from a file, and then display that. -There’s a convenience function to do this, gtk_image_new_from_file(), +There’s a convenience function to do this, gtk_image_new_from_file(), used as follows: |[<!-- language="C" --> GtkWidget *image; image = gtk_image_new_from_file ("myfile.png"); ]| -If the file isn’t loaded successfully, the image will contain a -“broken image” icon similar to that used in many web browsers. +If the file isn’t loaded successfully, the image will contain a +“broken image” icon similar to that used in many web browsers. If you want to handle errors in loading the file yourself, for example by displaying an error message, then load the image with gdk_pixbuf_new_from_file(), then create the #GtkImage with @@ -83136,7 +59669,7 @@ display an animation (#GdkPixbufAnimation) instead of a static image. align it (center, left, right) and add padding to it, using #GtkMisc methods. -#GtkImage is a “no window” widget (has no #GdkWindow of its own), +#GtkImage is a “no window” widget (has no #GdkWindow of its own), so by default does not receive events. If you want to receive events on the image, such as button clicks, place the image inside a #GtkEventBox, then connect to the event signals on the event box. @@ -83153,7 +59686,7 @@ on the image, such as button clicks, place the image inside a event->x, event->y); // Returning TRUE means we handled the event, so the signal - // emission should be stopped (don’t call any further callbacks + // emission should be stopped (don’t call any further callbacks // that may be connected). Return FALSE to continue invoking callbacks. return TRUE; } @@ -83188,7 +59721,7 @@ the image will be the same as the origin of the event box. Sometimes an application will want to avoid depending on external data files, such as image files. GTK+ comes with a program to avoid this, -called “gdk-pixbuf-csource”. This library +called “gdk-pixbuf-csource”. This library allows you to convert an image into a C variable declaration, which can then be loaded into a #GdkPixbuf using gdk_pixbuf_new_from_inline(). @@ -83201,22 +59734,15 @@ may appear on image CSS nodes: .icon-dropshadow, .lowres-icon. - Creates a new empty #GtkImage widget. + Creates a new empty #GtkImage widget. - a newly created #GtkImage widget. + a newly created #GtkImage widget. - - Creates a #GtkImage displaying the given animation. + + Creates a #GtkImage displaying the given animation. The #GtkImage does not assume a reference to the animation; you still need to unref it if you own references. #GtkImage will add its own reference rather than adopting yours. @@ -83227,27 +59753,20 @@ keep in mind that the animation will only be shown if the main loop is not busy with something that has a higher priority. - a new #GtkImage widget + a new #GtkImage widget - an animation - + an animation + - Creates a new #GtkImage displaying the file @filename. If the file -isn’t found or can’t be loaded, the resulting #GtkImage will -display a “broken image” icon. This function never returns %NULL, + Creates a new #GtkImage displaying the file @filename. If the file +isn’t found or can’t be loaded, the resulting #GtkImage will +display a “broken image” icon. This function never returns %NULL, it always returns a valid #GtkImage widget. If the file contains an animation, the image will contain an @@ -83263,94 +59782,62 @@ image is not defined, it will be whatever is appropriate for displaying the file. - a new #GtkImage + a new #GtkImage - a filename + a filename - - Creates a #GtkImage displaying an icon from the current icon theme. -If the icon name isn’t known, a “broken image” icon will be + + Creates a #GtkImage displaying an icon from the current icon theme. +If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. - a new #GtkImage displaying the themed icon + a new #GtkImage displaying the themed icon - an icon + an icon - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Creates a #GtkImage displaying an icon from the current icon theme. -If the icon name isn’t known, a “broken image” icon will be + + Creates a #GtkImage displaying an icon from the current icon theme. +If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. - a new #GtkImage displaying the themed icon + a new #GtkImage displaying the themed icon - - an icon name or %NULL + + an icon name or %NULL - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Creates a #GtkImage displaying an icon set. Sample stock sizes are + + Creates a #GtkImage displaying an icon set. Sample stock sizes are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using -this function, usually it’s better to create a #GtkIconFactory, put +this function, usually it’s better to create a #GtkIconFactory, put your icon sets in the icon factory, add the icon factory to the list of default factories with gtk_icon_factory_add_default(), and then use gtk_image_new_from_stock(). This will allow themes to @@ -83362,31 +59849,22 @@ icon set; you still need to unref it if you own references. Use gtk_image_new_from_icon_name() instead. - a new #GtkImage + a new #GtkImage - a #GtkIconSet + a #GtkIconSet - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Creates a new #GtkImage displaying @pixbuf. + + Creates a new #GtkImage displaying @pixbuf. The #GtkImage does not assume a reference to the pixbuf; you still need to unref it if you own references. #GtkImage will add its own reference rather than adopting yours. @@ -83396,31 +59874,20 @@ Note that this function just creates an #GtkImage from the pixbuf. The you should use gtk_image_new_from_icon_name(). - a new #GtkImage + a new #GtkImage - - a #GdkPixbuf, or %NULL + + a #GdkPixbuf, or %NULL - - Creates a new #GtkImage displaying the resource file @resource_path. If the file -isn’t found or can’t be loaded, the resulting #GtkImage will -display a “broken image” icon. This function never returns %NULL, + + Creates a new #GtkImage displaying the resource file @resource_path. If the file +isn’t found or can’t be loaded, the resulting #GtkImage will +display a “broken image” icon. This function never returns %NULL, it always returns a valid #GtkImage widget. If the file contains an animation, the image will contain an @@ -83436,131 +59903,91 @@ image is not defined, it will be whatever is appropriate for displaying the file. - a new #GtkImage + a new #GtkImage - a resource path + a resource path - - Creates a #GtkImage displaying a stock icon. Sample stock icon + + Creates a #GtkImage displaying a stock icon. Sample stock icon names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock -icon name isn’t known, the image will be empty. +icon name isn’t known, the image will be empty. You can register your own stock icon names, see gtk_icon_factory_add_default() and gtk_icon_factory_add(). Use gtk_image_new_from_icon_name() instead. - a new #GtkImage displaying the stock icon + a new #GtkImage displaying the stock icon - a stock icon name + a stock icon name - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Creates a new #GtkImage displaying @surface. + + Creates a new #GtkImage displaying @surface. The #GtkImage does not assume a reference to the surface; you still need to unref it if you own references. #GtkImage will add its own reference rather than adopting yours. - a new #GtkImage + a new #GtkImage - - a #cairo_surface_t, or %NULL + + a #cairo_surface_t, or %NULL - Resets the image to be empty. + Resets the image to be empty. - a #GtkImage + a #GtkImage - Gets the #GdkPixbufAnimation being displayed by the #GtkImage. + Gets the #GdkPixbufAnimation being displayed by the #GtkImage. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned animation. - the displayed animation, or %NULL if + the displayed animation, or %NULL if the image is empty - a #GtkImage + a #GtkImage - - Gets the #GIcon and size being displayed by the #GtkImage. + + Gets the #GIcon and size being displayed by the #GtkImage. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_GICON (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the @@ -83571,43 +59998,23 @@ returned #GIcon. - a #GtkImage + a #GtkImage - - place to store a + + place to store a #GIcon, or %NULL - - place to store an icon size + + place to store an icon size (#GtkIconSize), or %NULL - + - - Gets the icon name and size being displayed by the #GtkImage. + + Gets the icon name and size being displayed by the #GtkImage. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()). The returned string is owned by the #GtkImage and should not @@ -83618,44 +60025,23 @@ be freed. - a #GtkImage + a #GtkImage - - place to store an + + place to store an icon name, or %NULL - - place to store an icon size + + place to store an icon size (#GtkIconSize), or %NULL - + - - Gets the icon set and size being displayed by the #GtkImage. + + Gets the icon set and size being displayed by the #GtkImage. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()). Use gtk_image_get_icon_name() instead. @@ -83665,91 +60051,56 @@ The storage type of the image must be %GTK_IMAGE_EMPTY or - a #GtkImage + a #GtkImage - - location to store a + + location to store a #GtkIconSet, or %NULL - - location to store a stock + + location to store a stock icon size (#GtkIconSize), or %NULL - + - Gets the #GdkPixbuf being displayed by the #GtkImage. + Gets the #GdkPixbuf being displayed by the #GtkImage. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned pixbuf. - the displayed pixbuf, or %NULL if + the displayed pixbuf, or %NULL if the image is empty - a #GtkImage + a #GtkImage - - Gets the pixel size used for named icons. + + Gets the pixel size used for named icons. - the pixel size used for named icons. + the pixel size used for named icons. - a #GtkImage + a #GtkImage - - Gets the stock icon name and size being displayed by the #GtkImage. + + Gets the stock icon name and size being displayed by the #GtkImage. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_STOCK (see gtk_image_get_storage_type()). The returned string is owned by the #GtkImage and should not @@ -83761,65 +60112,39 @@ be freed. - a #GtkImage + a #GtkImage - - place to store a + + place to store a stock icon name, or %NULL - - place to store a stock icon + + place to store a stock icon size (#GtkIconSize), or %NULL - + - - Gets the type of representation being used by the #GtkImage + + Gets the type of representation being used by the #GtkImage to store image data. If the #GtkImage has no image data, the return value will be %GTK_IMAGE_EMPTY. - image representation being used + image representation being used - a #GtkImage + a #GtkImage - - Causes the #GtkImage to display the given animation (or display + + Causes the #GtkImage to display the given animation (or display nothing, if you set the animation to %NULL). @@ -83827,118 +60152,76 @@ nothing, if you set the animation to %NULL). - a #GtkImage + a #GtkImage - the #GdkPixbufAnimation - + the #GdkPixbufAnimation + - See gtk_image_new_from_file() for details. + See gtk_image_new_from_file() for details. - a #GtkImage + a #GtkImage - - a filename or %NULL + + a filename or %NULL - - See gtk_image_new_from_gicon() for details. + + See gtk_image_new_from_gicon() for details. - a #GtkImage + a #GtkImage - an icon + an icon - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - See gtk_image_new_from_icon_name() for details. + + See gtk_image_new_from_icon_name() for details. - a #GtkImage + a #GtkImage - - an icon name or %NULL + + an icon name or %NULL - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - See gtk_image_new_from_icon_set() for details. + + See gtk_image_new_from_icon_set() for details. Use gtk_image_set_from_icon_name() instead. @@ -83946,85 +60229,55 @@ nothing, if you set the animation to %NULL). - a #GtkImage + a #GtkImage - a #GtkIconSet + a #GtkIconSet - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - See gtk_image_new_from_pixbuf() for details. + See gtk_image_new_from_pixbuf() for details. - a #GtkImage + a #GtkImage - - a #GdkPixbuf or %NULL + + a #GdkPixbuf or %NULL - - See gtk_image_new_from_resource() for details. + + See gtk_image_new_from_resource() for details. - a #GtkImage + a #GtkImage - - a resource path or %NULL + + a resource path or %NULL - - See gtk_image_new_from_stock() for details. + + See gtk_image_new_from_stock() for details. Use gtk_image_set_from_icon_name() instead. @@ -84032,59 +60285,38 @@ nothing, if you set the animation to %NULL). - a #GtkImage + a #GtkImage - a stock icon name + a stock icon name - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - See gtk_image_new_from_surface() for details. + + See gtk_image_new_from_surface() for details. - a #GtkImage + a #GtkImage - - a cairo_surface_t or %NULL + + a cairo_surface_t or %NULL - - Sets the pixel size to use for named icons. If the pixel size is set + + Sets the pixel size to use for named icons. If the pixel size is set to a value != -1, it is used instead of the icon size set by gtk_image_set_from_icon_name(). @@ -84093,15 +60325,11 @@ gtk_image_set_from_icon_name(). - a #GtkImage + a #GtkImage - the new pixel size + the new pixel size @@ -84109,37 +60337,23 @@ gtk_image_set_from_icon_name(). - - The GIcon displayed in the GtkImage. For themed icons, + + The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically. - - The name of the icon in the icon theme. If the icon theme is + + The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically. - + Use #GtkImage:icon-name instead. - + @@ -84147,31 +60361,17 @@ changed, the image will be updated automatically. - - The "pixel-size" property can be used to specify a fixed size + + The "pixel-size" property can be used to specify a fixed size overriding the #GtkImage:icon-size property for images of type %GTK_IMAGE_ICON_NAME. - - A path to a resource file to display. + + A path to a resource file to display. - + Use #GtkImage:icon-name instead. @@ -84181,13 +60381,8 @@ overriding the #GtkImage:icon-size property for images of type - - Whether the icon displayed in the GtkImage will use + + Whether the icon displayed in the GtkImage will use standard icon names fallback. The value of this property is only relevant for images of type %GTK_IMAGE_ICON_NAME and %GTK_IMAGE_GICON. @@ -84200,13 +60395,7 @@ and %GTK_IMAGE_GICON. - + @@ -84214,61 +60403,41 @@ and %GTK_IMAGE_GICON. - + - + - + - + - + - + - + - + - + - + @@ -84306,16 +60475,8 @@ and %GTK_IMAGE_GICON. - - A GtkImageMenuItem is a menu item which has an icon next to the text label. + + A GtkImageMenuItem is a menu item which has an icon next to the text label. This is functionally equivalent to: @@ -84381,30 +60542,17 @@ binding of Ctrl+M: - - Creates a new #GtkImageMenuItem with an empty label. + + Creates a new #GtkImageMenuItem with an empty label. Use gtk_menu_item_new() instead. - + - a new #GtkImageMenuItem + a new #GtkImageMenuItem - - Creates a new #GtkImageMenuItem containing the image and text from a + + Creates a new #GtkImageMenuItem containing the image and text from a stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK and #GTK_STOCK_APPLY. @@ -84414,314 +60562,190 @@ appropriate path for the menu item, use gtk_stock_lookup() to look up the standard accelerator for the stock item, and if one is found, call gtk_accel_map_add_entry() to register it. Use gtk_menu_item_new_with_mnemonic() instead. - + - a new #GtkImageMenuItem. + a new #GtkImageMenuItem. - the name of the stock item. + the name of the stock item. - - the #GtkAccelGroup to add the menu items + + the #GtkAccelGroup to add the menu items accelerator to, or %NULL. - - Creates a new #GtkImageMenuItem containing a label. + + Creates a new #GtkImageMenuItem containing a label. Use gtk_menu_item_new_with_label() instead. - + - a new #GtkImageMenuItem. + a new #GtkImageMenuItem. - the text of the menu item. + the text of the menu item. - - Creates a new #GtkImageMenuItem containing a label. The label + + Creates a new #GtkImageMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the menu item. Use gtk_menu_item_new_with_mnemonic() instead. - + - a new #GtkImageMenuItem + a new #GtkImageMenuItem - the text of the menu item, with an underscore in front of the + the text of the menu item, with an underscore in front of the mnemonic character - - Returns whether the menu item will ignore the #GtkSettings:gtk-menu-images + + Returns whether the menu item will ignore the #GtkSettings:gtk-menu-images setting and always show the image, if available. - + - %TRUE if the menu item will always show the image + %TRUE if the menu item will always show the image - a #GtkImageMenuItem + a #GtkImageMenuItem - - Gets the widget that is currently set as the image of @image_menu_item. + + Gets the widget that is currently set as the image of @image_menu_item. See gtk_image_menu_item_set_image(). - + - the widget set as image of @image_menu_item + the widget set as image of @image_menu_item - a #GtkImageMenuItem + a #GtkImageMenuItem - - Checks whether the label set in the menuitem is used as a + + Checks whether the label set in the menuitem is used as a stock id to select the stock item for the item. - + - %TRUE if the label set in the menuitem is used as a + %TRUE if the label set in the menuitem is used as a stock id to select the stock item for the item - a #GtkImageMenuItem + a #GtkImageMenuItem - - Specifies an @accel_group to add the menu items accelerator to + + Specifies an @accel_group to add the menu items accelerator to (this only applies to stock items so a stock item must already be set, make sure to call gtk_image_menu_item_set_use_stock() and gtk_menu_item_set_label() with a valid stock item first). If you want this menu item to have changeable accelerators then you shouldnt need this (see gtk_image_menu_item_new_from_stock()). - + - a #GtkImageMenuItem + a #GtkImageMenuItem - the #GtkAccelGroup + the #GtkAccelGroup - - If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images + + If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images setting and always show the image, if available. Use this property if the menuitem would be useless or hard to use without the image. - + - a #GtkImageMenuItem + a #GtkImageMenuItem - %TRUE if the menuitem should always show the image + %TRUE if the menuitem should always show the image - - Sets the image of @image_menu_item to the given widget. + + Sets the image of @image_menu_item to the given widget. Note that it depends on the show-menu-images setting whether the image will be displayed or not. - + - a #GtkImageMenuItem. + a #GtkImageMenuItem. - - a widget to set as the image for the menu item. + + a widget to set as the image for the menu item. - - If %TRUE, the label set in the menuitem is used as a + + If %TRUE, the label set in the menuitem is used as a stock id to select the stock item for the item. - + - a #GtkImageMenuItem + a #GtkImageMenuItem - %TRUE if the menuitem should use a stock item + %TRUE if the menuitem should use a stock item - - The Accel Group to use for stock accelerator keys + + The Accel Group to use for stock accelerator keys Use gtk_widget_add_accelerator() instead - - If %TRUE, the menu item will always show the image, if available. + + If %TRUE, the menu item will always show the image, if available. Use this property only if the menuitem would be useless or hard to use without the image. @@ -84729,28 +60753,14 @@ without the image. a #GtkAccelLabel and a #GtkImage instead - - Child widget to appear next to the menu text. + + Child widget to appear next to the menu text. Use a #GtkMenuItem containing a #GtkBox with a #GtkAccelLabel and a #GtkImage instead - - If %TRUE, the label set in the menuitem is used as a + + If %TRUE, the label set in the menuitem is used as a stock id to select the stock item for the item. Use a named icon from the #GtkIconTheme instead @@ -84762,20 +60772,15 @@ stock id to select the stock item for the item. - + - The parent class. + The parent class. - + @@ -84783,8 +60788,7 @@ stock id to select the stock item for the item. - + @@ -84792,8 +60796,7 @@ stock id to select the stock item for the item. - + @@ -84801,113 +60804,57 @@ stock id to select the stock item for the item. - + - + - - Describes the image data representation used by a #GtkImage. If you + + Describes the image data representation used by a #GtkImage. If you want to get the image from the widget, you can only get the currently-stored representation. e.g. if the gtk_image_get_storage_type() returns #GTK_IMAGE_PIXBUF, then you can call gtk_image_get_pixbuf() but not gtk_image_get_stock(). For empty images, you can request any storage type (call any of the "get" functions), but they will all return %NULL values. - - there is no image displayed by the widget + + there is no image displayed by the widget - - the widget contains a #GdkPixbuf + + the widget contains a #GdkPixbuf - - the widget contains a [stock item name][gtkstock] + + the widget contains a [stock item name][gtkstock] - - the widget contains a #GtkIconSet + + the widget contains a #GtkIconSet - - the widget contains a #GdkPixbufAnimation + + the widget contains a #GdkPixbufAnimation - - the widget contains a named icon. + + the widget contains a named icon. This image type was added in GTK+ 2.6 - - the widget contains a #GIcon. + + the widget contains a #GIcon. This image type was added in GTK+ 2.14 - - the widget contains a #cairo_surface_t. + + the widget contains a #cairo_surface_t. This image type was added in GTK+ 3.10 - - #GtkInfoBar is a widget that can be used to show messages to + + #GtkInfoBar is a widget that can be used to show messages to the user without showing a dialog. It is often temporarily shown at the top or bottom of a document. In contrast to #GtkDialog, which has a action area at the bottom, #GtkInfoBar has an action area @@ -84965,10 +60912,10 @@ gtk_widget_show (bar); The GtkInfoBar implementation of the GtkBuildable interface exposes the content area and action area as internal children with the names -“content_area” and “action_area”. +“content_area” and “action_area”. GtkInfoBar supports a custom <action-widgets> element, which can contain -multiple <action-widget> elements. The “response” attribute specifies a +multiple <action-widget> elements. The “response” attribute specifies a numeric response, and the content of the element is the id of widget (which should be a child of the dialogs @action_area). @@ -84982,50 +60929,33 @@ on the message type. - Creates a new #GtkInfoBar object. + Creates a new #GtkInfoBar object. - a new #GtkInfoBar object + a new #GtkInfoBar object - - Creates a new #GtkInfoBar with buttons. Button text/response ID + + Creates a new #GtkInfoBar with buttons. Button text/response ID pairs should be listed, with a %NULL pointer ending the list. Button text can be either a stock ID such as %GTK_STOCK_OK, or some arbitrary text. A response ID can be any positive number, or one of the values in the #GtkResponseType enumeration. If the user clicks one of these dialog buttons, GtkInfoBar will emit -the “response” signal with the corresponding response ID. +the “response” signal with the corresponding response ID. - a new #GtkInfoBar + a new #GtkInfoBar - - stock ID or text to go in first button, or %NULL + + stock ID or text to go in first button, or %NULL - response ID for first button, then additional buttons, ending + response ID for first button, then additional buttons, ending with %NULL @@ -85043,34 +60973,24 @@ the “response” signal with the corresponding response ID. - Emits the “response” signal with the given @response_id. + Emits the “response” signal with the given @response_id. - a #GtkInfoBar + a #GtkInfoBar - a response ID - + a response ID + - - Add an activatable widget to the action area of a #GtkInfoBar, + + Add an activatable widget to the action area of a #GtkInfoBar, connecting a signal handler that will emit the #GtkInfoBar::response signal on the message area when the widget is activated. The widget is appended to the end of the message areas action area. @@ -85080,71 +61000,48 @@ is appended to the end of the message areas action area. - a #GtkInfoBar + a #GtkInfoBar - an activatable widget + an activatable widget - response ID for @child - + response ID for @child + - - Adds a button with the given text and sets things up so that -clicking the button will emit the “response” signal with the given + + Adds a button with the given text and sets things up so that +clicking the button will emit the “response” signal with the given response_id. The button is appended to the end of the info bars's action area. The button widget is returned, but usually you don't need it. - the #GtkButton widget + the #GtkButton widget that was added - a #GtkInfoBar + a #GtkInfoBar - text of button + text of button - response ID for the button - + response ID for the button + - - Adds more buttons, same as calling gtk_info_bar_add_button() + + Adds more buttons, same as calling gtk_info_bar_add_button() repeatedly. The variable argument list should be %NULL-terminated as with gtk_info_bar_new_with_buttons(). Each button must have both text and response ID. @@ -85154,166 +61051,110 @@ text and response ID. - a #GtkInfoBar + a #GtkInfoBar - button text or stock ID + button text or stock ID - response ID for first button, then more text-response_id pairs, + response ID for first button, then more text-response_id pairs, ending with %NULL - - Returns the action area of @info_bar. + + Returns the action area of @info_bar. - the action area + the action area - a #GtkInfoBar + a #GtkInfoBar - - Returns the content area of @info_bar. + + Returns the content area of @info_bar. - the content area + the content area - a #GtkInfoBar + a #GtkInfoBar - - Returns the message type of the message area. + + Returns the message type of the message area. - the message type of the message area. + the message type of the message area. - a #GtkInfoBar + a #GtkInfoBar - + - the current value of the GtkInfoBar:revealed property. + the current value of the GtkInfoBar:revealed property. - a #GtkInfoBar + a #GtkInfoBar - - Returns whether the widget will display a standard close button. + + Returns whether the widget will display a standard close button. - %TRUE if the widget displays standard close button + %TRUE if the widget displays standard close button - a #GtkInfoBar + a #GtkInfoBar - - Emits the “response” signal with the given @response_id. + + Emits the “response” signal with the given @response_id. - a #GtkInfoBar + a #GtkInfoBar - a response ID - + a response ID + - - Sets the last widget in the info bar’s action area with + + Sets the last widget in the info bar’s action area with the given response_id as the default widget for the dialog. -Pressing “Enter” normally activates the default widget. +Pressing “Enter” normally activates the default widget. Note that this function currently requires @info_bar to be added to a widget hierarchy. @@ -85323,25 +61164,17 @@ be added to a widget hierarchy. - a #GtkInfoBar + a #GtkInfoBar - a response ID - + a response ID + - - Sets the message type of the message area. + + Sets the message type of the message area. GTK+ uses this type to determine how the message is displayed. @@ -85350,26 +61183,18 @@ GTK+ uses this type to determine how the message is displayed. - a #GtkInfoBar + a #GtkInfoBar - a #GtkMessageType + a #GtkMessageType - - Calls gtk_widget_set_sensitive (widget, setting) for each -widget in the info bars’s action area with the given response_id. + + Calls gtk_widget_set_sensitive (widget, setting) for each +widget in the info bars’s action area with the given response_id. A convenient way to sensitize/desensitize dialog buttons. @@ -85377,34 +61202,24 @@ A convenient way to sensitize/desensitize dialog buttons. - a #GtkInfoBar + a #GtkInfoBar - a response ID - + a response ID + - TRUE for sensitive + TRUE for sensitive - - Sets the GtkInfoBar:revealed property to @revealed. This will cause + + Sets the GtkInfoBar:revealed property to @revealed. This will cause @info_bar to show up with a slide-in transition. -Note that this property does not automatically show @info_bar and thus won’t +Note that this property does not automatically show @info_bar and thus won’t have any effect if it is invisible. @@ -85412,25 +61227,17 @@ have any effect if it is invisible. - a #GtkInfoBar + a #GtkInfoBar - The new value of the property + The new value of the property - - If true, a standard close button is shown. When clicked it emits + + If true, a standard close button is shown. When clicked it emits the response %GTK_RESPONSE_CLOSE. @@ -85438,27 +61245,17 @@ the response %GTK_RESPONSE_CLOSE. - a #GtkInfoBar + a #GtkInfoBar - %TRUE to include a close button + %TRUE to include a close button - - The type of the message. + + The type of the message. The type may be used to determine the appearance of the info bar. @@ -85466,14 +61263,8 @@ The type may be used to determine the appearance of the info bar. - - Whether to include a standard close button. + + Whether to include a standard close button. @@ -85483,9 +61274,7 @@ The type may be used to determine the appearance of the info bar. - The ::close signal is a + The ::close signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to dismiss the info bar. @@ -85496,9 +61285,7 @@ The default binding for this signal is the Escape key. - Emitted when an action widget is clicked or the application programmer + Emitted when an action widget is clicked or the application programmer calls gtk_dialog_response(). The @response_id depends on which action widget was clicked. @@ -85506,17 +61293,13 @@ widget was clicked. - the response ID - + the response ID + - + @@ -85529,16 +61312,12 @@ widget was clicked. - a #GtkInfoBar + a #GtkInfoBar - a response ID - + a response ID + @@ -85592,14 +61371,8 @@ widget was clicked. - - Describes hints that might be taken into account by input methods + + Describes hints that might be taken into account by input methods or applications. Note that input methods may already tailor their behaviour according to the #GtkInputPurpose of the entry. @@ -85608,114 +61381,48 @@ Some common sense is expected when using these flags - mixing This enumeration may be extended in the future; input methods should ignore unknown values. - - No special behaviour suggested + + No special behaviour suggested - - Suggest checking for typos + + Suggest checking for typos - - Suggest not checking for typos + + Suggest not checking for typos - - Suggest word completion + + Suggest word completion - - Suggest to convert all text to lowercase + + Suggest to convert all text to lowercase - - Suggest to capitalize all text + + Suggest to capitalize all text - - Suggest to capitalize the first + + Suggest to capitalize the first character of each word - - Suggest to capitalize the + + Suggest to capitalize the first word of each sentence - - Suggest to not show an onscreen keyboard + + Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys). - - The text is vertical. Since 3.18 + + The text is vertical. Since 3.18 - - Suggest offering Emoji support. Since 3.22.20 + + Suggest offering Emoji support. Since 3.22.20 - - Suggest not offering Emoji support. Since 3.22.20 + + Suggest not offering Emoji support. Since 3.22.20 - - Describes primary purpose of the input widget. This information is + + Describes primary purpose of the input widget. This information is useful for on-screen keyboards and similar input methods to decide which keys should be presented to the user. @@ -85729,109 +61436,46 @@ it specified a purpose. The difference between @GTK_INPUT_PURPOSE_DIGITS and @GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits while the latter also some punctuation (like commas or points, plus, -minus) and “e” or “E” as in 3.14E+000. +minus) and “e” or “E” as in 3.14E+000. This enumeration may be extended in the future; input methods should -interpret unknown values as “free form”. - - Allow any character +interpret unknown values as “free form”. + + Allow any character - - Allow only alphabetic characters + + Allow only alphabetic characters - - Allow only digits + + Allow only digits - - Edited field expects numbers + + Edited field expects numbers - - Edited field expects phone number + + Edited field expects phone number - - Edited field expects URL + + Edited field expects URL - - Edited field expects email address + + Edited field expects email address - - Edited field expects the name of a person + + Edited field expects the name of a person - - Like @GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden + + Like @GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden - - Like @GTK_INPUT_PURPOSE_DIGITS, but characters are hidden + + Like @GTK_INPUT_PURPOSE_DIGITS, but characters are hidden - - Allow any character, in addition to control codes + + Allow any character, in addition to control codes - - The #GtkInvisible widget is used internally in GTK+, and is probably not + + The #GtkInvisible widget is used internally in GTK+, and is probably not very useful for application developers. It is used for reliable pointer grabs and selection handling in the code @@ -85840,83 +61484,55 @@ for drag-and-drop. - Creates a new #GtkInvisible. + Creates a new #GtkInvisible. - a new #GtkInvisible. + a new #GtkInvisible. - - Creates a new #GtkInvisible object for a specified screen + + Creates a new #GtkInvisible object for a specified screen - a newly created #GtkInvisible object + a newly created #GtkInvisible object - a #GdkScreen which identifies on which + a #GdkScreen which identifies on which the new #GtkInvisible will be created. - - Returns the #GdkScreen object associated with @invisible + + Returns the #GdkScreen object associated with @invisible - the associated #GdkScreen. + the associated #GdkScreen. - a #GtkInvisible. + a #GtkInvisible. - - Sets the #GdkScreen where the #GtkInvisible object will be displayed. + + Sets the #GdkScreen where the #GtkInvisible object will be displayed. - a #GtkInvisible. + a #GtkInvisible. - a #GdkScreen. + a #GdkScreen. @@ -85931,9 +61547,7 @@ for drag-and-drop. - + @@ -85974,160 +61588,71 @@ for drag-and-drop. - - Describes how a rendered element connects to adjacent elements. - - No junctions. + + Describes how a rendered element connects to adjacent elements. + + No junctions. - - Element connects on the top-left corner. + + Element connects on the top-left corner. - - Element connects on the top-right corner. + + Element connects on the top-right corner. - - Element connects on the bottom-left corner. + + Element connects on the bottom-left corner. - - Element connects on the bottom-right corner. + + Element connects on the bottom-right corner. - - Element connects on the top side. + + Element connects on the top side. - - Element connects on the bottom side. + + Element connects on the bottom side. - - Element connects on the left side. + + Element connects on the left side. - - Element connects on the right side. + + Element connects on the right side. - - Used for justifying the text inside a #GtkLabel widget. (See also + + Used for justifying the text inside a #GtkLabel widget. (See also #GtkAlignment). - - The text is placed at the left edge of the label. + + The text is placed at the left edge of the label. - - The text is placed at the right edge of the label. + + The text is placed at the right edge of the label. - - The text is placed in the center of the label. + + The text is placed in the center of the label. - - The text is placed is distributed across the label. + + The text is placed is distributed across the label. - Key snooper functions are called before normal event delivery. + Key snooper functions are called before normal event delivery. They can be used to implement custom key event handling. - %TRUE to stop further processing of @event, %FALSE to continue. + %TRUE to stop further processing of @event, %FALSE to continue. - the widget to which the event will be delivered + the widget to which the event will be delivered - the key event + the key event - - data supplied to gtk_key_snooper_install() + + data supplied to gtk_key_snooper_install() @@ -86139,45 +61664,35 @@ They can be used to implement custom key event handling. - + - + - + - + - + @@ -86191,370 +61706,268 @@ They can be used to implement custom key event handling. - + - + - + - + - + - + - + - + - - The name used for the stock full offset included by #GtkLevelBar. + + The name used for the stock full offset included by #GtkLevelBar. - - The name used for the stock high offset included by #GtkLevelBar. + + The name used for the stock high offset included by #GtkLevelBar. - - The name used for the stock low offset included by #GtkLevelBar. + + The name used for the stock low offset included by #GtkLevelBar. - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - - The #GtkLabel widget displays a small amount of text. As the name + + The #GtkLabel widget displays a small amount of text. As the name implies, most labels are used to label another widget such as a #GtkButton, a #GtkMenuItem, or a #GtkComboBox. @@ -86562,10 +61975,10 @@ implies, most labels are used to label another widget such as a |[<!-- language="plain" --> label -├── [selection] -├── [link] -┊ -╰── [link] +├── [selection] +├── [link] +┊ +╰── [link] ]| GtkLabel has a single CSS node with the name label. A wide variety @@ -86583,8 +61996,8 @@ visited. The GtkLabel implementation of the GtkBuildable interface supports a custom <attributes> element, which supports any number of <attribute> -elements. The <attribute> element has attributes named “name“, “value“, -“start“ and “end“ and allows you to specify #PangoAttribute values for +elements. The <attribute> element has attributes named “name“, “value“, +“start“ and “end“ and allows you to specify #PangoAttribute values for this label. An example of a UI definition fragment specifying Pango attributes: @@ -86605,7 +62018,7 @@ content instead. # Mnemonics -Labels may contain “mnemonics”. Mnemonics are +Labels may contain “mnemonics”. Mnemonics are underlined characters in the label, used for keyboard navigation. Mnemonics are created by providing a string with an underscore before the mnemonic character, such as `"_File"`, to the @@ -86614,8 +62027,8 @@ gtk_label_set_text_with_mnemonic(). Mnemonics automatically activate any activatable widget the label is inside, such as a #GtkButton; if the label is not inside the -mnemonic’s target widget, you have to tell the label about the target -using gtk_label_set_mnemonic_widget(). Here’s a simple example where +mnemonic’s target widget, you have to tell the label about the target +using gtk_label_set_mnemonic_widget(). Here’s a simple example where the label is inside a button: |[<!-- language="C" --> @@ -86625,7 +62038,7 @@ the label is inside a button: gtk_container_add (GTK_CONTAINER (button), label); ]| -There’s a convenience function to create buttons with a mnemonic label +There’s a convenience function to create buttons with a mnemonic label already inside: |[<!-- language="C" --> @@ -86650,7 +62063,7 @@ To make it easy to format text in a label (changing colors, fonts, etc.), label text can be provided in a simple [markup format][PangoMarkupFormat]. -Here’s how to create a label with a small font: +Here’s how to create a label with a small font: |[<!-- language="C" --> GtkWidget *label = gtk_label_new (NULL); gtk_label_set_markup (GTK_LABEL (label), "<small>Small text</small>"); @@ -86662,13 +62075,13 @@ tags in the Pango manual.) The markup passed to gtk_label_set_markup() must be valid; for example, literal <, > and & characters must be escaped as &lt;, &gt;, and &amp;. If you pass text obtained from the user, file, or a network to -gtk_label_set_markup(), you’ll want to escape it with +gtk_label_set_markup(), you’ll want to escape it with g_markup_escape_text() or g_markup_printf_escaped(). Markup strings are just a convenient way to set the #PangoAttrList on a label; gtk_label_set_attributes() may be a simpler way to set attributes in some cases. Be careful though; #PangoAttrList tends to -cause internationalization problems, unless you’re applying attributes +cause internationalization problems, unless you’re applying attributes to the entire string (i.e. unless you set the range of each attribute to [0, %G_MAXINT)). The reason is that specifying the start_index and end_index for a #PangoAttribute requires knowledge of the exact string @@ -86679,7 +62092,7 @@ being displayed, so translations will cause problems. Labels can be made selectable with gtk_label_set_selectable(). Selectable labels allow the user to copy the label contents to the clipboard. Only labels that contain useful-to-copy information -— such as error messages — should be made selectable. +— such as error messages — should be made selectable. # Text layout # {#label-text-layout} @@ -86713,9 +62126,9 @@ Note that the interpretation of #GtkLabel:width-chars and Since 2.18, GTK+ supports markup for clickable hyperlinks in addition to regular Pango markup. The markup for links is borrowed from HTML, -using the `<a>` with “href“ and “title“ attributes. GTK+ renders links +using the `<a>` with “href“ and “title“ attributes. GTK+ renders links similar to the way they appear in web browsers, with colored, underlined -text. The “title“ attribute is displayed as a tooltip on the link. +text. The “title“ attribute is displayed as a tooltip on the link. An example looks like this: @@ -86734,34 +62147,22 @@ the #GtkLabel::activate-link signal and the gtk_label_get_current_uri() function - Creates a new label with the given text inside it. You can + Creates a new label with the given text inside it. You can pass %NULL to get an empty label widget. - the new #GtkLabel + the new #GtkLabel - - The text of the label + + The text of the label - - Creates a new #GtkLabel, containing the text in @str. + + Creates a new #GtkLabel, containing the text in @str. If characters in @str are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use @@ -86777,19 +62178,12 @@ the button or menu item will automatically become the mnemonic widget and be activated by the mnemonic. - the new #GtkLabel + the new #GtkLabel - - The text of the label, with an underscore in front of the + + The text of the label, with an underscore in front of the mnemonic character @@ -86854,33 +62248,23 @@ and be activated by the mnemonic. - - Gets the angle of rotation for the label. See + + Gets the angle of rotation for the label. See gtk_label_set_angle(). - the angle of rotation for the label + the angle of rotation for the label - a #GtkLabel + a #GtkLabel - Gets the attribute list that was set on the label using + Gets the attribute list that was set on the label using gtk_label_set_attributes(), if any. This function does not reflect attributes that come from the labels markup (see gtk_label_set_markup()). If you want to get the @@ -86888,27 +62272,19 @@ effective attributes for the label, use pango_layout_get_attribute (gtk_label_get_layout (label)). - the attribute list, or %NULL + the attribute list, or %NULL if none was set. - a #GtkLabel + a #GtkLabel - - Returns the URI for the currently active link in the label. + + Returns the URI for the currently active link in the label. The active link is the one under the mouse pointer or, in a selectable label, the link in which the text cursor is currently positioned. @@ -86917,90 +62293,64 @@ This function is intended for use in a #GtkLabel::activate-link handler or for use in a #GtkWidget::query-tooltip handler. - the currently active URI. The string is owned by GTK+ and must + the currently active URI. The string is owned by GTK+ and must not be freed or modified. - a #GtkLabel + a #GtkLabel - - Returns the ellipsizing position of the label. See gtk_label_set_ellipsize(). + + Returns the ellipsizing position of the label. See gtk_label_set_ellipsize(). - #PangoEllipsizeMode + #PangoEllipsizeMode - a #GtkLabel + a #GtkLabel - Returns the justification of the label. See gtk_label_set_justify(). + Returns the justification of the label. See gtk_label_set_justify(). - #GtkJustification + #GtkJustification - a #GtkLabel + a #GtkLabel - Fetches the text from a label widget including any embedded + Fetches the text from a label widget including any embedded underlines indicating mnemonics and Pango markup. (See gtk_label_get_text()). - the text of the label widget. This string is + the text of the label widget. This string is owned by the widget and must not be modified or freed. - a #GtkLabel + a #GtkLabel - Gets the #PangoLayout used to display the label. + Gets the #PangoLayout used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with gtk_label_get_layout_offsets(). The returned layout is owned by the @label so need not be @@ -87008,25 +62358,18 @@ freed by the caller. The @label is free to recreate its layout at any time, so it should be considered read-only. - the #PangoLayout for this label + the #PangoLayout for this label - a #GtkLabel + a #GtkLabel - - Obtains the coordinates where the label will draw the #PangoLayout + + Obtains the coordinates where the label will draw the #PangoLayout representing the text in the label; useful to convert mouse events into coordinates inside the #PangoLayout, e.g. to take some action if some part of the label is clicked. Of course you will need to @@ -87041,414 +62384,270 @@ and from pixels using PANGO_PIXELS() or #PANGO_SCALE. - a #GtkLabel + a #GtkLabel - - location to store X offset of layout, or %NULL + + location to store X offset of layout, or %NULL - - location to store Y offset of layout, or %NULL + + location to store Y offset of layout, or %NULL - Returns whether lines in the label are automatically wrapped. + Returns whether lines in the label are automatically wrapped. See gtk_label_set_line_wrap(). - %TRUE if the lines of the label are automatically wrapped. + %TRUE if the lines of the label are automatically wrapped. - a #GtkLabel + a #GtkLabel - - Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode(). + + Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode(). - %TRUE if the lines of the label are automatically wrapped. + %TRUE if the lines of the label are automatically wrapped. - a #GtkLabel + a #GtkLabel - - Gets the number of lines to which an ellipsized, wrapping + + Gets the number of lines to which an ellipsized, wrapping label should be limited. See gtk_label_set_lines(). - The number of lines + The number of lines - a #GtkLabel + a #GtkLabel - - Retrieves the desired maximum width of @label, in characters. See + + Retrieves the desired maximum width of @label, in characters. See gtk_label_set_width_chars(). - the maximum width of the label in characters. + the maximum width of the label in characters. - a #GtkLabel + a #GtkLabel - - If the label has been set so that it has an mnemonic key this function + + If the label has been set so that it has an mnemonic key this function returns the keyval used for the mnemonic accelerator. If there is no mnemonic set up it returns #GDK_KEY_VoidSymbol. - GDK keyval usable for accelerators, or #GDK_KEY_VoidSymbol + GDK keyval usable for accelerators, or #GDK_KEY_VoidSymbol - a #GtkLabel + a #GtkLabel - - Retrieves the target of the mnemonic (keyboard shortcut) of this + + Retrieves the target of the mnemonic (keyboard shortcut) of this label. See gtk_label_set_mnemonic_widget(). - the target of the label’s mnemonic, + the target of the label’s mnemonic, or %NULL if none has been set and the default algorithm will be used. - a #GtkLabel + a #GtkLabel - Gets the value set by gtk_label_set_selectable(). + Gets the value set by gtk_label_set_selectable(). - %TRUE if the user can copy text from the label + %TRUE if the user can copy text from the label - a #GtkLabel + a #GtkLabel - - Gets the selected range of characters in the label, returning %TRUE -if there’s a selection. + + Gets the selected range of characters in the label, returning %TRUE +if there’s a selection. - %TRUE if selection is non-empty + %TRUE if selection is non-empty - a #GtkLabel + a #GtkLabel - - return location for start of selection, as a character offset + + return location for start of selection, as a character offset - - return location for end of selection, as a character offset + + return location for end of selection, as a character offset - - Returns whether the label is in single line mode. + + Returns whether the label is in single line mode. - %TRUE when the label is in single line mode. + %TRUE when the label is in single line mode. - a #GtkLabel + a #GtkLabel - Fetches the text from a label widget, as displayed on the + Fetches the text from a label widget, as displayed on the screen. This does not include any embedded underlines indicating mnemonics or Pango markup. (See gtk_label_get_label()) - the text in the label widget. This is the internal + the text in the label widget. This is the internal string used by the label, and must not be modified. - a #GtkLabel + a #GtkLabel - - Returns whether the label is currently keeping track + + Returns whether the label is currently keeping track of clicked links. - %TRUE if clicked links are remembered + %TRUE if clicked links are remembered - a #GtkLabel + a #GtkLabel - Returns whether the label’s text is interpreted as marked up with + Returns whether the label’s text is interpreted as marked up with the [Pango text markup language][PangoMarkupFormat]. See gtk_label_set_use_markup (). - %TRUE if the label’s text will be parsed for markup. + %TRUE if the label’s text will be parsed for markup. - a #GtkLabel + a #GtkLabel - - Returns whether an embedded underline in the label indicates a + + Returns whether an embedded underline in the label indicates a mnemonic. See gtk_label_set_use_underline(). - %TRUE whether an embedded underline in the label indicates + %TRUE whether an embedded underline in the label indicates the mnemonic accelerator keys. - a #GtkLabel + a #GtkLabel - - Retrieves the desired width of @label, in characters. See + + Retrieves the desired width of @label, in characters. See gtk_label_set_width_chars(). - the width of the label in characters. + the width of the label in characters. - a #GtkLabel + a #GtkLabel - - Gets the #GtkLabel:xalign property for @label. + + Gets the #GtkLabel:xalign property for @label. - the xalign property + the xalign property - a #GtkLabel + a #GtkLabel - - Gets the #GtkLabel:yalign property for @label. + + Gets the #GtkLabel:yalign property for @label. - the yalign property + the yalign property - a #GtkLabel + a #GtkLabel - Selects a range of characters in the label, if the label is selectable. + Selects a range of characters in the label, if the label is selectable. See gtk_label_set_selectable(). If the label is not selectable, this function has no effect. If @start_offset or @end_offset are -1, then the end of the label will be substituted. @@ -87458,31 +62657,21 @@ this function has no effect. If @start_offset or - a #GtkLabel + a #GtkLabel - start offset (in characters not bytes) + start offset (in characters not bytes) - end offset (in characters not bytes) + end offset (in characters not bytes) - - Sets the angle of rotation for the label. An angle of 90 reads from + + Sets the angle of rotation for the label. An angle of 90 reads from from bottom to top, an angle of 270, from top to bottom. The angle setting for the label is ignored if the label is selectable, wrapped, or ellipsized. @@ -87492,24 +62681,18 @@ wrapped, or ellipsized. - a #GtkLabel + a #GtkLabel - the angle that the baseline of the label makes with + the angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise - Sets a #PangoAttrList; the attributes in the list are applied to the + Sets a #PangoAttrList; the attributes in the list are applied to the label text. The attributes set with this function will be applied @@ -87524,28 +62707,17 @@ to the label after the markup string is parsed. - a #GtkLabel + a #GtkLabel - - a #PangoAttrList, or %NULL + + a #PangoAttrList, or %NULL - - Sets the mode used to ellipsize (add an ellipsis: "...") to the text + + Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire string. @@ -87553,23 +62725,17 @@ if there is not enough space to render the entire string. - a #GtkLabel + a #GtkLabel - a #PangoEllipsizeMode + a #PangoEllipsizeMode - Sets the alignment of the lines in the text of the label relative to + Sets the alignment of the lines in the text of the label relative to each other. %GTK_JUSTIFY_LEFT is the default value when the widget is first created with gtk_label_new(). If you instead want to set the alignment of the label as a whole, use gtk_widget_set_halign() instead. @@ -87581,23 +62747,17 @@ single line. - a #GtkLabel + a #GtkLabel - a #GtkJustification + a #GtkJustification - Sets the text of the label. The label is interpreted as + Sets the text of the label. The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the #GtkLabel:use-underline and #GtkLabel:use-markup properties. @@ -87607,56 +62767,42 @@ on the values of the #GtkLabel:use-underline and - a #GtkLabel + a #GtkLabel - the new text to set for the label + the new text to set for the label - Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break -lines if text exceeds the widget’s size. %FALSE lets the text get cut off + Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break +lines if text exceeds the widget’s size. %FALSE lets the text get cut off by the edge of the widget if it exceeds the widget size. Note that setting line wrapping to %TRUE does not make the label -wrap at its parent container’s width, because GTK+ widgets -conceptually can’t make their requisition depend on the parent -container’s size. For a label that wraps at a specific position, -set the label’s width using gtk_widget_set_size_request(). +wrap at its parent container’s width, because GTK+ widgets +conceptually can’t make their requisition depend on the parent +container’s size. For a label that wraps at a specific position, +set the label’s width using gtk_widget_set_size_request(). - a #GtkLabel + a #GtkLabel - the setting + the setting - - If line wrapping is on (see gtk_label_set_line_wrap()) this controls how + + If line wrapping is on (see gtk_label_set_line_wrap()) this controls how the line wrapping is done. The default is %PANGO_WRAP_WORD which means wrap on word boundaries. @@ -87665,27 +62811,19 @@ wrap on word boundaries. - a #GtkLabel + a #GtkLabel - the line wrapping mode + the line wrapping mode - - Sets the number of lines to which an ellipsized, wrapping label + + Sets the number of lines to which an ellipsized, wrapping label should be limited. This has no effect if the label is not wrapping -or ellipsized. Set this to -1 if you don’t want to limit the +or ellipsized. Set this to -1 if you don’t want to limit the number of lines. @@ -87693,25 +62831,19 @@ number of lines. - a #GtkLabel + a #GtkLabel - the desired number of lines, or -1 + the desired number of lines, or -1 - Parses @str which is marked up with the + Parses @str which is marked up with the [Pango text markup language][PangoMarkupFormat], setting the -label’s text and attribute list based on the parse results. +label’s text and attribute list based on the parse results. If the @str is external data, you may need to escape it with g_markup_escape_text() or g_markup_printf_escaped(): @@ -87741,26 +62873,19 @@ See also: gtk_label_set_text() - a #GtkLabel + a #GtkLabel - a markup string (see [Pango markup format][PangoMarkupFormat]) + a markup string (see [Pango markup format][PangoMarkupFormat]) - - Parses @str which is marked up with the + + Parses @str which is marked up with the [Pango text markup language][PangoMarkupFormat], -setting the label’s text and attribute list based on the parse results. +setting the label’s text and attribute list based on the parse results. If characters in @str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. @@ -87772,53 +62897,38 @@ automatically, or explicitly using gtk_label_set_mnemonic_widget(). - a #GtkLabel + a #GtkLabel - a markup string (see + a markup string (see [Pango markup format][PangoMarkupFormat]) - - Sets the desired maximum width in characters of @label to @n_chars. + + Sets the desired maximum width in characters of @label to @n_chars. - a #GtkLabel + a #GtkLabel - the new desired maximum width, in characters. + the new desired maximum width, in characters. - - If the label has been set so that it has an mnemonic key (using + + If the label has been set so that it has an mnemonic key (using i.e. gtk_label_set_markup_with_mnemonic(), gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic() -or the “use_underline” property) the label can be associated with a +or the “use_underline” property) the label can be associated with a widget that is the target of the mnemonic. When the label is inside a widget (like a #GtkButton or a #GtkNotebook tab) it is automatically associated with the correct widget, but sometimes @@ -87835,52 +62945,37 @@ and toggle focus between the colliding widgets otherwise. - a #GtkLabel + a #GtkLabel - - the target #GtkWidget, or %NULL to unset + + the target #GtkWidget, or %NULL to unset - The pattern of underlines you want under the existing text within the + The pattern of underlines you want under the existing text within the #GtkLabel widget. For example if the current text of the label says -“FooBarBaz” passing a pattern of “___ ___” will underline -“Foo” and “Baz” but not “Bar”. +“FooBarBaz” passing a pattern of “___ ___” will underline +“Foo” and “Baz” but not “Bar”. - The #GtkLabel you want to set the pattern to. + The #GtkLabel you want to set the pattern to. - The pattern as described above. + The pattern as described above. - Selectable labels allow the user to select text from the label, for + Selectable labels allow the user to select text from the label, for copy-and-paste. @@ -87888,48 +62983,34 @@ copy-and-paste. - a #GtkLabel + a #GtkLabel - %TRUE to allow selecting text in the label + %TRUE to allow selecting text in the label - - Sets whether the label is in single line mode. + + Sets whether the label is in single line mode. - a #GtkLabel + a #GtkLabel - %TRUE if the label should be in single line mode + %TRUE if the label should be in single line mode - Sets the text within the #GtkLabel widget. It overwrites any text that + Sets the text within the #GtkLabel widget. It overwrites any text that was there before. This function will clear any previously set mnemonic accelerators, and @@ -87945,24 +63026,17 @@ See also: gtk_label_set_markup() - a #GtkLabel + a #GtkLabel - The text you want to set + The text you want to set - - Sets the label’s text from the string @str. + + Sets the label’s text from the string @str. If characters in @str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chosen @@ -87973,25 +63047,17 @@ automatically, or explicitly using gtk_label_set_mnemonic_widget(). - a #GtkLabel + a #GtkLabel - a string + a string - - Sets whether the label should keep track of clicked + + Sets whether the label should keep track of clicked links (and use a different color for them). @@ -87999,24 +63065,18 @@ links (and use a different color for them). - a #GtkLabel + a #GtkLabel - %TRUE to track visited links + %TRUE to track visited links - Sets whether the text of the label contains markup in -[Pango’s text markup language][PangoMarkupFormat]. + Sets whether the text of the label contains markup in +[Pango’s text markup language][PangoMarkupFormat]. See gtk_label_set_markup(). @@ -88024,24 +63084,17 @@ See gtk_label_set_markup(). - a #GtkLabel + a #GtkLabel - %TRUE if the label’s text should be parsed for markup. + %TRUE if the label’s text should be parsed for markup. - - If true, an underline in the text indicates the next character should be + + If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. @@ -88049,101 +63102,68 @@ used for the mnemonic accelerator key. - a #GtkLabel + a #GtkLabel - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics - - Sets the desired width in characters of @label to @n_chars. + + Sets the desired width in characters of @label to @n_chars. - a #GtkLabel + a #GtkLabel - the new desired width, in characters. + the new desired width, in characters. - - Sets the #GtkLabel:xalign property for @label. + + Sets the #GtkLabel:xalign property for @label. - a #GtkLabel + a #GtkLabel - the new xalign value, between 0 and 1 + the new xalign value, between 0 and 1 - - Sets the #GtkLabel:yalign property for @label. + + Sets the #GtkLabel:yalign property for @label. - a #GtkLabel + a #GtkLabel - the new yalign value, between 0 and 1 + the new yalign value, between 0 and 1 - - The angle that the baseline of the label makes with the horizontal, + + The angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise. An angle of 90 reads from from bottom to top, an angle of 270, from top to bottom. Ignored if the label is selectable. @@ -88155,13 +63175,8 @@ if the label is selectable. - - The preferred place to ellipsize the string, if the label does + + The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, specified as a #PangoEllipsizeMode. @@ -88178,9 +63193,7 @@ gtk_label_set_width_chars(). - The contents of the label. + The contents of the label. If the string contains [Pango XML markup][PangoMarkupFormat], you will have to set the #GtkLabel:use-markup property to %TRUE in order for the @@ -88193,25 +63206,15 @@ set the #GtkLabel:use-underline property to %TRUE in order for the label to display them. - - The number of lines to which an ellipsized, wrapping label + + The number of lines to which an ellipsized, wrapping label should be limited. This property has no effect if the label is not wrapping or ellipsized. Set this property to -1 if you don't want to limit the number of lines. - - The desired maximum width of the label, in characters. If this property + + The desired maximum width of the label, in characters. If this property is set to -1, the width will be calculated automatically. See the section on [text layout][label-text-layout] @@ -88225,10 +63228,7 @@ determine the width of ellipsized and wrapped labels. - + @@ -88237,26 +63237,16 @@ determine the width of ellipsized and wrapped labels. - - Whether the label is in single line mode. In single line mode, + + Whether the label is in single line mode. In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar. - - Set this property to %TRUE to make the label track which links + + Set this property to %TRUE to make the label track which links have been visited. It will then apply the #GTK_STATE_FLAG_VISITED when rendering this link, in addition to #GTK_STATE_FLAG_LINK. @@ -88267,13 +63257,8 @@ when rendering this link, in addition to #GTK_STATE_FLAG_LINK. - - The desired width of the label, in characters. If this property is set to + + The desired width of the label, in characters. If this property is set to -1, the width will be calculated automatically. See the section on [text layout][label-text-layout] @@ -88284,36 +63269,21 @@ determine the width of ellipsized and wrapped labels. - - If line wrapping is on (see the #GtkLabel:wrap property) this controls + + If line wrapping is on (see the #GtkLabel:wrap property) this controls how the line wrapping is done. The default is %PANGO_WRAP_WORD, which means wrap on word boundaries. - - The xalign property determines the horizontal aligment of the label text + + The xalign property determines the horizontal aligment of the label text inside the labels size allocation. Compare this to #GtkWidget:halign, which determines how the labels size allocation is positioned in the space available for the label. - - The yalign property determines the vertical aligment of the label text + + The yalign property determines the vertical aligment of the label text inside the labels size allocation. Compare this to #GtkWidget:valign, which determines how the labels size allocation is positioned in the space available for the label. @@ -88325,13 +63295,8 @@ space available for the label. - - A [keybinding signal][GtkBindingSignal] + + A [keybinding signal][GtkBindingSignal] which gets emitted when the user activates a link in the label. Applications may also emit the signal with g_signal_emit_by_name() @@ -88343,30 +63308,22 @@ The default bindings for this signal are all forms of the Enter key. - The signal which gets emitted to activate a URI. + The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri_on_window(). - %TRUE if the link has been activated + %TRUE if the link has been activated - the URI that is activated + the URI that is activated - The ::copy-clipboard signal is a + The ::copy-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to copy the selection to the clipboard. @@ -88376,9 +63333,7 @@ The default binding for this signal is Ctrl-c. - The ::move-cursor signal is a + The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. If the cursor is not visible in @entry, this signal causes @@ -88400,29 +63355,21 @@ There are too many key combinations to list them all here. - the granularity of the move, as a #GtkMovementStep + the granularity of the move, as a #GtkMovementStep - the number of @step units to move + the number of @step units to move - %TRUE if the move should extend the selection + %TRUE if the move should extend the selection - The ::populate-popup signal gets emitted before showing the + The ::populate-popup signal gets emitted before showing the context menu of the label. Note that only selectable labels have context menus. @@ -88433,21 +63380,13 @@ to this signal and append your menuitems to the @menu. - the menu that is being populated + the menu that is being populated - + @@ -88456,26 +63395,19 @@ to this signal and append your menuitems to the @menu. - + - + - + - + @@ -88615,24 +63547,14 @@ to this signal and append your menuitems to the @menu. - + - - #GtkLayout is similar to #GtkDrawingArea in that it’s a “blank slate” and -doesn’t do anything except paint a blank background by default. It’s + + #GtkLayout is similar to #GtkDrawingArea in that it’s a “blank slate” and +doesn’t do anything except paint a blank background by default. It’s different in that it supports scrolling natively due to implementing -#GtkScrollable, and can contain child widgets since it’s a #GtkContainer. +#GtkScrollable, and can contain child widgets since it’s a #GtkContainer. If you just want to draw, a #GtkDrawingArea is a better choice since it has lower overhead. If you just need to position child widgets at specific @@ -88646,68 +63568,41 @@ gtk_widget_get_window() as you would for a #GtkDrawingArea. - Creates a new #GtkLayout. Unless you have a specific adjustment -you’d like the layout to use for scrolling, pass %NULL for + Creates a new #GtkLayout. Unless you have a specific adjustment +you’d like the layout to use for scrolling, pass %NULL for @hadjustment and @vadjustment. - a new #GtkLayout + a new #GtkLayout - - horizontal scroll adjustment, or %NULL + + horizontal scroll adjustment, or %NULL - - vertical scroll adjustment, or %NULL + + vertical scroll adjustment, or %NULL - - Retrieve the bin window of the layout used for drawing operations. + + Retrieve the bin window of the layout used for drawing operations. - a #GdkWindow + a #GdkWindow - a #GtkLayout + a #GtkLayout - - This function should only be called after the layout has been + + This function should only be called after the layout has been placed in a #GtkScrolledWindow or otherwise configured for scrolling. It returns the #GtkAdjustment used for communication between the horizontal scrollbar and @layout. @@ -88716,25 +63611,19 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. Use gtk_scrollable_get_hadjustment() - horizontal scroll adjustment + horizontal scroll adjustment - a #GtkLayout + a #GtkLayout - Gets the size that has been set on the layout, and that determines -the total extents of the layout’s scrollbar area. See + Gets the size that has been set on the layout, and that determines +the total extents of the layout’s scrollbar area. See gtk_layout_set_size (). @@ -88742,44 +63631,23 @@ gtk_layout_set_size (). - a #GtkLayout + a #GtkLayout - - location to store the width set on + + location to store the width set on @layout, or %NULL - - location to store the height set on + + location to store the height set on @layout, or %NULL - - This function should only be called after the layout has been + + This function should only be called after the layout has been placed in a #GtkScrolledWindow or otherwise configured for scrolling. It returns the #GtkAdjustment used for communication between the vertical scrollbar and @layout. @@ -88788,59 +63656,43 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. Use gtk_scrollable_get_vadjustment() - vertical scroll adjustment + vertical scroll adjustment - a #GtkLayout + a #GtkLayout - Moves a current child of @layout to a new position. + Moves a current child of @layout to a new position. - a #GtkLayout + a #GtkLayout - a current child of @layout + a current child of @layout - X position to move to + X position to move to - Y position to move to + Y position to move to - Adds @child_widget to @layout, at position (@x,@y). + Adds @child_widget to @layout, at position (@x,@y). @layout becomes the new parent container of @child_widget. @@ -88848,38 +63700,25 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. - a #GtkLayout + a #GtkLayout - child widget + child widget - X position of child widget + X position of child widget - Y position of child widget + Y position of child widget - - Sets the horizontal scroll adjustment for the layout. + + Sets the horizontal scroll adjustment for the layout. See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. Use gtk_scrollable_set_hadjustment() @@ -88889,58 +63728,38 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. - a #GtkLayout + a #GtkLayout - - new scroll adjustment + + new scroll adjustment - Sets the size of the scrollable area of the layout. + Sets the size of the scrollable area of the layout. - a #GtkLayout + a #GtkLayout - width of entire scrollable area + width of entire scrollable area - height of entire scrollable area + height of entire scrollable area - - Sets the vertical scroll adjustment for the layout. + + Sets the vertical scroll adjustment for the layout. See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. Use gtk_scrollable_set_vadjustment() @@ -88950,18 +63769,11 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. - a #GtkLayout + a #GtkLayout - - new scroll adjustment + + new scroll adjustment @@ -88979,9 +63791,7 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. - + @@ -89022,16 +63832,8 @@ See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. - - The #GtkLevelBar is a bar widget that can be used + + The #GtkLevelBar is a bar widget that can be used as a level indicator. Typical use cases are displaying the strength of a password, or showing the charge level of a battery. @@ -89081,7 +63883,7 @@ create_level_bar (void) } ]| -The default interval of values is between zero and one, but it’s possible to +The default interval of values is between zero and one, but it’s possible to modify the interval using gtk_level_bar_set_min_value() and gtk_level_bar_set_max_value(). The value will be always drawn in proportion to the admissible interval, i.e. a value of 15 with a specified interval between @@ -89091,7 +63893,7 @@ as a finite number of separated blocks instead of a single one. The number of blocks that will be rendered is equal to the number of units specified by the admissible interval. -For instance, to build a bar rendered with five blocks, it’s sufficient to +For instance, to build a bar rendered with five blocks, it’s sufficient to set the minimum value to 0 and the maximum value to 5 after changing the indicator mode to discrete. @@ -89107,11 +63909,11 @@ each of which must have name and value attributes. |[<!-- language="plain" --> levelbar[.discrete] -╰── trough - ├── block.filled.level-name - ┊ - ├── block.empty - ┊ +╰── trough + ├── block.filled.level-name + ┊ + ├── block.empty + ┊ ]| GtkLevelBar has a main CSS node with name levelbar and one of the style @@ -89129,42 +63931,28 @@ regardless of text direction. - Creates a new #GtkLevelBar. + Creates a new #GtkLevelBar. - a #GtkLevelBar. + a #GtkLevelBar. - - Utility constructor that creates a new #GtkLevelBar for the specified + + Utility constructor that creates a new #GtkLevelBar for the specified interval. - a #GtkLevelBar + a #GtkLevelBar - a positive value + a positive value - a positive value + a positive value @@ -89183,12 +63971,8 @@ interval. - - Adds a new offset marker on @self at the position specified by @value. + + Adds a new offset marker on @self at the position specified by @value. When the bar value is in the interval topped by @value (or between @value and #GtkLevelBar:max-value in case the offset is the last one on the bar) a style class named `level-`@name will be applied @@ -89201,183 +63985,115 @@ replaced by @value. - a #GtkLevelBar + a #GtkLevelBar - the name of the new offset + the name of the new offset - the value for the new offset + the value for the new offset - - Return the value of the #GtkLevelBar:inverted property. + + Return the value of the #GtkLevelBar:inverted property. - %TRUE if the level bar is inverted + %TRUE if the level bar is inverted - a #GtkLevelBar + a #GtkLevelBar - - Returns the value of the #GtkLevelBar:max-value property. + + Returns the value of the #GtkLevelBar:max-value property. - a positive value + a positive value - a #GtkLevelBar + a #GtkLevelBar - - Returns the value of the #GtkLevelBar:min-value property. + + Returns the value of the #GtkLevelBar:min-value property. - a positive value + a positive value - a #GtkLevelBar + a #GtkLevelBar - - Returns the value of the #GtkLevelBar:mode property. + + Returns the value of the #GtkLevelBar:mode property. - a #GtkLevelBarMode + a #GtkLevelBarMode - a #GtkLevelBar + a #GtkLevelBar - - Fetches the value specified for the offset marker @name in @self, + + Fetches the value specified for the offset marker @name in @self, returning %TRUE in case an offset named @name was found. - %TRUE if the specified offset is found + %TRUE if the specified offset is found - a #GtkLevelBar + a #GtkLevelBar - - the name of an offset in the bar + + the name of an offset in the bar - - location where to store the value + + location where to store the value - - Returns the value of the #GtkLevelBar:value property. + + Returns the value of the #GtkLevelBar:value property. - a value in the interval between + a value in the interval between #GtkLevelBar:min-value and #GtkLevelBar:max-value - a #GtkLevelBar + a #GtkLevelBar - - Removes an offset marker previously added with + + Removes an offset marker previously added with gtk_level_bar_add_offset_value(). @@ -89385,53 +64101,34 @@ gtk_level_bar_add_offset_value(). - a #GtkLevelBar + a #GtkLevelBar - - the name of an offset in the bar + + the name of an offset in the bar - - Sets the value of the #GtkLevelBar:inverted property. + + Sets the value of the #GtkLevelBar:inverted property. - a #GtkLevelBar + a #GtkLevelBar - %TRUE to invert the level bar + %TRUE to invert the level bar - - Sets the value of the #GtkLevelBar:max-value property. + + Sets the value of the #GtkLevelBar:max-value property. You probably want to update preexisting level offsets after calling this function. @@ -89441,25 +64138,17 @@ this function. - a #GtkLevelBar + a #GtkLevelBar - a positive value + a positive value - - Sets the value of the #GtkLevelBar:min-value property. + + Sets the value of the #GtkLevelBar:min-value property. You probably want to update preexisting level offsets after calling this function. @@ -89469,107 +64158,67 @@ this function. - a #GtkLevelBar + a #GtkLevelBar - a positive value + a positive value - - Sets the value of the #GtkLevelBar:mode property. + + Sets the value of the #GtkLevelBar:mode property. - a #GtkLevelBar + a #GtkLevelBar - a #GtkLevelBarMode + a #GtkLevelBarMode - - Sets the value of the #GtkLevelBar:value property. + + Sets the value of the #GtkLevelBar:value property. - a #GtkLevelBar + a #GtkLevelBar - a value in the interval between + a value in the interval between #GtkLevelBar:min-value and #GtkLevelBar:max-value - - Level bars normally grow from top to bottom or left to right. + + Level bars normally grow from top to bottom or left to right. Inverted level bars grow in the opposite direction. - - The #GtkLevelBar:max-value property determaxes the maximum value of + + The #GtkLevelBar:max-value property determaxes the maximum value of the interval that can be displayed by the bar. - - The #GtkLevelBar:min-value property determines the minimum value of + + The #GtkLevelBar:min-value property determines the minimum value of the interval that can be displayed by the bar. - - The #GtkLevelBar:mode property determines the way #GtkLevelBar + + The #GtkLevelBar:mode property determines the way #GtkLevelBar interprets the value properties to draw the level fill area. Specifically, when the value is #GTK_LEVEL_BAR_MODE_CONTINUOUS, #GtkLevelBar will draw a single block representing the current value in @@ -89579,13 +64228,8 @@ draw area, with the number of blocks being equal to the units separating the integral roundings of #GtkLevelBar:min-value and #GtkLevelBar:max-value. - - The #GtkLevelBar:value property determines the currently + + The #GtkLevelBar:value property determines the currently filled value of the level bar. @@ -89595,13 +64239,8 @@ filled value of the level bar. - - Emitted when an offset specified on the bar changes value as an + + Emitted when an offset specified on the bar changes value as an effect to gtk_level_bar_add_offset_value() being called. The signal supports detailed connections; you can connect to the @@ -89612,21 +64251,13 @@ the value of offset "x" changes. - the name of the offset that changed value + the name of the offset that changed value - + @@ -89634,26 +64265,19 @@ the value of offset "x" changes. - + - + - + - + @@ -89680,202 +64304,82 @@ the value of offset "x" changes. - - Describes how #GtkLevelBar contents should be rendered. + + Describes how #GtkLevelBar contents should be rendered. Note that this enumeration could be extended with additional modes in the future. - - the bar has a continuous mode + + the bar has a continuous mode - - the bar has a discrete mode + + the bar has a discrete mode - - The type of license for an application. + + The type of license for an application. This enumeration can be expanded at later date. - - No license specified + + No license specified - - A license text is going to be specified by the + + A license text is going to be specified by the developer - - The GNU General Public License, version 2.0 or later + + The GNU General Public License, version 2.0 or later - - The GNU General Public License, version 3.0 or later + + The GNU General Public License, version 3.0 or later - - The GNU Lesser General Public License, version 2.1 or later + + The GNU Lesser General Public License, version 2.1 or later - - The GNU Lesser General Public License, version 3.0 or later + + The GNU Lesser General Public License, version 3.0 or later - - The BSD standard license + + The BSD standard license - - The MIT/X11 standard license + + The MIT/X11 standard license - - The Artistic License, version 2.0 + + The Artistic License, version 2.0 - - The GNU General Public License, version 2.0 only. Since 3.12. + + The GNU General Public License, version 2.0 only. Since 3.12. - - The GNU General Public License, version 3.0 only. Since 3.12. + + The GNU General Public License, version 3.0 only. Since 3.12. - - The GNU Lesser General Public License, version 2.1 only. Since 3.12. + + The GNU Lesser General Public License, version 2.1 only. Since 3.12. - - The GNU Lesser General Public License, version 3.0 only. Since 3.12. + + The GNU Lesser General Public License, version 3.0 only. Since 3.12. - - The GNU Affero General Public License, version 3.0 or later. Since: 3.22. + + The GNU Affero General Public License, version 3.0 or later. Since: 3.22. - - The GNU Affero General Public License, version 3.0 only. Since: 3.22.27. + + The GNU Affero General Public License, version 3.0 only. Since: 3.22.27. - - The 3-clause BSD licence. Since: 3.24.20. + + The 3-clause BSD licence. Since: 3.24.20. - - The Apache License, version 2.0. Since: 3.24.20. + + The Apache License, version 2.0. Since: 3.24.20. - - The Mozilla Public License, version 2.0. Since: 3.24.20. + + The Mozilla Public License, version 2.0. Since: 3.24.20. - - A GtkLinkButton is a #GtkButton with a hyperlink, similar to the one + + A GtkLinkButton is a #GtkButton with a hyperlink, similar to the one used by web browsers, which triggers an action when clicked. It is useful to show quick links to resources. @@ -89900,55 +64404,34 @@ it from a plain #GtkButton, it gets the .link style class. - - Creates a new #GtkLinkButton with the URI as its text. + + Creates a new #GtkLinkButton with the URI as its text. - a new link button widget. + a new link button widget. - a valid URI + a valid URI - - Creates a new #GtkLinkButton containing a label. + + Creates a new #GtkLinkButton containing a label. - a new link button widget. + a new link button widget. - a valid URI + a valid URI - - the text of the button + + the text of the button @@ -89964,87 +64447,59 @@ it from a plain #GtkButton, it gets the .link style class. - - Retrieves the URI set using gtk_link_button_set_uri(). + + Retrieves the URI set using gtk_link_button_set_uri(). - a valid URI. The returned string is owned by the link button + a valid URI. The returned string is owned by the link button and should not be modified or freed. - a #GtkLinkButton + a #GtkLinkButton - - Retrieves the “visited” state of the URI where the #GtkLinkButton + + Retrieves the “visited” state of the URI where the #GtkLinkButton points. The button becomes visited when it is clicked. If the URI -is changed on the button, the “visited” state is unset again. +is changed on the button, the “visited” state is unset again. The state may also be changed using gtk_link_button_set_visited(). - %TRUE if the link has been visited, %FALSE otherwise + %TRUE if the link has been visited, %FALSE otherwise - a #GtkLinkButton + a #GtkLinkButton - - Sets @uri as the URI where the #GtkLinkButton points. As a side-effect -this unsets the “visited” state of the button. + + Sets @uri as the URI where the #GtkLinkButton points. As a side-effect +this unsets the “visited” state of the button. - a #GtkLinkButton + a #GtkLinkButton - a valid URI + a valid URI - - Sets the “visited” state of the URI where the #GtkLinkButton + + Sets the “visited” state of the URI where the #GtkLinkButton points. See gtk_link_button_get_visited() for more details. @@ -90052,35 +64507,21 @@ points. See gtk_link_button_get_visited() for more details. - a #GtkLinkButton + a #GtkLinkButton - the new “visited” state + the new “visited” state - - The URI bound to this button. + + The URI bound to this button. - - The 'visited' state of this button. A visited link is drawn in a + + The 'visited' state of this button. A visited link is drawn in a different color. @@ -90091,9 +64532,7 @@ different color. - The ::activate-link signal is emitted each time the #GtkLinkButton + The ::activate-link signal is emitted each time the #GtkLinkButton has been clicked. The default handler will call gtk_show_uri_on_window() with the URI stored inside @@ -90107,15 +64546,8 @@ your handler. - - + + @@ -90124,31 +64556,20 @@ your handler. - + - - + + - - + + - - The #GtkLinkButtonClass contains only + + The #GtkLinkButtonClass contains only private data. @@ -90200,22 +64621,12 @@ private data. - + - - A GtkListBox is a vertical container that contains GtkListBoxRow -children. These rows can by dynamically sorted and filtered, and + + A GtkListBox is a vertical container that contains GtkListBoxRow +children. These rows can be dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list. @@ -90239,14 +64650,14 @@ The GtkListBox widget was added in GTK+ 3.10. # GtkListBox as GtkBuildable The GtkListBox implementation of the #GtkBuildable interface supports -setting a child as the placeholder by specifying “placeholder” as the “type” +setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a <child> element. See gtk_list_box_set_placeholder() for info. # CSS nodes |[<!-- language="plain" --> list -╰── row[.activatable] +╰── row[.activatable] ]| GtkListBox uses a single CSS node named list. Each GtkListBoxRow uses @@ -90256,14 +64667,10 @@ style class added when appropriate. - Creates a new #GtkListBox container. + Creates a new #GtkListBox container. - a new #GtkListBox + a new #GtkListBox @@ -90324,18 +64731,14 @@ style class added when appropriate. - Select all children of @box, if the selection mode allows it. + Select all children of @box, if the selection mode allows it. - a #GtkListBox + a #GtkListBox @@ -90362,31 +64765,21 @@ style class added when appropriate. - - Unselect all children of @box, if the selection mode allows it. + + Unselect all children of @box, if the selection mode allows it. - a #GtkListBox + a #GtkListBox - - Binds @model to @box. + + Binds @model to @box. If @box was already bound to a model, that previous binding is destroyed. @@ -90408,59 +64801,30 @@ should be implemented by the model. - a #GtkListBox + a #GtkListBox - - the #GListModel to be bound to @box + + the #GListModel to be bound to @box - - a function that creates widgets for items + + a function that creates widgets for items or %NULL in case you also passed %NULL as @model - + - - user data passed to @create_widget_func + + user data passed to @create_widget_func - - function for freeing @user_data + + function for freeing @user_data - - This is a helper function for implementing DnD onto a #GtkListBox. + + This is a helper function for implementing DnD onto a #GtkListBox. The passed in @row will be highlighted via gtk_drag_highlight(), and any previously highlighted row will be unhighlighted. @@ -90472,25 +64836,17 @@ a drag leave event. - a #GtkListBox + a #GtkListBox - a #GtkListBoxRow + a #GtkListBoxRow - - If a row has previously been highlighted via gtk_list_box_drag_highlight_row() + + If a row has previously been highlighted via gtk_list_box_drag_highlight_row() it will have the highlight removed. @@ -90498,154 +64854,102 @@ it will have the highlight removed. - a #GtkListBox + a #GtkListBox - - Returns whether rows activate on single clicks. + + Returns whether rows activate on single clicks. - %TRUE if rows are activated on single click, %FALSE otherwise + %TRUE if rows are activated on single click, %FALSE otherwise - a #GtkListBox + a #GtkListBox - - Gets the adjustment (if any) that the widget uses to + + Gets the adjustment (if any) that the widget uses to for vertical scrolling. - the adjustment + the adjustment - a #GtkListBox + a #GtkListBox - - Gets the n-th child in the list (not counting headers). + + Gets the n-th child in the list (not counting headers). If @_index is negative or larger than the number of items in the list, %NULL is returned. - the child #GtkWidget or %NULL + the child #GtkWidget or %NULL - a #GtkListBox + a #GtkListBox - the index of the row + the index of the row - - Gets the row at the @y position. + + Gets the row at the @y position. - the row or %NULL + the row or %NULL in case no row exists for the given y coordinate. - a #GtkListBox + a #GtkListBox - position + position - - Gets the selected row. + + Gets the selected row. Note that the box may allow multiple selection, in which case you should use gtk_list_box_selected_foreach() to find all selected rows. - the selected row + the selected row - a #GtkListBox + a #GtkListBox - - Creates a list of all selected children. + + Creates a list of all selected children. - + A #GList containing the #GtkWidget for each selected child. Free with g_list_free() when done. @@ -90654,39 +64958,27 @@ find all selected rows. - a #GtkListBox + a #GtkListBox - - Gets the selection mode of the listbox. + + Gets the selection mode of the listbox. - a #GtkSelectionMode + a #GtkSelectionMode - a #GtkListBox + a #GtkListBox - Insert the @child into the @box at @position. If a sort function is + Insert the @child into the @box at @position. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of gtk_container_add(). @@ -90698,31 +64990,21 @@ If @position is -1, or larger than the total number of items in the - a #GtkListBox + a #GtkListBox - the #GtkWidget to add + the #GtkWidget to add - the position to insert @child in + the position to insert @child in - - Update the filtering for all rows. Call this when result + + Update the filtering for all rows. Call this when result of the filter function on the @box is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search @@ -90733,19 +65015,13 @@ string and the entry with the search string has changed. - a #GtkListBox + a #GtkListBox - - Update the separators for all rows. Call this when result + + Update the separators for all rows. Call this when result of the header function on the @box is changed due to an external factor. @@ -90754,19 +65030,13 @@ to an external factor. - a #GtkListBox + a #GtkListBox - - Update the sorting for all rows. Call this when result + + Update the sorting for all rows. Call this when result of the sort function on the @box is changed due to an external factor. @@ -90775,19 +65045,13 @@ to an external factor. - a #GtkListBox + a #GtkListBox - - Prepend a widget to the list. If a sort function is set, the widget will + + Prepend a widget to the list. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of gtk_container_add(). @@ -90796,72 +65060,47 @@ same effect of gtk_container_add(). - a #GtkListBox + a #GtkListBox - the #GtkWidget to add + the #GtkWidget to add - - Select all children of @box, if the selection mode allows it. + + Select all children of @box, if the selection mode allows it. - a #GtkListBox + a #GtkListBox - - Make @row the currently selected row. + + Make @row the currently selected row. - a #GtkListBox + a #GtkListBox - - The row to select or %NULL + + The row to select or %NULL - - Calls a function for each selected child. + + Calls a function for each selected child. Note that the selection cannot be modified from within this function. @@ -90870,37 +65109,21 @@ Note that the selection cannot be modified from within this function. - a #GtkListBox + a #GtkListBox - - the function to call for each selected child + + the function to call for each selected child - - user data to pass to the function + + user data to pass to the function - - If @single is %TRUE, rows will be activated when you click on them, + + If @single is %TRUE, rows will be activated when you click on them, otherwise you need to double-click. @@ -90908,25 +65131,17 @@ otherwise you need to double-click. - a #GtkListBox + a #GtkListBox - a boolean + a boolean - - Sets the adjustment (if any) that the widget uses to + + Sets the adjustment (if any) that the widget uses to for vertical scrolling. For instance, this is used to get the page size for PageUp/Down key handling. @@ -90940,28 +65155,17 @@ to manually do that. - a #GtkListBox + a #GtkListBox - - the adjustment, or %NULL + + the adjustment, or %NULL - - By setting a filter function on the @box one can decide dynamically which + + By setting a filter function on the @box one can decide dynamically which of the rows to show. For instance, to implement a search function on a list that filters the original list to only show the matching rows. @@ -90977,46 +65181,25 @@ Note that using a filter function is incompatible with using a model - a #GtkListBox + a #GtkListBox - - callback that lets you filter which rows to show + + callback that lets you filter which rows to show - - user data passed to @filter_func + + user data passed to @filter_func - destroy notifier for @user_data + destroy notifier for @user_data - - By setting a header function on the @box one can dynamically add headers + + By setting a header function on the @box one can dynamically add headers in front of rows, depending on the contents of the row and its position in the list. For instance, one could use it to add headers in front of the first item of a new kind, in a list sorted by the kind. @@ -91026,7 +65209,7 @@ and either update the state of the widget as needed, or set a new one using gtk_list_box_row_set_header(). If no header is needed, set the header to %NULL. Note that you may get many calls @update_header to this for a particular row when e.g. -changing things that don’t affect the header. In this case it is important for performance +changing things that don’t affect the header. In this case it is important for performance to not blindly replace an existing header with an identical one. The @update_header function will be called for each row after the call, and it will @@ -91040,47 +65223,25 @@ gtk_list_box_invalidate_headers() is called. - a #GtkListBox + a #GtkListBox - - callback that lets you add row headers - + + callback that lets you add row headers + - - user data passed to @update_header + + user data passed to @update_header - destroy notifier for @user_data + destroy notifier for @user_data - - Sets the placeholder widget that is shown in the list when + + Sets the placeholder widget that is shown in the list when it doesn't display any visible children. @@ -91088,28 +65249,17 @@ it doesn't display any visible children. - a #GtkListBox + a #GtkListBox - - a #GtkWidget or %NULL + + a #GtkWidget or %NULL - - Sets how selection works in the listbox. + + Sets how selection works in the listbox. See #GtkSelectionMode for details. @@ -91117,25 +65267,17 @@ See #GtkSelectionMode for details. - a #GtkListBox + a #GtkListBox - The #GtkSelectionMode + The #GtkSelectionMode - - By setting a sort function on the @box one can dynamically reorder the rows + + By setting a sort function on the @box one can dynamically reorder the rows of the list, based on the contents of the rows. The @sort_func will be called for each row after the call, and will continue to @@ -91150,87 +65292,54 @@ Note that using a sort function is incompatible with using a model - a #GtkListBox + a #GtkListBox - - the sort function + + the sort function - - user data passed to @sort_func + + user data passed to @sort_func - destroy notifier for @user_data + destroy notifier for @user_data - - Unselect all children of @box, if the selection mode allows it. + + Unselect all children of @box, if the selection mode allows it. - a #GtkListBox + a #GtkListBox - - Unselects a single row of @box, if the selection mode allows it. + + Unselects a single row of @box, if the selection mode allows it. - a #GtkListBox + a #GtkListBox - the row to unselected + the row to unselected - + @@ -91258,25 +65367,19 @@ Note that using a sort function is incompatible with using a model - The ::row-activated signal is emitted when a row has been activated by the user. + The ::row-activated signal is emitted when a row has been activated by the user. - the activated row + the activated row - The ::row-selected signal is emitted when a new row is selected, or + The ::row-selected signal is emitted when a new row is selected, or (with a %NULL @row) when the selection is cleared. When the @box is using #GTK_SELECTION_MULTIPLE, this signal will not @@ -91286,21 +65389,14 @@ the #GtkListBox::selected-rows-changed signal instead. - - the selected row + + the selected row - The ::select-all signal is a [keybinding signal][GtkBindingSignal] + The ::select-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select all children of the box, if the selection mode permits it. @@ -91310,9 +65406,7 @@ The default bindings for this signal is Ctrl-a. - The ::selected-rows-changed signal is emitted when the + The ::selected-rows-changed signal is emitted when the set of selected rows changes. @@ -91324,9 +65418,7 @@ set of selected rows changes. - The ::unselect-all signal is a [keybinding signal][GtkBindingSignal] + The ::unselect-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to unselect all children of the box, if the selection mode permits it. @@ -91336,13 +65428,7 @@ The default bindings for this signal is Ctrl-Shift-a. - + @@ -91350,32 +65436,22 @@ The default bindings for this signal is Ctrl-Shift-a. - + - + - + - + - + - The parent class. + The parent class. @@ -91476,9 +65552,7 @@ The default bindings for this signal is Ctrl-Shift-a. - a #GtkListBox + a #GtkListBox @@ -91492,9 +65566,7 @@ The default bindings for this signal is Ctrl-Shift-a. - a #GtkListBox + a #GtkListBox @@ -91525,12 +65597,8 @@ The default bindings for this signal is Ctrl-Shift-a. - - Called for list boxes that are bound to a #GListModel with + + Called for list boxes that are bound to a #GListModel with gtk_list_box_bind_model() for each item that gets added to the model. Versions of GTK+ prior to 3.18 called gtk_widget_show_all() on the rows @@ -91539,69 +65607,41 @@ inside the row to be shown, and is no longer the case. Applications should be updated to show the desired row widgets. - a #GtkWidget that represents @item + a #GtkWidget that represents @item - the item from the model for which to create a widget for + the item from the model for which to create a widget for - - user data + + user data - - Will be called whenever the row changes or is added and lets you control + + Will be called whenever the row changes or is added and lets you control if the row should be visible or not. - %TRUE if the row should be visible, %FALSE otherwise + %TRUE if the row should be visible, %FALSE otherwise - the row that may be filtered + the row that may be filtered - - user data + + user data - - A function used by gtk_list_box_selected_foreach(). + + A function used by gtk_list_box_selected_foreach(). It will be called on every selected child of the @box. @@ -91609,51 +65649,29 @@ It will be called on every selected child of the @box. - a #GtkListBox + a #GtkListBox - a #GtkListBoxRow + a #GtkListBoxRow - - user data + + user data - + - - Creates a new #GtkListBoxRow, to be used as a child of a #GtkListBox. + + Creates a new #GtkListBoxRow, to be used as a child of a #GtkListBox. - a new #GtkListBoxRow + a new #GtkListBoxRow @@ -91668,12 +65686,8 @@ It will be called on every selected child of the @box. - - Marks @row as changed, causing any state that depends on this + + Marks @row as changed, causing any state that depends on this to be updated. This affects sorting, filtering and headers. Note that calls to this method must be in sync with the data @@ -91684,7 +65698,7 @@ on the first row the sort function must only read the new data for the first of the two changed rows, otherwise the resorting of the rows will be wrong. -This generally means that if you don’t fully control the data +This generally means that if you don’t fully control the data model you have to duplicate the data that affects the listbox row functions into the row widgets themselves. Another alternative is to call gtk_list_box_invalidate_sort() on any model change, @@ -91695,159 +65709,105 @@ but that is more expensive. - a #GtkListBoxRow + a #GtkListBoxRow - - Gets the value of the #GtkListBoxRow:activatable property + + Gets the value of the #GtkListBoxRow:activatable property for this row. - %TRUE if the row is activatable + %TRUE if the row is activatable - a #GtkListBoxRow + a #GtkListBoxRow - - Returns the current header of the @row. This can be used + + Returns the current header of the @row. This can be used in a #GtkListBoxUpdateHeaderFunc to see if there is a header set already, and if so to update the state of it. - the current header, or %NULL if none + the current header, or %NULL if none - a #GtkListBoxRow + a #GtkListBoxRow - - Gets the current index of the @row in its #GtkListBox container. + + Gets the current index of the @row in its #GtkListBox container. - the index of the @row, or -1 if the @row is not in a listbox + the index of the @row, or -1 if the @row is not in a listbox - a #GtkListBoxRow + a #GtkListBoxRow - - Gets the value of the #GtkListBoxRow:selectable property + + Gets the value of the #GtkListBoxRow:selectable property for this row. - %TRUE if the row is selectable + %TRUE if the row is selectable - a #GtkListBoxRow + a #GtkListBoxRow - - Returns whether the child is currently selected in its + + Returns whether the child is currently selected in its #GtkListBox container. - %TRUE if @row is selected + %TRUE if @row is selected - a #GtkListBoxRow + a #GtkListBoxRow - - Set the #GtkListBoxRow:activatable property for this row. + + Set the #GtkListBoxRow:activatable property for this row. - a #GtkListBoxRow + a #GtkListBoxRow - %TRUE to mark the row as activatable + %TRUE to mark the row as activatable - - Sets the current header of the @row. This is only allowed to be called + + Sets the current header of the @row. This is only allowed to be called from a #GtkListBoxUpdateHeaderFunc. It will replace any existing header in the row, and be shown in front of the row in the listbox. @@ -91856,113 +65816,71 @@ header in the row, and be shown in front of the row in the listbox. - a #GtkListBoxRow + a #GtkListBoxRow - - the header, or %NULL + + the header, or %NULL - - Set the #GtkListBoxRow:selectable property for this row. + + Set the #GtkListBoxRow:selectable property for this row. - a #GtkListBoxRow + a #GtkListBoxRow - %TRUE to mark the row as selectable + %TRUE to mark the row as selectable - - The property determines whether the #GtkListBox::row-activated + + The property determines whether the #GtkListBox::row-activated signal will be emitted for this row. - - The property determines whether this row can be selected. + + The property determines whether this row can be selected. - This is a keybinding signal, which will cause this row to be activated. + This is a keybinding signal, which will cause this row to be activated. If you want to be notified when the user activates a row (by key or not), -use the #GtkListBox::row-activated signal on the row’s parent #GtkListBox. +use the #GtkListBox::row-activated signal on the row’s parent #GtkListBox. - - + + - - + + - + - + - The parent class. + The parent class. @@ -91995,51 +65913,31 @@ use the #GtkListBox::row-activated signal on the row’s parent #GtkListBox. - - Compare two rows to determine which should be first. + + Compare two rows to determine which should be first. - < 0 if @row1 should be before @row2, 0 if they are + < 0 if @row1 should be before @row2, 0 if they are equal and > 0 otherwise - the first row + the first row - the second row + the second row - - user data + + user data - - Whenever @row changes or which row is before @row changes this + + Whenever @row changes or which row is before @row changes this is called, which lets you update the header on @row. You may remove or set a new one via gtk_list_box_row_set_header() or just change the state of the current header widget. @@ -92049,42 +65947,21 @@ just change the state of the current header widget. - the row to update + the row to update - - the row before @row, or %NULL if it is first + + the row before @row, or %NULL if it is first - - user data + + user data - - The #GtkListStore object is a list model for use with a #GtkTreeView + + The #GtkListStore object is a list model for use with a #GtkTreeView widget. It implements the #GtkTreeModel interface, and consequentialy, can use all of the methods available there. It also implements the #GtkTreeSortable interface so it can be sorted by the view. @@ -92093,7 +65970,7 @@ Finally, it also implements the tree interfaces. The #GtkListStore can accept most GObject types as a column type, though -it can’t accept all custom types. Internally, it will keep a copy of +it can’t accept all custom types. Internally, it will keep a copy of data passed in (such as a string or a boxed pointer). Columns that accept #GObjects are handled a little differently. The #GtkListStore will keep a reference to the object instead of copying the @@ -92184,7 +66061,7 @@ function must be prepared for that. The GtkListStore implementation of the GtkBuildable interface allows to specify the model columns with a <columns> element that may contain -multiple <column> elements, each specifying one model column. The “type” +multiple <column> elements, each specifying one model column. The “type” attribute specifies the data type for the column. Additionally, it is possible to specify content for the list store @@ -92225,13 +66102,8 @@ An example of a UI Definition fragment for a list store: - - Creates a new list store as with @n_columns columns each of the types passed + + Creates a new list store as with @n_columns columns each of the types passed in. Note that only types derived from standard GObject fundamental types are supported. @@ -92240,50 +66112,34 @@ GDK_TYPE_PIXBUF);` will create a new #GtkListStore with three columns, of type int, string and #GdkPixbuf respectively. - a new #GtkListStore + a new #GtkListStore - number of columns in the list store + number of columns in the list store - all #GType types for the columns, from first to last + all #GType types for the columns, from first to last - - Non-vararg creation function. Used primarily by language bindings. + + Non-vararg creation function. Used primarily by language bindings. - a new #GtkListStore + a new #GtkListStore - number of columns in the list store + number of columns in the list store - an array of #GType types for the columns, from first to last + an array of #GType types for the columns, from first to last @@ -92291,9 +66147,7 @@ int, string and #GdkPixbuf respectively. - Appends a new row to @list_store. @iter will be changed to point to this new + Appends a new row to @list_store. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). @@ -92302,43 +66156,30 @@ values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the appended row + + An unset #GtkTreeIter to set to the appended row - Removes all rows from the list store. + Removes all rows from the list store. - a #GtkListStore. + a #GtkListStore. - Creates a new row at @position. @iter will be changed to point to this new + Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1 or is larger than the number of rows on the list, then the new row will be appended to the list. The row will be empty after this function is called. To fill in values, you need to call @@ -92349,32 +66190,21 @@ gtk_list_store_set() or gtk_list_store_set_value(). - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the new row + + An unset #GtkTreeIter to set to the new row - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - Inserts a new row after @sibling. If @sibling is %NULL, then the row will be + Inserts a new row after @sibling. If @sibling is %NULL, then the row will be prepended to the beginning of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). @@ -92384,35 +66214,21 @@ in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().< - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the new row + + An unset #GtkTreeIter to set to the new row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - Inserts a new row before @sibling. If @sibling is %NULL, then the row will + Inserts a new row before @sibling. If @sibling is %NULL, then the row will be appended to the end of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). @@ -92422,38 +66238,21 @@ values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the new row + + An unset #GtkTreeIter to set to the new row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - - Creates a new row at @position. @iter will be changed to point to this new + + Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1, or larger than the number of rows in the list, then the new row will be appended to the list. The row will be filled with the values given to this function. @@ -92486,43 +66285,26 @@ inserting rows in a sorted list store. - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the new row, or %NULL + + An unset #GtkTreeIter to set to the new row, or %NULL - position to insert the new row, or -1 to append after existing + position to insert the new row, or -1 to append after existing rows - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - - A variant of gtk_list_store_insert_with_values() which + + A variant of gtk_list_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings. @@ -92532,89 +66314,58 @@ language-bindings. - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the new row, or %NULL. + + An unset #GtkTreeIter to set to the new row, or %NULL. - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - - > This function is slow. Only use it for debugging and/or testing + + > This function is slow. Only use it for debugging and/or testing > purposes. Checks if the given iter is a valid iter for this #GtkListStore. - %TRUE if the iter is valid, %FALSE if the iter is invalid. + %TRUE if the iter is valid, %FALSE if the iter is invalid. - A #GtkListStore. + A #GtkListStore. - A #GtkTreeIter. + A #GtkTreeIter. - - Moves @iter in @store to the position after @position. Note that this + + Moves @iter in @store to the position after @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the start of the list. @@ -92623,34 +66374,21 @@ will be moved to the start of the list. - A #GtkListStore. + A #GtkListStore. - A #GtkTreeIter. + A #GtkTreeIter. - - A #GtkTreeIter or %NULL. + + A #GtkTreeIter or %NULL. - - Moves @iter in @store to the position before @position. Note that this + + Moves @iter in @store to the position before @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the end of the list. @@ -92659,32 +66397,21 @@ will be moved to the end of the list. - A #GtkListStore. + A #GtkListStore. - A #GtkTreeIter. + A #GtkTreeIter. - - A #GtkTreeIter, or %NULL. + + A #GtkTreeIter, or %NULL. - Prepends a new row to @list_store. @iter will be changed to point to this new + Prepends a new row to @list_store. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). @@ -92693,56 +66420,37 @@ values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). - A #GtkListStore + A #GtkListStore - - An unset #GtkTreeIter to set to the prepend row + + An unset #GtkTreeIter to set to the prepend row - Removes the given row from the list store. After being removed, + Removes the given row from the list store. After being removed, @iter is set to be the next valid row, or invalidated if it pointed to the last row in @list_store. - %TRUE if @iter is valid, %FALSE if not. + %TRUE if @iter is valid, %FALSE if not. - A #GtkListStore + A #GtkListStore - A valid #GtkTreeIter + A valid #GtkTreeIter - - Reorders @store to follow the order indicated by @new_order. Note that + + Reorders @store to follow the order indicated by @new_order. Note that this function only works with unsorted stores. @@ -92750,35 +66458,26 @@ this function only works with unsorted stores. - A #GtkListStore. + A #GtkListStore. - an array of integers mapping the new + an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos`. It must have - exactly as many items as the list store’s length. + exactly as many items as the list store’s length. - - Sets the value of one or more cells in the row referenced by @iter. + + Sets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by the value to be set. The list is terminated by a -1. For example, to set column 0 with type -%G_TYPE_STRING to “Foo”, you would write `gtk_list_store_set (store, iter, +%G_TYPE_STRING to “Foo”, you would write `gtk_list_store_set (store, iter, 0, "Foo", -1)`. The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it @@ -92789,30 +66488,21 @@ will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED. - a #GtkListStore + a #GtkListStore - row iterator + row iterator - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - - This function is meant primarily for #GObjects that inherit from #GtkListStore, + + This function is meant primarily for #GObjects that inherit from #GtkListStore, and should only be used when constructing a new #GtkListStore. It will not function after a row has been added, or a method on the #GtkTreeModel interface is called. @@ -92822,33 +66512,23 @@ interface is called. - A #GtkListStore + A #GtkListStore - Number of columns for the list store + Number of columns for the list store - An array length n of #GTypes + An array length n of #GTypes - - See gtk_list_store_set(); this version takes a va_list for use by language + + See gtk_list_store_set(); this version takes a va_list for use by language bindings. @@ -92856,29 +66536,21 @@ bindings. - A #GtkListStore + A #GtkListStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - va_list of column/value pairs + va_list of column/value pairs - Sets the data in the cell specified by @iter and @column. + Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column. @@ -92887,38 +66559,25 @@ column. - A #GtkListStore + A #GtkListStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - column number to modify + column number to modify - new value for the cell + new value for the cell - - A variant of gtk_list_store_set_valist() which + + A variant of gtk_list_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings and in case the number of columns to @@ -92929,45 +66588,33 @@ change is not known until run-time. - A #GtkListStore + A #GtkListStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Swaps @a and @b in @store. Note that this function only works with + Swaps @a and @b in @store. Note that this function only works with unsorted stores. @@ -92975,21 +66622,15 @@ unsorted stores. - A #GtkListStore. + A #GtkListStore. - A #GtkTreeIter. + A #GtkTreeIter. - Another #GtkTreeIter. + Another #GtkTreeIter. @@ -93001,9 +66642,7 @@ unsorted stores. - + @@ -93044,16 +66683,8 @@ unsorted stores. - - GtkLockButton is a widget that can be used in control panels or + + GtkLockButton is a widget that can be used in control panels or preference dialogs to allow users to obtain and revoke authorizations needed to operate the controls. The required authorization is represented by a #GPermission object. Concrete implementations of #GPermission may use @@ -93089,74 +66720,46 @@ with the #GtkLockButton:text-lock, #GtkLockButton:text-unlock, - Creates a new lock button which reflects the @permission. + Creates a new lock button which reflects the @permission. - a new #GtkLockButton + a new #GtkLockButton - - a #GPermission + + a #GPermission - - Obtains the #GPermission object that controls @button. + + Obtains the #GPermission object that controls @button. - the #GPermission of @button + the #GPermission of @button - a #GtkLockButton + a #GtkLockButton - - Sets the #GPermission object that controls @button. + + Sets the #GPermission object that controls @button. - a #GtkLockButton + a #GtkLockButton - - a #GPermission object, or %NULL + + a #GPermission object, or %NULL @@ -93164,34 +66767,19 @@ with the #GtkLockButton:text-lock, #GtkLockButton:text-unlock, - + - + - + - + - + @@ -93201,15 +66789,8 @@ with the #GtkLockButton:text-lock, #GtkLockButton:text-unlock, - - + + @@ -93217,33 +66798,22 @@ with the #GtkLockButton:text-lock, #GtkLockButton:text-unlock, - + - - + + - - + + - + - The parent class. + The parent class. @@ -93311,24 +66881,18 @@ with the #GtkLockButton:text-lock, #GtkLockButton:text-unlock, - + - Like gtk_get_major_version(), but from the headers used at + Like gtk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. - The maximum length of sequences in compose tables. + The maximum length of sequences in compose tables. @@ -93339,310 +66903,239 @@ against at application run time. - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - Like gtk_get_micro_version(), but from the headers used at + + Like gtk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. - Like gtk_get_minor_version(), but from the headers used at + Like gtk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. @@ -93655,70 +67148,50 @@ against at application run time. - + - + - + - + - + - + - - A #GtkMenu is a #GtkMenuShell that implements a drop down menu + + A #GtkMenu is a #GtkMenuShell that implements a drop down menu consisting of a list of #GtkMenuItem objects which can be navigated and activated by the user to perform application functions. @@ -93778,11 +67251,11 @@ my_popup_handler (GtkWidget *widget, GdkEvent *event) |[<!-- language="plain" --> menu -├── arrow.top -├── <child> -┊ -├── <child> -╰── arrow.bottom +├── arrow.top +├── <child> +┊ +├── <child> +╰── arrow.bottom ]| The main CSS node of GtkMenu has name menu, and there are two subnodes @@ -93792,23 +67265,15 @@ with name arrow, for scrolling menu arrows. These subnodes get the - Creates a new #GtkMenu + Creates a new #GtkMenu - a new #GtkMenu + a new #GtkMenu - - Creates a #GtkMenu and populates it with menu items and + + Creates a #GtkMenu and populates it with menu items and submenus according to @model. The created menu items are connected to actions found in the @@ -93820,32 +67285,22 @@ Actions can also be added using gtk_widget_insert_action_group() on the menu's attach widget or on any of its parent widgets. - a new #GtkMenu + a new #GtkMenu - a #GMenuModel + a #GMenuModel - - Returns a list of the menus which are attached to this widget. + + Returns a list of the menus which are attached to this widget. This list is owned by GTK+ and must not be modified. - the list + the list of menus attached to his widget. @@ -93853,17 +67308,13 @@ This list is owned by GTK+ and must not be modified. - a #GtkWidget + a #GtkWidget - Adds a new #GtkMenuItem to a (table) menu. The number of “cells” that + Adds a new #GtkMenuItem to a (table) menu. The number of “cells” that an item will occupy is specified by @left_attach, @right_attach, @top_attach and @bottom_attach. These each represent the leftmost, rightmost, uppermost and lower column and row numbers of the table. @@ -93876,47 +67327,33 @@ Note that this function is not related to gtk_menu_detach(). - a #GtkMenu + a #GtkMenu - a #GtkMenuItem + a #GtkMenuItem - The column number to attach the left side of the item to + The column number to attach the left side of the item to - The column number to attach the right side of the item to + The column number to attach the right side of the item to - The row number to attach the top of the item to + The row number to attach the top of the item to - The row number to attach the bottom of the item to + The row number to attach the bottom of the item to - Attaches the menu to the widget and provides a callback function + Attaches the menu to the widget and provides a callback function that will be invoked when the menu calls gtk_menu_detach() during its destruction. @@ -93930,34 +67367,22 @@ widgets moves between screens. - a #GtkMenu + a #GtkMenu - the #GtkWidget that the menu will be attached to + the #GtkWidget that the menu will be attached to - - the user supplied callback function + + the user supplied callback function that will be called when the menu calls gtk_menu_detach() - Detaches the menu from the widget to which it had been attached. + Detaches the menu from the widget to which it had been attached. This function will call the callback function, @detacher, provided when the gtk_menu_attach_to_widget() function was called. @@ -93966,244 +67391,164 @@ when the gtk_menu_attach_to_widget() function was called. - a #GtkMenu + a #GtkMenu - Gets the #GtkAccelGroup which holds global accelerators for the + Gets the #GtkAccelGroup which holds global accelerators for the menu. See gtk_menu_set_accel_group(). - the #GtkAccelGroup associated with the menu + the #GtkAccelGroup associated with the menu - a #GtkMenu + a #GtkMenu - - Retrieves the accelerator path set on the menu. + + Retrieves the accelerator path set on the menu. - the accelerator path set on the menu. + the accelerator path set on the menu. - a valid #GtkMenu + a valid #GtkMenu - Returns the selected menu item from the menu. This is used by the + Returns the selected menu item from the menu. This is used by the #GtkComboBox. - the #GtkMenuItem that was last selected + the #GtkMenuItem that was last selected in the menu. If a selection has not yet been made, the first menu item is selected. - a #GtkMenu + a #GtkMenu - - Returns the #GtkWidget that the menu is attached to. + + Returns the #GtkWidget that the menu is attached to. - the #GtkWidget that the menu is attached to + the #GtkWidget that the menu is attached to - a #GtkMenu + a #GtkMenu - - Retrieves the number of the monitor on which to show the menu. + + Retrieves the number of the monitor on which to show the menu. - the number of the monitor on which the menu should + the number of the monitor on which the menu should be popped up or -1, if no monitor has been set - a #GtkMenu + a #GtkMenu - - Returns whether the menu reserves space for toggles and + + Returns whether the menu reserves space for toggles and icons, regardless of their actual presence. - Whether the menu reserves toggle space + Whether the menu reserves toggle space - a #GtkMenu + a #GtkMenu - - Returns whether the menu is torn off. + + Returns whether the menu is torn off. See gtk_menu_set_tearoff_state(). - %TRUE if the menu is currently torn off. + %TRUE if the menu is currently torn off. - a #GtkMenu + a #GtkMenu - - Returns the title of the menu. See gtk_menu_set_title(). + + Returns the title of the menu. See gtk_menu_set_title(). - the title of the menu, or %NULL if the menu + the title of the menu, or %NULL if the menu has no title set on it. This string is owned by GTK+ and should not be modified or freed. - a #GtkMenu + a #GtkMenu - - Places @menu on the given monitor. + + Places @menu on the given monitor. - a #GtkMenu + a #GtkMenu - the monitor to place the menu on + the monitor to place the menu on - Removes the menu from the screen. + Removes the menu from the screen. - a #GtkMenu + a #GtkMenu - - Displays a menu and makes it available for selection. + + Displays a menu and makes it available for selection. Applications can use this function to display context-sensitive menus, and will typically supply %NULL for the @parent_menu_shell, @@ -94235,72 +67580,40 @@ have this problem. - a #GtkMenu + a #GtkMenu - - the menu shell containing the + + the menu shell containing the triggering menu item, or %NULL - - the menu item whose activation + + the menu item whose activation triggered the popup, or %NULL - - a user supplied function used to position + + a user supplied function used to position the menu, or %NULL - - user supplied data to be passed to @func. + + user supplied data to be passed to @func. - the mouse button which was pressed to initiate the event. + the mouse button which was pressed to initiate the event. - the time at which the activation event occurred. + the time at which the activation event occurred. - - Displays @menu and makes it available for selection. + + Displays @menu and makes it available for selection. See gtk_menu_popup_at_widget () to pop up a menu at a widget. gtk_menu_popup_at_rect () also allows you to position a menu at an arbitrary @@ -94318,29 +67631,18 @@ out how it was actually positioned. - the #GtkMenu to pop up + the #GtkMenu to pop up - - the #GdkEvent that initiated this request or + + the #GdkEvent that initiated this request or %NULL if it's the current event - - Displays @menu and makes it available for selection. + + Displays @menu and makes it available for selection. See gtk_menu_popup_at_widget () and gtk_menu_popup_at_pointer (), which handle more common cases for popping up menus. @@ -94364,53 +67666,34 @@ Other properties that influence the behaviour of this function are - the #GtkMenu to pop up + the #GtkMenu to pop up - the #GdkWindow @rect is relative to + the #GdkWindow @rect is relative to - the #GdkRectangle to align @menu with + the #GdkRectangle to align @menu with - the point on @rect to align with @menu's anchor point + the point on @rect to align with @menu's anchor point - the point on @menu to align with @rect's anchor point + the point on @menu to align with @rect's anchor point - - the #GdkEvent that initiated this request or + + the #GdkEvent that initiated this request or %NULL if it's the current event - - Displays @menu and makes it available for selection. + + Displays @menu and makes it available for selection. See gtk_menu_popup_at_pointer () to pop up a menu at the master pointer. gtk_menu_popup_at_rect () also allows you to position a menu at an arbitrary @@ -94436,49 +67719,30 @@ Other properties that influence the behaviour of this function are - the #GtkMenu to pop up + the #GtkMenu to pop up - the #GtkWidget to align @menu with + the #GtkWidget to align @menu with - the point on @widget to align with @menu's anchor point + the point on @widget to align with @menu's anchor point - the point on @menu to align with @widget's anchor point + the point on @menu to align with @widget's anchor point - - the #GdkEvent that initiated this request or + + the #GdkEvent that initiated this request or %NULL if it's the current event - - Displays a menu and makes it available for selection. + + Displays a menu and makes it available for selection. Applications can use this function to display context-sensitive menus, and will typically supply %NULL for the @parent_menu_shell, @@ -94510,90 +67774,48 @@ have this problem. - a #GtkMenu + a #GtkMenu - - a #GdkDevice + + a #GdkDevice - - the menu shell containing the triggering + + the menu shell containing the triggering menu item, or %NULL - - the menu item whose activation triggered + + the menu item whose activation triggered the popup, or %NULL - - a user supplied function used to position the menu, + + a user supplied function used to position the menu, or %NULL - - user supplied data to be passed to @func + + user supplied data to be passed to @func - - destroy notify for @data + + destroy notify for @data - the mouse button which was pressed to initiate the event + the mouse button which was pressed to initiate the event - the time at which the activation event occurred + the time at which the activation event occurred - Moves @child to a new @position in the list of @menu + Moves @child to a new @position in the list of @menu children. @@ -94601,47 +67823,35 @@ children. - a #GtkMenu + a #GtkMenu - the #GtkMenuItem to move + the #GtkMenuItem to move - the new position to place @child. + the new position to place @child. Positions are numbered from 0 to n - 1 - Repositions the menu according to its position function. + Repositions the menu according to its position function. - a #GtkMenu + a #GtkMenu - Set the #GtkAccelGroup which holds global accelerators for the + Set the #GtkAccelGroup which holds global accelerators for the menu. This accelerator group needs to also be added to all windows that this menu is being used in with gtk_window_add_accel_group(), in order for those windows to support all the accelerators @@ -94652,27 +67862,18 @@ contained in this group. - a #GtkMenu + a #GtkMenu - - the #GtkAccelGroup to be associated + + the #GtkAccelGroup to be associated with the menu. - Sets an accelerator path for this menu from which accelerator paths + Sets an accelerator path for this menu from which accelerator paths for its immediate children, its menu items, can be constructed. The main purpose of this function is to spare the programmer the inconvenience of having to call gtk_menu_item_set_accel_path() on @@ -94681,7 +67882,7 @@ Instead, by just calling gtk_menu_set_accel_path() on their parent, each menu item of this menu, that contains a label describing its purpose, automatically gets an accel path assigned. -For example, a menu containing menu items “New” and “Exit”, will, after +For example, a menu containing menu items “New” and “Exit”, will, after `gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");` has been called, assign its items the accel paths: `"<Gnumeric-Sheet>/File/New"` and `"<Gnumeric-Sheet>/File/Exit"`. @@ -94699,26 +67900,17 @@ it first with g_intern_static_string(). - a valid #GtkMenu + a valid #GtkMenu - - a valid accelerator path, or %NULL to unset the path + + a valid accelerator path, or %NULL to unset the path - Selects the specified menu item within the menu. This is used by + Selects the specified menu item within the menu. This is used by the #GtkComboBox and should not be used by anyone else. @@ -94726,31 +67918,23 @@ the #GtkComboBox and should not be used by anyone else. - a #GtkMenu + a #GtkMenu - the index of the menu item to select. Index values are + the index of the menu item to select. Index values are from 0 to n-1 - - Informs GTK+ on which monitor a menu should be popped up. + + Informs GTK+ on which monitor a menu should be popped up. See gdk_monitor_get_geometry(). This function should be called from a #GtkMenuPositionFunc if the menu should not appear on the same monitor as the pointer. -This information can’t be reliably inferred from the coordinates +This information can’t be reliably inferred from the coordinates returned by a #GtkMenuPositionFunc, since, for very long menus, these coordinates may extend beyond the monitor boundaries or even the screen boundaries. @@ -94760,26 +67944,18 @@ the screen boundaries. - a #GtkMenu + a #GtkMenu - the number of the monitor on which the menu should + the number of the monitor on which the menu should be popped up - - Sets whether the menu should reserve space for drawing toggles + + Sets whether the menu should reserve space for drawing toggles or icons, regardless of their actual presence. @@ -94787,55 +67963,35 @@ or icons, regardless of their actual presence. - a #GtkMenu + a #GtkMenu - whether to reserve size for toggles + whether to reserve size for toggles - - Sets the #GdkScreen on which the menu will be displayed. + + Sets the #GdkScreen on which the menu will be displayed. - a #GtkMenu + a #GtkMenu - - a #GdkScreen, or %NULL if the screen should be + + a #GdkScreen, or %NULL if the screen should be determined by the widget the menu is attached to - - Changes the tearoff state of the menu. A menu is normally + + Changes the tearoff state of the menu. A menu is normally displayed as drop down menu which persists as long as the menu is active. It can also be displayed as a tearoff menu which persists until it is closed or reattached. @@ -94845,90 +68001,53 @@ until it is closed or reattached. - a #GtkMenu + a #GtkMenu - If %TRUE, menu is displayed as a tearoff menu. + If %TRUE, menu is displayed as a tearoff menu. - - Sets the title string for the menu. + + Sets the title string for the menu. The title is displayed when the menu is shown as a tearoff menu. If @title is %NULL, the menu will see if it is attached to a parent menu item, and if so it will try to use the same -text as that menu item’s label. +text as that menu item’s label. - a #GtkMenu + a #GtkMenu - - a string containing the title for the menu, or %NULL to + + a string containing the title for the menu, or %NULL to inherit the title of the parent menu item, if any - - The accel group holding accelerators for the menu. + + The accel group holding accelerators for the menu. - - An accel path used to conveniently construct accel paths of child items. + + An accel path used to conveniently construct accel paths of child items. - - The index of the currently selected menu item, or -1 if no + + The index of the currently selected menu item, or -1 if no menu item is selected. - - Positioning hints for aligning the menu relative to a rectangle. + + Positioning hints for aligning the menu relative to a rectangle. These hints determine how the menu should be positioned in the case that the menu would fall off-screen if placed in its ideal position. @@ -94944,48 +68063,26 @@ gtk_menu_popup_at_pointer (), #GtkMenu:rect-anchor-dx, #GtkMenu:rect-anchor-dy, #GtkMenu:menu-type-hint, and #GtkMenu::popped-up. - - The widget the menu is attached to. Setting this property attaches + + The widget the menu is attached to. Setting this property attaches the menu without a #GtkMenuDetachFunc. If you need to use a detacher, use gtk_menu_attach_to_widget() directly. - - The #GdkWindowTypeHint to use for the menu's #GdkWindow. + + The #GdkWindowTypeHint to use for the menu's #GdkWindow. See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), gtk_menu_popup_at_pointer (), #GtkMenu:anchor-hints, #GtkMenu:rect-anchor-dx, #GtkMenu:rect-anchor-dy, and #GtkMenu::popped-up. - - The monitor the menu will be popped up on. + + The monitor the menu will be popped up on. - - Horizontal offset to apply to the menu, i.e. the rectangle or widget + + Horizontal offset to apply to the menu, i.e. the rectangle or widget anchor. See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), @@ -94993,27 +68090,16 @@ gtk_menu_popup_at_pointer (), #GtkMenu:anchor-hints, #GtkMenu:rect-anchor-dy, #GtkMenu:menu-type-hint, and #GtkMenu::popped-up. - - Vertical offset to apply to the menu, i.e. the rectangle or widget anchor. + + Vertical offset to apply to the menu, i.e. the rectangle or widget anchor. See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), gtk_menu_popup_at_pointer (), #GtkMenu:anchor-hints, #GtkMenu:rect-anchor-dx, #GtkMenu:menu-type-hint, and #GtkMenu::popped-up. - - A boolean that indicates whether the menu reserves space for + + A boolean that indicates whether the menu reserves space for toggles and icons, regardless of their actual presence. This property should only be changed from its default value @@ -95022,25 +68108,12 @@ are connected to a menu bar or context menus should reserve toggle space for consistency. - - A boolean that indicates whether the menu is torn-off. + + A boolean that indicates whether the menu is torn-off. - - A title that may be displayed by the window manager when this + + A title that may be displayed by the window manager when this menu is torn-off. @@ -95056,17 +68129,13 @@ menu is torn-off. - a #GtkScrollType + a #GtkScrollType - Emitted when the position of @menu is finalized after being popped up + Emitted when the position of @menu is finalized after being popped up using gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), or gtk_menu_popup_at_pointer (). @@ -95092,48 +68161,28 @@ gtk_menu_popup_at_pointer (), #GtkMenu:anchor-hints, - - the position of @menu after any possible + + the position of @menu after any possible flipping or %NULL if the backend can't obtain it - - the final position of @menu or %NULL if the + + the final position of @menu or %NULL if the backend can't obtain it - %TRUE if the anchors were flipped horizontally + %TRUE if the anchors were flipped horizontally - %TRUE if the anchors were flipped vertically + %TRUE if the anchors were flipped vertically - + @@ -95144,30 +68193,17 @@ gtk_menu_popup_at_pointer (), #GtkMenu:anchor-hints, - + - + - + - - The #GtkMenuBar is a subclass of #GtkMenuShell which contains one or + + The #GtkMenuBar is a subclass of #GtkMenuShell which contains one or more #GtkMenuItems. The result is a standard menu bar which can hold many menu items. @@ -95178,23 +68214,15 @@ GtkMenuBar has a single CSS node with name menubar. - Creates a new #GtkMenuBar + Creates a new #GtkMenuBar - the new menu bar, as a #GtkWidget + the new menu bar, as a #GtkWidget - - Creates a new #GtkMenuBar and populates it with menu items + + Creates a new #GtkMenuBar and populates it with menu items and submenus according to @model. The created menu items are connected to actions found in the @@ -95203,133 +68231,87 @@ by means of being contained within the #GtkApplicationWindows widget hierarchy. - a new #GtkMenuBar + a new #GtkMenuBar - a #GMenuModel + a #GMenuModel - - Retrieves the current child pack direction of the menubar. + + Retrieves the current child pack direction of the menubar. See gtk_menu_bar_set_child_pack_direction(). - the child pack direction + the child pack direction - a #GtkMenuBar + a #GtkMenuBar - - Retrieves the current pack direction of the menubar. + + Retrieves the current pack direction of the menubar. See gtk_menu_bar_set_pack_direction(). - the pack direction + the pack direction - a #GtkMenuBar + a #GtkMenuBar - - Sets how widgets should be packed inside the children of a menubar. + + Sets how widgets should be packed inside the children of a menubar. - a #GtkMenuBar + a #GtkMenuBar - a new #GtkPackDirection + a new #GtkPackDirection - - Sets how items should be packed inside a menubar. + + Sets how items should be packed inside a menubar. - a #GtkMenuBar + a #GtkMenuBar - a new #GtkPackDirection + a new #GtkPackDirection - - The child pack direction of the menubar. It determines how + + The child pack direction of the menubar. It determines how the widgets contained in child menuitems are arranged. - - The pack direction of the menubar. It determines how + + The pack direction of the menubar. It determines how menuitems are arranged in the menubar. @@ -95340,9 +68322,7 @@ menuitems are arranged in the menubar. - + @@ -95383,16 +68363,8 @@ menuitems are arranged in the menubar. - - The #GtkMenuButton widget is used to display a popup when clicked on. + + The #GtkMenuButton widget is used to display a popup when clicked on. This popup can be provided either as a #GtkMenu, a #GtkPopover or an abstract #GMenuModel. @@ -95400,7 +68372,7 @@ The #GtkMenuButton widget can hold any valid child widget. That is, it can hold almost any other standard #GtkWidget. The most commonly used child is #GtkImage. If no widget is explicitely added to the #GtkMenuButton, a #GtkImage is automatically created, using an arrow image oriented -according to #GtkMenuButton:direction or the generic “open-menu-symbolic” +according to #GtkMenuButton:direction or the generic “open-menu-symbolic” icon if the direction is not set. The positioning of the popup is determined by the #GtkMenuButton:direction @@ -95413,7 +68385,7 @@ menu will be positioned below the button, with the starting edge (depending on the text direction) of the menu aligned with the starting edge of the button. If there is not enough space below the button, the menu is popped up above the button instead. If the alignment would move -part of the menu offscreen, it is “pushed in”. +part of the menu offscreen, it is “pushed in”. ## Direction = Down @@ -95481,162 +68453,106 @@ it from a plain #GtkButton, it gets the .popup style class. - Creates a new #GtkMenuButton widget with downwards-pointing + Creates a new #GtkMenuButton widget with downwards-pointing arrow as the only child. You can replace the child widget with another #GtkWidget should you wish to. - The newly created #GtkMenuButton widget + The newly created #GtkMenuButton widget - - Returns the parent #GtkWidget to use to line up with menu. + + Returns the parent #GtkWidget to use to line up with menu. - a #GtkWidget value or %NULL + a #GtkWidget value or %NULL - a #GtkMenuButton + a #GtkMenuButton - - Returns the direction the popup will be pointing at when popped up. + + Returns the direction the popup will be pointing at when popped up. - a #GtkArrowType value + a #GtkArrowType value - a #GtkMenuButton + a #GtkMenuButton - - Returns the #GMenuModel used to generate the popup. + + Returns the #GMenuModel used to generate the popup. - a #GMenuModel or %NULL + a #GMenuModel or %NULL - a #GtkMenuButton + a #GtkMenuButton - - Returns the #GtkPopover that pops out of the button. + + Returns the #GtkPopover that pops out of the button. If the button is not using a #GtkPopover, this function returns %NULL. - a #GtkPopover or %NULL + a #GtkPopover or %NULL - a #GtkMenuButton + a #GtkMenuButton - - Returns the #GtkMenu that pops out of the button. + + Returns the #GtkMenu that pops out of the button. If the button does not use a #GtkMenu, this function returns %NULL. - a #GtkMenu or %NULL + a #GtkMenu or %NULL - a #GtkMenuButton + a #GtkMenuButton - - Returns whether a #GtkPopover or a #GtkMenu will be constructed + + Returns whether a #GtkPopover or a #GtkMenu will be constructed from the menu model. - %TRUE if using a #GtkPopover + %TRUE if using a #GtkPopover - a #GtkMenuButton + a #GtkMenuButton - - Sets the #GtkWidget to use to line the menu with when popped up. + + Sets the #GtkWidget to use to line the menu with when popped up. Note that the @align_widget must contain the #GtkMenuButton itself. Setting it to %NULL means that the menu will be aligned with the @@ -95650,61 +68566,42 @@ and not for popovers. - a #GtkMenuButton + a #GtkMenuButton - - a #GtkWidget + + a #GtkWidget - - Sets the direction in which the popup will be popped up, as -well as changing the arrow’s direction. The child will not + + Sets the direction in which the popup will be popped up, as +well as changing the arrow’s direction. The child will not be changed to an arrow if it was customized. If the does not fit in the available space in the given direction, GTK+ will its best to keep it inside the screen and fully visible. If you pass %GTK_ARROW_NONE for a @direction, the popup will behave -as if you passed %GTK_ARROW_DOWN (although you won’t see any arrows). +as if you passed %GTK_ARROW_DOWN (although you won’t see any arrows). - a #GtkMenuButton + a #GtkMenuButton - a #GtkArrowType + a #GtkArrowType - - Sets the #GMenuModel from which the popup will be constructed, + + Sets the #GMenuModel from which the popup will be constructed, or %NULL to dissociate any existing menu model and disable the button. Depending on the value of #GtkMenuButton:use-popover, either a @@ -95721,29 +68618,18 @@ to %NULL. - a #GtkMenuButton + a #GtkMenuButton - - a #GMenuModel, or %NULL to unset and disable the + + a #GMenuModel, or %NULL to unset and disable the button - - Sets the #GtkPopover that will be popped up when the @menu_button is clicked, + + Sets the #GtkPopover that will be popped up when the @menu_button is clicked, or %NULL to dissociate any existing popover and disable the button. If #GtkMenuButton:menu-model or #GtkMenuButton:popup are set, those objects @@ -95754,28 +68640,17 @@ are dissociated from the @menu_button, and those properties are set to %NULL. - a #GtkMenuButton + a #GtkMenuButton - - a #GtkPopover, or %NULL to unset and disable the button + + a #GtkPopover, or %NULL to unset and disable the button - - Sets the #GtkMenu that will be popped up when the @menu_button is clicked, or + + Sets the #GtkMenu that will be popped up when the @menu_button is clicked, or %NULL to dissociate any existing menu and disable the button. If #GtkMenuButton:menu-model or #GtkMenuButton:popover are set, those objects @@ -95786,28 +68661,17 @@ are dissociated from the @menu_button, and those properties are set to %NULL. - a #GtkMenuButton + a #GtkMenuButton - - a #GtkMenu, or %NULL to unset and disable the button + + a #GtkMenu, or %NULL to unset and disable the button - - Sets whether to construct a #GtkPopover instead of #GtkMenu + + Sets whether to construct a #GtkPopover instead of #GtkMenu when gtk_menu_button_set_menu_model() is called. Note that this property is only consulted when a new menu model is set. @@ -95816,45 +68680,26 @@ this property is only consulted when a new menu model is set. - a #GtkMenuButton + a #GtkMenuButton - %TRUE to construct a popover from the menu model + %TRUE to construct a popover from the menu model - - The #GtkWidget to use to align the menu with. + + The #GtkWidget to use to align the menu with. - - The #GtkArrowType representing the direction in which the + + The #GtkArrowType representing the direction in which the menu or popover will be popped out. - - The #GMenuModel from which the popup will be created. + + The #GMenuModel from which the popup will be created. Depending on the #GtkMenuButton:use-popover property, that may be a menu or a popover. @@ -95862,31 +68707,16 @@ See gtk_menu_button_set_menu_model() for the interaction with the #GtkMenuButton:popup property. - - The #GtkPopover that will be popped up when the button is clicked. + + The #GtkPopover that will be popped up when the button is clicked. - - The #GtkMenu that will be popped up when the button is clicked. + + The #GtkMenu that will be popped up when the button is clicked. - - Whether to construct a #GtkPopover from the menu model, + + Whether to construct a #GtkPopover from the menu model, or a #GtkMenu. @@ -95897,46 +68727,28 @@ or a #GtkMenu. - - + + - + - + - - + + - + - - + + - + @@ -95974,14 +68786,10 @@ or a #GtkMenu. - + - + @@ -96020,9 +68828,7 @@ or a #GtkMenu. - A user function supplied when calling gtk_menu_attach_to_widget() which + A user function supplied when calling gtk_menu_attach_to_widget() which will be called when the menu is later detached from the widget. @@ -96030,69 +68836,32 @@ will be called when the menu is later detached from the widget. - the #GtkWidget that the menu is being detached from. + the #GtkWidget that the menu is being detached from. - the #GtkMenu being detached. + the #GtkMenu being detached. - - An enumeration representing directional movements within a menu. - - To the parent menu shell + + An enumeration representing directional movements within a menu. + + To the parent menu shell - - To the submenu, if any, associated with the item + + To the submenu, if any, associated with the item - - To the next menu item + + To the next menu item - - To the previous menu item + + To the previous menu item - - The #GtkMenuItem widget and the derived widgets are the only valid + + The #GtkMenuItem widget and the derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus. @@ -96115,7 +68884,7 @@ gtk_accel_label_set_accel (GTK_ACCEL_LABEL (child), GDK_KEY_1, 0); # GtkMenuItem as GtkBuildable The GtkMenuItem implementation of the #GtkBuildable interface supports -adding a submenu by specifying “submenu” as the “type” attribute of +adding a submenu by specifying “submenu” as the “type” attribute of a <child> element. An example of UI definition fragment with submenus: @@ -96131,8 +68900,8 @@ An example of UI definition fragment with submenus: |[<!-- language="plain" --> menuitem -├── <child> -╰── [arrow.right] +├── <child> +╰── [arrow.right] ]| GtkMenuItem has a single CSS node with name menuitem. If the menuitem @@ -96144,76 +68913,54 @@ the .left or .right style class. - Creates a new #GtkMenuItem. + Creates a new #GtkMenuItem. - the newly created #GtkMenuItem + the newly created #GtkMenuItem - - Creates a new #GtkMenuItem whose child is a #GtkLabel. + + Creates a new #GtkMenuItem whose child is a #GtkLabel. - the newly created #GtkMenuItem + the newly created #GtkMenuItem - the text for the label + the text for the label - - Creates a new #GtkMenuItem containing a label. + + Creates a new #GtkMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the menu item. - a new #GtkMenuItem + a new #GtkMenuItem - The text of the button, with an underscore in front of the + The text of the button, with an underscore in front of the mnemonic character - Emits the #GtkMenuItem::activate signal on the given item + Emits the #GtkMenuItem::activate signal on the given item - the menu item + the menu item @@ -96230,334 +68977,236 @@ so underscores in @label indicate the mnemonic for the menu item. - Emits the #GtkMenuItem::deselect signal on the given item. + Emits the #GtkMenuItem::deselect signal on the given item. - the menu item + the menu item - Sets @text on the @menu_item label + Sets @text on the @menu_item label - The text in the @menu_item label. This is the internal + The text in the @menu_item label. This is the internal string used by the label, and must not be modified. - a #GtkMenuItem + a #GtkMenuItem - Emits the #GtkMenuItem::select signal on the given item. + Emits the #GtkMenuItem::select signal on the given item. - the menu item + the menu item - Sets @text on the @menu_item label + Sets @text on the @menu_item label - a #GtkMenuItem + a #GtkMenuItem - the text you want to set + the text you want to set - - Emits the #GtkMenuItem::toggle-size-allocate signal on the given item. + + Emits the #GtkMenuItem::toggle-size-allocate signal on the given item. - the menu item. + the menu item. - the allocation to use as signal data. + the allocation to use as signal data. - Emits the #GtkMenuItem::toggle-size-request signal on the given item. + Emits the #GtkMenuItem::toggle-size-request signal on the given item. - the menu item + the menu item - - the requisition to use as signal data. + + the requisition to use as signal data. - Emits the #GtkMenuItem::activate signal on the given item + Emits the #GtkMenuItem::activate signal on the given item - the menu item + the menu item - Emits the #GtkMenuItem::deselect signal on the given item. + Emits the #GtkMenuItem::deselect signal on the given item. - the menu item + the menu item - - Retrieve the accelerator path that was previously set on @menu_item. + + Retrieve the accelerator path that was previously set on @menu_item. See gtk_menu_item_set_accel_path() for details. - the accelerator path corresponding to - this menu item’s functionality, or %NULL if not set + the accelerator path corresponding to + this menu item’s functionality, or %NULL if not set - a valid #GtkMenuItem + a valid #GtkMenuItem - - Sets @text on the @menu_item label + + Sets @text on the @menu_item label - The text in the @menu_item label. This is the internal + The text in the @menu_item label. This is the internal string used by the label, and must not be modified. - a #GtkMenuItem + a #GtkMenuItem - - Returns whether the @menu_item reserves space for + + Returns whether the @menu_item reserves space for the submenu indicator, regardless if it has a submenu or not. - %TRUE if @menu_item always reserves space for the + %TRUE if @menu_item always reserves space for the submenu indicator - a #GtkMenuItem + a #GtkMenuItem - - Gets whether the menu item appears justified at the right + + Gets whether the menu item appears justified at the right side of the menu bar. See gtk_menu_item_set_right_justified() - %TRUE if the menu item will appear at the + %TRUE if the menu item will appear at the far right if added to a menu bar. - a #GtkMenuItem + a #GtkMenuItem - Gets the submenu underneath this menu item, if any. + Gets the submenu underneath this menu item, if any. See gtk_menu_item_set_submenu(). - submenu for this menu item, or %NULL if none + submenu for this menu item, or %NULL if none - a #GtkMenuItem + a #GtkMenuItem - - Checks if an underline in the text indicates the next character + + Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key. - %TRUE if an embedded underline in the label + %TRUE if an embedded underline in the label indicates the mnemonic accelerator key. - a #GtkMenuItem + a #GtkMenuItem - Emits the #GtkMenuItem::select signal on the given item. + Emits the #GtkMenuItem::select signal on the given item. - the menu item + the menu item - - Set the accelerator path on @menu_item, through which runtime -changes of the menu item’s accelerator caused by the user can be + + Set the accelerator path on @menu_item, through which runtime +changes of the menu item’s accelerator caused by the user can be identified and saved to persistent storage (see gtk_accel_map_save() on this). To set up a default accelerator for this menu item, call gtk_accel_map_add_entry() with the same @accel_path. See also @@ -96581,54 +69230,35 @@ by interning it first with g_intern_static_string(). - a valid #GtkMenuItem + a valid #GtkMenuItem - - accelerator path, corresponding to this menu - item’s functionality, or %NULL to unset the current path. + + accelerator path, corresponding to this menu + item’s functionality, or %NULL to unset the current path. - - Sets @text on the @menu_item label + + Sets @text on the @menu_item label - a #GtkMenuItem + a #GtkMenuItem - the text you want to set + the text you want to set - - Sets whether the @menu_item should reserve space for + + Sets whether the @menu_item should reserve space for the submenu indicator, regardless if it actually has a submenu or not. @@ -96640,27 +69270,18 @@ this functions. - a #GtkMenuItem + a #GtkMenuItem - the new value + the new value - - Sets whether the menu item appears justified at the right -side of a menu bar. This was traditionally done for “Help” + + Sets whether the menu item appears justified at the right +side of a menu bar. This was traditionally done for “Help” menu items, but is now considered a bad idea. (If the widget layout is reversed for a right-to-left language like Hebrew or Arabic, right-justified-menu-items appear at the left.) @@ -96672,24 +69293,18 @@ or Arabic, right-justified-menu-items appear at the left.) - a #GtkMenuItem. + a #GtkMenuItem. - if %TRUE the menu item will appear at the + if %TRUE the menu item will appear at the far right if added to a menu bar - Sets or replaces the menu item’s submenu, or removes it when a %NULL + Sets or replaces the menu item’s submenu, or removes it when a %NULL submenu is passed. @@ -96697,28 +69312,17 @@ submenu is passed. - a #GtkMenuItem + a #GtkMenuItem - - the submenu, or %NULL + + the submenu, or %NULL - - If true, an underline in the text indicates the next character + + If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. @@ -96726,116 +69330,70 @@ should be used for the mnemonic accelerator key. - a #GtkMenuItem + a #GtkMenuItem - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics - - Emits the #GtkMenuItem::toggle-size-allocate signal on the given item. + + Emits the #GtkMenuItem::toggle-size-allocate signal on the given item. - the menu item. + the menu item. - the allocation to use as signal data. + the allocation to use as signal data. - - Emits the #GtkMenuItem::toggle-size-request signal on the given item. + + Emits the #GtkMenuItem::toggle-size-request signal on the given item. - the menu item + the menu item - - the requisition to use as signal data. + + the requisition to use as signal data. - - Sets the accelerator path of the menu item, through which runtime + + Sets the accelerator path of the menu item, through which runtime changes of the menu item's accelerator caused by the user can be identified and saved to persistant storage. - - The text for the child label. + + The text for the child label. - - Sets whether the menu item appears justified + + Sets whether the menu item appears justified at the right side of a menu bar. - - The submenu attached to the menu item, or %NULL if it has none. + + The submenu attached to the menu item, or %NULL if it has none. - - %TRUE if underlines in the text indicate mnemonics. + + %TRUE if underlines in the text indicate mnemonics. @@ -96845,17 +69403,13 @@ at the right side of a menu bar. - Emitted when the item is activated. + Emitted when the item is activated. - Emitted when the item is activated, but also if the menu item has a + Emitted when the item is activated, but also if the menu item has a submenu. For normal applications, the relevant signal is #GtkMenuItem::activate. @@ -96887,22 +69441,13 @@ submenu. For normal applications, the relevant signal is - + - + @@ -96911,38 +69456,26 @@ submenu. For normal applications, the relevant signal is - + - + - + - + - + - The parent class. + The parent class. - If %TRUE, then we should always + If %TRUE, then we should always hide the menu when the %GtkMenuItem is activated. Otherwise, it is up to the caller. @@ -96955,9 +69488,7 @@ submenu. For normal applications, the relevant signal is - the menu item + the menu item @@ -96984,18 +69515,11 @@ submenu. For normal applications, the relevant signal is - the menu item + the menu item - - the requisition to use as signal data. + + the requisition to use as signal data. @@ -97009,15 +69533,11 @@ submenu. For normal applications, the relevant signal is - the menu item. + the menu item. - the allocation to use as signal data. + the allocation to use as signal data. @@ -97031,15 +69551,11 @@ submenu. For normal applications, the relevant signal is - a #GtkMenuItem + a #GtkMenuItem - the text you want to set + the text you want to set @@ -97049,17 +69565,13 @@ submenu. For normal applications, the relevant signal is - The text in the @menu_item label. This is the internal + The text in the @menu_item label. This is the internal string used by the label, and must not be modified. - a #GtkMenuItem + a #GtkMenuItem @@ -97073,9 +69585,7 @@ submenu. For normal applications, the relevant signal is - the menu item + the menu item @@ -97089,9 +69599,7 @@ submenu. For normal applications, the relevant signal is - the menu item + the menu item @@ -97134,9 +69642,7 @@ submenu. For normal applications, the relevant signal is - A user function supplied when calling gtk_menu_popup() which + A user function supplied when calling gtk_menu_popup() which controls the positioning of the menu when it is displayed. The function sets the @x and @y parameters to the coordinates where the menu is to be drawn. To make the menu appear on a different @@ -97148,58 +69654,35 @@ called. - a #GtkMenu. + a #GtkMenu. - - address of the #gint representing the horizontal + + address of the #gint representing the horizontal position where the menu shall be drawn. - - address of the #gint representing the vertical position + + address of the #gint representing the vertical position where the menu shall be drawn. This is an output parameter. - - This parameter controls how menus placed outside + + This parameter controls how menus placed outside the monitor are handled. If this is set to %TRUE and part of the menu is outside the monitor then GTK+ pushes the window into the visible area, effectively modifying the popup position. Note that moving and possibly resizing the menu around will alter the scroll position to keep the menu items - “in place”, i.e. at the same monitor position they would have + “in place”, i.e. at the same monitor position they would have been without resizing. In practice, this behavior is only useful for combobox popups or option menus and cannot be used to simply confine a menu to monitor boundaries. In that case, changing the scroll offset is not desirable. - - the data supplied by the user in the gtk_menu_popup() + + the data supplied by the user in the gtk_menu_popup() @data parameter. @@ -97208,17 +69691,8 @@ called. - - A #GtkMenuShell is the abstract base class used to derive the + + A #GtkMenuShell is the abstract base class used to derive the #GtkMenu and #GtkMenuBar subclasses. A #GtkMenuShell is a container of #GtkMenuItem objects arranged @@ -97228,11 +69702,11 @@ submenu associated with it, allowing for nested hierarchical menus. # Terminology -A menu item can be “selected”, this means that it is displayed +A menu item can be “selected”, this means that it is displayed in the prelight state, and if it has a submenu, that submenu will be popped up. -A menu is “active” when it is visible onscreen and the user +A menu is “active” when it is visible onscreen and the user is selecting from it. A menubar is not active until the user clicks on one of its menuitems. When a menu is active, passing the mouse over a submenu will pop it up. @@ -97263,26 +69737,20 @@ grab and receive all key presses. - Cancels the selection within the menu shell. + Cancels the selection within the menu shell. - a #GtkMenuShell + a #GtkMenuShell - Deactivates the menu shell. + Deactivates the menu shell. Typically this results in the menu shell being erased from the screen. @@ -97292,9 +69760,7 @@ from the screen. - a #GtkMenuShell + a #GtkMenuShell @@ -97311,9 +69777,7 @@ from the screen. - Adds a new #GtkMenuItem to the menu shell’s item list + Adds a new #GtkMenuItem to the menu shell’s item list at the position indicated by @position. @@ -97321,21 +69785,15 @@ at the position indicated by @position. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to add + The #GtkMenuItem to add - The position in the item list where @child + The position in the item list where @child is added. Positions are numbered from 0 to n-1 @@ -97370,24 +69828,18 @@ at the position indicated by @position. - Selects the menu item from the menu shell. + Selects the menu item from the menu shell. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to select + The #GtkMenuItem to select @@ -97404,39 +69856,29 @@ at the position indicated by @position. - Activates the menu item within the menu shell. + Activates the menu item within the menu shell. - a #GtkMenuShell + a #GtkMenuShell - the #GtkMenuItem to activate + the #GtkMenuItem to activate - if %TRUE, force the deactivation of the + if %TRUE, force the deactivation of the menu shell after the menu item is activated - Adds a new #GtkMenuItem to the end of the menu shell's + Adds a new #GtkMenuItem to the end of the menu shell's item list. @@ -97444,25 +69886,17 @@ item list. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to add + The #GtkMenuItem to add - - Establishes a binding between a #GtkMenuShell and a #GMenuModel. + + Establishes a binding between a #GtkMenuShell and a #GMenuModel. The contents of @shell are removed and then refilled with menu items according to @model. When @model changes, @shell is updated. @@ -97473,22 +69907,22 @@ all children are removed. @with_separators determines if toplevel items (eg: sections) have separators inserted between them. This is typically desired for -menus but doesn’t make sense for menubars. +menus but doesn’t make sense for menubars. If @action_namespace is non-%NULL then the effect is as if all actions mentioned in the @model have their names prefixed with the -namespace, plus a dot. For example, if the action “quit” is -mentioned and @action_namespace is “app” then the effective action -name is “app.quit”. +namespace, plus a dot. For example, if the action “quit” is +mentioned and @action_namespace is “app” then the effective action +name is “app.quit”. This function uses #GtkActionable to define the action name and target values on the created menu items. If you want to use an -action group other than “app” and “win”, or if you want to use a +action group other than “app” and “win”, or if you want to use a #GtkMenuShell outside of a #GtkApplicationWindow, then you will need to attach your own action group to the widget hierarchy using gtk_widget_insert_action_group(). As an example, if you created a -group with a “quit” action and inserted it with the name “mygroup” -then you would use the action name “mygroup.quit” in your +group with a “quit” action and inserted it with the name “mygroup” +then you would use the action name “mygroup.quit” in your #GMenuModel. For most cases you are probably better off using @@ -97501,60 +69935,40 @@ gtk_application_set_menubar(). - a #GtkMenuShell + a #GtkMenuShell - - the #GMenuModel to bind to or %NULL to remove + + the #GMenuModel to bind to or %NULL to remove binding - - the namespace for actions in @model + + the namespace for actions in @model - %TRUE if toplevel items in @shell should have + %TRUE if toplevel items in @shell should have separators between them - Cancels the selection within the menu shell. + Cancels the selection within the menu shell. - a #GtkMenuShell + a #GtkMenuShell - Deactivates the menu shell. + Deactivates the menu shell. Typically this results in the menu shell being erased from the screen. @@ -97564,17 +69978,13 @@ from the screen. - a #GtkMenuShell + a #GtkMenuShell - Deselects the currently selected item from the menu shell, + Deselects the currently selected item from the menu shell, if any. @@ -97582,86 +69992,58 @@ if any. - a #GtkMenuShell + a #GtkMenuShell - - Gets the parent menu shell. + + Gets the parent menu shell. The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar from which it was opened up. - the parent #GtkMenuShell + the parent #GtkMenuShell - a #GtkMenuShell + a #GtkMenuShell - - Gets the currently selected item. + + Gets the currently selected item. - the currently selected item + the currently selected item - a #GtkMenuShell + a #GtkMenuShell - - Returns %TRUE if the menu shell will take the keyboard focus on popup. + + Returns %TRUE if the menu shell will take the keyboard focus on popup. - %TRUE if the menu shell will take the keyboard focus on popup. + %TRUE if the menu shell will take the keyboard focus on popup. - a #GtkMenuShell + a #GtkMenuShell - Adds a new #GtkMenuItem to the menu shell’s item list + Adds a new #GtkMenuItem to the menu shell’s item list at the position indicated by @position. @@ -97669,30 +70051,22 @@ at the position indicated by @position. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to add + The #GtkMenuItem to add - The position in the item list where @child + The position in the item list where @child is added. Positions are numbered from 0 to n-1 - Adds a new #GtkMenuItem to the beginning of the menu shell's + Adds a new #GtkMenuItem to the beginning of the menu shell's item list. @@ -97700,26 +70074,18 @@ item list. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to add + The #GtkMenuItem to add - - Select the first visible or selectable child of the menu shell; -don’t select tearoff items unless the only item is a tearoff + + Select the first visible or selectable child of the menu shell; +don’t select tearoff items unless the only item is a tearoff item. @@ -97727,17 +70093,13 @@ item. - a #GtkMenuShell + a #GtkMenuShell - if %TRUE, search for the first selectable + if %TRUE, search for the first selectable menu item, otherwise select nothing if - the first item isn’t sensitive. This + the first item isn’t sensitive. This should be %FALSE if the menu is being popped up initially. @@ -97745,34 +70107,24 @@ item. - Selects the menu item from the menu shell. + Selects the menu item from the menu shell. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to select + The #GtkMenuItem to select - - If @take_focus is %TRUE (the default) the menu shell will take + + If @take_focus is %TRUE (the default) the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus. @@ -97782,7 +70134,7 @@ focus. The @take_focus state of a menu or menu bar is automatically propagated to submenus whenever a submenu is popped up, so you -don’t have to worry about recursively setting it for your entire +don’t have to worry about recursively setting it for your entire menu hierarchy. Only when programmatically picking a submenu and popping it up manually, the @take_focus property of the submenu needs to be set explicitly. @@ -97790,7 +70142,7 @@ needs to be set explicitly. Note that setting it to %FALSE has side-effects: If the focus is in some other app, it keeps the focus and keynav in -the menu doesn’t work. Consequently, keynav on the menu will only +the menu doesn’t work. Consequently, keynav on the menu will only work if the focus is on some toplevel owned by the onscreen keyboard. To avoid confusing the user, menus with @take_focus set to %FALSE @@ -97804,27 +70156,18 @@ See also gdk_keyboard_grab() - a #GtkMenuShell + a #GtkMenuShell - %TRUE if the menu shell should take the keyboard + %TRUE if the menu shell should take the keyboard focus on popup - - A boolean that determines whether the menu and its submenus grab the + + A boolean that determines whether the menu and its submenus grab the keyboard focus. See gtk_menu_shell_set_take_focus() and gtk_menu_shell_get_take_focus(). @@ -97836,60 +70179,46 @@ gtk_menu_shell_get_take_focus(). - An action signal that activates the current menu item within + An action signal that activates the current menu item within the menu shell. - if %TRUE, hide the menu after activating the menu item + if %TRUE, hide the menu after activating the menu item - An action signal which cancels the selection within the menu shell. + An action signal which cancels the selection within the menu shell. Causes the #GtkMenuShell::selection-done signal to be emitted. - A keybinding signal which moves the focus in the + A keybinding signal which moves the focus in the given @direction. - the direction to cycle in + the direction to cycle in - This signal is emitted when a menu shell is deactivated. + This signal is emitted when a menu shell is deactivated. - The ::insert signal is emitted when a new #GtkMenuItem is added to + The ::insert signal is emitted when a new #GtkMenuItem is added to a #GtkMenuShell. A separate signal is used instead of GtkContainer::add because of the need for an additional position parameter. @@ -97900,73 +70229,51 @@ The inverse of this signal is the GtkContainer::removed signal. - the #GtkMenuItem that is being inserted + the #GtkMenuItem that is being inserted - the position at which the insert occurs + the position at which the insert occurs - An keybinding signal which moves the current menu item + An keybinding signal which moves the current menu item in the direction specified by @direction. - the direction to move + the direction to move - The ::move-selected signal is emitted to move the selection to + The ::move-selected signal is emitted to move the selection to another item. - %TRUE to stop the signal emission, %FALSE to continue + %TRUE to stop the signal emission, %FALSE to continue - +1 to move to the next item, -1 to move to the previous + +1 to move to the next item, -1 to move to the previous - This signal is emitted when a selection has been + This signal is emitted when a selection has been completed within a menu shell. - + @@ -97974,27 +70281,19 @@ completed within a menu shell. - + - + - + - + - + @@ -98010,9 +70309,7 @@ completed within a menu shell. - a #GtkMenuShell + a #GtkMenuShell @@ -98071,9 +70368,7 @@ completed within a menu shell. - a #GtkMenuShell + a #GtkMenuShell @@ -98087,15 +70382,11 @@ completed within a menu shell. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to select + The #GtkMenuItem to select @@ -98109,21 +70400,15 @@ completed within a menu shell. - a #GtkMenuShell + a #GtkMenuShell - The #GtkMenuItem to add + The #GtkMenuItem to add - The position in the item list where @child + The position in the item list where @child is added. Positions are numbered from 0 to n-1 @@ -98195,16 +70480,8 @@ completed within a menu shell. - - A #GtkMenuToolButton is a #GtkToolItem that contains a button and + + A #GtkMenuToolButton is a #GtkToolItem that contains a button and a small additional button with an arrow. When clicked, the arrow button pops up a dropdown menu. @@ -98214,7 +70491,7 @@ Use gtk_menu_tool_button_new() to create a new # GtkMenuToolButton as GtkBuildable The GtkMenuToolButton implementation of the GtkBuildable interface -supports adding a menu by specifying “menu” as the “type” attribute +supports adding a menu by specifying “menu” as the “type” attribute of a <child> element. An example for a UI definition fragment with menus: @@ -98230,64 +70507,38 @@ An example for a UI definition fragment with menus: - - Creates a new #GtkMenuToolButton using @icon_widget as icon and + + Creates a new #GtkMenuToolButton using @icon_widget as icon and @label as label. - the new #GtkMenuToolButton + the new #GtkMenuToolButton - - a widget that will be used as icon widget, or %NULL + + a widget that will be used as icon widget, or %NULL - - a string that will be used as label, or %NULL + + a string that will be used as label, or %NULL - - Creates a new #GtkMenuToolButton. + + Creates a new #GtkMenuToolButton. The new #GtkMenuToolButton will contain an icon and label from the stock item indicated by @stock_id. Use gtk_menu_tool_button_new() instead. - the new #GtkMenuToolButton + the new #GtkMenuToolButton - the name of a stock item + the name of a stock item @@ -98303,35 +70554,23 @@ the stock item indicated by @stock_id. - - Gets the #GtkMenu associated with #GtkMenuToolButton. + + Gets the #GtkMenu associated with #GtkMenuToolButton. - the #GtkMenu associated + the #GtkMenu associated with #GtkMenuToolButton - a #GtkMenuToolButton + a #GtkMenuToolButton - - Sets the tooltip markup text to be used as tooltip for the arrow button + + Sets the tooltip markup text to be used as tooltip for the arrow button which pops up the menu. See gtk_tool_item_set_tooltip_text() for setting a tooltip on the whole #GtkMenuToolButton. @@ -98340,25 +70579,17 @@ a tooltip on the whole #GtkMenuToolButton. - a #GtkMenuToolButton + a #GtkMenuToolButton - markup text to be used as tooltip text for button’s arrow button + markup text to be used as tooltip text for button’s arrow button - - Sets the tooltip text to be used as tooltip for the arrow button which + + Sets the tooltip text to be used as tooltip for the arrow button which pops up the menu. See gtk_tool_item_set_tooltip_text() for setting a tooltip on the whole #GtkMenuToolButton. @@ -98367,25 +70598,17 @@ on the whole #GtkMenuToolButton. - a #GtkMenuToolButton + a #GtkMenuToolButton - text to be used as tooltip text for button’s arrow button + text to be used as tooltip text for button’s arrow button - - Sets the #GtkMenu that is popped up when the user clicks on the arrow. + + Sets the #GtkMenu that is popped up when the user clicks on the arrow. If @menu is NULL, the arrow button becomes insensitive. @@ -98393,15 +70616,11 @@ If @menu is NULL, the arrow button becomes insensitive. - a #GtkMenuToolButton + a #GtkMenuToolButton - the #GtkMenu associated with #GtkMenuToolButton + the #GtkMenu associated with #GtkMenuToolButton @@ -98416,9 +70635,7 @@ If @menu is NULL, the arrow button becomes insensitive. - The ::show-menu signal is emitted before the menu is shown. + The ::show-menu signal is emitted before the menu is shown. It can be used to populate the menu on demand, using gtk_menu_tool_button_set_menu(). @@ -98431,14 +70648,10 @@ since the arrow is made insensitive if the menu is not set. - + - The parent class. + The parent class. @@ -98487,21 +70700,11 @@ since the arrow is made insensitive if the menu is not set. - + - - #GtkMessageDialog presents a dialog with some message text. It’s simply a + + #GtkMessageDialog presents a dialog with some message text. It’s simply a convenience widget; you could construct the equivalent of #GtkMessageDialog from #GtkDialog without too much effort, but #GtkMessageDialog saves typing. @@ -98521,7 +70724,7 @@ An example for using a modal dialog: flags, GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, - "Error reading “%s”: %s", + "Error reading “%s”: %s", filename, g_strerror (errno)); gtk_dialog_run (GTK_DIALOG (dialog)); @@ -98537,7 +70740,7 @@ An example for a non-modal dialog: flags, GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, - "Error reading “%s”: %s", + "Error reading “%s”: %s", filename, g_strerror (errno)); @@ -98552,80 +70755,51 @@ An example for a non-modal dialog: # GtkMessageDialog as GtkBuildable The GtkMessageDialog implementation of the GtkBuildable interface exposes -the message area as an internal child with the name “message_area”. +the message area as an internal child with the name “message_area”. - - Creates a new message dialog, which is a simple dialog with some text -the user may want to see. When the user clicks a button a “response” + + Creates a new message dialog, which is a simple dialog with some text +the user may want to see. When the user clicks a button a “response” signal is emitted with response IDs from #GtkResponseType. See #GtkDialog for more details. - a new #GtkMessageDialog + a new #GtkMessageDialog - - transient parent, or %NULL for none + + transient parent, or %NULL for none - flags + flags - type of message + type of message - set of buttons to use + set of buttons to use - - printf()-style format string, or %NULL + + printf()-style format string, or %NULL - arguments for @message_format + arguments for @message_format - - Creates a new message dialog, which is a simple dialog with some text that + + Creates a new message dialog, which is a simple dialog with some text that is marked up with the [Pango text markup language][PangoMarkupFormat]. -When the user clicks a button a “response” signal is emitted with +When the user clicks a button a “response” signal is emitted with response IDs from #GtkResponseType. See #GtkDialog for more details. Special XML characters in the printf() arguments passed to this @@ -98634,8 +70808,8 @@ function will automatically be escaped as necessary. Usually this is what you want, but if you have an existing Pango markup string that you want to use literally as the label, then you need to use gtk_message_dialog_set_markup() -instead, since you can’t pass the markup string either -as the format (it might contain “%” characters) or as a string +instead, since you can’t pass the markup string either +as the format (it might contain “%” characters) or as a string argument. |[<!-- language="C" --> GtkWidget *dialog; @@ -98650,63 +70824,38 @@ argument. ]| - a new #GtkMessageDialog + a new #GtkMessageDialog - - transient parent, or %NULL for none + + transient parent, or %NULL for none - flags + flags - type of message + type of message - set of buttons to use + set of buttons to use - - printf()-style format string, or %NULL + + printf()-style format string, or %NULL - arguments for @message_format + arguments for @message_format - - Sets the secondary text of the message dialog to be @message_format (with + + Sets the secondary text of the message dialog to be @message_format (with printf()-style), which is marked up with the [Pango text markup language][PangoMarkupFormat]. @@ -98729,33 +70878,22 @@ g_free (msg); - a #GtkMessageDialog + a #GtkMessageDialog - printf()-style markup string (see + printf()-style markup string (see [Pango markup format][PangoMarkupFormat]), or %NULL - arguments for @message_format + arguments for @message_format - - Sets the secondary text of the message dialog to be @message_format + + Sets the secondary text of the message dialog to be @message_format (with printf()-style). @@ -98763,88 +70901,55 @@ g_free (msg); - a #GtkMessageDialog + a #GtkMessageDialog - - printf()-style format string, or %NULL + + printf()-style format string, or %NULL - arguments for @message_format + arguments for @message_format - - Gets the dialog’s image. + + Gets the dialog’s image. Use #GtkDialog for dialogs with images - the dialog’s image + the dialog’s image - a #GtkMessageDialog + a #GtkMessageDialog - - Returns the message area of the dialog. This is the box where the -dialog’s primary and secondary labels are packed. You can add your + + Returns the message area of the dialog. This is the box where the +dialog’s primary and secondary labels are packed. You can add your own extra content to that box and it will appear below those labels. See gtk_dialog_get_content_area() for the corresponding function in the parent #GtkDialog. - A #GtkBox corresponding to the - “message area” in the @message_dialog. + A #GtkBox corresponding to the + “message area” in the @message_dialog. - a #GtkMessageDialog + a #GtkMessageDialog - - Sets the dialog’s image to @image. + + Sets the dialog’s image to @image. Use #GtkDialog to create dialogs with images @@ -98852,25 +70957,17 @@ function in the parent #GtkDialog. - a #GtkMessageDialog + a #GtkMessageDialog - the image + the image - - Sets the text of the message dialog to be @str, which is marked + + Sets the text of the message dialog to be @str, which is marked up with the [Pango text markup language][PangoMarkupFormat]. @@ -98878,91 +70975,49 @@ up with the [Pango text markup language][PangoMarkupFormat]. - a #GtkMessageDialog + a #GtkMessageDialog - markup string (see [Pango markup format][PangoMarkupFormat]) + markup string (see [Pango markup format][PangoMarkupFormat]) - + - - The image for this dialog. + + The image for this dialog. Use #GtkDialog to create dialogs with images - The #GtkBox that corresponds to the message area of this dialog. See + The #GtkBox that corresponds to the message area of this dialog. See gtk_message_dialog_get_message_area() for a detailed description of this area. - - The type of the message. + + The type of the message. - - The secondary text of the message dialog. + + The secondary text of the message dialog. - - %TRUE if the secondary text of the dialog includes Pango markup. + + %TRUE if the secondary text of the dialog includes Pango markup. See pango_parse_markup(). - - The primary text of the message dialog. If the dialog has + + The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title. - - %TRUE if the primary text of the dialog includes Pango markup. + + %TRUE if the primary text of the dialog includes Pango markup. See pango_parse_markup(). @@ -98973,9 +71028,7 @@ See pango_parse_markup(). - + @@ -99013,70 +71066,29 @@ See pango_parse_markup(). - + - - The type of message being displayed in the dialog. - - Informational message + + The type of message being displayed in the dialog. + + Informational message - - Non-fatal warning message + + Non-fatal warning message - - Question requiring a choice + + Question requiring a choice - - Fatal error message + + Fatal error message - - None of the above + + None of the above - - The #GtkMisc widget is an abstract widget which is not useful itself, but + + The #GtkMisc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes. The horizontal and vertical padding attributes allows extra space to be @@ -99094,13 +71106,8 @@ this fact, all #GtkMisc API has been deprecated. - - Gets the X and Y alignment of the widget within its allocation. + + Gets the X and Y alignment of the widget within its allocation. See gtk_misc_set_alignment(). Use #GtkWidget alignment and margin properties. @@ -99109,42 +71116,21 @@ See gtk_misc_set_alignment(). - a #GtkMisc + a #GtkMisc - - location to store X alignment of @misc, or %NULL + + location to store X alignment of @misc, or %NULL - - location to store Y alignment of @misc, or %NULL + + location to store Y alignment of @misc, or %NULL - - Gets the padding in the X and Y directions of the widget. + + Gets the padding in the X and Y directions of the widget. See gtk_misc_set_padding(). Use #GtkWidget alignment and margin properties. @@ -99153,44 +71139,23 @@ See gtk_misc_set_padding(). - a #GtkMisc + a #GtkMisc - - location to store padding in the X + + location to store padding in the X direction, or %NULL - - location to store padding in the Y + + location to store padding in the Y direction, or %NULL - - Sets the alignment of the widget. + + Sets the alignment of the widget. Use #GtkWidget's alignment (#GtkWidget:halign and #GtkWidget:valign) and margin properties or #GtkLabel's #GtkLabel:xalign and #GtkLabel:yalign properties. @@ -99198,32 +71163,21 @@ See gtk_misc_set_padding(). - a #GtkMisc. + a #GtkMisc. - the horizontal alignment, from 0 (left) to 1 (right). + the horizontal alignment, from 0 (left) to 1 (right). - the vertical alignment, from 0 (top) to 1 (bottom). + the vertical alignment, from 0 (top) to 1 (bottom). - - Sets the amount of space to add around the widget. + + Sets the amount of space to add around the widget. Use #GtkWidget alignment and margin properties. @@ -99231,75 +71185,45 @@ See gtk_misc_set_padding(). - a #GtkMisc. + a #GtkMisc. - the amount of space to add on the left and right of the widget, + the amount of space to add on the left and right of the widget, in pixels. - the amount of space to add on the top and bottom of the widget, + the amount of space to add on the top and bottom of the widget, in pixels. - - The horizontal alignment. A value of 0.0 means left alignment (or right + + The horizontal alignment. A value of 0.0 means left alignment (or right on RTL locales); a value of 1.0 means right alignment (or left on RTL locales). Use gtk_widget_set_halign() instead. If you are using #GtkLabel, use #GtkLabel:xalign instead. - - The amount of space to add on the left and right of the widget, in + + The amount of space to add on the left and right of the widget, in pixels. Use gtk_widget_set_margin_start() and gtk_widget_set_margin_end() instead - - The vertical alignment. A value of 0.0 means top alignment; + + The vertical alignment. A value of 0.0 means top alignment; a value of 1.0 means bottom alignment. Use gtk_widget_set_valign() instead. If you are using #GtkLabel, use #GtkLabel:yalign instead. - - The amount of space to add on the top and bottom of the widget, in + + The amount of space to add on the top and bottom of the widget, in pixels. Use gtk_widget_set_margin_top() and gtk_widget_set_margin_bottom() instead @@ -99312,9 +71236,7 @@ pixels. - + @@ -99355,15 +71277,8 @@ pixels. - - GtkModelButton is a button class that can use a #GAction as its model. + + GtkModelButton is a button class that can use a #GAction as its model. In contrast to #GtkToggleButton or #GtkRadioButton, which can also be backed by a #GAction via the #GtkActionable:action-name property, GtkModelButton will adapt its appearance according to the kind of @@ -99430,20 +71345,20 @@ property to place the submenu indicator at the opposite side. |[<!-- language="plain" --> modelbutton -├── <child> -╰── check +├── <child> +╰── check ]| |[<!-- language="plain" --> modelbutton -├── <child> -╰── radio +├── <child> +╰── radio ]| |[<!-- language="plain" --> modelbutton -├── <child> -╰── arrow +├── <child> +╰── arrow ]| GtkModelButton has a main CSS node with name modelbutton, and a subnode, @@ -99455,8 +71370,8 @@ The subnode is positioned before or after the content nodes and gets the |[<!-- language="plain" --> button.model -├── <child> -╰── check +├── <child> +╰── check ]| Iconic model buttons (see #GtkModelButton:iconic) change the name of @@ -99466,120 +71381,65 @@ subnode is invisible in this case. - - Creates a new GtkModelButton. + + Creates a new GtkModelButton. - the newly created #GtkModelButton widget + the newly created #GtkModelButton widget - - The state of the button. This is reflecting the state of the associated + + The state of the button. This is reflecting the state of the associated #GAction. - - Whether to render the button contents centered instead of left-aligned. + + Whether to render the button contents centered instead of left-aligned. This property should be set for title-like items. - - A #GIcon that will be used if iconic appearance for the button is + + A #GIcon that will be used if iconic appearance for the button is desired. - - If this property is set, the button will show an icon if one is set. + + If this property is set, the button will show an icon if one is set. If no icon is set, the text will be used. This is typically used for horizontal sections of linked buttons. - - Whether to show the submenu indicator at the opposite side than normal. + + Whether to show the submenu indicator at the opposite side than normal. This property should be set for model buttons that 'go back' to a parent menu. - - The name of a submenu to open when the button is activated. + + The name of a submenu to open when the button is activated. If this is set, the button should not have an action associated with it. - - Specifies whether the button is a plain, check or radio button. + + Specifies whether the button is a plain, check or radio button. When #GtkActionable:action-name is set, the role will be determined from the action and does not have to be set explicitly. - - The label for the button. + + The label for the button. - - If %TRUE, XML tags in the text of the button are interpreted as by + + If %TRUE, XML tags in the text of the button are interpreted as by pango_parse_markup() to format the enclosed spans of text. If %FALSE, the text will be displayed verbatim. - - A multihead-aware GTK+ module may have a gtk_module_display_init() function + + A multihead-aware GTK+ module may have a gtk_module_display_init() function with this prototype. GTK+ calls this function for each opened display. @@ -99587,155 +71447,94 @@ with this prototype. GTK+ calls this function for each opened display. - an open #GdkDisplay + an open #GdkDisplay - Each GTK+ module must have a function gtk_module_init() with this prototype. + Each GTK+ module must have a function gtk_module_init() with this prototype. This function is called after loading the module. - - GTK+ always passes %NULL for this argument + + GTK+ always passes %NULL for this argument - - GTK+ always passes %NULL for this argument + + GTK+ always passes %NULL for this argument - - This should not be accessed directly. Use the accessor functions below. + + This should not be accessed directly. Use the accessor functions below. - - Creates a new #GtkMountOperation + + Creates a new #GtkMountOperation - a new #GtkMountOperation + a new #GtkMountOperation - - transient parent of the window, or %NULL + + transient parent of the window, or %NULL - - Gets the transient parent used by the #GtkMountOperation + + Gets the transient parent used by the #GtkMountOperation - the transient parent for windows shown by @op + the transient parent for windows shown by @op - a #GtkMountOperation + a #GtkMountOperation - - Gets the screen on which windows of the #GtkMountOperation + + Gets the screen on which windows of the #GtkMountOperation will be shown. - the screen on which windows of @op are shown + the screen on which windows of @op are shown - a #GtkMountOperation + a #GtkMountOperation - - Returns whether the #GtkMountOperation is currently displaying + + Returns whether the #GtkMountOperation is currently displaying a window. - %TRUE if @op is currently displaying a window + %TRUE if @op is currently displaying a window - a #GtkMountOperation + a #GtkMountOperation - - Sets the transient parent for windows shown by the + + Sets the transient parent for windows shown by the #GtkMountOperation. @@ -99743,43 +71542,28 @@ a window. - a #GtkMountOperation + a #GtkMountOperation - - transient parent of the window, or %NULL + + transient parent of the window, or %NULL - - Sets the screen to show windows of the #GtkMountOperation on. + + Sets the screen to show windows of the #GtkMountOperation on. - a #GtkMountOperation + a #GtkMountOperation - a #GdkScreen + a #GdkScreen @@ -99800,14 +71584,10 @@ a window. - + - The parent class. + The parent class. @@ -99843,94 +71623,39 @@ a window. - + - - - Move forward or back by graphemes + + + Move forward or back by graphemes - - Move left or right by graphemes + + Move left or right by graphemes - - Move forward or back by words + + Move forward or back by words - - Move up or down lines (wrapped lines) + + Move up or down lines (wrapped lines) - - Move to either end of a line + + Move to either end of a line - - Move up or down paragraphs (newline-ended lines) + + Move up or down paragraphs (newline-ended lines) - - Move to either end of a paragraph + + Move to either end of a paragraph - - Move by pages + + Move by pages - - Move to ends of the buffer + + Move to ends of the buffer - - Move horizontally by pages + + Move horizontally by pages @@ -99942,128 +71667,92 @@ a window. - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - - Native dialogs are platform dialogs that don't use #GtkDialog or + + Native dialogs are platform dialogs that don't use #GtkDialog or #GtkWindow. They are used in order to integrate better with a platform, by looking the same as other native applications and supporting platform specific features. @@ -100080,9 +71769,7 @@ to run any native dialog in a modal way with a recursive mainloop, similar to gtk_dialog_run(). - Hides the dialog if it is visilbe, aborting any interaction. Once this + Hides the dialog if it is visilbe, aborting any interaction. Once this is called the #GtkNativeDialog::response signal will not be emitted until after the next call to gtk_native_dialog_show(). @@ -100093,9 +71780,7 @@ If the dialog is not visible this does nothing. - a #GtkNativeDialog + a #GtkNativeDialog @@ -100110,14 +71795,12 @@ If the dialog is not visible this does nothing. - + - Shows the dialog on the display, allowing the user to interact with + Shows the dialog on the display, allowing the user to interact with it. When the user accepts the state of the dialog the dialog will be automatically hidden and the #GtkNativeDialog::response signal will be emitted. @@ -100129,19 +71812,13 @@ Multiple calls while the dialog is visible will be ignored. - a #GtkNativeDialog + a #GtkNativeDialog - - Destroys a dialog. + + Destroys a dialog. When a dialog is destroyed, it will break any references it holds to other objects. If it is visible it will be hidden and any underlying @@ -100156,109 +71833,73 @@ system to the #GtkNativeDialog. - a #GtkNativeDialog + a #GtkNativeDialog - - Returns whether the dialog is modal. See gtk_native_dialog_set_modal(). + + Returns whether the dialog is modal. See gtk_native_dialog_set_modal(). - %TRUE if the dialog is set to be modal + %TRUE if the dialog is set to be modal - a #GtkNativeDialog + a #GtkNativeDialog - - Gets the title of the #GtkNativeDialog. + + Gets the title of the #GtkNativeDialog. - the title of the dialog, or %NULL if none has + the title of the dialog, or %NULL if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed. - a #GtkNativeDialog + a #GtkNativeDialog - - Fetches the transient parent for this window. See + + Fetches the transient parent for this window. See gtk_native_dialog_set_transient_for(). - the transient parent for this window, + the transient parent for this window, or %NULL if no transient parent has been set. - a #GtkNativeDialog + a #GtkNativeDialog - - Determines whether the dialog is visible. + + Determines whether the dialog is visible. - %TRUE if the dialog is visible + %TRUE if the dialog is visible - a #GtkNativeDialog + a #GtkNativeDialog - Hides the dialog if it is visilbe, aborting any interaction. Once this + Hides the dialog if it is visilbe, aborting any interaction. Once this is called the #GtkNativeDialog::response signal will not be emitted until after the next call to gtk_native_dialog_show(). @@ -100269,17 +71910,13 @@ If the dialog is not visible this does nothing. - a #GtkNativeDialog + a #GtkNativeDialog - Blocks in a recursive main loop until @self emits the + Blocks in a recursive main loop until @self emits the #GtkNativeDialog::response signal. It then returns the response ID from the ::response signal emission. @@ -100307,29 +71944,21 @@ Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows in the same window group while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will -be triggered during a gtk_nautilus_dialog_run() call. +be triggered during a gtk_native_dialog_run() call. - response ID + response ID - a #GtkNativeDialog + a #GtkNativeDialog - - Sets a dialog modal or non-modal. Modal dialogs prevent interaction + + Sets a dialog modal or non-modal. Modal dialogs prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use gtk_native_dialog_set_transient_for() to make the dialog transient for the @@ -100341,50 +71970,34 @@ will then disallow lowering the dialog below the parent. - a #GtkNativeDialog + a #GtkNativeDialog - whether the window is modal + whether the window is modal - - Sets the title of the #GtkNativeDialog. + + Sets the title of the #GtkNativeDialog. - a #GtkNativeDialog + a #GtkNativeDialog - title of the dialog + title of the dialog - - Dialog windows should be set transient for the main application + + Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the @@ -100397,26 +72010,17 @@ Passing %NULL for @parent unsets the current transient window. - a #GtkNativeDialog + a #GtkNativeDialog - - parent window, or %NULL + + parent window, or %NULL - Shows the dialog on the display, allowing the user to interact with + Shows the dialog on the display, allowing the user to interact with it. When the user accepts the state of the dialog the dialog will be automatically hidden and the #GtkNativeDialog::response signal will be emitted. @@ -100428,57 +72032,32 @@ Multiple calls while the dialog is visible will be ignored. - a #GtkNativeDialog + a #GtkNativeDialog - - Whether the window should be modal with respect to its transient parent. + + Whether the window should be modal with respect to its transient parent. - - The title of the dialog window + + The title of the dialog window - - The transient parent of the dialog, or %NULL for none. + + The transient parent of the dialog, or %NULL for none. - - Whether the window is currenlty visible. + + Whether the window is currenlty visible. - Emitted when the user responds to the dialog. + Emitted when the user responds to the dialog. When this is called the dialog has been hidden. @@ -100489,17 +72068,13 @@ the dialog this signal will not be emitted. - the response ID - + the response ID + - + @@ -100515,7 +72090,7 @@ the dialog this signal will not be emitted. - + @@ -100528,9 +72103,7 @@ the dialog this signal will not be emitted. - a #GtkNativeDialog + a #GtkNativeDialog @@ -100544,9 +72117,7 @@ the dialog this signal will not be emitted. - a #GtkNativeDialog + a #GtkNativeDialog @@ -100585,16 +72156,8 @@ the dialog this signal will not be emitted. - - The #GtkNotebook widget is a #GtkContainer whose children are pages that + + The #GtkNotebook widget is a #GtkContainer whose children are pages that can be switched between using tab labels along one edge. There are many configuration options for GtkNotebook. Among other @@ -100608,14 +72171,14 @@ will be a popup menu allowing the users to switch pages. # GtkNotebook as GtkBuildable The GtkNotebook implementation of the #GtkBuildable interface -supports placing children into tabs by specifying “tab” as the -“type” attribute of a <child> element. Note that the content +supports placing children into tabs by specifying “tab” as the +“type” attribute of a <child> element. Note that the content of the tab must be created before the tab can be filled. A tab child can be specified without specifying a <child> type attribute. To add a child widget in the notebooks action area, specify -"action-start" or “action-end” as the “type” attribute of the +"action-start" or “action-end” as the “type” attribute of the <child> element. An example of a UI definition fragment with GtkNotebook: @@ -100638,22 +72201,22 @@ An example of a UI definition fragment with GtkNotebook: |[<!-- language="plain" --> notebook -├── header.top -│ ├── [<action widget>] -│ ├── tabs -│ │ ├── [arrow] -│ │ ├── tab -│ │ │ ╰── <tab label> -┊ ┊ ┊ -│ │ ├── tab[.reorderable-page] -│ │ │ ╰── <tab label> -│ │ ╰── [arrow] -│ ╰── [<action widget>] -│ -╰── stack - ├── <child> - ┊ - ╰── <child> +├── header.top +│ ├── [<action widget>] +│ ├── tabs +│ │ ├── [arrow] +│ │ ├── tab +│ │ │ ╰── <tab label> +┊ ┊ ┊ +│ │ ├── tab[.reorderable-page] +│ │ │ ╰── <tab label> +│ │ ╰── [arrow] +│ ╰── [<action widget>] +│ +╰── stack + ├── <child> + ┊ + ╰── <child> ]| GtkNotebook has a main CSS node with name notebook, a subnode @@ -100678,14 +72241,10 @@ The nodes are always arranged from left-to-right, regarldess of text direction.< - Creates a new #GtkNotebook widget with no pages. + Creates a new #GtkNotebook widget with no pages. - the newly created #GtkNotebook + the newly created #GtkNotebook @@ -100874,86 +72433,54 @@ The nodes are always arranged from left-to-right, regarldess of text direction.< - Appends a page to @notebook. + Appends a page to @notebook. - the index (starting from 0) of the appended + the index (starting from 0) of the appended page in the notebook, or -1 if function fails - a #GtkNotebook + a #GtkNotebook - the #GtkWidget to use as the contents of the page + the #GtkWidget to use as the contents of the page - - the #GtkWidget to be used as the label - for the page, or %NULL to use the default label, “page N” + + the #GtkWidget to be used as the label + for the page, or %NULL to use the default label, “page N” - - Appends a page to @notebook, specifying the widget to use as the + + Appends a page to @notebook, specifying the widget to use as the label in the popup menu. - the index (starting from 0) of the appended + the index (starting from 0) of the appended page in the notebook, or -1 if function fails - a #GtkNotebook + a #GtkNotebook - the #GtkWidget to use as the contents of the page + the #GtkWidget to use as the contents of the page - - the #GtkWidget to be used as the label - for the page, or %NULL to use the default label, “page N” + + the #GtkWidget to be used as the label + for the page, or %NULL to use the default label, “page N” - - the widget to use as a label for the + + the widget to use as a label for the page-switch menu, if that is enabled. If %NULL, and @tab_label is a #GtkLabel or %NULL, then the menu label will be a newly created label with the same text as @tab_label; if @tab_label @@ -100963,12 +72490,8 @@ label in the popup menu. - - Removes the child from the notebook. + + Removes the child from the notebook. This function is very similar to gtk_container_remove(), but additionally informs the notebook that the removal @@ -100980,132 +72503,90 @@ not be cancelled. - a #GtkNotebook + a #GtkNotebook - a child + a child - - Gets one of the action widgets. See gtk_notebook_set_action_widget(). + + Gets one of the action widgets. See gtk_notebook_set_action_widget(). - The action widget with the given + The action widget with the given @pack_type or %NULL when this action widget has not been set - a #GtkNotebook + a #GtkNotebook - pack type of the action widget to receive + pack type of the action widget to receive - - Returns the page number of the current page. + + Returns the page number of the current page. - the index (starting from 0) of the current + the index (starting from 0) of the current page in the notebook. If the notebook has no pages, then -1 will be returned. - a #GtkNotebook + a #GtkNotebook - - Gets the current group name for @notebook. + + Gets the current group name for @notebook. - the group name, or %NULL if none is set + the group name, or %NULL if none is set - a #GtkNotebook + a #GtkNotebook - Retrieves the menu label widget of the page containing @child. + Retrieves the menu label widget of the page containing @child. - the menu label, or %NULL if the + the menu label, or %NULL if the notebook page does not have a menu label other than the default (the tab label). - a #GtkNotebook + a #GtkNotebook - a widget contained in a page of @notebook + a widget contained in a page of @notebook - - Retrieves the text of the menu label for the page containing + + Retrieves the text of the menu label for the page containing @child. - the text of the tab label, or %NULL if the widget does + the text of the tab label, or %NULL if the widget does not have a menu label other than the default menu label, or the menu label widget is not a #GtkLabel. The string is owned by the widget and must not be freed. @@ -101113,406 +72594,270 @@ freed. - a #GtkNotebook + a #GtkNotebook - the child widget of a page of the notebook. + the child widget of a page of the notebook. - - Gets the number of pages in a notebook. + + Gets the number of pages in a notebook. - the number of pages in the notebook + the number of pages in the notebook - a #GtkNotebook + a #GtkNotebook - Returns the child widget contained in page number @page_num. + Returns the child widget contained in page number @page_num. - the child widget, or %NULL if @page_num + the child widget, or %NULL if @page_num is out of bounds - a #GtkNotebook + a #GtkNotebook - the index of a page in the notebook, or -1 + the index of a page in the notebook, or -1 to get the last page - Returns whether the tab label area has arrows for scrolling. + Returns whether the tab label area has arrows for scrolling. See gtk_notebook_set_scrollable(). - %TRUE if arrows for scrolling are present + %TRUE if arrows for scrolling are present - a #GtkNotebook + a #GtkNotebook - - Returns whether a bevel will be drawn around the notebook pages. + + Returns whether a bevel will be drawn around the notebook pages. See gtk_notebook_set_show_border(). - %TRUE if the bevel is drawn + %TRUE if the bevel is drawn - a #GtkNotebook + a #GtkNotebook - Returns whether the tabs of the notebook are shown. + Returns whether the tabs of the notebook are shown. See gtk_notebook_set_show_tabs(). - %TRUE if the tabs are shown + %TRUE if the tabs are shown - a #GtkNotebook + a #GtkNotebook - - Returns whether the tab contents can be detached from @notebook. + + Returns whether the tab contents can be detached from @notebook. - %TRUE if the tab is detachable. + %TRUE if the tab is detachable. - a #GtkNotebook + a #GtkNotebook - a child #GtkWidget + a child #GtkWidget - - Returns the horizontal width of a tab border. + + Returns the horizontal width of a tab border. this function returns zero - horizontal width of a tab border + horizontal width of a tab border - a #GtkNotebook + a #GtkNotebook - Returns the tab label widget for the page @child. + Returns the tab label widget for the page @child. %NULL is returned if @child is not in @notebook or if no tab label has specifically been set for @child. - the tab label + the tab label - a #GtkNotebook + a #GtkNotebook - the page + the page - - Retrieves the text of the tab label for the page containing + + Retrieves the text of the tab label for the page containing @child. - the text of the tab label, or %NULL if the tab label + the text of the tab label, or %NULL if the tab label widget is not a #GtkLabel. The string is owned by the widget and must not be freed. - a #GtkNotebook + a #GtkNotebook - a widget contained in a page of @notebook + a widget contained in a page of @notebook - Gets the edge at which the tabs for switching pages in the + Gets the edge at which the tabs for switching pages in the notebook are drawn. - the edge at which the tabs are drawn + the edge at which the tabs are drawn - a #GtkNotebook + a #GtkNotebook - - Gets whether the tab can be reordered via drag and drop or not. + + Gets whether the tab can be reordered via drag and drop or not. - %TRUE if the tab is reorderable. + %TRUE if the tab is reorderable. - a #GtkNotebook + a #GtkNotebook - a child #GtkWidget + a child #GtkWidget - - Returns the vertical width of a tab border. + + Returns the vertical width of a tab border. this function returns zero - vertical width of a tab border + vertical width of a tab border - a #GtkNotebook + a #GtkNotebook - Insert a page into @notebook at the given position. + Insert a page into @notebook at the given position. - the index (starting from 0) of the inserted + the index (starting from 0) of the inserted page in the notebook, or -1 if function fails - a #GtkNotebook + a #GtkNotebook - the #GtkWidget to use as the contents of the page + the #GtkWidget to use as the contents of the page - - the #GtkWidget to be used as the label - for the page, or %NULL to use the default label, “page N” + + the #GtkWidget to be used as the label + for the page, or %NULL to use the default label, “page N” - the index (starting at 0) at which to insert the page, + the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages - - Insert a page into @notebook at the given position, specifying + + Insert a page into @notebook at the given position, specifying the widget to use as the label in the popup menu. - the index (starting from 0) of the inserted + the index (starting from 0) of the inserted page in the notebook - a #GtkNotebook + a #GtkNotebook - the #GtkWidget to use as the contents of the page + the #GtkWidget to use as the contents of the page - - the #GtkWidget to be used as the label - for the page, or %NULL to use the default label, “page N” + + the #GtkWidget to be used as the label + for the page, or %NULL to use the default label, “page N” - - the widget to use as a label for the + + the widget to use as a label for the page-switch menu, if that is enabled. If %NULL, and @tab_label is a #GtkLabel or %NULL, then the menu label will be a newly created label with the same text as @tab_label; if @tab_label @@ -101521,18 +72866,14 @@ the widget to use as the label in the popup menu. - the index (starting at 0) at which to insert the page, + the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages. - Switches to the next page. Nothing happens if the current page is + Switches to the next page. Nothing happens if the current page is the last page. @@ -101540,62 +72881,46 @@ the last page. - a #GtkNotebook + a #GtkNotebook - Finds the index of the page which contains the given child + Finds the index of the page which contains the given child widget. - the index of the page containing @child, or + the index of the page containing @child, or -1 if @child is not in the notebook - a #GtkNotebook + a #GtkNotebook - a #GtkWidget + a #GtkWidget - Disables the popup menu. + Disables the popup menu. - a #GtkNotebook + a #GtkNotebook - Enables the popup menu: if the user clicks with the right + Enables the popup menu: if the user clicks with the right mouse button on the tab labels, a menu with all the pages will be popped up. @@ -101604,94 +72929,60 @@ will be popped up. - a #GtkNotebook + a #GtkNotebook - Prepends a page to @notebook. + Prepends a page to @notebook. - the index (starting from 0) of the prepended + the index (starting from 0) of the prepended page in the notebook, or -1 if function fails - a #GtkNotebook + a #GtkNotebook - the #GtkWidget to use as the contents of the page + the #GtkWidget to use as the contents of the page - - the #GtkWidget to be used as the label - for the page, or %NULL to use the default label, “page N” + + the #GtkWidget to be used as the label + for the page, or %NULL to use the default label, “page N” - - Prepends a page to @notebook, specifying the widget to use as the + + Prepends a page to @notebook, specifying the widget to use as the label in the popup menu. - the index (starting from 0) of the prepended + the index (starting from 0) of the prepended page in the notebook, or -1 if function fails - a #GtkNotebook + a #GtkNotebook - the #GtkWidget to use as the contents of the page + the #GtkWidget to use as the contents of the page - - the #GtkWidget to be used as the label - for the page, or %NULL to use the default label, “page N” + + the #GtkWidget to be used as the label + for the page, or %NULL to use the default label, “page N” - - the widget to use as a label for the + + the widget to use as a label for the page-switch menu, if that is enabled. If %NULL, and @tab_label is a #GtkLabel or %NULL, then the menu label will be a newly created label with the same text as @tab_label; if @tab_label @@ -101702,9 +72993,7 @@ label in the popup menu. - Switches to the previous page. Nothing happens if the current page + Switches to the previous page. Nothing happens if the current page is the first page. @@ -101712,17 +73001,13 @@ is the first page. - a #GtkNotebook + a #GtkNotebook - Removes a page from the notebook given its index + Removes a page from the notebook given its index in the notebook. @@ -101730,24 +73015,18 @@ in the notebook. - a #GtkNotebook + a #GtkNotebook - the index of a notebook page, starting + the index of a notebook page, starting from 0. If -1, the last page will be removed. - Reorders the page containing @child, so that it appears in position + Reorders the page containing @child, so that it appears in position @position. If @position is greater than or equal to the number of children in the list or negative, @child will be moved to the end of the list. @@ -101757,35 +73036,25 @@ of the list. - a #GtkNotebook + a #GtkNotebook - the child to move + the child to move - the new position, or -1 to move to the end + the new position, or -1 to move to the end - - Sets @widget as one of the action widgets. Depending on the pack type + + Sets @widget as one of the action widgets. Depending on the pack type the widget will be placed before or after the tabs. You can use a #GtkBox if you need to pack more than one widget on the same side. -Note that action widgets are “internal” children of the notebook and thus +Note that action widgets are “internal” children of the notebook and thus not included in the list returned from gtk_container_foreach(). @@ -101793,30 +73062,21 @@ not included in the list returned from gtk_container_foreach(). - a #GtkNotebook + a #GtkNotebook - a #GtkWidget + a #GtkWidget - pack type of the action widget + pack type of the action widget - - Switches to the page number @page_num. + + Switches to the page number @page_num. Note that due to historical reasons, GtkNotebook refuses to switch to a page unless the child widget is visible. @@ -101828,15 +73088,11 @@ adding them to a notebook. - a #GtkNotebook + a #GtkNotebook - index of the page to switch to, starting from 0. + index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the notebook, nothing will be done. @@ -101844,12 +73100,8 @@ adding them to a notebook. - - Sets a group name for @notebook. + + Sets a group name for @notebook. Notebooks with the same name will be able to exchange tabs via drag and drop. A notebook with a %NULL group name will @@ -101860,89 +73112,60 @@ not be able to exchange tabs with any other notebook. - a #GtkNotebook + a #GtkNotebook - - the name of the notebook group, + + the name of the notebook group, or %NULL to unset it - Changes the menu label for the page containing @child. + Changes the menu label for the page containing @child. - a #GtkNotebook + a #GtkNotebook - the child widget + the child widget - - the menu label, or %NULL for default + + the menu label, or %NULL for default - - Creates a new label and sets it as the menu label of @child. + + Creates a new label and sets it as the menu label of @child. - a #GtkNotebook + a #GtkNotebook - the child widget + the child widget - the label text + the label text - Sets whether the tab label area will have arrows for + Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area. @@ -101950,24 +73173,17 @@ scrolling if there are too many tabs to fit in the area. - a #GtkNotebook + a #GtkNotebook - %TRUE if scroll arrows should be added + %TRUE if scroll arrows should be added - - Sets whether a bevel will be drawn around the notebook pages. + + Sets whether a bevel will be drawn around the notebook pages. This only has a visual effect when the tabs are not shown. See gtk_notebook_set_show_tabs(). @@ -101976,48 +73192,34 @@ See gtk_notebook_set_show_tabs(). - a #GtkNotebook + a #GtkNotebook - %TRUE if a bevel should be drawn around the notebook + %TRUE if a bevel should be drawn around the notebook - Sets whether to show the tabs for the notebook or not. + Sets whether to show the tabs for the notebook or not. - a #GtkNotebook + a #GtkNotebook - %TRUE if the tabs should be shown + %TRUE if the tabs should be shown - - Sets whether the tab can be detached from @notebook to another + + Sets whether the tab can be detached from @notebook to another notebook or widget. Note that 2 notebooks must share a common group identificator @@ -102026,7 +73228,7 @@ interchange between them. If you want a widget to interact with a notebook through DnD (i.e.: accept dragged tabs from it) it must be set as a drop -destination and accept the target “GTK_NOTEBOOK_TAB”. The notebook +destination and accept the target “GTK_NOTEBOOK_TAB”. The notebook will fill the selection with a GtkWidget** pointing to the child widget that corresponds to the dropped tab. @@ -102068,65 +73270,45 @@ you will have to set your own DnD code to do it. - a #GtkNotebook + a #GtkNotebook - a child #GtkWidget + a child #GtkWidget - whether the tab is detachable or not + whether the tab is detachable or not - Changes the tab label for @child. + Changes the tab label for @child. If %NULL is specified for @tab_label, then the page will -have the label “page N”. +have the label “page N”. - a #GtkNotebook + a #GtkNotebook - the page + the page - - the tab label widget to use, or %NULL + + the tab label widget to use, or %NULL for default tab label - - Creates a new label and sets it as the tab label for the page + + Creates a new label and sets it as the tab label for the page containing @child. @@ -102134,29 +73316,21 @@ containing @child. - a #GtkNotebook + a #GtkNotebook - the page + the page - the label text + the label text - Sets the edge at which the tabs for switching pages in the + Sets the edge at which the tabs for switching pages in the notebook are drawn. @@ -102164,25 +73338,17 @@ notebook are drawn. - a #GtkNotebook. + a #GtkNotebook. - the edge to draw the tabs at + the edge to draw the tabs at - - Sets whether the notebook tab can be reordered + + Sets whether the notebook tab can be reordered via drag and drop or not. @@ -102190,21 +73356,15 @@ via drag and drop or not. - a #GtkNotebook + a #GtkNotebook - a child #GtkWidget + a child #GtkWidget - whether the tab is reorderable or not + whether the tab is reorderable or not @@ -102212,13 +73372,8 @@ via drag and drop or not. - - Group name for tab drag and drop. + + Group name for tab drag and drop. @@ -102253,9 +73408,7 @@ via drag and drop or not. - The ::create-window signal is emitted when a detachable + The ::create-window signal is emitted when a detachable tab is dropped on the root window. A handler for this signal can create a window containing @@ -102264,29 +73417,21 @@ responsible for moving/resizing the window and adding the necessary properties to the notebook (e.g. the #GtkNotebook:group-name ). - a #GtkNotebook that @page should be + a #GtkNotebook that @page should be added to, or %NULL. - the tab of @notebook that is being detached + the tab of @notebook that is being detached - the X coordinate where the drop happens + the X coordinate where the drop happens - the Y coordinate where the drop happens + the Y coordinate where the drop happens @@ -102312,70 +73457,52 @@ necessary properties to the notebook (e.g. the - the ::page-added signal is emitted in the notebook + the ::page-added signal is emitted in the notebook right after a page is added to the notebook. - the child #GtkWidget affected + the child #GtkWidget affected - the new page number for @child + the new page number for @child - the ::page-removed signal is emitted in the notebook + the ::page-removed signal is emitted in the notebook right after a page is removed from the notebook. - the child #GtkWidget affected + the child #GtkWidget affected - the @child page number + the @child page number - the ::page-reordered signal is emitted in the notebook + the ::page-reordered signal is emitted in the notebook right after a page has been reordered. - the child #GtkWidget affected + the child #GtkWidget affected - the new page number for @child + the new page number for @child @@ -102404,35 +73531,23 @@ right after a page has been reordered. - Emitted when the user or a function changes the current page. + Emitted when the user or a function changes the current page. - the new current page + the new current page - the index of the page + the index of the page - + @@ -102440,27 +73555,19 @@ right after a page has been reordered. - + - + - + - + - + @@ -102736,19 +73843,11 @@ right after a page has been reordered. - - + + - + @@ -102761,17 +73860,14 @@ right after a page has been reordered. - - + + - + @@ -102779,126 +73875,57 @@ right after a page has been reordered. - + - - + + - - + + - - + + - + - - Used to determine the layout of pages on a sheet when printing + + Used to determine the layout of pages on a sheet when printing multiple pages per sheet. - - ![](layout-lrtb.png) + + ![](layout-lrtb.png) - - ![](layout-lrbt.png) + + ![](layout-lrbt.png) - - ![](layout-rltb.png) + + ![](layout-rltb.png) - - ![](layout-rlbt.png) + + ![](layout-rlbt.png) - - ![](layout-tblr.png) + + ![](layout-tblr.png) - - ![](layout-tbrl.png) + + ![](layout-tbrl.png) - - ![](layout-btlr.png) + + ![](layout-btlr.png) - - ![](layout-btrl.png) + + ![](layout-btrl.png) - - GtkNumerableIcon is a subclass of #GEmblemedIcon that can + + GtkNumerableIcon is a subclass of #GEmblemedIcon that can show a number or short string as an emblem. The number can be overlayed on top of another emblem, if desired. @@ -102911,203 +73938,118 @@ Typical numerable icons: ![](numerableicon2.png) - - Creates a new unthemed #GtkNumerableIcon. - + + Creates a new unthemed #GtkNumerableIcon. + - a new #GIcon + a new #GIcon - a #GIcon to overlay on + a #GIcon to overlay on - - Creates a new #GtkNumerableIcon which will themed according + + Creates a new #GtkNumerableIcon which will themed according to the passed #GtkStyleContext. This is a convenience constructor that calls gtk_numerable_icon_set_style_context() internally. - + - a new #GIcon + a new #GIcon - a #GIcon to overlay on + a #GIcon to overlay on - a #GtkStyleContext + a #GtkStyleContext - - Returns the #GIcon that was set as the base background image, or -%NULL if there’s none. The caller of this function does not own + + Returns the #GIcon that was set as the base background image, or +%NULL if there’s none. The caller of this function does not own a reference to the returned #GIcon. - + - a #GIcon, or %NULL + a #GIcon, or %NULL - a #GtkNumerableIcon + a #GtkNumerableIcon - - Returns the icon name used as the base background image, -or %NULL if there’s none. - + + Returns the icon name used as the base background image, +or %NULL if there’s none. + - an icon name, or %NULL + an icon name, or %NULL - a #GtkNumerableIcon + a #GtkNumerableIcon - - Returns the value currently displayed by @self. - + + Returns the value currently displayed by @self. + - the currently displayed value + the currently displayed value - a #GtkNumerableIcon + a #GtkNumerableIcon - - Returns the currently displayed label of the icon, or %NULL. - + + Returns the currently displayed label of the icon, or %NULL. + - the currently displayed label + the currently displayed label - a #GtkNumerableIcon + a #GtkNumerableIcon - - Returns the #GtkStyleContext used by the icon for theming, -or %NULL if there’s none. - + + Returns the #GtkStyleContext used by the icon for theming, +or %NULL if there’s none. + - a #GtkStyleContext, or %NULL. + a #GtkStyleContext, or %NULL. This object is internal to GTK+ and should not be unreffed. Use g_object_ref() if you want to keep it around - a #GtkNumerableIcon + a #GtkNumerableIcon - - Updates the icon to use @icon as the base background image. + + Updates the icon to use @icon as the base background image. If @icon is %NULL, @self will go back using style information or default theming for its background image. @@ -103115,37 +74057,23 @@ If this method is called and an icon name was already set as background for the icon, @icon will be used, i.e. the last method called between gtk_numerable_icon_set_background_gicon() and gtk_numerable_icon_set_background_icon_name() has always priority. - + - a #GtkNumerableIcon + a #GtkNumerableIcon - - a #GIcon, or %NULL + + a #GIcon, or %NULL - - Updates the icon to use the icon named @icon_name from the + + Updates the icon to use the icon named @icon_name from the current icon theme as the base background image. If @icon_name is %NULL, @self will go back using style information or default theming for its background image. @@ -103154,37 +74082,23 @@ If this method is called and a #GIcon was already set as background for the icon, @icon_name will be used, i.e. the last method called between gtk_numerable_icon_set_background_icon_name() and gtk_numerable_icon_set_background_gicon() has always priority. - + - a #GtkNumerableIcon + a #GtkNumerableIcon - - an icon name, or %NULL + + an icon name, or %NULL - - Sets the currently displayed value of @self to @count. + + Sets the currently displayed value of @self to @count. The numeric value is always clamped to make it two digits, i.e. between -99 and 99. Setting a count of zero removes the emblem. @@ -103192,34 +74106,23 @@ If this method is called, and a label was already set on the icon, it will automatically be reset to %NULL before rendering the number, i.e. the last method called between gtk_numerable_icon_set_count() and gtk_numerable_icon_set_label() has always priority. - + - a #GtkNumerableIcon + a #GtkNumerableIcon - a number between -99 and 99 + a number between -99 and 99 - - Sets the currently displayed value of @self to the string + + Sets the currently displayed value of @self to the string in @label. Setting an empty label removes the emblem. Note that this is meant for displaying short labels, such as @@ -103232,54 +74135,35 @@ icon, it will automatically be reset to zero before rendering the label, i.e. the last method called between gtk_numerable_icon_set_label() and gtk_numerable_icon_set_count() has always priority. - + - a #GtkNumerableIcon + a #GtkNumerableIcon - - a short label, or %NULL + + a short label, or %NULL - - Updates the icon to fetch theme information from the + + Updates the icon to fetch theme information from the given #GtkStyleContext. - + - a #GtkNumerableIcon + a #GtkNumerableIcon - a #GtkStyleContext + a #GtkStyleContext @@ -103287,9 +74171,7 @@ given #GtkStyleContext. - + @@ -103308,9 +74190,7 @@ given #GtkStyleContext. - + @@ -103321,102 +74201,74 @@ given #GtkStyleContext. - + - + - + - + - + - + - + - + - + - + - - GtkOffscreenWindow is strictly intended to be used for obtaining + + GtkOffscreenWindow is strictly intended to be used for obtaining snapshots of widgets that are not part of a normal widget hierarchy. Since #GtkOffscreenWindow is a toplevel widget you cannot obtain snapshots of a full window with it since you cannot pack a toplevel @@ -103436,67 +74288,45 @@ will emit a #GtkWidget::damage-event signal. - - Creates a toplevel container widget that is used to retrieve + + Creates a toplevel container widget that is used to retrieve snapshots of widgets without showing them on the screen. - A pointer to a #GtkWidget + A pointer to a #GtkWidget - - Retrieves a snapshot of the contained widget in the form of + + Retrieves a snapshot of the contained widget in the form of a #GdkPixbuf. This is a new pixbuf with a reference count of 1, and the application should unreference it once it is no longer needed. - A #GdkPixbuf pointer, or %NULL. + A #GdkPixbuf pointer, or %NULL. - the #GtkOffscreenWindow contained widget. + the #GtkOffscreenWindow contained widget. - - Retrieves a snapshot of the contained widget in the form of + + Retrieves a snapshot of the contained widget in the form of a #cairo_surface_t. If you need to keep this around over window resizes then you should add a reference to it. - A #cairo_surface_t pointer to the offscreen + A #cairo_surface_t pointer to the offscreen surface, or %NULL. - the #GtkOffscreenWindow contained widget. + the #GtkOffscreenWindow contained widget. @@ -103505,14 +74335,10 @@ resizes then you should add a reference to it. - + - The parent class. + The parent class. @@ -103548,125 +74374,72 @@ resizes then you should add a reference to it. - - The #GtkOrientable interface is implemented by all widgets that can be + + The #GtkOrientable interface is implemented by all widgets that can be oriented horizontally or vertically. Historically, such widgets have been realized as subclasses of a common base class (e.g #GtkBox/#GtkHBox/#GtkVBox or #GtkScale/#GtkHScale/#GtkVScale). #GtkOrientable is more flexible in that it allows the orientation to be changed at runtime, allowing the widgets -to “flip”. +to “flip”. #GtkOrientable was introduced in GTK+ 2.16. - - Retrieves the orientation of the @orientable. + + Retrieves the orientation of the @orientable. - the orientation of the @orientable. + the orientation of the @orientable. - a #GtkOrientable + a #GtkOrientable - - Sets the orientation of the @orientable. + + Sets the orientation of the @orientable. - a #GtkOrientable + a #GtkOrientable - the orientable’s new orientation. + the orientable’s new orientation. - - The orientation of the orientable. + + The orientation of the orientable. - + - - Represents the orientation of widgets and other objects which can be switched + + Represents the orientation of widgets and other objects which can be switched between horizontal and vertical orientation on the fly, like #GtkToolbar or #GtkGesturePan. - - The element is in horizontal orientation. + + The element is in horizontal orientation. - - The element is in vertical orientation. + + The element is in vertical orientation. - - GtkOverlay is a container which contains a single main child, on top -of which it can place “overlay” widgets. The position of each overlay + + GtkOverlay is a container which contains a single main child, on top +of which it can place “overlay” widgets. The position of each overlay widget is determined by its #GtkWidget:halign and #GtkWidget:valign properties. E.g. a widget with both alignments set to %GTK_ALIGN_START will be placed at the top left corner of the GtkOverlay container, @@ -103678,32 +74451,28 @@ properties of the child to non-zero values. More complicated placement of overlays is possible by connecting to the #GtkOverlay::get-child-position signal. -An overlay’s minimum and natural sizes are those of its main child. The sizes +An overlay’s minimum and natural sizes are those of its main child. The sizes of overlay children are not considered when measuring these preferred sizes. # GtkOverlay as GtkBuildable The GtkOverlay implementation of the GtkBuildable interface -supports placing a child as an overlay by specifying “overlay” as -the “type” attribute of a `<child>` element. +supports placing a child as an overlay by specifying “overlay” as +the “type” attribute of a `<child>` element. # CSS nodes -GtkOverlay has a single CSS node with the name “overlay”. Overlay children +GtkOverlay has a single CSS node with the name “overlay”. Overlay children whose alignments cause them to be positioned at an edge get the style classes -“.left”, “.right”, “.top”, and/or “.bottom” according to their position. +“.left”, “.right”, “.top”, and/or “.bottom” according to their position. - Creates a new #GtkOverlay. + Creates a new #GtkOverlay. - a new #GtkOverlay object. + a new #GtkOverlay object. @@ -103724,12 +74493,8 @@ whose alignments cause them to be positioned at an edge get the style classes - - Adds @widget to @overlay. + + Adds @widget to @overlay. The widget will be stacked on top of the main widget added with gtk_container_add(). @@ -103742,58 +74507,40 @@ from its #GtkWidget:halign and #GtkWidget:valign properties. - a #GtkOverlay + a #GtkOverlay - a #GtkWidget to be added to the container + a #GtkWidget to be added to the container - - Convenience function to get the value of the #GtkOverlay:pass-through + + Convenience function to get the value of the #GtkOverlay:pass-through child property for @widget. - whether the widget is a pass through child. + whether the widget is a pass through child. - a #GtkOverlay + a #GtkOverlay - an overlay child of #GtkOverlay + an overlay child of #GtkOverlay - - Moves @child to a new @index in the list of @overlay children. + + Moves @child to a new @index in the list of @overlay children. The list contains overlays in the order that these were added to @overlay by default. See also #GtkOverlay:index. -A widget’s index in the @overlay children list determines which order +A widget’s index in the @overlay children list determines which order the children are drawn if they overlap. The first child is drawn at the bottom. It also affects the default focus chain order. @@ -103802,33 +74549,23 @@ the bottom. It also affects the default focus chain order. - a #GtkOverlay + a #GtkOverlay - the overlaid #GtkWidget to move + the overlaid #GtkWidget to move - the new index for @child in the list of overlay children + the new index for @child in the list of overlay children of @overlay, starting from 0. If negative, indicates the end of the list - - Convenience function to set the value of the #GtkOverlay:pass-through + + Convenience function to set the value of the #GtkOverlay:pass-through child property for @widget. @@ -103836,21 +74573,15 @@ child property for @widget. - a #GtkOverlay + a #GtkOverlay - an overlay child of #GtkOverlay + an overlay child of #GtkOverlay - whether the child should pass the input through + whether the child should pass the input through @@ -103862,9 +74593,7 @@ child property for @widget. - The ::get-child-position signal is emitted to determine + The ::get-child-position signal is emitted to determine the position and size of any overlay child widgets. A handler for this signal should fill @allocation with the desired position and size for @widget, relative to @@ -103878,39 +74607,26 @@ be full-width/height). If the main child is a #GtkScrolledWindow, the overlays are placed relative to its contents. - %TRUE if the @allocation has been filled + %TRUE if the @allocation has been filled - the child widget to position + the child widget to position - - return + + return location for the allocation - + - The parent class. + The parent class. @@ -104000,36 +74716,28 @@ to its contents. - + - + - + - + @@ -104043,45 +74751,35 @@ to its contents. - + - + - + - + - + @@ -104089,57 +74787,37 @@ to its contents. - Name for the A3 paper size. + Name for the A3 paper size. - Name for the A4 paper size. + Name for the A4 paper size. - Name for the A5 paper size. + Name for the A5 paper size. - Name for the B5 paper size. + Name for the B5 paper size. - - Name for the Executive paper size. + + Name for the Executive paper size. - - Name for the Legal paper size. + + Name for the Legal paper size. - - Name for the Letter paper size. + + Name for the Letter paper size. @@ -104147,27 +74825,21 @@ to its contents. - + - + - + @@ -104181,411 +74853,293 @@ to its contents. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - The key used by the “Print to file” printer to store the file + + The key used by the “Print to file” printer to store the file name of the output without the path to the directory and the file extension. - + - - The key used by the “Print to file” printer to store the + + The key used by the “Print to file” printer to store the directory to which the output should be written. - - The key used by the “Print to file” printer to store the format -of the output. The supported values are “PS” and “PDF”. + + The key used by the “Print to file” printer to store the format +of the output. The supported values are “PS” and “PDF”. - - The key used by the “Print to file” printer to store the URI + + The key used by the “Print to file” printer to store the URI to which the output should be written. GTK+ itself supports -only “file://” URIs. +only “file://” URIs. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - Use this priority for functionality related to size allocation. + Use this priority for functionality related to size allocation. It is used internally by GTK+ to compute the sizes of widgets. This priority is higher than %GDK_PRIORITY_REDRAW to avoid @@ -104593,206 +75147,114 @@ resizing a widget which was just redrawn. - + - - + + - - + + - - + + - + - + - - Determines how widgets should be packed inside menubars + + Determines how widgets should be packed inside menubars and menuitems contained in menubars. - - Widgets are packed left-to-right + + Widgets are packed left-to-right - - Widgets are packed right-to-left + + Widgets are packed right-to-left - - Widgets are packed top-to-bottom + + Widgets are packed top-to-bottom - - Widgets are packed bottom-to-top + + Widgets are packed bottom-to-top - - Represents the packing location #GtkBox children. (See: #GtkVBox, + + Represents the packing location #GtkBox children. (See: #GtkVBox, #GtkHBox, and #GtkButtonBox). - - The child is packed into the start of the box + + The child is packed into the start of the box - The child is packed into the end of the box + The child is packed into the end of the box - Struct defining a pad action entry. + Struct defining a pad action entry. - the type of pad feature that will trigger this action entry. + the type of pad feature that will trigger this action entry. - the 0-indexed button/ring/strip number that will trigger this action + the 0-indexed button/ring/strip number that will trigger this action entry. - the mode that will trigger this action entry, or -1 for all modes. + the mode that will trigger this action entry, or -1 for all modes. - Human readable description of this action entry, this string should + Human readable description of this action entry, this string should be deemed user-visible. - action name that will be activated in the #GActionGroup. + action name that will be activated in the #GActionGroup. - - The type of a pad action. - - Action is triggered by a pad button + + The type of a pad action. + + Action is triggered by a pad button - - Action is triggered by a pad ring + + Action is triggered by a pad ring - - Action is triggered by a pad strip + + Action is triggered by a pad strip - - #GtkPadController is an event controller for the pads found in drawing + + #GtkPadController is an event controller for the pads found in drawing tablets (The collection of buttons and tactile sensors often found around the stylus-sensitive area). @@ -104819,15 +75281,15 @@ modes and pad devices to an "invert-selection" action: |[ GtkPadActionEntry *pad_actions[] = { { GTK_PAD_ACTION_BUTTON, 1, -1, "Invert selection", "pad-actions.invert-selection" }, - … + … }; - … + … action_group = g_simple_action_group_new (); action = g_simple_action_new ("pad-actions.invert-selection", NULL); g_signal_connect (action, "activate", on_invert_selection_activated, NULL); g_action_map_add_action (G_ACTION_MAP (action_group), action); - … + … pad_controller = gtk_pad_controller_new (window, action_group, NULL); ]| @@ -104835,12 +75297,8 @@ The actions belonging to rings/strips will be activated with a parameter of type %G_VARIANT_TYPE_DOUBLE bearing the value of the given axis, it is required that those are made stateful and accepting this #GVariantType. - - Creates a new #GtkPadController that will associate events from @pad to + + Creates a new #GtkPadController that will associate events from @pad to actions. A %NULL pad may be provided so the controller manages all pad devices generically, it is discouraged to mix #GtkPadController objects with %NULL and non-%NULL @pad argument on the same @window, as execution order is not @@ -104851,41 +75309,26 @@ events to actions, use gtk_pad_controller_set_action_entries() or gtk_pad_controller_set_action(). - A newly created #GtkPadController + A newly created #GtkPadController - a #GtkWindow + a #GtkWindow - #GActionGroup to trigger actions from + #GActionGroup to trigger actions from - - A %GDK_SOURCE_TABLET_PAD device, or %NULL to handle all pads + + A %GDK_SOURCE_TABLET_PAD device, or %NULL to handle all pads - - Adds an individual action to @controller. This action will only be activated + + Adds an individual action to @controller. This action will only be activated if the given button/ring/strip number in @index is interacted while the current mode is @mode. -1 may be used for simple cases, so the action is triggered on all modes. @@ -104899,50 +75342,34 @@ feedback. - a #GtkPadController + a #GtkPadController - the type of pad feature that will trigger this action + the type of pad feature that will trigger this action - the 0-indexed button/ring/strip number that will trigger this action + the 0-indexed button/ring/strip number that will trigger this action - the mode that will trigger this action, or -1 for all modes. + the mode that will trigger this action, or -1 for all modes. - Human readable description of this action, this string should + Human readable description of this action, this string should be deemed user-visible. - action name that will be activated in the #GActionGroup + action name that will be activated in the #GActionGroup - - This is a convenience function to add a group of action entries on + + This is a convenience function to add a group of action entries on @controller. See #GtkPadActionEntry and gtk_pad_controller_set_action(). @@ -104950,147 +75377,72 @@ feedback. - a #GtkPadController + a #GtkPadController - the action entries to set on @controller - + the action entries to set on @controller + - the number of elements in @entries + the number of elements in @entries - + - + - + - - See also gtk_print_settings_set_orientation(). - - Portrait mode. + + See also gtk_print_settings_set_orientation(). + + Portrait mode. - - Landscape mode. + + Landscape mode. - - Reverse portrait mode. + + Reverse portrait mode. - - Reverse landscape mode. + + Reverse landscape mode. - See also gtk_print_settings_set_page_ranges(). + See also gtk_print_settings_set_page_ranges(). - start of page range. + start of page range. - end of page range. + end of page range. - - See also gtk_print_job_set_page_set(). - - All pages. + + See also gtk_print_job_set_page_set(). + + All pages. - - Even pages. + + Even pages. - - Odd pages. + + Odd pages. - - A GtkPageSetup object stores the page size, orientation and margins. + + A GtkPageSetup object stores the page size, orientation and margins. The idea is that you can get one of these from the page setup dialog and then pass it to the #GtkPrintOperation when printing. The benefit of splitting this out of the #GtkPrintSettings is that @@ -105098,7 +75450,7 @@ these affect the actual layout of the page, and thus need to be set long before user prints. ## Margins ## {#print-margins} -The margins specified in this object are the “print margins”, i.e. the +The margins specified in this object are the “print margins”, i.e. the parts of the page that the printer cannot print on. These are different from the layout margins that a word processor uses; they are typically used to determine the minimal size for the layout @@ -105134,567 +75486,371 @@ do_page_setup (void) Printing support was added in GTK+ 2.10. - Creates a new #GtkPageSetup. + Creates a new #GtkPageSetup. - a new #GtkPageSetup. + a new #GtkPageSetup. - - Reads the page setup from the file @file_name. Returns a + + Reads the page setup from the file @file_name. Returns a new #GtkPageSetup object with the restored page setup, or %NULL if an error occurred. See gtk_page_setup_to_file(). - the restored #GtkPageSetup + the restored #GtkPageSetup - the filename to read the page setup from + the filename to read the page setup from - - Desrialize a page setup from an a{sv} variant in + + Desrialize a page setup from an a{sv} variant in the format produced by gtk_page_setup_to_gvariant(). - a new #GtkPageSetup object + a new #GtkPageSetup object - an a{sv} #GVariant + an a{sv} #GVariant - - Reads the page setup from the group @group_name in the key file + + Reads the page setup from the group @group_name in the key file @key_file. Returns a new #GtkPageSetup object with the restored page setup, or %NULL if an error occurred. - the restored #GtkPageSetup + the restored #GtkPageSetup - the #GKeyFile to retrieve the page_setup from + the #GKeyFile to retrieve the page_setup from - - the name of the group in the key_file to read, or %NULL - to use the default name “Page Setup” + + the name of the group in the key_file to read, or %NULL + to use the default name “Page Setup” - Copies a #GtkPageSetup. + Copies a #GtkPageSetup. - a copy of @other + a copy of @other - the #GtkPageSetup to copy + the #GtkPageSetup to copy - - Gets the bottom margin in units of @unit. + + Gets the bottom margin in units of @unit. - the bottom margin + the bottom margin - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Gets the left margin in units of @unit. + + Gets the left margin in units of @unit. - the left margin + the left margin - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Gets the page orientation of the #GtkPageSetup. + + Gets the page orientation of the #GtkPageSetup. - the page orientation + the page orientation - a #GtkPageSetup + a #GtkPageSetup - - Returns the page height in units of @unit. + + Returns the page height in units of @unit. Note that this function takes orientation and margins into consideration. See gtk_page_setup_get_paper_height(). - the page height. + the page height. - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Returns the page width in units of @unit. + + Returns the page width in units of @unit. Note that this function takes orientation and margins into consideration. See gtk_page_setup_get_paper_width(). - the page width. + the page width. - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Returns the paper height in units of @unit. + + Returns the paper height in units of @unit. Note that this function takes orientation, but not margins into consideration. See gtk_page_setup_get_page_height(). - the paper height. + the paper height. - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Gets the paper size of the #GtkPageSetup. + + Gets the paper size of the #GtkPageSetup. - the paper size + the paper size - a #GtkPageSetup + a #GtkPageSetup - - Returns the paper width in units of @unit. + + Returns the paper width in units of @unit. Note that this function takes orientation, but not margins into consideration. See gtk_page_setup_get_page_width(). - the paper width. + the paper width. - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Gets the right margin in units of @unit. + + Gets the right margin in units of @unit. - the right margin + the right margin - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Gets the top margin in units of @unit. + + Gets the top margin in units of @unit. - the top margin + the top margin - a #GtkPageSetup + a #GtkPageSetup - the unit for the return value + the unit for the return value - - Reads the page setup from the file @file_name. + + Reads the page setup from the file @file_name. See gtk_page_setup_to_file(). - %TRUE on success + %TRUE on success - a #GtkPageSetup + a #GtkPageSetup - the filename to read the page setup from + the filename to read the page setup from - - Reads the page setup from the group @group_name in the key file + + Reads the page setup from the group @group_name in the key file @key_file. - %TRUE on success + %TRUE on success - a #GtkPageSetup + a #GtkPageSetup - the #GKeyFile to retrieve the page_setup from + the #GKeyFile to retrieve the page_setup from - - the name of the group in the key_file to read, or %NULL - to use the default name “Page Setup” + + the name of the group in the key_file to read, or %NULL + to use the default name “Page Setup” - - Sets the bottom margin of the #GtkPageSetup. + + Sets the bottom margin of the #GtkPageSetup. - a #GtkPageSetup + a #GtkPageSetup - the new bottom margin in units of @unit + the new bottom margin in units of @unit - the units for @margin + the units for @margin - - Sets the left margin of the #GtkPageSetup. + + Sets the left margin of the #GtkPageSetup. - a #GtkPageSetup + a #GtkPageSetup - the new left margin in units of @unit + the new left margin in units of @unit - the units for @margin + the units for @margin - - Sets the page orientation of the #GtkPageSetup. + + Sets the page orientation of the #GtkPageSetup. - a #GtkPageSetup + a #GtkPageSetup - a #GtkPageOrientation value + a #GtkPageOrientation value - - Sets the paper size of the #GtkPageSetup without + + Sets the paper size of the #GtkPageSetup without changing the margins. See gtk_page_setup_set_paper_size_and_default_margins(). @@ -105703,25 +75859,17 @@ gtk_page_setup_set_paper_size_and_default_margins(). - a #GtkPageSetup + a #GtkPageSetup - a #GtkPaperSize + a #GtkPaperSize - - Sets the paper size of the #GtkPageSetup and modifies + + Sets the paper size of the #GtkPageSetup and modifies the margins according to the new paper size. @@ -105729,172 +75877,114 @@ the margins according to the new paper size. - a #GtkPageSetup + a #GtkPageSetup - a #GtkPaperSize + a #GtkPaperSize - - Sets the right margin of the #GtkPageSetup. + + Sets the right margin of the #GtkPageSetup. - a #GtkPageSetup + a #GtkPageSetup - the new right margin in units of @unit + the new right margin in units of @unit - the units for @margin + the units for @margin - - Sets the top margin of the #GtkPageSetup. + + Sets the top margin of the #GtkPageSetup. - a #GtkPageSetup + a #GtkPageSetup - the new top margin in units of @unit + the new top margin in units of @unit - the units for @margin + the units for @margin - - This function saves the information from @setup to @file_name. + + This function saves the information from @setup to @file_name. - %TRUE on success + %TRUE on success - a #GtkPageSetup + a #GtkPageSetup - the file to save to + the file to save to - - Serialize page setup to an a{sv} variant. + + Serialize page setup to an a{sv} variant. - a new, floating, #GVariant + a new, floating, #GVariant - a #GtkPageSetup + a #GtkPageSetup - - This function adds the page setup from @setup to @key_file. + + This function adds the page setup from @setup to @key_file. - a #GtkPageSetup + a #GtkPageSetup - the #GKeyFile to save the page setup to + the #GKeyFile to save the page setup to - - the group to add the settings to in @key_file, - or %NULL to use the default name “Page Setup” + + the group to add the settings to in @key_file, + or %NULL to use the default name “Page Setup” - The type of function that is passed to + The type of function that is passed to gtk_print_run_page_setup_dialog_async(). This function will be called when the page setup dialog @@ -105905,75 +75995,33 @@ is dismissed, and also serves as destroy notify for @data. - the #GtkPageSetup that has been + the #GtkPageSetup that has been - - user data that has been passed to + + user data that has been passed to gtk_print_run_page_setup_dialog_async() - - Describes the panning direction of a #GtkGesturePan - - panned towards the left + + Describes the panning direction of a #GtkGesturePan + + panned towards the left - - panned towards the right + + panned towards the right - - panned upwards + + panned upwards - - panned downwards + + panned downwards - - #GtkPaned has two panes, arranged either + + #GtkPaned has two panes, arranged either horizontally or vertically. The division between the two panes is adjustable by the user by dragging a handle. @@ -106007,9 +76055,9 @@ by the user, by calling gtk_paned_set_position(). |[<!-- language="plain" --> paned -├── <child> -├── separator[.wide] -╰── <child> +├── <child> +├── separator[.wide] +╰── <child> ]| GtkPaned has a main CSS node with name paned, and a subnode for @@ -106042,21 +76090,15 @@ gtk_widget_set_size_request (frame2, 50, -1); - Creates a new #GtkPaned widget. + Creates a new #GtkPaned widget. - a new #GtkPaned. + a new #GtkPaned. - the paned’s orientation. + the paned’s orientation. @@ -106137,9 +76179,7 @@ gtk_widget_set_size_request (frame2, 50, -1); - Adds a child to the top or left pane with default parameters. This is + Adds a child to the top or left pane with default parameters. This is equivalent to `gtk_paned_pack1 (paned, child, FALSE, TRUE)`. @@ -106148,23 +76188,17 @@ equivalent to - a paned widget + a paned widget - the child to add + the child to add - Adds a child to the bottom or right pane with default parameters. This + Adds a child to the bottom or right pane with default parameters. This is equivalent to `gtk_paned_pack2 (paned, child, TRUE, TRUE)`. @@ -106173,261 +76207,181 @@ is equivalent to - a paned widget + a paned widget - the child to add + the child to add - - Obtains the first child of the paned widget. + + Obtains the first child of the paned widget. - first child, or %NULL if it is not set. + first child, or %NULL if it is not set. - a #GtkPaned widget + a #GtkPaned widget - - Obtains the second child of the paned widget. + + Obtains the second child of the paned widget. - second child, or %NULL if it is not set. + second child, or %NULL if it is not set. - a #GtkPaned widget + a #GtkPaned widget - - Returns the #GdkWindow of the handle. This function is + + Returns the #GdkWindow of the handle. This function is useful when handling button or motion events because it enables the callback to distinguish between the window of the paned, a child and the handle. - the paned’s handle window. + the paned’s handle window. - a #GtkPaned + a #GtkPaned - Obtains the position of the divider between the two panes. + Obtains the position of the divider between the two panes. - position of the divider + position of the divider - a #GtkPaned widget + a #GtkPaned widget - - Gets the #GtkPaned:wide-handle property. + + Gets the #GtkPaned:wide-handle property. - %TRUE if the paned should have a wide handle + %TRUE if the paned should have a wide handle - a #GtkPaned + a #GtkPaned - Adds a child to the top or left pane. + Adds a child to the top or left pane. - a paned widget + a paned widget - the child to add + the child to add - should this child expand when the paned widget is resized. + should this child expand when the paned widget is resized. - can this child be made smaller than its requisition. + can this child be made smaller than its requisition. - Adds a child to the bottom or right pane. + Adds a child to the bottom or right pane. - a paned widget + a paned widget - the child to add + the child to add - should this child expand when the paned widget is resized. + should this child expand when the paned widget is resized. - can this child be made smaller than its requisition. + can this child be made smaller than its requisition. - Sets the position of the divider between the two panes. + Sets the position of the divider between the two panes. - a #GtkPaned widget + a #GtkPaned widget - pixel position of divider, a negative value means that the position + pixel position of divider, a negative value means that the position is unset. - - Sets the #GtkPaned:wide-handle property. + + Sets the #GtkPaned:wide-handle property. - a #GtkPaned + a #GtkPaned - the new value for the #GtkPaned:wide-handle property + the new value for the #GtkPaned:wide-handle property - The largest possible value for the position property. + The largest possible value for the position property. This property is derived from the size and shrinkability of the widget's children. - The smallest possible value for the position property. + The smallest possible value for the position property. This property is derived from the size and shrinkability of the widget's children. @@ -106438,13 +76392,8 @@ of the widget's children. - - Setting this property to %TRUE indicates that the paned needs + + Setting this property to %TRUE indicates that the paned needs to provide stronger visual separation (e.g. because it separates between two notebooks, whose tab rows would otherwise merge visually). @@ -106456,9 +76405,7 @@ between two notebooks, whose tab rows would otherwise merge visually). - The ::accept-position signal is a + The ::accept-position signal is a [keybinding signal][GtkBindingSignal] which gets emitted to accept the current position of the handle when moving it using key bindings. @@ -106469,9 +76416,7 @@ The default binding for this signal is Return or Space. - The ::cancel-position signal is a + The ::cancel-position signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cancel moving the position of the handle using key bindings. The position of the handle will be reset to the value prior to @@ -106482,13 +76427,8 @@ The default binding for this signal is Escape. - - The ::cycle-child-focus signal is a + + The ::cycle-child-focus signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cycle the focus between the children of the paned. @@ -106498,20 +76438,13 @@ The default binding is f6. - whether cycling backward or forward + whether cycling backward or forward - - The ::cycle-handle-focus signal is a + + The ::cycle-handle-focus signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings. @@ -106522,17 +76455,13 @@ The default binding for this signal is f8. - whether cycling backward or forward + whether cycling backward or forward - The ::move-handle signal is a + The ::move-handle signal is a [keybinding signal][GtkBindingSignal] which gets emitted to move the handle when the user is using key bindings to move it. @@ -106541,20 +76470,13 @@ to move it. - a #GtkScrollType + a #GtkScrollType - - The ::toggle-handle-focus is a + + The ::toggle-handle-focus is a [keybinding signal][GtkBindingSignal] which gets emitted to accept the current position of the handle and then move focus to the next widget in the focus chain. @@ -106565,13 +76487,7 @@ The default binding is Tab. - + @@ -106579,27 +76495,19 @@ The default binding is Tab. - + - + - + - + - + @@ -106727,14 +76635,8 @@ The default binding is Tab. - - GtkPaperSize handles paper sizes. It uses the standard called + + GtkPaperSize handles paper sizes. It uses the standard called [PWG 5101.1-2002 PWG: Standard for Media Standardized Names](http://www.pwg.org/standards.html) to name the paper sizes (and to get the data for the page sizes). In addition to standard paper sizes, GtkPaperSize allows to @@ -106747,9 +76649,7 @@ default [print margins][print-margins]. Printing support has been added in GTK+ 2.10. - Creates a new #GtkPaperSize object by parsing a + Creates a new #GtkPaperSize object by parsing a [PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf) paper name. @@ -106757,101 +76657,66 @@ If @name is %NULL, the default paper size is returned, see gtk_paper_size_get_default(). - a new #GtkPaperSize, use gtk_paper_size_free() + a new #GtkPaperSize, use gtk_paper_size_free() to free it - - a paper size name, or %NULL + + a paper size name, or %NULL - - Creates a new #GtkPaperSize object with the + + Creates a new #GtkPaperSize object with the given parameters. - a new #GtkPaperSize object, use gtk_paper_size_free() + a new #GtkPaperSize object, use gtk_paper_size_free() to free it - the paper name + the paper name - the human-readable name + the human-readable name - the paper width, in units of @unit + the paper width, in units of @unit - the paper height, in units of @unit + the paper height, in units of @unit - the unit for @width and @height. not %GTK_UNIT_NONE. + the unit for @width and @height. not %GTK_UNIT_NONE. - - Deserialize a paper size from an a{sv} variant in + + Deserialize a paper size from an a{sv} variant in the format produced by gtk_paper_size_to_gvariant(). - a new #GtkPaperSize object + a new #GtkPaperSize object - an a{sv} #GVariant + an a{sv} #GVariant - - Creates a new #GtkPaperSize object by using + + Creates a new #GtkPaperSize object by using IPP information. If @ipp_name is not a recognized paper name, @@ -106859,74 +76724,48 @@ If @ipp_name is not a recognized paper name, construct a custom #GtkPaperSize object. - a new #GtkPaperSize, use gtk_paper_size_free() + a new #GtkPaperSize, use gtk_paper_size_free() to free it - an IPP paper name + an IPP paper name - the paper width, in points + the paper width, in points - the paper height in points + the paper height in points - - Reads a paper size from the group @group_name in the key file + + Reads a paper size from the group @group_name in the key file @key_file. - a new #GtkPaperSize object with the restored + a new #GtkPaperSize object with the restored paper size, or %NULL if an error occurred - the #GKeyFile to retrieve the papersize from + the #GKeyFile to retrieve the papersize from - - the name of the group in the key file to read, + + the name of the group in the key file to read, or %NULL to read the first group - - Creates a new #GtkPaperSize object by using + + Creates a new #GtkPaperSize object by using PPD information. If @ppd_name is not a recognized PPD paper name, @@ -106934,499 +76773,331 @@ If @ppd_name is not a recognized PPD paper name, construct a custom #GtkPaperSize object. - a new #GtkPaperSize, use gtk_paper_size_free() + a new #GtkPaperSize, use gtk_paper_size_free() to free it - a PPD paper name + a PPD paper name - the corresponding human-readable name + the corresponding human-readable name - the paper width, in points + the paper width, in points - the paper height in points + the paper height in points - Copies an existing #GtkPaperSize. + Copies an existing #GtkPaperSize. - a copy of @other + a copy of @other - a #GtkPaperSize + a #GtkPaperSize - Free the given #GtkPaperSize object. + Free the given #GtkPaperSize object. - a #GtkPaperSize + a #GtkPaperSize - - Gets the default bottom margin for the #GtkPaperSize. + + Gets the default bottom margin for the #GtkPaperSize. - the default bottom margin + the default bottom margin - a #GtkPaperSize object + a #GtkPaperSize object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - - Gets the default left margin for the #GtkPaperSize. + + Gets the default left margin for the #GtkPaperSize. - the default left margin + the default left margin - a #GtkPaperSize object + a #GtkPaperSize object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - - Gets the default right margin for the #GtkPaperSize. + + Gets the default right margin for the #GtkPaperSize. - the default right margin + the default right margin - a #GtkPaperSize object + a #GtkPaperSize object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - - Gets the default top margin for the #GtkPaperSize. + + Gets the default top margin for the #GtkPaperSize. - the default top margin + the default top margin - a #GtkPaperSize object + a #GtkPaperSize object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - - Gets the human-readable name of the #GtkPaperSize. + + Gets the human-readable name of the #GtkPaperSize. - the human-readable name of @size + the human-readable name of @size - a #GtkPaperSize object + a #GtkPaperSize object - - Gets the paper height of the #GtkPaperSize, in + + Gets the paper height of the #GtkPaperSize, in units of @unit. - the paper height + the paper height - a #GtkPaperSize object + a #GtkPaperSize object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - - Gets the name of the #GtkPaperSize. + + Gets the name of the #GtkPaperSize. - the name of @size + the name of @size - a #GtkPaperSize object + a #GtkPaperSize object - - Gets the PPD name of the #GtkPaperSize, which + + Gets the PPD name of the #GtkPaperSize, which may be %NULL. - the PPD name of @size + the PPD name of @size - a #GtkPaperSize object + a #GtkPaperSize object - - Gets the paper width of the #GtkPaperSize, in + + Gets the paper width of the #GtkPaperSize, in units of @unit. - the paper width + the paper width - a #GtkPaperSize object + a #GtkPaperSize object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Returns %TRUE if @size is not a standard paper size. + Returns %TRUE if @size is not a standard paper size. - whether @size is a custom paper size. + whether @size is a custom paper size. - a #GtkPaperSize object + a #GtkPaperSize object - - Compares two #GtkPaperSize objects. + + Compares two #GtkPaperSize objects. - %TRUE, if @size1 and @size2 + %TRUE, if @size1 and @size2 represent the same paper size - a #GtkPaperSize object + a #GtkPaperSize object - another #GtkPaperSize object + another #GtkPaperSize object - Returns %TRUE if @size is an IPP standard paper size. + Returns %TRUE if @size is an IPP standard paper size. - whether @size is not an IPP custom paper size. + whether @size is not an IPP custom paper size. - a #GtkPaperSize object + a #GtkPaperSize object - - Changes the dimensions of a @size to @width x @height. + + Changes the dimensions of a @size to @width x @height. - a custom #GtkPaperSize object + a custom #GtkPaperSize object - the new width in units of @unit + the new width in units of @unit - the new height in units of @unit + the new height in units of @unit - the unit for @width and @height + the unit for @width and @height - - Serialize a paper size to an a{sv} variant. + + Serialize a paper size to an a{sv} variant. - a new, floating, #GVariant + a new, floating, #GVariant - a #GtkPaperSize + a #GtkPaperSize - - This function adds the paper size from @size to @key_file. + + This function adds the paper size from @size to @key_file. - a #GtkPaperSize + a #GtkPaperSize - the #GKeyFile to save the paper size to + the #GKeyFile to save the paper size to - the group to add the settings to in @key_file + the group to add the settings to in @key_file - - Returns the name of the default paper size, which + + Returns the name of the default paper size, which depends on the current locale. - the name of the default paper size. The string + the name of the default paper size. The string is owned by GTK+ and should not be modified. - - Creates a list of known paper sizes. + + Creates a list of known paper sizes. - a newly allocated list of newly + a newly allocated list of newly allocated #GtkPaperSize objects @@ -107434,116 +77105,50 @@ is owned by GTK+ and should not be modified. - whether to include custom paper sizes + whether to include custom paper sizes as defined in the page setup dialog - - Priorities for path lookups. + + Priorities for path lookups. See also gtk_binding_set_add_path(). - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Widget path types. + + Widget path types. See also gtk_binding_set_add_path(). - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - These flags serve two purposes. First, the application can call gtk_places_sidebar_set_open_flags() + + These flags serve two purposes. First, the application can call gtk_places_sidebar_set_open_flags() using these flags as a bitmask. This tells the sidebar that the application is able to open folders selected from the sidebar in various ways, for example, in new tabs or in new windows in addition to the normal mode. @@ -107557,48 +77162,25 @@ based on the modifier keys that the user is pressing at the time the selection i If the application never calls gtk_places_sidebar_set_open_flags(), then the sidebar will only use #GTK_PLACES_OPEN_NORMAL in the #GtkPlacesSidebar::open-location signal. This is the default mode of operation. - - This is the default mode that #GtkPlacesSidebar uses if no other flags + + This is the default mode that #GtkPlacesSidebar uses if no other flags are specified. It indicates that the calling application should open the selected location in the normal way, for example, in the folder view beside the sidebar. - - When passed to gtk_places_sidebar_set_open_flags(), this indicates + + When passed to gtk_places_sidebar_set_open_flags(), this indicates that the application can open folders selected from the sidebar in new tabs. This value will be passed to the #GtkPlacesSidebar::open-location signal when the user selects that a location be opened in a new tab instead of in the standard fashion. - - Similar to @GTK_PLACES_OPEN_NEW_TAB, but indicates that the application + + Similar to @GTK_PLACES_OPEN_NEW_TAB, but indicates that the application can open folders in new windows. - - #GtkPlacesSidebar is a widget that displays a list of frequently-used places in the -file system: the user’s home directory, the user’s bookmarks, and volumes and drives. + + #GtkPlacesSidebar is a widget that displays a list of frequently-used places in the +file system: the user’s home directory, the user’s bookmarks, and volumes and drives. This widget is used as a sidebar in #GtkFileChooser and may be used by file managers and similar programs. @@ -107633,88 +77215,62 @@ be used: - - Creates a new #GtkPlacesSidebar widget. + + Creates a new #GtkPlacesSidebar widget. The application should connect to at least the #GtkPlacesSidebar::open-location signal to be notified when the user makes a selection in the sidebar. - a newly created #GtkPlacesSidebar + a newly created #GtkPlacesSidebar - - Applications may want to present some folders in the places sidebar if + + Applications may want to present some folders in the places sidebar if they could be immediately useful to users. For example, a drawing -program could add a “/usr/share/clipart” location when the sidebar is -being used in an “Insert Clipart” dialog box. +program could add a “/usr/share/clipart” location when the sidebar is +being used in an “Insert Clipart” dialog box. This function adds the specified @location to a special place for immutable shortcuts. The shortcuts are application-specific; they are not shared across applications, and they are not persistent. If this function is called multiple times with different locations, then they are added -to the sidebar’s list in the same order as the function is called. +to the sidebar’s list in the same order as the function is called. - a places sidebar + a places sidebar - location to add as an application-specific shortcut + location to add as an application-specific shortcut - - Returns the value previously set with gtk_places_sidebar_set_local_only(). + + Returns the value previously set with gtk_places_sidebar_set_local_only(). - %TRUE if the sidebar will only show local files. + %TRUE if the sidebar will only show local files. - a places sidebar + a places sidebar - - Gets the currently selected location in the @sidebar. This can be %NULL when + + Gets the currently selected location in the @sidebar. This can be %NULL when nothing is selected, for example, when gtk_places_sidebar_set_location() has -been called with a location that is not among the sidebar’s list of places to +been called with a location that is not among the sidebar’s list of places to show. You can use this function to get the selection in the @sidebar. Also, if you @@ -107723,243 +77279,158 @@ function to get the location that is being referred to during the callbacks for your menu items. - a #GFile with the selected location, or + a #GFile with the selected location, or %NULL if nothing is visually selected. - a places sidebar + a places sidebar - - This function queries the bookmarks added by the user to the places sidebar, + + This function queries the bookmarks added by the user to the places sidebar, and returns one of them. This function is used by #GtkFileChooser to implement -the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark. +the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark. - The bookmark specified by the index @n, or + The bookmark specified by the index @n, or %NULL if no such index exist. Note that the indices start at 0, even though the file chooser starts them with the keyboard shortcut "Alt-1". - a places sidebar + a places sidebar - index of the bookmark to query + index of the bookmark to query - - Gets the open flags. + + Gets the open flags. - the #GtkPlacesOpenFlags of @sidebar + the #GtkPlacesOpenFlags of @sidebar - a #GtkPlacesSidebar + a #GtkPlacesSidebar - - Returns the value previously set with gtk_places_sidebar_set_show_connect_to_server() + + Returns the value previously set with gtk_places_sidebar_set_show_connect_to_server() It is recommended to group this functionality with the drives and network location under the new 'Other Location' item - %TRUE if the sidebar will display a “Connect to Server” item. + %TRUE if the sidebar will display a “Connect to Server” item. - a places sidebar + a places sidebar - - Returns the value previously set with gtk_places_sidebar_set_show_desktop() + + Returns the value previously set with gtk_places_sidebar_set_show_desktop() - %TRUE if the sidebar will display a builtin shortcut to the desktop folder. + %TRUE if the sidebar will display a builtin shortcut to the desktop folder. - a places sidebar + a places sidebar - - Returns the value previously set with gtk_places_sidebar_set_show_enter_location() + + Returns the value previously set with gtk_places_sidebar_set_show_enter_location() - %TRUE if the sidebar will display an “Enter Location” item. + %TRUE if the sidebar will display an “Enter Location” item. - a places sidebar + a places sidebar - - Returns the value previously set with gtk_places_sidebar_set_show_other_locations() + + Returns the value previously set with gtk_places_sidebar_set_show_other_locations() - %TRUE if the sidebar will display an “Other Locations” item. + %TRUE if the sidebar will display an “Other Locations” item. - a places sidebar + a places sidebar - - Returns the value previously set with gtk_places_sidebar_set_show_recent() + + Returns the value previously set with gtk_places_sidebar_set_show_recent() - %TRUE if the sidebar will display a builtin shortcut for recent files + %TRUE if the sidebar will display a builtin shortcut for recent files - a places sidebar + a places sidebar - - Returns the value previously set with gtk_places_sidebar_set_show_starred_location() + + Returns the value previously set with gtk_places_sidebar_set_show_starred_location() - %TRUE if the sidebar will display a Starred item. + %TRUE if the sidebar will display a Starred item. - a places sidebar + a places sidebar - - Returns the value previously set with gtk_places_sidebar_set_show_trash() + + Returns the value previously set with gtk_places_sidebar_set_show_trash() - %TRUE if the sidebar will display a “Trash” item. + %TRUE if the sidebar will display a “Trash” item. - a places sidebar + a places sidebar - - Gets the list of shortcuts. + + Gets the list of shortcuts. - + A #GSList of #GFile of the locations that have been added as application-specific shortcuts with gtk_places_sidebar_add_shortcut(). To free this list, you can use @@ -107972,19 +77443,13 @@ g_slist_free_full (list, (GDestroyNotify) g_object_unref); - a places sidebar + a places sidebar - - Removes an application-specific shortcut that has been previously been + + Removes an application-specific shortcut that has been previously been inserted with gtk_places_sidebar_add_shortcut(). If the @location is not a shortcut in the sidebar, then nothing is done. @@ -107993,25 +77458,17 @@ shortcut in the sidebar, then nothing is done. - a places sidebar + a places sidebar - location to remove + location to remove - - Make the GtkPlacesSidebar show drop targets, so it can show the available + + Make the GtkPlacesSidebar show drop targets, so it can show the available drop targets and a "new bookmark" row. This improves the Drag-and-Drop experience of the user and allows applications to show all available drop targets at once. @@ -108026,57 +77483,39 @@ to unset the state when the drag ends on some other widget on your application.< - a places sidebar. + a places sidebar. - whether to show the valid targets or not. + whether to show the valid targets or not. - drag context used to ask the source about the action that wants to + drag context used to ask the source about the action that wants to perform, so hints are more accurate. - - Sets whether the @sidebar should only show local files. + + Sets whether the @sidebar should only show local files. - a places sidebar + a places sidebar - whether to show only local files + whether to show only local files - - Sets the location that is being shown in the widgets surrounding the + + Sets the location that is being shown in the widgets surrounding the @sidebar, for example, in a folder view in a file manager. In turn, the @sidebar will highlight that location if it is being shown in the list of places, or it will unhighlight everything if the @location is not among the @@ -108087,69 +77526,48 @@ places in the list. - a places sidebar + a places sidebar - - location to select, or %NULL for no current path + + location to select, or %NULL for no current path - - Sets the way in which the calling application can open new locations from + + Sets the way in which the calling application can open new locations from the places sidebar. For example, some applications only open locations -“directly” into their main view, while others may support opening locations +“directly” into their main view, while others may support opening locations in a new notebook tab or a new window. This function is used to tell the places @sidebar about the ways in which the application can open new locations, so that the sidebar can display (or not) -the “Open in new tab” and “Open in new window” menu items as appropriate. +the “Open in new tab” and “Open in new window” menu items as appropriate. When the #GtkPlacesSidebar::open-location signal is emitted, its flags argument will be set to one of the @flags that was passed in gtk_places_sidebar_set_open_flags(). Passing 0 for @flags will cause #GTK_PLACES_OPEN_NORMAL to always be sent -to callbacks for the “open-location” signal. +to callbacks for the “open-location” signal. - a places sidebar + a places sidebar - Bitmask of modes in which the calling application can open locations + Bitmask of modes in which the calling application can open locations - - Sets whether the @sidebar should show an item for connecting to a network server; + + Sets whether the @sidebar should show an item for connecting to a network server; this is off by default. An application may want to turn this on if it implements a way for the user to connect to network servers directly. @@ -108163,27 +77581,19 @@ If you enable this, you should connect to the - a places sidebar + a places sidebar - whether to show an item for the Connect to Server command + whether to show an item for the Connect to Server command - - Sets whether the @sidebar should show an item for the Desktop folder. + + Sets whether the @sidebar should show an item for the Desktop folder. The default value for this option is determined by the desktop -environment and the user’s configuration, but this function can be +environment and the user’s configuration, but this function can be used to override it on a per-application basis. @@ -108191,25 +77601,17 @@ used to override it on a per-application basis. - a places sidebar + a places sidebar - whether to show an item for the Desktop folder + whether to show an item for the Desktop folder - - Sets whether the @sidebar should show an item for entering a location; + + Sets whether the @sidebar should show an item for entering a location; this is off by default. An application may want to turn this on if manually entering URLs is an expected user action. @@ -108221,25 +77623,17 @@ If you enable this, you should connect to the - a places sidebar + a places sidebar - whether to show an item to enter a location + whether to show an item to enter a location - - Sets whether the @sidebar should show an item for the application to show + + Sets whether the @sidebar should show an item for the application to show an Other Locations view; this is off by default. When set to %TRUE, persistent devices such as hard drives are hidden, otherwise they are shown in the sidebar. An application may want to turn this on if it implements a way for the user to @@ -108253,25 +77647,17 @@ If you enable this, you should connect to the - a places sidebar + a places sidebar - whether to show an item for the Other Locations view + whether to show an item for the Other Locations view - - Sets whether the @sidebar should show an item for recent files. + + Sets whether the @sidebar should show an item for recent files. The default value for this option is determined by the desktop environment, but this function can be used to override it on a per-application basis. @@ -108281,25 +77667,17 @@ per-application basis. - a places sidebar + a places sidebar - whether to show an item for recent files + whether to show an item for recent files - - If you enable this, you should connect to the + + If you enable this, you should connect to the #GtkPlacesSidebar::show-starred-location signal. @@ -108307,40 +77685,28 @@ per-application basis. - a places sidebar + a places sidebar - whether to show an item for Starred files + whether to show an item for Starred files - - Sets whether the @sidebar should show an item for the Trash location. + + Sets whether the @sidebar should show an item for the Trash location. - a places sidebar + a places sidebar - whether to show an item for the Trash location + whether to show an item for the Trash location @@ -108354,70 +77720,49 @@ per-application basis. - - If :populate-all is %TRUE, the #GtkPlacesSidebar::populate-popup signal + + If :populate-all is %TRUE, the #GtkPlacesSidebar::populate-popup signal is also emitted for popovers. - + - + - + - + - The places sidebar emits this signal when it needs to ask the application + The places sidebar emits this signal when it needs to ask the application to pop up a menu to ask the user for which drag action to perform. - the final drag action that the sidebar should pass to the drag side + the final drag action that the sidebar should pass to the drag side of the drag-and-drop operation. - Possible drag actions that need to be asked for. + Possible drag actions that need to be asked for. - When the user starts a drag-and-drop operation and the sidebar needs + When the user starts a drag-and-drop operation and the sidebar needs to ask the application for which drag action to perform, then the sidebar will emit this signal. @@ -108427,30 +77772,22 @@ possible actions for the destination @dest_file. The drag action to use must be the return value of the signal handler. - The drag action to use, for example, #GDK_ACTION_COPY + The drag action to use, for example, #GDK_ACTION_COPY or #GDK_ACTION_MOVE, or 0 if no action is allowed here (i.e. drops are not allowed in the specified @dest_file). - #GdkDragContext with information about the drag operation + #GdkDragContext with information about the drag operation - #GFile with the tentative location that is being hovered for a drop + #GFile with the tentative location that is being hovered for a drop - + List of #GFile that are being dragged @@ -108459,9 +77796,7 @@ are not allowed in the specified @dest_file). - The places sidebar emits this signal when the user completes a + The places sidebar emits this signal when the user completes a drag-and-drop operation and one of the sidebar's items is the destination. This item is in the @dest_file, and the @source_file_list has the list of files that are dropped into it and @@ -108471,32 +77806,24 @@ which should be copied/moved/etc. based on the specified @action. - Destination #GFile. + Destination #GFile. - + #GList of #GFile that got dropped. - Drop action to perform. + Drop action to perform. - The places sidebar emits this signal when it starts a new operation + The places sidebar emits this signal when it starts a new operation because the user clicked on some location that needs mounting. In this way the application using the #GtkPlacesSidebar can track the progress of the operation and, for example, show a notification. @@ -108505,17 +77832,13 @@ progress of the operation and, for example, show a notification. - the #GMountOperation that is going to start. + the #GMountOperation that is going to start. - The places sidebar emits this signal when the user selects a location + The places sidebar emits this signal when the user selects a location in it. The calling application should display the contents of that location; for example, a file manager should show a list of files in the specified location. @@ -108524,23 +77847,17 @@ the specified location. - #GFile to which the caller should switch. + #GFile to which the caller should switch. - a single value from #GtkPlacesOpenFlags specifying how the @location should be opened. + a single value from #GtkPlacesOpenFlags specifying how the @location should be opened. - The places sidebar emits this signal when the user invokes a contextual + The places sidebar emits this signal when the user invokes a contextual popup on one of its items. In the signal handler, the application may add extra items to the menu as appropriate. For example, a file manager may want to add a "Properties" command to the menu. @@ -108570,40 +77887,23 @@ that this signal is emitted for populating popovers as well. - a #GtkMenu or another #GtkContainer + a #GtkMenu or another #GtkContainer - - #GFile with the item to which + + #GFile with the item to which the popup should refer, or %NULL in the case of a @selected_volume. - - #GVolume if the selected + + #GVolume if the selected item is a volume, or %NULL if it is a file. - - The places sidebar emits this signal when it needs the calling + + The places sidebar emits this signal when it needs the calling application to present an way to connect directly to a network server. For example, the application may bring up a dialog box asking for a URL like "sftp://ftp.example.com". It is up to the application to create @@ -108615,9 +77915,7 @@ the corresponding mount by using, for example, g_file_mount_enclosing_volume().< - The places sidebar emits this signal when it needs the calling + The places sidebar emits this signal when it needs the calling application to present an way to directly enter a location. For example, the application may bring up a dialog box asking for a URL like "http://http.example.com". @@ -108626,9 +77924,7 @@ a URL like "http://http.example.com". - The places sidebar emits this signal when it needs the calling + The places sidebar emits this signal when it needs the calling application to present an error message. Most of these messages refer to mounting or unmounting media, for example, when a drive cannot be started for some reason. @@ -108637,27 +77933,17 @@ cannot be started for some reason. - primary message with a summary of the error to show. + primary message with a summary of the error to show. - secondary message with details of the error to show. + secondary message with details of the error to show. - - The places sidebar emits this signal when it needs the calling + + The places sidebar emits this signal when it needs the calling application to present a way to show other locations e.g. drives and network access points. For example, the application may bring up a page showing persistent @@ -108669,12 +77955,8 @@ in a new tab or window, in a similar way than #GtkPlacesSidebar::open-location - - The places sidebar emits this signal when it needs the calling + + The places sidebar emits this signal when it needs the calling application to present a way to show other locations e.g. drives and network access points. For example, the application may bring up a page showing persistent @@ -108684,17 +77966,13 @@ volumes and discovered network addresses. - a single value from #GtkPlacesOpenFlags specifying how it should be opened. + a single value from #GtkPlacesOpenFlags specifying how it should be opened. - The places sidebar emits this signal when it needs the calling + The places sidebar emits this signal when it needs the calling application to present a way to show the starred files. In GNOME, starred files are implemented by setting the nao:predefined-tag-favorite tag in the tracker database. @@ -108703,18 +77981,14 @@ tag in the tracker database. - a single value from #GtkPlacesOpenFlags specifying how the + a single value from #GtkPlacesOpenFlags specifying how the starred file should be opened. - The places sidebar emits this signal when it starts a new operation + The places sidebar emits this signal when it starts a new operation because the user for example ejected some drive or unmounted a mount. In this way the application using the #GtkPlacesSidebar can track the progress of the operation and, for example, show a notification. @@ -108723,36 +77997,23 @@ progress of the operation and, for example, show a notification. - the #GMountOperation that is going to start. + the #GMountOperation that is going to start. - + - - Together with #GtkSocket, #GtkPlug provides the ability to embed + + Together with #GtkSocket, #GtkPlug provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a #GtkSocket widget -and passes the ID of that widget’s window to the other process, +and passes the ID of that widget’s window to the other process, which then creates a #GtkPlug with that window ID. Any widgets contained in the #GtkPlug then will appear inside the first -application’s window. +application’s window. The communication between a #GtkSocket and a #GtkPlug follows the [XEmbed Protocol](http://www.freedesktop.org/Standards/xembed-spec). @@ -108768,51 +78029,35 @@ They can only be used on a #GdkX11Display. To use #GtkPlug and - Creates a new plug widget inside the #GtkSocket identified -by @socket_id. If @socket_id is 0, the plug is left “unplugged” and + Creates a new plug widget inside the #GtkSocket identified +by @socket_id. If @socket_id is 0, the plug is left “unplugged” and can later be plugged into a #GtkSocket by gtk_socket_add_id(). - the new #GtkPlug widget. + the new #GtkPlug widget. - the window ID of the socket, or 0. + the window ID of the socket, or 0. - - Create a new plug widget inside the #GtkSocket identified by socket_id. + + Create a new plug widget inside the #GtkSocket identified by socket_id. - the new #GtkPlug widget. + the new #GtkPlug widget. - the #GdkDisplay on which @socket_id is displayed + the #GdkDisplay on which @socket_id is displayed - the XID of the socket’s window. + the XID of the socket’s window. @@ -108829,9 +78074,7 @@ can later be plugged into a #GtkSocket by gtk_socket_add_id(). - Finish the initialization of @plug for a given #GtkSocket identified by + Finish the initialization of @plug for a given #GtkSocket identified by @socket_id. This function will generally only be used by classes deriving from #GtkPlug. @@ -108839,25 +78082,17 @@ can later be plugged into a #GtkSocket by gtk_socket_add_id(). - a #GtkPlug. + a #GtkPlug. - the XID of the socket’s window. + the XID of the socket’s window. - - Finish the initialization of @plug for a given #GtkSocket identified by + + Finish the initialization of @plug for a given #GtkSocket identified by @socket_id which is currently displayed on @display. This function will generally only be used by classes deriving from #GtkPlug. @@ -108866,102 +78101,70 @@ This function will generally only be used by classes deriving from #GtkPlug. - a #GtkPlug. + a #GtkPlug. - the #GdkDisplay associated with @socket_id’s + the #GdkDisplay associated with @socket_id’s #GtkSocket. - the XID of the socket’s window. + the XID of the socket’s window. - - Determines whether the plug is embedded in a socket. + + Determines whether the plug is embedded in a socket. - %TRUE if the plug is embedded in a socket + %TRUE if the plug is embedded in a socket - a #GtkPlug + a #GtkPlug - Gets the window ID of a #GtkPlug widget, which can then + Gets the window ID of a #GtkPlug widget, which can then be used to embed this window inside another window, for instance with gtk_socket_add_id(). - the window ID for the plug + the window ID for the plug - a #GtkPlug. + a #GtkPlug. - - Retrieves the socket the plug is embedded in. + + Retrieves the socket the plug is embedded in. - the window of the socket, or %NULL + the window of the socket, or %NULL - a #GtkPlug + a #GtkPlug - %TRUE if the plug is embedded in a socket. + %TRUE if the plug is embedded in a socket. - The window of the socket the plug is embedded in. + The window of the socket the plug is embedded in. @@ -108971,21 +78174,13 @@ instance with gtk_socket_add_id(). - Gets emitted when the plug becomes embedded in a socket. + Gets emitted when the plug becomes embedded in a socket. - + @@ -109007,22 +78202,16 @@ instance with gtk_socket_add_id(). - + - + - + @@ -109076,63 +78265,29 @@ instance with gtk_socket_add_id(). - - Determines how the size should be computed to achieve the one of the + + Determines how the size should be computed to achieve the one of the visibility mode for the scrollbars. - - The scrollbar is always visible. The view size is + + The scrollbar is always visible. The view size is independent of the content. - - The scrollbar will appear and disappear as necessary. + + The scrollbar will appear and disappear as necessary. For example, when all of a #GtkTreeView can not be seen. - - The scrollbar should never appear. In this mode the + + The scrollbar should never appear. In this mode the content determines the size. - - Don't show a scrollbar, but don't force the + + Don't show a scrollbar, but don't force the size to follow the content. This can be used e.g. to make multiple scrolled windows share a scrollbar. Since: 3.16 - - GtkPopover is a bubble-like context window, primarily meant to + + GtkPopover is a bubble-like context window, primarily meant to provide context-dependent information or options. Popovers are attached to a widget, passed at construction time on gtk_popover_new(), or updated afterwards through gtk_popover_set_relative_to(), by @@ -109158,9 +78313,9 @@ model features, this function supports rendering sections in the model in a more compact form, as a row of icon buttons instead of menu items. -To use this rendering, set the ”display-hint” attribute of the -section to ”horizontal-buttons” and set the icons of your items -with the ”verb-icon” attribute. +To use this rendering, set the ”display-hint” attribute of the +section to ”horizontal-buttons” and set the icons of your items +with the ”verb-icon” attribute. |[ <section> @@ -109197,34 +78352,21 @@ plain popovers. - Creates a new popover to point to @relative_to + Creates a new popover to point to @relative_to - a new #GtkPopover + a new #GtkPopover - - #GtkWidget the popover is related to + + #GtkWidget the popover is related to - - Creates a #GtkPopover and populates it according to + + Creates a #GtkPopover and populates it according to @model. The popover is pointed to the @relative_to widget. The created buttons are connected to actions found in the @@ -109236,25 +78378,16 @@ Actions can also be added using gtk_widget_insert_action_group() on the menus attach widget or on any of its parent widgets. - the new #GtkPopover + the new #GtkPopover - - #GtkWidget the popover is related to + + #GtkWidget the popover is related to - a #GMenuModel + a #GMenuModel @@ -109270,12 +78403,8 @@ on the menus attach widget or on any of its parent widgets. - - Establishes a binding between a #GtkPopover and a #GMenuModel. + + Establishes a binding between a #GtkPopover and a #GMenuModel. The contents of @popover are removed and then refilled with menu items according to @model. When @model changes, @popover is updated. @@ -109286,18 +78415,18 @@ all children are removed. If @action_namespace is non-%NULL then the effect is as if all actions mentioned in the @model have their names prefixed with the -namespace, plus a dot. For example, if the action “quit” is -mentioned and @action_namespace is “app” then the effective action -name is “app.quit”. +namespace, plus a dot. For example, if the action “quit” is +mentioned and @action_namespace is “app” then the effective action +name is “app.quit”. This function uses #GtkActionable to define the action name and target values on the created menu items. If you want to use an -action group other than “app” and “win”, or if you want to use a +action group other than “app” and “win”, or if you want to use a #GtkMenuShell outside of a #GtkApplicationWindow, then you will need to attach your own action group to the widget hierarchy using gtk_widget_insert_action_group(). As an example, if you created a -group with a “quit” action and inserted it with the name “mygroup” -then you would use the action name “mygroup.quit” in your +group with a “quit” action and inserted it with the name “mygroup” +then you would use the action name “mygroup.quit” in your #GMenuModel. @@ -109305,209 +78434,135 @@ then you would use the action name “mygroup.quit” in your - a #GtkPopover + a #GtkPopover - - the #GMenuModel to bind to or %NULL to remove + + the #GMenuModel to bind to or %NULL to remove binding - - the namespace for actions in @model + + the namespace for actions in @model - - Returns the constraint for placing this popover. + + Returns the constraint for placing this popover. See gtk_popover_set_constrain_to(). - the constraint for placing this popover. + the constraint for placing this popover. - a #GtkPopover + a #GtkPopover - - Gets the widget that should be set as the default while + + Gets the widget that should be set as the default while the popover is shown. - the default widget, + the default widget, or %NULL if there is none - a #GtkPopover + a #GtkPopover - - Returns whether the popover is modal, see gtk_popover_set_modal to + + Returns whether the popover is modal, see gtk_popover_set_modal to see the implications of this. - #TRUE if @popover is modal + #TRUE if @popover is modal - a #GtkPopover + a #GtkPopover - - If a rectangle to point to has been set, this function will + + If a rectangle to point to has been set, this function will return %TRUE and fill in @rect with such rectangle, otherwise it will return %FALSE and fill in @rect with the attached widget coordinates. - %TRUE if a rectangle to point to was set. + %TRUE if a rectangle to point to was set. - a #GtkPopover + a #GtkPopover - - location to store the rectangle + + location to store the rectangle - Returns the preferred position of @popover. + Returns the preferred position of @popover. - The preferred position. + The preferred position. - a #GtkPopover + a #GtkPopover - - Returns the widget @popover is currently attached to + + Returns the widget @popover is currently attached to - a #GtkWidget + a #GtkWidget - a #GtkPopover + a #GtkPopover - - Returns whether show/hide transitions are enabled on this popover. + + Returns whether show/hide transitions are enabled on this popover. You can show or hide the popover without transitions using gtk_widget_show() and gtk_widget_hide() while gtk_popover_popup() and gtk_popover_popdown() will use transitions. - #TRUE if the show and hide transitions of the given + #TRUE if the show and hide transitions of the given popover are enabled, #FALSE otherwise. - a #GtkPopover + a #GtkPopover - Pops @popover down.This is different than a gtk_widget_hide() call + Pops @popover down.This is different than a gtk_widget_hide() call in that it shows the popover with a transition. If you want to hide the popover without a transition, use gtk_widget_hide(). @@ -109516,17 +78571,13 @@ the popover without a transition, use gtk_widget_hide(). - a #GtkPopover + a #GtkPopover - Pops @popover up. This is different than a gtk_widget_show() call + Pops @popover up. This is different than a gtk_widget_show() call in that it shows the popover with a transition. If you want to show the popover without a transition, use gtk_widget_show(). @@ -109535,19 +78586,13 @@ the popover without a transition, use gtk_widget_show(). - a #GtkPopover + a #GtkPopover - - Sets a constraint for positioning this popover. + + Sets a constraint for positioning this popover. Note that not all platforms support placing popovers freely, and may already impose constraints. @@ -109557,25 +78602,17 @@ and may already impose constraints. - a #GtkPopover + a #GtkPopover - the new constraint + the new constraint - - Sets the widget that should be set as default widget while + + Sets the widget that should be set as default widget while the popover is shown (see gtk_window_set_default()). #GtkPopover remembers the previous default widget and reestablishes it when the popover is dismissed. @@ -109585,28 +78622,17 @@ when the popover is dismissed. - a #GtkPopover + a #GtkPopover - - the new default widget, or %NULL + + the new default widget, or %NULL - - Sets whether @popover is modal, a modal popover will grab all input + + Sets whether @popover is modal, a modal popover will grab all input within the toplevel and grab the keyboard focus on it when being displayed. Clicking outside the popover area or pressing Esc will dismiss the popover and ungrab input. @@ -109616,25 +78642,17 @@ dismiss the popover and ungrab input. - a #GtkPopover + a #GtkPopover - #TRUE to make popover claim all input within the toplevel + #TRUE to make popover claim all input within the toplevel - - Sets the rectangle that @popover will point to, in the + + Sets the rectangle that @popover will point to, in the coordinate space of the widget @popover is attached to, see gtk_popover_set_relative_to(). @@ -109643,25 +78661,17 @@ see gtk_popover_set_relative_to(). - a #GtkPopover + a #GtkPopover - rectangle to point to + rectangle to point to - - Sets the preferred position for @popover to appear. If the @popover + + Sets the preferred position for @popover to appear. If the @popover is currently visible, it will be immediately updated. This preference will be respected where possible, although @@ -109673,25 +78683,17 @@ on lack of space (eg. if close to the window edges), the - a #GtkPopover + a #GtkPopover - preferred popover position + preferred popover position - - Sets a new widget to be attached to @popover. If @popover is + + Sets a new widget to be attached to @popover. If @popover is visible, the position will be updated. Note: the ownership of popovers is always given to their @relative_to @@ -109704,30 +78706,17 @@ unless extra references are kept. - a #GtkPopover + a #GtkPopover - - a #GtkWidget + + a #GtkWidget - - Sets whether show/hide transitions are enabled on this popover + + Sets whether show/hide transitions are enabled on this popover You can show or hide the popover without transitions using gtk_widget_show() and gtk_widget_hide() while gtk_popover_popup() and gtk_popover_popdown() will use transitions. @@ -109737,74 +78726,38 @@ unless extra references are kept. - a #GtkPopover + a #GtkPopover - Whether transitions are enabled + Whether transitions are enabled - - Sets a constraint for the popover position. + + Sets a constraint for the popover position. - - Sets whether the popover is modal (so other elements in the window do not + + Sets whether the popover is modal (so other elements in the window do not receive input while the popover is visible). - - Marks a specific rectangle to be pointed. + + Marks a specific rectangle to be pointed. - - Sets the preferred position of the popover. + + Sets the preferred position of the popover. - - Sets the attached widget. + + Sets the attached widget. - - Whether show/hide transitions are enabled for this popover. + + Whether show/hide transitions are enabled for this popover. You can show or hide the popover without transitions using gtk_widget_show() and gtk_widget_hide() while gtk_popover_popup() and gtk_popover_popdown() will use transitions. @@ -109817,40 +78770,27 @@ receive input while the popover is visible). - This signal is emitted when the popover is dismissed either through + This signal is emitted when the popover is dismissed either through API or user interaction. - + - + - + - + @@ -109874,44 +78814,20 @@ API or user interaction. - - Describes constraints to positioning of popovers. More values + + Describes constraints to positioning of popovers. More values may be added to this enumeration in the future. - - Don't constrain the popover position + + Don't constrain the popover position beyond what is imposed by the implementation - - Constrain the popover to the boundaries + + Constrain the popover to the boundaries of the window that it is attached to - - GtkPopoverMenu is a subclass of #GtkPopover that treats its + + GtkPopoverMenu is a subclass of #GtkPopover that treats its children like menus and allows switching between them. It is meant to be used primarily together with #GtkModelButton, but any widget can be used, such as #GtkSpinButton or #GtkScale. @@ -109986,26 +78902,16 @@ and get the .menu style class. - - Creates a new popover menu. + + Creates a new popover menu. - a new #GtkPopoverMenu + a new #GtkPopoverMenu - - Opens a submenu of the @popover. The @name + + Opens a submenu of the @popover. The @name must be one of the names given to the submenus of @popover with #GtkPopoverMenu:submenu, or "main" to switch back to the main menu. @@ -110020,15 +78926,11 @@ other kinds of widgets to initiate menu changes. - a #GtkPopoverMenu + a #GtkPopoverMenu - the name of the menu to switch to + the name of the menu to switch to @@ -110037,9 +78939,7 @@ other kinds of widgets to initiate menu changes. - + @@ -110053,54 +78953,25 @@ other kinds of widgets to initiate menu changes. - - Describes which edge of a widget a certain feature is positioned at, e.g. the + + Describes which edge of a widget a certain feature is positioned at, e.g. the tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a #GtkScale. - - The feature is at the left edge. + + The feature is at the left edge. - - The feature is at the right edge. + + The feature is at the right edge. - The feature is at the top edge. + The feature is at the top edge. - - The feature is at the bottom edge. + + The feature is at the bottom edge. - - A GtkPrintContext encapsulates context information that is required when + + A GtkPrintContext encapsulates context information that is required when drawing pages for printing, such as the cairo context and important parameters like page size and resolution. It also lets you easily create #PangoLayout and #PangoContext objects that match the font metrics @@ -110167,275 +79038,171 @@ draw_page (GtkPrintOperation *operation, ]| Printing support was added in GTK+ 2.10. - - Creates a new #PangoContext that can be used with the + + Creates a new #PangoContext that can be used with the #GtkPrintContext. - a new Pango context for @context + a new Pango context for @context - a #GtkPrintContext + a #GtkPrintContext - - Creates a new #PangoLayout that is suitable for use + + Creates a new #PangoLayout that is suitable for use with the #GtkPrintContext. - a new Pango layout for @context + a new Pango layout for @context - a #GtkPrintContext + a #GtkPrintContext - - Obtains the cairo context that is associated with the + + Obtains the cairo context that is associated with the #GtkPrintContext. - the cairo context of @context + the cairo context of @context - a #GtkPrintContext + a #GtkPrintContext - - Obtains the horizontal resolution of the #GtkPrintContext, + + Obtains the horizontal resolution of the #GtkPrintContext, in dots per inch. - the horizontal resolution of @context + the horizontal resolution of @context - a #GtkPrintContext + a #GtkPrintContext - - Obtains the vertical resolution of the #GtkPrintContext, + + Obtains the vertical resolution of the #GtkPrintContext, in dots per inch. - the vertical resolution of @context + the vertical resolution of @context - a #GtkPrintContext + a #GtkPrintContext - - Obtains the hardware printer margins of the #GtkPrintContext, in units. + + Obtains the hardware printer margins of the #GtkPrintContext, in units. - %TRUE if the hard margins were retrieved + %TRUE if the hard margins were retrieved - a #GtkPrintContext + a #GtkPrintContext - - top hardware printer margin + + top hardware printer margin - - bottom hardware printer margin + + bottom hardware printer margin - - left hardware printer margin + + left hardware printer margin - - right hardware printer margin + + right hardware printer margin - - Obtains the height of the #GtkPrintContext, in pixels. + + Obtains the height of the #GtkPrintContext, in pixels. - the height of @context + the height of @context - a #GtkPrintContext + a #GtkPrintContext - - Obtains the #GtkPageSetup that determines the page + + Obtains the #GtkPageSetup that determines the page dimensions of the #GtkPrintContext. - the page setup of @context + the page setup of @context - a #GtkPrintContext + a #GtkPrintContext - - Returns a #PangoFontMap that is suitable for use + + Returns a #PangoFontMap that is suitable for use with the #GtkPrintContext. - the font map of @context + the font map of @context - a #GtkPrintContext + a #GtkPrintContext - - Obtains the width of the #GtkPrintContext, in pixels. + + Obtains the width of the #GtkPrintContext, in pixels. - the width of @context + the width of @context - a #GtkPrintContext + a #GtkPrintContext - - Sets a new cairo context on a print context. + + Sets a new cairo context on a print context. This function is intended to be used when implementing an internal print preview, it is not needed for printing, @@ -110447,132 +79214,64 @@ case. - a #GtkPrintContext + a #GtkPrintContext - the cairo context + the cairo context - the horizontal resolution to use with @cr + the horizontal resolution to use with @cr - the vertical resolution to use with @cr + the vertical resolution to use with @cr - - See also gtk_print_settings_set_duplex(). - - No duplex. + + See also gtk_print_settings_set_duplex(). + + No duplex. - - Horizontal duplex. + + Horizontal duplex. - - Vertical duplex. + + Vertical duplex. - - Error codes that identify various errors that can occur while + + Error codes that identify various errors that can occur while using the GTK+ printing support. - - An unspecified error occurred. + + An unspecified error occurred. - - An internal error occurred. + + An internal error occurred. - - A memory allocation failed. + + A memory allocation failed. - - An error occurred while loading a page setup + + An error occurred while loading a page setup or paper size from a key file. - - Registers an error quark for #GtkPrintOperation if necessary. + + Registers an error quark for #GtkPrintOperation if necessary. - The error quark used for #GtkPrintOperation errors. + The error quark used for #GtkPrintOperation errors. - - GtkPrintOperation is the high-level, portable printing API. + + GtkPrintOperation is the high-level, portable printing API. It looks a bit different than other GTK+ dialogs such as the -#GtkFileChooser, since some platforms don’t expose enough +#GtkFileChooser, since some platforms don’t expose enough infrastructure to implement a good print dialog. On such platforms, GtkPrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK+ @@ -110633,17 +79332,11 @@ gtk_print_operation_preview_is_selected() are useful when implementing a print preview. - - Creates a new #GtkPrintOperation. + + Creates a new #GtkPrintOperation. - a new #GtkPrintOperation + a new #GtkPrintOperation @@ -110696,8 +79389,7 @@ are useful when implementing a print preview. - + @@ -110756,8 +79448,7 @@ are useful when implementing a print preview. - + @@ -110818,12 +79509,8 @@ are useful when implementing a print preview. - - Cancels a running print operation. This function may + + Cancels a running print operation. This function may be called from a #GtkPrintOperation::begin-print, #GtkPrintOperation::paginate or #GtkPrintOperation::draw-page signal handler to stop the currently running print @@ -110834,19 +79521,13 @@ operation. - a #GtkPrintOperation + a #GtkPrintOperation - - Signalize that drawing of particular page is complete. + + Signalize that drawing of particular page is complete. It is called after completion of page drawing (e.g. drawing in another thread). @@ -110859,65 +79540,42 @@ itself. - a #GtkPrintOperation + a #GtkPrintOperation - - Returns the default page setup, see + + Returns the default page setup, see gtk_print_operation_set_default_page_setup(). - the default page setup + the default page setup - a #GtkPrintOperation + a #GtkPrintOperation - - Gets the value of #GtkPrintOperation:embed-page-setup property. + + Gets the value of #GtkPrintOperation:embed-page-setup property. - whether page setup selection combos are embedded + whether page setup selection combos are embedded - a #GtkPrintOperation + a #GtkPrintOperation - - Call this when the result of a print operation is + + Call this when the result of a print operation is %GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by gtk_print_operation_run(), or in the #GtkPrintOperation::done signal handler. The returned #GError will contain more details on what went wrong. @@ -110927,41 +79585,27 @@ handler. The returned #GError will contain more details on what went wrong. - a #GtkPrintOperation + a #GtkPrintOperation - - Gets the value of #GtkPrintOperation:has-selection property. + + Gets the value of #GtkPrintOperation:has-selection property. - whether there is a selection + whether there is a selection - a #GtkPrintOperation + a #GtkPrintOperation - - Returns the number of pages that will be printed. + + Returns the number of pages that will be printed. Note that this value is set during print preparation phase (%GTK_PRINT_STATUS_PREPARING), so this function should never be @@ -110972,75 +79616,51 @@ print status is %GTK_PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation. - the number of pages that will be printed + the number of pages that will be printed - a #GtkPrintOperation + a #GtkPrintOperation - - Returns the current print settings. + + Returns the current print settings. Note that the return value is %NULL until either gtk_print_operation_set_print_settings() or gtk_print_operation_run() have been called. - the current print settings of @op. + the current print settings of @op. - a #GtkPrintOperation + a #GtkPrintOperation - - Returns the status of the print operation. + + Returns the status of the print operation. Also see gtk_print_operation_get_status_string(). - the status of the print operation + the status of the print operation - a #GtkPrintOperation + a #GtkPrintOperation - - Returns a string representation of the status of the + + Returns a string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a #GtkStatusbar. @@ -111048,49 +79668,33 @@ Use gtk_print_operation_get_status() to obtain a status value that is suitable for programmatic use. - a string representation of the status + a string representation of the status of the print operation - a #GtkPrintOperation + a #GtkPrintOperation - - Gets the value of #GtkPrintOperation:support-selection property. + + Gets the value of #GtkPrintOperation:support-selection property. - whether the application supports print of selection + whether the application supports print of selection - a #GtkPrintOperation + a #GtkPrintOperation - - A convenience function to find out if the print operation + + A convenience function to find out if the print operation is finished, either successfully (%GTK_PRINT_STATUS_FINISHED) or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED). @@ -111099,27 +79703,18 @@ can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer. - %TRUE, if the print operation is finished. + %TRUE, if the print operation is finished. - a #GtkPrintOperation + a #GtkPrintOperation - - Runs the print operation, by first letting the user modify + + Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document. Normally that this function does not return until the rendering of all @@ -111176,9 +79771,7 @@ Note that gtk_print_operation_run() can only be called once on a given #GtkPrintOperation. - the result of the print operation. A return value of + the result of the print operation. A return value of %GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was completed successfully. In this case, it is a good idea to obtain the used print settings with gtk_print_operation_get_print_settings() @@ -111190,35 +79783,21 @@ given #GtkPrintOperation. - a #GtkPrintOperation + a #GtkPrintOperation - the action to start - + the action to start + - - Transient parent of the dialog + + Transient parent of the dialog - - Sets whether the gtk_print_operation_run() may return + + Sets whether the gtk_print_operation_run() may return before the print operation is completed. Note that some platforms may not allow asynchronous operation. @@ -111227,25 +79806,17 @@ some platforms may not allow asynchronous operation. - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE to allow asynchronous operation + %TRUE to allow asynchronous operation - - Sets the current page. + + Sets the current page. If this is called before gtk_print_operation_run(), the user will be able to select to print only the current page. @@ -111257,53 +79828,34 @@ Note that this only makes sense for pre-paginated documents. - a #GtkPrintOperation + a #GtkPrintOperation - the current page, 0-based + the current page, 0-based - - Sets the label for the tab holding custom widgets. + + Sets the label for the tab holding custom widgets. - a #GtkPrintOperation + a #GtkPrintOperation - - the label to use, or %NULL to use the default label + + the label to use, or %NULL to use the default label - - Makes @default_page_setup the default page setup for @op. + + Makes @default_page_setup the default page setup for @op. This page setup will be used by gtk_print_operation_run(), but it can be overridden on a per-page basis by connecting @@ -111314,51 +79866,34 @@ to the #GtkPrintOperation::request-page-setup signal. - a #GtkPrintOperation + a #GtkPrintOperation - - a #GtkPageSetup, or %NULL + + a #GtkPageSetup, or %NULL - - Sets up the #GtkPrintOperation to wait for calling of + + Sets up the #GtkPrintOperation to wait for calling of gtk_print_operation_draw_page_finish() from application. It can be used for drawing page in another thread. -This function must be called in the callback of “draw-page” signal. +This function must be called in the callback of “draw-page” signal. - a #GtkPrintOperation + a #GtkPrintOperation - - Embed page size combo box and orientation combo box into page setup page. + + Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in #GtkPrintOperation. @@ -111366,31 +79901,23 @@ Selected page setup is stored as default page setup in #GtkPrintOperation. - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE to embed page setup selection in the #GtkPrintUnixDialog + %TRUE to embed page setup selection in the #GtkPrintUnixDialog - - Sets up the #GtkPrintOperation to generate a file instead + + Sets up the #GtkPrintOperation to generate a file instead of showing the print dialog. The indended use of this function -is for implementing “Export to PDF” actions. Currently, PDF +is for implementing “Export to PDF” actions. Currently, PDF is the only supported format. -“Print to PDF” support is independent of this and is done -by letting the user pick the “Print to PDF” item from the list +“Print to PDF” support is independent of this and is done +by letting the user pick the “Print to PDF” item from the list of printers in the print dialog. @@ -111398,25 +79925,17 @@ of printers in the print dialog. - a #GtkPrintOperation + a #GtkPrintOperation - the filename for the exported file + the filename for the exported file - - Sets whether there is a selection to print. + + Sets whether there is a selection to print. Application has to set number of pages to which the selection will draw by gtk_print_operation_set_n_pages() in a callback of @@ -111427,28 +79946,20 @@ will draw by gtk_print_operation_set_n_pages() in a callback of - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE indicates that a selection exists + %TRUE indicates that a selection exists - - Sets the name of the print job. The name is used to identify + + Sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups). -If you don’t set a job name, GTK+ picks a default one by +If you don’t set a job name, GTK+ picks a default one by numbering successive print jobs. @@ -111456,25 +79967,17 @@ numbering successive print jobs. - a #GtkPrintOperation + a #GtkPrintOperation - a string that identifies the print job + a string that identifies the print job - - Sets the number of pages in the document. + + Sets the number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a @@ -111491,25 +79994,17 @@ will be for page @n_pages - 1. - a #GtkPrintOperation + a #GtkPrintOperation - the number of pages + the number of pages - - Sets the print settings for @op. This is typically used to + + Sets the print settings for @op. This is typically used to re-establish print settings from a previous print operation, see gtk_print_operation_run(). @@ -111518,28 +80013,17 @@ see gtk_print_operation_run(). - a #GtkPrintOperation + a #GtkPrintOperation - - #GtkPrintSettings + + #GtkPrintSettings - - If @show_progress is %TRUE, the print operation will show a + + If @show_progress is %TRUE, the print operation will show a progress dialog during the print operation. @@ -111547,52 +80031,36 @@ progress dialog during the print operation. - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE to show a progress dialog + %TRUE to show a progress dialog - - Sets whether selection is supported by #GtkPrintOperation. + + Sets whether selection is supported by #GtkPrintOperation. - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE to support selection + %TRUE to support selection - - If track_status is %TRUE, the print operation will try to continue report + + If track_status is %TRUE, the print operation will try to continue report on the status of the print job in the printer queues and printer. This -can allow your application to show things like “out of paper” issues, +can allow your application to show things like “out of paper” issues, and when the print job actually reaches the printer. This function is often implemented using some form of polling, so it should @@ -111603,25 +80071,17 @@ not be enabled unless needed. - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE to track status after printing + %TRUE to track status after printing - - Sets up the transformation for the cairo context obtained from + + Sets up the transformation for the cairo context obtained from #GtkPrintContext in such a way that distances are measured in units of @unit. @@ -111630,25 +80090,17 @@ units of @unit. - a #GtkPrintOperation + a #GtkPrintOperation - the unit to use + the unit to use - - If @full_page is %TRUE, the transformation for the cairo context + + If @full_page is %TRUE, the transformation for the cairo context obtained from #GtkPrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per @@ -111660,26 +80112,17 @@ imageable area (i.e. inside the margins). - a #GtkPrintOperation + a #GtkPrintOperation - %TRUE to set up the #GtkPrintContext for the full page + %TRUE to set up the #GtkPrintContext for the full page - - Determines whether the print operation may run asynchronously or not. + + Determines whether the print operation may run asynchronously or not. Some systems don't support asynchronous printing, but those that do will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and @@ -111691,13 +80134,8 @@ is unlikely to change). On other platforms, all actions except for %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous operation. - - The current page in the document. + + The current page in the document. If this is set before gtk_print_operation_run(), the user will be able to select to print only the current page. @@ -111705,88 +80143,53 @@ the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents. - - Used as the label of the tab containing custom widgets. + + Used as the label of the tab containing custom widgets. Note that this property may be ignored on some platforms. If this is %NULL, GTK+ uses a default label. - - The #GtkPageSetup used by default. + + The #GtkPageSetup used by default. This page setup will be used by gtk_print_operation_run(), but it can be overridden on a per-page basis by connecting to the #GtkPrintOperation::request-page-setup signal. - - If %TRUE, page size combo box and orientation combo box are embedded into page setup page. + + If %TRUE, page size combo box and orientation combo box are embedded into page setup page. - - The name of a file to generate instead of showing the print dialog. + + The name of a file to generate instead of showing the print dialog. Currently, PDF is the only supported format. The intended use of this property is for implementing -“Export to PDF” actions. +“Export to PDF” actions. -“Print to PDF” support is independent of this and is done -by letting the user pick the “Print to PDF” item from the +“Print to PDF” support is independent of this and is done +by letting the user pick the “Print to PDF” item from the list of printers in the print dialog. - - Determines whether there is a selection in your application. + + Determines whether there is a selection in your application. This can allow your application to print the selection. This is typically used to make a "Selection" button sensitive. - - A string used to identify the job (e.g. in monitoring + + A string used to identify the job (e.g. in monitoring applications like eggcups). If you don't set a job name, GTK+ picks a default one by numbering successive print jobs. - - The number of pages in the document. + + The number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a @@ -111799,12 +80202,8 @@ the user chooses to print all pages, the last ::draw-page signal will be for page @n_pages - 1. - - The number of pages that will be printed. + + The number of pages that will be printed. Note that this value is set during print preparation phase (%GTK_PRINT_STATUS_PREPARING), so this value should never be @@ -111815,39 +80214,25 @@ print status is %GTK_PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation. - - The #GtkPrintSettings used for initializing the dialog. + + The #GtkPrintSettings used for initializing the dialog. Setting this property is typically used to re-establish print settings from a previous print operation, see gtk_print_operation_run(). - - Determines whether to show a progress dialog during the + + Determines whether to show a progress dialog during the print operation. - The status of the print operation. + The status of the print operation. - A string representation of the status of the print operation. + A string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a #GtkStatusbar. @@ -111855,48 +80240,28 @@ See the #GtkPrintOperation:status property for a status value that is suitable for programmatic use. - - If %TRUE, the print operation will support print of selection. + + If %TRUE, the print operation will support print of selection. This allows the print dialog to show a "Selection" button. - - If %TRUE, the print operation will try to continue report on + + If %TRUE, the print operation will try to continue report on the status of the print job in the printer queues and printer. -This can allow your application to show things like “out of paper” +This can allow your application to show things like “out of paper” issues, and when the print job actually reaches the printer. However, this is often implemented using polling, and should not be enabled unless needed. - - The transformation for the cairo context obtained from + + The transformation for the cairo context obtained from #GtkPrintContext is set up in such a way that distances are measured in units of @unit. - - If %TRUE, the transformation for the cairo context obtained + + If %TRUE, the transformation for the cairo context obtained from #GtkPrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). @@ -111911,9 +80276,7 @@ area (i.e. inside the margins). - Emitted after the user has finished changing print settings + Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts. A typical use for ::begin-print is to use the parameters from the @@ -111924,17 +80287,13 @@ set the number of pages with gtk_print_operation_set_n_pages(). - the #GtkPrintContext for the current operation + the #GtkPrintContext for the current operation - Emitted when displaying the print dialog. If you return a + Emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it. @@ -111945,17 +80304,13 @@ to stay around until the #GtkPrintOperation::custom-widget-apply signal is emitted on the operation. Then you can read out any information you need from the widgets. - A custom widget that gets embedded in + A custom widget that gets embedded in the print dialog, or %NULL - Emitted right before #GtkPrintOperation::begin-print if you added + Emitted right before #GtkPrintOperation::begin-print if you added a custom widget in the #GtkPrintOperation::create-custom-widget handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaraneed to be around at a @@ -111965,17 +80320,13 @@ later time. - the custom widget added in create-custom-widget + the custom widget added in create-custom-widget - Emitted when the print operation run has finished doing + Emitted when the print operation run has finished doing everything required for printing. @result gives you information about what happened during the run. @@ -111990,17 +80341,13 @@ after #GtkPrintOperation::done was emitted. - the result of the print operation + the result of the print operation - Emitted for every page that is printed. The signal handler + Emitted for every page that is printed. The signal handler must render the @page_nr's page onto the cairo context obtained from @context using gtk_print_context_get_cairo_context(). |[<!-- language="C" --> @@ -112053,23 +80400,17 @@ needs. - the #GtkPrintContext for the current operation + the #GtkPrintContext for the current operation - the number of the currently printed page (0-based) + the number of the currently printed page (0-based) - Emitted after all pages have been rendered. + Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the #GtkPrintOperation::begin-print handler. @@ -112077,17 +80418,13 @@ been allocated in the #GtkPrintOperation::begin-print handler. - the #GtkPrintContext for the current operation + the #GtkPrintContext for the current operation - Emitted after the #GtkPrintOperation::begin-print signal, but before + Emitted after the #GtkPrintOperation::begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns %TRUE. @@ -112101,24 +80438,18 @@ If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there. - %TRUE if pagination is complete + %TRUE if pagination is complete - the #GtkPrintContext for the current operation + the #GtkPrintContext for the current operation - Gets emitted when a preview is requested from the native dialog. + Gets emitted when a preview is requested from the native dialog. The default handler for this signal uses an external viewer application to preview. @@ -112135,39 +80466,26 @@ are selected for print and render them. The preview must be finished by calling gtk_print_operation_preview_end_preview() (typically in response to the user clicking a close button). - %TRUE if the listener wants to take over control of the preview + %TRUE if the listener wants to take over control of the preview - the #GtkPrintOperationPreview for the current operation + the #GtkPrintOperationPreview for the current operation - the #GtkPrintContext that will be used + the #GtkPrintContext that will be used - - the #GtkWindow to use as window parent, or %NULL + + the #GtkWindow to use as window parent, or %NULL - Emitted once for every page that is printed, to give + Emitted once for every page that is printed, to give the application a chance to modify the page setup. Any changes done to @setup will be in force only for printing this page. @@ -112175,29 +80493,21 @@ done to @setup will be in force only for printing this page. - the #GtkPrintContext for the current operation + the #GtkPrintContext for the current operation - the number of the currently printed page (0-based) + the number of the currently printed page (0-based) - the #GtkPageSetup + the #GtkPageSetup - Emitted at between the various phases of the print operation. + Emitted at between the various phases of the print operation. See #GtkPrintStatus for the phases that are being discriminated. Use gtk_print_operation_get_status() to find out the current status. @@ -112206,9 +80516,7 @@ status. - Emitted after change of selected printer. The actual page setup and + Emitted after change of selected printer. The actual page setup and print settings are passed to the custom widget, which can actualize itself according to this change. @@ -112216,77 +80524,42 @@ itself according to this change. - the custom widget added in create-custom-widget + the custom widget added in create-custom-widget - actual page setup + actual page setup - actual print settings + actual print settings - - The @action parameter to gtk_print_operation_run() + + The @action parameter to gtk_print_operation_run() determines what action the print operation should perform. - - Show the print dialog. + + Show the print dialog. - - Start to print without showing + + Start to print without showing the print dialog, based on the current print settings. - - Show the print preview. + + Show the print preview. - - Export to a file. This requires + + Export to a file. This requires the export-filename property to be set. - + - The parent class. + The parent class. @@ -112300,8 +80573,7 @@ determines what action the print operation should perform. - + @@ -112448,8 +80720,7 @@ determines what action the print operation should perform. - + @@ -112547,17 +80818,10 @@ determines what action the print operation should perform. - + - Ends a preview. + Ends a preview. This function must be called to finish a custom print preview. @@ -112566,11 +80830,8 @@ This function must be called to finish a custom print preview. - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + @@ -112581,8 +80842,7 @@ This function must be called to finish a custom print preview. - + @@ -112593,29 +80853,20 @@ This function must be called to finish a custom print preview. - Returns whether the given page is included in the set of pages that + Returns whether the given page is included in the set of pages that have been selected for printing. - %TRUE if the page has been selected for printing + %TRUE if the page has been selected for printing - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - a page number + a page number @@ -112627,8 +80878,7 @@ have been selected for printing. - + @@ -112636,9 +80886,7 @@ have been selected for printing. - Renders a page to the preview, using the print context that + Renders a page to the preview, using the print context that was passed to the #GtkPrintOperation::preview handler together with @preview. @@ -112653,26 +80901,17 @@ be associated with the print context. - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - the page to render + the page to render - - Ends a preview. + + Ends a preview. This function must be called to finish a custom print preview. @@ -112681,50 +80920,32 @@ This function must be called to finish a custom print preview. - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - - Returns whether the given page is included in the set of pages that + + Returns whether the given page is included in the set of pages that have been selected for printing. - %TRUE if the page has been selected for printing + %TRUE if the page has been selected for printing - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - a page number + a page number - - Renders a page to the preview, using the print context that + + Renders a page to the preview, using the print context that was passed to the #GtkPrintOperation::preview handler together with @preview. @@ -112739,24 +80960,17 @@ be associated with the print context. - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - the page to render + the page to render - The ::got-page-size signal is emitted once for each page + The ::got-page-size signal is emitted once for each page that gets rendered to the preview. A handler for this signal should update the @context @@ -112767,23 +80981,17 @@ context, using gtk_print_context_set_cairo_context(). - the current #GtkPrintContext + the current #GtkPrintContext - the #GtkPageSetup for the current page + the #GtkPageSetup for the current page - The ::ready signal gets emitted once per preview operation, + The ::ready signal gets emitted once per preview operation, before the first page is rendered. A handler for this signal can be used for setup tasks. @@ -112792,32 +81000,26 @@ A handler for this signal can be used for setup tasks. - the current #GtkPrintContext + the current #GtkPrintContext - + - + - + @@ -112827,15 +81029,13 @@ A handler for this signal can be used for setup tasks. - + - + @@ -112848,23 +81048,17 @@ A handler for this signal can be used for setup tasks. - + - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - the page to render + the page to render @@ -112872,26 +81066,18 @@ A handler for this signal can be used for setup tasks. - + - %TRUE if the page has been selected for printing + %TRUE if the page has been selected for printing - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - a page number + a page number @@ -112899,26 +81085,21 @@ A handler for this signal can be used for setup tasks. - + - a #GtkPrintOperationPreview - + a #GtkPrintOperationPreview + - + @@ -112926,8 +81107,7 @@ A handler for this signal can be used for setup tasks. - + @@ -112935,8 +81115,7 @@ A handler for this signal can be used for setup tasks. - + @@ -112944,8 +81123,7 @@ A handler for this signal can be used for setup tasks. - + @@ -112953,8 +81131,7 @@ A handler for this signal can be used for setup tasks. - + @@ -112962,8 +81139,7 @@ A handler for this signal can be used for setup tasks. - + @@ -112971,8 +81147,7 @@ A handler for this signal can be used for setup tasks. - + @@ -112980,154 +81155,69 @@ A handler for this signal can be used for setup tasks. - + - + - - A value of this type is returned by gtk_print_operation_run(). - - An error has occurred. + + A value of this type is returned by gtk_print_operation_run(). + + An error has occurred. - - The print settings should be stored. + + The print settings should be stored. - - The print operation has been canceled, + + The print operation has been canceled, the print settings should not be stored. - - The print operation is not complete + + The print operation is not complete yet. This value will only be returned when running asynchronously. - - See also gtk_print_job_set_pages() - - All pages. + + See also gtk_print_job_set_pages() + + All pages. - - Current page. + + Current page. - - Range of pages. + + Range of pages. - - Selected pages. + + Selected pages. - - See also gtk_print_settings_set_quality(). - - Low quality. + + See also gtk_print_settings_set_quality(). + + Low quality. - - Normal quality. + + Normal quality. - - High quality. + + High quality. - - Draft quality. + + Draft quality. - - A GtkPrintSettings object represents the settings of a print dialog in + + A GtkPrintSettings object represents the settings of a print dialog in a system-independent way. The main use for this object is that once -you’ve printed you can get a settings object that represents the settings +you’ve printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so -that the user doesn’t have to re-set all his settings. +that the user doesn’t have to re-set all his settings. Its also possible to enumerate the settings so that you can easily save the settings for the next time your app runs, or even store them in a @@ -113135,642 +81225,413 @@ document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works. Printing support was added in GTK+ 2.10. - - Creates a new #GtkPrintSettings object. + + Creates a new #GtkPrintSettings object. - a new #GtkPrintSettings object + a new #GtkPrintSettings object - - Reads the print settings from @file_name. Returns a new #GtkPrintSettings + + Reads the print settings from @file_name. Returns a new #GtkPrintSettings object with the restored settings, or %NULL if an error occurred. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. See gtk_print_settings_to_file(). - the restored #GtkPrintSettings + the restored #GtkPrintSettings - the filename to read the settings from + the filename to read the settings from - - Deserialize print settings from an a{sv} variant in + + Deserialize print settings from an a{sv} variant in the format produced by gtk_print_settings_to_gvariant(). - a new #GtkPrintSettings object + a new #GtkPrintSettings object - an a{sv} #GVariant + an a{sv} #GVariant - - Reads the print settings from the group @group_name in @key_file. Returns a + + Reads the print settings from the group @group_name in @key_file. Returns a new #GtkPrintSettings object with the restored settings, or %NULL if an error occurred. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. - the restored #GtkPrintSettings + the restored #GtkPrintSettings - the #GKeyFile to retrieve the settings from + the #GKeyFile to retrieve the settings from - - the name of the group to use, or %NULL to use - the default “Print Settings” + + the name of the group to use, or %NULL to use + the default “Print Settings” - - Copies a #GtkPrintSettings object. + + Copies a #GtkPrintSettings object. - a newly allocated copy of @other + a newly allocated copy of @other - a #GtkPrintSettings + a #GtkPrintSettings - - Calls @func for each key-value pair of @settings. + + Calls @func for each key-value pair of @settings. - a #GtkPrintSettings + a #GtkPrintSettings - - the function to call + + the function to call - - user data for @func + + user data for @func - Looks up the string value associated with @key. + Looks up the string value associated with @key. - the string value for @key + the string value for @key - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - - Returns the boolean represented by the value + + Returns the boolean represented by the value that is associated with @key. -The string “true” represents %TRUE, any other +The string “true” represents %TRUE, any other string %FALSE. - %TRUE, if @key maps to a true value. + %TRUE, if @key maps to a true value. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - - Gets the value of %GTK_PRINT_SETTINGS_COLLATE. + + Gets the value of %GTK_PRINT_SETTINGS_COLLATE. - whether to collate the printed pages + whether to collate the printed pages - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. + + Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. - the default source + the default source - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_DITHER. + + Gets the value of %GTK_PRINT_SETTINGS_DITHER. - the dithering that is used + the dithering that is used - a #GtkPrintSettings + a #GtkPrintSettings - - Returns the double value associated with @key, or 0. + + Returns the double value associated with @key, or 0. - the double value of @key + the double value of @key - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - - Returns the floating point number represented by + + Returns the floating point number represented by the value that is associated with @key, or @default_val if the value does not represent a floating point number. Floating point numbers are parsed with g_ascii_strtod(). - the floating point number associated with @key + the floating point number associated with @key - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - the default value + the default value - - Gets the value of %GTK_PRINT_SETTINGS_DUPLEX. + + Gets the value of %GTK_PRINT_SETTINGS_DUPLEX. - whether to print the output in duplex. + whether to print the output in duplex. - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS. + + Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS. - the finishings + the finishings - a #GtkPrintSettings + a #GtkPrintSettings - - Returns the integer value of @key, or 0. + + Returns the integer value of @key, or 0. - the integer value of @key + the integer value of @key - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - - Returns the value of @key, interpreted as + + Returns the value of @key, interpreted as an integer, or the default value. - the integer value of @key + the integer value of @key - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - the default value + the default value - - Returns the value associated with @key, interpreted + + Returns the value associated with @key, interpreted as a length. The returned value is converted to @units. - the length value of @key, converted to @unit + the length value of @key, converted to @unit - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - the unit of the return value + the unit of the return value - - Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. + + Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. The set of media types is defined in PWG 5101.1-2002 PWG. - the media type + the media type - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_N_COPIES. + + Gets the value of %GTK_PRINT_SETTINGS_N_COPIES. - the number of copies to print + the number of copies to print - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. + + Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. - the number of pages per sheet + the number of pages per sheet - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. + + Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. - layout of page in number-up mode + layout of page in number-up mode - a #GtkPrintSettings + a #GtkPrintSettings - - Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, + + Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, converted to a #GtkPageOrientation. - the orientation + the orientation - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. + + Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. - the output bin + the output bin - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. + + Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. - an array + an array of #GtkPageRanges. Use g_free() to free the array when it is no longer needed. @@ -113779,739 +81640,482 @@ converted to a #GtkPageOrientation. - a #GtkPrintSettings + a #GtkPrintSettings - - return location for the length of the returned array + + return location for the length of the returned array - - Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET. + + Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET. - the set of pages to print + the set of pages to print - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, + + Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to @unit. - the paper height, in units of @unit + the paper height, in units of @unit - a #GtkPrintSettings + a #GtkPrintSettings - the unit for the return value + the unit for the return value - - Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, + + Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a #GtkPaperSize. - the paper size + the paper size - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, + + Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to @unit. - the paper width, in units of @unit + the paper width, in units of @unit - a #GtkPrintSettings + a #GtkPrintSettings - the unit for the return value + the unit for the return value - - Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. + + Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. - which pages to print + which pages to print - a #GtkPrintSettings + a #GtkPrintSettings - - Convenience function to obtain the value of + + Convenience function to obtain the value of %GTK_PRINT_SETTINGS_PRINTER. - the printer name + the printer name - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. + + Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. - the resolution in lpi (lines per inch) + the resolution in lpi (lines per inch) - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_QUALITY. + + Gets the value of %GTK_PRINT_SETTINGS_QUALITY. - the print quality + the print quality - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION. + + Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION. - the resolution in dpi + the resolution in dpi - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X. + + Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X. - the horizontal resolution in dpi + the horizontal resolution in dpi - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y. + + Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y. - the vertical resolution in dpi + the vertical resolution in dpi - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_REVERSE. + + Gets the value of %GTK_PRINT_SETTINGS_REVERSE. - whether to reverse the order of the printed pages + whether to reverse the order of the printed pages - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_SCALE. + + Gets the value of %GTK_PRINT_SETTINGS_SCALE. - the scale in percent + the scale in percent - a #GtkPrintSettings + a #GtkPrintSettings - - Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR. + + Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR. - whether to use color + whether to use color - a #GtkPrintSettings + a #GtkPrintSettings - - Returns %TRUE, if a value is associated with @key. + + Returns %TRUE, if a value is associated with @key. - %TRUE, if @key has a value + %TRUE, if @key has a value - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - - Reads the print settings from @file_name. If the file could not be loaded + + Reads the print settings from @file_name. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. See gtk_print_settings_to_file(). - %TRUE on success + %TRUE on success - a #GtkPrintSettings + a #GtkPrintSettings - the filename to read the settings from + the filename to read the settings from - - Reads the print settings from the group @group_name in @key_file. If the + + Reads the print settings from the group @group_name in @key_file. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. - %TRUE on success + %TRUE on success - a #GtkPrintSettings + a #GtkPrintSettings - the #GKeyFile to retrieve the settings from + the #GKeyFile to retrieve the settings from - - the name of the group to use, or %NULL to use the default - “Print Settings” + + the name of the group to use, or %NULL to use the default + “Print Settings” - Associates @value with @key. + Associates @value with @key. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - - a string value, or %NULL + + a string value, or %NULL - - Sets @key to a boolean value. + + Sets @key to a boolean value. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - a boolean + a boolean - - Sets the value of %GTK_PRINT_SETTINGS_COLLATE. + + Sets the value of %GTK_PRINT_SETTINGS_COLLATE. - a #GtkPrintSettings + a #GtkPrintSettings - whether to collate the output + whether to collate the output - - Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. + + Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. - a #GtkPrintSettings + a #GtkPrintSettings - the default source + the default source - - Sets the value of %GTK_PRINT_SETTINGS_DITHER. + + Sets the value of %GTK_PRINT_SETTINGS_DITHER. - a #GtkPrintSettings + a #GtkPrintSettings - the dithering that is used + the dithering that is used - - Sets @key to a double value. + + Sets @key to a double value. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - a double value + a double value - - Sets the value of %GTK_PRINT_SETTINGS_DUPLEX. + + Sets the value of %GTK_PRINT_SETTINGS_DUPLEX. - a #GtkPrintSettings + a #GtkPrintSettings - a #GtkPrintDuplex value + a #GtkPrintDuplex value - - Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS. + + Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS. - a #GtkPrintSettings + a #GtkPrintSettings - the finishings + the finishings - - Sets @key to an integer value. + + Sets @key to an integer value. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - an integer + an integer - - Associates a length in units of @unit with @key. + + Associates a length in units of @unit with @key. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key - a length + a length - the unit of @length + the unit of @length - - Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. + + Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. The set of media types is defined in PWG 5101.1-2002 PWG. @@ -114520,239 +82124,163 @@ The set of media types is defined in PWG 5101.1-2002 PWG. - a #GtkPrintSettings + a #GtkPrintSettings - the media type + the media type - - Sets the value of %GTK_PRINT_SETTINGS_N_COPIES. + + Sets the value of %GTK_PRINT_SETTINGS_N_COPIES. - a #GtkPrintSettings + a #GtkPrintSettings - the number of copies + the number of copies - - Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. + + Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. - a #GtkPrintSettings + a #GtkPrintSettings - the number of pages per sheet + the number of pages per sheet - - Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. + + Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. - a #GtkPrintSettings + a #GtkPrintSettings - a #GtkNumberUpLayout value + a #GtkNumberUpLayout value - - Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION. + + Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION. - a #GtkPrintSettings + a #GtkPrintSettings - a page orientation + a page orientation - - Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. + + Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. - a #GtkPrintSettings + a #GtkPrintSettings - the output bin + the output bin - - Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. + + Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. - a #GtkPrintSettings + a #GtkPrintSettings - an array of #GtkPageRanges + an array of #GtkPageRanges - the length of @page_ranges + the length of @page_ranges - - Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET. + + Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET. - a #GtkPrintSettings + a #GtkPrintSettings - a #GtkPageSet value + a #GtkPageSet value - - Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT. + + Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT. - a #GtkPrintSettings + a #GtkPrintSettings - the paper height + the paper height - the units of @height + the units of @height - - Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, + + Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, %GTK_PRINT_SETTINGS_PAPER_WIDTH and %GTK_PRINT_SETTINGS_PAPER_HEIGHT. @@ -114761,81 +82289,55 @@ The set of media types is defined in PWG 5101.1-2002 PWG. - a #GtkPrintSettings + a #GtkPrintSettings - a paper size + a paper size - - Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH. + + Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH. - a #GtkPrintSettings + a #GtkPrintSettings - the paper width + the paper width - the units of @width + the units of @width - - Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. + + Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. - a #GtkPrintSettings + a #GtkPrintSettings - a #GtkPrintPages value + a #GtkPrintPages value - - Convenience function to set %GTK_PRINT_SETTINGS_PRINTER + + Convenience function to set %GTK_PRINT_SETTINGS_PRINTER to @printer. @@ -114843,75 +82345,51 @@ to @printer. - a #GtkPrintSettings + a #GtkPrintSettings - the printer name + the printer name - - Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. + + Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. - a #GtkPrintSettings + a #GtkPrintSettings - the resolution in lpi (lines per inch) + the resolution in lpi (lines per inch) - - Sets the value of %GTK_PRINT_SETTINGS_QUALITY. + + Sets the value of %GTK_PRINT_SETTINGS_QUALITY. - a #GtkPrintSettings + a #GtkPrintSettings - a #GtkPrintQuality value + a #GtkPrintQuality value - - Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, + + Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y. @@ -114920,25 +82398,17 @@ to @printer. - a #GtkPrintSettings + a #GtkPrintSettings - the resolution in dpi + the resolution in dpi - - Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, + + Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y. @@ -114947,194 +82417,128 @@ to @printer. - a #GtkPrintSettings + a #GtkPrintSettings - the horizontal resolution in dpi + the horizontal resolution in dpi - the vertical resolution in dpi + the vertical resolution in dpi - - Sets the value of %GTK_PRINT_SETTINGS_REVERSE. + + Sets the value of %GTK_PRINT_SETTINGS_REVERSE. - a #GtkPrintSettings + a #GtkPrintSettings - whether to reverse the output + whether to reverse the output - - Sets the value of %GTK_PRINT_SETTINGS_SCALE. + + Sets the value of %GTK_PRINT_SETTINGS_SCALE. - a #GtkPrintSettings + a #GtkPrintSettings - the scale in percent + the scale in percent - - Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR. + + Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR. - a #GtkPrintSettings + a #GtkPrintSettings - whether to use color + whether to use color - - This function saves the print settings from @settings to @file_name. If the + + This function saves the print settings from @settings to @file_name. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. - %TRUE on success + %TRUE on success - a #GtkPrintSettings + a #GtkPrintSettings - the file to save to + the file to save to - - Serialize print settings to an a{sv} variant. + + Serialize print settings to an a{sv} variant. - a new, floating, #GVariant + a new, floating, #GVariant - a #GtkPrintSettings + a #GtkPrintSettings - - This function adds the print settings from @settings to @key_file. + + This function adds the print settings from @settings to @key_file. - a #GtkPrintSettings + a #GtkPrintSettings - the #GKeyFile to save the print settings to + the #GKeyFile to save the print settings to - - the group to add the settings to in @key_file, or - %NULL to use the default “Print Settings” + + the group to add the settings to in @key_file, or + %NULL to use the default “Print Settings” - - Removes any value associated with @key. + + Removes any value associated with @key. This has the same effect as setting the value to %NULL. @@ -115142,15 +82546,11 @@ This has the same effect as setting the value to %NULL. - a #GtkPrintSettings + a #GtkPrintSettings - a key + a key @@ -115168,112 +82568,50 @@ This has the same effect as setting the value to %NULL. - + - - The status gives a rough indication of the completion of a running + + The status gives a rough indication of the completion of a running print operation. - - The printing has not started yet; this + + The printing has not started yet; this status is set initially, and while the print dialog is shown. - - This status is set while the begin-print + + This status is set while the begin-print signal is emitted and during pagination. - - This status is set while the + + This status is set while the pages are being rendered. - - The print job is being sent off to the + + The print job is being sent off to the printer. - - The print job has been sent to the printer, + + The print job has been sent to the printer, but is not printed for some reason, e.g. the printer may be stopped. - - Some problem has occurred during + + Some problem has occurred during printing, e.g. a paper jam. - - The printer is processing the print job. + + The printer is processing the print job. - - The printing has been completed successfully. + + The printing has been completed successfully. - - The printing has been aborted. + + The printing has been aborted. - - The #GtkProgressBar is typically used to display the progress of a long + + The #GtkProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The GtkProgressBar can be used in two different modes: percentage mode and activity mode. @@ -115300,9 +82638,9 @@ step size used in activity mode can be set. |[<!-- language="plain" --> progressbar[.osd] -├── [text] -╰── trough[.empty][.full] - ╰── progress[.pulse] +├── [text] +╰── trough[.empty][.full] + ╰── progress[.pulse] ]| GtkProgressBar has a main CSS node with name progressbar and subnodes with @@ -115317,153 +82655,106 @@ in overlays like the one Epiphany has for page loading progress. - Creates a new #GtkProgressBar. + Creates a new #GtkProgressBar. - a #GtkProgressBar. + a #GtkProgressBar. - - Returns the ellipsizing position of the progress bar. + + Returns the ellipsizing position of the progress bar. See gtk_progress_bar_set_ellipsize(). - #PangoEllipsizeMode + #PangoEllipsizeMode - a #GtkProgressBar + a #GtkProgressBar - Returns the current fraction of the task that’s been completed. + Returns the current fraction of the task that’s been completed. - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a #GtkProgressBar + a #GtkProgressBar - Gets the value set by gtk_progress_bar_set_inverted(). + Gets the value set by gtk_progress_bar_set_inverted(). - %TRUE if the progress bar is inverted + %TRUE if the progress bar is inverted - a #GtkProgressBar + a #GtkProgressBar - - Retrieves the pulse step set with gtk_progress_bar_set_pulse_step(). + + Retrieves the pulse step set with gtk_progress_bar_set_pulse_step(). - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a #GtkProgressBar + a #GtkProgressBar - - Gets the value of the #GtkProgressBar:show-text property. + + Gets the value of the #GtkProgressBar:show-text property. See gtk_progress_bar_set_show_text(). - %TRUE if text is shown in the progress bar + %TRUE if text is shown in the progress bar - a #GtkProgressBar + a #GtkProgressBar - Retrieves the text that is displayed with the progress bar, + Retrieves the text that is displayed with the progress bar, if any, otherwise %NULL. The return value is a reference to the text, not a copy of it, so will become invalid if you change the text in the progress bar. - text, or %NULL; this string is owned by the widget + text, or %NULL; this string is owned by the widget and should not be modified or freed. - a #GtkProgressBar + a #GtkProgressBar - Indicates that some progress has been made, but you don’t know how much. -Causes the progress bar to enter “activity mode,” where a block + Indicates that some progress has been made, but you don’t know how much. +Causes the progress bar to enter “activity mode,” where a block bounces back and forth. Each call to gtk_progress_bar_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by gtk_progress_bar_set_pulse_step()). @@ -115473,19 +82764,13 @@ per pulse is determined by gtk_progress_bar_set_pulse_step()). - a #GtkProgressBar + a #GtkProgressBar - - Sets the mode used to ellipsize (add an ellipsis: "...") the + + Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string. @@ -115493,23 +82778,17 @@ text if there is not enough space to render the entire string. - a #GtkProgressBar + a #GtkProgressBar - a #PangoEllipsizeMode + a #PangoEllipsizeMode - Causes the progress bar to “fill in” the given fraction + Causes the progress bar to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive. @@ -115518,23 +82797,17 @@ inclusive. - a #GtkProgressBar + a #GtkProgressBar - fraction of the task that’s been completed + fraction of the task that’s been completed - Progress bars normally grow from top to bottom or left to right. + Progress bars normally grow from top to bottom or left to right. Inverted progress bars grow in the opposite direction. @@ -115542,24 +82815,17 @@ Inverted progress bars grow in the opposite direction. - a #GtkProgressBar + a #GtkProgressBar - %TRUE to invert the progress bar + %TRUE to invert the progress bar - - Sets the fraction of total progress bar length to move the + + Sets the fraction of total progress bar length to move the bouncing block for each call to gtk_progress_bar_pulse(). @@ -115567,25 +82833,17 @@ bouncing block for each call to gtk_progress_bar_pulse(). - a #GtkProgressBar + a #GtkProgressBar - fraction between 0.0 and 1.0 + fraction between 0.0 and 1.0 - - Sets whether the progress bar will show text next to the bar. + + Sets whether the progress bar will show text next to the bar. The shown text is either the value of the #GtkProgressBar:text property or, if that is %NULL, the #GtkProgressBar:fraction value, as a percentage. @@ -115599,23 +82857,17 @@ text (even if the actual text is blank), set #GtkProgressBar:show-text to - a #GtkProgressBar + a #GtkProgressBar - whether to show text + whether to show text - Causes the given @text to appear next to the progress bar. + Causes the given @text to appear next to the progress bar. If @text is %NULL and #GtkProgressBar:show-text is %TRUE, the current value of #GtkProgressBar:fraction will be displayed as a percentage. @@ -115631,29 +82883,17 @@ be styled and sized suitably for containing text, as long as - a #GtkProgressBar + a #GtkProgressBar - - a UTF-8 string, or %NULL + + a UTF-8 string, or %NULL - - The preferred place to ellipsize the string, if the progress bar does + + The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, specified as a #PangoEllipsizeMode. @@ -115672,13 +82912,8 @@ progress bar's width is gtk_widget_set_size_request(). - - Sets whether the progress bar will show a text in addition + + Sets whether the progress bar will show a text in addition to the bar itself. The shown text is either the value of the #GtkProgressBar:text property or, if that is %NULL, the #GtkProgressBar:fraction value, as a percentage. @@ -115699,43 +82934,27 @@ to the empty string (not %NULL). - - + + - + - - + + - - + + - + @@ -115773,224 +82992,154 @@ to the empty string (not %NULL). - + - - Describes the stage at which events are fed into a #GtkEventController. - - Events are not delivered automatically. Those can be + + Describes the stage at which events are fed into a #GtkEventController. + + Events are not delivered automatically. Those can be manually fed through gtk_event_controller_handle_event(). This should only be used when full control about when, or whether the controller handles the event is needed. - - Events are delivered in the capture phase. The + + Events are delivered in the capture phase. The capture phase happens before the bubble phase, runs from the toplevel down to the event widget. This option should only be used on containers that might possibly handle events before their children do. - - Events are delivered in the bubble phase. The bubble + + Events are delivered in the bubble phase. The bubble phase happens after the capture phase, and before the default handlers are run. This phase runs from the event widget, up to the toplevel. - - Events are delivered in the default widget event handlers, + + Events are delivered in the default widget event handlers, note that widget implementations must chain up on button, motion, touch and grab broken handlers for controllers in this phase to be run. - + - + - + - + - - + + - - + + - - + + - + - + - + - - + + - - + + - - + + - + - + - + - + - + @@ -116004,368 +83153,266 @@ to the empty string (not %NULL). - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - - A #GtkRadioAction is similar to #GtkRadioMenuItem. A number of radio + + A #GtkRadioAction is similar to #GtkRadioMenuItem. A number of radio actions can be linked together so that only one may be active at any one time. - - Creates a new #GtkRadioAction object. To add the action to + + Creates a new #GtkRadioAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). - a new #GtkRadioAction + a new #GtkRadioAction - A unique name for the action + A unique name for the action - - The label displayed in menu items and on buttons, + + The label displayed in menu items and on buttons, or %NULL - - A tooltip for this action, or %NULL + + A tooltip for this action, or %NULL - - The stock icon to display in widgets representing + + The stock icon to display in widgets representing this action, or %NULL - The value which gtk_radio_action_get_current_value() should + The value which gtk_radio_action_get_current_value() should return if this action is selected. @@ -116385,39 +83432,23 @@ call gtk_action_group_add_action_with_accel(). - - Obtains the value property of the currently active member of + + Obtains the value property of the currently active member of the group to which @action belongs. - The value of the currently active group member + The value of the currently active group member - a #GtkRadioAction + a #GtkRadioAction - - Returns the list representing the radio group for this object. + + Returns the list representing the radio group for this object. Note that the returned list is only valid until the next change to the group. @@ -116436,30 +83467,20 @@ A common way to set up a group of radio group is the following: ]| - the list representing the radio group for this object + the list representing the radio group for this object - the action object + the action object - - Joins a radio action object to the group of another radio action object. + + Joins a radio action object to the group of another radio action object. Use this in language bindings instead of the gtk_radio_action_get_group() and gtk_radio_action_set_group() methods @@ -116483,31 +83504,18 @@ A common way to set up a group of radio actions is the following: - the action object + the action object - - a radio action object whos group we are + + a radio action object whos group we are joining, or %NULL to remove the radio action from its group - - Sets the currently active group member to the member with value + + Sets the currently active group member to the member with value property @current_value. @@ -116515,84 +83523,45 @@ property @current_value. - a #GtkRadioAction + a #GtkRadioAction - the new value + the new value - - Sets the radio group for the radio action object. + + Sets the radio group for the radio action object. - the action object + the action object - - a list representing a radio group, or %NULL + + a list representing a radio group, or %NULL - - The value property of the currently active member of the group to which + + The value property of the currently active member of the group to which this action belongs. - - Sets a new group for a radio action. + + Sets a new group for a radio action. - - The value is an arbitrary integer which can be used as a + + The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an ::activate or ::changed signal handler. See gtk_radio_action_get_current_value() and #GtkRadioActionEntry @@ -116605,15 +83574,8 @@ for convenient ways to get and set this property. - - The ::changed signal is emitted on every member of a radio group when the + + The ::changed signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the ::activate signals for the previous and current active members. @@ -116621,25 +83583,20 @@ for the previous and current active members. - the member of @action's group which has just been activated + the member of @action's group which has just been activated - + - + @@ -116655,8 +83612,7 @@ for the previous and current active members. - + @@ -116664,8 +83620,7 @@ for the previous and current active members. - + @@ -116673,8 +83628,7 @@ for the previous and current active members. - + @@ -116682,80 +83636,52 @@ for the previous and current active members. - + - - #GtkRadioActionEntry structs are used with + + #GtkRadioActionEntry structs are used with gtk_action_group_add_radio_actions() to construct groups of radio actions. - The name of the action. + The name of the action. - The stock id for the action, or the name of an icon from the + The stock id for the action, or the name of an icon from the icon theme. - The label for the action. This field should typically be marked + The label for the action. This field should typically be marked for translation, see gtk_action_group_set_translation_domain(). - The accelerator for the action, in the format understood by + The accelerator for the action, in the format understood by gtk_accelerator_parse(). - The tooltip for the action. This field should typically be + The tooltip for the action. This field should typically be marked for translation, see gtk_action_group_set_translation_domain(). - The value to set on the radio action. See + The value to set on the radio action. See gtk_radio_action_get_current_value(). - + - - A single radio button performs the same basic function as a #GtkCheckButton, + + A single radio button performs the same basic function as a #GtkCheckButton, as its position in the object hierarchy reflects. It is only when multiple radio buttons are grouped together that they become a different user interface component in their own right. @@ -116788,8 +83714,8 @@ itself and its list item when it is destroyed. |[<!-- language="plain" --> radiobutton -├── radio -╰── <child> +├── radio +╰── <child> ]| A GtkRadioButton with indicator (see gtk_toggle_button_set_mode()) has a @@ -116797,8 +83723,8 @@ main CSS node with name radiobutton and a subnode with name radio. |[<!-- language="plain" --> button.radio -├── radio -╰── <child> +├── radio +╰── <child> ]| A GtkRadioButton without indicator changes the name of its main node @@ -116823,7 +83749,7 @@ void create_radio_buttons (void) { // Create a radio button with a label radio2 = gtk_radio_button_new_with_label_from_widget (GTK_RADIO_BUTTON (radio1), - "I’m the second radio button."); + "I’m the second radio button."); // Pack them into a box, then show all the widgets gtk_box_pack_start (GTK_BOX (box), radio1); @@ -116845,25 +83771,16 @@ can be used to determine if the button has been selected or deselected. - Creates a new #GtkRadioButton. To be of any practical value, a widget should + Creates a new #GtkRadioButton. To be of any practical value, a widget should then be packed into the radio button. - a new radio button + a new radio button - - an existing + + an existing radio button group, or %NULL if you are creating a new group. @@ -116871,161 +83788,103 @@ then be packed into the radio button. - - Creates a new #GtkRadioButton, adding it to the same group as + + Creates a new #GtkRadioButton, adding it to the same group as @radio_group_member. As with gtk_radio_button_new(), a widget should be packed into the radio button. - a new radio button. + a new radio button. - - an existing #GtkRadioButton. + + an existing #GtkRadioButton. - - Creates a new #GtkRadioButton with a text label. + + Creates a new #GtkRadioButton with a text label. - a new radio button. + a new radio button. - - an existing + + an existing radio button group, or %NULL if you are creating a new group. - the text label to display next to the radio button. + the text label to display next to the radio button. - - Creates a new #GtkRadioButton with a text label, adding it to + + Creates a new #GtkRadioButton with a text label, adding it to the same group as @radio_group_member. - a new radio button. + a new radio button. - - widget to get radio group from or %NULL + + widget to get radio group from or %NULL - a text string to display next to the radio button. + a text string to display next to the radio button. - - Creates a new #GtkRadioButton containing a label, adding it to the same + + Creates a new #GtkRadioButton containing a label, adding it to the same group as @group. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the button. - a new #GtkRadioButton + a new #GtkRadioButton - - the radio button + + the radio button group, or %NULL - the text of the button, with an underscore in front of the + the text of the button, with an underscore in front of the mnemonic character - - Creates a new #GtkRadioButton containing a label. The label + + Creates a new #GtkRadioButton containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the button. - a new #GtkRadioButton + a new #GtkRadioButton - - widget to get radio group from or %NULL + + widget to get radio group from or %NULL - the text of the button, with an underscore in front of the + the text of the button, with an underscore in front of the mnemonic character @@ -117043,14 +83902,10 @@ in @label indicate the mnemonic for the button. - Retrieves the group assigned to a radio button. + Retrieves the group assigned to a radio button. - a linked list + a linked list containing all the radio buttons in the same group as @radio_button. The returned list is owned by the radio button and must not be modified or freed. @@ -117060,19 +83915,13 @@ and must not be modified or freed. - a #GtkRadioButton. + a #GtkRadioButton. - - Joins a #GtkRadioButton object to the group of another #GtkRadioButton object + + Joins a #GtkRadioButton object to the group of another #GtkRadioButton object Use this in language bindings instead of the gtk_radio_button_get_group() and gtk_radio_button_set_group() methods @@ -117096,27 +83945,18 @@ A common way to set up a group of radio buttons is the following: - the #GtkRadioButton object + the #GtkRadioButton object - - a radio button object whos group we are + + a radio button object whos group we are joining, or %NULL to remove the radio button from its group - Sets a #GtkRadioButton’s group. It should be noted that this does not change + Sets a #GtkRadioButton’s group. It should be noted that this does not change the layout of your interface in any way, so if you are changing the group, it is likely you will need to re-arrange the user interface to reflect these changes. @@ -117126,18 +83966,11 @@ changes. - a #GtkRadioButton. + a #GtkRadioButton. - - an existing radio + + an existing radio button group, such as one returned from gtk_radio_button_get_group(), or %NULL. @@ -117145,13 +83978,8 @@ changes. - - Sets a new group for a radio button. + + Sets a new group for a radio button. @@ -117161,9 +83989,7 @@ changes. - Emitted when the group of radio buttons that a radio button belongs + Emitted when the group of radio buttons that a radio button belongs to changes. This is emitted when a radio button switches from being alone to being part of a group of 2 or more buttons, or vice-versa, and when a button is moved from one group of 2 or @@ -117174,46 +84000,28 @@ of the group that a button belongs to changes. - - + + - + - + - - + + - + - - + + - + @@ -117264,21 +84072,11 @@ of the group that a button belongs to changes. - + - - A radio menu item is a check menu item that belongs to a group. At each + + A radio menu item is a check menu item that belongs to a group. At each instant exactly one of the radio menu items from a group is selected. The group list does not need to be freed, as each #GtkRadioMenuItem will @@ -117307,8 +84105,8 @@ for (i = 0; i < 5; i++) |[<!-- language="plain" --> menuitem -├── radio.left -╰── <child> +├── radio.left +╰── <child> ]| GtkRadioMenuItem has a main CSS node with name menuitem, and a subnode @@ -117319,24 +84117,15 @@ with name radio, which gets the .left or .right style class. - Creates a new #GtkRadioMenuItem. + Creates a new #GtkRadioMenuItem. - a new #GtkRadioMenuItem + a new #GtkRadioMenuItem - - the group to which the + + the group to which the radio menu item is to be attached, or %NULL @@ -117344,169 +84133,102 @@ with name radio, which gets the .left or .right style class. - - Creates a new #GtkRadioMenuItem adding it to the same group as @group. + + Creates a new #GtkRadioMenuItem adding it to the same group as @group. - The new #GtkRadioMenuItem + The new #GtkRadioMenuItem - - An existing #GtkRadioMenuItem + + An existing #GtkRadioMenuItem - - Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel. + + Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel. - A new #GtkRadioMenuItem + A new #GtkRadioMenuItem - - + + group the radio menu item is inside, or %NULL - the text for the label + the text for the label - - Creates a new GtkRadioMenuItem whose child is a simple GtkLabel. + + Creates a new GtkRadioMenuItem whose child is a simple GtkLabel. The new #GtkRadioMenuItem is added to the same group as @group. - The new #GtkRadioMenuItem + The new #GtkRadioMenuItem - - an existing #GtkRadioMenuItem + + an existing #GtkRadioMenuItem - - the text for the label + + the text for the label - - Creates a new #GtkRadioMenuItem containing a label. The label + + Creates a new #GtkRadioMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the menu item. - a new #GtkRadioMenuItem + a new #GtkRadioMenuItem - - + + group the radio menu item is inside, or %NULL - the text of the button, with an underscore in front of the + the text of the button, with an underscore in front of the mnemonic character - - Creates a new GtkRadioMenuItem containing a label. The label will be + + Creates a new GtkRadioMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the menu item. The new #GtkRadioMenuItem is added to the same group as @group. - The new #GtkRadioMenuItem + The new #GtkRadioMenuItem - - An existing #GtkRadioMenuItem + + An existing #GtkRadioMenuItem - - the text of the button, with an underscore in front of the + + the text of the button, with an underscore in front of the mnemonic character @@ -117524,15 +84246,11 @@ The new #GtkRadioMenuItem is added to the same group as @group. - Returns the group to which the radio menu item belongs, as a #GList of + Returns the group to which the radio menu item belongs, as a #GList of #GtkRadioMenuItem. The list belongs to GTK+ and should not be freed. - the group + the group of @radio_menu_item @@ -117540,19 +84258,13 @@ The new #GtkRadioMenuItem is added to the same group as @group. - a #GtkRadioMenuItem + a #GtkRadioMenuItem - - Joins a #GtkRadioMenuItem object to the group of another #GtkRadioMenuItem + + Joins a #GtkRadioMenuItem object to the group of another #GtkRadioMenuItem object. This function should be used by language bindings to avoid the memory @@ -117580,18 +84292,11 @@ A common way to set up a group of #GtkRadioMenuItem instances is: - a #GtkRadioMenuItem + a #GtkRadioMenuItem - - a #GtkRadioMenuItem whose group we are + + a #GtkRadioMenuItem whose group we are joining, or %NULL to remove the @radio_menu_item from its current group @@ -117599,41 +84304,26 @@ A common way to set up a group of #GtkRadioMenuItem instances is: - Sets the group of a radio menu item, or changes it. + Sets the group of a radio menu item, or changes it. - a #GtkRadioMenuItem. + a #GtkRadioMenuItem. - - the new group, or %NULL. + + the new group, or %NULL. - - The radio menu item whose group this widget belongs to. + + The radio menu item whose group this widget belongs to. @@ -117648,46 +84338,28 @@ A common way to set up a group of #GtkRadioMenuItem instances is: - - + + - + - + - - + + - + - - + + - + @@ -117738,21 +84410,11 @@ A common way to set up a group of #GtkRadioMenuItem instances is: - + - - A #GtkRadioToolButton is a #GtkToolItem that contains a radio button, + + A #GtkRadioToolButton is a #GtkToolItem that contains a radio button, that is, a button that is part of a group of toggle buttons where only one button can be active at a time. @@ -117768,27 +84430,16 @@ GtkRadioToolButton has a single CSS node with name toolbutton. - - Creates a new #GtkRadioToolButton, adding it to @group. + + Creates a new #GtkRadioToolButton, adding it to @group. - The new #GtkRadioToolButton + The new #GtkRadioToolButton - - An + + An existing radio button group, or %NULL if you are creating a new group @@ -117796,177 +84447,109 @@ GtkRadioToolButton has a single CSS node with name toolbutton. - - Creates a new #GtkRadioToolButton, adding it to @group. + + Creates a new #GtkRadioToolButton, adding it to @group. The new #GtkRadioToolButton will contain an icon and label from the stock item indicated by @stock_id. Use gtk_radio_tool_button_new() instead. - The new #GtkRadioToolButton + The new #GtkRadioToolButton - - an existing radio button + + an existing radio button group, or %NULL if you are creating a new group - the name of a stock item + the name of a stock item - - Creates a new #GtkRadioToolButton adding it to the same group as @gruup + + Creates a new #GtkRadioToolButton adding it to the same group as @gruup - The new #GtkRadioToolButton + The new #GtkRadioToolButton - - An existing #GtkRadioToolButton, or %NULL + + An existing #GtkRadioToolButton, or %NULL - - Creates a new #GtkRadioToolButton adding it to the same group as @group. + + Creates a new #GtkRadioToolButton adding it to the same group as @group. The new #GtkRadioToolButton will contain an icon and label from the stock item indicated by @stock_id. gtk_radio_tool_button_new_from_widget - A new #GtkRadioToolButton + A new #GtkRadioToolButton - - An existing #GtkRadioToolButton. + + An existing #GtkRadioToolButton. - the name of a stock item + the name of a stock item - - Returns the radio button group @button belongs to. + + Returns the radio button group @button belongs to. - The group @button belongs to. + The group @button belongs to. - a #GtkRadioToolButton + a #GtkRadioToolButton - - Adds @button to @group, removing it from the group it belonged to before. + + Adds @button to @group, removing it from the group it belonged to before. - a #GtkRadioToolButton + a #GtkRadioToolButton - - an existing radio button group, or %NULL + + an existing radio button group, or %NULL - - Sets a new group for a radio tool button. + + Sets a new group for a radio tool button. - + @@ -118004,23 +84587,14 @@ stock item indicated by @stock_id. - - #GtkRange is the common base class for widgets which visualize an + + #GtkRange is the common base class for widgets which visualize an adjustment, e.g #GtkScale or #GtkScrollbar. Apart from signals for monitoring the parameters of the adjustment, #GtkRange provides properties and methods for influencing the sensitivity -of the “steppers”. It also provides properties and methods for setting a -“fill level” on range widgets. See gtk_range_set_fill_level(). +of the “steppers”. It also provides properties and methods for setting a +“fill level” on range widgets. See gtk_range_set_fill_level(). @@ -118116,149 +84690,99 @@ of the “steppers”. It also provides properties and methods for setting a - Get the #GtkAdjustment which is the “model” object for #GtkRange. + Get the #GtkAdjustment which is the “model” object for #GtkRange. See gtk_range_set_adjustment() for details. The return value does not have a reference added, so should not be unreferenced. - a #GtkAdjustment + a #GtkAdjustment - a #GtkRange + a #GtkRange - - Gets the current position of the fill level indicator. + + Gets the current position of the fill level indicator. - The current fill level + The current fill level - A #GtkRange + A #GtkRange - - Gets the value set by gtk_range_set_flippable(). + + Gets the value set by gtk_range_set_flippable(). - %TRUE if the range is flippable + %TRUE if the range is flippable - a #GtkRange + a #GtkRange - Gets the value set by gtk_range_set_inverted(). + Gets the value set by gtk_range_set_inverted(). - %TRUE if the range is inverted + %TRUE if the range is inverted - a #GtkRange + a #GtkRange - - Gets the sensitivity policy for the stepper that points to the -'lower' end of the GtkRange’s adjustment. + + Gets the sensitivity policy for the stepper that points to the +'lower' end of the GtkRange’s adjustment. - The lower stepper’s sensitivity policy. + The lower stepper’s sensitivity policy. - a #GtkRange + a #GtkRange - - This function is useful mainly for #GtkRange subclasses. + + This function is useful mainly for #GtkRange subclasses. See gtk_range_set_min_slider_size(). Use the min-height/min-width CSS properties on the slider node. - The minimum size of the range’s slider. + The minimum size of the range’s slider. - a #GtkRange + a #GtkRange - - This function returns the area that contains the range’s trough + + This function returns the area that contains the range’s trough and its steppers, in widget->window coordinates. This function is useful mainly for #GtkRange subclasses. @@ -118268,95 +84792,60 @@ This function is useful mainly for #GtkRange subclasses. - a #GtkRange + a #GtkRange - - return location for the range rectangle + + return location for the range rectangle - - Gets whether the range is restricted to the fill level. + + Gets whether the range is restricted to the fill level. - %TRUE if @range is restricted to the fill level. + %TRUE if @range is restricted to the fill level. - A #GtkRange + A #GtkRange - - Gets the number of digits to round the value to when + + Gets the number of digits to round the value to when it changes. See #GtkRange::change-value. - the number of digits to round to + the number of digits to round to - a #GtkRange + a #GtkRange - - Gets whether the range displays the fill level graphically. + + Gets whether the range displays the fill level graphically. - %TRUE if @range shows the fill level. + %TRUE if @range shows the fill level. - A #GtkRange + A #GtkRange - - This function returns sliders range along the long dimension, + + This function returns sliders range along the long dimension, in widget->window coordinates. This function is useful mainly for #GtkRange subclasses. @@ -118366,108 +84855,68 @@ This function is useful mainly for #GtkRange subclasses. - a #GtkRange + a #GtkRange - - return location for the slider's + + return location for the slider's start, or %NULL - - return location for the slider's + + return location for the slider's end, or %NULL - - This function is useful mainly for #GtkRange subclasses. + + This function is useful mainly for #GtkRange subclasses. See gtk_range_set_slider_size_fixed(). - whether the range’s slider has a fixed size. + whether the range’s slider has a fixed size. - a #GtkRange + a #GtkRange - - Gets the sensitivity policy for the stepper that points to the -'upper' end of the GtkRange’s adjustment. + + Gets the sensitivity policy for the stepper that points to the +'upper' end of the GtkRange’s adjustment. - The upper stepper’s sensitivity policy. + The upper stepper’s sensitivity policy. - a #GtkRange + a #GtkRange - Gets the current value of the range. + Gets the current value of the range. - current value of the range. + current value of the range. - a #GtkRange + a #GtkRange - Sets the adjustment to be used as the “model” object for this range + Sets the adjustment to be used as the “model” object for this range widget. The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size @@ -118480,38 +84929,30 @@ The page size affects the size of the scrollbar slider. - a #GtkRange + a #GtkRange - a #GtkAdjustment + a #GtkAdjustment - - Set the new position of the fill level indicator. + + Set the new position of the fill level indicator. -The “fill level” is probably best described by its most prominent +The “fill level” is probably best described by its most prominent use case, which is an indicator for the amount of pre-buffering in a streaming media player. In that use case, the value of the range would indicate the current play position, and the fill level would be the position up to which the file/stream has been downloaded. -This amount of prebuffering can be displayed on the range’s trough +This amount of prebuffering can be displayed on the range’s trough and is themeable separately from the trough. To enable fill level display, use gtk_range_set_show_fill_level(). The range defaults to not showing the fill level. -Additionally, it’s possible to restrict the range’s slider position +Additionally, it’s possible to restrict the range’s slider position to values which are smaller than the fill level. This is controller by gtk_range_set_restrict_to_fill_level() and is by default enabled. @@ -118521,25 +84962,17 @@ enabled. - a #GtkRange + a #GtkRange - the new position of the fill level indicator + the new position of the fill level indicator - - If a range is flippable, it will switch its direction if it is + + If a range is flippable, it will switch its direction if it is horizontal and its direction is %GTK_TEXT_DIR_RTL. See gtk_widget_get_direction(). @@ -118549,23 +84982,17 @@ See gtk_widget_get_direction(). - a #GtkRange + a #GtkRange - %TRUE to make the range flippable + %TRUE to make the range flippable - Sets the step and page sizes for the range. + Sets the step and page sizes for the range. The step size is used when the user clicks the #GtkScrollbar arrows or moves #GtkScale via arrow keys. The page size is used for example when moving via Page Up or Page Down keys. @@ -118575,29 +85002,21 @@ is used for example when moving via Page Up or Page Down keys. - a #GtkRange + a #GtkRange - step size + step size - page size + page size - Ranges normally move from lower to higher values as the + Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the right rather than on the bottom or left. @@ -118607,53 +85026,35 @@ on the bottom or left. - a #GtkRange + a #GtkRange - %TRUE to invert the range + %TRUE to invert the range - - Sets the sensitivity policy for the stepper that points to the -'lower' end of the GtkRange’s adjustment. + + Sets the sensitivity policy for the stepper that points to the +'lower' end of the GtkRange’s adjustment. - a #GtkRange + a #GtkRange - the lower stepper’s sensitivity policy. + the lower stepper’s sensitivity policy. - - Sets the minimum size of the range’s slider. + + Sets the minimum size of the range’s slider. This function is useful mainly for #GtkRange subclasses. Use the min-height/min-width CSS properties on the slider @@ -118664,23 +85065,17 @@ This function is useful mainly for #GtkRange subclasses. - a #GtkRange + a #GtkRange - The slider’s minimum size + The slider’s minimum size - Sets the allowable values in the #GtkRange, and clamps the range + Sets the allowable values in the #GtkRange, and clamps the range value to be between @min and @max. (If the range has a non-zero page size, it is clamped between @min and @max - page-size.) @@ -118689,31 +85084,21 @@ page size, it is clamped between @min and @max - page-size.) - a #GtkRange + a #GtkRange - minimum range value + minimum range value - maximum range value + maximum range value - - Sets whether the slider is restricted to the fill level. See + + Sets whether the slider is restricted to the fill level. See gtk_range_set_fill_level() for a general description of the fill level concept. @@ -118722,25 +85107,17 @@ level concept. - A #GtkRange + A #GtkRange - Whether the fill level restricts slider movement. + Whether the fill level restricts slider movement. - - Sets the number of digits to round the value to when + + Sets the number of digits to round the value to when it changes. See #GtkRange::change-value. @@ -118748,25 +85125,17 @@ it changes. See #GtkRange::change-value. - a #GtkRange + a #GtkRange - the precision in digits, or -1 + the precision in digits, or -1 - - Sets whether a graphical fill level is show on the trough. See + + Sets whether a graphical fill level is show on the trough. See gtk_range_set_fill_level() for a general description of the fill level concept. @@ -118775,26 +85144,18 @@ level concept. - A #GtkRange + A #GtkRange - Whether a fill level indicator graphics is shown. + Whether a fill level indicator graphics is shown. - - Sets whether the range’s slider has a fixed size, or a size that -depends on its adjustment’s page size. + + Sets whether the range’s slider has a fixed size, or a size that +depends on its adjustment’s page size. This function is useful mainly for #GtkRange subclasses. @@ -118803,49 +85164,35 @@ This function is useful mainly for #GtkRange subclasses. - a #GtkRange + a #GtkRange - %TRUE to make the slider size constant + %TRUE to make the slider size constant - - Sets the sensitivity policy for the stepper that points to the -'upper' end of the GtkRange’s adjustment. + + Sets the sensitivity policy for the stepper that points to the +'upper' end of the GtkRange’s adjustment. - a #GtkRange + a #GtkRange - the upper stepper’s sensitivity policy. + the upper stepper’s sensitivity policy. - Sets the current value of the range; if the value is outside the + Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the #GtkRange::value-changed signal if the value changes. @@ -118855,78 +85202,47 @@ value changes. - a #GtkRange + a #GtkRange - new value of the range + new value of the range - + - - The fill level (e.g. prebuffering of a network stream). + + The fill level (e.g. prebuffering of a network stream). See gtk_range_set_fill_level(). - + - - The restrict-to-fill-level property controls whether slider + + The restrict-to-fill-level property controls whether slider movement is restricted to an upper boundary set by the fill level. See gtk_range_set_restrict_to_fill_level(). - - The number of digits to round the value to when + + The number of digits to round the value to when it changes, or -1. See #GtkRange::change-value. - - The show-fill-level property controls whether fill level indicator + + The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. See gtk_range_set_show_fill_level(). - + @@ -118936,26 +85252,20 @@ gtk_range_set_show_fill_level(). - Emitted before clamping a value, to give the application a + Emitted before clamping a value, to give the application a chance to adjust the bounds. - the value before we clamp + the value before we clamp - The #GtkRange::change-value signal is emitted when a scroll action is + The #GtkRange::change-value signal is emitted when a scroll action is performed on a range. It allows an application to determine the type of scroll event that occurred and the resultant new value. The application can handle the event itself and return %TRUE to @@ -118968,59 +85278,41 @@ the GtkRange::change-value signal is responsible for clamping the value to the desired number of decimal digits; the default GTK+ handler clamps the value based on #GtkRange:round-digits. - %TRUE to prevent other handlers from being invoked for + %TRUE to prevent other handlers from being invoked for the signal, %FALSE to propagate the signal further - the type of scroll action that was performed + the type of scroll action that was performed - the new value resulting from the scroll action + the new value resulting from the scroll action - Virtual function that moves the slider. Used for keybindings. + Virtual function that moves the slider. Used for keybindings. - how to move the slider + how to move the slider - Emitted when the range value changes. + Emitted when the range value changes. - + @@ -119028,26 +85320,19 @@ handler clamps the value based on #GtkRange:round-digits. - + - + - + - + @@ -119191,112 +85476,70 @@ handler clamps the value based on #GtkRange:round-digits. - - Deprecated + + Deprecated - Deprecated + Deprecated - Deprecated + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - Deprecated + Deprecated - quark-ified type identifier + quark-ified type identifier - quark-ified property identifier like - “GtkScrollbar::spacing” + quark-ified property identifier like + “GtkScrollbar::spacing” - field similar to one found in #GtkSettingsValue + field similar to one found in #GtkSettingsValue - field similar to one found in #GtkSettingsValue + field similar to one found in #GtkSettingsValue - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses borders in the form `"{ left, right, top, bottom }"` for integers left, right, top and bottom. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GtkBorder. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold boxed values. + a #GValue which must hold boxed values. - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a color given either by its name or in the form `{ red, green, blue }` where red, green and @@ -119304,37 +85547,27 @@ blue are integers between 0 and 65535 or floating-point numbers between 0 and 1. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GdkColor. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold #GdkColor values. + a #GValue which must hold #GdkColor values. - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a single enumeration value. @@ -119343,37 +85576,27 @@ its numeric value. For consistency with flags parsing, the value may be surrounded by parentheses. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GEnumValue. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold enum values. + a #GValue which must hold enum values. - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses flags. Flags can be specified by their name, their nickname or @@ -119381,66 +85604,47 @@ numerically. Multiple flags can be specified in the form `"( flag1 | flag2 | ... )"`. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting flags value. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold flags values. + a #GValue which must hold flags values. - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a requisition in the form `"{ width, height }"` for integers %width and %height. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GtkRequisition. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold boxed values. + a #GValue which must hold boxed values. @@ -119463,34 +85667,19 @@ has been set to the resulting #GtkRequisition. - - The #GtkRcStyle-struct is used to represent a set + + The #GtkRcStyle-struct is used to represent a set of information about the appearance of a widget. This can later be composited together with other #GtkRcStyle-struct<!-- -->s to form a #GtkStyle. - - Creates a new #GtkRcStyle with no fields set and + + Creates a new #GtkRcStyle with no fields set and a reference count of 1. Use #GtkCssProvider instead. - the newly-created #GtkRcStyle + the newly-created #GtkRcStyle @@ -119547,28 +85736,19 @@ a reference count of 1. - - Makes a copy of the specified #GtkRcStyle. This function + + Makes a copy of the specified #GtkRcStyle. This function will correctly copy an RC style that is a member of a class derived from #GtkRcStyle. Use #GtkCssProvider instead. - the resulting #GtkRcStyle + the resulting #GtkRcStyle - the style to copy + the style to copy @@ -119577,75 +85757,55 @@ derived from #GtkRcStyle. - Name + Name - Pixmap name + Pixmap name - A #PangoFontDescription + A #PangoFontDescription - #GtkRcFlags + #GtkRcFlags - Foreground colors + Foreground colors - Background colors + Background colors - Text colors + Text colors - Base colors + Base colors - X thickness + X thickness - Y thickness + Y thickness @@ -119667,14 +85827,10 @@ derived from #GtkRcStyle. - + - The parent class. + The parent class. @@ -119771,350 +85927,135 @@ derived from #GtkRcStyle. - - The #GtkRcTokenType enumeration represents the tokens + + The #GtkRcTokenType enumeration represents the tokens in the RC file. It is exposed so that theme engines can reuse these tokens when parsing the theme-engine specific portions of a RC file. Use #GtkCssProvider instead. - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - Deprecated + + Deprecated - - A #GtkRecentAction represents a list of recently used files, which + + A #GtkRecentAction represents a list of recently used files, which can be shown by widgets such as #GtkRecentChooserDialog or #GtkRecentChooserMenu. @@ -120125,192 +86066,107 @@ action for a <toolitem> element. - - Creates a new #GtkRecentAction object. To add the action to + + Creates a new #GtkRecentAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). - + - the newly created #GtkRecentAction. + the newly created #GtkRecentAction. - a unique name for the action + a unique name for the action - - the label displayed in menu items and on buttons, + + the label displayed in menu items and on buttons, or %NULL - - a tooltip for the action, or %NULL + + a tooltip for the action, or %NULL - - the stock icon to display in widgets representing + + the stock icon to display in widgets representing the action, or %NULL - - Creates a new #GtkRecentAction object. To add the action to + + Creates a new #GtkRecentAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). - + - the newly created #GtkRecentAction + the newly created #GtkRecentAction - a unique name for the action + a unique name for the action - - the label displayed in menu items and on buttons, + + the label displayed in menu items and on buttons, or %NULL - - a tooltip for the action, or %NULL + + a tooltip for the action, or %NULL - - the stock icon to display in widgets representing + + the stock icon to display in widgets representing the action, or %NULL - - a #GtkRecentManager, or %NULL for using the default + + a #GtkRecentManager, or %NULL for using the default #GtkRecentManager - - Returns the value set by gtk_recent_chooser_menu_set_show_numbers(). - + + Returns the value set by gtk_recent_chooser_menu_set_show_numbers(). + - %TRUE if numbers should be shown. + %TRUE if numbers should be shown. - a #GtkRecentAction + a #GtkRecentAction - - Sets whether a number should be added to the items shown by the + + Sets whether a number should be added to the items shown by the widgets representing @action. The numbers are shown to provide a unique character for a mnemonic to be used inside the menu item's label. Only the first ten items get a number to avoid clashes. - + - a #GtkRecentAction + a #GtkRecentAction - %TRUE if the shown items should be numbered + %TRUE if the shown items should be numbered - - Whether the items should be displayed with a number. + + Whether the items should be displayed with a number. @@ -120320,17 +86176,14 @@ label. Only the first ten items get a number to avoid clashes. - + - + @@ -120338,8 +86191,7 @@ label. Only the first ten items get a number to avoid clashes. - + @@ -120347,8 +86199,7 @@ label. Only the first ten items get a number to avoid clashes. - + @@ -120356,28 +86207,18 @@ label. Only the first ten items get a number to avoid clashes. - + - + - - #GtkRecentChooser is an interface that can be implemented by widgets + + #GtkRecentChooser is an interface that can be implemented by widgets displaying the list of recently used files. In GTK+, the main objects that implement this interface are #GtkRecentChooserWidget, #GtkRecentChooserDialog and #GtkRecentChooserMenu. @@ -120385,9 +86226,7 @@ that implement this interface are #GtkRecentChooserWidget, Recently used files are supported since GTK+ 2.10. - Adds @filter to the list of #GtkRecentFilter objects held by @chooser. + Adds @filter to the list of #GtkRecentFilter objects held by @chooser. If no previous filter objects were defined, this function will call gtk_recent_chooser_set_filter(). @@ -120397,53 +86236,37 @@ gtk_recent_chooser_set_filter(). - a #GtkRecentChooser + a #GtkRecentChooser - a #GtkRecentFilter + a #GtkRecentFilter - - Gets the URI currently selected by @chooser. + + Gets the URI currently selected by @chooser. - a newly allocated string holding a URI. + a newly allocated string holding a URI. - a #GtkRecentChooser + a #GtkRecentChooser - Gets the list of recently used resources in form of #GtkRecentInfo objects. + Gets the list of recently used resources in form of #GtkRecentInfo objects. -The return value of this function is affected by the “sort-type” and -“limit” properties of @chooser. +The return value of this function is affected by the “sort-type” and +“limit” properties of @chooser. - A newly allocated + A newly allocated list of #GtkRecentInfo objects. You should use gtk_recent_info_unref() on every item of the list, and then free the list itself using g_list_free(). @@ -120453,9 +86276,7 @@ The return value of this function is affected by the “sort-type” and - a #GtkRecentChooser + a #GtkRecentChooser @@ -120482,17 +86303,11 @@ The return value of this function is affected by the “sort-type” and - - Gets the #GtkRecentFilter objects held by @chooser. + + Gets the #GtkRecentFilter objects held by @chooser. - A singly linked list + A singly linked list of #GtkRecentFilter objects. You should just free the returned list using g_slist_free(). @@ -120501,42 +86316,30 @@ The return value of this function is affected by the “sort-type” and - a #GtkRecentChooser + a #GtkRecentChooser - - Removes @filter from the list of #GtkRecentFilter objects held by @chooser. + + Removes @filter from the list of #GtkRecentFilter objects held by @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - a #GtkRecentFilter + a #GtkRecentFilter - Selects all the items inside @chooser, if the @chooser supports + Selects all the items inside @chooser, if the @chooser supports multiple selection. @@ -120544,38 +86347,25 @@ multiple selection. - a #GtkRecentChooser + a #GtkRecentChooser - - Selects @uri inside @chooser. + + Selects @uri inside @chooser. - %TRUE if @uri was found. + %TRUE if @uri was found. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI @@ -120591,41 +86381,26 @@ multiple selection. - - Sets @uri as the current URI for @chooser. + + Sets @uri as the current URI for @chooser. - %TRUE if the URI was found. + %TRUE if the URI was found. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI - - Sets the comparison function used when sorting to be @sort_func. If + + Sets the comparison function used when sorting to be @sort_func. If the @chooser has the sort type set to #GTK_RECENT_SORT_CUSTOM then the chooser will sort using this function. @@ -120639,92 +86414,55 @@ a negative integer if the first item comes after the second. - a #GtkRecentChooser + a #GtkRecentChooser - - the comparison function + + the comparison function - - user data to pass to @sort_func, or %NULL + + user data to pass to @sort_func, or %NULL - - destroy notifier for @sort_data, or %NULL + + destroy notifier for @sort_data, or %NULL - - Unselects all the items inside @chooser. + + Unselects all the items inside @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - - Unselects @uri inside @chooser. + + Unselects @uri inside @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI - - Adds @filter to the list of #GtkRecentFilter objects held by @chooser. + + Adds @filter to the list of #GtkRecentFilter objects held by @chooser. If no previous filter objects were defined, this function will call gtk_recent_chooser_set_filter(). @@ -120734,101 +86472,67 @@ gtk_recent_chooser_set_filter(). - a #GtkRecentChooser + a #GtkRecentChooser - a #GtkRecentFilter + a #GtkRecentFilter - - Gets the #GtkRecentInfo currently selected by @chooser. + + Gets the #GtkRecentInfo currently selected by @chooser. - a #GtkRecentInfo. Use gtk_recent_info_unref() when + a #GtkRecentInfo. Use gtk_recent_info_unref() when when you have finished using it. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets the URI currently selected by @chooser. + + Gets the URI currently selected by @chooser. - a newly allocated string holding a URI. + a newly allocated string holding a URI. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets the #GtkRecentFilter object currently used by @chooser to affect + + Gets the #GtkRecentFilter object currently used by @chooser to affect the display of the recently used resources. - a #GtkRecentFilter object. + a #GtkRecentFilter object. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets the list of recently used resources in form of #GtkRecentInfo objects. + + Gets the list of recently used resources in form of #GtkRecentInfo objects. -The return value of this function is affected by the “sort-type” and -“limit” properties of @chooser. +The return value of this function is affected by the “sort-type” and +“limit” properties of @chooser. - A newly allocated + A newly allocated list of #GtkRecentInfo objects. You should use gtk_recent_info_unref() on every item of the list, and then free the list itself using g_list_free(). @@ -120838,214 +86542,142 @@ The return value of this function is affected by the “sort-type” and - a #GtkRecentChooser + a #GtkRecentChooser - - Gets the number of items returned by gtk_recent_chooser_get_items() + + Gets the number of items returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris(). - A positive integer, or -1 meaning that all items are + A positive integer, or -1 meaning that all items are returned. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets whether only local resources should be shown in the recently used + + Gets whether only local resources should be shown in the recently used resources selector. See gtk_recent_chooser_set_local_only() - %TRUE if only local resources should be shown. + %TRUE if only local resources should be shown. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets whether @chooser can select multiple items. + + Gets whether @chooser can select multiple items. - %TRUE if @chooser can select more than one item. + %TRUE if @chooser can select more than one item. - a #GtkRecentChooser + a #GtkRecentChooser - - Retrieves whether @chooser should show an icon near the resource. + + Retrieves whether @chooser should show an icon near the resource. - %TRUE if the icons should be displayed, %FALSE otherwise. + %TRUE if the icons should be displayed, %FALSE otherwise. - a #GtkRecentChooser + a #GtkRecentChooser - - Retrieves whether @chooser should show the recently used resources that + + Retrieves whether @chooser should show the recently used resources that were not found. - %TRUE if the resources not found should be displayed, and + %TRUE if the resources not found should be displayed, and %FALSE otheriwse. - a #GtkRecentChooser + a #GtkRecentChooser - - Returns whether @chooser should display recently used resources + + Returns whether @chooser should display recently used resources registered as private. - %TRUE if the recent chooser should show private items, + %TRUE if the recent chooser should show private items, %FALSE otherwise. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets whether @chooser should display tooltips containing the full path + + Gets whether @chooser should display tooltips containing the full path of a recently user resource. - %TRUE if the recent chooser should show tooltips, + %TRUE if the recent chooser should show tooltips, %FALSE otherwise. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets the value set by gtk_recent_chooser_set_sort_type(). + + Gets the value set by gtk_recent_chooser_set_sort_type(). - the sorting order of the @chooser. + the sorting order of the @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - - Gets the URI of the recently used resources. + + Gets the URI of the recently used resources. -The return value of this function is affected by the “sort-type” and “limit” +The return value of this function is affected by the “sort-type” and “limit” properties of @chooser. Since the returned array is %NULL terminated, @length may be %NULL. - + A newly allocated, %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -121054,36 +86686,21 @@ Since the returned array is %NULL terminated, @length may be %NULL. - a #GtkRecentChooser + a #GtkRecentChooser - - return location for a the length of the + + return location for a the length of the URI list, or %NULL - - Gets the #GtkRecentFilter objects held by @chooser. + + Gets the #GtkRecentFilter objects held by @chooser. - A singly linked list + A singly linked list of #GtkRecentFilter objects. You should just free the returned list using g_slist_free(). @@ -121092,44 +86709,30 @@ Since the returned array is %NULL terminated, @length may be %NULL. - a #GtkRecentChooser + a #GtkRecentChooser - - Removes @filter from the list of #GtkRecentFilter objects held by @chooser. + + Removes @filter from the list of #GtkRecentFilter objects held by @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - a #GtkRecentFilter + a #GtkRecentFilter - - Selects all the items inside @chooser, if the @chooser supports + + Selects all the items inside @chooser, if the @chooser supports multiple selection. @@ -121137,77 +86740,49 @@ multiple selection. - a #GtkRecentChooser + a #GtkRecentChooser - - Selects @uri inside @chooser. + + Selects @uri inside @chooser. - %TRUE if @uri was found. + %TRUE if @uri was found. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI - - Sets @uri as the current URI for @chooser. + + Sets @uri as the current URI for @chooser. - %TRUE if the URI was found. + %TRUE if the URI was found. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI - - Sets @filter as the current #GtkRecentFilter object used by @chooser + + Sets @filter as the current #GtkRecentFilter object used by @chooser to affect the displayed recently used resources. @@ -121215,28 +86790,17 @@ to affect the displayed recently used resources. - a #GtkRecentChooser + a #GtkRecentChooser - - a #GtkRecentFilter + + a #GtkRecentFilter - - Sets the number of items that should be returned by + + Sets the number of items that should be returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris(). @@ -121244,25 +86808,17 @@ gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris(). - a #GtkRecentChooser + a #GtkRecentChooser - a positive integer, or -1 for all items + a positive integer, or -1 for all items - - Sets whether only local resources, that is resources using the file:// URI + + Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector. If @local_only is %TRUE (the default) then the shown resources are guaranteed to be accessible through the operating system native file system. @@ -121272,50 +86828,34 @@ to be accessible through the operating system native file system. - a #GtkRecentChooser + a #GtkRecentChooser - %TRUE if only local files can be shown + %TRUE if only local files can be shown - - Sets whether @chooser can select multiple items. + + Sets whether @chooser can select multiple items. - a #GtkRecentChooser + a #GtkRecentChooser - %TRUE if @chooser can select more than one item + %TRUE if @chooser can select more than one item - - Sets whether @chooser should show an icon near the resource when + + Sets whether @chooser should show an icon near the resource when displaying it. @@ -121323,76 +86863,52 @@ displaying it. - a #GtkRecentChooser + a #GtkRecentChooser - whether to show an icon near the resource + whether to show an icon near the resource - - Sets whether @chooser should display the recently used resources that -it didn’t find. This only applies to local resources. + + Sets whether @chooser should display the recently used resources that +it didn’t find. This only applies to local resources. - a #GtkRecentChooser + a #GtkRecentChooser - whether to show the local items we didn’t find + whether to show the local items we didn’t find - - Whether to show recently used resources marked registered as private. + + Whether to show recently used resources marked registered as private. - a #GtkRecentChooser + a #GtkRecentChooser - %TRUE to show private items, %FALSE otherwise + %TRUE to show private items, %FALSE otherwise - - Sets whether to show a tooltips containing the full path of each + + Sets whether to show a tooltips containing the full path of each recently used resource in a #GtkRecentChooser widget. @@ -121400,25 +86916,17 @@ recently used resource in a #GtkRecentChooser widget. - a #GtkRecentChooser + a #GtkRecentChooser - %TRUE if tooltips should be shown + %TRUE if tooltips should be shown - - Sets the comparison function used when sorting to be @sort_func. If + + Sets the comparison function used when sorting to be @sort_func. If the @chooser has the sort type set to #GTK_RECENT_SORT_CUSTOM then the chooser will sort using this function. @@ -121432,48 +86940,25 @@ a negative integer if the first item comes after the second. - a #GtkRecentChooser + a #GtkRecentChooser - - the comparison function + + the comparison function - - user data to pass to @sort_func, or %NULL + + user data to pass to @sort_func, or %NULL - - destroy notifier for @sort_data, or %NULL + + destroy notifier for @sort_data, or %NULL - - Changes the sorting order of the recently used resources list displayed by + + Changes the sorting order of the recently used resources list displayed by @chooser. @@ -121481,130 +86966,75 @@ a negative integer if the first item comes after the second. - a #GtkRecentChooser + a #GtkRecentChooser - sort order that the chooser should use + sort order that the chooser should use - - Unselects all the items inside @chooser. + + Unselects all the items inside @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - - Unselects @uri inside @chooser. + + Unselects @uri inside @chooser. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI - - The #GtkRecentFilter object to be used when displaying + + The #GtkRecentFilter object to be used when displaying the recently used resources. - - The maximum number of recently used resources to be displayed, + + The maximum number of recently used resources to be displayed, or -1 to display all items. - - Whether this #GtkRecentChooser should display only local (file:) + + Whether this #GtkRecentChooser should display only local (file:) resources. - - The #GtkRecentManager instance used by the #GtkRecentChooser to + + The #GtkRecentManager instance used by the #GtkRecentChooser to display the list of recently used resources. - - Allow the user to select multiple resources. + + Allow the user to select multiple resources. - - Whether this #GtkRecentChooser should display an icon near the item. + + Whether this #GtkRecentChooser should display an icon near the item. - - Whether this #GtkRecentChooser should display the recently used resources + + Whether this #GtkRecentChooser should display the recently used resources even if not present anymore. Setting this to %FALSE will perform a potentially expensive check on every local resource (every remote resource will always be displayed). @@ -121613,29 +87043,17 @@ resource will always be displayed). - - Whether this #GtkRecentChooser should display a tooltip containing the + + Whether this #GtkRecentChooser should display a tooltip containing the full path of the recently used resources. - - Sorting order to be used when displaying the recently used resources. + + Sorting order to be used when displaying the recently used resources. - This signal is emitted when the user "activates" a recent item + This signal is emitted when the user "activates" a recent item in the recent chooser. This can happen by double-clicking on an item in the recently used resources list, or by pressing `Enter`. @@ -121644,9 +87062,7 @@ in the recently used resources list, or by pressing - This signal is emitted when there is a change in the set of + This signal is emitted when there is a change in the set of selected recently used resources. This can happen when a user modifies the selection with the mouse or the keyboard, or when explicitly calling functions to change the selection. @@ -121655,16 +87071,8 @@ explicitly calling functions to change the selection. - - #GtkRecentChooserDialog is a dialog box suitable for displaying the recently + + #GtkRecentChooserDialog is a dialog box suitable for displaying the recently used documents. This widgets works by putting a #GtkRecentChooserWidget inside a #GtkDialog. It exposes the #GtkRecentChooserIface interface, so you can use all the #GtkRecentChooser functions on the recent chooser dialog as well as @@ -121709,113 +87117,63 @@ Recently used files are supported since GTK+ 2.10. - - Creates a new #GtkRecentChooserDialog. This function is analogous to + + Creates a new #GtkRecentChooserDialog. This function is analogous to gtk_dialog_new_with_buttons(). - a new #GtkRecentChooserDialog + a new #GtkRecentChooserDialog - - Title of the dialog, or %NULL + + Title of the dialog, or %NULL - - Transient parent of the dialog, or %NULL, + + Transient parent of the dialog, or %NULL, - - stock ID or text to go in the first button, or %NULL + + stock ID or text to go in the first button, or %NULL - response ID for the first button, then additional (button, id) + response ID for the first button, then additional (button, id) pairs, ending with %NULL - - Creates a new #GtkRecentChooserDialog with a specified recent manager. + + Creates a new #GtkRecentChooserDialog with a specified recent manager. This is useful if you have implemented your own recent manager, or if you have a customized instance of a #GtkRecentManager object. - a new #GtkRecentChooserDialog + a new #GtkRecentChooserDialog - - Title of the dialog, or %NULL + + Title of the dialog, or %NULL - - Transient parent of the dialog, or %NULL, + + Transient parent of the dialog, or %NULL, - a #GtkRecentManager + a #GtkRecentManager - - stock ID or text to go in the first button, or %NULL + + stock ID or text to go in the first button, or %NULL - response ID for the first button, then additional (button, id) + response ID for the first button, then additional (button, id) pairs, ending with %NULL @@ -121825,13 +87183,10 @@ have a customized instance of a #GtkRecentManager object. - + - + @@ -121869,36 +87224,17 @@ have a customized instance of a #GtkRecentManager object. - + - - These identify the various errors that can occur while calling + + These identify the various errors that can occur while calling #GtkRecentChooser functions. - - Indicates that a file does not exist + + Indicates that a file does not exist - - Indicates a malformed URI + + Indicates a malformed URI @@ -121906,9 +87242,7 @@ have a customized instance of a #GtkRecentManager object. - + @@ -121917,22 +87251,16 @@ have a customized instance of a #GtkRecentManager object. - %TRUE if the URI was found. + %TRUE if the URI was found. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI @@ -121942,16 +87270,12 @@ have a customized instance of a #GtkRecentManager object. - a newly allocated string holding a URI. + a newly allocated string holding a URI. - a #GtkRecentChooser + a #GtkRecentChooser @@ -121961,22 +87285,16 @@ have a customized instance of a #GtkRecentManager object. - %TRUE if @uri was found. + %TRUE if @uri was found. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI @@ -121990,15 +87308,11 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser - a URI + a URI @@ -122012,9 +87326,7 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser @@ -122028,9 +87340,7 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser @@ -122040,9 +87350,7 @@ have a customized instance of a #GtkRecentManager object. - A newly allocated + A newly allocated list of #GtkRecentInfo objects. You should use gtk_recent_info_unref() on every item of the list, and then free the list itself using g_list_free(). @@ -122052,9 +87360,7 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser @@ -122081,15 +87387,11 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser - a #GtkRecentFilter + a #GtkRecentFilter @@ -122103,15 +87405,11 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser - a #GtkRecentFilter + a #GtkRecentFilter @@ -122121,9 +87419,7 @@ have a customized instance of a #GtkRecentManager object. - A singly linked list + A singly linked list of #GtkRecentFilter objects. You should just free the returned list using g_slist_free(). @@ -122132,9 +87428,7 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser @@ -122148,38 +87442,19 @@ have a customized instance of a #GtkRecentManager object. - a #GtkRecentChooser + a #GtkRecentChooser - - the comparison function + + the comparison function - - user data to pass to @sort_func, or %NULL + + user data to pass to @sort_func, or %NULL - - destroy notifier for @sort_data, or %NULL + + destroy notifier for @sort_data, or %NULL @@ -122212,16 +87487,8 @@ have a customized instance of a #GtkRecentManager object. - - #GtkRecentChooserMenu is a widget suitable for displaying recently used files + + #GtkRecentChooserMenu is a widget suitable for displaying recently used files inside a menu. It can be used to set a sub-menu of a #GtkMenuItem using gtk_menu_item_set_submenu(), or as the menu of a #GtkMenuToolButton. @@ -122244,12 +87511,8 @@ Recently used files are supported since GTK+ 2.10. - - Creates a new #GtkRecentChooserMenu widget. + + Creates a new #GtkRecentChooserMenu widget. This kind of widget shows the list of recently used resources as a menu, each item as a menu item. Each item inside the menu might @@ -122263,18 +87526,12 @@ gtk_recent_chooser_menu_new_for_manager() function to know how to create a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object. - a new #GtkRecentChooserMenu + a new #GtkRecentChooserMenu - - Creates a new #GtkRecentChooserMenu widget using @manager as + + Creates a new #GtkRecentChooserMenu widget using @manager as the underlying recently used resources manager. This is useful if you have implemented your own recent manager, @@ -122283,50 +87540,34 @@ object or if you wish to share a common #GtkRecentManager object among multiple #GtkRecentChooser widgets. - a new #GtkRecentChooserMenu, bound to @manager. + a new #GtkRecentChooserMenu, bound to @manager. - a #GtkRecentManager + a #GtkRecentManager - - Returns the value set by gtk_recent_chooser_menu_set_show_numbers(). + + Returns the value set by gtk_recent_chooser_menu_set_show_numbers(). - %TRUE if numbers should be shown. + %TRUE if numbers should be shown. - a #GtkRecentChooserMenu + a #GtkRecentChooserMenu - - Sets whether a number should be added to the items of @menu. The + + Sets whether a number should be added to the items of @menu. The numbers are shown to provide a unique character for a mnemonic to -be used inside ten menu item’s label. Only the first the items +be used inside ten menu item’s label. Only the first the items get a number to avoid clashes. @@ -122334,26 +87575,17 @@ get a number to avoid clashes. - a #GtkRecentChooserMenu + a #GtkRecentChooserMenu - whether to show numbers + whether to show numbers - - Whether the first ten items in the menu should be prepended by + + Whether the first ten items in the menu should be prepended by a number acting as a unique mnemonic. @@ -122361,13 +87593,10 @@ a number acting as a unique mnemonic. - + - + @@ -122405,21 +87634,11 @@ a number acting as a unique mnemonic. - + - - #GtkRecentChooserWidget is a widget suitable for selecting recently used + + #GtkRecentChooserWidget is a widget suitable for selecting recently used files. It is the main building block of a #GtkRecentChooserDialog. Most applications will only need to use the latter; you can use #GtkRecentChooserWidget as part of a larger window if you have special needs. @@ -122433,42 +87652,28 @@ Recently used files are supported since GTK+ 2.10. - - Creates a new #GtkRecentChooserWidget object. This is an embeddable widget + + Creates a new #GtkRecentChooserWidget object. This is an embeddable widget used to access the recently used resources list. - a new #GtkRecentChooserWidget + a new #GtkRecentChooserWidget - - Creates a new #GtkRecentChooserWidget with a specified recent manager. + + Creates a new #GtkRecentChooserWidget with a specified recent manager. This is useful if you have implemented your own recent manager, or if you have a customized instance of a #GtkRecentManager object. - a new #GtkRecentChooserWidget + a new #GtkRecentChooserWidget - a #GtkRecentManager + a #GtkRecentManager @@ -122477,13 +87682,10 @@ have a customized instance of a #GtkRecentManager object. - + - + @@ -122521,79 +87723,54 @@ have a customized instance of a #GtkRecentManager object. - + - Meta-data to be passed to gtk_recent_manager_add_full() when + Meta-data to be passed to gtk_recent_manager_add_full() when registering a recently used resource. - a UTF-8 encoded string, containing the name of the recently + a UTF-8 encoded string, containing the name of the recently used resource to be displayed, or %NULL; - a UTF-8 encoded string, containing a short description of + a UTF-8 encoded string, containing a short description of the resource, or %NULL; - the MIME type of the resource; + the MIME type of the resource; - the name of the application that is registering this recently + the name of the application that is registering this recently used resource; - command line used to launch this resource; may contain the - “\%f” and “\%u” escape characters which will be expanded + command line used to launch this resource; may contain the + “\%f” and “\%u” escape characters which will be expanded to the resource file path and URI respectively when the command line is retrieved; - a vector of strings containing + a vector of strings containing groups names; - whether this resource should be displayed only by the + whether this resource should be displayed only by the applications that have registered it or not. - - A #GtkRecentFilter can be used to restrict the files being shown + + A #GtkRecentFilter can be used to restrict the files being shown in a #GtkRecentChooser. Files can be filtered based on their name (with gtk_recent_filter_add_pattern()), on their mime type (with gtk_file_filter_add_mime_type()), on the application that has @@ -122640,12 +87817,8 @@ An example of a UI definition fragment specifying GtkRecentFilter rules: </object> ]| - - Creates a new #GtkRecentFilter with no rules added to it. + + Creates a new #GtkRecentFilter with no rules added to it. Such filter does not accept any recently used resources, so is not particularly useful until you add rules with gtk_recent_filter_add_pattern(), gtk_recent_filter_add_mime_type(), @@ -122657,18 +87830,12 @@ gtk_recent_filter_add_pattern (filter, "*"); ]| - a new #GtkRecentFilter + a new #GtkRecentFilter - - Adds a rule that allows resources based on their age - that is, the number + + Adds a rule that allows resources based on their age - that is, the number of days elapsed since they were last modified. @@ -122676,25 +87843,17 @@ of days elapsed since they were last modified. - a #GtkRecentFilter + a #GtkRecentFilter - number of days + number of days - - Adds a rule that allows resources based on the name of the application + + Adds a rule that allows resources based on the name of the application that has registered them. @@ -122702,83 +87861,52 @@ that has registered them. - a #GtkRecentFilter + a #GtkRecentFilter - an application name + an application name - - Adds a rule to a filter that allows resources based on a custom callback + + Adds a rule to a filter that allows resources based on a custom callback function. The bitfield @needed which is passed in provides information about what sorts of information that the filter function needs; this allows GTK+ to avoid retrieving expensive information when -it isn’t needed by the filter. +it isn’t needed by the filter. - a #GtkRecentFilter + a #GtkRecentFilter - bitfield of flags indicating the information that the custom + bitfield of flags indicating the information that the custom filter function needs. - - callback function; if the function returns %TRUE, then + + callback function; if the function returns %TRUE, then the file will be displayed. - - data to pass to @func + + data to pass to @func - - function to call to free @data when it is no longer needed. + + function to call to free @data when it is no longer needed. - - Adds a rule that allows resources based on the name of the group + + Adds a rule that allows resources based on the name of the group to which they belong @@ -122786,50 +87914,34 @@ to which they belong - a #GtkRecentFilter + a #GtkRecentFilter - a group name + a group name - - Adds a rule that allows resources based on their registered MIME type. + + Adds a rule that allows resources based on their registered MIME type. - a #GtkRecentFilter + a #GtkRecentFilter - a MIME type + a MIME type - - Adds a rule that allows resources based on a pattern matching their + + Adds a rule that allows resources based on a pattern matching their display name. @@ -122837,25 +87949,17 @@ display name. - a #GtkRecentFilter + a #GtkRecentFilter - a file pattern + a file pattern - - Adds a rule allowing image files in the formats supported + + Adds a rule allowing image files in the formats supported by GdkPixbuf. @@ -122863,19 +87967,13 @@ by GdkPixbuf. - a #GtkRecentFilter + a #GtkRecentFilter - - Tests whether a file should be displayed according to @filter. + + Tests whether a file should be displayed according to @filter. The #GtkRecentFilterInfo @filter_info should include the fields returned from gtk_recent_filter_get_needed(), and must set the #GtkRecentFilterInfo.contains field of @filter_info @@ -122886,57 +87984,39 @@ is intended principally for use in the implementation of #GtkRecentChooser. - %TRUE if the file should be displayed + %TRUE if the file should be displayed - a #GtkRecentFilter + a #GtkRecentFilter - a #GtkRecentFilterInfo containing information + a #GtkRecentFilterInfo containing information about a recently used resource - - Gets the human-readable name for the filter. + + Gets the human-readable name for the filter. See gtk_recent_filter_set_name(). - the name of the filter, or %NULL. The returned string + the name of the filter, or %NULL. The returned string is owned by the filter object and should not be freed. - a #GtkRecentFilter + a #GtkRecentFilter - - Gets the fields that need to be filled in for the #GtkRecentFilterInfo + + Gets the fields that need to be filled in for the #GtkRecentFilterInfo passed to gtk_recent_filter_filter() This function will not typically be used by applications; it @@ -122944,27 +88024,19 @@ is intended principally for use in the implementation of #GtkRecentChooser. - bitfield of flags indicating needed fields when + bitfield of flags indicating needed fields when calling gtk_recent_filter_filter() - a #GtkRecentFilter + a #GtkRecentFilter - - Sets the human-readable name of the filter; this is the string + + Sets the human-readable name of the filter; this is the string that will be displayed in the recently used resources selector user interface if there is a selectable list of filters. @@ -122973,305 +88045,188 @@ user interface if there is a selectable list of filters. - a #GtkRecentFilter + a #GtkRecentFilter - then human readable name of @filter + then human readable name of @filter - - These flags indicate what parts of a #GtkRecentFilterInfo struct + + These flags indicate what parts of a #GtkRecentFilterInfo struct are filled or need to be filled. - - the URI of the file being tested + + the URI of the file being tested - - the string that will be used to + + the string that will be used to display the file in the recent chooser - - the mime type of the file + + the mime type of the file - - the list of applications that have + + the list of applications that have registered the file - - the groups to which the file belongs to + + the groups to which the file belongs to - - the number of days elapsed since the file + + the number of days elapsed since the file has been registered - The type of function that is used with custom filters, + The type of function that is used with custom filters, see gtk_recent_filter_add_custom(). - %TRUE if the file should be displayed + %TRUE if the file should be displayed - a #GtkRecentFilterInfo that is filled according + a #GtkRecentFilterInfo that is filled according to the @needed flags passed to gtk_recent_filter_add_custom() - - user data passed to gtk_recent_filter_add_custom() + + user data passed to gtk_recent_filter_add_custom() - A GtkRecentFilterInfo struct is used + A GtkRecentFilterInfo struct is used to pass information about the tested file to gtk_recent_filter_filter(). - #GtkRecentFilterFlags to indicate which fields are set. + #GtkRecentFilterFlags to indicate which fields are set. - The URI of the file being tested. + The URI of the file being tested. - The string that will be used to display + The string that will be used to display the file in the recent chooser. - MIME type of the file. + MIME type of the file. - The list of + The list of applications that have registered the file. - The groups to which + The groups to which the file belongs to. - The number of days elapsed since the file has been + The number of days elapsed since the file has been registered. - - #GtkRecentInfo-struct contains private data only, and should + + #GtkRecentInfo-struct contains private data only, and should be accessed using the provided API. #GtkRecentInfo constains all the meta-data associated with an entry in the recently used files list. - - Creates a #GAppInfo for the specified #GtkRecentInfo + + Creates a #GAppInfo for the specified #GtkRecentInfo - the newly created #GAppInfo, or %NULL. + the newly created #GAppInfo, or %NULL. In case of error, @error will be set either with a %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR - a #GtkRecentInfo + a #GtkRecentInfo - - the name of the application that should + + the name of the application that should be mapped to a #GAppInfo; if %NULL is used then the default application for the MIME type is used - - Checks whether the resource pointed by @info still exists. + + Checks whether the resource pointed by @info still exists. At the moment this check is done only on resources pointing to local files. - %TRUE if the resource exists + %TRUE if the resource exists - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the timestamp (seconds from system’s Epoch) when the resource + + Gets the timestamp (seconds from system’s Epoch) when the resource was added to the recently used resources list. - the number of seconds elapsed from system’s Epoch when + the number of seconds elapsed from system’s Epoch when the resource was added to the list, or -1 on failure. - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the number of days elapsed since the last update + + Gets the number of days elapsed since the last update of the resource pointed by @info. - a positive integer containing the number of days + a positive integer containing the number of days elapsed since the time this resource was last modified - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the data regarding the application that has registered the resource + + Gets the data regarding the application that has registered the resource pointed by @info. If the command line contains any escape characters defined inside the storage specification, they will be expanded. - %TRUE if an application with @app_name has registered this + %TRUE if an application with @app_name has registered this resource inside the recently used list, or %FALSE otherwise. The @app_exec string is owned by the #GtkRecentInfo and should not be modified or freed @@ -123279,59 +88234,34 @@ storage specification, they will be expanded. - a #GtkRecentInfo + a #GtkRecentInfo - the name of the application that has registered this item + the name of the application that has registered this item - - return location for the string containing + + return location for the string containing the command line - - return location for the number of times this item was registered + + return location for the number of times this item was registered - - return location for the timestamp this item was last registered + + return location for the timestamp this item was last registered for this application - - Retrieves the list of applications that have registered this resource. + + Retrieves the list of applications that have registered this resource. - + a newly allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -123340,107 +88270,68 @@ storage specification, they will be expanded. - a #GtkRecentInfo + a #GtkRecentInfo - - return location for the length of the returned list + + return location for the length of the returned list - - Gets the (short) description of the resource. + + Gets the (short) description of the resource. - the description of the resource. The returned string + the description of the resource. The returned string is owned by the recent manager, and should not be freed. - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the name of the resource. If none has been defined, the basename + + Gets the name of the resource. If none has been defined, the basename of the resource is obtained. - the display name of the resource. The returned string + the display name of the resource. The returned string is owned by the recent manager, and should not be freed. - a #GtkRecentInfo + a #GtkRecentInfo - - Retrieves the icon associated to the resource MIME type. + + Retrieves the icon associated to the resource MIME type. - a #GIcon containing the icon, or %NULL. + a #GIcon containing the icon, or %NULL. Use g_object_unref() when finished using the icon - a #GtkRecentInfo + a #GtkRecentInfo - - Returns all groups registered for the recently used item @info. + + Returns all groups registered for the recently used item @info. The array of returned group names will be %NULL terminated, so length might optionally be %NULL. - + a newly allocated %NULL terminated array of strings. Use g_strfreev() to free it. @@ -123449,379 +88340,252 @@ length might optionally be %NULL. - a #GtkRecentInfo + a #GtkRecentInfo - - return location for the number of groups returned + + return location for the number of groups returned - - Retrieves the icon of size @size associated to the resource MIME type. + + Retrieves the icon of size @size associated to the resource MIME type. - a #GdkPixbuf containing the icon, + a #GdkPixbuf containing the icon, or %NULL. Use g_object_unref() when finished using the icon. - a #GtkRecentInfo + a #GtkRecentInfo - the size of the icon in pixels + the size of the icon in pixels - - Gets the MIME type of the resource. + + Gets the MIME type of the resource. - the MIME type of the resource. The returned string + the MIME type of the resource. The returned string is owned by the recent manager, and should not be freed. - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the timestamp (seconds from system’s Epoch) when the meta-data + + Gets the timestamp (seconds from system’s Epoch) when the meta-data for the resource was last modified. - the number of seconds elapsed from system’s Epoch when + the number of seconds elapsed from system’s Epoch when the resource was last modified, or -1 on failure. - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the value of the “private” flag. Resources in the recently used + + Gets the value of the “private” flag. Resources in the recently used list that have this flag set to %TRUE should only be displayed by the applications that have registered them. - %TRUE if the private flag was found, %FALSE otherwise + %TRUE if the private flag was found, %FALSE otherwise - a #GtkRecentInfo + a #GtkRecentInfo - - Computes a valid UTF-8 string that can be used as the + + Computes a valid UTF-8 string that can be used as the name of the item in a menu or list. For example, calling this function on an item that refers to -“file:///foo/bar.txt” will yield “bar.txt”. +“file:///foo/bar.txt” will yield “bar.txt”. - A newly-allocated string in UTF-8 encoding + A newly-allocated string in UTF-8 encoding free it with g_free() - an #GtkRecentInfo + an #GtkRecentInfo - - Gets the URI of the resource. + + Gets the URI of the resource. - the URI of the resource. The returned string is + the URI of the resource. The returned string is owned by the recent manager, and should not be freed. - a #GtkRecentInfo + a #GtkRecentInfo - - Gets a displayable version of the resource’s URI. If the resource + + Gets a displayable version of the resource’s URI. If the resource is local, it returns a local path; if the resource is not local, it returns the UTF-8 encoded content of gtk_recent_info_get_uri(). - a newly allocated UTF-8 string containing the - resource’s URI or %NULL. Use g_free() when done using it. + a newly allocated UTF-8 string containing the + resource’s URI or %NULL. Use g_free() when done using it. - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the timestamp (seconds from system’s Epoch) when the meta-data + + Gets the timestamp (seconds from system’s Epoch) when the meta-data for the resource was last visited. - the number of seconds elapsed from system’s Epoch when + the number of seconds elapsed from system’s Epoch when the resource was last visited, or -1 on failure. - a #GtkRecentInfo + a #GtkRecentInfo - - Checks whether an application registered this resource using @app_name. + + Checks whether an application registered this resource using @app_name. - %TRUE if an application with name @app_name was found, + %TRUE if an application with name @app_name was found, %FALSE otherwise - a #GtkRecentInfo + a #GtkRecentInfo - a string containing an application name + a string containing an application name - - Checks whether @group_name appears inside the groups + + Checks whether @group_name appears inside the groups registered for the recently used item @info. - %TRUE if the group was found + %TRUE if the group was found - a #GtkRecentInfo + a #GtkRecentInfo - name of a group + name of a group - - Checks whether the resource is local or not by looking at the + + Checks whether the resource is local or not by looking at the scheme of its URI. - %TRUE if the resource is local + %TRUE if the resource is local - a #GtkRecentInfo + a #GtkRecentInfo - - Gets the name of the last application that have registered the + + Gets the name of the last application that have registered the recently used resource represented by @info. - an application name. Use g_free() to free it. + an application name. Use g_free() to free it. - a #GtkRecentInfo + a #GtkRecentInfo - Checks whether two #GtkRecentInfo-struct point to the same + Checks whether two #GtkRecentInfo-struct point to the same resource. - %TRUE if both #GtkRecentInfo-struct point to the same + %TRUE if both #GtkRecentInfo-struct point to the same resource, %FALSE otherwise - a #GtkRecentInfo + a #GtkRecentInfo - a #GtkRecentInfo + a #GtkRecentInfo - Increases the reference count of @recent_info by one. + Increases the reference count of @recent_info by one. - the recent info object with its reference count + the recent info object with its reference count increased by one - a #GtkRecentInfo + a #GtkRecentInfo - Decreases the reference count of @info by one. If the reference + Decreases the reference count of @info by one. If the reference count reaches zero, @info is deallocated, and the memory freed. @@ -123829,25 +88593,14 @@ count reaches zero, @info is deallocated, and the memory freed. - a #GtkRecentInfo + a #GtkRecentInfo - - #GtkRecentManager provides a facility for adding, removing and + + #GtkRecentManager provides a facility for adding, removing and looking up recently used files. Each recently used file is identified by its URI, and has meta-data associated to it, like the names and command lines of the applications that have @@ -123908,38 +88661,26 @@ property. Recently used files are supported since GTK+ 2.10. - - Creates a new recent manager object. Recent manager objects are used to + + Creates a new recent manager object. Recent manager objects are used to handle the list of recently used resources. A #GtkRecentManager object -monitors the recently used resources list, and emits the “changed” signal +monitors the recently used resources list, and emits the “changed” signal each time something inside the list changes. #GtkRecentManager objects are expensive: be sure to create them only when needed. You should use gtk_recent_manager_get_default() instead. - A newly created #GtkRecentManager object + A newly created #GtkRecentManager object - - Gets a unique instance of #GtkRecentManager, that you can share + + Gets a unique instance of #GtkRecentManager, that you can share in your application without caring about memory management. - A unique #GtkRecentManager. Do not ref or + A unique #GtkRecentManager. Do not ref or unref it. @@ -123955,12 +88696,8 @@ in your application without caring about memory management. - - Adds a new resource, pointed by @uri, into the recently used + + Adds a new resource, pointed by @uri, into the recently used resources list, using the metadata specified inside the #GtkRecentData-struct passed in @recent_data. @@ -123981,39 +88718,27 @@ be considered private - that is, should be displayed only by the applications that have registered it. - %TRUE if the new item was successfully added to the + %TRUE if the new item was successfully added to the recently used resources list, %FALSE otherwise - a #GtkRecentManager + a #GtkRecentManager - a valid URI + a valid URI - metadata of the resource + metadata of the resource - - Adds a new resource, pointed by @uri, into the recently used + + Adds a new resource, pointed by @uri, into the recently used resources list. This function automatically retrieves some of the needed @@ -124024,38 +88749,26 @@ See gtk_recent_manager_add_full() if you want to explicitly define the metadata for the resource pointed by @uri. - %TRUE if the new item was successfully added + %TRUE if the new item was successfully added to the recently used resources list - a #GtkRecentManager + a #GtkRecentManager - a valid URI + a valid URI - - Gets the list of recently used resources. + + Gets the list of recently used resources. - a list of + a list of newly allocated #GtkRecentInfo objects. Use gtk_recent_info_unref() on each item inside the list, and then free the list itself using g_list_free(). @@ -124065,56 +88778,37 @@ define the metadata for the resource pointed by @uri. - a #GtkRecentManager + a #GtkRecentManager - - Checks whether there is a recently used resource registered + + Checks whether there is a recently used resource registered with @uri inside the recent manager. - %TRUE if the resource was found, %FALSE otherwise + %TRUE if the resource was found, %FALSE otherwise - a #GtkRecentManager + a #GtkRecentManager - a URI + a URI - - Searches for a URI inside the recently used resources list, and + + Searches for a URI inside the recently used resources list, and returns a #GtkRecentInfo-struct containing informations about the resource like its MIME type, or its display name. - a #GtkRecentInfo-struct containing information + a #GtkRecentInfo-struct containing information about the resource pointed by @uri, or %NULL if the URI was not registered in the recently used resources list. Free with gtk_recent_info_unref(). @@ -124122,131 +88816,83 @@ like its MIME type, or its display name. - a #GtkRecentManager + a #GtkRecentManager - a URI + a URI - - Changes the location of a recently used resource from @uri to @new_uri. + + Changes the location of a recently used resource from @uri to @new_uri. Please note that this function will not affect the resource pointed by the URIs, but only the URI used in the recently used resources list. - %TRUE on success + %TRUE on success - a #GtkRecentManager + a #GtkRecentManager - the URI of a recently used resource + the URI of a recently used resource - - the new URI of the recently used resource, or + + the new URI of the recently used resource, or %NULL to remove the item pointed by @uri in the list - - Purges every item from the recently used resources list. + + Purges every item from the recently used resources list. - the number of items that have been removed from the + the number of items that have been removed from the recently used resources list - a #GtkRecentManager + a #GtkRecentManager - - Removes a resource pointed by @uri from the recently used resources + + Removes a resource pointed by @uri from the recently used resources list handled by a recent manager. - %TRUE if the item pointed by @uri has been successfully + %TRUE if the item pointed by @uri has been successfully removed by the recently used resources list, and %FALSE otherwise - a #GtkRecentManager + a #GtkRecentManager - the URI of the item you wish to remove + the URI of the item you wish to remove - - The full path to the file to be used to store and read the + + The full path to the file to be used to store and read the recently used resources list - The size of the recently used resources list. + The size of the recently used resources list. @@ -124256,9 +88902,7 @@ recently used resources list - Emitted when the current recently used resources manager changes + Emitted when the current recently used resources manager changes its contents, either by calling gtk_recent_manager_add_item() or by another application. @@ -124266,13 +88910,8 @@ by another application. - - #GtkRecentManagerClass contains only private data. + + #GtkRecentManagerClass contains only private data. @@ -124323,75 +88962,33 @@ by another application. - - Error codes for #GtkRecentManager operations - - the URI specified does not exists in + + Error codes for #GtkRecentManager operations + + the URI specified does not exists in the recently used resources list. - - the URI specified is not valid. + + the URI specified is not valid. - - the supplied string is not + + the supplied string is not UTF-8 encoded. - - no application has registered + + no application has registered the specified item. - - failure while reading the recently used + + failure while reading the recently used resources file. - - failure while writing the recently used + + failure while writing the recently used resources file. - - unspecified error. + + unspecified error. @@ -124399,9 +88996,7 @@ by another application. - + @@ -124416,164 +89011,71 @@ by another application. - + - - Used to specify the sorting method to be applyed to the recently + + Used to specify the sorting method to be applyed to the recently used resource list. - - Do not sort the returned list of recently used + + Do not sort the returned list of recently used resources. - - Sort the returned list with the most recently used + + Sort the returned list with the most recently used items first. - - Sort the returned list with the least recently used + + Sort the returned list with the least recently used items first. - - Sort the returned list using a custom sorting + + Sort the returned list using a custom sorting function passed using gtk_recent_chooser_set_sort_func(). - - Describes a region within a widget. - - Region has an even number within a set. + + Describes a region within a widget. + + Region has an even number within a set. - - Region has an odd number within a set. + + Region has an odd number within a set. - - Region is the first one within a set. + + Region is the first one within a set. - - Region is the last one within a set. + + Region is the last one within a set. - - Region is the only one within a set. + + Region is the only one within a set. - - Region is part of a sorted area. + + Region is part of a sorted area. - - Indicated the relief to be drawn around a #GtkButton. - - Draw a normal relief. + + Indicated the relief to be drawn around a #GtkButton. + + Draw a normal relief. - - A half relief. Deprecated in 3.14, does the same as @GTK_RELIEF_NORMAL + + A half relief. Deprecated in 3.14, does the same as @GTK_RELIEF_NORMAL - - No relief. + + No relief. - - + + - + @@ -124583,273 +89085,145 @@ used resource list. - + - + - - + + - - + + - Represents a request of a screen object in a given orientation. These + Represents a request of a screen object in a given orientation. These are primarily used in container implementations when allocating a natural size for children calling. See gtk_distribute_natural_allocation(). - A client pointer + A client pointer - The minimum size needed for allocation in a given orientation + The minimum size needed for allocation in a given orientation - The natural size for allocation in a given orientation + The natural size for allocation in a given orientation - - A #GtkRequisition-struct represents the desired size of a widget. See -[GtkWidget’s geometry management section][geometry-management] for + + A #GtkRequisition-struct represents the desired size of a widget. See +[GtkWidget’s geometry management section][geometry-management] for more information. - the widget’s desired width + the widget’s desired width - the widget’s desired height + the widget’s desired height - Allocates a new #GtkRequisition-struct and initializes its elements to zero. + Allocates a new #GtkRequisition-struct and initializes its elements to zero. - a new empty #GtkRequisition. The newly allocated #GtkRequisition should + a new empty #GtkRequisition. The newly allocated #GtkRequisition should be freed with gtk_requisition_free(). - Copies a #GtkRequisition. + Copies a #GtkRequisition. - a copy of @requisition + a copy of @requisition - a #GtkRequisition + a #GtkRequisition - Frees a #GtkRequisition. + Frees a #GtkRequisition. - a #GtkRequisition + a #GtkRequisition - - - Pass resize request to the parent + + + Pass resize request to the parent - - Queue resizes on this widget + + Queue resizes on this widget - - Resize immediately. Deprecated. + + Resize immediately. Deprecated. - - Predefined values for use as response ids in gtk_dialog_add_button(). + + Predefined values for use as response ids in gtk_dialog_add_button(). All predefined values are negative; GTK+ leaves values of 0 or greater for application-defined response ids. - - Returned if an action widget has no response id, + + Returned if an action widget has no response id, or if the dialog gets programmatically hidden or destroyed - - Generic response id, not used by GTK+ dialogs + + Generic response id, not used by GTK+ dialogs - - Generic response id, not used by GTK+ dialogs + + Generic response id, not used by GTK+ dialogs - - Returned if the dialog is deleted + + Returned if the dialog is deleted - - Returned by OK buttons in GTK+ dialogs + + Returned by OK buttons in GTK+ dialogs - - Returned by Cancel buttons in GTK+ dialogs + + Returned by Cancel buttons in GTK+ dialogs - - Returned by Close buttons in GTK+ dialogs + + Returned by Close buttons in GTK+ dialogs - - Returned by Yes buttons in GTK+ dialogs + + Returned by Yes buttons in GTK+ dialogs - - Returned by No buttons in GTK+ dialogs + + Returned by No buttons in GTK+ dialogs - - Returned by Apply buttons in GTK+ dialogs + + Returned by Apply buttons in GTK+ dialogs - - Returned by Help buttons in GTK+ dialogs + + Returned by Help buttons in GTK+ dialogs - - The GtkRevealer widget is a container which animates + + The GtkRevealer widget is a container which animates the transition of its child from invisible to visible. The style of transition can be controlled with @@ -124867,46 +89241,30 @@ The GtkRevealer widget was added in GTK+ 3.10. - Creates a new #GtkRevealer. + Creates a new #GtkRevealer. - a newly created #GtkRevealer + a newly created #GtkRevealer - - Returns whether the child is fully revealed, in other words whether + + Returns whether the child is fully revealed, in other words whether the transition to the revealed state is completed. - %TRUE if the child is fully revealed + %TRUE if the child is fully revealed - a #GtkRevealer + a #GtkRevealer - - Returns whether the child is currently + + Returns whether the child is currently revealed. See gtk_revealer_set_reveal_child(). This function returns %TRUE as soon as the transition @@ -124915,73 +89273,48 @@ the child is fully revealed (ie the transition is completed), use gtk_revealer_get_child_revealed(). - %TRUE if the child is revealed. + %TRUE if the child is revealed. - a #GtkRevealer + a #GtkRevealer - - Returns the amount of time (in milliseconds) that + + Returns the amount of time (in milliseconds) that transitions will take. - the transition duration + the transition duration - a #GtkRevealer + a #GtkRevealer - - Gets the type of animation that will be used + + Gets the type of animation that will be used for transitions in @revealer. - the current transition type of @revealer - + the current transition type of @revealer + - a #GtkRevealer + a #GtkRevealer - - Tells the #GtkRevealer to reveal or conceal its child. + + Tells the #GtkRevealer to reveal or conceal its child. The transition will be animated with the current transition type of @revealer. @@ -124991,50 +89324,34 @@ transition type of @revealer. - a #GtkRevealer + a #GtkRevealer - %TRUE to reveal the child + %TRUE to reveal the child - - Sets the duration that transitions will take. + + Sets the duration that transitions will take. - a #GtkRevealer + a #GtkRevealer - the new duration, in milliseconds + the new duration, in milliseconds - - Sets the type of animation that will be used for + + Sets the type of animation that will be used for transitions in @revealer. Available types include various kinds of fades and slides. @@ -125043,111 +89360,58 @@ various kinds of fades and slides. - a #GtkRevealer + a #GtkRevealer - the new transition type - + the new transition type + - + - + - + - + - The parent class. + The parent class. - - These enumeration values describe the possible transitions + + These enumeration values describe the possible transitions when the child of a #GtkRevealer widget is shown or hidden. - - No transition + + No transition - - Fade in + + Fade in - - Slide in from the left + + Slide in from the left - - Slide in from the right + + Slide in from the right - - Slide in from the bottom + + Slide in from the bottom - - Slide in from the top + + Slide in from the top @@ -125157,528 +89421,406 @@ when the child of a #GtkRevealer widget is shown or hidden. - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -125692,156 +89834,119 @@ when the child of a #GtkRevealer widget is shown or hidden. - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + @@ -125855,1458 +89960,753 @@ when the child of a #GtkRevealer widget is shown or hidden. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - The “About” item. + + The “About” item. ![](help-about.png) Use named icon &quot;help-about&quot; or the label &quot;_About&quot;. - - The “Add” item and icon. + + The “Add” item and icon. Use named icon &quot;list-add&quot; or the label &quot;_Add&quot;. - - The “Apply” item and icon. + + The “Apply” item and icon. Do not use an icon. Use label &quot;_Apply&quot;. - - The “Bold” item and icon. + + The “Bold” item and icon. Use named icon &quot;format-text-bold&quot;. - - The “Cancel” item and icon. + + The “Cancel” item and icon. Do not use an icon. Use label &quot;_Cancel&quot;. - - The “Caps Lock Warning” icon. + + The “Caps Lock Warning” icon. Use named icon &quot;dialog-warning-symbolic&quot;. - - The “CD-Rom” item and icon. + + The “CD-Rom” item and icon. Use named icon &quot;media-optical&quot;. - - The “Clear” item and icon. + + The “Clear” item and icon. Use named icon &quot;edit-clear&quot;. - - The “Close” item and icon. + + The “Close” item and icon. Use named icon &quot;window-close&quot; or the label &quot;_Close&quot;. - - The “Color Picker” item and icon. + + The “Color Picker” item and icon. - - The “Connect” icon. + + The “Connect” icon. - - The “Convert” item and icon. + + The “Convert” item and icon. - - The “Copy” item and icon. + + The “Copy” item and icon. Use the named icon &quot;edit-copy&quot; or the label &quot;_Copy&quot;. - - The “Cut” item and icon. + + The “Cut” item and icon. Use the named icon &quot;edit-cut&quot; or the label &quot;Cu_t&quot;. - - The “Delete” item and icon. + + The “Delete” item and icon. Use the named icon &quot;edit-delete&quot; or the label &quot;_Delete&quot;. - - The “Authentication” item and icon. + + The “Authentication” item and icon. Use named icon &quot;dialog-password&quot;. - - The “Error” item and icon. + + The “Error” item and icon. Use named icon &quot;dialog-error&quot;. - - The “Information” item and icon. + + The “Information” item and icon. Use named icon &quot;dialog-information&quot;. - - The “Question” item and icon. + + The “Question” item and icon. Use named icon &quot;dialog-question&quot;. - - The “Warning” item and icon. + + The “Warning” item and icon. Use named icon &quot;dialog-warning&quot;. - - The “Directory” icon. + + The “Directory” icon. Use named icon &quot;folder&quot;. - - The “Discard” item. + + The “Discard” item. - - The “Disconnect” icon. + + The “Disconnect” icon. - - The “Drag-And-Drop” icon. + + The “Drag-And-Drop” icon. - - The “Drag-And-Drop multiple” icon. + + The “Drag-And-Drop multiple” icon. - - The “Edit” item and icon. + + The “Edit” item and icon. - - The “Execute” item and icon. + + The “Execute” item and icon. Use named icon &quot;system-run&quot;. - - The “File” item and icon. + + The “File” item and icon. Since 3.0, this item has a label, before it only had an icon. Use named icon &quot;text-x-generic&quot;. - - The “Find” item and icon. + + The “Find” item and icon. Use named icon &quot;edit-find&quot;. - - The “Find and Replace” item and icon. + + The “Find and Replace” item and icon. Use named icon &quot;edit-find-replace&quot;. - - The “Floppy” item and icon. + + The “Floppy” item and icon. - - The “Fullscreen” item and icon. + + The “Fullscreen” item and icon. Use named icon &quot;view-fullscreen&quot;. - - The “Bottom” item and icon. + + The “Bottom” item and icon. Use named icon &quot;go-bottom&quot;. - - The “First” item and icon. The icon has an RTL variant. + + The “First” item and icon. The icon has an RTL variant. Use named icon &quot;go-first&quot;. - - The “Last” item and icon. The icon has an RTL variant. + + The “Last” item and icon. The icon has an RTL variant. Use named icon &quot;go-last&quot;. - - The “Top” item and icon. + + The “Top” item and icon. Use named icon &quot;go-top&quot;. - - The “Back” item and icon. The icon has an RTL variant. + + The “Back” item and icon. The icon has an RTL variant. Use named icon &quot;go-previous&quot;. - - The “Down” item and icon. + + The “Down” item and icon. Use named icon &quot;go-down&quot;. - - The “Forward” item and icon. The icon has an RTL variant. + + The “Forward” item and icon. The icon has an RTL variant. Use named icon &quot;go-next&quot;. - - The “Up” item and icon. + + The “Up” item and icon. Use named icon &quot;go-up&quot;. - - The “Harddisk” item and icon. + + The “Harddisk” item and icon. Use named icon &quot;drive-harddisk&quot;. - - The “Help” item and icon. + + The “Help” item and icon. Use named icon &quot;help-browser&quot;. - - The “Home” item and icon. + + The “Home” item and icon. Use named icon &quot;go-home&quot;. - - The “Indent” item and icon. The icon has an RTL variant. + + The “Indent” item and icon. The icon has an RTL variant. Use named icon &quot;format-indent-more&quot;. - - The “Index” item and icon. + + The “Index” item and icon. - - The “Info” item and icon. + + The “Info” item and icon. Use named icon &quot;dialog-information&quot;. - - The “Italic” item and icon. + + The “Italic” item and icon. Use named icon &quot;format-text-italic&quot;. - - The “Jump to” item and icon. The icon has an RTL variant. + + The “Jump to” item and icon. The icon has an RTL variant. Use named icon &quot;go-jump&quot;. - - The “Center” item and icon. + + The “Center” item and icon. Use named icon &quot;format-justify-center&quot;. - - The “Fill” item and icon. + + The “Fill” item and icon. Use named icon &quot;format-justify-fill&quot;. - - The “Left” item and icon. + + The “Left” item and icon. Use named icon &quot;format-justify-left&quot;. - - The “Right” item and icon. + + The “Right” item and icon. Use named icon &quot;format-justify-right&quot;. - - The “Leave Fullscreen” item and icon. + + The “Leave Fullscreen” item and icon. Use named icon &quot;view-restore&quot;. - - The “Media Forward” item and icon. The icon has an RTL variant. + + The “Media Forward” item and icon. The icon has an RTL variant. Use named icon &quot;media-seek-forward&quot; or the label &quot;_Forward&quot;. - - The “Media Next” item and icon. The icon has an RTL variant. + + The “Media Next” item and icon. The icon has an RTL variant. Use named icon &quot;media-skip-forward&quot; or the label &quot;_Next&quot;. - - The “Media Pause” item and icon. + + The “Media Pause” item and icon. Use named icon &quot;media-playback-pause&quot; or the label &quot;P_ause&quot;. - - The “Media Play” item and icon. The icon has an RTL variant. + + The “Media Play” item and icon. The icon has an RTL variant. Use named icon &quot;media-playback-start&quot; or the label &quot;_Play&quot;. - - The “Media Previous” item and icon. The icon has an RTL variant. + + The “Media Previous” item and icon. The icon has an RTL variant. Use named icon &quot;media-skip-backward&quot; or the label &quot;Pre_vious&quot;. - - The “Media Record” item and icon. + + The “Media Record” item and icon. Use named icon &quot;media-record&quot; or the label &quot;_Record&quot;. - - The “Media Rewind” item and icon. The icon has an RTL variant. + + The “Media Rewind” item and icon. The icon has an RTL variant. Use named icon &quot;media-seek-backward&quot; or the label &quot;R_ewind&quot;. - - The “Media Stop” item and icon. + + The “Media Stop” item and icon. Use named icon &quot;media-playback-stop&quot; or the label &quot;_Stop&quot;. - - The “Missing image” icon. + + The “Missing image” icon. Use named icon &quot;image-missing&quot;. - - The “Network” item and icon. + + The “Network” item and icon. Use named icon &quot;network-workgroup&quot;. - - The “New” item and icon. + + The “New” item and icon. Use named icon &quot;document-new&quot; or the label &quot;_New&quot;. - - The “No” item and icon. + + The “No” item and icon. - - The “OK” item and icon. + + The “OK” item and icon. Do not use an icon. Use label &quot;_OK&quot;. - - The “Open” item and icon. + + The “Open” item and icon. Use named icon &quot;document-open&quot; or the label &quot;_Open&quot;. - - The “Landscape Orientation” item and icon. + + The “Landscape Orientation” item and icon. - - The “Portrait Orientation” item and icon. + + The “Portrait Orientation” item and icon. - - The “Reverse Landscape Orientation” item and icon. + + The “Reverse Landscape Orientation” item and icon. - - The “Reverse Portrait Orientation” item and icon. + + The “Reverse Portrait Orientation” item and icon. - - The “Page Setup” item and icon. + + The “Page Setup” item and icon. Use named icon &quot;document-page-setup&quot; or the label &quot;Page Set_up&quot;. - - The “Paste” item and icon. + + The “Paste” item and icon. Use named icon &quot;edit-paste&quot; or the label &quot;_Paste&quot;. - - The “Preferences” item and icon. + + The “Preferences” item and icon. Use named icon &quot;preferences-system&quot; or the label &quot;_Preferences&quot;. - - The “Print” item and icon. + + The “Print” item and icon. Use named icon &quot;document-print&quot; or the label &quot;_Print&quot;. - - The “Print Error” icon. + + The “Print Error” icon. Use named icon &quot;printer-error&quot;. - - The “Print Paused” icon. + + The “Print Paused” icon. - - The “Print Preview” item and icon. + + The “Print Preview” item and icon. Use label &quot;Pre_view&quot;. - - The “Print Report” icon. + + The “Print Report” icon. - - The “Print Warning” icon. + + The “Print Warning” icon. - - The “Properties” item and icon. + + The “Properties” item and icon. Use named icon &quot;document-properties&quot; or the label &quot;_Properties&quot;. - - The “Quit” item and icon. + + The “Quit” item and icon. Use named icon &quot;application-exit&quot; or the label &quot;_Quit&quot;. - - The “Redo” item and icon. The icon has an RTL variant. + + The “Redo” item and icon. The icon has an RTL variant. Use named icon &quot;edit-redo&quot; or the label &quot;_Redo&quot;. - - The “Refresh” item and icon. + + The “Refresh” item and icon. Use named icon &quot;view-refresh&quot; or the label &quot;_Refresh&quot;. - - The “Remove” item and icon. + + The “Remove” item and icon. Use named icon &quot;list-remove&quot; or the label &quot;_Remove&quot;. - - The “Revert” item and icon. The icon has an RTL variant. + + The “Revert” item and icon. The icon has an RTL variant. Use named icon &quot;document-revert&quot; or the label &quot;_Revert&quot;. - - The “Save” item and icon. + + The “Save” item and icon. Use named icon &quot;document-save&quot; or the label &quot;_Save&quot;. - - The “Save As” item and icon. + + The “Save As” item and icon. Use named icon &quot;document-save-as&quot; or the label &quot;Save _As&quot;. - - The “Select All” item and icon. + + The “Select All” item and icon. Use named icon &quot;edit-select-all&quot; or the label &quot;Select _All&quot;. - - The “Color” item and icon. + + The “Color” item and icon. - - The “Font” item and icon. + + The “Font” item and icon. - - The “Ascending” item and icon. + + The “Ascending” item and icon. Use named icon &quot;view-sort-ascending&quot;. - - The “Descending” item and icon. + + The “Descending” item and icon. Use named icon &quot;view-sort-descending&quot;. - - The “Spell Check” item and icon. + + The “Spell Check” item and icon. Use named icon &quot;tools-check-spelling&quot;. - - The “Stop” item and icon. + + The “Stop” item and icon. Use named icon &quot;process-stop&quot; or the label &quot;_Stop&quot;. - - The “Strikethrough” item and icon. + + The “Strikethrough” item and icon. Use named icon &quot;format-text-strikethrough&quot; or the label &quot;_Strikethrough&quot;. - - The “Undelete” item and icon. The icon has an RTL variant. + + The “Undelete” item and icon. The icon has an RTL variant. - - The “Underline” item and icon. + + The “Underline” item and icon. Use named icon &quot;format-text-underline&quot; or the label &quot;_Underline&quot;. - - The “Undo” item and icon. The icon has an RTL variant. + + The “Undo” item and icon. The icon has an RTL variant. Use named icon &quot;edit-undo&quot; or the label &quot;_Undo&quot;. - - The “Unindent” item and icon. The icon has an RTL variant. + + The “Unindent” item and icon. The icon has an RTL variant. Use named icon &quot;format-indent-less&quot;. - - The “Yes” item and icon. + + The “Yes” item and icon. - - The “Zoom 100%” item and icon. + + The “Zoom 100%” item and icon. Use named icon &quot;zoom-original&quot; or the label &quot;_Normal Size&quot;. - - The “Zoom to Fit” item and icon. + + The “Zoom to Fit” item and icon. Use named icon &quot;zoom-fit-best&quot; or the label &quot;Best _Fit&quot;. - - The “Zoom In” item and icon. + + The “Zoom In” item and icon. Use named icon &quot;zoom-in&quot; or the label &quot;Zoom _In&quot;. - - The “Zoom Out” item and icon. + + The “Zoom Out” item and icon. Use named icon &quot;zoom-out&quot; or the label &quot;Zoom _Out&quot;. @@ -127318,179 +90718,115 @@ Since 3.0, this item has a label, before it only had an icon. - + - a #GtkStyle. + a #GtkStyle. - + - - A CSS class to match an accelerator. + + A CSS class to match an accelerator. Refer to individual widget documentation for used style classes. - - A CSS class used when rendering an arrow element. + + A CSS class used when rendering an arrow element. Refer to individual widget documentation for used style classes. - - A CSS class to match the window background. + + A CSS class to match the window background. Refer to individual widget documentation for used style classes. - - A CSS class to indicate an area at the bottom of a widget. + + A CSS class to indicate an area at the bottom of a widget. Refer to individual widget documentation for used style classes. - - A CSS class to match buttons. + + A CSS class to match buttons. Refer to individual widget documentation for used style classes. - - A CSS class to match calendars. + + A CSS class to match calendars. Refer to individual widget documentation for used style classes. - - A CSS class to match content rendered in cell views. + + A CSS class to match content rendered in cell views. Refer to individual widget documentation for used style classes. - - A CSS class to match check boxes. + + A CSS class to match check boxes. Refer to individual widget documentation for used style classes. - - A CSS class to match combobox entries. + + A CSS class to match combobox entries. Refer to individual widget documentation for used style classes. - - A CSS class to match context menus. + + A CSS class to match context menus. Refer to individual widget documentation for used style classes. - - A CSS class that gets added to windows which have client-side decorations. + + A CSS class that gets added to windows which have client-side decorations. Refer to individual widget documentation for used style classes. - - A CSS class used when rendering a drag handle for + + A CSS class used when rendering a drag handle for text selection. Refer to individual widget documentation for used style classes. - - A CSS class to match the default widget. + + A CSS class to match the default widget. Refer to individual widget documentation for used style classes. - - A CSS class used when an action (usually a button) is + + A CSS class used when an action (usually a button) is one that is expected to remove or destroy something visible to the user. @@ -127498,78 +90834,51 @@ Refer to individual widget documentation for used style classes. - - A CSS class to match dimmed labels. + + A CSS class to match dimmed labels. Refer to individual widget documentation for used style classes. - A CSS class for a drag-and-drop indicator. + A CSS class for a drag-and-drop indicator. Refer to individual widget documentation for used style classes. - - A CSS class defining a dock area. + + A CSS class defining a dock area. Refer to individual widget documentation for used style classes. - - A CSS class to match text entries. + + A CSS class to match text entries. Refer to individual widget documentation for used style classes. - - A CSS class for an area displaying an error message, + + A CSS class for an area displaying an error message, such as those in infobars. Refer to individual widget documentation for used style classes. - - A CSS class defining an expander, such as those in treeviews. + + A CSS class defining an expander, such as those in treeviews. Refer to individual widget documentation for used style classes. - - A CSS class that is added when widgets that usually have + + A CSS class that is added when widgets that usually have a frame or border (like buttons or entries) should appear without it. @@ -127577,12 +90886,8 @@ Refer to individual widget documentation for used style classes. - - A CSS class defining a frame delimiting content, such as + + A CSS class defining a frame delimiting content, such as #GtkFrame or the scrolled window frame around the scrollable area. @@ -127590,242 +90895,154 @@ Refer to individual widget documentation for used style classes. - - A CSS class defining a resize grip. + + A CSS class defining a resize grip. Refer to individual widget documentation for used style classes. - - A CSS class to match a header element. + + A CSS class to match a header element. Refer to individual widget documentation for used style classes. - - A CSS class defining a highlighted area, such as headings in + + A CSS class defining a highlighted area, such as headings in assistants and calendars. Refer to individual widget documentation for used style classes. - - A CSS class for horizontally layered widgets. + + A CSS class for horizontally layered widgets. Refer to individual widget documentation for used style classes. - - A CSS class defining an image, such as the icon in an entry. + + A CSS class defining an image, such as the icon in an entry. Refer to individual widget documentation for used style classes. - - A CSS class for an area displaying an informational message, + + A CSS class for an area displaying an informational message, such as those in infobars. Refer to individual widget documentation for used style classes. - - A CSS class to match inline toolbars. + + A CSS class to match inline toolbars. Refer to individual widget documentation for used style classes. - - A CSS class used when rendering a drag handle for + + A CSS class used when rendering a drag handle for the insertion cursor position. Refer to individual widget documentation for used style classes. - - A CSS class to match labels. + + A CSS class to match labels. Refer to individual widget documentation for used style classes. - - A CSS class to indicate an area at the left of a widget. + + A CSS class to indicate an area at the left of a widget. Refer to individual widget documentation for used style classes. - - A CSS class used when rendering a level indicator, such + + A CSS class used when rendering a level indicator, such as a battery charge level, or a password strength. Refer to individual widget documentation for used style classes. - - A CSS class to match a linked area, such as a box containing buttons + + A CSS class to match a linked area, such as a box containing buttons belonging to the same control. Refer to individual widget documentation for used style classes. - - A CSS class to match lists. + + A CSS class to match lists. Refer to individual widget documentation for used style classes. - - A CSS class to match list rows. + + A CSS class to match list rows. Refer to individual widget documentation for used style classes. - - A CSS class defining marks in a widget, such as in scales. + + A CSS class defining marks in a widget, such as in scales. Refer to individual widget documentation for used style classes. - - A CSS class to match menus. + + A CSS class to match menus. Refer to individual widget documentation for used style classes. - - A CSS class to menubars. + + A CSS class to menubars. Refer to individual widget documentation for used style classes. - - A CSS class to match menu items. + + A CSS class to match menu items. Refer to individual widget documentation for used style classes. - - A CSS class that is added to message dialogs. + + A CSS class that is added to message dialogs. Refer to individual widget documentation for used style classes. - - A CSS class that is added to text view that should use + + A CSS class that is added to text view that should use a monospace font. Refer to individual widget documentation for used style classes. - - A CSS class used when an element needs the user attention, + + A CSS class used when an element needs the user attention, for instance a button in a stack switcher corresponding to a hidden page that changed state. @@ -127833,34 +91050,23 @@ Refer to individual widget documentation for used style classes. - - A CSS class defining a notebook. + + A CSS class defining a notebook. Refer to individual widget documentation for used style classes. - A CSS class used when rendering an OSD (On Screen Display) element, + A CSS class used when rendering an OSD (On Screen Display) element, on top of another container. Refer to individual widget documentation for used style classes. - - A CSS class that is added on the visual hints that happen + + A CSS class that is added on the visual hints that happen when scrolling is attempted past the limits of a scrollable area. @@ -127868,24 +91074,15 @@ Refer to individual widget documentation for used style classes. - - A CSS class for a pane separator, such as those in #GtkPaned. + + A CSS class for a pane separator, such as those in #GtkPaned. Refer to individual widget documentation for used style classes. - - A CSS class that is added to areas that should look like paper. + + A CSS class that is added to areas that should look like paper. This is used in print previews and themes are encouraged to style it as black text on white background. @@ -127894,148 +91091,94 @@ Refer to individual widget documentation for used style classes. - - A CSS class that matches popovers. + + A CSS class that matches popovers. Refer to individual widget documentation for used style classes. - - A CSS class that is added to the toplevel windows used for menus. + + A CSS class that is added to the toplevel windows used for menus. Refer to individual widget documentation for used style classes. - - A CSS class to match primary toolbars. + + A CSS class to match primary toolbars. Refer to individual widget documentation for used style classes. - - A CSS class to use when rendering activity as a progressbar. + + A CSS class to use when rendering activity as a progressbar. Refer to individual widget documentation for used style classes. - - A CSS class to use when rendering a pulse in an indeterminate progress bar. + + A CSS class to use when rendering a pulse in an indeterminate progress bar. Refer to individual widget documentation for used style classes. - - A CSS class for an area displaying a question to the user, + + A CSS class for an area displaying a question to the user, such as those in infobars. Refer to individual widget documentation for used style classes. - - A CSS class to match radio buttons. + + A CSS class to match radio buttons. Refer to individual widget documentation for used style classes. - - A CSS class to match a raised control, such as a raised + + A CSS class to match a raised control, such as a raised button on a toolbar. Refer to individual widget documentation for used style classes. - - A CSS class used to indicate a read-only state. + + A CSS class used to indicate a read-only state. Refer to individual widget documentation for used style classes. - - A CSS class to indicate an area at the right of a widget. + + A CSS class to indicate an area at the right of a widget. Refer to individual widget documentation for used style classes. - - A CSS class to match the rubberband selection rectangle. + + A CSS class to match the rubberband selection rectangle. Refer to individual widget documentation for used style classes. - - A CSS class to match scale widgets. + + A CSS class to match scale widgets. Refer to individual widget documentation for used style classes. - - A CSS class to match scale widgets with marks attached, + + A CSS class to match scale widgets with marks attached, all the marks are above for horizontal #GtkScale. left for vertical #GtkScale. @@ -128043,12 +91186,8 @@ Refer to individual widget documentation for used style classes. - - A CSS class to match scale widgets with marks attached, + + A CSS class to match scale widgets with marks attached, all the marks are below for horizontal #GtkScale, right for vertical #GtkScale. @@ -128056,209 +91195,133 @@ Refer to individual widget documentation for used style classes. - - A CSS class to match scrollbars. + + A CSS class to match scrollbars. Refer to individual widget documentation for used style classes. - - A CSS class to match the junction area between an horizontal -and vertical scrollbar, when they’re both shown. + + A CSS class to match the junction area between an horizontal +and vertical scrollbar, when they’re both shown. Refer to individual widget documentation for used style classes. - - A CSS class for a separator. + + A CSS class for a separator. Refer to individual widget documentation for used style classes. - - A CSS class defining a sidebar, such as the left side in + + A CSS class defining a sidebar, such as the left side in a file chooser. Refer to individual widget documentation for used style classes. - - A CSS class to match sliders. + + A CSS class to match sliders. Refer to individual widget documentation for used style classes. - - A CSS class defining an spinbutton. + + A CSS class defining an spinbutton. Refer to individual widget documentation for used style classes. - - A CSS class to use when rendering activity as a “spinner”. + + A CSS class to use when rendering activity as a “spinner”. Refer to individual widget documentation for used style classes. - - A CSS class to match statusbars. + + A CSS class to match statusbars. Refer to individual widget documentation for used style classes. - - A CSS class used for the subtitle label in a titlebar in + + A CSS class used for the subtitle label in a titlebar in a toplevel window. Refer to individual widget documentation for used style classes. - - A CSS class used when an action (usually a button) is the + + A CSS class used when an action (usually a button) is the primary suggested action in a specific context. Refer to individual widget documentation for used style classes. - - A CSS class used for the title label in a titlebar in + + A CSS class used for the title label in a titlebar in a toplevel window. Refer to individual widget documentation for used style classes. - - A CSS class used when rendering a titlebar in a toplevel window. + + A CSS class used when rendering a titlebar in a toplevel window. Refer to individual widget documentation for used style classes. - - A CSS class to match toolbars. + + A CSS class to match toolbars. Refer to individual widget documentation for used style classes. - - A CSS class to match tooltip windows. + + A CSS class to match tooltip windows. Refer to individual widget documentation for used style classes. - A CSS class to indicate an area at the top of a widget. + A CSS class to indicate an area at the top of a widget. Refer to individual widget documentation for used style classes. - - A CSS class for touch selection popups on entries + + A CSS class for touch selection popups on entries and text views. Refer to individual widget documentation for used style classes. - - A CSS class to match troughs, as in scrollbars and progressbars. + + A CSS class to match troughs, as in scrollbars and progressbars. Refer to individual widget documentation for used style classes. - - A CSS class that is added on the visual hints that happen + + A CSS class that is added on the visual hints that happen where content is 'scrolled off' and can be made visible by scrolling. @@ -128266,170 +91329,112 @@ Refer to individual widget documentation for used style classes. - - A CSS class for vertically layered widgets. + + A CSS class for vertically layered widgets. Refer to individual widget documentation for used style classes. - - A CSS class defining a view, such as iconviews or treeviews. + + A CSS class defining a view, such as iconviews or treeviews. Refer to individual widget documentation for used style classes. - - A CSS class for an area displaying a warning message, + + A CSS class for an area displaying a warning message, such as those in infobars. Refer to individual widget documentation for used style classes. - - A CSS class to indicate that a UI element should be 'wide'. + + A CSS class to indicate that a UI element should be 'wide'. Used by #GtkPaned. Refer to individual widget documentation for used style classes. - + - + - + - + - - + + - - + + - - + + - - A property holding the background color of rendered elements as a #GdkRGBA. + + A property holding the background color of rendered elements as a #GdkRGBA. - - A property holding the element’s background as a #cairo_pattern_t. + + A property holding the element’s background as a #cairo_pattern_t. - - A property holding the element’s border color as a #GdkRGBA. + + A property holding the element’s border color as a #GdkRGBA. - - A property holding the rendered element’s border radius in pixels as a #gint. + + A property holding the rendered element’s border radius in pixels as a #gint. - - A property holding the element’s border style as a #GtkBorderStyle. + + A property holding the element’s border style as a #GtkBorderStyle. - - A property holding the rendered element’s border width in pixels as + + A property holding the rendered element’s border width in pixels as a #GtkBorder. The border is the intermediary spacing property of the padding/border/margin series. @@ -128439,31 +91444,19 @@ requesting size - - A property holding the foreground color of rendered elements as a #GdkRGBA. + + A property holding the foreground color of rendered elements as a #GdkRGBA. - - A property holding the font properties used when rendering text + + A property holding the font properties used when rendering text as a #PangoFontDescription. - - A property holding the rendered element’s margin as a #GtkBorder. The + + A property holding the rendered element’s margin as a #GtkBorder. The margin is defined as the spacing between the border of the element and its surrounding elements. It is external to #GtkWidget's size allocations, and the most external spacing property of the @@ -128471,52 +91464,36 @@ padding/border/margin series. - - A property holding the rendered element’s padding as a #GtkBorder. The + + A property holding the rendered element’s padding as a #GtkBorder. The padding is defined as the spacing between the inner part of the element border -and its child. It’s the innermost spacing property of the padding/border/margin +and its child. It’s the innermost spacing property of the padding/border/margin series. - + - + - - A priority that can be used when adding a #GtkStyleProvider + + A priority that can be used when adding a #GtkStyleProvider for application-specific style information. - - The priority used for default style information + + The priority used for default style information that is used in the absence of themes. Note that this is not very useful for providing default @@ -128526,12 +91503,8 @@ catch-all `* {...}` rules. - - The priority used for style information provided + + The priority used for style information provided via #GtkSettings. This priority is higher than #GTK_STYLE_PROVIDER_PRIORITY_THEME @@ -128539,22 +91512,14 @@ to let settings override themes. - - The priority used for style information provided + + The priority used for style information provided by themes. - - The priority used for the style information from + + The priority used for the style information from `XDG_CONFIG_HOME/gtk-3.0/gtk.css`. You should not use priorities higher than this, to @@ -128562,50 +91527,26 @@ give the user the last word. - - A widget region name to define a treeview column. + + A widget region name to define a treeview column. Don't use regions. - - A widget region name to define a treeview column header. + + A widget region name to define a treeview column header. Don't use regions. - - A widget region name to define a treeview row. + + A widget region name to define a treeview row. Don't use regions. - - A widget region name to define a notebook tab. + + A widget region name to define a notebook tab. Don't use regions. @@ -128617,62 +91558,44 @@ give the user the last word. - + - + - + - + - + - - A GtkScale is a slider control used to select a numeric value. -To use it, you’ll probably want to investigate the methods on + + A GtkScale is a slider control used to select a numeric value. +To use it, you’ll probably want to investigate the methods on its base class, #GtkRange, in addition to the methods for GtkScale itself. To set the value of a scale, you would normally use gtk_range_set_value(). To detect changes to the value, you would normally use the @@ -128686,33 +91609,33 @@ changing the layout of the application (such as movie or music players). # GtkScale as GtkBuildable GtkScale supports a custom <marks> element, which can contain multiple -<mark> elements. The “value” and “position” attributes have the same +<mark> elements. The “value” and “position” attributes have the same meaning as gtk_scale_add_mark() parameters of the same name. If the element is not empty, its content is taken as the markup to show at -the mark. It can be translated with the usual ”translatable” and -“context” attributes. +the mark. It can be translated with the usual ”translatable” and +“context” attributes. # CSS nodes |[<!-- language="plain" --> scale[.fine-tune][.marks-before][.marks-after] -├── marks.top -│ ├── mark -│ ┊ ├── [label] -│ ┊ ╰── indicator -┊ ┊ -│ ╰── mark -├── [value] -├── contents -│ ╰── trough -│ ├── slider -│ ├── [highlight] -│ ╰── [fill] -╰── marks.bottom - ├── mark - ┊ ├── indicator - ┊ ╰── [label] - ╰── mark +├── marks.top +│ ├── mark +│ ┊ ├── [label] +│ ┊ ╰── indicator +┊ ┊ +│ ╰── mark +├── [value] +├── contents +│ ╰── trough +│ ├── slider +│ ├── [highlight] +│ ╰── [fill] +╰── marks.bottom + ├── mark + ┊ ├── indicator + ┊ ╰── [label] + ╰── mark ]| GtkScale has a main CSS node with name scale and a subnode for its contents, @@ -128748,43 +91671,28 @@ subnode with name value. - Creates a new #GtkScale. + Creates a new #GtkScale. - a new #GtkScale + a new #GtkScale - the scale’s orientation. + the scale’s orientation. - - the #GtkAdjustment which sets the range + + the #GtkAdjustment which sets the range of the scale, or %NULL to create a new adjustment. - - Creates a new scale widget with the given orientation that lets the + + Creates a new scale widget with the given orientation that lets the user input a number between @min and @max (including @min and @max) -with the increment @step. @step must be nonzero; it’s the distance +with the increment @step. @step must be nonzero; it’s the distance the slider moves when using the arrow keys to adjust the scale value. @@ -128793,34 +91701,24 @@ is a power of ten. If the resulting precision is not suitable for your needs, use gtk_scale_set_digits() to correct it. - a new #GtkScale + a new #GtkScale - the scale’s orientation. + the scale’s orientation. - minimum value + minimum value - maximum value + maximum value - step increment (tick size) used with keyboard shortcuts + step increment (tick size) used with keyboard shortcuts @@ -128850,12 +91748,8 @@ needs, use gtk_scale_set_digits() to correct it. - - Obtains the coordinates where the scale will draw the + + Obtains the coordinates where the scale will draw the #PangoLayout representing the text in the scale. Remember when using the #PangoLayout function you need to convert to and from pixels using PANGO_PIXELS() or #PANGO_SCALE. @@ -128868,39 +91762,21 @@ values are undefined. - a #GtkScale + a #GtkScale - - location to store X offset of layout, or %NULL + + location to store X offset of layout, or %NULL - - location to store Y offset of layout, or %NULL + + location to store Y offset of layout, or %NULL - Adds a mark at @value. + Adds a mark at @value. A mark is indicated visually by drawing a tick mark next to the scale, and GTK+ makes it easy for the user to position the scale exactly at the @@ -128915,151 +91791,102 @@ To remove marks from a scale, use gtk_scale_clear_marks(). - a #GtkScale + a #GtkScale - the value at which the mark is placed, must be between - the lower and upper limits of the scales’ adjustment + the value at which the mark is placed, must be between + the lower and upper limits of the scales’ adjustment - where to draw the mark. For a horizontal scale, #GTK_POS_TOP + where to draw the mark. For a horizontal scale, #GTK_POS_TOP and %GTK_POS_LEFT are drawn above the scale, anything else below. For a vertical scale, #GTK_POS_LEFT and %GTK_POS_TOP are drawn to the left of the scale, anything else to the right. - - Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL + + Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL - - Removes any marks that have been added with gtk_scale_add_mark(). + + Removes any marks that have been added with gtk_scale_add_mark(). - a #GtkScale + a #GtkScale - Gets the number of decimal places that are displayed in the value. + Gets the number of decimal places that are displayed in the value. - the number of decimal places that are displayed + the number of decimal places that are displayed - a #GtkScale + a #GtkScale - Returns whether the current value is displayed as a string + Returns whether the current value is displayed as a string next to the slider. - whether the current value is displayed as a string + whether the current value is displayed as a string - a #GtkScale + a #GtkScale - - Returns whether the scale has an origin. + + Returns whether the scale has an origin. - %TRUE if the scale has an origin. + %TRUE if the scale has an origin. - a #GtkScale + a #GtkScale - - Gets the #PangoLayout used to display the scale. The returned + + Gets the #PangoLayout used to display the scale. The returned object is owned by the scale so does not need to be freed by the caller. - the #PangoLayout for this scale, + the #PangoLayout for this scale, or %NULL if the #GtkScale:draw-value property is %FALSE. - A #GtkScale + A #GtkScale - - Obtains the coordinates where the scale will draw the + + Obtains the coordinates where the scale will draw the #PangoLayout representing the text in the scale. Remember when using the #PangoLayout function you need to convert to and from pixels using PANGO_PIXELS() or #PANGO_SCALE. @@ -129072,59 +91899,35 @@ values are undefined. - a #GtkScale + a #GtkScale - - location to store X offset of layout, or %NULL + + location to store X offset of layout, or %NULL - - location to store Y offset of layout, or %NULL + + location to store Y offset of layout, or %NULL - Gets the position in which the current value is displayed. + Gets the position in which the current value is displayed. - the position in which the current value is displayed + the position in which the current value is displayed - a #GtkScale + a #GtkScale - Sets the number of decimal places that are displayed in the value. Also + Sets the number of decimal places that are displayed in the value. Also causes the value of the adjustment to be rounded to this number of digits, so the retrieved value matches the displayed one, if #GtkScale:draw-value is %TRUE when the value changes. If you want to enforce rounding the value when @@ -129140,24 +91943,18 @@ value yourself. - a #GtkScale + a #GtkScale - the number of decimal places to display, + the number of decimal places to display, e.g. use 1 to display 1.0, 2 to display 1.00, etc - Specifies whether the current value is displayed as a string next + Specifies whether the current value is displayed as a string next to the slider. @@ -129165,25 +91962,17 @@ to the slider. - a #GtkScale + a #GtkScale - %TRUE to draw the value + %TRUE to draw the value - - If #GtkScale:has-origin is set to %TRUE (the default), the scale will + + If #GtkScale:has-origin is set to %TRUE (the default), the scale will highlight the part of the trough between the origin (bottom or left side) and the current value. @@ -129192,38 +91981,28 @@ and the current value. - a #GtkScale + a #GtkScale - %TRUE if the scale has an origin + %TRUE if the scale has an origin - Sets the position in which the current value is displayed. + Sets the position in which the current value is displayed. - a #GtkScale + a #GtkScale - the position in which the current value is displayed + the position in which the current value is displayed @@ -129247,9 +92026,7 @@ and the current value. - Signal which allows you to change how the scale value is displayed. + Signal which allows you to change how the scale value is displayed. Connect a signal handler which returns an allocated string representing @value. That string will then be used to display the scale's value. @@ -129268,28 +92045,18 @@ format_value_callback (GtkScale *scale, } ]| - allocated string representing @value + allocated string representing @value - the value to format + the value to format - + @@ -129297,33 +92064,20 @@ format_value_callback (GtkScale *scale, - + - + - + - - #GtkScaleButton provides a button which pops up a scale widget. + + #GtkScaleButton provides a button which pops up a scale widget. This kind of widget is commonly used for volume controls in multimedia applications, and GTK+ provides a #GtkVolumeButton subclass that is tailored for this use case. @@ -129340,53 +92094,34 @@ The popup widget that contains the scale has a .scale-popup style class. - - Creates a #GtkScaleButton, with a range between @min and @max, with + + Creates a #GtkScaleButton, with a range between @min and @max, with a stepping of @step. - a new #GtkScaleButton + a new #GtkScaleButton - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - the minimum value of the scale (usually 0) + the minimum value of the scale (usually 0) - the maximum value of the scale (usually 100) + the maximum value of the scale (usually 100) - the stepping of value when a scroll-wheel event, + the stepping of value when a scroll-wheel event, or up/down arrow event occurs (usually 2) - - a %NULL-terminated + + a %NULL-terminated array of icon names, or %NULL if you want to set the list later with gtk_scale_button_set_icons() @@ -129409,124 +92144,80 @@ a stepping of @step. - - Gets the #GtkAdjustment associated with the #GtkScaleButton’s scale. + + Gets the #GtkAdjustment associated with the #GtkScaleButton’s scale. See gtk_range_get_adjustment() for details. - the adjustment associated with the scale + the adjustment associated with the scale - a #GtkScaleButton + a #GtkScaleButton - - Retrieves the minus button of the #GtkScaleButton. + + Retrieves the minus button of the #GtkScaleButton. - the minus button of the #GtkScaleButton as a #GtkButton + the minus button of the #GtkScaleButton as a #GtkButton - a #GtkScaleButton + a #GtkScaleButton - - Retrieves the plus button of the #GtkScaleButton. + + Retrieves the plus button of the #GtkScaleButton. - the plus button of the #GtkScaleButton as a #GtkButton + the plus button of the #GtkScaleButton as a #GtkButton - a #GtkScaleButton + a #GtkScaleButton - - Retrieves the popup of the #GtkScaleButton. + + Retrieves the popup of the #GtkScaleButton. - the popup of the #GtkScaleButton + the popup of the #GtkScaleButton - a #GtkScaleButton + a #GtkScaleButton - - Gets the current value of the scale button. + + Gets the current value of the scale button. - current value of the scale button + current value of the scale button - a #GtkScaleButton + a #GtkScaleButton - - Sets the #GtkAdjustment to be used as a model -for the #GtkScaleButton’s scale. + + Sets the #GtkAdjustment to be used as a model +for the #GtkScaleButton’s scale. See gtk_range_set_adjustment() for details. @@ -129534,25 +92225,17 @@ See gtk_range_set_adjustment() for details. - a #GtkScaleButton + a #GtkScaleButton - a #GtkAdjustment + a #GtkAdjustment - - Sets the icons to be used by the scale button. + + Sets the icons to be used by the scale button. For details, see the #GtkScaleButton:icons property. @@ -129560,27 +92243,19 @@ For details, see the #GtkScaleButton:icons property. - a #GtkScaleButton + a #GtkScaleButton - a %NULL-terminated array of icon names + a %NULL-terminated array of icon names - - Sets the current value of the scale; if the value is outside + + Sets the current value of the scale; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The scale button emits the #GtkScaleButton::value-changed signal if the value changes. @@ -129590,15 +92265,11 @@ signal if the value changes. - a #GtkScaleButton + a #GtkScaleButton - new value of the scale button + new value of the scale button @@ -129606,13 +92277,8 @@ signal if the value changes. - - The names of the icons to be used by the scale button. + + The names of the icons to be used by the scale button. The first item in the array will be used in the button when the current value is the lowest value, the second item for the highest value. All the subsequent icons will @@ -129644,9 +92310,7 @@ better for the users. - The ::popdown signal is a + The ::popdown signal is a [keybinding signal][GtkBindingSignal] which gets emitted to popdown the scale widget. @@ -129656,9 +92320,7 @@ The default binding for this signal is Escape. - The ::popup signal is a + The ::popup signal is a [keybinding signal][GtkBindingSignal] which gets emitted to popup the scale widget. @@ -129668,32 +92330,21 @@ The default bindings for this signal are Space, Enter and Return. - The ::value-changed signal is emitted when the value field has + The ::value-changed signal is emitted when the value field has changed. - the new value + the new value - - + + @@ -129702,28 +92353,19 @@ changed. - + - - + + - - + + - + @@ -129777,14 +92419,10 @@ changed. - + - + @@ -129826,31 +92464,15 @@ changed. - a #GtkScale + a #GtkScale - - location to store X offset of layout, or %NULL + + location to store X offset of layout, or %NULL - - location to store Y offset of layout, or %NULL + + location to store Y offset of layout, or %NULL @@ -129892,204 +92514,79 @@ changed. - - - Scroll in steps. + + + Scroll in steps. - - Scroll by pages. + + Scroll by pages. - - Scroll to ends. + + Scroll to ends. - - Scroll in horizontal steps. + + Scroll in horizontal steps. - - Scroll by horizontal pages. + + Scroll by horizontal pages. - - Scroll to the horizontal ends. + + Scroll to the horizontal ends. - - Scrolling types. - - No scrolling. + + Scrolling types. + + No scrolling. - - Jump to new location. + + Jump to new location. - - Step backward. + + Step backward. - - Step forward. + + Step forward. - - Page backward. + + Page backward. - - Page forward. + + Page forward. - - Step up. + + Step up. - - Step down. + + Step down. - - Page up. + + Page up. - - Page down. + + Page down. - - Step to the left. + + Step to the left. - - Step to the right. + + Step to the right. - - Page to the left. + + Page to the left. - - Page to the right. + + Page to the right. - - Scroll to start. + + Scroll to start. - - Scroll to end. + + Scroll to end. - - #GtkScrollable is an interface that is implemented by widgets with native + + #GtkScrollable is an interface that is implemented by widgets with native scrolling ability. To implement this interface you should override the @@ -130099,8 +92596,8 @@ To implement this interface you should override the All scrollable widgets should do the following. -- When a parent widget sets the scrollable child widget’s adjustments, - the widget should populate the adjustments’ +- When a parent widget sets the scrollable child widget’s adjustments, + the widget should populate the adjustments’ #GtkAdjustment:lower, #GtkAdjustment:upper, #GtkAdjustment:step-increment, #GtkAdjustment:page-increment and #GtkAdjustment:page-size properties and connect to the @@ -130112,201 +92609,130 @@ All scrollable widgets should do the following. #GtkWidgetClass.size_allocate() function. - When the parent allocates space to the scrollable child widget, - the widget should update the adjustments’ properties with new values. + the widget should update the adjustments’ properties with new values. - When any of the adjustments emits the #GtkAdjustment::value-changed signal, the scrollable widget should scroll its contents. - Returns the size of a non-scrolling border around the + Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position. - %TRUE if @border has been set + %TRUE if @border has been set - a #GtkScrollable + a #GtkScrollable - - return location for the results + + return location for the results - - Returns the size of a non-scrolling border around the + + Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position. - %TRUE if @border has been set + %TRUE if @border has been set - a #GtkScrollable + a #GtkScrollable - - return location for the results + + return location for the results - - Retrieves the #GtkAdjustment used for horizontal scrolling. + + Retrieves the #GtkAdjustment used for horizontal scrolling. - horizontal #GtkAdjustment. + horizontal #GtkAdjustment. - a #GtkScrollable + a #GtkScrollable - - Gets the horizontal #GtkScrollablePolicy. + + Gets the horizontal #GtkScrollablePolicy. - The horizontal #GtkScrollablePolicy. + The horizontal #GtkScrollablePolicy. - a #GtkScrollable + a #GtkScrollable - - Retrieves the #GtkAdjustment used for vertical scrolling. + + Retrieves the #GtkAdjustment used for vertical scrolling. - vertical #GtkAdjustment. + vertical #GtkAdjustment. - a #GtkScrollable + a #GtkScrollable - - Gets the vertical #GtkScrollablePolicy. + + Gets the vertical #GtkScrollablePolicy. - The vertical #GtkScrollablePolicy. + The vertical #GtkScrollablePolicy. - a #GtkScrollable + a #GtkScrollable - - Sets the horizontal adjustment of the #GtkScrollable. + + Sets the horizontal adjustment of the #GtkScrollable. - a #GtkScrollable + a #GtkScrollable - - a #GtkAdjustment + + a #GtkAdjustment - - Sets the #GtkScrollablePolicy to determine whether + + Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width. @@ -130315,53 +92741,34 @@ below the natural width. - a #GtkScrollable + a #GtkScrollable - the horizontal #GtkScrollablePolicy + the horizontal #GtkScrollablePolicy - - Sets the vertical adjustment of the #GtkScrollable. + + Sets the vertical adjustment of the #GtkScrollable. - a #GtkScrollable + a #GtkScrollable - - a #GtkAdjustment + + a #GtkAdjustment - - Sets the #GtkScrollablePolicy to determine whether + + Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height. @@ -130370,65 +92777,37 @@ below the natural height. - a #GtkScrollable + a #GtkScrollable - the vertical #GtkScrollablePolicy + the vertical #GtkScrollablePolicy - - Horizontal #GtkAdjustment of the scrollable widget. This adjustment is + + Horizontal #GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. - - Determines whether horizontal scrolling should start once the scrollable + + Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width. - - Verical #GtkAdjustment of the scrollable widget. This adjustment is shared + + Verical #GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. - - Determines whether vertical scrolling should start once the scrollable + + Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height. - + @@ -130437,66 +92816,34 @@ widget is allocated less than its minimum height or less than its natural height - %TRUE if @border has been set + %TRUE if @border has been set - a #GtkScrollable + a #GtkScrollable - - return location for the results + + return location for the results - - Defines the policy to be used in a scrollable widget when updating + + Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation. - - Scrollable adjustments are based on the minimum size + + Scrollable adjustments are based on the minimum size - - Scrollable adjustments are based on the natural size + + Scrollable adjustments are based on the natural size - - The #GtkScrollbar widget is a horizontal or vertical scrollbar, + + The #GtkScrollbar widget is a horizontal or vertical scrollbar, depending on the value of the #GtkOrientable:orientation property. Its position and movement are controlled by the adjustment that is passed to @@ -130513,13 +92860,13 @@ stepper buttons) or by a page (using e.g. the Page Down/Up keys). |[<!-- language="plain" --> scrollbar[.fine-tune] -╰── contents - ├── [button.up] - ├── [button.down] - ├── trough - │ ╰── slider - ├── [button.up] - ╰── [button.down] +╰── contents + ├── [button.up] + ├── [button.down] + ├── trough + │ ╰── slider + ├── [button.up] + ╰── [button.down] ]| GtkScrollbar has a main CSS node with name scrollbar and a subnode for its @@ -130540,30 +92887,19 @@ classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering). - Creates a new scrollbar with the given orientation. + Creates a new scrollbar with the given orientation. - the new #GtkScrollbar. + the new #GtkScrollbar. - the scrollbar’s orientation. + the scrollbar’s orientation. - - the #GtkAdjustment to use, or %NULL to create a new adjustment. + + the #GtkAdjustment to use, or %NULL to create a new adjustment. @@ -130572,9 +92908,7 @@ classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering). - + @@ -130612,24 +92946,16 @@ classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering). - - GtkScrolledWindow is a container that accepts a single child widget, makes + + GtkScrolledWindow is a container that accepts a single child widget, makes that child scrollable using either internally added scrollbars or externally associated adjustments, and optionally draws a frame around the child. Widgets with native scrolling support, i.e. those whose classes implement the #GtkScrollable interface, are added directly. For other types of widget, the class #GtkViewport acts as an adaptor, giving scrollability to other widgets. -GtkScrolledWindow’s implementation of gtk_container_add() intelligently -accounts for whether or not the added child is a #GtkScrollable. If it isn’t, +GtkScrolledWindow’s implementation of gtk_container_add() intelligently +accounts for whether or not the added child is a #GtkScrollable. If it isn’t, #GtkScrolledWindow wraps the child in a #GtkViewport and adds that for you. Therefore, you can just add any child widget and not worry about the details. @@ -130659,11 +92985,11 @@ GtkScrolledWindow adds internal #GtkScrollbar widgets around its child. The scroll position of the child, and if applicable the scrollbars, is controlled by the #GtkScrolledWindow:hadjustment and #GtkScrolledWindow:vadjustment that are associated with the GtkScrolledWindow. See the docs on #GtkScrollbar -for the details, but note that the “step_increment” and “page_increment” +for the details, but note that the “step_increment” and “page_increment” fields are only effective if the policy causes scrollbars to be present. -If a GtkScrolledWindow doesn’t behave quite as you would like, or -doesn’t have exactly the right layout, it’s very possible to set up +If a GtkScrolledWindow doesn’t behave quite as you would like, or +doesn’t have exactly the right layout, it’s very possible to set up your own scrolling with #GtkScrollbar and for example a #GtkGrid. # Touch support @@ -130702,38 +93028,24 @@ with a subnode named junction. - Creates a new scrolled window. + Creates a new scrolled window. -The two arguments are the scrolled window’s adjustments; these will be +The two arguments are the scrolled window’s adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass %NULL for the adjustments, which will cause the scrolled window to create them for you. - a new scrolled window + a new scrolled window - - horizontal adjustment + + horizontal adjustment - - vertical adjustment + + vertical adjustment @@ -130769,13 +93081,8 @@ will cause the scrolled window to create them for you. - - Used to add children without native scrolling capabilities. This + + Used to add children without native scrolling capabilities. This is simply a convenience function; it is equivalent to adding the unscrollable child to a viewport, then adding the viewport to the scrolled window. If a child has native scrolling, use @@ -130792,237 +93099,157 @@ widgets with native scrolling support should not be used with the A widget supports scrolling natively if it implements the #GtkScrollable interface. gtk_container_add() will automatically add -a #GtkViewport if the child doesn’t implement #GtkScrollable. +a #GtkViewport if the child doesn’t implement #GtkScrollable. - a #GtkScrolledWindow + a #GtkScrolledWindow - the widget you want to scroll + the widget you want to scroll - - Return whether button presses are captured during kinetic + + Return whether button presses are captured during kinetic scrolling. See gtk_scrolled_window_set_capture_button_press(). - %TRUE if button presses are captured during kinetic scrolling + %TRUE if button presses are captured during kinetic scrolling - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the horizontal scrollbar’s adjustment, used to connect the -horizontal scrollbar to the child widget’s horizontal scroll + + Returns the horizontal scrollbar’s adjustment, used to connect the +horizontal scrollbar to the child widget’s horizontal scroll functionality. - the horizontal #GtkAdjustment + the horizontal #GtkAdjustment - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the horizontal scrollbar of @scrolled_window. + + Returns the horizontal scrollbar of @scrolled_window. - the horizontal scrollbar of the scrolled window. + the horizontal scrollbar of the scrolled window. - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the specified kinetic scrolling behavior. + + Returns the specified kinetic scrolling behavior. - the scrolling behavior flags. + the scrolling behavior flags. - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the maximum content height set. + + Returns the maximum content height set. - the maximum content height, or -1 + the maximum content height, or -1 - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the maximum content width set. + + Returns the maximum content width set. - the maximum content width, or -1 + the maximum content width, or -1 - a #GtkScrolledWindow + a #GtkScrolledWindow - - Gets the minimal content height of @scrolled_window, or -1 if not set. + + Gets the minimal content height of @scrolled_window, or -1 if not set. - the minimal content height + the minimal content height - a #GtkScrolledWindow + a #GtkScrolledWindow - - Gets the minimum content width of @scrolled_window, or -1 if not set. + + Gets the minimum content width of @scrolled_window, or -1 if not set. - the minimum content width + the minimum content width - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns whether overlay scrolling is enabled for this scrolled window. + + Returns whether overlay scrolling is enabled for this scrolled window. - %TRUE if overlay scrolling is enabled + %TRUE if overlay scrolling is enabled - a #GtkScrolledWindow + a #GtkScrolledWindow - - Gets the placement of the contents with respect to the scrollbars + + Gets the placement of the contents with respect to the scrollbars for the scrolled window. See gtk_scrolled_window_set_placement(). - the current placement value. + the current placement value. See also gtk_scrolled_window_set_placement() and gtk_scrolled_window_unset_placement(). @@ -131030,17 +93257,13 @@ gtk_scrolled_window_unset_placement(). - a #GtkScrolledWindow + a #GtkScrolledWindow - Retrieves the current policy values for the horizontal and vertical + Retrieves the current policy values for the horizontal and vertical scrollbars. See gtk_scrolled_window_set_policy(). @@ -131048,155 +93271,97 @@ scrollbars. See gtk_scrolled_window_set_policy(). - a #GtkScrolledWindow + a #GtkScrolledWindow - - location to store the policy + + location to store the policy for the horizontal scrollbar, or %NULL - - location to store the policy + + location to store the policy for the vertical scrollbar, or %NULL - - Reports whether the natural height of the child will be calculated and propagated -through the scrolled window’s requested natural height. + + Reports whether the natural height of the child will be calculated and propagated +through the scrolled window’s requested natural height. - whether natural height propagation is enabled. + whether natural height propagation is enabled. - a #GtkScrolledWindow + a #GtkScrolledWindow - - Reports whether the natural width of the child will be calculated and propagated -through the scrolled window’s requested natural width. + + Reports whether the natural width of the child will be calculated and propagated +through the scrolled window’s requested natural width. - whether natural width propagation is enabled. + whether natural width propagation is enabled. - a #GtkScrolledWindow + a #GtkScrolledWindow - - Gets the shadow type of the scrolled window. See + + Gets the shadow type of the scrolled window. See gtk_scrolled_window_set_shadow_type(). - the current shadow type + the current shadow type - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the vertical scrollbar’s adjustment, used to connect the -vertical scrollbar to the child widget’s vertical scroll functionality. + + Returns the vertical scrollbar’s adjustment, used to connect the +vertical scrollbar to the child widget’s vertical scroll functionality. - the vertical #GtkAdjustment + the vertical #GtkAdjustment - a #GtkScrolledWindow + a #GtkScrolledWindow - - Returns the vertical scrollbar of @scrolled_window. + + Returns the vertical scrollbar of @scrolled_window. - the vertical scrollbar of the scrolled window. + the vertical scrollbar of the scrolled window. - a #GtkScrolledWindow + a #GtkScrolledWindow - - Changes the behaviour of @scrolled_window with regard to the initial + + Changes the behaviour of @scrolled_window with regard to the initial event that possibly starts kinetic scrolling. When @capture_button_press is set to %TRUE, the event is captured by the scrolled window, and then later replayed if it is meant to go to the child widget. @@ -131213,52 +93378,34 @@ This setting only has an effect if kinetic scrolling is enabled. - a #GtkScrolledWindow + a #GtkScrolledWindow - %TRUE to capture button presses + %TRUE to capture button presses - - Sets the #GtkAdjustment for the horizontal scrollbar. + + Sets the #GtkAdjustment for the horizontal scrollbar. - a #GtkScrolledWindow + a #GtkScrolledWindow - - the #GtkAdjustment to use, or %NULL to create a new one + + the #GtkAdjustment to use, or %NULL to create a new one - - Turns kinetic scrolling on or off. + + Turns kinetic scrolling on or off. Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN. @@ -131267,25 +93414,17 @@ Kinetic scrolling only applies to devices with source - a #GtkScrolledWindow + a #GtkScrolledWindow - %TRUE to enable kinetic scrolling + %TRUE to enable kinetic scrolling - - Sets the maximum height that @scrolled_window should keep visible. The + + Sets the maximum height that @scrolled_window should keep visible. The @scrolled_window will grow up to this height before it starts scrolling the content. @@ -131297,25 +93436,17 @@ smaller than #GtkScrolledWindow:min-content-height. - a #GtkScrolledWindow + a #GtkScrolledWindow - the maximum content height + the maximum content height - - Sets the maximum width that @scrolled_window should keep visible. The + + Sets the maximum width that @scrolled_window should keep visible. The @scrolled_window will grow up to this width before it starts scrolling the content. @@ -131327,25 +93458,17 @@ smaller than #GtkScrolledWindow:min-content-width. - a #GtkScrolledWindow + a #GtkScrolledWindow - the maximum content width + the maximum content width - - Sets the minimum height that @scrolled_window should keep visible. + + Sets the minimum height that @scrolled_window should keep visible. Note that this can and (usually will) be smaller than the minimum size of the content. @@ -131357,25 +93480,17 @@ value greater than #GtkScrolledWindow:max-content-height. - a #GtkScrolledWindow + a #GtkScrolledWindow - the minimal content height + the minimal content height - - Sets the minimum width that @scrolled_window should keep visible. + + Sets the minimum width that @scrolled_window should keep visible. Note that this can and (usually will) be smaller than the minimum size of the content. @@ -131387,49 +93502,34 @@ value greater than #GtkScrolledWindow:max-content-width. - a #GtkScrolledWindow + a #GtkScrolledWindow - the minimal content width + the minimal content width - - Enables or disables overlay scrolling for this scrolled window. + + Enables or disables overlay scrolling for this scrolled window. - a #GtkScrolledWindow + a #GtkScrolledWindow - whether to enable overlay scrolling + whether to enable overlay scrolling - - Sets the placement of the contents with respect to the scrollbars + + Sets the placement of the contents with respect to the scrollbars for the scrolled window. The default is %GTK_CORNER_TOP_LEFT, meaning the child is @@ -131445,112 +93545,81 @@ gtk_scrolled_window_unset_placement(). - a #GtkScrolledWindow + a #GtkScrolledWindow - position of the child window + position of the child window - Sets the scrollbar policy for the horizontal and vertical scrollbars. + Sets the scrollbar policy for the horizontal and vertical scrollbars. The policy determines when the scrollbar should appear; it is a value from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only if needed (that is, if the slider part of the bar would be smaller -than the trough — the display is larger than the page size). +than the trough — the display is larger than the page size). - a #GtkScrolledWindow + a #GtkScrolledWindow - policy for horizontal bar + policy for horizontal bar - policy for vertical bar + policy for vertical bar - - Sets whether the natural height of the child should be calculated and propagated -through the scrolled window’s requested natural height. + + Sets whether the natural height of the child should be calculated and propagated +through the scrolled window’s requested natural height. - a #GtkScrolledWindow + a #GtkScrolledWindow - whether to propagate natural height + whether to propagate natural height - - Sets whether the natural width of the child should be calculated and propagated -through the scrolled window’s requested natural width. + + Sets whether the natural width of the child should be calculated and propagated +through the scrolled window’s requested natural width. - a #GtkScrolledWindow + a #GtkScrolledWindow - whether to propagate natural width + whether to propagate natural width - - Changes the type of shadow drawn around the contents of + + Changes the type of shadow drawn around the contents of @scrolled_window. @@ -131558,52 +93627,34 @@ through the scrolled window’s requested natural width. - a #GtkScrolledWindow + a #GtkScrolledWindow - kind of shadow to draw around scrolled window contents + kind of shadow to draw around scrolled window contents - - Sets the #GtkAdjustment for the vertical scrollbar. + + Sets the #GtkAdjustment for the vertical scrollbar. - a #GtkScrolledWindow + a #GtkScrolledWindow - - the #GtkAdjustment to use, or %NULL to create a new one + + the #GtkAdjustment to use, or %NULL to create a new one - - Unsets the placement of the contents with respect to the scrollbars + + Unsets the placement of the contents with respect to the scrollbars for the scrolled window. If no window placement is set for a scrolled window, it defaults to %GTK_CORNER_TOP_LEFT. @@ -131615,77 +93666,40 @@ gtk_scrolled_window_get_placement(). - a #GtkScrolledWindow + a #GtkScrolledWindow - + - + - - Whether kinetic scrolling is enabled or not. Kinetic scrolling + + Whether kinetic scrolling is enabled or not. Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN. - - The maximum content height of @scrolled_window, or -1 if not set. + + The maximum content height of @scrolled_window, or -1 if not set. - - The maximum content width of @scrolled_window, or -1 if not set. + + The maximum content width of @scrolled_window, or -1 if not set. - - The minimum content height of @scrolled_window, or -1 if not set. + + The minimum content height of @scrolled_window, or -1 if not set. - - The minimum content width of @scrolled_window, or -1 if not set. + + The minimum content width of @scrolled_window, or -1 if not set. - - Whether overlay scrolling is enabled or not. If it is, the + + Whether overlay scrolling is enabled or not. If it is, the scrollbars are only added as traditional widgets when a mouse is present. Otherwise, they are overlayed on top of the content, as narrow indicators. @@ -131694,27 +93708,17 @@ Note that overlay scrolling can also be globally disabled, with the #GtkSettings::gtk-overlay-scrolling setting. - - Whether the natural height of the child should be calculated and propagated -through the scrolled window’s requested natural height. + + Whether the natural height of the child should be calculated and propagated +through the scrolled window’s requested natural height. This is useful in cases where an attempt should be made to allocate exactly enough space for the natural size of the child. - - Whether the natural width of the child should be calculated and propagated -through the scrolled window’s requested natural width. + + Whether the natural width of the child should be calculated and propagated +through the scrolled window’s requested natural width. This is useful in cases where an attempt should be made to allocate exactly enough space for the natural size of the child. @@ -131723,29 +93727,17 @@ enough space for the natural size of the child. - + - + - - Whether "window-placement" should be used to determine the location + + Whether "window-placement" should be used to determine the location of the contents with respect to the scrollbars. This value is ignored and #GtkScrolledWindow:window-placement value is always honored. @@ -131758,9 +93750,7 @@ of the contents with respect to the scrollbars. - The ::edge-overshot signal is emitted whenever user initiated scrolling + The ::edge-overshot signal is emitted whenever user initiated scrolling makes the scrolled window firmly surpass (i.e. with some edge resistance) the lower or upper limits defined by the adjustment in that orientation. @@ -131774,17 +93764,13 @@ if intending to provide behavior on horizontal edges. - edge side that was hit + edge side that was hit - The ::edge-reached signal is emitted whenever user-initiated scrolling + The ::edge-reached signal is emitted whenever user-initiated scrolling makes the scrolled window exactly reach the lower or upper limits defined by the adjustment in that orientation. @@ -131798,21 +93784,17 @@ if intending to provide behavior on horizontal edges. - edge side that was reached + edge side that was reached - The ::move-focus-out signal is a + The ::move-focus-out signal is a [keybinding signal][GtkBindingSignal] which gets emitted when focus is moved away from the scrolled window by a keybinding. The #GtkWidget::move-focus signal is emitted with -@direction_type on this scrolled window’s toplevel parent in the +@direction_type on this scrolled window’s toplevel parent in the container hierarchy. The default bindings for this signal are `Ctrl + Tab` to move forward and `Ctrl + Shift + Tab` to move backward. @@ -131820,84 +93802,57 @@ container hierarchy. The default bindings for this signal are - either %GTK_DIR_TAB_FORWARD or + either %GTK_DIR_TAB_FORWARD or %GTK_DIR_TAB_BACKWARD - The ::scroll-child signal is a + The ::scroll-child signal is a [keybinding signal][GtkBindingSignal] which gets emitted when a keybinding that scrolls is pressed. The horizontal or vertical adjustment is updated which triggers a -signal that the scrolled window’s child may listen to and scroll itself. +signal that the scrolled window’s child may listen to and scroll itself. - a #GtkScrollType describing how much to scroll + a #GtkScrollType describing how much to scroll - whether the keybinding scrolls the child + whether the keybinding scrolls the child horizontally or not - - + + - + - - + + - + - - + + - + - The parent class. + The parent class. @@ -131971,25 +93926,14 @@ signal that the scrolled window’s child may listen to and scroll itself. - + - - #GtkSearchBar is a container made to have a search entry (possibly + + #GtkSearchBar is a container made to have a search entry (possibly with additional connex widgets, such as drop-down menus, or buttons) built-in. The search bar would appear when a search is started through -typing on the keyboard, or the application’s search mode is toggled on. +typing on the keyboard, or the application’s search mode is toggled on. For keyboard presses to start a search, events will need to be forwarded from the top-level window that contains the search bar. @@ -132013,27 +93957,19 @@ GtkSearchBar has a single CSS node with name searchbar. - Creates a #GtkSearchBar. You will need to tell it about + Creates a #GtkSearchBar. You will need to tell it about which widget is going to be your text entry using gtk_search_bar_connect_entry(). - a new #GtkSearchBar + a new #GtkSearchBar - - Connects the #GtkEntry widget passed as the one to be used in + + Connects the #GtkEntry widget passed as the one to be used in this search bar. The entry should be a descendant of the search bar. -This is only required if the entry isn’t the direct child of the +This is only required if the entry isn’t the direct child of the search bar (as in our main example). @@ -132041,69 +93977,45 @@ search bar (as in our main example). - a #GtkSearchBar + a #GtkSearchBar - a #GtkEntry + a #GtkEntry - - Returns whether the search mode is on or off. + + Returns whether the search mode is on or off. - whether search mode is toggled on + whether search mode is toggled on - a #GtkSearchBar + a #GtkSearchBar - - Returns whether the close button is shown. + + Returns whether the close button is shown. - whether the close button is shown + whether the close button is shown - a #GtkSearchBar + a #GtkSearchBar - - This function should be called when the top-level + + This function should be called when the top-level window which contains the search bar received a key event. If the key event is handled by the search bar, the bar will @@ -132143,60 +94055,42 @@ create_toplevel (void) ]| - %GDK_EVENT_STOP if the key press event resulted + %GDK_EVENT_STOP if the key press event resulted in text being entered in the search entry (and revealing the search bar if necessary), %GDK_EVENT_PROPAGATE otherwise. - a #GtkSearchBar + a #GtkSearchBar - a #GdkEvent containing key press events + a #GdkEvent containing key press events - - Switches the search mode on or off. + + Switches the search mode on or off. - a #GtkSearchBar + a #GtkSearchBar - the new state of the search mode + the new state of the search mode - - Shows or hides the close button. Applications that -already have a “search” toggle button should not show a close + + Shows or hides the close button. Applications that +already have a “search” toggle button should not show a close button in their search bar, as it duplicates the role of the toggle button. @@ -132205,42 +94099,29 @@ toggle button. - a #GtkSearchBar + a #GtkSearchBar - whether the close button will be shown or not + whether the close button will be shown or not - + - + - + - The parent class. + The parent class. @@ -132276,22 +94157,13 @@ toggle button. - - #GtkSearchEntry is a subclass of #GtkEntry that has been + + #GtkSearchEntry is a subclass of #GtkEntry that has been tailored for use as a search entry. -It will show an inactive symbolic “find” icon when the search -entry is empty, and a symbolic “clear” icon when there is text. -Clicking on the “clear” icon will empty the search entry. +It will show an inactive symbolic “find” icon when the search +entry is empty, and a symbolic “clear” icon when there is text. +Clicking on the “clear” icon will empty the search entry. Note that the search/clear icon is shown using a secondary icon, and thus does not work if you are using the secondary @@ -132315,18 +94187,12 @@ you can use gtk_search_entry_handle_event() to pass events. - - Creates a #GtkSearchEntry, with a find icon when the search field is + + Creates a #GtkSearchEntry, with a find icon when the search field is empty, and a clear icon when it isn't. - a new #GtkSearchEntry + a new #GtkSearchEntry @@ -132374,12 +94240,8 @@ empty, and a clear icon when it isn't. - - This function should be called when the top-level window + + This function should be called when the top-level window which contains the search entry received a key event. If the entry is part of a #GtkSearchBar, it is preferable to call gtk_search_bar_handle_event() instead, which will @@ -132392,24 +94254,18 @@ The caller should ensure that the entry is shown in this case, and not propagate the event further. - %GDK_EVENT_STOP if the key press event resulted + %GDK_EVENT_STOP if the key press event resulted in a search beginning or continuing, %GDK_EVENT_PROPAGATE otherwise. - a #GtkSearchEntry + a #GtkSearchEntry - a key event + a key event @@ -132418,9 +94274,7 @@ case, and not propagate the event further. - The ::next-match signal is a [keybinding signal][GtkBindingSignal] + The ::next-match signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a move to the next match for the current search string. @@ -132433,9 +94287,7 @@ The default bindings for this signal is Ctrl-g. - The ::previous-match signal is a [keybinding signal][GtkBindingSignal] + The ::previous-match signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a move to the previous match for the current search string. @@ -132448,18 +94300,14 @@ The default bindings for this signal is Ctrl-Shift-g. - The #GtkSearchEntry::search-changed signal is emitted with a short + The #GtkSearchEntry::search-changed signal is emitted with a short delay of 150 milliseconds after the last change to the entry text. - The ::stop-search signal is a [keybinding signal][GtkBindingSignal] + The ::stop-search signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user stops a search via keyboard input. Applications should connect to it, to implement hiding the search @@ -132471,9 +94319,7 @@ The default bindings for this signal is Escape. - + @@ -132531,36 +94377,24 @@ The default bindings for this signal is Escape. - + - Makes a copy of a #GtkSelectionData-struct and its data. + Makes a copy of a #GtkSelectionData-struct and its data. - a pointer to a copy of @data. + a pointer to a copy of @data. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - Frees a #GtkSelectionData-struct returned from + Frees a #GtkSelectionData-struct returned from gtk_selection_data_copy(). @@ -132568,173 +94402,109 @@ gtk_selection_data_copy(). - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - Retrieves the raw data of the selection. + + Retrieves the raw data of the selection. - the raw data of the selection. + the raw data of the selection. - a pointer to a + a pointer to a #GtkSelectionData-struct. - - Retrieves the data type of the selection. + + Retrieves the data type of the selection. - the data type of the selection. + the data type of the selection. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - Retrieves the raw data of the selection along with its length. + + Retrieves the raw data of the selection along with its length. - the raw data of the selection + the raw data of the selection - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - return location for length of the data segment + + return location for length of the data segment - - Retrieves the display of the selection. + + Retrieves the display of the selection. - the display of the selection. + the display of the selection. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - Retrieves the format of the selection. + + Retrieves the format of the selection. - the format of the selection. + the format of the selection. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - Retrieves the length of the raw data of the selection. + + Retrieves the length of the raw data of the selection. - the length of the data of the selection. + the length of the data of the selection. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - Gets the contents of the selection data as a #GdkPixbuf. + + Gets the contents of the selection data as a #GdkPixbuf. - if the selection data + if the selection data contained a recognized image type and it could be converted to a #GdkPixbuf, a newly allocated pixbuf is returned, otherwise %NULL. If the result is non-%NULL it must be freed with @@ -132743,112 +94513,74 @@ gtk_selection_data_copy(). - a #GtkSelectionData + a #GtkSelectionData - - Retrieves the selection #GdkAtom of the selection data. + + Retrieves the selection #GdkAtom of the selection data. - the selection #GdkAtom of the selection data. + the selection #GdkAtom of the selection data. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - - Retrieves the target of the selection. + + Retrieves the target of the selection. - the target of the selection. + the target of the selection. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - Gets the contents of @selection_data as an array of targets. + Gets the contents of @selection_data as an array of targets. This can be used to interpret the results of getting the standard TARGETS target that is always supplied for any selection. - %TRUE if @selection_data contains a valid + %TRUE if @selection_data contains a valid array of targets, otherwise %FALSE. - a #GtkSelectionData object + a #GtkSelectionData object - - + + location to store an array of targets. The result stored here must be freed with g_free(). - - location to store number of items in @targets. + + location to store number of items in @targets. - Gets the contents of the selection data as a UTF-8 string. + Gets the contents of the selection data as a UTF-8 string. - if the selection data contained a + if the selection data contained a recognized text type and it could be converted to UTF-8, a newly allocated string containing the converted text, otherwise %NULL. If the result is non-%NULL it must be freed with g_free(). @@ -132856,24 +94588,16 @@ any selection. - a #GtkSelectionData + a #GtkSelectionData - - Gets the contents of the selection data as array of URIs. + + Gets the contents of the selection data as array of URIs. - if + if the selection data contains a list of URIs, a newly allocated %NULL-terminated string array containing the URIs, otherwise %NULL. If the result is @@ -132884,17 +94608,13 @@ any selection. - a #GtkSelectionData + a #GtkSelectionData - Stores new data into a #GtkSelectionData object. Should + Stores new data into a #GtkSelectionData object. Should only be called from a selection handler callback. Zero-terminates the stored data. @@ -132903,132 +94623,92 @@ Zero-terminates the stored data. - a pointer to a #GtkSelectionData-struct. + a pointer to a #GtkSelectionData-struct. - the type of selection data + the type of selection data - format (number of bits in a unit) + format (number of bits in a unit) - pointer to the data (will be copied) + pointer to the data (will be copied) - length of the data + length of the data - - Sets the contents of the selection from a #GdkPixbuf + + Sets the contents of the selection from a #GdkPixbuf The pixbuf is converted to the form determined by @selection_data->target. - %TRUE if the selection was successfully set, + %TRUE if the selection was successfully set, otherwise %FALSE. - a #GtkSelectionData + a #GtkSelectionData - a #GdkPixbuf + a #GdkPixbuf - Sets the contents of the selection from a UTF-8 encoded string. + Sets the contents of the selection from a UTF-8 encoded string. The string is converted to the form determined by @selection_data->target. - %TRUE if the selection was successfully set, + %TRUE if the selection was successfully set, otherwise %FALSE. - a #GtkSelectionData + a #GtkSelectionData - a UTF-8 string + a UTF-8 string - the length of @str, or -1 if @str is nul-terminated. + the length of @str, or -1 if @str is nul-terminated. - - Sets the contents of the selection from a list of URIs. + + Sets the contents of the selection from a list of URIs. The string is converted to the form determined by @selection_data->target. - %TRUE if the selection was successfully set, + %TRUE if the selection was successfully set, otherwise %FALSE. - a #GtkSelectionData + a #GtkSelectionData - a %NULL-terminated array of + a %NULL-terminated array of strings holding URIs @@ -133036,212 +94716,124 @@ The string is converted to the form determined by - - Given a #GtkSelectionData object holding a list of targets, + + Given a #GtkSelectionData object holding a list of targets, determines if any of the targets in @targets can be used to provide a #GdkPixbuf. - %TRUE if @selection_data holds a list of targets, + %TRUE if @selection_data holds a list of targets, and a suitable target for images is included, otherwise %FALSE. - a #GtkSelectionData object + a #GtkSelectionData object - whether to accept only targets for which GTK+ knows + whether to accept only targets for which GTK+ knows how to convert a pixbuf into the format - - Given a #GtkSelectionData object holding a list of targets, + + Given a #GtkSelectionData object holding a list of targets, determines if any of the targets in @targets can be used to provide rich text. - %TRUE if @selection_data holds a list of targets, + %TRUE if @selection_data holds a list of targets, and a suitable target for rich text is included, otherwise %FALSE. - a #GtkSelectionData object + a #GtkSelectionData object - a #GtkTextBuffer + a #GtkTextBuffer - - Given a #GtkSelectionData object holding a list of targets, + + Given a #GtkSelectionData object holding a list of targets, determines if any of the targets in @targets can be used to provide text. - %TRUE if @selection_data holds a list of targets, + %TRUE if @selection_data holds a list of targets, and a suitable target for text is included, otherwise %FALSE. - a #GtkSelectionData object + a #GtkSelectionData object - - Given a #GtkSelectionData object holding a list of targets, + + Given a #GtkSelectionData object holding a list of targets, determines if any of the targets in @targets can be used to provide a list or URIs. - %TRUE if @selection_data holds a list of targets, + %TRUE if @selection_data holds a list of targets, and a suitable target for URI lists is included, otherwise %FALSE. - a #GtkSelectionData object + a #GtkSelectionData object - - Used to control what selections users are allowed to make. - - No selection is possible. + + Used to control what selections users are allowed to make. + + No selection is possible. - - Zero or one element may be selected. + + Zero or one element may be selected. - - Exactly one element is selected. + + Exactly one element is selected. In some circumstances, such as initially or during a search - operation, it’s possible for no element to be selected with + operation, it’s possible for no element to be selected with %GTK_SELECTION_BROWSE. What is really enforced is that the user - can’t deselect a currently selected element except by selecting + can’t deselect a currently selected element except by selecting another element. - - Any number of elements may be selected. + + Any number of elements may be selected. The Ctrl key may be used to enlarge the selection, and Shift key to select between the focus and the child pointed to. Some widgets may also allow Click-drag to select a range of elements. - - Determines how GTK+ handles the sensitivity of stepper arrows + + Determines how GTK+ handles the sensitivity of stepper arrows at the end of range widgets. - - The arrow is made insensitive if the + + The arrow is made insensitive if the thumb is at the end - - The arrow is always sensitive + + The arrow is always sensitive - - The arrow is always insensitive + + The arrow is always insensitive - - GtkSeparator is a horizontal or vertical separator widget, depending on the + + GtkSeparator is a horizontal or vertical separator widget, depending on the value of the #GtkOrientable:orientation property, used to group the widgets within a window. It displays a line with a shadow to make it appear sunken into the interface. @@ -133255,21 +94847,15 @@ gets one of the .horizontal or .vertical style classes. - Creates a new #GtkSeparator with the given orientation. + Creates a new #GtkSeparator with the given orientation. - a new #GtkSeparator. + a new #GtkSeparator. - the separator’s orientation. + the separator’s orientation. @@ -133281,9 +94867,7 @@ gets one of the .horizontal or .vertical style classes. - + @@ -133321,16 +94905,8 @@ gets one of the .horizontal or .vertical style classes. - - The #GtkSeparatorMenuItem is a separator used to group + + The #GtkSeparatorMenuItem is a separator used to group items within a menu. It displays a horizontal line with a shadow to make it appear sunken into the interface. @@ -133343,14 +94919,10 @@ GtkSeparatorMenuItem has a single CSS node with name separator. - Creates a new #GtkSeparatorMenuItem. + Creates a new #GtkSeparatorMenuItem. - a new #GtkSeparatorMenuItem. + a new #GtkSeparatorMenuItem. @@ -133358,14 +94930,10 @@ GtkSeparatorMenuItem has a single CSS node with name separator. - + - The parent class. + The parent class. @@ -133404,22 +94972,14 @@ GtkSeparatorMenuItem has a single CSS node with name separator. - - A #GtkSeparatorToolItem is a #GtkToolItem that separates groups of other + + A #GtkSeparatorToolItem is a #GtkToolItem that separates groups of other #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will often look like a vertical line on horizontally docked toolbars. -If the #GtkToolbar child property “expand” is %TRUE and the property +If the #GtkToolbar child property “expand” is %TRUE and the property #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as -a “spring” that forces other items to the ends of the toolbar. +a “spring” that forces other items to the ends of the toolbar. Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem. @@ -133430,49 +94990,31 @@ GtkSeparatorToolItem has a single CSS node with name separator. - - Create a new #GtkSeparatorToolItem + + Create a new #GtkSeparatorToolItem - the new #GtkSeparatorToolItem + the new #GtkSeparatorToolItem - - Returns whether @item is drawn as a line, or just blank. + + Returns whether @item is drawn as a line, or just blank. See gtk_separator_tool_item_set_draw(). - %TRUE if @item is drawn as a line, or just blank. + %TRUE if @item is drawn as a line, or just blank. - a #GtkSeparatorToolItem + a #GtkSeparatorToolItem - - Whether @item is drawn as a vertical line, or just blank. + + Whether @item is drawn as a vertical line, or just blank. Setting this to %FALSE along with gtk_tool_item_set_expand() is useful to create an item that forces following items to the end of the toolbar. @@ -133481,15 +95023,11 @@ to create an item that forces following items to the end of the toolbar. - a #GtkSeparatorToolItem + a #GtkSeparatorToolItem - whether @item is drawn as a vertical line + whether @item is drawn as a vertical line @@ -133501,18 +95039,13 @@ to create an item that forces following items to the end of the toolbar. - + - + - The parent class. + The parent class. @@ -133548,21 +95081,11 @@ to create an item that forces following items to the end of the toolbar. - + - - GtkSettings provide a mechanism to share global settings between + + GtkSettings provide a mechanism to share global settings between applications. On the X window system, this sharing is realized by an @@ -133601,45 +95124,30 @@ GtkSettings instance for the default screen. - Gets the #GtkSettings object for the default GDK screen, creating + Gets the #GtkSettings object for the default GDK screen, creating it if necessary. See gtk_settings_get_for_screen(). - a #GtkSettings object. If there is + a #GtkSettings object. If there is no default screen, then returns %NULL. - - Gets the #GtkSettings object for @screen, creating it if necessary. + + Gets the #GtkSettings object for @screen, creating it if necessary. - a #GtkSettings object. + a #GtkSettings object. - a #GdkScreen. + a #GdkScreen. - + This function is not useful outside GTK+. @@ -133651,10 +95159,7 @@ no default screen, then returns %NULL. - + This function is not useful outside GTK+. @@ -133669,12 +95174,8 @@ no default screen, then returns %NULL. - - Undoes the effect of calling g_object_set() to install an + + Undoes the effect of calling g_object_set() to install an application-specific value for a setting. After this call, the setting will again follow the session-wide value for this setting. @@ -133684,23 +95185,16 @@ this setting. - a #GtkSettings object + a #GtkSettings object - the name of the setting to reset + the name of the setting to reset - + Use g_object_set() instead. @@ -133721,10 +95215,7 @@ this setting. - + Use g_object_set() instead. @@ -133745,10 +95236,7 @@ this setting. - + Use g_object_set() instead. @@ -133766,10 +95254,7 @@ this setting. - + Use g_object_set() instead. @@ -133790,14 +95275,8 @@ this setting. - - Holds a hash table representation of the #GtkSettings:gtk-color-scheme + + Holds a hash table representation of the #GtkSettings:gtk-color-scheme setting, mapping color names to #GdkColors. Will always return an empty hash table. @@ -133805,29 +95284,17 @@ setting, mapping color names to #GdkColors. - + - - Controls the direction of the sort indicators in sorted list and tree + + Controls the direction of the sort indicators in sorted list and tree views. By default an arrow pointing down means the column is sorted in ascending order. When set to %TRUE, this order will be inverted. - - Whether the application prefers to use a dark theme. If a GTK+ theme + + Whether the application prefers to use a dark theme. If a GTK+ theme includes a dark variant, it will be used instead of the configured theme. @@ -133840,28 +95307,14 @@ Dark themes should not be used for documents, where large spaces are white/light and the dark chrome creates too much contrast (web browser, text editor...). - - Whether mnemonics should be automatically shown and hidden when the user + + Whether mnemonics should be automatically shown and hidden when the user presses the mnemonic activator. This setting is ignored - - Whether images should be shown on buttons + + Whether images should be shown on buttons This setting is deprecated. Application developers control whether a button should show an icon or not, on a per-button basis. If a #GtkButton should show an icon, use the @@ -133869,37 +95322,18 @@ presses the mnemonic activator. #GtkImage inside the #GtkButton - - Whether menu accelerators can be changed by pressing a key over the menu item. + + Whether menu accelerators can be changed by pressing a key over the menu item. This setting is ignored. - - Palette to use in the deprecated color selector. + + Palette to use in the deprecated color selector. Only used by the deprecated color selector widget. - - A palette of named colors for use in themes. The format of the string is + + A palette of named colors for use in themes. The format of the string is |[ name1: color1 name2: color2 @@ -133923,55 +95357,35 @@ name1: color1; name2: color2; ... You can still set this property, but it will be ignored. - + - Whether the cursor should blink. + Whether the cursor should blink. Also see the #GtkSettings:gtk-cursor-blink-timeout setting, which allows more flexible control over cursor blinking. - + - - Time after which the cursor stops blinking, in seconds. + + Time after which the cursor stops blinking, in seconds. The timer is reset after each user interaction. Setting this to zero has the same effect as setting #GtkSettings:gtk-cursor-blink to %FALSE. - + - + - - This setting determines which buttons should be put in the + + This setting determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed at the left of right. @@ -133993,13 +95407,8 @@ Also note that the setting can be overridden with the #GtkHeaderBar:decoration-layout property. - - Whether builtin GTK+ dialogs such as the file chooser, the + + Whether builtin GTK+ dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom. @@ -134007,43 +95416,25 @@ This setting does not affect custom dialogs using GtkDialog directly, or message dialogs. - + - + - + - - Whether menu items should have visible accelerators which can be + + Whether menu items should have visible accelerators which can be activated. - + - - Whether to play any event sounds at all. + + Whether to play any event sounds at all. See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec) for more information on event sounds and sound themes. @@ -134052,13 +95443,8 @@ GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra. - - Whether to play event sounds as feedback to user input. + + Whether to play event sounds as feedback to user input. See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec) for more information on event sounds and sound themes. @@ -134067,112 +95453,59 @@ GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra. - - Whether labels and menu items should have visible mnemonics which + + Whether labels and menu items should have visible mnemonics which can be activated. This setting can still be used for application overrides, but will be ignored in the future - - Whether a middle click on a mouse should paste the + + Whether a middle click on a mouse should paste the 'PRIMARY' clipboard content at the cursor location. - - Whether tooltips should be shown on widgets. + + Whether tooltips should be shown on widgets. This setting is ignored. - - How long to show the last input character in hidden + + How long to show the last input character in hidden entries. This value is in milliseconds. 0 disables showing the last char. 600 is a good value for enabling it. - + - - When %TRUE, keyboard navigation and other input-related errors + + When %TRUE, keyboard navigation and other input-related errors will cause a beep. Since the error bell is implemented using gdk_window_beep(), the windowing system may offer ways to configure the error bell in many ways, such as flashing the window or similar visual effects. - - Name of a icon theme to fall back to. + + Name of a icon theme to fall back to. This setting is ignored. - - Name of the GtkFileChooser backend to use by default. + + Name of the GtkFileChooser backend to use by default. This setting is ignored. #GtkFileChooser uses GIO by default. - The default font to use. GTK+ uses the family name and size from this string. + The default font to use. GTK+ uses the family name and size from this string. - + - - A list of icon sizes. The list is separated by colons, and + + A list of icon sizes. The list is separated by colons, and item has the form: `size-name` = `width` , `height` @@ -134185,15 +95518,11 @@ sizes with gtk_icon_size_register(). This setting is ignored. - + - Which IM (input method) module should be used by default. This is the + Which IM (input method) module should be used by default. This is the input method that will be used if the user has not explicitly chosen another input method from the IM context menu. This also can be a colon-separated list of input methods, which GTK+ @@ -134202,117 +95531,59 @@ will try in turn until it finds one available on the system. See #GtkIMContext. - - How to draw the input method preedit string. + + How to draw the input method preedit string. This setting is ignored. - - How to draw the input method statusbar. + + How to draw the input method statusbar. This setting is ignored. - + - - When %TRUE, keyboard navigation should be able to reach all widgets + + When %TRUE, keyboard navigation should be able to reach all widgets by using the cursor keys only. Tab, Shift etc. keys can't be expected to be present on the used input device. Generally, the behavior for touchscreen input should be performed dynamically based on gdk_event_get_source_device(). - - Whether GTK+ should make sure that text can be navigated with + + Whether GTK+ should make sure that text can be navigated with a caret, even if it is not editable. This is useful when using a screen reader. - - When %TRUE, some widgets will wrap around when doing keyboard + + When %TRUE, some widgets will wrap around when doing keyboard navigation, such as menus, menubars and notebooks. This setting is ignored. - + - - The time for a button or touch press to be considered a "long press". + + The time for a button or touch press to be considered a "long press". - - Keybinding to activate the menu bar. + + Keybinding to activate the menu bar. This setting can still be used for application overrides, but will be ignored in the future - - Delay before the submenus of a menu bar appear. + + Delay before the submenus of a menu bar appear. This setting is ignored. - - Whether images should be shown in menu items + + Whether images should be shown in menu items This setting is deprecated. Application developers control whether or not a #GtkMenuItem should have an icon or not, on a per widget basis. Either use a #GtkMenuItem with a #GtkBox @@ -134320,76 +95591,44 @@ navigation, such as menus, menubars and notebooks. using a #GMenu XML description - - The time before hiding a submenu when the pointer is moving towards the submenu. + + The time before hiding a submenu when the pointer is moving towards the submenu. This setting is ignored. - - Minimum time the pointer must stay over a menu item before the submenu appear. + + Minimum time the pointer must stay over a menu item before the submenu appear. This setting is ignored. - - Whether scrolled windows may use overlayed scrolling indicators. + + Whether scrolled windows may use overlayed scrolling indicators. If this is set to %FALSE, scrolled windows will have permanent scrollbars. - - If the value of this setting is %TRUE, clicking the primary button in a -#GtkRange trough will move the slider, and hence set the range’s value, to + + If the value of this setting is %TRUE, clicking the primary button in a +#GtkRange trough will move the slider, and hence set the range’s value, to the point that you clicked. If it is %FALSE, a primary click will cause the -slider/value to move by the range’s page-size towards the point clicked. +slider/value to move by the range’s page-size towards the point clicked. Whichever action you choose for the primary button, the other action will be available by holding Shift and primary-clicking, or (since GTK+ 3.22.25) clicking the middle mouse button. - - A comma-separated list of print backends to use in the print + + A comma-separated list of print backends to use in the print dialog. Available print backends depend on the GTK+ installation, and may include "file", "cups", "lpr" or "papi". - - A command to run for displaying the print preview. The command + + A command to run for displaying the print preview. The command should contain a `%f` placeholder, which will get replaced by the path to the pdf file. The command may also contain a `%s` placeholder, which will get replaced by the path to a file @@ -134400,93 +95639,50 @@ The preview application is responsible for removing the pdf file and the print settings file when it is done. - - Whether GTK+ should keep track of items inside the recently used + + Whether GTK+ should keep track of items inside the recently used resources list. If set to %FALSE, the list will always be empty. - - The number of recently used files that should be displayed by default by + + The number of recently used files that should be displayed by default by #GtkRecentChooser implementations and by the #GtkFileChooser. A value of -1 means every recently used file stored. This setting is ignored - - The maximum age, in days, of the items inside the recently used + + The maximum age, in days, of the items inside the recently used resources list. Items older than this setting will be excised from the list. If set to 0, the list will always be empty; if set to -1, no item will be removed. - - Where the contents of scrolled windows are located with respect to the + + Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement. This setting is ignored. - + - + - + - + This setting is ignored. - + This setting is ignored. - - The XDG sound theme to use for event sounds. + + The XDG sound theme to use for event sounds. See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec) for more information on event sounds and sound themes. @@ -134501,100 +95697,54 @@ module like the one that comes with libcanberra. - + This setting is ignored. - + This setting is ignored. - + This setting is ignored. - - This setting determines the action to take when a double-click + + This setting determines the action to take when a double-click occurs on the titlebar of client-side decorated windows. Recognized actions are minimize, toggle-maximize, menu, lower or none. - - This setting determines the action to take when a middle-click + + This setting determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows. Recognized actions are minimize, toggle-maximize, menu, lower or none. - - This setting determines the action to take when a right-click + + This setting determines the action to take when a right-click occurs on the titlebar of client-side decorated windows. Recognized actions are minimize, toggle-maximize, menu, lower or none. - - The size of icons in default toolbars. + + The size of icons in default toolbars. This setting is ignored. - - The size of icons in default toolbars. + + The size of icons in default toolbars. This setting is ignored. - - Amount of time, in milliseconds, after which the browse mode + + Amount of time, in milliseconds, after which the browse mode will be disabled. See #GtkSettings:gtk-tooltip-browse-timeout for more information @@ -134602,15 +95752,8 @@ about browse mode. This setting is ignored. - - Controls the time after which tooltips will appear when + + Controls the time after which tooltips will appear when browse mode is enabled, in milliseconds. Browse mode is enabled when the mouse pointer moves off an object @@ -134622,50 +95765,27 @@ for the new object. This setting is ignored. - - Time, in milliseconds, after which a tooltip could appear if the + + Time, in milliseconds, after which a tooltip could appear if the cursor is hovering on top of a widget. This setting is ignored. - - When %TRUE, there are no motion notify events delivered on this screen, + + When %TRUE, there are no motion notify events delivered on this screen, and widgets can't use the pointer hovering them for any essential functionality. Generally, the behavior for touchscreen input should be performed dynamically based on gdk_event_get_source_device(). - - Whether 'focus rectangles' should be always visible, never visible, + + Whether 'focus rectangles' should be always visible, never visible, or hidden until the user starts to use the keyboard. This setting is ignored - + @@ -134674,9 +95794,7 @@ or hidden until the user starts to use the keyboard. - + @@ -134689,9 +95807,7 @@ or hidden until the user starts to use the keyboard. - + @@ -134735,313 +95851,167 @@ or hidden until the user starts to use the keyboard. - Origin should be something like “filename:linenumber” for - rc files, or e.g. “XProperty” for other sources. + Origin should be something like “filename:linenumber” for + rc files, or e.g. “XProperty” for other sources. - Valid types are LONG, DOUBLE and STRING corresponding to + Valid types are LONG, DOUBLE and STRING corresponding to the token parsed, or a GSTRING holding an unparsed statement - - Used to change the appearance of an outline typically provided by a #GtkFrame. + + Used to change the appearance of an outline typically provided by a #GtkFrame. Note that many themes do not differentiate the appearance of the various shadow types: Either their is no visible shadow (@GTK_SHADOW_NONE), or there is (any other value). - - No outline. + + No outline. - The outline is bevelled inwards. + The outline is bevelled inwards. - - The outline is bevelled outwards like a button. + + The outline is bevelled outwards like a button. - - The outline has a sunken 3d appearance. + + The outline has a sunken 3d appearance. - - The outline has a raised 3d appearance. + + The outline has a raised 3d appearance. - - #GtkShortcutLabel is a widget that represents a single keyboard shortcut or gesture + + #GtkShortcutLabel is a widget that represents a single keyboard shortcut or gesture in the user interface. - - Creates a new #GtkShortcutLabel with @accelerator set. + + Creates a new #GtkShortcutLabel with @accelerator set. - - a newly-allocated #GtkShortcutLabel + + a newly-allocated #GtkShortcutLabel - the initial accelerator + the initial accelerator - - Retrieves the current accelerator of @self. + + Retrieves the current accelerator of @self. - the current accelerator. + the current accelerator. - a #GtkShortcutLabel + a #GtkShortcutLabel - - Retrieves the text that is displayed when no accelerator is set. + + Retrieves the text that is displayed when no accelerator is set. - the current text displayed when no + the current text displayed when no accelerator is set. - a #GtkShortcutLabel + a #GtkShortcutLabel - - Sets the accelerator to be displayed by @self. + + Sets the accelerator to be displayed by @self. - a #GtkShortcutLabel + a #GtkShortcutLabel - the new accelerator + the new accelerator - - Sets the text to be displayed by @self when no accelerator is set. + + Sets the text to be displayed by @self when no accelerator is set. - a #GtkShortcutLabel + a #GtkShortcutLabel - the text to be displayed when no accelerator is set + the text to be displayed when no accelerator is set - - The accelerator that @self displays. See #GtkShortcutsShortcut:accelerator + + The accelerator that @self displays. See #GtkShortcutsShortcut:accelerator for the accepted syntax. - - The text that is displayed when no accelerator is set. + + The text that is displayed when no accelerator is set. - + - - GtkShortcutType specifies the kind of shortcut that is being described. + + GtkShortcutType specifies the kind of shortcut that is being described. More values may be added to this enumeration over time. - - The shortcut is a keyboard accelerator. The #GtkShortcutsShortcut:accelerator + + The shortcut is a keyboard accelerator. The #GtkShortcutsShortcut:accelerator property will be used. - - The shortcut is a pinch gesture. GTK+ provides an icon and subtitle. + + The shortcut is a pinch gesture. GTK+ provides an icon and subtitle. - - The shortcut is a stretch gesture. GTK+ provides an icon and subtitle. + + The shortcut is a stretch gesture. GTK+ provides an icon and subtitle. - - The shortcut is a clockwise rotation gesture. GTK+ provides an icon and subtitle. + + The shortcut is a clockwise rotation gesture. GTK+ provides an icon and subtitle. - - The shortcut is a counterclockwise rotation gesture. GTK+ provides an icon and subtitle. + + The shortcut is a counterclockwise rotation gesture. GTK+ provides an icon and subtitle. - - The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle. + + The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle. - - The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle. + + The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle. - - The shortcut is a gesture. The #GtkShortcutsShortcut:icon property will be + + The shortcut is a gesture. The #GtkShortcutsShortcut:icon property will be used. - - A GtkShortcutsGroup represents a group of related keyboard shortcuts + + A GtkShortcutsGroup represents a group of related keyboard shortcuts or gestures. The group has a title. It may optionally be associated with a view of the application, which can be used to show only relevant shortcuts depending on the application context. @@ -135051,46 +96021,30 @@ This widget is only meant to be used with #GtkShortcutsWindow. - - The size group for the accelerator portion of shortcuts in this group. + + The size group for the accelerator portion of shortcuts in this group. This is used internally by GTK+, and must not be modified by applications. - A rough measure for the number of lines in this group. + A rough measure for the number of lines in this group. This is used internally by GTK+, and is not useful for applications. - The title for this group of shortcuts. + The title for this group of shortcuts. - - The size group for the textual portion of shortcuts in this group. + + The size group for the textual portion of shortcuts in this group. This is used internally by GTK+, and must not be modified by applications. - An optional view that the shortcuts in this group are relevant for. + An optional view that the shortcuts in this group are relevant for. The group will be hidden if the #GtkShortcutsWindow:view-name property does not match the view of this group. @@ -135098,22 +96052,11 @@ Set this to %NULL to make the group always visible. - + - - A GtkShortcutsSection collects all the keyboard shortcuts and gestures + + A GtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode. If your application needs multiple sections, you should give each section a unique #GtkShortcutsSection:section-name and a #GtkShortcutsSection:title that can be shown in the section selector of @@ -135128,35 +96071,27 @@ This widget is only meant to be used with #GtkShortcutsWindow. - The maximum number of lines to allow per column. This property can + The maximum number of lines to allow per column. This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases. - A unique name to identify this section among the sections + A unique name to identify this section among the sections added to the GtkShortcutsWindow. Setting the #GtkShortcutsWindow:section-name property to this string will make this section shown in the GtkShortcutsWindow. - The string to show in the section selector of the GtkShortcutsWindow + The string to show in the section selector of the GtkShortcutsWindow for this section. If there is only one section, you don't need to set a title, since the section selector will not be shown in this case. - A view name to filter the groups in this section by. + A view name to filter the groups in this section by. See #GtkShortcutsGroup:view. Applications are expected to use the #GtkShortcutsWindow:view-name @@ -135174,42 +96109,24 @@ property for this purpose. - + - - A GtkShortcutsShortcut represents a single keyboard shortcut or gesture + + A GtkShortcutsShortcut represents a single keyboard shortcut or gesture with a short text. This widget is only meant to be used with #GtkShortcutsWindow. - - The size group for the accelerator portion of this shortcut. + + The size group for the accelerator portion of this shortcut. This is used internally by GTK+, and must not be modified by applications. - The accelerator(s) represented by this object. This property is used + The accelerator(s) represented by this object. This property is used if #GtkShortcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_ACCELERATOR. The syntax of this property is (an extension of) the syntax understood by @@ -135232,13 +96149,8 @@ Note that <, > and & need to be escaped as &lt;, &gt; and & in .ui files. - - A detailed action name. If this is set for a shortcut + + A detailed action name. If this is set for a shortcut of type %GTK_SHORTCUT_ACCELERATOR, then GTK+ will use the accelerators that are associated with the action via gtk_application_set_accels_for_action(), and setting @@ -135246,37 +96158,27 @@ via gtk_application_set_accels_for_action(), and setting - The text direction for which this shortcut is active. If the shortcut + The text direction for which this shortcut is active. If the shortcut is used regardless of the text direction, set this property to #GTK_TEXT_DIR_NONE. - An icon to represent the shortcut or gesture. This property is used if + An icon to represent the shortcut or gesture. This property is used if #GtkShortcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_GESTURE. For the other predefined gesture types, GTK+ provides an icon on its own. - %TRUE if an icon has been set. + %TRUE if an icon has been set. - The type of shortcut that is represented. + The type of shortcut that is represented. - The subtitle for the shortcut or gesture. + The subtitle for the shortcut or gesture. This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture @@ -135284,46 +96186,26 @@ types, GTK+ provides a subtitle on its own. - %TRUE if a subtitle has been set. + %TRUE if a subtitle has been set. - The textual description for the shortcut or gesture represented by + The textual description for the shortcut or gesture represented by this object. This should be a short string that can fit in a single line. - - The size group for the textual portion of this shortcut. + + The size group for the textual portion of this shortcut. This is used internally by GTK+, and must not be modified by applications. - + - - A GtkShortcutsWindow shows brief information about the keyboard shortcuts + + A GtkShortcutsWindow shows brief information about the keyboard shortcuts and gestures of an application. The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application. @@ -135389,18 +96271,14 @@ The .ui file for this example can be found [here](https://git.gnome.org/browse/g - The name of the section to show. + The name of the section to show. This should be the section-name of one of the #GtkShortcutsSection objects that are in this shortcuts window. - The view name by which to filter the contents. + The view name by which to filter the contents. This should correspond to the #GtkShortcutsGroup:view property of some of the #GtkShortcutsGroup objects that are inside this shortcuts window. @@ -135412,9 +96290,7 @@ Set this to %NULL to show all groups. - The ::close signal is a + The ::close signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to close the window. @@ -135425,9 +96301,7 @@ The default binding for this signal is the Escape key. - The ::search signal is a + The ::search signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to start a search. @@ -135437,9 +96311,7 @@ The default binding for this signal is Control-F. - + @@ -135471,19 +96343,11 @@ The default binding for this signal is Control-F. - - #GtkSizeGroup provides a mechanism for grouping a number of widgets + + #GtkSizeGroup provides a mechanism for grouping a number of widgets together so they all request the same amount of space. This is typically useful when you want a column of widgets to have the same -size, but you can’t use a #GtkGrid widget. +size, but you can’t use a #GtkGrid widget. In detail, the size requested for each widget in a #GtkSizeGroup is the maximum of the sizes that would have been requested for each @@ -135533,7 +96397,7 @@ Size groups can be specified in a UI definition by placing an <object> element with `class="GtkSizeGroup"` somewhere in the UI definition. The widgets that belong to the size group are specified by a <widgets> element that may contain multiple <widget> elements, one for each member of the -size group. The ”name” attribute gives the id of the widget. +size group. The ”name” attribute gives the id of the widget. An example of a UI definition fragment with GtkSizeGroup: |[ @@ -135548,29 +96412,21 @@ An example of a UI definition fragment with GtkSizeGroup: - Create a new #GtkSizeGroup. + Create a new #GtkSizeGroup. - a newly created #GtkSizeGroup + a newly created #GtkSizeGroup - the mode for the new size group. + the mode for the new size group. - Adds a widget to a #GtkSizeGroup. In the future, the requisition + Adds a widget to a #GtkSizeGroup. In the future, the requisition of the widget will be determined as the maximum of its requisition and the requisition of the other widgets in the size group. Whether this applies horizontally, vertically, or in both directions @@ -135584,27 +96440,17 @@ be removed from the size group. - a #GtkSizeGroup + a #GtkSizeGroup - the #GtkWidget to add + the #GtkWidget to add - - Returns if invisible widgets are ignored when calculating the size. + + Returns if invisible widgets are ignored when calculating the size. Measuring the size of hidden widgets has not worked reliably for a long time. In most cases, they will report a size of 0 nowadays, and thus, their size will not affect the other @@ -135613,51 +96459,35 @@ be removed from the size group. widgets while still having their size taken into account. - %TRUE if invisible widgets are ignored. + %TRUE if invisible widgets are ignored. - a #GtkSizeGroup + a #GtkSizeGroup - Gets the current mode of the size group. See gtk_size_group_set_mode(). + Gets the current mode of the size group. See gtk_size_group_set_mode(). - the current mode of the size group. + the current mode of the size group. - a #GtkSizeGroup + a #GtkSizeGroup - - Returns the list of widgets associated with @size_group. + + Returns the list of widgets associated with @size_group. - a #GSList of + a #GSList of widgets. The list is owned by GTK+ and should not be modified. @@ -135665,44 +96495,30 @@ be removed from the size group. - a #GtkSizeGroup + a #GtkSizeGroup - Removes a widget from a #GtkSizeGroup. + Removes a widget from a #GtkSizeGroup. - a #GtkSizeGroup + a #GtkSizeGroup - the #GtkWidget to remove + the #GtkWidget to remove - - Sets whether unmapped widgets should be ignored when + + Sets whether unmapped widgets should be ignored when calculating the size. Measuring the size of hidden widgets has not worked reliably for a long time. In most cases, they will report a size @@ -135716,24 +96532,18 @@ calculating the size. - a #GtkSizeGroup + a #GtkSizeGroup - whether unmapped widgets should be ignored + whether unmapped widgets should be ignored when calculating the size - Sets the #GtkSizeGroupMode of the size group. The mode of the size + Sets the #GtkSizeGroupMode of the size group. The mode of the size group determines whether the widgets in the size group should all have the same horizontal requisition (%GTK_SIZE_GROUP_HORIZONTAL) all have the same vertical requisition (%GTK_SIZE_GROUP_VERTICAL), @@ -135745,28 +96555,17 @@ or should all have the same requisition in both directions - a #GtkSizeGroup + a #GtkSizeGroup - the mode to set for the size group. + the mode to set for the size group. - - If %TRUE, unmapped widgets are ignored when determining + + If %TRUE, unmapped widgets are ignored when determining the size of the group. Measuring the size of hidden widgets has not worked reliably for a long time. In most cases, they will report a size @@ -135786,9 +96585,7 @@ the size of the group. - + @@ -135826,100 +96623,47 @@ the size of the group. - - The mode of the size group determines the directions in which the size + + The mode of the size group determines the directions in which the size group affects the requested sizes of its component widgets. - - group has no effect + + group has no effect - - group affects horizontal requisition + + group affects horizontal requisition - - group affects vertical requisition + + group affects vertical requisition - - group affects both horizontal and vertical requisition + + group affects both horizontal and vertical requisition - - Specifies a preference for height-for-width or + + Specifies a preference for height-for-width or width-for-height geometry management. - - Prefer height-for-width geometry management + + Prefer height-for-width geometry management - - Prefer width-for-height geometry management + + Prefer width-for-height geometry management - - Don’t trade height-for-width or width-for-height + + Don’t trade height-for-width or width-for-height - - Together with #GtkPlug, #GtkSocket provides the ability to embed + + Together with #GtkPlug, #GtkSocket provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a #GtkSocket widget -and passes that widget’s window ID to the other process, which then +and passes that widget’s window ID to the other process, which then creates a #GtkPlug with that window ID. Any widgets contained in the -#GtkPlug then will appear inside the first application’s window. +#GtkPlug then will appear inside the first application’s window. -The socket’s window ID is obtained by using gtk_socket_get_id(). +The socket’s window ID is obtained by using gtk_socket_get_id(). Before using this function, the socket must have been realized, and for hence, have been added to its parent. @@ -135967,14 +96711,10 @@ They can only be used on a #GdkX11Display. To use #GtkPlug and - Create a new empty #GtkSocket. + Create a new empty #GtkSocket. - the new #GtkSocket. + the new #GtkSocket. @@ -136001,9 +96741,7 @@ They can only be used on a #GdkX11Display. To use #GtkPlug and - Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The + Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The client may be in the same process or in a different process. To embed a #GtkPlug in a #GtkSocket, you can either create the @@ -136021,23 +96759,17 @@ The #GtkSocket must have already be added into a toplevel window - a #GtkSocket + a #GtkSocket - the Window of a client participating in the XEMBED protocol. + the Window of a client participating in the XEMBED protocol. - Gets the window ID of a #GtkSocket widget, which can then + Gets the window ID of a #GtkSocket widget, which can then be used to create a client embedded inside the socket, for instance with gtk_plug_new(). @@ -136045,40 +96777,28 @@ The #GtkSocket must have already be added into a toplevel window before you can make this call. - the window ID for the socket + the window ID for the socket - a #GtkSocket. + a #GtkSocket. - - Retrieves the window of the plug. Use this to check if the plug has + + Retrieves the window of the plug. Use this to check if the plug has been created inside of the socket. - the window of the plug if + the window of the plug if available, or %NULL - a #GtkSocket. + a #GtkSocket. @@ -136090,35 +96810,23 @@ available, or %NULL - This signal is emitted when a client is successfully + This signal is emitted when a client is successfully added to the socket. - This signal is emitted when a client is removed from the socket. + This signal is emitted when a client is removed from the socket. The default action is to destroy the #GtkSocket widget, so if you want to reuse it you must add a signal handler that returns %TRUE. - %TRUE to stop other handlers from being invoked. + %TRUE to stop other handlers from being invoked. - + @@ -136139,27 +96847,19 @@ want to reuse it you must add a signal handler that returns %TRUE. - + - + - + - + - + @@ -136226,40 +96926,17 @@ want to reuse it you must add a signal handler that returns %TRUE. - - Determines the direction of a sort. - - Sorting is in ascending order. + + Determines the direction of a sort. + + Sorting is in ascending order. - - Sorting is in descending order. + + Sorting is in descending order. - - A #GtkSpinButton is an ideal way to allow the user to set the value of + + A #GtkSpinButton is an ideal way to allow the user to set the value of some attribute. Rather than having to directly type a number into a #GtkEntry, GtkSpinButton allows the user to click on one of two arrows to increment or decrement the displayed value. A value can still be @@ -136278,22 +96955,22 @@ to the desired number of characters to display in the entry. |[<!-- language="plain" --> spinbutton.horizontal -├── undershoot.left -├── undershoot.right -├── entry -│ ╰── ... -├── button.down -╰── button.up +├── undershoot.left +├── undershoot.right +├── entry +│ ╰── ... +├── button.down +╰── button.up ]| |[<!-- language="plain" --> spinbutton.vertical -├── undershoot.left -├── undershoot.right -├── button.up -├── entry -│ ╰── ... -╰── button.down +├── undershoot.left +├── undershoot.right +├── button.up +├── entry +│ ╰── ... +╰── button.down ]| GtkSpinButtons main CSS node has the name spinbutton. It creates subnodes @@ -136373,47 +97050,31 @@ create_floating_spin_button (void) - Creates a new #GtkSpinButton. + Creates a new #GtkSpinButton. - The new spin button as a #GtkWidget + The new spin button as a #GtkWidget - - the #GtkAdjustment object that this spin + + the #GtkAdjustment object that this spin button should use, or %NULL - specifies by how much the rate of change in the value will + specifies by how much the rate of change in the value will accelerate if you continue to hold down an up/down button or arrow key - the number of decimal places to display + the number of decimal places to display - - This is a convenience constructor that allows creation of a numeric + + This is a convenience constructor that allows creation of a numeric #GtkSpinButton without manually creating an adjustment. The value is initially set to the minimum value and a page increment of 10 * @step is the default. The precision of the spin button is equivalent to the @@ -136424,28 +97085,20 @@ is a power of ten. If the resulting precision is not suitable for your needs, use gtk_spin_button_set_digits() to correct it. - The new spin button as a #GtkWidget + The new spin button as a #GtkWidget - Minimum allowable value + Minimum allowable value - Maximum allowable value + Maximum allowable value - Increment added or subtracted by spinning the widget + Increment added or subtracted by spinning the widget @@ -136512,9 +97165,7 @@ needs, use gtk_spin_button_set_digits() to correct it. - Changes the properties of an existing spin button. The adjustment, + Changes the properties of an existing spin button. The adjustment, climb rate, and number of decimal places are updated accordingly. @@ -136522,81 +97173,54 @@ climb rate, and number of decimal places are updated accordingly. - a #GtkSpinButton + a #GtkSpinButton - - a #GtkAdjustment to replace the spin button’s + + a #GtkAdjustment to replace the spin button’s existing adjustment, or %NULL to leave its current adjustment unchanged - the new climb rate + the new climb rate - the number of decimal places to display in the spin button + the number of decimal places to display in the spin button - - Get the adjustment associated with a #GtkSpinButton + + Get the adjustment associated with a #GtkSpinButton - the #GtkAdjustment of @spin_button + the #GtkAdjustment of @spin_button - a #GtkSpinButton + a #GtkSpinButton - Fetches the precision of @spin_button. See gtk_spin_button_set_digits(). + Fetches the precision of @spin_button. See gtk_spin_button_set_digits(). - the current precision + the current precision - a #GtkSpinButton + a #GtkSpinButton - - Gets the current step and page the increments used by @spin_button. See + + Gets the current step and page the increments used by @spin_button. See gtk_spin_button_set_increments(). @@ -136604,60 +97228,36 @@ gtk_spin_button_set_increments(). - a #GtkSpinButton + a #GtkSpinButton - - location to store step increment, or %NULL + + location to store step increment, or %NULL - - location to store page increment, or %NULL + + location to store page increment, or %NULL - Returns whether non-numeric text can be typed into the spin button. + Returns whether non-numeric text can be typed into the spin button. See gtk_spin_button_set_numeric(). - %TRUE if only numeric text can be entered + %TRUE if only numeric text can be entered - a #GtkSpinButton + a #GtkSpinButton - Gets the range allowed for @spin_button. + Gets the range allowed for @spin_button. See gtk_spin_button_set_range(). @@ -136665,171 +97265,112 @@ See gtk_spin_button_set_range(). - a #GtkSpinButton + a #GtkSpinButton - - location to store minimum allowed value, or %NULL + + location to store minimum allowed value, or %NULL - - location to store maximum allowed value, or %NULL + + location to store maximum allowed value, or %NULL - - Returns whether the values are corrected to the nearest step. + + Returns whether the values are corrected to the nearest step. See gtk_spin_button_set_snap_to_ticks(). - %TRUE if values are snapped to the nearest step + %TRUE if values are snapped to the nearest step - a #GtkSpinButton + a #GtkSpinButton - - Gets the update behavior of a spin button. + + Gets the update behavior of a spin button. See gtk_spin_button_set_update_policy(). - the current update policy - + the current update policy + - a #GtkSpinButton + a #GtkSpinButton - Get the value in the @spin_button. + Get the value in the @spin_button. - the value of @spin_button + the value of @spin_button - a #GtkSpinButton + a #GtkSpinButton - - Get the value @spin_button represented as an integer. + + Get the value @spin_button represented as an integer. - the value of @spin_button + the value of @spin_button - a #GtkSpinButton + a #GtkSpinButton - Returns whether the spin button’s value wraps around to the + Returns whether the spin button’s value wraps around to the opposite limit when the upper or lower limit of the range is exceeded. See gtk_spin_button_set_wrap(). - %TRUE if the spin button wraps around + %TRUE if the spin button wraps around - a #GtkSpinButton + a #GtkSpinButton - - Replaces the #GtkAdjustment associated with @spin_button. + + Replaces the #GtkAdjustment associated with @spin_button. - a #GtkSpinButton + a #GtkSpinButton - a #GtkAdjustment to replace the existing adjustment + a #GtkAdjustment to replace the existing adjustment - Set the precision to be displayed by @spin_button. Up to 20 digit precision + Set the precision to be displayed by @spin_button. Up to 20 digit precision is allowed. @@ -136837,54 +97378,39 @@ is allowed. - a #GtkSpinButton + a #GtkSpinButton - the number of digits after the decimal point to be displayed for the spin button’s value + the number of digits after the decimal point to be displayed for the spin button’s value - - Sets the step and page increments for spin_button. This affects how -quickly the value changes when the spin button’s arrows are activated. + + Sets the step and page increments for spin_button. This affects how +quickly the value changes when the spin button’s arrows are activated. - a #GtkSpinButton + a #GtkSpinButton - increment applied for a button 1 press. + increment applied for a button 1 press. - increment applied for a button 2 press. + increment applied for a button 2 press. - Sets the flag that determines if non-numeric text can be typed + Sets the flag that determines if non-numeric text can be typed into the spin button. @@ -136892,23 +97418,17 @@ into the spin button. - a #GtkSpinButton + a #GtkSpinButton - flag indicating if only numeric entry is allowed + flag indicating if only numeric entry is allowed - Sets the minimum and maximum allowable values for @spin_button. + Sets the minimum and maximum allowable values for @spin_button. If the current value is outside this range, it will be adjusted to fit within the range, otherwise it will remain unchanged. @@ -136918,30 +97438,21 @@ to fit within the range, otherwise it will remain unchanged. - a #GtkSpinButton + a #GtkSpinButton - minimum allowable value + minimum allowable value - maximum allowable value + maximum allowable value - - Sets the policy as to whether values are corrected to the + + Sets the policy as to whether values are corrected to the nearest step increment when a spin button is activated after providing an invalid value. @@ -136950,24 +97461,17 @@ providing an invalid value. - a #GtkSpinButton + a #GtkSpinButton - a flag indicating if invalid values should be corrected + a flag indicating if invalid values should be corrected - - Sets the update behavior of a spin button. + + Sets the update behavior of a spin button. This determines whether the spin button is always updated or only when a valid value is set. @@ -136976,47 +97480,34 @@ or only when a valid value is set. - a #GtkSpinButton + a #GtkSpinButton - a #GtkSpinButtonUpdatePolicy value - + a #GtkSpinButtonUpdatePolicy value + - Sets the value of @spin_button. + Sets the value of @spin_button. - a #GtkSpinButton + a #GtkSpinButton - the new value + the new value - Sets the flag that determines if a spin button value wraps + Sets the flag that determines if a spin button value wraps around to the opposite limit when the upper or lower limit of the range is exceeded. @@ -137025,23 +97516,17 @@ of the range is exceeded. - a #GtkSpinButton + a #GtkSpinButton - a flag indicating if wrapping behavior is performed + a flag indicating if wrapping behavior is performed - Increment or decrement a spin button’s value in a specified + Increment or decrement a spin button’s value in a specified direction by a specified amount. @@ -137049,38 +97534,28 @@ direction by a specified amount. - a #GtkSpinButton + a #GtkSpinButton - a #GtkSpinType indicating the direction to spin + a #GtkSpinType indicating the direction to spin - step increment to apply in the specified direction + step increment to apply in the specified direction - Manually force an update of the spin button. + Manually force an update of the spin button. - a #GtkSpinButton + a #GtkSpinButton @@ -137116,9 +97591,7 @@ direction by a specified amount. - The ::change-value signal is a [keybinding signal][GtkBindingSignal] + The ::change-value signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a value change. Applications should not connect to it, but may emit it with @@ -137131,45 +97604,32 @@ The default bindings for this signal are Up/Down and PageUp and/PageDown. - a #GtkScrollType to specify the speed and amount of change + a #GtkScrollType to specify the speed and amount of change - The ::input signal can be used to influence the conversion of + The ::input signal can be used to influence the conversion of the users input into a double value. The signal handler is expected to use gtk_entry_get_text() to retrieve the text of the entry and set @new_value to the new value. The default conversion uses g_strtod(). - %TRUE for a successful conversion, %FALSE if the input + %TRUE for a successful conversion, %FALSE if the input was not handled, and %GTK_INPUT_ERROR if the conversion failed. - - return location for the new value + + return location for the new value - The ::output signal can be used to change to formatting + The ::output signal can be used to change to formatting of the value that is displayed in the spin buttons entry. |[<!-- language="C" --> // show leading zeros @@ -137191,40 +97651,27 @@ on_output (GtkSpinButton *spin, } ]| - %TRUE if the value has been displayed + %TRUE if the value has been displayed - The ::value-changed signal is emitted when the value represented by + The ::value-changed signal is emitted when the value represented by @spinbutton changes. Also see the #GtkSpinButton::output signal. - The ::wrapped signal is emitted right after the spinbutton wraps + The ::wrapped signal is emitted right after the spinbutton wraps from its maximum to minimum value or vice-versa. - - + + @@ -137234,28 +97681,19 @@ from its maximum to minimum value or vice-versa. - + - - + + - - + + - + @@ -137364,112 +97802,50 @@ from its maximum to minimum value or vice-versa. - + - - The spin button update policy determines whether the spin button displays + + The spin button update policy determines whether the spin button displays values even if they are outside the bounds of its adjustment. See gtk_spin_button_set_update_policy(). - - When refreshing your #GtkSpinButton, the value is + + When refreshing your #GtkSpinButton, the value is always displayed - - When refreshing your #GtkSpinButton, the value is + + When refreshing your #GtkSpinButton, the value is only displayed if it is valid within the bounds of the spin button's adjustment - - The values of the GtkSpinType enumeration are used to specify the + + The values of the GtkSpinType enumeration are used to specify the change to make in gtk_spin_button_spin(). - - Increment by the adjustments step increment. + + Increment by the adjustments step increment. - - Decrement by the adjustments step increment. + + Decrement by the adjustments step increment. - - Increment by the adjustments page increment. + + Increment by the adjustments page increment. - - Decrement by the adjustments page increment. + + Decrement by the adjustments page increment. - - Go to the adjustments lower bound. + + Go to the adjustments lower bound. - Go to the adjustments upper bound. + Go to the adjustments upper bound. - - Change by a specified amount. + + Change by a specified amount. - - A GtkSpinner widget displays an icon-size spinning animation. + + A GtkSpinner widget displays an icon-size spinning animation. It is often used as an alternative to a #GtkProgressBar for displaying indefinite activity, instead of actual progress. @@ -137484,47 +97860,35 @@ active, the :checked pseudoclass is added to this node. - Returns a new spinner widget. Not yet started. + Returns a new spinner widget. Not yet started. - a new #GtkSpinner + a new #GtkSpinner - Starts the animation of the spinner. + Starts the animation of the spinner. - a #GtkSpinner + a #GtkSpinner - Stops the animation of the spinner. + Stops the animation of the spinner. - a #GtkSpinner + a #GtkSpinner @@ -137539,13 +97903,7 @@ active, the :checked pseudoclass is added to this node. - + @@ -137553,26 +97911,19 @@ active, the :checked pseudoclass is added to this node. - + - + - + - + @@ -137613,16 +97964,8 @@ active, the :checked pseudoclass is added to this node. - - The GtkStack widget is a container which only shows + + The GtkStack widget is a container which only shows one of its children at a time. In contrast to GtkNotebook, GtkStack does not provide a means for users to change the visible child. Instead, the #GtkStackSwitcher widget can be @@ -137642,23 +97985,15 @@ GtkStack has a single CSS node named stack. - Creates a new #GtkStack container. + Creates a new #GtkStack container. - a new #GtkStack + a new #GtkStack - - Adds a child to @stack. + + Adds a child to @stack. The child is identified by the @name. @@ -137666,31 +98001,21 @@ The child is identified by the @name. - a #GtkStack + a #GtkStack - the widget to add + the widget to add - the name for @child + the name for @child - - Adds a child to @stack. + + Adds a child to @stack. The child is identified by the @name. The @title will be used by #GtkStackSwitcher to represent @child in a tab bar, so it should be short. @@ -137700,274 +98025,180 @@ will be used by #GtkStackSwitcher to represent - a #GtkStack + a #GtkStack - the widget to add + the widget to add - the name for @child + the name for @child - a human-readable title for @child + a human-readable title for @child - - Finds the child of the #GtkStack with the name given as + + Finds the child of the #GtkStack with the name given as the argument. Returns %NULL if there is no child with this name. - the requested child of the #GtkStack + the requested child of the #GtkStack - a #GtkStack + a #GtkStack - the name of the child to find + the name of the child to find - - Gets whether @stack is horizontally homogeneous. + + Gets whether @stack is horizontally homogeneous. See gtk_stack_set_hhomogeneous(). - whether @stack is horizontally homogeneous. + whether @stack is horizontally homogeneous. - a #GtkStack + a #GtkStack - - Gets whether @stack is homogeneous. + + Gets whether @stack is homogeneous. See gtk_stack_set_homogeneous(). - whether @stack is homogeneous. + whether @stack is homogeneous. - a #GtkStack + a #GtkStack - - Returns wether the #GtkStack is set up to interpolate between + + Returns wether the #GtkStack is set up to interpolate between the sizes of children on page switch. - %TRUE if child sizes are interpolated + %TRUE if child sizes are interpolated - A #GtkStack + A #GtkStack - - Returns the amount of time (in milliseconds) that + + Returns the amount of time (in milliseconds) that transitions between pages in @stack will take. - the transition duration + the transition duration - a #GtkStack + a #GtkStack - - Returns whether the @stack is currently in a transition from one page to + + Returns whether the @stack is currently in a transition from one page to another. - %TRUE if the transition is currently running, %FALSE otherwise. + %TRUE if the transition is currently running, %FALSE otherwise. - a #GtkStack + a #GtkStack - - Gets the type of animation that will be used + + Gets the type of animation that will be used for transitions between pages in @stack. - the current transition type of @stack + the current transition type of @stack - a #GtkStack + a #GtkStack - - Gets whether @stack is vertically homogeneous. + + Gets whether @stack is vertically homogeneous. See gtk_stack_set_vhomogeneous(). - whether @stack is vertically homogeneous. + whether @stack is vertically homogeneous. - a #GtkStack + a #GtkStack - - Gets the currently visible child of @stack, or %NULL if + + Gets the currently visible child of @stack, or %NULL if there are no visible children. - the visible child of the #GtkStack + the visible child of the #GtkStack - a #GtkStack + a #GtkStack - - Returns the name of the currently visible child of @stack, or + + Returns the name of the currently visible child of @stack, or %NULL if there is no visible child. - the name of the visible child of the #GtkStack + the name of the visible child of the #GtkStack - a #GtkStack + a #GtkStack - - Sets the #GtkStack to be horizontally homogeneous or not. + + Sets the #GtkStack to be horizontally homogeneous or not. If it is homogeneous, the #GtkStack will request the same width for all its children. If it isn't, the stack may change width when a different child becomes visible. @@ -137977,25 +98208,17 @@ may change width when a different child becomes visible. - a #GtkStack + a #GtkStack - %TRUE to make @stack horizontally homogeneous + %TRUE to make @stack horizontally homogeneous - - Sets the #GtkStack to be homogeneous or not. If it + + Sets the #GtkStack to be homogeneous or not. If it is homogeneous, the #GtkStack will request the same size for all its children. If it isn't, the stack may change size when a different child becomes visible. @@ -138009,25 +98232,17 @@ for horizontal and vertical size, with the - a #GtkStack + a #GtkStack - %TRUE to make @stack homogeneous + %TRUE to make @stack homogeneous - - Sets whether or not @stack will interpolate its size when + + Sets whether or not @stack will interpolate its size when changing the visible child. If the #GtkStack:interpolate-size property is set to %TRUE, @stack will interpolate its size between the current one and the one it'll take after changing the @@ -138038,25 +98253,17 @@ visible child, according to the set transition duration. - A #GtkStack + A #GtkStack - the new value + the new value - - Sets the duration that transitions between pages in @stack + + Sets the duration that transitions between pages in @stack will take. @@ -138064,25 +98271,17 @@ will take. - a #GtkStack + a #GtkStack - the new duration, in milliseconds + the new duration, in milliseconds - - Sets the type of animation that will be used for + + Sets the type of animation that will be used for transitions between pages in @stack. Available types include various kinds of fades and slides. @@ -138095,25 +98294,17 @@ based on the page that is about to become current. - a #GtkStack + a #GtkStack - the new transition type + the new transition type - - Sets the #GtkStack to be vertically homogeneous or not. + + Sets the #GtkStack to be vertically homogeneous or not. If it is homogeneous, the #GtkStack will request the same height for all its children. If it isn't, the stack may change height when a different child becomes visible. @@ -138123,25 +98314,17 @@ may change height when a different child becomes visible. - a #GtkStack + a #GtkStack - %TRUE to make @stack vertically homogeneous + %TRUE to make @stack vertically homogeneous - - Makes @child the visible child of @stack. + + Makes @child the visible child of @stack. If @child is different from the currently visible child, the transition between the @@ -138157,25 +98340,17 @@ child of @stack. - a #GtkStack + a #GtkStack - a child of @stack + a child of @stack - - Makes the child with the given name visible. + + Makes the child with the given name visible. Note that the child widget has to be visible itself (see gtk_widget_show()) in order to become the visible @@ -138186,31 +98361,21 @@ child of @stack. - a #GtkStack + a #GtkStack - the name of the child to make visible + the name of the child to make visible - the transition type to use + the transition type to use - - Makes the child with the given name visible. + + Makes the child with the given name visible. If @child is different from the currently visible child, the transition between the @@ -138226,26 +98391,17 @@ child of @stack. - a #GtkStack + a #GtkStack - the name of the child to make visible + the name of the child to make visible - - %TRUE if the stack allocates the same width for all children. + + %TRUE if the stack allocates the same width for all children. @@ -138254,9 +98410,7 @@ child of @stack. - + @@ -138265,68 +98419,41 @@ child of @stack. - - %TRUE if the stack allocates the same height for all children. + + %TRUE if the stack allocates the same height for all children. - + - + - + - + - + - - A GtkStackSidebar enables you to quickly and easily provide a + + A GtkStackSidebar enables you to quickly and easily provide a consistent "sidebar" object for your user interface. In order to use a GtkStackSidebar, you simply use a GtkStack to @@ -138345,50 +98472,32 @@ pages. - - Creates a new sidebar. + + Creates a new sidebar. - the new #GtkStackSidebar + the new #GtkStackSidebar - - Retrieves the stack. + + Retrieves the stack. See gtk_stack_sidebar_set_stack(). - the associated #GtkStack or + the associated #GtkStack or %NULL if none has been set explicitly - a #GtkStackSidebar + a #GtkStackSidebar - - Set the #GtkStack associated with this #GtkStackSidebar. + + Set the #GtkStack associated with this #GtkStackSidebar. The sidebar widget will automatically update according to the order (packing) and items within the given #GtkStack. @@ -138398,15 +98507,11 @@ The sidebar widget will automatically update according to the order - a #GtkStackSidebar + a #GtkStackSidebar - a #GtkStack + a #GtkStack @@ -138418,9 +98523,7 @@ The sidebar widget will automatically update according to the order - + @@ -138458,21 +98561,11 @@ The sidebar widget will automatically update according to the order - + - - The GtkStackSwitcher widget acts as a controller for a + + The GtkStackSwitcher widget acts as a controller for a #GtkStack; it shows a row of buttons to switch between the various pages of the associated stack widget. @@ -138498,95 +98591,60 @@ stack pages. - - Create a new #GtkStackSwitcher. + + Create a new #GtkStackSwitcher. - a new #GtkStackSwitcher. + a new #GtkStackSwitcher. - - Retrieves the stack. + + Retrieves the stack. See gtk_stack_switcher_set_stack(). - the stack, or %NULL if + the stack, or %NULL if none has been set explicitly. - a #GtkStackSwitcher + a #GtkStackSwitcher - - Sets the stack to control. + + Sets the stack to control. - a #GtkStackSwitcher + a #GtkStackSwitcher - - a #GtkStack + + a #GtkStack - - Use the "icon-size" property to change the size of the image displayed + + Use the "icon-size" property to change the size of the image displayed when a #GtkStackSwitcher is displaying icons. - + - + - + @@ -138624,390 +98682,160 @@ when a #GtkStackSwitcher is displaying icons. - - These enumeration values describe the possible transitions + + These enumeration values describe the possible transitions between pages in a #GtkStack widget. New values may be added to this enumeration over time. - - No transition + + No transition - - A cross-fade + + A cross-fade - - Slide from left to right + + Slide from left to right - - Slide from right to left + + Slide from right to left - - Slide from bottom up + + Slide from bottom up - - Slide from top down + + Slide from top down - - Slide from left or right according to the children order + + Slide from left or right according to the children order - - Slide from top down or bottom up according to the order + + Slide from top down or bottom up according to the order - - Cover the old page by sliding up. Since 3.12 + + Cover the old page by sliding up. Since 3.12 - - Cover the old page by sliding down. Since: 3.12 + + Cover the old page by sliding down. Since: 3.12 - - Cover the old page by sliding to the left. Since: 3.12 + + Cover the old page by sliding to the left. Since: 3.12 - - Cover the old page by sliding to the right. Since: 3.12 + + Cover the old page by sliding to the right. Since: 3.12 - - Uncover the new page by sliding up. Since 3.12 + + Uncover the new page by sliding up. Since 3.12 - - Uncover the new page by sliding down. Since: 3.12 + + Uncover the new page by sliding down. Since: 3.12 - - Uncover the new page by sliding to the left. Since: 3.12 + + Uncover the new page by sliding to the left. Since: 3.12 - - Uncover the new page by sliding to the right. Since: 3.12 + + Uncover the new page by sliding to the right. Since: 3.12 - - Cover the old page sliding up or uncover the new page sliding down, according to order. Since: 3.12 + + Cover the old page sliding up or uncover the new page sliding down, according to order. Since: 3.12 - - Cover the old page sliding down or uncover the new page sliding up, according to order. Since: 3.14 + + Cover the old page sliding down or uncover the new page sliding up, according to order. Since: 3.14 - - Cover the old page sliding left or uncover the new page sliding right, according to order. Since: 3.14 + + Cover the old page sliding left or uncover the new page sliding right, according to order. Since: 3.14 - - Cover the old page sliding right or uncover the new page sliding left, according to order. Since: 3.14 + + Cover the old page sliding right or uncover the new page sliding left, according to order. Since: 3.14 - - Describes a widget state. Widget states are used to match the widget + + Describes a widget state. Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names. - - State during normal operation. + + State during normal operation. - - Widget is active. + + Widget is active. - - Widget has a mouse pointer over it. + + Widget has a mouse pointer over it. - - Widget is selected. + + Widget is selected. - - Widget is insensitive. + + Widget is insensitive. - - Widget is inconsistent. + + Widget is inconsistent. - - Widget has the keyboard focus. + + Widget has the keyboard focus. - - Widget is in a background toplevel window. + + Widget is in a background toplevel window. - - Widget is in left-to-right text direction. Since 3.8 + + Widget is in left-to-right text direction. Since 3.8 - - Widget is in right-to-left text direction. Since 3.8 + + Widget is in right-to-left text direction. Since 3.8 - - Widget is a link. Since 3.12 + + Widget is a link. Since 3.12 - - The location the widget points to has already been visited. Since 3.12 + + The location the widget points to has already been visited. Since 3.12 - - Widget is checked. Since 3.14 + + Widget is checked. Since 3.14 - - Widget is highlighted as a drop target for DND. Since 3.20 + + Widget is highlighted as a drop target for DND. Since 3.20 - - This type indicates the current state of a widget; the state determines how + + This type indicates the current state of a widget; the state determines how the widget is drawn. The #GtkStateType enumeration is also used to identify different colors in a #GtkStyle for drawing, so states can be used for subparts of a widget as well as entire widgets. All APIs that are using this enumeration have been deprecated in favor of alternatives using #GtkStateFlags. - - State during normal operation. + + State during normal operation. - - State of a currently active widget, such as a depressed button. + + State of a currently active widget, such as a depressed button. - - State indicating that the mouse pointer is over + + State indicating that the mouse pointer is over the widget and the widget will respond to mouse clicks. - - State of a selected item, such the selected row in a list. + + State of a selected item, such the selected row in a list. - - State indicating that the widget is + + State indicating that the widget is unresponsive to user actions. - - The widget is inconsistent, such as checkbuttons - or radiobuttons that aren’t either set to %TRUE nor %FALSE, + + The widget is inconsistent, such as checkbuttons + or radiobuttons that aren’t either set to %TRUE nor %FALSE, or buttons requiring the user attention. - - The widget has the keyboard focus. + + The widget has the keyboard focus. - - The “system tray” or notification area is normally used for transient icons + + The “system tray” or notification area is normally used for transient icons that indicate some special state. For example, a system tray icon might appear to tell the user that they have new mail, or have an incoming instant message, or something along those lines. The basic idea is that creating an icon in the notification area is less annoying than popping up a dialog. -A #GtkStatusIcon object can be used to display an icon in a “system tray”. +A #GtkStatusIcon object can be used to display an icon in a “system tray”. The icon can have a tooltip, and the user can interact with it by activating it or popping up a context menu. @@ -139021,11 +98849,11 @@ recover if the function returns %FALSE. On X11, the implementation follows the [FreeDesktop System Tray Specification](http://www.freedesktop.org/wiki/Specifications/systemtray-spec). -Implementations of the “tray” side of this specification can +Implementations of the “tray” side of this specification can be found e.g. in the GNOME 2 and KDE panel applications. Note that a GtkStatusIcon is not a widget, but just a #GObject. Making it a -widget would be impractical, since the system tray on Windows doesn’t allow +widget would be impractical, since the system tray on Windows doesn’t allow to embed arbitrary widgets. GtkStatusIcon has been deprecated in 3.14. You should consider using @@ -139035,32 +98863,18 @@ platforms and environments, and should be the preferred mechanism to notify the users of transient status updates. See this [HowDoI](https://wiki.gnome.org/HowDoI/GNotification) for code examples. - - Creates an empty status icon object. + + Creates an empty status icon object. Use #GNotification and #GtkApplication to provide status notifications - a new #GtkStatusIcon + a new #GtkStatusIcon - - Creates a status icon displaying the file @filename. + + Creates a status icon displaying the file @filename. The image will be scaled down to fit in the available space in the notification area, if necessary. @@ -139068,83 +98882,53 @@ space in the notification area, if necessary. provide status notifications - a new #GtkStatusIcon + a new #GtkStatusIcon - a filename + a filename - - Creates a status icon displaying a #GIcon. If the icon is a + + Creates a status icon displaying a #GIcon. If the icon is a themed icon, it will be updated when the theme changes. Use #GNotification and #GtkApplication to provide status notifications - a new #GtkStatusIcon + a new #GtkStatusIcon - a #GIcon + a #GIcon - - Creates a status icon displaying an icon from the current icon theme. + + Creates a status icon displaying an icon from the current icon theme. If the current icon theme is changed, the icon will be updated appropriately. Use #GNotification and #GtkApplication to provide status notifications - a new #GtkStatusIcon + a new #GtkStatusIcon - an icon name + an icon name - - Creates a status icon displaying @pixbuf. + + Creates a status icon displaying @pixbuf. The image will be scaled down to fit in the available space in the notification area, if necessary. @@ -139152,28 +98936,18 @@ space in the notification area, if necessary. provide status notifications - a new #GtkStatusIcon + a new #GtkStatusIcon - a #GdkPixbuf + a #GdkPixbuf - - Creates a status icon displaying a stock icon. Sample stock icon + + Creates a status icon displaying a stock icon. Sample stock icon names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your own stock icon names, see gtk_icon_factory_add_default() and gtk_icon_factory_add(). @@ -139181,28 +98955,18 @@ gtk_icon_factory_add(). provide status notifications - a new #GtkStatusIcon + a new #GtkStatusIcon - a stock icon id + a stock icon id - - Menu positioning function to use with gtk_menu_popup() + + Menu positioning function to use with gtk_menu_popup() to position @menu aligned to the status icon @user_data. Use #GNotification and #GtkApplication to provide status notifications; notifications do not have menus, @@ -139213,44 +98977,25 @@ to position @menu aligned to the status icon @user_data. - the #GtkMenu + the #GtkMenu - - return location for the x position + + return location for the x position - - return location for the y position + + return location for the y position - - whether the first menu item should be offset + + whether the first menu item should be offset (pushed in) to be aligned with the menu popup position (only useful for GtkOptionMenu). - the status icon to position the menu on + the status icon to position the menu on @@ -139362,14 +99107,8 @@ to position @menu aligned to the status icon @user_data. - - Obtains information about the location of the status icon + + Obtains information about the location of the status icon on screen. This information can be used to e.g. position popups like notification bubbles. @@ -139387,52 +99126,27 @@ gtk_status_icon_is_embedded(). presentation of notifications - %TRUE if the location information has + %TRUE if the location information has been filled in - a #GtkStatusIcon + a #GtkStatusIcon - - return location for + + return location for the screen, or %NULL if the information is not needed - - return location for the area occupied by + + return location for the area occupied by the status icon, or %NULL - - return location for the + + return location for the orientation of the panel in which the status icon is embedded, or %NULL. A panel at the top or bottom of the screen is horizontal, a panel at the left or right is vertical. @@ -139440,14 +99154,8 @@ gtk_status_icon_is_embedded(). - - Retrieves the #GIcon being displayed by the #GtkStatusIcon. + + Retrieves the #GIcon being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the @@ -139459,56 +99167,36 @@ If this function fails, @icon is left unchanged; for this function - the displayed icon, or %NULL if the image is empty + the displayed icon, or %NULL if the image is empty - a #GtkStatusIcon + a #GtkStatusIcon - - Returns the current value of the has-tooltip property. + + Returns the current value of the has-tooltip property. See #GtkStatusIcon:has-tooltip for more information. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function - current value of has-tooltip on @status_icon. + current value of has-tooltip on @status_icon. - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the name of the icon being displayed by the #GtkStatusIcon. + + Gets the name of the icon being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()). The returned string is owned by the #GtkStatusIcon and should not @@ -139518,28 +99206,18 @@ be freed or modified. for this function - name of the displayed icon, or %NULL if the image is empty. + name of the displayed icon, or %NULL if the image is empty. - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the #GdkPixbuf being displayed by the #GtkStatusIcon. + + Gets the #GdkPixbuf being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the @@ -139549,56 +99227,36 @@ returned pixbuf. for this function - the displayed pixbuf, + the displayed pixbuf, or %NULL if the image is empty. - a #GtkStatusIcon + a #GtkStatusIcon - - Returns the #GdkScreen associated with @status_icon. + + Returns the #GdkScreen associated with @status_icon. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as notifications are managed by the platform - a #GdkScreen. + a #GdkScreen. - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the size in pixels that is available for the image. + + Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the size-changed signal can be used to @@ -139612,28 +99270,18 @@ status icon is embedded (see gtk_status_icon_is_embedded()). is left to the platform - the size that is available for the image + the size that is available for the image - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the id of the stock icon being displayed by the #GtkStatusIcon. + + Gets the id of the stock icon being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()). The returned string is owned by the #GtkStatusIcon and should not @@ -139641,29 +99289,19 @@ be freed or modified. Use gtk_status_icon_get_icon_name() instead. - stock id of the displayed stock icon, + stock id of the displayed stock icon, or %NULL if the image is empty. - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the type of representation being used by the #GtkStatusIcon + + Gets the type of representation being used by the #GtkStatusIcon to store image data. If the #GtkStatusIcon has no image data, the return value will be %GTK_IMAGE_EMPTY. Use #GNotification and #GtkApplication to @@ -139672,111 +99310,71 @@ the return value will be %GTK_IMAGE_EMPTY. instances - the image representation being used + the image representation being used - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the title of this tray icon. See gtk_status_icon_set_title(). + + Gets the title of this tray icon. See gtk_status_icon_set_title(). Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function - the title of the status icon + the title of the status icon - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the contents of the tooltip for @status_icon. + + Gets the contents of the tooltip for @status_icon. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function - the tooltip text, or %NULL. You should free the + the tooltip text, or %NULL. You should free the returned string with g_free() when done. - a #GtkStatusIcon + a #GtkStatusIcon - - Gets the contents of the tooltip for @status_icon. + + Gets the contents of the tooltip for @status_icon. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function - the tooltip text, or %NULL. You should free the + the tooltip text, or %NULL. You should free the returned string with g_free() when done. - a #GtkStatusIcon + a #GtkStatusIcon - - Returns whether the status icon is visible or not. + + Returns whether the status icon is visible or not. Note that being visible does not guarantee that the user can actually see the icon, see also gtk_status_icon_is_embedded(). @@ -139785,28 +99383,18 @@ gtk_status_icon_is_embedded(). for this function - %TRUE if the status icon is visible + %TRUE if the status icon is visible - a #GtkStatusIcon + a #GtkStatusIcon - - This function is only useful on the X11/freedesktop.org platform. + + This function is only useful on the X11/freedesktop.org platform. It returns a window ID for the widget in the underlying status icon implementation. This is useful for the Galago @@ -139822,58 +99410,38 @@ as gtk_status_icon_position_menu(). for this function - An 32 bit unsigned integer identifier for the + An 32 bit unsigned integer identifier for the underlying X11 Window - a #GtkStatusIcon + a #GtkStatusIcon - - Returns whether the status icon is embedded in a notification + + Returns whether the status icon is embedded in a notification area. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function - %TRUE if the status icon is embedded in + %TRUE if the status icon is embedded in a notification area. - a #GtkStatusIcon + a #GtkStatusIcon - - Makes @status_icon display the file @filename. + + Makes @status_icon display the file @filename. See gtk_status_icon_new_from_file() for details. Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() @@ -139884,27 +99452,17 @@ See gtk_status_icon_new_from_file() for details. - a #GtkStatusIcon + a #GtkStatusIcon - a filename + a filename - - Makes @status_icon display the #GIcon. + + Makes @status_icon display the #GIcon. See gtk_status_icon_new_from_gicon() for details. Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() @@ -139915,27 +99473,17 @@ See gtk_status_icon_new_from_gicon() for details. - a #GtkStatusIcon + a #GtkStatusIcon - a GIcon + a GIcon - - Makes @status_icon display the icon named @icon_name from the + + Makes @status_icon display the icon named @icon_name from the current icon theme. See gtk_status_icon_new_from_icon_name() for details. Use #GNotification and #GtkApplication to @@ -139947,27 +99495,17 @@ See gtk_status_icon_new_from_icon_name() for details. - a #GtkStatusIcon + a #GtkStatusIcon - an icon name + an icon name - - Makes @status_icon display @pixbuf. + + Makes @status_icon display @pixbuf. See gtk_status_icon_new_from_pixbuf() for details. Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() @@ -139978,30 +99516,17 @@ See gtk_status_icon_new_from_pixbuf() for details. - a #GtkStatusIcon + a #GtkStatusIcon - - a #GdkPixbuf or %NULL + + a #GdkPixbuf or %NULL - - Makes @status_icon display the stock icon with the id @stock_id. + + Makes @status_icon display the stock icon with the id @stock_id. See gtk_status_icon_new_from_stock() for details. Use gtk_status_icon_set_from_icon_name() instead. @@ -140010,27 +99535,17 @@ See gtk_status_icon_new_from_stock() for details. - a #GtkStatusIcon + a #GtkStatusIcon - a stock icon id + a stock icon id - - Sets the has-tooltip property on @status_icon to @has_tooltip. + + Sets the has-tooltip property on @status_icon to @has_tooltip. See #GtkStatusIcon:has-tooltip for more information. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement @@ -140042,27 +99557,17 @@ See #GtkStatusIcon:has-tooltip for more information. - a #GtkStatusIcon + a #GtkStatusIcon - whether or not @status_icon has a tooltip + whether or not @status_icon has a tooltip - - Sets the name of this tray icon. + + Sets the name of this tray icon. This should be a string identifying this icon. It is may be used for sorting the icons in the tray and will not be shown to the user. @@ -140076,27 +99581,17 @@ the user. - a #GtkStatusIcon + a #GtkStatusIcon - the name + the name - - Sets the #GdkScreen where @status_icon is displayed; if + + Sets the #GdkScreen where @status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen. Use #GNotification and #GtkApplication to @@ -140109,27 +99604,17 @@ then remapped on the new screen. - a #GtkStatusIcon + a #GtkStatusIcon - a #GdkScreen + a #GdkScreen - - Sets the title of this tray icon. + + Sets the title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. @@ -140142,27 +99627,17 @@ readers to render the tray icon. - a #GtkStatusIcon + a #GtkStatusIcon - the title + the title - - Sets @markup as the contents of the tooltip, which is marked up with + + Sets @markup as the contents of the tooltip, which is marked up with the [Pango text markup language][PangoMarkupFormat]. This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE @@ -140179,30 +99654,17 @@ gtk_tooltip_set_markup(). - a #GtkStatusIcon + a #GtkStatusIcon - - the contents of the tooltip for @status_icon, or %NULL + + the contents of the tooltip for @status_icon, or %NULL - - Sets @text as the contents of the tooltip. + + Sets @text as the contents of the tooltip. This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE and of the default handler for the #GtkStatusIcon::query-tooltip @@ -140219,27 +99681,17 @@ gtk_tooltip_set_text(). - a #GtkStatusIcon + a #GtkStatusIcon - the contents of the tooltip for @status_icon + the contents of the tooltip for @status_icon - - Shows or hides a status icon. + + Shows or hides a status icon. Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as notifications are managed by the platform @@ -140249,48 +99701,29 @@ gtk_tooltip_set_text(). - a #GtkStatusIcon + a #GtkStatusIcon - %TRUE to show the status icon, %FALSE to hide it + %TRUE to show the status icon, %FALSE to hide it - %TRUE if the statusicon is embedded in a notification area. + %TRUE if the statusicon is embedded in a notification area. - + - - The #GIcon displayed in the #GtkStatusIcon. For themed icons, + + The #GIcon displayed in the #GtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes. - - Enables or disables the emission of #GtkStatusIcon::query-tooltip on + + Enables or disables the emission of #GtkStatusIcon::query-tooltip on @status_icon. A value of %TRUE indicates that @status_icon can have a tooltip, in this case the status icon will be queried using #GtkStatusIcon::query-tooltip to determine whether it will provide a @@ -140309,9 +99742,7 @@ For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference. - The orientation of the tray in which the statusicon + The orientation of the tray in which the statusicon is embedded. @@ -140324,35 +99755,21 @@ is embedded. - + Use #GtkStatusIcon:icon-name instead. - - The title of this tray icon. This should be a short, human-readable, + + The title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. - - Sets the text of tooltip to be the given string, which is marked up + + Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup(). @@ -140365,13 +99782,8 @@ will take care of displaying the tooltip. On some platforms, embedded markup will be ignored. - - Sets the text of tooltip to be the given string. + + Sets the text of tooltip to be the given string. Also see gtk_tooltip_set_text(). @@ -140396,9 +99808,7 @@ that they allow on status icons, e.g. Windows only shows the first - Gets emitted when the user activates the status icon. + Gets emitted when the user activates the status icon. If and how status icons can activated is platform-dependent. Unlike most G_SIGNAL_ACTION signals, this signal is meant to @@ -140408,59 +99818,45 @@ be used by applications and should be wrapped by language bindings. - The ::button-press-event signal will be emitted when a button + The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed. Whether this event is emitted is platform-dependent. Use the ::activate and ::popup-menu signals in preference. - %TRUE to stop other handlers from being invoked + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventButton which triggered + the #GdkEventButton which triggered this signal - The ::button-release-event signal will be emitted when a button + The ::button-release-event signal will be emitted when a button (typically from a mouse) is released. Whether this event is emitted is platform-dependent. Use the ::activate and ::popup-menu signals in preference. - %TRUE to stop other handlers from being invoked + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventButton which triggered + the #GdkEventButton which triggered this signal - Gets emitted when the user brings up the context menu + Gets emitted when the user brings up the context menu of the status icon. Whether status icons can have context menus and how these are activated is platform-dependent. @@ -140474,25 +99870,19 @@ be used by applications and should be wrapped by language bindings. - the button that was pressed, or 0 if the + the button that was pressed, or 0 if the signal is not emitted in response to a button press event - the timestamp of the event that + the timestamp of the event that triggered the signal emission - Emitted when the hover timeout has expired with the + Emitted when the hover timeout has expired with the cursor hovering above @status_icon; or emitted when @status_icon got focus in keyboard mode. @@ -140508,98 +99898,73 @@ destined function calls. Whether this signal is emitted is platform-dependent. For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference. - %TRUE if @tooltip should be shown right now, %FALSE otherwise. + %TRUE if @tooltip should be shown right now, %FALSE otherwise. - the x coordinate of the cursor position where the request has been + the x coordinate of the cursor position where the request has been emitted, relative to @status_icon - the y coordinate of the cursor position where the request has been + the y coordinate of the cursor position where the request has been emitted, relative to @status_icon - %TRUE if the tooltip was trigged using the keyboard + %TRUE if the tooltip was trigged using the keyboard - a #GtkTooltip + a #GtkTooltip - The ::scroll-event signal is emitted when a button in the 4 to 7 + The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned. Whether this event is emitted is platform-dependent. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventScroll which triggered + the #GdkEventScroll which triggered this signal - Gets emitted when the size available for the image + Gets emitted when the size available for the image changes, e.g. because the notification area got resized. - %TRUE if the icon was updated for the new + %TRUE if the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary. - the new size + the new size - + - + @@ -140612,8 +99977,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140632,8 +99996,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140649,8 +100012,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140666,8 +100028,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140683,8 +100044,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140700,8 +100060,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140726,8 +100085,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140735,8 +100093,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140744,8 +100101,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + @@ -140753,38 +100109,27 @@ size. Otherwise, GTK+ will scale the icon as necessary. - + - + - - A #GtkStatusbar is usually placed along the bottom of an application's + + A #GtkStatusbar is usually placed along the bottom of an application's main #GtkWindow. It may provide a regular commentary of the application's status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example). Status bars in GTK+ maintain a stack of messages. The message at -the top of the each bar’s stack is the one that will currently be displayed. +the top of the each bar’s stack is the one that will currently be displayed. -Any messages added to a statusbar’s stack must specify a +Any messages added to a statusbar’s stack must specify a context id that is used to uniquely identify the source of a message. This context id can be generated by gtk_statusbar_get_context_id(), given a message and the statusbar that @@ -140798,7 +100143,7 @@ sub-stacks of the messages they produced (via context ids). Status bars are created using gtk_statusbar_new(). -Messages are added to the bar’s stack with gtk_statusbar_push(). +Messages are added to the bar’s stack with gtk_statusbar_push(). The message at the top of the stack can be removed using gtk_statusbar_pop(). A message can be removed from anywhere in the @@ -140813,14 +100158,10 @@ GtkStatusbar has a single CSS node with name statusbar. - Creates a new #GtkStatusbar ready for messages. + Creates a new #GtkStatusbar ready for messages. - the new #GtkStatusbar + the new #GtkStatusbar @@ -140858,62 +100199,43 @@ GtkStatusbar has a single CSS node with name statusbar. - - Returns a new context identifier, given a description + + Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI. - an integer id + an integer id - a #GtkStatusbar + a #GtkStatusbar - textual description of what context + textual description of what context the new message is being used in - - Retrieves the box containing the label widget. + + Retrieves the box containing the label widget. - a #GtkBox + a #GtkBox - a #GtkStatusbar + a #GtkStatusbar - Removes the first message in the #GtkStatusbar’s stack + Removes the first message in the #GtkStatusbar’s stack with the given context id. Note that this may not change the displayed message, if @@ -140925,57 +100247,41 @@ context id. - a #GtkStatusbar + a #GtkStatusbar - a context identifier + a context identifier - Pushes a new message onto a statusbar’s stack. + Pushes a new message onto a statusbar’s stack. - a message id that can be used with + a message id that can be used with gtk_statusbar_remove(). - a #GtkStatusbar + a #GtkStatusbar - the message’s context id, as returned by + the message’s context id, as returned by gtk_statusbar_get_context_id() - the message to add to the statusbar + the message to add to the statusbar - Forces the removal of a message from a statusbar’s stack. + Forces the removal of a message from a statusbar’s stack. The exact @context_id and @message_id must be specified. @@ -140983,31 +100289,21 @@ The exact @context_id and @message_id must be specified. - a #GtkStatusbar + a #GtkStatusbar - a context identifier + a context identifier - a message identifier, as returned by gtk_statusbar_push() + a message identifier, as returned by gtk_statusbar_push() - - Forces the removal of all messages from a statusbar's + + Forces the removal of all messages from a statusbar's stack with the exact @context_id. @@ -141015,15 +100311,11 @@ stack with the exact @context_id. - a #GtkStatusbar + a #GtkStatusbar - a context identifier + a context identifier @@ -141035,84 +100327,58 @@ stack with the exact @context_id. - Is emitted whenever a new message is popped off a statusbar's stack. + Is emitted whenever a new message is popped off a statusbar's stack. - the context id of the relevant message/statusbar + the context id of the relevant message/statusbar - the message that was just popped + the message that was just popped - Is emitted whenever a new message gets pushed onto a statusbar's stack. + Is emitted whenever a new message gets pushed onto a statusbar's stack. - the context id of the relevant message/statusbar + the context id of the relevant message/statusbar - the message that was pushed + the message that was pushed - + - + - + - + - + - + @@ -141194,72 +100460,44 @@ stack with the exact @context_id. - + - Identifier. + Identifier. - User visible label. + User visible label. - Modifier type for keyboard accelerator + Modifier type for keyboard accelerator - Keyboard accelerator + Keyboard accelerator - Translation domain of the menu or toolbar item + Translation domain of the menu or toolbar item - - Copies a stock item, mostly useful for language bindings and not in applications. + + Copies a stock item, mostly useful for language bindings and not in applications. - a new #GtkStockItem + a new #GtkStockItem - a #GtkStockItem + a #GtkStockItem - - Frees a stock item allocated on the heap, such as one returned by + + Frees a stock item allocated on the heap, such as one returned by gtk_stock_item_copy(). Also frees the fields inside the stock item, if they are not %NULL. @@ -141268,24 +100506,14 @@ if they are not %NULL. - a #GtkStockItem + a #GtkStockItem - - A #GtkStyle object encapsulates the information that provides the look and + + A #GtkStyle object encapsulates the information that provides the look and feel for a widget. > In GTK+ 3.0, GtkStyle has been deprecated and replaced by @@ -141302,19 +100530,12 @@ is set by GTK+ and modified the theme engine. Usually applications should not need to use or modify the #GtkStyle of their widgets. - - Creates a new #GtkStyle. + + Creates a new #GtkStyle. Use #GtkStyleContext - a new #GtkStyle. + a new #GtkStyle. @@ -142137,84 +101358,52 @@ their widgets. - - Renders the icon specified by @source at the given @size + + Renders the icon specified by @source at the given @size according to the given parameters and returns the result in a pixbuf. Use gtk_render_icon_pixbuf() instead - a newly-created #GdkPixbuf + a newly-created #GdkPixbuf containing the rendered icon - a #GtkStyle + a #GtkStyle - the #GtkIconSource specifying the icon to render + the #GtkIconSource specifying the icon to render - a text direction + a text direction - a state + a state - the size to render the icon at (#GtkIconSize). A size of + the size to render the icon at (#GtkIconSize). A size of `(GtkIconSize)-1` means render at the size of the source and - don’t scale. - + don’t scale. + - - the widget + + the widget - - a style detail + + a style detail - - Sets the background of @window to the background color or pixmap + + Sets the background of @window to the background color or pixmap specified by @style for the given state. Use gtk_style_context_set_background() instead @@ -142223,21 +101412,15 @@ specified by @style for the given state. - a #GtkStyle + a #GtkStyle - a #GdkWindow + a #GdkWindow - a state + a state @@ -142253,10 +101436,7 @@ specified by @style for the given state. - + Use #GtkStyleContext instead @@ -142289,15 +101469,9 @@ specified by @style for the given state. - - Attaches a style to a window; this process allocates the -colors and creates the GC’s for the style - it specializes + + Attaches a style to a window; this process allocates the +colors and creates the GC’s for the style - it specializes it to a particular visual. The process may involve the creation of a new style if the style has already been attached to a window with a different style and visual. @@ -142308,9 +101482,7 @@ in the following way: Use gtk_widget_style_attach() instead - Either @style, or a newly-created #GtkStyle. + Either @style, or a newly-created #GtkStyle. If the style is newly created, the style parameter will be unref'ed, and the new style will have a reference count belonging to the caller. @@ -142318,50 +101490,32 @@ in the following way: - a #GtkStyle. + a #GtkStyle. - a #GdkWindow. + a #GdkWindow. - - Creates a copy of the passed in #GtkStyle object. + + Creates a copy of the passed in #GtkStyle object. Use #GtkStyleContext instead - a copy of @style + a copy of @style - a #GtkStyle + a #GtkStyle - - Detaches a style from a window. If the style is not attached + + Detaches a style from a window. If the style is not attached to any windows anymore, it is unrealized. See gtk_style_attach(). Use #GtkStyleContext instead @@ -142370,20 +101524,13 @@ to any windows anymore, it is unrealized. See gtk_style_attach(). - a #GtkStyle + a #GtkStyle - - Gets the values of a multiple style properties for @widget_type + + Gets the values of a multiple style properties for @widget_type from @style. @@ -142391,39 +101538,27 @@ from @style. - a #GtkStyle + a #GtkStyle - the #GType of a descendant of #GtkWidget + the #GType of a descendant of #GtkWidget - the name of the first style property to get + the name of the first style property to get - pairs of property names and locations to + pairs of property names and locations to return the property values, starting with the location for @first_property_name, terminated by %NULL. - - Queries the value of a style property corresponding to a + + Queries the value of a style property corresponding to a widget class is in the given style. @@ -142431,42 +101566,26 @@ widget class is in the given style. - a #GtkStyle + a #GtkStyle - the #GType of a descendant of #GtkWidget + the #GType of a descendant of #GtkWidget - the name of the style property to get + the name of the style property to get - - a #GValue where the value of the property being + + a #GValue where the value of the property being queried will be stored - - Non-vararg variant of gtk_style_get(). + + Non-vararg variant of gtk_style_get(). Used primarily by language bindings. @@ -142474,63 +101593,41 @@ Used primarily by language bindings. - a #GtkStyle + a #GtkStyle - the #GType of a descendant of #GtkWidget + the #GType of a descendant of #GtkWidget - the name of the first style property to get + the name of the first style property to get - a va_list of pairs of property names and + a va_list of pairs of property names and locations to return the property values, starting with the location for @first_property_name. - - Returns whether @style has an associated #GtkStyleContext. + + Returns whether @style has an associated #GtkStyleContext. - %TRUE if @style has a #GtkStyleContext + %TRUE if @style has a #GtkStyleContext - a #GtkStyle + a #GtkStyle - - Looks up @color_name in the style’s logical color mappings, + + Looks up @color_name in the style’s logical color mappings, filling in @color and returning %TRUE if found, otherwise returning %FALSE. Do not cache the found mapping, because it depends on the #GtkStyle and might change when a theme @@ -142538,145 +101635,91 @@ switch occurs. Use gtk_style_context_lookup_color() instead - %TRUE if the mapping was found. + %TRUE if the mapping was found. - a #GtkStyle + a #GtkStyle - the name of the logical color to look up + the name of the logical color to look up - - the #GdkColor to fill in + + the #GdkColor to fill in - - Looks up @stock_id in the icon factories associated with @style + + Looks up @stock_id in the icon factories associated with @style and the default icon factory, returning an icon set if found, otherwise %NULL. Use gtk_style_context_lookup_icon_set() instead - icon set of @stock_id + icon set of @stock_id - a #GtkStyle + a #GtkStyle - an icon name + an icon name - - Renders the icon specified by @source at the given @size + + Renders the icon specified by @source at the given @size according to the given parameters and returns the result in a pixbuf. Use gtk_render_icon_pixbuf() instead - a newly-created #GdkPixbuf + a newly-created #GdkPixbuf containing the rendered icon - a #GtkStyle + a #GtkStyle - the #GtkIconSource specifying the icon to render + the #GtkIconSource specifying the icon to render - a text direction + a text direction - a state + a state - the size to render the icon at (#GtkIconSize). A size of + the size to render the icon at (#GtkIconSize). A size of `(GtkIconSize)-1` means render at the size of the source and - don’t scale. - + don’t scale. + - - the widget + + the widget - - a style detail + + a style detail - - Sets the background of @window to the background color or pixmap + + Sets the background of @window to the background color or pixmap specified by @style for the given state. Use gtk_style_context_set_background() instead @@ -142685,132 +101728,95 @@ specified by @style for the given state. - a #GtkStyle + a #GtkStyle - a #GdkWindow + a #GdkWindow - a state + a state - + - Set of foreground #GdkColor + Set of foreground #GdkColor - Set of background #GdkColor + Set of background #GdkColor - Set of light #GdkColor + Set of light #GdkColor - Set of dark #GdkColor + Set of dark #GdkColor - Set of mid #GdkColor + Set of mid #GdkColor - Set of text #GdkColor + Set of text #GdkColor - Set of base #GdkColor + Set of base #GdkColor - Color halfway between text/base + Color halfway between text/base - #GdkColor to use for black + #GdkColor to use for black - #GdkColor to use for white + #GdkColor to use for white - #PangoFontDescription + #PangoFontDescription - Thickness in X direction + Thickness in X direction - Thickness in Y direction + Thickness in Y direction - Set of background #cairo_pattern_t + Set of background #cairo_pattern_t @@ -142843,9 +101849,7 @@ specified by @style for the given state. - Emitted when the style has been initialized for a particular + Emitted when the style has been initialized for a particular visual. Connecting to this signal is probably seldom useful since most of the time applications and widgets only deal with styles that have been already realized. @@ -142854,9 +101858,7 @@ deal with styles that have been already realized. - Emitted when the aspects of the style specific to a particular visual + Emitted when the aspects of the style specific to a particular visual is being cleaned up. A connection to this signal can be useful if a widget wants to cache objects as object data on #GtkStyle. This signal provides a convenient place to free such cached objects. @@ -142865,14 +101867,10 @@ This signal provides a convenient place to free such cached objects. - + - The parent class. + The parent class. @@ -142954,21 +101952,15 @@ This signal provides a convenient place to free such cached objects. - a #GtkStyle + a #GtkStyle - a #GdkWindow + a #GdkWindow - a state + a state @@ -142978,61 +101970,39 @@ This signal provides a convenient place to free such cached objects. - a newly-created #GdkPixbuf + a newly-created #GdkPixbuf containing the rendered icon - a #GtkStyle + a #GtkStyle - the #GtkIconSource specifying the icon to render + the #GtkIconSource specifying the icon to render - a text direction + a text direction - a state + a state - the size to render the icon at (#GtkIconSize). A size of + the size to render the icon at (#GtkIconSize). A size of `(GtkIconSize)-1` means render at the size of the source and - don’t scale. - + don’t scale. + - - the widget + + the widget - - a style detail + + a style detail @@ -143936,16 +102906,8 @@ This signal provides a convenient place to free such cached objects. - - #GtkStyleContext is an object that stores styling information affecting + + #GtkStyleContext is an object that stores styling information affecting a widget defined by #GtkWidgetPath. In order to construct the final style information, #GtkStyleContext @@ -143953,7 +102915,7 @@ queries information from all attached #GtkStyleProviders. Style providers can be either attached explicitly to the context through gtk_style_context_add_provider(), or to the screen through gtk_style_context_add_provider_for_screen(). The resulting style is a -combination of all providers’ information in priority order. +combination of all providers’ information in priority order. For GTK+ widgets, any #GtkStyleContext returned by gtk_widget_get_style_context() will already have a #GtkWidgetPath, a @@ -143963,7 +102925,7 @@ updated automatically if any of these settings change on the widget. If you are using the theming layer standalone, you will need to set a widget path and a screen yourself to the created style context through gtk_style_context_set_path() and possibly gtk_style_context_set_screen(). See -the “Foreign drawing“ example in gtk3-demo. +the “Foreign drawing“ example in gtk3-demo. # Style Classes # {#gtkstylecontext-classes} @@ -143992,7 +102954,7 @@ priority, either a #GtkCssProvider or a custom object implementing the to style your UI elements in a different way if needed so. If you are using custom styling on an applications, you probably want then -to make your style information prevail to the theme’s, so you must use +to make your style information prevail to the theme’s, so you must use a #GtkStyleProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION priority, keep in mind that the user settings in `XDG_CONFIG_HOME/gtk-3.0/gtk.css` will @@ -144000,10 +102962,8 @@ still take precedence over your changes, as it uses the %GTK_STYLE_PROVIDER_PRIORITY_USER priority. - Creates a standalone #GtkStyleContext, this style context -won’t be attached to any widget, so you may want + Creates a standalone #GtkStyleContext, this style context +won’t be attached to any widget, so you may want to call gtk_style_context_set_path() yourself. This function is only useful when using the theming layer @@ -144012,18 +102972,12 @@ theme #GtkWidgets, use gtk_widget_get_style_context() in order to get a style context ready to theme the widget. - A newly created #GtkStyleContext. + A newly created #GtkStyleContext. - - Adds a global style provider to @screen, which will be used + + Adds a global style provider to @screen, which will be used in style construction for all #GtkStyleContexts under @screen. GTK+ uses this to make styling information from #GtkSettings @@ -144038,21 +102992,15 @@ over another added through this function. - a #GdkScreen + a #GdkScreen - a #GtkStyleProvider + a #GtkStyleProvider - the priority of the style provider. The lower + the priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and @@ -144061,37 +103009,25 @@ over another added through this function. - - Removes @provider from the global style providers list in @screen. + + Removes @provider from the global style providers list in @screen. - a #GdkScreen + a #GdkScreen - a #GtkStyleProvider + a #GtkStyleProvider - - This function recomputes the styles for all widgets under a particular + + This function recomputes the styles for all widgets under a particular #GdkScreen. This is useful when some global parameter has changed that affects the appearance of all widgets, because when a widget gets a new style, it will both redraw and recompute any cached information about @@ -144103,9 +103039,7 @@ in the related #GtkSettings object. - a #GdkScreen + a #GdkScreen @@ -144121,23 +103055,19 @@ in the related #GtkSettings object. - - Adds a style class to @context, so posterior calls to + + Adds a style class to @context, so posterior calls to gtk_style_context_get() or any of the gtk_render_*() functions will make use of this new class for styling. -In the CSS file format, a #GtkEntry defining a “search” +In the CSS file format, a #GtkEntry defining a “search” class, would be matched by: |[ <!-- language="CSS" --> entry.search { ... } ]| -While any widget defining a “search” class would be +While any widget defining a “search” class would be matched by: |[ <!-- language="CSS" --> .search { ... } @@ -144148,25 +103078,17 @@ matched by: - a #GtkStyleContext + a #GtkStyleContext - class name to use in styling + class name to use in styling - - Adds a style provider to @context, to be used in style construction. + + Adds a style provider to @context, to be used in style construction. Note that a style provider added by this function only affects the style of the widget to which @context belongs. If you want to affect the style of all widgets, use @@ -144181,21 +103103,15 @@ through gtk_style_context_add_provider_for_screen(). - a #GtkStyleContext + a #GtkStyleContext - a #GtkStyleProvider + a #GtkStyleProvider - the priority of the style provider. The lower + the priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and @@ -144204,18 +103120,12 @@ through gtk_style_context_add_provider_for_screen(). - - Adds a region to @context, so posterior calls to + + Adds a region to @context, so posterior calls to gtk_style_context_get() or any of the gtk_render_*() functions will make use of this new region for styling. -In the CSS file format, a #GtkTreeView defining a “row” +In the CSS file format, a #GtkTreeView defining a “row” region, would be matched by: |[ <!-- language="CSS" --> @@ -144232,40 +103142,28 @@ treeview row:nth-child(odd) { ... } would apply to even and odd rows, respectively. Region names must only contain lowercase letters -and “-”, starting always with a lowercase letter. +and “-”, starting always with a lowercase letter. - a #GtkStyleContext + a #GtkStyleContext - region name to use in styling + region name to use in styling - flags that apply to the region + flags that apply to the region - - Stops all running animations for @region_id and all animatable + + Stops all running animations for @region_id and all animatable regions underneath. A %NULL @region_id will stop all ongoing animations in @context, @@ -144281,30 +103179,18 @@ animatable regions. - a #GtkStyleContext + a #GtkStyleContext - - animatable region to stop, or %NULL. + + animatable region to stop, or %NULL. See gtk_style_context_push_animatable_region() - - Retrieves several style property values from @context for a + + Retrieves several style property values from @context for a given state. See gtk_style_context_get_property() for details. @@ -144314,33 +103200,21 @@ See gtk_style_context_get_property() for details. - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the property values for + state to retrieve the property values for - property name /return value pairs, followed by %NULL + property name /return value pairs, followed by %NULL - - Gets the background color for a given state. + + Gets the background color for a given state. This function is far less useful than it seems, and it should not be used in newly written code. CSS has no concept of "background color", as a background @@ -144357,34 +103231,21 @@ style classes to modify the color to be rendered. - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the color for + state to retrieve the color for - - return value for the background color + + return value for the background color - - Gets the border for a given state as a #GtkBorder. + + Gets the border for a given state as a #GtkBorder. See gtk_style_context_get_property() and #GTK_STYLE_PROPERTY_BORDER_WIDTH for details. @@ -144394,36 +103255,21 @@ See gtk_style_context_get_property() and - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the border for + state to retrieve the border for - - return value for the border settings + + return value for the border settings - - Gets the border color for a given state. + + Gets the border color for a given state. Use gtk_render_frame() instead. @@ -144431,34 +103277,21 @@ See gtk_style_context_get_property() and - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the color for + state to retrieve the color for - - return value for the border color + + return value for the border color - - Gets the foreground color for a given state. + + Gets the foreground color for a given state. See gtk_style_context_get_property() and #GTK_STYLE_PROPERTY_COLOR for details. @@ -144468,143 +103301,91 @@ See gtk_style_context_get_property() and - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the color for + state to retrieve the color for - - return value for the foreground color + + return value for the foreground color - - Returns the widget direction used for rendering. + + Returns the widget direction used for rendering. Use gtk_style_context_get_state() and check for #GTK_STATE_FLAG_DIR_LTR and #GTK_STATE_FLAG_DIR_RTL instead. - the widget direction + the widget direction - a #GtkStyleContext + a #GtkStyleContext - - Returns the font description for a given state. The returned + + Returns the font description for a given state. The returned object is const and will remain valid until the #GtkStyleContext::changed signal happens. Use gtk_style_context_get() for "font" or subproperties instead. - the #PangoFontDescription for the given + the #PangoFontDescription for the given state. This object is owned by GTK+ and should not be freed. - + - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the font for + state to retrieve the font for - - Returns the #GdkFrameClock to which @context is attached. + + Returns the #GdkFrameClock to which @context is attached. - a #GdkFrameClock, or %NULL + a #GdkFrameClock, or %NULL if @context does not have an attached frame clock. - a #GtkStyleContext + a #GtkStyleContext - - Returns the sides where rendered elements connect visually with others. + + Returns the sides where rendered elements connect visually with others. - the junction sides + the junction sides - a #GtkStyleContext + a #GtkStyleContext - - Gets the margin for a given state as a #GtkBorder. + + Gets the margin for a given state as a #GtkBorder. See gtk_style_property_get() and #GTK_STYLE_PROPERTY_MARGIN for details. @@ -144613,34 +103394,21 @@ for details. - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the border for + state to retrieve the border for - - return value for the margin settings + + return value for the margin settings - - Gets the padding for a given state as a #GtkBorder. + + Gets the padding for a given state as a #GtkBorder. See gtk_style_context_get() and #GTK_STYLE_PROPERTY_PADDING for details. @@ -144649,79 +103417,50 @@ for details. - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the padding for + state to retrieve the padding for - - return value for the padding settings + + return value for the padding settings - - Gets the parent context set via gtk_style_context_set_parent(). + + Gets the parent context set via gtk_style_context_set_parent(). See that function for details. - the parent context or %NULL + the parent context or %NULL - a #GtkStyleContext + a #GtkStyleContext - - Returns the widget path used for style matching. + + Returns the widget path used for style matching. - A #GtkWidgetPath + A #GtkWidgetPath - a #GtkStyleContext + a #GtkStyleContext - - Gets a style property from @context for the given state. + + Gets a style property from @context for the given state. Note that not all CSS properties that are supported by GTK+ can be retrieved in this way, since they may not be representable as #GValue. @@ -144740,80 +103479,53 @@ to free any allocated memory. - a #GtkStyleContext + a #GtkStyleContext - style property name + style property name - state to retrieve the property value for + state to retrieve the property value for - - return location for the style property value + + return location for the style property value - - Returns the scale used for assets. + + Returns the scale used for assets. - the scale + the scale - a #GtkStyleContext + a #GtkStyleContext - Returns the #GdkScreen to which @context is attached. + Returns the #GdkScreen to which @context is attached. - a #GdkScreen. + a #GdkScreen. - a #GtkStyleContext + a #GtkStyleContext - Queries the location in the CSS where @property was defined for the + Queries the location in the CSS where @property was defined for the current @context. Note that the state to be queried is taken from gtk_style_context_get_state(). @@ -144827,33 +103539,23 @@ Shorthand CSS properties cannot be queried for a location and will always return %NULL. - %NULL or the section where a value + %NULL or the section where a value for @property was defined - a #GtkStyleContext + a #GtkStyleContext - style property name + style property name - - Returns the state used for style matching. + + Returns the state used for style matching. This method should only be used to retrieve the #GtkStateFlags to pass to #GtkStyleContext methods, like gtk_style_context_get_padding(). @@ -144861,27 +103563,18 @@ If you need to retrieve the current state of a #GtkWidget, use gtk_widget_get_state_flags(). - the state flags + the state flags - a #GtkStyleContext + a #GtkStyleContext - - Retrieves several widget style properties from @context according to the + + Retrieves several widget style properties from @context according to the current style. @@ -144889,24 +103582,17 @@ current style. - a #GtkStyleContext + a #GtkStyleContext - property name /return value pairs, followed by %NULL + property name /return value pairs, followed by %NULL - - Gets the value for a widget style property. + + Gets the value for a widget style property. When @value is no longer needed, g_value_unset() must be called to free any allocated memory. @@ -144916,32 +103602,21 @@ to free any allocated memory. - a #GtkStyleContext + a #GtkStyleContext - the name of the widget style property + the name of the widget style property - - Return location for the property value + + Return location for the property value - - Retrieves several widget style properties from @context according to the + + Retrieves several widget style properties from @context according to the current style. @@ -144949,26 +103624,17 @@ current style. - a #GtkStyleContext + a #GtkStyleContext - va_list of property name/return location pairs, followed by %NULL + va_list of property name/return location pairs, followed by %NULL - - Retrieves several style property values from @context for a given state. + + Retrieves several style property values from @context for a given state. See gtk_style_context_get_property() for details. @@ -144977,105 +103643,64 @@ See gtk_style_context_get_property() for details. - a #GtkStyleContext + a #GtkStyleContext - state to retrieve the property values for + state to retrieve the property values for - va_list of property name/return location pairs, followed by %NULL + va_list of property name/return location pairs, followed by %NULL - - Returns %TRUE if @context currently has defined the + + Returns %TRUE if @context currently has defined the given class name. - %TRUE if @context has @class_name defined + %TRUE if @context has @class_name defined - a #GtkStyleContext + a #GtkStyleContext - a class name + a class name - - Returns %TRUE if @context has the region defined. + + Returns %TRUE if @context has the region defined. If @flags_return is not %NULL, it is set to the flags affecting the region. - %TRUE if region is defined + %TRUE if region is defined - a #GtkStyleContext + a #GtkStyleContext - a region name + a region name - - return location for region flags + + return location for region flags - - Invalidates @context style information, so it will be reconstructed + + Invalidates @context style information, so it will be reconstructed again. It is useful if you modify the @context and need the new information immediately. Style contexts are invalidated automatically. @@ -145085,24 +103710,16 @@ information immediately. - a #GtkStyleContext. + a #GtkStyleContext. - - Returns the list of classes currently defined in @context. + + Returns the list of classes currently defined in @context. - a #GList of + a #GList of strings with the currently defined classes. The contents of the list are owned by GTK+, but you must free the list itself with g_list_free() when you are done with it. @@ -145112,26 +103729,16 @@ information immediately. - a #GtkStyleContext + a #GtkStyleContext - - Returns the list of regions currently defined in @context. + + Returns the list of regions currently defined in @context. - a #GList of + a #GList of strings with the currently defined regions. The contents of the list are owned by GTK+, but you must free the list itself with g_list_free() when you are done with it. @@ -145141,89 +103748,56 @@ information immediately. - a #GtkStyleContext + a #GtkStyleContext - - Looks up and resolves a color name in the @context color map. + + Looks up and resolves a color name in the @context color map. - %TRUE if @color_name was found and resolved, %FALSE otherwise + %TRUE if @color_name was found and resolved, %FALSE otherwise - a #GtkStyleContext + a #GtkStyleContext - color name to lookup + color name to lookup - - Return location for the looked up color + + Return location for the looked up color - - Looks up @stock_id in the icon factories associated to @context and + + Looks up @stock_id in the icon factories associated to @context and the default icon factory, returning an icon set if found, otherwise %NULL. Use gtk_icon_theme_lookup_icon() instead. - The looked up %GtkIconSet, or %NULL + The looked up %GtkIconSet, or %NULL - a #GtkStyleContext + a #GtkStyleContext - an icon name + an icon name - - Notifies a state change on @context, so if the current style makes use + + Notifies a state change on @context, so if the current style makes use of transition animations, one will be started so all rendered elements under @region_id are animated for state @state being set to value @state_value. @@ -145270,50 +103844,31 @@ is why the style places the transition under the :hover pseudo-class. - a #GtkStyleContext + a #GtkStyleContext - a #GdkWindow + a #GdkWindow - - animatable region to notify on, or %NULL. + + animatable region to notify on, or %NULL. See gtk_style_context_push_animatable_region() - state to trigger transition for + state to trigger transition for - %TRUE if @state is the state we are changing to, + %TRUE if @state is the state we are changing to, %FALSE if we are changing away from it - - Pops an animatable region from @context. + + Pops an animatable region from @context. See gtk_style_context_push_animatable_region(). This function does nothing. @@ -145322,21 +103877,13 @@ See gtk_style_context_push_animatable_region(). - a #GtkStyleContext + a #GtkStyleContext - - Pushes an animatable region, so all further gtk_render_*() calls between + + Pushes an animatable region, so all further gtk_render_*() calls between this call and the following gtk_style_context_pop_animatable_region() will potentially show transition animations for this region if gtk_style_context_notify_state_change() is called for a given state, @@ -145352,105 +103899,68 @@ can uniquely identify rendered elements subject to a state transition. - a #GtkStyleContext + a #GtkStyleContext - - unique identifier for the animatable region + + unique identifier for the animatable region - - Removes @class_name from @context. + + Removes @class_name from @context. - a #GtkStyleContext + a #GtkStyleContext - class name to remove + class name to remove - - Removes @provider from the style providers list in @context. + + Removes @provider from the style providers list in @context. - a #GtkStyleContext + a #GtkStyleContext - a #GtkStyleProvider + a #GtkStyleProvider - - Removes a region from @context. + + Removes a region from @context. - a #GtkStyleContext + a #GtkStyleContext - region name to unset + region name to unset - - Restores @context state to a previous stage. + + Restores @context state to a previous stage. See gtk_style_context_save(). @@ -145458,17 +103968,13 @@ See gtk_style_context_save(). - a #GtkStyleContext + a #GtkStyleContext - Saves the @context state, so temporary modifications done through + Saves the @context state, so temporary modifications done through gtk_style_context_add_class(), gtk_style_context_remove_class(), gtk_style_context_set_state(), etc. can quickly be reverted in one go through gtk_style_context_restore(). @@ -145481,21 +103987,13 @@ before GTK returns to the main loop. - a #GtkStyleContext + a #GtkStyleContext - - This function is analogous to gdk_window_scroll(), and + + This function is analogous to gdk_window_scroll(), and should be called together with it so the invalidation areas for any ongoing animation are scrolled together with it. @@ -145506,40 +104004,26 @@ with it. - a #GtkStyleContext + a #GtkStyleContext - a #GdkWindow used previously in + a #GdkWindow used previously in gtk_style_context_notify_state_change() - Amount to scroll in the X axis + Amount to scroll in the X axis - Amount to scroll in the Y axis + Amount to scroll in the Y axis - - Sets the background of @window to the background pattern or + + Sets the background of @window to the background pattern or color specified in @context for its current state. Use gtk_render_background() instead. Note that clients still using this function are now responsible @@ -145550,27 +104034,17 @@ color specified in @context for its current state. - a #GtkStyleContext + a #GtkStyleContext - a #GdkWindow + a #GdkWindow - - Sets the reading direction for rendering purposes. + + Sets the reading direction for rendering purposes. If you are using a #GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to @@ -145584,25 +104058,17 @@ call this yourself. - a #GtkStyleContext + a #GtkStyleContext - the new direction. + the new direction. - - Attaches @context to the given frame clock. + + Attaches @context to the given frame clock. The frame clock is used for the timing of animations. @@ -145615,25 +104081,17 @@ call this yourself. - a #GdkFrameClock + a #GdkFrameClock - a #GdkFrameClock + a #GdkFrameClock - - Sets the sides where rendered elements (mostly through + + Sets the sides where rendered elements (mostly through gtk_render_frame()) will visually connect with other visual elements. This is merely a hint that may or may not be honored @@ -145648,26 +104106,18 @@ this function manually. - a #GtkStyleContext + a #GtkStyleContext - sides where rendered elements are visually connected to + sides where rendered elements are visually connected to other elements - - Sets the parent style context for @context. The parent style + + Sets the parent style context for @context. The parent style context is used to implement [inheritance](http://www.w3.org/TR/css3-cascade/#inheritance) of properties. @@ -145680,28 +104130,17 @@ gtk_widget_get_style_context(), the parent will be set for you. - a #GtkStyleContext + a #GtkStyleContext - - the new parent or %NULL + + the new parent or %NULL - - Sets the #GtkWidgetPath used for style matching. As a + + Sets the #GtkWidgetPath used for style matching. As a consequence, the style will be regenerated to match the new given path. @@ -145714,53 +104153,37 @@ this yourself. - a #GtkStyleContext + a #GtkStyleContext - a #GtkWidgetPath + a #GtkWidgetPath - - Sets the scale to use when getting image assets for the style. + + Sets the scale to use when getting image assets for the style. - a #GtkStyleContext + a #GtkStyleContext - scale + scale - - Attaches @context to the given screen. + + Attaches @context to the given screen. -The screen is used to add style information from “global” style -providers, such as the screen’s #GtkSettings instance. +The screen is used to add style information from “global” style +providers, such as the screen’s #GtkSettings instance. If you are using a #GtkStyleContext returned from gtk_widget_get_style_context(), you do not need to @@ -145771,97 +104194,64 @@ call this yourself. - a #GtkStyleContext + a #GtkStyleContext - a #GdkScreen + a #GdkScreen - - Sets the state to be used for style matching. + + Sets the state to be used for style matching. - a #GtkStyleContext + a #GtkStyleContext - state to represent + state to represent - - Returns %TRUE if there is a transition animation running for the + + Returns %TRUE if there is a transition animation running for the current region (see gtk_style_context_push_animatable_region()). If @progress is not %NULL, the animation progress will be returned there, 0.0 means the state is closest to being unset, while 1.0 means -it’s closest to being set. This means transition animation will +it’s closest to being set. This means transition animation will run from 0 to 1 when @state is being set and from 1 to 0 when -it’s being unset. +it’s being unset. This function always returns %FALSE - %TRUE if there is a running transition animation for @state. + %TRUE if there is a running transition animation for @state. - a #GtkStyleContext + a #GtkStyleContext - a widget state + a widget state - - return location for the transition progress + + return location for the transition progress - - Converts the style context into a string representation. + + Converts the style context into a string representation. The string representation always includes information about the name, state, id, visibility and style classes of the CSS @@ -145873,24 +104263,17 @@ CSS implementation in GTK+. There are no guarantees about the format of the returned string, it may change. - a newly allocated string representing @context + a newly allocated string representing @context - a #GtkStyleContext + a #GtkStyleContext - Flags that determine what to print - + Flags that determine what to print + @@ -145900,13 +104283,8 @@ the format of the returned string, it may change. - - Sets or gets the style context’s parent. See gtk_style_context_set_parent() + + Sets or gets the style context’s parent. See gtk_style_context_set_parent() for details. @@ -145920,9 +104298,7 @@ for details. - The ::changed signal is emitted when there is a change in the + The ::changed signal is emitted when there is a change in the #GtkStyleContext. For a #GtkStyleContext returned by gtk_widget_get_style_context(), the @@ -145934,9 +104310,7 @@ This signal is useful when using the theming layer standalone. - + @@ -145987,53 +104361,25 @@ This signal is useful when using the theming layer standalone. - - Flags that modify the behavior of gtk_style_context_to_string(). + + Flags that modify the behavior of gtk_style_context_to_string(). New values may be added to this enumeration. - + - - Print the entire tree of + + Print the entire tree of CSS nodes starting at the style context's node - - Show the values of the + + Show the values of the CSS properties for each node - + - - GtkStyleProperties provides the storage for style information + + GtkStyleProperties provides the storage for style information that is used by #GtkStyleContext and other #GtkStyleProvider implementations. @@ -146049,504 +104395,307 @@ should use the APIs provided by #GtkThemingEngine instead. #GtkStyleProperties has been deprecated in GTK 3.16. The CSS machinery does not use it anymore and all users of this object have been deprecated. - + - - Returns a newly created #GtkStyleProperties + + Returns a newly created #GtkStyleProperties #GtkStyleProperties are deprecated. - + - a new #GtkStyleProperties + a new #GtkStyleProperties - - Returns %TRUE if a property has been registered, if @pspec or + + Returns %TRUE if a property has been registered, if @pspec or @parse_func are not %NULL, the #GParamSpec and parsing function will be respectively returned. This code could only look up custom properties and those are deprecated. - + - %TRUE if the property is registered, %FALSE otherwise + %TRUE if the property is registered, %FALSE otherwise - property name to look up + property name to look up - - return location for the parse function + + return location for the parse function - - return location for the #GParamSpec + + return location for the #GParamSpec - - Registers a property so it can be used in the CSS file format. + + Registers a property so it can be used in the CSS file format. This function is the low-level equivalent of gtk_theming_engine_register_property(), if you are implementing a theming engine, you want to use that function instead. Code should use the default properties provided by CSS. - + - - parsing function to use, or %NULL + + parsing function to use, or %NULL - the #GParamSpec for the new property + the #GParamSpec for the new property - - Clears all style information from @props. + + Clears all style information from @props. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - - Retrieves several style property values from @props for a + + Retrieves several style property values from @props for a given state. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - state to retrieve the property values for + state to retrieve the property values for - property name /return value pairs, followed by %NULL + property name /return value pairs, followed by %NULL - - Gets a style property from @props for the given state. When done with @value, + + Gets a style property from @props for the given state. When done with @value, g_value_unset() needs to be called to free any allocated memory. #GtkStyleProperties are deprecated. - + - %TRUE if the property exists in @props, %FALSE otherwise + %TRUE if the property exists in @props, %FALSE otherwise - a #GtkStyleProperties + a #GtkStyleProperties - style property name + style property name - state to retrieve the property value for + state to retrieve the property value for - - return location for the style property value. + + return location for the style property value. - - Retrieves several style property values from @props for a given state. + + Retrieves several style property values from @props for a given state. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - state to retrieve the property values for + state to retrieve the property values for - va_list of property name/return location pairs, followed by %NULL + va_list of property name/return location pairs, followed by %NULL - - Returns the symbolic color that is mapped + + Returns the symbolic color that is mapped to @name. #GtkSymbolicColor is deprecated. - + - The mapped color + The mapped color - a #GtkStyleProperties + a #GtkStyleProperties - color name to lookup + color name to lookup - - Maps @color so it can be referenced by @name. See + + Maps @color so it can be referenced by @name. See gtk_style_properties_lookup_color() #GtkSymbolicColor is deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - color name + color name - #GtkSymbolicColor to map @name to + #GtkSymbolicColor to map @name to - - Merges into @props all the style information contained + + Merges into @props all the style information contained in @props_to_merge. If @replace is %TRUE, the values will be overwritten, if it is %FALSE, the older values will prevail. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - a second #GtkStyleProperties + a second #GtkStyleProperties - whether to replace values or not + whether to replace values or not - - Sets several style properties on @props. + + Sets several style properties on @props. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - state to set the values for + state to set the values for - property name/value pairs, followed by %NULL + property name/value pairs, followed by %NULL - - Sets a styling property in @props. + + Sets a styling property in @props. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - styling property to set + styling property to set - state to set the value for + state to set the value for - new value for the property + new value for the property - - Sets several style properties on @props. + + Sets several style properties on @props. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - state to set the values for + state to set the values for - va_list of property name/value pairs, followed by %NULL + va_list of property name/value pairs, followed by %NULL - - Unsets a style property in @props. + + Unsets a style property in @props. #GtkStyleProperties are deprecated. - + - a #GtkStyleProperties + a #GtkStyleProperties - property to unset + property to unset - state to unset + state to unset @@ -146555,22 +104704,17 @@ will prevail. - + - - + + - + @@ -146578,8 +104722,7 @@ will prevail. - + @@ -146587,8 +104730,7 @@ will prevail. - + @@ -146596,25 +104738,18 @@ will prevail. - + - - + + - - + + @@ -146627,253 +104762,158 @@ will prevail. - - GtkStyleProvider is an interface used to provide style information to a #GtkStyleContext. + + GtkStyleProvider is an interface used to provide style information to a #GtkStyleContext. See gtk_style_context_add_provider() and gtk_style_context_add_provider_for_screen(). - - Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none + + Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none is defined. Will always return %NULL for all GTK-provided style providers. - The icon factory to use for @path, or %NULL + The icon factory to use for @path, or %NULL - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - - Returns the style settings affecting a widget defined by @path, or %NULL if -@provider doesn’t contemplate styling @path. + + Returns the style settings affecting a widget defined by @path, or %NULL if +@provider doesn’t contemplate styling @path. Will always return %NULL for all GTK-provided style providers as the interface cannot correctly work the way CSS is specified. - a #GtkStyleProperties containing the + a #GtkStyleProperties containing the style settings affecting @path - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - - Looks up a widget style property as defined by @provider for + + Looks up a widget style property as defined by @provider for the widget represented by @path. - %TRUE if the property was found and has a value, %FALSE otherwise + %TRUE if the property was found and has a value, %FALSE otherwise - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - state to query the style property for + state to query the style property for - The #GParamSpec to query + The #GParamSpec to query - - return location for the property value + + return location for the property value - - Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none + + Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none is defined. Will always return %NULL for all GTK-provided style providers. - The icon factory to use for @path, or %NULL + The icon factory to use for @path, or %NULL - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - - Returns the style settings affecting a widget defined by @path, or %NULL if -@provider doesn’t contemplate styling @path. + + Returns the style settings affecting a widget defined by @path, or %NULL if +@provider doesn’t contemplate styling @path. Will always return %NULL for all GTK-provided style providers as the interface cannot correctly work the way CSS is specified. - a #GtkStyleProperties containing the + a #GtkStyleProperties containing the style settings affecting @path - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - - Looks up a widget style property as defined by @provider for + + Looks up a widget style property as defined by @provider for the widget represented by @path. - %TRUE if the property was found and has a value, %FALSE otherwise + %TRUE if the property was found and has a value, %FALSE otherwise - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - state to query the style property for + state to query the style property for - The #GParamSpec to query + The #GParamSpec to query - - return location for the property value + + return location for the property value - + @@ -146882,23 +104922,17 @@ the widget represented by @path. - a #GtkStyleProperties containing the + a #GtkStyleProperties containing the style settings affecting @path - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query @@ -146908,43 +104942,28 @@ style settings affecting @path - %TRUE if the property was found and has a value, %FALSE otherwise + %TRUE if the property was found and has a value, %FALSE otherwise - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - state to query the style property for + state to query the style property for - The #GParamSpec to query + The #GParamSpec to query - - return location for the property value + + return location for the property value @@ -146954,38 +104973,24 @@ style settings affecting @path - The icon factory to use for @path, or %NULL + The icon factory to use for @path, or %NULL - a #GtkStyleProvider + a #GtkStyleProvider - #GtkWidgetPath to query + #GtkWidgetPath to query - - #GtkSwitch is a widget that has two states: on or off. The user can control + + #GtkSwitch is a widget that has two states: on or off. The user can control which state should be active by clicking the empty area, or by dragging the handle. @@ -146996,7 +105001,7 @@ a delay. See #GtkSwitch::state-set for details. |[<!-- language="plain" --> switch -╰── slider +╰── slider ]| GtkSwitch has two css nodes, the main node with the name switch and a subnode @@ -147007,14 +105012,10 @@ named slider. Neither of them is using any style classes. - Creates a new #GtkSwitch widget. + Creates a new #GtkSwitch widget. - the newly created #GtkSwitch instance + the newly created #GtkSwitch instance @@ -147043,81 +105044,53 @@ named slider. Neither of them is using any style classes. - - Gets whether the #GtkSwitch is in its “on” or “off” state. + + Gets whether the #GtkSwitch is in its “on” or “off” state. - %TRUE if the #GtkSwitch is active, and %FALSE otherwise + %TRUE if the #GtkSwitch is active, and %FALSE otherwise - a #GtkSwitch + a #GtkSwitch - - Gets the underlying state of the #GtkSwitch. + + Gets the underlying state of the #GtkSwitch. - the underlying state + the underlying state - a #GtkSwitch + a #GtkSwitch - - Changes the state of @sw to the desired one. + + Changes the state of @sw to the desired one. - a #GtkSwitch + a #GtkSwitch - %TRUE if @sw should be active, and %FALSE otherwise + %TRUE if @sw should be active, and %FALSE otherwise - - Sets the underlying state of the #GtkSwitch. + + Sets the underlying state of the #GtkSwitch. Normally, this is the same as #GtkSwitch:active, unless the switch is set up for delayed state changes. This function is typically @@ -147130,32 +105103,21 @@ See #GtkSwitch::state-set for details. - a #GtkSwitch + a #GtkSwitch - the new state + the new state - Whether the #GtkSwitch widget is in its on or off state. + Whether the #GtkSwitch widget is in its on or off state. - - The backend state that is controlled by the switch. + + The backend state that is controlled by the switch. See #GtkSwitch::state-set for details. @@ -147166,9 +105128,7 @@ See #GtkSwitch::state-set for details. - The ::activate signal on GtkSwitch is an action signal and + The ::activate signal on GtkSwitch is an action signal and emitting it causes the switch to animate. Applications should never connect to this signal, but use the notify::active signal. @@ -147177,9 +105137,7 @@ notify::active signal. - The ::state-set signal on GtkSwitch is emitted to change the underlying + The ::state-set signal on GtkSwitch is emitted to change the underlying state. It is emitted when the user changes the switch position. The default handler keeps the state in sync with the #GtkSwitch:active property. @@ -147193,28 +105151,18 @@ Visually, the underlying state is represented by the trough color of the switch, while the #GtkSwitch:active property is represented by the position of the switch. - %TRUE to stop the signal emission + %TRUE to stop the signal emission - the new state of the switch + the new state of the switch - + @@ -147222,31 +105170,22 @@ position of the switch. - + - + - + - + - The parent class. + The parent class. @@ -147322,14 +105261,8 @@ position of the switch. - - GtkSymbolicColor is a boxed type that represents a symbolic color. + + GtkSymbolicColor is a boxed type that represents a symbolic color. It is the result of parsing a [color expression][gtkcssprovider-symbolic-colors]. To obtain the color represented by a GtkSymbolicColor, it has to @@ -147344,336 +105277,208 @@ since they are mostly used behind the scenes by #GtkStyleContext and #GtkSymbolicColor is deprecated. Symbolic colors are considered an implementation detail of GTK+. - - - Creates a symbolic color by modifying the relative alpha + + + Creates a symbolic color by modifying the relative alpha value of @color. A factor < 1.0 would resolve to a more transparent color, while > 1.0 would resolve to a more opaque color. #GtkSymbolicColor is deprecated. - + - A newly created #GtkSymbolicColor + A newly created #GtkSymbolicColor - another #GtkSymbolicColor + another #GtkSymbolicColor - factor to apply to @color alpha + factor to apply to @color alpha - - Creates a symbolic color pointing to a literal color. + + Creates a symbolic color pointing to a literal color. #GtkSymbolicColor is deprecated. - + - a newly created #GtkSymbolicColor + a newly created #GtkSymbolicColor - a #GdkRGBA + a #GdkRGBA - - Creates a symbolic color defined as a mix of another + + Creates a symbolic color defined as a mix of another two colors. a mix factor of 0 would resolve to @color1, while a factor of 1 would resolve to @color2. #GtkSymbolicColor is deprecated. - + - A newly created #GtkSymbolicColor + A newly created #GtkSymbolicColor - color to mix + color to mix - another color to mix + another color to mix - mix factor + mix factor - - Creates a symbolic color pointing to an unresolved named + + Creates a symbolic color pointing to an unresolved named color. See gtk_style_context_lookup_color() and gtk_style_properties_lookup_color(). #GtkSymbolicColor is deprecated. - + - a newly created #GtkSymbolicColor + a newly created #GtkSymbolicColor - color name + color name - - Creates a symbolic color defined as a shade of + + Creates a symbolic color defined as a shade of another color. A factor > 1.0 would resolve to a brighter color, while < 1.0 would resolve to a darker color. #GtkSymbolicColor is deprecated. - + - A newly created #GtkSymbolicColor + A newly created #GtkSymbolicColor - another #GtkSymbolicColor + another #GtkSymbolicColor - shading factor to apply to @color + shading factor to apply to @color - - Creates a symbolic color based on the current win32 + + Creates a symbolic color based on the current win32 theme. Note that while this call is available on all platforms the actual value returned is not reliable on non-win32 platforms. #GtkSymbolicColor is deprecated. - + - A newly created #GtkSymbolicColor + A newly created #GtkSymbolicColor - The theme class to pull color from + The theme class to pull color from - The color id + The color id - - Increases the reference count of @color + + Increases the reference count of @color #GtkSymbolicColor is deprecated. - + - the same @color + the same @color - a #GtkSymbolicColor + a #GtkSymbolicColor - - If @color is resolvable, @resolved_color will be filled in + + If @color is resolvable, @resolved_color will be filled in with the resolved color, and %TRUE will be returned. Generally, -if @color can’t be resolved, it is due to it being defined on -top of a named color that doesn’t exist in @props. +if @color can’t be resolved, it is due to it being defined on +top of a named color that doesn’t exist in @props. When @props is %NULL, resolving of named colors will fail, so if your @color is or references such a color, this function will return %FALSE. #GtkSymbolicColor is deprecated. - + - %TRUE if the color has been resolved + %TRUE if the color has been resolved - a #GtkSymbolicColor + a #GtkSymbolicColor - - #GtkStyleProperties to use when resolving + + #GtkStyleProperties to use when resolving named colors, or %NULL - - return location for the resolved color + + return location for the resolved color - - Converts the given @color to a string representation. This is useful + + Converts the given @color to a string representation. This is useful both for debugging and for serialization of strings. The format of the string may change between different versions of GTK, but it is guaranteed that the GTK css parser is able to read the string and create the same symbolic color from it. #GtkSymbolicColor is deprecated. - + - a new string representing @color + a new string representing @color - color to convert to a string + color to convert to a string - - Decreases the reference count of @color, freeing its memory if the + + Decreases the reference count of @color, freeing its memory if the reference count reaches 0. #GtkSymbolicColor is deprecated. - + - a #GtkSymbolicColor + a #GtkSymbolicColor @@ -147686,911 +105491,695 @@ reference count reaches 0. - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - The priority at which the text view validates onscreen lines + + The priority at which the text view validates onscreen lines in an idle job in the background. - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a + + The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a #GtkTreeSortable use the default sort function. See also gtk_tree_sortable_set_sort_column_id() - + - - The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a + + The GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID can be used to make a #GtkTreeSortable use no sorting. See also gtk_tree_sortable_set_sort_column_id() - + - + - + - + - + - + - + - + - + - + - + - + - - The #GtkTable functions allow the programmer to arrange widgets in rows and + + The #GtkTable functions allow the programmer to arrange widgets in rows and columns, making it easy to align many widgets next to each other, horizontally and vertically. @@ -148617,13 +106206,8 @@ table will resize themselves to the size of the largest widget in the table. - - Used to create a new table widget. An initial size must be given by + + Used to create a new table widget. An initial size must be given by specifying how many rows and columns the table should have, although this can be changed later with gtk_table_resize(). @rows and @columns must both be in the range 1 .. 65535. For historical reasons, 0 is accepted @@ -148631,40 +106215,27 @@ as well and is silently interpreted as 1. Use gtk_grid_new(). - A pointer to the newly created table widget. + A pointer to the newly created table widget. - The number of rows the new table should have. + The number of rows the new table should have. - The number of columns the new table should have. + The number of columns the new table should have. - If set to %TRUE, all table cells are resized to the size of + If set to %TRUE, all table cells are resized to the size of the cell containing the largest widget. - - Adds a widget to a table. The number of “cells” that a widget will occupy is + + Adds a widget to a table. The number of “cells” that a widget will occupy is specified by @left_attach, @right_attach, @top_attach and @bottom_attach. These each represent the leftmost, rightmost, uppermost and lowest column and row numbers of the table. (Columns and rows are indexed from zero). @@ -148686,74 +106257,49 @@ If you want to make the button span the entire bottom row, use @left_attach == 0 - The #GtkTable to add a new widget to. + The #GtkTable to add a new widget to. - The widget to add. + The widget to add. - the column number to attach the left side of a child widget to. + the column number to attach the left side of a child widget to. - the column number to attach the right side of a child widget to. + the column number to attach the right side of a child widget to. - the row number to attach the top of a child widget to. + the row number to attach the top of a child widget to. - the row number to attach the bottom of a child widget to. + the row number to attach the bottom of a child widget to. - Used to specify the properties of the child widget when the table is resized. + Used to specify the properties of the child widget when the table is resized. - The same as xoptions, except this field determines behaviour of vertical resizing. + The same as xoptions, except this field determines behaviour of vertical resizing. - An integer value specifying the padding on the left and right of the widget being added to the table. + An integer value specifying the padding on the left and right of the widget being added to the table. - The amount of padding above and below the child widget. + The amount of padding above and below the child widget. - - As there are many options associated with gtk_table_attach(), this convenience + + As there are many options associated with gtk_table_attach(), this convenience function provides the programmer with a means to add children to a table with identical padding and expansion options. The values used for the #GtkAttachOptions are `GTK_EXPAND | GTK_FILL`, and the padding is set to 0. @@ -148765,193 +106311,126 @@ are `GTK_EXPAND | GTK_FILL`, and the padding is set to 0. - The table to add a new child widget to. + The table to add a new child widget to. - The child widget to add. + The child widget to add. - The column number to attach the left side of the child widget to. + The column number to attach the left side of the child widget to. - The column number to attach the right side of the child widget to. + The column number to attach the right side of the child widget to. - The row number to attach the top of the child widget to. + The row number to attach the top of the child widget to. - The row number to attach the bottom of the child widget to. + The row number to attach the bottom of the child widget to. - - Gets the amount of space between column @col, and + + Gets the amount of space between column @col, and column @col + 1. See gtk_table_set_col_spacing(). #GtkGrid does not offer a replacement for this functionality. - the column spacing + the column spacing - a #GtkTable + a #GtkTable - a column in the table, 0 indicates the first column + a column in the table, 0 indicates the first column - - Gets the default column spacing for the table. This is + + Gets the default column spacing for the table. This is the spacing that will be used for newly added columns. (See gtk_table_set_col_spacings()) Use gtk_grid_get_column_spacing() with #GtkGrid. - the default column spacing + the default column spacing - a #GtkTable + a #GtkTable - - Gets the default row spacing for the table. This is + + Gets the default row spacing for the table. This is the spacing that will be used for newly added rows. (See gtk_table_set_row_spacings()) Use gtk_grid_get_row_spacing() with #GtkGrid. - the default row spacing + the default row spacing - a #GtkTable + a #GtkTable - - Returns whether the table cells are all constrained to the same + + Returns whether the table cells are all constrained to the same width and height. (See gtk_table_set_homogeneous ()) Use gtk_grid_get_row_homogeneous() and gtk_grid_get_column_homogeneous() with #GtkGrid. - %TRUE if the cells are all constrained to the same size + %TRUE if the cells are all constrained to the same size - a #GtkTable + a #GtkTable - - Gets the amount of space between row @row, and + + Gets the amount of space between row @row, and row @row + 1. See gtk_table_set_row_spacing(). #GtkGrid does not offer a replacement for this functionality. - the row spacing + the row spacing - a #GtkTable + a #GtkTable - a row in the table, 0 indicates the first row + a row in the table, 0 indicates the first row - - Gets the number of rows and columns in the table. + + Gets the number of rows and columns in the table. #GtkGrid does not expose the number of columns and rows. @@ -148960,44 +106439,23 @@ row @row + 1. See gtk_table_set_row_spacing(). - a #GtkTable + a #GtkTable - - return location for the number of + + return location for the number of rows, or %NULL - - return location for the number + + return location for the number of columns, or %NULL - - If you need to change a table’s size after + + If you need to change a table’s size after it has been created, this function allows you to do so. #GtkGrid resizes automatically. @@ -149006,32 +106464,21 @@ it has been created, this function allows you to do so. - The #GtkTable you wish to change the size of. + The #GtkTable you wish to change the size of. - The new number of rows. + The new number of rows. - The new number of columns. + The new number of columns. - - Alters the amount of space between a given table column and the following + + Alters the amount of space between a given table column and the following column. Use gtk_widget_set_margin_start() and gtk_widget_set_margin_end() on the widgets contained in the row if @@ -149042,32 +106489,21 @@ column. - a #GtkTable. + a #GtkTable. - the column whose spacing should be changed. + the column whose spacing should be changed. - number of pixels that the spacing should take up. + number of pixels that the spacing should take up. - - Sets the space between every column in @table equal to @spacing. + + Sets the space between every column in @table equal to @spacing. Use gtk_grid_set_column_spacing() with #GtkGrid. @@ -149075,27 +106511,18 @@ column. - a #GtkTable. + a #GtkTable. - the number of pixels of space to place between every column + the number of pixels of space to place between every column in the table. - - Changes the homogenous property of table cells, ie. whether all cells are + + Changes the homogenous property of table cells, ie. whether all cells are an equal size or not. Use gtk_grid_set_row_homogeneous() and gtk_grid_set_column_homogeneous() with #GtkGrid. @@ -149105,27 +106532,18 @@ an equal size or not. - The #GtkTable you wish to set the homogeneous properties of. + The #GtkTable you wish to set the homogeneous properties of. - Set to %TRUE to ensure all table cells are the same size. Set + Set to %TRUE to ensure all table cells are the same size. Set to %FALSE if this is not your desired behaviour. - - Changes the space between a given table row and the subsequent row. + + Changes the space between a given table row and the subsequent row. Use gtk_widget_set_margin_top() and gtk_widget_set_margin_bottom() on the widgets contained in the row if you need this functionality. #GtkGrid does not support per-row spacing. @@ -149135,32 +106553,21 @@ an equal size or not. - a #GtkTable containing the row whose properties you wish to change. + a #GtkTable containing the row whose properties you wish to change. - row number whose spacing will be changed. + row number whose spacing will be changed. - number of pixels that the spacing should take up. + number of pixels that the spacing should take up. - - Sets the space between every row in @table equal to @spacing. + + Sets the space between every row in @table equal to @spacing. Use gtk_grid_set_row_spacing() with #GtkGrid. @@ -149168,15 +106575,11 @@ an equal size or not. - a #GtkTable. + a #GtkTable. - the number of pixels of space to place between every row in the table. + the number of pixels of space to place between every row in the table. @@ -149245,9 +106648,7 @@ an equal size or not. - + @@ -149315,96 +106716,66 @@ an equal size or not. - - A #GtkTargetEntry represents a single type of + + A #GtkTargetEntry represents a single type of data than can be supplied for by a widget for a selection or for supplied or received during drag-and-drop. - a string representation of the target type + a string representation of the target type - #GtkTargetFlags for DND + #GtkTargetFlags for DND - an application-assigned integer ID which will + an application-assigned integer ID which will get passed as a parameter to e.g the #GtkWidget::selection-get signal. It allows the application to identify the target type without extensive string compares. - Makes a new #GtkTargetEntry. + Makes a new #GtkTargetEntry. - a pointer to a new #GtkTargetEntry. + a pointer to a new #GtkTargetEntry. Free with gtk_target_entry_free() - String identifier for target + String identifier for target - Set of flags, see #GtkTargetFlags + Set of flags, see #GtkTargetFlags - an ID that will be passed back to the application + an ID that will be passed back to the application - Makes a copy of a #GtkTargetEntry and its data. + Makes a copy of a #GtkTargetEntry and its data. - a pointer to a copy of @data. + a pointer to a copy of @data. Free with gtk_target_entry_free() - a pointer to a #GtkTargetEntry + a pointer to a #GtkTargetEntry - Frees a #GtkTargetEntry returned from + Frees a #GtkTargetEntry returned from gtk_target_entry_new() or gtk_target_entry_copy(). @@ -149412,145 +106783,85 @@ gtk_target_entry_new() or gtk_target_entry_copy(). - a pointer to a #GtkTargetEntry. + a pointer to a #GtkTargetEntry. - - The #GtkTargetFlags enumeration is used to specify + + The #GtkTargetFlags enumeration is used to specify constraints on a #GtkTargetEntry. - - If this is set, the target will only be selected + + If this is set, the target will only be selected for drags within a single application. - - If this is set, the target will only be selected + + If this is set, the target will only be selected for drags within a single widget. - - If this is set, the target will not be selected + + If this is set, the target will not be selected for drags within a single application. - - If this is set, the target will not be selected + + If this is set, the target will not be selected for drags withing a single widget. - - A #GtkTargetList-struct is a reference counted list + + A #GtkTargetList-struct is a reference counted list of #GtkTargetPair and should be treated as opaque. - Creates a new #GtkTargetList from an array of #GtkTargetEntry. + Creates a new #GtkTargetList from an array of #GtkTargetEntry. - the new #GtkTargetList. + the new #GtkTargetList. - - Pointer to an array + + Pointer to an array of #GtkTargetEntry - + - number of entries in @targets. + number of entries in @targets. - Appends another target to a #GtkTargetList. + Appends another target to a #GtkTargetList. - a #GtkTargetList + a #GtkTargetList - the interned atom representing the target + the interned atom representing the target - the flags for this target + the flags for this target - an ID that will be passed back to the application + an ID that will be passed back to the application - - Appends the image targets supported by #GtkSelectionData to + + Appends the image targets supported by #GtkSelectionData to the target list. All targets are added with the same @info. @@ -149558,32 +106869,22 @@ the target list. All targets are added with the same @info. - a #GtkTargetList + a #GtkTargetList - an ID that will be passed back to the application + an ID that will be passed back to the application - whether to add only targets for which GTK+ knows + whether to add only targets for which GTK+ knows how to convert a pixbuf into the format - - Appends the rich text targets registered with + + Appends the rich text targets registered with gtk_text_buffer_register_serialize_format() or gtk_text_buffer_register_deserialize_format() to the target list. All targets are added with the same @info. @@ -149593,71 +106894,49 @@ targets are added with the same @info. - a #GtkTargetList + a #GtkTargetList - an ID that will be passed back to the application + an ID that will be passed back to the application - if %TRUE, then deserializable rich text formats + if %TRUE, then deserializable rich text formats will be added, serializable formats otherwise. - a #GtkTextBuffer. + a #GtkTextBuffer. - Prepends a table of #GtkTargetEntry to a target list. + Prepends a table of #GtkTargetEntry to a target list. - a #GtkTargetList + a #GtkTargetList - the table of #GtkTargetEntry - + the table of #GtkTargetEntry + - number of targets in the table + number of targets in the table - - Appends the text targets supported by #GtkSelectionData to + + Appends the text targets supported by #GtkSelectionData to the target list. All targets are added with the same @info. @@ -149665,25 +106944,17 @@ the target list. All targets are added with the same @info. - a #GtkTargetList + a #GtkTargetList - an ID that will be passed back to the application + an ID that will be passed back to the application - - Appends the URI targets supported by #GtkSelectionData to + + Appends the URI targets supported by #GtkSelectionData to the target list. All targets are added with the same @info. @@ -149691,104 +106962,71 @@ the target list. All targets are added with the same @info. - a #GtkTargetList + a #GtkTargetList - an ID that will be passed back to the application + an ID that will be passed back to the application - Looks up a given target in a #GtkTargetList. + Looks up a given target in a #GtkTargetList. - %TRUE if the target was found, otherwise %FALSE + %TRUE if the target was found, otherwise %FALSE - a #GtkTargetList + a #GtkTargetList - an interned atom representing the target to search for + an interned atom representing the target to search for - - a pointer to the location to store + + a pointer to the location to store application info for target, or %NULL - Increases the reference count of a #GtkTargetList by one. + Increases the reference count of a #GtkTargetList by one. - the passed in #GtkTargetList. + the passed in #GtkTargetList. - a #GtkTargetList + a #GtkTargetList - Removes a target from a target list. + Removes a target from a target list. - a #GtkTargetList + a #GtkTargetList - the interned atom representing the target + the interned atom representing the target - Decreases the reference count of a #GtkTargetList by one. + Decreases the reference count of a #GtkTargetList by one. If the resulting reference count is zero, frees the list. @@ -149796,53 +107034,35 @@ If the resulting reference count is zero, frees the list. - a #GtkTargetList + a #GtkTargetList - A #GtkTargetPair is used to represent the same + A #GtkTargetPair is used to represent the same information as a table of #GtkTargetEntry, but in an efficient form. - #GdkAtom representation of the target type + #GdkAtom representation of the target type - #GtkTargetFlags for DND + #GtkTargetFlags for DND - an application-assigned integer ID which will + an application-assigned integer ID which will get passed as a parameter to e.g the #GtkWidget::selection-get signal. It allows the application to identify the target type without extensive string compares. - - A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to + + A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to tear off and reattach its menu. When its menu is shown normally, the #GtkTearoffMenuItem is drawn as a @@ -149857,27 +107077,18 @@ menu window. > #GtkTearoffMenuItem is deprecated and should not be used in newly > written code. Menus are not meant to be torn around. - + - - Creates a new #GtkTearoffMenuItem. + + Creates a new #GtkTearoffMenuItem. #GtkTearoffMenuItem is deprecated and should not be used in newly written code. - + - a new #GtkTearoffMenuItem. + a new #GtkTearoffMenuItem. @@ -149885,25 +107096,18 @@ menu window. - + - - + + - The parent class. + The parent class. - + @@ -149911,8 +107115,7 @@ menu window. - + @@ -149920,8 +107123,7 @@ menu window. - + @@ -149929,73 +107131,53 @@ menu window. - + - - + + - Background #GdkColor. + Background #GdkColor. - Foreground #GdkColor. + Foreground #GdkColor. - Super/subscript rise, can be negative. + Super/subscript rise, can be negative. - #PangoUnderline + #PangoUnderline - Strikethrough style + Strikethrough style - Whether to use background-related values; this is + Whether to use background-related values; this is irrelevant for the values struct when in a tag, but is used for - the composite values struct; it’s true if any of the tags being + the composite values struct; it’s true if any of the tags being composited had background stuff set. - This are only used when we are actually laying + This are only used when we are actually laying out and rendering a paragraph; not when a #GtkTextAppearance is part of a #GtkTextAttributes. - This are only used when we are actually laying + This are only used when we are actually laying out and rendering a paragraph; not when a #GtkTextAppearance is part of a #GtkTextAttributes. @@ -150014,15 +107196,9 @@ menu window. - - Using #GtkTextAttributes directly should rarely be necessary. -It’s primarily useful with gtk_text_iter_get_attributes(). + + Using #GtkTextAttributes directly should rarely be necessary. +It’s primarily useful with gtk_text_iter_get_attributes(). As with most GTK+ structs, the fields in this struct should only be read, never modified directly. @@ -150030,125 +107206,87 @@ be read, never modified directly. - #GtkTextAppearance for text. + #GtkTextAppearance for text. - #GtkJustification for text. + #GtkJustification for text. - #GtkTextDirection for text. + #GtkTextDirection for text. - #PangoFontDescription for text. + #PangoFontDescription for text. - Font scale factor. + Font scale factor. - Width of the left margin in pixels. + Width of the left margin in pixels. - Width of the right margin in pixels. + Width of the right margin in pixels. - Amount to indent the paragraph, in pixels. + Amount to indent the paragraph, in pixels. - Pixels of blank space above paragraphs. + Pixels of blank space above paragraphs. - Pixels of blank space below paragraphs. + Pixels of blank space below paragraphs. - Pixels of blank space between wrapped lines in + Pixels of blank space between wrapped lines in a paragraph. - Custom #PangoTabArray for this text. + Custom #PangoTabArray for this text. - #GtkWrapMode for text. + #GtkWrapMode for text. - #PangoLanguage for text. + #PangoLanguage for text. - Hide the text. + Hide the text. - Background is fit to full line height rather than + Background is fit to full line height rather than baseline +/- ascent/descent (font height). - Can edit this text. + Can edit this text. - Whether to disable font fallback. + Whether to disable font fallback. - Extra space to insert between graphemes, in Pango units + Extra space to insert between graphemes, in Pango units @@ -150163,45 +107301,32 @@ be read, never modified directly. - Creates a #GtkTextAttributes, which describes + Creates a #GtkTextAttributes, which describes a set of properties on some text. - a new #GtkTextAttributes, + a new #GtkTextAttributes, free with gtk_text_attributes_unref(). - Copies @src and returns a new #GtkTextAttributes. + Copies @src and returns a new #GtkTextAttributes. - a copy of @src, + a copy of @src, free with gtk_text_attributes_unref() - a #GtkTextAttributes to be copied + a #GtkTextAttributes to be copied - - Copies the values from @src to @dest so that @dest has + + Copies the values from @src to @dest so that @dest has the same values as @src. Frees existing values in @dest. @@ -150209,43 +107334,31 @@ the same values as @src. Frees existing values in @dest. - a #GtkTextAttributes + a #GtkTextAttributes - another #GtkTextAttributes + another #GtkTextAttributes - Increments the reference count on @values. + Increments the reference count on @values. - the #GtkTextAttributes that were passed in + the #GtkTextAttributes that were passed in - a #GtkTextAttributes + a #GtkTextAttributes - Decrements the reference count on @values, freeing the structure + Decrements the reference count on @values, freeing the structure if the reference count reaches 0. @@ -150253,9 +107366,7 @@ if the reference count reaches 0. - a #GtkTextAttributes + a #GtkTextAttributes @@ -150264,47 +107375,28 @@ if the reference count reaches 0. - - You may wish to begin by reading the + + You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together. - Creates a new text buffer. + Creates a new text buffer. - a new text buffer + a new text buffer - - a tag table, or %NULL to create a new one + + a tag table, or %NULL to create a new one - Emits the “apply-tag” signal on @buffer. The default + Emits the “apply-tag” signal on @buffer. The default handler for the signal applies @tag to the given range. @start and @end do not have to be in order. @@ -150313,35 +107405,25 @@ handler for the signal applies @tag to the given range. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextTag + a #GtkTextTag - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged - Called to indicate that the buffer operations between here and a + Called to indicate that the buffer operations between here and a call to gtk_text_buffer_end_user_action() are part of a single user-visible operation. The operations between gtk_text_buffer_begin_user_action() and @@ -150349,11 +107431,11 @@ gtk_text_buffer_end_user_action() can then be grouped when creating an undo stack. #GtkTextBuffer maintains a count of calls to gtk_text_buffer_begin_user_action() that have not been closed with a call to gtk_text_buffer_end_user_action(), and emits the -“begin-user-action” and “end-user-action” signals only for the +“begin-user-action” and “end-user-action” signals only for the outermost pair of calls. This allows you to build user actions from other user actions. -The “interactive” buffer mutation functions, such as +The “interactive” buffer mutation functions, such as gtk_text_buffer_insert_interactive(), automatically call begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a @@ -150364,9 +107446,7 @@ single call to one of those functions. - a #GtkTextBuffer + a #GtkTextBuffer @@ -150400,9 +107480,7 @@ single call to one of those functions. - Should be paired with a call to gtk_text_buffer_begin_user_action(). + Should be paired with a call to gtk_text_buffer_begin_user_action(). See that function for a full explanation. @@ -150410,22 +107488,18 @@ See that function for a full explanation. - a #GtkTextBuffer + a #GtkTextBuffer - Inserts a child widget anchor into the text buffer at @iter. The + Inserts a child widget anchor into the text buffer at @iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented -by the Unicode “object replacement character” 0xFFFC. Note that the -“slice” variants for obtaining portions of the buffer as a string -include this character for child anchors, but the “text” variants do +by the Unicode “object replacement character” 0xFFFC. Note that the +“slice” variants for obtaining portions of the buffer as a string +include this character for child anchors, but the “text” variants do not. E.g. see gtk_text_buffer_get_slice() and gtk_text_buffer_get_text(). Consider gtk_text_buffer_create_child_anchor() as a more convenient @@ -150437,34 +107511,26 @@ the anchor, so you can unref it after insertion. - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the anchor + location to insert the anchor - a #GtkTextChildAnchor + a #GtkTextChildAnchor - Inserts an image into the text buffer at @iter. The image will be + Inserts an image into the text buffer at @iter. The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode -“object replacement character” 0xFFFC. Note that the “slice” +“object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include -this character for pixbufs, but the “text” variants do +this character for pixbufs, but the “text” variants do not. e.g. see gtk_text_buffer_get_slice() and gtk_text_buffer_get_text(). @@ -150473,21 +107539,15 @@ gtk_text_buffer_get_text(). - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the pixbuf + location to insert the pixbuf - a #GdkPixbuf + a #GdkPixbuf @@ -150569,48 +107629,34 @@ gtk_text_buffer_get_text(). - Emits the “remove-tag” signal. The default handler for the signal + Emits the “remove-tag” signal. The default handler for the signal removes all occurrences of @tag from the given range. @start and -@end don’t have to be in order. +@end don’t have to be in order. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextTag + a #GtkTextTag - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - - Adds the mark at position @where. The mark must not be added to + + Adds the mark at position @where. The mark must not be added to another buffer, and if its name is not %NULL then there must not be another mark in the buffer with the same name. @@ -150622,30 +107668,21 @@ initial placement. - a #GtkTextBuffer + a #GtkTextBuffer - the mark to add + the mark to add - location to place mark + location to place mark - - Adds @clipboard to the list of clipboards in which the selection + + Adds @clipboard to the list of clipboards in which the selection contents of @buffer are available. In most cases, @clipboard will be the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer. @@ -150654,23 +107691,17 @@ the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkClipboard + a #GtkClipboard - Emits the “apply-tag” signal on @buffer. The default + Emits the “apply-tag” signal on @buffer. The default handler for the signal applies @tag to the given range. @start and @end do not have to be in order. @@ -150679,36 +107710,25 @@ handler for the signal applies @tag to the given range. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextTag + a #GtkTextTag - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged - - Calls gtk_text_tag_table_lookup() on the buffer’s tag table to + + Calls gtk_text_tag_table_lookup() on the buffer’s tag table to get a #GtkTextTag, then calls gtk_text_buffer_apply_tag(). @@ -150716,37 +107736,25 @@ get a #GtkTextTag, then calls gtk_text_buffer_apply_tag(). - a #GtkTextBuffer + a #GtkTextBuffer - name of a named #GtkTextTag + name of a named #GtkTextTag - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged - - Performs the appropriate action as if the user hit the delete + + Performs the appropriate action as if the user hit the delete key with the cursor at the position specified by @iter. In the normal case a single character will be deleted, but when combining accents are involved, more than one character can @@ -150758,43 +107766,30 @@ invalid after calling this function; however, the @iter will be re-initialized to point to the location where text was deleted. - %TRUE if the buffer was modified + %TRUE if the buffer was modified - a #GtkTextBuffer + a #GtkTextBuffer - a position in @buffer + a position in @buffer - whether the deletion is caused by user interaction + whether the deletion is caused by user interaction - whether the buffer is editable by default + whether the buffer is editable by default - - Called to indicate that the buffer operations between here and a + + Called to indicate that the buffer operations between here and a call to gtk_text_buffer_end_user_action() are part of a single user-visible operation. The operations between gtk_text_buffer_begin_user_action() and @@ -150802,11 +107797,11 @@ gtk_text_buffer_end_user_action() can then be grouped when creating an undo stack. #GtkTextBuffer maintains a count of calls to gtk_text_buffer_begin_user_action() that have not been closed with a call to gtk_text_buffer_end_user_action(), and emits the -“begin-user-action” and “end-user-action” signals only for the +“begin-user-action” and “end-user-action” signals only for the outermost pair of calls. This allows you to build user actions from other user actions. -The “interactive” buffer mutation functions, such as +The “interactive” buffer mutation functions, such as gtk_text_buffer_insert_interactive(), automatically call begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a @@ -150817,80 +107812,60 @@ single call to one of those functions. - a #GtkTextBuffer + a #GtkTextBuffer - - Copies the currently-selected text to a clipboard. + + Copies the currently-selected text to a clipboard. - a #GtkTextBuffer + a #GtkTextBuffer - the #GtkClipboard object to copy to + the #GtkClipboard object to copy to - - This is a convenience function which simply creates a child anchor + + This is a convenience function which simply creates a child anchor with gtk_text_child_anchor_new() and inserts it into the buffer with gtk_text_buffer_insert_child_anchor(). The new anchor is owned by the buffer; no reference count is returned to the caller of gtk_text_buffer_create_child_anchor(). - the created child anchor + the created child anchor - a #GtkTextBuffer + a #GtkTextBuffer - location in the buffer + location in the buffer - Creates a mark at position @where. If @mark_name is %NULL, the mark + Creates a mark at position @where. If @mark_name is %NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using gtk_text_buffer_get_mark(). If a mark has left gravity, and text is -inserted at the mark’s current location, the mark will be moved to +inserted at the mark’s current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity (@left_gravity = %FALSE), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right -side of the text you’re typing). +side of the text you’re typing). The caller of this function does not own a reference to the returned #GtkTextMark, so you can ignore the @@ -150901,50 +107876,33 @@ Emits the #GtkTextBuffer::mark-set signal as notification of the mark's initial placement. - the new #GtkTextMark object + the new #GtkTextMark object - a #GtkTextBuffer + a #GtkTextBuffer - - name for mark, or %NULL + + name for mark, or %NULL - location to place mark + location to place mark - whether the mark has left gravity + whether the mark has left gravity - - Creates a tag and adds it to the tag table for @buffer. + + Creates a tag and adds it to the tag table for @buffer. Equivalent to calling gtk_text_tag_new() and then adding the -tag to the buffer’s tag table. The returned tag is owned by -the buffer’s tag table, so the ref count will be equal to one. +tag to the buffer’s tag table. The returned tag is owned by +the buffer’s tag table, so the ref count will be equal to one. If @tag_name is %NULL, the tag is anonymous. @@ -150955,81 +107913,54 @@ The @first_property_name argument and subsequent arguments are a list of properties to set on the tag, as with g_object_set(). - a new tag + a new tag - a #GtkTextBuffer + a #GtkTextBuffer - - name of the new tag, or %NULL + + name of the new tag, or %NULL - - name of first property to set, or %NULL + + name of first property to set, or %NULL - %NULL-terminated list of property names and values + %NULL-terminated list of property names and values - - Copies the currently-selected text to a clipboard, then deletes -said text if it’s editable. + + Copies the currently-selected text to a clipboard, then deletes +said text if it’s editable. - a #GtkTextBuffer + a #GtkTextBuffer - the #GtkClipboard object to cut to + the #GtkClipboard object to cut to - default editability of the buffer + default editability of the buffer - Deletes text between @start and @end. The order of @start and @end + Deletes text between @start and @end. The order of @start and @end is not actually relevant; gtk_text_buffer_delete() will reorder -them. This function actually emits the “delete-range” signal, and +them. This function actually emits the “delete-range” signal, and the default handler of that signal deletes the text. Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the @start and @end will be @@ -151040,75 +107971,54 @@ re-initialized to point to the location where text was deleted. - a #GtkTextBuffer + a #GtkTextBuffer - a position in @buffer + a position in @buffer - another position in @buffer + another position in @buffer - - Deletes all editable text in the given range. + + Deletes all editable text in the given range. Calls gtk_text_buffer_delete() for each editable sub-range of [@start,@end). @start and @end are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted. - whether some text was actually deleted + whether some text was actually deleted - a #GtkTextBuffer + a #GtkTextBuffer - start of range to delete + start of range to delete - end of range + end of range - whether the buffer is editable by default + whether the buffer is editable by default - Deletes @mark, so that it’s no longer located anywhere in the + Deletes @mark, so that it’s no longer located anywhere in the buffer. Removes the reference the buffer holds to the mark, so if -you haven’t called g_object_ref() on the mark, it will be freed. Even -if the mark isn’t freed, most operations on @mark become +you haven’t called g_object_ref() on the mark, it will be freed. Even +if the mark isn’t freed, most operations on @mark become invalid, until it gets added to a buffer again with gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to find out if a mark has been removed from its buffer. @@ -151120,24 +108030,17 @@ the mark is deleted. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextMark in @buffer + a #GtkTextMark in @buffer - - Deletes the mark named @name; the mark must exist. See + + Deletes the mark named @name; the mark must exist. See gtk_text_buffer_delete_mark() for details. @@ -151145,62 +108048,42 @@ gtk_text_buffer_delete_mark() for details. - a #GtkTextBuffer + a #GtkTextBuffer - name of a mark in @buffer + name of a mark in @buffer - - Deletes the range between the “insert” and “selection_bound” marks, + + Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text. If @interactive is %TRUE, -the editability of the selection will be considered (users can’t delete +the editability of the selection will be considered (users can’t delete uneditable text). - whether there was a non-empty selection to delete + whether there was a non-empty selection to delete - a #GtkTextBuffer + a #GtkTextBuffer - whether the deletion is caused by user interaction + whether the deletion is caused by user interaction - whether the buffer is editable by default + whether the buffer is editable by default - - This function deserializes rich text in format @format and inserts + + This function deserializes rich text in format @format and inserts it at @iter. @formats to be used must be registered using @@ -151208,87 +108091,59 @@ gtk_text_buffer_register_deserialize_format() or gtk_text_buffer_register_deserialize_tagset() beforehand. - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - the #GtkTextBuffer @format is registered with + the #GtkTextBuffer @format is registered with - the #GtkTextBuffer to deserialize into + the #GtkTextBuffer to deserialize into - the rich text format to use for deserializing + the rich text format to use for deserializing - insertion point for the deserialized text + insertion point for the deserialized text - data to deserialize + data to deserialize - length of @data + length of @data - - This functions returns the value set with + + This functions returns the value set with gtk_text_buffer_deserialize_set_can_create_tags() - whether deserializing this format may create tags + whether deserializing this format may create tags - a #GtkTextBuffer + a #GtkTextBuffer - a #GdkAtom representing a registered rich text format + a #GdkAtom representing a registered rich text format - - Use this function to allow a rich text deserialization function to + + Use this function to allow a rich text deserialization function to create new tags in the receiving buffer. Note that using this function is almost always a bad idea, because the rich text functions you register should know how to map the rich text format @@ -151302,7 +108157,7 @@ of the source buffer, including its tag names. You should allow creation of tags only if you know what you are doing, e.g. if you defined a tagset name for your application -suite’s text buffers and you know that it’s fine to receive new +suite’s text buffers and you know that it’s fine to receive new tags from these buffers, because you know that your application can handle the newly created tags. @@ -151311,30 +108166,21 @@ handle the newly created tags. - a #GtkTextBuffer + a #GtkTextBuffer - a #GdkAtom representing a registered rich text format + a #GdkAtom representing a registered rich text format - whether deserializing this format may create tags + whether deserializing this format may create tags - - Should be paired with a call to gtk_text_buffer_begin_user_action(). + + Should be paired with a call to gtk_text_buffer_begin_user_action(). See that function for a full explanation. @@ -151342,17 +108188,13 @@ See that function for a full explanation. - a #GtkTextBuffer + a #GtkTextBuffer - Retrieves the first and last iterators in the buffer, i.e. the + Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range [@start,@end). @@ -151360,94 +108202,61 @@ entire buffer lies within the range [@start,@end). - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize with first position in the buffer + + iterator to initialize with first position in the buffer - - iterator to initialize with the end iterator + + iterator to initialize with the end iterator - - Gets the number of characters in the buffer; note that characters -and bytes are not the same, you can’t e.g. expect the contents of + + Gets the number of characters in the buffer; note that characters +and bytes are not the same, you can’t e.g. expect the contents of the buffer in string form to be this many bytes long. The character count is cached, so this function is very fast. - number of characters in the buffer + number of characters in the buffer - a #GtkTextBuffer + a #GtkTextBuffer - - This function returns the list of targets this text buffer can + + This function returns the list of targets this text buffer can provide for copying and as DND source. The targets in the list are added with @info values from the #GtkTextBufferTargetInfo enum, using gtk_target_list_add_rich_text_targets() and gtk_target_list_add_text_targets(). - the #GtkTargetList + the #GtkTargetList - a #GtkTextBuffer + a #GtkTextBuffer - - This function returns the rich text deserialize formats registered + + This function returns the rich text deserialize formats registered with @buffer using gtk_text_buffer_register_deserialize_format() or gtk_text_buffer_register_deserialize_tagset() - an array of + an array of #GdkAtoms representing the registered formats. @@ -151455,26 +108264,17 @@ gtk_text_buffer_register_deserialize_tagset() - a #GtkTextBuffer + a #GtkTextBuffer - - return location for the number of formats + + return location for the number of formats - Initializes @iter with the “end iterator,” one past the last valid + Initializes @iter with the “end iterator,” one past the last valid character in the text buffer. If dereferenced with gtk_text_iter_get_char(), the end iterator has a character value of 0. The entire buffer lies in the range from the first position in @@ -151486,105 +108286,69 @@ character position 0) to the end iterator. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - - Indicates whether the buffer has some text currently selected. + + Indicates whether the buffer has some text currently selected. - %TRUE if the there is text selected + %TRUE if the there is text selected - a #GtkTextBuffer + a #GtkTextBuffer - Returns the mark that represents the cursor (insertion point). + Returns the mark that represents the cursor (insertion point). Equivalent to calling gtk_text_buffer_get_mark() to get the mark -named “insert”, but very slightly more efficient, and involves less +named “insert”, but very slightly more efficient, and involves less typing. - insertion point mark + insertion point mark - a #GtkTextBuffer + a #GtkTextBuffer - - Obtains the location of @anchor within @buffer. + + Obtains the location of @anchor within @buffer. - a #GtkTextBuffer + a #GtkTextBuffer - - an iterator to be initialized + + an iterator to be initialized - a child anchor that appears in @buffer + a child anchor that appears in @buffer - - Initializes @iter to the start of the given line. If @line_number is greater + + Initializes @iter to the start of the given line. If @line_number is greater than the number of lines in the @buffer, the end iterator is returned. @@ -151592,33 +108356,21 @@ than the number of lines in the @buffer, the end iterator is returned. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - line number counting from 0 + line number counting from 0 - - Obtains an iterator pointing to @byte_index within the given line. + + Obtains an iterator pointing to @byte_index within the given line. @byte_index must be the start of a UTF-8 character. Note bytes, not characters; UTF-8 may encode one character as multiple bytes. @@ -151633,39 +108385,25 @@ end of the line, the iterator at the end of the line is returned. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - line number counting from 0 + line number counting from 0 - byte index from start of line + byte index from start of line - - Obtains an iterator pointing to @char_offset within the given line. Note + + Obtains an iterator pointing to @char_offset within the given line. Note characters, not bytes; UTF-8 may encode one character as multiple bytes. Before the 3.20 version, it was not allowed to pass an invalid location. @@ -151679,72 +108417,46 @@ end of the line, the iterator at the end of the line is returned. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - line number counting from 0 + line number counting from 0 - char offset from start of line + char offset from start of line - - Initializes @iter with the current position of @mark. + + Initializes @iter with the current position of @mark. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - a #GtkTextMark in @buffer + a #GtkTextMark in @buffer - - Initializes @iter to a position @char_offset chars from the start + + Initializes @iter to a position @char_offset chars from the start of the entire buffer. If @char_offset is -1 or greater than the number of characters in the buffer, @iter is initialized to the end iterator, the iterator one past the last valid character in the buffer. @@ -151754,162 +108466,114 @@ the iterator one past the last valid character in the buffer. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - char offset from start of buffer, counting from 0, or -1 + char offset from start of buffer, counting from 0, or -1 - - Obtains the number of lines in the buffer. This value is cached, so + + Obtains the number of lines in the buffer. This value is cached, so the function is very fast. - number of lines in the buffer + number of lines in the buffer - a #GtkTextBuffer + a #GtkTextBuffer - Returns the mark named @name in buffer @buffer, or %NULL if no such + Returns the mark named @name in buffer @buffer, or %NULL if no such mark exists in the buffer. - a #GtkTextMark, or %NULL + a #GtkTextMark, or %NULL - a #GtkTextBuffer + a #GtkTextBuffer - a mark name + a mark name - Indicates whether the buffer has been modified since the last call + Indicates whether the buffer has been modified since the last call to gtk_text_buffer_set_modified() set the modification flag to -%FALSE. Used for example to enable a “save” function in a text +%FALSE. Used for example to enable a “save” function in a text editor. - %TRUE if the buffer has been modified + %TRUE if the buffer has been modified - a #GtkTextBuffer + a #GtkTextBuffer - - This function returns the list of targets this text buffer supports + + This function returns the list of targets this text buffer supports for pasting and as DND destination. The targets in the list are added with @info values from the #GtkTextBufferTargetInfo enum, using gtk_target_list_add_rich_text_targets() and gtk_target_list_add_text_targets(). - the #GtkTargetList + the #GtkTargetList - a #GtkTextBuffer + a #GtkTextBuffer - - Returns the mark that represents the selection bound. Equivalent + + Returns the mark that represents the selection bound. Equivalent to calling gtk_text_buffer_get_mark() to get the mark named -“selection_bound”, but very slightly more efficient, and involves +“selection_bound”, but very slightly more efficient, and involves less typing. The currently-selected text in @buffer is the region between the -“selection_bound” and “insert” marks. If “selection_bound” and -“insert” are in the same place, then there is no current selection. +“selection_bound” and “insert” marks. If “selection_bound” and +“insert” are in the same place, then there is no current selection. gtk_text_buffer_get_selection_bounds() is another convenient function -for handling the selection, if you just want to know whether there’s a +for handling the selection, if you just want to know whether there’s a selection and what its bounds are. - selection bound mark + selection bound mark - a #GtkTextBuffer + a #GtkTextBuffer - - Returns %TRUE if some text is selected; places the bounds + + Returns %TRUE if some text is selected; places the bounds of the selection in @start and @end (if the selection has length 0, then @start and @end are filled in with the same value). @start and @end will be in ascending order. If @start and @end are @@ -151917,51 +108581,31 @@ NULL, then they are not filled in, but the return value still indicates whether text is selected. - whether the selection has nonzero length + whether the selection has nonzero length - a #GtkTextBuffer a #GtkTextBuffer + a #GtkTextBuffer a #GtkTextBuffer - - iterator to initialize with selection start + + iterator to initialize with selection start - - iterator to initialize with selection end + + iterator to initialize with selection end - - This function returns the rich text serialize formats registered + + This function returns the rich text serialize formats registered with @buffer using gtk_text_buffer_register_serialize_format() or gtk_text_buffer_register_serialize_tagset() - an array of + an array of #GdkAtoms representing the registered formats. @@ -151969,26 +108613,17 @@ gtk_text_buffer_register_serialize_tagset() - a #GtkTextBuffer + a #GtkTextBuffer - - return location for the number of formats + + return location for the number of formats - Returns the text in the range [@start,@end). Excludes undisplayed + Returns the text in the range [@start,@end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if @include_hidden_chars is %FALSE. The returned string includes a 0xFFFC character whenever the buffer contains @@ -152000,43 +108635,30 @@ text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer. - an allocated UTF-8 string + an allocated UTF-8 string - a #GtkTextBuffer + a #GtkTextBuffer - start of a range + start of a range - end of a range + end of a range - whether to include invisible text + whether to include invisible text - - Initialized @iter with the first position in the text buffer. This + + Initialized @iter with the first position in the text buffer. This is the same as using gtk_text_buffer_get_iter_at_offset() to get the iter at character offset 0. @@ -152045,47 +108667,31 @@ the iter at character offset 0. - a #GtkTextBuffer + a #GtkTextBuffer - - iterator to initialize + + iterator to initialize - - Get the #GtkTextTagTable associated with this buffer. + + Get the #GtkTextTagTable associated with this buffer. - the buffer’s tag table + the buffer’s tag table - a #GtkTextBuffer + a #GtkTextBuffer - Returns the text in the range [@start,@end). Excludes undisplayed + Returns the text in the range [@start,@end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if @include_hidden_chars is %FALSE. Does not include characters representing embedded images, so byte and character indexes into @@ -152094,44 +108700,32 @@ and character indexes into the buffer. Contrast with gtk_text_buffer_get_slice(). - an allocated UTF-8 string + an allocated UTF-8 string - a #GtkTextBuffer + a #GtkTextBuffer - start of a range + start of a range - end of a range + end of a range - whether to include invisible text + whether to include invisible text - Inserts @len bytes of @text at position @iter. If @len is -1, + Inserts @len bytes of @text at position @iter. If @len is -1, @text must be nul-terminated and will be inserted in its -entirety. Emits the “insert-text” signal; insertion actually occurs +entirety. Emits the “insert-text” signal; insertion actually occurs in the default handler for the signal. @iter is invalidated when insertion occurs (because the buffer contents change), but the default signal handler revalidates it to point to the end of the @@ -152142,36 +108736,25 @@ inserted text. - a #GtkTextBuffer + a #GtkTextBuffer - a position in the buffer + a position in the buffer - text in UTF-8 format + text in UTF-8 format - length of text in bytes, or -1 + length of text in bytes, or -1 - - Simply calls gtk_text_buffer_insert(), using the current + + Simply calls gtk_text_buffer_insert(), using the current cursor position as the insertion point. @@ -152179,35 +108762,26 @@ cursor position as the insertion point. - a #GtkTextBuffer + a #GtkTextBuffer - text in UTF-8 format + text in UTF-8 format - length of text, in bytes + length of text, in bytes - - Inserts a child widget anchor into the text buffer at @iter. The + + Inserts a child widget anchor into the text buffer at @iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented -by the Unicode “object replacement character” 0xFFFC. Note that the -“slice” variants for obtaining portions of the buffer as a string -include this character for child anchors, but the “text” variants do +by the Unicode “object replacement character” 0xFFFC. Note that the +“slice” variants for obtaining portions of the buffer as a string +include this character for child anchors, but the “text” variants do not. E.g. see gtk_text_buffer_get_slice() and gtk_text_buffer_get_text(). Consider gtk_text_buffer_create_child_anchor() as a more convenient @@ -152219,30 +108793,21 @@ the anchor, so you can unref it after insertion. - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the anchor + location to insert the anchor - a #GtkTextChildAnchor + a #GtkTextChildAnchor - - Like gtk_text_buffer_insert(), but the insertion will not occur if + + Like gtk_text_buffer_insert(), but the insertion will not occur if @iter is at a non-editable location in the buffer. Usually you want to prevent insertions at ineditable locations if the insertion results from a user action (is interactive). @@ -152252,49 +108817,34 @@ have a tag affecting editability applied to it. Typically the result of gtk_text_view_get_editable() is appropriate here. - whether text was actually inserted + whether text was actually inserted - a #GtkTextBuffer + a #GtkTextBuffer - a position in @buffer + a position in @buffer - some UTF-8 text + some UTF-8 text - length of text in bytes, or -1 + length of text in bytes, or -1 - default editability of buffer + default editability of buffer - - Calls gtk_text_buffer_insert_interactive() at the cursor + + Calls gtk_text_buffer_insert_interactive() at the cursor position. @default_editable indicates the editability of text that doesn't @@ -152302,44 +108852,30 @@ have a tag affecting editability applied to it. Typically the result of gtk_text_view_get_editable() is appropriate here. - whether text was actually inserted + whether text was actually inserted - a #GtkTextBuffer + a #GtkTextBuffer - text in UTF-8 format + text in UTF-8 format - length of text in bytes, or -1 + length of text in bytes, or -1 - default editability of buffer + default editability of buffer - - Inserts the text in @markup at position @iter. @markup will be inserted + + Inserts the text in @markup at position @iter. @markup will be inserted in its entirety and must be nul-terminated and valid UTF-8. Emits the #GtkTextBuffer::insert-text signal, possibly multiple times; insertion actually occurs in the default handler for the signal. @iter will point @@ -152350,41 +108886,30 @@ to the end of the inserted text on return. - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the markup + location to insert the markup - a nul-terminated UTF-8 string containing [Pango markup][PangoMarkupFormat] + a nul-terminated UTF-8 string containing [Pango markup][PangoMarkupFormat] - length of @markup in bytes, or -1 + length of @markup in bytes, or -1 - - Inserts an image into the text buffer at @iter. The image will be + + Inserts an image into the text buffer at @iter. The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode -“object replacement character” 0xFFFC. Note that the “slice” +“object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include -this character for pixbufs, but the “text” variants do +this character for pixbufs, but the “text” variants do not. e.g. see gtk_text_buffer_get_slice() and gtk_text_buffer_get_text(). @@ -152393,30 +108918,22 @@ gtk_text_buffer_get_text(). - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the pixbuf + location to insert the pixbuf - a #GdkPixbuf + a #GdkPixbuf - Copies text, tags, and pixbufs between @start and @end (the order -of @start and @end doesn’t matter) and inserts the copy at @iter. + Copies text, tags, and pixbufs between @start and @end (the order +of @start and @end doesn’t matter) and inserts the copy at @iter. Used instead of simply getting/inserting text because it preserves images and tags. If @start and @end are in a different buffer from @buffer, the two buffers must share the same tag table. @@ -152429,86 +108946,59 @@ so expect those. - a #GtkTextBuffer + a #GtkTextBuffer - a position in @buffer + a position in @buffer - a position in a #GtkTextBuffer + a position in a #GtkTextBuffer - another position in the same buffer as @start + another position in the same buffer as @start - - Same as gtk_text_buffer_insert_range(), but does nothing if the -insertion point isn’t editable. The @default_editable parameter + + Same as gtk_text_buffer_insert_range(), but does nothing if the +insertion point isn’t editable. The @default_editable parameter indicates whether the text is editable at @iter if no tags enclosing @iter affect editability. Typically the result of gtk_text_view_get_editable() is appropriate here. - whether an insertion was possible at @iter + whether an insertion was possible at @iter - a #GtkTextBuffer + a #GtkTextBuffer - a position in @buffer + a position in @buffer - a position in a #GtkTextBuffer + a position in a #GtkTextBuffer - another position in the same buffer as @start + another position in the same buffer as @start - default editability of the buffer + default editability of the buffer - - Inserts @text into @buffer at @iter, applying the list of tags to + + Inserts @text into @buffer at @iter, applying the list of tags to the newly-inserted text. The last tag specified must be %NULL to terminate the list. Equivalent to calling gtk_text_buffer_insert(), then gtk_text_buffer_apply_tag() on the inserted text; @@ -152519,49 +109009,33 @@ gtk_text_buffer_insert_with_tags() is just a convenience function. - a #GtkTextBuffer + a #GtkTextBuffer - an iterator in @buffer + an iterator in @buffer - UTF-8 text + UTF-8 text - length of @text, or -1 + length of @text, or -1 - first tag to apply to @text + first tag to apply to @text - %NULL-terminated list of tags to apply + %NULL-terminated list of tags to apply - - Same as gtk_text_buffer_insert_with_tags(), but allows you + + Same as gtk_text_buffer_insert_with_tags(), but allows you to pass in tag names instead of tag objects. @@ -152569,47 +109043,33 @@ to pass in tag names instead of tag objects. - a #GtkTextBuffer + a #GtkTextBuffer - position in @buffer + position in @buffer - UTF-8 text + UTF-8 text - length of @text, or -1 + length of @text, or -1 - name of a tag to apply to @text + name of a tag to apply to @text - more tag names + more tag names - Moves @mark to the new location @where. Emits the #GtkTextBuffer::mark-set + Moves @mark to the new location @where. Emits the #GtkTextBuffer::mark-set signal as notification of the move. @@ -152617,30 +109077,21 @@ signal as notification of the move. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextMark + a #GtkTextMark - new location for @mark in @buffer + new location for @mark in @buffer - - Moves the mark named @name (which must exist) to location @where. + + Moves the mark named @name (which must exist) to location @where. See gtk_text_buffer_move_mark() for details. @@ -152648,34 +109099,25 @@ See gtk_text_buffer_move_mark() for details. - a #GtkTextBuffer + a #GtkTextBuffer - name of a mark + name of a mark - new location for mark + new location for mark - - Pastes the contents of a clipboard. If @override_location is %NULL, the + + Pastes the contents of a clipboard. If @override_location is %NULL, the pasted text will be inserted at the cursor position, or the buffer selection will be replaced if the selection is non-empty. -Note: pasting is asynchronous, that is, we’ll ask for the paste data and +Note: pasting is asynchronous, that is, we’ll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted. @@ -152684,38 +109126,25 @@ be inserted. - a #GtkTextBuffer + a #GtkTextBuffer - the #GtkClipboard to paste from + the #GtkClipboard to paste from - - location to insert pasted text, or %NULL + + location to insert pasted text, or %NULL - whether the buffer is editable by default + whether the buffer is editable by default - This function moves the “insert” and “selection_bound” marks + This function moves the “insert” and “selection_bound” marks simultaneously. If you move them to the same place in two steps with gtk_text_buffer_move_mark(), you will temporarily select a region in between their old and new locations, which can be pretty @@ -152728,184 +109157,111 @@ be optimized. - a #GtkTextBuffer + a #GtkTextBuffer - where to put the cursor + where to put the cursor - - This function registers a rich text deserialization @function along with + + This function registers a rich text deserialization @function along with its @mime_type with the passed @buffer. - the #GdkAtom that corresponds to the - newly registered format’s mime-type. + the #GdkAtom that corresponds to the + newly registered format’s mime-type. - a #GtkTextBuffer + a #GtkTextBuffer - the format’s mime-type + the format’s mime-type - - the deserialize function to register - + + the deserialize function to register + - - @function’s user_data + + @function’s user_data - - a function to call when @user_data is no longer needed + + a function to call when @user_data is no longer needed - - This function registers GTK+’s internal rich text serialization + + This function registers GTK+’s internal rich text serialization format with the passed @buffer. See gtk_text_buffer_register_serialize_tagset() for details. - the #GdkAtom that corresponds to the - newly registered format’s mime-type. + the #GdkAtom that corresponds to the + newly registered format’s mime-type. - a #GtkTextBuffer + a #GtkTextBuffer - - an optional tagset name, on %NULL + + an optional tagset name, on %NULL - - This function registers a rich text serialization @function along with + + This function registers a rich text serialization @function along with its @mime_type with the passed @buffer. - the #GdkAtom that corresponds to the - newly registered format’s mime-type. + the #GdkAtom that corresponds to the + newly registered format’s mime-type. - a #GtkTextBuffer + a #GtkTextBuffer - the format’s mime-type + the format’s mime-type - - the serialize function to register - + + the serialize function to register + - - @function’s user_data + + @function’s user_data - - a function to call when @user_data is no longer needed + + a function to call when @user_data is no longer needed - - This function registers GTK+’s internal rich text serialization + + This function registers GTK+’s internal rich text serialization format with the passed @buffer. The internal format does not comply to any standard rich text format and only works between #GtkTextBuffer -instances. It is capable of serializing all of a text buffer’s tags +instances. It is capable of serializing all of a text buffer’s tags and embedded pixbufs. This function is just a wrapper around gtk_text_buffer_register_serialize_format(). The mime type used -for registering is “application/x-gtk-text-buffer-rich-text”, or -“application/x-gtk-text-buffer-rich-text;format=@tagset_name” if a +for registering is “application/x-gtk-text-buffer-rich-text”, or +“application/x-gtk-text-buffer-rich-text;format=@tagset_name” if a @tagset_name was passed. The @tagset_name can be used to restrict the transfer of rich text @@ -152915,37 +109271,25 @@ identifier != %NULL here, since the %NULL tagset requires the receiving buffer to deal with with pasting of arbitrary tags. - the #GdkAtom that corresponds to the - newly registered format’s mime-type. + the #GdkAtom that corresponds to the + newly registered format’s mime-type. - a #GtkTextBuffer + a #GtkTextBuffer - - an optional tagset name, on %NULL + + an optional tagset name, on %NULL - - Removes all tags in the range between @start and @end. Be careful + + Removes all tags in the range between @start and @end. Be careful with this function; it could remove tags added in code unrelated to -the code you’re currently writing. That is, using this function is +the code you’re currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags. @@ -152954,30 +109298,21 @@ that add tags. - a #GtkTextBuffer + a #GtkTextBuffer - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - - Removes a #GtkClipboard added with + + Removes a #GtkClipboard added with gtk_text_buffer_add_selection_clipboard(). @@ -152985,62 +109320,45 @@ gtk_text_buffer_add_selection_clipboard(). - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkClipboard added to @buffer by + a #GtkClipboard added to @buffer by gtk_text_buffer_add_selection_clipboard() - Emits the “remove-tag” signal. The default handler for the signal + Emits the “remove-tag” signal. The default handler for the signal removes all occurrences of @tag from the given range. @start and -@end don’t have to be in order. +@end don’t have to be in order. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextTag + a #GtkTextTag - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - - Calls gtk_text_tag_table_lookup() on the buffer’s tag table to + + Calls gtk_text_tag_table_lookup() on the buffer’s tag table to get a #GtkTextTag, then calls gtk_text_buffer_remove_tag(). @@ -153048,37 +109366,25 @@ get a #GtkTextTag, then calls gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer - name of a #GtkTextTag + name of a #GtkTextTag - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - - This function moves the “insert” and “selection_bound” marks + + This function moves the “insert” and “selection_bound” marks simultaneously. If you move them in two steps with gtk_text_buffer_move_mark(), you will temporarily select a region in between their old and new locations, which can be pretty @@ -153091,31 +109397,21 @@ be optimized. - a #GtkTextBuffer + a #GtkTextBuffer - where to put the “insert” mark + where to put the “insert” mark - where to put the “selection_bound” mark + where to put the “selection_bound” mark - - This function serializes the portion of text between @start + + This function serializes the portion of text between @start and @end in the rich text format represented by @format. @formats to be used must be registered using @@ -153123,9 +109419,7 @@ gtk_text_buffer_register_serialize_format() or gtk_text_buffer_register_serialize_tagset() beforehand. - the serialized + the serialized data, encoded as @format @@ -153133,50 +109427,33 @@ gtk_text_buffer_register_serialize_tagset() beforehand. - the #GtkTextBuffer @format is registered with + the #GtkTextBuffer @format is registered with - the #GtkTextBuffer to serialize + the #GtkTextBuffer to serialize - the rich text format to use for serializing + the rich text format to use for serializing - start of block of text to serialize + start of block of text to serialize - end of block of test to serialize + end of block of test to serialize - - return location for the length of the serialized data + + return location for the length of the serialized data - Used to keep track of whether the buffer has been modified since the + Used to keep track of whether the buffer has been modified since the last time it was saved. Whenever the buffer is saved to disk, call gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified, it will automatically toggled on the modified bit again. When the modified @@ -153187,23 +109464,17 @@ bit flips, the buffer emits the #GtkTextBuffer::modified-changed signal. - a #GtkTextBuffer + a #GtkTextBuffer - modification flag setting + modification flag setting - Deletes current contents of @buffer, and inserts @text instead. If + Deletes current contents of @buffer, and inserts @text instead. If @len is -1, @text must be nul-terminated. @text must be valid UTF-8. @@ -153211,31 +109482,21 @@ bit flips, the buffer emits the #GtkTextBuffer::modified-changed signal. - a #GtkTextBuffer + a #GtkTextBuffer - UTF-8 text to insert + UTF-8 text to insert - length of @text in bytes + length of @text in bytes - - This function unregisters a rich text format that was previously + + This function unregisters a rich text format that was previously registered using gtk_text_buffer_register_deserialize_format() or gtk_text_buffer_register_deserialize_tagset(). @@ -153244,25 +109505,17 @@ gtk_text_buffer_register_deserialize_tagset(). - a #GtkTextBuffer + a #GtkTextBuffer - a #GdkAtom representing a registered rich text format. + a #GdkAtom representing a registered rich text format. - - This function unregisters a rich text format that was previously + + This function unregisters a rich text format that was previously registered using gtk_text_buffer_register_serialize_format() or gtk_text_buffer_register_serialize_tagset() @@ -153271,66 +109524,40 @@ gtk_text_buffer_register_serialize_tagset() - a #GtkTextBuffer + a #GtkTextBuffer - a #GdkAtom representing a registered rich text format. + a #GdkAtom representing a registered rich text format. - - The list of targets this buffer supports for clipboard copying + + The list of targets this buffer supports for clipboard copying and as DND source. - - The position of the insert mark (as offset from the beginning + + The position of the insert mark (as offset from the beginning of the buffer). It is useful for getting notified when the cursor moves. - Whether the buffer has some text currently selected. + Whether the buffer has some text currently selected. - - The list of targets this buffer supports for clipboard pasting + + The list of targets this buffer supports for clipboard pasting and as DND destination. - + - - The text content of the buffer. Without child widgets and images, + + The text content of the buffer. Without child widgets and images, see gtk_text_buffer_get_text() for more information. @@ -153341,9 +109568,7 @@ see gtk_text_buffer_get_text() for more information. - The ::apply-tag signal is emitted to apply a tag to a + The ::apply-tag signal is emitted to apply a tag to a range of text in a #GtkTextBuffer. Applying actually occurs in the default handler. @@ -153359,29 +109584,21 @@ gtk_text_buffer_insert_range(). - the applied tag + the applied tag - the start of the range the tag is applied to + the start of the range the tag is applied to - the end of the range the tag is applied to + the end of the range the tag is applied to - The ::begin-user-action signal is emitted at the beginning of a single + The ::begin-user-action signal is emitted at the beginning of a single user-visible operation on a #GtkTextBuffer. See also: @@ -153396,18 +109613,14 @@ gtk_text_buffer_delete_selection(). - The ::changed signal is emitted when the content of a #GtkTextBuffer + The ::changed signal is emitted when the content of a #GtkTextBuffer has changed. - The ::delete-range signal is emitted to delete a range + The ::delete-range signal is emitted to delete a range from a #GtkTextBuffer. Note that if your handler runs before the default handler it must not @@ -153423,23 +109636,17 @@ See also: gtk_text_buffer_delete(). - the start of the range to be deleted + the start of the range to be deleted - the end of the range to be deleted + the end of the range to be deleted - The ::end-user-action signal is emitted at the end of a single + The ::end-user-action signal is emitted at the end of a single user-visible operation on the #GtkTextBuffer. See also: @@ -153455,9 +109662,7 @@ gtk_text_buffer_backspace(). - The ::insert-child-anchor signal is emitted to insert a + The ::insert-child-anchor signal is emitted to insert a #GtkTextChildAnchor in a #GtkTextBuffer. Insertion actually occurs in the default handler. @@ -153472,23 +109677,17 @@ See also: gtk_text_buffer_insert_child_anchor(). - position to insert @anchor in @textbuffer + position to insert @anchor in @textbuffer - the #GtkTextChildAnchor to be inserted + the #GtkTextChildAnchor to be inserted - The ::insert-pixbuf signal is emitted to insert a #GdkPixbuf + The ::insert-pixbuf signal is emitted to insert a #GdkPixbuf in a #GtkTextBuffer. Insertion actually occurs in the default handler. Note that if your handler runs before the default handler it must not @@ -153502,23 +109701,17 @@ See also: gtk_text_buffer_insert_pixbuf(). - position to insert @pixbuf in @textbuffer + position to insert @pixbuf in @textbuffer - the #GdkPixbuf to be inserted + the #GdkPixbuf to be inserted - The ::insert-text signal is emitted to insert text in a #GtkTextBuffer. + The ::insert-text signal is emitted to insert text in a #GtkTextBuffer. Insertion actually occurs in the default handler. Note that if your handler runs before the default handler it must not @@ -153534,29 +109727,21 @@ gtk_text_buffer_insert_range(). - position to insert @text in @textbuffer + position to insert @text in @textbuffer - the UTF-8 text to be inserted + the UTF-8 text to be inserted - length of the inserted text in bytes + length of the inserted text in bytes - The ::mark-deleted signal is emitted as notification + The ::mark-deleted signal is emitted as notification after a #GtkTextMark is deleted. See also: @@ -153566,17 +109751,13 @@ gtk_text_buffer_delete_mark(). - The mark that was deleted + The mark that was deleted - The ::mark-set signal is emitted as notification + The ::mark-set signal is emitted as notification after a #GtkTextMark is set. See also: @@ -153587,23 +109768,17 @@ gtk_text_buffer_move_mark(). - The location of @mark in @textbuffer + The location of @mark in @textbuffer - The mark that is set + The mark that is set - The ::modified-changed signal is emitted when the modified bit of a + The ::modified-changed signal is emitted when the modified bit of a #GtkTextBuffer flips. See also: @@ -153613,9 +109788,7 @@ gtk_text_buffer_set_modified(). - The paste-done signal is emitted after paste operation has been completed. + The paste-done signal is emitted after paste operation has been completed. This is useful to properly scroll the view to the end of the pasted text. See gtk_text_buffer_paste_clipboard() for more details. @@ -153623,17 +109796,13 @@ See gtk_text_buffer_paste_clipboard() for more details. - the #GtkClipboard pasted from + the #GtkClipboard pasted from - The ::remove-tag signal is emitted to remove all occurrences of @tag from + The ::remove-tag signal is emitted to remove all occurrences of @tag from a range of text in a #GtkTextBuffer. Removal actually occurs in the default handler. @@ -153647,34 +109816,24 @@ gtk_text_buffer_remove_tag(). - the tag to be removed + the tag to be removed - the start of the range the tag is removed from + the start of the range the tag is removed from - the end of the range the tag is removed from + the end of the range the tag is removed from - + - The object class structure needs to be the first. + The object class structure needs to be the first. @@ -153707,21 +109866,15 @@ gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the pixbuf + location to insert the pixbuf - a #GdkPixbuf + a #GdkPixbuf @@ -153735,21 +109888,15 @@ gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer - location to insert the anchor + location to insert the anchor - a #GtkTextChildAnchor + a #GtkTextChildAnchor @@ -153843,27 +109990,19 @@ gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextTag + a #GtkTextTag - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged @@ -153877,27 +110016,19 @@ gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextTag + a #GtkTextTag - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged @@ -153911,9 +110042,7 @@ gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer @@ -153927,9 +110056,7 @@ gtk_text_buffer_remove_tag(). - a #GtkTextBuffer + a #GtkTextBuffer @@ -153984,203 +110111,123 @@ gtk_text_buffer_remove_tag(). - - A function that is called to deserialize rich text that has been + + A function that is called to deserialize rich text that has been serialized with gtk_text_buffer_serialize(), and insert it at @iter. - %TRUE on success, %FALSE otherwise + %TRUE on success, %FALSE otherwise - the #GtkTextBuffer the format is registered with + the #GtkTextBuffer the format is registered with - the #GtkTextBuffer to deserialize into + the #GtkTextBuffer to deserialize into - insertion point for the deserialized text + insertion point for the deserialized text - data to deserialize + data to deserialize - length of @data + length of @data - %TRUE if deserializing may create tags + %TRUE if deserializing may create tags - - user data that was specified when registering the format + + user data that was specified when registering the format - + - - A function that is called to serialize the content of a text buffer. + + A function that is called to serialize the content of a text buffer. It must return the serialized form of the content. - a newly-allocated array of guint8 which contains + a newly-allocated array of guint8 which contains the serialized data, or %NULL if an error occurred - the #GtkTextBuffer for which the format is registered + the #GtkTextBuffer for which the format is registered - the #GtkTextBuffer to serialize + the #GtkTextBuffer to serialize - start of the block of text to serialize + start of the block of text to serialize - end of the block of text to serialize + end of the block of text to serialize - Return location for the length of the serialized data + Return location for the length of the serialized data - - user data that was specified when registering the format + + user data that was specified when registering the format - - These values are used as “info” for the targets contained in the + + These values are used as “info” for the targets contained in the lists returned by gtk_text_buffer_get_copy_target_list() and gtk_text_buffer_get_paste_target_list(). The values counts down from `-1` to avoid clashes with application added drag destinations which usually start at 0. - - Buffer contents + + Buffer contents - - Rich text + + Rich text - - Text + + Text - + - + - + - + - + - + @@ -154192,89 +110239,59 @@ with application added drag destinations which usually start at 0. - + - - A #GtkTextChildAnchor is a spot in the buffer where child widgets can -be “anchored” (inserted inline, as if they were characters). The anchor + + A #GtkTextChildAnchor is a spot in the buffer where child widgets can +be “anchored” (inserted inline, as if they were characters). The anchor can have multiple widgets anchored, to allow for multiple views. - Creates a new #GtkTextChildAnchor. Usually you would then insert + Creates a new #GtkTextChildAnchor. Usually you would then insert it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor(). To perform the creation and insertion in one step, use the convenience function gtk_text_buffer_create_child_anchor(). - a new #GtkTextChildAnchor + a new #GtkTextChildAnchor - - Determines whether a child anchor has been deleted from + + Determines whether a child anchor has been deleted from the buffer. Keep in mind that the child anchor will be unreferenced when removed from the buffer, so you need to hold your own reference (with g_object_ref()) if you plan -to use this function — otherwise all deleted child anchors +to use this function — otherwise all deleted child anchors will also be finalized. - %TRUE if the child anchor has been deleted from its buffer + %TRUE if the child anchor has been deleted from its buffer - a #GtkTextChildAnchor + a #GtkTextChildAnchor - - Gets a list of all widgets anchored at this child anchor. + + Gets a list of all widgets anchored at this child anchor. The returned list should be freed with g_list_free(). - list of widgets anchored at @anchor + list of widgets anchored at @anchor - a #GtkTextChildAnchor + a #GtkTextChildAnchor @@ -154286,9 +110303,7 @@ The returned list should be freed with g_list_free(). - + @@ -154326,74 +110341,32 @@ The returned list should be freed with g_list_free(). - - Reading directions for text. - - No direction. + + Reading directions for text. + + No direction. - - Left to right text direction. + + Left to right text direction. - - Right to left text direction. + + Right to left text direction. - - Granularity types that extend the text selection. Use the + + Granularity types that extend the text selection. Use the #GtkTextView::extend-selection signal to customize the selection. - - Selects the current word. It is triggered by + + Selects the current word. It is triggered by a double-click for example. - - Selects the current line. It is triggered by + + Selects the current line. It is triggered by a triple-click for example. - - You may wish to begin by reading the + + You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together. @@ -154441,9 +110414,7 @@ types related to the text widget and how they work together. - Assigns the value of @other to @iter. This function + Assigns the value of @other to @iter. This function is not useful in applications, because iterators can be assigned with `GtkTextIter i = j;`. The function is used by language bindings. @@ -154453,175 +110424,116 @@ function is used by language bindings. - a #GtkTextIter + a #GtkTextIter - another #GtkTextIter + another #GtkTextIter - Moves backward by one character offset. Returns %TRUE if movement + Moves backward by one character offset. Returns %TRUE if movement was possible; if @iter was the first in the buffer (character offset 0), gtk_text_iter_backward_char() returns %FALSE for convenience when writing loops. - whether movement was possible + whether movement was possible - an iterator + an iterator - - Moves @count characters backward, if possible (if @count would move + + Moves @count characters backward, if possible (if @count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved -onto a dereferenceable position; if the iterator didn’t move, or +onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - an iterator + an iterator - number of characters to move + number of characters to move - - Like gtk_text_iter_forward_cursor_position(), but moves backward. + + Like gtk_text_iter_forward_cursor_position(), but moves backward. - %TRUE if we moved + %TRUE if we moved - a #GtkTextIter + a #GtkTextIter - - Moves up to @count cursor positions. See + + Moves up to @count cursor positions. See gtk_text_iter_forward_cursor_position() for details. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of positions to move + number of positions to move - - Same as gtk_text_iter_forward_find_char(), but goes backward from @iter. + + Same as gtk_text_iter_forward_find_char(), but goes backward from @iter. - whether a match was found + whether a match was found - a #GtkTextIter + a #GtkTextIter - - function to be called on each character + + function to be called on each character - - user data for @pred + + user data for @pred - - search limit, or %NULL for none + + search limit, or %NULL for none - Moves @iter to the start of the previous line. Returns %TRUE if + Moves @iter to the start of the previous line. Returns %TRUE if @iter could be moved; i.e. if @iter was at character offset 0, this function returns %FALSE. Therefore if @iter was already on line 0, but not at the start of the line, @iter is snapped to the start of @@ -154630,179 +110542,117 @@ in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) - whether @iter moved + whether @iter moved - an iterator + an iterator - - Moves @count lines backward, if possible (if @count would move + + Moves @count lines backward, if possible (if @count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved -onto a dereferenceable position; if the iterator didn’t move, or +onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves forward by 0 - @count lines. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of lines to move backward + number of lines to move backward - - Same as gtk_text_iter_forward_search(), but moves backward. + + Same as gtk_text_iter_forward_search(), but moves backward. @match_end will never be set to a #GtkTextIter located after @iter, even if there is a possible @match_start before or at @iter. - whether a match was found + whether a match was found - a #GtkTextIter where the search begins + a #GtkTextIter where the search begins - search string + search string - bitmask of flags affecting the search + bitmask of flags affecting the search - - return location for start of match, or %NULL + + return location for start of match, or %NULL - - return location for end of match, or %NULL + + return location for end of match, or %NULL - - location of last possible @match_start, or %NULL for start of buffer + + location of last possible @match_start, or %NULL for start of buffer - - Moves backward to the previous sentence start; if @iter is already at + + Moves backward to the previous sentence start; if @iter is already at the start of a sentence, moves backward to the next one. Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Calls gtk_text_iter_backward_sentence_start() up to @count times, + + Calls gtk_text_iter_backward_sentence_start() up to @count times, or until it returns %FALSE. If @count is negative, moves forward instead of backward. - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - number of sentences to move + number of sentences to move - - Moves backward to the next toggle (on or off) of the + + Moves backward to the next toggle (on or off) of the #GtkTextTag @tag, or to the next toggle of any tag if @tag is %NULL. If no matching tag toggles are found, returns %FALSE, otherwise %TRUE. Does not return toggles @@ -154811,87 +110661,56 @@ to the location of the toggle, or the start of the buffer if no toggle is found. - whether we found a tag toggle before @iter + whether we found a tag toggle before @iter - a #GtkTextIter + a #GtkTextIter - - a #GtkTextTag, or %NULL + + a #GtkTextTag, or %NULL - - Moves @iter forward to the previous visible cursor position. See + + Moves @iter forward to the previous visible cursor position. See gtk_text_iter_backward_cursor_position() for details. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - - Moves up to @count visible cursor positions. See + + Moves up to @count visible cursor positions. See gtk_text_iter_backward_cursor_position() for details. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of positions to move + number of positions to move - - Moves @iter to the start of the previous visible line. Returns %TRUE if + + Moves @iter to the start of the previous visible line. Returns %TRUE if @iter could be moved; i.e. if @iter was at character offset 0, this function returns %FALSE. Therefore if @iter was already on line 0, but not at the start of the line, @iter is snapped to the start of @@ -154900,167 +110719,114 @@ in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) - whether @iter moved + whether @iter moved - an iterator + an iterator - - Moves @count visible lines backward, if possible (if @count would move + + Moves @count visible lines backward, if possible (if @count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved -onto a dereferenceable position; if the iterator didn’t move, or +onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves forward by 0 - @count lines. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of lines to move backward + number of lines to move backward - - Moves backward to the previous visible word start. (If @iter is currently + + Moves backward to the previous visible word start. (If @iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Calls gtk_text_iter_backward_visible_word_start() up to @count times. + + Calls gtk_text_iter_backward_visible_word_start() up to @count times. - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - number of times to move + number of times to move - - Moves backward to the previous word start. (If @iter is currently on a + + Moves backward to the previous word start. (If @iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Calls gtk_text_iter_backward_word_start() up to @count times. + + Calls gtk_text_iter_backward_word_start() up to @count times. - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - number of times to move + number of times to move - - Returns %TRUE if @tag is toggled on at exactly this point. If @tag + + Returns %TRUE if @tag is toggled on at exactly this point. If @tag is %NULL, returns %TRUE if any tag is toggled on at this point. Note that if gtk_text_iter_begins_tag() returns %TRUE, it means that @iter is @@ -155072,33 +110838,22 @@ parameters. Use gtk_text_iter_starts_tag() instead. - whether @iter is the start of a range tagged with @tag + whether @iter is the start of a range tagged with @tag - an iterator + an iterator - - a #GtkTextTag, or %NULL + + a #GtkTextTag, or %NULL - Considering the default editability of the buffer, and tags that + Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at @iter would be editable. If text inserted at @iter would be editable then the user should be allowed to insert text at @iter. @@ -155106,119 +110861,89 @@ gtk_text_buffer_insert_interactive() uses this function to decide whether insertions are allowed at a given position. - whether text inserted at @iter would be editable + whether text inserted at @iter would be editable - an iterator + an iterator - %TRUE if text is editable by default + %TRUE if text is editable by default - A qsort()-style function that returns negative if @lhs is less than -@rhs, positive if @lhs is greater than @rhs, and 0 if they’re equal. + A qsort()-style function that returns negative if @lhs is less than +@rhs, positive if @lhs is greater than @rhs, and 0 if they’re equal. Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer. - -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal + -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal - a #GtkTextIter + a #GtkTextIter - another #GtkTextIter + another #GtkTextIter - Creates a dynamically-allocated copy of an iterator. This function + Creates a dynamically-allocated copy of an iterator. This function is not useful in applications, because iterators can be copied with a simple assignment (`GtkTextIter i = j;`). The function is used by language bindings. - a copy of the @iter, free with gtk_text_iter_free() + a copy of the @iter, free with gtk_text_iter_free() - an iterator + an iterator - Returns whether the character at @iter is within an editable region -of text. Non-editable text is “locked” and can’t be changed by the + Returns whether the character at @iter is within an editable region +of text. Non-editable text is “locked” and can’t be changed by the user via #GtkTextView. This function is simply a convenience wrapper around gtk_text_iter_get_attributes(). If no tags applied to this text affect editability, @default_setting will be returned. -You don’t want to use this function to decide whether text can be -inserted at @iter, because for insertion you don’t want to know +You don’t want to use this function to decide whether text can be +inserted at @iter, because for insertion you don’t want to know whether the char at @iter is inside an editable range, you want to know whether a new character inserted at @iter would be inside an editable range. Use gtk_text_iter_can_insert() to handle this case. - whether @iter is inside an editable range + whether @iter is inside an editable range - an iterator + an iterator - %TRUE if text is editable by default + %TRUE if text is editable by default - Returns %TRUE if @iter points to the start of the paragraph + Returns %TRUE if @iter points to the start of the paragraph delimiter characters for a line (delimiters will be either a newline, a carriage return, a carriage return followed by a newline, or a Unicode paragraph separator character). Note that an @@ -155228,47 +110953,35 @@ considered to be at the end of a line, even though there are no paragraph delimiter chars there. - whether @iter is at the end of a line + whether @iter is at the end of a line - an iterator + an iterator - Determines whether @iter ends a sentence. Sentence boundaries are + Determines whether @iter ends a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). - %TRUE if @iter is at the end of a sentence. + %TRUE if @iter is at the end of a sentence. - a #GtkTextIter + a #GtkTextIter - Returns %TRUE if @tag is toggled off at exactly this point. If @tag + Returns %TRUE if @tag is toggled off at exactly this point. If @tag is %NULL, returns %TRUE if any tag is toggled off at this point. Note that if gtk_text_iter_ends_tag() returns %TRUE, it means that @iter is @@ -155278,86 +110991,61 @@ unlike gtk_text_iter_starts_tag(), if gtk_text_iter_ends_tag() returns %TRUE, gtk_text_iter_has_tag() will return %FALSE for the same parameters. - whether @iter is the end of a range tagged with @tag + whether @iter is the end of a range tagged with @tag - an iterator + an iterator - - a #GtkTextTag, or %NULL + + a #GtkTextTag, or %NULL - Determines whether @iter ends a natural-language word. Word breaks + Determines whether @iter ends a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). - %TRUE if @iter is at the end of a word + %TRUE if @iter is at the end of a word - a #GtkTextIter + a #GtkTextIter - Tests whether two iterators are equal, using the fastest possible + Tests whether two iterators are equal, using the fastest possible mechanism. This function is very fast; you can expect it to perform better than e.g. getting the character offset for each iterator and -comparing the offsets yourself. Also, it’s a bit faster than +comparing the offsets yourself. Also, it’s a bit faster than gtk_text_iter_compare(). - %TRUE if the iterators point to the same place in the buffer + %TRUE if the iterators point to the same place in the buffer - a #GtkTextIter + a #GtkTextIter - another #GtkTextIter + another #GtkTextIter - Moves @iter forward by one character offset. Note that images + Moves @iter forward by one character offset. Note that images embedded in the buffer occupy 1 character slot, so gtk_text_iter_forward_char() may actually move onto an image instead of a character, if you have images in your buffer. If @iter is the @@ -155366,24 +111054,18 @@ the end iterator, and gtk_text_iter_forward_char() returns %FALSE for convenience when writing loops. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - an iterator + an iterator - Moves @count characters if possible (if @count would move past the + Moves @count characters if possible (if @count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the new position of @iter is different from its original position, and dereferenceable @@ -155391,195 +111073,134 @@ buffer). The return value indicates whether the new position of is 0, the function does nothing and returns %FALSE. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - an iterator + an iterator - number of characters to move, may be negative + number of characters to move, may be negative - - Moves @iter forward by a single cursor position. Cursor positions + + Moves @iter forward by a single cursor position. Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be a cursor position between all characters. The most common example for European languages would be a carriage return/newline sequence. For some Unicode characters, -the equivalent of say the letter “a” with an accent mark will be +the equivalent of say the letter “a” with an accent mark will be represented as two characters, first the letter then a "combining -mark" that causes the accent to be rendered; so the cursor can’t go +mark" that causes the accent to be rendered; so the cursor can’t go between those two characters. See also the #PangoLogAttr-struct and pango_break() function. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - - Moves up to @count cursor positions. See + + Moves up to @count cursor positions. See gtk_text_iter_forward_cursor_position() for details. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of positions to move + number of positions to move - - Advances @iter, calling @pred on each character. If + + Advances @iter, calling @pred on each character. If @pred returns %TRUE, returns %TRUE and stops scanning. If @pred never returns %TRUE, @iter is set to @limit if @limit is non-%NULL, otherwise to the end iterator. - whether a match was found + whether a match was found - a #GtkTextIter + a #GtkTextIter - - a function to be called on each character + + a function to be called on each character - - user data for @pred + + user data for @pred - - search limit, or %NULL for none + + search limit, or %NULL for none - Moves @iter to the start of the next line. If the iter is already on the + Moves @iter to the start of the next line. If the iter is already on the last line of the buffer, moves the iter to the end of the current line. If after the operation, the iter is at the end of the buffer and not dereferencable, returns %FALSE. Otherwise, returns %TRUE. - whether @iter can be dereferenced + whether @iter can be dereferenced - an iterator + an iterator - Moves @count lines forward, if possible (if @count would move + Moves @count lines forward, if possible (if @count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved -onto a dereferenceable position; if the iterator didn’t move, or +onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves backward by 0 - @count lines. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of lines to move forward + number of lines to move forward - - Searches forward for @str. Any match is returned by setting + + Searches forward for @str. Any match is returned by setting @match_start to the first character of the match and @match_end to the first character after the match. The search will not continue past @limit. Note that a search is a linear or O(n) operation, so you @@ -155590,122 +111211,76 @@ buffers. there is a possible @match_end after or at @iter. - whether a match was found + whether a match was found - start of search + start of search - a search string + a search string - flags affecting how the search is done + flags affecting how the search is done - - return location for start of match, or %NULL + + return location for start of match, or %NULL - - return location for end of match, or %NULL + + return location for end of match, or %NULL - - location of last possible @match_end, or %NULL for the end of the buffer + + location of last possible @match_end, or %NULL for the end of the buffer - - Moves forward to the next sentence end. (If @iter is at the end of + + Moves forward to the next sentence end. (If @iter is at the end of a sentence, moves to the next end of sentence.) Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Calls gtk_text_iter_forward_sentence_end() @count times (or until + + Calls gtk_text_iter_forward_sentence_end() @count times (or until gtk_text_iter_forward_sentence_end() returns %FALSE). If @count is negative, moves backward instead of forward. - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - number of sentences to move + number of sentences to move - - Moves @iter forward to the “end iterator,” which points one past the last + + Moves @iter forward to the “end iterator,” which points one past the last valid character in the buffer. gtk_text_iter_get_char() called on the end iterator returns 0, which is convenient for writing loops. @@ -155714,18 +111289,13 @@ end iterator returns 0, which is convenient for writing loops. - a #GtkTextIter + a #GtkTextIter - - Moves the iterator to point to the paragraph delimiter characters, + + Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator character. If the iterator is already at the paragraph delimiter @@ -155735,25 +111305,18 @@ not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns %FALSE. - %TRUE if we moved and the new location is not the end iterator + %TRUE if we moved and the new location is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Moves forward to the next toggle (on or off) of the + + Moves forward to the next toggle (on or off) of the #GtkTextTag @tag, or to the next toggle of any tag if @tag is %NULL. If no matching tag toggles are found, returns %FALSE, otherwise %TRUE. Does not return toggles @@ -155762,250 +111325,169 @@ the location of the toggle, or to the end of the buffer if no toggle is found. - whether we found a tag toggle after @iter + whether we found a tag toggle after @iter - a #GtkTextIter + a #GtkTextIter - - a #GtkTextTag, or %NULL + + a #GtkTextTag, or %NULL - - Moves @iter forward to the next visible cursor position. See + + Moves @iter forward to the next visible cursor position. See gtk_text_iter_forward_cursor_position() for details. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - - Moves up to @count visible cursor positions. See + + Moves up to @count visible cursor positions. See gtk_text_iter_forward_cursor_position() for details. - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of positions to move + number of positions to move - - Moves @iter to the start of the next visible line. Returns %TRUE if there + + Moves @iter to the start of the next visible line. Returns %TRUE if there was a next line to move to, and %FALSE if @iter was simply moved to the end of the buffer and is now not dereferenceable, or if @iter was already at the end of the buffer. - whether @iter can be dereferenced + whether @iter can be dereferenced - an iterator + an iterator - - Moves @count visible lines forward, if possible (if @count would move + + Moves @count visible lines forward, if possible (if @count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved -onto a dereferenceable position; if the iterator didn’t move, or +onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves backward by 0 - @count lines. - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a #GtkTextIter + a #GtkTextIter - number of lines to move forward + number of lines to move forward - - Moves forward to the next visible word end. (If @iter is currently on a + + Moves forward to the next visible word end. (If @iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Calls gtk_text_iter_forward_visible_word_end() up to @count times. + + Calls gtk_text_iter_forward_visible_word_end() up to @count times. - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - number of times to move + number of times to move - - Moves forward to the next word end. (If @iter is currently on a + + Moves forward to the next word end. (If @iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - - Calls gtk_text_iter_forward_word_end() up to @count times. + + Calls gtk_text_iter_forward_word_end() up to @count times. - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a #GtkTextIter + a #GtkTextIter - number of times to move + number of times to move - Free an iterator allocated on the heap. This function + Free an iterator allocated on the heap. This function is intended for use in language bindings, and is not especially useful for applications, because iterators can simply be allocated on the stack. @@ -156015,20 +111497,15 @@ simply be allocated on the stack. - a dynamically-allocated iterator + a dynamically-allocated iterator - - Computes the effect of any tags applied to this spot in the + + Computes the effect of any tags applied to this spot in the text. The @values parameter should be initialized to the default -settings you wish to use if no tags are in effect. You’d typically +settings you wish to use if no tags are in effect. You’d typically obtain the defaults from gtk_text_view_get_default_attributes(). gtk_text_iter_get_attributes() will modify @values, applying the @@ -156036,312 +111513,224 @@ effects of any tags present at @iter. If any tags affected @values, the function returns %TRUE. - %TRUE if @values was modified + %TRUE if @values was modified - an iterator + an iterator - - a #GtkTextAttributes to be filled in + + a #GtkTextAttributes to be filled in - Returns the #GtkTextBuffer this iterator is associated with. + Returns the #GtkTextBuffer this iterator is associated with. - the buffer + the buffer - an iterator + an iterator - - Returns the number of bytes in the line containing @iter, + + Returns the number of bytes in the line containing @iter, including the paragraph delimiters. - number of bytes in the line + number of bytes in the line - an iterator + an iterator - The Unicode character at this iterator is returned. (Equivalent to + The Unicode character at this iterator is returned. (Equivalent to operator* on a C++ iterator.) If the element at this iterator is a non-character element, such as an image embedded in the buffer, the -Unicode “unknown” character 0xFFFC is returned. If invoked on +Unicode “unknown” character 0xFFFC is returned. If invoked on the end iterator, zero is returned; zero is not a valid Unicode character. So you can write a loop which ends when gtk_text_iter_get_char() returns 0. - a Unicode character, or 0 if @iter is not dereferenceable + a Unicode character, or 0 if @iter is not dereferenceable - an iterator + an iterator - - Returns the number of characters in the line containing @iter, + + Returns the number of characters in the line containing @iter, including the paragraph delimiters. - number of characters in the line + number of characters in the line - an iterator + an iterator - - If the location at @iter contains a child anchor, the + + If the location at @iter contains a child anchor, the anchor is returned (with no new reference count added). Otherwise, %NULL is returned. - the anchor at @iter + the anchor at @iter - an iterator + an iterator - A convenience wrapper around gtk_text_iter_get_attributes(), + A convenience wrapper around gtk_text_iter_get_attributes(), which returns the language in effect at @iter. If no tags affecting language apply to @iter, the return value is identical to that of gtk_get_default_language(). - language in effect at @iter + language in effect at @iter - an iterator + an iterator - Returns the line number containing the iterator. Lines in + Returns the line number containing the iterator. Lines in a #GtkTextBuffer are numbered beginning with 0 for the first line in the buffer. - a line number + a line number - an iterator + an iterator - - Returns the byte index of the iterator, counting + + Returns the byte index of the iterator, counting from the start of a newline-terminated line. Remember that #GtkTextBuffer encodes text in UTF-8, and that characters can require a variable number of bytes to represent. - distance from start of line, in bytes + distance from start of line, in bytes - an iterator + an iterator - - Returns the character offset of the iterator, + + Returns the character offset of the iterator, counting from the start of a newline-terminated line. The first character on the line has offset 0. - offset from start of line + offset from start of line - an iterator + an iterator - Returns a list of all #GtkTextMark at this location. Because marks -are not iterable (they don’t take up any "space" in the buffer, + Returns a list of all #GtkTextMark at this location. Because marks +are not iterable (they don’t take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order. - list of #GtkTextMark + list of #GtkTextMark - an iterator + an iterator - Returns the character offset of an iterator. + Returns the character offset of an iterator. Each character in a #GtkTextBuffer has an offset, starting with 0 for the first character in the buffer. Use gtk_text_buffer_get_iter_at_offset() to convert an offset back into an iterator. - a character offset + a character offset - an iterator + an iterator - If the element at @iter is a pixbuf, the pixbuf is returned + If the element at @iter is a pixbuf, the pixbuf is returned (with no new reference count added). Otherwise, %NULL is returned. - the pixbuf at @iter + the pixbuf at @iter - an iterator + an iterator - Returns the text in the given range. A “slice” is an array of -characters encoded in UTF-8 format, including the Unicode “unknown” + Returns the text in the given range. A “slice” is an array of +characters encoded in UTF-8 format, including the Unicode “unknown” character 0xFFFC for iterable non-character elements in the buffer, such as images. Because images are encoded in the slice, byte and character offsets in the returned array will correspond to byte @@ -156350,86 +111739,63 @@ text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer. - slice of text from the buffer + slice of text from the buffer - iterator at start of a range + iterator at start of a range - iterator at end of a range + iterator at end of a range - Returns a list of tags that apply to @iter, in ascending order of + Returns a list of tags that apply to @iter, in ascending order of priority (highest-priority tags are last). The #GtkTextTag in the -list don’t have a reference added, but you have to free the list +list don’t have a reference added, but you have to free the list itself. - list of #GtkTextTag + list of #GtkTextTag - a #GtkTextIter + a #GtkTextIter - Returns text in the given range. If the range + Returns text in the given range. If the range contains non-text elements such as images, the character and byte offsets in the returned string will not correspond to character and byte offsets in the buffer. If you want offsets to correspond, see gtk_text_iter_get_slice(). - array of characters from the buffer + array of characters from the buffer - iterator at start of a range + iterator at start of a range - iterator at end of a range + iterator at end of a range - - Returns a list of #GtkTextTag that are toggled on or off at this + + Returns a list of #GtkTextTag that are toggled on or off at this point. (If @toggled_on is %TRUE, the list contains tags that are toggled on.) If a tag is toggled on at @iter, then some non-empty range of characters following @iter has that tag applied to it. If @@ -156437,224 +111803,159 @@ a tag is toggled off, then some non-empty range following @iter does not have the tag applied to it. - tags toggled at this point + tags toggled at this point - an iterator + an iterator - %TRUE to get toggled-on tags + %TRUE to get toggled-on tags - - Returns the number of bytes from the start of the + + Returns the number of bytes from the start of the line to the given @iter, not counting bytes that -are invisible due to tags with the “invisible” flag +are invisible due to tags with the “invisible” flag toggled on. - byte index of @iter with respect to the start of the line + byte index of @iter with respect to the start of the line - a #GtkTextIter + a #GtkTextIter - - Returns the offset in characters from the start of the + + Returns the offset in characters from the start of the line to the given @iter, not counting characters that -are invisible due to tags with the “invisible” flag +are invisible due to tags with the “invisible” flag toggled on. - offset in visible characters from the start of the line + offset in visible characters from the start of the line - a #GtkTextIter + a #GtkTextIter - - Like gtk_text_iter_get_slice(), but invisible text is not included. + + Like gtk_text_iter_get_slice(), but invisible text is not included. Invisible text is usually invisible because a #GtkTextTag with the -“invisible” attribute turned on has been applied to it. +“invisible” attribute turned on has been applied to it. - slice of text from the buffer + slice of text from the buffer - iterator at start of range + iterator at start of range - iterator at end of range + iterator at end of range - - Like gtk_text_iter_get_text(), but invisible text is not included. + + Like gtk_text_iter_get_text(), but invisible text is not included. Invisible text is usually invisible because a #GtkTextTag with the -“invisible” attribute turned on has been applied to it. +“invisible” attribute turned on has been applied to it. - string containing visible text in the + string containing visible text in the range - iterator at start of range + iterator at start of range - iterator at end of range + iterator at end of range - Returns %TRUE if @iter points to a character that is part of a range tagged + Returns %TRUE if @iter points to a character that is part of a range tagged with @tag. See also gtk_text_iter_starts_tag() and gtk_text_iter_ends_tag(). - whether @iter is tagged with @tag + whether @iter is tagged with @tag - an iterator + an iterator - a #GtkTextTag + a #GtkTextTag - Checks whether @iter falls in the range [@start, @end). + Checks whether @iter falls in the range [@start, @end). @start and @end must be in ascending order. - %TRUE if @iter is in the range + %TRUE if @iter is in the range - a #GtkTextIter + a #GtkTextIter - start of range + start of range - end of range + end of range - - Determines whether @iter is inside a sentence (as opposed to in + + Determines whether @iter is inside a sentence (as opposed to in between two sentences, e.g. after a period and before the first letter of the next sentence). Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). - %TRUE if @iter is inside a sentence. + %TRUE if @iter is inside a sentence. - a #GtkTextIter + a #GtkTextIter - Determines whether the character pointed by @iter is part of a + Determines whether the character pointed by @iter is part of a natural-language word (as opposed to say inside some whitespace). Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). @@ -156663,93 +111964,68 @@ Note that if gtk_text_iter_starts_word() returns %TRUE, then this function returns %TRUE too, since @iter points to the first character of the word. - %TRUE if @iter is inside a word + %TRUE if @iter is inside a word - a #GtkTextIter + a #GtkTextIter - - See gtk_text_iter_forward_cursor_position() or #PangoLogAttr or + + See gtk_text_iter_forward_cursor_position() or #PangoLogAttr or pango_break() for details on what a cursor position is. - %TRUE if the cursor can be placed at @iter + %TRUE if the cursor can be placed at @iter - a #GtkTextIter + a #GtkTextIter - Returns %TRUE if @iter is the end iterator, i.e. one past the last + Returns %TRUE if @iter is the end iterator, i.e. one past the last dereferenceable iterator in the buffer. gtk_text_iter_is_end() is the most efficient way to check whether an iterator is the end iterator. - whether @iter is the end iterator + whether @iter is the end iterator - an iterator + an iterator - Returns %TRUE if @iter is the first iterator in the buffer, that is + Returns %TRUE if @iter is the first iterator in the buffer, that is if @iter has a character offset of 0. - whether @iter is the first in the buffer + whether @iter is the first in the buffer - an iterator + an iterator - Swaps the value of @first and @second if @second comes before + Swaps the value of @first and @second if @second comes before @first in the buffer. That is, ensures that @first and @second are in sequence. Most text buffer functions that take a range call this -automatically on your behalf, so there’s no real reason to call it yourself +automatically on your behalf, so there’s no real reason to call it yourself in those cases. There are some exceptions, such as gtk_text_iter_in_range(), that expect a pre-sorted range. @@ -156758,23 +112034,17 @@ that expect a pre-sorted range. - a #GtkTextIter + a #GtkTextIter - another #GtkTextIter + another #GtkTextIter - Moves iterator @iter to the start of the line @line_number. If + Moves iterator @iter to the start of the line @line_number. If @line_number is negative or larger than the number of lines in the buffer, moves @iter to the start of the last line in the buffer. @@ -156783,26 +112053,19 @@ buffer, moves @iter to the start of the last line in the buffer. - a #GtkTextIter + a #GtkTextIter - line number (counted from 0) + line number (counted from 0) - - Same as gtk_text_iter_set_line_offset(), but works with a + + Same as gtk_text_iter_set_line_offset(), but works with a byte index. The given byte index must be at -the start of a character, it can’t be in the middle of a UTF-8 +the start of a character, it can’t be in the middle of a UTF-8 encoded character. @@ -156810,24 +112073,17 @@ encoded character. - a #GtkTextIter + a #GtkTextIter - a byte index relative to the start of @iter’s current line + a byte index relative to the start of @iter’s current line - - Moves @iter within a line, to a new character + + Moves @iter within a line, to a new character (not byte) offset. The given character offset must be less than or equal to the number of characters in the line; if equal, @iter moves to the start of the next line. See @@ -156839,23 +112095,17 @@ a character offset. - a #GtkTextIter + a #GtkTextIter - a character offset relative to the start of @iter’s current line + a character offset relative to the start of @iter’s current line - Sets @iter to point to @char_offset. @char_offset counts from the start + Sets @iter to point to @char_offset. @char_offset counts from the start of the entire text buffer, starting with 0. @@ -156863,24 +112113,17 @@ of the entire text buffer, starting with 0. - a #GtkTextIter + a #GtkTextIter - a character number + a character number - - Like gtk_text_iter_set_line_index(), but the index is in visible + + Like gtk_text_iter_set_line_index(), but the index is in visible bytes, i.e. text with a tag making it invisible is not counted in the index. @@ -156889,24 +112132,17 @@ in the index. - a #GtkTextIter + a #GtkTextIter - a byte index + a byte index - - Like gtk_text_iter_set_line_offset(), but the offset is in visible + + Like gtk_text_iter_set_line_offset(), but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset. @@ -156915,73 +112151,52 @@ counted in the offset. - a #GtkTextIter + a #GtkTextIter - a character offset + a character offset - Returns %TRUE if @iter begins a paragraph, + Returns %TRUE if @iter begins a paragraph, i.e. if gtk_text_iter_get_line_offset() would return 0. However this function is potentially more efficient than -gtk_text_iter_get_line_offset() because it doesn’t have to compute -the offset, it just has to see whether it’s 0. +gtk_text_iter_get_line_offset() because it doesn’t have to compute +the offset, it just has to see whether it’s 0. - whether @iter begins a line + whether @iter begins a line - an iterator + an iterator - - Determines whether @iter begins a sentence. Sentence boundaries are + + Determines whether @iter begins a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). - %TRUE if @iter is at the start of a sentence. + %TRUE if @iter is at the start of a sentence. - a #GtkTextIter + a #GtkTextIter - - Returns %TRUE if @tag is toggled on at exactly this point. If @tag + + Returns %TRUE if @tag is toggled on at exactly this point. If @tag is %NULL, returns %TRUE if any tag is toggled on at this point. Note that if gtk_text_iter_starts_tag() returns %TRUE, it means that @iter is @@ -156992,94 +112207,60 @@ words, unlike gtk_text_iter_ends_tag(), if gtk_text_iter_starts_tag() returns parameters. - whether @iter is the start of a range tagged with @tag + whether @iter is the start of a range tagged with @tag - an iterator + an iterator - - a #GtkTextTag, or %NULL + + a #GtkTextTag, or %NULL - Determines whether @iter begins a natural-language word. Word + Determines whether @iter begins a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). - %TRUE if @iter is at the start of a word + %TRUE if @iter is at the start of a word - a #GtkTextIter + a #GtkTextIter - This is equivalent to (gtk_text_iter_starts_tag() || + This is equivalent to (gtk_text_iter_starts_tag() || gtk_text_iter_ends_tag()), i.e. it tells you whether a range with @tag applied to it begins or ends at @iter. - whether @tag is toggled on or off at @iter + whether @tag is toggled on or off at @iter - an iterator + an iterator - - a #GtkTextTag, or %NULL + + a #GtkTextTag, or %NULL - - You may wish to begin by reading the + + You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together. @@ -157090,11 +112271,11 @@ gtk_text_buffer_get_iter_at_mark(). Unlike iterators, marks remain valid across buffer mutations, because their behavior is defined when text is inserted or deleted. When text containing a mark is deleted, the mark remains in the position originally occupied by the deleted text. When text is inserted at a -mark, a mark with “left gravity” will be moved to the -beginning of the newly-inserted text, and a mark with “right -gravity” will be moved to the end. +mark, a mark with “left gravity” will be moved to the +beginning of the newly-inserted text, and a mark with “right +gravity” will be moved to the end. -Note that “left” and “right” here refer to logical direction (left +Note that “left” and “right” here refer to logical direction (left is the toward the start of the buffer); in some languages such as Hebrew the logically-leftmost text is not actually on the left when displayed. @@ -157110,151 +112291,107 @@ Marks optionally have names; these can be convenient to avoid passing the Marks are typically created using the gtk_text_buffer_create_mark() function. - Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark(). + Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark(). If @name is %NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using gtk_text_buffer_get_mark(). If a mark has left -gravity, and text is inserted at the mark’s current location, the mark +gravity, and text is inserted at the mark’s current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity (@left_gravity = %FALSE), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right -side of the text you’re typing). +side of the text you’re typing). - new #GtkTextMark + new #GtkTextMark - - mark name or %NULL + + mark name or %NULL - whether the mark should have left gravity + whether the mark should have left gravity - Gets the buffer this mark is located inside, + Gets the buffer this mark is located inside, or %NULL if the mark is deleted. - the mark’s #GtkTextBuffer + the mark’s #GtkTextBuffer - a #GtkTextMark + a #GtkTextMark - Returns %TRUE if the mark has been removed from its buffer + Returns %TRUE if the mark has been removed from its buffer with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark() for a way to add it to a buffer again. - whether the mark is deleted + whether the mark is deleted - a #GtkTextMark + a #GtkTextMark - - Determines whether the mark has left gravity. + + Determines whether the mark has left gravity. - %TRUE if the mark has left gravity, %FALSE otherwise + %TRUE if the mark has left gravity, %FALSE otherwise - a #GtkTextMark + a #GtkTextMark - Returns the mark name; returns NULL for anonymous marks. + Returns the mark name; returns NULL for anonymous marks. - mark name + mark name - a #GtkTextMark + a #GtkTextMark - Returns %TRUE if the mark is visible (i.e. a cursor is displayed + Returns %TRUE if the mark is visible (i.e. a cursor is displayed for it). - %TRUE if visible + %TRUE if visible - a #GtkTextMark + a #GtkTextMark - Sets the visibility of @mark; the insertion point is normally + Sets the visibility of @mark; the insertion point is normally visible, i.e. you can see it as a vertical bar. Also, the text widget uses a visible mark to indicate where a drop will occur when dragging-and-dropping text. Most other marks are not visible. @@ -157265,37 +112402,23 @@ Marks are not visible by default. - a #GtkTextMark + a #GtkTextMark - visibility of mark + visibility of mark - - Whether the mark has left gravity. When text is inserted at the mark’s + + Whether the mark has left gravity. When text is inserted at the mark’s current location, if the mark has left gravity it will be moved to the left of the newly-inserted text, otherwise to the right. - - The name of the mark or %NULL if the mark is anonymous. + + The name of the mark or %NULL if the mark is anonymous. @@ -157305,9 +112428,7 @@ to the left of the newly-inserted text, otherwise to the right. - + @@ -157345,55 +112466,27 @@ to the left of the newly-inserted text, otherwise to the right. - - Flags affecting how a search is done. + + Flags affecting how a search is done. If neither #GTK_TEXT_SEARCH_VISIBLE_ONLY nor #GTK_TEXT_SEARCH_TEXT_ONLY are enabled, the match must be exact; the special 0xFFFC character will match embedded pixbufs or child widgets. - - Search only visible data. A search match may + + Search only visible data. A search match may have invisible text interspersed. - - Search only text. A match may have pixbufs or + + Search only text. A match may have pixbufs or child widgets mixed inside the matched range. - - The text will be matched regardless of + + The text will be matched regardless of what case it is in. - - You may wish to begin by reading the + + You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together. @@ -157402,81 +112495,56 @@ Tags should be in the #GtkTextTagTable for a given #GtkTextBuffer before using them with that buffer. gtk_text_buffer_create_tag() is the best way to create tags. -See “gtk3-demo” for numerous examples. +See “gtk3-demo” for numerous examples. -For each property of #GtkTextTag, there is a “set” property, e.g. -“font-set” corresponds to “font”. These “set” properties reflect +For each property of #GtkTextTag, there is a “set” property, e.g. +“font-set” corresponds to “font”. These “set” properties reflect whether a property has been set or not. They are maintained by GTK+ and you should not set them independently. - Creates a #GtkTextTag. Configure the tag using object arguments, + Creates a #GtkTextTag. Configure the tag using object arguments, i.e. using g_object_set(). - a new #GtkTextTag + a new #GtkTextTag - - tag name, or %NULL + + tag name, or %NULL - Emits the “event” signal on the #GtkTextTag. + Emits the “event” signal on the #GtkTextTag. - result of signal emission (whether the event was handled) + result of signal emission (whether the event was handled) - a #GtkTextTag + a #GtkTextTag - object that received the event, such as a widget + object that received the event, such as a widget - the event + the event - location where the event was received + location where the event was received - - Emits the #GtkTextTagTable::tag-changed signal on the #GtkTextTagTable where + + Emits the #GtkTextTagTable::tag-changed signal on the #GtkTextTagTable where the tag is included. The signal is already emitted when setting a #GtkTextTag property. This @@ -157487,90 +112555,66 @@ function is useful for a #GtkTextTag subclass. - a #GtkTextTag. + a #GtkTextTag. - whether the change affects the #GtkTextView layout. + whether the change affects the #GtkTextView layout. - Emits the “event” signal on the #GtkTextTag. + Emits the “event” signal on the #GtkTextTag. - result of signal emission (whether the event was handled) + result of signal emission (whether the event was handled) - a #GtkTextTag + a #GtkTextTag - object that received the event, such as a widget + object that received the event, such as a widget - the event + the event - location where the event was received + location where the event was received - Get the tag priority. + Get the tag priority. - The tag’s priority. + The tag’s priority. - a #GtkTextTag + a #GtkTextTag - Sets the priority of a #GtkTextTag. Valid priorities + Sets the priority of a #GtkTextTag. Valid priorities start at 0 and go to one less than gtk_text_tag_table_get_size(). Each tag in a table has a unique priority; setting the priority of one tag shifts the priorities of all the other tags in the table to maintain a unique priority for each tag. Higher priority -tags “win” if two tags both set the same text attribute. When adding +tags “win” if two tags both set the same text attribute. When adding a tag to a tag table, it will be assigned the highest priority in the table by default; so normally the precedence of a set of tags is the order in which they were added to the table, or created with -gtk_text_buffer_create_tag(), which adds the tag to the buffer’s table +gtk_text_buffer_create_tag(), which adds the tag to the buffer’s table automatically. @@ -157578,66 +112622,39 @@ automatically. - a #GtkTextTag + a #GtkTextTag - the new priority + the new priority - - Whether the margins accumulate or override each other. + + Whether the margins accumulate or override each other. When set to %TRUE the margins of this tag are added to the margins of any other non-accumulative margins present. When set to %FALSE the margins override one another (the default). - + - + - + - - Background color as a #GdkColor. + + Background color as a #GdkColor. Use #GtkTextTag:background-rgba instead. - - Background color as a #GdkRGBA. + + Background color as a #GdkRGBA. @@ -157652,13 +112669,8 @@ the margins override one another (the default). - - Whether font fallback is enabled. + + Whether font fallback is enabled. When set to %TRUE, other fonts will be substituted where the current font is missing glyphs. @@ -157674,9 +112686,7 @@ where the current font is missing glyphs. - Font description as string, e.g. \"Sans Italic 12\". + Font description as string, e.g. \"Sans Italic 12\". Note that the initial value of this property depends on the internals of #PangoFontDescription. @@ -157685,44 +112695,23 @@ the internals of #PangoFontDescription. - - OpenType font features, as a string. + + OpenType font features, as a string. - + - + - - Foreground color as a #GdkColor. + + Foreground color as a #GdkColor. Use #GtkTextTag:foreground-rgba instead. - - Foreground color as a #GdkRGBA. + + Foreground color as a #GdkRGBA. @@ -157734,13 +112723,8 @@ the internals of #PangoFontDescription. - - Whether this text is hidden. + + Whether this text is hidden. Note that there may still be problems with the support for invisible text, in particular when navigating programmatically inside a buffer @@ -157753,15 +112737,11 @@ containing invisible segments. - + - The language this text is in, as an ISO code. Pango can use this as a + The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If not set, an appropriate default will be used. @@ -157778,90 +112758,48 @@ locale, see also gtk_get_default_language(). - - Extra spacing between graphemes, in Pango units. + + Extra spacing between graphemes, in Pango units. - + - + - - The paragraph background color as a string. + + The paragraph background color as a string. - - The paragraph background color as a #GdkColor. + + The paragraph background color as a #GdkColor. Use #GtkTextTag:paragraph-background-rgba instead. - - The paragraph background color as a #GdkRGBA. + + The paragraph background color as a #GdkRGBA. - + - + - + - + - + - + - + @@ -157900,28 +112838,16 @@ locale, see also gtk_get_default_language(). - - This property modifies the color of strikeouts. If not set, strikeouts + + This property modifies the color of strikeouts. If not set, strikeouts will use the forground color. - - If the #GtkTextTag:strikethrough-rgba property has been set. + + If the #GtkTextTag:strikethrough-rgba property has been set. - + @@ -157939,13 +112865,8 @@ will use the forground color. - - This property modifies the color of underlines. If not set, underlines + + This property modifies the color of underlines. If not set, underlines will use the forground color. If #GtkTextTag:underline is set to %PANGO_UNDERLINE_ERROR, an alternate @@ -157953,13 +112874,8 @@ color may be applied instead of the foreground. Setting this property will always override those defaults. - - If the #GtkTextTag:underline-rgba property has been set. + + If the #GtkTextTag:underline-rgba property has been set. @@ -157990,42 +112906,30 @@ will always override those defaults. - The ::event signal is emitted when an event occurs on a region of the + The ::event signal is emitted when an event occurs on a region of the buffer marked with this tag. - %TRUE to stop other handlers from being invoked for the + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the object the event was fired from (typically a #GtkTextView) + the object the event was fired from (typically a #GtkTextView) - the event which triggered the signal + the event which triggered the signal - a #GtkTextIter pointing at the location the event occurred + a #GtkTextIter pointing at the location the event occurred - + @@ -158034,34 +112938,24 @@ event. %FALSE to propagate the event further. - result of signal emission (whether the event was handled) + result of signal emission (whether the event was handled) - a #GtkTextTag + a #GtkTextTag - object that received the event, such as a widget + object that received the event, such as a widget - the event + the event - location where the event was received + location where the event was received @@ -158103,16 +112997,8 @@ event. %FALSE to propagate the event further. - - You may wish to begin by reading the + + You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together. @@ -158120,7 +113006,7 @@ data types related to the text widget and how they work together. # GtkTextTagTables as GtkBuildable The GtkTextTagTable implementation of the GtkBuildable interface -supports adding tags by specifying “tag” as the “type” attribute +supports adding tags by specifying “tag” as the “type” attribute of a <child> element. An example of a UI definition fragment specifying tags: @@ -158134,15 +113020,11 @@ An example of a UI definition fragment specifying tags: - Creates a new #GtkTextTagTable. The table contains no tags by + Creates a new #GtkTextTagTable. The table contains no tags by default. - a new #GtkTextTagTable + a new #GtkTextTagTable @@ -158192,125 +113074,87 @@ default. - Add a tag to the table. The tag is assigned the highest priority + Add a tag to the table. The tag is assigned the highest priority in the table. @tag must not be in a tag table already, and may not have the same name as an already-added tag. - %TRUE on success. + %TRUE on success. - a #GtkTextTagTable + a #GtkTextTagTable - a #GtkTextTag + a #GtkTextTag - Calls @func on each tag in @table, with user data @data. + Calls @func on each tag in @table, with user data @data. Note that the table may not be modified while iterating -over it (you can’t add/remove tags). +over it (you can’t add/remove tags). - a #GtkTextTagTable + a #GtkTextTagTable - - a function to call on each tag + + a function to call on each tag - - user data + + user data - Returns the size of the table (number of tags) + Returns the size of the table (number of tags) - number of tags in @table + number of tags in @table - a #GtkTextTagTable + a #GtkTextTagTable - Look up a named tag. + Look up a named tag. - The tag, or %NULL if none by that + The tag, or %NULL if none by that name is in the table. - a #GtkTextTagTable + a #GtkTextTagTable - name of a tag + name of a tag - Remove a tag from the table. If a #GtkTextBuffer has @table as its tag table, -the tag is removed from the buffer. The table’s reference to the tag is -removed, so the tag will end up destroyed if you don’t have a reference to + Remove a tag from the table. If a #GtkTextBuffer has @table as its tag table, +the tag is removed from the buffer. The table’s reference to the tag is +removed, so the tag will end up destroyed if you don’t have a reference to it. @@ -158318,15 +113162,11 @@ it. - a #GtkTextTagTable + a #GtkTextTagTable - a #GtkTextTag + a #GtkTextTag @@ -158343,9 +113183,7 @@ it. - the added tag. + the added tag. @@ -158356,15 +113194,11 @@ it. - the changed tag. + the changed tag. - whether the change affects the #GtkTextView layout. + whether the change affects the #GtkTextView layout. @@ -158375,17 +113209,13 @@ it. - the removed tag. + the removed tag. - + @@ -158481,38 +113311,20 @@ it. - the #GtkTextTag + the #GtkTextTag - - data passed to gtk_text_tag_table_foreach() + + data passed to gtk_text_tag_table_foreach() - + - - You may wish to begin by reading the + + You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together. @@ -158521,13 +113333,13 @@ types related to the text widget and how they work together. |[<!-- language="plain" --> textview.view -├── border.top -├── border.left -├── text -│ ╰── [selection] -├── border.right -├── border.bottom -╰── [window.popup] +├── border.top +├── border.left +├── text +│ ╰── [selection] +├── border.right +├── border.bottom +╰── [window.popup] ]| GtkTextView has a main css node with name textview and style class .view, @@ -158544,25 +113356,18 @@ of the main node. - Creates a new #GtkTextView. If you don’t call gtk_text_view_set_buffer() + Creates a new #GtkTextView. If you don’t call gtk_text_view_set_buffer() before using the text view, an empty default buffer will be created for you. Get the buffer with gtk_text_view_get_buffer(). If you want to specify your own buffer, consider gtk_text_view_new_with_buffer(). - a new #GtkTextView + a new #GtkTextView - - Creates a new #GtkTextView widget displaying the buffer + + Creates a new #GtkTextView widget displaying the buffer @buffer. One buffer can be shared among many widgets. @buffer may be %NULL to create a default buffer, in which case this function is equivalent to gtk_text_view_new(). The @@ -158570,16 +113375,12 @@ text view adds its own reference count to the buffer; it does not take over an existing reference. - a new #GtkTextView. + a new #GtkTextView. - a #GtkTextBuffer + a #GtkTextBuffer @@ -158777,41 +113578,29 @@ take over an existing reference. - - Adds a child widget in the text buffer, at the given @anchor. + + Adds a child widget in the text buffer, at the given @anchor. - a #GtkTextView + a #GtkTextView - a #GtkWidget + a #GtkWidget - a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view + a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view - - Adds a child at fixed coordinates in one of the text widget's + + Adds a child at fixed coordinates in one of the text widget's windows. The window must have nonzero size (see @@ -158827,113 +113616,82 @@ text window) it will move with the scrolling as needed. - a #GtkTextView + a #GtkTextView - a #GtkWidget + a #GtkWidget - which window the child should appear in + which window the child should appear in - X position of child in window coordinates + X position of child in window coordinates - Y position of child in window coordinates + Y position of child in window coordinates - - Moves the given @iter backward by one display (wrapped) line. + + Moves the given @iter backward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since -they depend on the view’s width; paragraphs are the same in all +they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer. - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - Moves the given @iter backward to the next display line start. + + Moves the given @iter backward to the next display line start. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since -they depend on the view’s width; paragraphs are the same in all +they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer. - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window + + Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window @win, and stores the result in (@window_x, @window_y). -Note that you can’t convert coordinates for a nonexisting window (see +Note that you can’t convert coordinates for a nonexisting window (see gtk_text_view_set_border_window_size()). @@ -158941,223 +113699,148 @@ gtk_text_view_set_border_window_size()). - a #GtkTextView + a #GtkTextView - a #GtkTextWindowType, except %GTK_TEXT_WINDOW_PRIVATE + a #GtkTextWindowType, except %GTK_TEXT_WINDOW_PRIVATE - buffer x coordinate + buffer x coordinate - buffer y coordinate + buffer y coordinate - - window x coordinate return location or %NULL + + window x coordinate return location or %NULL - - window y coordinate return location or %NULL + + window y coordinate return location or %NULL - - Moves the given @iter forward by one display (wrapped) line. + + Moves the given @iter forward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since -they depend on the view’s width; paragraphs are the same in all +they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer. - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - Moves the given @iter forward to the next display line end. + + Moves the given @iter forward to the next display line end. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since -they depend on the view’s width; paragraphs are the same in all +they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer. - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - Returns whether pressing the Tab key inserts a tab characters. + + Returns whether pressing the Tab key inserts a tab characters. gtk_text_view_set_accepts_tab(). - %TRUE if pressing the Tab key inserts a tab character, + %TRUE if pressing the Tab key inserts a tab character, %FALSE if pressing the Tab key moves the keyboard focus. - A #GtkTextView + A #GtkTextView - - Gets the width of the specified border window. See + + Gets the width of the specified border window. See gtk_text_view_set_border_window_size(). - width of window + width of window - a #GtkTextView + a #GtkTextView - window to return size from + window to return size from - - Gets the bottom margin for text in the @text_view. + + Gets the bottom margin for text in the @text_view. - bottom margin in pixels + bottom margin in pixels - a #GtkTextView + a #GtkTextView - Returns the #GtkTextBuffer being displayed by this text view. + Returns the #GtkTextBuffer being displayed by this text view. The reference count on the buffer is not incremented; the caller -of this function won’t own a new reference. +of this function won’t own a new reference. - a #GtkTextBuffer + a #GtkTextBuffer - a #GtkTextView + a #GtkTextView - - Given an @iter within a text layout, determine the positions of the + + Given an @iter within a text layout, determine the positions of the strong and weak cursors if the insertion point is at that iterator. The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where @@ -159171,7 +113854,7 @@ If @iter is %NULL, the actual cursor position is used. Note that if @iter happens to be the actual cursor position, and there is currently an IM preedit sequence being entered, the returned locations will be adjusted to account for the preedit -cursor’s offset within the preedit sequence. +cursor’s offset within the preedit sequence. The rectangle position is in buffer coordinates; use gtk_text_view_buffer_to_window_coords() to convert these @@ -159182,74 +113865,43 @@ coordinates to coordinates for one of the windows in the text view. - a #GtkTextView + a #GtkTextView - - a #GtkTextIter + + a #GtkTextIter - - location to store the strong + + location to store the strong cursor position (may be %NULL) - - location to store the weak + + location to store the weak cursor position (may be %NULL) - - Find out whether the cursor should be displayed. + + Find out whether the cursor should be displayed. - whether the insertion mark is visible + whether the insertion mark is visible - a #GtkTextView + a #GtkTextView - - Obtains a copy of the default text attributes. These are the + + Obtains a copy of the default text attributes. These are the attributes used for text unless a tag overrides them. -You’d typically pass the default attributes in to +You’d typically pass the default attributes in to gtk_text_iter_get_attributes() in order to get the attributes in effect at a given text position. @@ -159257,178 +113909,120 @@ The return value is a copy owned by the caller of this function, and should be freed with gtk_text_attributes_unref(). - a new #GtkTextAttributes + a new #GtkTextAttributes - a #GtkTextView + a #GtkTextView - Returns the default editability of the #GtkTextView. Tags in the + Returns the default editability of the #GtkTextView. Tags in the buffer may override this setting for some ranges of text. - whether text is editable by default + whether text is editable by default - a #GtkTextView + a #GtkTextView - - Gets the horizontal-scrolling #GtkAdjustment. + + Gets the horizontal-scrolling #GtkAdjustment. Use gtk_scrollable_get_hadjustment() - pointer to the horizontal #GtkAdjustment + pointer to the horizontal #GtkAdjustment - a #GtkTextView + a #GtkTextView - Gets the default indentation of paragraphs in @text_view. -Tags in the view’s buffer may override the default. + Gets the default indentation of paragraphs in @text_view. +Tags in the view’s buffer may override the default. The indentation may be negative. - number of pixels of indentation + number of pixels of indentation - a #GtkTextView + a #GtkTextView - - Gets the value of the #GtkTextView:input-hints property. + + Gets the value of the #GtkTextView:input-hints property. - a #GtkTextView + a #GtkTextView - - Gets the value of the #GtkTextView:input-purpose property. + + Gets the value of the #GtkTextView:input-purpose property. - a #GtkTextView + a #GtkTextView - - Retrieves the iterator at buffer coordinates @x and @y. Buffer + + Retrieves the iterator at buffer coordinates @x and @y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with gtk_text_view_window_to_buffer_coords(). - %TRUE if the position is over text + %TRUE if the position is over text - a #GtkTextView + a #GtkTextView - - a #GtkTextIter + + a #GtkTextIter - x position, in buffer coordinates + x position, in buffer coordinates - y position, in buffer coordinates + y position, in buffer coordinates - - Retrieves the iterator pointing to the character at buffer + + Retrieves the iterator pointing to the character at buffer coordinates @x and @y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert @@ -159440,60 +114034,37 @@ which returns cursor locations, i.e. positions between characters. - %TRUE if the position is over text + %TRUE if the position is over text - a #GtkTextView + a #GtkTextView - - a #GtkTextIter + + a #GtkTextIter - - if non-%NULL, location to store an integer indicating where + + if non-%NULL, location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme. - x position, in buffer coordinates + x position, in buffer coordinates - y position, in buffer coordinates + y position, in buffer coordinates - - Gets a rectangle which roughly contains the character at @iter. + + Gets a rectangle which roughly contains the character at @iter. The rectangle position is in buffer coordinates; use gtk_text_view_buffer_to_window_coords() to convert these coordinates to coordinates for one of the windows in the text view. @@ -159503,76 +114074,51 @@ coordinates to coordinates for one of the windows in the text view. - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - bounds of the character at @iter + + bounds of the character at @iter - - Gets the default justification of paragraphs in @text_view. + + Gets the default justification of paragraphs in @text_view. Tags in the buffer may override the default. - default justification + default justification - a #GtkTextView + a #GtkTextView - - Gets the default left margin size of paragraphs in the @text_view. + + Gets the default left margin size of paragraphs in the @text_view. Tags in the buffer may override the default. - left margin in pixels + left margin in pixels - a #GtkTextView + a #GtkTextView - Gets the #GtkTextIter at the start of the line containing + Gets the #GtkTextIter at the start of the line containing the coordinate @y. @y is in buffer coordinates, convert from window coordinates with gtk_text_view_window_to_buffer_coords(). If non-%NULL, @line_top will be filled with the coordinate of the top @@ -159583,42 +114129,25 @@ edge of the line. - a #GtkTextView + a #GtkTextView - - a #GtkTextIter + + a #GtkTextIter - a y coordinate + a y coordinate - - return location for top coordinate of the line + + return location for top coordinate of the line - - Gets the y coordinate of the top of the line containing @iter, + + Gets the y coordinate of the top of the line containing @iter, and the height of the line. The coordinate is a buffer coordinate; convert to window coordinates with gtk_text_view_buffer_to_window_coords(). @@ -159627,247 +114156,162 @@ convert to window coordinates with gtk_text_view_buffer_to_window_coords(). - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - return location for a y coordinate + + return location for a y coordinate - - return location for a height + + return location for a height - - Gets the value of the #GtkTextView:monospace property. + + Gets the value of the #GtkTextView:monospace property. - %TRUE if monospace fonts are desired + %TRUE if monospace fonts are desired - a #GtkTextView + a #GtkTextView - - Returns whether the #GtkTextView is in overwrite mode or not. + + Returns whether the #GtkTextView is in overwrite mode or not. - whether @text_view is in overwrite mode or not. + whether @text_view is in overwrite mode or not. - a #GtkTextView + a #GtkTextView - - Gets the default number of pixels to put above paragraphs. + + Gets the default number of pixels to put above paragraphs. Adding this function with gtk_text_view_get_pixels_below_lines() is equal to the line space between each paragraph. - default number of pixels above paragraphs + default number of pixels above paragraphs - a #GtkTextView + a #GtkTextView - - Gets the value set by gtk_text_view_set_pixels_below_lines(). + + Gets the value set by gtk_text_view_set_pixels_below_lines(). The line space is the sum of the value returned by this function and the value returned by gtk_text_view_get_pixels_above_lines(). - default number of blank pixels below paragraphs + default number of blank pixels below paragraphs - a #GtkTextView + a #GtkTextView - - Gets the value set by gtk_text_view_set_pixels_inside_wrap(). + + Gets the value set by gtk_text_view_set_pixels_inside_wrap(). - default number of pixels of blank space between wrapped lines + default number of pixels of blank space between wrapped lines - a #GtkTextView + a #GtkTextView - - Gets the default right margin for text in @text_view. Tags + + Gets the default right margin for text in @text_view. Tags in the buffer may override the default. - right margin in pixels + right margin in pixels - a #GtkTextView + a #GtkTextView - Gets the default tabs for @text_view. Tags in the buffer may + Gets the default tabs for @text_view. Tags in the buffer may override the defaults. The returned array will be %NULL if -“standard” (8-space) tabs are used. Free the return value +“standard” (8-space) tabs are used. Free the return value with pango_tab_array_free(). - copy of default tab array, or %NULL if - “standard" tabs are used; must be freed with pango_tab_array_free(). + copy of default tab array, or %NULL if + “standard" tabs are used; must be freed with pango_tab_array_free(). - a #GtkTextView + a #GtkTextView - - Gets the top margin for text in the @text_view. + + Gets the top margin for text in the @text_view. - top margin in pixels + top margin in pixels - a #GtkTextView + a #GtkTextView - - Gets the vertical-scrolling #GtkAdjustment. + + Gets the vertical-scrolling #GtkAdjustment. Use gtk_scrollable_get_vadjustment() - pointer to the vertical #GtkAdjustment + pointer to the vertical #GtkAdjustment - a #GtkTextView + a #GtkTextView - - Fills @visible_rect with the currently-visible + + Fills @visible_rect with the currently-visible region of the buffer, in buffer coordinates. Convert to window coordinates with gtk_text_view_buffer_to_window_coords(). @@ -159876,26 +114320,17 @@ with gtk_text_view_buffer_to_window_coords(). - a #GtkTextView + a #GtkTextView - - rectangle to fill + + rectangle to fill - Retrieves the #GdkWindow corresponding to an area of the text view; + Retrieves the #GdkWindow corresponding to an area of the text view; possible windows include the overall widget window, child windows on the left, right, top, bottom, and the window that displays the text buffer. Windows are %NULL and nonexistent if their width or @@ -159903,82 +114338,57 @@ height is 0, and are nonexistent before the widget has been realized. - a #GdkWindow, or %NULL + a #GdkWindow, or %NULL - a #GtkTextView + a #GtkTextView - window to get + window to get - - Usually used to find out which window an event corresponds to. + + Usually used to find out which window an event corresponds to. If you connect to an event signal on @text_view, this function should be called on `event->window` to see which window it was. - the window type. + the window type. - a #GtkTextView + a #GtkTextView - a window type + a window type - Gets the line wrapping for the view. + Gets the line wrapping for the view. - the line wrap setting + the line wrap setting - a #GtkTextView + a #GtkTextView - - Allow the #GtkTextView input method to internally handle key press + + Allow the #GtkTextView input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. See gtk_im_context_filter_keypress(). @@ -160010,93 +114420,66 @@ gtk_foo_bar_key_press_event (GtkWidget *widget, ]| - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a #GtkTextView + a #GtkTextView - the key event + the key event - Updates the position of a child, as for gtk_text_view_add_child_in_window(). + Updates the position of a child, as for gtk_text_view_add_child_in_window(). - a #GtkTextView + a #GtkTextView - child widget already added to the text view + child widget already added to the text view - new X position in window coordinates + new X position in window coordinates - new Y position in window coordinates + new Y position in window coordinates - - Moves a mark within the buffer so that it's + + Moves a mark within the buffer so that it's located within the currently-visible text area. - %TRUE if the mark moved (wasn’t already onscreen) + %TRUE if the mark moved (wasn’t already onscreen) - a #GtkTextView + a #GtkTextView - a #GtkTextMark + a #GtkTextMark - Move the iterator a given number of characters visually, treating + Move the iterator a given number of characters visually, treating it as the strong cursor position. If @count is positive, then the new strong cursor position will be @count positions to the right of the old cursor position. If @count is negative then the new strong @@ -160109,61 +114492,42 @@ of the current run, and there may be jumps when the cursor is moved off of the end of a run. - %TRUE if @iter moved and is not on the end iterator + %TRUE if @iter moved and is not on the end iterator - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - number of characters to move (negative moves left, + number of characters to move (negative moves left, positive moves right) - - Moves the cursor to the currently visible region of the -buffer, it it isn’t there already. + + Moves the cursor to the currently visible region of the +buffer, it it isn’t there already. - %TRUE if the cursor had to be moved. + %TRUE if the cursor had to be moved. - a #GtkTextView + a #GtkTextView - - Ensures that the cursor is shown (i.e. not in an 'off' blink + + Ensures that the cursor is shown (i.e. not in an 'off' blink interval) and resets the time that it will stay blinking (or visible, in case blinking is disabled). @@ -160176,19 +114540,13 @@ This function should be called in response to user input - a #GtkTextView + a #GtkTextView - - Reset the input method context of the text view if needed. + + Reset the input method context of the text view if needed. This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. @@ -160198,18 +114556,13 @@ would confuse on-going input method behavior. - a #GtkTextView + a #GtkTextView - - Scrolls @text_view the minimum distance such that @mark is contained + + Scrolls @text_view the minimum distance such that @mark is contained within the visible area of the widget. @@ -160217,24 +114570,17 @@ within the visible area of the widget. - a #GtkTextView + a #GtkTextView - a mark in the buffer for @text_view + a mark in the buffer for @text_view - - Scrolls @text_view so that @iter is on the screen in the position + + Scrolls @text_view so that @iter is on the screen in the position indicated by @xalign and @yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls the minimal distance to @@ -160244,62 +114590,45 @@ screen for purposes of this function is reduced by a margin of size Note that this function uses the currently-computed height of the lines in the text buffer. Line heights are computed in an idle -handler; so this function may not have the desired effect if it’s +handler; so this function may not have the desired effect if it’s called before the height computations. To avoid oddness, consider using gtk_text_view_scroll_to_mark() which saves a point to be scrolled to after line validation. - %TRUE if scrolling occurred + %TRUE if scrolling occurred - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - margin as a [0.0,0.5) fraction of screen size + margin as a [0.0,0.5) fraction of screen size - whether to use alignment arguments (if %FALSE, + whether to use alignment arguments (if %FALSE, just get the mark onscreen) - horizontal alignment of mark within visible area + horizontal alignment of mark within visible area - vertical alignment of mark within visible area + vertical alignment of mark within visible area - - Scrolls @text_view so that @mark is on the screen in the position + + Scrolls @text_view so that @mark is on the screen in the position indicated by @xalign and @yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls the minimal distance to @@ -160312,50 +114641,34 @@ screen for purposes of this function is reduced by a margin of size - a #GtkTextView + a #GtkTextView - a #GtkTextMark + a #GtkTextMark - margin as a [0.0,0.5) fraction of screen size + margin as a [0.0,0.5) fraction of screen size - whether to use alignment arguments (if %FALSE, just + whether to use alignment arguments (if %FALSE, just get the mark onscreen) - horizontal alignment of mark within visible area + horizontal alignment of mark within visible area - vertical alignment of mark within visible area + vertical alignment of mark within visible area - - Sets the behavior of the text widget when the Tab key is pressed. + + Sets the behavior of the text widget when the Tab key is pressed. If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab is %FALSE the keyboard focus is moved to the next widget in the focus chain. @@ -160365,30 +114678,23 @@ chain. - A #GtkTextView + A #GtkTextView - %TRUE if pressing the Tab key should insert a tab + %TRUE if pressing the Tab key should insert a tab character, %FALSE, if pressing the Tab key should move the keyboard focus. - - Sets the width of %GTK_TEXT_WINDOW_LEFT or %GTK_TEXT_WINDOW_RIGHT, + + Sets the width of %GTK_TEXT_WINDOW_LEFT or %GTK_TEXT_WINDOW_RIGHT, or the height of %GTK_TEXT_WINDOW_TOP or %GTK_TEXT_WINDOW_BOTTOM. Automatically destroys the corresponding window if the size is set to 0, and creates the window if the size is set to non-zero. This -function can only be used for the “border windows”, and it won’t +function can only be used for the “border windows”, and it won’t work with %GTK_TEXT_WINDOW_WIDGET, %GTK_TEXT_WINDOW_TEXT, or %GTK_TEXT_WINDOW_PRIVATE. @@ -160397,31 +114703,21 @@ work with %GTK_TEXT_WINDOW_WIDGET, %GTK_TEXT_WINDOW_TEXT, or - a #GtkTextView + a #GtkTextView - window to affect + window to affect - width or height of the window + width or height of the window - - Sets the bottom margin for text in @text_view. + + Sets the bottom margin for text in @text_view. Note that this function is confusingly named. In CSS terms, the value set here is padding. @@ -160431,55 +114727,39 @@ In CSS terms, the value set here is padding. - a #GtkTextView + a #GtkTextView - bottom margin in pixels + bottom margin in pixels - Sets @buffer as the buffer being displayed by @text_view. The previous + Sets @buffer as the buffer being displayed by @text_view. The previous buffer displayed by the text view is unreferenced, and a reference is added to @buffer. If you owned a reference to @buffer before passing it to this function, you must remove that reference yourself; #GtkTextView -will not “adopt” it. +will not “adopt” it. - a #GtkTextView + a #GtkTextView - - a #GtkTextBuffer + + a #GtkTextBuffer - - Toggles whether the insertion point should be displayed. A buffer with -no editable text probably shouldn’t have a visible cursor, so you may + + Toggles whether the insertion point should be displayed. A buffer with +no editable text probably shouldn’t have a visible cursor, so you may want to turn the cursor off. Note that this property may be overridden by the @@ -160490,24 +114770,18 @@ Note that this property may be overridden by the - a #GtkTextView + a #GtkTextView - whether to show the insertion cursor + whether to show the insertion cursor - Sets the default editability of the #GtkTextView. You can override -this default setting with tags in the buffer, using the “editable” + Sets the default editability of the #GtkTextView. You can override +this default setting with tags in the buffer, using the “editable” attribute of tags. @@ -160515,23 +114789,17 @@ attribute of tags. - a #GtkTextView + a #GtkTextView - whether it’s editable + whether it’s editable - Sets the default indentation for paragraphs in @text_view. + Sets the default indentation for paragraphs in @text_view. Tags in the buffer may override the default. @@ -160539,25 +114807,17 @@ Tags in the buffer may override the default. - a #GtkTextView + a #GtkTextView - indentation in pixels + indentation in pixels - - Sets the #GtkTextView:input-hints property, which + + Sets the #GtkTextView:input-hints property, which allows input methods to fine-tune their behaviour. @@ -160565,25 +114825,17 @@ allows input methods to fine-tune their behaviour. - a #GtkTextView + a #GtkTextView - the hints + the hints - - Sets the #GtkTextView:input-purpose property which + + Sets the #GtkTextView:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -160592,49 +114844,35 @@ methods to adjust their behaviour. - a #GtkTextView + a #GtkTextView - the purpose + the purpose - - Sets the default justification of text in @text_view. -Tags in the view’s buffer may override the default. + + Sets the default justification of text in @text_view. +Tags in the view’s buffer may override the default. - a #GtkTextView + a #GtkTextView - justification + justification - - Sets the default left margin for text in @text_view. + + Sets the default left margin for text in @text_view. Tags in the buffer may override the default. Note that this function is confusingly named. @@ -160645,25 +114883,17 @@ In CSS terms, the value set here is padding. - a #GtkTextView + a #GtkTextView - left margin in pixels + left margin in pixels - - Sets the #GtkTextView:monospace property, which + + Sets the #GtkTextView:monospace property, which indicates that the text view should use monospace fonts. @@ -160672,49 +114902,34 @@ fonts. - a #GtkTextView + a #GtkTextView - %TRUE to request monospace styling + %TRUE to request monospace styling - - Changes the #GtkTextView overwrite mode. + + Changes the #GtkTextView overwrite mode. - a #GtkTextView + a #GtkTextView - %TRUE to turn on overwrite mode, %FALSE to turn it off + %TRUE to turn on overwrite mode, %FALSE to turn it off - - Sets the default number of blank pixels above paragraphs in @text_view. + + Sets the default number of blank pixels above paragraphs in @text_view. Tags in the buffer for @text_view may override the defaults. @@ -160722,76 +114937,55 @@ Tags in the buffer for @text_view may override the defaults. - a #GtkTextView + a #GtkTextView - pixels above paragraphs + pixels above paragraphs - - Sets the default number of pixels of blank space + + Sets the default number of pixels of blank space to put below paragraphs in @text_view. May be overridden -by tags applied to @text_view’s buffer. +by tags applied to @text_view’s buffer. - a #GtkTextView + a #GtkTextView - pixels below paragraphs + pixels below paragraphs - - Sets the default number of pixels of blank space to leave between + + Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph. May be overridden by -tags in @text_view’s buffer. +tags in @text_view’s buffer. - a #GtkTextView + a #GtkTextView - default number of pixels between wrapped lines + default number of pixels between wrapped lines - - Sets the default right margin for text in the text view. + + Sets the default right margin for text in the text view. Tags in the buffer may override the default. Note that this function is confusingly named. @@ -160802,23 +114996,17 @@ In CSS terms, the value set here is padding. - a #GtkTextView + a #GtkTextView - right margin in pixels + right margin in pixels - Sets the default tab stops for paragraphs in @text_view. + Sets the default tab stops for paragraphs in @text_view. Tags in the buffer may override the default. @@ -160826,25 +115014,17 @@ Tags in the buffer may override the default. - a #GtkTextView + a #GtkTextView - tabs as a #PangoTabArray + tabs as a #PangoTabArray - - Sets the top margin for text in @text_view. + + Sets the top margin for text in @text_view. Note that this function is confusingly named. In CSS terms, the value set here is padding. @@ -160854,79 +115034,57 @@ In CSS terms, the value set here is padding. - a #GtkTextView + a #GtkTextView - top margin in pixels + top margin in pixels - Sets the line wrapping for the view. + Sets the line wrapping for the view. - a #GtkTextView + a #GtkTextView - a #GtkWrapMode + a #GtkWrapMode - - Determines whether @iter is at the start of a display line. + + Determines whether @iter is at the start of a display line. See gtk_text_view_forward_display_line() for an explanation of display lines vs. paragraphs. - %TRUE if @iter begins a wrapped line + %TRUE if @iter begins a wrapped line - a #GtkTextView + a #GtkTextView - a #GtkTextIter + a #GtkTextIter - - Converts coordinates on the window identified by @win to buffer + + Converts coordinates on the window identified by @win to buffer coordinates, storing the result in (@buffer_x,@buffer_y). -Note that you can’t convert coordinates for a nonexisting window (see +Note that you can’t convert coordinates for a nonexisting window (see gtk_text_view_set_border_window_size()). @@ -160934,49 +115092,27 @@ gtk_text_view_set_border_window_size()). - a #GtkTextView + a #GtkTextView - a #GtkTextWindowType except %GTK_TEXT_WINDOW_PRIVATE + a #GtkTextWindowType except %GTK_TEXT_WINDOW_PRIVATE - window x coordinate + window x coordinate - window y coordinate + window y coordinate - - buffer x coordinate return location or %NULL + + buffer x coordinate return location or %NULL - - buffer y coordinate return location or %NULL + + buffer y coordinate return location or %NULL @@ -160984,13 +115120,8 @@ gtk_text_view_set_border_window_size()). - - The bottom margin for text in the text view. + + The bottom margin for text in the text view. Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition @@ -161008,13 +115139,8 @@ Don't confuse this property with #GtkWidget:margin-bottom. - - Which IM (input method) module should be used for this text_view. + + Which IM (input method) module should be used for this text_view. See #GtkIMContext. Setting this to a non-%NULL value overrides the @@ -161025,23 +115151,13 @@ system-wide IM module setting. See the GtkSettings - - Additional hints (beyond #GtkTextView:input-purpose) that + + Additional hints (beyond #GtkTextView:input-purpose) that allow input methods to fine-tune their behaviour. - - The purpose of this text field. + + The purpose of this text field. This property can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -161051,9 +115167,7 @@ methods to adjust their behaviour. - The default left margin for text in the text view. + The default left margin for text in the text view. Tags in the buffer may override the default. Note that this property is confusingly named. In CSS terms, @@ -161069,35 +115183,22 @@ Don't confuse this property with #GtkWidget:margin-left. - + - + - + - - If :populate-all is %TRUE, the #GtkTextView::populate-popup + + If :populate-all is %TRUE, the #GtkTextView::populate-popup signal is also emitted for touch popups. - The default right margin for text in the text view. + The default right margin for text in the text view. Tags in the buffer may override the default. Note that this property is confusingly named. In CSS terms, @@ -161110,13 +115211,8 @@ Don't confuse this property with #GtkWidget:margin-right. - - The top margin for text in the text view. + + The top margin for text in the text view. Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition @@ -161135,9 +115231,7 @@ Don't confuse this property with #GtkWidget:margin-top. - The ::backspace signal is a + The ::backspace signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it. @@ -161148,9 +115242,7 @@ Backspace and Shift-Backspace. - The ::copy-clipboard signal is a + The ::copy-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to copy the selection to the clipboard. @@ -161161,9 +115253,7 @@ Ctrl-c and Ctrl-Insert. - The ::cut-clipboard signal is a + The ::cut-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cut the selection to the clipboard. @@ -161174,9 +115264,7 @@ Ctrl-x and Shift-Delete. - The ::delete-from-cursor signal is a + The ::delete-from-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a text deletion. @@ -161193,62 +115281,44 @@ backwords. - the granularity of the deletion, as a #GtkDeleteType + the granularity of the deletion, as a #GtkDeleteType - the number of @type units to delete + the number of @type units to delete - The ::extend-selection signal is emitted when the selection needs to be + The ::extend-selection signal is emitted when the selection needs to be extended at @location. - %GDK_EVENT_STOP to stop other handlers from being invoked for the + %GDK_EVENT_STOP to stop other handlers from being invoked for the event. %GDK_EVENT_PROPAGATE to propagate the event further. - the granularity type + the granularity type - the location where to extend the selection + the location where to extend the selection - where the selection should start + where the selection should start - where the selection should end + where the selection should end - The ::insert-at-cursor signal is a + The ::insert-at-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates the insertion of a fixed string at the cursor. @@ -161259,20 +115329,13 @@ This signal has no default bindings. - the string to insert + the string to insert - - The ::insert-emoji signal is a + + The ::insert-emoji signal is a [keybinding signal][GtkBindingSignal] which gets emitted to present the Emoji chooser for the @text_view. @@ -161282,9 +115345,7 @@ The default bindings for this signal are Ctrl-. and Ctrl-; - The ::move-cursor signal is a + The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. If the cursor is not visible in @text_view, this signal causes @@ -161308,29 +115369,21 @@ There are too many key combinations to list them all here. - the granularity of the move, as a #GtkMovementStep + the granularity of the move, as a #GtkMovementStep - the number of @step units to move + the number of @step units to move - %TRUE if the move should extend the selection + %TRUE if the move should extend the selection - The ::move-viewport signal is a + The ::move-viewport signal is a [keybinding signal][GtkBindingSignal] which can be bound to key combinations to allow the user to move the viewport, i.e. change what part of the text view @@ -161342,23 +115395,17 @@ There are no default bindings for this signal. - the granularity of the movement, as a #GtkScrollStep + the granularity of the movement, as a #GtkScrollStep - the number of @step units to move + the number of @step units to move - The ::paste-clipboard signal is a + The ::paste-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to paste the contents of the clipboard into the text view. @@ -161370,9 +115417,7 @@ Ctrl-v and Shift-Insert. - The ::populate-popup signal gets emitted before showing the + The ::populate-popup signal gets emitted before showing the context menu of the text view. If you need to add items to the context menu, connect @@ -161391,20 +115436,13 @@ or #GtkToolbar or another kind of container. - the container that is being populated + the container that is being populated - - If an input method is used, the typed text will not immediately + + If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal. @@ -161415,17 +115453,13 @@ is actually editable. - the current preedit string + the current preedit string - The ::select-all signal is a + The ::select-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select or unselect the complete contents of the text view. @@ -161437,17 +115471,13 @@ for selecting and Shift-Ctrl-a and Ctrl-\ for unselecting. - %TRUE to select, %FALSE to unselect + %TRUE to select, %FALSE to unselect - The ::set-anchor signal is a + The ::set-anchor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates setting the "anchor" mark. The "anchor" mark gets placed at the same position as the @@ -161459,9 +115489,7 @@ This signal has no default bindings. - The ::toggle-cursor-visible signal is a + The ::toggle-cursor-visible signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the #GtkTextView:cursor-visible property. @@ -161472,9 +115500,7 @@ The default binding for this signal is F7. - The ::toggle-overwrite signal is a + The ::toggle-overwrite signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the overwrite mode of the text view. @@ -161484,13 +115510,7 @@ The default bindings for this signal is Insert. - + @@ -161500,32 +115520,22 @@ The default bindings for this signal is Insert. - + - + - + - + - + - The object class structure needs to be the first + The object class structure needs to be the first @@ -161722,8 +115732,7 @@ The default bindings for this signal is Insert. - + @@ -161783,127 +115792,54 @@ The default bindings for this signal is Insert. - - Used to reference the layers of #GtkTextView for the purpose of customized + + Used to reference the layers of #GtkTextView for the purpose of customized drawing with the ::draw_layer vfunc. - - Old deprecated layer, use %GTK_TEXT_VIEW_LAYER_BELOW_TEXT instead + + Old deprecated layer, use %GTK_TEXT_VIEW_LAYER_BELOW_TEXT instead - - Old deprecated layer, use %GTK_TEXT_VIEW_LAYER_ABOVE_TEXT instead + + Old deprecated layer, use %GTK_TEXT_VIEW_LAYER_ABOVE_TEXT instead - - The layer rendered below the text (but above the background). Since: 3.20 + + The layer rendered below the text (but above the background). Since: 3.20 - - The layer rendered above the text. Since: 3.20 + + The layer rendered above the text. Since: 3.20 - - Used to reference the parts of #GtkTextView. - - Invalid value, used as a marker + + Used to reference the parts of #GtkTextView. + + Invalid value, used as a marker - - Window that floats over scrolling areas. + + Window that floats over scrolling areas. - - Scrollable text window. + + Scrollable text window. - - Left side border window. + + Left side border window. - - Right side border window. + + Right side border window. - - Top border window. + + Top border window. - - Bottom border window. + + Bottom border window. - - #GtkThemingEngine was the object used for rendering themed content + + #GtkThemingEngine was the object used for rendering themed content in GTK+ widgets. It used to allow overriding GTK+'s default implementation of rendering functions by allowing engines to be loaded as modules. @@ -161912,50 +115848,32 @@ loaded as modules. ignored for rendering. The advancements in CSS theming are good enough to allow themers to achieve their goals without the need to modify source code. - - - Loads and initializes a theming engine module from the + + + Loads and initializes a theming engine module from the standard directories. - + - A theming engine, or %NULL if -the engine @name doesn’t exist. + A theming engine, or %NULL if +the engine @name doesn’t exist. - Theme engine name to load + Theme engine name to load - - Registers a property so it can be used in the CSS file format, + + Registers a property so it can be used in the CSS file format, on the CSS file the property will look like "-${@name_space}-${property_name}". being ${property_name} the given to @pspec. @name_space will usually be the theme engine name. For any type a @parse_func may be provided, being this function -used for turning any property value (between “:” and “;”) in +used for turning any property value (between “:” and “;”) in CSS to the #GValue needed. For basic types there is already builtin parsing support, so %NULL may be provided for these cases. @@ -161976,38 +115894,27 @@ one. } ]| Code should use the default properties provided by CSS. - + - namespace for the property name + namespace for the property name - - parsing function to use, or %NULL + + parsing function to use, or %NULL - the #GParamSpec for the new property + the #GParamSpec for the new property - + @@ -162033,8 +115940,7 @@ one. - + @@ -162060,8 +115966,7 @@ one. - + @@ -162087,8 +115992,7 @@ one. - + @@ -162114,8 +116018,7 @@ one. - + @@ -162141,8 +116044,7 @@ one. - + @@ -162171,8 +116073,7 @@ one. - + @@ -162198,8 +116099,7 @@ one. - + @@ -162225,8 +116125,7 @@ one. - + @@ -162261,8 +116160,7 @@ one. - + @@ -162288,8 +116186,7 @@ one. - + @@ -162312,8 +116209,7 @@ one. - + @@ -162330,8 +116226,7 @@ one. - + @@ -162354,8 +116249,7 @@ one. - + @@ -162378,8 +116272,7 @@ one. - + @@ -162405,8 +116298,7 @@ one. - + @@ -162432,8 +116324,7 @@ one. - + @@ -162461,778 +116352,453 @@ one. - - Retrieves several style property values that apply to the currently + + Retrieves several style property values that apply to the currently rendered element. - + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve values for + state to retrieve values for - property name /return value pairs, followed by %NULL + property name /return value pairs, followed by %NULL - - Gets the background color for a given state. - + + Gets the background color for a given state. + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the color for + state to retrieve the color for - - return value for the background color + + return value for the background color - - Gets the border for a given state as a #GtkBorder. - + + Gets the border for a given state as a #GtkBorder. + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the border for + state to retrieve the border for - - return value for the border settings + + return value for the border settings - - Gets the border color for a given state. - + + Gets the border color for a given state. + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the color for + state to retrieve the color for - - return value for the border color + + return value for the border color - - Gets the foreground color for a given state. - + + Gets the foreground color for a given state. + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the color for + state to retrieve the color for - - return value for the foreground color + + return value for the foreground color - - Returns the widget direction used for rendering. + + Returns the widget direction used for rendering. Use gtk_theming_engine_get_state() and check for #GTK_STATE_FLAG_DIR_LTR and #GTK_STATE_FLAG_DIR_RTL instead. - + - the widget direction + the widget direction - a #GtkThemingEngine + a #GtkThemingEngine - - Returns the font description for a given state. + + Returns the font description for a given state. Use gtk_theming_engine_get() - + - the #PangoFontDescription for the given + the #PangoFontDescription for the given state. This object is owned by GTK+ and should not be freed. - + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the font for + state to retrieve the font for - - Returns the widget direction used for rendering. - + + Returns the widget direction used for rendering. + - the widget direction + the widget direction - a #GtkThemingEngine + a #GtkThemingEngine - - Gets the margin for a given state as a #GtkBorder. - + + Gets the margin for a given state as a #GtkBorder. + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the border for + state to retrieve the border for - - return value for the margin settings + + return value for the margin settings - - Gets the padding for a given state as a #GtkBorder. - + + Gets the padding for a given state as a #GtkBorder. + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve the padding for + state to retrieve the padding for - - return value for the padding settings + + return value for the padding settings - - Returns the widget path used for style matching. - + + Returns the widget path used for style matching. + - A #GtkWidgetPath + A #GtkWidgetPath - a #GtkThemingEngine + a #GtkThemingEngine - - Gets a property value as retrieved from the style settings that apply + + Gets a property value as retrieved from the style settings that apply to the currently rendered element. - + - a #GtkThemingEngine + a #GtkThemingEngine - the property name + the property name - state to retrieve the value for + state to retrieve the value for - - return location for the property value, + + return location for the property value, you must free this memory using g_value_unset() once you are done with it. - - Returns the #GdkScreen to which @engine currently rendering to. - + + Returns the #GdkScreen to which @engine currently rendering to. + - a #GdkScreen, or %NULL. + a #GdkScreen, or %NULL. - a #GtkThemingEngine + a #GtkThemingEngine - - returns the state used when rendering. - + + returns the state used when rendering. + - the state flags + the state flags - a #GtkThemingEngine + a #GtkThemingEngine - - Retrieves several widget style properties from @engine according -to the currently rendered content’s style. - + + Retrieves several widget style properties from @engine according +to the currently rendered content’s style. + - a #GtkThemingEngine + a #GtkThemingEngine - property name /return value pairs, followed by %NULL + property name /return value pairs, followed by %NULL - - Gets the value for a widget style property. - + + Gets the value for a widget style property. + - a #GtkThemingEngine + a #GtkThemingEngine - the name of the widget style property + the name of the widget style property - - Return location for the property value, free with + + Return location for the property value, free with g_value_unset() after use. - - Retrieves several widget style properties from @engine according to the -currently rendered content’s style. - + + Retrieves several widget style properties from @engine according to the +currently rendered content’s style. + - a #GtkThemingEngine + a #GtkThemingEngine - va_list of property name/return location pairs, followed by %NULL + va_list of property name/return location pairs, followed by %NULL - - Retrieves several style property values that apply to the currently + + Retrieves several style property values that apply to the currently rendered element. - + - a #GtkThemingEngine + a #GtkThemingEngine - state to retrieve values for + state to retrieve values for - va_list of property name/return location pairs, followed by %NULL + va_list of property name/return location pairs, followed by %NULL - - Returns %TRUE if the currently rendered contents have + + Returns %TRUE if the currently rendered contents have defined the given class name. - + - %TRUE if @engine has @class_name defined + %TRUE if @engine has @class_name defined - a #GtkThemingEngine + a #GtkThemingEngine - class name to look up + class name to look up - - Returns %TRUE if the currently rendered contents have the + + Returns %TRUE if the currently rendered contents have the region defined. If @flags_return is not %NULL, it is set to the flags affecting the region. - + - %TRUE if region is defined + %TRUE if region is defined - a #GtkThemingEngine + a #GtkThemingEngine - a region name + a region name - - return location for region flags + + return location for region flags - - Looks up and resolves a color name in the current style’s color map. - + + Looks up and resolves a color name in the current style’s color map. + - %TRUE if @color_name was found and resolved, %FALSE otherwise + %TRUE if @color_name was found and resolved, %FALSE otherwise - a #GtkThemingEngine + a #GtkThemingEngine - color name to lookup + color name to lookup - - Return location for the looked up color + + Return location for the looked up color - - Returns %TRUE if there is a transition animation running for the + + Returns %TRUE if there is a transition animation running for the current region (see gtk_style_context_push_animatable_region()). If @progress is not %NULL, the animation progress will be returned there, 0.0 means the state is closest to being %FALSE, while 1.0 means -it’s closest to being %TRUE. This means transition animations will +it’s closest to being %TRUE. This means transition animations will run from 0 to 1 when @state is being set to %TRUE and from 1 to 0 when -it’s being set to %FALSE. +it’s being set to %FALSE. Always returns %FALSE - + - %TRUE if there is a running transition animation for @state. + %TRUE if there is a running transition animation for @state. - a #GtkThemingEngine + a #GtkThemingEngine - a widget state + a widget state - - return location for the transition progress + + return location for the transition progress - - The theming engine name, this name will be used when registering + + The theming engine name, this name will be used when registering custom properties, for a theming engine named "Clearlooks" registering a "glossy" custom property, it could be referenced in the CSS file as @@ -163248,24 +116814,16 @@ a "glossy" custom property, it could be referenced in the CSS file as - - Base class for theming engines. - + + Base class for theming engines. + - The parent class. + The parent class. - + @@ -163293,8 +116851,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163322,8 +116879,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163351,8 +116907,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163389,8 +116944,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163421,8 +116975,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163450,8 +117003,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163479,8 +117031,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163508,8 +117059,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163537,8 +117087,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163566,8 +117115,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163592,8 +117140,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163624,8 +117171,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163653,8 +117199,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163682,8 +117227,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163702,8 +117246,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163728,8 +117271,7 @@ a "glossy" custom property, it could be referenced in the CSS file as - + @@ -163758,287 +117300,162 @@ a "glossy" custom property, it could be referenced in the CSS file as - + - Callback type for adding a function to update animations. See gtk_widget_add_tick_callback(). + Callback type for adding a function to update animations. See gtk_widget_add_tick_callback(). - %G_SOURCE_CONTINUE if the tick callback should continue to be called, + %G_SOURCE_CONTINUE if the tick callback should continue to be called, %G_SOURCE_REMOVE if the tick callback should be removed. - the widget + the widget - the frame clock for the widget (same as calling gtk_widget_get_frame_clock()) + the frame clock for the widget (same as calling gtk_widget_get_frame_clock()) - - user data passed to gtk_widget_add_tick_callback(). + + user data passed to gtk_widget_add_tick_callback(). - - A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an -“active” state specifying whether the action has been checked or not. + + A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an +“active” state specifying whether the action has been checked or not. - - Creates a new #GtkToggleAction object. To add the action to + + Creates a new #GtkToggleAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel(). - + - a new #GtkToggleAction + a new #GtkToggleAction - A unique name for the action + A unique name for the action - - The label displayed in menu items and on buttons, + + The label displayed in menu items and on buttons, or %NULL - - A tooltip for the action, or %NULL + + A tooltip for the action, or %NULL - - The stock icon to display in widgets representing + + The stock icon to display in widgets representing the action, or %NULL - - Emits the “toggled” signal on the toggle action. - + + Emits the “toggled” signal on the toggle action. + - the action object + the action object - - Returns the checked state of the toggle action. - + + Returns the checked state of the toggle action. + - the checked state of the toggle action + the checked state of the toggle action - the action object + the action object - - Returns whether the action should have proxies like a radio action. - + + Returns whether the action should have proxies like a radio action. + - whether the action should have proxies like a radio action. + whether the action should have proxies like a radio action. - the action object + the action object - - Sets the checked state on the toggle action. - + + Sets the checked state on the toggle action. + - the action object + the action object - whether the action should be checked or not + whether the action should be checked or not - - Sets whether the action should have proxies like a radio action. - + + Sets whether the action should have proxies like a radio action. + - the action object + the action object - whether the action should have proxies like a radio + whether the action should have proxies like a radio action - - Emits the “toggled” signal on the toggle action. - + + Emits the “toggled” signal on the toggle action. + - the action object + the action object - - Whether the toggle action should be active. + + Whether the toggle action should be active. - - Whether the proxies for this action look like radio action proxies. + + Whether the proxies for this action look like radio action proxies. This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE. @@ -164050,38 +117467,28 @@ This is an appearance property and thus only applies if - - Should be connected if you wish to perform an action + + Should be connected if you wish to perform an action whenever the #GtkToggleAction state is changed. - + - + - the action object + the action object @@ -164089,8 +117496,7 @@ whenever the #GtkToggleAction state is changed. - + @@ -164098,8 +117504,7 @@ whenever the #GtkToggleAction state is changed. - + @@ -164107,8 +117512,7 @@ whenever the #GtkToggleAction state is changed. - + @@ -164116,92 +117520,62 @@ whenever the #GtkToggleAction state is changed. - + - - #GtkToggleActionEntry structs are used with + + #GtkToggleActionEntry structs are used with gtk_action_group_add_toggle_actions() to construct toggle actions. - The name of the action. + The name of the action. - The stock id for the action, or the name of an icon from the + The stock id for the action, or the name of an icon from the icon theme. - The label for the action. This field should typically be marked + The label for the action. This field should typically be marked for translation, see gtk_action_group_set_translation_domain(). - The accelerator for the action, in the format understood by + The accelerator for the action, in the format understood by gtk_accelerator_parse(). - The tooltip for the action. This field should typically be + The tooltip for the action. This field should typically be marked for translation, see gtk_action_group_set_translation_domain(). - The function to call when the action is activated. + The function to call when the action is activated. - The initial state of the toggle action. + The initial state of the toggle action. - + - - A #GtkToggleButton is a #GtkButton which will remain “pressed-in” when + + A #GtkToggleButton is a #GtkButton which will remain “pressed-in” when clicked. Clicking again will cause the toggle button to return to its normal state. A toggle button is created by calling either gtk_toggle_button_new() or gtk_toggle_button_new_with_label(). If using the former, it is advisable to pack a widget, (such as a #GtkLabel and/or a #GtkImage), into the toggle -button’s container. (See #GtkButton for more information). +button’s container. (See #GtkButton for more information). The state of a #GtkToggleButton can be set specifically using gtk_toggle_button_set_active(), and retrieved using @@ -164229,7 +117603,7 @@ void make_toggles (void) { window = gtk_window_new (GTK_WINDOW_TOPLEVEL); box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12); - text = "Hi, I’m a toggle button."; + text = "Hi, I’m a toggle button."; toggle1 = gtk_toggle_button_new_with_label (text); // Makes this toggle button invisible @@ -164241,7 +117615,7 @@ void make_toggles (void) { NULL); gtk_container_add (GTK_CONTAINER (box), toggle1); - text = "Hi, I’m a toggle button."; + text = "Hi, I’m a toggle button."; toggle2 = gtk_toggle_button_new_with_label (text); gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle2), FALSE); @@ -164260,66 +117634,46 @@ void make_toggles (void) { - Creates a new toggle button. A widget should be packed into the button, as in gtk_button_new(). + Creates a new toggle button. A widget should be packed into the button, as in gtk_button_new(). - a new toggle button. + a new toggle button. - - Creates a new toggle button with a text label. + + Creates a new toggle button with a text label. - a new toggle button. + a new toggle button. - a string containing the message to be placed in the toggle button. + a string containing the message to be placed in the toggle button. - - Creates a new #GtkToggleButton containing a label. The label + + Creates a new #GtkToggleButton containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in @label indicate the mnemonic for the button. - a new #GtkToggleButton + a new #GtkToggleButton - the text of the button, with an underscore in front of the + the text of the button, with an underscore in front of the mnemonic character - Emits the #GtkToggleButton::toggled signal on the + Emits the #GtkToggleButton::toggled signal on the #GtkToggleButton. There is no good reason for an application ever to call this function. @@ -164328,82 +117682,59 @@ application ever to call this function. - a #GtkToggleButton. + a #GtkToggleButton. - Queries a #GtkToggleButton and returns its current state. Returns %TRUE if + Queries a #GtkToggleButton and returns its current state. Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised. - a #gboolean value. + a #gboolean value. - a #GtkToggleButton. + a #GtkToggleButton. - - Gets the value set by gtk_toggle_button_set_inconsistent(). + + Gets the value set by gtk_toggle_button_set_inconsistent(). - %TRUE if the button is displayed as inconsistent, %FALSE otherwise + %TRUE if the button is displayed as inconsistent, %FALSE otherwise - a #GtkToggleButton + a #GtkToggleButton - Retrieves whether the button is displayed as a separate indicator + Retrieves whether the button is displayed as a separate indicator and label. See gtk_toggle_button_set_mode(). - %TRUE if the togglebutton is drawn as a separate indicator + %TRUE if the togglebutton is drawn as a separate indicator and label. - a #GtkToggleButton + a #GtkToggleButton - Sets the status of the toggle button. Set to %TRUE if you want the -GtkToggleButton to be “pressed in”, and %FALSE to raise it. + Sets the status of the toggle button. Set to %TRUE if you want the +GtkToggleButton to be “pressed in”, and %FALSE to raise it. This action causes the #GtkToggleButton::toggled signal and the #GtkButton::clicked signal to be emitted. @@ -164412,54 +117743,41 @@ This action causes the #GtkToggleButton::toggled signal and the - a #GtkToggleButton. + a #GtkToggleButton. - %TRUE or %FALSE. + %TRUE or %FALSE. - - If the user has selected a range of elements (such as some text or + + If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to -display the toggle in an “in between” state. This function turns on -“in between” display. Normally you would turn off the inconsistent +display the toggle in an “in between” state. This function turns on +“in between” display. Normally you would turn off the inconsistent state again if the user toggles the toggle button. This has to be done manually, gtk_toggle_button_set_inconsistent() only affects -visual appearance, it doesn’t affect the semantics of the button. +visual appearance, it doesn’t affect the semantics of the button. - a #GtkToggleButton + a #GtkToggleButton - %TRUE if state is inconsistent + %TRUE if state is inconsistent - Sets whether the button is displayed as a separate indicator and label. + Sets whether the button is displayed as a separate indicator and label. You can call this function on a checkbutton or a radiobutton with @draw_indicator = %FALSE to make the button look like a normal button. @@ -164475,24 +117793,18 @@ not instances of #GtkToggleButton itself. - a #GtkToggleButton + a #GtkToggleButton - if %TRUE, draw the button as a separate indicator + if %TRUE, draw the button as a separate indicator and label; if %FALSE, draw the button like a normal button - Emits the #GtkToggleButton::toggled signal on the + Emits the #GtkToggleButton::toggled signal on the #GtkToggleButton. There is no good reason for an application ever to call this function. @@ -164501,9 +117813,7 @@ application ever to call this function. - a #GtkToggleButton. + a #GtkToggleButton. @@ -164524,24 +117834,15 @@ application ever to call this function. - Should be connected if you wish to perform an action whenever the + Should be connected if you wish to perform an action whenever the #GtkToggleButton's state is changed. - - + + @@ -164549,28 +117850,19 @@ application ever to call this function. - + - - + + - - + + - + @@ -164583,9 +117875,7 @@ application ever to call this function. - a #GtkToggleButton. + a #GtkToggleButton. @@ -164624,21 +117914,11 @@ application ever to call this function. - + - - A #GtkToggleToolButton is a #GtkToolItem that contains a toggle + + A #GtkToggleToolButton is a #GtkToolItem that contains a toggle button. Use gtk_toggle_tool_button_new() to create a new GtkToggleToolButton. @@ -164651,28 +117931,16 @@ GtkToggleToolButton has a single CSS node with name togglebutton. - - Returns a new #GtkToggleToolButton + + Returns a new #GtkToggleToolButton - a newly created #GtkToggleToolButton + a newly created #GtkToggleToolButton - - Creates a new #GtkToggleToolButton containing the image and text from a + + Creates a new #GtkToggleToolButton containing the image and text from a stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK and #GTK_STOCK_APPLY. @@ -164680,16 +117948,12 @@ It is an error if @stock_id is not a name of a stock item. Use gtk_toggle_tool_button_new() instead. - A new #GtkToggleToolButton + A new #GtkToggleToolButton - the name of the stock item + the name of the stock item @@ -164705,36 +117969,24 @@ It is an error if @stock_id is not a name of a stock item. - - Queries a #GtkToggleToolButton and returns its current state. + + Queries a #GtkToggleToolButton and returns its current state. Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised. - %TRUE if the toggle tool button is pressed in, %FALSE if not + %TRUE if the toggle tool button is pressed in, %FALSE if not - a #GtkToggleToolButton + a #GtkToggleToolButton - - Sets the status of the toggle tool button. Set to %TRUE if you -want the GtkToggleButton to be “pressed in”, and %FALSE to raise it. + + Sets the status of the toggle tool button. Set to %TRUE if you +want the GtkToggleButton to be “pressed in”, and %FALSE to raise it. This action causes the toggled signal to be emitted. @@ -164742,52 +117994,36 @@ This action causes the toggled signal to be emitted. - a #GtkToggleToolButton + a #GtkToggleToolButton - whether @button should be active + whether @button should be active - - If the toggle tool button should be pressed in. + + If the toggle tool button should be pressed in. - + - Emitted whenever the toggle tool button changes state. + Emitted whenever the toggle tool button changes state. - + - The parent class. + The parent class. @@ -164836,21 +118072,11 @@ This action causes the toggled signal to be emitted. - + - - #GtkToolButtons are #GtkToolItems containing buttons. + + #GtkToolButtons are #GtkToolItems containing buttons. Use gtk_tool_button_new() to create a new #GtkToolButton. @@ -164878,46 +118104,26 @@ GtkToolButton has a single CSS node with name toolbutton. - Creates a new #GtkToolButton using @icon_widget as contents and @label as + Creates a new #GtkToolButton using @icon_widget as contents and @label as label. - A new #GtkToolButton + A new #GtkToolButton - - a widget that will be used as the button contents, or %NULL + + a widget that will be used as the button contents, or %NULL - - a string that will be used as label, or %NULL + + a string that will be used as label, or %NULL - - Creates a new #GtkToolButton containing the image and text from a + + Creates a new #GtkToolButton containing the image and text from a stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK and #GTK_STOCK_APPLY. @@ -164926,16 +118132,12 @@ It is an error if @stock_id is not a name of a stock item. gtk_image_new_from_icon_name() instead. - A new #GtkToolButton + A new #GtkToolButton - the name of the stock item + the name of the stock item @@ -164951,158 +118153,104 @@ gtk_image_new_from_icon_name() instead. - - Returns the name of the themed icon for the tool button, + + Returns the name of the themed icon for the tool button, see gtk_tool_button_set_icon_name(). - the icon name or %NULL if the tool button has + the icon name or %NULL if the tool button has no themed icon - a #GtkToolButton + a #GtkToolButton - - Return the widget used as icon widget on @button. + + Return the widget used as icon widget on @button. See gtk_tool_button_set_icon_widget(). - The widget used as icon + The widget used as icon on @button, or %NULL. - a #GtkToolButton + a #GtkToolButton - - Returns the label used by the tool button, or %NULL if the tool button -doesn’t have a label. or uses a the label from a stock item. The returned + + Returns the label used by the tool button, or %NULL if the tool button +doesn’t have a label. or uses a the label from a stock item. The returned string is owned by GTK+, and must not be modified or freed. - The label, or %NULL + The label, or %NULL - a #GtkToolButton + a #GtkToolButton - - Returns the widget used as label on @button. + + Returns the widget used as label on @button. See gtk_tool_button_set_label_widget(). - The widget used as label + The widget used as label on @button, or %NULL. - a #GtkToolButton + a #GtkToolButton - - Returns the name of the stock item. See gtk_tool_button_set_stock_id(). + + Returns the name of the stock item. See gtk_tool_button_set_stock_id(). The returned string is owned by GTK+ and must not be freed or modifed. Use gtk_tool_button_get_icon_name() instead. - the name of the stock item for @button. + the name of the stock item for @button. - a #GtkToolButton + a #GtkToolButton - - Returns whether underscores in the label property are used as mnemonics + + Returns whether underscores in the label property are used as mnemonics on menu items on the overflow menu. See gtk_tool_button_set_use_underline(). - %TRUE if underscores in the label property are used as + %TRUE if underscores in the label property are used as mnemonics on menu items on the overflow menu. - a #GtkToolButton + a #GtkToolButton - - Sets the icon for the tool button from a named themed icon. + + Sets the icon for the tool button from a named themed icon. See the docs for #GtkIconTheme for more details. The #GtkToolButton:icon-name property only has an effect if not overridden by non-%NULL #GtkToolButton:label-widget, @@ -165113,28 +118261,17 @@ overridden by non-%NULL #GtkToolButton:label-widget, - a #GtkToolButton + a #GtkToolButton - - the name of the themed icon + + the name of the themed icon - - Sets @icon as the widget used as icon on @button. If @icon_widget is + + Sets @icon as the widget used as icon on @button. If @icon_widget is %NULL the icon is determined by the #GtkToolButton:stock-id property. If the #GtkToolButton:stock-id property is also %NULL, @button will not have an icon. @@ -165143,28 +118280,17 @@ overridden by non-%NULL #GtkToolButton:label-widget, - a #GtkToolButton + a #GtkToolButton - - the widget used as icon, or %NULL + + the widget used as icon, or %NULL - - Sets @label as the label used for the tool button. The #GtkToolButton:label + + Sets @label as the label used for the tool button. The #GtkToolButton:label property only has an effect if not overridden by a non-%NULL #GtkToolButton:label-widget property. If both the #GtkToolButton:label-widget and #GtkToolButton:label properties are %NULL, the label is determined by the @@ -165176,28 +118302,17 @@ also %NULL, @button will not have a label. - a #GtkToolButton + a #GtkToolButton - - a string that will be used as label, or %NULL. + + a string that will be used as label, or %NULL. - - Sets @label_widget as the widget that will be used as the label + + Sets @label_widget as the widget that will be used as the label for @button. If @label_widget is %NULL the #GtkToolButton:label property is used as label. If #GtkToolButton:label is also %NULL, the label in the stock item determined by the #GtkToolButton:stock-id property is used as label. If @@ -165208,30 +118323,17 @@ determined by the #GtkToolButton:stock-id property is used as label. If - a #GtkToolButton + a #GtkToolButton - - the widget used as label, or %NULL + + the widget used as label, or %NULL - - Sets the name of the stock item. See gtk_tool_button_new_from_stock(). + + Sets the name of the stock item. See gtk_tool_button_new_from_stock(). The stock_id property only has an effect if not overridden by non-%NULL #GtkToolButton:label-widget and #GtkToolButton:icon-widget properties. Use gtk_tool_button_set_icon_name() instead. @@ -165241,32 +118343,21 @@ The stock_id property only has an effect if not overridden by non-%NULL - a #GtkToolButton + a #GtkToolButton - - a name of a stock item, or %NULL + + a name of a stock item, or %NULL - - If set, an underline in the label property indicates that the next character + + If set, an underline in the label property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu. For -example, if the label property is “_Open” and @use_underline is %TRUE, -the label on the tool button will be “Open” and the item on the overflow -menu will have an underlined “O”. +example, if the label property is “_Open” and @use_underline is %TRUE, +the label on the tool button will be “Open” and the item on the overflow +menu will have an underlined “O”. Labels shown on tool buttons never have mnemonics on them; this property only affects the menu item on the overflow menu. @@ -165276,26 +118367,17 @@ only affects the menu item on the overflow menu. - a #GtkToolButton + a #GtkToolButton - whether the button label has the form “_Open” + whether the button label has the form “_Open” - - The name of the themed icon displayed on the item. + + The name of the themed icon displayed on the item. This property only has an effect if not overridden by #GtkToolButton:label-widget, #GtkToolButton:icon-widget or #GtkToolButton:stock-id properties. @@ -165310,11 +118392,7 @@ This property only has an effect if not overridden by - + Use #GtkToolButton:icon-name instead. @@ -165328,23 +118406,17 @@ This property only has an effect if not overridden by - This signal is emitted when the tool button is clicked with the mouse + This signal is emitted when the tool button is clicked with the mouse or activated with the keyboard. - + - The parent class. + The parent class. @@ -165396,21 +118468,11 @@ or activated with the keyboard. - + - - #GtkToolItems are widgets that can appear on a toolbar. To + + #GtkToolItems are widgets that can appear on a toolbar. To create a toolbar item that contain something else than a button, use gtk_tool_item_new(). Use gtk_container_add() to add a child widget to the tool item. @@ -165425,14 +118487,10 @@ See the #GtkToolbar class for a description of the toolbar widget, and - Creates a new #GtkToolItem + Creates a new #GtkToolItem - the new #GtkToolItem + the new #GtkToolItem @@ -165447,12 +118505,8 @@ See the #GtkToolbar class for a description of the toolbar widget, and - - Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item. + + Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item. #GtkToolbar and other #GtkToolShell implementations use this function to notify children, when some aspect of their configuration changes. @@ -165461,164 +118515,110 @@ to notify children, when some aspect of their configuration changes. - a #GtkToolItem + a #GtkToolItem - - Returns the ellipsize mode used for @tool_item. Custom subclasses of + + Returns the ellipsize mode used for @tool_item. Custom subclasses of #GtkToolItem should call this function to find out how text should be ellipsized. - a #PangoEllipsizeMode indicating how text in @tool_item + a #PangoEllipsizeMode indicating how text in @tool_item should be ellipsized. - a #GtkToolItem + a #GtkToolItem - - Returns whether @tool_item is allocated extra space. + + Returns whether @tool_item is allocated extra space. See gtk_tool_item_set_expand(). - %TRUE if @tool_item is allocated extra space. + %TRUE if @tool_item is allocated extra space. - a #GtkToolItem + a #GtkToolItem - - Returns whether @tool_item is the same size as other homogeneous + + Returns whether @tool_item is the same size as other homogeneous items. See gtk_tool_item_set_homogeneous(). - %TRUE if the item is the same size as other homogeneous + %TRUE if the item is the same size as other homogeneous items. - a #GtkToolItem + a #GtkToolItem - - Returns the icon size used for @tool_item. Custom subclasses of + + Returns the icon size used for @tool_item. Custom subclasses of #GtkToolItem should call this function to find out what size icons they should use. - a #GtkIconSize indicating the icon size + a #GtkIconSize indicating the icon size used for @tool_item - + - a #GtkToolItem + a #GtkToolItem - - Returns whether @tool_item is considered important. See + + Returns whether @tool_item is considered important. See gtk_tool_item_set_is_important() - %TRUE if @tool_item is considered important. + %TRUE if @tool_item is considered important. - a #GtkToolItem + a #GtkToolItem - - Returns the orientation used for @tool_item. Custom subclasses of + + Returns the orientation used for @tool_item. Custom subclasses of #GtkToolItem should call this function to find out what size icons they should use. - a #GtkOrientation indicating the orientation + a #GtkOrientation indicating the orientation used for @tool_item - a #GtkToolItem + a #GtkToolItem - - If @menu_item_id matches the string passed to + + If @menu_item_id matches the string passed to gtk_tool_item_set_proxy_menu_item() return the corresponding #GtkMenuItem. Custom subclasses of #GtkToolItem should use this function to @@ -165627,134 +118627,92 @@ update their menu item when the #GtkToolItem changes. That the will not inadvertently change a menu item that they did not create. - The #GtkMenuItem passed to + The #GtkMenuItem passed to gtk_tool_item_set_proxy_menu_item(), if the @menu_item_ids match. - a #GtkToolItem + a #GtkToolItem - a string used to identify the menu item + a string used to identify the menu item - - Returns the relief style of @tool_item. See gtk_button_set_relief(). + + Returns the relief style of @tool_item. See gtk_button_set_relief(). Custom subclasses of #GtkToolItem should call this function in the handler of the #GtkToolItem::toolbar_reconfigured signal to find out the relief style of buttons. - a #GtkReliefStyle indicating the relief style used + a #GtkReliefStyle indicating the relief style used for @tool_item. - a #GtkToolItem + a #GtkToolItem - - Returns the text alignment used for @tool_item. Custom subclasses of + + Returns the text alignment used for @tool_item. Custom subclasses of #GtkToolItem should call this function to find out how text should be aligned. - a #gfloat indicating the horizontal text alignment + a #gfloat indicating the horizontal text alignment used for @tool_item - a #GtkToolItem: + a #GtkToolItem: - - Returns the text orientation used for @tool_item. Custom subclasses of + + Returns the text orientation used for @tool_item. Custom subclasses of #GtkToolItem should call this function to find out how text should be orientated. - a #GtkOrientation indicating the text orientation + a #GtkOrientation indicating the text orientation used for @tool_item - a #GtkToolItem + a #GtkToolItem - - Returns the size group used for labels in @tool_item. + + Returns the size group used for labels in @tool_item. Custom subclasses of #GtkToolItem should call this function and use the size group for labels. - a #GtkSizeGroup + a #GtkSizeGroup - a #GtkToolItem + a #GtkToolItem - - Returns the toolbar style used for @tool_item. Custom subclasses of + + Returns the toolbar style used for @tool_item. Custom subclasses of #GtkToolItem should call this function in the handler of the GtkToolItem::toolbar_reconfigured signal to find out in what style the toolbar is displayed and change themselves accordingly @@ -165768,97 +118726,65 @@ Possibilities are: both an icon and a label, arranged horizontally - A #GtkToolbarStyle indicating the toolbar style used + A #GtkToolbarStyle indicating the toolbar style used for @tool_item. - a #GtkToolItem + a #GtkToolItem - - Returns whether @tool_item has a drag window. See + + Returns whether @tool_item has a drag window. See gtk_tool_item_set_use_drag_window(). - %TRUE if @tool_item uses a drag window. + %TRUE if @tool_item uses a drag window. - a #GtkToolItem + a #GtkToolItem - - Returns whether the @tool_item is visible on toolbars that are + + Returns whether the @tool_item is visible on toolbars that are docked horizontally. - %TRUE if @tool_item is visible on toolbars that are + %TRUE if @tool_item is visible on toolbars that are docked horizontally. - a #GtkToolItem + a #GtkToolItem - - Returns whether @tool_item is visible when the toolbar is docked vertically. + + Returns whether @tool_item is visible when the toolbar is docked vertically. See gtk_tool_item_set_visible_vertical(). - Whether @tool_item is visible when the toolbar is docked vertically + Whether @tool_item is visible when the toolbar is docked vertically - a #GtkToolItem + a #GtkToolItem - - Calling this function signals to the toolbar that the + + Calling this function signals to the toolbar that the overflow menu item for @tool_item has changed. If the overflow menu is visible when this function it called, the menu will be rebuilt. @@ -165871,44 +118797,30 @@ will do in response to the #GtkToolItem::create-menu-proxy signal. - a #GtkToolItem + a #GtkToolItem - - Returns the #GtkMenuItem that was last set by + + Returns the #GtkMenuItem that was last set by gtk_tool_item_set_proxy_menu_item(), ie. the #GtkMenuItem that is going to appear in the overflow menu. - The #GtkMenuItem that is going to appear in the + The #GtkMenuItem that is going to appear in the overflow menu for @tool_item. - a #GtkToolItem + a #GtkToolItem - - Sets whether @tool_item is allocated extra space when there + + Sets whether @tool_item is allocated extra space when there is more room on the toolbar then needed for the items. The effect is that the item gets bigger when the toolbar gets bigger and smaller when the toolbar gets smaller. @@ -165918,25 +118830,17 @@ and smaller when the toolbar gets smaller. - a #GtkToolItem + a #GtkToolItem - Whether @tool_item is allocated extra space + Whether @tool_item is allocated extra space - - Sets whether @tool_item is to be allocated the same size as other + + Sets whether @tool_item is to be allocated the same size as other homogeneous items. The effect is that all homogeneous items will have the same width as the widest of the items. @@ -165945,54 +118849,38 @@ the same width as the widest of the items. - a #GtkToolItem + a #GtkToolItem - whether @tool_item is the same size as other homogeneous items + whether @tool_item is the same size as other homogeneous items - - Sets whether @tool_item should be considered important. The #GtkToolButton + + Sets whether @tool_item should be considered important. The #GtkToolButton class uses this property to determine whether to show or hide its label when the toolbar style is %GTK_TOOLBAR_BOTH_HORIZ. The result is that -only tool buttons with the “is_important” property set have labels, an -effect known as “priority text” +only tool buttons with the “is_important” property set have labels, an +effect known as “priority text” - a #GtkToolItem + a #GtkToolItem - whether the tool item should be considered important + whether the tool item should be considered important - - Sets the #GtkMenuItem used in the toolbar overflow menu. The + + Sets the #GtkMenuItem used in the toolbar overflow menu. The @menu_item_id is used to identify the caller of this function and should also be used with gtk_tool_item_get_proxy_menu_item(). @@ -166003,34 +118891,21 @@ See also #GtkToolItem::create-menu-proxy. - a #GtkToolItem + a #GtkToolItem - a string used to identify @menu_item + a string used to identify @menu_item - - a #GtkMenuItem to use in the overflow menu, or %NULL + + a #GtkMenuItem to use in the overflow menu, or %NULL - - Sets the markup text to be displayed as tooltip on the item. + + Sets the markup text to be displayed as tooltip on the item. See gtk_widget_set_tooltip_markup(). @@ -166038,25 +118913,17 @@ See gtk_widget_set_tooltip_markup(). - a #GtkToolItem + a #GtkToolItem - markup text to be used as tooltip for @tool_item + markup text to be used as tooltip for @tool_item - - Sets the text to be displayed as tooltip on the item. + + Sets the text to be displayed as tooltip on the item. See gtk_widget_set_tooltip_text(). @@ -166064,25 +118931,17 @@ See gtk_widget_set_tooltip_text(). - a #GtkToolItem + a #GtkToolItem - text to be used as tooltip for @tool_item + text to be used as tooltip for @tool_item - - Sets whether @tool_item has a drag window. When %TRUE the + + Sets whether @tool_item has a drag window. When %TRUE the toolitem can be used as a drag source through gtk_drag_source_set(). When @tool_item has a drag window it will intercept all events, even those that would otherwise be sent to a child of @tool_item. @@ -166092,50 +118951,34 @@ even those that would otherwise be sent to a child of @tool_item. - a #GtkToolItem + a #GtkToolItem - Whether @tool_item has a drag window. + Whether @tool_item has a drag window. - - Sets whether @tool_item is visible when the toolbar is docked horizontally. + + Sets whether @tool_item is visible when the toolbar is docked horizontally. - a #GtkToolItem + a #GtkToolItem - Whether @tool_item is visible when in horizontal mode + Whether @tool_item is visible when in horizontal mode - - Sets whether @tool_item is visible when the toolbar is docked + + Sets whether @tool_item is visible when the toolbar is docked vertically. Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If @visible_vertical is %FALSE @tool_item will not appear on toolbars that are docked vertically. @@ -166145,26 +118988,18 @@ useful on a vertically docked toolbar. If @visible_vertical is %FALSE - a #GtkToolItem + a #GtkToolItem - whether @tool_item is visible when the toolbar + whether @tool_item is visible when the toolbar is in vertical mode - - Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item. + + Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item. #GtkToolbar and other #GtkToolShell implementations use this function to notify children, when some aspect of their configuration changes. @@ -166173,9 +119008,7 @@ to notify children, when some aspect of their configuration changes. - a #GtkToolItem + a #GtkToolItem @@ -166183,9 +119016,7 @@ to notify children, when some aspect of their configuration changes. - + @@ -166198,9 +119029,7 @@ to notify children, when some aspect of their configuration changes. - This signal is emitted when the toolbar needs information from @tool_item + This signal is emitted when the toolbar needs information from @tool_item about whether the item should appear in the toolbar overflow menu. In response the tool item should either @@ -166220,16 +119049,12 @@ how it will respond to this signal it must call gtk_tool_item_rebuild_menu() to invalidate the cache and ensure that the toolbar rebuilds its overflow menu. - %TRUE if the signal was handled, %FALSE if not + %TRUE if the signal was handled, %FALSE if not - This signal is emitted when some property of the toolbar that the + This signal is emitted when some property of the toolbar that the item is a child of changes. For custom subclasses of #GtkToolItem, the default handler of this signal use the functions - gtk_tool_shell_get_orientation() @@ -166243,14 +119068,10 @@ themselves accordingly. - + - The parent class. + The parent class. @@ -166274,9 +119095,7 @@ themselves accordingly. - a #GtkToolItem + a #GtkToolItem @@ -166315,17 +119134,8 @@ themselves accordingly. - - A #GtkToolItemGroup is used together with #GtkToolPalette to add + + A #GtkToolItemGroup is used together with #GtkToolPalette to add #GtkToolItems to a palette like container with different categories and drag and drop support. @@ -166336,341 +119146,223 @@ GtkToolItemGroup has a single CSS node named toolitemgroup. - - Creates a new tool item group with label @label. + + Creates a new tool item group with label @label. - a new #GtkToolItemGroup. + a new #GtkToolItemGroup. - the label of the new group + the label of the new group - - Gets whether @group is collapsed or expanded. + + Gets whether @group is collapsed or expanded. - %TRUE if @group is collapsed, %FALSE if it is expanded + %TRUE if @group is collapsed, %FALSE if it is expanded - a GtkToolItemGroup + a GtkToolItemGroup - - Gets the tool item at position (x, y). + + Gets the tool item at position (x, y). - the #GtkToolItem at position (x, y) + the #GtkToolItem at position (x, y) - a #GtkToolItemGroup + a #GtkToolItemGroup - the x position + the x position - the y position + the y position - - Gets the ellipsization mode of @group. + + Gets the ellipsization mode of @group. - the #PangoEllipsizeMode of @group + the #PangoEllipsizeMode of @group - a #GtkToolItemGroup + a #GtkToolItemGroup - - Gets the relief mode of the header button of @group. + + Gets the relief mode of the header button of @group. - the #GtkReliefStyle + the #GtkReliefStyle - a #GtkToolItemGroup + a #GtkToolItemGroup - - Gets the position of @item in @group as index. + + Gets the position of @item in @group as index. - the index of @item in @group or -1 if @item is no child of @group + the index of @item in @group or -1 if @item is no child of @group - a #GtkToolItemGroup + a #GtkToolItemGroup - a #GtkToolItem + a #GtkToolItem - - Gets the label of @group. + + Gets the label of @group. - the label of @group. The label is an internal string of @group + the label of @group. The label is an internal string of @group and must not be modified. Note that %NULL is returned if a custom label has been set with gtk_tool_item_group_set_label_widget() - a #GtkToolItemGroup + a #GtkToolItemGroup - - Gets the label widget of @group. + + Gets the label widget of @group. See gtk_tool_item_group_set_label_widget(). - the label widget of @group + the label widget of @group - a #GtkToolItemGroup + a #GtkToolItemGroup - - Gets the number of tool items in @group. + + Gets the number of tool items in @group. - the number of tool items in @group + the number of tool items in @group - a #GtkToolItemGroup + a #GtkToolItemGroup - - Gets the tool item at @index in group. + + Gets the tool item at @index in group. - the #GtkToolItem at index + the #GtkToolItem at index - a #GtkToolItemGroup + a #GtkToolItemGroup - the index + the index - - Inserts @item at @position in the list of children of @group. + + Inserts @item at @position in the list of children of @group. - a #GtkToolItemGroup + a #GtkToolItemGroup - the #GtkToolItem to insert into @group + the #GtkToolItem to insert into @group - the position of @item in @group, starting with 0. + the position of @item in @group, starting with 0. The position -1 means end of list. - - Sets whether the @group should be collapsed or expanded. + + Sets whether the @group should be collapsed or expanded. - a #GtkToolItemGroup + a #GtkToolItemGroup - whether the @group should be collapsed or expanded + whether the @group should be collapsed or expanded - - Sets the ellipsization mode which should be used by labels in @group. + + Sets the ellipsization mode which should be used by labels in @group. - a #GtkToolItemGroup + a #GtkToolItemGroup - the #PangoEllipsizeMode labels in @group should use + the #PangoEllipsizeMode labels in @group should use - - Set the button relief of the group header. + + Set the button relief of the group header. See gtk_button_set_relief() for details. @@ -166678,58 +119370,40 @@ See gtk_button_set_relief() for details. - a #GtkToolItemGroup + a #GtkToolItemGroup - the #GtkReliefStyle + the #GtkReliefStyle - - Sets the position of @item in the list of children of @group. + + Sets the position of @item in the list of children of @group. - a #GtkToolItemGroup + a #GtkToolItemGroup - the #GtkToolItem to move to a new position, should + the #GtkToolItem to move to a new position, should be a child of @group. - the new position of @item in @group, starting with 0. + the new position of @item in @group, starting with 0. The position -1 means end of list. - - Sets the label of the tool item group. The label is displayed in the header + + Sets the label of the tool item group. The label is displayed in the header of the group. @@ -166737,25 +119411,17 @@ of the group. - a #GtkToolItemGroup + a #GtkToolItemGroup - the new human-readable label of of the group + the new human-readable label of of the group - - Sets the label of the tool item group. + + Sets the label of the tool item group. The label widget is displayed in the header of the group, in place of the usual label. @@ -166764,15 +119430,11 @@ of the usual label. - a #GtkToolItemGroup + a #GtkToolItemGroup - the widget to be displayed in place of the usual label + the widget to be displayed in place of the usual label @@ -166799,14 +119461,10 @@ of the usual label. - + - The parent class. + The parent class. @@ -166842,25 +119500,14 @@ of the usual label. - + - - A #GtkToolPalette allows you to add #GtkToolItems to a palette-like + + A #GtkToolPalette allows you to add #GtkToolItems to a palette-like container with different categories and drag and drop support. A #GtkToolPalette is created with a call to gtk_tool_palette_new(). @@ -166934,54 +119581,32 @@ GtkToolPalette has a single CSS node named toolpalette. - - Creates a new tool palette. + + Creates a new tool palette. - a new #GtkToolPalette + a new #GtkToolPalette - - Get the target entry for a dragged #GtkToolItemGroup. + + Get the target entry for a dragged #GtkToolItemGroup. - the #GtkTargetEntry for a dragged group + the #GtkTargetEntry for a dragged group - - Gets the target entry for a dragged #GtkToolItem. + + Gets the target entry for a dragged #GtkToolItem. - the #GtkTargetEntry for a dragged item. + the #GtkTargetEntry for a dragged item. - - Sets @palette as drag source (see gtk_tool_palette_set_drag_source()) + + Sets @palette as drag source (see gtk_tool_palette_set_drag_source()) and sets @widget as a drag destination for drags from @palette. See gtk_drag_dest_set(). @@ -166990,327 +119615,212 @@ See gtk_drag_dest_set(). - a #GtkToolPalette + a #GtkToolPalette - a #GtkWidget which should be a drag destination for @palette + a #GtkWidget which should be a drag destination for @palette - the flags that specify what actions GTK+ should take for drops + the flags that specify what actions GTK+ should take for drops on that widget - the #GtkToolPaletteDragTargets which the widget + the #GtkToolPaletteDragTargets which the widget should support - + - the #GdkDragActions which the widget should suppport + the #GdkDragActions which the widget should suppport - - Get the dragged item from the selection. + + Get the dragged item from the selection. This could be a #GtkToolItem or a #GtkToolItemGroup. - the dragged item in selection + the dragged item in selection - a #GtkToolPalette + a #GtkToolPalette - a #GtkSelectionData + a #GtkSelectionData - - Gets the group at position (x, y). + + Gets the group at position (x, y). - the #GtkToolItemGroup at position + the #GtkToolItemGroup at position or %NULL if there is no such group - a #GtkToolPalette + a #GtkToolPalette - the x position + the x position - the y position + the y position - - Gets the item at position (x, y). + + Gets the item at position (x, y). See gtk_tool_palette_get_drop_group(). - the #GtkToolItem at position or %NULL if there is no such item + the #GtkToolItem at position or %NULL if there is no such item - a #GtkToolPalette + a #GtkToolPalette - the x position + the x position - the y position + the y position - - Gets whether @group is exclusive or not. + + Gets whether @group is exclusive or not. See gtk_tool_palette_set_exclusive(). - %TRUE if @group is exclusive + %TRUE if @group is exclusive - a #GtkToolPalette + a #GtkToolPalette - a #GtkToolItemGroup which is a child of palette + a #GtkToolItemGroup which is a child of palette - - Gets whether group should be given extra space. + + Gets whether group should be given extra space. See gtk_tool_palette_set_expand(). - %TRUE if group should be given extra space, %FALSE otherwise + %TRUE if group should be given extra space, %FALSE otherwise - a #GtkToolPalette + a #GtkToolPalette - a #GtkToolItemGroup which is a child of palette + a #GtkToolItemGroup which is a child of palette - - Gets the position of @group in @palette as index. + + Gets the position of @group in @palette as index. See gtk_tool_palette_set_group_position(). - the index of group or -1 if @group is not a child of @palette + the index of group or -1 if @group is not a child of @palette - a #GtkToolPalette + a #GtkToolPalette - a #GtkToolItemGroup + a #GtkToolItemGroup - - Gets the horizontal adjustment of the tool palette. + + Gets the horizontal adjustment of the tool palette. Use gtk_scrollable_get_hadjustment() - the horizontal adjustment of @palette + the horizontal adjustment of @palette - a #GtkToolPalette + a #GtkToolPalette - - Gets the size of icons in the tool palette. + + Gets the size of icons in the tool palette. See gtk_tool_palette_set_icon_size(). - the #GtkIconSize of icons in the tool palette - + the #GtkIconSize of icons in the tool palette + - a #GtkToolPalette + a #GtkToolPalette - - Gets the style (icons, text or both) of items in the tool palette. + + Gets the style (icons, text or both) of items in the tool palette. - the #GtkToolbarStyle of items in the tool palette. + the #GtkToolbarStyle of items in the tool palette. - a #GtkToolPalette + a #GtkToolPalette - - Gets the vertical adjustment of the tool palette. + + Gets the vertical adjustment of the tool palette. Use gtk_scrollable_get_vadjustment() - the vertical adjustment of @palette + the vertical adjustment of @palette - a #GtkToolPalette + a #GtkToolPalette - - Sets the tool palette as a drag source. + + Sets the tool palette as a drag source. Enables all groups and items in the tool palette as drag sources on button 1 and button 3 press with copy and move actions. See gtk_drag_source_set(). @@ -167320,27 +119830,18 @@ See gtk_drag_source_set(). - a #GtkToolPalette + a #GtkToolPalette - the #GtkToolPaletteDragTargets + the #GtkToolPaletteDragTargets which the widget should support - + - - Sets whether the group should be exclusive or not. + + Sets whether the group should be exclusive or not. If an exclusive group is expanded all other groups are collapsed. @@ -167348,62 +119849,42 @@ If an exclusive group is expanded all other groups are collapsed. - a #GtkToolPalette + a #GtkToolPalette - a #GtkToolItemGroup which is a child of palette + a #GtkToolItemGroup which is a child of palette - whether the group should be exclusive or not + whether the group should be exclusive or not - - Sets whether the group should be given extra space. + + Sets whether the group should be given extra space. - a #GtkToolPalette + a #GtkToolPalette - a #GtkToolItemGroup which is a child of palette + a #GtkToolItemGroup which is a child of palette - whether the group should be given extra space + whether the group should be given extra space - - Sets the position of the group as an index of the tool palette. + + Sets the position of the group as an index of the tool palette. If position is 0 the group will become the first child, if position is -1 it will become the last child. @@ -167412,82 +119893,56 @@ If position is 0 the group will become the first child, if position is - a #GtkToolPalette + a #GtkToolPalette - a #GtkToolItemGroup which is a child of palette + a #GtkToolItemGroup which is a child of palette - a new index for group + a new index for group - - Sets the size of icons in the tool palette. + + Sets the size of icons in the tool palette. - a #GtkToolPalette + a #GtkToolPalette - the #GtkIconSize that icons in the tool + the #GtkIconSize that icons in the tool palette shall have - + - - Sets the style (text, icons or both) of items in the tool palette. + + Sets the style (text, icons or both) of items in the tool palette. - a #GtkToolPalette + a #GtkToolPalette - the #GtkToolbarStyle that items in the tool palette shall have + the #GtkToolbarStyle that items in the tool palette shall have - - Unsets the tool palette icon size set with gtk_tool_palette_set_icon_size(), + + Unsets the tool palette icon size set with gtk_tool_palette_set_icon_size(), so that user preferences will be used to determine the icon size. @@ -167495,19 +119950,13 @@ so that user preferences will be used to determine the icon size. - a #GtkToolPalette + a #GtkToolPalette - - Unsets a toolbar style set with gtk_tool_palette_set_style(), + + Unsets a toolbar style set with gtk_tool_palette_set_style(), so that user preferences will be used to determine the toolbar style. @@ -167515,20 +119964,13 @@ so that user preferences will be used to determine the toolbar style. - a #GtkToolPalette + a #GtkToolPalette - - The size of the icons in a tool palette. When this property is set, + + The size of the icons in a tool palette. When this property is set, it overrides the default setting. This should only be used for special-purpose tool palettes, normal @@ -167536,22 +119978,12 @@ application tool palettes should respect the user preferences for the size of icons. - - Is %TRUE if the #GtkToolPalette:icon-size property has been set. + + Is %TRUE if the #GtkToolPalette:icon-size property has been set. - - The style of items in the tool palette. + + The style of items in the tool palette. @@ -167561,14 +119993,10 @@ size of icons. - + - The parent class. + The parent class. @@ -167604,67 +120032,35 @@ size of icons. - - Flags used to specify the supported drag targets. - - Support drag of items. + + Flags used to specify the supported drag targets. + + Support drag of items. - - Support drag of groups. + + Support drag of groups. - + - - The #GtkToolShell interface allows container widgets to provide additional + + The #GtkToolShell interface allows container widgets to provide additional information when embedding #GtkToolItem widgets. - - Retrieves the current ellipsize mode for the tool shell. Tool items must not + + Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_ellipsize_mode() instead. - the current ellipsize mode of @shell + the current ellipsize mode of @shell - a #GtkToolShell + a #GtkToolShell @@ -167680,153 +120076,103 @@ instead. - - Retrieves the current orientation for the tool shell. Tool items must not + + Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_orientation() instead. - the current orientation of @shell + the current orientation of @shell - a #GtkToolShell + a #GtkToolShell - - Returns the relief style of buttons on @shell. Tool items must not call this + + Returns the relief style of buttons on @shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_relief_style() instead. - The relief style of buttons on @shell. + The relief style of buttons on @shell. - a #GtkToolShell + a #GtkToolShell - Retrieves whether the tool shell has text, icons, or both. Tool items must + Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on gtk_tool_item_get_toolbar_style() instead. - the current style of @shell + the current style of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the current text alignment for the tool shell. Tool items must not + + Retrieves the current text alignment for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_alignment() instead. - the current text alignment of @shell + the current text alignment of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the current text orientation for the tool shell. Tool items must not + + Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_orientation() instead. - the current text orientation of @shell + the current text orientation of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the current text size group for the tool shell. Tool items must not + + Retrieves the current text size group for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_size_group() instead. - the current text size group of @shell + the current text size group of @shell - a #GtkToolShell + a #GtkToolShell - - Calling this function signals the tool shell that the overflow menu item for + + Calling this function signals the tool shell that the overflow menu item for tool items have changed. If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt. @@ -167838,209 +120184,139 @@ gtk_tool_item_rebuild_menu() instead. - a #GtkToolShell + a #GtkToolShell - - Retrieves the current ellipsize mode for the tool shell. Tool items must not + + Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_ellipsize_mode() instead. - the current ellipsize mode of @shell + the current ellipsize mode of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the icon size for the tool shell. Tool items must not call this + + Retrieves the icon size for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_icon_size() instead. - the current size (#GtkIconSize) for icons of @shell - + the current size (#GtkIconSize) for icons of @shell + - a #GtkToolShell + a #GtkToolShell - - Retrieves the current orientation for the tool shell. Tool items must not + + Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_orientation() instead. - the current orientation of @shell + the current orientation of @shell - a #GtkToolShell + a #GtkToolShell - - Returns the relief style of buttons on @shell. Tool items must not call this + + Returns the relief style of buttons on @shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_relief_style() instead. - The relief style of buttons on @shell. + The relief style of buttons on @shell. - a #GtkToolShell + a #GtkToolShell - - Retrieves whether the tool shell has text, icons, or both. Tool items must + + Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on gtk_tool_item_get_toolbar_style() instead. - the current style of @shell + the current style of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the current text alignment for the tool shell. Tool items must not + + Retrieves the current text alignment for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_alignment() instead. - the current text alignment of @shell + the current text alignment of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the current text orientation for the tool shell. Tool items must not + + Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_orientation() instead. - the current text orientation of @shell + the current text orientation of @shell - a #GtkToolShell + a #GtkToolShell - - Retrieves the current text size group for the tool shell. Tool items must not + + Retrieves the current text size group for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_size_group() instead. - the current text size group of @shell + the current text size group of @shell - a #GtkToolShell + a #GtkToolShell - - Calling this function signals the tool shell that the overflow menu item for + + Calling this function signals the tool shell that the overflow menu item for tool items have changed. If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt. @@ -168052,20 +120328,14 @@ gtk_tool_item_rebuild_menu() instead. - a #GtkToolShell + a #GtkToolShell - - Virtual function table for the #GtkToolShell interface. + + Virtual function table for the #GtkToolShell interface. @@ -168087,16 +120357,12 @@ gtk_tool_item_rebuild_menu() instead. - the current orientation of @shell + the current orientation of @shell - a #GtkToolShell + a #GtkToolShell @@ -168106,16 +120372,12 @@ gtk_tool_item_rebuild_menu() instead. - the current style of @shell + the current style of @shell - a #GtkToolShell + a #GtkToolShell @@ -168125,16 +120387,12 @@ gtk_tool_item_rebuild_menu() instead. - The relief style of buttons on @shell. + The relief style of buttons on @shell. - a #GtkToolShell + a #GtkToolShell @@ -168148,9 +120406,7 @@ gtk_tool_item_rebuild_menu() instead. - a #GtkToolShell + a #GtkToolShell @@ -168160,16 +120416,12 @@ gtk_tool_item_rebuild_menu() instead. - the current text orientation of @shell + the current text orientation of @shell - a #GtkToolShell + a #GtkToolShell @@ -168179,16 +120431,12 @@ gtk_tool_item_rebuild_menu() instead. - the current text alignment of @shell + the current text alignment of @shell - a #GtkToolShell + a #GtkToolShell @@ -168198,16 +120446,12 @@ gtk_tool_item_rebuild_menu() instead. - the current ellipsize mode of @shell + the current ellipsize mode of @shell - a #GtkToolShell + a #GtkToolShell @@ -168217,32 +120461,20 @@ gtk_tool_item_rebuild_menu() instead. - the current text size group of @shell + the current text size group of @shell - a #GtkToolShell + a #GtkToolShell - - A toolbar is created with a call to gtk_toolbar_new(). + + A toolbar is created with a call to gtk_toolbar_new(). A toolbar can contain instances of a subclass of #GtkToolItem. To add a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove @@ -168251,7 +120483,7 @@ to the toolbar, add an instance of #GtkToolButton. Toolbar items can be visually grouped by adding instances of #GtkSeparatorToolItem to the toolbar. If the GtkToolbar child property -“expand” is #TRUE and the property #GtkSeparatorToolItem:draw is set to +“expand” is #TRUE and the property #GtkSeparatorToolItem:draw is set to #FALSE, the effect is to force all following items to the end of the toolbar. By default, a toolbar can be shrunk, upon which it will add an arrow button @@ -168271,14 +120503,10 @@ GtkToolbar has a single CSS node with name toolbar. - Creates a new toolbar. + Creates a new toolbar. - the newly-created toolbar. + the newly-created toolbar. @@ -168330,12 +120558,8 @@ GtkToolbar has a single CSS node with name toolbar. - - Returns the position corresponding to the indicated point on + + Returns the position corresponding to the indicated point on @toolbar. This is useful when dragging items to the toolbar: this function returns the position a new item should be inserted. @@ -168343,204 +120567,138 @@ inserted. @x and @y are in @toolbar coordinates. - The position corresponding to the point (@x, @y) on the toolbar. + The position corresponding to the point (@x, @y) on the toolbar. - a #GtkToolbar + a #GtkToolbar - x coordinate of a point on the toolbar + x coordinate of a point on the toolbar - y coordinate of a point on the toolbar + y coordinate of a point on the toolbar - Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size(). + Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size(). - the current icon size for the icons on the toolbar. + the current icon size for the icons on the toolbar. - a #GtkToolbar + a #GtkToolbar - - Returns the position of @item on the toolbar, starting from 0. + + Returns the position of @item on the toolbar, starting from 0. It is an error if @item is not a child of the toolbar. - the position of item on the toolbar. + the position of item on the toolbar. - a #GtkToolbar + a #GtkToolbar - a #GtkToolItem that is a child of @toolbar + a #GtkToolItem that is a child of @toolbar - - Returns the number of items on the toolbar. + + Returns the number of items on the toolbar. - the number of items on the toolbar + the number of items on the toolbar - a #GtkToolbar + a #GtkToolbar - - Returns the @n'th item on @toolbar, or %NULL if the + + Returns the @n'th item on @toolbar, or %NULL if the toolbar does not contain an @n'th item. - The @n'th #GtkToolItem on @toolbar, - or %NULL if there isn’t an @n'th item. + The @n'th #GtkToolItem on @toolbar, + or %NULL if there isn’t an @n'th item. - a #GtkToolbar + a #GtkToolbar - A position on the toolbar + A position on the toolbar - - Returns the relief style of buttons on @toolbar. See + + Returns the relief style of buttons on @toolbar. See gtk_button_set_relief(). - The relief style of buttons on @toolbar. + The relief style of buttons on @toolbar. - a #GtkToolbar + a #GtkToolbar - - Returns whether the toolbar has an overflow menu. + + Returns whether the toolbar has an overflow menu. See gtk_toolbar_set_show_arrow(). - %TRUE if the toolbar has an overflow menu. + %TRUE if the toolbar has an overflow menu. - a #GtkToolbar + a #GtkToolbar - Retrieves whether the toolbar has text, icons, or both . See + Retrieves whether the toolbar has text, icons, or both . See gtk_toolbar_set_style(). - the current style of @toolbar + the current style of @toolbar - a #GtkToolbar + a #GtkToolbar - Insert a #GtkToolItem into the toolbar at position @pos. If @pos is + Insert a #GtkToolItem into the toolbar at position @pos. If @pos is 0 the item is prepended to the start of the toolbar. If @pos is negative, the item is appended to the end of the toolbar. @@ -168549,31 +120707,21 @@ negative, the item is appended to the end of the toolbar. - a #GtkToolbar + a #GtkToolbar - a #GtkToolItem + a #GtkToolItem - the position of the new item + the position of the new item - - Highlights @toolbar to give an idea of what it would look like + + Highlights @toolbar to give an idea of what it would look like if @item was added to @toolbar at the position indicated by @index_. If @item is %NULL, highlighting is turned off. In that case @index_ is ignored. @@ -168588,33 +120736,22 @@ toolbar. - a #GtkToolbar + a #GtkToolbar - - a #GtkToolItem, or %NULL to turn of highlighting + + a #GtkToolItem, or %NULL to turn of highlighting - a position on @toolbar + a position on @toolbar - This function sets the size of stock icons in the toolbar. You -can call it both before you add the icons and after they’ve been + This function sets the size of stock icons in the toolbar. You +can call it both before you add the icons and after they’ve been added. The size you set will override user preferences for the default icon size. @@ -168627,26 +120764,18 @@ size of icons. - A #GtkToolbar + A #GtkToolbar - The #GtkIconSize that stock icons in the toolbar shall have. + The #GtkIconSize that stock icons in the toolbar shall have. - - Sets whether to show an overflow menu when @toolbar isn’t allocated enough -size to show all of its items. If %TRUE, items which can’t fit in @toolbar, + + Sets whether to show an overflow menu when @toolbar isn’t allocated enough +size to show all of its items. If %TRUE, items which can’t fit in @toolbar, and which have a proxy menu item set by gtk_tool_item_set_proxy_menu_item() or #GtkToolItem::create-menu-proxy, will be available in an overflow menu, which can be opened by an added arrow button. If %FALSE, @toolbar will @@ -168657,47 +120786,34 @@ request enough size to fit all of its child items without any overflow. - a #GtkToolbar + a #GtkToolbar - Whether to show an overflow menu + Whether to show an overflow menu - Alters the view of @toolbar to display either icons only, text only, or both. + Alters the view of @toolbar to display either icons only, text only, or both. - a #GtkToolbar. + a #GtkToolbar. - the new style for @toolbar. + the new style for @toolbar. - - Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that + + Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that user preferences will be used to determine the icon size. @@ -168705,17 +120821,13 @@ user preferences will be used to determine the icon size. - a #GtkToolbar + a #GtkToolbar - Unsets a toolbar style set with gtk_toolbar_set_style(), so that + Unsets a toolbar style set with gtk_toolbar_set_style(), so that user preferences will be used to determine the toolbar style. @@ -168723,20 +120835,13 @@ user preferences will be used to determine the toolbar style. - a #GtkToolbar + a #GtkToolbar - - The size of the icons in a toolbar is normally determined by + + The size of the icons in a toolbar is normally determined by the toolbar-icon-size setting. When this property is set, it overrides the setting. @@ -168745,13 +120850,8 @@ application toolbars should respect the user preferences for the size of icons. - - Is %TRUE if the icon-size property has been set. + + Is %TRUE if the icon-size property has been set. @@ -168767,45 +120867,33 @@ size of icons. - A keybinding signal used internally by GTK+. This signal can't + A keybinding signal used internally by GTK+. This signal can't be used in application code - %TRUE if the signal was handled, %FALSE if not + %TRUE if the signal was handled, %FALSE if not - %TRUE if the first item should be focused + %TRUE if the first item should be focused - Emitted when the orientation of the toolbar changes. + Emitted when the orientation of the toolbar changes. - the new #GtkOrientation of the toolbar + the new #GtkOrientation of the toolbar - Emitted when the user right-clicks the toolbar or uses the + Emitted when the user right-clicks the toolbar or uses the keybinding to display a popup menu. Application developers should handle this signal if they want @@ -168814,52 +120902,38 @@ appear at the coordinates given by @x and @y. The mouse button number is given by the @button parameter. If the menu was popped up using the keybaord, @button is -1. - return %TRUE if the signal was handled, %FALSE if not + return %TRUE if the signal was handled, %FALSE if not - the x coordinate of the point where the menu should appear + the x coordinate of the point where the menu should appear - the y coordinate of the point where the menu should appear + the y coordinate of the point where the menu should appear - the mouse button the user pressed, or -1 + the mouse button the user pressed, or -1 - Emitted when the style of the toolbar changes. + Emitted when the style of the toolbar changes. - the new #GtkToolbarStyle of the toolbar + the new #GtkToolbarStyle of the toolbar - + @@ -168954,86 +121028,37 @@ up using the keybaord, @button is -1. - - Whether spacers are vertical lines or just blank. - - Use blank spacers. + + Whether spacers are vertical lines or just blank. + + Use blank spacers. - - Use vertical lines for spacers. + + Use vertical lines for spacers. - - Used to customize the appearance of a #GtkToolbar. Note that -setting the toolbar style overrides the user’s preferences + + Used to customize the appearance of a #GtkToolbar. Note that +setting the toolbar style overrides the user’s preferences for the default toolbar style. Note that if the button has only a label set and GTK_TOOLBAR_ICONS is used, the label will be visible, and vice versa. - - Buttons display only icons in the toolbar. + + Buttons display only icons in the toolbar. - - Buttons display only text labels in the toolbar. + + Buttons display only text labels in the toolbar. - - Buttons display text and icons in the toolbar. + + Buttons display text and icons in the toolbar. - - Buttons display icons and text alongside each + + Buttons display icons and text alongside each other, rather than vertically stacked - - Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text() + + Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text() or gtk_widget_set_tooltip_markup() without any explicit tooltip object. When you need a tooltip with a little more fancy contents, like adding an @@ -169049,7 +121074,7 @@ row or cell, you will have to do a little more work: to the signal handler is a GtkTooltip object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions like gtk_tooltip_set_icon(). There are functions for setting - the tooltip’s markup, setting an image from a named icon, or even putting in + the tooltip’s markup, setting an image from a named icon, or even putting in a custom widget. Return %TRUE from your query-tooltip handler. This causes the tooltip to be @@ -169067,12 +121092,8 @@ will be used as tooltip window. This works as follows: gtk_widget_get_tooltip_window() and manipulate as you wish. The semantics of the return value are exactly as before, return %TRUE to show the window, %FALSE to not show it. - - Triggers a new tooltip query on @display, in order to update the current + + Triggers a new tooltip query on @display, in order to update the current visible tooltip, or to show/hide the current tooltip. This function is useful to call when, for example, the state of the widget changed by a key press. @@ -169082,19 +121103,13 @@ key press. - a #GdkDisplay + a #GdkDisplay - - Replaces the widget packed into the tooltip with + + Replaces the widget packed into the tooltip with @custom_widget. @custom_widget does not get destroyed when the tooltip goes away. By default a box with a #GtkImage and #GtkLabel is embedded in @@ -169106,28 +121121,17 @@ and gtk_tooltip_set_icon(). - a #GtkTooltip + a #GtkTooltip - - a #GtkWidget, or %NULL to unset the old custom widget. + + a #GtkWidget, or %NULL to unset the old custom widget. - - Sets the icon of the tooltip (which is in front of the text) to be + + Sets the icon of the tooltip (which is in front of the text) to be @pixbuf. If @pixbuf is %NULL, the image will be hidden. @@ -169135,28 +121139,17 @@ and gtk_tooltip_set_icon(). - a #GtkTooltip + a #GtkTooltip - - a #GdkPixbuf, or %NULL + + a #GdkPixbuf, or %NULL - - Sets the icon of the tooltip (which is in front of the text) + + Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by @gicon with the size indicated by @size. If @gicon is %NULL, the image will be hidden. @@ -169165,34 +121158,21 @@ by @size. If @gicon is %NULL, the image will be hidden. - a #GtkTooltip + a #GtkTooltip - - a #GIcon representing the icon, or %NULL + + a #GIcon representing the icon, or %NULL - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Sets the icon of the tooltip (which is in front of the text) to be + + Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by @icon_name with the size indicated by @size. If @icon_name is %NULL, the image will be hidden. @@ -169201,36 +121181,21 @@ by @size. If @icon_name is %NULL, the image will be hidden. - a #GtkTooltip + a #GtkTooltip - - an icon name, or %NULL + + an icon name, or %NULL - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Sets the icon of the tooltip (which is in front of the text) to be + + Sets the icon of the tooltip (which is in front of the text) to be the stock item indicated by @stock_id with the size indicated by @size. If @stock_id is %NULL, the image will be hidden. Use gtk_tooltip_set_icon_from_icon_name() instead. @@ -169240,34 +121205,21 @@ by @size. If @stock_id is %NULL, the image will be hidden. - a #GtkTooltip + a #GtkTooltip - - a stock id, or %NULL + + a stock id, or %NULL - a stock icon size (#GtkIconSize) - + a stock icon size (#GtkIconSize) + - - Sets the text of the tooltip to be @markup, which is marked up + + Sets the text of the tooltip to be @markup, which is marked up with the [Pango text markup language][PangoMarkupFormat]. If @markup is %NULL, the label will be hidden. @@ -169276,28 +121228,17 @@ If @markup is %NULL, the label will be hidden. - a #GtkTooltip + a #GtkTooltip - - a markup string (see [Pango markup format][PangoMarkupFormat]) or %NULL + + a markup string (see [Pango markup format][PangoMarkupFormat]) or %NULL - - Sets the text of the tooltip to be @text. If @text is %NULL, the label + + Sets the text of the tooltip to be @text. If @text is %NULL, the label will be hidden. See also gtk_tooltip_set_markup(). @@ -169305,28 +121246,17 @@ will be hidden. See also gtk_tooltip_set_markup(). - a #GtkTooltip + a #GtkTooltip - - a text string or %NULL + + a text string or %NULL - - Sets the area of the widget, where the contents of this tooltip apply, + + Sets the area of the widget, where the contents of this tooltip apply, to be @rect (in widget coordinates). This is especially useful for properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews, etc. @@ -169340,36 +121270,22 @@ gtk_tree_view_set_tooltip_cell(). - a #GtkTooltip + a #GtkTooltip - a #GdkRectangle + a #GdkRectangle - + - - + + - List of + List of children. @@ -169385,67 +121301,45 @@ gtk_tree_view_set_tooltip_cell(). - + - + - + - - The function used to translate messages in e.g. #GtkIconFactory + + The function used to translate messages in e.g. #GtkIconFactory and #GtkActionGroup. - the translated message + the translated message - The id of the message. In #GtkActionGroup this will be a label + The id of the message. In #GtkActionGroup this will be a label or tooltip from a #GtkActionEntry. - - user data passed in when registering the + + user data passed in when registering the function - A function to set the properties of a cell instead of just using the + A function to set the properties of a cell instead of just using the straight mapping between the cell and the model. This is useful for customizing the cell renderer. For example, a function might get an -integer from the @tree_model, and render it to the “text” attribute of -“cell” by converting it to its written equivalent. This is set by +integer from the @tree_model, and render it to the “text” attribute of +“cell” by converting it to its written equivalent. This is set by calling gtk_tree_view_column_set_cell_data_func() @@ -169453,37 +121347,23 @@ calling gtk_tree_view_column_set_cell_data_func() - A #GtkTreeViewColumn + A #GtkTreeViewColumn - The #GtkCellRenderer that is being rendered by @tree_column + The #GtkCellRenderer that is being rendered by @tree_column - The #GtkTreeModel being rendered + The #GtkTreeModel being rendered - A #GtkTreeIter of the current row rendered + A #GtkTreeIter of the current row rendered - - user data + + user data @@ -169503,26 +121383,15 @@ calling gtk_tree_view_column_set_cell_data_func() - + - + - Asks the #GtkTreeDragDest to insert a row before the path @dest, + Asks the #GtkTreeDragDest to insert a row before the path @dest, deriving the contents of the row from @selection_data. If @dest is outside the tree so that inserting before it is impossible, %FALSE will be returned. Also, %FALSE may be returned if the new row is @@ -169530,73 +121399,52 @@ not created for some model-specific reason. Should robustly handle a @dest no longer found in the model! - whether a new row was created before position @dest + whether a new row was created before position @dest - a #GtkTreeDragDest + a #GtkTreeDragDest - row to drop in front of + row to drop in front of - data to drop + data to drop - Determines whether a drop is possible before the given @dest_path, + Determines whether a drop is possible before the given @dest_path, at the same depth as @dest_path. i.e., can we drop the data in @selection_data at that location. @dest_path does not have to exist; the return value will almost certainly be %FALSE if the -parent of @dest_path doesn’t exist, though. +parent of @dest_path doesn’t exist, though. - %TRUE if a drop is possible before @dest_path + %TRUE if a drop is possible before @dest_path - a #GtkTreeDragDest + a #GtkTreeDragDest - destination row + destination row - the data being dragged + the data being dragged - - Asks the #GtkTreeDragDest to insert a row before the path @dest, + + Asks the #GtkTreeDragDest to insert a row before the path @dest, deriving the contents of the row from @selection_data. If @dest is outside the tree so that inserting before it is impossible, %FALSE will be returned. Also, %FALSE may be returned if the new row is @@ -169604,73 +121452,52 @@ not created for some model-specific reason. Should robustly handle a @dest no longer found in the model! - whether a new row was created before position @dest + whether a new row was created before position @dest - a #GtkTreeDragDest + a #GtkTreeDragDest - row to drop in front of + row to drop in front of - data to drop + data to drop - - Determines whether a drop is possible before the given @dest_path, + + Determines whether a drop is possible before the given @dest_path, at the same depth as @dest_path. i.e., can we drop the data in @selection_data at that location. @dest_path does not have to exist; the return value will almost certainly be %FALSE if the -parent of @dest_path doesn’t exist, though. +parent of @dest_path doesn’t exist, though. - %TRUE if a drop is possible before @dest_path + %TRUE if a drop is possible before @dest_path - a #GtkTreeDragDest + a #GtkTreeDragDest - destination row + destination row - the data being dragged + the data being dragged - + @@ -169679,28 +121506,20 @@ parent of @dest_path doesn’t exist, though. - whether a new row was created before position @dest + whether a new row was created before position @dest - a #GtkTreeDragDest + a #GtkTreeDragDest - row to drop in front of + row to drop in front of - data to drop + data to drop @@ -169710,236 +121529,166 @@ parent of @dest_path doesn’t exist, though. - %TRUE if a drop is possible before @dest_path + %TRUE if a drop is possible before @dest_path - a #GtkTreeDragDest + a #GtkTreeDragDest - destination row + destination row - the data being dragged + the data being dragged - + - Asks the #GtkTreeDragSource to delete the row at @path, because + Asks the #GtkTreeDragSource to delete the row at @path, because it was moved somewhere else via drag-and-drop. Returns %FALSE if the deletion fails because @path no longer exists, or for some model-specific reason. Should robustly handle a @path no longer found in the model! - %TRUE if the row was successfully deleted + %TRUE if the row was successfully deleted - a #GtkTreeDragSource + a #GtkTreeDragSource - row that was being dragged + row that was being dragged - Asks the #GtkTreeDragSource to fill in @selection_data with a + Asks the #GtkTreeDragSource to fill in @selection_data with a representation of the row at @path. @selection_data->target gives the required type of the data. Should robustly handle a @path no longer found in the model! - %TRUE if data of the required type was provided + %TRUE if data of the required type was provided - a #GtkTreeDragSource + a #GtkTreeDragSource - row that was dragged + row that was dragged - a #GtkSelectionData to fill with data + a #GtkSelectionData to fill with data from the dragged row - Asks the #GtkTreeDragSource whether a particular row can be used as -the source of a DND operation. If the source doesn’t implement + Asks the #GtkTreeDragSource whether a particular row can be used as +the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable. - %TRUE if the row can be dragged + %TRUE if the row can be dragged - a #GtkTreeDragSource + a #GtkTreeDragSource - row on which user is initiating a drag + row on which user is initiating a drag - - Asks the #GtkTreeDragSource to delete the row at @path, because + + Asks the #GtkTreeDragSource to delete the row at @path, because it was moved somewhere else via drag-and-drop. Returns %FALSE if the deletion fails because @path no longer exists, or for some model-specific reason. Should robustly handle a @path no longer found in the model! - %TRUE if the row was successfully deleted + %TRUE if the row was successfully deleted - a #GtkTreeDragSource + a #GtkTreeDragSource - row that was being dragged + row that was being dragged - - Asks the #GtkTreeDragSource to fill in @selection_data with a + + Asks the #GtkTreeDragSource to fill in @selection_data with a representation of the row at @path. @selection_data->target gives the required type of the data. Should robustly handle a @path no longer found in the model! - %TRUE if data of the required type was provided + %TRUE if data of the required type was provided - a #GtkTreeDragSource + a #GtkTreeDragSource - row that was dragged + row that was dragged - a #GtkSelectionData to fill with data + a #GtkSelectionData to fill with data from the dragged row - - Asks the #GtkTreeDragSource whether a particular row can be used as -the source of a DND operation. If the source doesn’t implement + + Asks the #GtkTreeDragSource whether a particular row can be used as +the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable. - %TRUE if the row can be dragged + %TRUE if the row can be dragged - a #GtkTreeDragSource + a #GtkTreeDragSource - row on which user is initiating a drag + row on which user is initiating a drag - + @@ -169948,22 +121697,16 @@ this interface, the row is assumed draggable. - %TRUE if the row can be dragged + %TRUE if the row can be dragged - a #GtkTreeDragSource + a #GtkTreeDragSource - row on which user is initiating a drag + row on which user is initiating a drag @@ -169973,28 +121716,20 @@ this interface, the row is assumed draggable. - %TRUE if data of the required type was provided + %TRUE if data of the required type was provided - a #GtkTreeDragSource + a #GtkTreeDragSource - row that was dragged + row that was dragged - a #GtkSelectionData to fill with data + a #GtkSelectionData to fill with data from the dragged row @@ -170005,69 +121740,47 @@ this interface, the row is assumed draggable. - %TRUE if the row was successfully deleted + %TRUE if the row was successfully deleted - a #GtkTreeDragSource + a #GtkTreeDragSource - row that was being dragged + row that was being dragged - - The #GtkTreeIter is the primary structure + + The #GtkTreeIter is the primary structure for accessing a #GtkTreeModel. Models are expected to put a unique integer in the @stamp member, and put model-specific data in the three @user_data members. - a unique stamp to catch invalid iterators + a unique stamp to catch invalid iterators - model-specific data + model-specific data - model-specific data + model-specific data - model-specific data + model-specific data - Creates a dynamically allocated tree iterator as a copy of @iter. + Creates a dynamically allocated tree iterator as a copy of @iter. This function is not intended for use in applications, because you can just copy the structs by value @@ -170075,24 +121788,18 @@ because you can just copy the structs by value You must free this iter with gtk_tree_iter_free(). - a newly-allocated copy of @iter + a newly-allocated copy of @iter - a #GtkTreeIter-struct + a #GtkTreeIter-struct - Frees an iterator that has been allocated by gtk_tree_iter_copy(). + Frees an iterator that has been allocated by gtk_tree_iter_copy(). This function is mainly used for language bindings. @@ -170101,18 +121808,14 @@ This function is mainly used for language bindings. - a dynamically allocated tree iterator + a dynamically allocated tree iterator - A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive + A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b respectively. If two iters compare as equal, their order in the sorted model is undefined. In order to ensure that the #GtkTreeSortable behaves as @@ -170120,57 +121823,36 @@ expected, the GtkTreeIterCompareFunc must define a partial order on the model, i.e. it must be reflexive, antisymmetric and transitive. For example, if @model is a product catalogue, then a compare function -for the “price” column could be one which returns +for the “price” column could be one which returns `price_of(@a) - price_of(@b)`. - a negative integer, zero or a positive integer depending on whether + a negative integer, zero or a positive integer depending on whether @a sorts before, with or after @b - The #GtkTreeModel the comparison is within + The #GtkTreeModel the comparison is within - A #GtkTreeIter in @model + A #GtkTreeIter in @model - Another #GtkTreeIter in @model + Another #GtkTreeIter in @model - - Data passed when the compare func is assigned e.g. by + + Data passed when the compare func is assigned e.g. by gtk_tree_sortable_set_sort_func() - - The #GtkTreeModel interface defines a generic tree interface for + + The #GtkTreeModel interface defines a generic tree interface for use by the #GtkTreeView widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data @@ -170188,7 +121870,7 @@ model decides how and if changes are made. In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided -— the #GtkTreeStore and the #GtkListStore. To use these, the +— the #GtkTreeStore and the #GtkListStore. To use these, the developer simply pushes data into these models as necessary. These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and @@ -170199,7 +121881,7 @@ Models are accessed on a node/column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. There are two structures used to reference a particular node in a model. They are the #GtkTreePath-struct and -the #GtkTreeIter-struct (“iter” is short for iterator). Most of the +the #GtkTreeIter-struct (“iter” is short for iterator). Most of the interface consists of operations on a #GtkTreeIter-struct. A path is essentially a potential node. It is a location on a model @@ -170231,9 +121913,9 @@ catching errors resulting from using invalid iterators with a model. The lifecycle of an iterator can be a little confusing at first. Iterators are expected to always be valid for as long as the model -is unchanged (and doesn’t emit a signal). The model is considered +is unchanged (and doesn’t emit a signal). The model is considered to own all outstanding iterators and nothing needs to be done to -free them from the user’s point of view. Additionally, some models +free them from the user’s point of view. Additionally, some models guarantee that an iterator is valid for as long as the node it refers to is valid (most notably the #GtkTreeStore and #GtkListStore). Although generally uninteresting, as one always has to allow for @@ -170318,7 +122000,7 @@ while (valid) gchar *str_data; gint int_data; - // Make sure you terminate calls to gtk_tree_model_get() with a “-1” value + // Make sure you terminate calls to gtk_tree_model_get() with a “-1” value gtk_tree_model_get (list_store, &iter, STRING_COLUMN, &str_data, INT_COLUMN, &int_data, @@ -170366,143 +122048,100 @@ into account: is always referenced when any view is attached). - Returns the type of the column. + Returns the type of the column. - the type of the column + the type of the column - a #GtkTreeModel + a #GtkTreeModel - the column index + the column index - Returns a set of flags supported by this interface. + Returns a set of flags supported by this interface. The flags are a bitwise combination of #GtkTreeModelFlags. The flags supported should not change during the lifetime of the @tree_model. - the flags supported by this interface + the flags supported by this interface - a #GtkTreeModel + a #GtkTreeModel - Sets @iter to a valid iterator pointing to @path. If @path does + Sets @iter to a valid iterator pointing to @path. If @path does not exist, @iter is set to an invalid iterator and %FALSE is returned. - %TRUE, if @iter was set + %TRUE, if @iter was set - a #GtkTreeModel + a #GtkTreeModel - - the uninitialized #GtkTreeIter-struct + + the uninitialized #GtkTreeIter-struct - the #GtkTreePath-struct + the #GtkTreePath-struct - Returns the number of columns supported by @tree_model. + Returns the number of columns supported by @tree_model. - the number of columns + the number of columns - a #GtkTreeModel + a #GtkTreeModel - Returns a newly-created #GtkTreePath-struct referenced by @iter. + Returns a newly-created #GtkTreePath-struct referenced by @iter. This path should be freed with gtk_tree_path_free(). - a newly-created #GtkTreePath-struct + a newly-created #GtkTreePath-struct - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - Initializes and sets @value to that at @column. + Initializes and sets @value to that at @column. When done with @value, g_value_unset() needs to be called to free any allocated memory. @@ -170512,38 +122151,25 @@ to free any allocated memory. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - the column to lookup the value at + the column to lookup the value at - - an empty #GValue to set + + an empty #GValue to set - Sets @iter to point to the first child of @parent. + Sets @iter to point to the first child of @parent. If @parent has no children, %FALSE is returned and @iter is set to be invalid. @parent will remain a valid node after this @@ -170553,129 +122179,86 @@ If @parent is %NULL returns the first node, equivalent to `gtk_tree_model_get_iter_first (tree_model, iter);` - %TRUE, if @iter has been set to the first child + %TRUE, if @iter has been set to the first child - a #GtkTreeModel + a #GtkTreeModel - - the new #GtkTreeIter-struct to be set to the child + + the new #GtkTreeIter-struct to be set to the child - - the #GtkTreeIter-struct, or %NULL + + the #GtkTreeIter-struct, or %NULL - Returns %TRUE if @iter has children, %FALSE otherwise. + Returns %TRUE if @iter has children, %FALSE otherwise. - %TRUE if @iter has children + %TRUE if @iter has children - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct to test for children + the #GtkTreeIter-struct to test for children - Returns the number of children that @iter has. + Returns the number of children that @iter has. As a special case, if @iter is %NULL, then the number of toplevel nodes is returned. - the number of children of @iter + the number of children of @iter - a #GtkTreeModel + a #GtkTreeModel - - the #GtkTreeIter-struct, or %NULL + + the #GtkTreeIter-struct, or %NULL - Sets @iter to point to the node following it at the current level. + Sets @iter to point to the node following it at the current level. If there is no next @iter, %FALSE is returned and @iter is set to be invalid. - %TRUE if @iter has been changed to the next node + %TRUE if @iter has been changed to the next node - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - Sets @iter to be the child of @parent, using the given index. + Sets @iter to be the child of @parent, using the given index. The first index is 0. If @n is too big, or @parent has no children, @iter is set to an invalid iterator and %FALSE is returned. @parent @@ -170684,50 +122267,32 @@ special case, if @parent is %NULL, then the @n-th root node is set. - %TRUE, if @parent has an @n-th child + %TRUE, if @parent has an @n-th child - a #GtkTreeModel + a #GtkTreeModel - - the #GtkTreeIter-struct to set to the nth child + + the #GtkTreeIter-struct to set to the nth child - - the #GtkTreeIter-struct to get the child from, or %NULL. + + the #GtkTreeIter-struct to get the child from, or %NULL. - the index of the desired child + the index of the desired child - Sets @iter to be the parent of @child. + Sets @iter to be the parent of @child. -If @child is at the toplevel, and doesn’t have a parent, then +If @child is at the toplevel, and doesn’t have a parent, then @iter is set to an invalid iterator and %FALSE is returned. @child will remain a valid node after this function has been called. @@ -170736,70 +122301,47 @@ called. and @iter cannot point to the same memory location. - %TRUE, if @iter is set to the parent of @child + %TRUE, if @iter is set to the parent of @child - a #GtkTreeModel + a #GtkTreeModel - - the new #GtkTreeIter-struct to set to the parent + + the new #GtkTreeIter-struct to set to the parent - the #GtkTreeIter-struct + the #GtkTreeIter-struct - - Sets @iter to point to the previous node at the current level. + + Sets @iter to point to the previous node at the current level. If there is no previous @iter, %FALSE is returned and @iter is set to be invalid. - %TRUE if @iter has been changed to the previous node + %TRUE if @iter has been changed to the previous node - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - Lets the tree ref the node. + Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -170822,52 +122364,38 @@ of its reffed state. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - Emits the #GtkTreeModel::row-changed signal on @tree_model. + Emits the #GtkTreeModel::row-changed signal on @tree_model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the changed row + a #GtkTreePath-struct pointing to the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row - Emits the #GtkTreeModel::row-deleted signal on @tree_model. + Emits the #GtkTreeModel::row-deleted signal on @tree_model. This should be called by models after a row has been removed. The location pointed to by @path should be the location that @@ -170881,25 +122409,18 @@ outstanding references on the deleted node should not be released. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the previous location of + a #GtkTreePath-struct pointing to the previous location of the deleted row - - Emits the #GtkTreeModel::row-has-child-toggled signal on + + Emits the #GtkTreeModel::row-has-child-toggled signal on @tree_model. This should be called by models after the child state of a node changes. @@ -170908,60 +122429,42 @@ state of a node changes. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the changed row + a #GtkTreePath-struct pointing to the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row - Emits the #GtkTreeModel::row-inserted signal on @tree_model. + Emits the #GtkTreeModel::row-inserted signal on @tree_model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the inserted row + a #GtkTreePath-struct pointing to the inserted row - a valid #GtkTreeIter-struct pointing to the inserted row + a valid #GtkTreeIter-struct pointing to the inserted row - - Emits the #GtkTreeModel::rows-reordered signal on @tree_model. + + Emits the #GtkTreeModel::rows-reordered signal on @tree_model. This should be called by models when their rows have been reordered. @@ -170971,29 +122474,21 @@ reordered. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the tree node whose children + a #GtkTreePath-struct pointing to the tree node whose children have been reordered - a valid #GtkTreeIter-struct pointing to the node whose children + a valid #GtkTreeIter-struct pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position of + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -171001,9 +122496,7 @@ reordered. - Lets the tree unref the node. + Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -171017,55 +122510,36 @@ Please note that nodes that are deleted are not unreffed. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - - Creates a new #GtkTreeModel, with @child_model as the child_model + + Creates a new #GtkTreeModel, with @child_model as the child_model and @root as the virtual root. - A new #GtkTreeModel. + A new #GtkTreeModel. - A #GtkTreeModel. + A #GtkTreeModel. - - A #GtkTreePath or %NULL. + + A #GtkTreePath or %NULL. - Calls func on each node in model in a depth-first fashion. + Calls func on each node in model in a depth-first fashion. If @func returns %TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns. @@ -171075,36 +122549,21 @@ and gtk_tree_model_foreach() returns. - a #GtkTreeModel + a #GtkTreeModel - - a function to be called on each row - + + a function to be called on each row + - - user data to passed to @func + + user data to passed to @func - Gets the value of one or more cells in the row referenced by @iter. + Gets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by a place to store the value being retrieved. The list is terminated by a -1. For example, to get a @@ -171122,269 +122581,181 @@ Other values are passed by value. - a #GtkTreeModel + a #GtkTreeModel - a row in @tree_model + a row in @tree_model - pairs of column number and value return locations, + pairs of column number and value return locations, terminated by -1 - - Returns the type of the column. + + Returns the type of the column. - the type of the column + the type of the column - a #GtkTreeModel + a #GtkTreeModel - the column index + the column index - Returns a set of flags supported by this interface. + Returns a set of flags supported by this interface. The flags are a bitwise combination of #GtkTreeModelFlags. The flags supported should not change during the lifetime of the @tree_model. - the flags supported by this interface + the flags supported by this interface - a #GtkTreeModel + a #GtkTreeModel - Sets @iter to a valid iterator pointing to @path. If @path does + Sets @iter to a valid iterator pointing to @path. If @path does not exist, @iter is set to an invalid iterator and %FALSE is returned. - %TRUE, if @iter was set + %TRUE, if @iter was set - a #GtkTreeModel + a #GtkTreeModel - - the uninitialized #GtkTreeIter-struct + + the uninitialized #GtkTreeIter-struct - the #GtkTreePath-struct + the #GtkTreePath-struct - - Initializes @iter with the first iterator in the tree + + Initializes @iter with the first iterator in the tree (the one at the path "0") and returns %TRUE. Returns %FALSE if the tree is empty. - %TRUE, if @iter was set + %TRUE, if @iter was set - a #GtkTreeModel + a #GtkTreeModel - - the uninitialized #GtkTreeIter-struct + + the uninitialized #GtkTreeIter-struct - - Sets @iter to a valid iterator pointing to @path_string, if it + + Sets @iter to a valid iterator pointing to @path_string, if it exists. Otherwise, @iter is left invalid and %FALSE is returned. - %TRUE, if @iter was set + %TRUE, if @iter was set - a #GtkTreeModel + a #GtkTreeModel - - an uninitialized #GtkTreeIter-struct + + an uninitialized #GtkTreeIter-struct - a string representation of a #GtkTreePath-struct + a string representation of a #GtkTreePath-struct - Returns the number of columns supported by @tree_model. + Returns the number of columns supported by @tree_model. - the number of columns + the number of columns - a #GtkTreeModel + a #GtkTreeModel - Returns a newly-created #GtkTreePath-struct referenced by @iter. + Returns a newly-created #GtkTreePath-struct referenced by @iter. This path should be freed with gtk_tree_path_free(). - a newly-created #GtkTreePath-struct + a newly-created #GtkTreePath-struct - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - - Generates a string representation of the iter. + + Generates a string representation of the iter. -This string is a “:” separated list of numbers. -For example, “4:10:0:3” would be an acceptable +This string is a “:” separated list of numbers. +For example, “4:10:0:3” would be an acceptable return value for this string. - a newly-allocated string. + a newly-allocated string. Must be freed with g_free(). - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreeIter-struct + a #GtkTreeIter-struct - - See gtk_tree_model_get(), this version takes a va_list + + See gtk_tree_model_get(), this version takes a va_list for language bindings to use. @@ -171392,29 +122763,21 @@ for language bindings to use. - a #GtkTreeModel + a #GtkTreeModel - a row in @tree_model + a row in @tree_model - va_list of column/return location pairs + va_list of column/return location pairs - Initializes and sets @value to that at @column. + Initializes and sets @value to that at @column. When done with @value, g_value_unset() needs to be called to free any allocated memory. @@ -171424,38 +122787,25 @@ to free any allocated memory. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - the column to lookup the value at + the column to lookup the value at - - an empty #GValue to set + + an empty #GValue to set - Sets @iter to point to the first child of @parent. + Sets @iter to point to the first child of @parent. If @parent has no children, %FALSE is returned and @iter is set to be invalid. @parent will remain a valid node after this @@ -171465,132 +122815,86 @@ If @parent is %NULL returns the first node, equivalent to `gtk_tree_model_get_iter_first (tree_model, iter);` - %TRUE, if @iter has been set to the first child + %TRUE, if @iter has been set to the first child - a #GtkTreeModel + a #GtkTreeModel - - the new #GtkTreeIter-struct to be set to the child + + the new #GtkTreeIter-struct to be set to the child - - the #GtkTreeIter-struct, or %NULL + + the #GtkTreeIter-struct, or %NULL - - Returns %TRUE if @iter has children, %FALSE otherwise. + + Returns %TRUE if @iter has children, %FALSE otherwise. - %TRUE if @iter has children + %TRUE if @iter has children - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct to test for children + the #GtkTreeIter-struct to test for children - - Returns the number of children that @iter has. + + Returns the number of children that @iter has. As a special case, if @iter is %NULL, then the number of toplevel nodes is returned. - the number of children of @iter + the number of children of @iter - a #GtkTreeModel + a #GtkTreeModel - - the #GtkTreeIter-struct, or %NULL + + the #GtkTreeIter-struct, or %NULL - Sets @iter to point to the node following it at the current level. + Sets @iter to point to the node following it at the current level. If there is no next @iter, %FALSE is returned and @iter is set to be invalid. - %TRUE if @iter has been changed to the next node + %TRUE if @iter has been changed to the next node - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - - Sets @iter to be the child of @parent, using the given index. + + Sets @iter to be the child of @parent, using the given index. The first index is 0. If @n is too big, or @parent has no children, @iter is set to an invalid iterator and %FALSE is returned. @parent @@ -171599,50 +122903,32 @@ special case, if @parent is %NULL, then the @n-th root node is set. - %TRUE, if @parent has an @n-th child + %TRUE, if @parent has an @n-th child - a #GtkTreeModel + a #GtkTreeModel - - the #GtkTreeIter-struct to set to the nth child + + the #GtkTreeIter-struct to set to the nth child - - the #GtkTreeIter-struct to get the child from, or %NULL. + + the #GtkTreeIter-struct to get the child from, or %NULL. - the index of the desired child + the index of the desired child - Sets @iter to be the parent of @child. + Sets @iter to be the parent of @child. -If @child is at the toplevel, and doesn’t have a parent, then +If @child is at the toplevel, and doesn’t have a parent, then @iter is set to an invalid iterator and %FALSE is returned. @child will remain a valid node after this function has been called. @@ -171651,70 +122937,47 @@ called. and @iter cannot point to the same memory location. - %TRUE, if @iter is set to the parent of @child + %TRUE, if @iter is set to the parent of @child - a #GtkTreeModel + a #GtkTreeModel - - the new #GtkTreeIter-struct to set to the parent + + the new #GtkTreeIter-struct to set to the parent - the #GtkTreeIter-struct + the #GtkTreeIter-struct - - Sets @iter to point to the previous node at the current level. + + Sets @iter to point to the previous node at the current level. If there is no previous @iter, %FALSE is returned and @iter is set to be invalid. - %TRUE if @iter has been changed to the previous node + %TRUE if @iter has been changed to the previous node - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - Lets the tree ref the node. + Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -171737,52 +123000,38 @@ of its reffed state. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - Emits the #GtkTreeModel::row-changed signal on @tree_model. + Emits the #GtkTreeModel::row-changed signal on @tree_model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the changed row + a #GtkTreePath-struct pointing to the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row - Emits the #GtkTreeModel::row-deleted signal on @tree_model. + Emits the #GtkTreeModel::row-deleted signal on @tree_model. This should be called by models after a row has been removed. The location pointed to by @path should be the location that @@ -171796,25 +123045,18 @@ outstanding references on the deleted node should not be released. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the previous location of + a #GtkTreePath-struct pointing to the previous location of the deleted row - - Emits the #GtkTreeModel::row-has-child-toggled signal on + + Emits the #GtkTreeModel::row-has-child-toggled signal on @tree_model. This should be called by models after the child state of a node changes. @@ -171823,61 +123065,42 @@ state of a node changes. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the changed row + a #GtkTreePath-struct pointing to the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row - Emits the #GtkTreeModel::row-inserted signal on @tree_model. + Emits the #GtkTreeModel::row-inserted signal on @tree_model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the inserted row + a #GtkTreePath-struct pointing to the inserted row - a valid #GtkTreeIter-struct pointing to the inserted row + a valid #GtkTreeIter-struct pointing to the inserted row - - Emits the #GtkTreeModel::rows-reordered signal on @tree_model. + + Emits the #GtkTreeModel::rows-reordered signal on @tree_model. This should be called by models when their rows have been reordered. @@ -171887,42 +123110,29 @@ reordered. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the tree node whose children + a #GtkTreePath-struct pointing to the tree node whose children have been reordered - a valid #GtkTreeIter-struct pointing to the node whose children + a valid #GtkTreeIter-struct pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position of + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` - - Emits the #GtkTreeModel::rows-reordered signal on @tree_model. + + Emits the #GtkTreeModel::rows-reordered signal on @tree_model. This should be called by models when their rows have been reordered. @@ -171932,33 +123142,22 @@ reordered. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the tree node whose children + a #GtkTreePath-struct pointing to the tree node whose children have been reordered - - a valid #GtkTreeIter-struct pointing to the node + + a valid #GtkTreeIter-struct pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -171967,17 +123166,13 @@ reordered. - length of @new_order array + length of @new_order array - Lets the tree unref the node. + Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -171991,45 +123186,33 @@ Please note that nodes that are deleted are not unreffed. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - This signal is emitted when a row in the model has changed. + This signal is emitted when a row in the model has changed. - a #GtkTreePath-struct identifying the changed row + a #GtkTreePath-struct identifying the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row - This signal is emitted when a row has been deleted. + This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already deleted. @@ -172042,40 +123225,30 @@ the row previously was at. It may not be a valid location anymore. - a #GtkTreePath-struct identifying the row + a #GtkTreePath-struct identifying the row - This signal is emitted when a row has gotten the first child + This signal is emitted when a row has gotten the first child row or lost its last child row. - a #GtkTreePath-struct identifying the row + a #GtkTreePath-struct identifying the row - a valid #GtkTreeIter-struct pointing to the row + a valid #GtkTreeIter-struct pointing to the row - This signal is emitted when a new row has been inserted in + This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since @@ -172086,23 +123259,17 @@ then fill it with the desired values. - a #GtkTreePath-struct identifying the new row + a #GtkTreePath-struct identifying the new row - a valid #GtkTreeIter-struct pointing to the new row + a valid #GtkTreeIter-struct pointing to the new row - This signal is emitted when the children of a node in the + This signal is emitted when the children of a node in the #GtkTreeModel have been reordered. Note that this signal is not emitted @@ -172113,26 +123280,17 @@ by removing and then reinserting the row. - a #GtkTreePath-struct identifying the tree node whose children + a #GtkTreePath-struct identifying the tree node whose children have been reordered - a valid #GtkTreeIter-struct pointing to the node whose children + a valid #GtkTreeIter-struct pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - - an array of integers mapping the current position + + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -172140,30 +123298,22 @@ by removing and then reinserting the row. - - A #GtkTreeModelFilter is a tree model which wraps another tree model, + + A #GtkTreeModelFilter is a tree model which wraps another tree model, and can do the following things: -- Filter specific rows, based on data from a “visible column”, a column +- Filter specific rows, based on data from a “visible column”, a column storing booleans indicating whether the row should be filtered or not, - or based on the return value of a “visible function”, which gets a + or based on the return value of a “visible function”, which gets a model, iter and user_data and returns a boolean indicating whether the row should be filtered or not. -- Modify the “appearance” of the model, using a modify function. +- Modify the “appearance” of the model, using a modify function. This is extremely powerful and allows for just changing some values and also for creating a completely different model based on the given child model. -- Set a different root node, also known as a “virtual root”. You can pass +- Set a different root node, also known as a “virtual root”. You can pass in a #GtkTreePath indicating the root node for the filter at construction time. @@ -172194,8 +123344,8 @@ Determining the visibility state of a given node based on the state of its child nodes is a frequently occurring use case. Therefore, #GtkTreeModelFilter explicitly supports this. For example, when a node does not have any children, you might not want the node to be visible. -As soon as the first row is added to the node’s child level (or the -last row removed), the node’s visibility should be updated. +As soon as the first row is added to the node’s child level (or the +last row removed), the node’s visibility should be updated. This introduces a dependency from the node on its child nodes. In order to accommodate this, #GtkTreeModelFilter must make sure the necessary @@ -172209,7 +123359,7 @@ of any parent node has changed. Beware, however, that this explicit support is limited to these two cases. For example, if you want a node to be visible only if two nodes -in a child’s child level (2 levels deeper) are visible, you are on your +in a child’s child level (2 levels deeper) are visible, you are on your own. In this case, either rely on #GtkTreeStore to emit all signals because it does not implement reference counting, or for models that do implement reference counting, obtain references on these child levels @@ -172257,15 +123407,11 @@ yourself. - - This function should almost never be called. It clears the @filter -of any cached iterators that haven’t been reffed with + + This function should almost never be called. It clears the @filter +of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model -being filtered is static (and doesn’t change often) and there has been +being filtered is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid. @@ -172274,178 +123420,116 @@ all unreffed iters will be invalid. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - - Sets @filter_iter to point to the row in @filter that corresponds to the + + Sets @filter_iter to point to the row in @filter that corresponds to the row pointed at by @child_iter. If @filter_iter was not set, %FALSE is returned. - %TRUE, if @filter_iter was set, i.e. if @child_iter is a + %TRUE, if @filter_iter was set, i.e. if @child_iter is a valid iterator pointing to a visible row in child model. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - - An uninitialized #GtkTreeIter. + + An uninitialized #GtkTreeIter. - A valid #GtkTreeIter pointing to a row on the child model. + A valid #GtkTreeIter pointing to a row on the child model. - - Converts @child_path to a path relative to @filter. That is, @child_path + + Converts @child_path to a path relative to @filter. That is, @child_path points to a path in the child model. The rerturned path will point to the -same row in the filtered model. If @child_path isn’t a valid path on the +same row in the filtered model. If @child_path isn’t a valid path on the child model or points to a row which is not visible in @filter, then %NULL is returned. - A newly allocated #GtkTreePath, or %NULL. + A newly allocated #GtkTreePath, or %NULL. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - A #GtkTreePath to convert. + A #GtkTreePath to convert. - - Sets @child_iter to point to the row pointed to by @filter_iter. + + Sets @child_iter to point to the row pointed to by @filter_iter. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - - An uninitialized #GtkTreeIter. + + An uninitialized #GtkTreeIter. - A valid #GtkTreeIter pointing to a row on @filter. + A valid #GtkTreeIter pointing to a row on @filter. - - Converts @filter_path to a path on the child model of @filter. That is, + + Converts @filter_path to a path on the child model of @filter. That is, @filter_path points to a location in @filter. The returned path will point to the same location in the model not being filtered. If @filter_path does not point to a location in the child model, %NULL is returned. - A newly allocated #GtkTreePath, or %NULL. + A newly allocated #GtkTreePath, or %NULL. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - A #GtkTreePath to convert. + A #GtkTreePath to convert. - - Returns a pointer to the child model of @filter. + + Returns a pointer to the child model of @filter. - A pointer to a #GtkTreeModel. + A pointer to a #GtkTreeModel. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - - Emits ::row_changed for each row in the child model, which causes + + Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not. @@ -172453,19 +123537,13 @@ the filter to re-evaluate whether a row is visible or not. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - - With the @n_columns and @types parameters, you give an array of column + + With the @n_columns and @types parameters, you give an array of column types for this model (which will be exposed to the parent model/view). The @func, @data and @destroy parameters are for specifying the modify function. The modify function will get called for each @@ -172481,63 +123559,35 @@ can only be called once for a given filter model. - A #GtkTreeModelFilter. + A #GtkTreeModelFilter. - The number of columns in the filter model. + The number of columns in the filter model. - The #GTypes of the columns. + The #GTypes of the columns. - - A #GtkTreeModelFilterModifyFunc - + + A #GtkTreeModelFilterModifyFunc + - - User data to pass to the modify function, or %NULL. + + User data to pass to the modify function, or %NULL. - - Destroy notifier of @data, or %NULL. + + Destroy notifier of @data, or %NULL. - - Sets @column of the child_model to be the column where @filter should + + Sets @column of the child_model to be the column where @filter should look for visibility information. @columns should be a column of type %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE if not. @@ -172551,25 +123601,17 @@ once for a given filter model. - A #GtkTreeModelFilter + A #GtkTreeModelFilter - A #gint which is the column containing the visible information + A #gint which is the column containing the visible information - - Sets the visible function used when filtering the @filter to be @func. + + Sets the visible function used when filtering the @filter to be @func. The function should return %TRUE if the given row should be visible and %FALSE otherwise. @@ -172588,7 +123630,7 @@ visible_func (GtkTreeModel *model, GtkTreeIter *iter, gpointer data) { - // Visible if row is non-empty and first column is “HI” + // Visible if row is non-empty and first column is “HI” gchar *str; gboolean visible = FALSE; @@ -172610,66 +123652,37 @@ once for a given filter model. - A #GtkTreeModelFilter + A #GtkTreeModelFilter - - A #GtkTreeModelFilterVisibleFunc, the visible function - + + A #GtkTreeModelFilterVisibleFunc, the visible function + - - User data to pass to the visible function, or %NULL + + User data to pass to the visible function, or %NULL - - Destroy notifier of @data, or %NULL + + Destroy notifier of @data, or %NULL - + - + - + - + @@ -172751,15 +123764,12 @@ once for a given filter model. - - A function which calculates display values from raw values in the model. + + A function which calculates display values from raw values in the model. It must fill @value with the display value for the column @column in the row indicated by @iter. -Since this function is called for each data access, it’s not a +Since this function is called for each data access, it’s not a particularly efficient operation. @@ -172767,165 +123777,98 @@ particularly efficient operation. - the #GtkTreeModelFilter + the #GtkTreeModelFilter - a #GtkTreeIter pointing to the row whose display values are determined + a #GtkTreeIter pointing to the row whose display values are determined - - A #GValue which is already initialized for + + A #GValue which is already initialized for with the correct type for the column @column. - the column whose display value is determined + the column whose display value is determined - - user data given to gtk_tree_model_filter_set_modify_func() + + user data given to gtk_tree_model_filter_set_modify_func() - + - - A function which decides whether the row indicated by @iter is visible. + + A function which decides whether the row indicated by @iter is visible. - Whether the row indicated by @iter is visible. + Whether the row indicated by @iter is visible. - the child model of the #GtkTreeModelFilter + the child model of the #GtkTreeModelFilter - a #GtkTreeIter pointing to the row in @model whose visibility + a #GtkTreeIter pointing to the row in @model whose visibility is determined - - user data given to gtk_tree_model_filter_set_visible_func() + + user data given to gtk_tree_model_filter_set_visible_func() - - These flags indicate various properties of a #GtkTreeModel. + + These flags indicate various properties of a #GtkTreeModel. They are returned by gtk_tree_model_get_flags(), and must be static for the lifetime of the object. A more complete description of #GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of this section. - - iterators survive all signals + + iterators survive all signals emitted by the tree - - the model is a list only, and never + + the model is a list only, and never has children - Type of the callback passed to gtk_tree_model_foreach() to + Type of the callback passed to gtk_tree_model_foreach() to iterate over the rows in a tree model. - %TRUE to stop iterating, %FALSE to continue + %TRUE to stop iterating, %FALSE to continue - the #GtkTreeModel being iterated + the #GtkTreeModel being iterated - the current #GtkTreePath + the current #GtkTreePath - the current #GtkTreeIter + the current #GtkTreeIter - - The user data passed to gtk_tree_model_foreach() + + The user data passed to gtk_tree_model_foreach() - + @@ -172938,21 +123881,15 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the changed row + a #GtkTreePath-struct pointing to the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row @@ -172966,21 +123903,15 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the inserted row + a #GtkTreePath-struct pointing to the inserted row - a valid #GtkTreeIter-struct pointing to the inserted row + a valid #GtkTreeIter-struct pointing to the inserted row @@ -172994,21 +123925,15 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the changed row + a #GtkTreePath-struct pointing to the changed row - a valid #GtkTreeIter-struct pointing to the changed row + a valid #GtkTreeIter-struct pointing to the changed row @@ -173022,15 +123947,11 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the previous location of + a #GtkTreePath-struct pointing to the previous location of the deleted row @@ -173045,29 +123966,21 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - a #GtkTreePath-struct pointing to the tree node whose children + a #GtkTreePath-struct pointing to the tree node whose children have been reordered - a valid #GtkTreeIter-struct pointing to the node whose children + a valid #GtkTreeIter-struct pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position of + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -173079,16 +123992,12 @@ iterate over the rows in a tree model. - the flags supported by this interface + the flags supported by this interface - a #GtkTreeModel + a #GtkTreeModel @@ -173098,16 +124007,12 @@ iterate over the rows in a tree model. - the number of columns + the number of columns - a #GtkTreeModel + a #GtkTreeModel @@ -173117,22 +124022,16 @@ iterate over the rows in a tree model. - the type of the column + the type of the column - a #GtkTreeModel + a #GtkTreeModel - the column index + the column index @@ -173142,31 +124041,20 @@ iterate over the rows in a tree model. - %TRUE, if @iter was set + %TRUE, if @iter was set - a #GtkTreeModel + a #GtkTreeModel - - the uninitialized #GtkTreeIter-struct + + the uninitialized #GtkTreeIter-struct - the #GtkTreePath-struct + the #GtkTreePath-struct @@ -173176,22 +124064,16 @@ iterate over the rows in a tree model. - a newly-created #GtkTreePath-struct + a newly-created #GtkTreePath-struct - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct @@ -173205,30 +124087,19 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - the column to lookup the value at + the column to lookup the value at - - an empty #GValue to set + + an empty #GValue to set @@ -173238,22 +124109,16 @@ iterate over the rows in a tree model. - %TRUE if @iter has been changed to the next node + %TRUE if @iter has been changed to the next node - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct @@ -173263,22 +124128,16 @@ iterate over the rows in a tree model. - %TRUE if @iter has been changed to the previous node + %TRUE if @iter has been changed to the previous node - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct @@ -173288,34 +124147,20 @@ iterate over the rows in a tree model. - %TRUE, if @iter has been set to the first child + %TRUE, if @iter has been set to the first child - a #GtkTreeModel + a #GtkTreeModel - - the new #GtkTreeIter-struct to be set to the child + + the new #GtkTreeIter-struct to be set to the child - - the #GtkTreeIter-struct, or %NULL + + the #GtkTreeIter-struct, or %NULL @@ -173325,22 +124170,16 @@ iterate over the rows in a tree model. - %TRUE if @iter has children + %TRUE if @iter has children - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct to test for children + the #GtkTreeIter-struct to test for children @@ -173350,25 +124189,16 @@ iterate over the rows in a tree model. - the number of children of @iter + the number of children of @iter - a #GtkTreeModel + a #GtkTreeModel - - the #GtkTreeIter-struct, or %NULL + + the #GtkTreeIter-struct, or %NULL @@ -173378,40 +124208,24 @@ iterate over the rows in a tree model. - %TRUE, if @parent has an @n-th child + %TRUE, if @parent has an @n-th child - a #GtkTreeModel + a #GtkTreeModel - - the #GtkTreeIter-struct to set to the nth child + + the #GtkTreeIter-struct to set to the nth child - - the #GtkTreeIter-struct to get the child from, or %NULL. + + the #GtkTreeIter-struct to get the child from, or %NULL. - the index of the desired child + the index of the desired child @@ -173421,31 +124235,20 @@ iterate over the rows in a tree model. - %TRUE, if @iter is set to the parent of @child + %TRUE, if @iter is set to the parent of @child - a #GtkTreeModel + a #GtkTreeModel - - the new #GtkTreeIter-struct to set to the parent + + the new #GtkTreeIter-struct to set to the parent - the #GtkTreeIter-struct + the #GtkTreeIter-struct @@ -173459,15 +124262,11 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct @@ -173481,31 +124280,19 @@ iterate over the rows in a tree model. - a #GtkTreeModel + a #GtkTreeModel - the #GtkTreeIter-struct + the #GtkTreeIter-struct - - The #GtkTreeModelSort is a model which implements the #GtkTreeSortable + + The #GtkTreeModelSort is a model which implements the #GtkTreeSortable interface. It does not hold any data itself, but rather is created with a child model and proxies its data. It has identical column types to this child model, and the changes in the child are propagated. The @@ -173603,35 +124390,25 @@ selection_changed (GtkTreeSelection *selection, gpointer data) - - Creates a new #GtkTreeModelSort, with @child_model as the child model. + + Creates a new #GtkTreeModelSort, with @child_model as the child model. - A new #GtkTreeModelSort. + A new #GtkTreeModelSort. - A #GtkTreeModel + A #GtkTreeModel - - This function should almost never be called. It clears the @tree_model_sort -of any cached iterators that haven’t been reffed with + + This function should almost never be called. It clears the @tree_model_sort +of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being -sorted is static (and doesn’t change often) and there has been a lot of +sorted is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid. @@ -173640,222 +124417,152 @@ iters will be invalid. - A #GtkTreeModelSort + A #GtkTreeModelSort - - Sets @sort_iter to point to the row in @tree_model_sort that corresponds to + + Sets @sort_iter to point to the row in @tree_model_sort that corresponds to the row pointed at by @child_iter. If @sort_iter was not set, %FALSE is returned. Note: a boolean is only returned since 2.14. - %TRUE, if @sort_iter was set, i.e. if @sort_iter is a + %TRUE, if @sort_iter was set, i.e. if @sort_iter is a valid iterator pointer to a visible row in the child model. - A #GtkTreeModelSort + A #GtkTreeModelSort - - An uninitialized #GtkTreeIter. + + An uninitialized #GtkTreeIter. - A valid #GtkTreeIter pointing to a row on the child model + A valid #GtkTreeIter pointing to a row on the child model - - Converts @child_path to a path relative to @tree_model_sort. That is, + + Converts @child_path to a path relative to @tree_model_sort. That is, @child_path points to a path in the child model. The returned path will -point to the same row in the sorted model. If @child_path isn’t a valid +point to the same row in the sorted model. If @child_path isn’t a valid path on the child model, then %NULL is returned. - A newly allocated #GtkTreePath, or %NULL + A newly allocated #GtkTreePath, or %NULL - A #GtkTreeModelSort + A #GtkTreeModelSort - A #GtkTreePath to convert + A #GtkTreePath to convert - - Sets @child_iter to point to the row pointed to by @sorted_iter. + + Sets @child_iter to point to the row pointed to by @sorted_iter. - A #GtkTreeModelSort + A #GtkTreeModelSort - - An uninitialized #GtkTreeIter + + An uninitialized #GtkTreeIter - A valid #GtkTreeIter pointing to a row on @tree_model_sort. + A valid #GtkTreeIter pointing to a row on @tree_model_sort. - - Converts @sorted_path to a path on the child model of @tree_model_sort. + + Converts @sorted_path to a path on the child model of @tree_model_sort. That is, @sorted_path points to a location in @tree_model_sort. The returned path will point to the same location in the model not being sorted. If @sorted_path does not point to a location in the child model, %NULL is returned. - A newly allocated #GtkTreePath, or %NULL + A newly allocated #GtkTreePath, or %NULL - A #GtkTreeModelSort + A #GtkTreeModelSort - A #GtkTreePath to convert + A #GtkTreePath to convert - Returns the model the #GtkTreeModelSort is sorting. + Returns the model the #GtkTreeModelSort is sorting. - the "child model" being sorted + the "child model" being sorted - a #GtkTreeModelSort + a #GtkTreeModelSort - - > This function is slow. Only use it for debugging and/or testing + + > This function is slow. Only use it for debugging and/or testing > purposes. Checks if the given iter is a valid iter for this #GtkTreeModelSort. - %TRUE if the iter is valid, %FALSE if the iter is invalid. + %TRUE if the iter is valid, %FALSE if the iter is invalid. - A #GtkTreeModelSort. + A #GtkTreeModelSort. - A #GtkTreeIter. + A #GtkTreeIter. - - This resets the default sort function to be in the “unsorted” state. That + + This resets the default sort function to be in the “unsorted” state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if the #GtkTreeModelSort -is in “unsorted” state. +is in “unsorted” state. - A #GtkTreeModelSort + A #GtkTreeModelSort - + @@ -173865,9 +124572,7 @@ is in “unsorted” state. - + @@ -173905,136 +124610,90 @@ is in “unsorted” state. - + - + - Creates a new #GtkTreePath-struct. + Creates a new #GtkTreePath-struct. This refers to a row. - A newly created #GtkTreePath-struct. + A newly created #GtkTreePath-struct. - Creates a new #GtkTreePath-struct. + Creates a new #GtkTreePath-struct. -The string representation of this path is “0”. +The string representation of this path is “0”. - A new #GtkTreePath-struct + A new #GtkTreePath-struct - - Creates a new path with @first_index and @varargs as indices. + + Creates a new path with @first_index and @varargs as indices. - A newly created #GtkTreePath-struct + A newly created #GtkTreePath-struct - first integer + first integer - list of integers terminated by -1 + list of integers terminated by -1 - - Creates a new path with the given @indices array of @length. + + Creates a new path with the given @indices array of @length. - A newly created #GtkTreePath-struct + A newly created #GtkTreePath-struct - array of indices + array of indices - length of @indices array + length of @indices array - - Creates a new #GtkTreePath-struct initialized to @path. + + Creates a new #GtkTreePath-struct initialized to @path. @path is expected to be a colon separated list of numbers. -For example, the string “10:4:0” would create a path of depth +For example, the string “10:4:0” would create a path of depth 3 pointing to the 11th child of the root node, the 5th child of that 11th child, and the 1st child of that 5th child. If an invalid path string is passed in, %NULL is returned. - A newly-created #GtkTreePath-struct, or %NULL + A newly-created #GtkTreePath-struct, or %NULL - The string representation of a path + The string representation of a path - Appends a new index to a path. + Appends a new index to a path. As a result, the depth of the path is increased. @@ -174043,133 +124702,93 @@ As a result, the depth of the path is increased. - a #GtkTreePath-struct + a #GtkTreePath-struct - the index + the index - Compares two paths. + Compares two paths. If @a appears before @b in a tree, then -1 is returned. If @b appears before @a, then 1 is returned. If the two nodes are equal, then 0 is returned. - the relative positions of @a and @b + the relative positions of @a and @b - a #GtkTreePath-struct + a #GtkTreePath-struct - a #GtkTreePath-struct to compare with + a #GtkTreePath-struct to compare with - Creates a new #GtkTreePath-struct as a copy of @path. + Creates a new #GtkTreePath-struct as a copy of @path. - a new #GtkTreePath-struct + a new #GtkTreePath-struct - a #GtkTreePath-struct + a #GtkTreePath-struct - Moves @path to point to the first child of the current path. + Moves @path to point to the first child of the current path. - a #GtkTreePath-struct + a #GtkTreePath-struct - Frees @path. If @path is %NULL, it simply returns. + Frees @path. If @path is %NULL, it simply returns. - - a #GtkTreePath-struct + + a #GtkTreePath-struct - Returns the current depth of @path. + Returns the current depth of @path. - The depth of @path + The depth of @path - a #GtkTreePath-struct + a #GtkTreePath-struct - - Returns the current indices of @path. + + Returns the current indices of @path. This is an array of integers, each representing a node in a tree. This value should not be freed. @@ -174177,36 +124796,25 @@ This value should not be freed. The length of the array can be obtained with gtk_tree_path_get_depth(). - The current indices, or %NULL + The current indices, or %NULL - a #GtkTreePath-struct + a #GtkTreePath-struct - - Returns the current indices of @path. + + Returns the current indices of @path. This is an array of integers, each representing a node in a tree. It also returns the number of elements in the array. The array should not be freed. - The current + The current indices, or %NULL @@ -174214,98 +124822,67 @@ The array should not be freed. - a #GtkTreePath-struct + a #GtkTreePath-struct - - return location for number of elements + + return location for number of elements returned in the integer array, or %NULL - Returns %TRUE if @descendant is a descendant of @path. + Returns %TRUE if @descendant is a descendant of @path. - %TRUE if @descendant is contained inside @path + %TRUE if @descendant is contained inside @path - a #GtkTreePath-struct + a #GtkTreePath-struct - another #GtkTreePath-struct + another #GtkTreePath-struct - Returns %TRUE if @path is a descendant of @ancestor. + Returns %TRUE if @path is a descendant of @ancestor. - %TRUE if @ancestor contains @path somewhere below it + %TRUE if @ancestor contains @path somewhere below it - a #GtkTreePath-struct + a #GtkTreePath-struct - another #GtkTreePath-struct + another #GtkTreePath-struct - Moves the @path to point to the next node at the current depth. + Moves the @path to point to the next node at the current depth. - a #GtkTreePath-struct + a #GtkTreePath-struct - Prepends a new index to a path. + Prepends a new index to a path. As a result, the depth of the path is increased. @@ -174314,139 +124891,100 @@ As a result, the depth of the path is increased. - a #GtkTreePath-struct + a #GtkTreePath-struct - the index + the index - Moves the @path to point to the previous node at the + Moves the @path to point to the previous node at the current depth, if it exists. - %TRUE if @path has a previous node, and + %TRUE if @path has a previous node, and the move was made - a #GtkTreePath-struct + a #GtkTreePath-struct - Generates a string representation of the path. + Generates a string representation of the path. -This string is a “:” separated list of numbers. -For example, “4:10:0:3” would be an acceptable +This string is a “:” separated list of numbers. +For example, “4:10:0:3” would be an acceptable return value for this string. - A newly-allocated string. + A newly-allocated string. Must be freed with g_free(). - A #GtkTreePath-struct + A #GtkTreePath-struct - Moves the @path to point to its parent node, if it has a parent. + Moves the @path to point to its parent node, if it has a parent. - %TRUE if @path has a parent, and the move was made + %TRUE if @path has a parent, and the move was made - a #GtkTreePath-struct + a #GtkTreePath-struct - - A GtkTreeRowReference tracks model changes so that it always refers to the + + A GtkTreeRowReference tracks model changes so that it always refers to the same row (a #GtkTreePath refers to a position, not a fixed row). Create a new GtkTreeRowReference with gtk_tree_row_reference_new(). - Creates a row reference based on @path. + Creates a row reference based on @path. This reference will keep pointing to the node pointed to by @path, so long as it exists. Any changes that occur on @model are propagated, and the path is updated appropriately. If -@path isn’t a valid path in @model, then %NULL is returned. +@path isn’t a valid path in @model, then %NULL is returned. - a newly allocated #GtkTreeRowReference, or %NULL + a newly allocated #GtkTreeRowReference, or %NULL - a #GtkTreeModel + a #GtkTreeModel - a valid #GtkTreePath-struct to monitor + a valid #GtkTreePath-struct to monitor - - You do not need to use this function. + + You do not need to use this function. Creates a row reference based on @path. This reference will keep pointing to the node pointed to -by @path, so long as it exists. If @path isn’t a valid +by @path, so long as it exists. If @path isn’t a valid path in @model, then %NULL is returned. However, unlike references created with gtk_tree_row_reference_new(), it does not listen to the model for changes. The creator of @@ -174460,152 +124998,104 @@ updates all row references for that proxy. Since built-in GTK+ objects like #GtkTreeView already use this mechanism internally, using them as the proxy object will produce unpredictable results. Further more, passing the same object as @model and @proxy -doesn’t work for reasons of internal implementation. +doesn’t work for reasons of internal implementation. This type of row reference is primarily meant by structures that need to carefully monitor exactly when a row reference updates itself, and is not generally needed by most applications. - a newly allocated #GtkTreeRowReference, or %NULL + a newly allocated #GtkTreeRowReference, or %NULL - a proxy #GObject + a proxy #GObject - a #GtkTreeModel + a #GtkTreeModel - a valid #GtkTreePath-struct to monitor + a valid #GtkTreePath-struct to monitor - - Copies a #GtkTreeRowReference. + + Copies a #GtkTreeRowReference. - a copy of @reference + a copy of @reference - a #GtkTreeRowReference + a #GtkTreeRowReference - Free’s @reference. @reference may be %NULL + Free’s @reference. @reference may be %NULL - - a #GtkTreeRowReference, or %NULL + + a #GtkTreeRowReference, or %NULL - - Returns the model that the row reference is monitoring. + + Returns the model that the row reference is monitoring. - the model + the model - a #GtkTreeRowReference + a #GtkTreeRowReference - Returns a path that the row reference currently points to, + Returns a path that the row reference currently points to, or %NULL if the path pointed to is no longer valid. - a current path, or %NULL + a current path, or %NULL - a #GtkTreeRowReference + a #GtkTreeRowReference - Returns %TRUE if the @reference is non-%NULL and refers to + Returns %TRUE if the @reference is non-%NULL and refers to a current valid path. - %TRUE if @reference points to a valid path + %TRUE if @reference points to a valid path - - a #GtkTreeRowReference, or %NULL + + a #GtkTreeRowReference, or %NULL - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::row-deleted signal. @@ -174614,23 +125104,17 @@ model emitted the #GtkTreeModel::row-deleted signal. - a #GObject + a #GObject - the path position that was deleted + the path position that was deleted - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::row-inserted signal. @@ -174639,25 +125123,17 @@ model emitted the #GtkTreeModel::row-inserted signal. - a #GObject + a #GObject - the row position that was inserted + the row position that was inserted - - Lets a set of row reference created by + + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::rows-reordered signal. @@ -174666,27 +125142,19 @@ model emitted the #GtkTreeModel::rows-reordered signal. - a #GObject + a #GObject - the parent path of the reordered signal + the parent path of the reordered signal - the iter pointing to the parent of the reordered + the iter pointing to the parent of the reordered - the new order of rows + the new order of rows @@ -174694,16 +125162,8 @@ model emitted the #GtkTreeModel::rows-reordered signal. - - The #GtkTreeSelection object is a helper object to manage the selection + + The #GtkTreeSelection object is a helper object to manage the selection for a #GtkTreeView widget. The #GtkTreeSelection object is automatically created when a new #GtkTreeView widget is created, and cannot exist independently of this widget. The primary reason the @@ -174738,125 +125198,77 @@ select_row on an already selected row). - - Returns the number of rows that have been selected in @tree. + + Returns the number of rows that have been selected in @tree. - The number of rows selected. + The number of rows selected. - A #GtkTreeSelection. + A #GtkTreeSelection. - Gets the selection mode for @selection. See + Gets the selection mode for @selection. See gtk_tree_selection_set_mode(). - the current selection mode + the current selection mode - a #GtkTreeSelection + a #GtkTreeSelection - - Returns the current selection function. + + Returns the current selection function. - The function. + The function. - A #GtkTreeSelection. + A #GtkTreeSelection. - - Sets @iter to the currently selected node if @selection is set to + + Sets @iter to the currently selected node if @selection is set to #GTK_SELECTION_SINGLE or #GTK_SELECTION_BROWSE. @iter may be NULL if you just want to test if @selection has any selected nodes. @model is filled with the current model as a convenience. This function will not work if you use @selection is #GTK_SELECTION_MULTIPLE. - TRUE, if there is a selected node. + TRUE, if there is a selected node. - A #GtkTreeSelection. + A #GtkTreeSelection. - - A pointer to set to the #GtkTreeModel, or NULL. + + A pointer to set to the #GtkTreeModel, or NULL. - - The #GtkTreeIter, or NULL. + + The #GtkTreeIter, or NULL. - - Creates a list of path of all selected rows. Additionally, if you are + + Creates a list of path of all selected rows. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of #GtkTreeRowReferences. To do this, you can use gtk_tree_row_reference_new(). @@ -174867,135 +125279,89 @@ g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); ]| - A #GList containing a #GtkTreePath for each selected row. + A #GList containing a #GtkTreePath for each selected row. - A #GtkTreeSelection. + A #GtkTreeSelection. - - A pointer to set to the #GtkTreeModel, or %NULL. + + A pointer to set to the #GtkTreeModel, or %NULL. - - Returns the tree view associated with @selection. + + Returns the tree view associated with @selection. - A #GtkTreeView + A #GtkTreeView - A #GtkTreeSelection + A #GtkTreeSelection - - Returns the user data for the selection function. + + Returns the user data for the selection function. - The user data. + The user data. - A #GtkTreeSelection. + A #GtkTreeSelection. - - Returns %TRUE if the row at @iter is currently selected. + + Returns %TRUE if the row at @iter is currently selected. - %TRUE, if @iter is selected + %TRUE, if @iter is selected - A #GtkTreeSelection + A #GtkTreeSelection - A valid #GtkTreeIter + A valid #GtkTreeIter - - Returns %TRUE if the row pointed to by @path is currently selected. If @path + + Returns %TRUE if the row pointed to by @path is currently selected. If @path does not point to a valid location, %FALSE is returned - %TRUE if @path is selected. + %TRUE if @path is selected. - A #GtkTreeSelection. + A #GtkTreeSelection. - A #GtkTreePath to check selection on. + A #GtkTreePath to check selection on. - Selects all the nodes. @selection must be set to #GTK_SELECTION_MULTIPLE + Selects all the nodes. @selection must be set to #GTK_SELECTION_MULTIPLE mode. @@ -175003,64 +125369,47 @@ mode. - A #GtkTreeSelection. + A #GtkTreeSelection. - Selects the specified iterator. + Selects the specified iterator. - A #GtkTreeSelection. + A #GtkTreeSelection. - The #GtkTreeIter to be selected. + The #GtkTreeIter to be selected. - Select the row at @path. + Select the row at @path. - A #GtkTreeSelection. + A #GtkTreeSelection. - The #GtkTreePath to be selected. + The #GtkTreePath to be selected. - - Selects a range of nodes, determined by @start_path and @end_path inclusive. + + Selects a range of nodes, determined by @start_path and @end_path inclusive. @selection must be set to #GTK_SELECTION_MULTIPLE mode. @@ -175068,30 +125417,21 @@ mode. - A #GtkTreeSelection. + A #GtkTreeSelection. - The initial node of the range. + The initial node of the range. - The final node of the range. + The final node of the range. - - Calls a function for each selected node. Note that you cannot modify + + Calls a function for each selected node. Note that you cannot modify the tree or selection from within this function. As a result, gtk_tree_selection_get_selected_rows() might be more useful. @@ -175100,36 +125440,21 @@ gtk_tree_selection_get_selected_rows() might be more useful. - A #GtkTreeSelection. + A #GtkTreeSelection. - - The function to call for each selected node. - + + The function to call for each selected node. + - - user data to pass to the function. + + user data to pass to the function. - Sets the selection mode of the @selection. If the previous type was + Sets the selection mode of the @selection. If the previous type was #GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was previously selected. @@ -175138,24 +125463,17 @@ previously selected. - A #GtkTreeSelection. + A #GtkTreeSelection. - The selection mode + The selection mode - - Sets the selection function. + + Sets the selection function. If set, this function is called before any node is selected or unselected, giving some control over which nodes are selected. The select function @@ -175167,112 +125485,72 @@ if the state of the node should be left unchanged. - A #GtkTreeSelection. + A #GtkTreeSelection. - - The selection function. May be %NULL + + The selection function. May be %NULL - - The selection function’s data. May be %NULL + + The selection function’s data. May be %NULL - The destroy function for user data. May be %NULL + The destroy function for user data. May be %NULL - - Unselects all the nodes. + + Unselects all the nodes. - A #GtkTreeSelection. + A #GtkTreeSelection. - - Unselects the specified iterator. + + Unselects the specified iterator. - A #GtkTreeSelection. + A #GtkTreeSelection. - The #GtkTreeIter to be unselected. + The #GtkTreeIter to be unselected. - - Unselects the row at @path. + + Unselects the row at @path. - A #GtkTreeSelection. + A #GtkTreeSelection. - The #GtkTreePath to be unselected. + The #GtkTreePath to be unselected. - - Unselects a range of nodes, determined by @start_path and @end_path + + Unselects a range of nodes, determined by @start_path and @end_path inclusive. @@ -175280,32 +125558,21 @@ inclusive. - A #GtkTreeSelection. + A #GtkTreeSelection. - The initial node of the range. + The initial node of the range. - The initial node of the range. + The initial node of the range. - - Selection mode. + + Selection mode. See gtk_tree_selection_set_mode() for more information on this property. @@ -175316,9 +125583,7 @@ See gtk_tree_selection_set_mode() for more information on this property. - Emitted whenever the selection has (possibly) changed. Please note that + Emitted whenever the selection has (possibly) changed. Please note that this signal is mostly a hint. It may only be emitted once when a range of rows are selected, and it may occasionally be emitted when nothing has happened. @@ -175327,14 +125592,10 @@ has happened. - + - The parent class. + The parent class. @@ -175383,11 +125644,8 @@ has happened. - - A function used by gtk_tree_selection_selected_foreach() to map all + + A function used by gtk_tree_selection_selected_foreach() to map all selected rows. It will be called on every selected row in the view. @@ -175395,180 +125653,115 @@ selected rows. It will be called on every selected row in the view. - The #GtkTreeModel being viewed + The #GtkTreeModel being viewed - The #GtkTreePath of a selected row + The #GtkTreePath of a selected row - A #GtkTreeIter pointing to a selected row + A #GtkTreeIter pointing to a selected row - - user data + + user data - A function used by gtk_tree_selection_set_select_function() to filter + A function used by gtk_tree_selection_set_select_function() to filter whether or not a row may be selected. It is called whenever a row's state might change. A return value of %TRUE indicates to @selection that it is okay to change the selection. - %TRUE, if the selection state of the row can be toggled + %TRUE, if the selection state of the row can be toggled - A #GtkTreeSelection + A #GtkTreeSelection - A #GtkTreeModel being viewed + A #GtkTreeModel being viewed - The #GtkTreePath of the row in question + The #GtkTreePath of the row in question - %TRUE, if the path is currently selected + %TRUE, if the path is currently selected - - user data + + user data - + - - #GtkTreeSortable is an interface to be implemented by tree models which + + #GtkTreeSortable is an interface to be implemented by tree models which support sorting. The #GtkTreeView uses the methods provided by this interface to sort the model. - Fills in @sort_column_id and @order with the current sort column and the + Fills in @sort_column_id and @order with the current sort column and the order. It returns %TRUE unless the @sort_column_id is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. - %TRUE if the sort column is not one of the special sort + %TRUE if the sort column is not one of the special sort column ids. - A #GtkTreeSortable + A #GtkTreeSortable - - The sort column id to be filled in + + The sort column id to be filled in - - The #GtkSortType to be filled in + + The #GtkSortType to be filled in - - Returns %TRUE if the model has a default sort function. This is used + + Returns %TRUE if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not. - %TRUE, if the model has a default sort function + %TRUE, if the model has a default sort function - A #GtkTreeSortable + A #GtkTreeSortable - - Sets the default comparison function used when sorting to be @sort_func. + + Sets the default comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. If @sort_func is %NULL, then there will be no default comparison function. -This means that once the model has been sorted, it can’t go back to the +This means that once the model has been sorted, it can’t go back to the default state. In this case, when the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. @@ -175577,47 +125770,25 @@ is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. - A #GtkTreeSortable + A #GtkTreeSortable - - The comparison function + + The comparison function - - User data to pass to @sort_func, or %NULL + + User data to pass to @sort_func, or %NULL - - Destroy notifier of @user_data, or %NULL + + Destroy notifier of @user_data, or %NULL - Sets the current sort column to be @sort_column_id. The @sortable will + Sets the current sort column to be @sort_column_id. The @sortable will resort itself to reflect this change, after emitting a #GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be a regular column id, or one of the following special values: @@ -175632,29 +125803,21 @@ a regular column id, or one of the following special values: - A #GtkTreeSortable + A #GtkTreeSortable - the sort column id to set + the sort column id to set - The sort order of the column + The sort order of the column - Sets the comparison function used when sorting to be @sort_func. If the + Sets the comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is the same as @sort_column_id, then the model will sort using this function. @@ -175663,143 +125826,90 @@ the model will sort using this function. - A #GtkTreeSortable + A #GtkTreeSortable - the sort column id to set the function for + the sort column id to set the function for - - The comparison function + + The comparison function - - User data to pass to @sort_func, or %NULL + + User data to pass to @sort_func, or %NULL - - Destroy notifier of @user_data, or %NULL + + Destroy notifier of @user_data, or %NULL - Emits a #GtkTreeSortable::sort-column-changed signal on @sortable. + Emits a #GtkTreeSortable::sort-column-changed signal on @sortable. - A #GtkTreeSortable + A #GtkTreeSortable - - Fills in @sort_column_id and @order with the current sort column and the + + Fills in @sort_column_id and @order with the current sort column and the order. It returns %TRUE unless the @sort_column_id is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. - %TRUE if the sort column is not one of the special sort + %TRUE if the sort column is not one of the special sort column ids. - A #GtkTreeSortable + A #GtkTreeSortable - - The sort column id to be filled in + + The sort column id to be filled in - - The #GtkSortType to be filled in + + The #GtkSortType to be filled in - - Returns %TRUE if the model has a default sort function. This is used + + Returns %TRUE if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not. - %TRUE, if the model has a default sort function + %TRUE, if the model has a default sort function - A #GtkTreeSortable + A #GtkTreeSortable - - Sets the default comparison function used when sorting to be @sort_func. + + Sets the default comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. If @sort_func is %NULL, then there will be no default comparison function. -This means that once the model has been sorted, it can’t go back to the +This means that once the model has been sorted, it can’t go back to the default state. In this case, when the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. @@ -175808,47 +125918,25 @@ is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. - A #GtkTreeSortable + A #GtkTreeSortable - - The comparison function + + The comparison function - - User data to pass to @sort_func, or %NULL + + User data to pass to @sort_func, or %NULL - - Destroy notifier of @user_data, or %NULL + + Destroy notifier of @user_data, or %NULL - - Sets the current sort column to be @sort_column_id. The @sortable will + + Sets the current sort column to be @sort_column_id. The @sortable will resort itself to reflect this change, after emitting a #GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be a regular column id, or one of the following special values: @@ -175863,30 +125951,21 @@ a regular column id, or one of the following special values: - A #GtkTreeSortable + A #GtkTreeSortable - the sort column id to set + the sort column id to set - The sort order of the column + The sort order of the column - - Sets the comparison function used when sorting to be @sort_func. If the + + Sets the comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is the same as @sort_column_id, then the model will sort using this function. @@ -175895,70 +125974,42 @@ the model will sort using this function. - A #GtkTreeSortable + A #GtkTreeSortable - the sort column id to set the function for + the sort column id to set the function for - - The comparison function + + The comparison function - - User data to pass to @sort_func, or %NULL + + User data to pass to @sort_func, or %NULL - - Destroy notifier of @user_data, or %NULL + + Destroy notifier of @user_data, or %NULL - - Emits a #GtkTreeSortable::sort-column-changed signal on @sortable. + + Emits a #GtkTreeSortable::sort-column-changed signal on @sortable. - A #GtkTreeSortable + A #GtkTreeSortable - The ::sort-column-changed signal is emitted when the sort column + The ::sort-column-changed signal is emitted when the sort column or sort order of @sortable is changed. The signal is emitted before the contents of @sortable are resorted. @@ -175966,9 +126017,7 @@ the contents of @sortable are resorted. - + @@ -175981,9 +126030,7 @@ the contents of @sortable are resorted. - A #GtkTreeSortable + A #GtkTreeSortable @@ -175993,35 +126040,21 @@ the contents of @sortable are resorted. - %TRUE if the sort column is not one of the special sort + %TRUE if the sort column is not one of the special sort column ids. - A #GtkTreeSortable + A #GtkTreeSortable - - The sort column id to be filled in + + The sort column id to be filled in - - The #GtkSortType to be filled in + + The #GtkSortType to be filled in @@ -176035,21 +126068,15 @@ the contents of @sortable are resorted. - A #GtkTreeSortable + A #GtkTreeSortable - the sort column id to set + the sort column id to set - The sort order of the column + The sort order of the column @@ -176063,46 +126090,23 @@ the contents of @sortable are resorted. - A #GtkTreeSortable + A #GtkTreeSortable - the sort column id to set the function for + the sort column id to set the function for - - The comparison function - + + The comparison function + - - User data to pass to @sort_func, or %NULL + + User data to pass to @sort_func, or %NULL - - Destroy notifier of @user_data, or %NULL + + Destroy notifier of @user_data, or %NULL @@ -176116,40 +126120,19 @@ the contents of @sortable are resorted. - A #GtkTreeSortable + A #GtkTreeSortable - - The comparison function - + + The comparison function + - - User data to pass to @sort_func, or %NULL + + User data to pass to @sort_func, or %NULL - - Destroy notifier of @user_data, or %NULL + + Destroy notifier of @user_data, or %NULL @@ -176159,32 +126142,20 @@ the contents of @sortable are resorted. - %TRUE, if the model has a default sort function + %TRUE, if the model has a default sort function - A #GtkTreeSortable + A #GtkTreeSortable - - The #GtkTreeStore object is a list model for use with a #GtkTreeView + + The #GtkTreeStore object is a list model for use with a #GtkTreeView widget. It implements the #GtkTreeModel interface, and consequentially, can use all of the methods available there. It also implements the #GtkTreeSortable interface so it can be sorted by the view. Finally, @@ -176196,7 +126167,7 @@ interfaces. The GtkTreeStore implementation of the #GtkBuildable interface allows to specify the model columns with a <columns> element that may contain -multiple <column> elements, each specifying one model column. The “type” +multiple <column> elements, each specifying one model column. The “type” attribute specifies the data type for the column. An example of a UI Definition fragment for a tree store: @@ -176215,13 +126186,8 @@ An example of a UI Definition fragment for a tree store: - - Creates a new tree store as with @n_columns columns each of the types passed + + Creates a new tree store as with @n_columns columns each of the types passed in. Note that only types derived from standard GObject fundamental types are supported. @@ -176230,50 +126196,34 @@ GDK_TYPE_PIXBUF);` will create a new #GtkTreeStore with three columns, of type #gint, #gchararray, and #GdkPixbuf respectively. - a new #GtkTreeStore + a new #GtkTreeStore - number of columns in the tree store + number of columns in the tree store - all #GType types for the columns, from first to last + all #GType types for the columns, from first to last - - Non vararg creation function. Used primarily by language bindings. + + Non vararg creation function. Used primarily by language bindings. - a new #GtkTreeStore + a new #GtkTreeStore - number of columns in the tree store + number of columns in the tree store - an array of #GType types for the columns, from first to last + an array of #GType types for the columns, from first to last @@ -176281,9 +126231,7 @@ GDK_TYPE_PIXBUF);` will create a new #GtkTreeStore with three columns, of type - Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the + Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the new row after the last child of @parent, otherwise it will append a row to the top level. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call @@ -176294,52 +126242,34 @@ gtk_tree_store_set() or gtk_tree_store_set_value(). - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set to the appended row + + An unset #GtkTreeIter to set to the appended row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - Removes all rows from @tree_store + Removes all rows from @tree_store - a #GtkTreeStore + a #GtkTreeStore - Creates a new row at @position. If parent is non-%NULL, then the row will be + Creates a new row at @position. If parent is non-%NULL, then the row will be made a child of @parent. Otherwise, the row will be created at the toplevel. If @position is -1 or is larger than the number of rows at that level, then the new row will be inserted to the end of the list. @iter will be changed @@ -176352,42 +126282,26 @@ gtk_tree_store_set_value(). - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set to the new row + + An unset #GtkTreeIter to set to the new row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - Inserts a new row after @sibling. If @sibling is %NULL, then the row will be -prepended to @parent ’s children. If @parent and @sibling are %NULL, then + Inserts a new row after @sibling. If @sibling is %NULL, then the row will be +prepended to @parent ’s children. If @parent and @sibling are %NULL, then the row will be prepended to the toplevel. If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set, @parent is optional. @@ -176401,45 +126315,26 @@ gtk_tree_store_set() or gtk_tree_store_set_value(). - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set to the new row + + An unset #GtkTreeIter to set to the new row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - Inserts a new row before @sibling. If @sibling is %NULL, then the row will -be appended to @parent ’s children. If @parent and @sibling are %NULL, then + Inserts a new row before @sibling. If @sibling is %NULL, then the row will +be appended to @parent ’s children. If @parent and @sibling are %NULL, then the row will be appended to the toplevel. If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set, @parent is optional. @@ -176453,48 +126348,25 @@ gtk_tree_store_set() or gtk_tree_store_set_value(). - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set to the new row + + An unset #GtkTreeIter to set to the new row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - - Creates a new row at @position. @iter will be changed to point to this + + Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1, or larger than the number of rows on the list, then the new row will be appended to the list. The row will be filled with the values given to this function. @@ -176518,52 +126390,29 @@ inserting rows in a sorted tree store. - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set the new row, or %NULL. + + An unset #GtkTreeIter to set the new row, or %NULL. - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - position to insert the new row, or -1 to append after existing rows + position to insert the new row, or -1 to append after existing rows - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - - A variant of gtk_tree_store_insert_with_values() which takes + + A variant of gtk_tree_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language bindings. @@ -176572,158 +126421,104 @@ function is mainly intended for language bindings. - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set the new row, or %NULL. + + An unset #GtkTreeIter to set the new row, or %NULL. - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the + Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the parent (or grandparent or great-grandparent) of @descendant. - %TRUE, if @iter is an ancestor of @descendant + %TRUE, if @iter is an ancestor of @descendant - A #GtkTreeStore + A #GtkTreeStore - A valid #GtkTreeIter + A valid #GtkTreeIter - A valid #GtkTreeIter + A valid #GtkTreeIter - Returns the depth of @iter. This will be 0 for anything on the root level, 1 + Returns the depth of @iter. This will be 0 for anything on the root level, 1 for anything down a level, etc. - The depth of @iter + The depth of @iter - A #GtkTreeStore + A #GtkTreeStore - A valid #GtkTreeIter + A valid #GtkTreeIter - - WARNING: This function is slow. Only use it for debugging and/or testing + + WARNING: This function is slow. Only use it for debugging and/or testing purposes. Checks if the given iter is a valid iter for this #GtkTreeStore. - %TRUE if the iter is valid, %FALSE if the iter is invalid. + %TRUE if the iter is valid, %FALSE if the iter is invalid. - A #GtkTreeStore. + A #GtkTreeStore. - A #GtkTreeIter. + A #GtkTreeIter. - - Moves @iter in @tree_store to the position after @position. @iter and + + Moves @iter in @tree_store to the position after @position. @iter and @position should be in the same level. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the start of the level. @@ -176733,34 +126528,21 @@ to the start of the level. - A #GtkTreeStore. + A #GtkTreeStore. - A #GtkTreeIter. + A #GtkTreeIter. - - A #GtkTreeIter. + + A #GtkTreeIter. - - Moves @iter in @tree_store to the position before @position. @iter and + + Moves @iter in @tree_store to the position before @position. @iter and @position should be in the same level. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the end of the level. @@ -176770,32 +126552,21 @@ moved to the end of the level. - A #GtkTreeStore. + A #GtkTreeStore. - A #GtkTreeIter. + A #GtkTreeIter. - - A #GtkTreeIter or %NULL. + + A #GtkTreeIter or %NULL. - Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend + Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend the new row before the first child of @parent, otherwise it will prepend a row to the top level. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to @@ -176806,66 +126577,41 @@ call gtk_tree_store_set() or gtk_tree_store_set_value(). - A #GtkTreeStore + A #GtkTreeStore - - An unset #GtkTreeIter to set to the prepended row + + An unset #GtkTreeIter to set to the prepended row - - A valid #GtkTreeIter, or %NULL + + A valid #GtkTreeIter, or %NULL - Removes @iter from @tree_store. After being removed, @iter is set to the + Removes @iter from @tree_store. After being removed, @iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one. - %TRUE if @iter is still valid, %FALSE if not. + %TRUE if @iter is still valid, %FALSE if not. - A #GtkTreeStore + A #GtkTreeStore - A valid #GtkTreeIter + A valid #GtkTreeIter - - Reorders the children of @parent in @tree_store to follow the order + + Reorders the children of @parent in @tree_store to follow the order indicated by @new_order. Note that this function only works with unsorted stores. @@ -176874,24 +126620,15 @@ unsorted stores. - A #GtkTreeStore + A #GtkTreeStore - - A #GtkTreeIter, or %NULL + + A #GtkTreeIter, or %NULL - an array of integers mapping the new position of each child + an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos`. @@ -176900,17 +126637,12 @@ unsorted stores. - - Sets the value of one or more cells in the row referenced by @iter. + + Sets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by the value to be set. The list is terminated by a -1. For example, to set column 0 with type -%G_TYPE_STRING to “Foo”, you would write +%G_TYPE_STRING to “Foo”, you would write `gtk_tree_store_set (store, iter, 0, "Foo", -1)`. The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it @@ -176921,30 +126653,21 @@ will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED. - A #GtkTreeStore + A #GtkTreeStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - - This function is meant primarily for #GObjects that inherit from + + This function is meant primarily for #GObjects that inherit from #GtkTreeStore, and should only be used when constructing a new #GtkTreeStore. It will not function after a row has been added, or a method on the #GtkTreeModel interface is called. @@ -176954,33 +126677,23 @@ or a method on the #GtkTreeModel interface is called. - A #GtkTreeStore + A #GtkTreeStore - Number of columns for the tree store + Number of columns for the tree store - An array of #GType types, one for each column + An array of #GType types, one for each column - - See gtk_tree_store_set(); this version takes a va_list for + + See gtk_tree_store_set(); this version takes a va_list for use by language bindings. @@ -176988,29 +126701,21 @@ use by language bindings. - A #GtkTreeStore + A #GtkTreeStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - va_list of column/value pairs + va_list of column/value pairs - Sets the data in the cell specified by @iter and @column. + Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column. @@ -177019,38 +126724,25 @@ column. - a #GtkTreeStore + a #GtkTreeStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - column number to modify + column number to modify - new value for the cell + new value for the cell - - A variant of gtk_tree_store_set_valist() which takes + + A variant of gtk_tree_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language bindings or in case the number of columns to change is not known until run-time. @@ -177060,45 +126752,33 @@ the number of columns to change is not known until run-time. - A #GtkTreeStore + A #GtkTreeStore - A valid #GtkTreeIter for the row being modified + A valid #GtkTreeIter for the row being modified - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Swaps @a and @b in the same level of @tree_store. Note that this function + Swaps @a and @b in the same level of @tree_store. Note that this function only works with unsorted stores. @@ -177106,21 +126786,15 @@ only works with unsorted stores. - A #GtkTreeStore. + A #GtkTreeStore. - A #GtkTreeIter. + A #GtkTreeIter. - Another #GtkTreeIter. + Another #GtkTreeIter. @@ -177132,9 +126806,7 @@ only works with unsorted stores. - + @@ -177175,16 +126847,8 @@ only works with unsorted stores. - - Widget that displays any object that implements the #GtkTreeModel interface. + + Widget that displays any object that implements the #GtkTreeModel interface. Please refer to the [tree widget conceptual overview][TreeWidget] @@ -177245,12 +126909,12 @@ An example of a UI definition fragment with GtkTreeView: |[<!-- language="plain" --> treeview.view -├── header -│ ├── <column header> -┊ ┊ -│ ╰── <column header> -│ -╰── [rubberband] +├── header +│ ├── <column header> +┊ ┊ +│ ╰── <column header> +│ +╰── [rubberband] ]| GtkTreeView has a main CSS node with name treeview and style class .view. @@ -177262,34 +126926,23 @@ For rubberband selection, a subnode with name rubberband is used. - Creates a new #GtkTreeView widget. + Creates a new #GtkTreeView widget. - A newly created #GtkTreeView widget. + A newly created #GtkTreeView widget. - - Creates a new #GtkTreeView widget with the model initialized to @model. + + Creates a new #GtkTreeView widget with the model initialized to @model. - A newly created #GtkTreeView widget. + A newly created #GtkTreeView widget. - the model. + the model. @@ -177354,30 +127007,22 @@ For rubberband selection, a subnode with name rubberband is used. - Activates the cell determined by @path and @column. + Activates the cell determined by @path and @column. - A #GtkTreeView + A #GtkTreeView - The #GtkTreePath to be activated. + The #GtkTreePath to be activated. - The #GtkTreeViewColumn to be activated. + The #GtkTreeViewColumn to be activated. @@ -177520,81 +127165,58 @@ For rubberband selection, a subnode with name rubberband is used. - Appends @column to the list of columns. If @tree_view has “fixed_height” -mode enabled, then @column must have its “sizing” property set to be + Appends @column to the list of columns. If @tree_view has “fixed_height” +mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. - The number of columns in @tree_view after appending. + The number of columns in @tree_view after appending. - A #GtkTreeView. + A #GtkTreeView. - The #GtkTreeViewColumn to add. + The #GtkTreeViewColumn to add. - Recursively collapses all visible, expanded nodes in @tree_view. + Recursively collapses all visible, expanded nodes in @tree_view. - A #GtkTreeView. + A #GtkTreeView. - Collapses a row (hides its child rows, if they exist). + Collapses a row (hides its child rows, if they exist). - %TRUE if the row was collapsed. + %TRUE if the row was collapsed. - a #GtkTreeView + a #GtkTreeView - path to a row in the @tree_view + path to a row in the @tree_view - - Resizes all columns to their optimal width. Only works after the + + Resizes all columns to their optimal width. Only works after the treeview has been realized. @@ -177602,19 +127224,13 @@ treeview has been realized. - A #GtkTreeView. + A #GtkTreeView. - - Converts bin_window coordinates to coordinates for the + + Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree). @@ -177622,49 +127238,29 @@ tree (the full scrollable area of the tree). - a #GtkTreeView + a #GtkTreeView - X coordinate relative to bin_window + X coordinate relative to bin_window - Y coordinate relative to bin_window + Y coordinate relative to bin_window - - return location for tree X coordinate + + return location for tree X coordinate - - return location for tree Y coordinate + + return location for tree Y coordinate - - Converts bin_window coordinates (see gtk_tree_view_get_bin_window()) + + Converts bin_window coordinates (see gtk_tree_view_get_bin_window()) to widget relative coordinates. @@ -177672,49 +127268,29 @@ to widget relative coordinates. - a #GtkTreeView + a #GtkTreeView - bin_window X coordinate + bin_window X coordinate - bin_window Y coordinate + bin_window Y coordinate - - return location for widget X coordinate + + return location for widget X coordinate - - return location for widget Y coordinate + + return location for widget Y coordinate - - Converts tree coordinates (coordinates in full scrollable area of the tree) + + Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates. @@ -177722,49 +127298,29 @@ to bin_window coordinates. - a #GtkTreeView + a #GtkTreeView - tree X coordinate + tree X coordinate - tree Y coordinate + tree Y coordinate - - return location for X coordinate relative to bin_window + + return location for X coordinate relative to bin_window - - return location for Y coordinate relative to bin_window + + return location for Y coordinate relative to bin_window - - Converts tree coordinates (coordinates in full scrollable area of the tree) + + Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates. @@ -177772,49 +127328,29 @@ to widget coordinates. - a #GtkTreeView + a #GtkTreeView - X coordinate relative to the tree + X coordinate relative to the tree - Y coordinate relative to the tree + Y coordinate relative to the tree - - return location for widget X coordinate + + return location for widget X coordinate - - return location for widget Y coordinate + + return location for widget Y coordinate - - Converts widget coordinates to coordinates for the bin_window + + Converts widget coordinates to coordinates for the bin_window (see gtk_tree_view_get_bin_window()). @@ -177822,49 +127358,29 @@ to widget coordinates. - a #GtkTreeView + a #GtkTreeView - X coordinate relative to the widget + X coordinate relative to the widget - Y coordinate relative to the widget + Y coordinate relative to the widget - - return location for bin_window X coordinate + + return location for bin_window X coordinate - - return location for bin_window Y coordinate + + return location for bin_window Y coordinate - - Converts widget coordinates to coordinates for the + + Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree). @@ -177872,76 +127388,48 @@ tree (the full scrollable area of the tree). - a #GtkTreeView + a #GtkTreeView - X coordinate relative to the widget + X coordinate relative to the widget - Y coordinate relative to the widget + Y coordinate relative to the widget - - return location for tree X coordinate + + return location for tree X coordinate - - return location for tree Y coordinate + + return location for tree Y coordinate - - Creates a #cairo_surface_t representation of the row at @path. + + Creates a #cairo_surface_t representation of the row at @path. This image is used for a drag icon. - a newly-allocated surface of the drag icon. + a newly-allocated surface of the drag icon. - a #GtkTreeView + a #GtkTreeView - a #GtkTreePath in @tree_view + a #GtkTreePath in @tree_view - - Turns @tree_view into a drop destination for automatic DND. Calling + + Turns @tree_view into a drop destination for automatic DND. Calling this method sets #GtkTreeView:reorderable to %FALSE. @@ -177949,42 +127437,29 @@ this method sets #GtkTreeView:reorderable to %FALSE. - a #GtkTreeView + a #GtkTreeView - the table of targets that + the table of targets that the drag will support - + - the number of items in @targets + the number of items in @targets - the bitmask of possible actions for a drag from this + the bitmask of possible actions for a drag from this widget - - Turns @tree_view into a drag source for automatic DND. Calling this + + Turns @tree_view into a drag source for automatic DND. Calling this method sets #GtkTreeView:reorderable to %FALSE. @@ -177992,97 +127467,67 @@ method sets #GtkTreeView:reorderable to %FALSE. - a #GtkTreeView + a #GtkTreeView - Mask of allowed buttons to start drag + Mask of allowed buttons to start drag - the table of targets that the drag will support - + the table of targets that the drag will support + - the number of items in @targets + the number of items in @targets - the bitmask of possible actions for a drag from this + the bitmask of possible actions for a drag from this widget - Recursively expands all nodes in the @tree_view. + Recursively expands all nodes in the @tree_view. - A #GtkTreeView. + A #GtkTreeView. - Opens the row so its children are visible. + Opens the row so its children are visible. - %TRUE if the row existed and had children + %TRUE if the row existed and had children - a #GtkTreeView + a #GtkTreeView - path to a row + path to a row - whether to recursively expand, or just expand immediate children + whether to recursively expand, or just expand immediate children - - Expands the row at @path. This will also expand all parent rows of + + Expands the row at @path. This will also expand all parent rows of @path as necessary. @@ -178090,46 +127535,31 @@ method sets #GtkTreeView:reorderable to %FALSE. - A #GtkTreeView. + A #GtkTreeView. - path to a row. + path to a row. - - Gets the setting set by gtk_tree_view_set_activate_on_single_click(). + + Gets the setting set by gtk_tree_view_set_activate_on_single_click(). - %TRUE if row-activated will be emitted on a single click + %TRUE if row-activated will be emitted on a single click - a #GtkTreeView + a #GtkTreeView - - Fills the bounding rectangle in bin_window coordinates for the cell at the + + Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is %NULL, or points to a node not found in the tree, the @y and @height fields of the rectangle will be filled with 0. If @column is %NULL, the @x and @width @@ -178144,68 +127574,42 @@ itself, excluding surrounding borders and the tree expander area. - a #GtkTreeView + a #GtkTreeView - - a #GtkTreePath for the row, or %NULL to get only horizontal coordinates + + a #GtkTreePath for the row, or %NULL to get only horizontal coordinates - - a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes + + a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes - - rectangle to fill with cell background rect + + rectangle to fill with cell background rect - - Returns the window that @tree_view renders to. + + Returns the window that @tree_view renders to. This is used primarily to compare to `event->window` to confirm that the event on @tree_view is on the right window. - A #GdkWindow, or %NULL when @tree_view -hasn’t been realized yet. + A #GdkWindow, or %NULL when @tree_view +hasn’t been realized yet. - A #GtkTreeView + A #GtkTreeView - Fills the bounding rectangle in bin_window coordinates for the cell at the + Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is %NULL, or points to a path not currently displayed, the @y and @height fields of the rectangle will be filled with 0. If @column is %NULL, the @x and @width @@ -178220,95 +127624,62 @@ realized. - a #GtkTreeView + a #GtkTreeView - - a #GtkTreePath for the row, or %NULL to get only horizontal coordinates + + a #GtkTreePath for the row, or %NULL to get only horizontal coordinates - - a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates + + a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates - - rectangle to fill with cell rect + + rectangle to fill with cell rect - Gets the #GtkTreeViewColumn at the given position in the #tree_view. + Gets the #GtkTreeViewColumn at the given position in the #tree_view. - The #GtkTreeViewColumn, or %NULL if the + The #GtkTreeViewColumn, or %NULL if the position is outside the range of columns. - A #GtkTreeView. + A #GtkTreeView. - The position of the column, counting from 0. + The position of the column, counting from 0. - Returns a #GList of all the #GtkTreeViewColumn s currently in @tree_view. + Returns a #GList of all the #GtkTreeViewColumn s currently in @tree_view. The returned list must be freed with g_list_free (). - A list of #GtkTreeViewColumn s + A list of #GtkTreeViewColumn s - A #GtkTreeView + A #GtkTreeView - Fills in @path and @focus_column with the current path and focus column. If -the cursor isn’t currently set, then *@path will be %NULL. If no column + Fills in @path and @focus_column with the current path and focus column. If +the cursor isn’t currently set, then *@path will be %NULL. If no column currently has focus, then *@focus_column will be %NULL. The returned #GtkTreePath must be freed with gtk_tree_path_free() when @@ -178319,441 +127690,272 @@ you are done with it. - A #GtkTreeView + A #GtkTreeView - - A pointer to be + + A pointer to be filled with the current cursor path, or %NULL - - A + + A pointer to be filled with the current focus column, or %NULL - - Determines the destination row for a given position. @drag_x and + + Determines the destination row for a given position. @drag_x and @drag_y are expected to be in widget coordinates. This function is only meaningful if @tree_view is realized. Therefore this function will always return %FALSE if @tree_view is not realized or does not have a model. - whether there is a row at the given position, %TRUE if this + whether there is a row at the given position, %TRUE if this is indeed the case. - a #GtkTreeView + a #GtkTreeView - the position to determine the destination row for + the position to determine the destination row for - the position to determine the destination row for + the position to determine the destination row for - - Return location for the path of + + Return location for the path of the highlighted row, or %NULL. - - Return location for the drop position, or + + Return location for the drop position, or %NULL - + - - Gets information about the row that is highlighted for feedback. + + Gets information about the row that is highlighted for feedback. - a #GtkTreeView + a #GtkTreeView - - Return location for the path of the highlighted row, or %NULL. + + Return location for the path of the highlighted row, or %NULL. - - Return location for the drop position, or %NULL - + + Return location for the drop position, or %NULL + - - Returns whether or not the tree allows to start interactive searching + + Returns whether or not the tree allows to start interactive searching by typing in text. - whether or not to let the user search interactively + whether or not to let the user search interactively - A #GtkTreeView + A #GtkTreeView - - Returns whether or not tree lines are drawn in @tree_view. + + Returns whether or not tree lines are drawn in @tree_view. - %TRUE if tree lines are drawn in @tree_view, %FALSE + %TRUE if tree lines are drawn in @tree_view, %FALSE otherwise. - a #GtkTreeView. + a #GtkTreeView. - - Returns the column that is the current expander column. + + Returns the column that is the current expander column. This column has the expander arrow drawn next to it. - The expander column. + The expander column. - A #GtkTreeView + A #GtkTreeView - - Returns whether fixed height mode is turned on for @tree_view. + + Returns whether fixed height mode is turned on for @tree_view. - %TRUE if @tree_view is in fixed height mode + %TRUE if @tree_view is in fixed height mode - a #GtkTreeView + a #GtkTreeView - - Returns which grid lines are enabled in @tree_view. + + Returns which grid lines are enabled in @tree_view. - a #GtkTreeViewGridLines value indicating which grid lines + a #GtkTreeViewGridLines value indicating which grid lines are enabled. - a #GtkTreeView + a #GtkTreeView - - Gets the #GtkAdjustment currently being used for the horizontal aspect. + + Gets the #GtkAdjustment currently being used for the horizontal aspect. Use gtk_scrollable_get_hadjustment() - A #GtkAdjustment object, or %NULL + A #GtkAdjustment object, or %NULL if none is currently being used. - A #GtkTreeView + A #GtkTreeView - - Returns whether all header columns are clickable. + + Returns whether all header columns are clickable. - %TRUE if all header columns are clickable, otherwise %FALSE + %TRUE if all header columns are clickable, otherwise %FALSE - A #GtkTreeView. + A #GtkTreeView. - - Returns %TRUE if the headers on the @tree_view are visible. + + Returns %TRUE if the headers on the @tree_view are visible. - Whether the headers are visible or not. + Whether the headers are visible or not. - A #GtkTreeView. + A #GtkTreeView. - - Returns whether hover expansion mode is turned on for @tree_view. + + Returns whether hover expansion mode is turned on for @tree_view. - %TRUE if @tree_view is in hover expansion mode + %TRUE if @tree_view is in hover expansion mode - a #GtkTreeView + a #GtkTreeView - - Returns whether hover selection mode is turned on for @tree_view. + + Returns whether hover selection mode is turned on for @tree_view. - %TRUE if @tree_view is in hover selection mode + %TRUE if @tree_view is in hover selection mode - a #GtkTreeView + a #GtkTreeView - - Returns the amount, in pixels, of extra indentation for child levels + + Returns the amount, in pixels, of extra indentation for child levels in @tree_view. - the amount of extra indentation for child levels in + the amount of extra indentation for child levels in @tree_view. A return value of 0 means that this feature is disabled. - a #GtkTreeView. + a #GtkTreeView. - Returns the model the #GtkTreeView is based on. Returns %NULL if the + Returns the model the #GtkTreeView is based on. Returns %NULL if the model is unset. - A #GtkTreeModel, or %NULL if + A #GtkTreeModel, or %NULL if none is currently being used. - a #GtkTreeView + a #GtkTreeView - - Queries the number of columns in the given @tree_view. + + Queries the number of columns in the given @tree_view. - The number of columns in the @tree_view + The number of columns in the @tree_view - a #GtkTreeView + a #GtkTreeView - - Finds the path at the point (@x, @y), relative to bin_window coordinates + + Finds the path at the point (@x, @y), relative to bin_window coordinates (please see gtk_tree_view_get_bin_window()). That is, @x and @y are relative to an events coordinates. @x and @y must come from an event on the @tree_view only where `event->window == @@ -178772,340 +127974,208 @@ GtkWidget::query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords(). - %TRUE if a row exists at that coordinate. + %TRUE if a row exists at that coordinate. - A #GtkTreeView. + A #GtkTreeView. - The x position to be identified (relative to bin_window). + The x position to be identified (relative to bin_window). - The y position to be identified (relative to bin_window). + The y position to be identified (relative to bin_window). - - A pointer to a #GtkTreePath + + A pointer to a #GtkTreePath pointer to be filled in, or %NULL - - A pointer to + + A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL - - A pointer where the X coordinate + + A pointer where the X coordinate relative to the cell can be placed, or %NULL - - A pointer where the Y coordinate + + A pointer where the Y coordinate relative to the cell can be placed, or %NULL - - Retrieves whether the user can reorder the tree via drag-and-drop. See + + Retrieves whether the user can reorder the tree via drag-and-drop. See gtk_tree_view_set_reorderable(). - %TRUE if the tree can be reordered. + %TRUE if the tree can be reordered. - a #GtkTreeView + a #GtkTreeView - - Returns the current row separator function. + + Returns the current row separator function. - the current row separator function. - + the current row separator function. + - a #GtkTreeView + a #GtkTreeView - - Returns whether rubber banding is turned on for @tree_view. If the + + Returns whether rubber banding is turned on for @tree_view. If the selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse. - %TRUE if rubber banding in @tree_view is enabled. + %TRUE if rubber banding in @tree_view is enabled. - a #GtkTreeView + a #GtkTreeView - - Gets the setting set by gtk_tree_view_set_rules_hint(). + + Gets the setting set by gtk_tree_view_set_rules_hint(). - %TRUE if the hint is set + %TRUE if the hint is set - a #GtkTreeView + a #GtkTreeView - - Gets the column searched on by the interactive search code. + + Gets the column searched on by the interactive search code. - the column the interactive search code searches in. + the column the interactive search code searches in. - A #GtkTreeView + A #GtkTreeView - - Returns the #GtkEntry which is currently in use as interactive search + + Returns the #GtkEntry which is currently in use as interactive search entry for @tree_view. In case the built-in entry is being used, %NULL will be returned. - the entry currently in use as search entry. + the entry currently in use as search entry. - A #GtkTreeView + A #GtkTreeView - - Returns the compare function currently in use. + + Returns the compare function currently in use. - the currently used compare function for the search code. - + the currently used compare function for the search code. + - A #GtkTreeView + A #GtkTreeView - - Returns the positioning function currently in use. + + Returns the positioning function currently in use. - the currently used function for positioning the search dialog. - + the currently used function for positioning the search dialog. + - A #GtkTreeView + A #GtkTreeView - Gets the #GtkTreeSelection associated with @tree_view. + Gets the #GtkTreeSelection associated with @tree_view. - A #GtkTreeSelection object. + A #GtkTreeSelection object. - A #GtkTreeView. + A #GtkTreeView. - - Returns whether or not expanders are drawn in @tree_view. + + Returns whether or not expanders are drawn in @tree_view. - %TRUE if expanders are drawn in @tree_view, %FALSE + %TRUE if expanders are drawn in @tree_view, %FALSE otherwise. - a #GtkTreeView. + a #GtkTreeView. - - Returns the column of @tree_view’s model which is being used for -displaying tooltips on @tree_view’s rows. + + Returns the column of @tree_view’s model which is being used for +displaying tooltips on @tree_view’s rows. - the index of the tooltip column that is currently being + the index of the tooltip column that is currently being used, or -1 if this is disabled. - a #GtkTreeView + a #GtkTreeView - - This function is supposed to be used in a #GtkWidget::query-tooltip + + This function is supposed to be used in a #GtkWidget::query-tooltip signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values which are received in the signal handler, should be passed to this function without modification. @@ -179115,160 +128185,88 @@ coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard tooltips the row returned will be the cursor row. When %TRUE, then any of @model, @path and @iter which have been provided will be set to point to that row and the corresponding model. @x and @y will always be converted -to be relative to @tree_view’s bin_window if @keyboard_tooltip is %FALSE. +to be relative to @tree_view’s bin_window if @keyboard_tooltip is %FALSE. - whether or not the given tooltip context points to a row. + whether or not the given tooltip context points to a row. - a #GtkTreeView + a #GtkTreeView - - the x coordinate (relative to widget coordinates) + + the x coordinate (relative to widget coordinates) - - the y coordinate (relative to widget coordinates) + + the y coordinate (relative to widget coordinates) - whether this is a keyboard tooltip or not + whether this is a keyboard tooltip or not - - a pointer to + + a pointer to receive a #GtkTreeModel or %NULL - - a pointer to receive a #GtkTreePath or %NULL + + a pointer to receive a #GtkTreePath or %NULL - - a pointer to receive a #GtkTreeIter or %NULL + + a pointer to receive a #GtkTreeIter or %NULL - - Gets the #GtkAdjustment currently being used for the vertical aspect. + + Gets the #GtkAdjustment currently being used for the vertical aspect. Use gtk_scrollable_get_vadjustment() - A #GtkAdjustment object, or %NULL + A #GtkAdjustment object, or %NULL if none is currently being used. - A #GtkTreeView + A #GtkTreeView - - Sets @start_path and @end_path to be the first and last visible path. + + Sets @start_path and @end_path to be the first and last visible path. Note that there may be invisible paths in between. The paths should be freed with gtk_tree_path_free() after use. - %TRUE, if valid paths were placed in @start_path and @end_path. + %TRUE, if valid paths were placed in @start_path and @end_path. - A #GtkTreeView + A #GtkTreeView - - Return location for start of region, + + Return location for start of region, or %NULL. - - Return location for end of region, or %NULL. + + Return location for end of region, or %NULL. - - Fills @visible_rect with the currently-visible region of the + + Fills @visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with gtk_tree_view_convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire @@ -179279,182 +128277,119 @@ scrollable area of the tree. - a #GtkTreeView + a #GtkTreeView - - rectangle to fill + + rectangle to fill - This inserts the @column into the @tree_view at @position. If @position is + This inserts the @column into the @tree_view at @position. If @position is -1, then the column is inserted at the end. If @tree_view has -“fixed_height” mode enabled, then @column must have its “sizing” property +“fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. - The number of columns in @tree_view after insertion. + The number of columns in @tree_view after insertion. - A #GtkTreeView. + A #GtkTreeView. - The #GtkTreeViewColumn to be inserted. + The #GtkTreeViewColumn to be inserted. - The position to insert @column in. + The position to insert @column in. - - Creates a new #GtkTreeViewColumn and inserts it into the @tree_view at + + Creates a new #GtkTreeViewColumn and inserts it into the @tree_view at @position. If @position is -1, then the newly created column is inserted at the end. The column is initialized with the attributes given. If @tree_view -has “fixed_height” mode enabled, then the new column will have its sizing +has “fixed_height” mode enabled, then the new column will have its sizing property set to be GTK_TREE_VIEW_COLUMN_FIXED. - The number of columns in @tree_view after insertion. + The number of columns in @tree_view after insertion. - A #GtkTreeView + A #GtkTreeView - The position to insert the new column in + The position to insert the new column in - The title to set the header to + The title to set the header to - The #GtkCellRenderer + The #GtkCellRenderer - A %NULL-terminated list of attributes + A %NULL-terminated list of attributes - - Convenience function that inserts a new column into the #GtkTreeView + + Convenience function that inserts a new column into the #GtkTreeView with the given cell renderer and a #GtkTreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). -If @tree_view has “fixed_height” mode enabled, then the new column will have its -“sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. +If @tree_view has “fixed_height” mode enabled, then the new column will have its +“sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. - number of columns in the tree view post-insert + number of columns in the tree view post-insert - a #GtkTreeView + a #GtkTreeView - Position to insert, -1 for append + Position to insert, -1 for append - column title + column title - cell renderer for column + cell renderer for column - - function to set attributes of cell renderer + + function to set attributes of cell renderer - - data for @func + + data for @func - destroy notifier for @data + destroy notifier for @data - - Determine whether the point (@x, @y) in @tree_view is blank, that is no + + Determine whether the point (@x, @y) in @tree_view is blank, that is no cell content nor an expander arrow is drawn at the location. If so, the location can be considered as the background. You might wish to take special action on clicks on the background, such as clearing a current @@ -179473,148 +128408,84 @@ likewise as for gtk_tree_view_get_path_at_pos(). Please see gtk_tree_view_get_path_at_pos() for more information. - %TRUE if the area at the given coordinates is blank, + %TRUE if the area at the given coordinates is blank, %FALSE otherwise. - A #GtkTreeView + A #GtkTreeView - The x position to be identified (relative to bin_window) + The x position to be identified (relative to bin_window) - The y position to be identified (relative to bin_window) + The y position to be identified (relative to bin_window) - - A pointer to a #GtkTreePath pointer to + + A pointer to a #GtkTreePath pointer to be filled in, or %NULL - - A pointer to a + + A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL - - A pointer where the X coordinate relative to the + + A pointer where the X coordinate relative to the cell can be placed, or %NULL - - A pointer where the Y coordinate relative to the + + A pointer where the Y coordinate relative to the cell can be placed, or %NULL - - Returns whether a rubber banding operation is currently being done + + Returns whether a rubber banding operation is currently being done in @tree_view. - %TRUE if a rubber banding operation is currently being + %TRUE if a rubber banding operation is currently being done in @tree_view. - a #GtkTreeView + a #GtkTreeView - - Calls @func on all expanded rows. + + Calls @func on all expanded rows. - A #GtkTreeView + A #GtkTreeView - - A function to be called + + A function to be called - - User data to be passed to the function. + + User data to be passed to the function. - - Moves @column to be after to @base_column. If @base_column is %NULL, then + + Moves @column to be after to @base_column. If @base_column is %NULL, then @column is placed in the first position. @@ -179622,114 +128493,78 @@ done in @tree_view. - A #GtkTreeView + A #GtkTreeView - The #GtkTreeViewColumn to be moved. + The #GtkTreeViewColumn to be moved. - - The #GtkTreeViewColumn to be moved relative to, or %NULL. + + The #GtkTreeViewColumn to be moved relative to, or %NULL. - Removes @column from @tree_view. + Removes @column from @tree_view. - The number of columns in @tree_view after removing. + The number of columns in @tree_view after removing. - A #GtkTreeView. + A #GtkTreeView. - The #GtkTreeViewColumn to remove. + The #GtkTreeViewColumn to remove. - Activates the cell determined by @path and @column. + Activates the cell determined by @path and @column. - A #GtkTreeView + A #GtkTreeView - The #GtkTreePath to be activated. + The #GtkTreePath to be activated. - The #GtkTreeViewColumn to be activated. + The #GtkTreeViewColumn to be activated. - Returns %TRUE if the node pointed to by @path is expanded in @tree_view. + Returns %TRUE if the node pointed to by @path is expanded in @tree_view. - %TRUE if #path is expanded. + %TRUE if #path is expanded. - A #GtkTreeView. + A #GtkTreeView. - A #GtkTreePath to test expansion state. + A #GtkTreePath to test expansion state. - - Moves the alignments of @tree_view to the position specified by @column and + + Moves the alignments of @tree_view to the position specified by @column and @path. If @column is %NULL, then no horizontal scrolling occurs. Likewise, if @path is %NULL no vertical scrolling occurs. At a minimum, one of @column or @path need to be non-%NULL. @row_align determines where the row is @@ -179751,91 +128586,60 @@ path will be modified to reflect this change. - A #GtkTreeView. + A #GtkTreeView. - - The path of the row to move to, or %NULL. + + The path of the row to move to, or %NULL. - - The #GtkTreeViewColumn to move horizontally to, or %NULL. + + The #GtkTreeViewColumn to move horizontally to, or %NULL. - whether to use alignment arguments, or %FALSE. + whether to use alignment arguments, or %FALSE. - The vertical alignment of the row specified by @path. + The vertical alignment of the row specified by @path. - The horizontal alignment of the column specified by @column. + The horizontal alignment of the column specified by @column. - - Scrolls the tree view such that the top-left corner of the visible + + Scrolls the tree view such that the top-left corner of the visible area is @tree_x, @tree_y, where @tree_x and @tree_y are specified in tree coordinates. The @tree_view must be realized before this function is called. If it isn't, you probably want to be using gtk_tree_view_scroll_to_cell(). -If either @tree_x or @tree_y are -1, then that direction isn’t scrolled. +If either @tree_x or @tree_y are -1, then that direction isn’t scrolled. - a #GtkTreeView + a #GtkTreeView - X coordinate of new top-left pixel of visible area, or -1 + X coordinate of new top-left pixel of visible area, or -1 - Y coordinate of new top-left pixel of visible area, or -1 + Y coordinate of new top-left pixel of visible area, or -1 - - Cause the #GtkTreeView::row-activated signal to be emitted + + Cause the #GtkTreeView::row-activated signal to be emitted on a single click instead of a double click. @@ -179843,24 +128647,17 @@ on a single click instead of a double click. - a #GtkTreeView + a #GtkTreeView - %TRUE to emit row-activated on a single click + %TRUE to emit row-activated on a single click - - Sets a user function for determining where a column may be dropped when + + Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to @func are: the @tree_view, the #GtkTreeViewColumn being @@ -179875,50 +128672,26 @@ dropped everywhere. - A #GtkTreeView. + A #GtkTreeView. - - A function to determine which columns are reorderable, or %NULL. - + + A function to determine which columns are reorderable, or %NULL. + - - User data to be passed to @func, or %NULL + + User data to be passed to @func, or %NULL - - Destroy notifier for @user_data, or %NULL + + Destroy notifier for @user_data, or %NULL - Sets the current keyboard focus to be at @path, and selects it. This is -useful when you want to focus the user’s attention on a particular row. If + Sets the current keyboard focus to be at @path, and selects it. This is +useful when you want to focus the user’s attention on a particular row. If @focus_column is not %NULL, then focus is given to the column specified by it. Additionally, if @focus_column is specified, and @start_editing is %TRUE, then editing should be started in the specified cell. @@ -179934,41 +128707,26 @@ and the function will return without failing. - A #GtkTreeView + A #GtkTreeView - A #GtkTreePath + A #GtkTreePath - - A #GtkTreeViewColumn, or %NULL + + A #GtkTreeViewColumn, or %NULL - %TRUE if the specified cell should start being edited. + %TRUE if the specified cell should start being edited. - - Sets the current keyboard focus to be at @path, and selects it. This is -useful when you want to focus the user’s attention on a particular row. If + + Sets the current keyboard focus to be at @path, and selects it. This is +useful when you want to focus the user’s attention on a particular row. If @focus_column is not %NULL, then focus is given to the column specified by it. If @focus_column and @focus_cell are not %NULL, and @focus_column contains 2 or more editable or activatable cells, then focus is given to @@ -179987,50 +128745,29 @@ and the function will return without failing. - A #GtkTreeView + A #GtkTreeView - A #GtkTreePath + A #GtkTreePath - - A #GtkTreeViewColumn, or %NULL + + A #GtkTreeViewColumn, or %NULL - - A #GtkCellRenderer, or %NULL + + A #GtkCellRenderer, or %NULL - %TRUE if the specified cell should start being edited. + %TRUE if the specified cell should start being edited. - - This function should almost never be used. It is meant for private use by + + This function should almost never be used. It is meant for private use by ATK for determining the number of visible children that are removed when the user collapses a row, or a row is deleted. Accessibility does not need the function anymore. @@ -180040,50 +128777,25 @@ user collapses a row, or a row is deleted. - A #GtkTreeView + A #GtkTreeView - - Function to be called when a view row is destroyed, or %NULL - + + Function to be called when a view row is destroyed, or %NULL + - - User data to be passed to @func, or %NULL + + User data to be passed to @func, or %NULL - - Destroy notifier for @data, or %NULL + + Destroy notifier for @data, or %NULL - - Sets the row that is highlighted for feedback. + + Sets the row that is highlighted for feedback. If @path is %NULL, an existing highlight is removed. @@ -180091,63 +128803,42 @@ If @path is %NULL, an existing highlight is removed. - a #GtkTreeView + a #GtkTreeView - - The path of the row to highlight, or %NULL + + The path of the row to highlight, or %NULL - Specifies whether to drop before, after or into the row - + Specifies whether to drop before, after or into the row + - - If @enable_search is set, then the user can type in text to search through + + If @enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find"). Note that even if this is %FALSE, the user can still initiate a search -using the “start-interactive-search” key binding. +using the “start-interactive-search” key binding. - A #GtkTreeView + A #GtkTreeView - %TRUE, if the user can search interactively + %TRUE, if the user can search interactively - - Sets whether to draw lines interconnecting the expanders in @tree_view. + + Sets whether to draw lines interconnecting the expanders in @tree_view. This does not have any visible effects for lists. @@ -180155,24 +128846,17 @@ This does not have any visible effects for lists. - a #GtkTreeView + a #GtkTreeView - %TRUE to enable tree line drawing, %FALSE otherwise. + %TRUE to enable tree line drawing, %FALSE otherwise. - - Sets the column to draw the expander arrow at. It must be in @tree_view. + + Sets the column to draw the expander arrow at. It must be in @tree_view. If @column is %NULL, then the expander arrow is always at the first visible column. @@ -180184,28 +128868,17 @@ expander column to a hidden column. - A #GtkTreeView + A #GtkTreeView - - %NULL, or the column to draw the expander arrow at. + + %NULL, or the column to draw the expander arrow at. - - Enables or disables the fixed height mode of @tree_view. + + Enables or disables the fixed height mode of @tree_view. Fixed height mode speeds up #GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all @@ -180216,52 +128889,35 @@ columns are of type %GTK_TREE_VIEW_COLUMN_FIXED. - a #GtkTreeView + a #GtkTreeView - %TRUE to enable fixed height mode + %TRUE to enable fixed height mode - - Sets which grid lines to draw in @tree_view. + + Sets which grid lines to draw in @tree_view. - a #GtkTreeView + a #GtkTreeView - a #GtkTreeViewGridLines value indicating which grid lines to + a #GtkTreeViewGridLines value indicating which grid lines to enable. - - Sets the #GtkAdjustment for the current horizontal aspect. + + Sets the #GtkAdjustment for the current horizontal aspect. Use gtk_scrollable_set_hadjustment() @@ -180269,76 +128925,51 @@ enable. - A #GtkTreeView + A #GtkTreeView - - The #GtkAdjustment to set, or %NULL + + The #GtkAdjustment to set, or %NULL - - Allow the column title buttons to be clicked. + + Allow the column title buttons to be clicked. - A #GtkTreeView. + A #GtkTreeView. - %TRUE if the columns are clickable. + %TRUE if the columns are clickable. - - Sets the visibility state of the headers. + + Sets the visibility state of the headers. - A #GtkTreeView. + A #GtkTreeView. - %TRUE if the headers are visible + %TRUE if the headers are visible - - Enables or disables the hover expansion mode of @tree_view. + + Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them. @@ -180347,25 +128978,17 @@ moves over them. - a #GtkTreeView + a #GtkTreeView - %TRUE to enable hover selection mode + %TRUE to enable hover selection mode - - Enables or disables the hover selection mode of @tree_view. + + Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE. @@ -180375,25 +128998,17 @@ Currently, this works only for the selection modes - a #GtkTreeView + a #GtkTreeView - %TRUE to enable hover selection mode + %TRUE to enable hover selection mode - - Sets the amount of extra indentation for child levels to use in @tree_view + + Sets the amount of extra indentation for child levels to use in @tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. @@ -180404,23 +129019,17 @@ This does not have any visible effects for lists. - a #GtkTreeView + a #GtkTreeView - the amount, in pixels, of extra indentation in @tree_view. + the amount, in pixels, of extra indentation in @tree_view. - Sets the model for a #GtkTreeView. If the @tree_view already has a model + Sets the model for a #GtkTreeView. If the @tree_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model. @@ -180429,32 +129038,22 @@ then it will unset the old model. - A #GtkTreeView. + A #GtkTreeView. - - The model. + + The model. - - This function is a convenience function to allow you to reorder + + This function is a convenience function to allow you to reorder models that support the #GtkTreeDragSourceIface and the #GtkTreeDragDestIface. Both #GtkTreeStore and #GtkListStore support these. If @reorderable is %TRUE, then the user can reorder the model by dragging and dropping rows. The developer can listen to -these changes by connecting to the model’s #GtkTreeModel::row-inserted +these changes by connecting to the model’s #GtkTreeModel::row-inserted and #GtkTreeModel::row-deleted signals. The reordering is implemented by setting up the tree view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any @@ -180469,25 +129068,17 @@ handle drag and drop manually. - A #GtkTreeView. + A #GtkTreeView. - %TRUE, if the tree can be reordered. + %TRUE, if the tree can be reordered. - - Sets the row separator function, which is used to determine + + Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is %NULL, no separators are drawn. This is the default value. @@ -180496,51 +129087,25 @@ function is %NULL, no separators are drawn. This is the default value. - a #GtkTreeView + a #GtkTreeView - - a #GtkTreeViewRowSeparatorFunc - + + a #GtkTreeViewRowSeparatorFunc + - - user data to pass to @func, or %NULL + + user data to pass to @func, or %NULL - - destroy notifier for @data, or %NULL + + destroy notifier for @data, or %NULL - - Enables or disables rubber banding in @tree_view. If the selection mode + + Enables or disables rubber banding in @tree_view. If the selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse. @@ -180549,26 +129114,17 @@ multiple rows by dragging the mouse. - a #GtkTreeView + a #GtkTreeView - %TRUE to enable rubber banding + %TRUE to enable rubber banding - - Sets a hint for the theme to draw even/odd rows in the @tree_view + + Sets a hint for the theme to draw even/odd rows in the @tree_view with different colors, also known as "zebra striping". This function tells the GTK+ theme that the user interface for your @@ -180576,7 +129132,7 @@ application requires users to read across tree rows and associate cells with one another. Do not use it just because you prefer the appearance of the ruled -tree; that’s a question for the theme. Some themes will draw tree +tree; that’s a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to @@ -180589,27 +129145,20 @@ generally). - a #GtkTreeView + a #GtkTreeView - %TRUE if the tree requires reading across rows + %TRUE if the tree requires reading across rows - - Sets @column as the column where the interactive search code should + + Sets @column as the column where the interactive search code should search in for the current model. -If the search column is set, users can use the “start-interactive-search” +If the search column is set, users can use the “start-interactive-search” key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search. @@ -180621,25 +129170,17 @@ column is reset to -1 when the model is changed. - A #GtkTreeView + A #GtkTreeView - the column of the model to search in, or -1 to disable searching + the column of the model to search in, or -1 to disable searching - - Sets the entry which the interactive search code will use for this + + Sets the entry which the interactive search code will use for this @tree_view. This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing %NULL for @entry will make the interactive search code use the built-in popup @@ -180650,27 +129191,17 @@ entry again. - A #GtkTreeView + A #GtkTreeView - - the entry the interactive search code of @tree_view should use or %NULL + + the entry the interactive search code of @tree_view should use or %NULL - - Sets the compare function for the interactive search capabilities; note + + Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality #GtkTreeViewSearchEqualFunc returns %FALSE on matches. @@ -180679,101 +129210,51 @@ that somewhat like strcmp() returning 0 for equality - A #GtkTreeView + A #GtkTreeView - - the compare function to use during the search - + + the compare function to use during the search + - - user data to pass to @search_equal_func, or %NULL + + user data to pass to @search_equal_func, or %NULL - - Destroy notifier for @search_user_data, or %NULL + + Destroy notifier for @search_user_data, or %NULL - - Sets the function to use when positioning the search dialog. + + Sets the function to use when positioning the search dialog. - A #GtkTreeView + A #GtkTreeView - - the function to use to position the search dialog, or %NULL + + the function to use to position the search dialog, or %NULL to use the default search position function - + - - user data to pass to @func, or %NULL + + user data to pass to @func, or %NULL - - Destroy notifier for @data, or %NULL + + Destroy notifier for @data, or %NULL - - Sets whether to draw and enable expanders and indent child rows in + + Sets whether to draw and enable expanders and indent child rows in @tree_view. When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You @@ -180786,25 +129267,17 @@ This does not have any visible effects for lists. - a #GtkTreeView + a #GtkTreeView - %TRUE to enable expander drawing, %FALSE otherwise. + %TRUE to enable expander drawing, %FALSE otherwise. - - Sets the tip area of @tooltip to the area @path, @column and @cell have + + Sets the tip area of @tooltip to the area @path, @column and @cell have in common. For example if @path is %NULL and @column is set, the tip area will be set to the full area covered by @column. See also gtk_tooltip_set_tip_area(). @@ -180821,54 +129294,31 @@ See also gtk_tree_view_set_tooltip_column() for a simpler alternative. - a #GtkTreeView + a #GtkTreeView - a #GtkTooltip + a #GtkTooltip - - a #GtkTreePath or %NULL + + a #GtkTreePath or %NULL - - a #GtkTreeViewColumn or %NULL + + a #GtkTreeViewColumn or %NULL - - a #GtkCellRenderer or %NULL + + a #GtkCellRenderer or %NULL - - If you only plan to have simple (text-only) tooltips on full rows, you + + If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have #GtkTreeView handle these automatically -for you. @column should be set to the column in @tree_view’s model +for you. @column should be set to the column in @tree_view’s model containing the tooltip texts, or -1 to disable this feature. When enabled, #GtkWidget:has-tooltip will be set to %TRUE and @@ -180882,25 +129332,17 @@ so &, <, etc have to be escaped in the text. - a #GtkTreeView + a #GtkTreeView - an integer, which is a valid column number for @tree_view’s model + an integer, which is a valid column number for @tree_view’s model - - Sets the tip area of @tooltip to be the area covered by the row at @path. + + Sets the tip area of @tooltip to be the area covered by the row at @path. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area(). @@ -180909,32 +129351,21 @@ See also gtk_tooltip_set_tip_area(). - a #GtkTreeView + a #GtkTreeView - a #GtkTooltip + a #GtkTooltip - a #GtkTreePath + a #GtkTreePath - - Sets the #GtkAdjustment for the current vertical aspect. + + Sets the #GtkAdjustment for the current vertical aspect. Use gtk_scrollable_set_vadjustment() @@ -180942,27 +129373,17 @@ See also gtk_tooltip_set_tip_area(). - A #GtkTreeView + A #GtkTreeView - - The #GtkAdjustment to set, or %NULL + + The #GtkAdjustment to set, or %NULL - - Undoes the effect of + + Undoes the effect of gtk_tree_view_enable_model_drag_dest(). Calling this method sets #GtkTreeView:reorderable to %FALSE. @@ -180971,18 +129392,13 @@ gtk_tree_view_enable_model_drag_dest(). Calling this method sets - a #GtkTreeView + a #GtkTreeView - - Undoes the effect of + + Undoes the effect of gtk_tree_view_enable_model_drag_source(). Calling this method sets #GtkTreeView:reorderable to %FALSE. @@ -180991,67 +129407,44 @@ gtk_tree_view_enable_model_drag_source(). Calling this method sets - a #GtkTreeView + a #GtkTreeView - - The activate-on-single-click property specifies whether the "row-activated" signal + + The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click. - + - + - - Setting the ::fixed-height-mode property to %TRUE speeds up + + Setting the ::fixed-height-mode property to %TRUE speeds up #GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtk_tree_view_set_fixed_height_mode() for more information on this option. - + - - Enables or disables the hover expansion mode of @tree_view. + + Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them. @@ -181059,13 +129452,8 @@ This mode is primarily intended for treeviews in popups, e.g. in #GtkComboBox or #GtkEntryCompletion. - - Enables or disables the hover selection mode of @tree_view. + + Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE. @@ -181074,13 +129462,8 @@ This mode is primarily intended for treeviews in popups, e.g. in #GtkComboBox or #GtkEntryCompletion. - - Extra indentation for each level. + + Extra indentation for each level. @@ -181092,14 +129475,8 @@ in #GtkComboBox or #GtkEntryCompletion. - - Sets a hint to the theme to draw rows in alternating colors. + + Sets a hint to the theme to draw rows in alternating colors. The theme is responsible for drawing rows using zebra striping @@ -181107,13 +129484,8 @@ in #GtkComboBox or #GtkEntryCompletion. - - %TRUE if the view has expanders. + + %TRUE if the view has expanders. @@ -181126,17 +129498,13 @@ in #GtkComboBox or #GtkEntryCompletion. - The number of columns of the treeview has changed. + The number of columns of the treeview has changed. - The position of the cursor (focused cell) has changed. + The position of the cursor (focused cell) has changed. @@ -181158,9 +129526,7 @@ in #GtkComboBox or #GtkEntryCompletion. - The #GtkTreeView::move-cursor signal is a [keybinding + The #GtkTreeView::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user presses one of the cursor keys. @@ -181170,16 +129536,12 @@ programmatically. In contrast to gtk_tree_view_set_cursor() and gtk_tree_view_set_cursor_on_cell() when moving horizontally #GtkTreeView::move-cursor does not reset the current selection. - %TRUE if @step is supported, %FALSE otherwise. + %TRUE if @step is supported, %FALSE otherwise. - the granularity of the move, as a + the granularity of the move, as a #GtkMovementStep. %GTK_MOVEMENT_LOGICAL_POSITIONS, %GTK_MOVEMENT_VISUAL_POSITIONS, %GTK_MOVEMENT_DISPLAY_LINES, %GTK_MOVEMENT_PAGES and %GTK_MOVEMENT_BUFFER_ENDS are @@ -181188,9 +129550,7 @@ supported. %GTK_MOVEMENT_LOGICAL_POSITIONS and - the direction to move: +1 to move forwards; + the direction to move: +1 to move forwards; -1 to move backwards. The resulting movement is undefined for all other values. @@ -181198,9 +129558,7 @@ undefined for all other values. - The "row-activated" signal is emitted when the method + The "row-activated" signal is emitted when the method gtk_tree_view_row_activated() is called, when the user double clicks a treeview row with the "activate-on-single-click" property set to %FALSE, or when the user single clicks a row when @@ -181216,59 +129574,43 @@ as well as #GtkTreeSelection. - the #GtkTreePath for the activated row + the #GtkTreePath for the activated row - the #GtkTreeViewColumn in which the activation occurred + the #GtkTreeViewColumn in which the activation occurred - The given row has been collapsed (child nodes are hidden). + The given row has been collapsed (child nodes are hidden). - the tree iter of the collapsed row + the tree iter of the collapsed row - a tree path that points to the row + a tree path that points to the row - The given row has been expanded (child nodes are shown). + The given row has been expanded (child nodes are shown). - the tree iter of the expanded row + the tree iter of the expanded row - a tree path that points to the row + a tree path that points to the row @@ -181299,53 +129641,37 @@ as well as #GtkTreeSelection. - The given row is about to be collapsed (hide its children nodes). Use this + The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows. - %FALSE to allow collapsing, %TRUE to reject + %FALSE to allow collapsing, %TRUE to reject - the tree iter of the row to collapse + the tree iter of the row to collapse - a tree path that points to the row + a tree path that points to the row - The given row is about to be expanded (show its children nodes). Use this + The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows. - %FALSE to allow expansion, %TRUE to reject + %FALSE to allow expansion, %TRUE to reject - the tree iter of the row to expand + the tree iter of the row to expand - a tree path that points to the row + a tree path that points to the row @@ -181361,13 +129687,7 @@ signal if you need to control the expandability of individual rows. - + @@ -181377,27 +129697,19 @@ signal if you need to control the expandability of individual rows. - + - + - + - + - + @@ -181410,21 +129722,15 @@ signal if you need to control the expandability of individual rows. - A #GtkTreeView + A #GtkTreeView - The #GtkTreePath to be activated. + The #GtkTreePath to be activated. - The #GtkTreeViewColumn to be activated. + The #GtkTreeViewColumn to be activated. @@ -181719,16 +130025,8 @@ signal if you need to control the expandability of individual rows. - - The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget. + + The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed. @@ -181739,50 +130037,34 @@ they work together. - Creates a new #GtkTreeViewColumn. + Creates a new #GtkTreeViewColumn. - A newly created #GtkTreeViewColumn. + A newly created #GtkTreeViewColumn. - - Creates a new #GtkTreeViewColumn using @area to render its cells. + + Creates a new #GtkTreeViewColumn using @area to render its cells. - A newly created #GtkTreeViewColumn. + A newly created #GtkTreeViewColumn. - the #GtkCellArea that the newly created column should use to layout cells. + the #GtkCellArea that the newly created column should use to layout cells. - - Creates a new #GtkTreeViewColumn with a number of default values. + + Creates a new #GtkTreeViewColumn with a number of default values. This is equivalent to calling gtk_tree_view_column_set_title(), gtk_tree_view_column_pack_start(), and gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn. -Here’s a simple example: +Here’s a simple example: |[<!-- language="C" --> enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS }; // ... @@ -181799,36 +130081,26 @@ Here’s a simple example: ]| - A newly created #GtkTreeViewColumn. + A newly created #GtkTreeViewColumn. - The title to set the header to + The title to set the header to - The #GtkCellRenderer + The #GtkCellRenderer - A %NULL-terminated list of attributes + A %NULL-terminated list of attributes - Emits the “clicked” signal on the column. This function will only work if + Emits the “clicked” signal on the column. This function will only work if @tree_column is clickable. @@ -181836,22 +130108,17 @@ Here’s a simple example: - a #GtkTreeViewColumn + a #GtkTreeViewColumn - - Adds an attribute mapping to the list in @tree_column. The @column is the + + Adds an attribute mapping to the list in @tree_column. The @column is the column of the model to get a value from, and the @attribute is the parameter on @cell_renderer to be set from the value. So for example if column 2 of the model contains strings, you could have the -“text” attribute of a #GtkCellRendererText get its values from +“text” attribute of a #GtkCellRendererText get its values from column 2. @@ -181859,89 +130126,55 @@ column 2. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - the #GtkCellRenderer to set attributes on + the #GtkCellRenderer to set attributes on - An attribute on the renderer + An attribute on the renderer - The column position on the model to get the attribute from. + The column position on the model to get the attribute from. - - Obtains the horizontal position and size of a cell in a column. If the + + Obtains the horizontal position and size of a cell in a column. If the cell is not found in the column, @start_pos and @width are not changed and %FALSE is returned. - %TRUE if @cell belongs to @tree_column. + %TRUE if @cell belongs to @tree_column. - a #GtkTreeViewColumn + a #GtkTreeViewColumn - a #GtkCellRenderer + a #GtkCellRenderer - - return location for the horizontal + + return location for the horizontal position of @cell within @tree_column, may be %NULL - - return location for the width of @cell, + + return location for the width of @cell, may be %NULL - - Obtains the width and height needed to render the column. This is used + + Obtains the width and height needed to render the column. This is used primarily by the #GtkTreeView. @@ -181949,94 +130182,49 @@ primarily by the #GtkTreeView. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - The area a cell in the column will be allocated, or %NULL + + The area a cell in the column will be allocated, or %NULL - - location to return x offset of a cell relative to @cell_area, or %NULL + + location to return x offset of a cell relative to @cell_area, or %NULL - - location to return y offset of a cell relative to @cell_area, or %NULL + + location to return y offset of a cell relative to @cell_area, or %NULL - - location to return width needed to render a cell, or %NULL + + location to return width needed to render a cell, or %NULL - - location to return height needed to render a cell, or %NULL + + location to return height needed to render a cell, or %NULL - - Returns %TRUE if any of the cells packed into the @tree_column are visible. + + Returns %TRUE if any of the cells packed into the @tree_column are visible. For this to be meaningful, you must first initialize the cells with gtk_tree_view_column_cell_set_cell_data() - %TRUE, if any of the cells packed into the @tree_column are currently visible + %TRUE, if any of the cells packed into the @tree_column are currently visible - A #GtkTreeViewColumn + A #GtkTreeViewColumn - - Sets the cell renderer based on the @tree_model and @iter. That is, for + + Sets the cell renderer based on the @tree_model and @iter. That is, for every attribute mapping in @tree_column, it will get a value from the set column on the @iter, and use that value to set the attribute on the cell renderer. This is used primarily by the #GtkTreeView. @@ -182046,59 +130234,42 @@ renderer. This is used primarily by the #GtkTreeView. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The #GtkTreeModel to to get the cell renderers attributes from. + The #GtkTreeModel to to get the cell renderers attributes from. - The #GtkTreeIter to to get the cell renderer’s attributes from. + The #GtkTreeIter to to get the cell renderer’s attributes from. - %TRUE, if the row has children + %TRUE, if the row has children - %TRUE, if the row has visible children + %TRUE, if the row has visible children - Unsets all the mappings on all renderers on the @tree_column. + Unsets all the mappings on all renderers on the @tree_column. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - - Clears all existing attributes previously set with + + Clears all existing attributes previously set with gtk_tree_view_column_set_attributes(). @@ -182106,23 +130277,17 @@ gtk_tree_view_column_set_attributes(). - a #GtkTreeViewColumn + a #GtkTreeViewColumn - a #GtkCellRenderer to clear the attribute mapping on. + a #GtkCellRenderer to clear the attribute mapping on. - Emits the “clicked” signal on the column. This function will only work if + Emits the “clicked” signal on the column. This function will only work if @tree_column is clickable. @@ -182130,19 +130295,13 @@ gtk_tree_view_column_set_attributes(). - a #GtkTreeViewColumn + a #GtkTreeViewColumn - - Sets the current keyboard focus to be at @cell, if the column contains + + Sets the current keyboard focus to be at @cell, if the column contains 2 or more editable and activatable cells. @@ -182150,457 +130309,311 @@ gtk_tree_view_column_set_attributes(). - A #GtkTreeViewColumn + A #GtkTreeViewColumn - A #GtkCellRenderer + A #GtkCellRenderer - - Returns the current x alignment of @tree_column. This value can range + + Returns the current x alignment of @tree_column. This value can range between 0.0 and 1.0. - The current alignent of @tree_column. + The current alignent of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Returns the button used in the treeview column header + + Returns the button used in the treeview column header - The button for the column header. + The button for the column header. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - - Returns %TRUE if the user can click on the header for the column. + + Returns %TRUE if the user can click on the header for the column. - %TRUE if user can click the column header. + %TRUE if user can click the column header. - a #GtkTreeViewColumn + a #GtkTreeViewColumn - - Returns %TRUE if the column expands to fill available space. + + Returns %TRUE if the column expands to fill available space. - %TRUE if the column expands to fill available space. + %TRUE if the column expands to fill available space. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Gets the fixed width of the column. This may not be the actual displayed + + Gets the fixed width of the column. This may not be the actual displayed width of the column; for that, use gtk_tree_view_column_get_width(). - The fixed width of the column. + The fixed width of the column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Returns the maximum width in pixels of the @tree_column, or -1 if no maximum + + Returns the maximum width in pixels of the @tree_column, or -1 if no maximum width is set. - The maximum width of the @tree_column. + The maximum width of the @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Returns the minimum width in pixels of the @tree_column, or -1 if no minimum + + Returns the minimum width in pixels of the @tree_column, or -1 if no minimum width is set. - The minimum width of the @tree_column. + The minimum width of the @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Returns %TRUE if the @tree_column can be reordered by the user. + + Returns %TRUE if the @tree_column can be reordered by the user. - %TRUE if the @tree_column can be reordered by the user. + %TRUE if the @tree_column can be reordered by the user. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - - Returns %TRUE if the @tree_column can be resized by the end user. + + Returns %TRUE if the @tree_column can be resized by the end user. - %TRUE, if the @tree_column can be resized. + %TRUE, if the @tree_column can be resized. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - Returns the current type of @tree_column. + Returns the current type of @tree_column. - The type of @tree_column. + The type of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Gets the logical @sort_column_id that the model sorts on when this + + Gets the logical @sort_column_id that the model sorts on when this column is selected for sorting. See gtk_tree_view_column_set_sort_column_id(). - the current @sort_column_id for this column, or -1 if - this column can’t be used for sorting. + the current @sort_column_id for this column, or -1 if + this column can’t be used for sorting. - a #GtkTreeViewColumn + a #GtkTreeViewColumn - - Gets the value set by gtk_tree_view_column_set_sort_indicator(). + + Gets the value set by gtk_tree_view_column_set_sort_indicator(). - whether the sort indicator arrow is displayed + whether the sort indicator arrow is displayed - a #GtkTreeViewColumn + a #GtkTreeViewColumn - - Gets the value set by gtk_tree_view_column_set_sort_order(). + + Gets the value set by gtk_tree_view_column_set_sort_order(). - the sort order the sort indicator is indicating + the sort order the sort indicator is indicating - a #GtkTreeViewColumn + a #GtkTreeViewColumn - - Returns the spacing of @tree_column. + + Returns the spacing of @tree_column. - the spacing of @tree_column. + the spacing of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - Returns the title of the widget. + Returns the title of the widget. - the title of the column. This string should not be + the title of the column. This string should not be modified or freed. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Returns the #GtkTreeView wherein @tree_column has been inserted. + + Returns the #GtkTreeView wherein @tree_column has been inserted. If @column is currently not inserted in any tree view, %NULL is returned. - The tree view wherein @column has + The tree view wherein @column has been inserted if any, %NULL otherwise. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - - Returns %TRUE if @tree_column is visible. + + Returns %TRUE if @tree_column is visible. - whether the column is visible or not. If it is visible, then + whether the column is visible or not. If it is visible, then the tree will show the column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - Returns the #GtkWidget in the button on the column header. + Returns the #GtkWidget in the button on the column header. If a custom widget has not been set then %NULL is returned. - The #GtkWidget in the column + The #GtkWidget in the column header, or %NULL - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - Returns the current size of @tree_column in pixels. + Returns the current size of @tree_column in pixels. - The current width of @tree_column. + The current width of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - Returns the current X offset of @tree_column in pixels. + + Returns the current X offset of @tree_column in pixels. - The current X offset of @tree_column. + The current X offset of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - Adds the @cell to end of the column. If @expand is %FALSE, then the @cell + Adds the @cell to end of the column. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. @@ -182609,29 +130622,21 @@ evenly between cells for which @expand is %TRUE. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The #GtkCellRenderer. + The #GtkCellRenderer. - %TRUE if @cell is to be given extra space allocated to @tree_column. + %TRUE if @cell is to be given extra space allocated to @tree_column. - Packs the @cell into the beginning of the column. If @expand is %FALSE, then + Packs the @cell into the beginning of the column. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. @@ -182640,31 +130645,21 @@ evenly between cells for which @expand is %TRUE. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The #GtkCellRenderer. + The #GtkCellRenderer. - %TRUE if @cell is to be given extra space allocated to @tree_column. + %TRUE if @cell is to be given extra space allocated to @tree_column. - - Flags the column, and the cell renderers added to this column, to have + + Flags the column, and the cell renderers added to this column, to have their sizes renegotiated. @@ -182672,18 +130667,13 @@ their sizes renegotiated. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - - Sets the alignment of the title or custom widget inside the column header. + + Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right. @@ -182692,25 +130682,17 @@ for center, 1.0 for right. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The alignment, which is between [0.0 and 1.0] inclusive. + The alignment, which is between [0.0 and 1.0] inclusive. - - Sets the attributes in the list as the attributes of @tree_column. + + Sets the attributes in the list as the attributes of @tree_column. The attributes should be in attribute/column order, as in gtk_tree_view_column_add_attribute(). All existing attributes are removed, and replaced with the new attributes. @@ -182720,30 +130702,21 @@ are removed, and replaced with the new attributes. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - the #GtkCellRenderer we’re setting the attributes of + the #GtkCellRenderer we’re setting the attributes of - A %NULL-terminated list of attributes + A %NULL-terminated list of attributes - - Sets the #GtkTreeCellDataFunc to use for the column. This + + Sets the #GtkTreeCellDataFunc to use for the column. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of @tree_column's cell renderer as appropriate. @func may be %NULL to remove an @@ -182754,51 +130727,29 @@ older one. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - A #GtkCellRenderer + A #GtkCellRenderer - - The #GtkTreeCellDataFunc to use. + + The #GtkTreeCellDataFunc to use. - - The user data for @func. + + The user data for @func. - The destroy notification for @func_data + The destroy notification for @func_data - - Sets the header to be active if @clickable is %TRUE. When the header is + + Sets the header to be active if @clickable is %TRUE. When the header is active, then it can take keyboard focus, and can be clicked. @@ -182806,30 +130757,22 @@ active, then it can take keyboard focus, and can be clicked. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - %TRUE if the header is active. + %TRUE if the header is active. - - Sets the column to take available extra space. This space is shared equally + + Sets the column to take available extra space. This space is shared equally amongst all columns that have the expand set to %TRUE. If no column has this option set, then the last column gets all extra space. By default, every column is created with this %FALSE. -Along with “fixed-width”, the “expand” property changes when the column is +Along with “fixed-width”, the “expand” property changes when the column is resized by the user. @@ -182837,33 +130780,26 @@ resized by the user. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - %TRUE if the column should expand to fill available space. + %TRUE if the column should expand to fill available space. - - If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise + + If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise unsets it. The effective value of @fixed_width is clamped between the minimum and maximum width of the column; however, the value stored in the -“fixed-width” property is not clamped. If the column sizing is +“fixed-width” property is not clamped. If the column sizing is #GTK_TREE_VIEW_COLUMN_GROW_ONLY or #GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting a fixed width overrides the automatically calculated width. Note that @fixed_width is only a hint to GTK+; the width actually allocated to the column may be greater or less than requested. -Along with “expand”, the “fixed-width” property changes when the column is +Along with “expand”, the “fixed-width” property changes when the column is resized by the user. @@ -182871,26 +130807,19 @@ resized by the user. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The new fixed width, in pixels, or -1. + The new fixed width, in pixels, or -1. - - Sets the maximum width of the @tree_column. If @max_width is -1, then the + + Sets the maximum width of the @tree_column. If @max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max -width if it’s the last column in a view. In this case, the column expands to +width if it’s the last column in a view. In this case, the column expands to fill any extra space. @@ -182898,24 +130827,17 @@ fill any extra space. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The maximum width of the column in pixels, or -1. + The maximum width of the column in pixels, or -1. - - Sets the minimum width of the @tree_column. If @min_width is -1, then the + + Sets the minimum width of the @tree_column. If @min_width is -1, then the minimum width is unset. @@ -182923,24 +130845,17 @@ minimum width is unset. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The minimum width of the column in pixels, or -1. + The minimum width of the column in pixels, or -1. - - If @reorderable is %TRUE, then the column can be reordered by the end user + + If @reorderable is %TRUE, then the column can be reordered by the end user dragging the header. @@ -182948,24 +130863,17 @@ dragging the header. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - %TRUE, if the column can be reordered. + %TRUE, if the column can be reordered. - - If @resizable is %TRUE, then the user can explicitly resize the column by + + If @resizable is %TRUE, then the user can explicitly resize the column by grabbing the outer edge of the column button. If resizable is %TRUE and sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY. @@ -182975,48 +130883,34 @@ mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY. - A #GtkTreeViewColumn + A #GtkTreeViewColumn - %TRUE, if the column can be resized + %TRUE, if the column can be resized - Sets the growth behavior of @tree_column to @type. + Sets the growth behavior of @tree_column to @type. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The #GtkTreeViewColumnSizing. - + The #GtkTreeViewColumnSizing. + - - Sets the logical @sort_column_id that this column sorts on when this column + + Sets the logical @sort_column_id that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable. @@ -183024,24 +130918,17 @@ is selected for sorting. Doing so makes the column header clickable. - a #GtkTreeViewColumn + a #GtkTreeViewColumn - The @sort_column_id of the model to sort on. + The @sort_column_id of the model to sort on. - - Call this function with a @setting of %TRUE to display an arrow in + + Call this function with a @setting of %TRUE to display an arrow in the header button indicating the column is sorted. Call gtk_tree_view_column_set_sort_order() to change the direction of the arrow. @@ -183051,24 +130938,17 @@ the arrow. - a #GtkTreeViewColumn + a #GtkTreeViewColumn - %TRUE to display an indicator that the column is sorted + %TRUE to display an indicator that the column is sorted - - Changes the appearance of the sort indicator. + + Changes the appearance of the sort indicator. This does not actually sort the model. Use gtk_tree_view_column_set_sort_column_id() if you want automatic sorting @@ -183085,24 +130965,17 @@ calling this function; see gtk_tree_view_column_set_sort_indicator(). - a #GtkTreeViewColumn + a #GtkTreeViewColumn - sort order that the sort indicator should indicate + sort order that the sort indicator should indicate - - Sets the spacing field of @tree_column, which is the number of pixels to + + Sets the spacing field of @tree_column, which is the number of pixels to place between cell renderers packed into it. @@ -183110,23 +130983,17 @@ place between cell renderers packed into it. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - distance between cell renderers in pixels. + distance between cell renderers in pixels. - Sets the title of the @tree_column. If a custom widget has been set, then + Sets the title of the @tree_column. If a custom widget has been set, then this value is ignored. @@ -183134,47 +131001,34 @@ this value is ignored. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - The title of the @tree_column. + The title of the @tree_column. - - Sets the visibility of @tree_column. + + Sets the visibility of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - %TRUE if the @tree_column is visible. + %TRUE if the @tree_column is visible. - Sets the widget in the header to be @widget. If widget is %NULL, then the + Sets the widget in the header to be @widget. If widget is %NULL, then the header button is set with a #GtkLabel set to the title of @tree_column. @@ -183182,18 +131036,11 @@ header button is set with a #GtkLabel set to the title of @tree_column. - A #GtkTreeViewColumn. + A #GtkTreeViewColumn. - - A child #GtkWidget, or %NULL. + + A child #GtkWidget, or %NULL. @@ -183201,14 +131048,8 @@ header button is set with a #GtkLabel set to the title of @tree_column. - - The #GtkCellArea used to layout cell renderers for this column. + + The #GtkCellArea used to layout cell renderers for this column. If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area() a horizontally oriented #GtkCellAreaBox will be used. @@ -183238,13 +131079,8 @@ a horizontally oriented #GtkCellAreaBox will be used. - - Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header + + Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header clickable. Set to -1 to make the column unsortable. @@ -183284,13 +131120,10 @@ clickable. Set to -1 to make the column unsortable. - + - + @@ -183300,9 +131133,7 @@ clickable. Set to -1 to make the column unsortable. - a #GtkTreeViewColumn + a #GtkTreeViewColumn @@ -183342,9 +131173,7 @@ clickable. Set to -1 to make the column unsortable. - Function type for determining whether @column can be dropped in a + Function type for determining whether @column can be dropped in a particular spot (as determined by @prev_column and @next_column). In left to right locales, @prev_column is on the left of the potential drop spot, and @next_column is on the right. In right to left mode, this is @@ -183354,196 +131183,96 @@ the column drop was made, but is meant only to indicate a possible drop spot to the user. - %TRUE, if @column can be dropped in this spot + %TRUE, if @column can be dropped in this spot - A #GtkTreeView + A #GtkTreeView - The #GtkTreeViewColumn being dragged + The #GtkTreeViewColumn being dragged - A #GtkTreeViewColumn on one side of @column + A #GtkTreeViewColumn on one side of @column - A #GtkTreeViewColumn on the other side of @column + A #GtkTreeViewColumn on the other side of @column - - user data + + user data - + - - The sizing method the column uses to determine its width. Please note + + The sizing method the column uses to determine its width. Please note that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and can make columns appear choppy. - - Columns only get bigger in reaction to changes in the model + + Columns only get bigger in reaction to changes in the model - - Columns resize to be the optimal size everytime the model changes. + + Columns resize to be the optimal size everytime the model changes. - - Columns are a fixed numbers of pixels wide. + + Columns are a fixed numbers of pixels wide. - - An enum for determining where a dropped row goes. - - dropped row is inserted before + + An enum for determining where a dropped row goes. + + dropped row is inserted before - - dropped row is inserted after + + dropped row is inserted after - - dropped row becomes a child or is inserted before + + dropped row becomes a child or is inserted before - - dropped row becomes a child or is inserted after + + dropped row becomes a child or is inserted after - - Used to indicate which grid lines to draw in a tree view. - - No grid lines. + + Used to indicate which grid lines to draw in a tree view. + + No grid lines. - - Horizontal grid lines. + + Horizontal grid lines. - - Vertical grid lines. + + Vertical grid lines. - - Horizontal and vertical grid lines. + + Horizontal and vertical grid lines. - Function used for gtk_tree_view_map_expanded_rows(). + Function used for gtk_tree_view_map_expanded_rows(). - A #GtkTreeView + A #GtkTreeView - The path that’s expanded + The path that’s expanded - - user data + + user data @@ -183551,101 +131280,66 @@ can make columns appear choppy. - - Function type for determining whether the row pointed to by @iter should + + Function type for determining whether the row pointed to by @iter should be rendered as a separator. A common way to implement this is to have a boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc returns. - %TRUE if the row is a separator + %TRUE if the row is a separator - the #GtkTreeModel + the #GtkTreeModel - a #GtkTreeIter pointing at a row in @model + a #GtkTreeIter pointing at a row in @model - - user data + + user data - - A function used for checking whether a row in @model matches + + A function used for checking whether a row in @model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp() returning 0 for equal strings. - %FALSE if the row matches, %TRUE otherwise. + %FALSE if the row matches, %TRUE otherwise. - the #GtkTreeModel being searched + the #GtkTreeModel being searched - the search column set by gtk_tree_view_set_search_column() + the search column set by gtk_tree_view_set_search_column() - the key string to compare with + the key string to compare with - a #GtkTreeIter pointing the row of @model that should be compared + a #GtkTreeIter pointing the row of @model that should be compared with @key. - - user data from gtk_tree_view_set_search_equal_func() + + user data from gtk_tree_view_set_search_equal_func() - + @@ -183657,25 +131351,13 @@ has some similarity to strcmp() returning 0 for equal strings. - + - - > GtkUIManager is deprecated since GTK+ 3.10. To construct user interfaces + + > GtkUIManager is deprecated since GTK+ 3.10. To construct user interfaces > from XML definitions, you should use #GtkBuilder, #GMenuModel, et al. To > work with actions, use #GAction, #GtkActionable et al. These newer classes > support richer functionality and integration with various desktop shells. @@ -183738,9 +131420,9 @@ be valid XML, but valid markup. If a name is not specified, it defaults to the action. If an action is not specified either, the element name is used. The name and action -attributes must not contain “/” characters after parsing (since that +attributes must not contain “/” characters after parsing (since that would mess up path lookup) and must be usable as XML attributes when -enclosed in doublequotes, thus they must not “"” characters or references +enclosed in doublequotes, thus they must not “"” characters or references to the &quot; entity. # A UI definition # @@ -183812,9 +131494,9 @@ almost obvious: a keyboard accelerator -The “position” attribute determines where a constructed widget is positioned +The “position” attribute determines where a constructed widget is positioned wrt. to its siblings in the partially constructed tree. If it is -“top”, the widget is prepended, otherwise it is appended. +“top”, the widget is prepended, otherwise it is appended. # UI Merging # {#UI-Merging} @@ -183823,7 +131505,7 @@ of menuitems and toolitems over another one, and demerge them later. Merging is done based on the names of the XML elements. Each element is identified by a path which consists of the names of its anchestors, separated -by slashes. For example, the menuitem named “Left” in the example above +by slashes. For example, the menuitem named “Left” in the example above has the path `/ui/menubar/JustifyMenu/Left` and the toolitem with the same name has path `/ui/toolbar1/JustifyToolItems/Left`. @@ -183837,7 +131519,7 @@ have accelerators for actions even if they have no visible proxies. # Smart Separators # {#Smart-Separators} -The separators created by #GtkUIManager are “smart”, i.e. they do not show up +The separators created by #GtkUIManager are “smart”, i.e. they do not show up in the UI unless they end up between two visible menu or tool items. Separators which are located at the very beginning or end of the menu or toolbar containing them, or multiple separators next to each other, are hidden. This @@ -183855,11 +131537,11 @@ Submenus pose similar problems to separators inconnection with merging. It is impossible to know in advance whether they will end up empty after merging. #GtkUIManager offers two ways to treat empty submenus: -- make them disappear by hiding the menu item they’re attached to +- make them disappear by hiding the menu item they’re attached to -- add an insensitive “Empty” item +- add an insensitive “Empty” item -The behaviour is chosen based on the “hide_if_empty” property of the action +The behaviour is chosen based on the “hide_if_empty” property of the action to which the submenu is associated. # GtkUIManager as GtkBuildable # {#GtkUIManager-BUILDER-UI} @@ -183872,7 +131554,7 @@ an GtkUIManager <object> element in a GtkBuilder UI definition. The widgets that are constructed by a GtkUIManager can be embedded in other parts of the constructed user interface with the help of the -“constructor” attribute. See the example below. +“constructor” attribute. See the example below. ## An embedded GtkUIManager UI definition @@ -183902,19 +131584,11 @@ other parts of the constructed user interface with the help of the ]| - - Creates a new ui manager object. + + Creates a new ui manager object. - a new ui manager object. + a new ui manager object. @@ -183977,48 +131651,30 @@ other parts of the constructed user interface with the help of the - - Looks up an action by following a path. See gtk_ui_manager_get_widget() + + Looks up an action by following a path. See gtk_ui_manager_get_widget() for more information about paths. - the action whose proxy widget is found by following the path, + the action whose proxy widget is found by following the path, or %NULL if no widget was found. - a #GtkUIManager + a #GtkUIManager - a path + a path - - Looks up a widget by following a path. + + Looks up a widget by following a path. The path consists of the names specified in the XML description of the UI. -separated by “/”. Elements which don’t have a name or action attribute in +separated by “/”. Elements which don’t have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path. @@ -184032,23 +131688,17 @@ function to some container or explicitly ref them, they will survive the destruction of the ui manager. - the widget found by following the path, + the widget found by following the path, or %NULL if no widget was found - a #GtkUIManager + a #GtkUIManager - a path + a path @@ -184081,14 +131731,8 @@ destruction of the ui manager. - - Adds a UI element to the current contents of @manager. + + Adds a UI element to the current contents of @manager. If @type is %GTK_UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by @@ -184103,170 +131747,106 @@ before or after this item, depending on @top. - a #GtkUIManager + a #GtkUIManager - the merge id for the merged UI, see gtk_ui_manager_new_merge_id() + the merge id for the merged UI, see gtk_ui_manager_new_merge_id() - a path + a path - the name for the added UI element + the name for the added UI element - - the name of the action to be proxied, or %NULL to add a separator + + the name of the action to be proxied, or %NULL to add a separator - the type of UI element to add. + the type of UI element to add. - if %TRUE, the UI element is added before its siblings, otherwise it + if %TRUE, the UI element is added before its siblings, otherwise it is added after its siblings. - - Parses a file containing a [UI definition][XML-UI] and + + Parses a file containing a [UI definition][XML-UI] and merges it with the current contents of @manager. - The merge id for the merged UI. The merge id can be used + The merge id for the merged UI. The merge id can be used to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0. - a #GtkUIManager object + a #GtkUIManager object - the name of the file to parse + the name of the file to parse - - Parses a resource file containing a [UI definition][XML-UI] and + + Parses a resource file containing a [UI definition][XML-UI] and merges it with the current contents of @manager. - The merge id for the merged UI. The merge id can be used + The merge id for the merged UI. The merge id can be used to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0. - a #GtkUIManager object + a #GtkUIManager object - the resource path of the file to parse + the resource path of the file to parse - - Parses a string containing a [UI definition][XML-UI] and merges it with + + Parses a string containing a [UI definition][XML-UI] and merges it with the current contents of @manager. An enclosing <ui> element is added if it is missing. - The merge id for the merged UI. The merge id can be used + The merge id for the merged UI. The merge id can be used to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0. - a #GtkUIManager object + a #GtkUIManager object - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - - Makes sure that all pending updates to the UI have been completed. + + Makes sure that all pending updates to the UI have been completed. This may occasionally be necessary, since #GtkUIManager updates the UI in an idle function. A typical example where this function is @@ -184287,82 +131867,50 @@ gtk_widget_show (window); - a #GtkUIManager + a #GtkUIManager - - Returns the #GtkAccelGroup associated with @manager. + + Returns the #GtkAccelGroup associated with @manager. - the #GtkAccelGroup. + the #GtkAccelGroup. - a #GtkUIManager object + a #GtkUIManager object - - Looks up an action by following a path. See gtk_ui_manager_get_widget() + + Looks up an action by following a path. See gtk_ui_manager_get_widget() for more information about paths. - the action whose proxy widget is found by following the path, + the action whose proxy widget is found by following the path, or %NULL if no widget was found. - a #GtkUIManager + a #GtkUIManager - a path + a path - - Returns the list of action groups associated with @manager. + + Returns the list of action groups associated with @manager. - a #GList of + a #GList of action groups. The list is owned by GTK+ and should not be modified. @@ -184371,53 +131919,33 @@ for more information about paths. - a #GtkUIManager object + a #GtkUIManager object - - Returns whether menus generated by this #GtkUIManager + + Returns whether menus generated by this #GtkUIManager will have tearoff menu items. Tearoff menus are deprecated and should not be used in newly written code. - whether tearoff menu items are added + whether tearoff menu items are added - a #GtkUIManager + a #GtkUIManager - - Obtains a list of all toplevel widgets of the requested types. + + Obtains a list of all toplevel widgets of the requested types. - a newly-allocated #GSList of + a newly-allocated #GSList of all toplevel widgets of the requested types. Free the returned list with g_slist_free(). @@ -184425,56 +131953,36 @@ all toplevel widgets of the requested types. Free the returned list with g_slis - a #GtkUIManager + a #GtkUIManager - specifies the types of toplevel widgets to include. Allowed + specifies the types of toplevel widgets to include. Allowed types are #GTK_UI_MANAGER_MENUBAR, #GTK_UI_MANAGER_TOOLBAR and #GTK_UI_MANAGER_POPUP. - - Creates a [UI definition][XML-UI] of the merged UI. + + Creates a [UI definition][XML-UI] of the merged UI. - A newly allocated string containing an XML representation of + A newly allocated string containing an XML representation of the merged UI. - a #GtkUIManager + a #GtkUIManager - - Looks up a widget by following a path. + + Looks up a widget by following a path. The path consists of the names specified in the XML description of the UI. -separated by “/”. Elements which don’t have a name or action attribute in +separated by “/”. Elements which don’t have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path. @@ -184488,35 +131996,23 @@ function to some container or explicitly ref them, they will survive the destruction of the ui manager. - the widget found by following the path, + the widget found by following the path, or %NULL if no widget was found - a #GtkUIManager + a #GtkUIManager - a path + a path - - Inserts an action group into the list of action groups associated + + Inserts an action group into the list of action groups associated with @manager. Actions in earlier groups hide actions with the same name in later groups. @@ -184529,58 +132025,36 @@ list. - a #GtkUIManager object + a #GtkUIManager object - the action group to be inserted + the action group to be inserted - the position at which the group will be inserted. + the position at which the group will be inserted. - - Returns an unused merge id, suitable for use with + + Returns an unused merge id, suitable for use with gtk_ui_manager_add_ui(). - an unused merge id. + an unused merge id. - a #GtkUIManager + a #GtkUIManager - - Removes an action group from the list of action groups associated + + Removes an action group from the list of action groups associated with @manager. @@ -184588,54 +132062,34 @@ with @manager. - a #GtkUIManager object + a #GtkUIManager object - the action group to be removed + the action group to be removed - - Unmerges the part of @manager's content identified by @merge_id. + + Unmerges the part of @manager's content identified by @merge_id. - a #GtkUIManager object + a #GtkUIManager object - a merge id as returned by gtk_ui_manager_add_ui_from_string() + a merge id as returned by gtk_ui_manager_add_ui_from_string() - - Sets the “add_tearoffs” property, which controls whether menus + + Sets the “add_tearoffs” property, which controls whether menus generated by this #GtkUIManager will have tearoff menu items. Note that this only affects regular menus. Generated popup @@ -184648,28 +132102,17 @@ menus never have tearoff menu items. - a #GtkUIManager + a #GtkUIManager - whether tearoff menu items are added + whether tearoff menu items are added - - The "add-tearoffs" property controls whether generated menus + + The "add-tearoffs" property controls whether generated menus have tearoff menu items. Note that this only affects regular menus. Generated popup @@ -184687,29 +132130,15 @@ menus never have tearoff menu items. - - The ::actions-changed signal is emitted whenever the set of actions + + The ::actions-changed signal is emitted whenever the set of actions changes. - - The ::add-widget signal is emitted for each generated menubar and toolbar. + + The ::add-widget signal is emitted for each generated menubar and toolbar. It is not emitted for generated popup menus, which can be obtained by gtk_ui_manager_get_widget(). @@ -184717,22 +132146,13 @@ gtk_ui_manager_get_widget(). - the added widget + the added widget - - The ::connect-proxy signal is emitted after connecting a proxy to + + The ::connect-proxy signal is emitted after connecting a proxy to an action in the group. This is intended for simple customizations for which a custom action @@ -184743,56 +132163,34 @@ statusbar. - the action + the action - the proxy + the proxy - - The ::disconnect-proxy signal is emitted after disconnecting a proxy + + The ::disconnect-proxy signal is emitted after disconnecting a proxy from an action in the group. - the action + the action - the proxy + the proxy - - The ::post-activate signal is emitted just after the @action + + The ::post-activate signal is emitted just after the @action is activated. This is intended for applications to get notification @@ -184802,22 +132200,13 @@ just after any action is activated. - the action + the action - - The ::pre-activate signal is emitted just before the @action + + The ::pre-activate signal is emitted just before the @action is activated. This is intended for applications to get notification @@ -184827,17 +132216,13 @@ just before any action is activated. - the action + the action - + @@ -184945,23 +132330,17 @@ just before any action is activated. - the widget found by following the path, + the widget found by following the path, or %NULL if no widget was found - a #GtkUIManager + a #GtkUIManager - a path + a path @@ -184971,23 +132350,17 @@ just before any action is activated. - the action whose proxy widget is found by following the path, + the action whose proxy widget is found by following the path, or %NULL if no widget was found. - a #GtkUIManager + a #GtkUIManager - a path + a path @@ -185026,171 +132399,81 @@ just before any action is activated. - - These enumeration values are used by gtk_ui_manager_add_ui() to determine + + These enumeration values are used by gtk_ui_manager_add_ui() to determine what UI element to create. - - Pick the type of the UI element according to context. + + Pick the type of the UI element according to context. - - Create a menubar. + + Create a menubar. - - Create a menu. + + Create a menu. - - Create a toolbar. + + Create a toolbar. - - Insert a placeholder. + + Insert a placeholder. - - Create a popup menu. + + Create a popup menu. - - Create a menuitem. + + Create a menuitem. - - Create a toolitem. + + Create a toolitem. - - Create a separator. + + Create a separator. - - Install an accelerator. + + Install an accelerator. - - Same as %GTK_UI_MANAGER_POPUP, but the - actions’ accelerators are shown. + + Same as %GTK_UI_MANAGER_POPUP, but the + actions’ accelerators are shown. - + - + - + - - See also gtk_print_settings_set_paper_width(). - - No units. + + See also gtk_print_settings_set_paper_width(). + + No units. - - Dimensions in points. + + Dimensions in points. - - Dimensions in inches. + + Dimensions in inches. - Dimensions in millimeters + Dimensions in millimeters @@ -185200,61 +132483,43 @@ what UI element to create. - + - + - + - + - + - - A #GtkVBox is a container that organizes child widgets into a single column. + + A #GtkVBox is a container that organizes child widgets into a single column. Use the #GtkBox packing interface to determine the arrangement, spacing, height, and alignment of #GtkVBox children. @@ -185263,7 +132528,7 @@ All children are allocated the same width. GtkVBox has been deprecated. You can use #GtkBox with a #GtkOrientable:orientation set to %GTK_ORIENTATION_VERTICAL instead when calling gtk_box_new(), -which is a very quick and easy change. +which is a very quick and easy change. If you have derived your own classes from GtkVBox, you can change the inheritance to derive directly from #GtkBox, and set the #GtkOrientable:orientation @@ -185275,7 +132540,7 @@ with a call like: GTK_ORIENTATION_VERTICAL); ]| -If you have a grid-like layout composed of nested boxes, and you don’t +If you have a grid-like layout composed of nested boxes, and you don’t need first-child or last-child styling, the recommendation is to switch to #GtkGrid. For more information about migrating to #GtkGrid, see [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid]. @@ -185283,35 +132548,22 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - - Creates a new #GtkVBox. - You can use gtk_box_new() with %GTK_ORIENTATION_VERTICAL instead, - which is a quick and easy change. But the recommendation is to switch to - #GtkGrid, since #GtkBox is going to go away eventually. - See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid]. + + Creates a new #GtkVBox. + You should use gtk_box_new() with a %GTK_ORIENTATION_VERTICAL + #GtkOrientable:orientation instead - a new #GtkVBox. + a new #GtkVBox. - %TRUE if all children are to be given equal space allotments. + %TRUE if all children are to be given equal space allotments. - the number of pixels to place by default between children. + the number of pixels to place by default between children. @@ -185320,38 +132572,23 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - + - + - - Creates a new vertical button box. + + Creates a new vertical button box. Use gtk_button_box_new() with %GTK_ORIENTATION_VERTICAL instead - a new button box #GtkWidget. + a new button box #GtkWidget. @@ -185359,62 +132596,48 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - + - + - + - + - + - + - + @@ -185428,34 +132651,22 @@ to #GtkGrid. For more information about migrating to #GtkGrid, see - + - + - - The VPaned widget is a container widget with two + + The VPaned widget is a container widget with two children arranged vertically. The division between the two panes is adjustable by the user by dragging a handle. See #GtkPaned for details. @@ -185465,19 +132676,12 @@ GtkVPaned has been deprecated, use #GtkPaned instead. - - Create a new #GtkVPaned + + Create a new #GtkVPaned Use gtk_paned_new() with %GTK_ORIENTATION_VERTICAL instead - the new #GtkVPaned + the new #GtkVPaned @@ -185485,9 +132689,7 @@ GtkVPaned has been deprecated, use #GtkPaned instead. - + @@ -185500,131 +132702,93 @@ GtkVPaned has been deprecated, use #GtkPaned instead. - + - + - + - + - + - + - + - + - - The #GtkVScale widget is used to allow the user to select a value using + + The #GtkVScale widget is used to allow the user to select a value using a vertical slider. To create one, use gtk_hscale_new_with_range(). The position to show the current value, and the number of decimal places -shown can be set using the parent #GtkScale class’s functions. +shown can be set using the parent #GtkScale class’s functions. GtkVScale has been deprecated, use #GtkScale instead. - - Creates a new #GtkVScale. + + Creates a new #GtkVScale. Use gtk_scale_new() with %GTK_ORIENTATION_VERTICAL instead - a new #GtkVScale. + a new #GtkVScale. - the #GtkAdjustment which sets the range of the scale. + the #GtkAdjustment which sets the range of the scale. - - Creates a new vertical scale widget that lets the user input a + + Creates a new vertical scale widget that lets the user input a number between @min and @max (including @min and @max) with the -increment @step. @step must be nonzero; it’s the distance the +increment @step. @step must be nonzero; it’s the distance the slider moves when using the arrow keys to adjust the scale value. Note that the way in which the precision is derived works best if @step @@ -185633,28 +132797,20 @@ needs, use gtk_scale_set_digits() to correct it. Use gtk_scale_new_with_range() with %GTK_ORIENTATION_VERTICAL instead - a new #GtkVScale + a new #GtkVScale - minimum value + minimum value - maximum value + maximum value - step increment (tick size) used with keyboard shortcuts + step increment (tick size) used with keyboard shortcuts @@ -185663,24 +132819,14 @@ needs, use gtk_scale_set_digits() to correct it. - + - - The #GtkVScrollbar widget is a widget arranged vertically creating a + + The #GtkVScrollbar widget is a widget arranged vertically creating a scrollbar. See #GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be added to handle the adjustment of the scrollbar or it may be left %NULL in which case one @@ -185692,29 +132838,17 @@ GtkVScrollbar has been deprecated, use #GtkScrollbar instead. - - Creates a new vertical scrollbar. + + Creates a new vertical scrollbar. Use gtk_scrollbar_new() with %GTK_ORIENTATION_VERTICAL instead - the new #GtkVScrollbar + the new #GtkVScrollbar - - the #GtkAdjustment to use, or %NULL to create a new adjustment + + the #GtkAdjustment to use, or %NULL to create a new adjustment @@ -185723,24 +132857,14 @@ GtkVScrollbar has been deprecated, use #GtkScrollbar instead. - + - - The #GtkVSeparator widget is a vertical separator, used to group the + + The #GtkVSeparator widget is a vertical separator, used to group the widgets within a window. It displays a vertical line with a shadow to make it appear sunken into the interface. @@ -185749,19 +132873,12 @@ GtkVSeparator has been deprecated, use #GtkSeparator instead. - - Creates a new #GtkVSeparator. + + Creates a new #GtkVSeparator. Use gtk_separator_new() with %GTK_ORIENTATION_VERTICAL instead - a new #GtkVSeparator. + a new #GtkVSeparator. @@ -185769,24 +132886,14 @@ GtkVSeparator has been deprecated, use #GtkSeparator instead. - + - - The #GtkViewport widget acts as an adaptor class, implementing + + The #GtkViewport widget acts as an adaptor class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use GtkViewport to scroll child widgets such as #GtkGrid, #GtkBox, and so on. @@ -185800,7 +132907,7 @@ implement #GtkScrollable is added to a #GtkScrolledWindow, so you can ignore the presence of the viewport. The GtkViewport will start scrolling content only if allocated less -than the child widget’s minimum size in a given orientation. +than the child widget’s minimum size in a given orientation. # CSS nodes @@ -185810,159 +132917,99 @@ GtkViewport has a single CSS node with name viewport. - Creates a new #GtkViewport with the given adjustments, or with default + Creates a new #GtkViewport with the given adjustments, or with default adjustments if none are given. - a new #GtkViewport + a new #GtkViewport - - horizontal adjustment + + horizontal adjustment - - vertical adjustment + + vertical adjustment - - Gets the bin window of the #GtkViewport. + + Gets the bin window of the #GtkViewport. - a #GdkWindow + a #GdkWindow - a #GtkViewport + a #GtkViewport - - Returns the horizontal adjustment of the viewport. + + Returns the horizontal adjustment of the viewport. Use gtk_scrollable_get_hadjustment() - the horizontal adjustment of @viewport. + the horizontal adjustment of @viewport. - a #GtkViewport. + a #GtkViewport. - - Gets the shadow type of the #GtkViewport. See + + Gets the shadow type of the #GtkViewport. See gtk_viewport_set_shadow_type(). - the shadow type + the shadow type - a #GtkViewport + a #GtkViewport - - Returns the vertical adjustment of the viewport. + + Returns the vertical adjustment of the viewport. Use gtk_scrollable_get_vadjustment() - the vertical adjustment of @viewport. + the vertical adjustment of @viewport. - a #GtkViewport. + a #GtkViewport. - - Gets the view window of the #GtkViewport. + + Gets the view window of the #GtkViewport. - a #GdkWindow + a #GdkWindow - a #GtkViewport + a #GtkViewport - - Sets the horizontal adjustment of the viewport. + + Sets the horizontal adjustment of the viewport. Use gtk_scrollable_set_hadjustment() @@ -185970,53 +133017,34 @@ gtk_viewport_set_shadow_type(). - a #GtkViewport. + a #GtkViewport. - - a #GtkAdjustment. + + a #GtkAdjustment. - - Sets the shadow type of the viewport. + + Sets the shadow type of the viewport. - a #GtkViewport. + a #GtkViewport. - the new shadow type. + the new shadow type. - - Sets the vertical adjustment of the viewport. + + Sets the vertical adjustment of the viewport. Use gtk_scrollable_set_vadjustment() @@ -186024,18 +133052,11 @@ gtk_viewport_set_shadow_type(). - a #GtkViewport. + a #GtkViewport. - - a #GtkAdjustment. + + a #GtkAdjustment. @@ -186050,14 +133071,10 @@ gtk_viewport_set_shadow_type(). - + - The parent class. + The parent class. @@ -186096,16 +133113,8 @@ gtk_viewport_set_shadow_type(). - - #GtkVolumeButton is a subclass of #GtkScaleButton that has + + #GtkVolumeButton is a subclass of #GtkScaleButton that has been tailored for use as a volume control widget with suitable icons, tooltips and accessible labels. @@ -186114,30 +133123,18 @@ icons, tooltips and accessible labels. - - Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with + + Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with a stepping of 0.02. Volume values can be obtained and modified using the functions from #GtkScaleButton. - a new #GtkVolumeButton + a new #GtkVolumeButton - - Whether to use symbolic icons as the icons. Note that + + Whether to use symbolic icons as the icons. Note that if the symbolic icons are not available in your installed theme, then the normal (potentially colorful) icons will be used. @@ -186147,9 +133144,7 @@ be used. - + @@ -186194,45 +133189,35 @@ be used. - + - + - + - + - + @@ -186246,89 +133231,64 @@ be used. - + - + - + - + - + - + - + - + - - GtkWidget is the base class all widgets in GTK+ derive from. It manages the + + GtkWidget is the base class all widgets in GTK+ derive from. It manages the widget lifecycle, states and style. # Height-for-width Geometry Management # {#geometry-management} @@ -186375,7 +133335,7 @@ used to set the minimum size constraint on the toplevel After the toplevel window has initially requested its size in both dimensions it can go on to allocate itself a reasonable size (or a size previously specified with gtk_window_set_default_size()). During the -recursive allocation process it’s important to note that request cycles +recursive allocation process it’s important to note that request cycles will be recursively executed while container widgets allocate their children. Each container widget, once allocated a size, will go on to first share the space in one orientation among its children and then request each child's @@ -186387,7 +133347,7 @@ requested. For this reason, #GtkWidget caches a small number of results to avoid re-querying for the same sizes in one allocation cycle. See -[GtkContainer’s geometry management section][container-geometry-management] +[GtkContainer’s geometry management section][container-geometry-management] to learn more about how height-for-width allocations are performed by container widgets. @@ -186491,7 +133451,7 @@ Since 3.10 GTK+ also supports baseline vertical alignment of widgets. This means that widgets are positioned such that the typographical baseline of widgets in the same row are aligned. This happens if a widget supports baselines, has a vertical alignment of %GTK_ALIGN_BASELINE, and is inside a container -that supports baselines and has a natural “row” that it aligns to the baseline, +that supports baselines and has a natural “row” that it aligns to the baseline, or a baseline assigned to it by the grandparent. Baseline alignment support for a widget is done by the #GtkWidgetClass.get_preferred_height_and_baseline_for_width() @@ -186499,7 +133459,7 @@ virtual function. It allows you to report a baseline in combination with the minimum and natural height. If there is no baseline you can return -1 to indicate this. The default implementation of this virtual function calls into the #GtkWidgetClass.get_preferred_height() and #GtkWidgetClass.get_preferred_height_for_width(), -so if baselines are not supported it doesn’t need to be implemented. +so if baselines are not supported it doesn’t need to be implemented. If a widget ends up baseline aligned it will be allocated all the space in the parent as if it was %GTK_ALIGN_FILL, but the selected baseline can be found via gtk_widget_get_allocated_baseline(). @@ -186508,8 +133468,8 @@ appears at the position. # Style Properties -#GtkWidget introduces “style -properties” - these are basically object properties that are stored +#GtkWidget introduces “style +properties” - these are basically object properties that are stored not on the object, but in the style object associated to the widget. Style properties are set in [resource files][gtk3-Resource-Files]. This mechanism is used for configuring such things as the location of the @@ -186525,8 +133485,8 @@ gtk_widget_style_get_valist() to obtain the value of a style property. # GtkWidget as GtkBuildable The GtkWidget implementation of the GtkBuildable interface supports a -custom <accelerator> element, which has attributes named ”key”, ”modifiers” -and ”signal” and allows to specify accelerators. +custom <accelerator> element, which has attributes named ”key”, ”modifiers” +and ”signal” and allows to specify accelerators. An example of a UI definition fragment specifying an accelerator: |[ @@ -186538,7 +133498,7 @@ An example of a UI definition fragment specifying an accelerator: In addition to accelerators, GtkWidget also support a custom <accessible> element, which supports actions and relations. Properties on the accessible implementation of an object can be set by accessing the internal child -“accessible” of a #GtkWidget. +“accessible” of a #GtkWidget. An example of a UI definition fragment specifying an accessible: |[ @@ -186584,8 +133544,8 @@ is slightly different from regular #GtkBuilder XML. Unlike regular interface descriptions, gtk_widget_class_set_template() will expect a <template> tag as a direct child of the toplevel <interface> -tag. The <template> tag must specify the “class” attribute which must be -the type name of the widget. Optionally, the “parent” attribute may be +tag. The <template> tag must specify the “class” attribute which must be +the type name of the widget. Optionally, the “parent” attribute may be specified to specify the direct parent type of the widget type, this is ignored by the GtkBuilder but required for Glade to introspect what kind of properties and internal children exist for a given type when the actual @@ -186711,101 +133671,69 @@ foo_widget_class_init (FooWidgetClass *klass) - This is a convenience function for creating a widget and setting + This is a convenience function for creating a widget and setting its properties in one go. For example you might write: `gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign", 0.0, NULL)` to create a left-aligned label. Equivalent to -g_object_new(), but returns a widget so you don’t have to +g_object_new(), but returns a widget so you don’t have to cast the object yourself. - a new #GtkWidget of type @widget_type + a new #GtkWidget of type @widget_type - type ID of the widget to create + type ID of the widget to create - name of first property to set + name of first property to set - value of first property, followed by more properties, + value of first property, followed by more properties, %NULL-terminated - - Obtains the current default reading direction. See + + Obtains the current default reading direction. See gtk_widget_set_default_direction(). - the current default direction. + the current default direction. - - Returns the default style used by all widgets initially. + + Returns the default style used by all widgets initially. Use #GtkStyleContext instead, and gtk_css_provider_get_default() to obtain a #GtkStyleProvider with the default widget style information. - the default style. This #GtkStyle + the default style. This #GtkStyle object is owned by GTK+ and should not be modified or freed. - - Cancels the effect of a previous call to gtk_widget_push_composite_child(). - Use gtk_widget_class_set_template(), or don’t use this API at all. + + Cancels the effect of a previous call to gtk_widget_push_composite_child(). + Use gtk_widget_class_set_template(), or don’t use this API at all. - - Makes all newly-created widgets as composite children until + + Makes all newly-created widgets as composite children until the corresponding gtk_widget_pop_composite_child() call. -A composite child is a child that’s an implementation detail of the -container it’s inside and should not be visible to people using the -container. Composite children aren’t treated differently by GTK+ (but +A composite child is a child that’s an implementation detail of the +container it’s inside and should not be visible to people using the +container. Composite children aren’t treated differently by GTK+ (but see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI builders might want to treat them in a different way. This API never really worked well and was mostly unused, now @@ -186815,11 +133743,8 @@ we have a more complete mechanism for composite children, see gtk_widget_class_s - - Sets the default reading direction for widgets where the + + Sets the default reading direction for widgets where the direction has not been explicitly set by gtk_widget_set_direction(). @@ -186827,9 +133752,7 @@ direction has not been explicitly set by gtk_widget_set_direction(). - the new default direction. This cannot be + the new default direction. This cannot be %GTK_TEXT_DIR_NONE. @@ -186940,44 +133863,32 @@ direction has not been explicitly set by gtk_widget_set_direction(). - - Determines whether an accelerator that activates the signal + + Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel -signal on @widget; if the signal isn’t overridden by a +signal on @widget; if the signal isn’t overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped. - %TRUE if the accelerator can be activated. + %TRUE if the accelerator can be activated. - a #GtkWidget + a #GtkWidget - the ID of a signal installed on @widget + the ID of a signal installed on @widget - Emits a #GtkWidget::child-notify signal for the + Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on @widget. @@ -186990,16 +133901,12 @@ Also see gtk_container_child_notify(). - a #GtkWidget + a #GtkWidget - the name of a child property installed on the - class of @widget’s parent + the name of a child property installed on the + class of @widget’s parent @@ -187075,9 +133982,7 @@ Also see gtk_container_child_notify(). - Destroys a widget. + Destroys a widget. When a widget is destroyed all references it holds on other objects will be released: @@ -187114,9 +134019,7 @@ See also: gtk_container_remove() - a #GtkWidget + a #GtkWidget @@ -187369,35 +134272,27 @@ See also: gtk_container_remove() - Rarely-used function. This function is used to emit + Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). -If you want to synthesize an event though, don’t use this function; +If you want to synthesize an event though, don’t use this function; instead, use gtk_main_do_event() so the event will behave as if -it were in the event queue. Don’t synthesize expose events; instead, +it were in the event queue. Don’t synthesize expose events; instead, use gdk_window_invalidate_rect() to invalidate a region of the window. - return from the event signal emission (%TRUE if + return from the event signal emission (%TRUE if the event was handled) - a #GtkWidget + a #GtkWidget - a #GdkEvent + a #GdkEvent @@ -187445,9 +134340,7 @@ window. - Returns the accessible object that describes the widget to an + Returns the accessible object that describes the widget to an assistive technology. If accessibility support is not available, this #AtkObject @@ -187461,26 +134354,18 @@ The documentation of the library contains more information about accessible objects and their uses. - the #AtkObject associated with @widget + the #AtkObject associated with @widget - a #GtkWidget + a #GtkWidget - - Retrieves a widget’s initial minimum and natural height. + + Retrieves a widget’s initial minimum and natural height. This call is specific to width-for-height requests. @@ -187495,41 +134380,21 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL - - Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given + + Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified @width, or the default height if @width is -1. The baselines may be -1 which means that no baseline is requested for this widget. @@ -187544,69 +134409,33 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - the width which is available for allocation, or -1 if none + the width which is available for allocation, or -1 if none - - location for storing the minimum height, or %NULL + + location for storing the minimum height, or %NULL - - location for storing the natural height, or %NULL + + location for storing the natural height, or %NULL - - location for storing the baseline for the minimum height, or %NULL + + location for storing the baseline for the minimum height, or %NULL - - location for storing the baseline for the natural height, or %NULL + + location for storing the baseline for the natural height, or %NULL - - Retrieves a widget’s minimum and natural height if it would be given + + Retrieves a widget’s minimum and natural height if it would be given the specified @width. The returned request will be modified by the @@ -187620,47 +134449,25 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - the width which is available for allocation + the width which is available for allocation - - location for storing the minimum height, or %NULL + + location for storing the minimum height, or %NULL - - location for storing the natural height, or %NULL + + location for storing the natural height, or %NULL - - Retrieves a widget’s initial minimum and natural width. + + Retrieves a widget’s initial minimum and natural width. This call is specific to height-for-width requests. @@ -187675,41 +134482,21 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL - - Retrieves a widget’s minimum and natural width if it would be given + + Retrieves a widget’s minimum and natural width if it would be given the specified @height. The returned request will be modified by the @@ -187723,47 +134510,25 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - the height which is available for allocation + the height which is available for allocation - - location for storing the minimum width, or %NULL + + location for storing the minimum width, or %NULL - - location for storing the natural width, or %NULL + + location for storing the natural width, or %NULL - - Gets whether the widget prefers a height-for-width layout + + Gets whether the widget prefers a height-for-width layout or a width-for-height layout. #GtkBin widgets generally propagate the preference of @@ -187772,16 +134537,12 @@ context of their children or in context of their allocation capabilities. - The #GtkSizeRequestMode preferred by @widget. + The #GtkSizeRequestMode preferred by @widget. - a #GtkWidget instance + a #GtkWidget instance @@ -187801,11 +134562,9 @@ capabilities. - Causes @widget to have the keyboard focus for the #GtkWindow it's + Causes @widget to have the keyboard focus for the #GtkWindow it's inside. @widget must be a focusable widget, such as a #GtkEntry; -something like #GtkFrame won’t work. +something like #GtkFrame won’t work. More precisely, it must have the %GTK_CAN_FOCUS flag set. Use gtk_widget_set_can_focus() to modify that flag. @@ -187819,9 +134578,7 @@ will likely fail and cause critical warnings. - a #GtkWidget + a #GtkWidget @@ -187841,9 +134598,7 @@ will likely fail and cause critical warnings. - Reverses the effects of gtk_widget_show(), causing the widget to be + Reverses the effects of gtk_widget_show(), causing the widget to be hidden (invisible to the user). @@ -187851,9 +134606,7 @@ hidden (invisible to the user). - a #GtkWidget + a #GtkWidget @@ -187900,12 +134653,8 @@ hidden (invisible to the user). - - This function should be called whenever keyboard navigation within + + This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of @@ -187917,7 +134666,7 @@ focus to. When %FALSE is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling -gtk_widget_child_focus() on the widget’s toplevel. +gtk_widget_child_focus() on the widget’s toplevel. The default ::keynav-failed handler returns %FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other @@ -187934,24 +134683,18 @@ entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys. - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - a #GtkWidget + a #GtkWidget - direction of focus movement + direction of focus movement @@ -187971,19 +134714,15 @@ that require entering license keys. - This function is only for use in widget implementations. Causes -a widget to be mapped if it isn’t already. + This function is only for use in widget implementations. Causes +a widget to be mapped if it isn’t already. - a #GtkWidget + a #GtkWidget @@ -188003,27 +134742,19 @@ a widget to be mapped if it isn’t already. - Emits the #GtkWidget::mnemonic-activate signal. + Emits the #GtkWidget::mnemonic-activate signal. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - a #GtkWidget + a #GtkWidget - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic @@ -188146,13 +134877,9 @@ a widget to be mapped if it isn’t already. - - Invalidates the area of @widget defined by @region by calling -gdk_window_invalidate_region() on the widget’s window and all its + + Invalidates the area of @widget defined by @region by calling +gdk_window_invalidate_region() on the widget’s window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been @@ -188167,36 +134894,30 @@ implementations. You might also use it to schedule a redraw of a - a #GtkWidget + a #GtkWidget - region to draw + region to draw - Creates the GDK (windowing system) resources associated with a + Creates the GDK (windowing system) resources associated with a widget. For example, @widget->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all -the widget’s parent widgets to be realized; calling -gtk_widget_realize() realizes the widget’s parents in addition to +the widget’s parent widgets to be realized; calling +gtk_widget_realize() realizes the widget’s parents in addition to @widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen. This function is primarily used in widget implementations, and -isn’t very useful otherwise. Many times when you think you might +isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as #GtkWidget::draw. Or simply g_signal_connect () to the @@ -188207,9 +134928,7 @@ called after the widget is realized automatically, such as - a #GtkWidget + a #GtkWidget @@ -188322,11 +135041,9 @@ called after the widget is realized automatically, such as - Flags a widget to be displayed. Any widget that isn’t shown will + Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. If you want to show all the widgets in a -container, it’s easier to call gtk_widget_show_all() on the +container, it’s easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets. Remember that you have to show the containers containing a widget, @@ -188341,17 +135058,13 @@ toplevel container is realized and mapped. - a #GtkWidget + a #GtkWidget - Recursively shows a widget, and any child widgets (if the widget is + Recursively shows a widget, and any child widgets (if the widget is a container). @@ -188359,9 +135072,7 @@ a container). - a #GtkWidget + a #GtkWidget @@ -188381,16 +135092,14 @@ a container). - This function is only used by #GtkContainer subclasses, to assign a size + This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets. In this function, the allocation may be adjusted. It will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual method on the child will be used to adjust the allocation. Standard -adjustments include removing the widget’s margins, and applying the -widget’s #GtkWidget:halign and #GtkWidget:valign properties. +adjustments include removing the widget’s margins, and applying the +widget’s #GtkWidget:halign and #GtkWidget:valign properties. For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline() instead. @@ -188400,15 +135109,11 @@ instead. - a #GtkWidget + a #GtkWidget - position and size to be allocated to @widget + position and size to be allocated to @widget @@ -188481,19 +135186,15 @@ instead. - This function is only for use in widget implementations. Causes -a widget to be unmapped if it’s currently mapped. + This function is only for use in widget implementations. Causes +a widget to be unmapped if it’s currently mapped. - a #GtkWidget + a #GtkWidget @@ -188513,9 +135214,7 @@ a widget to be unmapped if it’s currently mapped. - This function is only useful in widget implementations. + This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as @widget->window). @@ -188524,9 +135223,7 @@ associated with the widget, such as @widget->window). - a #GtkWidget + a #GtkWidget @@ -188560,34 +135257,26 @@ associated with the widget, such as @widget->window). - For widgets that can be “activated” (buttons, menu items, etc.) + For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If @widget isn't activatable, the function returns %FALSE. - %TRUE if the widget was activatable + %TRUE if the widget was activatable - a #GtkWidget that’s activatable + a #GtkWidget that’s activatable - Installs an accelerator for this @widget in @accel_group that causes + Installs an accelerator for this @widget in @accel_group that causes @accel_signal to be emitted if the accelerator is activated. -The @accel_group needs to be added to the widget’s toplevel via +The @accel_group needs to be added to the widget’s toplevel via gtk_window_add_accel_group(), and the signal must be of type %G_SIGNAL_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the @@ -188599,49 +135288,33 @@ gtk_menu_item_set_accel_path() instead. - widget to install an accelerator on + widget to install an accelerator on - widget signal to emit on accelerator activation + widget signal to emit on accelerator activation - accel group for this widget, added to its toplevel + accel group for this widget, added to its toplevel - GDK keyval of the accelerator + GDK keyval of the accelerator - modifier key combination of the accelerator + modifier key combination of the accelerator - flag accelerators, e.g. %GTK_ACCEL_VISIBLE + flag accelerators, e.g. %GTK_ACCEL_VISIBLE - - Adds the device events in the bitfield @events to the event mask for + + Adds the device events in the bitfield @events to the event mask for @widget. See gtk_widget_set_device_events() for details. @@ -188649,29 +135322,21 @@ gtk_menu_item_set_accel_path() instead. - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - an event mask, see #GdkEventMask + an event mask, see #GdkEventMask - Adds the events in the bitfield @events to the event mask for + Adds the events in the bitfield @events to the event mask for @widget. See gtk_widget_set_events() and the [input handling overview][event-masks] for details. @@ -188680,25 +135345,17 @@ gtk_menu_item_set_accel_path() instead. - a #GtkWidget + a #GtkWidget - an event mask, see #GdkEventMask + an event mask, see #GdkEventMask - - Adds a widget to the list of mnemonic labels for + + Adds a widget to the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update @@ -188710,32 +135367,24 @@ to the #GtkWidget::destroy signal or a weak notifier. - a #GtkWidget + a #GtkWidget - a #GtkWidget that acts as a mnemonic label for @widget + a #GtkWidget that acts as a mnemonic label for @widget - - Queues an animation frame update and adds a callback to be called + + Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a -repaint or relayout, and aren’t changing widget properties that +repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a #GtkLabel), then you will have to call gtk_widget_queue_resize() or gtk_widget_queue_draw_area() yourself. @@ -188750,85 +135399,56 @@ This is a more convenient alternative to connecting directly to the have to worry about when a #GdkFrameClock is assigned to a widget. - an id for the connection of this callback. Remove the callback + an id for the connection of this callback. Remove the callback by passing it to gtk_widget_remove_tick_callback() - a #GtkWidget + a #GtkWidget - - function to call for updating animations + + function to call for updating animations - - data to pass to @callback + + data to pass to @callback - function to call to free @user_data when the callback is removed. + function to call to free @user_data when the callback is removed. - - Determines whether an accelerator that activates the signal + + Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel -signal on @widget; if the signal isn’t overridden by a +signal on @widget; if the signal isn’t overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped. - %TRUE if the accelerator can be activated. + %TRUE if the accelerator can be activated. - a #GtkWidget + a #GtkWidget - the ID of a signal installed on @widget + the ID of a signal installed on @widget - This function is used by custom widget implementations; if you're -writing an app, you’d use gtk_widget_grab_focus() to move the focus + This function is used by custom widget implementations; if you're +writing an app, you’d use gtk_widget_grab_focus() to move the focus to a particular widget, and gtk_container_set_focus_chain() to change the focus tab order. So you may want to investigate those functions instead. @@ -188845,33 +135465,25 @@ moving in @direction left the focus on a focusable location inside that widget, and %FALSE if moving in @direction moved the focus outside the widget. If returning %TRUE, widgets normally call gtk_widget_grab_focus() to place the focus accordingly; -if returning %FALSE, they don’t modify the current focus location. +if returning %FALSE, they don’t modify the current focus location. - %TRUE if focus ended up inside @widget + %TRUE if focus ended up inside @widget - a #GtkWidget + a #GtkWidget - direction of focus movement + direction of focus movement - Emits a #GtkWidget::child-notify signal for the + Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on @widget. @@ -188884,27 +135496,18 @@ Also see gtk_container_child_notify(). - a #GtkWidget + a #GtkWidget - the name of a child property installed on the - class of @widget’s parent + the name of a child property installed on the + class of @widget’s parent - - Same as gtk_widget_path(), but always uses the name of a widget’s type, + + Same as gtk_widget_path(), but always uses the name of a widget’s type, never uses a custom name set with gtk_widget_set_name(). Use gtk_widget_get_path() instead @@ -188913,53 +135516,28 @@ never uses a custom name set with gtk_widget_set_name(). - a #GtkWidget + a #GtkWidget - - location to store the length of the + + location to store the length of the class path, or %NULL - - location to store the class path as an + + location to store the class path as an allocated string, or %NULL - - location to store the reverse + + location to store the reverse class path as an allocated string, or %NULL - Computes whether a container should give this widget extra space + Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand(). @@ -188972,54 +135550,38 @@ set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do. - whether widget tree rooted here should be expanded + whether widget tree rooted here should be expanded - the widget + the widget - expand direction + expand direction - - Creates a new #PangoContext with the appropriate font map, + + Creates a new #PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget. See also gtk_widget_get_pango_context(). - the new #PangoContext + the new #PangoContext - a #GtkWidget + a #GtkWidget - - Creates a new #PangoLayout with the appropriate font map, + + Creates a new #PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget. @@ -189029,33 +135591,22 @@ This can be tracked by using the #GtkWidget::screen-changed signal on the widget. - the new #PangoLayout + the new #PangoLayout - a #GtkWidget + a #GtkWidget - - text to set on the layout (can be %NULL) + + text to set on the layout (can be %NULL) - Destroys a widget. + Destroys a widget. When a widget is destroyed all references it holds on other objects will be released: @@ -189092,19 +135643,15 @@ See also: gtk_container_remove() - a #GtkWidget + a #GtkWidget - This function sets *@widget_pointer to %NULL if @widget_pointer != -%NULL. It’s intended to be used as a callback connected to the -“destroy” signal of a widget. You connect gtk_widget_destroyed() + This function sets *@widget_pointer to %NULL if @widget_pointer != +%NULL. It’s intended to be used as a callback connected to the +“destroy” signal of a widget. You connect gtk_widget_destroyed() as a signal handler, and pass the address of your widget variable as user data. Then when the widget is destroyed, the variable will be set to %NULL. Useful for example to avoid multiple copies @@ -189115,115 +135662,74 @@ of the same dialog. - a #GtkWidget + a #GtkWidget - - address of a variable that contains @widget + + address of a variable that contains @widget - - Returns %TRUE if @device has been shadowed by a GTK+ + + Returns %TRUE if @device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to @widget. This may be used in the #GtkWidget::grab-notify signal to check for specific devices. See gtk_device_grab_add(). - %TRUE if there is an ongoing grab on @device + %TRUE if there is an ongoing grab on @device by another #GtkWidget than @widget. - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - - This function is equivalent to gtk_drag_begin_with_coordinates(), + + This function is equivalent to gtk_drag_begin_with_coordinates(), passing -1, -1 as coordinates. Use gtk_drag_begin_with_coordinates() instead - the context for this drag + the context for this drag - the source widget + the source widget - The targets (data formats) in which the + The targets (data formats) in which the source can provide the data - A bitmask of the allowed drag actions for this drag + A bitmask of the allowed drag actions for this drag - The button the user clicked to start the drag + The button the user clicked to start the drag - - The event that triggered the start of the drag, + + The event that triggered the start of the drag, or %NULL if none can be obtained. - - Initiates a drag on the source side. The function only needs to be used + + Initiates a drag on the source side. The function only needs to be used when the application is starting drags itself, and is not needed when gtk_drag_source_set() is used. @@ -189250,118 +135756,80 @@ from the mouse, using gdk_event_copy(), and pass it to this function If you really cannot pass a real event, pass %NULL instead. - the context for this drag + the context for this drag - the source widget + the source widget - The targets (data formats) in which the + The targets (data formats) in which the source can provide the data - A bitmask of the allowed drag actions for this drag + A bitmask of the allowed drag actions for this drag - The button the user clicked to start the drag + The button the user clicked to start the drag - - The event that triggered the start of the drag, + + The event that triggered the start of the drag, or %NULL if none can be obtained. - The initial x coordinate to start dragging from, in the coordinate space + The initial x coordinate to start dragging from, in the coordinate space of @widget. If -1 is passed, the coordinates are retrieved from @event or the current pointer position - The initial y coordinate to start dragging from, in the coordinate space + The initial y coordinate to start dragging from, in the coordinate space of @widget. If -1 is passed, the coordinates are retrieved from @event or the current pointer position - - Checks to see if a mouse drag starting at (@start_x, @start_y) and ending + + Checks to see if a mouse drag starting at (@start_x, @start_y) and ending at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation. - %TRUE if the drag threshold has been passed. + %TRUE if the drag threshold has been passed. - a #GtkWidget + a #GtkWidget - X coordinate of start of drag + X coordinate of start of drag - Y coordinate of start of drag + Y coordinate of start of drag - current X coordinate + current X coordinate - current Y coordinate + current Y coordinate - - Add the image targets supported by #GtkSelectionData to + + Add the image targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_image_targets() and @@ -189372,19 +135840,13 @@ gtk_drag_dest_set_target_list(). - a #GtkWidget that’s a drag destination + a #GtkWidget that’s a drag destination - - Add the text targets supported by #GtkSelectionData to + + Add the text targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_text_targets() and @@ -189395,19 +135857,13 @@ gtk_drag_dest_set_target_list(). - a #GtkWidget that’s a drag destination + a #GtkWidget that’s a drag destination - - Add the URI targets supported by #GtkSelectionData to + + Add the URI targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_uri_targets() and @@ -189418,18 +135874,13 @@ gtk_drag_dest_set_target_list(). - a #GtkWidget that’s a drag destination + a #GtkWidget that’s a drag destination - - Looks for a match between the supported targets of @context and the + + Looks for a match between the supported targets of @context and the @dest_target_list, returning the first matching target, otherwise returning %GDK_NONE. @dest_target_list should usually be the return value from gtk_drag_dest_get_target_list(), but some widgets may @@ -189438,93 +135889,65 @@ that case, they will have to implement a drag_motion handler that passes the correct target list to this function. - first target that the source offers + first target that the source offers and the dest can accept, or %GDK_NONE - drag destination widget + drag destination widget - drag context + drag context - - list of droppable targets, or %NULL to use + + list of droppable targets, or %NULL to use gtk_drag_dest_get_target_list (@widget). - - Returns the list of targets this widget can accept from + + Returns the list of targets this widget can accept from drag-and-drop. - the #GtkTargetList, or %NULL if none + the #GtkTargetList, or %NULL if none - a #GtkWidget + a #GtkWidget - - Returns whether the widget has been configured to always + + Returns whether the widget has been configured to always emit #GtkWidget::drag-motion signals. - %TRUE if the widget always emits + %TRUE if the widget always emits #GtkWidget::drag-motion events - a #GtkWidget that’s a drag destination + a #GtkWidget that’s a drag destination - Sets a widget as a potential drop destination, and adds default behaviors. + Sets a widget as a potential drop destination, and adds default behaviors. The default behaviors listed in @flags have an effect similar -to installing default handlers for the widget’s drag-and-drop signals +to installing default handlers for the widget’s drag-and-drop signals (#GtkWidget::drag-motion, #GtkWidget::drag-drop, ...). They all exist for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is -sufficient to connect to the widget’s #GtkWidget::drag-data-received +sufficient to connect to the widget’s #GtkWidget::drag-data-received signal to get primitive, but consistent drag-and-drop support. Things become more complicated when you try to preview the dragged data, @@ -189536,8 +135959,8 @@ and invokations of gtk_drag_finish() in #GtkWidget::drag-data-received. Especially the later is dramatic, when your own #GtkWidget::drag-motion handler calls gtk_drag_get_data() to inspect the dragged data. -There’s no way to set a default action here, you can use the -#GtkWidget::drag-motion callback for that. Here’s an example which selects +There’s no way to set a default action here, you can use the +#GtkWidget::drag-motion callback for that. Here’s an example which selects the action to use depending on whether the control key is pressed or not: |[<!-- language="C" --> static void @@ -189563,93 +135986,62 @@ drag_motion (GtkWidget *widget, - a #GtkWidget + a #GtkWidget - which types of default drag behavior to use + which types of default drag behavior to use - - a pointer to an array of + + a pointer to an array of #GtkTargetEntrys indicating the drop types that this @widget will accept, or %NULL. Later you can access the list with gtk_drag_dest_get_target_list() and gtk_drag_dest_find_target(). - + - the number of entries in @targets + the number of entries in @targets - a bitmask of possible actions for a drop onto this @widget. + a bitmask of possible actions for a drop onto this @widget. - - Sets this widget as a proxy for drops to another window. + + Sets this widget as a proxy for drops to another window. - a #GtkWidget + a #GtkWidget - the window to which to forward drag events + the window to which to forward drag events - the drag protocol which the @proxy_window accepts + the drag protocol which the @proxy_window accepts (You can use gdk_drag_get_protocol() to determine this) - If %TRUE, send the same coordinates to the + If %TRUE, send the same coordinates to the destination, because it is an embedded subwindow. - - Sets the target types that this widget can accept from drag-and-drop. + + Sets the target types that this widget can accept from drag-and-drop. The widget must first be made into a drag destination with gtk_drag_dest_set(). @@ -189658,28 +136050,17 @@ gtk_drag_dest_set(). - a #GtkWidget that’s a drag destination + a #GtkWidget that’s a drag destination - - list of droppable targets, or %NULL for none + + list of droppable targets, or %NULL for none - - Tells the widget to emit #GtkWidget::drag-motion and + + Tells the widget to emit #GtkWidget::drag-motion and #GtkWidget::drag-leave events regardless of the targets and the %GTK_DEST_DEFAULT_MOTION flag. @@ -189691,23 +136072,17 @@ actions regardless of the targets that the source offers. - a #GtkWidget that’s a drag destination + a #GtkWidget that’s a drag destination - whether to accept all targets + whether to accept all targets - Clears information about a drop destination set with + Clears information about a drop destination set with gtk_drag_dest_set(). The widget will no longer receive notification of drags. @@ -189716,17 +136091,13 @@ notification of drags. - a #GtkWidget + a #GtkWidget - Gets the data associated with a drag. When the data + Gets the data associated with a drag. When the data is received or the retrieval fails, GTK+ will emit a #GtkWidget::drag-data-received signal. Failure of the retrieval is indicated by the length field of the @selection_data @@ -189740,28 +136111,20 @@ drops. - the widget that will receive the + the widget that will receive the #GtkWidget::drag-data-received signal - the drag context + the drag context - the target (form of the data) to retrieve + the target (form of the data) to retrieve - a timestamp for retrieving the data. This will + a timestamp for retrieving the data. This will generally be the time received in a #GtkWidget::drag-motion or #GtkWidget::drag-drop signal @@ -189769,9 +136132,7 @@ drops. - Highlights a widget as a currently hovered drop target. + Highlights a widget as a currently hovered drop target. To end the highlight, call gtk_drag_unhighlight(). GTK+ calls this automatically if %GTK_DEST_DEFAULT_HIGHLIGHT is set. @@ -189780,19 +136141,13 @@ GTK+ calls this automatically if %GTK_DEST_DEFAULT_HIGHLIGHT is set. - a widget to highlight + a widget to highlight - - Add the writable image targets supported by #GtkSelectionData to + + Add the writable image targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_image_targets() and @@ -189803,19 +136158,13 @@ gtk_drag_source_set_target_list(). - a #GtkWidget that’s is a drag source + a #GtkWidget that’s is a drag source - - Add the text targets supported by #GtkSelectionData to + + Add the text targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_text_targets() and @@ -189826,19 +136175,13 @@ gtk_drag_source_set_target_list(). - a #GtkWidget that’s is a drag source + a #GtkWidget that’s is a drag source - - Add the URI targets supported by #GtkSelectionData to + + Add the URI targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_uri_targets() and @@ -189849,40 +136192,28 @@ gtk_drag_source_set_target_list(). - a #GtkWidget that’s is a drag source + a #GtkWidget that’s is a drag source - - Gets the list of targets this widget can provide for + + Gets the list of targets this widget can provide for drag-and-drop. - the #GtkTargetList, or %NULL if none + the #GtkTargetList, or %NULL if none - a #GtkWidget + a #GtkWidget - Sets up a widget so that GTK+ will start a drag operation when the user + Sets up a widget so that GTK+ will start a drag operation when the user clicks and drags on the widget. The widget must have a window. @@ -189890,51 +136221,32 @@ clicks and drags on the widget. The widget must have a window. - a #GtkWidget + a #GtkWidget - the bitmask of buttons that can start the drag + the bitmask of buttons that can start the drag - - the table of targets + + the table of targets that the drag will support, may be %NULL - + - the number of items in @targets + the number of items in @targets - the bitmask of possible actions for a drag from this widget + the bitmask of possible actions for a drag from this widget - - Sets the icon that will be used for drags from a particular source + + Sets the icon that will be used for drags from a particular source to @icon. See the docs for #GtkIconTheme for more details. @@ -189942,25 +136254,17 @@ to @icon. See the docs for #GtkIconTheme for more details. - a #GtkWidget + a #GtkWidget - A #GIcon + A #GIcon - - Sets the icon that will be used for drags from a particular source + + Sets the icon that will be used for drags from a particular source to a themed icon. See the docs for #GtkIconTheme for more details. @@ -189968,24 +136272,17 @@ to a themed icon. See the docs for #GtkIconTheme for more details. - a #GtkWidget + a #GtkWidget - name of icon to use + name of icon to use - - Sets the icon that will be used for drags from a particular widget + + Sets the icon that will be used for drags from a particular widget from a #GdkPixbuf. GTK+ retains a reference for @pixbuf and will release it when it is no longer needed. @@ -189994,26 +136291,17 @@ release it when it is no longer needed. - a #GtkWidget + a #GtkWidget - the #GdkPixbuf for the drag icon + the #GdkPixbuf for the drag icon - - Sets the icon that will be used for drags from a particular source + + Sets the icon that will be used for drags from a particular source to a stock icon. Use gtk_drag_source_set_icon_name() instead. @@ -190022,25 +136310,17 @@ to a stock icon. - a #GtkWidget + a #GtkWidget - the ID of the stock icon to use + the ID of the stock icon to use - - Changes the target types that this widget offers for drag-and-drop. + + Changes the target types that this widget offers for drag-and-drop. The widget must first be made into a drag source with gtk_drag_source_set(). @@ -190049,43 +136329,30 @@ gtk_drag_source_set(). - a #GtkWidget that’s a drag source + a #GtkWidget that’s a drag source - - list of draggable targets, or %NULL for none + + list of draggable targets, or %NULL for none - Undoes the effects of gtk_drag_source_set(). + Undoes the effects of gtk_drag_source_set(). - a #GtkWidget + a #GtkWidget - Removes a highlight set by gtk_drag_highlight() from + Removes a highlight set by gtk_drag_highlight() from a widget. @@ -190093,17 +136360,13 @@ a widget. - a widget to remove the highlight from + a widget to remove the highlight from - Draws @widget to @cr. The top left corner of the widget will be + Draws @widget to @cr. The top left corner of the widget will be drawn to the currently set origin point of @cr. You should pass a cairo context as @cr argument that is in an @@ -190111,7 +136374,7 @@ original state. Otherwise the resulting drawing is undefined. For example changing the operator using cairo_set_operator() or the line width using cairo_set_line_width() might have unwanted side effects. -You may however change the context’s transform matrix - like with +You may however change the context’s transform matrix - like with cairo_scale(), cairo_translate() or cairo_set_matrix() and clip region with cairo_clip() prior to calling this function. Also, it is fine to modify the context with cairo_save() and @@ -190126,27 +136389,18 @@ and when rendered using gtk_widget_draw(). - the widget to draw. It must be drawable (see + the widget to draw. It must be drawable (see gtk_widget_is_drawable()) and a size must have been allocated. - a cairo context to draw to + a cairo context to draw to - - Ensures that @widget has a style (@widget->style). + + Ensures that @widget has a style (@widget->style). Not a very useful function; most of the time, if you want the style, the widget is realized, and realized @@ -190158,19 +136412,13 @@ widgets are guaranteed to have a style already. - a #GtkWidget + a #GtkWidget - - Notifies the user about an input-related error on this widget. + + Notifies the user about an input-related error on this widget. If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls gdk_window_beep(), otherwise it does nothing. @@ -190183,52 +136431,39 @@ or window manager that is used. - a #GtkWidget + a #GtkWidget - Rarely-used function. This function is used to emit + Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). -If you want to synthesize an event though, don’t use this function; +If you want to synthesize an event though, don’t use this function; instead, use gtk_main_do_event() so the event will behave as if -it were in the event queue. Don’t synthesize expose events; instead, +it were in the event queue. Don’t synthesize expose events; instead, use gdk_window_invalidate_rect() to invalidate a region of the window. - return from the event signal emission (%TRUE if + return from the event signal emission (%TRUE if the event was handled) - a #GtkWidget + a #GtkWidget - a #GdkEvent + a #GdkEvent - - Stops emission of #GtkWidget::child-notify signals on @widget. The + + Stops emission of #GtkWidget::child-notify signals on @widget. The signals are queued until gtk_widget_thaw_child_notify() is called on @widget. @@ -190239,17 +136474,13 @@ This is the analogue of g_object_freeze_notify() for child properties. - a #GtkWidget + a #GtkWidget - Returns the accessible object that describes the widget to an + Returns the accessible object that describes the widget to an assistive technology. If accessibility support is not available, this #AtkObject @@ -190263,106 +136494,73 @@ The documentation of the library contains more information about accessible objects and their uses. - the #AtkObject associated with @widget + the #AtkObject associated with @widget - a #GtkWidget + a #GtkWidget - - Retrieves the #GActionGroup that was registered using @prefix. The resulting + + Retrieves the #GActionGroup that was registered using @prefix. The resulting #GActionGroup may have been registered to @widget or any #GtkWidget in its ancestry. If no action group was found matching @prefix, then %NULL is returned. - A #GActionGroup or %NULL. + A #GActionGroup or %NULL. - A #GtkWidget + A #GtkWidget - The “prefix” of the action group. + The “prefix” of the action group. - - Returns the baseline that has currently been allocated to @widget. + + Returns the baseline that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function, and when allocating child widgets in #GtkWidget::size_allocate. - the baseline of the @widget, or -1 if none + the baseline of the @widget, or -1 if none - the widget to query + the widget to query - - Returns the height that has currently been allocated to @widget. + + Returns the height that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function. - the height of the @widget + the height of the @widget - the widget to query + the widget to query - - Retrieves the widget’s allocated size. + + Retrieves the widget’s allocated size. This function returns the last values passed to gtk_widget_size_allocate_with_baseline(). The value differs from @@ -190377,65 +136575,40 @@ If a widget is not visible, its allocated size is 0. - a #GtkWidget + a #GtkWidget - - a pointer to a #GtkAllocation to copy to + + a pointer to a #GtkAllocation to copy to - - a pointer to an integer to copy to + + a pointer to an integer to copy to - - Returns the width that has currently been allocated to @widget. + + Returns the width that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function. - the width of the @widget + the width of the @widget - the widget to query + the widget to query - - Retrieves the widget’s allocation. + + Retrieves the widget’s allocation. -Note, when implementing a #GtkContainer: a widget’s allocation will -be its “adjusted” allocation, that is, the widget’s parent +Note, when implementing a #GtkContainer: a widget’s allocation will +be its “adjusted” allocation, that is, the widget’s parent container typically calls gtk_widget_size_allocate() with an allocation, and that allocation is then adjusted (to handle margin and alignment for example) before assignment to the widget. @@ -190446,7 +136619,7 @@ gtk_widget_size_allocate() allocation, however. So a #GtkContainer is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the container assigned. There is no way to get the original allocation assigned by -gtk_widget_size_allocate(), since it isn’t stored; if a container +gtk_widget_size_allocate(), since it isn’t stored; if a container implementation needs that information it will have to track it itself. @@ -190454,28 +136627,19 @@ implementation needs that information it will have to track it itself. - a #GtkWidget + a #GtkWidget - - a pointer to a #GtkAllocation to copy to + + a pointer to a #GtkAllocation to copy to - Gets the first ancestor of @widget with type @widget_type. For example, + Gets the first ancestor of @widget with type @widget_type. For example, `gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)` gets -the first #GtkBox that’s an ancestor of @widget. No reference will be +the first #GtkBox that’s an ancestor of @widget. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel #GtkWindow in the docs for gtk_widget_get_toplevel(). @@ -190484,104 +136648,69 @@ Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor() considers @widget to be an ancestor of itself. - the ancestor widget, or %NULL if not found + the ancestor widget, or %NULL if not found - a #GtkWidget + a #GtkWidget - ancestor type + ancestor type - - Determines whether the application intends to draw on the widget in + + Determines whether the application intends to draw on the widget in an #GtkWidget::draw handler. See gtk_widget_set_app_paintable() - %TRUE if the widget is app paintable + %TRUE if the widget is app paintable - a #GtkWidget + a #GtkWidget - - Determines whether @widget can be a default widget. See + + Determines whether @widget can be a default widget. See gtk_widget_set_can_default(). - %TRUE if @widget can be a default widget, %FALSE otherwise + %TRUE if @widget can be a default widget, %FALSE otherwise - a #GtkWidget + a #GtkWidget - - Determines whether @widget can own the input focus. See + + Determines whether @widget can own the input focus. See gtk_widget_set_can_focus(). - %TRUE if @widget can own the input focus, %FALSE otherwise + %TRUE if @widget can own the input focus, %FALSE otherwise - a #GtkWidget + a #GtkWidget - - This function is only for use in widget implementations. Obtains + + This function is only for use in widget implementations. Obtains @widget->requisition, unless someone has forced a particular geometry on the widget (e.g. with gtk_widget_set_size_request()), in which case it returns that geometry instead of the widget's @@ -190593,7 +136722,7 @@ while gtk_widget_size_request() actually calls the "size_request" method on @widget to compute the size request and fill in @widget->requisition, and only then returns @widget->requisition. -Because this function does not call the “size_request” method, it +Because this function does not call the “size_request” method, it can only be used when you know that @widget->requisition is up-to-date, that is, gtk_widget_size_request() has been called since the last time a resize was queued. In general, only container @@ -190606,27 +136735,17 @@ gtk_widget_size_request(). - a #GtkWidget + a #GtkWidget - - a #GtkRequisition to be filled in + + a #GtkRequisition to be filled in - - Gets the value set with gtk_widget_set_child_visible(). + + Gets the value set with gtk_widget_set_child_visible(). If you feel a need to use this function, your code probably needs reorganization. @@ -190634,26 +136753,18 @@ This function is only useful for container implementations and never should be called by an application. - %TRUE if the widget is mapped with the parent. + %TRUE if the widget is mapped with the parent. - a #GtkWidget + a #GtkWidget - - Retrieves the widget’s clip area. + + Retrieves the widget’s clip area. The clip area is the area in which all of @widget's drawing will happen. Other toolkits call it the bounding box. @@ -190666,36 +136777,23 @@ retrieved via gtk_widget_get_allocation(). - a #GtkWidget + a #GtkWidget - - a pointer to a #GtkAllocation to copy to + + a pointer to a #GtkAllocation to copy to - - Returns the clipboard object for the given selection to + + Returns the clipboard object for the given selection to be used with @widget. @widget must have a #GdkDisplay associated with it, so must be attached to a toplevel window. - the appropriate clipboard object. If no + the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time. @@ -190703,15 +136801,11 @@ window. - a #GtkWidget + a #GtkWidget - a #GdkAtom which identifies the clipboard + a #GdkAtom which identifies the clipboard to use. %GDK_SELECTION_CLIPBOARD gives the default clipboard. Another common value is %GDK_SELECTION_PRIMARY, which gives @@ -190720,117 +136814,78 @@ window. - - Obtains the composite name of a widget. - Use gtk_widget_class_set_template(), or don’t use this API at all. + + Obtains the composite name of a widget. + Use gtk_widget_class_set_template(), or don’t use this API at all. - the composite name of @widget, or %NULL if @widget is not + the composite name of @widget, or %NULL if @widget is not a composite child. The string should be freed when it is no longer needed. - a #GtkWidget + a #GtkWidget - - Returns whether @device can interact with @widget and its + + Returns whether @device can interact with @widget and its children. See gtk_widget_set_device_enabled(). - %TRUE is @device is enabled for @widget + %TRUE is @device is enabled for @widget - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - - Returns the events mask for the widget corresponding to an specific device. These + + Returns the events mask for the widget corresponding to an specific device. These are the events that the widget will receive when @device operates on it. - device event mask for @widget + device event mask for @widget - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - Gets the reading direction for a particular widget. See + Gets the reading direction for a particular widget. See gtk_widget_set_direction(). - the reading direction for the widget. + the reading direction for the widget. - a #GtkWidget + a #GtkWidget - - Get the #GdkDisplay for the toplevel window associated with + + Get the #GdkDisplay for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top. @@ -190839,48 +136894,34 @@ resources when a widget has been realized, and you should free those resources when the widget is unrealized. - the #GdkDisplay for the toplevel for this widget. + the #GdkDisplay for the toplevel for this widget. - a #GtkWidget + a #GtkWidget - - Determines whether the widget is double buffered. + + Determines whether the widget is double buffered. See gtk_widget_set_double_buffered() - %TRUE if the widget is double buffered + %TRUE if the widget is double buffered - a #GtkWidget + a #GtkWidget - Returns the event mask (see #GdkEventMask) for the widget. These are the + Returns the event mask (see #GdkEventMask) for the widget. These are the events that the widget will receive. Note: Internally, the widget event mask will be the logical OR of the event @@ -190889,96 +136930,64 @@ event mask necessary to cater for every #GtkEventController created for the widget. - event mask for @widget + event mask for @widget - a #GtkWidget + a #GtkWidget - - Returns whether the widget should grab focus when it is clicked with the mouse. + + Returns whether the widget should grab focus when it is clicked with the mouse. See gtk_widget_set_focus_on_click(). - %TRUE if the widget should grab focus when it is clicked with + %TRUE if the widget should grab focus when it is clicked with the mouse. - a #GtkWidget + a #GtkWidget - - Gets the font map that has been set with gtk_widget_set_font_map(). + + Gets the font map that has been set with gtk_widget_set_font_map(). - A #PangoFontMap, or %NULL + A #PangoFontMap, or %NULL - a #GtkWidget + a #GtkWidget - - Returns the #cairo_font_options_t used for Pango rendering. When not set, + + Returns the #cairo_font_options_t used for Pango rendering. When not set, the defaults font options for the #GdkScreen will be used. - the #cairo_font_options_t or %NULL if not set + the #cairo_font_options_t or %NULL if not set - a #GtkWidget + a #GtkWidget - - Obtains the frame clock for a widget. The frame clock is a global -“ticker” that can be used to drive animations and repaints. The + + Obtains the frame clock for a widget. The frame clock is a global +“ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call gdk_frame_clock_get_frame_time(), in order to get a time to use for animating. For example you might record the start of the animation @@ -190987,38 +136996,32 @@ then update the animation by calling gdk_frame_clock_get_frame_time() again during each repaint. gdk_frame_clock_request_phase() will result in a new frame on the -clock, but won’t necessarily repaint any widgets. To repaint a +clock, but won’t necessarily repaint any widgets. To repaint a widget, you have to use gtk_widget_queue_draw() which invalidates the widget (thus scheduling it to receive a draw on the next frame). gtk_widget_queue_draw() will also end up requesting a frame on the appropriate frame clock. -A widget’s frame clock will not change while the widget is +A widget’s frame clock will not change while the widget is mapped. Reparenting a widget (which implies a temporary unmap) can -change the widget’s frame clock. +change the widget’s frame clock. Unrealized widgets do not have a frame clock. - a #GdkFrameClock, + a #GdkFrameClock, or %NULL if widget is unrealized - a #GtkWidget + a #GtkWidget - Gets the value of the #GtkWidget:halign property. + Gets the value of the #GtkWidget:halign property. For backwards compatibility reasons this method will never return %GTK_ALIGN_BASELINE, but instead it will convert it to @@ -191026,70 +137029,48 @@ For backwards compatibility reasons this method will never return alignment. - the horizontal alignment of @widget + the horizontal alignment of @widget - a #GtkWidget + a #GtkWidget - - Returns the current value of the has-tooltip property. See + + Returns the current value of the has-tooltip property. See #GtkWidget:has-tooltip for more information. - current value of has-tooltip on @widget. + current value of has-tooltip on @widget. - a #GtkWidget + a #GtkWidget - - Determines whether @widget has a #GdkWindow of its own. See + + Determines whether @widget has a #GdkWindow of its own. See gtk_widget_set_has_window(). - %TRUE if @widget has a window, %FALSE otherwise + %TRUE if @widget has a window, %FALSE otherwise - a #GtkWidget + a #GtkWidget - Gets whether the widget would like any available extra horizontal + Gets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to @@ -191100,29 +137081,23 @@ this function, to see whether a widget, or any of its children, has the expand flag set. If any child of a widget wants to expand, the parent may ask to expand also. -This function only looks at the widget’s own hexpand flag, rather +This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand. - whether hexpand flag is set + whether hexpand flag is set - the widget + the widget - Gets whether gtk_widget_set_hexpand() has been used to + Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget. If hexpand is set, then it overrides any computed @@ -191130,222 +137105,143 @@ expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand. -There are few reasons to use this function, but it’s here +There are few reasons to use this function, but it’s here for completeness and consistency. - whether hexpand has been explicitly set + whether hexpand has been explicitly set - the widget + the widget - - Whether the widget is mapped. + + Whether the widget is mapped. - %TRUE if the widget is mapped, %FALSE otherwise. + %TRUE if the widget is mapped, %FALSE otherwise. - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:margin-bottom property. + + Gets the value of the #GtkWidget:margin-bottom property. - The bottom margin of @widget + The bottom margin of @widget - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:margin-end property. + + Gets the value of the #GtkWidget:margin-end property. - The end margin of @widget + The end margin of @widget - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:margin-left property. + + Gets the value of the #GtkWidget:margin-left property. Use gtk_widget_get_margin_start() instead. - The left margin of @widget + The left margin of @widget - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:margin-right property. + + Gets the value of the #GtkWidget:margin-right property. Use gtk_widget_get_margin_end() instead. - The right margin of @widget + The right margin of @widget - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:margin-start property. + + Gets the value of the #GtkWidget:margin-start property. - The start margin of @widget + The start margin of @widget - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:margin-top property. + + Gets the value of the #GtkWidget:margin-top property. - The top margin of @widget + The top margin of @widget - a #GtkWidget + a #GtkWidget - - Returns the modifier mask the @widget’s windowing system backend + + Returns the modifier mask the @widget’s windowing system backend uses for a particular purpose. See gdk_keymap_get_modifier_mask(). - the modifier mask used for @intent. + the modifier mask used for @intent. - a #GtkWidget + a #GtkWidget - the use case for the modifier mask + the use case for the modifier mask - - Returns the current modifier style for the widget. (As set by + + Returns the current modifier style for the widget. (As set by gtk_widget_modify_style().) If no style has previously set, a new #GtkRcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc @@ -191360,9 +137256,7 @@ to the modifier style if you want to keep it alive. Use #GtkStyleContext with a custom #GtkStyleProvider instead - the modifier style for the widget. + the modifier style for the widget. This rc style is owned by the widget. If you want to keep a pointer to value this around, you must add a refcount using g_object_ref(). @@ -191370,180 +137264,125 @@ to the modifier style if you want to keep it alive. - a #GtkWidget + a #GtkWidget - Retrieves the name of a widget. See gtk_widget_set_name() for the + Retrieves the name of a widget. See gtk_widget_set_name() for the significance of widget names. - name of the widget. This string is owned by GTK+ and + name of the widget. This string is owned by GTK+ and should not be modified or freed - a #GtkWidget + a #GtkWidget - - Returns the current value of the #GtkWidget:no-show-all property, + + Returns the current value of the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() will affect this widget. - the current value of the “no-show-all” property. + the current value of the “no-show-all” property. - a #GtkWidget + a #GtkWidget - - Fetches the requested opacity for this widget. + + Fetches the requested opacity for this widget. See gtk_widget_set_opacity(). - the requested opacity for this widget. + the requested opacity for this widget. - a #GtkWidget + a #GtkWidget - - Gets a #PangoContext with the appropriate font map, font description, + + Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk_widget_create_pango_context(), this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to -match any changes to the widget’s attributes. This can be tracked +match any changes to the widget’s attributes. This can be tracked by using the #GtkWidget::screen-changed signal on the widget. - the #PangoContext for the widget. + the #PangoContext for the widget. - a #GtkWidget + a #GtkWidget - Returns the parent container of @widget. + Returns the parent container of @widget. - the parent container of @widget, or %NULL + the parent container of @widget, or %NULL - a #GtkWidget + a #GtkWidget - - Gets @widget’s parent window, or %NULL if it does not have one. + + Gets @widget’s parent window, or %NULL if it does not have one. - the parent window of @widget, or %NULL + the parent window of @widget, or %NULL if it does not have a parent window. - a #GtkWidget. + a #GtkWidget. - Returns the #GtkWidgetPath representing @widget, if the widget + Returns the #GtkWidgetPath representing @widget, if the widget is not connected to a toplevel widget, a partial path will be created. - The #GtkWidgetPath representing @widget + The #GtkWidgetPath representing @widget - a #GtkWidget + a #GtkWidget - - Obtains the location of the mouse pointer in widget coordinates. + + Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as @widget->window coordinates for widgets that return %TRUE for gtk_widget_get_has_window(); and are relative to @widget->allocation.x, @@ -191555,41 +137394,21 @@ gtk_widget_get_has_window(); and are relative to @widget->allocation.x, - a #GtkWidget + a #GtkWidget - - return location for the X coordinate, or %NULL + + return location for the X coordinate, or %NULL - - return location for the Y coordinate, or %NULL + + return location for the Y coordinate, or %NULL - - Retrieves a widget’s initial minimum and natural height. + + Retrieves a widget’s initial minimum and natural height. This call is specific to width-for-height requests. @@ -191604,41 +137423,21 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL - - Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given + + Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified @width, or the default height if @width is -1. The baselines may be -1 which means that no baseline is requested for this widget. @@ -191653,69 +137452,33 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - the width which is available for allocation, or -1 if none + the width which is available for allocation, or -1 if none - - location for storing the minimum height, or %NULL + + location for storing the minimum height, or %NULL - - location for storing the natural height, or %NULL + + location for storing the natural height, or %NULL - - location for storing the baseline for the minimum height, or %NULL + + location for storing the baseline for the minimum height, or %NULL - - location for storing the baseline for the natural height, or %NULL + + location for storing the baseline for the natural height, or %NULL - - Retrieves a widget’s minimum and natural height if it would be given + + Retrieves a widget’s minimum and natural height if it would be given the specified @width. The returned request will be modified by the @@ -191729,48 +137492,26 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - the width which is available for allocation + the width which is available for allocation - - location for storing the minimum height, or %NULL + + location for storing the minimum height, or %NULL - - location for storing the natural height, or %NULL + + location for storing the natural height, or %NULL - - Retrieves the minimum and natural size of a widget, taking -into account the widget’s preference for height-for-width management. + + Retrieves the minimum and natural size of a widget, taking +into account the widget’s preference for height-for-width management. This is used to retrieve a suitable size by container widgets which do not impose any restrictions on the child placement. It can be used @@ -191790,41 +137531,21 @@ baseline alignment. - a #GtkWidget instance + a #GtkWidget instance - - location for storing the minimum size, or %NULL + + location for storing the minimum size, or %NULL - - location for storing the natural size, or %NULL + + location for storing the natural size, or %NULL - - Retrieves a widget’s initial minimum and natural width. + + Retrieves a widget’s initial minimum and natural width. This call is specific to height-for-width requests. @@ -191839,41 +137560,21 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL - - Retrieves a widget’s minimum and natural width if it would be given + + Retrieves a widget’s minimum and natural width if it would be given the specified @height. The returned request will be modified by the @@ -191887,96 +137588,58 @@ returned by the widget itself. - a #GtkWidget instance + a #GtkWidget instance - the height which is available for allocation + the height which is available for allocation - - location for storing the minimum width, or %NULL + + location for storing the minimum width, or %NULL - - location for storing the natural width, or %NULL + + location for storing the natural width, or %NULL - - Determines whether @widget is realized. + + Determines whether @widget is realized. - %TRUE if @widget is realized, %FALSE otherwise + %TRUE if @widget is realized, %FALSE otherwise - a #GtkWidget + a #GtkWidget - - Determines whether @widget is always treated as the default widget + + Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. See gtk_widget_set_receives_default(). - %TRUE if @widget acts as the default widget when focused, + %TRUE if @widget acts as the default widget when focused, %FALSE otherwise - a #GtkWidget + a #GtkWidget - - Gets whether the widget prefers a height-for-width layout + + Gets whether the widget prefers a height-for-width layout or a width-for-height layout. #GtkBin widgets generally propagate the preference of @@ -191985,31 +137648,21 @@ context of their children or in context of their allocation capabilities. - The #GtkSizeRequestMode preferred by @widget. + The #GtkSizeRequestMode preferred by @widget. - a #GtkWidget instance + a #GtkWidget instance - - Retrieves the widget’s requisition. + + Retrieves the widget’s requisition. This function should only be used by widget implementations in -order to figure whether the widget’s requisition has actually +order to figure whether the widget’s requisition has actually changed after some internal state change (so that they can call gtk_widget_queue_resize() instead of gtk_widget_queue_draw()). @@ -192023,30 +137676,17 @@ add an explicit cache to the widget in question instead. - a #GtkWidget + a #GtkWidget - - a pointer to a #GtkRequisition to copy to + + a pointer to a #GtkRequisition to copy to - - Get the root window where this widget is located. This function can + + Get the root window where this widget is located. This function can only be called after the widget has been added to a widget hierarchy with #GtkWindow at the top. @@ -192057,52 +137697,36 @@ and you should free those resources when the widget is unrealized. Use gdk_screen_get_root_window() instead - the #GdkWindow root window for the toplevel for this widget. + the #GdkWindow root window for the toplevel for this widget. - a #GtkWidget + a #GtkWidget - - Retrieves the internal scale factor that maps from window coordinates + + Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2). See gdk_window_get_scale_factor(). - the scale factor for @widget + the scale factor for @widget - a #GtkWidget + a #GtkWidget - - Get the #GdkScreen from the toplevel window associated with + + Get the #GdkScreen from the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top. @@ -192112,75 +137736,54 @@ resources when a widget has been realized, and you should free those resources when the widget is unrealized. - the #GdkScreen for the toplevel for this widget. + the #GdkScreen for the toplevel for this widget. - a #GtkWidget + a #GtkWidget - - Returns the widget’s sensitivity (in the sense of returning + + Returns the widget’s sensitivity (in the sense of returning the value that has been set using gtk_widget_set_sensitive()). The effective sensitivity of a widget is however determined by both its -own and its parent widget’s sensitivity. See gtk_widget_is_sensitive(). +own and its parent widget’s sensitivity. See gtk_widget_is_sensitive(). - %TRUE if the widget is sensitive + %TRUE if the widget is sensitive - a #GtkWidget + a #GtkWidget - Gets the settings object holding the settings used for this widget. + Gets the settings object holding the settings used for this widget. Note that this function can only be called when the #GtkWidget is attached to a toplevel, since the settings object is specific to a particular #GdkScreen. - the relevant #GtkSettings object + the relevant #GtkSettings object - a #GtkWidget + a #GtkWidget - - Gets the size request that was explicitly set for the widget using + + Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). A value of -1 stored in @width or @height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used instead. See @@ -192193,66 +137796,36 @@ this function. - a #GtkWidget + a #GtkWidget - - return location for width, or %NULL + + return location for width, or %NULL - - return location for height, or %NULL + + return location for height, or %NULL - - Returns the widget’s state. See gtk_widget_set_state(). + + Returns the widget’s state. See gtk_widget_set_state(). Use gtk_widget_get_state_flags() instead. - the state of @widget. + the state of @widget. - a #GtkWidget + a #GtkWidget - - Returns the widget state as a flag set. It is worth mentioning + + Returns the widget state as a flag set. It is worth mentioning that the effective %GTK_STATE_FLAG_INSENSITIVE state will be returned, that is, also based on parent insensitivity, even if @widget itself is sensitive. @@ -192262,94 +137835,64 @@ Also note that if you are looking for a way to obtain the should look at gtk_style_context_get_state(). - The state flags for widget + The state flags for widget - a #GtkWidget + a #GtkWidget - - Simply an accessor function that returns @widget->style. + + Simply an accessor function that returns @widget->style. Use #GtkStyleContext instead - the widget’s #GtkStyle + the widget’s #GtkStyle - a #GtkWidget + a #GtkWidget - - Returns the style context associated to @widget. The returned object is + + Returns the style context associated to @widget. The returned object is guaranteed to be the same for the lifetime of @widget. - a #GtkStyleContext. This memory is owned by @widget and + a #GtkStyleContext. This memory is owned by @widget and must not be freed. - a #GtkWidget + a #GtkWidget - - Returns %TRUE if @widget is multiple pointer aware. See + + Returns %TRUE if @widget is multiple pointer aware. See gtk_widget_set_support_multidevice() for more information. - %TRUE if @widget is multidevice aware. + %TRUE if @widget is multidevice aware. - a #GtkWidget + a #GtkWidget - - Fetch an object build from the template XML for @widget_type in this @widget instance. + + Fetch an object build from the template XML for @widget_type in this @widget instance. This will only report children which were previously declared with gtk_widget_class_bind_template_child_full() or one of its @@ -192360,106 +137903,72 @@ declared the child and is meant for language bindings which cannot easily make u of the GObject structure offsets. - The object built in the template XML with the id @name + The object built in the template XML with the id @name - A #GtkWidget + A #GtkWidget - The #GType to get a template child for + The #GType to get a template child for - The “id” of the child defined in the template XML + The “id” of the child defined in the template XML - - Gets the contents of the tooltip for @widget. + + Gets the contents of the tooltip for @widget. - the tooltip text, or %NULL. You should free the + the tooltip text, or %NULL. You should free the returned string with g_free() when done. - a #GtkWidget + a #GtkWidget - - Gets the contents of the tooltip for @widget. + + Gets the contents of the tooltip for @widget. - the tooltip text, or %NULL. You should free the + the tooltip text, or %NULL. You should free the returned string with g_free() when done. - a #GtkWidget + a #GtkWidget - - Returns the #GtkWindow of the current tooltip. This can be the + + Returns the #GtkWindow of the current tooltip. This can be the GtkWindow created by default, or the custom tooltip window set using gtk_widget_set_tooltip_window(). - The #GtkWindow of the current tooltip. + The #GtkWindow of the current tooltip. - a #GtkWidget + a #GtkWidget - This function returns the topmost widget in the container hierarchy + This function returns the topmost widget in the container hierarchy @widget is a part of. If @widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced. @@ -192467,7 +137976,7 @@ returned widget; it should not be unreferenced. Note the difference in behavior vs. gtk_widget_get_ancestor(); `gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)` would return -%NULL if @widget wasn’t inside a toplevel window, and if the +%NULL if @widget wasn’t inside a toplevel window, and if the window was inside a #GtkWindow-derived widget which was in turn inside the toplevel #GtkWindow. While the second case may seem unlikely, it actually happens when a #GtkPlug is embedded @@ -192492,25 +138001,19 @@ get_widget_toplevel_title (GtkWidget *widget) ]| - the topmost ancestor of @widget, or @widget itself - if there’s no ancestor. + the topmost ancestor of @widget, or @widget itself + if there’s no ancestor. - a #GtkWidget + a #GtkWidget - Gets the value of the #GtkWidget:valign property. + Gets the value of the #GtkWidget:valign property. For backwards compatibility reasons this method will never return %GTK_ALIGN_BASELINE, but instead it will convert it to @@ -192520,96 +138023,68 @@ children it must use gtk_widget_get_valign_with_baseline(), or also report the true value. - the vertical alignment of @widget, ignoring baseline alignment + the vertical alignment of @widget, ignoring baseline alignment - a #GtkWidget + a #GtkWidget - - Gets the value of the #GtkWidget:valign property, including + + Gets the value of the #GtkWidget:valign property, including %GTK_ALIGN_BASELINE. - the vertical alignment of @widget + the vertical alignment of @widget - a #GtkWidget + a #GtkWidget - Gets whether the widget would like any available extra vertical + Gets whether the widget would like any available extra vertical space. See gtk_widget_get_hexpand() for more detail. - whether vexpand flag is set + whether vexpand flag is set - the widget + the widget - Gets whether gtk_widget_set_vexpand() has been used to + Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget. See gtk_widget_get_hexpand_set() for more detail. - whether vexpand has been explicitly set + whether vexpand has been explicitly set - the widget + the widget - - Determines whether the widget is visible. If you want to -take into account whether the widget’s parent is also marked as + + Determines whether the widget is visible. If you want to +take into account whether the widget’s parent is also marked as visible, use gtk_widget_is_visible() instead. This function does not check if the widget is obscured in any way. @@ -192617,66 +138092,46 @@ This function does not check if the widget is obscured in any way. See gtk_widget_set_visible(). - %TRUE if the widget is visible + %TRUE if the widget is visible - a #GtkWidget + a #GtkWidget - Gets the visual that will be used to render @widget. + Gets the visual that will be used to render @widget. - the visual for @widget + the visual for @widget - a #GtkWidget + a #GtkWidget - - Returns the widget’s window if it is realized, %NULL otherwise + + Returns the widget’s window if it is realized, %NULL otherwise - @widget’s window. + @widget’s window. - a #GtkWidget + a #GtkWidget - Makes @widget the current grabbed widget. + Makes @widget the current grabbed widget. This means that interaction with other widgets in the same application is blocked and mouse as well as keyboard events @@ -192690,23 +138145,19 @@ grabbed widget and this function does nothing. - The widget that grabs keyboard and pointer events + The widget that grabs keyboard and pointer events - Causes @widget to become the default widget. @widget must be able to be + Causes @widget to become the default widget. @widget must be able to be a default widget; typically you would ensure this yourself by calling gtk_widget_set_can_default() with a %TRUE value. The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, gtk_widget_activate() should affect them. Note -that #GtkEntry widgets require the “activates-default” property +that #GtkEntry widgets require the “activates-default” property set to %TRUE before they activate the default widget when Enter is pressed and the #GtkEntry is focused. @@ -192715,19 +138166,15 @@ is pressed and the #GtkEntry is focused. - a #GtkWidget + a #GtkWidget - Causes @widget to have the keyboard focus for the #GtkWindow it's + Causes @widget to have the keyboard focus for the #GtkWindow it's inside. @widget must be a focusable widget, such as a #GtkEntry; -something like #GtkFrame won’t work. +something like #GtkFrame won’t work. More precisely, it must have the %GTK_CAN_FOCUS flag set. Use gtk_widget_set_can_focus() to modify that flag. @@ -192741,17 +138188,13 @@ will likely fail and cause critical warnings. - a #GtkWidget + a #GtkWidget - Removes the grab from the given widget. + Removes the grab from the given widget. You have to pair calls to gtk_grab_add() and gtk_grab_remove(). @@ -192762,144 +138205,96 @@ If @widget does not have the grab, this function does nothing. - The widget which gives up the grab + The widget which gives up the grab - - Determines whether @widget is the current default widget within its + + Determines whether @widget is the current default widget within its toplevel. See gtk_widget_set_can_default(). - %TRUE if @widget is the current default widget within + %TRUE if @widget is the current default widget within its toplevel, %FALSE otherwise - a #GtkWidget + a #GtkWidget - - Determines if the widget has the global input focus. See + + Determines if the widget has the global input focus. See gtk_widget_is_focus() for the difference between having the global input focus, and only having the focus within a toplevel. - %TRUE if the widget has the global input focus. + %TRUE if the widget has the global input focus. - a #GtkWidget + a #GtkWidget - - Determines whether the widget is currently grabbing events, so it + + Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). See also gtk_grab_add(). - %TRUE if the widget is in the grab_widgets stack + %TRUE if the widget is in the grab_widgets stack - a #GtkWidget + a #GtkWidget - - Determines if the widget style has been looked up through the rc mechanism. + + Determines if the widget style has been looked up through the rc mechanism. Use #GtkStyleContext instead - %TRUE if the widget has been looked up through the rc + %TRUE if the widget has been looked up through the rc mechanism, %FALSE otherwise. - a #GtkWidget + a #GtkWidget - - Checks whether there is a #GdkScreen is associated with + + Checks whether there is a #GdkScreen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top. - %TRUE if there is a #GdkScreen associated + %TRUE if there is a #GdkScreen associated with the widget. - a #GtkWidget + a #GtkWidget - - Determines if the widget should show a visible indication that + + Determines if the widget should show a visible indication that it has the global input focus. This is a convenience function for use in ::draw handlers that takes into account whether focus indication should currently be shown in the toplevel window of @@ -192910,24 +138305,18 @@ To find out if the widget has the global input focus, use gtk_widget_has_focus(). - %TRUE if the widget should display a “focus rectangle” + %TRUE if the widget should display a “focus rectangle” - a #GtkWidget + a #GtkWidget - Reverses the effects of gtk_widget_show(), causing the widget to be + Reverses the effects of gtk_widget_show(), causing the widget to be hidden (invisible to the user). @@ -192935,17 +138324,13 @@ hidden (invisible to the user). - a #GtkWidget + a #GtkWidget - Utility function; intended to be connected to the #GtkWidget::delete-event + Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk_widget_hide() on its argument, then returns %TRUE. If connected to ::delete-event, the result is that clicking the close button for a window (on the @@ -192954,48 +138339,34 @@ the window. By default, GTK+ destroys windows when ::delete-event is received. - %TRUE + %TRUE - a #GtkWidget + a #GtkWidget - Returns whether the widget is currently being destroyed. + Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work. - %TRUE if @widget is being destroyed + %TRUE if @widget is being destroyed - a #GtkWidget + a #GtkWidget - - Creates and initializes child widgets defined in templates. This + + Creates and initializes child widgets defined in templates. This function must be called in the instance initializer for any class which assigned itself a template using gtk_widget_class_set_template() @@ -193008,7 +138379,7 @@ class composite widgets have been created in their instance initializers. Another reason is that when calling g_object_new() on a widget with -composite templates, it’s important to build the composite widgets +composite templates, it’s important to build the composite widgets before the construct properties are set. Properties passed to g_object_new() should take precedence over properties set in the private template XML. @@ -193017,19 +138388,13 @@ should take precedence over properties set in the private template XML. - a #GtkWidget + a #GtkWidget - - Sets an input shape for this widget’s GDK window. This allows for + + Sets an input shape for this widget’s GDK window. This allows for windows which react to mouse click in a nonrectangular region, see gdk_window_input_shape_combine_region() for more information. @@ -193038,30 +138403,19 @@ gdk_window_input_shape_combine_region() for more information. - a #GtkWidget + a #GtkWidget - - shape to be added, or %NULL to remove an existing shape + + shape to be added, or %NULL to remove an existing shape - - Inserts @group into @widget. Children of @widget that implement + + Inserts @group into @widget. Children of @widget that implement #GtkActionable can then be associated with actions in @group by -setting their “action-name” to +setting their “action-name” to @prefix.`action-name`. If @group is %NULL, a previously inserted group for @name is removed @@ -193072,107 +138426,69 @@ from @widget. - a #GtkWidget + a #GtkWidget - the prefix for actions in @group + the prefix for actions in @group - - a #GActionGroup, or %NULL + + a #GActionGroup, or %NULL - Computes the intersection of a @widget’s area and @area, storing + Computes the intersection of a @widget’s area and @area, storing the intersection in @intersection, and returns %TRUE if there was -an intersection. @intersection may be %NULL if you’re only +an intersection. @intersection may be %NULL if you’re only interested in whether there was an intersection. - %TRUE if there was an intersection + %TRUE if there was an intersection - a #GtkWidget + a #GtkWidget - a rectangle + a rectangle - - rectangle to store + + rectangle to store intersection of @widget and @area - Determines whether @widget is somewhere inside @ancestor, possibly with + Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers. - %TRUE if @ancestor contains @widget as a child, + %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc. - a #GtkWidget + a #GtkWidget - another #GtkWidget + another #GtkWidget - - Whether @widget can rely on having its alpha channel + + Whether @widget can rely on having its alpha channel drawn correctly. On X11 this function returns whether a -compositing manager is running for @widget’s screen. +compositing manager is running for @widget’s screen. Please note that the semantics of this call will change in the future if used on a widget that has a composited @@ -193180,122 +138496,84 @@ window in its hierarchy (as set by gdk_window_set_composited()). Use gdk_screen_is_composited() instead. - %TRUE if the widget can rely on its alpha + %TRUE if the widget can rely on its alpha channel being drawn correctly. - a #GtkWidget + a #GtkWidget - - Determines whether @widget can be drawn to. A widget can be drawn + + Determines whether @widget can be drawn to. A widget can be drawn to if it is mapped and visible. - %TRUE if @widget is drawable, %FALSE otherwise + %TRUE if @widget is drawable, %FALSE otherwise - a #GtkWidget + a #GtkWidget - Determines if the widget is the focus widget within its + Determines if the widget is the focus widget within its toplevel. (This does not mean that the #GtkWidget:has-focus property is necessarily set; #GtkWidget:has-focus will only be set if the toplevel widget additionally has the global input focus.) - %TRUE if the widget is the focus widget. + %TRUE if the widget is the focus widget. - a #GtkWidget + a #GtkWidget - - Returns the widget’s effective sensitivity, which means + + Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive - %TRUE if the widget is effectively sensitive + %TRUE if the widget is effectively sensitive - a #GtkWidget + a #GtkWidget - - Determines whether @widget is a toplevel widget. + + Determines whether @widget is a toplevel widget. Currently only #GtkWindow and #GtkInvisible (and out-of-process #GtkPlugs) are toplevel widgets. Toplevel widgets have no parent widget. - %TRUE if @widget is a toplevel, %FALSE otherwise + %TRUE if @widget is a toplevel, %FALSE otherwise - a #GtkWidget + a #GtkWidget - - Determines whether the widget and all its parents are marked as + + Determines whether the widget and all its parents are marked as visible. This function does not check if the widget is obscured in any way. @@ -193303,26 +138581,18 @@ This function does not check if the widget is obscured in any way. See also gtk_widget_get_visible() and gtk_widget_set_visible() - %TRUE if the widget and all its parents are visible + %TRUE if the widget and all its parents are visible - a #GtkWidget + a #GtkWidget - - This function should be called whenever keyboard navigation within + + This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of @@ -193334,7 +138604,7 @@ focus to. When %FALSE is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling -gtk_widget_child_focus() on the widget’s toplevel. +gtk_widget_child_focus() on the widget’s toplevel. The default ::keynav-failed handler returns %FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other @@ -193351,33 +138621,24 @@ entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys. - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - a #GtkWidget + a #GtkWidget - direction of focus movement + direction of focus movement - - Lists the closures used by @widget for accelerator group connections + + Lists the closures used by @widget for accelerator group connections with gtk_accel_group_connect_by_path() or gtk_accel_group_connect(). The closures can be used to monitor accelerator changes on @widget, by connecting to the @GtkAccelGroup::accel-changed signal of the @@ -193385,9 +138646,7 @@ by connecting to the @GtkAccelGroup::accel-changed signal of the gtk_accel_group_from_accel_closure(). - + a newly allocated #GList of closures @@ -193395,44 +138654,30 @@ gtk_accel_group_from_accel_closure(). - widget to list accelerator closures for + widget to list accelerator closures for - - Retrieves a %NULL-terminated array of strings containing the prefixes of + + Retrieves a %NULL-terminated array of strings containing the prefixes of #GActionGroup's available to @widget. - a %NULL-terminated array of strings. + a %NULL-terminated array of strings. - A #GtkWidget + A #GtkWidget - - Returns a newly allocated list of the widgets, normally labels, for + + Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, gtk_label_set_mnemonic_widget()). @@ -193444,9 +138689,7 @@ must call `g_list_foreach (result, widgets afterwards. - the list of + the list of mnemonic labels; free this list with g_list_free() when you are done with it. @@ -193455,72 +138698,52 @@ widgets afterwards. - a #GtkWidget + a #GtkWidget - This function is only for use in widget implementations. Causes -a widget to be mapped if it isn’t already. + This function is only for use in widget implementations. Causes +a widget to be mapped if it isn’t already. - a #GtkWidget + a #GtkWidget - - Emits the #GtkWidget::mnemonic-activate signal. + + Emits the #GtkWidget::mnemonic-activate signal. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - a #GtkWidget + a #GtkWidget - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic - - Sets the base color for a widget in a particular state. + + Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see gtk_widget_modify_text()) for widgets such as #GtkEntry and #GtkTextView. See also gtk_widget_modify_style(). -> Note that “no window” widgets (which have the %GTK_NO_WINDOW -> flag set) draw on their parent container’s window and thus may +> Note that “no window” widgets (which have the %GTK_NO_WINDOW +> flag set) draw on their parent container’s window and thus may > not draw any background themselves. This is the case for e.g. > #GtkLabel. > @@ -193535,43 +138758,29 @@ and #GtkTextView. See also gtk_widget_modify_style(). - a #GtkWidget + a #GtkWidget - the state for which to set the base color + the state for which to set the base color - - the color to assign (does not need to + + the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_base(). - - Sets the background color for a widget in a particular state. + + Sets the background color for a widget in a particular state. All other style values are left untouched. See also gtk_widget_modify_style(). -> Note that “no window” widgets (which have the %GTK_NO_WINDOW -> flag set) draw on their parent container’s window and thus may +> Note that “no window” widgets (which have the %GTK_NO_WINDOW +> flag set) draw on their parent container’s window and thus may > not draw any background themselves. This is the case for e.g. > #GtkLabel. > @@ -193586,38 +138795,23 @@ See also gtk_widget_modify_style(). - a #GtkWidget + a #GtkWidget - the state for which to set the background color + the state for which to set the background color - - the color to assign (does not need + + the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_bg(). - - Sets the cursor color to use in a widget, overriding the #GtkWidget + + Sets the cursor color to use in a widget, overriding the #GtkWidget cursor-color and secondary-cursor-color style properties. @@ -193630,42 +138824,25 @@ See also gtk_widget_modify_style(). - a #GtkWidget + a #GtkWidget - - the color to use for primary cursor (does not + + the color to use for primary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor(). - - the color to use for secondary cursor (does + + the color to use for secondary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor(). - - Sets the foreground color for a widget in a particular state. + + Sets the foreground color for a widget in a particular state. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -193676,37 +138853,23 @@ See also gtk_widget_modify_style(). - a #GtkWidget + a #GtkWidget - the state for which to set the foreground color + the state for which to set the foreground color - - the color to assign (does not need to be allocated), + + the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_fg(). - - Sets the font to use for a widget. + + Sets the font to use for a widget. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -193717,30 +138880,18 @@ See also gtk_widget_modify_style(). - a #GtkWidget + a #GtkWidget - - the font description to use, or %NULL + + the font description to use, or %NULL to undo the effect of previous calls to gtk_widget_modify_font() - - Modifies style values on the widget. + + Modifies style values on the widget. Modifications made using this technique take precedence over style values set via an RC file, however, they will be overridden @@ -193765,26 +138916,17 @@ effect with the initial modifications. - a #GtkWidget + a #GtkWidget - the #GtkRcStyle-struct holding the style modifications + the #GtkRcStyle-struct holding the style modifications - - Sets the text color for a widget in a particular state. + + Sets the text color for a widget in a particular state. All other style values are left untouched. The text color is the foreground color used along with the @@ -193798,38 +138940,23 @@ See also gtk_widget_modify_style(). - a #GtkWidget + a #GtkWidget - the state for which to set the text color + the state for which to set the text color - - the color to assign (does not need to + + the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_text(). - - Sets the background color to use for a widget. + + Sets the background color to use for a widget. All other style values are left untouched. See gtk_widget_override_color(). @@ -193845,37 +138972,22 @@ See gtk_widget_override_color(). - a #GtkWidget + a #GtkWidget - the state for which to set the background color + the state for which to set the background color - - the color to assign, or %NULL to undo the effect + + the color to assign, or %NULL to undo the effect of previous calls to gtk_widget_override_background_color() - - Sets the color to use for a widget. + + Sets the color to use for a widget. All other style values are left untouched. @@ -193893,7 +139005,7 @@ widget/container implementation through gtk_style_context_add_class(). This way, your widget library can install a #GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order to provide a default styling for those widgets that need so, and -this theming may fully overridden by the user’s theme. +this theming may fully overridden by the user’s theme. Note that for complex widgets this may bring in undesired results (such as uniform background color everywhere), in @@ -193907,37 +139019,22 @@ priority. - a #GtkWidget + a #GtkWidget - the state for which to set the color + the state for which to set the color - - the color to assign, or %NULL to undo the effect + + the color to assign, or %NULL to undo the effect of previous calls to gtk_widget_override_color() - - Sets the cursor color to use in a widget, overriding the + + Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -193954,43 +139051,25 @@ so the alpha value in @primary and @secondary will be ignored. - a #GtkWidget + a #GtkWidget - - the color to use for primary cursor (does not need to be + + the color to use for primary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_override_cursor(). - - the color to use for secondary cursor (does not + + the color to use for secondary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_override_cursor(). - - Sets the font to use for a widget. All other style values are + + Sets the font to use for a widget. All other style values are left untouched. See gtk_widget_override_color(). This function is not useful in the context of CSS-based rendering. If you wish to change the font a widget uses to render its text @@ -194002,32 +139081,18 @@ left untouched. See gtk_widget_override_color(). - a #GtkWidget + a #GtkWidget - - the font description to use, or %NULL to undo + + the font description to use, or %NULL to undo the effect of previous calls to gtk_widget_override_font() - + - - Sets a symbolic color for a widget. + + Sets a symbolic color for a widget. All other style values are left untouched. See gtk_widget_override_color() for overriding the foreground @@ -194042,48 +139107,34 @@ or background color. - a #GtkWidget + a #GtkWidget - the name of the symbolic color to modify + the name of the symbolic color to modify - - the color to assign (does not need + + the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to gtk_widget_override_symbolic_color() - - Obtains the full path to @widget. The path is simply the name of a + + Obtains the full path to @widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from gtk_widget_get_name(). Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the -widget by default (e.g. “GtkButton”) or can be set to an +widget by default (e.g. “GtkButton”) or can be set to an application-specific value with gtk_widget_set_name(). By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. @path_reversed_p fills in the path in reverse order, -i.e. starting with @widget’s name instead of starting with the name -of @widget’s outermost ancestor. +i.e. starting with @widget’s name instead of starting with the name +of @widget’s outermost ancestor. Use gtk_widget_get_path() instead @@ -194091,55 +139142,28 @@ of @widget’s outermost ancestor. - a #GtkWidget + a #GtkWidget - - location to store length of the path, + + location to store length of the path, or %NULL - - location to store allocated path string, + + location to store allocated path string, or %NULL - - location to store allocated reverse + + location to store allocated reverse path string, or %NULL - - This function is only for use in widget implementations. + + This function is only for use in widget implementations. Flags the widget for a rerun of the GtkWidgetClass::size_allocate function. Use this function instead of gtk_widget_queue_resize() @@ -194153,18 +139177,13 @@ An example user of this function is gtk_widget_set_halign(). - a #GtkWidget + a #GtkWidget - - Mark @widget as needing to recompute its expand flags. Call + + Mark @widget as needing to recompute its expand flags. Call this function when setting legacy expand child properties on the child of a container. @@ -194175,17 +139194,13 @@ See gtk_widget_compute_expand(). - a #GtkWidget + a #GtkWidget - Equivalent to calling gtk_widget_queue_draw_area() for the + Equivalent to calling gtk_widget_queue_draw_area() for the entire area of a widget. @@ -194193,17 +139208,13 @@ entire area of a widget. - a #GtkWidget + a #GtkWidget - Convenience function that calls gtk_widget_queue_draw_region() on + Convenience function that calls gtk_widget_queue_draw_region() on the region created from the given coordinates. The region here is specified in widget coordinates. @@ -194220,44 +139231,30 @@ nothing. Negative values for @width and @height are not allowed. - a #GtkWidget + a #GtkWidget - x coordinate of upper-left corner of rectangle to redraw + x coordinate of upper-left corner of rectangle to redraw - y coordinate of upper-left corner of rectangle to redraw + y coordinate of upper-left corner of rectangle to redraw - width of region to draw + width of region to draw - height of region to draw + height of region to draw - - Invalidates the area of @widget defined by @region by calling -gdk_window_invalidate_region() on the widget’s window and all its + + Invalidates the area of @widget defined by @region by calling +gdk_window_invalidate_region() on the widget’s window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been @@ -194272,27 +139269,21 @@ implementations. You might also use it to schedule a redraw of a - a #GtkWidget + a #GtkWidget - region to draw + region to draw - This function is only for use in widget implementations. + This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a #GtkLabel, #GtkLabel -queues a resize to ensure there’s enough space for the new text. +queues a resize to ensure there’s enough space for the new text. Note that you cannot call gtk_widget_queue_resize() on a widget from inside its implementation of the GtkWidgetClass::size_allocate @@ -194304,19 +139295,13 @@ GtkWidgetClass::size_allocate will be silently ignored. - a #GtkWidget + a #GtkWidget - - This function works like gtk_widget_queue_resize(), + + This function works like gtk_widget_queue_resize(), except that the widget is not invalidated. @@ -194324,30 +139309,26 @@ except that the widget is not invalidated. - a #GtkWidget + a #GtkWidget - Creates the GDK (windowing system) resources associated with a + Creates the GDK (windowing system) resources associated with a widget. For example, @widget->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all -the widget’s parent widgets to be realized; calling -gtk_widget_realize() realizes the widget’s parents in addition to +the widget’s parent widgets to be realized; calling +gtk_widget_realize() realizes the widget’s parents in addition to @widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen. This function is primarily used in widget implementations, and -isn’t very useful otherwise. Many times when you think you might +isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as #GtkWidget::draw. Or simply g_signal_connect () to the @@ -194358,43 +139339,30 @@ called after the widget is realized automatically, such as - a #GtkWidget + a #GtkWidget - - Computes the intersection of a @widget’s area and @region, returning + + Computes the intersection of a @widget’s area and @region, returning the intersection. The result may be empty, use cairo_region_is_empty() to check. Use gtk_widget_get_allocation() and cairo_region_intersect_rectangle() to get the same behavior. - A newly allocated region holding the intersection of @widget + A newly allocated region holding the intersection of @widget and @region. - a #GtkWidget + a #GtkWidget - a #cairo_region_t, in the same coordinate system as + a #cairo_region_t, in the same coordinate system as @widget->allocation. That is, relative to @widget->window for widgets which return %FALSE from gtk_widget_get_has_window(); relative to the parent window of @widget->window otherwise. @@ -194402,12 +139370,8 @@ check. - - Registers a #GdkWindow with the widget and sets it up so that + + Registers a #GdkWindow with the widget and sets it up so that the widget receives events for it. Call gtk_widget_unregister_window() when destroying the window. @@ -194421,65 +139385,44 @@ transparency might not work perfectly. - a #GtkWidget + a #GtkWidget - a #GdkWindow + a #GdkWindow - - Removes an accelerator from @widget, previously installed with + + Removes an accelerator from @widget, previously installed with gtk_widget_add_accelerator(). - whether an accelerator was installed and could be removed + whether an accelerator was installed and could be removed - widget to install an accelerator on + widget to install an accelerator on - accel group for this widget + accel group for this widget - GDK keyval of the accelerator + GDK keyval of the accelerator - modifier key combination of the accelerator + modifier key combination of the accelerator - - Removes a widget from the list of mnemonic labels for + + Removes a widget from the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). The widget must have previously been added to the list with gtk_widget_add_mnemonic_label(). @@ -194489,26 +139432,18 @@ gtk_widget_add_mnemonic_label(). - a #GtkWidget + a #GtkWidget - a #GtkWidget that was previously set as a mnemonic label for + a #GtkWidget that was previously set as a mnemonic label for @widget with gtk_widget_add_mnemonic_label(). - - Removes a tick callback previously registered with + + Removes a tick callback previously registered with gtk_widget_add_tick_callback(). @@ -194516,26 +139451,17 @@ gtk_widget_add_tick_callback(). - a #GtkWidget + a #GtkWidget - an id returned by gtk_widget_add_tick_callback() + an id returned by gtk_widget_add_tick_callback() - - A convenience function that uses the theme settings for @widget + + A convenience function that uses the theme settings for @widget to look up @stock_id and render it to a pixbuf. @stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size such as #GTK_ICON_SIZE_MENU. @detail should be a @@ -194549,52 +139475,33 @@ freed after use with g_object_unref(). Use gtk_widget_render_icon_pixbuf() instead. - a new pixbuf, or %NULL if the - stock ID wasn’t known + a new pixbuf, or %NULL if the + stock ID wasn’t known - a #GtkWidget + a #GtkWidget - a stock ID + a stock ID - a stock size (#GtkIconSize). A size of `(GtkIconSize)-1` - means render at the size of the source and don’t scale (if there are + a stock size (#GtkIconSize). A size of `(GtkIconSize)-1` + means render at the size of the source and don’t scale (if there are multiple source sizes, GTK+ picks one of the available sizes). - + - - render detail to pass to theme engine + + render detail to pass to theme engine - - A convenience function that uses the theme engine and style + + A convenience function that uses the theme engine and style settings for @widget to look up @stock_id and render it to a pixbuf. @stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size @@ -194606,42 +139513,29 @@ after use with g_object_unref(). Use gtk_icon_theme_load_icon() instead. - a new pixbuf, or %NULL if the - stock ID wasn’t known + a new pixbuf, or %NULL if the + stock ID wasn’t known - a #GtkWidget + a #GtkWidget - a stock ID + a stock ID - a stock size (#GtkIconSize). A size of `(GtkIconSize)-1` - means render at the size of the source and don’t scale (if there are + a stock size (#GtkIconSize). A size of `(GtkIconSize)-1` + means render at the size of the source and don’t scale (if there are multiple source sizes, GTK+ picks one of the available sizes). - + - - Moves a widget from one #GtkContainer to another, handling reference + + Moves a widget from one #GtkContainer to another, handling reference count issues to avoid destroying the widget. Use gtk_container_remove() and gtk_container_add(). @@ -194650,26 +139544,17 @@ count issues to avoid destroying the widget. - a #GtkWidget + a #GtkWidget - a #GtkContainer to move the widget into + a #GtkContainer to move the widget into - - Reset the styles of @widget and all descendents, so when + + Reset the styles of @widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings. @@ -194681,19 +139566,13 @@ This function is not useful for applications. - a #GtkWidget. + a #GtkWidget. - - Updates the style context of @widget and all descendants + + Updates the style context of @widget and all descendants by updating its widget path. #GtkContainers may want to use this on a child when reordering it in a way that a different style might apply to it. See also gtk_container_get_path_for_child(). @@ -194703,20 +139582,13 @@ style might apply to it. See also gtk_container_get_path_for_child(). - a #GtkWidget + a #GtkWidget - - Very rarely-used function. This function is used to emit + + Very rarely-used function. This function is used to emit an expose event on a widget. This function is not normally used directly. The only time it is used is when propagating an expose event to a windowless child widget (gtk_widget_get_has_window() is %FALSE), @@ -194732,38 +139604,28 @@ with a call to gdk_window_process_updates(). implementations - return from the event signal emission (%TRUE if + return from the event signal emission (%TRUE if the event was handled) - a #GtkWidget + a #GtkWidget - a expose #GdkEvent + a expose #GdkEvent - - Sends the focus change @event to @widget + + Sends the focus change @event to @widget This function is not meant to be used by applications. The only time it should be used is when it is necessary for a #GtkWidget to assign focus to a widget that is semantically owned by the first widget even though -it’s not a direct child - for instance, a search entry in a floating +it’s not a direct child - for instance, a search entry in a floating window similar to the quick search in #GtkTreeView. An example of its usage is: @@ -194783,31 +139645,23 @@ An example of its usage is: ]| - the return value from the event signal emission: %TRUE + the return value from the event signal emission: %TRUE if the event was handled, and %FALSE otherwise - a #GtkWidget + a #GtkWidget - a #GdkEvent of type GDK_FOCUS_CHANGE + a #GdkEvent of type GDK_FOCUS_CHANGE - Given an accelerator group, @accel_group, and an accelerator path, + Given an accelerator group, @accel_group, and an accelerator path, @accel_path, sets up an accelerator in @accel_group so whenever the key binding that is defined for @accel_path is pressed, @widget will be activated. This removes any accelerators (for any @@ -194821,7 +139675,7 @@ be used by a menu creation system like #GtkUIManager. If you use #GtkUIManager, setting up accelerator paths will be done automatically. -Even when you you aren’t using #GtkUIManager, if you only want to +Even when you you aren’t using #GtkUIManager, if you only want to set up accelerators on menu items gtk_menu_item_set_accel_path() provides a somewhat more convenient interface. @@ -194834,41 +139688,25 @@ g_intern_static_string(). - a #GtkWidget + a #GtkWidget - - path used to look up the accelerator + + path used to look up the accelerator - - a #GtkAccelGroup. + + a #GtkAccelGroup. - - Sets the widget’s allocation. This should not be used -directly, but from within a widget’s size_allocate method. + + Sets the widget’s allocation. This should not be used +directly, but from within a widget’s size_allocate method. -The allocation set should be the “adjusted” or actual -allocation. If you’re implementing a #GtkContainer, you want to use +The allocation set should be the “adjusted” or actual +allocation. If you’re implementing a #GtkContainer, you want to use gtk_widget_size_allocate() instead of gtk_widget_set_allocation(). The GtkWidgetClass::adjust_size_allocation virtual method adjusts the allocation inside gtk_widget_size_allocate() to create an adjusted @@ -194879,24 +139717,17 @@ allocation. - a #GtkWidget + a #GtkWidget - a pointer to a #GtkAllocation to copy from + a pointer to a #GtkAllocation to copy from - - Sets whether the application intends to draw on the widget in + + Sets whether the application intends to draw on the widget in an #GtkWidget::draw handler. This is a hint to the widget and does not affect the behavior of @@ -194913,52 +139744,36 @@ Note that the background is still drawn when the widget is mapped. - a #GtkWidget + a #GtkWidget - %TRUE if the application will paint on the widget + %TRUE if the application will paint on the widget - - Specifies whether @widget can be a default widget. See + + Specifies whether @widget can be a default widget. See gtk_widget_grab_default() for details about the meaning of -“default”. +“default”. - a #GtkWidget + a #GtkWidget - whether or not @widget can be a default widget. + whether or not @widget can be a default widget. - - Specifies whether @widget can own the input focus. See + + Specifies whether @widget can own the input focus. See gtk_widget_grab_focus() for actually setting the input focus on a widget. @@ -194967,24 +139782,17 @@ widget. - a #GtkWidget + a #GtkWidget - whether or not @widget can own the input focus. + whether or not @widget can own the input focus. - - Sets whether @widget should be mapped along with its when its parent + + Sets whether @widget should be mapped along with its when its parent is mapped and @widget has been shown with gtk_widget_show(). The child visibility can be set for widget before it is added to @@ -195007,26 +139815,18 @@ never should be called by an application. - a #GtkWidget + a #GtkWidget - if %TRUE, @widget should be mapped along with its parent. + if %TRUE, @widget should be mapped along with its parent. - - Sets the widget’s clip. This must not be used directly, -but from within a widget’s size_allocate method. + + Sets the widget’s clip. This must not be used directly, +but from within a widget’s size_allocate method. It must be called after gtk_widget_set_allocation() (or after chaining up to the parent class), because that function resets the clip. @@ -195041,53 +139841,36 @@ the clip will be set to @widget's allocation. - a #GtkWidget + a #GtkWidget - a pointer to a #GtkAllocation to copy from + a pointer to a #GtkAllocation to copy from - - Sets a widgets composite name. The widget must be + + Sets a widgets composite name. The widget must be a composite child of its parent; see gtk_widget_push_composite_child(). - Use gtk_widget_class_set_template(), or don’t use this API at all. + Use gtk_widget_class_set_template(), or don’t use this API at all. - a #GtkWidget. + a #GtkWidget. - the name to set + the name to set - - Enables or disables a #GdkDevice to interact with @widget + + Enables or disables a #GdkDevice to interact with @widget and all its children. It does so by descending through the #GdkWindow hierarchy @@ -195099,38 +139882,28 @@ and enabling the same mask that is has for core events - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - whether to enable the device + whether to enable the device - - Sets the device event mask (see #GdkEventMask) for a widget. The event + + Sets the device event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive from @device. Keep in mind that different widgets have different default event masks, and by -changing the event mask you may disrupt a widget’s functionality, +changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk_widget_add_device_events() for widgets that are already realized, or if you want to preserve the existing event -mask. This function can’t be used with windowless widgets (which return +mask. This function can’t be used with windowless widgets (which return %FALSE from gtk_widget_get_has_window()); to get events on those widgets, place them inside a #GtkEventBox and receive events on the event box. @@ -195140,29 +139913,21 @@ and receive events on the event box. - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - event mask + event mask - Sets the reading direction on a particular widget. This direction + Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order @@ -195180,36 +139945,27 @@ set by gtk_widget_set_default_direction() will be used. - a #GtkWidget + a #GtkWidget - the new direction + the new direction - - Widgets are double buffered by default; you can use this function -to turn off the buffering. “Double buffered” simply means that + + Widgets are double buffered by default; you can use this function +to turn off the buffering. “Double buffered” simply means that gdk_window_begin_draw_frame() and gdk_window_end_draw_frame() are called automatically around expose events sent to the widget. gdk_window_begin_draw_frame() diverts all drawing to a widget's window to an offscreen buffer, and gdk_window_end_draw_frame() draws the buffer to the screen. The result is that users see the window -update in one smooth step, and don’t see individual graphics +update in one smooth step, and don’t see individual graphics primitives being rendered. -In very simple terms, double buffered widgets don’t flicker, +In very simple terms, double buffered widgets don’t flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing. @@ -195233,30 +139989,24 @@ It should not be used in newly written code. - a #GtkWidget + a #GtkWidget - %TRUE to double-buffer a widget + %TRUE to double-buffer a widget - Sets the event mask (see #GdkEventMask) for a widget. The event + Sets the event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by -changing the event mask you may disrupt a widget’s functionality, +changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk_widget_add_events() for widgets that are already realized, or if you want to preserve the existing event -mask. This function can’t be used with widgets that have no window. +mask. This function can’t be used with widgets that have no window. (See gtk_widget_get_has_window()). To get events on those widgets, place them inside a #GtkEventBox and receive events on the event box. @@ -195266,27 +140016,19 @@ box. - a #GtkWidget + a #GtkWidget - event mask + event mask - - Sets whether the widget should grab focus when it is clicked with the mouse. + + Sets whether the widget should grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where -you don’t want the keyboard focus removed from the main area of the +you don’t want the keyboard focus removed from the main area of the application. @@ -195294,25 +140036,17 @@ application. - a #GtkWidget + a #GtkWidget - whether the widget should grab focus when clicked with the mouse + whether the widget should grab focus when clicked with the mouse - - Sets the font map to use for Pango rendering. When not set, the widget + + Sets the font map to use for Pango rendering. When not set, the widget will inherit the font map from its parent. @@ -195320,29 +140054,18 @@ will inherit the font map from its parent. - a #GtkWidget + a #GtkWidget - - a #PangoFontMap, or %NULL to unset any previously + + a #PangoFontMap, or %NULL to unset any previously set font map - - Sets the #cairo_font_options_t used for Pango rendering in this widget. + + Sets the #cairo_font_options_t used for Pango rendering in this widget. When not set, the default font options for the #GdkScreen will be used. @@ -195350,28 +140073,18 @@ When not set, the default font options for the #GdkScreen will be used. - a #GtkWidget + a #GtkWidget - - a #cairo_font_options_t, or %NULL to unset any + + a #cairo_font_options_t, or %NULL to unset any previously set default font options. - + - Sets the horizontal alignment of @widget. + Sets the horizontal alignment of @widget. See the #GtkWidget:halign property. @@ -195379,25 +140092,17 @@ See the #GtkWidget:halign property. - a #GtkWidget + a #GtkWidget - the horizontal alignment + the horizontal alignment - - Sets the has-tooltip property on @widget to @has_tooltip. See + + Sets the has-tooltip property on @widget to @has_tooltip. See #GtkWidget:has-tooltip for more information. @@ -195405,28 +140110,20 @@ See the #GtkWidget:halign property. - a #GtkWidget + a #GtkWidget - whether or not @widget has a tooltip. + whether or not @widget has a tooltip. - - Specifies whether @widget has a #GdkWindow of its own. Note that -all realized widgets have a non-%NULL “window” pointer + + Specifies whether @widget has a #GdkWindow of its own. Note that +all realized widgets have a non-%NULL “window” pointer (gtk_widget_get_window() never returns a %NULL window when a widget -is realized), but for many of them it’s actually the #GdkWindow of +is realized), but for many of them it’s actually the #GdkWindow of one of its parent widgets. Widgets that do not create a %window for themselves in #GtkWidget::realize must announce this by calling this function with @has_window = %FALSE. @@ -195439,23 +140136,17 @@ and they should call it in their init() function. - a #GtkWidget + a #GtkWidget - whether or not @widget has a window. + whether or not @widget has a window. - Sets whether the widget would like any available extra horizontal + Sets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to @@ -195478,7 +140169,7 @@ automatic expand behavior. This function forces the widget to expand or not to expand, regardless of children. The override occurs because gtk_widget_set_hexpand() sets the hexpand-set property (see -gtk_widget_set_hexpand_set()) which causes the widget’s hexpand +gtk_widget_set_hexpand_set()) which causes the widget’s hexpand value to be used, rather than looking at children and widget state. @@ -195486,23 +140177,17 @@ value to be used, rather than looking at children and widget state. - the widget + the widget - whether to expand + whether to expand - Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will + Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will be used. The hexpand-set property will be set automatically when you call @@ -195515,7 +140200,7 @@ expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand. -There are few reasons to use this function, but it’s here +There are few reasons to use this function, but it’s here for completeness and consistency. @@ -195523,53 +140208,37 @@ for completeness and consistency. - the widget + the widget - value for hexpand-set property + value for hexpand-set property - - Marks the widget as being mapped. + + Marks the widget as being mapped. This function should only ever be called in a derived widget's -“map” or “unmap” implementation. +“map” or “unmap” implementation. - a #GtkWidget + a #GtkWidget - %TRUE to mark the widget as mapped + %TRUE to mark the widget as mapped - - Sets the bottom margin of @widget. + + Sets the bottom margin of @widget. See the #GtkWidget:margin-bottom property. @@ -195577,25 +140246,17 @@ See the #GtkWidget:margin-bottom property. - a #GtkWidget + a #GtkWidget - the bottom margin + the bottom margin - - Sets the end margin of @widget. + + Sets the end margin of @widget. See the #GtkWidget:margin-end property. @@ -195603,27 +140264,17 @@ See the #GtkWidget:margin-end property. - a #GtkWidget + a #GtkWidget - the end margin + the end margin - - Sets the left margin of @widget. + + Sets the left margin of @widget. See the #GtkWidget:margin-left property. Use gtk_widget_set_margin_start() instead. @@ -195632,27 +140283,17 @@ See the #GtkWidget:margin-left property. - a #GtkWidget + a #GtkWidget - the left margin + the left margin - - Sets the right margin of @widget. + + Sets the right margin of @widget. See the #GtkWidget:margin-right property. Use gtk_widget_set_margin_end() instead. @@ -195661,25 +140302,17 @@ See the #GtkWidget:margin-right property. - a #GtkWidget + a #GtkWidget - the right margin + the right margin - - Sets the start margin of @widget. + + Sets the start margin of @widget. See the #GtkWidget:margin-start property. @@ -195687,25 +140320,17 @@ See the #GtkWidget:margin-start property. - a #GtkWidget + a #GtkWidget - the start margin + the start margin - - Sets the top margin of @widget. + + Sets the top margin of @widget. See the #GtkWidget:margin-top property. @@ -195713,23 +140338,17 @@ See the #GtkWidget:margin-top property. - a #GtkWidget + a #GtkWidget - the top margin + the top margin - Widgets can be named, which allows you to refer to them from a + Widgets can be named, which allows you to refer to them from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for #GtkStyleContext). @@ -195744,25 +140363,17 @@ of alphanumeric symbols, dashes and underscores will suffice. - a #GtkWidget + a #GtkWidget - name for the widget + name for the widget - - Sets the #GtkWidget:no-show-all property, which determines whether + + Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() will affect this widget. This is mostly for use in constructing widget hierarchies with externally @@ -195773,25 +140384,17 @@ controlled visibility, see #GtkUIManager. - a #GtkWidget + a #GtkWidget - the new value for the “no-show-all” property + the new value for the “no-show-all” property - - Request the @widget to be rendered partially transparent, + + Request the @widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Opacity values are clamped to the [0,1] range.). This works on both toplevel widget, and child widgets, although there @@ -195800,10 +140403,10 @@ are some limitations: For toplevel widgets this depends on the capabilities of the windowing system. On X11 this has any effect only on X screens with a compositing manager running. See gtk_widget_is_composited(). On Windows it should work -always, although setting a window’s opacity after the window has been +always, although setting a window’s opacity after the window has been shown causes it to flicker once on Windows. -For child widgets it doesn’t work if any affected widget has a native window, or +For child widgets it doesn’t work if any affected widget has a native window, or disables double buffering. @@ -195811,23 +140414,17 @@ disables double buffering. - a #GtkWidget + a #GtkWidget - desired opacity, between 0 and 1 + desired opacity, between 0 and 1 - This function is useful only when implementing subclasses of + This function is useful only when implementing subclasses of #GtkContainer. Sets the container as the parent of @widget, and takes care of some details such as updating the state and style of the child @@ -195839,24 +140436,17 @@ gtk_widget_unparent(). - a #GtkWidget + a #GtkWidget - parent container + parent container - - Sets a non default parent window for @widget. + + Sets a non default parent window for @widget. For #GtkWindow classes, setting a @parent_window effects whether the window is a toplevel window or can be embedded into other @@ -195870,84 +140460,61 @@ window is realized. - a #GtkWidget. + a #GtkWidget. - the new parent window. + the new parent window. - - Marks the widget as being realized. This function must only be + + Marks the widget as being realized. This function must only be called after all #GdkWindows for the @widget have been created and registered. This function should only ever be called in a derived widget's -“realize” or “unrealize” implementation. +“realize” or “unrealize” implementation. - a #GtkWidget + a #GtkWidget - %TRUE to mark the widget as realized + %TRUE to mark the widget as realized - - Specifies whether @widget will be treated as the default widget + + Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. See gtk_widget_grab_default() for details about the meaning of -“default”. +“default”. - a #GtkWidget + a #GtkWidget - whether or not @widget can be a default widget. + whether or not @widget can be a default widget. - - Sets whether the entire widget is queued for drawing when its size + + Sets whether the entire widget is queued for drawing when its size allocation changes. By default, this setting is %TRUE and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this @@ -195956,7 +140523,7 @@ setting off will improve performance. Note that for widgets where gtk_widget_get_has_window() is %FALSE setting this flag to %FALSE turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to -allow containers that don’t draw anything to avoid excess +allow containers that don’t draw anything to avoid excess invalidations. If you set this flag on a widget with no window that does draw on @widget->window, you are responsible for invalidating both the old and new allocation of the @@ -195968,15 +140535,11 @@ regions newly when the widget increases size. - a #GtkWidget + a #GtkWidget - if %TRUE, the entire widget will be redrawn + if %TRUE, the entire widget will be redrawn when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn. @@ -195984,36 +140547,27 @@ regions newly when the widget increases size. - Sets the sensitivity of a widget. A widget is sensitive if the user -can interact with it. Insensitive widgets are “grayed out” and the -user can’t interact with them. Insensitive widgets are known as -“inactive”, “disabled”, or “ghosted” in some other toolkits. + Sets the sensitivity of a widget. A widget is sensitive if the user +can interact with it. Insensitive widgets are “grayed out” and the +user can’t interact with them. Insensitive widgets are known as +“inactive”, “disabled”, or “ghosted” in some other toolkits. - a #GtkWidget + a #GtkWidget - %TRUE to make the widget sensitive + %TRUE to make the widget sensitive - - Sets the minimum size of a widget; that is, the widget’s size + + Sets the minimum size of a widget; that is, the widget’s size request will be at least @width by @height. You can use this function to force a widget to be larger than it normally would be. @@ -196037,7 +140591,7 @@ its requested size, and in many cases a widget may be allocated more space than it requested. If the size request in a given direction is -1 (unset), then -the “natural” size request of the widget will be used instead. +the “natural” size request of the widget will be used instead. The size request set here does not include any margin from the #GtkWidget properties margin-left, margin-right, margin-top, and @@ -196049,32 +140603,21 @@ or border properties set by any subclass of #GtkWidget. - a #GtkWidget + a #GtkWidget - width @widget should request, or -1 to unset + width @widget should request, or -1 to unset - height @widget should request, or -1 to unset + height @widget should request, or -1 to unset - - This function is for use in widget implementations. Sets the state + + This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as gtk_widget_set_sensitive(). Use gtk_widget_set_state_flags() instead. @@ -196084,25 +140627,17 @@ the state using wrapper functions such as gtk_widget_set_sensitive(). - a #GtkWidget + a #GtkWidget - new state for @widget + new state for @widget - - This function is for use in widget implementations. Turns on flag + + This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.). This function accepts the values %GTK_STATE_FLAG_DIR_LTR and @@ -196121,32 +140656,21 @@ gtk_widget_is_sensitive() will make use of these. - a #GtkWidget + a #GtkWidget - State flags to turn on + State flags to turn on - Whether to clear state before turning on @flags + Whether to clear state before turning on @flags - - Used to set the #GtkStyle for a widget (@widget->style). Since + + Used to set the #GtkStyle for a widget (@widget->style). Since GTK 3, this function does nothing, the passed in style is ignored. Use #GtkStyleContext instead @@ -196155,30 +140679,19 @@ GTK 3, this function does nothing, the passed in style is ignored. - a #GtkWidget + a #GtkWidget - - a #GtkStyle, or %NULL to remove the effect + + a #GtkStyle, or %NULL to remove the effect of a previous call to gtk_widget_set_style() and go back to the default style - - Enables or disables multiple pointer awareness. If this setting is %TRUE, + + Enables or disables multiple pointer awareness. If this setting is %TRUE, @widget will start receiving multiple, per device enter/leave events. Note that if custom #GdkWindows are created in #GtkWidget::realize, gdk_window_set_support_multidevice() will have to be called manually on them. @@ -196188,25 +140701,17 @@ gdk_window_set_support_multidevice() will have to be called manually on them. - a #GtkWidget + a #GtkWidget - %TRUE to support input from multiple devices. + %TRUE to support input from multiple devices. - - Sets @markup as the contents of the tooltip, which is marked up with + + Sets @markup as the contents of the tooltip, which is marked up with the [Pango text markup language][PangoMarkupFormat]. This function will take care of setting #GtkWidget:has-tooltip to %TRUE @@ -196220,28 +140725,17 @@ gtk_tooltip_set_markup(). - a #GtkWidget + a #GtkWidget - - the contents of the tooltip for @widget, or %NULL + + the contents of the tooltip for @widget, or %NULL - - Sets @text as the contents of the tooltip. This function will take + + Sets @text as the contents of the tooltip. This function will take care of setting #GtkWidget:has-tooltip to %TRUE and of the default handler for the #GtkWidget::query-tooltip signal. @@ -196252,28 +140746,17 @@ See also the #GtkWidget:tooltip-text property and gtk_tooltip_set_text(). - a #GtkWidget + a #GtkWidget - - the contents of the tooltip for @widget + + the contents of the tooltip for @widget - - Replaces the default window used for displaying + + Replaces the default window used for displaying tooltips with @custom_window. GTK+ will take care of showing and hiding @custom_window at the right moment, to behave likewise as the default tooltip window. If @custom_window is %NULL, the default @@ -196284,26 +140767,17 @@ tooltip window will be used. - a #GtkWidget + a #GtkWidget - - a #GtkWindow, or %NULL + + a #GtkWindow, or %NULL - Sets the vertical alignment of @widget. + Sets the vertical alignment of @widget. See the #GtkWidget:valign property. @@ -196311,23 +140785,17 @@ See the #GtkWidget:valign property. - a #GtkWidget + a #GtkWidget - the vertical alignment + the vertical alignment - Sets whether the widget would like any available extra vertical + Sets whether the widget would like any available extra vertical space. See gtk_widget_set_hexpand() for more detail. @@ -196337,23 +140805,17 @@ See gtk_widget_set_hexpand() for more detail. - the widget + the widget - whether to expand + whether to expand - Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will + Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will be used. See gtk_widget_set_hexpand_set() for more detail. @@ -196363,26 +140825,18 @@ See gtk_widget_set_hexpand_set() for more detail. - the widget + the widget - value for vexpand-set property + value for vexpand-set property - - Sets the visibility state of @widget. Note that setting this to -%TRUE doesn’t mean the widget is actually viewable, see + + Sets the visibility state of @widget. Note that setting this to +%TRUE doesn’t mean the widget is actually viewable, see gtk_widget_get_visible(). This function simply calls gtk_widget_show() or gtk_widget_hide() @@ -196394,23 +140848,17 @@ some condition. - a #GtkWidget + a #GtkWidget - whether the widget should be shown or not + whether the widget should be shown or not - Sets the visual that should be used for by widget and its children for + Sets the visual that should be used for by widget and its children for creating #GdkWindows. The visual must be on the same #GdkScreen as returned by gtk_widget_get_screen(), so handling the #GtkWidget::screen-changed signal is necessary. @@ -196423,36 +140871,25 @@ so you should call this function before @widget is realized. - a #GtkWidget + a #GtkWidget - - visual to be used or %NULL to unset a previous one + + visual to be used or %NULL to unset a previous one - - Sets a widget’s window. This function should only be used in a -widget’s #GtkWidget::realize implementation. The %window passed is + + Sets a widget’s window. This function should only be used in a +widget’s #GtkWidget::realize implementation. The %window passed is usually either new window created with gdk_window_new(), or the window of its parent widget as returned by gtk_widget_get_parent_window(). Widgets must indicate whether they will create their own #GdkWindow by calling gtk_widget_set_has_window(). This is usually done in the -widget’s init() function. +widget’s init() function. Note that this function does not add any reference to @window. @@ -196461,25 +140898,17 @@ Note that this function does not add any reference to @window. - a #GtkWidget + a #GtkWidget - a #GdkWindow + a #GdkWindow - - Sets a shape for this widget’s GDK window. This allows for + + Sets a shape for this widget’s GDK window. This allows for transparent windows etc., see gdk_window_shape_combine_region() for more information. @@ -196488,28 +140917,19 @@ for more information. - a #GtkWidget + a #GtkWidget - - shape to be added, or %NULL to remove an existing shape + + shape to be added, or %NULL to remove an existing shape - Flags a widget to be displayed. Any widget that isn’t shown will + Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. If you want to show all the widgets in a -container, it’s easier to call gtk_widget_show_all() on the +container, it’s easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets. Remember that you have to show the containers containing a widget, @@ -196524,17 +140944,13 @@ toplevel container is realized and mapped. - a #GtkWidget + a #GtkWidget - Recursively shows a widget, and any child widgets (if the widget is + Recursively shows a widget, and any child widgets (if the widget is a container). @@ -196542,17 +140958,13 @@ a container). - a #GtkWidget + a #GtkWidget - Shows a widget. If the widget is an unmapped toplevel widget + Shows a widget. If the widget is an unmapped toplevel widget (i.e. a #GtkWindow that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during @@ -196563,24 +140975,20 @@ this function. - a #GtkWidget + a #GtkWidget - This function is only used by #GtkContainer subclasses, to assign a size + This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets. In this function, the allocation may be adjusted. It will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual method on the child will be used to adjust the allocation. Standard -adjustments include removing the widget’s margins, and applying the -widget’s #GtkWidget:halign and #GtkWidget:valign properties. +adjustments include removing the widget’s margins, and applying the +widget’s #GtkWidget:halign and #GtkWidget:valign properties. For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline() instead. @@ -196590,25 +140998,17 @@ instead. - a #GtkWidget + a #GtkWidget - position and size to be allocated to @widget + position and size to be allocated to @widget - - This function is only used by #GtkContainer subclasses, to assign a size, + + This function is only used by #GtkContainer subclasses, to assign a size, position and (optionally) baseline to their child widgets. In this function, the allocation and baseline may be adjusted. It @@ -196616,7 +141016,7 @@ will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual and adjust_baseline_allocation methods on the child will be used to adjust the allocation and baseline. Standard adjustments include removing the widget's -margins, and applying the widget’s #GtkWidget:halign and +margins, and applying the widget’s #GtkWidget:halign and #GtkWidget:valign properties. If the child widget does not have a valign of %GTK_ALIGN_BASELINE the @@ -196627,32 +141027,21 @@ baseline argument is ignored and -1 is used instead. - a #GtkWidget + a #GtkWidget - position and size to be allocated to @widget + position and size to be allocated to @widget - The baseline of the child, or -1 + The baseline of the child, or -1 - - This function is typically used when implementing a #GtkContainer + + This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk_widget_size_allocate(). @@ -196671,39 +141060,26 @@ a widget will actually be allocated. - a #GtkWidget + a #GtkWidget - - a #GtkRequisition to be filled in + + a #GtkRequisition to be filled in - - This function attaches the widget’s #GtkStyle to the widget's + + This function attaches the widget’s #GtkStyle to the widget's #GdkWindow. It is a replacement for |[ widget->style = gtk_style_attach (widget->style, widget->window); ]| -and should only ever be called in a derived widget’s “realize” +and should only ever be called in a derived widget’s “realize” implementation which does not chain up to its parent class' -“realize” implementation, because one of the parent classes +“realize” implementation, because one of the parent classes (finally #GtkWidget) would attach the style itself. This step is unnecessary with #GtkStyleContext. @@ -196712,82 +141088,57 @@ implementation which does not chain up to its parent class' - a #GtkWidget + a #GtkWidget - - Gets the values of a multiple style properties of @widget. + + Gets the values of a multiple style properties of @widget. - a #GtkWidget + a #GtkWidget - the name of the first property to get + the name of the first property to get - pairs of property names and locations to return the + pairs of property names and locations to return the property values, starting with the location for @first_property_name, terminated by %NULL. - - Gets the value of a style property of @widget. + + Gets the value of a style property of @widget. - a #GtkWidget + a #GtkWidget - the name of a style property + the name of a style property - - location to return the property value + + location to return the property value - - Non-vararg variant of gtk_widget_style_get(). Used primarily by language + + Non-vararg variant of gtk_widget_style_get(). Used primarily by language bindings. @@ -196795,32 +141146,23 @@ bindings. - a #GtkWidget + a #GtkWidget - the name of the first property to get + the name of the first property to get - a va_list of pairs of property names and + a va_list of pairs of property names and locations to return the property values, starting with the location for @first_property_name. - - Reverts the effect of a previous call to gtk_widget_freeze_child_notify(). + + Reverts the effect of a previous call to gtk_widget_freeze_child_notify(). This causes all queued #GtkWidget::child-notify signals on @widget to be emitted. @@ -196829,85 +141171,52 @@ emitted. - a #GtkWidget + a #GtkWidget - - Translate coordinates relative to @src_widget’s allocation to coordinates -relative to @dest_widget’s allocations. In order to perform this + + Translate coordinates relative to @src_widget’s allocation to coordinates +relative to @dest_widget’s allocations. In order to perform this operation, both widgets must be realized, and must share a common toplevel. - %FALSE if either widget was not realized, or there + %FALSE if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in *@dest_x and *@dest_y. Otherwise %TRUE. - a #GtkWidget + a #GtkWidget - a #GtkWidget + a #GtkWidget - X position relative to @src_widget + X position relative to @src_widget - Y position relative to @src_widget + Y position relative to @src_widget - - location to store X position relative to @dest_widget + + location to store X position relative to @dest_widget - - location to store Y position relative to @dest_widget + + location to store Y position relative to @dest_widget - - Triggers a tooltip query on the display where the toplevel of @widget + + Triggers a tooltip query on the display where the toplevel of @widget is located. See gtk_tooltip_trigger_tooltip_query() for more information. @@ -196916,35 +141225,27 @@ information. - a #GtkWidget + a #GtkWidget - This function is only for use in widget implementations. Causes -a widget to be unmapped if it’s currently mapped. + This function is only for use in widget implementations. Causes +a widget to be unmapped if it’s currently mapped. - a #GtkWidget + a #GtkWidget - This function is only for use in widget implementations. + This function is only for use in widget implementations. Should be called by implementations of the remove method on #GtkContainer, to dissociate a child from the container. @@ -196953,17 +141254,13 @@ on #GtkContainer, to dissociate a child from the container. - a #GtkWidget + a #GtkWidget - This function is only useful in widget implementations. + This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as @widget->window). @@ -196972,19 +141269,13 @@ associated with the widget, such as @widget->window). - a #GtkWidget + a #GtkWidget - - Unregisters a #GdkWindow from the widget that was previously set up with + + Unregisters a #GdkWindow from the widget that was previously set up with gtk_widget_register_window(). You need to call this when the window is no longer used by the widget, such as when you destroy it. @@ -196993,25 +141284,17 @@ no longer used by the widget, such as when you destroy it. - a #GtkWidget + a #GtkWidget - a #GdkWindow + a #GdkWindow - - This function is for use in widget implementations. Turns off flag + + This function is for use in widget implementations. Turns off flag values for the current widget state (insensitive, prelighted, etc.). See gtk_widget_set_state_flags(). @@ -197020,15 +141303,11 @@ See gtk_widget_set_state_flags(). - a #GtkWidget + a #GtkWidget - State flags to turn off + State flags to turn off @@ -197045,37 +141324,20 @@ See gtk_widget_set_state_flags(). - - Whether the widget is double buffered. + + Whether the widget is double buffered. Widgets should not use this property. - - Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand + + Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand - - Whether the widget should grab focus when it is clicked with the mouse. + + Whether the widget should grab focus when it is clicked with the mouse. This property is only relevant for widgets that can take focus. @@ -197083,13 +141345,8 @@ Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually. - - How to distribute horizontal space if widget gets extra space, see #GtkAlign + + How to distribute horizontal space if widget gets extra space, see #GtkAlign @@ -197098,13 +141355,8 @@ GtkComboBox) implemented this property individually. - - Enables or disables the emission of #GtkWidget::query-tooltip on @widget. + + Enables or disables the emission of #GtkWidget::query-tooltip on @widget. A value of %TRUE indicates that @widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not. @@ -197118,57 +141370,32 @@ property is set to %FALSE again. - - Whether to expand horizontally. See gtk_widget_set_hexpand(). + + Whether to expand horizontally. See gtk_widget_set_hexpand(). - - Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set(). + + Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set(). - - Sets all four sides' margin at once. If read, returns max + + Sets all four sides' margin at once. If read, returns max margin on any side. - - Margin on bottom side of widget. + + Margin on bottom side of widget. This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example. - - Margin on end of widget, horizontally. This property supports + + Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions. This property adds margin outside of the widget's normal size @@ -197176,15 +141403,8 @@ request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example. - - Margin on left side of widget. + + Margin on left side of widget. This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from @@ -197192,15 +141412,8 @@ gtk_widget_set_size_request() for example. Use #GtkWidget:margin-start instead. - - Margin on right side of widget. + + Margin on right side of widget. This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from @@ -197208,13 +141421,8 @@ gtk_widget_set_size_request() for example. Use #GtkWidget:margin-end instead. - - Margin on start of widget, horizontally. This property supports + + Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions. This property adds margin outside of the widget's normal size @@ -197222,13 +141430,8 @@ request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example. - - Margin on top side of widget. + + Margin on top side of widget. This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from @@ -197241,13 +141444,8 @@ gtk_widget_set_size_request() for example. - - The requested opacity of the widget. See gtk_widget_set_opacity() for + + The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity. Before 3.8 this was only available in GtkWindow @@ -197260,32 +141458,20 @@ Before 3.8 this was only available in GtkWindow - The scale factor of the widget. See gtk_widget_get_scale_factor() for + The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling. - - The style of the widget, which contains information about how it will look (colors, etc). + + The style of the widget, which contains information about how it will look (colors, etc). Use #GtkStyleContext instead - - Sets the text of tooltip to be the given string, which is marked up + + Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup(). @@ -197298,13 +141484,8 @@ Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins. - - Sets the text of tooltip to be the given string. + + Sets the text of tooltip to be the given string. Also see gtk_tooltip_set_text(). @@ -197317,31 +141498,16 @@ Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins. - - How to distribute vertical space if widget gets extra space, see #GtkAlign + + How to distribute vertical space if widget gets extra space, see #GtkAlign - - Whether to expand vertically. See gtk_widget_set_vexpand(). + + Whether to expand vertically. See gtk_widget_set_vexpand(). - - Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set(). + + Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set(). @@ -197351,9 +141517,7 @@ are set, the last one wins. - The widget's window if it is realized, %NULL otherwise. + The widget's window if it is realized, %NULL otherwise. @@ -197368,9 +141532,7 @@ are set, the last one wins. - The ::button-press-event signal will be emitted when a button + The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed. To receive this signal, the #GdkWindow associated to the @@ -197378,26 +141540,20 @@ widget needs to enable the #GDK_BUTTON_PRESS_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventButton which triggered + the #GdkEventButton which triggered this signal. - The ::button-release-event signal will be emitted when a button + The ::button-release-event signal will be emitted when a button (typically from a mouse) is released. To receive this signal, the #GdkWindow associated to the @@ -197405,53 +141561,37 @@ widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventButton which triggered + the #GdkEventButton which triggered this signal. - Determines whether an accelerator that activates the signal + Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This signal is present to allow applications and derived widgets to override the default #GtkWidget handling for determining whether an accelerator can be activated. - %TRUE if the signal can be activated. + %TRUE if the signal can be activated. - the ID of a signal installed on @widget + the ID of a signal installed on @widget - - The ::child-notify signal is emitted for each + + The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal's detail holds the property name. @@ -197459,21 +141599,13 @@ changed on an object. The signal's detail holds the property name. - the #GParamSpec of the changed child property + the #GParamSpec of the changed child property - - The ::composited-changed signal is emitted when the composited + + The ::composited-changed signal is emitted when the composited status of @widgets screen changes. See gdk_screen_is_composited(). Use GdkScreen::composited-changed instead. @@ -197482,81 +141614,61 @@ See gdk_screen_is_composited(). - The ::configure-event signal will be emitted when the size, position or + The ::configure-event signal will be emitted when the size, position or stacking of the @widget's window has changed. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventConfigure which triggered + the #GdkEventConfigure which triggered this signal. - Emitted when a redirected window belonging to @widget gets drawn into. + Emitted when a redirected window belonging to @widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventExpose event + the #GdkEventExpose event - The ::delete-event signal is emitted if a user requests that + The ::delete-event signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Connecting gtk_widget_hide_on_delete() to this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the event which triggered this signal + the event which triggered this signal - Signals that all holders of a reference to the widget should release + Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released. @@ -197566,9 +141678,7 @@ This signal is not suitable for saving widget state. - The ::destroy-event signal is emitted when a #GdkWindow is destroyed. + The ::destroy-event signal is emitted when a #GdkWindow is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time. @@ -197577,42 +141687,32 @@ To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the event which triggered this signal + the event which triggered this signal - The ::direction-changed signal is emitted when the text direction + The ::direction-changed signal is emitted when the text direction of a widget changes. - the previous text direction of @widget + the previous text direction of @widget - The ::drag-begin signal is emitted on the drag source when a drag is + The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf(). @@ -197624,17 +141724,13 @@ override what the default handler did. - the drag context + the drag context - The ::drag-data-delete signal is emitted on the drag source when a drag + The ::drag-data-delete signal is emitted on the drag source when a drag with the action %GDK_ACTION_MOVE is successfully completed. The signal handler is responsible for deleting the data that has been dropped. What "delete" means depends on the context of the drag operation. @@ -197643,17 +141739,13 @@ handler is responsible for deleting the data that has been dropped. What - the drag context + the drag context - The ::drag-data-get signal is emitted on the drag source when the drop + The ::drag-data-get signal is emitted on the drag source when the drop site requests the data which is dragged. It is the responsibility of the signal handler to fill @data with the data in the format which is indicated by @info. See gtk_selection_data_set() and @@ -197663,36 +141755,26 @@ gtk_selection_data_set_text(). - the drag context + the drag context - the #GtkSelectionData to be filled with the dragged data + the #GtkSelectionData to be filled with the dragged data - the info that has been registered with the target in the + the info that has been registered with the target in the #GtkTargetList - the timestamp at which the data was requested + the timestamp at which the data was requested - The ::drag-data-received signal is emitted on the drop site when the + The ::drag-data-received signal is emitted on the drop site when the dragged data has been received. If the data was received in order to determine whether the drop will be accepted, the handler is expected to call gdk_drag_status() and not finish the drag. @@ -197757,48 +141839,34 @@ drag_data_received (GtkWidget *widget, - the drag context + the drag context - where the drop happened + where the drop happened - where the drop happened + where the drop happened - the received data + the received data - the info that has been registered with the target in the + the info that has been registered with the target in the #GtkTargetList - the timestamp at which the data was received + the timestamp at which the data was received - The ::drag-drop signal is emitted on the drop site when the user drops + The ::drag-drop signal is emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing is necessary. @@ -197809,42 +141877,30 @@ directly or in a #GtkWidget::drag-data-received handler which gets triggered by calling gtk_drag_get_data() to receive the data for one or more of the supported targets. - whether the cursor position is in a drop zone + whether the cursor position is in a drop zone - the drag context + the drag context - the x coordinate of the current cursor position + the x coordinate of the current cursor position - the y coordinate of the current cursor position + the y coordinate of the current cursor position - the timestamp of the motion event + the timestamp of the motion event - The ::drag-end signal is emitted on the drag source when a drag is + The ::drag-end signal is emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in #GtkWidget::drag-begin. @@ -197852,46 +141908,34 @@ things done in #GtkWidget::drag-begin. - the drag context + the drag context - The ::drag-failed signal is emitted on the drag source when a drag has + The ::drag-failed signal is emitted on the drag source when a drag has failed. The signal handler may hook custom code to handle a failed DnD operation based on the type of error, it returns %TRUE is the failure has been already handled (not showing the default "drag operation failed" animation), otherwise it returns %FALSE. - %TRUE if the failed drag operation has been already handled. + %TRUE if the failed drag operation has been already handled. - the drag context + the drag context - the result of the drag operation + the result of the drag operation - The ::drag-leave signal is emitted on the drop site when the cursor + The ::drag-leave signal is emitted on the drop site when the cursor leaves the widget. A typical reason to connect to this signal is to undo things done in #GtkWidget::drag-motion, e.g. undo highlighting with gtk_drag_unhighlight(). @@ -197905,23 +141949,17 @@ created in the #GtkWidget::drag-motion signal handler. - the drag context + the drag context - the timestamp of the motion event + the timestamp of the motion event - The ::drag-motion signal is emitted on the drop site when the user + The ::drag-motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing @@ -198008,42 +142046,30 @@ drag_data_received (GtkWidget *widget, } ]| - whether the cursor position is in a drop zone + whether the cursor position is in a drop zone - the drag context + the drag context - the x coordinate of the current cursor position + the x coordinate of the current cursor position - the y coordinate of the current cursor position + the y coordinate of the current cursor position - the timestamp of the motion event + the timestamp of the motion event - This signal is emitted when a widget is supposed to render itself. + This signal is emitted when a widget is supposed to render itself. The @widget's top left corner must be painted at the origin of the passed in context and be sized to the values returned by gtk_widget_get_allocated_width() and @@ -198061,25 +142087,19 @@ extents of the clip region with gdk_cairo_get_clip_rectangle(), or they can get a finer-grained representation of the dirty region with cairo_copy_clip_rectangle_list(). - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the cairo context to draw to + the cairo context to draw to - The ::enter-notify-event will be emitted when the pointer enters + The ::enter-notify-event will be emitted when the pointer enters the @widget's window. To receive this signal, the #GdkWindow associated to the widget needs @@ -198087,34 +142107,26 @@ to enable the #GDK_ENTER_NOTIFY_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventCrossing which triggered + the #GdkEventCrossing which triggered this signal. - The GTK+ main loop will emit three signals for each GDK event delivered + The GTK+ main loop will emit three signals for each GDK event delivered to a widget: one generic ::event signal, another, more specific, signal that matches the type of event delivered (e.g. #GtkWidget::key-press-event) and finally a generic #GtkWidget::event-after signal. - %TRUE to stop other handlers from being invoked for the event + %TRUE to stop other handlers from being invoked for the event and to cancel the emission of the second specific ::event signal. %FALSE to propagate the event further and to allow the emission of the second signal. The ::event-after signal is emitted regardless of @@ -198123,17 +142135,13 @@ and to cancel the emission of the second specific ::event signal. - the #GdkEvent which triggered this signal + the #GdkEvent which triggered this signal - After the emission of the #GtkWidget::event signal and (optionally) + After the emission of the #GtkWidget::event signal and (optionally) the second more specific signal, ::event-after will be emitted regardless of the previous two signals handlers return values. @@ -198141,18 +142149,14 @@ regardless of the previous two signals handlers return values. - the #GdkEvent which triggered this signal + the #GdkEvent which triggered this signal - %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -198162,76 +142166,58 @@ regardless of the previous two signals handlers return values. - The ::focus-in-event signal will be emitted when the keyboard focus + The ::focus-in-event signal will be emitted when the keyboard focus enters the @widget's window. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_FOCUS_CHANGE_MASK mask. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventFocus which triggered + the #GdkEventFocus which triggered this signal. - The ::focus-out-event signal will be emitted when the keyboard focus + The ::focus-out-event signal will be emitted when the keyboard focus leaves the @widget's window. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_FOCUS_CHANGE_MASK mask. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventFocus which triggered this + the #GdkEventFocus which triggered this signal. - Emitted when a pointer or keyboard grab on a window belonging + Emitted when a pointer or keyboard grab on a window belonging to @widget gets broken. On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again. - %TRUE to stop other handlers from being invoked for + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventGrabBroken event + the #GdkEventGrabBroken event @@ -198242,9 +142228,7 @@ application grabs the pointer or keyboard again. - The ::grab-notify signal is emitted when a widget becomes + The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed. @@ -198257,51 +142241,38 @@ its ancestor. - %FALSE if the widget becomes shadowed, %TRUE + %FALSE if the widget becomes shadowed, %TRUE if it becomes unshadowed - The ::hide signal is emitted when @widget is hidden, for example with + The ::hide signal is emitted when @widget is hidden, for example with gtk_widget_hide(). - The ::hierarchy-changed signal is emitted when the + The ::hierarchy-changed signal is emitted when the anchored state of a widget changes. A widget is -“anchored” when its toplevel +“anchored” when its toplevel ancestor is a #GtkWindow. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa. - - the previous toplevel ancestor, or %NULL + + the previous toplevel ancestor, or %NULL if the widget was previously unanchored - The ::key-press-event signal is emitted when a key is pressed. The signal + The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed. To receive this signal, the #GdkWindow associated to the widget needs @@ -198309,72 +142280,54 @@ to enable the #GDK_KEY_PRESS_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventKey which triggered this signal. + the #GdkEventKey which triggered this signal. - The ::key-release-event signal is emitted when a key is released. + The ::key-release-event signal is emitted when a key is released. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_KEY_RELEASE_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventKey which triggered this signal. + the #GdkEventKey which triggered this signal. - Gets emitted if keyboard navigation fails. + Gets emitted if keyboard navigation fails. See gtk_widget_keynav_failed() for details. - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - the direction of movement + the direction of movement - The ::leave-notify-event will be emitted when the pointer leaves + The ::leave-notify-event will be emitted when the pointer leaves the @widget's window. To receive this signal, the #GdkWindow associated to the widget needs @@ -198382,26 +142335,20 @@ to enable the #GDK_LEAVE_NOTIFY_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventCrossing which triggered + the #GdkEventCrossing which triggered this signal. - The ::map signal is emitted when @widget is going to be mapped, that is + The ::map signal is emitted when @widget is going to be mapped, that is when the widget is visible (which is controlled with gtk_widget_set_visible()) and all its parents up to the toplevel widget are also visible. Once the map has occurred, #GtkWidget::map-event will @@ -198415,55 +142362,41 @@ emission of #GtkWidget::unmap. - The ::map-event signal will be emitted when the @widget's window is + The ::map-event signal will be emitted when the @widget's window is mapped. A window is mapped when it becomes visible on the screen. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventAny which triggered this signal. + the #GdkEventAny which triggered this signal. - The default handler for this signal activates @widget if @group_cycling + The default handler for this signal activates @widget if @group_cycling is %FALSE, or just makes @widget grab focus if @group_cycling is %TRUE. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic - The ::motion-notify-event signal is emitted when the pointer moves + The ::motion-notify-event signal is emitted when the pointer moves over the widget's #GdkWindow. To receive this signal, the #GdkWindow associated to the widget @@ -198471,17 +142404,13 @@ needs to enable the #GDK_POINTER_MOTION_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventMotion which triggered + the #GdkEventMotion which triggered this signal. @@ -198498,30 +142427,21 @@ This signal will be sent to the grab widget if there is one. - The ::parent-set signal is emitted when a new parent + The ::parent-set signal is emitted when a new parent has been set on a widget. - - the previous parent, or %NULL if the widget + + the previous parent, or %NULL if the widget just got its initial parent. - This signal gets emitted whenever a widget should pop up a context + This signal gets emitted whenever a widget should pop up a context menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the #GtkEntry widget creates @@ -198529,89 +142449,67 @@ a menu with clipboard commands. See the [Popup Menu Migration Checklist][checklist-popup-menu] for an example of how to use this signal. - %TRUE if a menu was activated + %TRUE if a menu was activated - The ::property-notify-event signal will be emitted when a property on + The ::property-notify-event signal will be emitted when a property on the @widget's window has been changed or deleted. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_PROPERTY_CHANGE_MASK mask. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventProperty which triggered + the #GdkEventProperty which triggered this signal. - To receive this signal the #GdkWindow associated to the widget needs + To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventProximity which triggered + the #GdkEventProximity which triggered this signal. - To receive this signal the #GdkWindow associated to the widget needs + To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventProximity which triggered + the #GdkEventProximity which triggered this signal. - Emitted when #GtkWidget:has-tooltip is %TRUE and the hover timeout + Emitted when #GtkWidget:has-tooltip is %TRUE and the hover timeout has expired with the cursor hovering "above" @widget; or emitted when @widget got focus in keyboard mode. @@ -198624,44 +142522,32 @@ should not be used. The signal handler is free to manipulate @tooltip with the therefore destined function calls. - %TRUE if @tooltip should be shown right now, %FALSE otherwise. + %TRUE if @tooltip should be shown right now, %FALSE otherwise. - the x coordinate of the cursor position where the request has + the x coordinate of the cursor position where the request has been emitted, relative to @widget's left side - the y coordinate of the cursor position where the request has + the y coordinate of the cursor position where the request has been emitted, relative to @widget's top - %TRUE if the tooltip was triggered using the keyboard + %TRUE if the tooltip was triggered using the keyboard - a #GtkTooltip + a #GtkTooltip - The ::realize signal is emitted when @widget is associated with a + The ::realize signal is emitted when @widget is associated with a #GdkWindow, which means that gtk_widget_realize() has been called or the widget has been mapped (that is, it is going to be drawn). @@ -198669,30 +142555,21 @@ widget has been mapped (that is, it is going to be drawn). - The ::screen-changed signal gets emitted when the + The ::screen-changed signal gets emitted when the screen of a widget has changed. - - the previous screen, or %NULL if the + + the previous screen, or %NULL if the widget was not associated with a screen before - The ::scroll-event signal is emitted when a button in the 4 to 7 + The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned. @@ -198701,39 +142578,29 @@ to enable the #GDK_SCROLL_MASK mask. This signal will be sent to the grab widget if there is one. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventScroll which triggered + the #GdkEventScroll which triggered this signal. - The ::selection-clear-event signal will be emitted when the + The ::selection-clear-event signal will be emitted when the the @widget's window has lost ownership of a selection. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventSelection which triggered + the #GdkEventSelection which triggered this signal. @@ -198757,9 +142624,7 @@ the @widget's window has lost ownership of a selection. - %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -198782,32 +142647,24 @@ the @widget's window has lost ownership of a selection. - The ::selection-request-event signal will be emitted when + The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the @widget's window. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventSelection which triggered + the #GdkEventSelection which triggered this signal. - The ::show signal is emitted when @widget is shown, for example with + The ::show signal is emitted when @widget is shown, for example with gtk_widget_show(). @@ -198815,9 +142672,7 @@ gtk_widget_show(). - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -198833,21 +142688,14 @@ gtk_widget_show(). - the region which has been + the region which has been allocated to the widget. - - The ::state-changed signal is emitted when the widget state changes. + + The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state(). Use #GtkWidget::state-flags-changed instead. @@ -198855,37 +142703,26 @@ See gtk_widget_get_state(). - the previous state + the previous state - The ::state-flags-changed signal is emitted when the widget state + The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags(). - The previous state flags. + The previous state flags. - - The ::style-set signal is emitted when a new style has been set + + The ::style-set signal is emitted when a new style has been set on a widget. Note that style-modifying functions like gtk_widget_modify_base() also cause this signal to be emitted. @@ -198897,22 +142734,15 @@ with a widget, use the #GtkWidget::style-updated signal. - - the previous style, or %NULL if the widget + + the previous style, or %NULL if the widget just got its initial style - The ::style-updated signal is a convenience signal that is emitted when the + The ::style-updated signal is a convenience signal that is emitted when the #GtkStyleContext::changed signal is emitted on the @widget's associated #GtkStyleContext as returned by gtk_widget_get_style_context(). @@ -198933,9 +142763,7 @@ cause this signal to be emitted. - The ::unmap signal is emitted when @widget is going to be unmapped, which + The ::unmap signal is emitted when @widget is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden. @@ -198946,34 +142774,26 @@ used to, for example, stop an animation on the widget. - The ::unmap-event signal will be emitted when the @widget's window is + The ::unmap-event signal will be emitted when the @widget's window is unmapped. A window is unmapped when it becomes invisible on the screen. To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventAny which triggered this signal + the #GdkEventAny which triggered this signal - The ::unrealize signal is emitted when the #GdkWindow associated with + The ::unrealize signal is emitted when the #GdkWindow associated with @widget is destroyed, which means that gtk_widget_unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden). @@ -198981,13 +142801,8 @@ hidden). - - The ::visibility-notify-event will be emitted when the @widget's + + The ::visibility-notify-event will be emitted when the @widget's window is obscured or unobscured. To receive this signal the #GdkWindow associated to the widget needs @@ -198997,77 +142812,57 @@ to enable the #GDK_VISIBILITY_NOTIFY_MASK mask. reliably, so this signal can not be guaranteed to provide useful information. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventVisibility which + the #GdkEventVisibility which triggered this signal. - The ::window-state-event will be emitted when the state of the + The ::window-state-event will be emitted when the state of the toplevel window associated to the @widget changes. To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows. - %TRUE to stop other handlers from being invoked for the + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #GdkEventWindowState which + the #GdkEventWindowState which triggered this signal. - + - + - + - + @@ -199082,29 +142877,20 @@ this mask automatically for all new windows. - + - + - The object class structure needs to be the first + The object class structure needs to be the first element in the widget class structure in order for the class mechanism to work correctly. This allows a GtkWidgetClass pointer to be cast to a GObjectClass pointer. - + - The signal to emit when a widget of this class is + The signal to emit when a widget of this class is activated, gtk_widget_activate() handles the emission. Implementation of this signal is optional. @@ -199136,9 +142922,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199152,9 +142936,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199168,9 +142950,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199184,9 +142964,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199200,9 +142978,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199216,9 +142992,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199232,9 +143006,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199248,9 +143020,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199264,15 +143034,11 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget - position and size to be allocated to @widget + position and size to be allocated to @widget @@ -199398,16 +143164,12 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget - the name of a child property installed on the - class of @widget’s parent + the name of a child property installed on the + class of @widget’s parent @@ -199433,16 +143195,12 @@ this mask automatically for all new windows. - The #GtkSizeRequestMode preferred by @widget. + The #GtkSizeRequestMode preferred by @widget. - a #GtkWidget instance + a #GtkWidget instance @@ -199456,31 +143214,15 @@ this mask automatically for all new windows. - a #GtkWidget instance + a #GtkWidget instance - - location to store the minimum height, or %NULL + + location to store the minimum height, or %NULL - - location to store the natural height, or %NULL + + location to store the natural height, or %NULL @@ -199494,37 +143236,19 @@ this mask automatically for all new windows. - a #GtkWidget instance + a #GtkWidget instance - the height which is available for allocation + the height which is available for allocation - - location for storing the minimum width, or %NULL + + location for storing the minimum width, or %NULL - - location for storing the natural width, or %NULL + + location for storing the natural width, or %NULL @@ -199538,31 +143262,15 @@ this mask automatically for all new windows. - a #GtkWidget instance + a #GtkWidget instance - - location to store the minimum width, or %NULL + + location to store the minimum width, or %NULL - - location to store the natural width, or %NULL + + location to store the natural width, or %NULL @@ -199576,37 +143284,19 @@ this mask automatically for all new windows. - a #GtkWidget instance + a #GtkWidget instance - the width which is available for allocation + the width which is available for allocation - - location for storing the minimum height, or %NULL + + location for storing the minimum height, or %NULL - - location for storing the natural height, or %NULL + + location for storing the natural height, or %NULL @@ -199616,22 +143306,16 @@ this mask automatically for all new windows. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - a #GtkWidget + a #GtkWidget - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic @@ -199645,9 +143329,7 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget @@ -199689,24 +143371,18 @@ this mask automatically for all new windows. - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - a #GtkWidget + a #GtkWidget - direction of focus movement + direction of focus movement @@ -199716,23 +143392,17 @@ this mask automatically for all new windows. - return from the event signal emission (%TRUE if + return from the event signal emission (%TRUE if the event was handled) - a #GtkWidget + a #GtkWidget - a #GdkEvent + a #GdkEvent @@ -200404,16 +144074,12 @@ this mask automatically for all new windows. - the #AtkObject associated with @widget + the #AtkObject associated with @widget - a #GtkWidget + a #GtkWidget @@ -200439,22 +144105,16 @@ this mask automatically for all new windows. - %TRUE if the accelerator can be activated. + %TRUE if the accelerator can be activated. - a #GtkWidget + a #GtkWidget - the ID of a signal installed on @widget + the ID of a signal installed on @widget @@ -200604,59 +144264,27 @@ this mask automatically for all new windows. - a #GtkWidget instance + a #GtkWidget instance - the width which is available for allocation, or -1 if none + the width which is available for allocation, or -1 if none - - location for storing the minimum height, or %NULL + + location for storing the minimum height, or %NULL - - location for storing the natural height, or %NULL + + location for storing the natural height, or %NULL - - location for storing the baseline for the minimum height, or %NULL + + location for storing the baseline for the minimum height, or %NULL - - location for storing the baseline for the natural height, or %NULL + + location for storing the baseline for the natural height, or %NULL @@ -200705,15 +144333,11 @@ this mask automatically for all new windows. - a #GtkWidget + a #GtkWidget - region to draw + region to draw @@ -200738,12 +144362,8 @@ this mask automatically for all new windows. - - Declares a @callback_symbol to handle @callback_name from the template XML + + Declares a @callback_symbol to handle @callback_name from the template XML defined for @widget_type. See gtk_builder_add_callback_symbol(). Note that this must be called from a composite widget classes class @@ -200754,40 +144374,28 @@ initializer after calling gtk_widget_class_set_template(). - A #GtkWidgetClass + A #GtkWidgetClass - The name of the callback as expected in the template XML + The name of the callback as expected in the template XML - - The callback symbol + + The callback symbol - - Automatically assign an object declared in the class template XML to be set to a location -on a freshly built instance’s private data, or alternatively accessible via gtk_widget_get_template_child(). + + Automatically assign an object declared in the class template XML to be set to a location +on a freshly built instance’s private data, or alternatively accessible via gtk_widget_get_template_child(). The struct can point either into the public instance, then you should use G_STRUCT_OFFSET(WidgetType, member) for @struct_offset, or in the private struct, then you should use G_PRIVATE_OFFSET(WidgetType, member). An explicit strong reference will be held automatically for the duration of your -instance’s life cycle, it will be released automatically when #GObjectClass.dispose() runs +instance’s life cycle, it will be released automatically when #GObjectClass.dispose() runs on your instance and if a @struct_offset that is != 0 is specified, then the automatic location in your instance public or private data will be set to %NULL. You can however access an automated child pointer the first time your classes #GObjectClass.dispose() runs, or alternatively in @@ -200808,90 +144416,61 @@ initializer after calling gtk_widget_class_set_template(). - A #GtkWidgetClass + A #GtkWidgetClass - The “id” of the child defined in the template XML + The “id” of the child defined in the template XML - Whether the child should be accessible as an “internal-child” + Whether the child should be accessible as an “internal-child” when this class is used in GtkBuilder XML - The structure offset into the composite widget’s instance public or private structure + The structure offset into the composite widget’s instance public or private structure where the automated child pointer should be set, or 0 to not assign the pointer. - - Finds a style property of a widget class by name. + + Finds a style property of a widget class by name. - the #GParamSpec of the style property or + the #GParamSpec of the style property or %NULL if @class has no style property with that name. - a #GtkWidgetClass + a #GtkWidgetClass - the name of the style property to find + the name of the style property to find - - Gets the name used by this class for matching in CSS code. See + + Gets the name used by this class for matching in CSS code. See gtk_widget_class_set_css_name() for details. - the CSS name of the given class + the CSS name of the given class - class to set the name on + class to set the name on - - Installs a style property on a widget class. The parser for the + + Installs a style property on a widget class. The parser for the style property is determined by the value type of @pspec. @@ -200899,61 +144478,41 @@ style property is determined by the value type of @pspec. - a #GtkWidgetClass + a #GtkWidgetClass - the #GParamSpec for the property + the #GParamSpec for the property - - Installs a style property on a widget class. + + Installs a style property on a widget class. - a #GtkWidgetClass + a #GtkWidgetClass - the #GParamSpec for the style property + the #GParamSpec for the style property - the parser for the style property + the parser for the style property - - Returns all style properties of a widget class. + + Returns all style properties of a widget class. - a + a newly allocated array of #GParamSpec*. The array must be freed with g_free(). @@ -200962,28 +144521,17 @@ style property is determined by the value type of @pspec. - a #GtkWidgetClass + a #GtkWidgetClass - - location to return the number of style properties found + + location to return the number of style properties found - - Sets the default #AtkRole to be set on accessibles created for + + Sets the default #AtkRole to be set on accessibles created for widgets of @widget_class. Accessibles may decide to not honor this setting if their role reporting is more refined. Calls to gtk_widget_class_set_accessible_type() will reset this value. @@ -200994,7 +144542,7 @@ accessible type and use gtk_widget_class_set_accessible_type() instead. If @role is #ATK_ROLE_INVALID, the default role will not be changed -and the accessible’s default role will be used instead. +and the accessible’s default role will be used instead. This function should only be called from class init functions of widgets. @@ -201003,25 +144551,17 @@ This function should only be called from class init functions of widgets. - class to set the accessible role for + class to set the accessible role for - The role to use for accessibles created for @widget_class + The role to use for accessibles created for @widget_class - - Sets the type to be used for creating accessibles for widgets of + + Sets the type to be used for creating accessibles for widgets of @widget_class. The given @type must be a subtype of the type used for accessibles of the parent class. @@ -201032,26 +144572,18 @@ This function should only be called from class init functions of widgets. - class to set the accessible type for + class to set the accessible type for - The object type that implements the accessible for @widget_class + The object type that implements the accessible for @widget_class - - For use in language bindings, this will override the default #GtkBuilderConnectFunc to be -used when parsing GtkBuilder XML from this class’s template data. + + For use in language bindings, this will override the default #GtkBuilderConnectFunc to be +used when parsing GtkBuilder XML from this class’s template data. Note that this must be called from a composite widget classes class initializer after calling gtk_widget_class_set_template(). @@ -201061,47 +144593,26 @@ initializer after calling gtk_widget_class_set_template(). - A #GtkWidgetClass + A #GtkWidgetClass - - The #GtkBuilderConnectFunc to use when connecting signals in the class template + + The #GtkBuilderConnectFunc to use when connecting signals in the class template - - The data to pass to @connect_func + + The data to pass to @connect_func - - The #GDestroyNotify to free @connect_data, this will only be used at + + The #GDestroyNotify to free @connect_data, this will only be used at class finalization time, when no classes of type @widget_type are in use anymore. - - Sets the name to be used for CSS matching of widgets. + + Sets the name to be used for CSS matching of widgets. If this function is not called for a given class, the name of the parent class is used. @@ -201111,116 +144622,73 @@ of the parent class is used. - class to set the name on + class to set the name on - name to use + name to use - - This should be called at class initialization time to specify + + This should be called at class initialization time to specify the GtkBuilder XML to be used to extend a widget. For convenience, gtk_widget_class_set_template_from_resource() is also provided. Note that any class that installs templates must call gtk_widget_init_template() -in the widget’s instance initializer. +in the widget’s instance initializer. - A #GtkWidgetClass + A #GtkWidgetClass - A #GBytes holding the #GtkBuilder XML + A #GBytes holding the #GtkBuilder XML - - A convenience function to call gtk_widget_class_set_template(). + + A convenience function to call gtk_widget_class_set_template(). Note that any class that installs templates must call gtk_widget_init_template() -in the widget’s instance initializer. +in the widget’s instance initializer. - A #GtkWidgetClass + A #GtkWidgetClass - The name of the resource to load the template from + The name of the resource to load the template from - + - - Kinds of widget-specific help. Used by the ::show-help signal. - - Tooltip. + + Kinds of widget-specific help. Used by the ::show-help signal. + + Tooltip. - - What’s this. + + What’s this. - - GtkWidgetPath is a boxed type that represents a widget hierarchy from + + GtkWidgetPath is a boxed type that represents a widget hierarchy from the topmost widget, typically a toplevel, to any child. This widget path abstraction is used in #GtkStyleContext on behalf of the real widget in order to query style information. @@ -201269,82 +144737,54 @@ All this information will be used to match the style information that applies to the described widget. - Returns an empty widget path. + Returns an empty widget path. - A newly created, empty, #GtkWidgetPath + A newly created, empty, #GtkWidgetPath - - Appends the data from @widget to the widget hierarchy represented + + Appends the data from @widget to the widget hierarchy represented by @path. This function is a shortcut for adding information from @widget to the given @path. This includes setting the name or adding the style classes from @widget. - the position where the data was inserted + the position where the data was inserted - a widget path + a widget path - the widget to append to the widget path + the widget to append to the widget path - - Appends a widget type to the widget hierarchy represented by @path. + + Appends a widget type to the widget hierarchy represented by @path. - the position where the element was inserted + the position where the element was inserted - a #GtkWidgetPath + a #GtkWidgetPath - widget type to append + widget type to append - - Appends a widget type with all its siblings to the widget hierarchy + + Appends a widget type with all its siblings to the widget hierarchy represented by @path. Using this function instead of gtk_widget_path_append_type() will allow the CSS theming to use sibling matches in selectors and apply :nth-child() pseudo classes. @@ -201353,59 +144793,43 @@ widgets need to make sure to call gtk_widget_reset_style() on all involved widgets when the @siblings path changes. - the position where the element was inserted. + the position where the element was inserted. - the widget path to append to + the widget path to append to - a widget path describing a list of siblings. This path + a widget path describing a list of siblings. This path may not contain any siblings itself and it must not be modified afterwards. - index into @siblings for where the added element is + index into @siblings for where the added element is positioned. - Returns a copy of @path + Returns a copy of @path - a copy of @path + a copy of @path - a #GtkWidgetPath + a #GtkWidgetPath - Decrements the reference count on @path, freeing the structure + Decrements the reference count on @path, freeing the structure if the reference count reaches 0. @@ -201413,100 +144837,66 @@ if the reference count reaches 0. - a #GtkWidgetPath + a #GtkWidgetPath - - Returns the topmost object type, that is, the object type this path + + Returns the topmost object type, that is, the object type this path is representing. - The object type + The object type - a #GtkWidget + a #GtkWidget - - Returns %TRUE if any of the parents of the widget represented + + Returns %TRUE if any of the parents of the widget represented in @path is of type @type, or any subtype of it. - %TRUE if any parent is of type @type + %TRUE if any parent is of type @type - a #GtkWidgetPath + a #GtkWidgetPath - widget type to check in parents + widget type to check in parents - - Returns %TRUE if the widget type represented by this path + + Returns %TRUE if the widget type represented by this path is @type, or a subtype of it. - %TRUE if the widget represented by @path is of type @type + %TRUE if the widget represented by @path is of type @type - a #GtkWidgetPath + a #GtkWidgetPath - widget type to match + widget type to match - - Adds the class @name to the widget at position @pos in + + Adds the class @name to the widget at position @pos in the hierarchy defined in @path. See gtk_style_context_add_class(). @@ -201515,38 +144905,26 @@ gtk_style_context_add_class(). - a #GtkWidget + a #GtkWidget - position to modify, -1 for the path head + position to modify, -1 for the path head - a class name + a class name - - Adds the region @name to the widget at position @pos in + + Adds the region @name to the widget at position @pos in the hierarchy defined in @path. See gtk_style_context_add_region(). Region names must only contain lowercase letters -and “-”, starting always with a lowercase letter. +and “-”, starting always with a lowercase letter. The use of regions is deprecated. @@ -201554,37 +144932,25 @@ and “-”, starting always with a lowercase letter. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - region name + region name - flags affecting the region + flags affecting the region - - Removes all classes from the widget at position @pos in the + + Removes all classes from the widget at position @pos in the hierarchy defined in @path. @@ -201592,27 +144958,17 @@ hierarchy defined in @path. - a #GtkWidget + a #GtkWidget - position to modify, -1 for the path head + position to modify, -1 for the path head - - Removes all regions from the widget at position @pos in the + + Removes all regions from the widget at position @pos in the hierarchy defined in @path. The use of regions is deprecated. @@ -201621,440 +144977,287 @@ hierarchy defined in @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - - Returns the name corresponding to the widget found at + + Returns the name corresponding to the widget found at the position @pos in the widget hierarchy defined by @path - The widget name, or %NULL if none was set. + The widget name, or %NULL if none was set. - a #GtkWidgetPath + a #GtkWidgetPath - position to get the widget name for, -1 for the path head + position to get the widget name for, -1 for the path head - - Returns the object name that is at position @pos in the widget + + Returns the object name that is at position @pos in the widget hierarchy defined in @path. - the name or %NULL + the name or %NULL - a #GtkWidgetPath + a #GtkWidgetPath - position to get the object name for, -1 for the path head + position to get the object name for, -1 for the path head - - Returns the object #GType that is at position @pos in the widget + + Returns the object #GType that is at position @pos in the widget hierarchy defined in @path. - a widget type + a widget type - a #GtkWidgetPath + a #GtkWidgetPath - position to get the object type for, -1 for the path head + position to get the object type for, -1 for the path head - - Returns the index into the list of siblings for the element at @pos as + + Returns the index into the list of siblings for the element at @pos as returned by gtk_widget_path_iter_get_siblings(). If that function would return %NULL because the element at @pos has no siblings, this function will return 0. - 0 or the index into the list of siblings for the element at @pos. + 0 or the index into the list of siblings for the element at @pos. - a #GtkWidgetPath + a #GtkWidgetPath - position to get the sibling index for, -1 for the path head + position to get the sibling index for, -1 for the path head - - Returns the list of siblings for the element at @pos. If the element + + Returns the list of siblings for the element at @pos. If the element was not added with siblings, %NULL is returned. - %NULL or the list of siblings for the element at @pos. + %NULL or the list of siblings for the element at @pos. - a #GtkWidgetPath + a #GtkWidgetPath - position to get the siblings for, -1 for the path head + position to get the siblings for, -1 for the path head - - Returns the state flags corresponding to the widget found at + + Returns the state flags corresponding to the widget found at the position @pos in the widget hierarchy defined by @path - The state flags + The state flags - a #GtkWidgetPath + a #GtkWidgetPath - position to get the state for, -1 for the path head + position to get the state for, -1 for the path head - - Returns %TRUE if the widget at position @pos has the class @name + + Returns %TRUE if the widget at position @pos has the class @name defined, %FALSE otherwise. - %TRUE if the class @name is defined for the widget at @pos + %TRUE if the class @name is defined for the widget at @pos - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - class name + class name - - Returns %TRUE if the widget at position @pos has the name @name, + + Returns %TRUE if the widget at position @pos has the name @name, %FALSE otherwise. - %TRUE if the widget at @pos has this name + %TRUE if the widget at @pos has this name - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - a widget name + a widget name - - See gtk_widget_path_iter_has_class(). This is a version that operates + + See gtk_widget_path_iter_has_class(). This is a version that operates with GQuarks. - %TRUE if the widget at @pos has the class defined. + %TRUE if the widget at @pos has the class defined. - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - class name as a #GQuark + class name as a #GQuark - - See gtk_widget_path_iter_has_name(). This is a version + + See gtk_widget_path_iter_has_name(). This is a version that operates on #GQuarks. - %TRUE if the widget at @pos has this name + %TRUE if the widget at @pos has this name - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - widget name as a #GQuark + widget name as a #GQuark - - See gtk_widget_path_iter_has_region(). This is a version that operates + + See gtk_widget_path_iter_has_region(). This is a version that operates with GQuarks. The use of regions is deprecated. - %TRUE if the widget at @pos has the region defined. + %TRUE if the widget at @pos has the region defined. - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - region name as a #GQuark + region name as a #GQuark - - return location for the region flags + + return location for the region flags - - Returns %TRUE if the widget at position @pos has the class @name + + Returns %TRUE if the widget at position @pos has the class @name defined, %FALSE otherwise. The use of regions is deprecated. - %TRUE if the class @name is defined for the widget at @pos + %TRUE if the class @name is defined for the widget at @pos - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - region name + region name - - return location for the region flags + + return location for the region flags - - Returns a list with all the class names defined for the widget + + Returns a list with all the class names defined for the widget at position @pos in the hierarchy defined in @path. - The list of + The list of classes, This is a list of strings, the #GSList contents are owned by GTK+, but you should use g_slist_free() to free the list itself. @@ -202064,34 +145267,22 @@ at position @pos in the hierarchy defined in @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - - Returns a list with all the region names defined for the widget + + Returns a list with all the region names defined for the widget at position @pos in the hierarchy defined in @path. The use of regions is deprecated. - The list of + The list of regions, This is a list of strings, the #GSList contents are owned by GTK+, but you should use g_slist_free() to free the list itself. @@ -202101,25 +145292,17 @@ at position @pos in the hierarchy defined in @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to query, -1 for the path head + position to query, -1 for the path head - - Removes the class @name from the widget at position @pos in + + Removes the class @name from the widget at position @pos in the hierarchy defined in @path. @@ -202127,33 +145310,21 @@ the hierarchy defined in @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - class name + class name - - Removes the region @name from the widget at position @pos in + + Removes the region @name from the widget at position @pos in the hierarchy defined in @path. The use of regions is deprecated. @@ -202162,31 +145333,21 @@ the hierarchy defined in @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - region name + region name - - Sets the widget name for the widget found at position @pos + + Sets the widget name for the widget found at position @pos in the widget hierarchy defined by @path. @@ -202194,31 +145355,21 @@ in the widget hierarchy defined by @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - widget name + widget name - - Sets the object name for a given position in the widget hierarchy + + Sets the object name for a given position in the widget hierarchy defined by @path. When set, the object name overrides the object type when matching @@ -202229,34 +145380,21 @@ CSS. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - - object name to set or %NULL to unset + + object name to set or %NULL to unset - - Sets the object type for a given position in the widget hierarchy + + Sets the object type for a given position in the widget hierarchy defined by @path. @@ -202264,31 +145402,21 @@ defined by @path. - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - object type to set + object type to set - - Sets the widget name for the widget found at position @pos + + Sets the widget name for the widget found at position @pos in the widget hierarchy defined by @path. If you want to update just a single state flag, you need to do @@ -202311,99 +145439,67 @@ gtk_widget_path_iter_set_state (path, pos, gtk_widget_path_iter_get_state (path, - a #GtkWidgetPath + a #GtkWidgetPath - position to modify, -1 for the path head + position to modify, -1 for the path head - state flags + state flags - - Returns the number of #GtkWidget #GTypes between the represented + + Returns the number of #GtkWidget #GTypes between the represented widget and its topmost container. - the number of elements in the path + the number of elements in the path - a #GtkWidgetPath + a #GtkWidgetPath - - Prepends a widget type to the widget hierachy represented by @path. + + Prepends a widget type to the widget hierachy represented by @path. - a #GtkWidgetPath + a #GtkWidgetPath - widget type to prepend + widget type to prepend - Increments the reference count on @path. + Increments the reference count on @path. - @path itself. + @path itself. - a #GtkWidgetPath + a #GtkWidgetPath - - Dumps the widget path into a string representation. It tries to match + + Dumps the widget path into a string representation. It tries to match the CSS style as closely as possible (Note that there might be paths that cannot be represented in CSS). @@ -202411,24 +145507,18 @@ The main use of this code is for debugging purposes, so that you can g_print() the path or dump it in a gdb session. - A new string describing @path. + A new string describing @path. - the path + the path - Decrements the reference count on @path, freeing the structure + Decrements the reference count on @path, freeing the structure if the reference count reaches 0. @@ -202436,9 +145526,7 @@ if the reference count reaches 0. - a #GtkWidgetPath + a #GtkWidgetPath @@ -202447,16 +145535,8 @@ if the reference count reaches 0. - - A GtkWindow is a toplevel window which can contain other widgets. + + A GtkWindow is a toplevel window which can contain other widgets. Windows normally have decorations that are under the control of the windowing system and allow the user to manipulate the window (resize it, move it, close it,...). @@ -202486,16 +145566,16 @@ An example of a UI definition fragment with accel groups: ]| The GtkWindow implementation of the #GtkBuildable interface supports -setting a child as the titlebar by specifying “titlebar” as the “type” +setting a child as the titlebar by specifying “titlebar” as the “type” attribute of a <child> element. # CSS nodes |[<!-- language="plain" --> window.background -├── decoration -├── <titlebar child>.titlebar [.default-decoration] -╰── <child> +├── decoration +├── <titlebar child>.titlebar [.default-decoration] +╰── <child> ]| GtkWindow has a main CSS node with name window and style class .background, @@ -202515,20 +145595,18 @@ widget that is added as a titlebar child. - Creates a new #GtkWindow, which is a toplevel window that can + Creates a new #GtkWindow, which is a toplevel window that can contain other widgets. Nearly always, the type of the window should -be #GTK_WINDOW_TOPLEVEL. If you’re implementing something like a +be #GTK_WINDOW_TOPLEVEL. If you’re implementing something like a popup menu from scratch (which is a bad idea, just use #GtkMenu), you might use #GTK_WINDOW_POPUP. #GTK_WINDOW_POPUP is not for -dialogs, though in some other toolkits dialogs are called “popups”. +dialogs, though in some other toolkits dialogs are called “popups”. In GTK+, #GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the [window manager][gtk-X11-arch]. If you simply want an undecorated window (no window borders), use -gtk_window_set_decorated(), don’t use #GTK_WINDOW_POPUP. +gtk_window_set_decorated(), don’t use #GTK_WINDOW_POPUP. All top-level windows created by gtk_window_new() are stored in an internal top-level window list. This list can be obtained from @@ -202539,60 +145617,43 @@ to the caller. To delete a #GtkWindow, call gtk_widget_destroy(). - a new #GtkWindow. + a new #GtkWindow. - type of window + type of window - - Gets the value set by gtk_window_set_default_icon_list(). + + Gets the value set by gtk_window_set_default_icon_list(). The list is a copy and should be freed with g_list_free(), but the pixbufs in the list have not had their reference count incremented. - copy of default icon list + copy of default icon list - - Returns the fallback icon name for windows that has been set + + Returns the fallback icon name for windows that has been set with gtk_window_set_default_icon_name(). The returned string is owned by GTK+ and should not be modified. It is only valid until the next call to gtk_window_set_default_icon_name(). - the fallback icon name for windows + the fallback icon name for windows - Returns a list of all existing toplevel windows. The widgets + Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call @@ -202600,20 +145661,14 @@ callbacks that might destroy the widgets, you must call then unref all the widgets afterwards. - list of toplevel widgets + list of toplevel widgets - - By default, after showing the first #GtkWindow, GTK+ calls + + By default, after showing the first #GtkWindow, GTK+ calls gdk_notify_startup_complete(). Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification @@ -202628,19 +145683,13 @@ showing the main window would automatically result in notification. - %TRUE to automatically do startup notification + %TRUE to automatically do startup notification - - Sets an icon to be used as fallback for windows that haven't + + Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon() called on them from a pixbuf. @@ -202648,43 +145697,29 @@ had gtk_window_set_icon() called on them from a pixbuf. - the icon + the icon - - Sets an icon to be used as fallback for windows that haven't + + Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them from a file on disk. Warns on failure if @err is %NULL. - %TRUE if setting the icon succeeded. + %TRUE if setting the icon succeeded. - location of icon file + location of icon file - - Sets an icon list to be used as fallback for windows that haven't + + Sets an icon list to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once. @@ -202696,21 +145731,15 @@ See gtk_window_set_icon_list() for more details. - a list of #GdkPixbuf + a list of #GdkPixbuf - - Sets an icon to be used as fallback for windows that haven't + + Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them from a named themed icon, see gtk_window_set_icon_name(). @@ -202719,19 +145748,13 @@ themed icon, see gtk_window_set_icon_name(). - the name of the themed icon + the name of the themed icon - - Opens or closes the [interactive debugger][interactive-debugging], + + Opens or closes the [interactive debugger][interactive-debugging], which offers access to the widget hierarchy of the application and to useful debugging tools. @@ -202740,9 +145763,7 @@ and to useful debugging tools. - %TRUE to enable interactive debugging + %TRUE to enable interactive debugging @@ -202795,9 +145816,7 @@ and to useful debugging tools. - If @focus is not the current focus widget, and is focusable, sets + If @focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If @focus is %NULL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use @@ -202808,102 +145827,70 @@ gtk_widget_grab_focus() instead of this function. - a #GtkWindow + a #GtkWindow - - widget to be the new focus widget, or %NULL to unset + + widget to be the new focus widget, or %NULL to unset any focus widget for the toplevel window. - - Activates the default widget for the window, unless the current + + Activates the default widget for the window, unless the current focused widget has been configured to receive the default action (see gtk_widget_set_receives_default()), in which case the focused widget is activated. - %TRUE if a widget got activated. + %TRUE if a widget got activated. - a #GtkWindow + a #GtkWindow - Activates the current focused widget within the window. + Activates the current focused widget within the window. - %TRUE if a widget got activated. + %TRUE if a widget got activated. - a #GtkWindow + a #GtkWindow - - Activates mnemonics and accelerators for this #GtkWindow. This is normally + + Activates mnemonics and accelerators for this #GtkWindow. This is normally called by the default ::key_press_event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window. - %TRUE if a mnemonic or accelerator was found and activated. + %TRUE if a mnemonic or accelerator was found and activated. - a #GtkWindow + a #GtkWindow - a #GdkEventKey + a #GdkEventKey - Associate @accel_group with @window, such that calling + Associate @accel_group with @window, such that calling gtk_accel_groups_activate() on @window will activate accelerators in @accel_group. @@ -202912,52 +145899,38 @@ in @accel_group. - window to attach accelerator group to + window to attach accelerator group to - a #GtkAccelGroup + a #GtkAccelGroup - Adds a mnemonic to this window. + Adds a mnemonic to this window. - a #GtkWindow + a #GtkWindow - the mnemonic + the mnemonic - the widget that gets activated by the mnemonic + the widget that gets activated by the mnemonic - Starts moving a window. This function is used if an application has + Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing @@ -202969,42 +145942,29 @@ potentially not all that well, depending on the windowing system. - a #GtkWindow + a #GtkWindow - mouse button that initiated the drag + mouse button that initiated the drag - X position where the user clicked to initiate the drag, in root window coordinates + X position where the user clicked to initiate the drag, in root window coordinates - Y position where the user clicked to initiate the drag + Y position where the user clicked to initiate the drag - timestamp from the click event that initiated the drag + timestamp from the click event that initiated the drag - - Starts resizing a window. This function is used if an application + + Starts resizing a window. This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing @@ -203016,47 +145976,33 @@ potentially not all that well, depending on the windowing system. - a #GtkWindow + a #GtkWindow - position of the resize control + position of the resize control - mouse button that initiated the drag + mouse button that initiated the drag - X position where the user clicked to initiate the drag, in root window coordinates + X position where the user clicked to initiate the drag, in root window coordinates - Y position where the user clicked to initiate the drag + Y position where the user clicked to initiate the drag - timestamp from the click event that initiated the drag + timestamp from the click event that initiated the drag - Requests that the window is closed, similar to what happens + Requests that the window is closed, similar to what happens when a window manager close button is clicked. This function can be used with close buttons in custom @@ -203067,23 +146013,19 @@ titlebars. - a #GtkWindow + a #GtkWindow - Asks to deiconify (i.e. unminimize) the specified @window. Note -that you shouldn’t assume the window is definitely deiconified + Asks to deiconify (i.e. unminimize) the specified @window. Note +that you shouldn’t assume the window is definitely deiconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch])) could iconify it again before your code which assumes deiconification gets to run. -You can track iconification via the “window-state-event” signal +You can track iconification via the “window-state-event” signal on #GtkWidget. @@ -203091,27 +146033,21 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - - Asks to place @window in the fullscreen state. Note that you -shouldn’t assume the window is definitely full screen afterward, + + Asks to place @window in the fullscreen state. Note that you +shouldn’t assume the window is definitely full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just -don’t write code that crashes if not. +don’t write code that crashes if not. -You can track the fullscreen state via the “window-state-event” signal +You can track the fullscreen state via the “window-state-event” signal on #GtkWidget. @@ -203119,19 +146055,13 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - - Asks to place @window in the fullscreen state. Note that you shouldn't assume + + Asks to place @window in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward. You can track the fullscreen state via the "window-state-event" signal @@ -203142,121 +146072,82 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - a #GdkScreen to draw to + a #GdkScreen to draw to - which monitor to go fullscreen on + which monitor to go fullscreen on - - Gets the value set by gtk_window_set_accept_focus(). + + Gets the value set by gtk_window_set_accept_focus(). - %TRUE if window should receive the input focus + %TRUE if window should receive the input focus - a #GtkWindow + a #GtkWindow - - Gets the #GtkApplication associated with the window (if any). + + Gets the #GtkApplication associated with the window (if any). - a #GtkApplication, or %NULL + a #GtkApplication, or %NULL - a #GtkWindow + a #GtkWindow - - Fetches the attach widget for this window. See + + Fetches the attach widget for this window. See gtk_window_set_attached_to(). - the widget where the window + the widget where the window is attached, or %NULL if the window is not attached to any widget. - a #GtkWindow + a #GtkWindow - Returns whether the window has been set to have decorations + Returns whether the window has been set to have decorations such as a title bar via gtk_window_set_decorated(). - %TRUE if the window has been set to have decorations + %TRUE if the window has been set to have decorations - a #GtkWindow + a #GtkWindow - - Gets the default size of the window. A value of -1 for the width or + + Gets the default size of the window. A value of -1 for the width or height indicates that a default size has not been explicitly set -for that dimension, so the “natural” size of the window will be +for that dimension, so the “natural” size of the window will be used. @@ -203264,438 +146155,289 @@ used. - a #GtkWindow + a #GtkWindow - - location to store the default width, or %NULL + + location to store the default width, or %NULL - - location to store the default height, or %NULL + + location to store the default height, or %NULL - - Returns the default widget for @window. See + + Returns the default widget for @window. See gtk_window_set_default() for more details. - the default widget, or %NULL + the default widget, or %NULL if there is none. - a #GtkWindow + a #GtkWindow - - Returns whether the window has been set to have a close button + + Returns whether the window has been set to have a close button via gtk_window_set_deletable(). - %TRUE if the window has been set to have a close button + %TRUE if the window has been set to have a close button - a #GtkWindow + a #GtkWindow - - Returns whether the window will be destroyed with its transient parent. See + + Returns whether the window will be destroyed with its transient parent. See gtk_window_set_destroy_with_parent (). - %TRUE if the window will be destroyed with its transient parent. + %TRUE if the window will be destroyed with its transient parent. - a #GtkWindow + a #GtkWindow - Retrieves the current focused widget within the window. + Retrieves the current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then `gtk_widget_has_focus (widget)` will not be %TRUE for the widget. - the currently focused widget, + the currently focused widget, or %NULL if there is none. - a #GtkWindow + a #GtkWindow - - Gets the value set by gtk_window_set_focus_on_map(). + + Gets the value set by gtk_window_set_focus_on_map(). - %TRUE if window should receive the input focus when + %TRUE if window should receive the input focus when mapped. - a #GtkWindow + a #GtkWindow - - Gets the value of the #GtkWindow:focus-visible property. + + Gets the value of the #GtkWindow:focus-visible property. - %TRUE if “focus rectangles” are supposed to be visible + %TRUE if “focus rectangles” are supposed to be visible in this window. - a #GtkWindow + a #GtkWindow - Gets the value set by gtk_window_set_gravity(). + Gets the value set by gtk_window_set_gravity(). - window gravity + window gravity - a #GtkWindow + a #GtkWindow - - Returns the group for @window or the default group, if + + Returns the group for @window or the default group, if @window is %NULL or if @window does not have an explicit window group. - the #GtkWindowGroup for a window or the default group + the #GtkWindowGroup for a window or the default group - - a #GtkWindow, or %NULL + + a #GtkWindow, or %NULL - - Determines whether the window may have a resize grip. + + Determines whether the window may have a resize grip. Resize grips have been removed. - %TRUE if the window has a resize grip + %TRUE if the window has a resize grip - a #GtkWindow + a #GtkWindow - - Returns whether the window has requested to have its titlebar hidden + + Returns whether the window has requested to have its titlebar hidden when maximized. See gtk_window_set_hide_titlebar_when_maximized (). - %TRUE if the window has requested to have its titlebar + %TRUE if the window has requested to have its titlebar hidden when maximized - a #GtkWindow + a #GtkWindow - Gets the value set by gtk_window_set_icon() (or if you've + Gets the value set by gtk_window_set_icon() (or if you've called gtk_window_set_icon_list(), gets the first icon in the icon list). - icon for window or %NULL if none + icon for window or %NULL if none - a #GtkWindow + a #GtkWindow - Retrieves the list of icons set by gtk_window_set_icon_list(). + Retrieves the list of icons set by gtk_window_set_icon_list(). The list is copied, but the reference count on each -member won’t be incremented. +member won’t be incremented. - copy of window’s icon list + copy of window’s icon list - a #GtkWindow + a #GtkWindow - - Returns the name of the themed icon for the window, + + Returns the name of the themed icon for the window, see gtk_window_set_icon_name(). - the icon name or %NULL if the window has + the icon name or %NULL if the window has no themed icon - a #GtkWindow + a #GtkWindow - - Returns the mnemonic modifier for this window. See + + Returns the mnemonic modifier for this window. See gtk_window_set_mnemonic_modifier(). - the modifier mask used to activate + the modifier mask used to activate mnemonics on this window. - a #GtkWindow + a #GtkWindow - - Gets the value of the #GtkWindow:mnemonics-visible property. + + Gets the value of the #GtkWindow:mnemonics-visible property. - %TRUE if mnemonics are supposed to be visible + %TRUE if mnemonics are supposed to be visible in this window. - a #GtkWindow + a #GtkWindow - Returns whether the window is modal. See gtk_window_set_modal(). + Returns whether the window is modal. See gtk_window_set_modal(). - %TRUE if the window is set to be modal and + %TRUE if the window is set to be modal and establishes a grab when shown - a #GtkWindow + a #GtkWindow - - Fetches the requested opacity for this window. See + + Fetches the requested opacity for this window. See gtk_window_set_opacity(). Use gtk_widget_get_opacity instead. - the requested opacity for this window. + the requested opacity for this window. - a #GtkWindow + a #GtkWindow - This function returns the position you need to pass to + This function returns the position you need to pass to gtk_window_move() to keep @window in its current position. This means that the meaning of the returned value varies with window gravity. See gtk_window_move() for more details. @@ -203710,7 +146452,7 @@ have been known to mismanage window gravity, which result in windows moving even if you use the coordinates of the current position as returned by this function. -If you haven’t changed the window gravity, its gravity will be +If you haven’t changed the window gravity, its gravity will be #GDK_GRAVITY_NORTH_WEST. This means that gtk_window_get_position() gets the position of the top-left corner of the window manager frame for the window. gtk_window_move() sets the position of this @@ -203718,7 +146460,7 @@ same top-left corner. If a window has gravity #GDK_GRAVITY_STATIC the window manager frame is not relevant, and thus gtk_window_get_position() will -always produce accurate results. However you can’t use static +always produce accurate results. However you can’t use static gravity to do things like place a window in a corner of the screen, because static gravity ignores the window manager decorations. @@ -203737,141 +146479,88 @@ use a platform-specific protocol, wherever that is available. - a #GtkWindow + a #GtkWindow - - return location for X coordinate of + + return location for X coordinate of gravity-determined reference point, or %NULL - - return location for Y coordinate of + + return location for Y coordinate of gravity-determined reference point, or %NULL - Gets the value set by gtk_window_set_resizable(). + Gets the value set by gtk_window_set_resizable(). - %TRUE if the user can resize the window + %TRUE if the user can resize the window - a #GtkWindow + a #GtkWindow - - If a window has a resize grip, this will retrieve the grip + + If a window has a resize grip, this will retrieve the grip position, width and height into the specified #GdkRectangle. Resize grips have been removed. - %TRUE if the resize grip’s area was retrieved + %TRUE if the resize grip’s area was retrieved - a #GtkWindow + a #GtkWindow - - a pointer to a #GdkRectangle which we should store + + a pointer to a #GdkRectangle which we should store the resize grip area - Returns the role of the window. See gtk_window_set_role() for + Returns the role of the window. See gtk_window_set_role() for further explanation. - the role of the window if set, or %NULL. The + the role of the window if set, or %NULL. The returned is owned by the widget and must not be modified or freed. - a #GtkWindow + a #GtkWindow - - Returns the #GdkScreen associated with @window. + + Returns the #GdkScreen associated with @window. - a #GdkScreen. + a #GdkScreen. - a #GtkWindow. + a #GtkWindow. - Obtains the current size of @window. + Obtains the current size of @window. If @window is not visible on screen, this function return the size GTK+ will suggest to the [window manager][gtk-X11-arch] for the initial window @@ -203930,7 +146619,7 @@ decorations added by GTK+, depending on the windowing system in use. If you are getting a window size in order to position the window -on the screen, you should, instead, simply set the window’s semantic +on the screen, you should, instead, simply set the window’s semantic type with gtk_window_set_type_hint(), which allows the window manager to e.g. center dialogs. Also, if you set the transient parent of dialogs with gtk_window_set_transient_for() window managers will @@ -203949,271 +146638,182 @@ see: gtk_window_set_position(). - a #GtkWindow + a #GtkWindow - - return location for width, or %NULL + + return location for width, or %NULL - - return location for height, or %NULL + + return location for height, or %NULL - - Gets the value set by gtk_window_set_skip_pager_hint(). + + Gets the value set by gtk_window_set_skip_pager_hint(). - %TRUE if window shouldn’t be in pager + %TRUE if window shouldn’t be in pager - a #GtkWindow + a #GtkWindow - - Gets the value set by gtk_window_set_skip_taskbar_hint() + + Gets the value set by gtk_window_set_skip_taskbar_hint() - %TRUE if window shouldn’t be in taskbar + %TRUE if window shouldn’t be in taskbar - a #GtkWindow + a #GtkWindow - Retrieves the title of the window. See gtk_window_set_title(). + Retrieves the title of the window. See gtk_window_set_title(). - the title of the window, or %NULL if none has + the title of the window, or %NULL if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed. - a #GtkWindow + a #GtkWindow - - Returns the custom titlebar that has been set with + + Returns the custom titlebar that has been set with gtk_window_set_titlebar(). - the custom titlebar, or %NULL + the custom titlebar, or %NULL - a #GtkWindow + a #GtkWindow - - Fetches the transient parent for this window. See + + Fetches the transient parent for this window. See gtk_window_set_transient_for(). - the transient parent for this + the transient parent for this window, or %NULL if no transient parent has been set. - a #GtkWindow + a #GtkWindow - Gets the type hint for this window. See gtk_window_set_type_hint(). + Gets the type hint for this window. See gtk_window_set_type_hint(). - the type hint for @window. + the type hint for @window. - a #GtkWindow + a #GtkWindow - - Gets the value set by gtk_window_set_urgency_hint() + + Gets the value set by gtk_window_set_urgency_hint() - %TRUE if window is urgent + %TRUE if window is urgent - a #GtkWindow + a #GtkWindow - - Gets the type of the window. See #GtkWindowType. + + Gets the type of the window. See #GtkWindowType. - the type of the window + the type of the window - a #GtkWindow + a #GtkWindow - Returns whether @window has an explicit window group. + Returns whether @window has an explicit window group. - %TRUE if @window has an explicit window group. + %TRUE if @window has an explicit window group. Since 2.22 - a #GtkWindow + a #GtkWindow - - Returns whether the input focus is within this GtkWindow. + + Returns whether the input focus is within this GtkWindow. For real toplevel windows, this is identical to gtk_window_is_active(), but for embedded windows, like #GtkPlug, the results will differ. - %TRUE if the input focus is within this GtkWindow + %TRUE if the input focus is within this GtkWindow - a #GtkWindow + a #GtkWindow - Asks to iconify (i.e. minimize) the specified @window. Note that -you shouldn’t assume the window is definitely iconified afterward, + Asks to iconify (i.e. minimize) the specified @window. Note that +you shouldn’t assume the window is definitely iconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could deiconify it again, or there may not be a window manager in which case -iconification isn’t possible, etc. But normally the window will end -up iconified. Just don’t write code that crashes if not. +iconification isn’t possible, etc. But normally the window will end +up iconified. Just don’t write code that crashes if not. -It’s permitted to call this function before showing a window, +It’s permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen. -You can track iconification via the “window-state-event” signal +You can track iconification via the “window-state-event” signal on #GtkWidget. @@ -204221,19 +146821,13 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - - Returns whether the window is part of the current active toplevel. + + Returns whether the window is part of the current active toplevel. (That is, the toplevel window receiving keystrokes.) The return value is %TRUE if the window is active toplevel itself, but also if it is, say, a #GtkPlug embedded in the active toplevel. @@ -204242,64 +146836,50 @@ differently in an active window from a widget in an inactive window. See gtk_window_has_toplevel_focus() - %TRUE if the window part of the current active window. + %TRUE if the window part of the current active window. - a #GtkWindow + a #GtkWindow - - Retrieves the current maximized state of @window. + + Retrieves the current maximized state of @window. Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you -shouldn’t assume the return value of this function changing +shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling gtk_window_maximize() or gtk_window_unmaximize(). - whether the window has a maximized state. + whether the window has a maximized state. - a #GtkWindow + a #GtkWindow - Asks to maximize @window, so that it becomes full-screen. Note that -you shouldn’t assume the window is definitely maximized afterward, + Asks to maximize @window, so that it becomes full-screen. Note that +you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unmaximize it again, and not all window managers support maximization. But -normally the window will end up maximized. Just don’t write code +normally the window will end up maximized. Just don’t write code that crashes if not. -It’s permitted to call this function before showing a window, +It’s permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially. -You can track maximization via the “window-state-event” signal +You can track maximization via the “window-state-event” signal on #GtkWidget, or by listening to notifications on the #GtkWindow:is-maximized property. @@ -204308,50 +146888,35 @@ on #GtkWidget, or by listening to notifications on the - a #GtkWindow + a #GtkWindow - - Activates the targets associated with the mnemonic. + + Activates the targets associated with the mnemonic. - %TRUE if the activation is done. + %TRUE if the activation is done. - a #GtkWindow + a #GtkWindow - the mnemonic + the mnemonic - the modifiers + the modifiers - Asks the [window manager][gtk-X11-arch] to move + Asks the [window manager][gtk-X11-arch] to move @window to the given position. Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and @@ -204381,7 +146946,7 @@ gdk_screen_height () - window_height)` (note that this example does not take multi-head scenarios into account). The [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec) -has a nice table of gravities in the “implementation notes” section. +has a nice table of gravities in the “implementation notes” section. The gtk_window_get_position() documentation may also be relevant. @@ -204390,33 +146955,22 @@ The gtk_window_get_position() documentation may also be relevant. - a #GtkWindow + a #GtkWindow - X coordinate to move window to + X coordinate to move window to - Y coordinate to move window to + Y coordinate to move window to - - Parses a standard X Window System geometry string - see the -manual page for X (type “man X”) for details on this. + + Parses a standard X Window System geometry string - see the +manual page for X (type “man X”) for details on this. gtk_window_parse_geometry() does work on all GTK+ ports including Win32 but is primarily intended for an X environment. @@ -204432,7 +146986,7 @@ the window was user-specified. This causes most window managers to honor the geometry. Note that for gtk_window_parse_geometry() to work as expected, it has -to be called when the window has its “final” size, i.e. after calling +to be called when the window has its “final” size, i.e. after calling gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints() on the window. |[<!-- language="C" --> @@ -204476,7 +147030,7 @@ main (int argc, char *argv[]) argv[1]); if (! res) fprintf (stderr, - "Failed to parse “%s”\n", + "Failed to parse “%s”\n", argv[1]); } @@ -204489,30 +147043,22 @@ main (int argc, char *argv[]) Geometry handling in GTK is deprecated. - %TRUE if string was parsed successfully + %TRUE if string was parsed successfully - a #GtkWindow + a #GtkWindow - geometry string + geometry string - Presents a window to the user. This function should not be used + Presents a window to the user. This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly. @@ -204521,28 +147067,22 @@ to allow focus stealing prevention to work correctly. - a #GtkWindow + a #GtkWindow - - Presents a window to the user. This may mean raising the window + + Presents a window to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent -on the user’s platform, window manager, and preferences. +on the user’s platform, window manager, and preferences. If @window is hidden, this function calls gtk_widget_show() as well. This function should be used when the user tries to open a window -that’s already open. Say for example the preferences dialog is +that’s already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use gtk_window_present() to move the already-open dialog where the user can see it. @@ -204557,26 +147097,18 @@ ready to be shown. - a #GtkWindow + a #GtkWindow - the timestamp of the user interaction (typically a + the timestamp of the user interaction (typically a button or key press event) which triggered this call - - Propagate a key press or release event to the focus widget and + + Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles @event. This is normally called by the default ::key_press_event and ::key_release_event handlers for toplevel windows, @@ -204584,86 +147116,60 @@ however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window. - %TRUE if a widget in the focus chain handled the event. + %TRUE if a widget in the focus chain handled the event. - a #GtkWindow + a #GtkWindow - a #GdkEventKey + a #GdkEventKey - - Reverses the effects of gtk_window_add_accel_group(). + + Reverses the effects of gtk_window_add_accel_group(). - a #GtkWindow + a #GtkWindow - a #GtkAccelGroup + a #GtkAccelGroup - Removes a mnemonic from this window. + Removes a mnemonic from this window. - a #GtkWindow + a #GtkWindow - the mnemonic + the mnemonic - the widget that gets activated by the mnemonic + the widget that gets activated by the mnemonic - - Hides @window, then reshows it, resetting the + + Hides @window, then reshows it, resetting the default size and position of the window. Used by GUI builders only. GUI builders can call gtk_widget_hide(), @@ -204675,17 +147181,13 @@ by GUI builders only. - a #GtkWindow + a #GtkWindow - Resizes the window as if the user had done so, obeying geometry + Resizes the window as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call gtk_widget_set_size_request() to set the window's @@ -204719,58 +147221,36 @@ a larger window. - a #GtkWindow + a #GtkWindow - width in pixels to resize the window to + width in pixels to resize the window to - height in pixels to resize the window to + height in pixels to resize the window to - - Determines whether a resize grip is visible for the specified window. + + Determines whether a resize grip is visible for the specified window. Resize grips have been removed. - %TRUE if a resize grip exists and is visible + %TRUE if a resize grip exists and is visible - a #GtkWindow + a #GtkWindow - - Like gtk_window_resize(), but @width and @height are interpreted + + Like gtk_window_resize(), but @width and @height are interpreted in terms of the base size and increment set with gtk_window_set_geometry_hints. This function does nothing. Use @@ -204781,31 +147261,21 @@ gtk_window_set_geometry_hints. - a #GtkWindow + a #GtkWindow - width in resize increments to resize the window to + width in resize increments to resize the window to - height in resize increments to resize the window to + height in resize increments to resize the window to - - Windows may set a hint asking the desktop environment not to receive + + Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint. @@ -204813,25 +147283,17 @@ the input focus. This function sets this hint. - a #GtkWindow + a #GtkWindow - %TRUE to let this window receive input focus + %TRUE to let this window receive input focus - - Sets or unsets the #GtkApplication associated with the window. + + Sets or unsets the #GtkApplication associated with the window. The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive @@ -204849,28 +147311,17 @@ gtk_application_add_window() on the old/new applications as relevant. - a #GtkWindow + a #GtkWindow - - a #GtkApplication, or %NULL to unset + + a #GtkApplication, or %NULL to unset - - Marks @window as attached to @attach_widget. This creates a logical binding + + Marks @window as attached to @attach_widget. This creates a logical binding between the window and the widget it belongs to, which is used by GTK+ to propagate information such as styling or accessibility to @window as if it was a children of @attach_widget. @@ -204890,26 +147341,17 @@ Passing %NULL for @attach_widget detaches the window. - a #GtkWindow + a #GtkWindow - - a #GtkWidget, or %NULL + + a #GtkWidget, or %NULL - By default, windows are decorated with a title bar, resize + By default, windows are decorated with a title bar, resize controls, etc. Some [window managers][gtk-X11-arch] allow GTK+ to disable these decorations, creating a borderless window. If you set the decorated property to %FALSE @@ -204918,7 +147360,7 @@ manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling gtk_widget_show(). -On Windows, this function always works, since there’s no window manager +On Windows, this function always works, since there’s no window manager policy involved. @@ -204926,60 +147368,41 @@ policy involved. - a #GtkWindow + a #GtkWindow - %TRUE to decorate the window + %TRUE to decorate the window - The default widget is the widget that’s activated when the user + The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget for a #GtkWindow. When setting (rather -than unsetting) the default widget it’s generally easier to call +than unsetting) the default widget it’s generally easier to call gtk_widget_grab_default() on the widget. Before making a widget the default widget, you must call gtk_widget_set_can_default() on -the widget you’d like to make the default. +the widget you’d like to make the default. - a #GtkWindow + a #GtkWindow - - widget to be the default, or %NULL + + widget to be the default, or %NULL to unset the default widget for the toplevel - - Like gtk_window_set_default_size(), but @width and @height are interpreted + + Like gtk_window_set_default_size(), but @width and @height are interpreted in terms of the base size and increment set with gtk_window_set_geometry_hints. This function does nothing. If you want to set a default @@ -204990,30 +147413,21 @@ gtk_window_set_geometry_hints. - a #GtkWindow + a #GtkWindow - width in resize increments, or -1 to unset the default width + width in resize increments, or -1 to unset the default width - height in resize increments, or -1 to unset the default height + height in resize increments, or -1 to unset the default height - - Sets the default size of a window. If the window’s “natural” size + + Sets the default size of a window. If the window’s “natural” size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (gtk_window_set_geometry_hints() can @@ -205025,9 +147439,9 @@ a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to -use the “natural” default size (the size request of the window). +use the “natural” default size (the size request of the window). -For more control over a window’s initial size and how resizing works, +For more control over a window’s initial size and how resizing works, investigate gtk_window_set_geometry_hints(). For some uses, gtk_window_resize() is a more appropriate function. @@ -205039,7 +147453,7 @@ The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size. -Windows can’t actually be 0x0 in size, they must be at least 1x1, but +Windows can’t actually be 0x0 in size, they must be at least 1x1, but passing 0 for @width and @height is OK, resulting in a 1x1 default size. If you use this function to reestablish a previously saved window size, @@ -205052,31 +147466,21 @@ work in all circumstances and can lead to growing or shrinking windows. - a #GtkWindow + a #GtkWindow - width in pixels, or -1 to unset the default width + width in pixels, or -1 to unset the default width - height in pixels, or -1 to unset the default height + height in pixels, or -1 to unset the default height - - By default, windows have a close button in the window frame. Some + + By default, windows have a close button in the window frame. Some [window managers][gtk-X11-arch] allow GTK+ to disable this button. If you set the deletable property to %FALSE using this function, GTK+ will do its best to convince the window @@ -205084,7 +147488,7 @@ manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling gtk_widget_show(). -On Windows, this function always works, since there’s no window manager +On Windows, this function always works, since there’s no window manager policy involved. @@ -205092,26 +147496,19 @@ policy involved. - a #GtkWindow + a #GtkWindow - %TRUE to decorate the window as deletable + %TRUE to decorate the window as deletable - - If @setting is %TRUE, then destroying the transient parent of @window + + If @setting is %TRUE, then destroying the transient parent of @window will also destroy @window itself. This is useful for dialogs that -shouldn’t persist beyond the lifetime of the main window they're +shouldn’t persist beyond the lifetime of the main window they're associated with, for example. @@ -205119,23 +147516,17 @@ associated with, for example. - a #GtkWindow + a #GtkWindow - whether to destroy @window with its transient parent + whether to destroy @window with its transient parent - If @focus is not the current focus widget, and is focusable, sets + If @focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If @focus is %NULL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use @@ -205146,29 +147537,18 @@ gtk_widget_grab_focus() instead of this function. - a #GtkWindow + a #GtkWindow - - widget to be the new focus widget, or %NULL to unset + + widget to be the new focus widget, or %NULL to unset any focus widget for the toplevel window. - - Windows may set a hint asking the desktop environment not to receive + + Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. This function sets this hint. @@ -205177,49 +147557,34 @@ hint. - a #GtkWindow + a #GtkWindow - %TRUE to let this window receive input focus on map + %TRUE to let this window receive input focus on map - - Sets the #GtkWindow:focus-visible property. + + Sets the #GtkWindow:focus-visible property. - a #GtkWindow + a #GtkWindow - the new value + the new value - - This function sets up hints about how a window can be resized by + + This function sets up hints about how a window can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the #GdkGeometry struct. @@ -205229,75 +147594,49 @@ character); aspect ratios; and more. See the #GdkGeometry struct. - a #GtkWindow + a #GtkWindow - - widget the geometry hints used to be applied to + + widget the geometry hints used to be applied to or %NULL. Since 3.20 this argument is ignored and GTK behaves as if %NULL was set. - - struct containing geometry information or %NULL + + struct containing geometry information or %NULL - mask indicating which struct fields should be paid attention to + mask indicating which struct fields should be paid attention to - Window gravity defines the meaning of coordinates passed to + Window gravity defines the meaning of coordinates passed to gtk_window_move(). See gtk_window_move() and #GdkGravity for more details. The default window gravity is #GDK_GRAVITY_NORTH_WEST which will -typically “do what you mean.” +typically “do what you mean.” - a #GtkWindow + a #GtkWindow - window gravity + window gravity - - Sets whether @window has a corner resize grip. + + Sets whether @window has a corner resize grip. Note that the resize grip is only shown if the window is actually resizable and not maximized. Use @@ -205310,25 +147649,17 @@ resize grip is currently shown. - a #GtkWindow + a #GtkWindow - %TRUE to allow a resize grip + %TRUE to allow a resize grip - - Tells GTK+ whether to drop its extra reference to the window + + Tells GTK+ whether to drop its extra reference to the window when gtk_widget_destroy() is called. This function is only exported for the benefit of language @@ -205341,27 +147672,19 @@ for ever calling this function in an application. - a #GtkWindow + a #GtkWindow - the new value + the new value - - If @setting is %TRUE, then @window will request that it’s titlebar + + If @setting is %TRUE, then @window will request that it’s titlebar should be hidden when maximized. -This is useful for windows that don’t convey any information other +This is useful for windows that don’t convey any information other than the application name in the titlebar, to put the available screen space to better use. If the underlying window system does not support the request, the setting will not have any effect. @@ -205375,30 +147698,24 @@ content and visibility anyway. - a #GtkWindow + a #GtkWindow - whether to hide the titlebar when @window is maximized + whether to hide the titlebar when @window is maximized - Sets up the icon representing a #GtkWindow. This icon is used when + Sets up the icon representing a #GtkWindow. This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary. The icon should be provided in whatever size it was naturally -drawn; that is, don’t scale the image before passing it to +drawn; that is, don’t scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality. @@ -205416,59 +147733,39 @@ for all windows in your application in one go. - a #GtkWindow + a #GtkWindow - - icon image, or %NULL + + icon image, or %NULL - - Sets the icon for @window. + + Sets the icon for @window. Warns on failure if @err is %NULL. This function is equivalent to calling gtk_window_set_icon() with a pixbuf created by loading the image from @filename. - %TRUE if setting the icon succeeded. + %TRUE if setting the icon succeeded. - a #GtkWindow + a #GtkWindow - location of icon file + location of icon file - Sets up the icon representing a #GtkWindow. The icon is used when + Sets up the icon representing a #GtkWindow. The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not @@ -205476,7 +147773,7 @@ used at all, so your mileage may vary. gtk_window_set_icon_list() allows you to pass in the same icon in several hand-drawn sizes. The list should contain the natural sizes -your icon is available in; that is, don’t scale the image before +your icon is available in; that is, don’t scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality. @@ -205491,7 +147788,7 @@ for all windows in your application in one go. Note that transient windows (those who have been set transient for another window using gtk_window_set_transient_for()) will inherit their -icon from their transient parent. So there’s no need to explicitly +icon from their transient parent. So there’s no need to explicitly set the icon on transient windows. @@ -205499,27 +147796,19 @@ set the icon on transient windows. - a #GtkWindow + a #GtkWindow - list of #GdkPixbuf + list of #GdkPixbuf - - Sets the icon for the window from a named themed icon. + + Sets the icon for the window from a named themed icon. See the docs for #GtkIconTheme for more details. On some platforms, the window icon is not used at all. @@ -205531,40 +147820,29 @@ property which is mentioned in the ICCCM. - a #GtkWindow + a #GtkWindow - - the name of the themed icon + + the name of the themed icon - - Asks to keep @window above, so that it stays on top. Note that -you shouldn’t assume the window is definitely above afterward, + + Asks to keep @window above, so that it stays on top. Note that +you shouldn’t assume the window is definitely above afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it above, and not all window managers support keeping windows above. But -normally the window will end kept above. Just don’t write code +normally the window will end kept above. Just don’t write code that crashes if not. -It’s permitted to call this function before showing a window, +It’s permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially. -You can track the above state via the “window-state-event” signal +You can track the above state via the “window-state-event” signal on #GtkWidget. Note that, according to the @@ -205578,37 +147856,29 @@ dialogs. - a #GtkWindow + a #GtkWindow - whether to keep @window above other windows + whether to keep @window above other windows - - Asks to keep @window below, so that it stays in bottom. Note that -you shouldn’t assume the window is definitely below afterward, + + Asks to keep @window below, so that it stays in bottom. Note that +you shouldn’t assume the window is definitely below afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it below, and not all window managers support putting windows below. But -normally the window will be kept below. Just don’t write code +normally the window will be kept below. Just don’t write code that crashes if not. -It’s permitted to call this function before showing a window, +It’s permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially. -You can track the below state via the “window-state-event” signal +You can track the below state via the “window-state-event” signal on #GtkWidget. Note that, according to the @@ -205622,73 +147892,52 @@ dialogs. - a #GtkWindow + a #GtkWindow - whether to keep @window below other windows + whether to keep @window below other windows - - Sets the mnemonic modifier for this window. + + Sets the mnemonic modifier for this window. - a #GtkWindow + a #GtkWindow - the modifier mask used to activate + the modifier mask used to activate mnemonics on this window. - - Sets the #GtkWindow:mnemonics-visible property. + + Sets the #GtkWindow:mnemonics-visible property. - a #GtkWindow + a #GtkWindow - the new value + the new value - Sets a window modal or non-modal. Modal windows prevent interaction + Sets a window modal or non-modal. Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use gtk_window_set_transient_for() to make the dialog transient for the @@ -205700,34 +147949,24 @@ will then disallow lowering the dialog below the parent. - a #GtkWindow + a #GtkWindow - whether the window is modal + whether the window is modal - - Request the windowing system to make @window partially transparent, + + Request the windowing system to make @window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See gtk_widget_is_composited(). On Windows it should work always. -Note that setting a window’s opacity after the window has been +Note that setting a window’s opacity after the window has been shown causes it to flicker once on Windows. Use gtk_widget_set_opacity instead. @@ -205736,23 +147975,17 @@ shown causes it to flicker once on Windows. - a #GtkWindow + a #GtkWindow - desired opacity, between 0 and 1 + desired opacity, between 0 and 1 - Sets a position constraint for this window. If the old or new + Sets a position constraint for this window. If the old or new constraint is %GTK_WIN_POS_CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint. @@ -205761,23 +147994,17 @@ the window to be repositioned to satisfy the new constraint. - a #GtkWindow. + a #GtkWindow. - a position constraint. + a position constraint. - Sets whether the user can resize a window. Windows are user resizable + Sets whether the user can resize a window. Windows are user resizable by default. @@ -205785,32 +148012,26 @@ by default. - a #GtkWindow + a #GtkWindow - %TRUE if the user can resize this window + %TRUE if the user can resize this window - This function is only useful on X11, not with other GTK+ targets. + This function is only useful on X11, not with other GTK+ targets. In combination with the window title, the window role allows a [window manager][gtk-X11-arch] to identify "the same" window when an application is restarted. So for example you -might set the “toolbox” role on your app’s toolbox window, so that +might set the “toolbox” role on your app’s toolbox window, so that when the user restarts their session, the window manager can put the toolbox back in the same place. -If a window already has a unique title, you don’t need to set the +If a window already has a unique title, you don’t need to set the role, since the WM can use the title to identify the window when restoring the session. @@ -205819,25 +148040,17 @@ restoring the session. - a #GtkWindow + a #GtkWindow - unique identifier for the window to be used when restoring a session + unique identifier for the window to be used when restoring a session - - Sets the #GdkScreen where the @window is displayed; if + + Sets the #GdkScreen where the @window is displayed; if the window is already mapped, it will be unmapped, and then remapped on the new screen. @@ -205846,25 +148059,17 @@ then remapped on the new screen. - a #GtkWindow. + a #GtkWindow. - a #GdkScreen. + a #GdkScreen. - - Windows may set a hint asking the desktop environment not to display + + Windows may set a hint asking the desktop environment not to display the window in the pager. This function sets this hint. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows @@ -205875,25 +148080,17 @@ on the screen.) - a #GtkWindow + a #GtkWindow - %TRUE to keep this window from appearing in the pager + %TRUE to keep this window from appearing in the pager - - Windows may set a hint asking the desktop environment not to display + + Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint. @@ -205901,25 +148098,17 @@ the window in the task bar. This function sets this hint. - a #GtkWindow + a #GtkWindow - %TRUE to keep this window from appearing in the task bar + %TRUE to keep this window from appearing in the task bar - - Startup notification identifiers are used by desktop environment to + + Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GdkWindow. Normally, startup identifier is managed @@ -205935,27 +148124,21 @@ This function is only useful on X11, not with other GTK+ targets. - a #GtkWindow + a #GtkWindow - a string with startup-notification identifier + a string with startup-notification identifier - Sets the title of the #GtkWindow. The title of a window will be + Sets the title of the #GtkWindow. The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the [window manager][gtk-X11-arch], so exactly how the title appears to users may vary -according to a user’s exact configuration. The title should help a +according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example. @@ -205965,25 +148148,17 @@ document filename, for example. - a #GtkWindow + a #GtkWindow - title of the window + title of the window - - Sets a custom titlebar for @window. + + Sets a custom titlebar for @window. A typical widget used here is #GtkHeaderBar, as it provides various features expected of a titlebar while allowing the addition of child widgets to it. @@ -205999,27 +148174,17 @@ gtk_widget_show(). - a #GtkWindow + a #GtkWindow - - the widget to use as titlebar + + the widget to use as titlebar - - Dialog windows should be set transient for the main application + + Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the @@ -206043,26 +148208,17 @@ much as the window manager would have done on X. - a #GtkWindow + a #GtkWindow - - parent window, or %NULL + + parent window, or %NULL - By setting the type hint for the window, you allow the window + By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application. @@ -206076,25 +148232,17 @@ will sometimes call gtk_window_set_type_hint() on your behalf. - a #GtkWindow + a #GtkWindow - the window type + the window type - - Windows may set a hint asking the desktop environment to draw + + Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint. @@ -206102,27 +148250,18 @@ the users attention to the window. This function sets this hint. - a #GtkWindow + a #GtkWindow - %TRUE to mark this window as urgent + %TRUE to mark this window as urgent - - Don’t use this function. It sets the X Window System “class” and -“name” hints for a window. According to the ICCCM, you should + + Don’t use this function. It sets the X Window System “class” and +“name” hints for a window. According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this function is sort of pointless. However, you may want to call @@ -206135,39 +148274,31 @@ manager to restore window positions when loading a saved session. - a #GtkWindow + a #GtkWindow - window name hint + window name hint - window class hint + window class hint - Asks to stick @window, which means that it will appear on all user -desktops. Note that you shouldn’t assume the window is definitely + Asks to stick @window, which means that it will appear on all user +desktops. Note that you shouldn’t assume the window is definitely stuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch] could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not. -It’s permitted to call this function before showing a window. +It’s permitted to call this function before showing a window. -You can track stickiness via the “window-state-event” signal +You can track stickiness via the “window-state-event” signal on #GtkWidget. @@ -206175,27 +148306,21 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - - Asks to toggle off the fullscreen state for @window. Note that you -shouldn’t assume the window is definitely not full screen + + Asks to toggle off the fullscreen state for @window. Note that you +shouldn’t assume the window is definitely not full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal -state. Just don’t write code that crashes if not. +state. Just don’t write code that crashes if not. -You can track the fullscreen state via the “window-state-event” signal +You can track the fullscreen state via the “window-state-event” signal on #GtkWidget. @@ -206203,24 +148328,20 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - Asks to unmaximize @window. Note that you shouldn’t assume the + Asks to unmaximize @window. Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will -end up unmaximized. Just don’t write code that crashes if not. +end up unmaximized. Just don’t write code that crashes if not. -You can track maximization via the “window-state-event” signal +You can track maximization via the “window-state-event” signal on #GtkWidget. @@ -206228,24 +148349,20 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - Asks to unstick @window, which means that it will appear on only -one of the user’s desktops. Note that you shouldn’t assume the + Asks to unstick @window, which means that it will appear on only +one of the user’s desktops. Note that you shouldn’t assume the window is definitely unstuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could stick it again. But normally the window will -end up stuck. Just don’t write code that crashes if not. +end up stuck. Just don’t write code that crashes if not. -You can track stickiness via the “window-state-event” signal +You can track stickiness via the “window-state-event” signal on #GtkWidget. @@ -206253,29 +148370,17 @@ on #GtkWidget. - a #GtkWindow + a #GtkWindow - - Whether the window should receive the input focus. + + Whether the window should receive the input focus. - - The #GtkApplication associated with the window. + + The #GtkApplication associated with the window. The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() @@ -206286,14 +148391,8 @@ will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to %NULL. - - The widget to which this window is attached. + + The widget to which this window is attached. See gtk_window_set_attached_to(). Examples of places where specifying this relation is useful are @@ -206302,13 +148401,8 @@ popup window created by #GtkEntry or a typeahead search entry created by #GtkTreeView. - - Whether the window should be decorated by the window manager. + + Whether the window should be decorated by the window manager. @@ -206317,60 +148411,31 @@ created by #GtkTreeView. - - Whether the window frame should have a close button. + + Whether the window frame should have a close button. - + - - Whether the window should receive the input focus when mapped. + + Whether the window should receive the input focus when mapped. - - Whether 'focus rectangles' are currently visible in this window. + + Whether 'focus rectangles' are currently visible in this window. This property is maintained by GTK+ based on user input and should not be set by applications. - - The window gravity of the window. See gtk_window_move() and #GdkGravity for + + The window gravity of the window. See gtk_window_move() and #GdkGravity for more details about window gravity. - - Whether the window has a corner resize grip. + + Whether the window has a corner resize grip. Note that the resize grip is only shown if the window is actually resizable and not maximized. Use @@ -206382,25 +148447,15 @@ grip is currently shown. - - Whether the titlebar should be hidden during maximization. + + Whether the titlebar should be hidden during maximization. - - The :icon-name property specifies the name of the themed icon to + + The :icon-name property specifies the name of the themed icon to use as the window icon. See #GtkIconTheme for more details. @@ -206410,13 +148465,8 @@ use as the window icon. See #GtkIconTheme for more details. - - Whether mnemonics are currently visible in this window. + + Whether mnemonics are currently visible in this window. This property is maintained by GTK+ based on user input, and should not be set by applications. @@ -206428,14 +148478,8 @@ and should not be set by applications. - - Whether a corner resize grip is currently shown. + + Whether a corner resize grip is currently shown. Resize grips have been removed. @@ -206448,19 +148492,11 @@ and should not be set by applications. - + - - The :startup-id is a write-only property for setting window's + + The :startup-id is a write-only property for setting window's startup notification identifier. See gtk_window_set_startup_id() for more details. @@ -206468,21 +148504,12 @@ for more details. - - The transient parent of the window. See gtk_window_set_transient_for() for + + The transient parent of the window. See gtk_window_set_transient_for() for more details about transient windows. - + @@ -206501,9 +148528,7 @@ more details about transient windows. - The ::activate-default signal is a + The ::activate-default signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the default widget of @window. @@ -206512,9 +148537,7 @@ of @window. - The ::activate-focus signal is a + The ::activate-focus signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the currently focused widget of @window. @@ -206523,9 +148546,7 @@ focused widget of @window. - The ::enable-debugging signal is a [keybinding signal][GtkBindingSignal] + The ::enable-debugging signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user enables or disables interactive debugging. When @toggle is %TRUE, interactive debugging is toggled on or off, when it is %FALSE, the debugger will be pointed at the @@ -206534,57 +148555,38 @@ widget under the pointer. The default bindings for this signal are Ctrl-Shift-I and Ctrl-Shift-D. - %TRUE if the key binding was handled + %TRUE if the key binding was handled - toggle the debugger + toggle the debugger - The ::keys-changed signal gets emitted when the set of accelerators + The ::keys-changed signal gets emitted when the set of accelerators or mnemonics that are associated with @window changes. - This signal is emitted whenever the currently focused widget in + This signal is emitted whenever the currently focused widget in this window changes. - - the newly focused widget (or %NULL for no focus) + + the newly focused widget (or %NULL for no focus) - + @@ -206592,32 +148594,22 @@ this window changes. - + - + - + - + - + - The parent class. + The parent class. @@ -206628,18 +148620,11 @@ this window changes. - a #GtkWindow + a #GtkWindow - - widget to be the new focus widget, or %NULL to unset + + widget to be the new focus widget, or %NULL to unset any focus widget for the toplevel window. @@ -206726,21 +148711,11 @@ this window changes. - + - - A #GtkWindowGroup restricts the effect of grabs to windows + + A #GtkWindowGroup restricts the effect of grabs to windows in the same group, thereby making window groups almost behave like separate applications. @@ -206757,103 +148732,69 @@ group; when all window have been removed, the window group will be freed. - Creates a new #GtkWindowGroup object. Grabs added with + Creates a new #GtkWindowGroup object. Grabs added with gtk_grab_add() only affect windows within the same #GtkWindowGroup. - a new #GtkWindowGroup. + a new #GtkWindowGroup. - Adds a window to a #GtkWindowGroup. + Adds a window to a #GtkWindowGroup. - a #GtkWindowGroup + a #GtkWindowGroup - the #GtkWindow to add + the #GtkWindow to add - - Returns the current grab widget for @device, or %NULL if none. + + Returns the current grab widget for @device, or %NULL if none. - The grab widget, or %NULL + The grab widget, or %NULL - a #GtkWindowGroup + a #GtkWindowGroup - a #GdkDevice + a #GdkDevice - - Gets the current grab widget of the given group, + + Gets the current grab widget of the given group, see gtk_grab_add(). - the current grab widget of the group + the current grab widget of the group - a #GtkWindowGroup + a #GtkWindowGroup - - Returns a list of the #GtkWindows that belong to @window_group. + + Returns a list of the #GtkWindows that belong to @window_group. - A + A newly-allocated list of windows inside the group. @@ -206861,33 +148802,24 @@ see gtk_grab_add(). - a #GtkWindowGroup + a #GtkWindowGroup - - Removes a window from a #GtkWindowGroup. + + Removes a window from a #GtkWindowGroup. - a #GtkWindowGroup + a #GtkWindowGroup - the #GtkWindow to remove + the #GtkWindow to remove @@ -206899,9 +148831,7 @@ see gtk_grab_add(). - + @@ -206939,191 +148869,103 @@ see gtk_grab_add(). - + - - Window placement can be influenced using this enumeration. Note that + + Window placement can be influenced using this enumeration. Note that using #GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea. -It won’t necessarily work well with all window managers or on all windowing systems. - - No influence is made on placement. +It won’t necessarily work well with all window managers or on all windowing systems. + + No influence is made on placement. - - Windows should be placed in the center of the screen. + + Windows should be placed in the center of the screen. - - Windows should be placed at the current mouse position. + + Windows should be placed at the current mouse position. - - Keep window centered as it changes size, etc. + + Keep window centered as it changes size, etc. - - Center the window on its transient + + Center the window on its transient parent (see gtk_window_set_transient_for()). - - A #GtkWindow can be one of these types. Most things you’d consider a -“window” should have type #GTK_WINDOW_TOPLEVEL; windows with this type + + A #GtkWindow can be one of these types. Most things you’d consider a +“window” should have type #GTK_WINDOW_TOPLEVEL; windows with this type are managed by the window manager and have a frame by default (call gtk_window_set_decorated() to toggle the frame). Windows with type #GTK_WINDOW_POPUP are ignored by the window manager; window manager -keybindings won’t work on them, the window manager won’t decorate the +keybindings won’t work on them, the window manager won’t decorate the window with a frame, many GTK+ features that rely on the window manager will not work (e.g. resize grips and maximization/minimization). #GTK_WINDOW_POPUP is used to implement -widgets such as #GtkMenu or tooltips that you normally don’t think of +widgets such as #GtkMenu or tooltips that you normally don’t think of as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL. In particular, do not use #GTK_WINDOW_POPUP just to turn off the window borders; use gtk_window_set_decorated() for that. - - A regular window, such as a dialog. + + A regular window, such as a dialog. - - A special window such as a tooltip. + + A special window such as a tooltip. - - Describes a type of line wrapping. - - do not wrap lines; just make the text area wider + + Describes a type of line wrapping. + + do not wrap lines; just make the text area wider - - wrap text, breaking lines anywhere the cursor can + + wrap text, breaking lines anywhere the cursor can appear (between characters, usually - if you want to be technical, between graphemes, see pango_get_log_attrs()) - - wrap text, breaking lines in between words + + wrap text, breaking lines in between words - - wrap text, breaking lines in between words, or if + + wrap text, breaking lines in between words, or if that is not enough, also between graphemes - - Finds the first accelerator in any #GtkAccelGroup attached + + Finds the first accelerator in any #GtkAccelGroup attached to @object that matches @accel_key and @accel_mods, and activates that accelerator. - %TRUE if an accelerator was activated and handled + %TRUE if an accelerator was activated and handled this keypress - the #GObject, usually a #GtkWindow, on which + the #GObject, usually a #GtkWindow, on which to activate the accelerator - accelerator keyval from a key event + accelerator keyval from a key event - keyboard state mask from a key event + keyboard state mask from a key event - - Gets a list of all accel groups which are attached to @object. + + Gets a list of all accel groups which are attached to @object. - a list of + a list of all accel groups which are attached to @object @@ -207131,64 +148973,43 @@ activates that accelerator. - a #GObject, usually a #GtkWindow + a #GObject, usually a #GtkWindow - - Gets the modifier mask. + + Gets the modifier mask. The modifier mask determines which modifiers are considered significant for keyboard accelerators. See gtk_accelerator_set_default_mod_mask(). - the default accelerator modifier mask + the default accelerator modifier mask - - Converts an accelerator keyval and modifier mask into a string + + Converts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user. - a newly-allocated string representing the accelerator. + a newly-allocated string representing the accelerator. - accelerator keyval + accelerator keyval - accelerator modifier mask + accelerator modifier mask - - Converts an accelerator keyval and modifier mask + + Converts an accelerator keyval and modifier mask into a (possibly translated) string that can be displayed to a user, similarly to gtk_accelerator_get_label(), but handling keycodes. @@ -207197,131 +149018,91 @@ This is only useful for system-level components, applications should use gtk_accelerator_parse() instead. - a newly-allocated string representing the accelerator. + a newly-allocated string representing the accelerator. - - a #GdkDisplay or %NULL to use the default display + + a #GdkDisplay or %NULL to use the default display - accelerator keyval + accelerator keyval - accelerator keycode + accelerator keycode - accelerator modifier mask + accelerator modifier mask - Converts an accelerator keyval and modifier mask into a string + Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse(). For example, if you pass in -#GDK_KEY_q and #GDK_CONTROL_MASK, this function returns “<Control>q”. +#GDK_KEY_q and #GDK_CONTROL_MASK, this function returns “<Control>q”. If you need to display accelerators in the user interface, see gtk_accelerator_get_label(). - a newly-allocated accelerator name + a newly-allocated accelerator name - accelerator keyval + accelerator keyval - accelerator modifier mask + accelerator modifier mask - - Converts an accelerator keyval and modifier mask + + Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse_with_keycode(), similarly to gtk_accelerator_name() but handling keycodes. This is only useful for system-level components, applications should use gtk_accelerator_parse() instead. - a newly allocated accelerator name. + a newly allocated accelerator name. - - a #GdkDisplay or %NULL to use the default display + + a #GdkDisplay or %NULL to use the default display - accelerator keyval + accelerator keyval - accelerator keycode + accelerator keycode - accelerator modifier mask + accelerator modifier mask - Parses a string representing an accelerator. The format looks like -“<Control>a” or “<Shift><Alt>F1” or “<Release>z” (the last one is + Parses a string representing an accelerator. The format looks like +“<Control>a” or “<Shift><Alt>F1” or “<Release>z” (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also -abbreviations such as “<Ctl>” and “<Ctrl>”. Key names are parsed using +abbreviations such as “<Ctl>” and “<Ctrl>”. Key names are parsed using gdk_keyval_from_name(). For character keys the name is not the symbol, -but the lowercase name, e.g. one would use “<Ctrl>minus” instead of -“<Ctrl>-”. +but the lowercase name, e.g. one would use “<Ctrl>minus” instead of +“<Ctrl>-”. If the parse fails, @accelerator_key and @accelerator_mods will be set to 0 (zero). @@ -207331,43 +149112,23 @@ be set to 0 (zero). - string representing an accelerator + string representing an accelerator - - return location for accelerator + + return location for accelerator keyval, or %NULL - - return location for accelerator + + return location for accelerator modifier mask, %NULL - - Parses a string representing an accelerator, similarly to + + Parses a string representing an accelerator, similarly to gtk_accelerator_parse() but handles keycodes as well. This is only useful for system-level components, applications should use gtk_accelerator_parse() instead. @@ -207386,56 +149147,30 @@ If the parse fails, @accelerator_key, @accelerator_mods and - string representing an accelerator + string representing an accelerator - - return location for accelerator + + return location for accelerator keyval, or %NULL - - + + return location for accelerator keycodes, or %NULL - - return location for accelerator + + return location for accelerator modifier mask, %NULL - - Sets the modifiers that will be considered significant for keyboard + + Sets the modifiers that will be considered significant for keyboard accelerators. The default mod mask depends on the GDK backend in use, but will typically include #GDK_CONTROL_MASK | #GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK | #GDK_HYPER_MASK | #GDK_META_MASK. @@ -207453,51 +149188,35 @@ before using any accelerator groups. - accelerator modifier mask + accelerator modifier mask - Determines whether a given keyval and modifier mask constitute + Determines whether a given keyval and modifier mask constitute a valid keyboard accelerator. For example, the #GDK_KEY_a keyval -plus #GDK_CONTROL_MASK is valid - this is a “Ctrl+a” accelerator. +plus #GDK_CONTROL_MASK is valid - this is a “Ctrl+a” accelerator. But, you can't, for instance, use the #GDK_KEY_Control_L keyval as an accelerator. - %TRUE if the accelerator is valid + %TRUE if the accelerator is valid - a GDK keyval + a GDK keyval - modifier mask + modifier mask - - Returns %TRUE if dialogs are expected to use an alternative + + Returns %TRUE if dialogs are expected to use an alternative button order on the screen @screen. See gtk_dialog_set_alternative_button_order() for more details about alternative button order. @@ -207509,30 +149228,18 @@ notified if the button order setting changes. Deprecated - Whether the alternative button order should be used + Whether the alternative button order should be used - - a #GdkScreen, or %NULL to use the default screen + + a #GdkScreen, or %NULL to use the default screen - - Parses a signal description from @signal_desc and incorporates + + Parses a signal description from @signal_desc and incorporates it into @binding_set. Signal descriptions may either bind a key combination to @@ -207553,33 +149260,23 @@ Key combinations must be in a format that can be parsed by gtk_accelerator_parse(). - %G_TOKEN_NONE if the signal was successfully parsed and added, + %G_TOKEN_NONE if the signal was successfully parsed and added, the expected token otherwise - a #GtkBindingSet + a #GtkBindingSet - a signal description + a signal description - - Override or install a new key binding for @keyval with @modifiers on + + Override or install a new key binding for @keyval with @modifiers on @binding_set. @@ -207587,33 +149284,23 @@ gtk_accelerator_parse(). - a #GtkBindingSet to add a signal to + a #GtkBindingSet to add a signal to - key value + key value - key modifier + key modifier - signal name to be bound + signal name to be bound - + list of #GtkBindingArg signal arguments @@ -207621,12 +149308,8 @@ gtk_accelerator_parse(). - - Remove a binding previously installed via + + Remove a binding previously installed via gtk_binding_entry_add_signal() on @binding_set. @@ -207634,32 +149317,21 @@ gtk_binding_entry_add_signal() on @binding_set. - a #GtkBindingSet to remove an entry of + a #GtkBindingSet to remove an entry of - key value of binding to remove + key value of binding to remove - key modifier of binding to remove + key modifier of binding to remove - - Install a binding on @binding_set which causes key lookups + + Install a binding on @binding_set which causes key lookups to be aborted, to prevent bindings from lower priority sets to be activated. @@ -207668,178 +149340,117 @@ to be activated. - a #GtkBindingSet to skip an entry of + a #GtkBindingSet to skip an entry of - key value of binding to skip + key value of binding to skip - key modifier of binding to skip + key modifier of binding to skip - - This function returns the binding set named after the type name of + + This function returns the binding set named after the type name of the passed in class structure. New binding sets are created on demand by this function. - the binding set corresponding to + the binding set corresponding to @object_class - - a valid #GObject class + + a valid #GObject class - - Find a binding set by its globally unique name. + + Find a binding set by its globally unique name. The @set_name can either be a name used for gtk_binding_set_new() or the type name of a class used in gtk_binding_set_by_class(). - %NULL or the specified binding set + %NULL or the specified binding set - unique binding set name + unique binding set name - - GTK+ maintains a global list of binding sets. Each binding set has + + GTK+ maintains a global list of binding sets. Each binding set has a unique name which needs to be specified upon creation. - new binding set + new binding set - unique name of this binding set + unique name of this binding set - Find a key binding matching @keyval and @modifiers and activate the + Find a key binding matching @keyval and @modifiers and activate the binding on @object. - %TRUE if a binding was found and activated + %TRUE if a binding was found and activated - object to activate when binding found + object to activate when binding found - key value of the binding + key value of the binding - key modifier of the binding + key modifier of the binding - - Looks up key bindings for @object to find one matching + + Looks up key bindings for @object to find one matching @event, and if one was found, activate it. - %TRUE if a matching key binding was found + %TRUE if a matching key binding was found - a #GObject (generally must be a widget) + a #GObject (generally must be a widget) - a #GdkEventKey + a #GdkEventKey - + - - This function is supposed to be called in #GtkWidget::draw + + This function is supposed to be called in #GtkWidget::draw implementations for widgets that support multiple windows. @cr must be untransformed from invoking of the draw function. This function will return %TRUE if the contents of the given @@ -207847,38 +149458,28 @@ This function will return %TRUE if the contents of the given that when the drawing was not initiated by the windowing system this function will return %TRUE for all windows, so you need to draw the bottommost window first. Also, do not -use “else if” statements to check which window should be drawn. +use “else if” statements to check which window should be drawn. - %TRUE if @window should be drawn + %TRUE if @window should be drawn - a cairo context + a cairo context - the window to check. @window may not be an input-only + the window to check. @window may not be an input-only window. - - Transforms the given cairo context @cr that from @widget-relative + + Transforms the given cairo context @cr that from @widget-relative coordinates to @window-relative coordinates. -If the @widget’s window is not an ancestor of @window, no +If the @widget’s window is not an ancestor of @window, no modification will be applied. This is the inverse to the transformation GTK applies when @@ -207891,29 +149492,21 @@ GTK+ 2 to the rendering architecture of GTK+ 3. - the cairo context to transform + the cairo context to transform - the widget the context is currently centered for + the widget the context is currently centered for - the window to transform the context to + the window to transform the context to - Checks that the GTK+ library in use is compatible with the + Checks that the GTK+ library in use is compatible with the given version. Generally you would pass in the constants #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION as the three arguments to this function; that produces @@ -207929,17 +149522,15 @@ version @required_major.required_minor.@required_micro (same major version.) This function is primarily for GTK+ modules; the module -can call this function to check that it wasn’t loaded +can call this function to check that it wasn’t loaded into an incompatible version of GTK+. However, such a -check isn’t completely reliable, since the module may be +check isn’t completely reliable, since the module may be linked against an old version of GTK+ and calling the old version of gtk_check_version(), but still get loaded into an application using a newer version of GTK+. - %NULL if the GTK+ library is compatible with the + %NULL if the GTK+ library is compatible with the given version, or a string describing the version mismatch. The returned string is owned by GTK+ and should not be modified or freed. @@ -207947,38 +149538,26 @@ into an application using a newer version of GTK+. - the required major version + the required major version - the required minor version + the required minor version - the required micro version + the required micro version - + - - Adds a GTK+ grab on @device, so all the events on @device and its + + Adds a GTK+ grab on @device, so all the events on @device and its associated pointer or keyboard (if any) are delivered to @widget. If the @block_others parameter is %TRUE, any other devices will be unable to interact with @widget during the grab. @@ -207988,31 +149567,21 @@ unable to interact with @widget during the grab. - a #GtkWidget + a #GtkWidget - a #GdkDevice to grab on. + a #GdkDevice to grab on. - %TRUE to prevent other devices to interact with @widget. + %TRUE to prevent other devices to interact with @widget. - - Removes a device grab from the given widget. + + Removes a device grab from the given widget. You have to pair calls to gtk_device_grab_add() and gtk_device_grab_remove(). @@ -208022,27 +149591,21 @@ gtk_device_grab_remove(). - a #GtkWidget + a #GtkWidget - a #GdkDevice + a #GdkDevice - Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and + Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and gtk_parse_args() from automatically calling `setlocale (LC_ALL, "")`. You would want to use this function if you wanted to set the locale for -your program to something other than the user’s locale, or if +your program to something other than the user’s locale, or if you wanted to set different values for different locale categories. Most programs should not need to call this function. @@ -208051,11 +149614,8 @@ Most programs should not need to call this function. - - Distributes @extra_space to child @sizes by bringing smaller + + Distributes @extra_space to child @sizes by bringing smaller children up to natural size first. The remaining space will be added to the @minimum_size member of the @@ -208063,39 +149623,29 @@ GtkRequestedSize struct. If all sizes reach their natural size then the remaining space is returned. - The remainder of @extra_space after redistributing space + The remainder of @extra_space after redistributing space to @sizes. - Extra space to redistribute among children after subtracting + Extra space to redistribute among children after subtracting minimum sizes and any child padding from the overall allocation - Number of requests to fit into the allocation + Number of requests to fit into the allocation - An array of structs with a client pointer and a minimum/natural size + An array of structs with a client pointer and a minimum/natural size in the orientation of the allocation. - Cancels an ongoing drag operation on the source side. + Cancels an ongoing drag operation on the source side. If you want to be able to cancel a drag operation in this way, you need to keep a pointer to the drag context, either from an @@ -208113,17 +149663,13 @@ If a drag is cancelled in this way, the @result argument of - a #GdkDragContext, as e.g. returned by gtk_drag_begin_with_coordinates() + a #GdkDragContext, as e.g. returned by gtk_drag_begin_with_coordinates() - Informs the drag source that the drop is finished, and + Informs the drag source that the drop is finished, and that the data of the drag will no longer be required. @@ -208131,60 +149677,42 @@ that the data of the drag will no longer be required. - the drag context + the drag context - a flag indicating whether the drop was successful + a flag indicating whether the drop was successful - a flag indicating whether the source should delete the + a flag indicating whether the source should delete the original data. (This should be %TRUE for a move) - the timestamp from the #GtkWidget::drag-drop signal + the timestamp from the #GtkWidget::drag-drop signal - - Determines the source widget for a drag. + + Determines the source widget for a drag. - if the drag is occurring + if the drag is occurring within a single application, a pointer to the source widget. Otherwise, %NULL. - a (destination side) drag context + a (destination side) drag context - - Sets the icon for a particular drag to the default + + Sets the icon for a particular drag to the default icon. @@ -208192,20 +149720,14 @@ icon. - the context for a drag (This must be called + the context for a drag (This must be called with a context for the source side of a drag) - - Sets the icon for a given drag from the given @icon. + + Sets the icon for a given drag from the given @icon. See the documentation for gtk_drag_set_icon_name() for more details about using icons in drag and drop. @@ -208214,38 +149736,26 @@ for more details about using icons in drag and drop. - the context for a drag (This must be called + the context for a drag (This must be called with a context for the source side of a drag) - a #GIcon + a #GIcon - the X offset of the hotspot within the icon + the X offset of the hotspot within the icon - the Y offset of the hotspot within the icon + the Y offset of the hotspot within the icon - - Sets the icon for a given drag from a named themed icon. See + + Sets the icon for a given drag from a named themed icon. See the docs for #GtkIconTheme for more details. Note that the size of the icon depends on the icon theme (the icon is loaded at the symbolic size #GTK_ICON_SIZE_DND), thus @@ -208256,76 +149766,52 @@ loaded at the symbolic size #GTK_ICON_SIZE_DND), thus - the context for a drag (This must be called + the context for a drag (This must be called with a context for the source side of a drag) - name of icon to use + name of icon to use - the X offset of the hotspot within the icon + the X offset of the hotspot within the icon - the Y offset of the hotspot within the icon + the Y offset of the hotspot within the icon - - Sets @pixbuf as the icon for a given drag. + + Sets @pixbuf as the icon for a given drag. - the context for a drag (This must be called + the context for a drag (This must be called with a context for the source side of a drag) - the #GdkPixbuf to use as the drag icon + the #GdkPixbuf to use as the drag icon - the X offset within @widget of the hotspot + the X offset within @widget of the hotspot - the Y offset within @widget of the hotspot + the Y offset within @widget of the hotspot - - Sets the icon for a given drag from a stock ID. + + Sets the icon for a given drag from a stock ID. Use gtk_drag_set_icon_name() instead. @@ -208333,37 +149819,26 @@ loaded at the symbolic size #GTK_ICON_SIZE_DND), thus - the context for a drag (This must be called + the context for a drag (This must be called with a context for the source side of a drag) - the ID of the stock icon to use for the drag + the ID of the stock icon to use for the drag - the X offset within the icon of the hotspot + the X offset within the icon of the hotspot - the Y offset within the icon of the hotspot + the Y offset within the icon of the hotspot - - Sets @surface as the icon for a given drag. GTK+ retains + + Sets @surface as the icon for a given drag. GTK+ retains references for the arguments, and will release them when they are no longer needed. @@ -208377,27 +149852,20 @@ surface. - the context for a drag (This must be called + the context for a drag (This must be called with a context for the source side of a drag) - the surface to use as icon + the surface to use as icon - - Changes the icon for drag operation to a given widget. -GTK+ will not destroy the widget, so if you don’t want -it to persist, you should connect to the “drag-end” + + Changes the icon for drag operation to a given widget. +GTK+ will not destroy the widget, so if you don’t want +it to persist, you should connect to the “drag-end” signal and destroy it yourself. @@ -208405,40 +149873,26 @@ signal and destroy it yourself. - the context for a drag. (This must be called + the context for a drag. (This must be called with a context for the source side of a drag) - a widget to use as an icon + a widget to use as an icon - the X offset within @widget of the hotspot + the X offset within @widget of the hotspot - the Y offset within @widget of the hotspot + the Y offset within @widget of the hotspot - - Draws a text caret on @cr at @location. This is not a style function + + Draws a text caret on @cr at @location. This is not a style function but merely a convenience function for drawing the standard cursor shape. Use gtk_render_insertion_cursor() instead. @@ -208447,49 +149901,35 @@ but merely a convenience function for drawing the standard cursor shape. - a #GtkWidget + a #GtkWidget - cairo context to draw to + cairo context to draw to - location where to draw the cursor (@location->width is ignored) + location where to draw the cursor (@location->width is ignored) - if the cursor should be the primary cursor color. + if the cursor should be the primary cursor color. - whether the cursor is left-to-right or + whether the cursor is left-to-right or right-to-left. Should never be #GTK_TEXT_DIR_NONE - %TRUE to draw a directional arrow on the + %TRUE to draw a directional arrow on the cursor. Should be %FALSE unless the cursor is split. - Checks if any events are pending. + Checks if any events are pending. This can be used to update the UI and invoke timeouts etc. while doing some time intensive computation. @@ -208506,43 +149946,28 @@ while doing some time intensive computation. ]| - %TRUE if any events are pending, %FALSE otherwise + %TRUE if any events are pending, %FALSE otherwise - Analogical to gtk_true(), this function does nothing + Analogical to gtk_true(), this function does nothing but always returns %FALSE. - %FALSE + %FALSE - - Registers an error quark for #GtkFileChooser if necessary. + + Registers an error quark for #GtkFileChooser if necessary. - The error quark used for #GtkFileChooser errors. + The error quark used for #GtkFileChooser errors. - The functions and objects described here make working with GTK+ and + The functions and objects described here make working with GTK+ and GIO more convenient. #GtkMountOperation is needed when mounting volumes: @@ -208560,117 +149985,80 @@ Another object that is worth mentioning in this context is #GdkAppLaunchContext, which provides visual feedback when lauching applications. - - Returns the binary age as passed to `libtool` + + Returns the binary age as passed to `libtool` when building the GTK+ library the process is running against. If `libtool` means nothing to you, don't worry about it. - the binary age of the GTK+ library + the binary age of the GTK+ library - Obtains a copy of the event currently being processed by GTK+. + Obtains a copy of the event currently being processed by GTK+. For example, if you are handling a #GtkButton::clicked signal, the current event will be the #GdkEventButton that triggered the ::clicked signal. - a copy of the current event, or + a copy of the current event, or %NULL if there is no current event. The returned event must be freed with gdk_event_free(). - - If there is a current event and it has a device, return that + + If there is a current event and it has a device, return that device, otherwise return %NULL. - a #GdkDevice, or %NULL + a #GdkDevice, or %NULL - - If there is a current event and it has a state field, place + + If there is a current event and it has a state field, place that state field in @state and return %TRUE, otherwise return %FALSE. - %TRUE if there was a current event and it + %TRUE if there was a current event and it had a state field - - a location to store the state of the current event + + a location to store the state of the current event - - If there is a current event and it has a timestamp, + + If there is a current event and it has a timestamp, return that timestamp, otherwise return %GDK_CURRENT_TIME. - the timestamp from the current event, + the timestamp from the current event, or %GDK_CURRENT_TIME. - Returns the GTK+ debug flags. + Returns the GTK+ debug flags. This function is intended for GTK+ modules that want to adjust their debug output based on GTK+ debug flags. - the GTK+ debug flags. + the GTK+ debug flags. - - Returns the #PangoLanguage for the default language currently in + + Returns the #PangoLanguage for the default language currently in effect. (Note that this can change over the life of an application.) The default language is derived from the current locale. It determines, for example, whether GTK+ uses the @@ -208680,59 +150068,41 @@ This function is equivalent to pango_language_get_default(). See that function for details. - the default language as a #PangoLanguage, + the default language as a #PangoLanguage, must not be freed - If @event is %NULL or the event was not associated with any widget, + If @event is %NULL or the event was not associated with any widget, returns %NULL, otherwise returns the widget that received the event originally. - the widget that originally + the widget that originally received @event, or %NULL - a #GdkEvent + a #GdkEvent - - Returns the interface age as passed to `libtool` + + Returns the interface age as passed to `libtool` when building the GTK+ library the process is running against. If `libtool` means nothing to you, don't worry about it. - the interface age of the GTK+ library + the interface age of the GTK+ library - - Get the direction of the current locale. This is the expected + + Get the direction of the current locale. This is the expected reading direction for text and UI. This function depends on the current locale being set with @@ -208755,18 +150125,12 @@ gtk_widget_set_default_direction (direction); ]| - the #GtkTextDirection of the current locale + the #GtkTextDirection of the current locale - - Returns the major version number of the GTK+ library. + + Returns the major version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 3.) This function is in the library, so it represents the GTK+ library @@ -208775,18 +150139,12 @@ macro, which represents the major version of the GTK+ headers you have included when compiling your code. - the major version number of the GTK+ library + the major version number of the GTK+ library - - Returns the micro version number of the GTK+ library. + + Returns the micro version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 5.) This function is in the library, so it represents the GTK+ library @@ -208795,18 +150153,12 @@ your code is are running against. Contrast with the GTK+ headers you have included when compiling your code. - the micro version number of the GTK+ library + the micro version number of the GTK+ library - - Returns the minor version number of the GTK+ library. + + Returns the minor version number of the GTK+ library. (e.g. in GTK+ version 3.1.5 this is 1.) This function is in the library, so it represents the GTK+ library @@ -208815,18 +150167,12 @@ your code is are running against. Contrast with the GTK+ headers you have included when compiling your code. - the minor version number of the GTK+ library + the minor version number of the GTK+ library - - Returns a #GOptionGroup for the commandline arguments recognized + + Returns a #GOptionGroup for the commandline arguments recognized by GTK+ and GDK. You should add this group to your #GOptionContext @@ -208834,41 +150180,31 @@ with g_option_context_add_group(), if you are using g_option_context_parse() to parse your commandline arguments. - a #GOptionGroup for the commandline + a #GOptionGroup for the commandline arguments recognized by GTK+ - whether to open the default display + whether to open the default display when parsing the commandline arguments - Queries the current grab of the default window group. + Queries the current grab of the default window group. - The widget which currently + The widget which currently has the grab or %NULL if no grab is active - A button box should be used to provide a consistent layout of buttons + A button box should be used to provide a consistent layout of buttons throughout your application. The layout/spacing can be altered by the -programmer, or if desired, by the user to alter the “feel” of a +programmer, or if desired, by the user to alter the “feel” of a program to a small degree. gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and @@ -208888,23 +150224,21 @@ property. GtkButtonBox uses a single CSS node with name buttonbox. - #GtkBindingSet provides a mechanism for configuring GTK+ key bindings + #GtkBindingSet provides a mechanism for configuring GTK+ key bindings through CSS files. This eases key binding adjustments for application developers as well as users and provides GTK+ users or administrators with high key binding configurability which requires no application or toolkit side changes. In order for bindings to work in a custom widget implementation, the -widget’s #GtkWidget:can-focus and #GtkWidget:has-focus properties +widget’s #GtkWidget:can-focus and #GtkWidget:has-focus properties must both be true. For example, by calling gtk_widget_set_can_focus() -in the widget’s initialisation function; and by calling +in the widget’s initialisation function; and by calling gtk_widget_grab_focus() when the widget is clicked. # Installing a key binding -A CSS file binding consists of a “binding-set” definition and a match +A CSS file binding consists of a “binding-set” definition and a match statement to apply the binding set to specific widget types. Details on the matching mechanism are described under [Selectors][gtkcssprovider-selectors] @@ -208944,7 +150278,7 @@ it provides. Because custom bindings set up in CSS files take precedence over the default bindings shipped with GTK+, overriding existing bindings as demonstrated in [Installing a key binding][gtk-bindings-install] -works as expected. The same mechanism can not be used to “unbind” +works as expected. The same mechanism can not be used to “unbind” existing bindings, however. |[ <!-- language="CSS" --> @@ -208961,14 +150295,14 @@ entry ]| The above example will not have the desired effect of causing -“<Control>Right” and “<Control>Left” key presses to be ignored by GTK+. +“<Control>Right” and “<Control>Left” key presses to be ignored by GTK+. Instead, it just causes any existing bindings from the bindings set -“MoveCursor3” to be deleted, so when “<Control>Right” or -“<Control>Left” are pressed, no binding for these keys is found in -binding set “MoveCursor3”. GTK+ will thus continue to search for +“MoveCursor3” to be deleted, so when “<Control>Right” or +“<Control>Left” are pressed, no binding for these keys is found in +binding set “MoveCursor3”. GTK+ will thus continue to search for matching key bindings, and will eventually lookup and find the default GTK+ bindings for entries which implement word movement. To keep GTK+ -from activating its default bindings, the “unbind” keyword can be used +from activating its default bindings, the “unbind” keyword can be used like this: |[ <!-- language="CSS" --> @@ -208984,25 +150318,21 @@ entry } ]| -Now, GTK+ will find a match when looking up “<Control>Right” and -“<Control>Left” key presses before it resorts to its default bindings, -and the match instructs it to abort (“unbind”) the search, so the key +Now, GTK+ will find a match when looking up “<Control>Right” and +“<Control>Left” key presses before it resorts to its default bindings, +and the match instructs it to abort (“unbind”) the search, so the key presses are not consumed by this widget. As usual, further processing -of the key presses, e.g. by an entry’s parent widget, is now possible. +of the key presses, e.g. by an entry’s parent widget, is now possible. - The #GtkColorSelection is a widget that is used to select + The #GtkColorSelection is a widget that is used to select a color. It consists of a color wheel and number of sliders and entry boxes for color parameters such as hue, saturation, value, red, green, blue, and opacity. It is found on the standard color selection dialog box #GtkColorSelectionDialog. - The #GtkColorSelectionDialog provides a standard dialog which + The #GtkColorSelectionDialog provides a standard dialog which allows the user to select a color much like the #GtkFileChooserDialog provides a standard dialog for file selection. @@ -209010,20 +150340,18 @@ Use gtk_color_selection_dialog_get_color_selection() to get the #GtkColorSelection widget contained within the dialog. Use this widget and its gtk_color_selection_get_current_color() function to gain access to the selected color. Connect a handler -for this widget’s #GtkColorSelection::color-changed signal to be notified +for this widget’s #GtkColorSelection::color-changed signal to be notified when the color changes. # GtkColorSelectionDialog as GtkBuildable # {#GtkColorSelectionDialog-BUILDER-UI} The GtkColorSelectionDialog implementation of the GtkBuildable interface exposes the embedded #GtkColorSelection as internal child with the -name “color_selection”. It also exposes the buttons with the names -“ok_button”, “cancel_button” and “help_button”. +name “color_selection”. It also exposes the buttons with the names +“ok_button”, “cancel_button” and “help_button”. - GTK+ has a rich set of functions for doing inter-process communication + GTK+ has a rich set of functions for doing inter-process communication via the drag-and-drop metaphor. As well as the functions listed here, applications may need to use some @@ -209031,16 +150359,12 @@ facilities provided for [Selections][gtk3-Selections]. Also, the Drag and Drop API makes use of signals in the #GtkWidget class. - GTK+ provides version information, primarily useful in configure checks + GTK+ provides version information, primarily useful in configure checks for builds that have a configure script. Applications will not typically use the features described here. - The #GtkFontSelection widget lists the available fonts, styles and sizes, + The #GtkFontSelection widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the #GtkFontSelectionDialog widget to provide a dialog box for selecting fonts. @@ -209057,9 +150381,7 @@ In GTK+ 3.2, #GtkFontSelection has been deprecated in favor of #GtkFontChooser. - The #GtkFontSelectionDialog widget is a dialog box for selecting a font. + The #GtkFontSelectionDialog widget is a dialog box for selecting a font. To set the font which is initially selected, use gtk_font_selection_dialog_set_font_name(). @@ -209076,15 +150398,13 @@ In GTK+ 3.2, #GtkFontSelectionDialog has been deprecated in favor of The GtkFontSelectionDialog implementation of the GtkBuildable interface exposes the embedded #GtkFontSelection as internal child with the -name “font_selection”. It also exposes the buttons with the names -“ok_button”, “cancel_button” and “apply_button”. +name “font_selection”. It also exposes the buttons with the names +“ok_button”, “cancel_button” and “apply_button”. - A button box should be used to provide a consistent layout of buttons + A button box should be used to provide a consistent layout of buttons throughout your application. The layout/spacing can be altered by the -programmer, or if desired, by the user to alter the “feel” of a +programmer, or if desired, by the user to alter the “feel” of a program to a small degree. A #GtkHButtonBox is created with gtk_hbutton_box_new(). Buttons are @@ -209103,9 +150423,7 @@ gtk_button_box_set_layout(). GtkHButtonBox has been deprecated, use #GtkButtonBox instead. - Before using GTK+, you need to initialize it; initialization connects to the + Before using GTK+, you need to initialize it; initialization connects to the window system display, and parses some standard command line arguments. The gtk_init() macro initializes GTK+. gtk_init() exits the application if errors occur; to avoid this, use gtk_init_check(). gtk_init_check() allows you to @@ -209113,16 +150431,16 @@ recover from a failed GTK+ initialization - you might start up your application in text mode instead. Like all GUI toolkits, GTK+ uses an event-driven programming model. When the -user is doing nothing, GTK+ sits in the “main loop” and +user is doing nothing, GTK+ sits in the “main loop” and waits for input. If the user performs some action - say, a mouse click - then -the main loop “wakes up” and delivers an event to GTK+. GTK+ forwards the +the main loop “wakes up” and delivers an event to GTK+. GTK+ forwards the event to one or more widgets. When widgets receive an event, they frequently emit one or more -“signals”. Signals notify your program that "something -interesting happened" by invoking functions you’ve connected to the signal +“signals”. Signals notify your program that "something +interesting happened" by invoking functions you’ve connected to the signal with g_signal_connect(). Functions connected to a signal are often termed -“callbacks”. +“callbacks”. When your callbacks are invoked, you would typically take some action - for example, when an Open button is clicked you might display a @@ -209161,13 +150479,11 @@ main (int argc, char **argv) } ]| -It’s OK to use the GLib main loop directly instead of gtk_main(), though it +It’s OK to use the GLib main loop directly instead of gtk_main(), though it involves slightly more typing. See #GMainLoop in the GLib documentation. - #GtkPlacesView is a stock widget that displays a list of persistent drives + #GtkPlacesView is a stock widget that displays a list of persistent drives such as harddisk partitions and networks. #GtkPlacesView does not monitor removable devices. @@ -209181,9 +150497,7 @@ to the #GtkPlacesView::open-location signal. This is emitted when the user selects a location to open in the view. - GTK+ provides resource file mechanism for configuring + GTK+ provides resource file mechanism for configuring various aspects of the operation of a GTK+ program at runtime. @@ -209203,7 +150517,7 @@ and `.gtkrc-3.0` in the users home directory. `--prefix` or `--sysconfdir` options when configuring GTK+.) -The set of these “default” files +The set of these “default” files can be retrieved with gtk_rc_get_default_files() and modified with gtk_rc_add_default_file() and gtk_rc_set_default_files(). @@ -209233,8 +150547,8 @@ widget "mywindow.*.GtkEntry" style "my-entry-class" ]| attaches the style `"my-entry-class"` to all -widgets whose “widget path” matches the -“pattern” `"mywindow.*.GtkEntry"`. +widgets whose “widget path” matches the +“pattern” `"mywindow.*.GtkEntry"`. That is, all #GtkEntry widgets which are part of a #GtkWindow named `"mywindow"`. @@ -209242,7 +150556,7 @@ The patterns here are given in the standard shell glob syntax. The `"?"` wildcard matches any character, while `"*"` matches zero or more of any character. The three types of matching are against the widget path, the -“class path” and the class hierarchy. Both the +“class path” and the class hierarchy. Both the widget path and the class path consist of a `"."` separated list of all the parents of the widget and the widget itself from outermost to innermost. The difference is that in the widget path, @@ -209366,8 +150680,8 @@ matches: # Toplevel Declarations # An RC file is a text file which is composed of a sequence -of declarations. `“#”` characters delimit comments and -the portion of a line after a `“#”` is ignored when parsing +of declarations. `“#”` characters delimit comments and +the portion of a line after a `“#”` is ignored when parsing an RC file. The possible toplevel declarations are: @@ -209496,18 +150810,18 @@ elements are: * `font = font` - Starting with GTK+ 2.0, the “font” and “fontset” - declarations are ignored; use “font_name” declarations instead. + Starting with GTK+ 2.0, the “font” and “fontset” + declarations are ignored; use “font_name” declarations instead. * `fontset = font` - Starting with GTK+ 2.0, the “font” and “fontset” - declarations are ignored; use “font_name” declarations instead. + Starting with GTK+ 2.0, the “font” and “fontset” + declarations are ignored; use “font_name” declarations instead. * `font_name = font` Sets the font for a widget. font must be - a Pango font name, e.g. “Sans Italic 10” . + a Pango font name, e.g. “Sans Italic 10” . For details about Pango font names, see pango_font_description_from_string(). @@ -209659,7 +150973,7 @@ The sizes that come with GTK+ itself are `"gtk-menu"`, `"gtk-button"`, `"gtk-dialog"`. Applications can define other sizes. -It’s also possible to use custom icons for a given state, for example: +It’s also possible to use custom icons for a given state, for example: |[<!-- language="C" --> stock["my-stock-item"] = @@ -209673,7 +150987,7 @@ stock["my-stock-item"] = When selecting an icon source to use, GTK+ will consider text direction most important, state second, and size third. It will select the best match based on those criteria. If an attribute matches exactly (e.g. you specified -`PRELIGHT` or specified the size), GTK+ won’t modify the image; +`PRELIGHT` or specified the size), GTK+ won’t modify the image; if the attribute matches with a wildcard, GTK+ will scale or modify the image to match the state and size the user requested. @@ -209741,9 +151055,7 @@ The priorities that can be specified and their default values are the same as for styles. - The selection mechanism provides the basis for different types + The selection mechanism provides the basis for different types of communication between processes. In particular, drag and drop and #GtkClipboard work via selections. You will very seldom or never need to use most of the functions in this section directly; @@ -209757,7 +151069,7 @@ and gtk_selection_data_set_pixbuf() or gtk_selection_data_get_pixbuf(), which is one of the reasons why it is advised to use #GtkClipboard. Some of the datatypes defined this section are used in -the #GtkClipboard and drag-and-drop API’s as well. The +the #GtkClipboard and drag-and-drop API’s as well. The #GtkTargetEntry and #GtkTargetList objects represent lists of data types that are supported when sending or receiving data. The #GtkSelectionData object is used to @@ -209765,14 +151077,12 @@ store a chunk of data along with the data type and other associated information. - > Since GTK+ 3.10, stock items are deprecated. You should instead set + > Since GTK+ 3.10, stock items are deprecated. You should instead set > up whatever labels and/or icons you need using normal widget API, > rather than relying on GTK+ providing ready-made combinations of these. Stock items represent commonly-used menu or toolbar items such as -“Open” or “Exit”. Each stock item is identified by a stock ID; +“Open” or “Exit”. Each stock item is identified by a stock ID; stock IDs are just strings, but macros such as #GTK_STOCK_OPEN are provided to avoid typing mistakes in the strings. Applications can register their own stock items in addition to those @@ -209783,14 +151093,12 @@ the user-visible label, keyboard accelerator, and translation domain of the menu or toolbar item; and/or with an icon stored in a #GtkIconFactory. The connection between a #GtkStockItem and stock icons is purely conventional (by virtue of -using the same stock ID); it’s possible to register a stock item but +using the same stock ID); it’s possible to register a stock item but no icon, and vice versa. Stock icons may have a RTL variant which gets used for right-to-left locales. - GTK+ supports Drag-and-Drop in tree views with a high-level and a low-level + GTK+ supports Drag-and-Drop in tree views with a high-level and a low-level API. The low-level API consists of the GTK+ DND API, augmented by some treeview @@ -209807,11 +151115,9 @@ and auto-scroll, but your models have to implement the #GtkTreeDragSource and #GtkTreeDragDest interfaces. - A button box should be used to provide a consistent layout of buttons + A button box should be used to provide a consistent layout of buttons throughout your application. The layout/spacing can be altered by the -programmer, or if desired, by the user to alter the “feel” of a +programmer, or if desired, by the user to alter the “feel” of a program to a small degree. A #GtkVButtonBox is created with gtk_vbutton_box_new(). Buttons are @@ -209829,65 +151135,41 @@ gtk_button_box_set_layout(). GtkVButtonBox has been deprecated, use #GtkButtonBox instead. - - Looks up the icon size associated with @name. + + Looks up the icon size associated with @name. Use #GtkIconTheme instead. - the icon size (#GtkIconSize) - + the icon size (#GtkIconSize) + - the name to look up. + the name to look up. - - Gets the canonical name of the given icon size. The returned string + + Gets the canonical name of the given icon size. The returned string is statically allocated and should not be freed. Use #GtkIconTheme instead. - the name of the given icon size. + the name of the given icon size. - a #GtkIconSize. - + a #GtkIconSize. + - - Obtains the pixel size of a semantic icon size @size: + + Obtains the pixel size of a semantic icon size @size: #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function -isn’t normally needed, gtk_icon_theme_load_icon() is the usual +isn’t normally needed, gtk_icon_theme_load_icon() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by gtk_icon_size_lookup(), because themes @@ -209895,55 +151177,30 @@ are free to render the pixbuf however they like, including changing the usual size. - %TRUE if @size was a valid size + %TRUE if @size was a valid size - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - location to store icon width + + location to store icon width - - location to store icon height + + location to store icon height - - Obtains the pixel size of a semantic icon size, possibly + + Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular #GtkSettings. Normally @size would be #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function -isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual +isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by gtk_icon_size_lookup(), because themes @@ -209952,95 +151209,55 @@ the usual size. Use gtk_icon_size_lookup() instead. - %TRUE if @size was a valid size + %TRUE if @size was a valid size - a #GtkSettings object, used to determine + a #GtkSettings object, used to determine which set of user preferences to used. - an icon size (#GtkIconSize) - + an icon size (#GtkIconSize) + - - location to store icon width + + location to store icon width - - location to store icon height + + location to store icon height - - Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU, + + Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU, etc. Returns the integer value for the size. Use #GtkIconTheme instead. - integer value representing the size (#GtkIconSize) - + integer value representing the size (#GtkIconSize) + - name of the icon size + name of the icon size - the icon width + the icon width - the icon height + the icon height - - Registers @alias as another name for @target. + + Registers @alias as another name for @target. So calling gtk_icon_size_from_name() with @alias as argument will return @target. Use #GtkIconTheme instead. @@ -210050,30 +151267,22 @@ will return @target. - an alias for @target + an alias for @target - an existing icon size (#GtkIconSize) - + an existing icon size (#GtkIconSize) + - + - Call this function before using any other GTK+ functions in your GUI + Call this function before using any other GTK+ functions in your GUI applications. It will initialize everything needed to operate the toolkit and parses some standard command line options. @@ -210088,7 +151297,7 @@ Note that there are some alternative ways to initialize GTK+: if you are calling gtk_parse_args(), gtk_init_check(), gtk_init_with_args() or g_option_context_parse() with the option group returned by gtk_get_option_group(), -you don’t have to call gtk_init(). +you don’t have to call gtk_init(). And if you are using #GtkApplication, you don't have to call any of the initialization functions either; the #GtkApplication::startup handler @@ -210110,26 +151319,14 @@ similar things. - - Address of the `argc` parameter of + + Address of the `argc` parameter of your main() function (or 0 if @argv is %NULL). This will be changed if any arguments were handled. - - Address of the + + Address of the `argv` parameter of main(), or %NULL. Any options understood by GTK+ are stripped before return. @@ -210139,11 +151336,9 @@ similar things. - This function does the same work as gtk_init() with only a single + This function does the same work as gtk_init() with only a single change: It does not terminate the program if the commandline -arguments couldn’t be parsed or the windowing system can’t be +arguments couldn’t be parsed or the windowing system can’t be initialized. Instead it returns %FALSE on failure. This way the application can fall back to some other means of @@ -210154,34 +151349,20 @@ Note that calling any GTK function or instantiating any GTK type after this function returns %FALSE results in undefined behavior. - %TRUE if the commandline arguments (if any) were valid and + %TRUE if the commandline arguments (if any) were valid and the windowing system has been successfully initialized, %FALSE otherwise - - Address of the `argc` parameter of + + Address of the `argc` parameter of your main() function (or 0 if @argv is %NULL). This will be changed if any arguments were handled. - - Address of the + + Address of the `argv` parameter of main(), or %NULL. Any options understood by GTK+ are stripped before return. @@ -210190,130 +151371,79 @@ this function returns %FALSE results in undefined behavior. - - This function does the same work as gtk_init_check(). + + This function does the same work as gtk_init_check(). Additionally, it allows you to add your own commandline options, and it automatically generates nicely formatted `--help` output. Note that your program will be terminated after writing out the help output. - %TRUE if the commandline arguments (if any) were valid and + %TRUE if the commandline arguments (if any) were valid and if the windowing system has been successfully initialized, %FALSE otherwise - - Address of the `argc` parameter of + + Address of the `argc` parameter of your main() function (or 0 if @argv is %NULL). This will be changed if any arguments were handled. - - Address of the + + Address of the `argv` parameter of main(), or %NULL. Any options understood by GTK+ are stripped before return. - - a string which is displayed in + + a string which is displayed in the first line of `--help` output, after `programname [OPTION...]` - a %NULL-terminated array + a %NULL-terminated array of #GOptionEntrys describing the options of your program - - a translation domain to use for translating + + a translation domain to use for translating the `--help` output for the options in @entries and the @parameter_string with gettext(), or %NULL - - Installs a key snooper function, which will get called on all + + Installs a key snooper function, which will get called on all key events before delivering them normally. Key snooping should not be done. Events should be handled by widgets. - a unique id for this key snooper for use with + a unique id for this key snooper for use with gtk_key_snooper_remove(). - a #GtkKeySnoopFunc + a #GtkKeySnoopFunc - - data to pass to @snooper + + data to pass to @snooper - - Removes the key snooper function with the given id. + + Removes the key snooper function with the given id. Key snooping should not be done. Events should be handled by widgets. @@ -210322,17 +151452,13 @@ key events before delivering them normally. - Identifies the key snooper to remove + Identifies the key snooper to remove - Runs the main loop until gtk_main_quit() is called. + Runs the main loop until gtk_main_quit() is called. You can nest calls to gtk_main(). In that case gtk_main_quit() will make the innermost invocation of the main loop return. @@ -210342,9 +151468,7 @@ will make the innermost invocation of the main loop return. - Processes a single GDK event. + Processes a single GDK event. This is public only to allow filtering of events between GDK and GTK+. You will not usually need to call this function directly. @@ -210358,7 +151482,7 @@ does with the event: events are thrown away. This is to avoid a backlog of (de-)highlighting widgets crossed by the pointer. -2. Find the widget which got the event. If the widget can’t be determined +2. Find the widget which got the event. If the widget can’t be determined the event is thrown away unless it belongs to a INCR transaction. 3. Then the event is pushed onto a stack so you can query the currently @@ -210386,84 +151510,61 @@ does with the event: - An event to process (normally passed by GDK) + An event to process (normally passed by GDK) - Runs a single iteration of the mainloop. + Runs a single iteration of the mainloop. If no events are waiting to be processed GTK+ will block -until the next event is noticed. If you don’t want to block +until the next event is noticed. If you don’t want to block look at gtk_main_iteration_do() or check if any events are pending with gtk_events_pending() first. - %TRUE if gtk_main_quit() has been called for the + %TRUE if gtk_main_quit() has been called for the innermost mainloop - Runs a single iteration of the mainloop. + Runs a single iteration of the mainloop. If no events are available either return or block depending on the value of @blocking. - %TRUE if gtk_main_quit() has been called for the + %TRUE if gtk_main_quit() has been called for the innermost mainloop - %TRUE if you want GTK+ to block if no events are pending + %TRUE if you want GTK+ to block if no events are pending - Asks for the current nesting level of the main loop. + Asks for the current nesting level of the main loop. - the nesting level of the current invocation + the nesting level of the current invocation of the main loop - Makes the innermost invocation of the main loop return + Makes the innermost invocation of the main loop return when it regains control. - - Draws an arrow in the given rectangle on @cr using the given + + Draws an arrow in the given rectangle on @cr using the given parameters. @arrow_type determines the direction of the arrow. Use gtk_render_arrow() instead @@ -210472,92 +151573,57 @@ parameters. @arrow_type determines the direction of the arrow. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - the type of arrow to draw + the type of arrow to draw - %TRUE if the arrow tip should be filled + %TRUE if the arrow tip should be filled - x origin of the rectangle to draw the arrow in + x origin of the rectangle to draw the arrow in - y origin of the rectangle to draw the arrow in + y origin of the rectangle to draw the arrow in - width of the rectangle to draw the arrow in + width of the rectangle to draw the arrow in - height of the rectangle to draw the arrow in + height of the rectangle to draw the arrow in - - Draws a box on @cr with the given parameters. + + Draws a box on @cr with the given parameters. Use gtk_render_frame() and gtk_render_background() instead @@ -210565,80 +151631,49 @@ parameters. @arrow_type determines the direction of the arrow. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the box + x origin of the box - y origin of the box + y origin of the box - the width of the box + the width of the box - the height of the box + the height of the box - - Draws a box in @cr using the given style and state and shadow type, + + Draws a box in @cr using the given style and state and shadow type, leaving a gap in one side. Use gtk_render_frame_gap() instead @@ -210647,98 +151682,61 @@ leaving a gap in one side. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - type of shadow to draw + type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle + x origin of the rectangle - y origin of the rectangle + y origin of the rectangle - width of the rectangle + width of the rectangle - width of the rectangle + width of the rectangle - side in which to leave the gap + side in which to leave the gap - starting position of the gap + starting position of the gap - width of the gap + width of the gap - - Draws a check button indicator in the given rectangle on @cr with + + Draws a check button indicator in the given rectangle on @cr with the given parameters. Use gtk_render_check() instead @@ -210747,80 +151745,49 @@ the given parameters. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle to draw the check in + x origin of the rectangle to draw the check in - y origin of the rectangle to draw the check in + y origin of the rectangle to draw the check in - the width of the rectangle to draw the check in + the width of the rectangle to draw the check in - the height of the rectangle to draw the check in + the height of the rectangle to draw the check in - - Draws a diamond in the given rectangle on @window using the given + + Draws a diamond in the given rectangle on @window using the given parameters. Use cairo instead @@ -210829,83 +151796,52 @@ parameters. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle to draw the diamond in + x origin of the rectangle to draw the diamond in - y origin of the rectangle to draw the diamond in + y origin of the rectangle to draw the diamond in - width of the rectangle to draw the diamond in + width of the rectangle to draw the diamond in - height of the rectangle to draw the diamond in + height of the rectangle to draw the diamond in - - Draws an expander as used in #GtkTreeView. @x and @y specify the + + Draws an expander as used in #GtkTreeView. @x and @y specify the center the expander. The size of the expander is determined by the -“expander-size” style property of @widget. (If widget is not -specified or doesn’t have an “expander-size” property, an +“expander-size” style property of @widget. (If widget is not +specified or doesn’t have an “expander-size” property, an unspecified default size will be used, since the caller doesn't have sufficient information to position the expander, this is likely not useful.) The expander is expander_size pixels tall @@ -210918,70 +151854,43 @@ expanded position. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - - the widget + + the widget - - a style detail + + a style detail - the x position to draw the expander at + the x position to draw the expander at - the y position to draw the expander at + the y position to draw the expander at - the style to draw the expander in; determines + the style to draw the expander in; determines whether the expander is collapsed, expanded, or in an intermediate state. - - Draws an extension, i.e. a notebook tab. + + Draws an extension, i.e. a notebook tab. Use gtk_render_extension() instead @@ -210989,86 +151898,53 @@ expanded position. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - type of shadow to draw + type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the extension + x origin of the extension - y origin of the extension + y origin of the extension - width of the extension + width of the extension - width of the extension + width of the extension - the side on to which the extension is attached + the side on to which the extension is attached - - Draws a flat box on @cr with the given parameters. + + Draws a flat box on @cr with the given parameters. Use gtk_render_frame() and gtk_render_background() instead @@ -211076,80 +151952,49 @@ expanded position. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the box + x origin of the box - y origin of the box + y origin of the box - the width of the box + the width of the box - the height of the box + the height of the box - - Draws a focus indicator around the given rectangle on @cr using the + + Draws a focus indicator around the given rectangle on @cr using the given style. Use gtk_render_focus() instead @@ -211158,74 +152003,45 @@ given style. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - - the widget + + the widget - - a style detail + + a style detail - the x origin of the rectangle around which to draw a focus indicator + the x origin of the rectangle around which to draw a focus indicator - the y origin of the rectangle around which to draw a focus indicator + the y origin of the rectangle around which to draw a focus indicator - the width of the rectangle around which to draw a focus indicator + the width of the rectangle around which to draw a focus indicator - the height of the rectangle around which to draw a focus indicator + the height of the rectangle around which to draw a focus indicator - - Draws a handle as used in #GtkHandleBox and #GtkPaned. + + Draws a handle as used in #GtkHandleBox and #GtkPaned. Use gtk_render_handle() instead @@ -211233,86 +152049,53 @@ given style. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - type of shadow to draw + type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the handle + x origin of the handle - y origin of the handle + y origin of the handle - with of the handle + with of the handle - height of the handle + height of the handle - the orientation of the handle + the orientation of the handle - - Draws a horizontal line from (@x1, @y) to (@x2, @y) in @cr + + Draws a horizontal line from (@x1, @y) to (@x2, @y) in @cr using the given style and state. Use gtk_render_line() instead @@ -211321,68 +152104,41 @@ using the given style and state. - a #GtkStyle + a #GtkStyle - a #caio_t + a #caio_t - a state + a state - - the widget + + the widget - - a style detail + + a style detail - the starting x coordinate + the starting x coordinate - the ending x coordinate + the ending x coordinate - the y coordinate + the y coordinate - - Draws a layout on @cr using the given parameters. + + Draws a layout on @cr using the given parameters. Use gtk_render_layout() instead @@ -211390,75 +152146,46 @@ using the given style and state. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - whether to use the text or foreground + whether to use the text or foreground graphics context of @style - - the widget + + the widget - - a style detail + + a style detail - x origin + x origin - y origin + y origin - the layout to draw + the layout to draw - - Draws a radio button indicator in the given rectangle on @cr with + + Draws a radio button indicator in the given rectangle on @cr with the given parameters. Use gtk_render_option() instead @@ -211467,80 +152194,49 @@ the given parameters. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle to draw the option in + x origin of the rectangle to draw the option in - y origin of the rectangle to draw the option in + y origin of the rectangle to draw the option in - the width of the rectangle to draw the option in + the width of the rectangle to draw the option in - the height of the rectangle to draw the option in + the height of the rectangle to draw the option in - - Draws a resize grip in the given rectangle on @cr using the given + + Draws a resize grip in the given rectangle on @cr using the given parameters. Use gtk_render_handle() instead @@ -211549,80 +152245,49 @@ parameters. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - - the widget + + the widget - - a style detail + + a style detail - the edge in which to draw the resize grip + the edge in which to draw the resize grip - the x origin of the rectangle in which to draw the resize grip + the x origin of the rectangle in which to draw the resize grip - the y origin of the rectangle in which to draw the resize grip + the y origin of the rectangle in which to draw the resize grip - the width of the rectangle in which to draw the resize grip + the width of the rectangle in which to draw the resize grip - the height of the rectangle in which to draw the resize grip + the height of the rectangle in which to draw the resize grip - - Draws a shadow around the given rectangle in @cr + + Draws a shadow around the given rectangle in @cr using the given style and state and shadow type. Use gtk_render_frame() instead @@ -211631,80 +152296,49 @@ using the given style and state and shadow type. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - type of shadow to draw + type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle + x origin of the rectangle - y origin of the rectangle + y origin of the rectangle - width of the rectangle + width of the rectangle - width of the rectangle + width of the rectangle - - Draws a shadow around the given rectangle in @cr + + Draws a shadow around the given rectangle in @cr using the given style and state and shadow type, leaving a gap in one side. Use gtk_render_frame_gap() instead @@ -211714,98 +152348,61 @@ gap in one side. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - type of shadow to draw + type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle + x origin of the rectangle - y origin of the rectangle + y origin of the rectangle - width of the rectangle + width of the rectangle - width of the rectangle + width of the rectangle - side in which to leave the gap + side in which to leave the gap - starting position of the gap + starting position of the gap - width of the gap + width of the gap - - Draws a slider in the given rectangle on @cr using the + + Draws a slider in the given rectangle on @cr using the given style and orientation. Use gtk_render_slider() instead @@ -211814,86 +152411,53 @@ given style and orientation. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - a shadow + a shadow - - the widget + + the widget - - a style detail + + a style detail - the x origin of the rectangle in which to draw a slider + the x origin of the rectangle in which to draw a slider - the y origin of the rectangle in which to draw a slider + the y origin of the rectangle in which to draw a slider - the width of the rectangle in which to draw a slider + the width of the rectangle in which to draw a slider - the height of the rectangle in which to draw a slider + the height of the rectangle in which to draw a slider - the orientation to be used + the orientation to be used - - Draws a spinner on @window using the given parameters. + + Draws a spinner on @window using the given parameters. Use gtk_render_icon() and the #GtkStyleContext you are drawing instead @@ -211902,80 +152466,49 @@ given style and orientation. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - - the widget (may be %NULL) + + the widget (may be %NULL) - - a style detail (may be %NULL) + + a style detail (may be %NULL) - the nth step + the nth step - the x origin of the rectangle in which to draw the spinner + the x origin of the rectangle in which to draw the spinner - the y origin of the rectangle in which to draw the spinner + the y origin of the rectangle in which to draw the spinner - the width of the rectangle in which to draw the spinner + the width of the rectangle in which to draw the spinner - the height of the rectangle in which to draw the spinner + the height of the rectangle in which to draw the spinner - - Draws an option menu tab (i.e. the up and down pointing arrows) + + Draws an option menu tab (i.e. the up and down pointing arrows) in the given rectangle on @cr using the given parameters. Use cairo instead @@ -211984,80 +152517,49 @@ in the given rectangle on @cr using the given parameters. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - the type of shadow to draw + the type of shadow to draw - - the widget + + the widget - - a style detail + + a style detail - x origin of the rectangle to draw the tab in + x origin of the rectangle to draw the tab in - y origin of the rectangle to draw the tab in + y origin of the rectangle to draw the tab in - the width of the rectangle to draw the tab in + the width of the rectangle to draw the tab in - the height of the rectangle to draw the tab in + the height of the rectangle to draw the tab in - - Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @cr + + Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @cr using the given style and state. Use gtk_render_line() instead @@ -212066,90 +152568,54 @@ using the given style and state. - a #GtkStyle + a #GtkStyle - a #cairo_t + a #cairo_t - a state + a state - - the widget + + the widget - - a style detail + + a style detail - the starting y coordinate + the starting y coordinate - the ending y coordinate + the ending y coordinate - the x coordinate + the x coordinate - - Returns the name of the default paper size, which + + Returns the name of the default paper size, which depends on the current locale. - the name of the default paper size. The string + the name of the default paper size. The string is owned by GTK+ and should not be modified. - - Creates a list of known paper sizes. + + Creates a list of known paper sizes. - a newly allocated list of newly + a newly allocated list of newly allocated #GtkPaperSize objects @@ -212157,18 +152623,14 @@ is owned by GTK+ and should not be modified. - whether to include custom paper sizes + whether to include custom paper sizes as defined in the page setup dialog - Parses command line arguments, and initializes global + Parses command line arguments, and initializes global attributes of GTK+, but does not actually open a connection to a display. (See gdk_display_open(), gdk_get_display_arg_name()) @@ -212183,28 +152645,16 @@ function, so this way of initializing GTK+ is really only useful for specialized use cases. - %TRUE if initialization succeeded, otherwise %FALSE + %TRUE if initialization succeeded, otherwise %FALSE - - a pointer to the number of command line arguments + + a pointer to the number of command line arguments - - a pointer to the array of + + a pointer to the array of command line arguments @@ -212212,26 +152662,15 @@ for specialized use cases. - - Registers an error quark for #GtkPrintOperation if necessary. + + Registers an error quark for #GtkPrintOperation if necessary. - The error quark used for #GtkPrintOperation errors. + The error quark used for #GtkPrintOperation errors. - - Runs a page setup dialog, letting the user modify the values from + + Runs a page setup dialog, letting the user modify the values from @page_setup. If the user cancels the dialog, the returned #GtkPageSetup is identical to the passed in @page_setup, otherwise it contains the modifications done in the dialog. @@ -212241,44 +152680,26 @@ setup dialog. See gtk_print_run_page_setup_dialog_async() if this is a problem. - a new #GtkPageSetup + a new #GtkPageSetup - - transient parent + + transient parent - - an existing #GtkPageSetup + + an existing #GtkPageSetup - a #GtkPrintSettings + a #GtkPrintSettings - - Runs a page setup dialog, letting the user modify the values from @page_setup. + + Runs a page setup dialog, letting the user modify the values from @page_setup. In contrast to gtk_print_run_page_setup_dialog(), this function returns after showing the page setup dialog on platforms that support this, and calls @done_cb @@ -212288,55 +152709,31 @@ from a signal handler for the ::response signal of the dialog. - - transient parent, or %NULL + + transient parent, or %NULL - - an existing #GtkPageSetup, or %NULL + + an existing #GtkPageSetup, or %NULL - a #GtkPrintSettings + a #GtkPrintSettings - - a function to call when the user saves + + a function to call when the user saves the modified page setup - - user data to pass to @done_cb + + user data to pass to @done_cb - Sends an event to a widget, propagating the event to parent widgets + Sends an event to a widget, propagating the event to parent widgets if the event remains unhandled. Events received by GTK+ from GDK normally begin in gtk_main_do_event(). @@ -212349,7 +152746,7 @@ function; it simply emits the #GtkWidget::event and possibly an event-specific signal on a widget. gtk_propagate_event() is a bit higher-level, and gtk_main_do_event() is the highest level. -All that said, you most likely don’t want to use any of these +All that said, you most likely don’t want to use any of these functions; synthesizing events is rarely needed. There are almost certainly better ways to achieve your goals. For example, use gdk_window_invalidate_rect() or gtk_widget_queue_draw() instead @@ -212360,26 +152757,17 @@ of making up expose events. - a #GtkWidget + a #GtkWidget - an event + an event - - Adds a file to the list of files to be parsed at the + + Adds a file to the list of files to be parsed at the end of gtk_init(). Use #GtkStyleContext with a custom #GtkStyleProvider instead @@ -212388,93 +152776,62 @@ end of gtk_init(). - the pathname to the file. If @filename + the pathname to the file. If @filename is not absolute, it is searched in the current directory. - - Searches for a theme engine in the GTK+ search path. This function + + Searches for a theme engine in the GTK+ search path. This function is not useful for applications and should not be used. Use #GtkCssProvider instead. - The filename, if found (must be + The filename, if found (must be freed with g_free()), otherwise %NULL. - name of a theme engine + name of a theme engine - - Looks up a file in pixmap path for the specified #GtkSettings. + + Looks up a file in pixmap path for the specified #GtkSettings. If the file is not found, it outputs a warning message using g_warning() and returns %NULL. Use #GtkCssProvider instead. - the filename. + the filename. - a #GtkSettings + a #GtkSettings - Scanner used to get line number information for the + Scanner used to get line number information for the warning message, or %NULL - name of the pixmap file to locate. + name of the pixmap file to locate. - - Retrieves the current list of RC files that will be parsed + + Retrieves the current list of RC files that will be parsed at the end of gtk_init(). Use #GtkStyleContext instead - + A %NULL-terminated array of filenames. This memory is owned by GTK+ and must not be freed by the application. If you want to store this information, you should make a copy. @@ -212483,32 +152840,20 @@ at the end of gtk_init(). - - Obtains the path to the IM modules file. See the documentation + + Obtains the path to the IM modules file. See the documentation of the `GTK_IM_MODULE_FILE` environment variable for more details. Use #GtkCssProvider instead. - a newly-allocated string containing the + a newly-allocated string containing the name of the file listing the IM modules available for loading - - Obtains the path in which to look for IM modules. See the documentation + + Obtains the path in which to look for IM modules. See the documentation of the `GTK_PATH` environment variable for more details about looking up modules. This function is useful solely for utilities supplied with GTK+ and should @@ -212516,38 +152861,24 @@ not be used by applications under normal circumstances. Use #GtkCssProvider instead. - a newly-allocated string containing the + a newly-allocated string containing the path in which to look for IM modules. - - Returns a directory in which GTK+ looks for theme engines. + + Returns a directory in which GTK+ looks for theme engines. For full information about the search for theme engines, see the docs for `GTK_PATH` in [Running GTK+ Applications][gtk-running]. Use #GtkCssProvider instead. - the directory. (Must be freed with g_free()) + the directory. (Must be freed with g_free()) - - Finds all matching RC styles for a given widget, + + Finds all matching RC styles for a given widget, composites them together, and then creates a #GtkStyle representing the composite appearance. (GTK+ actually keeps a cache of previously @@ -212556,32 +152887,23 @@ created.) Use #GtkStyleContext instead - the resulting style. No refcount is added + the resulting style. No refcount is added to the returned style, so if you want to save this style around, you should add a reference yourself. - a #GtkWidget + a #GtkWidget - - Creates up a #GtkStyle from styles defined in a RC file by providing + + Creates up a #GtkStyle from styles defined in a RC file by providing the raw components used in matching. This function may be useful when creating pseudo-widgets that should be themed like widgets but -don’t actually have corresponding GTK+ widgets. An example of this +don’t actually have corresponding GTK+ widgets. An example of this would be items inside a GNOME canvas widget. The action of gtk_rc_get_style() is similar to: @@ -212595,9 +152917,7 @@ The action of gtk_rc_get_style() is similar to: Use #GtkStyleContext instead - A style created by matching + A style created by matching with the supplied paths, or %NULL if nothing matching was specified and the default style should be used. The returned value is owned by GTK+ as part of an internal cache, so you @@ -212607,65 +152927,39 @@ The action of gtk_rc_get_style() is similar to: - a #GtkSettings object + a #GtkSettings object - - the widget path to use when looking up the + + the widget path to use when looking up the style, or %NULL if no matching against the widget path should be done - - the class path to use when looking up the style, + + the class path to use when looking up the style, or %NULL if no matching against the class path should be done. - a type that will be used along with parent types of this type + a type that will be used along with parent types of this type when matching against class styles, or #G_TYPE_NONE - - Returns the standard directory in which themes should + + Returns the standard directory in which themes should be installed. (GTK+ does not actually use this directory itself.) Use #GtkCssProvider instead. - The directory (must be freed with g_free()). + The directory (must be freed with g_free()). - - Parses a given resource file. + + Parses a given resource file. Use #GtkCssProvider instead. @@ -212673,21 +152967,14 @@ itself.) - the filename of a file to parse. If @filename is not absolute, it + the filename of a file to parse. If @filename is not absolute, it is searched in the current directory. - - Parses a color in the format expected + + Parses a color in the format expected in a RC file. Note that theme engines should use gtk_rc_parse_color_full() in @@ -212695,154 +152982,95 @@ order to support symbolic colors. Use #GtkCssProvider instead - %G_TOKEN_NONE if parsing succeeded, otherwise the token + %G_TOKEN_NONE if parsing succeeded, otherwise the token that was expected but not found - a #GScanner + a #GScanner - - a pointer to a #GdkColor in which to store + + a pointer to a #GdkColor in which to store the result - - Parses a color in the format expected + + Parses a color in the format expected in a RC file. If @style is not %NULL, it will be consulted to resolve references to symbolic colors. Use #GtkCssProvider instead - %G_TOKEN_NONE if parsing succeeded, otherwise the token + %G_TOKEN_NONE if parsing succeeded, otherwise the token that was expected but not found - a #GScanner + a #GScanner - - a #GtkRcStyle, or %NULL + + a #GtkRcStyle, or %NULL - - a pointer to a #GdkColor in which to store + + a pointer to a #GdkColor in which to store the result - - Parses a #GtkPathPriorityType variable from the format expected + + Parses a #GtkPathPriorityType variable from the format expected in a RC file. Use #GtkCssProvider instead - %G_TOKEN_NONE if parsing succeeded, otherwise the token + %G_TOKEN_NONE if parsing succeeded, otherwise the token that was expected but not found. - a #GScanner (must be initialized for parsing an RC file) + a #GScanner (must be initialized for parsing an RC file) - A pointer to #GtkPathPriorityType variable in which + A pointer to #GtkPathPriorityType variable in which to store the result. - - Parses a #GtkStateType variable from the format expected + + Parses a #GtkStateType variable from the format expected in a RC file. Use #GtkCssProvider instead - %G_TOKEN_NONE if parsing succeeded, otherwise the token + %G_TOKEN_NONE if parsing succeeded, otherwise the token that was expected but not found. - a #GScanner (must be initialized for parsing an RC file) + a #GScanner (must be initialized for parsing an RC file) - - A pointer to a #GtkStateType variable in which to + + A pointer to a #GtkStateType variable in which to store the result. - - Parses resource information directly from a string. + + Parses resource information directly from a string. Use #GtkCssProvider instead. @@ -212850,58 +153078,40 @@ in a RC file. - a string to parse. + a string to parse. - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses borders in the form `"{ left, right, top, bottom }"` for integers left, right, top and bottom. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GtkBorder. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold boxed values. + a #GValue which must hold boxed values. - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a color given either by its name or in the form `{ red, green, blue }` where red, green and @@ -212909,39 +153119,27 @@ blue are integers between 0 and 65535 or floating-point numbers between 0 and 1. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GdkColor. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold #GdkColor values. + a #GValue which must hold #GdkColor values. - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a single enumeration value. @@ -212950,39 +153148,27 @@ its numeric value. For consistency with flags parsing, the value may be surrounded by parentheses. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GEnumValue. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold enum values. + a #GValue which must hold enum values. - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses flags. Flags can be specified by their name, their nickname or @@ -212990,129 +153176,85 @@ numerically. Multiple flags can be specified in the form `"( flag1 | flag2 | ... )"`. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting flags value. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold flags values. + a #GValue which must hold flags values. - - A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() + + A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() or gtk_widget_class_install_style_property_parser() which parses a requisition in the form `"{ width, height }"` for integers %width and %height. - %TRUE if @gstring could be parsed and @property_value + %TRUE if @gstring could be parsed and @property_value has been set to the resulting #GtkRequisition. - a #GParamSpec + a #GParamSpec - the #GString to be parsed + the #GString to be parsed - a #GValue which must hold boxed values. + a #GValue which must hold boxed values. - - If the modification time on any previously read file for the + + If the modification time on any previously read file for the default #GtkSettings has changed, discard all style information and then reread all previously read RC files. Use #GtkCssProvider instead. - %TRUE if the files were reread. + %TRUE if the files were reread. - - If the modification time on any previously read file + + If the modification time on any previously read file for the given #GtkSettings has changed, discard all style information and then reread all previously read RC files. Use #GtkCssProvider instead. - %TRUE if the files were reread. + %TRUE if the files were reread. - a #GtkSettings + a #GtkSettings - load whether or not anything changed + load whether or not anything changed - - This function recomputes the styles for all widgets that use a + + This function recomputes the styles for all widgets that use a particular #GtkSettings object. (There is one #GtkSettings object per #GdkScreen, see gtk_settings_get_for_screen()); It is useful when some global parameter has changed that affects the appearance @@ -213120,7 +153262,7 @@ of all widgets, because when a widget gets a new style, it will both redraw and recompute any cached information about its appearance. As an example, it is used when the default font size set by the operating system changes. Note that this function -doesn’t affect widgets that have a style set explicitly on them +doesn’t affect widgets that have a style set explicitly on them with gtk_widget_set_style(). Use #GtkCssProvider instead. @@ -213129,31 +153271,20 @@ with gtk_widget_set_style(). - a #GtkSettings + a #GtkSettings - + Use #GtkCssProvider instead - - Sets the list of files that GTK+ will read at the + + Sets the list of files that GTK+ will read at the end of gtk_init(). Use #GtkStyleContext with a custom #GtkStyleProvider instead @@ -213162,9 +153293,7 @@ end of gtk_init(). - A + A %NULL-terminated list of filenames. @@ -213172,26 +153301,18 @@ end of gtk_init(). - + - + - - Renders an activity indicator (such as in #GtkSpinner). + + Renders an activity indicator (such as in #GtkSpinner). The state %GTK_STATE_FLAG_CHECKED determines whether there is activity going on. @@ -213200,51 +153321,35 @@ activity going on. - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Renders an arrow pointing to @angle. + + Renders an arrow pointing to @angle. -Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π: +Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π: ![](arrows.png) @@ -213253,49 +153358,33 @@ Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north + arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north - X origin of the render area + X origin of the render area - Y origin of the render area + Y origin of the render area - square side for render area + square side for render area - - Renders the background of an element. + + Renders the background of an element. Typical background rendering, showing the effect of `background-image`, `border-width` and `border-radius`: @@ -213307,49 +153396,33 @@ Typical background rendering, showing the effect of - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Returns the area that will be affected (i.e. drawn to) when + + Returns the area that will be affected (i.e. drawn to) when calling gtk_render_background() for the given @context and rectangle. @@ -213358,52 +153431,33 @@ rectangle. - a #GtkStyleContext + a #GtkStyleContext - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - return location for the clip + + return location for the clip - - Renders a checkmark (as in a #GtkCheckButton). + + Renders a checkmark (as in a #GtkCheckButton). The %GTK_STATE_FLAG_CHECKED state determines whether the check is on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it @@ -213418,49 +153472,33 @@ Typical checkmark rendering: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Renders an expander (as used in #GtkTreeView and #GtkExpander) in the area + + Renders an expander (as used in #GtkTreeView and #GtkExpander) in the area defined by @x, @y, @width, @height. The state %GTK_STATE_FLAG_CHECKED determines whether the expander is collapsed or expanded. @@ -213473,49 +153511,33 @@ Typical expander rendering: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Renders a extension (as in a #GtkNotebook tab) in the rectangle + + Renders a extension (as in a #GtkNotebook tab) in the rectangle defined by @x, @y, @width, @height. The side where the extension connects to is defined by @gap_side. @@ -213528,55 +153550,37 @@ Typical extension rendering: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - side where the gap is + side where the gap is - - Renders a focus indicator on the rectangle determined by @x, @y, @width, @height. + + Renders a focus indicator on the rectangle determined by @x, @y, @width, @height. Typical focus rendering: @@ -213587,49 +153591,33 @@ Typical focus rendering: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Renders a frame around the rectangle defined by @x, @y, @width, @height. + + Renders a frame around the rectangle defined by @x, @y, @width, @height. Examples of frame rendering, showing the effect of `border-image`, `border-color`, `border-width`, `border-radius` and junctions: @@ -213641,51 +153629,33 @@ Examples of frame rendering, showing the effect of `border-image`, - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Renders a frame around the rectangle defined by (@x, @y, @width, @height), + + Renders a frame around the rectangle defined by (@x, @y, @width, @height), leaving a gap on one side. @xy0_gap and @xy1_gap will mean X coordinates for %GTK_POS_TOP and %GTK_POS_BOTTOM gap sides, and Y coordinates for %GTK_POS_LEFT and %GTK_POS_RIGHT. @@ -213701,68 +153671,46 @@ Typical rendering of a frame with a gap: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - side where the gap is + side where the gap is - initial coordinate (X or Y depending on @gap_side) for the gap + initial coordinate (X or Y depending on @gap_side) for the gap - end coordinate (X or Y depending on @gap_side) for the gap + end coordinate (X or Y depending on @gap_side) for the gap - - Renders a handle (as in #GtkHandleBox, #GtkPaned and -#GtkWindow’s resize grip), in the rectangle + + Renders a handle (as in #GtkHandleBox, #GtkPaned and +#GtkWindow’s resize grip), in the rectangle determined by @x, @y, @width, @height. Handles rendered for the paned and grip classes: @@ -213774,47 +153722,33 @@ Handles rendered for the paned and grip classes: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders the icon in @pixbuf at the specified @x and @y coordinates. + Renders the icon in @pixbuf at the specified @x and @y coordinates. This function will render the icon in @pixbuf at exactly its size, regardless of scaling factors, which may not be appropriate when @@ -213828,271 +153762,183 @@ already have a Cairo surface. - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - a #GdkPixbuf containing the icon to draw + a #GdkPixbuf containing the icon to draw - X position for the @pixbuf + X position for the @pixbuf - Y position for the @pixbuf + Y position for the @pixbuf - - Renders the icon specified by @source at the given @size, returning the result + + Renders the icon specified by @source at the given @size, returning the result in a pixbuf. Use gtk_icon_theme_load_icon() instead. - a newly-created #GdkPixbuf containing the rendered icon + a newly-created #GdkPixbuf containing the rendered icon - a #GtkStyleContext + a #GtkStyleContext - the #GtkIconSource specifying the icon to render + the #GtkIconSource specifying the icon to render - the size (#GtkIconSize) to render the icon at. + the size (#GtkIconSize) to render the icon at. A size of `(GtkIconSize) -1` means render at the size of the source - and don’t scale. - + and don’t scale. + - - Renders the icon in @surface at the specified @x and @y coordinates. + + Renders the icon in @surface at the specified @x and @y coordinates. - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - a #cairo_surface_t containing the icon to draw + a #cairo_surface_t containing the icon to draw - X position for the @icon + X position for the @icon - Y position for the @incon + Y position for the @incon - - Draws a text caret on @cr at the specified index of @layout. + + Draws a text caret on @cr at the specified index of @layout. - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin + X origin - Y origin + Y origin - the #PangoLayout of the text + the #PangoLayout of the text - the index in the #PangoLayout + the index in the #PangoLayout - the #PangoDirection of the text + the #PangoDirection of the text - - Renders @layout on the coordinates @x, @y + + Renders @layout on the coordinates @x, @y - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin + X origin - Y origin + Y origin - the #PangoLayout to render + the #PangoLayout to render - Renders a line from (x0, y0) to (x1, y1). + Renders a line from (x0, y0) to (x1, y1). - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X coordinate for the origin of the line + X coordinate for the origin of the line - Y coordinate for the origin of the line + Y coordinate for the origin of the line - X coordinate for the end of the line + X coordinate for the end of the line - Y coordinate for the end of the line + Y coordinate for the end of the line - - Renders an option mark (as in a #GtkRadioButton), the %GTK_STATE_FLAG_CHECKED + + Renders an option mark (as in a #GtkRadioButton), the %GTK_STATE_FLAG_CHECKED state will determine whether the option is on or off, and %GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined. @@ -214105,49 +153951,33 @@ Typical option mark rendering: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - - Renders a slider (as in #GtkScale) in the rectangle defined by @x, @y, + + Renders a slider (as in #GtkScale) in the rectangle defined by @x, @y, @width, @height. @orientation defines whether the slider is vertical or horizontal. @@ -214160,53 +153990,37 @@ Typical slider rendering: - a #GtkStyleContext + a #GtkStyleContext - a #cairo_t + a #cairo_t - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - orientation of the slider + orientation of the slider - Converts a color from RGB space to HSV. + Converts a color from RGB space to HSV. Input values must be in the [0.0, 1.0] range; output values will be in the same range. @@ -214216,57 +154030,33 @@ output values will be in the same range. - Red + Red - Green + Green - Blue + Blue - - Return value for the hue component + + Return value for the hue component - - Return value for the saturation component + + Return value for the saturation component - - Return value for the value component + + Return value for the value component - - Appends a specified target to the list of supported targets for a + + Appends a specified target to the list of supported targets for a given widget and selection. @@ -214274,36 +154064,25 @@ given widget and selection. - a #GtkWidget + a #GtkWidget - the selection + the selection - target to add. + target to add. - A unsigned integer which will be passed back to the application. + A unsigned integer which will be passed back to the application. - - Prepends a table of targets to the list of supported targets + + Prepends a table of targets to the list of supported targets for a given widget and selection. @@ -214311,38 +154090,27 @@ for a given widget and selection. - a #GtkWidget + a #GtkWidget - the selection + the selection - a table of targets to add + a table of targets to add - number of entries in @targets + number of entries in @targets - - Remove all targets registered for the given selection for the + + Remove all targets registered for the given selection for the widget. @@ -214350,147 +154118,97 @@ widget. - a #GtkWidget + a #GtkWidget - an atom representing a selection + an atom representing a selection - Requests the contents of a selection. When received, -a “selection-received” signal will be generated. + Requests the contents of a selection. When received, +a “selection-received” signal will be generated. - %TRUE if requested succeeded. %FALSE if we could not process + %TRUE if requested succeeded. %FALSE if we could not process request. (e.g., there was already a request in process for this widget). - The widget which acts as requestor + The widget which acts as requestor - Which selection to get + Which selection to get - Form of information desired (e.g., STRING) + Form of information desired (e.g., STRING) - Time of request (usually of triggering event) + Time of request (usually of triggering event) In emergency, you could use #GDK_CURRENT_TIME - - Claims ownership of a given selection for a particular widget, + + Claims ownership of a given selection for a particular widget, or, if @widget is %NULL, release ownership of the selection. - %TRUE if the operation succeeded + %TRUE if the operation succeeded - - a #GtkWidget, or %NULL. + + a #GtkWidget, or %NULL. - an interned atom representing the selection to claim + an interned atom representing the selection to claim - timestamp with which to claim the selection + timestamp with which to claim the selection - - Claim ownership of a given selection for a particular widget, or, + + Claim ownership of a given selection for a particular widget, or, if @widget is %NULL, release ownership of the selection. - TRUE if the operation succeeded + TRUE if the operation succeeded - the #GdkDisplay where the selection is set + the #GdkDisplay where the selection is set - - new selection owner (a #GtkWidget), or %NULL. + + new selection owner (a #GtkWidget), or %NULL. - an interned atom representing the selection to claim. + an interned atom representing the selection to claim. - timestamp with which to claim the selection + timestamp with which to claim the selection - - Removes all handlers and unsets ownership of all + + Removes all handlers and unsets ownership of all selections for a widget. Called when widget is being destroyed. This function will not generally be called by applications. @@ -214500,17 +154218,13 @@ called by applications. - a #GtkWidget + a #GtkWidget - Sets the GTK+ debug flags. + Sets the GTK+ debug flags. @@ -214521,13 +154235,8 @@ called by applications. - - This is a convenience function for showing an application’s about box. + + This is a convenience function for showing an application’s about box. The constructed dialog is associated with the parent window and reused for future invocations of this function. @@ -214535,38 +154244,22 @@ reused for future invocations of this function. - - transient parent, or %NULL for none + + transient parent, or %NULL for none - the name of the first property + the name of the first property - value of first property, followed by more properties, %NULL-terminated + value of first property, followed by more properties, %NULL-terminated - - A convenience function for launching the default application + + A convenience function for launching the default application to show the uri. Like gtk_show_uri_on_window(), but takes a screen as transient parent instead of a window. @@ -214576,43 +154269,27 @@ sandboxed applications for example. Use gtk_show_uri_on_window() instead. - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - - screen to show the uri on + + screen to show the uri on or %NULL for the default screen - the uri to show + the uri to show - a timestamp to prevent focus stealing + a timestamp to prevent focus stealing - - This is a convenience function for launching the default application + + This is a convenience function for launching the default application to show the uri. The uri must be of a form understood by GIO (i.e. you need to install gvfs to get support for uri schemes such as http:// or ftp://, as only local files are handled by GIO itself). @@ -214629,42 +154306,26 @@ This is the recommended call to be used as it passes information necessary for sandbox helpers to parent their dialogs properly. - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - - parent window + + parent window - the uri to show + the uri to show - a timestamp to prevent focus stealing + a timestamp to prevent focus stealing - - Registers each of the stock items in @items. If an item already + + Registers each of the stock items in @items. If an item already exists with the same stock ID as one of the @items, the old item gets replaced. The stock items are copied, so GTK+ does not hold any pointer into @items and @items can be freed. Use @@ -214676,28 +154337,19 @@ copy the array. - a #GtkStockItem or array of items + a #GtkStockItem or array of items - number of #GtkStockItem in @items + number of #GtkStockItem in @items - - Same as gtk_stock_add(), but doesn’t copy @items, so + + Same as gtk_stock_add(), but doesn’t copy @items, so @items must persist until application exit. @@ -214705,81 +154357,50 @@ copy the array. - a #GtkStockItem or array of #GtkStockItem + a #GtkStockItem or array of #GtkStockItem - number of items + number of items - - Retrieves a list of all known stock IDs added to a #GtkIconFactory + + Retrieves a list of all known stock IDs added to a #GtkIconFactory or registered with gtk_stock_add(). The list must be freed with g_slist_free(), and each string in the list must be freed with g_free(). - a list of known stock IDs + a list of known stock IDs - - Fills @item with the registered values for @stock_id, returning %TRUE + + Fills @item with the registered values for @stock_id, returning %TRUE if @stock_id was known. - %TRUE if @item was initialized + %TRUE if @item was initialized - a stock item name + a stock item name - - stock item to initialize with values + + stock item to initialize with values - - Sets a function to be used for translating the @label of + + Sets a function to be used for translating the @label of a stock item. If no function is registered for a translation domain, @@ -214819,45 +154440,26 @@ gtk_stock_set_translate_func ("even-item-domain", my_translate_func, "even items - the translation domain for which @func shall be used + the translation domain for which @func shall be used - - a #GtkTranslateFunc + + a #GtkTranslateFunc - - data to pass to @func + + data to pass to @func - a #GDestroyNotify that is called when @data is + a #GDestroyNotify that is called when @data is no longer needed - - This function frees a target table as returned by + + This function frees a target table as returned by gtk_target_table_new_from_list() @@ -214865,286 +154467,188 @@ gtk_target_table_new_from_list() - a #GtkTargetEntry array + a #GtkTargetEntry array - the number of entries in the array + the number of entries in the array - - This function creates an #GtkTargetEntry array that contains the + + This function creates an #GtkTargetEntry array that contains the same targets as the passed %list. The returned table is newly allocated and should be freed using gtk_target_table_free() when no longer needed. - the new table. + the new table. - a #GtkTargetList + a #GtkTargetList - - return location for the number ot targets in the table + + return location for the number ot targets in the table - - Determines if any of the targets in @targets can be used to + + Determines if any of the targets in @targets can be used to provide a #GdkPixbuf. - %TRUE if @targets include a suitable target for images, + %TRUE if @targets include a suitable target for images, otherwise %FALSE. - an array of #GdkAtoms + an array of #GdkAtoms - the length of @targets + the length of @targets - whether to accept only targets for which GTK+ knows + whether to accept only targets for which GTK+ knows how to convert a pixbuf into the format - - Determines if any of the targets in @targets can be used to + + Determines if any of the targets in @targets can be used to provide rich text. - %TRUE if @targets include a suitable target for rich text, + %TRUE if @targets include a suitable target for rich text, otherwise %FALSE. - an array of #GdkAtoms + an array of #GdkAtoms - the length of @targets + the length of @targets - a #GtkTextBuffer + a #GtkTextBuffer - - Determines if any of the targets in @targets can be used to + + Determines if any of the targets in @targets can be used to provide text. - %TRUE if @targets include a suitable target for text, + %TRUE if @targets include a suitable target for text, otherwise %FALSE. - an array of #GdkAtoms + an array of #GdkAtoms - the length of @targets + the length of @targets - - Determines if any of the targets in @targets can be used to + + Determines if any of the targets in @targets can be used to provide an uri list. - %TRUE if @targets include a suitable target for uri lists, + %TRUE if @targets include a suitable target for uri lists, otherwise %FALSE. - an array of #GdkAtoms + an array of #GdkAtoms - the length of @targets + the length of @targets - - Create a simple window with window title @window_title and + + Create a simple window with window title @window_title and text contents @dialog_text. The window will quit any running gtk_main()-loop when destroyed, and it will automatically be destroyed upon test function teardown. This testing infrastructure is phased out in favor of reftests. - a widget pointer to the newly created GtkWindow. + a widget pointer to the newly created GtkWindow. - Title of the window to be displayed. + Title of the window to be displayed. - Text inside the window to be displayed. + Text inside the window to be displayed. - - This function wraps g_object_new() for widget types. -It’ll automatically show all created non window widgets, also + + This function wraps g_object_new() for widget types. +It’ll automatically show all created non window widgets, also g_object_ref_sink() them (to keep them alive across a running test) and set them up for destruction during the next test teardown phase. This testing infrastructure is phased out in favor of reftests. - a newly created widget. + a newly created widget. - a valid widget type. + a valid widget type. - - Name of first property to set or %NULL + + Name of first property to set or %NULL - value to set the first property to, followed by more + value to set the first property to, followed by more name-value pairs, terminated by %NULL - - Create a window with window title @window_title, text contents @dialog_text, + + Create a window with window title @window_title, text contents @dialog_text, and a number of buttons, according to the paired argument list given as @... parameters. Each button is created with a @label and a ::clicked signal handler that @@ -215157,151 +154661,106 @@ will automatically be destroyed upon test function teardown. This testing infrastructure is phased out in favor of reftests. - a widget pointer to the newly created GtkWindow. + a widget pointer to the newly created GtkWindow. - Title of the window to be displayed. + Title of the window to be displayed. - Text inside the window to be displayed. + Text inside the window to be displayed. - %NULL terminated list of (const char *label, int *nump) pairs. + %NULL terminated list of (const char *label, int *nump) pairs. - - This function will search @widget and all its descendants for a GtkLabel + + This function will search @widget and all its descendants for a GtkLabel widget with a text string matching @label_pattern. -The @label_pattern may contain asterisks “*” and question marks “?” as +The @label_pattern may contain asterisks “*” and question marks “?” as placeholders, g_pattern_match() is used for the matching. -Note that locales other than "C“ tend to alter (translate” label strings, +Note that locales other than "C“ tend to alter (translate” label strings, so this function is genrally only useful in test programs with predetermined locales, see gtk_test_init() for more details. - a GtkLabel widget if any is found. + a GtkLabel widget if any is found. - Valid label or container widget. + Valid label or container widget. - Shell-glob pattern to match a label string. + Shell-glob pattern to match a label string. - - This function will search siblings of @base_widget and siblings of its + + This function will search siblings of @base_widget and siblings of its ancestors for all widgets matching @widget_type. Of the matching widgets, the one that is geometrically closest to @base_widget will be returned. -The general purpose of this function is to find the most likely “action” +The general purpose of this function is to find the most likely “action” widget, relative to another labeling widget. Such as finding a button or text entry widget, given its corresponding label widget. - a widget of type @widget_type if any is found. + a widget of type @widget_type if any is found. - Valid widget, part of a widget hierarchy + Valid widget, part of a widget hierarchy - Type of a aearched for sibling widget + Type of a aearched for sibling widget - - This function will search the descendants of @widget for a widget + + This function will search the descendants of @widget for a widget of type @widget_type that has a label matching @label_pattern next to it. This is most useful for automated GUI testing, e.g. to find -the “OK” button in a dialog and synthesize clicks on it. +the “OK” button in a dialog and synthesize clicks on it. However see gtk_test_find_label(), gtk_test_find_sibling() and gtk_test_widget_click() for possible caveats involving the search of such widgets and synthesizing widget events. - a valid widget if any is found or %NULL. + a valid widget if any is found or %NULL. - Container widget, usually a GtkWindow. + Container widget, usually a GtkWindow. - Shell-glob pattern to match a label string. + Shell-glob pattern to match a label string. - Type of a aearched for label sibling widget. + Type of a aearched for label sibling widget. - - This function is used to initialize a GTK+ test program. + + This function is used to initialize a GTK+ test program. It will in turn call g_test_init() and gtk_init() to properly -initialize the testing framework and graphical toolkit. It’ll -also set the program’s locale to “C” and prevent loading of rc +initialize the testing framework and graphical toolkit. It’ll +also set the program’s locale to “C” and prevent loading of rc files and Gtk+ modules. This is done to make tets program environments as deterministic as possible. @@ -215312,23 +154771,13 @@ processed and stripped from @argc and @argv. - - Address of the `argc` parameter of the + + Address of the `argc` parameter of the main() function. Changed if any arguments were handled. - - Address of the + + Address of the `argv` parameter of main(). Any parameters understood by g_test_init() or gtk_init() are stripped before return. @@ -215337,48 +154786,31 @@ processed and stripped from @argc and @argv. - currently unused + currently unused - - Return the type ids that have been registered after + + Return the type ids that have been registered after calling gtk_test_register_all_types(). - + 0-terminated array of type ids - - location to store number of types + + location to store number of types - - Force registration of all core Gtk+ and Gdk object types. + + Force registration of all core Gtk+ and Gdk object types. This allowes to refer to any of those object types via g_type_from_name() after calling this function. @@ -215386,14 +154818,8 @@ g_type_from_name() after calling this function. - - Retrive the literal adjustment value for GtkRange based + + Retrive the literal adjustment value for GtkRange based widgets and spin buttons. Note that the value returned by this function is anything between the lower and upper bounds of the adjustment belonging to @widget, and is not a percentage @@ -215401,29 +154827,19 @@ as passed in to gtk_test_slider_set_perc(). This testing infrastructure is phased out in favor of reftests. - gtk_adjustment_get_value (adjustment) for an adjustment belonging to @widget. + gtk_adjustment_get_value (adjustment) for an adjustment belonging to @widget. - valid widget pointer. + valid widget pointer. - - This function will adjust the slider position of all GtkRange -based widgets, such as scrollbars or scales, it’ll also adjust + + This function will adjust the slider position of all GtkRange +based widgets, such as scrollbars or scales, it’ll also adjust spin buttons. The adjustment value of these widgets is set to a value between the lower and upper limits, according to the @percentage argument. @@ -215434,92 +154850,58 @@ a value between the lower and upper limits, according to the - valid widget pointer. + valid widget pointer. - value between 0 and 100. + value between 0 and 100. - - This function will generate a @button click in the upwards or downwards + + This function will generate a @button click in the upwards or downwards spin button arrow areas, usually leading to an increase or decrease of -spin button’s value. +spin button’s value. This testing infrastructure is phased out in favor of reftests. - whether all actions neccessary for the button click simulation were carried out successfully. + whether all actions neccessary for the button click simulation were carried out successfully. - valid GtkSpinButton widget. + valid GtkSpinButton widget. - Number of the pointer button for the event, usually 1, 2 or 3. + Number of the pointer button for the event, usually 1, 2 or 3. - %TRUE for upwards arrow click, %FALSE for downwards arrow click. + %TRUE for upwards arrow click, %FALSE for downwards arrow click. - - Retrive the text string of @widget if it is a GtkLabel, + + Retrive the text string of @widget if it is a GtkLabel, GtkEditable (entry and text widgets) or GtkTextView. This testing infrastructure is phased out in favor of reftests. - new 0-terminated C string, needs to be released with g_free(). + new 0-terminated C string, needs to be released with g_free(). - valid widget pointer. + valid widget pointer. - - Set the text string of @widget to @string if it is a GtkLabel, + + Set the text string of @widget to @string if it is a GtkLabel, GtkEditable (entry and text widgets) or GtkTextView. This testing infrastructure is phased out in favor of reftests. @@ -215528,27 +154910,17 @@ GtkEditable (entry and text widgets) or GtkTextView. - valid widget pointer. + valid widget pointer. - a 0-terminated C string + a 0-terminated C string - - This function will generate a @button click (button press and button + + This function will generate a @button click (button press and button release event) in the middle of the first GdkWindow found that belongs to @widget. For windowless widgets like #GtkButton (which returns %FALSE from @@ -215560,38 +154932,26 @@ location, see gdk_test_simulate_button() for details. This testing infrastructure is phased out in favor of reftests. - whether all actions neccessary for the button click simulation were carried out successfully. + whether all actions neccessary for the button click simulation were carried out successfully. - Widget to generate a button click on. + Widget to generate a button click on. - Number of the pointer button for the event, usually 1, 2 or 3. + Number of the pointer button for the event, usually 1, 2 or 3. - Keyboard modifiers the event is setup with. + Keyboard modifiers the event is setup with. - - This function will generate keyboard press and release events in + + This function will generate keyboard press and release events in the middle of the first GdkWindow found that belongs to @widget. For windowless widgets like #GtkButton (which returns %FALSE from gtk_widget_get_has_window()), this will often be an @@ -215601,38 +154961,26 @@ particular because the mouse pointer is warped to the key press location, see gdk_test_simulate_key() for details. - whether all actions neccessary for the key event simulation were carried out successfully. + whether all actions neccessary for the key event simulation were carried out successfully. - Widget to generate a key press and release on. + Widget to generate a key press and release on. - A Gdk keyboard value. + A Gdk keyboard value. - Keyboard modifiers the event is setup with. + Keyboard modifiers the event is setup with. - - Enters the main loop and waits for @widget to be “drawn”. In this + + Enters the main loop and waits for @widget to be “drawn”. In this context that means it waits for the frame clock of @widget to have run a full styling, layout and drawing cycle. @@ -215645,73 +154993,44 @@ server. - the widget to wait for + the widget to wait for - - Obtains a @tree_model and @path from selection data of target type + + Obtains a @tree_model and @path from selection data of target type %GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler. This function can only be used if @selection_data originates from the same -process that’s calling this function, because a pointer to the tree model -is being passed around. If you aren’t in the same process, then you'll +process that’s calling this function, because a pointer to the tree model +is being passed around. If you aren’t in the same process, then you'll get memory corruption. In the #GtkTreeDragDest drag_data_received handler, you can assume that selection data of type %GTK_TREE_MODEL_ROW is in from the current process. The returned path must be freed with gtk_tree_path_free(). - %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and + %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and is otherwise valid - a #GtkSelectionData + a #GtkSelectionData - - a #GtkTreeModel + + a #GtkTreeModel - - row in @tree_model + + row in @tree_model - - Lets a set of row reference created by + + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::row-deleted signal. @@ -215720,25 +155039,17 @@ model emitted the #GtkTreeModel::row-deleted signal. - a #GObject + a #GObject - the path position that was deleted + the path position that was deleted - - Lets a set of row reference created by + + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::row-inserted signal. @@ -215747,26 +155058,17 @@ model emitted the #GtkTreeModel::row-inserted signal. - a #GObject + a #GObject - the row position that was inserted + the row position that was inserted - - Lets a set of row reference created by + + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the #GtkTreeModel::rows-reordered signal. @@ -215775,71 +155077,50 @@ model emitted the #GtkTreeModel::rows-reordered signal. - a #GObject + a #GObject - the parent path of the reordered signal + the parent path of the reordered signal - the iter pointing to the parent of the reordered + the iter pointing to the parent of the reordered - the new order of rows + the new order of rows - - Sets selection data of target type %GTK_TREE_MODEL_ROW. Normally used + + Sets selection data of target type %GTK_TREE_MODEL_ROW. Normally used in a drag_data_get handler. - %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row + %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row - some #GtkSelectionData + some #GtkSelectionData - a #GtkTreeModel + a #GtkTreeModel - a row in @tree_model + a row in @tree_model - All this function does it to return %TRUE. + All this function does it to return %TRUE. This can be useful for example if you want to inhibit the deletion of a window. Of course you should not do this as the user expects @@ -215882,43 +155163,27 @@ main (int argc, char **argv) ]| - %TRUE + %TRUE - - Binds a callback function defined in a template to the @widget_class. + + Binds a callback function defined in a template to the @widget_class. This macro is a convenience wrapper around the gtk_widget_class_bind_template_callback_full() function. - a #GtkWidgetClass + a #GtkWidgetClass - the callback symbol + the callback symbol - - Binds a child widget defined in a template to the @widget_class. + + Binds a child widget defined in a template to the @widget_class. This macro is a convenience wrapper around the gtk_widget_class_bind_template_child_full() function. @@ -215928,29 +155193,18 @@ instance structure. - a #GtkWidgetClass + a #GtkWidgetClass - the type name of this widget + the type name of this widget - name of the instance member in the instance struct for @data_type + name of the instance member in the instance struct for @data_type - - Binds a child widget defined in a template to the @widget_class, and + + Binds a child widget defined in a template to the @widget_class, and also makes it available as an internal child in GtkBuilder, under the name @member_name. @@ -215962,29 +155216,18 @@ instance structure. - a #GtkWidgetClass + a #GtkWidgetClass - the type name, in CamelCase + the type name, in CamelCase - name of the instance member in the instance struct for @data_type + name of the instance member in the instance struct for @data_type - - Binds a child widget defined in a template to the @widget_class, and + + Binds a child widget defined in a template to the @widget_class, and also makes it available as an internal child in GtkBuilder, under the name @member_name. @@ -215996,29 +155239,18 @@ private data structure. - a #GtkWidgetClass + a #GtkWidgetClass - the type name, in CamelCase + the type name, in CamelCase - name of the instance private member on the private struct for @data_type + name of the instance private member on the private struct for @data_type - - Binds a child widget defined in a template to the @widget_class. + + Binds a child widget defined in a template to the @widget_class. This macro is a convenience wrapper around the gtk_widget_class_bind_template_child_full() function. @@ -216029,19 +155261,13 @@ must be added with G_ADD_PRIVATE()). - a #GtkWidgetClass + a #GtkWidgetClass - the type name of this widget + the type name of this widget - name of the instance private member in the private struct for @data_type + name of the instance private member in the private struct for @data_type diff --git a/Gtk-4.0.gir b/Gtk-4.0.gir index 45cdaf2..c50ec90 100644 --- a/Gtk-4.0.gir +++ b/Gtk-4.0.gir @@ -9,222 +9,250 @@ and/or use gtk-doc annotations. --> - The rectangle representing the area allocated for a widget by its parent. + The rectangle representing the area allocated for a widget by its parent. + + - An undefined value. The accessible attribute is either unset, or its + An undefined value. The accessible attribute is either unset, or its value is undefined. + + + + + + + + + + + + + + + + + + + + - `GtkATContext` is an abstract class provided by GTK to communicate to + `GtkATContext` is an abstract class provided by GTK to communicate to platform-specific assistive technologies API. Each platform supported by GTK implements a `GtkATContext` subclass, and is responsible for updating the accessible state in response to state changes in `GtkAccessible`. + - Creates a new `GtkATContext` instance for the given accessible role, + Creates a new `GtkATContext` instance for the given accessible role, accessible instance, and display connection. The `GtkATContext` implementation being instantiated will depend on the platform. + - the `GtkATContext` + the `GtkATContext` - the accessible role used by the `GtkATContext` + the accessible role used by the `GtkATContext` - the `GtkAccessible` implementation using the `GtkATContext` + the `GtkAccessible` implementation using the `GtkATContext` - the `GdkDisplay` used by the `GtkATContext` + the `GdkDisplay` used by the `GtkATContext` - Retrieves the `GtkAccessible` using this context. + Retrieves the `GtkAccessible` using this context. + - a `GtkAccessible` + a `GtkAccessible` - a `GtkATContext` + a `GtkATContext` - Retrieves the accessible role of this context. + Retrieves the accessible role of this context. + - a `GtkAccessibleRole` + a `GtkAccessibleRole` - a `GtkATContext` + a `GtkATContext` - The `GtkAccessible` that created the `GtkATContext` instance. + The `GtkAccessible` that created the `GtkATContext` instance. - The accessible role used by the AT context. + The accessible role used by the AT context. Depending on the given role, different states and properties can be set or retrieved. - The `GdkDisplay` for the `GtkATContext`. + The `GdkDisplay` for the `GtkATContext`. - Emitted when the attributes of the accessible for the + Emitted when the attributes of the accessible for the `GtkATContext` instance change. - + + + - The `GtkAboutDialog` offers a simple way to display information about + The `GtkAboutDialog` offers a simple way to display information about a program. The shown information includes the programs' logo, name, copyright, @@ -278,28 +306,30 @@ class `.aboutdialog`. - Creates a new `GtkAboutDialog`. + Creates a new `GtkAboutDialog`. + - a newly created `GtkAboutDialog` + a newly created `GtkAboutDialog` - Creates a new section in the "Credits" page. + Creates a new section in the "Credits" page. + - A `GtkAboutDialog` + A `GtkAboutDialog` - The name of the section + The name of the section - The people who belong to that section + The people who belong to that section @@ -308,10 +338,11 @@ class `.aboutdialog`. - Returns the names of the artists which are displayed + Returns the names of the artists which are displayed in the credits page. + - A + A `NULL`-terminated string array containing the artists @@ -319,17 +350,18 @@ in the credits page. - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the names of the authors which are displayed + Returns the names of the authors which are displayed in the credits page. + - A + A `NULL`-terminated string array containing the authors @@ -337,45 +369,48 @@ in the credits page. - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the comments string. + Returns the comments string. + - The comments + The comments - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the copyright string. + Returns the copyright string. + - The copyright string + The copyright string - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the name of the documenters which are displayed + Returns the name of the documenters which are displayed in the credits page. + - A + A `NULL`-terminated string array containing the documenters @@ -383,184 +418,196 @@ in the credits page. - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the license information. + Returns the license information. + - The license information + The license information - a `GtkAboutDialog` + a `GtkAboutDialog` - Retrieves the license type. + Retrieves the license type. + - a [enum@Gtk.License] value + a [enum@Gtk.License] value - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the paintable displayed as logo in the about dialog. + Returns the paintable displayed as logo in the about dialog. + - the paintable displayed as + the paintable displayed as logo or `NULL` if the logo is unset or has been set via [method@Gtk.AboutDialog.set_logo_icon_name] - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the icon name displayed as logo in the about dialog. + Returns the icon name displayed as logo in the about dialog. + - the icon name displayed as logo, + the icon name displayed as logo, or `NULL` if the logo has been set via [method@Gtk.AboutDialog.set_logo] - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the program name displayed in the about dialog. + Returns the program name displayed in the about dialog. + - The program name + The program name - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the system information that is shown in the about dialog. + Returns the system information that is shown in the about dialog. + - the system information + the system information - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the translator credits string which is displayed + Returns the translator credits string which is displayed in the credits page. + - The translator credits string + The translator credits string - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the version string. + Returns the version string. + - The version string + The version string - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the website URL. + Returns the website URL. + - The website URL + The website URL - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns the label used for the website link. + Returns the label used for the website link. + - The label used for the website link + The label used for the website link - a `GtkAboutDialog` + a `GtkAboutDialog` - Returns whether the license text in the about dialog is + Returns whether the license text in the about dialog is automatically wrapped. + - `TRUE` if the license text is wrapped + `TRUE` if the license text is wrapped - a `GtkAboutDialog` + a `GtkAboutDialog` - Sets the names of the artists to be displayed + Sets the names of the artists to be displayed in the "Credits" page. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the authors of the artwork + the authors of the artwork of the application @@ -570,18 +617,19 @@ in the "Credits" page. - Sets the names of the authors which are displayed + Sets the names of the authors which are displayed in the "Credits" page of the about dialog. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the authors of the application + the authors of the application @@ -590,56 +638,59 @@ in the "Credits" page of the about dialog. - Sets the comments string to display in the about dialog. + Sets the comments string to display in the about dialog. This should be a short string of one or two lines. + - a `GtkAboutDialog` + a `GtkAboutDialog` - a comments string + a comments string - Sets the copyright string to display in the about dialog. + Sets the copyright string to display in the about dialog. This should be a short string of one or two lines. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the copyright string + the copyright string - Sets the names of the documenters which are displayed + Sets the names of the documenters which are displayed in the "Credits" page. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the authors of the documentation + the authors of the documentation of the application @@ -649,125 +700,131 @@ in the "Credits" page. - Sets the license information to be displayed in the + Sets the license information to be displayed in the about dialog. If `license` is `NULL`, the license page is hidden. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the license information + the license information - Sets the license of the application showing the about dialog from a + Sets the license of the application showing the about dialog from a list of known licenses. This function overrides the license set using [method@Gtk.AboutDialog.set_license]. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the type of license + the type of license - Sets the logo in the about dialog. + Sets the logo in the about dialog. + - a `GtkAboutDialog` + a `GtkAboutDialog` - a `GdkPaintable` + a `GdkPaintable` - Sets the icon name to be displayed as logo in the about dialog. + Sets the icon name to be displayed as logo in the about dialog. + - a `GtkAboutDialog` + a `GtkAboutDialog` - an icon name + an icon name - Sets the name to display in the about dialog. + Sets the name to display in the about dialog. If `name` is not set, the string returned by `g_get_application_name()` is used. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the program name + the program name - Sets the system information to be displayed in the about + Sets the system information to be displayed in the about dialog. If `system_information` is `NULL`, the system information page is hidden. See [property@Gtk.AboutDialog:system-information]. + - a `GtkAboutDialog` + a `GtkAboutDialog` - system information + system information - Sets the translator credits string which is displayed in + Sets the translator credits string which is displayed in the credits page. The intended use for this string is to display the translator @@ -785,85 +842,90 @@ It is a good idea to use the customary `msgid` “translator-credits” for this purpose, since translators will already know the purpose of that `msgid`, and since `GtkAboutDialog` will detect if “translator-credits” is untranslated and omit translator credits. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the translator credits + the translator credits - Sets the version string to display in the about dialog. + Sets the version string to display in the about dialog. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the version string + the version string - Sets the URL to use for the website link. + Sets the URL to use for the website link. + - a `GtkAboutDialog` + a `GtkAboutDialog` - a URL string starting with `http://` + a URL string starting with `http://` - Sets the label to be used for the website link. + Sets the label to be used for the website link. + - a `GtkAboutDialog` + a `GtkAboutDialog` - the label used for the website link + the label used for the website link - Sets whether the license text in the about dialog should be + Sets whether the license text in the about dialog should be automatically wrapped. + - a `GtkAboutDialog` + a `GtkAboutDialog` - whether to wrap the license + whether to wrap the license @@ -871,7 +933,7 @@ automatically wrapped. - The people who contributed artwork to the program, as a `NULL`-terminated + The people who contributed artwork to the program, as a `NULL`-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed @@ -883,7 +945,7 @@ as links. - The authors of the program, as a `NULL`-terminated array of strings. + The authors of the program, as a `NULL`-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. @@ -894,7 +956,7 @@ as links, see the introduction for more details. - Comments about the program. + Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, @@ -904,13 +966,13 @@ not a detailed list of features. - Copyright information for the program. + Copyright information for the program. - The people documenting the program, as a `NULL`-terminated array of strings. + The people documenting the program, as a `NULL`-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. @@ -921,7 +983,7 @@ as links, see the introduction for more details. - The license of the program, as free-form text. + The license of the program, as free-form text. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only @@ -940,7 +1002,7 @@ be converted into clickable links. - The license of the program. + The license of the program. The `GtkAboutDialog` will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license @@ -960,7 +1022,7 @@ a side effect. - A logo for the about box. + A logo for the about box. If it is `NULL`, the default window icon set with [id@gtk_window_set_default_icon_name] will be used. @@ -969,7 +1031,7 @@ If it is `NULL`, the default window icon set with - A named icon to use as the logo for the about box. + A named icon to use as the logo for the about box. This property overrides the [property@Gtk.AboutDialog:logo] property. @@ -977,7 +1039,7 @@ This property overrides the [property@Gtk.AboutDialog:logo] property. - The name of the program. + The name of the program. If this is not set, it defaults to the value returned by `g_get_application_name()`. @@ -986,7 +1048,7 @@ If this is not set, it defaults to the value returned by - Information about the system on which the program is running. + Information about the system on which the program is running. This information is displayed in a separate page, therefore it is fine to use a long multi-paragraph text. Note that the text should contain @@ -1000,7 +1062,7 @@ be converted into clickable links. - Credits to the translators. + Credits to the translators. This string should be marked as translatable. @@ -1011,13 +1073,13 @@ as links, see the introduction for more details. - The version of the program. + The version of the program. - The URL for the link to the website of the program. + The URL for the link to the website of the program. This should be a string starting with `http://` or `https://`. @@ -1025,34 +1087,34 @@ This should be a string starting with `http://` or `https://`. - The label for the link to the website of the program. + The label for the link to the website of the program. - Whether to wrap the text in the license dialog. + Whether to wrap the text in the license dialog. - Emitted every time a URL is activated. + Emitted every time a URL is activated. Applications may connect to it to override the default behaviour, which is to call [func@Gtk.show_uri]. - `TRUE` if the link has been activated + `TRUE` if the link has been activated - the URI that is activated + the URI that is activated - `GtkAccessible` is an interface for describing UI elements for + `GtkAccessible` is an interface for describing UI elements for Assistive Technologies. Every accessible implementation has: @@ -1068,70 +1130,75 @@ The attributes are updated every time a UI element's state changes in a way that should be reflected by assistive technologies. For instance, if a `GtkWidget` visibility changes, the %GTK_ACCESSIBLE_STATE_HIDDEN state will also change to reflect the [property@Gtk.Widget:visible] property. + - Retrieves the `GtkAccessibleRole` for the given `GtkAccessible`. + Retrieves the `GtkAccessibleRole` for the given `GtkAccessible`. + - a `GtkAccessibleRole` + a `GtkAccessibleRole` - a `GtkAccessible` + a `GtkAccessible` - Resets the accessible @property to its default value. + Resets the accessible @property to its default value. + - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleProperty` + a `GtkAccessibleProperty` - Resets the accessible @relation to its default value. + Resets the accessible @relation to its default value. + - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleRelation` + a `GtkAccessibleRelation` - Resets the accessible @state to its default value. + Resets the accessible @state to its default value. + - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleState` + a `GtkAccessibleState` - Updates a list of accessible properties. + Updates a list of accessible properties. See the [enum@Gtk.AccessibleProperty] documentation for the value types of accessible properties. @@ -1147,51 +1214,53 @@ gtk_accessible_update_property (GTK_ACCESSIBLE (spin_button), GTK_ACCESSIBLE_PROPERTY_VALUE_NOW, value, -1); ``` + - a `GtkAccessible` + a `GtkAccessible` - the first `GtkAccessibleProperty` + the first `GtkAccessibleProperty` - a list of property and value pairs, terminated by -1 + a list of property and value pairs, terminated by -1 - Updates an array of accessible properties. + Updates an array of accessible properties. This function should be called by `GtkWidget` types whenever an accessible property change must be communicated to assistive technologies. This function is meant to be used by language bindings. + - a `GtkAccessible` + a `GtkAccessible` - the number of accessible properties to set + the number of accessible properties to set - an array of `GtkAccessibleProperty` + an array of `GtkAccessibleProperty` - an array of `GValues`, one for each property + an array of `GValues`, one for each property @@ -1199,7 +1268,7 @@ This function is meant to be used by language bindings. - Updates a list of accessible relations. + Updates a list of accessible relations. This function should be called by `GtkWidget` types whenever an accessible relation change must be communicated to assistive technologies. @@ -1215,51 +1284,53 @@ gtk_accessible_update_relation (accessible, ref1, ref2, ref3, NULL, -1); ``` + - a `GtkAccessible` + a `GtkAccessible` - the first `GtkAccessibleRelation` + the first `GtkAccessibleRelation` - a list of relation and value pairs, terminated by -1 + a list of relation and value pairs, terminated by -1 - Updates an array of accessible relations. + Updates an array of accessible relations. This function should be called by `GtkWidget` types whenever an accessible relation change must be communicated to assistive technologies. This function is meant to be used by language bindings. + - a `GtkAccessible` + a `GtkAccessible` - the number of accessible relations to set + the number of accessible relations to set - an array of `GtkAccessibleRelation` + an array of `GtkAccessibleRelation` - an array of `GValues`, one for each relation + an array of `GValues`, one for each relation @@ -1267,7 +1338,7 @@ This function is meant to be used by language bindings. - Updates a list of accessible states. See the [enum@Gtk.AccessibleState] + Updates a list of accessible states. See the [enum@Gtk.AccessibleState] documentation for the value types of accessible states. This function should be called by `GtkWidget` types whenever an accessible @@ -1280,51 +1351,53 @@ gtk_accessible_update_state (GTK_ACCESSIBLE (check_button), GTK_ACCESSIBLE_STATE_CHECKED, value, -1); ``` + - a `GtkAccessible` + a `GtkAccessible` - the first `GtkAccessibleState` + the first `GtkAccessibleState` - a list of state and value pairs, terminated by -1 + a list of state and value pairs, terminated by -1 - Updates an array of accessible states. + Updates an array of accessible states. This function should be called by `GtkWidget` types whenever an accessible state change must be communicated to assistive technologies. This function is meant to be used by language bindings. + - a `GtkAccessible` + a `GtkAccessible` - the number of accessible states to set + the number of accessible states to set - an array of `GtkAccessibleState` + an array of `GtkAccessibleState` - an array of `GValues`, one for each state + an array of `GValues`, one for each state @@ -1333,145 +1406,148 @@ This function is meant to be used by language bindings. - The accessible role of the given `GtkAccessible` implementation. + The accessible role of the given `GtkAccessible` implementation. The accessible role cannot be changed once set. - The possible values for the %GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE + The possible values for the %GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE accessible property. - Automatic suggestions are not displayed. + Automatic suggestions are not displayed. - When a user is providing input, text + When a user is providing input, text suggesting one way to complete the provided input may be dynamically inserted after the caret. - When a user is providing input, an element + When a user is providing input, an element containing a collection of values that could complete the provided input may be displayed. - When a user is providing input, an element + When a user is providing input, an element containing a collection of values that could complete the provided input may be displayed. If displayed, one value in the collection is automatically selected, and the text needed to complete the automatically selected value appears after the caret in the input. - + + + - The possible values for the %GTK_ACCESSIBLE_STATE_INVALID + The possible values for the %GTK_ACCESSIBLE_STATE_INVALID accessible state. Note that the %GTK_ACCESSIBLE_INVALID_FALSE and %GTK_ACCESSIBLE_INVALID_TRUE have the same values as %FALSE and %TRUE. - There are no detected errors in the value + There are no detected errors in the value - The value entered by the user has failed validation + The value entered by the user has failed validation - A grammatical error was detected + A grammatical error was detected - A spelling error was detected + A spelling error was detected - The possible accessible properties of a `GtkAccessible`. + The possible accessible properties of a `GtkAccessible`. - Indicates whether inputting text + Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for a combobox, searchbox, or textbox and specifies how predictions would be presented if they were made. Value type: `GtkAccessibleAutocomplete` - Defines a string value that describes + Defines a string value that describes or annotates the current element. Value type: string - Indicates the availability and type of + Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. - Indicates keyboard shortcuts that an + Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Value type: string - Defines a string value that labels the current + Defines a string value that labels the current element. Value type: string - Defines the hierarchical level of an element + Defines the hierarchical level of an element within a structure. Value type: integer - Indicates whether an element is modal when + Indicates whether an element is modal when displayed. Value type: boolean - Indicates whether a text box accepts + Indicates whether a text box accepts multiple lines of input or only a single line. Value type: boolean - Indicates that the user may select + Indicates that the user may select more than one item from the current selectable descendants. Value type: boolean - Indicates whether the element's + Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Value type: `GtkOrientation` - Defines a short hint (a word or short + Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. Value type: string - Indicates that the element is not editable, + Indicates that the element is not editable, but is otherwise operable. Value type: boolean - Indicates that user input is required on + Indicates that user input is required on the element before a form may be submitted. Value type: boolean - Defines a human-readable, + Defines a human-readable, author-localized description for the role of an element. Value type: string - Indicates if items in a table or grid are + Indicates if items in a table or grid are sorted in ascending or descending order. Possible property values are in the `GtkAccessibleSort` enumeration. Value type: `GtkAccessibleSort` - Defines the maximum allowed value for a + Defines the maximum allowed value for a range widget. Value type: double - Defines the minimum allowed value for a + Defines the minimum allowed value for a range widget. Value type: double - Defines the current value for a range widget. + Defines the current value for a range widget. Value type: double - Defines the human readable text alternative + Defines the human readable text alternative of aria-valuenow for a range widget. Value type: string + @@ -1486,90 +1562,91 @@ as %FALSE and %TRUE. - The possible accessible relations of a `GtkAccessible`. + The possible accessible relations of a `GtkAccessible`. Accessible relations can be references to other widgets, integers or strings. - Identifies the currently active + Identifies the currently active element when focus is on a composite widget, combobox, textbox, group, or application. Value type: reference - Defines the total number of columns + Defines the total number of columns in a table, grid, or treegrid. Value type: integer - Defines an element's column index or + Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. Value type: integer - Defines a human readable text + Defines a human readable text alternative of %GTK_ACCESSIBLE_RELATION_COL_INDEX. Value type: string - Defines the number of columns spanned + Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. Value type: integer - Identifies the element (or elements) whose + Identifies the element (or elements) whose contents or presence are controlled by the current element. Value type: reference - Identifies the element (or elements) + Identifies the element (or elements) that describes the object. Value type: reference - Identifies the element (or elements) that + Identifies the element (or elements) that provide additional information related to the object. Value type: reference - Identifies the element that provides + Identifies the element that provides an error message for an object. Value type: reference - Identifies the next element (or elements) + Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. Value type: reference - Identifies the element (or elements) + Identifies the element (or elements) that labels the current element. Value type: reference - Identifies an element (or elements) in order + Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between elements where the widget hierarchy cannot be used to represent the relationship. Value type: reference - Defines an element's number or position + Defines an element's number or position in the current set of listitems or treeitems. Value type: integer - Defines the total number of rows in a table, + Defines the total number of rows in a table, grid, or treegrid. Value type: integer - Defines an element's row index or position + Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. Value type: integer - Defines a human readable text + Defines a human readable text alternative of aria-rowindex. Value type: string - Defines the number of rows spanned by a + Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. Value type: integer - Defines the number of items in the current + Defines the number of items in the current set of listitems or treeitems. Value type: integer + @@ -1584,322 +1661,323 @@ integers or strings. - The accessible role for a `GtkAccessible` implementation. + The accessible role for a `GtkAccessible` implementation. Abstract roles are only used as part of the ontology; application developers must not use abstract roles in their code. - An element with important, and usually + An element with important, and usually time-sensitive, information - A type of dialog that contains an + A type of dialog that contains an alert message - Unused + Unused - An input element that allows for + An input element that allows for user-triggered actions when clicked or pressed - Unused + Unused - Unused + Unused - A checkable input element that has + A checkable input element that has three possible values: `true`, `false`, or `mixed` - A header in a columned list. + A header in a columned list. - An input that controls another element, + An input that controls another element, such as a list or a grid, that can dynamically pop up to help the user set the value of the input - Abstract role. + Abstract role. - Abstract role. + Abstract role. - A dialog is a window that is designed to interrupt + A dialog is a window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response. - Unused + Unused - Unused + Unused - Unused + Unused - Unused + Unused - A grid of items. + A grid of items. - An item in a grid or tree grid. + An item in a grid or tree grid. - An element that groups multiple widgets. GTK uses + An element that groups multiple widgets. GTK uses this role for various containers, like `GtkBox`, `GtkViewport`, and `GtkHeaderBar`. - Unused + Unused - An image. + An image. - Abstract role. + Abstract role. - A visible name or caption for a user interface component. + A visible name or caption for a user interface component. - Abstract role. + Abstract role. - Unused + Unused - A clickable link. + A clickable link. - A list of items. + A list of items. - Unused. + Unused. - An item in a list. + An item in a list. - Unused + Unused - Unused + Unused - Unused + Unused - Unused + Unused - An element that represents a value within a known range. + An element that represents a value within a known range. - A menu. + A menu. - A menubar. + A menubar. - An item in a menu. + An item in a menu. - A check item in a menu. + A check item in a menu. - A radio item in a menu. + A radio item in a menu. - Unused + Unused - An element that is not represented to accessibility technologies. + An element that is not represented to accessibility technologies. - Unused + Unused - Unused + Unused - An element that is not represented to accessibility technologies. + An element that is not represented to accessibility technologies. - An element that displays the progress + An element that displays the progress status for tasks that take a long time. - A checkable input in a group of radio roles, + A checkable input in a group of radio roles, only one of which can be checked at a time. - Unused + Unused - Abstract role. + Abstract role. - Unused + Unused - A row in a columned list. + A row in a columned list. - Unused + Unused - Unused + Unused - A graphical object that controls the scrolling + A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area. - Unused + Unused - A type of textbox intended for specifying + A type of textbox intended for specifying search criteria. - Abstract role. + Abstract role. - Abstract role. + Abstract role. - Abstract role. + Abstract role. - A divider that separates and distinguishes + A divider that separates and distinguishes sections of content or groups of menuitems. - A user input where the user selects a value + A user input where the user selects a value from within a given range. - A form of range that expects the user to + A form of range that expects the user to select from among discrete choices. - Unused + Unused - Abstract role. + Abstract role. - A type of checkbox that represents on/off values, + A type of checkbox that represents on/off values, as opposed to checked/unchecked values. - An item in a list of tab used for switching pages. + An item in a list of tab used for switching pages. - Unused + Unused - A list of tabs for switching pages. + A list of tabs for switching pages. - A page in a notebook or stack. + A page in a notebook or stack. - A type of input that allows free-form text + A type of input that allows free-form text as its value. - Unused + Unused - Unused + Unused - Unused + Unused - Unused + Unused - Unused + Unused - A treeview-like, columned list. + A treeview-like, columned list. - Unused + Unused - An interactive component of a graphical user + An interactive component of a graphical user interface. This is the role that GTK uses by default for widgets. - An application window. + An application window. - The possible values for the %GTK_ACCESSIBLE_PROPERTY_SORT + The possible values for the %GTK_ACCESSIBLE_PROPERTY_SORT accessible property. - There is no defined sort applied to the column. + There is no defined sort applied to the column. - Items are sorted in ascending order by this column. + Items are sorted in ascending order by this column. - Items are sorted in descending order by this column. + Items are sorted in descending order by this column. - A sort algorithm other than ascending or + A sort algorithm other than ascending or descending has been applied. - The possible accessible states of a `GtkAccessible`. + The possible accessible states of a `GtkAccessible`. - A “busy” state. This state has boolean values + A “busy” state. This state has boolean values - A “checked” state; indicates the current + A “checked” state; indicates the current state of a `GtkCheckButton`. Value type: `GtkAccessibleTristate` - A “disabled” state; corresponds to the + A “disabled” state; corresponds to the `GtkWidget:sensitive` property on `GtkWidget`. It indicates a UI element that is perceivable, but not editable or operable. Value type: boolean - An “expanded” state; corresponds to the + An “expanded” state; corresponds to the `GtkExpander:expanded` property on `GtkExpander`. Value type: boolean or undefined - A “hidden” state; corresponds to the + A “hidden” state; corresponds to the `GtkWidget:visible` property on `GtkWidget`. You can use this state explicitly on UI elements that should not be exposed to an assistive technology. Value type: boolean See also: %GTK_ACCESSIBLE_STATE_DISABLED - An “invalid” state; set when a widget + An “invalid” state; set when a widget is showing an error. Value type: `GtkAccessibleInvalidState` - A “pressed” state; indicates the current + A “pressed” state; indicates the current state of a `GtkToggleButton`. Value type: `GtkAccessibleTristate` enumeration - A “selected” state; set when a widget + A “selected” state; set when a widget is selected. Value type: boolean or undefined + @@ -1914,24 +1992,24 @@ accessible property. - The possible values for the %GTK_ACCESSIBLE_STATE_PRESSED + The possible values for the %GTK_ACCESSIBLE_STATE_PRESSED accessible state. Note that the %GTK_ACCESSIBLE_TRISTATE_FALSE and %GTK_ACCESSIBLE_TRISTATE_TRUE have the same values as %FALSE and %TRUE. - The state is `false` + The state is `false` - The state is `true` + The state is `true` - The state is `mixed` + The state is `mixed` - `GtkActionBar` is designed to present contextual actions. + `GtkActionBar` is designed to present contextual actions. ![An example GtkActionBar](action-bar.png) @@ -1966,123 +2044,131 @@ Each of the boxes contains children packed for that side. - Creates a new `GtkActionBar` widget. + Creates a new `GtkActionBar` widget. + - a new `GtkActionBar` + a new `GtkActionBar` - Retrieves the center bar widget of the bar. + Retrieves the center bar widget of the bar. + - the center `GtkWidget` + the center `GtkWidget` - a `GtkActionBar` + a `GtkActionBar` - Gets whether the contents of the action bar are revealed. + Gets whether the contents of the action bar are revealed. + - the current value of the [property@Gtk.ActionBar:revealed] + the current value of the [property@Gtk.ActionBar:revealed] property - a `GtkActionBar` + a `GtkActionBar` - Adds @child to @action_bar, packed with reference to the + Adds @child to @action_bar, packed with reference to the end of the @action_bar. + - A `GtkActionBar` + A `GtkActionBar` - the `GtkWidget` to be added to @action_bar + the `GtkWidget` to be added to @action_bar - Adds @child to @action_bar, packed with reference to the + Adds @child to @action_bar, packed with reference to the start of the @action_bar. + - A `GtkActionBar` + A `GtkActionBar` - the `GtkWidget` to be added to @action_bar + the `GtkWidget` to be added to @action_bar - Removes a child from @action_bar. + Removes a child from @action_bar. + - a `GtkActionBar` + a `GtkActionBar` - the `GtkWidget` to be removed + the `GtkWidget` to be removed - Sets the center widget for the `GtkActionBar`. + Sets the center widget for the `GtkActionBar`. + - a `GtkActionBar` + a `GtkActionBar` - a widget to use for the center + a widget to use for the center - Reveals or conceals the content of the action bar. + Reveals or conceals the content of the action bar. Note: this does not show or hide @action_bar in the [property@Gtk.Widget:visible] sense, so revealing has no effect if the action bar is hidden. + - a `GtkActionBar` + a `GtkActionBar` - The new value of the property + The new value of the property @@ -2090,12 +2176,12 @@ no effect if the action bar is hidden. - Controls whether the action bar shows its contents. + Controls whether the action bar shows its contents. - The `GtkActionable` interface provides a convenient way of asscociating + The `GtkActionable` interface provides a convenient way of asscociating widgets with actions. It primarily consists of two properties: [property@Gtk.Actionable:action-name] @@ -2108,38 +2194,41 @@ the “win.” or “app.” prefix that are associated with `GtkApplicationWindow` or `GtkApplication`, but other action groups that are added with [method@Gtk.Widget.insert_action_group] will be consulted as well. + - Gets the action name for @actionable. + Gets the action name for @actionable. + - the action name + the action name - a `GtkActionable` widget + a `GtkActionable` widget - Gets the current target value of @actionable. + Gets the current target value of @actionable. + - the current target value + the current target value - a `GtkActionable` widget + a `GtkActionable` widget - Specifies the name of the action with which this widget should be + Specifies the name of the action with which this widget should be associated. If @action_name is %NULL then the widget will be unassociated from @@ -2152,23 +2241,24 @@ Names are of the form “win.save” or “app.quit” for a containing `GtkApplicationWindow` or its associated `GtkApplication`, respectively. This is the same form used for actions in the `GMenu` associated with the window. + - a `GtkActionable` widget + a `GtkActionable` widget - an action name + an action name - Sets the target value of an actionable widget. + Sets the target value of an actionable widget. If @target_value is %NULL then the target value is unset. @@ -2186,51 +2276,54 @@ the action’s state to change to that value. Since the action’s sta is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive). + - a `GtkActionable` widget + a `GtkActionable` widget - a `GVariant` to set as the target value + a `GVariant` to set as the target value - Gets the action name for @actionable. + Gets the action name for @actionable. + - the action name + the action name - a `GtkActionable` widget + a `GtkActionable` widget - Gets the current target value of @actionable. + Gets the current target value of @actionable. + - the current target value + the current target value - a `GtkActionable` widget + a `GtkActionable` widget - Specifies the name of the action with which this widget should be + Specifies the name of the action with which this widget should be associated. If @action_name is %NULL then the widget will be unassociated from @@ -2243,22 +2336,23 @@ Names are of the form “win.save” or “app.quit” for a containing `GtkApplicationWindow` or its associated `GtkApplication`, respectively. This is the same form used for actions in the `GMenu` associated with the window. + - a `GtkActionable` widget + a `GtkActionable` widget - an action name + an action name - Sets the target of an actionable widget. + Sets the target of an actionable widget. This is a convenience function that calls g_variant_new() for @format_string and uses the result to call @@ -2267,27 +2361,28 @@ This is a convenience function that calls g_variant_new() for If you are setting a string-valued target and want to set the action name at the same time, you can use [method@Gtk.Actionable.set_detailed_action_name]. + - a `GtkActionable` widget + a `GtkActionable` widget - a GVariant format string + a GVariant format string - arguments appropriate for @format_string + arguments appropriate for @format_string - Sets the target value of an actionable widget. + Sets the target value of an actionable widget. If @target_value is %NULL then the target value is unset. @@ -2305,36 +2400,38 @@ the action’s state to change to that value. Since the action’s sta is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive). + - a `GtkActionable` widget + a `GtkActionable` widget - a `GVariant` to set as the target value + a `GVariant` to set as the target value - Sets the action-name and associated string target value of an + Sets the action-name and associated string target value of an actionable widget. @detailed_action_name is a string in the format accepted by g_action_parse_detailed_name(). + - a `GtkActionable` widget + a `GtkActionable` widget - the detailed action name + the detailed action name @@ -2347,19 +2444,21 @@ g_action_parse_detailed_name(). - The interface vtable for `GtkActionable`. + The interface vtable for `GtkActionable`. + + - the action name + the action name - a `GtkActionable` widget + a `GtkActionable` widget @@ -2367,16 +2466,17 @@ g_action_parse_detailed_name(). + - a `GtkActionable` widget + a `GtkActionable` widget - an action name + an action name @@ -2384,13 +2484,14 @@ g_action_parse_detailed_name(). + - the current target value + the current target value - a `GtkActionable` widget + a `GtkActionable` widget @@ -2398,16 +2499,17 @@ g_action_parse_detailed_name(). + - a `GtkActionable` widget + a `GtkActionable` widget - a `GVariant` to set as the target value + a `GVariant` to set as the target value @@ -2415,21 +2517,25 @@ g_action_parse_detailed_name(). - A `GtkShortcutAction` that calls gtk_widget_activate(). + A `GtkShortcutAction` that calls gtk_widget_activate(). + - Gets the activate action. + Gets the activate action. This is an action that calls gtk_widget_activate() on the given widget upon activation. + - The activate action + The activate action - + + + - `GtkAdjustment` is a model for a numeric value. + `GtkAdjustment` is a model for a numeric value. The `GtkAdjustment has an associated lower and upper bound. It also contains step and page increments, and a page size. @@ -2440,40 +2546,43 @@ and [class@Gtk.Scale]. The `GtkAdjustment` object does not update the value itself. Instead it is left up to the owner of the `GtkAdjustment` to control the value. + - Creates a new `GtkAdjustment`. + Creates a new `GtkAdjustment`. + - a new `GtkAdjustment` + a new `GtkAdjustment` - the initial value + the initial value - the minimum value + the minimum value - the maximum value + the maximum value - the step increment + the step increment - the page increment + the page increment - the page size + the page size + @@ -2484,6 +2593,7 @@ it is left up to the owner of the `GtkAdjustment` to control the value. + @@ -2494,7 +2604,7 @@ it is left up to the owner of the `GtkAdjustment` to control the value. - Updates the value property to ensure that the range + Updates the value property to ensure that the range between @lower and @upper is in the current page. The current page goes from `value` to `value` + `page-size`. @@ -2503,166 +2613,175 @@ start of it will be in the current page. A [signal@Gtk.Adjustment::value-changed] signal will be emitted if the value is changed. + - a `GtkAdjustment` + a `GtkAdjustment` - the lower value + the lower value - the upper value + the upper value - Sets all properties of the adjustment at once. + Sets all properties of the adjustment at once. Use this function to avoid multiple emissions of the [signal@Gtk.Adjustment::changed] signal. See [method@Gtk.Adjustment.set_lower] for an alternative way of compressing multiple emissions of [signal@Gtk.Adjustment::changed] into one. + - a `GtkAdjustment` + a `GtkAdjustment` - the new value + the new value - the new minimum value + the new minimum value - the new maximum value + the new maximum value - the new step increment + the new step increment - the new page increment + the new page increment - the new page size + the new page size - Retrieves the minimum value of the adjustment. + Retrieves the minimum value of the adjustment. + - The current minimum value of the adjustment + The current minimum value of the adjustment - a `GtkAdjustment` + a `GtkAdjustment` - Gets the smaller of step increment and page increment. + Gets the smaller of step increment and page increment. + - the minimum increment of @adjustment + the minimum increment of @adjustment - a `GtkAdjustment` + a `GtkAdjustment` - Retrieves the page increment of the adjustment. + Retrieves the page increment of the adjustment. + - The current page increment of the adjustment + The current page increment of the adjustment - a `GtkAdjustment` + a `GtkAdjustment` - Retrieves the page size of the adjustment. + Retrieves the page size of the adjustment. + - The current page size of the adjustment + The current page size of the adjustment - a `GtkAdjustment` + a `GtkAdjustment` - Retrieves the step increment of the adjustment. + Retrieves the step increment of the adjustment. + - The current step increment of the adjustment. + The current step increment of the adjustment. - a `GtkAdjustment` + a `GtkAdjustment` - Retrieves the maximum value of the adjustment. + Retrieves the maximum value of the adjustment. + - The current maximum value of the adjustment + The current maximum value of the adjustment - a `GtkAdjustment` + a `GtkAdjustment` - Gets the current value of the adjustment. + Gets the current value of the adjustment. + - The current value of the adjustment + The current value of the adjustment - a `GtkAdjustment` + a `GtkAdjustment` - Sets the minimum value of the adjustment. + Sets the minimum value of the adjustment. When setting multiple adjustment properties via their individual setters, multiple [signal@Gtk.Adjustment::changed] signals will @@ -2675,86 +2794,90 @@ around the calls to the individual setters. Alternatively, using a single g_object_set() for all the properties to change, or using [method@Gtk.Adjustment.configure] has the same effect. + - a `GtkAdjustment` + a `GtkAdjustment` - the new minimum value + the new minimum value - Sets the page increment of the adjustment. + Sets the page increment of the adjustment. See [method@Gtk.Adjustment.set_lower] about how to compress multiple emissions of the [signal@Gtk.Adjustment::changed] signal when setting multiple adjustment properties. + - a `GtkAdjustment` + a `GtkAdjustment` - the new page increment + the new page increment - Sets the page size of the adjustment. + Sets the page size of the adjustment. See [method@Gtk.Adjustment.set_lower] about how to compress multiple emissions of the [signal@Gtk.Adjustment::changed] signal when setting multiple adjustment properties. + - a `GtkAdjustment` + a `GtkAdjustment` - the new page size + the new page size - Sets the step increment of the adjustment. + Sets the step increment of the adjustment. See [method@Gtk.Adjustment.set_lower] about how to compress multiple emissions of the [signal@Gtk.Adjustment::changed] signal when setting multiple adjustment properties. + - a `GtkAdjustment` + a `GtkAdjustment` - the new step increment + the new step increment - Sets the maximum value of the adjustment. + Sets the maximum value of the adjustment. Note that values will be restricted by `upper - page-size` if the page-size property is nonzero. @@ -2762,23 +2885,24 @@ if the page-size property is nonzero. See [method@Gtk.Adjustment.set_lower] about how to compress multiple emissions of the [signal@Gtk.Adjustment::changed] signal when setting multiple adjustment properties. + - a `GtkAdjustment` + a `GtkAdjustment` - the new maximum value + the new maximum value - Sets the `GtkAdjustment` value. + Sets the `GtkAdjustment` value. The value is clamped to lie between [property@Gtk.Adjustment:lower] and [property@Gtk.Adjustment:upper]. @@ -2787,16 +2911,17 @@ Note that for adjustments which are used in a `GtkScrollbar`, the effective range of allowed values goes from [property@Gtk.Adjustment:lower] to [property@Gtk.Adjustment:upper] - [property@Gtk.Adjustment:page-size]. + - a `GtkAdjustment` + a `GtkAdjustment` - the new value + the new value @@ -2804,19 +2929,19 @@ the effective range of allowed values goes from - The minimum value of the adjustment. + The minimum value of the adjustment. - The page increment of the adjustment. + The page increment of the adjustment. - The page size of the adjustment. + The page size of the adjustment. Note that the page-size is irrelevant and should be set to zero if the adjustment is used for a simple scalar value, e.g. in a @@ -2826,13 +2951,13 @@ if the adjustment is used for a simple scalar value, e.g. in a - The step increment of the adjustment. + The step increment of the adjustment. - The maximum value of the adjustment. + The maximum value of the adjustment. Note that values will be restricted by `upper - page-size` if the page-size property is nonzero. @@ -2841,14 +2966,14 @@ property is nonzero. - The value of the adjustment. + The value of the adjustment. - Emitted when one or more of the `GtkAdjustment` properties have been + Emitted when one or more of the `GtkAdjustment` properties have been changed. Note that the [property@Gtk.Adjustment:value] property is @@ -2858,18 +2983,20 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. - Emitted when the value has been changed. + Emitted when the value has been changed. + + @@ -2882,6 +3009,7 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. + @@ -2894,6 +3022,7 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. + @@ -2901,6 +3030,7 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. + @@ -2908,6 +3038,7 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. + @@ -2915,6 +3046,7 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. + @@ -2922,7 +3054,7 @@ covered by the [signal@Gtk.Adjustment::value-changed] signal. - Controls how a widget deals with extra space in a single dimension. + Controls how a widget deals with extra space in a single dimension. Alignment only matters if the widget receives a “too large” allocation, for example if you packed the widget with the [property@Gtk.Widget:hexpand] @@ -2938,121 +3070,131 @@ are interpreted relative to text direction. it is only supported for vertical alignment. When it's not supported by a child or a container it is treated as %GTK_ALIGN_FILL. - stretch to fill all space if possible, center if + stretch to fill all space if possible, center if no meaningful way to stretch - snap to left or top side, leaving space on right or bottom + snap to left or top side, leaving space on right or bottom - snap to right or bottom side, leaving space on left or top + snap to right or bottom side, leaving space on left or top - center natural width of widget inside the allocation + center natural width of widget inside the allocation - align the widget according to the baseline. + align the widget according to the baseline. See [class@Gtk.Widget]. - A `GtkShortcutTrigger` that combines two triggers. + A `GtkShortcutTrigger` that combines two triggers. The `GtkAlternativeTrigger` triggers when either of two trigger. This can be cascaded to combine more than two triggers. + - Creates a `GtkShortcutTrigger` that will trigger whenever + Creates a `GtkShortcutTrigger` that will trigger whenever either of the two given triggers gets triggered. Note that nesting is allowed, so if you want more than two alternative, create a new alternative trigger for each option. + - a new `GtkShortcutTrigger` + a new `GtkShortcutTrigger` - The first trigger that may trigger + The first trigger that may trigger - The second trigger that may trigger + The second trigger that may trigger - Gets the first of the two alternative triggers that may + Gets the first of the two alternative triggers that may trigger @self. [method@Gtk.AlternativeTrigger.get_second] will return the other one. + - the first alternative trigger + the first alternative trigger - an alternative `GtkShortcutTrigger` + an alternative `GtkShortcutTrigger` - Gets the second of the two alternative triggers that may + Gets the second of the two alternative triggers that may trigger @self. [method@Gtk.AlternativeTrigger.get_first] will return the other one. + - the second alternative trigger + the second alternative trigger - an alternative `GtkShortcutTrigger` + an alternative `GtkShortcutTrigger` - The first `GtkShortcutTrigger` to check. + The first `GtkShortcutTrigger` to check. - The second `GtkShortcutTrigger` to check. + The second `GtkShortcutTrigger` to check. - + + + - `GtkAnyFilter` matches an item when at least one of its filters matches. + `GtkAnyFilter` matches an item when at least one of its filters matches. To add filters to a `GtkAnyFilter`, use [method@Gtk.MultiFilter.append]. + - Creates a new empty "any" filter. + Creates a new empty "any" filter. Use [method@Gtk.MultiFilter.append] to add filters to it. This filter matches an item if any of the filters added to it matches the item. In particular, this means that if no filter has been added to it, the filter matches no item. + - a new `GtkAnyFilter` + a new `GtkAnyFilter` - + + + - `GtkAppChooser` is an interface for widgets which allow the user to + `GtkAppChooser` is an interface for widgets which allow the user to choose an application. The main objects that implement this interface are @@ -3073,56 +3215,59 @@ To obtain the application that has been selected in a `GtkAppChooser`, use [method@Gtk.AppChooser.get_app_info]. - Returns the currently selected application. + Returns the currently selected application. + - a `GAppInfo` for the + a `GAppInfo` for the currently selected application - a `GtkAppChooser` + a `GtkAppChooser` - Returns the content type for which the `GtkAppChooser` + Returns the content type for which the `GtkAppChooser` shows applications. + - the content type of @self. Free with g_free() + the content type of @self. Free with g_free() - a `GtkAppChooser` + a `GtkAppChooser` - Reloads the list of applications. + Reloads the list of applications. + - a `GtkAppChooser` + a `GtkAppChooser` - The content type of the `GtkAppChooser` object. + The content type of the `GtkAppChooser` object. See `GContentType` for more information about content types. - The `GtkAppChooserButton` lets the user select an application. + The `GtkAppChooserButton` lets the user select an application. ![An example GtkAppChooserButton](appchooserbutton.png) @@ -3154,21 +3299,22 @@ To track changes in the selected application, use the - Creates a new `GtkAppChooserButton` for applications + Creates a new `GtkAppChooserButton` for applications that can handle content of the given type. + - a newly created `GtkAppChooserButton` + a newly created `GtkAppChooserButton` - the content type to show applications for + the content type to show applications for - Appends a custom item to the list of applications that is shown + Appends a custom item to the list of applications that is shown in the popup. The item name must be unique per-widget. Clients can use the @@ -3177,189 +3323,200 @@ provided name as a detail for the callback for the activation of a particular custom item in the list. See also [method@Gtk.AppChooserButton.append_separator]. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - the name of the custom item + the name of the custom item - the label for the custom item + the label for the custom item - the icon for the custom item + the icon for the custom item - Appends a separator to the list of applications that is shown + Appends a separator to the list of applications that is shown in the popup. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - Returns the text to display at the top of the dialog. + Returns the text to display at the top of the dialog. + - the text to display at the top of the dialog, + the text to display at the top of the dialog, or %NULL, in which case a default text is displayed - a `GtkAppChooserButton` + a `GtkAppChooserButton` - Gets whether the dialog is modal. + Gets whether the dialog is modal. + - %TRUE if the dialog is modal + %TRUE if the dialog is modal - a `GtkAppChooserButton` + a `GtkAppChooserButton` - Returns whether the dropdown menu should show the default + Returns whether the dropdown menu should show the default application at the top. + - the value of [property@Gtk.AppChooserButton:show-default-item] + the value of [property@Gtk.AppChooserButton:show-default-item] - a `GtkAppChooserButton` + a `GtkAppChooserButton` - Returns whether the dropdown menu shows an item + Returns whether the dropdown menu shows an item for a `GtkAppChooserDialog`. + - the value of [property@Gtk.AppChooserButton:show-dialog-item] + the value of [property@Gtk.AppChooserButton:show-dialog-item] - a `GtkAppChooserButton` + a `GtkAppChooserButton` - Selects a custom item. + Selects a custom item. See [method@Gtk.AppChooserButton.append_custom_item]. Use [method@Gtk.AppChooser.refresh] to bring the selection to its initial state. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - the name of the custom item + the name of the custom item - Sets the text to display at the top of the dialog. + Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - a string containing Pango markup + a string containing Pango markup - Sets whether the dialog should be modal. + Sets whether the dialog should be modal. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - %TRUE to make the dialog modal + %TRUE to make the dialog modal - Sets whether the dropdown menu of this button should show the + Sets whether the dropdown menu of this button should show the default application for the given content type at top. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - the new value for [property@Gtk.AppChooserButton:show-default-item] + the new value for [property@Gtk.AppChooserButton:show-default-item] - Sets whether the dropdown menu of this button should show an + Sets whether the dropdown menu of this button should show an entry to trigger a `GtkAppChooserDialog`. + - a `GtkAppChooserButton` + a `GtkAppChooserButton` - the new value for [property@Gtk.AppChooserButton:show-dialog-item] + the new value for [property@Gtk.AppChooserButton:show-dialog-item] @@ -3367,7 +3524,7 @@ entry to trigger a `GtkAppChooserDialog`. - The text to show at the top of the dialog that can be + The text to show at the top of the dialog that can be opened from the button. The string may contain Pango markup. @@ -3376,25 +3533,25 @@ The string may contain Pango markup. - Whether the app chooser dialog should be modal. + Whether the app chooser dialog should be modal. - Determines whether the dropdown menu shows the default application + Determines whether the dropdown menu shows the default application on top for the provided content type. - Determines whether the dropdown menu shows an item to open + Determines whether the dropdown menu shows an item to open a `GtkAppChooserDialog`. - Emitted to when the button is activated. + Emitted to when the button is activated. The `::activate` signal on `GtkAppChooserButton` is an action signal and emitting it causes the button to pop up its dialog. @@ -3403,13 +3560,13 @@ emitting it causes the button to pop up its dialog. - Emitted when the active application changes. + Emitted when the active application changes. - Emitted when a custom item is activated. + Emitted when a custom item is activated. Use [method@Gtk.AppChooserButton.append_custom_item], to add custom items. @@ -3418,14 +3575,14 @@ to add custom items. - the name of the activated item + the name of the activated item - `GtkAppChooserDialog` shows a `GtkAppChooserWidget` inside a `GtkDialog`. + `GtkAppChooserDialog` shows a `GtkAppChooserWidget` inside a `GtkDialog`. ![An example GtkAppChooserDialog](appchooserdialog.png) @@ -3445,100 +3602,105 @@ use [method@Gtk.AppChooserDialog.set_heading]. - Creates a new `GtkAppChooserDialog` for the provided `GFile`. + Creates a new `GtkAppChooserDialog` for the provided `GFile`. The dialog will show applications that can open the file. + - a newly created `GtkAppChooserDialog` + a newly created `GtkAppChooserDialog` - a `GtkWindow` + a `GtkWindow` - flags for this dialog + flags for this dialog - a `GFile` + a `GFile` - Creates a new `GtkAppChooserDialog` for the provided content type. + Creates a new `GtkAppChooserDialog` for the provided content type. The dialog will show applications that can open the content type. + - a newly created `GtkAppChooserDialog` + a newly created `GtkAppChooserDialog` - a `GtkWindow` + a `GtkWindow` - flags for this dialog + flags for this dialog - a content type string + a content type string - Returns the text to display at the top of the dialog. + Returns the text to display at the top of the dialog. + - the text to display at the top of the dialog, + the text to display at the top of the dialog, or %NULL, in which case a default text is displayed - a `GtkAppChooserDialog` + a `GtkAppChooserDialog` - Returns the `GtkAppChooserWidget` of this dialog. + Returns the `GtkAppChooserWidget` of this dialog. + - the `GtkAppChooserWidget` of @self + the `GtkAppChooserWidget` of @self - a `GtkAppChooserDialog` + a `GtkAppChooserDialog` - Sets the text to display at the top of the dialog. + Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text. + - a `GtkAppChooserDialog` + a `GtkAppChooserDialog` - a string containing Pango markup + a string containing Pango markup - The GFile used by the `GtkAppChooserDialog`. + The GFile used by the `GtkAppChooserDialog`. The dialog's `GtkAppChooserWidget` content type will be guessed from the file, if present. @@ -3547,14 +3709,14 @@ be guessed from the file, if present. - The text to show at the top of the dialog. + The text to show at the top of the dialog. The string may contain Pango markup. - `GtkAppChooserWidget` is a widget for selecting applications. + `GtkAppChooserWidget` is a widget for selecting applications. It is the main building block for [class@Gtk.AppChooserDialog]. Most applications only need to use the latter; but you can use @@ -3582,213 +3744,226 @@ To keep track of the selected application, use the - Creates a new `GtkAppChooserWidget` for applications + Creates a new `GtkAppChooserWidget` for applications that can handle content of the given type. + - a newly created `GtkAppChooserWidget` + a newly created `GtkAppChooserWidget` - the content type to show applications for + the content type to show applications for - Returns the text that is shown if there are not applications + Returns the text that is shown if there are not applications that can handle the content type. + - the value of [property@Gtk.AppChooserWidget:default-text] + the value of [property@Gtk.AppChooserWidget:default-text] - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - Gets whether the app chooser should show all applications + Gets whether the app chooser should show all applications in a flat list. + - the value of [property@Gtk.AppChooserWidget:show-all] + the value of [property@Gtk.AppChooserWidget:show-all] - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - Gets whether the app chooser should show the default handler + Gets whether the app chooser should show the default handler for the content type in a separate section. + - the value of [property@Gtk.AppChooserWidget:show-default] + the value of [property@Gtk.AppChooserWidget:show-default] - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - Gets whether the app chooser should show related applications + Gets whether the app chooser should show related applications for the content type in a separate section. + - the value of [property@Gtk.AppChooserWidget:show-fallback] + the value of [property@Gtk.AppChooserWidget:show-fallback] - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - Gets whether the app chooser should show applications + Gets whether the app chooser should show applications which are unrelated to the content type. + - the value of [property@Gtk.AppChooserWidget:show-other] + the value of [property@Gtk.AppChooserWidget:show-other] - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - Gets whether the app chooser should show recommended applications + Gets whether the app chooser should show recommended applications for the content type in a separate section. + - the value of [property@Gtk.AppChooserWidget:show-recommended] + the value of [property@Gtk.AppChooserWidget:show-recommended] - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - Sets the text that is shown if there are not applications + Sets the text that is shown if there are not applications that can handle the content type. + - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - the new value for [property@Gtk.AppChooserWidget:default-text] + the new value for [property@Gtk.AppChooserWidget:default-text] - Sets whether the app chooser should show all applications + Sets whether the app chooser should show all applications in a flat list. + - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - the new value for [property@Gtk.AppChooserWidget:show-all] + the new value for [property@Gtk.AppChooserWidget:show-all] - Sets whether the app chooser should show the default handler + Sets whether the app chooser should show the default handler for the content type in a separate section. + - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - the new value for [property@Gtk.AppChooserWidget:show-default] + the new value for [property@Gtk.AppChooserWidget:show-default] - Sets whether the app chooser should show related applications + Sets whether the app chooser should show related applications for the content type in a separate section. + - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - the new value for [property@Gtk.AppChooserWidget:show-fallback] + the new value for [property@Gtk.AppChooserWidget:show-fallback] - Sets whether the app chooser should show applications + Sets whether the app chooser should show applications which are unrelated to the content type. + - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - the new value for [property@Gtk.AppChooserWidget:show-other] + the new value for [property@Gtk.AppChooserWidget:show-other] - Sets whether the app chooser should show recommended applications + Sets whether the app chooser should show recommended applications for the content type in a separate section. + - a `GtkAppChooserWidget` + a `GtkAppChooserWidget` - the new value for [property@Gtk.AppChooserWidget:show-recommended] + the new value for [property@Gtk.AppChooserWidget:show-recommended] @@ -3796,14 +3971,14 @@ for the content type in a separate section. - The text that appears in the widget when there are no applications + The text that appears in the widget when there are no applications for the given content type. - If %TRUE, the app chooser presents all applications + If %TRUE, the app chooser presents all applications in a single list, without subsections for default, recommended or related applications. @@ -3811,7 +3986,7 @@ recommended or related applications. - Determines whether the app chooser should show the default + Determines whether the app chooser should show the default handler for the content type in a separate section. If %FALSE, the default handler is listed among the recommended @@ -3821,7 +3996,7 @@ applications. - Determines whether the app chooser should show a section + Determines whether the app chooser should show a section for fallback applications. If %FALSE, the fallback applications are listed among the @@ -3831,14 +4006,14 @@ other applications. - Determines whether the app chooser should show a section + Determines whether the app chooser should show a section for other applications. - Determines whether the app chooser should show a section + Determines whether the app chooser should show a section for recommended applications. If %FALSE, the recommended applications are listed @@ -3846,7 +4021,7 @@ among the other applications. - Emitted when an application item is activated from the widget's list. + Emitted when an application item is activated from the widget's list. This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, @@ -3856,26 +4031,26 @@ Return or Enter. - the activated `GAppInfo` + the activated `GAppInfo` - Emitted when an application item is selected from the widget's list. + Emitted when an application item is selected from the widget's list. - the selected `GAppInfo` + the selected `GAppInfo` - `GtkApplication` is a high-level API for writing applications. + `GtkApplication` is a high-level API for writing applications. It supports many aspects of writing a GTK application in a convenient fashion, without enforcing a one-size-fits-all model. @@ -3938,10 +4113,11 @@ session while inhibitors are present. [HowDoI: Using GtkApplication](https://wiki.gnome.org/HowDoI/GtkApplication), [Getting Started with GTK: Basics](getting_started.html#basics) + - Creates a new `GtkApplication` instance. + Creates a new `GtkApplication` instance. When using `GtkApplication`, it is not necessary to call [func@Gtk.init] manually. It is called as soon as the application gets registered as @@ -3959,22 +4135,24 @@ If `application_id` is not %NULL, then it must be valid. See If no application ID is given then some features (most notably application uniqueness) will be disabled. + - a new `GtkApplication` instance + a new `GtkApplication` instance - The application ID + The application ID - the application flags + the application flags + @@ -3988,6 +4166,7 @@ uniqueness) will be disabled. + @@ -4001,7 +4180,7 @@ uniqueness) will be disabled. - Adds a window to `application`. + Adds a window to `application`. This call can only happen after the `application` has started; typically, you should add new application windows in response @@ -4016,25 +4195,27 @@ remove it with [method@Gtk.Application.remove_window]. GTK will keep the `application` running as long as it has any windows. + - a `GtkApplication` + a `GtkApplication` - a `GtkWindow` + a `GtkWindow` - Gets the accelerators that are currently associated with + Gets the accelerators that are currently associated with the given action. + - + accelerators for `detailed_action_name` @@ -4042,18 +4223,18 @@ the given action. - a `GtkApplication` + a `GtkApplication` - a detailed action name, specifying an action + a detailed action name, specifying an action and target to obtain accelerators for - Returns the list of actions (possibly empty) that `accel` maps to. + Returns the list of actions (possibly empty) that `accel` maps to. Each item in the list is a detailed action name in the usual form. @@ -4070,100 +4251,105 @@ is returned. `NULL` is never returned. It is a programmer error to pass an invalid accelerator string. If you are unsure, check it with [func@Gtk.accelerator_parse] first. + - a %NULL-terminated array of actions for `accel` + a %NULL-terminated array of actions for `accel` - a `GtkApplication` + a `GtkApplication` - an accelerator that can be parsed by [func@Gtk.accelerator_parse] + an accelerator that can be parsed by [func@Gtk.accelerator_parse] - Gets the “active” window for the application. + Gets the “active” window for the application. The active window is the one that was most recently focused (within the application). This window may not have the focus at the moment if another application has it — this is just the most recently-focused window within this application. + - the active window + the active window - a `GtkApplication` + a `GtkApplication` - Gets a menu from automatically loaded resources. + Gets a menu from automatically loaded resources. See [the section on Automatic resources](class.Application.html#automatic-resources) for more information. + - Gets the menu with the + Gets the menu with the given id from the automatically loaded resources - a `GtkApplication` + a `GtkApplication` - the id of the menu to look up + the id of the menu to look up - Returns the menu model that has been set with + Returns the menu model that has been set with [method@Gtk.Application.set_menubar]. + - the menubar for windows of `application` + the menubar for windows of `application` - a `GtkApplication` + a `GtkApplication` - Returns the [class@Gtk.ApplicationWindow] with the given ID. + Returns the [class@Gtk.ApplicationWindow] with the given ID. The ID of a `GtkApplicationWindow` can be retrieved with [method@Gtk.ApplicationWindow.get_id]. + - the window for the given `id` + the window for the given `id` - a `GtkApplication` + a `GtkApplication` - an identifier number + an identifier number - Gets a list of the [class@Gtk.Window] instances associated with `application`. + Gets a list of the [class@Gtk.Window] instances associated with `application`. The list is sorted by most recently focused window, such that the first element is the currently focused window. (Useful for choosing a parent @@ -4172,8 +4358,9 @@ for a transient window.) The list that is returned should not be modified in any way. It will only remain valid until the next focus change or window creation or deletion. + - a `GList` of `GtkWindow` + a `GList` of `GtkWindow` instances @@ -4181,13 +4368,13 @@ deletion. - a `GtkApplication` + a `GtkApplication` - Inform the session manager that certain types of actions should be + Inform the session manager that certain types of actions should be inhibited. This is not guaranteed to work on all platforms and for all types of @@ -4210,8 +4397,9 @@ The `reason` message should be short and to the point. If `window` is given, the session manager may point the user to this window to find out more about why the action is inhibited. + - A non-zero cookie that is used to uniquely identify this + A non-zero cookie that is used to uniquely identify this request. It should be used as an argument to [method@Gtk.Application.uninhibit] in order to remove the request. If the platform does not support inhibiting or the request failed for some reason, 0 is returned. @@ -4219,43 +4407,44 @@ this window to find out more about why the action is inhibited. - the `GtkApplication` + the `GtkApplication` - a `GtkWindow` + a `GtkWindow` - what types of actions should be inhibited + what types of actions should be inhibited - a short, human-readable string that explains + a short, human-readable string that explains why these operations are inhibited - Lists the detailed action names which have associated accelerators. + Lists the detailed action names which have associated accelerators. See [method@Gtk.Application.set_accels_for_action]. + - the detailed action names + the detailed action names - a `GtkApplication` + a `GtkApplication` - Remove a window from `application`. + Remove a window from `application`. If `window` belongs to `application` then this call is equivalent to setting the [property@Gtk.Window:application] property of `window` to @@ -4263,22 +4452,23 @@ setting the [property@Gtk.Window:application] property of `window` to The application may stop running as a result of a call to this function, if `window` was the last window of the `application`. + - a `GtkApplication` + a `GtkApplication` - a `GtkWindow` + a `GtkWindow` - Sets zero or more keyboard accelerators that will trigger the + Sets zero or more keyboard accelerators that will trigger the given action. The first item in `accels` will be the primary accelerator, which may be @@ -4289,21 +4479,22 @@ array for `accels`. For the `detailed_action_name`, see `g_action_parse_detailed_name()` and `g_action_print_detailed_name()`. + - a `GtkApplication` + a `GtkApplication` - a detailed action name, specifying an action + a detailed action name, specifying an action and target to associate accelerators with - a list of accelerators in the format + a list of accelerators in the format understood by [func@Gtk.accelerator_parse] @@ -4313,7 +4504,7 @@ For the `detailed_action_name`, see `g_action_parse_detailed_name()` and - Sets or unsets the menubar for windows of `application`. + Sets or unsets the menubar for windows of `application`. This is a menubar in the traditional sense. @@ -4331,60 +4522,62 @@ menubar (if set) remains in each individual window. Use the base `GActionMap` interface to add actions, to respond to the user selecting these menu items. + - a `GtkApplication` + a `GtkApplication` - a `GMenuModel` + a `GMenuModel` - Removes an inhibitor that has been previously established. + Removes an inhibitor that has been previously established. See [method@Gtk.Application.inhibit]. Inhibitors are also cleared when the application exits. + - the `GtkApplication` + the `GtkApplication` - a cookie that was returned by [method@Gtk.Application.inhibit] + a cookie that was returned by [method@Gtk.Application.inhibit] - The currently focused window of the application. + The currently focused window of the application. - The `GMenuModel` to be used for the application's menu bar. + The `GMenuModel` to be used for the application's menu bar. - Set this property to `TRUE` to register with the session manager. + Set this property to `TRUE` to register with the session manager. This will make GTK track the session state (such as the [property@Gtk.Application:screensaver-active] property). - This property is `TRUE` if GTK believes that the screensaver is + This property is `TRUE` if GTK believes that the screensaver is currently active. GTK only tracks session state (including this) when @@ -4398,7 +4591,7 @@ Linux. - Emitted when the session manager is about to end the session. + Emitted when the session manager is about to end the session. This signal is only emitted if [property@Gtk.Application:register-session] is `TRUE`. Applications can connect to this signal and call @@ -4409,20 +4602,20 @@ to delay the end of the session until state has been saved. - Emitted when a [class@Gtk.Window] is added to `application` through + Emitted when a [class@Gtk.Window] is added to `application` through [method@Gtk.Application.add_window]. - the newly-added [class@Gtk.Window] + the newly-added [class@Gtk.Window] - Emitted when a [class@Gtk.Window] is removed from `application`. + Emitted when a [class@Gtk.Window] is removed from `application`. This can happen as a side-effect of the window being destroyed or explicitly through [method@Gtk.Application.remove_window]. @@ -4431,19 +4624,21 @@ or explicitly through [method@Gtk.Application.remove_window]. - the [class@Gtk.Window] that is being removed + the [class@Gtk.Window] that is being removed + - The parent class. + The parent class. + @@ -4459,6 +4654,7 @@ or explicitly through [method@Gtk.Application.remove_window]. + @@ -4479,27 +4675,27 @@ or explicitly through [method@Gtk.Application.remove_window]. - Types of user actions that may be blocked by `GtkApplication`. + Types of user actions that may be blocked by `GtkApplication`. See [method@Gtk.Application.inhibit]. - Inhibit ending the user session + Inhibit ending the user session by logging out or by shutting down the computer - Inhibit user switching + Inhibit user switching - Inhibit suspending the + Inhibit suspending the session or computer - Inhibit the session being + Inhibit the session being marked as idle (and possibly locked) - `GtkApplicationWindow` is a `GtkWindow` subclass that integrates with + `GtkApplicationWindow` is a `GtkWindow` subclass that integrates with `GtkApplication`. Notably, `GtkApplicationWindow` can handle an application menubar. @@ -4570,6 +4766,7 @@ g_object_unref (builder); GtkWidget *window = gtk_application_window_new (app); ``` + @@ -4579,100 +4776,106 @@ GtkWidget *window = gtk_application_window_new (app); - Creates a new `GtkApplicationWindow`. + Creates a new `GtkApplicationWindow`. + - a newly created `GtkApplicationWindow` + a newly created `GtkApplicationWindow` - a `GtkApplication` + a `GtkApplication` - Gets the `GtkShortcutsWindow` that is associated with @window. + Gets the `GtkShortcutsWindow` that is associated with @window. See [method@Gtk.ApplicationWindow.set_help_overlay]. + - the help overlay associated + the help overlay associated with @window - a `GtkApplicationWindow` + a `GtkApplicationWindow` - Returns the unique ID of the window. + Returns the unique ID of the window. If the window has not yet been added to a `GtkApplication`, returns `0`. + - the unique ID for @window, or `0` if the window + the unique ID for @window, or `0` if the window has not yet been added to a `GtkApplication` - a `GtkApplicationWindow` + a `GtkApplicationWindow` - Returns whether the window will display a menubar for the app menu + Returns whether the window will display a menubar for the app menu and menubar as needed. + - %TRUE if @window will display a menubar when needed + %TRUE if @window will display a menubar when needed - a `GtkApplicationWindow` + a `GtkApplicationWindow` - Associates a shortcuts window with the application window. + Associates a shortcuts window with the application window. Additionally, sets up an action with the name `win.show-help-overlay` to present it. @window takes responsibility for destroying @help_overlay. + - a `GtkApplicationWindow` + a `GtkApplicationWindow` - a `GtkShortcutsWindow` + a `GtkShortcutsWindow` - Sets whether the window will display a menubar for the app menu + Sets whether the window will display a menubar for the app menu and menubar as needed. + - a `GtkApplicationWindow` + a `GtkApplicationWindow` - whether to show a menubar when needed + whether to show a menubar when needed @@ -4680,7 +4883,7 @@ and menubar as needed. - If this property is %TRUE, the window will display a menubar + If this property is %TRUE, the window will display a menubar unless it is shown by the desktop shell. See [method@Gtk.Application.set_menubar]. @@ -4694,8 +4897,9 @@ of whether the desktop shell is showing it or not. + - The parent class. + The parent class. @@ -4705,25 +4909,25 @@ of whether the desktop shell is showing it or not. - Used to indicate the direction in which an arrow should point. + Used to indicate the direction in which an arrow should point. - Represents an upward pointing arrow. + Represents an upward pointing arrow. - Represents a downward pointing arrow. + Represents a downward pointing arrow. - Represents a left pointing arrow. + Represents a left pointing arrow. - Represents a right pointing arrow. + Represents a right pointing arrow. - No arrow. + No arrow. - `GtkAspectFrame` preserves the aspect ratio of its child. + `GtkAspectFrame` preserves the aspect ratio of its child. The frame can respect the aspect ratio of the child widget, or use its own aspect ratio. @@ -4735,28 +4939,29 @@ or use its own aspect ratio. - Create a new `GtkAspectFrame`. + Create a new `GtkAspectFrame`. + - the new `GtkAspectFrame`. + the new `GtkAspectFrame`. - Horizontal alignment of the child within the parent. + Horizontal alignment of the child within the parent. Ranges from 0.0 (left aligned) to 1.0 (right aligned) - Vertical alignment of the child within the parent. + Vertical alignment of the child within the parent. Ranges from 0.0 (top aligned) to 1.0 (bottom aligned) - The desired aspect ratio. + The desired aspect ratio. - If %TRUE, @ratio is ignored, and the aspect + If %TRUE, @ratio is ignored, and the aspect ratio is taken from the requistion of the child. @@ -4764,109 +4969,116 @@ or use its own aspect ratio. - Gets the child widget of @self. + Gets the child widget of @self. + - the child widget of self@ + the child widget of self@ - a `GtkAspectFrame` + a `GtkAspectFrame` - Returns whether the child's size request should override + Returns whether the child's size request should override the set aspect ratio of the `GtkAspectFrame`. + - whether to obey the child's size request + whether to obey the child's size request - a `GtkAspectFrame` + a `GtkAspectFrame` - Returns the desired aspect ratio of the child. + Returns the desired aspect ratio of the child. + - the desired aspect ratio + the desired aspect ratio - a `GtkAspectFrame` + a `GtkAspectFrame` - Returns the horizontal alignment of the child within the + Returns the horizontal alignment of the child within the allocation of the `GtkAspectFrame`. + - the horizontal alignment + the horizontal alignment - a `GtkAspectFrame` + a `GtkAspectFrame` - Returns the vertical alignment of the child within the + Returns the vertical alignment of the child within the allocation of the `GtkAspectFrame`. + - the vertical alignment + the vertical alignment - a `GtkAspectFrame` + a `GtkAspectFrame` - Sets the child widget of @self. + Sets the child widget of @self. + - a `GtkAspectFrame` + a `GtkAspectFrame` - the child widget + the child widget - Sets whether the aspect ratio of the child's size + Sets whether the aspect ratio of the child's size request should override the set aspect ratio of the `GtkAspectFrame`. + - a `GtkAspectFrame` + a `GtkAspectFrame` - If %TRUE, @ratio is ignored, and the aspect + If %TRUE, @ratio is ignored, and the aspect ratio is taken from the requistion of the child. @@ -4874,53 +5086,56 @@ the `GtkAspectFrame`. - Sets the desired aspect ratio of the child. + Sets the desired aspect ratio of the child. + - a `GtkAspectFrame` + a `GtkAspectFrame` - aspect ratio of the child + aspect ratio of the child - Sets the horizontal alignment of the child within the allocation + Sets the horizontal alignment of the child within the allocation of the `GtkAspectFrame`. + - a `GtkAspectFrame` + a `GtkAspectFrame` - horizontal alignment, from 0.0 (left aligned) to 1.0 (right aligned) + horizontal alignment, from 0.0 (left aligned) to 1.0 (right aligned) - Sets the vertical alignment of the child within the allocation + Sets the vertical alignment of the child within the allocation of the `GtkAspectFrame`. + - a `GtkAspectFrame` + a `GtkAspectFrame` - horizontal alignment, from 0.0 (top aligned) to 1.0 (bottom aligned) + horizontal alignment, from 0.0 (top aligned) to 1.0 (bottom aligned) @@ -4928,19 +5143,19 @@ of the `GtkAspectFrame`. - The child widget. + The child widget. - Whether the `GtkAspectFrame` should use the aspect ratio of its child. + Whether the `GtkAspectFrame` should use the aspect ratio of its child. - The aspect ratio to be used by the `GtkAspectFrame`. + The aspect ratio to be used by the `GtkAspectFrame`. This property is only used if [property@Gtk.AspectFrame:obey-child] is set to %FALSE. @@ -4949,18 +5164,18 @@ This property is only used if - The horizontal alignment of the child. + The horizontal alignment of the child. - The vertical alignment of the child. + The vertical alignment of the child. - `GtkAssistant` is used to represent a complex as a series of steps. + `GtkAssistant` is used to represent a complex as a series of steps. ![An example GtkAssistant](assistant.png) @@ -5003,47 +5218,50 @@ class .assistant. - Creates a new `GtkAssistant`. + Creates a new `GtkAssistant`. + - a newly created `GtkAssistant` + a newly created `GtkAssistant` - Adds a widget to the action area of a `GtkAssistant`. + Adds a widget to the action area of a `GtkAssistant`. + - a `GtkAssistant` + a `GtkAssistant` - a `GtkWidget` + a `GtkWidget` - Appends a page to the @assistant. + Appends a page to the @assistant. + - the index (starting at 0) of the inserted page + the index (starting at 0) of the inserted page - a `GtkAssistant` + a `GtkAssistant` - a `GtkWidget` + a `GtkWidget` - Erases the visited page history. + Erases the visited page history. GTK will then hide the back button on the current page, and removes the cancel button from subsequent pages. @@ -5053,269 +5271,285 @@ page is hereafter deemed permanent and cannot be modified or undone. For example, showing a progress page to track a long-running, unreversible operation after the user has clicked apply on a confirmation page. + - a `GtkAssistant` + a `GtkAssistant` - Returns the page number of the current page. + Returns the page number of the current page. + - The index (starting from 0) of the current + The index (starting from 0) of the current page in the @assistant, or -1 if the @assistant has no pages, or no current page - a `GtkAssistant` + a `GtkAssistant` - Returns the number of pages in the @assistant + Returns the number of pages in the @assistant + - the number of pages in the @assistant + the number of pages in the @assistant - a `GtkAssistant` + a `GtkAssistant` - Returns the child widget contained in page number @page_num. + Returns the child widget contained in page number @page_num. + - the child widget, or %NULL + the child widget, or %NULL if @page_num is out of bounds - a `GtkAssistant` + a `GtkAssistant` - the index of a page in the @assistant, + the index of a page in the @assistant, or -1 to get the last page - Returns the `GtkAssistantPage` object for @child. + Returns the `GtkAssistantPage` object for @child. + - the `GtkAssistantPage` for @child + the `GtkAssistantPage` for @child - a `GtkAssistant` + a `GtkAssistant` - a child of @assistant + a child of @assistant - Gets whether @page is complete. + Gets whether @page is complete. + - %TRUE if @page is complete. + %TRUE if @page is complete. - a `GtkAssistant` + a `GtkAssistant` - a page of @assistant + a page of @assistant - Gets the title for @page. + Gets the title for @page. + - the title for @page + the title for @page - a `GtkAssistant` + a `GtkAssistant` - a page of @assistant + a page of @assistant - Gets the page type of @page. + Gets the page type of @page. + - the page type of @page + the page type of @page - a `GtkAssistant` + a `GtkAssistant` - a page of @assistant + a page of @assistant - Gets a list model of the assistant pages. + Gets a list model of the assistant pages. + - A list model of the pages. + A list model of the pages. - a `GtkAssistant` + a `GtkAssistant` - Inserts a page in the @assistant at a given position. + Inserts a page in the @assistant at a given position. + - the index (starting from 0) of the inserted page + the index (starting from 0) of the inserted page - a `GtkAssistant` + a `GtkAssistant` - a `GtkWidget` + a `GtkWidget` - the index (starting at 0) at which to insert the page, + the index (starting at 0) at which to insert the page, or -1 to append the page to the @assistant - Navigate to the next page. + Navigate to the next page. It is a programming error to call this function when there is no next page. This function is for use when creating pages of the %GTK_ASSISTANT_PAGE_CUSTOM type. + - a `GtkAssistant` + a `GtkAssistant` - Prepends a page to the @assistant. + Prepends a page to the @assistant. + - the index (starting at 0) of the inserted page + the index (starting at 0) of the inserted page - a `GtkAssistant` + a `GtkAssistant` - a `GtkWidget` + a `GtkWidget` - Navigate to the previous visited page. + Navigate to the previous visited page. It is a programming error to call this function when no previous page is available. This function is for use when creating pages of the %GTK_ASSISTANT_PAGE_CUSTOM type. + - a `GtkAssistant` + a `GtkAssistant` - Removes a widget from the action area of a `GtkAssistant`. + Removes a widget from the action area of a `GtkAssistant`. + - a `GtkAssistant` + a `GtkAssistant` - a `GtkWidget` + a `GtkWidget` - Removes the @page_num’s page from @assistant. + Removes the @page_num’s page from @assistant. + - a `GtkAssistant` + a `GtkAssistant` - the index of a page in the @assistant, + the index of a page in the @assistant, or -1 to remove the last page - Switches the page to @page_num. + Switches the page to @page_num. Note that this will only be necessary in custom buttons, as the @assistant flow can be set with gtk_assistant_set_forward_page_func(). + - a `GtkAssistant` + a `GtkAssistant` - index of the page to switch to, starting from 0. + index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the @assistant, nothing will be done. @@ -5324,106 +5558,110 @@ gtk_assistant_set_forward_page_func(). - Sets the page forwarding function to be @page_func. + Sets the page forwarding function to be @page_func. This function will be used to determine what will be the next page when the user presses the forward button. Setting @page_func to %NULL will make the assistant to use the default forward function, which just goes to the next visible page. + - a `GtkAssistant` + a `GtkAssistant` - the `GtkAssistantPageFunc`, or %NULL + the `GtkAssistantPageFunc`, or %NULL to use the default one - user data for @page_func + user data for @page_func - destroy notifier for @data + destroy notifier for @data - Sets whether @page contents are complete. + Sets whether @page contents are complete. This will make @assistant update the buttons state to be able to continue the task. + - a `GtkAssistant` + a `GtkAssistant` - a page of @assistant + a page of @assistant - the completeness status of the page + the completeness status of the page - Sets a title for @page. + Sets a title for @page. The title is displayed in the header area of the assistant when @page is the current page. + - a `GtkAssistant` + a `GtkAssistant` - a page of @assistant + a page of @assistant - the new title for @page + the new title for @page - Sets the page type for @page. + Sets the page type for @page. The page type determines the page behavior in the @assistant. + - a `GtkAssistant` + a `GtkAssistant` - a page of @assistant + a page of @assistant - the new type for @page + the new type for @page - Forces @assistant to recompute the buttons state. + Forces @assistant to recompute the buttons state. GTK automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the @@ -5432,22 +5670,23 @@ visibility or completeness of a page changes. One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant. + - a `GtkAssistant` + a `GtkAssistant` - `GListModel` containing the pages. + `GListModel` containing the pages. - %TRUE if the assistant uses a `GtkHeaderBar` for action buttons + %TRUE if the assistant uses a `GtkHeaderBar` for action buttons instead of the action-area. For technical reasons, this property is declared as an integer @@ -5455,7 +5694,7 @@ property, but you should only set it to %TRUE or %FALSE. - Emitted when the apply button is clicked. + Emitted when the apply button is clicked. The default behavior of the `GtkAssistant` is to switch to the page after the current page, unless the current page is the last one. @@ -5471,13 +5710,13 @@ the progress page. - Emitted when then the cancel button is clicked. + Emitted when then the cancel button is clicked. - Emitted either when the close button of a summary page is clicked, + Emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type %GTK_ASSISTANT_PAGE_CONFIRM) is clicked. @@ -5485,13 +5724,13 @@ or when the apply button in the last page in the flow (of type - The action signal for the Escape binding. + The action signal for the Escape binding. - Emitted when a new page is set as the assistant's current page, + Emitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparations which are @@ -5501,71 +5740,73 @@ necessary before showing @page. - the current page + the current page - `GtkAssistantPage` is an auxiliary object used by `GtkAssistant. + `GtkAssistantPage` is an auxiliary object used by `GtkAssistant. - Returns the child to which @page belongs. + Returns the child to which @page belongs. + - the child to which @page belongs + the child to which @page belongs - a `GtkAssistantPage` + a `GtkAssistantPage` - The child widget. + The child widget. - Whether all required fields are filled in. + Whether all required fields are filled in. GTK uses this information to control the sensitivity of the navigation buttons. - The type of the assistant page. + The type of the assistant page. - The title of the page. + The title of the page. - Type of callback used to calculate the next page in a `GtkAssistant`. + Type of callback used to calculate the next page in a `GtkAssistant`. It’s called both for computing the next page when the user presses the “forward” button and for handling the behavior of the “last” button. See [method@Gtk.Assistant.set_forward_page_func]. + - The next page number + The next page number - The page number used to calculate the next page. + The page number used to calculate the next page. - user data. + user data. - Determines the page role inside a `GtkAssistant`. + Determines the page role inside a `GtkAssistant`. The role is used to handle buttons sensitivity and visibility. @@ -5576,137 +5817,153 @@ Note that an assistant needs to end its page flow with a page of type The Cancel button will only be shown if the page isn’t “committed”. See gtk_assistant_commit() for details. - The page has regular contents. Both the + The page has regular contents. Both the Back and forward buttons will be shown. - The page contains an introduction to the + The page contains an introduction to the assistant task. Only the Forward button will be shown if there is a next page. - The page lets the user confirm or deny the + The page lets the user confirm or deny the changes. The Back and Apply buttons will be shown. - The page informs the user of the changes + The page informs the user of the changes done. Only the Close button will be shown. - Used for tasks that take a long time to + Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete. Only the back button will be shown. - Used for when other page types are not + Used for when other page types are not appropriate. No buttons will be shown, and the application must add its own buttons through gtk_assistant_add_action_widget(). - Like gtk_get_binary_age(), but from the headers used at + Like gtk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. + + + + + + + + + + + + - This macro should be used to emit a warning about and unexpected @type value + This macro should be used to emit a warning about and unexpected @type value in a `GtkBuildable` add_child implementation. + - the `GtkBuildable` on which the warning occurred + the `GtkBuildable` on which the warning occurred - the unexpected type value + the unexpected type value + + + - Baseline position in a row of widgets. + Baseline position in a row of widgets. Whenever a container has some form of natural row it may align children in that row along a common typographical baseline. If @@ -5715,38 +5972,41 @@ requested height of the baseline-aligned children then it can use a `GtkBaselinePosition` to select where to put the baseline inside the extra available space. - Align the baseline at the top + Align the baseline at the top - Center the baseline + Center the baseline - Align the baseline at the bottom + Align the baseline at the bottom - `GtkBinLayout` is a `GtkLayoutManager` subclass useful for create "bins" of + `GtkBinLayout` is a `GtkLayoutManager` subclass useful for create "bins" of widgets. `GtkBinLayout` will stack each child of a widget on top of each other, using the [property@Gtk.Widget:hexpand], [property@Gtk.Widget:vexpand], [property@Gtk.Widget:halign], and [property@Gtk.Widget:valign] properties of each child to determine where they should be positioned. + - Creates a new `GtkBinLayout` instance. + Creates a new `GtkBinLayout` instance. + - the newly created `GtkBinLayout` + the newly created `GtkBinLayout` + - A `GtkBitset` represents a set of unsigned integers. + A `GtkBitset` represents a set of unsigned integers. Another name for this data structure is "bitmap". @@ -5761,152 +6021,161 @@ The fastest way to iterate values in a bitset is [struct@Gtk.BitsetIter]. The main use case for `GtkBitset` is implementing complex selections for [iface@Gtk.SelectionModel]. + - Creates a new empty bitset. + Creates a new empty bitset. + - A new empty bitset + A new empty bitset - Creates a bitset with the given range set. + Creates a bitset with the given range set. + - A new bitset + A new bitset - first value to add + first value to add - number of consecutive values to add + number of consecutive values to add - Adds @value to @self if it wasn't part of it before. + Adds @value to @self if it wasn't part of it before. + - %TRUE if @value was not part of @self and @self + %TRUE if @value was not part of @self and @self was changed - a `GtkBitset` + a `GtkBitset` - value to add + value to add - Adds all values from @start (inclusive) to @start + @n_items + Adds all values from @start (inclusive) to @start + @n_items (exclusive) in @self. + - a `GtkBitset` + a `GtkBitset` - first value to add + first value to add - number of consecutive values to add + number of consecutive values to add - Adds the closed range [@first, @last], so @first, @last and all + Adds the closed range [@first, @last], so @first, @last and all values in between. @first must be smaller than @last. + - a `GtkBitset` + a `GtkBitset` - first value to add + first value to add - last value to add + last value to add - Interprets the values as a 2-dimensional boolean grid with the given @stride + Interprets the values as a 2-dimensional boolean grid with the given @stride and inside that grid, adds a rectangle with the given @width and @height. + - a `GtkBitset` + a `GtkBitset` - first value to add + first value to add - width of the rectangle + width of the rectangle - height of the rectangle + height of the rectangle - row stride of the grid + row stride of the grid - Checks if the given @value has been added to @self + Checks if the given @value has been added to @self + - %TRUE if @self contains @value + %TRUE if @self contains @value - a `GtkBitset` + a `GtkBitset` - the value to check + the value to check - Creates a copy of @self. + Creates a copy of @self. + - A new bitset that contains the same + A new bitset that contains the same values as @self - a `GtkBitset` + a `GtkBitset` - Sets @self to be the symmetric difference of @self and @other. + Sets @self to be the symmetric difference of @self and @other. The symmetric difference is set @self to contain all values that were either contained in @self or in @other, but not in both. @@ -5914,88 +6183,93 @@ This operation is also called an XOR. It is allowed for @self and @other to be the same bitset. The bitset will be emptied in that case. + - a `GtkBitset` + a `GtkBitset` - the `GtkBitset` to compute the difference from + the `GtkBitset` to compute the difference from - Returns %TRUE if @self and @other contain the same values. + Returns %TRUE if @self and @other contain the same values. + - %TRUE if @self and @other contain the same values + %TRUE if @self and @other contain the same values - a `GtkBitset` + a `GtkBitset` - another `GtkBitset` + another `GtkBitset` - Returns the largest value in @self. + Returns the largest value in @self. If @self is empty, 0 is returned. + - The largest value in @self + The largest value in @self - a `GtkBitset` + a `GtkBitset` - Returns the smallest value in @self. + Returns the smallest value in @self. If @self is empty, `G_MAXUINT` is returned. + - The smallest value in @self + The smallest value in @self - a `GtkBitset` + a `GtkBitset` - Returns the value of the @nth item in self. + Returns the value of the @nth item in self. If @nth is >= the size of @self, 0 is returned. + - the value of the @nth item in @self + the value of the @nth item in @self - a `GtkBitset` + a `GtkBitset` - index of the item to get + index of the item to get - Gets the number of values that were added to the set. + Gets the number of values that were added to the set. For example, if the set is empty, 0 is returned. @@ -6003,229 +6277,241 @@ Note that this function returns a `guint64`, because when all values are set, the return value is `G_MAXUINT + 1`. Unless you are sure this cannot happen (it can't with `GListModel`), be sure to use a 64bit type. + - The number of values in the set. + The number of values in the set. - a `GtkBitset` + a `GtkBitset` - Gets the number of values that are part of the set from @first to @last + Gets the number of values that are part of the set from @first to @last (inclusive). Note that this function returns a `guint64`, because when all values are set, the return value is `G_MAXUINT + 1`. Unless you are sure this cannot happen (it can't with `GListModel`), be sure to use a 64bit type. + - The number of values in the set from @first to @last. + The number of values in the set from @first to @last. - a `GtkBitset` + a `GtkBitset` - the first element to include + the first element to include - the last element to include + the last element to include - Sets @self to be the intersection of @self and @other. + Sets @self to be the intersection of @self and @other. In other words, remove all values from @self that are not part of @other. It is allowed for @self and @other to be the same bitset. Nothing will happen in that case. + - a `GtkBitset` + a `GtkBitset` - the `GtkBitset` to intersect with + the `GtkBitset` to intersect with - Check if no value is contained in bitset. + Check if no value is contained in bitset. + - %TRUE if @self is empty + %TRUE if @self is empty - a `GtkBitset` + a `GtkBitset` - Acquires a reference on the given `GtkBitset`. + Acquires a reference on the given `GtkBitset`. + - the `GtkBitset` with an additional reference + the `GtkBitset` with an additional reference - a `GtkBitset` + a `GtkBitset` - Removes @value from @self if it was part of it before. + Removes @value from @self if it was part of it before. + - %TRUE if @value was part of @self and @self + %TRUE if @value was part of @self and @self was changed - a `GtkBitset` + a `GtkBitset` - value to add + value to add - Removes all values from the bitset so that it is empty again. + Removes all values from the bitset so that it is empty again. + - a `GtkBitset` + a `GtkBitset` - Removes all values from @start (inclusive) to @start + @n_items (exclusive) + Removes all values from @start (inclusive) to @start + @n_items (exclusive) in @self. + - a `GtkBitset` + a `GtkBitset` - first value to remove + first value to remove - number of consecutive values to remove + number of consecutive values to remove - Removes the closed range [@first, @last], so @first, @last and all + Removes the closed range [@first, @last], so @first, @last and all values in between. @first must be smaller than @last. + - a `GtkBitset` + a `GtkBitset` - first value to remove + first value to remove - last value to remove + last value to remove - Interprets the values as a 2-dimensional boolean grid with the given @stride + Interprets the values as a 2-dimensional boolean grid with the given @stride and inside that grid, removes a rectangle with the given @width and @height. + - a `GtkBitset` + a `GtkBitset` - first value to remove + first value to remove - width of the rectangle + width of the rectangle - height of the rectangle + height of the rectangle - row stride of the grid + row stride of the grid - Shifts all values in @self to the left by @amount. + Shifts all values in @self to the left by @amount. Values smaller than @amount are discarded. + - a `GtkBitset` + a `GtkBitset` - amount to shift all values to the left + amount to shift all values to the left - Shifts all values in @self to the right by @amount. + Shifts all values in @self to the right by @amount. Values that end up too large to be held in a #guint are discarded. + - a `GtkBitset` + a `GtkBitset` - amount to shift all values to the right + amount to shift all values to the right - This is a support function for `GListModel` handling, by mirroring + This is a support function for `GListModel` handling, by mirroring the `GlistModel::items-changed` signal. First, it "cuts" the values from @position to @removed from @@ -6235,246 +6521,258 @@ all larger values to the left by @removed places. Then, it "pastes" new room into the bitset by shifting all values larger than @position by @added spaces to the right. This frees up space that can then be filled. + - a `GtkBitset` + a `GtkBitset` - position at which to slice + position at which to slice - number of values to remove + number of values to remove - number of values to add + number of values to add - Sets @self to be the subtraction of @other from @self. + Sets @self to be the subtraction of @other from @self. In other words, remove all values from @self that are part of @other. It is allowed for @self and @other to be the same bitset. The bitset will be emptied in that case. + - a `GtkBitset` + a `GtkBitset` - the `GtkBitset` to subtract + the `GtkBitset` to subtract - Sets @self to be the union of @self and @other. + Sets @self to be the union of @self and @other. That is, add all values from @other into @self that weren't part of it. It is allowed for @self and @other to be the same bitset. Nothing will happen in that case. + - a `GtkBitset` + a `GtkBitset` - the `GtkBitset` to union with + the `GtkBitset` to union with - Releases a reference on the given `GtkBitset`. + Releases a reference on the given `GtkBitset`. If the reference was the last, the resources associated to the @self are freed. + - a `GtkBitset` + a `GtkBitset` - An opaque, stack-allocated struct for iterating + An opaque, stack-allocated struct for iterating over the elements of a `GtkBitset`. Before a `GtkBitsetIter` can be used, it needs to be initialized with [func@Gtk.BitsetIter.init_first], [func@Gtk.BitsetIter.init_last] or [func@Gtk.BitsetIter.init_at]. + - Gets the current value that @iter points to. + Gets the current value that @iter points to. If @iter is not valid and [method@Gtk.BitsetIter.is_valid] returns %FALSE, this function returns 0. + - The current value pointer to by @iter + The current value pointer to by @iter - a `GtkBitsetIter` + a `GtkBitsetIter` - Checks if @iter points to a valid value. + Checks if @iter points to a valid value. + - %TRUE if @iter points to a valid value + %TRUE if @iter points to a valid value - a `GtkBitsetIter` + a `GtkBitsetIter` - Moves @iter to the next value in the set. + Moves @iter to the next value in the set. If it was already pointing to the last value in the set, %FALSE is returned and @iter is invalidated. + - %TRUE if a next value existed + %TRUE if a next value existed - a pointer to a valid `GtkBitsetIter` + a pointer to a valid `GtkBitsetIter` - Set to the next value + Set to the next value - Moves @iter to the previous value in the set. + Moves @iter to the previous value in the set. If it was already pointing to the first value in the set, %FALSE is returned and @iter is invalidated. + - %TRUE if a previous value existed + %TRUE if a previous value existed - a pointer to a valid `GtkBitsetIter` + a pointer to a valid `GtkBitsetIter` - Set to the previous value + Set to the previous value - Initializes @iter to point to @target. + Initializes @iter to point to @target. If @target is not found, finds the next value after it. If no value >= @target exists in @set, this function returns %FALSE. + - %TRUE if a value was found. + %TRUE if a value was found. - a pointer to an uninitialized `GtkBitsetIter` + a pointer to an uninitialized `GtkBitsetIter` - a `GtkBitset` + a `GtkBitset` - target value to start iterating at + target value to start iterating at - Set to the found value in @set + Set to the found value in @set - Initializes an iterator for @set and points it to the first + Initializes an iterator for @set and points it to the first value in @set. If @set is empty, %FALSE is returned and @value is set to %G_MAXUINT. + - %TRUE if @set isn't empty. + %TRUE if @set isn't empty. - a pointer to an uninitialized `GtkBitsetIter` + a pointer to an uninitialized `GtkBitsetIter` - a `GtkBitset` + a `GtkBitset` - Set to the first value in @set + Set to the first value in @set - Initializes an iterator for @set and points it to the last + Initializes an iterator for @set and points it to the last value in @set. If @set is empty, %FALSE is returned. + - %TRUE if @set isn't empty. + %TRUE if @set isn't empty. - a pointer to an uninitialized `GtkBitsetIter` + a pointer to an uninitialized `GtkBitsetIter` - a `GtkBitset` + a `GtkBitset` - Set to the last value in @set + Set to the last value in @set - `GtkBookmarkList` is a list model that wraps `GBookmarkFile`. + `GtkBookmarkList` is a list model that wraps `GBookmarkFile`. It presents a `GListModel` and fills it asynchronously with the `GFileInfo`s returned from that function. @@ -6482,120 +6780,128 @@ It presents a `GListModel` and fills it asynchronously with the The `GFileInfo`s in the list have some attributes in the recent namespace added: `recent::private` (boolean) and `recent:applications` (stringv). + - Creates a new `GtkBookmarkList` with the given @attributes. + Creates a new `GtkBookmarkList` with the given @attributes. + - a new `GtkBookmarkList` + a new `GtkBookmarkList` - The bookmark file to load + The bookmark file to load - The attributes to query + The attributes to query - Gets the attributes queried on the children. + Gets the attributes queried on the children. + - The queried attributes + The queried attributes - a `GtkBookmarkList` + a `GtkBookmarkList` - Returns the filename of the bookmark file that + Returns the filename of the bookmark file that this list is loading. + - the filename of the .xbel file + the filename of the .xbel file - a `GtkBookmarkList` + a `GtkBookmarkList` - Gets the IO priority to use while loading file. + Gets the IO priority to use while loading file. + - The IO priority. + The IO priority. - a `GtkBookmarkList` + a `GtkBookmarkList` - Returns %TRUE if the files are currently being loaded. + Returns %TRUE if the files are currently being loaded. Files will be added to @self from time to time while loading is going on. The order in which are added is undefined and may change in between runs. + - %TRUE if @self is loading + %TRUE if @self is loading - a `GtkBookmarkList` + a `GtkBookmarkList` - Sets the @attributes to be enumerated and starts the enumeration. + Sets the @attributes to be enumerated and starts the enumeration. If @attributes is %NULL, no attributes will be queried, but a list of `GFileInfo`s will still be created. + - a `GtkBookmarkList` + a `GtkBookmarkList` - the attributes to enumerate + the attributes to enumerate - Sets the IO priority to use while loading files. + Sets the IO priority to use while loading files. The default IO priority is %G_PRIORITY_DEFAULT. + - a `GtkBookmarkList` + a `GtkBookmarkList` - IO priority to use + IO priority to use @@ -6603,109 +6909,116 @@ The default IO priority is %G_PRIORITY_DEFAULT. - The attributes to query. + The attributes to query. - The bookmark file to load. + The bookmark file to load. - Priority used when loading. + Priority used when loading. - %TRUE if files are being loaded. + %TRUE if files are being loaded. + - `GtkBoolFilter` evaluates a boolean `GtkExpression` + `GtkBoolFilter` evaluates a boolean `GtkExpression` to determine whether to include items. + - Creates a new bool filter. + Creates a new bool filter. + - a new `GtkBoolFilter` + a new `GtkBoolFilter` - The expression to evaluate + The expression to evaluate - Gets the expression that the filter uses to evaluate if + Gets the expression that the filter uses to evaluate if an item should be filtered. + - a `GtkExpression` + a `GtkExpression` - a `GtkBoolFilter` + a `GtkBoolFilter` - Returns whether the filter inverts the expression. + Returns whether the filter inverts the expression. + - %TRUE if the filter inverts + %TRUE if the filter inverts - a `GtkBoolFilter` + a `GtkBoolFilter` - Sets the expression that the filter uses to check if items + Sets the expression that the filter uses to check if items should be filtered. The expression must have a value type of %G_TYPE_BOOLEAN. + - a `GtkBoolFilter` + a `GtkBoolFilter` - a `GtkExpression` + a `GtkExpression` - Sets whether the filter should invert the expression. + Sets whether the filter should invert the expression. + - a `GtkBoolFilter` + a `GtkBoolFilter` - %TRUE to invert + %TRUE to invert @@ -6713,110 +7026,115 @@ The expression must have a value type of %G_TYPE_BOOLEAN. - The boolean expression to evaluate on item. + The boolean expression to evaluate on item. - If the expression result should be inverted. + If the expression result should be inverted. + - A struct that specifies a border around a rectangular area. + A struct that specifies a border around a rectangular area. Each side can have different width. + - The width of the left border + The width of the left border - The width of the right border + The width of the right border - The width of the top border + The width of the top border - The width of the bottom border + The width of the bottom border - Allocates a new `GtkBorder` struct and initializes its elements to zero. + Allocates a new `GtkBorder` struct and initializes its elements to zero. + - a newly allocated `GtkBorder` struct. + a newly allocated `GtkBorder` struct. Free with [method@Gtk.Border.free] - Copies a `GtkBorder`. + Copies a `GtkBorder`. + - a copy of @border_. + a copy of @border_. - a `GtkBorder` struct + a `GtkBorder` struct - Frees a `GtkBorder`. + Frees a `GtkBorder`. + - a `GtkBorder` struct + a `GtkBorder` struct - Describes how the border of a UI element should be rendered. + Describes how the border of a UI element should be rendered. - No visible border + No visible border - Same as %GTK_BORDER_STYLE_NONE + Same as %GTK_BORDER_STYLE_NONE - A single line segment + A single line segment - Looks as if the content is sunken into the canvas + Looks as if the content is sunken into the canvas - Looks as if the content is coming out of the canvas + Looks as if the content is coming out of the canvas - A series of round dots + A series of round dots - A series of square-ended dashes + A series of square-ended dashes - Two parallel lines with some space between them + Two parallel lines with some space between them - Looks as if it were carved in the canvas + Looks as if it were carved in the canvas - Looks as if it were coming out of the canvas + Looks as if it were coming out of the canvas - The `GtkBox` widget arranges child widgets into a single row or column. + The `GtkBox` widget arranges child widgets into a single row or column. ![An example GtkBox](box.png) @@ -6848,205 +7166,217 @@ place in the box. # Accessibility `GtkBox` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. + - Creates a new `GtkBox`. + Creates a new `GtkBox`. + - a new `GtkBox`. + a new `GtkBox`. - the box’s orientation + the box’s orientation - the number of pixels to place by default between children + the number of pixels to place by default between children - Adds @child as the last child to @box. + Adds @child as the last child to @box. + - a `GtkBox` + a `GtkBox` - the `GtkWidget` to append + the `GtkWidget` to append - Gets the value set by gtk_box_set_baseline_position(). + Gets the value set by gtk_box_set_baseline_position(). + - the baseline position + the baseline position - a `GtkBox` + a `GtkBox` - Returns whether the box is homogeneous (all children are the + Returns whether the box is homogeneous (all children are the same size). + - %TRUE if the box is homogeneous. + %TRUE if the box is homogeneous. - a `GtkBox` + a `GtkBox` - Gets the value set by gtk_box_set_spacing(). + Gets the value set by gtk_box_set_spacing(). + - spacing between children + spacing between children - a `GtkBox` + a `GtkBox` - Inserts @child in the position after @sibling in the list + Inserts @child in the position after @sibling in the list of @box children. If @sibling is %NULL, insert @child at the first position. + - a `GtkBox` + a `GtkBox` - the `GtkWidget` to insert + the `GtkWidget` to insert - the sibling after which to insert @child + the sibling after which to insert @child - Adds @child as the first child to @box. + Adds @child as the first child to @box. + - a `GtkBox` + a `GtkBox` - the `GtkWidget` to prepend + the `GtkWidget` to prepend - Removes a child widget from @box. + Removes a child widget from @box. The child must have been added before with [method@Gtk.Box.append], [method@Gtk.Box.prepend], or [method@Gtk.Box.insert_child_after]. + - a `GtkBox` + a `GtkBox` - the child to remove + the child to remove - Moves @child to the position after @sibling in the list + Moves @child to the position after @sibling in the list of @box children. If @sibling is %NULL, move @child to the first position. + - a `GtkBox` + a `GtkBox` - the `GtkWidget` to move, must be a child of @box + the `GtkWidget` to move, must be a child of @box - the sibling to move @child after + the sibling to move @child after - Sets the baseline position of a box. + Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then @position is used to allocate the baseline with respect to the extra space available. + - a `GtkBox` + a `GtkBox` - a `GtkBaselinePosition` + a `GtkBaselinePosition` - Sets whether or not all children of @box are given equal space + Sets whether or not all children of @box are given equal space in the box. + - a `GtkBox` + a `GtkBox` - a boolean value, %TRUE to create equal allotments, + a boolean value, %TRUE to create equal allotments, %FALSE for variable allotments @@ -7054,17 +7384,18 @@ in the box. - Sets the number of pixels to place between children of @box. + Sets the number of pixels to place between children of @box. + - a `GtkBox` + a `GtkBox` - the number of pixels to put between children + the number of pixels to put between children @@ -7072,19 +7403,19 @@ in the box. - The position of the baseline aligned widgets if extra space is available. + The position of the baseline aligned widgets if extra space is available. - Whether the children should all be the same size. + Whether the children should all be the same size. - The amount of space between children. + The amount of space between children. @@ -7092,8 +7423,9 @@ in the box. + - The parent class. + The parent class. @@ -7103,7 +7435,7 @@ in the box. - `GtkBoxLayout` is a layout manager that arranges children in a single + `GtkBoxLayout` is a layout manager that arranges children in a single row or column. Whether it is a row or column depends on the value of its @@ -7117,116 +7449,124 @@ the [property@Gtk.BoxLayout:homogeneous] property. If you want to specify the amount of space placed between each child, you can use the [property@Gtk.BoxLayout:spacing] property. + - Creates a new `GtkBoxLayout`. + Creates a new `GtkBoxLayout`. + - a new box layout + a new box layout - the orientation for the new layout + the orientation for the new layout - Gets the value set by gtk_box_layout_set_baseline_position(). + Gets the value set by gtk_box_layout_set_baseline_position(). + - the baseline position + the baseline position - a `GtkBoxLayout` + a `GtkBoxLayout` - Returns whether the layout is set to be homogeneous. + Returns whether the layout is set to be homogeneous. + - %TRUE if the layout is homogeneous + %TRUE if the layout is homogeneous - a `GtkBoxLayout` + a `GtkBoxLayout` - Returns the space that @box_layout puts between children. + Returns the space that @box_layout puts between children. + - the spacing of the layout + the spacing of the layout - a `GtkBoxLayout` + a `GtkBoxLayout` - Sets the baseline position of a box layout. + Sets the baseline position of a box layout. The baseline position affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then the given @position is used to allocate the baseline within the extra space available. + - a `GtkBoxLayout` + a `GtkBoxLayout` - a `GtkBaselinePosition` + a `GtkBaselinePosition` - Sets whether the box layout will allocate the same + Sets whether the box layout will allocate the same size to all children. + - a `GtkBoxLayout` + a `GtkBoxLayout` - %TRUE to set the box layout as homogeneous + %TRUE to set the box layout as homogeneous - Sets how much spacing to put between children. + Sets how much spacing to put between children. + - a `GtkBoxLayout` + a `GtkBoxLayout` - the spacing to apply between children + the spacing to apply between children @@ -7234,7 +7574,7 @@ size to all children. - The position of the allocated baseline within the extra space + The position of the allocated baseline within the extra space allocated to each child. This property is only relevant for horizontal layouts containing @@ -7244,24 +7584,25 @@ at least one child with a baseline alignment. - Whether the box layout should distribute the available space + Whether the box layout should distribute the available space equally among the children. - The space to put between the children. + The space to put between the children. + - `GtkBuildable` allows objects to extend and customize their deserialization + `GtkBuildable` allows objects to extend and customize their deserialization from ui files. The interface includes methods for setting names and properties of objects, @@ -7274,32 +7615,35 @@ very little need for applications to call any of these functions directly. An object only needs to implement this interface if it needs to extend the `GtkBuilder` XML format or run any extra routines at deserialization time. + - Adds a child to @buildable. @type is an optional string + Adds a child to @buildable. @type is an optional string describing how the child should be added. + - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` + a `GtkBuilder` - child to add + child to add - kind of child or %NULL + kind of child or %NULL + @@ -7316,99 +7660,103 @@ describing how the child should be added. - Similar to gtk_buildable_parser_finished() but is + Similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the @buildable. + - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` + a `GtkBuilder` - child object or %NULL for non-child tags + child object or %NULL for non-child tags - the name of the tag + the name of the tag - user data created in custom_tag_start + user data created in custom_tag_start - Called at the end of each custom element handled by + Called at the end of each custom element handled by the buildable. + - A `GtkBuildable` + A `GtkBuildable` - `GtkBuilder` used to construct this object + `GtkBuilder` used to construct this object - child object or %NULL for non-child tags + child object or %NULL for non-child tags - name of tag + name of tag - user data that will be passed in to parser functions + user data that will be passed in to parser functions - Called for each unknown element under `<child>`. + Called for each unknown element under `<child>`. + - %TRUE if an object has a custom implementation, %FALSE + %TRUE if an object has a custom implementation, %FALSE if it doesn't. - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` used to construct this object + a `GtkBuilder` used to construct this object - child object or %NULL for non-child tags + child object or %NULL for non-child tags - name of tag + name of tag - a `GtkBuildableParser` to fill in + a `GtkBuildableParser` to fill in - return location for user data that will be passed in + return location for user data that will be passed in to parser functions + @@ -7419,27 +7767,29 @@ the buildable. - Retrieves the internal child called @childname of the @buildable object. + Retrieves the internal child called @childname of the @buildable object. + - the internal child of the buildable object + the internal child of the buildable object - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` + a `GtkBuilder` - name of child + name of child + @@ -7453,6 +7803,7 @@ the buildable. + @@ -7472,6 +7823,7 @@ the buildable. + @@ -7485,32 +7837,35 @@ the buildable. - Gets the ID of the @buildable object. + Gets the ID of the @buildable object. `GtkBuilder` sets the name based on the ID attribute of the <object> tag used to construct the @buildable. + - the ID of the buildable object + the ID of the buildable object - a `GtkBuildable` + a `GtkBuildable` - The `GtkBuildableIface` interface contains methods that are + The `GtkBuildableIface` interface contains methods that are necessary to allow `GtkBuilder` to construct an object from a `GtkBuilder` UI definition. + - the parent class + the parent class + @@ -7526,6 +7881,7 @@ a `GtkBuilder` UI definition. + @@ -7538,24 +7894,25 @@ a `GtkBuilder` UI definition. + - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` + a `GtkBuilder` - child to add + child to add - kind of child or %NULL + kind of child or %NULL @@ -7563,6 +7920,7 @@ a `GtkBuilder` UI definition. + @@ -7584,6 +7942,7 @@ a `GtkBuilder` UI definition. + @@ -7602,34 +7961,35 @@ a `GtkBuilder` UI definition. + - %TRUE if an object has a custom implementation, %FALSE + %TRUE if an object has a custom implementation, %FALSE if it doesn't. - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` used to construct this object + a `GtkBuilder` used to construct this object - child object or %NULL for non-child tags + child object or %NULL for non-child tags - name of tag + name of tag - a `GtkBuildableParser` to fill in + a `GtkBuildableParser` to fill in - return location for user data that will be passed in + return location for user data that will be passed in to parser functions @@ -7638,28 +7998,29 @@ a `GtkBuilder` UI definition. + - A `GtkBuildable` + A `GtkBuildable` - `GtkBuilder` used to construct this object + `GtkBuilder` used to construct this object - child object or %NULL for non-child tags + child object or %NULL for non-child tags - name of tag + name of tag - user data that will be passed in to parser functions + user data that will be passed in to parser functions @@ -7667,28 +8028,29 @@ a `GtkBuilder` UI definition. + - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` + a `GtkBuilder` - child object or %NULL for non-child tags + child object or %NULL for non-child tags - the name of the tag + the name of the tag - user data created in custom_tag_start + user data created in custom_tag_start @@ -7696,6 +8058,7 @@ a `GtkBuilder` UI definition. + @@ -7711,21 +8074,22 @@ a `GtkBuilder` UI definition. + - the internal child of the buildable object + the internal child of the buildable object - a `GtkBuildable` + a `GtkBuildable` - a `GtkBuilder` + a `GtkBuilder` - name of child + name of child @@ -7733,26 +8097,28 @@ a `GtkBuilder` UI definition. - An opaque context struct for `GtkBuildableParser`. + An opaque context struct for `GtkBuildableParser`. + - Retrieves the name of the currently open element. + Retrieves the name of the currently open element. If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see gtk_buildable_parse_context_get_element_stack(). + - the name of the currently open element + the name of the currently open element - a `GtkBuildablParseContext` + a `GtkBuildablParseContext` - Retrieves the element stack from the internal state of the parser. + Retrieves the element stack from the internal state of the parser. The returned `GPtrArray` is an array of strings where the last item is the currently open tag (as would be returned by @@ -7763,44 +8129,46 @@ This function is intended to be used in the start_element and end_element handlers where gtk_buildable_parse_context_get_element() would merely return the name of the element that is being processed. + - the element stack, which must not be modified + the element stack, which must not be modified - a `GtkBuildableParseContext` + a `GtkBuildableParseContext` - Retrieves the current line number and the number of the character on + Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages." + - a `GtkBuildableParseContext` + a `GtkBuildableParseContext` - return location for a line number + return location for a line number - return location for a char-on-line number + return location for a char-on-line number - Completes the process of a temporary sub-parser redirection. + Completes the process of a temporary sub-parser redirection. This function exists to collect the user_data allocated by a matching call to gtk_buildable_parse_context_push(). It must be called @@ -7813,19 +8181,20 @@ This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface. + - the user data passed to gtk_buildable_parse_context_push() + the user data passed to gtk_buildable_parse_context_push() - a `GtkBuildableParseContext` + a `GtkBuildableParseContext` - Temporarily redirects markup data to a sub-parser. + Temporarily redirects markup data to a sub-parser. This function may only be called from the start_element handler of a `GtkBuildableParser`. It must be matched with a corresponding call to @@ -7854,29 +8223,32 @@ interface. For an example of how to use this, see g_markup_parse_context_push() which has the same kind of API. + - a `GtkBuildableParseContext` + a `GtkBuildableParseContext` - a `GtkBuildableParser` + a `GtkBuildableParser` - user data to pass to `GtkBuildableParser` functions + user data to pass to `GtkBuildableParser` functions - A sub-parser for `GtkBuildable` implementations. + A sub-parser for `GtkBuildable` implementations. + + @@ -7901,6 +8273,7 @@ has the same kind of API. + @@ -7919,6 +8292,7 @@ has the same kind of API. + @@ -7940,6 +8314,7 @@ has the same kind of API. + @@ -7963,7 +8338,7 @@ has the same kind of API. - A `GtkBuilder` reads XML descriptions of a user interface and + A `GtkBuilder` reads XML descriptions of a user interface and instantiates the described objects. To create a `GtkBuilder` from a user interface description, call @@ -8143,53 +8518,57 @@ respective objects. A `<template>` tag can be used to define a widget class’s components. See the [GtkWidget documentation](class.Widget.html#building-composite-widgets-from-template-xml) for details. + - Creates a new empty builder object. + Creates a new empty builder object. This function is only useful if you intend to make multiple calls to [method@Gtk.Builder.add_from_file], [method@Gtk.Builder.add_from_resource] or [method@Gtk.Builder.add_from_string] in order to merge multiple UI descriptions into a single builder. + - a new (empty) `GtkBuilder` object + a new (empty) `GtkBuilder` object - Parses the UI definition in the file @filename. + Parses the UI definition in the file @filename. If there is an error opening the file or parsing the description then the program will be aborted. You should only ever attempt to parse user interface descriptions that are shipped as part of your program. + - a `GtkBuilder` containing the described interface + a `GtkBuilder` containing the described interface - filename of user interface description file + filename of user interface description file - Parses the UI definition at @resource_path. + Parses the UI definition at @resource_path. If there is an error locating the resource or parsing the description, then the program will be aborted. + - a `GtkBuilder` containing the described interface + a `GtkBuilder` containing the described interface - a `GResource` resource path + a `GResource` resource path - Parses the UI definition in @string. + Parses the UI definition in @string. If @string is %NULL-terminated, then @length should be -1. If @length is not -1, then it is the length of @string. @@ -8197,23 +8576,24 @@ If @length is not -1, then it is the length of @string. If there is an error parsing @string then the program will be aborted. You should not attempt to parse user interface description from untrusted sources. + - a `GtkBuilder` containing the interface described by @string + a `GtkBuilder` containing the interface described by @string - a user interface (XML) description + a user interface (XML) description - the length of @string, or -1 + the length of @string, or -1 - Parses a file containing a UI definition and merges it with + Parses a file containing a UI definition and merges it with the current contents of @builder. This function is useful if you need to call @@ -8231,23 +8611,24 @@ files that are not part of your application). Broken `GtkBuilder` files can easily crash your program, and it’s possible that memory was leaked leading up to the reported failure. The only reasonable thing to do when an error is detected is to call `g_error()`. + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the name of the file to parse + the name of the file to parse - Parses a resource file containing a UI definition + Parses a resource file containing a UI definition and merges it with the current contents of @builder. This function is useful if you need to call @@ -8262,23 +8643,24 @@ domain. It’s not really reasonable to attempt to handle failures of this call. The only reasonable thing to do when an error is detected is to call g_error(). + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the path of the resource file to parse + the path of the resource file to parse - Parses a string containing a UI definition and merges it + Parses a string containing a UI definition and merges it with the current contents of @builder. This function is useful if you need to call @@ -8293,27 +8675,28 @@ Upon errors %FALSE will be returned and @error will be assigned a It’s not really reasonable to attempt to handle failures of this call. The only reasonable thing to do when an error is detected is to call g_error(). + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - Parses a file containing a UI definition building only the + Parses a file containing a UI definition building only the requested objects and merges them with the current contents of @builder. @@ -8324,21 +8707,22 @@ domain. If you are adding an object that depends on an object that is not its child (for instance a `GtkTreeView` that depends on its `GtkTreeModel`), you have to explicitly list all of them in @object_ids. + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the name of the file to parse + the name of the file to parse - nul-terminated array of objects to build + nul-terminated array of objects to build @@ -8346,7 +8730,7 @@ its child (for instance a `GtkTreeView` that depends on its - Parses a resource file containing a UI definition, building + Parses a resource file containing a UI definition, building only the requested objects and merges them with the current contents of @builder. @@ -8357,21 +8741,22 @@ domain. If you are adding an object that depends on an object that is not its child (for instance a `GtkTreeView` that depends on its `GtkTreeModel`), you have to explicitly list all of them in @object_ids. + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the path of the resource file to parse + the path of the resource file to parse - nul-terminated array of objects to build + nul-terminated array of objects to build @@ -8379,7 +8764,7 @@ its child (for instance a `GtkTreeView` that depends on its - Parses a string containing a UI definition, building only the + Parses a string containing a UI definition, building only the requested objects and merges them with the current contents of @builder. @@ -8389,25 +8774,26 @@ Upon errors %FALSE will be returned and @error will be assigned a If you are adding an object that depends on an object that is not its child (for instance a `GtkTreeView` that depends on its `GtkTreeModel`), you have to explicitly list all of them in @object_ids. + - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - nul-terminated array of objects to build + nul-terminated array of objects to build @@ -8415,131 +8801,137 @@ its child (for instance a `GtkTreeView` that depends on its - Creates a closure to invoke the function called @function_name. + Creates a closure to invoke the function called @function_name. This is using the create_closure() implementation of @builder's [class@Gtk.BuilderScope]. If no closure could be created, %NULL will be returned and @error will be set. + - A new closure for invoking @function_name + A new closure for invoking @function_name - a `GtkBuilder` + a `GtkBuilder` - name of the function to look up + name of the function to look up - closure creation flags + closure creation flags - Object to create the closure with + Object to create the closure with - Add @object to the @builder object pool so it can be + Add @object to the @builder object pool so it can be referenced just like any other object built by builder. + - a `GtkBuilder` + a `GtkBuilder` - the name of the object exposed to the builder + the name of the object exposed to the builder - the object to expose + the object to expose - Main private entry point for building composite components + Main private entry point for building composite components from template XML. This is exported purely to let `gtk-builder-tool` validate templates, applications have no need to call this function. + - A positive value on success, 0 if an error occurred + A positive value on success, 0 if an error occurred - a `GtkBuilder` + a `GtkBuilder` - the object that is being extended + the object that is being extended - the type that the template is for + the type that the template is for - the string to parse + the string to parse - the length of @buffer (may be -1 if @buffer is nul-terminated) + the length of @buffer (may be -1 if @buffer is nul-terminated) - Gets the current object set via gtk_builder_set_current_object(). + Gets the current object set via gtk_builder_set_current_object(). + - the current object + the current object - a `GtkBuilder` + a `GtkBuilder` - Gets the object named @name. + Gets the object named @name. Note that this function does not increment the reference count of the returned object. + - the object named @name + the object named @name - a `GtkBuilder` + a `GtkBuilder` - name of object to get + name of object to get - Gets all objects that have been constructed by @builder. + Gets all objects that have been constructed by @builder. Note that this function does not increment the reference counts of the returned objects. + - a + a newly-allocated `GSList` containing all the objects constructed by the `GtkBuilder instance`. It should be freed by g_slist_free() @@ -8549,64 +8941,67 @@ counts of the returned objects. - a `GtkBuilder` + a `GtkBuilder` - Gets the scope in use that was set via gtk_builder_set_scope(). + Gets the scope in use that was set via gtk_builder_set_scope(). + - the current scope + the current scope - a `GtkBuilder` + a `GtkBuilder` - Gets the translation domain of @builder. + Gets the translation domain of @builder. + - the translation domain + the translation domain - a `GtkBuilder` + a `GtkBuilder` - Looks up a type by name. + Looks up a type by name. This is using the virtual function that `GtkBuilder` has for that purpose. This is mainly used when implementing the `GtkBuildable` interface on a type. + - the `GType` found for @type_name or %G_TYPE_INVALID + the `GType` found for @type_name or %G_TYPE_INVALID if no type was found - a `GtkBuilder` + a `GtkBuilder` - type name to lookup + type name to lookup - Sets the current object for the @builder. + Sets the current object for the @builder. The current object can be thought of as the `this` object that the builder is working for and will often be used as the default object @@ -8615,58 +9010,61 @@ when an object is optional. [method@Gtk.Widget.init_template] for example will set the current object to the widget the template is inited for. For functions like [ctor@Gtk.Builder.new_from_resource], the current object will be %NULL. + - a `GtkBuilder` + a `GtkBuilder` - the new current object + the new current object - Sets the scope the builder should operate in. + Sets the scope the builder should operate in. If @scope is %NULL, a new [class@Gtk.BuilderCScope] will be created. + - a `GtkBuilder` + a `GtkBuilder` - the scope to use + the scope to use - Sets the translation domain of @builder. + Sets the translation domain of @builder. + - a `GtkBuilder` + a `GtkBuilder` - the translation domain + the translation domain - Demarshals a value from a string. + Demarshals a value from a string. This function calls g_value_init() on the @value argument, so it need not be initialised beforehand. @@ -8677,31 +9075,32 @@ ulong, enum, flags, float, double, string, `GdkRGBA` and Upon errors %FALSE will be returned and @error will be assigned a `GError` from the %GTK_BUILDER_ERROR domain. + - %TRUE on success + %TRUE on success - a `GtkBuilder` + a `GtkBuilder` - the `GParamSpec` for the property + the `GParamSpec` for the property - the string representation of the value + the string representation of the value - the `GValue` to store the result in + the `GValue` to store the result in - Demarshals a value from a string. + Demarshals a value from a string. Unlike [method@Gtk.Builder.value_from_string], this function takes a `GType` instead of `GParamSpec`. @@ -8711,25 +9110,26 @@ need not be initialised beforehand. Upon errors %FALSE will be returned and @error will be assigned a `GError` from the %GTK_BUILDER_ERROR domain. + - %TRUE on success + %TRUE on success - a `GtkBuilder` + a `GtkBuilder` - the `GType` of the value + the `GType` of the value - the string representation of the value + the string representation of the value - the `GValue` to store the result in + the `GValue` to store the result in @@ -8737,19 +9137,19 @@ assigned a `GError` from the %GTK_BUILDER_ERROR domain. - The object the builder is evaluating for. + The object the builder is evaluating for. - The scope the builder is operating in + The scope the builder is operating in - The translation domain used when translating property values that + The translation domain used when translating property values that have been marked as translatable. If the translation domain is %NULL, `GtkBuilder` uses gettext(), @@ -8758,7 +9158,7 @@ otherwise g_dgettext(). - A `GtkBuilderScope` implementation for the C language. + A `GtkBuilderScope` implementation for the C language. `GtkBuilderCScope` instances use symbols explicitly added to @builder with prior calls to [method@Gtk.BuilderCScope.add_callback_symbol]. @@ -8774,20 +9174,22 @@ symbols in the application. Note that unless [method@Gtk.BuilderCScope.add_callback_symbol] is called for all signal callbacks which are referenced by the loaded XML, this functionality will require that `GModule` be supported on the platform. + - Creates a new `GtkBuilderCScope` object to use with future + Creates a new `GtkBuilderCScope` object to use with future `GtkBuilder` instances. Calling this function is only necessary if you want to add custom callbacks via [method@Gtk.BuilderCScope.add_callback_symbol]. + - a new `GtkBuilderCScope` + a new `GtkBuilderCScope` - Adds the @callback_symbol to the scope of @builder under the + Adds the @callback_symbol to the scope of @builder under the given @callback_name. Using this function overrides the behavior of @@ -8795,66 +9197,69 @@ Using this function overrides the behavior of are added. Using this method allows for better encapsulation as it does not require that callback symbols be declared in the global namespace. + - a `GtkBuilderCScope` + a `GtkBuilderCScope` - The name of the callback, as expected in the XML + The name of the callback, as expected in the XML - The callback pointer + The callback pointer - A convenience function to add many callbacks. + A convenience function to add many callbacks. This is equivalent to calling [method@Gtk.BuilderCScope.add_callback_symbol] for each symbol. + - a `GtkBuilderCScope` + a `GtkBuilderCScope` - The name of the callback, as expected in the XML + The name of the callback, as expected in the XML - The callback pointer + The callback pointer - A list of callback name and callback symbol pairs terminated with %NULL + A list of callback name and callback symbol pairs terminated with %NULL - Fetches a symbol previously added with + Fetches a symbol previously added with gtk_builder_cscope_add_callback_symbol(). + - The callback symbol + The callback symbol in @builder for @callback_name - a `GtkBuilderCScope` + a `GtkBuilderCScope` - The name of the callback + The name of the callback @@ -8864,79 +9269,82 @@ gtk_builder_cscope_add_callback_symbol(). + - + + + - The list of flags that can be passed to gtk_builder_create_closure(). + The list of flags that can be passed to gtk_builder_create_closure(). New values may be added in the future for new features, so external implementations of [iface@Gtk.BuilderScope] should test the flags for unknown values and raise a %GTK_BUILDER_ERROR_INVALID_ATTRIBUTE error when they encounter one. - The closure should be created swapped. See + The closure should be created swapped. See g_cclosure_new_swap() for details. - Error codes that identify various errors that can occur while using + Error codes that identify various errors that can occur while using `GtkBuilder`. - A type-func attribute didn’t name + A type-func attribute didn’t name a function that returns a `GType`. - The input contained a tag that `GtkBuilder` + The input contained a tag that `GtkBuilder` can’t handle. - An attribute that is required by + An attribute that is required by `GtkBuilder` was missing. - `GtkBuilder` found an attribute that + `GtkBuilder` found an attribute that it doesn’t understand. - `GtkBuilder` found a tag that + `GtkBuilder` found a tag that it doesn’t understand. - A required property value was + A required property value was missing. - `GtkBuilder` couldn’t parse + `GtkBuilder` couldn’t parse some attribute value. - The input file requires a newer version + The input file requires a newer version of GTK. - An object id occurred twice. + An object id occurred twice. - A specified object type is of the same type or + A specified object type is of the same type or derived from the type of the composite class being extended with builder XML. - The wrong type was specified in a composite class’s template XML + The wrong type was specified in a composite class’s template XML - The specified property is unknown for the object class. + The specified property is unknown for the object class. - The specified signal is unknown for the object class. + The specified signal is unknown for the object class. - An object id is unknown. + An object id is unknown. - A function could not be found. This often happens + A function could not be found. This often happens when symbols are set to be kept private. Compiling code with -rdynamic or using the `gmodule-export-2.0` pkgconfig module can fix this problem. @@ -8947,7 +9355,7 @@ when they encounter one. - `GtkBuilderListItemFactory` is a `GtkListItemFactory` that creates + `GtkBuilderListItemFactory` is a `GtkListItemFactory` that creates widgets by instantiating `GtkBuilder` UI templates. The templates must be extending `GtkListItem`, and typically use @@ -8970,104 +9378,112 @@ Example: </template> </interface> ``` + - Creates a new `GtkBuilderListItemFactory` that instantiates widgets + Creates a new `GtkBuilderListItemFactory` that instantiates widgets using @bytes as the data to pass to `GtkBuilder`. + - a new `GtkBuilderListItemFactory` + a new `GtkBuilderListItemFactory` - A scope to use when instantiating + A scope to use when instantiating - the `GBytes` containing the ui file to instantiate + the `GBytes` containing the ui file to instantiate - Creates a new `GtkBuilderListItemFactory` that instantiates widgets + Creates a new `GtkBuilderListItemFactory` that instantiates widgets using data read from the given @resource_path to pass to `GtkBuilder`. + - a new `GtkBuilderListItemFactory` + a new `GtkBuilderListItemFactory` - A scope to use when instantiating + A scope to use when instantiating - valid path to a resource that contains the data + valid path to a resource that contains the data - Gets the data used as the `GtkBuilder` UI template for constructing + Gets the data used as the `GtkBuilder` UI template for constructing listitems. + - The `GtkBuilder` data + The `GtkBuilder` data - a `GtkBuilderListItemFactory` + a `GtkBuilderListItemFactory` - If the data references a resource, gets the path of that resource. + If the data references a resource, gets the path of that resource. + - The path to the resource + The path to the resource - a `GtkBuilderListItemFactory` + a `GtkBuilderListItemFactory` - Gets the scope used when constructing listitems. + Gets the scope used when constructing listitems. + - The scope used when constructing listitems + The scope used when constructing listitems - a `GtkBuilderListItemFactory` + a `GtkBuilderListItemFactory` - `GBytes` containing the UI definition. + `GBytes` containing the UI definition. - Path of the resource containing the UI definition. + Path of the resource containing the UI definition. - `GtkBuilderScope` to use when instantiating listitems + `GtkBuilderScope` to use when instantiating listitems - + + + - `GtkBuilderScope` is an interface to provide language binding support + `GtkBuilderScope` is an interface to provide language binding support to `GtkBuilder`. The goal of `GtkBuilderScope` is to look up programming-language-specific @@ -9081,7 +9497,9 @@ even at once. By default, GTK will use its own implementation of `GtkBuilderScope` for the C language which can be created via [ctor@Gtk.BuilderCScope.new]. + + @@ -9104,6 +9522,7 @@ for the C language which can be created via [ctor@Gtk.BuilderCScope.new]. + @@ -9120,6 +9539,7 @@ for the C language which can be created via [ctor@Gtk.BuilderCScope.new]. + @@ -9137,14 +9557,16 @@ for the C language which can be created via [ctor@Gtk.BuilderCScope.new]. - The virtual function table to implement for `GtkBuilderScope` implementations. + The virtual function table to implement for `GtkBuilderScope` implementations. Default implementations for each function do exist, but they usually just fail, so it is suggested that implementations implement all of them. + + @@ -9163,6 +9585,7 @@ so it is suggested that implementations implement all of them. + @@ -9181,6 +9604,7 @@ so it is suggested that implementations implement all of them. + @@ -9205,7 +9629,7 @@ so it is suggested that implementations implement all of them. - The `GtkButton` widget is generally used to trigger a callback function that is + The `GtkButton` widget is generally used to trigger a callback function that is called when the button is pressed. ![An example GtkButton](button.png) @@ -9235,69 +9659,75 @@ or [class@Gtk.FontButton] use style classes such as .toggle, .popup, .scale, # Accessibility `GtkButton` uses the %GTK_ACCESSIBLE_ROLE_BUTTON role. + - Creates a new `GtkButton` widget. + Creates a new `GtkButton` widget. To add a child widget to the button, use [method@Gtk.Button.set_child]. + - The newly created `GtkButton` widget. + The newly created `GtkButton` widget. - Creates a new button containing an icon from the current icon theme. + Creates a new button containing an icon from the current icon theme. If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. + - a new `GtkButton` displaying the themed icon + a new `GtkButton` displaying the themed icon - an icon name + an icon name - Creates a `GtkButton` widget with a `GtkLabel` child. + Creates a `GtkButton` widget with a `GtkLabel` child. + - The newly created `GtkButton` widget + The newly created `GtkButton` widget - The text you want the `GtkLabel` to hold + The text you want the `GtkLabel` to hold - Creates a new `GtkButton` containing a label. + Creates a new `GtkButton` containing a label. If characters in @label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button. + - a new `GtkButton` + a new `GtkButton` - The text of the button, with an underscore in front of the + The text of the button, with an underscore in front of the mnemonic character + @@ -9308,6 +9738,7 @@ accelerator called a mnemonic. Pressing Alt and that key activates the button. + @@ -9319,177 +9750,187 @@ accelerator called a mnemonic. Pressing Alt and that key activates the button. - Gets the child widget of @button. + Gets the child widget of @button. + - the child widget of @button + the child widget of @button - a `GtkButton` + a `GtkButton` - Returns whether the button has a frame. + Returns whether the button has a frame. + - %TRUE if the button has a frame + %TRUE if the button has a frame - a `GtkButton` + a `GtkButton` - Returns the icon name of the button. + Returns the icon name of the button. If the icon name has not been set with [method@Gtk.Button.set_icon_name] the return value will be %NULL. This will be the case if you create an empty button with [ctor@Gtk.Button.new] to use as a container. + - The icon name set via [method@Gtk.Button.set_icon_name] + The icon name set via [method@Gtk.Button.set_icon_name] - A `GtkButton` + A `GtkButton` - Fetches the text from the label of the button. + Fetches the text from the label of the button. If the label text has not been set with [method@Gtk.Button.set_label] the return value will be %NULL. This will be the case if you create an empty button with [ctor@Gtk.Button.new] to use as a container. + - The text of the label widget. This string is owned + The text of the label widget. This string is owned by the widget and must not be modified or freed. - a `GtkButton` + a `GtkButton` - gets whether underlines are interpreted as mnemonics. + gets whether underlines are interpreted as mnemonics. See [method@Gtk.Button.set_use_underline]. + - %TRUE if an embedded underline in the button label + %TRUE if an embedded underline in the button label indicates the mnemonic accelerator keys. - a `GtkButton` + a `GtkButton` - Sets the child widget of @button. + Sets the child widget of @button. + - a `GtkButton` + a `GtkButton` - the child widget + the child widget - Sets the style of the button. + Sets the style of the button. Buttons can has a flat appearance or have a frame drawn around them. + - a `GtkButton` + a `GtkButton` - whether the button should have a visible frame + whether the button should have a visible frame - Adds a `GtkImage` with the given icon name as a child. + Adds a `GtkImage` with the given icon name as a child. If @button already contains a child widget, that child widget will be removed and replaced with the image. + - A `GtkButton` + A `GtkButton` - An icon name + An icon name - Sets the text of the label of the button to @label. + Sets the text of the label of the button to @label. This will also clear any previously set labels. + - a `GtkButton` + a `GtkButton` - a string + a string - Sets whether to use underlines as mnemonics. + Sets whether to use underlines as mnemonics. If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key. + - a `GtkButton` + a `GtkButton` - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics @@ -9497,31 +9938,31 @@ the next character should be used for the mnemonic accelerator key. - The child widget. + The child widget. - Whether the button has a frame. + Whether the button has a frame. - The name of the icon used to automatically populate the button. + The name of the icon used to automatically populate the button. - Text of the label inside the button, if the button contains a label widget. + Text of the label inside the button, if the button contains a label widget. - If set, an underline in the text indicates that the following character is + If set, an underline in the text indicates that the following character is to be used as mnemonic. @@ -9529,7 +9970,7 @@ to be used as mnemonic. - Emitted to animate press then release. + Emitted to animate press then release. This is an action signal. Applications should never connect to this signal, but use the [signal@Gtk.Button::clicked] signal. @@ -9538,19 +9979,21 @@ to this signal, but use the [signal@Gtk.Button::clicked] signal. - Emitted when the button has been activated (pressed and released). + Emitted when the button has been activated (pressed and released). + - The parent class. + The parent class. + @@ -9563,6 +10006,7 @@ to this signal, but use the [signal@Gtk.Button::clicked] signal. + @@ -9579,9 +10023,11 @@ to this signal, but use the [signal@Gtk.Button::clicked] signal. - + + + - Prebuilt sets of buttons for `GtkDialog`. + Prebuilt sets of buttons for `GtkDialog`. If none of these choices are appropriate, simply use %GTK_BUTTONS_NONE and call [method@Gtk.Dialog.add_buttons]. @@ -9590,391 +10036,442 @@ If none of these choices are appropriate, simply use > and %GTK_BUTTONS_OK_CANCEL are discouraged by the > [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/). - no buttons at all + no buttons at all - an OK button + an OK button - a Close button + a Close button - a Cancel button + a Cancel button - Yes and No buttons + Yes and No buttons - OK and Cancel buttons + OK and Cancel buttons + - A variant of `GtkClosureExpression` using a C closure. + A variant of `GtkClosureExpression` using a C closure. - Creates a `GtkExpression` that calls `callback_func` when it is evaluated. + Creates a `GtkExpression` that calls `callback_func` when it is evaluated. This function is a variant of [ctor@Gtk.ClosureExpression.new] that creates a `GClosure` by calling g_cclosure_new() with the given `callback_func`, `user_data` and `user_destroy`. + - a new `GtkExpression` + a new `GtkExpression` - the type of the value that this expression evaluates to + the type of the value that this expression evaluates to - marshaller used for creating a closure + marshaller used for creating a closure - the number of params needed for evaluating @closure + the number of params needed for evaluating @closure - expressions for each parameter + expressions for each parameter - callback used for creating a closure + callback used for creating a closure - user data used for creating a closure + user data used for creating a closure - destroy notify for @user_data + destroy notify for @user_data + + + + + + + - This macro should be used to emit a standard warning about unexpected + This macro should be used to emit a standard warning about unexpected properties in set_cell_property() and get_cell_property() implementations. + - the `GObject` on which set_cell_property() or get_cell_property() + the `GObject` on which set_cell_property() or get_cell_property() was called - the numeric id of the property + the numeric id of the property - the `GParamSpec` of the property + the `GParamSpec` of the property + + + + + + + + + + + + + + + + + + + + + + + + - Returns %TRUE if the version of the GTK header files + Returns %TRUE if the version of the GTK header files is the same as or newer than the passed-in version. + - major version (e.g. 1 for version 1.2.5) + major version (e.g. 1 for version 1.2.5) - minor version (e.g. 2 for version 1.2.5) + minor version (e.g. 2 for version 1.2.5) - micro version (e.g. 5 for version 1.2.5) + micro version (e.g. 5 for version 1.2.5) + + + + + + + + + + + + + + + + - `GtkCalendar` is a widget that displays a Gregorian calendar, one month + `GtkCalendar` is a widget that displays a Gregorian calendar, one month at a time. ![An example GtkCalendar](calendar.png) @@ -10027,218 +10524,231 @@ Marked day labels get the :selected state assigned. - Creates a new calendar, with the current date being selected. + Creates a new calendar, with the current date being selected. + - a newly `GtkCalendar` widget + a newly `GtkCalendar` widget - Remove all visual markers. + Remove all visual markers. + - a `GtkCalendar` + a `GtkCalendar` - Returns a `GDateTime` representing the shown + Returns a `GDateTime` representing the shown year, month and the selected day. The returned date is in the local time zone. + - the `GDate` representing the shown date + the `GDate` representing the shown date - a `GtkCalendar` + a `GtkCalendar` - Returns if the @day of the @calendar is already marked. + Returns if the @day of the @calendar is already marked. + - whether the day is marked. + whether the day is marked. - a `GtkCalendar` + a `GtkCalendar` - the day number between 1 and 31. + the day number between 1 and 31. - Returns whether @self is currently showing the names + Returns whether @self is currently showing the names of the week days. This is the value of the [property@Gtk.Calendar:show-day-names] property. + - Whether the calendar shows day names. + Whether the calendar shows day names. - a `GtkCalendar` + a `GtkCalendar` - Returns whether @self is currently showing the heading. + Returns whether @self is currently showing the heading. This is the value of the [property@Gtk.Calendar:show-heading] property. + - Whether the calendar is showing a heading. + Whether the calendar is showing a heading. - a `GtkCalendar` + a `GtkCalendar` - Returns whether @self is showing week numbers right + Returns whether @self is showing week numbers right now. This is the value of the [property@Gtk.Calendar:show-week-numbers] property. + - Whether the calendar is showing week numbers. + Whether the calendar is showing week numbers. - a `GtkCalendar` + a `GtkCalendar` - Places a visual marker on a particular day. + Places a visual marker on a particular day. + - a `GtkCalendar` + a `GtkCalendar` - the day number to mark between 1 and 31. + the day number to mark between 1 and 31. - Switches to @date's year and month and select its day. + Switches to @date's year and month and select its day. + - a `GtkCalendar`. + a `GtkCalendar`. - a `GDateTime` representing the day to select + a `GDateTime` representing the day to select - Sets whether the calendar shows day names. + Sets whether the calendar shows day names. + - a `GtkCalendar` + a `GtkCalendar` - Whether to show day names above the day numbers + Whether to show day names above the day numbers - Sets whether the calendar should show a heading. + Sets whether the calendar should show a heading. The heading contains the current year and month as well as buttons for changing both. + - a `GtkCalendar` + a `GtkCalendar` - Whether to show the heading in the calendar + Whether to show the heading in the calendar - Sets whether week numbers are shown in the calendar. + Sets whether week numbers are shown in the calendar. + - a `GtkCalendar` + a `GtkCalendar` - whether to show week numbers on the left of the days + whether to show week numbers on the left of the days - Removes the visual marker from a particular day. + Removes the visual marker from a particular day. + - a `GtkCalendar`. + a `GtkCalendar`. - the day number to unmark between 1 and 31. + the day number to unmark between 1 and 31. - The selected day (as a number between 1 and 31). + The selected day (as a number between 1 and 31). - The selected month (as a number between 0 and 11). + The selected month (as a number between 0 and 11). This property gets initially set to the current month. @@ -10246,116 +10756,121 @@ This property gets initially set to the current month. - Determines whether day names are displayed. + Determines whether day names are displayed. - Determines whether a heading is displayed. + Determines whether a heading is displayed. - Determines whether week numbers are displayed. + Determines whether week numbers are displayed. - The selected year. + The selected year. This property gets initially set to the current year. - Emitted when the user selects a day. + Emitted when the user selects a day. - Emitted when the user switched to the next month. + Emitted when the user switched to the next month. - Emitted when user switched to the next year. + Emitted when user switched to the next year. - Emitted when the user switched to the previous month. + Emitted when the user switched to the previous month. - Emitted when user switched to the previous year. + Emitted when user switched to the previous year. - A `GtkShortcutAction` that invokes a callback. + A `GtkShortcutAction` that invokes a callback. + - Create a custom action that calls the given @callback when + Create a custom action that calls the given @callback when activated. + - A new shortcut action + A new shortcut action - the callback to call + the callback to call - the data to be passed to @callback + the data to be passed to @callback - the function to be called when the + the function to be called when the callback action is finalized - + + + - The type of the callback functions used for iterating over the + The type of the callback functions used for iterating over the cell renderers and their allocated areas inside a `GtkCellArea`, see gtk_cell_area_foreach_alloc(). + - %TRUE to stop iterating over cells. + %TRUE to stop iterating over cells. - the cell renderer to operate on + the cell renderer to operate on - the area allocated to @renderer inside the rectangle + the area allocated to @renderer inside the rectangle provided to gtk_cell_area_foreach_alloc(). - the background area for @renderer inside the + the background area for @renderer inside the background area provided to gtk_cell_area_foreach_alloc(). - user-supplied data + user-supplied data - An abstract class for laying out GtkCellRenderers + An abstract class for laying out GtkCellRenderers The `GtkCellArea` is an abstract class for `GtkCellLayout` widgets (also referred to as "layouting widgets") to interface with an @@ -10668,92 +11183,96 @@ To set the value of a cell property, use gtk_cell_area_cell_set_property(), gtk_cell_area_cell_set() or gtk_cell_area_cell_set_valist(). To obtain the value of a cell property, use gtk_cell_area_cell_get_property(), gtk_cell_area_cell_get() or gtk_cell_area_cell_get_valist(). + - Activates @area, usually by activating the currently focused + Activates @area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus. + - Whether @area was successfully activated. + Whether @area was successfully activated. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context in context with the current row data + the `GtkCellArea`Context in context with the current row data - the `GtkWidget` that @area is rendering on + the `GtkWidget` that @area is rendering on - the size and location of @area relative to @widget’s allocation + the size and location of @area relative to @widget’s allocation - the `GtkCellRenderer`State flags for @area for this row of data. + the `GtkCellRenderer`State flags for @area for this row of data. - if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE + if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE will be activated. - Adds @renderer to @area with the default child cell properties. + Adds @renderer to @area with the default child cell properties. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to add to @area + the `GtkCellRenderer` to add to @area - Applies any connected attributes to the renderers in + Applies any connected attributes to the renderers in @area by pulling the values from @tree_model. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkTreeModel` to pull values from + the `GtkTreeModel` to pull values from - the `GtkTreeIter` in @tree_model to apply values for + the `GtkTreeIter` in @tree_model to apply values for - whether @iter has children + whether @iter has children - whether @iter is expanded in the view and + whether @iter is expanded in the view and children are visible - This is sometimes needed for cases where rows need to share + This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation. @@ -10764,153 +11283,160 @@ a separate collective height. `GtkIconView` uses this to request the heights of each row based on a context which was already used to request all the row widths that are to be displayed. + - a newly created `GtkCellArea`Context copy of @context. + a newly created `GtkCellArea`Context copy of @context. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to copy + the `GtkCellArea`Context to copy - Creates a `GtkCellArea`Context to be used with @area for + Creates a `GtkCellArea`Context to be used with @area for all purposes. `GtkCellArea`Context stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same `GtkCellArea`Context which was used to request the size of those rows of data). + - a newly created `GtkCellArea`Context which can be used with @area. + a newly created `GtkCellArea`Context which can be used with @area. - a `GtkCellArea` + a `GtkCellArea` - Delegates event handling to a `GtkCellArea`. + Delegates event handling to a `GtkCellArea`. + - %TRUE if the event was handled by @area. + %TRUE if the event was handled by @area. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the `GdkEvent` to handle + the `GdkEvent` to handle - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the `GtkCellRenderer`State for @area in this row. + the `GtkCellRenderer`State for @area in this row. - This should be called by the @area’s owning layout widget + This should be called by the @area’s owning layout widget when focus is to be passed to @area, or moved within @area for a given @direction and row data. Implementing `GtkCellArea` classes should implement this method to receive and navigate focus in its own way particular to how it lays out cells. + - %TRUE if focus remains inside @area as a result of this call. + %TRUE if focus remains inside @area as a result of this call. - a `GtkCellArea` + a `GtkCellArea` - the `GtkDirectionType` + the `GtkDirectionType` - Calls @callback for every `GtkCellRenderer` in @area. + Calls @callback for every `GtkCellRenderer` in @area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellCallback` to call + the `GtkCellCallback` to call - user provided data pointer + user provided data pointer - Calls @callback for every `GtkCellRenderer` in @area with the + Calls @callback for every `GtkCellRenderer` in @area with the allocated rectangle inside @cell_area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the @widget relative coordinates and size for @area + the @widget relative coordinates and size for @area - the @widget relative coordinates of the background area + the @widget relative coordinates of the background area - the `GtkCellAllocCallback` to call + the `GtkCellAllocCallback` to call - user provided data pointer + user provided data pointer + @@ -10933,41 +11459,42 @@ allocated rectangle inside @cell_area. - Retrieves a cell area’s initial minimum and natural height. + Retrieves a cell area’s initial minimum and natural height. @area will store some geometrical information in @context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_height and @natural_height of this call but rather to consult gtk_cell_area_context_get_preferred_height() after a series of requests. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to perform this request with + the `GtkCellArea`Context to perform this request with - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Retrieves a cell area’s minimum and natural height if it would be given + Retrieves a cell area’s minimum and natural height if it would be given the specified @width. @area stores some geometrical information in @context along the way @@ -10981,72 +11508,74 @@ If at some point, the width of a single row changes, it should be requested with gtk_cell_area_get_preferred_width() again and then the full width of the requested rows checked again with gtk_cell_area_context_get_preferred_width(). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context which has already been requested for widths. + the `GtkCellArea`Context which has already been requested for widths. - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - the width for which to check the height of this area + the width for which to check the height of this area - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Retrieves a cell area’s initial minimum and natural width. + Retrieves a cell area’s initial minimum and natural width. @area will store some geometrical information in @context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_width and @natural_width of this call but rather to consult gtk_cell_area_context_get_preferred_width() after a series of requests. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to perform this request with + the `GtkCellArea`Context to perform this request with - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Retrieves a cell area’s minimum and natural width if it would be given + Retrieves a cell area’s minimum and natural width if it would be given the specified @height. @area stores some geometrical information in @context along the way @@ -11060,81 +11589,86 @@ If at some point, the height of a single row changes, it should be requested with gtk_cell_area_get_preferred_height() again and then the full height of the requested rows checked again with gtk_cell_area_context_get_preferred_height(). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context which has already been requested for widths. + the `GtkCellArea`Context which has already been requested for widths. - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - the height for which to check the width of this area + the height for which to check the width of this area - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Gets whether the area prefers a height-for-width layout + Gets whether the area prefers a height-for-width layout or a width-for-height layout. + - The `GtkSizeRequestMode` preferred by @area. + The `GtkSizeRequestMode` preferred by @area. - a `GtkCellArea` + a `GtkCellArea` - Returns whether the area can do anything when activated, + Returns whether the area can do anything when activated, after applying new attributes to @area. + - whether @area can do anything when activated. + whether @area can do anything when activated. - a `GtkCellArea` + a `GtkCellArea` - Removes @renderer from @area. + Removes @renderer from @area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to remove from @area + the `GtkCellRenderer` to remove from @area + @@ -11157,435 +11691,451 @@ after applying new attributes to @area. - Snapshots @area’s cells according to @area’s layout onto at + Snapshots @area’s cells according to @area’s layout onto at the given coordinates. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the `GtkSnapshot` to draw to + the `GtkSnapshot` to draw to - the @widget relative coordinates for @area’s background + the @widget relative coordinates for @area’s background - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the `GtkCellRenderer`State for @area in this row. + the `GtkCellRenderer`State for @area in this row. - whether @area should paint focus on focused cells for focused rows or not. + whether @area should paint focus on focused cells for focused rows or not. - Activates @area, usually by activating the currently focused + Activates @area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus. + - Whether @area was successfully activated. + Whether @area was successfully activated. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context in context with the current row data + the `GtkCellArea`Context in context with the current row data - the `GtkWidget` that @area is rendering on + the `GtkWidget` that @area is rendering on - the size and location of @area relative to @widget’s allocation + the size and location of @area relative to @widget’s allocation - the `GtkCellRenderer`State flags for @area for this row of data. + the `GtkCellRenderer`State flags for @area for this row of data. - if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE + if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE will be activated. - This is used by `GtkCellArea` subclasses when handling events + This is used by `GtkCellArea` subclasses when handling events to activate cells, the base `GtkCellArea` class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation. + - whether cell activation was successful + whether cell activation was successful - a `GtkCellArea` + a `GtkCellArea` - the `GtkWidget` that @area is rendering onto + the `GtkWidget` that @area is rendering onto - the `GtkCellRenderer` in @area to activate + the `GtkCellRenderer` in @area to activate - the `GdkEvent` for which cell activation should occur + the `GdkEvent` for which cell activation should occur - the `GdkRectangle` in @widget relative coordinates + the `GdkRectangle` in @widget relative coordinates of @renderer for the current row. - the `GtkCellRenderer`State for @renderer + the `GtkCellRenderer`State for @renderer - Adds @renderer to @area with the default child cell properties. + Adds @renderer to @area with the default child cell properties. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to add to @area + the `GtkCellRenderer` to add to @area - Adds @sibling to @renderer’s focusable area, focus will be drawn + Adds @sibling to @renderer’s focusable area, focus will be drawn around @renderer and all of its siblings if @renderer can focus for a given row. Events handled by focus siblings can also activate the given focusable @renderer. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` expected to have focus + the `GtkCellRenderer` expected to have focus - the `GtkCellRenderer` to add to @renderer’s focus area + the `GtkCellRenderer` to add to @renderer’s focus area - Adds @renderer to @area, setting cell properties at the same time. + Adds @renderer to @area, setting cell properties at the same time. See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` to be placed inside @area + a `GtkCellRenderer` to be placed inside @area - the name of the first cell property to set + the name of the first cell property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - Applies any connected attributes to the renderers in + Applies any connected attributes to the renderers in @area by pulling the values from @tree_model. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkTreeModel` to pull values from + the `GtkTreeModel` to pull values from - the `GtkTreeIter` in @tree_model to apply values for + the `GtkTreeIter` in @tree_model to apply values for - whether @iter has children + whether @iter has children - whether @iter is expanded in the view and + whether @iter is expanded in the view and children are visible - Connects an @attribute to apply values from @column for the + Connects an @attribute to apply values from @column for the `GtkTreeModel` in use. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to connect an attribute for + the `GtkCellRenderer` to connect an attribute for - the attribute name + the attribute name - the `GtkTreeModel` column to fetch attribute values from + the `GtkTreeModel` column to fetch attribute values from - Disconnects @attribute for the @renderer in @area so that + Disconnects @attribute for the @renderer in @area so that attribute will no longer be updated with values from the model. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to disconnect an attribute for + the `GtkCellRenderer` to disconnect an attribute for - the attribute name + the attribute name - Returns the model column that an attribute has been mapped to, + Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped. + - the model column, or -1 + the model column, or -1 - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` + a `GtkCellRenderer` - an attribute on the renderer + an attribute on the renderer - Gets the values of one or more cell properties for @renderer in @area. + Gets the values of one or more cell properties for @renderer in @area. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` which is inside @area + a `GtkCellRenderer` which is inside @area - the name of the first cell property to get + the name of the first cell property to get - return location for the first cell property, followed + return location for the first cell property, followed optionally by more name/return location pairs, followed by %NULL - Gets the value of a cell property for @renderer in @area. + Gets the value of a cell property for @renderer in @area. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` inside @area + a `GtkCellRenderer` inside @area - the name of the property to get + the name of the property to get - a location to return the value + a location to return the value - Gets the values of one or more cell properties for @renderer in @area. + Gets the values of one or more cell properties for @renderer in @area. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` inside @area + a `GtkCellRenderer` inside @area - the name of the first property to get + the name of the first property to get - return location for the first property, followed + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - Sets one or more cell properties for @cell in @area. + Sets one or more cell properties for @cell in @area. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` which is a cell inside @area + a `GtkCellRenderer` which is a cell inside @area - the name of the first cell property to set + the name of the first cell property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - Sets a cell property for @renderer in @area. + Sets a cell property for @renderer in @area. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` inside @area + a `GtkCellRenderer` inside @area - the name of the cell property to set + the name of the cell property to set - the value to set the cell property to + the value to set the cell property to - Sets one or more cell properties for @renderer in @area. + Sets one or more cell properties for @renderer in @area. + - a `GtkCellArea` + a `GtkCellArea` - a `GtkCellRenderer` which inside @area + a `GtkCellRenderer` which inside @area - the name of the first cell property to set + the name of the first cell property to set - a %NULL-terminated list of property names and values, starting + a %NULL-terminated list of property names and values, starting with @first_prop_name - This is sometimes needed for cases where rows need to share + This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation. @@ -11596,314 +12146,328 @@ a separate collective height. `GtkIconView` uses this to request the heights of each row based on a context which was already used to request all the row widths that are to be displayed. + - a newly created `GtkCellArea`Context copy of @context. + a newly created `GtkCellArea`Context copy of @context. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to copy + the `GtkCellArea`Context to copy - Creates a `GtkCellArea`Context to be used with @area for + Creates a `GtkCellArea`Context to be used with @area for all purposes. `GtkCellArea`Context stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same `GtkCellArea`Context which was used to request the size of those rows of data). + - a newly created `GtkCellArea`Context which can be used with @area. + a newly created `GtkCellArea`Context which can be used with @area. - a `GtkCellArea` + a `GtkCellArea` - Delegates event handling to a `GtkCellArea`. + Delegates event handling to a `GtkCellArea`. + - %TRUE if the event was handled by @area. + %TRUE if the event was handled by @area. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the `GdkEvent` to handle + the `GdkEvent` to handle - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the `GtkCellRenderer`State for @area in this row. + the `GtkCellRenderer`State for @area in this row. - This should be called by the @area’s owning layout widget + This should be called by the @area’s owning layout widget when focus is to be passed to @area, or moved within @area for a given @direction and row data. Implementing `GtkCellArea` classes should implement this method to receive and navigate focus in its own way particular to how it lays out cells. + - %TRUE if focus remains inside @area as a result of this call. + %TRUE if focus remains inside @area as a result of this call. - a `GtkCellArea` + a `GtkCellArea` - the `GtkDirectionType` + the `GtkDirectionType` - Calls @callback for every `GtkCellRenderer` in @area. + Calls @callback for every `GtkCellRenderer` in @area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellCallback` to call + the `GtkCellCallback` to call - user provided data pointer + user provided data pointer - Calls @callback for every `GtkCellRenderer` in @area with the + Calls @callback for every `GtkCellRenderer` in @area with the allocated rectangle inside @cell_area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the @widget relative coordinates and size for @area + the @widget relative coordinates and size for @area - the @widget relative coordinates of the background area + the @widget relative coordinates of the background area - the `GtkCellAllocCallback` to call + the `GtkCellAllocCallback` to call - user provided data pointer + user provided data pointer - Derives the allocation of @renderer inside @area if @area + Derives the allocation of @renderer inside @area if @area were to be renderered in @cell_area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context used to hold sizes for @area. + the `GtkCellArea`Context used to hold sizes for @area. - the `GtkWidget` that @area is rendering on + the `GtkWidget` that @area is rendering on - the `GtkCellRenderer` to get the allocation for + the `GtkCellRenderer` to get the allocation for - the whole allocated area for @area in @widget + the whole allocated area for @area in @widget for this row - where to store the allocation for @renderer + where to store the allocation for @renderer - Gets the `GtkCellRenderer` at @x and @y coordinates inside @area and optionally + Gets the `GtkCellRenderer` at @x and @y coordinates inside @area and optionally returns the full cell allocation for it inside @cell_area. + - the `GtkCellRenderer` at @x and @y. + the `GtkCellRenderer` at @x and @y. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context used to hold sizes for @area. + the `GtkCellArea`Context used to hold sizes for @area. - the `GtkWidget` that @area is rendering on + the `GtkWidget` that @area is rendering on - the whole allocated area for @area in @widget + the whole allocated area for @area in @widget for this row - the x position + the x position - the y position + the y position - where to store the inner allocated area of the + where to store the inner allocated area of the returned cell renderer - Gets the current `GtkTreePath` string for the currently + Gets the current `GtkTreePath` string for the currently applied `GtkTreeIter`, this is implicitly updated when gtk_cell_area_apply_attributes() is called and can be used to interact with renderers from `GtkCellArea` subclasses. + - The current `GtkTreePath` string for the current + The current `GtkTreePath` string for the current attributes applied to @area. This string belongs to the area and should not be freed. - a `GtkCellArea` + a `GtkCellArea` - Gets the `GtkCellEditable` widget currently used + Gets the `GtkCellEditable` widget currently used to edit the currently edited cell. + - The currently active `GtkCellEditable` widget + The currently active `GtkCellEditable` widget - a `GtkCellArea` + a `GtkCellArea` - Gets the `GtkCellRenderer` in @area that is currently + Gets the `GtkCellRenderer` in @area that is currently being edited. + - The currently edited `GtkCellRenderer` + The currently edited `GtkCellRenderer` - a `GtkCellArea` + a `GtkCellArea` - Retrieves the currently focused cell for @area + Retrieves the currently focused cell for @area + - the currently focused cell in @area. + the currently focused cell in @area. - a `GtkCellArea` + a `GtkCellArea` - Gets the `GtkCellRenderer` which is expected to be focusable + Gets the `GtkCellRenderer` which is expected to be focusable for which @renderer is, or may be a sibling. This is handy for `GtkCellArea` subclasses when handling events, after determining the renderer at the event location it can then chose to activate the focus cell for which the event cell may have been a sibling. + - the `GtkCellRenderer` + the `GtkCellRenderer` for which @renderer is a sibling - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` + the `GtkCellRenderer` - Gets the focus sibling cell renderers for @renderer. + Gets the focus sibling cell renderers for @renderer. + - A `GList` of `GtkCellRenderer`s. + A `GList` of `GtkCellRenderer`s. The returned list is internal and should not be freed. @@ -11911,51 +12475,52 @@ cell may have been a sibling. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` expected to have focus + the `GtkCellRenderer` expected to have focus - Retrieves a cell area’s initial minimum and natural height. + Retrieves a cell area’s initial minimum and natural height. @area will store some geometrical information in @context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_height and @natural_height of this call but rather to consult gtk_cell_area_context_get_preferred_height() after a series of requests. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to perform this request with + the `GtkCellArea`Context to perform this request with - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Retrieves a cell area’s minimum and natural height if it would be given + Retrieves a cell area’s minimum and natural height if it would be given the specified @width. @area stores some geometrical information in @context along the way @@ -11969,72 +12534,74 @@ If at some point, the width of a single row changes, it should be requested with gtk_cell_area_get_preferred_width() again and then the full width of the requested rows checked again with gtk_cell_area_context_get_preferred_width(). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context which has already been requested for widths. + the `GtkCellArea`Context which has already been requested for widths. - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - the width for which to check the height of this area + the width for which to check the height of this area - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Retrieves a cell area’s initial minimum and natural width. + Retrieves a cell area’s initial minimum and natural width. @area will store some geometrical information in @context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the @minimum_width and @natural_width of this call but rather to consult gtk_cell_area_context_get_preferred_width() after a series of requests. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to perform this request with + the `GtkCellArea`Context to perform this request with - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Retrieves a cell area’s minimum and natural width if it would be given + Retrieves a cell area’s minimum and natural width if it would be given the specified @height. @area stores some geometrical information in @context along the way @@ -12048,272 +12615,283 @@ If at some point, the height of a single row changes, it should be requested with gtk_cell_area_get_preferred_height() again and then the full height of the requested rows checked again with gtk_cell_area_context_get_preferred_height(). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context which has already been requested for widths. + the `GtkCellArea`Context which has already been requested for widths. - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - the height for which to check the width of this area + the height for which to check the width of this area - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Gets whether the area prefers a height-for-width layout + Gets whether the area prefers a height-for-width layout or a width-for-height layout. + - The `GtkSizeRequestMode` preferred by @area. + The `GtkSizeRequestMode` preferred by @area. - a `GtkCellArea` + a `GtkCellArea` - Checks if @area contains @renderer. + Checks if @area contains @renderer. + - %TRUE if @renderer is in the @area. + %TRUE if @renderer is in the @area. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to check + the `GtkCellRenderer` to check - This is a convenience function for `GtkCellArea` implementations + This is a convenience function for `GtkCellArea` implementations to get the inner area where a given `GtkCellRenderer` will be rendered. It removes any padding previously added by gtk_cell_area_request_renderer(). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkWidget` that @area is rendering onto + the `GtkWidget` that @area is rendering onto - the @widget relative coordinates where one of @area’s cells + the @widget relative coordinates where one of @area’s cells is to be placed - the return location for the inner cell area + the return location for the inner cell area - Returns whether the area can do anything when activated, + Returns whether the area can do anything when activated, after applying new attributes to @area. + - whether @area can do anything when activated. + whether @area can do anything when activated. - a `GtkCellArea` + a `GtkCellArea` - Returns whether @sibling is one of @renderer’s focus siblings + Returns whether @sibling is one of @renderer’s focus siblings (see gtk_cell_area_add_focus_sibling()). + - %TRUE if @sibling is a focus sibling of @renderer + %TRUE if @sibling is a focus sibling of @renderer - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` expected to have focus + the `GtkCellRenderer` expected to have focus - the `GtkCellRenderer` to check against @renderer’s sibling list + the `GtkCellRenderer` to check against @renderer’s sibling list - Removes @renderer from @area. + Removes @renderer from @area. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to remove from @area + the `GtkCellRenderer` to remove from @area - Removes @sibling from @renderer’s focus sibling list + Removes @sibling from @renderer’s focus sibling list (see gtk_cell_area_add_focus_sibling()). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` expected to have focus + the `GtkCellRenderer` expected to have focus - the `GtkCellRenderer` to remove from @renderer’s focus area + the `GtkCellRenderer` to remove from @renderer’s focus area - This is a convenience function for `GtkCellArea` implementations + This is a convenience function for `GtkCellArea` implementations to request size for cell renderers. It’s important to use this function to request size and then use gtk_cell_area_inner_cell_area() at render and event time since this function will add padding around the cell for focus painting. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to request size for + the `GtkCellRenderer` to request size for - the `GtkOrientation` in which to request size + the `GtkOrientation` in which to request size - the `GtkWidget` that @area is rendering onto + the `GtkWidget` that @area is rendering onto - the allocation contextual size to request for, or -1 if + the allocation contextual size to request for, or -1 if the base request for the orientation is to be returned. - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - Explicitly sets the currently focused cell to @renderer. + Explicitly sets the currently focused cell to @renderer. This is generally called by implementations of `GtkCellAreaClass.focus()` or `GtkCellAreaClass.event()`, however it can also be used to implement functions such as gtk_tree_view_set_cursor_on_cell(). + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to give focus to + the `GtkCellRenderer` to give focus to - Snapshots @area’s cells according to @area’s layout onto at + Snapshots @area’s cells according to @area’s layout onto at the given coordinates. + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the `GtkSnapshot` to draw to + the `GtkSnapshot` to draw to - the @widget relative coordinates for @area’s background + the @widget relative coordinates for @area’s background - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the `GtkCellRenderer`State for @area in this row. + the `GtkCellRenderer`State for @area in this row. - whether @area should paint focus on focused cells for focused rows or not. + whether @area should paint focus on focused cells for focused rows or not. - Explicitly stops the editing of the currently edited cell. + Explicitly stops the editing of the currently edited cell. If @canceled is %TRUE, the currently edited cell renderer will emit the ::editing-canceled signal, otherwise the @@ -12321,93 +12899,94 @@ the ::editing-done signal will be emitted on the current edit widget. See gtk_cell_area_get_edited_cell() and gtk_cell_area_get_edit_widget(). + - a `GtkCellArea` + a `GtkCellArea` - whether editing was canceled. + whether editing was canceled. - The widget currently editing the edited cell + The widget currently editing the edited cell This property is read-only and only changes as a result of a call gtk_cell_area_activate_cell(). - The cell in the area that is currently edited + The cell in the area that is currently edited This property is read-only and only changes as a result of a call gtk_cell_area_activate_cell(). - The cell in the area that currently has focus + The cell in the area that currently has focus - Indicates that editing has started on @renderer and that @editable + Indicates that editing has started on @renderer and that @editable should be added to the owning cell-layouting widget at @cell_area. - the `GtkCellRenderer` that started the edited + the `GtkCellRenderer` that started the edited - the `GtkCellEditable` widget to add + the `GtkCellEditable` widget to add - the `GtkWidget` relative `GdkRectangle` coordinates + the `GtkWidget` relative `GdkRectangle` coordinates where @editable should be added - the `GtkTreePath` string this edit was initiated for + the `GtkTreePath` string this edit was initiated for - This signal is emitted whenever applying attributes to @area from @model + This signal is emitted whenever applying attributes to @area from @model - the `GtkTreeModel` to apply the attributes from + the `GtkTreeModel` to apply the attributes from - the `GtkTreeIter` indicating which row to apply the attributes of + the `GtkTreeIter` indicating which row to apply the attributes of - whether the view shows children for this row + whether the view shows children for this row - whether the view is currently showing the children of this row + whether the view is currently showing the children of this row - Indicates that focus changed on this @area. This signal + Indicates that focus changed on this @area. This signal is emitted either as a result of focus handling or event handling. @@ -12420,35 +12999,35 @@ same cell area for a different row of data. - the `GtkCellRenderer` that has focus + the `GtkCellRenderer` that has focus - the current `GtkTreePath` string set for @area + the current `GtkTreePath` string set for @area - Indicates that editing finished on @renderer and that @editable + Indicates that editing finished on @renderer and that @editable should be removed from the owning cell-layouting widget. - the `GtkCellRenderer` that finished editeding + the `GtkCellRenderer` that finished editeding - the `GtkCellEditable` widget to remove + the `GtkCellEditable` widget to remove - A cell area that renders GtkCellRenderers into a row or a column + A cell area that renders GtkCellRenderers into a row or a column The `GtkCellAreaBox` renders cell renderers into a row or a column depending on its `GtkOrientation`. @@ -12471,126 +13050,133 @@ argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end(). - Creates a new `GtkCellAreaBox`. + Creates a new `GtkCellAreaBox`. + - a newly created `GtkCellAreaBox` + a newly created `GtkCellAreaBox` - Gets the spacing added between cell renderers. + Gets the spacing added between cell renderers. + - the space added between cell renderers in @box. + the space added between cell renderers in @box. - a `GtkCellAreaBox` + a `GtkCellAreaBox` - Adds @renderer to @box, packed with reference to the end of @box. + Adds @renderer to @box, packed with reference to the end of @box. The @renderer is packed after (away from end of) any other `GtkCellRenderer` packed with reference to the end of @box. + - a `GtkCellAreaBox` + a `GtkCellAreaBox` - the `GtkCellRenderer` to add + the `GtkCellRenderer` to add - whether @renderer should receive extra space when the area receives + whether @renderer should receive extra space when the area receives more than its natural size - whether @renderer should be aligned in adjacent rows + whether @renderer should be aligned in adjacent rows - whether @renderer should have the same size in all rows + whether @renderer should have the same size in all rows - Adds @renderer to @box, packed with reference to the start of @box. + Adds @renderer to @box, packed with reference to the start of @box. The @renderer is packed after any other `GtkCellRenderer` packed with reference to the start of @box. + - a `GtkCellAreaBox` + a `GtkCellAreaBox` - the `GtkCellRenderer` to add + the `GtkCellRenderer` to add - whether @renderer should receive extra space when the area receives + whether @renderer should receive extra space when the area receives more than its natural size - whether @renderer should be aligned in adjacent rows + whether @renderer should be aligned in adjacent rows - whether @renderer should have the same size in all rows + whether @renderer should have the same size in all rows - Sets the spacing to add between cell renderers in @box. + Sets the spacing to add between cell renderers in @box. + - a `GtkCellAreaBox` + a `GtkCellAreaBox` - the space to add between `GtkCellRenderer`s + the space to add between `GtkCellRenderer`s - The amount of space to reserve between cells. + The amount of space to reserve between cells. + + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to add to @area + the `GtkCellRenderer` to add to @area @@ -12598,16 +13184,17 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellRenderer` to remove from @area + the `GtkCellRenderer` to remove from @area @@ -12615,20 +13202,21 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellCallback` to call + the `GtkCellCallback` to call - user provided data pointer + user provided data pointer @@ -12636,36 +13224,37 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the @widget relative coordinates and size for @area + the @widget relative coordinates and size for @area - the @widget relative coordinates of the background area + the @widget relative coordinates of the background area - the `GtkCellAllocCallback` to call + the `GtkCellAllocCallback` to call - user provided data pointer + user provided data pointer @@ -12673,33 +13262,34 @@ more than its natural size + - %TRUE if the event was handled by @area. + %TRUE if the event was handled by @area. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the `GdkEvent` to handle + the `GdkEvent` to handle - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the `GtkCellRenderer`State for @area in this row. + the `GtkCellRenderer`State for @area in this row. @@ -12707,40 +13297,41 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context for this row of data. + the `GtkCellArea`Context for this row of data. - the `GtkWidget` that @area is rendering to + the `GtkWidget` that @area is rendering to - the `GtkSnapshot` to draw to + the `GtkSnapshot` to draw to - the @widget relative coordinates for @area’s background + the @widget relative coordinates for @area’s background - the @widget relative coordinates for @area + the @widget relative coordinates for @area - the `GtkCellRenderer`State for @area in this row. + the `GtkCellRenderer`State for @area in this row. - whether @area should paint focus on focused cells for focused rows or not. + whether @area should paint focus on focused cells for focused rows or not. @@ -12748,28 +13339,29 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkTreeModel` to pull values from + the `GtkTreeModel` to pull values from - the `GtkTreeIter` in @tree_model to apply values for + the `GtkTreeIter` in @tree_model to apply values for - whether @iter has children + whether @iter has children - whether @iter is expanded in the view and + whether @iter is expanded in the view and children are visible @@ -12778,13 +13370,14 @@ more than its natural size + - a newly created `GtkCellArea`Context which can be used with @area. + a newly created `GtkCellArea`Context which can be used with @area. - a `GtkCellArea` + a `GtkCellArea` @@ -12792,17 +13385,18 @@ more than its natural size + - a newly created `GtkCellArea`Context copy of @context. + a newly created `GtkCellArea`Context copy of @context. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to copy + the `GtkCellArea`Context to copy @@ -12810,13 +13404,14 @@ more than its natural size + - The `GtkSizeRequestMode` preferred by @area. + The `GtkSizeRequestMode` preferred by @area. - a `GtkCellArea` + a `GtkCellArea` @@ -12824,28 +13419,29 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to perform this request with + the `GtkCellArea`Context to perform this request with - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width @@ -12853,32 +13449,33 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context which has already been requested for widths. + the `GtkCellArea`Context which has already been requested for widths. - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - the width for which to check the height of this area + the width for which to check the height of this area - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height @@ -12886,28 +13483,29 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context to perform this request with + the `GtkCellArea`Context to perform this request with - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height @@ -12915,32 +13513,33 @@ more than its natural size + - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context which has already been requested for widths. + the `GtkCellArea`Context which has already been requested for widths. - the `GtkWidget` where @area will be rendering + the `GtkWidget` where @area will be rendering - the height for which to check the width of this area + the height for which to check the width of this area - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width @@ -12948,6 +13547,7 @@ more than its natural size + @@ -12972,6 +13572,7 @@ more than its natural size + @@ -12996,17 +13597,18 @@ more than its natural size + - %TRUE if focus remains inside @area as a result of this call. + %TRUE if focus remains inside @area as a result of this call. - a `GtkCellArea` + a `GtkCellArea` - the `GtkDirectionType` + the `GtkDirectionType` @@ -13014,13 +13616,14 @@ more than its natural size + - whether @area can do anything when activated. + whether @area can do anything when activated. - a `GtkCellArea` + a `GtkCellArea` @@ -13028,33 +13631,34 @@ more than its natural size + - Whether @area was successfully activated. + Whether @area was successfully activated. - a `GtkCellArea` + a `GtkCellArea` - the `GtkCellArea`Context in context with the current row data + the `GtkCellArea`Context in context with the current row data - the `GtkWidget` that @area is rendering on + the `GtkWidget` that @area is rendering on - the size and location of @area relative to @widget’s allocation + the size and location of @area relative to @widget’s allocation - the `GtkCellRenderer`State flags for @area for this row of data. + the `GtkCellRenderer`State flags for @area for this row of data. - if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE + if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE will be activated. @@ -13067,46 +13671,49 @@ more than its natural size - Finds a cell property of a cell area class by name. + Finds a cell property of a cell area class by name. + - the `GParamSpec` of the child property + the `GParamSpec` of the child property - a `GtkCellAreaClass` + a `GtkCellAreaClass` - the name of the child property to find + the name of the child property to find - Installs a cell property on a cell area class. + Installs a cell property on a cell area class. + - a `GtkCellAreaClass` + a `GtkCellAreaClass` - the id for the property + the id for the property - the `GParamSpec` for the property + the `GParamSpec` for the property - Returns all cell properties of a cell area class. + Returns all cell properties of a cell area class. + - a newly + a newly allocated %NULL-terminated array of `GParamSpec`*. The array must be freed with g_free(). @@ -13115,18 +13722,18 @@ more than its natural size - a `GtkCellAreaClass` + a `GtkCellAreaClass` - location to return the number of cell properties found + location to return the number of cell properties found - Stores geometrical information for a series of rows in a GtkCellArea + Stores geometrical information for a series of rows in a GtkCellArea The `GtkCellAreaContext` object is created by a given `GtkCellArea` implementation via its `GtkCellAreaClass.create_context()` virtual @@ -13138,8 +13745,9 @@ request and render groups of data rows. However, it’s important that the same context which was used to request sizes for a given `GtkTreeModel` row also be used for the same row when calling other `GtkCellArea` APIs such as gtk_cell_area_render() and gtk_cell_area_event(). + - Allocates a width and/or a height for all rows which are to be + Allocates a width and/or a height for all rows which are to be rendered with @context. Usually allocation is performed only horizontally or sometimes @@ -13149,84 +13757,87 @@ or the same height. Sometimes they are allocated in both horizontal and vertical orientations producing a homogeneous effect of the rows. This is generally the case for `GtkTreeView` when `GtkTreeView:fixed-height-mode` is enabled. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - the allocated width for all `GtkTreeModel` rows rendered + the allocated width for all `GtkTreeModel` rows rendered with @context, or -1 - the allocated height for all `GtkTreeModel` rows rendered + the allocated height for all `GtkTreeModel` rows rendered with @context, or -1 - Gets the accumulative preferred height for @width for all rows + Gets the accumulative preferred height for @width for all rows which have been requested for the same said @width with this context. After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a `GtkCellArea`, the returned values are -1. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - a proposed width for allocation + a proposed width for allocation - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Gets the accumulative preferred width for @height for all rows which + Gets the accumulative preferred width for @height for all rows which have been requested for the same said @height with this context. After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a `GtkCellArea`, the returned values are -1. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - a proposed height for allocation + a proposed height for allocation - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Resets any previously cached request and allocation + Resets any previously cached request and allocation data. When underlying `GtkTreeModel` data changes its @@ -13248,18 +13859,19 @@ the same width from top to bottom then a change in the allocated width necessitates a recalculation of all the displayed row heights using gtk_cell_area_get_preferred_height_for_width(). + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - Allocates a width and/or a height for all rows which are to be + Allocates a width and/or a height for all rows which are to be rendered with @context. Usually allocation is performed only horizontally or sometimes @@ -13269,52 +13881,54 @@ or the same height. Sometimes they are allocated in both horizontal and vertical orientations producing a homogeneous effect of the rows. This is generally the case for `GtkTreeView` when `GtkTreeView:fixed-height-mode` is enabled. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - the allocated width for all `GtkTreeModel` rows rendered + the allocated width for all `GtkTreeModel` rows rendered with @context, or -1 - the allocated height for all `GtkTreeModel` rows rendered + the allocated height for all `GtkTreeModel` rows rendered with @context, or -1 - Fetches the current allocation size for @context. + Fetches the current allocation size for @context. If the context was not allocated in width or height, or if the context was recently reset with gtk_cell_area_context_reset(), the returned value will be -1. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - location to store the allocated width + location to store the allocated width - location to store the allocated height + location to store the allocated height - Fetches the `GtkCellArea` this @context was created by. + Fetches the `GtkCellArea` this @context was created by. This is generally unneeded by layouting widgets; however, it is important for the context implementation itself to @@ -13324,175 +13938,182 @@ For instance at `GtkCellAreaContextClass.allocate()` time it’s important to know details about any cell spacing that the `GtkCellArea` is configured with in order to compute a proper allocation. + - the `GtkCellArea` this context was created by. + the `GtkCellArea` this context was created by. - a `GtkCellAreaContext` + a `GtkCellAreaContext` - Gets the accumulative preferred height for all rows which have been + Gets the accumulative preferred height for all rows which have been requested with this context. After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a `GtkCellArea`, the returned values are 0. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Gets the accumulative preferred height for @width for all rows + Gets the accumulative preferred height for @width for all rows which have been requested for the same said @width with this context. After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a `GtkCellArea`, the returned values are -1. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - a proposed width for allocation + a proposed width for allocation - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height - Gets the accumulative preferred width for all rows which have been + Gets the accumulative preferred width for all rows which have been requested with this context. After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a `GtkCellArea`, the returned values are 0. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Gets the accumulative preferred width for @height for all rows which + Gets the accumulative preferred width for @height for all rows which have been requested for the same said @height with this context. After gtk_cell_area_context_reset() is called and/or before ever requesting the size of a `GtkCellArea`, the returned values are -1. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - a proposed height for allocation + a proposed height for allocation - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width - Causes the minimum and/or natural height to grow if the new + Causes the minimum and/or natural height to grow if the new proposed sizes exceed the current minimum and natural height. This is used by `GtkCellAreaContext` implementations during the request process over a series of `GtkTreeModel` rows to progressively push the requested height over a series of gtk_cell_area_get_preferred_height() requests. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - the proposed new minimum height for @context + the proposed new minimum height for @context - the proposed new natural height for @context + the proposed new natural height for @context - Causes the minimum and/or natural width to grow if the new + Causes the minimum and/or natural width to grow if the new proposed sizes exceed the current minimum and natural width. This is used by `GtkCellAreaContext` implementations during the request process over a series of `GtkTreeModel` rows to progressively push the requested width over a series of gtk_cell_area_get_preferred_width() requests. + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - the proposed new minimum width for @context + the proposed new minimum width for @context - the proposed new natural width for @context + the proposed new natural width for @context - Resets any previously cached request and allocation + Resets any previously cached request and allocation data. When underlying `GtkTreeModel` data changes its @@ -13514,40 +14135,41 @@ the same width from top to bottom then a change in the allocated width necessitates a recalculation of all the displayed row heights using gtk_cell_area_get_preferred_height_for_width(). + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - The `GtkCellArea` this context was created by + The `GtkCellArea` this context was created by - The minimum height for the `GtkCellArea` in this context + The minimum height for the `GtkCellArea` in this context for all `GtkTreeModel` rows that this context was requested for using gtk_cell_area_get_preferred_height(). - The minimum width for the `GtkCellArea` in this context + The minimum width for the `GtkCellArea` in this context for all `GtkTreeModel` rows that this context was requested for using gtk_cell_area_get_preferred_width(). - The natural height for the `GtkCellArea` in this context + The natural height for the `GtkCellArea` in this context for all `GtkTreeModel` rows that this context was requested for using gtk_cell_area_get_preferred_height(). - The natural width for the `GtkCellArea` in this context + The natural width for the `GtkCellArea` in this context for all `GtkTreeModel` rows that this context was requested for using gtk_cell_area_get_preferred_width(). @@ -13557,26 +14179,28 @@ for using gtk_cell_area_get_preferred_width(). + + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - the allocated width for all `GtkTreeModel` rows rendered + the allocated width for all `GtkTreeModel` rows rendered with @context, or -1 - the allocated height for all `GtkTreeModel` rows rendered + the allocated height for all `GtkTreeModel` rows rendered with @context, or -1 @@ -13585,12 +14209,13 @@ for using gtk_cell_area_get_preferred_width(). + - a `GtkCellAreaContext` + a `GtkCellAreaContext` @@ -13598,24 +14223,25 @@ for using gtk_cell_area_get_preferred_width(). + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - a proposed width for allocation + a proposed width for allocation - location to store the minimum height + location to store the minimum height - location to store the natural height + location to store the natural height @@ -13623,24 +14249,25 @@ for using gtk_cell_area_get_preferred_width(). + - a `GtkCellAreaContext` + a `GtkCellAreaContext` - a proposed height for allocation + a proposed height for allocation - location to store the minimum width + location to store the minimum width - location to store the natural width + location to store the natural width @@ -13652,58 +14279,64 @@ for using gtk_cell_area_get_preferred_width(). - + + + - The type of the callback functions used for iterating over + The type of the callback functions used for iterating over the cell renderers of a `GtkCellArea`, see gtk_cell_area_foreach(). + - %TRUE to stop iterating over cells. + %TRUE to stop iterating over cells. - the cell renderer to operate on + the cell renderer to operate on - user-supplied data + user-supplied data - Interface for widgets that can be used for editing cells + Interface for widgets that can be used for editing cells The `GtkCellEditable` interface must be implemented for widgets to be usable to edit the contents of a `GtkTreeView` cell. It provides a way to specify how temporary widgets should be configured for editing, get the new value, etc. + - Emits the `GtkCellEditable::editing-done` signal. + Emits the `GtkCellEditable::editing-done` signal. + - A `GtkCellEditable` + A `GtkCellEditable` - Emits the `GtkCellEditable::remove-widget` signal. + Emits the `GtkCellEditable::remove-widget` signal. + - A `GtkCellEditable` + A `GtkCellEditable` - Begins editing on a @cell_editable. + Begins editing on a @cell_editable. The `GtkCellRenderer` for the cell creates and returns a `GtkCellEditable` from gtk_cell_renderer_start_editing(), configured for the `GtkCellRenderer` type. @@ -13713,47 +14346,50 @@ editing a cell, e.g. making the Esc key emit `GtkCellEditable::editing-done`. Note that the @cell_editable is created on-demand for the current edit; its lifetime is temporary and does not persist across other edits and/or cells. + - A `GtkCellEditable` + A `GtkCellEditable` - The `GdkEvent` that began the editing process, or + The `GdkEvent` that began the editing process, or %NULL if editing was initiated programmatically - Emits the `GtkCellEditable::editing-done` signal. + Emits the `GtkCellEditable::editing-done` signal. + - A `GtkCellEditable` + A `GtkCellEditable` - Emits the `GtkCellEditable::remove-widget` signal. + Emits the `GtkCellEditable::remove-widget` signal. + - A `GtkCellEditable` + A `GtkCellEditable` - Begins editing on a @cell_editable. + Begins editing on a @cell_editable. The `GtkCellRenderer` for the cell creates and returns a `GtkCellEditable` from gtk_cell_renderer_start_editing(), configured for the `GtkCellRenderer` type. @@ -13763,27 +14399,28 @@ editing a cell, e.g. making the Esc key emit `GtkCellEditable::editing-done`. Note that the @cell_editable is created on-demand for the current edit; its lifetime is temporary and does not persist across other edits and/or cells. + - A `GtkCellEditable` + A `GtkCellEditable` - The `GdkEvent` that began the editing process, or + The `GdkEvent` that began the editing process, or %NULL if editing was initiated programmatically - Indicates whether editing on the cell has been canceled. + Indicates whether editing on the cell has been canceled. - This signal is a sign for the cell renderer to update its + This signal is a sign for the cell renderer to update its value from the @cell_editable. Implementations of `GtkCellEditable` are responsible for @@ -13799,7 +14436,7 @@ for emitting `GtkCellEditable::editing-done`. - This signal is meant to indicate that the cell is finished + This signal is meant to indicate that the cell is finished editing, and the @cell_editable widget is being removed and may subsequently be destroyed. @@ -13817,17 +14454,19 @@ for emitting `GtkCellEditable::remove-widget`. + + - A `GtkCellEditable` + A `GtkCellEditable` @@ -13835,12 +14474,13 @@ for emitting `GtkCellEditable::remove-widget`. + - A `GtkCellEditable` + A `GtkCellEditable` @@ -13848,16 +14488,17 @@ for emitting `GtkCellEditable::remove-widget`. + - A `GtkCellEditable` + A `GtkCellEditable` - The `GdkEvent` that began the editing process, or + The `GdkEvent` that began the editing process, or %NULL if editing was initiated programmatically @@ -13866,7 +14507,7 @@ for emitting `GtkCellEditable::remove-widget`. - An interface for packing cells + An interface for packing cells `GtkCellLayout` is an interface to be implemented by all objects which want to provide a `GtkTreeViewColumn` like API for packing cells, @@ -13971,85 +14612,91 @@ not important, then this does not have to concern you. If you want to support alternative cell areas, you can do so by moving the problematic calls out of init() and into a constructor() for your class. + - Adds an attribute mapping to the list in @cell_layout. + Adds an attribute mapping to the list in @cell_layout. The @column is the column of the model to get a value from, and the @attribute is the property on @cell to be set from that value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a `GtkCellRendererText` get its values from column 2. In this context "attribute" and "property" are used interchangeably. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - a property on the renderer + a property on the renderer - the column position on the model to get the attribute from + the column position on the model to get the attribute from - Unsets all the mappings on all renderers on @cell_layout and + Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout. + - a `GtkCellLayout` + a `GtkCellLayout` - Clears all existing attributes previously set with + Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` to clear the attribute mapping on + a `GtkCellRenderer` to clear the attribute mapping on - Returns the underlying `GtkCellArea` which might be @cell_layout + Returns the underlying `GtkCellArea` which might be @cell_layout if called on a `GtkCellArea` or might be %NULL if no `GtkCellArea` is used by @cell_layout. + - the cell area used by @cell_layout + the cell area used by @cell_layout - a `GtkCellLayout` + a `GtkCellLayout` - Returns the cell renderers which have been added to @cell_layout. + Returns the cell renderers which have been added to @cell_layout. + - + a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. @@ -14059,195 +14706,204 @@ is used by @cell_layout. - a `GtkCellLayout` + a `GtkCellLayout` - Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the + Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. Note that reusing the same cell renderer is not supported. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, + Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. Note that reusing the same cell renderer is not supported. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - Re-inserts @cell at @position. + Re-inserts @cell at @position. Note that @cell has already to be packed into @cell_layout for this to function properly. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` to reorder + a `GtkCellRenderer` to reorder - new position to insert @cell at + new position to insert @cell at - Sets the `GtkCellLayout`DataFunc to use for @cell_layout. + Sets the `GtkCellLayout`DataFunc to use for @cell_layout. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of @cell_layout’s cell renderer(s) as appropriate. @func may be %NULL to remove a previously set function. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - the `GtkCellLayout`DataFunc to use + the `GtkCellLayout`DataFunc to use - user data for @func + user data for @func - destroy notify for @func_data + destroy notify for @func_data - Adds an attribute mapping to the list in @cell_layout. + Adds an attribute mapping to the list in @cell_layout. The @column is the column of the model to get a value from, and the @attribute is the property on @cell to be set from that value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a `GtkCellRendererText` get its values from column 2. In this context "attribute" and "property" are used interchangeably. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - a property on the renderer + a property on the renderer - the column position on the model to get the attribute from + the column position on the model to get the attribute from - Unsets all the mappings on all renderers on @cell_layout and + Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout. + - a `GtkCellLayout` + a `GtkCellLayout` - Clears all existing attributes previously set with + Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` to clear the attribute mapping on + a `GtkCellRenderer` to clear the attribute mapping on - Returns the underlying `GtkCellArea` which might be @cell_layout + Returns the underlying `GtkCellArea` which might be @cell_layout if called on a `GtkCellArea` or might be %NULL if no `GtkCellArea` is used by @cell_layout. + - the cell area used by @cell_layout + the cell area used by @cell_layout - a `GtkCellLayout` + a `GtkCellLayout` - Returns the cell renderers which have been added to @cell_layout. + Returns the cell renderers which have been added to @cell_layout. + - + a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. @@ -14257,84 +14913,87 @@ is used by @cell_layout. - a `GtkCellLayout` + a `GtkCellLayout` - Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the + Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. Note that reusing the same cell renderer is not supported. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, + Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. Note that reusing the same cell renderer is not supported. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout - Re-inserts @cell at @position. + Re-inserts @cell at @position. Note that @cell has already to be packed into @cell_layout for this to function properly. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` to reorder + a `GtkCellRenderer` to reorder - new position to insert @cell at + new position to insert @cell at - Sets the attributes in the parameter list as the attributes + Sets the attributes in the parameter list as the attributes of @cell_layout. See [method@Gtk.CellLayout.add_attribute] for more details. @@ -14342,108 +15001,113 @@ See [method@Gtk.CellLayout.add_attribute] for more details. The attributes should be in attribute/column order, as in gtk_cell_layout_add_attribute(). All existing attributes are removed, and replaced with the new attributes. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - a %NULL-terminated list of attributes + a %NULL-terminated list of attributes - Sets the `GtkCellLayout`DataFunc to use for @cell_layout. + Sets the `GtkCellLayout`DataFunc to use for @cell_layout. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of @cell_layout’s cell renderer(s) as appropriate. @func may be %NULL to remove a previously set function. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - the `GtkCellLayout`DataFunc to use + the `GtkCellLayout`DataFunc to use - user data for @func + user data for @func - destroy notify for @func_data + destroy notify for @func_data - A function which should set the value of @cell_layout’s cell renderer(s) + A function which should set the value of @cell_layout’s cell renderer(s) as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` - the cell renderer whose value is to be set + the cell renderer whose value is to be set - the model + the model - a `GtkTreeIter` indicating the row to set the value for + a `GtkTreeIter` indicating the row to set the value for - user data passed to gtk_cell_layout_set_cell_data_func() + user data passed to gtk_cell_layout_set_cell_data_func() + + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout @@ -14451,20 +15115,21 @@ as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @cell_layout + %TRUE if @cell is to be given extra space allocated to @cell_layout @@ -14472,12 +15137,13 @@ as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` @@ -14485,24 +15151,25 @@ as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - a property on the renderer + a property on the renderer - the column position on the model to get the attribute from + the column position on the model to get the attribute from @@ -14510,28 +15177,29 @@ as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` + a `GtkCellRenderer` - the `GtkCellLayout`DataFunc to use + the `GtkCellLayout`DataFunc to use - user data for @func + user data for @func - destroy notify for @func_data + destroy notify for @func_data @@ -14539,16 +15207,17 @@ as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` to clear the attribute mapping on + a `GtkCellRenderer` to clear the attribute mapping on @@ -14556,20 +15225,21 @@ as appropriate. + - a `GtkCellLayout` + a `GtkCellLayout` - a `GtkCellRenderer` to reorder + a `GtkCellRenderer` to reorder - new position to insert @cell at + new position to insert @cell at @@ -14577,8 +15247,9 @@ as appropriate. + - + a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. @@ -14588,7 +15259,7 @@ as appropriate. - a `GtkCellLayout` + a `GtkCellLayout` @@ -14596,13 +15267,14 @@ as appropriate. + - the cell area used by @cell_layout + the cell area used by @cell_layout - a `GtkCellLayout` + a `GtkCellLayout` @@ -14610,7 +15282,7 @@ as appropriate. - An object for rendering a single cell + An object for rendering a single cell The `GtkCellRenderer` is a base class of a set of objects used for rendering a cell to a `cairo_t`. These objects are used primarily by @@ -14647,47 +15319,50 @@ Many properties of `GtkCellRenderer` and its subclasses have a corresponding “set” property, e.g. “cell-background-set” corresponds to “cell-background”. These “set” properties reflect whether a property has been set or not. You should not set them independently. + - Passes an activate event to the cell renderer for possible processing. + Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, `GtkCellRendererToggle` toggles when it gets a mouse click. + - %TRUE if the event was consumed/handled + %TRUE if the event was consumed/handled - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GdkEvent` + a `GdkEvent` - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for `GtkTreeView`, a string representation of `GtkTreePath` - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags + @@ -14698,6 +15373,7 @@ toggles when it gets a mouse click. + @@ -14714,818 +15390,853 @@ toggles when it gets a mouse click. - Gets the aligned area used by @cell inside @cell_area. Used for finding + Gets the aligned area used by @cell inside @cell_area. Used for finding the appropriate edit and focus rectangle. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - render flags + render flags - cell area which would be passed to gtk_cell_renderer_render() + cell area which would be passed to gtk_cell_renderer_render() - the return location for the space inside @cell_area + the return location for the space inside @cell_area that would actually be used to render. - Retrieves a renderer’s natural size when rendered to @widget. + Retrieves a renderer’s natural size when rendered to @widget. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - Retrieves a cell renderers’s minimum and natural height if it were rendered to + Retrieves a cell renderers’s minimum and natural height if it were rendered to @widget with the specified @width. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - location for storing the minimum size + location for storing the minimum size - location for storing the preferred size + location for storing the preferred size - Retrieves a renderer’s natural size when rendered to @widget. + Retrieves a renderer’s natural size when rendered to @widget. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - Retrieves a cell renderers’s minimum and natural width if it were rendered to + Retrieves a cell renderers’s minimum and natural width if it were rendered to @widget with the specified @height. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - location for storing the minimum size + location for storing the minimum size - location for storing the preferred size + location for storing the preferred size - Gets whether the cell renderer prefers a height-for-width layout + Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. + - The `GtkSizeRequestMode` preferred by this renderer. + The `GtkSizeRequestMode` preferred by this renderer. - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - Invokes the virtual render function of the `GtkCellRenderer`. The three + Invokes the virtual render function of the `GtkCellRenderer`. The three passed-in rectangles are areas in @cr. Most renderers will draw within @cell_area; the xalign, yalign, xpad, and ypad fields of the `GtkCellRenderer` should be honored with respect to @cell_area. @background_area includes the blank space around the cell, and also the area containing the tree expander; so the @background_area rectangles for all cells tile to cover the entire @window. + - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GtkSnapshot` to draw to + a `GtkSnapshot` to draw to - the widget owning @window + the widget owning @window - entire cell area (including tree expanders and maybe + entire cell area (including tree expanders and maybe padding on the sides) - area normally rendered by a cell renderer + area normally rendered by a cell renderer - flags that affect rendering + flags that affect rendering - Starts editing the contents of this @cell, through a new `GtkCellEditable` + Starts editing the contents of this @cell, through a new `GtkCellEditable` widget created by the `GtkCellRenderer`Class.start_editing virtual function. + - A new `GtkCellEditable` for editing this + A new `GtkCellEditable` for editing this @cell, or %NULL if editing is not possible - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GdkEvent` + a `GdkEvent` - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for `GtkTreeView`, a string representation of `GtkTreePath` - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags - Passes an activate event to the cell renderer for possible processing. + Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, `GtkCellRendererToggle` toggles when it gets a mouse click. + - %TRUE if the event was consumed/handled + %TRUE if the event was consumed/handled - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GdkEvent` + a `GdkEvent` - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for `GtkTreeView`, a string representation of `GtkTreePath` - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags - Gets the aligned area used by @cell inside @cell_area. Used for finding + Gets the aligned area used by @cell inside @cell_area. Used for finding the appropriate edit and focus rectangle. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - render flags + render flags - cell area which would be passed to gtk_cell_renderer_render() + cell area which would be passed to gtk_cell_renderer_render() - the return location for the space inside @cell_area + the return location for the space inside @cell_area that would actually be used to render. - Fills in @xalign and @yalign with the appropriate values of @cell. + Fills in @xalign and @yalign with the appropriate values of @cell. + - A `GtkCellRenderer` + A `GtkCellRenderer` - location to fill in with the x alignment of the cell + location to fill in with the x alignment of the cell - location to fill in with the y alignment of the cell + location to fill in with the y alignment of the cell - Fills in @width and @height with the appropriate size of @cell. + Fills in @width and @height with the appropriate size of @cell. + - A `GtkCellRenderer` + A `GtkCellRenderer` - location to fill in with the fixed width of the cell + location to fill in with the fixed width of the cell - location to fill in with the fixed height of the cell + location to fill in with the fixed height of the cell - Checks whether the given `GtkCellRenderer` is expanded. + Checks whether the given `GtkCellRenderer` is expanded. + - %TRUE if the cell renderer is expanded + %TRUE if the cell renderer is expanded - a `GtkCellRenderer` + a `GtkCellRenderer` - Checks whether the given `GtkCellRenderer` is an expander. + Checks whether the given `GtkCellRenderer` is an expander. + - %TRUE if @cell is an expander, and %FALSE otherwise + %TRUE if @cell is an expander, and %FALSE otherwise - a `GtkCellRenderer` + a `GtkCellRenderer` - Fills in @xpad and @ypad with the appropriate values of @cell. + Fills in @xpad and @ypad with the appropriate values of @cell. + - A `GtkCellRenderer` + A `GtkCellRenderer` - location to fill in with the x padding of the cell + location to fill in with the x padding of the cell - location to fill in with the y padding of the cell + location to fill in with the y padding of the cell - Retrieves a renderer’s natural size when rendered to @widget. + Retrieves a renderer’s natural size when rendered to @widget. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - Retrieves a cell renderers’s minimum and natural height if it were rendered to + Retrieves a cell renderers’s minimum and natural height if it were rendered to @widget with the specified @width. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - location for storing the minimum size + location for storing the minimum size - location for storing the preferred size + location for storing the preferred size - Retrieves the minimum and natural size of a cell taking + Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location for storing the minimum size + location for storing the minimum size - location for storing the natural size + location for storing the natural size - Retrieves a renderer’s natural size when rendered to @widget. + Retrieves a renderer’s natural size when rendered to @widget. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - Retrieves a cell renderers’s minimum and natural width if it were rendered to + Retrieves a cell renderers’s minimum and natural width if it were rendered to @widget with the specified @height. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - location for storing the minimum size + location for storing the minimum size - location for storing the preferred size + location for storing the preferred size - Gets whether the cell renderer prefers a height-for-width layout + Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. + - The `GtkSizeRequestMode` preferred by this renderer. + The `GtkSizeRequestMode` preferred by this renderer. - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - Returns the cell renderer’s sensitivity. + Returns the cell renderer’s sensitivity. + - %TRUE if the cell renderer is sensitive + %TRUE if the cell renderer is sensitive - A `GtkCellRenderer` + A `GtkCellRenderer` - Translates the cell renderer state to `GtkStateFlags`, + Translates the cell renderer state to `GtkStateFlags`, based on the cell renderer and widget sensitivity, and the given `GtkCellRenderer`State. + - the widget state flags applying to @cell + the widget state flags applying to @cell - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GtkWidget` + a `GtkWidget` - cell renderer state + cell renderer state - Returns the cell renderer’s visibility. + Returns the cell renderer’s visibility. + - %TRUE if the cell renderer is visible + %TRUE if the cell renderer is visible - A `GtkCellRenderer` + A `GtkCellRenderer` - Checks whether the cell renderer can do something when activated. + Checks whether the cell renderer can do something when activated. + - %TRUE if the cell renderer can do anything when activated + %TRUE if the cell renderer can do anything when activated - A `GtkCellRenderer` + A `GtkCellRenderer` - Sets the renderer’s alignment within its available space. + Sets the renderer’s alignment within its available space. + - A `GtkCellRenderer` + A `GtkCellRenderer` - the x alignment of the cell renderer + the x alignment of the cell renderer - the y alignment of the cell renderer + the y alignment of the cell renderer - Sets the renderer size to be explicit, independent of the properties set. + Sets the renderer size to be explicit, independent of the properties set. + - A `GtkCellRenderer` + A `GtkCellRenderer` - the width of the cell renderer, or -1 + the width of the cell renderer, or -1 - the height of the cell renderer, or -1 + the height of the cell renderer, or -1 - Sets whether the given `GtkCellRenderer` is expanded. + Sets whether the given `GtkCellRenderer` is expanded. + - a `GtkCellRenderer` + a `GtkCellRenderer` - whether @cell should be expanded + whether @cell should be expanded - Sets whether the given `GtkCellRenderer` is an expander. + Sets whether the given `GtkCellRenderer` is an expander. + - a `GtkCellRenderer` + a `GtkCellRenderer` - whether @cell is an expander + whether @cell is an expander - Sets the renderer’s padding. + Sets the renderer’s padding. + - A `GtkCellRenderer` + A `GtkCellRenderer` - the x padding of the cell renderer + the x padding of the cell renderer - the y padding of the cell renderer + the y padding of the cell renderer - Sets the cell renderer’s sensitivity. + Sets the cell renderer’s sensitivity. + - A `GtkCellRenderer` + A `GtkCellRenderer` - the sensitivity of the cell + the sensitivity of the cell - Sets the cell renderer’s visibility. + Sets the cell renderer’s visibility. + - A `GtkCellRenderer` + A `GtkCellRenderer` - the visibility of the cell + the visibility of the cell - Invokes the virtual render function of the `GtkCellRenderer`. The three + Invokes the virtual render function of the `GtkCellRenderer`. The three passed-in rectangles are areas in @cr. Most renderers will draw within @cell_area; the xalign, yalign, xpad, and ypad fields of the `GtkCellRenderer` should be honored with respect to @cell_area. @background_area includes the blank space around the cell, and also the area containing the tree expander; so the @background_area rectangles for all cells tile to cover the entire @window. + - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GtkSnapshot` to draw to + a `GtkSnapshot` to draw to - the widget owning @window + the widget owning @window - entire cell area (including tree expanders and maybe + entire cell area (including tree expanders and maybe padding on the sides) - area normally rendered by a cell renderer + area normally rendered by a cell renderer - flags that affect rendering + flags that affect rendering - Starts editing the contents of this @cell, through a new `GtkCellEditable` + Starts editing the contents of this @cell, through a new `GtkCellEditable` widget created by the `GtkCellRenderer`Class.start_editing virtual function. + - A new `GtkCellEditable` for editing this + A new `GtkCellEditable` for editing this @cell, or %NULL if editing is not possible - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GdkEvent` + a `GdkEvent` - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for `GtkTreeView`, a string representation of `GtkTreePath` - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags - Informs the cell renderer that the editing is stopped. + Informs the cell renderer that the editing is stopped. If @canceled is %TRUE, the cell renderer will emit the `GtkCellRenderer`::editing-canceled signal. This function should be called by cell renderer implementations in response to the `GtkCellEditable::editing-done` signal of `GtkCellEditable`. + - A `GtkCellRenderer` + A `GtkCellRenderer` - %TRUE if the editing has been canceled + %TRUE if the editing has been canceled @@ -15534,7 +16245,7 @@ in response to the `GtkCellEditable::editing-done` signal of - Cell background as a `GdkRGBA` + Cell background as a `GdkRGBA` @@ -15583,7 +16294,7 @@ in response to the `GtkCellEditable::editing-done` signal of - This signal gets emitted when the user cancels the process of editing a + This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape. @@ -15593,7 +16304,7 @@ See also: gtk_cell_renderer_stop_editing(). - This signal gets emitted when a cell starts to be edited. + This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on @editable, e.g. adding a `GtkEntryCompletion` or setting up additional columns in a `GtkComboBox`. @@ -15627,112 +16338,115 @@ text_editing_started (GtkCellRenderer *cell, - the `GtkCellEditable` + the `GtkCellEditable` - the path identifying the edited cell + the path identifying the edited cell - Renders a keyboard accelerator in a cell + Renders a keyboard accelerator in a cell `GtkCellRendererAccel` displays a keyboard accelerator (i.e. a key combination like `Control + a`). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination. - Creates a new `GtkCellRendererAccel`. + Creates a new `GtkCellRendererAccel`. + - the new cell renderer + the new cell renderer - The keyval of the accelerator. + The keyval of the accelerator. - Determines if the edited accelerators are GTK accelerators. If + Determines if the edited accelerators are GTK accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK are allowed, and the accelerators are rendered in the same way as they are in menus. - The modifier mask of the accelerator. + The modifier mask of the accelerator. - The hardware keycode of the accelerator. Note that the hardware keycode is + The hardware keycode of the accelerator. Note that the hardware keycode is only relevant if the key does not have a keyval. Normally, the keyboard configuration should assign keyvals to all keys. - Gets emitted when the user has removed the accelerator. + Gets emitted when the user has removed the accelerator. - the path identifying the row of the edited cell + the path identifying the row of the edited cell - Gets emitted when the user has selected a new accelerator. + Gets emitted when the user has selected a new accelerator. - the path identifying the row of the edited cell + the path identifying the row of the edited cell - the new accelerator keyval + the new accelerator keyval - the new acclerator modifier mask + the new acclerator modifier mask - the keycode of the new accelerator + the keycode of the new accelerator - Determines if the edited accelerators are GTK accelerators. If + Determines if the edited accelerators are GTK accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK are allowed, and the accelerators are rendered in the same way as they are in menus. - GTK accelerators mode + GTK accelerators mode - Other accelerator mode + Other accelerator mode + + - The `GtkSizeRequestMode` preferred by this renderer. + The `GtkSizeRequestMode` preferred by this renderer. - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance @@ -15740,24 +16454,25 @@ in the same way as they are in menus. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size @@ -15765,28 +16480,29 @@ in the same way as they are in menus. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - location for storing the minimum size + location for storing the minimum size - location for storing the preferred size + location for storing the preferred size @@ -15794,24 +16510,25 @@ in the same way as they are in menus. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size @@ -15819,28 +16536,29 @@ in the same way as they are in menus. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - the size which is available for allocation + the size which is available for allocation - location for storing the minimum size + location for storing the minimum size - location for storing the preferred size + location for storing the preferred size @@ -15848,28 +16566,29 @@ in the same way as they are in menus. + - a `GtkCellRenderer` instance + a `GtkCellRenderer` instance - the `GtkWidget` this cell will be rendering to + the `GtkWidget` this cell will be rendering to - render flags + render flags - cell area which would be passed to gtk_cell_renderer_render() + cell area which would be passed to gtk_cell_renderer_render() - the return location for the space inside @cell_area + the return location for the space inside @cell_area that would actually be used to render. @@ -15878,33 +16597,34 @@ in the same way as they are in menus. + - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GtkSnapshot` to draw to + a `GtkSnapshot` to draw to - the widget owning @window + the widget owning @window - entire cell area (including tree expanders and maybe + entire cell area (including tree expanders and maybe padding on the sides) - area normally rendered by a cell renderer + area normally rendered by a cell renderer - flags that affect rendering + flags that affect rendering @@ -15912,38 +16632,39 @@ in the same way as they are in menus. + - %TRUE if the event was consumed/handled + %TRUE if the event was consumed/handled - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GdkEvent` + a `GdkEvent` - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for `GtkTreeView`, a string representation of `GtkTreePath` - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags @@ -15951,39 +16672,40 @@ in the same way as they are in menus. + - A new `GtkCellEditable` for editing this + A new `GtkCellEditable` for editing this @cell, or %NULL if editing is not possible - a `GtkCellRenderer` + a `GtkCellRenderer` - a `GdkEvent` + a `GdkEvent` - widget that received the event + widget that received the event - widget-dependent string representation of the event location; + widget-dependent string representation of the event location; e.g. for `GtkTreeView`, a string representation of `GtkTreePath` - background area as passed to gtk_cell_renderer_render() + background area as passed to gtk_cell_renderer_render() - cell area as passed to gtk_cell_renderer_render() + cell area as passed to gtk_cell_renderer_render() - render flags + render flags @@ -15991,6 +16713,7 @@ in the same way as they are in menus. + @@ -16003,6 +16726,7 @@ in the same way as they are in menus. + @@ -16025,9 +16749,11 @@ in the same way as they are in menus. - + + + - Renders a combobox in a cell + Renders a combobox in a cell `GtkCellRendererCombo` renders text in a cell like `GtkCellRendererText` from which it is derived. But while `GtkCellRendererText` offers a simple entry to @@ -16040,30 +16766,31 @@ box and sets it to display the column specified by its `GtkCellRendererCombo`:text-column property. Further properties of the combo box can be set in a handler for the `GtkCellRenderer::editing-started` signal. - Creates a new `GtkCellRendererCombo`. + Creates a new `GtkCellRendererCombo`. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you can bind a property to a value in a `GtkTreeModel`. For example, you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the `GtkTreeView`. + - the new cell renderer + the new cell renderer - If %TRUE, the cell renderer will include an entry and allow to enter + If %TRUE, the cell renderer will include an entry and allow to enter values other than the ones in the popup list. - Holds a tree model containing the possible values for the combo box. + Holds a tree model containing the possible values for the combo box. Use the text_column property to specify the column holding the values. - Specifies the model column which holds the possible values for the + Specifies the model column which holds the possible values for the combo box. Note that this refers to the model specified in the model property, @@ -16075,7 +16802,7 @@ this column to its combo box. - This signal is emitted each time after the user selected an item in + This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to GtkComboBox, GtkCellRendererCombo::changed is not emitted for changes made to a selected item in the entry. The argument @new_iter @@ -16091,12 +16818,12 @@ until the combo cell renderer emits the edited or editing_canceled signal. - a string of the path identifying the edited cell + a string of the path identifying the edited cell (relative to the tree view model) - the new iter selected in the combo box + the new iter selected in the combo box (relative to the combo box model) @@ -16104,22 +16831,22 @@ until the combo cell renderer emits the edited or editing_canceled signal. - Identifies how the user can interact with a particular cell. + Identifies how the user can interact with a particular cell. - The cell is just for display + The cell is just for display and cannot be interacted with. Note that this doesn’t mean that eg. the row being drawn can’t be selected -- just that a particular element of it cannot be individually modified. - The cell can be clicked. + The cell can be clicked. - The cell can be edited or otherwise modified. + The cell can be edited or otherwise modified. - Renders a pixbuf in a cell + Renders a pixbuf in a cell A `GtkCellRendererPixbuf` can be used to render an image in a cell. It allows to render either a given `GdkPixbuf` (set via the @@ -16134,31 +16861,32 @@ renders that pixbuf, if the `GtkCellRenderer:is-expanded` property is %FALSE and the `GtkCellRendererPixbuf:pixbuf-expander-closed` property is set to a pixbuf, it renders that one. - Creates a new `GtkCellRendererPixbuf`. Adjust rendering + Creates a new `GtkCellRendererPixbuf`. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you can bind a property to a value in a `GtkTreeModel`. For example, you can bind the “pixbuf” property on the cell renderer to a pixbuf value in the model, thus rendering a different image in each row of the `GtkTreeView`. + - the new cell renderer + the new cell renderer - The GIcon representing the icon to display. + The GIcon representing the icon to display. If the icon theme is changed, the image will be updated automatically. - The name of the themed icon to display. + The name of the themed icon to display. This property only has an effect if not overridden by the "pixbuf" property. - The `GtkIconSize` value that specifies the size of the rendered icon. + The `GtkIconSize` value that specifies the size of the rendered icon. @@ -16174,17 +16902,20 @@ This property only has an effect if not overridden by the "pixbuf" property. - + + + - Renders numbers as progress bars + Renders numbers as progress bars `GtkCellRendererProgress` renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar. - Creates a new `GtkCellRendererProgress`. + Creates a new `GtkCellRendererProgress`. + - the new cell renderer + the new cell renderer @@ -16192,7 +16923,7 @@ Additionally, it can display a text on top of the progress bar. - Setting this to a non-negative value causes the cell renderer to + Setting this to a non-negative value causes the cell renderer to enter "activity mode", where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much. @@ -16205,32 +16936,32 @@ to zero. To indicate completion, set the property to %G_MAXINT. - The "text" property determines the label which will be drawn + The "text" property determines the label which will be drawn over the progress bar. Setting this property to %NULL causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed. - The "text-xalign" property controls the horizontal alignment of the + The "text-xalign" property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts. - The "text-yalign" property controls the vertical alignment of the + The "text-yalign" property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom). - The "value" property determines the percentage to which the + The "value" property determines the percentage to which the progress bar will be "filled in". - Renders a spin button in a cell + Renders a spin button in a cell `GtkCellRendererSpin` renders text in a cell like `GtkCellRendererText` from which it is derived. But while `GtkCellRendererText` offers a simple entry to @@ -16246,28 +16977,29 @@ can be set in a handler for the `GtkCellRenderer::editing-started` signal. The `GtkCellRendererSpin` cell renderer was added in GTK 2.10. - Creates a new `GtkCellRendererSpin`. + Creates a new `GtkCellRendererSpin`. + - a new `GtkCellRendererSpin` + a new `GtkCellRendererSpin` - The adjustment that holds the value of the spinbutton. + The adjustment that holds the value of the spinbutton. This must be non-%NULL for the cell renderer to be editable. - The acceleration rate when you hold down a button. + The acceleration rate when you hold down a button. - The number of decimal places to display. + The number of decimal places to display. - Renders a spinning animation in a cell + Renders a spinning animation in a cell `GtkCellRendererSpinner` renders a spinning animation in a cell, very similar to `GtkSpinner`. It can often be used as an alternative @@ -16280,10 +17012,11 @@ at regular intervals. The usual way to set the cell renderer properties for each cell is to bind them to columns in your tree model using e.g. gtk_tree_view_column_add_attribute(). - Returns a new cell renderer which will show a spinner to indicate + Returns a new cell renderer which will show a spinner to indicate activity. + - a new `GtkCellRenderer` + a new `GtkCellRenderer` @@ -16291,7 +17024,7 @@ activity. - Pulse of the spinner. Increment this value to draw the next frame of the + Pulse of the spinner. Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout. By default, the `GtkSpinner` widget draws one full cycle of the animation, @@ -16299,37 +17032,37 @@ consisting of 12 frames, in 750 milliseconds. - The `GtkIconSize` value that specifies the size of the rendered spinner. + The `GtkIconSize` value that specifies the size of the rendered spinner. - Tells how a cell is to be rendered. + Tells how a cell is to be rendered. - The cell is currently selected, and + The cell is currently selected, and probably has a selection colored background to render to. - The mouse is hovering over the cell. + The mouse is hovering over the cell. - The cell is drawn in an insensitive manner + The cell is drawn in an insensitive manner - The cell is in a sorted row + The cell is in a sorted row - The cell is in the focus row. + The cell is in the focus row. - The cell is in a row that can be expanded + The cell is in a row that can be expanded - The cell is in a row that is expanded + The cell is in a row that is expanded - Renders text in a cell + Renders text in a cell A `GtkCellRendererText` renders a given text in its cell, using the font, color and style information provided by its properties. The text will be ellipsized if it is @@ -16337,20 +17070,23 @@ too long and the `GtkCellRendererText:ellipsize` property allows it. If the `GtkCellRenderer:mode` is %GTK_CELL_RENDERER_MODE_EDITABLE, the `GtkCellRendererText` allows to edit its text using an entry. + - Creates a new `GtkCellRendererText`. Adjust how text is drawn using + Creates a new `GtkCellRendererText`. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you can bind a property to a value in a `GtkTreeModel`. For example, you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the `GtkTreeView`. + - the new cell renderer + the new cell renderer + @@ -16367,23 +17103,24 @@ of the `GtkTreeView`. - Sets the height of a renderer to explicitly be determined by the “font” and + Sets the height of a renderer to explicitly be determined by the “font” and “y_pad” property set on it. Further changes in these properties do not affect the height, so they must be accompanied by a subsequent call to this function. Using this function is inflexible, and should really only be used if calculating the size of a cell is too slow (ie, a massive number of cells displayed). If @number_of_rows is -1, then the fixed height is unset, and the height is determined by the properties again. + - A `GtkCellRendererText` + A `GtkCellRendererText` - Number of rows of text each cell renderer is allocated, or -1 + Number of rows of text each cell renderer is allocated, or -1 @@ -16392,7 +17129,7 @@ the height is determined by the properties again. - Specifies how to align the lines of text with respect to each other. + Specifies how to align the lines of text with respect to each other. Note that this property describes how to align the lines of text in case there are several of them. The "xalign" property of `GtkCellRenderer`, @@ -16406,7 +17143,7 @@ on the other hand, sets the horizontal alignment of the whole text. - Background color as a `GdkRGBA` + Background color as a `GdkRGBA` @@ -16419,7 +17156,7 @@ on the other hand, sets the horizontal alignment of the whole text. - Specifies the preferred place to ellipsize the string, if the cell renderer + Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string. Setting it to %PANGO_ELLIPSIZE_NONE turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width. @@ -16444,7 +17181,7 @@ for another way of making the text fit into a given width. - Foreground color as a `GdkRGBA` + Foreground color as a `GdkRGBA` @@ -16460,7 +17197,7 @@ for another way of making the text fit into a given width. - The desired maximum width of the cell, in characters. If this property + The desired maximum width of the cell, in characters. If this property is set to -1, the width will be calculated automatically. For cell renderers that ellipsize or wrap text; this property @@ -16471,7 +17208,7 @@ have received their natural width. - The text that will be displayed in the `GtkCellRenderer` if + The text that will be displayed in the `GtkCellRenderer` if `GtkCellRendererText:editable` is %TRUE and the cell is empty. @@ -16539,19 +17276,19 @@ have received their natural width. - The desired width of the cell, in characters. If this property is set to + The desired width of the cell, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the cell will request either 3 characters or the property value, whichever is greater. - Specifies how to break the string into multiple lines, if the cell + Specifies how to break the string into multiple lines, if the cell renderer does not have enough room to display the entire string. This property has no effect unless the wrap-width property is set. - Specifies the minimum width at which the text is wrapped. The wrap-mode property can + Specifies the minimum width at which the text is wrapped. The wrap-mode property can be used to influence at what character positions the line breaks can be placed. Setting wrap-width to -1 turns wrapping off. @@ -16560,7 +17297,7 @@ Setting wrap-width to -1 turns wrapping off. - This signal is emitted after @renderer has been edited. + This signal is emitted after @renderer has been edited. It is the responsibility of the application to update the model and store @new_text at the position indicated by @path. @@ -16569,22 +17306,24 @@ and store @new_text at the position indicated by @path. - the path identifying the edited cell + the path identifying the edited cell - the new text + the new text + + @@ -16608,116 +17347,123 @@ and store @new_text at the position indicated by @path. - Renders a toggle button in a cell + Renders a toggle button in a cell `GtkCellRendererToggle` renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the `GtkCellRendererToggle:radio` property. When activated, it emits the `GtkCellRendererToggle::toggled` signal. - Creates a new `GtkCellRendererToggle`. Adjust rendering + Creates a new `GtkCellRendererToggle`. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you can bind a property to a value in a `GtkTreeModel`. For example, you can bind the “active” property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model. + - the new cell renderer + the new cell renderer - Returns whether the cell renderer is activatable. See + Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable(). + - %TRUE if the cell renderer is activatable. + %TRUE if the cell renderer is activatable. - a `GtkCellRendererToggle` + a `GtkCellRendererToggle` - Returns whether the cell renderer is active. See + Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active(). + - %TRUE if the cell renderer is active. + %TRUE if the cell renderer is active. - a `GtkCellRendererToggle` + a `GtkCellRendererToggle` - Returns whether we’re rendering radio toggles rather than checkboxes. + Returns whether we’re rendering radio toggles rather than checkboxes. + - %TRUE if we’re rendering radio toggles rather than checkboxes + %TRUE if we’re rendering radio toggles rather than checkboxes - a `GtkCellRendererToggle` + a `GtkCellRendererToggle` - Makes the cell renderer activatable. + Makes the cell renderer activatable. + - a `GtkCellRendererToggle`. + a `GtkCellRendererToggle`. - the value to set. + the value to set. - Activates or deactivates a cell renderer. + Activates or deactivates a cell renderer. + - a `GtkCellRendererToggle`. + a `GtkCellRendererToggle`. - the value to set. + the value to set. - If @radio is %TRUE, the cell renderer renders a radio toggle + If @radio is %TRUE, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles). If %FALSE, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for `GtkTreeView`, you set up a per-row setting using `GtkTreeViewColumn` to associate model columns with cell renderer properties). + - a `GtkCellRendererToggle` + a `GtkCellRendererToggle` - %TRUE to make the toggle look like a radio button + %TRUE to make the toggle look like a radio button @@ -16735,7 +17481,7 @@ columns with cell renderer properties). - The ::toggled signal is emitted when the cell is toggled. + The ::toggled signal is emitted when the cell is toggled. It is the responsibility of the application to update the model with the correct value to store at @path. Often this is simply the @@ -16745,7 +17491,7 @@ opposite of the value currently stored at @path. - string representation of `GtkTreePath` describing the + string representation of `GtkTreePath` describing the event location @@ -16753,7 +17499,7 @@ opposite of the value currently stored at @path. - A widget displaying a single row of a GtkTreeModel + A widget displaying a single row of a GtkTreeModel A `GtkCellView` displays a single row of a `GtkTreeModel` using a `GtkCellArea` and `GtkCellAreaContext`. A `GtkCellAreaContext` can be provided to the @@ -16778,217 +17524,230 @@ GtkCellView has a single CSS node with name cellview. - Creates a new `GtkCellView` widget. + Creates a new `GtkCellView` widget. + - A newly created `GtkCellView` widget. + A newly created `GtkCellView` widget. - Creates a new `GtkCellView` widget with a specific `GtkCellArea` + Creates a new `GtkCellView` widget with a specific `GtkCellArea` to layout cells and a specific `GtkCellAreaContext`. Specifying the same context for a handful of cells lets the underlying area synchronize the geometry for those cells, in this way alignments with cellviews for other rows are possible. + - A newly created `GtkCellView` widget. + A newly created `GtkCellView` widget. - the `GtkCellArea` to layout cells + the `GtkCellArea` to layout cells - the `GtkCellAreaContext` in which to calculate cell geometry + the `GtkCellAreaContext` in which to calculate cell geometry - Creates a new `GtkCellView` widget, adds a `GtkCellRendererText` + Creates a new `GtkCellView` widget, adds a `GtkCellRendererText` to it, and makes it show @markup. The text can be marked up with the [Pango text markup language](https://docs.gtk.org/Pango/pango_markup.html). + - A newly created `GtkCellView` widget. + A newly created `GtkCellView` widget. - the text to display in the cell view + the text to display in the cell view - Creates a new `GtkCellView` widget, adds a `GtkCellRendererText` + Creates a new `GtkCellView` widget, adds a `GtkCellRendererText` to it, and makes it show @text. + - A newly created `GtkCellView` widget. + A newly created `GtkCellView` widget. - the text to display in the cell view + the text to display in the cell view - Creates a new `GtkCellView` widget, adds a `GtkCellRendererPixbuf` + Creates a new `GtkCellView` widget, adds a `GtkCellRendererPixbuf` to it, and makes it show @texture. + - A newly created `GtkCellView` widget. + A newly created `GtkCellView` widget. - the image to display in the cell view + the image to display in the cell view - Returns a `GtkTreePath` referring to the currently + Returns a `GtkTreePath` referring to the currently displayed row. If no row is currently displayed, %NULL is returned. + - the currently displayed row + the currently displayed row - a `GtkCellView` + a `GtkCellView` - Gets whether @cell_view is configured to draw all of its + Gets whether @cell_view is configured to draw all of its cells in a sensitive state. + - whether @cell_view draws all of its + whether @cell_view draws all of its cells in a sensitive state - a `GtkCellView` + a `GtkCellView` - Gets whether @cell_view is configured to request space + Gets whether @cell_view is configured to request space to fit the entire `GtkTreeModel`. + - whether @cell_view requests space to fit + whether @cell_view requests space to fit the entire `GtkTreeModel`. - a `GtkCellView` + a `GtkCellView` - Returns the model for @cell_view. If no model is used %NULL is + Returns the model for @cell_view. If no model is used %NULL is returned. + - a `GtkTreeModel` used + a `GtkTreeModel` used - a `GtkCellView` + a `GtkCellView` - Sets the row of the model that is currently displayed + Sets the row of the model that is currently displayed by the `GtkCellView`. If the path is unset, then the contents of the cellview “stick” at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the model for the `GtkCellView` becomes temporarily empty. + - a `GtkCellView` + a `GtkCellView` - a `GtkTreePath` or %NULL to unset. + a `GtkTreePath` or %NULL to unset. - Sets whether @cell_view should draw all of its + Sets whether @cell_view should draw all of its cells in a sensitive state, this is used by `GtkComboBox` menus to ensure that rows with insensitive cells that contain children appear sensitive in the parent menu item. + - a `GtkCellView` + a `GtkCellView` - whether to draw all cells in a sensitive state. + whether to draw all cells in a sensitive state. - Sets whether @cell_view should request space to fit the entire `GtkTreeModel`. + Sets whether @cell_view should request space to fit the entire `GtkTreeModel`. This is used by `GtkComboBox` to ensure that the cell view displayed on the combo box’s button always gets enough space and does not resize when selection changes. + - a `GtkCellView` + a `GtkCellView` - whether @cell_view should request space for the whole model. + whether @cell_view should request space for the whole model. - Sets the model for @cell_view. If @cell_view already has a model + Sets the model for @cell_view. If @cell_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model. + - a `GtkCellView` + a `GtkCellView` - a `GtkTreeModel` + a `GtkTreeModel` - The `GtkCellArea` rendering cells + The `GtkCellArea` rendering cells If no area is specified when creating the cell view with gtk_cell_view_new_with_context() a horizontally oriented `GtkCellArea`Box will be used. @@ -16997,7 +17756,7 @@ since 3.0 - The `GtkCellAreaContext` used to compute the geometry of the cell view. + The `GtkCellAreaContext` used to compute the geometry of the cell view. A group of cell views can be assigned the same context in order to ensure the sizes and cell alignments match across all the views with @@ -17012,7 +17771,7 @@ since 3.0 - Whether all cells should be draw as sensitive for this view regardless + Whether all cells should be draw as sensitive for this view regardless of the actual cell properties (used to make menus with submenus appear sensitive when the items in submenus might be insensitive). @@ -17020,7 +17779,7 @@ since 3.0 - Whether the view should request enough space to always fit + Whether the view should request enough space to always fit the size of every row in the model (used by the combo box to ensure the combo box size doesn't change when different items are selected). @@ -17029,14 +17788,14 @@ since 3.0 - The model for cell view + The model for cell view since 2.10 - `GtkCenterBox` arranges three children in a row, keeping the middle child + `GtkCenterBox` arranges three children in a row, keeping the middle child centered as well as possible. ![An example GtkCenterBox](centerbox.png) @@ -17068,143 +17827,153 @@ bottom. # Accessibility `GtkCenterBox` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. + - Creates a new `GtkCenterBox`. + Creates a new `GtkCenterBox`. + - the new `GtkCenterBox`. + the new `GtkCenterBox`. - Gets the value set by gtk_center_box_set_baseline_position(). + Gets the value set by gtk_center_box_set_baseline_position(). + - the baseline position + the baseline position - a `GtkCenterBox` + a `GtkCenterBox` - Gets the center widget, or %NULL if there is none. + Gets the center widget, or %NULL if there is none. + - the center widget. + the center widget. - a `GtkCenterBox` + a `GtkCenterBox` - Gets the end widget, or %NULL if there is none. + Gets the end widget, or %NULL if there is none. + - the end widget. + the end widget. - a `GtkCenterBox` + a `GtkCenterBox` - Gets the start widget, or %NULL if there is none. + Gets the start widget, or %NULL if there is none. + - the start widget. + the start widget. - a `GtkCenterBox` + a `GtkCenterBox` - Sets the baseline position of a center box. + Sets the baseline position of a center box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then @position is used to allocate the baseline wrt. the extra space available. + - a `GtkCenterBox` + a `GtkCenterBox` - a `GtkBaselinePosition` + a `GtkBaselinePosition` - Sets the center widget. + Sets the center widget. To remove the existing center widget, pas %NULL. + - a `GtkCenterBox` + a `GtkCenterBox` - the new center widget + the new center widget - Sets the end widget. + Sets the end widget. To remove the existing end widget, pass %NULL. + - a `GtkCenterBox` + a `GtkCenterBox` - the new end widget + the new end widget - Sets the start widget. + Sets the start widget. To remove the existing start widget, pass %NULL. + - a `GtkCenterBox` + a `GtkCenterBox` - the new start widget + the new start widget @@ -17212,185 +17981,200 @@ To remove the existing start widget, pass %NULL. - The position of the baseline aligned widget if extra space is available. + The position of the baseline aligned widget if extra space is available. - + + + - `GtkCenterLayout` is a layout manager that manages up to three children. + `GtkCenterLayout` is a layout manager that manages up to three children. The start widget is allocated at the start of the layout (left in left-to-right locales and right in right-to-left ones), and the end widget at the end. The center widget is centered regarding the full width of the layout's. + - Creates a new `GtkCenterLayout`. + Creates a new `GtkCenterLayout`. + - the newly created `GtkCenterLayout` + the newly created `GtkCenterLayout` - Returns the baseline position of the layout. + Returns the baseline position of the layout. + - The current baseline position of @self. + The current baseline position of @self. - a `GtkCenterLayout` + a `GtkCenterLayout` - Returns the center widget of the layout. + Returns the center widget of the layout. + - the current center widget of @self + the current center widget of @self - a `GtkCenterLayout` + a `GtkCenterLayout` - Returns the end widget of the layout. + Returns the end widget of the layout. + - the current end widget of @self + the current end widget of @self - a `GtkCenterLayout` + a `GtkCenterLayout` - Gets the current orienration of the layout manager. + Gets the current orienration of the layout manager. + - The current orientation of @self + The current orientation of @self - a `GtkCenterLayout` + a `GtkCenterLayout` - Returns the start widget fo the layout. + Returns the start widget fo the layout. + - The current start widget of @self + The current start widget of @self - a `GtkCenterLayout` + a `GtkCenterLayout` - Sets the new baseline position of @self + Sets the new baseline position of @self + - a `GtkCenterLayout` + a `GtkCenterLayout` - the new baseline position + the new baseline position - Sets the new center widget of @self. + Sets the new center widget of @self. To remove the existing center widget, pass %NULL. + - a `GtkCenterLayout` + a `GtkCenterLayout` - the new center widget + the new center widget - Sets the new end widget of @self. + Sets the new end widget of @self. To remove the existing center widget, pass %NULL. + - a `GtkCenterLayout` + a `GtkCenterLayout` - the new end widget + the new end widget - Sets the orientation of @self. + Sets the orientation of @self. + - a `GtkCenterLayout` + a `GtkCenterLayout` - the new orientation + the new orientation - Sets the new start widget of @self. + Sets the new start widget of @self. To remove the existing start widget, pass %NULL. + - a `GtkCenterLayout` + a `GtkCenterLayout` - the new start widget + the new start widget + - A `GtkCheckButton` places a label next to an indicator. + A `GtkCheckButton` places a label next to an indicator. ![Example GtkCheckButtons](check-button.png) @@ -17441,45 +18225,50 @@ radio if the checkbutton is grouped together with other checkbuttons. # Accessibility `GtkCheckButton` uses the %GTK_ACCESSIBLE_ROLE_CHECKBOX role. + - Creates a new `GtkCheckButton`. + Creates a new `GtkCheckButton`. + - a new `GtkCheckButton` + a new `GtkCheckButton` - Creates a new `GtkCheckButton` with the given text. + Creates a new `GtkCheckButton` with the given text. + - a new `GtkCheckButton` + a new `GtkCheckButton` - the text for the check button. + the text for the check button. - Creates a new `GtkCheckButton` with the given text and a mnemonic. + Creates a new `GtkCheckButton` with the given text and a mnemonic. + - a new `GtkCheckButton` + a new `GtkCheckButton` - The text of the button, with an underscore + The text of the button, with an underscore in front of the mnemonic character + @@ -17490,6 +18279,7 @@ radio if the checkbutton is grouped together with other checkbuttons. + @@ -17501,83 +18291,88 @@ radio if the checkbutton is grouped together with other checkbuttons. - Returns whether the check button is active. + Returns whether the check button is active. + - whether the check button is active + whether the check button is active - a `GtkCheckButton` + a `GtkCheckButton` - Returns whether the check button is in an inconsistent state. + Returns whether the check button is in an inconsistent state. + - %TRUE if @check_button is currently in an inconsistent state + %TRUE if @check_button is currently in an inconsistent state - a `GtkCheckButton` + a `GtkCheckButton` - Returns the label of the check button. + Returns the label of the check button. + - The label @self shows next + The label @self shows next to the indicator. If no label is shown, %NULL will be returned. - a `GtkCheckButton` + a `GtkCheckButton` - Returns whether underlines in the label indicate mnemonics. + Returns whether underlines in the label indicate mnemonics. + - The value of the [property@Gtk.CheckButton:use-underline] property. + The value of the [property@Gtk.CheckButton:use-underline] property. See [method@Gtk.CheckButton.set_use_underline] for details on how to set a new value. - a `GtkCheckButton` + a `GtkCheckButton` - Changes the check buttons active state. + Changes the check buttons active state. + - a `GtkCheckButton` + a `GtkCheckButton` - the new value to set + the new value to set - Adds @self to the group of @group. + Adds @self to the group of @group. In a group of multiple check buttons, only one button can be active at a time. The behavior of a checkbutton in a group is also commonly @@ -17592,16 +18387,17 @@ Note that the same effect can be achieved via the [iface@Gtk.Actionable] API, by using the same action with parameter type and state type 's' for all buttons in the group, and giving each button its own target value. + - a `GtkCheckButton` + a `GtkCheckButton` - another `GtkCheckButton` to + another `GtkCheckButton` to form a group with @@ -17609,41 +18405,43 @@ value. - Sets the `GtkCheckButton` to inconsistent state. + Sets the `GtkCheckButton` to inconsistent state. You shoud turn off the inconsistent state again if the user checks the check button. This has to be done manually. + - a `GtkCheckButton` + a `GtkCheckButton` - %TRUE if state is inconsistent + %TRUE if state is inconsistent - Sets the text of @self. + Sets the text of @self. If [property@Gtk.CheckButton:use-underline] is %TRUE, an underscore in @label is interpreted as mnemonic indicator, see [method@Gtk.CheckButton.set_use_underline] for details on this behavior. + - a `GtkCheckButton` + a `GtkCheckButton` - The text shown next to the indicator, or %NULL + The text shown next to the indicator, or %NULL to show no text @@ -17651,21 +18449,22 @@ in @label is interpreted as mnemonic indicator, see - Sets whether underlines in the label indicate mnemonics. + Sets whether underlines in the label indicate mnemonics. If @setting is %TRUE, an underscore character in @self's label indicates a mnemonic accelerator key. This behavior is similar to [property@Gtk.Label:use-underline]. + - a `GtkCheckButton` + a `GtkCheckButton` - the new value to set + the new value to set @@ -17673,7 +18472,7 @@ to [property@Gtk.Label:use-underline]. - If the check button is active. + If the check button is active. Setting `active` to %TRUE will add the `:checked:` state to both the check button and the indicator CSS node. @@ -17681,13 +18480,13 @@ the check button and the indicator CSS node. - The check button whose group this widget belongs to. + The check button whose group this widget belongs to. - If the check button is in an “in between” state. + If the check button is in an “in between” state. The inconsistent state only affects visual appearance, not the semantics of the button. @@ -17696,13 +18495,13 @@ not the semantics of the button. - Text of the label inside the check button, if it contains a label widget. + Text of the label inside the check button, if it contains a label widget. - If set, an underline in the text indicates that the following + If set, an underline in the text indicates that the following character is to be used as mnemonic. @@ -17710,7 +18509,7 @@ character is to be used as mnemonic. - Emitted to when the check button is activated. + Emitted to when the check button is activated. The `::activate` signal on `GtkCheckButton` is an action signal and emitting it causes the button to animate press then release. @@ -17722,7 +18521,7 @@ Applications should never connect to this signal, but use the - Emitted when the buttons's [property@Gtk.CheckButton:active] + Emitted when the buttons's [property@Gtk.CheckButton:active] property changes. @@ -17730,11 +18529,13 @@ property changes. + + @@ -17747,6 +18548,7 @@ property changes. + @@ -17764,32 +18566,33 @@ property changes. - An expression using a custom `GClosure` to compute the value from + An expression using a custom `GClosure` to compute the value from its parameters. - Creates a `GtkExpression` that calls `closure` when it is evaluated. + Creates a `GtkExpression` that calls `closure` when it is evaluated. `closure` is called with the `this` object and the results of evaluating the `params` expressions. + - a new `GtkExpression` + a new `GtkExpression` - the type of the value that this expression evaluates to + the type of the value that this expression evaluates to - closure to call when evaluating this expression. If closure is floating, it is adopted + closure to call when evaluating this expression. If closure is floating, it is adopted - the number of params needed for evaluating `closure` + the number of params needed for evaluating `closure` - expressions for each parameter + expressions for each parameter @@ -17798,7 +18601,7 @@ the `params` expressions. - The `GtkColorButton` allows to open a color chooser dialog to change + The `GtkColorButton` allows to open a color chooser dialog to change the color. ![An example GtkColorButton](color-button.png) @@ -17821,89 +18624,95 @@ it gets the .color style class. - Creates a new color button. + Creates a new color button. This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a color chooser dialog will open, allowing the user to select a color. The swatch will be updated to reflect the new color when the user finishes. + - a new color button + a new color button - Creates a new color button showing the given color. + Creates a new color button showing the given color. + - a new color button + a new color button - A `GdkRGBA` to set the current color with + A `GdkRGBA` to set the current color with - Gets whether the dialog is modal. + Gets whether the dialog is modal. + - %TRUE if the dialog is modal + %TRUE if the dialog is modal - a `GtkColorButton` + a `GtkColorButton` - Gets the title of the color chooser dialog. + Gets the title of the color chooser dialog. + - An internal string, do not free the return value + An internal string, do not free the return value - a `GtkColorButton` + a `GtkColorButton` - Sets whether the dialog should be modal. + Sets whether the dialog should be modal. + - a `GtkColorButton` + a `GtkColorButton` - %TRUE to make the dialog modal + %TRUE to make the dialog modal - Sets the title for the color chooser dialog. + Sets the title for the color chooser dialog. + - a `GtkColorButton` + a `GtkColorButton` - String containing new window title + String containing new window title @@ -17911,11 +18720,11 @@ color when the user finishes. - Whether the color chooser dialog should be modal. + Whether the color chooser dialog should be modal. - Whether the color chooser should open in editor mode. + Whether the color chooser should open in editor mode. This property should be used in cases where the palette in the editor would be redundant, such as when the color @@ -17925,11 +18734,11 @@ button is already part of a palette. - The title of the color chooser dialog + The title of the color chooser dialog - Emitted to when the color button is activated. + Emitted to when the color button is activated. The `::activate` signal on `GtkMenuButton` is an action signal and emitting it causes the button to pop up its dialog. @@ -17938,7 +18747,7 @@ emitting it causes the button to pop up its dialog. - Emitted when the user selects a color. + Emitted when the user selects a color. When handling this signal, use [method@Gtk.ColorChooser.get_rgba] to find out which color was just selected. @@ -17952,7 +18761,7 @@ the notify::color signal. - `GtkColorChooser` is an interface that is implemented by widgets + `GtkColorChooser` is an interface that is implemented by widgets for choosing colors. Depending on the situation, colors may be allowed to have alpha (translucency). @@ -17960,8 +18769,9 @@ Depending on the situation, colors may be allowed to have alpha (translucency). In GTK, the main widgets that implement this interface are [class@Gtk.ColorChooserWidget], [class@Gtk.ColorChooserDialog] and [class@Gtk.ColorButton]. + - Adds a palette to the color chooser. + Adds a palette to the color chooser. If @orientation is horizontal, the colors are grouped in rows, with @colors_per_line colors in each row. If @horizontal is %FALSE, @@ -17978,29 +18788,30 @@ Calling this function for the first time has the side effect of removing the default color palette from the color chooser. If @colors is %NULL, removes all previously added palettes. + - a `GtkColorChooser` + a `GtkColorChooser` - %GTK_ORIENTATION_HORIZONTAL if the palette should + %GTK_ORIENTATION_HORIZONTAL if the palette should be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns - the number of colors to show in each row/column + the number of colors to show in each row/column - the total number of elements in @colors + the total number of elements in @colors - the colors of the palette + the colors of the palette @@ -18008,6 +18819,7 @@ If @colors is %NULL, removes all previously added palettes. + @@ -18022,40 +18834,42 @@ If @colors is %NULL, removes all previously added palettes. - Gets the currently-selected color. + Gets the currently-selected color. + - a `GtkColorChooser` + a `GtkColorChooser` - a `GdkRGBA` to fill in with the current color + a `GdkRGBA` to fill in with the current color - Sets the color. + Sets the color. + - a `GtkColorChooser` + a `GtkColorChooser` - the new color + the new color - Adds a palette to the color chooser. + Adds a palette to the color chooser. If @orientation is horizontal, the colors are grouped in rows, with @colors_per_line colors in each row. If @horizontal is %FALSE, @@ -18072,29 +18886,30 @@ Calling this function for the first time has the side effect of removing the default color palette from the color chooser. If @colors is %NULL, removes all previously added palettes. + - a `GtkColorChooser` + a `GtkColorChooser` - %GTK_ORIENTATION_HORIZONTAL if the palette should + %GTK_ORIENTATION_HORIZONTAL if the palette should be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns - the number of colors to show in each row/column + the number of colors to show in each row/column - the total number of elements in @colors + the total number of elements in @colors - the colors of the palette + the colors of the palette @@ -18103,66 +18918,70 @@ If @colors is %NULL, removes all previously added palettes. - Gets the currently-selected color. + Gets the currently-selected color. + - a `GtkColorChooser` + a `GtkColorChooser` - a `GdkRGBA` to fill in with the current color + a `GdkRGBA` to fill in with the current color - Returns whether the color chooser shows the alpha channel. + Returns whether the color chooser shows the alpha channel. + - %TRUE if the color chooser uses the alpha channel, + %TRUE if the color chooser uses the alpha channel, %FALSE if not - a `GtkColorChooser` + a `GtkColorChooser` - Sets the color. + Sets the color. + - a `GtkColorChooser` + a `GtkColorChooser` - the new color + the new color - Sets whether or not the color chooser should use the alpha channel. + Sets whether or not the color chooser should use the alpha channel. + - a `GtkColorChooser` + a `GtkColorChooser` - %TRUE if color chooser should use alpha channel, %FALSE if not + %TRUE if color chooser should use alpha channel, %FALSE if not @@ -18170,7 +18989,7 @@ If @colors is %NULL, removes all previously added palettes. - The currently selected color, as a `GdkRGBA` struct. + The currently selected color, as a `GdkRGBA` struct. The property can be set to change the current selection programmatically. @@ -18179,7 +18998,7 @@ programmatically. - Whether colors may have alpha (translucency). + Whether colors may have alpha (translucency). When ::use-alpha is %FALSE, the `GdkRGBA` struct obtained via the [property@Gtk.ColorChooser:rgba] property will be @@ -18190,7 +19009,7 @@ over a non-uniform background (like a checkerboard pattern). - Emitted when a color is activated from the color chooser. + Emitted when a color is activated from the color chooser. This usually happens when the user clicks a color swatch, or a color is selected and the user presses one of the keys @@ -18200,14 +19019,14 @@ Space, Shift+Space, Return or Enter. - the color + the color - A dialog for choosing a color. + A dialog for choosing a color. ![An example GtkColorChooserDialog](colorchooser.png) @@ -18227,18 +19046,19 @@ To change the initially selected color, use - Creates a new `GtkColorChooserDialog`. + Creates a new `GtkColorChooserDialog`. + - a new `GtkColorChooserDialog` + a new `GtkColorChooserDialog` - Title of the dialog + Title of the dialog - Transient parent of the dialog + Transient parent of the dialog @@ -18248,21 +19068,23 @@ To change the initially selected color, use + + - a `GtkColorChooser` + a `GtkColorChooser` - a `GdkRGBA` to fill in with the current color + a `GdkRGBA` to fill in with the current color @@ -18270,16 +19092,17 @@ To change the initially selected color, use + - a `GtkColorChooser` + a `GtkColorChooser` - the new color + the new color @@ -18287,29 +19110,30 @@ To change the initially selected color, use + - a `GtkColorChooser` + a `GtkColorChooser` - %GTK_ORIENTATION_HORIZONTAL if the palette should + %GTK_ORIENTATION_HORIZONTAL if the palette should be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns - the number of colors to show in each row/column + the number of colors to show in each row/column - the total number of elements in @colors + the total number of elements in @colors - the colors of the palette + the colors of the palette @@ -18319,6 +19143,7 @@ To change the initially selected color, use + @@ -18339,7 +19164,7 @@ To change the initially selected color, use - The `GtkColorChooserWidget` widget lets the user select a color. + The `GtkColorChooserWidget` widget lets the user select a color. By default, the chooser presents a predefined palette of colors, plus a small number of settable custom colors. It is also possible @@ -18368,21 +19193,22 @@ to provide a dialog for selecting colors. - Creates a new `GtkColorChooserWidget`. + Creates a new `GtkColorChooserWidget`. + - a new `GtkColorChooserWidget` + a new `GtkColorChooserWidget` - %TRUE when the color chooser is showing the single-color editor. + %TRUE when the color chooser is showing the single-color editor. It can be set to switch the color chooser into single-color editing mode. - `GtkColumnView` presents a large dynamic list of items using multiple columns + `GtkColumnView` presents a large dynamic list of items using multiple columns with headers. `GtkColumnView` uses the factories of its columns to generate a cell widget for @@ -18447,38 +19273,41 @@ the style of [list presentation](section-list-widget.html#list-styles): widgets are using the %GTK_ACCESSIBLE_ROLE_COLUMN_HEADER role. The row widgets are using the %GTK_ACCESSIBLE_ROLE_ROW role, and individual cells are using the %GTK_ACCESSIBLE_ROLE_GRID_CELL role + - Creates a new `GtkColumnView`. + Creates a new `GtkColumnView`. You most likely want to call [method@Gtk.ColumnView.append_column] to add columns next. + - a new `GtkColumnView` + a new `GtkColumnView` - the list model to use + the list model to use - Appends the @column to the end of the columns in @self. + Appends the @column to the end of the columns in @self. + - a `GtkColumnView` + a `GtkColumnView` - a `GtkColumnViewColumn` that hasn't been added to a + a `GtkColumnViewColumn` that hasn't been added to a `GtkColumnView` yet @@ -18486,112 +19315,119 @@ to add columns next. - Gets the list of columns in this column view. + Gets the list of columns in this column view. This list is constant over the lifetime of @self and can be used to monitor changes to the columns of @self by connecting to the ::items-changed signal. + - The list managing the columns + The list managing the columns - a `GtkColumnView` + a `GtkColumnView` - Returns whether rows can be selected by dragging with the mouse. + Returns whether rows can be selected by dragging with the mouse. + - %TRUE if rubberband selection is enabled + %TRUE if rubberband selection is enabled - a `GtkColumnView` + a `GtkColumnView` - Gets the model that's currently used to read the items displayed. + Gets the model that's currently used to read the items displayed. + - The model in use + The model in use - a `GtkColumnView` + a `GtkColumnView` - Returns whether columns are reorderable. + Returns whether columns are reorderable. + - %TRUE if columns are reorderable + %TRUE if columns are reorderable - a `GtkColumnView` + a `GtkColumnView` - Returns whether the list should show separators + Returns whether the list should show separators between columns. + - %TRUE if the list shows column separators + %TRUE if the list shows column separators - a `GtkColumnView` + a `GtkColumnView` - Returns whether the list should show separators + Returns whether the list should show separators between rows. + - %TRUE if the list shows separators + %TRUE if the list shows separators - a `GtkColumnView` + a `GtkColumnView` - Returns whether rows will be activated on single click and + Returns whether rows will be activated on single click and selected on hover. + - %TRUE if rows are activated on single click + %TRUE if rows are activated on single click - a `GtkColumnView` + a `GtkColumnView` - Returns a special sorter that reflects the users sorting + Returns a special sorter that reflects the users sorting choices in the column view. To allow users to customizable sorting by clicking on column @@ -18610,164 +19446,173 @@ model = gtk_sort_list_model_new (store, sorter); selection = gtk_no_selection_new (model); gtk_column_view_set_model (view, selection); ``` + - the `GtkSorter` of @self + the `GtkSorter` of @self - a `GtkColumnView` + a `GtkColumnView` - Inserts a column at the given position in the columns of @self. + Inserts a column at the given position in the columns of @self. If @column is already a column of @self, it will be repositioned. + - a `GtkColumnView` + a `GtkColumnView` - the position to insert @column at + the position to insert @column at - the `GtkColumnViewColumn` to insert + the `GtkColumnViewColumn` to insert - Removes the @column from the list of columns of @self. + Removes the @column from the list of columns of @self. + - a `GtkColumnView` + a `GtkColumnView` - a `GtkColumnViewColumn` that's part of @self + a `GtkColumnViewColumn` that's part of @self - Sets whether selections can be changed by dragging with the mouse. + Sets whether selections can be changed by dragging with the mouse. + - a `GtkColumnView` + a `GtkColumnView` - %TRUE to enable rubberband selection + %TRUE to enable rubberband selection - Sets the model to use. + Sets the model to use. This must be a [iface@Gtk.SelectionModel]. + - a `GtkColumnView` + a `GtkColumnView` - the model to use + the model to use - Sets whether columns should be reorderable by dragging. + Sets whether columns should be reorderable by dragging. + - a `GtkColumnView` + a `GtkColumnView` - whether columns should be reorderable + whether columns should be reorderable - Sets whether the list should show separators + Sets whether the list should show separators between columns. + - a `GtkColumnView` + a `GtkColumnView` - %TRUE to show column separators + %TRUE to show column separators - Sets whether the list should show separators + Sets whether the list should show separators between rows. + - a `GtkColumnView` + a `GtkColumnView` - %TRUE to show row separators + %TRUE to show row separators - Sets whether rows should be activated on single click and + Sets whether rows should be activated on single click and selected on hover. + - a `GtkColumnView` + a `GtkColumnView` - %TRUE to activate items on single click + %TRUE to activate items on single click - Sets the sorting of the view. + Sets the sorting of the view. This function should be used to set up the initial sorting. At runtime, users can change the sorting of a column view @@ -18779,72 +19624,73 @@ and [method@Gtk.ColumnViewColumn.set_sorter] has been called on @column to associate a sorter with the column. If @column is %NULL, the view will be unsorted. + - a `GtkColumnView` + a `GtkColumnView` - the `GtkColumnViewColumn` to sort by + the `GtkColumnViewColumn` to sort by - the direction to sort in + the direction to sort in - The list of columns. + The list of columns. - Allow rubberband selection. + Allow rubberband selection. - Model for the items displayed. + Model for the items displayed. - Whether columns are reorderable. + Whether columns are reorderable. - Show separators between columns. + Show separators between columns. - Show separators between rows. + Show separators between rows. - Activate rows on single click and select them on hover. + Activate rows on single click and select them on hover. - Sorter with the sorting choices of the user. + Sorter with the sorting choices of the user. - Emitted when a row has been activated by the user, usually via activating + Emitted when a row has been activated by the user, usually via activating the GtkListBase|list.activate-item action. This allows for a convenient way to handle activation in a columnview. @@ -18855,15 +19701,17 @@ signal. - position of item to activate + position of item to activate - + + + - `GtkColumnViewColumn` represents the columns being added to `GtkColumnView`. + `GtkColumnViewColumn` represents the columns being added to `GtkColumnView`. The main ingredient for a `GtkColumnViewColumn` is the `GtkListItemFactory` that tells the columnview how to create cells for this column from items in @@ -18875,8 +19723,9 @@ with [method@Gtk.ColumnViewColumn.set_header_menu]. A sorter can be associated with a column using [method@Gtk.ColumnViewColumn.set_sorter], to let users influence sorting by clicking on the column header. + - Creates a new `GtkColumnViewColumn` that uses the given @factory for + Creates a new `GtkColumnViewColumn` that uses the given @factory for mapping items to widgets. You most likely want to call [method@Gtk.ColumnView.append_column] next. @@ -18887,248 +19736,263 @@ The function takes ownership of the argument, so you can write code like: column = gtk_column_view_column_new (_("Name"), gtk_builder_list_item_factory_new_from_resource ("/name.ui")); ``` + - a new `GtkColumnViewColumn` using the given @factory + a new `GtkColumnViewColumn` using the given @factory - Title to use for this column + Title to use for this column - The factory to populate items with + The factory to populate items with - Gets the column view that's currently displaying this column. + Gets the column view that's currently displaying this column. If @self has not been added to a column view yet, %NULL is returned. + - The column view displaying @self. + The column view displaying @self. - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Returns whether this column should expand. + Returns whether this column should expand. + - %TRUE if this column expands + %TRUE if this column expands - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Gets the factory that's currently used to populate list items for + Gets the factory that's currently used to populate list items for this column. + - The factory in use + The factory in use - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Gets the fixed width of the column. + Gets the fixed width of the column. + - the fixed with of the column + the fixed with of the column - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Gets the menu model that is used to create the context menu + Gets the menu model that is used to create the context menu for the column header. + - the `GMenuModel` + the `GMenuModel` - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Returns whether this column is resizable. + Returns whether this column is resizable. + - %TRUE if this column is resizable + %TRUE if this column is resizable - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Returns the sorter that is associated with the column. + Returns the sorter that is associated with the column. + - the `GtkSorter` of @self + the `GtkSorter` of @self - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Returns the title set with gtk_column_view_column_set_title(). + Returns the title set with gtk_column_view_column_set_title(). + - The column's title + The column's title - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Returns whether this column is visible. + Returns whether this column is visible. + - %TRUE if this column is visible + %TRUE if this column is visible - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Sets the column to take available extra space. + Sets the column to take available extra space. The extra space is shared equally amongst all columns that have the expand set to %TRUE. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - %TRUE if this column should expand to fill available sace + %TRUE if this column should expand to fill available sace - Sets the `GtkListItemFactory` to use for populating list items for this + Sets the `GtkListItemFactory` to use for populating list items for this column. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - the factory to use + the factory to use - If @fixed_width is not -1, sets the fixed width of @column; + If @fixed_width is not -1, sets the fixed width of @column; otherwise unsets it. Setting a fixed width overrides the automatically calculated width. Interactive resizing also sets the “fixed-width” property. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - the new fixed width, or -1 + the new fixed width, or -1 - Sets the menu model that is used to create the context menu + Sets the menu model that is used to create the context menu for the column header. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - a `GMenuModel` + a `GMenuModel` - Sets whether this column should be resizable by dragging. + Sets whether this column should be resizable by dragging. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - whether this column should be resizable + whether this column should be resizable - Associates a sorter with the column. + Associates a sorter with the column. If @sorter is %NULL, the column will not let users change the sorting by clicking on its header. @@ -19138,116 +20002,121 @@ header, or by calling [method@Gtk.ColumnView.sort_by_column]. See [method@Gtk.ColumnView.get_sorter] for the necessary steps for setting up customizable sorting for [class@Gtk.ColumnView]. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - the `GtkSorter` to associate with @column + the `GtkSorter` to associate with @column - Sets the title of this column. + Sets the title of this column. The title is displayed in the header of a `GtkColumnView` for this column and is therefore user-facing text that should be translated. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - Title to use for this column + Title to use for this column - Sets whether this column should be visible in views. + Sets whether this column should be visible in views. + - a `GtkColumnViewColumn` + a `GtkColumnViewColumn` - whether this column should be visible + whether this column should be visible - The `GtkColumnView` this column is a part of. + The `GtkColumnView` this column is a part of. - Column gets share of extra width allocated to the view. + Column gets share of extra width allocated to the view. - Factory for populating list items. + Factory for populating list items. - If not -1, this is the width that the column is allocated, + If not -1, this is the width that the column is allocated, regardless of the size of its content. - Menu model used to create the context menu for the column header. + Menu model used to create the context menu for the column header. - Whether this column is resizable. + Whether this column is resizable. - Sorter for sorting items according to this column. + Sorter for sorting items according to this column. - Title displayed in the header. + Title displayed in the header. - Whether this column is visible. + Whether this column is visible. - + + + - A `GtkComboBox` is a widget that allows the user to choose from a list of + A `GtkComboBox` is a widget that allows the user to choose from a list of valid choices. ![An example GtkComboBox](combo-box.png) @@ -19307,58 +20176,64 @@ node with name arrow. # Accessibility `GtkComboBox` uses the %GTK_ACCESSIBLE_ROLE_COMBO_BOX role. + - Creates a new empty `GtkComboBox`. + Creates a new empty `GtkComboBox`. + - A new `GtkComboBox` + A new `GtkComboBox` - Creates a new empty `GtkComboBox` with an entry. + Creates a new empty `GtkComboBox` with an entry. In order to use a combo box with entry, you need to tell it which column of the model contains the text for the entry by calling [method@Gtk.ComboBox.set_entry_text_column]. + - A new `GtkComboBox` + A new `GtkComboBox` - Creates a new `GtkComboBox` with a model. + Creates a new `GtkComboBox` with a model. + - A new `GtkComboBox` + A new `GtkComboBox` - a `GtkTreeModel` + a `GtkTreeModel` - Creates a new empty `GtkComboBox` with an entry and a model. + Creates a new empty `GtkComboBox` with an entry and a model. See also [ctor@Gtk.ComboBox.new_with_entry]. + - A new `GtkComboBox` + A new `GtkComboBox` - A `GtkTreeModel` + A `GtkTreeModel` + @@ -19369,6 +20244,7 @@ See also [ctor@Gtk.ComboBox.new_with_entry]. + @@ -19382,27 +20258,28 @@ See also [ctor@Gtk.ComboBox.new_with_entry]. - Returns the index of the currently active item. + Returns the index of the currently active item. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns `gtk_tree_path_get_indices (path)[0]`, where `path` is the [struct@Gtk.TreePath] of the active item. + - An integer which is the index of the currently active item, + An integer which is the index of the currently active item, or -1 if there’s no active item - A `GtkComboBox` + A `GtkComboBox` - Returns the ID of the active row of @combo_box. + Returns the ID of the active row of @combo_box. This value is taken from the active row and the column specified by the [property@Gtk.ComboBox:id-column] property of @combo_box @@ -19415,42 +20292,45 @@ must not free it. If the [property@Gtk.ComboBox:id-column] property of @combo_box is not set, or if no row is active, or if the active row has a %NULL ID value, then %NULL is returned. + - the ID of the active row + the ID of the active row - a `GtkComboBox` + a `GtkComboBox` - Sets @iter to point to the currently active item. + Sets @iter to point to the currently active item. If no item is active, @iter is left unchanged. + - %TRUE if @iter was set, %FALSE otherwise + %TRUE if @iter was set, %FALSE otherwise - A `GtkComboBox` + A `GtkComboBox` - A `GtkTreeIter` + A `GtkTreeIter` - Returns whether the combo box sets the dropdown button + Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model. + - %GTK_SENSITIVITY_ON if the dropdown button + %GTK_SENSITIVITY_ON if the dropdown button is sensitive when the model is empty, %GTK_SENSITIVITY_OFF if the button is always insensitive or %GTK_SENSITIVITY_AUTO if it is only sensitive as long as the model has one item to @@ -19459,176 +20339,187 @@ sensitive or not when there are no items in the model. - a `GtkComboBox` + a `GtkComboBox` - Gets the child widget of @combo_box. + Gets the child widget of @combo_box. + - the child widget of @combo_box + the child widget of @combo_box - a `GtkComboBox` + a `GtkComboBox` - Returns the column which @combo_box is using to get the strings + Returns the column which @combo_box is using to get the strings from to display in the internal entry. + - A column in the data source model of @combo_box. + A column in the data source model of @combo_box. - A `GtkComboBox` + A `GtkComboBox` - Returns whether the combo box has an entry. + Returns whether the combo box has an entry. + - whether there is an entry in @combo_box. + whether there is an entry in @combo_box. - a `GtkComboBox` + a `GtkComboBox` - Returns the column which @combo_box is using to get string IDs + Returns the column which @combo_box is using to get string IDs for values from. + - A column in the data source model of @combo_box. + A column in the data source model of @combo_box. - A `GtkComboBox` + A `GtkComboBox` - Returns the `GtkTreeModel` of @combo_box. + Returns the `GtkTreeModel` of @combo_box. + - A `GtkTreeModel` which was passed + A `GtkTreeModel` which was passed during construction. - A `GtkComboBox` + A `GtkComboBox` - Gets whether the popup uses a fixed width. + Gets whether the popup uses a fixed width. + - %TRUE if the popup uses a fixed width + %TRUE if the popup uses a fixed width - a `GtkComboBox` + a `GtkComboBox` - Returns the current row separator function. + Returns the current row separator function. + - the current row separator function. + the current row separator function. - a `GtkComboBox` + a `GtkComboBox` - Hides the menu or dropdown list of @combo_box. + Hides the menu or dropdown list of @combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. + - a `GtkComboBox` + a `GtkComboBox` - Pops up the menu or dropdown list of @combo_box. + Pops up the menu or dropdown list of @combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Before calling this, @combo_box must be mapped, or nothing will happen. + - a `GtkComboBox` + a `GtkComboBox` - Pops up the menu of @combo_box. + Pops up the menu of @combo_box. Note that currently this does not do anything with the device, as it was previously only used for list-mode combo boxes, and those were removed in GTK 4. However, it is retained in case similar functionality is added back later. + - a `GtkComboBox` + a `GtkComboBox` - a `GdkDevice` + a `GdkDevice` - Sets the active item of @combo_box to be the item at @index. + Sets the active item of @combo_box to be the item at @index. + - a `GtkComboBox` + a `GtkComboBox` - An index in the model passed during construction, + An index in the model passed during construction, or -1 to have no active item @@ -19636,7 +20527,7 @@ back later. - Changes the active row of @combo_box to the one that has an ID equal to + Changes the active row of @combo_box to the one that has an ID equal to @active_id. If @active_id is %NULL, the active row is unset. Rows having @@ -19645,78 +20536,82 @@ a %NULL ID string cannot be made active by this function. If the [property@Gtk.ComboBox:id-column] property of @combo_box is unset or if no row has the given ID then the function does nothing and returns %FALSE. + - %TRUE if a row with a matching ID was found. If a %NULL + %TRUE if a row with a matching ID was found. If a %NULL @active_id was given to unset the active row, the function always returns %TRUE. - a `GtkComboBox` + a `GtkComboBox` - the ID of the row to select + the ID of the row to select - Sets the current active item to be the one referenced by @iter. + Sets the current active item to be the one referenced by @iter. If @iter is %NULL, the active item is unset. + - A `GtkComboBox` + A `GtkComboBox` - The `GtkTreeIter` + The `GtkTreeIter` - Sets whether the dropdown button of the combo box should update + Sets whether the dropdown button of the combo box should update its sensitivity depending on the model contents. + - a `GtkComboBox` + a `GtkComboBox` - specify the sensitivity of the dropdown button + specify the sensitivity of the dropdown button - Sets the child widget of @combo_box. + Sets the child widget of @combo_box. + - a `GtkComboBox` + a `GtkComboBox` - the child widget + the child widget - Sets the model column which @combo_box should use to get strings + Sets the model column which @combo_box should use to get strings from to be @text_column. For this column no separate @@ -19727,16 +20622,17 @@ type %G_TYPE_STRING. This is only relevant if @combo_box has been created with [property@Gtk.ComboBox:has-entry] as %TRUE. + - A `GtkComboBox` + A `GtkComboBox` - A column in @model to get the strings from for + A column in @model to get the strings from for the internal entry @@ -19744,28 +20640,29 @@ This is only relevant if @combo_box has been created with - Sets the model column which @combo_box should use to get string IDs + Sets the model column which @combo_box should use to get string IDs for values from. The column @id_column in the model of @combo_box must be of type %G_TYPE_STRING. + - A `GtkComboBox` + A `GtkComboBox` - A column in @model to get string IDs for values from + A column in @model to get string IDs for values from - Sets the model used by @combo_box to be @model. + Sets the model used by @combo_box to be @model. Will unset a previously set model (if applicable). If model is %NULL, then it will unset the model. @@ -19773,64 +20670,67 @@ then it will unset the model. Note that this function does not clear the cell renderers, you have to call [method@Gtk.CellLayout.clear] yourself if you need to set up different cell renderers for the new model. + - A `GtkComboBox` + A `GtkComboBox` - A `GtkTreeModel` + A `GtkTreeModel` - Specifies whether the popup’s width should be a fixed width. + Specifies whether the popup’s width should be a fixed width. If @fixed is %TRUE, the popup's width is set to match the allocated width of the combo box. + - a `GtkComboBox` + a `GtkComboBox` - whether to use a fixed popup width + whether to use a fixed popup width - Sets the row separator function, which is used to determine + Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is %NULL, no separators are drawn. This is the default value. + - a `GtkComboBox` + a `GtkComboBox` - a `GtkTreeViewRowSeparatorFunc` + a `GtkTreeViewRowSeparatorFunc` - user data to pass to @func + user data to pass to @func - destroy notifier for @data + destroy notifier for @data @@ -19838,7 +20738,7 @@ This is the default value. - The item which is currently active. + The item which is currently active. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this property has the value @@ -19849,26 +20749,26 @@ immediate child of the root of the tree, this property has the value - The value of the ID column of the active row. + The value of the ID column of the active row. - Whether the dropdown button is sensitive when + Whether the dropdown button is sensitive when the model is empty. - The child widget. + The child widget. - The model column to associate with strings from the entry. + The model column to associate with strings from the entry. This is property only relevant if the combo was created with [property@Gtk.ComboBox:has-entry] is %TRUE. @@ -19876,35 +20776,35 @@ This is property only relevant if the combo was created with - Whether the combo box has an entry. + Whether the combo box has an entry. - The `has-frame` property controls whether a frame is drawn around the entry. + The `has-frame` property controls whether a frame is drawn around the entry. - The model column that provides string IDs for the values + The model column that provides string IDs for the values in the model, if != -1. - The model from which the combo box takes its values. + The model from which the combo box takes its values. - Whether the popup's width should be a fixed width matching the + Whether the popup's width should be a fixed width matching the allocated width of the combo box. - Whether the combo boxes dropdown is popped up. + Whether the combo boxes dropdown is popped up. Note that this property is mainly useful, because it allows you to connect to notify::popup-shown. @@ -19914,7 +20814,7 @@ it allows you to connect to notify::popup-shown. - Emitted when the active item is changed. + Emitted when the active item is changed. The can be due to the user selecting a different item from the list, or due to a call to [method@Gtk.ComboBox.set_active_iter]. It will @@ -19924,7 +20824,7 @@ also be emitted while typing into the entry of a combo box with an entry. - Emitted to allow changing how the text in a combo box's entry is displayed. + Emitted to allow changing how the text in a combo box's entry is displayed. See [property@Gtk.ComboBox:has-entry]. @@ -19956,20 +20856,20 @@ format_entry_text_callback (GtkComboBox *combo, } ``` - a newly allocated string representing @path + a newly allocated string representing @path for the current `GtkComboBox` model. - the [struct@Gtk.TreePath] string from the combo box's current model + the [struct@Gtk.TreePath] string from the combo box's current model to format text for - Emitted to move the active selection. + Emitted to move the active selection. This is an [keybinding signal](class.SignalAction.html). @@ -19977,13 +20877,13 @@ This is an [keybinding signal](class.SignalAction.html). - a `GtkScrollType` + a `GtkScrollType` - Emitted to popdown the combo box list. + Emitted to popdown the combo box list. This is an [keybinding signal](class.SignalAction.html). @@ -19993,7 +20893,7 @@ The default bindings for this signal are Alt+Up and Escape. - Emitted to popup the combo box list. + Emitted to popup the combo box list. This is an [keybinding signal](class.SignalAction.html). @@ -20004,12 +20904,14 @@ The default binding for this signal is Alt+Down. + - The parent class. + The parent class. + @@ -20022,6 +20924,7 @@ The default binding for this signal is Alt+Down. + @@ -20042,7 +20945,7 @@ The default binding for this signal is Alt+Down. - A `GtkComboBoxText` is a simple variant of `GtkComboBox` for text-only + A `GtkComboBoxText` is a simple variant of `GtkComboBox` for text-only use cases. ![An example GtkComboBoxText](combo-box-text.png) @@ -20103,259 +21006,273 @@ children, and the .linked class to the node of its internal box. - Creates a new `GtkComboBoxText`. + Creates a new `GtkComboBoxText`. + - A new `GtkComboBoxText` + A new `GtkComboBoxText` - Creates a new `GtkComboBoxText` with an entry. + Creates a new `GtkComboBoxText` with an entry. + - a new `GtkComboBoxText` + a new `GtkComboBoxText` - Appends @text to the list of strings stored in @combo_box. + Appends @text to the list of strings stored in @combo_box. If @id is non-%NULL then it is used as the ID of the row. This is the same as calling [method@Gtk.ComboBoxText.insert] with a position of -1. + - A `GtkComboBoxText` + A `GtkComboBoxText` - a string ID for this value + a string ID for this value - A string + A string - Appends @text to the list of strings stored in @combo_box. + Appends @text to the list of strings stored in @combo_box. This is the same as calling [method@Gtk.ComboBoxText.insert_text] with a position of -1. + - A `GtkComboBoxText` + A `GtkComboBoxText` - A string + A string - Returns the currently active string in @combo_box. + Returns the currently active string in @combo_box. If no row is currently selected, %NULL is returned. If @combo_box contains an entry, this function will return its contents (which will not necessarily be an item from the list). + - a newly allocated + a newly allocated string containing the currently active text. Must be freed with g_free(). - A `GtkComboBoxText` + A `GtkComboBoxText` - Inserts @text at @position in the list of strings stored in @combo_box. + Inserts @text at @position in the list of strings stored in @combo_box. If @id is non-%NULL then it is used as the ID of the row. See [property@Gtk.ComboBox:id-column]. If @position is negative then @text is appended. + - A `GtkComboBoxText` + A `GtkComboBoxText` - An index to insert @text + An index to insert @text - a string ID for this value + a string ID for this value - A string to display + A string to display - Inserts @text at @position in the list of strings stored in @combo_box. + Inserts @text at @position in the list of strings stored in @combo_box. If @position is negative then @text is appended. This is the same as calling [method@Gtk.ComboBoxText.insert] with a %NULL ID string. + - A `GtkComboBoxText` + A `GtkComboBoxText` - An index to insert @text + An index to insert @text - A string + A string - Prepends @text to the list of strings stored in @combo_box. + Prepends @text to the list of strings stored in @combo_box. If @id is non-%NULL then it is used as the ID of the row. This is the same as calling [method@Gtk.ComboBoxText.insert] with a position of 0. + - A `GtkComboBox` + A `GtkComboBox` - a string ID for this value + a string ID for this value - a string + a string - Prepends @text to the list of strings stored in @combo_box. + Prepends @text to the list of strings stored in @combo_box. This is the same as calling [method@Gtk.ComboBoxText.insert_text] with a position of 0. + - A `GtkComboBox` + A `GtkComboBox` - A string + A string - Removes the string at @position from @combo_box. + Removes the string at @position from @combo_box. + - A `GtkComboBox` + A `GtkComboBox` - Index of the item to remove + Index of the item to remove - Removes all the text entries from the combo box. + Removes all the text entries from the combo box. + - A `GtkComboBoxText` + A `GtkComboBoxText` - A constant value in a `GtkExpression`. + A constant value in a `GtkExpression`. - Creates a `GtkExpression` that evaluates to the + Creates a `GtkExpression` that evaluates to the object given by the arguments. + - a new `GtkExpression` + a new `GtkExpression` - The type of the object + The type of the object - arguments to create the object from + arguments to create the object from - Creates an expression that always evaluates to the given `value`. + Creates an expression that always evaluates to the given `value`. + - a new `GtkExpression` + a new `GtkExpression` - a `GValue` + a `GValue` - Gets the value that a constant expression evaluates to. + Gets the value that a constant expression evaluates to. + - the value + the value - a constant `GtkExpression` + a constant `GtkExpression` - `GtkConstraint` describes a constraint between attributes of two widgets, + `GtkConstraint` describes a constraint between attributes of two widgets, expressed as a linear equation. The typical equation for a constraint is: @@ -20370,260 +21287,274 @@ child widget or guide. The source and target, as well as their attributes, of a `GtkConstraint` instance are immutable after creation. + - Creates a new constraint representing a relation between a layout + Creates a new constraint representing a relation between a layout attribute on a source and a layout attribute on a target. + - the newly created constraint + the newly created constraint - the target of the constraint + the target of the constraint - the attribute of `target` to be set + the attribute of `target` to be set - the relation equivalence between `target_attribute` and `source_attribute` + the relation equivalence between `target_attribute` and `source_attribute` - the source of the constraint + the source of the constraint - the attribute of `source` to be read + the attribute of `source` to be read - a multiplication factor to be applied to `source_attribute` + a multiplication factor to be applied to `source_attribute` - a constant factor to be added to `source_attribute` + a constant factor to be added to `source_attribute` - the strength of the constraint + the strength of the constraint - Creates a new constraint representing a relation between a layout + Creates a new constraint representing a relation between a layout attribute on a target and a constant value. + - the newly created constraint + the newly created constraint - a the target of the constraint + a the target of the constraint - the attribute of `target` to be set + the attribute of `target` to be set - the relation equivalence between `target_attribute` and `constant` + the relation equivalence between `target_attribute` and `constant` - a constant factor to be set on `target_attribute` + a constant factor to be set on `target_attribute` - the strength of the constraint + the strength of the constraint - Retrieves the constant factor added to the source attributes' value. + Retrieves the constant factor added to the source attributes' value. + - a constant factor + a constant factor - a `GtkConstraint` + a `GtkConstraint` - Retrieves the multiplication factor applied to the source + Retrieves the multiplication factor applied to the source attribute's value. + - a multiplication factor + a multiplication factor - a `GtkConstraint` + a `GtkConstraint` - The order relation between the terms of the constraint. + The order relation between the terms of the constraint. + - a relation type + a relation type - a `GtkConstraint` + a `GtkConstraint` - Retrieves the [iface@Gtk.ConstraintTarget] used as the source for the + Retrieves the [iface@Gtk.ConstraintTarget] used as the source for the constraint. If the source is set to `NULL` at creation, the constraint will use the widget using the [class@Gtk.ConstraintLayout] as the source. + - the source of the constraint + the source of the constraint - a `GtkConstraint` + a `GtkConstraint` - Retrieves the attribute of the source to be read by the constraint. + Retrieves the attribute of the source to be read by the constraint. + - the source's attribute + the source's attribute - a `GtkConstraint` + a `GtkConstraint` - Retrieves the strength of the constraint. + Retrieves the strength of the constraint. + - the strength value + the strength value - a `GtkConstraint` + a `GtkConstraint` - Retrieves the [iface@Gtk.ConstraintTarget] used as the target for + Retrieves the [iface@Gtk.ConstraintTarget] used as the target for the constraint. If the targe is set to `NULL` at creation, the constraint will use the widget using the [class@Gtk.ConstraintLayout] as the target. + - a `GtkConstraintTarget` + a `GtkConstraintTarget` - a `GtkConstraint` + a `GtkConstraint` - Retrieves the attribute of the target to be set by the constraint. + Retrieves the attribute of the target to be set by the constraint. + - the target's attribute + the target's attribute - a `GtkConstraint` + a `GtkConstraint` - Checks whether the constraint is attached to a [class@Gtk.ConstraintLayout], + Checks whether the constraint is attached to a [class@Gtk.ConstraintLayout], and it is contributing to the layout. + - `TRUE` if the constraint is attached + `TRUE` if the constraint is attached - a `GtkConstraint` + a `GtkConstraint` - Checks whether the constraint describes a relation between an attribute + Checks whether the constraint describes a relation between an attribute on the [property@Gtk.Constraint:target] and a constant value. + - `TRUE` if the constraint is a constant relation + `TRUE` if the constraint is a constant relation - a `GtkConstraint` + a `GtkConstraint` - Checks whether the constraint is a required relation for solving the + Checks whether the constraint is a required relation for solving the constraint layout. + - %TRUE if the constraint is required + %TRUE if the constraint is required - a `GtkConstraint` + a `GtkConstraint` - The constant value to be added to the [property@Gtk.Constraint:source-attribute]. + The constant value to be added to the [property@Gtk.Constraint:source-attribute]. - The multiplication factor to be applied to + The multiplication factor to be applied to the [property@Gtk.Constraint:source-attribute]. - The order relation between the terms of the constraint. + The order relation between the terms of the constraint. - The source of the constraint. + The source of the constraint. The constraint will set the [property@Gtk.Constraint:target-attribute] property of the target using the [property@Gtk.Constraint:source-attribute] @@ -20632,13 +21563,13 @@ property of the source. - The attribute of the [property@Gtk.Constraint:source] read by the + The attribute of the [property@Gtk.Constraint:source] read by the constraint. - The strength of the constraint. + The strength of the constraint. The strength can be expressed either using one of the symbolic values of the [enum@Gtk.ConstraintStrength] enumeration, or any positive integer @@ -20647,7 +21578,7 @@ value. - The target of the constraint. + The target of the constraint. The constraint will set the [property@Gtk.Constraint:target-attribute] property of the target using the [property@Gtk.Constraint:source-attribute] @@ -20656,65 +21587,66 @@ property of the source widget. - The attribute of the [property@Gtk.Constraint:target] set by the constraint. + The attribute of the [property@Gtk.Constraint:target] set by the constraint. - The widget attributes that can be used when creating a `GtkConstraint`. + The widget attributes that can be used when creating a `GtkConstraint`. - No attribute, used for constant + No attribute, used for constant relations - The left edge of a widget, regardless of + The left edge of a widget, regardless of text direction - The right edge of a widget, regardless + The right edge of a widget, regardless of text direction - The top edge of a widget + The top edge of a widget - The bottom edge of a widget + The bottom edge of a widget - The leading edge of a widget, depending + The leading edge of a widget, depending on text direction; equivalent to %GTK_CONSTRAINT_ATTRIBUTE_LEFT for LTR languages, and %GTK_CONSTRAINT_ATTRIBUTE_RIGHT for RTL ones - The trailing edge of a widget, depending + The trailing edge of a widget, depending on text direction; equivalent to %GTK_CONSTRAINT_ATTRIBUTE_RIGHT for LTR languages, and %GTK_CONSTRAINT_ATTRIBUTE_LEFT for RTL ones - The width of a widget + The width of a widget - The height of a widget + The height of a widget - The center of a widget, on the + The center of a widget, on the horizontal axis - The center of a widget, on the + The center of a widget, on the vertical axis - The baseline of a widget + The baseline of a widget + - A `GtkConstraintGuide` is an invisible layout element in a + A `GtkConstraintGuide` is an invisible layout element in a `GtkConstraintLayout`. The `GtkConstraintLayout` treats guides like widgets. They @@ -20726,253 +21658,266 @@ guideline that widgets can be aligned to, or like *flexible space*. Unlike a `GtkWidget`, a `GtkConstraintGuide` will not be drawn. + - Creates a new `GtkConstraintGuide` object. + Creates a new `GtkConstraintGuide` object. + - a new `GtkConstraintGuide` object. + a new `GtkConstraintGuide` object. - Gets the maximum size of @guide. + Gets the maximum size of @guide. + - a `GtkConstraintGuide` object + a `GtkConstraintGuide` object - return location for the maximum width + return location for the maximum width - return location for the maximum height + return location for the maximum height - Gets the minimum size of @guide. + Gets the minimum size of @guide. + - a `GtkConstraintGuide` object + a `GtkConstraintGuide` object - return location for the minimum width + return location for the minimum width - return location for the minimum height + return location for the minimum height - Retrieves the name set using gtk_constraint_guide_set_name(). + Retrieves the name set using gtk_constraint_guide_set_name(). + - the name of the guide + the name of the guide - a `GtkConstraintGuide` + a `GtkConstraintGuide` - Gets the natural size of @guide. + Gets the natural size of @guide. + - a `GtkConstraintGuide` object + a `GtkConstraintGuide` object - return location for the natural width + return location for the natural width - return location for the natural height + return location for the natural height - Retrieves the strength set using gtk_constraint_guide_set_strength(). + Retrieves the strength set using gtk_constraint_guide_set_strength(). + - the strength of the constraint on the natural size + the strength of the constraint on the natural size - a `GtkConstraintGuide` + a `GtkConstraintGuide` - Sets the maximum size of @guide. + Sets the maximum size of @guide. If @guide is attached to a `GtkConstraintLayout`, the constraints will be updated to reflect the new size. + - a `GtkConstraintGuide` object + a `GtkConstraintGuide` object - the new maximum width, or -1 to not change it + the new maximum width, or -1 to not change it - the new maximum height, or -1 to not change it + the new maximum height, or -1 to not change it - Sets the minimum size of @guide. + Sets the minimum size of @guide. If @guide is attached to a `GtkConstraintLayout`, the constraints will be updated to reflect the new size. + - a `GtkConstraintGuide` object + a `GtkConstraintGuide` object - the new minimum width, or -1 to not change it + the new minimum width, or -1 to not change it - the new minimum height, or -1 to not change it + the new minimum height, or -1 to not change it - Sets a name for the given `GtkConstraintGuide`. + Sets a name for the given `GtkConstraintGuide`. The name is useful for debugging purposes. + - a `GtkConstraintGuide` + a `GtkConstraintGuide` - a name for the @guide + a name for the @guide - Sets the natural size of @guide. + Sets the natural size of @guide. If @guide is attached to a `GtkConstraintLayout`, the constraints will be updated to reflect the new size. + - a `GtkConstraintGuide` object + a `GtkConstraintGuide` object - the new natural width, or -1 to not change it + the new natural width, or -1 to not change it - the new natural height, or -1 to not change it + the new natural height, or -1 to not change it - Sets the strength of the constraint on the natural size of the + Sets the strength of the constraint on the natural size of the given `GtkConstraintGuide`. + - a `GtkConstraintGuide` + a `GtkConstraintGuide` - the strength of the constraint + the strength of the constraint - The maximum height of the guide. + The maximum height of the guide. - The maximum width of the guide. + The maximum width of the guide. - The minimum height of the guide. + The minimum height of the guide. - The minimum width of the guide. + The minimum width of the guide. - A name that identifies the `GtkConstraintGuide`, for debugging. + A name that identifies the `GtkConstraintGuide`, for debugging. - The preferred, or natural, height of the guide. + The preferred, or natural, height of the guide. - The preferred, or natural, width of the guide. + The preferred, or natural, width of the guide. - The `GtkConstraintStrength` to be used for the constraint on + The `GtkConstraintStrength` to be used for the constraint on the natural size of the guide. + - A layout manager using constraints to describe relations between widgets. + A layout manager using constraints to describe relations between widgets. `GtkConstraintLayout` is a layout manager that uses relations between widget attributes, expressed via [class@Gtk.Constraint] instances, to @@ -21135,16 +22080,18 @@ Finally, it's also possible to use simple arithmetic operators: // divided by 2 plus 12 [button1(button2 / 2 + 12)] ``` + - Creates a new `GtkConstraintLayout` layout manager. + Creates a new `GtkConstraintLayout` layout manager. + - the newly created `GtkConstraintLayout` + the newly created `GtkConstraintLayout` - Adds a constraint to the layout manager. + Adds a constraint to the layout manager. The [property@Gtk.Constraint:source] and [property@Gtk.Constraint:target] properties of `constraint` can be: @@ -21157,28 +22104,30 @@ properties of `constraint` can be: The @layout acquires the ownership of @constraint after calling this function. + - a `GtkConstraintLayout` + a `GtkConstraintLayout` - a [class@Gtk.Constraint] + a [class@Gtk.Constraint] - Creates a list of constraints from a VFL description. + Creates a list of constraints from a VFL description. This function is a convenience wrapper around [method@Gtk.ConstraintLayout.add_constraints_from_descriptionv], using variadic arguments to populate the view/target map. + - the list of + the list of [class@Gtk.Constraint]s that were added to the layout @@ -21186,45 +22135,45 @@ variadic arguments to populate the view/target map. - a `GtkConstraintLayout` + a `GtkConstraintLayout` - an array of Visual Format Language lines + an array of Visual Format Language lines defining a set of constraints - the number of lines + the number of lines - default horizontal spacing value, or -1 for the fallback value + default horizontal spacing value, or -1 for the fallback value - default vertical spacing value, or -1 for the fallback value + default vertical spacing value, or -1 for the fallback value - return location for a `GError` + return location for a `GError` - the name of a view in the VFL description, followed by the + the name of a view in the VFL description, followed by the [iface@Gtk.ConstraintTarget] to which it maps - a `NULL`-terminated list of view names and [class@Gtk.ConstraintTarget]s + a `NULL`-terminated list of view names and [class@Gtk.ConstraintTarget]s - Creates a list of constraints from a VFL description. + Creates a list of constraints from a VFL description. The Visual Format Language, VFL, is based on Apple's AutoLayout [VFL](https://developer.apple.com/library/content/documentation/UserExperience/Conceptual/AutolayoutPG/VisualFormatLanguage.html). @@ -21301,8 +22250,9 @@ Examples of VFL descriptions are: // Named attributes [button1(==button2.height)] ``` + - the list of + the list of [class@Gtk.Constraint] instances that were added to the layout @@ -21310,30 +22260,30 @@ Examples of VFL descriptions are: - a `GtkConstraintLayout` + a `GtkConstraintLayout` - an array of Visual Format Language lines + an array of Visual Format Language lines defining a set of constraints - the number of lines + the number of lines - default horizontal spacing value, or -1 for the fallback value + default horizontal spacing value, or -1 for the fallback value - default vertical spacing value, or -1 for the fallback value + default vertical spacing value, or -1 for the fallback value - a dictionary of `[ name, target ]` + a dictionary of `[ name, target ]` pairs; the `name` keys map to the view names in the VFL lines, while the `target` values map to children of the widget using a `GtkConstraintLayout`, or guides @@ -21345,29 +22295,30 @@ Examples of VFL descriptions are: - Adds a guide to `layout`. + Adds a guide to `layout`. A guide can be used as the source or target of constraints, like a widget, but it is not visible. The `layout` acquires the ownership of `guide` after calling this function. + - a `GtkConstraintLayout` + a `GtkConstraintLayout` - a [class@Gtk.ConstraintGuide] object + a [class@Gtk.ConstraintGuide] object - Returns a `GListModel` to track the constraints that are + Returns a `GListModel` to track the constraints that are part of the layout. Calling this function will enable extra internal bookkeeping @@ -21376,21 +22327,22 @@ It may slow down operations a lot. Applications should try hard to avoid calling this function because of the slowdowns. + - a + a `GListModel` tracking the layout's constraints - a `GtkConstraintLayout` + a `GtkConstraintLayout` - Returns a `GListModel` to track the guides that are + Returns a `GListModel` to track the guides that are part of the layout. Calling this function will enable extra internal bookkeeping @@ -21399,135 +22351,145 @@ It may slow down operations a lot. Applications should try hard to avoid calling this function because of the slowdowns. + - a + a `GListModel` tracking the layout's guides - a `GtkConstraintLayout` + a `GtkConstraintLayout` - Removes all constraints from the layout manager. + Removes all constraints from the layout manager. + - a `GtkConstraintLayout` + a `GtkConstraintLayout` - Removes `constraint` from the layout manager, + Removes `constraint` from the layout manager, so that it no longer influences the layout. + - a `GtkConstraintLayout` + a `GtkConstraintLayout` - a [class@Gtk.Constraint] + a [class@Gtk.Constraint] - Removes `guide` from the layout manager, + Removes `guide` from the layout manager, so that it no longer influences the layout. + - a `GtkConstraintLayout` + a `GtkConstraintLayout` - a [class@Gtk.ConstraintGuide] object + a [class@Gtk.ConstraintGuide] object - `GtkLayoutChild` subclass for children in a `GtkConstraintLayout`. + `GtkLayoutChild` subclass for children in a `GtkConstraintLayout`. + + + - The relation between two terms of a constraint. + The relation between two terms of a constraint. - Less than, or equal + Less than, or equal - Equal + Equal - Greater than, or equal + Greater than, or equal - The strength of a constraint, expressed as a symbolic constant. + The strength of a constraint, expressed as a symbolic constant. The strength of a `GtkConstraint` can be expressed with any positive integer; the values of this enumeration can be used for readability. - The constraint is required towards solving the layout + The constraint is required towards solving the layout - A strong constraint + A strong constraint - A medium constraint + A medium constraint - A weak constraint + A weak constraint - The `GtkConstraintTarget` interface is implemented by objects that + The `GtkConstraintTarget` interface is implemented by objects that can be used as source or target in `GtkConstraint`s. Besides `GtkWidget`, it is also implemented by `GtkConstraintGuide`. + - + + + - Domain for VFL parsing errors. + Domain for VFL parsing errors. - Invalid or unknown symbol + Invalid or unknown symbol - Invalid or unknown attribute + Invalid or unknown attribute - Invalid or unknown view + Invalid or unknown view - Invalid or unknown metric + Invalid or unknown metric - Invalid or unknown priority + Invalid or unknown priority - Invalid or unknown relation + Invalid or unknown relation @@ -21536,29 +22498,29 @@ Besides `GtkWidget`, it is also implemented by `GtkConstraintGuide`. - Specifies which corner a child widget should be placed in when packed into + Specifies which corner a child widget should be placed in when packed into a `GtkScrolledWindow.` This is effectively the opposite of where the scroll bars are placed. - Place the scrollbars on the right and bottom of the + Place the scrollbars on the right and bottom of the widget (default behaviour). - Place the scrollbars on the top and right of the + Place the scrollbars on the top and right of the widget. - Place the scrollbars on the left and bottom of the + Place the scrollbars on the left and bottom of the widget. - Place the scrollbars on the top and left of the + Place the scrollbars on the top and left of the widget. - Represents a location in a file or other source of data parsed + Represents a location in a file or other source of data parsed by the CSS engine. The @bytes and @line_bytes offsets are meant to be used to @@ -21570,68 +22532,71 @@ whenever a CSS line break is encountered. (CSS defines the C character sequences "\r\n", "\r", "\n" and "\f" as newlines.) If your document uses different rules for line breaking, you might want run into problems here. + - number of bytes parsed since the beginning + number of bytes parsed since the beginning - number of characters parsed since the beginning + number of characters parsed since the beginning - number of full lines that have been parsed. If you want to + number of full lines that have been parsed. If you want to display this as a line number, you need to add 1 to this. - Number of bytes parsed since the last line break + Number of bytes parsed since the last line break - Number of characters parsed since the last line break + Number of characters parsed since the last line break - Errors that can occur while parsing CSS. + Errors that can occur while parsing CSS. These errors are unexpected and will cause parts of the given CSS to be ignored. + - Unknown failure. + Unknown failure. - The given text does not form valid syntax + The given text does not form valid syntax - Failed to import a resource + Failed to import a resource - The given name has not been defined + The given name has not been defined - The given value is not correct + The given value is not correct - Warnings that can occur while parsing CSS. + Warnings that can occur while parsing CSS. Unlike `GtkCssParserError`s, warnings do not cause the parser to skip any input, but they indicate issues that should be fixed. + - The given construct is + The given construct is deprecated and will be removed in a future version - A syntax construct was used + A syntax construct was used that should be avoided - A feature is not implemented + A feature is not implemented - `GtkCssProvider` is an object implementing the `GtkStyleProvider` interface + `GtkCssProvider` is an object implementing the `GtkStyleProvider` interface for CSS. It is able to parse CSS-like input in order to style widgets. @@ -21660,34 +22625,37 @@ current version, GTK tries older versions all the way back to 4.0. To track errors while loading CSS, connect to the [signal@Gtk.CssProvider::parsing-error] signal. + - Returns a newly created `GtkCssProvider`. + Returns a newly created `GtkCssProvider`. + - A new `GtkCssProvider` + A new `GtkCssProvider` - Loads @data into @css_provider. + Loads @data into @css_provider. This clears any previously loaded information. + - a `GtkCssProvider` + a `GtkCssProvider` - CSS data loaded in memory + CSS data loaded in memory - the length of @data in bytes, or -1 for NUL terminated strings. If + the length of @data in bytes, or -1 for NUL terminated strings. If @length is not -1, the code will assume it is not NUL terminated and will potentially do a copy. @@ -21695,100 +22663,105 @@ This clears any previously loaded information. - Loads the data contained in @file into @css_provider. + Loads the data contained in @file into @css_provider. This clears any previously loaded information. + - a `GtkCssProvider` + a `GtkCssProvider` - `GFile` pointing to a file to load + `GFile` pointing to a file to load - Loads the data contained in @path into @css_provider. + Loads the data contained in @path into @css_provider. This clears any previously loaded information. + - a `GtkCssProvider` + a `GtkCssProvider` - the path of a filename to load, in the GLib filename encoding + the path of a filename to load, in the GLib filename encoding - Loads the data contained in the resource at @resource_path into + Loads the data contained in the resource at @resource_path into the @css_provider. This clears any previously loaded information. + - a `GtkCssProvider` + a `GtkCssProvider` - a `GResource` resource path + a `GResource` resource path - Loads a theme from the usual theme paths. + Loads a theme from the usual theme paths. The actual process of finding the theme might change between releases, but it is guaranteed that this function uses the same mechanism to load the theme that GTK uses for loading its own theme. + - a `GtkCssProvider` + a `GtkCssProvider` - A theme name + A theme name - variant to load, for example, "dark", or + variant to load, for example, "dark", or %NULL for the default - Converts the @provider into a string representation in CSS + Converts the @provider into a string representation in CSS format. Using [method@Gtk.CssProvider.load_from_data] with the return value from this function on a new provider created with [ctor@Gtk.CssProvider.new] will basically create a duplicate of this @provider. + - a new string representing the @provider. + a new string representing the @provider. - the provider to write to a string + the provider to write to a string @@ -21797,7 +22770,7 @@ of this @provider. - Signals that a parsing error occurred. + Signals that a parsing error occurred. The @path, @line and @position describe the actual location of the error as accurately as possible. @@ -21815,79 +22788,87 @@ than when a loading function was called. - section the error happened in + section the error happened in - The parsing error + The parsing error - - + + + + + + - Defines a part of a CSS document. + Defines a part of a CSS document. Because sections are nested into one another, you can use gtk_css_section_get_parent() to get the containing region. + - Creates a new `GtkCssSection` referring to the section + Creates a new `GtkCssSection` referring to the section in the given `file` from the `start` location to the `end` location. + - a new `GtkCssSection` + a new `GtkCssSection` - The file this section refers to + The file this section refers to - The start location + The start location - The end location + The end location - Returns the location in the CSS document where this section ends. + Returns the location in the CSS document where this section ends. + - The end location of + The end location of this section - the section + the section - Gets the file that @section was parsed from. + Gets the file that @section was parsed from. If no such file exists, for example because the CSS was loaded via [method@Gtk.CssProvider.load_from_data], then `NULL` is returned. + - the `GFile` from which the `section` + the `GFile` from which the `section` was parsed - the section + the section - Gets the parent section for the given `section`. + Gets the parent section for the given `section`. The parent section is the section that contains this `section`. A special case are sections of type `GTK_CSS_SECTION_DOCUMEN`T. Their parent will @@ -21895,147 +22876,158 @@ either be `NULL` if they are the original CSS document that was loaded by [method@Gtk.CssProvider.load_from_file] or a section of type `GTK_CSS_SECTION_IMPORT` if it was loaded with an `@import` rule from a different file. + - the parent section + the parent section - the section + the section - Returns the location in the CSS document where this section starts. + Returns the location in the CSS document where this section starts. + - The start location of + The start location of this section - the section + the section - Prints the `section` into `string` in a human-readable form. + Prints the `section` into `string` in a human-readable form. This is a form like `gtk.css:32:1-23` to denote line 32, characters 1 to 23 in the file `gtk.css`. + - a section + a section - a `GString` to print to + a `GString` to print to - Increments the reference count on `section`. + Increments the reference count on `section`. + - the CSS section itself. + the CSS section itself. - a `GtkCssSection` + a `GtkCssSection` - Prints the section into a human-readable text form using + Prints the section into a human-readable text form using [method@Gtk.CssSection.print]. + - A new string. + A new string. - a `GtkCssSection` + a `GtkCssSection` - Decrements the reference count on `section`, freeing the + Decrements the reference count on `section`, freeing the structure if the reference count reaches 0. + - a `GtkCssSection` + a `GtkCssSection` - + + + - A function to be used by `GtkCustomLayout` to allocate a widget. + A function to be used by `GtkCustomLayout` to allocate a widget. + - the widget to allocate + the widget to allocate - the new width of the widget + the new width of the widget - the new height of the widget + the new height of the widget - the new baseline of the widget, or -1 + the new baseline of the widget, or -1 - `GtkCustomFilter` determines whether to include items with a callback. + `GtkCustomFilter` determines whether to include items with a callback. + - Creates a new filter using the given @match_func to filter + Creates a new filter using the given @match_func to filter items. If @match_func is %NULL, the filter matches all items. If the filter func changes its filtering behavior, gtk_filter_changed() needs to be called. + - a new `GtkCustomFilter` + a new `GtkCustomFilter` - function to filter items + function to filter items - user data to pass to @match_func + user data to pass to @match_func - destroy notify for @user_data + destroy notify for @user_data - Sets the function used for filtering items. + Sets the function used for filtering items. If @match_func is %NULL, the filter matches all items. @@ -22044,84 +23036,89 @@ gtk_filter_changed() needs to be called. If a previous function was set, its @user_destroy will be called now. + - a `GtkCustomFilter` + a `GtkCustomFilter` - function to filter items + function to filter items - user data to pass to @match_func + user data to pass to @match_func - destroy notify for @user_data + destroy notify for @user_data + - User function that is called to determine if the @item should be matched. + User function that is called to determine if the @item should be matched. If the filter matches the item, this function must return %TRUE. If the item should be filtered out, %FALSE must be returned. + - %TRUE to keep the item around + %TRUE to keep the item around - The item to be matched + The item to be matched - user data + user data - `GtkCustomLayout` uses closures for size negotiation. + `GtkCustomLayout` uses closures for size negotiation. A `GtkCustomLayout `uses closures matching to the old `GtkWidget` virtual functions for size negotiation, as a convenience API to ease the porting towards the corresponding `GtkLayoutManager virtual functions. + - Creates a new legacy layout manager. + Creates a new legacy layout manager. Legacy layout managers map to the old `GtkWidget` size negotiation virtual functions, and are meant to be used during the transition from layout containers to layout manager delegates. + - the newly created `GtkCustomLayout` + the newly created `GtkCustomLayout` - a function to retrieve + a function to retrieve the `GtkSizeRequestMode` of the widget using the layout; the default request mode is %GTK_SIZE_REQUEST_CONSTANT_SIZE - a function to measure the widget using the layout manager + a function to measure the widget using the layout manager - a function to allocate the children of the widget using + a function to allocate the children of the widget using the layout manager @@ -22129,88 +23126,93 @@ from layout containers to layout manager delegates. + - A function to be used by `GtkCustomLayout` to measure a widget. + A function to be used by `GtkCustomLayout` to measure a widget. + - the widget to be measured + the widget to be measured - the direction to be measured + the direction to be measured - the size to be measured for + the size to be measured for - the measured minimum size of the widget + the measured minimum size of the widget - the measured natural size of the widget + the measured natural size of the widget - the measured minimum baseline of the widget + the measured minimum baseline of the widget - the measured natural baseline of the widget + the measured natural baseline of the widget - Queries a widget for its preferred size request mode. + Queries a widget for its preferred size request mode. + - the size request mode + the size request mode - the widget to be queried + the widget to be queried - `GtkCustomSorter` is a `GtkSorter` implementation that sorts via a callback + `GtkCustomSorter` is a `GtkSorter` implementation that sorts via a callback function. + - Creates a new `GtkSorter` that works by calling + Creates a new `GtkSorter` that works by calling @sort_func to compare items. If @sort_func is %NULL, all items are considered equal. + - a new `GtkCustomSorter` + a new `GtkCustomSorter` - the `GCompareDataFunc` to use for sorting + the `GCompareDataFunc` to use for sorting - user data to pass to @sort_func + user data to pass to @sort_func - destroy notify for @user_data + destroy notify for @user_data - Sets (or unsets) the function used for sorting items. + Sets (or unsets) the function used for sorting items. If @sort_func is %NULL, all items are considered equal. @@ -22219,247 +23221,268 @@ gtk_sorter_changed() needs to be called. If a previous function was set, its @user_destroy will be called now. + - a `GtkCustomSorter` + a `GtkCustomSorter` - function to sort items + function to sort items - user data to pass to @match_func + user data to pass to @match_func - destroy notify for @user_data + destroy notify for @user_data + + + + + + + + + + + + + + + + + + + + - Flags to use with gtk_set_debug_flags(). + Flags to use with gtk_set_debug_flags(). Settings these flags causes GTK to print out different types of debugging information. Some of these flags are only available when GTK has been configured with `-Ddebug=true`. - Information about GtkTextView + Information about GtkTextView - Information about GtkTreeView + Information about GtkTreeView - Information about keyboard shortcuts + Information about keyboard shortcuts - Information about modules and extensions + Information about modules and extensions - Information about size allocation + Information about size allocation - Information about icon themes + Information about icon themes - Information about printing + Information about printing - Trace GtkBuilder operation + Trace GtkBuilder operation - Information about size requests + Information about size requests - Disable the style property cache + Disable the style property cache - Open the GTK inspector + Open the GTK inspector - Pretend the pointer is a touchscreen + Pretend the pointer is a touchscreen - Information about actions and menu models + Information about actions and menu models - Information from layout managers + Information from layout managers - Include debug render nodes in the generated snapshots + Include debug render nodes in the generated snapshots - Information from the constraints solver + Information from the constraints solver - Log unused GtkBuilder objects + Log unused GtkBuilder objects - Information about accessibility state changes + Information about accessibility state changes - Information about icon fallback. Since: 4.2 + Information about icon fallback. Since: 4.2 - Passed to various keybinding signals for deleting text. + Passed to various keybinding signals for deleting text. - Delete characters. + Delete characters. - Delete only the portion of the word to the + Delete only the portion of the word to the left/right of cursor if we’re in the middle of a word. - Delete words. + Delete words. - Delete display-lines. Display-lines + Delete display-lines. Display-lines refers to the visible lines, with respect to the current line breaks. As opposed to paragraphs, which are defined by line breaks in the input. - Delete only the portion of the + Delete only the portion of the display-line to the left/right of cursor. - Delete to the end of the + Delete to the end of the paragraph. Like C-k in Emacs (or its reverse). - Delete entire line. Like C-k in pico. + Delete entire line. Like C-k in pico. - Delete only whitespace. Like M-\ in Emacs. + Delete only whitespace. Like M-\ in Emacs. - Dialogs are a convenient way to prompt the user for a small amount + Dialogs are a convenient way to prompt the user for a small amount of input. ![An example GtkDialog](dialog.png) @@ -22580,6 +23603,7 @@ An example of a `GtkDialog` UI definition fragment: # Accessibility `GtkDialog` uses the %GTK_ACCESSIBLE_ROLE_DIALOG role. + @@ -22587,18 +23611,19 @@ An example of a `GtkDialog` UI definition fragment: - Creates a new dialog box. + Creates a new dialog box. Widgets should not be packed into the `GtkWindow` directly, but into the @content_area and @action_area, as described above. + - the new dialog as a `GtkWidget` + the new dialog as a `GtkWidget` - Creates a new `GtkDialog` with the given title and transient parent. + Creates a new `GtkDialog` with the given title and transient parent. The @flags argument can be used to make the dialog modal, have it destroyed along with its transient parent, or make it use a headerbar. @@ -22631,34 +23656,36 @@ dialog = gtk_dialog_new_with_buttons ("My dialog", GTK_RESPONSE_REJECT, NULL); ``` + - a new `GtkDialog` + a new `GtkDialog` - Title of the dialog + Title of the dialog - Transient parent of the dialog + Transient parent of the dialog - from `GtkDialogFlags` + from `GtkDialogFlags` - text to go in first button + text to go in first button - response ID for first button, then additional buttons, ending with %NULL + response ID for first button, then additional buttons, ending with %NULL + @@ -22670,25 +23697,26 @@ dialog = gtk_dialog_new_with_buttons ("My dialog", - Emits the ::response signal with the given response ID. + Emits the ::response signal with the given response ID. Used to indicate that the user has responded to the dialog in some way. + - a `GtkDialog` + a `GtkDialog` - response ID + response ID - Adds an activatable widget to the action area of a `GtkDialog`. + Adds an activatable widget to the action area of a `GtkDialog`. GTK connects a signal handler that will emit the [signal@Gtk.Dialog::response] signal on the dialog when the widget @@ -22697,204 +23725,214 @@ area. If you want to add a non-activatable widget, simply pack it into the @action_area field of the `GtkDialog` struct. + - a `GtkDialog` + a `GtkDialog` - an activatable widget + an activatable widget - response ID for @child + response ID for @child - Adds a button with the given text. + Adds a button with the given text. GTK arranges things so that clicking the button will emit the [signal@Gtk.Dialog::response] signal with the given @response_id. The button is appended to the end of the dialog’s action area. The button widget is returned, but usually you don’t need it. + - the `GtkButton` widget that was added + the `GtkButton` widget that was added - a `GtkDialog` + a `GtkDialog` - text of button + text of button - response ID for the button + response ID for the button - Adds multiple buttons. + Adds multiple buttons. This is the same as calling [method@Gtk.Dialog.add_button] repeatedly. The variable argument list should be %NULL-terminated as with [ctor@Gtk.Dialog.new_with_buttons]. Each button must have both text and response ID. + - a `GtkDialog` + a `GtkDialog` - button text + button text - response ID for first button, then more text-response_id pairs + response ID for first button, then more text-response_id pairs - Returns the content area of @dialog. + Returns the content area of @dialog. + - the content area `GtkBox`. + the content area `GtkBox`. - a `GtkDialog` + a `GtkDialog` - Returns the header bar of @dialog. + Returns the header bar of @dialog. Note that the headerbar is only used by the dialog if the [property@Gtk.Dialog:use-header-bar] property is %TRUE. + - the header bar + the header bar - a `GtkDialog` + a `GtkDialog` - Gets the response id of a widget in the action area + Gets the response id of a widget in the action area of a dialog. + - the response id of @widget, or %GTK_RESPONSE_NONE + the response id of @widget, or %GTK_RESPONSE_NONE if @widget doesn’t have a response id set. - a `GtkDialog` + a `GtkDialog` - a widget in the action area of @dialog + a widget in the action area of @dialog - Gets the widget button that uses the given response ID in the action area + Gets the widget button that uses the given response ID in the action area of a dialog. + - the @widget button that uses the given + the @widget button that uses the given @response_id - a `GtkDialog` + a `GtkDialog` - the response ID used by the @dialog widget + the response ID used by the @dialog widget - Emits the ::response signal with the given response ID. + Emits the ::response signal with the given response ID. Used to indicate that the user has responded to the dialog in some way. + - a `GtkDialog` + a `GtkDialog` - response ID + response ID - Sets the default widget for the dialog based on the response ID. + Sets the default widget for the dialog based on the response ID. Pressing “Enter” normally activates the default widget. + - a `GtkDialog` + a `GtkDialog` - a response ID + a response ID - A convenient way to sensitize/desensitize dialog buttons. + A convenient way to sensitize/desensitize dialog buttons. Calls `gtk_widget_set_sensitive (widget, @setting)` for each widget in the dialog’s action area with the given @response_id. + - a `GtkDialog` + a `GtkDialog` - a response ID + a response ID - %TRUE for sensitive + %TRUE for sensitive - %TRUE if the dialog uses a headerbar for action buttons + %TRUE if the dialog uses a headerbar for action buttons instead of the action-area. For technical reasons, this property is declared as an integer @@ -22918,7 +23956,7 @@ dialog = g_object_new (GTK_TYPE_DIALOG, header, TRUE, NULL); - Emitted when the user uses a keybinding to close the dialog. + Emitted when the user uses a keybinding to close the dialog. This is a [keybinding signal](class.SignalAction.html). @@ -22928,7 +23966,7 @@ The default binding for this signal is the Escape key. - Emitted when an action widget is clicked. + Emitted when an action widget is clicked. The signal is also emitted when the dialog receives a delete event, and when [method@Gtk.Dialog.response] is called. @@ -22939,29 +23977,31 @@ Otherwise, it depends on which action widget was clicked. - the response ID + the response ID + - The parent class. + The parent class. + - a `GtkDialog` + a `GtkDialog` - response ID + response ID @@ -22969,6 +24009,7 @@ Otherwise, it depends on which action widget was clicked. + @@ -22986,41 +24027,41 @@ Otherwise, it depends on which action widget was clicked. - Flags used to influence dialog construction. + Flags used to influence dialog construction. - Make the constructed dialog modal + Make the constructed dialog modal - Destroy the dialog when its parent is destroyed + Destroy the dialog when its parent is destroyed - Create dialog with actions in header + Create dialog with actions in header bar instead of action area - Focus movement types. + Focus movement types. - Move forward. + Move forward. - Move backward. + Move backward. - Move up. + Move up. - Move down. + Move down. - Move left. + Move left. - Move right. + Move right. - `GtkDirectoryList` is a list model that wraps g_file_enumerate_children_async(). + `GtkDirectoryList` is a list model that wraps g_file_enumerate_children_async(). It presents a `GListModel` and fills it asynchronously with the `GFileInfo`s returned from that function. @@ -23042,44 +24083,47 @@ that is referred to in the same way you would via g_file_enumerator_get_child(). This means you do not need access to the `GtkDirectoryList`, but can access the `GFile` directly from the `GFileInfo` when operating with a `GtkListView` or similar. + - Creates a new `GtkDirectoryList`. + Creates a new `GtkDirectoryList`. The `GtkDirectoryList` is querying the given @file with the given @attributes. + - a new `GtkDirectoryList` + a new `GtkDirectoryList` - The attributes to query with + The attributes to query with - The file to query + The file to query - Gets the attributes queried on the children. + Gets the attributes queried on the children. + - The queried attributes + The queried attributes - a `GtkDirectoryList` + a `GtkDirectoryList` - Gets the loading error, if any. + Gets the loading error, if any. If an error occurs during the loading process, the loading process will finish and this property allows querying the error that happened. @@ -23087,122 +24131,129 @@ This error will persist until a file is loaded again. An error being set does not mean that no files were loaded, and all successfully queried files will remain in the list. + - The loading error or %NULL if + The loading error or %NULL if loading finished successfully - a `GtkDirectoryList` + a `GtkDirectoryList` - Gets the file whose children are currently enumerated. + Gets the file whose children are currently enumerated. + - The file whose children are enumerated + The file whose children are enumerated - a `GtkDirectoryList` + a `GtkDirectoryList` - Gets the IO priority set via gtk_directory_list_set_io_priority(). + Gets the IO priority set via gtk_directory_list_set_io_priority(). + - The IO priority. + The IO priority. - a `GtkDirectoryList` + a `GtkDirectoryList` - Returns whether the directory list is monitoring + Returns whether the directory list is monitoring the directory for changes. + - %TRUE if the directory is monitored + %TRUE if the directory is monitored - a `GtkDirectoryList` + a `GtkDirectoryList` - Returns %TRUE if the children enumeration is currently in + Returns %TRUE if the children enumeration is currently in progress. Files will be added to @self from time to time while loading is going on. The order in which are added is undefined and may change in between runs. + - %TRUE if @self is loading + %TRUE if @self is loading - a `GtkDirectoryList` + a `GtkDirectoryList` - Sets the @attributes to be enumerated and starts the enumeration. + Sets the @attributes to be enumerated and starts the enumeration. If @attributes is %NULL, no attributes will be queried, but a list of `GFileInfo`s will still be created. + - a `GtkDirectoryList` + a `GtkDirectoryList` - the attributes to enumerate + the attributes to enumerate - Sets the @file to be enumerated and starts the enumeration. + Sets the @file to be enumerated and starts the enumeration. If @file is %NULL, the result will be an empty list. + - a `GtkDirectoryList` + a `GtkDirectoryList` - the `GFile` to be enumerated + the `GFile` to be enumerated - Sets the IO priority to use while loading directories. + Sets the IO priority to use while loading directories. Setting the priority while @self is loading will reprioritize the ongoing load as soon as possible. @@ -23211,23 +24262,24 @@ The default IO priority is %G_PRIORITY_DEFAULT, which is higher than the GTK redraw priority. If you are loading a lot of directories in parallel, lowering it to something like %G_PRIORITY_DEFAULT_IDLE may increase responsiveness. + - a `GtkDirectoryList` + a `GtkDirectoryList` - IO priority to use + IO priority to use - Sets whether the directory list will monitor the directory + Sets whether the directory list will monitor the directory for changes. If monitoring is enabled, the ::items-changed signal will @@ -23238,16 +24290,17 @@ When monitoring is turned on after the initial creation of the directory list, the directory is reloaded to avoid missing files that appeared between the initial loading and when monitoring was turned on. + - a `GtkDirectoryList` + a `GtkDirectoryList` - %TRUE to monitor the directory for changes + %TRUE to monitor the directory for changes @@ -23255,45 +24308,46 @@ and when monitoring was turned on. - The attributes to query. + The attributes to query. - Error encountered while loading files. + Error encountered while loading files. - File to query. + File to query. - Priority used when loading. + Priority used when loading. - %TRUE if files are being loaded. + %TRUE if files are being loaded. - %TRUE if the directory is monitored for changed. + %TRUE if the directory is monitored for changed. + - `GtkDragIcon` is a `GtkRoot` implementation for drag icons. + `GtkDragIcon` is a `GtkRoot` implementation for drag icons. A drag icon moves with the pointer during a Drag-and-Drop operation and is destroyed when the drag ends. @@ -23304,13 +24358,14 @@ then use it like any other widget and use [method@Gtk.DragIcon.set_child] to set whatever widget should be used for the drag icon. Keep in mind that drag icons do not allow user input. + - Creates a widget that can be used as a drag icon for the given + Creates a widget that can be used as a drag icon for the given @value. Supported types include strings, `GdkRGBA` and `GtkTextBuffer`. @@ -23320,89 +24375,94 @@ it will return %NULL. This method is used to set the default drag icon on drag-and-drop operations started by `GtkDragSource`, so you don't need to set a drag icon using this function there. + - A new `GtkWidget` + A new `GtkWidget` for displaying @value as a drag icon. - a `GValue` + a `GValue` - Gets the `GtkDragIcon` in use with @drag. + Gets the `GtkDragIcon` in use with @drag. If no drag icon exists yet, a new one will be created and shown. + - the `GtkDragIcon` + the `GtkDragIcon` - a `GdkDrag` + a `GdkDrag` - Creates a `GtkDragIcon` that shows @paintable, and associates + Creates a `GtkDragIcon` that shows @paintable, and associates it with the drag operation. The hotspot position on the paintable is aligned with the hotspot of the cursor. + - a `GdkDrag` + a `GdkDrag` - a `GdkPaintable` to display + a `GdkPaintable` to display - X coordinate of the hotspot + X coordinate of the hotspot - Y coordinate of the hotspot + Y coordinate of the hotspot - Gets the widget currently used as drag icon. + Gets the widget currently used as drag icon. + - The drag icon + The drag icon - a `GtkDragIcon` + a `GtkDragIcon` - Sets the widget to display as the drag icon. + Sets the widget to display as the drag icon. + - a `GtkDragIcon` + a `GtkDragIcon` - a `GtkWidget` + a `GtkWidget` @@ -23410,17 +24470,18 @@ hotspot of the cursor. - The widget to display as drag icon. + The widget to display as drag icon. + - `GtkDragSource` is an event controller to initiate Drag-And-Drop operations. + `GtkDragSource` is an event controller to initiate Drag-And-Drop operations. `GtkDragSource` can be set up with the necessary ingredients for a DND operation ahead of time. This includes @@ -23496,70 +24557,76 @@ except for one case: when the supported actions include %GDK_ACTION_MOVE, you need to listen for the [signal@Gtk.DragSource::drag-end] signal and delete the data after it has been transferred. + - Creates a new `GtkDragSource` object. + Creates a new `GtkDragSource` object. + - the new `GtkDragSource` + the new `GtkDragSource` - Cancels a currently ongoing drag operation. + Cancels a currently ongoing drag operation. + - a `GtkDragSource` + a `GtkDragSource` - Gets the actions that are currently set on the `GtkDragSource`. + Gets the actions that are currently set on the `GtkDragSource`. + - the actions set on @source + the actions set on @source - a `GtkDragSource` + a `GtkDragSource` - Gets the current content provider of a `GtkDragSource`. + Gets the current content provider of a `GtkDragSource`. + - the `GdkContentProvider` of @source + the `GdkContentProvider` of @source - a `GtkDragSource` + a `GtkDragSource` - Returns the underlying `GdkDrag` object for an ongoing drag. + Returns the underlying `GdkDrag` object for an ongoing drag. + - the `GdkDrag` of the current + the `GdkDrag` of the current drag operation - a `GtkDragSource` + a `GtkDragSource` - Sets the actions on the `GtkDragSource`. + Sets the actions on the `GtkDragSource`. During a DND operation, the actions are offered to potential drop targets. If @actions include %GDK_ACTION_MOVE, you need @@ -23568,23 +24635,24 @@ handle @delete_data being %TRUE. This function can be called before a drag is started, or in a handler for the [signal@Gtk.DragSource::prepare] signal. + - a `GtkDragSource` + a `GtkDragSource` - the actions to offer + the actions to offer - Sets a content provider on a `GtkDragSource`. + Sets a content provider on a `GtkDragSource`. When the data is requested in the cause of a DND operation, it will be obtained from the content provider. @@ -23594,22 +24662,23 @@ or in a handler for the [signal@Gtk.DragSource::prepare] signal. You may consider setting the content provider back to %NULL in a [signal@Gtk.DragSource::drag-end] signal handler. + - a `GtkDragSource` + a `GtkDragSource` - a `GdkContentProvider` + a `GdkContentProvider` - Sets a paintable to use as icon during DND operations. + Sets a paintable to use as icon during DND operations. The hotspot coordinates determine the point on the icon that gets aligned with the hotspot of the cursor. @@ -23619,24 +24688,25 @@ If @paintable is %NULL, a default icon is used. This function can be called before a drag is started, or in a [signal@Gtk.DragSource::prepare] or [signal@Gtk.DragSource::drag-begin] signal handler. + - a `GtkDragSource` + a `GtkDragSource` - the `GdkPaintable` to use as icon + the `GdkPaintable` to use as icon - the hotspot X coordinate on the icon + the hotspot X coordinate on the icon - the hotspot Y coordinate on the icon + the hotspot Y coordinate on the icon @@ -23644,7 +24714,7 @@ a [signal@Gtk.DragSource::prepare] or - The actions that are supported by drag operations from the source. + The actions that are supported by drag operations from the source. Note that you must handle the [signal@Gtk.DragSource::drag-end] signal if the actions include %GDK_ACTION_MOVE. @@ -23653,11 +24723,11 @@ if the actions include %GDK_ACTION_MOVE. - The data that is offered by drag operations from this source. + The data that is offered by drag operations from this source. - Emitted on the drag source when a drag is started. + Emitted on the drag source when a drag is started. It can be used to e.g. set a custom drag icon with [method@Gtk.DragSource.set_icon]. @@ -23666,34 +24736,34 @@ It can be used to e.g. set a custom drag icon with - the `GdkDrag` object + the `GdkDrag` object - Emitted on the drag source when a drag has failed. + Emitted on the drag source when a drag has failed. The signal handler may handle a failed drag operation based on the type of error. It should return %TRUE if the failure has been handled and the default "drag operation failed" animation should not be shown. - %TRUE if the failed drag operation has been already handled + %TRUE if the failed drag operation has been already handled - the `GdkDrag` object + the `GdkDrag` object - information on why the drag failed + information on why the drag failed - Emitted on the drag source when a drag is finished. + Emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in [signal@Gtk.DragSource::prepare] or @@ -23703,42 +24773,44 @@ things done in [signal@Gtk.DragSource::prepare] or - the `GdkDrag` object + the `GdkDrag` object - %TRUE if the drag was performing %GDK_ACTION_MOVE, + %TRUE if the drag was performing %GDK_ACTION_MOVE, and the data should be deleted - Emitted when a drag is about to be initiated. + Emitted when a drag is about to be initiated. It returns the `GdkContentProvider` to use for the drag that is about to start. The default handler for this signal returns the value of the [property@Gtk.DragSource:content] property, so if you set up that property ahead of time, you don't need to connect to this signal. - a `GdkContentProvider` + a `GdkContentProvider` - the X coordinate of the drag starting point + the X coordinate of the drag starting point - the Y coordinate fo the drag starting point + the Y coordinate fo the drag starting point - + + + - `GtkDrawingArea` is a widget that allows drawing with cairo. + `GtkDrawingArea` is a widget that allows drawing with cairo. ![An example GtkDrawingArea](drawingarea.png) @@ -23818,17 +24890,20 @@ draw some user-visible indication that the drawing area is focused. If you need more complex control over your widget, you should consider creating your own `GtkWidget` subclass. + - Creates a new drawing area. + Creates a new drawing area. + - a new `GtkDrawingArea` + a new `GtkDrawingArea` + @@ -23846,35 +24921,37 @@ creating your own `GtkWidget` subclass. - Retrieves the content height of the `GtkDrawingArea`. + Retrieves the content height of the `GtkDrawingArea`. + - The height requested for content of the drawing area + The height requested for content of the drawing area - a `GtkDrawingArea` + a `GtkDrawingArea` - Retrieves the content width of the `GtkDrawingArea`. + Retrieves the content width of the `GtkDrawingArea`. + - The width requested for content of the drawing area + The width requested for content of the drawing area - a `GtkDrawingArea` + a `GtkDrawingArea` - Sets the desired height of the contents of the drawing area. + Sets the desired height of the contents of the drawing area. Note that because widgets may be allocated larger sizes than they requested, it is possible that the actual height passed to your draw @@ -23882,23 +24959,24 @@ function is larger than the height set here. You can use [method@Gtk.Widget.set_valign] to avoid that. If the height is set to 0 (the default), the drawing area may disappear. + - a `GtkDrawingArea` + a `GtkDrawingArea` - the height of contents + the height of contents - Sets the desired width of the contents of the drawing area. + Sets the desired width of the contents of the drawing area. Note that because widgets may be allocated larger sizes than they requested, it is possible that the actual width passed to your draw @@ -23906,22 +24984,23 @@ function is larger than the width set here. You can use [method@Gtk.Widget.set_halign] to avoid that. If the width is set to 0 (the default), the drawing area may disappear. + - a `GtkDrawingArea` + a `GtkDrawingArea` - the width of contents + the width of contents - Setting a draw function is the main thing you want to do when using + Setting a draw function is the main thing you want to do when using a drawing area. The draw function is called whenever GTK needs to draw the contents @@ -23935,25 +25014,26 @@ your contents in the draw function. If what you are drawing does change, call [method@Gtk.Widget.queue_draw] on the drawing area. This will cause a redraw and will call @draw_func again. + - a `GtkDrawingArea` + a `GtkDrawingArea` - callback that lets you draw + callback that lets you draw the drawing area's contents - user data passed to @draw_func + user data passed to @draw_func - destroy notifier for @user_data + destroy notifier for @user_data @@ -23961,20 +25041,20 @@ on the drawing area. This will cause a redraw and will call @draw_func again. - The content height. + The content height. - The content width. + The content width. - Emitted once when the widget is realized, and then each time the widget + Emitted once when the widget is realized, and then each time the widget is changed while realized. This is useful in order to keep state up to date with the widget size, @@ -23984,22 +25064,24 @@ like for instance a backing surface. - the width of the viewport + the width of the viewport - the height of the viewport + the height of the viewport + + @@ -24023,40 +25105,41 @@ like for instance a backing surface. - Whenever @drawing_area needs to redraw, this function will be called. + Whenever @drawing_area needs to redraw, this function will be called. This function should exclusively redraw the contents of the drawing area and must not call any widget functions that cause changes. + - the `GtkDrawingArea` to redraw + the `GtkDrawingArea` to redraw - the context to draw to + the context to draw to - the actual width of the contents. This value will be at least + the actual width of the contents. This value will be at least as wide as GtkDrawingArea:width. - the actual height of the contents. This value will be at least + the actual height of the contents. This value will be at least as wide as GtkDrawingArea:height. - user data + user data - `GtkDropControllerMotion` is an event controller tracking + `GtkDropControllerMotion` is an event controller tracking the pointer during Drag-and-Drop operations. It is modeled after [class@Gtk.EventControllerMotion] so if you @@ -24064,64 +25147,69 @@ have used that, this should feel really familiar. This controller is not able to accept drops, use [class@Gtk.DropTarget] for that purpose. + - Creates a new event controller that will handle pointer motion + Creates a new event controller that will handle pointer motion events during drag and drop. + - a new `GtkDropControllerMotion` + a new `GtkDropControllerMotion` - Returns if a Drag-and-Drop operation is within the widget + Returns if a Drag-and-Drop operation is within the widget @self or one of its children. + - %TRUE if a dragging pointer is within @self or one of its children. + %TRUE if a dragging pointer is within @self or one of its children. - a `GtkDropControllerMotion` + a `GtkDropControllerMotion` - Returns the `GdkDrop` of a current Drag-and-Drop operation + Returns the `GdkDrop` of a current Drag-and-Drop operation over the widget of @self. + - The `GdkDrop` currently + The `GdkDrop` currently happening within @self - a `GtkDropControllerMotion` + a `GtkDropControllerMotion` - Returns if a Drag-and-Drop operation is within the widget + Returns if a Drag-and-Drop operation is within the widget @self, not one of its children. + - %TRUE if a dragging pointer is within @self but + %TRUE if a dragging pointer is within @self but not one of its children - a `GtkDropControllerMotion` + a `GtkDropControllerMotion` - Whether the pointer of a Drag-and-Drop operation is in + Whether the pointer of a Drag-and-Drop operation is in the controller's widget or a descendant. See also [property@Gtk.DropControllerMotion:is-pointer]. @@ -24133,7 +25221,7 @@ before [signal@Gtk.DropControllerMotion::enter], but after - The ongoing drop operation over the controller's widget or + The ongoing drop operation over the controller's widget or its descendant. If no drop operation is going on, this property returns %NULL. @@ -24148,7 +25236,7 @@ before [signal@Gtk.DropControllerMotion::enter], but after - Whether the pointer is in the controllers widget itself, + Whether the pointer is in the controllers widget itself, as opposed to in a descendent widget. See also [property@Gtk.DropControllerMotion:contains-pointer]. @@ -24159,47 +25247,49 @@ before [signal@Gtk.DropControllerMotion::enter], but after - Signals that the pointer has entered the widget. + Signals that the pointer has entered the widget. - coordinates of pointer location + coordinates of pointer location - coordinates of pointer location + coordinates of pointer location - Signals that the pointer has left the widget. + Signals that the pointer has left the widget. - Emitted when the pointer moves inside the widget. + Emitted when the pointer moves inside the widget. - the x coordinate + the x coordinate - the y coordinate + the y coordinate - + + + - `GtkDropDown` is a widget that allows the user to choose an item + `GtkDropDown` is a widget that allows the user to choose an item from a list of options. ![An example GtkDropDown](drop-down.png) @@ -24226,39 +25316,42 @@ with the button and popover nodes as children. # Accessibility `GtkDropDown` uses the %GTK_ACCESSIBLE_ROLE_COMBO_BOX role. + - Creates a new `GtkDropDown`. + Creates a new `GtkDropDown`. You may want to call [method@Gtk.DropDown.set_factory] to set up a way to map its items to widgets. + - a new `GtkDropDown` + a new `GtkDropDown` - the model to use + the model to use - the expression to use + the expression to use - Creates a new `GtkDropDown` that is populated with + Creates a new `GtkDropDown` that is populated with the strings. + - a new `GtkDropDown` + a new `GtkDropDown` - The strings to put in the dropdown + The strings to put in the dropdown @@ -24267,214 +25360,227 @@ the strings. - Returns whether search is enabled. + Returns whether search is enabled. + - %TRUE if the popup includes a search entry + %TRUE if the popup includes a search entry - a `GtkDropDown` + a `GtkDropDown` - Gets the expression set that is used to obtain strings from items. + Gets the expression set that is used to obtain strings from items. See [method@Gtk.DropDown.set_expression]. + - a `GtkExpression` + a `GtkExpression` - a `GtkDropDown` + a `GtkDropDown` - Gets the factory that's currently used to populate list items. + Gets the factory that's currently used to populate list items. The factory returned by this function is always used for the item in the button. It is also used for items in the popup if [property@Gtk.DropDown:list-factory] is not set. + - The factory in use + The factory in use - a `GtkDropDown` + a `GtkDropDown` - Gets the factory that's currently used to populate list items in the popup. + Gets the factory that's currently used to populate list items in the popup. + - The factory in use + The factory in use - a `GtkDropDown` + a `GtkDropDown` - Gets the model that provides the displayed items. + Gets the model that provides the displayed items. + - The model in use + The model in use - a `GtkDropDown` + a `GtkDropDown` - Gets the position of the selected item. + Gets the position of the selected item. + - the position of the selected item, or %GTK_INVALID_LIST_POSITION + the position of the selected item, or %GTK_INVALID_LIST_POSITION if not item is selected - a `GtkDropDown` + a `GtkDropDown` - Gets the selected item. If no item is selected, %NULL is returned. + Gets the selected item. If no item is selected, %NULL is returned. + - The selected item + The selected item - a `GtkDropDown` + a `GtkDropDown` - Sets whether a search entry will be shown in the popup that + Sets whether a search entry will be shown in the popup that allows to search for items in the list. Note that [property@Gtk.DropDown:expression] must be set for search to work. + - a `GtkDropDown` + a `GtkDropDown` - whether to enable search + whether to enable search - Sets the expression that gets evaluated to obtain strings from items. + Sets the expression that gets evaluated to obtain strings from items. This is used for search in the popup. The expression must have a value type of %G_TYPE_STRING. + - a `GtkDropDown` + a `GtkDropDown` - a `GtkExpression` + a `GtkExpression` - Sets the `GtkListItemFactory` to use for populating list items. + Sets the `GtkListItemFactory` to use for populating list items. + - a `GtkDropDown` + a `GtkDropDown` - the factory to use + the factory to use - Sets the `GtkListItemFactory` to use for populating list items in the popup. + Sets the `GtkListItemFactory` to use for populating list items in the popup. + - a `GtkDropDown` + a `GtkDropDown` - the factory to use + the factory to use - Sets the `GListModel` to use. + Sets the `GListModel` to use. + - a `GtkDropDown` + a `GtkDropDown` - the model to use + the model to use - Selects the item at the given position. + Selects the item at the given position. + - a `GtkDropDown` + a `GtkDropDown` - the position of the item to select, or %GTK_INVALID_LIST_POSITION + the position of the item to select, or %GTK_INVALID_LIST_POSITION @@ -24482,7 +25588,7 @@ a value type of %G_TYPE_STRING. - Whether to show a search entry in the popup. + Whether to show a search entry in the popup. Note that search requires [property@Gtk.DropDown:expression] to be set. @@ -24491,7 +25597,7 @@ to be set. - An expression to evaluate to obtain strings to match against the search + An expression to evaluate to obtain strings to match against the search term. See [property@Gtk.DropDown:enable-search] for how to enable search. @@ -24502,13 +25608,13 @@ used to bind strings to labels produced by a default factory. - Factory for populating list items. + Factory for populating list items. - The factory for populating list items in the popup. + The factory for populating list items in the popup. If this is not set, [property@Gtk.DropDown:factory] is used. @@ -24516,13 +25622,13 @@ If this is not set, [property@Gtk.DropDown:factory] is used. - Model for the displayed items. + Model for the displayed items. - The position of the selected item. + The position of the selected item. If no item is selected, the property has the value %GTK_INVALID_LIST_POSITION. @@ -24530,17 +25636,18 @@ If no item is selected, the property has the value - The selected item. + The selected item. + - `GtkDropTarget` is an event controller to receive Drag-and-Drop operations. + `GtkDropTarget` is an event controller to receive Drag-and-Drop operations. The most basic way to use a `GtkDropTarget` to receive drops on a widget is to create it via [ctor@Gtk.DropTarget.new], passing in the @@ -24610,96 +25717,103 @@ has not been rejected, that widget will receive the If you are not interested in receiving the drop, but just want to update UI state during a Drag-and-Drop operation (e.g. switching tabs), you can use [class@Gtk.DropControllerMotion]. + - Creates a new `GtkDropTarget` object. + Creates a new `GtkDropTarget` object. If the drop target should support more than 1 type, pass %G_TYPE_INVALID for @type and then call [method@Gtk.DropTarget.set_gtypes]. + - the new `GtkDropTarget` + the new `GtkDropTarget` - The supported type or %G_TYPE_INVALID + The supported type or %G_TYPE_INVALID - the supported actions + the supported actions - Gets the actions that this drop target supports. + Gets the actions that this drop target supports. + - the actions that this drop target supports + the actions that this drop target supports - a `GtkDropTarget` + a `GtkDropTarget` - Gets the currently handled drop operation. + Gets the currently handled drop operation. If no drop operation is going on, %NULL is returned. + - The current drop + The current drop - a `GtkDropTarget` + a `GtkDropTarget` - Gets the currently handled drop operation. + Gets the currently handled drop operation. If no drop operation is going on, %NULL is returned. Use [method@Gtk.DropTarget.get_current_drop] instead + - The current drop + The current drop - a `GtkDropTarget` + a `GtkDropTarget` - Gets the data formats that this drop target accepts. + Gets the data formats that this drop target accepts. If the result is %NULL, all formats are expected to be supported. + - the supported data formats + the supported data formats - a `GtkDropTarget` + a `GtkDropTarget` - Gets the list of supported `GType`s that can be dropped on the target. + Gets the list of supported `GType`s that can be dropped on the target. If no types have been set, `NULL` will be returned. + - + the `G_TYPE_INVALID`-terminated array of types included in formats @@ -24708,11 +25822,11 @@ If no types have been set, `NULL` will be returned. - a `GtkDropTarget` + a `GtkDropTarget` - the number of `GType`s contained in the + the number of `GType`s contained in the return value @@ -24720,34 +25834,36 @@ If no types have been set, `NULL` will be returned. - Gets whether data should be preloaded on hover. + Gets whether data should be preloaded on hover. + - %TRUE if drop data should be preloaded + %TRUE if drop data should be preloaded - a `GtkDropTarget` + a `GtkDropTarget` - Gets the current drop data, as a `GValue`. + Gets the current drop data, as a `GValue`. + - The current drop data + The current drop data - a `GtkDropTarget` + a `GtkDropTarget` - Rejects the ongoing drop operation. + Rejects the ongoing drop operation. If no drop operation is ongoing, i.e when [property@Gtk.DropTarget:current-drop] is %NULL, this function does nothing. @@ -24755,69 +25871,73 @@ is %NULL, this function does nothing. This function should be used when delaying the decision on whether to accept a drag or not until after reading the data. + - a `GtkDropTarget` + a `GtkDropTarget` - Sets the actions that this drop target supports. + Sets the actions that this drop target supports. + - a `GtkDropTarget` + a `GtkDropTarget` - the supported actions + the supported actions - Sets the supported `GTypes` for this drop target. + Sets the supported `GTypes` for this drop target. + - a `GtkDropTarget` + a `GtkDropTarget` - all supported `GType`s + all supported `GType`s that can be dropped on the target - number of @types + number of @types - Sets whether data should be preloaded on hover. + Sets whether data should be preloaded on hover. + - a `GtkDropTarget` + a `GtkDropTarget` - %TRUE to preload drop data + %TRUE to preload drop data @@ -24825,29 +25945,29 @@ the data. - The `GdkDragActions` that this drop target supports. + The `GdkDragActions` that this drop target supports. - The `GdkDrop` that is currently being performed. + The `GdkDrop` that is currently being performed. - The `GdkDrop` that is currently being performed. + The `GdkDrop` that is currently being performed. Use [property@Gtk.DropTarget:current-drop] instead - The `GdkContentFormats` that determine the supported data formats. + The `GdkContentFormats` that determine the supported data formats. - Whether the drop data should be preloaded when the pointer is only + Whether the drop data should be preloaded when the pointer is only hovering over the widget but has not been released. Setting this property allows finer grained reaction to an ongoing @@ -24869,7 +25989,7 @@ so enabling it there is free. - The value for this drop operation. + The value for this drop operation. This is %NULL if the data has not been loaded yet or no drop operation is going on. @@ -24881,7 +26001,7 @@ of available data. - Emitted on the drop site when a drop operation is about to begin. + Emitted on the drop site when a drop operation is about to begin. If the drop is not accepted, %FALSE will be returned and the drop target will ignore the drop. If %TRUE is returned, the drop is accepted for now @@ -24898,18 +26018,18 @@ on the data, this function should return %TRUE, the should be inspected via the ::notify:value signal, calling [method@Gtk.DropTarget.reject] if required. - %TRUE if @drop is accepted + %TRUE if @drop is accepted - the `GdkDrop` + the `GdkDrop` - Emitted on the drop site when the user drops the data onto the widget. + Emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the pointer position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE @@ -24919,46 +26039,46 @@ Otherwise, the handler returns %TRUE. In this case, this handler will accept the drop. The handler is responsible for using the given @value and performing the drop operation. - whether the drop was accepted at the given pointer position + whether the drop was accepted at the given pointer position - the `GValue` being dropped + the `GValue` being dropped - the x coordinate of the current pointer position + the x coordinate of the current pointer position - the y coordinate of the current pointer position + the y coordinate of the current pointer position - Emitted on the drop site when the pointer enters the widget. + Emitted on the drop site when the pointer enters the widget. It can be used to set up custom highlighting. - Preferred action for this drag operation or 0 if + Preferred action for this drag operation or 0 if dropping is not supported at the current @x,@y location. - the x coordinate of the current pointer position + the x coordinate of the current pointer position - the y coordinate of the current pointer position + the y coordinate of the current pointer position - Emitted on the drop site when the pointer leaves the widget. + Emitted on the drop site when the pointer leaves the widget. Its main purpose it to undo things done in [signal@Gtk.DropTarget::enter]. @@ -24967,26 +26087,26 @@ Its main purpose it to undo things done in - Emitted while the pointer is moving over the drop target. + Emitted while the pointer is moving over the drop target. - Preferred action for this drag operation or 0 if + Preferred action for this drag operation or 0 if dropping is not supported at the current @x,@y location. - the x coordinate of the current pointer position + the x coordinate of the current pointer position - the y coordinate of the current pointer position + the y coordinate of the current pointer position - `GtkDropTargetAsync` is an event controller to receive Drag-and-Drop + `GtkDropTargetAsync` is an event controller to receive Drag-and-Drop operations, asynchronously. It is the more complete but also more complex method of handling drop @@ -25020,103 +26140,110 @@ should initiate the data transfer and finish the operation by calling Between the ::drag-enter and ::drag-leave signals the widget is a current drop target, and will receive the %GTK_STATE_FLAG_DROP_ACTIVE state, which can be used by themes to style the widget as a drop target. + - Creates a new `GtkDropTargetAsync` object. + Creates a new `GtkDropTargetAsync` object. + - the new `GtkDropTargetAsync` + the new `GtkDropTargetAsync` - the supported data formats + the supported data formats - the supported actions + the supported actions - Gets the actions that this drop target supports. + Gets the actions that this drop target supports. + - the actions that this drop target supports + the actions that this drop target supports - a `GtkDropTargetAsync` + a `GtkDropTargetAsync` - Gets the data formats that this drop target accepts. + Gets the data formats that this drop target accepts. If the result is %NULL, all formats are expected to be supported. + - the supported data formats + the supported data formats - a `GtkDropTargetAsync` + a `GtkDropTargetAsync` - Sets the @drop as not accepted on this drag site. + Sets the @drop as not accepted on this drag site. This function should be used when delaying the decision on whether to accept a drag or not until after reading the data. + - a `GtkDropTargetAsync` + a `GtkDropTargetAsync` - the `GdkDrop` of an ongoing drag operation + the `GdkDrop` of an ongoing drag operation - Sets the actions that this drop target supports. + Sets the actions that this drop target supports. + - a `GtkDropTargetAsync` + a `GtkDropTargetAsync` - the supported actions + the supported actions - Sets the data formats that this drop target will accept. + Sets the data formats that this drop target will accept. + - a `GtkDropTargetAsync` + a `GtkDropTargetAsync` - the supported data formats or %NULL for any format + the supported data formats or %NULL for any format @@ -25124,17 +26251,17 @@ the data. - The `GdkDragActions` that this drop target supports. + The `GdkDragActions` that this drop target supports. - The `GdkContentFormats` that determines the supported data formats. + The `GdkContentFormats` that determines the supported data formats. - Emitted on the drop site when a drop operation is about to begin. + Emitted on the drop site when a drop operation is about to begin. If the drop is not accepted, %FALSE will be returned and the drop target will ignore the drop. If %TRUE is returned, the drop is accepted for now @@ -25150,41 +26277,41 @@ further processing, such as inspecting the data, this function should return %TRUE and proceed as is @drop was accepted and if it decides to reject the drop later, it should call [method@Gtk.DropTargetAsync.reject_drop]. - %TRUE if @drop is accepted + %TRUE if @drop is accepted - the `GdkDrop` + the `GdkDrop` - Emitted on the drop site when the pointer enters the widget. + Emitted on the drop site when the pointer enters the widget. It can be used to set up custom highlighting. - Preferred action for this drag operation. + Preferred action for this drag operation. - the `GdkDrop` + the `GdkDrop` - the x coordinate of the current pointer position + the x coordinate of the current pointer position - the y coordinate of the current pointer position + the y coordinate of the current pointer position - Emitted on the drop site when the pointer leaves the widget. + Emitted on the drop site when the pointer leaves the widget. Its main purpose it to undo things done in `GtkDropTargetAsync`::drag-enter. @@ -25193,34 +26320,34 @@ Its main purpose it to undo things done in - the `GdkDrop` + the `GdkDrop` - Emitted while the pointer is moving over the drop target. + Emitted while the pointer is moving over the drop target. - Preferred action for this drag operation. + Preferred action for this drag operation. - the `GdkDrop` + the `GdkDrop` - the x coordinate of the current pointer position + the x coordinate of the current pointer position - the y coordinate of the current pointer position + the y coordinate of the current pointer position - Emitted on the drop site when the user drops the data onto the widget. + Emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the pointer position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no @@ -25235,221 +26362,257 @@ To receive the data, use one of the read functions provided by [class@Gdk.Drop] such as [method@Gdk.Drop.read_async] or [method@Gdk.Drop.read_value_async]. - whether the drop is accepted at the given pointer position + whether the drop is accepted at the given pointer position - the `GdkDrop` + the `GdkDrop` - the x coordinate of the current pointer position + the x coordinate of the current pointer position - the y coordinate of the current pointer position + the y coordinate of the current pointer position - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - `GtkEditable` is an interface for text editing widgets. + `GtkEditable` is an interface for text editing widgets. Typical examples of editable widgets are [class@Gtk.Entry] and [class@Gtk.SpinButton]. It contains functions for generically manipulating @@ -25577,67 +26740,70 @@ the delegate to the "wrapper" editable, as they would cause an infinite recursion. If you wish to connect to the [signal@Gtk.Editable::insert-text] and [signal@Gtk.Editable::delete-text] signals, you will need to connect to them on the delegate obtained via [method@Gtk.Editable.get_delegate]. + - Gets a property of the `GtkEditable` delegate for @object. + Gets a property of the `GtkEditable` delegate for @object. This is helper function that should be called in the `get_property` function of your `GtkEditable` implementation, before handling your own properties. + - %TRUE if the property was found + %TRUE if the property was found - a `GObject` + a `GObject` - a property ID + a property ID - value to set + value to set - the `GParamSpec` for the property + the `GParamSpec` for the property - Sets a property on the `GtkEditable` delegate for @object. + Sets a property on the `GtkEditable` delegate for @object. This is a helper function that should be called in the `set_property` function of your `GtkEditable` implementation, before handling your own properties. + - %TRUE if the property was found + %TRUE if the property was found - a `GObject` + a `GObject` - a property ID + a property ID - value to set + value to set - the `GParamSpec` for the property + the `GParamSpec` for the property - Installs the `GtkEditable` properties for @class. + Installs the `GtkEditable` properties for @class. This is a helper function that should be called in class_init, after installing your own properties. @@ -25648,22 +26814,24 @@ and [func@Gtk.Editable.delegate_get_property] (if you are using a delegate), or remember the @first_prop offset and add it to the values in the [enum@Gtk.EditableProperties] enumeration to get the property IDs for these properties. + - the number of properties that were installed + the number of properties that were installed - a `GObjectClass` + a `GObjectClass` - property ID to use for the first property + property ID to use for the first property + @@ -25674,7 +26842,7 @@ property IDs for these properties. - Deletes a sequence of characters. + Deletes a sequence of characters. The characters that are deleted are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is @@ -25682,26 +26850,27 @@ negative, then the characters deleted are those from @start_pos to the end of the text. Note that the positions are specified in characters, not bytes. + - a `GtkEditable` + a `GtkEditable` - start position + start position - end position + end position - Deletes a sequence of characters. + Deletes a sequence of characters. The characters that are deleted are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is @@ -25709,143 +26878,149 @@ negative, then the characters deleted are those from @start_pos to the end of the text. Note that the positions are specified in characters, not bytes. + - a `GtkEditable` + a `GtkEditable` - start position + start position - end position + end position - Inserts @length bytes of @text into the contents of the + Inserts @length bytes of @text into the contents of the widget, at position @position. Note that the position is in characters, not in bytes. The function updates @position to point after the newly inserted text. + - a `GtkEditable` + a `GtkEditable` - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - location of the position text will be inserted at + location of the position text will be inserted at - Gets the `GtkEditable` that @editable is delegating its + Gets the `GtkEditable` that @editable is delegating its implementation to. Typically, the delegate is a [class@Gtk.Text] widget. + - the delegate `GtkEditable` + the delegate `GtkEditable` - a `GtkEditable` + a `GtkEditable` - Retrieves the selection bound of the editable. + Retrieves the selection bound of the editable. @start_pos will be filled with the start of the selection and @end_pos with end. If no text was selected both will be identical and %FALSE will be returned. Note that positions are specified in characters, not bytes. + - %TRUE if there is a non-empty selection, %FALSE otherwise + %TRUE if there is a non-empty selection, %FALSE otherwise - a `GtkEditable` + a `GtkEditable` - location to store the starting position + location to store the starting position - location to store the end position + location to store the end position - Retrieves the contents of @editable. + Retrieves the contents of @editable. The returned string is owned by GTK and must not be modified or freed. + - a pointer to the contents of the editable + a pointer to the contents of the editable - a `GtkEditable` + a `GtkEditable` - Inserts @length bytes of @text into the contents of the + Inserts @length bytes of @text into the contents of the widget, at position @position. Note that the position is in characters, not in bytes. The function updates @position to point after the newly inserted text. + - a `GtkEditable` + a `GtkEditable` - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - location of the position text will be inserted at + location of the position text will be inserted at - Selects a region of text. + Selects a region of text. The characters that are selected are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is @@ -25853,40 +27028,42 @@ negative, then the characters selected are those characters from @start_pos to the end of the text. Note that positions are specified in characters, not bytes. + - a `GtkEditable` + a `GtkEditable` - start of region + start of region - end of region + end of region - Deletes the currently selected text of the editable. + Deletes the currently selected text of the editable. This call doesn’t do anything if there is no selected text. + - a `GtkEditable` + a `GtkEditable` - Deletes a sequence of characters. + Deletes a sequence of characters. The characters that are deleted are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is @@ -25894,55 +27071,58 @@ negative, then the characters deleted are those from @start_pos to the end of the text. Note that the positions are specified in characters, not bytes. + - a `GtkEditable` + a `GtkEditable` - start position + start position - end position + end position - Undoes the setup done by [method@Gtk.Editable.init_delegate]. + Undoes the setup done by [method@Gtk.Editable.init_delegate]. This is a helper function that should be called from dispose, before removing the delegate object. + - a `GtkEditable` + a `GtkEditable` - Gets the alignment of the editable. + Gets the alignment of the editable. + - the alignment + the alignment - a `GtkEditable` + a `GtkEditable` - Retrieves a sequence of characters. + Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is negative, @@ -25950,209 +27130,220 @@ then the characters retrieved are those characters from @start_pos to the end of the text. Note that positions are specified in characters, not bytes. + - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string is allocated by the `GtkEditable` implementation and should be freed by the caller. - a `GtkEditable` + a `GtkEditable` - start of text + start of text - end of text + end of text - Gets the `GtkEditable` that @editable is delegating its + Gets the `GtkEditable` that @editable is delegating its implementation to. Typically, the delegate is a [class@Gtk.Text] widget. + - the delegate `GtkEditable` + the delegate `GtkEditable` - a `GtkEditable` + a `GtkEditable` - Retrieves whether @editable is editable. + Retrieves whether @editable is editable. + - %TRUE if @editable is editable. + %TRUE if @editable is editable. - a `GtkEditable` + a `GtkEditable` - Gets if undo/redo actions are enabled for @editable + Gets if undo/redo actions are enabled for @editable + - %TRUE if undo is enabled + %TRUE if undo is enabled - a `GtkEditable` + a `GtkEditable` - Retrieves the desired maximum width of @editable, in characters. + Retrieves the desired maximum width of @editable, in characters. + - the maximum width of the entry, in characters + the maximum width of the entry, in characters - a `GtkEditable` + a `GtkEditable` - Retrieves the current position of the cursor relative + Retrieves the current position of the cursor relative to the start of the content of the editable. Note that this position is in characters, not in bytes. + - the cursor position + the cursor position - a `GtkEditable` + a `GtkEditable` - Retrieves the selection bound of the editable. + Retrieves the selection bound of the editable. @start_pos will be filled with the start of the selection and @end_pos with end. If no text was selected both will be identical and %FALSE will be returned. Note that positions are specified in characters, not bytes. + - %TRUE if there is a non-empty selection, %FALSE otherwise + %TRUE if there is a non-empty selection, %FALSE otherwise - a `GtkEditable` + a `GtkEditable` - location to store the starting position + location to store the starting position - location to store the end position + location to store the end position - Retrieves the contents of @editable. + Retrieves the contents of @editable. The returned string is owned by GTK and must not be modified or freed. + - a pointer to the contents of the editable + a pointer to the contents of the editable - a `GtkEditable` + a `GtkEditable` - Gets the number of characters of space reserved + Gets the number of characters of space reserved for the contents of the editable. + - number of chars to request space for, or negative if unset + number of chars to request space for, or negative if unset - a `GtkEditable` + a `GtkEditable` - Sets up a delegate for `GtkEditable`. + Sets up a delegate for `GtkEditable`. This is assuming that the get_delegate vfunc in the `GtkEditable` interface has been set up for the @editable's type. This is a helper function that should be called in instance init, after creating the delegate object. + - a `GtkEditable` + a `GtkEditable` - Inserts @length bytes of @text into the contents of the + Inserts @length bytes of @text into the contents of the widget, at position @position. Note that the position is in characters, not in bytes. The function updates @position to point after the newly inserted text. + - a `GtkEditable` + a `GtkEditable` - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - location of the position text will be inserted at + location of the position text will be inserted at - Selects a region of text. + Selects a region of text. The characters that are selected are those characters at positions from @start_pos up to, but not including @end_pos. If @end_pos is @@ -26160,40 +27351,42 @@ negative, then the characters selected are those characters from @start_pos to the end of the text. Note that positions are specified in characters, not bytes. + - a `GtkEditable` + a `GtkEditable` - start of region + start of region - end of region + end of region - Sets the alignment for the contents of the editable. + Sets the alignment for the contents of the editable. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the editable. + - a `GtkEditable` + a `GtkEditable` - The horizontal alignment, from 0 (left) to 1 (right). + The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts @@ -26201,17 +27394,18 @@ the displayed text is shorter than the width of the editable. - Determines if the user can edit the text in the editable widget. + Determines if the user can edit the text in the editable widget. + - a `GtkEditable` + a `GtkEditable` - %TRUE if the user is allowed to edit the text + %TRUE if the user is allowed to edit the text in the widget @@ -26219,103 +27413,108 @@ the displayed text is shorter than the width of the editable. - If enabled, changes to @editable will be saved for undo/redo + If enabled, changes to @editable will be saved for undo/redo actions. This results in an additional copy of text changes and are not stored in secure memory. As such, undo is forcefully disabled when [property@Gtk.Text:visibility] is set to %FALSE. + - a `GtkEditable` + a `GtkEditable` - if undo/redo should be enabled + if undo/redo should be enabled - Sets the desired maximum width in characters of @editable. + Sets the desired maximum width in characters of @editable. + - a `GtkEditable` + a `GtkEditable` - the new desired maximum width, in characters + the new desired maximum width, in characters - Sets the cursor position in the editable to the given value. + Sets the cursor position in the editable to the given value. The cursor is displayed before the character with the given (base 0) index in the contents of the editable. The value must be less than or equal to the number of characters in the editable. A value of -1 indicates that the position should be set after the last character of the editable. Note that @position is in characters, not in bytes. + - a `GtkEditable` + a `GtkEditable` - the position of the cursor + the position of the cursor - Sets the text in the editable to the given value. + Sets the text in the editable to the given value. This is replacing the current contents. + - a `GtkEditable` + a `GtkEditable` - the text to set + the text to set - Changes the size request of the editable to be about the + Changes the size request of the editable to be about the right size for @n_chars characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If @n_chars is -1, the size reverts to the default size. + - a `GtkEditable` + a `GtkEditable` - width in chars + width in chars @@ -26323,53 +27522,53 @@ If @n_chars is -1, the size reverts to the default size. - The current position of the insertion cursor in chars. + The current position of the insertion cursor in chars. - Whether the entry contents can be edited. + Whether the entry contents can be edited. - If undo/redo should be enabled for the editable. + If undo/redo should be enabled for the editable. - The desired maximum width of the entry, in characters. + The desired maximum width of the entry, in characters. - The position of the opposite end of the selection from the cursor in chars. + The position of the opposite end of the selection from the cursor in chars. - The contents of the entry. + The contents of the entry. - Number of characters to leave space for in the entry. + Number of characters to leave space for in the entry. - The horizontal alignment, from 0 (left) to 1 (right). + The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. - Emitted at the end of a single user-visible operation on the + Emitted at the end of a single user-visible operation on the contents. E.g., a paste operation that replaces the contents of the @@ -26382,7 +27581,7 @@ to be emitted). - Emitted when text is deleted from the widget by the user. + Emitted when text is deleted from the widget by the user. The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping @@ -26396,17 +27595,17 @@ The @start_pos and @end_pos parameters are interpreted as for - the starting position + the starting position - the end position + the end position - Emitted when text is inserted into the widget by the user. + Emitted when text is inserted into the widget by the user. The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then @@ -26417,16 +27616,16 @@ to modify the inserted text, or prevent it from being inserted entirely. - the new text to insert + the new text to insert - the length of the new text, in bytes, + the length of the new text, in bytes, or -1 if new_text is nul-terminated - the position, in characters, + the position, in characters, at which to insert the new text. this is an in-out parameter. After the signal emission is finished, it should point after the newly inserted text. @@ -26436,29 +27635,31 @@ to modify the inserted text, or prevent it from being inserted entirely. + + - a `GtkEditable` + a `GtkEditable` - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - location of the position text will be inserted at + location of the position text will be inserted at @@ -26466,20 +27667,21 @@ to modify the inserted text, or prevent it from being inserted entirely. + - a `GtkEditable` + a `GtkEditable` - start position + start position - end position + end position @@ -26487,6 +27689,7 @@ to modify the inserted text, or prevent it from being inserted entirely. + @@ -26499,13 +27702,14 @@ to modify the inserted text, or prevent it from being inserted entirely. + - a pointer to the contents of the editable + a pointer to the contents of the editable - a `GtkEditable` + a `GtkEditable` @@ -26513,24 +27717,25 @@ to modify the inserted text, or prevent it from being inserted entirely. + - a `GtkEditable` + a `GtkEditable` - the text to append + the text to append - the length of the text in bytes, or -1 + the length of the text in bytes, or -1 - location of the position text will be inserted at + location of the position text will be inserted at @@ -26538,20 +27743,21 @@ to modify the inserted text, or prevent it from being inserted entirely. + - a `GtkEditable` + a `GtkEditable` - start position + start position - end position + end position @@ -26559,21 +27765,22 @@ to modify the inserted text, or prevent it from being inserted entirely. + - %TRUE if there is a non-empty selection, %FALSE otherwise + %TRUE if there is a non-empty selection, %FALSE otherwise - a `GtkEditable` + a `GtkEditable` - location to store the starting position + location to store the starting position - location to store the end position + location to store the end position @@ -26581,20 +27788,21 @@ to modify the inserted text, or prevent it from being inserted entirely. + - a `GtkEditable` + a `GtkEditable` - start of region + start of region - end of region + end of region @@ -26602,13 +27810,14 @@ to modify the inserted text, or prevent it from being inserted entirely. + - the delegate `GtkEditable` + the delegate `GtkEditable` - a `GtkEditable` + a `GtkEditable` @@ -26616,7 +27825,7 @@ to modify the inserted text, or prevent it from being inserted entirely. - A `GtkEditableLabel` is a label that allows users to + A `GtkEditableLabel` is a label that allows users to edit the text by switching to an “edit mode”. ![An example GtkEditableLabel](editable-label.png) @@ -26644,77 +27853,83 @@ class. For all the subnodes added to the text node in various situations, see [class@Gtk.Text]. + - Creates a new `GtkEditableLabel` widget. + Creates a new `GtkEditableLabel` widget. + - the new `GtkEditableLabel` + the new `GtkEditableLabel` - the text for the label + the text for the label - Returns whether the label is currently in “editing mode”. + Returns whether the label is currently in “editing mode”. + - %TRUE if @self is currently in editing mode + %TRUE if @self is currently in editing mode - a `GtkEditableLabel` + a `GtkEditableLabel` - Switches the label into “editing mode”. + Switches the label into “editing mode”. + - a `GtkEditableLabel` + a `GtkEditableLabel` - Switches the label out of “editing mode”. + Switches the label out of “editing mode”. If @commit is %TRUE, the resulting text is kept as the [property@Gtk.Editable:text] property value, otherwise the resulting text is discarded and the label will keep its previous [property@Gtk.Editable:text] property value. + - a `GtkEditableLabel` + a `GtkEditableLabel` - whether to set the edited text on the label + whether to set the edited text on the label - This property is %TRUE while the widget is in edit mode. + This property is %TRUE while the widget is in edit mode. + @@ -26740,7 +27955,7 @@ previous [property@Gtk.Editable:text] property value. - The `GtkEmojiChooser` is used by text widgets such as `GtkEntry` or + The `GtkEmojiChooser` is used by text widgets such as `GtkEntry` or `GtkTextView` to let users insert Emoji characters. ![An example GtkEmojiChooser](emojichooser.png) @@ -26768,34 +27983,38 @@ style class itself. The bottom toolbar used to switch between different emoji categories consists of buttons with the .emoji-section style class and gets the .emoji-toolbar style class itself. + - Creates a new `GtkEmojiChooser`. + Creates a new `GtkEmojiChooser`. + - a new `GtkEmojiChooser` + a new `GtkEmojiChooser` - Emitted when the user selects an Emoji. + Emitted when the user selects an Emoji. - the Unicode sequence for the picked Emoji, in UTF-8 + the Unicode sequence for the picked Emoji, in UTF-8 - + + + - `GtkEntry` is a single line text entry widget. + `GtkEntry` is a single line text entry widget. ![An example GtkEntry](entry.png) @@ -26882,32 +28101,36 @@ content instead. # Accessibility `GtkEntry` uses the %GTK_ACCESSIBLE_ROLE_TEXT_BOX role. + - Creates a new entry. + Creates a new entry. + - a new `GtkEntry`. + a new `GtkEntry`. - Creates a new entry with the specified text buffer. + Creates a new entry with the specified text buffer. + - a new `GtkEntry` + a new `GtkEntry` - The buffer to use for the new `GtkEntry`. + The buffer to use for the new `GtkEntry`. + @@ -26919,142 +28142,151 @@ content instead. - Retrieves the value set by gtk_entry_set_activates_default(). + Retrieves the value set by gtk_entry_set_activates_default(). + - %TRUE if the entry will activate the default widget + %TRUE if the entry will activate the default widget - a `GtkEntry` + a `GtkEntry` - Gets the value set by gtk_entry_set_alignment(). + Gets the value set by gtk_entry_set_alignment(). See also: [property@Gtk.Editable:xalign] + - the alignment + the alignment - a `GtkEntry` + a `GtkEntry` - Gets the attribute list of the `GtkEntry`. + Gets the attribute list of the `GtkEntry`. See [method@Gtk.Entry.set_attributes]. + - the attribute list + the attribute list - a `GtkEntry` + a `GtkEntry` - Get the `GtkEntryBuffer` object which holds the text for + Get the `GtkEntryBuffer` object which holds the text for this widget. + - A `GtkEntryBuffer` object. + A `GtkEntryBuffer` object. - a `GtkEntry` + a `GtkEntry` - Returns the auxiliary completion object currently + Returns the auxiliary completion object currently in use by @entry. + - The auxiliary + The auxiliary completion object currently in use by @entry - A `GtkEntry` + A `GtkEntry` - Returns the index of the icon which is the source of the + Returns the index of the icon which is the source of the current DND operation, or -1. + - index of the icon which is the source of the + index of the icon which is the source of the current DND operation, or -1. - a `GtkEntry` + a `GtkEntry` - Gets the menu model set with gtk_entry_set_extra_menu(). + Gets the menu model set with gtk_entry_set_extra_menu(). + - the menu model + the menu model - a `GtkEntry` + a `GtkEntry` - Gets the value set by gtk_entry_set_has_frame(). + Gets the value set by gtk_entry_set_has_frame(). + - whether the entry has a beveled frame + whether the entry has a beveled frame - a `GtkEntry` + a `GtkEntry` - Returns whether the icon is activatable. + Returns whether the icon is activatable. + - %TRUE if the icon is activatable. + %TRUE if the icon is activatable. - a `GtkEntry` + a `GtkEntry` - Icon position + Icon position - Gets the area where entry’s icon at @icon_pos is drawn. + Gets the area where entry’s icon at @icon_pos is drawn. This function is useful when drawing something to the entry in a draw callback. @@ -27063,266 +28295,281 @@ If the entry is not realized or has no icon at the given position, @icon_area is filled with zeros. Otherwise, @icon_area will be filled with the icon's allocation, relative to @entry's allocation. + - A `GtkEntry` + A `GtkEntry` - Icon position + Icon position - Return location for the icon’s area + Return location for the icon’s area - Finds the icon at the given position and return its index. + Finds the icon at the given position and return its index. The position’s coordinates are relative to the @entry’s top left corner. If @x, @y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a [signal@Gtk.Widget::query-tooltip] signal handler. + - the index of the icon at the given position, or -1 + the index of the icon at the given position, or -1 - a `GtkEntry` + a `GtkEntry` - the x coordinate of the position to find, relative to @entry + the x coordinate of the position to find, relative to @entry - the y coordinate of the position to find, relative to @entry + the y coordinate of the position to find, relative to @entry - Retrieves the `GIcon` used for the icon. + Retrieves the `GIcon` used for the icon. %NULL will be returned if there is no icon or if the icon was set by some other method (e.g., by `GdkPaintable` or icon name). + - A `GIcon` + A `GIcon` - A `GtkEntry` + A `GtkEntry` - Icon position + Icon position - Retrieves the icon name used for the icon. + Retrieves the icon name used for the icon. %NULL is returned if there is no icon or if the icon was set by some other method (e.g., by `GdkPaintable` or gicon). + - An icon name + An icon name - A `GtkEntry` + A `GtkEntry` - Icon position + Icon position - Retrieves the `GdkPaintable` used for the icon. + Retrieves the `GdkPaintable` used for the icon. If no `GdkPaintable` was used for the icon, %NULL is returned. + - A `GdkPaintable` + A `GdkPaintable` if no icon is set for this position or the icon set is not a `GdkPaintable`. - A `GtkEntry` + A `GtkEntry` - Icon position + Icon position - Returns whether the icon appears sensitive or insensitive. + Returns whether the icon appears sensitive or insensitive. + - %TRUE if the icon is sensitive. + %TRUE if the icon is sensitive. - a `GtkEntry` + a `GtkEntry` - Icon position + Icon position - Gets the type of representation being used by the icon + Gets the type of representation being used by the icon to store image data. If the icon has no image data, the return value will be %GTK_IMAGE_EMPTY. + - image representation being used + image representation being used - a `GtkEntry` + a `GtkEntry` - Icon position + Icon position - Gets the contents of the tooltip on the icon at the specified + Gets the contents of the tooltip on the icon at the specified position in @entry. + - the tooltip text + the tooltip text - a `GtkEntry` + a `GtkEntry` - the icon position + the icon position - Gets the contents of the tooltip on the icon at the specified + Gets the contents of the tooltip on the icon at the specified position in @entry. + - the tooltip text + the tooltip text - a `GtkEntry` + a `GtkEntry` - the icon position + the icon position - Gets the input hints of this `GtkEntry`. + Gets the input hints of this `GtkEntry`. + - the input hints + the input hints - a `GtkEntry` + a `GtkEntry` - Gets the input purpose of the `GtkEntry`. + Gets the input purpose of the `GtkEntry`. + - the input purpose + the input purpose - a `GtkEntry` + a `GtkEntry` - Retrieves the character displayed in place of the actual text + Retrieves the character displayed in place of the actual text in “password mode”. + - the current invisible char, or 0, if the entry does not + the current invisible char, or 0, if the entry does not show invisible text at all. - a `GtkEntry` + a `GtkEntry` - Retrieves the maximum allowed length of the text in @entry. + Retrieves the maximum allowed length of the text in @entry. See [method@Gtk.Entry.set_max_length]. + - the maximum allowed number of characters + the maximum allowed number of characters in `GtkEntry`, or 0 if there is no maximum. - a `GtkEntry` + a `GtkEntry` - Gets whether the `GtkEntry` is in overwrite mode. + Gets whether the `GtkEntry` is in overwrite mode. + - whether the text is overwritten when typing. + whether the text is overwritten when typing. - a `GtkEntry` + a `GtkEntry` - Retrieves the text that will be displayed when @entry + Retrieves the text that will be displayed when @entry is empty and unfocused + - a pointer to the + a pointer to the placeholder text as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored. If no placeholder @@ -27331,112 +28578,118 @@ is empty and unfocused - a `GtkEntry` + a `GtkEntry` - Returns the current fraction of the task that’s been completed. + Returns the current fraction of the task that’s been completed. See [method@Gtk.Entry.set_progress_fraction]. + - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a `GtkEntry` + a `GtkEntry` - Retrieves the pulse step set with + Retrieves the pulse step set with gtk_entry_set_progress_pulse_step(). + - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a `GtkEntry` + a `GtkEntry` - Gets the tabstops of the `GtkEntry. + Gets the tabstops of the `GtkEntry. See [method@Gtk.Entry.set_tabs]. + - the tabstops + the tabstops - a `GtkEntry` + a `GtkEntry` - Retrieves the current length of the text in @entry. + Retrieves the current length of the text in @entry. This is equivalent to getting @entry's `GtkEntryBuffer` and calling [method@Gtk.EntryBuffer.get_length] on it. + - the current number of characters + the current number of characters in `GtkEntry`, or 0 if there are none. - a `GtkEntry` + a `GtkEntry` - Retrieves whether the text in @entry is visible. + Retrieves whether the text in @entry is visible. See [method@Gtk.Entry.set_visibility]. + - %TRUE if the text is currently visible + %TRUE if the text is currently visible - a `GtkEntry` + a `GtkEntry` - Causes @entry to have keyboard focus. + Causes @entry to have keyboard focus. It behaves like [method@Gtk.Widget.grab_focus], except that it doesn't select the contents of the entry. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries. + - %TRUE if focus is now inside @self + %TRUE if focus is now inside @self - a `GtkEntry` + a `GtkEntry` - Indicates that some progress is made, but you don’t + Indicates that some progress is made, but you don’t know how much. Causes the entry’s progress indicator to enter “activity @@ -27444,69 +28697,73 @@ mode”, where a block bounces back and forth. Each call to gtk_entry_progress_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by [method@Gtk.Entry.set_progress_pulse_step]). + - a `GtkEntry` + a `GtkEntry` - Reset the input method context of the entry if needed. + Reset the input method context of the entry if needed. This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. + - a `GtkEntry` + a `GtkEntry` - Sets whether pressing Enter in the @entry will activate the default + Sets whether pressing Enter in the @entry will activate the default widget for the window containing the entry. This usually means that the dialog containing the entry will be closed, since the default widget is usually one of the dialog buttons. + - a `GtkEntry` + a `GtkEntry` - %TRUE to activate window’s default widget on Enter keypress + %TRUE to activate window’s default widget on Enter keypress - Sets the alignment for the contents of the entry. + Sets the alignment for the contents of the entry. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry. See also: [property@Gtk.Editable:xalign] + - a `GtkEntry` + a `GtkEntry` - The horizontal alignment, from 0 (left) to 1 (right). + The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts @@ -27514,151 +28771,158 @@ See also: [property@Gtk.Editable:xalign] - Sets a `PangoAttrList`. + Sets a `PangoAttrList`. The attributes in the list are applied to the entry text. Since the attributes will be applies to text that changes as the user types, it makes most sense to use attributes with unlimited extent. + - a `GtkEntry` + a `GtkEntry` - a `PangoAttrList` + a `PangoAttrList` - Set the `GtkEntryBuffer` object which holds the text for + Set the `GtkEntryBuffer` object which holds the text for this widget. + - a `GtkEntry` + a `GtkEntry` - a `GtkEntryBuffer` + a `GtkEntryBuffer` - Sets @completion to be the auxiliary completion object + Sets @completion to be the auxiliary completion object to use with @entry. All further configuration of the completion mechanism is done on @completion using the `GtkEntryCompletion` API. Completion is disabled if @completion is set to %NULL. + - A `GtkEntry` + A `GtkEntry` - The `GtkEntryCompletion` + The `GtkEntryCompletion` - Sets a menu model to add when constructing + Sets a menu model to add when constructing the context menu for @entry. + - a `GtkEntry` + a `GtkEntry` - a `GMenuModel` + a `GMenuModel` - Sets whether the entry has a beveled frame around it. + Sets whether the entry has a beveled frame around it. + - a `GtkEntry` + a `GtkEntry` - new value + new value - Sets whether the icon is activatable. + Sets whether the icon is activatable. + - A `GtkEntry` + A `GtkEntry` - Icon position + Icon position - %TRUE if the icon should be activatable + %TRUE if the icon should be activatable - Sets up the icon at the given position as drag source. + Sets up the icon at the given position as drag source. This makes it so that GTK will start a drag operation when the user clicks and drags the icon. + - a `GtkEntry` + a `GtkEntry` - icon position + icon position - a `GdkContentProvider` + a `GdkContentProvider` - a bitmask of the allowed drag actions + a bitmask of the allowed drag actions - Sets the icon shown in the entry at the specified position + Sets the icon shown in the entry at the specified position from the current icon theme. If the icon isn’t known, a “broken image” icon will be @@ -27666,26 +28930,27 @@ displayed instead. If @icon is %NULL, no icon will be shown in the specified position. + - A `GtkEntry` + A `GtkEntry` - The position at which to set the icon + The position at which to set the icon - The icon to set + The icon to set - Sets the icon shown in the entry at the specified position + Sets the icon shown in the entry at the specified position from the current icon theme. If the icon name isn’t known, a “broken image” icon will be @@ -27693,69 +28958,72 @@ displayed instead. If @icon_name is %NULL, no icon will be shown in the specified position. + - A `GtkEntry` + A `GtkEntry` - The position at which to set the icon + The position at which to set the icon - An icon name + An icon name - Sets the icon shown in the specified position using a `GdkPaintable`. + Sets the icon shown in the specified position using a `GdkPaintable`. If @paintable is %NULL, no icon will be shown in the specified position. + - a `GtkEntry` + a `GtkEntry` - Icon position + Icon position - A `GdkPaintable` + A `GdkPaintable` - Sets the sensitivity for the specified icon. + Sets the sensitivity for the specified icon. + - A `GtkEntry` + A `GtkEntry` - Icon position + Icon position - Specifies whether the icon should appear + Specifies whether the icon should appear sensitive or insensitive - Sets @tooltip as the contents of the tooltip for the icon at + Sets @tooltip as the contents of the tooltip for the icon at the specified position. @tooltip is assumed to be marked up with Pango Markup. @@ -27764,26 +29032,27 @@ Use %NULL for @tooltip to remove an existing tooltip. See also [method@Gtk.Widget.set_tooltip_markup] and [method@Gtk.Entry.set_icon_tooltip_text]. + - a `GtkEntry` + a `GtkEntry` - the icon position + the icon position - the contents of the tooltip for the icon + the contents of the tooltip for the icon - Sets @tooltip as the contents of the tooltip for the icon + Sets @tooltip as the contents of the tooltip for the icon at the specified position. Use %NULL for @tooltip to remove an existing tooltip. @@ -27800,63 +29069,66 @@ icon tooltips too. You can resolve this by then calling [property@Gtk.Widget:has-tooltip] back to %TRUE, or setting at least one non-empty tooltip on any icon achieves the same result. + - a `GtkEntry` + a `GtkEntry` - the icon position + the icon position - the contents of the tooltip for the icon + the contents of the tooltip for the icon - Set additional hints which allow input methods to + Set additional hints which allow input methods to fine-tune their behavior. + - a `GtkEntry` + a `GtkEntry` - the hints + the hints - Sets the input purpose which can be used by input methods + Sets the input purpose which can be used by input methods to adjust their behavior. + - a `GtkEntry` + a `GtkEntry` - the purpose + the purpose - Sets the character to use in place of the actual text + Sets the character to use in place of the actual text in “password mode”. See [method@Gtk.Entry.set_visibility] for how to enable @@ -27866,39 +29138,41 @@ By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type. + - a `GtkEntry` + a `GtkEntry` - a Unicode character + a Unicode character - Sets the maximum allowed length of the contents of the widget. + Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit. This is equivalent to getting @entry's `GtkEntryBuffer` and calling [method@Gtk.EntryBuffer.set_max_length] on it. + - a `GtkEntry` + a `GtkEntry` - the maximum length of the entry, or 0 for no maximum. + the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. @@ -27907,104 +29181,109 @@ calling [method@Gtk.EntryBuffer.set_max_length] on it. - Sets whether the text is overwritten when typing in the `GtkEntry`. + Sets whether the text is overwritten when typing in the `GtkEntry`. + - a `GtkEntry` + a `GtkEntry` - new value + new value - Sets text to be displayed in @entry when it is empty. + Sets text to be displayed in @entry when it is empty. This can be used to give a visual hint of the expected contents of the `GtkEntry`. + - a `GtkEntry` + a `GtkEntry` - a string to be displayed when @entry is empty and unfocused + a string to be displayed when @entry is empty and unfocused - Causes the entry’s progress indicator to “fill in” the given + Causes the entry’s progress indicator to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive. + - a `GtkEntry` + a `GtkEntry` - fraction of the task that’s been completed + fraction of the task that’s been completed - Sets the fraction of total entry width to move the progress + Sets the fraction of total entry width to move the progress bouncing block for each pulse. Use [method@Gtk.Entry.progress_pulse] to pulse the progress. + - a `GtkEntry` + a `GtkEntry` - fraction between 0.0 and 1.0 + fraction between 0.0 and 1.0 - Sets a `PangoTabArray`. + Sets a `PangoTabArray`. The tabstops in the array are applied to the entry text. + - a `GtkEntry` + a `GtkEntry` - a `PangoTabArray` + a `PangoTabArray` - Sets whether the contents of the entry are visible or not. + Sets whether the contents of the entry are visible or not. When visibility is set to %FALSE, characters are displayed as the invisible char, and will also appear that way when @@ -28018,29 +29297,31 @@ Note that you probably want to set [property@Gtk.Entry:input-purpose] to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN to inform input methods about the purpose of this entry, in addition to setting visibility to %FALSE. + - a `GtkEntry` + a `GtkEntry` - %TRUE if the contents of the entry are displayed as plaintext + %TRUE if the contents of the entry are displayed as plaintext - Unsets the invisible char, so that the default invisible char + Unsets the invisible char, so that the default invisible char is used again. See [method@Gtk.Entry.set_invisible_char]. + - a `GtkEntry` + a `GtkEntry` @@ -28048,13 +29329,13 @@ is used again. See [method@Gtk.Entry.set_invisible_char]. - Whether to activate the default widget when Enter is pressed. + Whether to activate the default widget when Enter is pressed. - A list of Pango attributes to apply to the text of the entry. + A list of Pango attributes to apply to the text of the entry. This is mainly useful to change the size or weight of the text. @@ -28065,34 +29346,34 @@ The `PangoAttribute`'s @start_index and @end_index must refer to the - The buffer object which actually stores the text. + The buffer object which actually stores the text. - The auxiliary completion object to use with the entry. + The auxiliary completion object to use with the entry. - Whether to suggest Emoji replacements for :-delimited names + Whether to suggest Emoji replacements for :-delimited names like `:heart:`. - A menu model whose contents will be appended to the context menu. + A menu model whose contents will be appended to the context menu. - Whehter the entry should draw a frame. + Whehter the entry should draw a frame. - Which IM (input method) module should be used for this entry. + Which IM (input method) module should be used for this entry. See [class@Gtk.IMContext]. @@ -28104,7 +29385,7 @@ property. - Additional hints that allow input methods to fine-tune their behavior. + Additional hints that allow input methods to fine-tune their behavior. Also see [property@Gtk.Entry:input-purpose] @@ -28112,7 +29393,7 @@ Also see [property@Gtk.Entry:input-purpose] - The purpose of this text field. + The purpose of this text field. This property can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -28125,34 +29406,34 @@ Note that setting the purpose to %GTK_INPUT_PURPOSE_PASSWORD or - The character to use when masking entry contents (“password mode”). + The character to use when masking entry contents (“password mode”). - Whether the invisible char has been set for the `GtkEntry`. + Whether the invisible char has been set for the `GtkEntry`. - Maximum number of characters for this entry. + Maximum number of characters for this entry. - If text is overwritten when typing in the `GtkEntry`. + If text is overwritten when typing in the `GtkEntry`. - The text that will be displayed in the `GtkEntry` when it is empty + The text that will be displayed in the `GtkEntry` when it is empty and unfocused. - Whether the primary icon is activatable. + Whether the primary icon is activatable. GTK emits the [signal@Gtk.Entry::icon-press] and [signal@Gtk.Entry::icon-release] signals only on sensitive, @@ -28163,19 +29444,19 @@ informational purposes. - The `GIcon` to use for the primary icon for the entry. + The `GIcon` to use for the primary icon for the entry. - The icon name to use for the primary icon for the entry. + The icon name to use for the primary icon for the entry. - A `GdkPaintable` to use as the primary icon for the entry. + A `GdkPaintable` to use as the primary icon for the entry. - Whether the primary icon is sensitive. + Whether the primary icon is sensitive. An insensitive icon appears grayed out. GTK does not emit the [signal@Gtk.Entry::icon-press] and [signal@Gtk.Entry::icon-release] @@ -28186,17 +29467,17 @@ when clicked is currently not available. - The representation which is used for the primary icon of the entry. + The representation which is used for the primary icon of the entry. - The contents of the tooltip on the primary icon, with markup. + The contents of the tooltip on the primary icon, with markup. Also see [method@Gtk.Entry.set_icon_tooltip_markup]. - The contents of the tooltip on the primary icon. + The contents of the tooltip on the primary icon. Also see [method@Gtk.Entry.set_icon_tooltip_text]. @@ -28204,24 +29485,24 @@ Also see [method@Gtk.Entry.set_icon_tooltip_text]. - The current fraction of the task that's been completed. + The current fraction of the task that's been completed. - The fraction of total entry width to move the progress + The fraction of total entry width to move the progress bouncing block for each pulse. See [method@Gtk.Entry.progress_pulse]. - Number of pixels of the entry scrolled off the screen to the left. + Number of pixels of the entry scrolled off the screen to the left. - Whether the secondary icon is activatable. + Whether the secondary icon is activatable. GTK emits the [signal@Gtk.Entry::icon-press] and [signal@Gtk.Entry::icon-release] signals only on sensitive, @@ -28232,19 +29513,19 @@ informational purposes. - The `GIcon` to use for the secondary icon for the entry. + The `GIcon` to use for the secondary icon for the entry. - The icon name to use for the secondary icon for the entry. + The icon name to use for the secondary icon for the entry. - A `GdkPaintable` to use as the secondary icon for the entry. + A `GdkPaintable` to use as the secondary icon for the entry. - Whether the secondary icon is sensitive. + Whether the secondary icon is sensitive. An insensitive icon appears grayed out. GTK does not emit the [signal@Gtk.Entry::icon-press[ and [signal@Gtk.Entry::icon-release] @@ -28255,17 +29536,17 @@ when clicked is currently not available. - The representation which is used for the secondary icon of the entry. + The representation which is used for the secondary icon of the entry. - The contents of the tooltip on the secondary icon, with markup. + The contents of the tooltip on the secondary icon, with markup. Also see [method@Gtk.Entry.set_icon_tooltip_markup]. - The contents of the tooltip on the secondary icon. + The contents of the tooltip on the secondary icon. Also see [method@Gtk.Entry.set_icon_tooltip_text]. @@ -28278,17 +29559,17 @@ Also see [method@Gtk.Entry.set_icon_tooltip_text]. - The length of the text in the `GtkEntry`. + The length of the text in the `GtkEntry`. - When %TRUE, pasted multi-line text is truncated to the first line. + When %TRUE, pasted multi-line text is truncated to the first line. - Whether the entry should show the “invisible char” instead of the + Whether the entry should show the “invisible char” instead of the actual text (“password mode”). @@ -28296,7 +29577,7 @@ actual text (“password mode”). - Emitted when the entry is activated. + Emitted when the entry is activated. The keybindings for this signal are all forms of the Enter key. @@ -28304,33 +29585,33 @@ The keybindings for this signal are all forms of the Enter key. - Emitted when an activatable icon is clicked. + Emitted when an activatable icon is clicked. - The position of the clicked icon + The position of the clicked icon - Emitted on the button release from a mouse click + Emitted on the button release from a mouse click over an activatable icon. - The position of the clicked icon + The position of the clicked icon - A `GtkEntryBuffer` hold the text displayed in a `GtkText` widget. + A `GtkEntryBuffer` hold the text displayed in a `GtkText` widget. A single `GtkEntryBuffer` object can be shared by multiple widgets which will then share the same text content, but not the cursor @@ -28340,27 +29621,29 @@ position, visibility attributes, icon etc. text to be stored in an alternate location, such as non-pageable memory, useful in the case of important passwords. Or a derived class could integrate with an application’s concept of undo/redo. + - Create a new `GtkEntryBuffer` object. + Create a new `GtkEntryBuffer` object. Optionally, specify initial text to set in the buffer. + - A new `GtkEntryBuffer` object. + A new `GtkEntryBuffer` object. - initial buffer text + initial buffer text - number of characters in @initial_chars, or -1 + number of characters in @initial_chars, or -1 - Deletes a sequence of characters from the buffer. + Deletes a sequence of characters from the buffer. @n_chars characters are deleted starting at @position. If @n_chars is negative, then all characters until the @@ -28371,26 +29654,28 @@ are coerced to sane values. Note that the positions are specified in characters, not bytes. + - The number of characters deleted. + The number of characters deleted. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - position at which to delete text + position at which to delete text - number of characters to delete + number of characters to delete + @@ -28408,19 +29693,21 @@ not bytes. - Retrieves the length in characters of the buffer. + Retrieves the length in characters of the buffer. + - The number of characters in the buffer. + The number of characters in the buffer. - a `GtkEntryBuffer` + a `GtkEntryBuffer` + @@ -28434,7 +29721,7 @@ not bytes. - Inserts @n_chars characters of @chars into the contents of the + Inserts @n_chars characters of @chars into the contents of the buffer, at position @position. If @n_chars is negative, then characters from chars will be inserted @@ -28443,30 +29730,32 @@ bounds, or the maximum buffer text length is exceeded, then they are coerced to sane values. Note that the position and length are in characters, not in bytes. + - The number of characters actually inserted. + The number of characters actually inserted. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - the position at which to insert text. + the position at which to insert text. - the text to insert into the buffer. + the text to insert into the buffer. - the length of the text in characters, or -1 + the length of the text in characters, or -1 + @@ -28486,7 +29775,7 @@ Note that the position and length are in characters, not in bytes. - Deletes a sequence of characters from the buffer. + Deletes a sequence of characters from the buffer. @n_chars characters are deleted starting at @position. If @n_chars is negative, then all characters until the @@ -28497,134 +29786,141 @@ are coerced to sane values. Note that the positions are specified in characters, not bytes. + - The number of characters deleted. + The number of characters deleted. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - position at which to delete text + position at which to delete text - number of characters to delete + number of characters to delete - Used when subclassing `GtkEntryBuffer`. + Used when subclassing `GtkEntryBuffer`. + - a `GtkEntryBuffer` + a `GtkEntryBuffer` - position at which text was deleted + position at which text was deleted - number of characters deleted + number of characters deleted - Used when subclassing `GtkEntryBuffer`. + Used when subclassing `GtkEntryBuffer`. + - a `GtkEntryBuffer` + a `GtkEntryBuffer` - position at which text was inserted + position at which text was inserted - text that was inserted + text that was inserted - number of characters inserted + number of characters inserted - Retrieves the length in bytes of the buffer. + Retrieves the length in bytes of the buffer. See [method@Gtk.EntryBuffer.get_length]. + - The byte length of the buffer. + The byte length of the buffer. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - Retrieves the length in characters of the buffer. + Retrieves the length in characters of the buffer. + - The number of characters in the buffer. + The number of characters in the buffer. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - Retrieves the maximum allowed length of the text in @buffer. + Retrieves the maximum allowed length of the text in @buffer. + - the maximum allowed number of characters + the maximum allowed number of characters in `GtkEntryBuffer`, or 0 if there is no maximum. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - Retrieves the contents of the buffer. + Retrieves the contents of the buffer. The memory pointer returned by this call will not change unless this object emits a signal, or is finalized. + - a pointer to the contents of the widget as a + a pointer to the contents of the widget as a string. This string points to internally allocated storage in the buffer and must not be freed, modified or stored. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - Inserts @n_chars characters of @chars into the contents of the + Inserts @n_chars characters of @chars into the contents of the buffer, at position @position. If @n_chars is negative, then characters from chars will be inserted @@ -28633,45 +29929,47 @@ bounds, or the maximum buffer text length is exceeded, then they are coerced to sane values. Note that the position and length are in characters, not in bytes. + - The number of characters actually inserted. + The number of characters actually inserted. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - the position at which to insert text. + the position at which to insert text. - the text to insert into the buffer. + the text to insert into the buffer. - the length of the text in characters, or -1 + the length of the text in characters, or -1 - Sets the maximum allowed length of the contents of the buffer. + Sets the maximum allowed length of the contents of the buffer. If the current contents are longer than the given length, then they will be truncated to fit. + - a `GtkEntryBuffer` + a `GtkEntryBuffer` - the maximum length of the entry buffer, or 0 for no maximum. + the maximum length of the entry buffer, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. @@ -28680,53 +29978,54 @@ they will be truncated to fit. - Sets the text in the buffer. + Sets the text in the buffer. This is roughly equivalent to calling [method@Gtk.EntryBuffer.delete_text] and [method@Gtk.EntryBuffer.insert_text]. Note that @n_chars is in characters, not in bytes. + - a `GtkEntryBuffer` + a `GtkEntryBuffer` - the new text + the new text - the number of characters in @text, or -1 + the number of characters in @text, or -1 - The length (in characters) of the text in buffer. + The length (in characters) of the text in buffer. - The maximum length (in characters) of the text in the buffer. + The maximum length (in characters) of the text in the buffer. - The contents of the buffer. + The contents of the buffer. - The text is altered in the default handler for this signal. + The text is altered in the default handler for this signal. If you want access to the text after the text has been modified, use %G_CONNECT_AFTER. @@ -28735,42 +30034,44 @@ use %G_CONNECT_AFTER. - the position the text was deleted at. + the position the text was deleted at. - The number of characters that were deleted. + The number of characters that were deleted. - This signal is emitted after text is inserted into the buffer. + This signal is emitted after text is inserted into the buffer. - the position the text was inserted at. + the position the text was inserted at. - The text that was inserted. + The text that was inserted. - The number of characters that were inserted. + The number of characters that were inserted. + + @@ -28792,6 +30093,7 @@ use %G_CONNECT_AFTER. + @@ -28810,6 +30112,7 @@ use %G_CONNECT_AFTER. + @@ -28825,13 +30128,14 @@ use %G_CONNECT_AFTER. + - The number of characters in the buffer. + The number of characters in the buffer. - a `GtkEntryBuffer` + a `GtkEntryBuffer` @@ -28839,25 +30143,26 @@ use %G_CONNECT_AFTER. + - The number of characters actually inserted. + The number of characters actually inserted. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - the position at which to insert text. + the position at which to insert text. - the text to insert into the buffer. + the text to insert into the buffer. - the length of the text in characters, or -1 + the length of the text in characters, or -1 @@ -28865,21 +30170,22 @@ use %G_CONNECT_AFTER. + - The number of characters deleted. + The number of characters deleted. - a `GtkEntryBuffer` + a `GtkEntryBuffer` - position at which to delete text + position at which to delete text - number of characters to delete + number of characters to delete @@ -28887,6 +30193,7 @@ use %G_CONNECT_AFTER. + @@ -28894,6 +30201,7 @@ use %G_CONNECT_AFTER. + @@ -28901,6 +30209,7 @@ use %G_CONNECT_AFTER. + @@ -28908,6 +30217,7 @@ use %G_CONNECT_AFTER. + @@ -28915,6 +30225,7 @@ use %G_CONNECT_AFTER. + @@ -28922,6 +30233,7 @@ use %G_CONNECT_AFTER. + @@ -28929,6 +30241,7 @@ use %G_CONNECT_AFTER. + @@ -28936,6 +30249,7 @@ use %G_CONNECT_AFTER. + @@ -28943,17 +30257,19 @@ use %G_CONNECT_AFTER. - Class structure for `GtkEntry`. All virtual functions have a default + Class structure for `GtkEntry`. All virtual functions have a default implementation. Derived classes may set the virtual function pointers for the signal handlers to %NULL, but must keep @get_text_area_size and @get_frame_size non-%NULL; either use the default implementation, or provide a custom one. + - The parent class. + The parent class. + @@ -28971,7 +30287,7 @@ a custom one. - `GtkEntryCompletion` is an auxiliary object to provide completion functionality + `GtkEntryCompletion` is an auxiliary object to provide completion functionality for `GtkEntry`. It implements the [iface@Gtk.CellLayout] interface, to allow the user @@ -29012,388 +30328,411 @@ matching iter. - Creates a new `GtkEntryCompletion` object. + Creates a new `GtkEntryCompletion` object. + - A newly created `GtkEntryCompletion` object + A newly created `GtkEntryCompletion` object - Creates a new `GtkEntryCompletion` object using the + Creates a new `GtkEntryCompletion` object using the specified @area. The `GtkCellArea` is used to layout cells in the underlying `GtkTreeViewColumn` for the drop-down menu. + - A newly created `GtkEntryCompletion` object + A newly created `GtkEntryCompletion` object - the `GtkCellArea` used to layout cells + the `GtkCellArea` used to layout cells - Requests a completion operation, or in other words a refiltering of the + Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key. The completion list view will be updated accordingly. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Computes the common prefix that is shared by all rows in @completion + Computes the common prefix that is shared by all rows in @completion that start with @key. If no row matches @key, %NULL will be returned. Note that a text column must have been set for this function to work, see [method@Gtk.EntryCompletion.set_text_column] for details. + - The common prefix all rows + The common prefix all rows starting with @key - the entry completion + the entry completion - The text to complete for + The text to complete for - Get the original text entered by the user that triggered + Get the original text entered by the user that triggered the completion or %NULL if there’s no completion ongoing. + - the prefix for the current completion + the prefix for the current completion - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Gets the entry @completion has been attached to. + Gets the entry @completion has been attached to. + - The entry @completion has been attached to + The entry @completion has been attached to - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns whether the common prefix of the possible completions should + Returns whether the common prefix of the possible completions should be automatically inserted in the entry. + - %TRUE if inline completion is turned on + %TRUE if inline completion is turned on - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns %TRUE if inline-selection mode is turned on. + Returns %TRUE if inline-selection mode is turned on. + - %TRUE if inline-selection mode is on + %TRUE if inline-selection mode is on - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns the minimum key length as set for @completion. + Returns the minimum key length as set for @completion. + - The currently used minimum key length + The currently used minimum key length - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns the model the `GtkEntryCompletion` is using as data source. + Returns the model the `GtkEntryCompletion` is using as data source. Returns %NULL if the model is unset. + - A `GtkTreeModel` + A `GtkTreeModel` - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns whether the completions should be presented in a popup window. + Returns whether the completions should be presented in a popup window. + - %TRUE if popup completion is turned on + %TRUE if popup completion is turned on - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns whether the completion popup window will be resized to the + Returns whether the completion popup window will be resized to the width of the entry. + - %TRUE if the popup window will be resized to the width of + %TRUE if the popup window will be resized to the width of the entry - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns whether the completion popup window will appear even if there is + Returns whether the completion popup window will appear even if there is only a single match. + - %TRUE if the popup window will appear regardless of the + %TRUE if the popup window will appear regardless of the number of matches - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Returns the column in the model of @completion to get strings from. + Returns the column in the model of @completion to get strings from. + - the column containing the strings + the column containing the strings - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Requests a prefix insertion. + Requests a prefix insertion. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - Sets whether the common prefix of the possible completions should + Sets whether the common prefix of the possible completions should be automatically inserted in the entry. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - %TRUE to do inline completion + %TRUE to do inline completion - Sets whether it is possible to cycle through the possible completions + Sets whether it is possible to cycle through the possible completions inside the entry. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - %TRUE to do inline selection + %TRUE to do inline selection - Sets the match function for @completion to be @func. + Sets the match function for @completion to be @func. The match function is used to determine if a row should or should not be in the completion list. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - the `GtkEntryCompletion`MatchFunc to use + the `GtkEntryCompletion`MatchFunc to use - user data for @func + user data for @func - destroy notify for @func_data. + destroy notify for @func_data. - Requires the length of the search key for @completion to be at least + Requires the length of the search key for @completion to be at least @length. This is useful for long lists, where completing using a small key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset). + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - the minimum length of the key in order to start completing + the minimum length of the key in order to start completing - Sets the model for a `GtkEntryCompletion`. + Sets the model for a `GtkEntryCompletion`. If @completion already has a model set, it will remove it before setting the new model. If model is %NULL, then it will unset the model. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - the `GtkTreeModel` + the `GtkTreeModel` - Sets whether the completions should be presented in a popup window. + Sets whether the completions should be presented in a popup window. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - %TRUE to do popup completion + %TRUE to do popup completion - Sets whether the completion popup window will be resized to be the same + Sets whether the completion popup window will be resized to be the same width as the entry. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - %TRUE to make the width of the popup the same as the entry + %TRUE to make the width of the popup the same as the entry - Sets whether the completion popup window will appear even if there is + Sets whether the completion popup window will appear even if there is only a single match. You may want to set this to %FALSE if you are using [property@Gtk.EntryCompletion:inline-completion]. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - %TRUE if the popup should appear even for a single match + %TRUE if the popup should appear even for a single match - Convenience function for setting up the most used case of this code: a + Convenience function for setting up the most used case of this code: a completion list with just strings. This function will set up @completion @@ -29404,22 +30743,23 @@ This functions creates and adds a `GtkCellRendererText` for the selected column. If you need to set the text column, but don't want the cell renderer, use g_object_set() to set the [property@Gtk.EntryCompletion:text-column] property directly. + - a `GtkEntryCompletion` + a `GtkEntryCompletion` - the column in the model of @completion to get strings from + the column in the model of @completion to get strings from - The `GtkCellArea` used to layout cell renderers in the treeview column. + The `GtkCellArea` used to layout cell renderers in the treeview column. If no area is specified when creating the entry completion with [ctor@Gtk.EntryCompletion.new_with_area], a horizontally oriented @@ -29429,7 +30769,7 @@ If no area is specified when creating the entry completion with - Determines whether the common prefix of the possible completions + Determines whether the common prefix of the possible completions should be inserted automatically in the entry. Note that this requires text-column to be set, even if you are @@ -29439,7 +30779,7 @@ using a custom match function. - Determines whether the possible completions on the popup + Determines whether the possible completions on the popup will appear in the entry as you navigate through them. @@ -29452,21 +30792,21 @@ will appear in the entry as you navigate through them. - Determines whether the possible completions should be + Determines whether the possible completions should be shown in a popup window. - Determines whether the completions popup window will be + Determines whether the completions popup window will be resized to the width of the entry. - Determines whether the completions popup window will shown + Determines whether the completions popup window will shown for a single possible completion. You probably want to set this to %FALSE if you are using @@ -29476,13 +30816,13 @@ You probably want to set this to %FALSE if you are using - The column of the model containing the strings. + The column of the model containing the strings. Note that the strings must be UTF-8. - Emitted when a match from the cursor is on a match of the list. + Emitted when a match from the cursor is on a match of the list. The default behaviour is to replace the contents of the entry with the contents of the text column in the row @@ -29491,22 +30831,22 @@ pointed to by @iter. Note that @model is the model that was passed to [method@Gtk.EntryCompletion.set_model]. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - the `GtkTreeModel` containing the matches + the `GtkTreeModel` containing the matches - a `GtkTreeIter` positioned at the selected match + a `GtkTreeIter` positioned at the selected match - Emitted when the inline autocompletion is triggered. + Emitted when the inline autocompletion is triggered. The default behaviour is to make the entry display the whole prefix and select the newly inserted part. @@ -29516,18 +30856,18 @@ smaller part of the @prefix into the entry - e.g. the entry used in the `GtkFileChooser` inserts only the part of the prefix up to the next '/'. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - the common prefix of all possible completions + the common prefix of all possible completions - Emitted when a match from the list is selected. + Emitted when a match from the list is selected. The default behaviour is to replace the contents of the entry with the contents of the text column in the row @@ -29536,22 +30876,22 @@ pointed to by @iter. Note that @model is the model that was passed to [method@Gtk.EntryCompletion.set_model]. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - the `GtkTreeModel` containing the matches + the `GtkTreeModel` containing the matches - a `GtkTreeIter` positioned at the selected match + a `GtkTreeIter` positioned at the selected match - Emitted when the filter model has zero + Emitted when the filter model has zero number of rows in completion_complete method. In other words when `GtkEntryCompletion` is out of suggestions. @@ -29561,48 +30901,49 @@ In other words when `GtkEntryCompletion` is out of suggestions. - A function which decides whether the row indicated by @iter matches + A function which decides whether the row indicated by @iter matches a given @key, and should be displayed as a possible completion for @key. Note that @key is normalized and case-folded (see g_utf8_normalize() and g_utf8_casefold()). If this is not appropriate, match functions have access to the unmodified key via `gtk_editable_get_text (GTK_EDITABLE (gtk_entry_completion_get_entry ()))`. + - %TRUE if @iter should be displayed as a possible completion + %TRUE if @iter should be displayed as a possible completion for @key - the `GtkEntryCompletion` + the `GtkEntryCompletion` - the string to match, normalized and case-folded + the string to match, normalized and case-folded - a `GtkTreeIter` indicating the row to match + a `GtkTreeIter` indicating the row to match - user data given to gtk_entry_completion_set_match_func() + user data given to gtk_entry_completion_set_match_func() - Specifies the side of the entry at which an icon is placed. + Specifies the side of the entry at which an icon is placed. - At the beginning of the entry (depending on the text direction). + At the beginning of the entry (depending on the text direction). - At the end of the entry (depending on the text direction). + At the end of the entry (depending on the text direction). - `GtkEventController` is the base class for event controllers. + `GtkEventController` is the base class for event controllers. These are ancillary objects associated to widgets, which react to `GdkEvents`, and possibly trigger actions as a consequence. @@ -29614,192 +30955,205 @@ explicitly remove a controller with [method@Gtk.Widget.remove_controller]. See the chapter on [input handling](input-handling.html) for an overview of the basic concepts, such as the capture and bubble phases of even propagation. + - Returns the event that is currently being handled by the controller. + Returns the event that is currently being handled by the controller. At other times, %NULL is returned. + - the event that is currently + the event that is currently handled by @controller - a `GtkEventController` + a `GtkEventController` - Returns the device of the event that is currently being + Returns the device of the event that is currently being handled by the controller. At other times, %NULL is returned. + - device of the event is + device of the event is currently handled by @controller - a `GtkEventController` + a `GtkEventController` - Returns the modifier state of the event that is currently being + Returns the modifier state of the event that is currently being handled by the controller. At other times, 0 is returned. + - modifier state of the event is currently handled by @controller + modifier state of the event is currently handled by @controller - a `GtkEventController` + a `GtkEventController` - Returns the timestamp of the event that is currently being + Returns the timestamp of the event that is currently being handled by the controller. At other times, 0 is returned. + - timestamp of the event is currently handled by @controller + timestamp of the event is currently handled by @controller - a `GtkEventController` + a `GtkEventController` - Gets the name of @controller. + Gets the name of @controller. + - a `GtkEventController` + a `GtkEventController` - Gets the propagation limit of the event controller. + Gets the propagation limit of the event controller. + - the propagation limit + the propagation limit - a `GtkEventController` + a `GtkEventController` - Gets the propagation phase at which @controller handles events. + Gets the propagation phase at which @controller handles events. + - the propagation phase + the propagation phase - a `GtkEventController` + a `GtkEventController` - Returns the `GtkWidget` this controller relates to. + Returns the `GtkWidget` this controller relates to. + - a `GtkWidget` + a `GtkWidget` - a `GtkEventController` + a `GtkEventController` - Resets the @controller to a clean state. + Resets the @controller to a clean state. + - a `GtkEventController` + a `GtkEventController` - Sets a name on the controller that can be used for debugging. + Sets a name on the controller that can be used for debugging. + - a `GtkEventController` + a `GtkEventController` - a name for @controller + a name for @controller - Sets the event propagation limit on the event controller. + Sets the event propagation limit on the event controller. If the limit is set to %GTK_LIMIT_SAME_NATIVE, the controller won't handle events that are targeted at widgets on a different surface, such as popovers. + - a `GtkEventController` + a `GtkEventController` - the propagation limit + the propagation limit - Sets the propagation phase at which a controller handles events. + Sets the propagation phase at which a controller handles events. If @phase is %GTK_PHASE_NONE, no automatic event handling will be performed, but other additional gesture maintenance will. + - a `GtkEventController` + a `GtkEventController` - a propagation phase + a propagation phase @@ -29807,30 +31161,32 @@ performed, but other additional gesture maintenance will. - The name for this controller, typically used for debugging purposes. + The name for this controller, typically used for debugging purposes. - The limit for which events this controller will handle. + The limit for which events this controller will handle. - The propagation phase at which this controller will handle events. + The propagation phase at which this controller will handle events. - The widget receiving the `GdkEvents` that the controller will handle. + The widget receiving the `GdkEvents` that the controller will handle. - + + + - `GtkEventControllerFocus` is an event controller to keep track of + `GtkEventControllerFocus` is an event controller to keep track of keyboard focus. The event controller offers [signal@Gtk.EventControllerFocus::enter] @@ -29839,44 +31195,48 @@ and [signal@Gtk.EventControllerFocus::leave] signals, as well as [property@Gtk.EventControllerFocus:contains-focus] properties which are updated to reflect focus changes inside the widget hierarchy that is rooted at the controllers widget. + - Creates a new event controller that will handle focus events. + Creates a new event controller that will handle focus events. + - a new `GtkEventControllerFocus` + a new `GtkEventControllerFocus` - Returns %TRUE if focus is within @self or one of its children. + Returns %TRUE if focus is within @self or one of its children. + - %TRUE if focus is within @self or one of its children + %TRUE if focus is within @self or one of its children - a `GtkEventControllerFocus` + a `GtkEventControllerFocus` - Returns %TRUE if focus is within @self, but not one of its children. + Returns %TRUE if focus is within @self, but not one of its children. + - %TRUE if focus is within @self, but not one of its children + %TRUE if focus is within @self, but not one of its children - a `GtkEventControllerFocus` + a `GtkEventControllerFocus` - %TRUE if focus is contained in the controllers widget. + %TRUE if focus is contained in the controllers widget. See [property@Gtk.EventControllerFocus:is-focus] for whether the focus is in the widget itself or inside a descendent. @@ -29888,7 +31248,7 @@ before [signal@Gtk.EventControllerFocus::enter] or - %TRUE if focus is in the controllers widget itself, + %TRUE if focus is in the controllers widget itself, as opposed to in a descendent widget. See also [property@Gtk.EventControllerFocus:contains-focus]. @@ -29899,7 +31259,7 @@ before [signal@Gtk.EventControllerFocus::enter] or - Emitted whenever the focus enters into the widget or one + Emitted whenever the focus enters into the widget or one of its descendents. Note that this means you may not get an ::enter signal @@ -29914,7 +31274,7 @@ property for changes. - Emitted whenever the focus leaves the widget hierarchy + Emitted whenever the focus leaves the widget hierarchy that is rooted at the widget that the controller is attached to. Note that this means you may not get a ::leave signal @@ -29928,85 +31288,93 @@ property for changes. - + + + - `GtkEventControllerKey` is an event controller that provides access + `GtkEventControllerKey` is an event controller that provides access to key events. + - Creates a new event controller that will handle key events. + Creates a new event controller that will handle key events. + - a new `GtkEventControllerKey` + a new `GtkEventControllerKey` - Forwards the current event of this @controller to a @widget. + Forwards the current event of this @controller to a @widget. This function can only be used in handlers for the [signal@Gtk.EventControllerKey::key-pressed], [signal@Gtk.EventControllerKey::key-released] or [signal@Gtk.EventControllerKey::modifiers] signals. + - whether the @widget handled the event + whether the @widget handled the event - a `GtkEventControllerKey` + a `GtkEventControllerKey` - a `GtkWidget` + a `GtkWidget` - Gets the key group of the current event of this @controller. + Gets the key group of the current event of this @controller. See [method@Gdk.KeyEvent.get_layout]. + - the key group + the key group - a `GtkEventControllerKey` + a `GtkEventControllerKey` - Gets the input method context of the key @controller. + Gets the input method context of the key @controller. + - the `GtkIMContext` + the `GtkIMContext` - a `GtkEventControllerKey` + a `GtkEventControllerKey` - Sets the input method context of the key @controller. + Sets the input method context of the key @controller. + - a `GtkEventControllerKey` + a `GtkEventControllerKey` - a `GtkIMContext` + a `GtkIMContext` - Emitted whenever the input method context filters away + Emitted whenever the input method context filters away a keypress and prevents the @controller receiving it. See [method@Gtk.EventControllerKey.set_im_context] and @@ -30016,91 +31384,97 @@ See [method@Gtk.EventControllerKey.set_im_context] and - Emitted whenever a key is pressed. + Emitted whenever a key is pressed. - %TRUE if the key press was handled, %FALSE otherwise. + %TRUE if the key press was handled, %FALSE otherwise. - the pressed key. + the pressed key. - the raw code of the pressed key. + the raw code of the pressed key. - the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`. + the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`. - Emitted whenever a key is released. + Emitted whenever a key is released. - the released key. + the released key. - the raw code of the released key. + the raw code of the released key. - the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`. + the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`. - Emitted whenever the state of modifier keys and pointer buttons change. + Emitted whenever the state of modifier keys and pointer buttons change. - the released key. + the released key. - + + + - `GtkEventControllerLegacy` is an event controller that provides raw + `GtkEventControllerLegacy` is an event controller that provides raw access to the event stream. It should only be used as a last resort if none of the other event controllers or gestures do the job. + - Creates a new legacy event controller. + Creates a new legacy event controller. + - the newly created event controller. + the newly created event controller. - Emitted for each GDK event delivered to @controller. + Emitted for each GDK event delivered to @controller. - %TRUE to stop other handlers from being invoked for the event + %TRUE to stop other handlers from being invoked for the event and the emission of this signal. %FALSE to propagate the event further. - the `GdkEvent` which triggered this signal + the `GdkEvent` which triggered this signal - + + + - `GtkEventControllerMotion` is an event controller tracking the pointer + `GtkEventControllerMotion` is an event controller tracking the pointer position. The event controller offers [signal@Gtk.EventControllerMotion::enter] @@ -30109,44 +31483,48 @@ and [signal@Gtk.EventControllerMotion::leave] signals, as well as [property@Gtk.EventControllerMotion:contains-pointer] properties which are updated to reflect changes in the pointer position as it moves over the widget. + - Creates a new event controller that will handle motion events. + Creates a new event controller that will handle motion events. + - a new `GtkEventControllerMotion` + a new `GtkEventControllerMotion` - Returns if a pointer is within @self or one of its children. + Returns if a pointer is within @self or one of its children. + - %TRUE if a pointer is within @self or one of its children + %TRUE if a pointer is within @self or one of its children - a `GtkEventControllerMotion` + a `GtkEventControllerMotion` - Returns if a pointer is within @self, but not one of its children. + Returns if a pointer is within @self, but not one of its children. + - %TRUE if a pointer is within @self but not one of its children + %TRUE if a pointer is within @self but not one of its children - a `GtkEventControllerMotion` + a `GtkEventControllerMotion` - Whether the pointer is in the controllers widget or a descendant. + Whether the pointer is in the controllers widget or a descendant. See also [property@Gtk.EventControllerMotion:is-pointer]. @@ -30157,7 +31535,7 @@ before [signal@Gtk.EventControllerMotion::enter], but after - Whether the pointer is in the controllers widget itself, + Whether the pointer is in the controllers widget itself, as opposed to in a descendent widget. See also [property@Gtk.EventControllerMotion:contains-pointer]. @@ -30168,47 +31546,49 @@ before [signal@Gtk.EventControllerMotion::enter], but after - Signals that the pointer has entered the widget. + Signals that the pointer has entered the widget. - coordinates of pointer location + coordinates of pointer location - coordinates of pointer location + coordinates of pointer location - Signals that the pointer has left the widget. + Signals that the pointer has left the widget. - Emitted when the pointer moves inside the widget. + Emitted when the pointer moves inside the widget. - the x coordinate + the x coordinate - the y coordinate + the y coordinate - + + + - `GtkEventControllerScroll` is an event controller that handles scroll + `GtkEventControllerScroll` is an event controller that handles scroll events. It is capable of handling both discrete and continuous scroll @@ -30242,46 +31622,50 @@ The %GTK_EVENT_CONTROLLER_SCROLL_KINETIC flag toggles the emission of the [signal@Gtk.EventControllerScroll::decelerate] signal, emitted at the end of scrolling with two X/Y velocity arguments that are consistent with the motion that was received. + - Creates a new event controller that will handle scroll events. + Creates a new event controller that will handle scroll events. + - a new `GtkEventControllerScroll` + a new `GtkEventControllerScroll` - flags affecting the controller behavior + flags affecting the controller behavior - Gets the flags conditioning the scroll controller behavior. + Gets the flags conditioning the scroll controller behavior. + - the controller flags. + the controller flags. - a `GtkEventControllerScroll` + a `GtkEventControllerScroll` - Sets the flags conditioning scroll controller behavior. + Sets the flags conditioning scroll controller behavior. + - a `GtkEventControllerScroll` + a `GtkEventControllerScroll` - flags affecting the controller behavior + flags affecting the controller behavior @@ -30289,11 +31673,11 @@ motion that was received. - The flags affecting event controller behavior. + The flags affecting event controller behavior. - Emitted after scroll is finished if the + Emitted after scroll is finished if the %GTK_EVENT_CONTROLLER_SCROLL_KINETIC flag is set. @vel_x and @vel_y express the initial velocity that was @@ -30304,36 +31688,36 @@ pixels/ms. - X velocity + X velocity - Y velocity + Y velocity - Signals that the widget should scroll by the + Signals that the widget should scroll by the amount specified by @dx and @dy. - %TRUE if the scroll event was handled, + %TRUE if the scroll event was handled, %FALSE otherwise. - X delta + X delta - Y delta + Y delta - Signals that a new scrolling operation has begun. + Signals that a new scrolling operation has begun. It will only be emitted on devices capable of it. @@ -30341,7 +31725,7 @@ It will only be emitted on devices capable of it. - Signals that a scrolling operation has finished. + Signals that a scrolling operation has finished. It will only be emitted on devices capable of it. @@ -30349,63 +31733,69 @@ It will only be emitted on devices capable of it. - + + + - Describes the behavior of a `GtkEventControllerScroll`. + Describes the behavior of a `GtkEventControllerScroll`. - Don't emit scroll. + Don't emit scroll. - Emit scroll with vertical deltas. + Emit scroll with vertical deltas. - Emit scroll with horizontal deltas. + Emit scroll with horizontal deltas. - Only emit deltas that are multiples of 1. + Only emit deltas that are multiples of 1. - Emit ::decelerate after continuous scroll finishes. + Emit ::decelerate after continuous scroll finishes. - Emit scroll on both axes. + Emit scroll on both axes. - Describes the state of a `GdkEventSequence` in a `GtkGesture`. + Describes the state of a `GdkEventSequence` in a `GtkGesture`. - The sequence is handled, but not grabbed. + The sequence is handled, but not grabbed. - The sequence is handled and grabbed. + The sequence is handled and grabbed. - The sequence is denied. + The sequence is denied. - `GtkEveryFilter` matches an item when each of its filters matches. + `GtkEveryFilter` matches an item when each of its filters matches. To add filters to a `GtkEveryFilter`, use [method@Gtk.MultiFilter.append]. + - Creates a new empty "every" filter. + Creates a new empty "every" filter. Use [method@Gtk.MultiFilter.append] to add filters to it. This filter matches an item if each of the filters added to it matches the item. In particular, this means that if no filter has been added to it, the filter matches every item. + - a new `GtkEveryFilter` + a new `GtkEveryFilter` - + + + - `GtkExpander` allows the user to reveal its child by clicking + `GtkExpander` allows the user to reveal its child by clicking on an expander triangle. ![An example GtkExpander](expander.png) @@ -30500,20 +31890,21 @@ expander that is showing its child gets the :checked pseudoclass added to it. - Creates a new expander using @label as the text of the label. + Creates a new expander using @label as the text of the label. + - a new `GtkExpander` widget. + a new `GtkExpander` widget. - the text of the label + the text of the label - Creates a new expander using @label as the text of the label. + Creates a new expander using @label as the text of the label. If characters in @label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, @@ -30521,13 +31912,14 @@ use “__” (two underscores). The first underlined character represe a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button. + - a new `GtkExpander` widget. + a new `GtkExpander` widget. - the text of the label with an underscore + the text of the label with an underscore in front of the mnemonic character @@ -30535,237 +31927,251 @@ Pressing Alt and that key activates the button. - Gets the child widget of @expander. + Gets the child widget of @expander. + - the child widget of @expander + the child widget of @expander - a `GtkExpander` + a `GtkExpander` - Queries a `GtkExpander` and returns its current state. + Queries a `GtkExpander` and returns its current state. Returns %TRUE if the child widget is revealed. + - the current state of the expander + the current state of the expander - a `GtkExpander` + a `GtkExpander` - Fetches the text from a label widget. + Fetches the text from a label widget. This is including any embedded underlines indicating mnemonics and Pango markup, as set by [method@Gtk.Expander.set_label]. If the label text has not been set the return value will be %NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container. + - The text of the label widget. This string is owned + The text of the label widget. This string is owned by the widget and must not be modified or freed. - a `GtkExpander` + a `GtkExpander` - Retrieves the label widget for the frame. + Retrieves the label widget for the frame. + - the label widget + the label widget - a `GtkExpander` + a `GtkExpander` - Returns whether the expander will resize the toplevel widget + Returns whether the expander will resize the toplevel widget containing the expander upon resizing and collpasing. + - the “resize toplevel” setting. + the “resize toplevel” setting. - a `GtkExpander` + a `GtkExpander` - Returns whether the label’s text is interpreted as Pango markup. + Returns whether the label’s text is interpreted as Pango markup. + - %TRUE if the label’s text will be parsed for markup + %TRUE if the label’s text will be parsed for markup - a `GtkExpander` + a `GtkExpander` - Returns whether an underline in the text indicates a mnemonic. + Returns whether an underline in the text indicates a mnemonic. + - %TRUE if an embedded underline in the expander + %TRUE if an embedded underline in the expander label indicates the mnemonic accelerator keys - a `GtkExpander` + a `GtkExpander` - Sets the child widget of @expander. + Sets the child widget of @expander. + - a `GtkExpander` + a `GtkExpander` - the child widget + the child widget - Sets the state of the expander. + Sets the state of the expander. Set to %TRUE, if you want the child widget to be revealed, and %FALSE if you want the child widget to be hidden. + - a `GtkExpander` + a `GtkExpander` - whether the child widget is revealed + whether the child widget is revealed - Sets the text of the label of the expander to @label. + Sets the text of the label of the expander to @label. This will also clear any previously set labels. + - a `GtkExpander` + a `GtkExpander` - a string + a string - Set the label widget for the expander. + Set the label widget for the expander. This is the widget that will appear embedded alongside the expander arrow. + - a `GtkExpander` + a `GtkExpander` - the new label widget + the new label widget - Sets whether the expander will resize the toplevel widget + Sets whether the expander will resize the toplevel widget containing the expander upon resizing and collpasing. + - a `GtkExpander` + a `GtkExpander` - whether to resize the toplevel + whether to resize the toplevel - Sets whether the text of the label contains Pango markup. + Sets whether the text of the label contains Pango markup. + - a `GtkExpander` + a `GtkExpander` - %TRUE if the label’s text should be parsed for markup + %TRUE if the label’s text should be parsed for markup - If true, an underline in the text indicates a mnemonic. + If true, an underline in the text indicates a mnemonic. + - a `GtkExpander` + a `GtkExpander` - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics @@ -30773,55 +32179,55 @@ containing the expander upon resizing and collpasing. - The child widget. + The child widget. - Whether the expander has been opened to reveal the child. + Whether the expander has been opened to reveal the child. - The text of the expanders label. + The text of the expanders label. - A widget to display instead of the usual expander label. + A widget to display instead of the usual expander label. - When this property is %TRUE, the expander will resize the toplevel + When this property is %TRUE, the expander will resize the toplevel widget containing the expander upon expanding and collapsing. - Whether the text in the label is Pango markup. + Whether the text in the label is Pango markup. - Whether an underline in the text indicates a mnemonic. + Whether an underline in the text indicates a mnemonic. - Activates the `GtkExpander`. + Activates the `GtkExpander`. - `GtkExpression` provides a way to describe references to values. + `GtkExpression` provides a way to describe references to values. An important aspect of expressions is that the value can be obtained from a source that is several steps away. For example, an expression @@ -30949,7 +32355,7 @@ contains the expressions for the parameters. For instance: </closure> ``` - Bind `target`'s property named `property` to `self`. + Bind `target`'s property named `property` to `self`. The value that `self` evaluates to is set via `g_object_set()` on `target`. This is repeated whenever `self` changes to ensure that @@ -30961,32 +32367,33 @@ expression. Note that this function takes ownership of `self`. If you want to keep it around, you should [method@Gtk.Expression.ref] it beforehand. + - a `GtkExpressionWatch` + a `GtkExpressionWatch` - a `GtkExpression` + a `GtkExpression` - the target object to bind to + the target object to bind to - name of the property on `target` to bind to + name of the property on `target` to bind to - the this argument for + the this argument for the evaluation of `self` - Evaluates the given expression and on success stores the result + Evaluates the given expression and on success stores the result in @value. The `GType` of `value` will be the type given by @@ -30996,90 +32403,95 @@ It is possible that expressions cannot be evaluated - for example when the expression references objects that have been destroyed or set to `NULL`. In that case `value` will remain empty and `FALSE` will be returned. + - `TRUE` if the expression could be evaluated + `TRUE` if the expression could be evaluated - a `GtkExpression` + a `GtkExpression` - the this argument for the evaluation + the this argument for the evaluation - an empty `GValue` + an empty `GValue` - Gets the `GType` that this expression evaluates to. + Gets the `GType` that this expression evaluates to. This type is constant and will not change over the lifetime of this expression. + - The type returned from [method@Gtk.Expression.evaluate] + The type returned from [method@Gtk.Expression.evaluate] - a `GtkExpression` + a `GtkExpression` - Checks if the expression is static. + Checks if the expression is static. A static expression will never change its result when [method@Gtk.Expression.evaluate] is called on it with the same arguments. That means a call to [method@Gtk.Expression.watch] is not necessary because it will never trigger a notify. + - `TRUE` if the expression is static + `TRUE` if the expression is static - a `GtkExpression` + a `GtkExpression` - Acquires a reference on the given `GtkExpression`. + Acquires a reference on the given `GtkExpression`. + - the `GtkExpression` with an additional reference + the `GtkExpression` with an additional reference - a `GtkExpression` + a `GtkExpression` - Releases a reference on the given `GtkExpression`. + Releases a reference on the given `GtkExpression`. If the reference was the last, the resources associated to the `self` are freed. + - a `GtkExpression` + a `GtkExpression` - Watch the given `expression` for changes. + Watch the given `expression` for changes. The @notify function will be called whenever the evaluation of `self` may have changed. @@ -31087,8 +32499,9 @@ may have changed. GTK cannot guarantee that the evaluation did indeed change when the @notify gets invoked, but it guarantees the opposite: When it did in fact change, the @notify will be invoked. + - The newly installed watch. Note that the only + The newly installed watch. Note that the only reference held to the watch will be released when the watch is unwatched which can happen automatically, and not just via [method@Gtk.ExpressionWatch.unwatch]. You should call [method@Gtk.ExpressionWatch.ref] @@ -31097,228 +32510,253 @@ the @notify will be invoked. - a `GtkExpression` + a `GtkExpression` - the `this` argument to + the `this` argument to watch - callback to invoke when the expression changes + callback to invoke when the expression changes - user data to pass to the `notify` callback + user data to pass to the `notify` callback - destroy notify for `user_data` + destroy notify for `user_data` - Callback called by gtk_expression_watch() when the + Callback called by gtk_expression_watch() when the expression value changes. + - data passed to gtk_expression_watch() + data passed to gtk_expression_watch() - An opaque structure representing a watched `GtkExpression`. + An opaque structure representing a watched `GtkExpression`. The contents of `GtkExpressionWatch` should only be accessed through the provided API. + - Evaluates the watched expression and on success stores the result + Evaluates the watched expression and on success stores the result in `value`. This is equivalent to calling [method@Gtk.Expression.evaluate] with the expression and this pointer originally used to create `watch`. + - `TRUE` if the expression could be evaluated and `value` was set + `TRUE` if the expression could be evaluated and `value` was set - a `GtkExpressionWatch` + a `GtkExpressionWatch` - an empty `GValue` to be set + an empty `GValue` to be set - Acquires a reference on the given `GtkExpressionWatch`. + Acquires a reference on the given `GtkExpressionWatch`. + - the `GtkExpressionWatch` with an additional reference + the `GtkExpressionWatch` with an additional reference - a `GtkExpressionWatch` + a `GtkExpressionWatch` - Releases a reference on the given `GtkExpressionWatch`. + Releases a reference on the given `GtkExpressionWatch`. If the reference was the last, the resources associated to `self` are freed. + - a `GtkExpressionWatch` + a `GtkExpressionWatch` - Stops watching an expression. + Stops watching an expression. See [method@Gtk.Expression.watch] for how the watch was established. + - watch to release + watch to release + + + + + + + + + + + + + + + + + + + - `GtkFileChooser` is an interface that can be implemented by file + `GtkFileChooser` is an interface that can be implemented by file selection widgets. In GTK, the main objects that implement this interface are @@ -31359,7 +32797,7 @@ options. If a choice has no option, it will be rendered as a check button with the given label; if a choice has options, it will be rendered as a combo box. - Adds a 'choice' to the file chooser. + Adds a 'choice' to the file chooser. This is typically implemented as a combobox or, for boolean choices, as a checkbutton. You can select a value using @@ -31367,30 +32805,31 @@ as a checkbutton. You can select a value using and you can obtain the user-selected value in the [signal@Gtk.Dialog::response] signal handler using [method@Gtk.FileChooser.get_choice]. + - a `GtkFileChooser` + a `GtkFileChooser` - id for the added choice + id for the added choice - user-visible label for the added choice + user-visible label for the added choice - ids for the options of the choice, or %NULL for a boolean choice + ids for the options of the choice, or %NULL for a boolean choice - user-visible labels for the options, must be the same length as @options + user-visible labels for the options, must be the same length as @options @@ -31398,111 +32837,118 @@ and you can obtain the user-selected value in the - Adds @filter to the list of filters that the user can select between. + Adds @filter to the list of filters that the user can select between. When a filter is selected, only files that are passed by that filter are displayed. Note that the @chooser takes ownership of the filter if it is floating, so you have to ref and sink it if you want to keep a reference. + - a `GtkFileChooser` + a `GtkFileChooser` - a `GtkFileFilter` + a `GtkFileFilter` - Adds a folder to be displayed with the shortcut folders + Adds a folder to be displayed with the shortcut folders in a file chooser. + - %TRUE if the folder could be added successfully, + %TRUE if the folder could be added successfully, %FALSE otherwise. - a `GtkFileChooser` + a `GtkFileChooser` - a `GFile` for the folder to add + a `GFile` for the folder to add - Gets the type of operation that the file chooser is performing. + Gets the type of operation that the file chooser is performing. + - the action that the file selector is performing + the action that the file selector is performing - a `GtkFileChooser` + a `GtkFileChooser` - Gets the currently selected option in the 'choice' with the given ID. + Gets the currently selected option in the 'choice' with the given ID. + - the ID of the currently selected option + the ID of the currently selected option - a `GtkFileChooser` + a `GtkFileChooser` - the ID of the choice to get + the ID of the choice to get - Gets whether file chooser will offer to create new folders. + Gets whether file chooser will offer to create new folders. + - %TRUE if the Create Folder button should be displayed. + %TRUE if the Create Folder button should be displayed. - a `GtkFileChooser` + a `GtkFileChooser` - Gets the current folder of @chooser as `GFile`. + Gets the current folder of @chooser as `GFile`. + - the `GFile` for the current folder. + the `GFile` for the current folder. - a `GtkFileChooser` + a `GtkFileChooser` - Gets the current name in the file selector, as entered by the user. + Gets the current name in the file selector, as entered by the user. This is meant to be used in save dialogs, to get the currently typed filename when the file itself does not exist yet. + - The raw text from the file chooser’s “Name” entry. Free with + The raw text from the file chooser’s “Name” entry. Free with g_free(). Note that this string is not a full pathname or URI; it is whatever the contents of the entry are. Note also that this string is in UTF-8 encoding, which is not necessarily the system’s encoding for @@ -31511,13 +32957,13 @@ filename when the file itself does not exist yet. - a `GtkFileChooser` + a `GtkFileChooser` - Gets the `GFile` for the currently selected file in + Gets the `GFile` for the currently selected file in the file selector. If multiple files are selected, one of the files will be @@ -31525,237 +32971,250 @@ returned at random. If the file chooser is in folder mode, this function returns the selected folder. + - a selected `GFile`. You own the + a selected `GFile`. You own the returned file; use g_object_unref() to release it. - a `GtkFileChooser` + a `GtkFileChooser` - Lists all the selected files and subfolders in the current folder + Lists all the selected files and subfolders in the current folder of @chooser as `GFile`. + - a list model containing a `GFile` for each + a list model containing a `GFile` for each selected file and subfolder in the current folder. Free the returned list with g_object_unref(). - a `GtkFileChooser` + a `GtkFileChooser` - Gets the current filter. + Gets the current filter. + - the current filter + the current filter - a `GtkFileChooser` + a `GtkFileChooser` - Gets the current set of user-selectable filters, as a list model. + Gets the current set of user-selectable filters, as a list model. See [method@Gtk.FileChooser.add_filter] and [method@Gtk.FileChooser.remove_filter] for changing individual filters. You should not modify the returned list model. Future changes to @chooser may or may not affect the returned model. + - a `GListModel` containing the current set + a `GListModel` containing the current set of user-selectable filters. - a `GtkFileChooser` + a `GtkFileChooser` - Gets whether multiple files can be selected in the file + Gets whether multiple files can be selected in the file chooser. + - %TRUE if multiple files can be selected. + %TRUE if multiple files can be selected. - a `GtkFileChooser` + a `GtkFileChooser` - Queries the list of shortcut folders in the file chooser. + Queries the list of shortcut folders in the file chooser. You should not modify the returned list model. Future changes to @chooser may or may not affect the returned model. + - A list model of `GFile`s + A list model of `GFile`s - a `GtkFileChooser` + a `GtkFileChooser` - Removes a 'choice' that has been added with gtk_file_chooser_add_choice(). + Removes a 'choice' that has been added with gtk_file_chooser_add_choice(). + - a `GtkFileChooser` + a `GtkFileChooser` - the ID of the choice to remove + the ID of the choice to remove - Removes @filter from the list of filters that the user can select between. + Removes @filter from the list of filters that the user can select between. + - a `GtkFileChooser` + a `GtkFileChooser` - a `GtkFileFilter` + a `GtkFileFilter` - Removes a folder from the shortcut folders in a file chooser. + Removes a folder from the shortcut folders in a file chooser. + - %TRUE if the folder could be removed successfully, + %TRUE if the folder could be removed successfully, %FALSE otherwise. - a `GtkFileChooser` + a `GtkFileChooser` - a `GFile` for the folder to remove + a `GFile` for the folder to remove - Sets the type of operation that the chooser is performing. + Sets the type of operation that the chooser is performing. The user interface is adapted to suit the selected action. For example, an option to create a new folder might be shown if the action is %GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is %GTK_FILE_CHOOSER_ACTION_OPEN. + - a `GtkFileChooser` + a `GtkFileChooser` - the action that the file selector is performing + the action that the file selector is performing - Selects an option in a 'choice' that has been added with + Selects an option in a 'choice' that has been added with gtk_file_chooser_add_choice(). For a boolean choice, the possible options are "true" and "false". + - a `GtkFileChooser` + a `GtkFileChooser` - the ID of the choice to set + the ID of the choice to set - the ID of the option to select + the ID of the option to select - Sets whether file chooser will offer to create new folders. + Sets whether file chooser will offer to create new folders. This is only relevant if the action is not set to be %GTK_FILE_CHOOSER_ACTION_OPEN. + - a `GtkFileChooser` + a `GtkFileChooser` - %TRUE if the Create Folder button should be displayed + %TRUE if the Create Folder button should be displayed - Sets the current folder for @chooser from a `GFile`. + Sets the current folder for @chooser from a `GFile`. + - %TRUE if the folder could be changed successfully, %FALSE + %TRUE if the folder could be changed successfully, %FALSE otherwise. - a `GtkFileChooser` + a `GtkFileChooser` - the `GFile` for the new folder + the `GFile` for the new folder - Sets the current name in the file selector, as if entered + Sets the current name in the file selector, as if entered by the user. Note that the name passed in here is a UTF-8 string rather @@ -31768,22 +33227,23 @@ use [method@Gtk.FileChooser.set_file] instead. Please see the documentation for those functions for an example of using [method@Gtk.FileChooser.set_current_name] as well. + - a `GtkFileChooser` + a `GtkFileChooser` - the filename to use, as a UTF-8 string + the filename to use, as a UTF-8 string - Sets @file as the current filename for the file chooser. + Sets @file as the current filename for the file chooser. This includes changing to the file’s parent folder and actually selecting the file in list. If the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, @@ -31825,24 +33285,25 @@ prepare_file_chooser (GtkFileChooser *chooser, } } ``` + - Not useful + Not useful - a `GtkFileChooser` + a `GtkFileChooser` - the `GFile` to set as current + the `GFile` to set as current - Sets the current filter. + Sets the current filter. Only the files that pass the filter will be displayed. If the user-selectable list of filters is non-empty, then @@ -31851,37 +33312,39 @@ the filter should be one of the filters in that list. Setting the current filter when the list of filters is empty is useful if you want to restrict the displayed set of files without letting the user change it. + - a `GtkFileChooser` + a `GtkFileChooser` - a `GtkFileFilter` + a `GtkFileFilter` - Sets whether multiple files can be selected in the file chooser. + Sets whether multiple files can be selected in the file chooser. This is only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER. + - a `GtkFileChooser` + a `GtkFileChooser` - %TRUE if multiple files can be selected. + %TRUE if multiple files can be selected. @@ -31889,25 +33352,25 @@ This is only relevant if the action is set to be - The type of operation that the file chooser is performing. + The type of operation that the file chooser is performing. - Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode + Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders. - The current filter for selecting files that are displayed. + The current filter for selecting files that are displayed. - A `GListModel` containing the filters that have been + A `GListModel` containing the filters that have been added with gtk_file_chooser_add_filter(). The returned object should not be modified. It may @@ -31917,12 +33380,12 @@ or may not be updated for later changes. - Whether to allow multiple files to be selected. + Whether to allow multiple files to be selected. - A `GListModel` containing the shortcut folders that have been + A `GListModel` containing the shortcut folders that have been added with gtk_file_chooser_add_shortcut_folder(). The returned object should not be modified. It may @@ -31931,25 +33394,25 @@ or may not be updated for later changes. - Describes whether a `GtkFileChooser` is being used to open existing files + Describes whether a `GtkFileChooser` is being used to open existing files or to save to a possibly new file. - Indicates open mode. The file chooser + Indicates open mode. The file chooser will only let the user pick an existing file. - Indicates save mode. The file chooser + Indicates save mode. The file chooser will let the user pick an existing file, or type in a new filename. - Indicates an Open mode for + Indicates an Open mode for selecting folders. The file chooser will let the user pick an existing folder. - `GtkFileChooserDialog` is a dialog suitable for use with + `GtkFileChooserDialog` is a dialog suitable for use with “File Open” or “File Save” commands. ![An example GtkFileChooserDialog](filechooser.png) @@ -32124,64 +33587,65 @@ when you use `GtkFileChooserDialog` to ensure proper operation. - Creates a new `GtkFileChooserDialog`. + Creates a new `GtkFileChooserDialog`. This function is analogous to [ctor@Gtk.Dialog.new_with_buttons]. + - a new `GtkFileChooserDialog` + a new `GtkFileChooserDialog` - Title of the dialog + Title of the dialog - Transient parent of the dialog + Transient parent of the dialog - Open or save mode for the dialog + Open or save mode for the dialog - text to go in the first button + text to go in the first button - response ID for the first button, then additional (button, id) pairs, ending with %NULL + response ID for the first button, then additional (button, id) pairs, ending with %NULL - These identify the various errors that can occur while calling + These identify the various errors that can occur while calling `GtkFileChooser` functions. - Indicates that a file does not exist. + Indicates that a file does not exist. - Indicates a malformed filename. + Indicates a malformed filename. - Indicates a duplicate path (e.g. when + Indicates a duplicate path (e.g. when adding a bookmark). - Indicates an incomplete hostname + Indicates an incomplete hostname (e.g. "http://foo" without a slash after that). - Registers an error quark for `GtkFileChooser` errors. + Registers an error quark for `GtkFileChooser` errors. - The error quark used for `GtkFileChooser` errors. + The error quark used for `GtkFileChooser` errors. - `GtkFileChooserNative` is an abstraction of a dialog suitable + `GtkFileChooserNative` is an abstraction of a dialog suitable for use with “File Open” or “File Save as” commands. By default, this just uses a `GtkFileChooserDialog` to implement @@ -32327,67 +33791,71 @@ native file chooser dialogs. Some features provided by `GtkFileChooser` are not supported: * Shortcut folders. + - Creates a new `GtkFileChooserNative`. + Creates a new `GtkFileChooserNative`. + - a new `GtkFileChooserNative` + a new `GtkFileChooserNative` - Title of the native + Title of the native - Transient parent of the native + Transient parent of the native - Open or save mode for the dialog + Open or save mode for the dialog - text to go in the accept button, or %NULL for the default + text to go in the accept button, or %NULL for the default - text to go in the cancel button, or %NULL for the default + text to go in the cancel button, or %NULL for the default - Retrieves the custom label text for the accept button. + Retrieves the custom label text for the accept button. + - The custom label + The custom label - a `GtkFileChooserNative` + a `GtkFileChooserNative` - Retrieves the custom label text for the cancel button. + Retrieves the custom label text for the cancel button. + - The custom label + The custom label - a `GtkFileChooserNative` + a `GtkFileChooserNative` - Sets the custom label text for the accept button. + Sets the custom label text for the accept button. If characters in @label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, @@ -32395,23 +33863,24 @@ use “__” (two underscores). The first underlined character represe a keyboard accelerator called a mnemonic. Pressing Alt and that key should activate the button. + - a `GtkFileChooserNative` + a `GtkFileChooserNative` - custom label + custom label - Sets the custom label text for the cancel button. + Sets the custom label text for the cancel button. If characters in @label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, @@ -32419,16 +33888,17 @@ use “__” (two underscores). The first underlined character represe a keyboard accelerator called a mnemonic. Pressing Alt and that key should activate the button. + - a `GtkFileChooserNative` + a `GtkFileChooserNative` - custom label + custom label @@ -32436,25 +33906,26 @@ Pressing Alt and that key should activate the button. - The text used for the label on the accept button in the dialog, or + The text used for the label on the accept button in the dialog, or %NULL to use the default text. - The text used for the label on the cancel button in the dialog, or + The text used for the label on the cancel button in the dialog, or %NULL to use the default text. + - `GtkFileChooserWidget` is a widget for choosing files. + `GtkFileChooserWidget` is a widget for choosing files. It exposes the [iface@Gtk.FileChooser] interface, and you should use the methods of this interface to interact with the @@ -32468,18 +33939,19 @@ widget. - Creates a new `GtkFileChooserWidget`. + Creates a new `GtkFileChooserWidget`. This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by `GtkFileChooserDialog`. + - a new `GtkFileChooserWidget` + a new `GtkFileChooserWidget` - Open or save mode for the widget + Open or save mode for the widget @@ -32491,7 +33963,7 @@ windows, and it is the same widget that is used by - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32504,7 +33976,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>D&l - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32521,7 +33993,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>Dow - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32534,7 +34006,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>Hom - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32552,13 +34024,13 @@ access to home directories. - a string that gets put in the text entry for the file name + a string that gets put in the text entry for the file name - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32571,7 +34043,7 @@ The default binding for this signal is <kbd>Control</kbd>-<kbd> - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32585,7 +34057,7 @@ The default binding for this signal is <kbd>Control</kbd>-<kbd> - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32597,7 +34069,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>P&l - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32616,13 +34088,13 @@ successively. - the number of the bookmark to switch to + the number of the bookmark to switch to - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32634,7 +34106,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>R&l - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32646,7 +34118,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>S&l - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32658,7 +34130,7 @@ The default binding for this signal is <kbd>Control</kbd>-<kbd> - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -32672,7 +34144,7 @@ The default binding for this signal is <kbd>Alt</kbd>-<kbd>Up& - `GtkFileFilter` filters files by name or mime type. + `GtkFileFilter` filters files by name or mime type. `GtkFileFilter` can be used to restrict the files being shown in a `GtkFileChooser`. Files can be filtered based on their name (with @@ -32720,7 +34192,7 @@ rules: ``` - Creates a new `GtkFileFilter` with no rules added to it. + Creates a new `GtkFileFilter` with no rules added to it. Such a filter doesn’t accept any files, so is not particularly useful until you add rules with @@ -32734,167 +34206,177 @@ To create a filter that accepts any file, use: GtkFileFilter *filter = gtk_file_filter_new (); gtk_file_filter_add_pattern (filter, "*"); ``` + - a new `GtkFileFilter` + a new `GtkFileFilter` - Deserialize a file filter from a `GVariant`. + Deserialize a file filter from a `GVariant`. The variant must be in the format produced by [method@Gtk.FileFilter.to_gvariant]. + - a new `GtkFileFilter` object + a new `GtkFileFilter` object - an `a{sv}` `GVariant` + an `a{sv}` `GVariant` - Adds a rule allowing a given mime type to @filter. + Adds a rule allowing a given mime type to @filter. + - A `GtkFileFilter` + A `GtkFileFilter` - name of a MIME type + name of a MIME type - Adds a rule allowing a shell style glob to a filter. + Adds a rule allowing a shell style glob to a filter. Note that it depends on the platform whether pattern matching ignores case or not. On Windows, it does, on other platforms, it doesn't. + - a `GtkFileFilter` + a `GtkFileFilter` - a shell style glob + a shell style glob - Adds a rule allowing image files in the formats supported + Adds a rule allowing image files in the formats supported by GdkPixbuf. This is equivalent to calling [method@Gtk.FileFilter.add_mime_type] for all the supported mime types. + - a `GtkFileFilter` + a `GtkFileFilter` - Adds a suffix match rule to a filter. + Adds a suffix match rule to a filter. This is similar to adding a match for the pattern "*.@suffix". In contrast to pattern matches, suffix matches are *always* case-insensitive. + - a `GtkFileFilter` + a `GtkFileFilter` - filename suffix to match + filename suffix to match - Gets the attributes that need to be filled in for the `GFileInfo` + Gets the attributes that need to be filled in for the `GFileInfo` passed to this filter. This function will not typically be used by applications; it is intended principally for use in the implementation of `GtkFileChooser`. + - the attributes + the attributes - a `GtkFileFilter` + a `GtkFileFilter` - Gets the human-readable name for the filter. + Gets the human-readable name for the filter. See [method@Gtk.FileFilter.set_name]. + - The human-readable name of the filter + The human-readable name of the filter - a `GtkFileFilter` + a `GtkFileFilter` - Sets a human-readable name of the filter. + Sets a human-readable name of the filter. This is the string that will be displayed in the file chooser if there is a selectable list of filters. + - a `GtkFileFilter` + a `GtkFileFilter` - the human-readable-name for the filter, or %NULL + the human-readable-name for the filter, or %NULL to remove any existing name. - Serialize a file filter to an `a{sv}` variant. + Serialize a file filter to an `a{sv}` variant. + - a new, floating, `GVariant` + a new, floating, `GVariant` - a `GtkFileFilter` + a `GtkFileFilter` @@ -32902,7 +34384,7 @@ if there is a selectable list of filters. - The human-readable name of the filter. + The human-readable name of the filter. This is the string that will be displayed in the file chooser user interface if there is a selectable list of filters. @@ -32910,7 +34392,7 @@ user interface if there is a selectable list of filters. - A `GtkFilter` object describes the filtering to be performed by a + A `GtkFilter` object describes the filtering to be performed by a `GtkFilterListModel`. The model will use the filter to determine if it should include items @@ -32928,8 +34410,9 @@ various widgets to easily allow searches. However, in particular for large lists or complex search methods, it is also possible to subclass `GtkFilter` and provide one's own filter. + - Gets the known strictness of @filters. + Gets the known strictness of @filters. If the strictness is not known, %GTK_FILTER_MATCH_SOME is returned. @@ -32938,37 +34421,39 @@ signal. This function is meant purely for optimization purposes, filters can choose to omit implementing it, but `GtkFilterListModel` uses it. + - the strictness of @self + the strictness of @self - a `GtkFilter` + a `GtkFilter` - Checks if the given @item is matched by the filter or not. + Checks if the given @item is matched by the filter or not. + - %TRUE if the filter matches the item and a filter model should + %TRUE if the filter matches the item and a filter model should keep it, %FALSE if not. - a `GtkFilter` + a `GtkFilter` - The item to check + The item to check - Notifies all users of the filter that it has changed. + Notifies all users of the filter that it has changed. This emits the [signal@Gtk.Filter::changed] signal. Users of the filter should then check items again via @@ -32980,22 +34465,23 @@ documentation for details. This function is intended for implementors of `GtkFilter` subclasses and should not be called from other functions. + - a `GtkFilter` + a `GtkFilter` - How the filter changed + How the filter changed - Gets the known strictness of @filters. + Gets the known strictness of @filters. If the strictness is not known, %GTK_FILTER_MATCH_SOME is returned. @@ -33004,31 +34490,33 @@ signal. This function is meant purely for optimization purposes, filters can choose to omit implementing it, but `GtkFilterListModel` uses it. + - the strictness of @self + the strictness of @self - a `GtkFilter` + a `GtkFilter` - Checks if the given @item is matched by the filter or not. + Checks if the given @item is matched by the filter or not. + - %TRUE if the filter matches the item and a filter model should + %TRUE if the filter matches the item and a filter model should keep it, %FALSE if not. - a `GtkFilter` + a `GtkFilter` - The item to check + The item to check @@ -33037,7 +34525,7 @@ choose to omit implementing it, but `GtkFilterListModel` uses it. - Emitted whenever the filter changed. + Emitted whenever the filter changed. Users of the filter should then check items again via [method@Gtk.Filter.match]. @@ -33052,52 +34540,54 @@ documentation for details. - how the filter changed + how the filter changed - Describes changes in a filter in more detail and allows objects + Describes changes in a filter in more detail and allows objects using the filter to optimize refiltering items. If you are writing an implementation and are not sure which value to pass, %GTK_FILTER_CHANGE_DIFFERENT is always a correct choice. - The filter change cannot be + The filter change cannot be described with any of the other enumeration values. - The filter is less strict than + The filter is less strict than it was before: All items that it used to return %TRUE for still return %TRUE, others now may, too. - The filter is more strict than + The filter is more strict than it was before: All items that it used to return %FALSE for still return %FALSE, others now may, too. + + - %TRUE if the filter matches the item and a filter model should + %TRUE if the filter matches the item and a filter model should keep it, %FALSE if not. - a `GtkFilter` + a `GtkFilter` - The item to check + The item to check @@ -33105,13 +34595,14 @@ choice. + - the strictness of @self + the strictness of @self - a `GtkFilter` + a `GtkFilter` @@ -33119,6 +34610,7 @@ choice. + @@ -33126,6 +34618,7 @@ choice. + @@ -33133,6 +34626,7 @@ choice. + @@ -33140,6 +34634,7 @@ choice. + @@ -33147,6 +34642,7 @@ choice. + @@ -33154,6 +34650,7 @@ choice. + @@ -33161,6 +34658,7 @@ choice. + @@ -33168,6 +34666,7 @@ choice. + @@ -33175,7 +34674,7 @@ choice. - `GtkFilterListModel` is a list model that filters the elements of + `GtkFilterListModel` is a list model that filters the elements of the underlying model according to a `GtkFilter`. It hides some elements from the other model according to @@ -33184,72 +34683,77 @@ criteria given by a `GtkFilter`. The model can be set up to do incremental searching, so that filtering long lists doesn't block the UI. See [method@Gtk.FilterListModel.set_incremental] for details. + - Creates a new `GtkFilterListModel` that will filter @model using the given + Creates a new `GtkFilterListModel` that will filter @model using the given @filter. + - a new `GtkFilterListModel` + a new `GtkFilterListModel` - the model to sort + the model to sort - filter + filter - Gets the `GtkFilter` currently set on @self. + Gets the `GtkFilter` currently set on @self. + - The filter currently in use + The filter currently in use - a `GtkFilterListModel` + a `GtkFilterListModel` - Returns whether incremental filtering is enabled. + Returns whether incremental filtering is enabled. See [method@Gtk.FilterListModel.set_incremental]. + - %TRUE if incremental filtering is enabled + %TRUE if incremental filtering is enabled - a `GtkFilterListModel` + a `GtkFilterListModel` - Gets the model currently filtered or %NULL if none. + Gets the model currently filtered or %NULL if none. + - The model that gets filtered + The model that gets filtered - a `GtkFilterListModel` + a `GtkFilterListModel` - Returns the number of items that have not been filtered yet. + Returns the number of items that have not been filtered yet. You can use this value to check if @self is busy filtering by comparing the return value to 0 or you can compute the percentage @@ -33265,37 +34769,39 @@ percentage = pending / (double) g_list_model_get_n_items (model); If no filter operation is ongoing - in particular when [property@Gtk.FilterListModel:incremental] is %FALSE - this function returns 0. + - The number of items not yet filtered + The number of items not yet filtered - a `GtkFilterListModel` + a `GtkFilterListModel` - Sets the filter used to filter items. + Sets the filter used to filter items. + - a `GtkFilterListModel` + a `GtkFilterListModel` - filter to use + filter to use - Sets the filter model to do an incremental sort. + Sets the filter model to do an incremental sort. When incremental filtering is enabled, the `GtkFilterListModel` will not run filters immediately, but will instead queue an idle handler that @@ -33311,38 +34817,40 @@ By default, incremental filtering is disabled. See [method@Gtk.FilterListModel.get_pending] for progress information about an ongoing incremental filtering operation. + - a `GtkFilterListModel` + a `GtkFilterListModel` - %TRUE to enable incremental filtering + %TRUE to enable incremental filtering - Sets the model to be filtered. + Sets the model to be filtered. Note that GTK makes no effort to ensure that @model conforms to the item type of @self. It assumes that the caller knows what they are doing and have set up an appropriate filter to ensure that item types match. + - a `GtkFilterListModel` + a `GtkFilterListModel` - The model to be filtered + The model to be filtered @@ -33350,53 +34858,54 @@ types match. - The filter for this model. + The filter for this model. - If the model should filter items incrementally. + If the model should filter items incrementally. - The model being filtered. + The model being filtered. - Number of items not yet filtered. + Number of items not yet filtered. + - Describes the known strictness of a filter. + Describes the known strictness of a filter. Note that for filters where the strictness is not known, %GTK_FILTER_MATCH_SOME is always an acceptable value, even if a filter does match all or no items. - The filter matches some items, + The filter matches some items, gtk_filter_match() may return %TRUE or %FALSE - The filter does not match any item, + The filter does not match any item, gtk_filter_match() will always return %FALSE. - The filter matches all items, + The filter matches all items, gtk_filter_match() will alays return %TRUE. - `GtkFixed` places its child widgets at fixed positions and with fixed sizes. + `GtkFixed` places its child widgets at fixed positions and with fixed sizes. `GtkFixed` performs no automatic layout management. @@ -33433,146 +34942,154 @@ is a long-term maintenance problem for your application. If you know none of these things are an issue for your application, and prefer the simplicity of `GtkFixed`, by all means use the widget. But you should be aware of the tradeoffs. + - Creates a new `GtkFixed`. + Creates a new `GtkFixed`. + - a new `GtkFixed`. + a new `GtkFixed`. - Retrieves the translation transformation of the + Retrieves the translation transformation of the given child `GtkWidget` in the `GtkFixed`. See also: [method@Gtk.Fixed.get_child_transform]. + - a `GtkFixed` + a `GtkFixed` - a child of @fixed + a child of @fixed - the horizontal position of the @widget + the horizontal position of the @widget - the vertical position of the @widget + the vertical position of the @widget - Retrieves the transformation for @widget set using + Retrieves the transformation for @widget set using gtk_fixed_set_child_transform(). + - a `GskTransform` + a `GskTransform` - a `GtkFixed` + a `GtkFixed` - a `GtkWidget`, child of @fixed + a `GtkWidget`, child of @fixed - Sets a translation transformation to the given @x and @y + Sets a translation transformation to the given @x and @y coordinates to the child @widget of the `GtkFixed`. + - a `GtkFixed` + a `GtkFixed` - the child widget + the child widget - the horizontal position to move the widget to + the horizontal position to move the widget to - the vertical position to move the widget to + the vertical position to move the widget to - Adds a widget to a `GtkFixed` at the given position. + Adds a widget to a `GtkFixed` at the given position. + - a `GtkFixed` + a `GtkFixed` - the widget to add + the widget to add - the horizontal position to place the widget at + the horizontal position to place the widget at - the vertical position to place the widget at + the vertical position to place the widget at - Removes a child from @fixed. + Removes a child from @fixed. + - a `GtkFixed` + a `GtkFixed` - the child widget to remove + the child widget to remove - Sets the transformation for @widget. + Sets the transformation for @widget. This is a convenience function that retrieves the [class@Gtk.FixedLayoutChild] instance associated to @widget and calls [method@Gtk.FixedLayoutChild.set_transform]. + - a `GtkFixed` + a `GtkFixed` - a `GtkWidget`, child of @fixed + a `GtkWidget`, child of @fixed - the transformation assigned to @widget + the transformation assigned to @widget to reset @widget's transform @@ -33583,6 +35100,7 @@ This is a convenience function that retrieves the + @@ -33593,7 +35111,7 @@ This is a convenience function that retrieves the - `GtkFixedLayout` is a layout manager which can place child widgets + `GtkFixedLayout` is a layout manager which can place child widgets at fixed positions. Most applications should never use this layout manager; fixed positioning @@ -33624,42 +35142,47 @@ to the right of the thing they label when using an RTL language; Finally, fixed positioning makes it kind of annoying to add/remove UI elements, since you have to reposition all the other elements. This is a long-term maintenance problem for your application. + - Creates a new `GtkFixedLayout`. + Creates a new `GtkFixedLayout`. + - the newly created `GtkFixedLayout` + the newly created `GtkFixedLayout` - `GtkLayoutChild` subclass for children in a `GtkFixedLayout`. + `GtkLayoutChild` subclass for children in a `GtkFixedLayout`. + - Retrieves the transformation of the child. + Retrieves the transformation of the child. + - a `GskTransform` + a `GskTransform` - a `GtkFixedLayoutChild` + a `GtkFixedLayoutChild` - Sets the transformation of the child of a `GtkFixedLayout`. + Sets the transformation of the child of a `GtkFixedLayout`. + - a `GtkFixedLayoutChild` + a `GtkFixedLayoutChild` - a `GskTransform` + a `GskTransform` @@ -33667,83 +35190,90 @@ long-term maintenance problem for your application. - The transform of the child. + The transform of the child. + + - `GtkFlattenListModel` is a list model that concatenates other list models. + `GtkFlattenListModel` is a list model that concatenates other list models. `GtkFlattenListModel` takes a list model containing list models, and flattens it into a single model. + - Creates a new `GtkFlattenListModel` that flattens @list. + Creates a new `GtkFlattenListModel` that flattens @list. + - a new `GtkFlattenListModel` + a new `GtkFlattenListModel` - the model to be flattened + the model to be flattened - Gets the model set via gtk_flatten_list_model_set_model(). + Gets the model set via gtk_flatten_list_model_set_model(). + - The model flattened by @self + The model flattened by @self - a `GtkFlattenListModel` + a `GtkFlattenListModel` - Returns the model containing the item at the given position. + Returns the model containing the item at the given position. + - the model containing the item at @position + the model containing the item at @position - a `GtkFlattenListModel` + a `GtkFlattenListModel` - a position + a position - Sets a new model to be flattened. + Sets a new model to be flattened. + - a `GtkFlattenListModel` + a `GtkFlattenListModel` - the new model + the new model @@ -33751,17 +35281,18 @@ long-term maintenance problem for your application. - The model being flattened. + The model being flattened. + - A `GtkFlowBox` puts child widgets in reflowing grid. + A `GtkFlowBox` puts child widgets in reflowing grid. For instance, with the horizontal orientation, the widgets will be arranged from left to right, starting a new row under the previous @@ -33812,14 +35343,15 @@ uses the %GTK_ACCESSIBLE_ROLE_GRID_CELL role. - Creates a `GtkFlowBox`. + Creates a `GtkFlowBox`. + - a new `GtkFlowBox` + a new `GtkFlowBox` - Binds @model to @box. + Binds @model to @box. If @box was already bound to a model, that previous binding is destroyed. @@ -33834,165 +35366,175 @@ It is undefined to add or remove widgets directly (for example, with Note that using a model is incompatible with the filtering and sorting functionality in `GtkFlowBox`. When using a model, filtering and sorting should be implemented by the model. + - a `GtkFlowBox` + a `GtkFlowBox` - the `GListModel` to be bound to @box + the `GListModel` to be bound to @box - a function that creates widgets for items + a function that creates widgets for items - user data passed to @create_widget_func + user data passed to @create_widget_func - function for freeing @user_data + function for freeing @user_data - Returns whether children activate on single clicks. + Returns whether children activate on single clicks. + - %TRUE if children are activated on single click, + %TRUE if children are activated on single click, %FALSE otherwise - a `GtkFlowBox` + a `GtkFlowBox` - Gets the nth child in the @box. + Gets the nth child in the @box. + - the child widget, which will + the child widget, which will always be a `GtkFlowBoxChild` or %NULL in case no child widget with the given index exists. - a `GtkFlowBox` + a `GtkFlowBox` - the position of the child + the position of the child - Gets the child in the (@x, @y) position. + Gets the child in the (@x, @y) position. Both @x and @y are assumed to be relative to the origin of @box. + - the child widget, which will + the child widget, which will always be a `GtkFlowBoxChild` or %NULL in case no child widget exists for the given x and y coordinates. - a `GtkFlowBox` + a `GtkFlowBox` - the x coordinate of the child + the x coordinate of the child - the y coordinate of the child + the y coordinate of the child - Gets the horizontal spacing. + Gets the horizontal spacing. + - the horizontal spacing + the horizontal spacing - a `GtkFlowBox` + a `GtkFlowBox` - Returns whether the box is homogeneous. + Returns whether the box is homogeneous. + - %TRUE if the box is homogeneous. + %TRUE if the box is homogeneous. - a `GtkFlowBox` + a `GtkFlowBox` - Gets the maximum number of children per line. + Gets the maximum number of children per line. + - the maximum number of children per line + the maximum number of children per line - a `GtkFlowBox` + a `GtkFlowBox` - Gets the minimum number of children per line. + Gets the minimum number of children per line. + - the minimum number of children per line + the minimum number of children per line - a `GtkFlowBox` + a `GtkFlowBox` - Gets the vertical spacing. + Gets the vertical spacing. + - the vertical spacing + the vertical spacing - a `GtkFlowBox` + a `GtkFlowBox` - Creates a list of all selected children. + Creates a list of all selected children. + - + A `GList` containing the `GtkWidget` for each selected child. Free with g_list_free() when done. @@ -34001,190 +35543,200 @@ Both @x and @y are assumed to be relative to the origin of @box. - a `GtkFlowBox` + a `GtkFlowBox` - Gets the selection mode of @box. + Gets the selection mode of @box. + - the `GtkSelectionMode` + the `GtkSelectionMode` - a `GtkFlowBox` + a `GtkFlowBox` - Inserts the @widget into @box at @position. + Inserts the @widget into @box at @position. If a sort function is set, the widget will actually be inserted at the calculated position. If @position is -1, or larger than the total number of children in the @box, then the @widget will be appended to the end. + - a `GtkFlowBox` + a `GtkFlowBox` - the `GtkWidget` to add + the `GtkWidget` to add - the position to insert @child in + the position to insert @child in - Updates the filtering for all children. + Updates the filtering for all children. Call this function when the result of the filter function on the @box is changed due ot an external factor. For instance, this would be used if the filter function just looked for a specific search term, and the entry with the string has changed. + - a `GtkFlowBox` + a `GtkFlowBox` - Updates the sorting for all children. + Updates the sorting for all children. Call this when the result of the sort function on @box is changed due to an external factor. + - a `GtkFlowBox` + a `GtkFlowBox` - Removes a child from @box. + Removes a child from @box. + - a `GtkFlowBox` + a `GtkFlowBox` - the child widget to remove + the child widget to remove - Select all children of @box, if the selection + Select all children of @box, if the selection mode allows it. + - a `GtkFlowBox` + a `GtkFlowBox` - Selects a single child of @box, if the selection + Selects a single child of @box, if the selection mode allows it. + - a `GtkFlowBox` + a `GtkFlowBox` - a child of @box + a child of @box - Calls a function for each selected child. + Calls a function for each selected child. Note that the selection cannot be modified from within this function. + - a `GtkFlowBox` + a `GtkFlowBox` - the function to call for each selected child + the function to call for each selected child - user data to pass to the function + user data to pass to the function - If @single is %TRUE, children will be activated when you click + If @single is %TRUE, children will be activated when you click on them, otherwise you need to double-click. + - a `GtkFlowBox` + a `GtkFlowBox` - %TRUE to emit child-activated on a single click + %TRUE to emit child-activated on a single click - Sets the horizontal space to add between children. + Sets the horizontal space to add between children. + - a `GtkFlowBox` + a `GtkFlowBox` - the spacing to use + the spacing to use - By setting a filter function on the @box one can decide dynamically + By setting a filter function on the @box one can decide dynamically which of the children to show. For instance, to implement a search function that only shows the @@ -34197,31 +35749,32 @@ it will continue to be called each time a child changes (via Note that using a filter function is incompatible with using a model (see [method@Gtk.FlowBox.bind_model]). + - a `GtkFlowBox` + a `GtkFlowBox` - callback that + callback that lets you filter which children to show - user data passed to @filter_func + user data passed to @filter_func - destroy notifier for @user_data + destroy notifier for @user_data - Hooks up an adjustment to focus handling in @box. + Hooks up an adjustment to focus handling in @box. The adjustment is also used for autoscrolling during rubberband selection. See [method@Gtk.ScrolledWindow.get_hadjustment] @@ -34232,16 +35785,17 @@ adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box. + - a `GtkFlowBox` + a `GtkFlowBox` - an adjustment which should be adjusted + an adjustment which should be adjusted when the focus is moved among the descendents of @container @@ -34249,18 +35803,19 @@ of the box. - Sets whether or not all children of @box are given + Sets whether or not all children of @box are given equal space in the box. + - a `GtkFlowBox` + a `GtkFlowBox` - %TRUE to create equal allotments, + %TRUE to create equal allotments, %FALSE for variable allotments @@ -34268,80 +35823,84 @@ equal space in the box. - Sets the maximum number of children to request and + Sets the maximum number of children to request and allocate space for in @box’s orientation. Setting the maximum number of children per line limits the overall natural size request to be no more than @n_children children long in the given orientation. + - a `GtkFlowBox` + a `GtkFlowBox` - the maximum number of children per line + the maximum number of children per line - Sets the minimum number of children to line up + Sets the minimum number of children to line up in @box’s orientation before flowing. + - a `GtkFlowBox` + a `GtkFlowBox` - the minimum number of children per line + the minimum number of children per line - Sets the vertical space to add between children. + Sets the vertical space to add between children. + - a `GtkFlowBox` + a `GtkFlowBox` - the spacing to use + the spacing to use - Sets how selection works in @box. + Sets how selection works in @box. + - a `GtkFlowBox` + a `GtkFlowBox` - the new selection mode + the new selection mode - By setting a sort function on the @box, one can dynamically + By setting a sort function on the @box, one can dynamically reorder the children of the box, based on the contents of the children. @@ -34352,30 +35911,31 @@ and will continue to be called each time a child changes (via Note that using a sort function is incompatible with using a model (see [method@Gtk.FlowBox.bind_model]). + - a `GtkFlowBox` + a `GtkFlowBox` - the sort function + the sort function - user data passed to @sort_func + user data passed to @sort_func - destroy notifier for @user_data + destroy notifier for @user_data - Hooks up an adjustment to focus handling in @box. + Hooks up an adjustment to focus handling in @box. The adjustment is also used for autoscrolling during rubberband selection. See [method@Gtk.ScrolledWindow.get_vadjustment] @@ -34386,47 +35946,50 @@ adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box. + - a `GtkFlowBox` + a `GtkFlowBox` - an adjustment which should be adjusted + an adjustment which should be adjusted when the focus is moved among the descendents of @container - Unselect all children of @box, if the selection + Unselect all children of @box, if the selection mode allows it. + - a `GtkFlowBox` + a `GtkFlowBox` - Unselects a single child of @box, if the selection + Unselects a single child of @box, if the selection mode allows it. + - a `GtkFlowBox` + a `GtkFlowBox` - a child of @box + a child of @box @@ -34437,34 +36000,34 @@ mode allows it. - Determines whether children can be activated with a single + Determines whether children can be activated with a single click, or require a double-click. - The amount of horizontal space between two children. + The amount of horizontal space between two children. - Determines whether all children should be allocated the + Determines whether all children should be allocated the same size. - The maximum amount of children to request space for consecutively + The maximum amount of children to request space for consecutively in the given orientation. - The minimum number of children to allocate consecutively + The minimum number of children to allocate consecutively in the given orientation. Setting the minimum children per line ensures @@ -34475,17 +36038,17 @@ for the overall minimum width of the box. - The amount of vertical space between two children. + The amount of vertical space between two children. - The selection mode used by the flow box. + The selection mode used by the flow box. - Emitted when the user activates the @box. + Emitted when the user activates the @box. This is a [keybinding signal](class.SignalAction.html). @@ -34493,19 +36056,19 @@ This is a [keybinding signal](class.SignalAction.html). - Emitted when a child has been activated by the user. + Emitted when a child has been activated by the user. - the child that is activated + the child that is activated - Emitted when the user initiates a cursor movement. + Emitted when the user initiates a cursor movement. This is a [keybinding signal](class.SignalAction.html). Applications should not connect to it, but may emit it with @@ -34522,31 +36085,31 @@ There are too many key combinations to list them all here. - <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the box - <kbd>PgUp</kbd>, <kbd>PgDn</kbd> move vertically by pages - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the granularity fo the move, as a `GtkMovementStep` + the granularity fo the move, as a `GtkMovementStep` - the number of @step units to move + the number of @step units to move - whether to extend the selection + whether to extend the selection - whether to modify the selection + whether to modify the selection - Emitted to select all children of the box, + Emitted to select all children of the box, if the selection mode permits it. This is a [keybinding signal](class.SignalAction.html). @@ -34557,7 +36120,7 @@ The default bindings for this signal is <kbd>Ctrl</kbd>-<kbd>a - Emitted when the set of selected children changes. + Emitted when the set of selected children changes. Use [method@Gtk.FlowBox.selected_foreach] or [method@Gtk.FlowBox.get_selected_children] to obtain the @@ -34567,7 +36130,7 @@ selected children. - Emitted to toggle the selection of the child that has the focus. + Emitted to toggle the selection of the child that has the focus. This is a [keybinding signal](class.SignalAction.html). @@ -34577,7 +36140,7 @@ The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>Sp - Emitted to unselect all children of the box, + Emitted to unselect all children of the box, if the selection mode permits it. This is a [keybinding signal](class.SignalAction.html). @@ -34589,20 +36152,23 @@ The default bindings for this signal is <kbd>Ctrl</kbd>-<kbd>S - `GtkFlowBoxChild` is the kind of widget that can be added to a `GtkFlowBox`. + `GtkFlowBoxChild` is the kind of widget that can be added to a `GtkFlowBox`. + - Creates a new `GtkFlowBoxChild`. + Creates a new `GtkFlowBoxChild`. This should only be used as a child of a `GtkFlowBox`. + - a new `GtkFlowBoxChild` + a new `GtkFlowBoxChild` + @@ -34613,7 +36179,7 @@ This should only be used as a child of a `GtkFlowBox`. - Marks @child as changed, causing any state that depends on this + Marks @child as changed, causing any state that depends on this to be updated. This affects sorting and filtering. @@ -34632,71 +36198,76 @@ and filtering functions into the widgets themselves. Another alternative is to call [method@Gtk.FlowBox.invalidate_sort] on any model change, but that is more expensive. + - a `GtkFlowBoxChild` + a `GtkFlowBoxChild` - Gets the child widget of @self. + Gets the child widget of @self. + - the child widget of @self + the child widget of @self - a `GtkFlowBoxChild` + a `GtkFlowBoxChild` - Gets the current index of the @child in its `GtkFlowBox` container. + Gets the current index of the @child in its `GtkFlowBox` container. + - the index of the @child, or -1 if the @child is not + the index of the @child, or -1 if the @child is not in a flow box - a `GtkFlowBoxChild` + a `GtkFlowBoxChild` - Returns whether the @child is currently selected in its + Returns whether the @child is currently selected in its `GtkFlowBox` container. + - %TRUE if @child is selected + %TRUE if @child is selected - a `GtkFlowBoxChild` + a `GtkFlowBoxChild` - Sets the child widget of @self. + Sets the child widget of @self. + - a `GtkFlowBoxChild` + a `GtkFlowBoxChild` - the child widget + the child widget @@ -34704,14 +36275,14 @@ on any model change, but that is more expensive. - The child widget. + The child widget. - Emitted when the user activates a child widget in a `GtkFlowBox`. + Emitted when the user activates a child widget in a `GtkFlowBox`. This can be happen either by clicking or double-clicking, or via a keybinding. @@ -34726,11 +36297,13 @@ The default bindings are <kbd>Space</kbd> and <kbd>Enter</k + + @@ -34748,91 +36321,95 @@ The default bindings are <kbd>Space</kbd> and <kbd>Enter</k - Called for flow boxes that are bound to a `GListModel`. + Called for flow boxes that are bound to a `GListModel`. This function is called for each item that gets added to the model. + - a `GtkWidget` that represents @item + a `GtkWidget` that represents @item - the item from the model for which to create a widget for + the item from the model for which to create a widget for - user data from gtk_flow_box_bind_model() + user data from gtk_flow_box_bind_model() - A function that will be called whenever a child changes + A function that will be called whenever a child changes or is added. It lets you control if the child should be visible or not. + - %TRUE if the row should be visible, %FALSE otherwise + %TRUE if the row should be visible, %FALSE otherwise - a `GtkFlowBoxChild` that may be filtered + a `GtkFlowBoxChild` that may be filtered - user data + user data - A function used by gtk_flow_box_selected_foreach(). + A function used by gtk_flow_box_selected_foreach(). It will be called on every selected child of the @box. + - a `GtkFlowBox` + a `GtkFlowBox` - a `GtkFlowBoxChild` + a `GtkFlowBoxChild` - user data + user data - A function to compare two children to determine which + A function to compare two children to determine which should come first. + - < 0 if @child1 should be before @child2, 0 if + < 0 if @child1 should be before @child2, 0 if the are equal, and > 0 otherwise - the first child + the first child - the second child + the second child - user data + user data - The `GtkFontButton` allows to open a font chooser dialog to change + The `GtkFontButton` allows to open a font chooser dialog to change the font. ![An example GtkFontButton](font-button.png) @@ -34854,148 +36431,158 @@ contains a button node with the .font style class. - Creates a new font picker widget. + Creates a new font picker widget. + - a new font picker widget. + a new font picker widget. - Creates a new font picker widget showing the given font. + Creates a new font picker widget showing the given font. + - a new font picker widget. + a new font picker widget. - Name of font to display in font chooser dialog + Name of font to display in font chooser dialog - Gets whether the dialog is modal. + Gets whether the dialog is modal. + - %TRUE if the dialog is modal + %TRUE if the dialog is modal - a `GtkFontButton` + a `GtkFontButton` - Retrieves the title of the font chooser dialog. + Retrieves the title of the font chooser dialog. + - an internal copy of the title string + an internal copy of the title string which must not be freed. - a `GtkFontButton` + a `GtkFontButton` - Returns whether the selected font is used in the label. + Returns whether the selected font is used in the label. + - whether the selected font is used in the label. + whether the selected font is used in the label. - a `GtkFontButton` + a `GtkFontButton` - Returns whether the selected size is used in the label. + Returns whether the selected size is used in the label. + - whether the selected size is used in the label. + whether the selected size is used in the label. - a `GtkFontButton` + a `GtkFontButton` - Sets whether the dialog should be modal. + Sets whether the dialog should be modal. + - a `GtkFontButton` + a `GtkFontButton` - %TRUE to make the dialog modal + %TRUE to make the dialog modal - Sets the title for the font chooser dialog. + Sets the title for the font chooser dialog. + - a `GtkFontButton` + a `GtkFontButton` - a string containing the font chooser dialog title + a string containing the font chooser dialog title - If @use_font is %TRUE, the font name will be written + If @use_font is %TRUE, the font name will be written using the selected font. + - a `GtkFontButton` + a `GtkFontButton` - If %TRUE, font name will be written using font chosen. + If %TRUE, font name will be written using font chosen. - If @use_size is %TRUE, the font name will be written using + If @use_size is %TRUE, the font name will be written using the selected size. + - a `GtkFontButton` + a `GtkFontButton` - If %TRUE, font name will be written using the + If %TRUE, font name will be written using the selected size. @@ -35004,29 +36591,29 @@ the selected size. - Whether the font chooser dialog should be modal. + Whether the font chooser dialog should be modal. - The title of the font chooser dialog. + The title of the font chooser dialog. - Whether the buttons label will be drawn in the selected font. + Whether the buttons label will be drawn in the selected font. - Whether the buttons label will use the selected font size. + Whether the buttons label will use the selected font size. - Emitted to when the font button is activated. + Emitted to when the font button is activated. The `::activate` signal on `GtkFontButton` is an action signal and emitting it causes the button to present its dialog. @@ -35035,7 +36622,7 @@ emitting it causes the button to present its dialog. - Emitted when the user selects a font. + Emitted when the user selects a font. When handling this signal, use [method@Gtk.FontChooser.get_font] to find out which font was just selected. @@ -35049,13 +36636,15 @@ the notify::font signal. - `GtkFontChooser` is an interface that can be implemented by widgets + `GtkFontChooser` is an interface that can be implemented by widgets for choosing fonts. In GTK, the main objects that implement this interface are [class@Gtk.FontChooserWidget], [class@Gtk.FontChooserDialog] and [class@Gtk.FontButton]. + + @@ -35069,95 +36658,100 @@ In GTK, the main objects that implement this interface are - Gets the `PangoFontFace` representing the selected font group + Gets the `PangoFontFace` representing the selected font group details (i.e. family, slant, weight, width, etc). If the selected font is not installed, returns %NULL. + - A `PangoFontFace` representing the + A `PangoFontFace` representing the selected font group details - a `GtkFontChooser` + a `GtkFontChooser` - Gets the `PangoFontFamily` representing the selected font family. + Gets the `PangoFontFamily` representing the selected font family. Font families are a collection of font faces. If the selected font is not installed, returns %NULL. + - A `PangoFontFamily` representing the + A `PangoFontFamily` representing the selected font family - a `GtkFontChooser` + a `GtkFontChooser` - Gets the custom font map of this font chooser widget, + Gets the custom font map of this font chooser widget, or %NULL if it does not have one. + - a `PangoFontMap` + a `PangoFontMap` - a `GtkFontChooser` + a `GtkFontChooser` - The selected font size. + The selected font size. + - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a `GtkFontChooser` + a `GtkFontChooser` - Adds a filter function that decides which fonts to display + Adds a filter function that decides which fonts to display in the font chooser. + - a `GtkFontChooser` + a `GtkFontChooser` - a `GtkFontFilterFunc` + a `GtkFontFilterFunc` - data to pass to @filter + data to pass to @filter - function to call to free @data when it is no longer needed + function to call to free @data when it is no longer needed - Sets a custom font map to use for this font chooser widget. + Sets a custom font map to use for this font chooser widget. A custom font map can be used to present application-specific fonts instead of or in addition to the normal system fonts. @@ -35182,23 +36776,24 @@ application-specific font if it is present in the font map they use: context = gtk_widget_get_pango_context (label); pango_context_set_font_map (context, fontmap); ``` + - a `GtkFontChooser` + a `GtkFontChooser` - a `PangoFontMap` + a `PangoFontMap` - Gets the currently-selected font name. + Gets the currently-selected font name. Note that this can be a different string than what you set with [method@Gtk.FontChooser.set_font], as the font chooser widget may @@ -35208,21 +36803,22 @@ normalized to “Helvetica Bold Italic 12”. Use [method@Pango.FontDescription.equal] if you want to compare two font descriptions. + - A string with the name + A string with the name of the current font - a `GtkFontChooser` + a `GtkFontChooser` - Gets the currently-selected font. + Gets the currently-selected font. Note that this can be a different string than what you set with [method@Gtk.FontChooser.set_font], as the font chooser widget may @@ -35232,212 +36828,225 @@ normalized to “Helvetica Bold Italic 12”. Use [method@Pango.FontDescription.equal] if you want to compare two font descriptions. + - A `PangoFontDescription` for the + A `PangoFontDescription` for the current font - a `GtkFontChooser` + a `GtkFontChooser` - Gets the `PangoFontFace` representing the selected font group + Gets the `PangoFontFace` representing the selected font group details (i.e. family, slant, weight, width, etc). If the selected font is not installed, returns %NULL. + - A `PangoFontFace` representing the + A `PangoFontFace` representing the selected font group details - a `GtkFontChooser` + a `GtkFontChooser` - Gets the `PangoFontFamily` representing the selected font family. + Gets the `PangoFontFamily` representing the selected font family. Font families are a collection of font faces. If the selected font is not installed, returns %NULL. + - A `PangoFontFamily` representing the + A `PangoFontFamily` representing the selected font family - a `GtkFontChooser` + a `GtkFontChooser` - Gets the currently-selected font features. + Gets the currently-selected font features. + - the currently selected font features + the currently selected font features - a `GtkFontChooser` + a `GtkFontChooser` - Gets the custom font map of this font chooser widget, + Gets the custom font map of this font chooser widget, or %NULL if it does not have one. + - a `PangoFontMap` + a `PangoFontMap` - a `GtkFontChooser` + a `GtkFontChooser` - The selected font size. + The selected font size. + - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a `GtkFontChooser` + a `GtkFontChooser` - Gets the language that is used for font features. + Gets the language that is used for font features. + - the currently selected language + the currently selected language - a `GtkFontChooser` + a `GtkFontChooser` - Returns the current level of granularity for selecting fonts. + Returns the current level of granularity for selecting fonts. + - the current granularity level + the current granularity level - a `GtkFontChooser` + a `GtkFontChooser` - Gets the text displayed in the preview area. + Gets the text displayed in the preview area. + - the text displayed in the preview area + the text displayed in the preview area - a `GtkFontChooser` + a `GtkFontChooser` - Returns whether the preview entry is shown or not. + Returns whether the preview entry is shown or not. + - %TRUE if the preview entry is shown or %FALSE if it is hidden. + %TRUE if the preview entry is shown or %FALSE if it is hidden. - a `GtkFontChooser` + a `GtkFontChooser` - Adds a filter function that decides which fonts to display + Adds a filter function that decides which fonts to display in the font chooser. + - a `GtkFontChooser` + a `GtkFontChooser` - a `GtkFontFilterFunc` + a `GtkFontFilterFunc` - data to pass to @filter + data to pass to @filter - function to call to free @data when it is no longer needed + function to call to free @data when it is no longer needed - Sets the currently-selected font. + Sets the currently-selected font. + - a `GtkFontChooser` + a `GtkFontChooser` - a font name like “Helvetica 12” or “Times Bold 18” + a font name like “Helvetica 12” or “Times Bold 18” - Sets the currently-selected font from @font_desc. + Sets the currently-selected font from @font_desc. + - a `GtkFontChooser` + a `GtkFontChooser` - a `PangoFontDescription` + a `PangoFontDescription` - Sets a custom font map to use for this font chooser widget. + Sets a custom font map to use for this font chooser widget. A custom font map can be used to present application-specific fonts instead of or in addition to the normal system fonts. @@ -35462,86 +37071,91 @@ application-specific font if it is present in the font map they use: context = gtk_widget_get_pango_context (label); pango_context_set_font_map (context, fontmap); ``` + - a `GtkFontChooser` + a `GtkFontChooser` - a `PangoFontMap` + a `PangoFontMap` - Sets the language to use for font features. + Sets the language to use for font features. + - a `GtkFontChooser` + a `GtkFontChooser` - a language + a language - Sets the desired level of granularity for selecting fonts. + Sets the desired level of granularity for selecting fonts. + - a `GtkFontChooser` + a `GtkFontChooser` - the desired level of granularity + the desired level of granularity - Sets the text displayed in the preview area. + Sets the text displayed in the preview area. The @text is used to show how the selected font looks. + - a `GtkFontChooser` + a `GtkFontChooser` - the text to display in the preview area + the text to display in the preview area - Shows or hides the editable preview entry. + Shows or hides the editable preview entry. + - a `GtkFontChooser` + a `GtkFontChooser` - whether to show the editable preview entry or not + whether to show the editable preview entry or not @@ -35549,18 +37163,18 @@ The @text is used to show how the selected font looks. - The font description as a string, e.g. "Sans Italic 12". + The font description as a string, e.g. "Sans Italic 12". - The font description as a `PangoFontDescription`. + The font description as a `PangoFontDescription`. - The selected font features. + The selected font features. The format of the string is compatible with CSS and with Pango attributes. @@ -35569,29 +37183,29 @@ CSS and with Pango attributes. - The language for which the font features were selected. + The language for which the font features were selected. - The level of granularity to offer for selecting fonts. + The level of granularity to offer for selecting fonts. - The string with which to preview the font. + The string with which to preview the font. - Whether to show an entry to change the preview text. + Whether to show an entry to change the preview text. - Emitted when a font is activated. + Emitted when a font is activated. This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys @@ -35601,14 +37215,14 @@ Space, Shift+Space, Return or Enter. - the font name + the font name - The `GtkFontChooserDialog` widget is a dialog for selecting a font. + The `GtkFontChooserDialog` widget is a dialog for selecting a font. ![An example GtkFontChooserDialog](fontchooser.png) @@ -35630,37 +37244,40 @@ and “cancel_button”. - Creates a new `GtkFontChooserDialog`. + Creates a new `GtkFontChooserDialog`. + - a new `GtkFontChooserDialog` + a new `GtkFontChooserDialog` - Title of the dialog + Title of the dialog - Transient parent of the dialog + Transient parent of the dialog + + - A `PangoFontFamily` representing the + A `PangoFontFamily` representing the selected font family - a `GtkFontChooser` + a `GtkFontChooser` @@ -35668,14 +37285,15 @@ and “cancel_button”. + - A `PangoFontFace` representing the + A `PangoFontFace` representing the selected font group details - a `GtkFontChooser` + a `GtkFontChooser` @@ -35683,14 +37301,15 @@ and “cancel_button”. + - A n integer representing the selected font size, + A n integer representing the selected font size, or -1 if no font size is selected. - a `GtkFontChooser` + a `GtkFontChooser` @@ -35698,24 +37317,25 @@ and “cancel_button”. + - a `GtkFontChooser` + a `GtkFontChooser` - a `GtkFontFilterFunc` + a `GtkFontFilterFunc` - data to pass to @filter + data to pass to @filter - function to call to free @data when it is no longer needed + function to call to free @data when it is no longer needed @@ -35723,6 +37343,7 @@ and “cancel_button”. + @@ -35738,16 +37359,17 @@ and “cancel_button”. + - a `GtkFontChooser` + a `GtkFontChooser` - a `PangoFontMap` + a `PangoFontMap` @@ -35755,13 +37377,14 @@ and “cancel_button”. + - a `PangoFontMap` + a `PangoFontMap` - a `GtkFontChooser` + a `GtkFontChooser` @@ -35774,29 +37397,29 @@ and “cancel_button”. - Specifies the granularity of font selection + Specifies the granularity of font selection that is desired in a `GtkFontChooser`. This enumeration may be extended in the future; applications should ignore unknown values. - Allow selecting a font family + Allow selecting a font family - Allow selecting a specific font face + Allow selecting a specific font face - Allow selecting a specific font size + Allow selecting a specific font size - Allow changing OpenType font variation axes + Allow changing OpenType font variation axes - Allow selecting specific OpenType font features + Allow selecting specific OpenType font features - The `GtkFontChooserWidget` widget lets the user select a font. + The `GtkFontChooserWidget` widget lets the user select a font. It is used in the `GtkFontChooserDialog` widget to provide a dialog for selecting fonts. @@ -35818,14 +37441,15 @@ To change the text which is shown in the preview area, use - Creates a new `GtkFontChooserWidget`. + Creates a new `GtkFontChooserWidget`. + - a new `GtkFontChooserWidget` + a new `GtkFontChooserWidget` - A toggle action that can be used to switch to the tweak page + A toggle action that can be used to switch to the tweak page of the font chooser widget, which lets the user tweak the OpenType features and variation axes of the selected font. @@ -35835,31 +37459,32 @@ the selected font has any features or axes. - The type of function that is used for deciding what fonts get + The type of function that is used for deciding what fonts get shown in a `GtkFontChooser`. See [method@Gtk.FontChooser.set_filter_func]. + - %TRUE if the font should be displayed + %TRUE if the font should be displayed - a `PangoFontFamily` + a `PangoFontFamily` - a `PangoFontFace` belonging to @family + a `PangoFontFace` belonging to @family - user data passed to gtk_font_chooser_set_filter_func() + user data passed to gtk_font_chooser_set_filter_func() - `GtkFrame` is a widget that surrounds its child with a decorative + `GtkFrame` is a widget that surrounds its child with a decorative frame and an optional label. ![An example GtkFrame](frame.png) @@ -35901,25 +37526,28 @@ frame `GtkFrame` has a main CSS node with name “frame”, which is used to draw the visible border. You can set the appearance of the border using CSS properties like “border-style” on this node. + - Creates a new `GtkFrame`, with optional label @label. + Creates a new `GtkFrame`, with optional label @label. If @label is %NULL, the label is omitted. + - a new `GtkFrame` widget + a new `GtkFrame` widget - the text to use as the label of the frame + the text to use as the label of the frame + @@ -35934,115 +37562,122 @@ If @label is %NULL, the label is omitted. - Gets the child widget of @frame. + Gets the child widget of @frame. + - the child widget of @frame + the child widget of @frame - a `GtkFrame` + a `GtkFrame` - Returns the frame labels text. + Returns the frame labels text. If the frame's label widget is not a `GtkLabel`, %NULL is returned. + - the text in the label, or %NULL if there + the text in the label, or %NULL if there was no label widget or the label widget was not a `GtkLabel`. This string is owned by GTK and must not be modified or freed. - a `GtkFrame` + a `GtkFrame` - Retrieves the X alignment of the frame’s label. + Retrieves the X alignment of the frame’s label. + - the frames X alignment + the frames X alignment - a `GtkFrame` + a `GtkFrame` - Retrieves the label widget for the frame. + Retrieves the label widget for the frame. + - the label widget + the label widget - a `GtkFrame` + a `GtkFrame` - Sets the child widget of @frame. + Sets the child widget of @frame. + - a `GtkFrame` + a `GtkFrame` - the child widget + the child widget - Creates a new `GtkLabel` with the @label and sets it as the frame's + Creates a new `GtkLabel` with the @label and sets it as the frame's label widget. + - a `GtkFrame` + a `GtkFrame` - the text to use as the label of the frame + the text to use as the label of the frame - Sets the X alignment of the frame widget’s label. + Sets the X alignment of the frame widget’s label. The default value for a newly created frame is 0.0. + - a `GtkFrame` + a `GtkFrame` - The position of the label along the top edge + The position of the label along the top edge of the widget. A value of 0.0 represents left alignment; 1.0 represents right alignment. @@ -36051,20 +37686,21 @@ The default value for a newly created frame is 0.0. - Sets the label widget for the frame. + Sets the label widget for the frame. This is the widget that will appear embedded in the top edge of the frame as a title. + - a `GtkFrame` + a `GtkFrame` - the new label widget + the new label widget @@ -36072,25 +37708,25 @@ of the frame as a title. - The child widget. + The child widget. - Text of the frame's label. + Text of the frame's label. - Widget to display in place of the usual frame label. + Widget to display in place of the usual frame label. - The horizontal alignment of the label. + The horizontal alignment of the label. @@ -36098,12 +37734,14 @@ of the frame as a title. + - The parent class. + The parent class. + @@ -36124,187 +37762,217 @@ of the frame as a title. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - `GtkGLArea` is a widget that allows drawing with OpenGL. + `GtkGLArea` is a widget that allows drawing with OpenGL. ![An example GtkGLArea](glarea.png) @@ -36406,17 +38074,20 @@ on_realize (GtkGLarea *area) If you need to change the options for creating the `GdkGLContext` you should use the [signal@Gtk.GLArea::create-context] signal. + - Creates a new `GtkGLArea` widget. + Creates a new `GtkGLArea` widget. + - a new `GtkGLArea` + a new `GtkGLArea` + @@ -36427,6 +38098,7 @@ you should use the [signal@Gtk.GLArea::create-context] signal. + @@ -36440,6 +38112,7 @@ you should use the [signal@Gtk.GLArea::create-context] signal. + @@ -36456,7 +38129,7 @@ you should use the [signal@Gtk.GLArea::create-context] signal. - Binds buffers to the framebuffer. + Binds buffers to the framebuffer. Ensures that the @area framebuffer object is made the current draw and read target, and that all the required buffers for the @area @@ -36465,142 +38138,151 @@ are created and bound to the framebuffer. This function is automatically called before emitting the [signal@Gtk.GLArea::render] signal, and doesn't normally need to be called by application code. + - a `GtkGLArea` + a `GtkGLArea` - Returns whether the area is in auto render mode or not. + Returns whether the area is in auto render mode or not. + - %TRUE if the @area is auto rendering, %FALSE otherwise + %TRUE if the @area is auto rendering, %FALSE otherwise - a `GtkGLArea` + a `GtkGLArea` - Retrieves the `GdkGLContext` used by @area. + Retrieves the `GdkGLContext` used by @area. + - the `GdkGLContext` + the `GdkGLContext` - a `GtkGLArea` + a `GtkGLArea` - Gets the current error set on the @area. + Gets the current error set on the @area. + - the `GError` + the `GError` - a `GtkGLArea` + a `GtkGLArea` - Returns whether the area has a depth buffer. + Returns whether the area has a depth buffer. + - %TRUE if the @area has a depth buffer, %FALSE otherwise + %TRUE if the @area has a depth buffer, %FALSE otherwise - a `GtkGLArea` + a `GtkGLArea` - Returns whether the area has a stencil buffer. + Returns whether the area has a stencil buffer. + - %TRUE if the @area has a stencil buffer, %FALSE otherwise + %TRUE if the @area has a stencil buffer, %FALSE otherwise - a `GtkGLArea` + a `GtkGLArea` - Retrieves the required version of OpenGL. + Retrieves the required version of OpenGL. See [method@Gtk.GLArea.set_required_version]. + - a `GtkGLArea` + a `GtkGLArea` - return location for the required major version + return location for the required major version - return location for the required minor version + return location for the required minor version - Returns whether the `GtkGLArea` should use OpenGL ES. + Returns whether the `GtkGLArea` should use OpenGL ES. See [method@Gtk.GLArea.set_use_es]. + - %TRUE if the `GtkGLArea` should create an OpenGL ES context + %TRUE if the `GtkGLArea` should create an OpenGL ES context and %FALSE otherwise - a `GtkGLArea` + a `GtkGLArea` - Ensures that the `GdkGLContext` used by @area is associated with + Ensures that the `GdkGLContext` used by @area is associated with the `GtkGLArea`. This function is automatically called before emitting the [signal@Gtk.GLArea::render] signal, and doesn't normally need to be called by application code. + - a `GtkGLArea` + a `GtkGLArea` - Marks the currently rendered data (if any) as invalid, and queues + Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget. This ensures that the [signal@Gtk.GLArea::render] signal @@ -36609,19 +38291,20 @@ is emitted during the draw. This is only needed when [method@Gtk.GLArea.set_auto_render] has been called with a %FALSE value. The default behaviour is to emit [signal@Gtk.GLArea::render] on each draw. + - a `GtkGLArea` + a `GtkGLArea` - Sets whether the `GtkGLArea` is in auto render mode. + Sets whether the `GtkGLArea` is in auto render mode. If @auto_render is %TRUE the [signal@Gtk.GLArea::render] signal will be emitted every time the widget draws. This is the default and is @@ -36632,121 +38315,127 @@ around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering [method@Gtk.GLArea.queue_render] must be called. This mode is useful when the scene changes seldom, but takes a long time to redraw. + - a `GtkGLArea` + a `GtkGLArea` - a boolean + a boolean - Sets an error on the area which will be shown instead of the + Sets an error on the area which will be shown instead of the GL rendering. This is useful in the [signal@Gtk.GLArea::create-context] signal if GL context creation fails. + - a `GtkGLArea` + a `GtkGLArea` - a new `GError`, or %NULL to unset the error + a new `GError`, or %NULL to unset the error - Sets whether the `GtkGLArea` should use a depth buffer. + Sets whether the `GtkGLArea` should use a depth buffer. If @has_depth_buffer is %TRUE the widget will allocate and enable a depth buffer for the target framebuffer. Otherwise there will be none. + - a `GtkGLArea` + a `GtkGLArea` - %TRUE to add a depth buffer + %TRUE to add a depth buffer - Sets whether the `GtkGLArea` should use a stencil buffer. + Sets whether the `GtkGLArea` should use a stencil buffer. If @has_stencil_buffer is %TRUE the widget will allocate and enable a stencil buffer for the target framebuffer. Otherwise there will be none. + - a `GtkGLArea` + a `GtkGLArea` - %TRUE to add a stencil buffer + %TRUE to add a stencil buffer - Sets the required version of OpenGL to be used when creating + Sets the required version of OpenGL to be used when creating the context for the widget. This function must be called before the area has been realized. + - a `GtkGLArea` + a `GtkGLArea` - the major version + the major version - the minor version + the minor version - Sets whether the @area should create an OpenGL or an OpenGL ES context. + Sets whether the @area should create an OpenGL or an OpenGL ES context. You should check the capabilities of the `GdkGLContext` before drawing with either API. + - a `GtkGLArea` + a `GtkGLArea` - whether to use OpenGL or OpenGL ES + whether to use OpenGL or OpenGL ES @@ -36754,7 +38443,7 @@ with either API. - If set to %TRUE the ::render signal will be emitted every time + If set to %TRUE the ::render signal will be emitted every time the widget draws. This is the default and is useful if drawing the widget is faster. @@ -36767,7 +38456,7 @@ to redraw. - The `GdkGLContext` used by the `GtkGLArea` widget. + The `GdkGLContext` used by the `GtkGLArea` widget. The `GtkGLArea` widget is responsible for creating the `GdkGLContext` instance. If you need to render with other kinds of buffers (stencil, @@ -36777,21 +38466,21 @@ depth, etc), use render buffers. - If set to %TRUE the widget will allocate and enable a depth buffer for the + If set to %TRUE the widget will allocate and enable a depth buffer for the target framebuffer. - If set to %TRUE the widget will allocate and enable a stencil buffer for the + If set to %TRUE the widget will allocate and enable a stencil buffer for the target framebuffer. - If set to %TRUE the widget will try to create a `GdkGLContext` using + If set to %TRUE the widget will try to create a `GdkGLContext` using OpenGL ES instead of OpenGL. @@ -36799,7 +38488,7 @@ OpenGL ES instead of OpenGL. - Emitted when the widget is being realized. + Emitted when the widget is being realized. This allows you to override how the GL context is created. This is useful when you want to reuse an existing GL context, @@ -36809,30 +38498,30 @@ If context creation fails then the signal handler can use [method@Gtk.GLArea.set_error] to register a more detailed error of how the construction failed. - a newly created `GdkGLContext`; + a newly created `GdkGLContext`; the `GtkGLArea` widget will take ownership of the returned value. - Emitted every time the contents of the `GtkGLArea` should be redrawn. + Emitted every time the contents of the `GtkGLArea` should be redrawn. The @context is bound to the @area prior to emitting this function, and the buffers are painted to the window once the emission terminates. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the `GdkGLContext` used by @area + the `GdkGLContext` used by @area - Emitted once when the widget is realized, and then each time the widget + Emitted once when the widget is realized, and then each time the widget is changed while realized. This is useful in order to keep GL state up to date with the widget size, @@ -36848,23 +38537,25 @@ The default handler sets up the GL viewport. - the width of the viewport + the width of the viewport - the height of the viewport + the height of the viewport - The `GtkGLAreaClass` structure contains only private data. + The `GtkGLAreaClass` structure contains only private data. + + @@ -36880,6 +38571,7 @@ The default handler sets up the GL viewport. + @@ -36898,6 +38590,7 @@ The default handler sets up the GL viewport. + @@ -36915,61 +38608,70 @@ The default handler sets up the GL viewport. + + + + + + + + + - `GtkGesture` is the base class for gesture recognition. + `GtkGesture` is the base class for gesture recognition. Although `GtkGesture` is quite generalized to serve as a base for multi-touch gestures, it is suitable to implement single-touch and @@ -37058,8 +38760,9 @@ do to enable this support are: - If the gesture has %GTK_PHASE_NONE, ensuring events of type %GDK_TOUCHPAD_SWIPE and %GDK_TOUCHPAD_PINCH are handled by the `GtkGesture` + - If there are touch sequences being currently handled by @gesture, + If there are touch sequences being currently handled by @gesture, returns %TRUE and fills in @rect with the bounding box containing all active touches. @@ -37070,66 +38773,70 @@ gestures. Since there is no correlation between physical and pixel distances, these will look as if constrained in an infinitely small area, @rect width and height will thus be 0 regardless of the number of touchpoints. + - %TRUE if there are active touches, %FALSE otherwise + %TRUE if there are active touches, %FALSE otherwise - a `GtkGesture` + a `GtkGesture` - bounding box containing all active touches. + bounding box containing all active touches. - If there are touch sequences being currently handled by @gesture, + If there are touch sequences being currently handled by @gesture, returns %TRUE and fills in @x and @y with the center of the bounding box containing all active touches. Otherwise, %FALSE will be returned. + - %FALSE if no active touches are present, %TRUE otherwise + %FALSE if no active touches are present, %TRUE otherwise - a `GtkGesture` + a `GtkGesture` - X coordinate for the bounding box center + X coordinate for the bounding box center - Y coordinate for the bounding box center + Y coordinate for the bounding box center - Returns the logical `GdkDevice` that is currently operating + Returns the logical `GdkDevice` that is currently operating on @gesture. This returns %NULL if the gesture is not being interacted. + - a `GdkDevice` + a `GdkDevice` - a `GtkGesture` + a `GtkGesture` - Returns all gestures in the group of @gesture + Returns all gestures in the group of @gesture + - The list + The list of `GtkGesture`s, free with g_list_free() @@ -37137,96 +38844,101 @@ This returns %NULL if the gesture is not being interacted. - a `GtkGesture` + a `GtkGesture` - Returns the last event that was processed for @sequence. + Returns the last event that was processed for @sequence. Note that the returned pointer is only valid as long as the @sequence is still interpreted by the @gesture. If in doubt, you should make a copy of the event. + - The last event from @sequence + The last event from @sequence - a `GtkGesture` + a `GtkGesture` - a `GdkEventSequence` + a `GdkEventSequence` - Returns the `GdkEventSequence` that was last updated on @gesture. + Returns the `GdkEventSequence` that was last updated on @gesture. + - The last updated sequence + The last updated sequence - a `GtkGesture` + a `GtkGesture` - If @sequence is currently being interpreted by @gesture, + If @sequence is currently being interpreted by @gesture, returns %TRUE and fills in @x and @y with the last coordinates stored for that event sequence. The coordinates are always relative to the widget allocation. + - %TRUE if @sequence is currently interpreted + %TRUE if @sequence is currently interpreted - a `GtkGesture` + a `GtkGesture` - a `GdkEventSequence`, or %NULL for pointer events + a `GdkEventSequence`, or %NULL for pointer events - return location for X axis of the sequence coordinates + return location for X axis of the sequence coordinates - return location for Y axis of the sequence coordinates + return location for Y axis of the sequence coordinates - Returns the @sequence state, as seen by @gesture. + Returns the @sequence state, as seen by @gesture. + - The sequence state in @gesture + The sequence state in @gesture - a `GtkGesture` + a `GtkGesture` - a `GdkEventSequence` + a `GdkEventSequence` - Returns the list of `GdkEventSequences` currently being interpreted + Returns the list of `GdkEventSequences` currently being interpreted by @gesture. + - A list + A list of `GdkEventSequence`, the list elements are owned by GTK and must not be freed or modified, the list itself must be deleted through g_list_free() @@ -37236,13 +38948,13 @@ by @gesture. - a `GtkGesture` + a `GtkGesture` - Adds @gesture to the same group than @group_gesture. + Adds @gesture to the same group than @group_gesture. Gestures are by default isolated in their own groups. @@ -37259,89 +38971,94 @@ Groups also perform an "implicit grabbing" of sequences, if a on one group, every other gesture group attached to the same `GtkWidget` will switch the state for that sequence to %GTK_EVENT_SEQUENCE_DENIED. + - `GtkGesture` to group @gesture with + `GtkGesture` to group @gesture with - a `GtkGesture` + a `GtkGesture` - Returns %TRUE if @gesture is currently handling events + Returns %TRUE if @gesture is currently handling events corresponding to @sequence. + - %TRUE if @gesture is handling @sequence, %FALSE otherwise + %TRUE if @gesture is handling @sequence, %FALSE otherwise - a `GtkGesture` + a `GtkGesture` - a `GdkEventSequence` + a `GdkEventSequence` - Returns %TRUE if the gesture is currently active. + Returns %TRUE if the gesture is currently active. A gesture is active while there are touch sequences interacting with it. + - %TRUE if gesture is active + %TRUE if gesture is active - a `GtkGesture` + a `GtkGesture` - Returns %TRUE if both gestures pertain to the same group. + Returns %TRUE if both gestures pertain to the same group. + - whether the gestures are grouped + whether the gestures are grouped - a `GtkGesture` + a `GtkGesture` - another `GtkGesture` + another `GtkGesture` - Returns %TRUE if the gesture is currently recognized. + Returns %TRUE if the gesture is currently recognized. A gesture is recognized if there are as many interacting touch sequences as required by @gesture. + - %TRUE if gesture is recognized + %TRUE if gesture is recognized - a `GtkGesture` + a `GtkGesture` - Sets the state of @sequence in @gesture. + Sets the state of @sequence in @gesture. Sequences start in state %GTK_EVENT_SEQUENCE_NONE, and whenever they change state, they can never go back to that state. Likewise, @@ -37383,67 +39100,70 @@ If both gestures are in the same group, just set the state on the gesture emitting the event, the sequence will be already be initialized to the group's global state when the second gesture processes the event. + - %TRUE if @sequence is handled by @gesture, + %TRUE if @sequence is handled by @gesture, and the state is changed successfully - a `GtkGesture` + a `GtkGesture` - a `GdkEventSequence` + a `GdkEventSequence` - the sequence state + the sequence state - Sets the state of all sequences that @gesture is currently + Sets the state of all sequences that @gesture is currently interacting with. See [method@Gtk.Gesture.set_sequence_state] for more details on sequence states. + - %TRUE if the state of at least one sequence + %TRUE if the state of at least one sequence was changed successfully - a `GtkGesture` + a `GtkGesture` - the sequence state + the sequence state - Separates @gesture into an isolated group. + Separates @gesture into an isolated group. + - a `GtkGesture` + a `GtkGesture` - The number of touch points that trigger + The number of touch points that trigger recognition on this gesture. - Emitted when the gesture is recognized. + Emitted when the gesture is recognized. This means the number of touch sequences matches [property@Gtk.Gesture:n-points]. @@ -37457,14 +39177,14 @@ touches, so don't rely on this being true. - the `GdkEventSequence` that made the gesture + the `GdkEventSequence` that made the gesture to be recognized - Emitted whenever a sequence is cancelled. + Emitted whenever a sequence is cancelled. This usually happens on active touches when [method@Gtk.EventController.reset] is called on @gesture @@ -37479,13 +39199,13 @@ response to this signal. - the `GdkEventSequence` that was cancelled + the `GdkEventSequence` that was cancelled - Emitted when @gesture either stopped recognizing the event + Emitted when @gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than [property@Gtk.Gesture:n-points]. @@ -37499,14 +39219,14 @@ This situation may be detected by checking through - the `GdkEventSequence` that made gesture + the `GdkEventSequence` that made gesture recognition to finish - Emitted whenever a sequence state changes. + Emitted whenever a sequence state changes. See [method@Gtk.Gesture.set_sequence_state] to know more about the expectable sequence lifetimes. @@ -37515,17 +39235,17 @@ more about the expectable sequence lifetimes. - the `GdkEventSequence` that was cancelled + the `GdkEventSequence` that was cancelled - the new sequence state + the new sequence state - Emitted whenever an event is handled while the gesture is recognized. + Emitted whenever an event is handled while the gesture is recognized. @sequence is guaranteed to pertain to the set of active touches. @@ -37533,51 +39253,55 @@ more about the expectable sequence lifetimes. - the `GdkEventSequence` that was updated + the `GdkEventSequence` that was updated - + + + - `GtkGestureClick` is a `GtkGesture` implementation for clicks. + `GtkGestureClick` is a `GtkGesture` implementation for clicks. It is able to recognize multiple clicks on a nearby zone, which can be listened for through the [signal@Gtk.GestureClick::pressed] signal. Whenever time or distance between clicks exceed the GTK defaults, [signal@Gtk.GestureClick::stopped] is emitted, and the click counter is reset. + - Returns a newly created `GtkGesture` that recognizes + Returns a newly created `GtkGesture` that recognizes single and multiple presses. + - a newly created `GtkGestureClick` + a newly created `GtkGestureClick` - Emitted whenever a button or touch press happens. + Emitted whenever a button or touch press happens. - how many touch/button presses happened with this one + how many touch/button presses happened with this one - The X coordinate, in widget allocation coordinates + The X coordinate, in widget allocation coordinates - The Y coordinate, in widget allocation coordinates + The Y coordinate, in widget allocation coordinates - Emitted when a button or touch is released. + Emitted when a button or touch is released. @n_press will report the number of press that is paired to this event, note that [signal@Gtk.GestureClick::stopped] may @@ -37588,27 +39312,27 @@ will only start over at the next press. - number of press that is paired with this release + number of press that is paired with this release - The X coordinate, in widget allocation coordinates + The X coordinate, in widget allocation coordinates - The Y coordinate, in widget allocation coordinates + The Y coordinate, in widget allocation coordinates - Emitted whenever any time/distance threshold has been exceeded. + Emitted whenever any time/distance threshold has been exceeded. - Emitted whenever the gesture receives a release + Emitted whenever the gesture receives a release event that had no previous corresponding press. Due to implicit grabs, this can only happen on situations @@ -37619,27 +39343,29 @@ widget voluntarily relinquishes its implicit grab. - X coordinate of the event + X coordinate of the event - Y coordinate of the event + Y coordinate of the event - Button being released + Button being released - Sequence being released + Sequence being released - + + + - `GtkGestureDrag` is a `GtkGesture` implementation for drags. + `GtkGestureDrag` is a `GtkGesture` implementation for drags. The drag operation itself can be tracked throughout the [signal@Gtk.GestureDrag::drag-begin], @@ -37648,115 +39374,121 @@ The drag operation itself can be tracked throughout the coordinates can be extracted through [method@Gtk.GestureDrag.get_offset] and [method@Gtk.GestureDrag.get_start_point]. + - Returns a newly created `GtkGesture` that recognizes drags. + Returns a newly created `GtkGesture` that recognizes drags. + - a newly created `GtkGestureDrag` + a newly created `GtkGestureDrag` - Gets the offset from the start point. + Gets the offset from the start point. If the @gesture is active, this function returns %TRUE and fills in @x and @y with the coordinates of the current point, as an offset to the starting drag point. + - %TRUE if the gesture is active + %TRUE if the gesture is active - a `GtkGesture` + a `GtkGesture` - X offset for the current point + X offset for the current point - Y offset for the current point + Y offset for the current point - Gets the point where the drag started. + Gets the point where the drag started. If the @gesture is active, this function returns %TRUE and fills in @x and @y with the drag start coordinates, in surface-relative coordinates. + - %TRUE if the gesture is active + %TRUE if the gesture is active - a `GtkGesture` + a `GtkGesture` - X coordinate for the drag start point + X coordinate for the drag start point - Y coordinate for the drag start point + Y coordinate for the drag start point - Emitted whenever dragging starts. + Emitted whenever dragging starts. - X coordinate, relative to the widget allocation + X coordinate, relative to the widget allocation - Y coordinate, relative to the widget allocation + Y coordinate, relative to the widget allocation - Emitted whenever the dragging is finished. + Emitted whenever the dragging is finished. - X offset, relative to the start point + X offset, relative to the start point - Y offset, relative to the start point + Y offset, relative to the start point - Emitted whenever the dragging point moves. + Emitted whenever the dragging point moves. - X offset, relative to the start point + X offset, relative to the start point - Y offset, relative to the start point + Y offset, relative to the start point - + + + - `GtkGestureLongPress` is a `GtkGesture` for long presses. + `GtkGestureLongPress` is a `GtkGesture` for long presses. This gesture is also known as “Press and Hold”. @@ -37771,43 +39503,47 @@ How long the timeout is before the ::pressed signal gets emitted is determined by the [property@Gtk.Settings:gtk-long-press-time] setting. It can be modified by the [property@Gtk.GestureLongPress:delay-factor] property. + - Returns a newly created `GtkGesture` that recognizes long presses. + Returns a newly created `GtkGesture` that recognizes long presses. + - a newly created `GtkGestureLongPress`. + a newly created `GtkGestureLongPress`. - Returns the delay factor. + Returns the delay factor. + - the delay factor + the delay factor - A `GtkGestureLongPress` + A `GtkGestureLongPress` - Applies the given delay factor. + Applies the given delay factor. The default long press time will be multiplied by this value. Valid values are in the range [0.5..2.0]. + - A `GtkGestureLongPress` + A `GtkGestureLongPress` - The delay factor to apply + The delay factor to apply @@ -37815,37 +39551,39 @@ Valid values are in the range [0.5..2.0]. - Factor by which to modify the default timeout. + Factor by which to modify the default timeout. - Emitted whenever a press moved too far, or was released + Emitted whenever a press moved too far, or was released before [signal@Gtk.GestureLongPress::pressed] happened. - Emitted whenever a press goes unmoved/unreleased longer than + Emitted whenever a press goes unmoved/unreleased longer than what the GTK defaults tell. - the X coordinate where the press happened, relative to the widget allocation + the X coordinate where the press happened, relative to the widget allocation - the Y coordinate where the press happened, relative to the widget allocation + the Y coordinate where the press happened, relative to the widget allocation - + + + - `GtkGesturePan` is a `GtkGesture` for pan gestures. + `GtkGesturePan` is a `GtkGesture` for pan gestures. These are drags that are locked to happen along one axis. The axis that a `GtkGesturePan` handles is defined at construct time, and @@ -37859,46 +39597,50 @@ this does not happen. Once a panning gesture along the expected axis is recognized, the [signal@Gtk.GesturePan::pan] signal will be emitted as input events are received, containing the offset in the given axis. + - Returns a newly created `GtkGesture` that recognizes pan gestures. + Returns a newly created `GtkGesture` that recognizes pan gestures. + - a newly created `GtkGesturePan` + a newly created `GtkGesturePan` - expected orientation + expected orientation - Returns the orientation of the pan gestures that this @gesture expects. + Returns the orientation of the pan gestures that this @gesture expects. + - the expected orientation for pan gestures + the expected orientation for pan gestures - A `GtkGesturePan` + A `GtkGesturePan` - Sets the orientation to be expected on pan gestures. + Sets the orientation to be expected on pan gestures. + - A `GtkGesturePan` + A `GtkGesturePan` - expected orientation + expected orientation @@ -37906,77 +39648,84 @@ events are received, containing the offset in the given axis. - The expected orientation of pan gestures. + The expected orientation of pan gestures. - Emitted once a panning gesture along the expected axis is detected. + Emitted once a panning gesture along the expected axis is detected. - current direction of the pan gesture + current direction of the pan gesture - Offset along the gesture orientation + Offset along the gesture orientation - + + + - `GtkGestureRotate` is a `GtkGesture` for 2-finger rotations. + `GtkGestureRotate` is a `GtkGesture` for 2-finger rotations. Whenever the angle between both handled sequences changes, the [signal@Gtk.GestureRotate::angle-changed] signal is emitted. + - Returns a newly created `GtkGesture` that recognizes 2-touch + Returns a newly created `GtkGesture` that recognizes 2-touch rotation gestures. + - a newly created `GtkGestureRotate` + a newly created `GtkGestureRotate` - Gets the angle delta in radians. + Gets the angle delta in radians. If @gesture is active, this function returns the angle difference in radians since the gesture was first recognized. If @gesture is not active, 0 is returned. + - the angle delta in radians + the angle delta in radians - a `GtkGestureRotate` + a `GtkGestureRotate` - Emitted when the angle between both tracked points changes. + Emitted when the angle between both tracked points changes. - Current angle in radians + Current angle in radians - Difference with the starting angle, in radians + Difference with the starting angle, in radians - + + + - `GtkGestureSingle` is a `GtkGestures` subclass optimized for singe-touch + `GtkGestureSingle` is a `GtkGestures` subclass optimized for singe-touch and mouse gestures. Under interaction, these gestures stick to the first interacting sequence, @@ -37990,141 +39739,150 @@ to interact with through [method@Gtk.GestureSingle.set_button], or react to any mouse button by setting it to 0. While the gesture is active, the button being currently pressed can be known through [method@Gtk.GestureSingle.get_current_button]. + - Returns the button number @gesture listens for. + Returns the button number @gesture listens for. If this is 0, the gesture reacts to any button press. + - The button number, or 0 for any button + The button number, or 0 for any button - a `GtkGestureSingle` + a `GtkGestureSingle` - Returns the button number currently interacting + Returns the button number currently interacting with @gesture, or 0 if there is none. + - The current button number + The current button number - a `GtkGestureSingle` + a `GtkGestureSingle` - Returns the event sequence currently interacting with @gesture. + Returns the event sequence currently interacting with @gesture. This is only meaningful if [method@Gtk.Gesture.is_active] returns %TRUE. + - the current sequence + the current sequence - a `GtkGestureSingle` + a `GtkGestureSingle` - Gets whether a gesture is exclusive. + Gets whether a gesture is exclusive. For more information, see [method@Gtk.GestureSingle.set_exclusive]. + - Whether the gesture is exclusive + Whether the gesture is exclusive - a `GtkGestureSingle` + a `GtkGestureSingle` - Returns %TRUE if the gesture is only triggered by touch events. + Returns %TRUE if the gesture is only triggered by touch events. + - %TRUE if the gesture only handles touch events + %TRUE if the gesture only handles touch events - a `GtkGestureSingle` + a `GtkGestureSingle` - Sets the button number @gesture listens to. + Sets the button number @gesture listens to. If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1. + - a `GtkGestureSingle` + a `GtkGestureSingle` - button number to listen to, or 0 for any button + button number to listen to, or 0 for any button - Sets whether @gesture is exclusive. + Sets whether @gesture is exclusive. An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those. + - a `GtkGestureSingle` + a `GtkGestureSingle` - %TRUE to make @gesture exclusive + %TRUE to make @gesture exclusive - Sets whether to handle only touch events. + Sets whether to handle only touch events. If @touch_only is %TRUE, @gesture will only handle events of type %GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE or %GDK_TOUCH_END. If %FALSE, mouse events will be handled too. + - a `GtkGestureSingle` + a `GtkGestureSingle` - whether @gesture handles only touch events + whether @gesture handles only touch events @@ -38132,13 +39890,13 @@ mouse events will be handled too. - Mouse button number to listen to, or 0 to listen for any button. + Mouse button number to listen to, or 0 to listen for any button. - Whether the gesture is exclusive. + Whether the gesture is exclusive. Exclusive gestures only listen to pointer and pointer emulated events. @@ -38146,47 +39904,52 @@ Exclusive gestures only listen to pointer and pointer emulated events. - Whether the gesture handles only touch events. + Whether the gesture handles only touch events. - + + + - `GtkGestureStylus` is a `GtkGesture` specific to stylus input. + `GtkGestureStylus` is a `GtkGesture` specific to stylus input. The provided signals just relay the basic information of the stylus events. + - Creates a new `GtkGestureStylus`. + Creates a new `GtkGestureStylus`. + - a newly created stylus gesture + a newly created stylus gesture - Returns the current values for the requested @axes. + Returns the current values for the requested @axes. This function must be called from the handler of one of the [signal@Gtk.GestureStylus::down], [signal@Gtk.GestureStylus::motion], [signal@Gtk.GestureStylus::up] or [signal@Gtk.GestureStylus::proximity] signals. + - %TRUE if there is a current value for the axes + %TRUE if there is a current value for the axes - a `GtkGestureStylus` + a `GtkGestureStylus` - array of requested axes, terminated with %GDK_AXIS_IGNORE + array of requested axes, terminated with %GDK_AXIS_IGNORE - return location for the axis values + return location for the axis values @@ -38194,33 +39957,34 @@ signals. - Returns the current value for the requested @axis. + Returns the current value for the requested @axis. This function must be called from the handler of one of the [signal@Gtk.GestureStylus::down], [signal@Gtk.GestureStylus::motion], [signal@Gtk.GestureStylus::up] or [signal@Gtk.GestureStylus::proximity] signals. + - %TRUE if there is a current value for the axis + %TRUE if there is a current value for the axis - a `GtkGestureStylus` + a `GtkGestureStylus` - requested device axis + requested device axis - return location for the axis value + return location for the axis value - Returns the accumulated backlog of tracking information. + Returns the accumulated backlog of tracking information. By default, GTK will limit rate of input events. On stylus input where accuracy of strokes is paramount, this function returns the @@ -38233,113 +39997,117 @@ signal handler, the state given in this signal and obtainable through state in motion history. The @backlog is provided in chronological order. + - %TRUE if there is a backlog to unfold in the current state. + %TRUE if there is a backlog to unfold in the current state. - a `GtkGestureStylus` + a `GtkGestureStylus` - coordinates and times for the backlog events + coordinates and times for the backlog events - return location for the number of elements + return location for the number of elements - Returns the `GdkDeviceTool` currently driving input through this gesture. + Returns the `GdkDeviceTool` currently driving input through this gesture. This function must be called from the handler of one of the [signal@Gtk.GestureStylus::down], [signal@Gtk.GestureStylus::motion], [signal@Gtk.GestureStylus::up] or [signal@Gtk.GestureStylus::proximity] signals. + - The current stylus tool + The current stylus tool - a `GtkGestureStylus` + a `GtkGestureStylus` - Emitted when the stylus touches the device. + Emitted when the stylus touches the device. - the X coordinate of the stylus event + the X coordinate of the stylus event - the Y coordinate of the stylus event + the Y coordinate of the stylus event - Emitted when the stylus moves while touching the device. + Emitted when the stylus moves while touching the device. - the X coordinate of the stylus event + the X coordinate of the stylus event - the Y coordinate of the stylus event + the Y coordinate of the stylus event - Emitted when the stylus is in proximity of the device. + Emitted when the stylus is in proximity of the device. - the X coordinate of the stylus event + the X coordinate of the stylus event - the Y coordinate of the stylus event + the Y coordinate of the stylus event - Emitted when the stylus no longer touches the device. + Emitted when the stylus no longer touches the device. - the X coordinate of the stylus event + the X coordinate of the stylus event - the Y coordinate of the stylus event + the Y coordinate of the stylus event - + + + - `GtkGestureSwipe` is a `GtkGesture` for swipe gestures. + `GtkGestureSwipe` is a `GtkGesture` for swipe gestures. After a press/move/.../move/release sequence happens, the [signal@Gtk.GestureSwipe::swipe] signal will be emitted, @@ -38351,40 +40119,43 @@ If the velocity is desired in intermediate points, [signal@Gtk.Gesture::update] handler. All velocities are reported in pixels/sec units. + - Returns a newly created `GtkGesture` that recognizes swipes. + Returns a newly created `GtkGesture` that recognizes swipes. + - a newly created `GtkGestureSwipe` + a newly created `GtkGestureSwipe` - Gets the current velocity. + Gets the current velocity. If the gesture is recognized, this function returns %TRUE and fills in @velocity_x and @velocity_y with the recorded velocity, as per the last events processed. + - whether velocity could be calculated + whether velocity could be calculated - a `GtkGestureSwipe` + a `GtkGestureSwipe` - return value for the velocity in the X axis, in pixels/sec + return value for the velocity in the X axis, in pixels/sec - return value for the velocity in the Y axis, in pixels/sec + return value for the velocity in the Y axis, in pixels/sec - Emitted when the recognized gesture is finished. + Emitted when the recognized gesture is finished. Velocity and direction are a product of previously recorded events. @@ -38392,65 +40163,72 @@ Velocity and direction are a product of previously recorded events. - velocity in the X axis, in pixels/sec + velocity in the X axis, in pixels/sec - velocity in the Y axis, in pixels/sec + velocity in the Y axis, in pixels/sec - + + + - `GtkGestureZoom` is a `GtkGesture` for 2-finger pinch/zoom gestures. + `GtkGestureZoom` is a `GtkGesture` for 2-finger pinch/zoom gestures. Whenever the distance between both tracked sequences changes, the [signal@Gtk.GestureZoom::scale-changed] signal is emitted to report the scale factor. + - Returns a newly created `GtkGesture` that recognizes + Returns a newly created `GtkGesture` that recognizes pinch/zoom gestures. + - a newly created `GtkGestureZoom` + a newly created `GtkGestureZoom` - Gets the scale delta. + Gets the scale delta. If @gesture is active, this function returns the zooming difference since the gesture was recognized (hence the starting point is considered 1:1). If @gesture is not active, 1 is returned. + - the scale delta + the scale delta - a `GtkGestureZoom` + a `GtkGestureZoom` - Emitted whenever the distance between both tracked sequences changes. + Emitted whenever the distance between both tracked sequences changes. - Scale delta, taking the initial state as 1:1 + Scale delta, taking the initial state as 1:1 - + + + - `GtkGrid` is a container which arranges its child widgets in + `GtkGrid` is a container which arranges its child widgets in rows and columns. ![An example GtkGrid](grid.png) @@ -38532,55 +40310,58 @@ defined by the `column-span` property. # Accessibility `GtkGrid` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. + - Creates a new grid widget. + Creates a new grid widget. + - the new `GtkGrid` + the new `GtkGrid` - Adds a widget to the grid. + Adds a widget to the grid. The position of @child is determined by @column and @row. The number of “cells” that @child will occupy is determined by @width and @height. + - a `GtkGrid` + a `GtkGrid` - the widget to add + the widget to add - the column number to attach the left side of @child to + the column number to attach the left side of @child to - the row number to attach the top side of @child to + the row number to attach the top side of @child to - the number of columns that @child will span + the number of columns that @child will span - the number of rows that @child will span + the number of rows that @child will span - Adds a widget to the grid. + Adds a widget to the grid. The widget is placed next to @sibling, on the side determined by @side. When @sibling is %NULL, the widget is placed in row (for @@ -38589,415 +40370,436 @@ at the end indicated by @side. Attaching widgets labeled `[1]`, `[2]`, `[3]` with `@sibling == %NULL` and `@side == %GTK_POS_LEFT` yields a layout of `[3][2][1]`. + - a `GtkGrid` + a `GtkGrid` - the widget to add + the widget to add - the child of @grid that @child will be placed + the child of @grid that @child will be placed next to, or %NULL to place @child at the beginning or end - the side of @sibling that @child is positioned next to + the side of @sibling that @child is positioned next to - the number of columns that @child will span + the number of columns that @child will span - the number of rows that @child will span + the number of rows that @child will span - Returns which row defines the global baseline of @grid. + Returns which row defines the global baseline of @grid. + - the row index defining the global baseline + the row index defining the global baseline - a `GtkGrid` + a `GtkGrid` - Gets the child of @grid whose area covers the grid + Gets the child of @grid whose area covers the grid cell at @column, @row. + - the child at the given position + the child at the given position - a `GtkGrid` + a `GtkGrid` - the left edge of the cell + the left edge of the cell - the top edge of the cell + the top edge of the cell - Returns whether all columns of @grid have the same width. + Returns whether all columns of @grid have the same width. + - whether all columns of @grid have the same width. + whether all columns of @grid have the same width. - a `GtkGrid` + a `GtkGrid` - Returns the amount of space between the columns of @grid. + Returns the amount of space between the columns of @grid. + - the column spacing of @grid + the column spacing of @grid - a `GtkGrid` + a `GtkGrid` - Returns the baseline position of @row. + Returns the baseline position of @row. See [method@Gtk.Grid.set_row_baseline_position]. + - the baseline position of @row + the baseline position of @row - a `GtkGrid` + a `GtkGrid` - a row index + a row index - Returns whether all rows of @grid have the same height. + Returns whether all rows of @grid have the same height. + - whether all rows of @grid have the same height. + whether all rows of @grid have the same height. - a `GtkGrid` + a `GtkGrid` - Returns the amount of space between the rows of @grid. + Returns the amount of space between the rows of @grid. + - the row spacing of @grid + the row spacing of @grid - a `GtkGrid` + a `GtkGrid` - Inserts a column at the specified position. + Inserts a column at the specified position. Children which are attached at or to the right of this position are moved one column to the right. Children which span across this position are grown to span the new column. + - a `GtkGrid` + a `GtkGrid` - the position to insert the column at + the position to insert the column at - Inserts a row or column at the specified position. + Inserts a row or column at the specified position. The new row or column is placed next to @sibling, on the side determined by @side. If @side is %GTK_POS_TOP or %GTK_POS_BOTTOM, a row is inserted. If @side is %GTK_POS_LEFT of %GTK_POS_RIGHT, a column is inserted. + - a `GtkGrid` + a `GtkGrid` - the child of @grid that the new row or column will be + the child of @grid that the new row or column will be placed next to - the side of @sibling that @child is positioned next to + the side of @sibling that @child is positioned next to - Inserts a row at the specified position. + Inserts a row at the specified position. Children which are attached at or below this position are moved one row down. Children which span across this position are grown to span the new row. + - a `GtkGrid` + a `GtkGrid` - the position to insert the row at + the position to insert the row at - Queries the attach points and spans of @child inside the given `GtkGrid`. + Queries the attach points and spans of @child inside the given `GtkGrid`. + - a `GtkGrid` + a `GtkGrid` - a `GtkWidget` child of @grid + a `GtkWidget` child of @grid - the column used to attach the left side of @child + the column used to attach the left side of @child - the row used to attach the top side of @child + the row used to attach the top side of @child - the number of columns @child spans + the number of columns @child spans - the number of rows @child spans + the number of rows @child spans - Removes a child from @grid. + Removes a child from @grid. The child must have been added with [method@Gtk.Grid.attach] or [method@Gtk.Grid.attach_next_to]. + - a `GtkGrid` + a `GtkGrid` - the child widget to remove + the child widget to remove - Removes a column from the grid. + Removes a column from the grid. Children that are placed in this column are removed, spanning children that overlap this column have their width reduced by one, and children after the column are moved to the left. + - a `GtkGrid` + a `GtkGrid` - the position of the column to remove + the position of the column to remove - Removes a row from the grid. + Removes a row from the grid. Children that are placed in this row are removed, spanning children that overlap this row have their height reduced by one, and children below the row are moved up. + - a `GtkGrid` + a `GtkGrid` - the position of the row to remove + the position of the row to remove - Sets which row defines the global baseline for the entire grid. + Sets which row defines the global baseline for the entire grid. Each row in the grid can have its own local baseline, but only one of those is global, meaning it will be the baseline in the parent of the @grid. + - a `GtkGrid` + a `GtkGrid` - the row index + the row index - Sets whether all columns of @grid will have the same width. + Sets whether all columns of @grid will have the same width. + - a `GtkGrid` + a `GtkGrid` - %TRUE to make columns homogeneous + %TRUE to make columns homogeneous - Sets the amount of space between columns of @grid. + Sets the amount of space between columns of @grid. + - a `GtkGrid` + a `GtkGrid` - the amount of space to insert between columns + the amount of space to insert between columns - Sets how the baseline should be positioned on @row of the + Sets how the baseline should be positioned on @row of the grid, in case that row is assigned more space than is requested. The default baseline position is %GTK_BASELINE_POSITION_CENTER. + - a `GtkGrid` + a `GtkGrid` - a row index + a row index - a `GtkBaselinePosition` + a `GtkBaselinePosition` - Sets whether all rows of @grid will have the same height. + Sets whether all rows of @grid will have the same height. + - a `GtkGrid` + a `GtkGrid` - %TRUE to make rows homogeneous + %TRUE to make rows homogeneous - Sets the amount of space between rows of @grid. + Sets the amount of space between rows of @grid. + - a `GtkGrid` + a `GtkGrid` - the amount of space to insert between rows + the amount of space to insert between rows @@ -39005,31 +40807,31 @@ The default baseline position is %GTK_BASELINE_POSITION_CENTER. - The row to align to the baseline when valign is %GTK_ALIGN_BASELINE. + The row to align to the baseline when valign is %GTK_ALIGN_BASELINE. - If %TRUE, the columns are all the same width. + If %TRUE, the columns are all the same width. - The amount of space between two consecutive columns. + The amount of space between two consecutive columns. - If %TRUE, the rows are all the same height. + If %TRUE, the rows are all the same height. - The amount of space between two consecutive rows. + The amount of space between two consecutive rows. @@ -39037,8 +40839,9 @@ The default baseline position is %GTK_BASELINE_POSITION_CENTER. + - The parent class. + The parent class. @@ -39048,7 +40851,7 @@ The default baseline position is %GTK_BASELINE_POSITION_CENTER. - `GtkGridLayout` is a layout manager which arranges child widgets in + `GtkGridLayout` is a layout manager which arranges child widgets in rows and columns. Children have an "attach point" defined by the horizontal and vertical @@ -39062,211 +40865,225 @@ grid cell is undefined. `GtkGridLayout` can be used like a `GtkBoxLayout` if all children are attached to the same row or column; however, if you only ever need a single row or column, you should consider using `GtkBoxLayout`. + - Creates a new `GtkGridLayout`. + Creates a new `GtkGridLayout`. + - the newly created `GtkGridLayout` + the newly created `GtkGridLayout` - Retrieves the row set with gtk_grid_layout_set_baseline_row(). + Retrieves the row set with gtk_grid_layout_set_baseline_row(). + - the global baseline row + the global baseline row - a `GtkGridLayout` + a `GtkGridLayout` - Checks whether all columns of @grid should have the same width. + Checks whether all columns of @grid should have the same width. + - %TRUE if the columns are homogeneous, and %FALSE otherwise + %TRUE if the columns are homogeneous, and %FALSE otherwise - a `GtkGridLayout` + a `GtkGridLayout` - Retrieves the spacing set with gtk_grid_layout_set_column_spacing(). + Retrieves the spacing set with gtk_grid_layout_set_column_spacing(). + - the spacing between consecutive columns + the spacing between consecutive columns - a `GtkGridLayout` + a `GtkGridLayout` - Returns the baseline position of @row. + Returns the baseline position of @row. If no value has been set with [method@Gtk.GridLayout.set_row_baseline_position], the default value of %GTK_BASELINE_POSITION_CENTER is returned. + - the baseline position of @row + the baseline position of @row - a `GtkGridLayout` + a `GtkGridLayout` - a row index + a row index - Checks whether all rows of @grid should have the same height. + Checks whether all rows of @grid should have the same height. + - %TRUE if the rows are homogeneous, and %FALSE otherwise + %TRUE if the rows are homogeneous, and %FALSE otherwise - a `GtkGridLayout` + a `GtkGridLayout` - Retrieves the spacing set with gtk_grid_layout_set_row_spacing(). + Retrieves the spacing set with gtk_grid_layout_set_row_spacing(). + - the spacing between consecutive rows + the spacing between consecutive rows - a `GtkGridLayout` + a `GtkGridLayout` - Sets which row defines the global baseline for the entire grid. + Sets which row defines the global baseline for the entire grid. Each row in the grid can have its own local baseline, but only one of those is global, meaning it will be the baseline in the parent of the @grid. + - a `GtkGridLayout` + a `GtkGridLayout` - the row index + the row index - Sets whether all columns of @grid should have the same width. + Sets whether all columns of @grid should have the same width. + - a `GtkGridLayout` + a `GtkGridLayout` - %TRUE to make columns homogeneous + %TRUE to make columns homogeneous - Sets the amount of space to insert between consecutive columns. + Sets the amount of space to insert between consecutive columns. + - a `GtkGridLayout` + a `GtkGridLayout` - the amount of space between columns, in pixels + the amount of space between columns, in pixels - Sets how the baseline should be positioned on @row of the + Sets how the baseline should be positioned on @row of the grid, in case that row is assigned more space than is requested. + - a `GtkGridLayout` + a `GtkGridLayout` - a row index + a row index - a `GtkBaselinePosition` + a `GtkBaselinePosition` - Sets whether all rows of @grid should have the same height. + Sets whether all rows of @grid should have the same height. + - a `GtkGridLayout` + a `GtkGridLayout` - %TRUE to make rows homogeneous + %TRUE to make rows homogeneous - Sets the amount of space to insert between consecutive rows. + Sets the amount of space to insert between consecutive rows. + - a `GtkGridLayout` + a `GtkGridLayout` - the amount of space between rows, in pixels + the amount of space between rows, in pixels @@ -39274,157 +41091,166 @@ grid, in case that row is assigned more space than is requested. - The row to align to the baseline, when `GtkWidget:valign` is set + The row to align to the baseline, when `GtkWidget:valign` is set to %GTK_ALIGN_BASELINE. - Whether all the columns in the grid have the same width. + Whether all the columns in the grid have the same width. - The amount of space between to consecutive columns. + The amount of space between to consecutive columns. - Whether all the rows in the grid have the same height. + Whether all the rows in the grid have the same height. - The amount of space between to consecutive rows. + The amount of space between to consecutive rows. - `GtkLayoutChild` subclass for children in a `GtkGridLayout`. + `GtkLayoutChild` subclass for children in a `GtkGridLayout`. + - Retrieves the column number to which @child attaches its left side. + Retrieves the column number to which @child attaches its left side. + - the column number + the column number - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - Retrieves the number of columns that @child spans to. + Retrieves the number of columns that @child spans to. + - the number of columns + the number of columns - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - Retrieves the row number to which @child attaches its top side. + Retrieves the row number to which @child attaches its top side. + - the row number + the row number - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - Retrieves the number of rows that @child spans to. + Retrieves the number of rows that @child spans to. + - the number of row + the number of row - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - Sets the column number to attach the left side of @child. + Sets the column number to attach the left side of @child. + - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - the attach point for @child + the attach point for @child - Sets the number of columns @child spans to. + Sets the number of columns @child spans to. + - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - the span of @child + the span of @child - Sets the row to place @child in. + Sets the row to place @child in. + - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - the row for @child + the row for @child - Sets the number of rows @child spans to. + Sets the number of rows @child spans to. + - a `GtkGridLayoutChild` + a `GtkGridLayoutChild` - the span of @child + the span of @child @@ -39432,40 +41258,42 @@ to %GTK_ALIGN_BASELINE. - The column to place the child in. + The column to place the child in. - The number of columns the child spans to. + The number of columns the child spans to. - The row to place the child in. + The row to place the child in. - The number of rows the child spans to. + The number of rows the child spans to. + + - `GtkGridView` presents a large dynamic grid of items. + `GtkGridView` presents a large dynamic grid of items. `GtkGridView` uses its factory to generate one child widget for each visible item and shows them in a grid. The orientation of the grid view @@ -39500,13 +41328,14 @@ class. For rubberband selection, a subnode with name `rubberband` is used. `GtkGridView` uses the %GTK_ACCESSIBLE_ROLE_GRID role, and the items use the %GTK_ACCESSIBLE_ROLE_GRID_CELL role. + - Creates a new `GtkGridView` that uses the given @factory for + Creates a new `GtkGridView` that uses the given @factory for mapping items to widgets. The function takes ownership of the @@ -39515,217 +41344,230 @@ arguments, so you can write code like grid_view = gtk_grid_view_new (create_model (), gtk_builder_list_item_factory_new_from_resource ("/resource.ui")); ``` + - a new `GtkGridView` using the given @model and @factory + a new `GtkGridView` using the given @model and @factory - the model to use + the model to use - The factory to populate items with + The factory to populate items with - Returns whether rows can be selected by dragging with the mouse. + Returns whether rows can be selected by dragging with the mouse. + - %TRUE if rubberband selection is enabled + %TRUE if rubberband selection is enabled - a `GtkGridView` + a `GtkGridView` - Gets the factory that's currently used to populate list items. + Gets the factory that's currently used to populate list items. + - The factory in use + The factory in use - a `GtkGridView` + a `GtkGridView` - Gets the maximum number of columns that the grid will use. + Gets the maximum number of columns that the grid will use. + - The maximum number of columns + The maximum number of columns - a `GtkGridView` + a `GtkGridView` - Gets the minimum number of columns that the grid will use. + Gets the minimum number of columns that the grid will use. + - The minimum number of columns + The minimum number of columns - a `GtkGridView` + a `GtkGridView` - Gets the model that's currently used to read the items displayed. + Gets the model that's currently used to read the items displayed. + - The model in use + The model in use - a `GtkGridView` + a `GtkGridView` - Returns whether items will be activated on single click and + Returns whether items will be activated on single click and selected on hover. + - %TRUE if items are activated on single click + %TRUE if items are activated on single click - a `GtkGridView` + a `GtkGridView` - Sets whether selections can be changed by dragging with the mouse. + Sets whether selections can be changed by dragging with the mouse. + - a `GtkGridView` + a `GtkGridView` - %TRUE to enable rubberband selection + %TRUE to enable rubberband selection - Sets the `GtkListItemFactory` to use for populating list items. + Sets the `GtkListItemFactory` to use for populating list items. + - a `GtkGridView` + a `GtkGridView` - the factory to use + the factory to use - Sets the maximum number of columns to use. + Sets the maximum number of columns to use. This number must be at least 1. If @max_columns is smaller than the minimum set via [method@Gtk.GridView.set_min_columns], that value is used instead. + - a `GtkGridView` + a `GtkGridView` - The maximum number of columns + The maximum number of columns - Sets the minimum number of columns to use. + Sets the minimum number of columns to use. This number must be at least 1. If @min_columns is smaller than the minimum set via [method@Gtk.GridView.set_max_columns], that value is ignored. + - a `GtkGridView` + a `GtkGridView` - The minimum number of columns + The minimum number of columns - Sets the imodel to use. + Sets the imodel to use. This must be a [iface@Gtk.SelectionModel]. + - a `GtkGridView` + a `GtkGridView` - the model to use + the model to use - Sets whether items should be activated on single click and + Sets whether items should be activated on single click and selected on hover. + - a `GtkGridView` + a `GtkGridView` - %TRUE to activate items on single click + %TRUE to activate items on single click @@ -39733,19 +41575,19 @@ selected on hover. - Allow rubberband selection. + Allow rubberband selection. - Factory for populating list items. + Factory for populating list items. - Maximum number of columns per row. + Maximum number of columns per row. If this number is smaller than [property@Gtk.GridView:min-columns], that value is used instead. @@ -39754,23 +41596,23 @@ that value is used instead. - Minimum number of columns per row. + Minimum number of columns per row. - Model for the items displayed. + Model for the items displayed. - Activate rows on single click and select them on hover. + Activate rows on single click and select them on hover. - Emitted when a cell has been activated by the user, + Emitted when a cell has been activated by the user, usually via activating the GtkGridView|list.activate-item action. This allows for a convenient way to handle activation in a gridview. @@ -39781,21 +41623,24 @@ this signal. - position of item to activate + position of item to activate - + + + + - `GtkHeaderBar` is a widget for creating custom title bars for windows. + `GtkHeaderBar` is a widget for creating custom title bars for windows. ![An example GtkHeaderBar](headerbar.png) @@ -39870,114 +41715,121 @@ Each of the boxes contains a `windowcontrols` subnode, see - Creates a new `GtkHeaderBar` widget. + Creates a new `GtkHeaderBar` widget. + - a new `GtkHeaderBar` + a new `GtkHeaderBar` - Gets the decoration layout of the `GtkHeaderBar`. + Gets the decoration layout of the `GtkHeaderBar`. + - the decoration layout + the decoration layout - a `GtkHeaderBar` + a `GtkHeaderBar` - Returns whether this header bar shows the standard window + Returns whether this header bar shows the standard window title buttons. + - %TRUE if title buttons are shown + %TRUE if title buttons are shown - a `GtkHeaderBar` + a `GtkHeaderBar` - Retrieves the title widget of the header. + Retrieves the title widget of the header. See [method@Gtk.HeaderBar.set_title_widget]. + - the title widget of the header + the title widget of the header - a `GtkHeaderBar` + a `GtkHeaderBar` - Adds @child to @bar, packed with reference to the + Adds @child to @bar, packed with reference to the end of the @bar. + - A `GtkHeaderBar` + A `GtkHeaderBar` - the `GtkWidget` to be added to @bar + the `GtkWidget` to be added to @bar - Adds @child to @bar, packed with reference to the + Adds @child to @bar, packed with reference to the start of the @bar. + - A `GtkHeaderBar` + A `GtkHeaderBar` - the `GtkWidget` to be added to @bar + the `GtkWidget` to be added to @bar - Removes a child from the `GtkHeaderBar`. + Removes a child from the `GtkHeaderBar`. The child must have been added with [method@Gtk.HeaderBar.pack_start], [method@Gtk.HeaderBar.pack_end] or [method@Gtk.HeaderBar.set_title_widget]. + - a `GtkHeaderBar` + a `GtkHeaderBar` - the child to remove + the child to remove - Sets the decoration layout for this header bar. + Sets the decoration layout for this header bar. This property overrides the [property@Gtk.Settings:gtk-decoration-layout] setting. @@ -39994,40 +41846,42 @@ maximize, close and icon (the window icon). For example, “icon:minimize,maximize,close” specifies a icon on the left, and minimize, maximize and close buttons on the right. + - a `GtkHeaderBar` + a `GtkHeaderBar` - a decoration layout, or %NULL to unset the layout + a decoration layout, or %NULL to unset the layout - Sets whether this header bar shows the standard window + Sets whether this header bar shows the standard window title buttons. + - a `GtkHeaderBar` + a `GtkHeaderBar` - %TRUE to show standard title buttons + %TRUE to show standard title buttons - Sets the title for the `GtkHeaderBar`. + Sets the title for the `GtkHeaderBar`. When set to %NULL, the headerbar will display the title of the window it is contained in. @@ -40038,16 +41892,17 @@ To achieve the same style as the builtin title, use the You should set the title widget to %NULL, for the window title label to be visible again. + - a `GtkHeaderBar` + a `GtkHeaderBar` - a widget to use for a title + a widget to use for a title @@ -40055,7 +41910,7 @@ title label to be visible again. - The decoration layout for buttons. + The decoration layout for buttons. If this property is not set, the [property@Gtk.Settings:gtk-decoration-layout] setting is used. @@ -40064,7 +41919,7 @@ If this property is not set, the - Whether to show title buttons like close, minimize, maximize. + Whether to show title buttons like close, minimize, maximize. Which buttons are actually shown and where is determined by the [property@Gtk.HeaderBar:decoration-layout] property, @@ -40077,31 +41932,35 @@ be shown if the window can't be closed). + + + + - `GtkIMContext` defines the interface for GTK input methods. + `GtkIMContext` defines the interface for GTK input methods. `GtkIMContext` is used by GTK text input widgets like `GtkText` to map from key events to Unicode character strings. @@ -40130,7 +41989,9 @@ provides a `GIOExtension` for the extension point named "gtk-im-module". To connect a widget to the users preferred input method, you should use [class@Gtk.IMMulticontext]. + + @@ -40144,7 +42005,7 @@ To connect a widget to the users preferred input method, you should use - Asks the widget that the input context is attached to delete + Asks the widget that the input context is attached to delete characters around the cursor position by emitting the `::delete_surrounding` signal. @@ -40161,112 +42022,117 @@ have deleted all the characters that were requested to be deleted. This function is used by an input method that wants to make subsitutions in the existing text in response to new input. It is not useful for applications. + - %TRUE if the signal was handled. + %TRUE if the signal was handled. - a `GtkIMContext` + a `GtkIMContext` - offset from cursor position in chars; + offset from cursor position in chars; a negative value means start before the cursor. - number of characters to delete. + number of characters to delete. - Allow an input method to internally handle key press and release + Allow an input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. + - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a `GtkIMContext` + a `GtkIMContext` - the key event + the key event - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change. + - a `GtkIMContext` + a `GtkIMContext` - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change. + - a `GtkIMContext` + a `GtkIMContext` - Retrieve the current preedit string for the input context, + Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point. + - a `GtkIMContext` + a `GtkIMContext` - location to store the retrieved + location to store the retrieved string. The string retrieved must be freed with g_free(). - location to store the retrieved + location to store the retrieved attribute list. When you are done with this list, you must unreference it with [method@Pango.AttrList.unref]. - location to store position of cursor + location to store position of cursor (in characters) within the preedit string. - Retrieves context around the insertion point. + Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai @@ -40282,32 +42148,33 @@ Note that there is no obligation for a widget to respond to the `::retrieve-surrounding` signal, so input methods must be prepared to function without context. Use [method@Gtk.IMContext.get_surrounding_with_selection] instead. + - `TRUE` if surrounding text was provided; in this case + `TRUE` if surrounding text was provided; in this case you must free the result stored in `text`. - a `GtkIMContext` + a `GtkIMContext` - location to store a UTF-8 encoded + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - location to store byte index of the insertion + location to store byte index of the insertion cursor within @text. - Retrieves context around the insertion point. + Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such @@ -40322,36 +42189,38 @@ is available, up to an entire paragraph, by calling Note that there is no obligation for a widget to respond to the `::retrieve-surrounding` signal, so input methods must be prepared to function without context. + - `TRUE` if surrounding text was provided; in this case + `TRUE` if surrounding text was provided; in this case you must free the result stored in `text`. - a `GtkIMContext` + a `GtkIMContext` - location to store a UTF-8 encoded + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - location to store byte index of the insertion + location to store byte index of the insertion cursor within @text. - location to store byte index of the selection + location to store byte index of the selection bound within @text + @@ -40362,6 +42231,7 @@ function without context. + @@ -40372,6 +42242,7 @@ function without context. + @@ -40382,21 +42253,23 @@ function without context. - Notify the input method that a change such as a change in cursor + Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state. + - a `GtkIMContext` + a `GtkIMContext` + @@ -40407,131 +42280,136 @@ This will typically cause the input method to clear the preedit state. - Set the client widget for the input context. + Set the client widget for the input context. This is the `GtkWidget` holding the input focus. This widget is used in order to correctly position status windows, and may also be used for purposes internal to the input method. + - a `GtkIMContext` + a `GtkIMContext` - the client widget. This may be %NULL to indicate + the client widget. This may be %NULL to indicate that the previous client widget no longer exists. - Notify the input method that a change in cursor + Notify the input method that a change in cursor position has been made. The location is relative to the client widget. + - a `GtkIMContext` + a `GtkIMContext` - new location + new location - Sets surrounding context around the insertion point and preedit + Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the [signal@Gtk.IMContext::retrieve-surrounding] signal, and will likely have no effect if called at other times. Use [method@Gtk.IMContext.set_surrounding_with_selection] instead + - a `GtkIMContext` + a `GtkIMContext` - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - Sets surrounding context around the insertion point and preedit + Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the [signal@Gtk.IMContext::retrieve_surrounding] signal, and will likely have no effect if called at other times. + - a `GtkIMContext` + a `GtkIMContext` - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text + the byte index of the insertion cursor within @text - the byte index of the selection bound within @text + the byte index of the selection bound within @text - Sets whether the IM context should use the preedit string + Sets whether the IM context should use the preedit string to display feedback. If @use_preedit is %FALSE (default is %TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window. + - a `GtkIMContext` + a `GtkIMContext` - whether the IM context should use the preedit string. + whether the IM context should use the preedit string. - Asks the widget that the input context is attached to delete + Asks the widget that the input context is attached to delete characters around the cursor position by emitting the `::delete_surrounding` signal. @@ -40548,155 +42426,161 @@ have deleted all the characters that were requested to be deleted. This function is used by an input method that wants to make subsitutions in the existing text in response to new input. It is not useful for applications. + - %TRUE if the signal was handled. + %TRUE if the signal was handled. - a `GtkIMContext` + a `GtkIMContext` - offset from cursor position in chars; + offset from cursor position in chars; a negative value means start before the cursor. - number of characters to delete. + number of characters to delete. - Allow an input method to forward key press and release events + Allow an input method to forward key press and release events to another input method without necessarily having a `GdkEvent` available. + - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a `GtkIMContext` + a `GtkIMContext` - whether to forward a key press or release event + whether to forward a key press or release event - the surface the event is for + the surface the event is for - the device that the event is for + the device that the event is for - the timestamp for the event + the timestamp for the event - the keycode for the event + the keycode for the event - modifier state for the event + modifier state for the event - the active keyboard group for the event + the active keyboard group for the event - Allow an input method to internally handle key press and release + Allow an input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. + - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a `GtkIMContext` + a `GtkIMContext` - the key event + the key event - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change. + - a `GtkIMContext` + a `GtkIMContext` - Notify the input method that the widget to which this + Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change. + - a `GtkIMContext` + a `GtkIMContext` - Retrieve the current preedit string for the input context, + Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point. + - a `GtkIMContext` + a `GtkIMContext` - location to store the retrieved + location to store the retrieved string. The string retrieved must be freed with g_free(). - location to store the retrieved + location to store the retrieved attribute list. When you are done with this list, you must unreference it with [method@Pango.AttrList.unref]. - location to store position of cursor + location to store position of cursor (in characters) within the preedit string. - Retrieves context around the insertion point. + Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai @@ -40712,32 +42596,33 @@ Note that there is no obligation for a widget to respond to the `::retrieve-surrounding` signal, so input methods must be prepared to function without context. Use [method@Gtk.IMContext.get_surrounding_with_selection] instead. + - `TRUE` if surrounding text was provided; in this case + `TRUE` if surrounding text was provided; in this case you must free the result stored in `text`. - a `GtkIMContext` + a `GtkIMContext` - location to store a UTF-8 encoded + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - location to store byte index of the insertion + location to store byte index of the insertion cursor within @text. - Retrieves context around the insertion point. + Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such @@ -40752,181 +42637,188 @@ is available, up to an entire paragraph, by calling Note that there is no obligation for a widget to respond to the `::retrieve-surrounding` signal, so input methods must be prepared to function without context. + - `TRUE` if surrounding text was provided; in this case + `TRUE` if surrounding text was provided; in this case you must free the result stored in `text`. - a `GtkIMContext` + a `GtkIMContext` - location to store a UTF-8 encoded + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - location to store byte index of the insertion + location to store byte index of the insertion cursor within @text. - location to store byte index of the selection + location to store byte index of the selection bound within @text - Notify the input method that a change such as a change in cursor + Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state. + - a `GtkIMContext` + a `GtkIMContext` - Set the client widget for the input context. + Set the client widget for the input context. This is the `GtkWidget` holding the input focus. This widget is used in order to correctly position status windows, and may also be used for purposes internal to the input method. + - a `GtkIMContext` + a `GtkIMContext` - the client widget. This may be %NULL to indicate + the client widget. This may be %NULL to indicate that the previous client widget no longer exists. - Notify the input method that a change in cursor + Notify the input method that a change in cursor position has been made. The location is relative to the client widget. + - a `GtkIMContext` + a `GtkIMContext` - new location + new location - Sets surrounding context around the insertion point and preedit + Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the [signal@Gtk.IMContext::retrieve-surrounding] signal, and will likely have no effect if called at other times. Use [method@Gtk.IMContext.set_surrounding_with_selection] instead + - a `GtkIMContext` + a `GtkIMContext` - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - Sets surrounding context around the insertion point and preedit + Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the [signal@Gtk.IMContext::retrieve_surrounding] signal, and will likely have no effect if called at other times. + - a `GtkIMContext` + a `GtkIMContext` - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text + the byte index of the insertion cursor within @text - the byte index of the selection bound within @text + the byte index of the selection bound within @text - Sets whether the IM context should use the preedit string + Sets whether the IM context should use the preedit string to display feedback. If @use_preedit is %FALSE (default is %TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window. + - a `GtkIMContext` + a `GtkIMContext` - whether the IM context should use the preedit string. + whether the IM context should use the preedit string. - Additional hints that allow input methods to fine-tune + Additional hints that allow input methods to fine-tune their behaviour. - The purpose of the text field that the `GtkIMContext is connected to. + The purpose of the text field that the `GtkIMContext is connected to. This property can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -40936,7 +42828,7 @@ methods to adjust their behaviour. - The ::commit signal is emitted when a complete input sequence + The ::commit signal is emitted when a complete input sequence has been entered by the user. If the commit comes after a preediting sequence, the @@ -40949,33 +42841,33 @@ the final result of preediting. - the completed character(s) entered by the user + the completed character(s) entered by the user - The ::delete-surrounding signal is emitted when the input method + The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. - %TRUE if the signal was handled. + %TRUE if the signal was handled. - the character offset from the cursor position of the text + the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor. - the number of characters to be deleted + the number of characters to be deleted - The ::preedit-changed signal is emitted whenever the preedit sequence + The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case @@ -40985,37 +42877,39 @@ It is also emitted at the end of a preedit sequence, in which case - The ::preedit-end signal is emitted when a preediting sequence + The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled. - The ::preedit-start signal is emitted when a new preediting sequence + The ::preedit-start signal is emitted when a new preediting sequence starts. - The ::retrieve-surrounding signal is emitted when the input method + The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor. The callback should set the input method surrounding context by calling the [method@Gtk.IMContext.set_surrounding] method. - %TRUE if the signal was handled. + %TRUE if the signal was handled. + + @@ -41028,6 +42922,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41040,6 +42935,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41052,6 +42948,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41067,6 +42964,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41079,22 +42977,23 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - %TRUE if the signal was handled. + %TRUE if the signal was handled. - a `GtkIMContext` + a `GtkIMContext` - offset from cursor position in chars; + offset from cursor position in chars; a negative value means start before the cursor. - number of characters to delete. + number of characters to delete. @@ -41102,16 +43001,17 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` - the client widget. This may be %NULL to indicate + the client widget. This may be %NULL to indicate that the previous client widget no longer exists. @@ -41120,27 +43020,28 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` - location to store the retrieved + location to store the retrieved string. The string retrieved must be freed with g_free(). - location to store the retrieved + location to store the retrieved attribute list. When you are done with this list, you must unreference it with [method@Pango.AttrList.unref]. - location to store position of cursor + location to store position of cursor (in characters) within the preedit string. @@ -41149,17 +43050,18 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a `GtkIMContext` + a `GtkIMContext` - the key event + the key event @@ -41167,12 +43069,13 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` @@ -41180,12 +43083,13 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` @@ -41193,12 +43097,13 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` @@ -41206,16 +43111,17 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` - new location + new location @@ -41223,16 +43129,17 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` - whether the IM context should use the preedit string. + whether the IM context should use the preedit string. @@ -41240,25 +43147,26 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. @@ -41266,25 +43174,26 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - `TRUE` if surrounding text was provided; in this case + `TRUE` if surrounding text was provided; in this case you must free the result stored in `text`. - a `GtkIMContext` + a `GtkIMContext` - location to store a UTF-8 encoded + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - location to store byte index of the insertion + location to store byte index of the insertion cursor within @text. @@ -41293,29 +43202,30 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - a `GtkIMContext` + a `GtkIMContext` - text surrounding the insertion point, as UTF-8. + text surrounding the insertion point, as UTF-8. the preedit string should not be included within @text - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text + the byte index of the insertion cursor within @text - the byte index of the selection bound within @text + the byte index of the selection bound within @text @@ -41323,30 +43233,31 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + - `TRUE` if surrounding text was provided; in this case + `TRUE` if surrounding text was provided; in this case you must free the result stored in `text`. - a `GtkIMContext` + a `GtkIMContext` - location to store a UTF-8 encoded + location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns %TRUE, then you must free the result stored in this location with g_free(). - location to store byte index of the insertion + location to store byte index of the insertion cursor within @text. - location to store byte index of the selection + location to store byte index of the selection bound within @text @@ -41355,6 +43266,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41362,6 +43274,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41369,6 +43282,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41376,6 +43290,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41383,6 +43298,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. + @@ -41390,7 +43306,7 @@ calling the [method@Gtk.IMContext.set_surrounding] method. - `GtkIMContextSimple` is an input method supporting table-based input methods. + `GtkIMContextSimple` is an input method supporting table-based input methods. ## Compose sequences @@ -41427,31 +43343,34 @@ yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ. yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this depends on the keyboard layout including dead keys. + - Creates a new `GtkIMContextSimple`. + Creates a new `GtkIMContextSimple`. + - a new `GtkIMContextSimple` + a new `GtkIMContextSimple` - Adds an additional table from the X11 compose file. + Adds an additional table from the X11 compose file. + - A `GtkIMContextSimple` + A `GtkIMContextSimple` - The path of compose file + The path of compose file - Adds an additional table to search to the input context. + Adds an additional table to search to the input context. Each row of the table consists of @max_seq_len key symbols followed by two #guint16 interpreted as the high and low words of a #gunicode value. Tables are searched starting @@ -41461,26 +43380,27 @@ The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.) Use gtk_im_context_simple_add_compose_file() + - A `GtkIMContextSimple` + A `GtkIMContextSimple` - the table + the table - Maximum length of a sequence in the table + Maximum length of a sequence in the table - number of sequences in the table + number of sequences in the table @@ -41493,40 +43413,46 @@ the length of the sequence should be zero.) + - + + + - `GtkIMMulticontext` is an input method context supporting multiple, + `GtkIMMulticontext` is an input method context supporting multiple, switchable input methods. Text widgets such as `GtkText` or `GtkTextView` use a `GtkIMMultiContext` to implement their `im-module` property for switching between different input methods. + - Creates a new `GtkIMMulticontext`. + Creates a new `GtkIMMulticontext`. + - a new `GtkIMMulticontext`. + a new `GtkIMMulticontext`. - Gets the id of the currently active delegate of the @context. + Gets the id of the currently active delegate of the @context. + - the id of the currently active delegate + the id of the currently active delegate - a `GtkIMMulticontext` + a `GtkIMMulticontext` - Sets the context id for @context. + Sets the context id for @context. This causes the currently active delegate of @context to be replaced by the delegate corresponding to the new context id. @@ -41534,16 +43460,17 @@ replaced by the delegate corresponding to the new context id. Setting this to a non-%NULL value overrides the system-wide IM module setting. See the [property@Gtk.Settings:gtk-im-module] property. + - a `GtkIMMulticontext` + a `GtkIMMulticontext` - the id to use + the id to use @@ -41556,11 +43483,13 @@ property. + + @@ -41568,6 +43497,7 @@ property. + @@ -41575,6 +43505,7 @@ property. + @@ -41582,91 +43513,107 @@ property. + - + + + + + + + + + + + + + + - Constant to return from a signal handler for the ::input + Constant to return from a signal handler for the ::input signal in case of conversion failure. See [signal@Gtk.SpinButton::input]. + - Like gtk_get_interface_age(), but from the headers used at + Like gtk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. + - The value used to refer to a guaranteed invalid position + The value used to refer to a guaranteed invalid position in a `GListModel`. This value may be returned from some functions, others may @@ -41675,1679 +43622,1950 @@ functions. Refer to each function's documentation for if this value is allowed and what it does. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Used to specify options for gtk_icon_theme_lookup_icon(). + Used to specify options for gtk_icon_theme_lookup_icon(). - Try to always load regular icons, even + Try to always load regular icons, even when symbolic icon names are given - Try to always load symbolic icons, even + Try to always load symbolic icons, even when regular icon names are given - Starts loading the texture in the background + Starts loading the texture in the background so it is ready when later needed. - Contains information found when looking up an icon in `GtkIconTheme`. + Contains information found when looking up an icon in `GtkIconTheme`. `GtkIconPaintable` implements `GdkPaintable`. - Creates a `GtkIconPaintable` for a file with a given size and scale. + Creates a `GtkIconPaintable` for a file with a given size and scale. The icon can then be rendered by using it as a `GdkPaintable`. + - a `GtkIconPaintable` containing + a `GtkIconPaintable` containing for the icon. Unref with g_object_unref() - a `GFile` + a `GFile` - desired icon size + desired icon size - the desired scale + the desired scale - Gets the `GFile` that was used to load the icon. + Gets the `GFile` that was used to load the icon. Returns %NULL if the icon was not loaded from a file. + - the `GFile` for the icon + the `GFile` for the icon - a `GtkIconPaintable` + a `GtkIconPaintable` - Get the icon name being used for this icon. + Get the icon name being used for this icon. When an icon looked up in the icon theme was not available, the icon theme may use fallback icons - either those specified to @@ -43356,56 +45574,58 @@ gtk_icon_theme_lookup_icon() or the always-available If the icon was created without an icon theme, this function returns %NULL. + - the themed icon-name for the + the themed icon-name for the icon, or %NULL if its not a themed icon. - a `GtkIconPaintable` + a `GtkIconPaintable` - Checks if the icon is symbolic or not. + Checks if the icon is symbolic or not. This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future. Note that to render a symbolic `GtkIconPaintable` properly (with recoloring), you have to set its icon name on a `GtkImage`. + - %TRUE if the icon is symbolic, %FALSE otherwise + %TRUE if the icon is symbolic, %FALSE otherwise - a `GtkIconPaintable` + a `GtkIconPaintable` - The file representing the icon, if any. + The file representing the icon, if any. - The icon name that was chosen during lookup. + The icon name that was chosen during lookup. - Whether the icon is symbolic or not. + Whether the icon is symbolic or not. - Built-in icon sizes. + Built-in icon sizes. Icon sizes default to being inherited. Where they cannot be inherited, text size is the default. @@ -43415,17 +45635,17 @@ large-icons style classes correspondingly, and let themes determine the actual size to be used with the `-gtk-icon-size` CSS property. - Keep the size of the parent element + Keep the size of the parent element - Size similar to text size + Size similar to text size - Large size, for example in an icon view + Large size, for example in an icon view - `GtkIconTheme` provides a facility for loading themed icons. + `GtkIconTheme` provides a facility for loading themed icons. The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what “icon theme” is @@ -43458,19 +45678,20 @@ paintable = GDK_PAINTABLE (icon); g_object_unref (icon); ``` - Creates a new icon theme object. + Creates a new icon theme object. Icon theme objects are used to lookup up an icon by name in a particular icon theme. Usually, you’ll want to use [func@Gtk.IconTheme.get_for_display] rather than creating a new icon theme object for scratch. + - the newly created `GtkIconTheme` object. + the newly created `GtkIconTheme` object. - Gets the icon theme object associated with @display. + Gets the icon theme object associated with @display. If this function has not previously been called for the given display, a new icon theme object will be created and associated @@ -43478,77 +45699,82 @@ with the display. Icon theme objects are fairly expensive to create, so using this function is usually a better choice than calling [ctor@Gtk.IconTheme.new] and setting the display yourself; by using this function a single icon theme object will be shared between users. + - A unique `GtkIconTheme` associated with + A unique `GtkIconTheme` associated with the given display. This icon theme is associated with the display and can be used as long as the display is open. Do not ref or unref it. - a `GdkDisplay` + a `GdkDisplay` - Adds a resource path that will be looked at when looking + Adds a resource path that will be looked at when looking for icons, similar to search paths. See [method@Gtk.IconTheme.set_resource_path]. This function should be used to make application-specific icons available as part of the icon theme. + - a `GtkIconTheme` + a `GtkIconTheme` - a resource path + a resource path - Appends a directory to the search path. + Appends a directory to the search path. See [method@Gtk.IconTheme.set_search_path]. + - a `GtkIconTheme` + a `GtkIconTheme` - directory name to append to the icon path + directory name to append to the icon path - Returns the display that the `GtkIconTheme` object was + Returns the display that the `GtkIconTheme` object was created for. + - the display of @icon_theme + the display of @icon_theme - a `GtkIconTheme` + a `GtkIconTheme` - Lists the names of icons in the current icon theme. + Lists the names of icons in the current icon theme. + - a string array + a string array holding the names of all the icons in the theme. You must free the array using g_strfreev(). @@ -43557,19 +45783,20 @@ created for. - a `GtkIconTheme` + a `GtkIconTheme` - Returns an array of integers describing the sizes at which + Returns an array of integers describing the sizes at which the icon is available without scaling. A size of -1 means that the icon is available in a scalable format. The array is zero-terminated. + - A newly + A newly allocated array describing the sizes at which the icon is available. The array should be freed with g_free() when it is no longer needed. @@ -43579,21 +45806,22 @@ format. The array is zero-terminated. - a `GtkIconTheme` + a `GtkIconTheme` - the name of an icon + the name of an icon - Gets the current resource path. + Gets the current resource path. See [method@Gtk.IconTheme.set_resource_path]. + - + A list of resource paths @@ -43601,17 +45829,18 @@ See [method@Gtk.IconTheme.set_resource_path]. - a `GtkIconTheme` + a `GtkIconTheme` - Gets the current search path. + Gets the current search path. See [method@Gtk.IconTheme.set_search_path]. + - + a list of icon theme path directories @@ -43619,101 +45848,105 @@ See [method@Gtk.IconTheme.set_search_path]. - a `GtkIconTheme` + a `GtkIconTheme` - Gets the current icon theme name. + Gets the current icon theme name. Returns (transfer full): the current icon theme name, + - a `GtkIconTheme` + a `GtkIconTheme` - Checks whether an icon theme includes an icon + Checks whether an icon theme includes an icon for a particular `GIcon`. + - %TRUE if @self includes an icon for @gicon + %TRUE if @self includes an icon for @gicon - a `GtkIconTheme` + a `GtkIconTheme` - a `GIcon` + a `GIcon` - Checks whether an icon theme includes an icon + Checks whether an icon theme includes an icon for a particular name. + - %TRUE if @self includes an + %TRUE if @self includes an icon for @icon_name. - a `GtkIconTheme` + a `GtkIconTheme` - the name of an icon + the name of an icon - Looks up a icon for a desired size and window scale. + Looks up a icon for a desired size and window scale. The icon can then be rendered by using it as a `GdkPaintable`, or you can get information such as the filename and size. + - a `GtkIconPaintable` containing + a `GtkIconPaintable` containing information about the icon. Unref with g_object_unref() - a `GtkIconTheme` + a `GtkIconTheme` - the `GIcon` to look up + the `GIcon` to look up - desired icon size + desired icon size - the desired scale + the desired scale - text direction the icon will be displayed in + text direction the icon will be displayed in - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - Looks up a named icon for a desired size and window scale, + Looks up a named icon for a desired size and window scale, returning a `GtkIconPaintable`. The icon can then be rendered by using it as a `GdkPaintable`, @@ -43729,18 +45962,19 @@ for missing icons you need to use [method@Gtk.IconTheme.has_icon]. Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function. + - a `GtkIconPaintable` object + a `GtkIconPaintable` object containing the icon. - a `GtkIconTheme` + a `GtkIconTheme` - the name of the icon to lookup + the name of the icon to lookup @@ -43749,25 +45983,25 @@ GtkWidgetClass.css-changed() function. - desired icon size. + desired icon size. - the window scale this will be displayed on + the window scale this will be displayed on - text direction the icon will be displayed in + text direction the icon will be displayed in - flags modifying the behavior of the icon lookup + flags modifying the behavior of the icon lookup - Sets the resource paths that will be looked at when + Sets the resource paths that will be looked at when looking for icons, similar to search paths. The resources are considered as part of the hicolor icon theme @@ -43778,16 +46012,17 @@ or `@path/scalable/actions/run.svg`. Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback, but they are treated like unthemed icons. + - a `GtkIconTheme` + a `GtkIconTheme` - + NULL-terminated array of resource paths that are searched for icons @@ -43797,7 +46032,7 @@ but they are treated like unthemed icons. - Sets the search path for the icon theme object. + Sets the search path for the icon theme object. When looking for an icon theme, GTK will search for a subdirectory of one or more of the directories in @path with the same name @@ -43812,16 +46047,17 @@ the right name is found directly in one of the elements of (This is legacy feature, and new icons should be put into the fallback icon theme, which is called hicolor, rather than directly on the icon path.) + - a `GtkIconTheme` + a `GtkIconTheme` - NULL-terminated + NULL-terminated array of directories that are searched for icon themes @@ -43830,38 +46066,39 @@ rather than directly on the icon path.) - Sets the name of the icon theme that the `GtkIconTheme` object uses + Sets the name of the icon theme that the `GtkIconTheme` object uses overriding system configuration. This function cannot be called on the icon theme objects returned from [func@Gtk.IconTheme.get_for_display]. + - a `GtkIconTheme` + a `GtkIconTheme` - name of icon theme to use instead of + name of icon theme to use instead of configured theme, or %NULL to unset a previously set custom theme - The display that this icon theme object is attached to. + The display that this icon theme object is attached to. - The icon names that are supported by the icon theme. + The icon names that are supported by the icon theme. - Resource paths that will be looked at when looking for icons, + Resource paths that will be looked at when looking for icons, similar to search paths. The resources are considered as part of the hicolor icon theme @@ -43874,7 +46111,7 @@ of a subdirectory are also considered as ultimate fallback. - The search path for this icon theme. + The search path for this icon theme. When looking for icons, GTK will search for a subdirectory of one or more of the directories in the search path with the same @@ -43886,7 +46123,7 @@ to be extended by adding icons in the user’s home directory.) - The name of the icon theme that is being used. + The name of the icon theme that is being used. Unless set to a different value, this will be the value of the `GtkSettings:gtk-icon-theme-name` property of the `GtkSettings` @@ -43894,7 +46131,7 @@ object associated to the display of the icontheme object. - Emitted when the icon theme changes. + Emitted when the icon theme changes. This can happen becuase current icon theme is switched or because GTK detects that a change has occurred in the @@ -43905,12 +46142,12 @@ contents of the current icon theme. - Error codes for `GtkIconTheme` operations. + Error codes for `GtkIconTheme` operations. - The icon specified does not exist in the theme + The icon specified does not exist in the theme - An unspecified error occurred. + An unspecified error occurred. @@ -43919,7 +46156,7 @@ contents of the current icon theme. - `GtkIconView` is a widget which displays data in a grid of icons. + `GtkIconView` is a widget which displays data in a grid of icons. `GtkIconView` provides an alternative view on a `GtkTreeModel`. It displays the model as a grid of icons with labels. Like @@ -43948,459 +46185,485 @@ For rubberband selection, a subnode with name rubberband is used. - Creates a new `GtkIconView` widget + Creates a new `GtkIconView` widget + - A newly created `GtkIconView` widget + A newly created `GtkIconView` widget - Creates a new `GtkIconView` widget using the + Creates a new `GtkIconView` widget using the specified @area to layout cells inside the icons. + - A newly created `GtkIconView` widget + A newly created `GtkIconView` widget - the `GtkCellArea` to use to layout cells + the `GtkCellArea` to use to layout cells - Creates a new `GtkIconView` widget with the model @model. + Creates a new `GtkIconView` widget with the model @model. + - A newly created `GtkIconView` widget. + A newly created `GtkIconView` widget. - The model. + The model. - Creates a `cairo_surface_t` representation of the item at @path. + Creates a `cairo_surface_t` representation of the item at @path. This image is used for a drag icon. + - a newly-allocated surface of the drag icon. + a newly-allocated surface of the drag icon. - a `GtkIconView` + a `GtkIconView` - a `GtkTreePath` in @icon_view + a `GtkTreePath` in @icon_view - Turns @icon_view into a drop destination for automatic DND. Calling this + Turns @icon_view into a drop destination for automatic DND. Calling this method sets `GtkIconView`:reorderable to %FALSE. + - a `GtkIconView` + a `GtkIconView` - the formats that the drag will support + the formats that the drag will support - the bitmask of possible actions for a drag to this + the bitmask of possible actions for a drag to this widget - Turns @icon_view into a drag source for automatic DND. Calling this + Turns @icon_view into a drag source for automatic DND. Calling this method sets `GtkIconView`:reorderable to %FALSE. + - a `GtkIconView` + a `GtkIconView` - Mask of allowed buttons to start drag + Mask of allowed buttons to start drag - the formats that the drag will support + the formats that the drag will support - the bitmask of possible actions for a drag from this + the bitmask of possible actions for a drag from this widget - Gets the setting set by gtk_icon_view_set_activate_on_single_click(). + Gets the setting set by gtk_icon_view_set_activate_on_single_click(). + - %TRUE if item-activated will be emitted on a single click + %TRUE if item-activated will be emitted on a single click - a `GtkIconView` + a `GtkIconView` - Fills the bounding rectangle in widget coordinates for the cell specified by + Fills the bounding rectangle in widget coordinates for the cell specified by @path and @cell. If @cell is %NULL the main cell area is used. This function is only valid if @icon_view is realized. + - %FALSE if there is no such item, %TRUE otherwise + %FALSE if there is no such item, %TRUE otherwise - a `GtkIconView` + a `GtkIconView` - a `GtkTreePath` + a `GtkTreePath` - a `GtkCellRenderer` + a `GtkCellRenderer` - rectangle to fill with cell rect + rectangle to fill with cell rect - Returns the value of the ::column-spacing property. + Returns the value of the ::column-spacing property. + - the space between columns + the space between columns - a `GtkIconView` + a `GtkIconView` - Returns the value of the ::columns property. + Returns the value of the ::columns property. + - the number of columns, or -1 + the number of columns, or -1 - a `GtkIconView` + a `GtkIconView` - Fills in @path and @cell with the current cursor path and cell. + Fills in @path and @cell with the current cursor path and cell. If the cursor isn’t currently set, then *@path will be %NULL. If no cell currently has focus, then *@cell will be %NULL. The returned `GtkTreePath` must be freed with gtk_tree_path_free(). + - %TRUE if the cursor is set. + %TRUE if the cursor is set. - A `GtkIconView` + A `GtkIconView` - Return location for the current + Return location for the current cursor path - Return location the current + Return location the current focus cell - Determines the destination item for a given position. + Determines the destination item for a given position. + - whether there is an item at the given position. + whether there is an item at the given position. - a `GtkIconView` + a `GtkIconView` - the position to determine the destination item for + the position to determine the destination item for - the position to determine the destination item for + the position to determine the destination item for - Return location for the path of the item + Return location for the path of the item - Return location for the drop position + Return location for the drop position - Gets information about the item that is highlighted for feedback. + Gets information about the item that is highlighted for feedback. + - a `GtkIconView` + a `GtkIconView` - Return location for the path of + Return location for the path of the highlighted item - Return location for the drop position + Return location for the drop position - Gets the path and cell for the icon at the given position. + Gets the path and cell for the icon at the given position. + - %TRUE if an item exists at the specified position + %TRUE if an item exists at the specified position - A `GtkIconView`. + A `GtkIconView`. - The x position to be identified + The x position to be identified - The y position to be identified + The y position to be identified - Return location for the path + Return location for the path - Return location for the renderer + Return location for the renderer responsible for the cell at (@x, @y) - Gets the column in which the item @path is currently + Gets the column in which the item @path is currently displayed. Column numbers start at 0. + - The column in which the item is displayed + The column in which the item is displayed - a `GtkIconView` + a `GtkIconView` - the `GtkTreePath` of the item + the `GtkTreePath` of the item - Returns the value of the ::item-orientation property which determines + Returns the value of the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below. + - the relative position of texts and icons + the relative position of texts and icons - a `GtkIconView` + a `GtkIconView` - Returns the value of the ::item-padding property. + Returns the value of the ::item-padding property. + - the padding around items + the padding around items - a `GtkIconView` + a `GtkIconView` - Gets the row in which the item @path is currently + Gets the row in which the item @path is currently displayed. Row numbers start at 0. + - The row in which the item is displayed + The row in which the item is displayed - a `GtkIconView` + a `GtkIconView` - the `GtkTreePath` of the item + the `GtkTreePath` of the item - Returns the value of the ::item-width property. + Returns the value of the ::item-width property. + - the width of a single item, or -1 + the width of a single item, or -1 - a `GtkIconView` + a `GtkIconView` - Returns the value of the ::margin property. + Returns the value of the ::margin property. + - the space at the borders + the space at the borders - a `GtkIconView` + a `GtkIconView` - Returns the column with markup text for @icon_view. + Returns the column with markup text for @icon_view. + - the markup column, or -1 if it’s unset. + the markup column, or -1 if it’s unset. - A `GtkIconView`. + A `GtkIconView`. - Returns the model the `GtkIconView` is based on. Returns %NULL if the + Returns the model the `GtkIconView` is based on. Returns %NULL if the model is unset. + - The currently used `GtkTreeModel` + The currently used `GtkTreeModel` - a `GtkIconView` + a `GtkIconView` - Gets the path for the icon at the given position. + Gets the path for the icon at the given position. + - The `GtkTreePath` corresponding + The `GtkTreePath` corresponding to the icon or %NULL if no icon exists at that position. - A `GtkIconView`. + A `GtkIconView`. - The x position to be identified + The x position to be identified - The y position to be identified + The y position to be identified - Returns the column with pixbufs for @icon_view. + Returns the column with pixbufs for @icon_view. + - the pixbuf column, or -1 if it’s unset. + the pixbuf column, or -1 if it’s unset. - A `GtkIconView`. + A `GtkIconView`. - Retrieves whether the user can reorder the list via drag-and-drop. + Retrieves whether the user can reorder the list via drag-and-drop. See gtk_icon_view_set_reorderable(). + - %TRUE if the list can be reordered. + %TRUE if the list can be reordered. - a `GtkIconView` + a `GtkIconView` - Returns the value of the ::row-spacing property. + Returns the value of the ::row-spacing property. + - the space between rows + the space between rows - a `GtkIconView` + a `GtkIconView` - Creates a list of paths of all selected items. Additionally, if you are + Creates a list of paths of all selected items. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of `GtkTreeRowReferences`. To do this, you can use gtk_tree_row_reference_new(). @@ -44409,75 +46672,80 @@ To free the return value, use: |[<!-- language="C" --> g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); ]| + - A `GList` containing a `GtkTreePath` for each selected row. + A `GList` containing a `GtkTreePath` for each selected row. - A `GtkIconView`. + A `GtkIconView`. - Gets the selection mode of the @icon_view. + Gets the selection mode of the @icon_view. + - the current selection mode + the current selection mode - A `GtkIconView`. + A `GtkIconView`. - Returns the value of the ::spacing property. + Returns the value of the ::spacing property. + - the space between cells + the space between cells - a `GtkIconView` + a `GtkIconView` - Returns the column with text for @icon_view. + Returns the column with text for @icon_view. + - the text column, or -1 if it’s unset. + the text column, or -1 if it’s unset. - A `GtkIconView`. + A `GtkIconView`. - Returns the column of @icon_view’s model which is being used for + Returns the column of @icon_view’s model which is being used for displaying tooltips on @icon_view’s rows. + - the index of the tooltip column that is currently being + the index of the tooltip column that is currently being used, or -1 if this is disabled. - a `GtkIconView` + a `GtkIconView` - This function is supposed to be used in a `GtkWidget::query-tooltip` + This function is supposed to be used in a `GtkWidget::query-tooltip` signal handler for `GtkIconView`. The @x, @y and @keyboard_tip values which are received in the signal handler, should be passed to this function without modification. @@ -44487,101 +46755,105 @@ coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard tooltips the item returned will be the cursor item. When %TRUE, then any of @model, @path and @iter which have been provided will be set to point to that row and the corresponding model. + - whether or not the given tooltip context points to an item + whether or not the given tooltip context points to an item - an `GtkIconView` + an `GtkIconView` - the x coordinate (relative to widget coordinates) + the x coordinate (relative to widget coordinates) - the y coordinate (relative to widget coordinates) + the y coordinate (relative to widget coordinates) - whether this is a keyboard tooltip or not + whether this is a keyboard tooltip or not - a pointer to receive a `GtkTreeModel` + a pointer to receive a `GtkTreeModel` - a pointer to receive a `GtkTreePath` + a pointer to receive a `GtkTreePath` - a pointer to receive a `GtkTreeIter` + a pointer to receive a `GtkTreeIter` - Sets @start_path and @end_path to be the first and last visible path. + Sets @start_path and @end_path to be the first and last visible path. Note that there may be invisible paths in between. Both paths should be freed with gtk_tree_path_free() after use. + - %TRUE, if valid paths were placed in @start_path and @end_path + %TRUE, if valid paths were placed in @start_path and @end_path - A `GtkIconView` + A `GtkIconView` - Return location for start of region + Return location for start of region - Return location for end of region + Return location for end of region - Activates the item determined by @path. + Activates the item determined by @path. + - A `GtkIconView` + A `GtkIconView` - The `GtkTreePath` to be activated + The `GtkTreePath` to be activated - Returns %TRUE if the icon pointed to by @path is currently + Returns %TRUE if the icon pointed to by @path is currently selected. If @path does not point to a valid location, %FALSE is returned. + - %TRUE if @path is selected. + %TRUE if @path is selected. - A `GtkIconView`. + A `GtkIconView`. - A `GtkTreePath` to check selection on. + A `GtkTreePath` to check selection on. - Moves the alignments of @icon_view to the position specified by @path. + Moves the alignments of @icon_view to the position specified by @path. @row_align determines where the row is placed, and @col_align determines where @column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means @@ -44595,137 +46867,144 @@ position. If the item is currently visible on the screen, nothing is done. This function only works if the model is set, and @path is a valid row on the model. If the model changes before the @icon_view is realized, the centered path will be modified to reflect this change. + - A `GtkIconView` + A `GtkIconView` - The path of the item to move to. + The path of the item to move to. - whether to use alignment arguments, or %FALSE. + whether to use alignment arguments, or %FALSE. - The vertical alignment of the item specified by @path. + The vertical alignment of the item specified by @path. - The horizontal alignment of the item specified by @path. + The horizontal alignment of the item specified by @path. - Selects all the icons. @icon_view must has its selection mode set + Selects all the icons. @icon_view must has its selection mode set to %GTK_SELECTION_MULTIPLE. + - A `GtkIconView`. + A `GtkIconView`. - Selects the row at @path. + Selects the row at @path. + - A `GtkIconView`. + A `GtkIconView`. - The `GtkTreePath` to be selected. + The `GtkTreePath` to be selected. - Calls a function for each selected icon. Note that the model or + Calls a function for each selected icon. Note that the model or selection cannot be modified from within this function. + - A `GtkIconView`. + A `GtkIconView`. - The function to call for each selected icon. + The function to call for each selected icon. - User data to pass to the function. + User data to pass to the function. - Causes the `GtkIconView`::item-activated signal to be emitted on + Causes the `GtkIconView`::item-activated signal to be emitted on a single click instead of a double click. + - a `GtkIconView` + a `GtkIconView` - %TRUE to emit item-activated on a single click + %TRUE to emit item-activated on a single click - Sets the ::column-spacing property which specifies the space + Sets the ::column-spacing property which specifies the space which is inserted between the columns of the icon view. + - a `GtkIconView` + a `GtkIconView` - the column spacing + the column spacing - Sets the ::columns property which determines in how + Sets the ::columns property which determines in how many columns the icons are arranged. If @columns is -1, the number of columns will be chosen automatically to fill the available area. + - a `GtkIconView` + a `GtkIconView` - the number of columns + the number of columns - Sets the current keyboard focus to be at @path, and selects it. This is + Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular item. If @cell is not %NULL, then focus is given to the cell specified by it. Additionally, if @start_editing is %TRUE, then editing should be @@ -44734,175 +47013,184 @@ started in the specified cell. This function is often followed by `gtk_widget_grab_focus (icon_view)` in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized. + - A `GtkIconView` + A `GtkIconView` - A `GtkTreePath` + A `GtkTreePath` - One of the cell renderers of @icon_view + One of the cell renderers of @icon_view - %TRUE if the specified cell should start being edited. + %TRUE if the specified cell should start being edited. - Sets the item that is highlighted for feedback. + Sets the item that is highlighted for feedback. + - a `GtkIconView` + a `GtkIconView` - The path of the item to highlight + The path of the item to highlight - Specifies where to drop, relative to the item + Specifies where to drop, relative to the item - Sets the ::item-orientation property which determines whether the labels + Sets the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below. + - a `GtkIconView` + a `GtkIconView` - the relative position of texts and icons + the relative position of texts and icons - Sets the `GtkIconView`:item-padding property which specifies the padding + Sets the `GtkIconView`:item-padding property which specifies the padding around each of the icon view’s items. + - a `GtkIconView` + a `GtkIconView` - the item padding + the item padding - Sets the ::item-width property which specifies the width + Sets the ::item-width property which specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size. + - a `GtkIconView` + a `GtkIconView` - the width for each item + the width for each item - Sets the ::margin property which specifies the space + Sets the ::margin property which specifies the space which is inserted at the top, bottom, left and right of the icon view. + - a `GtkIconView` + a `GtkIconView` - the margin + the margin - Sets the column with markup information for @icon_view to be + Sets the column with markup information for @icon_view to be @column. The markup column must be of type `G_TYPE_STRING`. If the markup column is set to something, it overrides the text column set by gtk_icon_view_set_text_column(). + - A `GtkIconView`. + A `GtkIconView`. - A column in the currently used model, or -1 to display no text + A column in the currently used model, or -1 to display no text - Sets the model for a `GtkIconView`. + Sets the model for a `GtkIconView`. If the @icon_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model. + - A `GtkIconView`. + A `GtkIconView`. - The model. + The model. - Sets the column with pixbufs for @icon_view to be @column. The pixbuf + Sets the column with pixbufs for @icon_view to be @column. The pixbuf column must be of type `GDK_TYPE_PIXBUF` + - A `GtkIconView`. + A `GtkIconView`. - A column in the currently used model, or -1 to disable + A column in the currently used model, or -1 to disable - This function is a convenience function to allow you to reorder models that + This function is a convenience function to allow you to reorder models that support the `GtkTreeDragSourceIface` and the `GtkTreeDragDestIface`. Both `GtkTreeStore` and `GtkListStore` support these. If @reorderable is %TRUE, then the user can reorder the model by dragging and dropping rows. The @@ -44914,117 +47202,123 @@ drop can not be used in a reorderable view for any other purpose. This function does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually. + - A `GtkIconView`. + A `GtkIconView`. - %TRUE, if the list of items can be reordered. + %TRUE, if the list of items can be reordered. - Sets the ::row-spacing property which specifies the space + Sets the ::row-spacing property which specifies the space which is inserted between the rows of the icon view. + - a `GtkIconView` + a `GtkIconView` - the row spacing + the row spacing - Sets the selection mode of the @icon_view. + Sets the selection mode of the @icon_view. + - A `GtkIconView`. + A `GtkIconView`. - The selection mode + The selection mode - Sets the ::spacing property which specifies the space + Sets the ::spacing property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. + - a `GtkIconView` + a `GtkIconView` - the spacing + the spacing - Sets the column with text for @icon_view to be @column. The text + Sets the column with text for @icon_view to be @column. The text column must be of type `G_TYPE_STRING`. + - A `GtkIconView`. + A `GtkIconView`. - A column in the currently used model, or -1 to display no text + A column in the currently used model, or -1 to display no text - Sets the tip area of @tooltip to the area which @cell occupies in + Sets the tip area of @tooltip to the area which @cell occupies in the item pointed to by @path. See also gtk_tooltip_set_tip_area(). See also gtk_icon_view_set_tooltip_column() for a simpler alternative. + - a `GtkIconView` + a `GtkIconView` - a `GtkTooltip` + a `GtkTooltip` - a `GtkTreePath` + a `GtkTreePath` - a `GtkCellRenderer` + a `GtkCellRenderer` - If you only plan to have simple (text-only) tooltips on full items, you + If you only plan to have simple (text-only) tooltips on full items, you can use this function to have `GtkIconView` handle these automatically for you. @column should be set to the column in @icon_view’s model containing the tooltip texts, or -1 to disable this feature. @@ -45034,142 +47328,148 @@ When enabled, `GtkWidget:has-tooltip` will be set to %TRUE and Note that the signal handler sets the text with gtk_tooltip_set_markup(), so &, <, etc have to be escaped in the text. + - a `GtkIconView` + a `GtkIconView` - an integer, which is a valid column number for @icon_view’s model + an integer, which is a valid column number for @icon_view’s model - Sets the tip area of @tooltip to be the area covered by the item at @path. + Sets the tip area of @tooltip to be the area covered by the item at @path. See also gtk_icon_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area(). + - a `GtkIconView` + a `GtkIconView` - a `GtkTooltip` + a `GtkTooltip` - a `GtkTreePath` + a `GtkTreePath` - Unselects all the icons. + Unselects all the icons. + - A `GtkIconView`. + A `GtkIconView`. - Unselects the row at @path. + Unselects the row at @path. + - A `GtkIconView`. + A `GtkIconView`. - The `GtkTreePath` to be unselected. + The `GtkTreePath` to be unselected. - Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this + Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this method sets `GtkIconView`:reorderable to %FALSE. + - a `GtkIconView` + a `GtkIconView` - Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this + Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this method sets `GtkIconView`:reorderable to %FALSE. + - a `GtkIconView` + a `GtkIconView` - The activate-on-single-click property specifies whether the "item-activated" signal + The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click. - The `GtkCellArea` used to layout cell renderers for this view. + The `GtkCellArea` used to layout cell renderers for this view. If no area is specified when creating the icon view with gtk_icon_view_new_with_area() a `GtkCellAreaBox` will be used. - The column-spacing property specifies the space which is inserted between + The column-spacing property specifies the space which is inserted between the columns of the icon view. - The columns property contains the number of the columns in which the + The columns property contains the number of the columns in which the items should be displayed. If it is -1, the number of columns will be chosen automatically to fill the available area. - The item-orientation property specifies how the cells (i.e. the icon and + The item-orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other. - The item-padding property specifies the padding around each + The item-padding property specifies the padding around each of the icon view's item. - The item-width property specifies the width to use for each item. + The item-width property specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size. - The margin property specifies the space which is inserted + The margin property specifies the space which is inserted at the edges of the icon view. - The ::markup-column property contains the number of the model column + The ::markup-column property contains the number of the model column containing markup information to be displayed. The markup column must be of type `G_TYPE_STRING`. If this property and the :text-column property are both set to column numbers, it overrides the text column. @@ -45180,35 +47480,35 @@ If both are set to -1, no texts are displayed. - The ::pixbuf-column property contains the number of the model column + The ::pixbuf-column property contains the number of the model column containing the pixbufs which are displayed. The pixbuf column must be of type `GDK_TYPE_PIXBUF`. Setting this property to -1 turns off the display of pixbufs. - The reorderable property specifies if the items can be reordered + The reorderable property specifies if the items can be reordered by DND. - The row-spacing property specifies the space which is inserted between + The row-spacing property specifies the space which is inserted between the rows of the icon view. - The ::selection-mode property specifies the selection mode of + The ::selection-mode property specifies the selection mode of icon view. If the mode is %GTK_SELECTION_MULTIPLE, rubberband selection is enabled, for the other modes, only keyboard selection is possible. - The spacing property specifies the space which is inserted between + The spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. - The ::text-column property contains the number of the model column + The ::text-column property contains the number of the model column containing the texts which are displayed. The text column must be of type `G_TYPE_STRING`. If this property and the :markup-column property are both set to -1, no texts are displayed. @@ -45218,7 +47518,7 @@ property are both set to -1, no texts are displayed. - A [keybinding signal][class@Gtk.SignalAction] + A [keybinding signal][class@Gtk.SignalAction] which gets emitted when the user activates the currently focused item. @@ -45232,7 +47532,7 @@ The default bindings for this signal are Space, Return and Enter. - The ::item-activated signal is emitted when the method + The ::item-activated signal is emitted when the method gtk_icon_view_item_activated() is called, when the user double clicks an item with the "activate-on-single-click" property set to %FALSE, or when the user single clicks an item when the @@ -45244,13 +47544,13 @@ Space, Return or Enter is pressed. - the `GtkTreePath` for the activated item + the `GtkTreePath` for the activated item - The ::move-cursor signal is a + The ::move-cursor signal is a [keybinding signal][class@Gtk.SignalAction] which gets emitted when the user initiates a cursor movement. @@ -45269,25 +47569,25 @@ the Shift modifier. - the granularity of the move, as a `GtkMovementStep` + the granularity of the move, as a `GtkMovementStep` - the number of @step units to move + the number of @step units to move - whether to extend the selection + whether to extend the selection - whether to modify the selection + whether to modify the selection - A [keybinding signal][class.Gtk.SignalAction] + A [keybinding signal][class.Gtk.SignalAction] which gets emitted when the user selects all items. Applications should not connect to it, but may emit it with @@ -45300,7 +47600,7 @@ The default binding for this signal is Ctrl-a. - A [keybinding signal][class@Gtk.SignalAction] + A [keybinding signal][class@Gtk.SignalAction] which gets emitted when the user selects the item that is currently focused. @@ -45314,14 +47614,14 @@ There is no default binding for this signal. - The ::selection-changed signal is emitted when the selection + The ::selection-changed signal is emitted when the selection (i.e. the set of selected items) changes. - A [keybinding signal][class@Gtk.SignalAction] + A [keybinding signal][class@Gtk.SignalAction] which gets emitted when the user toggles whether the currently focused item is selected or not. The exact effect of this depend on the selection mode. @@ -45336,7 +47636,7 @@ There is no default binding for this signal is Ctrl-Space. - A [keybinding signal][class@Gtk.SignalAction] + A [keybinding signal][class@Gtk.SignalAction] which gets emitted when the user unselects all items. Applications should not connect to it, but may emit it with @@ -45350,51 +47650,52 @@ The default binding for this signal is Ctrl-Shift-a. - An enum for determining where a dropped item goes. + An enum for determining where a dropped item goes. - no drop possible + no drop possible - dropped item replaces the item + dropped item replaces the item - dropped item is inserted to the left + dropped item is inserted to the left - dropped item is inserted to the right + dropped item is inserted to the right - dropped item is inserted above + dropped item is inserted above - dropped item is inserted below + dropped item is inserted below - A function used by gtk_icon_view_selected_foreach() to map all + A function used by gtk_icon_view_selected_foreach() to map all selected rows. It will be called on every selected row in the view. + - a `GtkIconView` + a `GtkIconView` - The `GtkTreePath` of a selected row + The `GtkTreePath` of a selected row - user data + user data - The `GtkImage` widget displays an image. + The `GtkImage` widget displays an image. ![An example GtkImage](image.png) @@ -45437,14 +47738,15 @@ at is actual size. - Creates a new empty `GtkImage` widget. + Creates a new empty `GtkImage` widget. + - a newly created `GtkImage` widget. + a newly created `GtkImage` widget. - Creates a new `GtkImage` displaying the file @filename. + Creates a new `GtkImage` displaying the file @filename. If the file isn’t found or can’t be loaded, the resulting `GtkImage` will display a “broken image” icon. This function never returns %NULL, @@ -45457,53 +47759,56 @@ then create the `GtkImage` from the texture. The storage type (see [method@Gtk.Image.get_storage_type]) of the returned image is not defined, it will be whatever is appropriate for displaying the file. + - a new `GtkImage` + a new `GtkImage` - a filename + a filename - Creates a `GtkImage` displaying an icon from the current icon theme. + Creates a `GtkImage` displaying an icon from the current icon theme. If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. + - a new `GtkImage` displaying the themed icon + a new `GtkImage` displaying the themed icon - an icon + an icon - Creates a `GtkImage` displaying an icon from the current icon theme. + Creates a `GtkImage` displaying an icon from the current icon theme. If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. + - a new `GtkImage` displaying the themed icon + a new `GtkImage` displaying the themed icon - an icon name + an icon name - Creates a new `GtkImage` displaying @paintable. + Creates a new `GtkImage` displaying @paintable. The `GtkImage` does not assume a reference to the paintable; you still need to unref it if you own references. `GtkImage` will add its own @@ -45511,19 +47816,20 @@ reference rather than adopting yours. The `GtkImage` will track changes to the @paintable and update its size and contents in response to it. + - a new `GtkImage` + a new `GtkImage` - a `GdkPaintable` + a `GdkPaintable` - Creates a new `GtkImage` displaying @pixbuf. + Creates a new `GtkImage` displaying @pixbuf. The `GtkImage` does not assume a reference to the pixbuf; you still need to unref it if you own references. `GtkImage` will add its own @@ -45535,19 +47841,20 @@ get back the exact pixbuf once this is called, only a texture. Note that this function just creates an `GtkImage` from the pixbuf. The `GtkImage` created will not react to state changes. Should you want that, you should use [ctor@Gtk.Image.new_from_icon_name]. + - a new `GtkImage` + a new `GtkImage` - a `GdkPixbuf` + a `GdkPixbuf` - Creates a new `GtkImage` displaying the resource file @resource_path. + Creates a new `GtkImage` displaying the resource file @resource_path. If the file isn’t found or can’t be loaded, the resulting `GtkImage` will display a “broken image” icon. This function never returns %NULL, @@ -45560,296 +47867,312 @@ then create the `GtkImage` from the pixbuf. The storage type (see [method@Gtk.Image.get_storage_type]) of the returned image is not defined, it will be whatever is appropriate for displaying the file. + - a new `GtkImage` + a new `GtkImage` - a resource path + a resource path - Resets the image to be empty. + Resets the image to be empty. + - a `GtkImage` + a `GtkImage` - Gets the `GIcon` being displayed by the `GtkImage`. + Gets the `GIcon` being displayed by the `GtkImage`. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_GICON (see [method@Gtk.Image.get_storage_type]). The caller of this function does not own a reference to the returned `GIcon`. + - a `GIcon` + a `GIcon` - a `GtkImage` + a `GtkImage` - Gets the icon name and size being displayed by the `GtkImage`. + Gets the icon name and size being displayed by the `GtkImage`. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_ICON_NAME (see [method@Gtk.Image.get_storage_type]). The returned string is owned by the `GtkImage` and should not be freed. + - the icon name + the icon name - a `GtkImage` + a `GtkImage` - Gets the icon size used by the @image when rendering icons. + Gets the icon size used by the @image when rendering icons. + - the image size used by icons + the image size used by icons - a `GtkImage` + a `GtkImage` - Gets the image `GdkPaintable` being displayed by the `GtkImage`. + Gets the image `GdkPaintable` being displayed by the `GtkImage`. The storage type of the image must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_PAINTABLE (see [method@Gtk.Image.get_storage_type]). The caller of this function does not own a reference to the returned paintable. + - the displayed paintable + the displayed paintable - a `GtkImage` + a `GtkImage` - Gets the pixel size used for named icons. + Gets the pixel size used for named icons. + - the pixel size used for named icons. + the pixel size used for named icons. - a `GtkImage` + a `GtkImage` - Gets the type of representation being used by the `GtkImage` + Gets the type of representation being used by the `GtkImage` to store image data. If the `GtkImage` has no image data, the return value will be %GTK_IMAGE_EMPTY. + - image representation being used + image representation being used - a `GtkImage` + a `GtkImage` - Sets a `GtkImage` to show a file. + Sets a `GtkImage` to show a file. See [ctor@Gtk.Image.new_from_file] for details. + - a `GtkImage` + a `GtkImage` - a filename + a filename - Sets a `GtkImage` to show a `GIcon`. + Sets a `GtkImage` to show a `GIcon`. See [ctor@Gtk.Image.new_from_gicon] for details. + - a `GtkImage` + a `GtkImage` - an icon + an icon - Sets a `GtkImage` to show a named icon. + Sets a `GtkImage` to show a named icon. See [ctor@Gtk.Image.new_from_icon_name] for details. + - a `GtkImage` + a `GtkImage` - an icon name + an icon name - Sets a `GtkImage` to show a `GdkPaintable`. + Sets a `GtkImage` to show a `GdkPaintable`. See [ctor@Gtk.Image.new_from_paintable] for details. + - a `GtkImage` + a `GtkImage` - a `GdkPaintable` + a `GdkPaintable` - Sets a `GtkImage` to show a `GdkPixbuf`. + Sets a `GtkImage` to show a `GdkPixbuf`. See [ctor@Gtk.Image.new_from_pixbuf] for details. Note: This is a helper for [method@Gtk.Image.set_from_paintable], and you can't get back the exact pixbuf once this is called, only a paintable. + - a `GtkImage` + a `GtkImage` - a `GdkPixbuf` or `NULL` + a `GdkPixbuf` or `NULL` - Sets a `GtkImage` to show a resource. + Sets a `GtkImage` to show a resource. See [ctor@Gtk.Image.new_from_resource] for details. + - a `GtkImage` + a `GtkImage` - a resource path + a resource path - Suggests an icon size to the theme for named icons. + Suggests an icon size to the theme for named icons. + - a `GtkImage` + a `GtkImage` - the new icon size + the new icon size - Sets the pixel size to use for named icons. + Sets the pixel size to use for named icons. If the pixel size is set to a value != -1, it is used instead of the icon size set by [method@Gtk.Image.set_from_icon_name]. + - a `GtkImage` + a `GtkImage` - the new pixel size + the new pixel size - The `GFile to display. + The `GFile to display. - The `GIcon` displayed in the GtkImage. + The `GIcon` displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically. @@ -45858,7 +48181,7 @@ automatically. - The name of the icon in the icon theme. + The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically. @@ -45866,19 +48189,19 @@ If the icon theme is changed, the image will be updated automatically. - The symbolic size to display icons at. + The symbolic size to display icons at. - The `GdkPaintable` to display. + The `GdkPaintable` to display. - The size in pixels to display icons at. + The size in pixels to display icons at. If set to a value != -1, this property overrides the [property@Gtk.Image:icon-size] property for images of type @@ -45887,16 +48210,16 @@ If set to a value != -1, this property overrides the - A path to a resource file to display. + A path to a resource file to display. - The representation being used for image data. + The representation being used for image data. - Whether the icon displayed in the `GtkImage` will use + Whether the icon displayed in the `GtkImage` will use standard icon names fallback. The value of this property is only relevant for images of type @@ -45905,7 +48228,7 @@ The value of this property is only relevant for images of type - Describes the image data representation used by a [class@Gtk.Image]. + Describes the image data representation used by a [class@Gtk.Image]. If you want to get the image from the widget, you can only get the currently-stored representation; for instance, if the gtk_image_get_storage_type() @@ -45914,20 +48237,20 @@ returns %GTK_IMAGE_PAINTABLE, then you can call gtk_image_get_paintable(). For empty images, you can request any storage type (call any of the "get" functions), but they will all return %NULL values. - there is no image displayed by the widget + there is no image displayed by the widget - the widget contains a named icon + the widget contains a named icon - the widget contains a `GIcon` + the widget contains a `GIcon` - the widget contains a `GdkPaintable` + the widget contains a `GdkPaintable` - `GtkInfoBar` can be show messages to the user without a dialog. + `GtkInfoBar` can be show messages to the user without a dialog. ![An example GtkInfoBar](info-bar.png) @@ -46004,14 +48327,15 @@ style class applied. - Creates a new `GtkInfoBar` object. + Creates a new `GtkInfoBar` object. + - a new `GtkInfoBar` object + a new `GtkInfoBar` object - Creates a new `GtkInfoBar` with buttons. + Creates a new `GtkInfoBar` with buttons. Button text/response ID pairs should be listed, with a %NULL pointer ending the list. A response ID can be any positive number, @@ -46019,277 +48343,291 @@ or one of the values in the `GtkResponseType` enumeration. If the user clicks one of these dialog buttons, GtkInfoBar will emit the [signal@Gtk.InfoBar::response] signal with the corresponding response ID. + - a new `GtkInfoBar` + a new `GtkInfoBar` - ext to go in first button + ext to go in first button - response ID for first button, then additional buttons, ending + response ID for first button, then additional buttons, ending with %NULL - Add an activatable widget to the action area of a `GtkInfoBar`. + Add an activatable widget to the action area of a `GtkInfoBar`. This also connects a signal handler that will emit the [signal@Gtk.InfoBar::response] signal on the message area when the widget is activated. The widget is appended to the end of the message areas action area. + - a `GtkInfoBar` + a `GtkInfoBar` - an activatable widget + an activatable widget - response ID for @child + response ID for @child - Adds a button with the given text. + Adds a button with the given text. Clicking the button will emit the [signal@Gtk.InfoBar::response] signal with the given response_id. The button is appended to the end of the info bars's action area. The button widget is returned, but usually you don't need it. + - the `GtkButton` widget + the `GtkButton` widget that was added - a `GtkInfoBar` + a `GtkInfoBar` - text of button + text of button - response ID for the button + response ID for the button - Adds multiple buttons. + Adds multiple buttons. This is the same as calling [method@Gtk.InfoBar.add_button] repeatedly. The variable argument list should be %NULL-terminated as with [ctor@Gtk.InfoBar.new_with_buttons]. Each button must have both text and response ID. + - a `GtkInfoBar` + a `GtkInfoBar` - button text + button text - response ID for first button, then more text-response_id pairs, + response ID for first button, then more text-response_id pairs, ending with %NULL - Adds a widget to the content area of the info bar. + Adds a widget to the content area of the info bar. + - a `GtkInfoBar` + a `GtkInfoBar` - the child to be added + the child to be added - Returns the message type of the message area. + Returns the message type of the message area. + - the message type of the message area. + the message type of the message area. - a `GtkInfoBar` + a `GtkInfoBar` - Returns whether the info bar is currently revealed. + Returns whether the info bar is currently revealed. + - the current value of the [property@Gtk.InfoBar:revealed] property + the current value of the [property@Gtk.InfoBar:revealed] property - a `GtkInfoBar` + a `GtkInfoBar` - Returns whether the widget will display a standard close button. + Returns whether the widget will display a standard close button. + - %TRUE if the widget displays standard close button + %TRUE if the widget displays standard close button - a `GtkInfoBar` + a `GtkInfoBar` - Removes a widget from the action area of @info_bar. + Removes a widget from the action area of @info_bar. The widget must have been put there by a call to [method@Gtk.InfoBar.add_action_widget] or [method@Gtk.InfoBar.add_button]. + - a `GtkInfoBar` + a `GtkInfoBar` - an action widget to remove + an action widget to remove - Removes a widget from the content area of the info bar. + Removes a widget from the content area of the info bar. + - a `GtkInfoBar` + a `GtkInfoBar` - a child that has been added to the content area + a child that has been added to the content area - Emits the “response” signal with the given @response_id. + Emits the “response” signal with the given @response_id. + - a `GtkInfoBar` + a `GtkInfoBar` - a response ID + a response ID - Sets the last widget in the info bar’s action area with + Sets the last widget in the info bar’s action area with the given response_id as the default widget for the dialog. Pressing “Enter” normally activates the default widget. Note that this function currently requires @info_bar to be added to a widget hierarchy. + - a `GtkInfoBar` + a `GtkInfoBar` - a response ID + a response ID - Sets the message type of the message area. + Sets the message type of the message area. GTK uses this type to determine how the message is displayed. + - a `GtkInfoBar` + a `GtkInfoBar` - a `GtkMessageType` + a `GtkMessageType` - Sets the sensitivity of action widgets for @response_id. + Sets the sensitivity of action widgets for @response_id. Calls `gtk_widget_set_sensitive (widget, setting)` for each widget in the info bars’s action area with the given @response_id. A convenient way to sensitize/desensitize buttons. + - a `GtkInfoBar` + a `GtkInfoBar` - a response ID + a response ID - TRUE for sensitive + TRUE for sensitive - Sets whether the `GtkInfoBar` is revealed. + Sets whether the `GtkInfoBar` is revealed. Changing this will make @info_bar reveal or conceal itself via a sliding transition. @@ -46297,35 +48635,37 @@ itself via a sliding transition. Note: this does not show or hide @info_bar in the [property@Gtk.Widget:visible] sense, so revealing has no effect if [property@Gtk.Widget:visible] is %FALSE. + - a `GtkInfoBar` + a `GtkInfoBar` - The new value of the property + The new value of the property - If true, a standard close button is shown. + If true, a standard close button is shown. When clicked it emits the response %GTK_RESPONSE_CLOSE. + - a `GtkInfoBar` + a `GtkInfoBar` - %TRUE to include a close button + %TRUE to include a close button @@ -46333,7 +48673,7 @@ When clicked it emits the response %GTK_RESPONSE_CLOSE. - The type of the message. + The type of the message. The type may be used to determine the appearance of the info bar. @@ -46341,17 +48681,17 @@ The type may be used to determine the appearance of the info bar. - Whether the info bar shows its contents. + Whether the info bar shows its contents. - Whether to include a standard close button. + Whether to include a standard close button. - Gets emitted when the user uses a keybinding to dismiss the info bar. + Gets emitted when the user uses a keybinding to dismiss the info bar. The ::close signal is a [keybinding signal](class.SignalAction.html). @@ -46361,7 +48701,7 @@ The default binding for this signal is the Escape key. - Emitted when an action widget is clicked. + Emitted when an action widget is clicked. The signal is also emitted when the application programmer calls [method@Gtk.InfoBar.response]. The @response_id depends @@ -46371,14 +48711,14 @@ on which action widget was clicked. - the response ID + the response ID - Describes hints that might be taken into account by input methods + Describes hints that might be taken into account by input methods or applications. Note that input methods may already tailor their behaviour according @@ -46390,51 +48730,51 @@ Some common sense is expected when using these flags - mixing This enumeration may be extended in the future; input methods should ignore unknown values. - No special behaviour suggested + No special behaviour suggested - Suggest checking for typos + Suggest checking for typos - Suggest not checking for typos + Suggest not checking for typos - Suggest word completion + Suggest word completion - Suggest to convert all text to lowercase + Suggest to convert all text to lowercase - Suggest to capitalize all text + Suggest to capitalize all text - Suggest to capitalize the first + Suggest to capitalize the first character of each word - Suggest to capitalize the + Suggest to capitalize the first word of each sentence - Suggest to not show an onscreen keyboard + Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys). - The text is vertical + The text is vertical - Suggest offering Emoji support + Suggest offering Emoji support - Suggest not offering Emoji support + Suggest not offering Emoji support - Request that the input method should not + Request that the input method should not update personalized data (like typing history) - Describes primary purpose of the input widget. + Describes primary purpose of the input widget. This information is useful for on-screen keyboards and similar input methods to decide which keys should be presented to the user. @@ -46454,268 +48794,300 @@ minus) and “e” or “E” as in 3.14E+000. This enumeration may be extended in the future; input methods should interpret unknown values as “free form”. - Allow any character + Allow any character - Allow only alphabetic characters + Allow only alphabetic characters - Allow only digits + Allow only digits - Edited field expects numbers + Edited field expects numbers - Edited field expects phone number + Edited field expects phone number - Edited field expects URL + Edited field expects URL - Edited field expects email address + Edited field expects email address - Edited field expects the name of a person + Edited field expects the name of a person - Like %GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden + Like %GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden - Like %GTK_INPUT_PURPOSE_DIGITS, but characters are hidden + Like %GTK_INPUT_PURPOSE_DIGITS, but characters are hidden - Allow any character, in addition to control codes + Allow any character, in addition to control codes - Used for justifying the text inside a `GtkLabel` widget. + Used for justifying the text inside a `GtkLabel` widget. - The text is placed at the left edge of the label. + The text is placed at the left edge of the label. - The text is placed at the right edge of the label. + The text is placed at the right edge of the label. - The text is placed in the center of the label. + The text is placed in the center of the label. - The text is placed is distributed across the label. + The text is placed is distributed across the label. - A `GtkShortcutTrigger` that triggers when a specific keyval and modifiers are pressed. + A `GtkShortcutTrigger` that triggers when a specific keyval and modifiers are pressed. + - Creates a `GtkShortcutTrigger` that will trigger whenever + Creates a `GtkShortcutTrigger` that will trigger whenever the key with the given @keyval and @modifiers is pressed. + - A new `GtkShortcutTrigger` + A new `GtkShortcutTrigger` - The keyval to trigger for + The keyval to trigger for - the modifiers that need to be present + the modifiers that need to be present - Gets the keyval that must be pressed to succeed + Gets the keyval that must be pressed to succeed triggering @self. + - the keyval + the keyval - a keyval `GtkShortcutTrigger` + a keyval `GtkShortcutTrigger` - Gets the modifiers that must be present to succeed + Gets the modifiers that must be present to succeed triggering @self. + - the modifiers + the modifiers - a keyval `GtkShortcutTrigger` + a keyval `GtkShortcutTrigger` - The key value for the trigger. + The key value for the trigger. - The key modifiers for the trigger. + The key modifiers for the trigger. - + + + + + - The name used for the stock full offset included by `GtkLevelBar`. + The name used for the stock full offset included by `GtkLevelBar`. + - The name used for the stock high offset included by `GtkLevelBar`. + The name used for the stock high offset included by `GtkLevelBar`. + - The name used for the stock low offset included by `GtkLevelBar`. + The name used for the stock low offset included by `GtkLevelBar`. + + + + + + + + + + + + + + + + + + + + + + - The `GtkLabel` widget displays a small amount of text. + The `GtkLabel` widget displays a small amount of text. As the name implies, most labels are used to label another widget such as a [class@Button]. @@ -46898,22 +49270,23 @@ with the [signal@Gtk.Label::activate-link] signal and the - Creates a new label with the given text inside it. + Creates a new label with the given text inside it. You can pass %NULL to get an empty label widget. + - the new `GtkLabel` + the new `GtkLabel` - The text of the label + The text of the label - Creates a new `GtkLabel`, containing the text in @str. + Creates a new `GtkLabel`, containing the text in @str. If characters in @str are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use @@ -46927,13 +49300,14 @@ activatable ancestor of the `GtkLabel` will be chosen as the mnemonic widget. For instance, if the label is inside a button or menu item, the button or menu item will automatically become the mnemonic widget and be activated by the mnemonic. + - the new `GtkLabel` + the new `GtkLabel` - The text of the label, with an underscore in front of the + The text of the label, with an underscore in front of the mnemonic character @@ -46941,7 +49315,7 @@ and be activated by the mnemonic. - Gets the labels attribute list. + Gets the labels attribute list. This is the [struct@Pango.AttrList] that was set on the label using [method@Gtk.Label.set_attributes], if any. This function does not @@ -46949,19 +49323,20 @@ reflect attributes that come from the labels markup (see [method@Gtk.Label.set_markup]). If you want to get the effective attributes for the label, use `pango_layout_get_attribute (gtk_label_get_layout (self))`. + - the attribute list + the attribute list - a `GtkLabel` + a `GtkLabel` - Returns the URI for the currently active link in the label. + Returns the URI for the currently active link in the label. The active link is the one under the mouse pointer or, in a selectable label, the link in which the text cursor is currently @@ -46969,404 +49344,427 @@ positioned. This function is intended for use in a [signal@Gtk.Label::activate-link] handler or for use in a [signal@Gtk.Widget::query-tooltip] handler. + - the currently active URI + the currently active URI - a `GtkLabel` + a `GtkLabel` - Returns the ellipsizing position of the label. + Returns the ellipsizing position of the label. See [method@Gtk.Label.set_ellipsize]. + - `PangoEllipsizeMode` + `PangoEllipsizeMode` - a `GtkLabel` + a `GtkLabel` - Gets the extra menu model of @label. + Gets the extra menu model of @label. See [method@Gtk.Label.set_extra_menu]. + - the menu model + the menu model - a `GtkLabel` + a `GtkLabel` - Returns the justification of the label. + Returns the justification of the label. See [method@Gtk.Label.set_justify]. + - `GtkJustification` + `GtkJustification` - a `GtkLabel` + a `GtkLabel` - Fetches the text from a label. + Fetches the text from a label. The returned text includes any embedded underlines indicating mnemonics and Pango markup. (See [method@Gtk.Label.get_text]). + - the text of the label widget. This string is + the text of the label widget. This string is owned by the widget and must not be modified or freed. - a `GtkLabel` + a `GtkLabel` - Gets the `PangoLayout` used to display the label. + Gets the `PangoLayout` used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with [method@Gtk.Label.get_layout_offsets]. The returned layout is owned by the @label so need not be freed by the caller. The @label is free to recreate its layout at any time, so it should be considered read-only. + - the [class@Pango.Layout] for this label + the [class@Pango.Layout] for this label - a `GtkLabel` + a `GtkLabel` - Obtains the coordinates where the label will draw its `PangoLayout`. + Obtains the coordinates where the label will draw its `PangoLayout`. The coordinates are useful to convert mouse events into coordinates inside the [class@Pango.Layout], e.g. to take some action if some part of the label is clicked. Remember when using the [class@Pango.Layout] functions you need to convert to and from pixels using PANGO_PIXELS() or [const@Pango.SCALE]. + - a `GtkLabel` + a `GtkLabel` - location to store X offset of layout + location to store X offset of layout - location to store Y offset of layout + location to store Y offset of layout - Gets the number of lines to which an ellipsized, wrapping + Gets the number of lines to which an ellipsized, wrapping label should be limited. See [method@Gtk.Label.set_lines]. + - The number of lines + The number of lines - a `GtkLabel` + a `GtkLabel` - Retrieves the desired maximum width of @label, in characters. + Retrieves the desired maximum width of @label, in characters. See [method@Gtk.Label.set_width_chars]. + - the maximum width of the label in characters. + the maximum width of the label in characters. - a `GtkLabel` + a `GtkLabel` - Return the mnemonic accelerator. + Return the mnemonic accelerator. If the label has been set so that it has a mnemonic key this function returns the keyval used for the mnemonic accelerator. If there is no mnemonic set up it returns `GDK_KEY_VoidSymbol`. + - GDK keyval usable for accelerators, or `GDK_KEY_VoidSymbol` + GDK keyval usable for accelerators, or `GDK_KEY_VoidSymbol` - a `GtkLabel` + a `GtkLabel` - Retrieves the target of the mnemonic (keyboard shortcut) of this + Retrieves the target of the mnemonic (keyboard shortcut) of this label. See [method@Gtk.Label.set_mnemonic_widget]. + - the target of the label’s mnemonic, + the target of the label’s mnemonic, or %NULL if none has been set and the default algorithm will be used. - a `GtkLabel` + a `GtkLabel` - Returns whether the label is selectable. + Returns whether the label is selectable. + - %TRUE if the user can copy text from the label + %TRUE if the user can copy text from the label - a `GtkLabel` + a `GtkLabel` - Gets the selected range of characters in the label. + Gets the selected range of characters in the label. + - %TRUE if selection is non-empty + %TRUE if selection is non-empty - a `GtkLabel` + a `GtkLabel` - return location for start of selection, as a character offset + return location for start of selection, as a character offset - return location for end of selection, as a character offset + return location for end of selection, as a character offset - Returns whether the label is in single line mode. + Returns whether the label is in single line mode. + - %TRUE when the label is in single line mode. + %TRUE when the label is in single line mode. - a `GtkLabel` + a `GtkLabel` - Fetches the text from a label. + Fetches the text from a label. The returned text is as it appears on screen. This does not include any embedded underlines indicating mnemonics or Pango markup. (See [method@Gtk.Label.get_label]) + - the text in the label widget. This is the internal + the text in the label widget. This is the internal string used by the label, and must not be modified. - a `GtkLabel` + a `GtkLabel` - Returns whether the label’s text is interpreted as Pango markup. + Returns whether the label’s text is interpreted as Pango markup. See [method@Gtk.Label.set_use_markup]. + - %TRUE if the label’s text will be parsed for markup. + %TRUE if the label’s text will be parsed for markup. - a `GtkLabel` + a `GtkLabel` - Returns whether an embedded underlines in the label indicate mnemonics. + Returns whether an embedded underlines in the label indicate mnemonics. See [method@Gtk.Label.set_use_underline]. + - %TRUE whether an embedded underline in the label indicates + %TRUE whether an embedded underline in the label indicates the mnemonic accelerator keys. - a `GtkLabel` + a `GtkLabel` - Retrieves the desired width of @label, in characters. + Retrieves the desired width of @label, in characters. See [method@Gtk.Label.set_width_chars]. + - the width of the label in characters. + the width of the label in characters. - a `GtkLabel` + a `GtkLabel` - Returns whether lines in the label are automatically wrapped. + Returns whether lines in the label are automatically wrapped. See [method@Gtk.Label.set_wrap]. + - %TRUE if the lines of the label are automatically wrapped. + %TRUE if the lines of the label are automatically wrapped. - a `GtkLabel` + a `GtkLabel` - Returns line wrap mode used by the label. + Returns line wrap mode used by the label. See [method@Gtk.Label.set_wrap_mode]. + - %TRUE if the lines of the label are automatically wrapped. + %TRUE if the lines of the label are automatically wrapped. - a `GtkLabel` + a `GtkLabel` - Gets the `xalign` of the label. + Gets the `xalign` of the label. See the [property@Gtk.Label:xalign] property. + - the xalign property + the xalign property - a `GtkLabel` + a `GtkLabel` - Gets the `yalign` of the label. + Gets the `yalign` of the label. See the [property@Gtk.Label:yalign] property. + - the yalign property + the yalign property - a `GtkLabel` + a `GtkLabel` - Selects a range of characters in the label, if the label is selectable. + Selects a range of characters in the label, if the label is selectable. See [method@Gtk.Label.set_selectable]. If the label is not selectable, this function has no effect. If @start_offset or @end_offset are -1, then the end of the label will be substituted. + - a `GtkLabel` + a `GtkLabel` - start offset (in characters not bytes) + start offset (in characters not bytes) - end offset (in characters not bytes) + end offset (in characters not bytes) - Apply attributes to the label text. + Apply attributes to the label text. The attributes set with this function will be applied and merged with any other attributes previously effected by way of the @@ -47374,61 +49772,64 @@ any other attributes previously effected by way of the properties. While it is not recommended to mix markup strings with manually set attributes, if you must; know that the attributes will be applied to the label after the markup string is parsed. + - a `GtkLabel` + a `GtkLabel` - a [struct@Pango.AttrList] + a [struct@Pango.AttrList] - Sets the mode used to ellipsizei the text. + Sets the mode used to ellipsizei the text. The text will be ellipsized if there is not enough space to render the entire string. + - a `GtkLabel` + a `GtkLabel` - a `PangoEllipsizeMode` + a `PangoEllipsizeMode` - Sets a menu model to add when constructing + Sets a menu model to add when constructing the context menu for @label. + - a `GtkLabel` + a `GtkLabel` - a `GMenuModel` + a `GMenuModel` - Sets the alignment of the lines in the text of the label relative to + Sets the alignment of the lines in the text of the label relative to each other. %GTK_JUSTIFY_LEFT is the default value when the widget is first created @@ -47436,64 +49837,67 @@ with [ctor@Gtk.Label.new]. If you instead want to set the alignment of the label as a whole, use [method@Gtk.Widget.set_halign] instead. [method@Gtk.Label.set_justify] has no effect on labels containing only a single line. + - a `GtkLabel` + a `GtkLabel` - a `GtkJustification` + a `GtkJustification` - Sets the text of the label. + Sets the text of the label. The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the [property@Gtk.Label:use-underline] and [property@Gtk.Label:use-markup] properties. + - a `GtkLabel` + a `GtkLabel` - the new text to set for the label + the new text to set for the label - Sets the number of lines to which an ellipsized, wrapping label + Sets the number of lines to which an ellipsized, wrapping label should be limited. This has no effect if the label is not wrapping or ellipsized. Set this to -1 if you don’t want to limit the number of lines. + - a `GtkLabel` + a `GtkLabel` - the desired number of lines, or -1 + the desired number of lines, or -1 - Sets the labels text and attributes from markup. + Sets the labels text and attributes from markup. The string must be marked up with Pango markup (see [func@Pango.parse_markup]). @@ -47520,22 +49924,23 @@ property you should also ensure that you set the [property@Gtk.Label:use-markup] property accordingly. See also: [method@Gtk.Label.set_text] + - a `GtkLabel` + a `GtkLabel` - a markup string + a markup string - Sets the labels text, attributes and mnemonic from markup. + Sets the labels text, attributes and mnemonic from markup. Parses @str which is marked up with Pango markup (see [func@Pango.parse_markup]), setting the label’s text and attribute list based on the parse results. @@ -47544,40 +49949,42 @@ indicating that they represent a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. + - a `GtkLabel` + a `GtkLabel` - a markup string + a markup string - Sets the desired maximum width in characters of @label to @n_chars. + Sets the desired maximum width in characters of @label to @n_chars. + - a `GtkLabel` + a `GtkLabel` - the new desired maximum width, in characters. + the new desired maximum width, in characters. - Associate the label with its mnemonic target. + Associate the label with its mnemonic target. If the label has been set so that it has a mnemonic key (using i.e. [method@Gtk.Label.set_markup_with_mnemonic], @@ -47594,59 +50001,62 @@ The target widget will be accelerated by emitting the [signal@GtkWidget::mnemonic-activate] signal on it. The default handler for this signal will activate the widget if there are no mnemonic collisions and toggle focus between the colliding widgets otherwise. + - a `GtkLabel` + a `GtkLabel` - the target `GtkWidget`, or %NULL to unset + the target `GtkWidget`, or %NULL to unset - Makes text in the label selectable. + Makes text in the label selectable. Selectable labels allow the user to select text from the label, for copy-and-paste. + - a `GtkLabel` + a `GtkLabel` - %TRUE to allow selecting text in the label + %TRUE to allow selecting text in the label - Sets whether the label is in single line mode. + Sets whether the label is in single line mode. + - a `GtkLabel` + a `GtkLabel` - %TRUE if the label should be in single line mode + %TRUE if the label should be in single line mode - Sets the text within the `GtkLabel` widget. + Sets the text within the `GtkLabel` widget. It overwrites any text that was there before. @@ -47658,97 +50068,102 @@ This function will set the [property@Gtk.Label:use-markup] property to %FALSE as a side effect. See also: [method@Gtk.Label.set_markup] + - a `GtkLabel` + a `GtkLabel` - The text you want to set + The text you want to set - Sets the label’s text from the string @str. + Sets the label’s text from the string @str. If characters in @str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. + - a `GtkLabel` + a `GtkLabel` - a string + a string - Sets whether the text of the label contains markup. + Sets whether the text of the label contains markup. See [method@Gtk.Label.set_markup]. + - a `GtkLabel` + a `GtkLabel` - %TRUE if the label’s text should be parsed for markup. + %TRUE if the label’s text should be parsed for markup. - Sets whether underlines in the text indicate mnemonics. + Sets whether underlines in the text indicate mnemonics. + - a `GtkLabel` + a `GtkLabel` - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics - Sets the desired width in characters of @label to @n_chars. + Sets the desired width in characters of @label to @n_chars. + - a `GtkLabel` + a `GtkLabel` - the new desired width, in characters. + the new desired width, in characters. - Toggles line wrapping within the `GtkLabel` widget. + Toggles line wrapping within the `GtkLabel` widget. %TRUE makes it break lines if text exceeds the widget’s size. %FALSE lets the text get cut off by the edge of the widget if @@ -47759,75 +50174,79 @@ wrap at its parent container’s width, because GTK widgets conceptually can’t make their requisition depend on the parent container’s size. For a label that wraps at a specific position, set the label’s width using [method@Gtk.Widget.set_size_request]. + - a `GtkLabel` + a `GtkLabel` - the setting + the setting - Controls how line wrapping is done. + Controls how line wrapping is done. This only affects the label if line wrapping is on. (See [method@Gtk.Label.set_wrap]) The default is %PANGO_WRAP_WORD which means wrap on word boundaries. + - a `GtkLabel` + a `GtkLabel` - the line wrapping mode + the line wrapping mode - Sets the `xalign` of the label. + Sets the `xalign` of the label. See the [property@Gtk.Label:xalign] property. + - a `GtkLabel` + a `GtkLabel` - the new xalign value, between 0 and 1 + the new xalign value, between 0 and 1 - Sets the `yalign` of the label. + Sets the `yalign` of the label. See the [property@Gtk.Label:yalign] property. + - a `GtkLabel` + a `GtkLabel` - the new yalign value, between 0 and 1 + the new yalign value, between 0 and 1 @@ -47835,13 +50254,13 @@ See the [property@Gtk.Label:yalign] property. - A list of style attributes to apply to the text of the label. + A list of style attributes to apply to the text of the label. - The preferred place to ellipsize the string, if the label does + The preferred place to ellipsize the string, if the label does not have enough room to display the entire string. Note that setting this property to a value other than @@ -47856,13 +50275,13 @@ and [method@Gtk.Label.set_width_chars]. - A menu model whose contents will be appended to the context menu. + A menu model whose contents will be appended to the context menu. - The alignment of the lines in the text of the label, relative to each other. + The alignment of the lines in the text of the label, relative to each other. This does *not* affect the alignment of the label within its allocation. See [property@Gtk.Label:xalign] for that. @@ -47871,7 +50290,7 @@ See [property@Gtk.Label:xalign] for that. - The contents of the label. + The contents of the label. If the string contains Pango markup (see [func@Pango.parse_markup]), you will have to set the [property@Gtk.Label:use-markup] property to @@ -47888,7 +50307,7 @@ for the label to display them. - The number of lines to which an ellipsized, wrapping label + The number of lines to which an ellipsized, wrapping label should be limited. This property has no effect if the label is not wrapping or ellipsized. @@ -47898,7 +50317,7 @@ Set this property to -1 if you don't want to limit the number of lines. - The desired maximum width of the label, in characters. + The desired maximum width of the label, in characters. If this property is set to -1, the width will be calculated automatically. @@ -47909,25 +50328,25 @@ determine the width of ellipsized and wrapped labels. - The mnemonic accelerator key for the label. + The mnemonic accelerator key for the label. - The widget to be activated when the labels mnemonic key is pressed. + The widget to be activated when the labels mnemonic key is pressed. - Whether the label text can be selected with the mouse. + Whether the label text can be selected with the mouse. - Whether the label is in single line mode. + Whether the label is in single line mode. In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This @@ -47938,7 +50357,7 @@ of text changes would be distracting, e.g. in a statusbar. - %TRUE if the text of the label includes Pango markup. + %TRUE if the text of the label includes Pango markup. See [func@Pango.parse_markup]. @@ -47946,13 +50365,13 @@ See [func@Pango.parse_markup]. - %TRUE if the text of the label indicates a mnemonic with _. + %TRUE if the text of the label indicates a mnemonic with _. - The desired width of the label, in characters. + The desired width of the label, in characters. If this property is set to -1, the width will be calculated automatically. @@ -47964,13 +50383,13 @@ determine the width of ellipsized and wrapped labels. - %TRUE if the label text will wrap if it gets too wide. + %TRUE if the label text will wrap if it gets too wide. - Controls how the line wrapping is done. + Controls how the line wrapping is done. This only affects the formatting if line wrapping is on (see the [property@Gtk.Label:wrap] property). The default is %PANGO_WRAP_WORD, @@ -47980,7 +50399,7 @@ which means wrap on word boundaries. - The horizontal alignment of the label text inside its size allocation. + The horizontal alignment of the label text inside its size allocation. Compare this to [property@Gtk.Widget:halign], which determines how the labels size allocation is positioned in the space available for the label. @@ -47989,14 +50408,14 @@ labels size allocation is positioned in the space available for the label. - The vertical alignment of the label text inside its size allocation. + The vertical alignment of the label text inside its size allocation. Compare this to [property@Gtk.Widget:valign], which determines how the labels size allocation is positioned in the space available for the label. - Gets emitted when the user activates a link in the label. + Gets emitted when the user activates a link in the label. The ::activate-current-link is a [keybinding signal](class.SignalAction.html). @@ -48009,23 +50428,23 @@ The default bindings for this signal are all forms of the Enter key. - Gets emitted to activate a URI. + Gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri(). - %TRUE if the link has been activated + %TRUE if the link has been activated - the URI that is activated + the URI that is activated - Gets emitted to copy the slection to the clipboard. + Gets emitted to copy the slection to the clipboard. The ::copy-clipboard signal is a [keybinding signal](class.SignalAction.html). @@ -48035,7 +50454,7 @@ The default binding for this signal is Ctrl-c. - Gets emitted when the user initiates a cursor movement. + Gets emitted when the user initiates a cursor movement. The ::move-cursor signal is a [keybinding signal](class.SignalAction.html). If the cursor is not visible in @entry, this signal causes the viewport to @@ -48057,22 +50476,22 @@ There are too many key combinations to list them all here. - the granularity of the move, as a `GtkMovementStep` + the granularity of the move, as a `GtkMovementStep` - the number of @step units to move + the number of @step units to move - %TRUE if the move should extend the selection + %TRUE if the move should extend the selection - `GtkLayoutChild` is the base class for objects that are meant to hold + `GtkLayoutChild` is the base class for objects that are meant to hold layout properties. If a `GtkLayoutManager` has per-child properties, like their packing type, @@ -48081,43 +50500,46 @@ manager should use a `GtkLayoutChild` implementation to store those properties. A `GtkLayoutChild` instance is only ever valid while a widget is part of a layout. + - Retrieves the `GtkWidget` associated to the given @layout_child. + Retrieves the `GtkWidget` associated to the given @layout_child. + - a `GtkWidget` + a `GtkWidget` - a `GtkLayoutChild` + a `GtkLayoutChild` - Retrieves the `GtkLayoutManager` instance that created the + Retrieves the `GtkLayoutManager` instance that created the given @layout_child. + - a `GtkLayoutManager` + a `GtkLayoutManager` - a `GtkLayoutChild` + a `GtkLayoutChild` - The widget that is associated to the `GtkLayoutChild` instance. + The widget that is associated to the `GtkLayoutChild` instance. - The layout manager that created the `GtkLayoutChild` instance. + The layout manager that created the `GtkLayoutChild` instance. @@ -48125,12 +50547,13 @@ given @layout_child. + - Layout managers are delegate classes that handle the preferred size + Layout managers are delegate classes that handle the preferred size and the allocation of a widget. You typically subclass `GtkLayoutManager` if you want to implement a @@ -48178,58 +50601,62 @@ Each `GtkLayoutManager` instance creating a `GtkLayoutChild` should use the layout properties; each `GtkLayoutChild` instance should call [method@Gtk.LayoutManager.layout_changed] every time a property is updated, in order to queue a new size measuring and allocation. + - Assigns the given @width, @height, and @baseline to + Assigns the given @width, @height, and @baseline to a @widget, and computes the position and sizes of the children of the @widget using the layout management policy of @manager. + - a `GtkLayoutManager` + a `GtkLayoutManager` - the `GtkWidget` using @manager + the `GtkWidget` using @manager - the new width of the @widget + the new width of the @widget - the new height of the @widget + the new height of the @widget - the baseline position of the @widget, or -1 + the baseline position of the @widget, or -1 - Create a `GtkLayoutChild` instance for the given @for_child widget. + Create a `GtkLayoutChild` instance for the given @for_child widget. + - a `GtkLayoutChild` + a `GtkLayoutChild` - the `GtkLayoutManager` + the `GtkLayoutManager` - the widget using the @manager + the widget using the @manager - the child of @widget + the child of @widget + @@ -48243,29 +50670,30 @@ the @widget using the layout management policy of @manager. - Measures the size of the @widget using @manager, for the + Measures the size of the @widget using @manager, for the given @orientation and size. See the [class@Gtk.Widget] documentation on layout management for more details. + - a `GtkLayoutManager` + a `GtkLayoutManager` - the `GtkWidget` using @manager + the `GtkWidget` using @manager - the orientation to measure + the orientation to measure - Size for the opposite of @orientation; for instance, if + Size for the opposite of @orientation; for instance, if the @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height of the widget; if the @orientation is %GTK_ORIENTATION_VERTICAL, this is the width of the widget. This allows to measure the height for the @@ -48274,28 +50702,29 @@ more details. - the minimum size for the given size and + the minimum size for the given size and orientation - the natural, or preferred size for the + the natural, or preferred size for the given size and orientation - the baseline position for the + the baseline position for the minimum size - the baseline position for the + the baseline position for the natural size + @@ -48306,6 +50735,7 @@ more details. + @@ -48316,37 +50746,38 @@ more details. - Assigns the given @width, @height, and @baseline to + Assigns the given @width, @height, and @baseline to a @widget, and computes the position and sizes of the children of the @widget using the layout management policy of @manager. + - a `GtkLayoutManager` + a `GtkLayoutManager` - the `GtkWidget` using @manager + the `GtkWidget` using @manager - the new width of the @widget + the new width of the @widget - the new height of the @widget + the new height of the @widget - the baseline position of the @widget, or -1 + the baseline position of the @widget, or -1 - Retrieves a `GtkLayoutChild` instance for the `GtkLayoutManager`, + Retrieves a `GtkLayoutChild` instance for the `GtkLayoutManager`, creating one if necessary. The @child widget must be a child of the widget using @manager. @@ -48354,86 +50785,91 @@ The @child widget must be a child of the widget using @manager. The `GtkLayoutChild` instance is owned by the `GtkLayoutManager`, and is guaranteed to exist as long as @child is a child of the `GtkWidget` using the given `GtkLayoutManager`. + - a `GtkLayoutChild` + a `GtkLayoutChild` - a `GtkLayoutManager` + a `GtkLayoutManager` - a `GtkWidget` + a `GtkWidget` - Retrieves the request mode of @manager. + Retrieves the request mode of @manager. + - a `GtkSizeRequestMode` + a `GtkSizeRequestMode` - a `GtkLayoutManager` + a `GtkLayoutManager` - Retrieves the `GtkWidget` using the given `GtkLayoutManager`. + Retrieves the `GtkWidget` using the given `GtkLayoutManager`. + - a `GtkWidget` + a `GtkWidget` - a `GtkLayoutManager` + a `GtkLayoutManager` - Queues a resize on the `GtkWidget` using @manager, if any. + Queues a resize on the `GtkWidget` using @manager, if any. This function should be called by subclasses of `GtkLayoutManager` in response to changes to their layout management policies. + - a `GtkLayoutManager` + a `GtkLayoutManager` - Measures the size of the @widget using @manager, for the + Measures the size of the @widget using @manager, for the given @orientation and size. See the [class@Gtk.Widget] documentation on layout management for more details. + - a `GtkLayoutManager` + a `GtkLayoutManager` - the `GtkWidget` using @manager + the `GtkWidget` using @manager - the orientation to measure + the orientation to measure - Size for the opposite of @orientation; for instance, if + Size for the opposite of @orientation; for instance, if the @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height of the widget; if the @orientation is %GTK_ORIENTATION_VERTICAL, this is the width of the widget. This allows to measure the height for the @@ -48442,22 +50878,22 @@ more details. - the minimum size for the given size and + the minimum size for the given size and orientation - the natural, or preferred size for the + the natural, or preferred size for the given size and orientation - the baseline position for the + the baseline position for the minimum size - the baseline position for the + the baseline position for the natural size @@ -48468,14 +50904,16 @@ more details. - The `GtkLayoutManagerClass` structure contains only private data, and + The `GtkLayoutManagerClass` structure contains only private data, and should only be accessed through the provided API, or when subclassing `GtkLayoutManager`. + + @@ -48491,24 +50929,25 @@ should only be accessed through the provided API, or when subclassing + - a `GtkLayoutManager` + a `GtkLayoutManager` - the `GtkWidget` using @manager + the `GtkWidget` using @manager - the orientation to measure + the orientation to measure - Size for the opposite of @orientation; for instance, if + Size for the opposite of @orientation; for instance, if the @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height of the widget; if the @orientation is %GTK_ORIENTATION_VERTICAL, this is the width of the widget. This allows to measure the height for the @@ -48517,22 +50956,22 @@ should only be accessed through the provided API, or when subclassing - the minimum size for the given size and + the minimum size for the given size and orientation - the natural, or preferred size for the + the natural, or preferred size for the given size and orientation - the baseline position for the + the baseline position for the minimum size - the baseline position for the + the baseline position for the natural size @@ -48541,54 +50980,56 @@ should only be accessed through the provided API, or when subclassing + - a `GtkLayoutManager` + a `GtkLayoutManager` - the `GtkWidget` using @manager + the `GtkWidget` using @manager - the new width of the @widget + the new width of the @widget - the new height of the @widget + the new height of the @widget - the baseline position of the @widget, or -1 + the baseline position of the @widget, or -1 - the type of `GtkLayoutChild` used by this layout manager + the type of `GtkLayoutChild` used by this layout manager + - a `GtkLayoutChild` + a `GtkLayoutChild` - the `GtkLayoutManager` + the `GtkLayoutManager` - the widget using the @manager + the widget using the @manager - the child of @widget + the child of @widget @@ -48596,6 +51037,7 @@ should only be accessed through the provided API, or when subclassing + @@ -48608,6 +51050,7 @@ should only be accessed through the provided API, or when subclassing + @@ -48625,7 +51068,7 @@ should only be accessed through the provided API, or when subclassing - `GtkLevelBar` is a widget that can be used as a level indicator. + `GtkLevelBar` is a widget that can be used as a level indicator. Typical use cases are displaying the strength of a password, or showing the charge level of a battery. @@ -48727,31 +51170,33 @@ regardless of text direction. - Creates a new `GtkLevelBar`. + Creates a new `GtkLevelBar`. + - a `GtkLevelBar`. + a `GtkLevelBar`. - Creates a new `GtkLevelBar` for the specified interval. + Creates a new `GtkLevelBar` for the specified interval. + - a `GtkLevelBar` + a `GtkLevelBar` - a positive value + a positive value - a positive value + a positive value - Adds a new offset marker on @self at the position specified by @value. + Adds a new offset marker on @self at the position specified by @value. When the bar value is in the interval topped by @value (or between @value and [property@Gtk.LevelBar:max-value] in case the offset is the last one @@ -48760,222 +51205,235 @@ when rendering the level bar fill. If another offset marker named @name exists, its value will be replaced by @value. + - a `GtkLevelBar` + a `GtkLevelBar` - the name of the new offset + the name of the new offset - the value for the new offset + the value for the new offset - Returns whether the levelbar is inverted. + Returns whether the levelbar is inverted. + - %TRUE if the level bar is inverted + %TRUE if the level bar is inverted - a `GtkLevelBar` + a `GtkLevelBar` - Returns the `max-value` of the `GtkLevelBar`. + Returns the `max-value` of the `GtkLevelBar`. + - a positive value + a positive value - a `GtkLevelBar` + a `GtkLevelBar` - Returns the `min-value of the `GtkLevelBar`. + Returns the `min-value of the `GtkLevelBar`. + - a positive value + a positive value - a `GtkLevelBar` + a `GtkLevelBar` - Returns the `mode` of the `GtkLevelBar`. + Returns the `mode` of the `GtkLevelBar`. + - a `GtkLevelBarMode` + a `GtkLevelBarMode` - a `GtkLevelBar` + a `GtkLevelBar` - Fetches the value specified for the offset marker @name in @self. + Fetches the value specified for the offset marker @name in @self. + - %TRUE if the specified offset is found + %TRUE if the specified offset is found - a `GtkLevelBar` + a `GtkLevelBar` - the name of an offset in the bar + the name of an offset in the bar - location where to store the value + location where to store the value - Returns the `value` of the `GtkLevelBar`. + Returns the `value` of the `GtkLevelBar`. + - a value in the interval between + a value in the interval between [property@Gtk.LevelBar:min-value[ and [property@Gtk.LevelBar:max-value] - a `GtkLevelBar` + a `GtkLevelBar` - Removes an offset marker from a `GtkLevelBar`. + Removes an offset marker from a `GtkLevelBar`. The marker must have been previously added with [method@Gtk.LevelBar.add_offset_value]. + - a `GtkLevelBar` + a `GtkLevelBar` - the name of an offset in the bar + the name of an offset in the bar - Sets whether the `GtkLevelBar` is inverted. + Sets whether the `GtkLevelBar` is inverted. + - a `GtkLevelBar` + a `GtkLevelBar` - %TRUE to invert the level bar + %TRUE to invert the level bar - Sets the `max-value` of the `GtkLevelBar`. + Sets the `max-value` of the `GtkLevelBar`. You probably want to update preexisting level offsets after calling this function. + - a `GtkLevelBar` + a `GtkLevelBar` - a positive value + a positive value - Sets the `min-value` of the `GtkLevelBar`. + Sets the `min-value` of the `GtkLevelBar`. You probably want to update preexisting level offsets after calling this function. + - a `GtkLevelBar` + a `GtkLevelBar` - a positive value + a positive value - Sets the `mode` of the `GtkLevelBar`. + Sets the `mode` of the `GtkLevelBar`. + - a `GtkLevelBar` + a `GtkLevelBar` - a `GtkLevelBarMode` + a `GtkLevelBarMode` - Sets the value of the `GtkLevelBar`. + Sets the value of the `GtkLevelBar`. + - a `GtkLevelBar` + a `GtkLevelBar` - a value in the interval between + a value in the interval between [property@Gtk.LevelBar:min-value] and [property@Gtk.LevelBar:max-value] @@ -48984,7 +51442,7 @@ this function. - Whether the `GtkLeveBar` is inverted. + Whether the `GtkLeveBar` is inverted. Level bars normally grow from top to bottom or left to right. Inverted level bars grow in the opposite direction. @@ -48993,19 +51451,19 @@ Inverted level bars grow in the opposite direction. - Determines the maximum value of the interval that can be displayed by the bar. + Determines the maximum value of the interval that can be displayed by the bar. - Determines the minimum value of the interval that can be displayed by the bar. + Determines the minimum value of the interval that can be displayed by the bar. - Determines the way `GtkLevelBar` interprets the value properties to draw the + Determines the way `GtkLevelBar` interprets the value properties to draw the level fill area. Specifically, when the value is %GTK_LEVEL_BAR_MODE_CONTINUOUS, @@ -49020,11 +51478,11 @@ the integral roundings of [property@Gtk.LevelBar:min-value] and - Determines the currently filled value of the level bar. + Determines the currently filled value of the level bar. - Emitted when an offset specified on the bar changes value. + Emitted when an offset specified on the bar changes value. This typically is the result of a [method@Gtk.LevelBar.add_offset_value] call. @@ -49037,86 +51495,86 @@ the value of offset "x" changes. - the name of the offset that changed value + the name of the offset that changed value - Describes how `GtkLevelBar` contents should be rendered. + Describes how `GtkLevelBar` contents should be rendered. Note that this enumeration could be extended with additional modes in the future. - the bar has a continuous mode + the bar has a continuous mode - the bar has a discrete mode + the bar has a discrete mode - The type of license for an application. + The type of license for an application. This enumeration can be expanded at later date. - No license specified + No license specified - A license text is going to be specified by the + A license text is going to be specified by the developer - The GNU General Public License, version 2.0 or later + The GNU General Public License, version 2.0 or later - The GNU General Public License, version 3.0 or later + The GNU General Public License, version 3.0 or later - The GNU Lesser General Public License, version 2.1 or later + The GNU Lesser General Public License, version 2.1 or later - The GNU Lesser General Public License, version 3.0 or later + The GNU Lesser General Public License, version 3.0 or later - The BSD standard license + The BSD standard license - The MIT/X11 standard license + The MIT/X11 standard license - The Artistic License, version 2.0 + The Artistic License, version 2.0 - The GNU General Public License, version 2.0 only + The GNU General Public License, version 2.0 only - The GNU General Public License, version 3.0 only + The GNU General Public License, version 3.0 only - The GNU Lesser General Public License, version 2.1 only + The GNU Lesser General Public License, version 2.1 only - The GNU Lesser General Public License, version 3.0 only + The GNU Lesser General Public License, version 3.0 only - The GNU Affero General Public License, version 3.0 or later + The GNU Affero General Public License, version 3.0 or later - The GNU Affero General Public License, version 3.0 only + The GNU Affero General Public License, version 3.0 only - The 3-clause BSD licence + The 3-clause BSD licence - The Apache License, version 2.0 + The Apache License, version 2.0 - The Mozilla Public License, version 2.0 + The Mozilla Public License, version 2.0 - A `GtkLinkButton` is a button with a hyperlink. + A `GtkLinkButton` is a button with a hyperlink. ![An example GtkLinkButton](link-button.png) @@ -49147,103 +51605,109 @@ it from a plain `GtkButton`, it gets the .link style class. - Creates a new `GtkLinkButton` with the URI as its text. + Creates a new `GtkLinkButton` with the URI as its text. + - a new link button widget. + a new link button widget. - a valid URI + a valid URI - Creates a new `GtkLinkButton` containing a label. + Creates a new `GtkLinkButton` containing a label. + - a new link button widget. + a new link button widget. - a valid URI + a valid URI - the text of the button + the text of the button - Retrieves the URI of the `GtkLinkButton`. + Retrieves the URI of the `GtkLinkButton`. + - a valid URI. The returned string is owned by the link button + a valid URI. The returned string is owned by the link button and should not be modified or freed. - a `GtkLinkButton` + a `GtkLinkButton` - Retrieves the “visited” state of the `GtkLinkButton`. + Retrieves the “visited” state of the `GtkLinkButton`. The button becomes visited when it is clicked. If the URI is changed on the button, the “visited” state is unset again. The state may also be changed using [method@Gtk.LinkButton.set_visited]. + - %TRUE if the link has been visited, %FALSE otherwise + %TRUE if the link has been visited, %FALSE otherwise - a `GtkLinkButton` + a `GtkLinkButton` - Sets @uri as the URI where the `GtkLinkButton` points. + Sets @uri as the URI where the `GtkLinkButton` points. As a side-effect this unsets the “visited” state of the button. + - a `GtkLinkButton` + a `GtkLinkButton` - a valid URI + a valid URI - Sets the “visited” state of the `GtkLinkButton`. + Sets the “visited” state of the `GtkLinkButton`. See [method@Gtk.LinkButton.get_visited] for more details. + - a `GtkLinkButton` + a `GtkLinkButton` - the new “visited” state + the new “visited” state @@ -49251,19 +51715,19 @@ See [method@Gtk.LinkButton.get_visited] for more details. - The URI bound to this button. + The URI bound to this button. - The 'visited' state of this button. + The 'visited' state of this button. A visited link is drawn in a different color. - Emitted each time the `GtkLinkButton` is clicked. + Emitted each time the `GtkLinkButton` is clicked. The default handler will call [func@Gtk.show_uri] with the URI stored inside the [property@Gtk.LinkButton:uri] property. @@ -49272,27 +51736,30 @@ To override the default behavior, you can connect to the ::activate-link signal and stop the propagation of the signal by returning %TRUE from your handler. - %TRUE if the signal has been handled + %TRUE if the signal has been handled - `GtkListBase` is the abstract base class for GTK's list widgets. + `GtkListBase` is the abstract base class for GTK's list widgets. + - The orientation of the list. See GtkOrientable:orientation + The orientation of the list. See GtkOrientable:orientation for details. - + + + - `GtkListBox` is a vertical list. + `GtkListBox` is a vertical list. A `GtkListBox` only contains `GtkListBoxRow` children. These rows can by dynamically sorted and filtered, and headers can be added dynamically @@ -49346,33 +51813,35 @@ the %GTK_ACCESSIBLE_ROLE_LIST_ITEM role. - Creates a new `GtkListBox` container. + Creates a new `GtkListBox` container. + - a new `GtkListBox` + a new `GtkListBox` - Append a widget to the list. + Append a widget to the list. If a sort function is set, the widget will actually be inserted at the calculated position. + - a `GtkListBox` + a `GtkListBox` - the `GtkWidget` to add + the `GtkWidget` to add - Binds @model to @box. + Binds @model to @box. If @box was already bound to a model, that previous binding is destroyed. @@ -49387,35 +51856,36 @@ It is undefined to add or remove widgets directly (for example, with Note that using a model is incompatible with the filtering and sorting functionality in `GtkListBox`. When using a model, filtering and sorting should be implemented by the model. + - a `GtkListBox` + a `GtkListBox` - the `GListModel` to be bound to @box + the `GListModel` to be bound to @box - a function that creates widgets for items + a function that creates widgets for items or %NULL in case you also passed %NULL as @model - user data passed to @create_widget_func + user data passed to @create_widget_func - function for freeing @user_data + function for freeing @user_data - Add a drag highlight to a row. + Add a drag highlight to a row. This is a helper function for implementing DnD onto a `GtkListBox`. The passed in @row will be highlighted by setting the @@ -49424,119 +51894,127 @@ row will be unhighlighted. The row will also be unhighlighted when the widget gets a drag leave event. + - a `GtkListBox` + a `GtkListBox` - a `GtkListBoxRow` + a `GtkListBoxRow` - If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), + If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed. + - a `GtkListBox` + a `GtkListBox` - Returns whether rows activate on single clicks. + Returns whether rows activate on single clicks. + - %TRUE if rows are activated on single click, %FALSE otherwise + %TRUE if rows are activated on single click, %FALSE otherwise - a `GtkListBox` + a `GtkListBox` - Gets the adjustment (if any) that the widget uses to + Gets the adjustment (if any) that the widget uses to for vertical scrolling. + - the adjustment + the adjustment - a `GtkListBox` + a `GtkListBox` - Gets the n-th child in the list (not counting headers). + Gets the n-th child in the list (not counting headers). If @index_ is negative or larger than the number of items in the list, %NULL is returned. + - the child `GtkWidget` + the child `GtkWidget` - a `GtkListBox` + a `GtkListBox` - the index of the row + the index of the row - Gets the row at the @y position. + Gets the row at the @y position. + - the row + the row - a `GtkListBox` + a `GtkListBox` - position + position - Gets the selected row, or %NULL if no rows are selected. + Gets the selected row, or %NULL if no rows are selected. Note that the box may allow multiple selection, in which case you should use [method@Gtk.ListBox.selected_foreach] to find all selected rows. + - the selected row + the selected row - a `GtkListBox` + a `GtkListBox` - Creates a list of all selected children. + Creates a list of all selected children. + - + A `GList` containing the `GtkWidget` for each selected child. Free with g_list_free() when done. @@ -49545,221 +52023,233 @@ find all selected rows. - a `GtkListBox` + a `GtkListBox` - Gets the selection mode of the listbox. + Gets the selection mode of the listbox. + - a `GtkSelectionMode` + a `GtkSelectionMode` - a `GtkListBox` + a `GtkListBox` - Returns whether the list box should show separators + Returns whether the list box should show separators between rows. + - %TRUE if the list box shows separators + %TRUE if the list box shows separators - a `GtkListBox` + a `GtkListBox` - Insert the @child into the @box at @position. + Insert the @child into the @box at @position. If a sort function is set, the widget will actually be inserted at the calculated position. If @position is -1, or larger than the total number of items in the @box, then the @child will be appended to the end. + - a `GtkListBox` + a `GtkListBox` - the `GtkWidget` to add + the `GtkWidget` to add - the position to insert @child in + the position to insert @child in - Update the filtering for all rows. + Update the filtering for all rows. Call this when result of the filter function on the @box is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search string and the entry with the search string has changed. + - a `GtkListBox` + a `GtkListBox` - Update the separators for all rows. + Update the separators for all rows. Call this when result of the header function on the @box is changed due to an external factor. + - a `GtkListBox` + a `GtkListBox` - Update the sorting for all rows. + Update the sorting for all rows. Call this when result of the sort function on the @box is changed due to an external factor. + - a `GtkListBox` + a `GtkListBox` - Prepend a widget to the list. + Prepend a widget to the list. If a sort function is set, the widget will actually be inserted at the calculated position. + - a `GtkListBox` + a `GtkListBox` - the `GtkWidget` to add + the `GtkWidget` to add - Removes a child from @box. + Removes a child from @box. + - a `GtkListBox` + a `GtkListBox` - the child to remove + the child to remove - Select all children of @box, if the selection mode allows it. + Select all children of @box, if the selection mode allows it. + - a `GtkListBox` + a `GtkListBox` - Make @row the currently selected row. + Make @row the currently selected row. + - a `GtkListBox` + a `GtkListBox` - The row to select + The row to select - Calls a function for each selected child. + Calls a function for each selected child. Note that the selection cannot be modified from within this function. + - a `GtkListBox` + a `GtkListBox` - the function to call for each selected child + the function to call for each selected child - user data to pass to the function + user data to pass to the function - If @single is %TRUE, rows will be activated when you click on them, + If @single is %TRUE, rows will be activated when you click on them, otherwise you need to double-click. + - a `GtkListBox` + a `GtkListBox` - a boolean + a boolean - Sets the adjustment (if any) that the widget uses to + Sets the adjustment (if any) that the widget uses to for vertical scrolling. For instance, this is used to get the page size for @@ -49769,22 +52259,23 @@ In the normal case when the @box is packed inside a `GtkScrolledWindow` the adjustment from that will be picked up automatically, so there is no need to manually do that. + - a `GtkListBox` + a `GtkListBox` - the adjustment + the adjustment - By setting a filter function on the @box one can decide dynamically which + By setting a filter function on the @box one can decide dynamically which of the rows to show. For instance, to implement a search function on a list that @@ -49797,30 +52288,31 @@ is called. Note that using a filter function is incompatible with using a model (see [method@Gtk.ListBox.bind_model]). + - a `GtkListBox` + a `GtkListBox` - callback that lets you filter which rows to show + callback that lets you filter which rows to show - user data passed to @filter_func + user data passed to @filter_func - destroy notifier for @user_data + destroy notifier for @user_data - Sets a header function. + Sets a header function. By setting a header function on the @box one can dynamically add headers in front of rows, depending on the contents of the row and its position @@ -49845,82 +52337,86 @@ and it will continue to be called each time a row changes (via by [method@Gtk.ListBoxRow.changed] on the previous row, or when the previous row becomes a different row). It is also called for all rows when [method@Gtk.ListBox.invalidate_headers] is called. + - a `GtkListBox` + a `GtkListBox` - callback that lets you add row headers + callback that lets you add row headers - user data passed to @update_header + user data passed to @update_header - destroy notifier for @user_data + destroy notifier for @user_data - Sets the placeholder widget that is shown in the list when + Sets the placeholder widget that is shown in the list when it doesn't display any visible children. + - a `GtkListBox` + a `GtkListBox` - a `GtkWidget` + a `GtkWidget` - Sets how selection works in the listbox. + Sets how selection works in the listbox. + - a `GtkListBox` + a `GtkListBox` - The `GtkSelectionMode` + The `GtkSelectionMode` - Sets whether the list box should show separators + Sets whether the list box should show separators between rows. + - a `GtkListBox` + a `GtkListBox` - %TRUE to show separators + %TRUE to show separators - Sets a sort function. + Sets a sort function. By setting a sort function on the @box one can dynamically reorder the rows of the list, based on the contents of the rows. @@ -49932,77 +52428,80 @@ is called. Note that using a sort function is incompatible with using a model (see [method@Gtk.ListBox.bind_model]). + - a `GtkListBox` + a `GtkListBox` - the sort function + the sort function - user data passed to @sort_func + user data passed to @sort_func - destroy notifier for @user_data + destroy notifier for @user_data - Unselect all children of @box, if the selection mode allows it. + Unselect all children of @box, if the selection mode allows it. + - a `GtkListBox` + a `GtkListBox` - Unselects a single row of @box, if the selection mode allows it. + Unselects a single row of @box, if the selection mode allows it. + - a `GtkListBox` + a `GtkListBox` - the row to unselected + the row to unselected - Whether to accept unpaired release events. + Whether to accept unpaired release events. - Determines whether children can be activated with a single + Determines whether children can be activated with a single click, or require a double-click. - The selection mode used by the list box. + The selection mode used by the list box. - Whether to show separators between rows. + Whether to show separators between rows. @@ -50030,19 +52529,19 @@ click, or require a double-click. - Emitted when a row has been activated by the user. + Emitted when a row has been activated by the user. - the activated row + the activated row - Emitted when a new row is selected, or (with a %NULL @row) + Emitted when a new row is selected, or (with a %NULL @row) when the selection is cleared. When the @box is using %GTK_SELECTION_MULTIPLE, this signal will not @@ -50053,13 +52552,13 @@ the [signal@Gtk.ListBox::selected-rows-changed] signal instead. - the selected row + the selected row - Emitted to select all children of the box, if the selection + Emitted to select all children of the box, if the selection mode permits it. This is a [keybinding signal](class.SignalAction.html). @@ -50070,7 +52569,7 @@ The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>a& - Emitted when the set of selected rows changes. + Emitted when the set of selected rows changes. @@ -50081,7 +52580,7 @@ The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>a& - Emitted to unselect all children of the box, if the selection + Emitted to unselect all children of the box, if the selection mode permits it. This is a [keybinding signal](class.SignalAction.html). @@ -50094,77 +52593,83 @@ The default binding for this signal is - Called for list boxes that are bound to a `GListModel` with + Called for list boxes that are bound to a `GListModel` with gtk_list_box_bind_model() for each item that gets added to the model. + - a `GtkWidget` that represents @item + a `GtkWidget` that represents @item - the item from the model for which to create a widget for + the item from the model for which to create a widget for - user data + user data - Will be called whenever the row changes or is added and lets you control + Will be called whenever the row changes or is added and lets you control if the row should be visible or not. + - %TRUE if the row should be visible, %FALSE otherwise + %TRUE if the row should be visible, %FALSE otherwise - the row that may be filtered + the row that may be filtered - user data + user data - A function used by gtk_list_box_selected_foreach(). + A function used by gtk_list_box_selected_foreach(). It will be called on every selected child of the @box. + - a `GtkListBox` + a `GtkListBox` - a `GtkListBoxRow` + a `GtkListBoxRow` - user data + user data - `GtkListBoxRow` is the kind of widget that can be added to a `GtkListBox`. + `GtkListBoxRow` is the kind of widget that can be added to a `GtkListBox`. + - Creates a new `GtkListBoxRow`. + Creates a new `GtkListBoxRow`. + - a new `GtkListBoxRow` + a new `GtkListBoxRow` + @@ -50175,7 +52680,7 @@ It will be called on every selected child of the @box. - Marks @row as changed, causing any state that depends on this + Marks @row as changed, causing any state that depends on this to be updated. This affects sorting, filtering and headers. @@ -50193,171 +52698,182 @@ model you have to duplicate the data that affects the listbox row functions into the row widgets themselves. Another alternative is to call [method@Gtk.ListBox.invalidate_sort] on any model change, but that is more expensive. + - a `GtkListBoxRow` + a `GtkListBoxRow` - Gets whether the row is activatable. + Gets whether the row is activatable. + - %TRUE if the row is activatable + %TRUE if the row is activatable - a `GtkListBoxRow` + a `GtkListBoxRow` - Gets the child widget of @row. + Gets the child widget of @row. + - the child widget of @row + the child widget of @row - a `GtkListBoxRow` + a `GtkListBoxRow` - Returns the current header of the @row. + Returns the current header of the @row. This can be used in a [callback@Gtk.ListBoxUpdateHeaderFunc] to see if there is a header set already, and if so to update the state of it. + - the current header + the current header - a `GtkListBoxRow` + a `GtkListBoxRow` - Gets the current index of the @row in its `GtkListBox` container. + Gets the current index of the @row in its `GtkListBox` container. + - the index of the @row, or -1 if the @row is not in a listbox + the index of the @row, or -1 if the @row is not in a listbox - a `GtkListBoxRow` + a `GtkListBoxRow` - Gets whether the row can be selected. + Gets whether the row can be selected. + - %TRUE if the row is selectable + %TRUE if the row is selectable - a `GtkListBoxRow` + a `GtkListBoxRow` - Returns whether the child is currently selected in its + Returns whether the child is currently selected in its `GtkListBox` container. + - %TRUE if @row is selected + %TRUE if @row is selected - a `GtkListBoxRow` + a `GtkListBoxRow` - Set whether the row is activatable. + Set whether the row is activatable. + - a `GtkListBoxRow` + a `GtkListBoxRow` - %TRUE to mark the row as activatable + %TRUE to mark the row as activatable - Sets the child widget of @self. + Sets the child widget of @self. + - a `GtkListBoxRow` + a `GtkListBoxRow` - the child widget + the child widget - Sets the current header of the @row. + Sets the current header of the @row. This is only allowed to be called from a [callback@Gtk.ListBoxUpdateHeaderFunc]. It will replace any existing header in the row, and be shown in front of the row in the listbox. + - a `GtkListBoxRow` + a `GtkListBoxRow` - the header + the header - Set whether the row can be selected. + Set whether the row can be selected. + - a `GtkListBoxRow` + a `GtkListBoxRow` - %TRUE to mark the row as selectable + %TRUE to mark the row as selectable @@ -50365,27 +52881,27 @@ and be shown in front of the row in the listbox. - Determines whether the ::row-activated + Determines whether the ::row-activated signal will be emitted for this row. - The child widget. + The child widget. - Determines whether this row can be selected. + Determines whether this row can be selected. - This is a keybinding signal, which will cause this row to be activated. + This is a keybinding signal, which will cause this row to be activated. If you want to be notified when the user activates a row (by key or not), use the [signal@Gtk.ListBox::row-activated] signal on the row’s parent @@ -50396,12 +52912,14 @@ use the [signal@Gtk.ListBox::row-activated] signal on the row’s parent + - The parent class. + The parent class. + @@ -50419,53 +52937,55 @@ use the [signal@Gtk.ListBox::row-activated] signal on the row’s parent - Compare two rows to determine which should be first. + Compare two rows to determine which should be first. + - < 0 if @row1 should be before @row2, 0 if they are + < 0 if @row1 should be before @row2, 0 if they are equal and > 0 otherwise - the first row + the first row - the second row + the second row - user data + user data - Whenever @row changes or which row is before @row changes this + Whenever @row changes or which row is before @row changes this is called, which lets you update the header on @row. You may remove or set a new one via [method@Gtk.ListBoxRow.set_header] or just change the state of the current header widget. + - the row to update + the row to update - the row before @row, or %NULL if it is first + the row before @row, or %NULL if it is first - user data + user data - `GtkListItem` is used by list widgets to represent items in a `GListModel`. + `GtkListItem` is used by list widgets to represent items in a `GListModel`. The `GtkListItem`s are managed by the list widget (with its factory) and cannot be created by applications, but they need to be populated @@ -50479,105 +52999,112 @@ by application code. This is done by calling [method@Gtk.ListItem.set_child]. 2. The bound stage where the listitem references an item from the list. The [property@Gtk.ListItem:item] property is not %NULL. + - Checks if a list item has been set to be activatable via + Checks if a list item has been set to be activatable via gtk_list_item_set_activatable(). + - %TRUE if the item is activatable + %TRUE if the item is activatable - a `GtkListItem` + a `GtkListItem` - Gets the child previously set via gtk_list_item_set_child() or + Gets the child previously set via gtk_list_item_set_child() or %NULL if none was set. + - The child + The child - a `GtkListItem` + a `GtkListItem` - Gets the model item that associated with @self. + Gets the model item that associated with @self. If @self is unbound, this function returns %NULL. + - The item displayed + The item displayed - a `GtkListItem` + a `GtkListItem` - Gets the position in the model that @self currently displays. + Gets the position in the model that @self currently displays. If @self is unbound, %GTK_INVALID_LIST_POSITION is returned. + - The position of this item + The position of this item - a `GtkListItem` + a `GtkListItem` - Checks if a list item has been set to be selectable via + Checks if a list item has been set to be selectable via gtk_list_item_set_selectable(). Do not confuse this function with [method@Gtk.ListItem.get_selected]. + - %TRUE if the item is selectable + %TRUE if the item is selectable - a `GtkListItem` + a `GtkListItem` - Checks if the item is displayed as selected. + Checks if the item is displayed as selected. The selected state is maintained by the liste widget and its model and cannot be set otherwise. + - %TRUE if the item is selected. + %TRUE if the item is selected. - a `GtkListItem` + a `GtkListItem` - Sets @self to be activatable. + Sets @self to be activatable. If an item is activatable, double-clicking on the item, using the Return key or calling gtk_widget_activate() will activate @@ -50586,44 +53113,46 @@ activation. `GtkListView` for example will be emitting the [signal@Gtk.ListView::activate] signal. By default, list items are activatable. + - a `GtkListItem` + a `GtkListItem` - if the item should be activatable + if the item should be activatable - Sets the child to be used for this listitem. + Sets the child to be used for this listitem. This function is typically called by applications when setting up a listitem so that the widget can be reused when binding it multiple times. + - a `GtkListItem` + a `GtkListItem` - The list item's child or %NULL to unset + The list item's child or %NULL to unset - Sets @self to be selectable. + Sets @self to be selectable. If an item is selectable, clicking on the item or using the keyboard will try to select or unselect the item. If this succeeds is up to @@ -50635,16 +53164,17 @@ may still be selected. By default, list items are selectable. When rebinding them to a new item, they will also be reset to be selectable by GTK. + - a `GtkListItem` + a `GtkListItem` - if the item should be selectable + if the item should be selectable @@ -50652,40 +53182,42 @@ a new item, they will also be reset to be selectable by GTK. - If the item can be activated by the user. + If the item can be activated by the user. - Widget used for display. + Widget used for display. - Displayed item. + Displayed item. - Position of the item. + Position of the item. - If the item can be selected by the user. + If the item can be selected by the user. - If the item is currently selected. + If the item is currently selected. - + + + - A `GtkListItemFactory` creates widgets for the items taken from a `GListModel`. + A `GtkListItemFactory` creates widgets for the items taken from a `GListModel`. This is one of the core concepts of handling list widgets such as [class@Gtk.ListView] or [class@Gtk.GridView]. @@ -50733,10 +53265,13 @@ Once you have chosen your factory and created it, you need to set it on the view widget you want to use it with, such as via [method@Gtk.ListView.set_factory]. Reusing factories across different views is allowed, but very uncommon. + - + + + - A list-like data structure that can be used with the GtkTreeView + A list-like data structure that can be used with the GtkTreeView The `GtkListStore` object is a list model for use with a `GtkTreeView` widget. It implements the `GtkTreeModel` interface, and consequentialy, @@ -50873,47 +53408,50 @@ An example of a UI Definition fragment for a list store: </data> </object> ]| + - Creates a new list store as with @n_columns columns each of the types passed + Creates a new list store as with @n_columns columns each of the types passed in. Note that only types derived from standard GObject fundamental types are supported. As an example, `gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING, GDK_TYPE_TEXTURE);` will create a new `GtkListStore` with three columns, of type int, string and `GdkTexture`, respectively. + - a new `GtkListStore` + a new `GtkListStore` - number of columns in the list store + number of columns in the list store - all `GType` types for the columns, from first to last + all `GType` types for the columns, from first to last - Non-vararg creation function. Used primarily by language bindings. + Non-vararg creation function. Used primarily by language bindings. + - a new `GtkListStore` + a new `GtkListStore` - number of columns in the list store + number of columns in the list store - an array of `GType` types for the columns, from first to last + an array of `GType` types for the columns, from first to last @@ -50921,107 +53459,112 @@ int, string and `GdkTexture`, respectively. - Appends a new row to @list_store. @iter will be changed to point to this new + Appends a new row to @list_store. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the appended row + An unset `GtkTreeIter` to set to the appended row - Removes all rows from the list store. + Removes all rows from the list store. + - a `GtkListStore`. + a `GtkListStore`. - Creates a new row at @position. @iter will be changed to point to this new + Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1 or is larger than the number of rows on the list, then the new row will be appended to the list. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - Inserts a new row after @sibling. If @sibling is %NULL, then the row will be + Inserts a new row after @sibling. If @sibling is %NULL, then the row will be prepended to the beginning of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Inserts a new row before @sibling. If @sibling is %NULL, then the row will + Inserts a new row before @sibling. If @sibling is %NULL, then the row will be appended to the end of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Creates a new row at @position. @iter will be changed to point to this new + Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1, or larger than the number of rows in the list, then the new row will be appended to the list. The row will be filled with the values given to this function. @@ -51052,183 +53595,191 @@ once, while the latter will emit `GtkTreeModel`::row-inserted, Since emitting the `GtkTreeModel::rows-reordered` signal repeatedly can affect the performance of the program, gtk_list_store_insert_with_values() should generally be preferred when inserting rows in a sorted list store. + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - position to insert the new row, or -1 to append after existing + position to insert the new row, or -1 to append after existing rows - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - A variant of gtk_list_store_insert_with_values() which + A variant of gtk_list_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings. + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Checks if the given iter is a valid iter for this `GtkListStore`. + Checks if the given iter is a valid iter for this `GtkListStore`. This function is slow. Only use it for debugging and/or testing purposes. + - %TRUE if the iter is valid, %FALSE if the iter is invalid. + %TRUE if the iter is valid, %FALSE if the iter is invalid. - a list store + a list store - the iterator to check + the iterator to check - Moves @iter in @store to the position after @position. Note that this + Moves @iter in @store to the position after @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the start of the list. + - A `GtkListStore`. + A `GtkListStore`. - A `GtkTreeIter` + A `GtkTreeIter` - A `GtkTreeIter` + A `GtkTreeIter` - Moves @iter in @store to the position before @position. Note that this + Moves @iter in @store to the position before @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the end of the list. + - A `GtkListStore`. + A `GtkListStore`. - A `GtkTreeIter` + A `GtkTreeIter` - A `GtkTreeIter` + A `GtkTreeIter` - Prepends a new row to @list_store. @iter will be changed to point to this new + Prepends a new row to @list_store. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value(). + - A `GtkListStore` + A `GtkListStore` - An unset `GtkTreeIter` to set to the prepend row + An unset `GtkTreeIter` to set to the prepend row - Removes the given row from the list store. After being removed, + Removes the given row from the list store. After being removed, @iter is set to be the next valid row, or invalidated if it pointed to the last row in @list_store. + - %TRUE if @iter is valid, %FALSE if not. + %TRUE if @iter is valid, %FALSE if not. - A `GtkListStore` + A `GtkListStore` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Reorders @store to follow the order indicated by @new_order. Note that + Reorders @store to follow the order indicated by @new_order. Note that this function only works with unsorted stores. + - A `GtkListStore`. + A `GtkListStore`. - an array of integers mapping the new + an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos`. It must have exactly as many items as the list store’s length. @@ -51239,7 +53790,7 @@ this function only works with unsorted stores. - Sets the value of one or more cells in the row referenced by @iter. + Sets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by the value to be set. The list is terminated by a -1. For example, to set column 0 with type @@ -51248,43 +53799,45 @@ The list is terminated by a -1. For example, to set column 0 with type The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED. + - a `GtkListStore` + a `GtkListStore` - row iterator + row iterator - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - This function is meant primarily for `GObject`s that inherit from `GtkListStore`, + This function is meant primarily for `GObject`s that inherit from `GtkListStore`, and should only be used when constructing a new `GtkListStore`. It will not function after a row has been added, or a method on the `GtkTreeModel` interface is called. + - A `GtkListStore` + A `GtkListStore` - Number of columns for the list store + Number of columns for the list store - An array length n of `GType`s + An array length n of `GType`s @@ -51292,105 +53845,109 @@ interface is called. - See gtk_list_store_set(); this version takes a va_list for use by language + See gtk_list_store_set(); this version takes a va_list for use by language bindings. + - A `GtkListStore` + A `GtkListStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - va_list of column/value pairs + va_list of column/value pairs - Sets the data in the cell specified by @iter and @column. + Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column. + - A `GtkListStore` + A `GtkListStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - column number to modify + column number to modify - new value for the cell + new value for the cell - A variant of gtk_list_store_set_valist() which + A variant of gtk_list_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings and in case the number of columns to change is not known until run-time. + - A `GtkListStore` + A `GtkListStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Swaps @a and @b in @store. Note that this function only works with + Swaps @a and @b in @store. Note that this function only works with unsorted stores. + - A `GtkListStore`. + A `GtkListStore`. - A `GtkTreeIter` + A `GtkTreeIter` - Another `GtkTreeIter` + Another `GtkTreeIter` @@ -51403,6 +53960,7 @@ unsorted stores. + @@ -51412,9 +53970,11 @@ unsorted stores. - + + + - `GtkListView` presents a large dynamic list of items. + `GtkListView` presents a large dynamic list of items. `GtkListView` uses its factory to generate one row widget for each visible item and shows them in a linear display, either vertically or horizontally. @@ -51511,13 +54071,14 @@ the style of [list presentation](ListContainers.html#list-styles): `GtkListView` uses the %GTK_ACCESSIBLE_ROLE_LIST role, and the list items use the %GTK_ACCESSIBLE_ROLE_LIST_ITEM role. + - Creates a new `GtkListView` that uses the given @factory for + Creates a new `GtkListView` that uses the given @factory for mapping items to widgets. The function takes ownership of the @@ -51526,178 +54087,189 @@ arguments, so you can write code like list_view = gtk_list_view_new (create_model (), gtk_builder_list_item_factory_new_from_resource ("/resource.ui")); ``` + - a new `GtkListView` using the given @model and @factory + a new `GtkListView` using the given @model and @factory - the model to use + the model to use - The factory to populate items with + The factory to populate items with - Returns whether rows can be selected by dragging with the mouse. + Returns whether rows can be selected by dragging with the mouse. + - %TRUE if rubberband selection is enabled + %TRUE if rubberband selection is enabled - a `GtkListView` + a `GtkListView` - Gets the factory that's currently used to populate list items. + Gets the factory that's currently used to populate list items. + - The factory in use + The factory in use - a `GtkListView` + a `GtkListView` - Gets the model that's currently used to read the items displayed. + Gets the model that's currently used to read the items displayed. + - The model in use + The model in use - a `GtkListView` + a `GtkListView` - Returns whether the list box should show separators + Returns whether the list box should show separators between rows. + - %TRUE if the list box shows separators + %TRUE if the list box shows separators - a `GtkListView` + a `GtkListView` - Returns whether rows will be activated on single click and + Returns whether rows will be activated on single click and selected on hover. + - %TRUE if rows are activated on single click + %TRUE if rows are activated on single click - a `GtkListView` + a `GtkListView` - Sets whether selections can be changed by dragging with the mouse. + Sets whether selections can be changed by dragging with the mouse. + - a `GtkListView` + a `GtkListView` - %TRUE to enable rubberband selection + %TRUE to enable rubberband selection - Sets the `GtkListItemFactory` to use for populating list items. + Sets the `GtkListItemFactory` to use for populating list items. + - a `GtkListView` + a `GtkListView` - the factory to use + the factory to use - Sets the model to use. + Sets the model to use. This must be a [iface@Gtk.SelectionModel] to use. + - a `GtkListView` + a `GtkListView` - the model to use + the model to use - Sets whether the list box should show separators + Sets whether the list box should show separators between rows. + - a `GtkListView` + a `GtkListView` - %TRUE to show separators + %TRUE to show separators - Sets whether rows should be activated on single click and + Sets whether rows should be activated on single click and selected on hover. + - a `GtkListView` + a `GtkListView` - %TRUE to activate items on single click + %TRUE to activate items on single click @@ -51705,35 +54277,35 @@ selected on hover. - Allow rubberband selection. + Allow rubberband selection. - Factory for populating list items. + Factory for populating list items. - Model for the items displayed. + Model for the items displayed. - Show separators between rows. + Show separators between rows. - Activate rows on single click and select them on hover. + Activate rows on single click and select them on hover. - Emitted when a row has been activated by the user, + Emitted when a row has been activated by the user, usually via activating the GtkListView|list.activate-item action. This allows for a convenient way to handle activation in a listview. @@ -51744,15 +54316,17 @@ this signal. - position of item to activate + position of item to activate - + + + - `GtkLockButton` is a widget to obtain and revoke authorizations + `GtkLockButton` is a widget to obtain and revoke authorizations needed to operate the controls. ![An example GtkLockButton](lock-button.png) @@ -51794,45 +54368,48 @@ with the [property@Gtk.LockButton:text-lock], - Creates a new lock button which reflects the @permission. + Creates a new lock button which reflects the @permission. + - a new `GtkLockButton` + a new `GtkLockButton` - a `GPermission` + a `GPermission` - Obtains the `GPermission` object that controls @button. + Obtains the `GPermission` object that controls @button. + - the `GPermission` of @button + the `GPermission` of @button - a `GtkLockButton` + a `GtkLockButton` - Sets the `GPermission` object that controls @button. + Sets the `GPermission` object that controls @button. + - a `GtkLockButton` + a `GtkLockButton` - a `GPermission` object + a `GPermission` object @@ -51840,86 +54417,96 @@ with the [property@Gtk.LockButton:text-lock], - The `GPermission object controlling this button. + The `GPermission object controlling this button. - The text to display when prompting the user to lock. + The text to display when prompting the user to lock. - The text to display when prompting the user to unlock. + The text to display when prompting the user to unlock. - The tooltip to display when prompting the user to lock. + The tooltip to display when prompting the user to lock. - The tooltip to display when the user cannot obtain authorization. + The tooltip to display when the user cannot obtain authorization. - The tooltip to display when prompting the user to unlock. + The tooltip to display when prompting the user to unlock. - Like gtk_get_major_version(), but from the headers used at + Like gtk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + + + + + - Like gtk_get_micro_version(), but from the headers used at + Like gtk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + - Like gtk_get_minor_version(), but from the headers used at + Like gtk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + + + + - A `GtkMapListModel` maps the items in a list model to different items. + A `GtkMapListModel` maps the items in a list model to different items. `GtkMapListModel` uses a [callback@Gtk.MapListModelMapFunc]. @@ -51947,62 +54534,66 @@ model = gtk_flatten_list_model_new (GTK_TYPE_EVENT_CONTROLLER, `GtkMapListModel` will attempt to discard the mapped objects as soon as they are no longer needed and recreate them if necessary. + - Creates a new `GtkMapListModel` for the given arguments. + Creates a new `GtkMapListModel` for the given arguments. + - a new `GtkMapListModel` + a new `GtkMapListModel` - The model to map + The model to map - map function + map function - user data passed to @map_func + user data passed to @map_func - destroy notifier for @user_data + destroy notifier for @user_data - Gets the model that is currently being mapped or %NULL if none. + Gets the model that is currently being mapped or %NULL if none. + - The model that gets mapped + The model that gets mapped - a `GtkMapListModel` + a `GtkMapListModel` - Checks if a map function is currently set on @self. + Checks if a map function is currently set on @self. + - %TRUE if a map function is set + %TRUE if a map function is set - a `GtkMapListModel` + a `GtkMapListModel` - Sets the function used to map items. + Sets the function used to map items. The function will be called whenever an item needs to be mapped and must return the item to use for the given input item. @@ -52013,136 +54604,144 @@ on the same item, because it may delete items it doesn't need anymore. GTK makes no effort to ensure that @map_func conforms to the item type of @self. It assumes that the caller knows what they are doing and the map function returns items of the appropriate type. + - a `GtkMapListModel` + a `GtkMapListModel` - map function + map function - user data passed to @map_func + user data passed to @map_func - destroy notifier for @user_data + destroy notifier for @user_data - Sets the model to be mapped. + Sets the model to be mapped. GTK makes no effort to ensure that @model conforms to the item type expected by the map function. It assumes that the caller knows what they are doing and have set up an appropriate map function. + - a `GtkMapListModel` + a `GtkMapListModel` - The model to be mapped + The model to be mapped - If a map is set for this model + If a map is set for this model - The model being mapped. + The model being mapped. + - User function that is called to map an @item of the original model to + User function that is called to map an @item of the original model to an item expected by the map model. The returned items must conform to the item type of the model they are used with. + - The item to map to + The item to map to - The item to map + The item to map - user data + user data - `GtkMediaControls` is a widget to show controls for a video. + `GtkMediaControls` is a widget to show controls for a video. ![An example GtkMediaControls](media-controls.png) Usually, `GtkMediaControls` is used as part of [class@Gtk.Video]. + - Creates a new `GtkMediaControls` managing the @stream passed to it. + Creates a new `GtkMediaControls` managing the @stream passed to it. + - a new `GtkMediaControls` + a new `GtkMediaControls` - a `GtkMediaStream` to manage + a `GtkMediaStream` to manage - Gets the media stream managed by @controls or %NULL if none. + Gets the media stream managed by @controls or %NULL if none. + - The media stream managed by @controls + The media stream managed by @controls - a `GtkMediaControls` + a `GtkMediaControls` - Sets the stream that is controlled by @controls. + Sets the stream that is controlled by @controls. + - a `GtkMediaControls` widget + a `GtkMediaControls` widget - a `GtkMediaStream` + a `GtkMediaStream` @@ -52150,17 +54749,18 @@ Usually, `GtkMediaControls` is used as part of [class@Gtk.Video]. - The media-stream managed by this object or %NULL if none. + The media-stream managed by this object or %NULL if none. + - `GtkMediaFile` implements `GtkMediaStream` for files. + `GtkMediaFile` implements `GtkMediaStream` for files. This provides a simple way to play back video files with GTK. @@ -52168,76 +54768,83 @@ GTK provides a GIO extension point for `GtkMediaFile` implementations to allow for external implementations using various media frameworks. GTK itself includes implementations using GStreamer and ffmpeg. + - Creates a new empty media file. + Creates a new empty media file. + - a new `GtkMediaFile` + a new `GtkMediaFile` - Creates a new media file to play @file. + Creates a new media file to play @file. + - a new `GtkMediaFile` playing @file + a new `GtkMediaFile` playing @file - The file to play + The file to play - Creates a new media file for the given filename. + Creates a new media file for the given filename. This is a utility function that converts the given @filename to a `GFile` and calls [ctor@Gtk.MediaFile.new_for_file]. + - a new `GtkMediaFile` playing @filename + a new `GtkMediaFile` playing @filename - filename to open + filename to open - Creates a new media file to play @stream. + Creates a new media file to play @stream. If you want the resulting media to be seekable, the stream should implement the `GSeekable` interface. + - a new `GtkMediaFile` + a new `GtkMediaFile` - The stream to play + The stream to play - Creates a new new media file for the given resource. + Creates a new new media file for the given resource. This is a utility function that converts the given @resource to a `GFile` and calls [ctor@Gtk.MediaFile.new_for_file]. + - a new `GtkMediaFile` playing @resource_path + a new `GtkMediaFile` playing @resource_path - resource path to open + resource path to open + @@ -52248,6 +54855,7 @@ to a `GFile` and calls [ctor@Gtk.MediaFile.new_for_file]. + @@ -52258,126 +54866,133 @@ to a `GFile` and calls [ctor@Gtk.MediaFile.new_for_file]. - Resets the media file to be empty. + Resets the media file to be empty. + - a `GtkMediaFile` + a `GtkMediaFile` - Returns the file that @self is currently playing from. + Returns the file that @self is currently playing from. When @self is not playing or not playing from a file, %NULL is returned. + - The currently playing file + The currently playing file - a `GtkMediaFile` + a `GtkMediaFile` - Returns the stream that @self is currently playing from. + Returns the stream that @self is currently playing from. When @self is not playing or not playing from a stream, %NULL is returned. + - The currently playing stream + The currently playing stream - a `GtkMediaFile` + a `GtkMediaFile` - Sets the `GtkMediaFile` to play the given file. + Sets the `GtkMediaFile` to play the given file. If any file is still playing, stop playing it. + - a `GtkMediaFile` + a `GtkMediaFile` - the file to play + the file to play - Sets the `GtkMediaFile to play the given file. + Sets the `GtkMediaFile to play the given file. This is a utility function that converts the given @filename to a `GFile` and calls [method@Gtk.MediaFile.set_file]. + - a `GtkMediaFile` + a `GtkMediaFile` - name of file to play + name of file to play - Sets the `GtkMediaFile` to play the given stream. + Sets the `GtkMediaFile` to play the given stream. If anything is still playing, stop playing it. Full control about the @stream is assumed for the duration of playback. The stream will not be closed. + - a `GtkMediaFile` + a `GtkMediaFile` - the stream to play from + the stream to play from - Sets the `GtkMediaFile to play the given resource. + Sets the `GtkMediaFile to play the given resource. This is a utility function that converts the given @resource_path to a `GFile` and calls [method@Gtk.MediaFile.set_file]. + - a `GtkMediaFile` + a `GtkMediaFile` - path to resource to play + path to resource to play @@ -52385,13 +55000,13 @@ to a `GFile` and calls [method@Gtk.MediaFile.set_file]. - The file being played back or %NULL if not playing a file. + The file being played back or %NULL if not playing a file. - The stream being played back or %NULL if not playing a stream. + The stream being played back or %NULL if not playing a stream. This is %NULL when playing a file. @@ -52401,11 +55016,13 @@ This is %NULL when playing a file. + + @@ -52418,6 +55035,7 @@ This is %NULL when playing a file. + @@ -52430,6 +55048,7 @@ This is %NULL when playing a file. + @@ -52437,6 +55056,7 @@ This is %NULL when playing a file. + @@ -52444,6 +55064,7 @@ This is %NULL when playing a file. + @@ -52451,6 +55072,7 @@ This is %NULL when playing a file. + @@ -52458,7 +55080,7 @@ This is %NULL when playing a file. - `GtkMediaStream` is the integration point for media playback inside GTK. + `GtkMediaStream` is the integration point for media playback inside GTK. GTK provides an implementation of the `GtkMediaStream` interface that is called [class@Gtk.MediaFile]. @@ -52475,22 +55097,25 @@ not be used in applications: [method@Gtk.MediaStream.gerror], [method@Gtk.MediaStream.error], [method@Gtk.MediaStream.error_valist]. + - Pauses playback of the stream. + Pauses playback of the stream. If the stream is not playing, do nothing. + - a `GtkMediaStream` + a `GtkMediaStream` + @@ -52501,7 +55126,7 @@ If the stream is not playing, do nothing. - Called by users to attach the media stream to a `GdkSurface` they manage. + Called by users to attach the media stream to a `GdkSurface` they manage. The stream can then access the resources of @surface for its rendering purposes. In particular, media streams might want to @@ -52517,22 +55142,23 @@ calls must be followed by its own call to [method@Gtk.MediaStream.unrealize]. It is not required to call this function to make a media stream work. + - a `GtkMediaStream` + a `GtkMediaStream` - a `GdkSurface` + a `GdkSurface` - Start a seek operation on @self to @timestamp. + Start a seek operation on @self to @timestamp. If @timestamp is out of range, it will be clamped. @@ -52543,40 +55169,43 @@ property will be set. When calling gtk_media_stream_seek() during an ongoing seek operation, the new seek will override any pending seek. + - a `GtkMediaStream` + a `GtkMediaStream` - timestamp to seek to. + timestamp to seek to. - Undoes a previous call to gtk_media_stream_realize(). + Undoes a previous call to gtk_media_stream_realize(). This causes the stream to release all resources it had allocated from @surface. + - a `GtkMediaStream` previously realized + a `GtkMediaStream` previously realized - the `GdkSurface` the stream was realized with + the `GdkSurface` the stream was realized with + @@ -52593,87 +55222,90 @@ allocated from @surface. - Pauses the media stream and marks it as ended. + Pauses the media stream and marks it as ended. This is a hint only, calls to [method@Gtk.MediaStream.play] may still happen. The media stream must be prepared when this function is called. Use [method@Gtk.MediaStream.stream_ended] instead + - a `GtkMediaStream` + a `GtkMediaStream` - Sets @self into an error state using a printf()-style format string. + Sets @self into an error state using a printf()-style format string. This is a utility function that calls [method@Gtk.MediaStream.gerror]. See that function for details. + - a `GtkMediaStream` + a `GtkMediaStream` - error domain + error domain - error code + error code - printf()-style format for error message + printf()-style format for error message - parameters for message format + parameters for message format - Sets @self into an error state using a printf()-style format string. + Sets @self into an error state using a printf()-style format string. This is a utility function that calls [method@Gtk.MediaStream.gerror]. See that function for details. + - a `GtkMediaStream` + a `GtkMediaStream` - error domain + error domain - error code + error code - printf()-style format for error message + printf()-style format for error message - `va_list` of parameters for the message format + `va_list` of parameters for the message format - Sets @self into an error state. + Sets @self into an error state. This will pause the stream (you can check for an error via [method@Gtk.MediaStream.get_error] in your @@ -52685,53 +55317,56 @@ will be ignored and the existing error will be retained. To unset an error, the stream must be reset via a call to [method@Gtk.MediaStream.unprepared]. + - a `GtkMediaStream` + a `GtkMediaStream` - the `GError` to set + the `GError` to set - Gets the duration of the stream. + Gets the duration of the stream. If the duration is not known, 0 will be returned. + - the duration of the stream or 0 if not known. + the duration of the stream or 0 if not known. - a `GtkMediaStream` + a `GtkMediaStream` - Returns whether the streams playback is finished. + Returns whether the streams playback is finished. + - %TRUE if playback is finished + %TRUE if playback is finished - a `GtkMediaStream` + a `GtkMediaStream` - If the stream is in an error state, returns the `GError` + If the stream is in an error state, returns the `GError` explaining that state. Any type of error can be reported here depending on the @@ -52745,141 +55380,150 @@ like [method@Gtk.MediaStream.play] or an error, but implementations may provide options. For example, a [class@Gtk.MediaFile] will unset errors when a new source is set, e.g. with [method@Gtk.MediaFile.set_file]. + - %NULL if not in an + %NULL if not in an error state or the `GError` of the stream - a `GtkMediaStream` + a `GtkMediaStream` - Returns whether the stream is set to loop. + Returns whether the stream is set to loop. See [method@Gtk.MediaStream.set_loop] for details. + - %TRUE if the stream should loop + %TRUE if the stream should loop - a `GtkMediaStream` + a `GtkMediaStream` - Returns whether the audio for the stream is muted. + Returns whether the audio for the stream is muted. See [method@Gtk.MediaStream.set_muted] for details. + - %TRUE if the stream is muted + %TRUE if the stream is muted - a `GtkMediaStream` + a `GtkMediaStream` - Return whether the stream is currently playing. + Return whether the stream is currently playing. + - %TRUE if the stream is playing + %TRUE if the stream is playing - a `GtkMediaStream` + a `GtkMediaStream` - Returns the current presentation timestamp in microseconds. + Returns the current presentation timestamp in microseconds. + - the timestamp in microseconds + the timestamp in microseconds - a `GtkMediaStream` + a `GtkMediaStream` - Returns the volume of the audio for the stream. + Returns the volume of the audio for the stream. See [method@Gtk.MediaStream.set_volume] for details. + - volume of the stream from 0.0 to 1.0 + volume of the stream from 0.0 to 1.0 - a `GtkMediaStream` + a `GtkMediaStream` - Returns whether the stream has audio. + Returns whether the stream has audio. + - %TRUE if the stream has audio + %TRUE if the stream has audio - a `GtkMediaStream` + a `GtkMediaStream` - Returns whether the stream has video. + Returns whether the stream has video. + - %TRUE if the stream has video + %TRUE if the stream has video - a `GtkMediaStream` + a `GtkMediaStream` - Returns whether the stream has finished initializing. + Returns whether the stream has finished initializing. At this point the existence of audio and video is known. + - %TRUE if the stream is prepared + %TRUE if the stream is prepared - a `GtkMediaStream` + a `GtkMediaStream` - Checks if a stream may be seekable. + Checks if a stream may be seekable. This is meant to be a hint. Streams may not allow seeking even if this function returns %TRUE. However, if this function returns @@ -52888,90 +55532,95 @@ may hide controls that allow seeking. It is allowed to call [method@Gtk.MediaStream.seek] on a non-seekable stream, though it will not do anything. + - %TRUE if the stream may support seeking + %TRUE if the stream may support seeking - a `GtkMediaStream` + a `GtkMediaStream` - Checks if there is currently a seek operation going on. + Checks if there is currently a seek operation going on. + - %TRUE if a seek operation is ongoing. + %TRUE if a seek operation is ongoing. - a `GtkMediaStream` + a `GtkMediaStream` - Pauses playback of the stream. + Pauses playback of the stream. If the stream is not playing, do nothing. + - a `GtkMediaStream` + a `GtkMediaStream` - Starts playing the stream. + Starts playing the stream. If the stream is in error or already playing, do nothing. + - a `GtkMediaStream` + a `GtkMediaStream` - Same as gtk_media_stream_stream_prepared(). + Same as gtk_media_stream_stream_prepared(). Use [method@Gtk.MediaStream.stream_prepared] instead. + - a `GtkMediaStream` + a `GtkMediaStream` - %TRUE if the stream should advertise audio support + %TRUE if the stream should advertise audio support - %TRUE if the stream should advertise video support + %TRUE if the stream should advertise video support - %TRUE if the stream should advertise seekability + %TRUE if the stream should advertise seekability - The duration of the stream or 0 if unknown + The duration of the stream or 0 if unknown - Called by users to attach the media stream to a `GdkSurface` they manage. + Called by users to attach the media stream to a `GdkSurface` they manage. The stream can then access the resources of @surface for its rendering purposes. In particular, media streams might want to @@ -52987,22 +55636,23 @@ calls must be followed by its own call to [method@Gtk.MediaStream.unrealize]. It is not required to call this function to make a media stream work. + - a `GtkMediaStream` + a `GtkMediaStream` - a `GdkSurface` + a `GdkSurface` - Start a seek operation on @self to @timestamp. + Start a seek operation on @self to @timestamp. If @timestamp is out of range, it will be clamped. @@ -53013,59 +55663,62 @@ property will be set. When calling gtk_media_stream_seek() during an ongoing seek operation, the new seek will override any pending seek. + - a `GtkMediaStream` + a `GtkMediaStream` - timestamp to seek to. + timestamp to seek to. - Ends a seek operation started via GtkMediaStream.seek() as a failure. + Ends a seek operation started via GtkMediaStream.seek() as a failure. This will not cause an error on the stream and will assume that playback continues as if no seek had happened. See [method@Gtk.MediaStream.seek_success] for the other way of ending a seek. + - a `GtkMediaStream` + a `GtkMediaStream` - Ends a seek operation started via GtkMediaStream.seek() successfully. + Ends a seek operation started via GtkMediaStream.seek() successfully. This function will unset the GtkMediaStream:ended property if it was set. See [method@Gtk.MediaStream.seek_failed] for the other way of ending a seek. + - a `GtkMediaStream` + a `GtkMediaStream` - Sets whether the stream should loop. + Sets whether the stream should loop. In this case, it will attempt to restart playback from the beginning instead of stopping at the end. @@ -53073,23 +55726,24 @@ from the beginning instead of stopping at the end. Not all streams may support looping, in particular non-seekable streams. Those streams will ignore the loop setting and just end. + - a `GtkMediaStream` + a `GtkMediaStream` - %TRUE if the stream should loop + %TRUE if the stream should loop - Sets whether the audio stream should be muted. + Sets whether the audio stream should be muted. Muting a stream will cause no audio to be played, but it does not modify the volume. This means that muting and @@ -53097,40 +55751,42 @@ then unmuting the stream will restore the volume settings. If the stream has no audio, calling this function will still work but it will not have an audible effect. + - a `GtkMediaStream` + a `GtkMediaStream` - %TRUE if the stream should be muted + %TRUE if the stream should be muted - Starts or pauses playback of the stream. + Starts or pauses playback of the stream. + - a `GtkMediaStream` + a `GtkMediaStream` - whether to start or pause playback + whether to start or pause playback - Sets the volume of the audio stream. + Sets the volume of the audio stream. This function call will work even if the stream is muted. @@ -53141,39 +55797,41 @@ be clamped to the nearest value. If the stream has no audio or is muted, calling this function will still work but it will not have an immediate audible effect. When the stream is unmuted, the new volume setting will take effect. + - a `GtkMediaStream` + a `GtkMediaStream` - New volume of the stream from 0.0 to 1.0 + New volume of the stream from 0.0 to 1.0 - Pauses the media stream and marks it as ended. + Pauses the media stream and marks it as ended. This is a hint only, calls to [method@Gtk.MediaStream.play] may still happen. The media stream must be prepared when this function is called. + - a `GtkMediaStream` + a `GtkMediaStream` - Called by `GtkMediaStream` implementations to advertise the stream + Called by `GtkMediaStream` implementations to advertise the stream being ready to play and providing details about the stream. Note that the arguments are hints. If the stream implementation @@ -53183,171 +55841,176 @@ values to determine what controls to show. This function may not be called again until the stream has been reset via [method@Gtk.MediaStream.stream_unprepared]. + - a `GtkMediaStream` + a `GtkMediaStream` - %TRUE if the stream should advertise audio support + %TRUE if the stream should advertise audio support - %TRUE if the stream should advertise video support + %TRUE if the stream should advertise video support - %TRUE if the stream should advertise seekability + %TRUE if the stream should advertise seekability - The duration of the stream or 0 if unknown + The duration of the stream or 0 if unknown - Resets a given media stream implementation. + Resets a given media stream implementation. [method@Gtk.MediaStream.stream_prepared] can then be called again. This function will also reset any error state the stream was in. + - a `GtkMediaStream` + a `GtkMediaStream` - Same as gtk_media_stream_stream_unprepared(). + Same as gtk_media_stream_stream_unprepared(). Use [method@Gtk.MediaStream.stream_unprepared] instead. + - a `GtkMediaStream` + a `GtkMediaStream` - Undoes a previous call to gtk_media_stream_realize(). + Undoes a previous call to gtk_media_stream_realize(). This causes the stream to release all resources it had allocated from @surface. + - a `GtkMediaStream` previously realized + a `GtkMediaStream` previously realized - the `GdkSurface` the stream was realized with + the `GdkSurface` the stream was realized with - Media stream implementations should regularly call this + Media stream implementations should regularly call this function to update the timestamp reported by the stream. It is up to implementations to call this at the frequency they deem appropriate. The media stream must be prepared when this function is called. + - a `GtkMediaStream` + a `GtkMediaStream` - the new timestamp + the new timestamp - The stream's duration in microseconds or 0 if unknown. + The stream's duration in microseconds or 0 if unknown. - Set when playback has finished. + Set when playback has finished. - %NULL for a properly working stream or the `GError` + %NULL for a properly working stream or the `GError` that the stream is in. - Whether the stream contains audio. + Whether the stream contains audio. - Whether the stream contains video. + Whether the stream contains video. - Try to restart the media from the beginning once it ended. + Try to restart the media from the beginning once it ended. - Whether the audio stream should be muted. + Whether the audio stream should be muted. - Whether the stream is currently playing. + Whether the stream is currently playing. - Whether the stream has finished initializing and existence of + Whether the stream has finished initializing and existence of audio and video is known. - Set unless the stream is known to not support seeking. + Set unless the stream is known to not support seeking. - Set while a seek is in progress. + Set while a seek is in progress. - The current presentation timestamp in microseconds. + The current presentation timestamp in microseconds. - Volume of the audio stream. + Volume of the audio stream. @@ -53355,11 +56018,13 @@ audio and video is known. + + @@ -53372,12 +56037,13 @@ audio and video is known. + - a `GtkMediaStream` + a `GtkMediaStream` @@ -53385,16 +56051,17 @@ audio and video is known. + - a `GtkMediaStream` + a `GtkMediaStream` - timestamp to seek to. + timestamp to seek to. @@ -53402,6 +56069,7 @@ audio and video is known. + @@ -53420,16 +56088,17 @@ audio and video is known. + - a `GtkMediaStream` + a `GtkMediaStream` - a `GdkSurface` + a `GdkSurface` @@ -53437,16 +56106,17 @@ audio and video is known. + - a `GtkMediaStream` previously realized + a `GtkMediaStream` previously realized - the `GdkSurface` the stream was realized with + the `GdkSurface` the stream was realized with @@ -53454,6 +56124,7 @@ audio and video is known. + @@ -53461,6 +56132,7 @@ audio and video is known. + @@ -53468,6 +56140,7 @@ audio and video is known. + @@ -53475,6 +56148,7 @@ audio and video is known. + @@ -53482,6 +56156,7 @@ audio and video is known. + @@ -53489,6 +56164,7 @@ audio and video is known. + @@ -53496,6 +56172,7 @@ audio and video is known. + @@ -53503,6 +56180,7 @@ audio and video is known. + @@ -53510,7 +56188,7 @@ audio and video is known. - The `GtkMenuButton` widget is used to display a popup when clicked. + The `GtkMenuButton` widget is used to display a popup when clicked. ![An example GtkMenuButton](menu-button.png) @@ -53575,190 +56253,203 @@ to request a round appearance. - Creates a new `GtkMenuButton` widget with downwards-pointing + Creates a new `GtkMenuButton` widget with downwards-pointing arrow as the only child. You can replace the child widget with another `GtkWidget` should you wish to. + - The newly created `GtkMenuButton` + The newly created `GtkMenuButton` - Gets whether to show a dropdown arrow even when using an icon. + Gets whether to show a dropdown arrow even when using an icon. + - whether to show a dropdown arrow even when using an icon + whether to show a dropdown arrow even when using an icon - a `GtkMenuButton` + a `GtkMenuButton` - Returns the direction the popup will be pointing at when popped up. + Returns the direction the popup will be pointing at when popped up. + - a `GtkArrowType` value + a `GtkArrowType` value - a `GtkMenuButton` + a `GtkMenuButton` - Returns whether the button has a frame. + Returns whether the button has a frame. + - %TRUE if the button has a frame + %TRUE if the button has a frame - a `GtkMenuButton` + a `GtkMenuButton` - Gets the name of the icon shown in the button. + Gets the name of the icon shown in the button. + - the name of the icon shown in the button + the name of the icon shown in the button - a `GtkMenuButton` + a `GtkMenuButton` - Gets the label shown in the button + Gets the label shown in the button + - the label shown in the button + the label shown in the button - a `GtkMenuButton` + a `GtkMenuButton` - Returns the `GMenuModel` used to generate the popup. + Returns the `GMenuModel` used to generate the popup. + - a `GMenuModel` + a `GMenuModel` - a `GtkMenuButton` + a `GtkMenuButton` - Returns the `GtkPopover` that pops out of the button. + Returns the `GtkPopover` that pops out of the button. If the button is not using a `GtkPopover`, this function returns %NULL. + - a `GtkPopover` or %NULL + a `GtkPopover` or %NULL - a `GtkMenuButton` + a `GtkMenuButton` - Returns whether the menu button acts as a primary menu. + Returns whether the menu button acts as a primary menu. + - %TRUE if the button is a primary menu + %TRUE if the button is a primary menu - a `GtkMenuButton` + a `GtkMenuButton` - Returns whether an embedded underline in the text indicates a + Returns whether an embedded underline in the text indicates a mnemonic. + - %TRUE whether an embedded underline in the text indicates + %TRUE whether an embedded underline in the text indicates the mnemonic accelerator keys. - a `GtkMenuButton` + a `GtkMenuButton` - Dismiss the menu. + Dismiss the menu. + - a `GtkMenuButton` + a `GtkMenuButton` - Pop up the menu. + Pop up the menu. + - a `GtkMenuButton` + a `GtkMenuButton` - Sets whether to show a dropdown arrow even when using an icon. + Sets whether to show a dropdown arrow even when using an icon. + - a `GtkMenuButton` + a `GtkMenuButton` - hether to show a dropdown arrow even when using an icon + hether to show a dropdown arrow even when using an icon - Sets @func to be called when a popup is about to be shown. + Sets @func to be called when a popup is about to be shown. @func should use one of @@ -53770,33 +56461,34 @@ If @func is non-%NULL, @menu_button will always be sensitive. Using this function will not reset the menu widget attached to @menu_button. Instead, this can be done manually in @func. + - a `GtkMenuButton` + a `GtkMenuButton` - function to call when a popup is about to + function to call when a popup is about to be shown, but none has been provided via other means, or %NULL to reset to default behavior. - user data to pass to @func. + user data to pass to @func. - destroy notify for @user_data + destroy notify for @user_data - Sets the direction in which the popup will be popped up. + Sets the direction in which the popup will be popped up. If the button is automatically populated with an arrow icon, its direction will be changed to match. @@ -53806,74 +56498,78 @@ GTK will its best to keep it inside the screen and fully visible. If you pass %GTK_ARROW_NONE for a @direction, the popup will behave as if you passed %GTK_ARROW_DOWN (although you won’t see any arrows). + - a `GtkMenuButton` + a `GtkMenuButton` - a `GtkArrowType` + a `GtkArrowType` - Sets the style of the button. + Sets the style of the button. + - a `GtkMenuButton` + a `GtkMenuButton` - whether the button should have a visible frame + whether the button should have a visible frame - Sets the name of an icon to show inside the menu button. + Sets the name of an icon to show inside the menu button. + - a `GtkMenuButton` + a `GtkMenuButton` - the icon name + the icon name - Sets the label to show inside the menu button. + Sets the label to show inside the menu button. + - a `GtkMenuButton` + a `GtkMenuButton` - the label + the label - Sets the `GMenuModel` from which the popup will be constructed. + Sets the `GMenuModel` from which the popup will be constructed. If @menu_model is %NULL, the button is disabled. @@ -53883,16 +56579,17 @@ as documented for this function. If [property@Gtk.MenuButton:popover] is already set, it will be dissociated from the @menu_button, and the property is set to %NULL. + - a `GtkMenuButton` + a `GtkMenuButton` - a `GMenuModel`, or %NULL to unset and disable the + a `GMenuModel`, or %NULL to unset and disable the button @@ -53900,58 +56597,61 @@ dissociated from the @menu_button, and the property is set to %NULL. - Sets the `GtkPopover` that will be popped up when the @menu_button is clicked. + Sets the `GtkPopover` that will be popped up when the @menu_button is clicked. If @popover is %NULL, the button is disabled. If [property@Gtk.MenuButton:menu-model] is set, the menu model is dissociated from the @menu_button, and the property is set to %NULL. + - a `GtkMenuButton` + a `GtkMenuButton` - a `GtkPopover`, or %NULL to unset and disable the button + a `GtkPopover`, or %NULL to unset and disable the button - Sets whether menu button acts as a primary menu. + Sets whether menu button acts as a primary menu. Primary menus can be opened with the <kbd>F10</kbd> key. + - a `GtkMenuButton` + a `GtkMenuButton` - whether the menubutton should act as a primary menu + whether the menubutton should act as a primary menu - If true, an underline in the text indicates a mnemonic. + If true, an underline in the text indicates a mnemonic. + - a `GtkMenuButton` + a `GtkMenuButton` - %TRUE if underlines in the text indicate mnemonics + %TRUE if underlines in the text indicate mnemonics @@ -53959,38 +56659,38 @@ Primary menus can be opened with the <kbd>F10</kbd> key. - Whether to show a dropdown arrow even when using an icon. + Whether to show a dropdown arrow even when using an icon. - The `GtkArrowType` representing the direction in which the + The `GtkArrowType` representing the direction in which the menu or popover will be popped out. - Whether the button has a frame. + Whether the button has a frame. - The name of the icon used to automatically populate the button. + The name of the icon used to automatically populate the button. - The label for the button. + The label for the button. - The `GMenuModel` from which the popup will be created. + The `GMenuModel` from which the popup will be created. See [method@Gtk.MenuButton.set_menu_model] for the interaction with the [property@Gtk.MenuButton:popover] property. @@ -53999,13 +56699,13 @@ with the [property@Gtk.MenuButton:popover] property. - The `GtkPopover` that will be popped up when the button is clicked. + The `GtkPopover` that will be popped up when the button is clicked. - Whether the menu button acts as a primary menu. + Whether the menu button acts as a primary menu. Primary menus can be opened using the <kbd>F10</kbd> key @@ -54013,11 +56713,11 @@ Primary menus can be opened using the <kbd>F10</kbd> key - If set an underscore in the text indicates a mnemonic. + If set an underscore in the text indicates a mnemonic. - Emitted to when the menu button is activated. + Emitted to when the menu button is activated. The `::activate` signal on `GtkMenuButton` is an action signal and emitting it causes the button to pop up its menu. @@ -54027,28 +56727,29 @@ emitting it causes the button to pop up its menu. - User-provided callback function to create a popup for a + User-provided callback function to create a popup for a `GtkMenuButton` on demand. This function is called when the popup of @menu_button is shown, but none has been provided via [method@Gtk.MenuButton.set_popover] or [method@Gtk.MenuButton.set_menu_model]. + - the `GtkMenuButton` + the `GtkMenuButton` - User data passed to gtk_menu_button_set_create_popup_func() + User data passed to gtk_menu_button_set_create_popup_func() - `GtkMessageDialog` presents a dialog with some message text. + `GtkMessageDialog` presents a dialog with some message text. ![An example GtkMessageDialog](messagedialog.png) @@ -54104,6 +56805,7 @@ g_signal_connect (dialog, "response", The `GtkMessageDialog` implementation of the `GtkBuildable` interface exposes the message area as an internal child with the name “message_area”. + @@ -54111,45 +56813,46 @@ the message area as an internal child with the name “message_area” - Creates a new message dialog. + Creates a new message dialog. This is a simple dialog with some text the user may want to see. When the user clicks a button a “response” signal is emitted with response IDs from [enum@Gtk.ResponseType]. See [class@Gtk.Dialog] for more details. + - a new `GtkMessageDialog` + a new `GtkMessageDialog` - transient parent + transient parent - flags + flags - type of message + type of message - set of buttons to use + set of buttons to use - printf()-style format string + printf()-style format string - arguments for @message_format + arguments for @message_format - Creates a new message dialog. + Creates a new message dialog. This is a simple dialog with some text that is marked up with Pango markup. When the user clicks a button a “response” signal @@ -54177,39 +56880,40 @@ dialog = gtk_message_dialog_new (parent_window, gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog), markup); ``` + - a new `GtkMessageDialog` + a new `GtkMessageDialog` - transient parent + transient parent - flags + flags - type of message + type of message - set of buttons to use + set of buttons to use - printf()-style format string + printf()-style format string - arguments for @message_format + arguments for @message_format - Sets the secondary text of the message dialog. + Sets the secondary text of the message dialog. The @message_format is assumed to contain Pango markup. @@ -54226,75 +56930,79 @@ gtk_message_dialog_format_secondary_markup (message_dialog, "%s", msg); g_free (msg); ``` + - a `GtkMessageDialog` + a `GtkMessageDialog` - printf()-style string with Pango markup + printf()-style string with Pango markup - arguments for @message_format + arguments for @message_format - Sets the secondary text of the message dialog. + Sets the secondary text of the message dialog. + - a `GtkMessageDialog` + a `GtkMessageDialog` - printf()-style format string + printf()-style format string - arguments for @message_format + arguments for @message_format - Returns the message area of the dialog. + Returns the message area of the dialog. This is the box where the dialog’s primary and secondary labels are packed. You can add your own extra content to that box and it will appear below those labels. See [method@Gtk.Dialog.get_content_area] for the corresponding function in the parent [class@Gtk.Dialog]. + - A `GtkBox` corresponding to the + A `GtkBox` corresponding to the “message area” in the @message_dialog - a `GtkMessageDialog` + a `GtkMessageDialog` - Sets the text of the message dialog. + Sets the text of the message dialog. + - a `GtkMessageDialog` + a `GtkMessageDialog` - string with Pango markup + string with Pango markup @@ -54303,34 +57011,34 @@ for the corresponding function in the parent [class@Gtk.Dialog]. - The `GtkBox` that corresponds to the message area of this dialog. + The `GtkBox` that corresponds to the message area of this dialog. See [method@Gtk.MessageDialog.get_message_area] for a detailed description of this area. - The type of the message. + The type of the message. - The secondary text of the message dialog. + The secondary text of the message dialog. - %TRUE if the secondary text of the dialog includes Pango markup. + %TRUE if the secondary text of the dialog includes Pango markup. See [func@Pango.parse_markup]. - The primary text of the message dialog. + The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title. - %TRUE if the primary text of the dialog includes Pango markup. + %TRUE if the primary text of the dialog includes Pango markup. See [func@Pango.parse_markup]. @@ -54339,84 +57047,95 @@ See [func@Pango.parse_markup]. - + + + - The type of message being displayed in a `GtkMessageDialog`. + The type of message being displayed in a `GtkMessageDialog`. - Informational message + Informational message - Non-fatal warning message + Non-fatal warning message - Question requiring a choice + Question requiring a choice - Fatal error message + Fatal error message - None of the above + None of the above - A `GtkShortcutAction` that calls gtk_widget_mnemonic_activate(). + A `GtkShortcutAction` that calls gtk_widget_mnemonic_activate(). + - Gets the mnemonic action. + Gets the mnemonic action. This is an action that calls gtk_widget_mnemonic_activate() on the given widget upon activation. + - The mnemonic action + The mnemonic action - + + + - A `GtkShortcutTrigger` that triggers when a specific mnemonic is pressed. + A `GtkShortcutTrigger` that triggers when a specific mnemonic is pressed. Mnemonics require a *mnemonic modifier* (typically <kbd>Alt</kbd>) to be pressed together with the mnemonic key. + - Creates a `GtkShortcutTrigger` that will trigger whenever the key with + Creates a `GtkShortcutTrigger` that will trigger whenever the key with the given @keyval is pressed and mnemonics have been activated. Mnemonics are activated by calling code when a key event with the right modifiers is detected. + - A new `GtkShortcutTrigger` + A new `GtkShortcutTrigger` - The keyval to trigger for + The keyval to trigger for - Gets the keyval that must be pressed to succeed triggering @self. + Gets the keyval that must be pressed to succeed triggering @self. + - the keyval + the keyval - a mnemonic `GtkShortcutTrigger` + a mnemonic `GtkShortcutTrigger` - The key value for the trigger. + The key value for the trigger. - + + + - `GtkMountOperation` is an implementation of `GMountOperation`. + `GtkMountOperation` is an implementation of `GMountOperation`. The functions and objects described here make working with GTK and GIO more convenient. @@ -54429,94 +57148,101 @@ g_volume_mount(), g_mount_unmount_with_operation() and others. When necessary, `GtkMountOperation` shows dialogs to let the user enter passwords, ask questions or show processes blocking unmount. + - Creates a new `GtkMountOperation`. + Creates a new `GtkMountOperation`. + - a new `GtkMountOperation` + a new `GtkMountOperation` - transient parent of the window + transient parent of the window - Gets the display on which windows of the `GtkMountOperation` + Gets the display on which windows of the `GtkMountOperation` will be shown. + - the display on which windows of @op are shown + the display on which windows of @op are shown - a `GtkMountOperation` + a `GtkMountOperation` - Gets the transient parent used by the `GtkMountOperation`. + Gets the transient parent used by the `GtkMountOperation`. + - the transient parent for windows shown by @op + the transient parent for windows shown by @op - a `GtkMountOperation` + a `GtkMountOperation` - Returns whether the `GtkMountOperation` is currently displaying + Returns whether the `GtkMountOperation` is currently displaying a window. + - %TRUE if @op is currently displaying a window + %TRUE if @op is currently displaying a window - a `GtkMountOperation` + a `GtkMountOperation` - Sets the display to show windows of the `GtkMountOperation` on. + Sets the display to show windows of the `GtkMountOperation` on. + - a `GtkMountOperation` + a `GtkMountOperation` - a `GdkDisplay` + a `GdkDisplay` - Sets the transient parent for windows shown by the + Sets the transient parent for windows shown by the `GtkMountOperation`. + - a `GtkMountOperation` + a `GtkMountOperation` - transient parent of the window + transient parent of the window @@ -54524,18 +57250,18 @@ a window. - The display where dialogs will be shown. + The display where dialogs will be shown. - Whether a dialog is currently shown. + Whether a dialog is currently shown. - The parent window. + The parent window. @@ -54546,12 +57272,14 @@ a window. + - The parent class. + The parent class. + @@ -54559,6 +57287,7 @@ a window. + @@ -54566,6 +57295,7 @@ a window. + @@ -54573,136 +57303,148 @@ a window. + - + + + - Passed as argument to various keybinding signals for moving the + Passed as argument to various keybinding signals for moving the cursor position. - Move forward or back by graphemes + Move forward or back by graphemes - Move left or right by graphemes + Move left or right by graphemes - Move forward or back by words + Move forward or back by words - Move up or down lines (wrapped lines) + Move up or down lines (wrapped lines) - Move to either end of a line + Move to either end of a line - Move up or down paragraphs (newline-ended lines) + Move up or down paragraphs (newline-ended lines) - Move to either end of a paragraph + Move to either end of a paragraph - Move by pages + Move by pages - Move to ends of the buffer + Move to ends of the buffer - Move horizontally by pages + Move horizontally by pages - `GtkMultiFilter` is the base class for filters that combine multiple filters. + `GtkMultiFilter` is the base class for filters that combine multiple filters. + - Adds a @filter to @self to use for matching. + Adds a @filter to @self to use for matching. + - a `GtkMultiFilter` + a `GtkMultiFilter` - A new filter to use + A new filter to use - Removes the filter at the given @position from the list of filters used + Removes the filter at the given @position from the list of filters used by @self. If @position is larger than the number of filters, nothing happens and the function returns. + - a `GtkMultiFilter` + a `GtkMultiFilter` - position of filter to remove + position of filter to remove - + + + - `GtkMultiSelection` is a `GtkSelectionModel` that allows selecting multiple + `GtkMultiSelection` is a `GtkSelectionModel` that allows selecting multiple elements. + - Creates a new selection to handle @model. + Creates a new selection to handle @model. + - a new `GtkMultiSelection` + a new `GtkMultiSelection` - the `GListModel` to manage + the `GListModel` to manage - Returns the underlying model of @self. + Returns the underlying model of @self. + - the underlying model + the underlying model - a `GtkMultiSelection` + a `GtkMultiSelection` - Sets the model that @self should wrap. + Sets the model that @self should wrap. If @model is %NULL, @self will be empty. + - a `GtkMultiSelection` + a `GtkMultiSelection` - A `GListModel` to wrap + A `GListModel` to wrap @@ -54710,80 +57452,87 @@ If @model is %NULL, @self will be empty. - The list managed by this selection. + The list managed by this selection. + - `GtkMultiSorter` combines multiple sorters by trying them + `GtkMultiSorter` combines multiple sorters by trying them in turn. If the first sorter compares two items as equal, the second is tried next, and so on. + - Creates a new multi sorter. + Creates a new multi sorter. This sorter compares items by trying each of the sorters in turn, until one returns non-zero. In particular, if no sorter has been added to it, it will always compare items as equal. + - a new `GtkMultiSorter` + a new `GtkMultiSorter` - Add @sorter to @self to use for sorting at the end. + Add @sorter to @self to use for sorting at the end. @self will consult all existing sorters before it will sort with the given @sorter. + - a `GtkMultiSorter` + a `GtkMultiSorter` - a sorter to add + a sorter to add - Removes the sorter at the given @position from the list of sorter + Removes the sorter at the given @position from the list of sorter used by @self. If @position is larger than the number of sorters, nothing happens. + - a `GtkMultiSorter` + a `GtkMultiSorter` - position of sorter to remove + position of sorter to remove + + @@ -54792,61 +57541,68 @@ If @position is larger than the number of sorters, nothing happens. + + - A `GtkShortcutAction` that activates an action by name. + A `GtkShortcutAction` that activates an action by name. + - Creates an action that when activated, activates + Creates an action that when activated, activates the named action on the widget. It also passes the given arguments to it. See [method@Gtk.Widget.insert_action_group] for how to add actions to widgets. + - a new `GtkShortcutAction` + a new `GtkShortcutAction` - the detailed name of the action + the detailed name of the action - Returns the name of the action that will be activated. + Returns the name of the action that will be activated. + - the name of the action to activate + the name of the action to activate - a named action + a named action - The name of the action to activate. + The name of the action to activate. - + + + - `GtkNative` is the interface implemented by all widgets that have + `GtkNative` is the interface implemented by all widgets that have their own `GdkSurface`. The obvious example of a `GtkNative` is `GtkWindow`. @@ -54861,100 +57617,107 @@ belongs, with [func@Gtk.Native.get_for_surface]. In addition to a [class@Gdk.Surface], a `GtkNative` also provides a [class@Gsk.Renderer] for rendering on that surface. To get the renderer, use [method@Gtk.Native.get_renderer]. + - Finds the `GtkNative` associated with the surface. + Finds the `GtkNative` associated with the surface. + - the `GtkNative` that is associated with @surface + the `GtkNative` that is associated with @surface - a `GdkSurface` + a `GdkSurface` - Returns the renderer that is used for this `GtkNative`. + Returns the renderer that is used for this `GtkNative`. + - the renderer for @self + the renderer for @self - a `GtkNative` + a `GtkNative` - Returns the surface of this `GtkNative`. + Returns the surface of this `GtkNative`. + - the surface of @self + the surface of @self - a `GtkNative` + a `GtkNative` - Retrieves the surface transform of @self. + Retrieves the surface transform of @self. This is the translation from @self's surface coordinates into @self's widget coordinates. + - a `GtkNative` + a `GtkNative` - return location for the x coordinate + return location for the x coordinate - return location for the y coordinate + return location for the y coordinate - Realizes a `GtkNative`. + Realizes a `GtkNative`. This should only be used by subclasses. + - a `GtkNative` + a `GtkNative` - Unrealizes a `GtkNative`. + Unrealizes a `GtkNative`. This should only be used by subclasses. + - a `GtkNative` + a `GtkNative` - Native dialogs are platform dialogs that don't use `GtkDialog`. + Native dialogs are platform dialogs that don't use `GtkDialog`. They are used in order to integrate better with a platform, by looking the same as other native applications and supporting @@ -54971,25 +57734,28 @@ Note that unlike `GtkDialog`, `GtkNativeDialog` objects are not toplevel widgets, and GTK does not keep them alive. It is your responsibility to keep a reference until you are done with the object. + - Hides the dialog if it is visible, aborting any interaction. + Hides the dialog if it is visible, aborting any interaction. Once this is called the [signal@Gtk.NativeDialog::response] signal will *not* be emitted until after the next call to [method@Gtk.NativeDialog.show]. If the dialog is not visible this does nothing. + - a `GtkNativeDialog` + a `GtkNativeDialog` + @@ -55003,25 +57769,26 @@ If the dialog is not visible this does nothing. - Shows the dialog on the display. + Shows the dialog on the display. When the user accepts the state of the dialog the dialog will be automatically hidden and the [signal@Gtk.NativeDialog::response] signal will be emitted. Multiple calls while the dialog is visible will be ignored. + - a `GtkNativeDialog` + a `GtkNativeDialog` - Destroys a dialog. + Destroys a dialog. When a dialog is destroyed, it will break any references it holds to other objects. @@ -55032,170 +57799,180 @@ resources will be destroyed. Note that this does not release any reference to the object (as opposed to destroying a `GtkWindow`) because there is no reference from the windowing system to the `GtkNativeDialog`. + - a `GtkNativeDialog` + a `GtkNativeDialog` - Returns whether the dialog is modal. + Returns whether the dialog is modal. + - %TRUE if the dialog is set to be modal + %TRUE if the dialog is set to be modal - a `GtkNativeDialog` + a `GtkNativeDialog` - Gets the title of the `GtkNativeDialog`. + Gets the title of the `GtkNativeDialog`. + - the title of the dialog, or %NULL if none has + the title of the dialog, or %NULL if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed. - a `GtkNativeDialog` + a `GtkNativeDialog` - Fetches the transient parent for this window. + Fetches the transient parent for this window. + - the transient parent for this window, + the transient parent for this window, or %NULL if no transient parent has been set. - a `GtkNativeDialog` + a `GtkNativeDialog` - Determines whether the dialog is visible. + Determines whether the dialog is visible. + - %TRUE if the dialog is visible + %TRUE if the dialog is visible - a `GtkNativeDialog` + a `GtkNativeDialog` - Hides the dialog if it is visible, aborting any interaction. + Hides the dialog if it is visible, aborting any interaction. Once this is called the [signal@Gtk.NativeDialog::response] signal will *not* be emitted until after the next call to [method@Gtk.NativeDialog.show]. If the dialog is not visible this does nothing. + - a `GtkNativeDialog` + a `GtkNativeDialog` - Sets a dialog modal or non-modal. + Sets a dialog modal or non-modal. Modal dialogs prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use [method@Gtk.NativeDialog.set_transient_for] to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent. + - a `GtkNativeDialog` + a `GtkNativeDialog` - whether the window is modal + whether the window is modal - Sets the title of the `GtkNativeDialog.` + Sets the title of the `GtkNativeDialog.` + - a `GtkNativeDialog` + a `GtkNativeDialog` - title of the dialog + title of the dialog - Dialog windows should be set transient for the main application + Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. Passing %NULL for @parent unsets the current transient window. + - a `GtkNativeDialog` + a `GtkNativeDialog` - parent window + parent window - Shows the dialog on the display. + Shows the dialog on the display. When the user accepts the state of the dialog the dialog will be automatically hidden and the [signal@Gtk.NativeDialog::response] signal will be emitted. Multiple calls while the dialog is visible will be ignored. + - a `GtkNativeDialog` + a `GtkNativeDialog` @@ -55203,31 +57980,31 @@ Multiple calls while the dialog is visible will be ignored. - Whether the window should be modal with respect to its transient parent. + Whether the window should be modal with respect to its transient parent. - The title of the dialog window + The title of the dialog window - The transient parent of the dialog, or %NULL for none. + The transient parent of the dialog, or %NULL for none. - Whether the window is currently visible. + Whether the window is currently visible. - Emitted when the user responds to the dialog. + Emitted when the user responds to the dialog. When this is called the dialog has been hidden. @@ -55238,19 +58015,21 @@ responds to the dialog this signal will not be emitted. - the response ID + the response ID - Class structure for `GtkNativeDialog`. + Class structure for `GtkNativeDialog`. + + @@ -55266,12 +58045,13 @@ responds to the dialog this signal will not be emitted. + - a `GtkNativeDialog` + a `GtkNativeDialog` @@ -55279,12 +58059,13 @@ responds to the dialog this signal will not be emitted. + - a `GtkNativeDialog` + a `GtkNativeDialog` @@ -55292,6 +58073,7 @@ responds to the dialog this signal will not be emitted. + @@ -55299,6 +58081,7 @@ responds to the dialog this signal will not be emitted. + @@ -55306,6 +58089,7 @@ responds to the dialog this signal will not be emitted. + @@ -55313,78 +58097,89 @@ responds to the dialog this signal will not be emitted. + - + + + - A `GtkShortcutTrigger` that never triggers. + A `GtkShortcutTrigger` that never triggers. + - Gets the never trigger. + Gets the never trigger. This is a singleton for a trigger that never triggers. Use this trigger instead of %NULL because it implements all virtual functions. + - The never trigger + The never trigger - + + + - `GtkNoSelection` is a `GtkSelectionModel` that does not allow selecting + `GtkNoSelection` is a `GtkSelectionModel` that does not allow selecting anything. This model is meant to be used as a simple wrapper around a `GListModel` when a `GtkSelectionModel` is required. + - Creates a new selection to handle @model. + Creates a new selection to handle @model. + - a new `GtkNoSelection` + a new `GtkNoSelection` - the `GListModel` to manage + the `GListModel` to manage - Gets the model that @self is wrapping. + Gets the model that @self is wrapping. + - The model being wrapped + The model being wrapped - a `GtkNoSelection` + a `GtkNoSelection` - Sets the model that @self should wrap. + Sets the model that @self should wrap. If @model is %NULL, this model will be empty. + - a `GtkNoSelection` + a `GtkNoSelection` - A `GListModel` to wrap + A `GListModel` to wrap @@ -55392,17 +58187,18 @@ If @model is %NULL, this model will be empty. - The model being managed. + The model being managed. + - `GtkNotebook` is a container whose children are pages switched + `GtkNotebook` is a container whose children are pages switched between using tabs. ![An example GtkNotebook](notebook.png) @@ -55498,59 +58294,62 @@ The nodes are always arranged from left-to-right, regardless of text direction. - Creates a new `GtkNotebook` widget with no pages. + Creates a new `GtkNotebook` widget with no pages. + - the newly created `GtkNotebook` + the newly created `GtkNotebook` - Appends a page to @notebook. + Appends a page to @notebook. + - the index (starting from 0) of the appended + the index (starting from 0) of the appended page in the notebook, or -1 if function fails - a `GtkNotebook` + a `GtkNotebook` - the `GtkWidget` to use as the contents of the page + the `GtkWidget` to use as the contents of the page - the `GtkWidget` to be used as the label + the `GtkWidget` to be used as the label for the page, or %NULL to use the default label, “page N” - Appends a page to @notebook, specifying the widget to use as the + Appends a page to @notebook, specifying the widget to use as the label in the popup menu. + - the index (starting from 0) of the appended + the index (starting from 0) of the appended page in the notebook, or -1 if function fails - a `GtkNotebook` + a `GtkNotebook` - the `GtkWidget` to use as the contents of the page + the `GtkWidget` to use as the contents of the page - the `GtkWidget` to be used as the label + the `GtkWidget` to be used as the label for the page, or %NULL to use the default label, “page N” - the widget to use as a label for the + the widget to use as a label for the page-switch menu, if that is enabled. If %NULL, and @tab_label is a `GtkLabel` or %NULL, then the menu label will be a newly created label with the same text as @tab_label; if @tab_label @@ -55561,102 +58360,108 @@ label in the popup menu. - Removes the child from the notebook. + Removes the child from the notebook. This function is very similar to [method@Gtk.Notebook.remove_page], but additionally informs the notebook that the removal is happening as part of a tab DND operation, which should not be cancelled. + - a `GtkNotebook` + a `GtkNotebook` - a child + a child - Gets one of the action widgets. + Gets one of the action widgets. See [method@Gtk.Notebook.set_action_widget]. + - The action widget + The action widget with the given @pack_type or %NULL when this action widget has not been set - a `GtkNotebook` + a `GtkNotebook` - pack type of the action widget to receive + pack type of the action widget to receive - Returns the page number of the current page. + Returns the page number of the current page. + - the index (starting from 0) of the current + the index (starting from 0) of the current page in the notebook. If the notebook has no pages, then -1 will be returned. - a `GtkNotebook` + a `GtkNotebook` - Gets the current group name for @notebook. + Gets the current group name for @notebook. + - the group name, + the group name, or %NULL if none is set - a `GtkNotebook` + a `GtkNotebook` - Retrieves the menu label widget of the page containing @child. + Retrieves the menu label widget of the page containing @child. + - the menu label, or %NULL + the menu label, or %NULL if the notebook page does not have a menu label other than the default (the tab label). - a `GtkNotebook` + a `GtkNotebook` - a widget contained in a page of @notebook + a widget contained in a page of @notebook - Retrieves the text of the menu label for the page containing + Retrieves the text of the menu label for the page containing @child. + - the text of the tab label, or %NULL if + the text of the tab label, or %NULL if the widget does not have a menu label other than the default menu label, or the menu label widget is not a `GtkLabel`. The string is owned by the widget and must not be freed. @@ -55664,266 +58469,280 @@ See [method@Gtk.Notebook.set_action_widget]. - a `GtkNotebook` + a `GtkNotebook` - the child widget of a page of the notebook. + the child widget of a page of the notebook. - Gets the number of pages in a notebook. + Gets the number of pages in a notebook. + - the number of pages in the notebook + the number of pages in the notebook - a `GtkNotebook` + a `GtkNotebook` - Returns the child widget contained in page number @page_num. + Returns the child widget contained in page number @page_num. + - the child widget, or %NULL if @page_num + the child widget, or %NULL if @page_num is out of bounds - a `GtkNotebook` + a `GtkNotebook` - the index of a page in the notebook, or -1 + the index of a page in the notebook, or -1 to get the last page - Returns the `GtkNotebookPage` for @child. + Returns the `GtkNotebookPage` for @child. + - the `GtkNotebookPage` for @child + the `GtkNotebookPage` for @child - a `GtkNotebook` + a `GtkNotebook` - a child of @notebook + a child of @notebook - Returns a `GListModel` that contains the pages of the notebook. + Returns a `GListModel` that contains the pages of the notebook. This can be used to keep an up-to-date view. The model also implements [iface@Gtk.SelectionModel] and can be used to track and modify the visible page. + - a + a `GListModel` for the notebook's children - a `GtkNotebook` + a `GtkNotebook` - Returns whether the tab label area has arrows for scrolling. + Returns whether the tab label area has arrows for scrolling. + - %TRUE if arrows for scrolling are present + %TRUE if arrows for scrolling are present - a `GtkNotebook` + a `GtkNotebook` - Returns whether a bevel will be drawn around the notebook pages. + Returns whether a bevel will be drawn around the notebook pages. + - %TRUE if the bevel is drawn + %TRUE if the bevel is drawn - a `GtkNotebook` + a `GtkNotebook` - Returns whether the tabs of the notebook are shown. + Returns whether the tabs of the notebook are shown. + - %TRUE if the tabs are shown + %TRUE if the tabs are shown - a `GtkNotebook` + a `GtkNotebook` - Returns whether the tab contents can be detached from @notebook. + Returns whether the tab contents can be detached from @notebook. + - %TRUE if the tab is detachable. + %TRUE if the tab is detachable. - a `GtkNotebook` + a `GtkNotebook` - a child `GtkWidget` + a child `GtkWidget` - Returns the tab label widget for the page @child. + Returns the tab label widget for the page @child. %NULL is returned if @child is not in @notebook or if no tab label has specifically been set for @child. + - the tab label + the tab label - a `GtkNotebook` + a `GtkNotebook` - the page + the page - Retrieves the text of the tab label for the page containing + Retrieves the text of the tab label for the page containing @child. + - the text of the tab label, or %NULL if + the text of the tab label, or %NULL if the tab label idget is not a `GtkLabel`. The string is owned by the widget and must not be freed. - a `GtkNotebook` + a `GtkNotebook` - a widget contained in a page of @notebook + a widget contained in a page of @notebook - Gets the edge at which the tabs are drawn. + Gets the edge at which the tabs are drawn. + - the edge at which the tabs are drawn + the edge at which the tabs are drawn - a `GtkNotebook` + a `GtkNotebook` - Gets whether the tab can be reordered via drag and drop or not. + Gets whether the tab can be reordered via drag and drop or not. + - %TRUE if the tab is reorderable. + %TRUE if the tab is reorderable. - a `GtkNotebook` + a `GtkNotebook` - a child `GtkWidget` + a child `GtkWidget` - Insert a page into @notebook at the given position. + Insert a page into @notebook at the given position. + - the index (starting from 0) of the inserted + the index (starting from 0) of the inserted page in the notebook, or -1 if function fails - a `GtkNotebook` + a `GtkNotebook` - the `GtkWidget` to use as the contents of the page + the `GtkWidget` to use as the contents of the page - the `GtkWidget` to be used as the label + the `GtkWidget` to be used as the label for the page, or %NULL to use the default label, “page N” - the index (starting at 0) at which to insert the page, + the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages - Insert a page into @notebook at the given position, specifying + Insert a page into @notebook at the given position, specifying the widget to use as the label in the popup menu. + - the index (starting from 0) of the inserted + the index (starting from 0) of the inserted page in the notebook - a `GtkNotebook` + a `GtkNotebook` - the `GtkWidget` to use as the contents of the page + the `GtkWidget` to use as the contents of the page - the `GtkWidget` to be used as the label + the `GtkWidget` to be used as the label for the page, or %NULL to use the default label, “page N” - the widget to use as a label for the + the widget to use as a label for the page-switch menu, if that is enabled. If %NULL, and @tab_label is a `GtkLabel` or %NULL, then the menu label will be a newly created label with the same text as @tab_label; if @tab_label @@ -55932,119 +58751,125 @@ the widget to use as the label in the popup menu. - the index (starting at 0) at which to insert the page, + the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages. - Switches to the next page. + Switches to the next page. Nothing happens if the current page is the last page. + - a `GtkNotebook` + a `GtkNotebook` - Finds the index of the page which contains the given child + Finds the index of the page which contains the given child widget. + - the index of the page containing @child, or + the index of the page containing @child, or -1 if @child is not in the notebook - a `GtkNotebook` + a `GtkNotebook` - a `GtkWidget` + a `GtkWidget` - Disables the popup menu. + Disables the popup menu. + - a `GtkNotebook` + a `GtkNotebook` - Enables the popup menu. + Enables the popup menu. If the user clicks with the right mouse button on the tab labels, a menu with all the pages will be popped up. + - a `GtkNotebook` + a `GtkNotebook` - Prepends a page to @notebook. + Prepends a page to @notebook. + - the index (starting from 0) of the prepended + the index (starting from 0) of the prepended page in the notebook, or -1 if function fails - a `GtkNotebook` + a `GtkNotebook` - the `GtkWidget` to use as the contents of the page + the `GtkWidget` to use as the contents of the page - the `GtkWidget` to be used as the label + the `GtkWidget` to be used as the label for the page, or %NULL to use the default label, “page N” - Prepends a page to @notebook, specifying the widget to use as the + Prepends a page to @notebook, specifying the widget to use as the label in the popup menu. + - the index (starting from 0) of the prepended + the index (starting from 0) of the prepended page in the notebook, or -1 if function fails - a `GtkNotebook` + a `GtkNotebook` - the `GtkWidget` to use as the contents of the page + the `GtkWidget` to use as the contents of the page - the `GtkWidget` to be used as the label + the `GtkWidget` to be used as the label for the page, or %NULL to use the default label, “page N” - the widget to use as a label for the + the widget to use as a label for the page-switch menu, if that is enabled. If %NULL, and @tab_label is a `GtkLabel` or %NULL, then the menu label will be a newly created label with the same text as @tab_label; if @tab_label @@ -56055,103 +58880,108 @@ label in the popup menu. - Switches to the previous page. + Switches to the previous page. Nothing happens if the current page is the first page. + - a `GtkNotebook` + a `GtkNotebook` - Removes a page from the notebook given its index + Removes a page from the notebook given its index in the notebook. + - a `GtkNotebook` + a `GtkNotebook` - the index of a notebook page, starting + the index of a notebook page, starting from 0. If -1, the last page will be removed. - Reorders the page containing @child, so that it appears in position + Reorders the page containing @child, so that it appears in position @position. If @position is greater than or equal to the number of children in the list or negative, @child will be moved to the end of the list. + - a `GtkNotebook` + a `GtkNotebook` - the child to move + the child to move - the new position, or -1 to move to the end + the new position, or -1 to move to the end - Sets @widget as one of the action widgets. + Sets @widget as one of the action widgets. Depending on the pack type the widget will be placed before or after the tabs. You can use a `GtkBox` if you need to pack more than one widget on the same side. + - a `GtkNotebook` + a `GtkNotebook` - a `GtkWidget` + a `GtkWidget` - pack type of the action widget + pack type of the action widget - Switches to the page number @page_num. + Switches to the page number @page_num. Note that due to historical reasons, GtkNotebook refuses to switch to a page unless the child widget is visible. Therefore, it is recommended to show child widgets before adding them to a notebook. + - a `GtkNotebook` + a `GtkNotebook` - index of the page to switch to, starting from 0. + index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the notebook, nothing will be done. @@ -56161,122 +58991,128 @@ adding them to a notebook. - Sets a group name for @notebook. + Sets a group name for @notebook. Notebooks with the same name will be able to exchange tabs via drag and drop. A notebook with a %NULL group name will not be able to exchange tabs with any other notebook. + - a `GtkNotebook` + a `GtkNotebook` - the name of the notebook group, + the name of the notebook group, or %NULL to unset it - Changes the menu label for the page containing @child. + Changes the menu label for the page containing @child. + - a `GtkNotebook` + a `GtkNotebook` - the child widget + the child widget - the menu label, or %NULL for default + the menu label, or %NULL for default - Creates a new label and sets it as the menu label of @child. + Creates a new label and sets it as the menu label of @child. + - a `GtkNotebook` + a `GtkNotebook` - the child widget + the child widget - the label text + the label text - Sets whether the tab label area will have arrows for + Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area. + - a `GtkNotebook` + a `GtkNotebook` - %TRUE if scroll arrows should be added + %TRUE if scroll arrows should be added - Sets whether a bevel will be drawn around the notebook pages. + Sets whether a bevel will be drawn around the notebook pages. This only has a visual effect when the tabs are not shown. + - a `GtkNotebook` + a `GtkNotebook` - %TRUE if a bevel should be drawn around the notebook + %TRUE if a bevel should be drawn around the notebook - Sets whether to show the tabs for the notebook or not. + Sets whether to show the tabs for the notebook or not. + - a `GtkNotebook` + a `GtkNotebook` - %TRUE if the tabs should be shown + %TRUE if the tabs should be shown - Sets whether the tab can be detached from @notebook to another + Sets whether the tab can be detached from @notebook to another notebook or widget. Note that two notebooks must share a common group identificator @@ -56320,150 +59156,155 @@ on_drag_data_received (GtkWidget *widget, If you want a notebook to accept drags from other widgets, you will have to set your own DnD code to do it. + - a `GtkNotebook` + a `GtkNotebook` - a child `GtkWidget` + a child `GtkWidget` - whether the tab is detachable or not + whether the tab is detachable or not - Changes the tab label for @child. + Changes the tab label for @child. If %NULL is specified for @tab_label, then the page will have the label “page N”. + - a `GtkNotebook` + a `GtkNotebook` - the page + the page - the tab label widget to use, or %NULL + the tab label widget to use, or %NULL for default tab label - Creates a new label and sets it as the tab label for the page + Creates a new label and sets it as the tab label for the page containing @child. + - a `GtkNotebook` + a `GtkNotebook` - the page + the page - the label text + the label text - Sets the edge at which the tabs are drawn. + Sets the edge at which the tabs are drawn. + - a `GtkNotebook`. + a `GtkNotebook`. - the edge to draw the tabs at + the edge to draw the tabs at - Sets whether the notebook tab can be reordered + Sets whether the notebook tab can be reordered via drag and drop or not. + - a `GtkNotebook` + a `GtkNotebook` - a child `GtkWidget` + a child `GtkWidget` - whether the tab is reorderable or not + whether the tab is reorderable or not - If %TRUE, pressing the right mouse button on the notebook shows a page switching menu. + If %TRUE, pressing the right mouse button on the notebook shows a page switching menu. - Group name for tab drag and drop. + Group name for tab drag and drop. - The index of the current page. + The index of the current page. - A selection model with the pages. + A selection model with the pages. - If %TRUE, scroll arrows are added if there are too many pages to fit. + If %TRUE, scroll arrows are added if there are too many pages to fit. - Whether the border should be shown. + Whether the border should be shown. - Whether tabs should be shown. + Whether tabs should be shown. - Which side of the notebook holds the tabs. + Which side of the notebook holds the tabs. @@ -56477,7 +59318,7 @@ via drag and drop or not. - The ::create-window signal is emitted when a detachable + The ::create-window signal is emitted when a detachable tab is dropped on the root window. A handler for this signal can create a window containing @@ -56486,13 +59327,13 @@ responsible for moving/resizing the window and adding the necessary properties to the notebook (e.g. the `GtkNotebook`:group-name ). - a `GtkNotebook` that + a `GtkNotebook` that @page should be added to - the tab of @notebook that is being detached + the tab of @notebook that is being detached @@ -56518,52 +59359,52 @@ necessary properties to the notebook (e.g. the - the ::page-added signal is emitted in the notebook + the ::page-added signal is emitted in the notebook right after a page is added to the notebook. - the child `GtkWidget` affected + the child `GtkWidget` affected - the new page number for @child + the new page number for @child - the ::page-removed signal is emitted in the notebook + the ::page-removed signal is emitted in the notebook right after a page is removed from the notebook. - the child `GtkWidget` affected + the child `GtkWidget` affected - the @child page number + the @child page number - the ::page-reordered signal is emitted in the notebook + the ::page-reordered signal is emitted in the notebook right after a page has been reordered. - the child `GtkWidget` affected + the child `GtkWidget` affected - the new page number for @child + the new page number for @child @@ -56592,216 +59433,227 @@ right after a page has been reordered. - Emitted when the user or a function changes the current page. + Emitted when the user or a function changes the current page. - the new current page + the new current page - the index of the page + the index of the page - `GtkNotebookPage` is an auxiliary object used by `GtkNotebook`. + `GtkNotebookPage` is an auxiliary object used by `GtkNotebook`. - Returns the notebook child to which @page belongs. + Returns the notebook child to which @page belongs. + - the child to which @page belongs + the child to which @page belongs - a `GtkNotebookPage` + a `GtkNotebookPage` - The child for this page. + The child for this page. - Whether the tab is detachable. + Whether the tab is detachable. - The label widget displayed in the childs menu entry. + The label widget displayed in the childs menu entry. - The text of the menu widget. + The text of the menu widget. - The index of the child in the parent. + The index of the child in the parent. - Whether the tab is reorderable by user action. + Whether the tab is reorderable by user action. - The tab widget for tihs page. + The tab widget for tihs page. - Whether to expand the childs tab. + Whether to expand the childs tab. - Whether the childs tab should fill the allocated area. + Whether the childs tab should fill the allocated area. - The text of the tab widget. + The text of the tab widget. - The parameter used in the action signals of `GtkNotebook`. + The parameter used in the action signals of `GtkNotebook`. - the first tab in the notebook + the first tab in the notebook - the last tab in the notebook + the last tab in the notebook - A `GtkShortcutAction` that does nothing. + A `GtkShortcutAction` that does nothing. + - Gets the nothing action. + Gets the nothing action. This is an action that does nothing and where activating it always fails. + - The nothing action + The nothing action - + + + - Used to determine the layout of pages on a sheet when printing + Used to determine the layout of pages on a sheet when printing multiple pages per sheet. - ![](layout-lrtb.png) + ![](layout-lrtb.png) - ![](layout-lrbt.png) + ![](layout-lrbt.png) - ![](layout-rltb.png) + ![](layout-rltb.png) - ![](layout-rlbt.png) + ![](layout-rlbt.png) - ![](layout-tblr.png) + ![](layout-tblr.png) - ![](layout-tbrl.png) + ![](layout-tbrl.png) - ![](layout-btlr.png) + ![](layout-btlr.png) - ![](layout-btrl.png) + ![](layout-btrl.png) - `GtkNumericSorter` is a `GtkSorter` that compares numbers. + `GtkNumericSorter` is a `GtkSorter` that compares numbers. To obtain the numbers to compare, this sorter evaluates a [class@Gtk.Expression]. + - Creates a new numeric sorter using the given @expression. + Creates a new numeric sorter using the given @expression. Smaller numbers will be sorted first. You can call [method@Gtk.NumericSorter.set_sort_order] to change this. + - a new `GtkNumericSorter` + a new `GtkNumericSorter` - The expression to evaluate + The expression to evaluate - Gets the expression that is evaluated to obtain numbers from items. + Gets the expression that is evaluated to obtain numbers from items. + - a `GtkExpression` + a `GtkExpression` - a `GtkNumericSorter` + a `GtkNumericSorter` - Gets whether this sorter will sort smaller numbers first. + Gets whether this sorter will sort smaller numbers first. + - the order of the numbers + the order of the numbers - a `GtkNumericSorter` + a `GtkNumericSorter` - Sets the expression that is evaluated to obtain numbers from items. + Sets the expression that is evaluated to obtain numbers from items. Unless an expression is set on @self, the sorter will always compare items as invalid. The expression must have a return type that can be compared numerically, such as %G_TYPE_INT or %G_TYPE_DOUBLE. + - a `GtkNumericSorter` + a `GtkNumericSorter` - a `GtkExpression` + a `GtkExpression` - Sets whether to sort smaller numbers before larger ones. + Sets whether to sort smaller numbers before larger ones. + - a `GtkNumericSorter` + a `GtkNumericSorter` - whether to sort smaller numbers first + whether to sort smaller numbers first @@ -56809,138 +59661,148 @@ numerically, such as %G_TYPE_INT or %G_TYPE_DOUBLE. - The expression to evaluate on items to get a number to compare with. + The expression to evaluate on items to get a number to compare with. - Whether the sorter will sort smaller numbers first. + Whether the sorter will sort smaller numbers first. + + + + - A `GObject` value in a `GtkExpression`. + A `GObject` value in a `GtkExpression`. - Creates an expression evaluating to the given `object` with a weak reference. + Creates an expression evaluating to the given `object` with a weak reference. Once the `object` is disposed, it will fail to evaluate. This expression is meant to break reference cycles. If you want to keep a reference to `object`, use [ctor@Gtk.ConstantExpression.new]. + - a new `GtkExpression` + a new `GtkExpression` - object to watch + object to watch - Gets the object that the expression evaluates to. + Gets the object that the expression evaluates to. + - the object, or `NULL` + the object, or `NULL` - an object `GtkExpression` + an object `GtkExpression` - Describes the way two values can be compared. + Describes the way two values can be compared. These values can be used with a `GCompareFunc`. However, a `GCompareFunc` is allowed to return any integer values. For converting such a value to a `GtkOrdering` value, use [func@Gtk.Ordering.from_cmpfunc]. - the first value is smaller than the second + the first value is smaller than the second - the two values are equal + the two values are equal - the first value is larger than the second + the first value is larger than the second - Converts the result of a `GCompareFunc` like strcmp() to a + Converts the result of a `GCompareFunc` like strcmp() to a `GtkOrdering` value. + - the corresponding `GtkOrdering` + the corresponding `GtkOrdering` - Result of a comparison function + Result of a comparison function - The `GtkOrientable` interface is implemented by all widgets that can be + The `GtkOrientable` interface is implemented by all widgets that can be oriented horizontally or vertically. `GtkOrientable` is more flexible in that it allows the orientation to be changed at runtime, allowing the widgets to “flip”. + - Retrieves the orientation of the @orientable. + Retrieves the orientation of the @orientable. + - the orientation of the @orientable + the orientation of the @orientable - a `GtkOrientable` + a `GtkOrientable` - Sets the orientation of the @orientable. + Sets the orientation of the @orientable. + - a `GtkOrientable` + a `GtkOrientable` - the orientable’s new orientation + the orientable’s new orientation @@ -56948,43 +59810,44 @@ changed at runtime, allowing the widgets to “flip”. - The orientation of the orientable. + The orientation of the orientable. + - Represents the orientation of widgets and other objects. + Represents the orientation of widgets and other objects. Typical examples are `GtkBox or `GtkGesturePan`. - The element is in horizontal orientation. + The element is in horizontal orientation. - The element is in vertical orientation. + The element is in vertical orientation. - Defines how content overflowing a given area should be handled. + Defines how content overflowing a given area should be handled. This is used in [method@Gtk.Widget.set_overflow]. The [property@Gtk.Widget:overflow] property is modeled after the CSS overflow property, but implements it only partially. - No change is applied. Content is drawn at the specified + No change is applied. Content is drawn at the specified position. - Content is clipped to the bounds of the area. Content + Content is clipped to the bounds of the area. Content outside the area is not drawn and cannot be interacted with. - `GtkOverlay` is a container which contains a single main child, on top + `GtkOverlay` is a container which contains a single main child, on top of which it can place “overlay” widgets. ![An example GtkOverlay](overlay.png) @@ -57020,14 +59883,15 @@ whose alignments cause them to be positioned at an edge get the style classes - Creates a new `GtkOverlay`. + Creates a new `GtkOverlay`. + - a new `GtkOverlay` object. + a new `GtkOverlay` object. - Adds @widget to @overlay. + Adds @widget to @overlay. The widget will be stacked on top of the main widget added with [method@Gtk.Overlay.set_child]. @@ -57035,140 +59899,148 @@ added with [method@Gtk.Overlay.set_child]. The position at which @widget is placed is determined from its [property@Gtk.Widget:halign] and [property@Gtk.Widget:valign] properties. + - a `GtkOverlay` + a `GtkOverlay` - a `GtkWidget` to be added to the container + a `GtkWidget` to be added to the container - Gets the child widget of @overlay. + Gets the child widget of @overlay. + - the child widget of @overlay + the child widget of @overlay - a `GtkOverlay` + a `GtkOverlay` - Gets whether @widget should be clipped within the parent. + Gets whether @widget should be clipped within the parent. + - whether the widget is clipped within the parent. + whether the widget is clipped within the parent. - a `GtkOverlay` + a `GtkOverlay` - an overlay child of `GtkOverlay` + an overlay child of `GtkOverlay` - Gets whether @widget's size is included in the measurement of + Gets whether @widget's size is included in the measurement of @overlay. + - whether the widget is measured + whether the widget is measured - a `GtkOverlay` + a `GtkOverlay` - an overlay child of `GtkOverlay` + an overlay child of `GtkOverlay` - Removes an overlay that was added with gtk_overlay_add_overlay(). + Removes an overlay that was added with gtk_overlay_add_overlay(). + - a `GtkOverlay` + a `GtkOverlay` - a `GtkWidget` to be removed + a `GtkWidget` to be removed - Sets the child widget of @overlay. + Sets the child widget of @overlay. + - a `GtkOverlay` + a `GtkOverlay` - the child widget + the child widget - Sets whether @widget should be clipped within the parent. + Sets whether @widget should be clipped within the parent. + - a `GtkOverlay` + a `GtkOverlay` - an overlay child of `GtkOverlay` + an overlay child of `GtkOverlay` - whether the child should be clipped + whether the child should be clipped - Sets whether @widget is included in the measured size of @overlay. + Sets whether @widget is included in the measured size of @overlay. The overlay will request the size of the largest child that has this property set to %TRUE. Children who are not included may be drawn outside of @overlay's allocation if they are too large. + - a `GtkOverlay` + a `GtkOverlay` - an overlay child of `GtkOverlay` + an overlay child of `GtkOverlay` - whether the child should be measured + whether the child should be measured @@ -57177,7 +60049,7 @@ be drawn outside of @overlay's allocation if they are too large. - Emitted to determine the position and size of any overlay + Emitted to determine the position and size of any overlay child widgets. A handler for this signal should fill @allocation with @@ -57192,16 +60064,16 @@ be full-width/height). If the main child is a `GtkScrolledWindow`, the overlays are placed relative to its contents. - %TRUE if the @allocation has been filled + %TRUE if the @allocation has been filled - the child widget to position + the child widget to position - return + return location for the allocation @@ -57209,81 +60081,88 @@ to its contents. - `GtkOverlayLayout` is the layout manager used by `GtkOverlay`. + `GtkOverlayLayout` is the layout manager used by `GtkOverlay`. It places widgets as overlays on top of the main child. This is not a reusable layout manager, since it expects its widget to be a `GtkOverlay`. It only listed here so that its layout properties get documented. + - Creates a new `GtkOverlayLayout` instance. + Creates a new `GtkOverlayLayout` instance. + - the newly created instance + the newly created instance - `GtkLayoutChild` subclass for children in a `GtkOverlayLayout`. + `GtkLayoutChild` subclass for children in a `GtkOverlayLayout`. + - Retrieves whether the child is clipped. + Retrieves whether the child is clipped. + - whether the child is clipped + whether the child is clipped - a `GtkOverlayLayoutChild` + a `GtkOverlayLayoutChild` - Retrieves whether the child is measured. + Retrieves whether the child is measured. + - whether the child is measured + whether the child is measured - a `GtkOverlayLayoutChild` + a `GtkOverlayLayoutChild` - Sets whether to clip this child. + Sets whether to clip this child. + - a `GtkOverlayLayoutChild` + a `GtkOverlayLayoutChild` - whether to clip this child + whether to clip this child - Sets whether to measure this child. + Sets whether to measure this child. + - a `GtkOverlayLayoutChild` + a `GtkOverlayLayoutChild` - whether to measure this child + whether to measure this child @@ -57291,363 +60170,430 @@ properties get documented. - Whether the child should be clipped to fit the parent's size. + Whether the child should be clipped to fit the parent's size. - Whether the child size should contribute to the `GtkOverlayLayout`'s + Whether the child size should contribute to the `GtkOverlayLayout`'s measurement. + + + + + + + + - Name for the A3 paper size. + Name for the A3 paper size. + - Name for the A4 paper size. + Name for the A4 paper size. + - Name for the A5 paper size. + Name for the A5 paper size. + - Name for the B5 paper size. + Name for the B5 paper size. + - Name for the Executive paper size. + Name for the Executive paper size. + - Name for the Legal paper size. + Name for the Legal paper size. + - Name for the Letter paper size. + Name for the Letter paper size. + + + + + + + + + + + + + + + + + + + + + + + + + + + - The key used by the “Print to file” printer to store the file + The key used by the “Print to file” printer to store the file name of the output without the path to the directory and the file extension. + + - The key used by the “Print to file” printer to store the + The key used by the “Print to file” printer to store the directory to which the output should be written. + - The key used by the “Print to file” printer to store the format + The key used by the “Print to file” printer to store the format of the output. The supported values are “PS” and “PDF”. + - The key used by the “Print to file” printer to store the URI + The key used by the “Print to file” printer to store the URI to which the output should be written. GTK itself supports only “file://” URIs. + + + + + + + + + + + + + + + + + + + - Use this priority for functionality related to size allocation. + Use this priority for functionality related to size allocation. It is used internally by GTK+ to compute the sizes of widgets. This priority is higher than %GDK_PRIORITY_REDRAW to avoid resizing a widget which was just redrawn. + + - Represents the packing location of a children in its parent. + Represents the packing location of a children in its parent. See `GtkWindowControls` for example. - The child is packed into the start of the widget + The child is packed into the start of the widget - The child is packed into the end of the widget + The child is packed into the end of the widget - Struct defining a pad action entry. + Struct defining a pad action entry. + - the type of pad feature that will trigger this action entry. + the type of pad feature that will trigger this action entry. - the 0-indexed button/ring/strip number that will trigger this action + the 0-indexed button/ring/strip number that will trigger this action entry. - the mode that will trigger this action entry, or -1 for all modes. + the mode that will trigger this action entry, or -1 for all modes. - Human readable description of this action entry, this string should + Human readable description of this action entry, this string should be deemed user-visible. - action name that will be activated in the `GActionGroup`. + action name that will be activated in the `GActionGroup`. - The type of a pad action. + The type of a pad action. - Action is triggered by a pad button + Action is triggered by a pad button - Action is triggered by a pad ring + Action is triggered by a pad ring - Action is triggered by a pad strip + Action is triggered by a pad strip - `GtkPadController` is an event controller for the pads found in drawing + `GtkPadController` is an event controller for the pads found in drawing tablets. Pads are the collection of buttons and tactile sensors often found around @@ -57694,8 +60640,9 @@ pad_controller = gtk_pad_controller_new (action_group, NULL); The actions belonging to rings/strips will be activated with a parameter of type %G_VARIANT_TYPE_DOUBLE bearing the value of the given axis, it is required that those are made stateful and accepting this `GVariantType`. + - Creates a new `GtkPadController` that will associate events from @pad to + Creates a new `GtkPadController` that will associate events from @pad to actions. A %NULL pad may be provided so the controller manages all pad devices @@ -57709,23 +60656,24 @@ or [method@Gtk.PadController.set_action]. Be aware that pad events will only be delivered to `GtkWindow`s, so adding a pad controller to any other type of widget will not have an effect. + - A newly created `GtkPadController` + A newly created `GtkPadController` - `GActionGroup` to trigger actions from + `GActionGroup` to trigger actions from - A %GDK_SOURCE_TABLET_PAD device, or %NULL to handle all pads + A %GDK_SOURCE_TABLET_PAD device, or %NULL to handle all pads - Adds an individual action to @controller. + Adds an individual action to @controller. This action will only be activated if the given button/ring/strip number in @index is interacted while the current mode is @mode. -1 may be used @@ -57734,58 +60682,60 @@ for simple cases, so the action is triggered on all modes. The given @label should be considered user-visible, so internationalization rules apply. Some windowing systems may be able to use those for user feedback. + - a `GtkPadController` + a `GtkPadController` - the type of pad feature that will trigger this action + the type of pad feature that will trigger this action - the 0-indexed button/ring/strip number that will trigger this action + the 0-indexed button/ring/strip number that will trigger this action - the mode that will trigger this action, or -1 for all modes. + the mode that will trigger this action, or -1 for all modes. - Human readable description of this action, this string should + Human readable description of this action, this string should be deemed user-visible. - action name that will be activated in the `GActionGroup` + action name that will be activated in the `GActionGroup` - A convenience function to add a group of action entries on + A convenience function to add a group of action entries on @controller. See [struct@Gtk.PadActionEntry] and [method@Gtk.PadController.set_action]. + - a `GtkPadController` + a `GtkPadController` - the action entries to set on @controller + the action entries to set on @controller - the number of elements in @entries + the number of elements in @entries @@ -57797,49 +60747,52 @@ See [struct@Gtk.PadActionEntry] and [method@Gtk.PadController.set_action]. - + + + - See also gtk_print_settings_set_orientation(). + See also gtk_print_settings_set_orientation(). - Portrait mode. + Portrait mode. - Landscape mode. + Landscape mode. - Reverse portrait mode. + Reverse portrait mode. - Reverse landscape mode. + Reverse landscape mode. - A range of pages to print. + A range of pages to print. See also [method@Gtk.PrintSettings.set_page_ranges]. + - start of page range. + start of page range. - end of page range. + end of page range. - See also gtk_print_job_set_page_set(). + See also gtk_print_job_set_page_set(). - All pages. + All pages. - Even pages. + Even pages. - Odd pages. + Odd pages. - A `GtkPageSetup` object stores the page size, orientation and margins. + A `GtkPageSetup` object stores the page size, orientation and margins. The idea is that you can get one of these from the page setup dialog and then pass it to the `GtkPrintOperation` when printing. @@ -57882,478 +60835,505 @@ do_page_setup (void) } ``` - Creates a new `GtkPageSetup`. + Creates a new `GtkPageSetup`. + - a new `GtkPageSetup`. + a new `GtkPageSetup`. - Reads the page setup from the file @file_name. + Reads the page setup from the file @file_name. Returns a new `GtkPageSetup` object with the restored page setup, or %NULL if an error occurred. See [method@Gtk.PageSetup.to_file]. + - the restored `GtkPageSetup` + the restored `GtkPageSetup` - the filename to read the page setup from + the filename to read the page setup from - Desrialize a page setup from an a{sv} variant. + Desrialize a page setup from an a{sv} variant. The variant must be in the format produced by [method@Gtk.PageSetup.to_gvariant]. + - a new `GtkPageSetup` object + a new `GtkPageSetup` object - an a{sv} `GVariant` + an a{sv} `GVariant` - Reads the page setup from the group @group_name in the key file + Reads the page setup from the group @group_name in the key file @key_file. Returns a new `GtkPageSetup` object with the restored page setup, or %NULL if an error occurred. + - the restored `GtkPageSetup` + the restored `GtkPageSetup` - the `GKeyFile` to retrieve the page_setup from + the `GKeyFile` to retrieve the page_setup from - the name of the group in the key_file to read + the name of the group in the key_file to read to use the default name “Page Setup” - Copies a `GtkPageSetup`. + Copies a `GtkPageSetup`. + - a copy of @other + a copy of @other - the `GtkPageSetup` to copy + the `GtkPageSetup` to copy - Gets the bottom margin in units of @unit. + Gets the bottom margin in units of @unit. + - the bottom margin + the bottom margin - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Gets the left margin in units of @unit. + Gets the left margin in units of @unit. + - the left margin + the left margin - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Gets the page orientation of the `GtkPageSetup`. + Gets the page orientation of the `GtkPageSetup`. + - the page orientation + the page orientation - a `GtkPageSetup` + a `GtkPageSetup` - Returns the page height in units of @unit. + Returns the page height in units of @unit. Note that this function takes orientation and margins into consideration. See [method@Gtk.PageSetup.get_paper_height]. + - the page height. + the page height. - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Returns the page width in units of @unit. + Returns the page width in units of @unit. Note that this function takes orientation and margins into consideration. See [method@Gtk.PageSetup.get_paper_width]. + - the page width. + the page width. - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Returns the paper height in units of @unit. + Returns the paper height in units of @unit. Note that this function takes orientation, but not margins into consideration. See [method@Gtk.PageSetup.get_page_height]. + - the paper height. + the paper height. - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Gets the paper size of the `GtkPageSetup`. + Gets the paper size of the `GtkPageSetup`. + - the paper size + the paper size - a `GtkPageSetup` + a `GtkPageSetup` - Returns the paper width in units of @unit. + Returns the paper width in units of @unit. Note that this function takes orientation, but not margins into consideration. See [method@Gtk.PageSetup.get_page_width]. + - the paper width. + the paper width. - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Gets the right margin in units of @unit. + Gets the right margin in units of @unit. + - the right margin + the right margin - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Gets the top margin in units of @unit. + Gets the top margin in units of @unit. + - the top margin + the top margin - a `GtkPageSetup` + a `GtkPageSetup` - the unit for the return value + the unit for the return value - Reads the page setup from the file @file_name. + Reads the page setup from the file @file_name. See [method@Gtk.PageSetup.to_file]. + - %TRUE on success + %TRUE on success - a `GtkPageSetup` + a `GtkPageSetup` - the filename to read the page setup from + the filename to read the page setup from - Reads the page setup from the group @group_name in the key file + Reads the page setup from the group @group_name in the key file @key_file. + - %TRUE on success + %TRUE on success - a `GtkPageSetup` + a `GtkPageSetup` - the `GKeyFile` to retrieve the page_setup from + the `GKeyFile` to retrieve the page_setup from - the name of the group in the key_file to read + the name of the group in the key_file to read to use the default name “Page Setup” - Sets the bottom margin of the `GtkPageSetup`. + Sets the bottom margin of the `GtkPageSetup`. + - a `GtkPageSetup` + a `GtkPageSetup` - the new bottom margin in units of @unit + the new bottom margin in units of @unit - the units for @margin + the units for @margin - Sets the left margin of the `GtkPageSetup`. + Sets the left margin of the `GtkPageSetup`. + - a `GtkPageSetup` + a `GtkPageSetup` - the new left margin in units of @unit + the new left margin in units of @unit - the units for @margin + the units for @margin - Sets the page orientation of the `GtkPageSetup`. + Sets the page orientation of the `GtkPageSetup`. + - a `GtkPageSetup` + a `GtkPageSetup` - a `GtkPageOrientation` value + a `GtkPageOrientation` value - Sets the paper size of the `GtkPageSetup` without + Sets the paper size of the `GtkPageSetup` without changing the margins. See [method@Gtk.PageSetup.set_paper_size_and_default_margins]. + - a `GtkPageSetup` + a `GtkPageSetup` - a `GtkPaperSize` + a `GtkPaperSize` - Sets the paper size of the `GtkPageSetup` and modifies + Sets the paper size of the `GtkPageSetup` and modifies the margins according to the new paper size. + - a `GtkPageSetup` + a `GtkPageSetup` - a `GtkPaperSize` + a `GtkPaperSize` - Sets the right margin of the `GtkPageSetup`. + Sets the right margin of the `GtkPageSetup`. + - a `GtkPageSetup` + a `GtkPageSetup` - the new right margin in units of @unit + the new right margin in units of @unit - the units for @margin + the units for @margin - Sets the top margin of the `GtkPageSetup`. + Sets the top margin of the `GtkPageSetup`. + - a `GtkPageSetup` + a `GtkPageSetup` - the new top margin in units of @unit + the new top margin in units of @unit - the units for @margin + the units for @margin - This function saves the information from @setup to @file_name. + This function saves the information from @setup to @file_name. + - %TRUE on success + %TRUE on success - a `GtkPageSetup` + a `GtkPageSetup` - the file to save to + the file to save to - Serialize page setup to an a{sv} variant. + Serialize page setup to an a{sv} variant. + - a new, floating, `GVariant` + a new, floating, `GVariant` - a `GtkPageSetup` + a `GtkPageSetup` - This function adds the page setup from @setup to @key_file. + This function adds the page setup from @setup to @key_file. + - a `GtkPageSetup` + a `GtkPageSetup` - the `GKeyFile` to save the page setup to + the `GKeyFile` to save the page setup to - the group to add the settings to in @key_file, + the group to add the settings to in @key_file, or %NULL to use the default name “Page Setup” @@ -58361,29 +61341,30 @@ the margins according to the new paper size. - The type of function that is passed to + The type of function that is passed to gtk_print_run_page_setup_dialog_async(). This function will be called when the page setup dialog is dismissed, and also serves as destroy notify for @data. + - the `GtkPageSetup` that has been passed to + the `GtkPageSetup` that has been passed to gtk_print_run_page_setup_dialog_async() - user data that has been passed to + user data that has been passed to gtk_print_run_page_setup_dialog_async() - `GtkPageSetupUnixDialog` implements a page setup dialog for platforms + `GtkPageSetupUnixDialog` implements a page setup dialog for platforms which don’t provide a native page setup dialog, like Unix. ![An example GtkPageSetupUnixDialog](pagesetupdialog.png) @@ -58398,100 +61379,105 @@ API in [class@Gtk.PrintOperation]. - Creates a new page setup dialog. + Creates a new page setup dialog. + - the new `GtkPageSetupUnixDialog` + the new `GtkPageSetupUnixDialog` - the title of the dialog + the title of the dialog - transient parent of the dialog + transient parent of the dialog - Gets the currently selected page setup from the dialog. + Gets the currently selected page setup from the dialog. + - the current page setup + the current page setup - a `GtkPageSetupUnixDialog` + a `GtkPageSetupUnixDialog` - Gets the current print settings from the dialog. + Gets the current print settings from the dialog. + - the current print settings + the current print settings - a `GtkPageSetupUnixDialog` + a `GtkPageSetupUnixDialog` - Sets the `GtkPageSetup` from which the page setup + Sets the `GtkPageSetup` from which the page setup dialog takes its values. + - a `GtkPageSetupUnixDialog` + a `GtkPageSetupUnixDialog` - a `GtkPageSetup` + a `GtkPageSetup` - Sets the `GtkPrintSettings` from which the page setup dialog + Sets the `GtkPrintSettings` from which the page setup dialog takes its values. + - a `GtkPageSetupUnixDialog` + a `GtkPageSetupUnixDialog` - a `GtkPrintSettings` + a `GtkPrintSettings` - Describes the panning direction of a `GtkGesturePan` + Describes the panning direction of a `GtkGesturePan` - panned towards the left + panned towards the left - panned towards the right + panned towards the right - panned upwards + panned upwards - panned downwards + panned downwards - `GtkPaned` has two panes, arranged either horizontally or vertically. + `GtkPaned` has two panes, arranged either horizontally or vertically. ![An example GtkPaned](panes.png) @@ -58563,164 +61549,175 @@ gtk_widget_set_size_request (frame2, 50, -1); - Creates a new `GtkPaned` widget. + Creates a new `GtkPaned` widget. + - a new `GtkPaned`. + a new `GtkPaned`. - the paned’s orientation. + the paned’s orientation. - Retrieves the end child of the given `GtkPaned`. + Retrieves the end child of the given `GtkPaned`. See also: `GtkPaned`:end-child + - the end child widget + the end child widget - a `GtkPaned` + a `GtkPaned` - Obtains the position of the divider between the two panes. + Obtains the position of the divider between the two panes. + - position of the divider + position of the divider - a `GtkPaned` widget + a `GtkPaned` widget - Returns whether the end child can be resized. + Returns whether the end child can be resized. + - %TRUE if the end child is resizable + %TRUE if the end child is resizable - a `GtkPaned` + a `GtkPaned` - Returns whether the start child can be resized. + Returns whether the start child can be resized. + - %TRUE if the start child is resizable + %TRUE if the start child is resizable - a `GtkPaned` + a `GtkPaned` - Returns whether the end child can be shrunk. + Returns whether the end child can be shrunk. + - %TRUE if the end child is shrinkable + %TRUE if the end child is shrinkable - a `GtkPaned` + a `GtkPaned` - Returns whether the start child can be shrunk. + Returns whether the start child can be shrunk. + - %TRUE if the start child is shrinkable + %TRUE if the start child is shrinkable - a `GtkPaned` + a `GtkPaned` - Retrieves the start child of the given `GtkPaned`. + Retrieves the start child of the given `GtkPaned`. See also: `GtkPaned`:start-child + - the start child widget + the start child widget - a `GtkPaned` + a `GtkPaned` - Gets whether the separator should be wide. + Gets whether the separator should be wide. + - %TRUE if the paned should have a wide handle + %TRUE if the paned should have a wide handle - a `GtkPaned` + a `GtkPaned` - Sets the end child of @paned to @child. + Sets the end child of @paned to @child. + - a `GtkPaned` + a `GtkPaned` - the widget to add + the widget to add - Sets the position of the divider between the two panes. + Sets the position of the divider between the two panes. + - a `GtkPaned` widget + a `GtkPaned` widget - pixel position of divider, a negative value means that the position + pixel position of divider, a negative value means that the position is unset @@ -58728,102 +61725,108 @@ See also: `GtkPaned`:start-child - Sets the `GtkPaned`:resize-end-child property + Sets the `GtkPaned`:resize-end-child property + - a `GtkPaned` + a `GtkPaned` - %TRUE to let the end child be resized + %TRUE to let the end child be resized - Sets the `GtkPaned`:resize-start-child property + Sets the `GtkPaned`:resize-start-child property + - a `GtkPaned` + a `GtkPaned` - %TRUE to let the start child be resized + %TRUE to let the start child be resized - Sets the `GtkPaned`:shrink-end-child property + Sets the `GtkPaned`:shrink-end-child property + - a `GtkPaned` + a `GtkPaned` - %TRUE to let the end child be shrunk + %TRUE to let the end child be shrunk - Sets the `GtkPaned`:shrink-start-child property + Sets the `GtkPaned`:shrink-start-child property + - a `GtkPaned` + a `GtkPaned` - %TRUE to let the start child be shrunk + %TRUE to let the start child be shrunk - Sets the start child of @paned to @child. + Sets the start child of @paned to @child. + - a `GtkPaned` + a `GtkPaned` - the widget to add + the widget to add - Sets whether the separator should be wide. + Sets whether the separator should be wide. + - a `GtkPaned` + a `GtkPaned` - the new value for the [property@Gtk.Paned:wide-handle] property + the new value for the [property@Gtk.Paned:wide-handle] property @@ -58831,18 +61834,18 @@ See also: `GtkPaned`:start-child - The second child. + The second child. - The largest possible value for the position property. + The largest possible value for the position property. This property is derived from the size and shrinkability of the widget's children. - The smallest possible value for the position property. + The smallest possible value for the position property. This property is derived from the size and shrinkability of the widget's children. @@ -58851,58 +61854,58 @@ of the widget's children. - Position of the separator in pixels, from the left/top. + Position of the separator in pixels, from the left/top. - %TRUE if the `position` property has been set. + %TRUE if the `position` property has been set. - Determines whether the second child expands and shrinks + Determines whether the second child expands and shrinks along with the paned widget. - Determines whether the first child expands and shrinks + Determines whether the first child expands and shrinks along with the paned widget. - Determines whether the second child can be made smaller + Determines whether the second child can be made smaller than its requisition. - Determines whether the first child can be made smaller + Determines whether the first child can be made smaller than its requisition. - The first child. + The first child. - Whether the `GtkPaned` should provide a stronger visual separation. + Whether the `GtkPaned` should provide a stronger visual separation. For example, this could be set when a paned contains two [class@Gtk.Notebook]s, whose tab rows would otherwise merge visually. - Emitted to accept the current position of the handle when + Emitted to accept the current position of the handle when moving it using key bindings. This is a [keybinding signal](class.SignalAction.html). @@ -58913,7 +61916,7 @@ The default binding for this signal is Return or Space. - Emitted to cancel moving the position of the handle using key + Emitted to cancel moving the position of the handle using key bindings. The position of the handle will be reset to the value prior to @@ -58927,7 +61930,7 @@ The default binding for this signal is Escape. - Emitted to cycle the focus between the children of the paned. + Emitted to cycle the focus between the children of the paned. This is a [keybinding signal](class.SignalAction.html). @@ -58937,13 +61940,13 @@ The default binding is F6. - whether cycling backward or forward + whether cycling backward or forward - Emitted to cycle whether the paned should grab focus to allow + Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings. This is a [keybinding signal](class.SignalAction.html). @@ -58954,13 +61957,13 @@ The default binding for this signal is F8. - whether cycling backward or forward + whether cycling backward or forward - Emitted to move the handle with key bindings. + Emitted to move the handle with key bindings. This is a [keybinding signal](class.SignalAction.html). @@ -58968,13 +61971,13 @@ This is a [keybinding signal](class.SignalAction.html). - a `GtkScrollType` + a `GtkScrollType` - Emitted to accept the current position of the handle and then + Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain. This is a [keybinding signal](class.SignalAction.html). @@ -58986,7 +61989,7 @@ The default binding is Tab. - `GtkPaperSize` handles paper sizes. + `GtkPaperSize` handles paper sizes. It uses the standard called [PWG 5101.1-2002 PWG: Standard for Media Standardized Names](http://www.pwg.org/standards.html) @@ -58997,432 +62000,458 @@ construct custom paper sizes with arbitrary dimensions. The `GtkPaperSize` object stores not only the dimensions (width and height) of a paper size and its name, it also provides default print margins. + - Creates a new `GtkPaperSize` object by parsing a + Creates a new `GtkPaperSize` object by parsing a [PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf) paper name. If @name is %NULL, the default paper size is returned, see [func@Gtk.PaperSize.get_default]. + - a new `GtkPaperSize`, use [method@Gtk.PaperSize.free] + a new `GtkPaperSize`, use [method@Gtk.PaperSize.free] to free it - a paper size name + a paper size name - Creates a new `GtkPaperSize` object with the + Creates a new `GtkPaperSize` object with the given parameters. + - a new `GtkPaperSize` object, use [method@Gtk.PaperSize.free] + a new `GtkPaperSize` object, use [method@Gtk.PaperSize.free] to free it - the paper name + the paper name - the human-readable name + the human-readable name - the paper width, in units of @unit + the paper width, in units of @unit - the paper height, in units of @unit + the paper height, in units of @unit - the unit for @width and @height. not %GTK_UNIT_NONE. + the unit for @width and @height. not %GTK_UNIT_NONE. - Deserialize a paper size from a `GVariant`. + Deserialize a paper size from a `GVariant`. The `GVariant must be in the format produced by [method@Gtk.PaperSize.to_gvariant]. + - a new `GtkPaperSize` object + a new `GtkPaperSize` object - an a{sv} `GVariant` + an a{sv} `GVariant` - Creates a new `GtkPaperSize` object by using + Creates a new `GtkPaperSize` object by using IPP information. If @ipp_name is not a recognized paper name, @width and @height are used to construct a custom `GtkPaperSize` object. + - a new `GtkPaperSize`, use [method@Gtk.PaperSize.free] + a new `GtkPaperSize`, use [method@Gtk.PaperSize.free] to free it - an IPP paper name + an IPP paper name - the paper width, in points + the paper width, in points - the paper height in points + the paper height in points - Reads a paper size from the group @group_name in the key file + Reads a paper size from the group @group_name in the key file @key_file. + - a new `GtkPaperSize` object with the restored paper size + a new `GtkPaperSize` object with the restored paper size - the `GKeyFile` to retrieve the papersize from + the `GKeyFile` to retrieve the papersize from - the name of the group in the key file to read, + the name of the group in the key file to read, or %NULL to read the first group - Creates a new `GtkPaperSize` object by using + Creates a new `GtkPaperSize` object by using PPD information. If @ppd_name is not a recognized PPD paper name, @ppd_display_name, @width and @height are used to construct a custom `GtkPaperSize` object. + - a new `GtkPaperSize`, use [method@Gtk.PaperSize.free] + a new `GtkPaperSize`, use [method@Gtk.PaperSize.free] to free it - a PPD paper name + a PPD paper name - the corresponding human-readable name + the corresponding human-readable name - the paper width, in points + the paper width, in points - the paper height in points + the paper height in points - Copies an existing `GtkPaperSize`. + Copies an existing `GtkPaperSize`. + - a copy of @other + a copy of @other - a `GtkPaperSize` + a `GtkPaperSize` - Free the given `GtkPaperSize` object. + Free the given `GtkPaperSize` object. + - a `GtkPaperSize` + a `GtkPaperSize` - Gets the default bottom margin for the `GtkPaperSize`. + Gets the default bottom margin for the `GtkPaperSize`. + - the default bottom margin + the default bottom margin - a `GtkPaperSize` object + a `GtkPaperSize` object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Gets the default left margin for the `GtkPaperSize`. + Gets the default left margin for the `GtkPaperSize`. + - the default left margin + the default left margin - a `GtkPaperSize` object + a `GtkPaperSize` object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Gets the default right margin for the `GtkPaperSize`. + Gets the default right margin for the `GtkPaperSize`. + - the default right margin + the default right margin - a `GtkPaperSize` object + a `GtkPaperSize` object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Gets the default top margin for the `GtkPaperSize`. + Gets the default top margin for the `GtkPaperSize`. + - the default top margin + the default top margin - a `GtkPaperSize` object + a `GtkPaperSize` object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Gets the human-readable name of the `GtkPaperSize`. + Gets the human-readable name of the `GtkPaperSize`. + - the human-readable name of @size + the human-readable name of @size - a `GtkPaperSize` object + a `GtkPaperSize` object - Gets the paper height of the `GtkPaperSize`, in + Gets the paper height of the `GtkPaperSize`, in units of @unit. + - the paper height + the paper height - a `GtkPaperSize` object + a `GtkPaperSize` object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Gets the name of the `GtkPaperSize`. + Gets the name of the `GtkPaperSize`. + - the name of @size + the name of @size - a `GtkPaperSize` object + a `GtkPaperSize` object - Gets the PPD name of the `GtkPaperSize`, which + Gets the PPD name of the `GtkPaperSize`, which may be %NULL. + - the PPD name of @size + the PPD name of @size - a `GtkPaperSize` object + a `GtkPaperSize` object - Gets the paper width of the `GtkPaperSize`, in + Gets the paper width of the `GtkPaperSize`, in units of @unit. + - the paper width + the paper width - a `GtkPaperSize` object + a `GtkPaperSize` object - the unit for the return value, not %GTK_UNIT_NONE + the unit for the return value, not %GTK_UNIT_NONE - Returns %TRUE if @size is not a standard paper size. + Returns %TRUE if @size is not a standard paper size. + - whether @size is a custom paper size. + whether @size is a custom paper size. - a `GtkPaperSize` object + a `GtkPaperSize` object - Compares two `GtkPaperSize` objects. + Compares two `GtkPaperSize` objects. + - %TRUE, if @size1 and @size2 + %TRUE, if @size1 and @size2 represent the same paper size - a `GtkPaperSize` object + a `GtkPaperSize` object - another `GtkPaperSize` object + another `GtkPaperSize` object - Returns %TRUE if @size is an IPP standard paper size. + Returns %TRUE if @size is an IPP standard paper size. + - whether @size is not an IPP custom paper size. + whether @size is not an IPP custom paper size. - a `GtkPaperSize` object + a `GtkPaperSize` object - Changes the dimensions of a @size to @width x @height. + Changes the dimensions of a @size to @width x @height. + - a custom `GtkPaperSize` object + a custom `GtkPaperSize` object - the new width in units of @unit + the new width in units of @unit - the new height in units of @unit + the new height in units of @unit - the unit for @width and @height + the unit for @width and @height - Serialize a paper size to an `a{sv}` variant. + Serialize a paper size to an `a{sv}` variant. + - a new, floating, `GVariant` + a new, floating, `GVariant` - a `GtkPaperSize` + a `GtkPaperSize` - This function adds the paper size from @size to @key_file. + This function adds the paper size from @size to @key_file. + - a `GtkPaperSize` + a `GtkPaperSize` - the `GKeyFile` to save the paper size to + the `GKeyFile` to save the paper size to - the group to add the settings to in @key_file + the group to add the settings to in @key_file - Returns the name of the default paper size, which + Returns the name of the default paper size, which depends on the current locale. + - the name of the default paper size. The string + the name of the default paper size. The string is owned by GTK and should not be modified. - Creates a list of known paper sizes. + Creates a list of known paper sizes. + - a newly allocated list of newly + a newly allocated list of newly allocated `GtkPaperSize` objects @@ -59430,7 +62459,7 @@ is owned by GTK and should not be modified. - whether to include custom paper sizes + whether to include custom paper sizes as defined in the page setup dialog @@ -59438,13 +62467,13 @@ is owned by GTK and should not be modified. - A `GParamSpec` for properties holding a `GtkExpression`. + A `GParamSpec` for properties holding a `GtkExpression`. - `GtkPasswordEntry` is an entry that has been tailored for entering secrets. + `GtkPasswordEntry` is an entry that has been tailored for entering secrets. ![An example GtkPasswordEntry](password-entry.png) @@ -59476,108 +62505,114 @@ icon, and possibly other children. # Accessibility `GtkPasswordEntry` uses the %GTK_ACCESSIBLE_ROLE_TEXT_BOX role. + - Creates a `GtkPasswordEntry`. + Creates a `GtkPasswordEntry`. + - a new `GtkPasswordEntry` + a new `GtkPasswordEntry` - Gets the menu model set with gtk_password_entry_set_extra_menu(). + Gets the menu model set with gtk_password_entry_set_extra_menu(). + - (nullable): the menu model + (nullable): the menu model - a `GtkPasswordEntry` + a `GtkPasswordEntry` - Returns whether the entry is showing an icon to + Returns whether the entry is showing an icon to reveal the contents. + - %TRUE if an icon is shown + %TRUE if an icon is shown - a `GtkPasswordEntry` + a `GtkPasswordEntry` - Sets a menu model to add when constructing + Sets a menu model to add when constructing the context menu for @entry. + - a `GtkPasswordEntry` + a `GtkPasswordEntry` - a `GMenuModel` + a `GMenuModel` - Sets whether the entry should have a clickable icon + Sets whether the entry should have a clickable icon to reveal the contents. Setting this to %FALSE also hides the text again. + - a `GtkPasswordEntry` + a `GtkPasswordEntry` - whether to show the peek icon + whether to show the peek icon - Whether to activate the default widget when Enter is pressed. + Whether to activate the default widget when Enter is pressed. - A menu model whose contents will be appended to + A menu model whose contents will be appended to the context menu. - The text that will be displayed in the `GtkPasswordEntry` + The text that will be displayed in the `GtkPasswordEntry` when it is empty and unfocused. - Whether to show an icon for revealing the content. + Whether to show an icon for revealing the content. - Emitted when the entry is activated. + Emitted when the entry is activated. The keybindings for this signal are all forms of the Enter key. @@ -59586,38 +62621,43 @@ The keybindings for this signal are all forms of the Enter key. - A `GtkEntryBuffer` that locks the underlying memory to prevent it + A `GtkEntryBuffer` that locks the underlying memory to prevent it from being swapped to disk. `GtkPasswordEntry` uses a `GtkPasswordEntryBuffer`. + - Creates a new `GtkEntryBuffer` using secure memory allocations. + Creates a new `GtkEntryBuffer` using secure memory allocations. + - the newly created instance + the newly created instance + - + + + - Flags that influence the behavior of gtk_widget_pick(). + Flags that influence the behavior of gtk_widget_pick(). - The default behavior, include widgets that are receiving events + The default behavior, include widgets that are receiving events - Include widgets that are insensitive + Include widgets that are insensitive - Include widgets that are marked as non-targetable. See `GtkWidget:can-target` + Include widgets that are marked as non-targetable. See `GtkWidget:can-target` - The `GtkPicture` widget displays a `GdkPaintable`. + The `GtkPicture` widget displays a `GdkPaintable`. ![An example GtkPicture](picture.png) @@ -59663,18 +62703,20 @@ fill all available space but is instead displayed at its original size. ## Accessibility `GtkPicture` uses the `GTK_ACCESSIBLE_ROLE_IMG` role. + - Creates a new empty `GtkPicture` widget. + Creates a new empty `GtkPicture` widget. + - a newly created `GtkPicture` widget. + a newly created `GtkPicture` widget. - Creates a new `GtkPicture` displaying the given @file. + Creates a new `GtkPicture` displaying the given @file. If the file isn’t found or can’t be loaded, the resulting `GtkPicture` is empty. @@ -59682,184 +62724,195 @@ If the file isn’t found or can’t be loaded, the resulting If you need to detect failures to load the file, use [ctor@Gdk.Texture.new_from_file] to load the file yourself, then create the `GtkPicture` from the texture. + - a new `GtkPicture` + a new `GtkPicture` - a `GFile` + a `GFile` - Creates a new `GtkPicture` displaying the file @filename. + Creates a new `GtkPicture` displaying the file @filename. This is a utility function that calls [ctor@Gtk.Picture.new_for_file]. See that function for details. + - a new `GtkPicture` + a new `GtkPicture` - a filename + a filename - Creates a new `GtkPicture` displaying @paintable. + Creates a new `GtkPicture` displaying @paintable. The `GtkPicture` will track changes to the @paintable and update its size and contents in response to it. + - a new `GtkPicture` + a new `GtkPicture` - a `GdkPaintable` + a `GdkPaintable` - Creates a new `GtkPicture` displaying @pixbuf. + Creates a new `GtkPicture` displaying @pixbuf. This is a utility function that calls [ctor@Gtk.Picture.new_for_paintable], See that function for details. The pixbuf must not be modified after passing it to this function. + - a new `GtkPicture` + a new `GtkPicture` - a `GdkPixbuf` + a `GdkPixbuf` - Creates a new `GtkPicture` displaying the resource at @resource_path. + Creates a new `GtkPicture` displaying the resource at @resource_path. This is a utility function that calls [ctor@Gtk.Picture.new_for_file]. See that function for details. + - a new `GtkPicture` + a new `GtkPicture` - resource path to play back + resource path to play back - Gets the alternative textual description of the picture. + Gets the alternative textual description of the picture. The returned string will be %NULL if the picture cannot be described textually. + - the alternative textual description of @self. + the alternative textual description of @self. - a `GtkPicture` + a `GtkPicture` - Returns whether the `GtkPicture` respects its contents size. + Returns whether the `GtkPicture` respects its contents size. + - %TRUE if the picture can be made smaller than its contents + %TRUE if the picture can be made smaller than its contents - a `GtkPicture` + a `GtkPicture` - Gets the `GFile` currently displayed if @self is displaying a file. + Gets the `GFile` currently displayed if @self is displaying a file. If @self is not displaying a file, for example when [method@Gtk.Picture.set_paintable] was used, then %NULL is returned. + - The `GFile` displayed by @self. + The `GFile` displayed by @self. - a `GtkPicture` + a `GtkPicture` - Returns whether the `GtkPicture` preserves its contents aspect ratio. + Returns whether the `GtkPicture` preserves its contents aspect ratio. + - %TRUE if the self tries to keep the contents' aspect ratio + %TRUE if the self tries to keep the contents' aspect ratio - a `GtkPicture` + a `GtkPicture` - Gets the `GdkPaintable` being displayed by the `GtkPicture`. + Gets the `GdkPaintable` being displayed by the `GtkPicture`. + - the displayed paintable + the displayed paintable - a `GtkPicture` + a `GtkPicture` - Sets an alternative textual description for the picture contents. + Sets an alternative textual description for the picture contents. It is equivalent to the "alt" attribute for images on websites. This text will be made available to accessibility tools. If the picture cannot be described textually, set this property to %NULL. + - a `GtkPicture` + a `GtkPicture` - a textual description of the contents + a textual description of the contents - If set to %TRUE, the @self can be made smaller than its contents. + If set to %TRUE, the @self can be made smaller than its contents. The contents will then be scaled down when rendering. @@ -59869,60 +62922,63 @@ If you want to still force a minimum size manually, consider using Also of note is that a similar function for growing does not exist because the grow behavior can be controlled via [method@Gtk.Widget.set_halign] and [method@Gtk.Widget.set_valign]. + - a `GtkPicture` + a `GtkPicture` - if @self can be made smaller than its contents + if @self can be made smaller than its contents - Makes @self load and display @file. + Makes @self load and display @file. See [ctor@Gtk.Picture.new_for_file] for details. + - a `GtkPicture` + a `GtkPicture` - a `GFile` + a `GFile` - Makes @self load and display the given @filename. + Makes @self load and display the given @filename. This is a utility function that calls [method@Gtk.Picture.set_file]. + - a `GtkPicture` + a `GtkPicture` - the filename to play + the filename to play - If set to %TRUE, the @self will render its contents according to + If set to %TRUE, the @self will render its contents according to their aspect ratio. That means that empty space may show up at the top/bottom or @@ -59930,76 +62986,80 @@ left/right of @self. If set to %FALSE or if the contents provide no aspect ratio, the contents will be stretched over the picture's whole area. + - a `GtkPicture` + a `GtkPicture` - whether to keep aspect ratio + whether to keep aspect ratio - Makes @self display the given @paintable. + Makes @self display the given @paintable. If @paintable is %NULL, nothing will be displayed. See [ctor@Gtk.Picture.new_for_paintable] for details. + - a `GtkPicture` + a `GtkPicture` - a `GdkPaintable` + a `GdkPaintable` - Sets a `GtkPicture` to show a `GdkPixbuf`. + Sets a `GtkPicture` to show a `GdkPixbuf`. See [ctor@Gtk.Picture.new_for_pixbuf] for details. This is a utility function that calls [method@Gtk.Picture.set_paintable]. + - a `GtkPicture` + a `GtkPicture` - a `GdkPixbuf` + a `GdkPixbuf` - Makes @self load and display the resource at the given + Makes @self load and display the resource at the given @resource_path. This is a utility function that calls [method@Gtk.Picture.set_file]. + - a `GtkPicture` + a `GtkPicture` - the resource to set + the resource to set @@ -60007,63 +63067,64 @@ This is a utility function that calls [method@Gtk.Picture.set_file]. - The alternative textual description for the picture. + The alternative textual description for the picture. - If the `GtkPicture` can be made smaller than the natural size of its contents. + If the `GtkPicture` can be made smaller than the natural size of its contents. - The `GFile` that is displayed or %NULL if none. + The `GFile` that is displayed or %NULL if none. - Whether the GtkPicture will render its contents trying to preserve the aspect + Whether the GtkPicture will render its contents trying to preserve the aspect ratio. - The `GdkPaintable` to be displayed by this `GtkPicture`. + The `GdkPaintable` to be displayed by this `GtkPicture`. + - Determines how the size should be computed to achieve the one of the + Determines how the size should be computed to achieve the one of the visibility mode for the scrollbars. - The scrollbar is always visible. The view size is + The scrollbar is always visible. The view size is independent of the content. - The scrollbar will appear and disappear as necessary. + The scrollbar will appear and disappear as necessary. For example, when all of a `GtkTreeView` can not be seen. - The scrollbar should never appear. In this mode the + The scrollbar should never appear. In this mode the content determines the size. - Don't show a scrollbar, but don't force the + Don't show a scrollbar, but don't force the size to follow the content. This can be used e.g. to make multiple scrolled windows share a scrollbar. - `GtkPopover` is a bubble-like context popup. + `GtkPopover` is a bubble-like context popup. ![An example GtkPopover](popover.png) @@ -60139,19 +63200,22 @@ means that the border width of the content node and the arrow node should be the same. The arrow also does not support any border shape other than solid, no border-radius, only one border width (border-bottom-width is used) and no box-shadow. + - Creates a new `GtkPopover`. + Creates a new `GtkPopover`. + - the new `GtkPopover` + the new `GtkPopover` + @@ -60162,6 +63226,7 @@ used) and no box-shadow. + @@ -60173,178 +63238,189 @@ used) and no box-shadow. - Returns whether the popover is modal. + Returns whether the popover is modal. See [method@Gtk.Popover.set_autohide] for the implications of this. + - %TRUE if @popover is modal + %TRUE if @popover is modal - a `GtkPopover` + a `GtkPopover` - Returns whether the popover will close after a modal child is closed. + Returns whether the popover will close after a modal child is closed. + - %TRUE if @popover will close after a modal child. + %TRUE if @popover will close after a modal child. - a `GtkPopover` + a `GtkPopover` - Gets the child widget of @popover. + Gets the child widget of @popover. + - the child widget of @popover + the child widget of @popover - a `GtkPopover` + a `GtkPopover` - Gets whether this popover is showing an arrow + Gets whether this popover is showing an arrow pointing at the widget that it is relative to. + - whether the popover has an arrow + whether the popover has an arrow - a `GtkPopover` + a `GtkPopover` - Gets whether mnemonics are visible. + Gets whether mnemonics are visible. + - %TRUE if mnemonics are supposed to be visible + %TRUE if mnemonics are supposed to be visible in this popover - a `GtkPopover` + a `GtkPopover` - Gets the offset previous set with gtk_popover_set_offset(). + Gets the offset previous set with gtk_popover_set_offset(). + - a `GtkPopover` + a `GtkPopover` - a location for the x_offset + a location for the x_offset - a location for the y_offset + a location for the y_offset - Gets the rectangle that the popover points to. + Gets the rectangle that the popover points to. If a rectangle to point to has been set, this function will return %TRUE and fill in @rect with such rectangle, otherwise it will return %FALSE and fill in @rect with the parent widget coordinates. + - %TRUE if a rectangle to point to was set. + %TRUE if a rectangle to point to was set. - a `GtkPopover` + a `GtkPopover` - location to store the rectangle + location to store the rectangle - Returns the preferred position of @popover. + Returns the preferred position of @popover. + - The preferred position. + The preferred position. - a `GtkPopover` + a `GtkPopover` - Pops @popover down. + Pops @popover down. This may have the side-effect of closing a parent popover as well. See [property@Gtk.Popover:cascade-popdown]. + - a `GtkPopover` + a `GtkPopover` - Pops @popover up. + Pops @popover up. + - a `GtkPopover` + a `GtkPopover` - Presents the popover to the user. + Presents the popover to the user. + - a `GtkPopover` + a `GtkPopover` - Sets whether @popover is modal. + Sets whether @popover is modal. A modal popover will grab the keyboard focus on it when being displayed. Focus will wrap around within the popover. Clicking @@ -60353,74 +63429,78 @@ outside the popover area or pressing Esc will dismiss the popover. Called this function on an already showing popup with a new autohide value different from the current one, will cause the popup to be hidden. + - a `GtkPopover` + a `GtkPopover` - %TRUE to dismiss the popover on outside clicks + %TRUE to dismiss the popover on outside clicks - If @cascade_popdown is %TRUE, the popover will be + If @cascade_popdown is %TRUE, the popover will be closed when a child modal popover is closed. If %FALSE, @popover will stay visible. + - A `GtkPopover` + A `GtkPopover` - %TRUE if the popover should follow a child closing + %TRUE if the popover should follow a child closing - Sets the child widget of @popover. + Sets the child widget of @popover. + - a `GtkPopover` + a `GtkPopover` - the child widget + the child widget - Sets the default widget of a `GtkPopover`. + Sets the default widget of a `GtkPopover`. The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget for a `GtkPopover`. + - a `GtkPopover` + a `GtkPopover` - a child widget of @popover to set as + a child widget of @popover to set as the default, or %NULL to unset the default widget for the popover @@ -60428,85 +63508,89 @@ unsets the default widget for a `GtkPopover`. - Sets whether this popover should draw an arrow + Sets whether this popover should draw an arrow pointing at the widget it is relative to. + - a `GtkPopover` + a `GtkPopover` - %TRUE to draw an arrow + %TRUE to draw an arrow - Sets whether mnemonics should be visible. + Sets whether mnemonics should be visible. + - a `GtkPopover` + a `GtkPopover` - the new value + the new value - Sets the offset to use when calculating the position + Sets the offset to use when calculating the position of the popover. These values are used when preparing the [struct@Gdk.PopupLayout] for positioning the popover. + - a `GtkPopover` + a `GtkPopover` - the x offset to adjust the position by + the x offset to adjust the position by - the y offset to adjust the position by + the y offset to adjust the position by - Sets the rectangle that @popover points to. + Sets the rectangle that @popover points to. This is in the coordinate space of the @popover parent. + - a `GtkPopover` + a `GtkPopover` - rectangle to point to + rectangle to point to - Sets the preferred position for @popover to appear. + Sets the preferred position for @popover to appear. If the @popover is currently visible, it will be immediately updated. @@ -60514,16 +63598,17 @@ updated. This preference will be respected where possible, although on lack of space (eg. if close to the window edges), the `GtkPopover` may choose to appear on the opposite side. + - a `GtkPopover` + a `GtkPopover` - preferred popover position + preferred popover position @@ -60531,13 +63616,13 @@ on lack of space (eg. if close to the window edges), the - Whether to dismiss the popover on outside clicks. + Whether to dismiss the popover on outside clicks. - Whether the popover pops down after a child popover. + Whether the popover pops down after a child popover. This is used to implement the expected behavior of submenus. @@ -60545,43 +63630,43 @@ This is used to implement the expected behavior of submenus. - The child widget. + The child widget. - The default widget inside the popover. + The default widget inside the popover. - Whether to draw an arrow. + Whether to draw an arrow. - Whether mnemonics are currently visible in this popover. + Whether mnemonics are currently visible in this popover. - Rectangle in the parent widget that the popover points to. + Rectangle in the parent widget that the popover points to. - How to place the popover, relative to its parent. + How to place the popover, relative to its parent. - Emitted whend the user activates the default widget. + Emitted whend the user activates the default widget. This is a [keybinding signal](class.SignalAction.html). @@ -60589,18 +63674,20 @@ This is a [keybinding signal](class.SignalAction.html). - Emitted when the popover is closed. + Emitted when the popover is closed. + + @@ -60613,6 +63700,7 @@ This is a [keybinding signal](class.SignalAction.html). + @@ -60630,7 +63718,7 @@ This is a [keybinding signal](class.SignalAction.html). - `GtkPopoverMenu` is a subclass of `GtkPopover` that implements menu + `GtkPopoverMenu` is a subclass of `GtkPopover` that implements menu behavior. ![An example GtkPopoverMenu](menu.png) @@ -60737,7 +63825,7 @@ action they are connected to. - Creates a `GtkPopoverMenu` and populates it according to @model. + Creates a `GtkPopoverMenu` and populates it according to @model. The created buttons are connected to actions found in the `GtkApplicationWindow` to which the popover belongs - typically @@ -60750,19 +63838,20 @@ on the menus attach widget or on any of its parent widgets. This function creates menus with sliding submenus. See [ctor@Gtk.PopoverMenu.new_from_model_full] for a way to control this. + - the new `GtkPopoverMenu` + the new `GtkPopoverMenu` - a `GMenuModel` + a `GMenuModel` - Creates a `GtkPopoverMenu` and populates it according to @model. + Creates a `GtkPopoverMenu` and populates it according to @model. The created buttons are connected to actions found in the action groups that are accessible from the parent widget. @@ -60773,94 +63862,99 @@ on the parent widget or on any of its parent widgets. The only flag that is supported currently is %GTK_POPOVER_MENU_NESTED, which makes GTK create traditional, nested submenus instead of the default sliding submenus. + - the new `GtkPopoverMenu` + the new `GtkPopoverMenu` - a `GMenuModel` + a `GMenuModel` - flags that affect how the menu is created + flags that affect how the menu is created - Adds a custom widget to a generated menu. + Adds a custom widget to a generated menu. For this to work, the menu model of @popover must have an item with a `custom` attribute that matches @id. + - %TRUE if @id was found and the widget added + %TRUE if @id was found and the widget added - a `GtkPopoverMenu` + a `GtkPopoverMenu` - the `GtkWidget` to add + the `GtkWidget` to add - the ID to insert @child at + the ID to insert @child at - Returns the menu model used to populate the popover. + Returns the menu model used to populate the popover. + - the menu model of @popover + the menu model of @popover - a `GtkPopoverMenu` + a `GtkPopoverMenu` - Removes a widget that has previously been added with + Removes a widget that has previously been added with gtk_popover_menu_add_child(). + - %TRUE if the widget was removed + %TRUE if the widget was removed - a `GtkPopoverMenu` + a `GtkPopoverMenu` - the `GtkWidget` to remove + the `GtkWidget` to remove - Sets a new menu model on @popover. + Sets a new menu model on @popover. The existing contents of @popover are removed, and the @popover is populated with new contents according to @model. + - a `GtkPopoverMenu` + a `GtkPopoverMenu` - a `GMenuModel` + a `GMenuModel` @@ -60868,16 +63962,16 @@ to @model. - The model from which the menu is made. + The model from which the menu is made. - The name of the visible submenu. + The name of the visible submenu. - `GtkPopoverMenuBar` presents a horizontal bar of items that pop + `GtkPopoverMenuBar` presents a horizontal bar of items that pop up popover menus when clicked. ![An example GtkPopoverMenuBar](menubar.png) @@ -60910,88 +64004,93 @@ the menus use the %GTK_ACCESSIBLE_ROLE_MENU role. - Creates a `GtkPopoverMenuBar` from a `GMenuModel`. + Creates a `GtkPopoverMenuBar` from a `GMenuModel`. + - a new `GtkPopoverMenuBar` + a new `GtkPopoverMenuBar` - a `GMenuModel` + a `GMenuModel` - Adds a custom widget to a generated menubar. + Adds a custom widget to a generated menubar. For this to work, the menu model of @bar must have an item with a `custom` attribute that matches @id. + - %TRUE if @id was found and the widget added + %TRUE if @id was found and the widget added - a `GtkPopoverMenuBar` + a `GtkPopoverMenuBar` - the `GtkWidget` to add + the `GtkWidget` to add - the ID to insert @child at + the ID to insert @child at - Returns the model from which the contents of @bar are taken. + Returns the model from which the contents of @bar are taken. + - a `GMenuModel` + a `GMenuModel` - a `GtkPopoverMenuBar` + a `GtkPopoverMenuBar` - Removes a widget that has previously been added with + Removes a widget that has previously been added with gtk_popover_menu_bar_add_child(). + - %TRUE if the widget was removed + %TRUE if the widget was removed - a `GtkPopoverMenuBar` + a `GtkPopoverMenuBar` - the `GtkWidget` to remove + the `GtkWidget` to remove - Sets a menu model from which @bar should take + Sets a menu model from which @bar should take its contents. + - a `GtkPopoverMenuBar` + a `GtkPopoverMenuBar` - a `GMenuModel` + a `GMenuModel` @@ -60999,83 +64098,85 @@ its contents. - The `GMenuModel` from which the menu bar is created. + The `GMenuModel` from which the menu bar is created. The model should only contain submenus as toplevel elements. - Flags that affect how popover menus are created from + Flags that affect how popover menus are created from a menu model. - Create submenus as nested + Create submenus as nested popovers. Without this flag, submenus are created as sliding pages that replace the main menu. - Describes which edge of a widget a certain feature is positioned at. + Describes which edge of a widget a certain feature is positioned at. For examples, see the tabs of a `GtkNotebook`, or the label of a `GtkScale`. - The feature is at the left edge. + The feature is at the left edge. - The feature is at the right edge. + The feature is at the right edge. - The feature is at the top edge. + The feature is at the top edge. - The feature is at the bottom edge. + The feature is at the bottom edge. - + + + - Specifies which features the print dialog should offer. + Specifies which features the print dialog should offer. If neither %GTK_PRINT_CAPABILITY_GENERATE_PDF nor %GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK assumes that all formats are supported. - Print dialog will offer printing even/odd pages. + Print dialog will offer printing even/odd pages. - Print dialog will allow to print multiple copies. + Print dialog will allow to print multiple copies. - Print dialog will allow to collate multiple copies. + Print dialog will allow to collate multiple copies. - Print dialog will allow to print pages in reverse order. + Print dialog will allow to print pages in reverse order. - Print dialog will allow to scale the output. + Print dialog will allow to scale the output. - The program will send the document to + The program will send the document to the printer in PDF format - The program will send the document to + The program will send the document to the printer in Postscript format - Print dialog will offer a preview + Print dialog will offer a preview - Print dialog will offer printing multiple + Print dialog will offer printing multiple pages per sheet - Print dialog will allow to rearrange + Print dialog will allow to rearrange pages when printing multiple pages per sheet - A `GtkPrintContext` encapsulates context information that is required when + A `GtkPrintContext` encapsulates context information that is required when drawing pages for printing. This includes the cairo context and important parameters like page size @@ -61145,227 +64246,238 @@ draw_page (GtkPrintOperation *operation, } ``` - Creates a new `PangoContext` that can be used with the + Creates a new `PangoContext` that can be used with the `GtkPrintContext`. + - a new Pango context for @context + a new Pango context for @context - a `GtkPrintContext` + a `GtkPrintContext` - Creates a new `PangoLayout` that is suitable for use + Creates a new `PangoLayout` that is suitable for use with the `GtkPrintContext`. + - a new Pango layout for @context + a new Pango layout for @context - a `GtkPrintContext` + a `GtkPrintContext` - Obtains the cairo context that is associated with the + Obtains the cairo context that is associated with the `GtkPrintContext`. + - the cairo context of @context + the cairo context of @context - a `GtkPrintContext` + a `GtkPrintContext` - Obtains the horizontal resolution of the `GtkPrintContext`, + Obtains the horizontal resolution of the `GtkPrintContext`, in dots per inch. + - the horizontal resolution of @context + the horizontal resolution of @context - a `GtkPrintContext` + a `GtkPrintContext` - Obtains the vertical resolution of the `GtkPrintContext`, + Obtains the vertical resolution of the `GtkPrintContext`, in dots per inch. + - the vertical resolution of @context + the vertical resolution of @context - a `GtkPrintContext` + a `GtkPrintContext` - Obtains the hardware printer margins of the `GtkPrintContext`, + Obtains the hardware printer margins of the `GtkPrintContext`, in units. + - %TRUE if the hard margins were retrieved + %TRUE if the hard margins were retrieved - a `GtkPrintContext` + a `GtkPrintContext` - top hardware printer margin + top hardware printer margin - bottom hardware printer margin + bottom hardware printer margin - left hardware printer margin + left hardware printer margin - right hardware printer margin + right hardware printer margin - Obtains the height of the `GtkPrintContext`, in pixels. + Obtains the height of the `GtkPrintContext`, in pixels. + - the height of @context + the height of @context - a `GtkPrintContext` + a `GtkPrintContext` - Obtains the `GtkPageSetup` that determines the page + Obtains the `GtkPageSetup` that determines the page dimensions of the `GtkPrintContext`. + - the page setup of @context + the page setup of @context - a `GtkPrintContext` + a `GtkPrintContext` - Returns a `PangoFontMap` that is suitable for use + Returns a `PangoFontMap` that is suitable for use with the `GtkPrintContext`. + - the font map of @context + the font map of @context - a `GtkPrintContext` + a `GtkPrintContext` - Obtains the width of the `GtkPrintContext`, in pixels. + Obtains the width of the `GtkPrintContext`, in pixels. + - the width of @context + the width of @context - a `GtkPrintContext` + a `GtkPrintContext` - Sets a new cairo context on a print context. + Sets a new cairo context on a print context. This function is intended to be used when implementing an internal print preview, it is not needed for printing, since GTK itself creates a suitable cairo context in that case. + - a `GtkPrintContext` + a `GtkPrintContext` - the cairo context + the cairo context - the horizontal resolution to use with @cr + the horizontal resolution to use with @cr - the vertical resolution to use with @cr + the vertical resolution to use with @cr - See also gtk_print_settings_set_duplex(). + See also gtk_print_settings_set_duplex(). - No duplex. + No duplex. - Horizontal duplex. + Horizontal duplex. - Vertical duplex. + Vertical duplex. - Error codes that identify various errors that can occur while + Error codes that identify various errors that can occur while using the GTK printing support. - An unspecified error occurred. + An unspecified error occurred. - An internal error occurred. + An internal error occurred. - A memory allocation failed. + A memory allocation failed. - An error occurred while loading a page setup + An error occurred while loading a page setup or paper size from a key file. - Registers an error quark for `GtkPrintOperation` if necessary. + Registers an error quark for `GtkPrintOperation` if necessary. - The error quark used for `GtkPrintOperation` errors. + The error quark used for `GtkPrintOperation` errors. - A `GtkPrintJob` object represents a job that is sent to a printer. + A `GtkPrintJob` object represents a job that is sent to a printer. You only need to deal directly with print jobs if you use the non-portable [class@Gtk.PrintUnixDialog] API. @@ -61376,86 +64488,92 @@ to send the finished job to the printer. If you don’t use cairo `GtkPrintJob` also supports printing of manually generated PostScript, via [method@Gtk.PrintJob.set_source_file]. - Creates a new `GtkPrintJob`. + Creates a new `GtkPrintJob`. + - a new `GtkPrintJob` + a new `GtkPrintJob` - the job title + the job title - a `GtkPrinter` + a `GtkPrinter` - a `GtkPrintSettings` + a `GtkPrintSettings` - a `GtkPageSetup` + a `GtkPageSetup` - Gets whether this job is printed collated. + Gets whether this job is printed collated. + - whether the job is printed collated + whether the job is printed collated - a `GtkPrintJob` + a `GtkPrintJob` - Gets the n-up setting for this job. + Gets the n-up setting for this job. + - the n-up setting + the n-up setting - a `GtkPrintJob` + a `GtkPrintJob` - Gets the n-up layout setting for this job. + Gets the n-up layout setting for this job. + - the n-up layout + the n-up layout - a `GtkPrintJob` + a `GtkPrintJob` - Gets the number of copies of this job. + Gets the number of copies of this job. + - the number of copies + the number of copies - a `GtkPrintJob` + a `GtkPrintJob` - Gets the page ranges for this job. + Gets the page ranges for this job. + - a pointer to an + a pointer to an array of `GtkPageRange` structs @@ -61463,360 +64581,382 @@ via [method@Gtk.PrintJob.set_source_file]. - a `GtkPrintJob` + a `GtkPrintJob` - return location for the number of ranges + return location for the number of ranges - Gets the `GtkPageSet` setting for this job. + Gets the `GtkPageSet` setting for this job. + - the `GtkPageSet` setting + the `GtkPageSet` setting - a `GtkPrintJob` + a `GtkPrintJob` - Gets the `GtkPrintPages` setting for this job. + Gets the `GtkPrintPages` setting for this job. + - the `GtkPrintPages` setting + the `GtkPrintPages` setting - a `GtkPrintJob` + a `GtkPrintJob` - Gets the `GtkPrinter` of the print job. + Gets the `GtkPrinter` of the print job. + - the printer of @job + the printer of @job - a `GtkPrintJob` + a `GtkPrintJob` - Gets whether this job is printed reversed. + Gets whether this job is printed reversed. + - whether the job is printed reversed. + whether the job is printed reversed. - a `GtkPrintJob` + a `GtkPrintJob` - Gets whether the job is printed rotated. + Gets whether the job is printed rotated. + - whether the job is printed rotated + whether the job is printed rotated - a `GtkPrintJob` + a `GtkPrintJob` - Gets the scale for this job. + Gets the scale for this job. + - the scale + the scale - a `GtkPrintJob` + a `GtkPrintJob` - Gets the `GtkPrintSettings` of the print job. + Gets the `GtkPrintSettings` of the print job. + - the settings of @job + the settings of @job - a `GtkPrintJob` + a `GtkPrintJob` - Gets the status of the print job. + Gets the status of the print job. + - the status of @job + the status of @job - a `GtkPrintJob` + a `GtkPrintJob` - Gets a cairo surface onto which the pages of + Gets a cairo surface onto which the pages of the print job should be rendered. + - the cairo surface of @job + the cairo surface of @job - a `GtkPrintJob` + a `GtkPrintJob` - Gets the job title. + Gets the job title. + - the title of @job + the title of @job - a `GtkPrintJob` + a `GtkPrintJob` - Returns whether jobs will be tracked after printing. + Returns whether jobs will be tracked after printing. For details, see [method@Gtk.PrintJob.set_track_print_status]. + - %TRUE if print job status will be reported after printing + %TRUE if print job status will be reported after printing - a `GtkPrintJob` + a `GtkPrintJob` - Sends the print job off to the printer. + Sends the print job off to the printer. + - a `GtkPrintJob` + a `GtkPrintJob` - function to call when the job completes or an error occurs + function to call when the job completes or an error occurs - user data that gets passed to @callback + user data that gets passed to @callback - destroy notify for @user_data + destroy notify for @user_data - Sets whether this job is printed collated. + Sets whether this job is printed collated. + - a `GtkPrintJob` + a `GtkPrintJob` - whether the job is printed collated + whether the job is printed collated - Sets the n-up setting for this job. + Sets the n-up setting for this job. + - a `GtkPrintJob` + a `GtkPrintJob` - the n-up value + the n-up value - Sets the n-up layout setting for this job. + Sets the n-up layout setting for this job. + - a `GtkPrintJob` + a `GtkPrintJob` - the n-up layout setting + the n-up layout setting - Sets the number of copies for this job. + Sets the number of copies for this job. + - a `GtkPrintJob` + a `GtkPrintJob` - the number of copies + the number of copies - Sets the page ranges for this job. + Sets the page ranges for this job. + - a `GtkPrintJob` + a `GtkPrintJob` - pointer to an array of + pointer to an array of `GtkPageRange` structs - the length of the @ranges array + the length of the @ranges array - Sets the `GtkPageSet` setting for this job. + Sets the `GtkPageSet` setting for this job. + - a `GtkPrintJob` + a `GtkPrintJob` - a `GtkPageSet` setting + a `GtkPageSet` setting - Sets the `GtkPrintPages` setting for this job. + Sets the `GtkPrintPages` setting for this job. + - a `GtkPrintJob` + a `GtkPrintJob` - the `GtkPrintPages` setting + the `GtkPrintPages` setting - Sets whether this job is printed reversed. + Sets whether this job is printed reversed. + - a `GtkPrintJob` + a `GtkPrintJob` - whether the job is printed reversed + whether the job is printed reversed - Sets whether this job is printed rotated. + Sets whether this job is printed rotated. + - a `GtkPrintJob` + a `GtkPrintJob` - whether to print rotated + whether to print rotated - Sets the scale for this job. + Sets the scale for this job. 1.0 means unscaled. + - a `GtkPrintJob` + a `GtkPrintJob` - the scale + the scale - Make the `GtkPrintJob` send an existing document to the + Make the `GtkPrintJob` send an existing document to the printing system. The file can be in any format understood by the platforms @@ -61827,47 +64967,49 @@ PDF may work too). See [method@Gtk.Printer.accepts_pdf] and This is similar to [method@Gtk.PrintJob.set_source_file], but takes expects an open file descriptor for the file, instead of a filename. + - %FALSE if an error occurred + %FALSE if an error occurred - a `GtkPrintJob` + a `GtkPrintJob` - a file descriptor + a file descriptor - Make the `GtkPrintJob` send an existing document to the + Make the `GtkPrintJob` send an existing document to the printing system. The file can be in any format understood by the platforms printing system (typically PostScript, but on many platforms PDF may work too). See [method@Gtk.Printer.accepts_pdf] and [method@Gtk.Printer.accepts_ps]. + - %FALSE if an error occurred + %FALSE if an error occurred - a `GtkPrintJob` + a `GtkPrintJob` - the file to be printed + the file to be printed - If track_status is %TRUE, the print job will try to continue report + If track_status is %TRUE, the print job will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like “out of paper” @@ -61875,48 +65017,49 @@ issues, and when the print job actually reaches the printer. This function is often implemented using some form of polling, so it should not be enabled unless needed. + - a `GtkPrintJob` + a `GtkPrintJob` - %TRUE to track status after printing + %TRUE to track status after printing - Page setup. + Page setup. - The printer to send the job to. + The printer to send the job to. - Printer settings. + Printer settings. - The title of the print job. + The title of the print job. - %TRUE if the print job will continue to emit status-changed + %TRUE if the print job will continue to emit status-changed signals after the print data has been setn to the printer. - Emitted when the status of a job changes. + Emitted when the status of a job changes. The signal handler can use [method@Gtk.PrintJob.get_status] to obtain the new status. @@ -61926,30 +65069,31 @@ to obtain the new status. - The type of callback that is passed to gtk_print_job_send(). + The type of callback that is passed to gtk_print_job_send(). It is called when the print job has been completely sent. + - the `GtkPrintJob` + the `GtkPrintJob` - user data that has been passed to gtk_print_job_send() + user data that has been passed to gtk_print_job_send() - a `GError` that contains error information if the sending + a `GError` that contains error information if the sending of the print job failed, otherwise %NULL - `GtkPrintOperation` is the high-level, portable printing API. + `GtkPrintOperation` is the high-level, portable printing API. It looks a bit different than other GTK dialogs such as the `GtkFileChooser`, since some platforms don’t expose enough @@ -62011,15 +65155,18 @@ must connect to the preview signal. The functions [method@Gtk.PrintOperationPreview.end_preview] and [method@Gtk.PrintOperationPreview.is_selected] are useful when implementing a print preview. + - Creates a new `GtkPrintOperation`. + Creates a new `GtkPrintOperation`. + - a new `GtkPrintOperation` + a new `GtkPrintOperation` + @@ -62033,6 +65180,7 @@ are useful when implementing a print preview. + @@ -62043,6 +65191,7 @@ are useful when implementing a print preview. + @@ -62056,6 +65205,7 @@ are useful when implementing a print preview. + @@ -62069,6 +65219,7 @@ are useful when implementing a print preview. + @@ -62085,6 +65236,7 @@ are useful when implementing a print preview. + @@ -62098,6 +65250,7 @@ are useful when implementing a print preview. + @@ -62111,6 +65264,7 @@ are useful when implementing a print preview. + @@ -62130,6 +65284,7 @@ are useful when implementing a print preview. + @@ -62149,6 +65304,7 @@ are useful when implementing a print preview. + @@ -62159,6 +65315,7 @@ are useful when implementing a print preview. + @@ -62178,68 +65335,72 @@ are useful when implementing a print preview. - Cancels a running print operation. + Cancels a running print operation. This function may be called from a [signal@Gtk.PrintOperation::begin-print], [signal@Gtk.PrintOperation::paginate] or [signal@Gtk.PrintOperation::draw-page] signal handler to stop the currently running print operation. + - a `GtkPrintOperation` + a `GtkPrintOperation` - Signal that drawing of particular page is complete. + Signal that drawing of particular page is complete. It is called after completion of page drawing (e.g. drawing in another thread). If [method@Gtk.PrintOperation.set_defer_drawing] was called before, then this function has to be called by application. Otherwise it is called by GTK itself. + - a `GtkPrintOperation` + a `GtkPrintOperation` - Returns the default page setup. + Returns the default page setup. + - the default page setup + the default page setup - a `GtkPrintOperation` + a `GtkPrintOperation` - Gets whether page setup selection combos are embedded + Gets whether page setup selection combos are embedded + - whether page setup selection combos are embedded + whether page setup selection combos are embedded - a `GtkPrintOperation` + a `GtkPrintOperation` - Call this when the result of a print operation is + Call this when the result of a print operation is %GTK_PRINT_OPERATION_RESULT_ERROR. It can be called either after [method@Gtk.PrintOperation.run] @@ -62247,33 +65408,35 @@ returns, or in the [signal@Gtk.PrintOperation::done] signal handler. The returned `GError` will contain more details on what went wrong. + - a `GtkPrintOperation` + a `GtkPrintOperation` - Gets whether there is a selection. + Gets whether there is a selection. + - whether there is a selection + whether there is a selection - a `GtkPrintOperation` + a `GtkPrintOperation` - Returns the number of pages that will be printed. + Returns the number of pages that will be printed. Note that this value is set during print preparation phase (%GTK_PRINT_STATUS_PREPARING), so this function should never be @@ -62283,54 +65446,57 @@ signal and call gtk_print_operation_get_n_pages_to_print() when print status is %GTK_PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation. + - the number of pages that will be printed + the number of pages that will be printed - a `GtkPrintOperation` + a `GtkPrintOperation` - Returns the current print settings. + Returns the current print settings. Note that the return value is %NULL until either [method@Gtk.PrintOperation.set_print_settings] or [method@Gtk.PrintOperation.run] have been called. + - the current print settings of @op. + the current print settings of @op. - a `GtkPrintOperation` + a `GtkPrintOperation` - Returns the status of the print operation. + Returns the status of the print operation. Also see [method@Gtk.PrintOperation.get_status_string]. + - the status of the print operation + the status of the print operation - a `GtkPrintOperation` + a `GtkPrintOperation` - Returns a string representation of the status of the + Returns a string representation of the status of the print operation. The string is translated and suitable for displaying @@ -62338,34 +65504,36 @@ the print status e.g. in a `GtkStatusbar`. Use [method@Gtk.PrintOperation.get_status] to obtain a status value that is suitable for programmatic use. + - a string representation of the status + a string representation of the status of the print operation - a `GtkPrintOperation` + a `GtkPrintOperation` - Gets whether the application supports print of selection + Gets whether the application supports print of selection + - whether the application supports print of selection + whether the application supports print of selection - a `GtkPrintOperation` + a `GtkPrintOperation` - A convenience function to find out if the print operation + A convenience function to find out if the print operation is finished. a print operation is finished if its status is either @@ -62374,19 +65542,20 @@ a print operation is finished if its status is either Note: when you enable print status tracking the print operation can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer. + - %TRUE, if the print operation is finished. + %TRUE, if the print operation is finished. - a `GtkPrintOperation` + a `GtkPrintOperation` - Runs the print operation. + Runs the print operation. Normally that this function does not return until the rendering of all pages is complete. You can connect to the @@ -62441,8 +65610,9 @@ g_object_unref (settings); Note that gtk_print_operation_run() can only be called once on a given `GtkPrintOperation`. + - the result of the print operation. A return value of + the result of the print operation. A return value of %GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was completed successfully. In this case, it is a good idea to obtain the used print settings with @@ -62455,140 +65625,146 @@ given `GtkPrintOperation`. - a `GtkPrintOperation` + a `GtkPrintOperation` - the action to start + the action to start - Transient parent of the dialog + Transient parent of the dialog - Sets whether gtk_print_operation_run() may return + Sets whether gtk_print_operation_run() may return before the print operation is completed. Note that some platforms may not allow asynchronous operation. + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE to allow asynchronous operation + %TRUE to allow asynchronous operation - Sets the current page. + Sets the current page. If this is called before [method@Gtk.PrintOperation.run], the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents. + - a `GtkPrintOperation` + a `GtkPrintOperation` - the current page, 0-based + the current page, 0-based - Sets the label for the tab holding custom widgets. + Sets the label for the tab holding custom widgets. + - a `GtkPrintOperation` + a `GtkPrintOperation` - the label to use, or %NULL to use the default label + the label to use, or %NULL to use the default label - Makes @default_page_setup the default page setup for @op. + Makes @default_page_setup the default page setup for @op. This page setup will be used by [method@Gtk.PrintOperation.run], but it can be overridden on a per-page basis by connecting to the [signal@Gtk.PrintOperation::request-page-setup] signal. + - a `GtkPrintOperation` + a `GtkPrintOperation` - a `GtkPageSetup` + a `GtkPageSetup` - Sets up the `GtkPrintOperation` to wait for calling of + Sets up the `GtkPrintOperation` to wait for calling of [method@Gtk.PrintOperation.draw_page_finish from application. This can be used for drawing page in another thread. This function must be called in the callback of the [signal@Gtk.PrintOperation::draw-page] signal. + - a `GtkPrintOperation` + a `GtkPrintOperation` - Embed page size combo box and orientation combo box into page setup page. + Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in `GtkPrintOperation`. + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE to embed page setup selection in the `GtkPrintUnixDialog` + %TRUE to embed page setup selection in the `GtkPrintUnixDialog` - Sets up the `GtkPrintOperation` to generate a file instead + Sets up the `GtkPrintOperation` to generate a file instead of showing the print dialog. The intended use of this function is for implementing @@ -62598,67 +65774,70 @@ format. “Print to PDF” support is independent of this and is done by letting the user pick the “Print to PDF” item from the list of printers in the print dialog. + - a `GtkPrintOperation` + a `GtkPrintOperation` - the filename for the exported file + the filename for the exported file - Sets whether there is a selection to print. + Sets whether there is a selection to print. Application has to set number of pages to which the selection will draw by [method@Gtk.PrintOperation.set_n_pages] in a handler for the [signal@Gtk.PrintOperation::begin-print] signal. + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE indicates that a selection exists + %TRUE indicates that a selection exists - Sets the name of the print job. + Sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups). If you don’t set a job name, GTK picks a default one by numbering successive print jobs. + - a `GtkPrintOperation` + a `GtkPrintOperation` - a string that identifies the print job + a string that identifies the print job - Sets the number of pages in the document. + Sets the number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a [signal@Gtk.PrintOperation::begin-print] @@ -62669,78 +65848,82 @@ Note that the page numbers passed to the and [signal@Gtk.PrintOperation::draw-page] signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page @n_pages - 1. + - a `GtkPrintOperation` + a `GtkPrintOperation` - the number of pages + the number of pages - Sets the print settings for @op. + Sets the print settings for @op. This is typically used to re-establish print settings from a previous print operation, see [method@Gtk.PrintOperation.run]. + - a `GtkPrintOperation` + a `GtkPrintOperation` - `GtkPrintSettings` + `GtkPrintSettings` - If @show_progress is %TRUE, the print operation will show + If @show_progress is %TRUE, the print operation will show a progress dialog during the print operation. + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE to show a progress dialog + %TRUE to show a progress dialog - Sets whether selection is supported by `GtkPrintOperation`. + Sets whether selection is supported by `GtkPrintOperation`. + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE to support selection + %TRUE to support selection - If track_status is %TRUE, the print operation will try to continue + If track_status is %TRUE, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like “out of paper” @@ -62748,65 +65931,68 @@ issues, and when the print job actually reaches the printer. This function is often implemented using some form of polling, so it should not be enabled unless needed. + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE to track status after printing + %TRUE to track status after printing - Sets up the transformation for the cairo context obtained from + Sets up the transformation for the cairo context obtained from `GtkPrintContext` in such a way that distances are measured in units of @unit. + - a `GtkPrintOperation` + a `GtkPrintOperation` - the unit to use + the unit to use - If @full_page is %TRUE, the transformation for the cairo context + If @full_page is %TRUE, the transformation for the cairo context obtained from `GtkPrintContext` puts the origin at the top left corner of the page. This may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins). + - a `GtkPrintOperation` + a `GtkPrintOperation` - %TRUE to set up the `GtkPrintContext` for the full page + %TRUE to set up the `GtkPrintContext` for the full page - Determines whether the print operation may run asynchronously or not. + Determines whether the print operation may run asynchronously or not. Some systems don't support asynchronous printing, but those that do will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and @@ -62820,7 +66006,7 @@ is unlikely to change). On other platforms, all actions except for - The current page in the document. + The current page in the document. If this is set before [method@Gtk.PrintOperation.run], the user will be able to select to print only the current page. @@ -62830,7 +66016,7 @@ Note that this only makes sense for pre-paginated documents. - Used as the label of the tab containing custom widgets. + Used as the label of the tab containing custom widgets. Note that this property may be ignored on some platforms. @@ -62840,7 +66026,7 @@ If this is %NULL, GTK uses a default label. - The `GtkPageSetup` used by default. + The `GtkPageSetup` used by default. This page setup will be used by [method@Gtk.PrintOperation.run], but it can be overridden on a per-page basis by connecting @@ -62850,13 +66036,13 @@ to the [signal@Gtk.PrintOperation::request-page-setup] signal. - If %TRUE, page size combo box and orientation combo box + If %TRUE, page size combo box and orientation combo box are embedded into page setup page. - The name of a file to generate instead of showing the print dialog. + The name of a file to generate instead of showing the print dialog. Currently, PDF is the only supported format. @@ -62871,7 +66057,7 @@ list of printers in the print dialog. - Determines whether there is a selection in your application. + Determines whether there is a selection in your application. This can allow your application to print the selection. This is typically used to make a "Selection" button sensitive. @@ -62879,7 +66065,7 @@ This is typically used to make a "Selection" button sensitive. - A string used to identify the job (e.g. in monitoring + A string used to identify the job (e.g. in monitoring applications like eggcups). If you don't set a job name, GTK picks a default one @@ -62888,7 +66074,7 @@ by numbering successive print jobs. - The number of pages in the document. + The number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a [signal@Gtk.PrintOperation::begin-print] @@ -62903,7 +66089,7 @@ will be for page @n_pages - 1. - The number of pages that will be printed. + The number of pages that will be printed. Note that this value is set during print preparation phase (%GTK_PRINT_STATUS_PREPARING), so this value should never be @@ -62918,7 +66104,7 @@ This is typically used to track the progress of print operation. - The `GtkPrintSettings` used for initializing the dialog. + The `GtkPrintSettings` used for initializing the dialog. Setting this property is typically used to re-establish print settings from a previous print operation, see @@ -62927,18 +66113,18 @@ print settings from a previous print operation, see - Determines whether to show a progress dialog during the + Determines whether to show a progress dialog during the print operation. - The status of the print operation. + The status of the print operation. - A string representation of the status of the print operation. + A string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a `GtkStatusbar`. @@ -62950,14 +66136,14 @@ value that is suitable for programmatic use. - If %TRUE, the print operation will support print of selection. + If %TRUE, the print operation will support print of selection. This allows the print dialog to show a "Selection" button. - If %TRUE, the print operation will try to continue report on + If %TRUE, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like “out of paper” @@ -62968,14 +66154,14 @@ not be enabled unless needed. - The transformation for the cairo context obtained from + The transformation for the cairo context obtained from `GtkPrintContext` is set up in such a way that distances are measured in units of @unit. - If %TRUE, the transformation for the cairo context obtained + If %TRUE, the transformation for the cairo context obtained from `GtkPrintContext` puts the origin at the top left corner of the page. @@ -62992,7 +66178,7 @@ inside the margins). - Emitted after the user has finished changing print settings + Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts. A typical use for ::begin-print is to use the parameters from the @@ -63004,13 +66190,13 @@ and then set the number of pages with - the `GtkPrintContext` for the current operation + the `GtkPrintContext` for the current operation - Emitted when displaying the print dialog. + Emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a @@ -63022,13 +66208,13 @@ to stay around until the [signal@Gtk.PrintOperation::custom-widget-apply] signal is emitted on the operation. Then you can read out any information you need from the widgets. - A custom widget that gets embedded in + A custom widget that gets embedded in the print dialog - Emitted right before ::begin-print if you added + Emitted right before ::begin-print if you added a custom widget in the ::create-custom-widget handler. When you get this signal you should read the information from the @@ -63039,13 +66225,13 @@ later time. - the custom widget added in ::create-custom-widget + the custom widget added in ::create-custom-widget - Emitted when the print operation run has finished doing + Emitted when the print operation run has finished doing everything required for printing. @result gives you information about what happened during the run. @@ -63060,13 +66246,13 @@ after the ::done signal was emitted. - the result of the print operation + the result of the print operation - Emitted for every page that is printed. + Emitted for every page that is printed. The signal handler must render the @page_nr's page onto the cairo context obtained from @context using @@ -63122,17 +66308,17 @@ according to your needs. - the `GtkPrintContext` for the current operation + the `GtkPrintContext` for the current operation - the number of the currently printed page (0-based) + the number of the currently printed page (0-based) - Emitted after all pages have been rendered. + Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the [signal@Gtk.PrintOperation::begin-print] handler. @@ -63141,13 +66327,13 @@ been allocated in the [signal@Gtk.PrintOperation::begin-print] handler. - the `GtkPrintContext` for the current operation + the `GtkPrintContext` for the current operation - Emitted after the ::begin-print signal, but before the actual rendering + Emitted after the ::begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns %TRUE. @@ -63162,18 +66348,18 @@ If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there. - %TRUE if pagination is complete + %TRUE if pagination is complete - the `GtkPrintContext` for the current operation + the `GtkPrintContext` for the current operation - Gets emitted when a preview is requested from the native dialog. + Gets emitted when a preview is requested from the native dialog. The default handler for this signal uses an external viewer application to preview. @@ -63191,26 +66377,26 @@ are selected for print and render them. The preview must be finished by calling [method@Gtk.PrintOperationPreview.end_preview] (typically in response to the user clicking a close button). - %TRUE if the listener wants to take over control of the preview + %TRUE if the listener wants to take over control of the preview - the `GtkPrintOperationPreview` for the current operation + the `GtkPrintOperationPreview` for the current operation - the `GtkPrintContext` that will be used + the `GtkPrintContext` that will be used - the `GtkWindow` to use as window parent + the `GtkWindow` to use as window parent - Emitted once for every page that is printed. + Emitted once for every page that is printed. This gives the application a chance to modify the page setup. Any changes done to @setup will be in force only for printing @@ -63220,21 +66406,21 @@ this page. - the `GtkPrintContext` for the current operation + the `GtkPrintContext` for the current operation - the number of the currently printed page (0-based) + the number of the currently printed page (0-based) - the `GtkPageSetup` + the `GtkPageSetup` - Emitted at between the various phases of the print operation. + Emitted at between the various phases of the print operation. See [enum@Gtk.PrintStatus] for the phases that are being discriminated. Use [method@Gtk.PrintOperation.get_status] to find out the current @@ -63244,7 +66430,7 @@ status. - Emitted after change of selected printer. + Emitted after change of selected printer. The actual page setup and print settings are passed to the custom widget, which can actualize itself according to this change. @@ -63253,46 +66439,48 @@ widget, which can actualize itself according to this change. - the custom widget added in ::create-custom-widget + the custom widget added in ::create-custom-widget - actual page setup + actual page setup - actual print settings + actual print settings - Determines what action the print operation should perform. + Determines what action the print operation should perform. A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. - Show the print dialog. + Show the print dialog. - Start to print without showing + Start to print without showing the print dialog, based on the current print settings. - Show the print preview. + Show the print preview. - Export to a file. This requires + Export to a file. This requires the export-filename property to be set. + - The parent class. + The parent class. + @@ -63308,6 +66496,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63323,6 +66512,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63338,6 +66528,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63359,6 +66550,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63377,6 +66569,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63392,6 +66585,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63404,6 +66598,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63416,6 +66611,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63431,6 +66627,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63452,6 +66649,7 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. + @@ -63478,27 +66676,30 @@ A parameter of this typs is passed to [method@Gtk.PrintOperation.run]. - `GtkPrintOperationPreview` is the interface that is used to + `GtkPrintOperationPreview` is the interface that is used to implement print preview. A `GtkPrintOperationPreview` object is passed to the [signal@Gtk.PrintOperation::preview] signal by [class@Gtk.PrintOperation]. + - Ends a preview. + Ends a preview. This function must be called to finish a custom print preview. + - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` + @@ -63515,24 +66716,26 @@ This function must be called to finish a custom print preview. - Returns whether the given page is included in the set of pages that + Returns whether the given page is included in the set of pages that have been selected for printing. + - %TRUE if the page has been selected for printing + %TRUE if the page has been selected for printing - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - a page number + a page number + @@ -63546,7 +66749,7 @@ have been selected for printing. - Renders a page to the preview. + Renders a page to the preview. This is using the print context that was passed to the [signal@Gtk.PrintOperation::preview] handler together @@ -63557,54 +66760,57 @@ the currently selected page. Note that this function requires a suitable cairo context to be associated with the print context. + - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - the page to render + the page to render - Ends a preview. + Ends a preview. This function must be called to finish a custom print preview. + - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - Returns whether the given page is included in the set of pages that + Returns whether the given page is included in the set of pages that have been selected for printing. + - %TRUE if the page has been selected for printing + %TRUE if the page has been selected for printing - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - a page number + a page number - Renders a page to the preview. + Renders a page to the preview. This is using the print context that was passed to the [signal@Gtk.PrintOperation::preview] handler together @@ -63615,22 +66821,23 @@ the currently selected page. Note that this function requires a suitable cairo context to be associated with the print context. + - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - the page to render + the page to render - Emitted once for each page that gets rendered to the preview. + Emitted once for each page that gets rendered to the preview. A handler for this signal should update the @context according to @page_setup and set up a suitable cairo @@ -63640,17 +66847,17 @@ context, using [method@Gtk.PrintContext.set_cairo_context]. - the current `GtkPrintContext` + the current `GtkPrintContext` - the `GtkPageSetup` for the current page + the `GtkPageSetup` for the current page - The ::ready signal gets emitted once per preview operation, + The ::ready signal gets emitted once per preview operation, before the first page is rendered. A handler for this signal can be used for setup tasks. @@ -63659,18 +66866,20 @@ A handler for this signal can be used for setup tasks. - the current `GtkPrintContext` + the current `GtkPrintContext` + + @@ -63686,6 +66895,7 @@ A handler for this signal can be used for setup tasks. + @@ -63704,16 +66914,17 @@ A handler for this signal can be used for setup tasks. + - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - the page to render + the page to render @@ -63721,17 +66932,18 @@ A handler for this signal can be used for setup tasks. + - %TRUE if the page has been selected for printing + %TRUE if the page has been selected for printing - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` - a page number + a page number @@ -63739,12 +66951,13 @@ A handler for this signal can be used for setup tasks. + - a `GtkPrintOperationPreview` + a `GtkPrintOperationPreview` @@ -63752,6 +66965,7 @@ A handler for this signal can be used for setup tasks. + @@ -63759,6 +66973,7 @@ A handler for this signal can be used for setup tasks. + @@ -63766,6 +66981,7 @@ A handler for this signal can be used for setup tasks. + @@ -63773,6 +66989,7 @@ A handler for this signal can be used for setup tasks. + @@ -63780,6 +66997,7 @@ A handler for this signal can be used for setup tasks. + @@ -63787,6 +67005,7 @@ A handler for this signal can be used for setup tasks. + @@ -63794,6 +67013,7 @@ A handler for this signal can be used for setup tasks. + @@ -63801,64 +67021,67 @@ A handler for this signal can be used for setup tasks. + - + + + - The result of a print operation. + The result of a print operation. A value of this type is returned by [method@Gtk.PrintOperation.run]. - An error has occurred. + An error has occurred. - The print settings should be stored. + The print settings should be stored. - The print operation has been canceled, + The print operation has been canceled, the print settings should not be stored. - The print operation is not complete + The print operation is not complete yet. This value will only be returned when running asynchronously. - See also gtk_print_job_set_pages() + See also gtk_print_job_set_pages() - All pages. + All pages. - Current page. + Current page. - Range of pages. + Range of pages. - Selected pages. + Selected pages. - See also gtk_print_settings_set_quality(). + See also gtk_print_settings_set_quality(). - Low quality. + Low quality. - Normal quality. + Normal quality. - High quality. + High quality. - Draft quality. + Draft quality. - A `GtkPrintSettings` object represents the settings of a print dialog in + A `GtkPrintSettings` object represents the settings of a print dialog in a system-independent way. The main use for this object is that once you’ve printed you can get a @@ -63871,395 +67094,420 @@ the settings for the next time your app runs, or even store them in a document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works. - Creates a new `GtkPrintSettings` object. + Creates a new `GtkPrintSettings` object. + - a new `GtkPrintSettings` object + a new `GtkPrintSettings` object - Reads the print settings from @file_name. + Reads the print settings from @file_name. Returns a new `GtkPrintSettings` object with the restored settings, or %NULL if an error occurred. If the file could not be loaded then error is set to either a `GFileError` or `GKeyFileError`. See [method@Gtk.PrintSettings.to_file]. + - the restored `GtkPrintSettings` + the restored `GtkPrintSettings` - the filename to read the settings from + the filename to read the settings from - Deserialize print settings from an a{sv} variant. + Deserialize print settings from an a{sv} variant. The variant must be in the format produced by [method@Gtk.PrintSettings.to_gvariant]. + - a new `GtkPrintSettings` object + a new `GtkPrintSettings` object - an a{sv} `GVariant` + an a{sv} `GVariant` - Reads the print settings from the group @group_name in @key_file. + Reads the print settings from the group @group_name in @key_file. Returns a new `GtkPrintSettings` object with the restored settings, or %NULL if an error occurred. If the file could not be loaded then error is set to either `GFileError` or `GKeyFileError`. + - the restored `GtkPrintSettings` + the restored `GtkPrintSettings` - the `GKeyFile` to retrieve the settings from + the `GKeyFile` to retrieve the settings from - the name of the group to use, or %NULL to use + the name of the group to use, or %NULL to use the default “Print Settings” - Copies a `GtkPrintSettings` object. + Copies a `GtkPrintSettings` object. + - a newly allocated copy of @other + a newly allocated copy of @other - a `GtkPrintSettings` + a `GtkPrintSettings` - Calls @func for each key-value pair of @settings. + Calls @func for each key-value pair of @settings. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the function to call + the function to call - user data for @func + user data for @func - Looks up the string value associated with @key. + Looks up the string value associated with @key. + - the string value for @key + the string value for @key - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - Returns the boolean represented by the value + Returns the boolean represented by the value that is associated with @key. The string “true” represents %TRUE, any other string %FALSE. + - %TRUE, if @key maps to a true value. + %TRUE, if @key maps to a true value. - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - Gets the value of %GTK_PRINT_SETTINGS_COLLATE. + Gets the value of %GTK_PRINT_SETTINGS_COLLATE. + - whether to collate the printed pages + whether to collate the printed pages - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. + Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. + - the default source + the default source - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_DITHER. + Gets the value of %GTK_PRINT_SETTINGS_DITHER. + - the dithering that is used + the dithering that is used - a `GtkPrintSettings` + a `GtkPrintSettings` - Returns the double value associated with @key, or 0. + Returns the double value associated with @key, or 0. + - the double value of @key + the double value of @key - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - Returns the floating point number represented by + Returns the floating point number represented by the value that is associated with @key, or @default_val if the value does not represent a floating point number. Floating point numbers are parsed with g_ascii_strtod(). + - the floating point number associated with @key + the floating point number associated with @key - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - the default value + the default value - Gets the value of %GTK_PRINT_SETTINGS_DUPLEX. + Gets the value of %GTK_PRINT_SETTINGS_DUPLEX. + - whether to print the output in duplex. + whether to print the output in duplex. - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS. + Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS. + - the finishings + the finishings - a `GtkPrintSettings` + a `GtkPrintSettings` - Returns the integer value of @key, or 0. + Returns the integer value of @key, or 0. + - the integer value of @key + the integer value of @key - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - Returns the value of @key, interpreted as + Returns the value of @key, interpreted as an integer, or the default value. + - the integer value of @key + the integer value of @key - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - the default value + the default value - Returns the value associated with @key, interpreted + Returns the value associated with @key, interpreted as a length. The returned value is converted to @units. + - the length value of @key, converted to @unit + the length value of @key, converted to @unit - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - the unit of the return value + the unit of the return value - Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. + Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. The set of media types is defined in PWG 5101.1-2002 PWG. + - the media type + the media type - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_N_COPIES. + Gets the value of %GTK_PRINT_SETTINGS_N_COPIES. + - the number of copies to print + the number of copies to print - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. + Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. + - the number of pages per sheet + the number of pages per sheet - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. + Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. + - layout of page in number-up mode + layout of page in number-up mode - a `GtkPrintSettings` + a `GtkPrintSettings` - Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, + Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, converted to a `GtkPageOrientation`. + - the orientation + the orientation - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. + Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. + - the output bin + the output bin - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. + Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. + - an array + an array of `GtkPageRange`s. Use g_free() to free the array when it is no longer needed. @@ -64268,878 +67516,930 @@ converted to a `GtkPageOrientation`. - a `GtkPrintSettings` + a `GtkPrintSettings` - return location for the length of the returned array + return location for the length of the returned array - Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET. + Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET. + - the set of pages to print + the set of pages to print - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, + Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to @unit. + - the paper height, in units of @unit + the paper height, in units of @unit - a `GtkPrintSettings` + a `GtkPrintSettings` - the unit for the return value + the unit for the return value - Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, + Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a `GtkPaperSize`. + - the paper size + the paper size - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, + Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to @unit. + - the paper width, in units of @unit + the paper width, in units of @unit - a `GtkPrintSettings` + a `GtkPrintSettings` - the unit for the return value + the unit for the return value - Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. + Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. + - which pages to print + which pages to print - a `GtkPrintSettings` + a `GtkPrintSettings` - Convenience function to obtain the value of + Convenience function to obtain the value of %GTK_PRINT_SETTINGS_PRINTER. + - the printer name + the printer name - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. + Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. + - the resolution in lpi (lines per inch) + the resolution in lpi (lines per inch) - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_QUALITY. + Gets the value of %GTK_PRINT_SETTINGS_QUALITY. + - the print quality + the print quality - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION. + Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION. + - the resolution in dpi + the resolution in dpi - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X. + Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X. + - the horizontal resolution in dpi + the horizontal resolution in dpi - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y. + Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y. + - the vertical resolution in dpi + the vertical resolution in dpi - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_REVERSE. + Gets the value of %GTK_PRINT_SETTINGS_REVERSE. + - whether to reverse the order of the printed pages + whether to reverse the order of the printed pages - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_SCALE. + Gets the value of %GTK_PRINT_SETTINGS_SCALE. + - the scale in percent + the scale in percent - a `GtkPrintSettings` + a `GtkPrintSettings` - Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR. + Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR. + - whether to use color + whether to use color - a `GtkPrintSettings` + a `GtkPrintSettings` - Returns %TRUE, if a value is associated with @key. + Returns %TRUE, if a value is associated with @key. + - %TRUE, if @key has a value + %TRUE, if @key has a value - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - Reads the print settings from @file_name. + Reads the print settings from @file_name. If the file could not be loaded then error is set to either a `GFileError` or `GKeyFileError`. See [method@Gtk.PrintSettings.to_file]. + - %TRUE on success + %TRUE on success - a `GtkPrintSettings` + a `GtkPrintSettings` - the filename to read the settings from + the filename to read the settings from - Reads the print settings from the group @group_name in @key_file. + Reads the print settings from the group @group_name in @key_file. If the file could not be loaded then error is set to either a `GFileError` or `GKeyFileError`. + - %TRUE on success + %TRUE on success - a `GtkPrintSettings` + a `GtkPrintSettings` - the `GKeyFile` to retrieve the settings from + the `GKeyFile` to retrieve the settings from - the name of the group to use, or %NULL + the name of the group to use, or %NULL to use the default “Print Settings” - Associates @value with @key. + Associates @value with @key. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - a string value + a string value - Sets @key to a boolean value. + Sets @key to a boolean value. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - a boolean + a boolean - Sets the value of %GTK_PRINT_SETTINGS_COLLATE. + Sets the value of %GTK_PRINT_SETTINGS_COLLATE. + - a `GtkPrintSettings` + a `GtkPrintSettings` - whether to collate the output + whether to collate the output - Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. + Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the default source + the default source - Sets the value of %GTK_PRINT_SETTINGS_DITHER. + Sets the value of %GTK_PRINT_SETTINGS_DITHER. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the dithering that is used + the dithering that is used - Sets @key to a double value. + Sets @key to a double value. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - a double value + a double value - Sets the value of %GTK_PRINT_SETTINGS_DUPLEX. + Sets the value of %GTK_PRINT_SETTINGS_DUPLEX. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a `GtkPrintDuplex` value + a `GtkPrintDuplex` value - Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS. + Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the finishings + the finishings - Sets @key to an integer value. + Sets @key to an integer value. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - an integer + an integer - Associates a length in units of @unit with @key. + Associates a length in units of @unit with @key. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key - a length + a length - the unit of @length + the unit of @length - Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. + Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE. The set of media types is defined in PWG 5101.1-2002 PWG. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the media type + the media type - Sets the value of %GTK_PRINT_SETTINGS_N_COPIES. + Sets the value of %GTK_PRINT_SETTINGS_N_COPIES. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the number of copies + the number of copies - Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. + Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the number of pages per sheet + the number of pages per sheet - Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. + Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a `GtkNumberUpLayout` value + a `GtkNumberUpLayout` value - Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION. + Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a page orientation + a page orientation - Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. + Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the output bin + the output bin - Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. + Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. + - a `GtkPrintSettings` + a `GtkPrintSettings` - an array of `GtkPageRange`s + an array of `GtkPageRange`s - the length of @page_ranges + the length of @page_ranges - Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET. + Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a `GtkPageSet` value + a `GtkPageSet` value - Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT. + Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the paper height + the paper height - the units of @height + the units of @height - Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, + Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, %GTK_PRINT_SETTINGS_PAPER_WIDTH and %GTK_PRINT_SETTINGS_PAPER_HEIGHT. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a paper size + a paper size - Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH. + Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the paper width + the paper width - the units of @width + the units of @width - Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. + Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a `GtkPrintPages` value + a `GtkPrintPages` value - Convenience function to set %GTK_PRINT_SETTINGS_PRINTER + Convenience function to set %GTK_PRINT_SETTINGS_PRINTER to @printer. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the printer name + the printer name - Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. + Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the resolution in lpi (lines per inch) + the resolution in lpi (lines per inch) - Sets the value of %GTK_PRINT_SETTINGS_QUALITY. + Sets the value of %GTK_PRINT_SETTINGS_QUALITY. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a `GtkPrintQuality` value + a `GtkPrintQuality` value - Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, + Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the resolution in dpi + the resolution in dpi - Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, + Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the horizontal resolution in dpi + the horizontal resolution in dpi - the vertical resolution in dpi + the vertical resolution in dpi - Sets the value of %GTK_PRINT_SETTINGS_REVERSE. + Sets the value of %GTK_PRINT_SETTINGS_REVERSE. + - a `GtkPrintSettings` + a `GtkPrintSettings` - whether to reverse the output + whether to reverse the output - Sets the value of %GTK_PRINT_SETTINGS_SCALE. + Sets the value of %GTK_PRINT_SETTINGS_SCALE. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the scale in percent + the scale in percent - Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR. + Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR. + - a `GtkPrintSettings` + a `GtkPrintSettings` - whether to use color + whether to use color - This function saves the print settings from @settings to @file_name. + This function saves the print settings from @settings to @file_name. If the file could not be written then error is set to either a `GFileError` or `GKeyFileError`. + - %TRUE on success + %TRUE on success - a `GtkPrintSettings` + a `GtkPrintSettings` - the file to save to + the file to save to - Serialize print settings to an a{sv} variant. + Serialize print settings to an a{sv} variant. + - a new, floating, `GVariant` + a new, floating, `GVariant` - a `GtkPrintSettings` + a `GtkPrintSettings` - This function adds the print settings from @settings to @key_file. + This function adds the print settings from @settings to @key_file. + - a `GtkPrintSettings` + a `GtkPrintSettings` - the `GKeyFile` to save the print settings to + the `GKeyFile` to save the print settings to - the group to add the settings to in @key_file, or + the group to add the settings to in @key_file, or %NULL to use the default “Print Settings” - Removes any value associated with @key. + Removes any value associated with @key. This has the same effect as setting the value to %NULL. + - a `GtkPrintSettings` + a `GtkPrintSettings` - a key + a key + @@ -65156,44 +68456,44 @@ This has the same effect as setting the value to %NULL. - The status gives a rough indication of the completion of a running + The status gives a rough indication of the completion of a running print operation. - The printing has not started yet; this + The printing has not started yet; this status is set initially, and while the print dialog is shown. - This status is set while the begin-print + This status is set while the begin-print signal is emitted and during pagination. - This status is set while the + This status is set while the pages are being rendered. - The print job is being sent off to the + The print job is being sent off to the printer. - The print job has been sent to the printer, + The print job has been sent to the printer, but is not printed for some reason, e.g. the printer may be stopped. - Some problem has occurred during + Some problem has occurred during printing, e.g. a paper jam. - The printer is processing the print job. + The printer is processing the print job. - The printing has been completed successfully. + The printing has been completed successfully. - The printing has been aborted. + The printing has been aborted. - `GtkPrintUnixDialog` implements a print dialog for platforms + `GtkPrintUnixDialog` implements a print dialog for platforms which don’t provide a native print dialog, like Unix. ![An example GtkPrintUnixDialog](printdialog.png) @@ -65256,299 +68556,317 @@ dialog and print are added. - Creates a new `GtkPrintUnixDialog`. + Creates a new `GtkPrintUnixDialog`. + - a new `GtkPrintUnixDialog` + a new `GtkPrintUnixDialog` - Title of the dialog + Title of the dialog - Transient parent of the dialog + Transient parent of the dialog - Adds a custom tab to the print dialog. + Adds a custom tab to the print dialog. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - the widget to put in the custom tab + the widget to put in the custom tab - the widget to use as tab label + the widget to use as tab label - Gets the current page of the `GtkPrintUnixDialog`. + Gets the current page of the `GtkPrintUnixDialog`. + - the current page of @dialog + the current page of @dialog - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets whether to embed the page setup. + Gets whether to embed the page setup. + - whether to embed the page setup + whether to embed the page setup - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets whether there is a selection. + Gets whether there is a selection. + - whether there is a selection + whether there is a selection - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets the capabilities that have been set on this `GtkPrintUnixDialog`. + Gets the capabilities that have been set on this `GtkPrintUnixDialog`. + - the printing capabilities + the printing capabilities - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets the page setup that is used by the `GtkPrintUnixDialog`. + Gets the page setup that is used by the `GtkPrintUnixDialog`. + - the page setup of @dialog. + the page setup of @dialog. - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets whether a page setup was set by the user. + Gets whether a page setup was set by the user. + - whether a page setup was set by user. + whether a page setup was set by user. - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets the currently selected printer. + Gets the currently selected printer. + - the currently selected printer + the currently selected printer - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets a new `GtkPrintSettings` object that represents the + Gets a new `GtkPrintSettings` object that represents the current values in the print dialog. Note that this creates a new object, and you need to unref it if don’t want to keep it. + - a new `GtkPrintSettings` object with the values from @dialog + a new `GtkPrintSettings` object with the values from @dialog - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Gets whether the print dialog allows user to print a selection. + Gets whether the print dialog allows user to print a selection. + - whether the application supports print of selection + whether the application supports print of selection - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - Sets the current page number. + Sets the current page number. If @current_page is not -1, this enables the current page choice for the range of pages to print. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - the current page number. + the current page number. - Embed page size combo box and orientation combo box into page setup page. + Embed page size combo box and orientation combo box into page setup page. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - embed page setup selection + embed page setup selection - Sets whether a selection exists. + Sets whether a selection exists. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - %TRUE indicates that a selection exists + %TRUE indicates that a selection exists - This lets you specify the printing capabilities your application + This lets you specify the printing capabilities your application supports. For instance, if you can handle scaling the output then you pass %GTK_PRINT_CAPABILITY_SCALE. If you don’t pass that, then the dialog will only let you select the scale if the printing system automatically handles scaling. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - the printing capabilities of your application + the printing capabilities of your application - Sets the page setup of the `GtkPrintUnixDialog`. + Sets the page setup of the `GtkPrintUnixDialog`. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - a `GtkPageSetup` + a `GtkPageSetup` - Sets the `GtkPrintSettings` for the `GtkPrintUnixDialog`. + Sets the `GtkPrintSettings` for the `GtkPrintUnixDialog`. Typically, this is used to restore saved print settings from a previous print operation before the print dialog is shown. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - a `GtkPrintSettings` + a `GtkPrintSettings` - Sets whether the print dialog allows user to print a selection. + Sets whether the print dialog allows user to print a selection. + - a `GtkPrintUnixDialog` + a `GtkPrintUnixDialog` - %TRUE to allow print selection + %TRUE to allow print selection @@ -65556,53 +68874,53 @@ is shown. - The current page in the document. + The current page in the document. - %TRUE if the page setup controls are embedded. + %TRUE if the page setup controls are embedded. - Whether the application has a selection. + Whether the application has a selection. - Capabilities the application can handle. + Capabilities the application can handle. - The `GtkPageSetup` object to use. + The `GtkPageSetup` object to use. - The `GtkPrintSettings` object used for this dialog. + The `GtkPrintSettings` object used for this dialog. - The `GtkPrinter` which is selected. + The `GtkPrinter` which is selected. - Whether the dialog supports selection. + Whether the dialog supports selection. - A `GtkPrinter` object represents a printer. + A `GtkPrinter` object represents a printer. You only need to deal directly with printers if you use the non-portable [class@Gtk.PrintUnixDialog] API. @@ -65612,90 +68930,95 @@ such as its description, its location, the number of queued jobs, etc. Most importantly, a `GtkPrinter` object can be used to create a [class@Gtk.PrintJob] object, which lets you print to the printer. - Creates a new `GtkPrinter`. + Creates a new `GtkPrinter`. + - a new `GtkPrinter` + a new `GtkPrinter` - the name of the printer + the name of the printer - a `GtkPrintBackend` + a `GtkPrintBackend` - whether the printer is virtual + whether the printer is virtual - Returns whether the printer accepts input in + Returns whether the printer accepts input in PDF format. + - %TRUE if @printer accepts PDF + %TRUE if @printer accepts PDF - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer accepts input in + Returns whether the printer accepts input in PostScript format. + - %TRUE if @printer accepts PostScript + %TRUE if @printer accepts PostScript - a `GtkPrinter` + a `GtkPrinter` - Compares two printers. + Compares two printers. + - 0 if the printer match, a negative value if @a < @b, + 0 if the printer match, a negative value if @a < @b, or a positive value if @a > @b - a `GtkPrinter` + a `GtkPrinter` - another `GtkPrinter` + another `GtkPrinter` - Returns the backend of the printer. + Returns the backend of the printer. + - the backend of @printer + the backend of @printer - a `GtkPrinter` + a `GtkPrinter` - Returns the printer’s capabilities. + Returns the printer’s capabilities. This is useful when you’re using `GtkPrintUnixDialog`’s manual-capabilities setting and need to know which settings @@ -65704,46 +69027,49 @@ the printer can handle and which you must handle yourself. This will return 0 unless the printer’s details are available, see [method@Gtk.Printer.has_details] and [method@Gtk.Printer.request_details]. + - the printer’s capabilities + the printer’s capabilities - a `GtkPrinter` + a `GtkPrinter` - Returns default page size of @printer. + Returns default page size of @printer. + - a newly allocated `GtkPageSetup` with default page size + a newly allocated `GtkPageSetup` with default page size of the printer. - a `GtkPrinter` + a `GtkPrinter` - Gets the description of the printer. + Gets the description of the printer. + - the description of @printer + the description of @printer - a `GtkPrinter` + a `GtkPrinter` - Retrieve the hard margins of @printer. + Retrieve the hard margins of @printer. These are the margins that define the area at the borders of the paper that the printer cannot print to. @@ -65751,35 +69077,36 @@ of the paper that the printer cannot print to. Note: This will not succeed unless the printer’s details are available, see [method@Gtk.Printer.has_details] and [method@Gtk.Printer.request_details]. + - %TRUE iff the hard margins were retrieved + %TRUE iff the hard margins were retrieved - a `GtkPrinter` + a `GtkPrinter` - a location to store the top margin in + a location to store the top margin in - a location to store the bottom margin in + a location to store the bottom margin in - a location to store the left margin in + a location to store the left margin in - a location to store the right margin in + a location to store the right margin in - Retrieve the hard margins of @printer for @paper_size. + Retrieve the hard margins of @printer for @paper_size. These are the margins that define the area at the borders of the paper that the printer cannot print to. @@ -65787,203 +69114,216 @@ of the paper that the printer cannot print to. Note: This will not succeed unless the printer’s details are available, see [method@Gtk.Printer.has_details] and [method@Gtk.Printer.request_details]. + - %TRUE iff the hard margins were retrieved + %TRUE iff the hard margins were retrieved - a `GtkPrinter` + a `GtkPrinter` - a `GtkPaperSize` + a `GtkPaperSize` - a location to store the top margin in + a location to store the top margin in - a location to store the bottom margin in + a location to store the bottom margin in - a location to store the left margin in + a location to store the left margin in - a location to store the right margin in + a location to store the right margin in - Gets the name of the icon to use for the printer. + Gets the name of the icon to use for the printer. + - the icon name for @printer + the icon name for @printer - a `GtkPrinter` + a `GtkPrinter` - Gets the number of jobs currently queued on the printer. + Gets the number of jobs currently queued on the printer. + - the number of jobs on @printer + the number of jobs on @printer - a `GtkPrinter` + a `GtkPrinter` - Returns a description of the location of the printer. + Returns a description of the location of the printer. + - the location of @printer + the location of @printer - a `GtkPrinter` + a `GtkPrinter` - Returns the name of the printer. + Returns the name of the printer. + - the name of @printer + the name of @printer - a `GtkPrinter` + a `GtkPrinter` - Returns the state message describing the current state + Returns the state message describing the current state of the printer. + - the state message of @printer + the state message of @printer - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer details are available. + Returns whether the printer details are available. + - %TRUE if @printer details are available + %TRUE if @printer details are available - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer is accepting jobs + Returns whether the printer is accepting jobs + - %TRUE if @printer is accepting jobs + %TRUE if @printer is accepting jobs - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer is currently active (i.e. + Returns whether the printer is currently active (i.e. accepts new jobs). + - %TRUE if @printer is active + %TRUE if @printer is active - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer is the default printer. + Returns whether the printer is the default printer. + - %TRUE if @printer is the default + %TRUE if @printer is the default - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer is currently paused. + Returns whether the printer is currently paused. A paused printer still accepts jobs, but it is not printing them. + - %TRUE if @printer is paused + %TRUE if @printer is paused - a `GtkPrinter` + a `GtkPrinter` - Returns whether the printer is virtual (i.e. does not + Returns whether the printer is virtual (i.e. does not represent actual printer hardware, but something like a CUPS class). + - %TRUE if @printer is virtual + %TRUE if @printer is virtual - a `GtkPrinter` + a `GtkPrinter` - Lists all the paper sizes @printer supports. + Lists all the paper sizes @printer supports. This will return and empty list unless the printer’s details are available, see [method@Gtk.Printer.has_details] and [method@Gtk.Printer.request_details]. + - a newly + a newly allocated list of newly allocated `GtkPageSetup`s. @@ -65991,75 +69331,76 @@ are available, see [method@Gtk.Printer.has_details] and - a `GtkPrinter` + a `GtkPrinter` - Requests the printer details. + Requests the printer details. When the details are available, the [signal@Gtk.Printer::details-acquired] signal will be emitted on @printer. + - a `GtkPrinter` + a `GtkPrinter` - %TRUE if the printer is accepting jobs. + %TRUE if the printer is accepting jobs. - %TRUE if this printer can accept PDF. + %TRUE if this printer can accept PDF. - %TRUE if this printer can accept PostScript. + %TRUE if this printer can accept PostScript. - The backend for the printer. + The backend for the printer. - Icon name to use for the printer. + Icon name to use for the printer. - %FALSE if this represents a real hardware device. + %FALSE if this represents a real hardware device. - Number of jobs queued in the printer. + Number of jobs queued in the printer. - Information about the location of the printer. + Information about the location of the printer. - The name of the printer. + The name of the printer. - %TRUE if this printer is paused. + %TRUE if this printer is paused. A paused printer still accepts jobs, but it does not print them. @@ -66067,11 +69408,11 @@ not print them. - String giving the current status of the printer. + String giving the current status of the printer. - Emitted in response to a request for detailed information + Emitted in response to a request for detailed information about a printer from the print backend. The @success parameter indicates if the information was @@ -66081,34 +69422,35 @@ actually obtained. - %TRUE if the details were successfully acquired + %TRUE if the details were successfully acquired - The type of function passed to gtk_enumerate_printers(). + The type of function passed to gtk_enumerate_printers(). Note that you need to ref @printer, if you want to keep a reference to it after the function has returned. + - %TRUE to stop the enumeration, %FALSE to continue + %TRUE to stop the enumeration, %FALSE to continue - a `GtkPrinter` + a `GtkPrinter` - user data passed to gtk_enumerate_printers() + user data passed to gtk_enumerate_printers() - `GtkProgressBar` is typically used to display the progress of a long + `GtkProgressBar` is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. `GtkProgressBar` @@ -66159,206 +69501,218 @@ in overlays like the one Epiphany has for page loading progress. - Creates a new `GtkProgressBar`. + Creates a new `GtkProgressBar`. + - a `GtkProgressBar`. + a `GtkProgressBar`. - Returns the ellipsizing position of the progress bar. + Returns the ellipsizing position of the progress bar. See [method@Gtk.ProgressBar.set_ellipsize]. + - `PangoEllipsizeMode` + `PangoEllipsizeMode` - a `GtkProgressBar` + a `GtkProgressBar` - Returns the current fraction of the task that’s been completed. + Returns the current fraction of the task that’s been completed. + - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a `GtkProgressBar` + a `GtkProgressBar` - Returns whether the progress bar is inverted. + Returns whether the progress bar is inverted. + - %TRUE if the progress bar is inverted + %TRUE if the progress bar is inverted - a `GtkProgressBar` + a `GtkProgressBar` - Retrieves the pulse step. + Retrieves the pulse step. See [method@Gtk.ProgressBar.set_pulse_step]. + - a fraction from 0.0 to 1.0 + a fraction from 0.0 to 1.0 - a `GtkProgressBar` + a `GtkProgressBar` - Returns whether the `GtkProgressBar` shows text. + Returns whether the `GtkProgressBar` shows text. See [method@Gtk.ProgressBar.set_show_text]. + - %TRUE if text is shown in the progress bar + %TRUE if text is shown in the progress bar - a `GtkProgressBar` + a `GtkProgressBar` - Retrieves the text that is displayed with the progress bar. + Retrieves the text that is displayed with the progress bar. The return value is a reference to the text, not a copy of it, so will become invalid if you change the text in the progress bar. + - the text + the text - a `GtkProgressBar` + a `GtkProgressBar` - Indicates that some progress has been made, but you don’t know how much. + Indicates that some progress has been made, but you don’t know how much. Causes the progress bar to enter “activity mode,” where a block bounces back and forth. Each call to [method@Gtk.ProgressBar.pulse] causes the block to move by a little bit (the amount of movement per pulse is determined by [method@Gtk.ProgressBar.set_pulse_step]). + - a `GtkProgressBar` + a `GtkProgressBar` - Sets the mode used to ellipsize the text. + Sets the mode used to ellipsize the text. The text is ellipsized if there is not enough space to render the entire string. + - a `GtkProgressBar` + a `GtkProgressBar` - a `PangoEllipsizeMode` + a `PangoEllipsizeMode` - Causes the progress bar to “fill in” the given fraction + Causes the progress bar to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive. + - a `GtkProgressBar` + a `GtkProgressBar` - fraction of the task that’s been completed + fraction of the task that’s been completed - Sets whether the progress bar is inverted. + Sets whether the progress bar is inverted. Progress bars normally grow from top to bottom or left to right. Inverted progress bars grow in the opposite direction. + - a `GtkProgressBar` + a `GtkProgressBar` - %TRUE to invert the progress bar + %TRUE to invert the progress bar - Sets the fraction of total progress bar length to move the + Sets the fraction of total progress bar length to move the bouncing block. The bouncing block is moved when [method@Gtk.ProgressBar.pulse] is called. + - a `GtkProgressBar` + a `GtkProgressBar` - fraction between 0.0 and 1.0 + fraction between 0.0 and 1.0 - Sets whether the progress bar will show text next to the bar. + Sets whether the progress bar will show text next to the bar. The shown text is either the value of the [property@Gtk.ProgressBar:text] property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] value, @@ -66367,23 +69721,24 @@ as a percentage. To make a progress bar that is styled and sized suitably for containing text (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text] to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL). + - a `GtkProgressBar` + a `GtkProgressBar` - whether to show text + whether to show text - Causes the given @text to appear next to the progress bar. + Causes the given @text to appear next to the progress bar. If @text is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE, the current value of [property@Gtk.ProgressBar:fraction] will be displayed @@ -66394,16 +69749,17 @@ the text will be displayed. In this case, it will not display the progress percentage. If @text is the empty string, the progress bar will still be styled and sized suitably for containing text, as long as [property@Gtk.ProgressBar:show-text] is %TRUE. + - a `GtkProgressBar` + a `GtkProgressBar` - a UTF-8 string + a UTF-8 string @@ -66411,7 +69767,7 @@ be styled and sized suitably for containing text, as long as - The preferred place to ellipsize the string. + The preferred place to ellipsize the string. The text will be ellipsized if the progress bar does not have enough room to display the entire string, specified as a `PangoEllipsizeMode`. @@ -66425,25 +69781,25 @@ progress bar's width is [method@Gtk.Widget.set_size_request]. - The fraction of total work that has been completed. + The fraction of total work that has been completed. - Invert the direction in which the progress bar grows. + Invert the direction in which the progress bar grows. - The fraction of total progress to move the bounding block when pulsed. + The fraction of total progress to move the bounding block when pulsed. - Sets whether the progress bar will show a text in addition + Sets whether the progress bar will show a text in addition to the bar itself. The shown text is either the value of the [property@Gtk.ProgressBar:text] @@ -66458,49 +69814,49 @@ to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL). - Text to be displayed in the progress bar. + Text to be displayed in the progress bar. - Describes limits of a `GtkEventController` for handling events + Describes limits of a `GtkEventController` for handling events targeting other widgets. - Events are handled regardless of what their + Events are handled regardless of what their target is. - Events are only handled if their target + Events are only handled if their target is in the same `GtkNative` as the event controllers widget. Note that some event types have two targets (origin and destination). - Describes the stage at which events are fed into a `GtkEventController`. + Describes the stage at which events are fed into a `GtkEventController`. - Events are not delivered. + Events are not delivered. - Events are delivered in the capture phase. The + Events are delivered in the capture phase. The capture phase happens before the bubble phase, runs from the toplevel down to the event widget. This option should only be used on containers that might possibly handle events before their children do. - Events are delivered in the bubble phase. The bubble + Events are delivered in the bubble phase. The bubble phase happens after the capture phase, and before the default handlers are run. This phase runs from the event widget, up to the toplevel. - Events are delivered in the default widget event handlers, + Events are delivered in the default widget event handlers, note that widget implementations must chain up on button, motion, touch and grab broken handlers for controllers in this phase to be run. - A `GObject` property value in a `GtkExpression`. + A `GObject` property value in a `GtkExpression`. - Creates an expression that looks up a property. + Creates an expression that looks up a property. The object to use is found by evaluating the `expression`, or using the `this` argument when `expression` is `NULL`. @@ -66510,29 +69866,30 @@ If the resulting object conforms to `this_type`, its property named evaluation will fail. The given `this_type` must have a property with `property_name`. + - a new `GtkExpression` + a new `GtkExpression` - The type to expect for the this type + The type to expect for the this type - Expression to + Expression to evaluate to get the object to query or `NULL` to query the `this` object - name of the property + name of the property - Creates an expression that looks up a property. + Creates an expression that looks up a property. The object to use is found by evaluating the `expression`, or using the `this` argument when `expression` is `NULL`. @@ -66540,96 +69897,106 @@ or using the `this` argument when `expression` is `NULL`. If the resulting object conforms to `this_type`, its property specified by `pspec` will be queried. Otherwise, this expression's evaluation will fail. + - a new `GtkExpression` + a new `GtkExpression` - Expression to + Expression to evaluate to get the object to query or `NULL` to query the `this` object - the `GParamSpec` for the property to query + the `GParamSpec` for the property to query - Gets the expression specifying the object of + Gets the expression specifying the object of a property expression. + - the object expression + the object expression - a property `GtkExpression` + a property `GtkExpression` - Gets the `GParamSpec` specifying the property of + Gets the `GParamSpec` specifying the property of a property expression. + - the `GParamSpec` for the property + the `GParamSpec` for the property - a property `GtkExpression` + a property `GtkExpression` + + + + + + + - `GtkRange` is the common base class for widgets which visualize an + `GtkRange` is the common base class for widgets which visualize an adjustment. Widgets that are derived from `GtkRange` include @@ -66638,11 +70005,13 @@ Widgets that are derived from `GtkRange` include Apart from signals for monitoring the parameters of the adjustment, `GtkRange` provides properties and methods for setting a “fill level” on range widgets. See [method@Gtk.Range.set_fill_level]. + + @@ -66656,6 +70025,7 @@ Apart from signals for monitoring the parameters of the adjustment, + @@ -66672,6 +70042,7 @@ Apart from signals for monitoring the parameters of the adjustment, + @@ -66685,6 +70056,7 @@ Apart from signals for monitoring the parameters of the adjustment, + @@ -66698,6 +70070,7 @@ Apart from signals for monitoring the parameters of the adjustment, + @@ -66709,181 +70082,192 @@ Apart from signals for monitoring the parameters of the adjustment, - Get the adjustment which is the “model” object for `GtkRange`. + Get the adjustment which is the “model” object for `GtkRange`. + - a `GtkAdjustment` + a `GtkAdjustment` - a `GtkRange` + a `GtkRange` - Gets the current position of the fill level indicator. + Gets the current position of the fill level indicator. + - The current fill level + The current fill level - A `GtkRange` + A `GtkRange` - Gets whether the `GtkRange` respects text direction. + Gets whether the `GtkRange` respects text direction. See [method@Gtk.Range.set_flippable]. + - %TRUE if the range is flippable + %TRUE if the range is flippable - a `GtkRange` + a `GtkRange` - Gets whether the range is inverted. + Gets whether the range is inverted. See [method@Gtk.Range.set_inverted]. + - %TRUE if the range is inverted + %TRUE if the range is inverted - a `GtkRange` + a `GtkRange` - This function returns the area that contains the range’s trough, + This function returns the area that contains the range’s trough, in coordinates relative to @range's origin. This function is useful mainly for `GtkRange` subclasses. + - a `GtkRange` + a `GtkRange` - return location for the range rectangle + return location for the range rectangle - Gets whether the range is restricted to the fill level. + Gets whether the range is restricted to the fill level. + - %TRUE if @range is restricted to the fill level. + %TRUE if @range is restricted to the fill level. - A `GtkRange` + A `GtkRange` - Gets the number of digits to round the value to when + Gets the number of digits to round the value to when it changes. See [signal@Gtk.Range::change-value]. + - the number of digits to round to + the number of digits to round to - a `GtkRange` + a `GtkRange` - Gets whether the range displays the fill level graphically. + Gets whether the range displays the fill level graphically. + - %TRUE if @range shows the fill level. + %TRUE if @range shows the fill level. - A `GtkRange` + A `GtkRange` - This function returns sliders range along the long dimension, + This function returns sliders range along the long dimension, in widget->window coordinates. This function is useful mainly for `GtkRange` subclasses. + - a `GtkRange` + a `GtkRange` - return location for the slider's start + return location for the slider's start - return location for the slider's end + return location for the slider's end - This function is useful mainly for `GtkRange` subclasses. + This function is useful mainly for `GtkRange` subclasses. See [method@Gtk.Range.set_slider_size_fixed]. + - whether the range’s slider has a fixed size. + whether the range’s slider has a fixed size. - a `GtkRange` + a `GtkRange` - Gets the current value of the range. + Gets the current value of the range. + - current value of the range. + current value of the range. - a `GtkRange` + a `GtkRange` - Sets the adjustment to be used as the “model” object for the `GtkRange` + Sets the adjustment to be used as the “model” object for the `GtkRange` The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings @@ -66892,23 +70276,24 @@ and scrolling, and the page size. The page size is normally 0 for `GtkScale` and nonzero for `GtkScrollbar`, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider. + - a `GtkRange` + a `GtkRange` - a `GtkAdjustment` + a `GtkAdjustment` - Set the new position of the fill level indicator. + Set the new position of the fill level indicator. The “fill level” is probably best described by its most prominent use case, which is an indicator for the amount of pre-buffering in @@ -66925,206 +70310,216 @@ Additionally, it’s possible to restrict the range’s slider positio to values which are smaller than the fill level. This is controlled by [method@Gtk.Range.set_restrict_to_fill_level] and is by default enabled. + - a `GtkRange` + a `GtkRange` - the new position of the fill level indicator + the new position of the fill level indicator - Sets whether the `GtkRange` respects text direction. + Sets whether the `GtkRange` respects text direction. If a range is flippable, it will switch its direction if it is horizontal and its direction is %GTK_TEXT_DIR_RTL. See [method@Gtk.Widget.get_direction]. + - a `GtkRange` + a `GtkRange` - %TRUE to make the range flippable + %TRUE to make the range flippable - Sets the step and page sizes for the range. + Sets the step and page sizes for the range. The step size is used when the user clicks the `GtkScrollbar` arrows or moves a `GtkScale` via arrow keys. The page size is used for example when moving via Page Up or Page Down keys. + - a `GtkRange` + a `GtkRange` - step size + step size - page size + page size - Sets whether to invert the range. + Sets whether to invert the range. Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the right rather than on the bottom or left. + - a `GtkRange` + a `GtkRange` - %TRUE to invert the range + %TRUE to invert the range - Sets the allowable values in the `GtkRange`. + Sets the allowable values in the `GtkRange`. The range value is clamped to be between @min and @max. (If the range has a non-zero page size, it is clamped between @min and @max - page-size.) + - a `GtkRange` + a `GtkRange` - minimum range value + minimum range value - maximum range value + maximum range value - Sets whether the slider is restricted to the fill level. + Sets whether the slider is restricted to the fill level. See [method@Gtk.Range.set_fill_level] for a general description of the fill level concept. + - A `GtkRange` + A `GtkRange` - Whether the fill level restricts slider movement. + Whether the fill level restricts slider movement. - Sets the number of digits to round the value to when + Sets the number of digits to round the value to when it changes. See [signal@Gtk.Range::change-value]. + - a `GtkRange` + a `GtkRange` - the precision in digits, or -1 + the precision in digits, or -1 - Sets whether a graphical fill level is show on the trough. + Sets whether a graphical fill level is show on the trough. See [method@Gtk.Range.set_fill_level] for a general description of the fill level concept. + - A `GtkRange` + A `GtkRange` - Whether a fill level indicator graphics is shown. + Whether a fill level indicator graphics is shown. - Sets whether the range’s slider has a fixed size, or a size that + Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size. This function is useful mainly for `GtkRange` subclasses. + - a `GtkRange` + a `GtkRange` - %TRUE to make the slider size constant + %TRUE to make the slider size constant - Sets the current value of the range. + Sets the current value of the range. If the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the [signal@Gtk.Range::value-changed] signal if the value changes. + - a `GtkRange` + a `GtkRange` - new value of the range + new value of the range @@ -67132,32 +70527,32 @@ it will be clamped to fit inside them. The range emits the - The adjustment that is controlled by the range. + The adjustment that is controlled by the range. - The fill level (e.g. prebuffering of a network stream). + The fill level (e.g. prebuffering of a network stream). - If %TRUE, the direction in which the slider moves is inverted. + If %TRUE, the direction in which the slider moves is inverted. - Controls whether slider movement is restricted to an + Controls whether slider movement is restricted to an upper boundary set by the fill level. - The number of digits to round the value to when + The number of digits to round the value to when it changes. See [signal@Gtk.Range::change-value]. @@ -67166,7 +70561,7 @@ See [signal@Gtk.Range::change-value]. - Controls whether fill level indicator graphics are displayed + Controls whether fill level indicator graphics are displayed on the trough. @@ -67174,20 +70569,20 @@ on the trough. - Emitted before clamping a value, to give the application a + Emitted before clamping a value, to give the application a chance to adjust the bounds. - the value before we clamp + the value before we clamp - Emitted when a scroll action is performed on a range. + Emitted when a scroll action is performed on a range. It allows an application to determine the type of scroll event that occurred and the resultant new value. The application can @@ -67200,23 +70595,23 @@ the ::change-value signal is responsible for clamping the value to the desired number of decimal digits; the default GTK handler clamps the value based on [property@Gtk.Range:round-digits]. - %TRUE to prevent other handlers from being invoked for + %TRUE to prevent other handlers from being invoked for the signal, %FALSE to propagate the signal further - the type of scroll action that was performed + the type of scroll action that was performed - the new value resulting from the scroll action + the new value resulting from the scroll action - Virtual function that moves the slider. + Virtual function that moves the slider. Used for keybindings. @@ -67224,24 +70619,26 @@ Used for keybindings. - how to move the slider + how to move the slider - Emitted when the range value changes. + Emitted when the range value changes. + + @@ -67254,6 +70651,7 @@ Used for keybindings. + @@ -67269,6 +70667,7 @@ Used for keybindings. + @@ -67284,6 +70683,7 @@ Used for keybindings. + @@ -67299,6 +70699,7 @@ Used for keybindings. + @@ -67322,66 +70723,69 @@ Used for keybindings. - Meta-data to be passed to gtk_recent_manager_add_full() when + Meta-data to be passed to gtk_recent_manager_add_full() when registering a recently used resource. + - a UTF-8 encoded string, containing the name of the recently + a UTF-8 encoded string, containing the name of the recently used resource to be displayed, or %NULL; - a UTF-8 encoded string, containing a short description of + a UTF-8 encoded string, containing a short description of the resource, or %NULL; - the MIME type of the resource; + the MIME type of the resource; - the name of the application that is registering this recently + the name of the application that is registering this recently used resource; - command line used to launch this resource; may contain the + command line used to launch this resource; may contain the “\%f” and “\%u” escape characters which will be expanded to the resource file path and URI respectively when the command line is retrieved; - a vector of strings containing + a vector of strings containing groups names; - whether this resource should be displayed only by the + whether this resource should be displayed only by the applications that have registered it or not. - `GtkRecentInfo` contains the metadata associated with an item in the + `GtkRecentInfo` contains the metadata associated with an item in the recently used files list. + - Creates a `GAppInfo` for the specified `GtkRecentInfo` + Creates a `GAppInfo` for the specified `GtkRecentInfo` In case of error, @error will be set either with a %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR + - the newly created `GAppInfo` + the newly created `GAppInfo` - a `GtkRecentInfo` + a `GtkRecentInfo` - the name of the application that should + the name of the application that should be mapped to a `GAppInfo`; if %NULL is used then the default application for the MIME type is used @@ -67389,58 +70793,62 @@ In case of error, @error will be set either with a - Checks whether the resource pointed by @info still exists. + Checks whether the resource pointed by @info still exists. At the moment this check is done only on resources pointing to local files. + - %TRUE if the resource exists + %TRUE if the resource exists - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the the time when the resource + Gets the the time when the resource was added to the recently used resources list. + - a `GDateTime` for the time + a `GDateTime` for the time when the resource was added - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the number of days elapsed since the last update + Gets the number of days elapsed since the last update of the resource pointed by @info. + - a positive integer containing the number of days + a positive integer containing the number of days elapsed since the time this resource was last modified - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the data regarding the application that has registered the resource + Gets the data regarding the application that has registered the resource pointed by @info. If the command line contains any escape characters defined inside the storage specification, they will be expanded. + - %TRUE if an application with @app_name has registered this + %TRUE if an application with @app_name has registered this resource inside the recently used list, or %FALSE otherwise. The @app_exec string is owned by the `GtkRecentInfo` and should not be modified or freed @@ -67448,33 +70856,34 @@ storage specification, they will be expanded. - a `GtkRecentInfo` + a `GtkRecentInfo` - the name of the application that has registered this item + the name of the application that has registered this item - return location for the string containing + return location for the string containing the command line - return location for the number of times this item was registered + return location for the number of times this item was registered - return location for the time this item was last + return location for the time this item was last registered for this application - Retrieves the list of applications that have registered this resource. + Retrieves the list of applications that have registered this resource. + - a newly + a newly allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -67482,66 +70891,70 @@ storage specification, they will be expanded. - a `GtkRecentInfo` + a `GtkRecentInfo` - return location for the length of the returned list + return location for the length of the returned list - Gets the (short) description of the resource. + Gets the (short) description of the resource. + - the description of the resource. The returned string + the description of the resource. The returned string is owned by the recent manager, and should not be freed. - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the name of the resource. + Gets the name of the resource. If none has been defined, the basename of the resource is obtained. + - the display name of the resource. The returned string + the display name of the resource. The returned string is owned by the recent manager, and should not be freed. - a `GtkRecentInfo` + a `GtkRecentInfo` - Retrieves the icon associated to the resource MIME type. + Retrieves the icon associated to the resource MIME type. + - a `GIcon` containing the icon + a `GIcon` containing the icon - a `GtkRecentInfo` + a `GtkRecentInfo` - Returns all groups registered for the recently used item @info. + Returns all groups registered for the recently used item @info. The array of returned group names will be %NULL terminated, so length might optionally be %NULL. + - + a newly allocated %NULL terminated array of strings. Use g_strfreev() to free it. @@ -67550,240 +70963,254 @@ length might optionally be %NULL. - a `GtkRecentInfo` + a `GtkRecentInfo` - return location for the number of groups returned + return location for the number of groups returned - Gets the MIME type of the resource. + Gets the MIME type of the resource. + - the MIME type of the resource. The returned string + the MIME type of the resource. The returned string is owned by the recent manager, and should not be freed. - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the time when the meta-data + Gets the time when the meta-data for the resource was last modified. + - a `GDateTime` for the time + a `GDateTime` for the time when the resource was last modified - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the value of the “private” flag. + Gets the value of the “private” flag. Resources in the recently used list that have this flag set to %TRUE should only be displayed by the applications that have registered them. + - %TRUE if the private flag was found, %FALSE otherwise + %TRUE if the private flag was found, %FALSE otherwise - a `GtkRecentInfo` + a `GtkRecentInfo` - Computes a valid UTF-8 string that can be used as the + Computes a valid UTF-8 string that can be used as the name of the item in a menu or list. For example, calling this function on an item that refers to “file:///foo/bar.txt” will yield “bar.txt”. + - A newly-allocated string in UTF-8 encoding + A newly-allocated string in UTF-8 encoding free it with g_free() - an `GtkRecentInfo` + an `GtkRecentInfo` - Gets the URI of the resource. + Gets the URI of the resource. + - the URI of the resource. The returned string is + the URI of the resource. The returned string is owned by the recent manager, and should not be freed. - a `tkRecentInfo` + a `tkRecentInfo` - Gets a displayable version of the resource’s URI. + Gets a displayable version of the resource’s URI. If the resource is local, it returns a local path; if the resource is not local, it returns the UTF-8 encoded content of [method@Gtk.RecentInfo.get_uri]. + - a newly allocated UTF-8 string containing the + a newly allocated UTF-8 string containing the resource’s URI or %NULL. Use g_free() when done using it. - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the time when the meta-data + Gets the time when the meta-data for the resource was last visited. + - a `GDateTime` for the time + a `GDateTime` for the time when the resource was last visited - a `GtkRecentInfo` + a `GtkRecentInfo` - Checks whether an application registered this resource using @app_name. + Checks whether an application registered this resource using @app_name. + - %TRUE if an application with name @app_name was found, + %TRUE if an application with name @app_name was found, %FALSE otherwise - a `GtkRecentInfo` + a `GtkRecentInfo` - a string containing an application name + a string containing an application name - Checks whether @group_name appears inside the groups + Checks whether @group_name appears inside the groups registered for the recently used item @info. + - %TRUE if the group was found + %TRUE if the group was found - a `GtkRecentInfo` + a `GtkRecentInfo` - name of a group + name of a group - Checks whether the resource is local or not by looking at the + Checks whether the resource is local or not by looking at the scheme of its URI. + - %TRUE if the resource is local + %TRUE if the resource is local - a `GtkRecentInfo` + a `GtkRecentInfo` - Gets the name of the last application that have registered the + Gets the name of the last application that have registered the recently used resource represented by @info. + - an application name. Use g_free() to free it. + an application name. Use g_free() to free it. - a `GtkRecentInfo` + a `GtkRecentInfo` - Checks whether two `GtkRecentInfo` point to the same resource. + Checks whether two `GtkRecentInfo` point to the same resource. + - %TRUE if both `GtkRecentInfo` point to the same + %TRUE if both `GtkRecentInfo` point to the same resource, %FALSE otherwise - a `GtkRecentInfo` + a `GtkRecentInfo` - a `GtkRecentInfo` + a `GtkRecentInfo` - Increases the reference count of @recent_info by one. + Increases the reference count of @recent_info by one. + - the recent info object with its reference count + the recent info object with its reference count increased by one - a `GtkRecentInfo` + a `GtkRecentInfo` - Decreases the reference count of @info by one. + Decreases the reference count of @info by one. If the reference count reaches zero, @info is deallocated, and the memory freed. + - a `GtkRecentInfo` + a `GtkRecentInfo` - `GtkRecentManager` manages and looks up recently used files. + `GtkRecentManager` manages and looks up recently used files. Each recently used file is identified by its URI, and has meta-data associated to it, like the names and command lines of the applications @@ -67839,8 +71266,9 @@ In order to retrieve the list of recently used files, you can use Note that the maximum age of the recently used files list is controllable through the [property@Gtk.Settings:gtk-recent-files-max-age] property. + - Creates a new recent manager object. + Creates a new recent manager object. Recent manager objects are used to handle the list of recently used resources. A `GtkRecentManager` object monitors the recently used @@ -67850,21 +71278,24 @@ signal each time something inside the list changes. `GtkRecentManager` objects are expensive: be sure to create them only when needed. You should use [func@Gtk.RecentManager.get_default] instead. + - A newly created `GtkRecentManager` object + A newly created `GtkRecentManager` object - Gets a unique instance of `GtkRecentManager` that you can share + Gets a unique instance of `GtkRecentManager` that you can share in your application without caring about memory management. + - A unique `GtkRecentManager`. Do not ref or + A unique `GtkRecentManager`. Do not ref or unref it. + @@ -67875,7 +71306,7 @@ in your application without caring about memory management. - Adds a new resource, pointed by @uri, into the recently used + Adds a new resource, pointed by @uri, into the recently used resources list, using the metadata specified inside the `GtkRecentData` passed in @recent_data. @@ -67894,28 +71325,29 @@ to be used when viewing the item instead of the last component of the URI; a short description of the item; whether the item should be considered private - that is, should be displayed only by the applications that have registered it. + - %TRUE if the new item was successfully added to the + %TRUE if the new item was successfully added to the recently used resources list, %FALSE otherwise - a `GtkRecentManager` + a `GtkRecentManager` - a valid URI + a valid URI - metadata of the resource + metadata of the resource - Adds a new resource, pointed by @uri, into the recently used + Adds a new resource, pointed by @uri, into the recently used resources list. This function automatically retrieves some of the needed @@ -67924,26 +71356,28 @@ it then feeds the data to [method@Gtk.RecentManager.add_full]. See [method@Gtk.RecentManager.add_full] if you want to explicitly define the metadata for the resource pointed by @uri. + - %TRUE if the new item was successfully added + %TRUE if the new item was successfully added to the recently used resources list - a `GtkRecentManager` + a `GtkRecentManager` - a valid URI + a valid URI - Gets the list of recently used resources. + Gets the list of recently used resources. + - a list of + a list of newly allocated `GtkRecentInfo objects`. Use [method@Gtk.RecentInfo.unref] on each item inside the list, and then free the list itself using g_list_free(). @@ -67953,35 +71387,37 @@ define the metadata for the resource pointed by @uri. - a `GtkRecentManager` + a `GtkRecentManager` - Checks whether there is a recently used resource registered + Checks whether there is a recently used resource registered with @uri inside the recent manager. + - %TRUE if the resource was found, %FALSE otherwise + %TRUE if the resource was found, %FALSE otherwise - a `GtkRecentManager` + a `GtkRecentManager` - a URI + a URI - Searches for a URI inside the recently used resources list, and + Searches for a URI inside the recently used resources list, and returns a `GtkRecentInfo` containing information about the resource like its MIME type, or its display name. + - a `GtkRecentInfo` containing information + a `GtkRecentInfo` containing information about the resource pointed by @uri, or %NULL if the URI was not registered in the recently used resources list. Free with [method@Gtk.RecentInfo.unref]. @@ -67989,80 +71425,83 @@ like its MIME type, or its display name. - a `GtkRecentManager` + a `GtkRecentManager` - a URI + a URI - Changes the location of a recently used resource from @uri to @new_uri. + Changes the location of a recently used resource from @uri to @new_uri. Please note that this function will not affect the resource pointed by the URIs, but only the URI used in the recently used resources list. + - %TRUE on success + %TRUE on success - a `GtkRecentManager` + a `GtkRecentManager` - the URI of a recently used resource + the URI of a recently used resource - the new URI of the recently used resource, or + the new URI of the recently used resource, or %NULL to remove the item pointed by @uri in the list - Purges every item from the recently used resources list. + Purges every item from the recently used resources list. + - the number of items that have been removed from the + the number of items that have been removed from the recently used resources list - a `GtkRecentManager` + a `GtkRecentManager` - Removes a resource pointed by @uri from the recently used resources + Removes a resource pointed by @uri from the recently used resources list handled by a recent manager. + - %TRUE if the item pointed by @uri has been successfully + %TRUE if the item pointed by @uri has been successfully removed by the recently used resources list, and %FALSE otherwise - a `GtkRecentManager` + a `GtkRecentManager` - the URI of the item you wish to remove + the URI of the item you wish to remove - The full path to the file to be used to store and read the + The full path to the file to be used to store and read the recently used resources list - The size of the recently used resources list. + The size of the recently used resources list. @@ -68072,7 +71511,7 @@ recently used resources list - Emitted when the current recently used resources manager changes + Emitted when the current recently used resources manager changes its contents. This can happen either by calling [method@Gtk.RecentManager.add_item] @@ -68083,12 +71522,14 @@ or by another application. - `GtkRecentManagerClass` contains only private data. + `GtkRecentManagerClass` contains only private data. + + @@ -68101,6 +71542,7 @@ or by another application. + @@ -68108,6 +71550,7 @@ or by another application. + @@ -68115,6 +71558,7 @@ or by another application. + @@ -68122,6 +71566,7 @@ or by another application. + @@ -68129,32 +71574,32 @@ or by another application. - Error codes for `GtkRecentManager` operations + Error codes for `GtkRecentManager` operations - the URI specified does not exists in + the URI specified does not exists in the recently used resources list. - the URI specified is not valid. + the URI specified is not valid. - the supplied string is not + the supplied string is not UTF-8 encoded. - no application has registered + no application has registered the specified item. - failure while reading the recently used + failure while reading the recently used resources file. - failure while writing the recently used + failure while writing the recently used resources file. - unspecified error. + unspecified error. @@ -68162,115 +71607,122 @@ or by another application. - + + + - Represents a request of a screen object in a given orientation. These + Represents a request of a screen object in a given orientation. These are primarily used in container implementations when allocating a natural size for children calling. See gtk_distribute_natural_allocation(). + - A client pointer + A client pointer - The minimum size needed for allocation in a given orientation + The minimum size needed for allocation in a given orientation - The natural size for allocation in a given orientation + The natural size for allocation in a given orientation - A `GtkRequisition` represents the desired size of a widget. See + A `GtkRequisition` represents the desired size of a widget. See [GtkWidget’s geometry management section][geometry-management] for more information. + - the widget’s desired width + the widget’s desired width - the widget’s desired height + the widget’s desired height - Allocates a new `GtkRequisition`. + Allocates a new `GtkRequisition`. The struct is initialized to zero. + - a new empty `GtkRequisition`. The newly + a new empty `GtkRequisition`. The newly allocated `GtkRequisition` should be freed with [method@Gtk.Requisition.free] - Copies a `GtkRequisition`. + Copies a `GtkRequisition`. + - a copy of @requisition + a copy of @requisition - a `GtkRequisition` + a `GtkRequisition` - Frees a `GtkRequisition`. + Frees a `GtkRequisition`. + - a `GtkRequisition` + a `GtkRequisition` - Predefined values for use as response ids in gtk_dialog_add_button(). + Predefined values for use as response ids in gtk_dialog_add_button(). All predefined values are negative; GTK leaves values of 0 or greater for application-defined response ids. - Returned if an action widget has no response id, + Returned if an action widget has no response id, or if the dialog gets programmatically hidden or destroyed - Generic response id, not used by GTK dialogs + Generic response id, not used by GTK dialogs - Generic response id, not used by GTK dialogs + Generic response id, not used by GTK dialogs - Returned if the dialog is deleted + Returned if the dialog is deleted - Returned by OK buttons in GTK dialogs + Returned by OK buttons in GTK dialogs - Returned by Cancel buttons in GTK dialogs + Returned by Cancel buttons in GTK dialogs - Returned by Close buttons in GTK dialogs + Returned by Close buttons in GTK dialogs - Returned by Yes buttons in GTK dialogs + Returned by Yes buttons in GTK dialogs - Returned by No buttons in GTK dialogs + Returned by No buttons in GTK dialogs - Returned by Apply buttons in GTK dialogs + Returned by Apply buttons in GTK dialogs - Returned by Help buttons in GTK dialogs + Returned by Help buttons in GTK dialogs - A `GtkRevealer` animates the transition of its child from invisible to visible. + A `GtkRevealer` animates the transition of its child from invisible to visible. The style of transition can be controlled with [method@Gtk.Revealer.set_transition_type]. @@ -68295,162 +71747,172 @@ tree, regardless of the state of the revealer widget. - Creates a new `GtkRevealer`. + Creates a new `GtkRevealer`. + - a newly created `GtkRevealer` + a newly created `GtkRevealer` - Gets the child widget of @revealer. + Gets the child widget of @revealer. + - the child widget of @revealer + the child widget of @revealer - a `GtkRevealer` + a `GtkRevealer` - Returns whether the child is fully revealed. + Returns whether the child is fully revealed. In other words, this returns whether the transition to the revealed state is completed. + - %TRUE if the child is fully revealed + %TRUE if the child is fully revealed - a `GtkRevealer` + a `GtkRevealer` - Returns whether the child is currently revealed. + Returns whether the child is currently revealed. This function returns %TRUE as soon as the transition is to the revealed state is started. To learn whether the child is fully revealed (ie the transition is completed), use [method@Gtk.Revealer.get_child_revealed]. + - %TRUE if the child is revealed. + %TRUE if the child is revealed. - a `GtkRevealer` + a `GtkRevealer` - Returns the amount of time (in milliseconds) that + Returns the amount of time (in milliseconds) that transitions will take. + - the transition duration + the transition duration - a `GtkRevealer` + a `GtkRevealer` - Gets the type of animation that will be used + Gets the type of animation that will be used for transitions in @revealer. + - the current transition type of @revealer + the current transition type of @revealer - a `GtkRevealer` + a `GtkRevealer` - Sets the child widget of @revealer. + Sets the child widget of @revealer. + - a `GtkRevealer` + a `GtkRevealer` - the child widget + the child widget - Tells the `GtkRevealer` to reveal or conceal its child. + Tells the `GtkRevealer` to reveal or conceal its child. The transition will be animated with the current transition type of @revealer. + - a `GtkRevealer` + a `GtkRevealer` - %TRUE to reveal the child + %TRUE to reveal the child - Sets the duration that transitions will take. + Sets the duration that transitions will take. + - a `GtkRevealer` + a `GtkRevealer` - the new duration, in milliseconds + the new duration, in milliseconds - Sets the type of animation that will be used for + Sets the type of animation that will be used for transitions in @revealer. Available types include various kinds of fades and slides. + - a `GtkRevealer` + a `GtkRevealer` - the new transition type + the new transition type @@ -68458,69 +71920,69 @@ Available types include various kinds of fades and slides. - The child widget. + The child widget. - Whether the child is revealed and the animation target reached. + Whether the child is revealed and the animation target reached. - Whether the revealer should reveal the child. + Whether the revealer should reveal the child. - The animation duration, in milliseconds. + The animation duration, in milliseconds. - The type of animation used to transition. + The type of animation used to transition. - These enumeration values describe the possible transitions + These enumeration values describe the possible transitions when the child of a `GtkRevealer` widget is shown or hidden. - No transition + No transition - Fade in + Fade in - Slide in from the left + Slide in from the left - Slide in from the right + Slide in from the right - Slide in from the bottom + Slide in from the bottom - Slide in from the top + Slide in from the top - Floop in from the left + Floop in from the left - Floop in from the right + Floop in from the right - Floop in from the bottom + Floop in from the bottom - Floop in from the top + Floop in from the top - `GtkRoot` is the interface implemented by all widgets that can act as a toplevel + `GtkRoot` is the interface implemented by all widgets that can act as a toplevel widget. The root widget takes care of providing the connection to the windowing system @@ -68533,41 +71995,44 @@ To get the display to which a `GtkRoot` belongs, use `GtkRoot` also maintains the location of keyboard focus inside its widget hierarchy, with [method@Gtk.Root.set_focus] and [method@Gtk.Root.get_focus]. + - Returns the display that this `GtkRoot` is on. + Returns the display that this `GtkRoot` is on. + - the display of @root + the display of @root - a `GtkRoot` + a `GtkRoot` - Retrieves the current focused widget within the root. + Retrieves the current focused widget within the root. Note that this is the widget that would have the focus if the root is active; if the root is not focused then `gtk_widget_has_focus (widget)` will be %FALSE for the widget. + - the currently focused widget + the currently focused widget - a `GtkRoot` + a `GtkRoot` - If @focus is not the current focus widget, and is focusable, sets + If @focus is not the current focus widget, and is focusable, sets it as the focus widget for the root. If @focus is %NULL, unsets the focus widget for the root. @@ -68575,295 +72040,342 @@ If @focus is %NULL, unsets the focus widget for the root. To set the focus to a particular widget in the root, it is usually more convenient to use [method@Gtk.Widget.grab_focus] instead of this function. + - a `GtkRoot` + a `GtkRoot` - widget to be the new focus widget, or %NULL + widget to be the new focus widget, or %NULL to unset the focus widget - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - A priority that can be used when adding a `GtkStyleProvider` + A priority that can be used when adding a `GtkStyleProvider` for application-specific style information. + - The priority used for default style information + The priority used for default style information that is used in the absence of themes. Note that this is not very useful for providing default styling for custom style classes - themes are likely to override styling provided at this priority with catch-all `* {...}` rules. + - The priority used for style information provided + The priority used for style information provided via `GtkSettings`. This priority is higher than %GTK_STYLE_PROVIDER_PRIORITY_THEME to let settings override themes. + - The priority used for style information provided + The priority used for style information provided by themes. + - The priority used for the style information from + The priority used for the style information from `$XDG_CONFIG_HOME/gtk-4.0/gtk.css`. You should not use priorities higher than this, to give the user the last word. + + - A `GtkScale` is a slider control used to select a numeric value. + A `GtkScale` is a slider control used to select a numeric value. ![An example GtkScale](scales.png) @@ -68943,30 +72455,32 @@ classes similar to the marks node. # Accessibility `GtkScale` uses the %GTK_ACCESSIBLE_ROLE_SLIDER role. + - Creates a new `GtkScale`. + Creates a new `GtkScale`. + - a new `GtkScale` + a new `GtkScale` - the scale’s orientation. + the scale’s orientation. - the [class@Gtk.Adjustment] which sets + the [class@Gtk.Adjustment] which sets the range of the scale, or %NULL to create a new adjustment. - Creates a new scale widget with a range from @min to @max. + Creates a new scale widget with a range from @min to @max. The returns scale will have the given orientation and will let the user input a number between @min and @max (including @min and @max) @@ -68977,31 +72491,32 @@ value. Note that the way in which the precision is derived works best if @step is a power of ten. If the resulting precision is not suitable for your needs, use [method@Gtk.Scale.set_digits] to correct it. + - a new `GtkScale` + a new `GtkScale` - the scale’s orientation. + the scale’s orientation. - minimum value + minimum value - maximum value + maximum value - step increment (tick size) used with keyboard shortcuts + step increment (tick size) used with keyboard shortcuts - Obtains the coordinates where the scale will draw the + Obtains the coordinates where the scale will draw the `PangoLayout` representing the text in the scale. Remember when using the `PangoLayout` function you need to @@ -69009,26 +72524,27 @@ convert to and from pixels using `PANGO_PIXELS()` or `PANGO_SCALE`. If the [property@GtkScale:draw-value] property is %FALSE, the return values are undefined. + - a `GtkScale` + a `GtkScale` - location to store X offset of layout + location to store X offset of layout - location to store Y offset of layout + location to store Y offset of layout - Adds a mark at @value. + Adds a mark at @value. A mark is indicated visually by drawing a tick mark next to the scale, and GTK makes it easy for the user to position the scale exactly at the @@ -69037,107 +72553,113 @@ marks value. If @markup is not %NULL, text is shown next to the tick mark. To remove marks from a scale, use [method@Gtk.Scale.clear_marks]. + - a `GtkScale` + a `GtkScale` - the value at which the mark is placed, must be between + the value at which the mark is placed, must be between the lower and upper limits of the scales’ adjustment - where to draw the mark. For a horizontal scale, %GTK_POS_TOP + where to draw the mark. For a horizontal scale, %GTK_POS_TOP and %GTK_POS_LEFT are drawn above the scale, anything else below. For a vertical scale, %GTK_POS_LEFT and %GTK_POS_TOP are drawn to the left of the scale, anything else to the right. - Text to be shown at the mark, using Pango markup + Text to be shown at the mark, using Pango markup - Removes any marks that have been added. + Removes any marks that have been added. + - a `GtkScale` + a `GtkScale` - Gets the number of decimal places that are displayed in the value. + Gets the number of decimal places that are displayed in the value. + - the number of decimal places that are displayed + the number of decimal places that are displayed - a `GtkScale` + a `GtkScale` - Returns whether the current value is displayed as a string + Returns whether the current value is displayed as a string next to the slider. + - whether the current value is displayed as a string + whether the current value is displayed as a string - a `GtkScale` + a `GtkScale` - Returns whether the scale has an origin. + Returns whether the scale has an origin. + - %TRUE if the scale has an origin. + %TRUE if the scale has an origin. - a `GtkScale` + a `GtkScale` - Gets the `PangoLayout` used to display the scale. + Gets the `PangoLayout` used to display the scale. The returned object is owned by the scale so does not need to be freed by the caller. + - the [class@Pango.Layout] + the [class@Pango.Layout] for this scale, or %NULL if the [property@GtkScale:draw-value] property is %FALSE. - A `GtkScale` + A `GtkScale` - Obtains the coordinates where the scale will draw the + Obtains the coordinates where the scale will draw the `PangoLayout` representing the text in the scale. Remember when using the `PangoLayout` function you need to @@ -69145,41 +72667,43 @@ convert to and from pixels using `PANGO_PIXELS()` or `PANGO_SCALE`. If the [property@GtkScale:draw-value] property is %FALSE, the return values are undefined. + - a `GtkScale` + a `GtkScale` - location to store X offset of layout + location to store X offset of layout - location to store Y offset of layout + location to store Y offset of layout - Gets the position in which the current value is displayed. + Gets the position in which the current value is displayed. + - the position in which the current value is displayed + the position in which the current value is displayed - a `GtkScale` + a `GtkScale` - Sets the number of decimal places that are displayed in the value. + Sets the number of decimal places that are displayed in the value. Also causes the value of the adjustment to be rounded to this number of digits, so the retrieved value matches the displayed one, if @@ -69191,16 +72715,17 @@ Note that rounding to a small number of digits can interfere with the smooth autoscrolling that is built into `GtkScale`. As an alternative, you can use [method@Gtk.Scale.set_format_value_func] to format the displayed value yourself. + - a `GtkScale` + a `GtkScale` - the number of decimal places to display, + the number of decimal places to display, e.g. use 1 to display 1.0, 2 to display 1.00, etc @@ -69208,24 +72733,25 @@ value yourself. - Specifies whether the current value is displayed as a string next + Specifies whether the current value is displayed as a string next to the slider. + - a `GtkScale` + a `GtkScale` - %TRUE to draw the value + %TRUE to draw the value - @func allows you to change how the scale value is displayed. + @func allows you to change how the scale value is displayed. The given function will return an allocated string representing @value. That string will then be used to display the scale's value. @@ -69233,62 +72759,65 @@ The given function will return an allocated string representing If #NULL is passed as @func, the value will be displayed on its own, rounded according to the value of the [property@GtkScale:digits] property. + - a `GtkScale` + a `GtkScale` - function that formats the value + function that formats the value - user data to pass to @func + user data to pass to @func - destroy function for @user_data + destroy function for @user_data - Sets whether the scale has an origin. + Sets whether the scale has an origin. If [property@GtkScale:has-origin] is set to %TRUE (the default), the scale will highlight the part of the trough between the origin (bottom or left side) and the current value. + - a `GtkScale` + a `GtkScale` - %TRUE if the scale has an origin + %TRUE if the scale has an origin - Sets the position in which the current value is displayed. + Sets the position in which the current value is displayed. + - a `GtkScale` + a `GtkScale` - the position in which the current value is displayed + the position in which the current value is displayed @@ -69296,25 +72825,25 @@ the scale will highlight the part of the trough between the origin - The number of decimal places that are displayed in the value. + The number of decimal places that are displayed in the value. - Whether the current value is displayed as a string next to the slider. + Whether the current value is displayed as a string next to the slider. - Whether the scale has an origin. + Whether the scale has an origin. - The position in which the current value is displayed. + The position in which the current value is displayed. @@ -69322,7 +72851,7 @@ the scale will highlight the part of the trough between the origin - `GtkScaleButton` provides a button which pops up a scale widget. + `GtkScaleButton` provides a button which pops up a scale widget. This kind of widget is commonly used for volume controls in multimedia applications, and GTK provides a [class@Gtk.VolumeButton] subclass that @@ -69332,35 +72861,37 @@ is tailored for this use case. `GtkScaleButton` has a single CSS node with name button. To differentiate it from a plain `GtkButton`, it gets the .scale style class. + - Creates a `GtkScaleButton`. + Creates a `GtkScaleButton`. The new scale button has a range between @min and @max, with a stepping of @step. + - a new `GtkScaleButton` + a new `GtkScaleButton` - the minimum value of the scale (usually 0) + the minimum value of the scale (usually 0) - the maximum value of the scale (usually 100) + the maximum value of the scale (usually 100) - the stepping of value when a scroll-wheel event, + the stepping of value when a scroll-wheel event, or up/down arrow event occurs (usually 2) - a %NULL-terminated + a %NULL-terminated array of icon names, or %NULL if you want to set the list later with gtk_scale_button_set_icons() @@ -69370,6 +72901,7 @@ with a stepping of @step. + @@ -69384,108 +72916,115 @@ with a stepping of @step. - Gets the `GtkAdjustment` associated with the `GtkScaleButton`’s scale. + Gets the `GtkAdjustment` associated with the `GtkScaleButton`’s scale. See [method@Gtk.Range.get_adjustment] for details. + - the adjustment associated with the scale + the adjustment associated with the scale - a `GtkScaleButton` + a `GtkScaleButton` - Retrieves the minus button of the `GtkScaleButton`. + Retrieves the minus button of the `GtkScaleButton`. + - the minus button + the minus button of the `GtkScaleButton` - a `GtkScaleButton` + a `GtkScaleButton` - Retrieves the plus button of the `GtkScaleButton.` + Retrieves the plus button of the `GtkScaleButton.` + - the plus button + the plus button of the `GtkScaleButton` - a `GtkScaleButton` + a `GtkScaleButton` - Retrieves the popup of the `GtkScaleButton`. + Retrieves the popup of the `GtkScaleButton`. + - the popup of the `GtkScaleButton` + the popup of the `GtkScaleButton` - a `GtkScaleButton` + a `GtkScaleButton` - Gets the current value of the scale button. + Gets the current value of the scale button. + - current value of the scale button + current value of the scale button - a `GtkScaleButton` + a `GtkScaleButton` - Sets the `GtkAdjustment` to be used as a model + Sets the `GtkAdjustment` to be used as a model for the `GtkScaleButton`’s scale. See [method@Gtk.Range.set_adjustment] for details. + - a `GtkScaleButton` + a `GtkScaleButton` - a `GtkAdjustment` + a `GtkAdjustment` - Sets the icons to be used by the scale button. + Sets the icons to be used by the scale button. + - a `GtkScaleButton` + a `GtkScaleButton` - a %NULL-terminated array of icon names + a %NULL-terminated array of icon names @@ -69494,23 +73033,24 @@ See [method@Gtk.Range.set_adjustment] for details. - Sets the current value of the scale. + Sets the current value of the scale. If the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The scale button emits the [signal@Gtk.ScaleButton::value-changed] signal if the value changes. + - a `GtkScaleButton` + a `GtkScaleButton` - new value of the scale button + new value of the scale button @@ -69518,12 +73058,12 @@ signal if the value changes. - The `GtkAdjustment` that is used as the model. + The `GtkAdjustment` that is used as the model. - The names of the icons to be used by the scale button. + The names of the icons to be used by the scale button. The first item in the array will be used in the button when the current value is the lowest value, the second @@ -69546,14 +73086,14 @@ better for the users. - The value of the scale. + The value of the scale. - Emitted to dismiss the popup. + Emitted to dismiss the popup. This is a [keybinding signal](class.SignalAction.html). @@ -69563,7 +73103,7 @@ The default binding for this signal is <kbd>Escape</kbd>. - Emitted to popup the scale widget. + Emitted to popup the scale widget. This is a [keybinding signal](class.SignalAction.html). @@ -69574,24 +73114,26 @@ The default bindings for this signal are <kbd>Space</kbd>, - Emitted when the value field has changed. + Emitted when the value field has changed. - the new value + the new value + + @@ -69612,25 +73154,27 @@ The default bindings for this signal are <kbd>Space</kbd>, + + - a `GtkScale` + a `GtkScale` - location to store X offset of layout + location to store X offset of layout - location to store Y offset of layout + location to store Y offset of layout @@ -69643,100 +73187,101 @@ The default bindings for this signal are <kbd>Space</kbd>, + - A newly allocated string describing a textual representation + A newly allocated string describing a textual representation of the given numerical value. - The `GtkScale` + The `GtkScale` - The numeric value to format + The numeric value to format - user data + user data - Passed as argument to various keybinding signals. + Passed as argument to various keybinding signals. - Scroll in steps. + Scroll in steps. - Scroll by pages. + Scroll by pages. - Scroll to ends. + Scroll to ends. - Scroll in horizontal steps. + Scroll in horizontal steps. - Scroll by horizontal pages. + Scroll by horizontal pages. - Scroll to the horizontal ends. + Scroll to the horizontal ends. - Scrolling types. + Scrolling types. - No scrolling. + No scrolling. - Jump to new location. + Jump to new location. - Step backward. + Step backward. - Step forward. + Step forward. - Page backward. + Page backward. - Page forward. + Page forward. - Step up. + Step up. - Step down. + Step down. - Page up. + Page up. - Page down. + Page down. - Step to the left. + Step to the left. - Step to the right. + Step to the right. - Page to the left. + Page to the left. - Page to the right. + Page to the right. - Scroll to start. + Scroll to start. - Scroll to end. + Scroll to end. - `GtkScrollable` is an interface for widgets with native scrolling ability. + `GtkScrollable` is an interface for widgets with native scrolling ability. To implement this interface you should override the [property@Gtk.Scrollable:hadjustment] and @@ -69765,176 +73310,187 @@ All scrollable widgets should do the following. - When any of the adjustments emits the [signal@Gtk.Adjustment::value-changed] signal, the scrollable widget should scroll its contents. + - Returns the size of a non-scrolling border around the + Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK can use this information to display overlaid graphics, like the overshoot indication, at the right position. + - %TRUE if @border has been set + %TRUE if @border has been set - a `GtkScrollable` + a `GtkScrollable` - return location for the results + return location for the results - Returns the size of a non-scrolling border around the + Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK can use this information to display overlaid graphics, like the overshoot indication, at the right position. + - %TRUE if @border has been set + %TRUE if @border has been set - a `GtkScrollable` + a `GtkScrollable` - return location for the results + return location for the results - Retrieves the `GtkAdjustment` used for horizontal scrolling. + Retrieves the `GtkAdjustment` used for horizontal scrolling. + - horizontal `GtkAdjustment`. + horizontal `GtkAdjustment`. - a `GtkScrollable` + a `GtkScrollable` - Gets the horizontal `GtkScrollablePolicy`. + Gets the horizontal `GtkScrollablePolicy`. + - The horizontal `GtkScrollablePolicy`. + The horizontal `GtkScrollablePolicy`. - a `GtkScrollable` + a `GtkScrollable` - Retrieves the `GtkAdjustment` used for vertical scrolling. + Retrieves the `GtkAdjustment` used for vertical scrolling. + - vertical `GtkAdjustment`. + vertical `GtkAdjustment`. - a `GtkScrollable` + a `GtkScrollable` - Gets the vertical `GtkScrollablePolicy`. + Gets the vertical `GtkScrollablePolicy`. + - The vertical `GtkScrollablePolicy`. + The vertical `GtkScrollablePolicy`. - a `GtkScrollable` + a `GtkScrollable` - Sets the horizontal adjustment of the `GtkScrollable`. + Sets the horizontal adjustment of the `GtkScrollable`. + - a `GtkScrollable` + a `GtkScrollable` - a `GtkAdjustment` + a `GtkAdjustment` - Sets the `GtkScrollablePolicy`. + Sets the `GtkScrollablePolicy`. The policy determines whether horizontal scrolling should start below the minimum width or below the natural width. + - a `GtkScrollable` + a `GtkScrollable` - the horizontal `GtkScrollablePolicy` + the horizontal `GtkScrollablePolicy` - Sets the vertical adjustment of the `GtkScrollable`. + Sets the vertical adjustment of the `GtkScrollable`. + - a `GtkScrollable` + a `GtkScrollable` - a `GtkAdjustment` + a `GtkAdjustment` - Sets the `GtkScrollablePolicy`. + Sets the `GtkScrollablePolicy`. The policy determines whether vertical scrolling should start below the minimum height or below the natural height. + - a `GtkScrollable` + a `GtkScrollable` - the vertical `GtkScrollablePolicy` + the vertical `GtkScrollablePolicy` @@ -69942,7 +73498,7 @@ below the minimum height or below the natural height. - Horizontal `GtkAdjustment` of the scrollable widget. + Horizontal `GtkAdjustment` of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. @@ -69950,13 +73506,13 @@ This adjustment is shared between the scrollable widget and its parent. - Determines when horizontal scrolling should start. + Determines when horizontal scrolling should start. - Vertical `GtkAdjustment` of the scrollable widget. + Vertical `GtkAdjustment` of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. @@ -69964,27 +73520,29 @@ This adjustment is shared between the scrollable widget and its parent. - Determines when vertical scrolling should start. + Determines when vertical scrolling should start. + + - %TRUE if @border has been set + %TRUE if @border has been set - a `GtkScrollable` + a `GtkScrollable` - return location for the results + return location for the results @@ -69992,17 +73550,17 @@ This adjustment is shared between the scrollable widget and its parent. - Defines the policy to be used in a scrollable widget when updating + Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation. - Scrollable adjustments are based on the minimum size + Scrollable adjustments are based on the minimum size - Scrollable adjustments are based on the natural size + Scrollable adjustments are based on the natural size - The `GtkScrollbar` widget is a horizontal or vertical scrollbar. + The `GtkScrollbar` widget is a horizontal or vertical scrollbar. ![An example GtkScrollbar](scrollbar.png) @@ -70049,18 +73607,19 @@ Other style classes that may be added to scrollbars inside - Creates a new scrollbar with the given orientation. + Creates a new scrollbar with the given orientation. + - the new `GtkScrollbar`. + the new `GtkScrollbar`. - the scrollbar’s orientation. + the scrollbar’s orientation. - the [class@Gtk.Adjustment] to use, or %NULL + the [class@Gtk.Adjustment] to use, or %NULL to create a new adjustment. @@ -70068,31 +73627,33 @@ Other style classes that may be added to scrollbars inside - Returns the scrollbar's adjustment. + Returns the scrollbar's adjustment. + - the scrollbar's adjustment + the scrollbar's adjustment - a `GtkScrollbar` + a `GtkScrollbar` - Makes the scrollbar use the given adjustment. + Makes the scrollbar use the given adjustment. + - a `GtkScrollbar` + a `GtkScrollbar` - the adjustment to set + the adjustment to set @@ -70100,12 +73661,12 @@ Other style classes that may be added to scrollbars inside - The `GtkAdjustment` controlled by this scrollbar. + The `GtkAdjustment` controlled by this scrollbar. - `GtkScrolledWindow` is a container that makes its child scrollable. + `GtkScrolledWindow` is a container that makes its child scrollable. It does so using either internally added scrollbars or externally associated adjustments, and optionally draws a frame around the child. @@ -70192,188 +73753,201 @@ with a subnode named junction. - Creates a new scrolled window. + Creates a new scrolled window. + - a new scrolled window + a new scrolled window - Gets the child widget of @scrolled_window. + Gets the child widget of @scrolled_window. + - the child widget of @scrolled_window + the child widget of @scrolled_window - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the horizontal scrollbar’s adjustment. + Returns the horizontal scrollbar’s adjustment. This is the adjustment used to connect the horizontal scrollbar to the child widget’s horizontal scroll functionality. + - the horizontal `GtkAdjustment` + the horizontal `GtkAdjustment` - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Gets whether the scrolled window draws a frame. + Gets whether the scrolled window draws a frame. + - %TRUE if the @scrolled_window has a frame + %TRUE if the @scrolled_window has a frame - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the horizontal scrollbar of @scrolled_window. + Returns the horizontal scrollbar of @scrolled_window. + - the horizontal scrollbar of the scrolled window. + the horizontal scrollbar of the scrolled window. - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the specified kinetic scrolling behavior. + Returns the specified kinetic scrolling behavior. + - the scrolling behavior flags. + the scrolling behavior flags. - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the maximum content height set. + Returns the maximum content height set. + - the maximum content height, or -1 + the maximum content height, or -1 - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the maximum content width set. + Returns the maximum content width set. + - the maximum content width, or -1 + the maximum content width, or -1 - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Gets the minimal content height of @scrolled_window. + Gets the minimal content height of @scrolled_window. + - the minimal content height + the minimal content height - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Gets the minimum content width of @scrolled_window. + Gets the minimum content width of @scrolled_window. + - the minimum content width + the minimum content width - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns whether overlay scrolling is enabled for this scrolled window. + Returns whether overlay scrolling is enabled for this scrolled window. + - %TRUE if overlay scrolling is enabled + %TRUE if overlay scrolling is enabled - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Gets the placement of the contents with respect to the scrollbars. + Gets the placement of the contents with respect to the scrollbars. + - the current placement value. + the current placement value. - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Retrieves the current policy values for the horizontal and vertical + Retrieves the current policy values for the horizontal and vertical scrollbars. See [method@Gtk.ScrolledWindow.set_policy]. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - location to store the policy + location to store the policy for the horizontal scrollbar - location to store the policy + location to store the policy for the vertical scrollbar @@ -70381,247 +73955,260 @@ See [method@Gtk.ScrolledWindow.set_policy]. - Reports whether the natural height of the child will be calculated + Reports whether the natural height of the child will be calculated and propagated through the scrolled window’s requested natural height. + - whether natural height propagation is enabled. + whether natural height propagation is enabled. - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Reports whether the natural width of the child will be calculated + Reports whether the natural width of the child will be calculated and propagated through the scrolled window’s requested natural width. + - whether natural width propagation is enabled. + whether natural width propagation is enabled. - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the vertical scrollbar’s adjustment. + Returns the vertical scrollbar’s adjustment. This is the adjustment used to connect the vertical scrollbar to the child widget’s vertical scroll functionality. + - the vertical `GtkAdjustment` + the vertical `GtkAdjustment` - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Returns the vertical scrollbar of @scrolled_window. + Returns the vertical scrollbar of @scrolled_window. + - the vertical scrollbar of the scrolled window. + the vertical scrollbar of the scrolled window. - a `GtkScrolledWindow` + a `GtkScrolledWindow` - Sets the child widget of @scrolled_window. + Sets the child widget of @scrolled_window. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the child widget + the child widget - Sets the `GtkAdjustment` for the horizontal scrollbar. + Sets the `GtkAdjustment` for the horizontal scrollbar. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the `GtkAdjustment` to use, or %NULL to create a new one + the `GtkAdjustment` to use, or %NULL to create a new one - Changes the frame drawn around the contents of @scrolled_window. + Changes the frame drawn around the contents of @scrolled_window. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - whether to draw a frame around scrolled window contents + whether to draw a frame around scrolled window contents - Turns kinetic scrolling on or off. + Turns kinetic scrolling on or off. Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - %TRUE to enable kinetic scrolling + %TRUE to enable kinetic scrolling - Sets the maximum height that @scrolled_window should keep visible. + Sets the maximum height that @scrolled_window should keep visible. The @scrolled_window will grow up to this height before it starts scrolling the content. It is a programming error to set the maximum content height to a value smaller than [property@Gtk.ScrolledWindow:min-content-height]. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the maximum content height + the maximum content height - Sets the maximum width that @scrolled_window should keep visible. + Sets the maximum width that @scrolled_window should keep visible. The @scrolled_window will grow up to this width before it starts scrolling the content. It is a programming error to set the maximum content width to a value smaller than [property@Gtk.ScrolledWindow:min-content-width]. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the maximum content width + the maximum content width - Sets the minimum height that @scrolled_window should keep visible. + Sets the minimum height that @scrolled_window should keep visible. Note that this can and (usually will) be smaller than the minimum size of the content. It is a programming error to set the minimum content height to a value greater than [property@Gtk.ScrolledWindow:max-content-height]. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the minimal content height + the minimal content height - Sets the minimum width that @scrolled_window should keep visible. + Sets the minimum width that @scrolled_window should keep visible. Note that this can and (usually will) be smaller than the minimum size of the content. It is a programming error to set the minimum content width to a value greater than [property@Gtk.ScrolledWindow:max-content-width]. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the minimal content width + the minimal content width - Enables or disables overlay scrolling for this scrolled window. + Enables or disables overlay scrolling for this scrolled window. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - whether to enable overlay scrolling + whether to enable overlay scrolling - Sets the placement of the contents with respect to the scrollbars + Sets the placement of the contents with respect to the scrollbars for the scrolled window. The default is %GTK_CORNER_TOP_LEFT, meaning the child is @@ -70631,22 +74218,23 @@ Other values in [enum@Gtk.CornerType] are %GTK_CORNER_TOP_RIGHT, See also [method@Gtk.ScrolledWindow.get_placement] and [method@Gtk.ScrolledWindow.unset_placement]. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - position of the child window + position of the child window - Sets the scrollbar policy for the horizontal and vertical scrollbars. + Sets the scrollbar policy for the horizontal and vertical scrollbars. The policy determines when the scrollbar should appear; it is a value from the [enum@Gtk.PolicyType] enumeration. If %GTK_POLICY_ALWAYS, the @@ -70654,88 +74242,93 @@ scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only if needed (that is, if the slider part of the bar would be smaller than the trough — the display is larger than the page size). + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - policy for horizontal bar + policy for horizontal bar - policy for vertical bar + policy for vertical bar - Sets whether the natural height of the child should be calculated + Sets whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - whether to propagate natural height + whether to propagate natural height - Sets whether the natural width of the child should be calculated + Sets whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - whether to propagate natural width + whether to propagate natural width - Sets the `GtkAdjustment` for the vertical scrollbar. + Sets the `GtkAdjustment` for the vertical scrollbar. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` - the `GtkAdjustment` to use, or %NULL to create a new one + the `GtkAdjustment` to use, or %NULL to create a new one - Unsets the placement of the contents with respect to the scrollbars. + Unsets the placement of the contents with respect to the scrollbars. If no window placement is set for a scrolled window, it defaults to %GTK_CORNER_TOP_LEFT. + - a `GtkScrolledWindow` + a `GtkScrolledWindow` @@ -70743,7 +74336,7 @@ it defaults to %GTK_CORNER_TOP_LEFT. - The child widget. + The child widget. @@ -70752,11 +74345,11 @@ it defaults to %GTK_CORNER_TOP_LEFT. - Whether to draw a frame around the contents. + Whether to draw a frame around the contents. - When the horizontal scrollbar is displayed. + When the horizontal scrollbar is displayed. Use [method@Gtk.ScrolledWindow.set_policy] to set this property. @@ -70765,7 +74358,7 @@ this property. - Whether kinetic scrolling is enabled or not. + Whether kinetic scrolling is enabled or not. Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN. @@ -70773,31 +74366,31 @@ Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN. - The maximum content height of @scrolled_window. + The maximum content height of @scrolled_window. - The maximum content width of @scrolled_window. + The maximum content width of @scrolled_window. - The minimum content height of @scrolled_window. + The minimum content height of @scrolled_window. - The minimum content width of @scrolled_window. + The minimum content width of @scrolled_window. - Whether overlay scrolling is enabled or not. + Whether overlay scrolling is enabled or not. If it is, the scrollbars are only added as traditional widgets when a mouse is present. Otherwise, they are overlaid on top of @@ -70810,7 +74403,7 @@ the [property@Gtk.Settings:gtk-overlay-scrolling] setting. - Whether the natural height of the child should be calculated and propagated + Whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height. This is useful in cases where an attempt should be made to allocate exactly @@ -70820,7 +74413,7 @@ enough space for the natural size of the child. - Whether the natural width of the child should be calculated and propagated + Whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width. This is useful in cases where an attempt should be made to allocate exactly @@ -70831,7 +74424,7 @@ enough space for the natural size of the child. - When the vertical scrollbar is displayed. + When the vertical scrollbar is displayed. Use [method@Gtk.ScrolledWindow.set_policy] to set this property. @@ -70840,11 +74433,11 @@ this property. - Where the contents are located with respect to the scrollbars. + Where the contents are located with respect to the scrollbars. - Emitted whenever user initiated scrolling makes the scrolled + Emitted whenever user initiated scrolling makes the scrolled window firmly surpass the limits defined by the adjustment in that orientation. @@ -70858,13 +74451,13 @@ aware too if intending to provide behavior on horizontal edges. - edge side that was hit + edge side that was hit - Emitted whenever user-initiated scrolling makes the scrolled + Emitted whenever user-initiated scrolling makes the scrolled window exactly reach the lower or upper limits defined by the adjustment in that orientation. @@ -70878,13 +74471,13 @@ aware too if intending to provide behavior on horizontal edges. - edge side that was reached + edge side that was reached - Emitted when focus is moved away from the scrolled window by a + Emitted when focus is moved away from the scrolled window by a keybinding. This is a [keybinding signal](class.SignalAction.html). @@ -70897,14 +74490,14 @@ move backward. - either %GTK_DIR_TAB_FORWARD or + either %GTK_DIR_TAB_FORWARD or %GTK_DIR_TAB_BACKWARD - Emitted when a keybinding that scrolls is pressed. + Emitted when a keybinding that scrolls is pressed. This is a [keybinding signal](class.SignalAction.html). @@ -70915,11 +74508,11 @@ signal that the scrolled window’s child may listen to and scroll itself.< - a `GtkScrollType` describing how much to scroll + a `GtkScrollType` describing how much to scroll - whether the keybinding scrolls the child + whether the keybinding scrolls the child horizontally or not @@ -70927,7 +74520,7 @@ signal that the scrolled window’s child may listen to and scroll itself.< - `GtkSearchBar` is a container made to have a search entry. + `GtkSearchBar` is a container made to have a search entry. ![An example GtkSearchBar](search-bar.png) @@ -70975,112 +74568,119 @@ node which gets the .close style class applied. - Creates a `GtkSearchBar`. + Creates a `GtkSearchBar`. You will need to tell it about which widget is going to be your text entry using [method@Gtk.SearchBar.connect_entry]. + - a new `GtkSearchBar` + a new `GtkSearchBar` - Connects the `GtkEditable widget passed as the one to be used in + Connects the `GtkEditable widget passed as the one to be used in this search bar. The entry should be a descendant of the search bar. Calling this function manually is only required if the entry isn’t the direct child of the search bar (as in our main example). + - a `GtkSearchBar` + a `GtkSearchBar` - a `GtkEditable` + a `GtkEditable` - Gets the child widget of @bar. + Gets the child widget of @bar. + - the child widget of @bar + the child widget of @bar - a `GtkSearchBar` + a `GtkSearchBar` - Gets the widget that @bar is capturing key events from. + Gets the widget that @bar is capturing key events from. + - The key capture widget. + The key capture widget. - a `GtkSearchBar` + a `GtkSearchBar` - Returns whether the search mode is on or off. + Returns whether the search mode is on or off. + - whether search mode is toggled on + whether search mode is toggled on - a `GtkSearchBar` + a `GtkSearchBar` - Returns whether the close button is shown. + Returns whether the close button is shown. + - whether the close button is shown + whether the close button is shown - a `GtkSearchBar` + a `GtkSearchBar` - Sets the child widget of @bar. + Sets the child widget of @bar. + - a `GtkSearchBar` + a `GtkSearchBar` - the child widget + the child widget - Sets @widget as the widget that @bar will capture key events + Sets @widget as the widget that @bar will capture key events from. If key events are handled by the search bar, the bar will @@ -71092,54 +74692,57 @@ editable child widgets of @widget will receive text input before it gets captured. If that is not desired, you can capture and forward the events yourself with [method@Gtk.EventControllerKey.forward]. + - a `GtkSearchBar` + a `GtkSearchBar` - a `GtkWidget` + a `GtkWidget` - Switches the search mode on or off. + Switches the search mode on or off. + - a `GtkSearchBar` + a `GtkSearchBar` - the new state of the search mode + the new state of the search mode - Shows or hides the close button. + Shows or hides the close button. Applications that already have a “search” toggle button should not show a close button in their search bar, as it duplicates the role of the toggle button. + - a `GtkSearchBar` + a `GtkSearchBar` - whether the close button will be shown or not + whether the close button will be shown or not @@ -71147,30 +74750,30 @@ of the toggle button. - The child widget. + The child widget. - The key capture widget. + The key capture widget. - Whether the search mode is on and the search bar shown. + Whether the search mode is on and the search bar shown. - Whether to show the close button in the search bar. + Whether to show the close button in the search bar. - `GtkSearchEntry` is an entry widget that has been tailored for use + `GtkSearchEntry` is an entry widget that has been tailored for use as a search entry. The main API for interacting with a `GtkSearchEntry` as entry @@ -71219,27 +74822,29 @@ a `.search` style class, and the text node is a child of that. - Creates a `GtkSearchEntry`. + Creates a `GtkSearchEntry`. + - a new `GtkSearchEntry` + a new `GtkSearchEntry` - Gets the widget that @entry is capturing key events from. + Gets the widget that @entry is capturing key events from. + - The key capture widget. + The key capture widget. - a `GtkSearchEntry` + a `GtkSearchEntry` - Sets @widget as the widget that @entry will capture key + Sets @widget as the widget that @entry will capture key events from. Key events are consumed by the search entry to start or @@ -71256,31 +74861,32 @@ editable child widgets of @widget will receive text input before it gets captured. If that is not desired, you can capture and forward the events yourself with [method@Gtk.EventControllerKey.forward]. + - a `GtkSearchEntry` + a `GtkSearchEntry` - a `GtkWidget` + a `GtkWidget` - Whether to activate the default widget when Enter is pressed. + Whether to activate the default widget when Enter is pressed. - The text that will be displayed in the `GtkSearchEntry` + The text that will be displayed in the `GtkSearchEntry` when it is empty and unfocused. - Emitted when the entry is activated. + Emitted when the entry is activated. The keybindings for this signal are all forms of the Enter key. @@ -71288,7 +74894,7 @@ The keybindings for this signal are all forms of the Enter key. - Emitted when the user initiates a move to the next match + Emitted when the user initiates a move to the next match for the current search string. This is a [keybinding signal](class.SignalAction.html). @@ -71302,7 +74908,7 @@ The default bindings for this signal is Ctrl-g. - Emitted when the user initiates a move to the previous match + Emitted when the user initiates a move to the previous match for the current search string. This is a [keybinding signal](class.SignalAction.html). @@ -71316,20 +74922,20 @@ The default bindings for this signal is Ctrl-Shift-g. - Emitted with a short delay of 150 milliseconds after the + Emitted with a short delay of 150 milliseconds after the last change to the entry text. - Emitted when the user initiated a search on the entry. + Emitted when the user initiated a search on the entry. - Emitted when the user stops a search via keyboard input. + Emitted when the user stops a search via keyboard input. This is a [keybinding signal](class.SignalAction.html). @@ -71343,55 +74949,59 @@ The default bindings for this signal is Escape. - `GtkSelectionFilterModel` is a list model that presents the selection from + `GtkSelectionFilterModel` is a list model that presents the selection from a `GtkSelectionModel`. + - Creates a new `GtkSelectionFilterModel` that will include the + Creates a new `GtkSelectionFilterModel` that will include the selected items from the underlying selection model. + - a new `GtkSelectionFilterModel` + a new `GtkSelectionFilterModel` - the selection model to filter + the selection model to filter - Gets the model currently filtered or %NULL if none. + Gets the model currently filtered or %NULL if none. + - The model that gets filtered + The model that gets filtered - a `GtkSelectionFilterModel` + a `GtkSelectionFilterModel` - Sets the model to be filtered. + Sets the model to be filtered. Note that GTK makes no effort to ensure that @model conforms to the item type of @self. It assumes that the caller knows what they are doing and have set up an appropriate filter to ensure that item types match. + - a `GtkSelectionFilterModel` + a `GtkSelectionFilterModel` - The model to be filtered + The model to be filtered @@ -71399,25 +75009,26 @@ types match. - The model being filtered. + The model being filtered. + - Used to control what selections users are allowed to make. + Used to control what selections users are allowed to make. - No selection is possible. + No selection is possible. - Zero or one element may be selected. + Zero or one element may be selected. - Exactly one element is selected. + Exactly one element is selected. In some circumstances, such as initially or during a search operation, it’s possible for no element to be selected with %GTK_SELECTION_BROWSE. What is really enforced is that the user @@ -71425,14 +75036,14 @@ types match. another element. - Any number of elements may be selected. + Any number of elements may be selected. The Ctrl key may be used to enlarge the selection, and Shift key to select between the focus and the child pointed to. Some widgets may also allow Click-drag to select a range of elements. - `GtkSelectionModel` is an interface that add support for selection to list models. + `GtkSelectionModel` is an interface that add support for selection to list models. This support is then used by widgets using list models to add the ability to select and unselect various items. @@ -71467,117 +75078,123 @@ selecting is not supported by the model. Selections may happen asynchronously, so the only reliable way to find out when an item was selected is to listen to the signals that indicate selection. + - Gets the set of selected items in a range. + Gets the set of selected items in a range. This function is an optimization for [method@Gtk.SelectionModel.get_selection] when you are only interested in part of the model's selected state. A common use case is in response to the [signal@Gtk.SelectionModel::selection-changed] signal. + - A `GtkBitset` that matches the selection state + A `GtkBitset` that matches the selection state for the given range with all other values being undefined. The bitset must not be modified. - a `GtkSelectionModel` + a `GtkSelectionModel` - start of the queired range + start of the queired range - number of items in the queried range + number of items in the queried range - Checks if the given item is selected. + Checks if the given item is selected. + - %TRUE if the item is selected + %TRUE if the item is selected - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to query + the position of the item to query - Requests to select all items in the model. + Requests to select all items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items are now selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - Requests to select an item in the model. + Requests to select an item in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the item was selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to select + the position of the item to select - whether previously selected items should be unselected + whether previously selected items should be unselected - Requests to select a range of items in the model. + Requests to select a range of items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the range was selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the first item to select + the first item to select - the number of items to select + the number of items to select - whether previously selected items should be unselected + whether previously selected items should be unselected - Make selection changes. + Make selection changes. This is the most advanced selection updating method that allows the most fine-grained control over selection changes. If you can, @@ -71610,233 +75227,244 @@ gtk_selection_model_selection_changed (model, @mask and @selected must not be modified. They may refer to the same bitset, which would mean that every item in the set should be selected. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items were updated according to the inputs. - a `GtkSelectionModel` + a `GtkSelectionModel` - bitmask specifying if items should be selected or unselected + bitmask specifying if items should be selected or unselected - bitmask specifying which items should be updated + bitmask specifying which items should be updated - Requests to unselect all items in the model. + Requests to unselect all items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items are now unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - Requests to unselect an item in the model. + Requests to unselect an item in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the item was unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to unselect + the position of the item to unselect - Requests to unselect a range of items in the model. + Requests to unselect a range of items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the range was unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the first item to unselect + the first item to unselect - the number of items to unselect + the number of items to unselect - Gets the set containing all currently selected items in the model. + Gets the set containing all currently selected items in the model. This function may be slow, so if you are only interested in single item, consider using [method@Gtk.SelectionModel.is_selected] or if you are only interested in a few, consider [method@Gtk.SelectionModel.get_selection_in_range]. + - a `GtkBitset` containing all the values currently + a `GtkBitset` containing all the values currently selected in @model. If no items are selected, the bitset is empty. The bitset must not be modified. - a `GtkSelectionModel` + a `GtkSelectionModel` - Gets the set of selected items in a range. + Gets the set of selected items in a range. This function is an optimization for [method@Gtk.SelectionModel.get_selection] when you are only interested in part of the model's selected state. A common use case is in response to the [signal@Gtk.SelectionModel::selection-changed] signal. + - A `GtkBitset` that matches the selection state + A `GtkBitset` that matches the selection state for the given range with all other values being undefined. The bitset must not be modified. - a `GtkSelectionModel` + a `GtkSelectionModel` - start of the queired range + start of the queired range - number of items in the queried range + number of items in the queried range - Checks if the given item is selected. + Checks if the given item is selected. + - %TRUE if the item is selected + %TRUE if the item is selected - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to query + the position of the item to query - Requests to select all items in the model. + Requests to select all items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items are now selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - Requests to select an item in the model. + Requests to select an item in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the item was selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to select + the position of the item to select - whether previously selected items should be unselected + whether previously selected items should be unselected - Requests to select a range of items in the model. + Requests to select a range of items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the range was selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the first item to select + the first item to select - the number of items to select + the number of items to select - whether previously selected items should be unselected + whether previously selected items should be unselected - Helper function for implementations of `GtkSelectionModel`. + Helper function for implementations of `GtkSelectionModel`. Call this when a the selection changes to emit the [signal@Gtk.SelectionModel::selection-changed] signal. + - a `GtkSelectionModel` + a `GtkSelectionModel` - the first changed item + the first changed item - the number of changed items + the number of changed items - Make selection changes. + Make selection changes. This is the most advanced selection updating method that allows the most fine-grained control over selection changes. If you can, @@ -71869,83 +75497,87 @@ gtk_selection_model_selection_changed (model, @mask and @selected must not be modified. They may refer to the same bitset, which would mean that every item in the set should be selected. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items were updated according to the inputs. - a `GtkSelectionModel` + a `GtkSelectionModel` - bitmask specifying if items should be selected or unselected + bitmask specifying if items should be selected or unselected - bitmask specifying which items should be updated + bitmask specifying which items should be updated - Requests to unselect all items in the model. + Requests to unselect all items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items are now unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - Requests to unselect an item in the model. + Requests to unselect an item in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the item was unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to unselect + the position of the item to unselect - Requests to unselect a range of items in the model. + Requests to unselect a range of items in the model. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the range was unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the first item to unselect + the first item to unselect - the number of items to unselect + the number of items to unselect - Emitted when the selection state of some of the items in @model changes. + Emitted when the selection state of some of the items in @model changes. Note that this signal does not specify the new selection state of the items, they need to be queried manually. It is also not necessary for @@ -71956,18 +75588,18 @@ model, though it would be rather useless to emit such a signal. - The first item that may have changed + The first item that may have changed - number of items with changes + number of items with changes - The list of virtual functions for the `GtkSelectionModel` interface. + The list of virtual functions for the `GtkSelectionModel` interface. No function must be implemented, but unless `GtkSelectionModel::is_selected()` is implemented, it will not be possible to select items in the set. @@ -71979,22 +75611,24 @@ using the model. All selection functions fall back to `GtkSelectionModel::set_selection()` so it is sufficient to implement just that function for full selection support. + + - %TRUE if the item is selected + %TRUE if the item is selected - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to query + the position of the item to query @@ -72002,23 +75636,24 @@ support. + - A `GtkBitset` that matches the selection state + A `GtkBitset` that matches the selection state for the given range with all other values being undefined. The bitset must not be modified. - a `GtkSelectionModel` + a `GtkSelectionModel` - start of the queired range + start of the queired range - number of items in the queried range + number of items in the queried range @@ -72026,22 +75661,23 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the item was selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to select + the position of the item to select - whether previously selected items should be unselected + whether previously selected items should be unselected @@ -72049,18 +75685,19 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the item was unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the position of the item to unselect + the position of the item to unselect @@ -72068,26 +75705,27 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the range was selected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the first item to select + the first item to select - the number of items to select + the number of items to select - whether previously selected items should be unselected + whether previously selected items should be unselected @@ -72095,22 +75733,23 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean the range was unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` - the first item to unselect + the first item to unselect - the number of items to unselect + the number of items to unselect @@ -72118,14 +75757,15 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items are now selected. - a `GtkSelectionModel` + a `GtkSelectionModel` @@ -72133,14 +75773,15 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items are now unselected. - a `GtkSelectionModel` + a `GtkSelectionModel` @@ -72148,23 +75789,24 @@ support. + - %TRUE if this action was supported and no fallback should be + %TRUE if this action was supported and no fallback should be tried. This does not mean that all items were updated according to the inputs. - a `GtkSelectionModel` + a `GtkSelectionModel` - bitmask specifying if items should be selected or unselected + bitmask specifying if items should be selected or unselected - bitmask specifying which items should be updated + bitmask specifying which items should be updated @@ -72172,21 +75814,21 @@ support. - Determines how GTK handles the sensitivity of various controls, + Determines how GTK handles the sensitivity of various controls, such as combo box buttons. - The control is made insensitive if no + The control is made insensitive if no action can be triggered - The control is always sensitive + The control is always sensitive - The control is always insensitive + The control is always insensitive - `GtkSeparator` is a horizontal or vertical separator widget. + `GtkSeparator` is a horizontal or vertical separator widget. ![An example GtkSeparator](separators.png) @@ -72207,21 +75849,22 @@ gets one of the .horizontal or .vertical style classes. - Creates a new `GtkSeparator` with the given orientation. + Creates a new `GtkSeparator` with the given orientation. + - a new `GtkSeparator`. + a new `GtkSeparator`. - the separator’s orientation. + the separator’s orientation. - `GtkSettings` provides a mechanism to share global settings between + `GtkSettings` provides a mechanism to share global settings between applications. On the X window system, this sharing is realized by an @@ -72249,55 +75892,58 @@ There is one `GtkSettings` instance per display. It can be obtained with convenient to use [method@Gtk.Widget.get_settings]. - Gets the `GtkSettings` object for the default display, creating + Gets the `GtkSettings` object for the default display, creating it if necessary. See [func@Gtk.Settings.get_for_display]. + - a `GtkSettings` object. If there is + a `GtkSettings` object. If there is no default display, then returns %NULL. - Gets the `GtkSettings` object for @display, creating it if necessary. + Gets the `GtkSettings` object for @display, creating it if necessary. + - a `GtkSettings` object + a `GtkSettings` object - a `GdkDisplay` + a `GdkDisplay` - Undoes the effect of calling g_object_set() to install an + Undoes the effect of calling g_object_set() to install an application-specific value for a setting. After this call, the setting will again follow the session-wide value for this setting. + - a `GtkSettings` object + a `GtkSettings` object - the name of the setting to reset + the name of the setting to reset - Whether buttons in dialogs should use the alternative button order. + Whether buttons in dialogs should use the alternative button order. - Controls the direction of the sort indicators in sorted list and tree + Controls the direction of the sort indicators in sorted list and tree views. By default an arrow pointing down means the column is sorted @@ -72305,7 +75951,7 @@ in ascending order. When set to %TRUE, this order will be inverted. - Whether the application prefers to use a dark theme. + Whether the application prefers to use a dark theme. If a GTK theme includes a dark variant, it will be used instead of the configured theme. @@ -72322,22 +75968,22 @@ are white/light and the dark chrome creates too much contrast - The aspect ratio of the text caret. + The aspect ratio of the text caret. - Whether the cursor should blink. + Whether the cursor should blink. Also see the [property@Gtk.Settings:gtk-cursor-blink-timeout] setting, which allows more flexible control over cursor blinking. - Length of the cursor blink cycle, in milliseconds. + Length of the cursor blink cycle, in milliseconds. - Time after which the cursor stops blinking, in seconds. + Time after which the cursor stops blinking, in seconds. The timer is reset after each user interaction. @@ -72346,19 +75992,19 @@ Setting this to zero has the same effect as setting - Name of the cursor theme to use. + Name of the cursor theme to use. Use %NULL to use the default theme. - The size to use for cursors. + The size to use for cursors. 0 means to use the default size. - Determines which buttons should be put in the + Determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed at the left of right. @@ -72381,7 +76027,7 @@ Also note that the setting can be overridden with the - Whether builtin GTK dialogs such as the file chooser, the + Whether builtin GTK dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom. @@ -72390,30 +76036,30 @@ directly, or message dialogs. - The number of pixels the cursor can move before dragging. + The number of pixels the cursor can move before dragging. - The maximum distance allowed between two clicks for them to be considered + The maximum distance allowed between two clicks for them to be considered a double click, in pixels. - The maximum time to allow between two clicks for them to be considered + The maximum time to allow between two clicks for them to be considered a double click, in milliseconds. - Whether menu items should have visible accelerators which can be + Whether menu items should have visible accelerators which can be activated. - Whether to enable toolkit-wide animations. + Whether to enable toolkit-wide animations. - Whether to play any event sounds at all. + Whether to play any event sounds at all. See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec) for more information on event sounds and sound themes. @@ -72423,7 +76069,7 @@ module like the one that comes with libcanberra. - Whether to play event sounds as feedback to user input. + Whether to play event sounds as feedback to user input. See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec) for more information on event sounds and sound themes. @@ -72433,12 +76079,12 @@ module like the one that comes with libcanberra. - Whether a middle click on a mouse should paste the + Whether a middle click on a mouse should paste the 'PRIMARY' clipboard content at the cursor location. - How long to show the last input character in hidden + How long to show the last input character in hidden entries. This value is in milliseconds. 0 disables showing the @@ -72449,7 +76095,7 @@ last char. 600 is a good value for enabling it. - When %TRUE, keyboard navigation and other input-related errors + When %TRUE, keyboard navigation and other input-related errors will cause a beep. Since the error bell is implemented using gdk_surface_beep(), the @@ -72458,24 +76104,24 @@ ways, such as flashing the window or similar visual effects. - The default font to use. + The default font to use. GTK uses the family name and size from this string. - Timestamp of the curent fontconfig configuration. + Timestamp of the curent fontconfig configuration. - Name of the icon theme to use. + Name of the icon theme to use. See [class@Gtk.IconTheme] for details about how GTK handles icon themes. - Which IM (input method) module should be used by default. + Which IM (input method) module should be used by default. This is the input method that will be used if the user has not explicitly chosen another input method from the IM context menu. @@ -72486,32 +76132,32 @@ See [class@Gtk.IMContext]. - Whether GTK should make sure that text can be navigated with + Whether GTK should make sure that text can be navigated with a caret, even if it is not editable. This is useful when using a screen reader. - Whether to select the contents of a selectable + Whether to select the contents of a selectable label when it is focused. - The time for a button or touch press to be considered a “long press”. + The time for a button or touch press to be considered a “long press”. See [class@Gtk.GestureLongPress]. - Whether scrolled windows may use overlaid scrolling indicators. + Whether scrolled windows may use overlaid scrolling indicators. If this is set to %FALSE, scrolled windows will have permanent scrollbars. - If the value of this setting is %TRUE, clicking the primary button in a + If the value of this setting is %TRUE, clicking the primary button in a `GtkRange` trough will move the slider, and hence set the range’s value, to the point that you clicked. @@ -72524,7 +76170,7 @@ mouse button. - A comma-separated list of print backends to use in the print + A comma-separated list of print backends to use in the print dialog. Available print backends depend on the GTK installation, @@ -72532,7 +76178,7 @@ and may include "file", "cups", "lpr" or "papi". - A command to run for displaying the print preview. + A command to run for displaying the print preview. The command should contain a `%f` placeholder, which will get replaced by the path to the pdf file. The command may also @@ -72545,14 +76191,14 @@ file and the print settings file when it is done. - Whether GTK should keep track of items inside the recently used + Whether GTK should keep track of items inside the recently used resources list. If set to %FALSE, the list will always be empty. - The maximum age, in days, of the items inside the recently used + The maximum age, in days, of the items inside the recently used resources list. Items older than this setting will be excised from the list. @@ -72561,22 +76207,22 @@ item will be removed. - Set to %TRUE if the desktop environment is displaying + Set to %TRUE if the desktop environment is displaying the app menu, %FALSE if the app should display it itself. - Set to %TRUE if the desktop environment is displaying + Set to %TRUE if the desktop environment is displaying the desktop folder, %FALSE if not. - Set to %TRUE if the desktop environment is displaying + Set to %TRUE if the desktop environment is displaying the menubar, %FALSE if the app should display it itself. - The XDG sound theme to use for event sounds. + The XDG sound theme to use for event sounds. See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec) for more information on event sounds and sound themes. @@ -72586,19 +76232,19 @@ a loadable module like the one that comes with libcanberra. - Whether two cursors should be displayed for mixed left-to-right and + Whether two cursors should be displayed for mixed left-to-right and right-to-left text. - Name of the theme to load. + Name of the theme to load. See [class@Gtk.CssProvider] for details about how GTK finds the CSS stylesheet for a theme. - Determines the action to take when a double-click + Determines the action to take when a double-click occurs on the titlebar of client-side decorated windows. Recognized actions are minimize, toggle-maximize, menu, lower @@ -72606,7 +76252,7 @@ or none. - Determines the action to take when a middle-click + Determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows. Recognized actions are minimize, toggle-maximize, menu, lower @@ -72614,7 +76260,7 @@ or none. - Determines the action to take when a right-click + Determines the action to take when a right-click occurs on the titlebar of client-side decorated windows. Recognized actions are minimize, toggle-maximize, menu, lower @@ -72622,39 +76268,39 @@ or none. - Whether to antialias fonts. + Whether to antialias fonts. The values are 0 for no, 1 for yes, or -1 for the system default. - The font resolution, in 1024 * dots/inch. + The font resolution, in 1024 * dots/inch. -1 to use the default value. - Whether to enable font hinting. + Whether to enable font hinting. The values are 0 for no, 1 for yes, or -1 for the system default. - What degree of font hinting to use. + What degree of font hinting to use. The possible vaues are hintnone, hintslight, hintmedium, hintfull. - The type of subpixel antialiasing to use. + The type of subpixel antialiasing to use. The possible values are none, rgb, bgr, vrgb, vbgr. - A `GtkShortcut` describes a keyboard shortcut. + A `GtkShortcut` describes a keyboard shortcut. It contains a description of how to trigger the shortcut via a [class@Gtk.ShortcutTrigger] and a way to activate the shortcut @@ -72669,108 +76315,115 @@ shortcuts in GTK. `GtkShortcut` does provide functionality to make it easy for users to work with shortcuts, either by providing informational strings for display purposes or by allowing shortcuts to be configured. + - Creates a new `GtkShortcut` that is triggered by + Creates a new `GtkShortcut` that is triggered by @trigger and then activates @action. + - a new `GtkShortcut` + a new `GtkShortcut` - The trigger that will trigger the shortcut + The trigger that will trigger the shortcut - The action that will be activated upon + The action that will be activated upon triggering - Creates a new `GtkShortcut` that is triggered by @trigger and then activates + Creates a new `GtkShortcut` that is triggered by @trigger and then activates @action with arguments given by @format_string. + - a new `GtkShortcut` + a new `GtkShortcut` - The trigger that will trigger the shortcut + The trigger that will trigger the shortcut - The action that will be activated upon + The action that will be activated upon triggering - GVariant format string for arguments or %NULL for + GVariant format string for arguments or %NULL for no arguments - arguments, as given by format string. + arguments, as given by format string. - Gets the action that is activated by this shortcut. + Gets the action that is activated by this shortcut. + - the action + the action - a `GtkShortcut` + a `GtkShortcut` - Gets the arguments that are passed when activating the shortcut. + Gets the arguments that are passed when activating the shortcut. + - the arguments + the arguments - a `GtkShortcut` + a `GtkShortcut` - Gets the trigger used to trigger @self. + Gets the trigger used to trigger @self. + - the trigger used + the trigger used - a `GtkShortcut` + a `GtkShortcut` - Sets the new action for @self to be @action. + Sets the new action for @self to be @action. + - a `GtkShortcut` + a `GtkShortcut` - The new action. + The new action. If the @action is %NULL, the nothing action will be used. @@ -72778,34 +76431,36 @@ for display purposes or by allowing shortcuts to be configured. - Sets the arguments to pass when activating the shortcut. + Sets the arguments to pass when activating the shortcut. + - a `GtkShortcut` + a `GtkShortcut` - arguments to pass when activating @self + arguments to pass when activating @self - Sets the new trigger for @self to be @trigger. + Sets the new trigger for @self to be @trigger. + - a `GtkShortcut` + a `GtkShortcut` - The new trigger. + The new trigger. If the @trigger is %NULL, the never trigger will be used. @@ -72814,24 +76469,24 @@ for display purposes or by allowing shortcuts to be configured. - The action that gets activated by this shortcut. + The action that gets activated by this shortcut. - Arguments passed to activation. + Arguments passed to activation. - The trigger that triggers this shortcut. + The trigger that triggers this shortcut. - `GtkShortcutAction` encodes an action that can be triggered by a + `GtkShortcutAction` encodes an action that can be triggered by a keyboard shortcut. `GtkShortcutActions` contain functions that allow easy presentation @@ -72858,8 +76513,9 @@ GTK provides various actions: - [class@Gtk.NamedAction]: a shortcut action that calls gtk_widget_activate_action() - [class@Gtk.NothingAction]: a shortcut action that does nothing + - Tries to parse the given string into an action. + Tries to parse the given string into an action. On success, the parsed action is returned. When parsing failed, %NULL is returned. @@ -72871,104 +76527,111 @@ The accepted strings are: - `mnemonic-activate`, for `GtkMnemonicAction` - `action(NAME)`, for a `GtkNamedAction` for the action named `NAME` - `signal(NAME)`, for a `GtkSignalAction` for the signal `NAME` + - a new `GtkShortcutAction` + a new `GtkShortcutAction` - the string to parse + the string to parse - Activates the action on the @widget with the given @args. + Activates the action on the @widget with the given @args. Note that some actions ignore the passed in @flags, @widget or @args. Activation of an action can fail for various reasons. If the action is not supported by the @widget, if the @args don't match the action or if the activation otherwise had no effect, %FALSE will be returned. + - %TRUE if this action was activated successfully + %TRUE if this action was activated successfully - a `GtkShortcutAction` + a `GtkShortcutAction` - flags to activate with + flags to activate with - Target of the activation + Target of the activation - arguments to pass + arguments to pass - Prints the given action into a string for the developer. + Prints the given action into a string for the developer. This is meant for debugging and logging. The form of the representation may change at any time and is not guaranteed to stay identical. + - a `GtkShortcutAction` + a `GtkShortcutAction` - a `GString` to print into + a `GString` to print into - Prints the given action into a human-readable string. + Prints the given action into a human-readable string. This is a small wrapper around [method@Gtk.ShortcutAction.print] to help when debugging. + - a new string + a new string - a `GtkShortcutAction` + a `GtkShortcutAction` - + + + - List of flags that can be passed to action activation. + List of flags that can be passed to action activation. More flags may be added in the future. - The action is the only + The action is the only action that can be activated. If this flag is not set, a future activation may select a different action. + - `GtkShortcutController` is an event controller that manages shortcuts. + `GtkShortcutController` is an event controller that manages shortcuts. Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a `GtkLabel`, or by installing a key @@ -73008,104 +76671,111 @@ This example creates a [class@Gtk.ActivateAction] for triggering the for the syntax for other kinds of `GtkShortcutAction`. See [ctor@Gtk.ShortcutTrigger.parse_string] to learn more about the syntax for triggers. + - Creates a new shortcut controller. + Creates a new shortcut controller. + - a newly created shortcut controller + a newly created shortcut controller - Creates a new shortcut controller that takes its shortcuts from + Creates a new shortcut controller that takes its shortcuts from the given list model. A controller created by this function does not let you add or remove individual shortcuts using the shortcut controller api, but you can change the contents of the model. + - a newly created shortcut controller + a newly created shortcut controller - a `GListModel` containing shortcuts + a `GListModel` containing shortcuts - Adds @shortcut to the list of shortcuts handled by @self. + Adds @shortcut to the list of shortcuts handled by @self. If this controller uses an external shortcut list, this function does nothing. + - the controller + the controller - a `GtkShortcut` + a `GtkShortcut` - Gets the mnemonics modifiers for when this controller activates its shortcuts. + Gets the mnemonics modifiers for when this controller activates its shortcuts. + - the controller's mnemonics modifiers + the controller's mnemonics modifiers - a `GtkShortcutController` + a `GtkShortcutController` - Gets the scope for when this controller activates its shortcuts. + Gets the scope for when this controller activates its shortcuts. See [method@Gtk.ShortcutController.set_scope] for details. + - the controller's scope + the controller's scope - a `GtkShortcutController` + a `GtkShortcutController` - Removes @shortcut from the list of shortcuts handled by @self. + Removes @shortcut from the list of shortcuts handled by @self. If @shortcut had not been added to @controller or this controller uses an external shortcut list, this function does nothing. + - the controller + the controller - a `GtkShortcut` + a `GtkShortcut` - Sets the controller to use the given modifier for mnemonics. + Sets the controller to use the given modifier for mnemonics. The mnemonics modifiers determines which modifiers need to be pressed to allow activation of shortcuts with mnemonics triggers. @@ -73118,23 +76788,24 @@ other shortcuts. This value is only relevant for local shortcut controllers. Global and managed shortcut controllers will have their shortcuts activated from other places which have their own modifiers for activating mnemonics. + - a `GtkShortcutController` + a `GtkShortcutController` - the new mnemonics_modifiers to use + the new mnemonics_modifiers to use - Sets the controller to have the given @scope. + Sets the controller to have the given @scope. The scope allows shortcuts to be activated outside of the normal event propagation. In particular, it allows installing global @@ -73143,16 +76814,17 @@ not have focus. With %GTK_SHORTCUT_SCOPE_LOCAL, shortcuts will only be activated when the widget has focus. + - a `GtkShortcutController` + a `GtkShortcutController` - the new scope to use + the new scope to use @@ -73160,120 +76832,129 @@ when the widget has focus. - The modifiers that need to be pressed to allow mnemonics activation. + The modifiers that need to be pressed to allow mnemonics activation. - A list model to take shortcuts from. + A list model to take shortcuts from. - What scope the shortcuts will be handled in. + What scope the shortcuts will be handled in. - + + + - Prototype for shortcuts based on user callbacks. + Prototype for shortcuts based on user callbacks. + - The widget passed to the activation + The widget passed to the activation - The arguments passed to the activation + The arguments passed to the activation - The user data provided when activating the action + The user data provided when activating the action - `GtkShortcutLabel` displays a single keyboard shortcut or gesture. + `GtkShortcutLabel` displays a single keyboard shortcut or gesture. The main use case for `GtkShortcutLabel` is inside a [class@Gtk.ShortcutsWindow]. + - Creates a new `GtkShortcutLabel` with @accelerator set. + Creates a new `GtkShortcutLabel` with @accelerator set. + - a newly-allocated `GtkShortcutLabel` + a newly-allocated `GtkShortcutLabel` - the initial accelerator + the initial accelerator - Retrieves the current accelerator of @self. + Retrieves the current accelerator of @self. + - the current accelerator. + the current accelerator. - a `GtkShortcutLabel` + a `GtkShortcutLabel` - Retrieves the text that is displayed when no accelerator is set. + Retrieves the text that is displayed when no accelerator is set. + - the current text displayed when no + the current text displayed when no accelerator is set. - a `GtkShortcutLabel` + a `GtkShortcutLabel` - Sets the accelerator to be displayed by @self. + Sets the accelerator to be displayed by @self. + - a `GtkShortcutLabel` + a `GtkShortcutLabel` - the new accelerator + the new accelerator - Sets the text to be displayed by @self when no accelerator is set. + Sets the text to be displayed by @self when no accelerator is set. + - a `GtkShortcutLabel` + a `GtkShortcutLabel` - the text to be displayed when no accelerator is set + the text to be displayed when no accelerator is set @@ -73281,7 +76962,7 @@ accelerator is set. - The accelerator that @self displays. + The accelerator that @self displays. See [property@Gtk.ShortcutsShortcut:accelerator] for the accepted syntax. @@ -73290,13 +76971,15 @@ for the accepted syntax. - The text that is displayed when no accelerator is set. + The text that is displayed when no accelerator is set. - + + + - The `GtkShortcutManager` interface is used to implement + The `GtkShortcutManager` interface is used to implement shortcut scopes. This is important for [iface@Gtk.Native] widgets that have their @@ -73308,7 +76991,9 @@ Examples for widgets implementing `GtkShortcutManager` are Every widget that implements `GtkShortcutManager` will be used as a %GTK_SHORTCUT_SCOPE_MANAGED. + + @@ -73322,6 +77007,7 @@ Every widget that implements `GtkShortcutManager` will be used as a + @@ -73336,16 +77022,18 @@ Every widget that implements `GtkShortcutManager` will be used as a - The list of functions that can be implemented for the `GtkShortcutManager` + The list of functions that can be implemented for the `GtkShortcutManager` interface. Note that no function is mandatory to implement, the default implementation will work fine. + + @@ -73361,6 +77049,7 @@ will work fine. + @@ -73376,23 +77065,23 @@ will work fine. - Describes where `GtkShortcut`s added to a + Describes where `GtkShortcut`s added to a `GtkShortcutController` get handled. - Shortcuts are handled inside + Shortcuts are handled inside the widget the controller belongs to. - Shortcuts are handled by + Shortcuts are handled by the first ancestor that is a `GtkShortcutManager` - Shortcuts are handled by + Shortcuts are handled by the root widget. - `GtkShortcutTrigger` tracks how a `GtkShortcut` should be activated. + `GtkShortcutTrigger` tracks how a `GtkShortcut` should be activated. To find out if a `GtkShortcutTrigger` triggers, you can call [method@Gtk.ShortcutTrigger.trigger] on a `GdkEvent`. @@ -73403,8 +77092,9 @@ to end users as well as being printed for debugging. All `GtkShortcutTriggers` are immutable, you can only specify their properties during construction. If you want to change a trigger, you have to replace it with a new one. + - Tries to parse the given string into a trigger. + Tries to parse the given string into a trigger. On success, the parsed trigger is returned. When parsing failed, %NULL is returned. @@ -73420,61 +77110,64 @@ The accepted strings are: Note that you will have to escape the `<` and `>` characters when specifying triggers in XML files, such as GtkBuilder ui files. Use `&lt;` instead of `<` and `&gt;` instead of `>`. + - a new `GtkShortcutTrigger` + a new `GtkShortcutTrigger` - the string to parse + the string to parse - The types of @trigger1 and @trigger2 are `gconstpointer` only to allow + The types of @trigger1 and @trigger2 are `gconstpointer` only to allow use of this function as a `GCompareFunc`. They must each be a `GtkShortcutTrigger`. + - An integer less than, equal to, or greater than zero if + An integer less than, equal to, or greater than zero if @trigger1 is found, respectively, to be less than, to match, or be greater than @trigger2. - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - Checks if @trigger1 and @trigger2 trigger under the same conditions. + Checks if @trigger1 and @trigger2 trigger under the same conditions. The types of @one and @two are `gconstpointer` only to allow use of this function with `GHashTable`. They must each be a `GtkShortcutTrigger`. + - %TRUE if @trigger1 and @trigger2 are equal + %TRUE if @trigger1 and @trigger2 are equal - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - Generates a hash value for a `GtkShortcutTrigger`. + Generates a hash value for a `GtkShortcutTrigger`. The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor @@ -73483,39 +77176,41 @@ function as a basis for building protocols or file formats. The types of @trigger is `gconstpointer` only to allow use of this function with `GHashTable`. They must each be a `GtkShortcutTrigger`. + - a hash value corresponding to @trigger + a hash value corresponding to @trigger - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - Prints the given trigger into a string for the developer. + Prints the given trigger into a string for the developer. This is meant for debugging and logging. The form of the representation may change at any time and is not guaranteed to stay identical. + - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - a `GString` to print into + a `GString` to print into - Prints the given trigger into a string. + Prints the given trigger into a string. This function is returning a translated string for presentation to end users for example in menu items or in help texts. @@ -73526,29 +77221,30 @@ causing display-specific modifier names. The form of the representation may change at any time and is not guaranteed to stay identical. + - %TRUE if something was printed or %FALSE if the + %TRUE if something was printed or %FALSE if the trigger did not have a textual representation suitable for end users. - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - `GdkDisplay` to print for + `GdkDisplay` to print for - a `GString` to print into + a `GString` to print into - Gets textual representation for the given trigger. + Gets textual representation for the given trigger. This function is returning a translated string for presentation to end users for example in menu items @@ -73560,54 +77256,57 @@ causing display-specific modifier names. The form of the representation may change at any time and is not guaranteed to stay identical. + - a new string + a new string - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - `GdkDisplay` to print for + `GdkDisplay` to print for - Prints the given trigger into a human-readable string. + Prints the given trigger into a human-readable string. This is a small wrapper around [method@Gtk.ShortcutTrigger.print] to help when debugging. + - a new string + a new string - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - Checks if the given @event triggers @self. + Checks if the given @event triggers @self. + - Whether the event triggered the shortcut + Whether the event triggered the shortcut - a `GtkShortcutTrigger` + a `GtkShortcutTrigger` - the event to check + the event to check - %TRUE if mnemonics should trigger. Usually the + %TRUE if mnemonics should trigger. Usually the value of this property is determined by checking that the passed in @event is a Key event and has the right modifiers set. @@ -73615,46 +77314,48 @@ to help when debugging. - + + + - GtkShortcutType specifies the kind of shortcut that is being described. + GtkShortcutType specifies the kind of shortcut that is being described. More values may be added to this enumeration over time. - The shortcut is a keyboard accelerator. The GtkShortcutsShortcut:accelerator + The shortcut is a keyboard accelerator. The GtkShortcutsShortcut:accelerator property will be used. - The shortcut is a pinch gesture. GTK provides an icon and subtitle. + The shortcut is a pinch gesture. GTK provides an icon and subtitle. - The shortcut is a stretch gesture. GTK provides an icon and subtitle. + The shortcut is a stretch gesture. GTK provides an icon and subtitle. - The shortcut is a clockwise rotation gesture. GTK provides an icon and subtitle. + The shortcut is a clockwise rotation gesture. GTK provides an icon and subtitle. - The shortcut is a counterclockwise rotation gesture. GTK provides an icon and subtitle. + The shortcut is a counterclockwise rotation gesture. GTK provides an icon and subtitle. - The shortcut is a two-finger swipe gesture. GTK provides an icon and subtitle. + The shortcut is a two-finger swipe gesture. GTK provides an icon and subtitle. - The shortcut is a two-finger swipe gesture. GTK provides an icon and subtitle. + The shortcut is a two-finger swipe gesture. GTK provides an icon and subtitle. - The shortcut is a gesture. The GtkShortcutsShortcut:icon property will be + The shortcut is a gesture. The GtkShortcutsShortcut:icon property will be used. - The shortcut is a swipe gesture. GTK provides an icon and subtitle. + The shortcut is a swipe gesture. GTK provides an icon and subtitle. - The shortcut is a swipe gesture. GTK provides an icon and subtitle. + The shortcut is a swipe gesture. GTK provides an icon and subtitle. - A `GtkShortcutsGroup` represents a group of related keyboard shortcuts + A `GtkShortcutsGroup` represents a group of related keyboard shortcuts or gestures. The group has a title. It may optionally be associated with a view @@ -73662,34 +77363,35 @@ of the application, which can be used to show only relevant shortcuts depending on the application context. This widget is only meant to be used with [class@Gtk.ShortcutsWindow]. + - The size group for the accelerator portion of shortcuts in this group. + The size group for the accelerator portion of shortcuts in this group. This is used internally by GTK, and must not be modified by applications. - A rough measure for the number of lines in this group. + A rough measure for the number of lines in this group. This is used internally by GTK, and is not useful for applications. - The title for this group of shortcuts. + The title for this group of shortcuts. - The size group for the textual portion of shortcuts in this group. + The size group for the textual portion of shortcuts in this group. This is used internally by GTK, and must not be modified by applications. - An optional view that the shortcuts in this group are relevant for. + An optional view that the shortcuts in this group are relevant for. The group will be hidden if the [property@Gtk.ShortcutsWindow:view-name] property does not match the view of this group. @@ -73698,9 +77400,11 @@ Set this to %NULL to make the group always visible. - + + + - A `GtkShortcutsSection` collects all the keyboard shortcuts and gestures + A `GtkShortcutsSection` collects all the keyboard shortcuts and gestures for a major application mode. If your application needs multiple sections, you should give each @@ -73713,12 +77417,13 @@ to influence how the groups in the section are distributed over pages and columns. This widget is only meant to be used with [class@Gtk.ShortcutsWindow]. + - The maximum number of lines to allow per column. + The maximum number of lines to allow per column. This property can be used to influence how the groups in this section are distributed across pages and columns. The default @@ -73726,7 +77431,7 @@ value of 15 should work in most cases. - A unique name to identify this section among the sections + A unique name to identify this section among the sections added to the `GtkShortcutsWindow`. Setting the [property@Gtk.ShortcutsWindow:section-name] property @@ -73734,7 +77439,7 @@ to this string will make this section shown in the `GtkShortcutsWindow`. - The string to show in the section selector of the `GtkShortcutsWindow` + The string to show in the section selector of the `GtkShortcutsWindow` for this section. If there is only one section, you don't need to set a title, @@ -73742,7 +77447,7 @@ since the section selector will not be shown in this case. - A view name to filter the groups in this section by. + A view name to filter the groups in this section by. See [property@Gtk.ShortcutsGroup:view]. @@ -73762,23 +77467,26 @@ for this purpose. - + + + - A `GtkShortcutsShortcut` represents a single keyboard shortcut or gesture + A `GtkShortcutsShortcut` represents a single keyboard shortcut or gesture with a short text. This widget is only meant to be used with `GtkShortcutsWindow`. + - The size group for the accelerator portion of this shortcut. + The size group for the accelerator portion of this shortcut. This is used internally by GTK, and must not be modified by applications. - The accelerator(s) represented by this object. + The accelerator(s) represented by this object. This property is used if [property@Gtk.ShortcutsShortcut:shortcut-type] is set to %GTK_SHORTCUT_ACCELERATOR. @@ -73808,7 +77516,7 @@ in .ui files. - A detailed action name. + A detailed action name. If this is set for a shortcut of type %GTK_SHORTCUT_ACCELERATOR, then GTK will use the accelerators that are associated with the @@ -73817,14 +77525,14 @@ setting [property@Gtk.ShortcutsShortcut:accelerator] is not necessary. - The text direction for which this shortcut is active. + The text direction for which this shortcut is active. If the shortcut is used regardless of the text direction, set this property to %GTK_TEXT_DIR_NONE. - An icon to represent the shortcut or gesture. + An icon to represent the shortcut or gesture. This property is used if [property@Gtk.ShortcutsShortcut:shortcut-type] is set to %GTK_SHORTCUT_GESTURE. @@ -73833,15 +77541,15 @@ For the other predefined gesture types, GTK provides an icon on its own. - %TRUE if an icon has been set. + %TRUE if an icon has been set. - The type of shortcut that is represented. + The type of shortcut that is represented. - The subtitle for the shortcut or gesture. + The subtitle for the shortcut or gesture. This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture @@ -73849,26 +77557,28 @@ types, GTK provides a subtitle on its own. - %TRUE if a subtitle has been set. + %TRUE if a subtitle has been set. - The textual description for the shortcut or gesture represented by + The textual description for the shortcut or gesture represented by this object. This should be a short string that can fit in a single line. - The size group for the textual portion of this shortcut. + The size group for the textual portion of this shortcut. This is used internally by GTK, and must not be modified by applications. - + + + - A `GtkShortcutsWindow` shows information about the keyboard shortcuts + A `GtkShortcutsWindow` shows information about the keyboard shortcuts and gestures of an application. The shortcuts can be grouped, and you can have multiple sections in this @@ -73916,14 +77626,14 @@ The .ui file for this example can be found [here](https://gitlab.gnome.org/GNOME - The name of the section to show. + The name of the section to show. This should be the section-name of one of the `GtkShortcutsSection` objects that are in this shortcuts window. - The view name by which to filter the contents. + The view name by which to filter the contents. This should correspond to the [property@Gtk.ShortcutsGroup:view] property of some of the [class@Gtk.ShortcutsGroup] objects that @@ -73933,7 +77643,7 @@ Set this to %NULL to show all groups. - Emitted when the user uses a keybinding to close the window. + Emitted when the user uses a keybinding to close the window. This is a [keybinding signal](class.SignalAction.html). @@ -73943,7 +77653,7 @@ The default binding for this signal is the Escape key. - Emitted when the user uses a keybinding to start a search. + Emitted when the user uses a keybinding to start a search. This is a [keybinding signal](class.SignalAction.html). @@ -73954,49 +77664,54 @@ The default binding for this signal is Control-F. - A `GtkShortcut`Action that emits a signal. + A `GtkShortcut`Action that emits a signal. Signals that are used in this way are referred to as keybinding signals, and they are expected to be defined with the %G_SIGNAL_ACTION flag. + - Creates an action that when activated, emits the given action signal + Creates an action that when activated, emits the given action signal on the provided widget. It will also unpack the args into arguments passed to the signal. + - a new `GtkShortcutAction` + a new `GtkShortcutAction` - name of the signal to emit + name of the signal to emit - Returns the name of the signal that will be emitted. + Returns the name of the signal that will be emitted. + - the name of the signal to emit + the name of the signal to emit - a signal action + a signal action - The name of the signal to emit. + The name of the signal to emit. - + + + - `GtkSignalListItemFactory` is a `GtkListItemFactory` that emits signals + `GtkSignalListItemFactory` is a `GtkListItemFactory` that emits signals to to manage listitems. Signals are emitted for every listitem in the same order: @@ -74036,17 +77751,19 @@ For tracking changes in other properties in the `GtkListItem`, the ::notify signal is recommended. The signal can be connected in the [signal@Gtk.SignalListItemFactory::setup] signal and removed again during [signal@Gtk.SignalListItemFactory::teardown]. + - Creates a new `GtkSignalListItemFactory`. + Creates a new `GtkSignalListItemFactory`. You need to connect signal handlers before you use it. + - a new `GtkSignalListItemFactory` + a new `GtkSignalListItemFactory` - Emitted when a new [property@Gtk.ListItem:item] has been set + Emitted when a new [property@Gtk.ListItem:item] has been set on the @listitem and should be bound for use. After this signal was emitted, the listitem might be shown in @@ -74060,13 +77777,13 @@ in this signal. - The `GtkListItem` to bind + The `GtkListItem` to bind - Emitted when a new listitem has been created and needs to be setup for use. + Emitted when a new listitem has been created and needs to be setup for use. It is the first signal emitted for every listitem. @@ -74077,13 +77794,13 @@ of this signal and can be used to undo everything done in this signal. - The `GtkListItem` to set up + The `GtkListItem` to set up - Emitted when a listitem is about to be destroyed. + Emitted when a listitem is about to be destroyed. It is the last signal ever emitted for this @listitem. @@ -74094,13 +77811,13 @@ signal and should be used to undo everything done in that signal. - The `GtkListItem` to teardown + The `GtkListItem` to teardown - Emitted when a listitem has been removed from use in a list widget + Emitted when a listitem has been removed from use in a list widget and its new [property@Gtk.ListItem:item] is about to be unset. This signal is the opposite of the [signal@Gtk.SignalListItemFactory::bind] @@ -74110,177 +77827,189 @@ signal and should be used to undo everything done in that signal. - The `GtkListItem` to unbind + The `GtkListItem` to unbind - + + + - `GtkSingleSelection` is a `GtkSelectionModel` that allows selecting a single + `GtkSingleSelection` is a `GtkSelectionModel` that allows selecting a single item. Note that the selection is *persistent* -- if the selected item is removed and re-added in the same ::items-changed emission, it stays selected. In particular, this means that changing the sort order of an underlying sort model will preserve the selection. + - Creates a new selection to handle @model. + Creates a new selection to handle @model. + - a new `GtkSingleSelection` + a new `GtkSingleSelection` - the `GListModel` to manage + the `GListModel` to manage - Checks if autoselect has been enabled or disabled via + Checks if autoselect has been enabled or disabled via gtk_single_selection_set_autoselect(). + - %TRUE if autoselect is enabled + %TRUE if autoselect is enabled - a `GtkSingleSelection` + a `GtkSingleSelection` - If %TRUE, gtk_selection_model_unselect_item() is supported and allows + If %TRUE, gtk_selection_model_unselect_item() is supported and allows unselecting the selected item. + - %TRUE to support unselecting + %TRUE to support unselecting - a `GtkSingleSelection` + a `GtkSingleSelection` - Gets the model that @self is wrapping. + Gets the model that @self is wrapping. + - The model being wrapped + The model being wrapped - a `GtkSingleSelection` + a `GtkSingleSelection` - Gets the position of the selected item. + Gets the position of the selected item. If no item is selected, %GTK_INVALID_LIST_POSITION is returned. + - The position of the selected item + The position of the selected item - a `GtkSingleSelection` + a `GtkSingleSelection` - Gets the selected item. + Gets the selected item. If no item is selected, %NULL is returned. + - The selected item + The selected item - a `GtkSingleSelection` + a `GtkSingleSelection` - Enables or disables autoselect. + Enables or disables autoselect. If @autoselect is %TRUE, @self will enforce that an item is always selected. It will select a new item when the currently selected item is deleted and it will disallow unselecting the current item. + - a `GtkSingleSelection` + a `GtkSingleSelection` - %TRUE to always select an item + %TRUE to always select an item - If %TRUE, unselecting the current item via + If %TRUE, unselecting the current item via gtk_selection_model_unselect_item() is supported. Note that setting [property@Gtk.SingleSelection:autoselect] will cause unselecting to not work, so it practically makes no sense to set both at the same time the same time. + - a `GtkSingleSelection` + a `GtkSingleSelection` - %TRUE to allow unselecting + %TRUE to allow unselecting - Sets the model that @self should wrap. + Sets the model that @self should wrap. If @model is %NULL, @self will be empty. + - a `GtkSingleSelection` + a `GtkSingleSelection` - A `GListModel` to wrap + A `GListModel` to wrap - Selects the item at the given position. + Selects the item at the given position. If the list does not have an item at @position or %GTK_INVALID_LIST_POSITION is given, the behavior depends on the @@ -74288,16 +78017,17 @@ value of the [property@Gtk.SingleSelection:autoselect] property: If it is set, no change will occur and the old item will stay selected. If it is unset, the selection will be unset and no item will be selected. + - a `GtkSingleSelection` + a `GtkSingleSelection` - the item to select or %GTK_INVALID_LIST_POSITION + the item to select or %GTK_INVALID_LIST_POSITION @@ -74305,40 +78035,41 @@ will be selected. - If the selection will always select an item. + If the selection will always select an item. - If unselecting the selected item is allowed. + If unselecting the selected item is allowed. - The model being managed. + The model being managed. - Position of the selected item. + Position of the selected item. - The selected item. + The selected item. + - `GtkSizeGroup` groups widgets together so they all request the same size. + `GtkSizeGroup` groups widgets together so they all request the same size. This is typically useful when you want a column of widgets to have the same size, but you can’t use a `GtkGrid`. @@ -74404,20 +78135,21 @@ An example of a UI definition fragment with `GtkSizeGroup`: ``` - Create a new `GtkSizeGroup`. + Create a new `GtkSizeGroup`. + - a newly created `GtkSizeGroup` + a newly created `GtkSizeGroup` - the mode for the new size group. + the mode for the new size group. - Adds a widget to a `GtkSizeGroup`. + Adds a widget to a `GtkSizeGroup`. In the future, the requisition of the widget will be determined as the maximum of its requisition @@ -74428,38 +78160,41 @@ See [method@Gtk.SizeGroup.set_mode]. When the widget is destroyed or no longer referenced elsewhere, it will be removed from the size group. + - a `GtkSizeGroup` + a `GtkSizeGroup` - the `GtkWidget` to add + the `GtkWidget` to add - Gets the current mode of the size group. + Gets the current mode of the size group. + - the current mode of the size group. + the current mode of the size group. - a `GtkSizeGroup` + a `GtkSizeGroup` - Returns the list of widgets associated with @size_group. + Returns the list of widgets associated with @size_group. + - a `GSList` of + a `GSList` of widgets. The list is owned by GTK and should not be modified. @@ -74467,46 +78202,48 @@ will be removed from the size group. - a `GtkSizeGroup` + a `GtkSizeGroup` - Removes a widget from a `GtkSizeGroup`. + Removes a widget from a `GtkSizeGroup`. + - a `GtkSizeGroup` + a `GtkSizeGroup` - the `GtkWidget` to remove + the `GtkWidget` to remove - Sets the `GtkSizeGroupMode` of the size group. + Sets the `GtkSizeGroupMode` of the size group. The mode of the size group determines whether the widgets in the size group should all have the same horizontal requisition (%GTK_SIZE_GROUP_HORIZONTAL) all have the same vertical requisition (%GTK_SIZE_GROUP_VERTICAL), or should all have the same requisition in both directions (%GTK_SIZE_GROUP_BOTH). + - a `GtkSizeGroup` + a `GtkSizeGroup` - the mode to set for the size group. + the mode to set for the size group. @@ -74514,7 +78251,7 @@ in both directions (%GTK_SIZE_GROUP_BOTH). - The direction in which the size group affects requested sizes. + The direction in which the size group affects requested sizes. @@ -74522,163 +78259,171 @@ in both directions (%GTK_SIZE_GROUP_BOTH). - The mode of the size group determines the directions in which the size + The mode of the size group determines the directions in which the size group affects the requested sizes of its component widgets. - group has no effect + group has no effect - group affects horizontal requisition + group affects horizontal requisition - group affects vertical requisition + group affects vertical requisition - group affects both horizontal and vertical requisition + group affects both horizontal and vertical requisition - Specifies a preference for height-for-width or + Specifies a preference for height-for-width or width-for-height geometry management. - Prefer height-for-width geometry management + Prefer height-for-width geometry management - Prefer width-for-height geometry management + Prefer width-for-height geometry management - Don’t trade height-for-width or width-for-height + Don’t trade height-for-width or width-for-height - `GtkSliceListModel` is a list model that presents a slice of another model. + `GtkSliceListModel` is a list model that presents a slice of another model. This is useful when implementing paging by setting the size to the number of elements per page and updating the offset whenever a different page is opened. + - Creates a new slice model. + Creates a new slice model. It presents the slice from @offset to offset + @size of the given @model. + - A new `GtkSliceListModel` + A new `GtkSliceListModel` - The model to use + The model to use - the offset of the slice + the offset of the slice - maximum size of the slice + maximum size of the slice - Gets the model that is currently being used or %NULL if none. + Gets the model that is currently being used or %NULL if none. + - The model in use + The model in use - a `GtkSliceListModel` + a `GtkSliceListModel` - Gets the offset set via gtk_slice_list_model_set_offset(). + Gets the offset set via gtk_slice_list_model_set_offset(). + - The offset + The offset - a `GtkSliceListModel` + a `GtkSliceListModel` - Gets the size set via gtk_slice_list_model_set_size(). + Gets the size set via gtk_slice_list_model_set_size(). + - The size + The size - a `GtkSliceListModel` + a `GtkSliceListModel` - Sets the model to show a slice of. + Sets the model to show a slice of. The model's item type must conform to @self's item type. + - a `GtkSliceListModel` + a `GtkSliceListModel` - The model to be sliced + The model to be sliced - Sets the offset into the original model for this slice. + Sets the offset into the original model for this slice. If the offset is too large for the sliced model, @self will end up empty. + - a `GtkSliceListModel` + a `GtkSliceListModel` - the new offset to use + the new offset to use - Sets the maximum size. @self will never have more items + Sets the maximum size. @self will never have more items than @size. It can however have fewer items if the offset is too large or the model sliced from doesn't have enough items. + - a `GtkSliceListModel` + a `GtkSliceListModel` - the maximum size + the maximum size @@ -74686,29 +78431,30 @@ or the model sliced from doesn't have enough items. - Child model to take slice from. + Child model to take slice from. - Offset of slice. + Offset of slice. - Maximum size of slice. + Maximum size of slice. + - `GtkSnapshot` assists in creating `GskRenderNodes` for widgets. + `GtkSnapshot` assists in creating `GskRenderNodes` for widgets. It functions in a similar way to a cairo context, and maintains a stack of render nodes and their associated transformations. @@ -74720,38 +78466,41 @@ gtk_snapshot_pop() to change the current node. The typical way to obtain a `GtkSnapshot` object is as an argument to the [vfunc@Gtk.Widget.snapshot] vfunc. If you need to create your own `GtkSnapshot`, use [ctor@Gtk.Snapshot.new]. + - Creates a new `GtkSnapshot`. + Creates a new `GtkSnapshot`. + - a newly-allocated `GtkSnapshot` + a newly-allocated `GtkSnapshot` - Appends a stroked border rectangle inside the given @outline. + Appends a stroked border rectangle inside the given @outline. The four sides of the border can have different widths and colors. + - a `GtkSnapshot` + a `GtkSnapshot` - a `GskRoundedRect` describing the outline of the border + a `GskRoundedRect` describing the outline of the border - the stroke width of the border on + the stroke width of the border on the top, right, bottom and left side respectively. - the color used on the top, right, + the color used on the top, right, bottom and left side. @@ -74760,122 +78509,127 @@ The four sides of the border can have different widths and colors. - Creates a new `GskCairoNode` and appends it to the current + Creates a new `GskCairoNode` and appends it to the current render node of @snapshot, without changing the current node. + - a `cairo_t` suitable for drawing the contents of + a `cairo_t` suitable for drawing the contents of the newly created render node - a `GtkSnapshot` + a `GtkSnapshot` - the bounds for the new node + the bounds for the new node - Creates a new render node drawing the @color into the + Creates a new render node drawing the @color into the given @bounds and appends it to the current render node of @snapshot. You should try to avoid calling this function if @color is transparent. + - a `GtkSnapshot` + a `GtkSnapshot` - the `GdkRGBA` to draw + the `GdkRGBA` to draw - the bounds for the new node + the bounds for the new node - Appends a conic gradient node with the given stops to @snapshot. + Appends a conic gradient node with the given stops to @snapshot. + - a `GtkSnapshot` + a `GtkSnapshot` - the rectangle to render the gradient into + the rectangle to render the gradient into - the center point of the conic gradient + the center point of the conic gradient - the clockwise rotation in degrees of the starting angle. + the clockwise rotation in degrees of the starting angle. 0 means the starting angle is the top. - a pointer to an array of `GskColorStop` + a pointer to an array of `GskColorStop` defining the gradient - the number of elements in @stops + the number of elements in @stops - Appends an inset shadow into the box given by @outline. + Appends an inset shadow into the box given by @outline. + - a `GtkSnapshot` + a `GtkSnapshot` - outline of the region surrounded by shadow + outline of the region surrounded by shadow - color of the shadow + color of the shadow - horizontal offset of shadow + horizontal offset of shadow - vertical offset of shadow + vertical offset of shadow - how far the shadow spreads towards the inside + how far the shadow spreads towards the inside - how much blur to apply to the shadow + how much blur to apply to the shadow + @@ -74892,330 +78646,342 @@ You should try to avoid calling this function if - Appends a linear gradient node with the given stops to @snapshot. + Appends a linear gradient node with the given stops to @snapshot. + - a `GtkSnapshot` + a `GtkSnapshot` - the rectangle to render the linear gradient into + the rectangle to render the linear gradient into - the point at which the linear gradient will begin + the point at which the linear gradient will begin - the point at which the linear gradient will finish + the point at which the linear gradient will finish - a pointer to an array of `GskColorStop` + a pointer to an array of `GskColorStop` defining the gradient - the number of elements in @stops + the number of elements in @stops - Appends @node to the current render node of @snapshot, + Appends @node to the current render node of @snapshot, without changing the current node. If @snapshot does not have a current node yet, @node will become the initial node. + - a `GtkSnapshot` + a `GtkSnapshot` - a `GskRenderNode` + a `GskRenderNode` - Appends an outset shadow node around the box given by @outline. + Appends an outset shadow node around the box given by @outline. + - a `GtkSnapshot` + a `GtkSnapshot` - outline of the region surrounded by shadow + outline of the region surrounded by shadow - color of the shadow + color of the shadow - horizontal offset of shadow + horizontal offset of shadow - vertical offset of shadow + vertical offset of shadow - how far the shadow spreads towards the outside + how far the shadow spreads towards the outside - how much blur to apply to the shadow + how much blur to apply to the shadow - Appends a radial gradient node with the given stops to @snapshot. + Appends a radial gradient node with the given stops to @snapshot. + - a `GtkSnapshot` + a `GtkSnapshot` - the rectangle to render the readial gradient into + the rectangle to render the readial gradient into - the center point for the radial gradient + the center point for the radial gradient - the horizontal radius + the horizontal radius - the vertical radius + the vertical radius - the start position (on the horizontal axis) + the start position (on the horizontal axis) - the end position (on the horizontal axis) + the end position (on the horizontal axis) - a pointer to an array of `GskColorStop` + a pointer to an array of `GskColorStop` defining the gradient - the number of elements in @stops + the number of elements in @stops - Appends a repeating linear gradient node with the given stops to @snapshot. + Appends a repeating linear gradient node with the given stops to @snapshot. + - a `GtkSnapshot` + a `GtkSnapshot` - the rectangle to render the linear gradient into + the rectangle to render the linear gradient into - the point at which the linear gradient will begin + the point at which the linear gradient will begin - the point at which the linear gradient will finish + the point at which the linear gradient will finish - a pointer to an array of `GskColorStop` + a pointer to an array of `GskColorStop` defining the gradient - the number of elements in @stops + the number of elements in @stops - Appends a repeating radial gradient node with the given stops to @snapshot. + Appends a repeating radial gradient node with the given stops to @snapshot. + - a `GtkSnapshot` + a `GtkSnapshot` - the rectangle to render the readial gradient into + the rectangle to render the readial gradient into - the center point for the radial gradient + the center point for the radial gradient - the horizontal radius + the horizontal radius - the vertical radius + the vertical radius - the start position (on the horizontal axis) + the start position (on the horizontal axis) - the end position (on the horizontal axis) + the end position (on the horizontal axis) - a pointer to an array of `GskColorStop` + a pointer to an array of `GskColorStop` defining the gradient - the number of elements in @stops + the number of elements in @stops - Creates a new render node drawing the @texture + Creates a new render node drawing the @texture into the given @bounds and appends it to the current render node of @snapshot. + - a `GtkSnapshot` + a `GtkSnapshot` - the `GdkTexture` to render + the `GdkTexture` to render - the bounds for the new node + the bounds for the new node - Returns the node that was constructed by @snapshot + Returns the node that was constructed by @snapshot and frees @snapshot. + - a newly-created `GskRenderNode` + a newly-created `GskRenderNode` - a `GtkSnapshot` + a `GtkSnapshot` - Returns a paintable for the node that was + Returns a paintable for the node that was constructed by @snapshot and frees @snapshot. + - a newly-created `GdkPaintable` + a newly-created `GdkPaintable` - a `GtkSnapshot` + a `GtkSnapshot` - The size of the resulting paintable + The size of the resulting paintable or %NULL to use the bounds of the snapshot - Removes the top element from the stack of render nodes and + Removes the top element from the stack of render nodes and adds it to the nearest `GskGLShaderNode` below it. This must be called the same number of times as the number of textures is needed for the shader in [method@Gtk.Snapshot.push_gl_shader]. + - a `GtkSnapshot` + a `GtkSnapshot` - Applies a perspective projection transform. + Applies a perspective projection transform. See [method@Gsk.Transform.perspective] for a discussion on the details. + - a `GtkSnapshot` + a `GtkSnapshot` - distance of the z=0 plane + distance of the z=0 plane - Removes the top element from the stack of render nodes, + Removes the top element from the stack of render nodes, and appends it to the node underneath it. + - a `GtkSnapshot` + a `GtkSnapshot` - Blends together two images with the given blend mode. + Blends together two images with the given blend mode. Until the first call to [method@Gtk.Snapshot.pop], the bottom image for the blend operation will be recorded. @@ -75224,81 +78990,85 @@ recorded until the second call to [method@Gtk.Snapshot.pop]. Calling this function requires two subsequent calls to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - blend mode to use + blend mode to use - Blurs an image. + Blurs an image. The image is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the blur radius to use + the blur radius to use - Clips an image to a rectangle. + Clips an image to a rectangle. The image is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the rectangle to clip to + the rectangle to clip to - Modifies the colors of an image by applying an affine transformation + Modifies the colors of an image by applying an affine transformation in RGB space. The image is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the color matrix to use + the color matrix to use - the color offset to use + the color offset to use - Snapshots a cross-fade operation between two images with the + Snapshots a cross-fade operation between two images with the given @progress. Until the first call to [method@Gtk.Snapshot.pop], the start image @@ -75307,46 +79077,48 @@ until the second call to [method@Gtk.Snapshot.pop]. Calling this function requires two subsequent calls to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - progress between 0.0 and 1.0 + progress between 0.0 and 1.0 - Inserts a debug node with a message. + Inserts a debug node with a message. Debug nodes don't affect the rendering at all, but can be helpful in identifying parts of a render node tree dump, for example in the GTK inspector. + - a `GtkSnapshot` + a `GtkSnapshot` - a printf-style format string + a printf-style format string - arguments for @message + arguments for @message - Push a `GskGLShaderNode`. + Push a `GskGLShaderNode`. The node uses the given [class@Gsk.GLShader] and uniform values Additionally this takes a list of @n_children other nodes @@ -75380,334 +79152,347 @@ push a texture node. These will be used directly rather than being re-rendered. For details on how to write shaders, see [class@Gsk.GLShader]. + - a `GtkSnapshot` + a `GtkSnapshot` - The code to run + The code to run - the rectangle to render into + the rectangle to render into - Data block with arguments for the shader. + Data block with arguments for the shader. - Modifies the opacity of an image. + Modifies the opacity of an image. The image is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the opacity to use + the opacity to use - Creates a node that repeats the child node. + Creates a node that repeats the child node. The child is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the bounds within which to repeat + the bounds within which to repeat - the bounds of the child or %NULL + the bounds of the child or %NULL to use the full size of the collected child node - Clips an image to a rounded rectangle. + Clips an image to a rounded rectangle. The image is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the rounded rectangle to clip to + the rounded rectangle to clip to - Applies a shadow to an image. + Applies a shadow to an image. The image is recorded until the next call to [method@Gtk.Snapshot.pop]. + - a `GtkSnapshot` + a `GtkSnapshot` - the first shadow specification + the first shadow specification - number of shadow specifications + number of shadow specifications - Creates a render node for the CSS background according to @context, + Creates a render node for the CSS background according to @context, and appends it to the current node of @snapshot, without changing the current node. + - a `GtkSnapshot` + a `GtkSnapshot` - the `GtkStyleContext` to use + the `GtkStyleContext` to use - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Creates a render node for the focus outline according to @context, + Creates a render node for the focus outline according to @context, and appends it to the current node of @snapshot, without changing the current node. + - a `GtkSnapshot` + a `GtkSnapshot` - the `GtkStyleContext` to use + the `GtkStyleContext` to use - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Creates a render node for the CSS border according to @context, + Creates a render node for the CSS border according to @context, and appends it to the current node of @snapshot, without changing the current node. + - a `GtkSnapshot` + a `GtkSnapshot` - the `GtkStyleContext` to use + the `GtkStyleContext` to use - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Draws a text caret using @snapshot at the specified index of @layout. + Draws a text caret using @snapshot at the specified index of @layout. + - snapshot to render to + snapshot to render to - a `GtkStyleContext` + a `GtkStyleContext` - X origin + X origin - Y origin + Y origin - the `PangoLayout` of the text + the `PangoLayout` of the text - the index in the `PangoLayout` + the index in the `PangoLayout` - the `PangoDirection` of the text + the `PangoDirection` of the text - Creates a render node for rendering @layout according to the style + Creates a render node for rendering @layout according to the style information in @context, and appends it to the current node of @snapshot, without changing the current node. + - a `GtkSnapshot` + a `GtkSnapshot` - the `GtkStyleContext` to use + the `GtkStyleContext` to use - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - the `PangoLayout` to render + the `PangoLayout` to render - Restores @snapshot to the state saved by a preceding call to + Restores @snapshot to the state saved by a preceding call to gtk_snapshot_save() and removes that state from the stack of saved states. + - a `GtkSnapshot` + a `GtkSnapshot` - Rotates @@snapshot's coordinate system by @angle degrees in 2D space - + Rotates @@snapshot's coordinate system by @angle degrees in 2D space - or in 3D speak, rotates around the Z axis. To rotate around other axes, use [method@Gsk.Transform.rotate_3d]. + - a `GtkSnapshot` + a `GtkSnapshot` - the rotation angle, in degrees (clockwise) + the rotation angle, in degrees (clockwise) - Rotates @snapshot's coordinate system by @angle degrees around @axis. + Rotates @snapshot's coordinate system by @angle degrees around @axis. For a rotation in 2D space, use [method@Gsk.Transform.rotate]. + - a `GtkSnapshot` + a `GtkSnapshot` - the rotation angle, in degrees (clockwise) + the rotation angle, in degrees (clockwise) - The rotation axis + The rotation axis - Makes a copy of the current state of @snapshot and saves it + Makes a copy of the current state of @snapshot and saves it on an internal stack. When [method@Gtk.Snapshot.restore] is called, @snapshot will @@ -75718,172 +79503,183 @@ the matching paired gtk_snapshot_save(). It is necessary to clear all saved states with corresponding calls to gtk_snapshot_restore(). + - a `GtkSnapshot` + a `GtkSnapshot` - Scales @snapshot's coordinate system in 2-dimensional space by + Scales @snapshot's coordinate system in 2-dimensional space by the given factors. Use [method@Gtk.Snapshot.scale_3d] to scale in all 3 dimensions. + - a `GtkSnapshot` + a `GtkSnapshot` - scaling factor on the X axis + scaling factor on the X axis - scaling factor on the Y axis + scaling factor on the Y axis - Scales @snapshot's coordinate system by the given factors. + Scales @snapshot's coordinate system by the given factors. + - a `GtkSnapshot` + a `GtkSnapshot` - scaling factor on the X axis + scaling factor on the X axis - scaling factor on the Y axis + scaling factor on the Y axis - scaling factor on the Z axis + scaling factor on the Z axis - Returns the render node that was constructed + Returns the render node that was constructed by @snapshot. After calling this function, it is no longer possible to add more nodes to @snapshot. The only function that should be called after this is g_object_unref(). + - the constructed `GskRenderNode` + the constructed `GskRenderNode` - a `GtkSnapshot` + a `GtkSnapshot` - Returns a paintable encapsulating the render node + Returns a paintable encapsulating the render node that was constructed by @snapshot. After calling this function, it is no longer possible to add more nodes to @snapshot. The only function that should be called after this is g_object_unref(). + - a new `GdkPaintable` + a new `GdkPaintable` - a `GtkSnapshot` + a `GtkSnapshot` - The size of the resulting paintable + The size of the resulting paintable or %NULL to use the bounds of the snapshot - Transforms @snapshot's coordinate system with the given @transform. + Transforms @snapshot's coordinate system with the given @transform. + - a `GtkSnapshot` + a `GtkSnapshot` - the transform to apply + the transform to apply - Transforms @snapshot's coordinate system with the given @matrix. + Transforms @snapshot's coordinate system with the given @matrix. + - a `GtkSnapshot` + a `GtkSnapshot` - the matrix to multiply the transform with + the matrix to multiply the transform with - Translates @snapshot's coordinate system by @point in 2-dimensional space. + Translates @snapshot's coordinate system by @point in 2-dimensional space. + - a `GtkSnapshot` + a `GtkSnapshot` - the point to translate the snapshot by + the point to translate the snapshot by - Translates @snapshot's coordinate system by @point. + Translates @snapshot's coordinate system by @point. + - a `GtkSnapshot` + a `GtkSnapshot` - the point to translate the snapshot by + the point to translate the snapshot by - + + + - A `GListModel` that sorts the elements of an underlying model + A `GListModel` that sorts the elements of an underlying model according to a `GtkSorter`. The model can be set up to do incremental sorting, so that @@ -75895,57 +79691,61 @@ cannot take advantage of any external knowledge when sorting. If you run into performance issues with `GtkSortListModel`, it is strongly recommended that you write your own sorting list model. + - Creates a new sort list model that uses the @sorter to sort @model. + Creates a new sort list model that uses the @sorter to sort @model. + - a new `GtkSortListModel` + a new `GtkSortListModel` - the model to sort + the model to sort - the `GtkSorter` to sort @model with, + the `GtkSorter` to sort @model with, - Returns whether incremental sorting is enabled. + Returns whether incremental sorting is enabled. See [method@Gtk.SortListModel.set_incremental]. + - %TRUE if incremental sorting is enabled + %TRUE if incremental sorting is enabled - a `GtkSortListModel` + a `GtkSortListModel` - Gets the model currently sorted or %NULL if none. + Gets the model currently sorted or %NULL if none. + - The model that gets sorted + The model that gets sorted - a `GtkSortListModel` + a `GtkSortListModel` - Estimates progress of an ongoing sorting operation. + Estimates progress of an ongoing sorting operation. The estimate is the number of items that would still need to be sorted to finish the sorting operation if this was a linear @@ -75962,34 +79762,36 @@ progress = 1.0 - pending / (double) MAX (1, g_list_model_get_n_items (model)); If no sort operation is ongoing - in particular when [property@Gtk.SortListModel:incremental] is %FALSE - this function returns 0. + - a progress estimate of remaining items to sort + a progress estimate of remaining items to sort - a `GtkSortListModel` + a `GtkSortListModel` - Gets the sorter that is used to sort @self. + Gets the sorter that is used to sort @self. + - the sorter of #self + the sorter of #self - a `GtkSortListModel` + a `GtkSortListModel` - Sets the sort model to do an incremental sort. + Sets the sort model to do an incremental sort. When incremental sorting is enabled, the `GtkSortListModel` will not do a complete sort immediately, but will instead queue an idle handler that @@ -76005,52 +79807,55 @@ By default, incremental sorting is disabled. See [method@Gtk.SortListModel.get_pending] for progress information about an ongoing incremental sorting operation. + - a `GtkSortListModel` + a `GtkSortListModel` - %TRUE to sort incrementally + %TRUE to sort incrementally - Sets the model to be sorted. + Sets the model to be sorted. The @model's item type must conform to the item type of @self. + - a `GtkSortListModel` + a `GtkSortListModel` - The model to be sorted + The model to be sorted - Sets a new sorter on @self. + Sets a new sorter on @self. + - a `GtkSortListModel` + a `GtkSortListModel` - the `GtkSorter` to sort @model with + the `GtkSorter` to sort @model with @@ -76058,43 +79863,44 @@ The @model's item type must conform to the item type of @self. - If the model should sort items incrementally. + If the model should sort items incrementally. - The model being sorted. + The model being sorted. - Estimate of unsorted items remaining. + Estimate of unsorted items remaining. - The sorter for this model. + The sorter for this model. + - Determines the direction of a sort. + Determines the direction of a sort. - Sorting is in ascending order. + Sorting is in ascending order. - Sorting is in descending order. + Sorting is in descending order. - `GtkSorter` is an object to describe sorting criteria. + `GtkSorter` is an object to describe sorting criteria. Its primary user is [class@Gtk.SortListModel] @@ -76114,8 +79920,9 @@ change the sorting by clicking on list headers. Of course, in particular for large lists, it is also possible to subclass `GtkSorter` and provide one's own sorter. + - Compares two given items according to the sort order implemented + Compares two given items according to the sort order implemented by the sorter. Sorters implement a partial order: @@ -76127,47 +79934,49 @@ Sorters implement a partial order: The sorter may signal it conforms to additional constraints via the return value of [method@Gtk.Sorter.get_order]. + - %GTK_ORDERING_EQUAL if @item1 == @item2, + %GTK_ORDERING_EQUAL if @item1 == @item2, %GTK_ORDERING_SMALLER if @item1 < @item2, %GTK_ORDERING_LARGER if @item1 > @item2 - a `GtkSorter` + a `GtkSorter` - first item to compare + first item to compare - second item to compare + second item to compare - Gets the order that @self conforms to. + Gets the order that @self conforms to. See [enum@Gtk.SorterOrder] for details of the possible return values. This function is intended to allow optimizations. + - The order + The order - a `GtkSorter` + a `GtkSorter` - Notifies all users of the sorter that it has changed. + Notifies all users of the sorter that it has changed. This emits the [signal@Gtk.Sorter::changed] signal. Users of the sorter should then update the sort order via @@ -76179,22 +79988,23 @@ the [enum@Gtk.SorterChange] documentation for details. This function is intended for implementors of `GtkSorter` subclasses and should not be called from other functions. + - a `GtkSorter` + a `GtkSorter` - How the sorter changed + How the sorter changed - Compares two given items according to the sort order implemented + Compares two given items according to the sort order implemented by the sorter. Sorters implement a partial order: @@ -76206,41 +80016,43 @@ Sorters implement a partial order: The sorter may signal it conforms to additional constraints via the return value of [method@Gtk.Sorter.get_order]. + - %GTK_ORDERING_EQUAL if @item1 == @item2, + %GTK_ORDERING_EQUAL if @item1 == @item2, %GTK_ORDERING_SMALLER if @item1 < @item2, %GTK_ORDERING_LARGER if @item1 > @item2 - a `GtkSorter` + a `GtkSorter` - first item to compare + first item to compare - second item to compare + second item to compare - Gets the order that @self conforms to. + Gets the order that @self conforms to. See [enum@Gtk.SorterOrder] for details of the possible return values. This function is intended to allow optimizations. + - The order + The order - a `GtkSorter` + a `GtkSorter` @@ -76249,7 +80061,7 @@ This function is intended to allow optimizations. - Emitted whenever the sorter changed. + Emitted whenever the sorter changed. Users of the sorter should then update the sort order again via gtk_sorter_compare(). @@ -76264,57 +80076,59 @@ the sort order without a full resorting. Refer to the - how the sorter changed + how the sorter changed - Describes changes in a sorter in more detail and allows users + Describes changes in a sorter in more detail and allows users to optimize resorting. - The sorter change cannot be described + The sorter change cannot be described by any of the other enumeration values - The sort order was inverted. Comparisons + The sort order was inverted. Comparisons that returned %GTK_ORDERING_SMALLER now return %GTK_ORDERING_LARGER and vice versa. Other comparisons return the same values as before. - The sorter is less strict: Comparisons + The sorter is less strict: Comparisons may now return %GTK_ORDERING_EQUAL that did not do so before. - The sorter is more strict: Comparisons + The sorter is more strict: Comparisons that did return %GTK_ORDERING_EQUAL may not do so anymore. - The virtual table for `GtkSorter`. + The virtual table for `GtkSorter`. + + - %GTK_ORDERING_EQUAL if @item1 == @item2, + %GTK_ORDERING_EQUAL if @item1 == @item2, %GTK_ORDERING_SMALLER if @item1 < @item2, %GTK_ORDERING_LARGER if @item1 > @item2 - a `GtkSorter` + a `GtkSorter` - first item to compare + first item to compare - second item to compare + second item to compare @@ -76322,13 +80136,14 @@ to optimize resorting. + - The order + The order - a `GtkSorter` + a `GtkSorter` @@ -76336,6 +80151,7 @@ to optimize resorting. + @@ -76343,6 +80159,7 @@ to optimize resorting. + @@ -76350,6 +80167,7 @@ to optimize resorting. + @@ -76357,6 +80175,7 @@ to optimize resorting. + @@ -76364,6 +80183,7 @@ to optimize resorting. + @@ -76371,6 +80191,7 @@ to optimize resorting. + @@ -76378,6 +80199,7 @@ to optimize resorting. + @@ -76385,6 +80207,7 @@ to optimize resorting. + @@ -76392,22 +80215,22 @@ to optimize resorting. - Describes the type of order that a `GtkSorter` may produce. + Describes the type of order that a `GtkSorter` may produce. - A partial order. Any `GtkOrdering` is possible. + A partial order. Any `GtkOrdering` is possible. - No order, all elements are considered equal. + No order, all elements are considered equal. gtk_sorter_compare() will only return %GTK_ORDERING_EQUAL. - A total order. gtk_sorter_compare() will only + A total order. gtk_sorter_compare() will only return %GTK_ORDERING_EQUAL if an item is compared with itself. Two different items will never cause this value to be returned. - A `GtkSpinButton` is an ideal way to allow the user to set the + A `GtkSpinButton` is an ideal way to allow the user to set the value of some attribute. ![An example GtkSpinButton](spinbutton.png) @@ -76526,29 +80349,30 @@ the .vertical or .horizontal style class on the main node. - Creates a new `GtkSpinButton`. + Creates a new `GtkSpinButton`. + - The new `GtkSpinButton` + The new `GtkSpinButton` - the `GtkAdjustment` that this spin button should use + the `GtkAdjustment` that this spin button should use - specifies by how much the rate of change in the value will + specifies by how much the rate of change in the value will accelerate if you continue to hold down an up/down button or arrow key - the number of decimal places to display + the number of decimal places to display - Creates a new `GtkSpinButton` with the given properties. + Creates a new `GtkSpinButton` with the given properties. This is a convenience constructor that allows creation of a numeric `GtkSpinButton` without manually creating @@ -76561,450 +80385,475 @@ Note that the way in which the precision is derived works best if @step is a power of ten. If the resulting precision is not suitable for your needs, use [method@Gtk.SpinButton.set_digits] to correct it. + - The new `GtkSpinButton` + The new `GtkSpinButton` - Minimum allowable value + Minimum allowable value - Maximum allowable value + Maximum allowable value - Increment added or subtracted by spinning the widget + Increment added or subtracted by spinning the widget - Changes the properties of an existing spin button. + Changes the properties of an existing spin button. The adjustment, climb rate, and number of decimal places are updated accordingly. + - a `GtkSpinButton` + a `GtkSpinButton` - a `GtkAdjustment` to replace the spin button’s + a `GtkAdjustment` to replace the spin button’s existing adjustment, or %NULL to leave its current adjustment unchanged - the new climb rate + the new climb rate - the number of decimal places to display in the spin button + the number of decimal places to display in the spin button - Get the adjustment associated with a `GtkSpinButton`. + Get the adjustment associated with a `GtkSpinButton`. + - the `GtkAdjustment` of @spin_button + the `GtkAdjustment` of @spin_button - a `GtkSpinButton` + a `GtkSpinButton` - Returns the acceleration rate for repeated changes. + Returns the acceleration rate for repeated changes. + - the acceleration rate + the acceleration rate - a `GtkSpinButton` + a `GtkSpinButton` - Fetches the precision of @spin_button. + Fetches the precision of @spin_button. + - the current precision + the current precision - a `GtkSpinButton` + a `GtkSpinButton` - Gets the current step and page the increments + Gets the current step and page the increments used by @spin_button. See [method@Gtk.SpinButton.set_increments]. + - a `GtkSpinButton` + a `GtkSpinButton` - location to store step increment + location to store step increment - location to store page increment + location to store page increment - Returns whether non-numeric text can be typed into the spin button. + Returns whether non-numeric text can be typed into the spin button. + - %TRUE if only numeric text can be entered + %TRUE if only numeric text can be entered - a `GtkSpinButton` + a `GtkSpinButton` - Gets the range allowed for @spin_button. + Gets the range allowed for @spin_button. See [method@Gtk.SpinButton.set_range]. + - a `GtkSpinButton` + a `GtkSpinButton` - location to store minimum allowed value + location to store minimum allowed value - location to store maximum allowed value + location to store maximum allowed value - Returns whether the values are corrected to the nearest step. + Returns whether the values are corrected to the nearest step. + - %TRUE if values are snapped to the nearest step + %TRUE if values are snapped to the nearest step - a `GtkSpinButton` + a `GtkSpinButton` - Gets the update behavior of a spin button. + Gets the update behavior of a spin button. See [method@Gtk.SpinButton.set_update_policy]. + - the current update policy + the current update policy - a `GtkSpinButton` + a `GtkSpinButton` - Get the value in the @spin_button. + Get the value in the @spin_button. + - the value of @spin_button + the value of @spin_button - a `GtkSpinButton` + a `GtkSpinButton` - Get the value @spin_button represented as an integer. + Get the value @spin_button represented as an integer. + - the value of @spin_button + the value of @spin_button - a `GtkSpinButton` + a `GtkSpinButton` - Returns whether the spin button’s value wraps around to the + Returns whether the spin button’s value wraps around to the opposite limit when the upper or lower limit of the range is exceeded. + - %TRUE if the spin button wraps around + %TRUE if the spin button wraps around - a `GtkSpinButton` + a `GtkSpinButton` - Replaces the `GtkAdjustment` associated with @spin_button. + Replaces the `GtkAdjustment` associated with @spin_button. + - a `GtkSpinButton` + a `GtkSpinButton` - a `GtkAdjustment` to replace the existing adjustment + a `GtkAdjustment` to replace the existing adjustment - Sets the acceleration rate for repeated changes when you + Sets the acceleration rate for repeated changes when you hold down a button or key. + - a `GtkSpinButton` + a `GtkSpinButton` - the rate of acceleration, must be >= 0 + the rate of acceleration, must be >= 0 - Set the precision to be displayed by @spin_button. + Set the precision to be displayed by @spin_button. Up to 20 digit precision is allowed. + - a `GtkSpinButton` + a `GtkSpinButton` - the number of digits after the decimal point to be + the number of digits after the decimal point to be displayed for the spin button’s value - Sets the step and page increments for spin_button. + Sets the step and page increments for spin_button. This affects how quickly the value changes when the spin button’s arrows are activated. + - a `GtkSpinButton` + a `GtkSpinButton` - increment applied for a button 1 press. + increment applied for a button 1 press. - increment applied for a button 2 press. + increment applied for a button 2 press. - Sets the flag that determines if non-numeric text can be typed + Sets the flag that determines if non-numeric text can be typed into the spin button. + - a `GtkSpinButton` + a `GtkSpinButton` - flag indicating if only numeric entry is allowed + flag indicating if only numeric entry is allowed - Sets the minimum and maximum allowable values for @spin_button. + Sets the minimum and maximum allowable values for @spin_button. If the current value is outside this range, it will be adjusted to fit within the range, otherwise it will remain unchanged. + - a `GtkSpinButton` + a `GtkSpinButton` - minimum allowable value + minimum allowable value - maximum allowable value + maximum allowable value - Sets the policy as to whether values are corrected to the + Sets the policy as to whether values are corrected to the nearest step increment when a spin button is activated after providing an invalid value. + - a `GtkSpinButton` + a `GtkSpinButton` - a flag indicating if invalid values should be corrected + a flag indicating if invalid values should be corrected - Sets the update behavior of a spin button. + Sets the update behavior of a spin button. This determines whether the spin button is always updated or only when a valid value is set. + - a `GtkSpinButton` + a `GtkSpinButton` - a `GtkSpinButtonUpdatePolicy` value + a `GtkSpinButtonUpdatePolicy` value - Sets the value of @spin_button. + Sets the value of @spin_button. + - a `GtkSpinButton` + a `GtkSpinButton` - the new value + the new value - Sets the flag that determines if a spin button value wraps + Sets the flag that determines if a spin button value wraps around to the opposite limit when the upper or lower limit of the range is exceeded. + - a `GtkSpinButton` + a `GtkSpinButton` - a flag indicating if wrapping behavior is performed + a flag indicating if wrapping behavior is performed - Increment or decrement a spin button’s value in a specified + Increment or decrement a spin button’s value in a specified direction by a specified amount. + - a `GtkSpinButton` + a `GtkSpinButton` - a `GtkSpinType` indicating the direction to spin + a `GtkSpinType` indicating the direction to spin - step increment to apply in the specified direction + step increment to apply in the specified direction - Manually force an update of the spin button. + Manually force an update of the spin button. + - a `GtkSpinButton` + a `GtkSpinButton` @@ -77012,55 +80861,55 @@ direction by a specified amount. - The adjustment that holds the value of the spin button. + The adjustment that holds the value of the spin button. - The acceleration rate when you hold down a button or key. + The acceleration rate when you hold down a button or key. - The number of decimal places to display. + The number of decimal places to display. - Whether non-numeric characters should be ignored. + Whether non-numeric characters should be ignored. - Whether erroneous values are automatically changed to the spin buttons + Whether erroneous values are automatically changed to the spin buttons nearest step increment. - Whether the spin button should update always, or only when the value + Whether the spin button should update always, or only when the value is acceptable. - The current value. + The current value. - Whether a spin button should wrap upon reaching its limits. + Whether a spin button should wrap upon reaching its limits. - Emitted when the user initiates a value change. + Emitted when the user initiates a value change. This is a [keybinding signal](class.SignalAction.html). @@ -77074,13 +80923,13 @@ The default bindings for this signal are Up/Down and PageUp/PageDown. - a `GtkScrollType` to specify the speed and amount of change + a `GtkScrollType` to specify the speed and amount of change - Emitted to convert the users input into a double value. + Emitted to convert the users input into a double value. The signal handler is expected to use [method@Gtk.Editable.get_text] to retrieve the text of the spinbutton and set @new_value to the @@ -77088,19 +80937,19 @@ new value. The default conversion uses g_strtod(). - %TRUE for a successful conversion, %FALSE if the input + %TRUE for a successful conversion, %FALSE if the input was not handled, and %GTK_INPUT_ERROR if the conversion failed. - return location for the new value + return location for the new value - Emitted to tweak the formatting of the value for display. + Emitted to tweak the formatting of the value for display. ```c // show leading zeros @@ -77122,12 +80971,12 @@ on_output (GtkSpinButton *spin, } ``` - %TRUE if the value has been displayed + %TRUE if the value has been displayed - Emitted when the value is changed. + Emitted when the value is changed. Also see the [signal@Gtk.SpinButton::output] signal. @@ -77135,7 +80984,7 @@ Also see the [signal@Gtk.SpinButton::output] signal. - Emitted right after the spinbutton wraps from its maximum + Emitted right after the spinbutton wraps from its maximum to its minimum value or vice-versa. @@ -77143,47 +80992,47 @@ to its minimum value or vice-versa. - Determines whether the spin button displays values outside the adjustment + Determines whether the spin button displays values outside the adjustment bounds. See [method@Gtk.SpinButton.set_update_policy]. - When refreshing your `GtkSpinButton`, the value is + When refreshing your `GtkSpinButton`, the value is always displayed - When refreshing your `GtkSpinButton`, the value is + When refreshing your `GtkSpinButton`, the value is only displayed if it is valid within the bounds of the spin button's adjustment - The values of the GtkSpinType enumeration are used to specify the + The values of the GtkSpinType enumeration are used to specify the change to make in gtk_spin_button_spin(). - Increment by the adjustments step increment. + Increment by the adjustments step increment. - Decrement by the adjustments step increment. + Decrement by the adjustments step increment. - Increment by the adjustments page increment. + Increment by the adjustments page increment. - Decrement by the adjustments page increment. + Decrement by the adjustments page increment. - Go to the adjustments lower bound. + Go to the adjustments lower bound. - Go to the adjustments upper bound. + Go to the adjustments upper bound. - Change by a specified amount. + Change by a specified amount. - A `GtkSpinner` widget displays an icon-size spinning animation. + A `GtkSpinner` widget displays an icon-size spinning animation. It is often used as an alternative to a [class@Gtk.ProgressBar] for displaying indefinite activity, instead of actual progress. @@ -77202,63 +81051,68 @@ added to this node. - Returns a new spinner widget. Not yet started. + Returns a new spinner widget. Not yet started. + - a new `GtkSpinner` + a new `GtkSpinner` - Returns whether the spinner is spinning. + Returns whether the spinner is spinning. + - %TRUE if the spinner is active + %TRUE if the spinner is active - a `GtkSpinner` + a `GtkSpinner` - Sets the activity of the spinner. + Sets the activity of the spinner. + - a `GtkSpinner` + a `GtkSpinner` - whether the spinner should be spinning + whether the spinner should be spinning - Starts the animation of the spinner. + Starts the animation of the spinner. + - a `GtkSpinner` + a `GtkSpinner` - Stops the animation of the spinner. + Stops the animation of the spinner. + - a `GtkSpinner` + a `GtkSpinner` @@ -77266,12 +81120,12 @@ added to this node. - Whether the spinner is spinning + Whether the spinner is spinning - `GtkStack` is a container which only shows one of its children + `GtkStack` is a container which only shows one of its children at a time. In contrast to `GtkNotebook`, `GtkStack` does not provide a means @@ -77322,338 +81176,357 @@ pages, which are the accessible parent objects of the child widgets. - Creates a new `GtkStack`. + Creates a new `GtkStack`. + - a new `GtkStack` + a new `GtkStack` - Adds a child to @stack. + Adds a child to @stack. + - the `GtkStackPage` for @child + the `GtkStackPage` for @child - a `GtkStack` + a `GtkStack` - the widget to add + the widget to add - Adds a child to @stack. + Adds a child to @stack. The child is identified by the @name. + - the `GtkStackPage` for @child + the `GtkStackPage` for @child - a `GtkStack` + a `GtkStack` - the widget to add + the widget to add - the name for @child + the name for @child - Adds a child to @stack. + Adds a child to @stack. The child is identified by the @name. The @title will be used by `GtkStackSwitcher` to represent @child in a tab bar, so it should be short. + - the `GtkStackPage` for @child + the `GtkStackPage` for @child - a `GtkStack` + a `GtkStack` - the widget to add + the widget to add - the name for @child + the name for @child - a human-readable title for @child + a human-readable title for @child - Finds the child with the name given as the argument. + Finds the child with the name given as the argument. Returns %NULL if there is no child with this name. + - the requested child + the requested child of the `GtkStack` - a `GtkStack` + a `GtkStack` - the name of the child to find + the name of the child to find - Gets whether @stack is horizontally homogeneous. + Gets whether @stack is horizontally homogeneous. + - whether @stack is horizontally homogeneous. + whether @stack is horizontally homogeneous. - a `GtkStack` + a `GtkStack` - Returns whether the `GtkStack` is set up to interpolate between + Returns whether the `GtkStack` is set up to interpolate between the sizes of children on page switch. + - %TRUE if child sizes are interpolated + %TRUE if child sizes are interpolated - A `GtkStack` + A `GtkStack` - Returns the `GtkStackPage` object for @child. + Returns the `GtkStackPage` object for @child. + - the `GtkStackPage` for @child + the `GtkStackPage` for @child - a `GtkStack` + a `GtkStack` - a child of @stack + a child of @stack - Returns a `GListModel` that contains the pages of the stack. + Returns a `GListModel` that contains the pages of the stack. This can be used to keep an up-to-date view. The model also implements [iface@Gtk.SelectionModel] and can be used to track and modify the visible page. + - a `GtkSelectionModel` for the stack's children + a `GtkSelectionModel` for the stack's children - a `GtkStack` + a `GtkStack` - Returns the amount of time (in milliseconds) that + Returns the amount of time (in milliseconds) that transitions between pages in @stack will take. + - the transition duration + the transition duration - a `GtkStack` + a `GtkStack` - Returns whether the @stack is currently in a transition from one page to + Returns whether the @stack is currently in a transition from one page to another. + - %TRUE if the transition is currently running, %FALSE otherwise. + %TRUE if the transition is currently running, %FALSE otherwise. - a `GtkStack` + a `GtkStack` - Gets the type of animation that will be used + Gets the type of animation that will be used for transitions between pages in @stack. + - the current transition type of @stack + the current transition type of @stack - a `GtkStack` + a `GtkStack` - Gets whether @stack is vertically homogeneous. + Gets whether @stack is vertically homogeneous. + - whether @stack is vertically homogeneous. + whether @stack is vertically homogeneous. - a `GtkStack` + a `GtkStack` - Gets the currently visible child of @stack. + Gets the currently visible child of @stack. Returns %NULL if there are no visible children. + - the visible child of the `GtkStack` + the visible child of the `GtkStack` - a `GtkStack` + a `GtkStack` - Returns the name of the currently visible child of @stack. + Returns the name of the currently visible child of @stack. Returns %NULL if there is no visible child. + - the name of the visible child + the name of the visible child of the `GtkStack` - a `GtkStack` + a `GtkStack` - Removes a child widget from @stack. + Removes a child widget from @stack. + - a `GtkStack` + a `GtkStack` - the child to remove + the child to remove - Sets the `GtkStack` to be horizontally homogeneous or not. + Sets the `GtkStack` to be horizontally homogeneous or not. If it is homogeneous, the `GtkStack` will request the same width for all its children. If it isn't, the stack may change width when a different child becomes visible. + - a `GtkStack` + a `GtkStack` - %TRUE to make @stack horizontally homogeneous + %TRUE to make @stack horizontally homogeneous - Sets whether or not @stack will interpolate its size when + Sets whether or not @stack will interpolate its size when changing the visible child. If the [property@Gtk.Stack:interpolate-size] property is set to %TRUE, @stack will interpolate its size between the current one and the one it'll take after changing the visible child, according to the set transition duration. + - A `GtkStack` + A `GtkStack` - the new value + the new value - Sets the duration that transitions between pages in @stack + Sets the duration that transitions between pages in @stack will take. + - a `GtkStack` + a `GtkStack` - the new duration, in milliseconds + the new duration, in milliseconds - Sets the type of animation that will be used for + Sets the type of animation that will be used for transitions between pages in @stack. Available types include various kinds of fades and slides. @@ -77661,44 +81534,46 @@ Available types include various kinds of fades and slides. The transition type can be changed without problems at runtime, so it is possible to change the animation based on the page that is about to become current. + - a `GtkStack` + a `GtkStack` - the new transition type + the new transition type - Sets the `GtkStack` to be vertically homogeneous or not. + Sets the `GtkStack` to be vertically homogeneous or not. If it is homogeneous, the `GtkStack` will request the same height for all its children. If it isn't, the stack may change height when a different child becomes visible. + - a `GtkStack` + a `GtkStack` - %TRUE to make @stack vertically homogeneous + %TRUE to make @stack vertically homogeneous - Makes @child the visible child of @stack. + Makes @child the visible child of @stack. If @child is different from the currently visible child, the transition between the two will be animated with the @@ -77707,47 +81582,49 @@ current transition type of @stack. Note that the @child widget has to be visible itself (see [method@Gtk.Widget.show]) in order to become the visible child of @stack. + - a `GtkStack` + a `GtkStack` - a child of @stack + a child of @stack - Makes the child with the given name visible. + Makes the child with the given name visible. Note that the child widget has to be visible itself (see [method@Gtk.Widget.show]) in order to become the visible child of @stack. + - a `GtkStack` + a `GtkStack` - the name of the child to make visible + the name of the child to make visible - the transition type to use + the transition type to use - Makes the child with the given name visible. + Makes the child with the given name visible. If @child is different from the currently visible child, the transition between the two will be animated with the @@ -77756,16 +81633,17 @@ current transition type of @stack. Note that the child widget has to be visible itself (see [method@Gtk.Widget.show]) in order to become the visible child of @stack. + - a `GtkStack` + a `GtkStack` - the name of the child to make visible + the name of the child to make visible @@ -77773,284 +81651,297 @@ child of @stack. - %TRUE if the stack allocates the same width for all children. + %TRUE if the stack allocates the same width for all children. - Whether or not the size should smoothly change during the transition. + Whether or not the size should smoothly change during the transition. - A selection model with the stack pages. + A selection model with the stack pages. - The animation duration, in milliseconds. + The animation duration, in milliseconds. - Whether or not the transition is currently running. + Whether or not the transition is currently running. - The type of animation used to transition. + The type of animation used to transition. - %TRUE if the stack allocates the same height for all children. + %TRUE if the stack allocates the same height for all children. - The widget currently visible in the stack. + The widget currently visible in the stack. - The name of the widget currently visible in the stack. + The name of the widget currently visible in the stack. - `GtkStackPage` is an auxiliary class used by `GtkStack`. + `GtkStackPage` is an auxiliary class used by `GtkStack`. - Returns the stack child to which @self belongs. + Returns the stack child to which @self belongs. + - the child to which @self belongs + the child to which @self belongs - a `GtkStackPage` + a `GtkStackPage` - Returns the icon name of the page. + Returns the icon name of the page. + - The value of the [property@Gtk.StackPage:icon-name] property + The value of the [property@Gtk.StackPage:icon-name] property - a `GtkStackPage` + a `GtkStackPage` - Returns the name of the page. + Returns the name of the page. + - The value of the [property@Gtk.StackPage:name] property + The value of the [property@Gtk.StackPage:name] property - a `GtkStackPage` + a `GtkStackPage` - Returns whether the page is marked as “needs attention”. + Returns whether the page is marked as “needs attention”. + - The value of the [property@Gtk.StackPage:needs-attention] + The value of the [property@Gtk.StackPage:needs-attention] property. - a `GtkStackPage` + a `GtkStackPage` - Gets the page title. + Gets the page title. + - The value of the [property@Gtk.StackPage:title] property + The value of the [property@Gtk.StackPage:title] property - a `GtkStackPage` + a `GtkStackPage` - Gets whether underlines in the page title indicate mnemonics. + Gets whether underlines in the page title indicate mnemonics. + - The value of the [property@Gtk.StackPage:use-underline] property + The value of the [property@Gtk.StackPage:use-underline] property - a `GtkStackPage` + a `GtkStackPage` - Returns whether @page is visible in its `GtkStack`. + Returns whether @page is visible in its `GtkStack`. This is independent from the [property@Gtk.Widget:visible] property of its widget. + - %TRUE if @page is visible + %TRUE if @page is visible - a `GtkStackPage` + a `GtkStackPage` - Sets the icon name of the page. + Sets the icon name of the page. + - a `GtkStackPage` + a `GtkStackPage` - the new value to set + the new value to set - Sets the name of the page. + Sets the name of the page. + - a `GtkStackPage` + a `GtkStackPage` - the new value to set + the new value to set - Sets whether the page is marked as “needs attention”. + Sets whether the page is marked as “needs attention”. + - a `GtkStackPage` + a `GtkStackPage` - the new value to set + the new value to set - Sets the page title. + Sets the page title. + - a `GtkStackPage` + a `GtkStackPage` - the new value to set + the new value to set - Sets whether underlines in the page title indicate mnemonics. + Sets whether underlines in the page title indicate mnemonics. + - a `GtkStackPage` + a `GtkStackPage` - the new value to set + the new value to set - Sets whether @page is visible in its `GtkStack`. + Sets whether @page is visible in its `GtkStack`. + - a `GtkStackPage` + a `GtkStackPage` - The new property value + The new property value - The child that this page is for. + The child that this page is for. - The icon name of the child page. + The icon name of the child page. - The name of the child page. + The name of the child page. - Whether the page requires the user attention. + Whether the page requires the user attention. This is used by the [class@Gtk.StackSwitcher] to change the appearance of the corresponding button when a page needs @@ -78060,24 +81951,24 @@ attention and it is not the current one. - The title of the child page. + The title of the child page. - If set, an underline in the title indicates a mnemonic. + If set, an underline in the title indicates a mnemonic. - Whether this page is visible. + Whether this page is visible. - A `GtkStackSidebar` uses a sidebar to switch between `GtkStack` pages. + A `GtkStackSidebar` uses a sidebar to switch between `GtkStack` pages. In order to use a `GtkStackSidebar`, you simply use a `GtkStack` to organize your UI flow, and add the sidebar to your sidebar area. You @@ -78096,43 +81987,46 @@ pages. - Creates a new `GtkStackSidebar`. + Creates a new `GtkStackSidebar`. + - the new `GtkStackSidebar` + the new `GtkStackSidebar` - Retrieves the stack. + Retrieves the stack. + - the associated `GtkStack` or + the associated `GtkStack` or %NULL if none has been set explicitly - a `GtkStackSidebar` + a `GtkStackSidebar` - Set the `GtkStack` associated with this `GtkStackSidebar`. + Set the `GtkStack` associated with this `GtkStackSidebar`. The sidebar widget will automatically update according to the order and items within the given `GtkStack`. + - a `GtkStackSidebar` + a `GtkStackSidebar` - a `GtkStack` + a `GtkStack` @@ -78140,12 +82034,12 @@ the order and items within the given `GtkStack`. - The stack. + The stack. - The `GtkStackSwitcher` shows a row of buttons to switch between `GtkStack` + The `GtkStackSwitcher` shows a row of buttons to switch between `GtkStack` pages. ![An example GtkStackSwitcher](stackswitcher.png) @@ -78183,39 +82077,42 @@ the stack switcher to be made vertical with - Create a new `GtkStackSwitcher`. + Create a new `GtkStackSwitcher`. + - a new `GtkStackSwitcher`. + a new `GtkStackSwitcher`. - Retrieves the stack. + Retrieves the stack. + - the stack + the stack - a `GtkStackSwitcher` + a `GtkStackSwitcher` - Sets the stack to control. + Sets the stack to control. + - a `GtkStackSwitcher` + a `GtkStackSwitcher` - a `GtkStack` + a `GtkStack` @@ -78223,141 +82120,141 @@ the stack switcher to be made vertical with - The stack. + The stack. - Possible transitions between pages in a `GtkStack` widget. + Possible transitions between pages in a `GtkStack` widget. New values may be added to this enumeration over time. - No transition + No transition - A cross-fade + A cross-fade - Slide from left to right + Slide from left to right - Slide from right to left + Slide from right to left - Slide from bottom up + Slide from bottom up - Slide from top down + Slide from top down - Slide from left or right according to the children order + Slide from left or right according to the children order - Slide from top down or bottom up according to the order + Slide from top down or bottom up according to the order - Cover the old page by sliding up + Cover the old page by sliding up - Cover the old page by sliding down + Cover the old page by sliding down - Cover the old page by sliding to the left + Cover the old page by sliding to the left - Cover the old page by sliding to the right + Cover the old page by sliding to the right - Uncover the new page by sliding up + Uncover the new page by sliding up - Uncover the new page by sliding down + Uncover the new page by sliding down - Uncover the new page by sliding to the left + Uncover the new page by sliding to the left - Uncover the new page by sliding to the right + Uncover the new page by sliding to the right - Cover the old page sliding up or uncover the new page sliding down, according to order + Cover the old page sliding up or uncover the new page sliding down, according to order - Cover the old page sliding down or uncover the new page sliding up, according to order + Cover the old page sliding down or uncover the new page sliding up, according to order - Cover the old page sliding left or uncover the new page sliding right, according to order + Cover the old page sliding left or uncover the new page sliding right, according to order - Cover the old page sliding right or uncover the new page sliding left, according to order + Cover the old page sliding right or uncover the new page sliding left, according to order - Pretend the pages are sides of a cube and rotate that cube to the left + Pretend the pages are sides of a cube and rotate that cube to the left - Pretend the pages are sides of a cube and rotate that cube to the right + Pretend the pages are sides of a cube and rotate that cube to the right - Pretend the pages are sides of a cube and rotate that cube to the left or right according to the children order + Pretend the pages are sides of a cube and rotate that cube to the left or right according to the children order - Describes a widget state. + Describes a widget state. Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names. - State during normal operation + State during normal operation - Widget is active + Widget is active - Widget has a mouse pointer over it + Widget has a mouse pointer over it - Widget is selected + Widget is selected - Widget is insensitive + Widget is insensitive - Widget is inconsistent + Widget is inconsistent - Widget has the keyboard focus + Widget has the keyboard focus - Widget is in a background toplevel window + Widget is in a background toplevel window - Widget is in left-to-right text direction + Widget is in left-to-right text direction - Widget is in right-to-left text direction + Widget is in right-to-left text direction - Widget is a link + Widget is a link - The location the widget points to has already been visited + The location the widget points to has already been visited - Widget is checked + Widget is checked - Widget is highlighted as a drop target for DND + Widget is highlighted as a drop target for DND - Widget has the visible focus + Widget has the visible focus - Widget contains the keyboard focus + Widget contains the keyboard focus - A `GtkStatusbar` widget is usually placed along the bottom of an application's + A `GtkStatusbar` widget is usually placed along the bottom of an application's main [class@Gtk.Window]. ![An example GtkStatusbar](statusbar.png) @@ -78397,150 +82294,156 @@ using [method@Gtk.Statusbar.remove]. - Creates a new `GtkStatusbar` ready for messages. + Creates a new `GtkStatusbar` ready for messages. + - the new `GtkStatusbar` + the new `GtkStatusbar` - Returns a new context identifier, given a description + Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI. + - an integer id + an integer id - a `GtkStatusbar` + a `GtkStatusbar` - textual description of what context + textual description of what context the new message is being used in - Removes the first message in the `GtkStatusbar`’s stack + Removes the first message in the `GtkStatusbar`’s stack with the given context id. Note that this may not change the displayed message, if the message at the top of the stack has a different context id. + - a `GtkStatusbar` + a `GtkStatusbar` - a context identifier + a context identifier - Pushes a new message onto a statusbar’s stack. + Pushes a new message onto a statusbar’s stack. + - a message id that can be used with + a message id that can be used with [method@Gtk.Statusbar.remove]. - a `GtkStatusbar` + a `GtkStatusbar` - the message’s context id, as returned by + the message’s context id, as returned by gtk_statusbar_get_context_id() - the message to add to the statusbar + the message to add to the statusbar - Forces the removal of a message from a statusbar’s stack. + Forces the removal of a message from a statusbar’s stack. The exact @context_id and @message_id must be specified. + - a `GtkStatusbar` + a `GtkStatusbar` - a context identifier + a context identifier - a message identifier, as returned by [method@Gtk.Statusbar.push] + a message identifier, as returned by [method@Gtk.Statusbar.push] - Forces the removal of all messages from a statusbar's + Forces the removal of all messages from a statusbar's stack with the exact @context_id. + - a `GtkStatusbar` + a `GtkStatusbar` - a context identifier + a context identifier - Emitted whenever a new message is popped off a statusbar's stack. + Emitted whenever a new message is popped off a statusbar's stack. - the context id of the relevant message/statusbar + the context id of the relevant message/statusbar - the message that was just popped + the message that was just popped - Emitted whenever a new message gets pushed onto a statusbar's stack. + Emitted whenever a new message gets pushed onto a statusbar's stack. - the context id of the relevant message/statusbar + the context id of the relevant message/statusbar - the message that was pushed + the message that was pushed - `GtkStringFilter` determines whether to include items by comparing + `GtkStringFilter` determines whether to include items by comparing strings to a fixed search term. The strings are obtained from the items by evaluating a `GtkExpression` @@ -78553,146 +82456,156 @@ can match the whole string, just a prefix, or any substring. Use It is also possible to make case-insensitive comparisons, with [method@Gtk.StringFilter.set_ignore_case]. + - Creates a new string filter. + Creates a new string filter. You will want to set up the filter by providing a string to search for and by providing a property to look up on the item. + - a new `GtkStringFilter` + a new `GtkStringFilter` - The expression to evaluate + The expression to evaluate - Gets the expression that the string filter uses to + Gets the expression that the string filter uses to obtain strings from items. + - a `GtkExpression` + a `GtkExpression` - a `GtkStringFilter` + a `GtkStringFilter` - Returns whether the filter ignores case differences. + Returns whether the filter ignores case differences. + - %TRUE if the filter ignores case + %TRUE if the filter ignores case - a `GtkStringFilter` + a `GtkStringFilter` - Returns the match mode that the filter is using. + Returns the match mode that the filter is using. + - the match mode of the filter + the match mode of the filter - a `GtkStringFilter` + a `GtkStringFilter` - Gets the search term. + Gets the search term. + - The search term + The search term - a `GtkStringFilter` + a `GtkStringFilter` - Sets the expression that the string filter uses to + Sets the expression that the string filter uses to obtain strings from items. The expression must have a value type of %G_TYPE_STRING. + - a `GtkStringFilter` + a `GtkStringFilter` - a `GtkExpression` + a `GtkExpression` - Sets whether the filter ignores case differences. + Sets whether the filter ignores case differences. + - a `GtkStringFilter` + a `GtkStringFilter` - %TRUE to ignore case + %TRUE to ignore case - Sets the match mode for the filter. + Sets the match mode for the filter. + - a `GtkStringFilter` + a `GtkStringFilter` - the new match mode + the new match mode - Sets the string to search for. + Sets the string to search for. + - a `GtkStringFilter` + a `GtkStringFilter` - The string to search for + The string to search for or %NULL to clear the search @@ -78701,50 +82614,51 @@ The expression must have a value type of %G_TYPE_STRING. - The expression to evaluate on item to get a string to compare with. + The expression to evaluate on item to get a string to compare with. - If matching is case sensitive. + If matching is case sensitive. - If exact matches are necessary or if substrings are allowed. + If exact matches are necessary or if substrings are allowed. - The search term. + The search term. + - Specifies how search strings are matched inside text. + Specifies how search strings are matched inside text. - The search string and + The search string and text must match exactly. - The search string + The search string must be contained as a substring inside the text. - The text must begin + The text must begin with the search string. - `GtkStringList` is a list model that wraps an array of strings. + `GtkStringList` is a list model that wraps an array of strings. The objects in the model have a "string" property. @@ -78770,17 +82684,19 @@ Here is a UI definition fragment specifying a `GtkStringList` </items> </object> ``` + - Creates a new `GtkStringList` with the given @strings. + Creates a new `GtkStringList` with the given @strings. + - a new `GtkStringList` + a new `GtkStringList` - The strings to put in the model + The strings to put in the model @@ -78788,67 +82704,70 @@ Here is a UI definition fragment specifying a `GtkStringList` - Appends @string to @self. + Appends @string to @self. The @string will be copied. See [method@Gtk.StringList.take] for a way to avoid that. + - a `GtkStringList` + a `GtkStringList` - the string to insert + the string to insert - Gets the string that is at @position in @self. + Gets the string that is at @position in @self. If @self does not contain @position items, %NULL is returned. This function returns the const char *. To get the object wrapping it, use g_list_model_get_item(). + - the string at the given position + the string at the given position - a `GtkStringList` + a `GtkStringList` - the position to get the string for + the position to get the string for - Removes the string at @position from @self. + Removes the string at @position from @self. @position must be smaller than the current length of the list. + - a `GtkStringList` + a `GtkStringList` - the position of the string that is to be removed + the position of the string that is to be removed - Changes @self by removing @n_removals strings and adding @additions + Changes @self by removing @n_removals strings and adding @additions to it. This function is more efficient than [method@Gtk.StringList.append] @@ -78860,24 +82779,25 @@ This function copies the strings 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). + - a `GtkStringList` + a `GtkStringList` - the position at which to make the change + the position at which to make the change - the number of strings to remove + the number of strings to remove - The strings to add + The strings to add @@ -78885,7 +82805,7 @@ of the list at the time this function is called). - Adds @string to self at the end, and takes + Adds @string to self at the end, and takes ownership of it. This variant of [method@Gtk.StringList.append] @@ -78894,71 +82814,77 @@ is convenient for formatting strings: ```c gtk_string_list_take (self, g_strdup_print ("%d dollars", lots)); ``` + - a `GtkStringList` + a `GtkStringList` - the string to insert + the string to insert + - `GtkStringObject` is the type of items in a `GtkStringList`. + `GtkStringObject` is the type of items in a `GtkStringList`. A `GtkStringObject` is a wrapper around a `const char*`; it has a [property@Gtk.StringObject:string] property. + - Wraps a string in an object for use with `GListModel`. + Wraps a string in an object for use with `GListModel`. + - a new `GtkStringObject` + a new `GtkStringObject` - The string to wrap + The string to wrap - Returns the string contained in a `GtkStringObject`. + Returns the string contained in a `GtkStringObject`. + - the string of @self + the string of @self - a `GtkStringObject` + a `GtkStringObject` - The string. + The string. + - `GtkStringSorter` is a `GtkSorter` that compares strings. + `GtkStringSorter` is a `GtkSorter` that compares strings. It does the comparison in a linguistically correct way using the current locale by normalizing Unicode strings and possibly case-folding @@ -78966,83 +82892,89 @@ them before performing the comparison. To obtain the strings to compare, this sorter evaluates a [class@Gtk.Expression]. + - Creates a new string sorter that compares items using the given + Creates a new string sorter that compares items using the given @expression. Unless an expression is set on it, this sorter will always compare items as invalid. + - a new `GtkStringSorter` + a new `GtkStringSorter` - The expression to evaluate + The expression to evaluate - Gets the expression that is evaluated to obtain strings from items. + Gets the expression that is evaluated to obtain strings from items. + - a `GtkExpression` + a `GtkExpression` - a `GtkStringSorter` + a `GtkStringSorter` - Gets whether the sorter ignores case differences. + Gets whether the sorter ignores case differences. + - %TRUE if @self is ignoring case differences + %TRUE if @self is ignoring case differences - a `GtkStringSorter` + a `GtkStringSorter` - Sets the expression that is evaluated to obtain strings from items. + Sets the expression that is evaluated to obtain strings from items. The expression must have the type %G_TYPE_STRING. + - a `GtkStringSorter` + a `GtkStringSorter` - a `GtkExpression` + a `GtkExpression` - Sets whether the sorter will ignore case differences. + Sets whether the sorter will ignore case differences. + - a `GtkStringSorter` + a `GtkStringSorter` - %TRUE to ignore case differences + %TRUE to ignore case differences @@ -79050,23 +82982,24 @@ The expression must have the type %G_TYPE_STRING. - The expression to evaluate on item to get a string to compare with. + The expression to evaluate on item to get a string to compare with. - If matching is case sensitive. + If matching is case sensitive. + - `GtkStyleContext` stores styling information affecting a widget. + `GtkStyleContext` stores styling information affecting a widget. In order to construct the final style information, `GtkStyleContext` queries information from all attached `GtkStyleProviders`. Style @@ -79103,8 +83036,9 @@ priority, keep in mind that the user settings in `XDG_CONFIG_HOME/gtk-4.0/gtk.css` will still take precedence over your changes, as it uses the %GTK_STYLE_PROVIDER_PRIORITY_USER priority. + - Adds a global style provider to @display, which will be used + Adds a global style provider to @display, which will be used in style construction for all `GtkStyleContexts` under @display. GTK uses this to make styling information from `GtkSettings` @@ -79113,20 +83047,21 @@ available. Note: If both priorities are the same, A `GtkStyleProvider` added through [method@Gtk.StyleContext.add_provider] takes precedence over another added through this function. + - a `GdkDisplay` + a `GdkDisplay` - a `GtkStyleProvider` + a `GtkStyleProvider` - the priority of the style provider. The lower + the priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and @@ -79136,22 +83071,24 @@ precedence over another added through this function. - Removes @provider from the global style providers list in @display. + Removes @provider from the global style providers list in @display. + - a `GdkDisplay` + a `GdkDisplay` - a `GtkStyleProvider` + a `GtkStyleProvider` + @@ -79162,7 +83099,7 @@ precedence over another added through this function. - Adds a style class to @context, so later uses of the + Adds a style class to @context, so later uses of the style context will make use of this new class for styling. In the CSS file format, a `GtkEntry` defining a “search” @@ -79177,22 +83114,23 @@ matched by: ```css .search { ... } ``` + - a `GtkStyleContext` + a `GtkStyleContext` - class name to use in styling + class name to use in styling - Adds a style provider to @context, to be used in style construction. + Adds a style provider to @context, to be used in style construction. Note that a style provider added by this function only affects the style of the widget to which @context belongs. If you want @@ -79202,20 +83140,21 @@ to affect the style of all widgets, use Note: If both priorities are the same, a `GtkStyleProvider` added through this function takes precedence over another added through [func@Gtk.StyleContext.add_provider_for_display]. + - a `GtkStyleContext` + a `GtkStyleContext` - a `GtkStyleProvider` + a `GtkStyleProvider` - the priority of the style provider. The lower + the priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and @@ -79225,201 +83164,213 @@ through [func@Gtk.StyleContext.add_provider_for_display]. - Gets the border for a given state as a `GtkBorder`. + Gets the border for a given state as a `GtkBorder`. + - a `GtkStyleContext` + a `GtkStyleContext` - return value for the border settings + return value for the border settings - Gets the foreground color for a given state. + Gets the foreground color for a given state. + - a `GtkStyleContext` + a `GtkStyleContext` - return value for the foreground color + return value for the foreground color - Returns the `GdkDisplay` to which @context is attached. + Returns the `GdkDisplay` to which @context is attached. + - a `GdkDisplay`. + a `GdkDisplay`. - a `GtkStyleContext` + a `GtkStyleContext` - Gets the margin for a given state as a `GtkBorder`. + Gets the margin for a given state as a `GtkBorder`. + - a `GtkStyleContext` + a `GtkStyleContext` - return value for the margin settings + return value for the margin settings - Gets the padding for a given state as a `GtkBorder`. + Gets the padding for a given state as a `GtkBorder`. + - a `GtkStyleContext` + a `GtkStyleContext` - return value for the padding settings + return value for the padding settings - Returns the scale used for assets. + Returns the scale used for assets. + - the scale + the scale - a `GtkStyleContext` + a `GtkStyleContext` - Returns the state used for style matching. + Returns the state used for style matching. This method should only be used to retrieve the `GtkStateFlags` to pass to `GtkStyleContext` methods, like [method@Gtk.StyleContext.get_padding]. If you need to retrieve the current state of a `GtkWidget`, use [method@Gtk.Widget.get_state_flags]. + - the state flags + the state flags - a `GtkStyleContext` + a `GtkStyleContext` - Returns %TRUE if @context currently has defined the + Returns %TRUE if @context currently has defined the given class name. + - %TRUE if @context has @class_name defined + %TRUE if @context has @class_name defined - a `GtkStyleContext` + a `GtkStyleContext` - a class name + a class name - Looks up and resolves a color name in the @context color map. + Looks up and resolves a color name in the @context color map. + - %TRUE if @color_name was found and resolved, %FALSE otherwise + %TRUE if @color_name was found and resolved, %FALSE otherwise - a `GtkStyleContext` + a `GtkStyleContext` - color name to lookup + color name to lookup - Return location for the looked up color + Return location for the looked up color - Removes @class_name from @context. + Removes @class_name from @context. + - a `GtkStyleContext` + a `GtkStyleContext` - class name to remove + class name to remove - Removes @provider from the style providers list in @context. + Removes @provider from the style providers list in @context. + - a `GtkStyleContext` + a `GtkStyleContext` - a `GtkStyleProvider` + a `GtkStyleProvider` - Restores @context state to a previous stage. + Restores @context state to a previous stage. See [method@Gtk.StyleContext.save]. + - a `GtkStyleContext` + a `GtkStyleContext` - Saves the @context state. + Saves the @context state. This allows temporary modifications done through [method@Gtk.StyleContext.add_class], @@ -79429,18 +83380,19 @@ reverted in one go through [method@Gtk.StyleContext.restore]. The matching call to [method@Gtk.StyleContext.restore] must be done before GTK returns to the main loop. + - a `GtkStyleContext` + a `GtkStyleContext` - Attaches @context to the given display. + Attaches @context to the given display. The display is used to add style information from “global” style providers, such as the display's `GtkSettings` instance. @@ -79448,54 +83400,57 @@ style providers, such as the display's `GtkSettings` instance. If you are using a `GtkStyleContext` returned from [method@Gtk.Widget.get_style_context], you do not need to call this yourself. + - a `GtkStyleContext` + a `GtkStyleContext` - a `GdkDisplay` + a `GdkDisplay` - Sets the scale to use when getting image assets for the style. + Sets the scale to use when getting image assets for the style. + - a `GtkStyleContext` + a `GtkStyleContext` - scale + scale - Sets the state to be used for style matching. + Sets the state to be used for style matching. + - a `GtkStyleContext` + a `GtkStyleContext` - state to represent + state to represent - Converts the style context into a string representation. + Converts the style context into a string representation. The string representation always includes information about the name, state, id, visibility and style classes of the CSS @@ -79505,17 +83460,18 @@ information may be included. This function is intended for testing and debugging of the CSS implementation in GTK. There are no guarantees about the format of the returned string, it may change. + - a newly allocated string representing @context + a newly allocated string representing @context - a `GtkStyleContext` + a `GtkStyleContext` - Flags that determine what to print + Flags that determine what to print @@ -79528,11 +83484,13 @@ the format of the returned string, it may change. + + @@ -79545,6 +83503,7 @@ the format of the returned string, it may change. + @@ -79552,6 +83511,7 @@ the format of the returned string, it may change. + @@ -79559,6 +83519,7 @@ the format of the returned string, it may change. + @@ -79566,6 +83527,7 @@ the format of the returned string, it may change. + @@ -79573,27 +83535,27 @@ the format of the returned string, it may change. - Flags that modify the behavior of gtk_style_context_to_string(). + Flags that modify the behavior of gtk_style_context_to_string(). New values may be added to this enumeration. - Default value. + Default value. - Print the entire tree of + Print the entire tree of CSS nodes starting at the style context's node - Show the values of the + Show the values of the CSS properties for each node - Show information about + Show information about what changes affect the styles - `GtkStyleProvider` is an interface for style information used by + `GtkStyleProvider` is an interface for style information used by `GtkStyleContext`. See [method@Gtk.StyleContext.add_provider] and @@ -79609,7 +83571,7 @@ GTK uses the `GtkStyleProvider` implementation for CSS in - `GtkSwitch` is a "light switch" that has two states: on or off. + `GtkSwitch` is a "light switch" that has two states: on or off. ![An example GtkSwitch](switch.png) @@ -79640,76 +83602,81 @@ using any style classes. - Creates a new `GtkSwitch` widget. + Creates a new `GtkSwitch` widget. + - the newly created `GtkSwitch` instance + the newly created `GtkSwitch` instance - Gets whether the `GtkSwitch` is in its “on” or “off” state. + Gets whether the `GtkSwitch` is in its “on” or “off” state. + - %TRUE if the `GtkSwitch` is active, and %FALSE otherwise + %TRUE if the `GtkSwitch` is active, and %FALSE otherwise - a `GtkSwitch` + a `GtkSwitch` - Gets the underlying state of the `GtkSwitch`. + Gets the underlying state of the `GtkSwitch`. + - the underlying state + the underlying state - a `GtkSwitch` + a `GtkSwitch` - Changes the state of @self to the desired one. + Changes the state of @self to the desired one. + - a `GtkSwitch` + a `GtkSwitch` - %TRUE if @self should be active, and %FALSE otherwise + %TRUE if @self should be active, and %FALSE otherwise - Sets the underlying state of the `GtkSwitch`. + Sets the underlying state of the `GtkSwitch`. Normally, this is the same as [property@Gtk.Switch:active], unless the switch is set up for delayed state changes. This function is typically called from a [signal@Gtk.Switch::state-set] signal handler. See [signal@Gtk.Switch::state-set] for details. + - a `GtkSwitch` + a `GtkSwitch` - the new state + the new state @@ -79717,19 +83684,19 @@ See [signal@Gtk.Switch::state-set] for details. - Whether the `GtkSwitch` widget is in its on or off state. + Whether the `GtkSwitch` widget is in its on or off state. - The backend state that is controlled by the switch. + The backend state that is controlled by the switch. See [signal@GtkSwitch::state-set] for details. - Emitted to animate the switch. + Emitted to animate the switch. Applications should never connect to this signal, but use the [property@Gtk.Switch:active] property. @@ -79738,7 +83705,7 @@ but use the [property@Gtk.Switch:active] property. - Emitted to change the underlying state. + Emitted to change the underlying state. The ::state-set signal is emitted when the user changes the switch position. The default handler keeps the state in sync with the @@ -79754,19 +83721,19 @@ Visually, the underlying state is represented by the trough color of the switch, while the [property@Gtk.Switch`:active] property is represented by the position of the switch. - %TRUE to stop the signal emission + %TRUE to stop the signal emission - the new state of the switch + the new state of the switch - Values that can be passed to the [vfunc@Gtk.Widget.system_setting_changed] + Values that can be passed to the [vfunc@Gtk.Widget.system_setting_changed] vfunc. The values indicate which system setting has changed. @@ -79776,13 +83743,13 @@ Most of the values correspond to `GtkSettings` properties. More values may be added over time. - the [property@Gtk.Settings:gtk-xft-dpi] setting has changed + the [property@Gtk.Settings:gtk-xft-dpi] setting has changed - The [property@Gtk.Settings:gtk-font-name] setting has changed + The [property@Gtk.Settings:gtk-font-name] setting has changed - The font configuration has changed in a way that + The font configuration has changed in a way that requires text to be redrawn. This can be any of the [property@Gtk.Settings:gtk-xft-antialias], [property@Gtk.Settings:gtk-xft-hinting], @@ -79791,290 +83758,336 @@ More values may be added over time. [property@Gtk.Settings:gtk-fontconfig-timestamp] settings - The display has changed + The display has changed - The icon theme has changed in a way that requires + The icon theme has changed in a way that requires icons to be looked up again + + + + + + + + + + + + + + + + + - The priority at which the text view validates onscreen lines + The priority at which the text view validates onscreen lines in an idle job in the background. + + + + + + + + + + + + + + + + + + + - Uses the default sort function in a [iface@Gtk.TreeSortable]. + Uses the default sort function in a [iface@Gtk.TreeSortable]. See also: [method@Gtk.TreeSortable.set_sort_column_id] + + - Disables sorting in a [iface@Gtk.TreeSortable]. + Disables sorting in a [iface@Gtk.TreeSortable]. See also: [method@Gtk.TreeSortable.set_sort_column_id] + + + + + + + + - The `GtkText` widget is a single-line text entry widget. + The `GtkText` widget is a single-line text entry widget. `GtkText` is the common implementation of single-line text editing that is shared between `GtkEntry`, `GtkPasswordEntry`, `GtkSpinButton` @@ -80141,27 +84154,29 @@ to accessibility. - Creates a new `GtkText`. + Creates a new `GtkText`. + - a new `GtkText`. + a new `GtkText`. - Creates a new `GtkText` with the specified text buffer. + Creates a new `GtkText` with the specified text buffer. + - a new `GtkText` + a new `GtkText` - The buffer to use for the new `GtkText`. + The buffer to use for the new `GtkText`. - Determine the positions of the strong and weak cursors if the + Determine the positions of the strong and weak cursors if the insertion point in the layout is at @position. The position of each cursor is stored as a zero-width rectangle. @@ -80171,476 +84186,503 @@ The weak cursor location is the location where characters of the directionality opposite to the base direction are inserted. The rectangle positions are in widget coordinates. + - a `GtkText` + a `GtkText` - the character position + the character position - location to store the strong cursor position + location to store the strong cursor position - location to store the weak cursor position + location to store the weak cursor position - Returns whether pressing Enter will activate + Returns whether pressing Enter will activate the default widget for the window containing @self. See [method@Gtk.Text.set_activates_default]. + - %TRUE if the `GtkText` will activate the default widget + %TRUE if the `GtkText` will activate the default widget - a `GtkText` + a `GtkText` - Gets the attribute list that was set on the `GtkText`. + Gets the attribute list that was set on the `GtkText`. See [method@Gtk.Text.set_attributes]. + - the attribute list + the attribute list - a `GtkText` + a `GtkText` - Get the `GtkEntryBuffer` object which holds the text for + Get the `GtkEntryBuffer` object which holds the text for this widget. + - A `GtkEntryBuffer` object. + A `GtkEntryBuffer` object. - a `GtkText` + a `GtkText` - Returns whether Emoji completion is enabled for this + Returns whether Emoji completion is enabled for this `GtkText` widget. + - %TRUE if Emoji completion is enabled + %TRUE if Emoji completion is enabled - a `GtkText` + a `GtkText` - Gets the menu model for extra items in the context menu. + Gets the menu model for extra items in the context menu. See [method@Gtk.Text.set_extra_menu]. + - the menu model + the menu model - a `GtkText` + a `GtkText` - Gets the input hints of the `GtkText`. + Gets the input hints of the `GtkText`. + - a `GtkText` + a `GtkText` - Gets the input purpose of the `GtkText`. + Gets the input purpose of the `GtkText`. + - a `GtkText` + a `GtkText` - Retrieves the character displayed when visibility is set to false. + Retrieves the character displayed when visibility is set to false. Note that GTK does not compute this value unless it needs it, so the value returned by this function is not very useful unless it has been explicitly set with [method@Gtk.Text.set_invisible_char]. + - the current invisible char, or 0, if @text does not + the current invisible char, or 0, if @text does not show invisible text at all. - a `GtkText` + a `GtkText` - Retrieves the maximum allowed length of the text in @self. + Retrieves the maximum allowed length of the text in @self. See [method@Gtk.Text.set_max_length]. This is equivalent to getting @self's `GtkEntryBuffer` and calling [method@Gtk.EntryBuffer.get_max_length] on it. + - the maximum allowed number of characters + the maximum allowed number of characters in `GtkText`, or 0 if there is no maximum. - a `GtkText` + a `GtkText` - Gets whether text is overwritten when typing in the `GtkText`. + Gets whether text is overwritten when typing in the `GtkText`. See [method@Gtk.Text.set_overwrite_mode]. + - whether the text is overwritten when typing + whether the text is overwritten when typing - a `GtkText` + a `GtkText` - Retrieves the text that will be displayed when + Retrieves the text that will be displayed when @self is empty and unfocused If no placeholder text has been set, %NULL will be returned. + - the placeholder text + the placeholder text - a `GtkText` + a `GtkText` - Returns whether the `GtkText` will grow and shrink + Returns whether the `GtkText` will grow and shrink with the content. + - %TRUE if @self will propagate the text width + %TRUE if @self will propagate the text width - a `GtkText` + a `GtkText` - Gets the tabstops that were set on the `GtkText`. + Gets the tabstops that were set on the `GtkText`. See [method@Gtk.Text.set_tabs]. + - the tabstops + the tabstops - a `GtkText` + a `GtkText` - Retrieves the current length of the text in @self. + Retrieves the current length of the text in @self. This is equivalent to getting @self's `GtkEntryBuffer` and calling [method@Gtk.EntryBuffer.get_length] on it. + - the current number of characters + the current number of characters in `GtkText`, or 0 if there are none. - a `GtkText` + a `GtkText` - Returns whether the `GtkText` will truncate multi-line text + Returns whether the `GtkText` will truncate multi-line text that is pasted into the widget + - %TRUE if @self will truncate multi-line text + %TRUE if @self will truncate multi-line text - a `GtkText` + a `GtkText` - Retrieves whether the text in @self is visible. + Retrieves whether the text in @self is visible. + - %TRUE if the text is currently visible + %TRUE if the text is currently visible - a `GtkText` + a `GtkText` - Causes @self to have keyboard focus. + Causes @self to have keyboard focus. It behaves like [method@Gtk.Widget.grab_focus], except that it doesn't select the contents of @self. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries. + - %TRUE if focus is now inside @self + %TRUE if focus is now inside @self - a `GtkText` + a `GtkText` - If @activates is %TRUE, pressing Enter will activate + If @activates is %TRUE, pressing Enter will activate the default widget for the window containing @self. This usually means that the dialog containing the `GtkText` will be closed, since the default widget is usually one of the dialog buttons. + - a `GtkText` + a `GtkText` - %TRUE to activate window’s default widget on Enter keypress + %TRUE to activate window’s default widget on Enter keypress - Sets attributes that are applied to the text. + Sets attributes that are applied to the text. + - a `GtkText` + a `GtkText` - a `PangoAttrList` + a `PangoAttrList` - Set the `GtkEntryBuffer` object which holds the text for + Set the `GtkEntryBuffer` object which holds the text for this widget. + - a `GtkText` + a `GtkText` - a `GtkEntryBuffer` + a `GtkEntryBuffer` - Sets whether Emoji completion is enabled. + Sets whether Emoji completion is enabled. If it is, typing ':', followed by a recognized keyword, will pop up a window with suggested Emojis matching the keyword. + - a `GtkText` + a `GtkText` - %TRUE to enable Emoji completion + %TRUE to enable Emoji completion - Sets a menu model to add when constructing + Sets a menu model to add when constructing the context menu for @self. + - a `GtkText` + a `GtkText` - a `GMenuModel` + a `GMenuModel` - Sets input hints that allow input methods + Sets input hints that allow input methods to fine-tune their behaviour. + - a `GtkText` + a `GtkText` - the hints + the hints - Sets the input purpose of the `GtkText`. + Sets the input purpose of the `GtkText`. This can be used by on-screen keyboards and other input methods to adjust their behaviour. + - a `GtkText` + a `GtkText` - the purpose + the purpose - Sets the character to use when in “password mode”. + Sets the character to use when in “password mode”. By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type. + - a `GtkText` + a `GtkText` - a Unicode character + a Unicode character - Sets the maximum allowed length of the contents of the widget. + Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit. This is equivalent to getting @self's `GtkEntryBuffer` and calling [method@Gtk.EntryBuffer.set_max_length] on it. + - a `GtkText` + a `GtkText` - the maximum length of the `GtkText`, or 0 for no maximum. + the maximum length of the `GtkText`, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. @@ -80649,38 +84691,40 @@ calling [method@Gtk.EntryBuffer.set_max_length] on it. - Sets whether the text is overwritten when typing + Sets whether the text is overwritten when typing in the `GtkText`. + - a `GtkText` + a `GtkText` - new value + new value - Sets text to be displayed in @self when it is empty. + Sets text to be displayed in @self when it is empty. This can be used to give a visual hint of the expected contents of the `GtkText`. + - a `GtkText` + a `GtkText` - a string to be displayed when @self + a string to be displayed when @self is empty and unfocused @@ -80688,59 +84732,62 @@ contents of the `GtkText`. - Sets whether the `GtkText` should grow and shrink with the content. + Sets whether the `GtkText` should grow and shrink with the content. + - a `GtkText` + a `GtkText` - %TRUE to propagate the text width + %TRUE to propagate the text width - Sets tabstops that are applied to the text. + Sets tabstops that are applied to the text. + - a `GtkText` + a `GtkText` - a `PangoTabArray` + a `PangoTabArray` - Sets whether the `GtkText` should truncate multi-line text + Sets whether the `GtkText` should truncate multi-line text that is pasted into the widget. + - a `GtkText` + a `GtkText` - %TRUE to truncate multi-line text + %TRUE to truncate multi-line text - Sets whether the contents of the `GtkText` are visible or not. + Sets whether the contents of the `GtkText` are visible or not. When visibility is set to %FALSE, characters are displayed as the invisible char, and will also appear that way when @@ -80754,32 +84801,34 @@ Note that you probably want to set [property@Gtk.Text:input-purpose] to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN to inform input methods about the purpose of this self, in addition to setting visibility to %FALSE. + - a `GtkText` + a `GtkText` - %TRUE if the contents of the `GtkText` are displayed + %TRUE if the contents of the `GtkText` are displayed as plaintext - Unsets the invisible char. + Unsets the invisible char. After calling this, the default invisible char is used again. + - a `GtkText` + a `GtkText` @@ -80787,13 +84836,13 @@ char is used again. - Whether to activate the default widget when Enter is pressed. + Whether to activate the default widget when Enter is pressed. - A list of Pango attributes to apply to the text of the `GtkText`. + A list of Pango attributes to apply to the text of the `GtkText`. This is mainly useful to change the size or weight of the text. @@ -80804,24 +84853,24 @@ The `PangoAttribute`'s @start_index and @end_index must refer to the - The `GtkEntryBuffer` object which stores the text. + The `GtkEntryBuffer` object which stores the text. - Whether to suggest Emoji replacements. + Whether to suggest Emoji replacements. - A menu model whose contents will be appended to + A menu model whose contents will be appended to the context menu. - Which IM (input method) module should be used for this self. + Which IM (input method) module should be used for this self. See [class@Gtk.IMMulticontext]. @@ -80833,14 +84882,14 @@ property. - Additional hints that allow input methods to fine-tune + Additional hints that allow input methods to fine-tune their behaviour. - The purpose of this text field. + The purpose of this text field. This property can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -80853,17 +84902,17 @@ Note that setting the purpose to %GTK_INPUT_PURPOSE_PASSWORD or - The character to used when masking contents (in “password mode”). + The character to used when masking contents (in “password mode”). - Whether the invisible char has been set for the `GtkText`. + Whether the invisible char has been set for the `GtkText`. - Maximum number of characters that are allowed. + Maximum number of characters that are allowed. Zero indicates no limit. @@ -80871,49 +84920,49 @@ Zero indicates no limit. - If text is overwritten when typing in the `GtkText`. + If text is overwritten when typing in the `GtkText`. - The text that will be displayed in the `GtkText` when it is empty + The text that will be displayed in the `GtkText` when it is empty and unfocused. - Whether the widget should grow and shrink with the content. + Whether the widget should grow and shrink with the content. - Number of pixels scrolled of the screen to the left. + Number of pixels scrolled of the screen to the left. - A list of tabstops to apply to the text of the `GtkText`. + A list of tabstops to apply to the text of the `GtkText`. - When %TRUE, pasted multi-line text is truncated to the first line. + When %TRUE, pasted multi-line text is truncated to the first line. - If %FALSE, the text is masked with the “invisible char”. + If %FALSE, the text is masked with the “invisible char”. - Emitted when the user hits the Enter key. + Emitted when the user hits the Enter key. The default bindings for this signal are all forms of the <kbd>Enter</kbd> key. @@ -80922,7 +84971,7 @@ of the <kbd>Enter</kbd> key. - Emitted when the user asks for it. + Emitted when the user asks for it. This is a [keybinding signal](class.SignalAction.html). @@ -80933,7 +84982,7 @@ The default bindings for this signal are - Emitted to copy the selection to the clipboard. + Emitted to copy the selection to the clipboard. This is a [keybinding signal](class.SignalAction.html). @@ -80945,7 +84994,7 @@ The default bindings for this signal are - Emitted to cut the selection to the clipboard. + Emitted to cut the selection to the clipboard. This is a [keybinding signal](class.SignalAction.html). @@ -80957,7 +85006,7 @@ The default bindings for this signal are - Emitted when the user initiates a text deletion. + Emitted when the user initiates a text deletion. This is a [keybinding signal](class.SignalAction.html). @@ -80973,17 +85022,17 @@ for deleting a word. - the granularity of the deletion, as a `GtkDeleteType` + the granularity of the deletion, as a `GtkDeleteType` - the number of @type units to delete + the number of @type units to delete - Emitted when the user initiates the insertion of a + Emitted when the user initiates the insertion of a fixed string at the cursor. This is a [keybinding signal](class.SignalAction.html). @@ -80994,13 +85043,13 @@ This signal has no default bindings. - the string to insert + the string to insert - Emitted to present the Emoji chooser for the widget. + Emitted to present the Emoji chooser for the widget. This is a [keybinding signal](class.SignalAction.html). @@ -81012,7 +85061,7 @@ The default bindings for this signal are - Emitted when the user initiates a cursor movement. + Emitted when the user initiates a cursor movement. If the cursor is not visible in @self, this signal causes the viewport to be moved instead. @@ -81037,21 +85086,21 @@ There are too many key combinations to list them all here. - the granularity of the move, as a `GtkMovementStep` + the granularity of the move, as a `GtkMovementStep` - the number of @step units to move + the number of @step units to move - %TRUE if the move should extend the selection + %TRUE if the move should extend the selection - Emitted to paste the contents of the clipboard. + Emitted to paste the contents of the clipboard. This is a [keybinding signal](class.SignalAction.html). @@ -81062,7 +85111,7 @@ The default bindings for this signal are - Emitted when the preedit text changes. + Emitted when the preedit text changes. If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, @@ -81072,13 +85121,13 @@ connect to this signal. - the current preedit string + the current preedit string - Emitted to toggle the overwrite mode of the `GtkText`. + Emitted to toggle the overwrite mode of the `GtkText`. This is a [keybinding signal](class.SignalAction.html). @@ -81089,7 +85138,7 @@ The default bindings for this signal is <kbd>Insert</kbd>. - Stores text and attributes for display in a `GtkTextView`. + Stores text and attributes for display in a `GtkTextView`. You may wish to begin by reading the [text widget conceptual overview](section-text-widget.html), @@ -81098,49 +85147,52 @@ related to the text widget and how they work together. GtkTextBuffer can support undoing changes to the buffer content, see [method@Gtk.TextBuffer.set_enable_undo]. + - Creates a new text buffer. + Creates a new text buffer. + - a new text buffer + a new text buffer - a tag table, or %NULL to create a new one + a tag table, or %NULL to create a new one - Emits the “apply-tag” signal on @buffer. + Emits the “apply-tag” signal on @buffer. The default handler for the signal applies @tag to the given range. @start and @end do not have to be in order. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextTag` + a `GtkTextTag` - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged - Called to indicate that the buffer operations between here and a + Called to indicate that the buffer operations between here and a call to gtk_text_buffer_end_user_action() are part of a single user-visible operation. @@ -81158,17 +85210,19 @@ The “interactive” buffer mutation functions, such as begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a single call to one of those functions. + - a `GtkTextBuffer` + a `GtkTextBuffer` + @@ -81179,6 +85233,7 @@ solely of a single call to one of those functions. + @@ -81195,23 +85250,24 @@ solely of a single call to one of those functions. - Ends a user-visible operation. + Ends a user-visible operation. Should be paired with a call to [method@Gtk.TextBuffer.begin_user_action]. See that function for a full explanation. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Inserts a child widget anchor into the text buffer at @iter. + Inserts a child widget anchor into the text buffer at @iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented @@ -81224,26 +85280,27 @@ not. E.g. see [method@Gtk.TextBuffer.get_slice] and Consider [method@Gtk.TextBuffer.create_child_anchor] as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the anchor + location to insert the anchor - a `GtkTextChildAnchor` + a `GtkTextChildAnchor` - Inserts an image into the text buffer at @iter. + Inserts an image into the text buffer at @iter. The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be @@ -81252,25 +85309,27 @@ Note that the “slice” variants for obtaining portions of the buffe as a string include this character for paintable, but the “text” variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and [method@Gtk.TextBuffer.get_text]. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the paintable + location to insert the paintable - a `GdkPaintable` + a `GdkPaintable` + @@ -81290,6 +85349,7 @@ variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and + @@ -81303,6 +85363,7 @@ variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and + @@ -81319,6 +85380,7 @@ variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and + @@ -81329,6 +85391,7 @@ variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and + @@ -81342,59 +85405,62 @@ variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and - Redoes the next redoable action on the buffer, if there is one. + Redoes the next redoable action on the buffer, if there is one. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Emits the “remove-tag” signal. + Emits the “remove-tag” signal. The default handler for the signal removes all occurrences of @tag from the given range. @start and @end don’t have to be in order. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextTag` + a `GtkTextTag` - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - Undoes the last undoable action on the buffer, if there is one. + Undoes the last undoable action on the buffer, if there is one. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Adds the mark at position @where. + Adds the mark at position @where. The mark must not be added to another buffer, and if its name is not %NULL then there must not be another mark in the buffer @@ -81402,102 +85468,106 @@ with the same name. Emits the [signal@Gtk.TextBuffer::mark-set] signal as notification of the mark's initial placement. + - a `GtkTextBuffer` + a `GtkTextBuffer` - the mark to add + the mark to add - location to place mark + location to place mark - Adds @clipboard to the list of clipboards in which the selection + Adds @clipboard to the list of clipboards in which the selection contents of @buffer are available. In most cases, @clipboard will be the `GdkClipboard` returned by [method@Gtk.Widget.get_primary_clipboard] for a view of @buffer. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GdkClipboard` + a `GdkClipboard` - Emits the “apply-tag” signal on @buffer. + Emits the “apply-tag” signal on @buffer. The default handler for the signal applies @tag to the given range. @start and @end do not have to be in order. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextTag` + a `GtkTextTag` - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged - Emits the “apply-tag” signal on @buffer. + Emits the “apply-tag” signal on @buffer. Calls [method@Gtk.TextTagTable.lookup] on the buffer’s tag table to get a `GtkTextTag`, then calls [method@Gtk.TextBuffer.apply_tag]. + - a `GtkTextBuffer` + a `GtkTextBuffer` - name of a named `GtkTextTag` + name of a named `GtkTextTag` - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged - Performs the appropriate action as if the user hit the delete + Performs the appropriate action as if the user hit the delete key with the cursor at the position specified by @iter. In the normal case a single character will be deleted, but when @@ -81508,31 +85578,32 @@ are involved, less than one character will be deleted. Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the @iter will be re-initialized to point to the location where text was deleted. + - %TRUE if the buffer was modified + %TRUE if the buffer was modified - a `GtkTextBuffer` + a `GtkTextBuffer` - a position in @buffer + a position in @buffer - whether the deletion is caused by user interaction + whether the deletion is caused by user interaction - whether the buffer is editable by default + whether the buffer is editable by default - Denotes the beginning of an action that may not be undone. + Denotes the beginning of an action that may not be undone. This will cause any previous operations in the undo/redo queue to be cleared. @@ -81543,18 +85614,19 @@ action has completed. You may nest calls to gtk_text_buffer_begin_irreversible_action() and gtk_text_buffer_end_irreversible_action() pairs. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Called to indicate that the buffer operations between here and a + Called to indicate that the buffer operations between here and a call to gtk_text_buffer_end_user_action() are part of a single user-visible operation. @@ -81572,34 +85644,36 @@ The “interactive” buffer mutation functions, such as begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a single call to one of those functions. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Copies the currently-selected text to a clipboard. + Copies the currently-selected text to a clipboard. + - a `GtkTextBuffer` + a `GtkTextBuffer` - the `GdkClipboard` object to copy to + the `GdkClipboard` object to copy to - Creates and inserts a child anchor. + Creates and inserts a child anchor. This is a convenience function which simply creates a child anchor with [ctor@Gtk.TextChildAnchor.new] and inserts it into the buffer @@ -81607,23 +85681,24 @@ with [method@Gtk.TextBuffer.insert_child_anchor]. The new anchor is owned by the buffer; no reference count is returned to the caller of this function. + - the created child anchor + the created child anchor - a `GtkTextBuffer` + a `GtkTextBuffer` - location in the buffer + location in the buffer - Creates a mark at position @where. + Creates a mark at position @where. If @mark_name is %NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using [method@Gtk.TextBuffer.get_mark]. @@ -81642,31 +85717,32 @@ away when the buffer does. Emits the [signal@Gtk.TextBuffer::mark-set] signal as notification of the mark's initial placement. + - the new `GtkTextMark` object + the new `GtkTextMark` object - a `GtkTextBuffer` + a `GtkTextBuffer` - name for mark + name for mark - location to place mark + location to place mark - whether the mark has left gravity + whether the mark has left gravity - Creates a tag and adds it to the tag table for @buffer. + Creates a tag and adds it to the tag table for @buffer. Equivalent to calling [ctor@Gtk.TextTag.new] and then adding the tag to the buffer’s tag table. The returned tag is owned by @@ -81679,52 +85755,54 @@ exist in the tag table for this buffer. The @first_property_name argument and subsequent arguments are a list of properties to set on the tag, as with g_object_set(). + - a new tag + a new tag - a `GtkTextBuffer` + a `GtkTextBuffer` - name of the new tag + name of the new tag - name of first property to set + name of first property to set - %NULL-terminated list of property names and values + %NULL-terminated list of property names and values - Copies the currently-selected text to a clipboard, + Copies the currently-selected text to a clipboard, then deletes said text if it’s editable. + - a `GtkTextBuffer` + a `GtkTextBuffer` - the `GdkClipboard` object to cut to + the `GdkClipboard` object to cut to - default editability of the buffer + default editability of the buffer - Deletes text between @start and @end. + Deletes text between @start and @end. The order of @start and @end is not actually relevant; gtk_text_buffer_delete() will reorder them. @@ -81734,56 +85812,58 @@ the default handler of that signal deletes the text. Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the @start and @end will be re-initialized to point to the location where text was deleted. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a position in @buffer + a position in @buffer - another position in @buffer + another position in @buffer - Deletes all editable text in the given range. + Deletes all editable text in the given range. Calls [method@Gtk.TextBuffer.delete] for each editable sub-range of [@start,@end). @start and @end are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted. + - whether some text was actually deleted + whether some text was actually deleted - a `GtkTextBuffer` + a `GtkTextBuffer` - start of range to delete + start of range to delete - end of range + end of range - whether the buffer is editable by default + whether the buffer is editable by default - Deletes @mark, so that it’s no longer located anywhere in the + Deletes @mark, so that it’s no longer located anywhere in the buffer. Removes the reference the buffer holds to the mark, so if @@ -81795,65 +85875,68 @@ to find out if a mark has been removed from its buffer. The [signal@Gtk.TextBuffer::mark-deleted] signal will be emitted as notification after the mark is deleted. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextMark` in @buffer + a `GtkTextMark` in @buffer - Deletes the mark named @name; the mark must exist. + Deletes the mark named @name; the mark must exist. See [method@Gtk.TextBuffer.delete_mark] for details. + - a `GtkTextBuffer` + a `GtkTextBuffer` - name of a mark in @buffer + name of a mark in @buffer - Deletes the range between the “insert” and “selection_bound” marks, + Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text. If @interactive is %TRUE, the editability of the selection will be considered (users can’t delete uneditable text). + - whether there was a non-empty selection to delete + whether there was a non-empty selection to delete - a `GtkTextBuffer` + a `GtkTextBuffer` - whether the deletion is caused by user interaction + whether the deletion is caused by user interaction - whether the buffer is editable by default + whether the buffer is editable by default - Denotes the end of an action that may not be undone. + Denotes the end of an action that may not be undone. This will cause any previous operations in the undo/redo queue to be cleared. @@ -81864,120 +85947,127 @@ was called. You may nest calls to gtk_text_buffer_begin_irreversible_action() and gtk_text_buffer_end_irreversible_action() pairs. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Ends a user-visible operation. + Ends a user-visible operation. Should be paired with a call to [method@Gtk.TextBuffer.begin_user_action]. See that function for a full explanation. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Retrieves the first and last iterators in the buffer, i.e. the + Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range [@start,@end). + - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize with first position in the buffer + iterator to initialize with first position in the buffer - iterator to initialize with the end iterator + iterator to initialize with the end iterator - Gets whether there is a redoable action in the history. + Gets whether there is a redoable action in the history. + - %TRUE if there is an redoable action + %TRUE if there is an redoable action - a `GtkTextBuffer` + a `GtkTextBuffer` - Gets whether there is an undoable action in the history. + Gets whether there is an undoable action in the history. + - %TRUE if there is an undoable action + %TRUE if there is an undoable action - a `GtkTextBuffer` + a `GtkTextBuffer` - Gets the number of characters in the buffer. + Gets the number of characters in the buffer. Note that characters and bytes are not the same, you can’t e.g. expect the contents of the buffer in string form to be this many bytes long. The character count is cached, so this function is very fast. + - number of characters in the buffer + number of characters in the buffer - a `GtkTextBuffer` + a `GtkTextBuffer` - Gets whether the buffer is saving modifications to the buffer + Gets whether the buffer is saving modifications to the buffer to allow for undo and redo actions. See [method@Gtk.TextBuffer.begin_irreversible_action] and [method@Gtk.TextBuffer.end_irreversible_action] to create changes to the buffer that cannot be undone. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Initializes @iter with the “end iterator,” one past the last valid + Initializes @iter with the “end iterator,” one past the last valid character in the text buffer. If dereferenced with [method@Gtk.TextIter.get_char], the end @@ -81985,96 +86075,101 @@ iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call [method@Gtk.TextBuffer.get_start_iter] to get character position 0) to the end iterator. + - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - Indicates whether the buffer has some text currently selected. + Indicates whether the buffer has some text currently selected. + - %TRUE if the there is text selected + %TRUE if the there is text selected - a `GtkTextBuffer` + a `GtkTextBuffer` - Returns the mark that represents the cursor (insertion point). + Returns the mark that represents the cursor (insertion point). Equivalent to calling [method@Gtk.TextBuffer.get_mark] to get the mark named “insert”, but very slightly more efficient, and involves less typing. + - insertion point mark + insertion point mark - a `GtkTextBuffer` + a `GtkTextBuffer` - Obtains the location of @anchor within @buffer. + Obtains the location of @anchor within @buffer. + - a `GtkTextBuffer` + a `GtkTextBuffer` - an iterator to be initialized + an iterator to be initialized - a child anchor that appears in @buffer + a child anchor that appears in @buffer - Initializes @iter to the start of the given line. + Initializes @iter to the start of the given line. If @line_number is greater than or equal to the number of lines in the @buffer, the end iterator is returned. + - whether the exact position has been found + whether the exact position has been found - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - line number counting from 0 + line number counting from 0 - Obtains an iterator pointing to @byte_index within the given line. + Obtains an iterator pointing to @byte_index within the given line. @byte_index must be the start of a UTF-8 character. Note bytes, not characters; UTF-8 may encode one character as multiple bytes. @@ -82082,31 +86177,32 @@ characters; UTF-8 may encode one character as multiple bytes. If @line_number is greater than or equal to the number of lines in the @buffer, the end iterator is returned. And if @byte_index is off the end of the line, the iterator at the end of the line is returned. + - whether the exact position has been found + whether the exact position has been found - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - line number counting from 0 + line number counting from 0 - byte index from start of line + byte index from start of line - Obtains an iterator pointing to @char_offset within the given line. + Obtains an iterator pointing to @char_offset within the given line. Note characters, not bytes; UTF-8 may encode one character as multiple bytes. @@ -82114,142 +86210,149 @@ bytes. If @line_number is greater than or equal to the number of lines in the @buffer, the end iterator is returned. And if @char_offset is off the end of the line, the iterator at the end of the line is returned. + - whether the exact position has been found + whether the exact position has been found - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - line number counting from 0 + line number counting from 0 - char offset from start of line + char offset from start of line - Initializes @iter with the current position of @mark. + Initializes @iter with the current position of @mark. + - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - a `GtkTextMark` in @buffer + a `GtkTextMark` in @buffer - Initializes @iter to a position @char_offset chars from the start + Initializes @iter to a position @char_offset chars from the start of the entire buffer. If @char_offset is -1 or greater than the number of characters in the buffer, @iter is initialized to the end iterator, the iterator one past the last valid character in the buffer. + - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - char offset from start of buffer, counting from 0, or -1 + char offset from start of buffer, counting from 0, or -1 - Obtains the number of lines in the buffer. + Obtains the number of lines in the buffer. This value is cached, so the function is very fast. + - number of lines in the buffer + number of lines in the buffer - a `GtkTextBuffer` + a `GtkTextBuffer` - Returns the mark named @name in buffer @buffer, or %NULL if no such + Returns the mark named @name in buffer @buffer, or %NULL if no such mark exists in the buffer. + - a `GtkTextMark` + a `GtkTextMark` - a `GtkTextBuffer` + a `GtkTextBuffer` - a mark name + a mark name - Gets the maximum number of undo levels to perform. + Gets the maximum number of undo levels to perform. If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Indicates whether the buffer has been modified since the last call + Indicates whether the buffer has been modified since the last call to [method@Gtk.TextBuffer.set_modified] set the modification flag to %FALSE. Used for example to enable a “save” function in a text editor. + - %TRUE if the buffer has been modified + %TRUE if the buffer has been modified - a `GtkTextBuffer` + a `GtkTextBuffer` - Returns the mark that represents the selection bound. + Returns the mark that represents the selection bound. Equivalent to calling [method@Gtk.TextBuffer.get_mark] to get the mark named “selection_bound”, but very slightly @@ -82261,62 +86364,65 @@ The currently-selected text in @buffer is the region between the [method@Gtk.TextBuffer.get_selection_bounds] is another convenient function for handling the selection, if you just want to know whether there’s a selection and what its bounds are. + - selection bound mark + selection bound mark - a `GtkTextBuffer` + a `GtkTextBuffer` - Returns %TRUE if some text is selected; places the bounds + Returns %TRUE if some text is selected; places the bounds of the selection in @start and @end. If the selection has length 0, then @start and @end are filled in with the same value. @start and @end will be in ascending order. If @start and @end are %NULL, then they are not filled in, but the return value still indicates whether text is selected. + - whether the selection has nonzero length + whether the selection has nonzero length - a `GtkTextBuffer` a `GtkTextBuffer` + a `GtkTextBuffer` a `GtkTextBuffer` - iterator to initialize with selection start + iterator to initialize with selection start - iterator to initialize with selection end + iterator to initialize with selection end - Get a content provider for this buffer. + Get a content provider for this buffer. It can be used to make the content of @buffer available in a `GdkClipboard`, see [method@Gdk.Clipboard.set_content]. + - a new `GdkContentProvider`. + a new `GdkContentProvider`. - a `GtkTextBuffer` + a `GtkTextBuffer` - Returns the text in the range [@start,@end). + Returns the text in the range [@start,@end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if @include_hidden_chars is %FALSE. @@ -82326,64 +86432,67 @@ into the returned string do correspond to byte and character indexes into the buffer. Contrast with [method@Gtk.TextBuffer.get_text]. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a paintable or widget is in the buffer. + - an allocated UTF-8 string + an allocated UTF-8 string - a `GtkTextBuffer` + a `GtkTextBuffer` - start of a range + start of a range - end of a range + end of a range - whether to include invisible text + whether to include invisible text - Initialized @iter with the first position in the text buffer. + Initialized @iter with the first position in the text buffer. This is the same as using [method@Gtk.TextBuffer.get_iter_at_offset] to get the iter at character offset 0. + - a `GtkTextBuffer` + a `GtkTextBuffer` - iterator to initialize + iterator to initialize - Get the `GtkTextTagTable` associated with this buffer. + Get the `GtkTextTagTable` associated with this buffer. + - the buffer’s tag table + the buffer’s tag table - a `GtkTextBuffer` + a `GtkTextBuffer` - Returns the text in the range [@start,@end). + Returns the text in the range [@start,@end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if @include_hidden_chars is %FALSE. @@ -82391,31 +86500,32 @@ Does not include characters representing embedded images, so byte and character indexes into the returned string do not correspond to byte and character indexes into the buffer. Contrast with [method@Gtk.TextBuffer.get_slice]. + - an allocated UTF-8 string + an allocated UTF-8 string - a `GtkTextBuffer` + a `GtkTextBuffer` - start of a range + start of a range - end of a range + end of a range - whether to include invisible text + whether to include invisible text - Inserts @len bytes of @text at position @iter. + Inserts @len bytes of @text at position @iter. If @len is -1, @text must be nul-terminated and will be inserted in its entirety. Emits the “insert-text” signal; insertion actually occurs @@ -82423,53 +86533,55 @@ in the default handler for the signal. @iter is invalidated when insertion occurs (because the buffer contents change), but the default signal handler revalidates it to point to the end of the inserted text. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a position in the buffer + a position in the buffer - text in UTF-8 format + text in UTF-8 format - length of text in bytes, or -1 + length of text in bytes, or -1 - Inserts @text in @buffer. + Inserts @text in @buffer. Simply calls [method@Gtk.TextBuffer.insert], using the current cursor position as the insertion point. + - a `GtkTextBuffer` + a `GtkTextBuffer` - text in UTF-8 format + text in UTF-8 format - length of text, in bytes + length of text, in bytes - Inserts a child widget anchor into the text buffer at @iter. + Inserts a child widget anchor into the text buffer at @iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented @@ -82482,26 +86594,27 @@ not. E.g. see [method@Gtk.TextBuffer.get_slice] and Consider [method@Gtk.TextBuffer.create_child_anchor] as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the anchor + location to insert the anchor - a `GtkTextChildAnchor` + a `GtkTextChildAnchor` - Inserts @text in @buffer. + Inserts @text in @buffer. Like [method@Gtk.TextBuffer.insert], but the insertion will not occur if @iter is at a non-editable location in the buffer. Usually you @@ -82511,35 +86624,36 @@ results from a user action (is interactive). @default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of [method@Gtk.TextView.get_editable] is appropriate here. + - whether text was actually inserted + whether text was actually inserted - a `GtkTextBuffer` + a `GtkTextBuffer` - a position in @buffer + a position in @buffer - some UTF-8 text + some UTF-8 text - length of text in bytes, or -1 + length of text in bytes, or -1 - default editability of buffer + default editability of buffer - Inserts @text in @buffer. + Inserts @text in @buffer. Calls [method@Gtk.TextBuffer.insert_interactive] at the cursor position. @@ -82547,60 +86661,62 @@ at the cursor position. @default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of [method@Gtk.TextView.get_editable] is appropriate here. + - whether text was actually inserted + whether text was actually inserted - a `GtkTextBuffer` + a `GtkTextBuffer` - text in UTF-8 format + text in UTF-8 format - length of text in bytes, or -1 + length of text in bytes, or -1 - default editability of buffer + default editability of buffer - Inserts the text in @markup at position @iter. + Inserts the text in @markup at position @iter. @markup will be inserted in its entirety and must be nul-terminated and valid UTF-8. Emits the [signal@Gtk.TextBuffer::insert-text] signal, possibly multiple times; insertion actually occurs in the default handler for the signal. @iter will point to the end of the inserted text on return. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the markup + location to insert the markup - a nul-terminated UTF-8 string containing Pango markup + a nul-terminated UTF-8 string containing Pango markup - length of @markup in bytes, or -1 + length of @markup in bytes, or -1 - Inserts an image into the text buffer at @iter. + Inserts an image into the text buffer at @iter. The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be @@ -82609,26 +86725,27 @@ Note that the “slice” variants for obtaining portions of the buffe as a string include this character for paintable, but the “text” variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and [method@Gtk.TextBuffer.get_text]. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the paintable + location to insert the paintable - a `GdkPaintable` + a `GdkPaintable` - Copies text, tags, and paintables between @start and @end + Copies text, tags, and paintables between @start and @end and inserts the copy at @iter. The order of @start and @end doesn’t matter. @@ -82639,30 +86756,31 @@ images and tags. If @start and @end are in a different buffer from Implemented via emissions of the ::insert-text and ::apply-tag signals, so expect those. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a position in @buffer + a position in @buffer - a position in a `GtkTextBuffer` + a position in a `GtkTextBuffer` - another position in the same buffer as @start + another position in the same buffer as @start - Copies text, tags, and paintables between @start and @end + Copies text, tags, and paintables between @start and @end and inserts the copy at @iter. Same as [method@Gtk.TextBuffer.insert_range], but does nothing @@ -82670,154 +86788,159 @@ if the insertion point isn’t editable. The @default_editable parameter indicates whether the text is editable at @iter if no tags enclosing @iter affect editability. Typically the result of [method@Gtk.TextView.get_editable] is appropriate here. + - whether an insertion was possible at @iter + whether an insertion was possible at @iter - a `GtkTextBuffer` + a `GtkTextBuffer` - a position in @buffer + a position in @buffer - a position in a `GtkTextBuffer` + a position in a `GtkTextBuffer` - another position in the same buffer as @start + another position in the same buffer as @start - default editability of the buffer + default editability of the buffer - Inserts @text into @buffer at @iter, applying the list of tags to + Inserts @text into @buffer at @iter, applying the list of tags to the newly-inserted text. The last tag specified must be %NULL to terminate the list. Equivalent to calling [method@Gtk.TextBuffer.insert], then [method@Gtk.TextBuffer.apply_tag] on the inserted text; this is just a convenience function. + - a `GtkTextBuffer` + a `GtkTextBuffer` - an iterator in @buffer + an iterator in @buffer - UTF-8 text + UTF-8 text - length of @text, or -1 + length of @text, or -1 - first tag to apply to @text + first tag to apply to @text - %NULL-terminated list of tags to apply + %NULL-terminated list of tags to apply - Inserts @text into @buffer at @iter, applying the list of tags to + Inserts @text into @buffer at @iter, applying the list of tags to the newly-inserted text. Same as [method@Gtk.TextBuffer.insert_with_tags], but allows you to pass in tag names instead of tag objects. + - a `GtkTextBuffer` + a `GtkTextBuffer` - position in @buffer + position in @buffer - UTF-8 text + UTF-8 text - length of @text, or -1 + length of @text, or -1 - name of a tag to apply to @text + name of a tag to apply to @text - more tag names + more tag names - Moves @mark to the new location @where. + Moves @mark to the new location @where. Emits the [signal@Gtk.TextBuffer::mark-set] signal as notification of the move. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextMark` + a `GtkTextMark` - new location for @mark in @buffer + new location for @mark in @buffer - Moves the mark named @name (which must exist) to location @where. + Moves the mark named @name (which must exist) to location @where. See [method@Gtk.TextBuffer.move_mark] for details. + - a `GtkTextBuffer` + a `GtkTextBuffer` - name of a mark + name of a mark - new location for mark + new location for mark - Pastes the contents of a clipboard. + Pastes the contents of a clipboard. If @override_location is %NULL, the pasted text will be inserted at the cursor position, or the buffer selection will be replaced @@ -82826,30 +86949,31 @@ if the selection is non-empty. Note: pasting is asynchronous, that is, we’ll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted. + - a `GtkTextBuffer` + a `GtkTextBuffer` - the `GdkClipboard` to paste from + the `GdkClipboard` to paste from - location to insert pasted text + location to insert pasted text - whether the buffer is editable by default + whether the buffer is editable by default - This function moves the “insert” and “selection_bound” marks + This function moves the “insert” and “selection_bound” marks simultaneously. If you move them to the same place in two steps with @@ -82858,133 +86982,139 @@ region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized. + - a `GtkTextBuffer` + a `GtkTextBuffer` - where to put the cursor + where to put the cursor - Redoes the next redoable action on the buffer, if there is one. + Redoes the next redoable action on the buffer, if there is one. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Removes all tags in the range between @start and @end. + Removes all tags in the range between @start and @end. Be careful with this function; it could remove tags added in code unrelated to the code you’re currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags. + - a `GtkTextBuffer` + a `GtkTextBuffer` - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - Removes a `GdkClipboard` added with + Removes a `GdkClipboard` added with gtk_text_buffer_add_selection_clipboard(). + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GdkClipboard` added to @buffer by + a `GdkClipboard` added to @buffer by [method@Gtk.TextBuffer.add_selection_clipboard] - Emits the “remove-tag” signal. + Emits the “remove-tag” signal. The default handler for the signal removes all occurrences of @tag from the given range. @start and @end don’t have to be in order. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextTag` + a `GtkTextTag` - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - Emits the “remove-tag” signal. + Emits the “remove-tag” signal. Calls [method@Gtk.TextTagTable.lookup] on the buffer’s tag table to get a `GtkTextTag`, then calls [method@Gtk.TextBuffer.remove_tag]. + - a `GtkTextBuffer` + a `GtkTextBuffer` - name of a `GtkTextTag` + name of a `GtkTextTag` - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged - This function moves the “insert” and “selection_bound” marks + This function moves the “insert” and “selection_bound” marks simultaneously. If you move them in two steps with @@ -82993,27 +87123,28 @@ region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized. + - a `GtkTextBuffer` + a `GtkTextBuffer` - where to put the “insert” mark + where to put the “insert” mark - where to put the “selection_bound” mark + where to put the “selection_bound” mark - Sets whether or not to enable undoable actions in the text buffer. + Sets whether or not to enable undoable actions in the text buffer. Undoable actions in this context are changes to the text content of the buffer. Changes to tags and marks are not tracked. @@ -83024,42 +87155,44 @@ up to [method@Gtk.TextBuffer.get_max_undo_levels]. See [method@Gtk.TextBuffer.begin_irreversible_action] and [method@Gtk.TextBuffer.end_irreversible_action] to create changes to the buffer that cannot be undone. + - a `GtkTextBuffer` + a `GtkTextBuffer` - %TRUE to enable undo + %TRUE to enable undo - Sets the maximum number of undo levels to perform. + Sets the maximum number of undo levels to perform. If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer. + - a `GtkTextBuffer` + a `GtkTextBuffer` - the maximum number of undo actions to perform + the maximum number of undo actions to perform - Used to keep track of whether the buffer has been + Used to keep track of whether the buffer has been modified since the last time it was saved. Whenever the buffer is saved to disk, call @@ -83068,68 +87201,71 @@ When the buffer is modified, it will automatically toggled on the modified bit again. When the modified bit flips, the buffer emits the [signal@Gtk.TextBuffer::modified-changed] signal. + - a `GtkTextBuffer` + a `GtkTextBuffer` - modification flag setting + modification flag setting - Deletes current contents of @buffer, and inserts @text instead. + Deletes current contents of @buffer, and inserts @text instead. If @len is -1, @text must be nul-terminated. @text must be valid UTF-8. + - a `GtkTextBuffer` + a `GtkTextBuffer` - UTF-8 text to insert + UTF-8 text to insert - length of @text in bytes + length of @text in bytes - Undoes the last undoable action on the buffer, if there is one. + Undoes the last undoable action on the buffer, if there is one. + - a `GtkTextBuffer` + a `GtkTextBuffer` - Denotes that the buffer can reapply the last undone action. + Denotes that the buffer can reapply the last undone action. - Denotes that the buffer can undo the last applied action. + Denotes that the buffer can undo the last applied action. - The position of the insert mark. + The position of the insert mark. This is an offset from the beginning of the buffer. It is useful for getting notified when the cursor moves. @@ -83138,21 +87274,21 @@ It is useful for getting notified when the cursor moves. - Denotes if support for undoing and redoing changes to the buffer is allowed. + Denotes if support for undoing and redoing changes to the buffer is allowed. - Whether the buffer has some text currently selected. + Whether the buffer has some text currently selected. - The GtkTextTagTable for the buffer. + The GtkTextTagTable for the buffer. - The text content of the buffer. + The text content of the buffer. Without child widgets and images, see [method@Gtk.TextBuffer.get_text] for more information. @@ -83165,7 +87301,7 @@ see [method@Gtk.TextBuffer.get_text] for more information. - Emitted to apply a tag to a range of text in a `GtkTextBuffer`. + Emitted to apply a tag to a range of text in a `GtkTextBuffer`. Applying actually occurs in the default handler. @@ -83182,21 +87318,21 @@ See also: - the applied tag + the applied tag - the start of the range the tag is applied to + the start of the range the tag is applied to - the end of the range the tag is applied to + the end of the range the tag is applied to - Emitted at the beginning of a single user-visible + Emitted at the beginning of a single user-visible operation on a `GtkTextBuffer`. See also: @@ -83211,13 +87347,13 @@ See also: - Emitted when the content of a `GtkTextBuffer` has changed. + Emitted when the content of a `GtkTextBuffer` has changed. - Emitted to delete a range from a `GtkTextBuffer`. + Emitted to delete a range from a `GtkTextBuffer`. Note that if your handler runs before the default handler it must not invalidate the @start and @end iters (or has @@ -83233,17 +87369,17 @@ See also: [method@Gtk.TextBuffer.delete]. - the start of the range to be deleted + the start of the range to be deleted - the end of the range to be deleted + the end of the range to be deleted - Emitted at the end of a single user-visible + Emitted at the end of a single user-visible operation on the `GtkTextBuffer`. See also: @@ -83259,7 +87395,7 @@ See also: - Emitted to insert a `GtkTextChildAnchor` in a `GtkTextBuffer`. + Emitted to insert a `GtkTextChildAnchor` in a `GtkTextBuffer`. Insertion actually occurs in the default handler. @@ -83274,17 +87410,17 @@ See also: [method@Gtk.TextBuffer.insert_child_anchor]. - position to insert @anchor in @textbuffer + position to insert @anchor in @textbuffer - the `GtkTextChildAnchor` to be inserted + the `GtkTextChildAnchor` to be inserted - Emitted to insert a `GdkPaintable` in a `GtkTextBuffer`. + Emitted to insert a `GdkPaintable` in a `GtkTextBuffer`. Insertion actually occurs in the default handler. @@ -83299,17 +87435,17 @@ See also: [method@Gtk.TextBuffer.insert_paintable]. - position to insert @paintable in @textbuffer + position to insert @paintable in @textbuffer - the `GdkPaintable` to be inserted + the `GdkPaintable` to be inserted - Emitted to insert text in a `GtkTextBuffer`. + Emitted to insert text in a `GtkTextBuffer`. Insertion actually occurs in the default handler. @@ -83325,21 +87461,21 @@ See also: [method@Gtk.TextBuffer.insert], - position to insert @text in @textbuffer + position to insert @text in @textbuffer - the UTF-8 text to be inserted + the UTF-8 text to be inserted - length of the inserted text in bytes + length of the inserted text in bytes - Emitted as notification after a `GtkTextMark` is deleted. + Emitted as notification after a `GtkTextMark` is deleted. See also: [method@Gtk.TextBuffer.delete_mark]. @@ -83347,13 +87483,13 @@ See also: [method@Gtk.TextBuffer.delete_mark]. - The mark that was deleted + The mark that was deleted - Emitted as notification after a `GtkTextMark` is set. + Emitted as notification after a `GtkTextMark` is set. See also: [method@Gtk.TextBuffer.create_mark], @@ -83363,17 +87499,17 @@ See also: - The location of @mark in @textbuffer + The location of @mark in @textbuffer - The mark that is set + The mark that is set - Emitted when the modified bit of a `GtkTextBuffer` flips. + Emitted when the modified bit of a `GtkTextBuffer` flips. See also: [method@Gtk.TextBuffer.set_modified]. @@ -83381,7 +87517,7 @@ See also: [method@Gtk.TextBuffer.set_modified]. - Emitted after paste operation has been completed. + Emitted after paste operation has been completed. This is useful to properly scroll the view to the end of the pasted text. See [method@Gtk.TextBuffer.paste_clipboard] @@ -83391,20 +87527,20 @@ for more details. - the `GdkClipboard` pasted from + the `GdkClipboard` pasted from - Emitted when a request has been made to redo the + Emitted when a request has been made to redo the previously undone operation. - Emitted to remove all occurrences of @tag from a range + Emitted to remove all occurrences of @tag from a range of text in a `GtkTextBuffer`. Removal actually occurs in the default handler. @@ -83419,21 +87555,21 @@ See also: [method@Gtk.TextBuffer.remove_tag]. - the tag to be removed + the tag to be removed - the start of the range the tag is removed from + the start of the range the tag is removed from - the end of the range the tag is removed from + the end of the range the tag is removed from - Emitted when a request has been made to undo the + Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together. @@ -83442,13 +87578,15 @@ been grouped together. - The class structure for `GtkTextBuffer`. + The class structure for `GtkTextBuffer`. + - The object class structure needs to be the first. + The object class structure needs to be the first. + @@ -83470,20 +87608,21 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the paintable + location to insert the paintable - a `GdkPaintable` + a `GdkPaintable` @@ -83491,20 +87630,21 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` - location to insert the anchor + location to insert the anchor - a `GtkTextChildAnchor` + a `GtkTextChildAnchor` @@ -83512,6 +87652,7 @@ been grouped together. + @@ -83530,6 +87671,7 @@ been grouped together. + @@ -83542,6 +87684,7 @@ been grouped together. + @@ -83554,6 +87697,7 @@ been grouped together. + @@ -83572,6 +87716,7 @@ been grouped together. + @@ -83587,24 +87732,25 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextTag` + a `GtkTextTag` - one bound of range to be tagged + one bound of range to be tagged - other bound of range to be tagged + other bound of range to be tagged @@ -83612,24 +87758,25 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextTag` + a `GtkTextTag` - one bound of range to be untagged + one bound of range to be untagged - other bound of range to be untagged + other bound of range to be untagged @@ -83637,12 +87784,13 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` @@ -83650,12 +87798,13 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` @@ -83663,6 +87812,7 @@ been grouped together. + @@ -83678,12 +87828,13 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` @@ -83691,12 +87842,13 @@ been grouped together. + - a `GtkTextBuffer` + a `GtkTextBuffer` @@ -83704,6 +87856,7 @@ been grouped together. + @@ -83711,6 +87864,7 @@ been grouped together. + @@ -83718,6 +87872,7 @@ been grouped together. + @@ -83725,51 +87880,57 @@ been grouped together. + - + + + - The predicate function used by gtk_text_iter_forward_find_char() and + The predicate function used by gtk_text_iter_forward_find_char() and gtk_text_iter_backward_find_char(). + - %TRUE if the predicate is satisfied, and the iteration should + %TRUE if the predicate is satisfied, and the iteration should stop, and %FALSE otherwise - a Unicode code point + a Unicode code point - data passed to the callback + data passed to the callback - A `GtkTextChildAnchor` is a spot in a `GtkTextBuffer` where child widgets can + A `GtkTextChildAnchor` is a spot in a `GtkTextBuffer` where child widgets can be “anchored”. The anchor can have multiple widgets anchored, to allow for multiple views. + - Creates a new `GtkTextChildAnchor`. + Creates a new `GtkTextChildAnchor`. Usually you would then insert it into a `GtkTextBuffer` with [method@Gtk.TextBuffer.insert_child_anchor]. To perform the creation and insertion in one step, use the convenience function [method@Gtk.TextBuffer.create_child_anchor]. + - a new `GtkTextChildAnchor` + a new `GtkTextChildAnchor` - Determines whether a child anchor has been deleted from + Determines whether a child anchor has been deleted from the buffer. Keep in mind that the child anchor will be unreferenced @@ -83777,23 +87938,25 @@ when removed from the buffer, so you need to hold your own reference (with g_object_ref()) if you plan to use this function — otherwise all deleted child anchors will also be finalized. + - %TRUE if the child anchor has been deleted from its buffer + %TRUE if the child anchor has been deleted from its buffer - a `GtkTextChildAnchor` + a `GtkTextChildAnchor` - Gets a list of all widgets anchored at this child anchor. + Gets a list of all widgets anchored at this child anchor. The order in which the widgets are returned is not defined. + - an + an array of widgets anchored at @anchor @@ -83801,11 +87964,11 @@ The order in which the widgets are returned is not defined. - a `GtkTextChildAnchor` + a `GtkTextChildAnchor` - return location for the length of the array + return location for the length of the array @@ -83818,11 +87981,13 @@ The order in which the widgets are returned is not defined. + + @@ -83830,6 +87995,7 @@ The order in which the widgets are returned is not defined. + @@ -83837,6 +88003,7 @@ The order in which the widgets are returned is not defined. + @@ -83844,6 +88011,7 @@ The order in which the widgets are returned is not defined. + @@ -83851,36 +88019,37 @@ The order in which the widgets are returned is not defined. - Reading directions for text. + Reading directions for text. - No direction. + No direction. - Left to right text direction. + Left to right text direction. - Right to left text direction. + Right to left text direction. - Granularity types that extend the text selection. Use the + Granularity types that extend the text selection. Use the `GtkTextView::extend-selection` signal to customize the selection. - Selects the current word. It is triggered by + Selects the current word. It is triggered by a double-click for example. - Selects the current line. It is triggered by + Selects the current line. It is triggered by a triple-click for example. - An iterator for the contents of a `GtkTextBuffer`. + An iterator for the contents of a `GtkTextBuffer`. You may wish to begin by reading the [text widget conceptual overview](section-text-widget.html), which gives an overview of all the objects and data types related to the text widget and how they work together. + @@ -83924,45 +88093,47 @@ related to the text widget and how they work together. - Assigns the value of @other to @iter. + Assigns the value of @other to @iter. This function is not useful in applications, because iterators can be assigned with `GtkTextIter i = j;`. The function is used by language bindings. + - a `GtkTextIter` + a `GtkTextIter` - another `GtkTextIter` + another `GtkTextIter` - Moves backward by one character offset. + Moves backward by one character offset. Returns %TRUE if movement was possible; if @iter was the first in the buffer (character offset 0), this function returns %FALSE for convenience when writing loops. + - whether movement was possible + whether movement was possible - an iterator + an iterator - Moves @count characters backward, if possible. + Moves @count characters backward, if possible. If @count would move past the start or end of the buffer, moves to the start or end of the buffer. @@ -83971,81 +88142,85 @@ The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - an iterator + an iterator - number of characters to move + number of characters to move - Like gtk_text_iter_forward_cursor_position(), but moves backward. + Like gtk_text_iter_forward_cursor_position(), but moves backward. + - %TRUE if we moved + %TRUE if we moved - a `GtkTextIter` + a `GtkTextIter` - Moves up to @count cursor positions. + Moves up to @count cursor positions. See [method@Gtk.TextIter.forward_cursor_position] for details. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of positions to move + number of positions to move - Same as gtk_text_iter_forward_find_char(), + Same as gtk_text_iter_forward_find_char(), but goes backward from @iter. + - whether a match was found + whether a match was found - a `GtkTextIter` + a `GtkTextIter` - function to be called on each character + function to be called on each character - user data for @pred + user data for @pred - search limit + search limit - Moves @iter to the start of the previous line. + Moves @iter to the start of the previous line. Returns %TRUE if @iter could be moved; i.e. if @iter was at character offset 0, this function returns %FALSE. Therefore, @@ -84054,19 +88229,20 @@ if @iter was already on line 0, but not at the start of the line, %TRUE. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) + - whether @iter moved + whether @iter moved - an iterator + an iterator - Moves @count lines backward, if possible. + Moves @count lines backward, if possible. If @count would move past the start or end of the buffer, moves to the start or end of the buffer. @@ -84076,97 +88252,101 @@ onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves forward by 0 - @count lines. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of lines to move backward + number of lines to move backward - Same as gtk_text_iter_forward_search(), but moves backward. + Same as gtk_text_iter_forward_search(), but moves backward. @match_end will never be set to a `GtkTextIter` located after @iter, even if there is a possible @match_start before or at @iter. + - whether a match was found + whether a match was found - a `GtkTextIter` where the search begins + a `GtkTextIter` where the search begins - search string + search string - bitmask of flags affecting the search + bitmask of flags affecting the search - return location for start of match + return location for start of match - return location for end of match + return location for end of match - location of last possible @match_start, or %NULL for start of buffer + location of last possible @match_start, or %NULL for start of buffer - Moves backward to the previous sentence start. + Moves backward to the previous sentence start. If @iter is already at the start of a sentence, moves backward to the next one. Sentence boundaries are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Calls gtk_text_iter_backward_sentence_start() up to @count times. + Calls gtk_text_iter_backward_sentence_start() up to @count times. If @count is negative, moves forward instead of backward. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - number of sentences to move + number of sentences to move - Moves backward to the next toggle (on or off) of the + Moves backward to the next toggle (on or off) of the @tag, or to the next toggle of any tag if @tag is %NULL. @@ -84175,57 +88355,60 @@ returns %FALSE, otherwise %TRUE. Does not return toggles located at @iter, only toggles before @iter. Sets @iter to the location of the toggle, or the start of the buffer if no toggle is found. + - whether we found a tag toggle before @iter + whether we found a tag toggle before @iter - a `GtkTextIter` + a `GtkTextIter` - a `GtkTextTag` + a `GtkTextTag` - Moves @iter forward to the previous visible cursor position. + Moves @iter forward to the previous visible cursor position. See [method@Gtk.TextIter.backward_cursor_position] for details. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - Moves up to @count visible cursor positions. + Moves up to @count visible cursor positions. See [method@Gtk.TextIter.backward_cursor_position] for details. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of positions to move + number of positions to move - Moves @iter to the start of the previous visible line. + Moves @iter to the start of the previous visible line. Returns %TRUE if @iter could be moved; i.e. if @iter was at character offset 0, this @@ -84234,19 +88417,20 @@ but not at the start of the line, @iter is snapped to the start of the line and the function returns %TRUE. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) + - whether @iter moved + whether @iter moved - an iterator + an iterator - Moves @count visible lines backward, if possible. + Moves @count visible lines backward, if possible. If @count would move past the start or end of the buffer, moves to the start or end of the buffer. @@ -84256,95 +88440,100 @@ onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves forward by 0 - @count lines. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of lines to move backward + number of lines to move backward - Moves backward to the previous visible word start. + Moves backward to the previous visible word start. If @iter is currently on a word start, moves backward to the next one after that. Word breaks are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Calls gtk_text_iter_backward_visible_word_start() up to @count times. + Calls gtk_text_iter_backward_visible_word_start() up to @count times. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - number of times to move + number of times to move - Moves backward to the previous word start. + Moves backward to the previous word start. If @iter is currently on a word start, moves backward to the next one after that. Word breaks are determined by Pango and should be correct for nearly any language + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Calls gtk_text_iter_backward_word_start() up to @count times. + Calls gtk_text_iter_backward_word_start() up to @count times. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - number of times to move + number of times to move - Considering the default editability of the buffer, and tags that + Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at @iter would be editable. @@ -84352,63 +88541,66 @@ If text inserted at @iter would be editable then the user should be allowed to insert text at @iter. [method@Gtk.TextBuffer.insert_interactive] uses this function to decide whether insertions are allowed at a given position. + - whether text inserted at @iter would be editable + whether text inserted at @iter would be editable - an iterator + an iterator - %TRUE if text is editable by default + %TRUE if text is editable by default - A qsort()-style function that returns negative if @lhs is less than + A qsort()-style function that returns negative if @lhs is less than @rhs, positive if @lhs is greater than @rhs, and 0 if they’re equal. Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer. + - -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal + -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal - a `GtkTextIter` + a `GtkTextIter` - another `GtkTextIter` + another `GtkTextIter` - Creates a dynamically-allocated copy of an iterator. + Creates a dynamically-allocated copy of an iterator. This function is not useful in applications, because iterators can be copied with a simple assignment (`GtkTextIter i = j;`). The function is used by language bindings. + - a copy of the @iter, free with [method@Gtk.TextIter.free] + a copy of the @iter, free with [method@Gtk.TextIter.free] - an iterator + an iterator - Returns whether the character at @iter is within an editable region + Returns whether the character at @iter is within an editable region of text. Non-editable text is “locked” and can’t be changed by the @@ -84421,23 +88613,24 @@ whether the char at @iter is inside an editable range, you want to know whether a new character inserted at @iter would be inside an editable range. Use [method@Gtk.TextIter.can_insert] to handle this case. + - whether @iter is inside an editable range + whether @iter is inside an editable range - an iterator + an iterator - %TRUE if text is editable by default + %TRUE if text is editable by default - Returns %TRUE if @iter points to the start of the paragraph + Returns %TRUE if @iter points to the start of the paragraph delimiter characters for a line. Delimiters will be either a newline, a carriage return, a carriage @@ -84448,35 +88641,37 @@ Note that an iterator pointing to the \n of a \r\n pair will not be counted as the end of a line, the line ends before the \r. The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there. + - whether @iter is at the end of a line + whether @iter is at the end of a line - an iterator + an iterator - Determines whether @iter ends a sentence. + Determines whether @iter ends a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter is at the end of a sentence. + %TRUE if @iter is at the end of a sentence. - a `GtkTextIter` + a `GtkTextIter` - Returns %TRUE if @tag is toggled off at exactly this point. + Returns %TRUE if @tag is toggled off at exactly this point. If @tag is %NULL, returns %TRUE if any tag is toggled off at this point. @@ -84486,81 +88681,85 @@ at @iter is outside the tagged range. In other words, unlike [method@Gtk.TextIter.starts_tag], if this function returns %TRUE, [method@Gtk.TextIter.has_tag] will return %FALSE for the same parameters. + - whether @iter is the end of a range tagged with @tag + whether @iter is the end of a range tagged with @tag - an iterator + an iterator - a `GtkTextTag` + a `GtkTextTag` - Determines whether @iter ends a natural-language word. + Determines whether @iter ends a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter is at the end of a word + %TRUE if @iter is at the end of a word - a `GtkTextIter` + a `GtkTextIter` - Tests whether two iterators are equal, using the fastest possible + Tests whether two iterators are equal, using the fastest possible mechanism. This function is very fast; you can expect it to perform better than e.g. getting the character offset for each iterator and comparing the offsets yourself. Also, it’s a bit faster than [method@Gtk.TextIter.compare]. + - %TRUE if the iterators point to the same place in the buffer + %TRUE if the iterators point to the same place in the buffer - a `GtkTextIter` + a `GtkTextIter` - another `GtkTextIter` + another `GtkTextIter` - Moves @iter forward by one character offset. + Moves @iter forward by one character offset. Note that images embedded in the buffer occupy 1 character slot, so this function may actually move onto an image instead of a character, if you have images in your buffer. If @iter is the end iterator or one character before it, @iter will now point at the end iterator, and this function returns %FALSE for convenience when writing loops. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - an iterator + an iterator - Moves @count characters if possible. + Moves @count characters if possible. If @count would move past the start or end of the buffer, moves to the start or end of the buffer. @@ -84569,23 +88768,24 @@ The return value indicates whether the new position of @iter is different from its original position, and dereferenceable (the last iterator in the buffer is not dereferenceable). If @count is 0, the function does nothing and returns %FALSE. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - an iterator + an iterator - number of characters to move, may be negative + number of characters to move, may be negative - Moves @iter forward by a single cursor position. + Moves @iter forward by a single cursor position. Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be @@ -84600,85 +88800,89 @@ rendered; so the cursor can’t go between those two characters. See also the [struct@Pango.LogAttr] struct and the [func@Pango.break] function. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - Moves up to @count cursor positions. + Moves up to @count cursor positions. See [method@Gtk.TextIter.forward_cursor_position] for details. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of positions to move + number of positions to move - Advances @iter, calling @pred on each character. + Advances @iter, calling @pred on each character. If @pred returns %TRUE, returns %TRUE and stops scanning. If @pred never returns %TRUE, @iter is set to @limit if @limit is non-%NULL, otherwise to the end iterator. + - whether a match was found + whether a match was found - a `GtkTextIter` + a `GtkTextIter` - a function to be called on each character + a function to be called on each character - user data for @pred + user data for @pred - search limit + search limit - Moves @iter to the start of the next line. + Moves @iter to the start of the next line. If the iter is already on the last line of the buffer, moves the iter to the end of the current line. If after the operation, the iter is at the end of the buffer and not dereferenceable, returns %FALSE. Otherwise, returns %TRUE. + - whether @iter can be dereferenced + whether @iter can be dereferenced - an iterator + an iterator - Moves @count lines forward, if possible. + Moves @count lines forward, if possible. If @count would move past the start or end of the buffer, moves to the start or end of the buffer. @@ -84688,23 +88892,24 @@ onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves backward by 0 - @count lines. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of lines to move forward + number of lines to move forward - Searches forward for @str. + Searches forward for @str. Any match is returned by setting @match_start to the first character of the match and @match_end to the first character after the match. @@ -84714,93 +88919,97 @@ locking up your UI on large buffers. @match_start will never be set to a `GtkTextIter` located before @iter, even if there is a possible @match_end after or at @iter. + - whether a match was found + whether a match was found - start of search + start of search - a search string + a search string - flags affecting how the search is done + flags affecting how the search is done - return location for start of match + return location for start of match - return location for end of match + return location for end of match - location of last possible @match_end, or %NULL for the end of the buffer + location of last possible @match_end, or %NULL for the end of the buffer - Moves forward to the next sentence end. + Moves forward to the next sentence end. If @iter is at the end of a sentence, moves to the next end of sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Calls gtk_text_iter_forward_sentence_end() @count times. + Calls gtk_text_iter_forward_sentence_end() @count times. If @count is negative, moves backward instead of forward. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - number of sentences to move + number of sentences to move - Moves @iter forward to the “end iterator”, which points + Moves @iter forward to the “end iterator”, which points one past the last valid character in the buffer. gtk_text_iter_get_char() called on the end iterator returns 0, which is convenient for writing loops. + - a `GtkTextIter` + a `GtkTextIter` - Moves the iterator to point to the paragraph delimiter characters. + Moves the iterator to point to the paragraph delimiter characters. The possible characters are either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph @@ -84811,19 +89020,20 @@ characters, moves to the paragraph delimiter characters for the next line. If @iter is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns %FALSE. + - %TRUE if we moved and the new location is not the end iterator + %TRUE if we moved and the new location is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Moves forward to the next toggle (on or off) of the + Moves forward to the next toggle (on or off) of the @tag, or to the next toggle of any tag if @tag is %NULL. @@ -84832,75 +89042,79 @@ returns %FALSE, otherwise %TRUE. Does not return toggles located at @iter, only toggles after @iter. Sets @iter to the location of the toggle, or to the end of the buffer if no toggle is found. + - whether we found a tag toggle after @iter + whether we found a tag toggle after @iter - a `GtkTextIter` + a `GtkTextIter` - a `GtkTextTag` + a `GtkTextTag` - Moves @iter forward to the next visible cursor position. + Moves @iter forward to the next visible cursor position. See [method@Gtk.TextIter.forward_cursor_position] for details. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - Moves up to @count visible cursor positions. + Moves up to @count visible cursor positions. See [method@Gtk.TextIter.forward_cursor_position] for details. + - %TRUE if we moved and the new position is dereferenceable + %TRUE if we moved and the new position is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of positions to move + number of positions to move - Moves @iter to the start of the next visible line. + Moves @iter to the start of the next visible line. Returns %TRUE if there was a next line to move to, and %FALSE if @iter was simply moved to the end of the buffer and is now not dereferenceable, or if @iter was already at the end of the buffer. + - whether @iter can be dereferenced + whether @iter can be dereferenced - an iterator + an iterator - Moves @count visible lines forward, if possible. + Moves @count visible lines forward, if possible. If @count would move past the start or end of the buffer, moves to the start or end of the buffer. @@ -84910,138 +89124,146 @@ onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then %FALSE is returned. If @count is 0, the function does nothing and returns %FALSE. If @count is negative, moves backward by 0 - @count lines. + - whether @iter moved and is dereferenceable + whether @iter moved and is dereferenceable - a `GtkTextIter` + a `GtkTextIter` - number of lines to move forward + number of lines to move forward - Moves forward to the next visible word end. + Moves forward to the next visible word end. If @iter is currently on a word end, moves forward to the next one after that. Word breaks are determined by Pango and should be correct for nearly any language + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Calls gtk_text_iter_forward_visible_word_end() up to @count times. + Calls gtk_text_iter_forward_visible_word_end() up to @count times. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - number of times to move + number of times to move - Moves forward to the next word end. + Moves forward to the next word end. If @iter is currently on a word end, moves forward to the next one after that. Word breaks are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - Calls gtk_text_iter_forward_word_end() up to @count times. + Calls gtk_text_iter_forward_word_end() up to @count times. + - %TRUE if @iter moved and is not the end iterator + %TRUE if @iter moved and is not the end iterator - a `GtkTextIter` + a `GtkTextIter` - number of times to move + number of times to move - Free an iterator allocated on the heap. + Free an iterator allocated on the heap. This function is intended for use in language bindings, and is not especially useful for applications, because iterators can simply be allocated on the stack. + - a dynamically-allocated iterator + a dynamically-allocated iterator - Returns the `GtkTextBuffer` this iterator is associated with. + Returns the `GtkTextBuffer` this iterator is associated with. + - the buffer + the buffer - an iterator + an iterator - Returns the number of bytes in the line containing @iter, + Returns the number of bytes in the line containing @iter, including the paragraph delimiters. + - number of bytes in the line + number of bytes in the line - an iterator + an iterator - The Unicode character at this iterator is returned. + The Unicode character at this iterator is returned. Equivalent to operator* on a C++ iterator. If the element at this iterator is a non-character element, such as an image @@ -85050,123 +89272,131 @@ is returned. If invoked on the end iterator, zero is returned; zero is not a valid Unicode character. So you can write a loop which ends when this function returns 0. + - a Unicode character, or 0 if @iter is not dereferenceable + a Unicode character, or 0 if @iter is not dereferenceable - an iterator + an iterator - Returns the number of characters in the line containing @iter, + Returns the number of characters in the line containing @iter, including the paragraph delimiters. + - number of characters in the line + number of characters in the line - an iterator + an iterator - If the location at @iter contains a child anchor, the + If the location at @iter contains a child anchor, the anchor is returned. Otherwise, %NULL is returned. + - the anchor at @iter + the anchor at @iter - an iterator + an iterator - Returns the language in effect at @iter. + Returns the language in effect at @iter. If no tags affecting language apply to @iter, the return value is identical to that of [func@Gtk.get_default_language]. + - language in effect at @iter + language in effect at @iter - an iterator + an iterator - Returns the line number containing the iterator. + Returns the line number containing the iterator. Lines in a `GtkTextBuffer` are numbered beginning with 0 for the first line in the buffer. + - a line number + a line number - an iterator + an iterator - Returns the byte index of the iterator, counting + Returns the byte index of the iterator, counting from the start of a newline-terminated line. Remember that `GtkTextBuffer` encodes text in UTF-8, and that characters can require a variable number of bytes to represent. + - distance from start of line, in bytes + distance from start of line, in bytes - an iterator + an iterator - Returns the character offset of the iterator, + Returns the character offset of the iterator, counting from the start of a newline-terminated line. The first character on the line has offset 0. + - offset from start of line + offset from start of line - an iterator + an iterator - Returns a list of all `GtkTextMark` at this location. + Returns a list of all `GtkTextMark` at this location. Because marks are not iterable (they don’t take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order. + - + list of `GtkTextMark` @@ -85174,46 +89404,48 @@ The returned list is not in any meaningful order. - an iterator + an iterator - Returns the character offset of an iterator. + Returns the character offset of an iterator. Each character in a `GtkTextBuffer` has an offset, starting with 0 for the first character in the buffer. Use [method@Gtk,TextBuffer.get_iter_at_offset] to convert an offset back into an iterator. + - a character offset + a character offset - an iterator + an iterator - If the element at @iter is a paintable, the paintable is returned. + If the element at @iter is a paintable, the paintable is returned. Otherwise, %NULL is returned. + - the paintable at @iter + the paintable at @iter - an iterator + an iterator - Returns the text in the given range. + Returns the text in the given range. A “slice” is an array of characters encoded in UTF-8 format, including the Unicode “unknown” character 0xFFFC for iterable @@ -85223,31 +89455,33 @@ character offsets in the returned array will correspond to byte offsets in the text buffer. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a paintable or widget is in the buffer. + - slice of text from the buffer + slice of text from the buffer - iterator at start of a range + iterator at start of a range - iterator at end of a range + iterator at end of a range - Returns a list of tags that apply to @iter, in ascending order of + Returns a list of tags that apply to @iter, in ascending order of priority. The highest-priority tags are last. The `GtkTextTag`s in the list don’t have a reference added, but you have to free the list itself. + - list of + list of `GtkTextTag` @@ -85255,36 +89489,37 @@ but you have to free the list itself. - a `GtkTextIter` + a `GtkTextIter` - Returns text in the given range. + Returns text in the given range. If the range contains non-text elements such as images, the character and byte offsets in the returned string will not correspond to character and byte offsets in the buffer. If you want offsets to correspond, see [method@Gtk.TextIter.get_slice]. + - array of characters from the buffer + array of characters from the buffer - iterator at start of a range + iterator at start of a range - iterator at end of a range + iterator at end of a range - Returns a list of `GtkTextTag` that are toggled on or off at this + Returns a list of `GtkTextTag` that are toggled on or off at this point. If @toggled_on is %TRUE, the list contains tags that are @@ -85292,8 +89527,9 @@ toggled on. If a tag is toggled on at @iter, then some non-empty range of characters following @iter has that tag applied to it. If a tag is toggled off, then some non-empty range following @iter does not have the tag applied to it. + - tags + tags toggled at this point @@ -85301,156 +89537,163 @@ does not have the tag applied to it. - an iterator + an iterator - %TRUE to get toggled-on tags + %TRUE to get toggled-on tags - Returns the number of bytes from the start of the + Returns the number of bytes from the start of the line to the given @iter, not counting bytes that are invisible due to tags with the “invisible” flag toggled on. + - byte index of @iter with respect to the start of the line + byte index of @iter with respect to the start of the line - a `GtkTextIter` + a `GtkTextIter` - Returns the offset in characters from the start of the + Returns the offset in characters from the start of the line to the given @iter, not counting characters that are invisible due to tags with the “invisible” flag toggled on. + - offset in visible characters from the start of the line + offset in visible characters from the start of the line - a `GtkTextIter` + a `GtkTextIter` - Returns visible text in the given range. + Returns visible text in the given range. Like [method@Gtk.TextIter.get_slice], but invisible text is not included. Invisible text is usually invisible because a `GtkTextTag` with the “invisible” attribute turned on has been applied to it. + - slice of text from the buffer + slice of text from the buffer - iterator at start of range + iterator at start of range - iterator at end of range + iterator at end of range - Returns visible text in the given range. + Returns visible text in the given range. Like [method@Gtk.TextIter.get_text], but invisible text is not included. Invisible text is usually invisible because a `GtkTextTag` with the “invisible” attribute turned on has been applied to it. + - string containing visible text in the + string containing visible text in the range - iterator at start of range + iterator at start of range - iterator at end of range + iterator at end of range - Returns %TRUE if @iter points to a character that is part + Returns %TRUE if @iter points to a character that is part of a range tagged with @tag. See also [method@Gtk.TextIter.starts_tag] and [method@Gtk.TextIter.ends_tag]. + - whether @iter is tagged with @tag + whether @iter is tagged with @tag - an iterator + an iterator - a `GtkTextTag` + a `GtkTextTag` - Checks whether @iter falls in the range [@start, @end). + Checks whether @iter falls in the range [@start, @end). @start and @end must be in ascending order. + - %TRUE if @iter is in the range + %TRUE if @iter is in the range - a `GtkTextIter` + a `GtkTextIter` - start of range + start of range - end of range + end of range - Determines whether @iter is inside a sentence (as opposed to in + Determines whether @iter is inside a sentence (as opposed to in between two sentences, e.g. after a period and before the first letter of the next sentence). Sentence boundaries are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter is inside a sentence. + %TRUE if @iter is inside a sentence. - a `GtkTextIter` + a `GtkTextIter` - Determines whether the character pointed by @iter is part of a + Determines whether the character pointed by @iter is part of a natural-language word (as opposed to say inside some whitespace). Word breaks are determined by Pango and should be correct @@ -85459,66 +89702,70 @@ for nearly any language. Note that if [method@Gtk.TextIter.starts_word] returns %TRUE, then this function returns %TRUE too, since @iter points to the first character of the word. + - %TRUE if @iter is inside a word + %TRUE if @iter is inside a word - a `GtkTextIter` + a `GtkTextIter` - Determine if @iter is at a cursor position. + Determine if @iter is at a cursor position. See [method@Gtk.TextIter.forward_cursor_position] or [struct@Pango.LogAttr] or [func@Pango.break] for details on what a cursor position is. + - %TRUE if the cursor can be placed at @iter + %TRUE if the cursor can be placed at @iter - a `GtkTextIter` + a `GtkTextIter` - Returns %TRUE if @iter is the end iterator. + Returns %TRUE if @iter is the end iterator. This means it is one past the last dereferenceable iterator in the buffer. gtk_text_iter_is_end() is the most efficient way to check whether an iterator is the end iterator. + - whether @iter is the end iterator + whether @iter is the end iterator - an iterator + an iterator - Returns %TRUE if @iter is the first iterator in the buffer. + Returns %TRUE if @iter is the first iterator in the buffer. + - whether @iter is the first in the buffer + whether @iter is the first in the buffer - an iterator + an iterator - Swaps the value of @first and @second if @second comes before + Swaps the value of @first and @second if @second comes before @first in the buffer. That is, ensures that @first and @second are in sequence. @@ -85527,171 +89774,180 @@ automatically on your behalf, so there’s no real reason to call it yourself in those cases. There are some exceptions, such as [method@Gtk.TextIter.in_range], that expect a pre-sorted range. + - a `GtkTextIter` + a `GtkTextIter` - another `GtkTextIter` + another `GtkTextIter` - Moves iterator @iter to the start of the line @line_number. + Moves iterator @iter to the start of the line @line_number. If @line_number is negative or larger than or equal to the number of lines in the buffer, moves @iter to the start of the last line in the buffer. + - a `GtkTextIter` + a `GtkTextIter` - line number (counted from 0) + line number (counted from 0) - Same as gtk_text_iter_set_line_offset(), but works with a + Same as gtk_text_iter_set_line_offset(), but works with a byte index. The given byte index must be at the start of a character, it can’t be in the middle of a UTF-8 encoded character. + - a `GtkTextIter` + a `GtkTextIter` - a byte index relative to the start of @iter’s current line + a byte index relative to the start of @iter’s current line - Moves @iter within a line, to a new character (not byte) offset. + Moves @iter within a line, to a new character (not byte) offset. The given character offset must be less than or equal to the number of characters in the line; if equal, @iter moves to the start of the next line. See [method@Gtk.TextIter.set_line_index] if you have a byte index rather than a character offset. + - a `GtkTextIter` + a `GtkTextIter` - a character offset relative to the start of @iter’s current line + a character offset relative to the start of @iter’s current line - Sets @iter to point to @char_offset. + Sets @iter to point to @char_offset. @char_offset counts from the start of the entire text buffer, starting with 0. + - a `GtkTextIter` + a `GtkTextIter` - a character number + a character number - Like gtk_text_iter_set_line_index(), but the index is in visible + Like gtk_text_iter_set_line_index(), but the index is in visible bytes, i.e. text with a tag making it invisible is not counted in the index. + - a `GtkTextIter` + a `GtkTextIter` - a byte index + a byte index - Like gtk_text_iter_set_line_offset(), but the offset is in visible + Like gtk_text_iter_set_line_offset(), but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset. + - a `GtkTextIter` + a `GtkTextIter` - a character offset + a character offset - Returns %TRUE if @iter begins a paragraph. + Returns %TRUE if @iter begins a paragraph. This is the case if [method@Gtk.TextIter.get_line_offset] would return 0. However this function is potentially more efficient than [method@Gtk.TextIter.get_line_offset], because it doesn’t have to compute the offset, it just has to see whether it’s 0. + - whether @iter begins a line + whether @iter begins a line - an iterator + an iterator - Determines whether @iter begins a sentence. + Determines whether @iter begins a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter is at the start of a sentence. + %TRUE if @iter is at the start of a sentence. - a `GtkTextIter` + a `GtkTextIter` - Returns %TRUE if @tag is toggled on at exactly this point. + Returns %TRUE if @tag is toggled on at exactly this point. If @tag is %NULL, returns %TRUE if any tag is toggled on at this point. @@ -85701,61 +89957,64 @@ character at @iter is inside the tagged range. In other words, unlike [method@Gtk.TextIter.ends_tag], if this function returns %TRUE, [method@Gtk.TextIter.has_tag will also return %TRUE for the same parameters. + - whether @iter is the start of a range tagged with @tag + whether @iter is the start of a range tagged with @tag - an iterator + an iterator - a `GtkTextTag` + a `GtkTextTag` - Determines whether @iter begins a natural-language word. + Determines whether @iter begins a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language. + - %TRUE if @iter is at the start of a word + %TRUE if @iter is at the start of a word - a `GtkTextIter` + a `GtkTextIter` - Gets whether a range with @tag applied to it begins + Gets whether a range with @tag applied to it begins or ends at @iter. This is equivalent to (gtk_text_iter_starts_tag() || gtk_text_iter_ends_tag()) + - whether @tag is toggled on or off at @iter + whether @tag is toggled on or off at @iter - an iterator + an iterator - a `GtkTextTag` + a `GtkTextTag` - A `GtkTextMark` is a position in a `GtkTextbuffer` that is preserved + A `GtkTextMark` is a position in a `GtkTextbuffer` that is preserved across modifications. You may wish to begin by reading the @@ -85788,8 +90047,9 @@ the `GtkTextMark` object around. Marks are typically created using the [method@Gtk.TextBuffer.create_mark] function. + - Creates a text mark. + Creates a text mark. Add it to a buffer using [method@Gtk.TextBuffer.add_mark]. If @name is %NULL, the mark is anonymous; otherwise, the mark can be @@ -85800,96 +90060,103 @@ mark has right gravity (@left_gravity = %FALSE), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right side of the text you’re typing). + - new `GtkTextMark` + new `GtkTextMark` - mark name + mark name - whether the mark should have left gravity + whether the mark should have left gravity - Gets the buffer this mark is located inside. + Gets the buffer this mark is located inside. Returns %NULL if the mark is deleted. + - the mark’s `GtkTextBuffer` + the mark’s `GtkTextBuffer` - a `GtkTextMark` + a `GtkTextMark` - Returns %TRUE if the mark has been removed from its buffer. + Returns %TRUE if the mark has been removed from its buffer. See [method@Gtk.TextBuffer.add_mark] for a way to add it to a buffer again. + - whether the mark is deleted + whether the mark is deleted - a `GtkTextMark` + a `GtkTextMark` - Determines whether the mark has left gravity. + Determines whether the mark has left gravity. + - %TRUE if the mark has left gravity, %FALSE otherwise + %TRUE if the mark has left gravity, %FALSE otherwise - a `GtkTextMark` + a `GtkTextMark` - Returns the mark name. + Returns the mark name. Returns %NULL for anonymous marks. + - mark name + mark name - a `GtkTextMark` + a `GtkTextMark` - Returns %TRUE if the mark is visible. + Returns %TRUE if the mark is visible. A cursor is displayed for visible marks. + - %TRUE if visible + %TRUE if visible - a `GtkTextMark` + a `GtkTextMark` + @@ -85903,7 +90170,7 @@ A cursor is displayed for visible marks. - Whether the mark has left gravity. + Whether the mark has left gravity. When text is inserted at the mark’s current location, if the mark has left gravity it will be moved to the left of the newly-inserted @@ -85911,7 +90178,7 @@ text, otherwise to the right. - The name of the mark or %NULL if the mark is anonymous. + The name of the mark or %NULL if the mark is anonymous. @@ -85922,6 +90189,7 @@ text, otherwise to the right. + @@ -85932,26 +90200,26 @@ text, otherwise to the right. - Flags affecting how a search is done. + Flags affecting how a search is done. If neither %GTK_TEXT_SEARCH_VISIBLE_ONLY nor %GTK_TEXT_SEARCH_TEXT_ONLY are enabled, the match must be exact; the special 0xFFFC character will match embedded paintables or child widgets. - Search only visible data. A search match may + Search only visible data. A search match may have invisible text interspersed. - Search only text. A match may have paintables or + Search only text. A match may have paintables or child widgets mixed inside the matched range. - The text will be matched regardless of + The text will be matched regardless of what case it is in. - A tag that can be applied to text contained in a `GtkTextBuffer`. + A tag that can be applied to text contained in a `GtkTextBuffer`. You may wish to begin by reading the [text widget conceptual overview](section-text-widget.html), @@ -85969,54 +90237,58 @@ For each property of `GtkTextTag`, there is a “set” property, e.g. whether a property has been set or not. They are maintained by GTK and you should not set them independently. + - Creates a `GtkTextTag`. + Creates a `GtkTextTag`. + - a new `GtkTextTag` + a new `GtkTextTag` - tag name + tag name - Emits the [signal@Gtk.TextTagTable::tag-changed] signal on the + Emits the [signal@Gtk.TextTagTable::tag-changed] signal on the `GtkTextTagTable` where the tag is included. The signal is already emitted when setting a `GtkTextTag` property. This function is useful for a `GtkTextTag` subclass. + - a `GtkTextTag` + a `GtkTextTag` - whether the change affects the `GtkTextView` layout + whether the change affects the `GtkTextView` layout - Get the tag priority. + Get the tag priority. + - The tag’s priority. + The tag’s priority. - a `GtkTextTag` + a `GtkTextTag` - Sets the priority of a `GtkTextTag`. + Sets the priority of a `GtkTextTag`. Valid priorities start at 0 and go to one less than [method@Gtk.TextTagTable.get_size]. Each tag in a table @@ -86030,22 +90302,23 @@ the highest priority in the table by default; so normally the precedence of a set of tags is the order in which they were added to the table, or created with [method@Gtk.TextBuffer.create_tag], which adds the tag to the buffer’s table automatically. + - a `GtkTextTag` + a `GtkTextTag` - the new priority + the new priority - Whether the margins accumulate or override each other. + Whether the margins accumulate or override each other. When set to %TRUE the margins of this tag are added to the margins of any other non-accumulative margins present. When set to %FALSE @@ -86053,18 +90326,18 @@ the margins override one another (the default). - Whether breaks are allowed. + Whether breaks are allowed. - Background color as a string. + Background color as a string. - Whether the background color fills the entire line height + Whether the background color fills the entire line height or only the height of the tagged characters. @@ -86072,25 +90345,25 @@ or only the height of the tagged characters. - Background color as a `GdkRGBA`. + Background color as a `GdkRGBA`. - Text direction, e.g. right-to-left or left-to-right. + Text direction, e.g. right-to-left or left-to-right. - Whether the text can be modified by the user. + Whether the text can be modified by the user. - Whether font fallback is enabled. + Whether font fallback is enabled. When set to %TRUE, other fonts will be substituted where the current font is missing glyphs. @@ -86100,57 +90373,57 @@ where the current font is missing glyphs. - Name of the font family, e.g. Sans, Helvetica, Times, Monospace. + Name of the font family, e.g. Sans, Helvetica, Times, Monospace. - Font description as string, e.g. \"Sans Italic 12\". + Font description as string, e.g. \"Sans Italic 12\". Note that the initial value of this property depends on the internals of `PangoFontDescription`. - Font description as a `PangoFontDescription`. + Font description as a `PangoFontDescription`. - OpenType font features, as a string. + OpenType font features, as a string. - Foreground color as a string. + Foreground color as a string. - Foreground color as a `GdkRGBA`. + Foreground color as a `GdkRGBA`. - Amount to indent the paragraph, in pixels. + Amount to indent the paragraph, in pixels. - Whether to insert hyphens at breaks. + Whether to insert hyphens at breaks. - Whether this text is hidden. + Whether this text is hidden. Note that there may still be problems with the support for invisible text, in particular when navigating programmatically inside a buffer @@ -86161,14 +90434,14 @@ containing invisible segments. - Left, right, or center justification. + Left, right, or center justification. - The language this text is in, as an ISO code. + The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If not set, an appropriate default will be used. @@ -86181,31 +90454,31 @@ on the current locale, see also [func@Gtk.get_default_language]. - Width of the left margin in pixels. + Width of the left margin in pixels. - Extra spacing between graphemes, in Pango units. + Extra spacing between graphemes, in Pango units. - The name used to refer to the tag. + The name used to refer to the tag. %NULL for anonymous tags. - Style of overline for this text. + Style of overline for this text. - This property modifies the color of overlines. + This property modifies the color of overlines. If not set, overlines will use the foreground color. @@ -86217,46 +90490,46 @@ If not set, overlines will use the foreground color. - The paragraph background color as a string. + The paragraph background color as a string. - The paragraph background color as a `GdkRGBA`. + The paragraph background color as a `GdkRGBA`. - Pixels of blank space above paragraphs. + Pixels of blank space above paragraphs. - Pixels of blank space below paragraphs. + Pixels of blank space below paragraphs. - Pixels of blank space between wrapped lines in a paragraph. + Pixels of blank space between wrapped lines in a paragraph. - Width of the right margin, in pixels. + Width of the right margin, in pixels. - Offset of text above the baseline, in Pango units. + Offset of text above the baseline, in Pango units. Negative values go below the baseline. @@ -86265,7 +90538,7 @@ Negative values go below the baseline. - Font size as a scale factor relative to the default font size. + Font size as a scale factor relative to the default font size. This properly adapts to theme changes, etc. so is recommended. Pango predefines some scales such as %PANGO_SCALE_X_LARGE. @@ -86275,67 +90548,67 @@ Pango predefines some scales such as %PANGO_SCALE_X_LARGE. - How to render invisible characters. + How to render invisible characters. - Font size in Pango units. + Font size in Pango units. - Font size in points. + Font size in points. - Font stretch as a `PangoStretch`, e.g. %PANGO_STRETCH_CONDENSED. + Font stretch as a `PangoStretch`, e.g. %PANGO_STRETCH_CONDENSED. - Whether to strike through the text. + Whether to strike through the text. - This property modifies the color of strikeouts. + This property modifies the color of strikeouts. If not set, strikeouts will use the foreground color. - If the `strikethrough-rgba` property has been set. + If the `strikethrough-rgba` property has been set. - Font style as a `PangoStyle`, e.g. %PANGO_STYLE_ITALIC. + Font style as a `PangoStyle`, e.g. %PANGO_STYLE_ITALIC. - Custom tabs for this text. + Custom tabs for this text. - Style of underline for this text. + Style of underline for this text. - This property modifies the color of underlines. + This property modifies the color of underlines. If not set, underlines will use the foreground color. @@ -86345,28 +90618,28 @@ this property will always override those defaults. - If the `underline-rgba` property has been set. + If the `underline-rgba` property has been set. - Font variant as a `PangoVariant`, e.g. %PANGO_VARIANT_SMALL_CAPS. + Font variant as a `PangoVariant`, e.g. %PANGO_VARIANT_SMALL_CAPS. - Font weight as an integer. + Font weight as an integer. - Whether to wrap lines never, at word boundaries, or + Whether to wrap lines never, at word boundaries, or at character boundaries. @@ -86381,6 +90654,7 @@ at character boundaries. + @@ -86390,9 +90664,11 @@ at character boundaries. - + + + - The collection of tags in a `GtkTextBuffer` + The collection of tags in a `GtkTextBuffer` You may wish to begin by reading the [text widget conceptual overview](section-text-widget.html), @@ -86415,140 +90691,146 @@ An example of a UI definition fragment specifying tags: ``` - Creates a new `GtkTextTagTable`. + Creates a new `GtkTextTagTable`. The table contains no tags by default. + - a new `GtkTextTagTable` + a new `GtkTextTagTable` - Add a tag to the table. + Add a tag to the table. The tag is assigned the highest priority in the table. @tag must not be in a tag table already, and may not have the same name as an already-added tag. + - %TRUE on success. + %TRUE on success. - a `GtkTextTagTable` + a `GtkTextTagTable` - a `GtkTextTag` + a `GtkTextTag` - Calls @func on each tag in @table, with user data @data. + Calls @func on each tag in @table, with user data @data. Note that the table may not be modified while iterating over it (you can’t add/remove tags). + - a `GtkTextTagTable` + a `GtkTextTagTable` - a function to call on each tag + a function to call on each tag - user data + user data - Returns the size of the table (number of tags) + Returns the size of the table (number of tags) + - number of tags in @table + number of tags in @table - a `GtkTextTagTable` + a `GtkTextTagTable` - Look up a named tag. + Look up a named tag. + - The tag + The tag - a `GtkTextTagTable` + a `GtkTextTagTable` - name of a tag + name of a tag - Remove a tag from the table. + Remove a tag from the table. If a `GtkTextBuffer` has @table as its tag table, the tag is removed from the buffer. The table’s reference to the tag is removed, so the tag will end up destroyed if you don’t have a reference to it. + - a `GtkTextTagTable` + a `GtkTextTagTable` - a `GtkTextTag` + a `GtkTextTag` - Emitted every time a new tag is added in the `GtkTextTagTable`. + Emitted every time a new tag is added in the `GtkTextTagTable`. - the added tag. + the added tag. - Emitted every time a tag in the `GtkTextTagTable` changes. + Emitted every time a tag in the `GtkTextTagTable` changes. - the changed tag. + the changed tag. - whether the change affects the `GtkTextView` layout. + whether the change affects the `GtkTextView` layout. - Emitted every time a tag is removed from the `GtkTextTagTable`. + Emitted every time a tag is removed from the `GtkTextTagTable`. The @tag is still valid by the time the signal is emitted, but it is not associated with a tag table any more. @@ -86557,31 +90839,32 @@ it is not associated with a tag table any more. - the removed tag. + the removed tag. - A function used with gtk_text_tag_table_foreach(), + A function used with gtk_text_tag_table_foreach(), to iterate over every `GtkTextTag` inside a `GtkTextTagTable`. + - the `GtkTextTag` + the `GtkTextTag` - data passed to gtk_text_tag_table_foreach() + data passed to gtk_text_tag_table_foreach() - A widget that displays the contents of a [class@Gtk.TextBuffer]. + A widget that displays the contents of a [class@Gtk.TextBuffer]. ![An example GtkTextview](multiline-text.png) @@ -86615,41 +90898,45 @@ of the main node. ## Accessibility `GtkTextView` uses the %GTK_ACCESSIBLE_ROLE_TEXT_BOX role. + - Creates a new `GtkTextView`. + Creates a new `GtkTextView`. If you don’t call [method@Gtk.TextView.set_buffer] before using the text view, an empty default buffer will be created for you. Get the buffer with [method@Gtk.TextView.get_buffer]. If you want to specify your own buffer, consider [ctor@Gtk.TextView.new_with_buffer]. + - a new `GtkTextView` + a new `GtkTextView` - Creates a new `GtkTextView` widget displaying the buffer @buffer. + Creates a new `GtkTextView` widget displaying the buffer @buffer. One buffer can be shared among many widgets. @buffer may be %NULL to create a default buffer, in which case this function is equivalent to [ctor@Gtk.TextView.new]. The text view adds its own reference count to the buffer; it does not take over an existing reference. + - a new `GtkTextView`. + a new `GtkTextView`. - a `GtkTextBuffer` + a `GtkTextBuffer` + @@ -86660,6 +90947,7 @@ to the buffer; it does not take over an existing reference. + @@ -86670,6 +90958,7 @@ to the buffer; it does not take over an existing reference. + @@ -86680,6 +90969,7 @@ to the buffer; it does not take over an existing reference. + @@ -86690,6 +90980,7 @@ to the buffer; it does not take over an existing reference. + @@ -86706,6 +90997,7 @@ to the buffer; it does not take over an existing reference. + @@ -86728,6 +91020,7 @@ to the buffer; it does not take over an existing reference. + @@ -86741,6 +91034,7 @@ to the buffer; it does not take over an existing reference. + @@ -86751,6 +91045,7 @@ to the buffer; it does not take over an existing reference. + @@ -86770,6 +91065,7 @@ to the buffer; it does not take over an existing reference. + @@ -86780,6 +91076,7 @@ to the buffer; it does not take over an existing reference. + @@ -86790,6 +91087,7 @@ to the buffer; it does not take over an existing reference. + @@ -86806,6 +91104,7 @@ to the buffer; it does not take over an existing reference. + @@ -86816,27 +91115,28 @@ to the buffer; it does not take over an existing reference. - Adds a child widget in the text buffer, at the given @anchor. + Adds a child widget in the text buffer, at the given @anchor. + - a `GtkTextView` + a `GtkTextView` - a `GtkWidget` + a `GtkWidget` - a `GtkTextChildAnchor` in the `GtkTextBuffer` for @text_view + a `GtkTextChildAnchor` in the `GtkTextBuffer` for @text_view - Adds @child at a fixed coordinate in the `GtkTextView`'s text window. + Adds @child at a fixed coordinate in the `GtkTextView`'s text window. The @xpos and @ypos must be in buffer coordinates (see [method@Gtk.TextView.get_iter_location] to convert to @@ -86846,30 +91146,31 @@ buffer coordinates). If instead you want a widget that will not move with the `GtkTextView` contents see `GtkOverlay`. + - a `GtkTextView` + a `GtkTextView` - a `GtkWidget` + a `GtkWidget` - X position of child in window coordinates + X position of child in window coordinates - Y position of child in window coordinates + Y position of child in window coordinates - Moves the given @iter backward by one display (wrapped) line. + Moves the given @iter backward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. @@ -86878,23 +91179,24 @@ wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the `GtkTextBuffer`. + - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - Moves the given @iter backward to the next display line start. + Moves the given @iter backward to the next display line start. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. @@ -86903,55 +91205,57 @@ wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the `GtkTextBuffer`. + - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - Converts buffer coordinates to window coordinates. + Converts buffer coordinates to window coordinates. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextWindowType` + a `GtkTextWindowType` - buffer x coordinate + buffer x coordinate - buffer y coordinate + buffer y coordinate - window x coordinate return location + window x coordinate return location - window y coordinate return location + window y coordinate return location - Moves the given @iter forward by one display (wrapped) line. + Moves the given @iter forward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. @@ -86960,23 +91264,24 @@ wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the `GtkTextBuffer`. + - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - Moves the given @iter forward to the next display line end. + Moves the given @iter forward to the next display line end. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. @@ -86985,71 +91290,75 @@ wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the `GtkTextBuffer`. + - %TRUE if @iter was moved and is not on the end iterator + %TRUE if @iter was moved and is not on the end iterator - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - Returns whether pressing the <kbd>Tab</kbd> key inserts a tab characters. + Returns whether pressing the <kbd>Tab</kbd> key inserts a tab characters. See [method@Gtk.TextView.set_accepts_tab]. + - %TRUE if pressing the Tab key inserts a tab character, + %TRUE if pressing the Tab key inserts a tab character, %FALSE if pressing the Tab key moves the keyboard focus. - A `GtkTextView` + A `GtkTextView` - Gets the bottom margin for text in the @text_view. + Gets the bottom margin for text in the @text_view. + - bottom margin in pixels + bottom margin in pixels - a `GtkTextView` + a `GtkTextView` - Returns the `GtkTextBuffer` being displayed by this text view. + Returns the `GtkTextBuffer` being displayed by this text view. The reference count on the buffer is not incremented; the caller of this function won’t own a new reference. + - a `GtkTextBuffer` + a `GtkTextBuffer` - a `GtkTextView` + a `GtkTextView` - Determine the positions of the strong and weak cursors if the + Determine the positions of the strong and weak cursors if the insertion point is at @iter. The position of each cursor is stored as a zero-width rectangle. @@ -87069,170 +91378,179 @@ cursor’s offset within the preedit sequence. The rectangle position is in buffer coordinates; use [method@Gtk.TextView.buffer_to_window_coords] to convert these coordinates to coordinates for one of the windows in the text view. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - location to store the strong cursor position + location to store the strong cursor position - location to store the weak cursor position + location to store the weak cursor position - Find out whether the cursor should be displayed. + Find out whether the cursor should be displayed. + - whether the insertion mark is visible + whether the insertion mark is visible - a `GtkTextView` + a `GtkTextView` - Returns the default editability of the `GtkTextView`. + Returns the default editability of the `GtkTextView`. Tags in the buffer may override this setting for some ranges of text. + - whether text is editable by default + whether text is editable by default - a `GtkTextView` + a `GtkTextView` - Gets the menu model that gets added to the context menu + Gets the menu model that gets added to the context menu or %NULL if none has been set. + - the menu model + the menu model - a `GtkTextView` + a `GtkTextView` - Gets a `GtkWidget` that has previously been set as gutter. + Gets a `GtkWidget` that has previously been set as gutter. See [method@Gtk.TextView.set_gutter]. @win must be one of %GTK_TEXT_WINDOW_LEFT, %GTK_TEXT_WINDOW_RIGHT, %GTK_TEXT_WINDOW_TOP, or %GTK_TEXT_WINDOW_BOTTOM. + - a `GtkWidget` + a `GtkWidget` - a `GtkTextView` + a `GtkTextView` - a `GtkTextWindowType` + a `GtkTextWindowType` - Gets the default indentation of paragraphs in @text_view. + Gets the default indentation of paragraphs in @text_view. Tags in the view’s buffer may override the default. The indentation may be negative. + - number of pixels of indentation + number of pixels of indentation - a `GtkTextView` + a `GtkTextView` - Gets the `input-hints` of the `GtkTextView`. + Gets the `input-hints` of the `GtkTextView`. + - a `GtkTextView` + a `GtkTextView` - Gets the `input-purpose` of the `GtkTextView`. + Gets the `input-purpose` of the `GtkTextView`. + - a `GtkTextView` + a `GtkTextView` - Retrieves the iterator at buffer coordinates @x and @y. + Retrieves the iterator at buffer coordinates @x and @y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with [method@Gtk.TextView.window_to_buffer_coords]. + - %TRUE if the position is over text + %TRUE if the position is over text - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - x position, in buffer coordinates + x position, in buffer coordinates - y position, in buffer coordinates + y position, in buffer coordinates - Retrieves the iterator pointing to the character at buffer + Retrieves the iterator pointing to the character at buffer coordinates @x and @y. Buffer coordinates are coordinates for the entire buffer, not just @@ -87242,345 +91560,363 @@ you have to convert those to buffer coordinates with Note that this is different from [method@Gtk.TextView.get_iter_at_location], which returns cursor locations, i.e. positions between characters. + - %TRUE if the position is over text + %TRUE if the position is over text - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - if non-%NULL, location to store + if non-%NULL, location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme. - x position, in buffer coordinates + x position, in buffer coordinates - y position, in buffer coordinates + y position, in buffer coordinates - Gets a rectangle which roughly contains the character at @iter. + Gets a rectangle which roughly contains the character at @iter. The rectangle position is in buffer coordinates; use [method@Gtk.TextView.buffer_to_window_coords] to convert these coordinates to coordinates for one of the windows in the text view. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - bounds of the character at @iter + bounds of the character at @iter - Gets the default justification of paragraphs in @text_view. + Gets the default justification of paragraphs in @text_view. Tags in the buffer may override the default. + - default justification + default justification - a `GtkTextView` + a `GtkTextView` - Gets the default left margin size of paragraphs in the @text_view. + Gets the default left margin size of paragraphs in the @text_view. Tags in the buffer may override the default. + - left margin in pixels + left margin in pixels - a `GtkTextView` + a `GtkTextView` - Gets the `GtkTextIter` at the start of the line containing + Gets the `GtkTextIter` at the start of the line containing the coordinate @y. @y is in buffer coordinates, convert from window coordinates with [method@Gtk.TextView.window_to_buffer_coords]. If non-%NULL, @line_top will be filled with the coordinate of the top edge of the line. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - a y coordinate + a y coordinate - return location for top coordinate of the line + return location for top coordinate of the line - Gets the y coordinate of the top of the line containing @iter, + Gets the y coordinate of the top of the line containing @iter, and the height of the line. The coordinate is a buffer coordinate; convert to window coordinates with [method@Gtk.TextView.buffer_to_window_coords]. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - return location for a y coordinate + return location for a y coordinate - return location for a height + return location for a height - Gets the `PangoContext` that is used for rendering LTR directed + Gets the `PangoContext` that is used for rendering LTR directed text layouts. The context may be replaced when CSS changes occur. + - a `PangoContext` + a `PangoContext` - a `GtkTextView` + a `GtkTextView` - Gets whether the `GtkTextView` uses monospace styling. + Gets whether the `GtkTextView` uses monospace styling. + - %TRUE if monospace fonts are desired + %TRUE if monospace fonts are desired - a `GtkTextView` + a `GtkTextView` - Returns whether the `GtkTextView` is in overwrite mode or not. + Returns whether the `GtkTextView` is in overwrite mode or not. + - whether @text_view is in overwrite mode or not. + whether @text_view is in overwrite mode or not. - a `GtkTextView` + a `GtkTextView` - Gets the default number of pixels to put above paragraphs. + Gets the default number of pixels to put above paragraphs. Adding this function with [method@Gtk.TextView.get_pixels_below_lines] is equal to the line space between each paragraph. + - default number of pixels above paragraphs + default number of pixels above paragraphs - a `GtkTextView` + a `GtkTextView` - Gets the default number of pixels to put below paragraphs. + Gets the default number of pixels to put below paragraphs. The line space is the sum of the value returned by this function and the value returned by [method@Gtk.TextView.get_pixels_above_lines]. + - default number of blank pixels below paragraphs + default number of blank pixels below paragraphs - a `GtkTextView` + a `GtkTextView` - Gets the default number of pixels to put between wrapped lines + Gets the default number of pixels to put between wrapped lines inside a paragraph. + - default number of pixels of blank space between wrapped lines + default number of pixels of blank space between wrapped lines - a `GtkTextView` + a `GtkTextView` - Gets the default right margin for text in @text_view. + Gets the default right margin for text in @text_view. Tags in the buffer may override the default. + - right margin in pixels + right margin in pixels - a `GtkTextView` + a `GtkTextView` - Gets the `PangoContext` that is used for rendering RTL directed + Gets the `PangoContext` that is used for rendering RTL directed text layouts. The context may be replaced when CSS changes occur. + - a `PangoContext` + a `PangoContext` - a `GtkTextView` + a `GtkTextView` - Gets the default tabs for @text_view. + Gets the default tabs for @text_view. Tags in the buffer may override the defaults. The returned array will be %NULL if “standard” (8-space) tabs are used. Free the return value with [method@Pango.TabArray.free]. + - copy of default tab array, + copy of default tab array, or %NULL if standard tabs are used; must be freed with [method@Pango.TabArray.free]. - a `GtkTextView` + a `GtkTextView` - Gets the top margin for text in the @text_view. + Gets the top margin for text in the @text_view. + - top margin in pixels + top margin in pixels - a `GtkTextView` + a `GtkTextView` - Fills @visible_rect with the currently-visible + Fills @visible_rect with the currently-visible region of the buffer, in buffer coordinates. Convert to window coordinates with [method@Gtk.TextView.buffer_to_window_coords]. + - a `GtkTextView` + a `GtkTextView` - rectangle to fill + rectangle to fill - Gets the line wrapping for the view. + Gets the line wrapping for the view. + - the line wrap setting + the line wrap setting - a `GtkTextView` + a `GtkTextView` - Allow the `GtkTextView` input method to internally handle key press + Allow the `GtkTextView` input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be @@ -87611,67 +91947,70 @@ gtk_foo_bar_key_press_event (GtkWidget *widget, return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event); } ``` + - %TRUE if the input method handled the key event. + %TRUE if the input method handled the key event. - a `GtkTextView` + a `GtkTextView` - the key event + the key event - Moves a mark within the buffer so that it's + Moves a mark within the buffer so that it's located within the currently-visible text area. + - %TRUE if the mark moved (wasn’t already onscreen) + %TRUE if the mark moved (wasn’t already onscreen) - a `GtkTextView` + a `GtkTextView` - a `GtkTextMark` + a `GtkTextMark` - Updates the position of a child. + Updates the position of a child. See [method@Gtk.TextView.add_overlay]. + - a `GtkTextView` + a `GtkTextView` - a widget already added with [method@Gtk.TextView.add_overlay] + a widget already added with [method@Gtk.TextView.add_overlay] - new X position in buffer coordinates + new X position in buffer coordinates - new Y position in buffer coordinates + new Y position in buffer coordinates - Move the iterator a given number of characters visually, treating + Move the iterator a given number of characters visually, treating it as the strong cursor position. If @count is positive, then the new strong cursor position will @@ -87683,58 +92022,61 @@ In the presence of bi-directional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run. + - %TRUE if @iter moved and is not on the end iterator + %TRUE if @iter moved and is not on the end iterator - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - number of characters to move (negative moves left, + number of characters to move (negative moves left, positive moves right) - Moves the cursor to the currently visible region of the + Moves the cursor to the currently visible region of the buffer. + - %TRUE if the cursor had to be moved. + %TRUE if the cursor had to be moved. - a `GtkTextView` + a `GtkTextView` - Removes a child widget from @text_view. + Removes a child widget from @text_view. + - a `GtkTextView` + a `GtkTextView` - the child to remove + the child to remove - Ensures that the cursor is shown. + Ensures that the cursor is shown. This also resets the time that it will stay blinking (or visible, in case blinking is disabled). @@ -87742,50 +92084,53 @@ visible, in case blinking is disabled). This function should be called in response to user input (e.g. from derived classes that override the textview's event handlers). + - a `GtkTextView` + a `GtkTextView` - Reset the input method context of the text view if needed. + Reset the input method context of the text view if needed. This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. + - a `GtkTextView` + a `GtkTextView` - Scrolls @text_view the minimum distance such that @mark is contained + Scrolls @text_view the minimum distance such that @mark is contained within the visible area of the widget. + - a `GtkTextView` + a `GtkTextView` - a mark in the buffer for @text_view + a mark in the buffer for @text_view - Scrolls @text_view so that @iter is on the screen in the position + Scrolls @text_view so that @iter is on the screen in the position indicated by @xalign and @yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or @@ -87800,40 +92145,41 @@ handler; so this function may not have the desired effect if it’s called before the height computations. To avoid oddness, consider using [method@Gtk.TextView.scroll_to_mark] which saves a point to be scrolled to after line validation. + - %TRUE if scrolling occurred + %TRUE if scrolling occurred - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - margin as a [0.0,0.5) fraction of screen size + margin as a [0.0,0.5) fraction of screen size - whether to use alignment arguments (if %FALSE, + whether to use alignment arguments (if %FALSE, just get the mark onscreen) - horizontal alignment of mark within visible area + horizontal alignment of mark within visible area - vertical alignment of mark within visible area + vertical alignment of mark within visible area - Scrolls @text_view so that @mark is on the screen in the position + Scrolls @text_view so that @mark is on the screen in the position indicated by @xalign and @yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or @@ -87841,54 +92187,56 @@ bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size @within_margin. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextMark` + a `GtkTextMark` - margin as a [0.0,0.5) fraction of screen size + margin as a [0.0,0.5) fraction of screen size - whether to use alignment arguments (if %FALSE, just + whether to use alignment arguments (if %FALSE, just get the mark onscreen) - horizontal alignment of mark within visible area + horizontal alignment of mark within visible area - vertical alignment of mark within visible area + vertical alignment of mark within visible area - Sets the behavior of the text widget when the <kbd>Tab</kbd> key is pressed. + Sets the behavior of the text widget when the <kbd>Tab</kbd> key is pressed. If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab is %FALSE the keyboard focus is moved to the next widget in the focus chain. + - A `GtkTextView` + A `GtkTextView` - %TRUE if pressing the Tab key should insert a tab + %TRUE if pressing the Tab key should insert a tab character, %FALSE, if pressing the Tab key should move the keyboard focus. @@ -87897,453 +92245,475 @@ chain. - Sets the bottom margin for text in @text_view. + Sets the bottom margin for text in @text_view. Note that this function is confusingly named. In CSS terms, the value set here is padding. + - a `GtkTextView` + a `GtkTextView` - bottom margin in pixels + bottom margin in pixels - Sets @buffer as the buffer being displayed by @text_view. + Sets @buffer as the buffer being displayed by @text_view. The previous buffer displayed by the text view is unreferenced, and a reference is added to @buffer. If you owned a reference to @buffer before passing it to this function, you must remove that reference yourself; `GtkTextView` will not “adopt” it. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextBuffer` + a `GtkTextBuffer` - Toggles whether the insertion point should be displayed. + Toggles whether the insertion point should be displayed. A buffer with no editable text probably shouldn’t have a visible cursor, so you may want to turn the cursor off. Note that this property may be overridden by the [property@GtkSettings:gtk-keynav-use-caret] setting. + - a `GtkTextView` + a `GtkTextView` - whether to show the insertion cursor + whether to show the insertion cursor - Sets the default editability of the `GtkTextView`. + Sets the default editability of the `GtkTextView`. You can override this default setting with tags in the buffer, using the “editable” attribute of tags. + - a `GtkTextView` + a `GtkTextView` - whether it’s editable + whether it’s editable - Sets a menu model to add when constructing the context + Sets a menu model to add when constructing the context menu for @text_view. You can pass %NULL to remove a previously set extra menu. + - a `GtkTextView` + a `GtkTextView` - a `GMenuModel` + a `GMenuModel` - Places @widget into the gutter specified by @win. + Places @widget into the gutter specified by @win. @win must be one of %GTK_TEXT_WINDOW_LEFT, %GTK_TEXT_WINDOW_RIGHT, %GTK_TEXT_WINDOW_TOP, or %GTK_TEXT_WINDOW_BOTTOM. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextWindowType` + a `GtkTextWindowType` - a `GtkWidget` + a `GtkWidget` - Sets the default indentation for paragraphs in @text_view. + Sets the default indentation for paragraphs in @text_view. Tags in the buffer may override the default. + - a `GtkTextView` + a `GtkTextView` - indentation in pixels + indentation in pixels - Sets the `input-hints` of the `GtkTextView`. + Sets the `input-hints` of the `GtkTextView`. The `input-hints` allow input methods to fine-tune their behaviour. + - a `GtkTextView` + a `GtkTextView` - the hints + the hints - Sets the `input-purpose` of the `GtkTextView`. + Sets the `input-purpose` of the `GtkTextView`. The `input-purpose` can be used by on-screen keyboards and other input methods to adjust their behaviour. + - a `GtkTextView` + a `GtkTextView` - the purpose + the purpose - Sets the default justification of text in @text_view. + Sets the default justification of text in @text_view. Tags in the view’s buffer may override the default. + - a `GtkTextView` + a `GtkTextView` - justification + justification - Sets the default left margin for text in @text_view. + Sets the default left margin for text in @text_view. Tags in the buffer may override the default. Note that this function is confusingly named. In CSS terms, the value set here is padding. + - a `GtkTextView` + a `GtkTextView` - left margin in pixels + left margin in pixels - Sets whether the `GtkTextView` should display text in + Sets whether the `GtkTextView` should display text in monospace styling. + - a `GtkTextView` + a `GtkTextView` - %TRUE to request monospace styling + %TRUE to request monospace styling - Changes the `GtkTextView` overwrite mode. + Changes the `GtkTextView` overwrite mode. + - a `GtkTextView` + a `GtkTextView` - %TRUE to turn on overwrite mode, %FALSE to turn it off + %TRUE to turn on overwrite mode, %FALSE to turn it off - Sets the default number of blank pixels above paragraphs in @text_view. + Sets the default number of blank pixels above paragraphs in @text_view. Tags in the buffer for @text_view may override the defaults. + - a `GtkTextView` + a `GtkTextView` - pixels above paragraphs + pixels above paragraphs - Sets the default number of pixels of blank space + Sets the default number of pixels of blank space to put below paragraphs in @text_view. May be overridden by tags applied to @text_view’s buffer. + - a `GtkTextView` + a `GtkTextView` - pixels below paragraphs + pixels below paragraphs - Sets the default number of pixels of blank space to leave between + Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph. May be overridden by tags in @text_view’s buffer. + - a `GtkTextView` + a `GtkTextView` - default number of pixels between wrapped lines + default number of pixels between wrapped lines - Sets the default right margin for text in the text view. + Sets the default right margin for text in the text view. Tags in the buffer may override the default. Note that this function is confusingly named. In CSS terms, the value set here is padding. + - a `GtkTextView` + a `GtkTextView` - right margin in pixels + right margin in pixels - Sets the default tab stops for paragraphs in @text_view. + Sets the default tab stops for paragraphs in @text_view. Tags in the buffer may override the default. + - a `GtkTextView` + a `GtkTextView` - tabs as a `PangoTabArray` + tabs as a `PangoTabArray` - Sets the top margin for text in @text_view. + Sets the top margin for text in @text_view. Note that this function is confusingly named. In CSS terms, the value set here is padding. + - a `GtkTextView` + a `GtkTextView` - top margin in pixels + top margin in pixels - Sets the line wrapping for the view. + Sets the line wrapping for the view. + - a `GtkTextView` + a `GtkTextView` - a `GtkWrapMode` + a `GtkWrapMode` - Determines whether @iter is at the start of a display line. + Determines whether @iter is at the start of a display line. See [method@Gtk.TextView.forward_display_line] for an explanation of display lines vs. paragraphs. + - %TRUE if @iter begins a wrapped line + %TRUE if @iter begins a wrapped line - a `GtkTextView` + a `GtkTextView` - a `GtkTextIter` + a `GtkTextIter` - Converts coordinates on the window identified by @win to buffer + Converts coordinates on the window identified by @win to buffer coordinates. + - a `GtkTextView` + a `GtkTextView` - a `GtkTextWindowType` + a `GtkTextWindowType` - window x coordinate + window x coordinate - window y coordinate + window y coordinate - buffer x coordinate return location + buffer x coordinate return location - buffer y coordinate return location + buffer y coordinate return location @@ -88351,13 +92721,13 @@ coordinates. - Whether Tab will result in a tab character being entered. + Whether Tab will result in a tab character being entered. - The bottom margin for text in the text view. + The bottom margin for text in the text view. Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition @@ -88369,13 +92739,13 @@ Don't confuse this property with [property@Gtk.Widget:margin-bottom]. - The buffer which is displayed. + The buffer which is displayed. - If the insertion cursor is shown. + If the insertion cursor is shown. @@ -88384,11 +92754,11 @@ Don't confuse this property with [property@Gtk.Widget:margin-bottom]. - A menu model whose contents will be appended to the context menu. + A menu model whose contents will be appended to the context menu. - Which IM (input method) module should be used for this text_view. + Which IM (input method) module should be used for this text_view. See [class@Gtk.IMMulticontext]. @@ -88399,20 +92769,20 @@ setting. See the GtkSettings [property@Gtk.Settings:gtk-im-module] property. - Amount to indent the paragraph, in pixels. + Amount to indent the paragraph, in pixels. - Additional hints (beyond [property@Gtk.TextView:input-purpose]) + Additional hints (beyond [property@Gtk.TextView:input-purpose]) that allow input methods to fine-tune their behaviour. - The purpose of this text field. + The purpose of this text field. This property can be used by on-screen keyboards and other input methods to adjust their behaviour. @@ -88424,7 +92794,7 @@ methods to adjust their behaviour. - The default left margin for text in the text view. + The default left margin for text in the text view. Tags in the buffer may override the default. @@ -88436,7 +92806,7 @@ to the padding from the theme. - Whether text should be displayed in a monospace font. + Whether text should be displayed in a monospace font. If %TRUE, set the .monospace style class on the text view to indicate that a monospace font is desired. @@ -88445,7 +92815,7 @@ text view to indicate that a monospace font is desired. - Whether entered text overwrites existing contents. + Whether entered text overwrites existing contents. @@ -88460,7 +92830,7 @@ text view to indicate that a monospace font is desired. - The default right margin for text in the text view. + The default right margin for text in the text view. Tags in the buffer may override the default. @@ -88475,7 +92845,7 @@ to the padding from the theme. - The top margin for text in the text view. + The top margin for text in the text view. Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition @@ -88494,7 +92864,7 @@ Don't confuse this property with [property@Gtk.Widget:margin-top]. - Gets emitted when the user asks for it. + Gets emitted when the user asks for it. The ::backspace signal is a [keybinding signal](class.SignalAction.html). @@ -88505,7 +92875,7 @@ The default bindings for this signal are - Gets emitted to copy the selection to the clipboard. + Gets emitted to copy the selection to the clipboard. The ::copy-clipboard signal is a [keybinding signal](class.SignalAction.html). @@ -88517,7 +92887,7 @@ The default bindings for this signal are - Gets emitted to cut the selection to the clipboard. + Gets emitted to cut the selection to the clipboard. The ::cut-clipboard signal is a [keybinding signal](class.SignalAction.html). @@ -88529,7 +92899,7 @@ The default bindings for this signal are - Gets emitted when the user initiates a text deletion. + Gets emitted when the user initiates a text deletion. The ::delete-from-cursor signal is a [keybinding signal](class.SignalAction.html). @@ -88546,43 +92916,43 @@ deleting a word backwards. - the granularity of the deletion, as a `GtkDeleteType` + the granularity of the deletion, as a `GtkDeleteType` - the number of @type units to delete + the number of @type units to delete - Emitted when the selection needs to be extended at @location. + Emitted when the selection needs to be extended at @location. - %GDK_EVENT_STOP to stop other handlers from being invoked for the + %GDK_EVENT_STOP to stop other handlers from being invoked for the event. %GDK_EVENT_PROPAGATE to propagate the event further. - the granularity type + the granularity type - the location where to extend the selection + the location where to extend the selection - where the selection should start + where the selection should start - where the selection should end + where the selection should end - Gets emitted when the user initiates the insertion of a + Gets emitted when the user initiates the insertion of a fixed string at the cursor. The ::insert-at-cursor signal is a [keybinding signal](class.SignalAction.html). @@ -88593,13 +92963,13 @@ This signal has no default bindings. - the string to insert + the string to insert - Gets emitted to present the Emoji chooser for the @text_view. + Gets emitted to present the Emoji chooser for the @text_view. The ::insert-emoji signal is a [keybinding signal](class.SignalAction.html). @@ -88611,7 +92981,7 @@ The default bindings for this signal are - Gets emitted when the user initiates a cursor movement. + Gets emitted when the user initiates a cursor movement. The ::move-cursor signal is a [keybinding signal](class.SignalAction.html). If the cursor is not visible in @text_view, this signal causes @@ -88639,21 +93009,21 @@ There are too many key combinations to list them all here. - the granularity of the move, as a `GtkMovementStep` + the granularity of the move, as a `GtkMovementStep` - the number of @step units to move + the number of @step units to move - %TRUE if the move should extend the selection + %TRUE if the move should extend the selection - Gets emitted to move the viewport. + Gets emitted to move the viewport. The ::move-viewport signal is a [keybinding signal](class.SignalAction.html), which can be bound to key combinations to allow the user to move the viewport, @@ -88666,17 +93036,17 @@ There are no default bindings for this signal. - the granularity of the movement, as a `GtkScrollStep` + the granularity of the movement, as a `GtkScrollStep` - the number of @step units to move + the number of @step units to move - Gets emitted to paste the contents of the clipboard + Gets emitted to paste the contents of the clipboard into the text view. The ::paste-clipboard signal is a [keybinding signal](class.SignalAction.html). @@ -88689,7 +93059,7 @@ The default bindings for this signal are - Emitted when preedit text of the active IM changes. + Emitted when preedit text of the active IM changes. If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, @@ -88702,13 +93072,13 @@ is actually editable. - the current preedit string + the current preedit string - Gets emitted to select or unselect the complete contents of the text view. + Gets emitted to select or unselect the complete contents of the text view. The ::select-all signal is a [keybinding signal](class.SignalAction.html). @@ -88722,13 +93092,13 @@ The default bindings for this signal are - %TRUE to select, %FALSE to unselect + %TRUE to select, %FALSE to unselect - Gets emitted when the user initiates settings the "anchor" mark. + Gets emitted when the user initiates settings the "anchor" mark. The ::set-anchor signal is a [keybinding signal](class.SignalAction.html) which gets emitted when the user initiates setting the "anchor" @@ -88741,7 +93111,7 @@ This signal has no default bindings. - Gets emitted to toggle the `cursor-visible` property. + Gets emitted to toggle the `cursor-visible` property. The ::toggle-cursor-visible signal is a [keybinding signal](class.SignalAction.html). @@ -88752,7 +93122,7 @@ The default binding for this signal is <kbd>F7</kbd>. - Gets emitted to toggle the overwrite mode of the text view. + Gets emitted to toggle the overwrite mode of the text view. The ::toggle-overwrite signal is a [keybinding signal](class.SignalAction.html). @@ -88763,12 +93133,14 @@ The default binding for this signal is <kbd>Insert</kbd>. + - The object class structure needs to be the first + The object class structure needs to be the first + @@ -88790,6 +93162,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88802,6 +93175,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88817,6 +93191,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88835,6 +93210,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88847,6 +93223,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88859,6 +93236,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88871,6 +93249,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88883,6 +93262,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88895,6 +93275,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88907,6 +93288,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88925,6 +93307,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88949,6 +93332,7 @@ The default binding for this signal is <kbd>Insert</kbd>. + @@ -88966,61 +93350,64 @@ The default binding for this signal is <kbd>Insert</kbd>. - Used to reference the layers of `GtkTextView` for the purpose of customized + Used to reference the layers of `GtkTextView` for the purpose of customized drawing with the ::snapshot_layer vfunc. - The layer rendered below the text (but above the background). + The layer rendered below the text (but above the background). - The layer rendered above the text. + The layer rendered above the text. - + + + - Used to reference the parts of `GtkTextView`. + Used to reference the parts of `GtkTextView`. - Window that floats over scrolling areas. + Window that floats over scrolling areas. - Scrollable text window. + Scrollable text window. - Left side border window. + Left side border window. - Right side border window. + Right side border window. - Top border window. + Top border window. - Bottom border window. + Bottom border window. - Callback type for adding a function to update animations. See gtk_widget_add_tick_callback(). + Callback type for adding a function to update animations. See gtk_widget_add_tick_callback(). + - %G_SOURCE_CONTINUE if the tick callback should continue to be called, + %G_SOURCE_CONTINUE if the tick callback should continue to be called, %G_SOURCE_REMOVE if the tick callback should be removed. - the widget + the widget - the frame clock for the widget (same as calling gtk_widget_get_frame_clock()) + the frame clock for the widget (same as calling gtk_widget_get_frame_clock()) - user data passed to gtk_widget_add_tick_callback(). + user data passed to gtk_widget_add_tick_callback(). - A `GtkToggleButton` is a button which remains “pressed-in” when + A `GtkToggleButton` is a button which remains “pressed-in” when clicked. Clicking again will cause the toggle button to return to its normal state. @@ -89086,106 +93473,113 @@ void make_toggles (void) gtk_widget_show (window); } ``` + - Creates a new toggle button. + Creates a new toggle button. A widget should be packed into the button, as in [ctor@Gtk.Button.new]. + - a new toggle button. + a new toggle button. - Creates a new toggle button with a text label. + Creates a new toggle button with a text label. + - a new toggle button. + a new toggle button. - a string containing the message to be placed in the toggle button. + a string containing the message to be placed in the toggle button. - Creates a new `GtkToggleButton` containing a label. + Creates a new `GtkToggleButton` containing a label. The label will be created using [ctor@Gtk.Label.new_with_mnemonic], so underscores in @label indicate the mnemonic for the button. + - a new `GtkToggleButton` + a new `GtkToggleButton` - the text of the button, with an underscore in front of the + the text of the button, with an underscore in front of the mnemonic character - Emits the ::toggled signal on the `GtkToggleButton`. + Emits the ::toggled signal on the `GtkToggleButton`. There is no good reason for an application ever to call this function. + - a `GtkToggleButton`. + a `GtkToggleButton`. - Queries a `GtkToggleButton` and returns its current state. + Queries a `GtkToggleButton` and returns its current state. Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised. + - whether the button is pressed + whether the button is pressed - a `GtkToggleButton`. + a `GtkToggleButton`. - Sets the status of the toggle button. + Sets the status of the toggle button. Set to %TRUE if you want the `GtkToggleButton` to be “pressed in”, and %FALSE to raise it. If the status of the button changes, this action causes the [signal@GtkToggleButton::toggled] signal to be emitted. + - a `GtkToggleButton`. + a `GtkToggleButton`. - %TRUE or %FALSE. + %TRUE or %FALSE. - Adds @self to the group of @group. + Adds @self to the group of @group. In a group of multiple toggle buttons, only one button can be active at a time. @@ -89196,31 +93590,33 @@ Note that the same effect can be achieved via the [iface@Gtk.Actionable] API, by using the same action with parameter type and state type 's' for all buttons in the group, and giving each button its own target value. + - a `GtkToggleButton` + a `GtkToggleButton` - another `GtkToggleButton` to + another `GtkToggleButton` to form a group with - Emits the ::toggled signal on the `GtkToggleButton`. + Emits the ::toggled signal on the `GtkToggleButton`. There is no good reason for an application ever to call this function. + - a `GtkToggleButton`. + a `GtkToggleButton`. @@ -89228,36 +93624,38 @@ There is no good reason for an application ever to call this function. - If the toggle button should be pressed in. + If the toggle button should be pressed in. - The toggle button whose group this widget belongs to. + The toggle button whose group this widget belongs to. - Emitted whenever the `GtkToggleButton`'s state is changed. + Emitted whenever the `GtkToggleButton`'s state is changed. + + - a `GtkToggleButton`. + a `GtkToggleButton`. @@ -89270,7 +93668,7 @@ There is no good reason for an application ever to call this function. - `GtkTooltip` is an object representing a widget tooltip. + `GtkTooltip` is an object representing a widget tooltip. Basic tooltips can be realized simply by using [method@Gtk.Widget.set_tooltip_text] or @@ -89298,119 +93696,125 @@ little more work: - Return %TRUE from your ::query-tooltip handler. This causes the tooltip to be show. If you return %FALSE, it will not be shown. - Replaces the widget packed into the tooltip with + Replaces the widget packed into the tooltip with @custom_widget. @custom_widget does not get destroyed when the tooltip goes away. By default a box with a `GtkImage` and `GtkLabel` is embedded in the tooltip, which can be configured using gtk_tooltip_set_markup() and gtk_tooltip_set_icon(). + - a `GtkTooltip` + a `GtkTooltip` - a `GtkWidget`, or %NULL to unset the old custom widget. + a `GtkWidget`, or %NULL to unset the old custom widget. - Sets the icon of the tooltip (which is in front of the text) to be + Sets the icon of the tooltip (which is in front of the text) to be @paintable. If @paintable is %NULL, the image will be hidden. + - a `GtkTooltip` + a `GtkTooltip` - a `GdkPaintable` + a `GdkPaintable` - Sets the icon of the tooltip (which is in front of the text) + Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by @gicon with the size indicated by @size. If @gicon is %NULL, the image will be hidden. + - a `GtkTooltip` + a `GtkTooltip` - a `GIcon` representing the icon + a `GIcon` representing the icon - Sets the icon of the tooltip (which is in front of the text) to be + Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by @icon_name with the size indicated by @size. If @icon_name is %NULL, the image will be hidden. + - a `GtkTooltip` + a `GtkTooltip` - an icon name + an icon name - Sets the text of the tooltip to be @markup. + Sets the text of the tooltip to be @markup. The string must be marked up with Pango markup. If @markup is %NULL, the label will be hidden. + - a `GtkTooltip` + a `GtkTooltip` - a string with Pango markup or %NLL + a string with Pango markup or %NLL - Sets the text of the tooltip to be @text. + Sets the text of the tooltip to be @text. If @text is %NULL, the label will be hidden. See also [method@Gtk.Tooltip.set_markup]. + - a `GtkTooltip` + a `GtkTooltip` - a text string + a text string - Sets the area of the widget, where the contents of this tooltip apply, + Sets the area of the widget, where the contents of this tooltip apply, to be @rect (in widget coordinates). This is especially useful for properly setting tooltips on `GtkTreeView` rows and cells, `GtkIconViews`, etc. @@ -89418,23 +93822,24 @@ etc. For setting tooltips on `GtkTreeView`, please refer to the convenience functions for this: gtk_tree_view_set_tooltip_row() and gtk_tree_view_set_tooltip_cell(). + - a `GtkTooltip` + a `GtkTooltip` - a `GdkRectangle` + a `GdkRectangle` - A function to set the properties of a cell instead of just using the + A function to set the properties of a cell instead of just using the straight mapping between the cell and the model. This function is useful for customizing the cell renderer. For example, @@ -89442,158 +93847,166 @@ a function might get an* integer from the @tree_model, and render it to the “text” attribute of “cell” by converting it to its written equivalent. See also: gtk_tree_view_column_set_cell_data_func() + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - The `GtkCellRenderer` that is being rendered by @tree_column + The `GtkCellRenderer` that is being rendered by @tree_column - The `GtkTreeModel` being rendered + The `GtkTreeModel` being rendered - A `GtkTreeIter` of the current row rendered + A `GtkTreeIter` of the current row rendered - user data + user data - Interface for Drag-and-Drop destinations in `GtkTreeView`. + Interface for Drag-and-Drop destinations in `GtkTreeView`. + - Asks the `GtkTreeDragDest` to insert a row before the path @dest, + Asks the `GtkTreeDragDest` to insert a row before the path @dest, deriving the contents of the row from @value. If @dest is outside the tree so that inserting before it is impossible, %FALSE will be returned. Also, %FALSE may be returned if the new row is not created for some model-specific reason. Should robustly handle a @dest no longer found in the model! + - whether a new row was created before position @dest + whether a new row was created before position @dest - a `GtkTreeDragDest` + a `GtkTreeDragDest` - row to drop in front of + row to drop in front of - data to drop + data to drop - Determines whether a drop is possible before the given @dest_path, + Determines whether a drop is possible before the given @dest_path, at the same depth as @dest_path. i.e., can we drop the data in @value at that location. @dest_path does not have to exist; the return value will almost certainly be %FALSE if the parent of @dest_path doesn’t exist, though. + - %TRUE if a drop is possible before @dest_path + %TRUE if a drop is possible before @dest_path - a `GtkTreeDragDest` + a `GtkTreeDragDest` - destination row + destination row - the data being dropped + the data being dropped - Asks the `GtkTreeDragDest` to insert a row before the path @dest, + Asks the `GtkTreeDragDest` to insert a row before the path @dest, deriving the contents of the row from @value. If @dest is outside the tree so that inserting before it is impossible, %FALSE will be returned. Also, %FALSE may be returned if the new row is not created for some model-specific reason. Should robustly handle a @dest no longer found in the model! + - whether a new row was created before position @dest + whether a new row was created before position @dest - a `GtkTreeDragDest` + a `GtkTreeDragDest` - row to drop in front of + row to drop in front of - data to drop + data to drop - Determines whether a drop is possible before the given @dest_path, + Determines whether a drop is possible before the given @dest_path, at the same depth as @dest_path. i.e., can we drop the data in @value at that location. @dest_path does not have to exist; the return value will almost certainly be %FALSE if the parent of @dest_path doesn’t exist, though. + - %TRUE if a drop is possible before @dest_path + %TRUE if a drop is possible before @dest_path - a `GtkTreeDragDest` + a `GtkTreeDragDest` - destination row + destination row - the data being dropped + the data being dropped + + - whether a new row was created before position @dest + whether a new row was created before position @dest - a `GtkTreeDragDest` + a `GtkTreeDragDest` - row to drop in front of + row to drop in front of - data to drop + data to drop @@ -89601,21 +94014,22 @@ parent of @dest_path doesn’t exist, though. + - %TRUE if a drop is possible before @dest_path + %TRUE if a drop is possible before @dest_path - a `GtkTreeDragDest` + a `GtkTreeDragDest` - destination row + destination row - the data being dropped + the data being dropped @@ -89623,145 +94037,154 @@ parent of @dest_path doesn’t exist, though. - Interface for Drag-and-Drop destinations in `GtkTreeView`. + Interface for Drag-and-Drop destinations in `GtkTreeView`. + - Asks the `GtkTreeDragSource` to delete the row at @path, because + Asks the `GtkTreeDragSource` to delete the row at @path, because it was moved somewhere else via drag-and-drop. Returns %FALSE if the deletion fails because @path no longer exists, or for some model-specific reason. Should robustly handle a @path no longer found in the model! + - %TRUE if the row was successfully deleted + %TRUE if the row was successfully deleted - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row that was being dragged + row that was being dragged - Asks the `GtkTreeDragSource` to return a `GdkContentProvider` representing + Asks the `GtkTreeDragSource` to return a `GdkContentProvider` representing the row at @path. Should robustly handle a @path no longer found in the model! + - a `GdkContentProvider` for the + a `GdkContentProvider` for the given @path - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row that was dragged + row that was dragged - Asks the `GtkTreeDragSource` whether a particular row can be used as + Asks the `GtkTreeDragSource` whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable. + - %TRUE if the row can be dragged + %TRUE if the row can be dragged - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row on which user is initiating a drag + row on which user is initiating a drag - Asks the `GtkTreeDragSource` to delete the row at @path, because + Asks the `GtkTreeDragSource` to delete the row at @path, because it was moved somewhere else via drag-and-drop. Returns %FALSE if the deletion fails because @path no longer exists, or for some model-specific reason. Should robustly handle a @path no longer found in the model! + - %TRUE if the row was successfully deleted + %TRUE if the row was successfully deleted - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row that was being dragged + row that was being dragged - Asks the `GtkTreeDragSource` to return a `GdkContentProvider` representing + Asks the `GtkTreeDragSource` to return a `GdkContentProvider` representing the row at @path. Should robustly handle a @path no longer found in the model! + - a `GdkContentProvider` for the + a `GdkContentProvider` for the given @path - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row that was dragged + row that was dragged - Asks the `GtkTreeDragSource` whether a particular row can be used as + Asks the `GtkTreeDragSource` whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable. + - %TRUE if the row can be dragged + %TRUE if the row can be dragged - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row on which user is initiating a drag + row on which user is initiating a drag + + - %TRUE if the row can be dragged + %TRUE if the row can be dragged - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row on which user is initiating a drag + row on which user is initiating a drag @@ -89769,18 +94192,19 @@ this interface, the row is assumed draggable. + - a `GdkContentProvider` for the + a `GdkContentProvider` for the given @path - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row that was dragged + row that was dragged @@ -89788,17 +94212,18 @@ this interface, the row is assumed draggable. + - %TRUE if the row was successfully deleted + %TRUE if the row was successfully deleted - a `GtkTreeDragSource` + a `GtkTreeDragSource` - row that was being dragged + row that was being dragged @@ -89806,7 +94231,7 @@ this interface, the row is assumed draggable. - `GtkTreeExpander` is a widget that provides an expander for a list. + `GtkTreeExpander` is a widget that provides an expander for a list. It is typically placed as a bottommost child into a `GtkListView` to allow users to expand and collapse children in a list with a @@ -89845,94 +94270,101 @@ For every level of depth, another "indent" node is prepended. `GtkTreeExpander` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. The expander icon is represented as a %GTK_ACCESSIBLE_ROLE_BUTTON, labelled by the expander's child, and toggling it will change the %GTK_ACCESSIBLE_STATE_EXPANDED state. + - Creates a new `GtkTreeExpander` + Creates a new `GtkTreeExpander` + - a new `GtkTreeExpander` + a new `GtkTreeExpander` - Gets the child widget displayed by @self. + Gets the child widget displayed by @self. + - The child displayed by @self + The child displayed by @self - a `GtkTreeExpander` + a `GtkTreeExpander` - Forwards the item set on the `GtkTreeListRow` that @self is managing. + Forwards the item set on the `GtkTreeListRow` that @self is managing. This call is essentially equivalent to calling: ```c gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self)); ``` + - The item of the row + The item of the row - a `GtkTreeExpander` + a `GtkTreeExpander` - Gets the list row managed by @self. + Gets the list row managed by @self. + - The list row displayed by @self + The list row displayed by @self - a `GtkTreeExpander` + a `GtkTreeExpander` - Sets the content widget to display. + Sets the content widget to display. + - a `GtkTreeExpander` + a `GtkTreeExpander` - a `GtkWidget` + a `GtkWidget` - Sets the tree list row that this expander should manage. + Sets the tree list row that this expander should manage. + - a `GtkTreeExpander` widget + a `GtkTreeExpander` widget - a `GtkTreeListRow` + a `GtkTreeListRow` @@ -89940,83 +94372,87 @@ gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self)); - The child widget with the actual contents. + The child widget with the actual contents. - The item held by this expander's row. + The item held by this expander's row. - The list row to track for expander state. + The list row to track for expander state. + - The `GtkTreeIter` is the primary structure + The `GtkTreeIter` is the primary structure for accessing a `GtkTreeModel`. Models are expected to put a unique integer in the @stamp member, and put model-specific data in the three @user_data members. + - a unique stamp to catch invalid iterators + a unique stamp to catch invalid iterators - model-specific data + model-specific data - model-specific data + model-specific data - model-specific data + model-specific data - Creates a dynamically allocated tree iterator as a copy of @iter. + Creates a dynamically allocated tree iterator as a copy of @iter. This function is not intended for use in applications, because you can just copy the structs by value (`GtkTreeIter new_iter = iter;`). You must free this iter with gtk_tree_iter_free(). + - a newly-allocated copy of @iter + a newly-allocated copy of @iter - a `GtkTreeIter` + a `GtkTreeIter` - Frees an iterator that has been allocated by gtk_tree_iter_copy(). + Frees an iterator that has been allocated by gtk_tree_iter_copy(). This function is mainly used for language bindings. + - a dynamically allocated tree iterator + a dynamically allocated tree iterator - A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive + A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b respectively. @@ -90028,127 +94464,133 @@ the model, i.e. it must be reflexive, antisymmetric and transitive. For example, if @model is a product catalogue, then a compare function for the “price” column could be one which returns `price_of(@a) - price_of(@b)`. + - a negative integer, zero or a positive integer depending on whether + a negative integer, zero or a positive integer depending on whether @a sorts before, with or after @b - The `GtkTreeModel` the comparison is within + The `GtkTreeModel` the comparison is within - A `GtkTreeIter` in @model + A `GtkTreeIter` in @model - Another `GtkTreeIter` in @model + Another `GtkTreeIter` in @model - Data passed when the compare func is assigned e.g. by + Data passed when the compare func is assigned e.g. by gtk_tree_sortable_set_sort_func() - `GtkTreeListModel` is a list model that can create child models on demand. + `GtkTreeListModel` is a list model that can create child models on demand. + - Creates a new empty `GtkTreeListModel` displaying @root + Creates a new empty `GtkTreeListModel` displaying @root with all rows collapsed. + - a newly created `GtkTreeListModel`. + a newly created `GtkTreeListModel`. - The `GListModel` to use as root + The `GListModel` to use as root - %TRUE to pass through items from the models + %TRUE to pass through items from the models - %TRUE to set the autoexpand property and expand the @root model + %TRUE to set the autoexpand property and expand the @root model - Function to call to create the `GListModel` for the children + Function to call to create the `GListModel` for the children of an item - Data to pass to @create_func + Data to pass to @create_func - Function to call to free @user_data + Function to call to free @user_data - Gets whether the model is set to automatically expand new rows + Gets whether the model is set to automatically expand new rows that get added. This can be either rows added by changes to the underlying models or via [method@Gtk.TreeListRow.set_expanded]. + - %TRUE if the model is set to autoexpand + %TRUE if the model is set to autoexpand - a `GtkTreeListModel` + a `GtkTreeListModel` - Gets the row item corresponding to the child at index @position for + Gets the row item corresponding to the child at index @position for @self's root model. If @position is greater than the number of children in the root model, %NULL is returned. Do not confuse this function with [method@Gtk.TreeListModel.get_row]. + - the child in @position + the child in @position - a `GtkTreeListModel` + a `GtkTreeListModel` - position of the child to get + position of the child to get - Gets the root model that @self was created with. + Gets the root model that @self was created with. + - the root model + the root model - a `GtkTreeListModel` + a `GtkTreeListModel` - Gets whether the model is passing through original row items. + Gets whether the model is passing through original row items. If this function returns %FALSE, the `GListModel` functions for @self return custom `GtkTreeListRow` objects. You need to call @@ -90158,19 +94600,20 @@ item. If %TRUE, the values of the child models are passed through in their original state. You then need to call [method@Gtk.TreeListModel.get_row] to get the custom `GtkTreeListRow`s. + - %TRUE if the model is passing through original row items + %TRUE if the model is passing through original row items - a `GtkTreeListModel` + a `GtkTreeListModel` - Gets the row object for the given row. + Gets the row object for the given row. If @position is greater than the number of items in @self, %NULL is returned. @@ -90187,38 +94630,40 @@ If @self is set to not be passthrough, this function is equivalent to calling g_list_model_get_item(). Do not confuse this function with [method@Gtk.TreeListModel.get_child_row]. + - The row item + The row item - a `GtkTreeListModel` + a `GtkTreeListModel` - the position of the row to fetch + the position of the row to fetch - Sets whether the model should autoexpand. + Sets whether the model should autoexpand. If set to %TRUE, the model will recursively expand all rows that get added to the model. This can be either rows added by changes to the underlying models or via [method@Gtk.TreeListRow.set_expanded]. + - a `GtkTreeListModel` + a `GtkTreeListModel` - %TRUE to make the model autoexpand its rows + %TRUE to make the model autoexpand its rows @@ -90226,17 +94671,17 @@ to the underlying models or via [method@Gtk.TreeListRow.set_expanded]. - If all rows should be expanded by default. + If all rows should be expanded by default. - The root model displayed. + The root model displayed. - Gets whether the model is in passthrough mode. + Gets whether the model is in passthrough mode. If %FALSE, the `GListModel` functions for this object return custom [class@Gtk.TreeListRow] objects. If %TRUE, the values of the child @@ -90245,36 +94690,38 @@ models are pass through unmodified. + - Prototype of the function called to create new child models when + Prototype of the function called to create new child models when gtk_tree_list_row_set_expanded() is called. This function can return %NULL to indicate that @item is guaranteed to be a leaf node and will never have children. If it does not have children but may get children later, it should return an empty model that is filled once children arrive. + - The model tracking the children of + The model tracking the children of @item or %NULL if @item can never have children - The item that is being expanded + The item that is being expanded - User data passed when registering the function + User data passed when registering the function - `GtkTreeListRow` is used by `GtkTreeListModel` to represent items. + `GtkTreeListRow` is used by `GtkTreeListModel` to represent items. It allows navigating the model as a tree and modify the state of rows. @@ -90285,97 +94732,103 @@ There are various support objects that can make use of `GtkTreeListRow` objects, such as the [class@Gtk.TreeExpander] widget that allows displaying an icon to expand or collapse a row or [class@Gtk.TreeListRowSorter] that makes it possible to sort trees properly. + - If @self is not expanded or @position is greater than the + If @self is not expanded or @position is greater than the number of children, %NULL is returned. + - the child in @position + the child in @position - a `GtkTreeListRow` + a `GtkTreeListRow` - position of the child to get + position of the child to get - If the row is expanded, gets the model holding the children of @self. + If the row is expanded, gets the model holding the children of @self. This model is the model created by the [callback@Gtk.TreeListModelCreateModelFunc] and contains the original items, no matter what value [property@Gtk.TreeListModel:passthrough] is set to. + - The model containing the children + The model containing the children - a `GtkTreeListRow` + a `GtkTreeListRow` - Gets the depth of this row. + Gets the depth of this row. Rows that correspond to items in the root model have a depth of zero, rows corresponding to items of models of direct children of the root model have a depth of 1 and so on. The depth of a row never changes until the row is destroyed. + - The depth of this row + The depth of this row - a `GtkTreeListRow` + a `GtkTreeListRow` - Gets if a row is currently expanded. + Gets if a row is currently expanded. + - %TRUE if the row is expanded + %TRUE if the row is expanded - a `GtkTreeListRow` + a `GtkTreeListRow` - Gets the item corresponding to this row, + Gets the item corresponding to this row, The value returned by this function never changes until the row is destroyed. + - The item + The item of this row or %NULL when the row was destroyed - a `GtkTreeListRow` + a `GtkTreeListRow` - Gets the row representing the parent for @self. + Gets the row representing the parent for @self. That is the row that would need to be collapsed to make this row disappear. @@ -90385,53 +94838,56 @@ If @self is a row corresponding to the root model, The value returned by this function never changes until the row is destroyed. + - The parent of @self + The parent of @self - a `GtkTreeListRow` + a `GtkTreeListRow` - Returns the position in the `GtkTreeListModel` that @self occupies + Returns the position in the `GtkTreeListModel` that @self occupies at the moment. + - The position in the model + The position in the model - a `GtkTreeListRow` + a `GtkTreeListRow` - Checks if a row can be expanded. + Checks if a row can be expanded. This does not mean that the row is actually expanded, this can be checked with [method@Gtk.TreeListRow.get_expanded]. If a row is expandable never changes until the row is destroyed. + - %TRUE if the row is expandable + %TRUE if the row is expandable - a `GtkTreeListRow` + a `GtkTreeListRow` - Expands or collapses a row. + Expands or collapses a row. If a row is expanded, the model of calling the [callback@Gtk.TreeListModelCreateModelFunc] for the row's @@ -90439,54 +94895,56 @@ item will be inserted after this row. If a row is collapsed, those items will be removed from the model. If the row is not expandable, this function does nothing. + - a `GtkTreeListRow` + a `GtkTreeListRow` - %TRUE if the row should be expanded + %TRUE if the row should be expanded - The model holding the row's children. + The model holding the row's children. - The depth in the tree of this row. + The depth in the tree of this row. - If this row can ever be expanded. + If this row can ever be expanded. - If this row is currently expanded. + If this row is currently expanded. - The item held in this row. + The item held in this row. + - `GtkTreeListRowSorter` is a special-purpose sorter that will apply a given + `GtkTreeListRowSorter` is a special-purpose sorter that will apply a given sorter to the levels in a tree. Here is an example for setting up a column view with a tree model and @@ -90499,67 +94957,72 @@ sort_model = gtk_sort_list_model_new (tree_model, sorter); selection = gtk_single_selection_new (sort_model); gtk_column_view_set_model (view, G_LIST_MODEL (selection)); ``` + - Create a special-purpose sorter that applies the sorting + Create a special-purpose sorter that applies the sorting of @sorter to the levels of a `GtkTreeListModel`. Note that this sorter relies on [property@Gtk.TreeListModel:passthrough] being %FALSE as it can only sort [class@Gtk.TreeListRow]s. + - a new `GtkTreeListRowSorter` + a new `GtkTreeListRowSorter` - a `GtkSorter` + a `GtkSorter` - Returns the sorter used by @self. + Returns the sorter used by @self. + - the sorter used + the sorter used - a `GtkTreeListRowSorter` + a `GtkTreeListRowSorter` - Sets the sorter to use for items with the same parent. + Sets the sorter to use for items with the same parent. This sorter will be passed the [property@Gtk.TreeListRow:item] of the tree list rows passed to @self. + - a `GtkTreeListRowSorter` + a `GtkTreeListRowSorter` - The sorter to use + The sorter to use - The underlying sorter + The underlying sorter + - The tree interface used by GtkTreeView + The tree interface used by GtkTreeView The `GtkTreeModel` interface defines a generic tree interface for use by the `GtkTreeView` widget. It is an abstract interface, and @@ -90755,125 +95218,132 @@ into account: required for levels in which nodes are referenced. For the root level however, signals must be emitted at all times (however the root level is always referenced when any view is attached). + - Returns the type of the column. + Returns the type of the column. + - the type of the column + the type of the column - a `GtkTreeModel` + a `GtkTreeModel` - the column index + the column index - Returns a set of flags supported by this interface. + Returns a set of flags supported by this interface. The flags are a bitwise combination of `GtkTreeModel`Flags. The flags supported should not change during the lifetime of the @tree_model. + - the flags supported by this interface + the flags supported by this interface - a `GtkTreeModel` + a `GtkTreeModel` - Sets @iter to a valid iterator pointing to @path. + Sets @iter to a valid iterator pointing to @path. If @path does not exist, @iter is set to an invalid iterator and %FALSE is returned. + - %TRUE, if @iter was set + %TRUE, if @iter was set - a `GtkTreeModel` + a `GtkTreeModel` - the uninitialized `GtkTreeIter` + the uninitialized `GtkTreeIter` - the `GtkTreePath` + the `GtkTreePath` - Returns the number of columns supported by @tree_model. + Returns the number of columns supported by @tree_model. + - the number of columns + the number of columns - a `GtkTreeModel` + a `GtkTreeModel` - Returns a newly-created `GtkTreePath` referenced by @iter. + Returns a newly-created `GtkTreePath` referenced by @iter. This path should be freed with gtk_tree_path_free(). + - a newly-created `GtkTreePath` + a newly-created `GtkTreePath` - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Initializes and sets @value to that at @column. + Initializes and sets @value to that at @column. When done with @value, g_value_unset() needs to be called to free any allocated memory. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - the column to lookup the value at + the column to lookup the value at - an empty `GValue` to set + an empty `GValue` to set - Sets @iter to point to the first child of @parent. + Sets @iter to point to the first child of @parent. If @parent has no children, %FALSE is returned and @iter is set to be invalid. @parent will remain a valid node after this @@ -90881,115 +95351,120 @@ function has been called. If @parent is %NULL returns the first node, equivalent to `gtk_tree_model_get_iter_first (tree_model, iter);` + - %TRUE, if @iter has been set to the first child + %TRUE, if @iter has been set to the first child - a `GtkTreeModel` + a `GtkTreeModel` - the new `GtkTreeIter` to be set to the child + the new `GtkTreeIter` to be set to the child - the `GtkTreeIter` + the `GtkTreeIter` - Returns %TRUE if @iter has children, %FALSE otherwise. + Returns %TRUE if @iter has children, %FALSE otherwise. + - %TRUE if @iter has children + %TRUE if @iter has children - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` to test for children + the `GtkTreeIter` to test for children - Returns the number of children that @iter has. + Returns the number of children that @iter has. As a special case, if @iter is %NULL, then the number of toplevel nodes is returned. + - the number of children of @iter + the number of children of @iter - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Sets @iter to point to the node following it at the current level. + Sets @iter to point to the node following it at the current level. If there is no next @iter, %FALSE is returned and @iter is set to be invalid. + - %TRUE if @iter has been changed to the next node + %TRUE if @iter has been changed to the next node - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Sets @iter to be the child of @parent, using the given index. + Sets @iter to be the child of @parent, using the given index. The first index is 0. If @n is too big, or @parent has no children, @iter is set to an invalid iterator and %FALSE is returned. @parent will remain a valid node after this function has been called. As a special case, if @parent is %NULL, then the @n-th root node is set. + - %TRUE, if @parent has an @n-th child + %TRUE, if @parent has an @n-th child - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` to set to the nth child + the `GtkTreeIter` to set to the nth child - the `GtkTreeIter` to get the child from + the `GtkTreeIter` to get the child from - the index of the desired child + the index of the desired child - Sets @iter to be the parent of @child. + Sets @iter to be the parent of @child. If @child is at the toplevel, and doesn’t have a parent, then @iter is set to an invalid iterator and %FALSE is returned. @@ -90998,47 +95473,49 @@ called. @iter will be initialized before the lookup is performed, so @child and @iter cannot point to the same memory location. + - %TRUE, if @iter is set to the parent of @child + %TRUE, if @iter is set to the parent of @child - a `GtkTreeModel` + a `GtkTreeModel` - the new `GtkTreeIter` to set to the parent + the new `GtkTreeIter` to set to the parent - the `GtkTreeIter` + the `GtkTreeIter` - Sets @iter to point to the previous node at the current level. + Sets @iter to point to the previous node at the current level. If there is no previous @iter, %FALSE is returned and @iter is set to be invalid. + - %TRUE if @iter has been changed to the previous node + %TRUE if @iter has been changed to the previous node - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Lets the tree ref the node. + Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -91055,44 +95532,46 @@ every current view. A model should be expected to be able to get an iter independent of its reffed state. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Emits the ::row-changed signal on @tree_model. + Emits the ::row-changed signal on @tree_model. See [signal@Gtk.TreeModel::row-changed]. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the changed row + a `GtkTreePath` pointing to the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row - Emits the ::row-deleted signal on @tree_model. + Emits the ::row-deleted signal on @tree_model. See [signal@Gtk.TreeModel::row-deleted]. @@ -91102,95 +95581,99 @@ the row previously was at. It may not be a valid location anymore. Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the previous location of + a `GtkTreePath` pointing to the previous location of the deleted row - Emits the ::row-has-child-toggled signal on @tree_model. + Emits the ::row-has-child-toggled signal on @tree_model. See [signal@Gtk.TreeModel::row-has-child-toggled]. This should be called by models after the child state of a node changes. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the changed row + a `GtkTreePath` pointing to the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row - Emits the ::row-inserted signal on @tree_model. + Emits the ::row-inserted signal on @tree_model. See [signal@Gtk.TreeModel::row-inserted]. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the inserted row + a `GtkTreePath` pointing to the inserted row - a valid `GtkTreeIter` pointing to the inserted row + a valid `GtkTreeIter` pointing to the inserted row - Emits the ::rows-reordered signal on @tree_model. + Emits the ::rows-reordered signal on @tree_model. See [signal@Gtk.TreeModel::rows-reordered]. This should be called by models when their rows have been reordered. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the tree node whose children + a `GtkTreePath` pointing to the tree node whose children have been reordered - a valid `GtkTreeIter` pointing to the node whose children + a valid `GtkTreeIter` pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position of + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -91198,7 +95681,7 @@ reordered. - Lets the tree unref the node. + Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -91206,63 +95689,66 @@ primarily for performance reasons. For more information on what this means, see gtk_tree_model_ref_node(). Please note that nodes that are deleted are not unreffed. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Creates a new `GtkTreeModel`, with @child_model as the child_model + Creates a new `GtkTreeModel`, with @child_model as the child_model and @root as the virtual root. + - A new `GtkTreeModel`. + A new `GtkTreeModel`. - A `GtkTreeModel`. + A `GtkTreeModel`. - A `GtkTreePath` + A `GtkTreePath` - Calls @func on each node in model in a depth-first fashion. + Calls @func on each node in model in a depth-first fashion. If @func returns %TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns. + - a `GtkTreeModel` + a `GtkTreeModel` - a function to be called on each row + a function to be called on each row - user data to passed to @func + user data to passed to @func - Gets the value of one or more cells in the row referenced by @iter. + Gets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by a place to store the value being @@ -91275,232 +95761,243 @@ to be filled with the string. Returned values with type %G_TYPE_OBJECT have to be unreferenced, values with type %G_TYPE_STRING or %G_TYPE_BOXED have to be freed. Other values are passed by value. + - a `GtkTreeModel` + a `GtkTreeModel` - a row in @tree_model + a row in @tree_model - pairs of column number and value return locations, + pairs of column number and value return locations, terminated by -1 - Returns the type of the column. + Returns the type of the column. + - the type of the column + the type of the column - a `GtkTreeModel` + a `GtkTreeModel` - the column index + the column index - Returns a set of flags supported by this interface. + Returns a set of flags supported by this interface. The flags are a bitwise combination of `GtkTreeModel`Flags. The flags supported should not change during the lifetime of the @tree_model. + - the flags supported by this interface + the flags supported by this interface - a `GtkTreeModel` + a `GtkTreeModel` - Sets @iter to a valid iterator pointing to @path. + Sets @iter to a valid iterator pointing to @path. If @path does not exist, @iter is set to an invalid iterator and %FALSE is returned. + - %TRUE, if @iter was set + %TRUE, if @iter was set - a `GtkTreeModel` + a `GtkTreeModel` - the uninitialized `GtkTreeIter` + the uninitialized `GtkTreeIter` - the `GtkTreePath` + the `GtkTreePath` - Initializes @iter with the first iterator in the tree + Initializes @iter with the first iterator in the tree (the one at the path "0"). Returns %FALSE if the tree is empty, %TRUE otherwise. + - %TRUE, if @iter was set + %TRUE, if @iter was set - a `GtkTreeModel` + a `GtkTreeModel` - the uninitialized `GtkTreeIter` + the uninitialized `GtkTreeIter` - Sets @iter to a valid iterator pointing to @path_string, if it + Sets @iter to a valid iterator pointing to @path_string, if it exists. Otherwise, @iter is left invalid and %FALSE is returned. + - %TRUE, if @iter was set + %TRUE, if @iter was set - a `GtkTreeModel` + a `GtkTreeModel` - an uninitialized `GtkTreeIter` + an uninitialized `GtkTreeIter` - a string representation of a `GtkTreePath` + a string representation of a `GtkTreePath` - Returns the number of columns supported by @tree_model. + Returns the number of columns supported by @tree_model. + - the number of columns + the number of columns - a `GtkTreeModel` + a `GtkTreeModel` - Returns a newly-created `GtkTreePath` referenced by @iter. + Returns a newly-created `GtkTreePath` referenced by @iter. This path should be freed with gtk_tree_path_free(). + - a newly-created `GtkTreePath` + a newly-created `GtkTreePath` - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Generates a string representation of the iter. + Generates a string representation of the iter. This string is a “:” separated list of numbers. For example, “4:10:0:3” would be an acceptable return value for this string. + - a newly-allocated string + a newly-allocated string - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreeIter` + a `GtkTreeIter` - Gets the value of one or more cells in the row referenced by @iter. + Gets the value of one or more cells in the row referenced by @iter. See [method@Gtk.TreeModel.get], this version takes a va_list for language bindings to use. + - a `GtkTreeModel` + a `GtkTreeModel` - a row in @tree_model + a row in @tree_model - va_list of column/return location pairs + va_list of column/return location pairs - Initializes and sets @value to that at @column. + Initializes and sets @value to that at @column. When done with @value, g_value_unset() needs to be called to free any allocated memory. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - the column to lookup the value at + the column to lookup the value at - an empty `GValue` to set + an empty `GValue` to set - Sets @iter to point to the first child of @parent. + Sets @iter to point to the first child of @parent. If @parent has no children, %FALSE is returned and @iter is set to be invalid. @parent will remain a valid node after this @@ -91508,115 +96005,120 @@ function has been called. If @parent is %NULL returns the first node, equivalent to `gtk_tree_model_get_iter_first (tree_model, iter);` + - %TRUE, if @iter has been set to the first child + %TRUE, if @iter has been set to the first child - a `GtkTreeModel` + a `GtkTreeModel` - the new `GtkTreeIter` to be set to the child + the new `GtkTreeIter` to be set to the child - the `GtkTreeIter` + the `GtkTreeIter` - Returns %TRUE if @iter has children, %FALSE otherwise. + Returns %TRUE if @iter has children, %FALSE otherwise. + - %TRUE if @iter has children + %TRUE if @iter has children - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` to test for children + the `GtkTreeIter` to test for children - Returns the number of children that @iter has. + Returns the number of children that @iter has. As a special case, if @iter is %NULL, then the number of toplevel nodes is returned. + - the number of children of @iter + the number of children of @iter - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Sets @iter to point to the node following it at the current level. + Sets @iter to point to the node following it at the current level. If there is no next @iter, %FALSE is returned and @iter is set to be invalid. + - %TRUE if @iter has been changed to the next node + %TRUE if @iter has been changed to the next node - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Sets @iter to be the child of @parent, using the given index. + Sets @iter to be the child of @parent, using the given index. The first index is 0. If @n is too big, or @parent has no children, @iter is set to an invalid iterator and %FALSE is returned. @parent will remain a valid node after this function has been called. As a special case, if @parent is %NULL, then the @n-th root node is set. + - %TRUE, if @parent has an @n-th child + %TRUE, if @parent has an @n-th child - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` to set to the nth child + the `GtkTreeIter` to set to the nth child - the `GtkTreeIter` to get the child from + the `GtkTreeIter` to get the child from - the index of the desired child + the index of the desired child - Sets @iter to be the parent of @child. + Sets @iter to be the parent of @child. If @child is at the toplevel, and doesn’t have a parent, then @iter is set to an invalid iterator and %FALSE is returned. @@ -91625,47 +96127,49 @@ called. @iter will be initialized before the lookup is performed, so @child and @iter cannot point to the same memory location. + - %TRUE, if @iter is set to the parent of @child + %TRUE, if @iter is set to the parent of @child - a `GtkTreeModel` + a `GtkTreeModel` - the new `GtkTreeIter` to set to the parent + the new `GtkTreeIter` to set to the parent - the `GtkTreeIter` + the `GtkTreeIter` - Sets @iter to point to the previous node at the current level. + Sets @iter to point to the previous node at the current level. If there is no previous @iter, %FALSE is returned and @iter is set to be invalid. + - %TRUE if @iter has been changed to the previous node + %TRUE if @iter has been changed to the previous node - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Lets the tree ref the node. + Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -91682,44 +96186,46 @@ every current view. A model should be expected to be able to get an iter independent of its reffed state. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - Emits the ::row-changed signal on @tree_model. + Emits the ::row-changed signal on @tree_model. See [signal@Gtk.TreeModel::row-changed]. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the changed row + a `GtkTreePath` pointing to the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row - Emits the ::row-deleted signal on @tree_model. + Emits the ::row-deleted signal on @tree_model. See [signal@Gtk.TreeModel::row-deleted]. @@ -91729,95 +96235,99 @@ the row previously was at. It may not be a valid location anymore. Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the previous location of + a `GtkTreePath` pointing to the previous location of the deleted row - Emits the ::row-has-child-toggled signal on @tree_model. + Emits the ::row-has-child-toggled signal on @tree_model. See [signal@Gtk.TreeModel::row-has-child-toggled]. This should be called by models after the child state of a node changes. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the changed row + a `GtkTreePath` pointing to the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row - Emits the ::row-inserted signal on @tree_model. + Emits the ::row-inserted signal on @tree_model. See [signal@Gtk.TreeModel::row-inserted]. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the inserted row + a `GtkTreePath` pointing to the inserted row - a valid `GtkTreeIter` pointing to the inserted row + a valid `GtkTreeIter` pointing to the inserted row - Emits the ::rows-reordered signal on @tree_model. + Emits the ::rows-reordered signal on @tree_model. See [signal@Gtk.TreeModel::rows-reordered]. This should be called by models when their rows have been reordered. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the tree node whose children + a `GtkTreePath` pointing to the tree node whose children have been reordered - a valid `GtkTreeIter` pointing to the node whose children + a valid `GtkTreeIter` pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position of + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -91825,33 +96335,34 @@ reordered. - Emits the ::rows-reordered signal on @tree_model. + Emits the ::rows-reordered signal on @tree_model. See [signal@Gtk.TreeModel::rows-reordered]. This should be called by models when their rows have been reordered. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the tree node whose children + a `GtkTreePath` pointing to the tree node whose children have been reordered - a valid `GtkTreeIter` pointing to the node + a valid `GtkTreeIter` pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -91860,13 +96371,13 @@ reordered. - length of @new_order array + length of @new_order array - Lets the tree unref the node. + Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists @@ -91874,38 +96385,39 @@ primarily for performance reasons. For more information on what this means, see gtk_tree_model_ref_node(). Please note that nodes that are deleted are not unreffed. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - This signal is emitted when a row in the model has changed. + This signal is emitted when a row in the model has changed. - a `GtkTreePath` identifying the changed row + a `GtkTreePath` identifying the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row - This signal is emitted when a row has been deleted. + This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already deleted. @@ -91918,30 +96430,30 @@ the row previously was at. It may not be a valid location anymore. - a `GtkTreePath` identifying the row + a `GtkTreePath` identifying the row - This signal is emitted when a row has gotten the first child + This signal is emitted when a row has gotten the first child row or lost its last child row. - a `GtkTreePath` identifying the row + a `GtkTreePath` identifying the row - a valid `GtkTreeIter` pointing to the row + a valid `GtkTreeIter` pointing to the row - This signal is emitted when a new row has been inserted in + This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since @@ -91952,17 +96464,17 @@ then fill it with the desired values. - a `GtkTreePath` identifying the new row + a `GtkTreePath` identifying the new row - a valid `GtkTreeIter` pointing to the new row + a valid `GtkTreeIter` pointing to the new row - This signal is emitted when the children of a node in the + This signal is emitted when the children of a node in the `GtkTreeModel` have been reordered. Note that this signal is not emitted @@ -91973,17 +96485,17 @@ by removing and then reinserting the row. - a `GtkTreePath` identifying the tree node whose children + a `GtkTreePath` identifying the tree node whose children have been reordered - a valid `GtkTreeIter` pointing to the node whose children + a valid `GtkTreeIter` pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -91992,7 +96504,7 @@ by removing and then reinserting the row. - A `GtkTreeModel` which hides parts of an underlying tree model + A `GtkTreeModel` which hides parts of an underlying tree model A `GtkTreeModelFilter` is a tree model which wraps another tree model, and can do the following things: @@ -92059,9 +96571,11 @@ own. In this case, either rely on `GtkTreeStore` to emit all signals because it does not implement reference counting, or for models that do implement reference counting, obtain references on these child levels yourself. + + @@ -92084,6 +96598,7 @@ yourself. + @@ -92100,135 +96615,142 @@ yourself. - This function should almost never be called. It clears the @filter + This function should almost never be called. It clears the @filter of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being filtered is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid. + - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - Sets @filter_iter to point to the row in @filter that corresponds to the + Sets @filter_iter to point to the row in @filter that corresponds to the row pointed at by @child_iter. If @filter_iter was not set, %FALSE is returned. + - %TRUE, if @filter_iter was set, i.e. if @child_iter is a + %TRUE, if @filter_iter was set, i.e. if @child_iter is a valid iterator pointing to a visible row in child model. - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - An uninitialized `GtkTreeIter` + An uninitialized `GtkTreeIter` - A valid `GtkTreeIter` pointing to a row on the child model. + A valid `GtkTreeIter` pointing to a row on the child model. - Converts @child_path to a path relative to @filter. That is, @child_path + Converts @child_path to a path relative to @filter. That is, @child_path points to a path in the child model. The rerturned path will point to the same row in the filtered model. If @child_path isn’t a valid path on the child model or points to a row which is not visible in @filter, then %NULL is returned. + - A newly allocated `GtkTreePath` + A newly allocated `GtkTreePath` - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - A `GtkTreePath` to convert. + A `GtkTreePath` to convert. - Sets @child_iter to point to the row pointed to by @filter_iter. + Sets @child_iter to point to the row pointed to by @filter_iter. + - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - An uninitialized `GtkTreeIter` + An uninitialized `GtkTreeIter` - A valid `GtkTreeIter` pointing to a row on @filter. + A valid `GtkTreeIter` pointing to a row on @filter. - Converts @filter_path to a path on the child model of @filter. That is, + Converts @filter_path to a path on the child model of @filter. That is, @filter_path points to a location in @filter. The returned path will point to the same location in the model not being filtered. If @filter_path does not point to a location in the child model, %NULL is returned. + - A newly allocated `GtkTreePath` + A newly allocated `GtkTreePath` - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - A `GtkTreePath` to convert. + A `GtkTreePath` to convert. - Returns a pointer to the child model of @filter. + Returns a pointer to the child model of @filter. + - A pointer to a `GtkTreeModel` + A pointer to a `GtkTreeModel` - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - Emits ::row_changed for each row in the child model, which causes + Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not. + - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - With the @n_columns and @types parameters, you give an array of column + With the @n_columns and @types parameters, you give an array of column types for this model (which will be exposed to the parent model/view). The @func, @data and @destroy parameters are for specifying the modify function. The modify function will get called for each @@ -92238,40 +96760,41 @@ modify function. Note that gtk_tree_model_filter_set_modify_func() can only be called once for a given filter model. + - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - The number of columns in the filter model. + The number of columns in the filter model. - The `GType`s of the columns. + The `GType`s of the columns. - A `GtkTreeModelFilterModifyFunc` + A `GtkTreeModelFilterModifyFunc` - User data to pass to the modify function + User data to pass to the modify function - Destroy notifier of @data + Destroy notifier of @data - Sets @column of the child_model to be the column where @filter should + Sets @column of the child_model to be the column where @filter should look for visibility information. @columns should be a column of type %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE if not. @@ -92279,22 +96802,23 @@ if not. Note that gtk_tree_model_filter_set_visible_func() or gtk_tree_model_filter_set_visible_column() can only be called once for a given filter model. + - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - A `int` which is the column containing the visible information + A `int` which is the column containing the visible information - Sets the visible function used when filtering the @filter to be @func. + Sets the visible function used when filtering the @filter to be @func. The function should return %TRUE if the given row should be visible and %FALSE otherwise. @@ -92329,24 +96853,25 @@ visible_func (GtkTreeModel *model, Note that gtk_tree_model_filter_set_visible_func() or gtk_tree_model_filter_set_visible_column() can only be called once for a given filter model. + - A `GtkTreeModelFilter` + A `GtkTreeModelFilter` - A `GtkTreeModelFilterVisibleFunc`, the visible function + A `GtkTreeModelFilterVisibleFunc`, the visible function - User data to pass to the visible function + User data to pass to the visible function - Destroy notifier of @data + Destroy notifier of @data @@ -92365,11 +96890,13 @@ once for a given filter model. + + @@ -92388,6 +96915,7 @@ once for a given filter model. + @@ -92417,124 +96945,131 @@ once for a given filter model. - A function which calculates display values from raw values in the model. + A function which calculates display values from raw values in the model. It must fill @value with the display value for the column @column in the row indicated by @iter. Since this function is called for each data access, it’s not a particularly efficient operation. + - the `GtkTreeModelFilter` + the `GtkTreeModelFilter` - a `GtkTreeIter` pointing to the row whose display values are determined + a `GtkTreeIter` pointing to the row whose display values are determined - A `GValue` which is already initialized for + A `GValue` which is already initialized for with the correct type for the column @column. - the column whose display value is determined + the column whose display value is determined - user data given to gtk_tree_model_filter_set_modify_func() + user data given to gtk_tree_model_filter_set_modify_func() - + + + - A function which decides whether the row indicated by @iter is visible. + A function which decides whether the row indicated by @iter is visible. + - Whether the row indicated by @iter is visible. + Whether the row indicated by @iter is visible. - the child model of the `GtkTreeModelFilter` + the child model of the `GtkTreeModelFilter` - a `GtkTreeIter` pointing to the row in @model whose visibility + a `GtkTreeIter` pointing to the row in @model whose visibility is determined - user data given to gtk_tree_model_filter_set_visible_func() + user data given to gtk_tree_model_filter_set_visible_func() - These flags indicate various properties of a `GtkTreeModel`. + These flags indicate various properties of a `GtkTreeModel`. They are returned by [method@Gtk.TreeModel.get_flags], and must be static for the lifetime of the object. A more complete description of %GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of this section. - iterators survive all signals + iterators survive all signals emitted by the tree - the model is a list only, and never + the model is a list only, and never has children - Type of the callback passed to gtk_tree_model_foreach() to + Type of the callback passed to gtk_tree_model_foreach() to iterate over the rows in a tree model. + - %TRUE to stop iterating, %FALSE to continue + %TRUE to stop iterating, %FALSE to continue - the `GtkTreeModel` being iterated + the `GtkTreeModel` being iterated - the current `GtkTreePath` + the current `GtkTreePath` - the current `GtkTreeIter` + the current `GtkTreeIter` - The user data passed to gtk_tree_model_foreach() + The user data passed to gtk_tree_model_foreach() + + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the changed row + a `GtkTreePath` pointing to the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row @@ -92542,20 +97077,21 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the inserted row + a `GtkTreePath` pointing to the inserted row - a valid `GtkTreeIter` pointing to the inserted row + a valid `GtkTreeIter` pointing to the inserted row @@ -92563,20 +97099,21 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the changed row + a `GtkTreePath` pointing to the changed row - a valid `GtkTreeIter` pointing to the changed row + a valid `GtkTreeIter` pointing to the changed row @@ -92584,16 +97121,17 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the previous location of + a `GtkTreePath` pointing to the previous location of the deleted row @@ -92602,26 +97140,27 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - a `GtkTreePath` pointing to the tree node whose children + a `GtkTreePath` pointing to the tree node whose children have been reordered - a valid `GtkTreeIter` pointing to the node whose children + a valid `GtkTreeIter` pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0 - an array of integers mapping the current position of + an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos` @@ -92631,13 +97170,14 @@ iterate over the rows in a tree model. + - the flags supported by this interface + the flags supported by this interface - a `GtkTreeModel` + a `GtkTreeModel` @@ -92645,13 +97185,14 @@ iterate over the rows in a tree model. + - the number of columns + the number of columns - a `GtkTreeModel` + a `GtkTreeModel` @@ -92659,17 +97200,18 @@ iterate over the rows in a tree model. + - the type of the column + the type of the column - a `GtkTreeModel` + a `GtkTreeModel` - the column index + the column index @@ -92677,21 +97219,22 @@ iterate over the rows in a tree model. + - %TRUE, if @iter was set + %TRUE, if @iter was set - a `GtkTreeModel` + a `GtkTreeModel` - the uninitialized `GtkTreeIter` + the uninitialized `GtkTreeIter` - the `GtkTreePath` + the `GtkTreePath` @@ -92699,17 +97242,18 @@ iterate over the rows in a tree model. + - a newly-created `GtkTreePath` + a newly-created `GtkTreePath` - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` @@ -92717,24 +97261,25 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` - the column to lookup the value at + the column to lookup the value at - an empty `GValue` to set + an empty `GValue` to set @@ -92742,17 +97287,18 @@ iterate over the rows in a tree model. + - %TRUE if @iter has been changed to the next node + %TRUE if @iter has been changed to the next node - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` @@ -92760,17 +97306,18 @@ iterate over the rows in a tree model. + - %TRUE if @iter has been changed to the previous node + %TRUE if @iter has been changed to the previous node - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` @@ -92778,21 +97325,22 @@ iterate over the rows in a tree model. + - %TRUE, if @iter has been set to the first child + %TRUE, if @iter has been set to the first child - a `GtkTreeModel` + a `GtkTreeModel` - the new `GtkTreeIter` to be set to the child + the new `GtkTreeIter` to be set to the child - the `GtkTreeIter` + the `GtkTreeIter` @@ -92800,17 +97348,18 @@ iterate over the rows in a tree model. + - %TRUE if @iter has children + %TRUE if @iter has children - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` to test for children + the `GtkTreeIter` to test for children @@ -92818,17 +97367,18 @@ iterate over the rows in a tree model. + - the number of children of @iter + the number of children of @iter - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` @@ -92836,25 +97386,26 @@ iterate over the rows in a tree model. + - %TRUE, if @parent has an @n-th child + %TRUE, if @parent has an @n-th child - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` to set to the nth child + the `GtkTreeIter` to set to the nth child - the `GtkTreeIter` to get the child from + the `GtkTreeIter` to get the child from - the index of the desired child + the index of the desired child @@ -92862,21 +97413,22 @@ iterate over the rows in a tree model. + - %TRUE, if @iter is set to the parent of @child + %TRUE, if @iter is set to the parent of @child - a `GtkTreeModel` + a `GtkTreeModel` - the new `GtkTreeIter` to set to the parent + the new `GtkTreeIter` to set to the parent - the `GtkTreeIter` + the `GtkTreeIter` @@ -92884,16 +97436,17 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` @@ -92901,16 +97454,17 @@ iterate over the rows in a tree model. + - a `GtkTreeModel` + a `GtkTreeModel` - the `GtkTreeIter` + the `GtkTreeIter` @@ -92918,7 +97472,7 @@ iterate over the rows in a tree model. - A GtkTreeModel which makes an underlying tree model sortable + A GtkTreeModel which makes an underlying tree model sortable The `GtkTreeModelSort` is a model which implements the `GtkTreeSortable` interface. It does not hold any data itself, but rather is created with @@ -93014,168 +97568,178 @@ selection_changed (GtkTreeSelection *selection, gpointer data) g_free (modified_data); } ]| + - Creates a new `GtkTreeModelSort`, with @child_model as the child model. + Creates a new `GtkTreeModelSort`, with @child_model as the child model. + - A new `GtkTreeModelSort`. + A new `GtkTreeModelSort`. - A `GtkTreeModel` + A `GtkTreeModel` - This function should almost never be called. It clears the @tree_model_sort + This function should almost never be called. It clears the @tree_model_sort of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being sorted is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid. + - A `GtkTreeModelSort` + A `GtkTreeModelSort` - Sets @sort_iter to point to the row in @tree_model_sort that corresponds to + Sets @sort_iter to point to the row in @tree_model_sort that corresponds to the row pointed at by @child_iter. If @sort_iter was not set, %FALSE is returned. Note: a boolean is only returned since 2.14. + - %TRUE, if @sort_iter was set, i.e. if @sort_iter is a + %TRUE, if @sort_iter was set, i.e. if @sort_iter is a valid iterator pointer to a visible row in the child model. - A `GtkTreeModelSort` + A `GtkTreeModelSort` - An uninitialized `GtkTreeIter` + An uninitialized `GtkTreeIter` - A valid `GtkTreeIter` pointing to a row on the child model + A valid `GtkTreeIter` pointing to a row on the child model - Converts @child_path to a path relative to @tree_model_sort. That is, + Converts @child_path to a path relative to @tree_model_sort. That is, @child_path points to a path in the child model. The returned path will point to the same row in the sorted model. If @child_path isn’t a valid path on the child model, then %NULL is returned. + - A newly allocated `GtkTreePath` + A newly allocated `GtkTreePath` - A `GtkTreeModelSort` + A `GtkTreeModelSort` - A `GtkTreePath` to convert + A `GtkTreePath` to convert - Sets @child_iter to point to the row pointed to by @sorted_iter. + Sets @child_iter to point to the row pointed to by @sorted_iter. + - A `GtkTreeModelSort` + A `GtkTreeModelSort` - An uninitialized `GtkTreeIter` + An uninitialized `GtkTreeIter` - A valid `GtkTreeIter` pointing to a row on @tree_model_sort. + A valid `GtkTreeIter` pointing to a row on @tree_model_sort. - Converts @sorted_path to a path on the child model of @tree_model_sort. + Converts @sorted_path to a path on the child model of @tree_model_sort. That is, @sorted_path points to a location in @tree_model_sort. The returned path will point to the same location in the model not being sorted. If @sorted_path does not point to a location in the child model, %NULL is returned. + - A newly allocated `GtkTreePath` + A newly allocated `GtkTreePath` - A `GtkTreeModelSort` + A `GtkTreeModelSort` - A `GtkTreePath` to convert + A `GtkTreePath` to convert - Returns the model the `GtkTreeModelSort` is sorting. + Returns the model the `GtkTreeModelSort` is sorting. + - the "child model" being sorted + the "child model" being sorted - a `GtkTreeModelSort` + a `GtkTreeModelSort` - > This function is slow. Only use it for debugging and/or testing + > This function is slow. Only use it for debugging and/or testing > purposes. Checks if the given iter is a valid iter for this `GtkTreeModelSort`. + - %TRUE if the iter is valid, %FALSE if the iter is invalid. + %TRUE if the iter is valid, %FALSE if the iter is invalid. - A `GtkTreeModelSort`. + A `GtkTreeModelSort`. - A `GtkTreeIter` + A `GtkTreeIter` - This resets the default sort function to be in the “unsorted” state. That + This resets the default sort function to be in the “unsorted” state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if the `GtkTreeModelSort` is in “unsorted” state. + - A `GtkTreeModelSort` + A `GtkTreeModelSort` @@ -93191,6 +97755,7 @@ is in “unsorted” state. + @@ -93200,196 +97765,212 @@ is in “unsorted” state. - + + + - An opaque structure representing a path to a row in a model. + An opaque structure representing a path to a row in a model. + - Creates a new `GtkTreePath` + Creates a new `GtkTreePath` This refers to a row. + - A newly created `GtkTreePath`. + A newly created `GtkTreePath`. - Creates a new `GtkTreePath`. + Creates a new `GtkTreePath`. The string representation of this path is “0”. + - A new `GtkTreePath` + A new `GtkTreePath` - Creates a new path with @first_index and @varargs as indices. + Creates a new path with @first_index and @varargs as indices. + - A newly created `GtkTreePath` + A newly created `GtkTreePath` - first integer + first integer - list of integers terminated by -1 + list of integers terminated by -1 - Creates a new path with the given @indices array of @length. + Creates a new path with the given @indices array of @length. + - A newly created `GtkTreePath` + A newly created `GtkTreePath` - array of indices + array of indices - length of @indices array + length of @indices array - Creates a new `GtkTreePath` initialized to @path. + Creates a new `GtkTreePath` initialized to @path. @path is expected to be a colon separated list of numbers. For example, the string “10:4:0” would create a path of depth 3 pointing to the 11th child of the root node, the 5th child of that 11th child, and the 1st child of that 5th child. If an invalid path string is passed in, %NULL is returned. + - A newly-created `GtkTreePath` + A newly-created `GtkTreePath` - The string representation of a path + The string representation of a path - Appends a new index to a path. + Appends a new index to a path. As a result, the depth of the path is increased. + - a `GtkTreePath` + a `GtkTreePath` - the index + the index - Compares two paths. + Compares two paths. If @a appears before @b in a tree, then -1 is returned. If @b appears before @a, then 1 is returned. If the two nodes are equal, then 0 is returned. + - the relative positions of @a and @b + the relative positions of @a and @b - a `GtkTreePath` + a `GtkTreePath` - a `GtkTreePath` to compare with + a `GtkTreePath` to compare with - Creates a new `GtkTreePath` as a copy of @path. + Creates a new `GtkTreePath` as a copy of @path. + - a new `GtkTreePath` + a new `GtkTreePath` - a `GtkTreePath` + a `GtkTreePath` - Moves @path to point to the first child of the current path. + Moves @path to point to the first child of the current path. + - a `GtkTreePath` + a `GtkTreePath` - Frees @path. If @path is %NULL, it simply returns. + Frees @path. If @path is %NULL, it simply returns. + - a `GtkTreePath` + a `GtkTreePath` - Returns the current depth of @path. + Returns the current depth of @path. + - The depth of @path + The depth of @path - a `GtkTreePath` + a `GtkTreePath` - Returns the current indices of @path. + Returns the current indices of @path. This is an array of integers, each representing a node in a tree. This value should not be freed. The length of the array can be obtained with gtk_tree_path_get_depth(). + - The current indices + The current indices - a `GtkTreePath` + a `GtkTreePath` - Returns the current indices of @path. + Returns the current indices of @path. This is an array of integers, each representing a node in a tree. It also returns the number of elements in the array. The array should not be freed. + - The current + The current indices @@ -93397,122 +97978,129 @@ The array should not be freed. - a `GtkTreePath` + a `GtkTreePath` - return location for number of elements + return location for number of elements returned in the integer array - Returns %TRUE if @descendant is a descendant of @path. + Returns %TRUE if @descendant is a descendant of @path. + - %TRUE if @descendant is contained inside @path + %TRUE if @descendant is contained inside @path - a `GtkTreePath` + a `GtkTreePath` - another `GtkTreePath` + another `GtkTreePath` - Returns %TRUE if @path is a descendant of @ancestor. + Returns %TRUE if @path is a descendant of @ancestor. + - %TRUE if @ancestor contains @path somewhere below it + %TRUE if @ancestor contains @path somewhere below it - a `GtkTreePath` + a `GtkTreePath` - another `GtkTreePath` + another `GtkTreePath` - Moves the @path to point to the next node at the current depth. + Moves the @path to point to the next node at the current depth. + - a `GtkTreePath` + a `GtkTreePath` - Prepends a new index to a path. + Prepends a new index to a path. As a result, the depth of the path is increased. + - a `GtkTreePath` + a `GtkTreePath` - the index + the index - Moves the @path to point to the previous node at the + Moves the @path to point to the previous node at the current depth, if it exists. + - %TRUE if @path has a previous node, and + %TRUE if @path has a previous node, and the move was made - a `GtkTreePath` + a `GtkTreePath` - Generates a string representation of the path. + Generates a string representation of the path. This string is a “:” separated list of numbers. For example, “4:10:0:3” would be an acceptable return value for this string. If the path has depth 0, %NULL is returned. + - A newly-allocated string + A newly-allocated string - a `GtkTreePath` + a `GtkTreePath` - Moves the @path to point to its parent node, if it has a parent. + Moves the @path to point to its parent node, if it has a parent. + - %TRUE if @path has a parent, and the move was made + %TRUE if @path has a parent, and the move was made - a `GtkTreePath` + a `GtkTreePath` @@ -93521,33 +98109,35 @@ depth 0, %NULL is returned. - A GtkTreeRowReference tracks model changes so that it always refers to the + A GtkTreeRowReference tracks model changes so that it always refers to the same row (a `GtkTreePath` refers to a position, not a fixed row). Create a new GtkTreeRowReference with gtk_tree_row_reference_new(). + - Creates a row reference based on @path. + Creates a row reference based on @path. This reference will keep pointing to the node pointed to by @path, so long as it exists. Any changes that occur on @model are propagated, and the path is updated appropriately. If @path isn’t a valid path in @model, then %NULL is returned. + - a newly allocated `GtkTreeRowReference` + a newly allocated `GtkTreeRowReference` - a `GtkTreeModel` + a `GtkTreeModel` - a valid `GtkTreePath` to monitor + a valid `GtkTreePath` to monitor - You do not need to use this function. + You do not need to use this function. Creates a row reference based on @path. @@ -93571,149 +98161,158 @@ doesn’t work for reasons of internal implementation. This type of row reference is primarily meant by structures that need to carefully monitor exactly when a row reference updates itself, and is not generally needed by most applications. + - a newly allocated `GtkTreeRowReference` + a newly allocated `GtkTreeRowReference` - a proxy `GObject` + a proxy `GObject` - a `GtkTreeModel` + a `GtkTreeModel` - a valid `GtkTreePath` to monitor + a valid `GtkTreePath` to monitor - Copies a `GtkTreeRowReference`. + Copies a `GtkTreeRowReference`. + - a copy of @reference + a copy of @reference - a `GtkTreeRowReference` + a `GtkTreeRowReference` - Free’s @reference. @reference may be %NULL + Free’s @reference. @reference may be %NULL + - a `GtkTreeRowReference` + a `GtkTreeRowReference` - Returns the model that the row reference is monitoring. + Returns the model that the row reference is monitoring. + - the model + the model - a `GtkTreeRowReference` + a `GtkTreeRowReference` - Returns a path that the row reference currently points to, + Returns a path that the row reference currently points to, or %NULL if the path pointed to is no longer valid. + - a current path + a current path - a `GtkTreeRowReference` + a `GtkTreeRowReference` - Returns %TRUE if the @reference is non-%NULL and refers to + Returns %TRUE if the @reference is non-%NULL and refers to a current valid path. + - %TRUE if @reference points to a valid path + %TRUE if @reference points to a valid path - a `GtkTreeRowReference` + a `GtkTreeRowReference` - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::row-deleted signal. + - a `GObject` + a `GObject` - the path position that was deleted + the path position that was deleted - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::row-inserted signal. + - a `GObject` + a `GObject` - the row position that was inserted + the row position that was inserted - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::rows-reordered signal. + - a `GObject` + a `GObject` - the parent path of the reordered signal + the parent path of the reordered signal - the iter pointing to the parent of the reordered + the iter pointing to the parent of the reordered - the new order of rows + the new order of rows @@ -93722,7 +98321,7 @@ model emitted the ::rows-reordered signal. - The selection object for GtkTreeView + The selection object for GtkTreeView The `GtkTreeSelection` object is a helper object to manage the selection for a `GtkTreeView` widget. The `GtkTreeSelection` object is @@ -93748,72 +98347,76 @@ Additionally, it may on occasion emit a `GtkTreeSelection`::changed signal when nothing has happened (mostly as a result of programmers calling select_row on an already selected row). - Returns the number of rows that have been selected in @tree. + Returns the number of rows that have been selected in @tree. + - The number of rows selected. + The number of rows selected. - A `GtkTreeSelection`. + A `GtkTreeSelection`. - Gets the selection mode for @selection. See + Gets the selection mode for @selection. See gtk_tree_selection_set_mode(). + - the current selection mode + the current selection mode - a `GtkTreeSelection` + a `GtkTreeSelection` - Returns the current selection function. + Returns the current selection function. + - The function. + The function. - A `GtkTreeSelection`. + A `GtkTreeSelection`. - Sets @iter to the currently selected node if @selection is set to + Sets @iter to the currently selected node if @selection is set to %GTK_SELECTION_SINGLE or %GTK_SELECTION_BROWSE. @iter may be NULL if you just want to test if @selection has any selected nodes. @model is filled with the current model as a convenience. This function will not work if you use @selection is %GTK_SELECTION_MULTIPLE. + - TRUE, if there is a selected node. + TRUE, if there is a selected node. - A `GtkTreeSelection`. + A `GtkTreeSelection`. - A pointer to set to the `GtkTreeModel` + A pointer to set to the `GtkTreeModel` - The `GtkTreeIter` + The `GtkTreeIter` - Creates a list of path of all selected rows. Additionally, if you are + Creates a list of path of all selected rows. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of `GtkTreeRowReference`s. To do this, you can use gtk_tree_row_reference_new(). @@ -93822,291 +98425,307 @@ To free the return value, use: |[<!-- language="C" --> g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); ]| + - A `GList` containing a `GtkTreePath` for each selected row. + A `GList` containing a `GtkTreePath` for each selected row. - A `GtkTreeSelection`. + A `GtkTreeSelection`. - A pointer to set to the `GtkTreeModel` + A pointer to set to the `GtkTreeModel` - Returns the tree view associated with @selection. + Returns the tree view associated with @selection. + - A `GtkTreeView` + A `GtkTreeView` - A `GtkTreeSelection` + A `GtkTreeSelection` - Returns the user data for the selection function. + Returns the user data for the selection function. + - The user data. + The user data. - A `GtkTreeSelection`. + A `GtkTreeSelection`. - Returns %TRUE if the row at @iter is currently selected. + Returns %TRUE if the row at @iter is currently selected. + - %TRUE, if @iter is selected + %TRUE, if @iter is selected - A `GtkTreeSelection` + A `GtkTreeSelection` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Returns %TRUE if the row pointed to by @path is currently selected. If @path + Returns %TRUE if the row pointed to by @path is currently selected. If @path does not point to a valid location, %FALSE is returned + - %TRUE if @path is selected. + %TRUE if @path is selected. - A `GtkTreeSelection`. + A `GtkTreeSelection`. - A `GtkTreePath` to check selection on. + A `GtkTreePath` to check selection on. - Selects all the nodes. @selection must be set to %GTK_SELECTION_MULTIPLE + Selects all the nodes. @selection must be set to %GTK_SELECTION_MULTIPLE mode. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - Selects the specified iterator. + Selects the specified iterator. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The `GtkTreeIter` to be selected. + The `GtkTreeIter` to be selected. - Select the row at @path. + Select the row at @path. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The `GtkTreePath` to be selected. + The `GtkTreePath` to be selected. - Selects a range of nodes, determined by @start_path and @end_path inclusive. + Selects a range of nodes, determined by @start_path and @end_path inclusive. @selection must be set to %GTK_SELECTION_MULTIPLE mode. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The initial node of the range. + The initial node of the range. - The final node of the range. + The final node of the range. - Calls a function for each selected node. Note that you cannot modify + Calls a function for each selected node. Note that you cannot modify the tree or selection from within this function. As a result, gtk_tree_selection_get_selected_rows() might be more useful. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The function to call for each selected node. + The function to call for each selected node. - user data to pass to the function. + user data to pass to the function. - Sets the selection mode of the @selection. If the previous type was + Sets the selection mode of the @selection. If the previous type was %GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was previously selected. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The selection mode + The selection mode - Sets the selection function. + Sets the selection function. If set, this function is called before any node is selected or unselected, giving some control over which nodes are selected. The select function should return %TRUE if the state of the node may be toggled, and %FALSE if the state of the node should be left unchanged. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The selection function. May be %NULL + The selection function. May be %NULL - The selection function’s data. May be %NULL + The selection function’s data. May be %NULL - The destroy function for user data. May be %NULL + The destroy function for user data. May be %NULL - Unselects all the nodes. + Unselects all the nodes. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - Unselects the specified iterator. + Unselects the specified iterator. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The `GtkTreeIter` to be unselected. + The `GtkTreeIter` to be unselected. - Unselects the row at @path. + Unselects the row at @path. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The `GtkTreePath` to be unselected. + The `GtkTreePath` to be unselected. - Unselects a range of nodes, determined by @start_path and @end_path + Unselects a range of nodes, determined by @start_path and @end_path inclusive. + - A `GtkTreeSelection`. + A `GtkTreeSelection`. - The initial node of the range. + The initial node of the range. - The initial node of the range. + The initial node of the range. - Selection mode. + Selection mode. See gtk_tree_selection_set_mode() for more information on this property. - Emitted whenever the selection has (possibly) changed. Please note that + Emitted whenever the selection has (possibly) changed. Please note that this signal is mostly a hint. It may only be emitted once when a range of rows are selected, and it may occasionally be emitted when nothing has happened. @@ -94116,113 +98735,118 @@ has happened. - A function used by gtk_tree_selection_selected_foreach() to map all + A function used by gtk_tree_selection_selected_foreach() to map all selected rows. It will be called on every selected row in the view. + - The `GtkTreeModel` being viewed + The `GtkTreeModel` being viewed - The `GtkTreePath` of a selected row + The `GtkTreePath` of a selected row - A `GtkTreeIter` pointing to a selected row + A `GtkTreeIter` pointing to a selected row - user data + user data - A function used by gtk_tree_selection_set_select_function() to filter + A function used by gtk_tree_selection_set_select_function() to filter whether or not a row may be selected. It is called whenever a row's state might change. A return value of %TRUE indicates to @selection that it is okay to change the selection. + - %TRUE, if the selection state of the row can be toggled + %TRUE, if the selection state of the row can be toggled - A `GtkTreeSelection` + A `GtkTreeSelection` - A `GtkTreeModel` being viewed + A `GtkTreeModel` being viewed - The `GtkTreePath` of the row in question + The `GtkTreePath` of the row in question - %TRUE, if the path is currently selected + %TRUE, if the path is currently selected - user data + user data - The interface for sortable models used by GtkTreeView + The interface for sortable models used by GtkTreeView `GtkTreeSortable` is an interface to be implemented by tree models which support sorting. The `GtkTreeView` uses the methods provided by this interface to sort the model. + - Fills in @sort_column_id and @order with the current sort column and the + Fills in @sort_column_id and @order with the current sort column and the order. It returns %TRUE unless the @sort_column_id is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. + - %TRUE if the sort column is not one of the special sort + %TRUE if the sort column is not one of the special sort column ids. - A `GtkTreeSortable` + A `GtkTreeSortable` - The sort column id to be filled in + The sort column id to be filled in - The `GtkSortType` to be filled in + The `GtkSortType` to be filled in - Returns %TRUE if the model has a default sort function. This is used + Returns %TRUE if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not. + - %TRUE, if the model has a default sort function + %TRUE, if the model has a default sort function - A `GtkTreeSortable` + A `GtkTreeSortable` - Sets the default comparison function used when sorting to be @sort_func. + Sets the default comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. @@ -94231,30 +98855,31 @@ If @sort_func is %NULL, then there will be no default comparison function. This means that once the model has been sorted, it can’t go back to the default state. In this case, when the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. + - A `GtkTreeSortable` + A `GtkTreeSortable` - The comparison function + The comparison function - User data to pass to @sort_func + User data to pass to @sort_func - Destroy notifier of @user_data + Destroy notifier of @user_data - Sets the current sort column to be @sort_column_id. The @sortable will + Sets the current sort column to be @sort_column_id. The @sortable will resort itself to reflect this change, after emitting a `GtkTreeSortable::sort-column-changed` signal. @sort_column_id may either be a regular column id, or one of the following special values: @@ -94263,108 +98888,113 @@ a regular column id, or one of the following special values: will be used, if it is set - %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur + - A `GtkTreeSortable` + A `GtkTreeSortable` - the sort column id to set + the sort column id to set - The sort order of the column + The sort order of the column - Sets the comparison function used when sorting to be @sort_func. If the + Sets the comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is the same as @sort_column_id, then the model will sort using this function. + - A `GtkTreeSortable` + A `GtkTreeSortable` - the sort column id to set the function for + the sort column id to set the function for - The comparison function + The comparison function - User data to pass to @sort_func + User data to pass to @sort_func - Destroy notifier of @user_data + Destroy notifier of @user_data - Emits a `GtkTreeSortable::sort-column-changed` signal on @sortable. + Emits a `GtkTreeSortable::sort-column-changed` signal on @sortable. + - A `GtkTreeSortable` + A `GtkTreeSortable` - Fills in @sort_column_id and @order with the current sort column and the + Fills in @sort_column_id and @order with the current sort column and the order. It returns %TRUE unless the @sort_column_id is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. + - %TRUE if the sort column is not one of the special sort + %TRUE if the sort column is not one of the special sort column ids. - A `GtkTreeSortable` + A `GtkTreeSortable` - The sort column id to be filled in + The sort column id to be filled in - The `GtkSortType` to be filled in + The `GtkSortType` to be filled in - Returns %TRUE if the model has a default sort function. This is used + Returns %TRUE if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not. + - %TRUE, if the model has a default sort function + %TRUE, if the model has a default sort function - A `GtkTreeSortable` + A `GtkTreeSortable` - Sets the default comparison function used when sorting to be @sort_func. + Sets the default comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. @@ -94373,30 +99003,31 @@ If @sort_func is %NULL, then there will be no default comparison function. This means that once the model has been sorted, it can’t go back to the default state. In this case, when the current sort column id of @sortable is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. + - A `GtkTreeSortable` + A `GtkTreeSortable` - The comparison function + The comparison function - User data to pass to @sort_func + User data to pass to @sort_func - Destroy notifier of @user_data + Destroy notifier of @user_data - Sets the current sort column to be @sort_column_id. The @sortable will + Sets the current sort column to be @sort_column_id. The @sortable will resort itself to reflect this change, after emitting a `GtkTreeSortable::sort-column-changed` signal. @sort_column_id may either be a regular column id, or one of the following special values: @@ -94405,68 +99036,71 @@ a regular column id, or one of the following special values: will be used, if it is set - %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur + - A `GtkTreeSortable` + A `GtkTreeSortable` - the sort column id to set + the sort column id to set - The sort order of the column + The sort order of the column - Sets the comparison function used when sorting to be @sort_func. If the + Sets the comparison function used when sorting to be @sort_func. If the current sort column id of @sortable is the same as @sort_column_id, then the model will sort using this function. + - A `GtkTreeSortable` + A `GtkTreeSortable` - the sort column id to set the function for + the sort column id to set the function for - The comparison function + The comparison function - User data to pass to @sort_func + User data to pass to @sort_func - Destroy notifier of @user_data + Destroy notifier of @user_data - Emits a `GtkTreeSortable::sort-column-changed` signal on @sortable. + Emits a `GtkTreeSortable::sort-column-changed` signal on @sortable. + - A `GtkTreeSortable` + A `GtkTreeSortable` - The ::sort-column-changed signal is emitted when the sort column + The ::sort-column-changed signal is emitted when the sort column or sort order of @sortable is changed. The signal is emitted before the contents of @sortable are resorted. @@ -94475,17 +99109,19 @@ the contents of @sortable are resorted. + + - A `GtkTreeSortable` + A `GtkTreeSortable` @@ -94493,22 +99129,23 @@ the contents of @sortable are resorted. + - %TRUE if the sort column is not one of the special sort + %TRUE if the sort column is not one of the special sort column ids. - A `GtkTreeSortable` + A `GtkTreeSortable` - The sort column id to be filled in + The sort column id to be filled in - The `GtkSortType` to be filled in + The `GtkSortType` to be filled in @@ -94516,20 +99153,21 @@ the contents of @sortable are resorted. + - A `GtkTreeSortable` + A `GtkTreeSortable` - the sort column id to set + the sort column id to set - The sort order of the column + The sort order of the column @@ -94537,28 +99175,29 @@ the contents of @sortable are resorted. + - A `GtkTreeSortable` + A `GtkTreeSortable` - the sort column id to set the function for + the sort column id to set the function for - The comparison function + The comparison function - User data to pass to @sort_func + User data to pass to @sort_func - Destroy notifier of @user_data + Destroy notifier of @user_data @@ -94566,24 +99205,25 @@ the contents of @sortable are resorted. + - A `GtkTreeSortable` + A `GtkTreeSortable` - The comparison function + The comparison function - User data to pass to @sort_func + User data to pass to @sort_func - Destroy notifier of @user_data + Destroy notifier of @user_data @@ -94591,13 +99231,14 @@ the contents of @sortable are resorted. + - %TRUE, if the model has a default sort function + %TRUE, if the model has a default sort function - A `GtkTreeSortable` + A `GtkTreeSortable` @@ -94605,7 +99246,7 @@ the contents of @sortable are resorted. - A tree-like data structure that can be used with the GtkTreeView + A tree-like data structure that can be used with the GtkTreeView The `GtkTreeStore` object is a list model for use with a `GtkTreeView` widget. It implements the `GtkTreeModel` interface, and consequently, @@ -94632,13 +99273,14 @@ An example of a UI Definition fragment for a tree store: </columns> </object> ]| + - Creates a new tree store as with @n_columns columns each of the types passed + Creates a new tree store as with @n_columns columns each of the types passed in. Note that only types derived from standard GObject fundamental types are supported. @@ -94650,34 +99292,36 @@ gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING, GDK_TYPE_TEXTURE); will create a new `GtkTreeStore` with three columns, of type `int`, `gchararray`, and `GdkTexture` respectively. + - a new `GtkTreeStore` + a new `GtkTreeStore` - number of columns in the tree store + number of columns in the tree store - all `GType` types for the columns, from first to last + all `GType` types for the columns, from first to last - Non vararg creation function. Used primarily by language bindings. + Non vararg creation function. Used primarily by language bindings. + - a new `GtkTreeStore` + a new `GtkTreeStore` - number of columns in the tree store + number of columns in the tree store - an array of `GType` types for the columns, from first to last + an array of `GType` types for the columns, from first to last @@ -94685,73 +99329,76 @@ will create a new `GtkTreeStore` with three columns, of type - Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the + Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the new row after the last child of @parent, otherwise it will append a row to the top level. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value(). + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set to the appended row + An unset `GtkTreeIter` to set to the appended row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Removes all rows from @tree_store + Removes all rows from @tree_store + - a `GtkTreeStore` + a `GtkTreeStore` - Creates a new row at @position. If parent is non-%NULL, then the row will be + Creates a new row at @position. If parent is non-%NULL, then the row will be made a child of @parent. Otherwise, the row will be created at the toplevel. If @position is -1 or is larger than the number of rows at that level, then the new row will be inserted to the end of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value(). + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - Inserts a new row after @sibling. If @sibling is %NULL, then the row will be + Inserts a new row after @sibling. If @sibling is %NULL, then the row will be prepended to @parent ’s children. If @parent and @sibling are %NULL, then the row will be prepended to the toplevel. If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set, @@ -94760,30 +99407,31 @@ set, then @parent must be the parent of @sibling. When @sibling is set, @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value(). + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Inserts a new row before @sibling. If @sibling is %NULL, then the row will + Inserts a new row before @sibling. If @sibling is %NULL, then the row will be appended to @parent ’s children. If @parent and @sibling are %NULL, then the row will be appended to the toplevel. If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set, @@ -94792,30 +99440,31 @@ set, then @parent must be the parent of @sibling. When @sibling is set, @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value(). + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set to the new row + An unset `GtkTreeIter` to set to the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Creates a new row at @position. @iter will be changed to point to this + Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1, or larger than the number of rows on the list, then the new row will be appended to the list. The row will be filled with the values given to this function. @@ -94833,241 +99482,251 @@ is sorted, rows_reordered. Since emitting the rows_reordered signal repeatedly can affect the performance of the program, gtk_tree_store_insert_with_values() should generally be preferred when inserting rows in a sorted tree store. + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set the new row + An unset `GtkTreeIter` to set the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - position to insert the new row, or -1 to append after existing rows + position to insert the new row, or -1 to append after existing rows - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - A variant of gtk_tree_store_insert_with_values() which takes + A variant of gtk_tree_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language bindings. + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set the new row + An unset `GtkTreeIter` to set the new row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - position to insert the new row, or -1 for last + position to insert the new row, or -1 for last - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the + Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the parent (or grandparent or great-grandparent) of @descendant. + - %TRUE, if @iter is an ancestor of @descendant + %TRUE, if @iter is an ancestor of @descendant - A `GtkTreeStore` + A `GtkTreeStore` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Returns the depth of @iter. This will be 0 for anything on the root level, 1 + Returns the depth of @iter. This will be 0 for anything on the root level, 1 for anything down a level, etc. + - The depth of @iter + The depth of @iter - A `GtkTreeStore` + A `GtkTreeStore` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Checks if the given iter is a valid iter for this `GtkTreeStore`. + Checks if the given iter is a valid iter for this `GtkTreeStore`. This function is slow. Only use it for debugging and/or testing purposes. + - %TRUE if the iter is valid, %FALSE if the iter is invalid. + %TRUE if the iter is valid, %FALSE if the iter is invalid. - a tree store + a tree store - the iterator to check + the iterator to check - Moves @iter in @tree_store to the position after @position. @iter and + Moves @iter in @tree_store to the position after @position. @iter and @position should be in the same level. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the start of the level. + - A `GtkTreeStore` + A `GtkTreeStore` - A `GtkTreeIter`. + A `GtkTreeIter`. - A `GtkTreeIter`. + A `GtkTreeIter`. - Moves @iter in @tree_store to the position before @position. @iter and + Moves @iter in @tree_store to the position before @position. @iter and @position should be in the same level. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the end of the level. + - A `GtkTreeStore` + A `GtkTreeStore` - A `GtkTreeIter` + A `GtkTreeIter` - A `GtkTreeIter` + A `GtkTreeIter` - Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend + Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend the new row before the first child of @parent, otherwise it will prepend a row to the top level. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value(). + - A `GtkTreeStore` + A `GtkTreeStore` - An unset `GtkTreeIter` to set to the prepended row + An unset `GtkTreeIter` to set to the prepended row - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Removes @iter from @tree_store. After being removed, @iter is set to the + Removes @iter from @tree_store. After being removed, @iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one. + - %TRUE if @iter is still valid, %FALSE if not. + %TRUE if @iter is still valid, %FALSE if not. - A `GtkTreeStore` + A `GtkTreeStore` - A valid `GtkTreeIter` + A valid `GtkTreeIter` - Reorders the children of @parent in @tree_store to follow the order + Reorders the children of @parent in @tree_store to follow the order indicated by @new_order. Note that this function only works with unsorted stores. + - A `GtkTreeStore` + A `GtkTreeStore` - A `GtkTreeIter` + A `GtkTreeIter` - an array of integers mapping the new position of each child + an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. @new_order`[newpos] = oldpos`. @@ -95077,7 +99736,7 @@ unsorted stores. - Sets the value of one or more cells in the row referenced by @iter. + Sets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by the value to be set. The list is terminated by a -1. For example, to set column 0 with type @@ -95086,43 +99745,45 @@ The list is terminated by a -1. For example, to set column 0 with type The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED. + - A `GtkTreeStore` + A `GtkTreeStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - pairs of column number and value, terminated with -1 + pairs of column number and value, terminated with -1 - This function is meant primarily for `GObjects` that inherit from + This function is meant primarily for `GObjects` that inherit from `GtkTreeStore`, and should only be used when constructing a new `GtkTreeStore`. It will not function after a row has been added, or a method on the `GtkTreeModel` interface is called. + - A `GtkTreeStore` + A `GtkTreeStore` - Number of columns for the tree store + Number of columns for the tree store - An array of `GType` types, one for each column + An array of `GType` types, one for each column @@ -95130,104 +99791,108 @@ or a method on the `GtkTreeModel` interface is called. - See gtk_tree_store_set(); this version takes a va_list for + See gtk_tree_store_set(); this version takes a va_list for use by language bindings. + - A `GtkTreeStore` + A `GtkTreeStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - va_list of column/value pairs + va_list of column/value pairs - Sets the data in the cell specified by @iter and @column. + Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column. + - a `GtkTreeStore` + a `GtkTreeStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - column number to modify + column number to modify - new value for the cell + new value for the cell - A variant of gtk_tree_store_set_valist() which takes + A variant of gtk_tree_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language bindings or in case the number of columns to change is not known until run-time. + - A `GtkTreeStore` + A `GtkTreeStore` - A valid `GtkTreeIter` for the row being modified + A valid `GtkTreeIter` for the row being modified - an array of column numbers + an array of column numbers - an array of GValues + an array of GValues - the length of the @columns and @values arrays + the length of the @columns and @values arrays - Swaps @a and @b in the same level of @tree_store. Note that this function + Swaps @a and @b in the same level of @tree_store. Note that this function only works with unsorted stores. + - A `GtkTreeStore`. + A `GtkTreeStore`. - A `GtkTreeIter`. + A `GtkTreeIter`. - Another `GtkTreeIter`. + Another `GtkTreeIter`. @@ -95240,6 +99905,7 @@ only works with unsorted stores. + @@ -95249,9 +99915,11 @@ only works with unsorted stores. - + + + - A widget for displaying both trees and lists + A widget for displaying both trees and lists Widget that displays any object that implements the [iface@Gtk.TreeModel] interface. @@ -95337,31 +100005,35 @@ is expected to provide a suitable image using the `-gtk-icon-source` property. For rubberband selection, a subnode with name `rubberband` is used. For the drop target location during DND, a subnode with name `dndtarget` is used. + - Creates a new `GtkTreeView` widget. + Creates a new `GtkTreeView` widget. + - A newly created `GtkTreeView` widget. + A newly created `GtkTreeView` widget. - Creates a new `GtkTreeView` widget with the model initialized to @model. + Creates a new `GtkTreeView` widget with the model initialized to @model. + - A newly created `GtkTreeView` widget. + A newly created `GtkTreeView` widget. - the model. + the model. + @@ -95372,6 +100044,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95382,6 +100055,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95401,6 +100075,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95423,26 +100098,28 @@ For the drop target location during DND, a subnode with name `dndtarget` is used - Activates the cell determined by @path and @column. + Activates the cell determined by @path and @column. + - A `GtkTreeView` + A `GtkTreeView` - The `GtkTreePath` to be activated. + The `GtkTreePath` to be activated. - The `GtkTreeViewColumn` to be activated. + The `GtkTreeViewColumn` to be activated. + @@ -95459,6 +100136,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95475,6 +100153,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95485,6 +100164,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95495,6 +100175,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95508,6 +100189,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95518,6 +100200,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95534,6 +100217,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95550,6 +100234,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95560,6 +100245,7 @@ For the drop target location during DND, a subnode with name `dndtarget` is used + @@ -95570,369 +100256,386 @@ For the drop target location during DND, a subnode with name `dndtarget` is used - Appends @column to the list of columns. If @tree_view has “fixed_height” + Appends @column to the list of columns. If @tree_view has “fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. + - The number of columns in @tree_view after appending. + The number of columns in @tree_view after appending. - A `GtkTreeView`. + A `GtkTreeView`. - The `GtkTreeViewColumn` to add. + The `GtkTreeViewColumn` to add. - Recursively collapses all visible, expanded nodes in @tree_view. + Recursively collapses all visible, expanded nodes in @tree_view. + - A `GtkTreeView`. + A `GtkTreeView`. - Collapses a row (hides its child rows, if they exist). + Collapses a row (hides its child rows, if they exist). + - %TRUE if the row was collapsed. + %TRUE if the row was collapsed. - a `GtkTreeView` + a `GtkTreeView` - path to a row in the @tree_view + path to a row in the @tree_view - Resizes all columns to their optimal width. Only works after the + Resizes all columns to their optimal width. Only works after the treeview has been realized. + - A `GtkTreeView`. + A `GtkTreeView`. - Converts bin_window coordinates to coordinates for the + Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree). + - a `GtkTreeView` + a `GtkTreeView` - X coordinate relative to bin_window + X coordinate relative to bin_window - Y coordinate relative to bin_window + Y coordinate relative to bin_window - return location for tree X coordinate + return location for tree X coordinate - return location for tree Y coordinate + return location for tree Y coordinate - Converts bin_window coordinates to widget relative coordinates. + Converts bin_window coordinates to widget relative coordinates. + - a `GtkTreeView` + a `GtkTreeView` - bin_window X coordinate + bin_window X coordinate - bin_window Y coordinate + bin_window Y coordinate - return location for widget X coordinate + return location for widget X coordinate - return location for widget Y coordinate + return location for widget Y coordinate - Converts tree coordinates (coordinates in full scrollable area of the tree) + Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates. + - a `GtkTreeView` + a `GtkTreeView` - tree X coordinate + tree X coordinate - tree Y coordinate + tree Y coordinate - return location for X coordinate relative to bin_window + return location for X coordinate relative to bin_window - return location for Y coordinate relative to bin_window + return location for Y coordinate relative to bin_window - Converts tree coordinates (coordinates in full scrollable area of the tree) + Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates. + - a `GtkTreeView` + a `GtkTreeView` - X coordinate relative to the tree + X coordinate relative to the tree - Y coordinate relative to the tree + Y coordinate relative to the tree - return location for widget X coordinate + return location for widget X coordinate - return location for widget Y coordinate + return location for widget Y coordinate - Converts widget coordinates to coordinates for the bin_window. + Converts widget coordinates to coordinates for the bin_window. + - a `GtkTreeView` + a `GtkTreeView` - X coordinate relative to the widget + X coordinate relative to the widget - Y coordinate relative to the widget + Y coordinate relative to the widget - return location for bin_window X coordinate + return location for bin_window X coordinate - return location for bin_window Y coordinate + return location for bin_window Y coordinate - Converts widget coordinates to coordinates for the + Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree). + - a `GtkTreeView` + a `GtkTreeView` - X coordinate relative to the widget + X coordinate relative to the widget - Y coordinate relative to the widget + Y coordinate relative to the widget - return location for tree X coordinate + return location for tree X coordinate - return location for tree Y coordinate + return location for tree Y coordinate - Creates a `cairo_surface_t` representation of the row at @path. + Creates a `cairo_surface_t` representation of the row at @path. This image is used for a drag icon. + - a newly-allocated surface of the drag icon. + a newly-allocated surface of the drag icon. - a `GtkTreeView` + a `GtkTreeView` - a `GtkTreePath` in @tree_view + a `GtkTreePath` in @tree_view - Turns @tree_view into a drop destination for automatic DND. Calling + Turns @tree_view into a drop destination for automatic DND. Calling this method sets `GtkTreeView`:reorderable to %FALSE. + - a `GtkTreeView` + a `GtkTreeView` - the target formats that the drag will support + the target formats that the drag will support - the bitmask of possible actions for a drag from this + the bitmask of possible actions for a drag from this widget - Turns @tree_view into a drag source for automatic DND. Calling this + Turns @tree_view into a drag source for automatic DND. Calling this method sets `GtkTreeView`:reorderable to %FALSE. + - a `GtkTreeView` + a `GtkTreeView` - Mask of allowed buttons to start drag + Mask of allowed buttons to start drag - the target formats that the drag will support + the target formats that the drag will support - the bitmask of possible actions for a drag from this + the bitmask of possible actions for a drag from this widget - Recursively expands all nodes in the @tree_view. + Recursively expands all nodes in the @tree_view. + - A `GtkTreeView`. + A `GtkTreeView`. - Opens the row so its children are visible. + Opens the row so its children are visible. + - %TRUE if the row existed and had children + %TRUE if the row existed and had children - a `GtkTreeView` + a `GtkTreeView` - path to a row + path to a row - whether to recursively expand, or just expand immediate children + whether to recursively expand, or just expand immediate children - Expands the row at @path. This will also expand all parent rows of + Expands the row at @path. This will also expand all parent rows of @path as necessary. + - A `GtkTreeView`. + A `GtkTreeView`. - path to a row. + path to a row. - Gets the setting set by gtk_tree_view_set_activate_on_single_click(). + Gets the setting set by gtk_tree_view_set_activate_on_single_click(). + - %TRUE if row-activated will be emitted on a single click + %TRUE if row-activated will be emitted on a single click - a `GtkTreeView` + a `GtkTreeView` - Fills the bounding rectangle in bin_window coordinates for the cell at the + Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is %NULL, or points to a node not found in the tree, the @y and @height fields of the rectangle will be filled with 0. If @column is %NULL, the @x and @width @@ -95941,30 +100644,31 @@ fields will be filled with 0. The returned rectangle is equivalent to the areas tile to cover the entire bin window. Contrast with the @cell_area, returned by gtk_tree_view_get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area. + - a `GtkTreeView` + a `GtkTreeView` - a `GtkTreePath` for the row, or %NULL to get only horizontal coordinates + a `GtkTreePath` for the row, or %NULL to get only horizontal coordinates - a `GtkTreeViewColumn` for the column, or %NULL to get only vertical coordinates + a `GtkTreeViewColumn` for the column, or %NULL to get only vertical coordinates - rectangle to fill with cell background rect + rectangle to fill with cell background rect - Fills the bounding rectangle in bin_window coordinates for the cell at the + Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is %NULL, or points to a path not currently displayed, the @y and @height fields of the rectangle will be filled with 0. If @column is %NULL, the @x and @width @@ -95973,310 +100677,328 @@ entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the @cell_area passed to gtk_cell_renderer_render(). This function is only valid if @tree_view is realized. + - a `GtkTreeView` + a `GtkTreeView` - a `GtkTreePath` for the row, or %NULL to get only horizontal coordinates + a `GtkTreePath` for the row, or %NULL to get only horizontal coordinates - a `GtkTreeViewColumn` for the column, or %NULL to get only vertical coordinates + a `GtkTreeViewColumn` for the column, or %NULL to get only vertical coordinates - rectangle to fill with cell rect + rectangle to fill with cell rect - Gets the `GtkTreeViewColumn` at the given position in the #tree_view. + Gets the `GtkTreeViewColumn` at the given position in the #tree_view. + - The `GtkTreeViewColumn`, or %NULL if the + The `GtkTreeViewColumn`, or %NULL if the position is outside the range of columns. - A `GtkTreeView`. + A `GtkTreeView`. - The position of the column, counting from 0. + The position of the column, counting from 0. - Returns a `GList` of all the `GtkTreeViewColumn`s currently in @tree_view. + Returns a `GList` of all the `GtkTreeViewColumn`s currently in @tree_view. The returned list must be freed with g_list_free (). + - A list of `GtkTreeViewColumn`s + A list of `GtkTreeViewColumn`s - A `GtkTreeView` + A `GtkTreeView` - Fills in @path and @focus_column with the current path and focus column. If + Fills in @path and @focus_column with the current path and focus column. If the cursor isn’t currently set, then *@path will be %NULL. If no column currently has focus, then *@focus_column will be %NULL. The returned `GtkTreePath` must be freed with gtk_tree_path_free() when you are done with it. + - A `GtkTreeView` + A `GtkTreeView` - A pointer to be + A pointer to be filled with the current cursor path - A + A pointer to be filled with the current focus column - Determines the destination row for a given position. @drag_x and + Determines the destination row for a given position. @drag_x and @drag_y are expected to be in widget coordinates. This function is only meaningful if @tree_view is realized. Therefore this function will always return %FALSE if @tree_view is not realized or does not have a model. + - whether there is a row at the given position, %TRUE if this + whether there is a row at the given position, %TRUE if this is indeed the case. - a `GtkTreeView` + a `GtkTreeView` - the position to determine the destination row for + the position to determine the destination row for - the position to determine the destination row for + the position to determine the destination row for - Return location for the path of + Return location for the path of the highlighted row - Return location for the drop position, or + Return location for the drop position, or %NULL - Gets information about the row that is highlighted for feedback. + Gets information about the row that is highlighted for feedback. + - a `GtkTreeView` + a `GtkTreeView` - Return location for the path of the highlighted row + Return location for the path of the highlighted row - Return location for the drop position + Return location for the drop position - Returns whether or not the tree allows to start interactive searching + Returns whether or not the tree allows to start interactive searching by typing in text. + - whether or not to let the user search interactively + whether or not to let the user search interactively - A `GtkTreeView` + A `GtkTreeView` - Returns whether or not tree lines are drawn in @tree_view. + Returns whether or not tree lines are drawn in @tree_view. + - %TRUE if tree lines are drawn in @tree_view, %FALSE + %TRUE if tree lines are drawn in @tree_view, %FALSE otherwise. - a `GtkTreeView`. + a `GtkTreeView`. - Returns the column that is the current expander column, + Returns the column that is the current expander column, or %NULL if none has been set. This column has the expander arrow drawn next to it. + - The expander column. + The expander column. - A `GtkTreeView` + A `GtkTreeView` - Returns whether fixed height mode is turned on for @tree_view. + Returns whether fixed height mode is turned on for @tree_view. + - %TRUE if @tree_view is in fixed height mode + %TRUE if @tree_view is in fixed height mode - a `GtkTreeView` + a `GtkTreeView` - Returns which grid lines are enabled in @tree_view. + Returns which grid lines are enabled in @tree_view. + - a `GtkTreeView`GridLines value indicating which grid lines + a `GtkTreeView`GridLines value indicating which grid lines are enabled. - a `GtkTreeView` + a `GtkTreeView` - Returns whether all header columns are clickable. + Returns whether all header columns are clickable. + - %TRUE if all header columns are clickable, otherwise %FALSE + %TRUE if all header columns are clickable, otherwise %FALSE - A `GtkTreeView`. + A `GtkTreeView`. - Returns %TRUE if the headers on the @tree_view are visible. + Returns %TRUE if the headers on the @tree_view are visible. + - Whether the headers are visible or not. + Whether the headers are visible or not. - A `GtkTreeView`. + A `GtkTreeView`. - Returns whether hover expansion mode is turned on for @tree_view. + Returns whether hover expansion mode is turned on for @tree_view. + - %TRUE if @tree_view is in hover expansion mode + %TRUE if @tree_view is in hover expansion mode - a `GtkTreeView` + a `GtkTreeView` - Returns whether hover selection mode is turned on for @tree_view. + Returns whether hover selection mode is turned on for @tree_view. + - %TRUE if @tree_view is in hover selection mode + %TRUE if @tree_view is in hover selection mode - a `GtkTreeView` + a `GtkTreeView` - Returns the amount, in pixels, of extra indentation for child levels + Returns the amount, in pixels, of extra indentation for child levels in @tree_view. + - the amount of extra indentation for child levels in + the amount of extra indentation for child levels in @tree_view. A return value of 0 means that this feature is disabled. - a `GtkTreeView`. + a `GtkTreeView`. - Returns the model the `GtkTreeView` is based on. Returns %NULL if the + Returns the model the `GtkTreeView` is based on. Returns %NULL if the model is unset. + - A `GtkTreeModel` + A `GtkTreeModel` - a `GtkTreeView` + a `GtkTreeView` - Queries the number of columns in the given @tree_view. + Queries the number of columns in the given @tree_view. + - The number of columns in the @tree_view + The number of columns in the @tree_view - a `GtkTreeView` + a `GtkTreeView` - Finds the path at the point (@x, @y), relative to bin_window coordinates. + Finds the path at the point (@x, @y), relative to bin_window coordinates. That is, @x and @y are relative to an events coordinates. Widget-relative coordinates must be converted using gtk_tree_view_convert_widget_to_bin_window_coords(). It is primarily for @@ -96292,172 +101014,182 @@ if @tree_view is not realized or does not have a model. For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords(). + - %TRUE if a row exists at that coordinate. + %TRUE if a row exists at that coordinate. - A `GtkTreeView`. + A `GtkTreeView`. - The x position to be identified (relative to bin_window). + The x position to be identified (relative to bin_window). - The y position to be identified (relative to bin_window). + The y position to be identified (relative to bin_window). - A pointer to a `GtkTreePath` + A pointer to a `GtkTreePath` pointer to be filled in - A pointer to + A pointer to a `GtkTreeViewColumn` pointer to be filled in - A pointer where the X coordinate + A pointer where the X coordinate relative to the cell can be placed - A pointer where the Y coordinate + A pointer where the Y coordinate relative to the cell can be placed - Retrieves whether the user can reorder the tree via drag-and-drop. See + Retrieves whether the user can reorder the tree via drag-and-drop. See gtk_tree_view_set_reorderable(). + - %TRUE if the tree can be reordered. + %TRUE if the tree can be reordered. - a `GtkTreeView` + a `GtkTreeView` - Returns the current row separator function. + Returns the current row separator function. + - the current row separator function. + the current row separator function. - a `GtkTreeView` + a `GtkTreeView` - Returns whether rubber banding is turned on for @tree_view. If the + Returns whether rubber banding is turned on for @tree_view. If the selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse. + - %TRUE if rubber banding in @tree_view is enabled. + %TRUE if rubber banding in @tree_view is enabled. - a `GtkTreeView` + a `GtkTreeView` - Gets the column searched on by the interactive search code. + Gets the column searched on by the interactive search code. + - the column the interactive search code searches in. + the column the interactive search code searches in. - A `GtkTreeView` + A `GtkTreeView` - Returns the `GtkEntry` which is currently in use as interactive search + Returns the `GtkEntry` which is currently in use as interactive search entry for @tree_view. In case the built-in entry is being used, %NULL will be returned. + - the entry currently in use as search entry. + the entry currently in use as search entry. - A `GtkTreeView` + A `GtkTreeView` - Returns the compare function currently in use. + Returns the compare function currently in use. + - the currently used compare function for the search code. + the currently used compare function for the search code. - A `GtkTreeView` + A `GtkTreeView` - Gets the `GtkTreeSelection` associated with @tree_view. + Gets the `GtkTreeSelection` associated with @tree_view. + - A `GtkTreeSelection` object. + A `GtkTreeSelection` object. - A `GtkTreeView`. + A `GtkTreeView`. - Returns whether or not expanders are drawn in @tree_view. + Returns whether or not expanders are drawn in @tree_view. + - %TRUE if expanders are drawn in @tree_view, %FALSE + %TRUE if expanders are drawn in @tree_view, %FALSE otherwise. - a `GtkTreeView`. + a `GtkTreeView`. - Returns the column of @tree_view’s model which is being used for + Returns the column of @tree_view’s model which is being used for displaying tooltips on @tree_view’s rows. + - the index of the tooltip column that is currently being + the index of the tooltip column that is currently being used, or -1 if this is disabled. - a `GtkTreeView` + a `GtkTreeView` - This function is supposed to be used in a ::query-tooltip + This function is supposed to be used in a ::query-tooltip signal handler for `GtkTreeView`. The @x, @y and @keyboard_tip values which are received in the signal handler, should be passed to this function without modification. @@ -96468,187 +101200,193 @@ tooltips the row returned will be the cursor row. When %TRUE, then any of @model, @path and @iter which have been provided will be set to point to that row and the corresponding model. @x and @y will always be converted to be relative to @tree_view’s bin_window if @keyboard_tooltip is %FALSE. + - whether or not the given tooltip context points to a row + whether or not the given tooltip context points to a row - a `GtkTreeView` + a `GtkTreeView` - the x coordinate (relative to widget coordinates) + the x coordinate (relative to widget coordinates) - the y coordinate (relative to widget coordinates) + the y coordinate (relative to widget coordinates) - whether this is a keyboard tooltip or not + whether this is a keyboard tooltip or not - a pointer to + a pointer to receive a `GtkTreeModel` - a pointer to receive a `GtkTreePath` + a pointer to receive a `GtkTreePath` - a pointer to receive a `GtkTreeIter` + a pointer to receive a `GtkTreeIter` - Sets @start_path and @end_path to be the first and last visible path. + Sets @start_path and @end_path to be the first and last visible path. Note that there may be invisible paths in between. The paths should be freed with gtk_tree_path_free() after use. + - %TRUE, if valid paths were placed in @start_path and @end_path. + %TRUE, if valid paths were placed in @start_path and @end_path. - A `GtkTreeView` + A `GtkTreeView` - Return location for start of region + Return location for start of region - Return location for end of region + Return location for end of region - Fills @visible_rect with the currently-visible region of the + Fills @visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with gtk_tree_view_convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree. + - a `GtkTreeView` + a `GtkTreeView` - rectangle to fill + rectangle to fill - This inserts the @column into the @tree_view at @position. If @position is + This inserts the @column into the @tree_view at @position. If @position is -1, then the column is inserted at the end. If @tree_view has “fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. + - The number of columns in @tree_view after insertion. + The number of columns in @tree_view after insertion. - A `GtkTreeView`. + A `GtkTreeView`. - The `GtkTreeViewColumn` to be inserted. + The `GtkTreeViewColumn` to be inserted. - The position to insert @column in. + The position to insert @column in. - Creates a new `GtkTreeViewColumn` and inserts it into the @tree_view at + Creates a new `GtkTreeViewColumn` and inserts it into the @tree_view at @position. If @position is -1, then the newly created column is inserted at the end. The column is initialized with the attributes given. If @tree_view has “fixed_height” mode enabled, then the new column will have its sizing property set to be GTK_TREE_VIEW_COLUMN_FIXED. + - The number of columns in @tree_view after insertion. + The number of columns in @tree_view after insertion. - A `GtkTreeView` + A `GtkTreeView` - The position to insert the new column in + The position to insert the new column in - The title to set the header to + The title to set the header to - The `GtkCellRenderer` + The `GtkCellRenderer` - A %NULL-terminated list of attributes + A %NULL-terminated list of attributes - Convenience function that inserts a new column into the `GtkTreeView` + Convenience function that inserts a new column into the `GtkTreeView` with the given cell renderer and a `GtkTreeCellDataFunc` to set cell renderer attributes (normally using data from the model). See also gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). If @tree_view has “fixed_height” mode enabled, then the new column will have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. + - number of columns in the tree view post-insert + number of columns in the tree view post-insert - a `GtkTreeView` + a `GtkTreeView` - Position to insert, -1 for append + Position to insert, -1 for append - column title + column title - cell renderer for column + cell renderer for column - function to set attributes of cell renderer + function to set attributes of cell renderer - data for @func + data for @func - destroy notifier for @data + destroy notifier for @data - Determine whether the point (@x, @y) in @tree_view is blank, that is no + Determine whether the point (@x, @y) in @tree_view is blank, that is no cell content nor an expander arrow is drawn at the location. If so, the location can be considered as the background. You might wish to take special action on clicks on the background, such as clearing a current @@ -96665,158 +101403,165 @@ gtk_tree_view_convert_widget_to_bin_window_coords(). The @path, @column, @cell_x and @cell_y arguments will be filled in likewise as for gtk_tree_view_get_path_at_pos(). Please see gtk_tree_view_get_path_at_pos() for more information. + - %TRUE if the area at the given coordinates is blank, + %TRUE if the area at the given coordinates is blank, %FALSE otherwise. - A `GtkTreeView` + A `GtkTreeView` - The x position to be identified (relative to bin_window) + The x position to be identified (relative to bin_window) - The y position to be identified (relative to bin_window) + The y position to be identified (relative to bin_window) - A pointer to a `GtkTreePath` pointer to + A pointer to a `GtkTreePath` pointer to be filled in - A pointer to a + A pointer to a `GtkTreeViewColumn` pointer to be filled in - A pointer where the X coordinate relative to the + A pointer where the X coordinate relative to the cell can be placed - A pointer where the Y coordinate relative to the + A pointer where the Y coordinate relative to the cell can be placed - Returns whether a rubber banding operation is currently being done + Returns whether a rubber banding operation is currently being done in @tree_view. + - %TRUE if a rubber banding operation is currently being + %TRUE if a rubber banding operation is currently being done in @tree_view. - a `GtkTreeView` + a `GtkTreeView` - Calls @func on all expanded rows. + Calls @func on all expanded rows. + - A `GtkTreeView` + A `GtkTreeView` - A function to be called + A function to be called - User data to be passed to the function. + User data to be passed to the function. - Moves @column to be after to @base_column. If @base_column is %NULL, then + Moves @column to be after to @base_column. If @base_column is %NULL, then @column is placed in the first position. + - A `GtkTreeView` + A `GtkTreeView` - The `GtkTreeViewColumn` to be moved. + The `GtkTreeViewColumn` to be moved. - The `GtkTreeViewColumn` to be moved relative to + The `GtkTreeViewColumn` to be moved relative to - Removes @column from @tree_view. + Removes @column from @tree_view. + - The number of columns in @tree_view after removing. + The number of columns in @tree_view after removing. - A `GtkTreeView`. + A `GtkTreeView`. - The `GtkTreeViewColumn` to remove. + The `GtkTreeViewColumn` to remove. - Activates the cell determined by @path and @column. + Activates the cell determined by @path and @column. + - A `GtkTreeView` + A `GtkTreeView` - The `GtkTreePath` to be activated. + The `GtkTreePath` to be activated. - The `GtkTreeViewColumn` to be activated. + The `GtkTreeViewColumn` to be activated. - Returns %TRUE if the node pointed to by @path is expanded in @tree_view. + Returns %TRUE if the node pointed to by @path is expanded in @tree_view. + - %TRUE if #path is expanded. + %TRUE if #path is expanded. - A `GtkTreeView`. + A `GtkTreeView`. - A `GtkTreePath` to test expansion state. + A `GtkTreePath` to test expansion state. - Moves the alignments of @tree_view to the position specified by @column and + Moves the alignments of @tree_view to the position specified by @column and @path. If @column is %NULL, then no horizontal scrolling occurs. Likewise, if @path is %NULL no vertical scrolling occurs. At a minimum, one of @column or @path need to be non-%NULL. @row_align determines where the row is @@ -96832,81 +101577,84 @@ position. If the cell is currently visible on the screen, nothing is done. This function only works if the model is set, and @path is a valid row on the model. If the model changes before the @tree_view is realized, the centered path will be modified to reflect this change. + - A `GtkTreeView`. + A `GtkTreeView`. - The path of the row to move to + The path of the row to move to - The `GtkTreeViewColumn` to move horizontally to + The `GtkTreeViewColumn` to move horizontally to - whether to use alignment arguments, or %FALSE. + whether to use alignment arguments, or %FALSE. - The vertical alignment of the row specified by @path. + The vertical alignment of the row specified by @path. - The horizontal alignment of the column specified by @column. + The horizontal alignment of the column specified by @column. - Scrolls the tree view such that the top-left corner of the visible + Scrolls the tree view such that the top-left corner of the visible area is @tree_x, @tree_y, where @tree_x and @tree_y are specified in tree coordinates. The @tree_view must be realized before this function is called. If it isn't, you probably want to be using gtk_tree_view_scroll_to_cell(). If either @tree_x or @tree_y are -1, then that direction isn’t scrolled. + - a `GtkTreeView` + a `GtkTreeView` - X coordinate of new top-left pixel of visible area, or -1 + X coordinate of new top-left pixel of visible area, or -1 - Y coordinate of new top-left pixel of visible area, or -1 + Y coordinate of new top-left pixel of visible area, or -1 - Cause the `GtkTreeView`::row-activated signal to be emitted + Cause the `GtkTreeView`::row-activated signal to be emitted on a single click instead of a double click. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to emit row-activated on a single click + %TRUE to emit row-activated on a single click - Sets a user function for determining where a column may be dropped when + Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to @func are: the @tree_view, the `GtkTreeViewColumn` being @@ -96915,30 +101663,31 @@ dragged, the two `GtkTreeViewColumn`s determining the drop spot, and are %NULL, then they indicate an edge. If @func is set to be %NULL, then @tree_view reverts to the default behavior of allowing all columns to be dropped everywhere. + - A `GtkTreeView`. + A `GtkTreeView`. - A function to determine which columns are reorderable + A function to determine which columns are reorderable - User data to be passed to @func + User data to be passed to @func - Destroy notifier for @user_data + Destroy notifier for @user_data - Sets the current keyboard focus to be at @path, and selects it. This is + Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If @focus_column is not %NULL, then focus is given to the column specified by it. Additionally, if @focus_column is specified, and @start_editing is @@ -96949,30 +101698,31 @@ can only happen when the widget is realized. If @path is invalid for @model, the current cursor (if any) will be unset and the function will return without failing. + - A `GtkTreeView` + A `GtkTreeView` - A `GtkTreePath` + A `GtkTreePath` - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - %TRUE if the specified cell should start being edited. + %TRUE if the specified cell should start being edited. - Sets the current keyboard focus to be at @path, and selects it. This is + Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If @focus_column is not %NULL, then focus is given to the column specified by it. If @focus_column and @focus_cell are not %NULL, and @focus_column @@ -96986,257 +101736,270 @@ realized. If @path is invalid for @model, the current cursor (if any) will be unset and the function will return without failing. + - A `GtkTreeView` + A `GtkTreeView` - A `GtkTreePath` + A `GtkTreePath` - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - A `GtkCellRenderer` + A `GtkCellRenderer` - %TRUE if the specified cell should start being edited. + %TRUE if the specified cell should start being edited. - Sets the row that is highlighted for feedback. + Sets the row that is highlighted for feedback. If @path is %NULL, an existing highlight is removed. + - a `GtkTreeView` + a `GtkTreeView` - The path of the row to highlight + The path of the row to highlight - Specifies whether to drop before, after or into the row + Specifies whether to drop before, after or into the row - If @enable_search is set, then the user can type in text to search through + If @enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find"). Note that even if this is %FALSE, the user can still initiate a search using the “start-interactive-search” key binding. + - A `GtkTreeView` + A `GtkTreeView` - %TRUE, if the user can search interactively + %TRUE, if the user can search interactively - Sets whether to draw lines interconnecting the expanders in @tree_view. + Sets whether to draw lines interconnecting the expanders in @tree_view. This does not have any visible effects for lists. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to enable tree line drawing, %FALSE otherwise. + %TRUE to enable tree line drawing, %FALSE otherwise. - Sets the column to draw the expander arrow at. It must be in @tree_view. + Sets the column to draw the expander arrow at. It must be in @tree_view. If @column is %NULL, then the expander arrow is always at the first visible column. If you do not want expander arrow to appear in your tree, set the expander column to a hidden column. + - A `GtkTreeView` + A `GtkTreeView` - %NULL, or the column to draw the expander arrow at. + %NULL, or the column to draw the expander arrow at. - Enables or disables the fixed height mode of @tree_view. + Enables or disables the fixed height mode of @tree_view. Fixed height mode speeds up `GtkTreeView` by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type %GTK_TREE_VIEW_COLUMN_FIXED. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to enable fixed height mode + %TRUE to enable fixed height mode - Sets which grid lines to draw in @tree_view. + Sets which grid lines to draw in @tree_view. + - a `GtkTreeView` + a `GtkTreeView` - a `GtkTreeView`GridLines value indicating which grid lines to + a `GtkTreeView`GridLines value indicating which grid lines to enable. - Allow the column title buttons to be clicked. + Allow the column title buttons to be clicked. + - A `GtkTreeView`. + A `GtkTreeView`. - %TRUE if the columns are clickable. + %TRUE if the columns are clickable. - Sets the visibility state of the headers. + Sets the visibility state of the headers. + - A `GtkTreeView`. + A `GtkTreeView`. - %TRUE if the headers are visible + %TRUE if the headers are visible - Enables or disables the hover expansion mode of @tree_view. + Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to enable hover selection mode + %TRUE to enable hover selection mode - Enables or disables the hover selection mode of @tree_view. + Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to enable hover selection mode + %TRUE to enable hover selection mode - Sets the amount of extra indentation for child levels to use in @tree_view + Sets the amount of extra indentation for child levels to use in @tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists. + - a `GtkTreeView` + a `GtkTreeView` - the amount, in pixels, of extra indentation in @tree_view. + the amount, in pixels, of extra indentation in @tree_view. - Sets the model for a `GtkTreeView`. If the @tree_view already has a model + Sets the model for a `GtkTreeView`. If the @tree_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model. + - A `GtkTreeView`. + A `GtkTreeView`. - The model. + The model. - This function is a convenience function to allow you to reorder + This function is a convenience function to allow you to reorder models that support the `GtkTreeDragSourceIface` and the `GtkTreeDragDestIface`. Both `GtkTreeStore` and `GtkListStore` support these. If @reorderable is %TRUE, then the user can reorder the @@ -97250,66 +102013,69 @@ other purpose. This function does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually. + - A `GtkTreeView`. + A `GtkTreeView`. - %TRUE, if the tree can be reordered. + %TRUE, if the tree can be reordered. - Sets the row separator function, which is used to determine + Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is %NULL, no separators are drawn. This is the default value. + - a `GtkTreeView` + a `GtkTreeView` - a `GtkTreeView`RowSeparatorFunc + a `GtkTreeView`RowSeparatorFunc - user data to pass to @func + user data to pass to @func - destroy notifier for @data + destroy notifier for @data - Enables or disables rubber banding in @tree_view. If the selection mode + Enables or disables rubber banding in @tree_view. If the selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to enable rubber banding + %TRUE to enable rubber banding - Sets @column as the column where the interactive search code should + Sets @column as the column where the interactive search code should search in for the current model. If the search column is set, users can use the “start-interactive-search” @@ -97318,90 +102084,94 @@ whether simply typing text will also start an interactive search. Note that @column refers to a column of the current model. The search column is reset to -1 when the model is changed. + - A `GtkTreeView` + A `GtkTreeView` - the column of the model to search in, or -1 to disable searching + the column of the model to search in, or -1 to disable searching - Sets the entry which the interactive search code will use for this + Sets the entry which the interactive search code will use for this @tree_view. This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing %NULL for @entry will make the interactive search code use the built-in popup entry again. + - A `GtkTreeView` + A `GtkTreeView` - the entry the interactive search code of @tree_view should use + the entry the interactive search code of @tree_view should use - Sets the compare function for the interactive search capabilities; note + Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality `GtkTreeView`SearchEqualFunc returns %FALSE on matches. + - A `GtkTreeView` + A `GtkTreeView` - the compare function to use during the search + the compare function to use during the search - user data to pass to @search_equal_func + user data to pass to @search_equal_func - Destroy notifier for @search_user_data + Destroy notifier for @search_user_data - Sets whether to draw and enable expanders and indent child rows in + Sets whether to draw and enable expanders and indent child rows in @tree_view. When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You can set a custom indentation in this case using gtk_tree_view_set_level_indentation(). This does not have any visible effects for lists. + - a `GtkTreeView` + a `GtkTreeView` - %TRUE to enable expander drawing, %FALSE otherwise. + %TRUE to enable expander drawing, %FALSE otherwise. - Sets the tip area of @tooltip to the area @path, @column and @cell have + Sets the tip area of @tooltip to the area @path, @column and @cell have in common. For example if @path is %NULL and @column is set, the tip area will be set to the full area covered by @column. See also gtk_tooltip_set_tip_area(). @@ -97412,34 +102182,35 @@ position. In such cases @path must be set to the current node under the mouse cursor for this function to operate correctly. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. + - a `GtkTreeView` + a `GtkTreeView` - a `GtkTooltip` + a `GtkTooltip` - a `GtkTreePath` + a `GtkTreePath` - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - a `GtkCellRenderer` + a `GtkCellRenderer` - If you only plan to have simple (text-only) tooltips on full rows, you + If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have `GtkTreeView` handle these automatically for you. @column should be set to the column in @tree_view’s model containing the tooltip texts, or -1 to disable this feature. @@ -97449,72 +102220,76 @@ When enabled, `GtkWidget:has-tooltip` will be set to %TRUE and Note that the signal handler sets the text with gtk_tooltip_set_markup(), so &, <, etc have to be escaped in the text. + - a `GtkTreeView` + a `GtkTreeView` - an integer, which is a valid column number for @tree_view’s model + an integer, which is a valid column number for @tree_view’s model - Sets the tip area of @tooltip to be the area covered by the row at @path. + Sets the tip area of @tooltip to be the area covered by the row at @path. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area(). + - a `GtkTreeView` + a `GtkTreeView` - a `GtkTooltip` + a `GtkTooltip` - a `GtkTreePath` + a `GtkTreePath` - Undoes the effect of + Undoes the effect of gtk_tree_view_enable_model_drag_dest(). Calling this method sets `GtkTreeView`:reorderable to %FALSE. + - a `GtkTreeView` + a `GtkTreeView` - Undoes the effect of + Undoes the effect of gtk_tree_view_enable_model_drag_source(). Calling this method sets `GtkTreeView`:reorderable to %FALSE. + - a `GtkTreeView` + a `GtkTreeView` - The activate-on-single-click property specifies whether the "row-activated" signal + The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click. @@ -97531,7 +102306,7 @@ will be emitted after a single click. - Setting the ::fixed-height-mode property to %TRUE speeds up + Setting the ::fixed-height-mode property to %TRUE speeds up `GtkTreeView` by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtk_tree_view_set_fixed_height_mode() for more @@ -97545,7 +102320,7 @@ information on this option. - Enables or disables the hover expansion mode of @tree_view. + Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them. @@ -97554,7 +102329,7 @@ in `GtkComboBox` or `GtkEntryCompletion`. - Enables or disables the hover selection mode of @tree_view. + Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE. @@ -97564,7 +102339,7 @@ in `GtkComboBox` or `GtkEntryCompletion`. - Extra indentation for each level. + Extra indentation for each level. @@ -97580,7 +102355,7 @@ in `GtkComboBox` or `GtkEntryCompletion`. - %TRUE if the view has expanders. + %TRUE if the view has expanders. @@ -97590,13 +102365,13 @@ in `GtkComboBox` or `GtkEntryCompletion`. - The number of columns of the treeview has changed. + The number of columns of the treeview has changed. - The position of the cursor (focused cell) has changed. + The position of the cursor (focused cell) has changed. @@ -97618,7 +102393,7 @@ in `GtkComboBox` or `GtkEntryCompletion`. - The `GtkTreeView`::move-cursor signal is a [keybinding + The `GtkTreeView`::move-cursor signal is a [keybinding signal][class@Gtk.SignalAction] which gets emitted when the user presses one of the cursor keys. @@ -97628,12 +102403,12 @@ programmatically. In contrast to gtk_tree_view_set_cursor() and gtk_tree_view_set_cursor_on_cell() when moving horizontally `GtkTreeView`::move-cursor does not reset the current selection. - %TRUE if @step is supported, %FALSE otherwise. + %TRUE if @step is supported, %FALSE otherwise. - the granularity of the move, as a `GtkMovementStep`. + the granularity of the move, as a `GtkMovementStep`. %GTK_MOVEMENT_LOGICAL_POSITIONS, %GTK_MOVEMENT_VISUAL_POSITIONS, %GTK_MOVEMENT_DISPLAY_LINES, %GTK_MOVEMENT_PAGES and %GTK_MOVEMENT_BUFFER_ENDS are supported. @@ -97642,22 +102417,22 @@ gtk_tree_view_set_cursor_on_cell() when moving horizontally - the direction to move: +1 to move forwards; -1 to move + the direction to move: +1 to move forwards; -1 to move backwards. The resulting movement is undefined for all other values. - whether to extend the selection + whether to extend the selection - whether to modify the selection + whether to modify the selection - The "row-activated" signal is emitted when the method + The "row-activated" signal is emitted when the method gtk_tree_view_row_activated() is called. This signal is emitted when the user double-clicks a treeview row with the @@ -97675,43 +102450,43 @@ as well as `GtkTreeSelection`. - the `GtkTreePath` for the activated row + the `GtkTreePath` for the activated row - the `GtkTreeViewColumn` in which the activation occurred + the `GtkTreeViewColumn` in which the activation occurred - The given row has been collapsed (child nodes are hidden). + The given row has been collapsed (child nodes are hidden). - the tree iter of the collapsed row + the tree iter of the collapsed row - a tree path that points to the row + a tree path that points to the row - The given row has been expanded (child nodes are shown). + The given row has been expanded (child nodes are shown). - the tree iter of the expanded row + the tree iter of the expanded row - a tree path that points to the row + a tree path that points to the row @@ -97742,37 +102517,37 @@ as well as `GtkTreeSelection`. - The given row is about to be collapsed (hide its children nodes). Use this + The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows. - %FALSE to allow collapsing, %TRUE to reject + %FALSE to allow collapsing, %TRUE to reject - the tree iter of the row to collapse + the tree iter of the row to collapse - a tree path that points to the row + a tree path that points to the row - The given row is about to be expanded (show its children nodes). Use this + The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows. - %FALSE to allow expansion, %TRUE to reject + %FALSE to allow expansion, %TRUE to reject - the tree iter of the row to expand + the tree iter of the row to expand - a tree path that points to the row + a tree path that points to the row @@ -97789,25 +102564,27 @@ signal if you need to control the expandability of individual rows. + + - A `GtkTreeView` + A `GtkTreeView` - The `GtkTreePath` to be activated. + The `GtkTreePath` to be activated. - The `GtkTreeViewColumn` to be activated. + The `GtkTreeViewColumn` to be activated. @@ -97815,6 +102592,7 @@ signal if you need to control the expandability of individual rows. + @@ -97833,6 +102611,7 @@ signal if you need to control the expandability of individual rows. + @@ -97851,6 +102630,7 @@ signal if you need to control the expandability of individual rows. + @@ -97869,6 +102649,7 @@ signal if you need to control the expandability of individual rows. + @@ -97887,6 +102668,7 @@ signal if you need to control the expandability of individual rows. + @@ -97899,6 +102681,7 @@ signal if you need to control the expandability of individual rows. + @@ -97911,6 +102694,7 @@ signal if you need to control the expandability of individual rows. + @@ -97935,6 +102719,7 @@ signal if you need to control the expandability of individual rows. + @@ -97947,6 +102732,7 @@ signal if you need to control the expandability of individual rows. + @@ -97959,6 +102745,7 @@ signal if you need to control the expandability of individual rows. + @@ -97974,6 +102761,7 @@ signal if you need to control the expandability of individual rows. + @@ -97986,6 +102774,7 @@ signal if you need to control the expandability of individual rows. + @@ -98007,6 +102796,7 @@ signal if you need to control the expandability of individual rows. + @@ -98019,6 +102809,7 @@ signal if you need to control the expandability of individual rows. + @@ -98036,7 +102827,7 @@ signal if you need to control the expandability of individual rows. - A visible column in a GtkTreeView widget + A visible column in a GtkTreeView widget The GtkTreeViewColumn object represents a visible column in a `GtkTreeView` widget. It allows to set properties of the column header, and functions as a holding pen @@ -98049,27 +102840,29 @@ the CSS node structure for treeviews and their headers. - Creates a new `GtkTreeViewColumn`. + Creates a new `GtkTreeViewColumn`. + - A newly created `GtkTreeViewColumn`. + A newly created `GtkTreeViewColumn`. - Creates a new `GtkTreeViewColumn` using @area to render its cells. + Creates a new `GtkTreeViewColumn` using @area to render its cells. + - A newly created `GtkTreeViewColumn`. + A newly created `GtkTreeViewColumn`. - the `GtkCellArea` that the newly created column should use to layout cells. + the `GtkCellArea` that the newly created column should use to layout cells. - Creates a new `GtkTreeViewColumn` with a number of default values. + Creates a new `GtkTreeViewColumn` with a number of default values. This is equivalent to calling gtk_tree_view_column_set_title(), gtk_tree_view_column_pack_start(), and gtk_tree_view_column_set_attributes() on the newly created `GtkTreeViewColumn`. @@ -98089,27 +102882,28 @@ Here’s a simple example: NULL); } ]| + - A newly created `GtkTreeViewColumn`. + A newly created `GtkTreeViewColumn`. - The title to set the header to + The title to set the header to - The `GtkCellRenderer` + The `GtkCellRenderer` - A %NULL-terminated list of attributes + A %NULL-terminated list of attributes - Adds an attribute mapping to the list in @tree_column. + Adds an attribute mapping to the list in @tree_column. The @column is the column of the model to get a value from, and the @attribute is the @@ -98117,640 +102911,677 @@ parameter on @cell_renderer to be set from the value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a `GtkCellRendererText` get its values from column 2. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - the `GtkCellRenderer` to set attributes on + the `GtkCellRenderer` to set attributes on - An attribute on the renderer + An attribute on the renderer - The column position on the model to get the attribute from. + The column position on the model to get the attribute from. - Obtains the horizontal position and size of a cell in a column. + Obtains the horizontal position and size of a cell in a column. If the cell is not found in the column, @start_pos and @width are not changed and %FALSE is returned. + - %TRUE if @cell belongs to @tree_column + %TRUE if @cell belongs to @tree_column - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - a `GtkCellRenderer` + a `GtkCellRenderer` - return location for the horizontal + return location for the horizontal position of @cell within @tree_column - return location for the width of @cell + return location for the width of @cell - Obtains the width and height needed to render the column. This is used + Obtains the width and height needed to render the column. This is used primarily by the `GtkTreeView`. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - location to return x offset of a cell relative to @cell_area + location to return x offset of a cell relative to @cell_area - location to return y offset of a cell relative to @cell_area + location to return y offset of a cell relative to @cell_area - location to return width needed to render a cell + location to return width needed to render a cell - location to return height needed to render a cell + location to return height needed to render a cell - Returns %TRUE if any of the cells packed into the @tree_column are visible. + Returns %TRUE if any of the cells packed into the @tree_column are visible. For this to be meaningful, you must first initialize the cells with gtk_tree_view_column_cell_set_cell_data() + - %TRUE, if any of the cells packed into the @tree_column are currently visible + %TRUE, if any of the cells packed into the @tree_column are currently visible - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Sets the cell renderer based on the @tree_model and @iter. That is, for + Sets the cell renderer based on the @tree_model and @iter. That is, for every attribute mapping in @tree_column, it will get a value from the set column on the @iter, and use that value to set the attribute on the cell renderer. This is used primarily by the `GtkTreeView`. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The `GtkTreeModel` to get the cell renderers attributes from. + The `GtkTreeModel` to get the cell renderers attributes from. - The `GtkTreeIter` to get the cell renderer’s attributes from. + The `GtkTreeIter` to get the cell renderer’s attributes from. - %TRUE, if the row has children + %TRUE, if the row has children - %TRUE, if the row has visible children + %TRUE, if the row has visible children - Unsets all the mappings on all renderers on the @tree_column. + Unsets all the mappings on all renderers on the @tree_column. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Clears all existing attributes previously set with + Clears all existing attributes previously set with gtk_tree_view_column_set_attributes(). + - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - a `GtkCellRenderer` to clear the attribute mapping on. + a `GtkCellRenderer` to clear the attribute mapping on. - Emits the “clicked” signal on the column. This function will only work if + Emits the “clicked” signal on the column. This function will only work if @tree_column is clickable. + - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - Sets the current keyboard focus to be at @cell, if the column contains + Sets the current keyboard focus to be at @cell, if the column contains 2 or more editable and activatable cells. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - A `GtkCellRenderer` + A `GtkCellRenderer` - Returns the current x alignment of @tree_column. This value can range + Returns the current x alignment of @tree_column. This value can range between 0.0 and 1.0. + - The current alignent of @tree_column. + The current alignent of @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the button used in the treeview column header + Returns the button used in the treeview column header + - The button for the column header. + The button for the column header. - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Returns %TRUE if the user can click on the header for the column. + Returns %TRUE if the user can click on the header for the column. + - %TRUE if user can click the column header. + %TRUE if user can click the column header. - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - Returns %TRUE if the column expands to fill available space. + Returns %TRUE if the column expands to fill available space. + - %TRUE if the column expands to fill available space. + %TRUE if the column expands to fill available space. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Gets the fixed width of the column. This may not be the actual displayed + Gets the fixed width of the column. This may not be the actual displayed width of the column; for that, use gtk_tree_view_column_get_width(). + - The fixed width of the column. + The fixed width of the column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the maximum width in pixels of the @tree_column, or -1 if no maximum + Returns the maximum width in pixels of the @tree_column, or -1 if no maximum width is set. + - The maximum width of the @tree_column. + The maximum width of the @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the minimum width in pixels of the @tree_column, or -1 if no minimum + Returns the minimum width in pixels of the @tree_column, or -1 if no minimum width is set. + - The minimum width of the @tree_column. + The minimum width of the @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns %TRUE if the @tree_column can be reordered by the user. + Returns %TRUE if the @tree_column can be reordered by the user. + - %TRUE if the @tree_column can be reordered by the user. + %TRUE if the @tree_column can be reordered by the user. - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Returns %TRUE if the @tree_column can be resized by the end user. + Returns %TRUE if the @tree_column can be resized by the end user. + - %TRUE, if the @tree_column can be resized. + %TRUE, if the @tree_column can be resized. - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Returns the current type of @tree_column. + Returns the current type of @tree_column. + - The type of @tree_column. + The type of @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Gets the logical @sort_column_id that the model sorts on + Gets the logical @sort_column_id that the model sorts on when this column is selected for sorting. See [method@Gtk.TreeViewColumn.set_sort_column_id]. + - the current @sort_column_id for this column, or -1 if + the current @sort_column_id for this column, or -1 if this column can’t be used for sorting - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - Gets the value set by gtk_tree_view_column_set_sort_indicator(). + Gets the value set by gtk_tree_view_column_set_sort_indicator(). + - whether the sort indicator arrow is displayed + whether the sort indicator arrow is displayed - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - Gets the value set by gtk_tree_view_column_set_sort_order(). + Gets the value set by gtk_tree_view_column_set_sort_order(). + - the sort order the sort indicator is indicating + the sort order the sort indicator is indicating - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - Returns the spacing of @tree_column. + Returns the spacing of @tree_column. + - the spacing of @tree_column. + the spacing of @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the title of the widget. + Returns the title of the widget. + - the title of the column. This string should not be + the title of the column. This string should not be modified or freed. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the `GtkTreeView` wherein @tree_column has been inserted. + Returns the `GtkTreeView` wherein @tree_column has been inserted. If @column is currently not inserted in any tree view, %NULL is returned. + - The tree view wherein @column + The tree view wherein @column has been inserted - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Returns %TRUE if @tree_column is visible. + Returns %TRUE if @tree_column is visible. + - whether the column is visible or not. If it is visible, then + whether the column is visible or not. If it is visible, then the tree will show the column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the `GtkWidget` in the button on the column header. + Returns the `GtkWidget` in the button on the column header. If a custom widget has not been set then %NULL is returned. + - The `GtkWidget` in the column header + The `GtkWidget` in the column header - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Returns the current size of @tree_column in pixels. + Returns the current size of @tree_column in pixels. + - The current width of @tree_column. + The current width of @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Returns the current X offset of @tree_column in pixels. + Returns the current X offset of @tree_column in pixels. + - The current X offset of @tree_column. + The current X offset of @tree_column. - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - Adds the @cell to end of the column. If @expand is %FALSE, then the @cell + Adds the @cell to end of the column. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The `GtkCellRenderer` + The `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @tree_column. + %TRUE if @cell is to be given extra space allocated to @tree_column. - Packs the @cell into the beginning of the column. If @expand is %FALSE, then + Packs the @cell into the beginning of the column. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The `GtkCellRenderer` + The `GtkCellRenderer` - %TRUE if @cell is to be given extra space allocated to @tree_column. + %TRUE if @cell is to be given extra space allocated to @tree_column. - Flags the column, and the cell renderers added to this column, to have + Flags the column, and the cell renderers added to this column, to have their sizes renegotiated. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - Sets the alignment of the title or custom widget inside the column header. + Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The alignment, which is between [0.0 and 1.0] inclusive. + The alignment, which is between [0.0 and 1.0] inclusive. - Sets the attributes in the list as the attributes of @tree_column. + Sets the attributes in the list as the attributes of @tree_column. The attributes should be in attribute/column order, as in gtk_tree_view_column_add_attribute(). All existing attributes are removed, and replaced with the new attributes. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - the `GtkCellRenderer` we’re setting the attributes of + the `GtkCellRenderer` we’re setting the attributes of - A %NULL-terminated list of attributes + A %NULL-terminated list of attributes - Sets the `GtkTreeCellDataFunc` to use for the column. + Sets the `GtkTreeCellDataFunc` to use for the column. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of @tree_column's cell renderer as appropriate. @func may be %NULL to remove an older one. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - A `GtkCellRenderer` + A `GtkCellRenderer` - The `GtkTreeCellDataFunc` to use. + The `GtkTreeCellDataFunc` to use. - The user data for @func. + The user data for @func. - The destroy notification for @func_data + The destroy notification for @func_data - Sets the header to be active if @clickable is %TRUE. When the header is + Sets the header to be active if @clickable is %TRUE. When the header is active, then it can take keyboard focus, and can be clicked. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - %TRUE if the header is active. + %TRUE if the header is active. - Sets the column to take available extra space. This space is shared equally + Sets the column to take available extra space. This space is shared equally amongst all columns that have the expand set to %TRUE. If no column has this option set, then the last column gets all extra space. By default, every column is created with this %FALSE. Along with “fixed-width”, the “expand” property changes when the column is resized by the user. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - %TRUE if the column should expand to fill available space. + %TRUE if the column should expand to fill available space. - If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise + If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise unsets it. The effective value of @fixed_width is clamped between the minimum and maximum width of the column; however, the value stored in the “fixed-width” property is not clamped. If the column sizing is @@ -98761,148 +103592,156 @@ column may be greater or less than requested. Along with “expand”, the “fixed-width” property changes when the column is resized by the user. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The new fixed width, in pixels, or -1. + The new fixed width, in pixels, or -1. - Sets the maximum width of the @tree_column. If @max_width is -1, then the + Sets the maximum width of the @tree_column. If @max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it’s the last column in a view. In this case, the column expands to fill any extra space. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The maximum width of the column in pixels, or -1. + The maximum width of the column in pixels, or -1. - Sets the minimum width of the @tree_column. If @min_width is -1, then the + Sets the minimum width of the @tree_column. If @min_width is -1, then the minimum width is unset. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The minimum width of the column in pixels, or -1. + The minimum width of the column in pixels, or -1. - If @reorderable is %TRUE, then the column can be reordered by the end user + If @reorderable is %TRUE, then the column can be reordered by the end user dragging the header. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - %TRUE, if the column can be reordered. + %TRUE, if the column can be reordered. - If @resizable is %TRUE, then the user can explicitly resize the column by + If @resizable is %TRUE, then the user can explicitly resize the column by grabbing the outer edge of the column button. If resizable is %TRUE and sizing mode of the column is %GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing mode is changed to %GTK_TREE_VIEW_COLUMN_GROW_ONLY. + - A `GtkTreeViewColumn` + A `GtkTreeViewColumn` - %TRUE, if the column can be resized + %TRUE, if the column can be resized - Sets the growth behavior of @tree_column to @type. + Sets the growth behavior of @tree_column to @type. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The `GtkTreeViewColumn`Sizing. + The `GtkTreeViewColumn`Sizing. - Sets the logical @sort_column_id that this column sorts on when this column + Sets the logical @sort_column_id that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable. + - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - The @sort_column_id of the model to sort on. + The @sort_column_id of the model to sort on. - Call this function with a @setting of %TRUE to display an arrow in + Call this function with a @setting of %TRUE to display an arrow in the header button indicating the column is sorted. Call gtk_tree_view_column_set_sort_order() to change the direction of the arrow. + - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - %TRUE to display an indicator that the column is sorted + %TRUE to display an indicator that the column is sorted - Changes the appearance of the sort indicator. + Changes the appearance of the sort indicator. This does not actually sort the model. Use gtk_tree_view_column_set_sort_column_id() if you want automatic sorting @@ -98913,83 +103752,88 @@ that. For custom models, the mechanism will vary. The sort indicator changes direction to indicate normal sort or reverse sort. Note that you must have the sort indicator enabled to see anything when calling this function; see gtk_tree_view_column_set_sort_indicator(). + - a `GtkTreeViewColumn` + a `GtkTreeViewColumn` - sort order that the sort indicator should indicate + sort order that the sort indicator should indicate - Sets the spacing field of @tree_column, which is the number of pixels to + Sets the spacing field of @tree_column, which is the number of pixels to place between cell renderers packed into it. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - distance between cell renderers in pixels. + distance between cell renderers in pixels. - Sets the title of the @tree_column. If a custom widget has been set, then + Sets the title of the @tree_column. If a custom widget has been set, then this value is ignored. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - The title of the @tree_column. + The title of the @tree_column. - Sets the visibility of @tree_column. + Sets the visibility of @tree_column. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - %TRUE if the @tree_column is visible. + %TRUE if the @tree_column is visible. - Sets the widget in the header to be @widget. If widget is %NULL, then the + Sets the widget in the header to be @widget. If widget is %NULL, then the header button is set with a `GtkLabel` set to the title of @tree_column. + - A `GtkTreeViewColumn`. + A `GtkTreeViewColumn`. - A child `GtkWidget` + A child `GtkWidget` @@ -98998,7 +103842,7 @@ header button is set with a `GtkLabel` set to the title of @tree_column. - The `GtkCellArea` used to layout cell renderers for this column. + The `GtkCellArea` used to layout cell renderers for this column. If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area() a horizontally oriented `GtkCellAreaBox` will be used. @@ -99029,7 +103873,7 @@ a horizontally oriented `GtkCellAreaBox` will be used. - Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header + Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header clickable. Set to -1 to make the column unsortable. @@ -99058,14 +103902,14 @@ clickable. Set to -1 to make the column unsortable. - Emitted when the column's header has been clicked. + Emitted when the column's header has been clicked. - Function type for determining whether @column can be dropped in a + Function type for determining whether @column can be dropped in a particular spot (as determined by @prev_column and @next_column). In left to right locales, @prev_column is on the left of the potential drop spot, and @next_column is on the right. In right to left mode, this is @@ -99073,191 +103917,198 @@ reversed. This function should return %TRUE if the spot is a valid drop spot. Please note that returning %TRUE does not actually indicate that the column drop was made, but is meant only to indicate a possible drop spot to the user. + - %TRUE, if @column can be dropped in this spot + %TRUE, if @column can be dropped in this spot - A `GtkTreeView` + A `GtkTreeView` - The `GtkTreeViewColumn` being dragged + The `GtkTreeViewColumn` being dragged - A `GtkTreeViewColumn` on one side of @column + A `GtkTreeViewColumn` on one side of @column - A `GtkTreeViewColumn` on the other side of @column + A `GtkTreeViewColumn` on the other side of @column - user data + user data - The sizing method the column uses to determine its width. Please note + The sizing method the column uses to determine its width. Please note that %GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and can make columns appear choppy. - Columns only get bigger in reaction to changes in the model + Columns only get bigger in reaction to changes in the model - Columns resize to be the optimal size every time the model changes. + Columns resize to be the optimal size every time the model changes. - Columns are a fixed numbers of pixels wide. + Columns are a fixed numbers of pixels wide. - An enum for determining where a dropped row goes. + An enum for determining where a dropped row goes. - dropped row is inserted before + dropped row is inserted before - dropped row is inserted after + dropped row is inserted after - dropped row becomes a child or is inserted before + dropped row becomes a child or is inserted before - dropped row becomes a child or is inserted after + dropped row becomes a child or is inserted after - Used to indicate which grid lines to draw in a tree view. + Used to indicate which grid lines to draw in a tree view. - No grid lines. + No grid lines. - Horizontal grid lines. + Horizontal grid lines. - Vertical grid lines. + Vertical grid lines. - Horizontal and vertical grid lines. + Horizontal and vertical grid lines. - Function used for gtk_tree_view_map_expanded_rows(). + Function used for gtk_tree_view_map_expanded_rows(). + - A `GtkTreeView` + A `GtkTreeView` - The path that’s expanded + The path that’s expanded - user data + user data - Function type for determining whether the row pointed to by @iter should + Function type for determining whether the row pointed to by @iter should be rendered as a separator. A common way to implement this is to have a boolean column in the model, whose values the `GtkTreeViewRowSeparatorFunc` returns. + - %TRUE if the row is a separator + %TRUE if the row is a separator - the `GtkTreeModel` + the `GtkTreeModel` - a `GtkTreeIter` pointing at a row in @model + a `GtkTreeIter` pointing at a row in @model - user data + user data - A function used for checking whether a row in @model matches + A function used for checking whether a row in @model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp() returning 0 for equal strings. + - %FALSE if the row matches, %TRUE otherwise. + %FALSE if the row matches, %TRUE otherwise. - the `GtkTreeModel` being searched + the `GtkTreeModel` being searched - the search column set by gtk_tree_view_set_search_column() + the search column set by gtk_tree_view_set_search_column() - the key string to compare with + the key string to compare with - a `GtkTreeIter` pointing the row of @model that should be compared + a `GtkTreeIter` pointing the row of @model that should be compared with @key. - user data from gtk_tree_view_set_search_equal_func() + user data from gtk_tree_view_set_search_equal_func() - See also gtk_print_settings_set_paper_width(). + See also gtk_print_settings_set_paper_width(). - No units. + No units. - Dimensions in points. + Dimensions in points. - Dimensions in inches. + Dimensions in inches. - Dimensions in millimeters + Dimensions in millimeters - Evaluates to %TRUE if @value was initialized with %GTK_TYPE_EXPRESSION. + Evaluates to %TRUE if @value was initialized with %GTK_TYPE_EXPRESSION. + - a `GValue` + a `GValue` + + - `GtkVideo` is a widget to show a `GtkMediaStream` with media controls. + `GtkVideo` is a widget to show a `GtkMediaStream` with media controls. ![An example GtkVideo](video.png) @@ -99271,204 +104122,218 @@ not have support for video overlays, multichannel audio, device selection, or input. If you are writing a full-fledged video player, you may want to use the [class@Gdk.Paintable] API and a media framework such as Gstreamer directly. + - Creates a new empty `GtkVideo`. + Creates a new empty `GtkVideo`. + - a new `GtkVideo` + a new `GtkVideo` - Creates a `GtkVideo` to play back the given @file. + Creates a `GtkVideo` to play back the given @file. + - a new `GtkVideo` + a new `GtkVideo` - a `GFile` + a `GFile` - Creates a `GtkVideo` to play back the given @filename. + Creates a `GtkVideo` to play back the given @filename. This is a utility function that calls [ctor@Gtk.Video.new_for_file], See that function for details. + - a new `GtkVideo` + a new `GtkVideo` - filename to play back + filename to play back - Creates a `GtkVideo` to play back the given @stream. + Creates a `GtkVideo` to play back the given @stream. + - a new `GtkVideo` + a new `GtkVideo` - a `GtkMediaStream` + a `GtkMediaStream` - Creates a `GtkVideo` to play back the resource at the + Creates a `GtkVideo` to play back the resource at the given @resource_path. This is a utility function that calls [ctor@Gtk.Video.new_for_file]. + - a new `GtkVideo` + a new `GtkVideo` - resource path to play back + resource path to play back - Returns %TRUE if videos have been set to loop. + Returns %TRUE if videos have been set to loop. + - %TRUE if streams should autoplay + %TRUE if streams should autoplay - a `GtkVideo` + a `GtkVideo` - Gets the file played by @self or %NULL if not playing back + Gets the file played by @self or %NULL if not playing back a file. + - The file played by @self + The file played by @self - a `GtkVideo` + a `GtkVideo` - Returns %TRUE if videos have been set to loop. + Returns %TRUE if videos have been set to loop. + - %TRUE if streams should loop + %TRUE if streams should loop - a `GtkVideo` + a `GtkVideo` - Gets the media stream managed by @self or %NULL if none. + Gets the media stream managed by @self or %NULL if none. + - The media stream managed by @self + The media stream managed by @self - a `GtkVideo` + a `GtkVideo` - Sets whether @self automatically starts playback when it + Sets whether @self automatically starts playback when it becomes visible or when a new file gets loaded. + - a `GtkVideo` + a `GtkVideo` - whether media streams should autoplay + whether media streams should autoplay - Makes @self play the given @file. + Makes @self play the given @file. + - a `GtkVideo` + a `GtkVideo` - the file to play + the file to play - Makes @self play the given @filename. + Makes @self play the given @filename. This is a utility function that calls gtk_video_set_file(), + - a `GtkVideo` + a `GtkVideo` - the filename to play + the filename to play - Sets whether new files loaded by @self should be set to loop. + Sets whether new files loaded by @self should be set to loop. + - a `GtkVideo` + a `GtkVideo` - whether media streams should loop + whether media streams should loop - Sets the media stream to be played back. + Sets the media stream to be played back. @self will take full control of managing the media stream. If you want to manage a media stream yourself, consider using a @@ -99476,34 +104341,36 @@ want to manage a media stream yourself, consider using a If you want to display a file, consider using [method@Gtk.Video.set_file] instead. + - a `GtkVideo` + a `GtkVideo` - The media stream to play or %NULL to unset + The media stream to play or %NULL to unset - Makes @self play the resource at the given @resource_path. + Makes @self play the resource at the given @resource_path. This is a utility function that calls [method@Gtk.Video.set_file]. + - a `GtkVideo` + a `GtkVideo` - the resource to set + the resource to set @@ -99511,35 +104378,36 @@ This is a utility function that calls [method@Gtk.Video.set_file]. - If the video should automatically begin playing. + If the video should automatically begin playing. - The file played by this video if the video is playing a file. + The file played by this video if the video is playing a file. - If new media files should be set to loop. + If new media files should be set to loop. - The media-stream played + The media-stream played + - `GtkViewport` implements scrollability for widgets that lack their + `GtkViewport` implements scrollability for widgets that lack their own scrolling capabilities. Use `GtkViewport` to scroll child widgets such as `GtkGrid`, @@ -99560,85 +104428,90 @@ less than the child widget’s minimum size in a given orientation. - Creates a new `GtkViewport`. + Creates a new `GtkViewport`. The new viewport uses the given adjustments, or default adjustments if none are given. + - a new `GtkViewport` + a new `GtkViewport` - horizontal adjustment + horizontal adjustment - vertical adjustment + vertical adjustment - Gets the child widget of @viewport. + Gets the child widget of @viewport. + - the child widget of @viewport + the child widget of @viewport - a `GtkViewport` + a `GtkViewport` - Gets whether the viewport is scrolling to keep the focused + Gets whether the viewport is scrolling to keep the focused child in view. + - %TRUE if the viewport keeps the focus child scrolled to view + %TRUE if the viewport keeps the focus child scrolled to view - a `GtkViewport` + a `GtkViewport` - Sets the child widget of @viewport. + Sets the child widget of @viewport. + - a `GtkViewport` + a `GtkViewport` - the child widget + the child widget - Sets whether the viewport should automatically scroll + Sets whether the viewport should automatically scroll to keep the focused child in view. + - a `GtkViewport` + a `GtkViewport` - whether to keep the focus widget scrolled to view + whether to keep the focus widget scrolled to view @@ -99646,18 +104519,18 @@ to keep the focused child in view. - The child widget. + The child widget. - Whether to scroll when the focus changes. + Whether to scroll when the focus changes. - `GtkVolumeButton` is a `GtkScaleButton` subclass tailored for + `GtkVolumeButton` is a `GtkScaleButton` subclass tailored for volume control. ![An example GtkVolumeButton](volumebutton.png) @@ -99666,18 +104539,19 @@ volume control. - Creates a `GtkVolumeButton`. + Creates a `GtkVolumeButton`. The button has a range between 0.0 and 1.0, with a stepping of 0.02. Volume values can be obtained and modified using the functions from [class@Gtk.ScaleButton]. + - a new `GtkVolumeButton` + a new `GtkVolumeButton` - Whether to use symbolic icons as the icons. + Whether to use symbolic icons as the icons. Note that if the symbolic icons are not available in your installed theme, then the normal (potentially colorful) icons will be used. @@ -99688,61 +104562,70 @@ theme, then the normal (potentially colorful) icons will be used. + + + + + + + + + - The base class for all widgets. + The base class for all widgets. `GtkWidget` is the base class all widgets in GTK derive from. It manages the widget lifecycle, layout, states and style. @@ -100100,33 +104983,37 @@ foo_widget_class_init (FooWidgetClass *klass) gtk_widget_class_bind_template_callback (GTK_WIDGET_CLASS (klass), hello_button_clicked); } ``` + - Obtains the current default reading direction. + Obtains the current default reading direction. See [func@Gtk.Widget.set_default_direction]. + - the current default direction. + the current default direction. - Sets the default reading direction for widgets. + Sets the default reading direction for widgets. See [method@Gtk.Widget.set_direction]. + - the new default direction. This cannot be %GTK_TEXT_DIR_NONE. + the new default direction. This cannot be %GTK_TEXT_DIR_NONE. + @@ -100143,30 +105030,32 @@ See [method@Gtk.Widget.set_direction]. - Tests if the point at (@x, @y) is contained in @widget. + Tests if the point at (@x, @y) is contained in @widget. The coordinates for (@x, @y) must be in widget coordinates, so (0, 0) is assumed to be the top left of @widget's content area. + - %TRUE if @widget contains (@x, @y). + %TRUE if @widget contains (@x, @y). - the widget to query + the widget to query - X coordinate to test, relative to @widget's origin + X coordinate to test, relative to @widget's origin - Y coordinate to test, relative to @widget's origin + Y coordinate to test, relative to @widget's origin + @@ -100180,6 +105069,7 @@ The coordinates for (@x, @y) must be in widget coordinates, so + @@ -100193,6 +105083,7 @@ The coordinates for (@x, @y) must be in widget coordinates, so + @@ -100206,26 +105097,27 @@ The coordinates for (@x, @y) must be in widget coordinates, so - Gets whether the widget prefers a height-for-width layout + Gets whether the widget prefers a height-for-width layout or a width-for-height layout. Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities. + - The `GtkSizeRequestMode` preferred by @widget. + The `GtkSizeRequestMode` preferred by @widget. - a `GtkWidget` instance + a `GtkWidget` instance - Causes @widget to have the keyboard focus for the `GtkWindow` it's inside. + Causes @widget to have the keyboard focus for the `GtkWindow` it's inside. If @widget is not focusable, or its [vfunc@Gtk.Widget.grab_focus] implementation cannot transfer the focus to a descendant of @widget @@ -100233,33 +105125,35 @@ that is focusable, it will not take focus and %FALSE will be returned. Calling [method@Gtk.Widget.grab_focus] on an already focused widget is allowed, should not have an effect, and return %TRUE. + - %TRUE if focus is now inside @widget. + %TRUE if focus is now inside @widget. - a `GtkWidget` + a `GtkWidget` - Reverses the effects of gtk_widget_show(). + Reverses the effects of gtk_widget_show(). This is causing the widget to be hidden (invisible to the user). + - a `GtkWidget` + a `GtkWidget` - Emits the `::keynav-failed` signal on the widget. + Emits the `::keynav-failed` signal on the widget. This function should be called whenever keyboard navigation within a single widget hits a boundary. @@ -100286,39 +105180,41 @@ A use case for providing an own implementation of ::keynav-failed [class@Gtk.Entry] widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys. + - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - a `GtkWidget` + a `GtkWidget` - direction of focus movement + direction of focus movement - Causes a widget to be mapped if it isn’t already. + Causes a widget to be mapped if it isn’t already. This function is only for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Measures @widget in the orientation @orientation and for the given @for_size. + Measures @widget in the orientation @orientation and for the given @for_size. As an example, if @orientation is %GTK_ORIENTATION_HORIZONTAL and @for_size is 300, this functions will compute the minimum and natural width of @widget @@ -100326,20 +105222,21 @@ if it is allocated at a height of 300 pixels. See [GtkWidget’s geometry management section](class.Widget.html#height-for-width-geometry-management) for a more details on implementing `GtkWidgetClass.measure()`. + - A `GtkWidget` instance + A `GtkWidget` instance - the orientation to measure + the orientation to measure - Size for the opposite of @orientation, i.e. + Size for the opposite of @orientation, i.e. if @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height @@ -100347,45 +105244,47 @@ a more details on implementing `GtkWidgetClass.measure()`. - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - location to store the baseline + location to store the baseline position for the minimum size - location to store the baseline + location to store the baseline position for the natural size - Emits the ::mnemonic-activate signal. + Emits the ::mnemonic-activate signal. See [signal@Gtk.Widget::mnemonic-activate]. + - %TRUE if the signal has been handled + %TRUE if the signal has been handled - a `GtkWidget` + a `GtkWidget` - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic + @@ -100399,6 +105298,7 @@ See [signal@Gtk.Widget::mnemonic-activate]. + @@ -100421,7 +105321,7 @@ See [signal@Gtk.Widget::mnemonic-activate]. - Creates the GDK resources associated with a widget. + Creates the GDK resources associated with a widget. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized @@ -100437,17 +105337,19 @@ isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as [signal@Gtk.Widget::realize]. + - a `GtkWidget` + a `GtkWidget` + @@ -100458,28 +105360,29 @@ called after the widget is realized automatically, such as - Set @child as the current focus child of @widget. + Set @child as the current focus child of @widget. This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call [method@Gtk.Widget.grab_focus] on it. + - a `GtkWidget` + a `GtkWidget` - a direct child widget of @widget or %NULL + a direct child widget of @widget or %NULL to unset the focus child of @widget - Flags a widget to be displayed. + Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. @@ -100489,17 +105392,19 @@ in addition to the widget itself, before it will appear onscreen. When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped. + - a `GtkWidget` + a `GtkWidget` + @@ -100519,6 +105424,7 @@ toplevel container is realized and mapped. + @@ -100532,6 +105438,7 @@ toplevel container is realized and mapped. + @@ -100545,6 +105452,7 @@ toplevel container is realized and mapped. + @@ -100558,35 +105466,38 @@ toplevel container is realized and mapped. - Causes a widget to be unmapped if it’s currently mapped. + Causes a widget to be unmapped if it’s currently mapped. This function is only for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Causes a widget to be unrealized (frees all GDK resources + Causes a widget to be unrealized (frees all GDK resources associated with the widget). This function is only useful in widget implementations. + - a `GtkWidget` + a `GtkWidget` + @@ -100597,28 +105508,29 @@ This function is only useful in widget implementations. - Enable or disable an action installed with + Enable or disable an action installed with gtk_widget_class_install_action(). + - a `GtkWidget` + a `GtkWidget` - action name, such as "clipboard.paste" + action name, such as "clipboard.paste" - whether the action is now enabled + whether the action is now enabled - For widgets that can be “activated” (buttons, menu items, etc.), + For widgets that can be “activated” (buttons, menu items, etc.), this function activates them. The activation will emit the signal set using @@ -100632,50 +105544,52 @@ recommended to use [method@Gtk.WidgetClass.add_shortcut] with an action created with [ctor@Gtk.SignalAction.new]. If @widget isn't activatable, the function returns %FALSE. + - %TRUE if the widget was activatable + %TRUE if the widget was activatable - a `GtkWidget` that’s activatable + a `GtkWidget` that’s activatable - Looks up the action in the action groups associated + Looks up the action in the action groups associated with @widget and its ancestors, and activates it. This is a wrapper around [method@Gtk.Widget.activate_action_variant] that constructs the @args variant according to @format_string. + - %TRUE if the action was activated, %FALSE if the action + %TRUE if the action was activated, %FALSE if the action does not exist - a `GtkWidget` + a `GtkWidget` - the name of the action to activate + the name of the action to activate - GVariant format string for arguments or %NULL + GVariant format string for arguments or %NULL for no arguments - arguments, as given by format string + arguments, as given by format string - Looks up the action in the action groups associated with + Looks up the action in the action groups associated with @widget and its ancestors, and activates it. If the action is in an action group added with @@ -100685,104 +105599,109 @@ inserted. The arguments must match the actions expected parameter type, as returned by `g_action_get_parameter_type()`. + - %TRUE if the action was activated, %FALSE if the + %TRUE if the action was activated, %FALSE if the action does not exist. - a `GtkWidget` + a `GtkWidget` - the name of the action to activate + the name of the action to activate - parameters to use + parameters to use - Activates the `default.activate` action from @widget. + Activates the `default.activate` action from @widget. + - a `GtkWidget` + a `GtkWidget` - Adds @controller to @widget so that it will receive events. + Adds @controller to @widget so that it will receive events. You will usually want to call this function right after creating any kind of [class@Gtk.EventController]. + - a `GtkWidget` + a `GtkWidget` - a `GtkEventController` that hasn't been + a `GtkEventController` that hasn't been added to a widget yet - Adds a style class to @widget. + Adds a style class to @widget. After calling this function, the widgets style will match for @css_class, according to CSS matching rules. Use [method@Gtk.Widget.remove_css_class] to remove the style again. + - a `GtkWidget` + a `GtkWidget` - The style class to add to @widget, without + The style class to add to @widget, without the leading '.' used for notation of style classes - Adds a widget to the list of mnemonic labels for this widget. + Adds a widget to the list of mnemonic labels for this widget. See [method@Gtk.Widget.list_mnemonic_labels]. Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well. + - a `GtkWidget` + a `GtkWidget` - a `GtkWidget` that acts as a mnemonic label for @widget + a `GtkWidget` that acts as a mnemonic label for @widget - Queues an animation frame update and adds a callback to be called + Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently @@ -100804,33 +105723,34 @@ trying to display isolated frames at particular times. This is a more convenient alternative to connecting directly to the [signal@Gdk.FrameClock::update] signal of `GdkFrameClock`, since you don't have to worry about when a `GdkFrameClock` is assigned to a widget. + - an id for the connection of this callback. Remove the callback + an id for the connection of this callback. Remove the callback by passing the id returned from this function to [method@Gtk.Widget.remove_tick_callback] - a `GtkWidget` + a `GtkWidget` - function to call for updating animations + function to call for updating animations - data to pass to @callback + data to pass to @callback - function to call to free @user_data when the callback is removed. + function to call to free @user_data when the callback is removed. - This function is only used by `GtkWidget` subclasses, to + This function is only used by `GtkWidget` subclasses, to assign a size, position and (optionally) baseline to their child widgets. @@ -100840,34 +105760,35 @@ widget's minimum size, as well as at least 0×0 in size. For a version that does not take a transform, see [method@Gtk.Widget.size_allocate]. + - A `GtkWidget` + A `GtkWidget` - New width of @widget + New width of @widget - New height of @widget + New height of @widget - New baseline of @widget, or -1 + New baseline of @widget, or -1 - Transformation to be applied to @widget + Transformation to be applied to @widget - Called by widgets as the user moves around the window using + Called by widgets as the user moves around the window using keyboard shortcuts. The @direction argument indicates what kind of motion is taking place (up, @@ -100887,23 +105808,24 @@ the current focus location. This function is used by custom widget implementations; if you're writing an app, you’d use [method@Gtk.Widget.grab_focus] to move the focus to a particular widget. + - %TRUE if focus ended up inside @widget + %TRUE if focus ended up inside @widget - a `GtkWidget` + a `GtkWidget` - direction of focus movement + direction of focus movement - Computes the bounds for @widget in the coordinate space of @target. + Computes the bounds for @widget in the coordinate space of @target. FIXME: Explain what "bounds" are. @@ -100913,27 +105835,28 @@ bounds or the bounds cannot be expressed in @target's coordinate space returned and @bounds is set to the zero rectangle. It is valid for @widget and @target to be the same widget. + - %TRUE if the bounds could be computed + %TRUE if the bounds could be computed - the `GtkWidget` to query + the `GtkWidget` to query - the `GtkWidget` + the `GtkWidget` - the rectangle taking the bounds + the rectangle taking the bounds - Computes whether a container should give this widget + Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at @@ -100946,122 +105869,127 @@ widgets are not expanded. The computed expand value uses either the expand setting explicitly set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do. + - whether widget tree rooted here should be expanded + whether widget tree rooted here should be expanded - the widget + the widget - expand direction + expand direction - Translates the given @point in @widget's coordinates to coordinates + Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system. In order to perform this operation, both widgets must share a common ancestor. + - %TRUE if the point could be determined, %FALSE on failure. + %TRUE if the point could be determined, %FALSE on failure. In this case, 0 is stored in @out_point. - the `GtkWidget` to query + the `GtkWidget` to query - the `GtkWidget` to transform into + the `GtkWidget` to transform into - a point in @widget's coordinate system + a point in @widget's coordinate system - Set to the corresponding coordinates in + Set to the corresponding coordinates in @target's coordinate system - Computes a matrix suitable to describe a transformation from + Computes a matrix suitable to describe a transformation from @widget's coordinate system into @target's coordinate system. The transform can not be computed in certain cases, for example when @widget and @target do not share a common ancestor. In that case @out_transform gets set to the identity matrix. + - %TRUE if the transform could be computed, %FALSE otherwise + %TRUE if the transform could be computed, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - the target widget that the matrix will transform to + the target widget that the matrix will transform to - location to + location to store the final transformation - Tests if the point at (@x, @y) is contained in @widget. + Tests if the point at (@x, @y) is contained in @widget. The coordinates for (@x, @y) must be in widget coordinates, so (0, 0) is assumed to be the top left of @widget's content area. + - %TRUE if @widget contains (@x, @y). + %TRUE if @widget contains (@x, @y). - the widget to query + the widget to query - X coordinate to test, relative to @widget's origin + X coordinate to test, relative to @widget's origin - Y coordinate to test, relative to @widget's origin + Y coordinate to test, relative to @widget's origin - Creates a new `PangoContext` with the appropriate font map, + Creates a new `PangoContext` with the appropriate font map, font options, font description, and base direction for drawing text for this widget. See also [method@Gtk.Widget.get_pango_context]. + - the new `PangoContext` + the new `PangoContext` - a `GtkWidget` + a `GtkWidget` - Creates a new `PangoLayout` with the appropriate font map, + Creates a new `PangoLayout` with the appropriate font map, font description, and base direction for drawing text for this widget. @@ -101069,52 +105997,54 @@ If you keep a `PangoLayout` created in this way around, you need to re-create it when the widget `PangoContext` is replaced. This can be tracked by listening to changes of the [property@Gtk.Widget:root] property on the widget. + - the new `PangoLayout` + the new `PangoLayout` - a `GtkWidget` + a `GtkWidget` - text to set on the layout + text to set on the layout - Checks to see if a drag movement has passed the GTK drag threshold. + Checks to see if a drag movement has passed the GTK drag threshold. + - %TRUE if the drag threshold has been passed. + %TRUE if the drag threshold has been passed. - a `GtkWidget` + a `GtkWidget` - X coordinate of start of drag + X coordinate of start of drag - Y coordinate of start of drag + Y coordinate of start of drag - current X coordinate + current X coordinate - current Y coordinate + current Y coordinate - Notifies the user about an input-related error on this widget. + Notifies the user about an input-related error on this widget. If the [property@Gtk.Settings:gtk-error-bell] setting is %TRUE, it calls [method@Gdk.Surface.beep], otherwise it does nothing. @@ -101122,61 +106052,65 @@ it calls [method@Gdk.Surface.beep], otherwise it does nothing. Note that the effect of [method@Gdk.Surface.beep] can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used. + - a `GtkWidget` + a `GtkWidget` - Returns the baseline that has currently been allocated to @widget. + Returns the baseline that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the `GtkWidget`Class.snapshot() function, and when allocating child widgets in `GtkWidget`Class.size_allocate(). + - the baseline of the @widget, or -1 if none + the baseline of the @widget, or -1 if none - the widget to query + the widget to query - Returns the height that has currently been allocated to @widget. + Returns the height that has currently been allocated to @widget. + - the height of the @widget + the height of the @widget - the widget to query + the widget to query - Returns the width that has currently been allocated to @widget. + Returns the width that has currently been allocated to @widget. + - the width of the @widget + the width of the @widget - the widget to query + the widget to query - Retrieves the widget’s allocation. + Retrieves the widget’s allocation. Note, when implementing a layout container: a widget’s allocation will be its “adjusted” allocation, that is, the widget’s parent @@ -101191,22 +106125,23 @@ guaranteed to be completely contained within the So a layout container is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the container assigned. + - a `GtkWidget` + a `GtkWidget` - a pointer to a `GtkAllocation` to copy to + a pointer to a `GtkAllocation` to copy to - Gets the first ancestor of @widget with type @widget_type. + Gets the first ancestor of @widget with type @widget_type. For example, `gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)` gets the first `GtkBox` that’s an ancestor of @widget. No @@ -101215,95 +106150,101 @@ not be unreferenced. Note that unlike [method@Gtk.Widget.is_ancestor], this function considers @widget to be an ancestor of itself. + - the ancestor widget + the ancestor widget - a `GtkWidget` + a `GtkWidget` - ancestor type + ancestor type - Determines whether the input focus can enter @widget or any + Determines whether the input focus can enter @widget or any of its children. See [method@Gtk.Widget.set_focusable]. + - %TRUE if the input focus can enter @widget, %FALSE otherwise + %TRUE if the input focus can enter @widget, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - Queries whether @widget can be the target of pointer events. + Queries whether @widget can be the target of pointer events. + - %TRUE if @widget can receive pointer events + %TRUE if @widget can receive pointer events - a `GtkWidget` + a `GtkWidget` - Gets the value set with gtk_widget_set_child_visible(). + Gets the value set with gtk_widget_set_child_visible(). If you feel a need to use this function, your code probably needs reorganization. This function is only useful for container implementations and should never be called by an application. + - %TRUE if the widget is mapped with the parent. + %TRUE if the widget is mapped with the parent. - a `GtkWidget` + a `GtkWidget` - Gets the clipboard object for @widget. + Gets the clipboard object for @widget. This is a utility function to get the clipboard object for the `GdkDisplay` that @widget is using. Note that this function always works, even when @widget is not realized yet. + - the appropriate clipboard object + the appropriate clipboard object - a `GtkWidget` + a `GtkWidget` - Returns the list of style classes applied to @widget. + Returns the list of style classes applied to @widget. + - a %NULL-terminated list of + a %NULL-terminated list of css classes currently applied to @widget. The returned list must freed using g_strfreev(). @@ -101312,59 +106253,62 @@ realized yet. - a `GtkWidget` + a `GtkWidget` - Returns the CSS name that is used for @self. + Returns the CSS name that is used for @self. + - the CSS name + the CSS name - a `GtkWidget` + a `GtkWidget` - Queries the cursor set on @widget. + Queries the cursor set on @widget. See [method@Gtk.Widget.set_cursor] for details. + - the cursor + the cursor currently in use or %NULL if the cursor is inherited - a `GtkWidget` + a `GtkWidget` - Gets the reading direction for a particular widget. + Gets the reading direction for a particular widget. See [method@Gtk.Widget.set_direction]. + - the reading direction for the widget. + the reading direction for the widget. - a `GtkWidget` + a `GtkWidget` - Get the `GdkDisplay` for the toplevel window associated with + Get the `GdkDisplay` for the toplevel window associated with this widget. This function can only be called after the widget has been @@ -101373,114 +106317,121 @@ added to a widget hierarchy with a `GtkWindow` at the top. In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized. + - the `GdkDisplay` for the toplevel + the `GdkDisplay` for the toplevel for this widget. - a `GtkWidget` + a `GtkWidget` - Returns the widgets first child. + Returns the widgets first child. This API is primarily meant for widget implementations. + - The widget's first child + The widget's first child - a `GtkWidget` + a `GtkWidget` - Returns the current focus child of @widget. + Returns the current focus child of @widget. + - The current focus + The current focus child of @widget - a `GtkWidget` + a `GtkWidget` - Returns whether the widget should grab focus when it is clicked + Returns whether the widget should grab focus when it is clicked with the mouse. See [method@Gtk.Widget.set_focus_on_click]. + - %TRUE if the widget should grab focus when it is + %TRUE if the widget should grab focus when it is clicked with the mouse - a `GtkWidget` + a `GtkWidget` - Determines whether @widget can own the input focus. + Determines whether @widget can own the input focus. See [method@Gtk.Widget.set_focusable]. + - %TRUE if @widget can own the input focus, %FALSE otherwise + %TRUE if @widget can own the input focus, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - Gets the font map of @widget. + Gets the font map of @widget. See [method@Gtk.Widget.set_font_map]. + - A `PangoFontMap` + A `PangoFontMap` - a `GtkWidget` + a `GtkWidget` - Returns the `cairo_font_options_t` of widget. + Returns the `cairo_font_options_t` of widget. Seee [method@Gtk.Widget.set_font_options]. + - the `cairo_font_options_t` + the `cairo_font_options_t` of widget - a `GtkWidget` + a `GtkWidget` - Obtains the frame clock for a widget. + Obtains the frame clock for a widget. The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame @@ -101502,72 +106453,76 @@ mapped. Reparenting a widget (which implies a temporary unmap) can change the widget’s frame clock. Unrealized widgets do not have a frame clock. + - a `GdkFrameClock` + a `GdkFrameClock` - a `GtkWidget` + a `GtkWidget` - Gets the horizontal alignment of @widget. + Gets the horizontal alignment of @widget. For backwards compatibility reasons this method will never return %GTK_ALIGN_BASELINE, but instead it will convert it to %GTK_ALIGN_FILL. Baselines are not supported for horizontal alignment. + - the horizontal alignment of @widget + the horizontal alignment of @widget - a `GtkWidget` + a `GtkWidget` - Returns the current value of the `has-tooltip` property. + Returns the current value of the `has-tooltip` property. + - current value of `has-tooltip` on @widget. + current value of `has-tooltip` on @widget. - a `GtkWidget` + a `GtkWidget` - Returns the content height of the widget. + Returns the content height of the widget. This function returns the height passed to its size-allocate implementation, which is the height you should be using in [vfunc@Gtk.Widget.snapshot]. For pointer events, see [method@Gtk.Widget.contains]. + - The height of @widget + The height of @widget - a `GtkWidget` + a `GtkWidget` - Gets whether the widget would like any available extra horizontal + Gets whether the widget would like any available extra horizontal space. When a user resizes a `GtkWindow`, widgets with expand=TRUE @@ -101583,20 +106538,21 @@ expand, the parent may ask to expand also. This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand. + - whether hexpand flag is set + whether hexpand flag is set - the widget + the widget - Gets whether gtk_widget_set_hexpand() has been used + Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget. If [property@Gtk.Widget:hexpand] property is set, then it @@ -101606,199 +106562,212 @@ whether any children of the widget would like to expand. There are few reasons to use this function, but it’s here for completeness and consistency. + - whether hexpand has been explicitly set + whether hexpand has been explicitly set - the widget + the widget - Returns the widgets last child. + Returns the widgets last child. This API is primarily meant for widget implementations. + - The widget's last child + The widget's last child - a `GtkWidget` + a `GtkWidget` - Retrieves the layout manager used by @widget. + Retrieves the layout manager used by @widget. See [method@Gtk.Widget.set_layout_manager]. + - a `GtkLayoutManager` + a `GtkLayoutManager` - a `GtkWidget` + a `GtkWidget` - Whether the widget is mapped. + Whether the widget is mapped. + - %TRUE if the widget is mapped, %FALSE otherwise. + %TRUE if the widget is mapped, %FALSE otherwise. - a `GtkWidget` + a `GtkWidget` - Gets the bottom margin of @widget. + Gets the bottom margin of @widget. + - The bottom margin of @widget + The bottom margin of @widget - a `GtkWidget` + a `GtkWidget` - Gets the end margin of @widget. + Gets the end margin of @widget. + - The end margin of @widget + The end margin of @widget - a `GtkWidget` + a `GtkWidget` - Gets the start margin of @widget. + Gets the start margin of @widget. + - The start margin of @widget + The start margin of @widget - a `GtkWidget` + a `GtkWidget` - Gets the top margin of @widget. + Gets the top margin of @widget. + - The top margin of @widget + The top margin of @widget - a `GtkWidget` + a `GtkWidget` - Retrieves the name of a widget. + Retrieves the name of a widget. See [method@Gtk.Widget.set_name] for the significance of widget names. + - name of the widget. This string is owned by GTK and + name of the widget. This string is owned by GTK and should not be modified or freed - a `GtkWidget` + a `GtkWidget` - Returns the nearest `GtkNative` ancestor of @widget. + Returns the nearest `GtkNative` ancestor of @widget. This function will return %NULL if the widget is not contained inside a widget tree with a native ancestor. `GtkNative` widgets will return themselves here. + - the `GtkNative` ancestor of @widget + the `GtkNative` ancestor of @widget - a `GtkWidget` + a `GtkWidget` - Returns the widgets next sibling. + Returns the widgets next sibling. This API is primarily meant for widget implementations. + - The widget's next sibling + The widget's next sibling - a `GtkWidget` + a `GtkWidget` - #Fetches the requested opacity for this widget. + #Fetches the requested opacity for this widget. See [method@Gtk.Widget.set_opacity]. + - the requested opacity for this widget. + the requested opacity for this widget. - a `GtkWidget` + a `GtkWidget` - Returns the widgets overflow value. + Returns the widgets overflow value. + - The widget's overflow. + The widget's overflow. - a `GtkWidget` + a `GtkWidget` - Gets a `PangoContext` with the appropriate font map, font description, + Gets a `PangoContext` with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by [method@Gtk.Widget.create_pango_context], @@ -101807,33 +106776,35 @@ for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by listening to changes of the [property@Gtk.Widget:root] property on the widget. + - the `PangoContext` for the widget. + the `PangoContext` for the widget. - a `GtkWidget` + a `GtkWidget` - Returns the parent widget of @widget. + Returns the parent widget of @widget. + - the parent widget of @widget + the parent widget of @widget - a `GtkWidget` + a `GtkWidget` - Retrieves the minimum and natural size of a widget, taking + Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. This is used to retrieve a suitable size by container widgets which do @@ -101847,151 +106818,159 @@ the required height for the natural width is generally smaller than the required height for the minimum width. Use [id@gtk_widget_measure] if you want to support baseline alignment. + - a `GtkWidget` instance + a `GtkWidget` instance - location for storing the minimum size + location for storing the minimum size - location for storing the natural size + location for storing the natural size - Returns the widgets previous sibling. + Returns the widgets previous sibling. This API is primarily meant for widget implementations. + - The widget's previous sibling + The widget's previous sibling - a `GtkWidget` + a `GtkWidget` - Gets the primary clipboard of @widget. + Gets the primary clipboard of @widget. This is a utility function to get the primary clipboard object for the `GdkDisplay` that @widget is using. Note that this function always works, even when @widget is not realized yet. + - the appropriate clipboard object + the appropriate clipboard object - a `GtkWidget` + a `GtkWidget` - Determines whether @widget is realized. + Determines whether @widget is realized. + - %TRUE if @widget is realized, %FALSE otherwise + %TRUE if @widget is realized, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - Determines whether @widget is always treated as the default widget + Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. See [method@Gtk.Widget.set_receives_default]. + - %TRUE if @widget acts as the default widget when focused, + %TRUE if @widget acts as the default widget when focused, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - Gets whether the widget prefers a height-for-width layout + Gets whether the widget prefers a height-for-width layout or a width-for-height layout. Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities. + - The `GtkSizeRequestMode` preferred by @widget. + The `GtkSizeRequestMode` preferred by @widget. - a `GtkWidget` instance + a `GtkWidget` instance - Returns the `GtkRoot` widget of @widget. + Returns the `GtkRoot` widget of @widget. This function will return %NULL if the widget is not contained inside a widget tree with a root widget. `GtkRoot` widgets will return themselves here. + - the root widget of @widget + the root widget of @widget - a `GtkWidget` + a `GtkWidget` - Retrieves the internal scale factor that maps from window + Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2). See [method@Gdk.Surface.get_scale_factor]. + - the scale factor for @widget + the scale factor for @widget - a `GtkWidget` + a `GtkWidget` - Returns the widget’s sensitivity. + Returns the widget’s sensitivity. This function returns the value that has been set using [method@Gtk.Widget.set_sensitive]). @@ -101999,37 +106978,39 @@ This function returns the value that has been set using The effective sensitivity of a widget is however determined by both its own and its parent widget’s sensitivity. See [method@Gtk.Widget.is_sensitive]. + - %TRUE if the widget is sensitive + %TRUE if the widget is sensitive - a `GtkWidget` + a `GtkWidget` - Gets the settings object holding the settings used for this widget. + Gets the settings object holding the settings used for this widget. Note that this function can only be called when the `GtkWidget` is attached to a toplevel, since the settings object is specific to a particular `GdkDisplay`. If you want to monitor the widget for changes in its settings, connect to the `notify::display` signal. + - the relevant `GtkSettings` object + the relevant `GtkSettings` object - a `GtkWidget` + a `GtkWidget` - Returns the content width or height of the widget. + Returns the content width or height of the widget. Which dimension is returned depends on @orientation. @@ -102038,23 +107019,24 @@ for %GTK_ORIENTATION_HORIZONTAL or [method@Gtk.Widget.get_height] for %GTK_ORIENTATION_VERTICAL, but can be used when writing orientation-independent code, such as when implementing [iface@Gtk.Orientable] widgets. + - The size of @widget in @orientation. + The size of @widget in @orientation. - a `GtkWidget` + a `GtkWidget` - the orientation to query + the orientation to query - Gets the size request that was explicitly set for the widget using + Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). A value of -1 stored in @width or @height indicates that that @@ -102063,26 +107045,27 @@ of the widget will be used instead. See [method@Gtk.Widget.set_size_request]. To get the size a widget will actually request, call [method@Gtk.Widget.measure] instead of this function. + - a `GtkWidget` + a `GtkWidget` - return location for width + return location for width - return location for height + return location for height - Returns the widget state as a flag set. + Returns the widget state as a flag set. It is worth mentioning that the effective %GTK_STATE_FLAG_INSENSITIVE state will be returned, that is, also based on parent insensitivity, @@ -102091,35 +107074,37 @@ even if @widget itself is sensitive. Also note that if you are looking for a way to obtain the [flags@Gtk.StateFlags] to pass to a [class@Gtk.StyleContext] method, you should look at [method@Gtk.StyleContext.get_state]. + - The state flags for widget + The state flags for widget - a `GtkWidget` + a `GtkWidget` - Returns the style context associated to @widget. + Returns the style context associated to @widget. The returned object is guaranteed to be the same for the lifetime of @widget. + - the widgets `GtkStyleContext` + the widgets `GtkStyleContext` - a `GtkWidget` + a `GtkWidget` - Fetch an object build from the template XML for @widget_type in + Fetch an object build from the template XML for @widget_type in this @widget instance. This will only report children which were previously declared @@ -102129,113 +107114,119 @@ variants. This function is only meant to be called for code which is private to the @widget_type which declared the child and is meant for language bindings which cannot easily make use of the GObject structure offsets. + - The object built in the template XML with + The object built in the template XML with the id @name - A `GtkWidget` + A `GtkWidget` - The `GType` to get a template child for + The `GType` to get a template child for - The “id” of the child defined in the template XML + The “id” of the child defined in the template XML - Gets the contents of the tooltip for @widget. + Gets the contents of the tooltip for @widget. If the tooltip has not been set using [method@Gtk.Widget.set_tooltip_markup], this function returns %NULL. + - the tooltip text + the tooltip text - a `GtkWidget` + a `GtkWidget` - Gets the contents of the tooltip for @widget. + Gets the contents of the tooltip for @widget. If the @widget's tooltip was set using [method@Gtk.Widget.set_tooltip_markup], this function will return the escaped text. + - the tooltip text + the tooltip text - a `GtkWidget` + a `GtkWidget` - Gets the vertical alignment of @widget. + Gets the vertical alignment of @widget. + - the vertical alignment of @widget + the vertical alignment of @widget - a `GtkWidget` + a `GtkWidget` - Gets whether the widget would like any available extra vertical + Gets whether the widget would like any available extra vertical space. See [method@Gtk.Widget.get_hexpand] for more detail. + - whether vexpand flag is set + whether vexpand flag is set - the widget + the widget - Gets whether gtk_widget_set_vexpand() has been used to + Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget. See [method@Gtk.Widget.get_hexpand_set] for more detail. + - whether vexpand has been explicitly set + whether vexpand has been explicitly set - the widget + the widget - Determines whether the widget is visible. + Determines whether the widget is visible. If you want to take into account whether the widget’s parent is also marked as visible, use @@ -102245,38 +107236,40 @@ This function does not check if the widget is obscured in any way. See [method@Gtk.Widget.set_visible]. + - %TRUE if the widget is visible + %TRUE if the widget is visible - a `GtkWidget` + a `GtkWidget` - Returns the content width of the widget. + Returns the content width of the widget. This function returns the width passed to its size-allocate implementation, which is the width you should be using in [vfunc@Gtk.Widget.snapshot]. For pointer events, see [method@Gtk.Widget.contains]. + - The width of @widget + The width of @widget - a `GtkWidget` + a `GtkWidget` - Causes @widget to have the keyboard focus for the `GtkWindow` it's inside. + Causes @widget to have the keyboard focus for the `GtkWindow` it's inside. If @widget is not focusable, or its [vfunc@Gtk.Widget.grab_focus] implementation cannot transfer the focus to a descendant of @widget @@ -102284,31 +107277,33 @@ that is focusable, it will not take focus and %FALSE will be returned. Calling [method@Gtk.Widget.grab_focus] on an already focused widget is allowed, should not have an effect, and return %TRUE. + - %TRUE if focus is now inside @widget. + %TRUE if focus is now inside @widget. - a `GtkWidget` + a `GtkWidget` - Returns whether @css_class is currently applied to @widget. + Returns whether @css_class is currently applied to @widget. + - %TRUE if @css_class is currently applied to @widget, + %TRUE if @css_class is currently applied to @widget, %FALSE otherwise. - a `GtkWidget` + a `GtkWidget` - A style class, without the leading '.' + A style class, without the leading '.' used for notation of style classes @@ -102316,40 +107311,42 @@ is allowed, should not have an effect, and return %TRUE. - Determines whether @widget is the current default widget + Determines whether @widget is the current default widget within its toplevel. + - %TRUE if @widget is the current default widget + %TRUE if @widget is the current default widget within its toplevel, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - Determines if the widget has the global input focus. + Determines if the widget has the global input focus. See [method@Gtk.Widget.is_focus] for the difference between having the global input focus, and only having the focus within a toplevel. + - %TRUE if the widget has the global input focus. + %TRUE if the widget has the global input focus. - a `GtkWidget` + a `GtkWidget` - Determines if the widget should show a visible indication that + Determines if the widget should show a visible indication that it has the global input focus. This is a convenience function that takes into account whether @@ -102359,49 +107356,52 @@ information about focus indication. To find out if the widget has the global input focus, use [method@Gtk.Widget.has_focus]. + - %TRUE if the widget should display a “focus rectangle” + %TRUE if the widget should display a “focus rectangle” - a `GtkWidget` + a `GtkWidget` - Reverses the effects of gtk_widget_show(). + Reverses the effects of gtk_widget_show(). This is causing the widget to be hidden (invisible to the user). + - a `GtkWidget` + a `GtkWidget` - Returns whether the widget is currently being destroyed. + Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work. + - %TRUE if @widget is being destroyed + %TRUE if @widget is being destroyed - a `GtkWidget` + a `GtkWidget` - Creates and initializes child widgets defined in templates. + Creates and initializes child widgets defined in templates. This function must be called in the instance initializer for any class which assigned itself a template using @@ -102421,18 +107421,19 @@ of a `GtkWidget` subclass and not in `GObject.constructed()` or A good rule of thumb is to call this function as the first thing in an instance initialization function. + - a `GtkWidget` + a `GtkWidget` - Inserts @group into @widget. + Inserts @group into @widget. Children of @widget that implement [iface@Gtk.Actionable] can then be associated with actions in @group by setting their @@ -102445,27 +107446,28 @@ the group contains an action with the same name. If @group is %NULL, a previously inserted group for @name is removed from @widget. + - a `GtkWidget` + a `GtkWidget` - the prefix for actions in @group + the prefix for actions in @group - a `GActionGroup`, or %NULL to remove + a `GActionGroup`, or %NULL to remove the previously inserted group for @name - Inserts @widget into the child widget list of @parent. + Inserts @widget into the child widget list of @parent. It will be placed after @previous_sibling, or at the beginning if @previous_sibling is %NULL. @@ -102479,26 +107481,27 @@ list of @parent. This API is primarily meant for widget implementations; if you are just using a widget, you *must* use its own API for adding children. + - a `GtkWidget` + a `GtkWidget` - the parent `GtkWidget` to insert @widget into + the parent `GtkWidget` to insert @widget into - the new previous sibling of @widget + the new previous sibling of @widget - Inserts @widget into the child widget list of @parent. + Inserts @widget into the child widget list of @parent. It will be placed before @next_sibling, or at the end if @next_sibling is %NULL. @@ -102511,114 +107514,120 @@ can also be used to reorder @widget in the child widget list of @parent. This API is primarily meant for widget implementations; if you are just using a widget, you *must* use its own API for adding children. + - a `GtkWidget` + a `GtkWidget` - the parent `GtkWidget` to insert @widget into + the parent `GtkWidget` to insert @widget into - the new next sibling of @widget + the new next sibling of @widget - Determines whether @widget is somewhere inside @ancestor, + Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers. + - %TRUE if @ancestor contains @widget as a child, + %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc. - a `GtkWidget` + a `GtkWidget` - another `GtkWidget` + another `GtkWidget` - Determines whether @widget can be drawn to. + Determines whether @widget can be drawn to. A widget can be drawn if it is mapped and visible. + - %TRUE if @widget is drawable, %FALSE otherwise + %TRUE if @widget is drawable, %FALSE otherwise - a `GtkWidget` + a `GtkWidget` - Determines if the widget is the focus widget within its + Determines if the widget is the focus widget within its toplevel. This does not mean that the [property@Gtk.Widget:has-focus] property is necessarily set; [property@Gtk.Widget:has-focus] will only be set if the toplevel widget additionally has the global input focus. + - %TRUE if the widget is the focus widget. + %TRUE if the widget is the focus widget. - a `GtkWidget` + a `GtkWidget` - Returns the widget’s effective sensitivity. + Returns the widget’s effective sensitivity. This means it is sensitive itself and also its parent widget is sensitive. + - %TRUE if the widget is effectively sensitive + %TRUE if the widget is effectively sensitive - a `GtkWidget` + a `GtkWidget` - Determines whether the widget and all its parents are marked as + Determines whether the widget and all its parents are marked as visible. This function does not check if the widget is obscured in any way. See also [method@Gtk.Widget.get_visible] and [method@Gtk.Widget.set_visible]. + - %TRUE if the widget and all its parents are visible + %TRUE if the widget and all its parents are visible - a `GtkWidget` + a `GtkWidget` - Emits the `::keynav-failed` signal on the widget. + Emits the `::keynav-failed` signal on the widget. This function should be called whenever keyboard navigation within a single widget hits a boundary. @@ -102645,25 +107654,26 @@ A use case for providing an own implementation of ::keynav-failed [class@Gtk.Entry] widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys. + - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - a `GtkWidget` + a `GtkWidget` - direction of focus movement + direction of focus movement - Returns the widgets for which this widget is the target of a + Returns the widgets for which this widget is the target of a mnemonic. Typically, these widgets will be labels. See, for example, @@ -102674,8 +107684,9 @@ If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and then unref all the widgets afterwards. + - the list + the list of mnemonic labels; free this list with g_list_free() when you are done with it. @@ -102684,27 +107695,28 @@ first, and then unref all the widgets afterwards. - a `GtkWidget` + a `GtkWidget` - Causes a widget to be mapped if it isn’t already. + Causes a widget to be mapped if it isn’t already. This function is only for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Measures @widget in the orientation @orientation and for the given @for_size. + Measures @widget in the orientation @orientation and for the given @for_size. As an example, if @orientation is %GTK_ORIENTATION_HORIZONTAL and @for_size is 300, this functions will compute the minimum and natural width of @widget @@ -102712,20 +107724,21 @@ if it is allocated at a height of 300 pixels. See [GtkWidget’s geometry management section](class.Widget.html#height-for-width-geometry-management) for a more details on implementing `GtkWidgetClass.measure()`. + - A `GtkWidget` instance + A `GtkWidget` instance - the orientation to measure + the orientation to measure - Size for the opposite of @orientation, i.e. + Size for the opposite of @orientation, i.e. if @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height @@ -102733,46 +107746,47 @@ a more details on implementing `GtkWidgetClass.measure()`. - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - location to store the baseline + location to store the baseline position for the minimum size - location to store the baseline + location to store the baseline position for the natural size - Emits the ::mnemonic-activate signal. + Emits the ::mnemonic-activate signal. See [signal@Gtk.Widget::mnemonic-activate]. + - %TRUE if the signal has been handled + %TRUE if the signal has been handled - a `GtkWidget` + a `GtkWidget` - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic - Returns a `GListModel` to track the children of @widget. + Returns a `GListModel` to track the children of @widget. Calling this function will enable extra internal bookkeeping to track children and emit signals on the returned listmodel. @@ -102780,21 +107794,22 @@ It may slow down operations a lot. Applications should try hard to avoid calling this function because of the slowdowns. + - + a `GListModel` tracking @widget's children - a `GtkWidget` + a `GtkWidget` - Returns a `GListModel` to track the [class@Gtk.EventController]s + Returns a `GListModel` to track the [class@Gtk.EventController]s of @widget. Calling this function will enable extra internal bookkeeping @@ -102803,21 +107818,22 @@ It may slow down operations a lot. Applications should try hard to avoid calling this function because of the slowdowns. + - + a `GListModel` tracking @widget's controllers - a `GtkWidget` + a `GtkWidget` - Finds the descendant of @widget closest to the point (@x, @y). + Finds the descendant of @widget closest to the point (@x, @y). The point must be given in widget coordinates, so (0, 0) is assumed to be the top left of @widget's content area. @@ -102831,32 +107847,33 @@ picking algorithm. This function is used on the toplevel to determine the widget below the mouse cursor for purposes of hover highlighting and delivering events. + - The widget descendant at + The widget descendant at the given point - the widget to query + the widget to query - X coordinate to test, relative to @widget's origin + X coordinate to test, relative to @widget's origin - Y coordinate to test, relative to @widget's origin + Y coordinate to test, relative to @widget's origin - Flags to influence what is picked + Flags to influence what is picked - Flags the widget for a rerun of the [vfunc@Gtk.Widget.size_allocate] + Flags the widget for a rerun of the [vfunc@Gtk.Widget.size_allocate] function. Use this function instead of [method@Gtk.Widget.queue_resize] @@ -102866,34 +107883,36 @@ reposition its contents. An example user of this function is [method@Gtk.Widget.set_halign]. This function is only for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Schedules this widget to be redrawn in the paint phase + Schedules this widget to be redrawn in the paint phase of the current or the next frame. This means @widget's [vfunc@Gtk.Widget.snapshot] implementation will be called. + - a `GtkWidget` + a `GtkWidget` - Flags a widget to have its size renegotiated. + Flags a widget to have its size renegotiated. This should be called when a widget for some reason has a new size request. For example, when you change the text in a @@ -102906,18 +107925,19 @@ virtual method. Calls to gtk_widget_queue_resize() from inside [vfunc@Gtk.Widget.size_allocate] will be silently ignored. This function is only for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Creates the GDK resources associated with a widget. + Creates the GDK resources associated with a widget. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized @@ -102933,98 +107953,103 @@ isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as [signal@Gtk.Widget::realize]. + - a `GtkWidget` + a `GtkWidget` - Removes @controller from @widget, so that it doesn't process + Removes @controller from @widget, so that it doesn't process events anymore. It should not be used again. Widgets will remove all event controllers automatically when they are destroyed, there is normally no need to call this function. + - a `GtkWidget` + a `GtkWidget` - a `GtkEventController` + a `GtkEventController` - Removes a style from @widget. + Removes a style from @widget. After this, the style of @widget will stop matching for @css_class. + - a `GtkWidget` + a `GtkWidget` - The style class to remove from @widget, without + The style class to remove from @widget, without the leading '.' used for notation of style classes - Removes a widget from the list of mnemonic labels for this widget. + Removes a widget from the list of mnemonic labels for this widget. See [method@Gtk.Widget.list_mnemonic_labels]. The widget must have previously been added to the list with [method@Gtk.Widget.add_mnemonic_label]. + - a `GtkWidget` + a `GtkWidget` - a `GtkWidget` that was previously set as a mnemonic + a `GtkWidget` that was previously set as a mnemonic label for @widget with [method@Gtk.Widget.add_mnemonic_label] - Removes a tick callback previously registered with + Removes a tick callback previously registered with gtk_widget_add_tick_callback(). + - a `GtkWidget` + a `GtkWidget` - an id returned by [method@Gtk.Widget.add_tick_callback] + an id returned by [method@Gtk.Widget.add_tick_callback] - Specifies whether the input focus can enter the widget + Specifies whether the input focus can enter the widget or any of its children. Applications should set @can_focus to %FALSE to mark a @@ -103038,16 +108063,17 @@ focus. See [method@Gtk.Widget.grab_focus] for actually setting the input focus on a widget. + - a `GtkWidget` + a `GtkWidget` - whether or not the input focus can enter + whether or not the input focus can enter the widget or any of its children @@ -103055,24 +108081,25 @@ the input focus on a widget. - Sets whether @widget can be the target of pointer events. + Sets whether @widget can be the target of pointer events. + - a `GtkWidget` + a `GtkWidget` - whether this widget should be able to + whether this widget should be able to receive pointer events - Sets whether @widget should be mapped along with its parent. + Sets whether @widget should be mapped along with its parent. The child visibility can be set for widget before it is added to a container with [method@Gtk.Widget.set_parent], to avoid @@ -103088,16 +108115,17 @@ can queue a resize itself. This function is only useful for container implementations and should never be called by an application. + - a `GtkWidget` + a `GtkWidget` - if %TRUE, @widget should be mapped along + if %TRUE, @widget should be mapped along with its parent. @@ -103105,18 +108133,19 @@ and should never be called by an application. - Clear all style classes applied to @widget + Clear all style classes applied to @widget and replace them with @classes. + - a `GtkWidget` + a `GtkWidget` - + %NULL-terminated list of style classes to apply to @widget. @@ -103126,27 +108155,28 @@ and replace them with @classes. - Sets the cursor to be shown when pointer devices point + Sets the cursor to be shown when pointer devices point towards @widget. If the @cursor is NULL, @widget will use the cursor inherited from the parent widget. + - a `GtkWidget` + a `GtkWidget` - the new cursor + the new cursor - Sets a named cursor to be shown when pointer devices point + Sets a named cursor to be shown when pointer devices point towards @widget. This is a utility function that creates a cursor via @@ -103157,22 +108187,23 @@ details. On top of that, this function allows @name to be %NULL, which will do the same as calling [method@Gtk.Widget.set_cursor] with a %NULL cursor. + - a `GtkWidget` + a `GtkWidget` - The name of the cursor + The name of the cursor - Sets the reading direction on a particular widget. + Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children @@ -103185,36 +108216,38 @@ visual rather than logical (such as buttons for text justification). If the direction is set to %GTK_TEXT_DIR_NONE, then the value set by [func@Gtk.Widget.set_default_direction] will be used. + - a `GtkWidget` + a `GtkWidget` - the new direction + the new direction - Set @child as the current focus child of @widget. + Set @child as the current focus child of @widget. This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call [method@Gtk.Widget.grab_focus] on it. + - a `GtkWidget` + a `GtkWidget` - a direct child widget of @widget or %NULL + a direct child widget of @widget or %NULL to unset the focus child of @widget @@ -103222,22 +108255,23 @@ If you want a certain widget to get the input focus, call - Sets whether the widget should grab focus when it is clicked + Sets whether the widget should grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application. + - a `GtkWidget` + a `GtkWidget` - whether the widget should grab focus when clicked + whether the widget should grab focus when clicked with the mouse @@ -103245,7 +108279,7 @@ the main area of the application. - Specifies whether @widget can own the input focus. + Specifies whether @widget can own the input focus. Widget implementations should set @focusable to %TRUE in their init() function if they want to receive keyboard input. @@ -103258,22 +108292,23 @@ focus. See [method@Gtk.Widget.grab_focus] for actually setting the input focus on a widget. + - a `GtkWidget` + a `GtkWidget` - whether or not @widget can own the input focus + whether or not @widget can own the input focus - Sets the font map to use for Pango rendering. + Sets the font map to use for Pango rendering. The font map is the object that is used to look up fonts. Setting a custom font map can be useful in special situations, @@ -103281,37 +108316,39 @@ e.g. when you need to add application-specific fonts to the set of available fonts. When not set, the widget will inherit the font map from its parent. + - a `GtkWidget` + a `GtkWidget` - a `PangoFontMap`, or %NULL to unset any + a `PangoFontMap`, or %NULL to unset any previously set font map - Sets the `cairo_font_options_t` used for Pango rendering + Sets the `cairo_font_options_t` used for Pango rendering in this widget. When not set, the default font options for the `GdkDisplay` will be used. + - a `GtkWidget` + a `GtkWidget` - a `cairo_font_options_t` + a `cairo_font_options_t` to unset any previously set default font options @@ -103319,41 +108356,43 @@ will be used. - Sets the horizontal alignment of @widget. + Sets the horizontal alignment of @widget. + - a `GtkWidget` + a `GtkWidget` - the horizontal alignment + the horizontal alignment - Sets the `has-tooltip` property on @widget to @has_tooltip. + Sets the `has-tooltip` property on @widget to @has_tooltip. + - a `GtkWidget` + a `GtkWidget` - whether or not @widget has a tooltip. + whether or not @widget has a tooltip. - Sets whether the widget would like any available extra horizontal + Sets whether the widget would like any available extra horizontal space. When a user resizes a `GtkWindow`, widgets with expand=TRUE @@ -103380,23 +108419,24 @@ regardless of children. The override occurs because [method@Gtk.Widget.set_hexpand] sets the hexpand-set property (see [method@Gtk.Widget.set_hexpand_set]) which causes the widget’s hexpand value to be used, rather than looking at children and widget state. + - the widget + the widget - whether to expand + whether to expand - Sets whether the hexpand flag will be used. + Sets whether the hexpand flag will be used. The [property@Gtk.Widget:hexpand-set] property will be set automatically when you call [method@Gtk.Widget.set_hexpand] @@ -103410,109 +108450,115 @@ children of the widget would like to expand. There are few reasons to use this function, but it’s here for completeness and consistency. + - the widget + the widget - value for hexpand-set property + value for hexpand-set property - Sets the layout manager delegate instance that provides an + Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget. + - a `GtkWidget` + a `GtkWidget` - a `GtkLayoutManager` + a `GtkLayoutManager` - Sets the bottom margin of @widget. + Sets the bottom margin of @widget. + - a `GtkWidget` + a `GtkWidget` - the bottom margin + the bottom margin - Sets the end margin of @widget. + Sets the end margin of @widget. + - a `GtkWidget` + a `GtkWidget` - the end margin + the end margin - Sets the start margin of @widget. + Sets the start margin of @widget. + - a `GtkWidget` + a `GtkWidget` - the start margin + the start margin - Sets the top margin of @widget. + Sets the top margin of @widget. + - a `GtkWidget` + a `GtkWidget` - the top margin + the top margin - Sets a widgets name. + Sets a widgets name. Setting a name allows you to refer to the widget from a CSS file. You can apply a style to widgets with a particular name @@ -103523,23 +108569,24 @@ Note that the CSS syntax has certain special characters to delimit and represent elements in a selector (period, #, >, *...), so using these will make your widget impossible to match by name. Any combination of alphanumeric symbols, dashes and underscores will suffice. + - a `GtkWidget` + a `GtkWidget` - name for the widget + name for the widget - Request the @widget to be rendered partially transparent. + Request the @widget to be rendered partially transparent. An opacity of 0 is fully transparent and an opacity of 1 is fully opaque. @@ -103561,23 +108608,24 @@ progressively more translucent). As a consequence, [class@Gtk.Popover]s and other [class@Gtk.Native] widgets with their own surface will use their own opacity value, and thus by default appear non-translucent, even if they are attached to a toplevel that is translucent. + - a `GtkWidget` + a `GtkWidget` - desired opacity, between 0 and 1 + desired opacity, between 0 and 1 - Sets how @widget treats content that is drawn outside the + Sets how @widget treats content that is drawn outside the widget's content area. See the definition of [enum@Gtk.Overflow] for details. @@ -103586,23 +108634,24 @@ This setting is provided for widget implementations and should not be used by application code. The default value is %GTK_OVERFLOW_VISIBLE. + - a `GtkWidget` + a `GtkWidget` - desired overflow + desired overflow - Sets @parent as the parent widget of @widget. + Sets @parent as the parent widget of @widget. This takes care of details such as updating the state and style of the child to reflect its new location and resizing the parent. @@ -103610,63 +108659,66 @@ The opposite function is [method@Gtk.Widget.unparent]. This function is useful only when implementing subclasses of `GtkWidget`. + - a `GtkWidget` + a `GtkWidget` - parent widget + parent widget - Specifies whether @widget will be treated as the default + Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. + - a `GtkWidget` + a `GtkWidget` - whether or not @widget can be a default widget. + whether or not @widget can be a default widget. - Sets the sensitivity of a widget. + Sets the sensitivity of a widget. A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits. + - a `GtkWidget` + a `GtkWidget` - %TRUE to make the widget sensitive + %TRUE to make the widget sensitive - Sets the minimum size of a widget. + Sets the minimum size of a widget. That is, the widget’s size request will be at least @width by @height. You can use this function to force a widget to @@ -103701,26 +108753,27 @@ properties [property@Gtk.Widget:margin-bottom], but it does include pretty much all other padding or border properties set by any subclass of `GtkWidget`. + - a `GtkWidget` + a `GtkWidget` - width @widget should request, or -1 to unset + width @widget should request, or -1 to unset - height @widget should request, or -1 to unset + height @widget should request, or -1 to unset - Turns on flag values in the current widget state. + Turns on flag values in the current widget state. Typical widget states are insensitive, prelighted, etc. @@ -103729,27 +108782,28 @@ This function accepts the values %GTK_STATE_FLAG_DIR_LTR and the widget's direction, use [method@Gtk.Widget.set_direction]. This function is for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - State flags to turn on + State flags to turn on - Whether to clear state before turning on @flags + Whether to clear state before turning on @flags - Sets @markup as the contents of the tooltip, which is marked + Sets @markup as the contents of the tooltip, which is marked up with Pango markup. This function will take care of setting the @@ -103757,23 +108811,24 @@ This function will take care of setting the default handler for the [signal@Gtk.Widget::query-tooltip] signal. See also [method@Gtk.Tooltip.set_markup]. + - a `GtkWidget` + a `GtkWidget` - the contents of the tooltip for @widget + the contents of the tooltip for @widget - Sets @text as the contents of the tooltip. + Sets @text as the contents of the tooltip. If @text contains any markup, it will be escaped. @@ -103783,79 +108838,83 @@ and of the default handler for the [signal@Gtk.Widget::query-tooltip] signal. See also [method@Gtk.Tooltip.set_text]. + - a `GtkWidget` + a `GtkWidget` - the contents of the tooltip for @widget + the contents of the tooltip for @widget - Sets the vertical alignment of @widget. + Sets the vertical alignment of @widget. + - a `GtkWidget` + a `GtkWidget` - the vertical alignment + the vertical alignment - Sets whether the widget would like any available extra vertical + Sets whether the widget would like any available extra vertical space. See [method@Gtk.Widget.set_hexpand] for more detail. + - the widget + the widget - whether to expand + whether to expand - Sets whether the vexpand flag will be used. + Sets whether the vexpand flag will be used. See [method@Gtk.Widget.set_hexpand_set] for more detail. + - the widget + the widget - value for vexpand-set property + value for vexpand-set property - Sets the visibility state of @widget. + Sets the visibility state of @widget. Note that setting this to %TRUE doesn’t mean the widget is actually viewable, see [method@Gtk.Widget.get_visible]. @@ -103863,40 +108922,42 @@ actually viewable, see [method@Gtk.Widget.get_visible]. This function simply calls [method@Gtk.Widget.show] or [method@Gtk.Widget.hide] but is nicer to use when the visibility of the widget depends on some condition. + - a `GtkWidget` + a `GtkWidget` - whether the widget should be shown or not + whether the widget should be shown or not - Returns whether @widget should contribute to + Returns whether @widget should contribute to the measuring and allocation of its parent. This is %FALSE for invisible children, but also for children that have their own surface. + - %TRUE if child should be included in + %TRUE if child should be included in measuring and allocating - a widget + a widget - Flags a widget to be displayed. + Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. @@ -103906,41 +108967,43 @@ in addition to the widget itself, before it will appear onscreen. When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped. + - a `GtkWidget` + a `GtkWidget` - Allocates widget with a transformation that translates + Allocates widget with a transformation that translates the origin to the position in @allocation. This is a simple form of [method@Gtk.Widget.allocate]. + - a `GtkWidget` + a `GtkWidget` - position and size to be allocated to @widget + position and size to be allocated to @widget - The baseline of the child, or -1 + The baseline of the child, or -1 - Snapshot the a child of @widget. + Snapshot the a child of @widget. When a widget receives a call to the snapshot function, it must send synthetic [vfunc@Gtk.Widget.snapshot] calls @@ -103954,20 +109017,21 @@ gtk_widget_snapshot_child() takes care of translating the origin of @snapshot, and deciding whether the child needs to be snapshot. This function does nothing for children that implement `GtkNative`. + - a `GtkWidget` + a `GtkWidget` - a child of @widget + a child of @widget - `GtkSnapshot` as passed to the widget. In particular, no + `GtkSnapshot` as passed to the widget. In particular, no calls to gtk_snapshot_translate() or other transform calls should have been made. @@ -103975,117 +109039,123 @@ This function does nothing for children that implement `GtkNative`. - Translate coordinates relative to @src_widget’s allocation + Translate coordinates relative to @src_widget’s allocation to coordinates relative to @dest_widget’s allocations. In order to perform this operation, both widget must share a common ancestor. + - %FALSE if @src_widget and @dest_widget have no common + %FALSE if @src_widget and @dest_widget have no common ancestor. In this case, 0 is stored in *@dest_x and *@dest_y. Otherwise %TRUE. - a `GtkWidget` + a `GtkWidget` - a `GtkWidget` + a `GtkWidget` - X position relative to @src_widget + X position relative to @src_widget - Y position relative to @src_widget + Y position relative to @src_widget - location to store X position relative to @dest_widget + location to store X position relative to @dest_widget - location to store Y position relative to @dest_widget + location to store Y position relative to @dest_widget - Triggers a tooltip query on the display where the toplevel + Triggers a tooltip query on the display where the toplevel of @widget is located. + - a `GtkWidget` + a `GtkWidget` - Causes a widget to be unmapped if it’s currently mapped. + Causes a widget to be unmapped if it’s currently mapped. This function is only for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Dissociate @widget from its parent. + Dissociate @widget from its parent. This function is only for use in widget implementations, typically in dispose. + - a `GtkWidget` + a `GtkWidget` - Causes a widget to be unrealized (frees all GDK resources + Causes a widget to be unrealized (frees all GDK resources associated with the widget). This function is only useful in widget implementations. + - a `GtkWidget` + a `GtkWidget` - Turns off flag values for the current widget state. + Turns off flag values for the current widget state. See [method@Gtk.Widget.set_state_flags]. This function is for use in widget implementations. + - a `GtkWidget` + a `GtkWidget` - State flags to turn off + State flags to turn off @@ -104093,7 +109163,7 @@ This function is for use in widget implementations. - Whether the widget or any of its descendents can accept + Whether the widget or any of its descendents can accept the input focus. This property is meant to be set by widget implementations, @@ -104103,20 +109173,20 @@ typically in their instance init function. - Whether the widget can receive pointer events. + Whether the widget can receive pointer events. - A list of css classes applied to this widget. + A list of css classes applied to this widget. - The name of this widget in the CSS tree. + The name of this widget in the CSS tree. This property is meant to be set by widget implementations, typically in their instance init function. @@ -104125,13 +109195,13 @@ typically in their instance init function. - The cursor used by @widget. + The cursor used by @widget. - Whether the widget should grab focus when it is clicked with the mouse. + Whether the widget should grab focus when it is clicked with the mouse. This property is only relevant for widgets that can take focus. @@ -104139,29 +109209,29 @@ This property is only relevant for widgets that can take focus. - Whether this widget itself will accept the input focus. + Whether this widget itself will accept the input focus. - How to distribute horizontal space if widget gets extra space. + How to distribute horizontal space if widget gets extra space. - Whether the widget is the default widget. + Whether the widget is the default widget. - Whether the widget has the input focus. + Whether the widget has the input focus. - Enables or disables the emission of the ::query-tooltip signal on @widget. + Enables or disables the emission of the ::query-tooltip signal on @widget. A value of %TRUE indicates that @widget can have a tooltip, in this case the widget will be queried using [signal@Gtk.Widget::query-tooltip] to @@ -104169,7 +109239,7 @@ determine whether it will provide a tooltip or not. - Override for height request of the widget. + Override for height request of the widget. If this is -1, the natural request will be used. @@ -104177,19 +109247,19 @@ If this is -1, the natural request will be used. - Whether to expand horizontally. + Whether to expand horizontally. - Whether to use the `hexpand` property. + Whether to use the `hexpand` property. - The `GtkLayoutManager` instance to use to compute the preferred size + The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children. This property is meant to be set by widget implementations, @@ -104199,7 +109269,7 @@ typically in their instance init function. - Margin on bottom side of widget. + Margin on bottom side of widget. This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from @@ -104209,7 +109279,7 @@ request, the margin will be added in addition to the size from - Margin on end of widget, horizontally. + Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions. @@ -104222,7 +109292,7 @@ request, the margin will be added in addition to the size from - Margin on start of widget, horizontally. + Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions. @@ -104235,7 +109305,7 @@ request, the margin will be added in addition to the size from - Margin on top side of widget. + Margin on top side of widget. This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from @@ -104245,19 +109315,19 @@ request, the margin will be added in addition to the size from - The name of the widget. + The name of the widget. - The requested opacity of the widget. + The requested opacity of the widget. - How content outside the widget's content area is treated. + How content outside the widget's content area is treated. This property is meant to be set by widget implementations, typically in their instance init function. @@ -104265,37 +109335,37 @@ typically in their instance init function. - The parent widget of this widget. + The parent widget of this widget. - Whether the widget will receive the default action when it is focused. + Whether the widget will receive the default action when it is focused. - The `GtkRoot` widget of the widget tree containing this widget. + The `GtkRoot` widget of the widget tree containing this widget. This will be %NULL if the widget is not contained in a root widget. - The scale factor of the widget. + The scale factor of the widget. - Whether the widget responds to input. + Whether the widget responds to input. - Sets the text of tooltip to be the given string, which is marked up + Sets the text of tooltip to be the given string, which is marked up with Pango markup. Also see [method@Gtk.Tooltip.set_markup]. @@ -104313,7 +109383,7 @@ Note that if both [property@Gtk.Widget:tooltip-text] and - Sets the text of tooltip to be the given string. + Sets the text of tooltip to be the given string. Also see [method@Gtk.Tooltip.set_text]. @@ -104330,29 +109400,29 @@ Note that if both [property@Gtk.Widget:tooltip-text] and - How to distribute vertical space if widget gets extra space. + How to distribute vertical space if widget gets extra space. - Whether to expand vertically. + Whether to expand vertically. - Whether to use the `vexpand` property. + Whether to use the `vexpand` property. - Whether the widget is visible. + Whether the widget is visible. - Override for width request of the widget. + Override for width request of the widget. If this is -1, the natural request will be used. @@ -104364,7 +109434,7 @@ If this is -1, the natural request will be used. - Signals that all holders of a reference to the widget should release + Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released. @@ -104375,42 +109445,42 @@ This signal is not suitable for saving widget state. - Emitted when the text direction of a widget changes. + Emitted when the text direction of a widget changes. - the previous text direction of @widget + the previous text direction of @widget - Emitted when @widget is hidden. + Emitted when @widget is hidden. - Emitted if keyboard navigation fails. + Emitted if keyboard navigation fails. See [method@Gtk.Widget.keynav_failed] for details. - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent widget(s). - the direction of movement + the direction of movement - Emitted when @widget is going to be mapped. + Emitted when @widget is going to be mapped. A widget is mapped when the widget is visible (which is controlled with [property@Gtk.Widget:visible]) and all its parents up to the toplevel widget @@ -104424,36 +109494,36 @@ emission of [signal@Gtk.Widget::unmap]. - Emitted when a widget is activated via a mnemonic. + Emitted when a widget is activated via a mnemonic. The default handler for this signal activates @widget if @group_cycling is %FALSE, or just makes @widget grab focus if @group_cycling is %TRUE. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic - Emitted when the focus is moved. + Emitted when the focus is moved. - the direction of the focus move + the direction of the focus move - Emitted when the widgets tooltip is about to be shown. + Emitted when the widgets tooltip is about to be shown. This happens when the [property@Gtk.Widget:has-tooltip] property is %TRUE and the hover timeout has expired with the cursor hovering @@ -104468,32 +109538,32 @@ should not be used. The signal handler is free to manipulate @tooltip with the therefore destined function calls. - %TRUE if @tooltip should be shown right now, %FALSE otherwise. + %TRUE if @tooltip should be shown right now, %FALSE otherwise. - the x coordinate of the cursor position where the request has + the x coordinate of the cursor position where the request has been emitted, relative to @widget's left side - the y coordinate of the cursor position where the request has + the y coordinate of the cursor position where the request has been emitted, relative to @widget's top - %TRUE if the tooltip was triggered using the keyboard + %TRUE if the tooltip was triggered using the keyboard - a `GtkTooltip` + a `GtkTooltip` - Emitted when @widget is associated with a `GdkSurface`. + Emitted when @widget is associated with a `GdkSurface`. This means that [method@Gtk.Widget.realize] has been called or the widget has been mapped (that is, it is going to be drawn). @@ -104502,13 +109572,13 @@ or the widget has been mapped (that is, it is going to be drawn). - Emitted when @widget is shown. + Emitted when @widget is shown. - Emitted when the widget state changes. + Emitted when the widget state changes. See [method@Gtk.Widget.get_state_flags]. @@ -104516,13 +109586,13 @@ See [method@Gtk.Widget.get_state_flags]. - The previous state flags. + The previous state flags. - Emitted when @widget is going to be unmapped. + Emitted when @widget is going to be unmapped. A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden. @@ -104534,7 +109604,7 @@ it can be used to, for example, stop an animation on the widget. - Emitted when the `GdkSurface` associated with @widget is destroyed. + Emitted when the `GdkSurface` associated with @widget is destroyed. This means that [method@Gtk.Widget.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden). @@ -104544,31 +109614,33 @@ or the widget has been unmapped (that is, it is going to be hidden). - The type of the callback functions used for activating + The type of the callback functions used for activating actions installed with gtk_widget_class_install_action(). The @parameter must match the @parameter_type of the action. + - the widget to which the action belongs + the widget to which the action belongs - the action name + the action name - parameter for activation + parameter for activation + - The object class structure needs to be the first + The object class structure needs to be the first element in the widget class structure in order for the class mechanism to work correctly. This allows a GtkWidgetClass pointer to be cast to a GObjectClass pointer. @@ -104576,12 +109648,13 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` @@ -104589,12 +109662,13 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` @@ -104602,12 +109676,13 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` @@ -104615,12 +109690,13 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` @@ -104628,12 +109704,13 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` @@ -104641,12 +109718,13 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` @@ -104654,6 +109732,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104666,6 +109745,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104678,6 +109758,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104699,6 +109780,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104714,6 +109796,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104729,13 +109812,14 @@ The @parameter must match the @parameter_type of the action. + - The `GtkSizeRequestMode` preferred by @widget. + The `GtkSizeRequestMode` preferred by @widget. - a `GtkWidget` instance + a `GtkWidget` instance @@ -104743,20 +109827,21 @@ The @parameter must match the @parameter_type of the action. + - A `GtkWidget` instance + A `GtkWidget` instance - the orientation to measure + the orientation to measure - Size for the opposite of @orientation, i.e. + Size for the opposite of @orientation, i.e. if @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height @@ -104764,20 +109849,20 @@ The @parameter must match the @parameter_type of the action. - location to store the minimum size + location to store the minimum size - location to store the natural size + location to store the natural size - location to store the baseline + location to store the baseline position for the minimum size - location to store the baseline + location to store the baseline position for the natural size @@ -104786,17 +109871,18 @@ The @parameter must match the @parameter_type of the action. + - %TRUE if the signal has been handled + %TRUE if the signal has been handled - a `GtkWidget` + a `GtkWidget` - %TRUE if there are other widgets with the same mnemonic + %TRUE if there are other widgets with the same mnemonic @@ -104804,13 +109890,14 @@ The @parameter must match the @parameter_type of the action. + - %TRUE if focus is now inside @widget. + %TRUE if focus is now inside @widget. - a `GtkWidget` + a `GtkWidget` @@ -104818,6 +109905,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104833,16 +109921,17 @@ The @parameter must match the @parameter_type of the action. + - a `GtkWidget` + a `GtkWidget` - a direct child widget of @widget or %NULL + a direct child widget of @widget or %NULL to unset the focus child of @widget @@ -104851,6 +109940,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104866,19 +109956,20 @@ The @parameter must match the @parameter_type of the action. + - %TRUE if stopping keyboard navigation is fine, %FALSE + %TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). - a `GtkWidget` + a `GtkWidget` - direction of focus movement + direction of focus movement @@ -104886,6 +109977,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104910,6 +110002,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104928,6 +110021,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104943,6 +110037,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104958,6 +110053,7 @@ The @parameter must match the @parameter_type of the action. + @@ -104973,21 +110069,22 @@ The @parameter must match the @parameter_type of the action. + - %TRUE if @widget contains (@x, @y). + %TRUE if @widget contains (@x, @y). - the widget to query + the widget to query - X coordinate to test, relative to @widget's origin + X coordinate to test, relative to @widget's origin - Y coordinate to test, relative to @widget's origin + Y coordinate to test, relative to @widget's origin @@ -105002,7 +110099,7 @@ The @parameter must match the @parameter_type of the action. - Creates a new shortcut for @widget_class that calls the given @callback + Creates a new shortcut for @widget_class that calls the given @callback with arguments read according to @format_string. The arguments and format string must be provided in the same way as @@ -105013,39 +110110,40 @@ This function is a convenience wrapper around initialization. It does not provide for user_data, if you need that, you will have to use [method@GtkWidgetClass.add_shortcut] with a custom shortcut. + - the class to add the binding to + the class to add the binding to - key value of binding to install + key value of binding to install - key modifier of binding to install + key modifier of binding to install - the callback to call upon activation + the callback to call upon activation - GVariant format string for arguments + GVariant format string for arguments or %NULL for no arguments - arguments, as given by format string + arguments, as given by format string - Creates a new shortcut for @widget_class that activates the given + Creates a new shortcut for @widget_class that activates the given @action_name with arguments read according to @format_string. The arguments and format string must be provided in the same way as @@ -105054,39 +110152,40 @@ with g_variant_new(). This function is a convenience wrapper around [method@Gtk.WidgetClass.add_shortcut] and must be called during class initialization. + - the class to add the binding to + the class to add the binding to - key value of binding to install + key value of binding to install - key modifier of binding to install + key modifier of binding to install - the action to activate + the action to activate - GVariant format string for arguments + GVariant format string for arguments or %NULL for no arguments - arguments, as given by format string + arguments, as given by format string - Creates a new shortcut for @widget_class that emits the given action + Creates a new shortcut for @widget_class that emits the given action @signal with arguments read according to @format_string. The arguments and format string must be provided in the same way as @@ -105095,39 +110194,40 @@ with g_variant_new(). This function is a convenience wrapper around [method@Gtk.WidgetClass.add_shortcut] and must be called during class initialization. + - the class to add the binding to + the class to add the binding to - key value of binding to install + key value of binding to install - key modifier of binding to install + key modifier of binding to install - the signal to execute + the signal to execute - GVariant format string for arguments + GVariant format string for arguments or %NULL for no arguments - arguments, as given by format string + arguments, as given by format string - Installs a shortcut in @widget_class. + Installs a shortcut in @widget_class. Every instance created for @widget_class or its subclasses will inherit this shortcut and trigger it. @@ -105137,22 +110237,23 @@ phase, which means they may also trigger if child widgets have focus. This function must only be used in class initialization functions otherwise it is not guaranteed that the shortcut will be installed. + - the class to add the shortcut to + the class to add the shortcut to - the `GtkShortcut` to add + the `GtkShortcut` to add - Declares a @callback_symbol to handle @callback_name from + Declares a @callback_symbol to handle @callback_name from the template XML defined for @widget_type. This function is not supported after [method@Gtk.WidgetClass.set_template_scope] @@ -105160,26 +110261,27 @@ has been used on @widget_class. See [method@Gtk.BuilderCScope.add_callback_symbo Note that this must be called from a composite widget classes class initializer after calling [method@Gtk.WidgetClass.set_template]. + - A `GtkWidgetClass` + A `GtkWidgetClass` - The name of the callback as expected in the template XML + The name of the callback as expected in the template XML - The callback symbol + The callback symbol - Automatically assign an object declared in the class template XML to + Automatically assign an object declared in the class template XML to be set to a location on a freshly built instance’s private data, or alternatively accessible via [method@Gtk.Widget.get_template_child]. @@ -105207,25 +110309,26 @@ might be more convenient to use. Note that this must be called from a composite widget classes class initializer after calling [method@Gtk.WidgetClass.set_template]. + - A `GtkWidgetClass` + A `GtkWidgetClass` - The “id” of the child defined in the template XML + The “id” of the child defined in the template XML - Whether the child should be accessible as an “internal-child” + Whether the child should be accessible as an “internal-child” when this class is used in GtkBuilder XML - The structure offset into the composite widget’s instance + The structure offset into the composite widget’s instance public or private structure where the automated child pointer should be set, or 0 to not assign the pointer. @@ -105233,101 +110336,106 @@ initializer after calling [method@Gtk.WidgetClass.set_template]. - Retrieves the accessible role used by the given `GtkWidget` class. + Retrieves the accessible role used by the given `GtkWidget` class. Different accessible roles have different states, and are rendered differently by assistive technologies. See also: [method@Gtk.Accessible.get_accessible_role]. + - the accessible role for the widget class + the accessible role for the widget class - a `GtkWidgetClass` + a `GtkWidgetClass` - Retrieves the signal id for the activation signal. + Retrieves the signal id for the activation signal. the activation signal is set using [method@Gtk.WidgetClass.set_activate_signal]. + - a signal id, or 0 if the widget class does not + a signal id, or 0 if the widget class does not specify an activation signal - a `GtkWidgetClass` + a `GtkWidgetClass` - Gets the name used by this class for matching in CSS code. + Gets the name used by this class for matching in CSS code. See [method@Gtk.WidgetClass.set_css_name] for details. + - the CSS name of the given class + the CSS name of the given class - class to set the name on + class to set the name on - Retrieves the type of the [class@Gtk.LayoutManager] + Retrieves the type of the [class@Gtk.LayoutManager] used by widgets of class @widget_class. See also: [method@Gtk.WidgetClass.set_layout_manager_type]. + - type of a `GtkLayoutManager` subclass, or %G_TYPE_INVALID + type of a `GtkLayoutManager` subclass, or %G_TYPE_INVALID - a `GtkWidgetClass` + a `GtkWidgetClass` - This should be called at class initialization time to specify + This should be called at class initialization time to specify actions to be added for all instances of this class. Actions installed by this function are stateless. The only state they have is whether they are enabled or not. + - a `GtkWidgetClass` + a `GtkWidgetClass` - a prefixed action name, such as "clipboard.paste" + a prefixed action name, such as "clipboard.paste" - the parameter type + the parameter type - callback to use when the action is activated + callback to use when the action is activated - Installs an action called @action_name on @widget_class and + Installs an action called @action_name on @widget_class and binds its state to the value of the @property_name property. This function will perform a few santity checks on the property selected @@ -105342,27 +110450,28 @@ The state type of the action matches the property type. If the property is boolean, the action will have no parameter and toggle the property value. Otherwise, the action will have a parameter of the same type as the property. + - a `GtkWidgetClass` + a `GtkWidgetClass` - name of the action + name of the action - name of the property in instances of @widget_class + name of the property in instances of @widget_class or any parent class. - Returns details about the @index_-th action that has been + Returns details about the @index_-th action that has been installed for @widget_class during class initialization. See [method@Gtk.WidgetClass.install_action] for details on @@ -105371,146 +110480,152 @@ how to install actions. Note that this function will also return actions defined by parent classes. You can identify those by looking at @owner. + - %TRUE if the action was found, %FALSE if @index_ + %TRUE if the action was found, %FALSE if @index_ is out of range - a `GtkWidget` class + a `GtkWidget` class - position of the action to query + position of the action to query - return location for the type where the action was defined + return location for the type where the action was defined - return location for the action name + return location for the action name - return location for the parameter type + return location for the parameter type - return location for the property name + return location for the property name - Sets the accessible role used by the given `GtkWidget` class. + Sets the accessible role used by the given `GtkWidget` class. Different accessible roles have different states, and are rendered differently by assistive technologies. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the `GtkAccessibleRole` used by the @widget_class + the `GtkAccessibleRole` used by the @widget_class - Sets the `GtkWidgetClass.activate_signal` field with the + Sets the `GtkWidgetClass.activate_signal` field with the given @signal_id. The signal will be emitted when calling [method@Gtk.Widget.activate]. The @signal_id must have been registered with `g_signal_new()` or g_signal_newv() before calling this function. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the id for the activate signal + the id for the activate signal - Sets the `GtkWidgetClass.activate_signal` field with the signal id for + Sets the `GtkWidgetClass.activate_signal` field with the signal id for the given @signal_name. The signal will be emitted when calling [method@Gtk.Widget.activate]. The @signal_name of @widget_type must have been registered with g_signal_new() or g_signal_newv() before calling this function. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the name of the activate signal of @widget_type + the name of the activate signal of @widget_type - Sets the name to be used for CSS matching of widgets. + Sets the name to be used for CSS matching of widgets. If this function is not called for a given class, the name set on the parent class is used. By default, `GtkWidget` uses the name "widget". + - class to set the name on + class to set the name on - name to use + name to use - Sets the type to be used for creating layout managers for + Sets the type to be used for creating layout managers for widgets of @widget_class. The given @type must be a subtype of [class@Gtk.LayoutManager]. This function should only be called from class init functions of widgets. + - a `GtkWidgetClass` + a `GtkWidgetClass` - The object type that implements the `GtkLayoutManager` + The object type that implements the `GtkLayoutManager` for @widget_class - This should be called at class initialization time to specify + This should be called at class initialization time to specify the `GtkBuilder` XML to be used to extend a widget. For convenience, [method@Gtk.WidgetClass.set_template_from_resource] @@ -105518,67 +110633,72 @@ is also provided. Note that any class that installs templates must call [method@Gtk.Widget.init_template] in the widget’s instance initializer. + - A `GtkWidgetClass` + A `GtkWidgetClass` - A `GBytes` holding the `GtkBuilder` XML + A `GBytes` holding the `GtkBuilder` XML - A convenience function that calls [method@Gtk.WidgetClass.set_template] + A convenience function that calls [method@Gtk.WidgetClass.set_template] with the contents of a `GResource`. Note that any class that installs templates must call [method@Gtk.Widget.init_template] in the widget’s instance initializer. + - A `GtkWidgetClass` + A `GtkWidgetClass` - The name of the resource to load the template from + The name of the resource to load the template from - For use in language bindings, this will override the default + For use in language bindings, this will override the default `GtkBuilderScope` to be used when parsing GtkBuilder XML from this class’s template data. Note that this must be called from a composite widget classes class initializer after calling [method@GtkWidgetClass.set_template]. + - A `GtkWidgetClass` + A `GtkWidgetClass` - The `GtkBuilderScope` to use when loading + The `GtkBuilderScope` to use when loading the class template - + + + - `GtkWidgetPaintable` is a `GdkPaintable` that displays the contents + `GtkWidgetPaintable` is a `GdkPaintable` that displays the contents of a widget. `GtkWidgetPaintable` will also take care of the widget not being in a @@ -105598,47 +110718,51 @@ set on itself via gtk_picture_set_paintable(). The paintable will take care of recursion when this happens. If you do this however, ensure that the [property@Gtk.Picture:can-shrink] property is set to %TRUE or you might end up with an infinitely growing widget. + - Creates a new widget paintable observing the given widget. + Creates a new widget paintable observing the given widget. + - a new `GtkWidgetPaintable` + a new `GtkWidgetPaintable` - a `GtkWidget` + a `GtkWidget` - Returns the widget that is observed or %NULL if none. + Returns the widget that is observed or %NULL if none. + - the observed widget. + the observed widget. - a `GtkWidgetPaintable` + a `GtkWidgetPaintable` - Sets the widget that should be observed. + Sets the widget that should be observed. + - a `GtkWidgetPaintable` + a `GtkWidgetPaintable` - the widget to observe + the widget to observe @@ -105646,18 +110770,21 @@ end up with an infinitely growing widget. - The observed widget or %NULL if none. + The observed widget or %NULL if none. + - + + + - A `GtkWindow` is a toplevel window which can contain other widgets. + A `GtkWindow` is a toplevel window which can contain other widgets. ![An example GtkWindow](window.png) @@ -105704,6 +110831,7 @@ widget that is added as a titlebar child. # Accessibility `GtkWindow` uses the %GTK_ACCESSIBLE_ROLE_WINDOW role. + @@ -105711,7 +110839,7 @@ widget that is added as a titlebar child. - Creates a new `GtkWindow`. + Creates a new `GtkWindow`. To get an undecorated window (no window borders), use [method@Gtk.Window.set_decorated]. @@ -105723,45 +110851,49 @@ reference to the window internally, gtk_window_new() does not return a reference to the caller. To delete a `GtkWindow`, call [method@Gtk.Window.destroy]. + - a new `GtkWindow`. + a new `GtkWindow`. - Returns the fallback icon name for windows. + Returns the fallback icon name for windows. The returned string is owned by GTK and should not be modified. It is only valid until the next call to [func@Gtk.Window.set_default_icon_name]. + - the fallback icon name for windows + the fallback icon name for windows - Returns a list of all existing toplevel windows. + Returns a list of all existing toplevel windows. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets or add new ones, be aware that the list of toplevels will change and emit the "items-changed" signal. + - the list + the list of toplevel widgets - Returns a list of all existing toplevel windows. + Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and then unref all the widgets afterwards. + - list of + list of toplevel widgets @@ -105769,7 +110901,7 @@ and then unref all the widgets afterwards. - Sets whether the window should request startup notification. + Sets whether the window should request startup notification. By default, after showing the first `GtkWindow`, GTK calls [method@Gdk.Display.notify_startup_complete]. Call this function @@ -105781,48 +110913,52 @@ for example. In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification. + - %TRUE to automatically do startup notification + %TRUE to automatically do startup notification - Sets an icon to be used as fallback. + Sets an icon to be used as fallback. The fallback icon is used for windows that haven't had [method@Gtk.Window.set_icon_name] called on them. + - the name of the themed icon + the name of the themed icon - Opens or closes the [interactive debugger](running.html#interactive-debugging). + Opens or closes the [interactive debugger](running.html#interactive-debugging). The debugger offers access to the widget hierarchy of the application and to useful debugging tools. + - %TRUE to enable interactive debugging + %TRUE to enable interactive debugging + @@ -105833,6 +110969,7 @@ and to useful debugging tools. + @@ -105843,6 +110980,7 @@ and to useful debugging tools. + @@ -105853,6 +110991,7 @@ and to useful debugging tools. + @@ -105866,6 +111005,7 @@ and to useful debugging tools. + @@ -105876,37 +111016,39 @@ and to useful debugging tools. - Requests that the window is closed. + Requests that the window is closed. This is similar to what happens when a window manager close button is clicked. This function can be used with close buttons in custom titlebars. + - a `GtkWindow` + a `GtkWindow` - Drop the internal reference GTK holds on toplevel windows. + Drop the internal reference GTK holds on toplevel windows. + - The window to destroy + The window to destroy - Asks to place @window in the fullscreen state. + Asks to place @window in the fullscreen state. Note that you shouldn’t assume the window is definitely fullscreen afterward, because other entities (e.g. the user or window manager @@ -105916,18 +111058,19 @@ to fullscreen windows. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications of the [property@Gtk.Window:fullscreened] property. + - a `GtkWindow` + a `GtkWindow` - Asks to place @window in the fullscreen state on the given @monitor. + Asks to place @window in the fullscreen state on the given @monitor. Note that you shouldn't assume the window is definitely fullscreen afterward, or that the windowing system allows fullscreen windows on @@ -105936,343 +111079,365 @@ any given monitor. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications of the [property@Gtk.Window:fullscreened] property. + - a `GtkWindow` + a `GtkWindow` - which monitor to go fullscreen on + which monitor to go fullscreen on - Gets the `GtkApplication` associated with the window. + Gets the `GtkApplication` associated with the window. + - a `GtkApplication` + a `GtkApplication` - a `GtkWindow` + a `GtkWindow` - Gets the child widget of @window. + Gets the child widget of @window. + - the child widget of @window + the child widget of @window - a `GtkWindow` + a `GtkWindow` - Returns whether the window has been set to have decorations. + Returns whether the window has been set to have decorations. + - %TRUE if the window has been set to have decorations + %TRUE if the window has been set to have decorations - a `GtkWindow` + a `GtkWindow` - Gets the default size of the window. + Gets the default size of the window. A value of 0 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used. + - a `GtkWindow` + a `GtkWindow` - location to store the default width + location to store the default width - location to store the default height + location to store the default height - Returns the default widget for @window. + Returns the default widget for @window. + - the default widget + the default widget - a `GtkWindow` + a `GtkWindow` - Returns whether the window has been set to have a close button. + Returns whether the window has been set to have a close button. + - %TRUE if the window has been set to have a close button + %TRUE if the window has been set to have a close button - a `GtkWindow` + a `GtkWindow` - Returns whether the window will be destroyed with its transient parent. + Returns whether the window will be destroyed with its transient parent. + - %TRUE if the window will be destroyed with its transient parent. + %TRUE if the window will be destroyed with its transient parent. - a `GtkWindow` + a `GtkWindow` - Retrieves the current focused widget within the window. + Retrieves the current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then `gtk_widget_has_focus (widget)` will not be %TRUE for the widget. + - the currently focused widget + the currently focused widget - a `GtkWindow` + a `GtkWindow` - Gets whether “focus rectangles” are supposed to be visible. + Gets whether “focus rectangles” are supposed to be visible. + - %TRUE if “focus rectangles” are supposed to be visible + %TRUE if “focus rectangles” are supposed to be visible in this window. - a `GtkWindow` + a `GtkWindow` - Returns the group for @window. + Returns the group for @window. If the window has no group, then the default group is returned. + - the `GtkWindowGroup` for a window + the `GtkWindowGroup` for a window or the default group - a `GtkWindow` + a `GtkWindow` - Returns whether this window reacts to F10 key presses by + Returns whether this window reacts to F10 key presses by activating a menubar it contains. + - %TRUE if the window handles F10 + %TRUE if the window handles F10 - a `GtkWindow` + a `GtkWindow` - Returns whether the window will be hidden when the close button is clicked. + Returns whether the window will be hidden when the close button is clicked. + - %TRUE if the window will be hidden + %TRUE if the window will be hidden - a `GtkWindow` + a `GtkWindow` - Returns the name of the themed icon for the window. + Returns the name of the themed icon for the window. + - the icon name + the icon name - a `GtkWindow` + a `GtkWindow` - Gets whether mnemonics are supposed to be visible. + Gets whether mnemonics are supposed to be visible. + - %TRUE if mnemonics are supposed to be visible + %TRUE if mnemonics are supposed to be visible in this window. - a `GtkWindow` + a `GtkWindow` - Returns whether the window is modal. + Returns whether the window is modal. + - %TRUE if the window is set to be modal and + %TRUE if the window is set to be modal and establishes a grab when shown - a `GtkWindow` + a `GtkWindow` - Gets the value set by gtk_window_set_resizable(). + Gets the value set by gtk_window_set_resizable(). + - %TRUE if the user can resize the window + %TRUE if the user can resize the window - a `GtkWindow` + a `GtkWindow` - Retrieves the title of the window. + Retrieves the title of the window. + - the title of the window + the title of the window - a `GtkWindow` + a `GtkWindow` - Returns the custom titlebar that has been set with + Returns the custom titlebar that has been set with gtk_window_set_titlebar(). + - the custom titlebar + the custom titlebar - a `GtkWindow` + a `GtkWindow` - Fetches the transient parent for this window. + Fetches the transient parent for this window. + - the transient parent for this window + the transient parent for this window - a `GtkWindow` + a `GtkWindow` - Returns whether @window has an explicit window group. + Returns whether @window has an explicit window group. + - %TRUE if @window has an explicit window group. + %TRUE if @window has an explicit window group. - a `GtkWindow` + a `GtkWindow` - Returns whether the window is part of the current active toplevel. + Returns whether the window is part of the current active toplevel. The active toplevel is the window receiving keystrokes. The return value is %TRUE if the window is active toplevel itself. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window. + - %TRUE if the window part of the current active window. + %TRUE if the window part of the current active window. - a `GtkWindow` + a `GtkWindow` - Retrieves the current fullscreen state of @window. + Retrieves the current fullscreen state of @window. Note that since fullscreening is ultimately handled by the window manager and happens asynchronously to an application request, you @@ -106282,20 +111447,21 @@ immediately (or at all), as an effect of calling If the window isn't yet mapped, the value returned will whether the initial requested state is fullscreen. + - whether the window has a fullscreen state. + whether the window has a fullscreen state. - a `GtkWindow` + a `GtkWindow` - Retrieves the current maximized state of @window. + Retrieves the current maximized state of @window. Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you @@ -106305,19 +111471,20 @@ immediately (or at all), as an effect of calling If the window isn't yet mapped, the value returned will whether the initial requested state is maximized. + - whether the window has a maximized state. + whether the window has a maximized state. - a `GtkWindow` + a `GtkWindow` - Asks to maximize @window, so that it fills the screen. + Asks to maximize @window, so that it fills the screen. Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager @@ -106332,18 +111499,19 @@ You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications on the [property@Gtk.Window:maximized] property. + - a `GtkWindow` + a `GtkWindow` - Asks to minimize the specified @window. + Asks to minimize the specified @window. Note that you shouldn’t assume the window is definitely minimized afterward, because the windowing system might not support this @@ -106357,34 +111525,36 @@ onscreen. You can track result of this operation via the [property@Gdk.Toplevel:state] property. + - a `GtkWindow` + a `GtkWindow` - Presents a window to the user. + Presents a window to the user. This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly. + - a `GtkWindow` + a `GtkWindow` - Presents a window to the user. + Presents a window to the user. This may mean raising the window in the stacking order, unminimizing it, moving it to the current desktop, and/or @@ -106404,16 +111574,17 @@ Presents a window to the user in response to a user interaction. The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown. + - a `GtkWindow` + a `GtkWindow` - the timestamp of the user interaction (typically a + the timestamp of the user interaction (typically a button or key press event) which triggered this call @@ -106421,7 +111592,7 @@ the window is ready to be shown. - Sets or unsets the `GtkApplication` associated with the window. + Sets or unsets the `GtkApplication` associated with the window. The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way @@ -106434,40 +111605,42 @@ it by setting the @application to %NULL. This is equivalent to calling [method@Gtk.Application.remove_window] and/or [method@Gtk.Application.add_window] on the old/new applications as relevant. + - a `GtkWindow` + a `GtkWindow` - a `GtkApplication`, or %NULL to unset + a `GtkApplication`, or %NULL to unset - Sets the child widget of @window. + Sets the child widget of @window. + - a `GtkWindow` + a `GtkWindow` - the child widget + the child widget - Sets whether the window should be decorated. + Sets whether the window should be decorated. By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK to disable these @@ -106480,22 +111653,23 @@ window that is already visible, so you should call it before calling On Windows, this function always works, since there’s no window manager policy involved. + - a `GtkWindow` + a `GtkWindow` - %TRUE to decorate the window + %TRUE to decorate the window - Sets the default size of a window. + Sets the default size of a window. If the window’s “natural” size (its size request) is larger than the default, the default will be ignored. @@ -106520,40 +111694,42 @@ note that the appropriate size to save is the one returned by [method@Gtk.Window.get_default_size]. Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows. + - a `GtkWindow` + a `GtkWindow` - width in pixels, or -1 to unset the default width + width in pixels, or -1 to unset the default width - height in pixels, or -1 to unset the default height + height in pixels, or -1 to unset the default height - Sets the default widget. + Sets the default widget. The default widget is the widget that is activated when the user presses Enter in a dialog (for example). + - a `GtkWindow` + a `GtkWindow` - widget to be the default + widget to be the default to unset the default widget for the toplevel @@ -106561,7 +111737,7 @@ presses Enter in a dialog (for example). - Sets whether the window should be deletable. + Sets whether the window should be deletable. By default, windows have a close button in the window frame. Some window managers allow GTK to disable this button. If you @@ -106573,80 +111749,84 @@ so you should call it before calling [method@Gtk.Widget.show]. On Windows, this function always works, since there’s no window manager policy involved. + - a `GtkWindow` + a `GtkWindow` - %TRUE to decorate the window as deletable + %TRUE to decorate the window as deletable - If @setting is %TRUE, then destroying the transient parent of @window + If @setting is %TRUE, then destroying the transient parent of @window will also destroy @window itself. This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they are associated with, for example. + - a `GtkWindow` + a `GtkWindow` - whether to destroy @window with its transient parent + whether to destroy @window with its transient parent - Sets the `GdkDisplay` where the @window is displayed. + Sets the `GdkDisplay` where the @window is displayed. If the window is already mapped, it will be unmapped, and then remapped on the new display. + - a `GtkWindow` + a `GtkWindow` - a `GdkDisplay` + a `GdkDisplay` - Sets the focus widget. + Sets the focus widget. If @focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If @focus is %NULL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use [method@Gtk.Widget.grab_focus] instead of this function. + - a `GtkWindow` + a `GtkWindow` - widget to be the new focus widget, or %NULL to unset + widget to be the new focus widget, or %NULL to unset any focus widget for the toplevel window. @@ -106654,141 +111834,148 @@ to use [method@Gtk.Widget.grab_focus] instead of this function. - Sets whether “focus rectangles” are supposed to be visible. + Sets whether “focus rectangles” are supposed to be visible. + - a `GtkWindow` + a `GtkWindow` - the new value + the new value - Sets whether this window should react to F10 key presses + Sets whether this window should react to F10 key presses by activating a menubar it contains. + - a `GtkWindow` + a `GtkWindow` - %TRUE to make @window handle F10 + %TRUE to make @window handle F10 - If @setting is %TRUE, then clicking the close button on the window + If @setting is %TRUE, then clicking the close button on the window will not destroy it, but only hide it. + - a `GtkWindow` + a `GtkWindow` - whether to hide the window when it is closed + whether to hide the window when it is closed - Sets the icon for the window from a named themed icon. + Sets the icon for the window from a named themed icon. See the docs for [class@Gtk.IconTheme] for more details. On some platforms, the window icon is not used at all. Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM. + - a `GtkWindow` + a `GtkWindow` - the name of the themed icon + the name of the themed icon - Sets whether mnemonics are supposed to be visible. + Sets whether mnemonics are supposed to be visible. + - a `GtkWindow` + a `GtkWindow` - the new value + the new value - Sets a window modal or non-modal. + Sets a window modal or non-modal. Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use [method@Gtk.Window.set_transient_for] to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent. + - a `GtkWindow` + a `GtkWindow` - whether the window is modal + whether the window is modal - Sets whether the user can resize a window. + Sets whether the user can resize a window. Windows are user resizable by default. + - a `GtkWindow` + a `GtkWindow` - %TRUE if the user can resize this window + %TRUE if the user can resize this window - Sets the startup notification ID. + Sets the startup notification ID. Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other @@ -106802,23 +111989,24 @@ other processes. You should use this function before calling a window map event. This function is only useful on X11, not with other GTK targets. + - a `GtkWindow` + a `GtkWindow` - a string with startup-notification identifier + a string with startup-notification identifier - Sets the title of the `GtkWindow`. + Sets the title of the `GtkWindow`. The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager @@ -106828,22 +112016,23 @@ this window from other windows they may have open. A good title might include the application name and current document filename, for example. Passing %NULL does the same as setting the title to an empty string. + - a `GtkWindow` + a `GtkWindow` - title of the window + title of the window - Sets a custom titlebar for @window. + Sets a custom titlebar for @window. A typical widget used here is [class@Gtk.HeaderBar], as it provides various features expected of a titlebar while allowing @@ -106854,23 +112043,24 @@ the window manager not to put its own titlebar on the window. Depending on the system, this function may not work for a window that is already visible, so you set the titlebar before calling [method@Gtk.Widget.show]. + - a `GtkWindow` + a `GtkWindow` - the widget to use as titlebar + the widget to use as titlebar - Dialog windows should be set transient for the main application + Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. [ctor@Gtk.Dialog.new_with_buttons] and other @@ -106881,22 +112071,23 @@ Passing %NULL for @parent unsets the current transient window. On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X. + - a `GtkWindow` + a `GtkWindow` - parent window + parent window - Asks to remove the fullscreen state for @window, and return to + Asks to remove the fullscreen state for @window, and return to its previous state. Note that you shouldn’t assume the window is definitely not @@ -106909,18 +112100,19 @@ write code that crashes if not. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications of the [property@Gtk.Window:fullscreened] property. + - a `GtkWindow` + a `GtkWindow` - Asks to unmaximize @window. + Asks to unmaximize @window. Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager @@ -106930,18 +112122,19 @@ unmaximize. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications on the [property@Gtk.Window:maximized] property. + - a `GtkWindow` + a `GtkWindow` - Asks to unminimize the specified @window. + Asks to unminimize the specified @window. Note that you shouldn’t assume the window is definitely unminimized afterward, because the windowing system might not support this @@ -106951,12 +112144,13 @@ which case minimization isn’t possible, etc. You can track result of this operation via the [property@Gdk.Toplevel:state] property. + - a `GtkWindow` + a `GtkWindow` @@ -106964,7 +112158,7 @@ You can track result of this operation via the - The `GtkApplication` associated with the window. + The `GtkApplication` associated with the window. The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() @@ -106978,50 +112172,50 @@ remove it by setting the :application property to %NULL. - The child widget. + The child widget. - Whether the window should have a frame (also known as *decorations*). + Whether the window should have a frame (also known as *decorations*). - The default height of the window. + The default height of the window. - The default widget. + The default widget. - The default width of the window. + The default width of the window. - Whether the window frame should have a close button. + Whether the window frame should have a close button. - If this window should be destroyed when the parent is destroyed. + If this window should be destroyed when the parent is destroyed. - The display that will display this window. + The display that will display this window. - Whether 'focus rectangles' are currently visible in this window. + Whether 'focus rectangles' are currently visible in this window. This property is maintained by GTK based on user input and should not be set by applications. @@ -107030,12 +112224,12 @@ and should not be set by applications. - The focus widget. + The focus widget. - Whether the window is fullscreen. + Whether the window is fullscreen. Setting this property is the equivalent of calling [method@Gtk.Window.fullscreen] or [method@Gtk.Window.unfullscreen]; @@ -107047,32 +112241,32 @@ operation was successful. - Whether the window frame should handle F10 for activating + Whether the window frame should handle F10 for activating menubars. - If this window should be hidden when the users clicks the close button. + If this window should be hidden when the users clicks the close button. - Specifies the name of the themed icon to use as the window icon. + Specifies the name of the themed icon to use as the window icon. See [class@Gtk.IconTheme] for more details. - Whether the toplevel is the currently active window. + Whether the toplevel is the currently active window. - Whether the window is maximized. + Whether the window is maximized. Setting this property is the equivalent of calling [method@Gtk.Window.maximize] or [method@Gtk.Window.unmaximize]; @@ -107084,7 +112278,7 @@ operation was successful. - Whether mnemonics are currently visible in this window. + Whether mnemonics are currently visible in this window. This property is maintained by GTK based on user input, and should not be set by applications. @@ -107093,37 +112287,37 @@ and should not be set by applications. - If %TRUE, the window is modal. + If %TRUE, the window is modal. - If %TRUE, users can resize the window. + If %TRUE, users can resize the window. - A write-only property for setting window's startup notification identifier. + A write-only property for setting window's startup notification identifier. - The title of the window. + The title of the window. - The transient parent of the window. + The transient parent of the window. - Emitted when the user activates the default widget + Emitted when the user activates the default widget of @window. This is a [keybinding signal](class.SignalAction.html). @@ -107132,7 +112326,7 @@ This is a [keybinding signal](class.SignalAction.html). - Emitted when the user activates the currently focused + Emitted when the user activates the currently focused widget of @window. This is a [keybinding signal](class.SignalAction.html). @@ -107141,14 +112335,14 @@ This is a [keybinding signal](class.SignalAction.html). - Emitted when the user clicks on the close button of the window. + Emitted when the user clicks on the close button of the window. - %TRUE to stop other handlers from being invoked for the signal + %TRUE to stop other handlers from being invoked for the signal - Emitted when the user enables or disables interactive debugging. + Emitted when the user enables or disables interactive debugging. When @toggle is %TRUE, interactive debugging is toggled on or off, when it is %FALSE, the debugger will be pointed at the widget @@ -107159,18 +112353,18 @@ This is a [keybinding signal](class.SignalAction.html). The default bindings for this signal are Ctrl-Shift-I and Ctrl-Shift-D. - %TRUE if the key binding was handled + %TRUE if the key binding was handled - toggle the debugger + toggle the debugger - emitted when the set of accelerators or mnemonics that + emitted when the set of accelerators or mnemonics that are associated with @window changes. @@ -107178,12 +112372,14 @@ are associated with @window changes. + - The parent class. + The parent class. + @@ -107196,6 +112392,7 @@ are associated with @window changes. + @@ -107208,6 +112405,7 @@ are associated with @window changes. + @@ -107220,6 +112418,7 @@ are associated with @window changes. + @@ -107235,6 +112434,7 @@ are associated with @window changes. + @@ -107252,7 +112452,7 @@ are associated with @window changes. - `GtkWindowControls` shows window frame controls. + `GtkWindowControls` shows window frame controls. Typical window frame controls are minimize, maximize and close buttons, and the window icon. @@ -107302,67 +112502,72 @@ style class. # Accessibility `GtkWindowControls` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. + - Creates a new `GtkWindowControls`. + Creates a new `GtkWindowControls`. + - a new `GtkWindowControls`. + a new `GtkWindowControls`. - the side + the side - Gets the decoration layout of this `GtkWindowControls`. + Gets the decoration layout of this `GtkWindowControls`. + - the decoration layout or %NULL if it is unset + the decoration layout or %NULL if it is unset - a `GtkWindowControls` + a `GtkWindowControls` - Gets whether the widget has any window buttons. + Gets whether the widget has any window buttons. + - %TRUE if the widget has window buttons, otherwise %FALSE + %TRUE if the widget has window buttons, otherwise %FALSE - a `GtkWindowControls` + a `GtkWindowControls` - Gets the side to which this `GtkWindowControls` instance belongs. + Gets the side to which this `GtkWindowControls` instance belongs. + - the side + the side - a `GtkWindowControls` + a `GtkWindowControls` - Sets the decoration layout for the title buttons. + Sets the decoration layout for the title buttons. This overrides the [property@Gtk.Settings:gtk-decoration-layout] setting. @@ -107377,35 +112582,37 @@ on the left, and minimize, maximize and close buttons on the right. If [property@Gtk.WindowControls:side] value is @GTK_PACK_START, @self will display the part before the colon, otherwise after that. + - a `GtkWindowControls` + a `GtkWindowControls` - a decoration layout, or %NULL to unset the layout + a decoration layout, or %NULL to unset the layout - Determines which part of decoration layout the `GtkWindowControls` uses. + Determines which part of decoration layout the `GtkWindowControls` uses. See [property@Gtk.WindowControls:decoration-layout]. + - a `GtkWindowControls` + a `GtkWindowControls` - a side + a side @@ -107413,7 +112620,7 @@ See [property@Gtk.WindowControls:decoration-layout]. - The decoration layout for window buttons. + The decoration layout for window buttons. If this property is not set, the [property@Gtk.Settings:gtk-decoration-layout] setting is used. @@ -107421,25 +112628,26 @@ If this property is not set, the - Whether the widget has any window buttons. + Whether the widget has any window buttons. - Whether the widget shows start or end side of the decoration layout. + Whether the widget shows start or end side of the decoration layout. See [property@Gtk.WindowControls:decoration_layout]. + - `GtkWindowGroup` makes group of windows behave like separate applications. + `GtkWindowGroup` makes group of windows behave like separate applications. It achieves this by limiting the effect of GTK grabs and modality to windows in the same group. @@ -107455,36 +112663,40 @@ windows in the window group are subsequently destroyed, then they will be removed from the window group and drop their references on the window group; when all window have been removed, the window group will be freed. + - Creates a new `GtkWindowGroup` object. + Creates a new `GtkWindowGroup` object. Modality of windows only affects windows within the same `GtkWindowGroup`. + - a new `GtkWindowGroup`. + a new `GtkWindowGroup`. - Adds a window to a `GtkWindowGroup`. + Adds a window to a `GtkWindowGroup`. + - a `GtkWindowGroup` + a `GtkWindowGroup` - the `GtkWindow` to add + the `GtkWindow` to add - Returns a list of the `GtkWindows` that belong to @window_group. + Returns a list of the `GtkWindows` that belong to @window_group. + - A + A newly-allocated list of windows inside the group. @@ -107492,23 +112704,24 @@ within the same `GtkWindowGroup`. - a `GtkWindowGroup` + a `GtkWindowGroup` - Removes a window from a `GtkWindowGroup`. + Removes a window from a `GtkWindowGroup`. + - a `GtkWindowGroup` + a `GtkWindowGroup` - the `GtkWindow` to remove + the `GtkWindow` to remove @@ -107521,11 +112734,13 @@ within the same `GtkWindowGroup`. + + @@ -107533,6 +112748,7 @@ within the same `GtkWindowGroup`. + @@ -107540,6 +112756,7 @@ within the same `GtkWindowGroup`. + @@ -107547,15 +112764,18 @@ within the same `GtkWindowGroup`. + - + + + - `GtkWindowHandle` is a titlebar area widget. + `GtkWindowHandle` is a titlebar area widget. When added into a window, it can be dragged to move the window, and handles right click, double click and middle click as expected of a titlebar. @@ -107567,43 +112787,47 @@ right click, double click and middle click as expected of a titlebar. # Accessibility `GtkWindowHandle` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. + - Creates a new `GtkWindowHandle`. + Creates a new `GtkWindowHandle`. + - a new `GtkWindowHandle`. + a new `GtkWindowHandle`. - Gets the child widget of @self. + Gets the child widget of @self. + - the child widget of @self + the child widget of @self - a `GtkWindowHandle` + a `GtkWindowHandle` - Sets the child widget of @self. + Sets the child widget of @self. + - a `GtkWindowHandle` + a `GtkWindowHandle` - the child widget + the child widget @@ -107611,64 +112835,67 @@ right click, double click and middle click as expected of a titlebar. - The child widget. + The child widget. + - Describes a type of line wrapping. + Describes a type of line wrapping. - do not wrap lines; just make the text area wider + do not wrap lines; just make the text area wider - wrap text, breaking lines anywhere the cursor can + wrap text, breaking lines anywhere the cursor can appear (between characters, usually - if you want to be technical, between graphemes, see pango_get_log_attrs()) - wrap text, breaking lines in between words + wrap text, breaking lines in between words - wrap text, breaking lines in between words, or if + wrap text, breaking lines in between words, or if that is not enough, also between graphemes - Gets the modifier mask. + Gets the modifier mask. The modifier mask determines which modifiers are considered significant for keyboard accelerators. This includes all keyboard modifiers except for %GDK_LOCK_MASK. + - the modifier mask for accelerators + the modifier mask for accelerators - Converts an accelerator keyval and modifier mask into a string + Converts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user. + - a newly-allocated string representing the accelerator + a newly-allocated string representing the accelerator - accelerator keyval + accelerator keyval - accelerator modifier mask + accelerator modifier mask - Converts an accelerator keyval and modifier mask + Converts an accelerator keyval and modifier mask into a string that can be displayed to the user. The string may be translated. @@ -107677,31 +112904,32 @@ This function is similar to [func@Gtk.accelerator_get_label], but handling keycodes. This is only useful for system-level components, applications should use [func@Gtk.accelerator_get_label] instead. + - a newly-allocated string representing the accelerator + a newly-allocated string representing the accelerator - a `GdkDisplay` or %NULL to use the default display + a `GdkDisplay` or %NULL to use the default display - accelerator keyval + accelerator keyval - accelerator keycode + accelerator keycode - accelerator modifier mask + accelerator modifier mask - Converts an accelerator keyval and modifier mask into a string + Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse(). For example, if you pass in %GDK_KEY_q and %GDK_CONTROL_MASK, @@ -107709,53 +112937,55 @@ this function returns `<Control>q`. If you need to display accelerators in the user interface, see [func@Gtk.accelerator_get_label]. + - a newly-allocated accelerator name + a newly-allocated accelerator name - accelerator keyval + accelerator keyval - accelerator modifier mask + accelerator modifier mask - Converts an accelerator keyval and modifier mask + Converts an accelerator keyval and modifier mask into a string parseable by gtk_accelerator_parse_with_keycode(). This is similar to [func@Gtk.accelerator_name] but handling keycodes. This is only useful for system-level components, applications should use [func@Gtk.accelerator_name] instead. + - a newly allocated accelerator name. + a newly allocated accelerator name. - a `GdkDisplay` or %NULL to use the default display + a `GdkDisplay` or %NULL to use the default display - accelerator keyval + accelerator keyval - accelerator keycode + accelerator keycode - accelerator modifier mask + accelerator modifier mask - Parses a string representing an accelerator. + Parses a string representing an accelerator. The format looks like “<Control>a” or “<Shift><Alt>F1”. @@ -107767,27 +112997,28 @@ but the lowercase name, e.g. one would use “<Ctrl>minus” ins If the parse fails, @accelerator_key and @accelerator_mods will be set to 0 (zero). + - string representing an accelerator + string representing an accelerator - return location for accelerator keyval + return location for accelerator keyval - return location for accelerator + return location for accelerator modifier mask - Parses a string representing an accelerator. + Parses a string representing an accelerator. This is similar to [func@Gtk.accelerator_parse] but handles keycodes as well. This is only useful for system-level components, applications should @@ -107801,60 +113032,63 @@ is given, the parse will fail. If the parse fails, @accelerator_key, @accelerator_mods and @accelerator_codes will be set to 0 (zero). + - %TRUE if parsing succeeded + %TRUE if parsing succeeded - string representing an accelerator + string representing an accelerator - the `GdkDisplay` to look up @accelerator_codes in + the `GdkDisplay` to look up @accelerator_codes in - return location for accelerator keyval + return location for accelerator keyval - + return location for accelerator keycodes - return location for accelerator + return location for accelerator modifier mask - Determines whether a given keyval and modifier mask constitute + Determines whether a given keyval and modifier mask constitute a valid keyboard accelerator. For example, the %GDK_KEY_a keyval plus %GDK_CONTROL_MASK mark is valid, and matches the “Ctrl+a” accelerator. But, you can't, for instance, use the %GDK_KEY_Control_L keyval as an accelerator. + - %TRUE if the accelerator is valid + %TRUE if the accelerator is valid - a GDK keyval + a GDK keyval - modifier mask + modifier mask + @@ -107868,6 +113102,7 @@ the %GDK_KEY_Control_L keyval as an accelerator. + @@ -107881,6 +113116,7 @@ the %GDK_KEY_Control_L keyval as an accelerator. + @@ -107894,77 +113130,80 @@ the %GDK_KEY_Control_L keyval as an accelerator. - Initializes @iter to point to @target. + Initializes @iter to point to @target. If @target is not found, finds the next value after it. If no value >= @target exists in @set, this function returns %FALSE. + - %TRUE if a value was found. + %TRUE if a value was found. - a pointer to an uninitialized `GtkBitsetIter` + a pointer to an uninitialized `GtkBitsetIter` - a `GtkBitset` + a `GtkBitset` - target value to start iterating at + target value to start iterating at - Set to the found value in @set + Set to the found value in @set - Initializes an iterator for @set and points it to the first + Initializes an iterator for @set and points it to the first value in @set. If @set is empty, %FALSE is returned and @value is set to %G_MAXUINT. + - %TRUE if @set isn't empty. + %TRUE if @set isn't empty. - a pointer to an uninitialized `GtkBitsetIter` + a pointer to an uninitialized `GtkBitsetIter` - a `GtkBitset` + a `GtkBitset` - Set to the first value in @set + Set to the first value in @set - Initializes an iterator for @set and points it to the last + Initializes an iterator for @set and points it to the last value in @set. If @set is empty, %FALSE is returned. + - %TRUE if @set isn't empty. + %TRUE if @set isn't empty. - a pointer to an uninitialized `GtkBitsetIter` + a pointer to an uninitialized `GtkBitsetIter` - a `GtkBitset` + a `GtkBitset` - Set to the last value in @set + Set to the last value in @set @@ -107975,7 +113214,7 @@ If @set is empty, %FALSE is returned. - Checks that the GTK library in use is compatible with the + Checks that the GTK library in use is compatible with the given version. Generally you would pass in the constants %GTK_MAJOR_VERSION, @@ -107998,8 +113237,9 @@ check isn’t completely reliable, since the module may be linked against an old version of GTK and calling the old version of gtk_check_version(), but still get loaded into an application using a newer version of GTK. + - %NULL if the GTK library is compatible with the + %NULL if the GTK library is compatible with the given version, or a string describing the version mismatch. The returned string is owned by GTK and should not be modified or freed. @@ -108007,15 +113247,15 @@ into an application using a newer version of GTK. - the required major version + the required major version - the required minor version + the required minor version - the required micro version + the required micro version @@ -108031,12 +113271,13 @@ into an application using a newer version of GTK. + - Prevents [id@gtk_init] and [id@gtk_init_check] from automatically calling + Prevents [id@gtk_init] and [id@gtk_init_check] from automatically calling `setlocale (LC_ALL, "")`. You would want to use this function if you wanted to set the locale for @@ -108044,34 +113285,36 @@ your program to something other than the user’s locale, or if you wanted to set different values for different locale categories. Most programs should not need to call this function. + - Distributes @extra_space to child @sizes by bringing smaller + Distributes @extra_space to child @sizes by bringing smaller children up to natural size first. The remaining space will be added to the @minimum_size member of the `GtkRequestedSize` struct. If all sizes reach their natural size then the remaining space is returned. + - The remainder of @extra_space after redistributing space + The remainder of @extra_space after redistributing space to @sizes. - Extra space to redistribute among children after subtracting + Extra space to redistribute among children after subtracting minimum sizes and any child padding from the overall allocation - Number of requests to fit into the allocation + Number of requests to fit into the allocation - An array of structs with a client pointer and a minimum/natural size + An array of structs with a client pointer and a minimum/natural size in the orientation of the allocation. @@ -108080,65 +113323,67 @@ to @sizes. - Gets a property of the `GtkEditable` delegate for @object. + Gets a property of the `GtkEditable` delegate for @object. This is helper function that should be called in the `get_property` function of your `GtkEditable` implementation, before handling your own properties. + - %TRUE if the property was found + %TRUE if the property was found - a `GObject` + a `GObject` - a property ID + a property ID - value to set + value to set - the `GParamSpec` for the property + the `GParamSpec` for the property - Sets a property on the `GtkEditable` delegate for @object. + Sets a property on the `GtkEditable` delegate for @object. This is a helper function that should be called in the `set_property` function of your `GtkEditable` implementation, before handling your own properties. + - %TRUE if the property was found + %TRUE if the property was found - a `GObject` + a `GObject` - a property ID + a property ID - value to set + value to set - the `GParamSpec` for the property + the `GParamSpec` for the property - Installs the `GtkEditable` properties for @class. + Installs the `GtkEditable` properties for @class. This is a helper function that should be called in class_init, after installing your own properties. @@ -108149,76 +113394,80 @@ and [func@Gtk.Editable.delegate_get_property] (if you are using a delegate), or remember the @first_prop offset and add it to the values in the [enum@Gtk.EditableProperties] enumeration to get the property IDs for these properties. + - the number of properties that were installed + the number of properties that were installed - a `GObjectClass` + a `GObjectClass` - property ID to use for the first property + property ID to use for the first property - Calls a function for all `GtkPrinter`s. + Calls a function for all `GtkPrinter`s. If @func returns %TRUE, the enumeration is stopped. + - a function to call for each printer + a function to call for each printer - user data to pass to @func + user data to pass to @func - function to call if @data is no longer needed + function to call if @data is no longer needed - if %TRUE, wait in a recursive mainloop until + if %TRUE, wait in a recursive mainloop until all printers are enumerated; otherwise return early - Registers an error quark for `GtkFileChooser` errors. + Registers an error quark for `GtkFileChooser` errors. - The error quark used for `GtkFileChooser` errors. + The error quark used for `GtkFileChooser` errors. - Returns the binary age as passed to `libtool`. + Returns the binary age as passed to `libtool`. If `libtool` means nothing to you, don't worry about it. + - the binary age of the GTK library + the binary age of the GTK library - Returns the GTK debug flags that are currently active. + Returns the GTK debug flags that are currently active. This function is intended for GTK modules that want to adjust their debug output based on GTK debug flags. + - the GTK debug flags. + the GTK debug flags. - Returns the `PangoLanguage` for the default language + Returns the `PangoLanguage` for the default language currently in effect. Note that this can change over the life of an @@ -108231,23 +113480,25 @@ the right-to-left or left-to-right text direction. This function is equivalent to [func@Pango.Language.get_default]. See that function for details. + - the default language as a + the default language as a `PangoLanguage` - Returns the interface age as passed to `libtool`. + Returns the interface age as passed to `libtool`. If `libtool` means nothing to you, don't worry about it. + - the interface age of the GTK library + the interface age of the GTK library - Get the direction of the current locale. This is the expected + Get the direction of the current locale. This is the expected reading direction for text and UI. This function depends on the current locale being set with @@ -108268,13 +113519,14 @@ setlocale (LC_ALL, new_locale); direction = gtk_get_locale_direction (); gtk_widget_set_default_direction (direction); ]| + - the `GtkTextDirection` of the current locale + the `GtkTextDirection` of the current locale - Returns the major version number of the GTK library. + Returns the major version number of the GTK library. For example, in GTK version 3.1.5 this is 3. @@ -108282,13 +113534,14 @@ This function is in the library, so it represents the GTK library your code is running against. Contrast with the %GTK_MAJOR_VERSION macro, which represents the major version of the GTK headers you have included when compiling your code. + - the major version number of the GTK library + the major version number of the GTK library - Returns the micro version number of the GTK library. + Returns the micro version number of the GTK library. For example, in GTK version 3.1.5 this is 5. @@ -108296,13 +113549,14 @@ This function is in the library, so it represents the GTK library your code is are running against. Contrast with the %GTK_MICRO_VERSION macro, which represents the micro version of the GTK headers you have included when compiling your code. + - the micro version number of the GTK library + the micro version number of the GTK library - Returns the minor version number of the GTK library. + Returns the minor version number of the GTK library. For example, in GTK version 3.1.5 this is 1. @@ -108310,13 +113564,14 @@ This function is in the library, so it represents the GTK library your code is are running against. Contrast with the %GTK_MINOR_VERSION macro, which represents the minor version of the GTK headers you have included when compiling your code. + - the minor version number of the GTK library + the minor version number of the GTK library - GTK supports Drag-and-Drop in tree views with a high-level and a low-level + GTK supports Drag-and-Drop in tree views with a high-level and a low-level API. The low-level API consists of the GTK DND API, augmented by some treeview @@ -108333,36 +113588,37 @@ and auto-scroll, but your models have to implement the `GtkTreeDragSource` and `GtkTreeDragDest` interfaces. - Converts a color from HSV space to RGB. + Converts a color from HSV space to RGB. Input values must be in the [0.0, 1.0] range; output values will be in the same range. + - Hue + Hue - Saturation + Saturation - Value + Value - Return value for the red component + Return value for the red component - Return value for the green component + Return value for the green component - Return value for the blue component + Return value for the blue component @@ -108373,7 +113629,7 @@ output values will be in the same range. - Call this function before using any other GTK functions in your GUI + Call this function before using any other GTK functions in your GUI applications. It will initialize everything needed to operate the toolkit and parses some standard command line options. @@ -108392,72 +113648,79 @@ almost never wanted in graphical applications. If you do need to handle SIGPIPE for some reason, reset the handler after gtk_init(), but notice that other libraries (e.g. libdbus or gvfs) might do similar things. + - This function does the same work as gtk_init() with only a single + This function does the same work as gtk_init() with only a single change: It does not terminate the program if the windowing system can’t be initialized. Instead it returns %FALSE on failure. This way the application can fall back to some other means of communication with the user - for example a curses or command line interface. + - %TRUE if the windowing system has been successfully + %TRUE if the windowing system has been successfully initialized, %FALSE otherwise - Use this function to check if GTK has been initialized with gtk_init() + Use this function to check if GTK has been initialized with gtk_init() or gtk_init_check(). + - the initialization status + the initialization status - Finds the `GtkNative` associated with the surface. + Finds the `GtkNative` associated with the surface. + - the `GtkNative` that is associated with @surface + the `GtkNative` that is associated with @surface - a `GdkSurface` + a `GdkSurface` - Converts the result of a `GCompareFunc` like strcmp() to a + Converts the result of a `GCompareFunc` like strcmp() to a `GtkOrdering` value. + - the corresponding `GtkOrdering` + the corresponding `GtkOrdering` - Result of a comparison function + Result of a comparison function - Returns the name of the default paper size, which + Returns the name of the default paper size, which depends on the current locale. + - the name of the default paper size. The string + the name of the default paper size. The string is owned by GTK and should not be modified. - Creates a list of known paper sizes. + Creates a list of known paper sizes. + - a newly allocated list of newly + a newly allocated list of newly allocated `GtkPaperSize` objects @@ -108465,48 +113728,49 @@ is owned by GTK and should not be modified. - whether to include custom paper sizes + whether to include custom paper sizes as defined in the page setup dialog - Creates a new `GParamSpec` instance for a property holding a `GtkExpression`. + Creates a new `GParamSpec` instance for a property holding a `GtkExpression`. See `g_param_spec_internal()` for details on the property strings. + - a newly created property specification + a newly created property specification - canonical name of the property + canonical name of the property - a user-readable name for the property + a user-readable name for the property - a user-readable description of the property + a user-readable description of the property - flags for the property + flags for the property - Registers an error quark for `GtkPrintOperation` if necessary. + Registers an error quark for `GtkPrintOperation` if necessary. - The error quark used for `GtkPrintOperation` errors. + The error quark used for `GtkPrintOperation` errors. - Runs a page setup dialog, letting the user modify the values from + Runs a page setup dialog, letting the user modify the values from @page_setup. If the user cancels the dialog, the returned `GtkPageSetup` is identical to the passed in @page_setup, otherwise it contains the modifications done in the dialog. @@ -108514,54 +113778,56 @@ modifications done in the dialog. Note that this function may use a recursive mainloop to show the page setup dialog. See gtk_print_run_page_setup_dialog_async() if this is a problem. + - a new `GtkPageSetup` + a new `GtkPageSetup` - transient parent + transient parent - an existing `GtkPageSetup` + an existing `GtkPageSetup` - a `GtkPrintSettings` + a `GtkPrintSettings` - Runs a page setup dialog, letting the user modify the values from @page_setup. + Runs a page setup dialog, letting the user modify the values from @page_setup. In contrast to gtk_print_run_page_setup_dialog(), this function returns after showing the page setup dialog on platforms that support this, and calls @done_cb from a signal handler for the ::response signal of the dialog. + - transient parent + transient parent - an existing `GtkPageSetup` + an existing `GtkPageSetup` - a `GtkPrintSettings` + a `GtkPrintSettings` - a function to call when the user saves + a function to call when the user saves the modified page setup - user data to pass to @done_cb + user data to pass to @done_cb @@ -108572,114 +113838,117 @@ from a signal handler for the ::response signal of the dialog. - Renders an activity indicator (such as in `GtkSpinner`). + Renders an activity indicator (such as in `GtkSpinner`). The state %GTK_STATE_FLAG_CHECKED determines whether there is activity going on. + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders an arrow pointing to @angle. + Renders an arrow pointing to @angle. Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π: ![](arrows.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north + arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north - X origin of the render area + X origin of the render area - Y origin of the render area + Y origin of the render area - square side for render area + square side for render area - Renders the background of an element. + Renders the background of an element. Typical background rendering, showing the effect of `background-image`, `border-width` and `border-radius`: ![](background.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders a checkmark (as in a `GtkCheckButton`). + Renders a checkmark (as in a `GtkCheckButton`). The %GTK_STATE_FLAG_CHECKED state determines whether the check is on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it @@ -108688,408 +113957,421 @@ should be marked as undefined. Typical checkmark rendering: ![](checks.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders an expander (as used in `GtkTreeView` and `GtkExpander`) in the area + Renders an expander (as used in `GtkTreeView` and `GtkExpander`) in the area defined by @x, @y, @width, @height. The state %GTK_STATE_FLAG_CHECKED determines whether the expander is collapsed or expanded. Typical expander rendering: ![](expanders.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders a focus indicator on the rectangle determined by @x, @y, @width, @height. + Renders a focus indicator on the rectangle determined by @x, @y, @width, @height. Typical focus rendering: ![](focus.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders a frame around the rectangle defined by @x, @y, @width, @height. + Renders a frame around the rectangle defined by @x, @y, @width, @height. Examples of frame rendering, showing the effect of `border-image`, `border-color`, `border-width`, `border-radius` and junctions: ![](frames.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders a handle (as in `GtkPaned` and `GtkWindow`’s resize grip), + Renders a handle (as in `GtkPaned` and `GtkWindow`’s resize grip), in the rectangle determined by @x, @y, @width, @height. Handles rendered for the paned and grip classes: ![](handles.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Renders the icon in @texture at the specified @x and @y coordinates. + Renders the icon in @texture at the specified @x and @y coordinates. This function will render the icon in @texture at exactly its size, regardless of scaling factors, which may not be appropriate when drawing on displays with high pixel densities. + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - a `GdkTexture` containing the icon to draw + a `GdkTexture` containing the icon to draw - X position for the @texture + X position for the @texture - Y position for the @texture + Y position for the @texture - Renders @layout on the coordinates @x, @y + Renders @layout on the coordinates @x, @y + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin + X origin - Y origin + Y origin - the `PangoLayout` to render + the `PangoLayout` to render - Renders a line from (x0, y0) to (x1, y1). + Renders a line from (x0, y0) to (x1, y1). + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X coordinate for the origin of the line + X coordinate for the origin of the line - Y coordinate for the origin of the line + Y coordinate for the origin of the line - X coordinate for the end of the line + X coordinate for the end of the line - Y coordinate for the end of the line + Y coordinate for the end of the line - Renders an option mark (as in a radio button), the %GTK_STATE_FLAG_CHECKED + Renders an option mark (as in a radio button), the %GTK_STATE_FLAG_CHECKED state will determine whether the option is on or off, and %GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined. Typical option mark rendering: ![](options.png) + - a `GtkStyleContext` + a `GtkStyleContext` - a `cairo_t` + a `cairo_t` - X origin of the rectangle + X origin of the rectangle - Y origin of the rectangle + Y origin of the rectangle - rectangle width + rectangle width - rectangle height + rectangle height - Converts a color from RGB space to HSV. + Converts a color from RGB space to HSV. Input values must be in the [0.0, 1.0] range; output values will be in the same range. + - Red + Red - Green + Green - Blue + Blue - Return value for the hue component + Return value for the hue component - Return value for the saturation component + Return value for the saturation component - Return value for the value component + Return value for the value component - Sets the GTK debug flags. + Sets the GTK debug flags. + - the debug flags to set + the debug flags to set - A convenience function for showing an application’s about dialog. + A convenience function for showing an application’s about dialog. The constructed dialog is associated with the parent window and reused for future invocations of this function. + - the parent top-level window + the parent top-level window - the name of the first property + the name of the first property - value of first property, followed by more pairs of property + value of first property, followed by more pairs of property name and value, `NULL`-terminated - This function launches the default application for showing + This function launches the default application for showing a given uri, or shows an error dialog if that fails. + - parent window + parent window - the uri to show + the uri to show - timestamp from the event that triggered this call, or %GDK_CURRENT_TIME + timestamp from the event that triggered this call, or %GDK_CURRENT_TIME - This function launches the default application for showing + This function launches the default application for showing a given uri. The @callback will be called when the launch is completed. @@ -109097,68 +114379,72 @@ It should call gtk_show_uri_full_finish() to obtain the result. This is the recommended call to be used as it passes information necessary for sandbox helpers to parent their dialogs properly. + - parent window + parent window - the uri to show + the uri to show - timestamp from the event that triggered this call, or %GDK_CURRENT_TIME + timestamp from the event that triggered this call, or %GDK_CURRENT_TIME - a `GCancellable` to cancel the launch + a `GCancellable` to cancel the launch - a callback to call when the action is complete + a callback to call when the action is complete - data to pass to @callback + data to pass to @callback - Finishes the gtk_show_uri() call and returns the result + Finishes the gtk_show_uri() call and returns the result of the operation. + - %TRUE if the URI was shown successfully. + %TRUE if the URI was shown successfully. Otherwise, %FALSE is returned and @error is set - the `GtkWindow` passed to gtk_show_uri() + the `GtkWindow` passed to gtk_show_uri() - `GAsyncResult` that was passed to @callback + `GAsyncResult` that was passed to @callback - Checks whether a `GtkAccessible` implementation has the given @role, + Checks whether a `GtkAccessible` implementation has the given @role, and raises an assertion if the condition is failed. + - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleRole` + a `GtkAccessibleRole` + @@ -109190,142 +114476,149 @@ and raises an assertion if the condition is failed. - Checks whether the accessible @property of @accessible is set to + Checks whether the accessible @property of @accessible is set to a specific value. + - the value of the accessible property + the value of the accessible property - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleProperty` + a `GtkAccessibleProperty` - the expected value of @property + the expected value of @property - Checks whether the accessible @relation of @accessible is set to + Checks whether the accessible @relation of @accessible is set to a specific value. + - the value of the accessible relation + the value of the accessible relation - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleRelation` + a `GtkAccessibleRelation` - the expected value of @relation + the expected value of @relation - Checks whether the accessible @state of @accessible is set to + Checks whether the accessible @state of @accessible is set to a specific value. + - the value of the accessible state + the value of the accessible state - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleState` + a `GtkAccessibleState` - the expected value of @state + the expected value of @state - Checks whether the `GtkAccessible` has @property set. + Checks whether the `GtkAccessible` has @property set. + - %TRUE if the @property is set in the @accessible + %TRUE if the @property is set in the @accessible - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleProperty` + a `GtkAccessibleProperty` - Checks whether the `GtkAccessible` has @relation set. + Checks whether the `GtkAccessible` has @relation set. + - %TRUE if the @relation is set in the @accessible + %TRUE if the @relation is set in the @accessible - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleRelation` + a `GtkAccessibleRelation` - Checks whether the `GtkAccessible:accessible-role` of the accessible + Checks whether the `GtkAccessible:accessible-role` of the accessible is @role. + - %TRUE if the role matches + %TRUE if the role matches - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleRole` + a `GtkAccessibleRole` - Checks whether the `GtkAccessible` has @state set. + Checks whether the `GtkAccessible` has @state set. + - %TRUE if the @state is set in the @accessible + %TRUE if the @state is set in the @accessible - a `GtkAccessible` + a `GtkAccessible` - a `GtkAccessibleState` + a `GtkAccessibleState` - This function is used to initialize a GTK test program. + This function is used to initialize a GTK test program. It will in turn call g_test_init() and gtk_init() to properly initialize the testing framework and graphical toolkit. It’ll @@ -109334,17 +114627,18 @@ program environments as deterministic as possible. Like gtk_init() and g_test_init(), any known arguments will be processed and stripped from @argc and @argv. + - Address of the `argc` parameter of the + Address of the `argc` parameter of the main() function. Changed if any arguments were handled. - Address of the `argv` + Address of the `argv` parameter of main(). Any parameters understood by g_test_init() or gtk_init() are stripped before return. @@ -109352,16 +114646,17 @@ processed and stripped from @argc and @argv. - currently unused + currently unused - Return the type ids that have been registered after + Return the type ids that have been registered after calling gtk_test_register_all_types(). + - + 0-terminated array of type ids @@ -109369,22 +114664,23 @@ calling gtk_test_register_all_types(). - location to store number of types + location to store number of types - Force registration of all core GTK object types. + Force registration of all core GTK object types. This allowes to refer to any of those object types via g_type_from_name() after calling this function. + - Enters the main loop and waits for @widget to be “drawn”. + Enters the main loop and waits for @widget to be “drawn”. In this context that means it waits for the frame clock of @widget to have run a full styling, layout and drawing cycle. @@ -109392,116 +114688,122 @@ In this context that means it waits for the frame clock of This function is intended to be used for syncing with actions that depend on @widget relayouting or on interaction with the display server. + - the widget to wait for + the widget to wait for - Creates a content provider for dragging @path from @tree_model. + Creates a content provider for dragging @path from @tree_model. + - a new `GdkContentProvider` + a new `GdkContentProvider` - a `GtkTreeModel` + a `GtkTreeModel` - a row in @tree_model + a row in @tree_model - Obtains a @tree_model and @path from value of target type + Obtains a @tree_model and @path from value of target type %GTK_TYPE_TREE_ROW_DATA. The returned path must be freed with gtk_tree_path_free(). + - %TRUE if @selection_data had target type %GTK_TYPE_TREE_ROW_DATA + %TRUE if @selection_data had target type %GTK_TYPE_TREE_ROW_DATA is otherwise valid - a `GValue` + a `GValue` - a `GtkTreeModel` + a `GtkTreeModel` - row in @tree_model + row in @tree_model - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::row-deleted signal. + - a `GObject` + a `GObject` - the path position that was deleted + the path position that was deleted - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::row-inserted signal. + - a `GObject` + a `GObject` - the row position that was inserted + the row position that was inserted - Lets a set of row reference created by + Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::rows-reordered signal. + - a `GObject` + a `GObject` - the parent path of the reordered signal + the parent path of the reordered signal - the iter pointing to the parent of the reordered + the iter pointing to the parent of the reordered - the new order of rows + the new order of rows @@ -109509,106 +114811,112 @@ model emitted the ::rows-reordered signal. - Retrieves the `GtkExpression` stored inside the given `value`, and acquires + Retrieves the `GtkExpression` stored inside the given `value`, and acquires a reference to it. + - a `GtkExpression` + a `GtkExpression` - a `GValue` initialized with type `GTK_TYPE_EXPRESSION` + a `GValue` initialized with type `GTK_TYPE_EXPRESSION` - Retrieves the `GtkExpression` stored inside the given `value`. + Retrieves the `GtkExpression` stored inside the given `value`. + - a `GtkExpression` + a `GtkExpression` - a `GValue` initialized with type `GTK_TYPE_EXPRESSION` + a `GValue` initialized with type `GTK_TYPE_EXPRESSION` - Stores the given `GtkExpression` inside `value`. + Stores the given `GtkExpression` inside `value`. The `GValue` will acquire a reference to the `expression`. + - a `GValue` initialized with type `GTK_TYPE_EXPRESSION` + a `GValue` initialized with type `GTK_TYPE_EXPRESSION` - a `GtkExpression` + a `GtkExpression` - Stores the given `GtkExpression` inside `value`. + Stores the given `GtkExpression` inside `value`. This function transfers the ownership of the `expression` to the `GValue`. + - a `GValue` initialized with type `GTK_TYPE_EXPRESSION` + a `GValue` initialized with type `GTK_TYPE_EXPRESSION` - a `GtkExpression` + a `GtkExpression` - Binds a callback function defined in a template to the @widget_class. + Binds a callback function defined in a template to the @widget_class. This macro is a convenience wrapper around the gtk_widget_class_bind_template_callback_full() function. It is not supported after gtk_widget_class_set_template_scope() has been used on @widget_class. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the callback symbol + the callback symbol - Binds a child widget defined in a template to the @widget_class. + Binds a child widget defined in a template to the @widget_class. This macro is a convenience wrapper around the gtk_widget_class_bind_template_child_full() function. This macro will use the offset of the @member_name inside the @TypeName instance structure. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the type name of this widget + the type name of this widget - name of the instance member in the instance struct for @data_type + name of the instance member in the instance struct for @data_type - Binds a child widget defined in a template to the @widget_class, and + Binds a child widget defined in a template to the @widget_class, and also makes it available as an internal child in GtkBuilder, under the name @member_name. @@ -109617,20 +114925,21 @@ gtk_widget_class_bind_template_child_full() function. This macro will use the offset of the @member_name inside the @TypeName instance structure. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the type name, in CamelCase + the type name, in CamelCase - name of the instance member in the instance struct for @data_type + name of the instance member in the instance struct for @data_type - Binds a child widget defined in a template to the @widget_class, and + Binds a child widget defined in a template to the @widget_class, and also makes it available as an internal child in GtkBuilder, under the name @member_name. @@ -109639,20 +114948,21 @@ gtk_widget_class_bind_template_child_full() function. This macro will use the offset of the @member_name inside the @TypeName private data structure. + - a `GtkWidgetClass` + a `GtkWidgetClass` - the type name, in CamelCase + the type name, in CamelCase - name of the instance private member on the private struct for @data_type + name of the instance private member on the private struct for @data_type - Binds a child widget defined in a template to the @widget_class. + Binds a child widget defined in a template to the @widget_class. This macro is a convenience wrapper around the gtk_widget_class_bind_template_child_full() function. @@ -109660,15 +114970,16 @@ gtk_widget_class_bind_template_child_full() function. This macro will use the offset of the @member_name inside the @TypeName private data structure (it uses G_PRIVATE_OFFSET(), so the private struct must be added with G_ADD_PRIVATE()). + - a `GtkWidgetClass` + a `GtkWidgetClass` - the type name of this widget + the type name of this widget - name of the instance private member in the private struct for @data_type + name of the instance private member in the private struct for @data_type diff --git a/HarfBuzz-0.0.gir b/HarfBuzz-0.0.gir index b22f42a..7442683 100644 --- a/HarfBuzz-0.0.gir +++ b/HarfBuzz-0.0.gir @@ -8,117 +8,137 @@ and/or use gtk-doc annotations. --> - Data type for booleans. + Data type for booleans. + - Data type for holding Unicode codepoints. Also + Data type for holding Unicode codepoints. Also used to hold glyph IDs. + - Data type for holding color values. Colors are eight bits per + Data type for holding color values. Colors are eight bits per channel RGB plus alpha transparency. + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the extents for a font, in horizontal-direction text segments. Extents must be returned in an #hb_glyph_extents output parameter. + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the extents for a font, in vertical-direction text segments. Extents must be returned in an #hb_glyph_extents output parameter. + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the advance for a specified glyph, in horizontal-direction text segments. Advances must be returned in an #hb_position_t output parameter. + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the advances for a sequence of glyphs, in horizontal-direction text segments. + + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph, in horizontal-direction text segments. Each coordinate must be returned in an #hb_position_t output parameter. + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the advance for a specified glyph, in vertical-direction text segments. Advances must be returned in an #hb_position_t output parameter. + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the advances for a sequence of glyphs, in vertical-direction text segments. + + - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph, in vertical-direction text segments. Each coordinate must be returned in an #hb_position_t output parameter. + - Data type for bitmasks. + Data type for bitmasks. + - An integral type representing an OpenType 'name' table name identifier. + An integral type representing an OpenType 'name' table name identifier. There are predefined name IDs, as well as name IDs return from other API. These can be used to fetch name strings from a font face. + - Data type for holding a single coordinate value. + Data type for holding a single coordinate value. Contour points and other multi-dimensional data are stored as tuples of #hb_position_t's. + + - Used when getting or setting AAT feature selectors. Indicates that + Used when getting or setting AAT feature selectors. Indicates that there is no selector index corresponding to the selector of interest. + - The default code point for replacing invalid characters in a given encoding. + The default code point for replacing invalid characters in a given encoding. Set to U+FFFD REPLACEMENT CHARACTER. + + @@ -131,99 +151,118 @@ Set to U+FFFD REPLACEMENT CHARACTER. + - Tests whether a text direction moves backward (from right to left, or from + Tests whether a text direction moves backward (from right to left, or from bottom to top). Requires that the direction be valid. + - #hb_direction_t to test + #hb_direction_t to test - Tests whether a text direction moves forward (from left to right, or from + Tests whether a text direction moves forward (from left to right, or from top to bottom). Requires that the direction be valid. + - #hb_direction_t to test + #hb_direction_t to test - Tests whether a text direction is horizontal. Requires + Tests whether a text direction is horizontal. Requires that the direction be valid. + - #hb_direction_t to test + #hb_direction_t to test - Tests whether a text direction is valid. + Tests whether a text direction is valid. + - #hb_direction_t to test + #hb_direction_t to test - Tests whether a text direction is vertical. Requires + Tests whether a text direction is vertical. Requires that the direction be valid. + - #hb_direction_t to test + #hb_direction_t to test - Reverses a text direction. Requires that the direction + Reverses a text direction. Requires that the direction be valid. + - #hb_direction_t to reverse + #hb_direction_t to reverse + + + + + + + + + + + - Constructs an #hb_tag_t from four characters. + Constructs an #hb_tag_t from four characters. + @@ -236,20 +275,24 @@ be valid. + - See Unicode 6.1 for details on the maximum decomposition length. + See Unicode 6.1 for details on the maximum decomposition length. + - Extracts the characters from an #hb_tag_t. + Extracts the characters from an #hb_tag_t. + + @@ -260,777 +303,781 @@ be valid. + + + + - The selectors defined for specifying AAT feature settings. + The selectors defined for specifying AAT feature settings. - Initial, unset feature selector + Initial, unset feature selector - for #HB_AAT_LAYOUT_FEATURE_TYPE_ALL_TYPOGRAPHIC + for #HB_AAT_LAYOUT_FEATURE_TYPE_ALL_TYPOGRAPHIC - for #HB_AAT_LAYOUT_FEATURE_TYPE_ALL_TYPOGRAPHIC + for #HB_AAT_LAYOUT_FEATURE_TYPE_ALL_TYPOGRAPHIC - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES + for #HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES - Deprecated + Deprecated - Deprecated + Deprecated - Deprecated + Deprecated - Deprecated + Deprecated - Deprecated + Deprecated - Deprecated + Deprecated - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION - for #HB_AAT_LAYOUT_FEATURE_TYPE_LINGUISTIC_REARRANGEMENT + for #HB_AAT_LAYOUT_FEATURE_TYPE_LINGUISTIC_REARRANGEMENT - for #HB_AAT_LAYOUT_FEATURE_TYPE_LINGUISTIC_REARRANGEMENT + for #HB_AAT_LAYOUT_FEATURE_TYPE_LINGUISTIC_REARRANGEMENT - for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_SMART_SWASH_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DIACRITICS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DIACRITICS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DIACRITICS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DIACRITICS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DIACRITICS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DIACRITICS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION - for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION + for #HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION - for #HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_OVERLAPPING_CHARACTERS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_OVERLAPPING_CHARACTERS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_OVERLAPPING_CHARACTERS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_OVERLAPPING_CHARACTERS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS + for #HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ORNAMENT_SETS_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_DESIGN_COMPLEXITY_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING + for #HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION + for #HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_ANNOTATION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_KANA_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_KANA_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_KANA_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_KANA_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UNICODE_DECOMPOSITION_TYPE - Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_RUBY_KANA_OFF instead + Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_RUBY_KANA_OFF instead - Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_RUBY_KANA_ON instead + Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_RUBY_KANA_ON instead - for #HB_AAT_LAYOUT_FEATURE_TYPE_RUBY_KANA + for #HB_AAT_LAYOUT_FEATURE_TYPE_RUBY_KANA - for #HB_AAT_LAYOUT_FEATURE_TYPE_RUBY_KANA + for #HB_AAT_LAYOUT_FEATURE_TYPE_RUBY_KANA - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_SYMBOL_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_IDEOGRAPHIC_ALTERNATIVES_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_VERTICAL_ROMAN_PLACEMENT_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_VERTICAL_ROMAN_PLACEMENT_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_VERTICAL_ROMAN_PLACEMENT_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_VERTICAL_ROMAN_PLACEMENT_TYPE - Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_CJK_ITALIC_ROMAN_OFF instead + Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_CJK_ITALIC_ROMAN_OFF instead - Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_CJK_ITALIC_ROMAN_ON instead + Deprecated; use #HB_AAT_LAYOUT_FEATURE_SELECTOR_CJK_ITALIC_ROMAN_ON instead - for #HB_AAT_LAYOUT_FEATURE_TYPE_ITALIC_CJK_ROMAN + for #HB_AAT_LAYOUT_FEATURE_TYPE_ITALIC_CJK_ROMAN - for #HB_AAT_LAYOUT_FEATURE_TYPE_ITALIC_CJK_ROMAN + for #HB_AAT_LAYOUT_FEATURE_TYPE_ITALIC_CJK_ROMAN - for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT + for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT - for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT + for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT - for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT + for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT - for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT + for #HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT - for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA + for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA - for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA + for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA - for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA + for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA - for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA + for #HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES + for #HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES - for #HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE + for #HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE - for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE + for #HB_AAT_LAYOUT_FEATURE_TYPE_CJK_ROMAN_SPACING_TYPE - The possible feature types defined for AAT shaping. + The possible feature types defined for AAT shaping. - Initial, unset feature type + Initial, unset feature type @@ -1112,135 +1159,142 @@ be valid. - Makes a writable copy of @blob. + Makes a writable copy of @blob. + - The new blob, or nullptr if allocation failed + The new blob, or nullptr if allocation failed - A blob. + A blob. - Creates a new "blob" object wrapping @data. The @mode parameter is used + Creates a new "blob" object wrapping @data. The @mode parameter is used to negotiate ownership and lifecycle of @data. + - New blob, or the empty blob if something failed or if @length is + New blob, or the empty blob if something failed or if @length is zero. Destroy with hb_blob_destroy(). - Pointer to blob data. + Pointer to blob data. - Length of @data in bytes. + Length of @data in bytes. - Memory mode for @data. + Memory mode for @data. - Data parameter to pass to @destroy. + Data parameter to pass to @destroy. - Callback to call when @data is not needed anymore. + Callback to call when @data is not needed anymore. - Creates a new blob containing the data from the + Creates a new blob containing the data from the specified binary font file. + - An #hb_blob_t pointer with the content of the file + An #hb_blob_t pointer with the content of the file - A font filename + A font filename - Returns a blob that represents a range of bytes in @parent. The new + Returns a blob that represents a range of bytes in @parent. The new blob is always created with %HB_MEMORY_MODE_READONLY, meaning that it will never modify data in the parent blob. The parent data is not expected to be modified, and will result in undefined behavior if it is. Makes @parent immutable. + - New blob, or the empty blob if something failed or if + New blob, or the empty blob if something failed or if @length is zero or @offset is beyond the end of @parent's data. Destroy with hb_blob_destroy(). - Parent blob. + Parent blob. - Start offset of sub-blob within @parent, in bytes. + Start offset of sub-blob within @parent, in bytes. - Length of sub-blob. + Length of sub-blob. - Decreases the reference count on @blob, and if it reaches zero, destroys + Decreases the reference count on @blob, and if it reaches zero, destroys @blob, freeing all memory, possibly calling the destroy-callback the blob was created for if it has not been called already. See TODO:link object types for more information. + - a blob. + a blob. - Fetches the data from a blob. + Fetches the data from a blob. + - the byte data of @blob. + the byte data of @blob. - a blob. + a blob. - The length in bytes of the data retrieved + The length in bytes of the data retrieved - Tries to make blob data writable (possibly copying it) and + Tries to make blob data writable (possibly copying it) and return pointer to data. Fails if blob has been made immutable, or if memory allocation fails. + - Writable blob data, + Writable blob data, or %NULL if failed. @@ -1248,131 +1302,139 @@ or %NULL if failed. - a blob. + a blob. - output length of the writable data. + output length of the writable data. - Returns the singleton empty blob. + Returns the singleton empty blob. See TODO:link object types for more information. + - The empty blob. + The empty blob. - Fetches the length of a blob's data. + Fetches the length of a blob's data. + - the length of @blob data in bytes. + the length of @blob data in bytes. - a blob. + a blob. - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified font-functions structure. + - A pointer to the user data + A pointer to the user data - a blob + a blob - The user-data key to query + The user-data key to query - Tests whether a blob is immutable. + Tests whether a blob is immutable. + - %true if @blob is immutable, false otherwise + %true if @blob is immutable, false otherwise - a blob. + a blob. - Makes a blob immutable. + Makes a blob immutable. + - a blob + a blob - Increases the reference count on @blob. + Increases the reference count on @blob. See TODO:link object types for more information. + - @blob. + @blob. - a blob. + a blob. - Attaches a user-data key/data pair to the specified blob. + Attaches a user-data key/data pair to the specified blob. + - %true if success, %false otherwise + %true if success, %false otherwise - An #hb_blob_t + An #hb_blob_t - The user-data key to set + The user-data key to set - A pointer to the user data to set + A pointer to the user data to set - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Data type for blobs. A blob wraps a chunk of binary + Data type for blobs. A blob wraps a chunk of binary data and facilitates its lifecycle management between a client program and HarfBuzz. + - Appends a character with the Unicode value of @codepoint to @buffer, and + Appends a character with the Unicode value of @codepoint to @buffer, and gives it the initial cluster value of @cluster. Clusters can be any thing the client wants, they are usually used to refer to the index of the character in the input text stream and are output in @@ -1380,26 +1442,27 @@ character in the input text stream and are output in This function does not check the validity of @codepoint, it is up to the caller to ensure it is a valid Unicode code point. + - An #hb_buffer_t + An #hb_buffer_t - A Unicode code point. + A Unicode code point. - The cluster value of @codepoint. + The cluster value of @codepoint. - Appends characters from @text array to @buffer. The @item_offset is the + Appends characters from @text array to @buffer. The @item_offset is the position of the first character from @text that will be appended, and @item_length is the number of character. When shaping part of a larger text (e.g. a run of text from a paragraph), instead of passing just the substring @@ -1411,225 +1474,233 @@ marks at stat of run. This function does not check the validity of @text, it is up to the caller to ensure it contains a valid Unicode code points. + - a #hb_buffer_t to append characters to. + a #hb_buffer_t to append characters to. - an array of Unicode code points to append. + an array of Unicode code points to append. - the length of the @text, or -1 if it is %NULL terminated. + the length of the @text, or -1 if it is %NULL terminated. - the offset of the first code point to add to the @buffer. + the offset of the first code point to add to the @buffer. - the number of code points to add to the @buffer, or -1 for the + the number of code points to add to the @buffer, or -1 for the end of @text (assuming it is %NULL terminated). - Similar to hb_buffer_add_codepoints(), but allows only access to first 256 + Similar to hb_buffer_add_codepoints(), but allows only access to first 256 Unicode code points that can fit in 8-bit strings. <note>Has nothing to do with non-Unicode Latin-1 encoding.</note> + - An #hb_buffer_t + An #hb_buffer_t - an array of UTF-8 + an array of UTF-8 characters to append - the length of the @text, or -1 if it is %NULL terminated + the length of the @text, or -1 if it is %NULL terminated - the offset of the first character to add to the @buffer + the offset of the first character to add to the @buffer - the number of characters to add to the @buffer, or -1 for the + the number of characters to add to the @buffer, or -1 for the end of @text (assuming it is %NULL terminated) - See hb_buffer_add_codepoints(). + See hb_buffer_add_codepoints(). Replaces invalid UTF-16 characters with the @buffer replacement code point, see hb_buffer_set_replacement_codepoint(). + - An #hb_buffer_t + An #hb_buffer_t - An array of UTF-16 characters to append + An array of UTF-16 characters to append - The length of the @text, or -1 if it is %NULL terminated + The length of the @text, or -1 if it is %NULL terminated - The offset of the first character to add to the @buffer + The offset of the first character to add to the @buffer - The number of characters to add to the @buffer, or -1 for the + The number of characters to add to the @buffer, or -1 for the end of @text (assuming it is %NULL terminated) - See hb_buffer_add_codepoints(). + See hb_buffer_add_codepoints(). Replaces invalid UTF-32 characters with the @buffer replacement code point, see hb_buffer_set_replacement_codepoint(). + - An #hb_buffer_t + An #hb_buffer_t - An array of UTF-32 characters to append + An array of UTF-32 characters to append - The length of the @text, or -1 if it is %NULL terminated + The length of the @text, or -1 if it is %NULL terminated - The offset of the first character to add to the @buffer + The offset of the first character to add to the @buffer - The number of characters to add to the @buffer, or -1 for the + The number of characters to add to the @buffer, or -1 for the end of @text (assuming it is %NULL terminated) - See hb_buffer_add_codepoints(). + See hb_buffer_add_codepoints(). Replaces invalid UTF-8 characters with the @buffer replacement code point, see hb_buffer_set_replacement_codepoint(). + - An #hb_buffer_t + An #hb_buffer_t - An array of UTF-8 + An array of UTF-8 characters to append. - The length of the @text, or -1 if it is %NULL terminated. + The length of the @text, or -1 if it is %NULL terminated. - The offset of the first character to add to the @buffer. + The offset of the first character to add to the @buffer. - The number of characters to add to the @buffer, or -1 for the + The number of characters to add to the @buffer, or -1 for the end of @text (assuming it is %NULL terminated). - Check if allocating memory for the buffer succeeded. + Check if allocating memory for the buffer succeeded. + - %true if @buffer memory allocation succeeded, %false otherwise. + %true if @buffer memory allocation succeeded, %false otherwise. - An #hb_buffer_t + An #hb_buffer_t - Append (part of) contents of another buffer to this buffer. + Append (part of) contents of another buffer to this buffer. + - An #hb_buffer_t + An #hb_buffer_t - source #hb_buffer_t + source #hb_buffer_t - start index into source buffer to copy. Use 0 to copy from start of buffer. + start index into source buffer to copy. Use 0 to copy from start of buffer. - end index into source buffer to copy. Use @HB_FEATURE_GLOBAL_END to copy to end of buffer. + end index into source buffer to copy. Use @HB_FEATURE_GLOBAL_END to copy to end of buffer. - Similar to hb_buffer_reset(), but does not clear the Unicode functions and + Similar to hb_buffer_reset(), but does not clear the Unicode functions and the replacement code point. + - An #hb_buffer_t + An #hb_buffer_t - Data type for holding HarfBuzz's clustering behavior options. The cluster level + Data type for holding HarfBuzz's clustering behavior options. The cluster level dictates one aspect of how HarfBuzz will treat non-base characters during shaping. @@ -1646,35 +1717,36 @@ backward compatibility with older versions of HarfBuzz. New client programs that do not need to maintain such backward compatibility are recommended to use @HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS instead of the default. - Return cluster values grouped by graphemes into + Return cluster values grouped by graphemes into monotone order. - Return cluster values grouped into monotone order. + Return cluster values grouped into monotone order. - Don't group cluster values. + Don't group cluster values. - Default cluster level, + Default cluster level, equal to @HB_BUFFER_CLUSTER_LEVEL_MONOTONE_GRAPHEMES. - Initial value for new buffer. + Initial value for new buffer. - The buffer contains input characters (before shaping). + The buffer contains input characters (before shaping). - The buffer contains output glyphs (after shaping). + The buffer contains output glyphs (after shaping). - Creates a new #hb_buffer_t with all properties to defaults. + Creates a new #hb_buffer_t with all properties to defaults. + - + A newly allocated #hb_buffer_t with a reference count of 1. The initial reference count should be released with hb_buffer_destroy() when you are done using the #hb_buffer_t. This function never returns %NULL. If memory cannot @@ -1684,12 +1756,13 @@ hb_buffer_allocation_successful() returns %false. + - an #hb_buffer_t buffer. + an #hb_buffer_t buffer. @@ -1712,12 +1785,13 @@ hb_buffer_allocation_successful() returns %false. + - an #hb_buffer_t buffer. + an #hb_buffer_t buffer. @@ -1737,41 +1811,43 @@ hb_buffer_allocation_successful() returns %false. - Deallocate the @buffer. + Deallocate the @buffer. Decreases the reference count on @buffer by one. If the result is zero, then @buffer and all associated resources are freed. See hb_buffer_reference(). + - An #hb_buffer_t + An #hb_buffer_t - If dottedcircle_glyph is (hb_codepoint_t) -1 then %HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT + If dottedcircle_glyph is (hb_codepoint_t) -1 then %HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT and %HB_BUFFER_DIFF_FLAG_NOTDEF_PRESENT are never returned. This should be used by most callers if just comparing two buffers is needed. + - a buffer. + a buffer. - other buffer to compare to. + other buffer to compare to. - glyph id of U+25CC DOTTED CIRCLE, or (hb_codepont_t) -1. + glyph id of U+25CC DOTTED CIRCLE, or (hb_codepont_t) -1. - allowed absolute difference in position values. + allowed absolute difference in position values. @@ -1798,21 +1874,21 @@ callers if just comparing two buffers is needed. - the default buffer flag. + the default buffer flag. - flag indicating that special handling of the beginning + flag indicating that special handling of the beginning of text paragraph can be applied to this buffer. Should usually be set, unless you are passing to the buffer only part of the text without the full context. - flag indicating that special handling of the end of text + flag indicating that special handling of the end of text paragraph can be applied to this buffer, similar to @HB_BUFFER_FLAG_BOT. - flag indication that character with Default_Ignorable + flag indication that character with Default_Ignorable Unicode property should use the corresponding glyph from the font, instead of hiding them (done by replacing them with the space glyph and zeroing the @@ -1820,7 +1896,7 @@ callers if just comparing two buffers is needed. @HB_BUFFER_FLAG_REMOVE_DEFAULT_IGNORABLES. - flag indication that character with Default_Ignorable + flag indication that character with Default_Ignorable Unicode property should be removed from glyph string instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) @@ -1828,78 +1904,84 @@ callers if just comparing two buffers is needed. precedence over this flag. Since: 1.8.0 - flag indicating that a dotted circle should + flag indicating that a dotted circle should not be inserted in the rendering of incorrect character sequences (such at <0905 093E>). Since: 2.4 - Fetches the cluster level of a buffer. The #hb_buffer_cluster_level_t + Fetches the cluster level of a buffer. The #hb_buffer_cluster_level_t dictates one aspect of how HarfBuzz will treat non-base characters during shaping. + - The cluster level of @buffer + The cluster level of @buffer - An #hb_buffer_t + An #hb_buffer_t - Fetches the type of @buffer contents. Buffers are either empty, contain + Fetches the type of @buffer contents. Buffers are either empty, contain characters (before shaping), or contain glyphs (the result of shaping). + - The type of @buffer contents + The type of @buffer contents - An #hb_buffer_t + An #hb_buffer_t - See hb_buffer_set_direction() + See hb_buffer_set_direction() + - The direction of the @buffer. + The direction of the @buffer. - An #hb_buffer_t + An #hb_buffer_t - Fetches an empty #hb_buffer_t. + Fetches an empty #hb_buffer_t. + - The empty buffer + The empty buffer - Fetches the #hb_buffer_flags_t of @buffer. + Fetches the #hb_buffer_flags_t of @buffer. + - The @buffer flags + The @buffer flags - An #hb_buffer_t + An #hb_buffer_t - Returns @buffer glyph information array. Returned pointer + Returns @buffer glyph information array. Returned pointer is valid as long as @buffer contents are not modified. + - + The @buffer glyph information array. The value valid as long as buffer has not been modified. @@ -1908,20 +1990,21 @@ The value valid as long as buffer has not been modified. - An #hb_buffer_t + An #hb_buffer_t - The output-array length. + The output-array length. - Returns @buffer glyph position array. Returned pointer + Returns @buffer glyph position array. Returned pointer is valid as long as @buffer contents are not modified. + - + The @buffer glyph position array. The value valid as long as buffer has not been modified. @@ -1930,132 +2013,140 @@ The value valid as long as buffer has not been modified. - An #hb_buffer_t + An #hb_buffer_t - The output length + The output length - See hb_buffer_set_invisible_glyph(). + See hb_buffer_set_invisible_glyph(). + - The @buffer invisible #hb_codepoint_t + The @buffer invisible #hb_codepoint_t - An #hb_buffer_t + An #hb_buffer_t - See hb_buffer_set_language(). + See hb_buffer_set_language(). + - + The #hb_language_t of the buffer. Must not be freed by the caller. - An #hb_buffer_t + An #hb_buffer_t - Returns the number of items in the buffer. + Returns the number of items in the buffer. + - The @buffer length. + The @buffer length. The value valid as long as buffer has not been modified. - An #hb_buffer_t + An #hb_buffer_t - Fetches the #hb_codepoint_t that replaces invalid entries for a given encoding + Fetches the #hb_codepoint_t that replaces invalid entries for a given encoding when adding text to @buffer. + - The @buffer replacement #hb_codepoint_t + The @buffer replacement #hb_codepoint_t - An #hb_buffer_t + An #hb_buffer_t - Fetches the script of @buffer. + Fetches the script of @buffer. + - The #hb_script_t of the @buffer + The #hb_script_t of the @buffer - An #hb_buffer_t + An #hb_buffer_t - Sets @props to the #hb_segment_properties_t of @buffer. + Sets @props to the #hb_segment_properties_t of @buffer. + - An #hb_buffer_t + An #hb_buffer_t - The output #hb_segment_properties_t + The output #hb_segment_properties_t - Fetches the Unicode-functions structure of a buffer. + Fetches the Unicode-functions structure of a buffer. + - The Unicode-functions structure + The Unicode-functions structure - An #hb_buffer_t + An #hb_buffer_t - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified buffer. + - A pointer to the user data + A pointer to the user data - An #hb_buffer_t + An #hb_buffer_t - The user-data key to query + The user-data key to query - Sets unset buffer segment properties based on buffer Unicode + Sets unset buffer segment properties based on buffer Unicode contents. If buffer is not empty, it must have content type %HB_BUFFER_CONTENT_TYPE_UNICODE. @@ -2076,32 +2167,35 @@ hb_language_get_default(). This may change in the future by taking buffer script into consideration when choosing a language. Note that hb_language_get_default() is NOT threadsafe the first time it is called. See documentation for that function for details. + - An #hb_buffer_t + An #hb_buffer_t - Returns whether @buffer has glyph position data. + Returns whether @buffer has glyph position data. A buffer gains position data when hb_buffer_get_glyph_positions() is called on it, and cleared of position data when hb_buffer_clear_contents() is called. + - %true if the @buffer has position array, %false otherwise. + %true if the @buffer has position array, %false otherwise. - an #hb_buffer_t. + an #hb_buffer_t. + @@ -2121,241 +2215,251 @@ and cleared of position data when hb_buffer_clear_contents() is called. - Reorders a glyph buffer to have canonical in-cluster glyph order / position. + Reorders a glyph buffer to have canonical in-cluster glyph order / position. The resulting clusters should behave identical to pre-reordering clusters. <note>This has nothing to do with Unicode normalization.</note> + - An #hb_buffer_t + An #hb_buffer_t - Pre allocates memory for @buffer to fit at least @size number of items. + Pre allocates memory for @buffer to fit at least @size number of items. + - %true if @buffer memory allocation succeeded, %false otherwise + %true if @buffer memory allocation succeeded, %false otherwise - An #hb_buffer_t + An #hb_buffer_t - Number of items to pre allocate. + Number of items to pre allocate. - Increases the reference count on @buffer by one. This prevents @buffer from + Increases the reference count on @buffer by one. This prevents @buffer from being destroyed until a matching call to hb_buffer_destroy() is made. + - + The referenced #hb_buffer_t. - An #hb_buffer_t + An #hb_buffer_t - Resets the buffer to its initial status, as if it was just newly created + Resets the buffer to its initial status, as if it was just newly created with hb_buffer_create(). + - An #hb_buffer_t + An #hb_buffer_t - Reverses buffer contents. + Reverses buffer contents. + - An #hb_buffer_t + An #hb_buffer_t - Reverses buffer clusters. That is, the buffer contents are + Reverses buffer clusters. That is, the buffer contents are reversed, then each cluster (consecutive items having the same cluster number) are reversed again. + - An #hb_buffer_t + An #hb_buffer_t - Reverses buffer contents between @start and @end. + Reverses buffer contents between @start and @end. + - An #hb_buffer_t + An #hb_buffer_t - start index + start index - end index + end index - Serializes @buffer into a textual representation of its content, whether + Serializes @buffer into a textual representation of its content, whether Unicode codepoints or glyph identifiers and positioning information. This is useful for showing the contents of the buffer, for example during debugging. See the documentation of hb_buffer_serialize_unicode() and hb_buffer_serialize_glyphs() for a description of the output format. + - The number of serialized items. + The number of serialized items. - an #hb_buffer_t buffer. + an #hb_buffer_t buffer. - the first item in @buffer to serialize. + the first item in @buffer to serialize. - the last item in @buffer to serialize. + the last item in @buffer to serialize. - output string to + output string to write serialized buffer into. - the size of @buf. + the size of @buf. - if not %NULL, will be set to the number of byes written into @buf. + if not %NULL, will be set to the number of byes written into @buf. - the #hb_font_t used to shape this buffer, needed to + the #hb_font_t used to shape this buffer, needed to read glyph names and extents. If %NULL, and empty font will be used. - the #hb_buffer_serialize_format_t to use for formatting the output. + the #hb_buffer_serialize_format_t to use for formatting the output. - the #hb_buffer_serialize_flags_t that control what glyph properties + the #hb_buffer_serialize_flags_t that control what glyph properties to serialize. - Flags that control what glyph information are serialized in hb_buffer_serialize_glyphs(). + Flags that control what glyph information are serialized in hb_buffer_serialize_glyphs(). - serialize glyph names, clusters and positions. + serialize glyph names, clusters and positions. - do not serialize glyph cluster. + do not serialize glyph cluster. - do not serialize glyph position information. + do not serialize glyph position information. - do no serialize glyph name. + do no serialize glyph name. - serialize glyph extents. + serialize glyph extents. - serialize glyph flags. Since: 1.5.0 + serialize glyph flags. Since: 1.5.0 - do not serialize glyph advances, + do not serialize glyph advances, glyph offsets will reflect absolute glyph positions. Since: 1.8.0 - Parses a string into an #hb_buffer_serialize_format_t. Does not check if + Parses a string into an #hb_buffer_serialize_format_t. Does not check if @str is a valid buffer serialization format, use hb_buffer_serialize_list_formats() to get the list of supported formats. + - The parsed #hb_buffer_serialize_format_t. + The parsed #hb_buffer_serialize_format_t. - a string to parse + a string to parse - length of @str, or -1 if string is %NULL terminated + length of @str, or -1 if string is %NULL terminated - The buffer serialization and de-serialization format used in + The buffer serialization and de-serialization format used in hb_buffer_serialize_glyphs() and hb_buffer_deserialize_glyphs(). - a human-readable, plain text format. + a human-readable, plain text format. - a machine-readable JSON format. + a machine-readable JSON format. - invalid format. + invalid format. - Converts @format to the string corresponding it, or %NULL if it is not a valid + Converts @format to the string corresponding it, or %NULL if it is not a valid #hb_buffer_serialize_format_t. + - + A %NULL terminated string corresponding to @format. Should not be freed. - an #hb_buffer_serialize_format_t to convert. + an #hb_buffer_serialize_format_t to convert. - Serializes @buffer into a textual representation of its glyph content, + Serializes @buffer into a textual representation of its glyph content, useful for showing the contents of the buffer, for example during debugging. There are currently two supported serialization formats: @@ -2397,58 +2501,60 @@ Each glyph is a JSON object, with the following properties: - `xb`,`yb`,`w`,`h`: #hb_glyph_extents_t.x_bearing, #hb_glyph_extents_t.y_bearing, #hb_glyph_extents_t.width and #hb_glyph_extents_t.height respectively if #HB_BUFFER_SERIALIZE_FLAG_GLYPH_EXTENTS is set. + - The number of serialized items. + The number of serialized items. - an #hb_buffer_t buffer. + an #hb_buffer_t buffer. - the first item in @buffer to serialize. + the first item in @buffer to serialize. - the last item in @buffer to serialize. + the last item in @buffer to serialize. - output string to + output string to write serialized buffer into. - the size of @buf. + the size of @buf. - if not %NULL, will be set to the number of byes written into @buf. + if not %NULL, will be set to the number of byes written into @buf. - the #hb_font_t used to shape this buffer, needed to + the #hb_font_t used to shape this buffer, needed to read glyph names and extents. If %NULL, and empty font will be used. - the #hb_buffer_serialize_format_t to use for formatting the output. + the #hb_buffer_serialize_format_t to use for formatting the output. - the #hb_buffer_serialize_flags_t that control what glyph properties + the #hb_buffer_serialize_flags_t that control what glyph properties to serialize. - Returns a list of supported buffer serialization formats. + Returns a list of supported buffer serialization formats. + - + A string array of buffer serialization formats. Should not be freed. @@ -2456,7 +2562,7 @@ A string array of buffer serialization formats. Should not be freed. - Serializes @buffer into a textual representation of its content, + Serializes @buffer into a textual representation of its content, when the buffer contains Unicode codepoints (i.e., before shaping). This is useful for showing the contents of the buffer, for example during debugging. There are currently two supported serialization formats: @@ -2488,40 +2594,41 @@ For example: ``` [{u:1617,cl:0},{u:1576,cl:1}] ``` + - The number of serialized items. + The number of serialized items. - an #hb_buffer_t buffer. + an #hb_buffer_t buffer. - the first item in @buffer to serialize. + the first item in @buffer to serialize. - the last item in @buffer to serialize. + the last item in @buffer to serialize. - output string to + output string to write serialized buffer into. - the size of @buf. + the size of @buf. - if not %NULL, will be set to the number of byes written into @buf. + if not %NULL, will be set to the number of byes written into @buf. - the #hb_buffer_serialize_format_t to use for formatting the output. + the #hb_buffer_serialize_format_t to use for formatting the output. @@ -2530,99 +2637,104 @@ For example: - Sets the cluster level of a buffer. The #hb_buffer_cluster_level_t + Sets the cluster level of a buffer. The #hb_buffer_cluster_level_t dictates one aspect of how HarfBuzz will treat non-base characters during shaping. + - An #hb_buffer_t + An #hb_buffer_t - The cluster level to set on the buffer + The cluster level to set on the buffer - Sets the type of @buffer contents. Buffers are either empty, contain + Sets the type of @buffer contents. Buffers are either empty, contain characters (before shaping), or contain glyphs (the result of shaping). + - An #hb_buffer_t + An #hb_buffer_t - The type of buffer contents to set + The type of buffer contents to set - Set the text flow direction of the buffer. No shaping can happen without + Set the text flow direction of the buffer. No shaping can happen without setting @buffer direction, and it controls the visual direction for the output glyphs; for RTL direction the glyphs will be reversed. Many layout features depend on the proper setting of the direction, for example, reversing RTL text before shaping, then shaping with LTR direction is not the same as keeping the text in logical order and shaping with RTL direction. + - An #hb_buffer_t + An #hb_buffer_t - the #hb_direction_t of the @buffer + the #hb_direction_t of the @buffer - Sets @buffer flags to @flags. See #hb_buffer_flags_t. + Sets @buffer flags to @flags. See #hb_buffer_flags_t. + - An #hb_buffer_t + An #hb_buffer_t - The buffer flags to set + The buffer flags to set - Sets the #hb_codepoint_t that replaces invisible characters in + Sets the #hb_codepoint_t that replaces invisible characters in the shaping result. If set to zero (default), the glyph for the U+0020 SPACE character is used. Otherwise, this value is used verbatim. + - An #hb_buffer_t + An #hb_buffer_t - the invisible #hb_codepoint_t + the invisible #hb_codepoint_t - Sets the language of @buffer to @language. + Sets the language of @buffer to @language. Languages are crucial for selecting which OpenType feature to apply to the buffer which can result in applying language-specific behaviour. Languages @@ -2631,45 +2743,48 @@ different concepts and should not be confused with each other. Use hb_language_from_string() to convert from BCP 47 language tags to #hb_language_t. + - An #hb_buffer_t + An #hb_buffer_t - An hb_language_t to set + An hb_language_t to set - Similar to hb_buffer_pre_allocate(), but clears any new items added at the + Similar to hb_buffer_pre_allocate(), but clears any new items added at the end. + - %true if @buffer memory allocation succeeded, %false otherwise. + %true if @buffer memory allocation succeeded, %false otherwise. - An #hb_buffer_t + An #hb_buffer_t - The new length of @buffer + The new length of @buffer + - An #hb_buffer_t + An #hb_buffer_t @@ -2684,26 +2799,27 @@ end. - Sets the #hb_codepoint_t that replaces invalid entries for a given encoding + Sets the #hb_codepoint_t that replaces invalid entries for a given encoding when adding text to @buffer. Default is %HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT. + - An #hb_buffer_t + An #hb_buffer_t - the replacement #hb_codepoint_t + the replacement #hb_codepoint_t - Sets the script of @buffer to @script. + Sets the script of @buffer to @script. Script is crucial for choosing the proper shaping behaviour for scripts that require it (e.g. Arabic) and the which OpenType features defined in the font @@ -2712,92 +2828,98 @@ to be applied. You can pass one of the predefined #hb_script_t values, or use hb_script_from_string() or hb_script_from_iso15924_tag() to get the corresponding script from an ISO 15924 script tag. + - An #hb_buffer_t + An #hb_buffer_t - An #hb_script_t to set. + An #hb_script_t to set. - Sets the segment properties of the buffer, a shortcut for calling + Sets the segment properties of the buffer, a shortcut for calling hb_buffer_set_direction(), hb_buffer_set_script() and hb_buffer_set_language() individually. + - An #hb_buffer_t + An #hb_buffer_t - An #hb_segment_properties_t to use + An #hb_segment_properties_t to use - Sets the Unicode-functions structure of a buffer to + Sets the Unicode-functions structure of a buffer to @unicode_funcs. + - An #hb_buffer_t + An #hb_buffer_t - The Unicode-functions structure + The Unicode-functions structure - Attaches a user-data key/data pair to the specified buffer. + Attaches a user-data key/data pair to the specified buffer. + - %true if success, %false otherwise + %true if success, %false otherwise - An #hb_buffer_t + An #hb_buffer_t - The user-data key + The user-data key - A pointer to the user data + A pointer to the user data - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - The main structure holding the input text and its properties before shaping, + The main structure holding the input text and its properties before shaping, and output glyphs and their information after shaping. + - color: a #hb_color_t we are interested in its channels. + color: a #hb_color_t we are interested in its channels. + - Alpha channel value of the given color + Alpha channel value of the given color @@ -2807,9 +2929,10 @@ and output glyphs and their information after shaping. - color: a #hb_color_t we are interested in its channels. + color: a #hb_color_t we are interested in its channels. + - Blue channel value of the given color + Blue channel value of the given color @@ -2819,9 +2942,10 @@ and output glyphs and their information after shaping. - color: a #hb_color_t we are interested in its channels. + color: a #hb_color_t we are interested in its channels. + - Green channel value of the given color + Green channel value of the given color @@ -2831,9 +2955,10 @@ and output glyphs and their information after shaping. - color: a #hb_color_t we are interested in its channels. + color: a #hb_color_t we are interested in its channels. + - Red channel value of the given color + Red channel value of the given color @@ -2843,6 +2968,7 @@ and output glyphs and their information after shaping. + @@ -2853,281 +2979,296 @@ and output glyphs and their information after shaping. - Converts a string to an #hb_direction_t. + Converts a string to an #hb_direction_t. Matching is loose and applies only to the first letter. For examples, "LTR" and "left-to-right" will both return #HB_DIRECTION_LTR. Unmatched strings will return #HB_DIRECTION_INVALID. + - The #hb_direction_t matching @str + The #hb_direction_t matching @str - String to convert + String to convert - Length of @str, or -1 if it is %NULL-terminated + Length of @str, or -1 if it is %NULL-terminated - The direction of a text segment or buffer. + The direction of a text segment or buffer. A segment can also be tested for horizontal or vertical orientation (irrespective of specific direction) with HB_DIRECTION_IS_HORIZONTAL() or HB_DIRECTION_IS_VERTICAL(). - Initial, unset direction. + Initial, unset direction. - Text is set horizontally from left to right. + Text is set horizontally from left to right. - Text is set horizontally from right to left. + Text is set horizontally from right to left. - Text is set vertically from top to bottom. + Text is set vertically from top to bottom. - Text is set vertically from bottom to top. + Text is set vertically from bottom to top. - Converts an #hb_direction_t to a string. + Converts an #hb_direction_t to a string. + - The string corresponding to @direction + The string corresponding to @direction - The #hb_direction_t to convert + The #hb_direction_t to convert - Add table for @tag with data provided by @blob to the face. @face must + Add table for @tag with data provided by @blob to the face. @face must be created using hb_face_builder_create(). + - A face object created with hb_face_builder_create() + A face object created with hb_face_builder_create() - The #hb_tag_t of the table to add + The #hb_tag_t of the table to add - The blob containing the table data to add + The blob containing the table data to add - Creates a #hb_face_t that can be used with hb_face_builder_add_table(). + Creates a #hb_face_t that can be used with hb_face_builder_add_table(). After tables are added to the face, it can be compiled to a binary font file by calling hb_face_reference_blob(). + - New face. + New face. - Collects all of the Unicode characters covered by @face and adds + Collects all of the Unicode characters covered by @face and adds them to the #hb_set_t set @out. + - A face object + A face object - The set to add Unicode characters to + The set to add Unicode characters to - Collects all Unicode "Variation Selector" characters covered by @face and adds + Collects all Unicode "Variation Selector" characters covered by @face and adds them to the #hb_set_t set @out. + - A face object + A face object - The set to add Variation Selector characters to + The set to add Variation Selector characters to - Collects all Unicode characters for @variation_selector covered by @face and adds + Collects all Unicode characters for @variation_selector covered by @face and adds them to the #hb_set_t set @out. + - A face object + A face object - The Variation Selector to query + The Variation Selector to query - The set to add Unicode characters to + The set to add Unicode characters to - Fetches the number of faces in a blob. + Fetches the number of faces in a blob. + - Number of faces in @blob + Number of faces in @blob - a blob. + a blob. - Constructs a new face object from the specified blob and + Constructs a new face object from the specified blob and a face index into that blob. This is used for blobs of file formats such as Dfont and TTC that can contain more than one face. + - The new face object + The new face object - #hb_blob_t to work upon + #hb_blob_t to work upon - The index of the face within @blob + The index of the face within @blob - Variant of hb_face_create(), built for those cases where it is more + Variant of hb_face_create(), built for those cases where it is more convenient to provide data for individual tables instead of the whole font data. With the caveat that hb_face_get_table_tags() does not currently work with faces created this way. Creates a new face object from the specified @user_data and @reference_table_func, with the @destroy callback. + - The new face object + The new face object - Table-referencing function + Table-referencing function - A pointer to the user data + A pointer to the user data - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Decreases the reference count on a face object. When the + Decreases the reference count on a face object. When the reference count reaches zero, the face is destroyed, freeing all memory. + - A face object + A face object - Fetches the singleton empty face object. + Fetches the singleton empty face object. + - The empty face object + The empty face object - Fetches the glyph-count value of the specified face object. + Fetches the glyph-count value of the specified face object. + - The glyph-count value of @face + The glyph-count value of @face - A face object + A face object - Fetches the face-index corresponding to the given face. + Fetches the face-index corresponding to the given face. <note>Note: face indices within a collection are zero-based.</note> + - The index of @face. + The index of @face. - A face object + A face object - Fetches a list of all table tags for a face, if possible. The list returned will + Fetches a list of all table tags for a face, if possible. The list returned will begin at the offset provided + - Total number of tables, or zero if it is not possible to list + Total number of tables, or zero if it is not possible to list - A face object + A face object - The index of first table tag to retrieve + The index of first table tag to retrieve - Input = the maximum number of table tags to return; + Input = the maximum number of table tags to return; Output = the actual number of table tags returned (may be zero) - The array of table tags found + The array of table tags found @@ -3135,192 +3276,204 @@ begin at the offset provided - Fetches the units-per-em (upem) value of the specified face object. + Fetches the units-per-em (upem) value of the specified face object. + - The upem value of @face + The upem value of @face - A face object + A face object - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified face object. + - A pointer to the user data + A pointer to the user data - A face object + A face object - The user-data key to query + The user-data key to query - Tests whether the given face object is immutable. + Tests whether the given face object is immutable. + - True is @face is immutable, false otherwise + True is @face is immutable, false otherwise - A face object + A face object - Makes the given face object immutable. + Makes the given face object immutable. + - A face object + A face object - Increases the reference count on a face object. + Increases the reference count on a face object. + - The @face object + The @face object - A face object + A face object - Fetches a pointer to the binary blob that contains the + Fetches a pointer to the binary blob that contains the specified face. Returns an empty blob if referencing face data is not possible. + - A pointer to the blob for @face + A pointer to the blob for @face - A face object + A face object - Fetches a reference to the specified table within + Fetches a reference to the specified table within the specified face. + - A pointer to the @tag table within @face + A pointer to the @tag table within @face - A face object + A face object - The #hb_tag_t of the table to query + The #hb_tag_t of the table to query - Sets the glyph count for a face object to the specified value. + Sets the glyph count for a face object to the specified value. + - A face object + A face object - The glyph-count value to assign + The glyph-count value to assign - Assigns the specified face-index to @face. Fails if the + Assigns the specified face-index to @face. Fails if the face is immutable. <note>Note: face indices within a collection are zero-based.</note> + - A face object + A face object - The index to assign + The index to assign - Sets the units-per-em (upem) for a face object to the specified value. + Sets the units-per-em (upem) for a face object to the specified value. + - A face object + A face object - The units-per-em value to assign + The units-per-em value to assign - Attaches a user-data key/data pair to the given face object. + Attaches a user-data key/data pair to the given face object. + - %true if success, %false otherwise + %true if success, %false otherwise - A face object + A face object - The user-data key to set + The user-data key to set - A pointer to the user data + A pointer to the user data - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Data type for holding font faces. + Data type for holding font faces. + - Parses a string into a #hb_feature_t. + Parses a string into a #hb_feature_t. The format for specifying feature strings follows. All valid CSS font-feature-settings values other than 'normal' and the global values are @@ -3357,190 +3510,199 @@ The format is Python-esque. Here is how it all works: </tbody> </tgroup> </informaltable> + - %true if @str is successfully parsed, %false otherwise + %true if @str is successfully parsed, %false otherwise - a string to parse + a string to parse - length of @str, or -1 if string is %NULL terminated + length of @str, or -1 if string is %NULL terminated - the #hb_feature_t to initialize with the parsed values + the #hb_feature_t to initialize with the parsed values - The #hb_feature_t is the structure that holds information about requested + The #hb_feature_t is the structure that holds information about requested feature application. The feature will be applied with the given value to all glyphs which are in clusters between @start (inclusive) and @end (exclusive). Setting start to @HB_FEATURE_GLOBAL_START and end to @HB_FEATURE_GLOBAL_END specifies that the feature always applies to the entire buffer. + - The #hb_tag_t tag of the feature + The #hb_tag_t tag of the feature - The value of the feature. 0 disables the feature, non-zero (usually + The value of the feature. 0 disables the feature, non-zero (usually 1) enables the feature. For features implemented as lookup type 3 (like 'salt') the @value is a one based index into the alternates. - the cluster to start applying this feature setting (inclusive). + the cluster to start applying this feature setting (inclusive). - the cluster to end applying this feature setting (exclusive). + the cluster to end applying this feature setting (exclusive). - Converts a #hb_feature_t into a %NULL-terminated string in the format + Converts a #hb_feature_t into a %NULL-terminated string in the format understood by hb_feature_from_string(). The client in responsible for allocating big enough size for @buf, 128 bytes is more than enough. + - an #hb_feature_t to convert + an #hb_feature_t to convert - output string + output string - the allocated size of @buf + the allocated size of @buf - Converts a #hb_feature_t into a %NULL-terminated string in the format + Converts a #hb_feature_t into a %NULL-terminated string in the format understood by hb_feature_from_string(). The client in responsible for allocating big enough size for @buf, 128 bytes is more than enough. + - an #hb_feature_t to convert + an #hb_feature_t to convert - output string + output string - the allocated size of @buf + the allocated size of @buf - Adds the origin coordinates to an (X,Y) point coordinate, in + Adds the origin coordinates to an (X,Y) point coordinate, in the specified glyph ID in the specified font. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The direction of the text segment + The direction of the text segment - Input = The original X coordinate + Input = The original X coordinate Output = The X coordinate plus the X-coordinate of the origin - Input = The original Y coordinate + Input = The original Y coordinate Output = The Y coordinate plus the Y-coordinate of the origin - Constructs a new font object from the specified face. + Constructs a new font object from the specified face. + - The new font object + The new font object - a face. + a face. - Constructs a sub-font font object from the specified @parent font, + Constructs a sub-font font object from the specified @parent font, replicating the parent's properties. + - The new sub-font font object + The new sub-font font object - The parent font object + The parent font object - Decreases the reference count on the given font object. When the + Decreases the reference count on the given font object. When the reference count reaches zero, the font is destroyed, freeing all memory. + - #hb_font_t to work upon + #hb_font_t to work upon - Font-wide extent values, measured in font units. + Font-wide extent values, measured in font units. Note that typically @ascender is positive and @descender negative, in coordinate systems that grow up. + - The height of typographic ascenders. + The height of typographic ascenders. - The depth of typographic descenders. + The depth of typographic descenders. - The suggested line-spacing gap. + The suggested line-spacing gap. @@ -3572,289 +3734,305 @@ negative, in coordinate systems that grow up. - Creates a new #hb_font_funcs_t structure of font functions. + Creates a new #hb_font_funcs_t structure of font functions. + - The font-functions structure + The font-functions structure - Decreases the reference count on a font-functions structure. When + Decreases the reference count on a font-functions structure. When the reference count reaches zero, the font-functions structure is destroyed, freeing all memory. + - The font-functions structure + The font-functions structure - Fetches an empty font-functions structure. + Fetches an empty font-functions structure. + - The font-functions structure + The font-functions structure - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified font-functions structure. + - A pointer to the user data + A pointer to the user data - The font-functions structure + The font-functions structure - The user-data key to query + The user-data key to query - Tests whether a font-functions structure is immutable. + Tests whether a font-functions structure is immutable. + - %true if @ffuncs is immutable, false otherwise + %true if @ffuncs is immutable, false otherwise - The font-functions structure + The font-functions structure - Makes a font-functions structure immutable. + Makes a font-functions structure immutable. + - The font-functions structure + The font-functions structure - Increases the reference count on a font-functions structure. + Increases the reference count on a font-functions structure. + - The font-functions structure + The font-functions structure - The font-functions structure + The font-functions structure - Sets the implementation function for #hb_font_get_font_h_extents_func_t. + Sets the implementation function for #hb_font_get_font_h_extents_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_font_v_extents_func_t. + Sets the implementation function for #hb_font_get_font_v_extents_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_contour_point_func_t. + Sets the implementation function for #hb_font_get_glyph_contour_point_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_extents_func_t. + Sets the implementation function for #hb_font_get_glyph_extents_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_from_name_func_t. + Sets the implementation function for #hb_font_get_glyph_from_name_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Deprecated. Use hb_font_funcs_set_nominal_glyph_func() and + Deprecated. Use hb_font_funcs_set_nominal_glyph_func() and hb_font_funcs_set_variation_glyph_func() instead. + - The font-functions structure + The font-functions structure - callback function + callback function - data to pass to @func + data to pass to @func - function to call when @user_data is not needed anymore + function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_h_advance_func_t. + Sets the implementation function for #hb_font_get_glyph_h_advance_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_h_advances_func_t. + Sets the implementation function for #hb_font_get_glyph_h_advances_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore + - font functions. + font functions. @@ -3869,108 +4047,113 @@ hb_font_funcs_set_variation_glyph_func() instead. - Sets the implementation function for #hb_font_get_glyph_h_origin_func_t. + Sets the implementation function for #hb_font_get_glyph_h_origin_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_name_func_t. + Sets the implementation function for #hb_font_get_glyph_name_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_v_advance_func_t. + Sets the implementation function for #hb_font_get_glyph_v_advance_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_glyph_v_advances_func_t. + Sets the implementation function for #hb_font_get_glyph_v_advances_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore + - font functions. + font functions. @@ -3985,132 +4168,137 @@ hb_font_funcs_set_variation_glyph_func() instead. - Sets the implementation function for #hb_font_get_glyph_v_origin_func_t. + Sets the implementation function for #hb_font_get_glyph_v_origin_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_nominal_glyph_func_t. + Sets the implementation function for #hb_font_get_nominal_glyph_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_font_get_nominal_glyphs_func_t. + Sets the implementation function for #hb_font_get_nominal_glyphs_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Attaches a user-data key/data pair to the specified font-functions structure. + Attaches a user-data key/data pair to the specified font-functions structure. + - %true if success, %false otherwise + %true if success, %false otherwise - The font-functions structure + The font-functions structure - The user-data key to set + The user-data key to set - A pointer to the user data set + A pointer to the user data set - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Sets the implementation function for #hb_font_get_variation_glyph_func_t. + Sets the implementation function for #hb_font_get_variation_glyph_func_t. + - A font-function structure + A font-function structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Data type containing a set of virtual methods used for + Data type containing a set of virtual methods used for working on #hb_font_t font objects. HarfBuzz provides a lightweight default function for each of @@ -4118,52 +4306,57 @@ the methods in #hb_font_funcs_t. Client programs can implement their own replacements for the individual font functions, as needed, and replace the default by calling the setter for a method. + - Fetches the empty font object. + Fetches the empty font object. + - The empty font object + The empty font object - Fetches the extents for a font in a text segment of the + Fetches the extents for a font in a text segment of the specified direction. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The direction of the text segment + The direction of the text segment - The #hb_glyph_extents_t retrieved + The #hb_glyph_extents_t retrieved - Fetches the face associated with the specified font object. + Fetches the face associated with the specified font object. + - The #hb_face_t value + The #hb_face_t value - #hb_font_t to work upon + #hb_font_t to work upon + @@ -4183,71 +4376,74 @@ or vertical) depending on the value of @direction. - Fetches the glyph ID for a Unicode code point in the specified + Fetches the glyph ID for a Unicode code point in the specified font, with an optional variation selector. If @variation_selector is 0, calls hb_font_get_nominal_glyph(); otherwise calls hb_font_get_variation_glyph(). + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The Unicode code point to query + The Unicode code point to query - A variation-selector code point + A variation-selector code point - The glyph ID retrieved + The glyph ID retrieved - Fetches the advance for a glyph ID from the specified font, + Fetches the advance for a glyph ID from the specified font, in a text segment of the specified direction. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The direction of the text segment + The direction of the text segment - The horizontal advance retrieved + The horizontal advance retrieved - The vertical advance retrieved + The vertical advance retrieved - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the advance for a specified glyph. The method must return an #hb_position_t. + @@ -4267,49 +4463,51 @@ method must return an #hb_position_t. - Fetches the advances for a sequence of glyph IDs in the specified + Fetches the advances for a sequence of glyph IDs in the specified font, in a text segment of the specified direction. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The direction of the text segment + The direction of the text segment - The number of glyph IDs in the sequence queried + The number of glyph IDs in the sequence queried - The first glyph ID to query + The first glyph ID to query - The stride between successive glyph IDs + The stride between successive glyph IDs - The first advance retrieved + The first advance retrieved - The stride between successive advances + The stride between successive advances - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the advances for a sequence of glyphs. + @@ -4341,79 +4539,82 @@ This method should retrieve the advances for a sequence of glyphs. - Fetches the (x,y) coordinates of a specified contour-point index + Fetches the (x,y) coordinates of a specified contour-point index in the specified glyph, within the specified font. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The contour-point index to query + The contour-point index to query - The X value retrieved for the contour point + The X value retrieved for the contour point - The Y value retrieved for the contour point + The Y value retrieved for the contour point - Fetches the (X,Y) coordinates of a specified contour-point index + Fetches the (X,Y) coordinates of a specified contour-point index in the specified glyph ID in the specified font, with respect to the origin in a text segment in the specified direction. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The contour-point index to query + The contour-point index to query - The direction of the text segment + The direction of the text segment - The X value retrieved for the contour point + The X value retrieved for the contour point - The Y value retrieved for the contour point + The Y value retrieved for the contour point - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the (X,Y) coordinates (in font units) for a specified contour point in a glyph. Each coordinate must be returned as an #hb_position_t output parameter. + @@ -4442,62 +4643,65 @@ an #hb_position_t output parameter. - Fetches the #hb_glyph_extents_t data for a glyph ID + Fetches the #hb_glyph_extents_t data for a glyph ID in the specified font. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The #hb_glyph_extents_t retrieved + The #hb_glyph_extents_t retrieved - Fetches the #hb_glyph_extents_t data for a glyph ID + Fetches the #hb_glyph_extents_t data for a glyph ID in the specified font, with respect to the origin in a text segment in the specified direction. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The direction of the text segment + The direction of the text segment - The #hb_glyph_extents_t retrieved + The #hb_glyph_extents_t retrieved - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the extents for a specified glyph. Extents must be returned in an #hb_glyph_extents output parameter. + @@ -4520,39 +4724,41 @@ returned in an #hb_glyph_extents output parameter. - Fetches the glyph ID that corresponds to a name string in the specified @font. + Fetches the glyph ID that corresponds to a name string in the specified @font. <note>Note: @len == -1 means the name string is null-terminated.</note> + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The name string to query + The name string to query - The length of the name queried + The length of the name queried - The glyph ID retrieved + The glyph ID retrieved - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the glyph ID that corresponds to a glyph-name string. + @@ -4578,6 +4784,7 @@ string. + @@ -4603,143 +4810,149 @@ string. - Fetches the advance for a glyph ID in the specified font, + Fetches the advance for a glyph ID in the specified font, for horizontal text segments. + - The advance of @glyph within @font + The advance of @glyph within @font - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - Fetches the advances for a sequence of glyph IDs in the specified + Fetches the advances for a sequence of glyph IDs in the specified font, for horizontal text segments. + - #hb_font_t to work upon + #hb_font_t to work upon - The number of glyph IDs in the sequence queried + The number of glyph IDs in the sequence queried - The first glyph ID to query + The first glyph ID to query - The stride between successive glyph IDs + The stride between successive glyph IDs - The first advance retrieved + The first advance retrieved - The stride between successive advances + The stride between successive advances - Fetches the kerning-adjustment value for a glyph-pair in + Fetches the kerning-adjustment value for a glyph-pair in the specified font, in horizontal text segments. <note>It handles legacy kerning only (as returned by the corresponding #hb_font_funcs_t function).</note> + - The kerning adjustment value + The kerning adjustment value - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID of the left glyph in the glyph pair + The glyph ID of the left glyph in the glyph pair - The glyph ID of the right glyph in the glyph pair + The glyph ID of the right glyph in the glyph pair - Fetches the (X,Y) coordinates of the origin for a glyph ID + Fetches the (X,Y) coordinates of the origin for a glyph ID in the specified font, for horizontal text segments. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The X coordinate of the origin + The X coordinate of the origin - The Y coordinate of the origin + The Y coordinate of the origin - Fetches the kerning-adjustment value for a glyph-pair in the specified font. + Fetches the kerning-adjustment value for a glyph-pair in the specified font. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID of the first glyph in the glyph pair to query + The glyph ID of the first glyph in the glyph pair to query - The glyph ID of the second glyph in the glyph pair to query + The glyph ID of the second glyph in the glyph pair to query - The direction of the text segment + The direction of the text segment - The horizontal kerning-adjustment value retrieved + The horizontal kerning-adjustment value retrieved - The vertical kerning-adjustment value retrieved + The vertical kerning-adjustment value retrieved + @@ -4762,37 +4975,39 @@ or vertical) depending on the value of @direction. - Fetches the glyph-name string for a glyph ID in the specified @font. + Fetches the glyph-name string for a glyph ID in the specified @font. + - %true if data found, zero otherwise + %true if data found, zero otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - Name string retrieved for the glyph ID + Name string retrieved for the glyph ID - Length of the glyph-name string retrieved + Length of the glyph-name string retrieved - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the glyph name that corresponds to a glyph ID. The name should be returned in a string output parameter. + @@ -4818,43 +5033,45 @@ glyph ID. The name should be returned in a string output parameter. - Fetches the (X,Y) coordinates of the origin for a glyph in + Fetches the (X,Y) coordinates of the origin for a glyph in the specified font. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The direction of the text segment + The direction of the text segment - The X coordinate retrieved for the origin + The X coordinate retrieved for the origin - The Y coordinate retrieved for the origin + The Y coordinate retrieved for the origin - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph. Each coordinate must be returned in an #hb_position_t output parameter. + @@ -4880,156 +5097,163 @@ output parameter. - Fetches the advance for a glyph ID in the specified font, + Fetches the advance for a glyph ID in the specified font, for vertical text segments. + - The advance of @glyph within @font + The advance of @glyph within @font - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - Fetches the advances for a sequence of glyph IDs in the specified + Fetches the advances for a sequence of glyph IDs in the specified font, for vertical text segments. + - #hb_font_t to work upon + #hb_font_t to work upon - The number of glyph IDs in the sequence queried + The number of glyph IDs in the sequence queried - The first glyph ID to query + The first glyph ID to query - The stride between successive glyph IDs + The stride between successive glyph IDs - The first advance retrieved + The first advance retrieved - The stride between successive advances + The stride between successive advances - Fetches the kerning-adjustment value for a glyph-pair in + Fetches the kerning-adjustment value for a glyph-pair in the specified font, in vertical text segments. <note>It handles legacy kerning only (as returned by the corresponding #hb_font_funcs_t function).</note> + - The kerning adjustment value + The kerning adjustment value - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID of the top glyph in the glyph pair + The glyph ID of the top glyph in the glyph pair - The glyph ID of the bottom glyph in the glyph pair + The glyph ID of the bottom glyph in the glyph pair - Fetches the (X,Y) coordinates of the origin for a glyph ID + Fetches the (X,Y) coordinates of the origin for a glyph ID in the specified font, for vertical text segments. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The X coordinate of the origin + The X coordinate of the origin - The Y coordinate of the origin + The Y coordinate of the origin - Fetches the extents for a specified font, in horizontal + Fetches the extents for a specified font, in horizontal text segments. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The font extents retrieved + The font extents retrieved - Fetches the nominal glyph ID for a Unicode code point in the + Fetches the nominal glyph ID for a Unicode code point in the specified font. This version of the function should not be used to fetch glyph IDs for code points modified by variation selectors. For variation-selector support, user hb_font_get_variation_glyph() or use hb_font_get_glyph(). + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The Unicode code point to query + The Unicode code point to query - The glyph ID retrieved + The glyph ID retrieved - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the nominal glyph ID for a specified Unicode code point. Glyph IDs must be returned in a #hb_codepoint_t output parameter. + @@ -5052,12 +5276,13 @@ point. Glyph IDs must be returned in a #hb_codepoint_t output parameter. + - a font. + a font. @@ -5078,11 +5303,12 @@ point. Glyph IDs must be returned in a #hb_codepoint_t output parameter. - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the nominal glyph IDs for a sequence of Unicode code points. Glyph IDs must be returned in a #hb_codepoint_t output parameter. + @@ -5114,161 +5340,170 @@ output parameter. - Fetches the parent font of @font. + Fetches the parent font of @font. + - The parent font object + The parent font object - #hb_font_t to work upon + #hb_font_t to work upon - Fetches the horizontal and vertical points-per-em (ppem) of a font. + Fetches the horizontal and vertical points-per-em (ppem) of a font. + - #hb_font_t to work upon + #hb_font_t to work upon - Horizontal ppem value + Horizontal ppem value - Vertical ppem value + Vertical ppem value - Fetches the "point size" of a font. Used in CoreText to + Fetches the "point size" of a font. Used in CoreText to implement optical sizing. + - Point size. A value of zero means "not set." + Point size. A value of zero means "not set." - #hb_font_t to work upon + #hb_font_t to work upon - Fetches the horizontal and vertical scale of a font. + Fetches the horizontal and vertical scale of a font. + - #hb_font_t to work upon + #hb_font_t to work upon - Horizontal scale value + Horizontal scale value - Vertical scale value + Vertical scale value - Fetches the user-data object associated with the specified key, + Fetches the user-data object associated with the specified key, attached to the specified font object. + - Pointer to the user data + Pointer to the user data - #hb_font_t to work upon + #hb_font_t to work upon - The user-data key to query + The user-data key to query - Fetches the extents for a specified font, in vertical + Fetches the extents for a specified font, in vertical text segments. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The font extents retrieved + The font extents retrieved - Fetches the list of normalized variation coordinates currently + Fetches the list of normalized variation coordinates currently set on a font. Return value is valid as long as variation coordinates of the font are not modified. + - #hb_font_t to work upon + #hb_font_t to work upon - Number of coordinates retrieved + Number of coordinates retrieved - Fetches the glyph ID for a Unicode code point when followed by + Fetches the glyph ID for a Unicode code point when followed by by the specified variation-selector code point, in the specified font. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - The Unicode code point to query + The Unicode code point to query - The variation-selector code point to query + The variation-selector code point to query - The glyph ID retrieved + The glyph ID retrieved - A virtual method for the #hb_font_funcs_t of an #hb_font_t object. + A virtual method for the #hb_font_funcs_t of an #hb_font_t object. This method should retrieve the glyph ID for a specified Unicode code point followed by a specified Variation Selector code point. Glyph IDs must be returned in a #hb_codepoint_t output parameter. + @@ -5294,389 +5529,410 @@ returned in a #hb_codepoint_t output parameter. - Fetches the glyph ID from @font that matches the specified string. + Fetches the glyph ID from @font that matches the specified string. Strings of the format `gidDDD` or `uniUUUU` are parsed automatically. <note>Note: @len == -1 means the string is null-terminated.</note> + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - string to query + string to query - The length of the string @s + The length of the string @s - The glyph ID corresponding to the string requested + The glyph ID corresponding to the string requested - Fetches the name of the specified glyph ID in @font and returns + Fetches the name of the specified glyph ID in @font and returns it in string @s. If the glyph ID has no name in @font, a string of the form `gidDDD` is generated, with `DDD` being the glyph ID. + - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The string containing the glyph name + The string containing the glyph name - Length of string @s + Length of string @s - Tests whether a font object is immutable. + Tests whether a font object is immutable. + - %true if @font is immutable, false otherwise + %true if @font is immutable, false otherwise - #hb_font_t to work upon + #hb_font_t to work upon - Makes @font immutable. + Makes @font immutable. + - #hb_font_t to work upon + #hb_font_t to work upon - Increases the reference count on the given font object. + Increases the reference count on the given font object. + - The @font object + The @font object - #hb_font_t to work upon + #hb_font_t to work upon - Sets @face as the font-face value of @font. + Sets @face as the font-face value of @font. + - #hb_font_t to work upon + #hb_font_t to work upon - The #hb_face_t to assign + The #hb_face_t to assign - Replaces the font-functions structure attached to a font, updating + Replaces the font-functions structure attached to a font, updating the font's user-data with @font-data and the @destroy callback. + - #hb_font_t to work upon + #hb_font_t to work upon - Data to attach to @font + Data to attach to @font - The function to call when @font_data is not needed anymore + The function to call when @font_data is not needed anymore - Replaces the user data attached to a font, updating the font's + Replaces the user data attached to a font, updating the font's @destroy callback. + - #hb_font_t to work upon + #hb_font_t to work upon - Data to attach to @font + Data to attach to @font - The function to call when @font_data is not needed anymore + The function to call when @font_data is not needed anymore - Sets the parent font of @font. + Sets the parent font of @font. + - #hb_font_t to work upon + #hb_font_t to work upon - The parent font object to assign + The parent font object to assign - Sets the horizontal and vertical pixels-per-em (ppem) of a font. + Sets the horizontal and vertical pixels-per-em (ppem) of a font. + - #hb_font_t to work upon + #hb_font_t to work upon - Horizontal ppem value to assign + Horizontal ppem value to assign - Vertical ppem value to assign + Vertical ppem value to assign - Sets the "point size" of a font. Set to zero to unset. + Sets the "point size" of a font. Set to zero to unset. Used in CoreText to implement optical sizing. <note>Note: There are 72 points in an inch.</note> + - #hb_font_t to work upon + #hb_font_t to work upon - font size in points. + font size in points. - Sets the horizontal and vertical scale of a font. + Sets the horizontal and vertical scale of a font. + - #hb_font_t to work upon + #hb_font_t to work upon - Horizontal scale value to assign + Horizontal scale value to assign - Vertical scale value to assign + Vertical scale value to assign - Attaches a user-data key/data pair to the specified font object. + Attaches a user-data key/data pair to the specified font object. + - #hb_font_t to work upon + #hb_font_t to work upon - The user-data key + The user-data key - A pointer to the user data + A pointer to the user data - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Applies a list of variation coordinates (in design-space units) + Applies a list of variation coordinates (in design-space units) to a font. + - #hb_font_t to work upon + #hb_font_t to work upon - Array of variation coordinates to apply + Array of variation coordinates to apply - Number of coordinates to apply + Number of coordinates to apply - Applies a list of variation coordinates (in normalized units) + Applies a list of variation coordinates (in normalized units) to a font. <note>Note: Coordinates should be normalized to 2.14.</note> + - #hb_font_t to work upon + #hb_font_t to work upon - Array of variation coordinates to apply + Array of variation coordinates to apply - Number of coordinates to apply + Number of coordinates to apply - Sets design coords of a font from a named instance index. + Sets design coords of a font from a named instance index. + - a font. + a font. - named instance index. + named instance index. - Applies a list of font-variation settings to a font. + Applies a list of font-variation settings to a font. + - #hb_font_t to work upon + #hb_font_t to work upon - Array of variation settings to apply + Array of variation settings to apply - Number of variations to apply + Number of variations to apply - Subtracts the origin coordinates from an (X,Y) point coordinate, + Subtracts the origin coordinates from an (X,Y) point coordinate, in the specified glyph ID in the specified font. Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of @direction. + - #hb_font_t to work upon + #hb_font_t to work upon - The glyph ID to query + The glyph ID to query - The direction of the text segment + The direction of the text segment - Input = The original X coordinate + Input = The original X coordinate Output = The X coordinate minus the X-coordinate of the origin - Input = The original Y coordinate + Input = The original Y coordinate Output = The Y coordinate minus the Y-coordinate of the origin - + + + + @@ -5687,23 +5943,24 @@ or vertical) depending on the value of @direction. - Fetches the FT_Load_Glyph load flags of the specified #hb_font_t. + Fetches the FT_Load_Glyph load flags of the specified #hb_font_t. For more information, see https://www.freetype.org/freetype2/docs/reference/ft2-base_interface.html#ft_load_xxx + - FT_Load_Glyph flags found + FT_Load_Glyph flags found - #hb_font_t to work upon + #hb_font_t to work upon - Configures the font-functions structure of the specified + Configures the font-functions structure of the specified #hb_font_t font object to use FreeType font functions. In particular, you can use this function to configure an @@ -5718,36 +5975,39 @@ require this function to be used. <note>Note: Internally, this function creates an FT_Face. </note> + - #hb_font_t to work upon + #hb_font_t to work upon - Sets the FT_Load_Glyph load flags for the specified #hb_font_t. + Sets the FT_Load_Glyph load flags for the specified #hb_font_t. For more information, see https://www.freetype.org/freetype2/docs/reference/ft2-base_interface.html#ft_load_xxx + - #hb_font_t to work upon + #hb_font_t to work upon - The FreeType load flags to set + The FreeType load flags to set + @@ -5758,79 +6018,84 @@ https://www.freetype.org/freetype2/docs/reference/ft2-base_interface.html#ft_loa - Creates an #hb_blob_t blob from the specified + Creates an #hb_blob_t blob from the specified GBytes data structure. + - the new #hb_blob_t blob object + the new #hb_blob_t blob object - the GBytes structure to work upon + the GBytes structure to work upon - Fetches a Unicode-functions structure that is populated + Fetches a Unicode-functions structure that is populated with the appropriate GLib function for each method. + - a pointer to the #hb_unicode_funcs_t Unicode-functions structure + a pointer to the #hb_unicode_funcs_t Unicode-functions structure - Fetches the GUnicodeScript identifier that corresponds to the + Fetches the GUnicodeScript identifier that corresponds to the specified #hb_script_t script. + - the GUnicodeScript identifier found + the GUnicodeScript identifier found - The #hb_script_t to query + The #hb_script_t to query - Fetches the #hb_script_t script that corresponds to the + Fetches the #hb_script_t script that corresponds to the specified GUnicodeScript identifier. + - the #hb_script_t script found + the #hb_script_t script found - The GUnicodeScript identifier to query + The GUnicodeScript identifier to query - Glyph extent values, measured in font units. + Glyph extent values, measured in font units. Note that @height is negative, in coordinate systems that grow up. + - Distance from the x-origin to the left extremum of the glyph. + Distance from the x-origin to the left extremum of the glyph. - Distance from the top extremum of the glyph to the y-origin. + Distance from the top extremum of the glyph to the y-origin. - Distance from the left extremum of the glyph to the right extremum. + Distance from the left extremum of the glyph to the right extremum. - Distance from the top extremum of the glyph to the bottom extremum. + Distance from the top extremum of the glyph to the bottom extremum. - Indicates that if input text is broken at the + Indicates that if input text is broken at the beginning of the cluster this glyph is part of, then both sides need to be re-shaped, as the result might be different. On the flip side, @@ -5847,27 +6112,29 @@ Note that @height is negative, in coordinate systems that grow up. breaking point only. - All the currently defined flags. + All the currently defined flags. - Returns glyph flags encoded within a #hb_glyph_info_t. + Returns glyph flags encoded within a #hb_glyph_info_t. + - The #hb_glyph_flags_t encoded within @info + The #hb_glyph_flags_t encoded within @info - a #hb_glyph_info_t + a #hb_glyph_info_t - The #hb_glyph_info_t is the structure that holds information about the + The #hb_glyph_info_t is the structure that holds information about the glyphs and their relation to input text. + - either a Unicode code point (before shaping) or a glyph index + either a Unicode code point (before shaping) or a glyph index (after shaping). @@ -5875,7 +6142,7 @@ glyphs and their relation to input text. - the index of the character in the original text that corresponds + the index of the character in the original text that corresponds to this #hb_glyph_info_t, or whatever the client passes to hb_buffer_add(). More than one #hb_glyph_info_t can have the same @cluster value, if they resulted from the same character (e.g. one @@ -5896,26 +6163,27 @@ glyphs and their relation to input text. - The #hb_glyph_position_t is the structure that holds the positions of the + The #hb_glyph_position_t is the structure that holds the positions of the glyph in both horizontal and vertical directions. All positions in #hb_glyph_position_t are relative to the current point. + - how much the line advances after drawing this glyph when setting + how much the line advances after drawing this glyph when setting text in horizontal direction. - how much the line advances after drawing this glyph when setting + how much the line advances after drawing this glyph when setting text in vertical direction. - how much the glyph moves on the X-axis before drawing it, this + how much the glyph moves on the X-axis before drawing it, this should not affect how much the line advances. - how much the glyph moves on the Y-axis before drawing it, this + how much the glyph moves on the Y-axis before drawing it, this should not affect how much the line advances. @@ -5924,31 +6192,31 @@ glyph in both horizontal and vertical directions. All positions in - Functions for querying AAT Layout features in the font face. + Functions for querying AAT Layout features in the font face. HarfBuzz supports all of the AAT tables used to implement shaping. Other AAT tables and their associated features are not supported. - Blobs wrap a chunk of binary data to handle lifecycle management of data + Blobs wrap a chunk of binary data to handle lifecycle management of data while it is passed between client and HarfBuzz. Blobs are primarily used to create font faces, but also to access font face tables, as well as pass around other binary data. - Buffers serve a dual role in HarfBuzz; before shaping, they hold + Buffers serve a dual role in HarfBuzz; before shaping, they hold the input characters that are passed to hb_shape(), and after shaping they hold the output glyphs. - Common data types used across HarfBuzz are defined here. + Common data types used across HarfBuzz are defined here. - These API have been deprecated in favor of newer API, or because they + These API have been deprecated in favor of newer API, or because they were deemed unnecessary. - A font face is an object that represents a single face from within a + A font face is an object that represents a single face from within a font family. More precisely, a font face represents a single face in a binary font file. @@ -5956,7 +6224,7 @@ Font faces are typically built from a binary blob and a face index. Font faces are used to create fonts. - Functions for working with font objects. + Functions for working with font objects. A font object represents a font face at a specific size and with certain other parameters (pixels-per-em, points-per-em, variation @@ -5972,7 +6240,7 @@ HarfBuzz provides a built-in set of lightweight default functions for each method in #hb_font_funcs_t. - Functions for using HarfBuzz with the FreeType library. + Functions for using HarfBuzz with the FreeType library. HarfBuzz supports using FreeType to provide face and font data. @@ -5981,14 +6249,14 @@ font data. functions are not thread-safe either.</note> - Functions for using HarfBuzz with the GLib library. + Functions for using HarfBuzz with the GLib library. HarfBuzz supports using GLib to provide Unicode data, by attaching GLib functions to the virtual methods in a #hb_unicode_funcs_t function structure. - Support for using HarfBuzz with the GObject library to provide + Support for using HarfBuzz with the GObject library to provide type data. The types and functions listed here are solely a linkage between @@ -6001,65 +6269,65 @@ For client programs using the GNOME and GTK software stack, please see the GLib and FreeType integration pages. - Functions for using HarfBuzz with fonts that include Graphite features. + Functions for using HarfBuzz with fonts that include Graphite features. For Graphite features to work, you must be sure that HarfBuzz was compiled with the `graphite2` shaping engine enabled. Currently, the default is to not enable `graphite2` shaping. - Map objects are integer-to-integer hash-maps. Currently they are + Map objects are integer-to-integer hash-maps. Currently they are not used in the HarfBuzz public API, but are provided for client's use if desired. - Functions for fetching color-font information from OpenType font faces. + Functions for fetching color-font information from OpenType font faces. HarfBuzz supports `COLR`/`CPAL`, `sbix`, `CBDT`, and `SVG` color fonts. - Functions for using OpenType fonts with hb_shape(). Note that fonts returned + Functions for using OpenType fonts with hb_shape(). Note that fonts returned by hb_font_create() default to using these functions, so most clients would never need to call these functions directly. - Functions for querying OpenType Layout features in the font face. + Functions for querying OpenType Layout features in the font face. - Functions for fetching mathematics layout data from OpenType fonts. + Functions for fetching mathematics layout data from OpenType fonts. HarfBuzz itself does not implement a math layout solution. The functions and types provided can be used by client programs to access the font data necessary for typesetting OpenType Math layout. - Functions for fetching metadata from fonts. + Functions for fetching metadata from fonts. - Functions for fetching metrics from fonts. + Functions for fetching metrics from fonts. - Functions for fetching name strings from OpenType fonts. + Functions for fetching name strings from OpenType fonts. - Support functions for OpenType shaping related queries. + Support functions for OpenType shaping related queries. - Functions for fetching information about OpenType Variable Fonts. + Functions for fetching information about OpenType Variable Fonts. - Set objects represent a mathematical set of integer values. They are + Set objects represent a mathematical set of integer values. They are used in non-shaping APIs to query certain sets of characters or glyphs, or other integer values. - Shaping is the central operation of HarfBuzz. Shaping operates on buffers, + Shaping is the central operation of HarfBuzz. Shaping operates on buffers, which are sequences of Unicode characters that use the same font and have the same text direction, script, and language. After shaping the buffer contains the output glyphs and their positions. - Shape plans are an internal mechanism. Each plan contains state + Shape plans are an internal mechanism. Each plan contains state describing how HarfBuzz will shape a particular text segment, based on the combination of segment properties and the capabilities in the font face in use. @@ -6072,7 +6340,7 @@ etc.). Most client programs will not need to deal with shape plans directly. - Unicode functions are used to access Unicode character properties. + Unicode functions are used to access Unicode character properties. With these functions, client programs can query various properties from the Unicode Character Database for any code point, such as General Category (gc), Script (sc), Canonical Combining Class (ccc), etc. @@ -6085,34 +6353,35 @@ HarfBuzz provides built-in default functions for each method in #hb_unicode_funcs_t. - These functions and macros allow accessing version of the HarfBuzz + These functions and macros allow accessing version of the HarfBuzz library used at compile- as well as run-time, and to direct code conditionally based on those versions, again, at compile- or run-time. - Converts @str representing a BCP 47 language tag to the corresponding + Converts @str representing a BCP 47 language tag to the corresponding #hb_language_t. + - + The #hb_language_t corresponding to the BCP 47 language tag. - a string representing + a string representing a BCP 47 language tag - length of the @str, or -1 if it is %NULL-terminated. + length of the @str, or -1 if it is %NULL-terminated. - Fetch the default language from current locale. + Fetch the default language from current locale. <note>Note that the first time this function is called, it calls "setlocale (LC_CTYPE, nullptr)" to fetch current locale. The underlying @@ -6120,257 +6389,276 @@ setlocale function is, in many implementations, NOT threadsafe. To avoid problems, call this function once before multiple threads can call it. This function is only used from hb_buffer_guess_segment_properties() by HarfBuzz itself.</note> + - The default language of the locale as + The default language of the locale as an #hb_language_t + - Converts an #hb_language_t to a string. + Converts an #hb_language_t to a string. + - + A %NULL-terminated string representing the @language. Must not be freed by the caller. - The #hb_language_t to convert + The #hb_language_t to convert - Converts an #hb_language_t to a string. + Converts an #hb_language_t to a string. + - + A %NULL-terminated string representing the @language. Must not be freed by the caller. - The #hb_language_t to convert + The #hb_language_t to convert - Tests whether memory allocation for a set was successful. + Tests whether memory allocation for a set was successful. + - %true if allocation succeeded, false otherwise + %true if allocation succeeded, false otherwise - A map + A map - Clears out the contents of @map. + Clears out the contents of @map. + - A map + A map - Creates a new, initially empty map. + Creates a new, initially empty map. + - The new #hb_map_t + The new #hb_map_t - Removes @key and its stored value from @map. + Removes @key and its stored value from @map. + - A map + A map - The key to delete + The key to delete - Decreases the reference count on a map. When + Decreases the reference count on a map. When the reference count reaches zero, the map is destroyed, freeing all memory. + - A map + A map - Fetches the value stored for @key in @map. + Fetches the value stored for @key in @map. + - A map + A map - The key to query + The key to query - Fetches the singleton empty #hb_map_t. + Fetches the singleton empty #hb_map_t. + - The empty #hb_map_t + The empty #hb_map_t - Returns the number of key-value pairs in the map. + Returns the number of key-value pairs in the map. + - The population of @map + The population of @map - A map + A map - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified map. + - A pointer to the user data + A pointer to the user data - A map + A map - The user-data key to query + The user-data key to query - Tests whether @key is an element of @map. + Tests whether @key is an element of @map. + - %true if @key is found in @map, false otherwise + %true if @key is found in @map, false otherwise - A map + A map - The key to query + The key to query - Tests whether @map is empty (contains no elements). + Tests whether @map is empty (contains no elements). + - %true if @map is empty + %true if @map is empty - A map + A map - Increases the reference count on a map. + Increases the reference count on a map. + - The map + The map - A map + A map - Stores @key:@value in the map. + Stores @key:@value in the map. + - A map + A map - The key to store in the map + The key to store in the map - The value to store for @key + The value to store for @key - Attaches a user-data key/data pair to the specified map. + Attaches a user-data key/data pair to the specified map. + - %true if success, %false otherwise + %true if success, %false otherwise - A map + A map - The user-data key to set + The user-data key to set - A pointer to the user data to set + A pointer to the user data to set - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Data type for holding integer-to-integer hash maps. + Data type for holding integer-to-integer hash maps. + - @HB_MEMORY_MODE_DUPLICATE + @HB_MEMORY_MODE_DUPLICATE @HB_MEMORY_MODE_READONLY @HB_MEMORY_MODE_WRITABLE @HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE @@ -6404,32 +6692,33 @@ Regarding these various memory-modes: - Fetches a list of all color layers for the specified glyph index in the specified + Fetches a list of all color layers for the specified glyph index in the specified face. The list returned will begin at the offset provided. + - Total number of layers available for the glyph index queried + Total number of layers available for the glyph index queried - #hb_face_t to work upon + #hb_face_t to work upon - The glyph index to query + The glyph index to query - offset of the first layer to retrieve + offset of the first layer to retrieve - Input = the maximum number of layers to return; + Input = the maximum number of layers to return; Output = the actual number of layers returned (may be zero) - The array of layers found + The array of layers found @@ -6437,95 +6726,102 @@ face. The list returned will begin at the offset provided. - Fetches the PNG image for a glyph. This function takes a font object, not a face object, + Fetches the PNG image for a glyph. This function takes a font object, not a face object, as input. To get an optimally sized PNG blob, the UPEM value must be set on the @font object. If UPEM is unset, the blob returned will be the largest PNG available. + - An #hb_blob_t containing the PNG image for the glyph, if available + An #hb_blob_t containing the PNG image for the glyph, if available - #hb_font_t to work upon + #hb_font_t to work upon - a glyph index + a glyph index - Fetches the SVG document for a glyph. The blob may be either plain text or gzip-encoded. + Fetches the SVG document for a glyph. The blob may be either plain text or gzip-encoded. + - An #hb_blob_t containing the SVG document of the glyph, if available + An #hb_blob_t containing the SVG document of the glyph, if available - #hb_face_t to work upon + #hb_face_t to work upon - a svg glyph index + a svg glyph index - Tests whether a face includes any `COLR` color layers. + Tests whether a face includes any `COLR` color layers. + - true if data found, false otherwise + true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - Tests whether a face includes a `CPAL` color-palette table. + Tests whether a face includes a `CPAL` color-palette table. + - true if data found, false otherwise + true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - Tests whether a face has PNG glyph images (either in `CBDT` or `sbix` tables). + Tests whether a face has PNG glyph images (either in `CBDT` or `sbix` tables). + - true if data found, false otherwise + true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - Tests whether a face includes any `SVG` glyph images. + Tests whether a face includes any `SVG` glyph images. + - true if data found, false otherwise. + true if data found, false otherwise. - #hb_face_t to work upon. + #hb_face_t to work upon. - Pairs of glyph and color index. + Pairs of glyph and color index. + @@ -6534,72 +6830,74 @@ object. If UPEM is unset, the blob returned will be the largest PNG available. - Fetches the `name` table Name ID that provides display names for + Fetches the `name` table Name ID that provides display names for the specificed color in a face's `CPAL` color palette. Display names can be generic (e.g., "Background") or specific (e.g., "Eye color"). + - the Name ID found for the color. + the Name ID found for the color. - #hb_face_t to work upon + #hb_face_t to work upon - The index of the color + The index of the color - Default indicating that there is nothing special + Default indicating that there is nothing special to note about a color palette. - Flag indicating that the color + Flag indicating that the color palette is appropriate to use when displaying the font on a light background such as white. - Flag indicating that the color + Flag indicating that the color palette is appropriate to use when displaying the font on a dark background such as black. - Fetches a list of the colors in a color palette. + Fetches a list of the colors in a color palette. After calling this function, @colors will be filled with the palette colors. If @colors is NULL, the function will just return the number of total colors without storing any actual colors; this can be used for allocating a buffer of suitable size before calling hb_ot_color_palette_get_colors() a second time. + - the total number of colors in the palette + the total number of colors in the palette - #hb_face_t to work upon + #hb_face_t to work upon - the index of the color palette to query + the index of the color palette to query - offset of the first color to retrieve + offset of the first color to retrieve - Input = the maximum number of colors to return; + Input = the maximum number of colors to return; Output = the actual number of colors returned (may be zero) - The array of #hb_color_t records found + The array of #hb_color_t records found @@ -6607,206 +6905,213 @@ hb_ot_color_palette_get_colors() a second time. - Fetches the number of color palettes in a face. + Fetches the number of color palettes in a face. + - the number of palettes found + the number of palettes found - #hb_face_t to work upon + #hb_face_t to work upon - Fetches the flags defined for a color palette. + Fetches the flags defined for a color palette. + - the #hb_ot_color_palette_flags_t of the requested color palette + the #hb_ot_color_palette_flags_t of the requested color palette - #hb_face_t to work upon + #hb_face_t to work upon - The index of the color palette + The index of the color palette - Fetches the `name` table Name ID that provides display names for + Fetches the `name` table Name ID that provides display names for a `CPAL` color palette. Palette display names can be generic (e.g., "Default") or provide specific, themed names (e.g., "Spring", "Summer", "Fall", and "Winter"). + - the Named ID found for the palette. + the Named ID found for the palette. If the requested palette has no name the result is #HB_OT_NAME_ID_INVALID. - #hb_face_t to work upon + #hb_face_t to work upon - The index of the color palette + The index of the color palette - Sets the font functions to use when working with @font. + Sets the font functions to use when working with @font. + - #hb_font_t to work upon + #hb_font_t to work upon - Baseline tags from https://docs.microsoft.com/en-us/typography/opentype/spec/baselinetags + Baseline tags from https://docs.microsoft.com/en-us/typography/opentype/spec/baselinetags - The baseline used by alphabetic scripts such as Latin, Cyrillic and Greek. + The baseline used by alphabetic scripts such as Latin, Cyrillic and Greek. In vertical writing mode, the alphabetic baseline for characters rotated 90 degrees clockwise. (This would not apply to alphabetic characters that remain upright in vertical writing mode, since these characters are not rotated.) - The hanging baseline. In horizontal direction, this is the horizontal + The hanging baseline. In horizontal direction, this is the horizontal line from which syllables seem, to hang in Tibetan and other similar scripts. In vertical writing mode, for Tibetan (or some other similar script) characters rotated 90 degrees clockwise. - Ideographic character face bottom or left edge, + Ideographic character face bottom or left edge, if the direction is horizontal or vertical, respectively. - Ideographic character face top or right edge, + Ideographic character face top or right edge, if the direction is horizontal or vertical, respectively. - Ideographic em-box bottom or left edge, + Ideographic em-box bottom or left edge, if the direction is horizontal or vertical, respectively. - Ideographic em-box top or right edge baseline, + Ideographic em-box top or right edge baseline, if the direction is horizontal or vertical, respectively. - The baseline about which mathematical characters are centered. + The baseline about which mathematical characters are centered. In vertical writing mode when mathematical characters rotated 90 degrees clockwise, are centered. - Fetches a list of all feature indexes in the specified face's GSUB table + Fetches a list of all feature indexes in the specified face's GSUB table or GPOS table, underneath the specified scripts, languages, and features. If no list of scripts is provided, all scripts will be queried. If no list of languages is provided, all languages will be queried. If no list of features is provided, all features will be queried. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The array of scripts to collect features for + The array of scripts to collect features for - The array of languages to collect features for + The array of languages to collect features for - The array of features to collect + The array of features to collect - The array of feature indexes found for the query + The array of feature indexes found for the query - Fetches a list of all feature-lookup indexes in the specified face's GSUB + Fetches a list of all feature-lookup indexes in the specified face's GSUB table or GPOS table, underneath the specified scripts, languages, and features. If no list of scripts is provided, all scripts will be queried. If no list of languages is provided, all languages will be queried. If no list of features is provided, all features will be queried. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The array of scripts to collect lookups for + The array of scripts to collect lookups for - The array of languages to collect lookups for + The array of languages to collect lookups for - The array of features to collect lookups for + The array of features to collect lookups for - The array of lookup indexes found for the query + The array of lookup indexes found for the query - Fetches a list of the characters defined as having a variant under the specified + Fetches a list of the characters defined as having a variant under the specified "Character Variant" ("cvXX") feature tag. + - Number of total sample characters in the cvXX feature. + Number of total sample characters in the cvXX feature. - #hb_face_t to work upon + #hb_face_t to work upon - table tag to query, "GSUB" or "GPOS". + table tag to query, "GSUB" or "GPOS". - index of feature to query. + index of feature to query. - offset of the first character to retrieve + offset of the first character to retrieve - Input = the maximum number of characters to return; + Input = the maximum number of characters to return; Output = the actual number of characters returned (may be zero) - A buffer pointer. + A buffer pointer. The Unicode codepoints of the characters for which this feature provides glyph variants. @@ -6816,36 +7121,37 @@ list of features is provided, all features will be queried. - Fetches a list of all lookups enumerated for the specified feature, in + Fetches a list of all lookups enumerated for the specified feature, in the specified face's GSUB table or GPOS table. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested feature + The index of the requested feature - offset of the first lookup to retrieve + offset of the first lookup to retrieve - Input = the maximum number of lookups to return; + Input = the maximum number of lookups to return; Output = the actual number of lookups returned (may be zero) - The array of lookup indexes found for the query + The array of lookup indexes found for the query @@ -6853,47 +7159,48 @@ begin at the offset provided. - Fetches name indices from feature parameters for "Stylistic Set" ('ssXX') or + Fetches name indices from feature parameters for "Stylistic Set" ('ssXX') or "Character Variant" ('cvXX') features. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - table tag to query, "GSUB" or "GPOS". + table tag to query, "GSUB" or "GPOS". - index of feature to query. + index of feature to query. - The ‘name’ table name ID that specifies a string + The ‘name’ table name ID that specifies a string for a user-interface label for this feature. (May be NULL.) - The ‘name’ table name ID that specifies a string + The ‘name’ table name ID that specifies a string that an application can use for tooltip text for this feature. (May be NULL.) - The ‘name’ table name ID that specifies sample text + The ‘name’ table name ID that specifies sample text that illustrates the effect of this feature. (May be NULL.) - Number of named parameters. (May be zero.) + Number of named parameters. (May be zero.) - The first ‘name’ table name ID used to specify + The first ‘name’ table name ID used to specify strings for user-interface labels for the feature parameters. (Must be zero if numParameters is zero.) @@ -6901,40 +7208,41 @@ begin at the offset provided. - Fetches a list of all lookups enumerated for the specified feature, in + Fetches a list of all lookups enumerated for the specified feature, in the specified face's GSUB table or GPOS table, enabled at the specified variations index. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the feature to query + The index of the feature to query - The index of the feature variation to query + The index of the feature variation to query - offset of the first lookup to retrieve + offset of the first lookup to retrieve - Input = the maximum number of lookups to return; + Input = the maximum number of lookups to return; Output = the actual number of lookups returned (may be zero) - The array of lookups found for the query + The array of lookups found for the query @@ -6942,33 +7250,34 @@ variations index. The list returned will begin at the offset provided. - Fetches a list of all attachment points for the specified glyph in the GDEF + Fetches a list of all attachment points for the specified glyph in the GDEF table of the face. The list returned will begin at the offset provided. Useful if the client program wishes to cache the list. + - The #hb_face_t to work on + The #hb_face_t to work on - The #hb_codepoint_t code point to query + The #hb_codepoint_t code point to query - offset of the first attachment point to retrieve + offset of the first attachment point to retrieve - Input = the maximum number of attachment points to return; + Input = the maximum number of attachment points to return; Output = the actual number of attachment points returned (may be zero) - The array of attachment points found for the query + The array of attachment points found for the query @@ -6976,108 +7285,112 @@ Useful if the client program wishes to cache the list. - Fetches a baseline value from the face. + Fetches a baseline value from the face. + - if found baseline value in the font. + if found baseline value in the font. - a font + a font - a baseline tag + a baseline tag - text direction. + text direction. - script tag. + script tag. - language tag. + language tag. - baseline value if found. + baseline value if found. - Fetches the GDEF class of the requested glyph in the specified face. + Fetches the GDEF class of the requested glyph in the specified face. + - The #hb_ot_layout_glyph_class_t glyph class of the given code + The #hb_ot_layout_glyph_class_t glyph class of the given code point in the GDEF table of the face. - The #hb_face_t to work on + The #hb_face_t to work on - The #hb_codepoint_t code point to query + The #hb_codepoint_t code point to query - Retrieves the set of all glyphs from the face that belong to the requested + Retrieves the set of all glyphs from the face that belong to the requested glyph class in the face's GDEF table. + - The #hb_face_t to work on + The #hb_face_t to work on - The #hb_ot_layout_glyph_class_t GDEF class to retrieve + The #hb_ot_layout_glyph_class_t GDEF class to retrieve - The #hb_set_t set of all glyphs belonging to the requested + The #hb_set_t set of all glyphs belonging to the requested class. - Fetches a list of the caret positions defined for a ligature glyph in the GDEF + Fetches a list of the caret positions defined for a ligature glyph in the GDEF table of the font. The list returned will begin at the offset provided. + - The #hb_font_t to work on + The #hb_font_t to work on - The #hb_direction_t text direction to use + The #hb_direction_t text direction to use - The #hb_codepoint_t code point to query + The #hb_codepoint_t code point to query - offset of the first caret position to retrieve + offset of the first caret position to retrieve - Input = the maximum number of caret positions to return; + Input = the maximum number of caret positions to return; Output = the actual number of caret positions returned (may be zero) - The array of caret positions found for the query + The array of caret positions found for the query @@ -7085,7 +7398,7 @@ table of the font. The list returned will begin at the offset provided. - Fetches optical-size feature data (i.e., the `size` feature from GPOS). Note that + Fetches optical-size feature data (i.e., the `size` feature from GPOS). Note that the subfamily_id and the subfamily name string (accessible via the subfamily_name_id) as used here are defined as pertaining only to fonts within a font family that differ specifically in their respective size ranges; other ways to differentiate fonts within @@ -7093,162 +7406,168 @@ a subfamily are not covered by the `size` feature. For more information on this distinction, see the [`size` feature documentation]( https://docs.microsoft.com/en-us/typography/opentype/spec/features_pt#tag-size). + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - The design size of the face + The design size of the face - The identifier of the face within the font subfamily + The identifier of the face within the font subfamily - The ‘name’ table name ID of the face within the font subfamily + The ‘name’ table name ID of the face within the font subfamily - The minimum size of the recommended size range for the face + The minimum size of the recommended size range for the face - The maximum size of the recommended size range for the face + The maximum size of the recommended size range for the face - The GDEF classes defined for glyphs. + The GDEF classes defined for glyphs. - Glyphs not matching the other classifications + Glyphs not matching the other classifications - Spacing, single characters, capable of accepting marks + Spacing, single characters, capable of accepting marks - Glyphs that represent ligation of multiple characters + Glyphs that represent ligation of multiple characters - Non-spacing, combining glyphs that represent marks + Non-spacing, combining glyphs that represent marks - Spacing glyphs that represent part of a single character + Spacing glyphs that represent part of a single character - Tests whether a face has any glyph classes defined in its GDEF table. + Tests whether a face has any glyph classes defined in its GDEF table. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon + - %true if the face has GPOS data, false otherwise + %true if the face has GPOS data, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - Tests whether the specified face includes any GSUB substitutions. + Tests whether the specified face includes any GSUB substitutions. + - %true if data found, false otherwise + %true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - Fetches the index of a given feature tag in the specified face's GSUB table + Fetches the index of a given feature tag in the specified face's GSUB table or GPOS table, underneath the specified script and language. + - %true if the feature is found, false otherwise + %true if the feature is found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The index of the requested language tag + The index of the requested language tag - #hb_tag_t of the feature tag requested + #hb_tag_t of the feature tag requested - The index of the requested feature + The index of the requested feature - Fetches a list of all features in the specified face's GSUB table + Fetches a list of all features in the specified face's GSUB table or GPOS table, underneath the specified script and language. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The index of the requested language tag + The index of the requested language tag - offset of the first feature tag to retrieve + offset of the first feature tag to retrieve - Input = the maximum number of feature tags to return; + Input = the maximum number of feature tags to return; Output: the actual number of feature tags returned (may be zero) - The array of feature indexes found for the query + The array of feature indexes found for the query @@ -7256,40 +7575,41 @@ returned will begin at the offset provided. - Fetches a list of all features in the specified face's GSUB table + Fetches a list of all features in the specified face's GSUB table or GPOS table, underneath the specified script and language. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The index of the requested language tag + The index of the requested language tag - offset of the first feature tag to retrieve + offset of the first feature tag to retrieve - Input = the maximum number of feature tags to return; + Input = the maximum number of feature tags to return; Output = the actual number of feature tags returned (may be zero) - The array of #hb_tag_t feature tags found for the query + The array of #hb_tag_t feature tags found for the query @@ -7297,136 +7617,140 @@ returned will begin at the offset provided. - Fetches the tag of a requested feature index in the given face's GSUB or GPOS table, + Fetches the tag of a requested feature index in the given face's GSUB or GPOS table, underneath the specified script and language. + - %true if the feature is found, false otherwise + %true if the feature is found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The index of the requested language tag + The index of the requested language tag - The index of the requested feature + The index of the requested feature - The #hb_tag_t of the requested feature + The #hb_tag_t of the requested feature - Fetches the index of a requested feature in the given face's GSUB or GPOS table, + Fetches the index of a requested feature in the given face's GSUB or GPOS table, underneath the specified script and language. + - %true if the feature is found, false otherwise + %true if the feature is found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The index of the requested language tag + The index of the requested language tag - The index of the requested feature + The index of the requested feature - Fetches a list of all glyphs affected by the specified lookup in the + Fetches a list of all glyphs affected by the specified lookup in the specified face's GSUB table or GPOS table. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the feature lookup to query + The index of the feature lookup to query - Array of glyphs preceding the substitution range + Array of glyphs preceding the substitution range - Array of input glyphs that would be substituted by the lookup + Array of input glyphs that would be substituted by the lookup - Array of glyphs following the substitution range + Array of glyphs following the substitution range - Array of glyphs that would be the substituted output of the lookup + Array of glyphs that would be the substituted output of the lookup - Fetches alternates of a glyph from a given GSUB lookup index. + Fetches alternates of a glyph from a given GSUB lookup index. + - total number of alternates found in the specific lookup index for the given glyph id. + total number of alternates found in the specific lookup index for the given glyph id. - a face. + a face. - index of the feature lookup to query. + index of the feature lookup to query. - a glyph id. + a glyph id. - starting offset. + starting offset. - Input = the maximum number of alternate glyphs to return; + Input = the maximum number of alternate glyphs to return; Output = the actual number of alternate glyphs returned (may be zero). - A glyphs buffer. + A glyphs buffer. Alternate glyphs associated with the glyph id. @@ -7435,139 +7759,144 @@ specified face's GSUB table or GPOS table. - Compute the transitive closure of glyphs needed for a + Compute the transitive closure of glyphs needed for a specified lookup. + - #hb_face_t to work upon + #hb_face_t to work upon - index of the feature lookup to query + index of the feature lookup to query - Array of glyphs comprising the transitive closure of the lookup + Array of glyphs comprising the transitive closure of the lookup - Tests whether a specified lookup in the specified face would + Tests whether a specified lookup in the specified face would trigger a substitution on the given glyph sequence. + - %true if a substitution would be triggered, false otherwise + %true if a substitution would be triggered, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - The index of the lookup to query + The index of the lookup to query - The sequence of glyphs to query for substitution + The sequence of glyphs to query for substitution - The length of the glyph sequence + The length of the glyph sequence - #hb_bool_t indicating whether substitutions should be context-free + #hb_bool_t indicating whether substitutions should be context-free - Compute the transitive closure of glyphs needed for all of the + Compute the transitive closure of glyphs needed for all of the provided lookups. + - #hb_face_t to work upon + #hb_face_t to work upon - The set of lookups to query + The set of lookups to query - Array of glyphs comprising the transitive closure of the lookups + Array of glyphs comprising the transitive closure of the lookups - Fetches the index of a given language tag in the specified face's GSUB table + Fetches the index of a given language tag in the specified face's GSUB table or GPOS table, underneath the specified script tag. ?? ?? + - %true if the language tag is found, false otherwise + %true if the language tag is found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The #hb_tag_t of the requested language + The #hb_tag_t of the requested language - The index of the requested language + The index of the requested language - Fetches a list of language tags in the given face's GSUB or GPOS table, underneath + Fetches a list of language tags in the given face's GSUB or GPOS table, underneath the specified script index. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - offset of the first language tag to retrieve + offset of the first language tag to retrieve - Input = the maximum number of language tags to return; + Input = the maximum number of language tags to return; Output = the actual number of language tags returned (may be zero) - Array of language tags found in the table + Array of language tags found in the table @@ -7575,147 +7904,152 @@ the specified script index. The list returned will begin at the offset provided. - Fetches the index of a given language tag in the specified face's GSUB table + Fetches the index of a given language tag in the specified face's GSUB table or GPOS table, underneath the specified script index. + - %true if the language tag is found, false otherwise + %true if the language tag is found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The index of the requested script tag + The index of the requested script tag - The number of languages in the specified script + The number of languages in the specified script - The array of language tags + The array of language tags - The index of the requested language + The index of the requested language - Deprecated since 2.0.0 + Deprecated since 2.0.0 + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - Array of #hb_tag_t script tags + Array of #hb_tag_t script tags - The index of the requested script tag + The index of the requested script tag - #hb_tag_t of the script tag requested + #hb_tag_t of the script tag requested - Fetches a list of feature variations in the specified face's GSUB table + Fetches a list of feature variations in the specified face's GSUB table or GPOS table, at the specified variation coordinates. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - The variation coordinates to query + The variation coordinates to query - The number of variation coordinates + The number of variation coordinates - The array of feature variations found for the query + The array of feature variations found for the query - Fetches the index if a given script tag in the specified face's GSUB table + Fetches the index if a given script tag in the specified face's GSUB table or GPOS table. + - %true if the script is found, false otherwise + %true if the script is found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - #hb_tag_t of the script tag requested + #hb_tag_t of the script tag requested - The index of the requested script tag + The index of the requested script tag - Fetches a list of all feature tags in the given face's GSUB or GPOS table. + Fetches a list of all feature tags in the given face's GSUB or GPOS table. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - offset of the first feature tag to retrieve + offset of the first feature tag to retrieve - Input = the maximum number of feature tags to return; + Input = the maximum number of feature tags to return; Output = the actual number of feature tags returned (may be zero) - Array of feature tags found in the table + Array of feature tags found in the table @@ -7723,48 +8057,50 @@ or GPOS table. - Fetches the total number of lookups enumerated in the specified + Fetches the total number of lookups enumerated in the specified face's GSUB table or GPOS table. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - Fetches a list of all scripts enumerated in the specified face's GSUB table + Fetches a list of all scripts enumerated in the specified face's GSUB table or GPOS table. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - offset of the first script tag to retrieve + offset of the first script tag to retrieve - Input = the maximum number of script tags to return; + Input = the maximum number of script tags to return; Output = the actual number of script tags returned (may be zero) - The array of #hb_tag_t script tags found for the query + The array of #hb_tag_t script tags found for the query @@ -7772,38 +8108,39 @@ or GPOS table. The list returned will begin at the offset provided. + - #hb_face_t to work upon + #hb_face_t to work upon - HB_OT_TAG_GSUB or HB_OT_TAG_GPOS + HB_OT_TAG_GSUB or HB_OT_TAG_GPOS - Number of script tags in the array + Number of script tags in the array - Array of #hb_tag_t script tags + Array of #hb_tag_t script tags - The index of the requested script + The index of the requested script - #hb_tag_t of the requested script + #hb_tag_t of the requested script - The 'MATH' table constants specified at + The 'MATH' table constants specified at https://docs.microsoft.com/en-us/typography/opentype/spec/math @@ -7919,30 +8256,31 @@ https://docs.microsoft.com/en-us/typography/opentype/spec/math - Fetches the specified math constant. For most constants, the value returned + Fetches the specified math constant. For most constants, the value returned is an #hb_position_t. However, if the requested constant is #HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN, #HB_OT_MATH_CONSTANT_SCRIPT_SCRIPT_PERCENT_SCALE_DOWN or #HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN, then the return value is an integer between 0 and 100 representing that percentage. + - the requested constant or zero + the requested constant or zero - #hb_font_t to work upon + #hb_font_t to work upon - #hb_ot_math_constant_t the constant to retrieve + #hb_ot_math_constant_t the constant to retrieve - Fetches the GlyphAssembly for the specified font, glyph index, and direction. + Fetches the GlyphAssembly for the specified font, glyph index, and direction. Returned are a list of #hb_ot_math_glyph_part_t glyph parts that can be used to draw the glyph and an italics-correction value (if one is defined in the font). @@ -7951,95 +8289,98 @@ in the font). or vertical directions for the construction. Even though all #hb_direction_t values are accepted, only the result of #HB_DIRECTION_IS_HORIZONTAL is considered.</note> + - the total number of parts in the glyph assembly + the total number of parts in the glyph assembly - #hb_font_t to work upon + #hb_font_t to work upon - The index of the glyph to stretch + The index of the glyph to stretch - direction of the stretching (horizontal or vertical) + direction of the stretching (horizontal or vertical) - offset of the first glyph part to retrieve + offset of the first glyph part to retrieve - Input = maximum number of glyph parts to return; + Input = maximum number of glyph parts to return; Output = actual number of parts returned - the glyph parts returned + the glyph parts returned - italics correction of the glyph assembly + italics correction of the glyph assembly - Fetches an italics-correction value (if one exists) for the specified + Fetches an italics-correction value (if one exists) for the specified glyph index. + - the italics correction of the glyph or zero + the italics correction of the glyph or zero - #hb_font_t to work upon + #hb_font_t to work upon - The glyph index from which to retrieve the value + The glyph index from which to retrieve the value - Fetches the math kerning (cut-ins) value for the specified font, glyph index, and + Fetches the math kerning (cut-ins) value for the specified font, glyph index, and @kern. If the MathKern table is found, the function examines it to find a height value that is greater or equal to @correction_height. If such a height value is found, corresponding kerning value from the table is returned. If no such height value is found, the last kerning value is returned. + - requested kerning value or zero + requested kerning value or zero - #hb_font_t to work upon + #hb_font_t to work upon - The glyph index from which to retrieve the value + The glyph index from which to retrieve the value - The #hb_ot_math_kern_t from which to retrieve the value + The #hb_ot_math_kern_t from which to retrieve the value - the correction height to use to determine the kerning. + the correction height to use to determine the kerning. - Fetches a top-accent-attachment value (if one exists) for the specified + Fetches a top-accent-attachment value (if one exists) for the specified glyph index. For any glyph that does not have a top-accent-attachment value - that is, @@ -8047,24 +8388,25 @@ a glyph not covered by the `MathTopAccentAttachment` table (or, when @font has no `MathTopAccentAttachment` table or no `MATH` table, any glyph) - the function synthesizes a value, returning the position at one-half the glyph's advance width. + - the top accent attachment of the glyph or 0.5 * the advance + the top accent attachment of the glyph or 0.5 * the advance width of @glyph - #hb_font_t to work upon + #hb_font_t to work upon - The glyph index from which to retrieve the value + The glyph index from which to retrieve the value - Fetches the MathGlyphConstruction for the specified font, glyph index, and + Fetches the MathGlyphConstruction for the specified font, glyph index, and direction. The corresponding list of size variants is returned as a list of #hb_ot_math_glyph_variant_t structs. @@ -8072,34 +8414,35 @@ direction. The corresponding list of size variants is returned as a list of or vertical directions for the construction. Even though all #hb_direction_t values are accepted, only the result of #HB_DIRECTION_IS_HORIZONTAL is considered.</note> + - the total number of size variants available or zero + the total number of size variants available or zero - #hb_font_t to work upon + #hb_font_t to work upon - The index of the glyph to stretch + The index of the glyph to stretch - The direction of the stretching (horizontal or vertical) + The direction of the stretching (horizontal or vertical) - offset of the first variant to retrieve + offset of the first variant to retrieve - Input = the maximum number of variants to return; + Input = the maximum number of variants to return; Output = the actual number of variants returned - array of variants returned + array of variants returned @@ -8107,7 +8450,7 @@ considered.</note> - Fetches the MathVariants table for the specified font and returns the + Fetches the MathVariants table for the specified font and returns the minimum overlap of connecting glyphs that are required to draw a glyph assembly in the specified direction. @@ -8115,94 +8458,99 @@ assembly in the specified direction. or vertical directions for the construction. Even though all #hb_direction_t values are accepted, only the result of #HB_DIRECTION_IS_HORIZONTAL is considered.</note> + - requested minimum connector overlap or zero + requested minimum connector overlap or zero - #hb_font_t to work upon + #hb_font_t to work upon - direction of the stretching (horizontal or vertical) + direction of the stretching (horizontal or vertical) - Flags for math glyph parts. + Flags for math glyph parts. - Data type to hold information for a "part" component of a math-variant glyph. + Data type to hold information for a "part" component of a math-variant glyph. Large variants for stretchable math glyphs (such as parentheses) can be constructed on the fly from parts. + - The glyph index of the variant part + The glyph index of the variant part - The length of the connector on the starting side of the variant part + The length of the connector on the starting side of the variant part - The length of the connector on the ending side of the variant part + The length of the connector on the ending side of the variant part - The total advance of the part + The total advance of the part - #hb_ot_math_glyph_part_flags_t flags for the part + #hb_ot_math_glyph_part_flags_t flags for the part - Data type to hold math-variant information for a glyph. + Data type to hold math-variant information for a glyph. + - The glyph index of the variant + The glyph index of the variant - The advance width of the variant + The advance width of the variant - Tests whether a face has a `MATH` table. + Tests whether a face has a `MATH` table. + - true if the table is found, false otherwise + true if the table is found, false otherwise - #hb_face_t to test + #hb_face_t to test - Tests whether the given glyph index is an extended shape in the face. + Tests whether the given glyph index is an extended shape in the face. + - true if the glyph is an extended shape, false otherwise + true if the glyph is an extended shape, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - The glyph index to test + The glyph index to test - The math kerning-table types defined for the four corners + The math kerning-table types defined for the four corners of a glyph. @@ -8214,25 +8562,26 @@ of a glyph. + - Number of all available feature types. + Number of all available feature types. - a face object + a face object - iteration's start offset + iteration's start offset - buffer size as input, filled size as output + buffer size as input, filled size as output - entries tags buffer + entries tags buffer @@ -8240,57 +8589,60 @@ of a glyph. - It fetches metadata entry of a given tag from a font. + It fetches metadata entry of a given tag from a font. + - A blob containing the blob. + A blob containing the blob. - a #hb_face_t object. + a #hb_face_t object. - tag of metadata you like to have. + tag of metadata you like to have. - Known metadata tags from https://docs.microsoft.com/en-us/typography/opentype/spec/meta + Known metadata tags from https://docs.microsoft.com/en-us/typography/opentype/spec/meta - Design languages. Text, using only + Design languages. Text, using only Basic Latin (ASCII) characters. Indicates languages and/or scripts for the user audiences that the font was primarily designed for. - Supported languages. Text, using + Supported languages. Text, using only Basic Latin (ASCII) characters. Indicates languages and/or scripts that the font is declared to be capable of supporting. - It fetches metrics value corresponding to a given tag from a font. + It fetches metrics value corresponding to a given tag from a font. + - Whether found the requested metrics in the font. + Whether found the requested metrics in the font. - a #hb_font_t object. + a #hb_font_t object. - tag of metrics value you like to fetch. + tag of metrics value you like to fetch. - result of metrics value from the font. + result of metrics value from the font. + @@ -8304,6 +8656,7 @@ that the font is declared to be capable of supporting. + @@ -8317,6 +8670,7 @@ that the font is declared to be capable of supporting. + @@ -8330,134 +8684,136 @@ that the font is declared to be capable of supporting. - From https://docs.microsoft.com/en-us/typography/opentype/spec/mvar#value-tags + From https://docs.microsoft.com/en-us/typography/opentype/spec/mvar#value-tags - horizontal ascender. + horizontal ascender. - horizontal descender. + horizontal descender. - horizontal line gap. + horizontal line gap. - horizontal clipping ascent. + horizontal clipping ascent. - horizontal clipping descent. + horizontal clipping descent. - vertical ascender. + vertical ascender. - vertical descender. + vertical descender. - vertical line gap. + vertical line gap. - horizontal caret rise. + horizontal caret rise. - horizontal caret run. + horizontal caret run. - horizontal caret offset. + horizontal caret offset. - vertical caret rise. + vertical caret rise. - vertical caret run. + vertical caret run. - vertical caret offset. + vertical caret offset. - x height. + x height. - cap height. + cap height. - subscript em x size. + subscript em x size. - subscript em y size. + subscript em y size. - subscript em x offset. + subscript em x offset. - subscript em y offset. + subscript em y offset. - superscript em x size. + superscript em x size. - superscript em y size. + superscript em y size. - superscript em x offset. + superscript em x offset. - superscript em y offset. + superscript em y offset. - strikeout size. + strikeout size. - strikeout offset. + strikeout offset. - underline size. + underline size. - underline offset. + underline offset. - Structure representing a name ID in a particular language. + Structure representing a name ID in a particular language. + - name ID + name ID - language + language - Fetches a font name from the OpenType 'name' table. + Fetches a font name from the OpenType 'name' table. If @language is #HB_LANGUAGE_INVALID, English ("en") is assumed. Returns string in UTF-16 encoding. + - full length of the requested string, or 0 if not found. + full length of the requested string, or 0 if not found. - font face. + font face. - OpenType name identifier to fetch. + OpenType name identifier to fetch. - language to fetch the name for. + language to fetch the name for. - input size of @text buffer, and output size of + input size of @text buffer, and output size of text written to buffer. - buffer to write fetched name into. + buffer to write fetched name into. @@ -8465,33 +8821,34 @@ Returns string in UTF-16 encoding. - Fetches a font name from the OpenType 'name' table. + Fetches a font name from the OpenType 'name' table. If @language is #HB_LANGUAGE_INVALID, English ("en") is assumed. Returns string in UTF-32 encoding. + - full length of the requested string, or 0 if not found. + full length of the requested string, or 0 if not found. - font face. + font face. - OpenType name identifier to fetch. + OpenType name identifier to fetch. - language to fetch the name for. + language to fetch the name for. - input size of @text buffer, and output size of + input size of @text buffer, and output size of text written to buffer. - buffer to write fetched name into. + buffer to write fetched name into. @@ -8499,33 +8856,34 @@ Returns string in UTF-32 encoding. - Fetches a font name from the OpenType 'name' table. + Fetches a font name from the OpenType 'name' table. If @language is #HB_LANGUAGE_INVALID, English ("en") is assumed. Returns string in UTF-8 encoding. + - full length of the requested string, or 0 if not found. + full length of the requested string, or 0 if not found. - font face. + font face. - OpenType name identifier to fetch. + OpenType name identifier to fetch. - language to fetch the name for. + language to fetch the name for. - input size of @text buffer, and output size of + input size of @text buffer, and output size of text written to buffer. - buffer to write fetched name into. + buffer to write fetched name into. @@ -8533,59 +8891,62 @@ Returns string in UTF-8 encoding. - Enumerates all available name IDs and language combinations. Returned + Enumerates all available name IDs and language combinations. Returned array is owned by the @face and should not be modified. It can be used as long as @face is alive. + - Array of available name entries. + Array of available name entries. - font face. + font face. - number of returned entries. + number of returned entries. - Computes the transitive closure of glyphs needed for a specified + Computes the transitive closure of glyphs needed for a specified input buffer under the given font and feature list. The closure is computed as a set, not as a list. + - #hb_font_t to work upon + #hb_font_t to work upon - The input buffer to compute from + The input buffer to compute from - The features enabled on the buffer + The features enabled on the buffer - The number of features enabled on the buffer + The number of features enabled on the buffer - The #hb_set_t set of glyphs comprising the transitive closure of the query + The #hb_set_t set of glyphs comprising the transitive closure of the query + @@ -8596,6 +8957,7 @@ computed as a set, not as a list. + @@ -8606,6 +8968,7 @@ computed as a set, not as a list. + @@ -8616,6 +8979,7 @@ computed as a set, not as a list. + @@ -8632,62 +8996,64 @@ computed as a set, not as a list. - Converts an #hb_script_t and an #hb_language_t to script and language tags. + Converts an #hb_script_t and an #hb_language_t to script and language tags. + - an #hb_script_t to convert. + an #hb_script_t to convert. - an #hb_language_t to convert. + an #hb_language_t to convert. - maximum number of script tags to retrieve (IN) + maximum number of script tags to retrieve (IN) and actual number of script tags retrieved (OUT) - array of size at least @script_count to store the + array of size at least @script_count to store the script tag results - maximum number of language tags to retrieve + maximum number of language tags to retrieve (IN) and actual number of language tags retrieved (OUT) - array of size at least @language_count to store + array of size at least @language_count to store the language tag results - Converts a script tag and a language tag to an #hb_script_t and an + Converts a script tag and a language tag to an #hb_script_t and an #hb_language_t. + - a script tag + a script tag - a language tag + a language tag - the #hb_script_t corresponding to @script_tag (OUT). + the #hb_script_t corresponding to @script_tag (OUT). - the #hb_language_t corresponding to @script_tag and + the #hb_language_t corresponding to @script_tag and @language_tag (OUT). @@ -8695,42 +9061,43 @@ the language tag results - The axis should not be exposed directly in user interfaces. + The axis should not be exposed directly in user interfaces. - Data type for holding variation-axis values. + Data type for holding variation-axis values. The minimum, default, and maximum values are in un-normalized, user scales. <note>Note: at present, the only flag defined for @flags is #HB_OT_VAR_AXIS_FLAG_HIDDEN.</note> + - Index of the axis in the variation-axis array + Index of the axis in the variation-axis array - The #hb_tag_t tag identifying the design variation of the axis + The #hb_tag_t tag identifying the design variation of the axis - The `name` table Name ID that provides display names for the axis + The `name` table Name ID that provides display names for the axis - The #hb_ot_var_axis_flags_t flags for the axis + The #hb_ot_var_axis_flags_t flags for the axis - The mininum value on the variation axis that the font covers + The mininum value on the variation axis that the font covers - The position on the variation axis corresponding to the font's defaults + The position on the variation axis corresponding to the font's defaults - The maximum value on the variation axis that the font covers + The maximum value on the variation axis that the font covers @@ -8738,6 +9105,7 @@ The minimum, default, and maximum values are in un-normalized, user scales. + @@ -8755,76 +9123,79 @@ The minimum, default, and maximum values are in un-normalized, user scales. - Fetches the variation-axis information corresponding to the specified axis tag + Fetches the variation-axis information corresponding to the specified axis tag in the specified face. - use hb_ot_var_find_axis_info() instead + - #hb_face_t to work upon + #hb_face_t to work upon - The #hb_tag_t of the variation axis to query + The #hb_tag_t of the variation axis to query - The index of the variation axis + The index of the variation axis - The #hb_ot_var_axis_info_t of the axis tag queried + The #hb_ot_var_axis_info_t of the axis tag queried - Fetches the variation-axis information corresponding to the specified axis tag + Fetches the variation-axis information corresponding to the specified axis tag in the specified face. + - true if data found, false otherwise + true if data found, false otherwise - #hb_face_t to work upon + #hb_face_t to work upon - The #hb_tag_t of the variation axis to query + The #hb_tag_t of the variation axis to query - The #hb_ot_var_axis_info_t of the axis tag queried + The #hb_ot_var_axis_info_t of the axis tag queried - Fetches a list of all variation axes in the specified face. The list returned will begin + Fetches a list of all variation axes in the specified face. The list returned will begin at the offset provided. use hb_ot_var_get_axis_infos() instead + - #hb_face_t to work upon + #hb_face_t to work upon - offset of the first lookup to retrieve + offset of the first lookup to retrieve - Input = the maximum number of variation axes to return; + Input = the maximum number of variation axes to return; Output = the actual number of variation axes returned (may be zero) - The array of variation axes found + The array of variation axes found @@ -8832,41 +9203,43 @@ at the offset provided. - Fetches the number of OpenType variation axes included in the face. + Fetches the number of OpenType variation axes included in the face. + - the number of variation axes defined + the number of variation axes defined - The #hb_face_t to work on + The #hb_face_t to work on - Fetches a list of all variation axes in the specified face. The list returned will begin + Fetches a list of all variation axes in the specified face. The list returned will begin at the offset provided. + - the number of variation axes in the face + the number of variation axes in the face - #hb_face_t to work upon + #hb_face_t to work upon - offset of the first lookup to retrieve + offset of the first lookup to retrieve - Input = the maximum number of variation axes to return; + Input = the maximum number of variation axes to return; Output = the actual number of variation axes returned (may be zero) - The array of variation axes found + The array of variation axes found @@ -8874,54 +9247,57 @@ at the offset provided. - Fetches the number of named instances included in the face. + Fetches the number of named instances included in the face. + - the number of named instances defined + the number of named instances defined - The #hb_face_t to work on + The #hb_face_t to work on - Tests whether a face includes any OpenType variation data in the `fvar` table. + Tests whether a face includes any OpenType variation data in the `fvar` table. + - true if data found, false otherwise + true if data found, false otherwise - The #hb_face_t to work on + The #hb_face_t to work on - Fetches the design-space coordinates corresponding to the given + Fetches the design-space coordinates corresponding to the given named instance in the face. + - the number of variation axes in the face + the number of variation axes in the face - The #hb_face_t to work on + The #hb_face_t to work on - The index of the named instance to query + The index of the named instance to query - Input = the maximum number of coordinates to return; + Input = the maximum number of coordinates to return; Output = the actual number of coordinates returned (may be zero) - The array of coordinates found for the query + The array of coordinates found for the query @@ -8929,101 +9305,106 @@ named instance in the face. - Fetches the `name` table Name ID that provides display names for + Fetches the `name` table Name ID that provides display names for the "PostScript name" defined for the given named instance in the face. + - the Name ID found for the PostScript name + the Name ID found for the PostScript name - The #hb_face_t to work on + The #hb_face_t to work on - The index of the named instance to query + The index of the named instance to query - Fetches the `name` table Name ID that provides display names for + Fetches the `name` table Name ID that provides display names for the "Subfamily name" defined for the given named instance in the face. + - the Name ID found for the Subfamily name + the Name ID found for the Subfamily name - The #hb_face_t to work on + The #hb_face_t to work on - The index of the named instance to query + The index of the named instance to query - Normalizes the given design-space coordinates. The minimum and maximum + Normalizes the given design-space coordinates. The minimum and maximum values for the axis are mapped to the interval [-1,1], with the default axis value mapped to 0. Any additional scaling defined in the face's `avar` table is also applied, as described at https://docs.microsoft.com/en-us/typography/opentype/spec/avar + - The #hb_face_t to work on + The #hb_face_t to work on - The length of the coordinate array + The length of the coordinate array - The design-space coordinates to normalize + The design-space coordinates to normalize - The normalized coordinates + The normalized coordinates - Normalizes all of the coordinates in the given list of variation axes. + Normalizes all of the coordinates in the given list of variation axes. + - The #hb_face_t to work on + The #hb_face_t to work on - The array of variations to normalize + The array of variations to normalize - The number of variations to normalize + The number of variations to normalize - The array of normalized coordinates + The array of normalized coordinates - The length of the coordinate array + The length of the coordinate array + @@ -9040,71 +9421,74 @@ applied, as described at https://docs.microsoft.com/en-us/typography/opentype/sp - Converts an ISO 15924 script tag to a corresponding #hb_script_t. + Converts an ISO 15924 script tag to a corresponding #hb_script_t. + - An #hb_script_t corresponding to the ISO 15924 tag. + An #hb_script_t corresponding to the ISO 15924 tag. - an #hb_tag_t representing an ISO 15924 tag. + an #hb_tag_t representing an ISO 15924 tag. - Converts a string @str representing an ISO 15924 script tag to a + Converts a string @str representing an ISO 15924 script tag to a corresponding #hb_script_t. Shorthand for hb_tag_from_string() then hb_script_from_iso15924_tag(). + - An #hb_script_t corresponding to the ISO 15924 tag. + An #hb_script_t corresponding to the ISO 15924 tag. - a string representing an + a string representing an ISO 15924 tag. - length of the @str, or -1 if it is %NULL-terminated. + length of the @str, or -1 if it is %NULL-terminated. - Fetches the #hb_direction_t of a script when it is + Fetches the #hb_direction_t of a script when it is set horizontally. All right-to-left scripts will return #HB_DIRECTION_RTL. All left-to-right scripts will return #HB_DIRECTION_LTR. Scripts that can be written either horizontally or vertically will return #HB_DIRECTION_INVALID. Unknown scripts will return #HB_DIRECTION_LTR. + - The horizontal #hb_direction_t of @script + The horizontal #hb_direction_t of @script - The #hb_script_t to query + The #hb_script_t to query - Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding + Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding to the four-letter values defined by [ISO 15924](https://unicode.org/iso15924/). See also the Script (sc) property of the Unicode Character Database. - HB_TAG ('Z','y','y','y') + HB_TAG ('Z','y','y','y') - HB_TAG ('Z','i','n','h') + HB_TAG ('Z','i','n','h') - HB_TAG ('Z','z','z','z') + HB_TAG ('Z','z','z','z') @HB_SCRIPT_ARABIC @HB_SCRIPT_ARMENIAN @HB_SCRIPT_BENGALI @@ -9565,66 +9949,70 @@ See also the Script (sc) property of the Unicode Character Database. - #HB_TAG_NONE + #HB_TAG_NONE - Converts an #hb_script_t to a corresponding ISO 15924 script tag. + Converts an #hb_script_t to a corresponding ISO 15924 script tag. + - An #hb_tag_t representing an ISO 15924 script tag. + An #hb_tag_t representing an ISO 15924 script tag. - an #hb_script_t to convert. + an #hb_script_t to convert. - Checks the equality of two #hb_segment_properties_t's. + Checks the equality of two #hb_segment_properties_t's. + - %true if all properties of @a equal those of @b, %false otherwise. + %true if all properties of @a equal those of @b, %false otherwise. - first #hb_segment_properties_t to compare. + first #hb_segment_properties_t to compare. - second #hb_segment_properties_t to compare. + second #hb_segment_properties_t to compare. - Creates a hash representing @p. + Creates a hash representing @p. + - A hash of @p. + A hash of @p. - #hb_segment_properties_t to hash. + #hb_segment_properties_t to hash. - The structure that holds various text properties of an #hb_buffer_t. Can be + The structure that holds various text properties of an #hb_buffer_t. Can be set and retrieved using hb_buffer_set_segment_properties() and hb_buffer_get_segment_properties(), respectively. + - the #hb_direction_t of the buffer, see hb_buffer_set_direction(). + the #hb_direction_t of the buffer, see hb_buffer_set_direction(). - the #hb_script_t of the buffer, see hb_buffer_set_script(). + the #hb_script_t of the buffer, see hb_buffer_set_script(). - the #hb_language_t of the buffer, see hb_buffer_set_language(). + the #hb_language_t of the buffer, see hb_buffer_set_language(). @@ -9635,546 +10023,578 @@ hb_buffer_get_segment_properties(), respectively. - Adds @codepoint to @set. + Adds @codepoint to @set. + - A set + A set - The element to add to @set + The element to add to @set - Adds all of the elements from @first to @last + Adds all of the elements from @first to @last (inclusive) to @set. + - A set + A set - The first element to add to @set + The first element to add to @set - The final element to add to @set + The final element to add to @set - Tests whether memory allocation for a set was successful. + Tests whether memory allocation for a set was successful. + - %true if allocation succeeded, false otherwise + %true if allocation succeeded, false otherwise - A set + A set - Clears out the contents of a set. + Clears out the contents of a set. + - A set + A set - Creates a new, initially empty set. + Creates a new, initially empty set. + - The new #hb_set_t + The new #hb_set_t - Removes @codepoint from @set. + Removes @codepoint from @set. + - A set + A set - Removes @codepoint from @set + Removes @codepoint from @set - Removes all of the elements from @first to @last + Removes all of the elements from @first to @last (inclusive) from @set. + - A set + A set - The first element to remove from @set + The first element to remove from @set - The final element to remove from @set + The final element to remove from @set - Decreases the reference count on a set. When + Decreases the reference count on a set. When the reference count reaches zero, the set is destroyed, freeing all memory. + - A set + A set - Fetches the singleton empty #hb_set_t. + Fetches the singleton empty #hb_set_t. + - The empty #hb_set_t + The empty #hb_set_t - Finds the largest element in the set. + Finds the largest element in the set. + - maximum of @set, or %HB_SET_VALUE_INVALID if @set is empty. + maximum of @set, or %HB_SET_VALUE_INVALID if @set is empty. - A set + A set - Finds the smallest element in the set. + Finds the smallest element in the set. + - minimum of @set, or %HB_SET_VALUE_INVALID if @set is empty. + minimum of @set, or %HB_SET_VALUE_INVALID if @set is empty. - A set + A set - Returns the number of elements in the set. + Returns the number of elements in the set. + - The population of @set + The population of @set - A set + A set - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified set. + - A pointer to the user data + A pointer to the user data - A set + A set - The user-data key to query + The user-data key to query - Tests whether @codepoint belongs to @set. + Tests whether @codepoint belongs to @set. + - %true if @codepoint is in @set, false otherwise + %true if @codepoint is in @set, false otherwise - A set + A set - The element to query + The element to query - Makes @set the intersection of @set and @other. + Makes @set the intersection of @set and @other. + - A set + A set - Another set + Another set - Inverts the contents of @set. + Inverts the contents of @set. + - A set + A set - Tests whether a set is empty (contains no elements). + Tests whether a set is empty (contains no elements). + - %true if @set is empty + %true if @set is empty - a set. + a set. - Tests whether @set and @other are equal (contain the same + Tests whether @set and @other are equal (contain the same elements). + - %TRUE if the two sets are equal, %FALSE otherwise. + %TRUE if the two sets are equal, %FALSE otherwise. - A set + A set - Another set + Another set - Tests whether @set is a subset of @larger_set. + Tests whether @set is a subset of @larger_set. + - %TRUE if the @set is a subset of (or equal to) @larger_set, %FALSE otherwise. + %TRUE if the @set is a subset of (or equal to) @larger_set, %FALSE otherwise. - A set + A set - Another set + Another set - Fetches the next element in @set that is greater than current value of @codepoint. + Fetches the next element in @set that is greater than current value of @codepoint. Set @codepoint to %HB_SET_VALUE_INVALID to get started. + - %true if there was a next value, false otherwise + %true if there was a next value, false otherwise - A set + A set - Input = Code point to query + Input = Code point to query Output = Code point retrieved - Fetches the next consecutive range of elements in @set that + Fetches the next consecutive range of elements in @set that are greater than current value of @last. Set @last to %HB_SET_VALUE_INVALID to get started. + - %true if there was a next range, false otherwise + %true if there was a next range, false otherwise - A set + A set - The first code point in the range + The first code point in the range - Input = The current last code point in the range + Input = The current last code point in the range Output = The last code point in the range - Fetches the previous element in @set that is lower than current value of @codepoint. + Fetches the previous element in @set that is lower than current value of @codepoint. Set @codepoint to %HB_SET_VALUE_INVALID to get started. + - %true if there was a previous value, false otherwise + %true if there was a previous value, false otherwise - A set + A set - Input = Code point to query + Input = Code point to query Output = Code point retrieved - Fetches the previous consecutive range of elements in @set that + Fetches the previous consecutive range of elements in @set that are greater than current value of @last. Set @first to %HB_SET_VALUE_INVALID to get started. + - %true if there was a previous range, false otherwise + %true if there was a previous range, false otherwise - A set + A set - Input = The current first code point in the range + Input = The current first code point in the range Output = The first code point in the range - The last code point in the range + The last code point in the range - Increases the reference count on a set. + Increases the reference count on a set. + - The set + The set - A set + A set - Makes the contents of @set equal to the contents of @other. + Makes the contents of @set equal to the contents of @other. + - A set + A set - Another set + Another set - Attaches a user-data key/data pair to the specified set. + Attaches a user-data key/data pair to the specified set. + - %true if success, %false otherwise + %true if success, %false otherwise - A set + A set - The user-data key to set + The user-data key to set - A pointer to the user data to set + A pointer to the user data to set - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Subtracts the contents of @other from @set. + Subtracts the contents of @other from @set. + - A set + A set - Another set + Another set - Makes @set the symmetric difference of @set + Makes @set the symmetric difference of @set and @other. + - A set + A set - Another set + Another set - Data type for holding a set of integers. #hb_set_t's are + Data type for holding a set of integers. #hb_set_t's are used to gather and contain glyph IDs, Unicode code points, and various other collections of discrete values. + - Makes @set the union of @set and @other. + Makes @set the union of @set and @other. + - A set + A set - Another set + Another set - Shapes @buffer using @font turning its Unicode characters content to + Shapes @buffer using @font turning its Unicode characters content to positioned glyphs. If @features is not %NULL, it will be used to control the features applied during shaping. If two @features have the same tag but overlapping ranges the value of the feature with the higher index takes precedence. + - an #hb_font_t to use for shaping + an #hb_font_t to use for shaping - an #hb_buffer_t to shape + an #hb_buffer_t to shape - an array of user + an array of user specified #hb_feature_t or %NULL - the length of @features array + the length of @features array - See hb_shape() for details. If @shaper_list is not %NULL, the specified + See hb_shape() for details. If @shaper_list is not %NULL, the specified shapers will be used in the given order, otherwise the default shapers list will be used. + - false if all shapers failed, true otherwise + false if all shapers failed, true otherwise - an #hb_font_t to use for shaping + an #hb_font_t to use for shaping - an #hb_buffer_t to shape + an #hb_buffer_t to shape - an array of user + an array of user specified #hb_feature_t or %NULL - the length of @features array + the length of @features array - a %NULL-terminated + a %NULL-terminated array of shapers to use or %NULL @@ -10183,9 +10603,10 @@ will be used. - Retrieves the list of shapers supported by HarfBuzz. + Retrieves the list of shapers supported by HarfBuzz. + - an array of + an array of constant strings @@ -10193,33 +10614,34 @@ will be used. - Constructs a shaping plan for a combination of @face, @user_features, @props, + Constructs a shaping plan for a combination of @face, @user_features, @props, and @shaper_list. + - The shaping plan + The shaping plan - #hb_face_t to use + #hb_face_t to use - The #hb_segment_properties_t of the segment + The #hb_segment_properties_t of the segment - The list of user-selected features + The list of user-selected features - The number of user-selected features + The number of user-selected features - List of shapers to try + List of shapers to try @@ -10227,44 +10649,45 @@ and @shaper_list. - The variable-font version of #hb_shape_plan_create. + The variable-font version of #hb_shape_plan_create. Constructs a shaping plan for a combination of @face, @user_features, @props, and @shaper_list, plus the variation-space coordinates @coords. + - The shaping plan + The shaping plan - #hb_face_t to use + #hb_face_t to use - The #hb_segment_properties_t of the segment + The #hb_segment_properties_t of the segment - The list of user-selected features + The list of user-selected features - The number of user-selected features + The number of user-selected features - The list of variation-space coordinates + The list of variation-space coordinates - The number of variation-space coordinates + The number of variation-space coordinates - List of shapers to try + List of shapers to try @@ -10272,33 +10695,34 @@ and @shaper_list, plus the variation-space coordinates @coords. - Creates a cached shaping plan suitable for reuse, for a combination + Creates a cached shaping plan suitable for reuse, for a combination of @face, @user_features, @props, and @shaper_list. + - The shaping plan + The shaping plan - #hb_face_t to use + #hb_face_t to use - The #hb_segment_properties_t of the segment + The #hb_segment_properties_t of the segment - The list of user-selected features + The list of user-selected features - The number of user-selected features + The number of user-selected features - List of shapers to try + List of shapers to try @@ -10306,45 +10730,46 @@ of @face, @user_features, @props, and @shaper_list. - The variable-font version of #hb_shape_plan_create_cached. + The variable-font version of #hb_shape_plan_create_cached. Creates a cached shaping plan suitable for reuse, for a combination of @face, @user_features, @props, and @shaper_list, plus the variation-space coordinates @coords. + - The shaping plan + The shaping plan - #hb_face_t to use + #hb_face_t to use - The #hb_segment_properties_t of the segment + The #hb_segment_properties_t of the segment - The list of user-selected features + The list of user-selected features - The number of user-selected features + The number of user-selected features - The list of variation-space coordinates + The list of variation-space coordinates - The number of variation-space coordinates + The number of variation-space coordinates - List of shapers to try + List of shapers to try @@ -10352,131 +10777,138 @@ variation-space coordinates @coords. - Decreases the reference count on the given shaping plan. When the + Decreases the reference count on the given shaping plan. When the reference count reaches zero, the shaping plan is destroyed, freeing all memory. + - A shaping plan + A shaping plan - Executes the given shaping plan on the specified buffer, using + Executes the given shaping plan on the specified buffer, using the given @font and @features. + - A shaping plan + A shaping plan - The #hb_font_t to use + The #hb_font_t to use - The #hb_buffer_t to work upon + The #hb_buffer_t to work upon - Features to enable + Features to enable - The number of features to enable + The number of features to enable - Fetches the singleton empty shaping plan. + Fetches the singleton empty shaping plan. + - The empty shaping plan + The empty shaping plan - Fetches the shaper from a given shaping plan. + Fetches the shaper from a given shaping plan. + - The shaper + The shaper - A shaping plan + A shaping plan - Fetches the user data associated with the specified key, + Fetches the user data associated with the specified key, attached to the specified shaping plan. + - A pointer to the user data + A pointer to the user data - A shaping plan + A shaping plan - The user-data key to query + The user-data key to query - Increases the reference count on the given shaping plan. + Increases the reference count on the given shaping plan. + - @shape_plan + @shape_plan - A shaping plan + A shaping plan - Attaches a user-data key/data pair to the given shaping plan. + Attaches a user-data key/data pair to the given shaping plan. + - A shaping plan + A shaping plan - The user-data key to set + The user-data key to set - A pointer to the user data + A pointer to the user data - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Data type for holding a shaping plan. + Data type for holding a shaping plan. Shape plans contain information about how HarfBuzz will shape a particular text segment, based on the segment's properties and the @@ -10485,42 +10917,45 @@ capabilities in the font face in use. Shape plans can be queried about how shaping will perform, given a set of specific input parameters (script, language, direction, features, etc.). + - Converts a string into an #hb_tag_t. Valid tags + Converts a string into an #hb_tag_t. Valid tags are four characters. Shorter input strings will be padded with spaces. Longer input strings will be truncated. + - The #hb_tag_t corresponding to @str + The #hb_tag_t corresponding to @str - String to convert + String to convert - Length of @str, or -1 if it is %NULL-terminated + Length of @str, or -1 if it is %NULL-terminated - Converts an #hb_tag_t to a string and returns it in @buf. + Converts an #hb_tag_t to a string and returns it in @buf. Strings will be four characters long. + - #hb_tag_t to convert + #hb_tag_t to convert - Converted string + Converted string @@ -10528,336 +10963,342 @@ Strings will be four characters long. - Retrieves the Canonical Combining Class (ccc) property + Retrieves the Canonical Combining Class (ccc) property of code point @unicode. + - The #hb_unicode_combining_class_t of @unicode + The #hb_unicode_combining_class_t of @unicode - The Unicode-functions structure + The Unicode-functions structure - The code point to query + The code point to query - A virtual method for the #hb_unicode_funcs_t structure. + A virtual method for the #hb_unicode_funcs_t structure. This method should retrieve the Canonical Combining Class (ccc) property for a specified Unicode code point. + - The #hb_unicode_combining_class_t of @unicode + The #hb_unicode_combining_class_t of @unicode - A Unicode-functions structure + A Unicode-functions structure - The code point to query + The code point to query - User data pointer passed by the caller + User data pointer passed by the caller - Data type for the Canonical_Combining_Class (ccc) property + Data type for the Canonical_Combining_Class (ccc) property from the Unicode Character Database. <note>Note: newer versions of Unicode may add new values. Client programs should be ready to handle any value in the 0..254 range being returned from hb_unicode_combining_class().</note> - Spacing and enclosing marks; also many vowel and consonant signs, even if nonspacing + Spacing and enclosing marks; also many vowel and consonant signs, even if nonspacing - Marks which overlay a base letter or symbol + Marks which overlay a base letter or symbol - Diacritic nukta marks in Brahmi-derived scripts + Diacritic nukta marks in Brahmi-derived scripts - Hiragana/Katakana voicing marks + Hiragana/Katakana voicing marks - Viramas + Viramas - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Hebrew] + [Hebrew] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Arabic] + [Arabic] - [Syriac] + [Syriac] - [Telugu] + [Telugu] - [Telugu] + [Telugu] - [Thai] + [Thai] - [Thai] + [Thai] - [Lao] + [Lao] - [Lao] + [Lao] - [Tibetan] + [Tibetan] - [Tibetan] + [Tibetan] - [Tibetan] + [Tibetan] - Marks attached at the bottom left + Marks attached at the bottom left - Marks attached directly below + Marks attached directly below - Marks attached directly above + Marks attached directly above - Marks attached at the top right + Marks attached at the top right - Distinct marks at the bottom left + Distinct marks at the bottom left - Distinct marks directly below + Distinct marks directly below - Distinct marks at the bottom right + Distinct marks at the bottom right - Distinct marks to the left + Distinct marks to the left - Distinct marks to the right + Distinct marks to the right - Distinct marks at the top left + Distinct marks at the top left - Distinct marks directly above + Distinct marks directly above - Distinct marks at the top right + Distinct marks at the top right - Distinct marks subtending two bases + Distinct marks subtending two bases - Distinct marks extending above two bases + Distinct marks extending above two bases - Greek iota subscript only + Greek iota subscript only - Invalid combining class + Invalid combining class - Composes the code point sequence @a,@b by canonical equivalence into + Composes the code point sequence @a,@b by canonical equivalence into code point @ab. + - True is @a,@b composed, false otherwise + True is @a,@b composed, false otherwise - The Unicode-functions structure + The Unicode-functions structure - The first code point to compose + The first code point to compose - The second code point to compose + The second code point to compose - The composed code point + The composed code point - A virtual method for the #hb_unicode_funcs_t structure. + A virtual method for the #hb_unicode_funcs_t structure. This method should compose a sequence of two input Unicode code points by canonical equivalence, returning the composed code point in a #hb_codepoint_t output parameter (if successful). The method must return an #hb_bool_t indicating the success of the composition. + - True is @a,@b composed, false otherwise + True is @a,@b composed, false otherwise - A Unicode-functions structure + A Unicode-functions structure - The first code point to compose + The first code point to compose - The second code point to compose + The second code point to compose - The composed code point + The composed code point - user data pointer passed by the caller + user data pointer passed by the caller - Decomposes code point @ab by canonical equivalence, into code points + Decomposes code point @ab by canonical equivalence, into code points @a and @b. + - True if @ab decomposed, false otherwise + True if @ab decomposed, false otherwise - The Unicode-functions structure + The Unicode-functions structure - The code point to decompose + The code point to decompose - The first decomposed code point + The first decomposed code point - The second decomposed code point + The second decomposed code point - Fetches the compatibility decomposition of a Unicode + Fetches the compatibility decomposition of a Unicode code point. Deprecated. + - The Unicode-functions structure + The Unicode-functions structure - Code point to decompose + Code point to decompose - Compatibility decomposition of @u + Compatibility decomposition of @u - Fully decompose @u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to @decomposed. + Fully decompose @u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to @decomposed. The complete length of the decomposition will be returned. If @u has no compatibility decomposition, zero should be returned. @@ -10865,64 +11306,67 @@ If @u has no compatibility decomposition, zero should be returned. The Unicode standard guarantees that a buffer of length %HB_UNICODE_MAX_DECOMPOSITION_LEN codepoints will always be sufficient for any compatibility decomposition plus an terminating value of 0. Consequently, @decompose must be allocated by the caller to be at least this length. Implementations of this function type must ensure that they do not write past the provided array. + - number of codepoints in the full compatibility decomposition of @u, or 0 if no decomposition available. + number of codepoints in the full compatibility decomposition of @u, or 0 if no decomposition available. - a Unicode function structure + a Unicode function structure - codepoint to decompose + codepoint to decompose - address of codepoint array (of length %HB_UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into + address of codepoint array (of length %HB_UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into - user data pointer as passed to hb_unicode_funcs_set_decompose_compatibility_func() + user data pointer as passed to hb_unicode_funcs_set_decompose_compatibility_func() - A virtual method for the #hb_unicode_funcs_t structure. + A virtual method for the #hb_unicode_funcs_t structure. This method should decompose an input Unicode code point, returning the two decomposed code points in #hb_codepoint_t output parameters (if successful). The method must return an #hb_bool_t indicating the success of the composition. + - True if @ab decomposed, false otherwise + True if @ab decomposed, false otherwise - A Unicode-functions structure + A Unicode-functions structure - The code point to decompose + The code point to decompose - The first decomposed code point + The first decomposed code point - The second decomposed code point + The second decomposed code point - user data pointer passed by the caller + user data pointer passed by the caller + @@ -10936,6 +11380,7 @@ output parameters (if successful). The method must return an + @@ -10952,174 +11397,186 @@ output parameters (if successful). The method must return an - Creates a new #hb_unicode_funcs_t structure of Unicode functions. + Creates a new #hb_unicode_funcs_t structure of Unicode functions. + - The Unicode-functions structure + The Unicode-functions structure - Parent Unicode-functions structure + Parent Unicode-functions structure - Decreases the reference count on a Unicode-functions structure. When + Decreases the reference count on a Unicode-functions structure. When the reference count reaches zero, the Unicode-functions structure is destroyed, freeing all memory. + - The Unicode-functions structure + The Unicode-functions structure - Fetches a pointer to the default Unicode-functions structure that is used + Fetches a pointer to the default Unicode-functions structure that is used when no functions are explicitly set on #hb_buffer_t. + - a pointer to the #hb_unicode_funcs_t Unicode-functions structure + a pointer to the #hb_unicode_funcs_t Unicode-functions structure - Fetches the singleton empty Unicode-functions structure. + Fetches the singleton empty Unicode-functions structure. + - The empty Unicode-functions structure + The empty Unicode-functions structure - Fetches the parent of the Unicode-functions structure + Fetches the parent of the Unicode-functions structure @ufuncs. + - The parent Unicode-functions structure + The parent Unicode-functions structure - The Unicode-functions structure + The Unicode-functions structure - Fetches the user-data associated with the specified key, + Fetches the user-data associated with the specified key, attached to the specified Unicode-functions structure. + - A pointer to the user data + A pointer to the user data - The Unicode-functions structure + The Unicode-functions structure - The user-data key to query + The user-data key to query - Tests whether the specified Unicode-functions structure + Tests whether the specified Unicode-functions structure is immutable. + - %true if @ufuncs is immutable, false otherwise + %true if @ufuncs is immutable, false otherwise - The Unicode-functions structure + The Unicode-functions structure - Makes the specified Unicode-functions structure + Makes the specified Unicode-functions structure immutable. + - The Unicode-functions structure + The Unicode-functions structure - Increases the reference count on a Unicode-functions structure. + Increases the reference count on a Unicode-functions structure. + - The Unicode-functions structure + The Unicode-functions structure - The Unicode-functions structure + The Unicode-functions structure - Sets the implementation function for #hb_unicode_combining_class_func_t. + Sets the implementation function for #hb_unicode_combining_class_func_t. + - A Unicode-functions structure + A Unicode-functions structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_unicode_compose_func_t. + Sets the implementation function for #hb_unicode_compose_func_t. + - A Unicode-functions structure + A Unicode-functions structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore + - a Unicode function structure + a Unicode function structure @@ -11134,36 +11591,38 @@ immutable. - Sets the implementation function for #hb_unicode_decompose_func_t. + Sets the implementation function for #hb_unicode_decompose_func_t. + - A Unicode-functions structure + A Unicode-functions structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore + - a Unicode function structure + a Unicode function structure @@ -11178,108 +11637,112 @@ immutable. - Sets the implementation function for #hb_unicode_general_category_func_t. + Sets the implementation function for #hb_unicode_general_category_func_t. + - A Unicode-functions structure + A Unicode-functions structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_unicode_mirroring_func_t. + Sets the implementation function for #hb_unicode_mirroring_func_t. + - A Unicode-functions structure + A Unicode-functions structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Sets the implementation function for #hb_unicode_script_func_t. + Sets the implementation function for #hb_unicode_script_func_t. + - A Unicode-functions structure + A Unicode-functions structure - The callback function to assign + The callback function to assign - Data to pass to @func + Data to pass to @func - The function to call when @user_data is not needed anymore + The function to call when @user_data is not needed anymore - Attaches a user-data key/data pair to the specified Unicode-functions structure. + Attaches a user-data key/data pair to the specified Unicode-functions structure. + - %true if success, %false otherwise + %true if success, %false otherwise - The Unicode-functions structure + The Unicode-functions structure - The user-data key + The user-data key - A pointer to the user data + A pointer to the user data - A callback to call when @data is not needed anymore + A callback to call when @data is not needed anymore - Whether to replace an existing data with the same key + Whether to replace an existing data with the same key - Data type containing a set of virtual methods used for + Data type containing a set of virtual methods used for accessing various Unicode character properties. HarfBuzz provides a default function for each of the @@ -11287,163 +11750,167 @@ methods in #hb_unicode_funcs_t. Client programs can implement their own replacements for the individual Unicode functions, as needed, and replace the default by calling the setter for a method. + - Retrieves the General Category (gc) property + Retrieves the General Category (gc) property of code point @unicode. + - The #hb_unicode_general_category_t of @unicode + The #hb_unicode_general_category_t of @unicode - The Unicode-functions structure + The Unicode-functions structure - The code point to query + The code point to query - A virtual method for the #hb_unicode_funcs_t structure. + A virtual method for the #hb_unicode_funcs_t structure. This method should retrieve the General Category property for a specified Unicode code point. + - The #hb_unicode_general_category_t of @unicode + The #hb_unicode_general_category_t of @unicode - A Unicode-functions structure + A Unicode-functions structure - The code point to query + The code point to query - User data pointer passed by the caller + User data pointer passed by the caller - Data type for the "General_Category" (gc) property from + Data type for the "General_Category" (gc) property from the Unicode Character Database. - [Cc] + [Cc] - [Cf] + [Cf] - [Cn] + [Cn] - [Co] + [Co] - [Cs] + [Cs] - [Ll] + [Ll] - [Lm] + [Lm] - [Lo] + [Lo] - [Lt] + [Lt] - [Lu] + [Lu] - [Mc] + [Mc] - [Me] + [Me] - [Mn] + [Mn] - [Nd] + [Nd] - [Nl] + [Nl] - [No] + [No] - [Pc] + [Pc] - [Pd] + [Pd] - [Pe] + [Pe] - [Pf] + [Pf] - [Pi] + [Pi] - [Po] + [Po] - [Ps] + [Ps] - [Sc] + [Sc] - [Sk] + [Sk] - [Sm] + [Sm] - [So] + [So] - [Zl] + [Zl] - [Zp] + [Zp] - [Zs] + [Zs] - Retrieves the Bi-directional Mirroring Glyph code + Retrieves the Bi-directional Mirroring Glyph code point defined for code point @unicode. + - The #hb_codepoint_t of the Mirroring Glyph for @unicode + The #hb_codepoint_t of the Mirroring Glyph for @unicode - The Unicode-functions structure + The Unicode-functions structure - The code point to query + The code point to query - A virtual method for the #hb_unicode_funcs_t structure. + A virtual method for the #hb_unicode_funcs_t structure. This method should retrieve the Bi-Directional Mirroring Glyph code point for a specified Unicode code point. @@ -11451,74 +11918,79 @@ code point for a specified Unicode code point. <note>Note: If a code point does not have a specified Bi-Directional Mirroring Glyph defined, the method should return the original code point.</note> + - The #hb_codepoint_t of the Mirroring Glyph for @unicode + The #hb_codepoint_t of the Mirroring Glyph for @unicode - A Unicode-functions structure + A Unicode-functions structure - The code point to query + The code point to query - User data pointer passed by the caller + User data pointer passed by the caller - Retrieves the #hb_script_t script to which code + Retrieves the #hb_script_t script to which code point @unicode belongs. + - The #hb_script_t of @unicode + The #hb_script_t of @unicode - The Unicode-functions structure + The Unicode-functions structure - The code point to query + The code point to query - A virtual method for the #hb_unicode_funcs_t structure. + A virtual method for the #hb_unicode_funcs_t structure. This method should retrieve the Script property for a specified Unicode code point. + - The #hb_script_t of @unicode + The #hb_script_t of @unicode - A Unicode-functions structure + A Unicode-functions structure - The code point to query + The code point to query - User data pointer passed by the caller + User data pointer passed by the caller - Data structure for holding user-data keys. + Data structure for holding user-data keys. + + @@ -11547,6 +12019,7 @@ specified Unicode code point. + @@ -11563,18 +12036,20 @@ specified Unicode code point. - Data type for holding variation data. Registered OpenType + Data type for holding variation data. Registered OpenType variation-axis tags are listed at https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg + - The #hb_tag_t tag of the variation-axis name + The #hb_tag_t tag of the variation-axis name - The value of the variation axis + The value of the variation axis + @@ -11592,6 +12067,7 @@ https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg + @@ -11608,52 +12084,55 @@ https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg - Returns library version as three integer components. + Returns library version as three integer components. + - Library major version component + Library major version component - Library minor version component + Library minor version component - Library micro version component + Library micro version component - Tests the library version against a minimum value, + Tests the library version against a minimum value, as three integer components. + - True if the library is equal to or greater than + True if the library is equal to or greater than the test value, false otherwise - Library major version component + Library major version component - Library minor version component + Library minor version component - Library micro version component + Library micro version component - Returns library version as a string with three components. + Returns library version as a string with three components. + - Library version string + Library version string diff --git a/JavaScriptCore-4.0-patch.gir b/JavaScriptCore-4.0-patch.gir new file mode 100644 index 0000000..176ceb2 --- /dev/null +++ b/JavaScriptCore-4.0-patch.gir @@ -0,0 +1,355 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + return location for a #JSCException, or %NULL to ignore + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/JavaScriptCore-4.0.gir b/JavaScriptCore-4.0.gir index 1751bb5..5abfdf7 100644 --- a/JavaScriptCore-4.0.gir +++ b/JavaScriptCore-4.0.gir @@ -7,76 +7,426 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + return location for a #JSCException, or %NULL to ignore + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - major version (e.g. 1 for version 1.2.5) + major version (e.g. 1 for version 1.2.5) - minor version (e.g. 2 for version 1.2.5) + minor version (e.g. 2 for version 1.2.5) - micro version (e.g. 5 for version 1.2.5) + micro version (e.g. 5 for version 1.2.5) + + + + - Enum values to specify a mode to check for syntax errors in jsc_context_check_syntax(). + Enum values to specify a mode to check for syntax errors in jsc_context_check_syntax(). + - mode to check syntax of a script + mode to check syntax of a script - mode to check syntax of a module + mode to check syntax of a module - Enum values to specify the result of jsc_context_check_syntax(). + Enum values to specify the result of jsc_context_check_syntax(). + - no errors + no errors - recoverable syntax error + recoverable syntax error - irrecoverable syntax error + irrecoverable syntax error - unterminated literal error + unterminated literal error - out of memory error + out of memory error - stack overflow error + stack overflow error + - Add a constructor to @jsc_class. If @name is %NULL, the class name will be used. When <function>new</function> + Add a constructor to @jsc_class. If @name is %NULL, the class name will be used. When <function>new</function> is used with the constructor or jsc_value_constructor_call() is called, @callback is invoked receiving the parameters and @user_data as the last parameter. When the constructor object is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. @@ -86,47 +436,48 @@ jsc_context_set_value() to make the constructor available in the global object. Note that the value returned by @callback is adopted by @jsc_class, and the #GDestroyNotify passed to jsc_context_register_class() is responsible for disposing of it. + - a #JSCValue representing the class constructor. + a #JSCValue representing the class constructor. - a #JSCClass + a #JSCClass - the constructor name or %NULL + the constructor name or %NULL - a #GCallback to be called to create an instance of @jsc_class + a #GCallback to be called to create an instance of @jsc_class - user data to pass to @callback + user data to pass to @callback - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the constructor return value + the #GType of the constructor return value - the number of parameter types to follow or 0 if constructor doesn't receive parameters. + the number of parameter types to follow or 0 if constructor doesn't receive parameters. - a list of #GType<!-- -->s, one for each parameter. + a list of #GType<!-- -->s, one for each parameter. - Add a constructor to @jsc_class. If @name is %NULL, the class name will be used. When <function>new</function> + Add a constructor to @jsc_class. If @name is %NULL, the class name will be used. When <function>new</function> is used with the constructor or jsc_value_constructor_call() is called, @callback is invoked receiving a #GPtrArray of #JSCValue<!-- -->s as arguments and @user_data as the last parameter. When the constructor object is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. @@ -136,39 +487,40 @@ jsc_context_set_value() to make the constructor available in the global object. Note that the value returned by @callback is adopted by @jsc_class, and the #GDestroyNotify passed to jsc_context_register_class() is responsible for disposing of it. + - a #JSCValue representing the class constructor. + a #JSCValue representing the class constructor. - a #JSCClass + a #JSCClass - the constructor name or %NULL + the constructor name or %NULL - a #GCallback to be called to create an instance of @jsc_class - + a #GCallback to be called to create an instance of @jsc_class + - user data to pass to @callback + user data to pass to @callback - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the constructor return value + the #GType of the constructor return value - Add a constructor to @jsc_class. If @name is %NULL, the class name will be used. When <function>new</function> + Add a constructor to @jsc_class. If @name is %NULL, the class name will be used. When <function>new</function> is used with the constructor or jsc_value_constructor_call() is called, @callback is invoked receiving the parameters and @user_data as the last parameter. When the constructor object is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. @@ -178,41 +530,42 @@ jsc_context_set_value() to make the constructor available in the global object. Note that the value returned by @callback is adopted by @jsc_class, and the #GDestroyNotify passed to jsc_context_register_class() is responsible for disposing of it. + - a #JSCValue representing the class constructor. + a #JSCValue representing the class constructor. - a #JSCClass + a #JSCClass - the constructor name or %NULL + the constructor name or %NULL - a #GCallback to be called to create an instance of @jsc_class + a #GCallback to be called to create an instance of @jsc_class - user data to pass to @callback + user data to pass to @callback - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the constructor return value + the #GType of the constructor return value - the number of parameters + the number of parameters - a list of #GType<!-- -->s, one for each parameter, or %NULL + a list of #GType<!-- -->s, one for each parameter, or %NULL @@ -220,7 +573,7 @@ jsc_context_register_class() is responsible for disposing of it. - Add method with @name to @jsc_class. When the method is called by JavaScript or jsc_value_object_invoke_method(), + Add method with @name to @jsc_class. When the method is called by JavaScript or jsc_value_object_invoke_method(), @callback is called receiving the class instance as first parameter, followed by the method parameters and then @user_data as last parameter. When the method is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. @@ -229,46 +582,47 @@ Note that the value returned by @callback must be transfer full. In case of non- %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter. + - a #JSCClass + a #JSCClass - the method name + the method name - a #GCallback to be called to invoke method @name of @jsc_class + a #GCallback to be called to invoke method @name of @jsc_class - user data to pass to @callback + user data to pass to @callback - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the method return value, or %G_TYPE_NONE if the method is void. + the #GType of the method return value, or %G_TYPE_NONE if the method is void. - the number of parameter types to follow or 0 if the method doesn't receive parameters. + the number of parameter types to follow or 0 if the method doesn't receive parameters. - a list of #GType<!-- -->s, one for each parameter. + a list of #GType<!-- -->s, one for each parameter. - Add method with @name to @jsc_class. When the method is called by JavaScript or jsc_value_object_invoke_method(), + Add method with @name to @jsc_class. When the method is called by JavaScript or jsc_value_object_invoke_method(), @callback is called receiving the class instance as first parameter, followed by a #GPtrArray of #JSCValue<!-- -->s with the method arguments and then @user_data as last parameter. When the method is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. @@ -277,38 +631,39 @@ Note that the value returned by @callback must be transfer full. In case of non- %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter. + - a #JSCClass + a #JSCClass - the method name + the method name - a #GCallback to be called to invoke method @name of @jsc_class - + a #GCallback to be called to invoke method @name of @jsc_class + - user data to pass to @callback + user data to pass to @callback - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the method return value, or %G_TYPE_NONE if the method is void. + the #GType of the method return value, or %G_TYPE_NONE if the method is void. - Add method with @name to @jsc_class. When the method is called by JavaScript or jsc_value_object_invoke_method(), + Add method with @name to @jsc_class. When the method is called by JavaScript or jsc_value_object_invoke_method(), @callback is called receiving the class instance as first parameter, followed by the method parameters and then @user_data as last parameter. When the method is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. @@ -317,40 +672,41 @@ Note that the value returned by @callback must be transfer full. In case of non- %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter. + - a #JSCClass + a #JSCClass - the method name + the method name - a #GCallback to be called to invoke method @name of @jsc_class + a #GCallback to be called to invoke method @name of @jsc_class - user data to pass to @callback + user data to pass to @callback - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the method return value, or %G_TYPE_NONE if the method is void. + the #GType of the method return value, or %G_TYPE_NONE if the method is void. - the number of parameter types to follow or 0 if the method doesn't receive parameters. + the number of parameter types to follow or 0 if the method doesn't receive parameters. - a list of #GType<!-- -->s, one for each parameter, or %NULL + a list of #GType<!-- -->s, one for each parameter, or %NULL @@ -358,7 +714,7 @@ with jsc_value_new_object() that receives the copy as the instance parameter. - Add a property with @name to @jsc_class. When the property value needs to be getted, @getter is called + Add a property with @name to @jsc_class. When the property value needs to be getted, @getter is called receiving the the class instance as first parameter and @user_data as last parameter. When the property value needs to be set, @setter is called receiving the the class instance as first parameter, followed by the value to be set and then @user_data as the last parameter. When the property is cleared in the @@ -368,111 +724,118 @@ Note that the value returned by @getter must be transfer full. In case of non-re %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter. + - a #JSCClass + a #JSCClass - the property name + the property name - the #GType of the property value + the #GType of the property value - - a #GCallback to be called to get the property value - + + a #GCallback to be called to get the property value + - a #GCallback to be called to set the property value - + a #GCallback to be called to set the property value + - user data to pass to @getter and @setter + user data to pass to @getter and @setter - destroy notifier for @user_data + destroy notifier for @user_data - - Get the class name of @jsc_class + + Get the class name of @jsc_class + - the name of @jsc_class + the name of @jsc_class - a @JSCClass + a @JSCClass - - Get the parent class of @jsc_class + + Get the parent class of @jsc_class + - the parent class of @jsc_class + the parent class of @jsc_class - a @JSCClass + a @JSCClass - The #JSCContext in which the class was registered. + The #JSCContext in which the class was registered. - - The name of the class. + + The name of the class. - - The parent class or %NULL in case of final classes. + + The parent class or %NULL in case of final classes. - + + + - The type of delete_property in #JSCClassVTable. This is only required when you need to handle + The type of delete_property in #JSCClassVTable. This is only required when you need to handle external properties not added to the prototype. + - %TRUE if handled or %FALSE to to forward the request to the parent class or prototype chain. + %TRUE if handled or %FALSE to to forward the request to the parent class or prototype chain. - a #JSCClass + a #JSCClass - a #JSCContext + a #JSCContext - the @jsc_class instance + the @jsc_class instance - the property name + the property name - The type of enumerate_properties in #JSCClassVTable. This is only required when you need to handle + The type of enumerate_properties in #JSCClassVTable. This is only required when you need to handle external properties not added to the prototype. + - a %NULL-terminated array of strings + a %NULL-terminated array of strings containing the property names, or %NULL if @instance doesn't have enumerable properties. @@ -480,129 +843,134 @@ external properties not added to the prototype. - a #JSCClass + a #JSCClass - a #JSCContext + a #JSCContext - the @jsc_class instance + the @jsc_class instance - The type of get_property in #JSCClassVTable. This is only required when you need to handle + The type of get_property in #JSCClassVTable. This is only required when you need to handle external properties not added to the prototype. + - a #JSCValue or %NULL to forward the request to + a #JSCValue or %NULL to forward the request to the parent class or prototype chain - a #JSCClass + a #JSCClass - a #JSCContext + a #JSCContext - the @jsc_class instance + the @jsc_class instance - the property name + the property name - The type of has_property in #JSCClassVTable. This is only required when you need to handle + The type of has_property in #JSCClassVTable. This is only required when you need to handle external properties not added to the prototype. + - %TRUE if @instance has a property with @name or %FALSE to forward the request + %TRUE if @instance has a property with @name or %FALSE to forward the request to the parent class or prototype chain. - a #JSCClass + a #JSCClass - a #JSCContext + a #JSCContext - the @jsc_class instance + the @jsc_class instance - the property name + the property name - The type of set_property in #JSCClassVTable. This is only required when you need to handle + The type of set_property in #JSCClassVTable. This is only required when you need to handle external properties not added to the prototype. + - %TRUE if handled or %FALSE to forward the request to the parent class or prototype chain. + %TRUE if handled or %FALSE to forward the request to the parent class or prototype chain. - a #JSCClass + a #JSCClass - a #JSCContext + a #JSCContext - the @jsc_class instance + the @jsc_class instance - the property name + the property name - the #JSCValue to set + the #JSCValue to set - Virtual table for a JSCClass. This can be optionally used when registering a #JSCClass in a #JSCContext + Virtual table for a JSCClass. This can be optionally used when registering a #JSCClass in a #JSCContext to provide a custom implementation for the class. All virtual functions are optional and can be set to %NULL to fallback to the default implementation. + - a #JSCClassGetPropertyFunction for getting a property. + a #JSCClassGetPropertyFunction for getting a property. - a #JSCClassSetPropertyFunction for setting a property. + a #JSCClassSetPropertyFunction for setting a property. - a #JSCClassHasPropertyFunction for querying a property. + a #JSCClassHasPropertyFunction for querying a property. - a #JSCClassDeletePropertyFunction for deleting a property. + a #JSCClassDeletePropertyFunction for deleting a property. - a #JSCClassEnumeratePropertiesFunction for enumerating properties. + a #JSCClassEnumeratePropertiesFunction for enumerating properties. + @@ -610,6 +978,7 @@ to provide a custom implementation for the class. All virtual functions are opti + @@ -617,6 +986,7 @@ to provide a custom implementation for the class. All virtual functions are opti + @@ -624,6 +994,7 @@ to provide a custom implementation for the class. All virtual functions are opti + @@ -631,257 +1002,271 @@ to provide a custom implementation for the class. All virtual functions are opti + - Create a new #JSCContext. The context is created in a new #JSCVirtualMachine. + Create a new #JSCContext. The context is created in a new #JSCVirtualMachine. Use jsc_context_new_with_virtual_machine() to create a new #JSCContext in an existing #JSCVirtualMachine. + - the newly created #JSCContext. + the newly created #JSCContext. - Create a new #JSCContext in @virtual_machine. + Create a new #JSCContext in @virtual_machine. + - the newly created #JSCContext. + the newly created #JSCContext. - a #JSCVirtualMachine + a #JSCVirtualMachine - Get the #JSCContext that is currently executing a function. This should only be + Get the #JSCContext that is currently executing a function. This should only be called within a function or method callback, otherwise %NULL will be returned. + - the #JSCContext that is currently executing. + the #JSCContext that is currently executing. - Check the given @code in @context for syntax errors. The @line_number is the starting line number in @uri; + Check the given @code in @context for syntax errors. The @line_number is the starting line number in @uri; the value is one-based so the first line is 1. @uri and @line_number are only used to fill the @exception. In case of errors @exception will be set to a new #JSCException with the details. You can pass %NULL to @exception to ignore the error details. + - a #JSCCheckSyntaxResult + a #JSCCheckSyntaxResult - a #JSCContext + a #JSCContext - a JavaScript script to check + a JavaScript script to check - length of @code, or -1 if @code is a nul-terminated string + length of @code, or -1 if @code is a nul-terminated string - a #JSCCheckSyntaxMode + a #JSCCheckSyntaxMode - the source URI + the source URI - the starting line number + the starting line number - return location for a #JSCException, or %NULL to ignore + return location for a #JSCException, or %NULL to ignore - Clear the uncaught exception in @context if any. + Clear the uncaught exception in @context if any. + - a #JSCContext + a #JSCContext - Evaluate @code in @context. + Evaluate @code in @context. + - a #JSCValue representing the last value generated by the script. + a #JSCValue representing the last value generated by the script. - a #JSCContext + a #JSCContext - a JavaScript script to evaluate + a JavaScript script to evaluate - length of @code, or -1 if @code is a nul-terminated string + length of @code, or -1 if @code is a nul-terminated string - Evaluate @code and create an new object where symbols defined in @code will be added as properties, + Evaluate @code and create an new object where symbols defined in @code will be added as properties, instead of being added to @context global object. The new object is returned as @object parameter. Similar to how jsc_value_new_object() works, if @object_instance is not %NULL @object_class must be provided too. The @line_number is the starting line number in @uri; the value is one-based so the first line is 1. @uri and @line_number will be shown in exceptions and they don't affect the behavior of the script. + - a #JSCValue representing the last value generated by the script. + a #JSCValue representing the last value generated by the script. - a #JSCContext + a #JSCContext - a JavaScript script to evaluate + a JavaScript script to evaluate - length of @code, or -1 if @code is a nul-terminated string + length of @code, or -1 if @code is a nul-terminated string - an object instance + an object instance - a #JSCClass or %NULL to use the default + a #JSCClass or %NULL to use the default - the source URI + the source URI - the starting line number + the starting line number - return location for a #JSCValue. + return location for a #JSCValue. - Evaluate @code in @context using @uri as the source URI. The @line_number is the starting line number + Evaluate @code in @context using @uri as the source URI. The @line_number is the starting line number in @uri; the value is one-based so the first line is 1. @uri and @line_number will be shown in exceptions and they don't affect the behavior of the script. + - a #JSCValue representing the last value generated by the script. + a #JSCValue representing the last value generated by the script. - a #JSCContext + a #JSCContext - a JavaScript script to evaluate + a JavaScript script to evaluate - length of @code, or -1 if @code is a nul-terminated string + length of @code, or -1 if @code is a nul-terminated string - the source URI + the source URI - the starting line number + the starting line number - Get the last unhandled exception thrown in @context by API functions calls. + Get the last unhandled exception thrown in @context by API functions calls. + - a #JSCException or %NULL if there isn't any + a #JSCException or %NULL if there isn't any unhandled exception in the #JSCContext. - a #JSCContext + a #JSCContext - Get a #JSCValue referencing the @context global object + Get a #JSCValue referencing the @context global object + - a #JSCValue + a #JSCValue - a #JSCContext + a #JSCContext - Get a property of @context global object with @name. + Get a property of @context global object with @name. + - a #JSCValue + a #JSCValue - a #JSCContext + a #JSCContext - the value name + the value name - - Get the #JSCVirtualMachine where @context was created. + + Get the #JSCVirtualMachine where @context was created. + - the #JSCVirtualMachine where the #JSCContext was created. + the #JSCVirtualMachine where the #JSCContext was created. - a #JSCContext + a #JSCContext - Remove the last #JSCExceptionHandler previously pushed to @context with + Remove the last #JSCExceptionHandler previously pushed to @context with jsc_context_push_exception_handler(). + - a #JSCContext + a #JSCContext - Push an exception handler in @context. Whenever a JavaScript exception happens in + Push an exception handler in @context. Whenever a JavaScript exception happens in the #JSCContext, the given @handler will be called. The default #JSCExceptionHandler simply calls jsc_context_throw_exception() to throw the exception to the #JSCContext. If you don't want to catch the exception, but only get notified about it, call @@ -889,184 +1274,192 @@ jsc_context_throw_exception() in @handler like the default one does. The last exception handler pushed is the only one used by the #JSCContext, use jsc_context_pop_exception_handler() to remove it and set the previous one. When @handler is removed from the context, @destroy_notify i called with @user_data as parameter. + - a #JSCContext + a #JSCContext - a #JSCExceptionHandler + a #JSCExceptionHandler - user data to pass to @handler + user data to pass to @handler - destroy notifier for @user_data + destroy notifier for @user_data - Register a custom class in @context using the given @name. If the new class inherits from + Register a custom class in @context using the given @name. If the new class inherits from another #JSCClass, the parent should be passed as @parent_class, otherwise %NULL should be used. The optional @vtable parameter allows to provide a custom implementation for handling the class, for example, to handle external properties not added to the prototype. When an instance of the #JSCClass is cleared in the context, @destroy_notify is called with the instance as parameter. + - a #JSCClass + a #JSCClass - a #JSCContext + a #JSCContext - the class name + the class name - a #JSCClass or %NULL + a #JSCClass or %NULL - an optional #JSCClassVTable or %NULL + an optional #JSCClassVTable or %NULL - a destroy notifier for class instances + a destroy notifier for class instances - Set a property of @context global object with @name and @value. + Set a property of @context global object with @name and @value. + - a #JSCContext + a #JSCContext - the value name + the value name - a #JSCValue + a #JSCValue - Throw an exception to @context using the given error message. The created #JSCException + Throw an exception to @context using the given error message. The created #JSCException can be retrieved with jsc_context_get_exception(). + - a #JSCContext + a #JSCContext - an error message + an error message - Throw @exception to @context. + Throw @exception to @context. + - a #JSCContext + a #JSCContext - a #JSCException + a #JSCException - Throw an exception to @context using the given formatted string as error message. + Throw an exception to @context using the given formatted string as error message. The created #JSCException can be retrieved with jsc_context_get_exception(). + - a #JSCContext + a #JSCContext - the string format + the string format - the parameters to insert into the format string + the parameters to insert into the format string - Throw an exception to @context using the given error name and message. The created #JSCException + Throw an exception to @context using the given error name and message. The created #JSCException can be retrieved with jsc_context_get_exception(). + - a #JSCContext + a #JSCContext - the error name + the error name - an error message + an error message - Throw an exception to @context using the given error name and the formatted string as error message. + Throw an exception to @context using the given error name and the formatted string as error message. The created #JSCException can be retrieved with jsc_context_get_exception(). + - a #JSCContext + a #JSCContext - the error name + the error name - the string format + the string format - the parameters to insert into the format string + the parameters to insert into the format string - - The #JSCVirtualMachine in which the context was created. + + The #JSCVirtualMachine in which the context was created. @@ -1077,11 +1470,13 @@ The created #JSCException can be retrieved with jsc_context_get_exception(). + + @@ -1089,6 +1484,7 @@ The created #JSCException can be retrieved with jsc_context_get_exception(). + @@ -1096,6 +1492,7 @@ The created #JSCException can be retrieved with jsc_context_get_exception(). + @@ -1103,275 +1500,297 @@ The created #JSCException can be retrieved with jsc_context_get_exception(). + - + + + + + + + + - Create a new #JSCException in @context with @message. + Create a new #JSCException in @context with @message. + - a new #JSCException. + a new #JSCException. - a #JSCContext + a #JSCContext - the error message + the error message - Create a new #JSCException in @context using a formatted string + Create a new #JSCException in @context using a formatted string for the message. + - a new #JSCException. + a new #JSCException. - a #JSCContext + a #JSCContext - the string format + the string format - the parameters to insert into the format string + the parameters to insert into the format string - Create a new #JSCException in @context using a formatted string + Create a new #JSCException in @context using a formatted string for the message. This is similar to jsc_exception_new_printf() except that the arguments to the format string are passed as a va_list. + - a new #JSCException. + a new #JSCException. - a #JSCContext + a #JSCContext - the string format + the string format - the parameters to insert into the format string + the parameters to insert into the format string - Create a new #JSCException in @context with @name and @message. + Create a new #JSCException in @context with @name and @message. + - a new #JSCException. + a new #JSCException. - a #JSCContext + a #JSCContext - the error name + the error name - the error message + the error message - Create a new #JSCException in @context with @name and using a formatted string + Create a new #JSCException in @context with @name and using a formatted string for the message. + - a new #JSCException. + a new #JSCException. - a #JSCContext + a #JSCContext - the error name + the error name - the string format + the string format - the parameters to insert into the format string + the parameters to insert into the format string - Create a new #JSCException in @context with @name and using a formatted string + Create a new #JSCException in @context with @name and using a formatted string for the message. This is similar to jsc_exception_new_with_name_printf() except that the arguments to the format string are passed as a va_list. + - a new #JSCException. + a new #JSCException. - a #JSCContext + a #JSCContext - the error name + the error name - the string format + the string format - the parameters to insert into the format string + the parameters to insert into the format string - Get a string with the exception backtrace. + Get a string with the exception backtrace. + - the exception backtrace string or %NULL. + the exception backtrace string or %NULL. - a #JSCException + a #JSCException - Get the column number at which @exception happened. + Get the column number at which @exception happened. + - the column number of @exception. + the column number of @exception. - a #JSCException + a #JSCException - Get the line number at which @exception happened. + Get the line number at which @exception happened. + - the line number of @exception. + the line number of @exception. - a #JSCException + a #JSCException - Get the error message of @exception. + Get the error message of @exception. + - the @exception error message. + the @exception error message. - a #JSCException + a #JSCException - Get the error name of @exception + Get the error name of @exception + - the @exception error name. + the @exception error name. - a #JSCException + a #JSCException - Get the source URI of @exception. + Get the source URI of @exception. + - the the source URI of @exception, or %NULL. + the the source URI of @exception, or %NULL. - a #JSCException + a #JSCException - Return a report message of @exception, containing all the possible details such us + Return a report message of @exception, containing all the possible details such us source URI, line, column and backtrace, and formatted to be printed. + - a new string with the exception report + a new string with the exception report - a #JSCException + a #JSCException - Get the string representation of @exception error. + Get the string representation of @exception error. + - the string representation of @exception. + the string representation of @exception. - a #JSCException + a #JSCException @@ -1384,11 +1803,13 @@ source URI, line, column and backtrace, and formatted to be printed. + + @@ -1396,6 +1817,7 @@ source URI, line, column and backtrace, and formatted to be printed. + @@ -1403,6 +1825,7 @@ source URI, line, column and backtrace, and formatted to be printed. + @@ -1410,6 +1833,7 @@ source URI, line, column and backtrace, and formatted to be printed. + @@ -1417,101 +1841,115 @@ source URI, line, column and backtrace, and formatted to be printed. - Function used to handle JavaScript exceptions in a #JSCContext. + Function used to handle JavaScript exceptions in a #JSCContext. + - a #JSCContext + a #JSCContext - a #JSCException + a #JSCException - user data + user data - + + + + + + + + + + + + + + - A JSSClass represents a custom JavaScript class registered by the user in a #JSCContext. + A JSSClass represents a custom JavaScript class registered by the user in a #JSCContext. It allows to create new JavaScripts objects whose instances are created by the user using this API. It's possible to add constructors, properties and methods for a JSSClass by providing #GCallback<!-- -->s to implement them. - JSCContext represents a JavaScript execution context, where all operations + JSCContext represents a JavaScript execution context, where all operations take place and where the values will be associated. When a new context is created, a global object is allocated and the built-in JavaScript @@ -1520,10 +1958,10 @@ the context by using jsc_context_evaluate() or jsc_context_evaluate_with_source_ It's also possible to register custom objects in the context with jsc_context_register_class(). - JSCException represents a JavaScript exception. + JSCException represents a JavaScript exception. - JavaScript options allow changing the behavior of the JavaScript engine. + JavaScript options allow changing the behavior of the JavaScript engine. They affect the way the engine works, so the options must be set at the very beginning of the program execution, before any other JavaScript API call. Most of the options are only useful for testing and debugging. @@ -1537,11 +1975,11 @@ command line arguments, you can easily integrate the JSCOptions by adding the #GOptionGroup returned by jsc_options_get_option_group(). - JSCValue represents a reference to a value in a #JSCContext. The JSCValue + JSCValue represents a reference to a value in a #JSCContext. The JSCValue protects the referenced value from being garbage collected. - Provides convenience functions returning JavaScriptCore's major, minor and + Provides convenience functions returning JavaScriptCore's major, minor and micro versions of the JavaScriptCore library your code is running against. This is not necessarily the same as the #JSC_MAJOR_VERSION, #JSC_MINOR_VERSION or @@ -1549,7 +1987,7 @@ against. This is not necessarily the same as the headers included when compiling the code. - JSCVirtualMachine represents a group of JSCContext<!-- -->s. It allows + JSCVirtualMachine represents a group of JSCContext<!-- -->s. It allows concurrent JavaScript execution by creating a different instance of JSCVirtualMachine in each thread. @@ -1557,177 +1995,195 @@ To create a group of JSCContext<!-- -->s pass the same JSCVirtualMachine instance to every JSCContext constructor. - JSCWeakValue represents a weak reference to a value in a #JSCContext. It can be used + JSCWeakValue represents a weak reference to a value in a #JSCContext. It can be used to keep a reference to a JavaScript value without protecting it from being garbage collected and without referencing the #JSCContext either. - Like jsc_get_major_version(), but from the headers used at + Like jsc_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + - - Like jsc_get_micro_version(), but from the headers used at + + Like jsc_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + - - Like jsc_get_minor_version(), but from the headers used at + + Like jsc_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + - Allows the DFG JIT to be used if %TRUE. + Allows the DFG JIT to be used if %TRUE. Option type: %JSC_OPTION_BOOLEAN Default value: %TRUE. + - Allows the FTL JIT to be used if %TRUE. + Allows the FTL JIT to be used if %TRUE. Option type: %JSC_OPTION_BOOLEAN Default value: %TRUE. + - Allows the executable pages to be allocated for JIT and thunks if %TRUE. + Allows the executable pages to be allocated for JIT and thunks if %TRUE. Option type: %JSC_OPTION_BOOLEAN Default value: %TRUE. + - Allows the LLINT to be used if %TRUE. + Allows the LLINT to be used if %TRUE. Option type: %JSC_OPTION_BOOLEAN Default value: %TRUE. + - Enum values for options types. + Enum values for options types. + - A #gboolean option type. + A #gboolean option type. - A #gint option type. + A #gint option type. - A #guint option type. + A #guint option type. - A #gsize options type. + A #gsize options type. - A #gdouble options type. + A #gdouble options type. - A string option type. + A string option type. - A range string option type. + A range string option type. - Function used to iterate options. + Function used to iterate options. Not that @description string is not localized. + - %TRUE to stop the iteration, or %FALSE otherwise + %TRUE to stop the iteration, or %FALSE otherwise - the option name + the option name - the option #JSCOptionType + the option #JSCOptionType - the option description, or %NULL + the option description, or %NULL - user data + user data + + + + + + + - Create a new #JSCValue referencing an array with the given items. If @first_item_type + Create a new #JSCValue referencing an array with the given items. If @first_item_type is %G_TYPE_NONE an empty array is created. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - #GType of first item, or %G_TYPE_NONE + #GType of first item, or %G_TYPE_NONE - value of the first item, followed optionally by more type/value pairs, followed by %G_TYPE_NONE. + value of the first item, followed optionally by more type/value pairs, followed by %G_TYPE_NONE. - Create a new #JSCValue referencing an array with the items from @array. If @array + Create a new #JSCValue referencing an array with the items from @array. If @array is %NULL or empty a new empty array will be created. Elements of @array should be pointers to a #JSCValue. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - a #GPtrArray + a #GPtrArray @@ -1735,19 +2191,20 @@ pointers to a #JSCValue. - Create a new #JSCValue referencing an array of strings with the items from @strv. If @array + Create a new #JSCValue referencing an array of strings with the items from @strv. If @array is %NULL or empty a new empty array will be created. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - a %NULL-terminated array of strings + a %NULL-terminated array of strings @@ -1755,41 +2212,43 @@ is %NULL or empty a new empty array will be created. - Create a new #JSCValue from @value + Create a new #JSCValue from @value + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - a #gboolean + a #gboolean - Create a new #JSCValue referencing a new value created by parsing @json. + Create a new #JSCValue referencing a new value created by parsing @json. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - the JSON string to be parsed + the JSON string to be parsed - Create a function in @context. If @name is %NULL an anonymous function will be created. + Create a function in @context. If @name is %NULL an anonymous function will be created. When the function is called by JavaScript or jsc_value_function_call(), @callback is called receiving the function parameters and then @user_data as last parameter. When the function is cleared in @context, @destroy_notify is called with @user_data as parameter. @@ -1798,47 +2257,48 @@ Note that the value returned by @callback must be fully transferred. In case of %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as instance parameter. + - a #JSCValue. + a #JSCValue. - a #JSCContext: + a #JSCContext: - the function name or %NULL + the function name or %NULL - a #GCallback. + a #GCallback. - user data to pass to @callback. + user data to pass to @callback. - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the function return value, or %G_TYPE_NONE if the function is void. + the #GType of the function return value, or %G_TYPE_NONE if the function is void. - the number of parameter types to follow or 0 if the function doesn't receive parameters. + the number of parameter types to follow or 0 if the function doesn't receive parameters. - a list of #GType<!-- -->s, one for each parameter. + a list of #GType<!-- -->s, one for each parameter. - Create a function in @context. If @name is %NULL an anonymous function will be created. + Create a function in @context. If @name is %NULL an anonymous function will be created. When the function is called by JavaScript or jsc_value_function_call(), @callback is called receiving an #GPtrArray of #JSCValue<!-- -->s with the arguments and then @user_data as last parameter. When the function is cleared in @context, @destroy_notify is called with @user_data as parameter. @@ -1847,39 +2307,40 @@ Note that the value returned by @callback must be fully transferred. In case of %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as instance parameter. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - the function name or %NULL + the function name or %NULL - a #GCallback. - + a #GCallback. + - user data to pass to @callback. + user data to pass to @callback. - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the function return value, or %G_TYPE_NONE if the function is void. + the #GType of the function return value, or %G_TYPE_NONE if the function is void. - Create a function in @context. If @name is %NULL an anonymous function will be created. + Create a function in @context. If @name is %NULL an anonymous function will be created. When the function is called by JavaScript or jsc_value_function_call(), @callback is called receiving the function parameters and then @user_data as last parameter. When the function is cleared in @context, @destroy_notify is called with @user_data as parameter. @@ -1888,41 +2349,42 @@ Note that the value returned by @callback must be fully transferred. In case of %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as instance parameter. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - the function name or %NULL + the function name or %NULL - a #GCallback. + a #GCallback. - user data to pass to @callback. + user data to pass to @callback. - destroy notifier for @user_data + destroy notifier for @user_data - the #GType of the function return value, or %G_TYPE_NONE if the function is void. + the #GType of the function return value, or %G_TYPE_NONE if the function is void. - the number of parameters + the number of parameters - a list of #GType<!-- -->s, one for each parameter, or %NULL + a list of #GType<!-- -->s, one for each parameter, or %NULL @@ -1930,146 +2392,154 @@ with jsc_value_new_object() that receives the copy as instance parameter. - Create a new #JSCValue referencing <function>null</function> in @context. + Create a new #JSCValue referencing <function>null</function> in @context. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - Create a new #JSCValue from @number. + Create a new #JSCValue from @number. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - a number + a number - Create a new #JSCValue from @instance. If @instance is %NULL a new empty object is created. + Create a new #JSCValue from @instance. If @instance is %NULL a new empty object is created. When @instance is provided, @jsc_class must be provided too. @jsc_class takes ownership of @instance that will be freed by the #GDestroyNotify passed to jsc_context_register_class(). + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - an object instance or %NULL + an object instance or %NULL - the #JSCClass of @instance + the #JSCClass of @instance - Create a new #JSCValue from @string. If you need to create a #JSCValue from a + Create a new #JSCValue from @string. If you need to create a #JSCValue from a string containing null characters, use jsc_value_new_string_from_bytes() instead. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - a null-terminated string + a null-terminated string - Create a new #JSCValue from @bytes. + Create a new #JSCValue from @bytes. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - a #GBytes + a #GBytes - Create a new #JSCValue referencing <function>undefined</function> in @context. + Create a new #JSCValue referencing <function>undefined</function> in @context. + - a #JSCValue. + a #JSCValue. - a #JSCContext + a #JSCContext - Invoke <function>new</function> with constructor referenced by @value. If @first_parameter_type + Invoke <function>new</function> with constructor referenced by @value. If @first_parameter_type is %G_TYPE_NONE no parameters will be passed to the constructor. + - a #JSCValue referencing the newly created object instance. + a #JSCValue referencing the newly created object instance. - a #JSCValue + a #JSCValue - #GType of first parameter, or %G_TYPE_NONE + #GType of first parameter, or %G_TYPE_NONE - value of the first parameter, followed optionally by more type/value pairs, followed by %G_TYPE_NONE + value of the first parameter, followed optionally by more type/value pairs, followed by %G_TYPE_NONE - Invoke <function>new</function> with constructor referenced by @value. If @n_parameters + Invoke <function>new</function> with constructor referenced by @value. If @n_parameters is 0 no parameters will be passed to the constructor. + - a #JSCValue referencing the newly created object instance. + a #JSCValue referencing the newly created object instance. - a #JSCValue + a #JSCValue - the number of parameters + the number of parameters - the #JSCValue<!-- -->s to pass as parameters to the constructor, or %NULL + the #JSCValue<!-- -->s to pass as parameters to the constructor, or %NULL @@ -2077,189 +2547,201 @@ is 0 no parameters will be passed to the constructor. - Call function referenced by @value, passing the given parameters. If @first_parameter_type + Call function referenced by @value, passing the given parameters. If @first_parameter_type is %G_TYPE_NONE no parameters will be passed to the function. This function always returns a #JSCValue, in case of void functions a #JSCValue referencing <function>undefined</function> is returned + - a #JSCValue with the return value of the function. + a #JSCValue with the return value of the function. - a #JSCValue + a #JSCValue - #GType of first parameter, or %G_TYPE_NONE + #GType of first parameter, or %G_TYPE_NONE - value of the first parameter, followed optionally by more type/value pairs, followed by %G_TYPE_NONE + value of the first parameter, followed optionally by more type/value pairs, followed by %G_TYPE_NONE - Call function referenced by @value, passing the given @parameters. If @n_parameters + Call function referenced by @value, passing the given @parameters. If @n_parameters is 0 no parameters will be passed to the function. This function always returns a #JSCValue, in case of void functions a #JSCValue referencing <function>undefined</function> is returned + - a #JSCValue with the return value of the function. + a #JSCValue with the return value of the function. - a #JSCValue + a #JSCValue - the number of parameters + the number of parameters - the #JSCValue<!-- -->s to pass as parameters to the function, or %NULL + the #JSCValue<!-- -->s to pass as parameters to the function, or %NULL - - Get the #JSCContext in which @value was created. + + Get the #JSCContext in which @value was created. + - the #JSCValue context. + the #JSCValue context. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is an array. + Get whether the value referenced by @value is an array. + - whether the value is an array. + whether the value is an array. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is a boolean. + Get whether the value referenced by @value is a boolean. + - whether the value is a boolean. + whether the value is a boolean. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is a constructor. + Get whether the value referenced by @value is a constructor. + - whether the value is a constructor. + whether the value is a constructor. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is a function + Get whether the value referenced by @value is a function + - whether the value is a function. + whether the value is a function. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is <function>null</function>. + Get whether the value referenced by @value is <function>null</function>. + - whether the value is null. + whether the value is null. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is a number. + Get whether the value referenced by @value is a number. + - whether the value is a number. + whether the value is a number. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is an object. + Get whether the value referenced by @value is an object. + - whether the value is an object. + whether the value is an object. - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is a string + Get whether the value referenced by @value is a string + - whether the value is a string + whether the value is a string - a #JSCValue + a #JSCValue - Get whether the value referenced by @value is <function>undefined</function>. + Get whether the value referenced by @value is <function>undefined</function>. + - whether the value is undefined. + whether the value is undefined. - a #JSCValue + a #JSCValue - Define or modify a property with @property_name in object referenced by @value. When the + Define or modify a property with @property_name in object referenced by @value. When the property value needs to be getted or set, @getter and @setter callbacks will be called. When the property is cleared in the #JSCClass context, @destroy_notify is called with @user_data as parameter. This is equivalent to JavaScript <function>Object.defineProperty()</function> @@ -2269,92 +2751,96 @@ Note that the value returned by @getter must be fully transferred. In case of bo %G_TYPE_POINTER instead of the actual boxed #GType to ensure that the instance owned by #JSCClass is used. If you really want to return a new copy of the boxed type, use #JSC_TYPE_VALUE and return a #JSCValue created with jsc_value_new_object() that receives the copy as instance parameter. + - a #JSCValue + a #JSCValue - the name of the property to define + the name of the property to define - #JSCValuePropertyFlags + #JSCValuePropertyFlags - the #GType of the property + the #GType of the property - - a #GCallback to be called to get the property value - + + a #GCallback to be called to get the property value + - a #GCallback to be called to set the property value - + a #GCallback to be called to set the property value + - user data to pass to @getter and @setter + user data to pass to @getter and @setter - destroy notifier for @user_data + destroy notifier for @user_data - Define or modify a property with @property_name in object referenced by @value. This is equivalent to + Define or modify a property with @property_name in object referenced by @value. This is equivalent to JavaScript <function>Object.defineProperty()</function> when used with a data descriptor. + - a #JSCValue + a #JSCValue - the name of the property to define + the name of the property to define - #JSCValuePropertyFlags + #JSCValuePropertyFlags - the default property value + the default property value - Try to delete property with @name from @value. This function will return %FALSE if + Try to delete property with @name from @value. This function will return %FALSE if the property was defined without %JSC_VALUE_PROPERTY_CONFIGURABLE flag. + - %TRUE if the property was deleted, or %FALSE otherwise. + %TRUE if the property was deleted, or %FALSE otherwise. - a #JSCValue + a #JSCValue - the property name + the property name - Get the list of property names of @value. Only properties defined with %JSC_VALUE_PROPERTY_ENUMERABLE + Get the list of property names of @value. Only properties defined with %JSC_VALUE_PROPERTY_ENUMERABLE flag will be collected. + - a %NULL-terminated array of strings containing the + a %NULL-terminated array of strings containing the property names, or %NULL if @value doesn't have enumerable properties. Use g_strfreev() to free. @@ -2362,64 +2848,67 @@ flag will be collected. - a #JSCValue + a #JSCValue - Get property with @name from @value. + Get property with @name from @value. + - the property #JSCValue. + the property #JSCValue. - a #JSCValue + a #JSCValue - the property name + the property name - Get property at @index from @value. + Get property at @index from @value. + - the property #JSCValue. + the property #JSCValue. - a #JSCValue + a #JSCValue - the property index + the property index - Get whether @value has property with @name. + Get whether @value has property with @name. + - %TRUE if @value has a property with @name, or %FALSE otherwise + %TRUE if @value has a property with @name, or %FALSE otherwise - a #JSCValue + a #JSCValue - the property name + the property name - Invoke method with @name on object referenced by @value, passing the given parameters. If + Invoke method with @name on object referenced by @value, passing the given parameters. If @first_parameter_type is %G_TYPE_NONE no parameters will be passed to the method. The object instance will be handled automatically even when the method is a custom one registered with jsc_class_add_method(), so it should never be passed explicitly as parameter @@ -2427,31 +2916,32 @@ of this function. This function always returns a #JSCValue, in case of void methods a #JSCValue referencing <function>undefined</function> is returned. + - a #JSCValue with the return value of the method. + a #JSCValue with the return value of the method. - a #JSCValue + a #JSCValue - the method name + the method name - #GType of first parameter, or %G_TYPE_NONE + #GType of first parameter, or %G_TYPE_NONE - value of the first parameter, followed optionally by more type/value pairs, followed by %G_TYPE_NONE + value of the first parameter, followed optionally by more type/value pairs, followed by %G_TYPE_NONE - Invoke method with @name on object referenced by @value, passing the given @parameters. If + Invoke method with @name on object referenced by @value, passing the given @parameters. If @n_parameters is 0 no parameters will be passed to the method. The object instance will be handled automatically even when the method is a custom one registered with jsc_class_add_method(), so it should never be passed explicitly as parameter @@ -2459,25 +2949,26 @@ of this function. This function always returns a #JSCValue, in case of void methods a #JSCValue referencing <function>undefined</function> is returned. + - a #JSCValue with the return value of the method. + a #JSCValue with the return value of the method. - a #JSCValue + a #JSCValue - the method name + the method name - the number of parameters + the number of parameters - the #JSCValue<!-- -->s to pass as parameters to the method, or %NULL + the #JSCValue<!-- -->s to pass as parameters to the method, or %NULL @@ -2485,149 +2976,158 @@ This function always returns a #JSCValue, in case of void methods a #JSCValue re - Get whether the value referenced by @value is an instance of class @name. + Get whether the value referenced by @value is an instance of class @name. + - whether the value is an object instance of class @name. + whether the value is an object instance of class @name. - a #JSCValue + a #JSCValue - a class name + a class name - Set @property with @name on @value. + Set @property with @name on @value. + - a #JSCValue + a #JSCValue - the property name + the property name - the #JSCValue to set + the #JSCValue to set - Set @property at @index on @value. + Set @property at @index on @value. + - a #JSCValue + a #JSCValue - the property index + the property index - the #JSCValue to set + the #JSCValue to set - Convert @value to a boolean. + Convert @value to a boolean. + - a #gboolean result of the conversion. + a #gboolean result of the conversion. - a #JSCValue + a #JSCValue - Convert @value to a double. + Convert @value to a double. + - a #gdouble result of the conversion. + a #gdouble result of the conversion. - a #JSCValue + a #JSCValue - Convert @value to a #gint32. + Convert @value to a #gint32. + - a #gint32 result of the conversion. + a #gint32 result of the conversion. - a #JSCValue + a #JSCValue - Create a JSON string of @value serialization. If @indent is 0, the resulting JSON will + Create a JSON string of @value serialization. If @indent is 0, the resulting JSON will not contain newlines. The size of the indent is clamped to 10 spaces. + - a null-terminated JSON string with serialization of @value + a null-terminated JSON string with serialization of @value - a #JSCValue + a #JSCValue - The number of spaces to indent when nesting. + The number of spaces to indent when nesting. - Convert @value to a string. Use jsc_value_to_string_as_bytes() instead, if you need to + Convert @value to a string. Use jsc_value_to_string_as_bytes() instead, if you need to handle strings containing null characters. + - a null-terminated string result of the conversion. + a null-terminated string result of the conversion. - a #JSCValue + a #JSCValue - Convert @value to a string and return the results as #GBytes. This is needed + Convert @value to a string and return the results as #GBytes. This is needed to handle strings with null characters. + - a #GBytes with the result of the conversion. + a #GBytes with the result of the conversion. - a #JSCValue + a #JSCValue - - The #JSCContext in which the value was created. + + The #JSCContext in which the value was created. @@ -2638,11 +3138,13 @@ to handle strings with null characters. + + @@ -2650,6 +3152,7 @@ to handle strings with null characters. + @@ -2657,6 +3160,7 @@ to handle strings with null characters. + @@ -2664,34 +3168,40 @@ to handle strings with null characters. + - + + + - Flags used when defining properties with jsc_value_object_define_property_data() and + Flags used when defining properties with jsc_value_object_define_property_data() and jsc_value_object_define_property_accessor(). + - the type of the property descriptor may be changed and the + the type of the property descriptor may be changed and the property may be deleted from the corresponding object. - the property shows up during enumeration of the properties on + the property shows up during enumeration of the properties on the corresponding object. - the value associated with the property may be changed with an + the value associated with the property may be changed with an assignment operator. This doesn't have any effect when passed to jsc_value_object_define_property_accessor(). + - Create a new #JSCVirtualMachine. + Create a new #JSCVirtualMachine. + - the newly created #JSCVirtualMachine. + the newly created #JSCVirtualMachine. @@ -2703,11 +3213,13 @@ jsc_value_object_define_property_accessor(). + + @@ -2715,6 +3227,7 @@ jsc_value_object_define_property_accessor(). + @@ -2722,6 +3235,7 @@ jsc_value_object_define_property_accessor(). + @@ -2729,60 +3243,69 @@ jsc_value_object_define_property_accessor(). + - + + + + + + + - Create a new #JSCWeakValue for the JavaScript value referenced by @value. + Create a new #JSCWeakValue for the JavaScript value referenced by @value. + - a new #JSCWeakValue + a new #JSCWeakValue - a #JSCValue + a #JSCValue - Get a #JSCValue referencing the JavaScript value of @weak_value. + Get a #JSCValue referencing the JavaScript value of @weak_value. + - a new #JSCValue or %NULL if @weak_value was cleared. + a new #JSCValue or %NULL if @weak_value was cleared. - a #JSCWeakValue + a #JSCWeakValue - The #JSCValue referencing the JavaScript value. + The #JSCValue referencing the JavaScript value. @@ -2792,18 +3315,20 @@ jsc_value_object_define_property_accessor(). - This signal is emitted when the JavaScript value is destroyed. + This signal is emitted when the JavaScript value is destroyed. + + @@ -2811,6 +3336,7 @@ jsc_value_object_define_property_accessor(). + @@ -2818,6 +3344,7 @@ jsc_value_object_define_property_accessor(). + @@ -2825,322 +3352,344 @@ jsc_value_object_define_property_accessor(). + - + + + - Returns the major version number of the JavaScriptCore library. + Returns the major version number of the JavaScriptCore library. (e.g. in JavaScriptCore version 1.8.3 this is 1.) This function is in the library, so it represents the JavaScriptCore library your code is running against. Contrast with the #JSC_MAJOR_VERSION macro, which represents the major version of the JavaScriptCore headers you have included when compiling your code. + - the major version number of the JavaScriptCore library + the major version number of the JavaScriptCore library - Returns the micro version number of the JavaScriptCore library. + Returns the micro version number of the JavaScriptCore library. (e.g. in JavaScriptCore version 1.8.3 this is 3.) This function is in the library, so it represents the JavaScriptCore library your code is running against. Contrast with the #JSC_MICRO_VERSION macro, which represents the micro version of the JavaScriptCore headers you have included when compiling your code. + - the micro version number of the JavaScriptCore library + the micro version number of the JavaScriptCore library - Returns the minor version number of the JavaScriptCore library. + Returns the minor version number of the JavaScriptCore library. (e.g. in JavaScriptCore version 1.8.3 this is 8.) This function is in the library, so it represents the JavaScriptCore library your code is running against. Contrast with the #JSC_MINOR_VERSION macro, which represents the minor version of the JavaScriptCore headers you have included when compiling your code. + - the minor version number of the JavaScriptCore library + the minor version number of the JavaScriptCore library - Iterates all available options calling @function for each one. Iteration can + Iterates all available options calling @function for each one. Iteration can stop early if @function returns %FALSE. + - a #JSCOptionsFunc callback + a #JSCOptionsFunc callback - callback user data + callback user data - Get @option as a #gboolean value. + Get @option as a #gboolean value. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Get @option as a #gdouble value. + Get @option as a #gdouble value. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Get @option as a #gint value. + Get @option as a #gint value. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Create a #GOptionGroup to handle JSCOptions as command line arguments. + Create a #GOptionGroup to handle JSCOptions as command line arguments. The options will be exposed as command line arguments with the form <emphasis>--jsc-&lt;option&gt;=&lt;value&gt;</emphasis>. Each entry in the returned #GOptionGroup is configured to apply the corresponding option during command line parsing. Applications only need to pass the returned group to g_option_context_add_group(), and the rest will be taken care for automatically. + - a #GOptionGroup for the JSCOptions + a #GOptionGroup for the JSCOptions - Get @option as a range string. The string must be in the + Get @option as a range string. The string must be in the format <emphasis>[!]&lt;low&gt;[:&lt;high&gt;]</emphasis> where low and high are #guint values. Values between low and high (both included) will be considered in the range, unless <emphasis>!</emphasis> is used to invert the range. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Get @option as a #gsize value. + Get @option as a #gsize value. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Get @option as a string. + Get @option as a string. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Get @option as a #guint value. + Get @option as a #guint value. + - %TRUE if @value has been set or %FALSE if the option doesn't exist + %TRUE if @value has been set or %FALSE if the option doesn't exist - the option identifier + the option identifier - return location for the option value + return location for the option value - Set @option as a #gboolean value. + Set @option as a #gboolean value. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set - Set @option as a #gdouble value. + Set @option as a #gdouble value. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set - Set @option as a #gint value. + Set @option as a #gint value. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set - Set @option as a range string. The string must be in the + Set @option as a range string. The string must be in the format <emphasis>[!]&lt;low&gt;[:&lt;high&gt;]</emphasis> where low and high are #guint values. Values between low and high (both included) will be considered in the range, unless <emphasis>!</emphasis> is used to invert the range. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set - Set @option as a #gsize value. + Set @option as a #gsize value. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set - Set @option as a string. + Set @option as a string. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set - Set @option as a #guint value. + Set @option as a #guint value. + - %TRUE if option was correctly set or %FALSE otherwise. + %TRUE if option was correctly set or %FALSE otherwise. - the option identifier + the option identifier - the value to set + the value to set diff --git a/JavaScriptCore-4.0.xsl b/JavaScriptCore-4.0.xsl new file mode 100644 index 0000000..5f02d12 --- /dev/null +++ b/JavaScriptCore-4.0.xsl @@ -0,0 +1,84 @@ + + + + + + + + + + + + + + + + + Constructor + JSCConstructor + + + + + ClassVariadicFunction + JSCClassVariadicFunction + + + + + + notified + 4 + 5 + + + + + + + + + PropertySetter + JSCPropertySetter + + + + + + + VariadicFunction + JSCVariadicFunction + + + + + + notified + 5 + 6 + + + + + + + + + Setter + JSCSetter + + + + + + + + + + + diff --git a/Pango-1.0.gir b/Pango-1.0.gir index c3c775a..d9d7a16 100644 --- a/Pango-1.0.gir +++ b/Pango-1.0.gir @@ -10,11 +10,12 @@ and/or use gtk-doc annotations. --> - A `PangoGlyph` represents a single glyph in the output form of a string. + A `PangoGlyph` represents a single glyph in the output form of a string. + - The `PangoGlyphUnit` type is used to store dimensions within + The `PangoGlyphUnit` type is used to store dimensions within Pango. Dimensions are stored in 1/%PANGO_SCALE of a device unit. @@ -23,122 +24,133 @@ a point on a printer.) %PANGO_SCALE is currently 1024, and may change in the future (unlikely though), but you should not depend on its exact value. The PANGO_PIXELS() macro can be used to convert from glyph units into device units with correct rounding. + - A `PangoLayoutRun` represents a single run within a `PangoLayoutLine`. + A `PangoLayoutRun` represents a single run within a `PangoLayoutLine`. It is simply an alternate name for [struct@Pango.GlyphItem]. See the [struct@Pango.GlyphItem] docs for details on the fields. + - Whether the segment should be shifted to center around the baseline. + Whether the segment should be shifted to center around the baseline. This is mainly used in vertical writing directions. + - Whether this run holds ellipsized text. + Whether this run holds ellipsized text. + - Whether to add a hyphen at the end of the run during shaping. + Whether to add a hyphen at the end of the run during shaping. + - Extracts the *ascent* from a `PangoRectangle` + Extracts the *ascent* from a `PangoRectangle` representing glyph extents. The ascent is the distance from the baseline to the highest point of the character. This is positive if the glyph ascends above the baseline. + - a `PangoRectangle` + a `PangoRectangle` - Value for @start_index in `PangoAttribute` that indicates + Value for @start_index in `PangoAttribute` that indicates the beginning of the text. + - Value for @end_index in `PangoAttribute` that indicates + Value for @end_index in `PangoAttribute` that indicates the end of the text. + - `PangoAlignment` describes how to align the lines of a `PangoLayout` + `PangoAlignment` describes how to align the lines of a `PangoLayout` within the available space. If the `PangoLayout` is set to justify using [method@Pango.Layout.set_justify], this only has effect for partial lines. - Put all available space on the right + Put all available space on the right - Center the line within the available space + Center the line within the available space - Put all available space on the left + Put all available space on the left - The `PangoAnalysis` structure stores information about + The `PangoAnalysis` structure stores information about the properties of a segment of text. + - unused + unused - unused + unused - the font for this segment. + the font for this segment. - the bidirectional level for this segment. + the bidirectional level for this segment. - the glyph orientation for this segment (A `PangoGravity`). + the glyph orientation for this segment (A `PangoGravity`). - boolean flags for this segment (Since: 1.16). + boolean flags for this segment (Since: 1.16). - the detected script for this segment (A `PangoScript`) (Since: 1.18). + the detected script for this segment (A `PangoScript`) (Since: 1.18). - the detected language for this segment. + the detected language for this segment. - extra attributes for this segment. + extra attributes for this segment. - The `PangoAttrClass` structure stores the type and operations for + The `PangoAttrClass` structure stores the type and operations for a particular type of attribute. The functions in this structure should not be called directly. Instead, one should use the wrapper functions provided for `PangoAttribute`. + - the type ID for this attribute + the type ID for this attribute + @@ -151,6 +163,7 @@ one should use the wrapper functions provided for `PangoAttribute`. + @@ -163,6 +176,7 @@ one should use the wrapper functions provided for `PangoAttribute`. + @@ -178,115 +192,123 @@ one should use the wrapper functions provided for `PangoAttribute`. - The `PangoAttrColor` structure is used to represent attributes that + The `PangoAttrColor` structure is used to represent attributes that are colors. + - the common portion of the attribute + the common portion of the attribute - the `PangoColor` which is the value of the attribute + the `PangoColor` which is the value of the attribute - Type of a function that can duplicate user data for an attribute. + Type of a function that can duplicate user data for an attribute. + - new copy of @user_data. + new copy of @user_data. - user data to copy + user data to copy - Type of a function filtering a list of attributes. + Type of a function filtering a list of attributes. + - %TRUE if the attribute should be selected for + %TRUE if the attribute should be selected for filtering, %FALSE otherwise. - a Pango attribute + a Pango attribute - user data passed to the function + user data passed to the function - The `PangoAttrFloat` structure is used to represent attributes with + The `PangoAttrFloat` structure is used to represent attributes with a float or double value. + - the common portion of the attribute + the common portion of the attribute - the value of the attribute + the value of the attribute - The `PangoAttrFontDesc` structure is used to store an attribute that + The `PangoAttrFontDesc` structure is used to store an attribute that sets all aspects of the font description at once. + - the common portion of the attribute + the common portion of the attribute - the font description which is the value of this attribute + the font description which is the value of this attribute - Create a new font description attribute. + Create a new font description attribute. This attribute allows setting family, style, weight, variant, stretch, and size simultaneously. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the font description + the font description - The `PangoAttrFontFeatures` structure is used to represent OpenType + The `PangoAttrFontFeatures` structure is used to represent OpenType font features as an attribute. + - the common portion of the attribute + the common portion of the attribute - the featues, as a string in CSS syntax + the featues, as a string in CSS syntax - Create a new font features tag attribute. + Create a new font features tag attribute. You can use this attribute to select OpenType font features like small-caps, alternative glyphs, ligatures, etc. for fonts that support them. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - a string with OpenType font features, with the syntax of the [CSS + a string with OpenType font features, with the syntax of the [CSS font-feature-settings property](https://www.w3.org/TR/css-fonts-4/#font-rend-desc) @@ -294,81 +316,87 @@ font-feature-settings property](https://www.w3.org/TR/css-fonts-4/#font-rend-des - The `PangoAttrInt` structure is used to represent attributes with + The `PangoAttrInt` structure is used to represent attributes with an integer or enumeration value. + - the common portion of the attribute + the common portion of the attribute - the value of the attribute + the value of the attribute - A `PangoAttrIterator` is used to iterate through a `PangoAttrList`. + A `PangoAttrIterator` is used to iterate through a `PangoAttrList`. A new iterator is created with [method@Pango.AttrList.get_iterator]. Once the iterator is created, it can be advanced through the style changes in the text using [method@Pango.AttrIterator.next]. At each style change, the range of the current style segment and the attributes currently in effect can be queried. + - Copy a `PangoAttrIterator`. + Copy a `PangoAttrIterator`. + - the newly allocated + the newly allocated `PangoAttrIterator`, which should be freed with [method@Pango.AttrIterator.destroy] - a `PangoAttrIterator` + a `PangoAttrIterator` - Destroy a `PangoAttrIterator` and free all associated memory. + Destroy a `PangoAttrIterator` and free all associated memory. + - a `PangoAttrIterator` + a `PangoAttrIterator` - Find the current attribute of a particular type + Find the current attribute of a particular type at the iterator location. When multiple attributes of the same type overlap, the attribute whose range starts closest to the current location is used. + - the current + the current attribute of the given type, or %NULL if no attribute of that type applies to the current location. - a `PangoAttrIterator` + a `PangoAttrIterator` - the type of attribute to find + the type of attribute to find - Gets a list of all attributes at the current position of the + Gets a list of all attributes at the current position of the iterator. + - + a list of all attributes for the current range. To free this value, call [method@Pango.Attribute.destroy] on each value and g_slist_free() on the list. @@ -378,24 +406,25 @@ iterator. - a `PangoAttrIterator` + a `PangoAttrIterator` - Get the font and other attributes at the current + Get the font and other attributes at the current iterator position. + - a `PangoAttrIterator` + a `PangoAttrIterator` - a `PangoFontDescription` to fill in with the current + a `PangoFontDescription` to fill in with the current values. The family name in this structure will be set using [method@Pango.FontDescription.set_family_static] using values from an attribute in the `PangoAttrList` associated @@ -405,12 +434,12 @@ iterator position. - location to store language tag + location to store language tag for item, or %NULL if none is found. - + location in which to store a list of non-font attributes at the the current position; only the highest priority value of each attribute will be added to this list. In @@ -423,74 +452,78 @@ iterator position. - Advance the iterator until the next change of style. + Advance the iterator until the next change of style. + - %FALSE if the iterator is at the end + %FALSE if the iterator is at the end of the list, otherwise %TRUE - a `PangoAttrIterator` + a `PangoAttrIterator` - Get the range of the current segment. + Get the range of the current segment. Note that the stored return values are signed, not unsigned like the values in `PangoAttribute`. To deal with this API oversight, stored return values that wouldn't fit into a signed integer are clamped to %G_MAXINT. + - a PangoAttrIterator + a PangoAttrIterator - location to store the start of the range + location to store the start of the range - location to store the end of the range + location to store the end of the range - The `PangoAttrLanguage` structure is used to represent attributes that + The `PangoAttrLanguage` structure is used to represent attributes that are languages. + - the common portion of the attribute + the common portion of the attribute - the `PangoLanguage` which is the value of the attribute + the `PangoLanguage` which is the value of the attribute - Create a new language tag attribute. + Create a new language tag attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - language tag + language tag - A `PangoAttrList` represents a list of attributes that apply to a section + A `PangoAttrList` represents a list of attributes that apply to a section of text. The attributes in a `PangoAttrList` are, in general, allowed to overlap in @@ -501,18 +534,20 @@ stricter criteria. Since the `PangoAttrList` structure is stored as a linear list, it is not suitable for storing attributes for large amounts of text. In general, you should not use a single `PangoAttrList` for more than one paragraph of text. + - Create a new empty attribute list with a reference + Create a new empty attribute list with a reference count of one. + - the newly allocated + the newly allocated `PangoAttrList`, which should be freed with [method@Pango.AttrList.unref] - Insert the given attribute into the `PangoAttrList`. + Insert the given attribute into the `PangoAttrList`. It will replace any attributes of the same type on that segment and be merged with any adjoining @@ -524,24 +559,26 @@ much slower for large lists). However, [method@Pango.AttrList.insert] is not suitable for continually changing a set of attributes since it never removes or combines existing attributes. + - a `PangoAttrList` + a `PangoAttrList` - the attribute to insert + the attribute to insert - Copy @list and return an identical new list. + Copy @list and return an identical new list. + - the newly allocated + the newly allocated `PangoAttrList`, with a reference count of one, which should be freed with [method@Pango.AttrList.unref]. Returns %NULL if @list was %NULL. @@ -549,64 +586,67 @@ never removes or combines existing attributes. - a `PangoAttrList` + a `PangoAttrList` - Checks whether @list and @other_list contain the same + Checks whether @list and @other_list contain the same attributes and whether those attributes apply to the same ranges. Beware that this will return wrong values if any list contains duplicates. + - %TRUE if the lists are equal, %FALSE if + %TRUE if the lists are equal, %FALSE if they aren't - a `PangoAttrList` + a `PangoAttrList` - the other `PangoAttrList` + the other `PangoAttrList` - Given a `PangoAttrList` and callback function, removes + Given a `PangoAttrList` and callback function, removes any elements of @list for which @func returns %TRUE and inserts them into a new list. + - the new + the new `PangoAttrList` or %NULL if no attributes of the given types were found - a `PangoAttrList` + a `PangoAttrList` - callback function; + callback function; returns %TRUE if an attribute should be filtered out - Data to be passed to @func + Data to be passed to @func - Gets a list of all attributes in @list. + Gets a list of all attributes in @list. + - + a list of all attributes in @list. To free this value, call [method@Pango.Attribute.destroy] on each value and g_slist_free() on the list. @@ -616,82 +656,86 @@ inserts them into a new list. - a `PangoAttrList` + a `PangoAttrList` - Create a iterator initialized to the beginning of the list. + Create a iterator initialized to the beginning of the list. @list must not be modified until this iterator is freed. + - the newly allocated + the newly allocated `PangoAttrIterator`, which should be freed with [method@Pango.AttrIterator.destroy] - a `PangoAttrList` + a `PangoAttrList` - Insert the given attribute into the `PangoAttrList`. + Insert the given attribute into the `PangoAttrList`. It will be inserted after all other attributes with a matching @start_index. + - a `PangoAttrList` + a `PangoAttrList` - the attribute to insert + the attribute to insert - Insert the given attribute into the `PangoAttrList`. + Insert the given attribute into the `PangoAttrList`. It will be inserted before all other attributes with a matching @start_index. + - a `PangoAttrList` + a `PangoAttrList` - the attribute to insert + the attribute to insert - Increase the reference count of the given attribute + Increase the reference count of the given attribute list by one. + - The attribute list passed in + The attribute list passed in - a `PangoAttrList` + a `PangoAttrList` - This function opens up a hole in @list, fills it + This function opens up a hole in @list, fills it in with attributes from the left, and then merges @other on top of the hole. @@ -703,24 +747,25 @@ by @pos). This operation proves useful for, for instance, inserting a pre-edit string in the middle of an edit buffer. + - a `PangoAttrList` + a `PangoAttrList` - another `PangoAttrList` + another `PangoAttrList` - the position in @list at which to insert @other + the position in @list at which to insert @other - the length of the spliced segment. (Note that this + the length of the spliced segment. (Note that this must be specified since the attributes in @other may only be present at some subsection of this range) @@ -728,23 +773,24 @@ a pre-edit string in the middle of an edit buffer. - Decrease the reference count of the given attribute + Decrease the reference count of the given attribute list by one. If the result is zero, free the attribute list and the attributes it contains. + - a `PangoAttrList` + a `PangoAttrList` - Update indices of attributes in @list for a change in the + Update indices of attributes in @list for a change in the text they refer to. The change that this function applies is removing @remove @@ -758,113 +804,117 @@ range are shortened to reflect the removal. Attributes start and end positions are updated if they are behind @pos + @remove. + - a `PangoAttrList` + a `PangoAttrList` - the position of the change + the position of the change - the number of removed bytes + the number of removed bytes - the number of added bytes + the number of added bytes - The `PangoAttrShape` structure is used to represent attributes which + The `PangoAttrShape` structure is used to represent attributes which impose shape restrictions. + - the common portion of the attribute + the common portion of the attribute - the ink rectangle to restrict to + the ink rectangle to restrict to - the logical rectangle to restrict to + the logical rectangle to restrict to - user data set (see [func@Pango.AttrShape.new_with_data]) + user data set (see [func@Pango.AttrShape.new_with_data]) - copy function for the user data + copy function for the user data - destroy function for the user data + destroy function for the user data - Create a new shape attribute. + Create a new shape attribute. A shape is used to impose a particular ink and logical rectangle on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a `PangoLayout`. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - ink rectangle to assign to each character + ink rectangle to assign to each character - logical rectangle to assign to each character + logical rectangle to assign to each character - Creates a new shape attribute. + Creates a new shape attribute. Like [func@Pango.AttrShape.new], but a user data pointer is also provided; this pointer can be accessed when later rendering the glyph. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - ink rectangle to assign to each character + ink rectangle to assign to each character - logical rectangle to assign to each character + logical rectangle to assign to each character - user data pointer + user data pointer - function to copy @data when the + function to copy @data when the attribute is copied. If %NULL, @data is simply copied as a pointer - function to free @data when the + function to free @data when the attribute is freed @@ -872,169 +922,173 @@ rendering the glyph. - The `PangoAttrSize` structure is used to represent attributes which + The `PangoAttrSize` structure is used to represent attributes which set font size. + - the common portion of the attribute + the common portion of the attribute - size of font, in units of 1/%PANGO_SCALE of a point (for + size of font, in units of 1/%PANGO_SCALE of a point (for %PANGO_ATTR_SIZE) or of a device unit (for %PANGO_ATTR_ABSOLUTE_SIZE) - whether the font size is in device units or points. + whether the font size is in device units or points. This field is only present for compatibility with Pango-1.8.0 (%PANGO_ATTR_ABSOLUTE_SIZE was added in 1.8.1); and always will be %FALSE for %PANGO_ATTR_SIZE and %TRUE for %PANGO_ATTR_ABSOLUTE_SIZE. - Create a new font-size attribute in fractional points. + Create a new font-size attribute in fractional points. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the font size, in %PANGO_SCALE-ths of a point + the font size, in %PANGO_SCALE-ths of a point - Create a new font-size attribute in device units. + Create a new font-size attribute in device units. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the font size, in %PANGO_SCALE-ths of a device unit + the font size, in %PANGO_SCALE-ths of a device unit - The `PangoAttrString` structure is used to represent attributes with + The `PangoAttrString` structure is used to represent attributes with a string value. + - the common portion of the attribute + the common portion of the attribute - the string which is the value of the attribute + the string which is the value of the attribute - The `PangoAttrType` distinguishes between different types of attributes. + The `PangoAttrType` distinguishes between different types of attributes. Along with the predefined values, it is possible to allocate additional values for custom attributes using [func@AttrType.register]. The predefined values are given below. The type of structure used to store the attribute is listed in parentheses after the description. - does not happen + does not happen - language ([struct@Pango.AttrLanguage]) + language ([struct@Pango.AttrLanguage]) - font family name list ([struct@Pango.AttrString]) + font family name list ([struct@Pango.AttrString]) - font slant style ([struct@Pango.AttrInt]) + font slant style ([struct@Pango.AttrInt]) - font weight ([struct@Pango.AttrInt]) + font weight ([struct@Pango.AttrInt]) - font variant (normal or small caps) ([struct@Pango.AttrInt]) + font variant (normal or small caps) ([struct@Pango.AttrInt]) - font stretch ([struct@Pango.AttrInt]) + font stretch ([struct@Pango.AttrInt]) - font size in points scaled by %PANGO_SCALE ([struct@Pango.AttrInt]) + font size in points scaled by %PANGO_SCALE ([struct@Pango.AttrInt]) - font description ([struct@Pango.AttrFontDesc]) + font description ([struct@Pango.AttrFontDesc]) - foreground color ([struct@Pango.AttrColor]) + foreground color ([struct@Pango.AttrColor]) - background color ([struct@Pango.AttrColor]) + background color ([struct@Pango.AttrColor]) - whether the text has an underline ([struct@Pango.AttrInt]) + whether the text has an underline ([struct@Pango.AttrInt]) - whether the text is struck-through ([struct@Pango.AttrInt]) + whether the text is struck-through ([struct@Pango.AttrInt]) - baseline displacement ([struct@Pango.AttrInt]) + baseline displacement ([struct@Pango.AttrInt]) - shape ([struct@Pango.AttrShape]) + shape ([struct@Pango.AttrShape]) - font size scale factor ([struct@Pango.AttrFloat]) + font size scale factor ([struct@Pango.AttrFloat]) - whether fallback is enabled ([struct@Pango.AttrInt]) + whether fallback is enabled ([struct@Pango.AttrInt]) - letter spacing ([struct@PangoAttrInt]) + letter spacing ([struct@PangoAttrInt]) - underline color ([struct@Pango.AttrColor]) + underline color ([struct@Pango.AttrColor]) - strikethrough color ([struct@Pango.AttrColor]) + strikethrough color ([struct@Pango.AttrColor]) - font size in pixels scaled by %PANGO_SCALE ([struct@Pango.AttrInt]) + font size in pixels scaled by %PANGO_SCALE ([struct@Pango.AttrInt]) - base text gravity ([struct@Pango.AttrInt]) + base text gravity ([struct@Pango.AttrInt]) - gravity hint ([struct@Pango.AttrInt]) + gravity hint ([struct@Pango.AttrInt]) - OpenType font features ([struct@Pango.AttrString]). Since 1.38 + OpenType font features ([struct@Pango.AttrString]). Since 1.38 - foreground alpha ([struct@Pango.AttrInt]). Since 1.38 + foreground alpha ([struct@Pango.AttrInt]). Since 1.38 - background alpha ([struct@Pango.AttrInt]). Since 1.38 + background alpha ([struct@Pango.AttrInt]). Since 1.38 - whether breaks are allowed ([struct@Pango.AttrInt]). Since 1.44 + whether breaks are allowed ([struct@Pango.AttrInt]). Since 1.44 - how to render invisible characters ([struct@Pango.AttrInt]). Since 1.44 + how to render invisible characters ([struct@Pango.AttrInt]). Since 1.44 - whether to insert hyphens at intra-word line breaks ([struct@Pango.AttrInt]). Since 1.44 + whether to insert hyphens at intra-word line breaks ([struct@Pango.AttrInt]). Since 1.44 - whether the text has an overline ([struct@Pango.AttrInt]). Since 1.46 + whether the text has an overline ([struct@Pango.AttrInt]). Since 1.46 - overline color ([struct@Pango.AttrColor]). Since 1.46 + overline color ([struct@Pango.AttrColor]). Since 1.46 - Fetches the attribute type name. + Fetches the attribute type name. The attribute type name is the string passed in when registering the type using @@ -1043,38 +1097,40 @@ when registering the type using The returned value is an interned string (see g_intern_string() for what that means) that should not be modified or freed. + - the type ID name (which + the type ID name (which may be %NULL), or %NULL if @type is a built-in Pango attribute type or invalid. - an attribute type ID to fetch the name for + an attribute type ID to fetch the name for - Allocate a new attribute type ID. + Allocate a new attribute type ID. The attribute type name can be accessed later by using [func@Pango.AttrType.get_name]. + - the new type ID. + the new type ID. - an identifier for the type + an identifier for the type - The `PangoAttribute` structure represents the common portions of all + The `PangoAttribute` structure represents the common portions of all attributes. Particular types of attributes include this structure as their initial @@ -1082,246 +1138,258 @@ portion. The common portion of the attribute holds the range to which the value in the type-specific part of the attribute applies and should be initialized using [method@Pango.Attribute.init]. By default, an attribute will have an all-inclusive range of [0,%G_MAXUINT]. + - the class structure holding information about the type of the attribute + the class structure holding information about the type of the attribute - the start index of the range (in bytes). + the start index of the range (in bytes). - end index of the range (in bytes). The character at this index + end index of the range (in bytes). The character at this index is not included in the range. - Make a copy of an attribute. + Make a copy of an attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy]. - a `PangoAttribute` + a `PangoAttribute` - Destroy a `PangoAttribute` and free all associated memory. + Destroy a `PangoAttribute` and free all associated memory. + - a `PangoAttribute`. + a `PangoAttribute`. - Compare two attributes for equality. + Compare two attributes for equality. This compares only the actual value of the two attributes and not the ranges that the attributes apply to. + - %TRUE if the two attributes have the same value + %TRUE if the two attributes have the same value - a `PangoAttribute` + a `PangoAttribute` - another `PangoAttribute` + another `PangoAttribute` - Initializes @attr's klass to @klass, it's start_index to + Initializes @attr's klass to @klass, it's start_index to %PANGO_ATTR_INDEX_FROM_TEXT_BEGINNING and end_index to %PANGO_ATTR_INDEX_TO_TEXT_END such that the attribute applies to the entire text by default. + - a `PangoAttribute` + a `PangoAttribute` - a `PangoAttrClass` + a `PangoAttrClass` - `PangoBidiType` represents the bidirectional character + `PangoBidiType` represents the bidirectional character type of a Unicode character as specified by the [Unicode bidirectional algorithm](http://www.unicode.org/reports/tr9/). Use fribidi for this information - Left-to-Right + Left-to-Right - Left-to-Right Embedding + Left-to-Right Embedding - Left-to-Right Override + Left-to-Right Override - Right-to-Left + Right-to-Left - Right-to-Left Arabic + Right-to-Left Arabic - Right-to-Left Embedding + Right-to-Left Embedding - Right-to-Left Override + Right-to-Left Override - Pop Directional Format + Pop Directional Format - European Number + European Number - European Number Separator + European Number Separator - European Number Terminator + European Number Terminator - Arabic Number + Arabic Number - Common Number Separator + Common Number Separator - Nonspacing Mark + Nonspacing Mark - Boundary Neutral + Boundary Neutral - Paragraph Separator + Paragraph Separator - Segment Separator + Segment Separator - Whitespace + Whitespace - Other Neutrals + Other Neutrals - Left-to-Right isolate. Since 1.48.6 + Left-to-Right isolate. Since 1.48.6 - Right-to-Left isolate. Since 1.48.6 + Right-to-Left isolate. Since 1.48.6 - First strong isolate. Since 1.48.6 + First strong isolate. Since 1.48.6 - Pop directional isolate. Since 1.48.6 + Pop directional isolate. Since 1.48.6 - Determines the bidirectional type of a character. + Determines the bidirectional type of a character. The bidirectional type is specified in the Unicode Character Database. A simplified version of this function is available as [func@unichar_direction]. + - the bidirectional character type, as used in the + the bidirectional character type, as used in the Unicode bidirectional algorithm. - a Unicode character + a Unicode character + + + - The `PangoColor` structure is used to + The `PangoColor` structure is used to represent a color in an uncalibrated RGB color-space. + - value of red component + value of red component - value of green component + value of green component - value of blue component + value of blue component - Creates a copy of @src. + Creates a copy of @src. The copy should be freed with [method@Pango.Color.free]. Primarily used by language bindings, not that useful otherwise (since colors can just be copied by assignment in C). + - the newly allocated `PangoColor`, + the newly allocated `PangoColor`, which should be freed with [method@Pango.Color.free] - color to copy + color to copy - Frees a color allocated by [method@Pango.Color.copy]. + Frees a color allocated by [method@Pango.Color.copy]. + - an allocated `PangoColor` + an allocated `PangoColor` - Fill in the fields of a color from a string specification. + Fill in the fields of a color from a string specification. The string can either one of a large set of standard names. (Taken from the CSS Color [specification](https://www.w3.org/TR/css-color-4/#named-colors), @@ -1330,25 +1398,26 @@ or it can be a value in the form `#rgb`, `#rrggbb`, are hex digits of the red, green, and blue components of the color, respectively. (White in the four forms is `#fff`, `#ffffff`, `#fffffffff` and `#ffffffffffff`.) + - %TRUE if parsing of the specifier succeeded, + %TRUE if parsing of the specifier succeeded, otherwise %FALSE - a `PangoColor` structure in which + a `PangoColor` structure in which to store the result - a string specifying the new color + a string specifying the new color - Fill in the fields of a color from a string specification. + Fill in the fields of a color from a string specification. The string can either one of a large set of standard names. (Taken from the CSS Color [specification](https://www.w3.org/TR/css-color-4/#named-colors), @@ -1363,48 +1432,50 @@ Additionally, parse strings of the form `#rgba`, `#rrggbbaa`, to the value specified by the hex digits for `a`. If no alpha component is found in @spec, @alpha is set to 0xffff (for a solid color). + - %TRUE if parsing of the specifier succeeded, + %TRUE if parsing of the specifier succeeded, otherwise %FALSE - a `PangoColor` structure in which + a `PangoColor` structure in which to store the result - return location for alpha + return location for alpha - a string specifying the new color + a string specifying the new color - Returns a textual specification of @color. + Returns a textual specification of @color. The string is in the hexadecimal form `#rrrrggggbbbb`, where `r`, `g` and `b` are hex digits representing the red, green, and blue components respectively. + - a newly-allocated text string that must + a newly-allocated text string that must be freed with g_free(). - a `PangoColor` + a `PangoColor` - A `PangoContext` stores global information used to control the + A `PangoContext` stores global information used to control the itemization process. The information stored by `PangoContext` includes the fontmap used @@ -1412,8 +1483,9 @@ to look up fonts, and default values such as the default language, default gravity, or default font. To obtain a `PangoContext`, use [method@Pango.FontMap.create_context]. + - Creates a new `PangoContext` initialized to default values. + Creates a new `PangoContext` initialized to default values. This function is not particularly useful as it should always be followed by a [method@Pango.Context.set_font_map] call, and the @@ -1424,154 +1496,164 @@ If you are using Pango as part of a higher-level system, that system may have it's own way of create a `PangoContext`. For instance, the GTK toolkit has, among others, `gtk_widget_get_pango_context()`. Use those instead. + - the newly allocated `PangoContext`, which should + the newly allocated `PangoContext`, which should be freed with g_object_unref(). - Forces a change in the context, which will cause any `PangoLayout` + Forces a change in the context, which will cause any `PangoLayout` using this context to re-layout. This function is only useful when implementing a new backend for Pango, something applications won't do. Backends should call this function if they have attached extra data to the context and such data is changed. + - a `PangoContext` + a `PangoContext` - Retrieves the base direction for the context. + Retrieves the base direction for the context. See [method@Pango.Context.set_base_dir]. + - the base direction for the context. + the base direction for the context. - a `PangoContext` + a `PangoContext` - Retrieves the base gravity for the context. + Retrieves the base gravity for the context. See [method@Pango.Context.set_base_gravity]. + - the base gravity for the context. + the base gravity for the context. - a `PangoContext` + a `PangoContext` - Retrieve the default font description for the context. + Retrieve the default font description for the context. + - a pointer to the context's default font + a pointer to the context's default font description. This value must not be modified or freed. - a `PangoContext` + a `PangoContext` - Gets the `PangoFontMap` used to look up fonts for this context. + Gets the `PangoFontMap` used to look up fonts for this context. + - the font map for the `PangoContext`. + the font map for the `PangoContext`. This value is owned by Pango and should not be unreferenced. - a `PangoContext` + a `PangoContext` - Retrieves the gravity for the context. + Retrieves the gravity for the context. This is similar to [method@Pango.Context.get_base_gravity], except for when the base gravity is %PANGO_GRAVITY_AUTO for which [func@Pango.Gravity.get_for_matrix] is used to return the gravity from the current context matrix. + - the resolved gravity for the context. + the resolved gravity for the context. - a `PangoContext` + a `PangoContext` - Retrieves the gravity hint for the context. + Retrieves the gravity hint for the context. See [method@Pango.Context.set_gravity_hint] for details. + - the gravity hint for the context. + the gravity hint for the context. - a `PangoContext` + a `PangoContext` - Retrieves the global language tag for the context. + Retrieves the global language tag for the context. + - the global language tag. + the global language tag. - a `PangoContext` + a `PangoContext` - Gets the transformation matrix that will be applied when + Gets the transformation matrix that will be applied when rendering with this context. See [method@Pango.Context.set_matrix]. + - the matrix, or %NULL if no matrix has + the matrix, or %NULL if no matrix has been set (which is the same as the identity matrix). The returned matrix is owned by Pango and must not be modified or freed. - a `PangoContext` + a `PangoContext` - Get overall metric information for a particular font description. + Get overall metric information for a particular font description. Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be @@ -1582,23 +1664,24 @@ and the family name may be a comma separated list of names. If characters from multiple of these families would be used to render the string, then the returned fonts would be a composite of the metrics for the fonts loaded for the individual families. + - a `PangoFontMetrics` object. The caller must call + a `PangoFontMetrics` object. The caller must call [method@Pango.FontMetrics.unref] when finished using the object. - a `PangoContext` + a `PangoContext` - a `PangoFontDescription` structure. %NULL means that the + a `PangoFontDescription` structure. %NULL means that the font description from the context will be used. - language tag used to determine which script to get + language tag used to determine which script to get the metrics for. %NULL means that the language tag from the context will be used. If no language tag is set on the context, metrics for the default language (as determined by [func@Pango.Language.get_default] @@ -1608,20 +1691,21 @@ for the individual families. - Returns whether font rendering with this context should + Returns whether font rendering with this context should round glyph positions and widths. + - a `PangoContext` + a `PangoContext` - Returns the current serial number of @context. + Returns the current serial number of @context. The serial number is initialized to an small number larger than zero when a new context is created and is increased whenever the context @@ -1633,29 +1717,31 @@ always use "not equals". This can be used to automatically detect changes to a `PangoContext`, and is only useful when implementing objects that need update when their `PangoContext` changes, like `PangoLayout`. + - The current serial number of @context. + The current serial number of @context. - a `PangoContext` + a `PangoContext` - List all families for a context. + List all families for a context. + - a `PangoContext` + a `PangoContext` - location + location to store a pointer to an array of `PangoFontFamily`. This array should be freed with g_free(). @@ -1663,55 +1749,57 @@ and is only useful when implementing objects that need update when their - location to store the number of elements in @descs + location to store the number of elements in @descs - Loads the font in one of the fontmaps in the context + Loads the font in one of the fontmaps in the context that is the closest match for @desc. + - the newly allocated `PangoFont` + the newly allocated `PangoFont` that was loaded, or %NULL if no font matched. - a `PangoContext` + a `PangoContext` - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load - Load a set of fonts in the context that can be used to render + Load a set of fonts in the context that can be used to render a font matching @desc. + - the newly allocated + the newly allocated `PangoFontset` loaded, or %NULL if no font matched. - a `PangoContext` + a `PangoContext` - a `PangoFontDescription` describing the fonts to load + a `PangoFontDescription` describing the fonts to load - a `PangoLanguage` the fonts will be used for + a `PangoLanguage` the fonts will be used for - Sets the base direction for the context. + Sets the base direction for the context. The base direction is used in applying the Unicode bidirectional algorithm; if the @direction is %PANGO_DIRECTION_LTR or @@ -1719,117 +1807,123 @@ algorithm; if the @direction is %PANGO_DIRECTION_LTR or direction in the Unicode bidirectional algorithm. A value of %PANGO_DIRECTION_WEAK_LTR or %PANGO_DIRECTION_WEAK_RTL is used only for paragraphs that do not contain any strong characters themselves. + - a `PangoContext` + a `PangoContext` - the new base direction + the new base direction - Sets the base gravity for the context. + Sets the base gravity for the context. The base gravity is used in laying vertical text out. + - a `PangoContext` + a `PangoContext` - the new base gravity + the new base gravity - Set the default font description for the context + Set the default font description for the context + - a `PangoContext` + a `PangoContext` - the new pango font description + the new pango font description - Sets the font map to be searched when fonts are looked-up + Sets the font map to be searched when fonts are looked-up in this context. This is only for internal use by Pango backends, a `PangoContext` obtained via one of the recommended methods should already have a suitable font map. + - a `PangoContext` + a `PangoContext` - the `PangoFontMap` to set. + the `PangoFontMap` to set. - Sets the gravity hint for the context. + Sets the gravity hint for the context. The gravity hint is used in laying vertical text out, and is only relevant if gravity of the context as returned by [method@Pango.Context.get_gravity] is set to %PANGO_GRAVITY_EAST or %PANGO_GRAVITY_WEST. + - a `PangoContext` + a `PangoContext` - the new gravity hint + the new gravity hint - Sets the global language tag for the context. + Sets the global language tag for the context. The default language for the locale of the running process can be found using [func@Pango.Language.get_default]. + - a `PangoContext` + a `PangoContext` - the new language tag. + the new language tag. - Sets the transformation matrix that will be applied when rendering + Sets the transformation matrix that will be applied when rendering with this context. Note that reported metrics are in the user space coordinates before @@ -1837,23 +1931,24 @@ the application of the matrix, not device-space coordinates after the application of the matrix. So, they don't scale with the matrix, though they may change slightly for different matrices, depending on how the text is fit to the pixel grid. + - a `PangoContext` + a `PangoContext` - a `PangoMatrix`, or %NULL to unset any existing + a `PangoMatrix`, or %NULL to unset any existing matrix. (No matrix set is the same as setting the identity matrix.) - Sets whether font rendering with this context should + Sets whether font rendering with this context should round glyph positions and widths to integral positions, in device units. @@ -1862,24 +1957,27 @@ positioning of glyphs. The default value is to round glyph positions, to remain compatible with previous Pango behavior. + - a `PangoContext` + a `PangoContext` - whether to round glyph positions + whether to round glyph positions - + + + - A `PangoCoverage` structure is a map from Unicode characters + A `PangoCoverage` structure is a map from Unicode characters to [enum@Pango.CoverageLevel] values. It is often necessary in Pango to determine if a particular @@ -1888,201 +1986,211 @@ it can represent that character. The `PangoCoverage` is a data structure that is used to represent that information. It is an opaque structure with no public fields. - Create a new `PangoCoverage` + Create a new `PangoCoverage` + - the newly allocated `PangoCoverage`, initialized + the newly allocated `PangoCoverage`, initialized to %PANGO_COVERAGE_NONE with a reference count of one, which should be freed with [method@Pango.Coverage.unref]. - Convert data generated from pango_coverage_to_bytes() + Convert data generated from pango_coverage_to_bytes() back to a `PangoCoverage`. This returns %NULL + - a newly allocated `PangoCoverage` + a newly allocated `PangoCoverage` - binary data + binary data representing a `PangoCoverage` - the size of @bytes in bytes + the size of @bytes in bytes - Copy an existing `PangoCoverage`. + Copy an existing `PangoCoverage`. + - the newly allocated `PangoCoverage`, + the newly allocated `PangoCoverage`, with a reference count of one, which should be freed with [method@Pango.Coverage.unref]. - a `PangoCoverage` + a `PangoCoverage` - Determine whether a particular index is covered by @coverage. + Determine whether a particular index is covered by @coverage. + - the coverage level of @coverage for character @index_. + the coverage level of @coverage for character @index_. - a `PangoCoverage` + a `PangoCoverage` - the index to check + the index to check - Set the coverage for each index in @coverage to be the max (better) + Set the coverage for each index in @coverage to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in @other. This function does nothing + - a `PangoCoverage` + a `PangoCoverage` - another `PangoCoverage` + another `PangoCoverage` - Increase the reference count on the `PangoCoverage` by one. + Increase the reference count on the `PangoCoverage` by one. + - @coverage + @coverage - a `PangoCoverage` + a `PangoCoverage` - Modify a particular index within @coverage + Modify a particular index within @coverage + - a `PangoCoverage` + a `PangoCoverage` - the index to modify + the index to modify - the new level for @index_ + the new level for @index_ - Convert a `PangoCoverage` structure into a flat binary format. + Convert a `PangoCoverage` structure into a flat binary format. This returns %NULL + - a `PangoCoverage` + a `PangoCoverage` - + location to store result (must be freed with g_free()) - location to store size of result + location to store size of result - Decrease the reference count on the `PangoCoverage` by one. + Decrease the reference count on the `PangoCoverage` by one. If the result is zero, free the coverage and all associated memory. + - a `PangoCoverage` + a `PangoCoverage` - `PangoCoverageLevel` is used to indicate how well a font can + `PangoCoverageLevel` is used to indicate how well a font can represent a particular Unicode character for a particular script. Since 1.44, only %PANGO_COVERAGE_NONE and %PANGO_COVERAGE_EXACT will be returned. - The character is not representable with + The character is not representable with the font. - The character is represented in a + The character is represented in a way that may be comprehensible but is not the correct graphical form. For instance, a Hangul character represented as a a sequence of Jamos, or a Latin transliteration of a Cyrillic word. - The character is represented as + The character is represented as basically the correct graphical form, but with a stylistic variant inappropriate for the current script. - The character is represented as the + The character is represented as the correct graphical form. - Extracts the *descent* from a `PangoRectangle` + Extracts the *descent* from a `PangoRectangle` representing glyph extents. The descent is the distance from the baseline to the lowest point of the character. This is positive if the glyph descends below the baseline. + - a `PangoRectangle` + a `PangoRectangle` - `PangoDirection` represents a direction in the Unicode bidirectional + `PangoDirection` represents a direction in the Unicode bidirectional algorithm. Not every value in this enumeration makes sense for every usage of @@ -2101,168 +2209,187 @@ If you are interested in text direction, you should really use fribidi directly. `PangoDirection` is only retained because it is used in some public apis. - A strong left-to-right direction + A strong left-to-right direction - A strong right-to-left direction + A strong right-to-left direction - Deprecated value; treated the + Deprecated value; treated the same as %PANGO_DIRECTION_RTL. - Deprecated value; treated the + Deprecated value; treated the same as %PANGO_DIRECTION_LTR - A weak left-to-right direction + A weak left-to-right direction - A weak right-to-left direction + A weak right-to-left direction - No direction specified + No direction specified - `PangoEllipsizeMode` describes what sort of ellipsization + `PangoEllipsizeMode` describes what sort of ellipsization should be applied to text. In the ellipsization process characters are removed from the text in order to make it fit to a given width and replaced with an ellipsis. - No ellipsization + No ellipsization - Omit characters at the start of the text + Omit characters at the start of the text - Omit characters in the middle of the text + Omit characters in the middle of the text - Omit characters at the end of the text + Omit characters at the end of the text + + + + + + + + + + + + + + + + - A `PangoFont` is used to represent a font in a + A `PangoFont` is used to represent a font in a rendering-system-independent manner. + - Frees an array of font descriptions. + Frees an array of font descriptions. + - a pointer + a pointer to an array of `PangoFontDescription`, may be %NULL - number of font descriptions in @descs + number of font descriptions in @descs + @@ -2273,22 +2400,24 @@ rendering-system-independent manner. - Returns a description of the font, with font size set in points. + Returns a description of the font, with font size set in points. Use [method@Pango.Font.describe_with_absolute_size] if you want the font size in device units. + - a newly-allocated `PangoFontDescription` object. + a newly-allocated `PangoFontDescription` object. - a `PangoFont` + a `PangoFont` + @@ -2299,55 +2428,57 @@ the font size in device units. - Computes the coverage map for a given font and language tag. + Computes the coverage map for a given font and language tag. + - a newly-allocated `PangoCoverage` + a newly-allocated `PangoCoverage` object. - a `PangoFont` + a `PangoFont` - the language tag + the language tag - Obtain the OpenType features that are provided by the font. + Obtain the OpenType features that are provided by the font. These are passed to the rendering system, together with features that have been explicitly set via attributes. Note that this does not include OpenType features which the rendering system enables by default. + - a `PangoFont` + a `PangoFont` - Array to features in + Array to features in - the length of @features + the length of @features - the number of used items in @features + the number of used items in @features - Gets the font map for which the font was created. + Gets the font map for which the font was created. Note that the font maintains a *weak* reference to the font map, so if all references to font map are @@ -2358,20 +2489,21 @@ In that case this function will return %NULL. It is the responsibility of the user to ensure that the font map is kept alive. In most uses this is not an issue as a `PangoContext` holds a reference to the font map. + - the `PangoFontMap` + the `PangoFontMap` for the font - a `PangoFont` + a `PangoFont` - Gets the logical and ink extents of a glyph within a font. + Gets the logical and ink extents of a glyph within a font. The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing @@ -2382,30 +2514,31 @@ of the rectangles are in 1/PANGO_SCALE of a device unit. If @font is %NULL, this function gracefully sets some sane values in the output variables and returns. + - a `PangoFont` + a `PangoFont` - the glyph index + the glyph index - rectangle used to store the extents of the glyph as drawn + rectangle used to store the extents of the glyph as drawn - rectangle used to store the logical extents of the glyph + rectangle used to store the logical extents of the glyph - Gets overall metric information for a font. + Gets overall metric information for a font. Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be @@ -2413,18 +2546,19 @@ retrieved that correspond to the script(s) used by that language. If @font is %NULL, this function gracefully sets some sane values in the output variables and returns. + - a `PangoFontMetrics` object. The caller must call + a `PangoFontMetrics` object. The caller must call [method@Pango.FontMetrics.unref] when finished using the object. - a `PangoFont` + a `PangoFont` - language tag used to determine which script + language tag used to determine which script to get the metrics for, or %NULL to indicate to get the metrics for the entire font. @@ -2432,100 +2566,105 @@ output variables and returns. - Returns a description of the font, with font size set in points. + Returns a description of the font, with font size set in points. Use [method@Pango.Font.describe_with_absolute_size] if you want the font size in device units. + - a newly-allocated `PangoFontDescription` object. + a newly-allocated `PangoFontDescription` object. - a `PangoFont` + a `PangoFont` - Returns a description of the font, with absolute font size set + Returns a description of the font, with absolute font size set in device units. Use [method@Pango.Font.describe] if you want the font size in points. + - a newly-allocated `PangoFontDescription` object. + a newly-allocated `PangoFontDescription` object. - a `PangoFont` + a `PangoFont` - Computes the coverage map for a given font and language tag. + Computes the coverage map for a given font and language tag. + - a newly-allocated `PangoCoverage` + a newly-allocated `PangoCoverage` object. - a `PangoFont` + a `PangoFont` - the language tag + the language tag - Gets the `PangoFontFace` to which @font belongs. + Gets the `PangoFontFace` to which @font belongs. + - the `PangoFontFace` + the `PangoFontFace` - a `PangoFont` + a `PangoFont` - Obtain the OpenType features that are provided by the font. + Obtain the OpenType features that are provided by the font. These are passed to the rendering system, together with features that have been explicitly set via attributes. Note that this does not include OpenType features which the rendering system enables by default. + - a `PangoFont` + a `PangoFont` - Array to features in + Array to features in - the length of @features + the length of @features - the number of used items in @features + the number of used items in @features - Gets the font map for which the font was created. + Gets the font map for which the font was created. Note that the font maintains a *weak* reference to the font map, so if all references to font map are @@ -2536,20 +2675,21 @@ In that case this function will return %NULL. It is the responsibility of the user to ensure that the font map is kept alive. In most uses this is not an issue as a `PangoContext` holds a reference to the font map. + - the `PangoFontMap` + the `PangoFontMap` for the font - a `PangoFont` + a `PangoFont` - Gets the logical and ink extents of a glyph within a font. + Gets the logical and ink extents of a glyph within a font. The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing @@ -2560,48 +2700,50 @@ of the rectangles are in 1/PANGO_SCALE of a device unit. If @font is %NULL, this function gracefully sets some sane values in the output variables and returns. + - a `PangoFont` + a `PangoFont` - the glyph index + the glyph index - rectangle used to store the extents of the glyph as drawn + rectangle used to store the extents of the glyph as drawn - rectangle used to store the logical extents of the glyph + rectangle used to store the logical extents of the glyph - Get a `hb_font_t` object backing this font. + Get a `hb_font_t` object backing this font. Note that the objects returned by this function are cached and immutable. If you need to make changes to the `hb_font_t`, use hb_font_create_sub_font(). + - the `hb_font_t` object + the `hb_font_t` object backing the font - a `PangoFont` + a `PangoFont` - Gets overall metric information for a font. + Gets overall metric information for a font. Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be @@ -2609,18 +2751,19 @@ retrieved that correspond to the script(s) used by that language. If @font is %NULL, this function gracefully sets some sane values in the output variables and returns. + - a `PangoFontMetrics` object. The caller must call + a `PangoFontMetrics` object. The caller must call [method@Pango.FontMetrics.unref] when finished using the object. - a `PangoFont` + a `PangoFont` - language tag used to determine which script + language tag used to determine which script to get the metrics for, or %NULL to indicate to get the metrics for the entire font. @@ -2628,19 +2771,20 @@ output variables and returns. - Returns whether the font provides a glyph for this character. + Returns whether the font provides a glyph for this character. Returns %TRUE if @font can render @wc + - a `PangoFont` + a `PangoFont` - a Unicode character + a Unicode character @@ -2650,18 +2794,20 @@ Returns %TRUE if @font can render @wc + + - a newly-allocated `PangoFontDescription` object. + a newly-allocated `PangoFontDescription` object. - a `PangoFont` + a `PangoFont` @@ -2669,18 +2815,19 @@ Returns %TRUE if @font can render @wc + - a newly-allocated `PangoCoverage` + a newly-allocated `PangoCoverage` object. - a `PangoFont` + a `PangoFont` - the language tag + the language tag @@ -2688,24 +2835,25 @@ Returns %TRUE if @font can render @wc + - a `PangoFont` + a `PangoFont` - the glyph index + the glyph index - rectangle used to store the extents of the glyph as drawn + rectangle used to store the extents of the glyph as drawn - rectangle used to store the logical extents of the glyph + rectangle used to store the logical extents of the glyph @@ -2713,18 +2861,19 @@ Returns %TRUE if @font can render @wc + - a `PangoFontMetrics` object. The caller must call + a `PangoFontMetrics` object. The caller must call [method@Pango.FontMetrics.unref] when finished using the object. - a `PangoFont` + a `PangoFont` - language tag used to determine which script + language tag used to determine which script to get the metrics for, or %NULL to indicate to get the metrics for the entire font. @@ -2734,14 +2883,15 @@ Returns %TRUE if @font can render @wc + - the `PangoFontMap` + the `PangoFontMap` for the font - a `PangoFont` + a `PangoFont` @@ -2749,6 +2899,7 @@ Returns %TRUE if @font can render @wc + @@ -2761,24 +2912,25 @@ Returns %TRUE if @font can render @wc + - a `PangoFont` + a `PangoFont` - Array to features in + Array to features in - the length of @features + the length of @features - the number of used items in @features + the number of used items in @features @@ -2786,6 +2938,7 @@ Returns %TRUE if @font can render @wc + @@ -2798,22 +2951,24 @@ Returns %TRUE if @font can render @wc - A `PangoFontDescription` describes a font in an implementation-independent + A `PangoFontDescription` describes a font in an implementation-independent manner. `PangoFontDescription` structures are used both to list what fonts are available on the system and also for specifying the characteristics of a font to load. + - Creates a new font description structure with all fields unset. + Creates a new font description structure with all fields unset. + - the newly allocated `PangoFontDescription`, which + the newly allocated `PangoFontDescription`, which should be freed using [method@Pango.FontDescription.free]. - Determines if the style attributes of @new_match are a closer match + Determines if the style attributes of @new_match are a closer match for @desc than those of @old_match are, or if @old_match is %NULL, determines if @new_match is a match at all. @@ -2824,150 +2979,159 @@ and size-related attributes. Approximate matching for style considers a match as when the styles are equal. Note that @old_match must match @desc. + - %TRUE if @new_match is a better match + %TRUE if @new_match is a better match - a `PangoFontDescription` + a `PangoFontDescription` - a `PangoFontDescription`, or %NULL + a `PangoFontDescription`, or %NULL - a `PangoFontDescription` + a `PangoFontDescription` - Make a copy of a `PangoFontDescription`. + Make a copy of a `PangoFontDescription`. + - the newly allocated `PangoFontDescription`, + the newly allocated `PangoFontDescription`, which should be freed with [method@Pango.FontDescription.free], or %NULL if @desc was %NULL. - a `PangoFontDescription`, may be %NULL + a `PangoFontDescription`, may be %NULL - Make a copy of a `PangoFontDescription`, but don't duplicate + Make a copy of a `PangoFontDescription`, but don't duplicate allocated fields. This is like [method@Pango.FontDescription.copy], but only a shallow copy is made of the family name and other allocated fields. The result can only be used until @desc is modified or freed. This is meant to be used when the copy is only needed temporarily. + - the newly allocated `PangoFontDescription`, + the newly allocated `PangoFontDescription`, which should be freed with [method@Pango.FontDescription.free], or %NULL if @desc was %NULL. - a `PangoFontDescription`, may be %NULL + a `PangoFontDescription`, may be %NULL - Compares two font descriptions for equality. + Compares two font descriptions for equality. Two font descriptions are considered equal if the fonts they describe are provably identical. This means that their masks do not have to match, as long as other fields are all the same. (Two font descriptions may result in identical fonts being loaded, but still compare %FALSE.) + - %TRUE if the two font descriptions are identical, + %TRUE if the two font descriptions are identical, %FALSE otherwise. - a `PangoFontDescription` + a `PangoFontDescription` - another `PangoFontDescription` + another `PangoFontDescription` - Frees a font description. + Frees a font description. + - a `PangoFontDescription`, may be %NULL + a `PangoFontDescription`, may be %NULL - Gets the family name field of a font description. + Gets the family name field of a font description. See [method@Pango.FontDescription.set_family]. + - the family name field for the font + the family name field for the font description, or %NULL if not previously set. This has the same life-time as the font description itself and should not be freed. - a `PangoFontDescription`. + a `PangoFontDescription`. - Gets the gravity field of a font description. + Gets the gravity field of a font description. See [method@Pango.FontDescription.set_gravity]. + - the gravity field for the font description. + the gravity field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not. - a `PangoFontDescription` + a `PangoFontDescription` - Determines which fields in a font description have been set. + Determines which fields in a font description have been set. + - a bitmask with bits set corresponding to the + a bitmask with bits set corresponding to the fields in @desc that have been set. - a `PangoFontDescription` + a `PangoFontDescription` - Gets the size field of a font description. + Gets the size field of a font description. See [method@Pango.FontDescription.set_size]. + - the size field for the font description in points + the size field for the font description in points or device units. You must call [method@Pango.FontDescription.get_size_is_absolute] to find out which is the case. Returns 0 if the size field has not previously @@ -2978,19 +3142,20 @@ See [method@Pango.FontDescription.set_size]. - a `PangoFontDescription` + a `PangoFontDescription` - Determines whether the size of the font is in points (not absolute) + Determines whether the size of the font is in points (not absolute) or device units (absolute). See [method@Pango.FontDescription.set_size] and [method@Pango.FontDescription.set_absolute_size]. + - whether the size for the font description is in + whether the size for the font description is in points or device units. Use [method@Pango.FontDescription.get_set_fields] to find out if the size field of the font description was explicitly set or not. @@ -2998,114 +3163,120 @@ and [method@Pango.FontDescription.set_absolute_size]. - a `PangoFontDescription` + a `PangoFontDescription` - Gets the stretch field of a font description. + Gets the stretch field of a font description. See [method@Pango.FontDescription.set_stretch]. + - the stretch field for the font description. + the stretch field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not. - a `PangoFontDescription`. + a `PangoFontDescription`. - Gets the style field of a `PangoFontDescription`. + Gets the style field of a `PangoFontDescription`. See [method@Pango.FontDescription.set_style]. + - the style field for the font description. + the style field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not. - a `PangoFontDescription` + a `PangoFontDescription` - Gets the variant field of a `PangoFontDescription`. + Gets the variant field of a `PangoFontDescription`. See [method@Pango.FontDescription.set_variant]. + - the variant field for the font description. + the variant field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not. - a `PangoFontDescription`. + a `PangoFontDescription`. - Gets the variations field of a font description. + Gets the variations field of a font description. See [method@Pango.FontDescription.set_variations]. + - the variations field for the font + the variations field for the font description, or %NULL if not previously set. This has the same life-time as the font description itself and should not be freed. - a `PangoFontDescription` + a `PangoFontDescription` - Gets the weight field of a font description. + Gets the weight field of a font description. See [method@Pango.FontDescription.set_weight]. + - the weight field for the font description. + the weight field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not. - a `PangoFontDescription` + a `PangoFontDescription` - Computes a hash of a `PangoFontDescription` structure. + Computes a hash of a `PangoFontDescription` structure. This is suitable to be used, for example, as an argument to g_hash_table_new(). The hash value is independent of @desc->mask. + - the hash value. + the hash value. - a `PangoFontDescription` + a `PangoFontDescription` - Merges the fields that are set in @desc_to_merge into the fields in + Merges the fields that are set in @desc_to_merge into the fields in @desc. If @replace_existing is %FALSE, only fields in @desc that @@ -3113,21 +3284,22 @@ are not already set are affected. If %TRUE, then fields that are already set will be replaced as well. If @desc_to_merge is %NULL, this function performs nothing. + - a `PangoFontDescription` + a `PangoFontDescription` - the `PangoFontDescription` to merge from, + the `PangoFontDescription` to merge from, or %NULL - if %TRUE, replace fields in @desc with the + if %TRUE, replace fields in @desc with the corresponding values from @desc_to_merge, even if they are already exist. @@ -3135,27 +3307,28 @@ If @desc_to_merge is %NULL, this function performs nothing. - Merges the fields that are set in @desc_to_merge into the fields in + Merges the fields that are set in @desc_to_merge into the fields in @desc, without copying allocated fields. This is like [method@Pango.FontDescription.merge], but only a shallow copy is made of the family name and other allocated fields. @desc can only be used until @desc_to_merge is modified or freed. This is meant to be used when the merged font description is only needed temporarily. + - a `PangoFontDescription` + a `PangoFontDescription` - the `PangoFontDescription` to merge from + the `PangoFontDescription` to merge from - if %TRUE, replace fields in @desc with the + if %TRUE, replace fields in @desc with the corresponding values from @desc_to_merge, even if they are already exist. @@ -3163,20 +3336,21 @@ be used when the merged font description is only needed temporarily. - Sets the size field of a font description, in device units. + Sets the size field of a font description, in device units. This is mutually exclusive with [method@Pango.FontDescription.set_size] which sets the font size in points. + - a `PangoFontDescription` + a `PangoFontDescription` - the new size, in Pango units. There are %PANGO_SCALE Pango units + the new size, in Pango units. There are %PANGO_SCALE Pango units in one device unit. For an output backend where a device unit is a pixel, a @size value of 10 * PANGO_SCALE gives a 10 pixel font. @@ -3184,51 +3358,53 @@ which sets the font size in points. - Sets the family name field of a font description. + Sets the family name field of a font description. The family name represents a family of related font styles, and will resolve to a particular `PangoFontFamily`. In some uses of `PangoFontDescription`, it is also possible to use a comma separated list of family names for this field. + - a `PangoFontDescription`. + a `PangoFontDescription`. - a string representing the family name. + a string representing the family name. - Sets the family name field of a font description, without copying the string. + Sets the family name field of a font description, without copying the string. This is like [method@Pango.FontDescription.set_family], except that no copy of @family is made. The caller must make sure that the string passed in stays around until @desc has been freed or the name is set again. This function can be used if @family is a static string such as a C string literal, or if @desc is only needed temporarily. + - a `PangoFontDescription` + a `PangoFontDescription` - a string representing the family name + a string representing the family name - Sets the gravity field of a font description. + Sets the gravity field of a font description. The gravity field specifies how the glyphs should be rotated. If @gravity is @@ -3237,35 +3413,37 @@ the font description. This function is seldom useful to the user. Gravity should normally be set on a `PangoContext`. + - a `PangoFontDescription` + a `PangoFontDescription` - the gravity for the font description. + the gravity for the font description. - Sets the size field of a font description in fractional points. + Sets the size field of a font description in fractional points. This is mutually exclusive with [method@Pango.FontDescription.set_absolute_size]. + - a `PangoFontDescription` + a `PangoFontDescription` - the size of the font in points, scaled by %PANGO_SCALE. + the size of the font in points, scaled by %PANGO_SCALE. (That is, a @size value of 10 * PANGO_SCALE is a 10 point font. The conversion factor between points and device units depends on system configuration and the output device. For screen display, a @@ -3278,26 +3456,27 @@ This is mutually exclusive with - Sets the stretch field of a font description. + Sets the stretch field of a font description. The [enum@Pango.Stretch] field specifies how narrow or wide the font should be. + - a `PangoFontDescription` + a `PangoFontDescription` - the stretch for the font description + the stretch for the font description - Sets the style field of a `PangoFontDescription`. + Sets the style field of a `PangoFontDescription`. The [enum@Pango.Style] enumeration describes whether the font is slanted and the manner in which it is slanted; it can be either @@ -3307,41 +3486,43 @@ Most fonts will either have a italic style or an oblique style, but not both, and font matching in Pango will match italic specifications with oblique fonts and vice-versa if an exact match is not found. + - a `PangoFontDescription` + a `PangoFontDescription` - the style for the font description + the style for the font description - Sets the variant field of a font description. + Sets the variant field of a font description. The [enum@Pango.Variant] can either be %PANGO_VARIANT_NORMAL or %PANGO_VARIANT_SMALL_CAPS. + - a `PangoFontDescription` + a `PangoFontDescription` - the variant type for the font description. + the variant type for the font description. - Sets the variations field of a font description. + Sets the variations field of a font description. OpenType font variations allow to select a font instance by specifying values for a number of axes, such as width or weight. @@ -3356,22 +3537,23 @@ and values are clamped to their allowed range. Pango does not currently have a way to find supported axes of a font. Both harfbuzz or freetype have API for this. + - a `PangoFontDescription`. + a `PangoFontDescription`. - a string representing the variations + a string representing the variations - Sets the variations field of a font description. + Sets the variations field of a font description. This is like [method@Pango.FontDescription.set_variations], except that no copy of @variations is made. The caller must make sure that @@ -3379,97 +3561,102 @@ the string passed in stays around until @desc has been freed or the name is set again. This function can be used if @variations is a static string such as a C string literal, or if @desc is only needed temporarily. + - a `PangoFontDescription` + a `PangoFontDescription` - a string representing the variations + a string representing the variations - Sets the weight field of a font description. + Sets the weight field of a font description. The weight field specifies how bold or light the font should be. In addition to the values of the [enum@Pango.Weight] enumeration, other intermediate numeric values are possible. + - a `PangoFontDescription` + a `PangoFontDescription` - the weight for the font description. + the weight for the font description. - Creates a filename representation of a font description. + Creates a filename representation of a font description. The filename is identical to the result from calling [method@Pango.FontDescription.to_string], but with underscores instead of characters that are untypical in filenames, and in lower case only. + - a new string that must be freed with g_free(). + a new string that must be freed with g_free(). - a `PangoFontDescription` + a `PangoFontDescription` - Creates a string representation of a font description. + Creates a string representation of a font description. See [func@Pango.FontDescription.from_string] for a description of the format of the string representation. The family list in the string description will only have a terminating comma if the last word of the list is a valid style option. + - a new string that must be freed with g_free(). + a new string that must be freed with g_free(). - a `PangoFontDescription` + a `PangoFontDescription` - Unsets some of the fields in a `PangoFontDescription`. + Unsets some of the fields in a `PangoFontDescription`. The unset fields will get back to their default values. + - a `PangoFontDescription` + a `PangoFontDescription` - bitmask of fields in the @desc to unset. + bitmask of fields in the @desc to unset. - Creates a new font description from a string representation. + Creates a new font description from a string representation. The string must have the form @@ -3512,99 +3699,106 @@ size in the resulting font description will be set to 0. A typical example: "Cantarell Italic Light 15 \@wght=200" + - a new `PangoFontDescription`. + a new `PangoFontDescription`. - string representation of a font description. + string representation of a font description. - A `PangoFontFace` is used to represent a group of fonts with + A `PangoFontFace` is used to represent a group of fonts with the same family, slant, weight, and width, but varying sizes. + - Returns the family, style, variant, weight and stretch of + Returns the family, style, variant, weight and stretch of a `PangoFontFace`. The size field of the resulting font description will be unset. + - a newly-created `PangoFontDescription` structure + a newly-created `PangoFontDescription` structure holding the description of the face. Use [method@Pango.FontDescription.free] to free the result. - a `PangoFontFace` + a `PangoFontFace` - Gets a name representing the style of this face among the + Gets a name representing the style of this face among the different faces in the `PangoFontFamily` for the face. The name is suitable for displaying to users. + - the face name for the face. This string is + the face name for the face. This string is owned by the face object and must not be modified or freed. - a `PangoFontFace`. + a `PangoFontFace`. - Gets the `PangoFontFamily` that @face belongs to. + Gets the `PangoFontFamily` that @face belongs to. + - the `PangoFontFamily` + the `PangoFontFamily` - a `PangoFontFace` + a `PangoFontFace` - Returns whether a `PangoFontFace` is synthesized by the underlying + Returns whether a `PangoFontFace` is synthesized by the underlying font rendering engine from another face, perhaps by shearing, emboldening, or lightening it. + - whether @face is synthesized. + whether @face is synthesized. - a `PangoFontFace` + a `PangoFontFace` - List the available sizes for a font. + List the available sizes for a font. This is only applicable to bitmap fonts. For scalable fonts, stores %NULL at the location pointed to by @sizes and 0 at the location pointed to by @n_sizes. The sizes returned are in Pango units and are sorted in ascending order. + - a `PangoFontFace`. + a `PangoFontFace`. - + location to store a pointer to an array of int. This array should be freed with g_free(). @@ -3612,89 +3806,94 @@ in ascending order. - location to store the number of elements in @sizes + location to store the number of elements in @sizes - Returns the family, style, variant, weight and stretch of + Returns the family, style, variant, weight and stretch of a `PangoFontFace`. The size field of the resulting font description will be unset. + - a newly-created `PangoFontDescription` structure + a newly-created `PangoFontDescription` structure holding the description of the face. Use [method@Pango.FontDescription.free] to free the result. - a `PangoFontFace` + a `PangoFontFace` - Gets a name representing the style of this face among the + Gets a name representing the style of this face among the different faces in the `PangoFontFamily` for the face. The name is suitable for displaying to users. + - the face name for the face. This string is + the face name for the face. This string is owned by the face object and must not be modified or freed. - a `PangoFontFace`. + a `PangoFontFace`. - Gets the `PangoFontFamily` that @face belongs to. + Gets the `PangoFontFamily` that @face belongs to. + - the `PangoFontFamily` + the `PangoFontFamily` - a `PangoFontFace` + a `PangoFontFace` - Returns whether a `PangoFontFace` is synthesized by the underlying + Returns whether a `PangoFontFace` is synthesized by the underlying font rendering engine from another face, perhaps by shearing, emboldening, or lightening it. + - whether @face is synthesized. + whether @face is synthesized. - a `PangoFontFace` + a `PangoFontFace` - List the available sizes for a font. + List the available sizes for a font. This is only applicable to bitmap fonts. For scalable fonts, stores %NULL at the location pointed to by @sizes and 0 at the location pointed to by @n_sizes. The sizes returned are in Pango units and are sorted in ascending order. + - a `PangoFontFace`. + a `PangoFontFace`. - + location to store a pointer to an array of int. This array should be freed with g_free(). @@ -3702,7 +3901,7 @@ in ascending order. - location to store the number of elements in @sizes + location to store the number of elements in @sizes @@ -3712,19 +3911,21 @@ in ascending order. + + - the face name for the face. This string is + the face name for the face. This string is owned by the face object and must not be modified or freed. - a `PangoFontFace`. + a `PangoFontFace`. @@ -3732,15 +3933,16 @@ in ascending order. + - a newly-created `PangoFontDescription` structure + a newly-created `PangoFontDescription` structure holding the description of the face. Use [method@Pango.FontDescription.free] to free the result. - a `PangoFontFace` + a `PangoFontFace` @@ -3748,16 +3950,17 @@ in ascending order. + - a `PangoFontFace`. + a `PangoFontFace`. - + location to store a pointer to an array of int. This array should be freed with g_free(). @@ -3765,7 +3968,7 @@ in ascending order. - location to store the number of elements in @sizes + location to store the number of elements in @sizes @@ -3773,13 +3976,14 @@ in ascending order. + - whether @face is synthesized. + whether @face is synthesized. - a `PangoFontFace` + a `PangoFontFace` @@ -3787,13 +3991,14 @@ in ascending order. + - the `PangoFontFamily` + the `PangoFontFamily` - a `PangoFontFace` + a `PangoFontFace` @@ -3801,6 +4006,7 @@ in ascending order. + @@ -3808,6 +4014,7 @@ in ascending order. + @@ -3815,25 +4022,27 @@ in ascending order. - A `PangoFontFamily` is used to represent a family of related + A `PangoFontFamily` is used to represent a family of related font faces. The font faces in a family share a common design, but differ in slant, weight, width or other aspects. + - Gets the `PangoFontFace` of @family with the given name. + Gets the `PangoFontFace` of @family with the given name. + - the `PangoFontFace`, + the `PangoFontFace`, or %NULL if no face with the given name exists. - a `PangoFontFamily` + a `PangoFontFamily` - the name of a face. If the name is %NULL, + the name of a face. If the name is %NULL, the family's default face (fontconfig calls it "Regular") will be returned. @@ -3841,25 +4050,26 @@ slant, weight, width or other aspects. - Gets the name of the family. + Gets the name of the family. The name is unique among all fonts for the font backend and can be used in a `PangoFontDescription` to specify that a face from this family is desired. + - the name of the family. This string is owned + the name of the family. This string is owned by the family object and must not be modified or freed. - a `PangoFontFamily` + a `PangoFontFamily` - A monospace font is a font designed for text display where the the + A monospace font is a font designed for text display where the the characters form a regular grid. For Western languages this would @@ -3873,46 +4083,49 @@ The best way to find out the grid-cell size is to call [method@Pango.FontMetrics.get_approximate_digit_width], since the results of [method@Pango.FontMetrics.get_approximate_char_width] may be affected by double-width characters. + - %TRUE if the family is monospace. + %TRUE if the family is monospace. - a `PangoFontFamily` + a `PangoFontFamily` - A variable font is a font which has axes that can be modified to + A variable font is a font which has axes that can be modified to produce different faces. + - %TRUE if the family is variable + %TRUE if the family is variable - a `PangoFontFamily` + a `PangoFontFamily` - Lists the different font faces that make up @family. + Lists the different font faces that make up @family. The faces in a family share a common design, but differ in slant, weight, width and other aspects. + - a `PangoFontFamily` + a `PangoFontFamily` - + location to store an array of pointers to `PangoFontFace` objects, or %NULL. This array should be freed with g_free() when it is no longer needed. @@ -3921,25 +4134,26 @@ width and other aspects. - location to store number of elements in @faces. + location to store number of elements in @faces. - Gets the `PangoFontFace` of @family with the given name. + Gets the `PangoFontFace` of @family with the given name. + - the `PangoFontFace`, + the `PangoFontFace`, or %NULL if no face with the given name exists. - a `PangoFontFamily` + a `PangoFontFamily` - the name of a face. If the name is %NULL, + the name of a face. If the name is %NULL, the family's default face (fontconfig calls it "Regular") will be returned. @@ -3947,25 +4161,26 @@ width and other aspects. - Gets the name of the family. + Gets the name of the family. The name is unique among all fonts for the font backend and can be used in a `PangoFontDescription` to specify that a face from this family is desired. + - the name of the family. This string is owned + the name of the family. This string is owned by the family object and must not be modified or freed. - a `PangoFontFamily` + a `PangoFontFamily` - A monospace font is a font designed for text display where the the + A monospace font is a font designed for text display where the the characters form a regular grid. For Western languages this would @@ -3979,46 +4194,49 @@ The best way to find out the grid-cell size is to call [method@Pango.FontMetrics.get_approximate_digit_width], since the results of [method@Pango.FontMetrics.get_approximate_char_width] may be affected by double-width characters. + - %TRUE if the family is monospace. + %TRUE if the family is monospace. - a `PangoFontFamily` + a `PangoFontFamily` - A variable font is a font which has axes that can be modified to + A variable font is a font which has axes that can be modified to produce different faces. + - %TRUE if the family is variable + %TRUE if the family is variable - a `PangoFontFamily` + a `PangoFontFamily` - Lists the different font faces that make up @family. + Lists the different font faces that make up @family. The faces in a family share a common design, but differ in slant, weight, width and other aspects. + - a `PangoFontFamily` + a `PangoFontFamily` - + location to store an array of pointers to `PangoFontFace` objects, or %NULL. This array should be freed with g_free() when it is no longer needed. @@ -4027,7 +4245,7 @@ width and other aspects. - location to store number of elements in @faces. + location to store number of elements in @faces. @@ -4037,21 +4255,23 @@ width and other aspects. + + - a `PangoFontFamily` + a `PangoFontFamily` - + location to store an array of pointers to `PangoFontFace` objects, or %NULL. This array should be freed with g_free() when it is no longer needed. @@ -4060,7 +4280,7 @@ width and other aspects. - location to store number of elements in @faces. + location to store number of elements in @faces. @@ -4068,14 +4288,15 @@ width and other aspects. + - the name of the family. This string is owned + the name of the family. This string is owned by the family object and must not be modified or freed. - a `PangoFontFamily` + a `PangoFontFamily` @@ -4083,13 +4304,14 @@ width and other aspects. + - %TRUE if the family is monospace. + %TRUE if the family is monospace. - a `PangoFontFamily` + a `PangoFontFamily` @@ -4097,13 +4319,14 @@ width and other aspects. + - %TRUE if the family is variable + %TRUE if the family is variable - a `PangoFontFamily` + a `PangoFontFamily` @@ -4111,18 +4334,19 @@ width and other aspects. + - the `PangoFontFace`, + the `PangoFontFace`, or %NULL if no face with the given name exists. - a `PangoFontFamily` + a `PangoFontFamily` - the name of a face. If the name is %NULL, + the name of a face. If the name is %NULL, the family's default face (fontconfig calls it "Regular") will be returned. @@ -4132,6 +4356,7 @@ width and other aspects. + @@ -4139,30 +4364,33 @@ width and other aspects. - A `PangoFontMap` represents the set of fonts available for a + A `PangoFontMap` represents the set of fonts available for a particular rendering system. This is a virtual object with implementations being specific to particular rendering systems. + - Forces a change in the context, which will cause any `PangoContext` + Forces a change in the context, which will cause any `PangoContext` using this fontmap to change. This function is only useful when implementing a new backend for Pango, something applications won't do. Backends should call this function if they have attached extra data to the context and such data is changed. + - a `PangoFontMap` + a `PangoFontMap` + @@ -4176,24 +4404,25 @@ context and such data is changed. - Gets a font family by name. + Gets a font family by name. + - the `PangoFontFamily` + the `PangoFontFamily` - a `PangoFontMap` + a `PangoFontMap` - a family name + a family name - Returns the current serial number of @fontmap. + Returns the current serial number of @fontmap. The serial number is initialized to an small number larger than zero when a new fontmap is created and is increased whenever the fontmap @@ -4205,29 +4434,31 @@ fontmap resolution. This can be used to automatically detect changes to a `PangoFontMap`, like in `PangoContext`. + - The current serial number of @fontmap. + The current serial number of @fontmap. - a `PangoFontMap` + a `PangoFontMap` - List all families for a fontmap. + List all families for a fontmap. + - a `PangoFontMap` + a `PangoFontMap` - location to + location to store a pointer to an array of `PangoFontFamily` *. This array should be freed with g_free(). @@ -4235,80 +4466,83 @@ like in `PangoContext`. - location to store the number of elements in @families + location to store the number of elements in @families - Load the font in the fontmap that is the closest match for @desc. + Load the font in the fontmap that is the closest match for @desc. + - the newly allocated `PangoFont` + the newly allocated `PangoFont` loaded, or %NULL if no font matched. - a `PangoFontMap` + a `PangoFontMap` - the `PangoContext` the font will be used with + the `PangoContext` the font will be used with - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load - Load a set of fonts in the fontmap that can be used to render + Load a set of fonts in the fontmap that can be used to render a font matching @desc. + - the newly allocated + the newly allocated `PangoFontset` loaded, or %NULL if no font matched. - a `PangoFontMap` + a `PangoFontMap` - the `PangoContext` the font will be used with + the `PangoContext` the font will be used with - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load - a `PangoLanguage` the fonts will be used for + a `PangoLanguage` the fonts will be used for - Forces a change in the context, which will cause any `PangoContext` + Forces a change in the context, which will cause any `PangoContext` using this fontmap to change. This function is only useful when implementing a new backend for Pango, something applications won't do. Backends should call this function if they have attached extra data to the context and such data is changed. + - a `PangoFontMap` + a `PangoFontMap` - Creates a `PangoContext` connected to @fontmap. + Creates a `PangoContext` connected to @fontmap. This is equivalent to [ctor@Pango.Context.new] followed by [method@Pango.Context.set_font_map]. @@ -4317,37 +4551,39 @@ If you are using Pango as part of a higher-level system, that system may have it's own way of create a `PangoContext`. For instance, the GTK toolkit has, among others, gtk_widget_get_pango_context(). Use those instead. + - the newly allocated `PangoContext`, + the newly allocated `PangoContext`, which should be freed with g_object_unref(). - a `PangoFontMap` + a `PangoFontMap` - Gets a font family by name. + Gets a font family by name. + - the `PangoFontFamily` + the `PangoFontFamily` - a `PangoFontMap` + a `PangoFontMap` - a family name + a family name - Returns the current serial number of @fontmap. + Returns the current serial number of @fontmap. The serial number is initialized to an small number larger than zero when a new fontmap is created and is increased whenever the fontmap @@ -4359,29 +4595,31 @@ fontmap resolution. This can be used to automatically detect changes to a `PangoFontMap`, like in `PangoContext`. + - The current serial number of @fontmap. + The current serial number of @fontmap. - a `PangoFontMap` + a `PangoFontMap` - List all families for a fontmap. + List all families for a fontmap. + - a `PangoFontMap` + a `PangoFontMap` - location to + location to store a pointer to an array of `PangoFontFamily` *. This array should be freed with g_free(). @@ -4389,56 +4627,58 @@ like in `PangoContext`. - location to store the number of elements in @families + location to store the number of elements in @families - Load the font in the fontmap that is the closest match for @desc. + Load the font in the fontmap that is the closest match for @desc. + - the newly allocated `PangoFont` + the newly allocated `PangoFont` loaded, or %NULL if no font matched. - a `PangoFontMap` + a `PangoFontMap` - the `PangoContext` the font will be used with + the `PangoContext` the font will be used with - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load - Load a set of fonts in the fontmap that can be used to render + Load a set of fonts in the fontmap that can be used to render a font matching @desc. + - the newly allocated + the newly allocated `PangoFontset` loaded, or %NULL if no font matched. - a `PangoFontMap` + a `PangoFontMap` - the `PangoContext` the font will be used with + the `PangoContext` the font will be used with - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load - a `PangoLanguage` the fonts will be used for + a `PangoLanguage` the fonts will be used for @@ -4448,30 +4688,32 @@ a font matching @desc. - The `PangoFontMapClass` structure holds the virtual functions for + The `PangoFontMapClass` structure holds the virtual functions for a particular `PangoFontMap` implementation. + - parent `GObjectClass` + parent `GObjectClass` + - the newly allocated `PangoFont` + the newly allocated `PangoFont` loaded, or %NULL if no font matched. - a `PangoFontMap` + a `PangoFontMap` - the `PangoContext` the font will be used with + the `PangoContext` the font will be used with - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load @@ -4479,16 +4721,17 @@ a particular `PangoFontMap` implementation. + - a `PangoFontMap` + a `PangoFontMap` - location to + location to store a pointer to an array of `PangoFontFamily` *. This array should be freed with g_free(). @@ -4496,7 +4739,7 @@ a particular `PangoFontMap` implementation. - location to store the number of elements in @families + location to store the number of elements in @families @@ -4504,45 +4747,47 @@ a particular `PangoFontMap` implementation. + - the newly allocated + the newly allocated `PangoFontset` loaded, or %NULL if no font matched. - a `PangoFontMap` + a `PangoFontMap` - the `PangoContext` the font will be used with + the `PangoContext` the font will be used with - a `PangoFontDescription` describing the font to load + a `PangoFontDescription` describing the font to load - a `PangoLanguage` the fonts will be used for + a `PangoLanguage` the fonts will be used for - the type of rendering-system-dependent engines that + the type of rendering-system-dependent engines that can handle fonts of this fonts loaded with this fontmap. + - The current serial number of @fontmap. + The current serial number of @fontmap. - a `PangoFontMap` + a `PangoFontMap` @@ -4550,12 +4795,13 @@ can handle fonts of this fonts loaded with this fontmap. + - a `PangoFontMap` + a `PangoFontMap` @@ -4563,17 +4809,18 @@ can handle fonts of this fonts loaded with this fontmap. + - the `PangoFontFamily` + the `PangoFontFamily` - a `PangoFontMap` + a `PangoFontMap` - a family name + a family name @@ -4581,6 +4828,7 @@ can handle fonts of this fonts loaded with this fontmap. + @@ -4596,41 +4844,42 @@ can handle fonts of this fonts loaded with this fontmap. - The bits in a `PangoFontMask` correspond to the set fields in a + The bits in a `PangoFontMask` correspond to the set fields in a `PangoFontDescription`. - the font family is specified. + the font family is specified. - the font style is specified. + the font style is specified. - the font variant is specified. + the font variant is specified. - the font weight is specified. + the font weight is specified. - the font stretch is specified. + the font stretch is specified. - the font size is specified. + the font size is specified. - the font gravity is specified (Since: 1.16.) + the font gravity is specified (Since: 1.16.) - OpenType font variations are specified (Since: 1.42) + OpenType font variations are specified (Since: 1.42) - A `PangoFontMetrics` structure holds the overall metric information + A `PangoFontMetrics` structure holds the overall metric information for a font. The information in a `PangoFontMetrics` structure may be restricted to a script. The fields of this structure are private to implementations of a font backend. See the documentation of the corresponding getters for documentation of their meaning. + @@ -4662,230 +4911,245 @@ for documentation of their meaning. - Gets the approximate character width for a font metrics structure. + Gets the approximate character width for a font metrics structure. This is merely a representative value useful, for example, for determining the initial size for a window. Actual characters in text will be wider and narrower than this. + - the character width, in Pango units. + the character width, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the approximate digit width for a font metrics structure. + Gets the approximate digit width for a font metrics structure. This is merely a representative value useful, for example, for determining the initial size for a window. Actual digits in text can be wider or narrower than this, though this value is generally somewhat more accurate than the result of pango_font_metrics_get_approximate_char_width() for digits. + - the digit width, in Pango units. + the digit width, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the ascent from a font metrics structure. + Gets the ascent from a font metrics structure. The ascent is the distance from the baseline to the logical top of a line of text. (The logical top may be above or below the top of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.) + - the ascent, in Pango units. + the ascent, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the descent from a font metrics structure. + Gets the descent from a font metrics structure. The descent is the distance from the baseline to the logical bottom of a line of text. (The logical bottom may be above or below the bottom of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.) + - the descent, in Pango units. + the descent, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the line height from a font metrics structure. + Gets the line height from a font metrics structure. The line height is the distance between successive baselines in wrapped text. If the line height is not available, 0 is returned. + - the height, in Pango units + the height, in Pango units - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the suggested position to draw the strikethrough. + Gets the suggested position to draw the strikethrough. The value returned is the distance *above* the baseline of the top of the strikethrough. + - the suggested strikethrough position, in Pango units. + the suggested strikethrough position, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the suggested thickness to draw for the strikethrough. + Gets the suggested thickness to draw for the strikethrough. + - the suggested strikethrough thickness, in Pango units. + the suggested strikethrough thickness, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the suggested position to draw the underline. + Gets the suggested position to draw the underline. The value returned is the distance *above* the baseline of the top of the underline. Since most fonts have underline positions beneath the baseline, this value is typically negative. + - the suggested underline position, in Pango units. + the suggested underline position, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Gets the suggested thickness to draw for the underline. + Gets the suggested thickness to draw for the underline. + - the suggested underline thickness, in Pango units. + the suggested underline thickness, in Pango units. - a `PangoFontMetrics` structure + a `PangoFontMetrics` structure - Increase the reference count of a font metrics structure by one. + Increase the reference count of a font metrics structure by one. + - @metrics + @metrics - a `PangoFontMetrics` structure, may be %NULL + a `PangoFontMetrics` structure, may be %NULL - Decrease the reference count of a font metrics structure by one. + Decrease the reference count of a font metrics structure by one. If the result is zero, frees the structure and any associated memory. + - a `PangoFontMetrics` structure, may be %NULL + a `PangoFontMetrics` structure, may be %NULL - A `PangoFontset` represents a set of `PangoFont` to use when rendering text. + A `PangoFontset` represents a set of `PangoFont` to use when rendering text. A `PAngoFontset` is the result of resolving a `PangoFontDescription` against a particular `PangoContext`. It has operations for finding the component font for a particular Unicode character, and for finding a composite set of metrics for the entire fontset. + - Iterates through all the fonts in a fontset, calling @func for + Iterates through all the fonts in a fontset, calling @func for each one. If @func returns %TRUE, that stops the iteration. + - a `PangoFontset` + a `PangoFontset` - Callback function + Callback function - data to pass to the callback function + data to pass to the callback function - Returns the font in the fontset that contains the best glyph for a + Returns the font in the fontset that contains the best glyph for a Unicode character. + - a `PangoFont` + a `PangoFont` - a `PangoFontset` + a `PangoFontset` - a Unicode character + a Unicode character + @@ -4896,68 +5160,72 @@ Unicode character. - Get overall metric information for the fonts in the fontset. + Get overall metric information for the fonts in the fontset. + - a `PangoFontMetrics` object + a `PangoFontMetrics` object - a `PangoFontset` + a `PangoFontset` - Iterates through all the fonts in a fontset, calling @func for + Iterates through all the fonts in a fontset, calling @func for each one. If @func returns %TRUE, that stops the iteration. + - a `PangoFontset` + a `PangoFontset` - Callback function + Callback function - data to pass to the callback function + data to pass to the callback function - Returns the font in the fontset that contains the best glyph for a + Returns the font in the fontset that contains the best glyph for a Unicode character. + - a `PangoFont` + a `PangoFont` - a `PangoFontset` + a `PangoFontset` - a Unicode character + a Unicode character - Get overall metric information for the fonts in the fontset. + Get overall metric information for the fonts in the fontset. + - a `PangoFontMetrics` object + a `PangoFontMetrics` object - a `PangoFontset` + a `PangoFontset` @@ -4967,25 +5235,27 @@ Unicode character. - The `PangoFontsetClass` structure holds the virtual functions for + The `PangoFontsetClass` structure holds the virtual functions for a particular `PangoFontset` implementation. + - parent `GObjectClass` + parent `GObjectClass` + - a `PangoFont` + a `PangoFont` - a `PangoFontset` + a `PangoFontset` - a Unicode character + a Unicode character @@ -4993,13 +5263,14 @@ a particular `PangoFontset` implementation. + - a `PangoFontMetrics` object + a `PangoFontMetrics` object - a `PangoFontset` + a `PangoFontset` @@ -5007,6 +5278,7 @@ a particular `PangoFontset` implementation. + @@ -5019,20 +5291,21 @@ a particular `PangoFontset` implementation. + - a `PangoFontset` + a `PangoFontset` - Callback function + Callback function - data to pass to the callback function + data to pass to the callback function @@ -5040,6 +5313,7 @@ a particular `PangoFontset` implementation. + @@ -5047,6 +5321,7 @@ a particular `PangoFontset` implementation. + @@ -5054,6 +5329,7 @@ a particular `PangoFontset` implementation. + @@ -5061,6 +5337,7 @@ a particular `PangoFontset` implementation. + @@ -5068,177 +5345,193 @@ a particular `PangoFontset` implementation. - Callback used by pango_fontset_foreach() when enumerating + Callback used by pango_fontset_foreach() when enumerating fonts in a fontset. + - if %TRUE, stop iteration and return immediately. + if %TRUE, stop iteration and return immediately. - a `PangoFontset` + a `PangoFontset` - a font from @fontset + a font from @fontset - callback data + callback data - `PangoFontsetSimple` is a implementation of the abstract + `PangoFontsetSimple` is a implementation of the abstract `PangoFontset` base class as an array of fonts. When creating a `PangoFontsetSimple`, you have to provide the array of fonts that make up the fontset. + - Creates a new `PangoFontsetSimple` for the given language. + Creates a new `PangoFontsetSimple` for the given language. + - the newly allocated `PangoFontsetSimple` + the newly allocated `PangoFontsetSimple` - a `PangoLanguage` tag + a `PangoLanguage` tag - Adds a font to the fontset. + Adds a font to the fontset. + - a `PangoFontsetSimple`. + a `PangoFontsetSimple`. - a `PangoFont`. + a `PangoFont`. - Returns the number of fonts in the fontset. + Returns the number of fonts in the fontset. + - the size of @fontset + the size of @fontset - a `PangoFontsetSimple`. + a `PangoFontsetSimple`. - + + + - The way this unknown glyphs are rendered is backend specific. For example, + The way this unknown glyphs are rendered is backend specific. For example, a box with the hexadecimal Unicode code-point of the character written in it is what is done in the most common backends. + - a Unicode character + a Unicode character - A `PangoGlyph` value that indicates a zero-width empty glpyh. + A `PangoGlyph` value that indicates a zero-width empty glpyh. This is useful for example in shaper modules, to use as the glyph for various zero-width Unicode characters (those passing [func@is_zero_width]). + - A `PangoGlyph` value for invalid input. + A `PangoGlyph` value for invalid input. `PangoLayout` produces one such glyph per invalid input UTF-8 byte and such a glyph is rendered as a crossed box. Note that this value is defined such that it has the %PANGO_GLYPH_UNKNOWN_FLAG set. + - Flag used in `PangoGlyph` to turn a `gunichar` value of a valid Unicode + Flag used in `PangoGlyph` to turn a `gunichar` value of a valid Unicode character into an unknown-character glyph for that `gunichar`. Such unknown-character glyphs may be rendered as a 'hex box'. + - Whether a `PangoGravity` represents a gravity that results in reversal + Whether a `PangoGravity` represents a gravity that results in reversal of text direction. + - the `PangoGravity` to check + the `PangoGravity` to check - Whether a `PangoGravity` represents vertical writing directions. + Whether a `PangoGravity` represents vertical writing directions. + - the `PangoGravity` to check + the `PangoGravity` to check - The `PangoGlyphGeometry` structure contains width and positioning + The `PangoGlyphGeometry` structure contains width and positioning information for a single glyph. + - the logical width to use for the the character. + the logical width to use for the the character. - horizontal offset from nominal character position. + horizontal offset from nominal character position. - vertical offset from nominal character position. + vertical offset from nominal character position. - A `PangoGlyphInfo` structure represents a single glyph with + A `PangoGlyphInfo` structure represents a single glyph with positioning information and visual attributes. + - the glyph itself. + the glyph itself. - the positional information about the glyph. + the positional information about the glyph. - the visual attributes of the glyph. + the visual attributes of the glyph. - A `PangoGlyphItem` is a pair of a `PangoItem` and the glyphs + A `PangoGlyphItem` is a pair of a `PangoItem` and the glyphs resulting from shaping the items text. As an example of the usage of `PangoGlyphItem`, the results of shaping text with `PangoLayout` is a list of `PangoLayoutLine`, each of which contains a list of `PangoGlyphItem`. + - corresponding `PangoItem` + corresponding `PangoItem` - corresponding `PangoGlyphString` + corresponding `PangoGlyphString` - Splits a shaped item (`PangoGlyphItem`) into multiple items based + Splits a shaped item (`PangoGlyphItem`) into multiple items based on an attribute list. The idea is that if you have attributes that don't affect shaping, @@ -5255,8 +5548,9 @@ result items can have multiple attributes of the same type. This function takes ownership of @glyph_item; it will be reused as one of the elements in the list. + - a + a list of glyph items resulting from splitting @glyph_item. Free the elements using [method@Pango.GlyphItem.free], the list using g_slist_free(). @@ -5266,68 +5560,71 @@ as one of the elements in the list. - a shaped item + a shaped item - text that @list applies to + text that @list applies to - a `PangoAttrList` + a `PangoAttrList` - Make a deep copy of an existing `PangoGlyphItem` structure. + Make a deep copy of an existing `PangoGlyphItem` structure. + - the newly allocated `PangoGlyphItem` + the newly allocated `PangoGlyphItem` - a `PangoGlyphItem` + a `PangoGlyphItem` - Frees a `PangoGlyphItem` and resources to which it points. + Frees a `PangoGlyphItem` and resources to which it points. + - a `PangoGlyphItem` + a `PangoGlyphItem` - Given a `PangoGlyphItem` and the corresponding text, determine the + Given a `PangoGlyphItem` and the corresponding text, determine the width corresponding to each character. When multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters. See also [method@Pango.GlyphString.get_logical_widths]. + - a `PangoGlyphItem` + a `PangoGlyphItem` - text that @glyph_item corresponds to + text that @glyph_item corresponds to (glyph_item->item->offset is an offset from the start of @text) - an array whose length is the number of + an array whose length is the number of characters in glyph_item (equal to glyph_item->item->num_chars) to be filled in with the resulting character widths. @@ -5337,24 +5634,25 @@ See also [method@Pango.GlyphString.get_logical_widths]. - Adds spacing between the graphemes of @glyph_item to + Adds spacing between the graphemes of @glyph_item to give the effect of typographic letter spacing. + - a `PangoGlyphItem` + a `PangoGlyphItem` - text that @glyph_item corresponds to + text that @glyph_item corresponds to (glyph_item->item->offset is an offset from the start of @text) - logical attributes for the item + logical attributes for the item (the first logical attribute refers to the position before the first character in the item) @@ -5362,7 +5660,7 @@ give the effect of typographic letter spacing. - amount of letter spacing to add + amount of letter spacing to add in Pango units. May be negative, though too large negative values will give ugly results. @@ -5370,7 +5668,7 @@ give the effect of typographic letter spacing. - Modifies @orig to cover only the text after @split_index, and + Modifies @orig to cover only the text after @split_index, and returns a new item that covers the text before @split_index that used to be in @orig. @@ -5381,23 +5679,24 @@ assigned to each item, you can't create a zero-length item). This function is similar in function to pango_item_split() (and uses it internally.) + - the newly allocated item representing text before + the newly allocated item representing text before @split_index, which should be freed with pango_glyph_item_free(). - a `PangoItem` + a `PangoItem` - text to which positions in @orig apply + text to which positions in @orig apply - byte index of position to split item, relative to the + byte index of position to split item, relative to the start of the item @@ -5405,7 +5704,7 @@ it internally.) - A `PangoGlyphItemIter` is an iterator over the clusters in a + A `PangoGlyphItemIter` is an iterator over the clusters in a `PangoGlyphItem`. The *forward direction* of the iterator is the logical direction of text. @@ -5445,6 +5744,7 @@ the start variables is included in the cluster while the one pointed at by end variables is not. None of the members of a `PangoGlyphItemIter` should be modified manually. + @@ -5470,129 +5770,136 @@ None of the members of a `PangoGlyphItemIter` should be modified manually. - Make a shallow copy of an existing `PangoGlyphItemIter` structure. + Make a shallow copy of an existing `PangoGlyphItemIter` structure. + - the newly allocated `PangoGlyphItemIter` + the newly allocated `PangoGlyphItemIter` - a `PangoGlyphItem`Iter + a `PangoGlyphItem`Iter - Frees a `PangoGlyphItem`Iter. + Frees a `PangoGlyphItem`Iter. + - a `PangoGlyphItemIter` + a `PangoGlyphItemIter` - Initializes a `PangoGlyphItemIter` structure to point to the + Initializes a `PangoGlyphItemIter` structure to point to the last cluster in a glyph item. See `PangoGlyphItemIter` for details of cluster orders. + - %FALSE if there are no clusters in the glyph item + %FALSE if there are no clusters in the glyph item - a `PangoGlyphItemIter` + a `PangoGlyphItemIter` - the glyph item to iterate over + the glyph item to iterate over - text corresponding to the glyph item + text corresponding to the glyph item - Initializes a `PangoGlyphItemIter` structure to point to the + Initializes a `PangoGlyphItemIter` structure to point to the first cluster in a glyph item. See `PangoGlyphItemIter` for details of cluster orders. + - %FALSE if there are no clusters in the glyph item + %FALSE if there are no clusters in the glyph item - a `PangoGlyphItemIter` + a `PangoGlyphItemIter` - the glyph item to iterate over + the glyph item to iterate over - text corresponding to the glyph item + text corresponding to the glyph item - Advances the iterator to the next cluster in the glyph item. + Advances the iterator to the next cluster in the glyph item. See `PangoGlyphItemIter` for details of cluster orders. + - %TRUE if the iterator was advanced, + %TRUE if the iterator was advanced, %FALSE if we were already on the last cluster. - a `PangoGlyphItemIter` + a `PangoGlyphItemIter` - Moves the iterator to the preceding cluster in the glyph item. + Moves the iterator to the preceding cluster in the glyph item. See `PangoGlyphItemIter` for details of cluster orders. + - %TRUE if the iterator was moved, + %TRUE if the iterator was moved, %FALSE if we were already on the first cluster. - a `PangoGlyphItemIter` + a `PangoGlyphItemIter` - A `PangoGlyphString` is used to store strings of glyphs with geometry + A `PangoGlyphString` is used to store strings of glyphs with geometry and visual attribute information. The storage for the glyph information is owned by the structure which simplifies memory management. + - number of the glyphs in this glyph string. + number of the glyphs in this glyph string. - array of glyph information + array of glyph information for the glyph string. - logical cluster info, indexed by the byte index + logical cluster info, indexed by the byte index within the text corresponding to the glyph string. @@ -5600,28 +5907,30 @@ which simplifies memory management. - Create a new `PangoGlyphString`. + Create a new `PangoGlyphString`. + - the newly allocated `PangoGlyphString`, which + the newly allocated `PangoGlyphString`, which should be freed with [method@Pango.GlyphString.free]. - Copy a glyph string and associated storage. + Copy a glyph string and associated storage. + - the newly allocated `PangoGlyphString` + the newly allocated `PangoGlyphString` - a `PangoGlyphString` + a `PangoGlyphString` - Compute the logical and ink extents of a glyph string. + Compute the logical and ink extents of a glyph string. See the documentation for [method@Pango.Font.get_glyph_extents] for details about the interpretation of the rectangles. @@ -5629,109 +5938,113 @@ about the interpretation of the rectangles. Examples of logical (red) and ink (green) rects: ![](rects1.png) ![](rects2.png) + - a `PangoGlyphString` + a `PangoGlyphString` - a `PangoFont` + a `PangoFont` - rectangle used to store the extents of the glyph string as drawn + rectangle used to store the extents of the glyph string as drawn - rectangle used to store the logical extents of the glyph string + rectangle used to store the logical extents of the glyph string - Computes the extents of a sub-portion of a glyph string. + Computes the extents of a sub-portion of a glyph string. The extents are relative to the start of the glyph string range (the origin of their coordinate system is at the start of the range, not at the start of the entire glyph string). + - a `PangoGlyphString` + a `PangoGlyphString` - start index + start index - end index (the range is the set of bytes with + end index (the range is the set of bytes with indices such that start <= index < end) - a `PangoFont` + a `PangoFont` - rectangle used to + rectangle used to store the extents of the glyph string range as drawn - rectangle used to + rectangle used to store the logical extents of the glyph string range - Free a glyph string and associated storage. + Free a glyph string and associated storage. + - a `PangoGlyphString`, may be %NULL + a `PangoGlyphString`, may be %NULL - Given a `PangoGlyphString` and corresponding text, determine the width + Given a `PangoGlyphString` and corresponding text, determine the width corresponding to each character. When multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters. See also [method@Pango.GlyphItem.get_logical_widths]. + - a `PangoGlyphString` + a `PangoGlyphString` - the text corresponding to the glyphs + the text corresponding to the glyphs - the length of @text, in bytes + the length of @text, in bytes - the embedding level of the string + the embedding level of the string - an array whose length is the number of + an array whose length is the number of characters in text (equal to `g_utf8_strlen (text, length)` unless text has `NUL` bytes) to be filled in with the resulting character widths. @@ -5741,118 +6054,122 @@ See also [method@Pango.GlyphItem.get_logical_widths]. - Computes the logical width of the glyph string. + Computes the logical width of the glyph string. This can also be computed using [method@Pango.GlyphString.extents]. However, since this only computes the width, it's much faster. This is in fact only a convenience function that computes the sum of @geometry.width for each glyph in the @glyphs. + - the logical width of the glyph string. + the logical width of the glyph string. - a `PangoGlyphString` + a `PangoGlyphString` - Converts from character position to x position. + Converts from character position to x position. The X position is measured from the left edge of the run. Character positions are computed by dividing up each cluster into equal portions. + - the glyphs return from [func@shape] + the glyphs return from [func@shape] - the text for the run + the text for the run - the number of bytes (not characters) in @text. + the number of bytes (not characters) in @text. - the analysis information return from [func@itemize] + the analysis information return from [func@itemize] - the byte index within @text + the byte index within @text - whether we should compute the result for the beginning (%FALSE) + whether we should compute the result for the beginning (%FALSE) or end (%TRUE) of the character. - location to store result + location to store result - Resize a glyph string to the given length. + Resize a glyph string to the given length. + - a `PangoGlyphString`. + a `PangoGlyphString`. - the new length of the string + the new length of the string - Convert from x offset to character position. + Convert from x offset to character position. Character positions are computed by dividing up each cluster into equal portions. In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position. + - the glyphs returned from [func@shape] + the glyphs returned from [func@shape] - the text for the run + the text for the run - the number of bytes (not characters) in text. + the number of bytes (not characters) in text. - the analysis information return from [func@itemize] + the analysis information return from [func@itemize] - the x offset (in Pango units) + the x offset (in Pango units) - location to store calculated byte index within @text + location to store calculated byte index within @text - location to store a boolean indicating whether the + location to store a boolean indicating whether the user clicked on the leading or trailing edge of the character @@ -5860,13 +6177,14 @@ attributes for the text to compute the valid cursor position. - A `PangoGlyphVisAttr` structure communicates information between + A `PangoGlyphVisAttr` structure communicates information between the shaping and rendering phases. Currently, it contains only cluster start information. More attributes may be added in the future. + - set for the first logical glyph in each cluster. + set for the first logical glyph in each cluster. (Clusters are stored in visual order, within the cluster, glyphs are always ordered in logical order, since visual order is meaningless; that is, in Arabic text, accent glyphs follow the glyphs for the @@ -5875,7 +6193,7 @@ may be added in the future. - `PangoGravity` represents the orientation of glyphs in a segment + `PangoGravity` represents the orientation of glyphs in a segment of text. This is useful when rendering vertical text layouts. In those situations, @@ -5889,65 +6207,67 @@ Not every value in this enumeration makes sense for every usage of See also: [enum@Pango.GravityHint] - Glyphs stand upright (default) + Glyphs stand upright (default) - Glyphs are rotated 90 degrees clockwise + Glyphs are rotated 90 degrees clockwise - Glyphs are upside-down + Glyphs are upside-down - Glyphs are rotated 90 degrees counter-clockwise + Glyphs are rotated 90 degrees counter-clockwise - Gravity is resolved from the context matrix + Gravity is resolved from the context matrix - Finds the gravity that best matches the rotation component + Finds the gravity that best matches the rotation component in a `PangoMatrix`. + - the gravity of @matrix, which will never be + the gravity of @matrix, which will never be %PANGO_GRAVITY_AUTO, or %PANGO_GRAVITY_SOUTH if @matrix is %NULL - a `PangoMatrix` + a `PangoMatrix` - Returns the gravity to use in laying out a `PangoItem`. + Returns the gravity to use in laying out a `PangoItem`. The gravity is determined based on the script, base gravity, and hint. If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the preferred gravity of @script. To get the preferred gravity of a script, pass %PANGO_GRAVITY_AUTO and %PANGO_GRAVITY_HINT_STRONG in. + - resolved gravity suitable to use for a run of text + resolved gravity suitable to use for a run of text with @script - `PangoScript` to query + `PangoScript` to query - base gravity of the paragraph + base gravity of the paragraph - orientation hint + orientation hint - Returns the gravity to use in laying out a single character + Returns the gravity to use in laying out a single character or `PangoItem`. The gravity is determined based on the script, East Asian width, @@ -5962,203 +6282,224 @@ context. If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the preferred gravity of @script. + - resolved gravity suitable to use for a run of text + resolved gravity suitable to use for a run of text with @script and @wide. - `PangoScript` to query + `PangoScript` to query - %TRUE for wide characters as returned by g_unichar_iswide() + %TRUE for wide characters as returned by g_unichar_iswide() - base gravity of the paragraph + base gravity of the paragraph - orientation hint + orientation hint - Converts a `PangoGravity` value to its natural rotation in radians. + Converts a `PangoGravity` value to its natural rotation in radians. Note that [method@Pango.Matrix.rotate] takes angle in degrees, not radians. So, to call [method@Pango.Matrix,rotate] with the output of this function you should multiply it by (180. / G_PI). + - the rotation value corresponding to @gravity. + the rotation value corresponding to @gravity. - gravity to query, should not be %PANGO_GRAVITY_AUTO + gravity to query, should not be %PANGO_GRAVITY_AUTO - `PangoGravityHint` defines how horizontal scripts should behave in a + `PangoGravityHint` defines how horizontal scripts should behave in a vertical context. That is, English excerpts in a vertical paragraph for example. See also [enum@Pango.Gravity] - scripts will take their natural gravity based + scripts will take their natural gravity based on the base gravity and the script. This is the default. - always use the base gravity set, regardless of + always use the base gravity set, regardless of the script. - for scripts not in their natural direction (eg. + for scripts not in their natural direction (eg. Latin in East gravity), choose per-script gravity such that every script respects the line progression. This means, Latin and Arabic will take opposite gravities and both flow top-to-bottom for example. + + + + + + + + + + + + + + + + + - The `PangoItem` structure stores information about a segment of text. + The `PangoItem` structure stores information about a segment of text. You typically obtain `PangoItems` by itemizing a piece of text with [func@itemize]. + - byte offset of the start of this item in text. + byte offset of the start of this item in text. - length of this item in bytes. + length of this item in bytes. - number of Unicode characters in the item. + number of Unicode characters in the item. - analysis results for the item. + analysis results for the item. - Creates a new `PangoItem` structure initialized to default values. + Creates a new `PangoItem` structure initialized to default values. + - the newly allocated `PangoItem`, which should + the newly allocated `PangoItem`, which should be freed with [method@Pango.Item.free]. - Add attributes to a `PangoItem`. + Add attributes to a `PangoItem`. The idea is that you have attributes that don't affect itemization, such as font features, so you filter them out using @@ -6169,47 +6510,50 @@ The @iter should be positioned before the range of the item, and will be advanced past it. This function is meant to be called in a loop over the items resulting from itemization, while passing the iter to each call. + - a `PangoItem` + a `PangoItem` - a `PangoAttrIterator` + a `PangoAttrIterator` - Copy an existing `PangoItem` structure. + Copy an existing `PangoItem` structure. + - the newly allocated `PangoItem` + the newly allocated `PangoItem` - a `PangoItem` + a `PangoItem` - Free a `PangoItem` and all associated memory. + Free a `PangoItem` and all associated memory. + - a `PangoItem`, may be %NULL + a `PangoItem`, may be %NULL - Modifies @orig to cover only the text after @split_index, and + Modifies @orig to cover only the text after @split_index, and returns a new item that covers the text before @split_index that used to be in @orig. @@ -6221,68 +6565,74 @@ assigned to each item, you can't create a zero-length item). provided because the text used to generate the item isn't available, so `pango_item_split()` can't count the char length of the split items itself. + - new item representing text before @split_index, which + new item representing text before @split_index, which should be freed with [method@Pango.Item.free]. - a `PangoItem` + a `PangoItem` - byte index of position to split item, relative to the + byte index of position to split item, relative to the start of the item - number of chars between start of @orig and @split_index + number of chars between start of @orig and @split_index + + + - Extracts the *left bearing* from a `PangoRectangle` + Extracts the *left bearing* from a `PangoRectangle` representing glyph extents. The left bearing is the distance from the horizontal origin to the farthest left point of the character. This is positive for characters drawn completely to the right of the glyph origin. + - a `PangoRectangle` + a `PangoRectangle` - The `PangoLanguage` structure is used to + The `PangoLanguage` structure is used to represent a language. `PangoLanguage` pointers can be efficiently copied and compared with each other. + - Get a string that is representative of the characters needed to + Get a string that is representative of the characters needed to render a particular language. The sample text may be a pangram, but is not necessarily. It is chosen @@ -6301,19 +6651,20 @@ language code "xx". That is, compare to: ``` pango_language_get_sample_string (pango_language_from_string ("xx")) ``` + - the sample string + the sample string - a `PangoLanguage` + a `PangoLanguage` - Determines the scripts used to to write @language. + Determines the scripts used to to write @language. If nothing is known about the language tag @language, or if @language is %NULL, then %NULL is returned. @@ -6336,8 +6687,9 @@ function internally. Note: while the return value is declared as `PangoScript`, the returned values are from the `GUnicodeScript` enumeration, which may have more values. Callers need to handle unknown values. + - + An array of `PangoScript` values, with the number of entries in the array stored in @num_scripts, or %NULL if Pango does not have any information about this particular language tag (also the case @@ -6348,18 +6700,18 @@ may have more values. Callers need to handle unknown values. - a `PangoLanguage` + a `PangoLanguage` - location to + location to return number of scripts - Determines if @script is one of the scripts used to + Determines if @script is one of the scripts used to write @language. The returned value is conservative; if nothing is known about @@ -6372,42 +6724,44 @@ a particular section of text. It probably is not useful for applications in most circumstances. This function uses [method@Pango.Language.get_scripts] internally. + - %TRUE if @script is one of the scripts used + %TRUE if @script is one of the scripts used to write @language or if nothing is known about @language (including the case that @language is %NULL), %FALSE otherwise. - a `PangoLanguage` + a `PangoLanguage` - a `PangoScript` + a `PangoScript` - Checks if a language tag matches one of the elements in a list of + Checks if a language tag matches one of the elements in a list of language ranges. A language tag is considered to match a range in the list if the range is '*', the range is exactly the tag, or the range is a prefix of the tag, and the character after it in the tag is '-'. + - %TRUE if a match was found + %TRUE if a match was found - a language tag (see [func@Pango.Language.from_string]), + a language tag (see [func@Pango.Language.from_string]), %NULL is allowed and matches nothing but '*' - a list of language ranges, separated by ';', ':', + a list of language ranges, separated by ';', ':', ',', or space characters. Each element must either be '*', or a RFC 3066 language range canonicalized as by [func@Pango.Language.from_string] @@ -6416,21 +6770,22 @@ of the tag, and the character after it in the tag is '-'. - Gets the RFC-3066 format string representing the given language tag. + Gets the RFC-3066 format string representing the given language tag. Returns (transfer none): a string representing the language tag + - a language tag. + a language tag. - Convert a language tag to a `PangoLanguage`. + Convert a language tag to a `PangoLanguage`. The language tag must be in a RFC-3066 format. `PangoLanguage` pointers can be efficiently copied (copy the pointer) and compared with other @@ -6442,19 +6797,20 @@ than letters and '-'. Use [func@Pango.Language.get_default] if you want to get the `PangoLanguage` for the current locale of the process. + - a `PangoLanguage` + a `PangoLanguage` - a string representing a language tag + a string representing a language tag - Returns the `PangoLanguage` for the current locale of the process. + Returns the `PangoLanguage` for the current locale of the process. On Unix systems, this is the return value is derived from `setlocale (LC_CTYPE, NULL)`, and the user can @@ -6481,13 +6837,14 @@ functions automatically (by calling gtk_set_locale()). See the setlocale() manpage for more details. Note that the default language can change over the life of an application. + - the default language as a `PangoLanguage` + the default language as a `PangoLanguage` - Returns the list of languages that the user prefers. + Returns the list of languages that the user prefers. The list is specified by the `PANGO_LANGUAGE` or `LANGUAGE` environment variables, in order of preference. Note that this @@ -6498,15 +6855,16 @@ When choosing language-specific resources, such as the sample text returned by [method@Pango.Language.get_sample_string], you should first try the default language, followed by the languages returned by this function. + - a %NULL-terminated array + a %NULL-terminated array of `PangoLanguage`* - A `PangoLayout` structure represents an entire paragraph of text. + A `PangoLayout` structure represents an entire paragraph of text. While complete access to the layout capabilities of Pango is provided using the detailed interfaces for itemization and shaping, using @@ -6531,139 +6889,149 @@ There are a number of parameters to adjust the formatting of a It is possible, as well, to ignore the 2-D setup, and simply treat the results of a `PangoLayout` as a list of lines. + - Create a new `PangoLayout` object with attributes initialized to + Create a new `PangoLayout` object with attributes initialized to default values for a particular `PangoContext`. + - the newly allocated `PangoLayout` + the newly allocated `PangoLayout` - a `PangoContext` + a `PangoContext` - Forces recomputation of any state in the `PangoLayout` that + Forces recomputation of any state in the `PangoLayout` that might depend on the layout's context. This function should be called if you make changes to the context subsequent to creating the layout. + - a `PangoLayout` + a `PangoLayout` - Creates a deep copy-by-value of the layout. + Creates a deep copy-by-value of the layout. The attribute list, tab array, and text from the original layout are all copied by value. + - the newly allocated `PangoLayout` + the newly allocated `PangoLayout` - a `PangoLayout` + a `PangoLayout` - Gets the alignment for the layout: how partial lines are + Gets the alignment for the layout: how partial lines are positioned within the horizontal space available. + - the alignment + the alignment - a `PangoLayout` + a `PangoLayout` - Gets the attribute list for the layout, if any. + Gets the attribute list for the layout, if any. + - a `PangoAttrList` + a `PangoAttrList` - a `PangoLayout` + a `PangoLayout` - Gets whether to calculate the base direction for the layout + Gets whether to calculate the base direction for the layout according to its contents. See [method@Pango.Layout.set_auto_dir]. + - %TRUE if the bidirectional base direction + %TRUE if the bidirectional base direction is computed from the layout's contents, %FALSE otherwise - a `PangoLayout` + a `PangoLayout` - Gets the Y position of baseline of the first line in @layout. + Gets the Y position of baseline of the first line in @layout. + - baseline of first line, from top of @layout + baseline of first line, from top of @layout - a `PangoLayout` + a `PangoLayout` - Returns the number of Unicode characters in the + Returns the number of Unicode characters in the the text of @layout. + - the number of Unicode characters + the number of Unicode characters in the text of @layout - a `PangoLayout` + a `PangoLayout` - Retrieves the `PangoContext` used for this layout. + Retrieves the `PangoContext` used for this layout. + - the `PangoContext` for the layout + the `PangoContext` for the layout - a `PangoLayout` + a `PangoLayout` - Given an index within a layout, determines the positions that of the + Given an index within a layout, determines the positions that of the strong and weak cursors if the insertion point is at that index. The position of each cursor is stored as a zero-width rectangle. @@ -6671,65 +7039,68 @@ The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted. + - a `PangoLayout` + a `PangoLayout` - the byte index of the cursor + the byte index of the cursor - location to store the strong cursor position + location to store the strong cursor position - location to store the weak cursor position + location to store the weak cursor position - Gets the text direction at the given character position in @layout. + Gets the text direction at the given character position in @layout. + - the text direction at @index + the text direction at @index - a `PangoLayout` + a `PangoLayout` - the byte index of the char + the byte index of the char - Gets the type of ellipsization being performed for @layout. + Gets the type of ellipsization being performed for @layout. See [method@Pango.Layout.set_ellipsize]. Use [method@Pango.Layout.is_ellipsized] to query whether any paragraphs were actually ellipsized. + - the current ellipsization mode for @layout + the current ellipsization mode for @layout - a `PangoLayout` + a `PangoLayout` - Computes the logical and ink extents of @layout. + Computes the logical and ink extents of @layout. Logical extents are usually what you want for positioning things. Note that both extents may have non-zero x and y. You may want to use those @@ -6739,106 +7110,113 @@ in a layout with a set width. The extents are given in layout coordinates and in Pango units; layout coordinates begin at the top left corner of the layout. + - a `PangoLayout` + a `PangoLayout` - rectangle used to store the extents of the + rectangle used to store the extents of the layout as drawn - rectangle used to store the logical + rectangle used to store the logical extents of the layout - Gets the font description for the layout, if any. + Gets the font description for the layout, if any. + - a pointer to the + a pointer to the layout's font description, or %NULL if the font description from the layout's context is inherited. - a `PangoLayout` + a `PangoLayout` - Gets the height of layout used for ellipsization. + Gets the height of layout used for ellipsization. See [method@Pango.Layout.set_height] for details. + - the height, in Pango units if positive, + the height, in Pango units if positive, or number of lines if negative. - a `PangoLayout` + a `PangoLayout` - Gets the paragraph indent width in Pango units. + Gets the paragraph indent width in Pango units. A negative value indicates a hanging indentation. + - the indent in Pango units + the indent in Pango units - a `PangoLayout` + a `PangoLayout` - Returns an iterator to iterate over the visual extents of the layout. + Returns an iterator to iterate over the visual extents of the layout. + - the new `PangoLayoutIter` + the new `PangoLayoutIter` - a `PangoLayout` + a `PangoLayout` - Gets whether each complete line should be stretched to fill the entire + Gets whether each complete line should be stretched to fill the entire width of the layout. + - the justify value + the justify value - a `PangoLayout` + a `PangoLayout` - Retrieves a particular line from a `PangoLayout`. + Retrieves a particular line from a `PangoLayout`. Use the faster [method@Pango.Layout.get_line_readonly] if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.). + - the requested `PangoLayoutLine`, + the requested `PangoLayoutLine`, or %NULL if the index is out of range. This layout line can be ref'ed and retained, but will become invalid if changes are made to the `PangoLayout`. @@ -6846,37 +7224,39 @@ plan to modify the contents of the line (glyphs, glyph widths, etc.). - a `PangoLayout` + a `PangoLayout` - the index of a line, which must be between 0 and + the index of a line, which must be between 0 and `pango_layout_get_line_count(layout) - 1`, inclusive. - Retrieves the count of lines for the @layout. + Retrieves the count of lines for the @layout. + - the line count + the line count - `PangoLayout` + `PangoLayout` - Retrieves a particular line from a `PangoLayout`. + Retrieves a particular line from a `PangoLayout`. This is a faster alternative to [method@Pango.Layout.get_line], but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.). + - the requested `PangoLayoutLine`, + the requested `PangoLayoutLine`, or %NULL if the index is out of range. This layout line can be ref'ed and retained, but will become invalid if changes are made to the `PangoLayout`. No changes should be made to the line. @@ -6884,37 +7264,39 @@ but the user is not expected to modify the contents of the line - a `PangoLayout` + a `PangoLayout` - the index of a line, which must be between 0 and + the index of a line, which must be between 0 and `pango_layout_get_line_count(layout) - 1`, inclusive. - Gets the line spacing factor of @layout. + Gets the line spacing factor of @layout. See [method@Pango.Layout.set_line_spacing]. + - a `PangoLayout` + a `PangoLayout` - Returns the lines of the @layout as a list. + Returns the lines of the @layout as a list. Use the faster [method@Pango.Layout.get_lines_readonly] if you do not plan to modify the contents of the lines (glyphs, glyph widths, etc.). + - a `GSList` + a `GSList` containing the lines in the layout. This points to internal data of the `PangoLayout` and must be used with care. It will become invalid on any change to the layout's text or properties. @@ -6924,19 +7306,20 @@ plan to modify the contents of the lines (glyphs, glyph widths, etc.). - a `PangoLayout` + a `PangoLayout` - Returns the lines of the @layout as a list. + Returns the lines of the @layout as a list. This is a faster alternative to [method@Pango.Layout.get_lines], but the user is not expected to modify the contents of the lines (glyphs, glyph widths, etc.). + - a `GSList` + a `GSList` containing the lines in the layout. This points to internal data of the `PangoLayout` and must be used with care. It will become invalid on any change to the layout's text or properties. No changes should be made to @@ -6947,24 +7330,25 @@ but the user is not expected to modify the contents of the lines - a `PangoLayout` + a `PangoLayout` - Retrieves an array of logical attributes for each character in + Retrieves an array of logical attributes for each character in the @layout. + - a `PangoLayout` + a `PangoLayout` - + location to store a pointer to an array of logical attributes. This value must be freed with g_free(). @@ -6972,7 +7356,7 @@ the @layout. - location to store the number of the attributes in the + location to store the number of the attributes in the array. (The stored value will be one more than the total number of characters in the layout, since there need to be attributes corresponding to both the position before the first character @@ -6982,7 +7366,7 @@ the @layout. - Retrieves an array of logical attributes for each character in + Retrieves an array of logical attributes for each character in the @layout. This is a faster alternative to [method@Pango.Layout.get_log_attrs]. @@ -6993,78 +7377,81 @@ The number of attributes returned in @n_attrs will be one more than the total number of characters in the layout, since there need to be attributes corresponding to both the position before the first character and the position after the last character. + - an array of logical attributes + an array of logical attributes - a `PangoLayout` + a `PangoLayout` - location to store the number of the attributes in + location to store the number of the attributes in the array - Computes the logical and ink extents of @layout in device units. + Computes the logical and ink extents of @layout in device units. This function just calls [method@Pango.Layout.get_extents] followed by two [func@extents_to_pixels] calls, rounding @ink_rect and @logical_rect such that the rounded rectangles fully contain the unrounded one (that is, passes them as first argument to [func@Pango.extents_to_pixels]). + - a `PangoLayout` + a `PangoLayout` - rectangle used to store the extents of the + rectangle used to store the extents of the layout as drawn - rectangle used to store the logical + rectangle used to store the logical extents of the layout - Determines the logical width and height of a `PangoLayout` in device + Determines the logical width and height of a `PangoLayout` in device units. [method@Pango.Layout.get_size] returns the width and height scaled by %PANGO_SCALE. This is simply a convenience function around [method@Pango.Layout.get_pixel_extents]. + - a `PangoLayout` + a `PangoLayout` - location to store the logical width + location to store the logical width - location to store the logical height + location to store the logical height - Returns the current serial number of @layout. + Returns the current serial number of @layout. The serial number is initialized to an small number larger than zero when a new layout is created and is increased whenever the layout is @@ -7076,249 +7463,262 @@ This can be used to automatically detect changes to a `PangoLayout`, and is useful for example to decide whether a layout needs redrawing. To force the serial to be increased, use [method@Pango.Layout.context_changed]. + - The current serial number of @layout. + The current serial number of @layout. - a `PangoLayout` + a `PangoLayout` - Obtains whether @layout is in single paragraph mode. + Obtains whether @layout is in single paragraph mode. See [method@Pango.Layout.set_single_paragraph_mode]. + - %TRUE if the layout does not break paragraphs + %TRUE if the layout does not break paragraphs at paragraph separator characters, %FALSE otherwise - a `PangoLayout` + a `PangoLayout` - Determines the logical width and height of a `PangoLayout` in Pango + Determines the logical width and height of a `PangoLayout` in Pango units. This is simply a convenience function around [method@Pango.Layout.get_extents]. + - a `PangoLayout` + a `PangoLayout` - location to store the logical width + location to store the logical width - location to store the logical height + location to store the logical height - Gets the amount of spacing between the lines of the layout. + Gets the amount of spacing between the lines of the layout. + - the spacing in Pango units + the spacing in Pango units - a `PangoLayout` + a `PangoLayout` - Gets the current `PangoTabArray` used by this layout. + Gets the current `PangoTabArray` used by this layout. If no `PangoTabArray` has been set, then the default tabs are in use and %NULL is returned. Default tabs are every 8 spaces. The return value should be freed with [method@Pango.TabArray.free]. + - a copy of the tabs for this layout + a copy of the tabs for this layout - a `PangoLayout` + a `PangoLayout` - Gets the text in the layout. + Gets the text in the layout. The returned text should not be freed or modified. + - the text in the @layout + the text in the @layout - a `PangoLayout` + a `PangoLayout` - Counts the number of unknown glyphs in @layout. + Counts the number of unknown glyphs in @layout. This function can be used to determine if there are any fonts available to render all characters in a certain string, or when used in combination with %PANGO_ATTR_FALLBACK, to check if a certain font supports all the characters in the string. + - The number of unknown glyphs in @layout + The number of unknown glyphs in @layout - a `PangoLayout` + a `PangoLayout` - Gets the width to which the lines of the `PangoLayout` should wrap. + Gets the width to which the lines of the `PangoLayout` should wrap. + - the width in Pango units, or -1 if no width set. + the width in Pango units, or -1 if no width set. - a `PangoLayout` + a `PangoLayout` - Gets the wrap mode for the layout. + Gets the wrap mode for the layout. Use [method@Pango.Layout.is_wrapped] to query whether any paragraphs were actually wrapped. + - active wrap mode. + active wrap mode. - a `PangoLayout` + a `PangoLayout` - Converts from byte @index_ within the @layout to line and X position. + Converts from byte @index_ within the @layout to line and X position. The X position is measured from the left edge of the line. + - a `PangoLayout` + a `PangoLayout` - the byte index of a grapheme within the layout + the byte index of a grapheme within the layout - an integer indicating the edge of the grapheme to retrieve the + an integer indicating the edge of the grapheme to retrieve the position of. If > 0, the trailing edge of the grapheme, if 0, the leading of the grapheme - location to store resulting line index. (which will + location to store resulting line index. (which will between 0 and pango_layout_get_line_count(layout) - 1) - location to store resulting position within line + location to store resulting position within line (%PANGO_SCALE units per device unit) - Converts from an index within a `PangoLayout` to the onscreen position + Converts from an index within a `PangoLayout` to the onscreen position corresponding to the grapheme at that index. The return value is represented as rectangle. Note that `pos->x` is always the leading edge of the grapheme and `pos->x + pos->width` the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then `pos->width` will be negative. + - a `PangoLayout` + a `PangoLayout` - byte index within @layout + byte index within @layout - rectangle in which to store the position of the grapheme + rectangle in which to store the position of the grapheme - Queries whether the layout had to ellipsize any paragraphs. + Queries whether the layout had to ellipsize any paragraphs. This returns %TRUE if the ellipsization mode for @layout is not %PANGO_ELLIPSIZE_NONE, a positive width is set on @layout, and there are paragraphs exceeding that width that have to be ellipsized. + - %TRUE if any paragraphs had to be ellipsized, + %TRUE if any paragraphs had to be ellipsized, %FALSE otherwise - a `PangoLayout` + a `PangoLayout` - Queries whether the layout had to wrap any paragraphs. + Queries whether the layout had to wrap any paragraphs. This returns %TRUE if a positive width is set on @layout, ellipsization mode of @layout is set to %PANGO_ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped. + - %TRUE if any paragraphs had to be wrapped, %FALSE + %TRUE if any paragraphs had to be wrapped, %FALSE otherwise - a `PangoLayout` + a `PangoLayout` - Computes a new cursor position from an old position and a count of + Computes a new cursor position from an old position and a count of positions to move visually. If @direction is positive, then the new strong cursor position will be @@ -7335,44 +7735,45 @@ Motion here is in cursor positions, not in characters, so a single call to [method@Pango.Layout.move_cursor_visually] may move the cursor over multiple characters when multiple characters combine to form a single grapheme. + - a `PangoLayout` + a `PangoLayout` - whether the moving cursor is the strong cursor or the + whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout. - the byte index of the grapheme for the old index + the byte index of the grapheme for the old index - if 0, the cursor was at the leading edge of the + if 0, the cursor was at the leading edge of the grapheme indicated by @old_index, if > 0, the cursor was at the trailing edge. - direction to move cursor. A negative + direction to move cursor. A negative value indicates motion to the left - location to store the new cursor byte index. + location to store the new cursor byte index. A value of -1 indicates that the cursor has been moved off the beginning of the layout. A value of %G_MAXINT indicates that the cursor has been moved off the end of the layout. - number of characters to move forward from + number of characters to move forward from the location returned for @new_index to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the @@ -7383,44 +7784,46 @@ single grapheme. - Sets the alignment for the layout: how partial lines are + Sets the alignment for the layout: how partial lines are positioned within the horizontal space available. The default alignment is %PANGO_ALIGN_LEFT. + - a `PangoLayout` + a `PangoLayout` - the alignment + the alignment - Sets the text attributes for a layout object. + Sets the text attributes for a layout object. References @attrs, so the caller can unref its reference. + - a `PangoLayout` + a `PangoLayout` - a `PangoAttrList` + a `PangoAttrList` - Sets whether to calculate the base direction + Sets whether to calculate the base direction for the layout according to its contents. When this flag is on (the default), then paragraphs in @layout that @@ -7436,23 +7839,24 @@ layout is done according to the base direction of the layout's When the auto-computed direction of a paragraph differs from the base direction of the context, the interpretation of %PANGO_ALIGN_LEFT and %PANGO_ALIGN_RIGHT are swapped. + - a `PangoLayout` + a `PangoLayout` - if %TRUE, compute the bidirectional base direction + if %TRUE, compute the bidirectional base direction from the layout's contents - Sets the type of ellipsization being performed for @layout. + Sets the type of ellipsization being performed for @layout. Depending on the ellipsization mode @ellipsize text is removed from the start, middle, or end of text so they @@ -7467,42 +7871,44 @@ is ellipsized as a whole depends on the set height of the layout. The default value is %PANGO_ELLIPSIZE_NONE. See [method@Pango.Layout.set_height] for details. + - a `PangoLayout` + a `PangoLayout` - the new ellipsization mode for @layout + the new ellipsization mode for @layout - Sets the default font description for the layout. + Sets the default font description for the layout. If no font description is set on the layout, the font description from the layout's context is used. + - a `PangoLayout` + a `PangoLayout` - the new `PangoFontDescription` + the new `PangoFontDescription` to unset the current font description - Sets the height to which the `PangoLayout` should be ellipsized at. + Sets the height to which the `PangoLayout` should be ellipsized at. There are two different behaviors, based on whether @height is positive or negative. @@ -7527,23 +7933,24 @@ Height setting only has effect if a positive width is set on The behavior is undefined if a height other than -1 is set and ellipsization mode is set to %PANGO_ELLIPSIZE_NONE, and may change in the future. + - a `PangoLayout`. + a `PangoLayout`. - the desired height of the layout in Pango units if positive, + the desired height of the layout in Pango units if positive, or desired number of lines if negative. - Sets the width in Pango units to indent each paragraph. + Sets the width in Pango units to indent each paragraph. A negative value of @indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent @@ -7553,22 +7960,23 @@ The indent setting is ignored if layout alignment is set to %PANGO_ALIGN_CENTER. The default value is 0. + - a `PangoLayout` + a `PangoLayout` - the amount by which to indent + the amount by which to indent - Sets whether each complete line should be stretched to fill the + Sets whether each complete line should be stretched to fill the entire width of the layout. Stretching is typically done by adding whitespace, but for some scripts @@ -7579,22 +7987,23 @@ Note that this setting is not implemented and so is ignored in Pango older than 1.18. The default value is %FALSE. + - a `PangoLayout` + a `PangoLayout` - whether the lines in the layout should be justified + whether the lines in the layout should be justified - Sets a factor for line spacing. + Sets a factor for line spacing. Typical values are: 0, 1, 1.5, 2. The default values is 0. @@ -7607,22 +8016,23 @@ where height2 is the line height of the second line set with [method@Pango.Layout.set_spacing] is ignored. If @factor is zero (the default), spacing is applied as before. + - a `PangoLayout` + a `PangoLayout` - the new line spacing factor + the new line spacing factor - Sets the layout text and attribute list from marked-up text. + Sets the layout text and attribute list from marked-up text. See [Pango Markup](pango_markup.html)). @@ -7630,27 +8040,28 @@ Replaces the current text and attribute list. This is the same as [method@Pango.Layout.set_markup_with_accel], but the markup text isn't scanned for accelerators. + - a `PangoLayout` + a `PangoLayout` - marked-up text + marked-up text - length of marked-up text in bytes, or -1 if @markup is + length of marked-up text in bytes, or -1 if @markup is `NUL`-terminated - Sets the layout text and attribute list from marked-up text. + Sets the layout text and attribute list from marked-up text. See [Pango Markup](pango_markup.html)). @@ -7663,36 +8074,37 @@ as an accelerator will receive a %PANGO_UNDERLINE_LOW attribute, and the first character so marked will be returned in @accel_char. Two @accel_marker characters following each other produce a single literal @accel_marker character. + - a `PangoLayout` + a `PangoLayout` - marked-up text (see [Pango Markup](pango_markup.html)) + marked-up text (see [Pango Markup](pango_markup.html)) - length of marked-up text in bytes, or -1 if @markup is + length of marked-up text in bytes, or -1 if @markup is `NUL`-terminated - marker for accelerators in the text + marker for accelerators in the text - return location + return location for first located accelerator - Sets the single paragraph mode of @layout. + Sets the single paragraph mode of @layout. If @setting is %TRUE, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, @@ -7700,22 +8112,23 @@ and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line. The default value is %FALSE. + - a `PangoLayout` + a `PangoLayout` - new setting + new setting - Sets the amount of spacing in Pango units between + Sets the amount of spacing in Pango units between the lines of the layout. When placing lines with spacing, Pango arranges things so that @@ -7728,42 +8141,44 @@ Note: Since 1.44, Pango is using the line height (as determined by the font) for placing lines when the line height factor is set to a non-zero value with [method@Pango.Layout.set_line_spacing]. In that case, the @spacing set with this function is ignored. + - a `PangoLayout` + a `PangoLayout` - the amount of spacing + the amount of spacing - Sets the tabs to use for @layout, overriding the default tabs. + Sets the tabs to use for @layout, overriding the default tabs. By default, tabs are every 8 spaces. If @tabs is %NULL, the default tabs are reinstated. @tabs is copied into the layout; you must free your copy of @tabs yourself. + - a `PangoLayout` + a `PangoLayout` - a `PangoTabArray` + a `PangoTabArray` - Sets the text of the layout. + Sets the text of the layout. This function validates @text and renders invalid UTF-8 with a placeholder glyph. @@ -7773,20 +8188,21 @@ Note that if you have used [method@Pango.Layout.set_markup] or may want to call [method@Pango.Layout.set_attributes] to clear the attributes set on the layout from the markup as this function does not clear attributes. + - a `PangoLayout` + a `PangoLayout` - the text + the text - maximum length of @text, in bytes. -1 indicates that + maximum length of @text, in bytes. -1 indicates that the string is nul-terminated and the length should be calculated. The text will also be truncated on encountering a nul-termination even when @length is positive. @@ -7795,49 +8211,51 @@ not clear attributes. - Sets the width to which the lines of the `PangoLayout` should wrap or + Sets the width to which the lines of the `PangoLayout` should wrap or ellipsized. The default value is -1: no width set. + - a `PangoLayout`. + a `PangoLayout`. - the desired width in Pango units, or -1 to indicate that no + the desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed. - Sets the wrap mode. + Sets the wrap mode. The wrap mode only has effect if a width is set on the layout with [method@Pango.Layout.set_width]. To turn off wrapping, set the width to -1. The default value is %PANGO_WRAP_WORD. + - a `PangoLayout` + a `PangoLayout` - the wrap mode + the wrap mode - Converts from X and Y position within a layout to the byte index to the + Converts from X and Y position within a layout to the byte index to the character at that logical position. If the Y position is not inside the layout, the closest position is @@ -7846,29 +8264,30 @@ is not within the layout, then the start or the end of the line is chosen as described for [method@Pango.LayoutLine.x_to_index]. If either the X or Y positions were not inside the layout, then the function returns %FALSE; on an exact hit, it returns %TRUE. + - %TRUE if the coordinates were inside text, %FALSE otherwise + %TRUE if the coordinates were inside text, %FALSE otherwise - a `PangoLayout` + a `PangoLayout` - the X offset (in Pango units) from the left edge of the layout + the X offset (in Pango units) from the left edge of the layout - the Y offset (in Pango units) from the top edge of the layout + the Y offset (in Pango units) from the top edge of the layout - location to store calculated byte index + location to store calculated byte index - location to store a integer indicating where + location to store a integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the leading edge of the grapheme. @@ -7877,225 +8296,240 @@ the X or Y positions were not inside the layout, then the function returns - + + + - A `PangoLayoutIter` can be used to iterate over the visual + A `PangoLayoutIter` can be used to iterate over the visual extents of a `PangoLayout`. To obtain a `PangoLayoutIter`, use [method@Pango.Layout.get_iter]. The `PangoLayoutIter` structure is opaque, and has no user-visible fields. + - Determines whether @iter is on the last line of the layout. + Determines whether @iter is on the last line of the layout. + - %TRUE if @iter is on the last line + %TRUE if @iter is on the last line - a `PangoLayoutIter` + a `PangoLayoutIter` - Copies a `PangoLayoutIter`. + Copies a `PangoLayoutIter`. + - the newly allocated `PangoLayoutIter` + the newly allocated `PangoLayoutIter` - a `PangoLayoutIter` + a `PangoLayoutIter` - Frees an iterator that's no longer in use. + Frees an iterator that's no longer in use. + - a `PangoLayoutIter`, may be %NULL + a `PangoLayoutIter`, may be %NULL - Gets the Y position of the current line's baseline, in layout + Gets the Y position of the current line's baseline, in layout coordinates. Layout coordinates have the origin at the top left of the entire layout. + - baseline of current line + baseline of current line - a `PangoLayoutIter` + a `PangoLayoutIter` - Gets the extents of the current character, in layout coordinates. + Gets the extents of the current character, in layout coordinates. Layout coordinates have the origin at the top left of the entire layout. Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters. + - a `PangoLayoutIter` + a `PangoLayoutIter` - rectangle to fill with + rectangle to fill with logical extents - Gets the extents of the current cluster, in layout coordinates. + Gets the extents of the current cluster, in layout coordinates. Layout coordinates have the origin at the top left of the entire layout. + - a `PangoLayoutIter` + a `PangoLayoutIter` - rectangle to fill with ink extents + rectangle to fill with ink extents - rectangle to fill with logical extents + rectangle to fill with logical extents - Gets the current byte index. + Gets the current byte index. Note that iterating forward by char moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout, if on the %NULL run (see [method@Pango.LayoutIter.get_run]). + - current byte index + current byte index - a `PangoLayoutIter` + a `PangoLayoutIter` - Gets the layout associated with a `PangoLayoutIter`. + Gets the layout associated with a `PangoLayoutIter`. + - the layout associated with @iter + the layout associated with @iter - a `PangoLayoutIter` + a `PangoLayoutIter` - Obtains the extents of the `PangoLayout` being iterated over. + Obtains the extents of the `PangoLayout` being iterated over. + - a `PangoLayoutIter` + a `PangoLayoutIter` - rectangle to fill with ink extents + rectangle to fill with ink extents - rectangle to fill with logical extents + rectangle to fill with logical extents - Gets the current line. + Gets the current line. Use the faster [method@Pango.LayoutIter.get_line_readonly] if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.). + - the current line + the current line - a `PangoLayoutIter` + a `PangoLayoutIter` - Obtains the extents of the current line. + Obtains the extents of the current line. Extents are in layout coordinates (origin is the top-left corner of the entire `PangoLayout`). Thus the extents returned by this function will be the same width/height but not at the same x/y as the extents returned from [method@Pango.LayoutLine.get_extents]. + - a `PangoLayoutIter` + a `PangoLayoutIter` - rectangle to fill with ink extents + rectangle to fill with ink extents - rectangle to fill with logical extents + rectangle to fill with logical extents - Gets the current line for read-only access. + Gets the current line for read-only access. This is a faster alternative to [method@Pango.LayoutIter.get_line], but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.). + - the current line, that should not be + the current line, that should not be modified - a `PangoLayoutIter` + a `PangoLayoutIter` - Divides the vertical space in the `PangoLayout` being iterated over + Divides the vertical space in the `PangoLayout` being iterated over between the lines in the layout, and returns the space belonging to the current line. @@ -8106,26 +8540,27 @@ coordinates (origin at top left of the entire layout). Note: Since 1.44, Pango uses line heights for placing lines, and there may be gaps between the ranges returned by this function. + - a `PangoLayoutIter` + a `PangoLayoutIter` - start of line + start of line - end of line + end of line - Gets the current run. + Gets the current run. When iterating by run, at the end of each line, there's a position with a %NULL run, so this function can return %NULL. The %NULL run @@ -8134,41 +8569,43 @@ even lines consisting of only a newline. Use the faster [method@Pango.LayoutIter.get_run_readonly] if you do not plan to modify the contents of the run (glyphs, glyph widths, etc.). + - the current run + the current run - a `PangoLayoutIter` + a `PangoLayoutIter` - Gets the extents of the current run in layout coordinates. + Gets the extents of the current run in layout coordinates. Layout coordinates have the origin at the top left of the entire layout. + - a `PangoLayoutIter` + a `PangoLayoutIter` - rectangle to fill with ink extents + rectangle to fill with ink extents - rectangle to fill with logical extents + rectangle to fill with logical extents - Gets the current run for read-only access. + Gets the current run for read-only access. When iterating by run, at the end of each line, there's a position with a %NULL run, so this function can return %NULL. The %NULL run @@ -8178,213 +8615,223 @@ even lines consisting of only a newline. This is a faster alternative to [method@Pango.LayoutIter.get_run], but the user is not expected to modify the contents of the run (glyphs, glyph widths, etc.). + - the current run, that + the current run, that should not be modified - a `PangoLayoutIter` + a `PangoLayoutIter` - Moves @iter forward to the next character in visual order. + Moves @iter forward to the next character in visual order. If @iter was already at the end of the layout, returns %FALSE. + - whether motion was possible + whether motion was possible - a `PangoLayoutIter` + a `PangoLayoutIter` - Moves @iter forward to the next cluster in visual order. + Moves @iter forward to the next cluster in visual order. If @iter was already at the end of the layout, returns %FALSE. + - whether motion was possible + whether motion was possible - a `PangoLayoutIter` + a `PangoLayoutIter` - Moves @iter forward to the start of the next line. + Moves @iter forward to the start of the next line. If @iter is already on the last line, returns %FALSE. + - whether motion was possible + whether motion was possible - a `PangoLayoutIter` + a `PangoLayoutIter` - Moves @iter forward to the next run in visual order. + Moves @iter forward to the next run in visual order. If @iter was already at the end of the layout, returns %FALSE. + - whether motion was possible + whether motion was possible - a `PangoLayoutIter` + a `PangoLayoutIter` - A `PangoLayoutLine` represents one of the lines resulting from laying + A `PangoLayoutLine` represents one of the lines resulting from laying out a paragraph via `PangoLayout`. `PangoLayoutLine` structures are obtained by calling [method@Pango.Layout.get_line] and are only valid until the text, attributes, or settings of the parent `PangoLayout` are modified. + - the layout this line belongs to, might be %NULL + the layout this line belongs to, might be %NULL - start of line as byte index into layout->text + start of line as byte index into layout->text - length of line in bytes + length of line in bytes - list of runs in the + list of runs in the line, from left to right - #TRUE if this is the first line of the paragraph + #TRUE if this is the first line of the paragraph - #Resolved PangoDirection of line + #Resolved PangoDirection of line - Computes the logical and ink extents of a layout line. + Computes the logical and ink extents of a layout line. See [method@Pango.Font.get_glyph_extents] for details about the interpretation of the rectangles. + - a `PangoLayoutLine` + a `PangoLayoutLine` - rectangle used to store the extents of + rectangle used to store the extents of the glyph string as drawn - rectangle used to store the logical + rectangle used to store the logical extents of the glyph string - Computes the height of the line, i.e. the distance between + Computes the height of the line, i.e. the distance between this and the previous lines baseline. + - a `PangoLayoutLine` + a `PangoLayoutLine` - return location for the line height + return location for the line height - Computes the logical and ink extents of @layout_line in device units. + Computes the logical and ink extents of @layout_line in device units. This function just calls [method@Pango.LayoutLine.get_extents] followed by two [func@extents_to_pixels] calls, rounding @ink_rect and @logical_rect such that the rounded rectangles fully contain the unrounded one (that is, passes them as first argument to [func@extents_to_pixels]). + - a `PangoLayoutLine` + a `PangoLayoutLine` - rectangle used to store the extents of + rectangle used to store the extents of the glyph string as drawn - rectangle used to store the logical + rectangle used to store the logical extents of the glyph string - Gets a list of visual ranges corresponding to a given logical range. + Gets a list of visual ranges corresponding to a given logical range. This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line. + - a `PangoLayoutLine` + a `PangoLayoutLine` - Start byte index of the logical range. If this value + Start byte index of the logical range. If this value is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise, it will start at the leading edge of the first character. - Ending byte index of the logical range. If this value is + Ending byte index of the logical range. If this value is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character. - location to + location to store a pointer to an array of ranges. The array will be of length `2*n_ranges`, with each range starting at `(*ranges)[2*n]` and of width `(*ranges)[2*n + 1] - (*ranges)[2*n]`. This array must be freed @@ -8395,67 +8842,70 @@ layout, not with respect to the line. - The number of ranges stored in @ranges + The number of ranges stored in @ranges - Converts an index within a line to a X position. + Converts an index within a line to a X position. + - a `PangoLayoutLine` + a `PangoLayoutLine` - byte offset of a grapheme within the layout + byte offset of a grapheme within the layout - an integer indicating the edge of the grapheme to retrieve + an integer indicating the edge of the grapheme to retrieve the position of. If > 0, the trailing edge of the grapheme, if 0, the leading of the grapheme - location to store the x_offset (in Pango units) + location to store the x_offset (in Pango units) - Increase the reference count of a `PangoLayoutLine` by one. + Increase the reference count of a `PangoLayoutLine` by one. + - the line passed in. + the line passed in. - a `PangoLayoutLine` + a `PangoLayoutLine` - Decrease the reference count of a `PangoLayoutLine` by one. + Decrease the reference count of a `PangoLayoutLine` by one. If the result is zero, the line and all associated memory will be freed. + - a `PangoLayoutLine` + a `PangoLayoutLine` - Converts from x offset to the byte index of the corresponding character + Converts from x offset to the byte index of the corresponding character within the text of the layout. If @x_pos is outside the line, @index_ and @trailing will point to the very @@ -8466,26 +8916,27 @@ results in 0 being stored in @index_ and @trailing. An X position to the left of the line results in @index_ pointing to the (logical) last grapheme in the line and @trailing being set to the number of characters in that grapheme. The reverse is true for a left-to-right line. + - %FALSE if @x_pos was outside the line, %TRUE if inside + %FALSE if @x_pos was outside the line, %TRUE if inside - a `PangoLayoutLine` + a `PangoLayoutLine` - the X offset (in Pango units) from the left edge of the line. + the X offset (in Pango units) from the left edge of the line. - location to store calculated byte index for the grapheme + location to store calculated byte index for the grapheme in which the user clicked - location to store an integer indicating where in the + location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the leading edge of the grapheme. @@ -8494,26 +8945,27 @@ grapheme. The reverse is true for a left-to-right line. - The `PangoLogAttr` structure stores information about the attributes of a + The `PangoLogAttr` structure stores information about the attributes of a single character. + - if set, can break line in front of character + if set, can break line in front of character - if set, must break line in front of character + if set, must break line in front of character - if set, can break here when doing character wrapping + if set, can break here when doing character wrapping - is whitespace character + is whitespace character - if set, cursor can appear in front of character. + if set, cursor can appear in front of character. i.e. this is a grapheme boundary, or the first character in the text. This flag implements Unicode's [Grapheme Cluster Boundaries](http://www.unicode.org/reports/tr29/) @@ -8521,17 +8973,17 @@ single character. - is first character in a word + is first character in a word - is first non-word char after a word + is first non-word char after a word Note that in degenerate cases, you could have both @is_word_start and @is_word_end set for some character. - is a sentence boundary. + is a sentence boundary. There are two ways to divide sentences. The first assigns all inter-sentence whitespace/control/format chars to some sentence, so all chars are in some sentence; @is_sentence_boundary denotes @@ -8541,18 +8993,18 @@ single character. - is first character in a sentence + is first character in a sentence - is first char after a sentence. + is first char after a sentence. Note that in degenerate cases, you could have both @is_sentence_start and @is_sentence_end set for some character. (e.g. no space after a period, so the next sentence starts right away) - if set, backspace deletes one character + if set, backspace deletes one character rather than the entire grapheme cluster. This field is only meaningful on grapheme boundaries (where @is_cursor_position is set). In some languages, the full grapheme (e.g. letter + diacritics) is considered a unit, while in @@ -8562,12 +9014,12 @@ single character. - is a whitespace character that can possibly be + is a whitespace character that can possibly be expanded for justification purposes. (Since: 1.18) - is a word boundary, as defined by UAX#29. + is a word boundary, as defined by UAX#29. More specifically, means that this is not a position in the middle of a word. For example, both sides of a punctuation mark are considered word boundaries. This flag is particularly useful when selecting text word-by-word. This flag @@ -8577,7 +9029,7 @@ single character. - A `PangoMatrix` specifies a transformation between user-space + A `PangoMatrix` specifies a transformation between user-space and device coordinates. The transformation is given by @@ -8586,160 +9038,168 @@ The transformation is given by x_device = x_user * matrix->xx + y_user * matrix->xy + matrix->x0; y_device = x_user * matrix->yx + y_user * matrix->yy + matrix->y0; ``` + - 1st component of the transformation matrix + 1st component of the transformation matrix - 2nd component of the transformation matrix + 2nd component of the transformation matrix - 3rd component of the transformation matrix + 3rd component of the transformation matrix - 4th component of the transformation matrix + 4th component of the transformation matrix - x translation + x translation - y translation + y translation - Changes the transformation represented by @matrix to be the + Changes the transformation represented by @matrix to be the transformation given by first applying transformation given by @new_matrix then applying the original transformation. + - a `PangoMatrix` + a `PangoMatrix` - a `PangoMatrix` + a `PangoMatrix` - Copies a `PangoMatrix`. + Copies a `PangoMatrix`. + - the newly allocated `PangoMatrix` + the newly allocated `PangoMatrix` - a `PangoMatrix` + a `PangoMatrix` - Free a `PangoMatrix`. + Free a `PangoMatrix`. + - a `PangoMatrix`, may be %NULL + a `PangoMatrix`, may be %NULL - Returns the scale factor of a matrix on the height of the font. + Returns the scale factor of a matrix on the height of the font. That is, the scale factor in the direction perpendicular to the vector that the X coordinate is mapped to. If the scale in the X coordinate is needed as well, use [method@Pango.Matrix.get_font_scale_factors]. + - the scale factor of @matrix on the height of the font, + the scale factor of @matrix on the height of the font, or 1.0 if @matrix is %NULL. - a `PangoMatrix`, may be %NULL + a `PangoMatrix`, may be %NULL - Calculates the scale factor of a matrix on the width and height of the font. + Calculates the scale factor of a matrix on the width and height of the font. That is, @xscale is the scale factor in the direction of the X coordinate, and @yscale is the scale factor in the direction perpendicular to the vector that the X coordinate is mapped to. Note that output numbers will always be non-negative. + - a `PangoMatrix` + a `PangoMatrix` - output scale factor in the x direction + output scale factor in the x direction - output scale factor perpendicular to the x direction + output scale factor perpendicular to the x direction - Changes the transformation represented by @matrix to be the + Changes the transformation represented by @matrix to be the transformation given by first rotating by @degrees degrees counter-clockwise then applying the original transformation. + - a `PangoMatrix` + a `PangoMatrix` - degrees to rotate counter-clockwise + degrees to rotate counter-clockwise - Changes the transformation represented by @matrix to be the + Changes the transformation represented by @matrix to be the transformation given by first scaling by @sx in the X direction and @sy in the Y direction then applying the original transformation. + - a `PangoMatrix` + a `PangoMatrix` - amount to scale by in X direction + amount to scale by in X direction - amount to scale by in Y direction + amount to scale by in Y direction - Transforms the distance vector (@dx,@dy) by @matrix. + Transforms the distance vector (@dx,@dy) by @matrix. This is similar to [method@Pango.Matrix.transform_point], except that the translation components of the transformation @@ -8754,26 +9214,27 @@ Affine transformations are position invariant, so the same vector always transforms to the same vector. If (@x1,@y1) transforms to (@x2,@y2) then (@x1+@dx1,@y1+@dy1) will transform to (@x1+@dx2,@y1+@dy2) for all values of @x1 and @x2. + - a `PangoMatrix` + a `PangoMatrix` - in/out X component of a distance vector + in/out X component of a distance vector - in/out Y component of a distance vector + in/out Y component of a distance vector - First transforms the @rect using @matrix, then calculates the bounding box + First transforms the @rect using @matrix, then calculates the bounding box of the transformed rectangle. This function is useful for example when you want to draw a rotated @@ -8783,42 +9244,44 @@ should be and how much you should shift the layout when rendering. For better accuracy, you should use [method@Pango.Matrix.transform_rectangle] on original rectangle in Pango units and convert to pixels afterward using [func@extents_to_pixels]'s first argument. + - a `PangoMatrix` + a `PangoMatrix` - in/out bounding box in device units + in/out bounding box in device units - Transforms the point (@x, @y) by @matrix. + Transforms the point (@x, @y) by @matrix. + - a `PangoMatrix` + a `PangoMatrix` - in/out X position + in/out X position - in/out Y position + in/out Y position - First transforms @rect using @matrix, then calculates the bounding box + First transforms @rect using @matrix, then calculates the bounding box of the transformed rectangle. This function is useful for example when you want to draw a rotated @@ -8836,160 +9299,172 @@ However, there are valid reasons that you may want to convert to pixels first and then transform, for example when the transformed coordinates may overflow in Pango units (large matrix translation for example). + - a `PangoMatrix` + a `PangoMatrix` - in/out bounding box in Pango units + in/out bounding box in Pango units - Changes the transformation represented by @matrix to be the + Changes the transformation represented by @matrix to be the transformation given by first translating by (@tx, @ty) then applying the original transformation. + - a `PangoMatrix` + a `PangoMatrix` - amount to translate in the X direction + amount to translate in the X direction - amount to translate in the Y direction + amount to translate in the Y direction - The `PangoOverline` enumeration is used to specify whether text + The `PangoOverline` enumeration is used to specify whether text should be overlined, and if so, the type of line. - no overline should be drawn + no overline should be drawn - Draw a single line above the ink + Draw a single line above the ink extents of the text being underlined. - Converts a dimension to device units by rounding. + Converts a dimension to device units by rounding. + - a dimension in Pango units. + a dimension in Pango units. - Converts a dimension to device units by ceiling. + Converts a dimension to device units by ceiling. + - a dimension in Pango units. + a dimension in Pango units. - Converts a dimension to device units by flooring. + Converts a dimension to device units by flooring. + - a dimension in Pango units. + a dimension in Pango units. - Extracts the *right bearing* from a `PangoRectangle` + Extracts the *right bearing* from a `PangoRectangle` representing glyph extents. The right bearing is the distance from the horizontal origin to the farthest right point of the character. This is positive except for characters drawn completely to the left of the horizontal origin. + - a `PangoRectangle` + a `PangoRectangle` + + + - The `PangoRectangle` structure represents a rectangle. + The `PangoRectangle` structure represents a rectangle. `PangoRectangle` is frequently used to represent the logical or ink extents of a single glyph or section of text. (See, for instance, [method@Pango.Font.get_glyph_extents].) + - X coordinate of the left side of the rectangle. + X coordinate of the left side of the rectangle. - Y coordinate of the the top side of the rectangle. + Y coordinate of the the top side of the rectangle. - width of the rectangle. + width of the rectangle. - height of the rectangle. + height of the rectangle. - `PangoRenderPart` defines different items to render for such + `PangoRenderPart` defines different items to render for such purposes as setting colors. - the text itself + the text itself - the area behind the text + the area behind the text - underlines + underlines - strikethrough lines + strikethrough lines - overlines + overlines - `PangoRenderer` is a base class for objects that can render text + `PangoRenderer` is a base class for objects that can render text provided as `PangoGlyphString` or `PangoLayout`. By subclassing `PangoRenderer` and overriding operations such as @draw_glyphs and @draw_rectangle, renderers for particular font backends and destinations can be created. + + @@ -9000,7 +9475,7 @@ backends and destinations can be created. - Draw a squiggly line that approximately covers the given rectangle + Draw a squiggly line that approximately covers the given rectangle in the style of an underline used to indicate a spelling error. The width of the underline is rounded to an integer number @@ -9009,62 +9484,64 @@ in the original rectangle. This should be called while @renderer is already active. Use [method@Pango.Renderer.activate] to activate a renderer. + - a `PangoRenderer` + a `PangoRenderer` - X coordinate of underline, in Pango units in user coordinate system + X coordinate of underline, in Pango units in user coordinate system - Y coordinate of underline, in Pango units in user coordinate system + Y coordinate of underline, in Pango units in user coordinate system - width of underline, in Pango units in user coordinate system + width of underline, in Pango units in user coordinate system - height of underline, in Pango units in user coordinate system + height of underline, in Pango units in user coordinate system - Draws a single glyph with coordinates in device space. + Draws a single glyph with coordinates in device space. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoFont` + a `PangoFont` - the glyph index of a single glyph + the glyph index of a single glyph - X coordinate of left edge of baseline of glyph + X coordinate of left edge of baseline of glyph - Y coordinate of left edge of baseline of glyph + Y coordinate of left edge of baseline of glyph - Draws the glyphs in @glyph_item with the specified `PangoRenderer`, + Draws the glyphs in @glyph_item with the specified `PangoRenderer`, embedding the text associated with the glyphs in the output if the output format supports it. @@ -9082,103 +9559,107 @@ If @text is %NULL, this simply calls [method@Pango.Renderer.draw_glyphs]. The default implementation of this method simply falls back to [method@Pango.Renderer.draw_glyphs]. + - a `PangoRenderer` + a `PangoRenderer` - the UTF-8 text that @glyph_item refers to + the UTF-8 text that @glyph_item refers to - a `PangoGlyphItem` + a `PangoGlyphItem` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units - Draws the glyphs in @glyphs with the specified `PangoRenderer`. + Draws the glyphs in @glyphs with the specified `PangoRenderer`. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoFont` + a `PangoFont` - a `PangoGlyphString` + a `PangoGlyphString` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units. - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units. - Draws an axis-aligned rectangle in user space coordinates with the + Draws an axis-aligned rectangle in user space coordinates with the specified `PangoRenderer`. This should be called while @renderer is already active. Use [method@Pango.Renderer.activate] to activate a renderer. + - a `PangoRenderer` + a `PangoRenderer` - type of object this rectangle is part of + type of object this rectangle is part of - X position at which to draw rectangle, in user space coordinates + X position at which to draw rectangle, in user space coordinates in Pango units - Y position at which to draw rectangle, in user space coordinates + Y position at which to draw rectangle, in user space coordinates in Pango units - width of rectangle in Pango units + width of rectangle in Pango units - height of rectangle in Pango units + height of rectangle in Pango units + @@ -9198,47 +9679,49 @@ Use [method@Pango.Renderer.activate] to activate a renderer. - Draws a trapezoid with the parallel sides aligned with the X axis + Draws a trapezoid with the parallel sides aligned with the X axis using the given `PangoRenderer`; coordinates are in device space. + - a `PangoRenderer` + a `PangoRenderer` - type of object this trapezoid is part of + type of object this trapezoid is part of - Y coordinate of top of trapezoid + Y coordinate of top of trapezoid - X coordinate of left end of top of trapezoid + X coordinate of left end of top of trapezoid - X coordinate of right end of top of trapezoid + X coordinate of right end of top of trapezoid - Y coordinate of bottom of trapezoid + Y coordinate of bottom of trapezoid - X coordinate of left end of bottom of trapezoid + X coordinate of left end of bottom of trapezoid - X coordinate of right end of bottom of trapezoid + X coordinate of right end of bottom of trapezoid + @@ -9249,7 +9732,7 @@ using the given `PangoRenderer`; coordinates are in device space. - Informs Pango that the way that the rendering is done + Informs Pango that the way that the rendering is done for @part has changed. This should be called if the rendering changes in a way that would @@ -9264,21 +9747,23 @@ pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE); When the stipple changes or underlines with different stipples might be joined together. Pango automatically calls this for changes to colors. (See [method@Pango.Renderer.set_color]) + - a `PangoRenderer` + a `PangoRenderer` - the part for which rendering has changed. + the part for which rendering has changed. + @@ -9292,7 +9777,7 @@ changes to colors. (See [method@Pango.Renderer.set_color]) - Does initial setup before rendering operations on @renderer. + Does initial setup before rendering operations on @renderer. [method@Pango.Renderer.deactivate] should be called when done drawing. Calls such as [method@Pango.Renderer.draw_layout] automatically @@ -9301,32 +9786,34 @@ activate the layout before drawing on it. Calls to [method@Pango.Renderer.activate] and [method@Pango.Renderer.deactivate] can be nested and the renderer will only be initialized and deinitialized once. + - a `PangoRenderer` + a `PangoRenderer` - Cleans up after rendering operations on @renderer. + Cleans up after rendering operations on @renderer. See docs for [method@Pango.Renderer.activate]. + - a `PangoRenderer` + a `PangoRenderer` - Draw a squiggly line that approximately covers the given rectangle + Draw a squiggly line that approximately covers the given rectangle in the style of an underline used to indicate a spelling error. The width of the underline is rounded to an integer number @@ -9335,62 +9822,64 @@ in the original rectangle. This should be called while @renderer is already active. Use [method@Pango.Renderer.activate] to activate a renderer. + - a `PangoRenderer` + a `PangoRenderer` - X coordinate of underline, in Pango units in user coordinate system + X coordinate of underline, in Pango units in user coordinate system - Y coordinate of underline, in Pango units in user coordinate system + Y coordinate of underline, in Pango units in user coordinate system - width of underline, in Pango units in user coordinate system + width of underline, in Pango units in user coordinate system - height of underline, in Pango units in user coordinate system + height of underline, in Pango units in user coordinate system - Draws a single glyph with coordinates in device space. + Draws a single glyph with coordinates in device space. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoFont` + a `PangoFont` - the glyph index of a single glyph + the glyph index of a single glyph - X coordinate of left edge of baseline of glyph + X coordinate of left edge of baseline of glyph - Y coordinate of left edge of baseline of glyph + Y coordinate of left edge of baseline of glyph - Draws the glyphs in @glyph_item with the specified `PangoRenderer`, + Draws the glyphs in @glyph_item with the specified `PangoRenderer`, embedding the text associated with the glyphs in the output if the output format supports it. @@ -9408,300 +9897,311 @@ If @text is %NULL, this simply calls [method@Pango.Renderer.draw_glyphs]. The default implementation of this method simply falls back to [method@Pango.Renderer.draw_glyphs]. + - a `PangoRenderer` + a `PangoRenderer` - the UTF-8 text that @glyph_item refers to + the UTF-8 text that @glyph_item refers to - a `PangoGlyphItem` + a `PangoGlyphItem` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units - Draws the glyphs in @glyphs with the specified `PangoRenderer`. + Draws the glyphs in @glyphs with the specified `PangoRenderer`. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoFont` + a `PangoFont` - a `PangoGlyphString` + a `PangoGlyphString` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units. - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units. - Draws @layout with the specified `PangoRenderer`. + Draws @layout with the specified `PangoRenderer`. This is equivalent to drawing the lines of the layout, at their respective positions relative to @x, @y. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoLayout` + a `PangoLayout` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units. - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units. - Draws @line with the specified `PangoRenderer`. + Draws @line with the specified `PangoRenderer`. This draws the glyph items that make up the line, as well as shapes, backgrounds and lines that are specified by the attributes of those items. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoLayoutLine` + a `PangoLayoutLine` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units. - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units. - Draws an axis-aligned rectangle in user space coordinates with the + Draws an axis-aligned rectangle in user space coordinates with the specified `PangoRenderer`. This should be called while @renderer is already active. Use [method@Pango.Renderer.activate] to activate a renderer. + - a `PangoRenderer` + a `PangoRenderer` - type of object this rectangle is part of + type of object this rectangle is part of - X position at which to draw rectangle, in user space coordinates + X position at which to draw rectangle, in user space coordinates in Pango units - Y position at which to draw rectangle, in user space coordinates + Y position at which to draw rectangle, in user space coordinates in Pango units - width of rectangle in Pango units + width of rectangle in Pango units - height of rectangle in Pango units + height of rectangle in Pango units - Draws a trapezoid with the parallel sides aligned with the X axis + Draws a trapezoid with the parallel sides aligned with the X axis using the given `PangoRenderer`; coordinates are in device space. + - a `PangoRenderer` + a `PangoRenderer` - type of object this trapezoid is part of + type of object this trapezoid is part of - Y coordinate of top of trapezoid + Y coordinate of top of trapezoid - X coordinate of left end of top of trapezoid + X coordinate of left end of top of trapezoid - X coordinate of right end of top of trapezoid + X coordinate of right end of top of trapezoid - Y coordinate of bottom of trapezoid + Y coordinate of bottom of trapezoid - X coordinate of left end of bottom of trapezoid + X coordinate of left end of bottom of trapezoid - X coordinate of right end of bottom of trapezoid + X coordinate of right end of bottom of trapezoid - Gets the current alpha for the specified part. + Gets the current alpha for the specified part. + - the alpha for the specified part, + the alpha for the specified part, or 0 if it hasn't been set and should be inherited from the environment. - a `PangoRenderer` + a `PangoRenderer` - the part to get the alpha for + the part to get the alpha for - Gets the current rendering color for the specified part. + Gets the current rendering color for the specified part. + - the color for the + the color for the specified part, or %NULL if it hasn't been set and should be inherited from the environment. - a `PangoRenderer` + a `PangoRenderer` - the part to get the color for + the part to get the color for - Gets the layout currently being rendered using @renderer. + Gets the layout currently being rendered using @renderer. Calling this function only makes sense from inside a subclass's methods, like in its draw_shape vfunc, for example. The returned layout should not be modified while still being rendered. + - the layout, or %NULL if + the layout, or %NULL if no layout is being rendered using @renderer at this time. - a `PangoRenderer` + a `PangoRenderer` - Gets the layout line currently being rendered using @renderer. + Gets the layout line currently being rendered using @renderer. Calling this function only makes sense from inside a subclass's methods, like in its draw_shape vfunc, for example. The returned layout line should not be modified while still being rendered. + - the layout line, or %NULL + the layout line, or %NULL if no layout line is being rendered using @renderer at this time. - a `PangoRenderer` + a `PangoRenderer` - Gets the transformation matrix that will be applied when + Gets the transformation matrix that will be applied when rendering. See [method@Pango.Renderer.set_matrix]. + - the matrix, or %NULL if no matrix has + the matrix, or %NULL if no matrix has been set (which is the same as the identity matrix). The returned matrix is owned by Pango and must not be modified or freed. - a `PangoRenderer` + a `PangoRenderer` - Informs Pango that the way that the rendering is done + Informs Pango that the way that the rendering is done for @part has changed. This should be called if the rendering changes in a way that would @@ -9716,77 +10216,81 @@ pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE); When the stipple changes or underlines with different stipples might be joined together. Pango automatically calls this for changes to colors. (See [method@Pango.Renderer.set_color]) + - a `PangoRenderer` + a `PangoRenderer` - the part for which rendering has changed. + the part for which rendering has changed. - Sets the alpha for part of the rendering. + Sets the alpha for part of the rendering. Note that the alpha may only be used if a color is specified for @part as well. + - a `PangoRenderer` + a `PangoRenderer` - the part to set the alpha for + the part to set the alpha for - an alpha value between 1 and 65536, or 0 to unset the alpha + an alpha value between 1 and 65536, or 0 to unset the alpha - Sets the color for part of the rendering. + Sets the color for part of the rendering. Also see [method@Pango.Renderer.set_alpha]. + - a `PangoRenderer` + a `PangoRenderer` - the part to change the color of + the part to change the color of - the new color or %NULL to unset the current color + the new color or %NULL to unset the current color - Sets the transformation matrix that will be applied when rendering. + Sets the transformation matrix that will be applied when rendering. + - a `PangoRenderer` + a `PangoRenderer` - a `PangoMatrix`, or %NULL to unset any existing matrix + a `PangoMatrix`, or %NULL to unset any existing matrix (No matrix set is the same as setting the identity matrix.) @@ -9805,7 +10309,7 @@ Also see [method@Pango.Renderer.set_alpha]. - the current transformation matrix for + the current transformation matrix for the Renderer; may be %NULL, which should be treated the same as the identity matrix. @@ -9815,7 +10319,7 @@ Also see [method@Pango.Renderer.set_alpha]. - Class structure for `PangoRenderer`. + Class structure for `PangoRenderer`. The following vfuncs take user space coordinates in Pango units and have default implementations: @@ -9831,34 +10335,36 @@ The following vfuncs take device space coordinates as doubles and must be implemented: - draw_trapezoid - draw_glyph + + - a `PangoRenderer` + a `PangoRenderer` - a `PangoFont` + a `PangoFont` - a `PangoGlyphString` + a `PangoGlyphString` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units. - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units. @@ -9867,34 +10373,35 @@ and must be implemented: + - a `PangoRenderer` + a `PangoRenderer` - type of object this rectangle is part of + type of object this rectangle is part of - X position at which to draw rectangle, in user space coordinates + X position at which to draw rectangle, in user space coordinates in Pango units - Y position at which to draw rectangle, in user space coordinates + Y position at which to draw rectangle, in user space coordinates in Pango units - width of rectangle in Pango units + width of rectangle in Pango units - height of rectangle in Pango units + height of rectangle in Pango units @@ -9902,28 +10409,29 @@ and must be implemented: + - a `PangoRenderer` + a `PangoRenderer` - X coordinate of underline, in Pango units in user coordinate system + X coordinate of underline, in Pango units in user coordinate system - Y coordinate of underline, in Pango units in user coordinate system + Y coordinate of underline, in Pango units in user coordinate system - width of underline, in Pango units in user coordinate system + width of underline, in Pango units in user coordinate system - height of underline, in Pango units in user coordinate system + height of underline, in Pango units in user coordinate system @@ -9931,6 +10439,7 @@ and must be implemented: + @@ -9952,40 +10461,41 @@ and must be implemented: + - a `PangoRenderer` + a `PangoRenderer` - type of object this trapezoid is part of + type of object this trapezoid is part of - Y coordinate of top of trapezoid + Y coordinate of top of trapezoid - X coordinate of left end of top of trapezoid + X coordinate of left end of top of trapezoid - X coordinate of right end of top of trapezoid + X coordinate of right end of top of trapezoid - Y coordinate of bottom of trapezoid + Y coordinate of bottom of trapezoid - X coordinate of left end of bottom of trapezoid + X coordinate of left end of bottom of trapezoid - X coordinate of right end of bottom of trapezoid + X coordinate of right end of bottom of trapezoid @@ -9993,28 +10503,29 @@ and must be implemented: + - a `PangoRenderer` + a `PangoRenderer` - a `PangoFont` + a `PangoFont` - the glyph index of a single glyph + the glyph index of a single glyph - X coordinate of left edge of baseline of glyph + X coordinate of left edge of baseline of glyph - Y coordinate of left edge of baseline of glyph + Y coordinate of left edge of baseline of glyph @@ -10022,16 +10533,17 @@ and must be implemented: + - a `PangoRenderer` + a `PangoRenderer` - the part for which rendering has changed. + the part for which rendering has changed. @@ -10039,6 +10551,7 @@ and must be implemented: + @@ -10051,6 +10564,7 @@ and must be implemented: + @@ -10063,6 +10577,7 @@ and must be implemented: + @@ -10078,29 +10593,30 @@ and must be implemented: + - a `PangoRenderer` + a `PangoRenderer` - the UTF-8 text that @glyph_item refers to + the UTF-8 text that @glyph_item refers to - a `PangoGlyphItem` + a `PangoGlyphItem` - X position of left edge of baseline, in user space coordinates + X position of left edge of baseline, in user space coordinates in Pango units - Y position of left edge of baseline, in user space coordinates + Y position of left edge of baseline, in user space coordinates in Pango units @@ -10109,6 +10625,7 @@ and must be implemented: + @@ -10116,6 +10633,7 @@ and must be implemented: + @@ -10123,15 +10641,18 @@ and must be implemented: + - + + + - The scale between dimensions used for Pango distances and device units. + The scale between dimensions used for Pango distances and device units. The definition of device units is dependent on the output device; it will typically be pixels for a screen, and points for a printer. %PANGO_SCALE is @@ -10139,10 +10660,11 @@ currently 1024, but this may be changed in the future. When setting font sizes, device units are always considered to be points (as in "12 point font"), rather than pixels. + - The `PangoScript` enumeration identifies different writing + The `PangoScript` enumeration identifies different writing systems. The values correspond to the names as defined in the Unicode standard. See @@ -10153,362 +10675,362 @@ to include values in newer versions of the Unicode standard. Applications should use the `GUnicodeScript` enumeration instead, whose values are interchangeable with `PangoScript`. - a value never returned from pango_script_for_unichar() + a value never returned from pango_script_for_unichar() - a character used by multiple different scripts + a character used by multiple different scripts - a mark glyph that takes its script from the + a mark glyph that takes its script from the base glyph to which it is attached - Arabic + Arabic - Armenian + Armenian - Bengali + Bengali - Bopomofo + Bopomofo - Cherokee + Cherokee - Coptic + Coptic - Cyrillic + Cyrillic - Deseret + Deseret - Devanagari + Devanagari - Ethiopic + Ethiopic - Georgian + Georgian - Gothic + Gothic - Greek + Greek - Gujarati + Gujarati - Gurmukhi + Gurmukhi - Han + Han - Hangul + Hangul - Hebrew + Hebrew - Hiragana + Hiragana - Kannada + Kannada - Katakana + Katakana - Khmer + Khmer - Lao + Lao - Latin + Latin - Malayalam + Malayalam - Mongolian + Mongolian - Myanmar + Myanmar - Ogham + Ogham - Old Italic + Old Italic - Oriya + Oriya - Runic + Runic - Sinhala + Sinhala - Syriac + Syriac - Tamil + Tamil - Telugu + Telugu - Thaana + Thaana - Thai + Thai - Tibetan + Tibetan - Canadian Aboriginal + Canadian Aboriginal - Yi + Yi - Tagalog + Tagalog - Hanunoo + Hanunoo - Buhid + Buhid - Tagbanwa + Tagbanwa - Braille + Braille - Cypriot + Cypriot - Limbu + Limbu - Osmanya + Osmanya - Shavian + Shavian - Linear B + Linear B - Tai Le + Tai Le - Ugaritic + Ugaritic - New Tai Lue. Since 1.10 + New Tai Lue. Since 1.10 - Buginese. Since 1.10 + Buginese. Since 1.10 - Glagolitic. Since 1.10 + Glagolitic. Since 1.10 - Tifinagh. Since 1.10 + Tifinagh. Since 1.10 - Syloti Nagri. Since 1.10 + Syloti Nagri. Since 1.10 - Old Persian. Since 1.10 + Old Persian. Since 1.10 - Kharoshthi. Since 1.10 + Kharoshthi. Since 1.10 - an unassigned code point. Since 1.14 + an unassigned code point. Since 1.14 - Balinese. Since 1.14 + Balinese. Since 1.14 - Cuneiform. Since 1.14 + Cuneiform. Since 1.14 - Phoenician. Since 1.14 + Phoenician. Since 1.14 - Phags-pa. Since 1.14 + Phags-pa. Since 1.14 - N'Ko. Since 1.14 + N'Ko. Since 1.14 - Kayah Li. Since 1.20.1 + Kayah Li. Since 1.20.1 - Lepcha. Since 1.20.1 + Lepcha. Since 1.20.1 - Rejang. Since 1.20.1 + Rejang. Since 1.20.1 - Sundanese. Since 1.20.1 + Sundanese. Since 1.20.1 - Saurashtra. Since 1.20.1 + Saurashtra. Since 1.20.1 - Cham. Since 1.20.1 + Cham. Since 1.20.1 - Ol Chiki. Since 1.20.1 + Ol Chiki. Since 1.20.1 - Vai. Since 1.20.1 + Vai. Since 1.20.1 - Carian. Since 1.20.1 + Carian. Since 1.20.1 - Lycian. Since 1.20.1 + Lycian. Since 1.20.1 - Lydian. Since 1.20.1 + Lydian. Since 1.20.1 - Batak. Since 1.32 + Batak. Since 1.32 - Brahmi. Since 1.32 + Brahmi. Since 1.32 - Mandaic. Since 1.32 + Mandaic. Since 1.32 - Chakma. Since: 1.32 + Chakma. Since: 1.32 - Meroitic Cursive. Since: 1.32 + Meroitic Cursive. Since: 1.32 - Meroitic Hieroglyphs. Since: 1.32 + Meroitic Hieroglyphs. Since: 1.32 - Miao. Since: 1.32 + Miao. Since: 1.32 - Sharada. Since: 1.32 + Sharada. Since: 1.32 - Sora Sompeng. Since: 1.32 + Sora Sompeng. Since: 1.32 - Takri. Since: 1.32 + Takri. Since: 1.32 - Bassa. Since: 1.40 + Bassa. Since: 1.40 - Caucasian Albanian. Since: 1.40 + Caucasian Albanian. Since: 1.40 - Duployan. Since: 1.40 + Duployan. Since: 1.40 - Elbasan. Since: 1.40 + Elbasan. Since: 1.40 - Grantha. Since: 1.40 + Grantha. Since: 1.40 - Kjohki. Since: 1.40 + Kjohki. Since: 1.40 - Khudawadi, Sindhi. Since: 1.40 + Khudawadi, Sindhi. Since: 1.40 - Linear A. Since: 1.40 + Linear A. Since: 1.40 - Mahajani. Since: 1.40 + Mahajani. Since: 1.40 - Manichaean. Since: 1.40 + Manichaean. Since: 1.40 - Mende Kikakui. Since: 1.40 + Mende Kikakui. Since: 1.40 - Modi. Since: 1.40 + Modi. Since: 1.40 - Mro. Since: 1.40 + Mro. Since: 1.40 - Nabataean. Since: 1.40 + Nabataean. Since: 1.40 - Old North Arabian. Since: 1.40 + Old North Arabian. Since: 1.40 - Old Permic. Since: 1.40 + Old Permic. Since: 1.40 - Pahawh Hmong. Since: 1.40 + Pahawh Hmong. Since: 1.40 - Palmyrene. Since: 1.40 + Palmyrene. Since: 1.40 - Pau Cin Hau. Since: 1.40 + Pau Cin Hau. Since: 1.40 - Psalter Pahlavi. Since: 1.40 + Psalter Pahlavi. Since: 1.40 - Siddham. Since: 1.40 + Siddham. Since: 1.40 - Tirhuta. Since: 1.40 + Tirhuta. Since: 1.40 - Warang Citi. Since: 1.40 + Warang Citi. Since: 1.40 - Ahom. Since: 1.40 + Ahom. Since: 1.40 - Anatolian Hieroglyphs. Since: 1.40 + Anatolian Hieroglyphs. Since: 1.40 - Hatran. Since: 1.40 + Hatran. Since: 1.40 - Multani. Since: 1.40 + Multani. Since: 1.40 - Old Hungarian. Since: 1.40 + Old Hungarian. Since: 1.40 - Signwriting. Since: 1.40 + Signwriting. Since: 1.40 - Looks up the script for a particular character. + Looks up the script for a particular character. The script of a character is defined by Unicode Standard Annex \#24. No check is made for @ch being a valid Unicode character; if you pass @@ -10519,19 +11041,20 @@ as `PangoScript`, as of Pango 1.18, this function simply returns the return value of g_unichar_get_script(). Callers must be prepared to handle unknown values. Use g_unichar_get_script() + - the `PangoScript` for the character. + the `PangoScript` for the character. - a Unicode character + a Unicode character - Finds a language tag that is reasonably representative of @script. + Finds a language tag that is reasonably representative of @script. The language will usually be the most widely spoken or used language written in that script: for instance, the sample language for @@ -10560,31 +11083,34 @@ instead of Arabic (ar) when a segment of Arabic text is found in an otherwise non-Arabic text. The same trick can be used to choose a default language for %PANGO_SCRIPT_HAN when setting context language is not feasible. + - a `PangoLanguage` that is representative + a `PangoLanguage` that is representative of the script - a `PangoScript` + a `PangoScript` - A `PangoScriptIter` is used to iterate through a string + A `PangoScriptIter` is used to iterate through a string and identify ranges in different scripts. + - Create a new `PangoScriptIter`, used to break a string of + Create a new `PangoScriptIter`, used to break a string of Unicode text into runs by Unicode script. No copy is made of @text, so the caller needs to make sure it remains valid until the iterator is freed with [method@Pango.ScriptIter.free]. + - the new script iterator, initialized + the new script iterator, initialized to point at the first range in the text, which should be freed with [method@Pango.ScriptIter.free]. If the string is empty, it will point at an empty range. @@ -10592,29 +11118,30 @@ sure it remains valid until the iterator is freed with - a UTF-8 string + a UTF-8 string - length of @text, or -1 if @text is nul-terminated. + length of @text, or -1 if @text is nul-terminated. - Frees a `PangoScriptIter`. + Frees a `PangoScriptIter`. + - a `PangoScriptIter` + a `PangoScriptIter` - Gets information about the range to which @iter currently points. + Gets information about the range to which @iter currently points. The range is the set of locations p where *start <= p < *end. (That is, it doesn't include the character stored at *end) @@ -10622,282 +11149,293 @@ Note that while the type of the @script argument is declared as `PangoScript`, as of Pango 1.18, this function simply returns GUnicodeScript values. Callers must be prepared to handle unknown values. + - a `PangoScriptIter` + a `PangoScriptIter` - location to store start position of the range + location to store start position of the range - location to store end position of the range + location to store end position of the range - location to store script for range + location to store script for range - Advances a `PangoScriptIter` to the next range. + Advances a `PangoScriptIter` to the next range. If @iter is already at the end, it is left unchanged and %FALSE is returned. + - %TRUE if @iter was successfully advanced + %TRUE if @iter was successfully advanced - a `PangoScriptIter` + a `PangoScriptIter` - Flags influencing the shaping process. + Flags influencing the shaping process. `PangoShapeFlags` can be passed to [func@Pango.shape_with_flags]. - Default value. + Default value. - Round glyph positions + Round glyph positions and widths to whole device units. This option should be set if the target renderer can't do subpixel positioning of glyphs. - These flags affect how Pango treats characters that are normally + These flags affect how Pango treats characters that are normally not visible in the output. - No special treatment for invisible characters + No special treatment for invisible characters - Render spaces, tabs and newlines visibly + Render spaces, tabs and newlines visibly - Render line breaks visibly + Render line breaks visibly - Render default-ignorable Unicode + Render default-ignorable Unicode characters visibly - An enumeration specifying the width of the font relative to other designs + An enumeration specifying the width of the font relative to other designs within a family. - ultra condensed width + ultra condensed width - extra condensed width + extra condensed width - condensed width + condensed width - semi condensed width + semi condensed width - the normal width + the normal width - semi expanded width + semi expanded width - expanded width + expanded width - extra expanded width + extra expanded width - ultra expanded width + ultra expanded width - An enumeration specifying the various slant styles possible for a font. + An enumeration specifying the various slant styles possible for a font. - the font is upright. + the font is upright. - the font is slanted, but in a roman style. + the font is slanted, but in a roman style. - the font is slanted in an italic style. + the font is slanted in an italic style. - `PangoTabAlign` specifies where a tab stop appears relative to the text. + `PangoTabAlign` specifies where a tab stop appears relative to the text. - the tab stop appears to the left of the text. + the tab stop appears to the left of the text. - A `PangoTabArray` contains an array of tab stops. + A `PangoTabArray` contains an array of tab stops. `PangoTabArray` can be used to set tab stops in a `PangoLayout`. Each tab stop has an alignment and a position. + - Creates an array of @initial_size tab stops. + Creates an array of @initial_size tab stops. Tab stops are specified in pixel units if @positions_in_pixels is %TRUE, otherwise in Pango units. All stops are initially at position 0. + - the newly allocated `PangoTabArray`, which should + the newly allocated `PangoTabArray`, which should be freed with [method@Pango.TabArray.free]. - Initial number of tab stops to allocate, can be 0 + Initial number of tab stops to allocate, can be 0 - whether positions are in pixel units + whether positions are in pixel units - Creates a `PangoTabArray` and allows you to specify the alignment + Creates a `PangoTabArray` and allows you to specify the alignment and position of each tab stop. You **must** provide an alignment and position for @size tab stops. + - the newly allocated `PangoTabArray`, which should + the newly allocated `PangoTabArray`, which should be freed with [method@Pango.TabArray.free]. - number of tab stops in the array + number of tab stops in the array - whether positions are in pixel units + whether positions are in pixel units - alignment of first tab stop + alignment of first tab stop - position of first tab stop + position of first tab stop - additional alignment/position pairs + additional alignment/position pairs - Copies a `PangoTabArray`. + Copies a `PangoTabArray`. + - the newly allocated `PangoTabArray`, which should + the newly allocated `PangoTabArray`, which should be freed with [method@Pango.TabArray.free]. - `PangoTabArray` to copy + `PangoTabArray` to copy - Frees a tab array and associated resources. + Frees a tab array and associated resources. + - a `PangoTabArray` + a `PangoTabArray` - Returns %TRUE if the tab positions are in pixels, + Returns %TRUE if the tab positions are in pixels, %FALSE if they are in Pango units. + - whether positions are in pixels. + whether positions are in pixels. - a `PangoTabArray` + a `PangoTabArray` - Gets the number of tab stops in @tab_array. + Gets the number of tab stops in @tab_array. + - the number of tab stops in the array. + the number of tab stops in the array. - a `PangoTabArray` + a `PangoTabArray` - Gets the alignment and position of a tab stop. + Gets the alignment and position of a tab stop. + - a `PangoTabArray` + a `PangoTabArray` - tab stop index + tab stop index - location to store alignment + location to store alignment - location to store tab position + location to store tab position - If non-%NULL, @alignments and @locations are filled with allocated + If non-%NULL, @alignments and @locations are filled with allocated arrays. The arrays are of length [method@Pango.TabArray.get_size]. You must free the returned array. + - a `PangoTabArray` + a `PangoTabArray` - location to store an array of tab + location to store an array of tab stop alignments - location to store an array + location to store an array of tab positions @@ -10906,75 +11444,78 @@ You must free the returned array. - Resizes a tab array. + Resizes a tab array. You must subsequently initialize any tabs that were added as a result of growing the array. + - a `PangoTabArray` + a `PangoTabArray` - new size of the array + new size of the array - Sets the alignment and location of a tab stop. + Sets the alignment and location of a tab stop. @alignment must always be %PANGO_TAB_LEFT in the current implementation. + - a `PangoTabArray` + a `PangoTabArray` - the index of a tab stop + the index of a tab stop - tab alignment + tab alignment - tab location in Pango units + tab location in Pango units - Rounds a dimension to whole device units, but does not + Rounds a dimension to whole device units, but does not convert it to device units. + - a dimension in Pango units. + a dimension in Pango units. - The `PangoUnderline` enumeration is used to specify whether text + The `PangoUnderline` enumeration is used to specify whether text should be underlined, and if so, the type of underlining. - no underline should be drawn + no underline should be drawn - a single underline should be drawn + a single underline should be drawn - a double underline should be drawn + a double underline should be drawn - a single underline should be drawn at a + a single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. @@ -10982,7 +11523,7 @@ should be underlined, and if so, the type of underlining. portions of text. - an underline indicating an error should + an underline indicating an error should be drawn below. The exact style of rendering is up to the `PangoRenderer` in use, but typical styles include wavy or dotted lines. @@ -10992,122 +11533,128 @@ should be underlined, and if so, the type of underlining. available since Pango 1.4. - Like @PANGO_UNDERLINE_SINGLE, but + Like @PANGO_UNDERLINE_SINGLE, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46. - Like @PANGO_UNDERLINE_DOUBLE, but + Like @PANGO_UNDERLINE_DOUBLE, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46. - Like @PANGO_UNDERLINE_ERROR, but + Like @PANGO_UNDERLINE_ERROR, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46. - Checks that the version of Pango available at compile-time is not older than + Checks that the version of Pango available at compile-time is not older than the provided version number. + - the major component of the version number + the major component of the version number - the minor component of the version number + the minor component of the version number - the micro component of the version number + the micro component of the version number - This macro encodes the given Pango version into an integer. The numbers + This macro encodes the given Pango version into an integer. The numbers returned by %PANGO_VERSION and pango_version() are encoded using this macro. Two encoded version numbers can be compared as integers. + - the major component of the version number + the major component of the version number - the minor component of the version number + the minor component of the version number - the micro component of the version number + the micro component of the version number - The major component of the version of Pango available at compile-time. + The major component of the version of Pango available at compile-time. + - The micro component of the version of Pango available at compile-time. + The micro component of the version of Pango available at compile-time. + - The minor component of the version of Pango available at compile-time. + The minor component of the version of Pango available at compile-time. + - A string literal containing the version of Pango available at compile-time. + A string literal containing the version of Pango available at compile-time. + - An enumeration specifying capitalization variant of the font. + An enumeration specifying capitalization variant of the font. - A normal font. + A normal font. - A font with the lower case characters + A font with the lower case characters replaced by smaller variants of the capital characters. - An enumeration specifying the weight (boldness) of a font. + An enumeration specifying the weight (boldness) of a font. This is a numerical value ranging from 100 to 1000, but there are some predefined values. - the thin weight (= 100; Since: 1.24) + the thin weight (= 100; Since: 1.24) - the ultralight weight (= 200) + the ultralight weight (= 200) - the light weight (= 300) + the light weight (= 300) - the semilight weight (= 350; Since: 1.36.7) + the semilight weight (= 350; Since: 1.36.7) - the book weight (= 380; Since: 1.24) + the book weight (= 380; Since: 1.24) - the default weight (= 400) + the default weight (= 400) - the normal weight (= 500; Since: 1.24) + the normal weight (= 500; Since: 1.24) - the semibold weight (= 600) + the semibold weight (= 600) - the bold weight (= 700) + the bold weight (= 700) - the ultrabold weight (= 800) + the ultrabold weight (= 800) - the heavy weight (= 900) + the heavy weight (= 900) - the ultraheavy weight (= 1000; Since: 1.24) + the ultraheavy weight (= 1000; Since: 1.24) - `PangoWrapMode` describes how to wrap the lines of a `PangoLayout` + `PangoWrapMode` describes how to wrap the lines of a `PangoLayout` to the desired width. For @PANGO_WRAP_WORD, Pango uses break opportunities that are determined @@ -11115,519 +11662,546 @@ by the Unicode line breaking algorithm. For @PANGO_WRAP_CHAR, Pango allows breaking at grapheme boundaries that are determined by the Unicode text segmentation algorithm. - wrap lines at word boundaries. + wrap lines at word boundaries. - wrap lines at character boundaries. + wrap lines at character boundaries. - wrap lines at word boundaries, but fall back to + wrap lines at word boundaries, but fall back to character boundaries if there is not enough space for a full word. - Create a new allow-breaks attribute. + Create a new allow-breaks attribute. If breaks are disabled, the range will be kept in a single run, as far as possible. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - %TRUE if we line breaks are allowed + %TRUE if we line breaks are allowed - Create a new background alpha attribute. + Create a new background alpha attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the alpha value, between 1 and 65536 + the alpha value, between 1 and 65536 - Create a new background color attribute. + Create a new background color attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the red value (ranging from 0 to 65535) + the red value (ranging from 0 to 65535) - the green value + the green value - the blue value + the blue value - Create a new font fallback attribute. + Create a new font fallback attribute. If fallback is disabled, characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - %TRUE if we should fall back on other fonts + %TRUE if we should fall back on other fonts for characters the active font is missing - Create a new font family attribute. + Create a new font family attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the family or comma-separated list of families + the family or comma-separated list of families - Create a new font description attribute. + Create a new font description attribute. This attribute allows setting family, style, weight, variant, stretch, and size simultaneously. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the font description + the font description - Create a new font features tag attribute. + Create a new font features tag attribute. You can use this attribute to select OpenType font features like small-caps, alternative glyphs, ligatures, etc. for fonts that support them. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - a string with OpenType font features, with the syntax of the [CSS + a string with OpenType font features, with the syntax of the [CSS font-feature-settings property](https://www.w3.org/TR/css-fonts-4/#font-rend-desc) - Create a new foreground alpha attribute. + Create a new foreground alpha attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the alpha value, between 1 and 65536 + the alpha value, between 1 and 65536 - Create a new foreground color attribute. + Create a new foreground color attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the red value (ranging from 0 to 65535) + the red value (ranging from 0 to 65535) - the green value + the green value - the blue value + the blue value - Create a new gravity hint attribute. + Create a new gravity hint attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the gravity hint value + the gravity hint value - Create a new gravity attribute. + Create a new gravity attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the gravity value; should not be %PANGO_GRAVITY_AUTO + the gravity value; should not be %PANGO_GRAVITY_AUTO - Create a new insert-hyphens attribute. + Create a new insert-hyphens attribute. Pango will insert hyphens when breaking lines in the middle of a word. This attribute can be used to suppress the hyphen. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - %TRUE if hyphens should be inserted + %TRUE if hyphens should be inserted - Create a new language tag attribute. + Create a new language tag attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - language tag + language tag - Create a new letter-spacing attribute. + Create a new letter-spacing attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - amount of extra space to add between + amount of extra space to add between graphemes of the text, in Pango units - Create a new overline color attribute. + Create a new overline color attribute. This attribute modifies the color of overlines. If not set, overlines will use the foreground color. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the red value (ranging from 0 to 65535) + the red value (ranging from 0 to 65535) - the green value + the green value - the blue value + the blue value - Create a new overline-style attribute. + Create a new overline-style attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the overline style + the overline style - Create a new baseline displacement attribute. + Create a new baseline displacement attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the amount that the text should be displaced vertically, + the amount that the text should be displaced vertically, in Pango units. Positive values displace the text upwards. - Create a new font size scale attribute. + Create a new font size scale attribute. The base font for the affected text will have its size multiplied by @scale_factor. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - factor to scale the font + factor to scale the font - Create a new shape attribute. + Create a new shape attribute. A shape is used to impose a particular ink and logical rectangle on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a `PangoLayout`. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - ink rectangle to assign to each character + ink rectangle to assign to each character - logical rectangle to assign to each character + logical rectangle to assign to each character - Creates a new shape attribute. + Creates a new shape attribute. Like [func@Pango.AttrShape.new], but a user data pointer is also provided; this pointer can be accessed when later rendering the glyph. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - ink rectangle to assign to each character + ink rectangle to assign to each character - logical rectangle to assign to each character + logical rectangle to assign to each character - user data pointer + user data pointer - function to copy @data when the + function to copy @data when the attribute is copied. If %NULL, @data is simply copied as a pointer - function to free @data when the + function to free @data when the attribute is freed - Create a new attribute that influences how invisible + Create a new attribute that influences how invisible characters are rendered. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - `PangoShowFlags` to apply + `PangoShowFlags` to apply - Create a new font-size attribute in fractional points. + Create a new font-size attribute in fractional points. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the font size, in %PANGO_SCALE-ths of a point + the font size, in %PANGO_SCALE-ths of a point - Create a new font-size attribute in device units. + Create a new font-size attribute in device units. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the font size, in %PANGO_SCALE-ths of a device unit + the font size, in %PANGO_SCALE-ths of a device unit - Create a new font stretch attribute. + Create a new font stretch attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the stretch + the stretch - Create a new strikethrough color attribute. + Create a new strikethrough color attribute. This attribute modifies the color of strikethrough lines. If not set, strikethrough lines will use the foreground color. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the red value (ranging from 0 to 65535) + the red value (ranging from 0 to 65535) - the green value + the green value - the blue value + the blue value - Create a new strike-through attribute. + Create a new strike-through attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - %TRUE if the text should be struck-through + %TRUE if the text should be struck-through - Create a new font slant style attribute. + Create a new font slant style attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the slant style + the slant style - Fetches the attribute type name. + Fetches the attribute type name. The attribute type name is the string passed in when registering the type using @@ -11636,195 +12210,204 @@ when registering the type using The returned value is an interned string (see g_intern_string() for what that means) that should not be modified or freed. + - the type ID name (which + the type ID name (which may be %NULL), or %NULL if @type is a built-in Pango attribute type or invalid. - an attribute type ID to fetch the name for + an attribute type ID to fetch the name for - Allocate a new attribute type ID. + Allocate a new attribute type ID. The attribute type name can be accessed later by using [func@Pango.AttrType.get_name]. + - the new type ID. + the new type ID. - an identifier for the type + an identifier for the type - Create a new underline color attribute. + Create a new underline color attribute. This attribute modifies the color of underlines. If not set, underlines will use the foreground color. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the red value (ranging from 0 to 65535) + the red value (ranging from 0 to 65535) - the green value + the green value - the blue value + the blue value - Create a new underline-style attribute. + Create a new underline-style attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the underline style + the underline style - Create a new font variant attribute (normal or small caps). + Create a new font variant attribute (normal or small caps). + - the newly allocated `PangoAttribute`, + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy]. - the variant + the variant - Create a new font weight attribute. + Create a new font weight attribute. + - the newly allocated + the newly allocated `PangoAttribute`, which should be freed with [method@Pango.Attribute.destroy] - the weight + the weight - Determines the bidirectional type of a character. + Determines the bidirectional type of a character. The bidirectional type is specified in the Unicode Character Database. A simplified version of this function is available as [func@unichar_direction]. + - the bidirectional character type, as used in the + the bidirectional character type, as used in the Unicode bidirectional algorithm. - a Unicode character + a Unicode character - Determines possible line, word, and character breaks + Determines possible line, word, and character breaks for a string of Unicode text with a single analysis. For most purposes you may want to use [func@Pango.get_log_attrs]. Use [func@Pango.default_break] and [func@Pango.tailor_break] + - the text to process. Must be valid UTF-8 + the text to process. Must be valid UTF-8 - length of @text in bytes (may be -1 if @text is nul-terminated) + length of @text in bytes (may be -1 if @text is nul-terminated) - `PangoAnalysis` structure for @text + `PangoAnalysis` structure for @text - an array to store character information in + an array to store character information in - size of the array passed as @attrs + size of the array passed as @attrs - This is the default break algorithm. + This is the default break algorithm. It applies Unicode rules without language-specific tailoring, therefore the @analyis argument is unused and can be %NULL. See [func@Pango.tailor_break] for language-specific breaks. + - text to break. Must be valid UTF-8 + text to break. Must be valid UTF-8 - length of text in bytes (may be -1 if @text is nul-terminated) + length of text in bytes (may be -1 if @text is nul-terminated) - a `PangoAnalysis` structure for the @text + a `PangoAnalysis` structure for the @text - logical attributes to fill in + logical attributes to fill in - size of the array passed as @attrs + size of the array passed as @attrs - Converts extents from Pango units to device units. + Converts extents from Pango units to device units. The conversion is done by dividing by the %PANGO_SCALE factor and performing rounding. @@ -11841,41 +12424,43 @@ rectangle to completely contain the original rectangle, pass it in as @inclusive. If you want two touching-but-not-overlapping rectangles stay touching-but-not-overlapping after rounding to device units, pass them in as @nearest. + - rectangle to round to pixels inclusively + rectangle to round to pixels inclusively - rectangle to round to nearest pixels + rectangle to round to nearest pixels - Searches a string the first character that has a strong + Searches a string the first character that has a strong direction, according to the Unicode bidirectional algorithm. + - The direction corresponding to the first strong character. + The direction corresponding to the first strong character. If no such character is found, then %PANGO_DIRECTION_NEUTRAL is returned. - the text to process. Must be valid UTF-8 + the text to process. Must be valid UTF-8 - length of @text in bytes (may be -1 if @text is nul-terminated) + length of @text in bytes (may be -1 if @text is nul-terminated) - Locates a paragraph boundary in @text. + Locates a paragraph boundary in @text. A boundary is caused by delimiter characters, such as a newline, carriage return, carriage return-newline pair, @@ -11889,32 +12474,33 @@ in @next_paragraph_start. If no delimiters are found, both @paragraph_delimiter_index and @next_paragraph_start are filled with the length of @text (an index one off the end). + - UTF-8 text + UTF-8 text - length of @text in bytes, or -1 if nul-terminated + length of @text in bytes, or -1 if nul-terminated - return location for index of + return location for index of delimiter - return location for start of next + return location for start of next paragraph - Creates a new font description from a string representation. + Creates a new font description from a string representation. The string must have the form @@ -11957,19 +12543,20 @@ size in the resulting font description will be set to 0. A typical example: "Cantarell Italic Light 15 \@wght=200" + - a new `PangoFontDescription`. + a new `PangoFontDescription`. - string representation of a font description. + string representation of a font description. - Computes a `PangoLogAttr` for each character in @text. + Computes a `PangoLogAttr` for each character in @text. The @log_attrs array must have one `PangoLogAttr` for each position in @text; if @text contains N characters, @@ -11978,106 +12565,110 @@ end of the text. @text should be an entire paragraph; logical attributes can't be computed without context (for example you need to see spaces on either side of a word to know the word is a word). + - text to process. Must be valid UTF-8 + text to process. Must be valid UTF-8 - length in bytes of @text + length in bytes of @text - embedding level, or -1 if unknown + embedding level, or -1 if unknown - language tag + language tag - array with one `PangoLogAttr` + array with one `PangoLogAttr` per character in @text, plus one extra, to be filled in - length of @log_attrs array + length of @log_attrs array - Returns the mirrored character of a Unicode character. + Returns the mirrored character of a Unicode character. Mirror characters are determined by the Unicode mirrored property. Use g_unichar_get_mirror_char() instead; the docs for that function provide full details. + - %TRUE if @ch has a mirrored character and @mirrored_ch is + %TRUE if @ch has a mirrored character and @mirrored_ch is filled in, %FALSE otherwise - a Unicode character + a Unicode character - location to store the mirrored character + location to store the mirrored character - Finds the gravity that best matches the rotation component + Finds the gravity that best matches the rotation component in a `PangoMatrix`. + - the gravity of @matrix, which will never be + the gravity of @matrix, which will never be %PANGO_GRAVITY_AUTO, or %PANGO_GRAVITY_SOUTH if @matrix is %NULL - a `PangoMatrix` + a `PangoMatrix` - Returns the gravity to use in laying out a `PangoItem`. + Returns the gravity to use in laying out a `PangoItem`. The gravity is determined based on the script, base gravity, and hint. If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the preferred gravity of @script. To get the preferred gravity of a script, pass %PANGO_GRAVITY_AUTO and %PANGO_GRAVITY_HINT_STRONG in. + - resolved gravity suitable to use for a run of text + resolved gravity suitable to use for a run of text with @script - `PangoScript` to query + `PangoScript` to query - base gravity of the paragraph + base gravity of the paragraph - orientation hint + orientation hint - Returns the gravity to use in laying out a single character + Returns the gravity to use in laying out a single character or `PangoItem`. The gravity is determined based on the script, East Asian width, @@ -12092,66 +12683,69 @@ context. If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the preferred gravity of @script. + - resolved gravity suitable to use for a run of text + resolved gravity suitable to use for a run of text with @script and @wide. - `PangoScript` to query + `PangoScript` to query - %TRUE for wide characters as returned by g_unichar_iswide() + %TRUE for wide characters as returned by g_unichar_iswide() - base gravity of the paragraph + base gravity of the paragraph - orientation hint + orientation hint - Converts a `PangoGravity` value to its natural rotation in radians. + Converts a `PangoGravity` value to its natural rotation in radians. Note that [method@Pango.Matrix.rotate] takes angle in degrees, not radians. So, to call [method@Pango.Matrix,rotate] with the output of this function you should multiply it by (180. / G_PI). + - the rotation value corresponding to @gravity. + the rotation value corresponding to @gravity. - gravity to query, should not be %PANGO_GRAVITY_AUTO + gravity to query, should not be %PANGO_GRAVITY_AUTO - Checks if a character that should not be normally rendered. + Checks if a character that should not be normally rendered. This includes all Unicode characters with "ZERO WIDTH" in their name, as well as *bidi* formatting characters, and a few other ones. This is totally different from g_unichar_iszerowidth() and is at best misnamed. + - %TRUE if @ch is a zero-width character, %FALSE otherwise + %TRUE if @ch is a zero-width character, %FALSE otherwise - a Unicode character + a Unicode character - Breaks a piece of text into segments with consistent directional + Breaks a piece of text into segments with consistent directional level and font. Each byte of @text will be contained in exactly one of the items in the @@ -12163,8 +12757,9 @@ at a range before or containing @start_index; @cached_iter will be advanced to the range covering the position just after @start_index + @length. (i.e. if itemizing in a loop, just keep passing in the same @cached_iter). + - a `GList` of + a `GList` of [struct@Pango.Item] structures. The items should be freed using [method@Pango.Item.free] probably in combination with g_list_free_full(). @@ -12173,41 +12768,42 @@ in the same @cached_iter). - a structure holding information that affects + a structure holding information that affects the itemization process. - the text to itemize. Must be valid UTF-8 + the text to itemize. Must be valid UTF-8 - first byte in @text to process + first byte in @text to process - the number of bytes (not characters) to process + the number of bytes (not characters) to process after @start_index. This must be >= 0. - the set of attributes that apply to @text. + the set of attributes that apply to @text. - Cached attribute iterator + Cached attribute iterator - Like `pango_itemize()`, but with an explicitly specified base direction. + Like `pango_itemize()`, but with an explicitly specified base direction. The base direction is used when computing bidirectional levels. (see [method@Pango.Context.set_base_dir]). [func@itemize] gets the base direction from the `PangoContext`. + - a `GList` of + a `GList` of [struct@Pango.Item] structures. The items should be freed using [method@Pango.Item.free] probably in combination with g_list_free_full(). @@ -12216,39 +12812,39 @@ base direction from the `PangoContext`. - a structure holding information that affects + a structure holding information that affects the itemization process. - base direction to use for bidirectional processing + base direction to use for bidirectional processing - the text to itemize. + the text to itemize. - first byte in @text to process + first byte in @text to process - the number of bytes (not characters) to process + the number of bytes (not characters) to process after @start_index. This must be >= 0. - the set of attributes that apply to @text. + the set of attributes that apply to @text. - Cached attribute iterator + Cached attribute iterator - Convert a language tag to a `PangoLanguage`. + Convert a language tag to a `PangoLanguage`. The language tag must be in a RFC-3066 format. `PangoLanguage` pointers can be efficiently copied (copy the pointer) and compared with other @@ -12260,19 +12856,20 @@ than letters and '-'. Use [func@Pango.Language.get_default] if you want to get the `PangoLanguage` for the current locale of the process. + - a `PangoLanguage` + a `PangoLanguage` - a string representing a language tag + a string representing a language tag - Returns the `PangoLanguage` for the current locale of the process. + Returns the `PangoLanguage` for the current locale of the process. On Unix systems, this is the return value is derived from `setlocale (LC_CTYPE, NULL)`, and the user can @@ -12299,13 +12896,14 @@ functions automatically (by calling gtk_set_locale()). See the setlocale() manpage for more details. Note that the default language can change over the life of an application. + - the default language as a `PangoLanguage` + the default language as a `PangoLanguage` - Returns the list of languages that the user prefers. + Returns the list of languages that the user prefers. The list is specified by the `PANGO_LANGUAGE` or `LANGUAGE` environment variables, in order of preference. Note that this @@ -12316,14 +12914,15 @@ When choosing language-specific resources, such as the sample text returned by [method@Pango.Language.get_sample_string], you should first try the default language, followed by the languages returned by this function. + - a %NULL-terminated array + a %NULL-terminated array of `PangoLanguage`* - Return the bidirectional embedding levels of the input paragraph. + Return the bidirectional embedding levels of the input paragraph. The bidirectional embedding levels are defined by the Unicode Bidirectional Algorithm available at: @@ -12332,59 +12931,61 @@ Algorithm available at: If the input base direction is a weak direction, the direction of the characters in the text will determine the final resolved direction. + - a newly allocated array of embedding levels, one item per + a newly allocated array of embedding levels, one item per character (not byte), that should be freed using g_free(). - the text to itemize. + the text to itemize. - the number of bytes (not characters) to process, or -1 + the number of bytes (not characters) to process, or -1 if @text is nul-terminated and the length should be calculated. - input base direction, and output resolved direction. + input base direction, and output resolved direction. - Finishes parsing markup. + Finishes parsing markup. After feeding a Pango markup parser some data with g_markup_parse_context_parse(), use this function to get the list of attributes and text out of the markup. This function will not free @context, use g_markup_parse_context_free() to do so. + - %FALSE if @error is set, otherwise %TRUE + %FALSE if @error is set, otherwise %TRUE - A valid parse context that was returned from [func@markup_parser_new] + A valid parse context that was returned from [func@markup_parser_new] - address of return location for a `PangoAttrList` + address of return location for a `PangoAttrList` - address of return location for text with tags stripped + address of return location for text with tags stripped - address of return location for accelerator char + address of return location for accelerator char - Incrementally parses marked-up text to create a plain-text string + Incrementally parses marked-up text to create a plain-text string and an attribute list. See the [Pango Markup](pango_markup.html) docs for details about the @@ -12406,20 +13007,21 @@ of it, and then use g_markup_parse_context_free() to free it. This function is designed for applications that read Pango markup from streams. To simply parse a string containing Pango markup, the [func@parse_markup] API is recommended instead. + - a `GMarkupParseContext` that should be + a `GMarkupParseContext` that should be destroyed with g_markup_parse_context_free(). - character that precedes an accelerator, or 0 for none + character that precedes an accelerator, or 0 for none - Parses an enum type and stores the result in @value. + Parses an enum type and stores the result in @value. If @str does not match the nick name of any of the possible values for the enum and is not an integer, %FALSE is returned, a warning @@ -12429,36 +13031,37 @@ slash-separated, eg. "none/start/middle/end". If failed and @possible_values is not %NULL, returned string should be freed using g_free(). + - %TRUE if @str was successfully parsed + %TRUE if @str was successfully parsed - enum type to parse, eg. %PANGO_TYPE_ELLIPSIZE_MODE + enum type to parse, eg. %PANGO_TYPE_ELLIPSIZE_MODE - string to parse + string to parse - integer to store the result in + integer to store the result in - if %TRUE, issue a g_warning() on bad input + if %TRUE, issue a g_warning() on bad input - place to store list of possible + place to store list of possible values on failure - Parses marked-up text to create a plain-text string and an attribute list. + Parses marked-up text to create a plain-text string and an attribute list. See the [Pango Markup](pango_markup.html) docs for details about the supported markup. @@ -12475,140 +13078,145 @@ To parse a stream of pango markup incrementally, use [func@markup_parser_new]. If any error happens, none of the output arguments are touched except for @error. + - %FALSE if @error is set, otherwise %TRUE + %FALSE if @error is set, otherwise %TRUE - markup to parse (see the Pango Markup docs) + markup to parse (see the Pango Markup docs) - length of @markup_text, or -1 if nul-terminated + length of @markup_text, or -1 if nul-terminated - character that precedes an accelerator, or 0 for none + character that precedes an accelerator, or 0 for none - address of return location for a `PangoAttrList` + address of return location for a `PangoAttrList` - address of return location for text with tags stripped + address of return location for text with tags stripped - address of return location for accelerator char + address of return location for accelerator char - Parses a font stretch. + Parses a font stretch. The allowed values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" and "ultra_expanded". Case variations are ignored and the '_' characters may be omitted. + - %TRUE if @str was successfully parsed. + %TRUE if @str was successfully parsed. - a string to parse. + a string to parse. - a `PangoStretch` to store the result in. + a `PangoStretch` to store the result in. - if %TRUE, issue a g_warning() on bad input. + if %TRUE, issue a g_warning() on bad input. - Parses a font style. + Parses a font style. The allowed values are "normal", "italic" and "oblique", case variations being ignored. + - %TRUE if @str was successfully parsed. + %TRUE if @str was successfully parsed. - a string to parse. + a string to parse. - a `PangoStyle` to store the result in. + a `PangoStyle` to store the result in. - if %TRUE, issue a g_warning() on bad input. + if %TRUE, issue a g_warning() on bad input. - Parses a font variant. + Parses a font variant. The allowed values are "normal" and "smallcaps" or "small_caps", case variations being ignored. + - %TRUE if @str was successfully parsed. + %TRUE if @str was successfully parsed. - a string to parse. + a string to parse. - a `PangoVariant` to store the result in. + a `PangoVariant` to store the result in. - if %TRUE, issue a g_warning() on bad input. + if %TRUE, issue a g_warning() on bad input. - Parses a font weight. + Parses a font weight. The allowed values are "heavy", "ultrabold", "bold", "normal", "light", "ultraleight" and integers. Case variations are ignored. + - %TRUE if @str was successfully parsed. + %TRUE if @str was successfully parsed. - a string to parse. + a string to parse. - a `PangoWeight` to store the result in. + a `PangoWeight` to store the result in. - if %TRUE, issue a g_warning() on bad input. + if %TRUE, issue a g_warning() on bad input. - Quantizes the thickness and position of a line to whole device pixels. + Quantizes the thickness and position of a line to whole device pixels. This is typically used for underline or strikethrough. The purpose of this function is to avoid such lines looking blurry. @@ -12616,22 +13224,23 @@ this function is to avoid such lines looking blurry. Care is taken to make sure @thickness is at least one pixel when this function returns, but returned @position may become zero as a result of rounding. + - pointer to the thickness of a line, in Pango units + pointer to the thickness of a line, in Pango units - corresponding position + corresponding position - Reads an entire line from a file into a buffer. + Reads an entire line from a file into a buffer. Lines may be delimited with '\n', '\r', '\n\r', or '\r\n'. The delimiter is not written into the buffer. Text after a '#' character is treated as @@ -12639,25 +13248,26 @@ a comment and skipped. '\' can be used to escape a # character. '\' proceeding a line delimiter combines adjacent lines. A '\' proceeding any other character is ignored and written into the output buffer unmodified. + - 0 if the stream was already at an %EOF character, + 0 if the stream was already at an %EOF character, otherwise the number of lines read (this is useful for maintaining a line number counter which doesn't combine lines with '\') - a stdio stream + a stdio stream - `GString` buffer into which to write the result + `GString` buffer into which to write the result - Reorder items from logical order to visual order. + Reorder items from logical order to visual order. The visual order is determined from the associated directional levels of the items. The original list is unmodified. @@ -12665,8 +13275,9 @@ levels of the items. The original list is unmodified. (Please open a bug if you use this function. It is not a particularly convenient interface, and the code is duplicated elsewhere in Pango for that reason.) + - a `GList` + a `GList` of `PangoItem` structures in visual order. @@ -12674,7 +13285,7 @@ levels of the items. The original list is unmodified. - a `GList` of `PangoItem` + a `GList` of `PangoItem` in logical order. @@ -12683,67 +13294,70 @@ levels of the items. The original list is unmodified. - Scans an integer. + Scans an integer. Leading white space is skipped. + - %FALSE if a parse error occurred + %FALSE if a parse error occurred - in/out string position + in/out string position - an int into which to write the result + an int into which to write the result - Scans a string into a `GString` buffer. + Scans a string into a `GString` buffer. The string may either be a sequence of non-white-space characters, or a quoted string with '"'. Instead a quoted string, '\"' represents a literal quote. Leading white space outside of quotes is skipped. + - %FALSE if a parse error occurred + %FALSE if a parse error occurred - in/out string position + in/out string position - a `GString` into which to write the result + a `GString` into which to write the result - Scans a word into a `GString` buffer. + Scans a word into a `GString` buffer. A word consists of [A-Za-z_] followed by zero or more [A-Za-z_0-9]. Leading white space is skipped. + - %FALSE if a parse error occurred + %FALSE if a parse error occurred - in/out string position + in/out string position - a `GString` into which to write the result + a `GString` into which to write the result - Looks up the script for a particular character. + Looks up the script for a particular character. The script of a character is defined by Unicode Standard Annex \#24. No check is made for @ch being a valid Unicode character; if you pass @@ -12754,19 +13368,20 @@ as `PangoScript`, as of Pango 1.18, this function simply returns the return value of g_unichar_get_script(). Callers must be prepared to handle unknown values. Use g_unichar_get_script() + - the `PangoScript` for the character. + the `PangoScript` for the character. - a Unicode character + a Unicode character - Finds a language tag that is reasonably representative of @script. + Finds a language tag that is reasonably representative of @script. The language will usually be the most widely spoken or used language written in that script: for instance, the sample language for @@ -12795,20 +13410,21 @@ instead of Arabic (ar) when a segment of Arabic text is found in an otherwise non-Arabic text. The same trick can be used to choose a default language for %PANGO_SCRIPT_HAN when setting context language is not feasible. + - a `PangoLanguage` that is representative + a `PangoLanguage` that is representative of the script - a `PangoScript` + a `PangoScript` - Convert the characters in @text into glyphs. + Convert the characters in @text into glyphs. Given a segment of text and the corresponding `PangoAnalysis` structure returned from [func@itemize], convert the characters into glyphs. You @@ -12822,30 +13438,31 @@ Note that the extra attributes in the @analyis that is returned from [func@itemize] have indices that are relative to the entire paragraph, so you need to subtract the item offset from their indices before calling [func@shape]. + - the text to process + the text to process - the length (in bytes) of @text + the length (in bytes) of @text - `PangoAnalysis` structure from [func@itemize] + `PangoAnalysis` structure from [func@itemize] - glyph string in which to store results + glyph string in which to store results - Convert the characters in @text into glyphs. + Convert the characters in @text into glyphs. Given a segment of text and the corresponding `PangoAnalysis` structure returned from [func@itemize], convert the characters into glyphs. You may @@ -12861,38 +13478,39 @@ Note that the extra attributes in the @analyis that is returned from [func@itemize] have indices that are relative to the entire paragraph, so you do not pass the full paragraph text as @paragraph_text, you need to subtract the item offset from their indices before calling [func@shape_full]. + - valid UTF-8 text to shape. + valid UTF-8 text to shape. - the length (in bytes) of @item_text. -1 means nul-terminated text. + the length (in bytes) of @item_text. -1 means nul-terminated text. - text of the paragraph (see details). May be %NULL. + text of the paragraph (see details). May be %NULL. - the length (in bytes) of @paragraph_text. -1 means nul-terminated text. + the length (in bytes) of @paragraph_text. -1 means nul-terminated text. - `PangoAnalysis` structure from [func@itemize]. + `PangoAnalysis` structure from [func@itemize]. - glyph string in which to store results. + glyph string in which to store results. - Convert the characters in @text into glyphs. + Convert the characters in @text into glyphs. Given a segment of text and the corresponding `PangoAnalysis` structure returned from [func@itemize], convert the characters into glyphs. You may @@ -12906,62 +13524,65 @@ Note that the extra attributes in the @analyis that is returned from so you do not pass the full paragraph text as @paragraph_text, you need to subtract the item offset from their indices before calling [func@shape_with_flags]. + - valid UTF-8 text to shape + valid UTF-8 text to shape - the length (in bytes) of @item_text. + the length (in bytes) of @item_text. -1 means nul-terminated text. - text of the paragraph (see details). + text of the paragraph (see details). May be %NULL. - the length (in bytes) of @paragraph_text. + the length (in bytes) of @paragraph_text. -1 means nul-terminated text. - `PangoAnalysis` structure from [func@itemize] + `PangoAnalysis` structure from [func@itemize] - glyph string in which to store results + glyph string in which to store results - flags influencing the shaping process + flags influencing the shaping process - Skips 0 or more characters of white space. + Skips 0 or more characters of white space. + - %FALSE if skipping the white space leaves + %FALSE if skipping the white space leaves the position at a '\0' character. - in/out string position + in/out string position - Splits a %G_SEARCHPATH_SEPARATOR-separated list of files, stripping + Splits a %G_SEARCHPATH_SEPARATOR-separated list of files, stripping white space and substituting ~/ with $HOME/. + - a list of + a list of strings to be freed with g_strfreev() @@ -12969,13 +13590,13 @@ white space and substituting ~/ with $HOME/. - a %G_SEARCHPATH_SEPARATOR separated list of filenames + a %G_SEARCHPATH_SEPARATOR separated list of filenames - Apply language-specific tailoring to the breaks + Apply language-specific tailoring to the breaks in @log_attrs. The line breaks are assumed to have been produced @@ -12983,55 +13604,57 @@ by [func@Pango.default_break]. If @offset is not -1, it is used to apply attributes from @analysis that are relevant to line breaking. + - text to process. Must be valid UTF-8 + text to process. Must be valid UTF-8 - length in bytes of @text + length in bytes of @text - `PangoAnalysis` for @text + `PangoAnalysis` for @text - Byte offset of @text from the beginning of the + Byte offset of @text from the beginning of the paragraph, or -1 to ignore attributes from @analysis - array with one `PangoLogAttr` + array with one `PangoLogAttr` per character in @text, plus one extra, to be filled in - length of @log_attrs array + length of @log_attrs array - Trims leading and trailing whitespace from a string. + Trims leading and trailing whitespace from a string. + - A newly-allocated string that must be freed with g_free() + A newly-allocated string that must be freed with g_free() - a string + a string - Determines the inherent direction of a character. + Determines the inherent direction of a character. The inherent direction is either %PANGO_DIRECTION_LTR, %PANGO_DIRECTION_RTL, or %PANGO_DIRECTION_NEUTRAL. @@ -13040,61 +13663,65 @@ This function is useful to categorize characters into left-to-right letters, right-to-left letters, and everything else. If full Unicode bidirectional type of a character is needed, [func@Pango.BidiType.for_unichar] can be used instead. + - the direction of the character. + the direction of the character. - a Unicode character + a Unicode character - Converts a floating-point number to Pango units. + Converts a floating-point number to Pango units. The conversion is done by multiplying @d by %PANGO_SCALE and rounding the result to nearest integer. + - the value in Pango units. + the value in Pango units. - double floating-point value + double floating-point value - Converts a number in Pango units to floating-point. + Converts a number in Pango units to floating-point. The conversion is done by dividing @i by %PANGO_SCALE. + - the double value. + the double value. - value in Pango units + value in Pango units - Returns the encoded version of Pango available at run-time. + Returns the encoded version of Pango available at run-time. This is similar to the macro %PANGO_VERSION except that the macro returns the encoded version available at compile-time. A version number can be encoded into an integer using PANGO_VERSION_ENCODE(). + - The encoded version of Pango library available at run time. + The encoded version of Pango library available at run time. - Checks that the Pango library in use is compatible with the + Checks that the Pango library in use is compatible with the given version. Generally you would pass in the constants %PANGO_VERSION_MAJOR, @@ -13111,8 +13738,9 @@ version @required_major.required_minor.@required_micro (same major version.) For compile-time version checking use PANGO_VERSION_CHECK(). + - %NULL if the Pango library is compatible + %NULL if the Pango library is compatible with the given version, or a string describing the version mismatch. The returned string is owned by Pango and should not be modified or freed. @@ -13120,26 +13748,27 @@ For compile-time version checking use PANGO_VERSION_CHECK(). - the required major version + the required major version - the required minor version + the required minor version - the required major version + the required major version - Returns the version of Pango available at run-time. + Returns the version of Pango available at run-time. This is similar to the macro %PANGO_VERSION_STRING except that the macro returns the version available at compile-time. + - A string containing the version of Pango library available + A string containing the version of Pango library available at run time. The returned string is owned by Pango and should not be modified or freed. diff --git a/PangoCairo-1.0.gir b/PangoCairo-1.0.gir index 7ef90a9..e5886f3 100644 --- a/PangoCairo-1.0.gir +++ b/PangoCairo-1.0.gir @@ -2,58 +2,101 @@ - + - - + + + - + + - - `PangoCairoFont` is an interface exported by fonts for + + `PangoCairoFont` is an interface exported by fonts for use with Cairo. The actual type of the font will depend on the particular font technology Cairo was compiled to use. - - Gets the `cairo_scaled_font_t` used by @font. + + Gets the `cairo_scaled_font_t` used by @font. The scaled font can be referenced and kept using cairo_scaled_font_reference(). + - the `cairo_scaled_font_t` + the `cairo_scaled_font_t` used by @font - - a `PangoFont` from a `PangoCairoFontMap` + + a `PangoFont` from a `PangoCairoFontMap` - - `PangoCairoFontMap` is an interface exported by font maps for + + `PangoCairoFontMap` is an interface exported by font maps for use with Cairo. The actual type of the font map will depend on the particular font technology Cairo was compiled to use. - - Gets a default `PangoCairoFontMap` to use with Cairo. + + Gets a default `PangoCairoFontMap` to use with Cairo. Note that the type of the returned object will depend on the particular font backend Cairo was compiled to use; you generally @@ -68,15 +111,22 @@ for example. Note that since Pango 1.32.6, the default fontmap is per-thread. Each thread gets its own default fontmap. In this way, PangoCairo can be used safely from multiple threads. + - the default PangoCairo fontmap + the default PangoCairo fontmap for the current thread. This object is owned by Pango and must not be freed. - - Creates a new `PangoCairoFontMap` object. + + Creates a new `PangoCairoFontMap` object. A fontmap is used to cache information about available fonts, and holds certain global parameters such as the resolution. @@ -94,20 +144,30 @@ based on your build, are fc (fontconfig), win32, and coretext. If requested type is not available, NULL is returned. Ie. this is only useful for testing, when at least two backends are compiled in. + - the newly allocated `PangoFontMap`, + the newly allocated `PangoFontMap`, which should be freed with g_object_unref(). - - Creates a new `PangoCairoFontMap` object of the type suitable + + Creates a new `PangoCairoFontMap` object of the type suitable to be used with cairo font backend of type @fonttype. In most cases one should simply use [func@PangoCairo.FontMap.new], or in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default]. + - the newly allocated + the newly allocated `PangoFontMap` of suitable type which should be freed with g_object_unref(), or %NULL if the requested cairo font backend is not supported / compiled in. @@ -115,55 +175,91 @@ in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default].< - desired #cairo_font_type_t + desired #cairo_font_type_t - - Create a `PangoContext` for the given fontmap. + + Create a `PangoContext` for the given fontmap. Use pango_font_map_create_context() instead. + - the newly created context; free with g_object_unref(). + the newly created context; free with g_object_unref(). - a `PangoCairoFontMap` + a `PangoCairoFontMap` - - Gets the type of Cairo font backend that @fontmap uses. + + Gets the type of Cairo font backend that @fontmap uses. + - the `cairo_font_type_t` cairo font backend type + the `cairo_font_type_t` cairo font backend type - a `PangoCairoFontMap` + a `PangoCairoFontMap` - - Gets the resolution for the fontmap. + + Gets the resolution for the fontmap. See [method@PangoCairo.FontMap.set_resolution]. + - the resolution in "dots per inch" + the resolution in "dots per inch" - a `PangoCairoFontMap` + a `PangoCairoFontMap` - - Sets a default `PangoCairoFontMap` to use with Cairo. + + Sets a default `PangoCairoFontMap` to use with Cairo. This can be used to change the Cairo font backend that the default fontmap uses for example. The old default font map @@ -178,117 +274,176 @@ still be created using [func@PangoCairo.FontMap.new]. A value of %NULL for @fontmap will cause the current default font map to be released and a new default font map to be created on demand, using [func@PangoCairo.FontMap.new]. + - - The new default font map + + The new default font map - - Sets the resolution for the fontmap. + + Sets the resolution for the fontmap. This is a scale factor between points specified in a `PangoFontDescription` and Cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3). + - a `PangoCairoFontMap` + a `PangoCairoFontMap` - the resolution in "dots per inch". (Physical inches aren't actually + the resolution in "dots per inch". (Physical inches aren't actually involved; the terminology is conventional.) - + + - + + - Function type for rendering attributes of type %PANGO_ATTR_SHAPE + Function type for rendering attributes of type %PANGO_ATTR_SHAPE with Pango's Cairo renderer. + - a Cairo context with current point set to where the shape should + a Cairo context with current point set to where the shape should be rendered - the %PANGO_ATTR_SHAPE to render + the %PANGO_ATTR_SHAPE to render - whether only the shape path should be appended to current + whether only the shape path should be appended to current path of @cr and no filling/stroking done. This will be set to %TRUE when called from pango_cairo_layout_path() and pango_cairo_layout_line_path() rendering functions. - - user data passed to pango_cairo_context_set_shape_renderer() + + user data passed to pango_cairo_context_set_shape_renderer() - - Retrieves any font rendering options previously set with + + Retrieves any font rendering options previously set with [func@PangoCairo.context_set_font_options]. This function does not report options that are derived from the target surface by [func@update_context]. + - the font options previously set on the + the font options previously set on the context, or %NULL if no options have been set. This value is owned by the context and must not be modified or freed. - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - - Gets the resolution for the context. + + Gets the resolution for the context. See [func@PangoCairo.context_set_resolution] + - the resolution in "dots per inch". A negative value will + the resolution in "dots per inch". A negative value will be returned if no resolution has previously been set. - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - - Sets callback function for context to use for rendering attributes + + Sets callback function for context to use for rendering attributes of type %PANGO_ATTR_SHAPE. See `PangoCairoShapeRendererFunc` for details. @@ -296,96 +451,157 @@ See `PangoCairoShapeRendererFunc` for details. Retrieves callback function and associated user data for rendering attributes of type %PANGO_ATTR_SHAPE as set by [func@PangoCairo.context_set_shape_renderer], if any. + - the shape rendering callback + the shape rendering callback previously set on the context, or %NULL if no shape rendering callback have been set. - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - - Pointer to `gpointer` to return user data + + Pointer to `gpointer` to return user data - - Sets the font options used when rendering text with this context. + + Sets the font options used when rendering text with this context. These options override any options that [func@update_context] derives from the target surface. + - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - - a `cairo_font_options_t`, or %NULL to unset + + a `cairo_font_options_t`, or %NULL to unset any previously set options. A copy is made. - - Sets the resolution for the context. + + Sets the resolution for the context. This is a scale factor between points specified in a `PangoFontDescription` and Cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3). + - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - the resolution in "dots per inch". (Physical inches aren't actually + the resolution in "dots per inch". (Physical inches aren't actually involved; the terminology is conventional.) A 0 or negative value means to use the resolution from the font map. - - Sets callback function for context to use for rendering attributes + + Sets callback function for context to use for rendering attributes of type %PANGO_ATTR_SHAPE. See `PangoCairoShapeRendererFunc` for details. + - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - - Callback function for rendering attributes of + + Callback function for rendering attributes of type %PANGO_ATTR_SHAPE, or %NULL to disable shape rendering. - - User data that will be passed to @func. + + User data that will be passed to @func. - - Callback that will be called when the + + Callback that will be called when the context is freed to release @data - - Creates a context object set up to match the current transformation + + Creates a context object set up to match the current transformation and target surface of the Cairo context. This context can then be @@ -395,19 +611,28 @@ This function is a convenience function that creates a context using the default font map, then updates it to @cr. If you just need to create a layout for use with @cr and do not need to access `PangoContext` directly, you can use [func@create_layout] instead. + - the newly created `PangoContext` + the newly created `PangoContext` - a Cairo context + a Cairo context - - Creates a layout object set up to match the current transformation + + Creates a layout object set up to match the current transformation and target surface of the Cairo context. This layout can then be used for text measurement with functions @@ -419,52 +644,77 @@ This function is the most convenient way to use Cairo with Pango, however it is slightly inefficient since it creates a separate `PangoContext` object for each layout. This might matter in an application that was laying out large amounts of text. + - the newly created `PangoLayout` + the newly created `PangoLayout` - a Cairo context + a Cairo context - - Add a squiggly line to the current path in the specified cairo context that + + Add a squiggly line to the current path in the specified cairo context that approximately covers the given rectangle in the style of an underline used to indicate a spelling error. The width of the underline is rounded to an integer number of up/down segments and the resulting rectangle is centered in the original rectangle. + - a Cairo context + a Cairo context - The X coordinate of one corner of the rectangle + The X coordinate of one corner of the rectangle - The Y coordinate of one corner of the rectangle + The Y coordinate of one corner of the rectangle - Non-negative width of the rectangle + Non-negative width of the rectangle - Non-negative height of the rectangle + Non-negative height of the rectangle - - Gets a default `PangoCairoFontMap` to use with Cairo. + + Gets a default `PangoCairoFontMap` to use with Cairo. Note that the type of the returned object will depend on the particular font backend Cairo was compiled to use; you generally @@ -479,15 +729,23 @@ for example. Note that since Pango 1.32.6, the default fontmap is per-thread. Each thread gets its own default fontmap. In this way, PangoCairo can be used safely from multiple threads. + - the default PangoCairo fontmap + the default PangoCairo fontmap for the current thread. This object is owned by Pango and must not be freed. - - Creates a new `PangoCairoFontMap` object. + + Creates a new `PangoCairoFontMap` object. A fontmap is used to cache information about available fonts, and holds certain global parameters such as the resolution. @@ -505,20 +763,31 @@ based on your build, are fc (fontconfig), win32, and coretext. If requested type is not available, NULL is returned. Ie. this is only useful for testing, when at least two backends are compiled in. + - the newly allocated `PangoFontMap`, + the newly allocated `PangoFontMap`, which should be freed with g_object_unref(). - - Creates a new `PangoCairoFontMap` object of the type suitable + + Creates a new `PangoCairoFontMap` object of the type suitable to be used with cairo font backend of type @fonttype. In most cases one should simply use [func@PangoCairo.FontMap.new], or in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default]. + - the newly allocated + the newly allocated `PangoFontMap` of suitable type which should be freed with g_object_unref(), or %NULL if the requested cairo font backend is not supported / compiled in. @@ -526,111 +795,161 @@ in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default].< - desired #cairo_font_type_t + desired #cairo_font_type_t - - Adds the glyphs in @glyphs to the current path in the specified + + Adds the glyphs in @glyphs to the current path in the specified cairo context. The origin of the glyphs (the left edge of the baseline) will be at the current point of the cairo context. + - a Cairo context + a Cairo context - a `PangoFont` from a `PangoCairoFontMap` + a `PangoFont` from a `PangoCairoFontMap` - a `PangoGlyphString` + a `PangoGlyphString` - - Adds the text in `PangoLayoutLine` to the current path in the + + Adds the text in `PangoLayoutLine` to the current path in the specified cairo context. The origin of the glyphs (the left edge of the line) will be at the current point of the cairo context. + - a Cairo context + a Cairo context - a `PangoLayoutLine` + a `PangoLayoutLine` - - Adds the text in a `PangoLayout` to the current path in the + + Adds the text in a `PangoLayout` to the current path in the specified cairo context. The top-left corner of the `PangoLayout` will be at the current point of the cairo context. + - a Cairo context + a Cairo context - a Pango layout + a Pango layout - - Draw a squiggly line in the specified cairo context that approximately + + Draw a squiggly line in the specified cairo context that approximately covers the given rectangle in the style of an underline used to indicate a spelling error. The width of the underline is rounded to an integer number of up/down segments and the resulting rectangle is centered in the original rectangle. + - a Cairo context + a Cairo context - The X coordinate of one corner of the rectangle + The X coordinate of one corner of the rectangle - The Y coordinate of one corner of the rectangle + The Y coordinate of one corner of the rectangle - Non-negative width of the rectangle + Non-negative width of the rectangle - Non-negative height of the rectangle + Non-negative height of the rectangle - - Draws the glyphs in @glyph_item in the specified cairo context, + + Draws the glyphs in @glyph_item in the specified cairo context, embedding the text associated with the glyphs in the output if the output format supports it (PDF for example), otherwise it acts @@ -641,120 +960,174 @@ be drawn at the current point of the cairo context. Note that @text is the start of the text for layout, which is then indexed by `glyph_item->item->offset`. + - a Cairo context + a Cairo context - the UTF-8 text that @glyph_item refers to + the UTF-8 text that @glyph_item refers to - a `PangoGlyphItem` + a `PangoGlyphItem` - - Draws the glyphs in @glyphs in the specified cairo context. + + Draws the glyphs in @glyphs in the specified cairo context. The origin of the glyphs (the left edge of the baseline) will be drawn at the current point of the cairo context. + - a Cairo context + a Cairo context - a `PangoFont` from a `PangoCairoFontMap` + a `PangoFont` from a `PangoCairoFontMap` - a `PangoGlyphString` + a `PangoGlyphString` - - Draws a `PangoLayout` in the specified cairo context. + + Draws a `PangoLayout` in the specified cairo context. The top-left corner of the `PangoLayout` will be drawn at the current point of the cairo context. + - a Cairo context + a Cairo context - a Pango layout + a Pango layout - - Draws a `PangoLayoutLine` in the specified cairo context. + + Draws a `PangoLayoutLine` in the specified cairo context. The origin of the glyphs (the left edge of the line) will be drawn at the current point of the cairo context. + - a Cairo context + a Cairo context - a `PangoLayoutLine` + a `PangoLayoutLine` - - Updates a `PangoContext` previously created for use with Cairo to + + Updates a `PangoContext` previously created for use with Cairo to match the current transformation and target surface of a Cairo context. If any layouts have been created for the context, it's necessary to call [method@Pango.Layout.context_changed] on those layouts. + - a Cairo context + a Cairo context - a `PangoContext`, from a pangocairo font map + a `PangoContext`, from a pangocairo font map - - Updates the private `PangoContext` of a `PangoLayout` created with + + Updates the private `PangoContext` of a `PangoLayout` created with [func@create_layout] to match the current transformation and target surface of a Cairo context. + - a Cairo context + a Cairo context - a `PangoLayout`, from [func@create_layout] + a `PangoLayout`, from [func@create_layout] diff --git a/PangoFT2-1.0.gir b/PangoFT2-1.0.gir index d4b4ec8..6231f68 100644 --- a/PangoFT2-1.0.gir +++ b/PangoFT2-1.0.gir @@ -2,63 +2,112 @@ - + - - + + + - - The `PangoFT2FontMap` is the `PangoFontMap` implementation for FreeType fonts. - - Create a new `PangoFT2FontMap` object. + + The `PangoFT2FontMap` is the `PangoFontMap` implementation for FreeType fonts. + + Create a new `PangoFT2FontMap` object. A fontmap is used to cache information about available fonts, and holds certain global parameters such as the resolution and the default substitute function (see [method@PangoFT2.FontMap.set_default_substitute]). + - the newly created fontmap object. Unref + the newly created fontmap object. Unref with g_object_unref() when you are finished with it. - - Returns a `PangoFT2FontMap`. + + Returns a `PangoFT2FontMap`. This font map is cached and should not be freed. If the font map is no longer needed, it can be released with pango_ft2_shutdown_display(). Use of the global PangoFT2 fontmap is deprecated; use pango_ft2_font_map_new() instead. + - a `PangoFT2FontMap`. + a `PangoFT2FontMap`. - - Create a `PangoContext` for the given fontmap. + + Create a `PangoContext` for the given fontmap. Use [method@Pango.FontMap.create_context] instead. + - the newly created context; free with + the newly created context; free with g_object_unref(). - a `PangoFT2FontMap` + a `PangoFT2FontMap` - - Sets a function that will be called to do final configuration + + Sets a function that will be called to do final configuration substitution on a `FcPattern` before it is used to load the font. @@ -66,51 +115,84 @@ This function can be used to do things like set hinting and antialiasing options. Use [method@PangoFc.FontMap.set_default_substitute] instead. + - a `PangoFT2FontMap` + a `PangoFT2FontMap` - - function to call to to do final config tweaking + + function to call to to do final config tweaking on #FcPattern objects. - - data to pass to @func + + data to pass to @func - function to call when @data is no longer used. + function to call when @data is no longer used. - - Sets the horizontal and vertical resolutions for the fontmap. + + Sets the horizontal and vertical resolutions for the fontmap. + - a `PangoFT2FontMap` + a `PangoFT2FontMap` - dots per inch in the X direction + dots per inch in the X direction - dots per inch in the Y direction + dots per inch in the Y direction - - Call this function any time the results of the + + Call this function any time the results of the default substitution function set with pango_ft2_font_map_set_default_substitute() change. @@ -118,60 +200,90 @@ That is, if your substitution function will return different results for the same input pattern, you must call this function. Use [method@PangoFc.FontMap.substitute_changed] instead. + - a `PangoFT2FontMap` + a `PangoFT2FontMap` - + + - Function type for doing final config tweaking on prepared FcPatterns. + Function type for doing final config tweaking on prepared FcPatterns. + - the FcPattern to tweak. + the FcPattern to tweak. - - user data. + + user data. - - Gets the `PangoCoverage` for a `PangoFT2Font`. + + Gets the `PangoCoverage` for a `PangoFT2Font`. Use [method@Pango.Font.get_coverage] instead. + - a `PangoCoverage` + a `PangoCoverage` - a Pango FT2 font + a Pango FT2 font - a language tag. + a language tag. - - Returns the native FreeType2 `FT_Face` structure + + Returns the native FreeType2 `FT_Face` structure used for this `PangoFont`. This may be useful if you want to use FreeType2 @@ -180,219 +292,323 @@ functions directly. Use [method@PangoFc.Font.lock_face] instead; when you are done with a face from [method@PangoFc.Font.lock_face], you must call [method@PangoFc.Font.unlock_face]. + - a pointer to a `FT_Face` structure, + a pointer to a `FT_Face` structure, with the size set correctly - a `PangoFont` + a `PangoFont` - - Retrieves kerning information for a combination of two glyphs. + + Retrieves kerning information for a combination of two glyphs. Use pango_fc_font_kern_glyphs() instead. + - The amount of kerning (in Pango units) to + The amount of kerning (in Pango units) to apply for the given combination of glyphs. - a `PangoFont` + a `PangoFont` - the left `PangoGlyph` + the left `PangoGlyph` - the right `PangoGlyph` + the right `PangoGlyph` - - Retrieves a `PangoContext` for the default PangoFT2 fontmap + + Retrieves a `PangoContext` for the default PangoFT2 fontmap (see pango_ft2_font_map_for_display()) and sets the resolution for the default fontmap to @dpi_x by @dpi_y. Use [method@Pango.FontMap.create_context] instead. + - the new `PangoContext` + the new `PangoContext` - the horizontal DPI of the target device + the horizontal DPI of the target device - the vertical DPI of the target device + the vertical DPI of the target device - - Return the index of a glyph suitable for drawing unknown + + Return the index of a glyph suitable for drawing unknown characters with @font, or %PANGO_GLYPH_EMPTY if no suitable glyph found. If you want to draw an unknown-box for a character that is not covered by the font, use PANGO_GET_UNKNOWN_GLYPH() instead. + - a glyph index into @font, or %PANGO_GLYPH_EMPTY + a glyph index into @font, or %PANGO_GLYPH_EMPTY - a `PangoFont` + a `PangoFont` - Renders a `PangoGlyphString` onto a FreeType2 bitmap. + Renders a `PangoGlyphString` onto a FreeType2 bitmap. + - the FreeType2 bitmap onto which to draw the string + the FreeType2 bitmap onto which to draw the string - the font in which to draw the string + the font in which to draw the string - the glyph string to draw + the glyph string to draw - the x position of the start of the string (in pixels) + the x position of the start of the string (in pixels) - the y position of the baseline (in pixels) + the y position of the baseline (in pixels) - Render a `PangoLayout` onto a FreeType2 bitmap + Render a `PangoLayout` onto a FreeType2 bitmap + - a FT_Bitmap to render the layout onto + a FT_Bitmap to render the layout onto - a `PangoLayout` + a `PangoLayout` - the X position of the left of the layout (in pixels) + the X position of the left of the layout (in pixels) - the Y position of the top of the layout (in pixels) + the Y position of the top of the layout (in pixels) - - Render a `PangoLayoutLine` onto a FreeType2 bitmap + + Render a `PangoLayoutLine` onto a FreeType2 bitmap + - a FT_Bitmap to render the line onto + a FT_Bitmap to render the line onto - a `PangoLayoutLine` + a `PangoLayoutLine` - the x position of start of string (in pixels) + the x position of start of string (in pixels) - the y position of baseline (in pixels) + the y position of baseline (in pixels) - - Render a `PangoLayoutLine` onto a FreeType2 bitmap, with he + + Render a `PangoLayoutLine` onto a FreeType2 bitmap, with he location specified in fixed-point Pango units rather than pixels. (Using this will avoid extra inaccuracies from rounding to integer pixels multiple times, even if the final glyph positions are integers.) + - a FT_Bitmap to render the line onto + a FT_Bitmap to render the line onto - a `PangoLayoutLine` + a `PangoLayoutLine` - the x position of start of string (in Pango units) + the x position of start of string (in Pango units) - the y position of baseline (in Pango units) + the y position of baseline (in Pango units) - - Render a `PangoLayout` onto a FreeType2 bitmap, with he + + Render a `PangoLayout` onto a FreeType2 bitmap, with he location specified in fixed-point Pango units rather than pixels. (Using this will avoid extra inaccuracies from rounding to integer pixels multiple times, even if the final glyph positions are integers.) + - a FT_Bitmap to render the layout onto + a FT_Bitmap to render the layout onto - a `PangoLayout` + a `PangoLayout` - the X position of the left of the layout (in Pango units) + the X position of the left of the layout (in Pango units) - the Y position of the top of the layout (in Pango units) + the Y position of the top of the layout (in Pango units) - - Renders a `PangoGlyphString` onto a FreeType2 bitmap, possibly + + Renders a `PangoGlyphString` onto a FreeType2 bitmap, possibly transforming the layed-out coordinates through a transformation matrix. @@ -400,41 +616,61 @@ Note that the transformation matrix for @font is not changed, so to produce correct rendering results, the @font must have been loaded using a `PangoContext` with an identical transformation matrix to that passed in to this function. + - the FreeType2 bitmap onto which to draw the string + the FreeType2 bitmap onto which to draw the string - - a `PangoMatrix` + + a `PangoMatrix` - the font in which to draw the string + the font in which to draw the string - the glyph string to draw + the glyph string to draw - the x position of the start of the string (in Pango + the x position of the start of the string (in Pango units in user space coordinates) - the y position of the baseline (in Pango units + the y position of the baseline (in Pango units in user space coordinates) - - Free the global fontmap. (See pango_ft2_font_map_for_display()) + + Free the global fontmap. (See pango_ft2_font_map_for_display()) Use of the global PangoFT2 fontmap is deprecated. + diff --git a/PangoFc-1.0.gir b/PangoFc-1.0.gir index 190843d..92e8893 100644 --- a/PangoFc-1.0.gir +++ b/PangoFc-1.0.gir @@ -2,32 +2,58 @@ - + - - + + + - + + - + + - - `PangoFcDecoder` is a virtual base class that implementations will + + `PangoFcDecoder` is a virtual base class that implementations will inherit from. It's the interface that is used to define a custom encoding for a font. @@ -37,104 +63,149 @@ Pango requires information about the supported charset for a font as well as the individual character to glyph conversions. Pango gets that information via the #get_charset and #get_glyph callbacks into your object implementation. + - Generates an `FcCharSet` of supported characters for the @fcfont + Generates an `FcCharSet` of supported characters for the @fcfont given. The returned `FcCharSet` will be a reference to an internal value stored by the `PangoFcDecoder` and must not be modified or freed. + - the `FcCharset` for @fcfont; must not + the `FcCharset` for @fcfont; must not be modified or freed. - a `PangoFcDecoder` + a `PangoFcDecoder` - the `PangoFcFont` to query. + the `PangoFcFont` to query. - Generates a `PangoGlyph` for the given Unicode point using the + Generates a `PangoGlyph` for the given Unicode point using the custom decoder. For complex scripts where there can be multiple glyphs for a single character, the decoder will return whatever glyph is most convenient for it. (Usually whatever glyph is directly in the fonts character map table.) + - the glyph index, or 0 if the glyph isn't + the glyph index, or 0 if the glyph isn't covered by the font. - a `PangoFcDecoder` + a `PangoFcDecoder` - a `PangoFcFont` to query. + a `PangoFcFont` to query. - the Unicode code point to convert to a single `PangoGlyph`. + the Unicode code point to convert to a single `PangoGlyph`. - - Generates an `FcCharSet` of supported characters for the @fcfont + + Generates an `FcCharSet` of supported characters for the @fcfont given. The returned `FcCharSet` will be a reference to an internal value stored by the `PangoFcDecoder` and must not be modified or freed. + - the `FcCharset` for @fcfont; must not + the `FcCharset` for @fcfont; must not be modified or freed. - a `PangoFcDecoder` + a `PangoFcDecoder` - the `PangoFcFont` to query. + the `PangoFcFont` to query. - - Generates a `PangoGlyph` for the given Unicode point using the + + Generates a `PangoGlyph` for the given Unicode point using the custom decoder. For complex scripts where there can be multiple glyphs for a single character, the decoder will return whatever glyph is most convenient for it. (Usually whatever glyph is directly in the fonts character map table.) + - the glyph index, or 0 if the glyph isn't + the glyph index, or 0 if the glyph isn't covered by the font. - a `PangoFcDecoder` + a `PangoFcDecoder` - a `PangoFcFont` to query. + a `PangoFcFont` to query. - the Unicode code point to convert to a single `PangoGlyph`. + the Unicode code point to convert to a single `PangoGlyph`. @@ -143,25 +214,38 @@ covered by the font. - - Class structure for `PangoFcDecoder`. + + Class structure for `PangoFcDecoder`. + + - the `FcCharset` for @fcfont; must not + the `FcCharset` for @fcfont; must not be modified or freed. - a `PangoFcDecoder` + a `PangoFcDecoder` - the `PangoFcFont` to query. + the `PangoFcFont` to query. @@ -169,22 +253,31 @@ covered by the font. + - the glyph index, or 0 if the glyph isn't + the glyph index, or 0 if the glyph isn't covered by the font. - a `PangoFcDecoder` + a `PangoFcDecoder` - a `PangoFcFont` to query. + a `PangoFcFont` to query. - the Unicode code point to convert to a single `PangoGlyph`. + the Unicode code point to convert to a single `PangoGlyph`. @@ -192,6 +285,7 @@ covered by the font. + @@ -199,6 +293,7 @@ covered by the font. + @@ -206,6 +301,7 @@ covered by the font. + @@ -213,39 +309,63 @@ covered by the font. + - - Callback function passed to [method@PangoFc.FontMap.add_decoder_find_func]. + + Callback function passed to [method@PangoFc.FontMap.add_decoder_find_func]. + - a new reference to a custom decoder for this pattern, + a new reference to a custom decoder for this pattern, or %NULL if the default decoder handling should be used. - a fully resolved `FcPattern` specifying the font on the system + a fully resolved `FcPattern` specifying the font on the system - - user data passed to + + user data passed to [method@PangoFc.FontMap.add_decoder_find_func] - + + - - Fontconfig property that Pango reads from font + + Fontconfig property that Pango reads from font patterns to populate list of OpenType features to be enabled for the font by default. @@ -255,205 +375,328 @@ to enable. This is equivalent to FC_FONT_FEATURES in versions of fontconfig that have that. + - + + - - Fontconfig property that Pango reads from font + + Fontconfig property that Pango reads from font patterns to populate list of OpenType font variations to be used for a font. The property will have a string elements, each of which a comma-separated list of OpenType axis setting of the form AXIS=VALUE. + - - `PangoFcFont` is a base class for font implementations + + `PangoFcFont` is a base class for font implementations using the Fontconfig and FreeType libraries. It is used in onjunction with [class@PangoFc.FontMap]. When deriving from this class, you need to implement all of its virtual functions other than shutdown() along with the get_glyph_extents() virtual function from `PangoFont`. - - Creates a `PangoFontDescription` that matches the specified + + + Creates a `PangoFontDescription` that matches the specified Fontconfig pattern as closely as possible. Many possible Fontconfig pattern values, such as %FC_RASTERIZER or %FC_DPI, don't make sense in the context of `PangoFontDescription`, so will be ignored. + - a new `PangoFontDescription`. Free with + a new `PangoFontDescription`. Free with pango_font_description_free(). - a `FcPattern` + a `FcPattern` - if %TRUE, the pattern will include the size from + if %TRUE, the pattern will include the size from the @pattern; otherwise the resulting pattern will be unsized. (only %FC_SIZE is examined, not %FC_PIXEL_SIZE) - - Gets the glyph index for a given Unicode character + + Gets the glyph index for a given Unicode character for @font. If you only want to determine whether the font has the glyph, use [method@PangoFc.Font.has_char]. + - the glyph index, or 0, if the Unicode + the glyph index, or 0, if the Unicode character doesn't exist in the font. - a `PangoFcFont` + a `PangoFcFont` - Unicode character to look up + Unicode character to look up - - Returns the languages that are supported by @font. + + Returns the languages that are supported by @font. This corresponds to the FC_LANG member of the FcPattern. The returned array is only valid as long as the font and its fontmap are valid. + - a %NULL-terminated + a %NULL-terminated array of `PangoLanguage`* - a `PangoFcFont` + a `PangoFcFont` - - Returns the FcPattern that @font is based on. + + Returns the FcPattern that @font is based on. + - the fontconfig pattern for this font + the fontconfig pattern for this font - a `PangoFcFont` + a `PangoFcFont` - - Returns the index of a glyph suitable for drawing @wc + + Returns the index of a glyph suitable for drawing @wc as an unknown character. Use PANGO_GET_UNKNOWN_GLYPH() instead. + - a glyph index into @font. + a glyph index into @font. - a `PangoFcFont` + a `PangoFcFont` - the Unicode character for which a glyph is needed. + the Unicode character for which a glyph is needed. - - Determines whether @font has a glyph for the codepoint @wc. + + Determines whether @font has a glyph for the codepoint @wc. Use [method@Pango.Font.has_char] + - %TRUE if @font has the requested codepoint. + %TRUE if @font has the requested codepoint. - a `PangoFcFont` + a `PangoFcFont` - Unicode codepoint to look up + Unicode codepoint to look up - - This function used to adjust each adjacent pair of glyphs + + This function used to adjust each adjacent pair of glyphs in @glyphs according to kerning information in @font. Since 1.44, it does nothing. + - a `PangoFcFont` + a `PangoFcFont` - a `PangoGlyphString` + a `PangoGlyphString` - - Gets the FreeType `FT_Face` associated with a font. + + Gets the FreeType `FT_Face` associated with a font. This face will be kept around until you call [method@PangoFc.Font.unlock_face]. Use pango_font_get_hb_font() instead + - the FreeType `FT_Face` associated with @font. + the FreeType `FT_Face` associated with @font. - a `PangoFcFont`. + a `PangoFcFont`. - - Releases a font previously obtained with + + Releases a font previously obtained with [method@PangoFc.Font.lock_face]. Use pango_font_get_hb_font() instead + - a `PangoFcFont`. + a `PangoFcFont`. - The PangoFc font map this font is associated with. + The PangoFc font map this font is associated with. - - The fontconfig pattern for this font. + + The fontconfig pattern for this font. @@ -486,157 +729,256 @@ This face will be kept around until you call - - - `PangoFcFontMap` is a base class for font map implementations using the + + + + + `PangoFcFontMap` is a base class for font map implementations using the Fontconfig and FreeType libraries. It is used in the Xft and FreeType backends shipped with Pango, but can also be used when creating new backends. Any backend deriving from this base class will take advantage of the wide range of shapers implemented using FreeType that come with Pango. - - This function saves a callback method in the `PangoFcFontMap` that + + + This function saves a callback method in the `PangoFcFontMap` that will be called whenever new fonts are created. If the function returns a `PangoFcDecoder`, that decoder will be used to determine both coverage via a `FcCharSet` and a one-to-one mapping of characters to glyphs. This will allow applications to have application-specific encodings for various fonts. + - The `PangoFcFontMap` to add this method to. + The `PangoFcFontMap` to add this method to. - - The `PangoFcDecoderFindFunc` callback function + + The `PangoFcDecoderFindFunc` callback function - - User data. + + User data. - A `GDestroyNotify` callback that will be called when the + A `GDestroyNotify` callback that will be called when the fontmap is finalized and the decoder is released. - - Clear all cached information and fontsets for this font map. + + Clear all cached information and fontsets for this font map. This should be called whenever there is a change in the output of the default_substitute() virtual function of the font map, or if fontconfig has been reinitialized to new configuration. + - a `PangoFcFontMap` + a `PangoFcFontMap` - - Informs font map that the fontconfig configuration (i.e., FcConfig + + Informs font map that the fontconfig configuration (i.e., FcConfig object) used by this font map has changed. This currently calls [method@PangoFc.FontMap.cache_clear] which ensures that list of fonts, etc will be regenerated using the updated configuration. + - a `PangoFcFontMap` + a `PangoFcFontMap` - - Creates a new context for this fontmap. + + Creates a new context for this fontmap. This function is intended only for backend implementations deriving from `PangoFcFontMap`; it is possible that a backend will store additional information needed for correct operation on the `PangoContext` after calling this function. Use pango_font_map_create_context() instead. + - a new `PangoContext` + a new `PangoContext` - a `PangoFcFontMap` + a `PangoFcFontMap` - - Finds the decoder to use for @pattern. + + Finds the decoder to use for @pattern. Decoders can be added to a font map using [method@PangoFc.FontMap.add_decoder_find_func]. + - a newly created `PangoFcDecoder` + a newly created `PangoFcDecoder` object or %NULL if no decoder is set for @pattern. - The `PangoFcFontMap` to use. + The `PangoFcFontMap` to use. - The `FcPattern` to find the decoder for. + The `FcPattern` to find the decoder for. - - Fetches the `FcConfig` attached to a font map. + + Fetches the `FcConfig` attached to a font map. See also: [method@PangoFc.FontMap.set_config]. + - the `FcConfig` object attached to + the `FcConfig` object attached to @fcfontmap, which might be %NULL. The return value is owned by Pango and should not be freed. - a `PangoFcFontMap` + a `PangoFcFontMap` - - Retrieves the `hb_face_t` for the given `PangoFcFont`. + + Retrieves the `hb_face_t` for the given `PangoFcFont`. + - the `hb_face_t` + the `hb_face_t` for the given font - a `PangoFcFontMap` + a `PangoFcFontMap` - a `PangoFcFont` + a `PangoFcFont` - - Set the `FcConfig` for this font map to use. + + Set the `FcConfig` for this font map to use. The default value is %NULL, which causes Fontconfig to use its global "current config". @@ -652,51 +994,83 @@ If @fcconfig is different from the previous config attached to the font map, This function acquires a reference to the `FcConfig` object; the caller does **not** need to retain a reference. + - a `PangoFcFontMap` + a `PangoFcFontMap` - - a `FcConfig` + + a `FcConfig` - - Sets a function that will be called to do final configuration + + Sets a function that will be called to do final configuration substitution on a `FcPattern` before it is used to load the font. This function can be used to do things like set hinting and antialiasing options. + - a `PangoFcFontMap` + a `PangoFcFontMap` - - function to call to to do final config tweaking on `FcPattern` objects + + function to call to to do final config tweaking on `FcPattern` objects - - data to pass to @func + + data to pass to @func - function to call when @data is no longer used + function to call when @data is no longer used - - Clears all cached information for the fontmap and marks + + Clears all cached information for the fontmap and marks all fonts open for the fontmap as dead. See the shutdown() virtual function of `PangoFcFont`. @@ -705,38 +1079,60 @@ This function might be used by a backend when the underlying windowing system for the font map exits. This function is only intended to be called only for backend implementations deriving from `PangoFcFontMap`. + - a `PangoFcFontMap` + a `PangoFcFontMap` - - Call this function any time the results of the default + + Call this function any time the results of the default substitution function set with [method@PangoFc.FontMap.set_default_substitute] change. That is, if your substitution function will return different results for the same input pattern, you must call this function. + - a `PangoFcFontMap` + a `PangoFcFontMap` - - - - Fontconfig property that Pango sets on any + + + + + + + + Fontconfig property that Pango sets on any fontconfig pattern it passes to fontconfig if a `PangoGravity` other than %PANGO_GRAVITY_SOUTH is desired. @@ -745,34 +1141,52 @@ The property will have a `PangoGravity` value as a string, like "east". This can be used to write fontconfig configuration rules to choose different fonts for horizontal and vertical writing directions. + - + + - + + - + + - + + - - Fontconfig property that Pango sets on any + + Fontconfig property that Pango sets on any fontconfig pattern it passes to fontconfig. The property will have a string equal to what @@ -782,26 +1196,42 @@ certain applications. This is equivalent to FC_PRGNAME in versions of fontconfig that have that. + - Function type for doing final config tweaking on prepared `FcPattern`s. + Function type for doing final config tweaking on prepared `FcPattern`s. + - the FcPattern to tweak. + the FcPattern to tweak. - - user data. + + user data. - - Fontconfig property that Pango sets on any + + Fontconfig property that Pango sets on any fontconfig pattern it passes to fontconfig. The property will have an integer value equal to what @@ -809,6 +1239,7 @@ The property will have an integer value equal to what fontconfig configuration rules that only affect certain pango versions (or only pango-using applications, or only non-pango-using applications). + diff --git a/PangoOT-1.0.gir b/PangoOT-1.0.gir index 60ceec2..364bb19 100644 --- a/PangoOT-1.0.gir +++ b/PangoOT-1.0.gir @@ -2,178 +2,284 @@ - + - + - The `PangoOTTag` typedef is used to represent TrueType and OpenType + The `PangoOTTag` typedef is used to represent TrueType and OpenType four letter tags inside Pango. Use PANGO_OT_TAG_MAKE() or PANGO_OT_TAG_MAKE_FROM_STRING() macros to create PangoOTTags manually. + - - This is used as the property bit in pango_ot_ruleset_add_feature() when a + + This is used as the property bit in pango_ot_ruleset_add_feature() when a feature should be applied to all glyphs. + - + + - Creates a new `PangoOTBuffer` for the given OpenType font. + Creates a new `PangoOTBuffer` for the given OpenType font. + - the newly allocated `PangoOTBuffer`, which should + the newly allocated `PangoOTBuffer`, which should be freed with [method@PangoOT.Buffer.destroy]. - a `PangoFcFont` + a `PangoFcFont` - - Appends a glyph to a `PangoOTBuffer`, with @properties identifying which + + Appends a glyph to a `PangoOTBuffer`, with @properties identifying which features should be applied on this glyph. See [method@PangoOT.Ruleset.add_feature]. + - a `PangoOTBuffer` + a `PangoOTBuffer` - the glyph index to add, like a `PangoGlyph` + the glyph index to add, like a `PangoGlyph` - the glyph properties + the glyph properties - the cluster that this glyph belongs to + the cluster that this glyph belongs to - Empties a `PangoOTBuffer`, make it ready to add glyphs to. + Empties a `PangoOTBuffer`, make it ready to add glyphs to. + - a `PangoOTBuffer` + a `PangoOTBuffer` - - Destroys a `PangoOTBuffer` and free all associated memory. + + Destroys a `PangoOTBuffer` and free all associated memory. + - a `PangoOTBuffer` + a `PangoOTBuffer` - - Gets the glyph array contained in a `PangoOTBuffer`. + + Gets the glyph array contained in a `PangoOTBuffer`. The glyphs are owned by the buffer and should not be freed, and are only valid as long as buffer is not modified. + - a `PangoOTBuffer` + a `PangoOTBuffer` - - location to + + location to store the array of glyphs - - location to store the number of glyphs + + location to store the number of glyphs - - Exports the glyphs in a `PangoOTBuffer` into a `PangoGlyphString`. + + Exports the glyphs in a `PangoOTBuffer` into a `PangoGlyphString`. This is typically used after the OpenType layout processing is over, to convert the resulting glyphs into a generic Pango glyph string. + - a `PangoOTBuffer` + a `PangoOTBuffer` - a `PangoGlyphString` + a `PangoGlyphString` - - Sets whether glyphs will be rendered right-to-left. + + Sets whether glyphs will be rendered right-to-left. This setting is needed for proper horizontal positioning of right-to-left scripts. + - a `PangoOTBuffer` + a `PangoOTBuffer` - %TRUE for right-to-left text + %TRUE for right-to-left text - - Sets whether characters with a mark class should be forced to zero width. + + Sets whether characters with a mark class should be forced to zero width. This setting is needed for proper positioning of Arabic accents, but will produce incorrect results with standard OpenType Indic fonts. + - a `PangoOTBuffer` + a `PangoOTBuffer` - %TRUE if characters with a mark class should + %TRUE if characters with a mark class should be forced to zero width - - This is used as the language index in pango_ot_info_find_feature() when + + This is used as the language index in pango_ot_info_find_feature() when the default language system of the script is desired. It is also returned by pango_ot_info_find_language() if the requested language @@ -182,89 +288,135 @@ The end result is that one can always call pango_ot_tag_from_language() followed by pango_ot_info_find_language() and pass the result to pango_ot_info_find_feature() without having to worry about falling back to default language system explicitly. + - The `PangoOTFeatureMap` typedef is used to represent an OpenType + The `PangoOTFeatureMap` typedef is used to represent an OpenType feature with the property bit associated with it. The feature tag is represented as a char array instead of a `PangoOTTag` for convenience. + - feature tag in represented as four-letter ASCII string. + feature tag in represented as four-letter ASCII string. - the property bit to use for this feature. See + the property bit to use for this feature. See pango_ot_ruleset_add_feature() for details. - The `PangoOTGlyph` structure represents a single glyph together with + The `PangoOTGlyph` structure represents a single glyph together with information used for OpenType layout processing of the glyph. It contains the following fields. + - the glyph itself. + the glyph itself. - the properties value, identifying which features should be + the properties value, identifying which features should be applied on this glyph. See pango_ot_ruleset_add_feature(). - the cluster that this glyph belongs to. + the cluster that this glyph belongs to. - a component value, set by the OpenType layout engine. + a component value, set by the OpenType layout engine. - a ligature index value, set by the OpenType layout engine. + a ligature index value, set by the OpenType layout engine. - for Pango internal use + for Pango internal use - + + - + + - + + - + - Returns the `PangoOTInfo` structure for the given FreeType font face. + Returns the `PangoOTInfo` structure for the given FreeType font face. + - the `PangoOTInfo` for @face. + the `PangoOTInfo` for @face. This object will have the same lifetime as @face. - a `FT_Face` + a `FT_Face` - Finds the index of a feature. + Finds the index of a feature. If the feature is not found, sets @feature_index to PANGO_OT_NO_FEATURE, which is safe to pass to [method@PangoOT.Ruleset.add_feature] and similar @@ -275,41 +427,63 @@ used in [method@PangoOT.Ruleset.add_feature] will ask Pango to synthesize the requested feature based on Unicode properties and data. However, this function will still return %FALSE in those cases. So, users may want to ignore the return value of this function in certain cases. + - %TRUE if the feature was found + %TRUE if the feature was found - a `PangoOTInfo` + a `PangoOTInfo` - the table type to obtain information about + the table type to obtain information about - the tag of the feature to find + the tag of the feature to find - the index of the script + the index of the script - the index of the language whose features are searched, + the index of the language whose features are searched, or %PANGO_OT_DEFAULT_LANGUAGE to use the default language of the script - - location to store the index of + + location to store the index of the feature - Finds the index of a language and its required feature index. + Finds the index of a language and its required feature index. If the language is not found, sets @language_index to %PANGO_OT_DEFAULT_LANGUAGE and the required feature of the default language system is returned in @@ -318,40 +492,67 @@ searches the language system tag 'dflt' before falling back to the default language system, but that is transparent to the user. The user can simply ignore the return value of this function to automatically fall back to the default language system. + - %TRUE if the language was found + %TRUE if the language was found - a `PangoOTInfo` + a `PangoOTInfo` - the table type to obtain information about + the table type to obtain information about - the index of the script whose languages are searched + the index of the script whose languages are searched - the tag of the language to find + the tag of the language to find - - location to store the index of the language + + location to store the index of the language - - location to store the + + location to store the required feature index of the language - Finds the index of a script. + Finds the index of a script. If not found, tries to find the 'DFLT' and then 'dflt' scripts and return the index of that in @script_index. If none of those is found @@ -361,130 +562,206 @@ All other functions taking an input script_index parameter know how to handle %PANGO_OT_NO_SCRIPT, so one can ignore the return value of this function completely and proceed, to enjoy the automatic fallback to the 'DFLT'/'dflt' script. + - %TRUE if the script was found + %TRUE if the script was found - a `PangoOTInfo` + a `PangoOTInfo` - the table type to obtain information about + the table type to obtain information about - the tag of the script to find + the tag of the script to find - - location to store the index of the script + + location to store the index of the script - Obtains the list of features for the given language of the given script. + Obtains the list of features for the given language of the given script. + - a newly-allocated zero-terminated + a newly-allocated zero-terminated array containing the tags of the available features - a `PangoOTInfo` + a `PangoOTInfo` - the table type to obtain information about + the table type to obtain information about - unused parameter + unused parameter - the index of the script to obtain information about + the index of the script to obtain information about - the index of the language to list features for, or + the index of the language to list features for, or %PANGO_OT_DEFAULT_LANGUAGE, to list features for the default language of the script - - Obtains the list of available languages for a given script. + + Obtains the list of available languages for a given script. + - a newly-allocated zero-terminated + a newly-allocated zero-terminated array containing the tags of the available languages - a `PangoOTInfo` + a `PangoOTInfo` - the table type to obtain information about + the table type to obtain information about - the index of the script to list languages for + the index of the script to list languages for - unused parameter + unused parameter - Obtains the list of available scripts. + Obtains the list of available scripts. + - a newly-allocated zero-terminated + a newly-allocated zero-terminated array containing the tags of the available scripts - a `PangoOTInfo` + a `PangoOTInfo` - the table type to obtain information about + the table type to obtain information about - - This is used as a feature index that represent no feature, that is, should be + + This is used as a feature index that represent no feature, that is, should be skipped. It may be returned as feature index by pango_ot_info_find_feature() if the feature is not found, and pango_ot_ruleset_add_feature() function automatically skips this value, so no special handling is required by the user. + - - This is used as a script index that represent no script, that is, when the + + This is used as a script index that represent no script, that is, when the requested script was not found, and a default ('DFLT') script was not found either. It may be returned as script index by pango_ot_info_find_script() if the script or a default script are not found, all other functions taking a script index essentially return if the input script index is this value, so no special handling is required by the user. + - + + - - The `PangoOTRuleset` structure holds a set of features selected + + The `PangoOTRuleset` structure holds a set of features selected from the tables in an OpenType font. A feature is an operation such as adjusting glyph positioning @@ -496,20 +773,31 @@ features are added to it with [method@PangoOT.Ruleset.add_feature], then it is applied to a `PangoGlyphString` with [method@PangoOT.Ruleset.position]. - Creates a new `PangoOTRuleset` for the given OpenType info. + Creates a new `PangoOTRuleset` for the given OpenType info. + - the newly allocated `PangoOTRuleset` + the newly allocated `PangoOTRuleset` - a `PangoOTInfo` + a `PangoOTInfo` - - Creates a new `PangoOTRuleset` for the given OpenType info, script, and + + Creates a new `PangoOTRuleset` for the given OpenType info, script, and language. This function is part of a convenience scheme that highly simplifies @@ -540,27 +828,40 @@ In addition to what [ctor@PangoOT.Ruleset.new] does, this function will: Because of the way return values of [method@PangoOT.Info.find_script] and [method@PangoOT.Info.find_language] are ignored, this function automatically finds and uses the 'DFLT' script and the default language-system. + - the newly allocated `PangoOTRuleset` + the newly allocated `PangoOTRuleset` - a `PangoOTInfo` + a `PangoOTInfo` - a `PangoScript` + a `PangoScript` - a `PangoLanguage` + a `PangoLanguage` - - Creates a new `PangoOTRuleset` for the given OpenType info and + + Creates a new `PangoOTRuleset` for the given OpenType info and matching the given ruleset description. This is a convenience function that calls [ctor@PangoOT.Ruleset.new_for] @@ -569,23 +870,35 @@ followed by adding other features to both GSUB and GPOS. The static feature map members of @desc should be alive as long as @info is. + - the newly allocated `PangoOTRuleset` + the newly allocated `PangoOTRuleset` - a `PangoOTInfo` + a `PangoOTInfo` - a `PangoOTRulesetDescription` - + a `PangoOTRulesetDescription` + - - Returns a ruleset for the given OpenType info and ruleset + + Returns a ruleset for the given OpenType info and ruleset description. Rulesets are created on demand using @@ -594,227 +907,355 @@ The returned ruleset should not be modified or destroyed. The static feature map members of @desc should be alive as long as @info is. + - the `PangoOTRuleset` for @desc. This object will have + the `PangoOTRuleset` for @desc. This object will have the same lifetime as @info. - a `PangoOTInfo` + a `PangoOTInfo` - a `PangoOTRulesetDescription` - + a `PangoOTRulesetDescription` + - Adds a feature to the ruleset. + Adds a feature to the ruleset. + - a `PangoOTRuleset` + a `PangoOTRuleset` - the table type to add a feature to + the table type to add a feature to - the index of the feature to add + the index of the feature to add - the property bit to use for this feature. Used to + the property bit to use for this feature. Used to identify the glyphs that this feature should be applied to, or %PANGO_OT_ALL_GLYPHS if it should be applied to all glyphs. - - Gets the number of GSUB and GPOS features in the ruleset. + + Gets the number of GSUB and GPOS features in the ruleset. + - Total number of features in the @ruleset + Total number of features in the @ruleset - a `PangoOTRuleset` + a `PangoOTRuleset` - - location to store number of GSUB features + + location to store number of GSUB features - - location to store number of GPOS features + + location to store number of GPOS features - - This is a convenience function that first tries to find the feature + + This is a convenience function that first tries to find the feature using [method@PangoOT.Info.find_feature] and the ruleset script and language passed to [ctor@PangoOT.Ruleset.new_for] and if the feature is found, adds it to the ruleset. If @ruleset was not created using [ctor@PangoOT.Ruleset.new_for], this function does nothing. + - %TRUE if the feature was found and added to ruleset, + %TRUE if the feature was found and added to ruleset, %FALSE otherwise - a `PangoOTRuleset` + a `PangoOTRuleset` - the table type to add a feature to + the table type to add a feature to - the tag of the feature to add + the tag of the feature to add - the property bit to use for this feature. Used to + the property bit to use for this feature. Used to identify the glyphs that this feature should be applied to, or %PANGO_OT_ALL_GLYPHS if it should be applied to all glyphs. - - This is a convenience function that for each feature in the feature map + + This is a convenience function that for each feature in the feature map array @features converts the feature name to a `PangoOTTag` feature tag using PANGO_OT_TAG_MAKE() and calls [method@PangoOT.Ruleset.maybe_add_feature] on it. + - The number of features in @features that were found + The number of features in @features that were found and added to @ruleset - a `PangoOTRuleset` + a `PangoOTRuleset` - the table type to add features to + the table type to add features to - array of feature name and property bits to add + array of feature name and property bits to add - number of feature records in @features array + number of feature records in @features array - - Performs the OpenType GPOS positioning on @buffer using + + Performs the OpenType GPOS positioning on @buffer using the features in @ruleset. + - a `PangoOTRuleset` + a `PangoOTRuleset` - a `PangoOTBuffer` + a `PangoOTBuffer` - - Performs the OpenType GSUB substitution on @buffer using + + Performs the OpenType GSUB substitution on @buffer using the features in @ruleset. + - a `PangoOTRuleset` + a `PangoOTRuleset` - a `PangoOTBuffer` + a `PangoOTBuffer` - - The `PangoOTRuleset` structure holds all the information needed + + The `PangoOTRuleset` structure holds all the information needed to build a complete `PangoOTRuleset` from an OpenType font. The main use of this struct is to act as the key for a per-font hash of rulesets. The user populates a ruleset description and gets the ruleset using pango_ot_ruleset_get_for_description() or create a new one using pango_ot_ruleset_new_from_description(). + - a `PangoScript` + a `PangoScript` - a `PangoLanguage` + a `PangoLanguage` - static map of GSUB features + static map of GSUB features - length of @static_gsub_features, or 0. + length of @static_gsub_features, or 0. - static map of GPOS features + static map of GPOS features - length of @static_gpos_features, or 0. + length of @static_gpos_features, or 0. - map of extra features to add to both + map of extra features to add to both GSUB and GPOS. Unlike the static maps, this pointer need not live beyond the life of function calls taking this struct. - length of @other_features, or 0. + length of @other_features, or 0. - - Creates a copy of @desc, which should be freed with + + Creates a copy of @desc, which should be freed with [method@PangoOT.RulesetDescription.free]. Primarily used internally by [func@PangoOT.Ruleset.get_for_description] to cache rulesets for ruleset descriptions. + - the newly allocated `PangoOTRulesetDescription` + the newly allocated `PangoOTRulesetDescription` - ruleset description to copy - + ruleset description to copy + - - Compares two ruleset descriptions for equality. + + Compares two ruleset descriptions for equality. Two ruleset descriptions are considered equal if the rulesets they describe are provably identical. This means that their @@ -824,108 +1265,178 @@ For static feature sets, the array addresses are compared directly, while for other features, the list of features is compared one by one.(Two ruleset descriptions may result in identical rulesets being created, but still compare %FALSE.) + - %TRUE if two ruleset descriptions are identical, + %TRUE if two ruleset descriptions are identical, %FALSE otherwise - a ruleset description - + a ruleset description + - a ruleset description - + a ruleset description + - - Frees a ruleset description allocated by + + Frees a ruleset description allocated by pango_ot_ruleset_description_copy(). + - an allocated `PangoOTRulesetDescription` - + an allocated `PangoOTRulesetDescription` + - - Computes a hash of a `PangoOTRulesetDescription` structure suitable + + Computes a hash of a `PangoOTRulesetDescription` structure suitable to be used, for example, as an argument to g_hash_table_new(). + - the hash value + the hash value - a ruleset description - + a ruleset description + - - Creates a `PangoOTTag` from four characters. This is similar and + + Creates a `PangoOTTag` from four characters. This is similar and compatible with the FT_MAKE_TAG() macro from FreeType. + - First character. + First character. - Second character. + Second character. - Third character. + Third character. - Fourth character. + Fourth character. - - Creates a `PangoOTTag` from a string. The string should be at least + + Creates a `PangoOTTag` from a string. The string should be at least four characters long (pad with space characters if needed), and need not be nul-terminated. This is a convenience wrapper around PANGO_OT_TAG_MAKE(), but cannot be used in certain situations, for example, as a switch expression, as it dereferences pointers. + - The string representation of the tag. + The string representation of the tag. - The PangoOTTableType enumeration values are used to + The PangoOTTableType enumeration values are used to identify the various OpenType tables in the -pango_ot_info_… functions. +pango_ot_info_… functions. + - The GSUB table. + The GSUB table. - The GPOS table. + The GPOS table. - - Finds the OpenType language-system tag best describing @language. + + Finds the OpenType language-system tag best describing @language. + - `PangoOTTag` best matching @language or + `PangoOTTag` best matching @language or %PANGO_OT_TAG_DEFAULT_LANGUAGE if none found or if @language is %NULL. - - A `PangoLanguage` + + A `PangoLanguage` - - Finds the OpenType script tag corresponding to @script. + + Finds the OpenType script tag corresponding to @script. The %PANGO_SCRIPT_COMMON, %PANGO_SCRIPT_INHERITED, and %PANGO_SCRIPT_UNKNOWN scripts are mapped to the OpenType @@ -935,34 +1446,52 @@ The %PANGO_SCRIPT_COMMON, %PANGO_SCRIPT_INHERITED, and Note that multiple `PangoScript` values may map to the same OpenType script tag. In particular, %PANGO_SCRIPT_HIRAGANA and %PANGO_SCRIPT_KATAKANA both map to the OT tag 'kana'. + - `PangoOTTag` corresponding to @script or + `PangoOTTag` corresponding to @script or %PANGO_OT_TAG_DEFAULT_SCRIPT if none found. - A `PangoScript` + A `PangoScript` - - Finds a `PangoLanguage` corresponding to @language_tag. + + Finds a `PangoLanguage` corresponding to @language_tag. + - `PangoLanguage` best matching @language_tag or + `PangoLanguage` best matching @language_tag or `PangoLanguage` corresponding to the string "xx" if none found. - A `PangoOTTag` OpenType language-system tag + A `PangoOTTag` OpenType language-system tag - - Finds the `PangoScript` corresponding to @script_tag. + + Finds the `PangoScript` corresponding to @script_tag. The 'DFLT' script tag is mapped to %PANGO_SCRIPT_COMMON. @@ -973,14 +1502,19 @@ In particular, %PANGO_SCRIPT_HIRAGANA and %PANGO_SCRIPT_KATAKANA both map to the OT tag 'kana'. This function will return %PANGO_SCRIPT_HIRAGANA for 'kana'. + - `PangoScript` corresponding to @script_tag or + `PangoScript` corresponding to @script_tag or %PANGO_SCRIPT_UNKNOWN if none found. - A `PangoOTTag` OpenType script tag + A `PangoOTTag` OpenType script tag diff --git a/PangoXft-1.0.gir b/PangoXft-1.0.gir index 5cec93d..348c0bc 100644 --- a/PangoXft-1.0.gir +++ b/PangoXft-1.0.gir @@ -2,7 +2,10 @@ - + @@ -11,218 +14,356 @@ and/or use gtk-doc annotations. --> - - + + + - + + - - `PangoXftFont` is an implementation of `PangoFcFont` using the Xft + + `PangoXftFont` is an implementation of `PangoFcFont` using the Xft library for rendering. It is used in conjunction with `PangoXftFontMap`. - - Returns the `XftFont` of a font. + + Returns the `XftFont` of a font. + - the `XftFont` associated to @font + the `XftFont` associated to @font - - a `PangoFont` + + a `PangoFont` - - Returns the X display of the `XftFont` of a font. + + Returns the X display of the `XftFont` of a font. + - the X display of the XftFont associated to @font. + the X display of the XftFont associated to @font. - a `PangoFont` + a `PangoFont` - - Gets the glyph index for a given Unicode character + + Gets the glyph index for a given Unicode character for @font. If you only want to determine whether the font has the glyph, use pango_xft_font_has_char(). Use pango_fc_font_get_glyph() instead. + - the glyph index, or 0, if the Unicode + the glyph index, or 0, if the Unicode character does not exist in the font. - a `PangoFont` for the Xft backend + a `PangoFont` for the Xft backend - Unicode codepoint to look up + Unicode codepoint to look up - - Returns the index of a glyph suitable for drawing @wc as an + + Returns the index of a glyph suitable for drawing @wc as an unknown character. Use PANGO_GET_UNKNOWN_GLYPH() instead. + - a glyph index into @font. + a glyph index into @font. - a `PangoFont` + a `PangoFont` - the Unicode character for which a glyph is needed. + the Unicode character for which a glyph is needed. - - Determines whether @font has a glyph for the codepoint @wc. + + Determines whether @font has a glyph for the codepoint @wc. Use pango_fc_font_has_char() instead. + - %TRUE if @font has the requested codepoint. + %TRUE if @font has the requested codepoint. - a `PangoFont` for the Xft backend + a `PangoFont` for the Xft backend - Unicode codepoint to look up + Unicode codepoint to look up - - Gets the FreeType `FT_Face` associated with a font. + + Gets the FreeType `FT_Face` associated with a font. This face will be kept around until you call pango_xft_font_unlock_face(). Use pango_fc_font_lock_face() instead. + - the FreeType `FT_Face` associated with @font. + the FreeType `FT_Face` associated with @font. - a `PangoFont` + a `PangoFont` - - Releases a font previously obtained with + + Releases a font previously obtained with pango_xft_font_lock_face(). Use pango_fc_font_unlock_face() instead. + - a `PangoFont` + a `PangoFont` - - `PangoXftFontMap` is an implementation of `PangoFcFontMap` suitable for + + `PangoXftFontMap` is an implementation of `PangoFcFontMap` suitable for the Xft library as the renderer. It is used in to create fonts of type `PangoXftFont`. - + + - + + - + + - + + - + + - + + - + + - - `PangoXftRenderer` is a subclass of `PangoRenderer` used for rendering + + `PangoXftRenderer` is a subclass of `PangoRenderer` used for rendering with Pango's Xft backend. It can be used directly, or it can be further subclassed to modify exactly how drawing of individual elements occurs. - - Create a new `PangoXftRenderer` to allow rendering Pango objects + + + Create a new `PangoXftRenderer` to allow rendering Pango objects with the Xft library. You must call pango_xft_renderer_set_draw() before using the renderer. + - the newly created `PangoXftRenderer` + the newly created `PangoXftRenderer` - an X display + an X display - the index of the screen for @display to which rendering will be done + the index of the screen for @display to which rendering will be done + @@ -242,6 +383,7 @@ using the renderer. + @@ -260,43 +402,69 @@ using the renderer. - - Sets the default foreground color for a XftRenderer. + + Sets the default foreground color for a XftRenderer. + - a XftRenderer + a XftRenderer - the default foreground color + the default foreground color - - Sets the XftDraw object that the renderer is drawing to. + + Sets the XftDraw object that the renderer is drawing to. The renderer must not be currently active. + - a `PangoXftRenderer` + a `PangoXftRenderer` - a XftDraw + a XftDraw - + - + @@ -315,13 +483,20 @@ The renderer must not be currently active. - - The class structure for `PangoXftRenderer` + + The class structure for `PangoXftRenderer` + + @@ -343,6 +518,7 @@ The renderer must not be currently active. + @@ -363,190 +539,294 @@ The renderer must not be currently active. - + + + - Function type for doing final config tweaking on prepared FcPatterns. + Function type for doing final config tweaking on prepared FcPatterns. + - the FcPattern to tweak. + the FcPattern to tweak. - - user data. + + user data. - - Retrieves a `PangoContext` appropriate for rendering with + + Retrieves a `PangoContext` appropriate for rendering with Xft fonts on the given screen of the given display. Use pango_xft_get_font_map() followed by pango_font_map_create_context() instead. + - the new `PangoContext`. + the new `PangoContext`. - an X display. + an X display. - an X screen. + an X screen. - - Returns the `PangoXftFontMap` for the given display and screen. + + Returns the `PangoXftFontMap` for the given display and screen. The fontmap is owned by Pango and will be valid until the display is closed. + - a `PangoFontMap` object, owned by Pango. + a `PangoFontMap` object, owned by Pango. - an X display + an X display - the screen number of a screen within @display + the screen number of a screen within @display - Renders a `PangoGlyphString` onto an Xrender Picture object. + Renders a `PangoGlyphString` onto an Xrender Picture object. + - an X display + an X display - the source picture to draw the string with + the source picture to draw the string with - the destination picture to draw the string onto + the destination picture to draw the string onto - the font in which to draw the string + the font in which to draw the string - the glyph string to draw + the glyph string to draw - the x position of start of string (in pixels) + the x position of start of string (in pixels) - the y position of baseline (in pixels) + the y position of baseline (in pixels) - Renders a `PangoGlyphString` onto an XftDraw object wrapping an X drawable. + Renders a `PangoGlyphString` onto an XftDraw object wrapping an X drawable. + - the XftDraw object. + the XftDraw object. - the color in which to draw the string + the color in which to draw the string - the font in which to draw the string + the font in which to draw the string - the glyph string to draw + the glyph string to draw - the x position of start of string (in pixels) + the x position of start of string (in pixels) - the y position of baseline (in pixels) + the y position of baseline (in pixels) - - Render a `PangoLayout` onto a XftDraw + + Render a `PangoLayout` onto a XftDraw + - an XftDraw + an XftDraw - the foreground color in which to draw the layout + the foreground color in which to draw the layout (may be overridden by color attributes) - a `PangoLayout` + a `PangoLayout` - the X position of the left of the layout (in Pango units) + the X position of the left of the layout (in Pango units) - the Y position of the top of the layout (in Pango units) + the Y position of the top of the layout (in Pango units) - - Render a `PangoLayoutLine` onto a XftDraw + + Render a `PangoLayoutLine` onto a XftDraw + - an XftDraw + an XftDraw - the foreground color in which to draw the layout line + the foreground color in which to draw the layout line (may be overridden by color attributes) - a `PangoLayoutLine` + a `PangoLayoutLine` - the x position of start of string (in Pango units) + the x position of start of string (in Pango units) - the y position of baseline (in Pango units) + the y position of baseline (in Pango units) - - Renders a `PangoGlyphString` onto a XftDraw, possibly + + Renders a `PangoGlyphString` onto a XftDraw, possibly transforming the layed-out coordinates through a transformation matrix. @@ -554,113 +834,175 @@ Note that the transformation matrix for @font is not changed, so to produce correct rendering results, the @font must have been loaded using a `PangoContext` with an identical transformation matrix to that passed in to this function. + - an XftDraw + an XftDraw - the color in which to draw the glyphs + the color in which to draw the glyphs - - a `PangoMatrix` + + a `PangoMatrix` - the font in which to draw the string + the font in which to draw the string - the glyph string to draw + the glyph string to draw - the x position of the start of the string (in Pango + the x position of the start of the string (in Pango units in user space coordinates) - the y position of the baseline (in Pango units + the y position of the baseline (in Pango units in user space coordinates) - - Sets a function that will be called to do final configuration + + Sets a function that will be called to do final configuration substitution on a #FcPattern before it is used to load the font. This function can be used to do things like set hinting and antialiasing options. Use pango_fc_font_map_set_default_substitute() instead. + - an X Display + an X Display - the screen number of a screen within @display + the screen number of a screen within @display - - function to call to to do final config tweaking + + function to call to to do final config tweaking on #FcPattern objects. - - data to pass to @func + + data to pass to @func - function to call when @data is no longer used. + function to call when @data is no longer used. - - Release any resources that have been cached for the + + Release any resources that have been cached for the combination of @display and @screen. Note that when the X display is closed, resources are released automatically, without needing to call this function. + - an X display + an X display - the screen number of a screen within @display + the screen number of a screen within @display - - Call this function any time the results of the + + Call this function any time the results of the default substitution function set with pango_xft_set_default_substitute() change. That is, if your substitution function will return different results for the same input pattern, you must call this function. Use pango_fc_font_map_substitute_changed() instead. + - an X Display + an X Display - the screen number of a screen within @display + the screen number of a screen within @display diff --git a/Soup-2.4.gir b/Soup-2.4.gir index cfbb396..3a1151b 100644 --- a/Soup-2.4.gir +++ b/Soup-2.4.gir @@ -2,307 +2,521 @@ - + - - + + + - This can be passed to any #SoupAddress method that expects a port, + This can be passed to any #SoupAddress method that expects a port, to indicate that you don't care what port is used. + - + + - - Alias for the #SoupAddress:family property. (The + + Alias for the #SoupAddress:family property. (The #SoupAddressFamily for this address.) + - + + - Alias for the #SoupAddress:name property. (The hostname for + Alias for the #SoupAddress:name property. (The hostname for this address.) + - - An alias for the #SoupAddress:physical property. (The + + An alias for the #SoupAddress:physical property. (The stringified IP address for this address.) + - An alias for the #SoupAddress:port property. (The port for + An alias for the #SoupAddress:port property. (The port for this address.) + - - Alias for the #SoupAddress:protocol property. (The URI scheme + + Alias for the #SoupAddress:protocol property. (The URI scheme used with this address.) + - - An alias for the #SoupAddress:sockaddr property. (A pointer + + An alias for the #SoupAddress:sockaddr property. (A pointer to the struct sockaddr for this address.) + + - + + - + + - - Alias for the #SoupAuthDomain:add-path property. (Shortcut + + Alias for the #SoupAuthDomain:add-path property. (Shortcut for calling soup_auth_domain_add_path().) + - + + - - Alias for the #SoupAuthDomainBasic:auth-callback property. + + Alias for the #SoupAuthDomainBasic:auth-callback property. (The #SoupAuthDomainBasicAuthCallback.) + - - Alias for the #SoupAuthDomainBasic:auth-data property. + + Alias for the #SoupAuthDomainBasic:auth-data property. (The data to pass to the #SoupAuthDomainBasicAuthCallback.) + - + + - + + - + + - + + - - Alias for the #SoupAuthDomainDigest:auth-callback property. + + Alias for the #SoupAuthDomainDigest:auth-callback property. (The #SoupAuthDomainDigestAuthCallback.) + - - Alias for the #SoupAuthDomainDigest:auth-callback property. + + Alias for the #SoupAuthDomainDigest:auth-callback property. (The #SoupAuthDomainDigestAuthCallback.) + - + + - + + - - Alias for the #SoupAuthDomain:filter property. (The + + Alias for the #SoupAuthDomain:filter property. (The #SoupAuthDomainFilter for the domain.) + - - Alias for the #SoupAuthDomain:filter-data property. (Data + + Alias for the #SoupAuthDomain:filter-data property. (Data to pass to the #SoupAuthDomainFilter.) + - - Alias for the #SoupAuthDomain:generic-auth-callback property. + + Alias for the #SoupAuthDomain:generic-auth-callback property. (The #SoupAuthDomainGenericAuthCallback.) + - - Alias for the #SoupAuthDomain:generic-auth-data property. + + Alias for the #SoupAuthDomain:generic-auth-data property. (The data to pass to the #SoupAuthDomainGenericAuthCallback.) + - + + - - Alias for the #SoupAuthDomain:proxy property. (Whether or + + Alias for the #SoupAuthDomain:proxy property. (Whether or not this is a proxy auth domain.) + - - Alias for the #SoupAuthDomain:realm property. (The realm of + + Alias for the #SoupAuthDomain:realm property. (The realm of this auth domain.) + - - Alias for the #SoupAuthDomain:remove-path property. + + Alias for the #SoupAuthDomain:remove-path property. (Shortcut for calling soup_auth_domain_remove_path().) + - + + - An alias for the #SoupAuth:host property. (The + An alias for the #SoupAuth:host property. (The host being authenticated to.) + - - An alias for the #SoupAuth:is-authenticated property. + + An alias for the #SoupAuth:is-authenticated property. (Whether or not the auth has been authenticated.) + - - An alias for the #SoupAuth:is-for-proxy property. (Whether + + An alias for the #SoupAuth:is-for-proxy property. (Whether or not the auth is for a proxy server.) + - + + - + + - + + - An alias for the #SoupAuth:realm property. (The + An alias for the #SoupAuth:realm property. (The authentication realm.) + - - An alias for the #SoupAuth:scheme-name property. (The + + An alias for the #SoupAuth:scheme-name property. (The authentication scheme name.) + - - #SoupAddress represents the address of a TCP connection endpoint: -both the IP address and the port. (It is somewhat like an -object-oriented version of struct sockaddr.) - -Although #SoupAddress is still used in some libsoup API's, it -should not be used in new code; use GLib's #GNetworkAddress or -#GSocketAddress instead. + + - Creates a #SoupAddress from @name and @port. The #SoupAddress's IP + Creates a #SoupAddress from @name and @port. The #SoupAddress's IP address may not be available right away; the caller can call soup_address_resolve_async() or soup_address_resolve_sync() to force a DNS resolution. + - a #SoupAddress + a #SoupAddress - a hostname or physical address + a hostname or physical address - a port number + a port number - Returns a #SoupAddress corresponding to the "any" address + Returns a #SoupAddress corresponding to the "any" address for @family (or %NULL if @family isn't supported), suitable for using as a listening #SoupSocket. + - the new #SoupAddress + the new #SoupAddress - the address family + the address family - the port number (usually %SOUP_ADDRESS_ANY_PORT) + the port number (usually %SOUP_ADDRESS_ANY_PORT) - - Returns a #SoupAddress equivalent to @sa (or %NULL if @sa's + + Returns a #SoupAddress equivalent to @sa (or %NULL if @sa's address family isn't supported) + - the new #SoupAddress + the new #SoupAddress - - a pointer to a sockaddr + + a pointer to a sockaddr - size of @sa + size of @sa - - Tests if @addr1 and @addr2 have the same IP address. This method + + Tests if @addr1 and @addr2 have the same IP address. This method can be used with soup_address_hash_by_ip() to create a #GHashTable that hashes on IP address. @@ -314,26 +528,37 @@ to either of them. See also soup_address_equal_by_name(), which compares by name rather than by IP address. + - whether or not @addr1 and @addr2 have the same IP + whether or not @addr1 and @addr2 have the same IP address. - a #SoupAddress with a resolved IP + a #SoupAddress with a resolved IP address - another #SoupAddress with a resolved + another #SoupAddress with a resolved IP address - - Tests if @addr1 and @addr2 have the same "name". This method can be + + Tests if @addr1 and @addr2 have the same "name". This method can be used with soup_address_hash_by_name() to create a #GHashTable that hashes on address "names". @@ -354,154 +579,227 @@ to be different hosts. See also soup_address_equal_by_ip(), which compares by IP address rather than by name. + - whether or not @addr1 and @addr2 have the same name + whether or not @addr1 and @addr2 have the same name - a #SoupAddress with a resolved name + a #SoupAddress with a resolved name - another #SoupAddress with a resolved + another #SoupAddress with a resolved name - - Creates a new #GSocketAddress corresponding to @addr (which is assumed + + Creates a new #GSocketAddress corresponding to @addr (which is assumed to only have one socket address associated with it). + - a new #GSocketAddress + a new #GSocketAddress - a #SoupAddress + a #SoupAddress - Returns the hostname associated with @addr. + Returns the hostname associated with @addr. This method is not thread-safe; if you call it while @addr is being resolved in another thread, it may return garbage. You can use soup_address_is_resolved() to safely test whether or not an address is resolved before fetching its name or address. + - the hostname, or %NULL if it is not known. + the hostname, or %NULL if it is not known. - a #SoupAddress + a #SoupAddress - Returns the physical address associated with @addr as a string. + Returns the physical address associated with @addr as a string. (Eg, "127.0.0.1"). If the address is not yet known, returns %NULL. This method is not thread-safe; if you call it while @addr is being resolved in another thread, it may return garbage. You can use soup_address_is_resolved() to safely test whether or not an address is resolved before fetching its name or address. + - the physical address, or %NULL + the physical address, or %NULL - a #SoupAddress + a #SoupAddress - Returns the port associated with @addr. + Returns the port associated with @addr. + - the port + the port - a #SoupAddress + a #SoupAddress - Returns the sockaddr associated with @addr, with its length in + Returns the sockaddr associated with @addr, with its length in *@len. If the sockaddr is not yet known, returns %NULL. This method is not thread-safe; if you call it while @addr is being resolved in another thread, it may return garbage. You can use soup_address_is_resolved() to safely test whether or not an address is resolved before fetching its name or address. + - the sockaddr, or %NULL + the sockaddr, or %NULL - a #SoupAddress + a #SoupAddress - return location for sockaddr length + return location for sockaddr length - - A hash function (for #GHashTable) that corresponds to + + A hash function (for #GHashTable) that corresponds to soup_address_equal_by_ip(), qv + - the IP-based hash value for @addr. + the IP-based hash value for @addr. - a #SoupAddress + a #SoupAddress - - A hash function (for #GHashTable) that corresponds to + + A hash function (for #GHashTable) that corresponds to soup_address_equal_by_name(), qv + - the named-based hash value for @addr. + the named-based hash value for @addr. - a #SoupAddress + a #SoupAddress - Tests if @addr has already been resolved. Unlike the other + Tests if @addr has already been resolved. Unlike the other #SoupAddress "get" methods, this is safe to call when @addr might be being resolved in another thread. + - %TRUE if @addr has been resolved. + %TRUE if @addr has been resolved. - a #SoupAddress + a #SoupAddress - Asynchronously resolves the missing half of @addr (its IP address + Asynchronously resolves the missing half of @addr (its IP address if it was created with soup_address_new(), or its hostname if it was created with soup_address_new_from_sockaddr() or soup_address_new_any().) @@ -515,34 +813,59 @@ same thread, with the same @async_context (and doing so will not result in redundant DNS queries being made). But it is not safe to call from multiple threads, or with different @async_contexts, or mixed with calls to soup_address_resolve_sync(). + - a #SoupAddress + a #SoupAddress - - the #GMainContext to call @callback from + + the #GMainContext to call @callback from - - a #GCancellable object, or %NULL + + a #GCancellable object, or %NULL - - callback to call with the result + + callback to call with the result - - data for @callback + + data for @callback - Synchronously resolves the missing half of @addr, as with + Synchronously resolves the missing half of @addr, as with soup_address_resolve_async(). If @cancellable is non-%NULL, it can be used to cancel the @@ -553,38 +876,63 @@ It is safe to call this more than once, even from different threads, but it is not safe to mix calls to soup_address_resolve_sync() with calls to soup_address_resolve_async() on the same address. + - %SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or + %SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or %SOUP_STATUS_CANCELLED. - a #SoupAddress + a #SoupAddress - - a #GCancellable object, or %NULL + + a #GCancellable object, or %NULL - + - + - + - + - + @@ -592,33 +940,50 @@ soup_address_resolve_async() on the same address. - The callback function passed to soup_address_resolve_async(). + The callback function passed to soup_address_resolve_async(). + - the #SoupAddress that was resolved + the #SoupAddress that was resolved - %SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or + %SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or %SOUP_STATUS_CANCELLED - - the user data that was passed to + + the user data that was passed to soup_address_resolve_async() - + + + @@ -626,6 +991,7 @@ soup_address_resolve_async() + @@ -633,6 +999,7 @@ soup_address_resolve_async() + @@ -640,115 +1007,191 @@ soup_address_resolve_async() + - - The supported address families. - - an invalid %SoupAddress + + The supported address families. + + an invalid %SoupAddress - - an IPv4 address + + an IPv4 address - - an IPv6 address + + an IPv6 address - - #SoupAuth objects store the authentication data associated with a -given bit of web space. They are created automatically by -#SoupSession. + + The abstract base class for handling authentication. Specific HTTP +Authentication mechanisms are implemented by its subclasses, but +applications never need to be aware of the specific subclasses +being used. + - Creates a new #SoupAuth of type @type with the information from + Creates a new #SoupAuth of type @type with the information from @msg and @auth_header. This is called by #SoupSession; you will normally not create auths yourself. + - the new #SoupAuth, or %NULL if it could + the new #SoupAuth, or %NULL if it could not be created - the type of auth to create (a subtype of #SoupAuth) + the type of auth to create (a subtype of #SoupAuth) - the #SoupMessage the auth is being created for + the #SoupMessage the auth is being created for - the WWW-Authenticate/Proxy-Authenticate header + the WWW-Authenticate/Proxy-Authenticate header - Call this on an auth to authenticate it; normally this will cause + Call this on an auth to authenticate it; normally this will cause the auth's message to be requeued with the new authentication info. + - a #SoupAuth + a #SoupAuth - the username provided by the user or client + the username provided by the user or client - the password provided by the user or client + the password provided by the user or client - - Tests if @auth is able to authenticate by providing credentials to the + + Tests if @auth is able to authenticate by providing credentials to the soup_auth_authenticate(). + - %TRUE if @auth is able to accept credentials. + %TRUE if @auth is able to accept credentials. - a #SoupAuth + a #SoupAuth - Generates an appropriate "Authorization" header for @msg. (The + Generates an appropriate "Authorization" header for @msg. (The session will only call this if soup_auth_is_authenticated() returned %TRUE.) + - the "Authorization" header, which must be freed. + the "Authorization" header, which must be freed. - a #SoupAuth + a #SoupAuth - the #SoupMessage to be authorized + the #SoupMessage to be authorized - - Returns a list of paths on the server which @auth extends over. + + Returns a list of paths on the server which @auth extends over. (All subdirectories of these paths are also assumed to be part of @auth's protection space, unless otherwise discovered not to be.) + - the list of + the list of paths, which can be freed with soup_auth_free_protection_space(). @@ -756,70 +1199,101 @@ paths, which can be freed with soup_auth_free_protection_space(). - a #SoupAuth + a #SoupAuth - the URI of the request that @auth was generated in + the URI of the request that @auth was generated in response to. - Tests if @auth has been given a username and password + Tests if @auth has been given a username and password + - %TRUE if @auth has been given a username and password + %TRUE if @auth has been given a username and password - a #SoupAuth + a #SoupAuth - Tests if @auth is ready to make a request for @msg with. For most + Tests if @auth is ready to make a request for @msg with. For most auths, this is equivalent to soup_auth_is_authenticated(), but for some auth types (eg, NTLM), the auth may be sendable (eg, as an authentication request) even before it is authenticated. + - %TRUE if @auth is ready to make a request with. + %TRUE if @auth is ready to make a request with. - a #SoupAuth + a #SoupAuth - a #SoupMessage + a #SoupMessage - Updates @auth with the information from @msg and @auth_header, + Updates @auth with the information from @msg and @auth_header, possibly un-authenticating it. As with soup_auth_new(), this is normally only used by #SoupSession. + - %TRUE if @auth is still a valid (but potentially + %TRUE if @auth is still a valid (but potentially unauthenticated) #SoupAuth. %FALSE if something about @auth_params could not be parsed or incorporated into @auth at all. - a #SoupAuth + a #SoupAuth - the #SoupMessage @auth is being updated for + the #SoupMessage @auth is being updated for - the WWW-Authenticate/Proxy-Authenticate header + the WWW-Authenticate/Proxy-Authenticate header @@ -828,113 +1302,170 @@ could not be parsed or incorporated into @auth at all. - Call this on an auth to authenticate it; normally this will cause + Call this on an auth to authenticate it; normally this will cause the auth's message to be requeued with the new authentication info. + - a #SoupAuth + a #SoupAuth - the username provided by the user or client + the username provided by the user or client - the password provided by the user or client + the password provided by the user or client - - Tests if @auth is able to authenticate by providing credentials to the + + Tests if @auth is able to authenticate by providing credentials to the soup_auth_authenticate(). + - %TRUE if @auth is able to accept credentials. + %TRUE if @auth is able to accept credentials. - a #SoupAuth + a #SoupAuth - - Frees @space. + + Frees @space. + - a #SoupAuth + a #SoupAuth - the return value from soup_auth_get_protection_space() + the return value from soup_auth_get_protection_space() - - Generates an appropriate "Authorization" header for @msg. (The + + Generates an appropriate "Authorization" header for @msg. (The session will only call this if soup_auth_is_authenticated() returned %TRUE.) + - the "Authorization" header, which must be freed. + the "Authorization" header, which must be freed. - a #SoupAuth + a #SoupAuth - the #SoupMessage to be authorized + the #SoupMessage to be authorized - Returns the host that @auth is associated with. + Returns the host that @auth is associated with. + - the hostname + the hostname - a #SoupAuth + a #SoupAuth - Gets an opaque identifier for @auth, for use as a hash key or the + Gets an opaque identifier for @auth, for use as a hash key or the like. #SoupAuth objects from the same server with the same identifier refer to the same authentication domain (eg, the URLs associated with them take the same usernames and passwords). + - the identifier + the identifier - a #SoupAuth + a #SoupAuth - - Returns a list of paths on the server which @auth extends over. + + Returns a list of paths on the server which @auth extends over. (All subdirectories of these paths are also assumed to be part of @auth's protection space, unless otherwise discovered not to be.) + - the list of + the list of paths, which can be freed with soup_auth_free_protection_space(). @@ -942,33 +1473,46 @@ paths, which can be freed with soup_auth_free_protection_space(). - a #SoupAuth + a #SoupAuth - the URI of the request that @auth was generated in + the URI of the request that @auth was generated in response to. - Returns @auth's realm. This is an identifier that distinguishes + Returns @auth's realm. This is an identifier that distinguishes separate authentication spaces on a given server, and may be some string that is meaningful to the user. (Although it is probably not localized.) + - the realm name + the realm name - a #SoupAuth + a #SoupAuth - + + @@ -982,6 +1526,7 @@ localized.) + @@ -994,19 +1539,28 @@ localized.) - Returns @auth's scheme name. (Eg, "Basic", "Digest", or "NTLM") + Returns @auth's scheme name. (Eg, "Basic", "Digest", or "NTLM") + - the scheme name + the scheme name - a #SoupAuth + a #SoupAuth - + + @@ -1022,54 +1576,79 @@ localized.) - - Tests if @auth has been given a username and password + + Tests if @auth has been given a username and password + - %TRUE if @auth has been given a username and password + %TRUE if @auth has been given a username and password - a #SoupAuth + a #SoupAuth - Tests whether or not @auth is associated with a proxy server rather + Tests whether or not @auth is associated with a proxy server rather than an "origin" server. + - %TRUE or %FALSE + %TRUE or %FALSE - a #SoupAuth + a #SoupAuth - Tests if @auth is ready to make a request for @msg with. For most + Tests if @auth is ready to make a request for @msg with. For most auths, this is equivalent to soup_auth_is_authenticated(), but for some auth types (eg, NTLM), the auth may be sendable (eg, as an authentication request) even before it is authenticated. + - %TRUE if @auth is ready to make a request with. + %TRUE if @auth is ready to make a request with. - a #SoupAuth + a #SoupAuth - a #SoupMessage + a #SoupMessage + @@ -1086,26 +1665,37 @@ authentication request) even before it is authenticated. - Updates @auth with the information from @msg and @auth_header, + Updates @auth with the information from @msg and @auth_header, possibly un-authenticating it. As with soup_auth_new(), this is normally only used by #SoupSession. + - %TRUE if @auth is still a valid (but potentially + %TRUE if @auth is still a valid (but potentially unauthenticated) #SoupAuth. %FALSE if something about @auth_params could not be parsed or incorporated into @auth at all. - a #SoupAuth + a #SoupAuth - the #SoupMessage @auth is being updated for + the #SoupMessage @auth is being updated for - the WWW-Authenticate/Proxy-Authenticate header + the WWW-Authenticate/Proxy-Authenticate header @@ -1132,9 +1722,16 @@ could not be parsed or incorporated into @auth at all. - + - + + @@ -1146,23 +1743,32 @@ could not be parsed or incorporated into @auth at all. + - %TRUE if @auth is still a valid (but potentially + %TRUE if @auth is still a valid (but potentially unauthenticated) #SoupAuth. %FALSE if something about @auth_params could not be parsed or incorporated into @auth at all. - a #SoupAuth + a #SoupAuth - the #SoupMessage @auth is being updated for + the #SoupMessage @auth is being updated for - the WWW-Authenticate/Proxy-Authenticate header + the WWW-Authenticate/Proxy-Authenticate header @@ -1173,8 +1779,11 @@ could not be parsed or incorporated into @auth at all. + - the list of + the list of paths, which can be freed with soup_auth_free_protection_space(). @@ -1182,11 +1791,15 @@ paths, which can be freed with soup_auth_free_protection_space(). - a #SoupAuth + a #SoupAuth - the URI of the request that @auth was generated in + the URI of the request that @auth was generated in response to. @@ -1195,20 +1808,27 @@ response to. + - a #SoupAuth + a #SoupAuth - the username provided by the user or client + the username provided by the user or client - the password provided by the user or client + the password provided by the user or client @@ -1216,13 +1836,18 @@ response to. + - %TRUE if @auth has been given a username and password + %TRUE if @auth has been given a username and password - a #SoupAuth + a #SoupAuth @@ -1230,17 +1855,24 @@ response to. + - the "Authorization" header, which must be freed. + the "Authorization" header, which must be freed. - a #SoupAuth + a #SoupAuth - the #SoupMessage to be authorized + the #SoupMessage to be authorized @@ -1248,17 +1880,24 @@ response to. + - %TRUE if @auth is ready to make a request with. + %TRUE if @auth is ready to make a request with. - a #SoupAuth + a #SoupAuth - a #SoupMessage + a #SoupMessage @@ -1266,13 +1905,18 @@ response to. + - %TRUE if @auth is able to accept credentials. + %TRUE if @auth is able to accept credentials. - a #SoupAuth + a #SoupAuth @@ -1280,6 +1924,7 @@ response to. + @@ -1287,33 +1932,30 @@ response to. + - + - - A #SoupAuthDomain manages authentication for all or part of a -#SoupServer. To make a server require authentication, first create -an appropriate subclass of #SoupAuthDomain, and then add it to the -server with soup_server_add_auth_domain(). - -In order for an auth domain to have any effect, you must add one or -more paths to it (via soup_auth_domain_add_path() or the -%SOUP_AUTH_DOMAIN_ADD_PATH property). To require authentication for -all ordinary requests, add the path "/". (Note that this does not -include the special "*" URI (eg, "OPTIONS *"), which must be added -as a separate path if you want to cover it.) - -If you need greater control over which requests should and -shouldn't be authenticated, add paths covering everything you -<emphasis>might</emphasis> want authenticated, and then use a -filter (soup_auth_domain_set_filter()) to bypass authentication for -those requests that don't need it. + + + @@ -1330,185 +1972,260 @@ those requests that don't need it. - Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg, + Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg, requesting that the client authenticate, and sets @msg's status accordingly. This is used by #SoupServer internally and is probably of no use to anyone else. + - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - Checks if @msg authenticates to @domain via @username and + Checks if @msg authenticates to @domain via @username and @password. This would normally be called from a #SoupAuthDomainGenericAuthCallback. + - whether or not the message is authenticated + whether or not the message is authenticated - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - a username + a username - a password + a password - Checks if @msg contains appropriate authorization for @domain to + Checks if @msg contains appropriate authorization for @domain to accept it. Mirroring soup_auth_domain_covers(), this does not check whether or not @domain <emphasis>cares</emphasis> if @msg is authorized. This is used by #SoupServer internally and is probably of no use to anyone else. + - the username that @msg has authenticated + the username that @msg has authenticated as, if in fact it has authenticated. %NULL otherwise. - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - Adds @path to @domain, such that requests under @path on @domain's + Adds @path to @domain, such that requests under @path on @domain's server will require authentication (unless overridden by soup_auth_domain_remove_path() or soup_auth_domain_set_filter()). You can also add paths by setting the %SOUP_AUTH_DOMAIN_ADD_PATH property, which can also be used to add one or more paths at construct time. + - a #SoupAuthDomain + a #SoupAuthDomain - the path to add to @domain + the path to add to @domain - Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg, + Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg, requesting that the client authenticate, and sets @msg's status accordingly. This is used by #SoupServer internally and is probably of no use to anyone else. + - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - - Checks if @msg authenticates to @domain via @username and + + Checks if @msg authenticates to @domain via @username and @password. This would normally be called from a #SoupAuthDomainGenericAuthCallback. + - whether or not the message is authenticated + whether or not the message is authenticated - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - a username + a username - a password + a password - Checks if @domain requires @msg to be authenticated (according to + Checks if @domain requires @msg to be authenticated (according to its paths and filter function). This does not actually look at whether @msg <emphasis>is</emphasis> authenticated, merely whether or not it needs to be. This is used by #SoupServer internally and is probably of no use to anyone else. + - %TRUE if @domain requires @msg to be authenticated + %TRUE if @domain requires @msg to be authenticated - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - Gets the realm name associated with @domain + Gets the realm name associated with @domain + - @domain's realm + @domain's realm - a #SoupAuthDomain + a #SoupAuthDomain - Removes @path from @domain, such that requests under @path on + Removes @path from @domain, such that requests under @path on @domain's server will NOT require authentication. This is not simply an undo-er for soup_auth_domain_add_path(); it @@ -1522,22 +2239,29 @@ otherwise be unnecessary. You can also remove paths by setting the %SOUP_AUTH_DOMAIN_REMOVE_PATH property, which can also be used to remove one or more paths at construct time. + - a #SoupAuthDomain + a #SoupAuthDomain - the path to remove from @domain + the path to remove from @domain - Adds @filter as an authentication filter to @domain. The filter + Adds @filter as an authentication filter to @domain. The filter gets a chance to bypass authentication for certain requests that would otherwise require it. Eg, it might check the message's path in some way that is too complicated to do via the other methods, or @@ -1561,60 +2285,98 @@ unauthenticated users. You can also set the filter by setting the %SOUP_AUTH_DOMAIN_FILTER and %SOUP_AUTH_DOMAIN_FILTER_DATA properties, which can also be used to set the filter at construct time. + - a #SoupAuthDomain + a #SoupAuthDomain - - the auth filter for @domain + + the auth filter for @domain - - data to pass to @filter + + data to pass to @filter - destroy notifier to free @filter_data when @domain + destroy notifier to free @filter_data when @domain is destroyed - - Sets @auth_callback as an authentication-handling callback for + + Sets @auth_callback as an authentication-handling callback for @domain. Whenever a request comes in to @domain which cannot be authenticated via a domain-specific auth callback (eg, #SoupAuthDomainDigestAuthCallback), the generic auth callback will be invoked. See #SoupAuthDomainGenericAuthCallback for information on what the callback should do. + - a #SoupAuthDomain + a #SoupAuthDomain - - the auth callback - + + the auth callback + - - data to pass to @auth_callback + + data to pass to @auth_callback - destroy notifier to free @auth_data when @domain + destroy notifier to free @auth_data when @domain is destroyed - + + @@ -1630,61 +2392,102 @@ is destroyed - + - The #SoupAuthDomainFilter for the domain + The #SoupAuthDomainFilter for the domain - - The #SoupAuthDomainGenericAuthCallback for the domain + + The #SoupAuthDomainGenericAuthCallback for the domain - + - + - + - + - - #SoupAuthDomainBasic handles the server side of HTTP "Basic" (ie, -cleartext password) authentication. - - Creates a #SoupAuthDomainBasic. You must set the + + + + Creates a #SoupAuthDomainBasic. You must set the %SOUP_AUTH_DOMAIN_REALM parameter, to indicate the realm name to be returned with the authentication challenge to the client. Other parameters are optional. + - the new #SoupAuthDomain + the new #SoupAuthDomain - name of first option, or %NULL + name of first option, or %NULL - option name/value pairs + option name/value pairs - - Sets the callback that @domain will use to authenticate incoming + + Sets the callback that @domain will use to authenticate incoming requests. For each request containing authorization, @domain will invoke the callback, and then either accept or reject the request based on @callback's return value. @@ -1693,43 +2496,68 @@ You can also set the auth callback by setting the %SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK and %SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA properties, which can also be used to set the callback at construct time. + - the domain + the domain - - the callback - + + the callback + - - data to pass to @auth_callback + + data to pass to @auth_callback - destroy notifier to free @user_data when @domain + destroy notifier to free @user_data when @domain is destroyed - The #SoupAuthDomainBasicAuthCallback + The #SoupAuthDomainBasicAuthCallback - The data to pass to the #SoupAuthDomainBasicAuthCallback + The data to pass to the #SoupAuthDomainBasicAuthCallback - - Callback used by #SoupAuthDomainBasic for authentication purposes. + + Callback used by #SoupAuthDomainBasic for authentication purposes. The application should verify that @username and @password and valid and return %TRUE or %FALSE. @@ -1743,39 +2571,63 @@ will frequently use the same password for multiple sites, and so compromising any site with a cleartext (or easily-cracked) password database may give attackers access to other more-interesting sites as well. + - %TRUE if @username and @password are valid + %TRUE if @username and @password are valid - the domain + the domain - the message being authenticated + the message being authenticated - the username provided by the client + the username provided by the client - the password provided by the client + the password provided by the client - - the data passed to soup_auth_domain_basic_set_auth_callback() + + the data passed to soup_auth_domain_basic_set_auth_callback() - + + + @@ -1783,6 +2635,8 @@ as well. + @@ -1790,6 +2644,8 @@ as well. + @@ -1797,18 +2653,24 @@ as well. + - + + + @@ -1827,16 +2689,21 @@ as well. + - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage @@ -1844,25 +2711,36 @@ as well. + - whether or not the message is authenticated + whether or not the message is authenticated - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - a username + a username - a password + a password @@ -1870,6 +2748,7 @@ as well. + @@ -1877,6 +2756,7 @@ as well. + @@ -1884,37 +2764,59 @@ as well. + - - #SoupAuthDomainDigest handles the server side of HTTP "Digest" -authentication. - - Creates a #SoupAuthDomainDigest. You must set the + + + + Creates a #SoupAuthDomainDigest. You must set the %SOUP_AUTH_DOMAIN_REALM parameter, to indicate the realm name to be returned with the authentication challenge to the client. Other parameters are optional. + - the new #SoupAuthDomain + the new #SoupAuthDomain - name of first option, or %NULL + name of first option, or %NULL - option name/value pairs + option name/value pairs - - Encodes the username/realm/password triplet for Digest + + Encodes the username/realm/password triplet for Digest authentication. (That is, it returns a stringified MD5 hash of @username, @realm, and @password concatenated together). This is the form that is needed as the return value of @@ -1927,27 +2829,40 @@ compromised, the attackers will not gain access to cleartext passwords which might also be usable at other sites. (Note also that the encoded password returned by this method is identical to the encoded password stored in an Apache .htdigest file.) + - the encoded password + the encoded password - a username + a username - an auth realm name + an auth realm name - the password for @username in @realm + the password for @username in @realm - - Sets the callback that @domain will use to authenticate incoming + + Sets the callback that @domain will use to authenticate incoming requests. For each request containing authorization, @domain will invoke the callback, and then either accept or reject the request based on @callback's return value. @@ -1956,77 +2871,124 @@ You can also set the auth callback by setting the %SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK and %SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA properties, which can also be used to set the callback at construct time. + - the domain + the domain - - the callback - + + the callback + - - data to pass to @auth_callback + + data to pass to @auth_callback - destroy notifier to free @user_data when @domain + destroy notifier to free @user_data when @domain is destroyed - The #SoupAuthDomainDigestAuthCallback + The #SoupAuthDomainDigestAuthCallback - The data to pass to the #SoupAuthDomainDigestAuthCallback + The data to pass to the #SoupAuthDomainDigestAuthCallback - - Callback used by #SoupAuthDomainDigest for authentication purposes. + + Callback used by #SoupAuthDomainDigest for authentication purposes. The application should look up @username in its password database, and return the corresponding encoded password (see soup_auth_domain_digest_encode_password()). + - the encoded password, or %NULL if + the encoded password, or %NULL if @username is not a valid user. @domain will free the password when it is done with it. - the domain + the domain - the message being authenticated + the message being authenticated - the username provided by the client + the username provided by the client - - the data passed to soup_auth_domain_digest_set_auth_callback() + + the data passed to soup_auth_domain_digest_set_auth_callback() - + + + @@ -2034,6 +2996,8 @@ it is done with it. + @@ -2041,6 +3005,8 @@ it is done with it. + @@ -2048,6 +3014,8 @@ it is done with it. + @@ -2055,29 +3023,47 @@ it is done with it. - The prototype for a #SoupAuthDomain filter; see + The prototype for a #SoupAuthDomain filter; see soup_auth_domain_set_filter() for details. + - %TRUE if @msg requires authentication, %FALSE if not. + %TRUE if @msg requires authentication, %FALSE if not. - a #SoupAuthDomain + a #SoupAuthDomain - a #SoupMessage + a #SoupMessage - - the data passed to soup_auth_domain_set_filter() + + the data passed to soup_auth_domain_set_filter() - - The prototype for a #SoupAuthDomain generic authentication callback. + + The prototype for a #SoupAuthDomain generic authentication callback. The callback should look up the user's password, call soup_auth_domain_check_password(), and use the return value from @@ -2093,41 +3079,56 @@ cleartext password database is compromised, accounts on other servers might be compromised as well. For many of the cases where #SoupServer is used, this is not really relevant, but it may still be worth considering. + - %TRUE if @msg is authenticated, %FALSE if not. + %TRUE if @msg is authenticated, %FALSE if not. - a #SoupAuthDomain + a #SoupAuthDomain - the #SoupMessage being authenticated + the #SoupMessage being authenticated - the username from @msg + the username from @msg - - the data passed to + + the data passed to soup_auth_domain_set_generic_auth_callback() - - #SoupAuthManager is the #SoupSessionFeature that handles HTTP -authentication for a #SoupSession. - -A #SoupAuthManager is added to the session by default, and normally -you don't need to worry about it at all. However, if you want to -disable HTTP authentication, you can remove the feature from the -session with soup_session_remove_feature_by_type(), or disable it on -individual requests with soup_message_disable_feature(). + + + @@ -2146,20 +3147,31 @@ individual requests with soup_message_disable_feature(). - - Clear all credentials cached by @manager + + Clear all credentials cached by @manager + - a #SoupAuthManager + a #SoupAuthManager - - Records that @auth is to be used under @uri, as though a + + Records that @auth is to be used under @uri, as though a WWW-Authenticate header had been received at that URI. This can be used to "preload" @manager's auth cache, to avoid an extra HTTP round trip in the case where you know ahead of time that a 401 @@ -2168,20 +3180,27 @@ response will be returned. This is only useful for authentication types where the initial Authorization header does not depend on any additional information from the server. (Eg, Basic or NTLM, but not Digest.) + - a #SoupAuthManager + a #SoupAuthManager - the #SoupURI under which @auth is to be used + the #SoupURI under which @auth is to be used - the #SoupAuth to use + the #SoupAuth to use @@ -2193,7 +3212,9 @@ from the server. (Eg, Basic or NTLM, but not Digest.) - Emitted when the manager requires the application to + Emitted when the manager requires the application to provide authentication credentials. #SoupSession connects to this signal and emits its own @@ -2204,26 +3225,37 @@ you shouldn't need to use this signal directly. - the #SoupMessage being sent + the #SoupMessage being sent - the #SoupAuth to authenticate + the #SoupAuth to authenticate - %TRUE if this is the second (or later) attempt + %TRUE if this is the second (or later) attempt - + + + @@ -2244,82 +3276,138 @@ you shouldn't need to use this signal directly. - - + + + + - - - Indicates whether libsoup was built with GSSAPI support. If this is + + + Indicates whether libsoup was built with GSSAPI support. If this is %FALSE, %SOUP_TYPE_AUTH_NEGOTIATE will still be defined and can still be added to a #SoupSession, but libsoup will never attempt to actually use this auth type. + - - A data buffer, generally used to represent a chunk of a + + A data buffer, generally used to represent a chunk of a #SoupMessageBody. @data is a #char because that's generally convenient; in some situations you may need to cast it to #guchar or another type. + - the data + the data - length of @data + length of @data - - Creates a new #SoupBuffer containing @length bytes from @data. + + Creates a new #SoupBuffer containing @length bytes from @data. + - the new #SoupBuffer. + the new #SoupBuffer. - how @data is to be used by the buffer + how @data is to be used by the buffer - data + data - length of @data + length of @data - - Creates a new #SoupBuffer containing @length bytes from @data. + + Creates a new #SoupBuffer containing @length bytes from @data. This function is exactly equivalent to soup_buffer_new() with %SOUP_MEMORY_TAKE as first argument; it exists mainly for convenience and simplifying language bindings. + - the new #SoupBuffer. + the new #SoupBuffer. - data + data - length of @data + length of @data - - Creates a new #SoupBuffer containing @length bytes from @data. When + + Creates a new #SoupBuffer containing @length bytes from @data. When the #SoupBuffer is freed, it will call @owner_dnotify, passing @owner to it. You must ensure that @data will remain valid until @owner_dnotify is called. @@ -2336,346 +3424,564 @@ return soup_buffer_new_with_owner (xmlbody, len, xmlbody, In this example, @data and @owner are the same, but in other cases they would be different (eg, @owner would be a object, and @data would be a pointer to one of the object's fields). + - the new #SoupBuffer. + the new #SoupBuffer. - data + data - length of @data + length of @data - - pointer to an object that owns @data + + pointer to an object that owns @data - - a function to free/unref @owner when + + a function to free/unref @owner when the buffer is freed - Makes a copy of @buffer. In reality, #SoupBuffer is a refcounted + Makes a copy of @buffer. In reality, #SoupBuffer is a refcounted type, and calling soup_buffer_copy() will normally just increment the refcount on @buffer and return it. However, if @buffer was created with #SOUP_MEMORY_TEMPORARY memory, then soup_buffer_copy() will actually return a copy of it, so that the data in the copy will remain valid after the temporary buffer is freed. + - the new (or newly-reffed) buffer + the new (or newly-reffed) buffer - a #SoupBuffer + a #SoupBuffer - Frees @buffer. (In reality, as described in the documentation for + Frees @buffer. (In reality, as described in the documentation for soup_buffer_copy(), this is actually an "unref" operation, and may or may not actually free @buffer.) + - a #SoupBuffer + a #SoupBuffer - - Creates a #GBytes pointing to the same memory as @buffer. The + + Creates a #GBytes pointing to the same memory as @buffer. The #GBytes will hold a reference on @buffer to ensure that it is not freed while the #GBytes is still valid. + - a new #GBytes which has the same content + a new #GBytes which has the same content as the #SoupBuffer. - a #SoupBuffer + a #SoupBuffer - - This function exists for use by language bindings, because it's not + + This function exists for use by language bindings, because it's not currently possible to get the right effect by annotating the fields of #SoupBuffer. + - a #SoupBuffer + a #SoupBuffer - - the pointer + + the pointer to the buffer data is stored here - - the length of the buffer data is stored here + + the length of the buffer data is stored here - Gets the "owner" object for a buffer created with + Gets the "owner" object for a buffer created with soup_buffer_new_with_owner(). + - the owner pointer + the owner pointer - a #SoupBuffer created with soup_buffer_new_with_owner() + a #SoupBuffer created with soup_buffer_new_with_owner() - Creates a new #SoupBuffer containing @length bytes "copied" from + Creates a new #SoupBuffer containing @length bytes "copied" from @parent starting at @offset. (Normally this will not actually copy any data, but will instead simply reference the same data as @parent does.) + - the new #SoupBuffer. + the new #SoupBuffer. - the parent #SoupBuffer + the parent #SoupBuffer - offset within @parent to start at + offset within @parent to start at - number of bytes to copy from @parent + number of bytes to copy from @parent - + + - + + - + + + - + + - + + - + + - + + - - Macro to test the version of libsoup being compiled against. + + Macro to test the version of libsoup being compiled against. + - major version (e.g. 2 for version 2.42.0) + major version (e.g. 2 for version 2.42.0) - minor version (e.g. 42 for version 2.42.0) + minor version (e.g. 42 for version 2.42.0) - micro version (e.g. 0 for version 2.42.0) + micro version (e.g. 0 for version 2.42.0) - + + - + + - + + - + + - + + - + + - + + - - Alias for the #SoupCookieJar:accept-policy property. + + Alias for the #SoupCookieJar:accept-policy property. + - + + - + + - + + - - Alias for the #SoupCookieJarDB:filename property. (The + + Alias for the #SoupCookieJarDB:filename property. (The cookie-storage filename.) + - + + - + + - - Alias for the #SoupCookieJar:read-only property. (Whether + + Alias for the #SoupCookieJar:read-only property. (Whether or not the cookie jar is read-only.) + - + + - + + - - Alias for the #SoupCookieJarText:filename property. (The + + Alias for the #SoupCookieJarText:filename property. (The cookie-storage filename.) + - + + - - A constant corresponding to 1 day, for use with soup_cookie_new() + + A constant corresponding to 1 day, for use with soup_cookie_new() and soup_cookie_set_max_age(). + - - A constant corresponding to 1 hour, for use with soup_cookie_new() + + A constant corresponding to 1 hour, for use with soup_cookie_new() and soup_cookie_set_max_age(). + - - A constant corresponding to 1 week, for use with soup_cookie_new() + + A constant corresponding to 1 week, for use with soup_cookie_new() and soup_cookie_set_max_age(). + - - A constant corresponding to 1 year, for use with soup_cookie_new() + + A constant corresponding to 1 year, for use with soup_cookie_new() and soup_cookie_set_max_age(). + - - #SoupCache implements a file-based cache for HTTP resources. + + - Creates a new #SoupCache. + Creates a new #SoupCache. + - a new #SoupCache + a new #SoupCache - - the directory to store the cached data, or %NULL + + the directory to store the cached data, or %NULL to use the default one. Note that since the cache isn't safe to access for multiple processes at once, and the default directory isn't namespaced by process, clients are strongly discouraged from passing %NULL. - the #SoupCacheType of the cache + the #SoupCacheType of the cache + @@ -2689,96 +3995,140 @@ and soup_cookie_set_max_age(). - Will remove all entries in the @cache plus all the cache files. + Will remove all entries in the @cache plus all the cache files. + - a #SoupCache + a #SoupCache - Synchronously writes the cache index out to disk. Contrast with + Synchronously writes the cache index out to disk. Contrast with soup_cache_flush(), which writes pending cache <emphasis>entries</emphasis> to disk. You must call this before exiting if you want your cache data to persist between sessions. + - a #SoupCache + a #SoupCache - This function will force all pending writes in the @cache to be + This function will force all pending writes in the @cache to be committed to disk. For doing so it will iterate the #GMainContext associated with @cache's session as long as needed. Contrast with soup_cache_dump(), which writes out the cache index file. + - a #SoupCache + a #SoupCache - - Gets the maximum size of the cache. + + Gets the maximum size of the cache. + - the maximum size of the cache, in bytes. + the maximum size of the cache, in bytes. - a #SoupCache + a #SoupCache - Loads the contents of @cache's index into memory. + Loads the contents of @cache's index into memory. + - a #SoupCache + a #SoupCache - - Sets the maximum size of the cache. + + Sets the maximum size of the cache. + - a #SoupCache + a #SoupCache - the maximum size of the cache, in bytes + the maximum size of the cache, in bytes - + - + @@ -2788,12 +4138,16 @@ file. - + + + @@ -2809,6 +4163,7 @@ file. + @@ -2816,6 +4171,7 @@ file. + @@ -2823,43 +4179,91 @@ file. + - - - + + + + + - + - + - - The type of cache; this affects what kinds of responses will be + + The type of cache; this affects what kinds of responses will be saved. - - a single-user cache + + a single-user cache - - a shared cache + + a shared cache - - + + - + - + - + - The prototype for a chunk allocation callback. This should allocate + The prototype for a chunk allocation callback. This should allocate a new #SoupBuffer and return it for the I/O layer to read message body data off the network into. @@ -2876,27 +4280,46 @@ up to the application to make sure that it gets unpaused when it becomes possible to allocate a new buffer. Use #SoupRequest if you want to read into your own buffers. + - the new buffer (or %NULL) + the new buffer (or %NULL) - the #SoupMessage the chunk is being allocated for + the #SoupMessage the chunk is being allocated for - the maximum length that will be read, or 0. + the maximum length that will be read, or 0. - - the data passed to soup_message_set_chunk_allocator() + + the data passed to soup_message_set_chunk_allocator() - - A #SoupClientContext provides additional information about the + + A #SoupClientContext provides additional information about the client making a particular request. In particular, you can use soup_client_context_get_auth_domain() and soup_client_context_get_auth_user() to determine if HTTP @@ -2907,58 +4330,88 @@ soup_client_context_get_host() can be used to get information for logging or debugging purposes. soup_client_context_get_gsocket() may also be of use in some situations (eg, tracking when multiple requests are made on the same connection). - - Retrieves the #SoupAddress associated with the remote end + + + Retrieves the #SoupAddress associated with the remote end of a connection. Use soup_client_context_get_remote_address(), which returns a #GSocketAddress. + - the #SoupAddress + the #SoupAddress associated with the remote end of a connection, it may be %NULL if you used soup_server_accept_iostream(). - a #SoupClientContext + a #SoupClientContext - - Checks whether the request associated with @client has been + + Checks whether the request associated with @client has been authenticated, and if so returns the #SoupAuthDomain that authenticated it. + - a #SoupAuthDomain, or + a #SoupAuthDomain, or %NULL if the request was not authenticated. - a #SoupClientContext + a #SoupClientContext - - Checks whether the request associated with @client has been + + Checks whether the request associated with @client has been authenticated, and if so returns the username that the client authenticated as. + - the authenticated-as user, or %NULL if + the authenticated-as user, or %NULL if the request was not authenticated. - a #SoupClientContext + a #SoupClientContext - - Retrieves the #GSocket that @client is associated with. + + Retrieves the #GSocket that @client is associated with. If you are using this method to observe when multiple requests are made on the same persistent HTTP connection (eg, as the ntlm-test @@ -2966,68 +4419,102 @@ test program does), you will need to pay attention to socket destruction as well (eg, by using weak references), so that you do not get fooled when the allocator reuses the memory address of a previously-destroyed socket to represent a new socket. + - the #GSocket that @client is + the #GSocket that @client is associated with, %NULL if you used soup_server_accept_iostream(). - a #SoupClientContext + a #SoupClientContext - Retrieves the IP address associated with the remote end of a + Retrieves the IP address associated with the remote end of a connection. + - the IP address associated with the remote + the IP address associated with the remote end of a connection, it may be %NULL if you used soup_server_accept_iostream(). - a #SoupClientContext + a #SoupClientContext - - Retrieves the #GSocketAddress associated with the local end + + Retrieves the #GSocketAddress associated with the local end of a connection. + - the #GSocketAddress + the #GSocketAddress associated with the local end of a connection, it may be %NULL if you used soup_server_accept_iostream(). - a #SoupClientContext + a #SoupClientContext - - Retrieves the #GSocketAddress associated with the remote end + + Retrieves the #GSocketAddress associated with the remote end of a connection. + - the #GSocketAddress + the #GSocketAddress associated with the remote end of a connection, it may be %NULL if you used soup_server_accept_iostream(). - a #SoupClientContext + a #SoupClientContext - - Retrieves the #SoupSocket that @client is associated with. + + Retrieves the #SoupSocket that @client is associated with. If you are using this method to observe when multiple requests are made on the same persistent HTTP connection (eg, as the ntlm-test @@ -3038,20 +4525,29 @@ not get fooled when the allocator reuses the memory address of a previously-destroyed socket to represent a new socket. use soup_client_context_get_gsocket(), which returns a #GSocket. + - the #SoupSocket that @client is + the #SoupSocket that @client is associated with. - a #SoupClientContext + a #SoupClientContext - - "Steals" the HTTP connection associated with @client from its + + "Steals" the HTTP connection associated with @client from its #SoupServer. This happens immediately, regardless of the current state of the connection; if the response to the current #SoupMessage has not yet finished being sent, then it will be @@ -3062,8 +4558,11 @@ sent. Note that when calling this function from C, @client will most likely be freed as a side effect. + - the #GIOStream formerly associated + the #GIOStream formerly associated with @client (or %NULL if @client was no longer associated with a connection). No guarantees are made about what kind of #GIOStream is returned. @@ -3071,29 +4570,24502 @@ likely be freed as a side effect. - a #SoupClientContext + a #SoupClientContext - - - + + + + + - + - + - + - + - + - - #SoupContentDecoder handles adding the "Accept-Encoding" header on + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #SoupContentSniffer. + + + a new #SoupContentSniffer + + + + + Gets the number of bytes @sniffer needs in order to properly sniff +a buffer. + + + the number of bytes to sniff + + + + + a #SoupContentSniffer + + + + + + Sniffs @buffer to determine its Content-Type. The result may also +be influenced by the Content-Type declared in @msg's response +headers. + + + the sniffed Content-Type of @buffer; this will never be %NULL, + but may be "application/octet-stream". + + + + + a #SoupContentSniffer + + + + the message to sniff + + + + a buffer containing the start of @msg's response body + + + + return + location for Content-Type parameters (eg, "charset"), or %NULL + + + + + + + + + Gets the number of bytes @sniffer needs in order to properly sniff +a buffer. + + + the number of bytes to sniff + + + + + a #SoupContentSniffer + + + + + + Sniffs @buffer to determine its Content-Type. The result may also +be influenced by the Content-Type declared in @msg's response +headers. + + + the sniffed Content-Type of @buffer; this will never be %NULL, + but may be "application/octet-stream". + + + + + a #SoupContentSniffer + + + + the message to sniff + + + + a buffer containing the start of @msg's response body + + + + return + location for Content-Type parameters (eg, "charset"), or %NULL + + + + + + + + + + + + + + + + + + + + + + + + the sniffed Content-Type of @buffer; this will never be %NULL, + but may be "application/octet-stream". + + + + + a #SoupContentSniffer + + + + the message to sniff + + + + a buffer containing the start of @msg's response body + + + + return + location for Content-Type parameters (eg, "charset"), or %NULL + + + + + + + + + + + + + the number of bytes to sniff + + + + + a #SoupContentSniffer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An HTTP cookie. + +@name and @value will be set for all cookies. If the cookie is +generated from a string that appears to have no name, then @name +will be the empty string. + +@domain and @path give the host or domain, and path within that +host/domain, to restrict this cookie to. If @domain starts with +".", that indicates a domain (which matches the string after the +".", or any hostname that has @domain as a suffix). Otherwise, it +is a hostname and must match exactly. + +@expires will be non-%NULL if the cookie uses either the original +"expires" attribute, or the newer "max-age" attribute. If @expires +is %NULL, it indicates that neither "expires" nor "max-age" was +specified, and the cookie expires at the end of the session. + +If @http_only is set, the cookie should not be exposed to untrusted +code (eg, javascript), so as to minimize the danger posed by +cross-site scripting attacks. + + + the cookie name + + + + the cookie value + + + + the "domain" attribute, or else the hostname that the +cookie came from. + + + + the "path" attribute, or %NULL + + + + the cookie expiration time, or %NULL for a session cookie + + + + %TRUE if the cookie should only be tranferred over SSL + + + + %TRUE if the cookie should not be exposed to scripts + + + + Creates a new #SoupCookie with the given attributes. (Use +soup_cookie_set_secure() and soup_cookie_set_http_only() if you +need to set those attributes on the returned cookie.) + +If @domain starts with ".", that indicates a domain (which matches +the string after the ".", or any hostname that has @domain as a +suffix). Otherwise, it is a hostname and must match exactly. + +@max_age is used to set the "expires" attribute on the cookie; pass +-1 to not include the attribute (indicating that the cookie expires +with the current session), 0 for an already-expired cookie, or a +lifetime in seconds. You can use the constants +%SOUP_COOKIE_MAX_AGE_ONE_HOUR, %SOUP_COOKIE_MAX_AGE_ONE_DAY, +%SOUP_COOKIE_MAX_AGE_ONE_WEEK and %SOUP_COOKIE_MAX_AGE_ONE_YEAR (or +multiples thereof) to calculate this value. (If you really care +about setting the exact time that the cookie will expire, use +soup_cookie_set_expires().) + + + a new #SoupCookie. + + + + + cookie name + + + + cookie value + + + + cookie domain or hostname + + + + cookie path, or %NULL + + + + max age of the cookie, or -1 for a session cookie + + + + + + Tests if @cookie should be sent to @uri. + +(At the moment, this does not check that @cookie's domain matches +@uri, because it assumes that the caller has already done that. +But don't rely on that; it may change in the future.) + + + %TRUE if @cookie should be sent to @uri, %FALSE if +not + + + + + a #SoupCookie + + + + a #SoupURI + + + + + + Copies @cookie. + + + a copy of @cookie + + + + + a #SoupCookie + + + + + + Checks if the @cookie's domain and @host match in the sense that +@cookie should be sent when making a request to @host, or that +@cookie should be accepted when receiving a response from @host. + + + %TRUE if the domains match, %FALSE otherwise + + + + + a #SoupCookie + + + + a URI + + + + + + Tests if @cookie1 and @cookie2 are equal. + +Note that currently, this does not check that the cookie domains +match. This may change in the future. + + + whether the cookies are equal. + + + + + a #SoupCookie + + + + a #SoupCookie + + + + + + Frees @cookie + + + + + + + a #SoupCookie + + + + + + Gets @cookie's domain + + + @cookie's domain + + + + + a #SoupCookie + + + + + + Gets @cookie's expiration time. + + + @cookie's expiration +time, which is owned by @cookie and should not be modified or +freed. + + + + + a #SoupCookie + + + + + + Gets @cookie's HttpOnly attribute + + + @cookie's HttpOnly attribute + + + + + a #SoupCookie + + + + + + Gets @cookie's name + + + @cookie's name + + + + + a #SoupCookie + + + + + + Gets @cookie's path + + + @cookie's path + + + + + a #SoupCookie + + + + + + + + a #SoupSameSitePolicy + + + + + a #SoupCookie + + + + + + Gets @cookie's secure attribute + + + @cookie's secure attribute + + + + + a #SoupCookie + + + + + + Gets @cookie's value + + + @cookie's value + + + + + a #SoupCookie + + + + + + Sets @cookie's domain to @domain + + + + + + + a #SoupCookie + + + + the new domain + + + + + + Sets @cookie's expiration time to @expires. If @expires is %NULL, +@cookie will be a session cookie and will expire at the end of the +client's session. + +(This sets the same property as soup_cookie_set_max_age().) + + + + + + + a #SoupCookie + + + + the new expiration time, or %NULL + + + + + + Sets @cookie's HttpOnly attribute to @http_only. If %TRUE, @cookie +will be marked as "http only", meaning it should not be exposed to +web page scripts or other untrusted code. + + + + + + + a #SoupCookie + + + + the new value for the HttpOnly attribute + + + + + + Sets @cookie's max age to @max_age. If @max_age is -1, the cookie +is a session cookie, and will expire at the end of the client's +session. Otherwise, it is the number of seconds until the cookie +expires. You can use the constants %SOUP_COOKIE_MAX_AGE_ONE_HOUR, +%SOUP_COOKIE_MAX_AGE_ONE_DAY, %SOUP_COOKIE_MAX_AGE_ONE_WEEK and +%SOUP_COOKIE_MAX_AGE_ONE_YEAR (or multiples thereof) to calculate +this value. (A value of 0 indicates that the cookie should be +considered already-expired.) + +(This sets the same property as soup_cookie_set_expires().) + + + + + + + a #SoupCookie + + + + the new max age + + + + + + Sets @cookie's name to @name + + + + + + + a #SoupCookie + + + + the new name + + + + + + Sets @cookie's path to @path + + + + + + + a #SoupCookie + + + + the new path + + + + + + When used in conjunction with soup_cookie_jar_get_cookie_list_with_same_site_info() this +sets the policy of when this cookie should be exposed. + + + + + + + a #SoupCookie + + + + a #SoupSameSitePolicy + + + + + + Sets @cookie's secure attribute to @secure. If %TRUE, @cookie will +only be transmitted from the client to the server over secure +(https) connections. + + + + + + + a #SoupCookie + + + + the new value for the secure attribute + + + + + + Sets @cookie's value to @value + + + + + + + a #SoupCookie + + + + the new value + + + + + + Serializes @cookie in the format used by the Cookie header (ie, for +returning a cookie from a #SoupSession to a server). + + + the header + + + + + a #SoupCookie + + + + + + Serializes @cookie in the format used by the Set-Cookie header +(ie, for sending a cookie from a #SoupServer to a client). + + + the header + + + + + a #SoupCookie + + + + + + Parses @header and returns a #SoupCookie. (If @header contains +multiple cookies, only the first one will be parsed.) + +If @header does not have "path" or "domain" attributes, they will +be defaulted from @origin. If @origin is %NULL, path will default +to "/", but domain will be left as %NULL. Note that this is not a +valid state for a #SoupCookie, and you will need to fill in some +appropriate string for the domain if you want to actually make use +of the cookie. + + + a new #SoupCookie, or %NULL if it could +not be parsed, or contained an illegal "domain" attribute for a +cookie originating from @origin. + + + + + a cookie string (eg, the value of a Set-Cookie header) + + + + origin of the cookie, or %NULL + + + + + + + + + + Creates a new #SoupCookieJar. The base #SoupCookieJar class does +not support persistent storage of cookies; use a subclass for that. + + + a new #SoupCookieJar + + + + + + + + + + + + + + + + + + + + + + Gets whether @jar stores cookies persistenly. + + + %TRUE if @jar storage is persistent or %FALSE otherwise. + + + + + a #SoupCookieJar + + + + + + This function exists for backward compatibility, but does not do +anything any more; cookie jars are saved automatically when they +are changed. + This is a no-op. + + + + + + + a #SoupCookieJar + + + + + + Adds @cookie to @jar, emitting the 'changed' signal if we are modifying +an existing cookie or adding a valid new cookie ('valid' means +that the cookie's expire date is not in the past). + +@cookie will be 'stolen' by the jar, so don't free it afterwards. + + + + + + + a #SoupCookieJar + + + + a #SoupCookie + + + + + + Adds @cookie to @jar, emitting the 'changed' signal if we are modifying +an existing cookie or adding a valid new cookie ('valid' means +that the cookie's expire date is not in the past). + +@first_party will be used to reject cookies coming from third party +resources in case such a security policy is set in the @jar. + +@uri will be used to reject setting or overwriting secure cookies +from insecure origins. %NULL is treated as secure. + +@cookie will be 'stolen' by the jar, so don't free it afterwards. + + + + + + + a #SoupCookieJar + + + + a #SoupCookie + + + + the URI setting the cookie + + + + the URI for the main document + + + + + + Adds @cookie to @jar, emitting the 'changed' signal if we are modifying +an existing cookie or adding a valid new cookie ('valid' means +that the cookie's expire date is not in the past). + +@first_party will be used to reject cookies coming from third party +resources in case such a security policy is set in the @jar. + +@cookie will be 'stolen' by the jar, so don't free it afterwards. + +For secure cookies to work properly you may want to use +soup_cookie_jar_add_cookie_full(). + + + + + + + a #SoupCookieJar + + + + the URI for the main document + + + + a #SoupCookie + + + + + + Constructs a #GSList with every cookie inside the @jar. +The cookies in the list are a copy of the original, so +you have to free them when you are done with them. + + + a #GSList +with all the cookies in the @jar. + + + + + + + a #SoupCookieJar + + + + + + Deletes @cookie from @jar, emitting the 'changed' signal. + + + + + + + a #SoupCookieJar + + + + a #SoupCookie + + + + + + Gets @jar's #SoupCookieJarAcceptPolicy + + + the #SoupCookieJarAcceptPolicy set in the @jar + + + + + a #SoupCookieJar + + + + + + Retrieves the list of cookies that would be sent with a request to @uri +as a #GSList of #SoupCookie objects. + +If @for_http is %TRUE, the return value will include cookies marked +"HttpOnly" (that is, cookies that the server wishes to keep hidden +from client-side scripting operations such as the JavaScript +document.cookies property). Since #SoupCookieJar sets the Cookie +header itself when making the actual HTTP request, you should +almost certainly be setting @for_http to %FALSE if you are calling +this. + + + a #GSList +with the cookies in the @jar that would be sent with a request to @uri. + + + + + + + a #SoupCookieJar + + + + a #SoupURI + + + + whether or not the return value is being passed directly +to an HTTP operation + + + + + + This is an extended version of soup_cookie_jar_get_cookie_list() that +provides more information required to use SameSite cookies. See the +[SameSite cookies spec](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00) +for more detailed information. + + + a #GSList +with the cookies in the @jar that would be sent with a request to @uri. + + + + + + + a #SoupCookieJar + + + + a #SoupURI + + + + a #SoupURI for the top level document + + + + a #SoupURI indicating the origin to get cookies for + + + + whether or not the return value is being passed directly +to an HTTP operation + + + + if the HTTP method is safe, as defined by RFC 7231, ignored when @for_http is %FALSE + + + + whether or not the HTTP request is part of +top level navigation + + + + + + Retrieves (in Cookie-header form) the list of cookies that would +be sent with a request to @uri. + +If @for_http is %TRUE, the return value will include cookies marked +"HttpOnly" (that is, cookies that the server wishes to keep hidden +from client-side scripting operations such as the JavaScript +document.cookies property). Since #SoupCookieJar sets the Cookie +header itself when making the actual HTTP request, you should +almost certainly be setting @for_http to %FALSE if you are calling +this. + + + the cookies, in string form, or %NULL if +there are no cookies for @uri. + + + + + a #SoupCookieJar + + + + a #SoupURI + + + + whether or not the return value is being passed directly +to an HTTP operation + + + + + + Gets whether @jar stores cookies persistenly. + + + %TRUE if @jar storage is persistent or %FALSE otherwise. + + + + + a #SoupCookieJar + + + + + + This function exists for backward compatibility, but does not do +anything any more; cookie jars are saved automatically when they +are changed. + This is a no-op. + + + + + + + a #SoupCookieJar + + + + + + Sets @policy as the cookie acceptance policy for @jar. + + + + + + + a #SoupCookieJar + + + + a #SoupCookieJarAcceptPolicy + + + + + + Adds @cookie to @jar, exactly as though it had appeared in a +Set-Cookie header returned from a request to @uri. + +Keep in mind that if the #SoupCookieJarAcceptPolicy set is either +%SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY or +%SOUP_COOKIE_JAR_ACCEPT_GRANDFATHERED_THIRD_PARTY you'll need to use +soup_cookie_jar_set_cookie_with_first_party(), otherwise the jar +will have no way of knowing if the cookie is being set by a third +party or not. + + + + + + + a #SoupCookieJar + + + + the URI setting the cookie + + + + the stringified cookie to set + + + + + + Adds @cookie to @jar, exactly as though it had appeared in a +Set-Cookie header returned from a request to @uri. @first_party +will be used to reject cookies coming from third party resources in +case such a security policy is set in the @jar. + + + + + + + a #SoupCookieJar + + + + the URI setting the cookie + + + + the URI for the main document + + + + the stringified cookie to set + + + + + + The policy the jar should follow to accept or reject cookies + + + + + + + + + + Emitted when @jar changes. If a cookie has been added, +@new_cookie will contain the newly-added cookie and +@old_cookie will be %NULL. If a cookie has been deleted, +@old_cookie will contain the to-be-deleted cookie and +@new_cookie will be %NULL. If a cookie has been changed, +@old_cookie will contain its old value, and @new_cookie its +new value. + + + + + + the old #SoupCookie value + + + + the new #SoupCookie value + + + + + + + The policy for accepting or rejecting cookies returned in +responses. + + accept all cookies unconditionally. + + + reject all cookies unconditionally. + + + accept all cookies set by +the main document loaded in the application using libsoup. An +example of the most common case, web browsers, would be: If +http://www.example.com is the page loaded, accept all cookies set +by example.com, but if a resource from http://www.third-party.com +is loaded from that page reject any cookie that it could try to +set. For libsoup to be able to tell apart first party cookies from +the rest, the application must call soup_message_set_first_party() +on each outgoing #SoupMessage, setting the #SoupURI of the main +document. If no first party is set in a message when this policy is +in effect, cookies will be assumed to be third party by default. + + + accept all cookies +set by the main document loaded in the application using libsoup, and +from domains that have previously set at least one cookie when loaded +as the main document. An example of the most common case, web browsers, +would be: if http://www.example.com is the page loaded, accept all +cookies set by example.com, but if a resource from http://www.third-party.com +is loaded from that page, reject any cookie that it could try to +set unless it already has a cookie in the cookie jar. For libsoup to +be able to tell apart first party cookies from the rest, the +application must call soup_message_set_first_party() on each outgoing +#SoupMessage, setting the #SoupURI of the main document. If no first +party is set in a message when this policy is in effect, cookies will +be assumed to be third party by default. Since 2.72. + + + + + + + + + + + + + + + + a #SoupCookieJar + + + + + + + + + + %TRUE if @jar storage is persistent or %FALSE otherwise. + + + + + a #SoupCookieJar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a #SoupCookieJarDB. + +@filename will be read in at startup to create an initial set of +cookies. If @read_only is %FALSE, then the non-session cookies will +be written to @filename when the 'changed' signal is emitted from +the jar. (If @read_only is %TRUE, then the cookie jar will only be +used for this session, and changes made to it will be lost when the +jar is destroyed.) + + + the new #SoupCookieJar + + + + + the filename to read to/write from, or %NULL + + + + %TRUE if @filename is read-only + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a #SoupCookieJarText. + +@filename will be read in at startup to create an initial set of +cookies. If @read_only is %FALSE, then the non-session cookies will +be written to @filename when the 'changed' signal is emitted from +the jar. (If @read_only is %TRUE, then the cookie jar will only be +used for this session, and changes made to it will be lost when the +jar is destroyed.) + + + the new #SoupCookieJar + + + + + the filename to read to/write from + + + + %TRUE if @filename is read-only + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A date and time. The date is assumed to be in the (proleptic) +Gregorian calendar. The time is in UTC if @utc is %TRUE. Otherwise, +the time is a local time, and @offset gives the offset from UTC in +minutes (such that adding @offset to the time would give the +correct UTC time). If @utc is %FALSE and @offset is 0, then the +%SoupDate represents a "floating" time with no associated timezone +information. + + + the year, 1 to 9999 + + + + the month, 1 to 12 + + + + day of the month, 1 to 31 + + + + hour of the day, 0 to 23 + + + + minute, 0 to 59 + + + + second, 0 to 59 (or up to 61 in the case of leap seconds) + + + + %TRUE if the date is in UTC + + + + offset from UTC + + + + Creates a #SoupDate representing the indicated time, UTC. + + + a new #SoupDate + + + + + the year (1-9999) + + + + the month (1-12) + + + + the day of the month (1-31, as appropriate for @month) + + + + the hour (0-23) + + + + the minute (0-59) + + + + the second (0-59, or up to 61 for leap seconds) + + + + + + Creates a #SoupDate representing a time @offset_seconds after the +current time (or before it, if @offset_seconds is negative). If +offset_seconds is 0, returns the current time. + +If @offset_seconds would indicate a time not expressible as a +<type>time_t</type>, the return value will be clamped into range. + + + a new #SoupDate + + + + + offset from current time + + + + + + Parses @date_string and tries to extract a date from it. This +recognizes all of the "HTTP-date" formats from RFC 2616, all ISO +8601 formats containing both a time and a date, RFC 2822 dates, +and reasonable approximations thereof. (Eg, it is lenient about +whitespace, leading "0"s, etc.) + + + a new #SoupDate, or %NULL if @date_string +could not be parsed. + + + + + the date in some plausible format + + + + + + Creates a #SoupDate corresponding to @when + + + a new #SoupDate + + + + + a <type>time_t</type> + + + + + + Copies @date. + + + + + + + a #SoupDate + + + + + + Frees @date. + + + + + + + a #SoupDate + + + + + + Gets @date's day. + + + @date's day + + + + + a #SoupDate + + + + + + Gets @date's hour. + + + @date's hour + + + + + a #SoupDate + + + + + + Gets @date's minute. + + + @date's minute + + + + + a #SoupDate + + + + + + Gets @date's month. + + + @date's month + + + + + a #SoupDate + + + + + + Gets @date's offset from UTC. + + + @date's offset from UTC. If soup_date_get_utc() +returns %FALSE but soup_date_get_offset() returns 0, that means the +date is a "floating" time with no associated offset information. + + + + + a #SoupDate + + + + + + Gets @date's second. + + + @date's second + + + + + a #SoupDate + + + + + + Gets @date's UTC flag + + + %TRUE if @date is UTC. + + + + + a #SoupDate + + + + + + Gets @date's year. + + + @date's year + + + + + a #SoupDate + + + + + + Determines if @date is in the past. + + + %TRUE if @date is in the past + + + + + a #SoupDate + + + + + + Converts @date to a string in the format described by @format. + + + @date as a string + + + + + a #SoupDate + + + + the format to generate the date in + + + + + + Converts @date to a <type>time_t</type>, assumming it to be in +UTC. + +If @date is not representable as a <type>time_t</type>, it will be +clamped into range. (In particular, some HTTP cookies have +expiration dates after "Y2.038k" (2038-01-19T03:14:07Z).) + + + @date as a <type>time_t</type> + + + + + a #SoupDate + + + + + + Converts @date to a #GTimeVal. + Do not use #GTimeVal, as it's not Y2038-safe. + + + + + + + a #SoupDate + + + + a #GTimeVal structure in which to store the converted time. + + + + + + + Date formats that soup_date_to_string() can use. + +@SOUP_DATE_HTTP and @SOUP_DATE_COOKIE always coerce the time to +UTC. @SOUP_DATE_ISO8601_XMLRPC uses the time as given, ignoring the +offset completely. @SOUP_DATE_RFC2822 and the other ISO 8601 +variants use the local time, appending the offset information if +available. + +This enum may be extended with more values in future releases. + + RFC 1123 format, used by the HTTP "Date" header. Eg +"Sun, 06 Nov 1994 08:49:37 GMT" + + + The format for the "Expires" timestamp in the +Netscape cookie specification. Eg, "Sun, 06-Nov-1994 08:49:37 GMT". + + + RFC 2822 format, eg "Sun, 6 Nov 1994 09:49:37 -0100" + + + ISO 8601 date/time with no optional +punctuation. Eg, "19941106T094937-0100". + + + ISO 8601 date/time with all optional +punctuation. Eg, "1994-11-06T09:49:37-01:00". + + + An alias for @SOUP_DATE_ISO8601_FULL. + + + ISO 8601 date/time as used by XML-RPC. +Eg, "19941106T09:49:37". + + + + How a message body is encoded for transport + + unknown / error + + + no body is present (which is not the same as a +0-length body, and only occurs in certain places) + + + Content-Length encoding + + + Response body ends when the connection is closed + + + chunked encoding (currently only supported +for response) + + + multipart/byteranges (Reserved for future +use: NOT CURRENTLY IMPLEMENTED) + + + + Represents the parsed value of the "Expect" header. + + any unrecognized expectation + + + "100-continue" + + + + A macro containing the value +<literal>"multipart/form-data"</literal>; the MIME type used for +posting form data that contains files to be uploaded. + + + + + A macro containing the value +<literal>"application/x-www-form-urlencoded"</literal>; the default +MIME type for POSTing HTML form data. + + + + + + + + Creates a new #SoupHSTSEnforcer. The base #SoupHSTSEnforcer class +does not support persistent storage of HSTS policies, see +#SoupHSTSEnforcerDB for that. + + + a new #SoupHSTSEnforcer + + + + + + + + + + + + + + + + + + + + + + Gets whether @hsts_enforcer has a currently valid policy for @domain. + + + %TRUE if access to @domain should happen over HTTPS, false +otherwise. + + + + + a #SoupHSTSEnforcer + + + + a domain. + + + + + + + + + + + + + + + + + + + + Gets whether @hsts_enforcer stores policies persistenly. + + + %TRUE if @hsts_enforcer storage is persistent or %FALSE otherwise. + + + + + a #SoupHSTSEnforcer + + + + + + Gets a list of domains for which there are policies in @enforcer. + + + a newly allocated +list of domains. Use g_list_free_full() and g_free() to free the +list. + + + + + + + a #SoupHSTSEnforcer + + + + whether to include session policies + + + + + + Gets a list with the policies in @enforcer. + + + a newly +allocated list of policies. Use g_list_free_full() and +soup_hsts_policy_free() to free the list. + + + + + + + a #SoupHSTSEnforcer + + + + whether to include session policies + + + + + + Gets whether @hsts_enforcer has a currently valid policy for @domain. + + + %TRUE if access to @domain should happen over HTTPS, false +otherwise. + + + + + a #SoupHSTSEnforcer + + + + a domain. + + + + + + Gets whether @hsts_enforcer stores policies persistenly. + + + %TRUE if @hsts_enforcer storage is persistent or %FALSE otherwise. + + + + + a #SoupHSTSEnforcer + + + + + + Sets @policy to @hsts_enforcer. If @policy is expired, any +existing HSTS policy for its host will be removed instead. If a +policy existed for this host, it will be replaced. Otherwise, the +new policy will be inserted. If the policy is a session policy, that +is, one created with soup_hsts_policy_new_session_policy(), the policy +will not expire and will be enforced during the lifetime of +@hsts_enforcer's #SoupSession. + + + + + + + a #SoupHSTSEnforcer + + + + the policy of the HSTS host + + + + + + Sets a session policy for @domain. A session policy is a policy +that is permanent to the lifetime of @hsts_enforcer's #SoupSession +and doesn't expire. + + + + + + + a #SoupHSTSEnforcer + + + + policy domain or hostname + + + + %TRUE if the policy applies on sub domains + + + + + + + + + + + + Emitted when @hsts_enforcer changes. If a policy has been added, +@new_policy will contain the newly-added policy and +@old_policy will be %NULL. If a policy has been deleted, +@old_policy will contain the to-be-deleted policy and +@new_policy will be %NULL. If a policy has been changed, +@old_policy will contain its old value, and @new_policy its +new value. + +Note that you shouldn't modify the policies from a callback to +this signal. + + + + + + the old #SoupHSTSPolicy value + + + + the new #SoupHSTSPolicy value + + + + + + Emitted when @hsts_enforcer has upgraded the protocol +for @message to HTTPS as a result of matching its domain with +a HSTS policy. + + + + + + the message for which HSTS is being enforced + + + + + + + + + The parent class. + + + + + + + %TRUE if @hsts_enforcer storage is persistent or %FALSE otherwise. + + + + + a #SoupHSTSEnforcer + + + + + + + + + + %TRUE if access to @domain should happen over HTTPS, false +otherwise. + + + + + a #SoupHSTSEnforcer + + + + a domain. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a #SoupHSTSEnforcerDB. + +@filename will be read in during the initialization of a +#SoupHSTSEnforcerDB, in order to create an initial set of HSTS +policies. If the file doesn't exist, a new database will be created +and initialized. Changes to the policies during the lifetime of a +#SoupHSTSEnforcerDB will be written to @filename when +#SoupHSTSEnforcer::changed is emitted. + + + the new #SoupHSTSEnforcer + + + + + the filename of the database to read/write from. + + + + + + The filename of the SQLite database where HSTS policies are stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An HTTP Strict Transport Security policy. + +@domain represents the host that this policy applies to. The domain +must be IDNA-canonicalized. soup_hsts_policy_new() and related methods +will do this for you. + +@max_age contains the 'max-age' value from the Strict Transport +Security header and indicates the time to live of this policy, +in seconds. + +@expires will be non-%NULL if the policy has been set by the host and +hence has an expiry time. If @expires is %NULL, it indicates that the +policy is a permanent session policy set by the user agent. + +If @include_subdomains is %TRUE, the Strict Transport Security policy +must also be enforced on subdomains of @domain. + + + The domain or hostname that the policy applies to + + + + The maximum age, in seconds, that the policy is valid + + + + the policy expiration time, or %NULL for a permanent session policy + + + + %TRUE if the policy applies on subdomains + + + + Creates a new #SoupHSTSPolicy with the given attributes. + +@domain is a domain on which the strict transport security policy +represented by this object must be enforced. + +@max_age is used to set the "expires" attribute on the policy; pass +SOUP_HSTS_POLICY_MAX_AGE_PAST for an already-expired policy, or a +lifetime in seconds. + +If @include_subdomains is %TRUE, the strict transport security policy +must also be enforced on all subdomains of @domain. + + + a new #SoupHSTSPolicy. + + + + + policy domain or hostname + + + + max age of the policy + + + + %TRUE if the policy applies on subdomains + + + + + + Parses @msg's first "Strict-Transport-Security" response header and +returns a #SoupHSTSPolicy. + + + a new #SoupHSTSPolicy, or %NULL if no valid +"Strict-Transport-Security" response header was found. + + + + + a #SoupMessage + + + + + + Full version of #soup_hsts_policy_new(), to use with an existing +expiration date. See #soup_hsts_policy_new() for details. + + + a new #SoupHSTSPolicy. + + + + + policy domain or hostname + + + + max age of the policy + + + + the date of expiration of the policy or %NULL for a permanent policy + + + + %TRUE if the policy applies on subdomains + + + + + + Creates a new session #SoupHSTSPolicy with the given attributes. +A session policy is a policy that is valid during the lifetime of +the #SoupHSTSEnforcer it is added to. Contrary to regular policies, +it has no expiration date and is not stored in persistent +enforcers. These policies are useful for user-agent to load their +own or user-defined rules. + +@domain is a domain on which the strict transport security policy +represented by this object must be enforced. + +If @include_subdomains is %TRUE, the strict transport security policy +must also be enforced on all subdomains of @domain. + + + a new #SoupHSTSPolicy. + + + + + policy domain or hostname + + + + %TRUE if the policy applies on sub domains + + + + + + Copies @policy. + + + a copy of @policy + + + + + a #SoupHSTSPolicy + + + + + + Tests if @policy1 and @policy2 are equal. + + + whether the policies are equal. + + + + + a #SoupHSTSPolicy + + + + a #SoupHSTSPolicy + + + + + + Frees @policy. + + + + + + + a #SoupHSTSPolicy + + + + + + Gets @policy's domain. + + + @policy's domain. + + + + + a #SoupHSTSPolicy + + + + + + Gets whether @policy include its subdomains. + + + %TRUE if @policy includes subdomains, %FALSE otherwise. + + + + + a #SoupHSTSPolicy + + + + + + Gets whether @policy is expired. Permanent policies never +expire. + + + %TRUE if @policy is expired, %FALSE otherwise. + + + + + a #SoupHSTSPolicy + + + + + + Gets whether @policy is a non-permanent, non-expirable session policy. +see soup_hsts_policy_new_session_policy() for details. + + + %TRUE if @policy is permanent, %FALSE otherwise + + + + + a #SoupHSTSPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates the HTTP protocol version being used. + + HTTP 1.0 (RFC 1945) + + + HTTP 1.1 (RFC 2616) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Alias for the #SoupLogger:level property, qv. + + + + + Alias for the #SoupLogger:max-body-size property, qv. + + + + + + + + Creates a new #SoupLogger with the given debug level. If @level is +%SOUP_LOGGER_LOG_BODY, @max_body_size gives the maximum number of +bytes of the body that will be logged. (-1 means "no limit".) + +If you need finer control over what message parts are and aren't +logged, use soup_logger_set_request_filter() and +soup_logger_set_response_filter(). + + + a new #SoupLogger + + + + + the debug level + + + + the maximum body size to output, or -1 + + + + + + Sets @logger to watch @session and print debug information for +its messages. + +(The session will take a reference on @logger, which will be +removed when you call soup_logger_detach(), or when the session is +destroyed.) + Use soup_session_add_feature() instead. + + + + + + + a #SoupLogger + + + + a #SoupSession + + + + + + Stops @logger from watching @session. + Use soup_session_remove_feature() instead. + + + + + + + a #SoupLogger + + + + a #SoupSession + + + + + + Sets up an alternate log printing routine, if you don't want +the log to go to <literal>stdout</literal>. + + + + + + + a #SoupLogger + + + + the callback for printing logging output + + + + data to pass to the callback + + + + a #GDestroyNotify to free @printer_data + + + + + + Sets up a filter to determine the log level for a given request. +For each HTTP request @logger will invoke @request_filter to +determine how much (if any) of that request to log. (If you do not +set a request filter, @logger will just always log requests at the +level passed to soup_logger_new().) + + + + + + + a #SoupLogger + + + + the callback for request debugging + + + + data to pass to the callback + + + + a #GDestroyNotify to free @filter_data + + + + + + Sets up a filter to determine the log level for a given response. +For each HTTP response @logger will invoke @response_filter to +determine how much (if any) of that response to log. (If you do not +set a response filter, @logger will just always log responses at +the level passed to soup_logger_new().) + + + + + + + a #SoupLogger + + + + the callback for response debugging + + + + data to pass to the callback + + + + a #GDestroyNotify to free @filter_data + + + + + + The level of logging output + + + + If #SoupLogger:level is %SOUP_LOGGER_LOG_BODY, this gives +the maximum number of bytes of the body that will be logged. +(-1 means "no limit".) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The prototype for a logging filter. The filter callback will be +invoked for each request or response, and should analyze it and +return a #SoupLoggerLogLevel value indicating how much of the +message to log. Eg, it might choose between %SOUP_LOGGER_LOG_BODY +and %SOUP_LOGGER_LOG_HEADERS depending on the Content-Type. + + + a #SoupLoggerLogLevel value indicating how much of +the message to log + + + + + the #SoupLogger + + + + the message being logged + + + + the data passed to soup_logger_set_request_filter() +or soup_logger_set_response_filter() + + + + + + Describes the level of logging output to provide. + + No logging + + + Log the Request-Line or Status-Line and +the Soup-Debug pseudo-headers + + + Log the full request/response headers + + + Log the full headers and request/response +bodies. + + + + The prototype for a custom printing callback. + +@level indicates what kind of information is being printed. Eg, it +will be %SOUP_LOGGER_LOG_HEADERS if @data is header data. + +@direction is either '<', '>', or ' ', and @data is the single line +to print; the printer is expected to add a terminating newline. + +To get the effect of the default printer, you would do: + +<informalexample><programlisting> +printf ("%c %s\n", direction, data); +</programlisting></informalexample> + + + + + + + the #SoupLogger + + + + the level of the information being printed. + + + + a single-character prefix to @data + + + + data to print + + + + the data passed to soup_logger_set_printer() + + + + + + Like soup_get_major_version(), but from the headers used at +application compile time, rather than from the library linked +against at application run time. + + + + + + + + + + + + + + + + + + + Alias for the #SoupMessage:first-party property. (The +#SoupURI loaded in the application when the message was +queued.) + + + + + Alias for the #SoupMessage:flags property. (The message's +#SoupMessageFlags.) + + + + + + + + + + + + Alias for the #SoupMessage:http-version property. (The +message's #SoupHTTPVersion.) + + + + + + + + + Alias for the #SoupMessage:method property. (The message's +HTTP method.) + + + + + Sets the priority of the #SoupMessage. See +soup_message_set_priority() for further details. + + + + + Alias for the #SoupMessage:reason-phrase property. (The +message's HTTP response reason phrase.) + + + + + Alias for the #SoupMessage:request-body property. (The +message's HTTP request body.) + + + + + Alias for the #SoupMessage:request-body-data property. (The +message's HTTP request body, as a #GBytes.) + + + + + Alias for the #SoupMessage:request-headers property. (The +message's HTTP request headers.) + + + + + Alias for the #SoupMessage:response-body property. (The +message's HTTP response body.) + + + + + Alias for the #SoupMessage:response-body-data property. (The +message's HTTP response body, as a #GBytes.) + + + + + Alias for the #SoupMessage:response-headers property. (The +message's HTTP response headers.) + + + + + Alias for the #SoupMessage:server-side property. (%TRUE if +the message was created by #SoupServer.) + + + + + + + + + Alias for the #SoupMessage:status-code property. (The +message's HTTP response status code.) + + + + + Alias for the #SoupMessage:tls-certificate property. (The +TLS certificate associated with the message, if any.) + + + + + Alias for the #SoupMessage:tls-errors property. (The +verification errors on #SoupMessage:tls-certificate.) + + + + + Alias for the #SoupMessage:uri property. (The message's +#SoupURI.) + + + + + Like soup_get_micro_version(), but from the headers used at +application compile time, rather than from the library linked +against at application run time. + + + + + Like soup_get_minor_version(), but from the headers used at +application compile time, rather than from the library linked +against at application run time. + + + + + + + + + + + + + + + + + + + + + + + + + + Describes how #SoupBuffer should use the data passed in by the +caller. + +See also soup_buffer_new_with_owner(), which allows to you create a +buffer containing data which is owned by another object. + + The memory is statically allocated and +constant; libsoup can use the passed-in buffer directly and not +need to worry about it being modified or freed. + + + The caller has allocated the memory for the +#SoupBuffer's use; libsoup will assume ownership of it and free it +(with g_free()) when it is done with it. + + + The passed-in data belongs to the caller; the +#SoupBuffer will copy it into new memory, leaving the caller free +to reuse the original memory. + + + The passed-in data belongs to the caller, +but will remain valid for the lifetime of the #SoupBuffer. The +difference between this and @SOUP_MEMORY_STATIC is that if you copy +a @SOUP_MEMORY_TEMPORARY buffer, it will make a copy of the memory +as well, rather than reusing the original memory. + + + + Represents an HTTP message being sent or received. + +@status_code will normally be a #SoupStatus value, eg, +%SOUP_STATUS_OK, though of course it might actually be an unknown +status code. @reason_phrase is the actual text returned from the +server, which may or may not correspond to the "standard" +description of @status_code. At any rate, it is almost certainly +not localized, and not very descriptive even if it is in the user's +language; you should not use @reason_phrase in user-visible +messages. Rather, you should look at @status_code, and determine an +end-user-appropriate message based on that and on what you were +trying to do. + +As described in the #SoupMessageBody documentation, the +@request_body and @response_body <literal>data</literal> fields +will not necessarily be filled in at all times. When the body +fields are filled in, they will be terminated with a '\0' byte +(which is not included in the <literal>length</literal>), so you +can use them as ordinary C strings (assuming that you know that the +body doesn't have any other '\0' bytes). + +For a client-side #SoupMessage, @request_body's +<literal>data</literal> is usually filled in right before libsoup +writes the request to the network, but you should not count on +this; use soup_message_body_flatten() if you want to ensure that +<literal>data</literal> is filled in. If you are not using +#SoupRequest to read the response, then @response_body's +<literal>data</literal> will be filled in before +#SoupMessage::finished is emitted. (If you are using #SoupRequest, +then the message body is not accumulated by default, so +@response_body's <literal>data</literal> will always be %NULL.) + +For a server-side #SoupMessage, @request_body's %data will be +filled in before #SoupMessage::got_body is emitted. + +To prevent the %data field from being filled in at all (eg, if you +are handling the data from a #SoupMessage::got_chunk, and so don't +need to see it all at the end), call +soup_message_body_set_accumulate() on @response_body or +@request_body as appropriate, passing %FALSE. + + + Creates a new empty #SoupMessage, which will connect to @uri + + + the new #SoupMessage (or %NULL if @uri +could not be parsed). + + + + + the HTTP method for the created request + + + + the destination endpoint (as a string) + + + + + + Creates a new empty #SoupMessage, which will connect to @uri + + + the new #SoupMessage + + + + + the HTTP method for the created request + + + + the destination endpoint (as a #SoupURI) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a signal handler to @msg for @signal, as with +g_signal_connect(), but the @callback will only be run if @msg's +incoming messages headers (that is, the +<literal>request_headers</literal> for a client #SoupMessage, or +the <literal>response_headers</literal> for a server #SoupMessage) +contain a header named @header. + + + the handler ID from g_signal_connect() + + + + + a #SoupMessage + + + + signal to connect the handler to. + + + + HTTP response header to match against + + + + the header handler + + + + data to pass to @handler_cb + + + + + + Adds a signal handler to @msg for @signal, as with +g_signal_connect(), but the @callback will only be run if @msg has +the status @status_code. + +@signal must be a signal that will be emitted after @msg's status +is set. For a client #SoupMessage, this means it can't be a "wrote" +signal. For a server #SoupMessage, this means it can't be a "got" +signal. + + + the handler ID from g_signal_connect() + + + + + a #SoupMessage + + + + signal to connect the handler to. + + + + status code to match against + + + + the header handler + + + + data to pass to @handler_cb + + + + + + + + + + + + + + + + + + + + + + + + + + This disables the actions of #SoupSessionFeature<!-- -->s with the +given @feature_type (or a subclass of that type) on @msg, so that +@msg is processed as though the feature(s) hadn't been added to the +session. Eg, passing #SOUP_TYPE_CONTENT_SNIFFER for @feature_type +will disable Content-Type sniffing on the message. + +You must call this before queueing @msg on a session; calling it on +a message that has already been queued is undefined. In particular, +you cannot call this on a message that is being requeued after a +redirect or authentication. + + + + + + + a #SoupMessage + + + + the #GType of a #SoupSessionFeature + + + + + + + + + + + + + + + + + Gets the address @msg's URI points to. After first setting the +URI on a message, this will be unresolved, although the message's +session will resolve it before sending the message. + + + the address @msg's URI points to + + + + + a #SoupMessage + + + + + + Gets @msg's first-party #SoupURI + + + the @msg's first party #SoupURI + + + + + a #SoupMessage + + + + + + Gets the flags on @msg + + + the flags + + + + + a #SoupMessage + + + + + + Gets the HTTP version of @msg. This is the minimum of the +version from the request and the version from the response. + + + the HTTP version + + + + + a #SoupMessage + + + + + + If @msg is using https (or attempted to use https but got +%SOUP_STATUS_SSL_FAILED), this retrieves the #GTlsCertificate +associated with its connection, and the #GTlsCertificateFlags +showing what problems, if any, have been found with that +certificate. + +<note><para>This is only meaningful with messages processed by a #SoupSession and is +not useful for messages received by a #SoupServer</para></note> + + + %TRUE if @msg used/attempted https, %FALSE if not + + + + + a #SoupMessage + + + + @msg's TLS certificate + + + + the verification status of @certificate + + + + + + + + + + + + a #SoupMessage + + + + + + Retrieves the #SoupMessagePriority. If not set this value defaults +to #SOUP_MESSAGE_PRIORITY_NORMAL. + + + the priority of the message. + + + + + a #SoupMessage + + + + + + Gets @msg's site for cookies #SoupURI + + + the @msg's site for cookies #SoupURI + + + + + a #SoupMessage + + + + + + If @msg is associated with a #SoupRequest, this returns that +request. Otherwise it returns %NULL. + + + @msg's associated #SoupRequest + + + + + a #SoupMessage + + + + + + Gets @msg's URI + + + the URI @msg is targeted for. + + + + + a #SoupMessage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get whether #SoupSessionFeature<!-- -->s of the given @feature_type +(or a subclass of that type) are disabled on @msg. +See soup_message_disable_feature(). + + + %TRUE if feature is disabled, or %FALSE otherwise. + + + + + a #SoupMessage + + + + the #GType of a #SoupSessionFeature + + + + + + Determines whether or not @msg's connection can be kept alive for +further requests after processing @msg, based on the HTTP version, +Connection header, etc. + + + %TRUE or %FALSE. + + + + + a #SoupMessage + + + + + + + + + + + + + + + + + Sets an alternate chunk-allocation function to use when reading +@msg's body when using the traditional (ie, +non-#SoupRequest<!-- -->-based) API. Every time data is available +to read, libsoup will call @allocator, which should return a +#SoupBuffer. (See #SoupChunkAllocator for additional details.) +Libsoup will then read data from the network into that buffer, and +update the buffer's <literal>length</literal> to indicate how much +data it read. + +Generally, a custom chunk allocator would be used in conjunction +with soup_message_body_set_accumulate() %FALSE and +#SoupMessage::got_chunk, as part of a strategy to avoid unnecessary +copying of data. However, you cannot assume that every call to the +allocator will be followed by a call to your +#SoupMessage::got_chunk handler; if an I/O error occurs, then the +buffer will be unreffed without ever having been used. If your +buffer-allocation strategy requires special cleanup, use +soup_buffer_new_with_owner() rather than doing the cleanup from the +#SoupMessage::got_chunk handler. + +The other thing to remember when using non-accumulating message +bodies is that the buffer passed to the #SoupMessage::got_chunk +handler will be unreffed after the handler returns, just as it +would be in the non-custom-allocated case. If you want to hand the +chunk data off to some other part of your program to use later, +you'll need to ref the #SoupBuffer (or its owner, in the +soup_buffer_new_with_owner() case) to ensure that the data remains +valid. + #SoupRequest provides a much simpler API that lets you +read the response directly into your own buffers without needing to +mess with callbacks, pausing/unpausing, etc. + + + + + + + a #SoupMessage + + + + the chunk allocator callback + + + + data to pass to @allocator + + + + destroy notifier to free @user_data when @msg is +destroyed + + + + + + Sets @first_party as the main document #SoupURI for @msg. For +details of when and how this is used refer to the documentation for +#SoupCookieJarAcceptPolicy. + + + + + + + a #SoupMessage + + + + the #SoupURI for the @msg's first party + + + + + + Sets the specified flags on @msg. + + + + + + + a #SoupMessage + + + + a set of #SoupMessageFlags values + + + + + + Sets the HTTP version on @msg. The default version is +%SOUP_HTTP_1_1. Setting it to %SOUP_HTTP_1_0 will prevent certain +functionality from being used. + + + + + + + a #SoupMessage + + + + the HTTP version + + + + + + See the [same-site spec](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00) +for more information. + + + + + + + a #SoupMessage + + + + if %TRUE indicate the current request is a top-level navigation + + + + + + Sets the priority of a message. Note that this won't have any +effect unless used before the message is added to the session's +message processing queue. + +The message will be placed just before any other previously added +message with lower priority (messages with the same priority are +processed on a FIFO basis). + +Setting priorities does not currently work with #SoupSessionSync +(or with synchronous messages on a plain #SoupSession) because in +the synchronous/blocking case, priority ends up being determined +semi-randomly by thread scheduling. + + + + + + + a #SoupMessage + + + + the #SoupMessagePriority + + + + + + Sets @msg's status_code to @status_code and adds a Location header +pointing to @redirect_uri. Use this from a #SoupServer when you +want to redirect the client to another URI. + +@redirect_uri can be a relative URI, in which case it is +interpreted relative to @msg's current URI. In particular, if +@redirect_uri is just a path, it will replace the path +<emphasis>and query</emphasis> of @msg's URI. + + + + + + + a #SoupMessage + + + + a 3xx status code + + + + the URI to redirect @msg to + + + + + + Convenience function to set the request body of a #SoupMessage. If +@content_type is %NULL, the request body must be empty as well. + + + + + + + the message + + + + MIME Content-Type of the body + + + + a #SoupMemoryUse describing how to handle @req_body + + + + + a data buffer containing the body of the message request. + + + + + + the byte length of @req_body. + + + + + + Convenience function to set the response body of a #SoupMessage. If +@content_type is %NULL, the response body must be empty as well. + + + + + + + the message + + + + MIME Content-Type of the body + + + + a #SoupMemoryUse describing how to handle @resp_body + + + + + a data buffer containing the body of the message response. + + + + + + the byte length of @resp_body. + + + + + + Sets @site_for_cookies as the policy URL for same-site cookies for @msg. + +It is either the URL of the top-level document or %NULL depending on whether the registrable +domain of this document's URL matches the registrable domain of its parent's/opener's +URL. For the top-level document it is set to the document's URL. + +See the [same-site spec](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00) +for more information. + + + + + + + a #SoupMessage + + + + the #SoupURI for the @msg's site for cookies + + + + + + Sets @msg's status code to @status_code. If @status_code is a +known value, it will also set @msg's reason_phrase. + + + + + + + a #SoupMessage + + + + an HTTP status code + + + + + + Sets @msg's status code and reason phrase. + + + + + + + a #SoupMessage + + + + an HTTP status code + + + + a description of the status + + + + + + Sets @msg's URI to @uri. If @msg has already been sent and you want +to re-send it with the new URI, you need to call +soup_session_requeue_message(). + + + + + + + a #SoupMessage + + + + the new #SoupURI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The #SoupURI loaded in the application when the message was +queued. + + + + + + + + + + Set when the message is navigating between top level domains. + + + + + + + + + + + + + + + + The message's HTTP request body, as a #GBytes. + + + + + + + + + + The message's HTTP response body, as a #GBytes. + + + + + + + + + + + + + + + + The #GTlsCertificate associated with the message + + + + The verification errors on #SoupMessage:tls-certificate + + + + + + + + + + the HTTP method + + + + the HTTP status code + + + + the status phrase associated with @status_code + + + + the request body + + + + the request headers + + + + the response body + + + + the response headers + + + + This signal is emitted after #SoupMessage::got-headers, and +before the first #SoupMessage::got-chunk. If content +sniffing is disabled, or no content sniffing will be +performed, due to the sniffer deciding to trust the +Content-Type sent by the server, this signal is emitted +immediately after #SoupMessage::got-headers, and @type is +%NULL. + +If the #SoupContentSniffer feature is enabled, and the +sniffer decided to perform sniffing, the first +#SoupMessage::got-chunk emission may be delayed, so that the +sniffer has enough data to correctly sniff the content. It +notified the library user that the content has been +sniffed, and allows it to change the header contents in the +message, if desired. + +After this signal is emitted, the data that was spooled so +that sniffing could be done is delivered on the first +emission of #SoupMessage::got-chunk. + + + + + + the content type that we got from sniffing + + + + a #GHashTable with the parameters + + + + + + + + + Emitted when all HTTP processing is finished for a message. +(After #SoupMessage::got_body for client-side messages, or +after #SoupMessage::wrote_body for server-side messages.) + + + + + + Emitted after receiving the complete message body. (For a +server-side message, this means it has received the request +body. For a client-side message, this means it has received +the response body and is nearly done with the message.) + +See also soup_message_add_header_handler() and +soup_message_add_status_code_handler(), which can be used +to connect to a subset of emissions of this signal. + + + + + + Emitted after receiving a chunk of a message body. Note +that "chunk" in this context means any subpiece of the +body, not necessarily the specific HTTP 1.1 chunks sent by +the other side. + +If you cancel or requeue @msg while processing this signal, +then the current HTTP I/O will be stopped after this signal +emission finished, and @msg's connection will be closed. + + + + + + the just-read chunk + + + + + + Emitted after receiving all message headers for a message. +(For a client-side message, this is after receiving the +Status-Line and response headers; for a server-side +message, it is after receiving the Request-Line and request +headers.) + +See also soup_message_add_header_handler() and +soup_message_add_status_code_handler(), which can be used +to connect to a subset of emissions of this signal. + +If you cancel or requeue @msg while processing this signal, +then the current HTTP I/O will be stopped after this signal +emission finished, and @msg's connection will be closed. +(If you need to requeue a message--eg, after handling +authentication or redirection--it is usually better to +requeue it from a #SoupMessage::got_body handler rather +than a #SoupMessage::got_headers handler, so that the +existing HTTP connection can be reused.) + + + + + + Emitted after receiving a 1xx (Informational) response for +a (client-side) message. The response_headers will be +filled in with the headers associated with the +informational response; however, those header values will +be erased after this signal is done. + +If you cancel or requeue @msg while processing this signal, +then the current HTTP I/O will be stopped after this signal +emission finished, and @msg's connection will be closed. + + + + + + Emitted to indicate that some network-related event +related to @msg has occurred. This essentially proxies the +#GSocketClient::event signal, but only for events that +occur while @msg "owns" the connection; if @msg is sent on +an existing persistent connection, then this signal will +not be emitted. (If you want to force the message to be +sent on a new connection, set the +%SOUP_MESSAGE_NEW_CONNECTION flag on it.) + +See #GSocketClient::event for more information on what +the different values of @event correspond to, and what +@connection will be in each case. + + + + + + the network event + + + + the current state of the network connection + + + + + + Emitted when a request that was already sent once is now +being sent again (eg, because the first attempt received a +redirection response, or because we needed to use +authentication). + + + + + + Emitted just before a message is sent. + + + + + + Emitted immediately after writing the complete body for a +message. (For a client-side message, this means that +libsoup is done writing and is now waiting for the response +from the server. For a server-side message, this means that +libsoup has finished writing the response and is nearly +done with the message.) + + + + + + Emitted immediately after writing a portion of the message +body to the network. + +Unlike #SoupMessage::wrote_chunk, this is emitted after +every successful write() call, not only after finishing a +complete "chunk". + + + + + + the data written + + + + + + Emitted immediately after writing a body chunk for a message. + +Note that this signal is not parallel to +#SoupMessage::got_chunk; it is emitted only when a complete +chunk (added with soup_message_body_append() or +soup_message_body_append_buffer()) has been written. To get +more useful continuous progress information, use +#SoupMessage::wrote_body_data. + + + + + + Emitted immediately after writing the headers for a +message. (For a client-side message, this is after writing +the request headers; for a server-side message, it is after +writing the response headers.) + + + + + + Emitted immediately after writing a 1xx (Informational) +response for a (server-side) message. + + + + + + + A #SoupMessage request or response body. + +Note that while @length always reflects the full length of the +message body, @data is normally %NULL, and will only be filled in +after soup_message_body_flatten() is called. For client-side +messages, this automatically happens for the response body after it +has been fully read, unless you set the +%SOUP_MESSAGE_OVERWRITE_CHUNKS flags. Likewise, for server-side +messages, the request body is automatically filled in after being +read. + +As an added bonus, when @data is filled in, it is always terminated +with a '\0' byte (which is not reflected in @length). + + + the data + + + + length of @data + + + + Creates a new #SoupMessageBody. #SoupMessage uses this internally; you +will not normally need to call it yourself. + + + a new #SoupMessageBody. + + + + + Appends @length bytes from @data to @body according to @use. + + + + + + + a #SoupMessageBody + + + + how to use @data + + + + data to append + + + + + + length of @data + + + + + + Appends the data from @buffer to @body. (#SoupMessageBody uses +#SoupBuffers internally, so this is normally a constant-time +operation that doesn't actually require copying the data in +@buffer.) + + + + + + + a #SoupMessageBody + + + + a #SoupBuffer + + + + + + Appends @length bytes from @data to @body. + +This function is exactly equivalent to soup_message_body_append() +with %SOUP_MEMORY_TAKE as second argument; it exists mainly for +convenience and simplifying language bindings. + + + + + + + a #SoupMessageBody + + + + data to append + + + + + + length of @data + + + + + + Tags @body as being complete; Call this when using chunked encoding +after you have appended the last chunk. + + + + + + + a #SoupMessageBody + + + + + + Fills in @body's data field with a buffer containing all of the +data in @body (plus an additional '\0' byte not counted by @body's +length field). + + + a #SoupBuffer containing the same data as @body. +(You must free this buffer if you do not want it.) + + + + + a #SoupMessageBody + + + + + + Frees @body. You will not normally need to use this, as +#SoupMessage frees its associated message bodies automatically. + + + + + + + a #SoupMessageBody + + + + + + Gets the accumulate flag on @body; see +soup_message_body_set_accumulate() for details. + + + the accumulate flag for @body. + + + + + a #SoupMessageBody + + + + + + Gets a #SoupBuffer containing data from @body starting at @offset. +The size of the returned chunk is unspecified. You can iterate +through the entire body by first calling +soup_message_body_get_chunk() with an offset of 0, and then on each +successive call, increment the offset by the length of the +previously-returned chunk. + +If @offset is greater than or equal to the total length of @body, +then the return value depends on whether or not +soup_message_body_complete() has been called or not; if it has, +then soup_message_body_get_chunk() will return a 0-length chunk +(indicating the end of @body). If it has not, then +soup_message_body_get_chunk() will return %NULL (indicating that +@body may still potentially have more data, but that data is not +currently available). + + + a #SoupBuffer, or %NULL. + + + + + a #SoupMessageBody + + + + an offset + + + + + + Handles the #SoupMessageBody part of receiving a chunk of data from +the network. Normally this means appending @chunk to @body, exactly +as with soup_message_body_append_buffer(), but if you have set +@body's accumulate flag to %FALSE, then that will not happen. + +This is a low-level method which you should not normally need to +use. + + + + + + + a #SoupMessageBody + + + + a #SoupBuffer received from the network + + + + + + Sets or clears the accumulate flag on @body. (The default value is +%TRUE.) If set to %FALSE, @body's %data field will not be filled in +after the body is fully sent/received, and the chunks that make up +@body may be discarded when they are no longer needed. + +In particular, if you set this flag to %FALSE on an "incoming" +message body (that is, the #SoupMessage:response_body of a +client-side message, or #SoupMessage:request_body of a server-side +message), this will cause each chunk of the body to be discarded +after its corresponding #SoupMessage::got_chunk signal is emitted. +(This is equivalent to setting the deprecated +%SOUP_MESSAGE_OVERWRITE_CHUNKS flag on the message.) + +If you set this flag to %FALSE on the #SoupMessage:response_body of +a server-side message, it will cause each chunk of the body to be +discarded after its corresponding #SoupMessage::wrote_chunk signal +is emitted. + +If you set the flag to %FALSE on the #SoupMessage:request_body of a +client-side message, it will block the accumulation of chunks into +@body's %data field, but it will not normally cause the chunks to +be discarded after being written like in the server-side +#SoupMessage:response_body case, because the request body needs to +be kept around in case the request needs to be sent a second time +due to redirection or authentication. However, if you set the +%SOUP_MESSAGE_CAN_REBUILD flag on the message, then the chunks will +be discarded, and you will be responsible for recreating the +request body after the #SoupMessage::restarted signal is emitted. + + + + + + + a #SoupMessageBody + + + + whether or not to accumulate body chunks in @body + + + + + + Deletes all of the data in @body. + + + + + + + a #SoupMessageBody + + + + + + Handles the #SoupMessageBody part of writing a chunk of data to the +network. Normally this is a no-op, but if you have set @body's +accumulate flag to %FALSE, then this will cause @chunk to be +discarded to free up memory. + +This is a low-level method which you should not need to use, and +there are further restrictions on its proper use which are not +documented here. + + + + + + + a #SoupMessageBody + + + + a #SoupBuffer returned from soup_message_body_get_chunk() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Various flags that can be set on a #SoupMessage to alter its +behavior. + + The session should not follow redirect + (3xx) responses received by this message. + + + The caller will rebuild the request + body if the message is restarted; see + soup_message_body_set_accumulate() for more details. + + + Deprecated: equivalent to calling + soup_message_body_set_accumulate() on the incoming message body + (ie, #SoupMessage:response_body for a client-side request), + passing %FALSE. + + + Set by #SoupContentDecoder to + indicate that it has removed the Content-Encoding on a message (and + so headers such as Content-Length may no longer accurately describe + the body). + + + if set after an https response + has been received, indicates that the server's SSL certificate is + trusted according to the session's CA. + + + Requests that the message should be + sent on a newly-created connection, not reusing an existing + persistent connection. Note that messages with non-idempotent + #SoupMessage:method<!-- -->s behave this way by default, unless + #SOUP_MESSAGE_IDEMPOTENT is set. + + + The message is considered idempotent, + regardless its #SoupMessage:method, and allows reuse of existing + idle connections, instead of always requiring a new one, unless + #SOUP_MESSAGE_NEW_CONNECTION is set. + + + Request that a new connection is + created for the message if there aren't idle connections available + and it's not possible to create new connections due to any of the + connection limits has been reached. If a dedicated connection is + eventually created for this message, it will be dropped when the + message finishes. Since 2.50 + + + The #SoupAuthManager should not use + the credentials cache for this message, neither to use cached credentials + to automatically authenticate this message nor to cache the credentials + after the message is successfully authenticated. This applies to both server + and proxy authentication. Note that #SoupSession::authenticate signal will + be emitted, if you want to disable authentication for a message use + soup_message_disable_feature() passing #SOUP_TYPE_AUTH_MANAGER instead. Since 2.58 + + + + The HTTP message headers associated with a request or response. + + + Creates a #SoupMessageHeaders. (#SoupMessage does this +automatically for its own headers. You would only need to use this +method if you are manually parsing or generating message headers.) + + + a new #SoupMessageHeaders + + + + + the type of headers + + + + + + Appends a new header with name @name and value @value to @hdrs. (If +there is an existing header with name @name, then this creates a +second one, which is only allowed for list-valued headers; see also +soup_message_headers_replace().) + +The caller is expected to make sure that @name and @value are +syntactically correct. + + + + + + + a #SoupMessageHeaders + + + + the header name to add + + + + the new value of @name + + + + + + Removes all the headers listed in the Connection header. + + + + + + + a #SoupMessageHeaders + + + + + + Clears @hdrs. + + + + + + + a #SoupMessageHeaders + + + + + + Calls @func once for each header value in @hdrs. + +Beware that unlike soup_message_headers_get(), this processes the +headers in exactly the way they were added, rather than +concatenating multiple same-named headers into a single value. +(This is intentional; it ensures that if you call +soup_message_headers_append() multiple times with the same name, +then the I/O code will output multiple copies of the header when +sending the message to the remote implementation, which may be +required for interoperability in some cases.) + +You may not modify the headers from @func. + + + + + + + a #SoupMessageHeaders + + + + callback function to run for each header + + + + data to pass to @func + + + + + + Frees @hdrs. + + + + + + + a #SoupMessageHeaders + + + + + + Frees the array of ranges returned from soup_message_headers_get_ranges(). + + + + + + + a #SoupMessageHeaders + + + + an array of #SoupRange + + + + + + Gets the value of header @name in @hdrs. + +This method was supposed to work correctly for both single-valued +and list-valued headers, but because some HTTP clients/servers +mistakenly send multiple copies of headers that are supposed to be +single-valued, it sometimes returns incorrect results. To fix this, +the methods soup_message_headers_get_one() and +soup_message_headers_get_list() were introduced, so callers can +explicitly state which behavior they are expecting. + Use soup_message_headers_get_one() or +soup_message_headers_get_list() instead. + + + as with soup_message_headers_get_list(). + + + + + a #SoupMessageHeaders + + + + header name + + + + + + Looks up the "Content-Disposition" header in @hdrs, parses it, and +returns its value in *@disposition and *@params. @params can be +%NULL if you are only interested in the disposition-type. + +In HTTP, the most common use of this header is to set a +disposition-type of "attachment", to suggest to the browser that a +response should be saved to disk rather than displayed in the +browser. If @params contains a "filename" parameter, this is a +suggestion of a filename to use. (If the parameter value in the +header contains an absolute or relative path, libsoup will truncate +it down to just the final path component, so you do not need to +test this yourself.) + +Content-Disposition is also used in "multipart/form-data", however +this is handled automatically by #SoupMultipart and the associated +form methods. + + + %TRUE if @hdrs contains a "Content-Disposition" +header, %FALSE if not (in which case *@disposition and *@params +will be unchanged). + + + + + a #SoupMessageHeaders + + + + return location for the +disposition-type, or %NULL + + + + return +location for the Content-Disposition parameters, or %NULL + + + + + + + + + Gets the message body length that @hdrs declare. This will only +be non-0 if soup_message_headers_get_encoding() returns +%SOUP_ENCODING_CONTENT_LENGTH. + + + the message body length declared by @hdrs. + + + + + a #SoupMessageHeaders + + + + + + Parses @hdrs's Content-Range header and returns it in @start, +@end, and @total_length. If the total length field in the header +was specified as "*", then @total_length will be set to -1. + + + %TRUE if @hdrs contained a "Content-Range" header +containing a byte range which could be parsed, %FALSE otherwise. + + + + + a #SoupMessageHeaders + + + + return value for the start of the range + + + + return value for the end of the range + + + + return value for the total length of the +resource, or %NULL if you don't care. + + + + + + Looks up the "Content-Type" header in @hdrs, parses it, and returns +its value in *@content_type and *@params. @params can be %NULL if you +are only interested in the content type itself. + + + a string with the value of the +"Content-Type" header or %NULL if @hdrs does not contain that +header or it cannot be parsed (in which case *@params will be +unchanged). + + + + + a #SoupMessageHeaders + + + + + return location for the Content-Type parameters (eg, "charset"), or + %NULL + + + + + + + + + Gets the message body encoding that @hdrs declare. This may not +always correspond to the encoding used on the wire; eg, a HEAD +response may declare a Content-Length or Transfer-Encoding, but +it will never actually include a body. + + + the encoding declared by @hdrs. + + + + + a #SoupMessageHeaders + + + + + + Gets the expectations declared by @hdrs's "Expect" header. +Currently this will either be %SOUP_EXPECTATION_CONTINUE or +%SOUP_EXPECTATION_UNRECOGNIZED. + + + the contents of @hdrs's "Expect" header + + + + + a #SoupMessageHeaders + + + + + + Gets the type of headers. + + + the header's type. + + + + + a #SoupMessageHeaders + + + + + + Gets the value of header @name in @hdrs. Use this for headers whose +values are comma-delimited lists, and which are therefore allowed +to appear multiple times in the headers. For non-list-valued +headers, use soup_message_headers_get_one(). + +If @name appears multiple times in @hdrs, +soup_message_headers_get_list() will concatenate all of the values +together, separated by commas. This is sometimes awkward to parse +(eg, WWW-Authenticate, Set-Cookie), but you have to be able to deal +with it anyway, because the HTTP spec explicitly states that this +transformation is allowed, and so an upstream proxy could do the +same thing. + + + the header's value or %NULL if not found. + + + + + a #SoupMessageHeaders + + + + header name + + + + + + Gets the value of header @name in @hdrs. Use this for headers whose +values are <emphasis>not</emphasis> comma-delimited lists, and +which therefore can only appear at most once in the headers. For +list-valued headers, use soup_message_headers_get_list(). + +If @hdrs does erroneously contain multiple copies of the header, it +is not defined which one will be returned. (Ideally, it will return +whichever one makes libsoup most compatible with other HTTP +implementations.) + + + the header's value or %NULL if not found. + + + + + a #SoupMessageHeaders + + + + header name + + + + + + Parses @hdrs's Range header and returns an array of the requested +byte ranges. The returned array must be freed with +soup_message_headers_free_ranges(). + +If @total_length is non-0, its value will be used to adjust the +returned ranges to have explicit start and end values, and the +returned ranges will be sorted and non-overlapping. If +@total_length is 0, then some ranges may have an end value of -1, +as described under #SoupRange, and some of the ranges may be +redundant. + +Beware that even if given a @total_length, this function does not +check that the ranges are satisfiable. + +<note><para> +#SoupServer has built-in handling for range requests. If your +server handler returns a %SOUP_STATUS_OK response containing the +complete response body (rather than pausing the message and +returning some of the response body later), and there is a Range +header in the request, then libsoup will automatically convert the +response to a %SOUP_STATUS_PARTIAL_CONTENT response containing only +the range(s) requested by the client. + +The only time you need to process the Range header yourself is if +either you need to stream the response body rather than returning +it all at once, or you do not already have the complete response +body available, and only want to generate the parts that were +actually requested by the client. +</para></note> + + + %TRUE if @hdrs contained a syntactically-valid +"Range" header, %FALSE otherwise (in which case @range and @length +will not be set). + + + + + a #SoupMessageHeaders + + + + the total_length of the response body + + + + return location for an array +of #SoupRange + + + + + + the length of the returned array + + + + + + Checks whether the list-valued header @name is present in @hdrs, +and contains a case-insensitive match for @token. + +(If @name is present in @hdrs, then this is equivalent to calling +soup_header_contains() on its value.) + + + %TRUE if the header is present and contains @token, + %FALSE otherwise. + + + + + a #SoupMessageHeaders + + + + header name + + + + token to look for + + + + + + Checks whether the header @name is present in @hdrs and is +(case-insensitively) equal to @value. + + + %TRUE if the header is present and its value is + @value, %FALSE otherwise. + + + + + a #SoupMessageHeaders + + + + header name + + + + expected value + + + + + + Removes @name from @hdrs. If there are multiple values for @name, +they are all removed. + + + + + + + a #SoupMessageHeaders + + + + the header name to remove + + + + + + Replaces the value of the header @name in @hdrs with @value. (See +also soup_message_headers_append().) + +The caller is expected to make sure that @name and @value are +syntactically correct. + + + + + + + a #SoupMessageHeaders + + + + the header name to replace + + + + the new value of @name + + + + + + Sets the "Content-Disposition" header in @hdrs to @disposition, +optionally with additional parameters specified in @params. + +See soup_message_headers_get_content_disposition() for a discussion +of how Content-Disposition is used in HTTP. + + + + + + + a #SoupMessageHeaders + + + + the disposition-type + + + + additional +parameters, or %NULL + + + + + + + + + Sets the message body length that @hdrs will declare, and sets +@hdrs's encoding to %SOUP_ENCODING_CONTENT_LENGTH. + +You do not normally need to call this; if @hdrs is set to use +Content-Length encoding, libsoup will automatically set its +Content-Length header for you immediately before sending the +headers. One situation in which this method is useful is when +generating the response to a HEAD request; Calling +soup_message_headers_set_content_length() allows you to put the +correct content length into the response without needing to waste +memory by filling in a response body which won't actually be sent. + + + + + + + a #SoupMessageHeaders + + + + the message body length + + + + + + Sets @hdrs's Content-Range header according to the given values. +(Note that @total_length is the total length of the entire resource +that this is a range of, not simply @end - @start + 1.) + +<note><para> +#SoupServer has built-in handling for range requests, and you do +not normally need to call this function youself. See +soup_message_headers_get_ranges() for more details. +</para></note> + + + + + + + a #SoupMessageHeaders + + + + the start of the range + + + + the end of the range + + + + the total length of the resource, or -1 if unknown + + + + + + Sets the "Content-Type" header in @hdrs to @content_type, +optionally with additional parameters specified in @params. + + + + + + + a #SoupMessageHeaders + + + + the MIME type + + + + additional +parameters, or %NULL + + + + + + + + + Sets the message body encoding that @hdrs will declare. In particular, +you should use this if you are going to send a request or response in +chunked encoding. + + + + + + + a #SoupMessageHeaders + + + + a #SoupEncoding + + + + + + Sets @hdrs's "Expect" header according to @expectations. + +Currently %SOUP_EXPECTATION_CONTINUE is the only known expectation +value. You should set this value on a request if you are sending a +large message body (eg, via POST or PUT), and want to give the +server a chance to reject the request after seeing just the headers +(eg, because it will require authentication before allowing you to +post, or because you're POSTing to a URL that doesn't exist). This +saves you from having to transmit the large request body when the +server is just going to ignore it anyway. + + + + + + + a #SoupMessageHeaders + + + + the expectations to set + + + + + + Sets @hdrs's Range header to request the indicated range. +@start and @end are interpreted as in a #SoupRange. + +If you need to request multiple ranges, use +soup_message_headers_set_ranges(). + + + + + + + a #SoupMessageHeaders + + + + the start of the range to request + + + + the end of the range to request + + + + + + Sets @hdrs's Range header to request the indicated ranges. (If you +only want to request a single range, you can use +soup_message_headers_set_range().) + + + + + + + a #SoupMessageHeaders + + + + an array of #SoupRange + + + + the length of @range + + + + + + + The callback passed to soup_message_headers_foreach(). + + + + + + + the header name + + + + the header value + + + + the data passed to soup_message_headers_foreach() + + + + + + An opaque type used to iterate over a %SoupMessageHeaders +structure. + +After intializing the iterator with +soup_message_headers_iter_init(), call +soup_message_headers_iter_next() to fetch data from it. + +You may not modify the headers while iterating over them. + + + + + + + + Yields the next name/value pair in the %SoupMessageHeaders being +iterated by @iter. If @iter has already yielded the last header, +then soup_message_headers_iter_next() will return %FALSE and @name +and @value will be unchanged. + + + %TRUE if another name and value were returned, %FALSE +if the end of the headers has been reached. + + + + + a %SoupMessageHeadersIter + + + + pointer to a variable to return +the header name in + + + + pointer to a variable to return +the header value in + + + + + + Initializes @iter for iterating @hdrs. + + + + + + + a pointer to a %SoupMessageHeadersIter +structure + + + + a %SoupMessageHeaders + + + + + + + Value passed to soup_message_headers_new() to set certain default +behaviors. + + request headers + + + response headers + + + multipart body part headers + + + + Priorities that can be set on a #SoupMessage to instruct the +message queue to process it before any other message with lower +priority. + + The lowest priority, the messages + with this priority will be the last ones to be attended. + + + Use this for low priority messages, a + #SoupMessage with the default priority will be processed first. + + + The default priotity, this is the + priority assigned to the #SoupMessage by default. + + + High priority, a #SoupMessage with + this priority will be processed before the ones with the default + priority. + + + The highest priority, use this + for very urgent #SoupMessage as they will be the first ones to be + attended. + + + + + + + + + + Represents a multipart HTTP message body, parsed according to the +syntax of RFC 2046. Of particular interest to HTTP are +<literal>multipart/byte-ranges</literal> and +<literal>multipart/form-data</literal>. + +Although the headers of a #SoupMultipart body part will contain the +full headers from that body part, libsoup does not interpret them +according to MIME rules. For example, each body part is assumed to +have "binary" Content-Transfer-Encoding, even if its headers +explicitly state otherwise. In other words, don't try to use +#SoupMultipart for handling real MIME multiparts. + + + Creates a new empty #SoupMultipart with a randomly-generated +boundary string. Note that @mime_type must be the full MIME type, +including "multipart/". + + + a new empty #SoupMultipart of the given @mime_type + + + + + the MIME type of the multipart to create. + + + + + + Parses @headers and @body to form a new #SoupMultipart + + + a new #SoupMultipart (or %NULL if the +message couldn't be parsed or wasn't multipart). + + + + + the headers of the HTTP message to parse + + + + the body of the HTTP message to parse + + + + + + Adds a new MIME part containing @body to @multipart, using +"Content-Disposition: form-data", as per the HTML forms +specification. See soup_form_request_new_from_multipart() for more +details. + + + + + + + a multipart (presumably of type "multipart/form-data") + + + + the name of the control associated with this file + + + + the name of the file, or %NULL if not known + + + + the MIME type of the file, or %NULL if not known + + + + the file data + + + + + + Adds a new MIME part containing @data to @multipart, using +"Content-Disposition: form-data", as per the HTML forms +specification. See soup_form_request_new_from_multipart() for more +details. + + + + + + + a multipart (presumably of type "multipart/form-data") + + + + the name of the control associated with @data + + + + the body data + + + + + + Adds a new MIME part to @multipart with the given headers and body. +(The multipart will make its own copies of @headers and @body, so +you should free your copies if you are not using them for anything +else.) + + + + + + + a #SoupMultipart + + + + the MIME part headers + + + + the MIME part body + + + + + + Frees @multipart + + + + + + + a #SoupMultipart + + + + + + Gets the number of body parts in @multipart + + + the number of body parts in @multipart + + + + + a #SoupMultipart + + + + + + Gets the indicated body part from @multipart. + + + %TRUE on success, %FALSE if @part is out of range (in +which case @headers and @body won't be set) + + + + + a #SoupMultipart + + + + the part number to get (counting from 0) + + + + return location for the MIME part +headers + + + + return location for the MIME part +body + + + + + + Serializes @multipart to @dest_headers and @dest_body. + + + + + + + a #SoupMultipart + + + + the headers of the HTTP message to serialize @multipart to + + + + the body of the HTTP message to serialize @multipart to + + + + + + + + + + Creates a new #SoupMultipartInputStream that wraps the +#GInputStream obtained by sending the #SoupRequest. Reads should +not be done directly through this object, use the input streams +returned by soup_multipart_input_stream_next_part() or its async +counterpart instead. + + + a new #SoupMultipartInputStream + + + + + the #SoupMessage the response is related to. + + + + the #GInputStream returned by sending the request. + + + + + + Obtains the headers for the part currently being processed. Note +that the #SoupMessageHeaders that are returned are owned by the +#SoupMultipartInputStream and will be replaced when a call is made +to soup_multipart_input_stream_next_part() or its async +counterpart, so if keeping the headers is required, a copy must be +made. + +Note that if a part had no headers at all an empty #SoupMessageHeaders +will be returned. + + + a #SoupMessageHeaders +containing the headers for the part currently being processed or +%NULL if the headers failed to parse. + + + + + a #SoupMultipartInputStream. + + + + + + Obtains an input stream for the next part. When dealing with a +multipart response the input stream needs to be wrapped in a +#SoupMultipartInputStream and this function or its async +counterpart need to be called to obtain the first part for +reading. + +After calling this function, +soup_multipart_input_stream_get_headers() can be used to obtain the +headers for the first part. A read of 0 bytes indicates the end of +the part; a new call to this function should be done at that point, +to obtain the next part. + + + a new #GInputStream, or +%NULL if there are no more parts + + + + + the #SoupMultipartInputStream + + + + a #GCancellable + + + + + + Obtains a #GInputStream for the next request. See +soup_multipart_input_stream_next_part() for details on the +workflow. + + + + + + + the #SoupMultipartInputStream. + + + + the I/O priority for the request. + + + + a #GCancellable. + + + + callback to call when request is satisfied. + + + + data for @callback + + + + + + Finishes an asynchronous request for the next part. + + + a newly created +#GInputStream for reading the next part or %NULL if there are no +more parts. + + + + + a #SoupMultipartInputStream. + + + + a #GAsyncResult. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use SoupProxyURIResolver.get_proxy_uri_async instead + + + + + + + + + + + + + + + + + + + + + + + + + + + Use SoupProxyURIResolver.get_proxy_uri_sync() instead + + + + + + + + + + + + + + + + + + + + + Use SoupProxyURIResolver.get_proxy_uri_async instead + + + + + + + + + + + + + + + + + + + + + + + + + + + Use SoupProxyURIResolver.get_proxy_uri_sync() instead + + + + + + + + + + + + + + + + + + + + + + Use SoupProxyURIResolver instead + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Asynchronously determines a proxy URI to use for @msg and calls +@callback. + #SoupProxyURIResolver is deprecated in favor of +#GProxyResolver + + + + + + + the #SoupProxyURIResolver + + + + the #SoupURI you want a proxy for + + + + the #GMainContext to invoke @callback in + + + + a #GCancellable, or %NULL + + + + callback to invoke with the proxy address + + + + data for @callback + + + + + + Synchronously determines a proxy URI to use for @uri. If @uri +should be sent via proxy, *@proxy_uri will be set to the URI of the +proxy, else it will be set to %NULL. + #SoupProxyURIResolver is deprecated in favor of +#GProxyResolver + + + %SOUP_STATUS_OK if successful, or a transport-level +error. + + + + + the #SoupProxyURIResolver + + + + the #SoupURI you want a proxy for + + + + a #GCancellable, or %NULL + + + + on return, will contain the proxy URI + + + + + + Asynchronously determines a proxy URI to use for @msg and calls +@callback. + #SoupProxyURIResolver is deprecated in favor of +#GProxyResolver + + + + + + + the #SoupProxyURIResolver + + + + the #SoupURI you want a proxy for + + + + the #GMainContext to invoke @callback in + + + + a #GCancellable, or %NULL + + + + callback to invoke with the proxy address + + + + data for @callback + + + + + + Synchronously determines a proxy URI to use for @uri. If @uri +should be sent via proxy, *@proxy_uri will be set to the URI of the +proxy, else it will be set to %NULL. + #SoupProxyURIResolver is deprecated in favor of +#GProxyResolver + + + %SOUP_STATUS_OK if successful, or a transport-level +error. + + + + + the #SoupProxyURIResolver + + + + the #SoupURI you want a proxy for + + + + a #GCancellable, or %NULL + + + + on return, will contain the proxy URI + + + + + + + Callback for soup_proxy_uri_resolver_get_proxy_uri_async() + + + + + + + the #SoupProxyURIResolver + + + + a #SoupStatus + + + + the resolved proxy URI, or %NULL + + + + data passed to soup_proxy_uri_resolver_get_proxy_uri_async() + + + + + + + + + + + + + + + + + + the #SoupProxyURIResolver + + + + the #SoupURI you want a proxy for + + + + the #GMainContext to invoke @callback in + + + + a #GCancellable, or %NULL + + + + callback to invoke with the proxy address + + + + data for @callback + + + + + + + + + + %SOUP_STATUS_OK if successful, or a transport-level +error. + + + + + the #SoupProxyURIResolver + + + + the #SoupURI you want a proxy for + + + + a #GCancellable, or %NULL + + + + on return, will contain the proxy URI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Alias for the #SoupRequest:session property, qv. + + + + + Alias for the #SoupRequest:uri property, qv. + + + + + Represents a byte range as used in the Range header. + +If @end is non-negative, then @start and @end represent the bounds +of of the range, counting from 0. (Eg, the first 500 bytes would be +represented as @start = 0 and @end = 499.) + +If @end is -1 and @start is non-negative, then this represents a +range starting at @start and ending with the last byte of the +requested resource body. (Eg, all but the first 500 bytes would be +@start = 500, and @end = -1.) + +If @end is -1 and @start is negative, then it represents a "suffix +range", referring to the last -@start bytes of the resource body. +(Eg, the last 500 bytes would be @start = -500 and @end = -1.) + + + the start of the range + + + + the end of the range + + + + + A request to retrieve a particular URI. + + + + + + + + + + + + + + + + + + Gets the length of the data represented by @request. For most +request types, this will not be known until after you call +soup_request_send() or soup_request_send_finish(). + + + the length of the data represented by @request, + or -1 if not known. + + + + + a #SoupRequest + + + + + + Gets the type of the data represented by @request. For most request +types, this will not be known until after you call +soup_request_send() or soup_request_send_finish(). + +As in the HTTP Content-Type header, this may include parameters +after the MIME type. + + + the type of the data represented by + @request, or %NULL if not known. + + + + + a #SoupRequest + + + + + + Synchronously requests the URI pointed to by @request, and returns +a #GInputStream that can be used to read its contents. + +Note that you cannot use this method with #SoupRequests attached to +a #SoupSessionAsync. + + + a #GInputStream that can be used to + read from the URI pointed to by @request. + + + + + a #SoupRequest + + + + a #GCancellable or %NULL + + + + + + Begins an asynchronously request for the URI pointed to by +@request. + +Note that you cannot use this method with #SoupRequests attached to +a #SoupSessionSync. + + + + + + + a #SoupRequest + + + + a #GCancellable or %NULL + + + + a #GAsyncReadyCallback + + + + user data passed to @callback + + + + + + Gets the result of a soup_request_send_async(). + + + a #GInputStream that can be used to + read from the URI pointed to by @request. + + + + + a #SoupRequest + + + + the #GAsyncResult + + + + + + Gets the length of the data represented by @request. For most +request types, this will not be known until after you call +soup_request_send() or soup_request_send_finish(). + + + the length of the data represented by @request, + or -1 if not known. + + + + + a #SoupRequest + + + + + + Gets the type of the data represented by @request. For most request +types, this will not be known until after you call +soup_request_send() or soup_request_send_finish(). + +As in the HTTP Content-Type header, this may include parameters +after the MIME type. + + + the type of the data represented by + @request, or %NULL if not known. + + + + + a #SoupRequest + + + + + + Gets @request's #SoupSession + + + @request's #SoupSession + + + + + a #SoupRequest + + + + + + Gets @request's URI + + + @request's URI + + + + + a #SoupRequest + + + + + + Synchronously requests the URI pointed to by @request, and returns +a #GInputStream that can be used to read its contents. + +Note that you cannot use this method with #SoupRequests attached to +a #SoupSessionAsync. + + + a #GInputStream that can be used to + read from the URI pointed to by @request. + + + + + a #SoupRequest + + + + a #GCancellable or %NULL + + + + + + Begins an asynchronously request for the URI pointed to by +@request. + +Note that you cannot use this method with #SoupRequests attached to +a #SoupSessionSync. + + + + + + + a #SoupRequest + + + + a #GCancellable or %NULL + + + + a #GAsyncReadyCallback + + + + user data passed to @callback + + + + + + Gets the result of a soup_request_send_async(). + + + a #GInputStream that can be used to + read from the URI pointed to by @request. + + + + + a #SoupRequest + + + + the #GAsyncResult + + + + + + The request's #SoupSession. + + + + The request URI. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a #GInputStream that can be used to + read from the URI pointed to by @request. + + + + + a #SoupRequest + + + + a #GCancellable or %NULL + + + + + + + + + + + + + + a #SoupRequest + + + + a #GCancellable or %NULL + + + + a #GAsyncReadyCallback + + + + user data passed to @callback + + + + + + + + + + a #GInputStream that can be used to + read from the URI pointed to by @request. + + + + + a #SoupRequest + + + + the #GAsyncResult + + + + + + + + + + the length of the data represented by @request, + or -1 if not known. + + + + + a #SoupRequest + + + + + + + + + + the type of the data represented by + @request, or %NULL if not known. + + + + + a #SoupRequest + + + + + + + + + + + + + + + + + + + + + + + + + + + A #SoupRequest error. + + the URI could not be parsed + + + the URI scheme is not + supported by this #SoupSession + + + the server's response could not + be parsed + + + the server's response was in an + unsupported format + + + + + + + + + + + + Gets a #GFile corresponding to @file's URI + + + a #GFile corresponding to @file + + + + + a #SoupRequestFile + + + + + + + + + + + + + + + + + + + + + + + + + Gets a new reference to the #SoupMessage associated to this SoupRequest + + + a new reference to the #SoupMessage + + + + + a #SoupRequestHTTP object + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Alias for the #SoupServer:add-websocket-extension property, qv. + + + + + Alias for the deprecated #SoupServer:async-context +property, qv. + The new API uses the thread-default #GMainContext +rather than having an explicitly-specified one. + + + + + + + + + + + + + + + + + + + Alias for the #SoupServer:https-aliases property, qv. + + + + + Alias for the #SoupServer:http-aliases property, qv. + + + + + Alias for the #SoupServer:interface property, qv. + #SoupServers can listen on multiple interfaces +at once now. Use soup_server_listen(), etc, to listen on an +interface, and soup_server_get_uris() to see what addresses +are being listened on. + + + + + Alias for the deprecated #SoupServer:port property, qv. + #SoupServers can listen on multiple interfaces +at once now. Use soup_server_listen(), etc, to listen on a +port, and soup_server_get_uris() to see what ports are +being listened on. + + + + + Alias for the #SoupServer:raw-paths property. (If %TRUE, +percent-encoding in the Request-URI path will not be +automatically decoded.) + + + + + Alias for the #SoupServer:remove-websocket-extension property, qv. + + + + + Alias for the #SoupServer:server-header property, qv. + + + + + Alias for the #SoupServer:ssl-cert-file property, qv. + use #SoupServer:tls-certificate or +soup_server_set_ssl_certificate(). + + + + + Alias for the #SoupServer:ssl-key-file property, qv. + use #SoupServer:tls-certificate or +soup_server_set_ssl_certificate(). + + + + + Alias for the #SoupServer:tls-certificate property, qv. + + + + + + + + + + + + Alias for the #SoupSession:accept-language property, qv. + + + + + Alias for the #SoupSession:accept-language-auto property, qv. + + + + + Alias for the #SoupSession:add-feature property, qv. + + + + + Alias for the #SoupSession:add-feature-by-type property, qv. + + + + + + + + + + + + + + + + + + + Alias for the #SoupSession:async-context property, qv. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Alias for the #SoupSession:https-aliases property, qv. + + + + + Alias for the #SoupSession:http-aliases property, qv. + + + + + Alias for the #SoupSession:idle-timeout property, qv. + + + + + Alias for the #SoupSession:local-address property, qv. + + + + + Alias for the #SoupSession:max-conns property, qv. + + + + + Alias for the #SoupSession:max-conns-per-host property, qv. + + + + + Alias for the #SoupSession:proxy-resolver property, qv. + + + + + Alias for the #SoupSession:proxy-uri property, qv. + + + + + Alias for the #SoupSession:remove-feature-by-type property, +qv. + + + + + Alias for the #SoupSession:ssl-ca-file property, qv. + + + + + Alias for the #SoupSession:ssl-strict property, qv. + + + + + Alias for the #SoupSession:ssl-use-system-ca-file property, +qv. + + + + + + + + + + + + + + + + + + + + + + + + + + Alias for the #SoupSession:timeout property, qv. + + + + + Alias for the #SoupSession:tls-database property, qv. + + + + + Alias for the #SoupSession:tls-interaction property, qv. + + + + + Alias for the #SoupSession:user-agent property, qv. + + + + + Alias for the #SoupSession:use-ntlm property, qv. + + + + + Alias for the #SoupSession:use-thread-context property, qv. + + + + + + + + + + + + Alias for the #SoupSocket:async-context property. (The +socket's #GMainContext.) + + + + + + + + + + + + Alias for the #SoupSocket:non-blocking property. (Whether +or not the socket uses non-blocking I/O.) + + + + + + + + + + + + Alias for the #SoupSocket:is-server property, qv. + + + + + Alias for the #SoupSocket:local-address property. (Address +of local end of socket.) + + + + + Alias for the #SoupSocket:remote-address property. (Address +of remote end of socket.) + + + + + Alias for the #SoupSocket:ssl-creds property. +(SSL credential information.) + + + + + Alias for the #SoupSocket:ssl-fallback property. + + + + + Alias for the #SoupSocket:ssl-strict property. + + + + + Alias for the #SoupSocket:timeout property. (The timeout +in seconds for blocking socket I/O operations.) + + + + + Alias for the #SoupSocket:tls-certificate +property. Note that this property's value is only useful +if the socket is for a TLS connection, and only reliable +after some data has been transferred to or from it. + + + + + Alias for the #SoupSocket:tls-errors +property. Note that this property's value is only useful +if the socket is for a TLS connection, and only reliable +after some data has been transferred to or from it. + + + + + Alias for the #SoupSocket:trusted-certificate +property. + + + + + Alias for the #SoupSocket:use-thread-context property. (Use +g_main_context_get_thread_default()) + + + + + Tests if @status is a Client Error (4xx) response. + + + + an HTTP status code + + + + + Tests if @status is an Informational (1xx) response. + + + + an HTTP status code + + + + + Tests if @status is a Redirection (3xx) response. + + + + an HTTP status code + + + + + Tests if @status is a Server Error (5xx) response. + + + + an HTTP status code + + + + + Tests if @status is a Successful (2xx) response. + + + + an HTTP status code + + + + + Tests if @status is a libsoup transport error. + + + + a status code + + + + + + The cookie is exposed with both cross-site and same-site requests + + + The cookie is withheld on cross-site requests but exposed on cross-site navigations + + + The cookie is only exposed for same-site requests + + + + + + Creates a new #SoupServer. This is exactly equivalent to calling +g_object_new() and specifying %SOUP_TYPE_SERVER as the type. + + + a new #SoupServer. If you are using +certain legacy properties, this may also return %NULL if an error +occurs. + + + + + name of first property to set + + + + value of @optname1, followed by additional property/value pairs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a new client stream to the @server. + + + %TRUE on success, %FALSE if the stream could not be +accepted or any other error occurred (in which case @error will be +set). + + + + + a #SoupServer + + + + a #GIOStream + + + + the local #GSocketAddress associated with the @stream + + + + the remote #GSocketAddress associated with the @stream + + + + + + Adds an authentication domain to @server. Each auth domain will +have the chance to require authentication for each request that +comes in; normally auth domains will require authentication for +requests on certain paths that they have been set up to watch, or +that meet other criteria set by the caller. If an auth domain +determines that a request requires authentication (and the request +doesn't contain authentication), @server will automatically reject +the request with an appropriate status (401 Unauthorized or 407 +Proxy Authentication Required). If the request used the +"100-continue" Expectation, @server will reject it before the +request body is sent. + + + + + + + a #SoupServer + + + + a #SoupAuthDomain + + + + + + Adds an "early" handler to @server for requests under @path. Note +that "normal" and "early" handlers are matched up together, so if +you add a normal handler for "/foo" and an early handler for +"/foo/bar", then a request to "/foo/bar" (or any path below it) +will run only the early handler. (But if you add both handlers at +the same path, then both will get run.) + +For requests under @path (that have not already been assigned a +status code by a #SoupAuthDomain or a signal handler), @callback +will be invoked after receiving the request headers, but before +receiving the request body; the message's #SoupMessage:method and +#SoupMessage:request-headers fields will be filled in. + +Early handlers are generally used for processing requests with +request bodies in a streaming fashion. If you determine that the +request will contain a message body, normally you would call +soup_message_body_set_accumulate() on the message's +#SoupMessage:request-body to turn off request-body accumulation, +and connect to the message's #SoupMessage::got-chunk signal to +process each chunk as it comes in. + +To complete the message processing after the full message body has +been read, you can either also connect to #SoupMessage::got-body, +or else you can register a non-early handler for @path as well. As +long as you have not set the #SoupMessage:status-code by the time +#SoupMessage::got-body is emitted, the non-early handler will be +run as well. + + + + + + + a #SoupServer + + + + the toplevel path for the handler + + + + callback to invoke for requests under @path + + + + data for @callback + + + + destroy notifier to free @user_data + + + + + + Adds a handler to @server for requests under @path. If @path is +%NULL or "/", then this will be the default handler for all +requests that don't have a more specific handler. (Note though that +if you want to handle requests to the special "*" URI, you must +explicitly register a handler for "*"; the default handler will not +be used for that case.) + +For requests under @path (that have not already been assigned a +status code by a #SoupAuthDomain, an early #SoupServerHandler, or a +signal handler), @callback will be invoked after receiving the +request body; the message's #SoupMessage:method, +#SoupMessage:request-headers, and #SoupMessage:request-body fields +will be filled in. + +After determining what to do with the request, the callback must at +a minimum call soup_message_set_status() (or +soup_message_set_status_full()) on the message to set the response +status code. Additionally, it may set response headers and/or fill +in the response body. + +If the callback cannot fully fill in the response before returning +(eg, if it needs to wait for information from a database, or +another network server), it should call soup_server_pause_message() +to tell @server to not send the response right away. When the +response is ready, call soup_server_unpause_message() to cause it +to be sent. + +To send the response body a bit at a time using "chunked" encoding, +first call soup_message_headers_set_encoding() to set +%SOUP_ENCODING_CHUNKED on the #SoupMessage:response-headers. Then call +soup_message_body_append() (or soup_message_body_append_buffer()) +to append each chunk as it becomes ready, and +soup_server_unpause_message() to make sure it's running. (The +server will automatically pause the message if it is using chunked +encoding but no more chunks are available.) When you are done, call +soup_message_body_complete() to indicate that no more chunks are +coming. + + + + + + + a #SoupServer + + + + the toplevel path for the handler + + + + callback to invoke for requests under @path + + + + data for @callback + + + + destroy notifier to free @user_data + + + + + + Add support for a WebSocket extension of the given @extension_type. +When a WebSocket client requests an extension of @extension_type, +a new #SoupWebsocketExtension of type @extension_type will be created +to handle the request. + +You can also add support for a WebSocket extension to the server at +construct time by using the %SOUP_SERVER_ADD_WEBSOCKET_EXTENSION property. +Note that #SoupWebsocketExtensionDeflate is supported by default, use +soup_server_remove_websocket_extension() if you want to disable it. + + + + + + + a #SoupServer + + + + a #GType + + + + + + Adds a WebSocket handler to @server for requests under @path. (If +@path is %NULL or "/", then this will be the default handler for +all requests that don't have a more specific handler.) + +When a path has a WebSocket handler registered, @server will check +incoming requests for WebSocket handshakes after all other handlers +have run (unless some earlier handler has already set a status code +on the message), and update the request's status, response headers, +and response body accordingly. + +If @origin is non-%NULL, then only requests containing a matching +"Origin" header will be accepted. If @protocols is non-%NULL, then +only requests containing a compatible "Sec-WebSocket-Protocols" +header will be accepted. More complicated requirements can be +handled by adding a normal handler to @path, and having it perform +whatever checks are needed (possibly calling +soup_server_check_websocket_handshake() one or more times), and +setting a failure status code if the handshake should be rejected. + + + + + + + a #SoupServer + + + + the toplevel path for the handler + + + + the origin of the connection + + + + the protocols + supported by this handler + + + + + + callback to invoke for successful WebSocket requests under @path + + + + data for @callback + + + + destroy notifier to free @user_data + + + + + + Closes and frees @server's listening sockets. If you are using the +old #SoupServer APIs, this also includes the effect of +soup_server_quit(). + +Note that if there are currently requests in progress on @server, +that they will continue to be processed if @server's #GMainContext +is still running. + +You can call soup_server_listen(), etc, after calling this function +if you want to start listening again. + + + + + + + a #SoupServer + + + + + + Gets @server's async_context, if you are using the old API. (With +the new API, the server runs in the thread's thread-default +#GMainContext, regardless of what this method returns.) + +This does not add a ref to the context, so you will need to ref it +yourself if you want it to outlive its server. + If you are using soup_server_listen(), etc, then +the server listens on the thread-default #GMainContext, and this +property is ignored. + + + @server's #GMainContext, +which may be %NULL + + + + + a #SoupServer + + + + + + Gets @server's listening socket, if you are using the old API. + +You should treat this socket as read-only; writing to it or +modifiying it may cause @server to malfunction. + If you are using soup_server_listen(), etc, then use +soup_server_get_listeners() to get a list of all listening sockets, +but note that that function returns #GSockets, not #SoupSockets. + + + the listening socket. + + + + + a #SoupServer + + + + + + Gets @server's list of listening sockets. + +You should treat these sockets as read-only; writing to or +modifiying any of these sockets may cause @server to malfunction. + +(Beware that in contrast to the old soup_server_get_listener(), this +function returns #GSockets, not #SoupSockets.) + + + a +list of listening sockets. + + + + + + + a #SoupServer + + + + + + Gets the TCP port that @server is listening on, if you are using +the old API. + If you are using soup_server_listen(), etc, then use +soup_server_get_uris() to get a list of all listening addresses. + + + the port @server is listening on. + + + + + a #SoupServer + + + + + + Gets a list of URIs corresponding to the interfaces @server is +listening on. These will contain IP addresses, not hostnames, and +will also indicate whether the given listener is http or https. + +Note that if you used soup_server_listen_all(), the returned URIs +will use the addresses <literal>0.0.0.0</literal> and +<literal>::</literal>, rather than actually returning separate URIs +for each interface on the system. + + + a list of +#SoupURIs, which you must free when you are done with it. + + + + + + + a #SoupServer + + + + + + Checks whether @server is capable of https. + +In order for a server to run https, you must call +soup_server_set_ssl_cert_file(), or set the +#SoupServer:tls-certificate property, to provide it with a +certificate to use. + +If you are using the deprecated single-listener APIs, then a return +value of %TRUE indicates that the #SoupServer serves https +exclusively. If you are using soup_server_listen(), etc, then a +%TRUE return value merely indicates that the server is +<emphasis>able</emphasis> to do https, regardless of whether it +actually currently is or not. Use soup_server_get_uris() to see if +it currently has any https listeners. + + + %TRUE if @server is configured to serve https. + + + + + a #SoupServer + + + + + + This attempts to set up @server to listen for connections on +@address. + +If @options includes %SOUP_SERVER_LISTEN_HTTPS, and @server has +been configured for TLS, then @server will listen for https +connections on this port. Otherwise it will listen for plain http. + +You may call this method (along with the other "listen" methods) +any number of times on a server, if you want to listen on multiple +ports, or set up both http and https service. + +After calling this method, @server will begin accepting and +processing connections as soon as the appropriate #GMainContext is +run. + +Note that #SoupServer never makes use of dual IPv4/IPv6 sockets; if +@address is an IPv6 address, it will only accept IPv6 connections. +You must configure IPv4 listening separately. + + + %TRUE on success, %FALSE if @address could not be +bound or any other error occurred (in which case @error will be +set). + + + + + a #SoupServer + + + + the address of the interface to listen on + + + + listening options for this server + + + + + + This attempts to set up @server to listen for connections on all +interfaces on the system. (That is, it listens on the addresses +<literal>0.0.0.0</literal> and/or <literal>::</literal>, depending +on whether @options includes %SOUP_SERVER_LISTEN_IPV4_ONLY, +%SOUP_SERVER_LISTEN_IPV6_ONLY, or neither.) If @port is specified, +@server will listen on that port. If it is 0, @server will find an +unused port to listen on. (In that case, you can use +soup_server_get_uris() to find out what port it ended up choosing.) + +See soup_server_listen() for more details. + + + %TRUE on success, %FALSE if @port could not be bound +or any other error occurred (in which case @error will be set). + + + + + a #SoupServer + + + + the port to listen on, or 0 + + + + listening options for this server + + + + + + This attempts to set up @server to listen for connections on +@fd. + +See soup_server_listen() for more details. + +Note that @server will close @fd when you free it or call +soup_server_disconnect(). + + + %TRUE on success, %FALSE if an error occurred (in +which case @error will be set). + + + + + a #SoupServer + + + + the file descriptor of a listening socket + + + + listening options for this server + + + + + + This attempts to set up @server to listen for connections on +"localhost" (that is, <literal>127.0.0.1</literal> and/or +<literal>::1</literal>, depending on whether @options includes +%SOUP_SERVER_LISTEN_IPV4_ONLY, %SOUP_SERVER_LISTEN_IPV6_ONLY, or +neither). If @port is specified, @server will listen on that port. +If it is 0, @server will find an unused port to listen on. (In that +case, you can use soup_server_get_uris() to find out what port it +ended up choosing.) + +See soup_server_listen() for more details. + + + %TRUE on success, %FALSE if @port could not be bound +or any other error occurred (in which case @error will be set). + + + + + a #SoupServer + + + + the port to listen on, or 0 + + + + listening options for this server + + + + + + This attempts to set up @server to listen for connections on +@socket. + +See soup_server_listen() for more details. + + + %TRUE on success, %FALSE if an error occurred (in +which case @error will be set). + + + + + a #SoupServer + + + + a listening #GSocket + + + + listening options for this server + + + + + + Pauses I/O on @msg. This can be used when you need to return from +the server handler without having the full response ready yet. Use +soup_server_unpause_message() to resume I/O. + +This must only be called on #SoupMessages which were created by the +#SoupServer and are currently doing I/O, such as those passed into a +#SoupServerCallback or emitted in a #SoupServer::request-read signal. + + + + + + + a #SoupServer + + + + a #SoupMessage associated with @server. + + + + + + Stops processing for @server, if you are using the old API. Call +this to clean up after soup_server_run_async(), or to terminate a +call to soup_server_run(). + +Note that messages currently in progress will continue to be +handled, if the main loop associated with the server is resumed or +kept running. + +@server is still in a working state after this call; you can start +and stop a server as many times as you want. + When using soup_server_listen(), etc, the server will +always listen for connections, and will process them whenever the +thread-default #GMainContext is running. + + + + + + + a #SoupServer + + + + + + Removes @auth_domain from @server. + + + + + + + a #SoupServer + + + + a #SoupAuthDomain + + + + + + Removes all handlers (early and normal) registered at @path. + + + + + + + a #SoupServer + + + + the toplevel path for the handler + + + + + + Removes support for WebSocket extension of type @extension_type (or any subclass of +@extension_type) from @server. You can also remove extensions enabled by default +from the server at construct time by using the %SOUP_SERVER_REMOVE_WEBSOCKET_EXTENSION +property. + + + + + + + a #SoupServer + + + + a #GType + + + + + + Starts @server, if you are using the old API, causing it to listen +for and process incoming connections. Unlike +soup_server_run_async(), this creates a #GMainLoop and runs it, and +it will not return until someone calls soup_server_quit() to stop +the server. + When using soup_server_listen(), etc, the server will +always listen for connections, and will process them whenever the +thread-default #GMainContext is running. + + + + + + + a #SoupServer + + + + + + Starts @server, if you are using the old API, causing it to listen +for and process incoming connections. + +The server runs in @server's #GMainContext. It will not actually +perform any processing unless the appropriate main loop is running. +In the simple case where you did not set the server's +%SOUP_SERVER_ASYNC_CONTEXT property, this means the server will run +whenever the glib main loop is running. + When using soup_server_listen(), etc, the server will +always listen for connections, and will process them whenever the +thread-default #GMainContext is running. + + + + + + + a #SoupServer + + + + + + Sets @server up to do https, using the SSL/TLS certificate +specified by @ssl_cert_file and @ssl_key_file (which may point to +the same file). + +Alternatively, you can set the #SoupServer:tls-certificate property +at construction time, if you already have a #GTlsCertificate. + + + success or failure. + + + + + a #SoupServer + + + + path to a file containing a PEM-encoded SSL/TLS + certificate. + + + + path to a file containing a PEM-encoded private key. + + + + + + Resumes I/O on @msg. Use this to resume after calling +soup_server_pause_message(), or after adding a new chunk to a +chunked response. + +I/O won't actually resume until you return to the main loop. + +This must only be called on #SoupMessages which were created by the +#SoupServer and are currently doing I/O, such as those passed into a +#SoupServerCallback or emitted in a #SoupServer::request-read signal. + + + + + + + a #SoupServer + + + + a #SoupMessage associated with @server. + + + + + + Add support for #SoupWebsocketExtension of the given type. +(Shortcut for calling soup_server_add_websocket_extension().) + + + + The server's #GMainContext, if you are using the old API. +Servers created using soup_server_listen() will listen on +the #GMainContext that was the thread-default context at +the time soup_server_listen() was called. + The new API uses the thread-default #GMainContext +rather than having an explicitly-specified one. + + + + A %NULL-terminated array of URI schemes that should be +considered to be aliases for "http". Eg, if this included +<literal>"dav"</literal>, than a URI of +<literal>dav://example.com/path</literal> would be treated +identically to <literal>http://example.com/path</literal>. +In particular, this is needed in cases where a client +sends requests with absolute URIs, where those URIs do +not use "http:". + +The default value is an array containing the single element +<literal>"*"</literal>, a special value which means that +any scheme except "https" is considered to be an alias for +"http". + +See also #SoupServer:https-aliases. + + + + + + A comma-delimited list of URI schemes that should be +considered to be aliases for "https". See +#SoupServer:http-aliases for more information. + +The default value is %NULL, meaning that no URI schemes +are considered aliases for "https". + + + + + + The address of the network interface the server is +listening on, if you are using the old #SoupServer API. +(This will not be set if you use soup_server_listen(), +etc.) + #SoupServers can listen on multiple interfaces +at once now. Use soup_server_listen(), etc, to listen on an +interface, and soup_server_get_uris() to see what addresses +are being listened on. + + + + The port the server is listening on, if you are using the +old #SoupServer API. (This will not be set if you use +soup_server_listen(), etc.) + #SoupServers can listen on multiple interfaces +at once now. Use soup_server_listen(), etc, to listen on a +port, and soup_server_get_uris() to see what ports are +being listened on. + + + + + + + Remove support for #SoupWebsocketExtension of the given type. (Shortcut for +calling soup_server_remove_websocket_extension().) + + + + If non-%NULL, the value to use for the "Server" header on +#SoupMessage<!-- -->s processed by this server. + +The Server header is the server equivalent of the +User-Agent header, and provides information about the +server and its components. It contains a list of one or +more product tokens, separated by whitespace, with the most +significant product token coming first. The tokens must be +brief, ASCII, and mostly alphanumeric (although "-", "_", +and "." are also allowed), and may optionally include a "/" +followed by a version string. You may also put comments, +enclosed in parentheses, between or after the tokens. + +Some HTTP server implementations intentionally do not use +version numbers in their Server header, so that +installations running older versions of the server don't +end up advertising their vulnerability to specific security +holes. + +As with #SoupSession:user_agent, if you set a +#SoupServer:server_header property that has trailing whitespace, +#SoupServer will append its own product token (eg, +"<literal>libsoup/2.3.2</literal>") to the end of the +header for you. + + + + Path to a file containing a PEM-encoded certificate. + +If you set this property and #SoupServer:ssl-key-file at +construct time, then soup_server_new() will try to read the +files; if it cannot, it will return %NULL, with no explicit +indication of what went wrong (and logging a warning with +newer versions of glib, since returning %NULL from a +constructor is illegal). + use #SoupServer:tls-certificate or +soup_server_set_ssl_certificate(). + + + + Path to a file containing a PEM-encoded private key. See +#SoupServer:ssl-cert-file for more information about how this +is used. + use #SoupServer:tls-certificate or +soup_server_set_ssl_certificate(). + + + + A #GTlsCertificate that has a #GTlsCertificate:private-key +set. If this is set, then the server will be able to speak +https in addition to (or instead of) plain http. + +Alternatively, you can call soup_server_set_ssl_cert_file() +to have #SoupServer read in a a certificate from a file. + + + + + + + Emitted when processing has failed for a message; this +could mean either that it could not be read (if +#SoupServer::request_read has not been emitted for it yet), +or that the response could not be written back (if +#SoupServer::request_read has been emitted but +#SoupServer::request_finished has not been). + +@message is in an undefined state when this signal is +emitted; the signal exists primarily to allow the server to +free any state that it may have allocated in +#SoupServer::request_started. + + + + + + the message + + + + the client context + + + + + + Emitted when the server has finished writing a response to +a request. + + + + + + the message + + + + the client context + + + + + + Emitted when the server has successfully read a request. +@message will have all of its request-side information +filled in, and if the message was authenticated, @client +will have information about that. This signal is emitted +before any (non-early) handlers are called for the message, +and if it sets the message's #status_code, then normal +handler processing will be skipped. + + + + + + the message + + + + the client context + + + + + + Emitted when the server has started reading a new request. +@message will be completely blank; not even the +Request-Line will have been read yet. About the only thing +you can usefully do with it is connect to its signals. + +If the request is read successfully, this will eventually +be followed by a #SoupServer::request_read signal. If a +response is then sent, the request processing will end with +a #SoupServer::request_finished signal. If a network error +occurs, the processing will instead end with +#SoupServer::request_aborted. + + + + + + the new message + + + + the client context + + + + + + + A callback used to handle requests to a #SoupServer. + +@path and @query contain the likewise-named components of the +Request-URI, subject to certain assumptions. By default, +#SoupServer decodes all percent-encoding in the URI path, such that +"/foo%<!-- -->2Fbar" is treated the same as "/foo/bar". If your +server is serving resources in some non-POSIX-filesystem namespace, +you may want to distinguish those as two distinct paths. In that +case, you can set the %SOUP_SERVER_RAW_PATHS property when creating +the #SoupServer, and it will leave those characters undecoded. (You +may want to call soup_uri_normalize() to decode any percent-encoded +characters that you aren't handling specially.) + +@query contains the query component of the Request-URI parsed +according to the rules for HTML form handling. Although this is the +only commonly-used query string format in HTTP, there is nothing +that actually requires that HTTP URIs use that format; if your +server needs to use some other format, you can just ignore @query, +and call soup_message_get_uri() and parse the URI's query field +yourself. + +See soup_server_add_handler() and soup_server_add_early_handler() +for details of what handlers can/should do. + + + + + + + the #SoupServer + + + + the message being processed + + + + the path component of @msg's Request-URI + + + + the parsed query + component of @msg's Request-URI + + + + + + + additional contextual information about the client + + + + the data passed to soup_server_add_handler() or + soup_server_add_early_handler(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Options to pass to soup_server_listen(), etc. + +%SOUP_SERVER_LISTEN_IPV4_ONLY and %SOUP_SERVER_LISTEN_IPV6_ONLY +only make sense with soup_server_listen_all() and +soup_server_listen_local(), not plain soup_server_listen() (which +simply listens on whatever kind of socket you give it). And you +cannot specify both of them in a single call. + + Listen for https connections rather + than plain http. + + + Only listen on IPv4 interfaces. + + + Only listen on IPv6 interfaces. + + + + A callback used to handle WebSocket requests to a #SoupServer. The +callback will be invoked after sending the handshake response back +to the client (and is only invoked if the handshake was +successful). + +@path contains the path of the Request-URI, subject to the same +rules as #SoupServerCallback (qv). + + + + + + + the #SoupServer + + + + the newly created WebSocket connection + + + + the path component of @msg's Request-URI + + + + additional contextual information about the client + + + + the data passed to @soup_server_add_handler + + + + + + + + Creates a #SoupSession with the default options. + + + the new session. + + + + + Creates a #SoupSession with the specified options. + + + the new session. + + + + + name of first property to set + + + + value of @optname1, followed by additional property/value pairs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Causes @session to immediately finish processing @msg (regardless +of its current state) with a final status_code of @status_code. You +may call this at any time after handing @msg off to @session; if +@session has started sending the request but has not yet received +the complete response, then it will close the request's connection. +Note that with requests that have side effects (eg, +<literal>POST</literal>, <literal>PUT</literal>, +<literal>DELETE</literal>) it is possible that you might cancel the +request after the server acts on it, but before it returns a +response, leaving the remote resource in an unknown state. + +If the message is cancelled while its response body is being read, +then the response body in @msg will be left partially-filled-in. +The response headers, on the other hand, will always be either +empty or complete. + +Beware that with the deprecated #SoupSessionAsync, messages queued +with soup_session_queue_message() will have their callbacks invoked +before soup_session_cancel_message() returns. The plain +#SoupSession does not have this behavior; cancelling an +asynchronous message will merely queue its callback to be run after +returning to the main loop. + + + + + + + a #SoupSession + + + + the message to cancel + + + + status code to set on @msg (generally +%SOUP_STATUS_CANCELLED) + + + + + + + + + + + + + + + + + + + + + + + + + + + + Queues the message @msg for asynchronously sending the request and +receiving a response in the current thread-default #GMainContext. +If @msg has been processed before, any resources related to the +time it was last sent are freed. + +Upon message completion, the callback specified in @callback will +be invoked. If after returning from this callback the message has not +been requeued, @msg will be unreffed. + +(The behavior above applies to a plain #SoupSession; if you are +using #SoupSessionAsync or #SoupSessionSync, then the #GMainContext +that is used depends on the settings of #SoupSession:async-context +and #SoupSession:use-thread-context, and for #SoupSessionSync, the +message will actually be sent and processed in another thread, with +only the final callback occurring in the indicated #GMainContext.) + +Contrast this method with soup_session_send_async(), which also +asynchronously sends a message, but returns before reading the +response body, and allows you to read the response via a +#GInputStream. + + + + + + + a #SoupSession + + + + the message to queue + + + + a #SoupSessionCallback which will +be called after the message completes or when an unrecoverable error occurs. + + + + a pointer passed to @callback. + + + + + + + + + + + + + + + + + + + + + + + This causes @msg to be placed back on the queue to be attempted +again. + + + + + + + a #SoupSession + + + + the message to requeue + + + + + + Synchronously send @msg. This call will not return until the +transfer is finished successfully or there is an unrecoverable +error. + +Unlike with soup_session_queue_message(), @msg is not freed upon +return. + +(Note that if you call this method on a #SoupSessionAsync, it will +still use asynchronous I/O internally, running the glib main loop +to process the message, which may also cause other events to be +processed.) + +Contrast this method with soup_session_send(), which also +synchronously sends a message, but returns before reading the +response body, and allows you to read the response via a +#GInputStream. + + + the HTTP status code of the response + + + + + a #SoupSession + + + + the message to send + + + + + + Cancels all pending requests in @session and closes all idle +persistent connections. + +The message cancellation has the same semantics as with +soup_session_cancel_message(); asynchronous requests on a +#SoupSessionAsync will have their callback called before +soup_session_abort() returns. Requests on a plain #SoupSession will +not. + + + + + + + the session + + + + + + Adds @feature's functionality to @session. You can also add a +feature to the session at construct time by using the +%SOUP_SESSION_ADD_FEATURE property. + +See the main #SoupSession documentation for information on what +features are present in sessions by default. + + + + + + + a #SoupSession + + + + an object that implements #SoupSessionFeature + + + + + + If @feature_type is the type of a class that implements +#SoupSessionFeature, this creates a new feature of that type and +adds it to @session as with soup_session_add_feature(). You can use +this when you don't need to customize the new feature in any way. + +If @feature_type is not a #SoupSessionFeature type, this gives each +existing feature on @session the chance to accept @feature_type as +a "subfeature". This can be used to add new #SoupAuth or +#SoupRequest types, for instance. + +You can also add a feature to the session at construct time by +using the %SOUP_SESSION_ADD_FEATURE_BY_TYPE property. + +See the main #SoupSession documentation for information on what +features are present in sessions by default. + + + + + + + a #SoupSession + + + + a #GType + + + + + + Causes @session to immediately finish processing @msg (regardless +of its current state) with a final status_code of @status_code. You +may call this at any time after handing @msg off to @session; if +@session has started sending the request but has not yet received +the complete response, then it will close the request's connection. +Note that with requests that have side effects (eg, +<literal>POST</literal>, <literal>PUT</literal>, +<literal>DELETE</literal>) it is possible that you might cancel the +request after the server acts on it, but before it returns a +response, leaving the remote resource in an unknown state. + +If the message is cancelled while its response body is being read, +then the response body in @msg will be left partially-filled-in. +The response headers, on the other hand, will always be either +empty or complete. + +Beware that with the deprecated #SoupSessionAsync, messages queued +with soup_session_queue_message() will have their callbacks invoked +before soup_session_cancel_message() returns. The plain +#SoupSession does not have this behavior; cancelling an +asynchronous message will merely queue its callback to be run after +returning to the main loop. + + + + + + + a #SoupSession + + + + the message to cancel + + + + status code to set on @msg (generally +%SOUP_STATUS_CANCELLED) + + + + + + Start a connection to @uri. The operation can be monitored by providing a @progress_callback +and finishes when the connection is done or an error ocurred. + +Call soup_session_connect_finish() to get the #GIOStream to communicate with the server. + + + + + + + a #SoupSession + + + + a #SoupURI to connect to + + + + a #GCancellable + + + + a #SoupSessionConnectProgressCallback which +will be called for every network event that occurs during the connection. + + + + the callback to invoke when the operation finishes + + + + data for @progress_callback and @callback + + + + + + Gets the #GIOStream created for the connection to communicate with the server. + + + a new #GIOStream, or %NULL on error. + + + + + a #SoupSession + + + + the #GAsyncResult passed to your callback + + + + + + Gets @session's #SoupSession:async-context. This does not add a ref +to the context, so you will need to ref it yourself if you want it +to outlive its session. + +For a modern #SoupSession, this will always just return the +thread-default #GMainContext, and so is not especially useful. + + + @session's #GMainContext, +which may be %NULL + + + + + a #SoupSession + + + + + + Gets the first feature in @session of type @feature_type. For +features where there may be more than one feature of a given type, +use soup_session_get_features(). + + + a #SoupSessionFeature, or +%NULL. The feature is owned by @session. + + + + + a #SoupSession + + + + the #GType of the feature to get + + + + + + Gets the first feature in @session of type @feature_type, provided +that it is not disabled for @msg. As with +soup_session_get_feature(), this should only be used for features +where @feature_type is only expected to match a single feature. In +particular, if there are two matching features, and the first is +disabled on @msg, and the second is not, then this will return +%NULL, not the second feature. + + + a #SoupSessionFeature, or %NULL. The +feature is owned by @session. + + + + + a #SoupSession + + + + the #GType of the feature to get + + + + a #SoupMessage + + + + + + Generates a list of @session's features of type @feature_type. (If +you want to see all features, you can pass %SOUP_TYPE_SESSION_FEATURE +for @feature_type.) + + + +a list of features. You must free the list, but not its contents + + + + + + + a #SoupSession + + + + the #GType of the class of features to get + + + + + + Tests if @session has at a feature of type @feature_type (which can +be the type of either a #SoupSessionFeature, or else a subtype of +some class managed by another feature, such as #SoupAuth or +#SoupRequest). + + + %TRUE or %FALSE + + + + + a #SoupSession + + + + the #GType of the class of features to check for + + + + + + Pauses HTTP I/O on @msg. Call soup_session_unpause_message() to +resume I/O. + +This may only be called for asynchronous messages (those sent on a +#SoupSessionAsync or using soup_session_queue_message()). + + + + + + + a #SoupSession + + + + a #SoupMessage currently running on @session + + + + + + Tells @session that an URI from the given @hostname may be requested +shortly, and so the session can try to prepare by resolving the +domain name in advance, in order to work more quickly once the URI +is actually requested. + +If @cancellable is non-%NULL, it can be used to cancel the +resolution. @callback will still be invoked in this case, with a +status of %SOUP_STATUS_CANCELLED. + + + + + + + a #SoupSession + + + + a hostname to be resolved + + + + a #GCancellable object, or %NULL + + + + callback to call with the + result, or %NULL + + + + data for @callback + + + + + + Tells @session that @uri may be requested shortly, and so the +session can try to prepare (resolving the domain name, obtaining +proxy address, etc.) in order to work more quickly once the URI is +actually requested. + use soup_session_prefetch_dns() instead + + + + + + + a #SoupSession + + + + a #SoupURI which may be required + + + + + + Queues the message @msg for asynchronously sending the request and +receiving a response in the current thread-default #GMainContext. +If @msg has been processed before, any resources related to the +time it was last sent are freed. + +Upon message completion, the callback specified in @callback will +be invoked. If after returning from this callback the message has not +been requeued, @msg will be unreffed. + +(The behavior above applies to a plain #SoupSession; if you are +using #SoupSessionAsync or #SoupSessionSync, then the #GMainContext +that is used depends on the settings of #SoupSession:async-context +and #SoupSession:use-thread-context, and for #SoupSessionSync, the +message will actually be sent and processed in another thread, with +only the final callback occurring in the indicated #GMainContext.) + +Contrast this method with soup_session_send_async(), which also +asynchronously sends a message, but returns before reading the +response body, and allows you to read the response via a +#GInputStream. + + + + + + + a #SoupSession + + + + the message to queue + + + + a #SoupSessionCallback which will +be called after the message completes or when an unrecoverable error occurs. + + + + a pointer passed to @callback. + + + + + + Updates @msg's URI according to its status code and "Location" +header, and requeues it on @session. Use this when you have set +%SOUP_MESSAGE_NO_REDIRECT on a message, but have decided to allow a +particular redirection to occur, or if you want to allow a +redirection that #SoupSession will not perform automatically (eg, +redirecting a non-safe method such as DELETE). + +If @msg's status code indicates that it should be retried as a GET +request, then @msg will be modified accordingly. + +If @msg has already been redirected too many times, this will +cause it to fail with %SOUP_STATUS_TOO_MANY_REDIRECTS. + + + %TRUE if a redirection was applied, %FALSE if not +(eg, because there was no Location header, or it could not be +parsed). + + + + + the session + + + + a #SoupMessage that has received a 3xx response + + + + + + Removes @feature's functionality from @session. + + + + + + + a #SoupSession + + + + a feature that has previously been added to @session + + + + + + Removes all features of type @feature_type (or any subclass of +@feature_type) from @session. You can also remove standard features +from the session at construct time by using the +%SOUP_SESSION_REMOVE_FEATURE_BY_TYPE property. + + + + + + + a #SoupSession + + + + a #GType + + + + + + Creates a #SoupRequest for retrieving @uri_string. + + + a new #SoupRequest, or + %NULL on error. + + + + + a #SoupSession + + + + a URI, in string form + + + + + + Creates a #SoupRequest for retrieving @uri_string, which must be an +"http" or "https" URI (or another protocol listed in @session's +#SoupSession:http-aliases or #SoupSession:https-aliases). + + + a new #SoupRequestHTTP, or + %NULL on error. + + + + + a #SoupSession + + + + an HTTP method + + + + a URI, in string form + + + + + + Creates a #SoupRequest for retrieving @uri, which must be an +"http" or "https" URI (or another protocol listed in @session's +#SoupSession:http-aliases or #SoupSession:https-aliases). + + + a new #SoupRequestHTTP, or + %NULL on error. + + + + + a #SoupSession + + + + an HTTP method + + + + a #SoupURI representing the URI to retrieve + + + + + + Creates a #SoupRequest for retrieving @uri. + + + a new #SoupRequest, or + %NULL on error. + + + + + a #SoupSession + + + + a #SoupURI representing the URI to retrieve + + + + + + This causes @msg to be placed back on the queue to be attempted +again. + + + + + + + a #SoupSession + + + + the message to requeue + + + + + + Synchronously sends @msg and waits for the beginning of a response. +On success, a #GInputStream will be returned which you can use to +read the response body. ("Success" here means only that an HTTP +response was received and understood; it does not necessarily mean +that a 2xx class status code was received.) + +If non-%NULL, @cancellable can be used to cancel the request; +soup_session_send() will return a %G_IO_ERROR_CANCELLED error. Note +that with requests that have side effects (eg, +<literal>POST</literal>, <literal>PUT</literal>, +<literal>DELETE</literal>) it is possible that you might cancel the +request after the server acts on it, but before it returns a +response, leaving the remote resource in an unknown state. + +If @msg is requeued due to a redirect or authentication, the +initial (3xx/401/407) response body will be suppressed, and +soup_session_send() will only return once a final response has been +received. + +Contrast this method with soup_session_send_message(), which also +synchronously sends a #SoupMessage, but doesn't return until the +response has been completely read. + +(Note that this method cannot be called on the deprecated +#SoupSessionAsync subclass.) + + + a #GInputStream for reading the + response body, or %NULL on error. + + + + + a #SoupSession + + + + a #SoupMessage + + + + a #GCancellable + + + + + + Asynchronously sends @msg and waits for the beginning of a +response. When @callback is called, then either @msg has been sent, +and its response headers received, or else an error has occurred. +Call soup_session_send_finish() to get a #GInputStream for reading +the response body. + +See soup_session_send() for more details on the general semantics. + +Contrast this method with soup_session_queue_message(), which also +asynchronously sends a #SoupMessage, but doesn't invoke its +callback until the response has been completely read. + +(Note that this method cannot be called on the deprecated +#SoupSessionSync subclass, and can only be called on +#SoupSessionAsync if you have set the +#SoupSession:use-thread-context property.) + + + + + + + a #SoupSession + + + + a #SoupMessage + + + + a #GCancellable + + + + the callback to invoke + + + + data for @callback + + + + + + Gets the response to a soup_session_send_async() call and (if +successful), returns a #GInputStream that can be used to read the +response body. + + + a #GInputStream for reading the + response body, or %NULL on error. + + + + + a #SoupSession + + + + the #GAsyncResult passed to your callback + + + + + + Synchronously send @msg. This call will not return until the +transfer is finished successfully or there is an unrecoverable +error. + +Unlike with soup_session_queue_message(), @msg is not freed upon +return. + +(Note that if you call this method on a #SoupSessionAsync, it will +still use asynchronous I/O internally, running the glib main loop +to process the message, which may also cause other events to be +processed.) + +Contrast this method with soup_session_send(), which also +synchronously sends a message, but returns before reading the +response body, and allows you to read the response via a +#GInputStream. + + + the HTTP status code of the response + + + + + a #SoupSession + + + + the message to send + + + + + + "Steals" the HTTP connection associated with @msg from @session. +This happens immediately, regardless of the current state of the +connection, and @msg's callback will not be called. You can steal +the connection from a #SoupMessage signal handler if you need to +wait for part or all of the response to be received first. + +Calling this function may cause @msg to be freed if you are not +holding any other reference to it. + + + the #GIOStream formerly associated + with @msg (or %NULL if @msg was no longer associated with a + connection). No guarantees are made about what kind of #GIOStream + is returned. + + + + + a #SoupSession + + + + the message whose connection is to be stolen + + + + + + Resumes HTTP I/O on @msg. Use this to resume after calling +soup_session_pause_message(). + +If @msg is being sent via blocking I/O, this will resume reading or +writing immediately. If @msg is using non-blocking I/O, then +reading or writing won't resume until you return to the main loop. + +This may only be called for asynchronous messages (those sent on a +#SoupSessionAsync or using soup_session_queue_message()). + + + + + + + a #SoupSession + + + + a #SoupMessage currently running on @session + + + + + + Asynchronously creates a #SoupWebsocketConnection to communicate +with a remote server. + +All necessary WebSocket-related headers will be added to @msg, and +it will then be sent and asynchronously processed normally +(including handling of redirection and HTTP authentication). + +If the server returns "101 Switching Protocols", then @msg's status +code and response headers will be updated, and then the WebSocket +handshake will be completed. On success, +soup_session_websocket_connect_finish() will return a new +#SoupWebsocketConnection. On failure it will return a #GError. + +If the server returns a status other than "101 Switching +Protocols", then @msg will contain the complete response headers +and body from the server's response, and +soup_session_websocket_connect_finish() will return +%SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET. + + + + + + + a #SoupSession + + + + #SoupMessage indicating the WebSocket server to connect to + + + + origin of the connection + + + + a + %NULL-terminated array of protocols supported + + + + + + a #GCancellable + + + + the callback to invoke + + + + data for @callback + + + + + + Gets the #SoupWebsocketConnection response to a +soup_session_websocket_connect_async() call and (if successful), +returns a #SoupWebsocketConnection that can be used to communicate +with the server. + + + a new #SoupWebsocketConnection, or + %NULL on error. + + + + + a #SoupSession + + + + the #GAsyncResult passed to your callback + + + + + + Checks if @msg contains a response that would cause @session to +redirect it to a new URL (ignoring @msg's %SOUP_MESSAGE_NO_REDIRECT +flag, and the number of times it has already been redirected). + + + whether @msg would be redirected + + + + + a #SoupSession + + + + a #SoupMessage that has response headers + + + + + + If non-%NULL, the value to use for the "Accept-Language" header +on #SoupMessage<!-- -->s sent from this session. + +Setting this will disable +#SoupSession:accept-language-auto. + + + + If %TRUE, #SoupSession will automatically set the string +for the "Accept-Language" header on every #SoupMessage +sent, based on the return value of g_get_language_names(). + +Setting this will override any previous value of +#SoupSession:accept-language. + + + + Add a feature object to the session. (Shortcut for calling +soup_session_add_feature().) + + + + Add a feature object of the given type to the session. +(Shortcut for calling soup_session_add_feature_by_type().) + + + + The #GMainContext that miscellaneous session-related +asynchronous callbacks are invoked on. (Eg, setting +#SoupSession:idle-timeout will add a timeout source on this +context.) + +For a plain #SoupSession, this property is always set to +the #GMainContext that is the thread-default at the time +the session was created, and cannot be overridden. For the +deprecated #SoupSession subclasses, the default value is +%NULL, meaning to use the global default #GMainContext. + +If #SoupSession:use-thread-context is %FALSE, this context +will also be used for asynchronous HTTP I/O. + + + + A %NULL-terminated array of URI schemes that should be +considered to be aliases for "http". Eg, if this included +<literal>"dav"</literal>, than a URI of +<literal>dav://example.com/path</literal> would be treated +identically to <literal>http://example.com/path</literal>. + +In a plain #SoupSession, the default value is %NULL, +meaning that only "http" is recognized as meaning "http". +In #SoupSessionAsync and #SoupSessionSync, for backward +compatibility, the default value is an array containing the +single element <literal>"*"</literal>, a special value +which means that any scheme except "https" is considered to +be an alias for "http". + +See also #SoupSession:https-aliases. + + + + + + A comma-delimited list of URI schemes that should be +considered to be aliases for "https". See +#SoupSession:http-aliases for more information. + +The default value is %NULL, meaning that no URI schemes +are considered aliases for "https". + + + + + + Connection lifetime (in seconds) when idle. Any connection +left idle longer than this will be closed. + +Although you can change this property at any time, it will +only affect newly-created connections, not currently-open +ones. You can call soup_session_abort() after setting this +if you want to ensure that all future connections will have +this timeout value. + +Note that the default value of 60 seconds only applies to +plain #SoupSessions. If you are using #SoupSessionAsync or +#SoupSessionSync, the default value is 0 (meaning idle +connections will never time out). + + + + Sets the #SoupAddress to use for the client side of +the connection. + +Use this property if you want for instance to bind the +local socket to a specific IP address. + + + + + + + + + + A #GProxyResolver to use with this session. Setting this +will clear the #SoupSession:proxy-uri property, and remove +any <type>SoupProxyURIResolver</type> features that have +been added to the session. + +By default, in a plain #SoupSession, this is set to the +default #GProxyResolver, but you can set it to %NULL if you +don't want to use proxies, or set it to your own +#GProxyResolver if you want to control what proxies get +used. + + + + A proxy to use for all http and https requests in this +session. Setting this will clear the +#SoupSession:proxy-resolver property, and remove any +<type>SoupProxyURIResolver</type> features that have been +added to the session. Setting this property will also +cancel all currently pending messages. + +Note that #SoupSession will normally handle looking up the +user's proxy settings for you; you should only use +#SoupSession:proxy-uri if you need to override the user's +normal proxy settings. + +Also note that this proxy will be used for +<emphasis>all</emphasis> requests; even requests to +<literal>localhost</literal>. If you need more control over +proxies, you can create a #GSimpleProxyResolver and set the +#SoupSession:proxy-resolver property. + Use SoupSession:proxy-resolver along with #GSimpleProxyResolver. + + + + Remove feature objects from the session. (Shortcut for +calling soup_session_remove_feature_by_type().) + + + + File containing SSL CA certificates. + +If the specified file does not exist or cannot be read, +then libsoup will print a warning, and then behave as +though it had read in a empty CA file, meaning that all SSL +certificates will be considered invalid. + use #SoupSession:ssl-use-system-ca-file, or +else #SoupSession:tls-database with a #GTlsFileDatabase +(which allows you to do explicit error handling). + + + + Normally, if #SoupSession:tls-database is set (including if +it was set via #SoupSession:ssl-use-system-ca-file or +#SoupSession:ssl-ca-file), then libsoup will reject any +certificate that is invalid (ie, expired) or that is not +signed by one of the given CA certificates, and the +#SoupMessage will fail with the status +%SOUP_STATUS_SSL_FAILED. + +If you set #SoupSession:ssl-strict to %FALSE, then all +certificates will be accepted, and you will need to call +soup_message_get_https_status() to distinguish valid from +invalid certificates. (This can be used, eg, if you want to +accept invalid certificates after giving some sort of +warning.) + +For a plain #SoupSession, if the session has no CA file or +TLS database, and this property is %TRUE, then all +certificates will be rejected. However, beware that the +deprecated #SoupSession subclasses (#SoupSessionAsync and +#SoupSessionSync) have the opposite behavior: if there is +no CA file or TLS database, then all certificates are always +accepted, and this property has no effect. + + + + Setting this to %TRUE is equivalent to setting +#SoupSession:tls-database to the default system CA database. +(and likewise, setting #SoupSession:tls-database to the +default database by hand will cause this property to +become %TRUE). + +Setting this to %FALSE (when it was previously %TRUE) will +clear the #SoupSession:tls-database field. + +See #SoupSession:ssl-strict for more information on how +https certificate validation is handled. + +If you are using #SoupSessionAsync or +#SoupSessionSync, on libsoup older than 2.72.1, the default value +is %FALSE, for backward compatibility. + + + + The timeout (in seconds) for socket I/O operations +(including connecting to a server, and waiting for a reply +to an HTTP request). + +Although you can change this property at any time, it will +only affect newly-created connections, not currently-open +ones. You can call soup_session_abort() after setting this +if you want to ensure that all future connections will have +this timeout value. + +Note that the default value of 60 seconds only applies to +plain #SoupSessions. If you are using #SoupSessionAsync or +#SoupSessionSync, the default value is 0 (meaning socket I/O +will not time out). + +Not to be confused with #SoupSession:idle-timeout (which is +the length of time that idle persistent connections will be +kept open). + + + + Sets the #GTlsDatabase to use for validating SSL/TLS +certificates. + +Note that setting the #SoupSession:ssl-ca-file or +#SoupSession:ssl-use-system-ca-file property will cause +this property to be set to a #GTlsDatabase corresponding to +the indicated file or system default. + +See #SoupSession:ssl-strict for more information on how +https certificate validation is handled. + +If you are using a plain #SoupSession then +#SoupSession:ssl-use-system-ca-file will be %TRUE by +default, and so this property will be a copy of the system +CA database. If you are using #SoupSessionAsync or +#SoupSessionSync, on libsoup older than 2.72.1, this property +will be %NULL by default. + + + + A #GTlsInteraction object that will be passed on to any +#GTlsConnections created by the session. (This can be used to +provide client-side certificates, for example.) + + + + Whether or not to use NTLM authentication. + use soup_session_add_feature_by_type() with +#SOUP_TYPE_AUTH_NTLM. + + + + If %TRUE (which it always is on a plain #SoupSession), +asynchronous HTTP requests in this session will run in +whatever the thread-default #GMainContext is at the time +they are started, rather than always occurring in +#SoupSession:async-context. + + + + If non-%NULL, the value to use for the "User-Agent" header +on #SoupMessage<!-- -->s sent from this session. + +RFC 2616 says: "The User-Agent request-header field +contains information about the user agent originating the +request. This is for statistical purposes, the tracing of +protocol violations, and automated recognition of user +agents for the sake of tailoring responses to avoid +particular user agent limitations. User agents SHOULD +include this field with requests." + +The User-Agent header contains a list of one or more +product tokens, separated by whitespace, with the most +significant product token coming first. The tokens must be +brief, ASCII, and mostly alphanumeric (although "-", "_", +and "." are also allowed), and may optionally include a "/" +followed by a version string. You may also put comments, +enclosed in parentheses, between or after the tokens. + +If you set a #SoupSession:user_agent property that has trailing +whitespace, #SoupSession will append its own product token +(eg, "<literal>libsoup/2.3.2</literal>") to the end of the +header for you. + + + + + + + Emitted when the session requires authentication. If +credentials are available call soup_auth_authenticate() on +@auth. If these credentials fail, the signal will be +emitted again, with @retrying set to %TRUE, which will +continue until you return without calling +soup_auth_authenticate() on @auth. + +Note that this may be emitted before @msg's body has been +fully read. + +If you call soup_session_pause_message() on @msg before +returning, then you can authenticate @auth asynchronously +(as long as you g_object_ref() it to make sure it doesn't +get destroyed), and then unpause @msg when you are ready +for it to continue. + + + + + + the #SoupMessage being sent + + + + the #SoupAuth to authenticate + + + + %TRUE if this is the second (or later) attempt + + + + + + Emitted when a new connection is created. This is an +internal signal intended only to be used for debugging +purposes, and may go away in the future. + + + + + + the connection + + + + + + Emitted when a request is queued on @session. (Note that +"queued" doesn't just mean soup_session_queue_message(); +soup_session_send_message() implicitly queues the message +as well.) + +When sending a request, first #SoupSession::request_queued +is emitted, indicating that the session has become aware of +the request. + +Once a connection is available to send the request on, the +session emits #SoupSession::request_started. Then, various +#SoupMessage signals are emitted as the message is +processed. If the message is requeued, it will emit +#SoupMessage::restarted, which will then be followed by +another #SoupSession::request_started and another set of +#SoupMessage signals when the message is re-sent. + +Eventually, the message will emit #SoupMessage::finished. +Normally, this signals the completion of message +processing. However, it is possible that the application +will requeue the message from the "finished" handler (or +equivalently, from the soup_session_queue_message() +callback). In that case, the process will loop back to +#SoupSession::request_started. + +Eventually, a message will reach "finished" and not be +requeued. At that point, the session will emit +#SoupSession::request_unqueued to indicate that it is done +with the message. + +To sum up: #SoupSession::request_queued and +#SoupSession::request_unqueued are guaranteed to be emitted +exactly once, but #SoupSession::request_started and +#SoupMessage::finished (and all of the other #SoupMessage +signals) may be invoked multiple times for a given message. + + + + + + the request that was queued + + + + + + Emitted just before a request is sent. See +#SoupSession::request_queued for a detailed description of +the message lifecycle within a session. + Use #SoupMessage::starting instead. + + + + + + the request being sent + + + + the socket the request is being sent on + + + + + + Emitted when a request is removed from @session's queue, +indicating that @session is done with it. See +#SoupSession::request_queued for a detailed description of the +message lifecycle within a session. + + + + + + the request that was unqueued + + + + + + Emitted when an SSL tunnel is being created on a proxy +connection. This is an internal signal intended only to be +used for debugging purposes, and may go away in the future. + + + + + + the connection + + + + + + + + + Creates an asynchronous #SoupSession with the default options. + #SoupSessionAsync is deprecated; use a plain +#SoupSession, created with soup_session_new(). See the <link +linkend="libsoup-session-porting">porting guide</link>. + + + the new session. + + + + + Creates an asynchronous #SoupSession with the specified options. + #SoupSessionAsync is deprecated; use a plain +#SoupSession, created with soup_session_new_with_options(). See the +<link linkend="libsoup-session-porting">porting guide</link>. + + + the new session. + + + + + name of first property to set + + + + value of @optname1, followed by additional property/value pairs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Prototype for the callback passed to soup_session_queue_message(), +qv. + + + + + + + the session + + + + the message that has finished + + + + the data passed to soup_session_queue_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a #SoupSession + + + + the message to queue + + + + a #SoupSessionCallback which will +be called after the message completes or when an unrecoverable error occurs. + + + + a pointer passed to @callback. + + + + + + + + + + + + + + a #SoupSession + + + + the message to requeue + + + + + + + + + + the HTTP status code of the response + + + + + a #SoupSession + + + + the message to send + + + + + + + + + + + + + + a #SoupSession + + + + the message to cancel + + + + status code to set on @msg (generally +%SOUP_STATUS_CANCELLED) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Prototype for the progress callback passed to soup_session_connect_async(). + + + + + + + the #SoupSession + + + + a #GSocketClientEvent + + + + the current state of the network connection + + + + the data passed to soup_session_connect_async(). + + + + + + An object that implement some sort of optional feature for +#SoupSession. + + + Adds a "sub-feature" of type @type to the base feature @feature. +This is used for features that can be extended with multiple +different types. Eg, the authentication manager can be extended +with subtypes of #SoupAuth. + + + %TRUE if @feature accepted @type as a subfeature. + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests if @feature has a "sub-feature" of type @type. See +soup_session_feature_add_feature(). + + + %TRUE if @feature has a subfeature of type @type + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + Removes the "sub-feature" of type @type from the base feature +@feature. See soup_session_feature_add_feature(). + + + %TRUE if @type was removed from @feature + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a "sub-feature" of type @type to the base feature @feature. +This is used for features that can be extended with multiple +different types. Eg, the authentication manager can be extended +with subtypes of #SoupAuth. + + + %TRUE if @feature accepted @type as a subfeature. + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests if @feature has a "sub-feature" of type @type. See +soup_session_feature_add_feature(). + + + %TRUE if @feature has a subfeature of type @type + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + Removes the "sub-feature" of type @type from the base feature +@feature. See soup_session_feature_add_feature(). + + + %TRUE if @type was removed from @feature + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + The interface implemented by #SoupSessionFeature<!-- -->s. + + + The parent interface. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + %TRUE if @feature accepted @type as a subfeature. + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + + + + %TRUE if @type was removed from @feature + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + + + + %TRUE if @feature has a subfeature of type @type + + + + + the "base" feature + + + + the #GType of a "sub-feature" + + + + + + + + + + Creates an synchronous #SoupSession with the default options. + #SoupSessionSync is deprecated; use a plain +#SoupSession, created with soup_session_new(). See the <link +linkend="libsoup-session-porting">porting guide</link>. + + + the new session. + + + + + Creates an synchronous #SoupSession with the specified options. + #SoupSessionSync is deprecated; use a plain +#SoupSession, created with soup_session_new_with_options(). See the +<link linkend="libsoup-session-porting">porting guide</link>. + + + the new session. + + + + + name of first property to set + + + + value of @optname1, followed by additional property/value pairs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new (disconnected) socket + + + the new socket + + + + + name of first property to set (or %NULL) + + + + value of @optname1, followed by additional property/value pairs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Begins asynchronously connecting to @sock's remote address. The +socket will call @callback when it succeeds or fails (but not +before returning from this function). + +If @cancellable is non-%NULL, it can be used to cancel the +connection. @callback will still be invoked in this case, with a +status of %SOUP_STATUS_CANCELLED. + + + + + + + a client #SoupSocket (which must not already be connected) + + + + a #GCancellable, or %NULL + + + + callback to call after connecting + + + + data to pass to @callback + + + + + + Attempt to synchronously connect @sock to its remote address. + +If @cancellable is non-%NULL, it can be used to cancel the +connection, in which case soup_socket_connect_sync() will return +%SOUP_STATUS_CANCELLED. + + + a success or failure code. + + + + + a client #SoupSocket (which must not already be connected) + + + + a #GCancellable, or %NULL + + + + + + Disconnects @sock. Any further read or write attempts on it will +fail. + + + + + + + a #SoupSocket + + + + + + Gets @sock's underlying file descriptor. + +Note that fiddling with the file descriptor may break the +#SoupSocket. + + + @sock's file descriptor. + + + + + a #SoupSocket + + + + + + Returns the #SoupAddress corresponding to the local end of @sock. + +Calling this method on an unconnected socket is considered to be +an error, and produces undefined results. + + + the #SoupAddress + + + + + a #SoupSocket + + + + + + Returns the #SoupAddress corresponding to the remote end of @sock. + +Calling this method on an unconnected socket is considered to be +an error, and produces undefined results. + + + the #SoupAddress + + + + + a #SoupSocket + + + + + + Tests if @sock is connected to another host + + + %TRUE or %FALSE. + + + + + a #SoupSocket + + + + + + Tests if @sock is doing (or has attempted to do) SSL. + + + %TRUE if @sock has SSL credentials set + + + + + a #SoupSocket + + + + + + Makes @sock start listening on its local address. When connections +come in, @sock will emit #SoupSocket::new_connection. + + + whether or not @sock is now listening. + + + + + a server #SoupSocket (which must not already be connected or +listening) + + + + + + Attempts to read up to @len bytes from @sock into @buffer. If some +data is successfully read, soup_socket_read() will return +%SOUP_SOCKET_OK, and *@nread will contain the number of bytes +actually read (which may be less than @len). + +If @sock is non-blocking, and no data is available, the return +value will be %SOUP_SOCKET_WOULD_BLOCK. In this case, the caller +can connect to the #SoupSocket::readable signal to know when there +is more data to read. (NB: You MUST read all available data off the +socket first. #SoupSocket::readable is only emitted after +soup_socket_read() returns %SOUP_SOCKET_WOULD_BLOCK, and it is only +emitted once. See the documentation for #SoupSocket:non-blocking.) + + + a #SoupSocketIOStatus, as described above (or +%SOUP_SOCKET_EOF if the socket is no longer connected, or +%SOUP_SOCKET_ERROR on any other error, in which case @error will +also be set). + + + + + the socket + + + + buffer to read + into + + + + + + size of @buffer in bytes + + + + on return, the number of bytes read into @buffer + + + + a #GCancellable, or %NULL + + + + + + Like soup_socket_read(), but reads no further than the first +occurrence of @boundary. (If the boundary is found, it will be +included in the returned data, and *@got_boundary will be set to +%TRUE.) Any data after the boundary will returned in future reads. + +soup_socket_read_until() will almost always return fewer than @len +bytes: if the boundary is found, then it will only return the bytes +up until the end of the boundary, and if the boundary is not found, +then it will leave the last <literal>(boundary_len - 1)</literal> +bytes in its internal buffer, in case they form the start of the +boundary string. Thus, @len normally needs to be at least 1 byte +longer than @boundary_len if you want to make any progress at all. + + + as for soup_socket_read() + + + + + the socket + + + + buffer to read + into + + + + + + size of @buffer in bytes + + + + boundary to read until + + + + length of @boundary in bytes + + + + on return, the number of bytes read into @buffer + + + + on return, whether or not the data in @buffer +ends with the boundary string + + + + a #GCancellable, or %NULL + + + + + + Starts using SSL on @socket, expecting to find a host named +@ssl_host. + + + success or failure + + + + + the socket + + + + hostname of the SSL server + + + + a #GCancellable + + + + + + Starts using SSL on @socket. + + + success or failure + + + + + the socket + + + + a #GCancellable + + + + + + Attempts to write @len bytes from @buffer to @sock. If some data is +successfully written, the return status will be %SOUP_SOCKET_OK, +and *@nwrote will contain the number of bytes actually written +(which may be less than @len). + +If @sock is non-blocking, and no data could be written right away, +the return value will be %SOUP_SOCKET_WOULD_BLOCK. In this case, +the caller can connect to the #SoupSocket::writable signal to know +when more data can be written. (NB: #SoupSocket::writable is only +emitted after soup_socket_write() returns %SOUP_SOCKET_WOULD_BLOCK, +and it is only emitted once. See the documentation for +#SoupSocket:non-blocking.) + + + a #SoupSocketIOStatus, as described above (or +%SOUP_SOCKET_EOF or %SOUP_SOCKET_ERROR. @error will be set if the +return value is %SOUP_SOCKET_ERROR.) + + + + + the socket + + + + data to write + + + + + + size of @buffer, in bytes + + + + on return, number of bytes written + + + + a #GCancellable, or %NULL + + + + + + + + + + + + + + + + + + + + + Whether or not the socket is a server socket. + +Note that for "ordinary" #SoupSockets this will be set for +both listening sockets and the sockets emitted by +#SoupSocket::new-connection, but for sockets created by +setting #SoupSocket:fd, it will only be set for listening +sockets. + + + + + + + Whether or not the socket uses non-blocking I/O. + +#SoupSocket's I/O methods are designed around the idea of +using a single codepath for both synchronous and +asynchronous I/O. If you want to read off a #SoupSocket, +the "correct" way to do it is to call soup_socket_read() or +soup_socket_read_until() repeatedly until you have read +everything you want. If it returns %SOUP_SOCKET_WOULD_BLOCK +at any point, stop reading and wait for it to emit the +#SoupSocket::readable signal. Then go back to the +reading-as-much-as-you-can loop. Likewise, for writing to a +#SoupSocket, you should call soup_socket_write() either +until you have written everything, or it returns +%SOUP_SOCKET_WOULD_BLOCK (in which case you wait for +#SoupSocket::writable and then go back into the loop). + +Code written this way will work correctly with both +blocking and non-blocking sockets; blocking sockets will +simply never return %SOUP_SOCKET_WOULD_BLOCK, and so the +code that handles that case just won't get used for them. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use g_main_context_get_thread_default(). + + + + + + + Emitted when the socket is disconnected, for whatever +reason. + + + + + + Emitted when a network-related event occurs. See +#GSocketClient::event for more details. + + + + + + the event that occurred + + + + the current connection state + + + + + + Emitted when a listening socket (set up with +soup_socket_listen()) receives a new connection. + +You must ref the @new if you want to keep it; otherwise it +will be destroyed after the signal is emitted. + + + + + + the new socket + + + + + + Emitted when an async socket is readable. See +soup_socket_read(), soup_socket_read_until() and +#SoupSocket:non-blocking. + + + + + + Emitted when an async socket is writable. See +soup_socket_write() and #SoupSocket:non-blocking. + + + + + + + The callback function passed to soup_socket_connect_async(). + + + + + + + the #SoupSocket + + + + an HTTP status code indicating success or failure + + + + the data passed to soup_socket_connect_async() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Return value from the #SoupSocket IO methods. + + Success + + + Cannot read/write any more at this time + + + End of file + + + Other error + + + + These represent the known HTTP status code values, plus various +network and internal errors. + +Note that no libsoup functions take or return this type directly; +any function that works with status codes will accept unrecognized +status codes as well. + +Prior to 2.44 this type was called +<literal>SoupKnownStatusCode</literal>, but the individual values +have always had the names they have now. + + No status available. (Eg, the message has not +been sent yet) + + + Message was cancelled locally + + + Unable to resolve destination host name + + + Unable to resolve proxy host name + + + Unable to connect to remote host + + + Unable to connect to proxy + + + SSL/TLS negotiation failed + + + A network error occurred, or the other end +closed the connection unexpectedly + + + Malformed data (usually a programmer error) + + + Used internally + + + There were too many redirections + + + Used internally + + + 100 Continue (HTTP) + + + 101 Switching Protocols (HTTP) + + + 102 Processing (WebDAV) + + + 200 Success (HTTP). Also used by many lower-level +soup routines to indicate success. + + + 201 Created (HTTP) + + + 202 Accepted (HTTP) + + + 203 Non-Authoritative Information +(HTTP) + + + 204 No Content (HTTP) + + + 205 Reset Content (HTTP) + + + 206 Partial Content (HTTP) + + + 207 Multi-Status (WebDAV) + + + 300 Multiple Choices (HTTP) + + + 301 Moved Permanently (HTTP) + + + 302 Found (HTTP) + + + 302 Moved Temporarily (old name, +RFC 2068) + + + 303 See Other (HTTP) + + + 304 Not Modified (HTTP) + + + 305 Use Proxy (HTTP) + + + 306 [Unused] (HTTP) + + + 307 Temporary Redirect (HTTP) + + + + + 400 Bad Request (HTTP) + + + 401 Unauthorized (HTTP) + + + 402 Payment Required (HTTP) + + + 403 Forbidden (HTTP) + + + 404 Not Found (HTTP) + + + 405 Method Not Allowed (HTTP) + + + 406 Not Acceptable (HTTP) + + + 407 Proxy Authentication +Required (HTTP) + + + shorter alias for +%SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED + + + 408 Request Timeout (HTTP) + + + 409 Conflict (HTTP) + + + 410 Gone (HTTP) + + + 411 Length Required (HTTP) + + + 412 Precondition Failed (HTTP) + + + 413 Request Entity Too Large +(HTTP) + + + 414 Request-URI Too Long (HTTP) + + + 415 Unsupported Media Type +(HTTP) + + + 416 Requested Range +Not Satisfiable (HTTP) + + + shorter alias for +%SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE + + + 417 Expectation Failed (HTTP) + + + 422 Unprocessable Entity +(WebDAV) + + + 423 Locked (WebDAV) + + + 424 Failed Dependency (WebDAV) + + + 500 Internal Server Error +(HTTP) + + + 501 Not Implemented (HTTP) + + + 502 Bad Gateway (HTTP) + + + 503 Service Unavailable (HTTP) + + + 504 Gateway Timeout (HTTP) + + + 505 HTTP Version Not +Supported (HTTP) + + + 507 Insufficient Storage +(WebDAV) + + + 510 Not Extended (RFC 2774) + + + Looks up the stock HTTP description of @status_code. This is used +by soup_message_set_status() to get the correct text to go with a +given status code. + +<emphasis>There is no reason for you to ever use this +function.</emphasis> If you wanted the textual description for the +#SoupMessage:status_code of a given #SoupMessage, you should just +look at the message's #SoupMessage:reason_phrase. However, you +should only do that for use in debugging messages; HTTP reason +phrases are not localized, and are not generally very descriptive +anyway, and so they should never be presented to the user directly. +Instead, you should create you own error messages based on the +status code, and on what you were trying to do. + + + the (terse, English) description of @status_code + + + + + an HTTP status code + + + + + + Turns %SOUP_STATUS_CANT_RESOLVE into +%SOUP_STATUS_CANT_RESOLVE_PROXY and %SOUP_STATUS_CANT_CONNECT into +%SOUP_STATUS_CANT_CONNECT_PROXY. Other status codes are passed +through unchanged. + + + the "proxified" equivalent of @status_code. + + + + + a status code + + + + + + + Error codes for %SOUP_TLD_ERROR. + + A hostname was syntactically + invalid. + + + The passed-in "hostname" was + actually an IP address (and thus has no base domain or + public suffix). + + + The passed-in hostname + did not have enough components. Eg, calling + soup_tld_get_base_domain() on <literal>"co.uk"</literal>. + + + The passed-in hostname has + no recognized public suffix. + + + + + + + + + + + A #SoupURI represents a (parsed) URI. #SoupURI supports RFC 3986 +(URI Generic Syntax), and can parse any valid URI. However, libsoup +only uses "http" and "https" URIs internally; You can use +SOUP_URI_VALID_FOR_HTTP() to test if a #SoupURI is a valid HTTP +URI. + +@scheme will always be set in any URI. It is an interned string and +is always all lowercase. (If you parse a URI with a non-lowercase +scheme, it will be converted to lowercase.) The macros +%SOUP_URI_SCHEME_HTTP and %SOUP_URI_SCHEME_HTTPS provide the +interned values for "http" and "https" and can be compared against +URI @scheme values. + +@user and @password are parsed as defined in the older URI specs +(ie, separated by a colon; RFC 3986 only talks about a single +"userinfo" field). Note that @password is not included in the +output of soup_uri_to_string(). libsoup does not normally use these +fields; authentication is handled via #SoupSession signals. + +@host contains the hostname, and @port the port specified in the +URI. If the URI doesn't contain a hostname, @host will be %NULL, +and if it doesn't specify a port, @port may be 0. However, for +"http" and "https" URIs, @host is guaranteed to be non-%NULL +(trying to parse an http URI with no @host will return %NULL), and +@port will always be non-0 (because libsoup knows the default value +to use when it is not specified in the URI). + +@path is always non-%NULL. For http/https URIs, @path will never be +an empty string either; if the input URI has no path, the parsed +#SoupURI will have a @path of "/". + +@query and @fragment are optional for all URI types. +soup_form_decode() may be useful for parsing @query. + +Note that @path, @query, and @fragment may contain +%<!-- -->-encoded characters. soup_uri_new() calls +soup_uri_normalize() on them, but not soup_uri_decode(). This is +necessary to ensure that soup_uri_to_string() will generate a URI +that has exactly the same meaning as the original. (In theory, +#SoupURI should leave @user, @password, and @host partially-encoded +as well, but this would be more annoying than useful.) + + + the URI scheme (eg, "http") + + + + a username, or %NULL + + + + a password, or %NULL + + + + the hostname or IP address, or %NULL + + + + the port number on @host + + + + the path on @host + + + + a query for @path, or %NULL + + + + a fragment identifier within @path, or %NULL + + + + Parses an absolute URI. + +You can also pass %NULL for @uri_string if you want to get back an +"empty" #SoupURI that you can fill in by hand. (You will need to +call at least soup_uri_set_scheme() and soup_uri_set_path(), since +those fields are required.) + + + a #SoupURI, or %NULL if the given string + was found to be invalid. + + + + + a URI + + + + + + Parses @uri_string relative to @base. + + + a parsed #SoupURI. + + + + + a base URI + + + + the URI + + + + + + Copies @uri + + + a copy of @uri, which must be freed with soup_uri_free() + + + + + a #SoupURI + + + + + + Makes a copy of @uri, considering only the protocol, host, and port + + + the new #SoupURI + + + + + a #SoupURI + + + + + + Tests whether or not @uri1 and @uri2 are equal in all parts + + + %TRUE or %FALSE + + + + + a #SoupURI + + + + another #SoupURI + + + + + + Frees @uri. + + + + + + + a #SoupURI + + + + + + Gets @uri's fragment. + + + @uri's fragment. + + + + + a #SoupURI + + + + + + Gets @uri's host. + + + @uri's host. + + + + + a #SoupURI + + + + + + Gets @uri's password. + + + @uri's password. + + + + + a #SoupURI + + + + + + Gets @uri's path. + + + @uri's path. + + + + + a #SoupURI + + + + + + Gets @uri's port. + + + @uri's port. + + + + + a #SoupURI + + + + + + Gets @uri's query. + + + @uri's query. + + + + + a #SoupURI + + + + + + Gets @uri's scheme. + + + @uri's scheme. + + + + + a #SoupURI + + + + + + Gets @uri's user. + + + @uri's user. + + + + + a #SoupURI + + + + + + Compares @v1 and @v2, considering only the scheme, host, and port. + + + whether or not the URIs are equal in scheme, host, +and port. + + + + + a #SoupURI with a non-%NULL @host member + + + + a #SoupURI with a non-%NULL @host member + + + + + + Hashes @key, considering only the scheme, host, and port. + + + a hash + + + + + a #SoupURI with a non-%NULL @host member + + + + + + Sets @uri's fragment to @fragment. + + + + + + + a #SoupURI + + + + the fragment + + + + + + Sets @uri's host to @host. + +If @host is an IPv6 IP address, it should not include the brackets +required by the URI syntax; they will be added automatically when +converting @uri to a string. + +http and https URIs should not have a %NULL @host. + + + + + + + a #SoupURI + + + + the hostname or IP address, or %NULL + + + + + + Sets @uri's password to @password. + + + + + + + a #SoupURI + + + + the password, or %NULL + + + + + + Sets @uri's path to @path. + + + + + + + a #SoupURI + + + + the non-%NULL path + + + + + + Sets @uri's port to @port. If @port is 0, @uri will not have an +explicitly-specified port. + + + + + + + a #SoupURI + + + + the port, or 0 + + + + + + Sets @uri's query to @query. + + + + + + + a #SoupURI + + + + the query + + + + + + Sets @uri's query to the result of encoding the given form fields +and values according to the * HTML form rules. See +soup_form_encode() for more information. + + + + + + + a #SoupURI + + + + name of the first form field to encode into query + + + + value of @first_field, followed by additional field names +and values, terminated by %NULL. + + + + + + Sets @uri's query to the result of encoding @form according to the +HTML form rules. See soup_form_encode_hash() for more information. + + + + + + + a #SoupURI + + + + a #GHashTable containing HTML form +information + + + + + + + + + Sets @uri's scheme to @scheme. This will also set @uri's port to +the default port for @scheme, if known. + + + + + + + a #SoupURI + + + + the URI scheme + + + + + + Sets @uri's user to @user. + + + + + + + a #SoupURI + + + + the username, or %NULL + + + + + + Returns a string representing @uri. + +If @just_path_and_query is %TRUE, this concatenates the path and query +together. That is, it constructs the string that would be needed in +the Request-Line of an HTTP request for @uri. + +Note that the output will never contain a password, even if @uri +does. + + + a string representing @uri, which the caller must free. + + + + + a #SoupURI + + + + if %TRUE, output just the path and query portions + + + + + + Tests if @uri uses the default port for its scheme. (Eg, 80 for +http.) (This only works for http, https and ftp; libsoup does not know +the default ports of other protocols.) + + + %TRUE or %FALSE + + + + + a #SoupURI + + + + + + Fully %<!-- -->-decodes @part. + +In the past, this would return %NULL if @part contained invalid +percent-encoding, but now it just ignores the problem (as +soup_uri_new() already did). + + + the decoded URI part. + + + + + a URI part + + + + + + This %<!-- -->-encodes the given URI part and returns the escaped +version in allocated memory, which the caller must free when it is +done. + + + the encoded URI part + + + + + a URI part + + + + additional reserved characters to +escape (or %NULL) + + + + + + %<!-- -->-decodes any "unreserved" characters (or characters in +@unescape_extra) in @part, and %<!-- -->-encodes any non-ASCII +characters, spaces, and non-printing characters in @part. + +"Unreserved" characters are those that are not allowed to be used +for punctuation according to the URI spec. For example, letters are +unreserved, so soup_uri_normalize() will turn +<literal>http://example.com/foo/b%<!-- -->61r</literal> into +<literal>http://example.com/foo/bar</literal>, which is guaranteed +to mean the same thing. However, "/" is "reserved", so +<literal>http://example.com/foo%<!-- -->2Fbar</literal> would not +be changed, because it might mean something different to the +server. + +In the past, this would return %NULL if @part contained invalid +percent-encoding, but now it just ignores the problem (as +soup_uri_new() already did). + + + the normalized URI part + + + + + a URI part + + + + reserved characters to unescape (or %NULL) + + + + + + + Tests whether @uri is a valid #SoupURI; that is, that it is non-%NULL +and its @scheme and @path members are also non-%NULL. + +This macro does not check whether http and https URIs have a non-%NULL +@host member. + + + + a #SoupURI + + + + + Tests if @uri is a valid #SoupURI for HTTP communication; that is, if +it can be used to construct a #SoupMessage. + + + + a #SoupURI + + + + + Extracts a value of type @type from @val into @args. The return +value will point to the same data as @val rather than being a copy +of it. + Use #GVariant API instead. + + + + a #GValue + + + a #GType + + + #va_list pointing to a value of type pointer-to-@type + + + + + Copies an argument of type @type from @args into @val. @val will +point directly to the value in @args rather than copying it, so you +must g_value_copy() it if you want it to remain valid. + Use #GVariant API instead. + + + + a #GValue + + + a #GType + + + #va_list pointing to a value of type @type + + + + + A macro that should be defined by the user prior to including +libsoup.h. The definition should be one of the predefined libsoup +version macros: %SOUP_VERSION_2_24, %SOUP_VERSION_2_26, ... + +This macro defines the earliest version of libsoup that the package +is required to be able to compile against. + +If the compiler is configured to warn about the use of deprecated +functions, then using functions that were deprecated in version +%SOUP_VERSION_MIN_REQUIRED or earlier will cause warnings (but +using functions deprecated in later releases will not). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Pre-defined close codes that can be passed to +soup_websocket_connection_close() or received from +soup_websocket_connection_get_close_code(). (However, other codes +are also allowed.) + + a normal, non-error close + + + the client/server is going away + + + a protocol error occurred + + + the endpoint received data + of a type that it does not support. + + + reserved value indicating that + no close code was present; must not be sent. + + + reserved value indicating that + the connection was closed abnormally; must not be sent. + + + the endpoint received data that + was invalid (eg, non-UTF-8 data in a text message). + + + generic error code + indicating some sort of policy violation. + + + the endpoint received a message + that is too big to process. + + + the client is closing the + connection because the server failed to negotiate a required + extension. + + + the server is closing the + connection because it was unable to fulfill the request. + + + reserved value indicating that + the TLS handshake failed; must not be sent. + + + + A class representing a WebSocket connection. + + + Creates a #SoupWebsocketConnection on @stream. This should be +called after completing the handshake to begin using the WebSocket +protocol. + + + a new #SoupWebsocketConnection + + + + + a #GIOStream connected to the WebSocket server + + + + the URI of the connection + + + + the type of connection (client/side) + + + + the Origin of the client + + + + the subprotocol in use + + + + + + Creates a #SoupWebsocketConnection on @stream with the given active @extensions. +This should be called after completing the handshake to begin using the WebSocket +protocol. + + + a new #SoupWebsocketConnection + + + + + a #GIOStream connected to the WebSocket server + + + + the URI of the connection + + + + the type of connection (client/side) + + + + the Origin of the client + + + + the subprotocol in use + + + + a #GList of #SoupWebsocketExtension objects + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Close the connection in an orderly fashion. + +Note that until the #SoupWebsocketConnection::closed signal fires, the connection +is not yet completely closed. The close message is not even sent until the +main loop runs. + +The @code and @data are sent to the peer along with the close request. +If @code is %SOUP_WEBSOCKET_CLOSE_NO_STATUS a close message with no body +(without code and data) is sent. +Note that the @data must be UTF-8 valid. + + + + + + + the WebSocket + + + + close code + + + + close data + + + + + + Get the close code received from the WebSocket peer. + +This only becomes valid once the WebSocket is in the +%SOUP_WEBSOCKET_STATE_CLOSED state. The value will often be in the +#SoupWebsocketCloseCode enumeration, but may also be an application +defined close code. + + + the close code or zero. + + + + + the WebSocket + + + + + + Get the close data received from the WebSocket peer. + +This only becomes valid once the WebSocket is in the +%SOUP_WEBSOCKET_STATE_CLOSED state. The data may be freed once +the main loop is run, so copy it if you need to keep it around. + + + the close data or %NULL + + + + + the WebSocket + + + + + + Get the connection type (client/server) of the connection. + + + the connection type + + + + + the WebSocket + + + + + + Get the extensions chosen via negotiation with the peer. + + + a #GList of #SoupWebsocketExtension objects + + + + + + + the WebSocket + + + + + + Get the I/O stream the WebSocket is communicating over. + + + the WebSocket's I/O stream. + + + + + the WebSocket + + + + + + Gets the keepalive interval in seconds or 0 if disabled. + + + the keepalive interval. + + + + + the WebSocket + + + + + + Gets the maximum payload size allowed for incoming packets. + + + the maximum payload size. + + + + + the WebSocket + + + + + + Get the origin of the WebSocket. + + + the origin, or %NULL + + + + + the WebSocket + + + + + + Get the protocol chosen via negotiation with the peer. + + + the chosen protocol, or %NULL + + + + + the WebSocket + + + + + + Get the current state of the WebSocket. + + + the state + + + + + the WebSocket + + + + + + Get the URI of the WebSocket. + +For servers this represents the address of the WebSocket, and +for clients it is the address connected to. + + + the URI + + + + + the WebSocket + + + + + + Send a binary message to the peer. If @length is 0, @data may be %NULL. + +The message is queued to be sent and will be sent when the main loop +is run. + + + + + + + the WebSocket + + + + the message contents + + + + + + the length of @data + + + + + + Send a message of the given @type to the peer. Note that this method, +allows to send text messages containing %NULL characters. + +The message is queued to be sent and will be sent when the main loop +is run. + + + + + + + the WebSocket + + + + the type of message contents + + + + the message data as #GBytes + + + + + + Send a %NULL-terminated text (UTF-8) message to the peer. If you need +to send text messages containing %NULL characters use +soup_websocket_connection_send_message() instead. + +The message is queued to be sent and will be sent when the main loop +is run. + + + + + + + the WebSocket + + + + the message contents + + + + + + Sets the interval in seconds on when to send a ping message which will serve +as a keepalive message. If set to 0 the keepalive message is disabled. + + + + + + + the WebSocket + + + + the interval to send a ping message or 0 to disable it + + + + + + Sets the maximum payload size allowed for incoming packets. It +does not limit the outgoing packet size. + + + + + + + the WebSocket + + + + the maximum payload size + + + + + + The type of connection (client/server). + + + + List of #SoupWebsocketExtension objects that are active in the connection. + + + + The underlying IO stream the WebSocket is communicating +over. + +The input and output streams must be pollable streams. + + + + Interval in seconds on when to send a ping message which will +serve as a keepalive message. If set to 0 the keepalive message is +disabled. + + + + The maximum payload size for incoming packets the protocol expects +or 0 to not limit it. + + + + The client's Origin. + + + + The chosen protocol, or %NULL if a protocol was not agreed +upon. + + + + The current state of the WebSocket. + + + + The URI of the WebSocket. + +For servers this represents the address of the WebSocket, +and for clients it is the address connected to. + + + + + + + + + + Emitted when the connection has completely closed, either +due to an orderly close from the peer, one initiated via +soup_websocket_connection_close() or a fatal error +condition that caused a close. + +This signal will be emitted once. + + + + + + This signal will be emitted during an orderly close. + + + + + + Emitted when an error occurred on the WebSocket. This may +be fired multiple times. Fatal errors will be followed by +the #SoupWebsocketConnection::closed signal being emitted. + + + + + + the error that occured + + + + + + Emitted when we receive a message from the peer. + +As a convenience, the @message data will always be +NUL-terminated, but the NUL byte will not be included in +the length count. + + + + + + the type of message contents + + + + the message data + + + + + + Emitted when we receive a Pong frame (solicited or +unsolicited) from the peer. + +As a convenience, the @message data will always be +NUL-terminated, but the NUL byte will not be included in +the length count. + + + + + + the application data (if any) + + + + + + + The abstract base class for #SoupWebsocketConnection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The type of a #SoupWebsocketConnection. + + unknown/invalid connection + + + a client-side connection + + + a server-side connection + + + + The type of data contained in a #SoupWebsocketConnection::message +signal. + + UTF-8 text + + + binary data + + + + WebSocket-related errors. + + a generic error + + + attempted to handshake with a + server that does not appear to understand WebSockets. + + + the WebSocket handshake failed + because some detail was invalid (eg, incorrect accept key). + + + the WebSocket handshake failed + because the "Origin" header was not an allowed value. + + + + + + + + + + + + Configures @extension with the given @params + + + %TRUE if extension could be configured with the given parameters, or %FALSE otherwise + + + + + a #SoupWebsocketExtension + + + + either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER + + + + the parameters, or %NULL + + + + + + + + + Get the parameters strings to be included in the request header. If the extension +doesn't include any parameter in the request, this function returns %NULL. + + + a new allocated string with the parameters + + + + + a #SoupWebsocketExtension + + + + + + Get the parameters strings to be included in the response header. If the extension +doesn't include any parameter in the response, this function returns %NULL. + + + a new allocated string with the parameters + + + + + a #SoupWebsocketExtension + + + + + + Process a message after it's received. If the payload isn't changed the given +@payload is just returned, otherwise g_bytes_unref() is called on the given +@payload and a new #GBytes is returned with the new data. + +Extensions using reserved bits of the header will reset them in @header. + + + the message payload data, or %NULL in case of error + + + + + a #SoupWebsocketExtension + + + + the message header + + + + the payload data + + + + + + Process a message before it's sent. If the payload isn't changed the given +@payload is just returned, otherwise g_bytes_unref() is called on the given +@payload and a new #GBytes is returned with the new data. + +Extensions using reserved bits of the header will change them in @header. + + + the message payload data, or %NULL in case of error + + + + + a #SoupWebsocketExtension + + + + the message header + + + + the payload data + + + + + + Configures @extension with the given @params + + + %TRUE if extension could be configured with the given parameters, or %FALSE otherwise + + + + + a #SoupWebsocketExtension + + + + either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER + + + + the parameters, or %NULL + + + + + + + + + Get the parameters strings to be included in the request header. If the extension +doesn't include any parameter in the request, this function returns %NULL. + + + a new allocated string with the parameters + + + + + a #SoupWebsocketExtension + + + + + + Get the parameters strings to be included in the response header. If the extension +doesn't include any parameter in the response, this function returns %NULL. + + + a new allocated string with the parameters + + + + + a #SoupWebsocketExtension + + + + + + Process a message after it's received. If the payload isn't changed the given +@payload is just returned, otherwise g_bytes_unref() is called on the given +@payload and a new #GBytes is returned with the new data. + +Extensions using reserved bits of the header will reset them in @header. + + + the message payload data, or %NULL in case of error + + + + + a #SoupWebsocketExtension + + + + the message header + + + + the payload data + + + + + + Process a message before it's sent. If the payload isn't changed the given +@payload is just returned, otherwise g_bytes_unref() is called on the given +@payload and a new #GBytes is returned with the new data. + +Extensions using reserved bits of the header will change them in @header. + + + the message payload data, or %NULL in case of error + + + + + a #SoupWebsocketExtension + + + + the message header + + + + the payload data + + + + + + + + + + The class structure for the SoupWebsocketExtension. + + + the parent class + + + + + + + + + + %TRUE if extension could be configured with the given parameters, or %FALSE otherwise + + + + + a #SoupWebsocketExtension + + + + either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER + + + + the parameters, or %NULL + + + + + + + + + + + + + a new allocated string with the parameters + + + + + a #SoupWebsocketExtension + + + + + + + + + + a new allocated string with the parameters + + + + + a #SoupWebsocketExtension + + + + + + + + + + the message payload data, or %NULL in case of error + + + + + a #SoupWebsocketExtension + + + + the message header + + + + the payload data + + + + + + + + + + the message payload data, or %NULL in case of error + + + + + a #SoupWebsocketExtension + + + + the message header + + + + the payload data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The state of the WebSocket connection. + + the connection is ready to send messages + + + the connection is in the process of + closing down; messages may be received, but not sent + + + the connection is completely closed down + + + + + + + + + + + + + + + Pre-defined XML-RPC fault codes from <ulink +url="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</ulink>. +These are an extension, not part of the XML-RPC spec; you can't +assume servers will use them. + + request was not + well-formed + + + request was in + an unsupported encoding + + + request contained an invalid character + + + request was not + valid XML-RPC + + + method + not found + + + invalid + parameters + + + internal + error + + + start of reserved range for + application error codes + + + start of reserved range for + system error codes + + + start of reserved range for + transport error codes + + + + + + + + + + Opaque structure containing XML-RPC methodCall parameter values. +Can be parsed using soup_xmlrpc_params_parse() and freed with +soup_xmlrpc_params_free(). + + + Free a #SoupXMLRPCParams returned by soup_xmlrpc_parse_request(). + + + + + + + a SoupXMLRPCParams + + + + + + Parse method parameters returned by soup_xmlrpc_parse_request(). + +Deserialization details: + - If @signature is provided, &lt;int&gt; and &lt;i4&gt; can be deserialized + to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise + it will be deserialized to int32. If the value is out of range + for the target type it will return an error. + - &lt;struct&gt; will be deserialized to "a{sv}". @signature could define + another value type (e.g. "a{ss}"). + - &lt;array&gt; will be deserialized to "av". @signature could define + another element type (e.g. "as") or could be a tuple (e.g. "(ss)"). + - &lt;base64&gt; will be deserialized to "ay". + - &lt;string&gt; will be deserialized to "s". + - &lt;dateTime.iso8601&gt; will be deserialized to an unspecified variant + type. If @signature is provided it must have the generic "v" type, which + means there is no guarantee that it's actually a datetime that has been + received. soup_xmlrpc_variant_get_datetime() must be used to parse and + type check this special variant. + - @signature must not have maybes, otherwise an error is returned. + - Dictionaries must have string keys, otherwise an error is returned. + + + a new (non-floating) #GVariant, or %NULL + + + + + A #SoupXMLRPCParams + + + + A valid #GVariant type string, or %NULL + + + + + + + Adds @function to be executed from inside @async_context with the +default priority. Use this when you want to complete an action in +@async_context's main loop, as soon as possible. + + + a #GSource, which can be removed from @async_context +with g_source_destroy(). + + + + + the #GMainContext to dispatch the I/O +watch in, or %NULL for the default context + + + + the callback to invoke + + + + user data to pass to @function + + + + + + Adds an idle event as with g_idle_add(), but using the given +@async_context. + +If you want @function to run "right away", use +soup_add_completion(), since that sets a higher priority on the +#GSource than soup_add_idle() does. + + + a #GSource, which can be removed from @async_context +with g_source_destroy(). + + + + + the #GMainContext to dispatch the I/O +watch in, or %NULL for the default context + + + + the callback to invoke at idle time + + + + user data to pass to @function + + + + + + Adds an I/O watch as with g_io_add_watch(), but using the given +@async_context. + + + a #GSource, which can be removed from @async_context +with g_source_destroy(). + + + + + the #GMainContext to dispatch the I/O +watch in, or %NULL for the default context + + + + the #GIOChannel to watch + + + + the condition to watch for + + + + the callback to invoke when @condition occurs + + + + user data to pass to @function + + + + + + Adds a timeout as with g_timeout_add(), but using the given +@async_context. + + + a #GSource, which can be removed from @async_context +with g_source_destroy(). + + + + + the #GMainContext to dispatch the I/O +watch in, or %NULL for the default context + + + + the timeout interval, in milliseconds + + + + the callback to invoke at timeout time + + + + user data to pass to @function + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Like SOUP_CHECK_VERSION, but the check for soup_check_version is +at runtime instead of compile time. This is useful for compiling +against older versions of libsoup, but using features from newer +versions. + + + %TRUE if the version of the libsoup currently loaded +is the same as or newer than the passed-in version. + + + + + the major version to check + + + + the minor version to check + + + + the micro version to check + + + + + + Parses @header and returns a #SoupCookie. (If @header contains +multiple cookies, only the first one will be parsed.) + +If @header does not have "path" or "domain" attributes, they will +be defaulted from @origin. If @origin is %NULL, path will default +to "/", but domain will be left as %NULL. Note that this is not a +valid state for a #SoupCookie, and you will need to fill in some +appropriate string for the domain if you want to actually make use +of the cookie. + + + a new #SoupCookie, or %NULL if it could +not be parsed, or contained an illegal "domain" attribute for a +cookie originating from @origin. + + + + + a cookie string (eg, the value of a Set-Cookie header) + + + + origin of the cookie, or %NULL + + + + + + Frees @cookies. + + + + + + + a #GSList of #SoupCookie + + + + + + + + Parses @msg's Cookie request header and returns a #GSList of +#SoupCookie<!-- -->s. As the "Cookie" header, unlike "Set-Cookie", +only contains cookie names and values, none of the other +#SoupCookie fields will be filled in. (Thus, you can't generally +pass a cookie returned from this method directly to +soup_cookies_to_response().) + + + a #GSList +of #SoupCookie<!-- -->s, which can be freed with +soup_cookies_free(). + + + + + + + a #SoupMessage containing a "Cookie" request header + + + + + + Parses @msg's Set-Cookie response headers and returns a #GSList of +#SoupCookie<!-- -->s. Cookies that do not specify "path" or +"domain" attributes will have their values defaulted from @msg. + + + a #GSList +of #SoupCookie<!-- -->s, which can be freed with +soup_cookies_free(). + + + + + + + a #SoupMessage containing a "Set-Cookie" response header + + + + + + Serializes a #GSList of #SoupCookie into a string suitable for +setting as the value of the "Cookie" header. + + + the serialization of @cookies + + + + + a #GSList of #SoupCookie + + + + + + + + Adds the name and value of each cookie in @cookies to @msg's +"Cookie" request. (If @msg already has a "Cookie" request header, +these cookies will be appended to the cookies already present. Be +careful that you do not append the same cookies twice, eg, when +requeuing a message.) + + + + + + + a #GSList of #SoupCookie + + + + + + a #SoupMessage + + + + + + Appends a "Set-Cookie" response header to @msg for each cookie in +@cookies. (This is in addition to any other "Set-Cookie" headers +@msg may already have.) + + + + + + + a #GSList of #SoupCookie + + + + + + a #SoupMessage + + + + + + Decodes @form, which is an urlencoded dataset as defined in the +HTML 4.01 spec. + + + a hash +table containing the name/value pairs from @encoded_form, which you +can free with g_hash_table_destroy(). + + + + + + + + data of type "application/x-www-form-urlencoded" + + + + + + Decodes the "multipart/form-data" request in @msg; this is a +convenience method for the case when you have a single file upload +control in a form. (Or when you don't have any file upload +controls, but are still using "multipart/form-data" anyway.) Pass +the name of the file upload control in @file_control_name, and +soup_form_decode_multipart() will extract the uploaded file data +into @filename, @content_type, and @file. All of the other form +control data will be returned (as strings, as with +soup_form_decode()) in the returned #GHashTable. + +You may pass %NULL for @filename, @content_type and/or @file if you do not +care about those fields. soup_form_decode_multipart() may also +return %NULL in those fields if the client did not provide that +information. You must free the returned filename and content-type +with g_free(), and the returned file data with soup_buffer_free(). + +If you have a form with more than one file upload control, you will +need to decode it manually, using soup_multipart_new_from_message() +and soup_multipart_get_part(). + + + +a hash table containing the name/value pairs (other than +@file_control_name) from @msg, which you can free with +g_hash_table_destroy(). On error, it will return %NULL. + + + + + + + + a #SoupMessage containing a "multipart/form-data" request body + + + + the name of the HTML file upload control, or %NULL + + + + return location for the name of the uploaded file, or %NULL + + + + return location for the MIME type of the uploaded file, or %NULL + + + + return location for the uploaded file data, or %NULL + + + + + + Encodes the given field names and values into a value of type +"application/x-www-form-urlencoded", as defined in the HTML 4.01 +spec. + +This method requires you to know the names of the form fields (or +at the very least, the total number of fields) at compile time; for +working with dynamic forms, use soup_form_encode_hash() or +soup_form_encode_datalist(). + + + the encoded form + + + + + name of the first form field + + + + value of @first_field, followed by additional field names +and values, terminated by %NULL. + + + + + + Encodes @form_data_set into a value of type +"application/x-www-form-urlencoded", as defined in the HTML 4.01 +spec. Unlike soup_form_encode_hash(), this preserves the ordering +of the form elements, which may be required in some situations. + + + the encoded form + + + + + a datalist containing name/value pairs + + + + + + Encodes @form_data_set into a value of type +"application/x-www-form-urlencoded", as defined in the HTML 4.01 +spec. + +Note that the HTML spec states that "The control names/values are +listed in the order they appear in the document." Since this method +takes a hash table, it cannot enforce that; if you care about the +ordering of the form fields, use soup_form_encode_datalist(). + + + the encoded form + + + + + a hash table containing +name/value pairs (as strings) + + + + + + + + + See soup_form_encode(). This is mostly an internal method, used by +various other methods such as soup_uri_set_query_from_fields() and +soup_form_request_new(). + + + the encoded form + + + + + name of the first form field + + + + pointer to additional values, as in soup_form_encode() + + + + + + Creates a new %SoupMessage and sets it up to send the given data +to @uri via @method. (That is, if @method is "GET", it will encode +the form data into @uri's query field, and if @method is "POST", it +will encode it into the %SoupMessage's request_body.) + + + the new %SoupMessage + + + + + the HTTP method, either "GET" or "POST" + + + + the URI to send the form data to + + + + name of the first form field + + + + value of @first_field, followed by additional field names +and values, terminated by %NULL. + + + + + + Creates a new %SoupMessage and sets it up to send @form_data_set to +@uri via @method, as with soup_form_request_new(). + + + the new %SoupMessage + + + + + the HTTP method, either "GET" or "POST" + + + + the URI to send the form data to + + + + the data to send to @uri + + + + + + Creates a new %SoupMessage and sets it up to send @form_data_set to +@uri via @method, as with soup_form_request_new(). + + + the new %SoupMessage + + + + + the HTTP method, either "GET" or "POST" + + + + the URI to send the form data to + + + + the data to send to @uri + + + + + + + + + Creates a new %SoupMessage and sets it up to send @multipart to +@uri via POST. + +To send a <literal>"multipart/form-data"</literal> POST, first +create a #SoupMultipart, using %SOUP_FORM_MIME_TYPE_MULTIPART as +the MIME type. Then use soup_multipart_append_form_string() and +soup_multipart_append_form_file() to add the value of each form +control to the multipart. (These are just convenience methods, and +you can use soup_multipart_append_part() if you need greater +control over the part headers.) Finally, call +soup_form_request_new_from_multipart() to serialize the multipart +structure and create a #SoupMessage. + + + the new %SoupMessage + + + + + the URI to send the form data to + + + + a "multipart/form-data" #SoupMultipart + + + + + + Returns the major version number of the libsoup library. +(e.g. in libsoup version 2.42.0 this is 2.) + +This function is in the library, so it represents the libsoup library +your code is running against. Contrast with the #SOUP_MAJOR_VERSION +macro, which represents the major version of the libsoup headers you +have included when compiling your code. + + + the major version number of the libsoup library + + + + + Returns the micro version number of the libsoup library. +(e.g. in libsoup version 2.42.0 this is 0.) + +This function is in the library, so it represents the libsoup library +your code is running against. Contrast with the #SOUP_MICRO_VERSION +macro, which represents the micro version of the libsoup headers you +have included when compiling your code. + + + the micro version number of the libsoup library + + + + + Returns the minor version number of the libsoup library. +(e.g. in libsoup version 2.42.0 this is 42.) + +This function is in the library, so it represents the libsoup library +your code is running against. Contrast with the #SOUP_MINOR_VERSION +macro, which represents the minor version of the libsoup headers you +have included when compiling your code. + + + the minor version number of the libsoup library + + + + + + + + + + + Parses @header to see if it contains the token @token (matched +case-insensitively). Note that this can't be used with lists +that have qvalues. + + + whether or not @header contains @token + + + + + An HTTP header suitable for parsing with +soup_header_parse_list() + + + + a token + + + + + + Frees @list. + + + + + + + a #GSList returned from soup_header_parse_list() or +soup_header_parse_quality_list() + + + + + + + + Frees @param_list. + + + + + + + a #GHashTable returned from soup_header_parse_param_list() +or soup_header_parse_semi_param_list() + + + + + + + + + Appends something like <literal>@name=@value</literal> to @string, +taking care to quote @value if needed, and if so, to escape any +quotes or backslashes in @value. + +Alternatively, if @value is a non-ASCII UTF-8 string, it will be +appended using RFC5987 syntax. Although in theory this is supposed +to work anywhere in HTTP that uses this style of parameter, in +reality, it can only be used portably with the Content-Disposition +"filename" parameter. + +If @value is %NULL, this will just append @name to @string. + + + + + + + a #GString being used to construct an HTTP header value + + + + a parameter name + + + + a parameter value, or %NULL + + + + + + Appends something like <literal>@name="@value"</literal> to +@string, taking care to escape any quotes or backslashes in @value. + +If @value is (non-ASCII) UTF-8, this will instead use RFC 5987 +encoding, just like soup_header_g_string_append_param(). + + + + + + + a #GString being used to construct an HTTP header value + + + + a parameter name + + + + a parameter value + + + + + + Parses a header whose content is described by RFC2616 as +"#something", where "something" does not itself contain commas, +except as part of quoted-strings. + + + a #GSList of +list elements, as allocated strings + + + + + + + a header value + + + + + + Parses a header which is a comma-delimited list of something like: +<literal>token [ "=" ( token | quoted-string ) ]</literal>. + +Tokens that don't have an associated value will still be added to +the resulting hash table, but with a %NULL value. + +This also handles RFC5987 encoding (which in HTTP is mostly used +for giving UTF8-encoded filenames in the Content-Disposition +header). + + + a +#GHashTable of list elements, which can be freed with +soup_header_free_param_list(). + + + + + + + + a header value + + + + + + A strict version of soup_header_parse_param_list() +that bails out if there are duplicate parameters. +Note that this function will treat RFC5987-encoded +parameters as duplicated if an ASCII version is also +present. For header fields that might contain +RFC5987-encoded parameters, use +soup_header_parse_param_list() instead. + + + +a #GHashTable of list elements, which can be freed with +soup_header_free_param_list() or %NULL if there are duplicate +elements. + + + + + + + + a header value + + + + + + Parses a header whose content is a list of items with optional +"qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding, +Accept-Language, TE). + +If @unacceptable is not %NULL, then on return, it will contain the +items with qvalue 0. Either way, those items will be removed from +the main list. + + + a #GSList of +acceptable values (as allocated strings), highest-qvalue first. + + + + + + + a header value + + + + on +return, will contain a list of unacceptable values + + + + + + + + Parses a header which is a semicolon-delimited list of something +like: <literal>token [ "=" ( token | quoted-string ) ]</literal>. + +Tokens that don't have an associated value will still be added to +the resulting hash table, but with a %NULL value. + +This also handles RFC5987 encoding (which in HTTP is mostly used +for giving UTF8-encoded filenames in the Content-Disposition +header). + + + a +#GHashTable of list elements, which can be freed with +soup_header_free_param_list(). + + + + + + + + a header value + + + + + + A strict version of soup_header_parse_semi_param_list() +that bails out if there are duplicate parameters. +Note that this function will treat RFC5987-encoded +parameters as duplicated if an ASCII version is also +present. For header fields that might contain +RFC5987-encoded parameters, use +soup_header_parse_semi_param_list() instead. + + + +a #GHashTable of list elements, which can be freed with +soup_header_free_param_list() or %NULL if there are duplicate +elements. + + + + + + + + a header value + + + + + + Parses the headers of an HTTP request or response in @str and +stores the results in @dest. Beware that @dest may be modified even +on failure. + +This is a low-level method; normally you would use +soup_headers_parse_request() or soup_headers_parse_response(). + + + success or failure + + + + + the header string (including the Request-Line or Status-Line, + but not the trailing blank line) + + + + length of @str + + + + #SoupMessageHeaders to store the header values in + + + + + + Parses the headers of an HTTP request in @str and stores the +results in @req_method, @req_path, @ver, and @req_headers. + +Beware that @req_headers may be modified even on failure. + + + %SOUP_STATUS_OK if the headers could be parsed, or an +HTTP error to be returned to the client if they could not be. + + + + + the headers (up to, but not including, the trailing blank line) + + + + length of @str + + + + #SoupMessageHeaders to store the header values in + + + + if non-%NULL, will be filled in with the +request method + + + + if non-%NULL, will be filled in with the +request path + + + + if non-%NULL, will be filled in with the HTTP +version + + + + + + Parses the headers of an HTTP response in @str and stores the +results in @ver, @status_code, @reason_phrase, and @headers. + +Beware that @headers may be modified even on failure. + + + success or failure. + + + + + the headers (up to, but not including, the trailing blank line) + + + + length of @str + + + + #SoupMessageHeaders to store the header values in + + + + if non-%NULL, will be filled in with the HTTP +version + + + + if non-%NULL, will be filled in with +the status code + + + + if non-%NULL, will be filled in with +the reason phrase + + + + + + Parses the HTTP Status-Line string in @status_line into @ver, +@status_code, and @reason_phrase. @status_line must be terminated by +either "\0" or "\r\n". + + + %TRUE if @status_line was parsed successfully. + + + + + an HTTP Status-Line + + + + if non-%NULL, will be filled in with the HTTP +version + + + + if non-%NULL, will be filled in with +the status code + + + + if non-%NULL, will be filled in with +the reason phrase + + + + + + + + + + + Initializes @iter for iterating @hdrs. + + + + + + + a pointer to a %SoupMessageHeadersIter +structure + + + + a %SoupMessageHeaders + + + + + + + + + + + + + + + + #SoupAddress represents the address of a TCP connection endpoint: +both the IP address and the port. (It is somewhat like an +object-oriented version of struct sockaddr.) + +Although #SoupAddress is still used in some libsoup API's, it +should not be used in new code; use GLib's #GNetworkAddress or +#GSocketAddress instead. + + + #SoupAuth objects store the authentication data associated with a +given bit of web space. They are created automatically by +#SoupSession. + + + A #SoupAuthDomain manages authentication for all or part of a +#SoupServer. To make a server require authentication, first create +an appropriate subclass of #SoupAuthDomain, and then add it to the +server with soup_server_add_auth_domain(). + +In order for an auth domain to have any effect, you must add one or +more paths to it (via soup_auth_domain_add_path() or the +%SOUP_AUTH_DOMAIN_ADD_PATH property). To require authentication for +all ordinary requests, add the path "/". (Note that this does not +include the special "*" URI (eg, "OPTIONS *"), which must be added +as a separate path if you want to cover it.) + +If you need greater control over which requests should and +shouldn't be authenticated, add paths covering everything you +<emphasis>might</emphasis> want authenticated, and then use a +filter (soup_auth_domain_set_filter()) to bypass authentication for +those requests that don't need it. + + + #SoupAuthDomainBasic handles the server side of HTTP "Basic" (ie, +cleartext password) authentication. + + + #SoupAuthDomainDigest handles the server side of HTTP "Digest" +authentication. + + + #SoupAuthManager is the #SoupSessionFeature that handles HTTP +authentication for a #SoupSession. + +A #SoupAuthManager is added to the session by default, and normally +you don't need to worry about it at all. However, if you want to +disable HTTP authentication, you can remove the feature from the +session with soup_session_remove_feature_by_type(), or disable it on +individual requests with soup_message_disable_feature(). + + + #SoupCache implements a file-based cache for HTTP resources. + + + #SoupContentDecoder handles adding the "Accept-Encoding" header on outgoing messages, and processing the "Content-Encoding" header on incoming ones. Currently it supports the "gzip", "deflate", and "br" content codings. @@ -3121,746 +29093,30 @@ not be set). (Note that currently there is no way to (automatically) use Content-Encoding when sending a request body, or to pick specific encoding types to support.) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A #SoupContentSniffer tries to detect the actual content type of + + + A #SoupContentSniffer tries to detect the actual content type of the files that are being downloaded by looking at some of the data before the #SoupMessage emits its #SoupMessage::got-headers signal. #SoupContentSniffer implements #SoupSessionFeature, so you can add content sniffing to a session with soup_session_add_feature() or soup_session_add_feature_by_type(). - - - Creates a new #SoupContentSniffer. - - a new #SoupContentSniffer - - - - - Gets the number of bytes @sniffer needs in order to properly sniff -a buffer. - - the number of bytes to sniff - - - - - a #SoupContentSniffer - - - - - - Sniffs @buffer to determine its Content-Type. The result may also -be influenced by the Content-Type declared in @msg's response -headers. - - the sniffed Content-Type of @buffer; this will never be %NULL, - but may be "application/octet-stream". - - - - - a #SoupContentSniffer - - - - the message to sniff - - - - a buffer containing the start of @msg's response body - - - - return - location for Content-Type parameters (eg, "charset"), or %NULL - - - - - - - - - Gets the number of bytes @sniffer needs in order to properly sniff -a buffer. - - the number of bytes to sniff - - - - - a #SoupContentSniffer - - - - - - Sniffs @buffer to determine its Content-Type. The result may also -be influenced by the Content-Type declared in @msg's response -headers. - - the sniffed Content-Type of @buffer; this will never be %NULL, - but may be "application/octet-stream". - - - - - a #SoupContentSniffer - - - - the message to sniff - - - - a buffer containing the start of @msg's response body - - - - return - location for Content-Type parameters (eg, "charset"), or %NULL - - - - - - - - - - - - - - - - - - - - - - the sniffed Content-Type of @buffer; this will never be %NULL, - but may be "application/octet-stream". - - - - - a #SoupContentSniffer - - - - the message to sniff - - - - a buffer containing the start of @msg's response body - - - - return - location for Content-Type parameters (eg, "charset"), or %NULL - - - - - - - - - - - - the number of bytes to sniff - - - - - a #SoupContentSniffer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupCookie implements HTTP cookies, as described by <ulink + + + #SoupCookie implements HTTP cookies, as described by <ulink url="http://tools.ietf.org/html/rfc6265.txt">RFC 6265</ulink>. To have a #SoupSession handle cookies for your appliction automatically, use a #SoupCookieJar. - - the cookie name - - - - the cookie value - - - - the "domain" attribute, or else the hostname that the -cookie came from. - - - - the "path" attribute, or %NULL - - - - the cookie expiration time, or %NULL for a session cookie - - - - %TRUE if the cookie should only be tranferred over SSL - - - - %TRUE if the cookie should not be exposed to scripts - - - - Creates a new #SoupCookie with the given attributes. (Use -soup_cookie_set_secure() and soup_cookie_set_http_only() if you -need to set those attributes on the returned cookie.) - -If @domain starts with ".", that indicates a domain (which matches -the string after the ".", or any hostname that has @domain as a -suffix). Otherwise, it is a hostname and must match exactly. - -@max_age is used to set the "expires" attribute on the cookie; pass --1 to not include the attribute (indicating that the cookie expires -with the current session), 0 for an already-expired cookie, or a -lifetime in seconds. You can use the constants -%SOUP_COOKIE_MAX_AGE_ONE_HOUR, %SOUP_COOKIE_MAX_AGE_ONE_DAY, -%SOUP_COOKIE_MAX_AGE_ONE_WEEK and %SOUP_COOKIE_MAX_AGE_ONE_YEAR (or -multiples thereof) to calculate this value. (If you really care -about setting the exact time that the cookie will expire, use -soup_cookie_set_expires().) - - a new #SoupCookie. - - - - - cookie name - - - - cookie value - - - - cookie domain or hostname - - - - cookie path, or %NULL - - - - max age of the cookie, or -1 for a session cookie - - - - - - Tests if @cookie should be sent to @uri. - -(At the moment, this does not check that @cookie's domain matches -@uri, because it assumes that the caller has already done that. -But don't rely on that; it may change in the future.) - - %TRUE if @cookie should be sent to @uri, %FALSE if -not - - - - - a #SoupCookie - - - - a #SoupURI - - - - - - Copies @cookie. - - a copy of @cookie - - - - - a #SoupCookie - - - - - - Checks if the @cookie's domain and @host match in the sense that -@cookie should be sent when making a request to @host, or that -@cookie should be accepted when receiving a response from @host. - - %TRUE if the domains match, %FALSE otherwise - - - - - a #SoupCookie - - - - a URI - - - - - - Tests if @cookie1 and @cookie2 are equal. - -Note that currently, this does not check that the cookie domains -match. This may change in the future. - - whether the cookies are equal. - - - - - a #SoupCookie - - - - a #SoupCookie - - - - - - Frees @cookie - - - - - - a #SoupCookie - - - - - - Gets @cookie's domain - - @cookie's domain - - - - - a #SoupCookie - - - - - - Gets @cookie's expiration time. - - @cookie's expiration -time, which is owned by @cookie and should not be modified or -freed. - - - - - a #SoupCookie - - - - - - Gets @cookie's HttpOnly attribute - - @cookie's HttpOnly attribute - - - - - a #SoupCookie - - - - - - Gets @cookie's name - - @cookie's name - - - - - a #SoupCookie - - - - - - Gets @cookie's path - - @cookie's path - - - - - a #SoupCookie - - - - - - - a #SoupSameSitePolicy - - - - - a #SoupCookie - - - - - - Gets @cookie's secure attribute - - @cookie's secure attribute - - - - - a #SoupCookie - - - - - - Gets @cookie's value - - @cookie's value - - - - - a #SoupCookie - - - - - - Sets @cookie's domain to @domain - - - - - - a #SoupCookie - - - - the new domain - - - - - - Sets @cookie's expiration time to @expires. If @expires is %NULL, -@cookie will be a session cookie and will expire at the end of the -client's session. - -(This sets the same property as soup_cookie_set_max_age().) - - - - - - a #SoupCookie - - - - the new expiration time, or %NULL - - - - - - Sets @cookie's HttpOnly attribute to @http_only. If %TRUE, @cookie -will be marked as "http only", meaning it should not be exposed to -web page scripts or other untrusted code. - - - - - - a #SoupCookie - - - - the new value for the HttpOnly attribute - - - - - - Sets @cookie's max age to @max_age. If @max_age is -1, the cookie -is a session cookie, and will expire at the end of the client's -session. Otherwise, it is the number of seconds until the cookie -expires. You can use the constants %SOUP_COOKIE_MAX_AGE_ONE_HOUR, -%SOUP_COOKIE_MAX_AGE_ONE_DAY, %SOUP_COOKIE_MAX_AGE_ONE_WEEK and -%SOUP_COOKIE_MAX_AGE_ONE_YEAR (or multiples thereof) to calculate -this value. (A value of 0 indicates that the cookie should be -considered already-expired.) - -(This sets the same property as soup_cookie_set_expires().) - - - - - - a #SoupCookie - - - - the new max age - - - - - - Sets @cookie's name to @name - - - - - - a #SoupCookie - - - - the new name - - - - - - Sets @cookie's path to @path - - - - - - a #SoupCookie - - - - the new path - - - - - - When used in conjunction with soup_cookie_jar_get_cookie_list_with_same_site_info() this -sets the policy of when this cookie should be exposed. - - - - - - a #SoupCookie - - - - a #SoupSameSitePolicy - - - - - - Sets @cookie's secure attribute to @secure. If %TRUE, @cookie will -only be transmitted from the client to the server over secure -(https) connections. - - - - - - a #SoupCookie - - - - the new value for the secure attribute - - - - - - Sets @cookie's value to @value - - - - - - a #SoupCookie - - - - the new value - - - - - - Serializes @cookie in the format used by the Cookie header (ie, for -returning a cookie from a #SoupSession to a server). - - the header - - - - - a #SoupCookie - - - - - - Serializes @cookie in the format used by the Set-Cookie header -(ie, for sending a cookie from a #SoupServer to a client). - - the header - - - - - a #SoupCookie - - - - - - Parses @header and returns a #SoupCookie. (If @header contains -multiple cookies, only the first one will be parsed.) - -If @header does not have "path" or "domain" attributes, they will -be defaulted from @origin. If @origin is %NULL, path will default -to "/", but domain will be left as %NULL. Note that this is not a -valid state for a #SoupCookie, and you will need to fill in some -appropriate string for the domain if you want to actually make use -of the cookie. - - a new #SoupCookie, or %NULL if it could -not be parsed, or contained an illegal "domain" attribute for a -cookie originating from @origin. - - - - - a cookie string (eg, the value of a Set-Cookie header) - - - - origin of the cookie, or %NULL - - - - - - - A #SoupCookieJar stores #SoupCookie<!-- -->s and arrange for them + + + A #SoupCookieJar stores #SoupCookie<!-- -->s and arrange for them to be sent with the appropriate #SoupMessage<!-- -->s. #SoupCookieJar implements #SoupSessionFeature, so you can add a cookie jar to a session with soup_session_add_feature() or @@ -3868,1203 +29124,35 @@ soup_session_add_feature_by_type(). Note that the base #SoupCookieJar class does not support any form of long-term cookie persistence. - - - Creates a new #SoupCookieJar. The base #SoupCookieJar class does -not support persistent storage of cookies; use a subclass for that. - - a new #SoupCookieJar - - - - - - - - - - - - - - - - - - - - - Gets whether @jar stores cookies persistenly. - - %TRUE if @jar storage is persistent or %FALSE otherwise. - - - - - a #SoupCookieJar - - - - - - This function exists for backward compatibility, but does not do -anything any more; cookie jars are saved automatically when they -are changed. - This is a no-op. - - - - - - a #SoupCookieJar - - - - - - Adds @cookie to @jar, emitting the 'changed' signal if we are modifying -an existing cookie or adding a valid new cookie ('valid' means -that the cookie's expire date is not in the past). - -@cookie will be 'stolen' by the jar, so don't free it afterwards. - - - - - - a #SoupCookieJar - - - - a #SoupCookie - - - - - - Adds @cookie to @jar, emitting the 'changed' signal if we are modifying -an existing cookie or adding a valid new cookie ('valid' means -that the cookie's expire date is not in the past). - -@first_party will be used to reject cookies coming from third party -resources in case such a security policy is set in the @jar. - -@uri will be used to reject setting or overwriting secure cookies -from insecure origins. %NULL is treated as secure. - -@cookie will be 'stolen' by the jar, so don't free it afterwards. - - - - - - a #SoupCookieJar - - - - a #SoupCookie - - - - the URI setting the cookie - - - - the URI for the main document - - - - - - Adds @cookie to @jar, emitting the 'changed' signal if we are modifying -an existing cookie or adding a valid new cookie ('valid' means -that the cookie's expire date is not in the past). - -@first_party will be used to reject cookies coming from third party -resources in case such a security policy is set in the @jar. - -@cookie will be 'stolen' by the jar, so don't free it afterwards. - -For secure cookies to work properly you may want to use -soup_cookie_jar_add_cookie_full(). - - - - - - a #SoupCookieJar - - - - the URI for the main document - - - - a #SoupCookie - - - - - - Constructs a #GSList with every cookie inside the @jar. -The cookies in the list are a copy of the original, so -you have to free them when you are done with them. - - a #GSList -with all the cookies in the @jar. - - - - - - - a #SoupCookieJar - - - - - - Deletes @cookie from @jar, emitting the 'changed' signal. - - - - - - a #SoupCookieJar - - - - a #SoupCookie - - - - - - Gets @jar's #SoupCookieJarAcceptPolicy - - the #SoupCookieJarAcceptPolicy set in the @jar - - - - - a #SoupCookieJar - - - - - - Retrieves the list of cookies that would be sent with a request to @uri -as a #GSList of #SoupCookie objects. - -If @for_http is %TRUE, the return value will include cookies marked -"HttpOnly" (that is, cookies that the server wishes to keep hidden -from client-side scripting operations such as the JavaScript -document.cookies property). Since #SoupCookieJar sets the Cookie -header itself when making the actual HTTP request, you should -almost certainly be setting @for_http to %FALSE if you are calling -this. - - a #GSList -with the cookies in the @jar that would be sent with a request to @uri. - - - - - - - a #SoupCookieJar - - - - a #SoupURI - - - - whether or not the return value is being passed directly -to an HTTP operation - - - - - - This is an extended version of soup_cookie_jar_get_cookie_list() that -provides more information required to use SameSite cookies. See the -[SameSite cookies spec](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00) -for more detailed information. - - a #GSList -with the cookies in the @jar that would be sent with a request to @uri. - - - - - - - a #SoupCookieJar - - - - a #SoupURI - - - - a #SoupURI for the top level document - - - - a #SoupURI indicating the origin to get cookies for - - - - whether or not the return value is being passed directly -to an HTTP operation - - - - if the HTTP method is safe, as defined by RFC 7231, ignored when @for_http is %FALSE - - - - whether or not the HTTP request is part of -top level navigation - - - - - - Retrieves (in Cookie-header form) the list of cookies that would -be sent with a request to @uri. - -If @for_http is %TRUE, the return value will include cookies marked -"HttpOnly" (that is, cookies that the server wishes to keep hidden -from client-side scripting operations such as the JavaScript -document.cookies property). Since #SoupCookieJar sets the Cookie -header itself when making the actual HTTP request, you should -almost certainly be setting @for_http to %FALSE if you are calling -this. - - the cookies, in string form, or %NULL if -there are no cookies for @uri. - - - - - a #SoupCookieJar - - - - a #SoupURI - - - - whether or not the return value is being passed directly -to an HTTP operation - - - - - - Gets whether @jar stores cookies persistenly. - - %TRUE if @jar storage is persistent or %FALSE otherwise. - - - - - a #SoupCookieJar - - - - - - This function exists for backward compatibility, but does not do -anything any more; cookie jars are saved automatically when they -are changed. - This is a no-op. - - - - - - a #SoupCookieJar - - - - - - Sets @policy as the cookie acceptance policy for @jar. - - - - - - a #SoupCookieJar - - - - a #SoupCookieJarAcceptPolicy - - - - - - Adds @cookie to @jar, exactly as though it had appeared in a -Set-Cookie header returned from a request to @uri. - -Keep in mind that if the #SoupCookieJarAcceptPolicy set is either -%SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY or -%SOUP_COOKIE_JAR_ACCEPT_GRANDFATHERED_THIRD_PARTY you'll need to use -soup_cookie_jar_set_cookie_with_first_party(), otherwise the jar -will have no way of knowing if the cookie is being set by a third -party or not. - - - - - - a #SoupCookieJar - - - - the URI setting the cookie - - - - the stringified cookie to set - - - - - - Adds @cookie to @jar, exactly as though it had appeared in a -Set-Cookie header returned from a request to @uri. @first_party -will be used to reject cookies coming from third party resources in -case such a security policy is set in the @jar. - - - - - - a #SoupCookieJar - - - - the URI setting the cookie - - - - the URI for the main document - - - - the stringified cookie to set - - - - - - The policy the jar should follow to accept or reject cookies - - - - - - - - - - Emitted when @jar changes. If a cookie has been added, -@new_cookie will contain the newly-added cookie and -@old_cookie will be %NULL. If a cookie has been deleted, -@old_cookie will contain the to-be-deleted cookie and -@new_cookie will be %NULL. If a cookie has been changed, -@old_cookie will contain its old value, and @new_cookie its -new value. - - - - - - the old #SoupCookie value - - - - the new #SoupCookie value - - - - - - - The policy for accepting or rejecting cookies returned in -responses. - - accept all cookies unconditionally. - - - reject all cookies unconditionally. - - - accept all cookies set by -the main document loaded in the application using libsoup. An -example of the most common case, web browsers, would be: If -http://www.example.com is the page loaded, accept all cookies set -by example.com, but if a resource from http://www.third-party.com -is loaded from that page reject any cookie that it could try to -set. For libsoup to be able to tell apart first party cookies from -the rest, the application must call soup_message_set_first_party() -on each outgoing #SoupMessage, setting the #SoupURI of the main -document. If no first party is set in a message when this policy is -in effect, cookies will be assumed to be third party by default. - - - accept all cookies -set by the main document loaded in the application using libsoup, and -from domains that have previously set at least one cookie when loaded -as the main document. An example of the most common case, web browsers, -would be: if http://www.example.com is the page loaded, accept all -cookies set by example.com, but if a resource from http://www.third-party.com -is loaded from that page, reject any cookie that it could try to -set unless it already has a cookie in the cookie jar. For libsoup to -be able to tell apart first party cookies from the rest, the -application must call soup_message_set_first_party() on each outgoing -#SoupMessage, setting the #SoupURI of the main document. If no first -party is set in a message when this policy is in effect, cookies will -be assumed to be third party by default. Since 2.72. - - - - - - - - - - - - - - a #SoupCookieJar - - - - - - - - - %TRUE if @jar storage is persistent or %FALSE otherwise. - - - - - a #SoupCookieJar - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupCookieJarDB is a #SoupCookieJar that reads cookies from and + + + #SoupCookieJarDB is a #SoupCookieJar that reads cookies from and writes them to a sqlite database in the new Mozilla format. (This is identical to <literal>SoupCookieJarSqlite</literal> in libsoup-gnome; it has just been moved into libsoup proper, and renamed to avoid conflicting.) - - - Creates a #SoupCookieJarDB. - -@filename will be read in at startup to create an initial set of -cookies. If @read_only is %FALSE, then the non-session cookies will -be written to @filename when the 'changed' signal is emitted from -the jar. (If @read_only is %TRUE, then the cookie jar will only be -used for this session, and changes made to it will be lost when the -jar is destroyed.) - - the new #SoupCookieJar - - - - - the filename to read to/write from, or %NULL - - - - %TRUE if @filename is read-only - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupCookieJarText is a #SoupCookieJar that reads cookies from and + + + #SoupCookieJarText is a #SoupCookieJar that reads cookies from and writes them to a text file in the Mozilla "cookies.txt" format. - - - Creates a #SoupCookieJarText. - -@filename will be read in at startup to create an initial set of -cookies. If @read_only is %FALSE, then the non-session cookies will -be written to @filename when the 'changed' signal is emitted from -the jar. (If @read_only is %TRUE, then the cookie jar will only be -used for this session, and changes made to it will be lost when the -jar is destroyed.) - - the new #SoupCookieJar - - - - - the filename to read to/write from - - - - %TRUE if @filename is read-only - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A date and time. The date is assumed to be in the (proleptic) -Gregorian calendar. The time is in UTC if @utc is %TRUE. Otherwise, -the time is a local time, and @offset gives the offset from UTC in -minutes (such that adding @offset to the time would give the -correct UTC time). If @utc is %FALSE and @offset is 0, then the -%SoupDate represents a "floating" time with no associated timezone -information. - - the year, 1 to 9999 - - - - the month, 1 to 12 - - - - day of the month, 1 to 31 - - - - hour of the day, 0 to 23 - - - - minute, 0 to 59 - - - - second, 0 to 59 (or up to 61 in the case of leap seconds) - - - - %TRUE if the date is in UTC - - - - offset from UTC - - - - Creates a #SoupDate representing the indicated time, UTC. - - a new #SoupDate - - - - - the year (1-9999) - - - - the month (1-12) - - - - the day of the month (1-31, as appropriate for @month) - - - - the hour (0-23) - - - - the minute (0-59) - - - - the second (0-59, or up to 61 for leap seconds) - - - - - - Creates a #SoupDate representing a time @offset_seconds after the -current time (or before it, if @offset_seconds is negative). If -offset_seconds is 0, returns the current time. - -If @offset_seconds would indicate a time not expressible as a -<type>time_t</type>, the return value will be clamped into range. - - a new #SoupDate - - - - - offset from current time - - - - - - Parses @date_string and tries to extract a date from it. This -recognizes all of the "HTTP-date" formats from RFC 2616, all ISO -8601 formats containing both a time and a date, RFC 2822 dates, -and reasonable approximations thereof. (Eg, it is lenient about -whitespace, leading "0"s, etc.) - - a new #SoupDate, or %NULL if @date_string -could not be parsed. - - - - - the date in some plausible format - - - - - - Creates a #SoupDate corresponding to @when - - a new #SoupDate - - - - - a <type>time_t</type> - - - - - - Copies @date. - - - - - - a #SoupDate - - - - - - Frees @date. - - - - - - a #SoupDate - - - - - - Gets @date's day. - - @date's day - - - - - a #SoupDate - - - - - - Gets @date's hour. - - @date's hour - - - - - a #SoupDate - - - - - - Gets @date's minute. - - @date's minute - - - - - a #SoupDate - - - - - - Gets @date's month. - - @date's month - - - - - a #SoupDate - - - - - - Gets @date's offset from UTC. - - @date's offset from UTC. If soup_date_get_utc() -returns %FALSE but soup_date_get_offset() returns 0, that means the -date is a "floating" time with no associated offset information. - - - - - a #SoupDate - - - - - - Gets @date's second. - - @date's second - - - - - a #SoupDate - - - - - - Gets @date's UTC flag - - %TRUE if @date is UTC. - - - - - a #SoupDate - - - - - - Gets @date's year. - - @date's year - - - - - a #SoupDate - - - - - - Determines if @date is in the past. - - %TRUE if @date is in the past - - - - - a #SoupDate - - - - - - Converts @date to a string in the format described by @format. - - @date as a string - - - - - a #SoupDate - - - - the format to generate the date in - - - - - - Converts @date to a <type>time_t</type>, assumming it to be in -UTC. - -If @date is not representable as a <type>time_t</type>, it will be -clamped into range. (In particular, some HTTP cookies have -expiration dates after "Y2.038k" (2038-01-19T03:14:07Z).) - - @date as a <type>time_t</type> - - - - - a #SoupDate - - - - - - Converts @date to a #GTimeVal. - Do not use #GTimeVal, as it's not Y2038-safe. - - - - - - a #SoupDate - - - - a #GTimeVal structure in which to store the converted time. - - - - - - - Date formats that soup_date_to_string() can use. - -@SOUP_DATE_HTTP and @SOUP_DATE_COOKIE always coerce the time to -UTC. @SOUP_DATE_ISO8601_XMLRPC uses the time as given, ignoring the -offset completely. @SOUP_DATE_RFC2822 and the other ISO 8601 -variants use the local time, appending the offset information if -available. - -This enum may be extended with more values in future releases. - - RFC 1123 format, used by the HTTP "Date" header. Eg -"Sun, 06 Nov 1994 08:49:37 GMT" - - - The format for the "Expires" timestamp in the -Netscape cookie specification. Eg, "Sun, 06-Nov-1994 08:49:37 GMT". - - - RFC 2822 format, eg "Sun, 6 Nov 1994 09:49:37 -0100" - - - ISO 8601 date/time with no optional -punctuation. Eg, "19941106T094937-0100". - - - ISO 8601 date/time with all optional -punctuation. Eg, "1994-11-06T09:49:37-01:00". - - - An alias for @SOUP_DATE_ISO8601_FULL. - - - ISO 8601 date/time as used by XML-RPC. -Eg, "19941106T09:49:37". - - - - How a message body is encoded for transport - - unknown / error - - - no body is present (which is not the same as a -0-length body, and only occurs in certain places) - - - Content-Length encoding - - - Response body ends when the connection is closed - - - chunked encoding (currently only supported -for response) - - - multipart/byteranges (Reserved for future -use: NOT CURRENTLY IMPLEMENTED) - - - - Represents the parsed value of the "Expect" header. - - any unrecognized expectation - - - "100-continue" - - - - A macro containing the value -<literal>"multipart/form-data"</literal>; the MIME type used for -posting form data that contains files to be uploaded. - - - - A macro containing the value -<literal>"application/x-www-form-urlencoded"</literal>; the default -MIME type for POSTing HTML form data. - - - - A #SoupHSTSEnforcer stores HSTS policies and enforces them when + + + libsoup contains several help methods for processing HTML forms as +defined by <ulink +url="http://www.w3.org/TR/html401/interact/forms.html#h-17.13">the +HTML 4.01 specification</ulink>. + + + A #SoupHSTSEnforcer stores HSTS policies and enforces them when required. #SoupHSTSEnforcer implements #SoupSessionFeature, so you can add an HSTS enforcer to a session with soup_session_add_feature() or soup_session_add_feature_by_type(). @@ -5084,1267 +29172,26 @@ SoupMessage:uri in order to be aware of changes in the message URI. Note that #SoupHSTSEnforcer does not support any form of long-term HSTS policy persistence. See #SoupHSTSDBEnforcer for a persistent enforcer. - - - Creates a new #SoupHSTSEnforcer. The base #SoupHSTSEnforcer class -does not support persistent storage of HSTS policies, see -#SoupHSTSEnforcerDB for that. - - a new #SoupHSTSEnforcer - - - - - - - - - - - - - - - - - - - - - Gets whether @hsts_enforcer has a currently valid policy for @domain. - - %TRUE if access to @domain should happen over HTTPS, false -otherwise. - - - - - a #SoupHSTSEnforcer - - - - a domain. - - - - - - - - - - - - - - - - - - - Gets whether @hsts_enforcer stores policies persistenly. - - %TRUE if @hsts_enforcer storage is persistent or %FALSE otherwise. - - - - - a #SoupHSTSEnforcer - - - - - - Gets a list of domains for which there are policies in @enforcer. - - a newly allocated -list of domains. Use g_list_free_full() and g_free() to free the -list. - - - - - - - a #SoupHSTSEnforcer - - - - whether to include session policies - - - - - - Gets a list with the policies in @enforcer. - - a newly -allocated list of policies. Use g_list_free_full() and -soup_hsts_policy_free() to free the list. - - - - - - - a #SoupHSTSEnforcer - - - - whether to include session policies - - - - - - Gets whether @hsts_enforcer has a currently valid policy for @domain. - - %TRUE if access to @domain should happen over HTTPS, false -otherwise. - - - - - a #SoupHSTSEnforcer - - - - a domain. - - - - - - Gets whether @hsts_enforcer stores policies persistenly. - - %TRUE if @hsts_enforcer storage is persistent or %FALSE otherwise. - - - - - a #SoupHSTSEnforcer - - - - - - Sets @policy to @hsts_enforcer. If @policy is expired, any -existing HSTS policy for its host will be removed instead. If a -policy existed for this host, it will be replaced. Otherwise, the -new policy will be inserted. If the policy is a session policy, that -is, one created with soup_hsts_policy_new_session_policy(), the policy -will not expire and will be enforced during the lifetime of -@hsts_enforcer's #SoupSession. - - - - - - a #SoupHSTSEnforcer - - - - the policy of the HSTS host - - - - - - Sets a session policy for @domain. A session policy is a policy -that is permanent to the lifetime of @hsts_enforcer's #SoupSession -and doesn't expire. - - - - - - a #SoupHSTSEnforcer - - - - policy domain or hostname - - - - %TRUE if the policy applies on sub domains - - - - - - - - - - - - Emitted when @hsts_enforcer changes. If a policy has been added, -@new_policy will contain the newly-added policy and -@old_policy will be %NULL. If a policy has been deleted, -@old_policy will contain the to-be-deleted policy and -@new_policy will be %NULL. If a policy has been changed, -@old_policy will contain its old value, and @new_policy its -new value. - -Note that you shouldn't modify the policies from a callback to -this signal. - - - - - - the old #SoupHSTSPolicy value - - - - the new #SoupHSTSPolicy value - - - - - - Emitted when @hsts_enforcer has upgraded the protocol -for @message to HTTPS as a result of matching its domain with -a HSTS policy. - - - - - - the message for which HSTS is being enforced - - - - - - - - The parent class. - - - - - - %TRUE if @hsts_enforcer storage is persistent or %FALSE otherwise. - - - - - a #SoupHSTSEnforcer - - - - - - - - - %TRUE if access to @domain should happen over HTTPS, false -otherwise. - - - - - a #SoupHSTSEnforcer - - - - a domain. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupHSTSEnforcerDB is a #SoupHSTSEnforcer that uses a SQLite + + + #SoupHSTSEnforcerDB is a #SoupHSTSEnforcer that uses a SQLite database as a backend for persistency. - - - Creates a #SoupHSTSEnforcerDB. - -@filename will be read in during the initialization of a -#SoupHSTSEnforcerDB, in order to create an initial set of HSTS -policies. If the file doesn't exist, a new database will be created -and initialized. Changes to the policies during the lifetime of a -#SoupHSTSEnforcerDB will be written to @filename when -#SoupHSTSEnforcer::changed is emitted. - - the new #SoupHSTSEnforcer - - - - - the filename of the database to read/write from. - - - - - - The filename of the SQLite database where HSTS policies are stored. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupHSTSPolicy implements HTTP policies, as described by <ulink + + + #SoupHSTSPolicy implements HTTP policies, as described by <ulink url="http://tools.ietf.org/html/rfc6797">RFC 6797</ulink>. To have a #SoupSession handle HSTS policies for your appliction automatically, use a #SoupHSTSEnforcer. - - The domain or hostname that the policy applies to - - - - The maximum age, in seconds, that the policy is valid - - - - the policy expiration time, or %NULL for a permanent session policy - - - - %TRUE if the policy applies on subdomains - - - - Creates a new #SoupHSTSPolicy with the given attributes. - -@domain is a domain on which the strict transport security policy -represented by this object must be enforced. - -@max_age is used to set the "expires" attribute on the policy; pass -SOUP_HSTS_POLICY_MAX_AGE_PAST for an already-expired policy, or a -lifetime in seconds. - -If @include_subdomains is %TRUE, the strict transport security policy -must also be enforced on all subdomains of @domain. - - a new #SoupHSTSPolicy. - - - - - policy domain or hostname - - - - max age of the policy - - - - %TRUE if the policy applies on subdomains - - - - - - Parses @msg's first "Strict-Transport-Security" response header and -returns a #SoupHSTSPolicy. - - a new #SoupHSTSPolicy, or %NULL if no valid -"Strict-Transport-Security" response header was found. - - - - - a #SoupMessage - - - - - - Full version of #soup_hsts_policy_new(), to use with an existing -expiration date. See #soup_hsts_policy_new() for details. - - a new #SoupHSTSPolicy. - - - - - policy domain or hostname - - - - max age of the policy - - - - the date of expiration of the policy or %NULL for a permanent policy - - - - %TRUE if the policy applies on subdomains - - - - - - Creates a new session #SoupHSTSPolicy with the given attributes. -A session policy is a policy that is valid during the lifetime of -the #SoupHSTSEnforcer it is added to. Contrary to regular policies, -it has no expiration date and is not stored in persistent -enforcers. These policies are useful for user-agent to load their -own or user-defined rules. - -@domain is a domain on which the strict transport security policy -represented by this object must be enforced. - -If @include_subdomains is %TRUE, the strict transport security policy -must also be enforced on all subdomains of @domain. - - a new #SoupHSTSPolicy. - - - - - policy domain or hostname - - - - %TRUE if the policy applies on sub domains - - - - - - Copies @policy. - - a copy of @policy - - - - - a #SoupHSTSPolicy - - - - - - Tests if @policy1 and @policy2 are equal. - - whether the policies are equal. - - - - - a #SoupHSTSPolicy - - - - a #SoupHSTSPolicy - - - - - - Frees @policy. - - - - - - a #SoupHSTSPolicy - - - - - - Gets @policy's domain. - - @policy's domain. - - - - - a #SoupHSTSPolicy - - - - - - Gets whether @policy include its subdomains. - - %TRUE if @policy includes subdomains, %FALSE otherwise. - - - - - a #SoupHSTSPolicy - - - - - - Gets whether @policy is expired. Permanent policies never -expire. - - %TRUE if @policy is expired, %FALSE otherwise. - - - - - a #SoupHSTSPolicy - - - - - - Gets whether @policy is a non-permanent, non-expirable session policy. -see soup_hsts_policy_new_session_policy() for details. - - %TRUE if @policy is permanent, %FALSE otherwise - - - - - a #SoupHSTSPolicy - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates the HTTP protocol version being used. - - HTTP 1.0 (RFC 1945) - - - HTTP 1.1 (RFC 2616) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Alias for the #SoupLogger:level property, qv. - - - - Alias for the #SoupLogger:max-body-size property, qv. - - - - #SoupLogger watches a #SoupSession and logs the HTTP traffic that + + + #SoupLogger watches a #SoupSession and logs the HTTP traffic that it generates, for debugging purposes. Many applications use an environment variable to determine whether or not to use #SoupLogger, and to determine the amount of debugging output. @@ -6407,458 +29254,11 @@ If the response doesn't happen to trigger the due to, for example, a cancellation before receiving the last byte of the response body, the response will still be logged on the event of the #SoupMessage::finished signal. - - - Creates a new #SoupLogger with the given debug level. If @level is -%SOUP_LOGGER_LOG_BODY, @max_body_size gives the maximum number of -bytes of the body that will be logged. (-1 means "no limit".) - -If you need finer control over what message parts are and aren't -logged, use soup_logger_set_request_filter() and -soup_logger_set_response_filter(). - - a new #SoupLogger - - - - - the debug level - - - - the maximum body size to output, or -1 - - - - - - Sets @logger to watch @session and print debug information for -its messages. - -(The session will take a reference on @logger, which will be -removed when you call soup_logger_detach(), or when the session is -destroyed.) - Use soup_session_add_feature() instead. - - - - - - a #SoupLogger - - - - a #SoupSession - - - - - - Stops @logger from watching @session. - Use soup_session_remove_feature() instead. - - - - - - a #SoupLogger - - - - a #SoupSession - - - - - - Sets up an alternate log printing routine, if you don't want -the log to go to <literal>stdout</literal>. - - - - - - a #SoupLogger - - - - the callback for printing logging output - - - - data to pass to the callback - - - - a #GDestroyNotify to free @printer_data - - - - - - Sets up a filter to determine the log level for a given request. -For each HTTP request @logger will invoke @request_filter to -determine how much (if any) of that request to log. (If you do not -set a request filter, @logger will just always log requests at the -level passed to soup_logger_new().) - - - - - - a #SoupLogger - - - - the callback for request debugging - - - - data to pass to the callback - - - - a #GDestroyNotify to free @filter_data - - - - - - Sets up a filter to determine the log level for a given response. -For each HTTP response @logger will invoke @response_filter to -determine how much (if any) of that response to log. (If you do not -set a response filter, @logger will just always log responses at -the level passed to soup_logger_new().) - - - - - - a #SoupLogger - - - - the callback for response debugging - - - - data to pass to the callback - - - - a #GDestroyNotify to free @filter_data - - - - - - The level of logging output - - - - If #SoupLogger:level is %SOUP_LOGGER_LOG_BODY, this gives -the maximum number of bytes of the body that will be logged. -(-1 means "no limit".) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The prototype for a logging filter. The filter callback will be -invoked for each request or response, and should analyze it and -return a #SoupLoggerLogLevel value indicating how much of the -message to log. Eg, it might choose between %SOUP_LOGGER_LOG_BODY -and %SOUP_LOGGER_LOG_HEADERS depending on the Content-Type. - - a #SoupLoggerLogLevel value indicating how much of -the message to log - - - - - the #SoupLogger - - - - the message being logged - - - - the data passed to soup_logger_set_request_filter() -or soup_logger_set_response_filter() - - - - - - Describes the level of logging output to provide. - - No logging - - - Log the Request-Line or Status-Line and -the Soup-Debug pseudo-headers - - - Log the full request/response headers - - - Log the full headers and request/response -bodies. - - - - The prototype for a custom printing callback. - -@level indicates what kind of information is being printed. Eg, it -will be %SOUP_LOGGER_LOG_HEADERS if @data is header data. - -@direction is either '<', '>', or ' ', and @data is the single line -to print; the printer is expected to add a terminating newline. - -To get the effect of the default printer, you would do: - -<informalexample><programlisting> -printf ("%c %s\n", direction, data); -</programlisting></informalexample> - - - - - - the #SoupLogger - - - - the level of the information being printed. - - - - a single-character prefix to @data - - - - data to print - - - - the data passed to soup_logger_set_printer() - - - - - - Like soup_get_major_version(), but from the headers used at -application compile time, rather than from the library linked -against at application run time. - - - - - - - - - - - - - - - - Alias for the #SoupMessage:first-party property. (The -#SoupURI loaded in the application when the message was -queued.) - - - - Alias for the #SoupMessage:flags property. (The message's -#SoupMessageFlags.) - - - - - - - - - - Alias for the #SoupMessage:http-version property. (The -message's #SoupHTTPVersion.) - - - - - - - Alias for the #SoupMessage:method property. (The message's -HTTP method.) - - - - Sets the priority of the #SoupMessage. See -soup_message_set_priority() for further details. - - - - Alias for the #SoupMessage:reason-phrase property. (The -message's HTTP response reason phrase.) - - - - Alias for the #SoupMessage:request-body property. (The -message's HTTP request body.) - - - - Alias for the #SoupMessage:request-body-data property. (The -message's HTTP request body, as a #GBytes.) - - - - Alias for the #SoupMessage:request-headers property. (The -message's HTTP request headers.) - - - - Alias for the #SoupMessage:response-body property. (The -message's HTTP response body.) - - - - Alias for the #SoupMessage:response-body-data property. (The -message's HTTP response body, as a #GBytes.) - - - - Alias for the #SoupMessage:response-headers property. (The -message's HTTP response headers.) - - - - Alias for the #SoupMessage:server-side property. (%TRUE if -the message was created by #SoupServer.) - - - - - - - Alias for the #SoupMessage:status-code property. (The -message's HTTP response status code.) - - - - Alias for the #SoupMessage:tls-certificate property. (The -TLS certificate associated with the message, if any.) - - - - Alias for the #SoupMessage:tls-errors property. (The -verification errors on #SoupMessage:tls-certificate.) - - - - Alias for the #SoupMessage:uri property. (The message's -#SoupURI.) - - - - Like soup_get_micro_version(), but from the headers used at -application compile time, rather than from the library linked -against at application run time. - - - - Like soup_get_minor_version(), but from the headers used at -application compile time, rather than from the library linked -against at application run time. - - - - - - - - - - - - - - - - - - - - - - Describes how #SoupBuffer should use the data passed in by the -caller. - -See also soup_buffer_new_with_owner(), which allows to you create a -buffer containing data which is owned by another object. - - The memory is statically allocated and -constant; libsoup can use the passed-in buffer directly and not -need to worry about it being modified or freed. - - - The caller has allocated the memory for the -#SoupBuffer's use; libsoup will assume ownership of it and free it -(with g_free()) when it is done with it. - - - The passed-in data belongs to the caller; the -#SoupBuffer will copy it into new memory, leaving the caller free -to reuse the original memory. - - - The passed-in data belongs to the caller, -but will remain valid for the lifetime of the #SoupBuffer. The -difference between this and @SOUP_MEMORY_STATIC is that if you copy -a @SOUP_MEMORY_TEMPORARY buffer, it will make a copy of the memory -as well, rather than reusing the original memory. - - - - A #SoupMessage represents an HTTP message that is being sent or + + + A #SoupMessage represents an HTTP message that is being sent or received. For client-side usage, if you are using the traditional @@ -6881,1207 +29281,11 @@ specification: in RFC 2616, an "HTTP-message" is <emphasis>either</emphasis> a Request, <emphasis>or</emphasis> a Response. In libsoup, a #SoupMessage combines both the request and the response. - - Creates a new empty #SoupMessage, which will connect to @uri - - the new #SoupMessage (or %NULL if @uri -could not be parsed). - - - - - the HTTP method for the created request - - - - the destination endpoint (as a string) - - - - - - Creates a new empty #SoupMessage, which will connect to @uri - - the new #SoupMessage - - - - - the HTTP method for the created request - - - - the destination endpoint (as a #SoupURI) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Adds a signal handler to @msg for @signal, as with -g_signal_connect(), but the @callback will only be run if @msg's -incoming messages headers (that is, the -<literal>request_headers</literal> for a client #SoupMessage, or -the <literal>response_headers</literal> for a server #SoupMessage) -contain a header named @header. - - the handler ID from g_signal_connect() - - - - - a #SoupMessage - - - - signal to connect the handler to. - - - - HTTP response header to match against - - - - the header handler - - - - data to pass to @handler_cb - - - - - - Adds a signal handler to @msg for @signal, as with -g_signal_connect(), but the @callback will only be run if @msg has -the status @status_code. - -@signal must be a signal that will be emitted after @msg's status -is set. For a client #SoupMessage, this means it can't be a "wrote" -signal. For a server #SoupMessage, this means it can't be a "got" -signal. - - the handler ID from g_signal_connect() - - - - - a #SoupMessage - - - - signal to connect the handler to. - - - - status code to match against - - - - the header handler - - - - data to pass to @handler_cb - - - - - - - - - - - - - - - - - - - - - - - - - This disables the actions of #SoupSessionFeature<!-- -->s with the -given @feature_type (or a subclass of that type) on @msg, so that -@msg is processed as though the feature(s) hadn't been added to the -session. Eg, passing #SOUP_TYPE_CONTENT_SNIFFER for @feature_type -will disable Content-Type sniffing on the message. - -You must call this before queueing @msg on a session; calling it on -a message that has already been queued is undefined. In particular, -you cannot call this on a message that is being requeued after a -redirect or authentication. - - - - - - a #SoupMessage - - - - the #GType of a #SoupSessionFeature - - - - - - - - - - - - - - - - Gets the address @msg's URI points to. After first setting the -URI on a message, this will be unresolved, although the message's -session will resolve it before sending the message. - - the address @msg's URI points to - - - - - a #SoupMessage - - - - - - Gets @msg's first-party #SoupURI - - the @msg's first party #SoupURI - - - - - a #SoupMessage - - - - - - Gets the flags on @msg - - the flags - - - - - a #SoupMessage - - - - - - Gets the HTTP version of @msg. This is the minimum of the -version from the request and the version from the response. - - the HTTP version - - - - - a #SoupMessage - - - - - - If @msg is using https (or attempted to use https but got -%SOUP_STATUS_SSL_FAILED), this retrieves the #GTlsCertificate -associated with its connection, and the #GTlsCertificateFlags -showing what problems, if any, have been found with that -certificate. - -<note><para>This is only meaningful with messages processed by a #SoupSession and is -not useful for messages received by a #SoupServer</para></note> - - %TRUE if @msg used/attempted https, %FALSE if not - - - - - a #SoupMessage - - - - @msg's TLS certificate - - - - the verification status of @certificate - - - - - - - - - - - a #SoupMessage - - - - - - Retrieves the #SoupMessagePriority. If not set this value defaults -to #SOUP_MESSAGE_PRIORITY_NORMAL. - - the priority of the message. - - - - - a #SoupMessage - - - - - - Gets @msg's site for cookies #SoupURI - - the @msg's site for cookies #SoupURI - - - - - a #SoupMessage - - - - - - If @msg is associated with a #SoupRequest, this returns that -request. Otherwise it returns %NULL. - - @msg's associated #SoupRequest - - - - - a #SoupMessage - - - - - - Gets @msg's URI - - the URI @msg is targeted for. - - - - - a #SoupMessage - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Get whether #SoupSessionFeature<!-- -->s of the given @feature_type -(or a subclass of that type) are disabled on @msg. -See soup_message_disable_feature(). - - %TRUE if feature is disabled, or %FALSE otherwise. - - - - - a #SoupMessage - - - - the #GType of a #SoupSessionFeature - - - - - - Determines whether or not @msg's connection can be kept alive for -further requests after processing @msg, based on the HTTP version, -Connection header, etc. - - %TRUE or %FALSE. - - - - - a #SoupMessage - - - - - - - - - - - - - - - - Sets an alternate chunk-allocation function to use when reading -@msg's body when using the traditional (ie, -non-#SoupRequest<!-- -->-based) API. Every time data is available -to read, libsoup will call @allocator, which should return a -#SoupBuffer. (See #SoupChunkAllocator for additional details.) -Libsoup will then read data from the network into that buffer, and -update the buffer's <literal>length</literal> to indicate how much -data it read. - -Generally, a custom chunk allocator would be used in conjunction -with soup_message_body_set_accumulate() %FALSE and -#SoupMessage::got_chunk, as part of a strategy to avoid unnecessary -copying of data. However, you cannot assume that every call to the -allocator will be followed by a call to your -#SoupMessage::got_chunk handler; if an I/O error occurs, then the -buffer will be unreffed without ever having been used. If your -buffer-allocation strategy requires special cleanup, use -soup_buffer_new_with_owner() rather than doing the cleanup from the -#SoupMessage::got_chunk handler. - -The other thing to remember when using non-accumulating message -bodies is that the buffer passed to the #SoupMessage::got_chunk -handler will be unreffed after the handler returns, just as it -would be in the non-custom-allocated case. If you want to hand the -chunk data off to some other part of your program to use later, -you'll need to ref the #SoupBuffer (or its owner, in the -soup_buffer_new_with_owner() case) to ensure that the data remains -valid. - #SoupRequest provides a much simpler API that lets you -read the response directly into your own buffers without needing to -mess with callbacks, pausing/unpausing, etc. - - - - - - a #SoupMessage - - - - the chunk allocator callback - - - - data to pass to @allocator - - - - destroy notifier to free @user_data when @msg is -destroyed - - - - - - Sets @first_party as the main document #SoupURI for @msg. For -details of when and how this is used refer to the documentation for -#SoupCookieJarAcceptPolicy. - - - - - - a #SoupMessage - - - - the #SoupURI for the @msg's first party - - - - - - Sets the specified flags on @msg. - - - - - - a #SoupMessage - - - - a set of #SoupMessageFlags values - - - - - - Sets the HTTP version on @msg. The default version is -%SOUP_HTTP_1_1. Setting it to %SOUP_HTTP_1_0 will prevent certain -functionality from being used. - - - - - - a #SoupMessage - - - - the HTTP version - - - - - - See the [same-site spec](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00) -for more information. - - - - - - a #SoupMessage - - - - if %TRUE indicate the current request is a top-level navigation - - - - - - Sets the priority of a message. Note that this won't have any -effect unless used before the message is added to the session's -message processing queue. - -The message will be placed just before any other previously added -message with lower priority (messages with the same priority are -processed on a FIFO basis). - -Setting priorities does not currently work with #SoupSessionSync -(or with synchronous messages on a plain #SoupSession) because in -the synchronous/blocking case, priority ends up being determined -semi-randomly by thread scheduling. - - - - - - a #SoupMessage - - - - the #SoupMessagePriority - - - - - - Sets @msg's status_code to @status_code and adds a Location header -pointing to @redirect_uri. Use this from a #SoupServer when you -want to redirect the client to another URI. - -@redirect_uri can be a relative URI, in which case it is -interpreted relative to @msg's current URI. In particular, if -@redirect_uri is just a path, it will replace the path -<emphasis>and query</emphasis> of @msg's URI. - - - - - - a #SoupMessage - - - - a 3xx status code - - - - the URI to redirect @msg to - - - - - - Convenience function to set the request body of a #SoupMessage. If -@content_type is %NULL, the request body must be empty as well. - - - - - - the message - - - - MIME Content-Type of the body - - - - a #SoupMemoryUse describing how to handle @req_body - - - - - a data buffer containing the body of the message request. - - - - - - the byte length of @req_body. - - - - - - Convenience function to set the response body of a #SoupMessage. If -@content_type is %NULL, the response body must be empty as well. - - - - - - the message - - - - MIME Content-Type of the body - - - - a #SoupMemoryUse describing how to handle @resp_body - - - - - a data buffer containing the body of the message response. - - - - - - the byte length of @resp_body. - - - - - - Sets @site_for_cookies as the policy URL for same-site cookies for @msg. - -It is either the URL of the top-level document or %NULL depending on whether the registrable -domain of this document's URL matches the registrable domain of its parent's/opener's -URL. For the top-level document it is set to the document's URL. - -See the [same-site spec](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00) -for more information. - - - - - - a #SoupMessage - - - - the #SoupURI for the @msg's site for cookies - - - - - - Sets @msg's status code to @status_code. If @status_code is a -known value, it will also set @msg's reason_phrase. - - - - - - a #SoupMessage - - - - an HTTP status code - - - - - - Sets @msg's status code and reason phrase. - - - - - - a #SoupMessage - - - - an HTTP status code - - - - a description of the status - - - - - - Sets @msg's URI to @uri. If @msg has already been sent and you want -to re-send it with the new URI, you need to call -soup_session_requeue_message(). - - - - - - a #SoupMessage - - - - the new #SoupURI - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The #SoupURI loaded in the application when the message was -queued. - - - - - - - - - - Set when the message is navigating between top level domains. - - - - - - - - - - - - - - - - The message's HTTP request body, as a #GBytes. - - - - - - - - - - The message's HTTP response body, as a #GBytes. - - - - - - - - - - - - - - - - The #GTlsCertificate associated with the message - - - - The verification errors on #SoupMessage:tls-certificate - - - - - - - - - - the HTTP method - - - - the HTTP status code - - - - the status phrase associated with @status_code - - - - the request body - - - - the request headers - - - - the response body - - - - the response headers - - - - This signal is emitted after #SoupMessage::got-headers, and -before the first #SoupMessage::got-chunk. If content -sniffing is disabled, or no content sniffing will be -performed, due to the sniffer deciding to trust the -Content-Type sent by the server, this signal is emitted -immediately after #SoupMessage::got-headers, and @type is -%NULL. - -If the #SoupContentSniffer feature is enabled, and the -sniffer decided to perform sniffing, the first -#SoupMessage::got-chunk emission may be delayed, so that the -sniffer has enough data to correctly sniff the content. It -notified the library user that the content has been -sniffed, and allows it to change the header contents in the -message, if desired. - -After this signal is emitted, the data that was spooled so -that sniffing could be done is delivered on the first -emission of #SoupMessage::got-chunk. - - - - - - the content type that we got from sniffing - - - - a #GHashTable with the parameters - - - - - - - - - Emitted when all HTTP processing is finished for a message. -(After #SoupMessage::got_body for client-side messages, or -after #SoupMessage::wrote_body for server-side messages.) - - - - - - Emitted after receiving the complete message body. (For a -server-side message, this means it has received the request -body. For a client-side message, this means it has received -the response body and is nearly done with the message.) - -See also soup_message_add_header_handler() and -soup_message_add_status_code_handler(), which can be used -to connect to a subset of emissions of this signal. - - - - - - Emitted after receiving a chunk of a message body. Note -that "chunk" in this context means any subpiece of the -body, not necessarily the specific HTTP 1.1 chunks sent by -the other side. - -If you cancel or requeue @msg while processing this signal, -then the current HTTP I/O will be stopped after this signal -emission finished, and @msg's connection will be closed. - - - - - - the just-read chunk - - - - - - Emitted after receiving all message headers for a message. -(For a client-side message, this is after receiving the -Status-Line and response headers; for a server-side -message, it is after receiving the Request-Line and request -headers.) - -See also soup_message_add_header_handler() and -soup_message_add_status_code_handler(), which can be used -to connect to a subset of emissions of this signal. - -If you cancel or requeue @msg while processing this signal, -then the current HTTP I/O will be stopped after this signal -emission finished, and @msg's connection will be closed. -(If you need to requeue a message--eg, after handling -authentication or redirection--it is usually better to -requeue it from a #SoupMessage::got_body handler rather -than a #SoupMessage::got_headers handler, so that the -existing HTTP connection can be reused.) - - - - - - Emitted after receiving a 1xx (Informational) response for -a (client-side) message. The response_headers will be -filled in with the headers associated with the -informational response; however, those header values will -be erased after this signal is done. - -If you cancel or requeue @msg while processing this signal, -then the current HTTP I/O will be stopped after this signal -emission finished, and @msg's connection will be closed. - - - - - - Emitted to indicate that some network-related event -related to @msg has occurred. This essentially proxies the -#GSocketClient::event signal, but only for events that -occur while @msg "owns" the connection; if @msg is sent on -an existing persistent connection, then this signal will -not be emitted. (If you want to force the message to be -sent on a new connection, set the -%SOUP_MESSAGE_NEW_CONNECTION flag on it.) - -See #GSocketClient::event for more information on what -the different values of @event correspond to, and what -@connection will be in each case. - - - - - - the network event - - - - the current state of the network connection - - - - - - Emitted when a request that was already sent once is now -being sent again (eg, because the first attempt received a -redirection response, or because we needed to use -authentication). - - - - - - Emitted just before a message is sent. - - - - - - Emitted immediately after writing the complete body for a -message. (For a client-side message, this means that -libsoup is done writing and is now waiting for the response -from the server. For a server-side message, this means that -libsoup has finished writing the response and is nearly -done with the message.) - - - - - - Emitted immediately after writing a portion of the message -body to the network. - -Unlike #SoupMessage::wrote_chunk, this is emitted after -every successful write() call, not only after finishing a -complete "chunk". - - - - - - the data written - - - - - - Emitted immediately after writing a body chunk for a message. - -Note that this signal is not parallel to -#SoupMessage::got_chunk; it is emitted only when a complete -chunk (added with soup_message_body_append() or -soup_message_body_append_buffer()) has been written. To get -more useful continuous progress information, use -#SoupMessage::wrote_body_data. - - - - - - Emitted immediately after writing the headers for a -message. (For a client-side message, this is after writing -the request headers; for a server-side message, it is after -writing the response headers.) - - - - - - Emitted immediately after writing a 1xx (Informational) -response for a (server-side) message. - - - - - - - #SoupMessageBody represents the request or response body of a + + + #SoupMessageBody represents the request or response body of a #SoupMessage. In addition to #SoupMessageBody, libsoup also defines a "smaller" @@ -8089,1535 +29293,38 @@ data buffer type, #SoupBuffer, which is primarily used as a component of #SoupMessageBody. In particular, when using chunked encoding to transmit or receive a message, each chunk is represented as a #SoupBuffer. - - the data - - - - length of @data - - - - Creates a new #SoupMessageBody. #SoupMessage uses this internally; you -will not normally need to call it yourself. - - a new #SoupMessageBody. - - - - - Appends @length bytes from @data to @body according to @use. - - - - - - a #SoupMessageBody - - - - how to use @data - - - - data to append - - - - - - length of @data - - - - - - Appends the data from @buffer to @body. (#SoupMessageBody uses -#SoupBuffers internally, so this is normally a constant-time -operation that doesn't actually require copying the data in -@buffer.) - - - - - - a #SoupMessageBody - - - - a #SoupBuffer - - - - - - Appends @length bytes from @data to @body. - -This function is exactly equivalent to soup_message_body_append() -with %SOUP_MEMORY_TAKE as second argument; it exists mainly for -convenience and simplifying language bindings. - - - - - - a #SoupMessageBody - - - - data to append - - - - - - length of @data - - - - - - Tags @body as being complete; Call this when using chunked encoding -after you have appended the last chunk. - - - - - - a #SoupMessageBody - - - - - - Fills in @body's data field with a buffer containing all of the -data in @body (plus an additional '\0' byte not counted by @body's -length field). - - a #SoupBuffer containing the same data as @body. -(You must free this buffer if you do not want it.) - - - - - a #SoupMessageBody - - - - - - Frees @body. You will not normally need to use this, as -#SoupMessage frees its associated message bodies automatically. - - - - - - a #SoupMessageBody - - - - - - Gets the accumulate flag on @body; see -soup_message_body_set_accumulate() for details. - - the accumulate flag for @body. - - - - - a #SoupMessageBody - - - - - - Gets a #SoupBuffer containing data from @body starting at @offset. -The size of the returned chunk is unspecified. You can iterate -through the entire body by first calling -soup_message_body_get_chunk() with an offset of 0, and then on each -successive call, increment the offset by the length of the -previously-returned chunk. - -If @offset is greater than or equal to the total length of @body, -then the return value depends on whether or not -soup_message_body_complete() has been called or not; if it has, -then soup_message_body_get_chunk() will return a 0-length chunk -(indicating the end of @body). If it has not, then -soup_message_body_get_chunk() will return %NULL (indicating that -@body may still potentially have more data, but that data is not -currently available). - - a #SoupBuffer, or %NULL. - - - - - a #SoupMessageBody - - - - an offset - - - - - - Handles the #SoupMessageBody part of receiving a chunk of data from -the network. Normally this means appending @chunk to @body, exactly -as with soup_message_body_append_buffer(), but if you have set -@body's accumulate flag to %FALSE, then that will not happen. - -This is a low-level method which you should not normally need to -use. - - - - - - a #SoupMessageBody - - - - a #SoupBuffer received from the network - - - - - - Sets or clears the accumulate flag on @body. (The default value is -%TRUE.) If set to %FALSE, @body's %data field will not be filled in -after the body is fully sent/received, and the chunks that make up -@body may be discarded when they are no longer needed. - -In particular, if you set this flag to %FALSE on an "incoming" -message body (that is, the #SoupMessage:response_body of a -client-side message, or #SoupMessage:request_body of a server-side -message), this will cause each chunk of the body to be discarded -after its corresponding #SoupMessage::got_chunk signal is emitted. -(This is equivalent to setting the deprecated -%SOUP_MESSAGE_OVERWRITE_CHUNKS flag on the message.) - -If you set this flag to %FALSE on the #SoupMessage:response_body of -a server-side message, it will cause each chunk of the body to be -discarded after its corresponding #SoupMessage::wrote_chunk signal -is emitted. - -If you set the flag to %FALSE on the #SoupMessage:request_body of a -client-side message, it will block the accumulation of chunks into -@body's %data field, but it will not normally cause the chunks to -be discarded after being written like in the server-side -#SoupMessage:response_body case, because the request body needs to -be kept around in case the request needs to be sent a second time -due to redirection or authentication. However, if you set the -%SOUP_MESSAGE_CAN_REBUILD flag on the message, then the chunks will -be discarded, and you will be responsible for recreating the -request body after the #SoupMessage::restarted signal is emitted. - - - - - - a #SoupMessageBody - - - - whether or not to accumulate body chunks in @body - - - - - - Deletes all of the data in @body. - - - - - - a #SoupMessageBody - - - - - - Handles the #SoupMessageBody part of writing a chunk of data to the -network. Normally this is a no-op, but if you have set @body's -accumulate flag to %FALSE, then this will cause @chunk to be -discarded to free up memory. - -This is a low-level method which you should not need to use, and -there are further restrictions on its proper use which are not -documented here. - - - - - - a #SoupMessageBody - - - - a #SoupBuffer returned from soup_message_body_get_chunk() - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Various flags that can be set on a #SoupMessage to alter its -behavior. - - The session should not follow redirect - (3xx) responses received by this message. - - - The caller will rebuild the request - body if the message is restarted; see - soup_message_body_set_accumulate() for more details. - - - Deprecated: equivalent to calling - soup_message_body_set_accumulate() on the incoming message body - (ie, #SoupMessage:response_body for a client-side request), - passing %FALSE. - - - Set by #SoupContentDecoder to - indicate that it has removed the Content-Encoding on a message (and - so headers such as Content-Length may no longer accurately describe - the body). - - - if set after an https response - has been received, indicates that the server's SSL certificate is - trusted according to the session's CA. - - - Requests that the message should be - sent on a newly-created connection, not reusing an existing - persistent connection. Note that messages with non-idempotent - #SoupMessage:method<!-- -->s behave this way by default, unless - #SOUP_MESSAGE_IDEMPOTENT is set. - - - The message is considered idempotent, - regardless its #SoupMessage:method, and allows reuse of existing - idle connections, instead of always requiring a new one, unless - #SOUP_MESSAGE_NEW_CONNECTION is set. - - - Request that a new connection is - created for the message if there aren't idle connections available - and it's not possible to create new connections due to any of the - connection limits has been reached. If a dedicated connection is - eventually created for this message, it will be dropped when the - message finishes. Since 2.50 - - - The #SoupAuthManager should not use - the credentials cache for this message, neither to use cached credentials - to automatically authenticate this message nor to cache the credentials - after the message is successfully authenticated. This applies to both server - and proxy authentication. Note that #SoupSession::authenticate signal will - be emitted, if you want to disable authentication for a message use - soup_message_disable_feature() passing #SOUP_TYPE_AUTH_MANAGER instead. Since 2.58 - - - - #SoupMessageHeaders represents the HTTP message headers associated + + + #SoupMessageHeaders represents the HTTP message headers associated with a request or response. - - Creates a #SoupMessageHeaders. (#SoupMessage does this -automatically for its own headers. You would only need to use this -method if you are manually parsing or generating message headers.) - - a new #SoupMessageHeaders - - - - - the type of headers - - - - - - Appends a new header with name @name and value @value to @hdrs. (If -there is an existing header with name @name, then this creates a -second one, which is only allowed for list-valued headers; see also -soup_message_headers_replace().) + + + soup-method.h contains a number of defines for standard HTTP and +WebDAV headers. You do not need to use these defines; you can pass +arbitrary strings to soup_message_new() if you prefer. -The caller is expected to make sure that @name and @value are -syntactically correct. - - - - - - a #SoupMessageHeaders - - - - the header name to add - - - - the new value of @name - - - - - - Removes all the headers listed in the Connection header. - - - - - - a #SoupMessageHeaders - - - - - - Clears @hdrs. - - - - - - a #SoupMessageHeaders - - - - - - Calls @func once for each header value in @hdrs. +The thing that these defines <emphasis>are</emphasis> useful for is +performing quick comparisons against #SoupMessage's %method field; +because that field always contains an interned string, and these +macros return interned strings, you can compare %method directly +against these macros rather than needing to use strcmp(). This is +most useful in SoupServer handlers. Eg: -Beware that unlike soup_message_headers_get(), this processes the -headers in exactly the way they were added, rather than -concatenating multiple same-named headers into a single value. -(This is intentional; it ensures that if you call -soup_message_headers_append() multiple times with the same name, -then the I/O code will output multiple copies of the header when -sending the message to the remote implementation, which may be -required for interoperability in some cases.) - -You may not modify the headers from @func. - - - - - - a #SoupMessageHeaders - - - - callback function to run for each header - - - - data to pass to @func - - - - - - Frees @hdrs. - - - - - - a #SoupMessageHeaders - - - - - - Frees the array of ranges returned from soup_message_headers_get_ranges(). - - - - - - a #SoupMessageHeaders - - - - an array of #SoupRange - - - - - - Gets the value of header @name in @hdrs. - -This method was supposed to work correctly for both single-valued -and list-valued headers, but because some HTTP clients/servers -mistakenly send multiple copies of headers that are supposed to be -single-valued, it sometimes returns incorrect results. To fix this, -the methods soup_message_headers_get_one() and -soup_message_headers_get_list() were introduced, so callers can -explicitly state which behavior they are expecting. - Use soup_message_headers_get_one() or -soup_message_headers_get_list() instead. - - as with soup_message_headers_get_list(). - - - - - a #SoupMessageHeaders - - - - header name - - - - - - Looks up the "Content-Disposition" header in @hdrs, parses it, and -returns its value in *@disposition and *@params. @params can be -%NULL if you are only interested in the disposition-type. - -In HTTP, the most common use of this header is to set a -disposition-type of "attachment", to suggest to the browser that a -response should be saved to disk rather than displayed in the -browser. If @params contains a "filename" parameter, this is a -suggestion of a filename to use. (If the parameter value in the -header contains an absolute or relative path, libsoup will truncate -it down to just the final path component, so you do not need to -test this yourself.) - -Content-Disposition is also used in "multipart/form-data", however -this is handled automatically by #SoupMultipart and the associated -form methods. - - %TRUE if @hdrs contains a "Content-Disposition" -header, %FALSE if not (in which case *@disposition and *@params -will be unchanged). - - - - - a #SoupMessageHeaders - - - - return location for the -disposition-type, or %NULL - - - - return -location for the Content-Disposition parameters, or %NULL - - - - - - - - - Gets the message body length that @hdrs declare. This will only -be non-0 if soup_message_headers_get_encoding() returns -%SOUP_ENCODING_CONTENT_LENGTH. - - the message body length declared by @hdrs. - - - - - a #SoupMessageHeaders - - - - - - Parses @hdrs's Content-Range header and returns it in @start, -@end, and @total_length. If the total length field in the header -was specified as "*", then @total_length will be set to -1. - - %TRUE if @hdrs contained a "Content-Range" header -containing a byte range which could be parsed, %FALSE otherwise. - - - - - a #SoupMessageHeaders - - - - return value for the start of the range - - - - return value for the end of the range - - - - return value for the total length of the -resource, or %NULL if you don't care. - - - - - - Looks up the "Content-Type" header in @hdrs, parses it, and returns -its value in *@content_type and *@params. @params can be %NULL if you -are only interested in the content type itself. - - a string with the value of the -"Content-Type" header or %NULL if @hdrs does not contain that -header or it cannot be parsed (in which case *@params will be -unchanged). - - - - - a #SoupMessageHeaders - - - - - return location for the Content-Type parameters (eg, "charset"), or - %NULL - - - - - - - - - Gets the message body encoding that @hdrs declare. This may not -always correspond to the encoding used on the wire; eg, a HEAD -response may declare a Content-Length or Transfer-Encoding, but -it will never actually include a body. - - the encoding declared by @hdrs. - - - - - a #SoupMessageHeaders - - - - - - Gets the expectations declared by @hdrs's "Expect" header. -Currently this will either be %SOUP_EXPECTATION_CONTINUE or -%SOUP_EXPECTATION_UNRECOGNIZED. - - the contents of @hdrs's "Expect" header - - - - - a #SoupMessageHeaders - - - - - - Gets the type of headers. - - the header's type. - - - - - a #SoupMessageHeaders - - - - - - Gets the value of header @name in @hdrs. Use this for headers whose -values are comma-delimited lists, and which are therefore allowed -to appear multiple times in the headers. For non-list-valued -headers, use soup_message_headers_get_one(). - -If @name appears multiple times in @hdrs, -soup_message_headers_get_list() will concatenate all of the values -together, separated by commas. This is sometimes awkward to parse -(eg, WWW-Authenticate, Set-Cookie), but you have to be able to deal -with it anyway, because the HTTP spec explicitly states that this -transformation is allowed, and so an upstream proxy could do the -same thing. - - the header's value or %NULL if not found. - - - - - a #SoupMessageHeaders - - - - header name - - - - - - Gets the value of header @name in @hdrs. Use this for headers whose -values are <emphasis>not</emphasis> comma-delimited lists, and -which therefore can only appear at most once in the headers. For -list-valued headers, use soup_message_headers_get_list(). - -If @hdrs does erroneously contain multiple copies of the header, it -is not defined which one will be returned. (Ideally, it will return -whichever one makes libsoup most compatible with other HTTP -implementations.) - - the header's value or %NULL if not found. - - - - - a #SoupMessageHeaders - - - - header name - - - - - - Parses @hdrs's Range header and returns an array of the requested -byte ranges. The returned array must be freed with -soup_message_headers_free_ranges(). - -If @total_length is non-0, its value will be used to adjust the -returned ranges to have explicit start and end values, and the -returned ranges will be sorted and non-overlapping. If -@total_length is 0, then some ranges may have an end value of -1, -as described under #SoupRange, and some of the ranges may be -redundant. - -Beware that even if given a @total_length, this function does not -check that the ranges are satisfiable. - -<note><para> -#SoupServer has built-in handling for range requests. If your -server handler returns a %SOUP_STATUS_OK response containing the -complete response body (rather than pausing the message and -returning some of the response body later), and there is a Range -header in the request, then libsoup will automatically convert the -response to a %SOUP_STATUS_PARTIAL_CONTENT response containing only -the range(s) requested by the client. - -The only time you need to process the Range header yourself is if -either you need to stream the response body rather than returning -it all at once, or you do not already have the complete response -body available, and only want to generate the parts that were -actually requested by the client. -</para></note> - - %TRUE if @hdrs contained a syntactically-valid -"Range" header, %FALSE otherwise (in which case @range and @length -will not be set). - - - - - a #SoupMessageHeaders - - - - the total_length of the response body - - - - return location for an array -of #SoupRange - - - - - - the length of the returned array - - - - - - Checks whether the list-valued header @name is present in @hdrs, -and contains a case-insensitive match for @token. - -(If @name is present in @hdrs, then this is equivalent to calling -soup_header_contains() on its value.) - - %TRUE if the header is present and contains @token, - %FALSE otherwise. - - - - - a #SoupMessageHeaders - - - - header name - - - - token to look for - - - - - - Checks whether the header @name is present in @hdrs and is -(case-insensitively) equal to @value. - - %TRUE if the header is present and its value is - @value, %FALSE otherwise. - - - - - a #SoupMessageHeaders - - - - header name - - - - expected value - - - - - - Removes @name from @hdrs. If there are multiple values for @name, -they are all removed. - - - - - - a #SoupMessageHeaders - - - - the header name to remove - - - - - - Replaces the value of the header @name in @hdrs with @value. (See -also soup_message_headers_append().) - -The caller is expected to make sure that @name and @value are -syntactically correct. - - - - - - a #SoupMessageHeaders - - - - the header name to replace - - - - the new value of @name - - - - - - Sets the "Content-Disposition" header in @hdrs to @disposition, -optionally with additional parameters specified in @params. - -See soup_message_headers_get_content_disposition() for a discussion -of how Content-Disposition is used in HTTP. - - - - - - a #SoupMessageHeaders - - - - the disposition-type - - - - additional -parameters, or %NULL - - - - - - - - - Sets the message body length that @hdrs will declare, and sets -@hdrs's encoding to %SOUP_ENCODING_CONTENT_LENGTH. - -You do not normally need to call this; if @hdrs is set to use -Content-Length encoding, libsoup will automatically set its -Content-Length header for you immediately before sending the -headers. One situation in which this method is useful is when -generating the response to a HEAD request; Calling -soup_message_headers_set_content_length() allows you to put the -correct content length into the response without needing to waste -memory by filling in a response body which won't actually be sent. - - - - - - a #SoupMessageHeaders - - - - the message body length - - - - - - Sets @hdrs's Content-Range header according to the given values. -(Note that @total_length is the total length of the entire resource -that this is a range of, not simply @end - @start + 1.) - -<note><para> -#SoupServer has built-in handling for range requests, and you do -not normally need to call this function youself. See -soup_message_headers_get_ranges() for more details. -</para></note> - - - - - - a #SoupMessageHeaders - - - - the start of the range - - - - the end of the range - - - - the total length of the resource, or -1 if unknown - - - - - - Sets the "Content-Type" header in @hdrs to @content_type, -optionally with additional parameters specified in @params. - - - - - - a #SoupMessageHeaders - - - - the MIME type - - - - additional -parameters, or %NULL - - - - - - - - - Sets the message body encoding that @hdrs will declare. In particular, -you should use this if you are going to send a request or response in -chunked encoding. - - - - - - a #SoupMessageHeaders - - - - a #SoupEncoding - - - - - - Sets @hdrs's "Expect" header according to @expectations. - -Currently %SOUP_EXPECTATION_CONTINUE is the only known expectation -value. You should set this value on a request if you are sending a -large message body (eg, via POST or PUT), and want to give the -server a chance to reject the request after seeing just the headers -(eg, because it will require authentication before allowing you to -post, or because you're POSTing to a URL that doesn't exist). This -saves you from having to transmit the large request body when the -server is just going to ignore it anyway. - - - - - - a #SoupMessageHeaders - - - - the expectations to set - - - - - - Sets @hdrs's Range header to request the indicated range. -@start and @end are interpreted as in a #SoupRange. - -If you need to request multiple ranges, use -soup_message_headers_set_ranges(). - - - - - - a #SoupMessageHeaders - - - - the start of the range to request - - - - the end of the range to request - - - - - - Sets @hdrs's Range header to request the indicated ranges. (If you -only want to request a single range, you can use -soup_message_headers_set_range().) - - - - - - a #SoupMessageHeaders - - - - an array of #SoupRange - - - - the length of @range - - - - - - - The callback passed to soup_message_headers_foreach(). - - - - - - the header name - - - - the header value - - - - the data passed to soup_message_headers_foreach() - - - - - - An opaque type used to iterate over a %SoupMessageHeaders -structure. - -After intializing the iterator with -soup_message_headers_iter_init(), call -soup_message_headers_iter_next() to fetch data from it. - -You may not modify the headers while iterating over them. - - - - - - - Yields the next name/value pair in the %SoupMessageHeaders being -iterated by @iter. If @iter has already yielded the last header, -then soup_message_headers_iter_next() will return %FALSE and @name -and @value will be unchanged. - - %TRUE if another name and value were returned, %FALSE -if the end of the headers has been reached. - - - - - a %SoupMessageHeadersIter - - - - pointer to a variable to return -the header name in - - - - pointer to a variable to return -the header value in - - - - - - Initializes @iter for iterating @hdrs. - - - - - - a pointer to a %SoupMessageHeadersIter -structure - - - - a %SoupMessageHeaders - - - - - - - Value passed to soup_message_headers_new() to set certain default -behaviors. - - request headers - - - response headers - - - multipart body part headers - - - - Priorities that can be set on a #SoupMessage to instruct the -message queue to process it before any other message with lower -priority. - - The lowest priority, the messages - with this priority will be the last ones to be attended. - - - Use this for low priority messages, a - #SoupMessage with the default priority will be processed first. - - - The default priotity, this is the - priority assigned to the #SoupMessage by default. - - - High priority, a #SoupMessage with - this priority will be processed before the ones with the default - priority. - - - The highest priority, use this - for very urgent #SoupMessage as they will be the first ones to be - attended. - - - - - - Represents a multipart HTTP message body, parsed according to the -syntax of RFC 2046. Of particular interest to HTTP are -<literal>multipart/byte-ranges</literal> and -<literal>multipart/form-data</literal>. - -Although the headers of a #SoupMultipart body part will contain the -full headers from that body part, libsoup does not interpret them -according to MIME rules. For example, each body part is assumed to -have "binary" Content-Transfer-Encoding, even if its headers -explicitly state otherwise. In other words, don't try to use -#SoupMultipart for handling real MIME multiparts. - - Creates a new empty #SoupMultipart with a randomly-generated -boundary string. Note that @mime_type must be the full MIME type, -including "multipart/". - - a new empty #SoupMultipart of the given @mime_type - - - - - the MIME type of the multipart to create. - - - - - - Parses @headers and @body to form a new #SoupMultipart - - a new #SoupMultipart (or %NULL if the -message couldn't be parsed or wasn't multipart). - - - - - the headers of the HTTP message to parse - - - - the body of the HTTP message to parse - - - - - - Adds a new MIME part containing @body to @multipart, using -"Content-Disposition: form-data", as per the HTML forms -specification. See soup_form_request_new_from_multipart() for more -details. - - - - - - a multipart (presumably of type "multipart/form-data") - - - - the name of the control associated with this file - - - - the name of the file, or %NULL if not known - - - - the MIME type of the file, or %NULL if not known - - - - the file data - - - - - - Adds a new MIME part containing @data to @multipart, using -"Content-Disposition: form-data", as per the HTML forms -specification. See soup_form_request_new_from_multipart() for more -details. - - - - - - a multipart (presumably of type "multipart/form-data") - - - - the name of the control associated with @data - - - - the body data - - - - - - Adds a new MIME part to @multipart with the given headers and body. -(The multipart will make its own copies of @headers and @body, so -you should free your copies if you are not using them for anything -else.) - - - - - - a #SoupMultipart - - - - the MIME part headers - - - - the MIME part body - - - - - - Frees @multipart - - - - - - a #SoupMultipart - - - - - - Gets the number of body parts in @multipart - - the number of body parts in @multipart - - - - - a #SoupMultipart - - - - - - Gets the indicated body part from @multipart. - - %TRUE on success, %FALSE if @part is out of range (in -which case @headers and @body won't be set) - - - - - a #SoupMultipart - - - - the part number to get (counting from 0) - - - - return location for the MIME part -headers - - - - return location for the MIME part -body - - - - - - Serializes @multipart to @dest_headers and @dest_body. - - - - - - a #SoupMultipart - - - - the headers of the HTTP message to serialize @multipart to - - - - the body of the HTTP message to serialize @multipart to - - - - - - - This adds support for the multipart responses. For handling the +<informalexample><programlisting> + if (msg->method != SOUP_METHOD_GET &amp;&amp; msg->method != SOUP_METHOD_HEAD) { + soup_message_set_status (msg, SOUP_METHOD_NOT_IMPLEMENTED); + return; + } +</programlisting></informalexample> + + + This adds support for the multipart responses. For handling the multiple parts the user needs to wrap the #GInputStream obtained by sending the request with a #SoupMultipartInputStream and use soup_multipart_input_stream_next_part() before reading. Responses @@ -9626,520 +29333,11 @@ which are not wrapped will be treated like non-multipart responses. Note that although #SoupMultipartInputStream is a #GInputStream, you should not read directly from it, and the results are undefined if you do. - - - Creates a new #SoupMultipartInputStream that wraps the -#GInputStream obtained by sending the #SoupRequest. Reads should -not be done directly through this object, use the input streams -returned by soup_multipart_input_stream_next_part() or its async -counterpart instead. - - a new #SoupMultipartInputStream - - - - - the #SoupMessage the response is related to. - - - - the #GInputStream returned by sending the request. - - - - - - Obtains the headers for the part currently being processed. Note -that the #SoupMessageHeaders that are returned are owned by the -#SoupMultipartInputStream and will be replaced when a call is made -to soup_multipart_input_stream_next_part() or its async -counterpart, so if keeping the headers is required, a copy must be -made. - -Note that if a part had no headers at all an empty #SoupMessageHeaders -will be returned. - - a #SoupMessageHeaders -containing the headers for the part currently being processed or -%NULL if the headers failed to parse. - - - - - a #SoupMultipartInputStream. - - - - - - Obtains an input stream for the next part. When dealing with a -multipart response the input stream needs to be wrapped in a -#SoupMultipartInputStream and this function or its async -counterpart need to be called to obtain the first part for -reading. - -After calling this function, -soup_multipart_input_stream_get_headers() can be used to obtain the -headers for the first part. A read of 0 bytes indicates the end of -the part; a new call to this function should be done at that point, -to obtain the next part. - - a new #GInputStream, or -%NULL if there are no more parts - - - - - the #SoupMultipartInputStream - - - - a #GCancellable - - - - - - Obtains a #GInputStream for the next request. See -soup_multipart_input_stream_next_part() for details on the -workflow. - - - - - - the #SoupMultipartInputStream. - - - - the I/O priority for the request. - - - - a #GCancellable. - - - - callback to call when request is satisfied. - - - - data for @callback - - - - - - Finishes an asynchronous request for the next part. - - a newly created -#GInputStream for reading the next part or %NULL if there are no -more parts. - - - - - a #SoupMultipartInputStream. - - - - a #GAsyncResult. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Use SoupProxyURIResolver.get_proxy_uri_async instead - - - - - - - - - - - - - - - - - - - - - - - - - - Use SoupProxyURIResolver.get_proxy_uri_sync() instead - - - - - - - - - - - - - - - - - - - - Use SoupProxyURIResolver.get_proxy_uri_async instead - - - - - - - - - - - - - - - - - - - - - - - - - - Use SoupProxyURIResolver.get_proxy_uri_sync() instead - - - - - - - - - - - - - - - - - - - - - Use SoupProxyURIResolver instead - - - - - - - - - - - - - - - - - - - - - - - #SoupProxyResolverDefault is a <type>SoupProxyURIResolver</type> + + + #SoupProxyResolverDefault is a <type>SoupProxyURIResolver</type> implementation that uses the default gio #GProxyResolver to resolve proxies. @@ -10148,1390 +29346,44 @@ In libsoup 2.44 and later, you can set the session's g_proxy_resolver_get_default() to get the same effect. Note that for "plain" #SoupSessions (ie, not #SoupSessionAsync or #SoupSessionSync), this is done for you automatically. - Use #SoupSession:proxy-resolver - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupProxyURIResolver is an interface for finding appropriate HTTP + + + #SoupProxyURIResolver is an interface for finding appropriate HTTP proxies to use. - #SoupSession now has a #SoupSession:proxy-resolver -property that takes a #GProxyResolver (which is semantically -identical to #SoupProxyURIResolver). - -Even in older releases of libsoup, you are not likely to have to -implement this interface on your own; instead, you should usually -just be able to use #SoupProxyResolverDefault. - - - Asynchronously determines a proxy URI to use for @msg and calls -@callback. - #SoupProxyURIResolver is deprecated in favor of -#GProxyResolver - - - - - - the #SoupProxyURIResolver - - - - the #SoupURI you want a proxy for - - - - the #GMainContext to invoke @callback in - - - - a #GCancellable, or %NULL - - - - callback to invoke with the proxy address - - - - data for @callback - - - - - - Synchronously determines a proxy URI to use for @uri. If @uri -should be sent via proxy, *@proxy_uri will be set to the URI of the -proxy, else it will be set to %NULL. - #SoupProxyURIResolver is deprecated in favor of -#GProxyResolver - - %SOUP_STATUS_OK if successful, or a transport-level -error. - - - - - the #SoupProxyURIResolver - - - - the #SoupURI you want a proxy for - - - - a #GCancellable, or %NULL - - - - on return, will contain the proxy URI - - - - - - Asynchronously determines a proxy URI to use for @msg and calls -@callback. - #SoupProxyURIResolver is deprecated in favor of -#GProxyResolver - - - - - - the #SoupProxyURIResolver - - - - the #SoupURI you want a proxy for - - - - the #GMainContext to invoke @callback in - - - - a #GCancellable, or %NULL - - - - callback to invoke with the proxy address - - - - data for @callback - - - - - - Synchronously determines a proxy URI to use for @uri. If @uri -should be sent via proxy, *@proxy_uri will be set to the URI of the -proxy, else it will be set to %NULL. - #SoupProxyURIResolver is deprecated in favor of -#GProxyResolver - - %SOUP_STATUS_OK if successful, or a transport-level -error. - - - - - the #SoupProxyURIResolver - - - - the #SoupURI you want a proxy for - - - - a #GCancellable, or %NULL - - - - on return, will contain the proxy URI - - - - - - - Callback for soup_proxy_uri_resolver_get_proxy_uri_async() - - - - - - the #SoupProxyURIResolver - - - - a #SoupStatus - - - - the resolved proxy URI, or %NULL - - - - data passed to soup_proxy_uri_resolver_get_proxy_uri_async() - - - - - - - - - - - - - - - - the #SoupProxyURIResolver - - - - the #SoupURI you want a proxy for - - - - the #GMainContext to invoke @callback in - - - - a #GCancellable, or %NULL - - - - callback to invoke with the proxy address - - - - data for @callback - - - - - - - - - %SOUP_STATUS_OK if successful, or a transport-level -error. - - - - - the #SoupProxyURIResolver - - - - the #SoupURI you want a proxy for - - - - a #GCancellable, or %NULL - - - - on return, will contain the proxy URI - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Alias for the #SoupRequest:session property, qv. - - - - Alias for the #SoupRequest:uri property, qv. - - - - Represents a byte range as used in the Range header. - -If @end is non-negative, then @start and @end represent the bounds -of of the range, counting from 0. (Eg, the first 500 bytes would be -represented as @start = 0 and @end = 499.) - -If @end is -1 and @start is non-negative, then this represents a -range starting at @start and ending with the last byte of the -requested resource body. (Eg, all but the first 500 bytes would be -@start = 500, and @end = -1.) - -If @end is -1 and @start is negative, then it represents a "suffix -range", referring to the last -@start bytes of the resource body. -(Eg, the last 500 bytes would be @start = -500 and @end = -1.) - - the start of the range - - - - the end of the range - - - - - A #SoupRequest is created by #SoupSession, and represents a request + + + A #SoupRequest is created by #SoupSession, and represents a request to retrieve a particular URI. - - - - - - - - - - - - - - - - Gets the length of the data represented by @request. For most -request types, this will not be known until after you call -soup_request_send() or soup_request_send_finish(). - - the length of the data represented by @request, - or -1 if not known. - - - - - a #SoupRequest - - - - - - Gets the type of the data represented by @request. For most request -types, this will not be known until after you call -soup_request_send() or soup_request_send_finish(). - -As in the HTTP Content-Type header, this may include parameters -after the MIME type. - - the type of the data represented by - @request, or %NULL if not known. - - - - - a #SoupRequest - - - - - - Synchronously requests the URI pointed to by @request, and returns -a #GInputStream that can be used to read its contents. - -Note that you cannot use this method with #SoupRequests attached to -a #SoupSessionAsync. - - a #GInputStream that can be used to - read from the URI pointed to by @request. - - - - - a #SoupRequest - - - - a #GCancellable or %NULL - - - - - - Begins an asynchronously request for the URI pointed to by -@request. - -Note that you cannot use this method with #SoupRequests attached to -a #SoupSessionSync. - - - - - - a #SoupRequest - - - - a #GCancellable or %NULL - - - - a #GAsyncReadyCallback - - - - user data passed to @callback - - - - - - Gets the result of a soup_request_send_async(). - - a #GInputStream that can be used to - read from the URI pointed to by @request. - - - - - a #SoupRequest - - - - the #GAsyncResult - - - - - - Gets the length of the data represented by @request. For most -request types, this will not be known until after you call -soup_request_send() or soup_request_send_finish(). - - the length of the data represented by @request, - or -1 if not known. - - - - - a #SoupRequest - - - - - - Gets the type of the data represented by @request. For most request -types, this will not be known until after you call -soup_request_send() or soup_request_send_finish(). - -As in the HTTP Content-Type header, this may include parameters -after the MIME type. - - the type of the data represented by - @request, or %NULL if not known. - - - - - a #SoupRequest - - - - - - Gets @request's #SoupSession - - @request's #SoupSession - - - - - a #SoupRequest - - - - - - Gets @request's URI - - @request's URI - - - - - a #SoupRequest - - - - - - Synchronously requests the URI pointed to by @request, and returns -a #GInputStream that can be used to read its contents. - -Note that you cannot use this method with #SoupRequests attached to -a #SoupSessionAsync. - - a #GInputStream that can be used to - read from the URI pointed to by @request. - - - - - a #SoupRequest - - - - a #GCancellable or %NULL - - - - - - Begins an asynchronously request for the URI pointed to by -@request. - -Note that you cannot use this method with #SoupRequests attached to -a #SoupSessionSync. - - - - - - a #SoupRequest - - - - a #GCancellable or %NULL - - - - a #GAsyncReadyCallback - - - - user data passed to @callback - - - - - - Gets the result of a soup_request_send_async(). - - a #GInputStream that can be used to - read from the URI pointed to by @request. - - - - - a #SoupRequest - - - - the #GAsyncResult - - - - - - The request's #SoupSession. - - - - The request URI. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - a #GInputStream that can be used to - read from the URI pointed to by @request. - - - - - a #SoupRequest - - - - a #GCancellable or %NULL - - - - - - - - - - - - - a #SoupRequest - - - - a #GCancellable or %NULL - - - - a #GAsyncReadyCallback - - - - user data passed to @callback - - - - - - - - - a #GInputStream that can be used to - read from the URI pointed to by @request. - - - - - a #SoupRequest - - - - the #GAsyncResult - - - - - - - - - the length of the data represented by @request, - or -1 if not known. - - - - - a #SoupRequest - - - - - - - - - the type of the data represented by - @request, or %NULL if not known. - - - - - a #SoupRequest - - - - - - - - #SoupRequestData implements #SoupRequest for "data" URIs. - - - - - - - - - - - - - - - - A #SoupRequest error. - - the URI could not be parsed - - - the URI scheme is not - supported by this #SoupSession - - - the server's response could not - be parsed - - - the server's response was in an - unsupported format - - - - - - - - - #SoupRequestFile implements #SoupRequest for "file" and "resource" + + + #SoupRequestData implements #SoupRequest for "data" URIs. + + + #SoupRequestFile implements #SoupRequest for "file" and "resource" URIs. - - - Gets a #GFile corresponding to @file's URI - - a #GFile corresponding to @file - - - - - a #SoupRequestFile - - - - - - - - - - - - - - - - - - - #SoupRequestHTTP implements #SoupRequest for "http" and "https" + + + #SoupRequestHTTP implements #SoupRequest for "http" and "https" URIs. To do more complicated HTTP operations using the #SoupRequest APIs, call soup_request_http_get_message() to get the request's #SoupMessage. - - - Gets a new reference to the #SoupMessage associated to this SoupRequest - - a new reference to the #SoupMessage - - - - - a #SoupRequestHTTP object - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Alias for the #SoupServer:add-websocket-extension property, qv. - - - - Alias for the deprecated #SoupServer:async-context -property, qv. - The new API uses the thread-default #GMainContext -rather than having an explicitly-specified one. - - - - - - - - - - - - - - - - Alias for the #SoupServer:https-aliases property, qv. - - - - Alias for the #SoupServer:http-aliases property, qv. - - - - Alias for the #SoupServer:interface property, qv. - #SoupServers can listen on multiple interfaces -at once now. Use soup_server_listen(), etc, to listen on an -interface, and soup_server_get_uris() to see what addresses -are being listened on. - - - - Alias for the deprecated #SoupServer:port property, qv. - #SoupServers can listen on multiple interfaces -at once now. Use soup_server_listen(), etc, to listen on a -port, and soup_server_get_uris() to see what ports are -being listened on. - - - - Alias for the #SoupServer:raw-paths property. (If %TRUE, -percent-encoding in the Request-URI path will not be -automatically decoded.) - - - - Alias for the #SoupServer:remove-websocket-extension property, qv. - - - - Alias for the #SoupServer:server-header property, qv. - - - - Alias for the #SoupServer:ssl-cert-file property, qv. - use #SoupServer:tls-certificate or -soup_server_set_ssl_certificate(). - - - - Alias for the #SoupServer:ssl-key-file property, qv. - use #SoupServer:tls-certificate or -soup_server_set_ssl_certificate(). - - - - Alias for the #SoupServer:tls-certificate property, qv. - - - - - - - - - - Alias for the #SoupSession:accept-language property, qv. - - - - Alias for the #SoupSession:accept-language-auto property, qv. - - - - Alias for the #SoupSession:add-feature property, qv. - - - - Alias for the #SoupSession:add-feature-by-type property, qv. - - - - - - - - - - - - - - - - Alias for the #SoupSession:async-context property, qv. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Alias for the #SoupSession:https-aliases property, qv. - - - - Alias for the #SoupSession:http-aliases property, qv. - - - - Alias for the #SoupSession:idle-timeout property, qv. - - - - Alias for the #SoupSession:local-address property, qv. - - - - Alias for the #SoupSession:max-conns property, qv. - - - - Alias for the #SoupSession:max-conns-per-host property, qv. - - - - Alias for the #SoupSession:proxy-resolver property, qv. - - - - Alias for the #SoupSession:proxy-uri property, qv. - - - - Alias for the #SoupSession:remove-feature-by-type property, -qv. - - - - Alias for the #SoupSession:ssl-ca-file property, qv. - - - - Alias for the #SoupSession:ssl-strict property, qv. - - - - Alias for the #SoupSession:ssl-use-system-ca-file property, -qv. - - - - - - - - - - - - - - - - - - - - - - Alias for the #SoupSession:timeout property, qv. - - - - Alias for the #SoupSession:tls-database property, qv. - - - - Alias for the #SoupSession:tls-interaction property, qv. - - - - Alias for the #SoupSession:user-agent property, qv. - - - - Alias for the #SoupSession:use-ntlm property, qv. - - - - Alias for the #SoupSession:use-thread-context property, qv. - - - - - - - - - - Alias for the #SoupSocket:async-context property. (The -socket's #GMainContext.) - - - - - - - - - - Alias for the #SoupSocket:non-blocking property. (Whether -or not the socket uses non-blocking I/O.) - - - - - - - - - - Alias for the #SoupSocket:is-server property, qv. - - - - Alias for the #SoupSocket:local-address property. (Address -of local end of socket.) - - - - Alias for the #SoupSocket:remote-address property. (Address -of remote end of socket.) - - - - Alias for the #SoupSocket:ssl-creds property. -(SSL credential information.) - - - - Alias for the #SoupSocket:ssl-fallback property. - - - - Alias for the #SoupSocket:ssl-strict property. - - - - Alias for the #SoupSocket:timeout property. (The timeout -in seconds for blocking socket I/O operations.) - - - - Alias for the #SoupSocket:tls-certificate -property. Note that this property's value is only useful -if the socket is for a TLS connection, and only reliable -after some data has been transferred to or from it. - - - - Alias for the #SoupSocket:tls-errors -property. Note that this property's value is only useful -if the socket is for a TLS connection, and only reliable -after some data has been transferred to or from it. - - - - Alias for the #SoupSocket:trusted-certificate -property. - - - - Alias for the #SoupSocket:use-thread-context property. (Use -g_main_context_get_thread_default()) - - - - Tests if @status is a Client Error (4xx) response. - - - an HTTP status code - - - - - Tests if @status is an Informational (1xx) response. - - - an HTTP status code - - - - - Tests if @status is a Redirection (3xx) response. - - - an HTTP status code - - - - - Tests if @status is a Server Error (5xx) response. - - - an HTTP status code - - - - - Tests if @status is a Successful (2xx) response. - - - an HTTP status code - - - - - Tests if @status is a libsoup transport error. - - - a status code - - - - - - The cookie is exposed with both cross-site and same-site requests - - - The cookie is withheld on cross-site requests but exposed on cross-site navigations - - - The cookie is only exposed for same-site requests - - - - #SoupServer implements a simple HTTP server. + + + #SoupServer implements a simple HTTP server. (The following documentation describes the current #SoupServer API, available in <application>libsoup</application> 2.48 and later. See @@ -11620,1279 +29472,11 @@ function.). #SoupServer will begin processing connections as soon as you return to (or start) the main loop for the current thread-default #GMainContext. - - Creates a new #SoupServer. This is exactly equivalent to calling -g_object_new() and specifying %SOUP_TYPE_SERVER as the type. - - a new #SoupServer. If you are using -certain legacy properties, this may also return %NULL if an error -occurs. - - - - - name of first property to set - - - - value of @optname1, followed by additional property/value pairs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Add a new client stream to the @server. - - %TRUE on success, %FALSE if the stream could not be -accepted or any other error occurred (in which case @error will be -set). - - - - - a #SoupServer - - - - a #GIOStream - - - - the local #GSocketAddress associated with the @stream - - - - the remote #GSocketAddress associated with the @stream - - - - - - Adds an authentication domain to @server. Each auth domain will -have the chance to require authentication for each request that -comes in; normally auth domains will require authentication for -requests on certain paths that they have been set up to watch, or -that meet other criteria set by the caller. If an auth domain -determines that a request requires authentication (and the request -doesn't contain authentication), @server will automatically reject -the request with an appropriate status (401 Unauthorized or 407 -Proxy Authentication Required). If the request used the -"100-continue" Expectation, @server will reject it before the -request body is sent. - - - - - - a #SoupServer - - - - a #SoupAuthDomain - - - - - - Adds an "early" handler to @server for requests under @path. Note -that "normal" and "early" handlers are matched up together, so if -you add a normal handler for "/foo" and an early handler for -"/foo/bar", then a request to "/foo/bar" (or any path below it) -will run only the early handler. (But if you add both handlers at -the same path, then both will get run.) - -For requests under @path (that have not already been assigned a -status code by a #SoupAuthDomain or a signal handler), @callback -will be invoked after receiving the request headers, but before -receiving the request body; the message's #SoupMessage:method and -#SoupMessage:request-headers fields will be filled in. - -Early handlers are generally used for processing requests with -request bodies in a streaming fashion. If you determine that the -request will contain a message body, normally you would call -soup_message_body_set_accumulate() on the message's -#SoupMessage:request-body to turn off request-body accumulation, -and connect to the message's #SoupMessage::got-chunk signal to -process each chunk as it comes in. - -To complete the message processing after the full message body has -been read, you can either also connect to #SoupMessage::got-body, -or else you can register a non-early handler for @path as well. As -long as you have not set the #SoupMessage:status-code by the time -#SoupMessage::got-body is emitted, the non-early handler will be -run as well. - - - - - - a #SoupServer - - - - the toplevel path for the handler - - - - callback to invoke for requests under @path - - - - data for @callback - - - - destroy notifier to free @user_data - - - - - - Adds a handler to @server for requests under @path. If @path is -%NULL or "/", then this will be the default handler for all -requests that don't have a more specific handler. (Note though that -if you want to handle requests to the special "*" URI, you must -explicitly register a handler for "*"; the default handler will not -be used for that case.) - -For requests under @path (that have not already been assigned a -status code by a #SoupAuthDomain, an early #SoupServerHandler, or a -signal handler), @callback will be invoked after receiving the -request body; the message's #SoupMessage:method, -#SoupMessage:request-headers, and #SoupMessage:request-body fields -will be filled in. - -After determining what to do with the request, the callback must at -a minimum call soup_message_set_status() (or -soup_message_set_status_full()) on the message to set the response -status code. Additionally, it may set response headers and/or fill -in the response body. - -If the callback cannot fully fill in the response before returning -(eg, if it needs to wait for information from a database, or -another network server), it should call soup_server_pause_message() -to tell @server to not send the response right away. When the -response is ready, call soup_server_unpause_message() to cause it -to be sent. - -To send the response body a bit at a time using "chunked" encoding, -first call soup_message_headers_set_encoding() to set -%SOUP_ENCODING_CHUNKED on the #SoupMessage:response-headers. Then call -soup_message_body_append() (or soup_message_body_append_buffer()) -to append each chunk as it becomes ready, and -soup_server_unpause_message() to make sure it's running. (The -server will automatically pause the message if it is using chunked -encoding but no more chunks are available.) When you are done, call -soup_message_body_complete() to indicate that no more chunks are -coming. - - - - - - a #SoupServer - - - - the toplevel path for the handler - - - - callback to invoke for requests under @path - - - - data for @callback - - - - destroy notifier to free @user_data - - - - - - Add support for a WebSocket extension of the given @extension_type. -When a WebSocket client requests an extension of @extension_type, -a new #SoupWebsocketExtension of type @extension_type will be created -to handle the request. - -You can also add support for a WebSocket extension to the server at -construct time by using the %SOUP_SERVER_ADD_WEBSOCKET_EXTENSION property. -Note that #SoupWebsocketExtensionDeflate is supported by default, use -soup_server_remove_websocket_extension() if you want to disable it. - - - - - - a #SoupServer - - - - a #GType - - - - - - Adds a WebSocket handler to @server for requests under @path. (If -@path is %NULL or "/", then this will be the default handler for -all requests that don't have a more specific handler.) - -When a path has a WebSocket handler registered, @server will check -incoming requests for WebSocket handshakes after all other handlers -have run (unless some earlier handler has already set a status code -on the message), and update the request's status, response headers, -and response body accordingly. - -If @origin is non-%NULL, then only requests containing a matching -"Origin" header will be accepted. If @protocols is non-%NULL, then -only requests containing a compatible "Sec-WebSocket-Protocols" -header will be accepted. More complicated requirements can be -handled by adding a normal handler to @path, and having it perform -whatever checks are needed (possibly calling -soup_server_check_websocket_handshake() one or more times), and -setting a failure status code if the handshake should be rejected. - - - - - - a #SoupServer - - - - the toplevel path for the handler - - - - the origin of the connection - - - - the protocols - supported by this handler - - - - - - callback to invoke for successful WebSocket requests under @path - - - - data for @callback - - - - destroy notifier to free @user_data - - - - - - Closes and frees @server's listening sockets. If you are using the -old #SoupServer APIs, this also includes the effect of -soup_server_quit(). - -Note that if there are currently requests in progress on @server, -that they will continue to be processed if @server's #GMainContext -is still running. - -You can call soup_server_listen(), etc, after calling this function -if you want to start listening again. - - - - - - a #SoupServer - - - - - - Gets @server's async_context, if you are using the old API. (With -the new API, the server runs in the thread's thread-default -#GMainContext, regardless of what this method returns.) - -This does not add a ref to the context, so you will need to ref it -yourself if you want it to outlive its server. - If you are using soup_server_listen(), etc, then -the server listens on the thread-default #GMainContext, and this -property is ignored. - - @server's #GMainContext, -which may be %NULL - - - - - a #SoupServer - - - - - - Gets @server's listening socket, if you are using the old API. - -You should treat this socket as read-only; writing to it or -modifiying it may cause @server to malfunction. - If you are using soup_server_listen(), etc, then use -soup_server_get_listeners() to get a list of all listening sockets, -but note that that function returns #GSockets, not #SoupSockets. - - the listening socket. - - - - - a #SoupServer - - - - - - Gets @server's list of listening sockets. - -You should treat these sockets as read-only; writing to or -modifiying any of these sockets may cause @server to malfunction. - -(Beware that in contrast to the old soup_server_get_listener(), this -function returns #GSockets, not #SoupSockets.) - - a -list of listening sockets. - - - - - - - a #SoupServer - - - - - - Gets the TCP port that @server is listening on, if you are using -the old API. - If you are using soup_server_listen(), etc, then use -soup_server_get_uris() to get a list of all listening addresses. - - the port @server is listening on. - - - - - a #SoupServer - - - - - - Gets a list of URIs corresponding to the interfaces @server is -listening on. These will contain IP addresses, not hostnames, and -will also indicate whether the given listener is http or https. - -Note that if you used soup_server_listen_all(), the returned URIs -will use the addresses <literal>0.0.0.0</literal> and -<literal>::</literal>, rather than actually returning separate URIs -for each interface on the system. - - a list of -#SoupURIs, which you must free when you are done with it. - - - - - - - a #SoupServer - - - - - - Checks whether @server is capable of https. - -In order for a server to run https, you must call -soup_server_set_ssl_cert_file(), or set the -#SoupServer:tls-certificate property, to provide it with a -certificate to use. - -If you are using the deprecated single-listener APIs, then a return -value of %TRUE indicates that the #SoupServer serves https -exclusively. If you are using soup_server_listen(), etc, then a -%TRUE return value merely indicates that the server is -<emphasis>able</emphasis> to do https, regardless of whether it -actually currently is or not. Use soup_server_get_uris() to see if -it currently has any https listeners. - - %TRUE if @server is configured to serve https. - - - - - a #SoupServer - - - - - - This attempts to set up @server to listen for connections on -@address. - -If @options includes %SOUP_SERVER_LISTEN_HTTPS, and @server has -been configured for TLS, then @server will listen for https -connections on this port. Otherwise it will listen for plain http. - -You may call this method (along with the other "listen" methods) -any number of times on a server, if you want to listen on multiple -ports, or set up both http and https service. - -After calling this method, @server will begin accepting and -processing connections as soon as the appropriate #GMainContext is -run. - -Note that #SoupServer never makes use of dual IPv4/IPv6 sockets; if -@address is an IPv6 address, it will only accept IPv6 connections. -You must configure IPv4 listening separately. - - %TRUE on success, %FALSE if @address could not be -bound or any other error occurred (in which case @error will be -set). - - - - - a #SoupServer - - - - the address of the interface to listen on - - - - listening options for this server - - - - - - This attempts to set up @server to listen for connections on all -interfaces on the system. (That is, it listens on the addresses -<literal>0.0.0.0</literal> and/or <literal>::</literal>, depending -on whether @options includes %SOUP_SERVER_LISTEN_IPV4_ONLY, -%SOUP_SERVER_LISTEN_IPV6_ONLY, or neither.) If @port is specified, -@server will listen on that port. If it is 0, @server will find an -unused port to listen on. (In that case, you can use -soup_server_get_uris() to find out what port it ended up choosing.) - -See soup_server_listen() for more details. - - %TRUE on success, %FALSE if @port could not be bound -or any other error occurred (in which case @error will be set). - - - - - a #SoupServer - - - - the port to listen on, or 0 - - - - listening options for this server - - - - - - This attempts to set up @server to listen for connections on -@fd. - -See soup_server_listen() for more details. - -Note that @server will close @fd when you free it or call -soup_server_disconnect(). - - %TRUE on success, %FALSE if an error occurred (in -which case @error will be set). - - - - - a #SoupServer - - - - the file descriptor of a listening socket - - - - listening options for this server - - - - - - This attempts to set up @server to listen for connections on -"localhost" (that is, <literal>127.0.0.1</literal> and/or -<literal>::1</literal>, depending on whether @options includes -%SOUP_SERVER_LISTEN_IPV4_ONLY, %SOUP_SERVER_LISTEN_IPV6_ONLY, or -neither). If @port is specified, @server will listen on that port. -If it is 0, @server will find an unused port to listen on. (In that -case, you can use soup_server_get_uris() to find out what port it -ended up choosing.) - -See soup_server_listen() for more details. - - %TRUE on success, %FALSE if @port could not be bound -or any other error occurred (in which case @error will be set). - - - - - a #SoupServer - - - - the port to listen on, or 0 - - - - listening options for this server - - - - - - This attempts to set up @server to listen for connections on -@socket. - -See soup_server_listen() for more details. - - %TRUE on success, %FALSE if an error occurred (in -which case @error will be set). - - - - - a #SoupServer - - - - a listening #GSocket - - - - listening options for this server - - - - - - Pauses I/O on @msg. This can be used when you need to return from -the server handler without having the full response ready yet. Use -soup_server_unpause_message() to resume I/O. - -This must only be called on #SoupMessages which were created by the -#SoupServer and are currently doing I/O, such as those passed into a -#SoupServerCallback or emitted in a #SoupServer::request-read signal. - - - - - - a #SoupServer - - - - a #SoupMessage associated with @server. - - - - - - Stops processing for @server, if you are using the old API. Call -this to clean up after soup_server_run_async(), or to terminate a -call to soup_server_run(). - -Note that messages currently in progress will continue to be -handled, if the main loop associated with the server is resumed or -kept running. - -@server is still in a working state after this call; you can start -and stop a server as many times as you want. - When using soup_server_listen(), etc, the server will -always listen for connections, and will process them whenever the -thread-default #GMainContext is running. - - - - - - a #SoupServer - - - - - - Removes @auth_domain from @server. - - - - - - a #SoupServer - - - - a #SoupAuthDomain - - - - - - Removes all handlers (early and normal) registered at @path. - - - - - - a #SoupServer - - - - the toplevel path for the handler - - - - - - Removes support for WebSocket extension of type @extension_type (or any subclass of -@extension_type) from @server. You can also remove extensions enabled by default -from the server at construct time by using the %SOUP_SERVER_REMOVE_WEBSOCKET_EXTENSION -property. - - - - - - a #SoupServer - - - - a #GType - - - - - - Starts @server, if you are using the old API, causing it to listen -for and process incoming connections. Unlike -soup_server_run_async(), this creates a #GMainLoop and runs it, and -it will not return until someone calls soup_server_quit() to stop -the server. - When using soup_server_listen(), etc, the server will -always listen for connections, and will process them whenever the -thread-default #GMainContext is running. - - - - - - a #SoupServer - - - - - - Starts @server, if you are using the old API, causing it to listen -for and process incoming connections. - -The server runs in @server's #GMainContext. It will not actually -perform any processing unless the appropriate main loop is running. -In the simple case where you did not set the server's -%SOUP_SERVER_ASYNC_CONTEXT property, this means the server will run -whenever the glib main loop is running. - When using soup_server_listen(), etc, the server will -always listen for connections, and will process them whenever the -thread-default #GMainContext is running. - - - - - - a #SoupServer - - - - - - Sets @server up to do https, using the SSL/TLS certificate -specified by @ssl_cert_file and @ssl_key_file (which may point to -the same file). - -Alternatively, you can set the #SoupServer:tls-certificate property -at construction time, if you already have a #GTlsCertificate. - - success or failure. - - - - - a #SoupServer - - - - path to a file containing a PEM-encoded SSL/TLS - certificate. - - - - path to a file containing a PEM-encoded private key. - - - - - - Resumes I/O on @msg. Use this to resume after calling -soup_server_pause_message(), or after adding a new chunk to a -chunked response. - -I/O won't actually resume until you return to the main loop. - -This must only be called on #SoupMessages which were created by the -#SoupServer and are currently doing I/O, such as those passed into a -#SoupServerCallback or emitted in a #SoupServer::request-read signal. - - - - - - a #SoupServer - - - - a #SoupMessage associated with @server. - - - - - - Add support for #SoupWebsocketExtension of the given type. -(Shortcut for calling soup_server_add_websocket_extension().) - - - - The server's #GMainContext, if you are using the old API. -Servers created using soup_server_listen() will listen on -the #GMainContext that was the thread-default context at -the time soup_server_listen() was called. - The new API uses the thread-default #GMainContext -rather than having an explicitly-specified one. - - - - A %NULL-terminated array of URI schemes that should be -considered to be aliases for "http". Eg, if this included -<literal>"dav"</literal>, than a URI of -<literal>dav://example.com/path</literal> would be treated -identically to <literal>http://example.com/path</literal>. -In particular, this is needed in cases where a client -sends requests with absolute URIs, where those URIs do -not use "http:". - -The default value is an array containing the single element -<literal>"*"</literal>, a special value which means that -any scheme except "https" is considered to be an alias for -"http". - -See also #SoupServer:https-aliases. - - - - - - A comma-delimited list of URI schemes that should be -considered to be aliases for "https". See -#SoupServer:http-aliases for more information. - -The default value is %NULL, meaning that no URI schemes -are considered aliases for "https". - - - - - - The address of the network interface the server is -listening on, if you are using the old #SoupServer API. -(This will not be set if you use soup_server_listen(), -etc.) - #SoupServers can listen on multiple interfaces -at once now. Use soup_server_listen(), etc, to listen on an -interface, and soup_server_get_uris() to see what addresses -are being listened on. - - - - The port the server is listening on, if you are using the -old #SoupServer API. (This will not be set if you use -soup_server_listen(), etc.) - #SoupServers can listen on multiple interfaces -at once now. Use soup_server_listen(), etc, to listen on a -port, and soup_server_get_uris() to see what ports are -being listened on. - - - - - - - Remove support for #SoupWebsocketExtension of the given type. (Shortcut for -calling soup_server_remove_websocket_extension().) - - - - If non-%NULL, the value to use for the "Server" header on -#SoupMessage<!-- -->s processed by this server. - -The Server header is the server equivalent of the -User-Agent header, and provides information about the -server and its components. It contains a list of one or -more product tokens, separated by whitespace, with the most -significant product token coming first. The tokens must be -brief, ASCII, and mostly alphanumeric (although "-", "_", -and "." are also allowed), and may optionally include a "/" -followed by a version string. You may also put comments, -enclosed in parentheses, between or after the tokens. - -Some HTTP server implementations intentionally do not use -version numbers in their Server header, so that -installations running older versions of the server don't -end up advertising their vulnerability to specific security -holes. - -As with #SoupSession:user_agent, if you set a -#SoupServer:server_header property that has trailing whitespace, -#SoupServer will append its own product token (eg, -"<literal>libsoup/2.3.2</literal>") to the end of the -header for you. - - - - Path to a file containing a PEM-encoded certificate. - -If you set this property and #SoupServer:ssl-key-file at -construct time, then soup_server_new() will try to read the -files; if it cannot, it will return %NULL, with no explicit -indication of what went wrong (and logging a warning with -newer versions of glib, since returning %NULL from a -constructor is illegal). - use #SoupServer:tls-certificate or -soup_server_set_ssl_certificate(). - - - - Path to a file containing a PEM-encoded private key. See -#SoupServer:ssl-cert-file for more information about how this -is used. - use #SoupServer:tls-certificate or -soup_server_set_ssl_certificate(). - - - - A #GTlsCertificate that has a #GTlsCertificate:private-key -set. If this is set, then the server will be able to speak -https in addition to (or instead of) plain http. - -Alternatively, you can call soup_server_set_ssl_cert_file() -to have #SoupServer read in a a certificate from a file. - - - - - - - Emitted when processing has failed for a message; this -could mean either that it could not be read (if -#SoupServer::request_read has not been emitted for it yet), -or that the response could not be written back (if -#SoupServer::request_read has been emitted but -#SoupServer::request_finished has not been). - -@message is in an undefined state when this signal is -emitted; the signal exists primarily to allow the server to -free any state that it may have allocated in -#SoupServer::request_started. - - - - - - the message - - - - the client context - - - - - - Emitted when the server has finished writing a response to -a request. - - - - - - the message - - - - the client context - - - - - - Emitted when the server has successfully read a request. -@message will have all of its request-side information -filled in, and if the message was authenticated, @client -will have information about that. This signal is emitted -before any (non-early) handlers are called for the message, -and if it sets the message's #status_code, then normal -handler processing will be skipped. - - - - - - the message - - - - the client context - - - - - - Emitted when the server has started reading a new request. -@message will be completely blank; not even the -Request-Line will have been read yet. About the only thing -you can usefully do with it is connect to its signals. - -If the request is read successfully, this will eventually -be followed by a #SoupServer::request_read signal. If a -response is then sent, the request processing will end with -a #SoupServer::request_finished signal. If a network error -occurs, the processing will instead end with -#SoupServer::request_aborted. - - - - - - the new message - - - - the client context - - - - - - - A callback used to handle requests to a #SoupServer. - -@path and @query contain the likewise-named components of the -Request-URI, subject to certain assumptions. By default, -#SoupServer decodes all percent-encoding in the URI path, such that -"/foo%<!-- -->2Fbar" is treated the same as "/foo/bar". If your -server is serving resources in some non-POSIX-filesystem namespace, -you may want to distinguish those as two distinct paths. In that -case, you can set the %SOUP_SERVER_RAW_PATHS property when creating -the #SoupServer, and it will leave those characters undecoded. (You -may want to call soup_uri_normalize() to decode any percent-encoded -characters that you aren't handling specially.) - -@query contains the query component of the Request-URI parsed -according to the rules for HTML form handling. Although this is the -only commonly-used query string format in HTTP, there is nothing -that actually requires that HTTP URIs use that format; if your -server needs to use some other format, you can just ignore @query, -and call soup_message_get_uri() and parse the URI's query field -yourself. - -See soup_server_add_handler() and soup_server_add_early_handler() -for details of what handlers can/should do. - - - - - - the #SoupServer - - - - the message being processed - - - - the path component of @msg's Request-URI - - - - the parsed query - component of @msg's Request-URI - - - - - - - additional contextual information about the client - - - - the data passed to soup_server_add_handler() or - soup_server_add_early_handler(). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Options to pass to soup_server_listen(), etc. - -%SOUP_SERVER_LISTEN_IPV4_ONLY and %SOUP_SERVER_LISTEN_IPV6_ONLY -only make sense with soup_server_listen_all() and -soup_server_listen_local(), not plain soup_server_listen() (which -simply listens on whatever kind of socket you give it). And you -cannot specify both of them in a single call. - - Listen for https connections rather - than plain http. - - - Only listen on IPv4 interfaces. - - - Only listen on IPv6 interfaces. - - - - A callback used to handle WebSocket requests to a #SoupServer. The -callback will be invoked after sending the handshake response back -to the client (and is only invoked if the handshake was -successful). - -@path contains the path of the Request-URI, subject to the same -rules as #SoupServerCallback (qv). - - - - - - the #SoupServer - - - - the newly created WebSocket connection - - - - the path component of @msg's Request-URI - - - - additional contextual information about the client - - - - the data passed to @soup_server_add_handler - - - - - - #SoupSession is the object that controls client-side HTTP. A + + + #SoupSession is the object that controls client-side HTTP. A #SoupSession encapsulates all of the state that libsoup is keeping on behalf of your program; cached HTTP connections, authentication information, etc. It also keeps track of various global options @@ -12936,6201 +29520,69 @@ for %SOUP_TYPE_AUTH_BASIC and %SOUP_TYPE_AUTH_DIGEST. For #SoupRequestData are supported. Additionally, sessions using the plain #SoupSession class (rather than one of its deprecated subtypes) have a #SoupContentDecoder by default. - - Creates a #SoupSession with the default options. - - the new session. - - - - - Creates a #SoupSession with the specified options. - - the new session. - - - - - name of first property to set - - - - value of @optname1, followed by additional property/value pairs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Causes @session to immediately finish processing @msg (regardless -of its current state) with a final status_code of @status_code. You -may call this at any time after handing @msg off to @session; if -@session has started sending the request but has not yet received -the complete response, then it will close the request's connection. -Note that with requests that have side effects (eg, -<literal>POST</literal>, <literal>PUT</literal>, -<literal>DELETE</literal>) it is possible that you might cancel the -request after the server acts on it, but before it returns a -response, leaving the remote resource in an unknown state. - -If the message is cancelled while its response body is being read, -then the response body in @msg will be left partially-filled-in. -The response headers, on the other hand, will always be either -empty or complete. - -Beware that with the deprecated #SoupSessionAsync, messages queued -with soup_session_queue_message() will have their callbacks invoked -before soup_session_cancel_message() returns. The plain -#SoupSession does not have this behavior; cancelling an -asynchronous message will merely queue its callback to be run after -returning to the main loop. - - - - - - a #SoupSession - - - - the message to cancel - - - - status code to set on @msg (generally -%SOUP_STATUS_CANCELLED) - - - - - - - - - - - - - - - - - - - - - - - - - - Queues the message @msg for asynchronously sending the request and -receiving a response in the current thread-default #GMainContext. -If @msg has been processed before, any resources related to the -time it was last sent are freed. - -Upon message completion, the callback specified in @callback will -be invoked. If after returning from this callback the message has not -been requeued, @msg will be unreffed. - -(The behavior above applies to a plain #SoupSession; if you are -using #SoupSessionAsync or #SoupSessionSync, then the #GMainContext -that is used depends on the settings of #SoupSession:async-context -and #SoupSession:use-thread-context, and for #SoupSessionSync, the -message will actually be sent and processed in another thread, with -only the final callback occurring in the indicated #GMainContext.) - -Contrast this method with soup_session_send_async(), which also -asynchronously sends a message, but returns before reading the -response body, and allows you to read the response via a -#GInputStream. - - - - - - a #SoupSession - - - - the message to queue - - - - a #SoupSessionCallback which will -be called after the message completes or when an unrecoverable error occurs. - - - - a pointer passed to @callback. - - - - - - - - - - - - - - - - - - - - - - This causes @msg to be placed back on the queue to be attempted -again. - - - - - - a #SoupSession - - - - the message to requeue - - - - - - Synchronously send @msg. This call will not return until the -transfer is finished successfully or there is an unrecoverable -error. - -Unlike with soup_session_queue_message(), @msg is not freed upon -return. - -(Note that if you call this method on a #SoupSessionAsync, it will -still use asynchronous I/O internally, running the glib main loop -to process the message, which may also cause other events to be -processed.) - -Contrast this method with soup_session_send(), which also -synchronously sends a message, but returns before reading the -response body, and allows you to read the response via a -#GInputStream. - - the HTTP status code of the response - - - - - a #SoupSession - - - - the message to send - - - - - - Cancels all pending requests in @session and closes all idle -persistent connections. - -The message cancellation has the same semantics as with -soup_session_cancel_message(); asynchronous requests on a -#SoupSessionAsync will have their callback called before -soup_session_abort() returns. Requests on a plain #SoupSession will -not. - - - - - - the session - - - - - - Adds @feature's functionality to @session. You can also add a -feature to the session at construct time by using the -%SOUP_SESSION_ADD_FEATURE property. - -See the main #SoupSession documentation for information on what -features are present in sessions by default. - - - - - - a #SoupSession - - - - an object that implements #SoupSessionFeature - - - - - - If @feature_type is the type of a class that implements -#SoupSessionFeature, this creates a new feature of that type and -adds it to @session as with soup_session_add_feature(). You can use -this when you don't need to customize the new feature in any way. - -If @feature_type is not a #SoupSessionFeature type, this gives each -existing feature on @session the chance to accept @feature_type as -a "subfeature". This can be used to add new #SoupAuth or -#SoupRequest types, for instance. - -You can also add a feature to the session at construct time by -using the %SOUP_SESSION_ADD_FEATURE_BY_TYPE property. - -See the main #SoupSession documentation for information on what -features are present in sessions by default. - - - - - - a #SoupSession - - - - a #GType - - - - - - Causes @session to immediately finish processing @msg (regardless -of its current state) with a final status_code of @status_code. You -may call this at any time after handing @msg off to @session; if -@session has started sending the request but has not yet received -the complete response, then it will close the request's connection. -Note that with requests that have side effects (eg, -<literal>POST</literal>, <literal>PUT</literal>, -<literal>DELETE</literal>) it is possible that you might cancel the -request after the server acts on it, but before it returns a -response, leaving the remote resource in an unknown state. - -If the message is cancelled while its response body is being read, -then the response body in @msg will be left partially-filled-in. -The response headers, on the other hand, will always be either -empty or complete. - -Beware that with the deprecated #SoupSessionAsync, messages queued -with soup_session_queue_message() will have their callbacks invoked -before soup_session_cancel_message() returns. The plain -#SoupSession does not have this behavior; cancelling an -asynchronous message will merely queue its callback to be run after -returning to the main loop. - - - - - - a #SoupSession - - - - the message to cancel - - - - status code to set on @msg (generally -%SOUP_STATUS_CANCELLED) - - - - - - Start a connection to @uri. The operation can be monitored by providing a @progress_callback -and finishes when the connection is done or an error ocurred. - -Call soup_session_connect_finish() to get the #GIOStream to communicate with the server. - - - - - - a #SoupSession - - - - a #SoupURI to connect to - - - - a #GCancellable - - - - a #SoupSessionConnectProgressCallback which -will be called for every network event that occurs during the connection. - - - - the callback to invoke when the operation finishes - - - - data for @progress_callback and @callback - - - - - - Gets the #GIOStream created for the connection to communicate with the server. - - a new #GIOStream, or %NULL on error. - - - - - a #SoupSession - - - - the #GAsyncResult passed to your callback - - - - - - Gets @session's #SoupSession:async-context. This does not add a ref -to the context, so you will need to ref it yourself if you want it -to outlive its session. - -For a modern #SoupSession, this will always just return the -thread-default #GMainContext, and so is not especially useful. - - @session's #GMainContext, -which may be %NULL - - - - - a #SoupSession - - - - - - Gets the first feature in @session of type @feature_type. For -features where there may be more than one feature of a given type, -use soup_session_get_features(). - - a #SoupSessionFeature, or -%NULL. The feature is owned by @session. - - - - - a #SoupSession - - - - the #GType of the feature to get - - - - - - Gets the first feature in @session of type @feature_type, provided -that it is not disabled for @msg. As with -soup_session_get_feature(), this should only be used for features -where @feature_type is only expected to match a single feature. In -particular, if there are two matching features, and the first is -disabled on @msg, and the second is not, then this will return -%NULL, not the second feature. - - a #SoupSessionFeature, or %NULL. The -feature is owned by @session. - - - - - a #SoupSession - - - - the #GType of the feature to get - - - - a #SoupMessage - - - - - - Generates a list of @session's features of type @feature_type. (If -you want to see all features, you can pass %SOUP_TYPE_SESSION_FEATURE -for @feature_type.) - - -a list of features. You must free the list, but not its contents - - - - - - - a #SoupSession - - - - the #GType of the class of features to get - - - - - - Tests if @session has at a feature of type @feature_type (which can -be the type of either a #SoupSessionFeature, or else a subtype of -some class managed by another feature, such as #SoupAuth or -#SoupRequest). - - %TRUE or %FALSE - - - - - a #SoupSession - - - - the #GType of the class of features to check for - - - - - - Pauses HTTP I/O on @msg. Call soup_session_unpause_message() to -resume I/O. - -This may only be called for asynchronous messages (those sent on a -#SoupSessionAsync or using soup_session_queue_message()). - - - - - - a #SoupSession - - - - a #SoupMessage currently running on @session - - - - - - Tells @session that an URI from the given @hostname may be requested -shortly, and so the session can try to prepare by resolving the -domain name in advance, in order to work more quickly once the URI -is actually requested. - -If @cancellable is non-%NULL, it can be used to cancel the -resolution. @callback will still be invoked in this case, with a -status of %SOUP_STATUS_CANCELLED. - - - - - - a #SoupSession - - - - a hostname to be resolved - - - - a #GCancellable object, or %NULL - - - - callback to call with the - result, or %NULL - - - - data for @callback - - - - - - Tells @session that @uri may be requested shortly, and so the -session can try to prepare (resolving the domain name, obtaining -proxy address, etc.) in order to work more quickly once the URI is -actually requested. - use soup_session_prefetch_dns() instead - - - - - - a #SoupSession - - - - a #SoupURI which may be required - - - - - - Queues the message @msg for asynchronously sending the request and -receiving a response in the current thread-default #GMainContext. -If @msg has been processed before, any resources related to the -time it was last sent are freed. - -Upon message completion, the callback specified in @callback will -be invoked. If after returning from this callback the message has not -been requeued, @msg will be unreffed. - -(The behavior above applies to a plain #SoupSession; if you are -using #SoupSessionAsync or #SoupSessionSync, then the #GMainContext -that is used depends on the settings of #SoupSession:async-context -and #SoupSession:use-thread-context, and for #SoupSessionSync, the -message will actually be sent and processed in another thread, with -only the final callback occurring in the indicated #GMainContext.) - -Contrast this method with soup_session_send_async(), which also -asynchronously sends a message, but returns before reading the -response body, and allows you to read the response via a -#GInputStream. - - - - - - a #SoupSession - - - - the message to queue - - - - a #SoupSessionCallback which will -be called after the message completes or when an unrecoverable error occurs. - - - - a pointer passed to @callback. - - - - - - Updates @msg's URI according to its status code and "Location" -header, and requeues it on @session. Use this when you have set -%SOUP_MESSAGE_NO_REDIRECT on a message, but have decided to allow a -particular redirection to occur, or if you want to allow a -redirection that #SoupSession will not perform automatically (eg, -redirecting a non-safe method such as DELETE). - -If @msg's status code indicates that it should be retried as a GET -request, then @msg will be modified accordingly. - -If @msg has already been redirected too many times, this will -cause it to fail with %SOUP_STATUS_TOO_MANY_REDIRECTS. - - %TRUE if a redirection was applied, %FALSE if not -(eg, because there was no Location header, or it could not be -parsed). - - - - - the session - - - - a #SoupMessage that has received a 3xx response - - - - - - Removes @feature's functionality from @session. - - - - - - a #SoupSession - - - - a feature that has previously been added to @session - - - - - - Removes all features of type @feature_type (or any subclass of -@feature_type) from @session. You can also remove standard features -from the session at construct time by using the -%SOUP_SESSION_REMOVE_FEATURE_BY_TYPE property. - - - - - - a #SoupSession - - - - a #GType - - - - - - Creates a #SoupRequest for retrieving @uri_string. - - a new #SoupRequest, or - %NULL on error. - - - - - a #SoupSession - - - - a URI, in string form - - - - - - Creates a #SoupRequest for retrieving @uri_string, which must be an -"http" or "https" URI (or another protocol listed in @session's -#SoupSession:http-aliases or #SoupSession:https-aliases). - - a new #SoupRequestHTTP, or - %NULL on error. - - - - - a #SoupSession - - - - an HTTP method - - - - a URI, in string form - - - - - - Creates a #SoupRequest for retrieving @uri, which must be an -"http" or "https" URI (or another protocol listed in @session's -#SoupSession:http-aliases or #SoupSession:https-aliases). - - a new #SoupRequestHTTP, or - %NULL on error. - - - - - a #SoupSession - - - - an HTTP method - - - - a #SoupURI representing the URI to retrieve - - - - - - Creates a #SoupRequest for retrieving @uri. - - a new #SoupRequest, or - %NULL on error. - - - - - a #SoupSession - - - - a #SoupURI representing the URI to retrieve - - - - - - This causes @msg to be placed back on the queue to be attempted -again. - - - - - - a #SoupSession - - - - the message to requeue - - - - - - Synchronously sends @msg and waits for the beginning of a response. -On success, a #GInputStream will be returned which you can use to -read the response body. ("Success" here means only that an HTTP -response was received and understood; it does not necessarily mean -that a 2xx class status code was received.) - -If non-%NULL, @cancellable can be used to cancel the request; -soup_session_send() will return a %G_IO_ERROR_CANCELLED error. Note -that with requests that have side effects (eg, -<literal>POST</literal>, <literal>PUT</literal>, -<literal>DELETE</literal>) it is possible that you might cancel the -request after the server acts on it, but before it returns a -response, leaving the remote resource in an unknown state. - -If @msg is requeued due to a redirect or authentication, the -initial (3xx/401/407) response body will be suppressed, and -soup_session_send() will only return once a final response has been -received. - -Contrast this method with soup_session_send_message(), which also -synchronously sends a #SoupMessage, but doesn't return until the -response has been completely read. - -(Note that this method cannot be called on the deprecated -#SoupSessionAsync subclass.) - - a #GInputStream for reading the - response body, or %NULL on error. - - - - - a #SoupSession - - - - a #SoupMessage - - - - a #GCancellable - - - - - - Asynchronously sends @msg and waits for the beginning of a -response. When @callback is called, then either @msg has been sent, -and its response headers received, or else an error has occurred. -Call soup_session_send_finish() to get a #GInputStream for reading -the response body. - -See soup_session_send() for more details on the general semantics. - -Contrast this method with soup_session_queue_message(), which also -asynchronously sends a #SoupMessage, but doesn't invoke its -callback until the response has been completely read. - -(Note that this method cannot be called on the deprecated -#SoupSessionSync subclass, and can only be called on -#SoupSessionAsync if you have set the -#SoupSession:use-thread-context property.) - - - - - - a #SoupSession - - - - a #SoupMessage - - - - a #GCancellable - - - - the callback to invoke - - - - data for @callback - - - - - - Gets the response to a soup_session_send_async() call and (if -successful), returns a #GInputStream that can be used to read the -response body. - - a #GInputStream for reading the - response body, or %NULL on error. - - - - - a #SoupSession - - - - the #GAsyncResult passed to your callback - - - - - - Synchronously send @msg. This call will not return until the -transfer is finished successfully or there is an unrecoverable -error. - -Unlike with soup_session_queue_message(), @msg is not freed upon -return. - -(Note that if you call this method on a #SoupSessionAsync, it will -still use asynchronous I/O internally, running the glib main loop -to process the message, which may also cause other events to be -processed.) - -Contrast this method with soup_session_send(), which also -synchronously sends a message, but returns before reading the -response body, and allows you to read the response via a -#GInputStream. - - the HTTP status code of the response - - - - - a #SoupSession - - - - the message to send - - - - - - "Steals" the HTTP connection associated with @msg from @session. -This happens immediately, regardless of the current state of the -connection, and @msg's callback will not be called. You can steal -the connection from a #SoupMessage signal handler if you need to -wait for part or all of the response to be received first. - -Calling this function may cause @msg to be freed if you are not -holding any other reference to it. - - the #GIOStream formerly associated - with @msg (or %NULL if @msg was no longer associated with a - connection). No guarantees are made about what kind of #GIOStream - is returned. - - - - - a #SoupSession - - - - the message whose connection is to be stolen - - - - - - Resumes HTTP I/O on @msg. Use this to resume after calling -soup_session_pause_message(). - -If @msg is being sent via blocking I/O, this will resume reading or -writing immediately. If @msg is using non-blocking I/O, then -reading or writing won't resume until you return to the main loop. - -This may only be called for asynchronous messages (those sent on a -#SoupSessionAsync or using soup_session_queue_message()). - - - - - - a #SoupSession - - - - a #SoupMessage currently running on @session - - - - - - Asynchronously creates a #SoupWebsocketConnection to communicate -with a remote server. - -All necessary WebSocket-related headers will be added to @msg, and -it will then be sent and asynchronously processed normally -(including handling of redirection and HTTP authentication). - -If the server returns "101 Switching Protocols", then @msg's status -code and response headers will be updated, and then the WebSocket -handshake will be completed. On success, -soup_session_websocket_connect_finish() will return a new -#SoupWebsocketConnection. On failure it will return a #GError. - -If the server returns a status other than "101 Switching -Protocols", then @msg will contain the complete response headers -and body from the server's response, and -soup_session_websocket_connect_finish() will return -%SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET. - - - - - - a #SoupSession - - - - #SoupMessage indicating the WebSocket server to connect to - - - - origin of the connection - - - - a - %NULL-terminated array of protocols supported - - - - - - a #GCancellable - - - - the callback to invoke - - - - data for @callback - - - - - - Gets the #SoupWebsocketConnection response to a -soup_session_websocket_connect_async() call and (if successful), -returns a #SoupWebsocketConnection that can be used to communicate -with the server. - - a new #SoupWebsocketConnection, or - %NULL on error. - - - - - a #SoupSession - - - - the #GAsyncResult passed to your callback - - - - - - Checks if @msg contains a response that would cause @session to -redirect it to a new URL (ignoring @msg's %SOUP_MESSAGE_NO_REDIRECT -flag, and the number of times it has already been redirected). - - whether @msg would be redirected - - - - - a #SoupSession - - - - a #SoupMessage that has response headers - - - - - - If non-%NULL, the value to use for the "Accept-Language" header -on #SoupMessage<!-- -->s sent from this session. - -Setting this will disable -#SoupSession:accept-language-auto. - - - - If %TRUE, #SoupSession will automatically set the string -for the "Accept-Language" header on every #SoupMessage -sent, based on the return value of g_get_language_names(). - -Setting this will override any previous value of -#SoupSession:accept-language. - - - - Add a feature object to the session. (Shortcut for calling -soup_session_add_feature().) - - - - Add a feature object of the given type to the session. -(Shortcut for calling soup_session_add_feature_by_type().) - - - - The #GMainContext that miscellaneous session-related -asynchronous callbacks are invoked on. (Eg, setting -#SoupSession:idle-timeout will add a timeout source on this -context.) - -For a plain #SoupSession, this property is always set to -the #GMainContext that is the thread-default at the time -the session was created, and cannot be overridden. For the -deprecated #SoupSession subclasses, the default value is -%NULL, meaning to use the global default #GMainContext. - -If #SoupSession:use-thread-context is %FALSE, this context -will also be used for asynchronous HTTP I/O. - - - - A %NULL-terminated array of URI schemes that should be -considered to be aliases for "http". Eg, if this included -<literal>"dav"</literal>, than a URI of -<literal>dav://example.com/path</literal> would be treated -identically to <literal>http://example.com/path</literal>. - -In a plain #SoupSession, the default value is %NULL, -meaning that only "http" is recognized as meaning "http". -In #SoupSessionAsync and #SoupSessionSync, for backward -compatibility, the default value is an array containing the -single element <literal>"*"</literal>, a special value -which means that any scheme except "https" is considered to -be an alias for "http". - -See also #SoupSession:https-aliases. - - - - - - A comma-delimited list of URI schemes that should be -considered to be aliases for "https". See -#SoupSession:http-aliases for more information. - -The default value is %NULL, meaning that no URI schemes -are considered aliases for "https". - - - - - - Connection lifetime (in seconds) when idle. Any connection -left idle longer than this will be closed. - -Although you can change this property at any time, it will -only affect newly-created connections, not currently-open -ones. You can call soup_session_abort() after setting this -if you want to ensure that all future connections will have -this timeout value. - -Note that the default value of 60 seconds only applies to -plain #SoupSessions. If you are using #SoupSessionAsync or -#SoupSessionSync, the default value is 0 (meaning idle -connections will never time out). - - - - Sets the #SoupAddress to use for the client side of -the connection. - -Use this property if you want for instance to bind the -local socket to a specific IP address. - - - - - - - - - - A #GProxyResolver to use with this session. Setting this -will clear the #SoupSession:proxy-uri property, and remove -any <type>SoupProxyURIResolver</type> features that have -been added to the session. - -By default, in a plain #SoupSession, this is set to the -default #GProxyResolver, but you can set it to %NULL if you -don't want to use proxies, or set it to your own -#GProxyResolver if you want to control what proxies get -used. - - - - A proxy to use for all http and https requests in this -session. Setting this will clear the -#SoupSession:proxy-resolver property, and remove any -<type>SoupProxyURIResolver</type> features that have been -added to the session. Setting this property will also -cancel all currently pending messages. - -Note that #SoupSession will normally handle looking up the -user's proxy settings for you; you should only use -#SoupSession:proxy-uri if you need to override the user's -normal proxy settings. - -Also note that this proxy will be used for -<emphasis>all</emphasis> requests; even requests to -<literal>localhost</literal>. If you need more control over -proxies, you can create a #GSimpleProxyResolver and set the -#SoupSession:proxy-resolver property. - Use SoupSession:proxy-resolver along with #GSimpleProxyResolver. - - - - Remove feature objects from the session. (Shortcut for -calling soup_session_remove_feature_by_type().) - - - - File containing SSL CA certificates. - -If the specified file does not exist or cannot be read, -then libsoup will print a warning, and then behave as -though it had read in a empty CA file, meaning that all SSL -certificates will be considered invalid. - use #SoupSession:ssl-use-system-ca-file, or -else #SoupSession:tls-database with a #GTlsFileDatabase -(which allows you to do explicit error handling). - - - - Normally, if #SoupSession:tls-database is set (including if -it was set via #SoupSession:ssl-use-system-ca-file or -#SoupSession:ssl-ca-file), then libsoup will reject any -certificate that is invalid (ie, expired) or that is not -signed by one of the given CA certificates, and the -#SoupMessage will fail with the status -%SOUP_STATUS_SSL_FAILED. - -If you set #SoupSession:ssl-strict to %FALSE, then all -certificates will be accepted, and you will need to call -soup_message_get_https_status() to distinguish valid from -invalid certificates. (This can be used, eg, if you want to -accept invalid certificates after giving some sort of -warning.) - -For a plain #SoupSession, if the session has no CA file or -TLS database, and this property is %TRUE, then all -certificates will be rejected. However, beware that the -deprecated #SoupSession subclasses (#SoupSessionAsync and -#SoupSessionSync) have the opposite behavior: if there is -no CA file or TLS database, then all certificates are always -accepted, and this property has no effect. - - - - Setting this to %TRUE is equivalent to setting -#SoupSession:tls-database to the default system CA database. -(and likewise, setting #SoupSession:tls-database to the -default database by hand will cause this property to -become %TRUE). - -Setting this to %FALSE (when it was previously %TRUE) will -clear the #SoupSession:tls-database field. - -See #SoupSession:ssl-strict for more information on how -https certificate validation is handled. - -Note that the default value of %TRUE only applies to plain -#SoupSessions. If you are using #SoupSessionAsync or -#SoupSessionSync, the default value is %FALSE, for backward -compatibility. - - - - The timeout (in seconds) for socket I/O operations -(including connecting to a server, and waiting for a reply -to an HTTP request). - -Although you can change this property at any time, it will -only affect newly-created connections, not currently-open -ones. You can call soup_session_abort() after setting this -if you want to ensure that all future connections will have -this timeout value. - -Note that the default value of 60 seconds only applies to -plain #SoupSessions. If you are using #SoupSessionAsync or -#SoupSessionSync, the default value is 0 (meaning socket I/O -will not time out). - -Not to be confused with #SoupSession:idle-timeout (which is -the length of time that idle persistent connections will be -kept open). - - - - Sets the #GTlsDatabase to use for validating SSL/TLS -certificates. - -Note that setting the #SoupSession:ssl-ca-file or -#SoupSession:ssl-use-system-ca-file property will cause -this property to be set to a #GTlsDatabase corresponding to -the indicated file or system default. - -See #SoupSession:ssl-strict for more information on how -https certificate validation is handled. - -If you are using a plain #SoupSession then -#SoupSession:ssl-use-system-ca-file will be %TRUE by -default, and so this property will be a copy of the system -CA database. If you are using #SoupSessionAsync or -#SoupSessionSync, this property will be %NULL by default. - - - - A #GTlsInteraction object that will be passed on to any -#GTlsConnections created by the session. (This can be used to -provide client-side certificates, for example.) - - - - Whether or not to use NTLM authentication. - use soup_session_add_feature_by_type() with -#SOUP_TYPE_AUTH_NTLM. - - - - If %TRUE (which it always is on a plain #SoupSession), -asynchronous HTTP requests in this session will run in -whatever the thread-default #GMainContext is at the time -they are started, rather than always occurring in -#SoupSession:async-context. - - - - If non-%NULL, the value to use for the "User-Agent" header -on #SoupMessage<!-- -->s sent from this session. - -RFC 2616 says: "The User-Agent request-header field -contains information about the user agent originating the -request. This is for statistical purposes, the tracing of -protocol violations, and automated recognition of user -agents for the sake of tailoring responses to avoid -particular user agent limitations. User agents SHOULD -include this field with requests." - -The User-Agent header contains a list of one or more -product tokens, separated by whitespace, with the most -significant product token coming first. The tokens must be -brief, ASCII, and mostly alphanumeric (although "-", "_", -and "." are also allowed), and may optionally include a "/" -followed by a version string. You may also put comments, -enclosed in parentheses, between or after the tokens. - -If you set a #SoupSession:user_agent property that has trailing -whitespace, #SoupSession will append its own product token -(eg, "<literal>libsoup/2.3.2</literal>") to the end of the -header for you. - - - - - - - Emitted when the session requires authentication. If -credentials are available call soup_auth_authenticate() on -@auth. If these credentials fail, the signal will be -emitted again, with @retrying set to %TRUE, which will -continue until you return without calling -soup_auth_authenticate() on @auth. - -Note that this may be emitted before @msg's body has been -fully read. - -If you call soup_session_pause_message() on @msg before -returning, then you can authenticate @auth asynchronously -(as long as you g_object_ref() it to make sure it doesn't -get destroyed), and then unpause @msg when you are ready -for it to continue. - - - - - - the #SoupMessage being sent - - - - the #SoupAuth to authenticate - - - - %TRUE if this is the second (or later) attempt - - - - - - Emitted when a new connection is created. This is an -internal signal intended only to be used for debugging -purposes, and may go away in the future. - - - - - - the connection - - - - - - Emitted when a request is queued on @session. (Note that -"queued" doesn't just mean soup_session_queue_message(); -soup_session_send_message() implicitly queues the message -as well.) - -When sending a request, first #SoupSession::request_queued -is emitted, indicating that the session has become aware of -the request. - -Once a connection is available to send the request on, the -session emits #SoupSession::request_started. Then, various -#SoupMessage signals are emitted as the message is -processed. If the message is requeued, it will emit -#SoupMessage::restarted, which will then be followed by -another #SoupSession::request_started and another set of -#SoupMessage signals when the message is re-sent. - -Eventually, the message will emit #SoupMessage::finished. -Normally, this signals the completion of message -processing. However, it is possible that the application -will requeue the message from the "finished" handler (or -equivalently, from the soup_session_queue_message() -callback). In that case, the process will loop back to -#SoupSession::request_started. - -Eventually, a message will reach "finished" and not be -requeued. At that point, the session will emit -#SoupSession::request_unqueued to indicate that it is done -with the message. - -To sum up: #SoupSession::request_queued and -#SoupSession::request_unqueued are guaranteed to be emitted -exactly once, but #SoupSession::request_started and -#SoupMessage::finished (and all of the other #SoupMessage -signals) may be invoked multiple times for a given message. - - - - - - the request that was queued - - - - - - Emitted just before a request is sent. See -#SoupSession::request_queued for a detailed description of -the message lifecycle within a session. - Use #SoupMessage::starting instead. - - - - - - the request being sent - - - - the socket the request is being sent on - - - - - - Emitted when a request is removed from @session's queue, -indicating that @session is done with it. See -#SoupSession::request_queued for a detailed description of the -message lifecycle within a session. - - - - - - the request that was unqueued - - - - - - Emitted when an SSL tunnel is being created on a proxy -connection. This is an internal signal intended only to be -used for debugging purposes, and may go away in the future. - - - - - - the connection - - - - - - - #SoupSessionAsync is an implementation of #SoupSession that uses + + + #SoupSessionAsync is an implementation of #SoupSession that uses non-blocking I/O via the glib main loop for all I/O. - Use the #SoupSession class (which uses both asynchronous -and synchronous I/O, depending on the API used). See the -<link linkend="libsoup-session-porting">porting guide</link>. - - Creates an asynchronous #SoupSession with the default options. - #SoupSessionAsync is deprecated; use a plain -#SoupSession, created with soup_session_new(). See the <link -linkend="libsoup-session-porting">porting guide</link>. - - the new session. - - - - - Creates an asynchronous #SoupSession with the specified options. - #SoupSessionAsync is deprecated; use a plain -#SoupSession, created with soup_session_new_with_options(). See the -<link linkend="libsoup-session-porting">porting guide</link>. - - the new session. - - - - - name of first property to set - - - - value of @optname1, followed by additional property/value pairs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Prototype for the callback passed to soup_session_queue_message(), -qv. - - - - - - the session - - - - the message that has finished - - - - the data passed to soup_session_queue_message - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - a #SoupSession - - - - the message to queue - - - - a #SoupSessionCallback which will -be called after the message completes or when an unrecoverable error occurs. - - - - a pointer passed to @callback. - - - - - - - - - - - - - a #SoupSession - - - - the message to requeue - - - - - - - - - the HTTP status code of the response - - - - - a #SoupSession - - - - the message to send - - - - - - - - - - - - - a #SoupSession - - - - the message to cancel - - - - status code to set on @msg (generally -%SOUP_STATUS_CANCELLED) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Prototype for the progress callback passed to soup_session_connect_async(). - - - - - - the #SoupSession - - - - a #GSocketClientEvent - - - - the current state of the network connection - - - - the data passed to soup_session_connect_async(). - - - - - - #SoupSessionFeature is the interface used by classes that extend + + + #SoupSessionFeature is the interface used by classes that extend the functionality of a #SoupSession. Some features like HTTP authentication handling are implemented internally via #SoupSessionFeature<!-- -->s. Other features can be added to the session by the application. (Eg, #SoupLogger, #SoupCookieJar.) See soup_session_add_feature(), etc, to add a feature to a session. - - Adds a "sub-feature" of type @type to the base feature @feature. -This is used for features that can be extended with multiple -different types. Eg, the authentication manager can be extended -with subtypes of #SoupAuth. - - %TRUE if @feature accepted @type as a subfeature. - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Tests if @feature has a "sub-feature" of type @type. See -soup_session_feature_add_feature(). - - %TRUE if @feature has a subfeature of type @type - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - Removes the "sub-feature" of type @type from the base feature -@feature. See soup_session_feature_add_feature(). - - %TRUE if @type was removed from @feature - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Adds a "sub-feature" of type @type to the base feature @feature. -This is used for features that can be extended with multiple -different types. Eg, the authentication manager can be extended -with subtypes of #SoupAuth. - - %TRUE if @feature accepted @type as a subfeature. - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Tests if @feature has a "sub-feature" of type @type. See -soup_session_feature_add_feature(). - - %TRUE if @feature has a subfeature of type @type - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - Removes the "sub-feature" of type @type from the base feature -@feature. See soup_session_feature_add_feature(). - - %TRUE if @type was removed from @feature - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - The interface implemented by #SoupSessionFeature<!-- -->s. - - The parent interface. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - %TRUE if @feature accepted @type as a subfeature. - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - - - %TRUE if @type was removed from @feature - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - - - %TRUE if @feature has a subfeature of type @type - - - - - the "base" feature - - - - the #GType of a "sub-feature" - - - - - - - - #SoupSessionSync is an implementation of #SoupSession that uses + + + #SoupSessionSync is an implementation of #SoupSession that uses synchronous I/O, intended for use in multi-threaded programs. - Use the #SoupSession class (which uses both asynchronous -and synchronous I/O, depending on the API used). See the -<link linkend="libsoup-session-porting">porting guide</link>. - - Creates an synchronous #SoupSession with the default options. - #SoupSessionSync is deprecated; use a plain -#SoupSession, created with soup_session_new(). See the <link -linkend="libsoup-session-porting">porting guide</link>. - - the new session. - - - - - Creates an synchronous #SoupSession with the specified options. - #SoupSessionSync is deprecated; use a plain -#SoupSession, created with soup_session_new_with_options(). See the -<link linkend="libsoup-session-porting">porting guide</link>. - - the new session. - - - - - name of first property to set - - - - value of @optname1, followed by additional property/value pairs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #SoupSocket is libsoup's TCP socket type. While it is primarily + + + #SoupSocket is libsoup's TCP socket type. While it is primarily intended for internal use, #SoupSocket<!-- -->s are exposed in the API in various places, and some of their methods (eg, soup_socket_get_remote_address()) may be useful to applications. - - - Creates a new (disconnected) socket - - the new socket - - - - - name of first property to set (or %NULL) - - - - value of @optname1, followed by additional property/value pairs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Begins asynchronously connecting to @sock's remote address. The -socket will call @callback when it succeeds or fails (but not -before returning from this function). - -If @cancellable is non-%NULL, it can be used to cancel the -connection. @callback will still be invoked in this case, with a -status of %SOUP_STATUS_CANCELLED. - - - - - - a client #SoupSocket (which must not already be connected) - - - - a #GCancellable, or %NULL - - - - callback to call after connecting - - - - data to pass to @callback - - - - - - Attempt to synchronously connect @sock to its remote address. - -If @cancellable is non-%NULL, it can be used to cancel the -connection, in which case soup_socket_connect_sync() will return -%SOUP_STATUS_CANCELLED. - - a success or failure code. - - - - - a client #SoupSocket (which must not already be connected) - - - - a #GCancellable, or %NULL - - - - - - Disconnects @sock. Any further read or write attempts on it will -fail. - - - - - - a #SoupSocket - - - - - - Gets @sock's underlying file descriptor. - -Note that fiddling with the file descriptor may break the -#SoupSocket. - - @sock's file descriptor. - - - - - a #SoupSocket - - - - - - Returns the #SoupAddress corresponding to the local end of @sock. - -Calling this method on an unconnected socket is considered to be -an error, and produces undefined results. - - the #SoupAddress - - - - - a #SoupSocket - - - - - - Returns the #SoupAddress corresponding to the remote end of @sock. - -Calling this method on an unconnected socket is considered to be -an error, and produces undefined results. - - the #SoupAddress - - - - - a #SoupSocket - - - - - - Tests if @sock is connected to another host - - %TRUE or %FALSE. - - - - - a #SoupSocket - - - - - - Tests if @sock is doing (or has attempted to do) SSL. - - %TRUE if @sock has SSL credentials set - - - - - a #SoupSocket - - - - - - Makes @sock start listening on its local address. When connections -come in, @sock will emit #SoupSocket::new_connection. - - whether or not @sock is now listening. - - - - - a server #SoupSocket (which must not already be connected or -listening) - - - - - - Attempts to read up to @len bytes from @sock into @buffer. If some -data is successfully read, soup_socket_read() will return -%SOUP_SOCKET_OK, and *@nread will contain the number of bytes -actually read (which may be less than @len). - -If @sock is non-blocking, and no data is available, the return -value will be %SOUP_SOCKET_WOULD_BLOCK. In this case, the caller -can connect to the #SoupSocket::readable signal to know when there -is more data to read. (NB: You MUST read all available data off the -socket first. #SoupSocket::readable is only emitted after -soup_socket_read() returns %SOUP_SOCKET_WOULD_BLOCK, and it is only -emitted once. See the documentation for #SoupSocket:non-blocking.) - - a #SoupSocketIOStatus, as described above (or -%SOUP_SOCKET_EOF if the socket is no longer connected, or -%SOUP_SOCKET_ERROR on any other error, in which case @error will -also be set). - - - - - the socket - - - - buffer to read - into - - - - - - size of @buffer in bytes - - - - on return, the number of bytes read into @buffer - - - - a #GCancellable, or %NULL - - - - - - Like soup_socket_read(), but reads no further than the first -occurrence of @boundary. (If the boundary is found, it will be -included in the returned data, and *@got_boundary will be set to -%TRUE.) Any data after the boundary will returned in future reads. - -soup_socket_read_until() will almost always return fewer than @len -bytes: if the boundary is found, then it will only return the bytes -up until the end of the boundary, and if the boundary is not found, -then it will leave the last <literal>(boundary_len - 1)</literal> -bytes in its internal buffer, in case they form the start of the -boundary string. Thus, @len normally needs to be at least 1 byte -longer than @boundary_len if you want to make any progress at all. - - as for soup_socket_read() - - - - - the socket - - - - buffer to read - into - - - - - - size of @buffer in bytes - - - - boundary to read until - - - - length of @boundary in bytes - - - - on return, the number of bytes read into @buffer - - - - on return, whether or not the data in @buffer -ends with the boundary string - - - - a #GCancellable, or %NULL - - - - - - Starts using SSL on @socket, expecting to find a host named -@ssl_host. - - success or failure - - - - - the socket - - - - hostname of the SSL server - - - - a #GCancellable - - - - - - Starts using SSL on @socket. - - success or failure - - - - - the socket - - - - a #GCancellable - - - - - - Attempts to write @len bytes from @buffer to @sock. If some data is -successfully written, the return status will be %SOUP_SOCKET_OK, -and *@nwrote will contain the number of bytes actually written -(which may be less than @len). - -If @sock is non-blocking, and no data could be written right away, -the return value will be %SOUP_SOCKET_WOULD_BLOCK. In this case, -the caller can connect to the #SoupSocket::writable signal to know -when more data can be written. (NB: #SoupSocket::writable is only -emitted after soup_socket_write() returns %SOUP_SOCKET_WOULD_BLOCK, -and it is only emitted once. See the documentation for -#SoupSocket:non-blocking.) - - a #SoupSocketIOStatus, as described above (or -%SOUP_SOCKET_EOF or %SOUP_SOCKET_ERROR. @error will be set if the -return value is %SOUP_SOCKET_ERROR.) - - - - - the socket - - - - data to write - - - - - - size of @buffer, in bytes - - - - on return, number of bytes written - - - - a #GCancellable, or %NULL - - - - - - - - - - - - - - - - - - - - - Whether or not the socket is a server socket. - -Note that for "ordinary" #SoupSockets this will be set for -both listening sockets and the sockets emitted by -#SoupSocket::new-connection, but for sockets created by -setting #SoupSocket:fd, it will only be set for listening -sockets. - - - - - - - Whether or not the socket uses non-blocking I/O. - -#SoupSocket's I/O methods are designed around the idea of -using a single codepath for both synchronous and -asynchronous I/O. If you want to read off a #SoupSocket, -the "correct" way to do it is to call soup_socket_read() or -soup_socket_read_until() repeatedly until you have read -everything you want. If it returns %SOUP_SOCKET_WOULD_BLOCK -at any point, stop reading and wait for it to emit the -#SoupSocket::readable signal. Then go back to the -reading-as-much-as-you-can loop. Likewise, for writing to a -#SoupSocket, you should call soup_socket_write() either -until you have written everything, or it returns -%SOUP_SOCKET_WOULD_BLOCK (in which case you wait for -#SoupSocket::writable and then go back into the loop). - -Code written this way will work correctly with both -blocking and non-blocking sockets; blocking sockets will -simply never return %SOUP_SOCKET_WOULD_BLOCK, and so the -code that handles that case just won't get used for them. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Use g_main_context_get_thread_default(). - - - - - - - Emitted when the socket is disconnected, for whatever -reason. - - - - - - Emitted when a network-related event occurs. See -#GSocketClient::event for more details. - - - - - - the event that occurred - - - - the current connection state - - - - - - Emitted when a listening socket (set up with -soup_socket_listen()) receives a new connection. - -You must ref the @new if you want to keep it; otherwise it -will be destroyed after the signal is emitted. - - - - - - the new socket - - - - - - Emitted when an async socket is readable. See -soup_socket_read(), soup_socket_read_until() and -#SoupSocket:non-blocking. - - - - - - Emitted when an async socket is writable. See -soup_socket_write() and #SoupSocket:non-blocking. - - - - - - - The callback function passed to soup_socket_connect_async(). - - - - - - the #SoupSocket - - - - an HTTP status code indicating success or failure - - - - the data passed to soup_socket_connect_async() - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Return value from the #SoupSocket IO methods. - - Success - - - Cannot read/write any more at this time - - - End of file - - - Other error - - - - These represent the known HTTP status code values, plus various -network and internal errors. - -Note that no libsoup functions take or return this type directly; -any function that works with status codes will accept unrecognized -status codes as well. - -Prior to 2.44 this type was called -<literal>SoupKnownStatusCode</literal>, but the individual values -have always had the names they have now. - - No status available. (Eg, the message has not -been sent yet) - - - Message was cancelled locally - - - Unable to resolve destination host name - - - Unable to resolve proxy host name - - - Unable to connect to remote host - - - Unable to connect to proxy - - - SSL/TLS negotiation failed - - - A network error occurred, or the other end -closed the connection unexpectedly - - - Malformed data (usually a programmer error) - - - Used internally - - - There were too many redirections - - - Used internally - - - 100 Continue (HTTP) - - - 101 Switching Protocols (HTTP) - - - 102 Processing (WebDAV) - - - 200 Success (HTTP). Also used by many lower-level -soup routines to indicate success. - - - 201 Created (HTTP) - - - 202 Accepted (HTTP) - - - 203 Non-Authoritative Information -(HTTP) - - - 204 No Content (HTTP) - - - 205 Reset Content (HTTP) - - - 206 Partial Content (HTTP) - - - 207 Multi-Status (WebDAV) - - - 300 Multiple Choices (HTTP) - - - 301 Moved Permanently (HTTP) - - - 302 Found (HTTP) - - - 302 Moved Temporarily (old name, -RFC 2068) - - - 303 See Other (HTTP) - - - 304 Not Modified (HTTP) - - - 305 Use Proxy (HTTP) - - - 306 [Unused] (HTTP) - - - 307 Temporary Redirect (HTTP) - - - - - 400 Bad Request (HTTP) - - - 401 Unauthorized (HTTP) - - - 402 Payment Required (HTTP) - - - 403 Forbidden (HTTP) - - - 404 Not Found (HTTP) - - - 405 Method Not Allowed (HTTP) - - - 406 Not Acceptable (HTTP) - - - 407 Proxy Authentication -Required (HTTP) - - - shorter alias for -%SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED - - - 408 Request Timeout (HTTP) - - - 409 Conflict (HTTP) - - - 410 Gone (HTTP) - - - 411 Length Required (HTTP) - - - 412 Precondition Failed (HTTP) - - - 413 Request Entity Too Large -(HTTP) - - - 414 Request-URI Too Long (HTTP) - - - 415 Unsupported Media Type -(HTTP) - - - 416 Requested Range -Not Satisfiable (HTTP) - - - shorter alias for -%SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE - - - 417 Expectation Failed (HTTP) - - - 422 Unprocessable Entity -(WebDAV) - - - 423 Locked (WebDAV) - - - 424 Failed Dependency (WebDAV) - - - 500 Internal Server Error -(HTTP) - - - 501 Not Implemented (HTTP) - - - 502 Bad Gateway (HTTP) - - - 503 Service Unavailable (HTTP) - - - 504 Gateway Timeout (HTTP) - - - 505 HTTP Version Not -Supported (HTTP) - - - 507 Insufficient Storage -(WebDAV) - - - 510 Not Extended (RFC 2774) - - - Looks up the stock HTTP description of @status_code. This is used -by soup_message_set_status() to get the correct text to go with a -given status code. - -<emphasis>There is no reason for you to ever use this -function.</emphasis> If you wanted the textual description for the -#SoupMessage:status_code of a given #SoupMessage, you should just -look at the message's #SoupMessage:reason_phrase. However, you -should only do that for use in debugging messages; HTTP reason -phrases are not localized, and are not generally very descriptive -anyway, and so they should never be presented to the user directly. -Instead, you should create you own error messages based on the -status code, and on what you were trying to do. - - the (terse, English) description of @status_code - - - - - an HTTP status code - - - - - - Turns %SOUP_STATUS_CANT_RESOLVE into -%SOUP_STATUS_CANT_RESOLVE_PROXY and %SOUP_STATUS_CANT_CONNECT into -%SOUP_STATUS_CANT_CONNECT_PROXY. Other status codes are passed -through unchanged. - - the "proxified" equivalent of @status_code. - - - - - a status code - - - - - - - Error codes for %SOUP_TLD_ERROR. - - A hostname was syntactically - invalid. - - - The passed-in "hostname" was - actually an IP address (and thus has no base domain or - public suffix). - - - The passed-in hostname - did not have enough components. Eg, calling - soup_tld_get_base_domain() on <literal>"co.uk"</literal>. - - - The passed-in hostname has - no recognized public suffix. - - - - - - - - - - - A #SoupURI represents a (parsed) URI. + + + These functions can be used to parse hostnames to attempt to determine +what part of the name belongs to the domain owner, and what part is +simply a "public suffix" such as ".com". + + + A #SoupURI represents a (parsed) URI. Many applications will not need to use #SoupURI directly at all; on the client side, soup_message_new() takes a stringified URI, and on the server side, the path and query components are provided for you in the server callback. - - the URI scheme (eg, "http") - - - - a username, or %NULL - - - - a password, or %NULL - - - - the hostname or IP address, or %NULL - - - - the port number on @host - - - - the path on @host - - - - a query for @path, or %NULL - - - - a fragment identifier within @path, or %NULL - - - - Parses an absolute URI. - -You can also pass %NULL for @uri_string if you want to get back an -"empty" #SoupURI that you can fill in by hand. (You will need to -call at least soup_uri_set_scheme() and soup_uri_set_path(), since -those fields are required.) - - a #SoupURI, or %NULL if the given string - was found to be invalid. - - - - - a URI - - - - - - Parses @uri_string relative to @base. - - a parsed #SoupURI. - - - - - a base URI - - - - the URI - - - - - - Copies @uri - - a copy of @uri, which must be freed with soup_uri_free() - - - - - a #SoupURI - - - - - - Makes a copy of @uri, considering only the protocol, host, and port - - the new #SoupURI - - - - - a #SoupURI - - - - - - Tests whether or not @uri1 and @uri2 are equal in all parts - - %TRUE or %FALSE - - - - - a #SoupURI - - - - another #SoupURI - - - - - - Frees @uri. - - - - - - a #SoupURI - - - - - - Gets @uri's fragment. - - @uri's fragment. - - - - - a #SoupURI - - - - - - Gets @uri's host. - - @uri's host. - - - - - a #SoupURI - - - - - - Gets @uri's password. - - @uri's password. - - - - - a #SoupURI - - - - - - Gets @uri's path. - - @uri's path. - - - - - a #SoupURI - - - - - - Gets @uri's port. - - @uri's port. - - - - - a #SoupURI - - - - - - Gets @uri's query. - - @uri's query. - - - - - a #SoupURI - - - - - - Gets @uri's scheme. - - @uri's scheme. - - - - - a #SoupURI - - - - - - Gets @uri's user. - - @uri's user. - - - - - a #SoupURI - - - - - - Compares @v1 and @v2, considering only the scheme, host, and port. - - whether or not the URIs are equal in scheme, host, -and port. - - - - - a #SoupURI with a non-%NULL @host member - - - - a #SoupURI with a non-%NULL @host member - - - - - - Hashes @key, considering only the scheme, host, and port. - - a hash - - - - - a #SoupURI with a non-%NULL @host member - - - - - - Sets @uri's fragment to @fragment. - - - - - - a #SoupURI - - - - the fragment - - - - - - Sets @uri's host to @host. - -If @host is an IPv6 IP address, it should not include the brackets -required by the URI syntax; they will be added automatically when -converting @uri to a string. - -http and https URIs should not have a %NULL @host. - - - - - - a #SoupURI - - - - the hostname or IP address, or %NULL - - - - - - Sets @uri's password to @password. - - - - - - a #SoupURI - - - - the password, or %NULL - - - - - - Sets @uri's path to @path. - - - - - - a #SoupURI - - - - the non-%NULL path - - - - - - Sets @uri's port to @port. If @port is 0, @uri will not have an -explicitly-specified port. - - - - - - a #SoupURI - - - - the port, or 0 - - - - - - Sets @uri's query to @query. - - - - - - a #SoupURI - - - - the query - - - - - - Sets @uri's query to the result of encoding the given form fields -and values according to the * HTML form rules. See -soup_form_encode() for more information. - - - - - - a #SoupURI - - - - name of the first form field to encode into query - - - - value of @first_field, followed by additional field names -and values, terminated by %NULL. - - - - - - Sets @uri's query to the result of encoding @form according to the -HTML form rules. See soup_form_encode_hash() for more information. - - - - - - a #SoupURI - - - - a #GHashTable containing HTML form -information - - - - - - - - - Sets @uri's scheme to @scheme. This will also set @uri's port to -the default port for @scheme, if known. - - - - - - a #SoupURI - - - - the URI scheme - - - - - - Sets @uri's user to @user. - - - - - - a #SoupURI - - - - the username, or %NULL - - - - - - Returns a string representing @uri. - -If @just_path_and_query is %TRUE, this concatenates the path and query -together. That is, it constructs the string that would be needed in -the Request-Line of an HTTP request for @uri. - -Note that the output will never contain a password, even if @uri -does. - - a string representing @uri, which the caller must free. - - - - - a #SoupURI - - - - if %TRUE, output just the path and query portions - - - - - - Tests if @uri uses the default port for its scheme. (Eg, 80 for -http.) (This only works for http, https and ftp; libsoup does not know -the default ports of other protocols.) - - %TRUE or %FALSE - - - - - a #SoupURI - - - - - - Fully %<!-- -->-decodes @part. - -In the past, this would return %NULL if @part contained invalid -percent-encoding, but now it just ignores the problem (as -soup_uri_new() already did). - - the decoded URI part. - - - - - a URI part - - - - - - This %<!-- -->-encodes the given URI part and returns the escaped -version in allocated memory, which the caller must free when it is -done. - - the encoded URI part - - - - - a URI part - - - - additional reserved characters to -escape (or %NULL) - - - - - - %<!-- -->-decodes any "unreserved" characters (or characters in -@unescape_extra) in @part, and %<!-- -->-encodes any non-ASCII -characters, spaces, and non-printing characters in @part. - -"Unreserved" characters are those that are not allowed to be used -for punctuation according to the URI spec. For example, letters are -unreserved, so soup_uri_normalize() will turn -<literal>http://example.com/foo/b%<!-- -->61r</literal> into -<literal>http://example.com/foo/bar</literal>, which is guaranteed -to mean the same thing. However, "/" is "reserved", so -<literal>http://example.com/foo%<!-- -->2Fbar</literal> would not -be changed, because it might mean something different to the -server. - -In the past, this would return %NULL if @part contained invalid -percent-encoding, but now it just ignores the problem (as -soup_uri_new() already did). - - the normalized URI part - - - - - a URI part - - - - reserved characters to unescape (or %NULL) - - - - - - - Tests whether @uri is a valid #SoupURI; that is, that it is non-%NULL -and its @scheme and @path members are also non-%NULL. - -This macro does not check whether http and https URIs have a non-%NULL -@host member. - - - a #SoupURI - - - - - Tests if @uri is a valid #SoupURI for HTTP communication; that is, if -it can be used to construct a #SoupMessage. - - - a #SoupURI - - - - - Extracts a value of type @type from @val into @args. The return -value will point to the same data as @val rather than being a copy -of it. - Use #GVariant API instead. - - - a #GValue - - - a #GType - - - #va_list pointing to a value of type pointer-to-@type - - - - - Copies an argument of type @type from @args into @val. @val will -point directly to the value in @args rather than copying it, so you -must g_value_copy() it if you want it to remain valid. - Use #GVariant API instead. - - - a #GValue - - - a #GType - - - #va_list pointing to a value of type @type - - - - - A macro that should be defined by the user prior to including -libsoup.h. The definition should be one of the predefined libsoup -version macros: %SOUP_VERSION_2_24, %SOUP_VERSION_2_26, ... - -This macro defines the earliest version of libsoup that the package -is required to be able to compile against. - -If the compiler is configured to warn about the use of deprecated -functions, then using functions that were deprecated in version -%SOUP_VERSION_MIN_REQUIRED or earlier will cause warnings (but -using functions deprecated in later releases will not). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Pre-defined close codes that can be passed to -soup_websocket_connection_close() or received from -soup_websocket_connection_get_close_code(). (However, other codes -are also allowed.) - - a normal, non-error close - - - the client/server is going away - - - a protocol error occurred - - - the endpoint received data - of a type that it does not support. - - - reserved value indicating that - no close code was present; must not be sent. - - - reserved value indicating that - the connection was closed abnormally; must not be sent. - - - the endpoint received data that - was invalid (eg, non-UTF-8 data in a text message). - - - generic error code - indicating some sort of policy violation. - - - the endpoint received a message - that is too big to process. - - - the client is closing the - connection because the server failed to negotiate a required - extension. - - - the server is closing the - connection because it was unable to fulfill the request. - - - reserved value indicating that - the TLS handshake failed; must not be sent. - - - - A class representing a WebSocket connection. - - Creates a #SoupWebsocketConnection on @stream. This should be -called after completing the handshake to begin using the WebSocket -protocol. - - a new #SoupWebsocketConnection - - - - - a #GIOStream connected to the WebSocket server - - - - the URI of the connection - - - - the type of connection (client/side) - - - - the Origin of the client - - - - the subprotocol in use - - - - - - Creates a #SoupWebsocketConnection on @stream with the given active @extensions. -This should be called after completing the handshake to begin using the WebSocket -protocol. - - a new #SoupWebsocketConnection - - - - - a #GIOStream connected to the WebSocket server - - - - the URI of the connection - - - - the type of connection (client/side) - - - - the Origin of the client - - - - the subprotocol in use - - - - a #GList of #SoupWebsocketExtension objects - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Close the connection in an orderly fashion. - -Note that until the #SoupWebsocketConnection::closed signal fires, the connection -is not yet completely closed. The close message is not even sent until the -main loop runs. - -The @code and @data are sent to the peer along with the close request. -If @code is %SOUP_WEBSOCKET_CLOSE_NO_STATUS a close message with no body -(without code and data) is sent. -Note that the @data must be UTF-8 valid. - - - - - - the WebSocket - - - - close code - - - - close data - - - - - - Get the close code received from the WebSocket peer. - -This only becomes valid once the WebSocket is in the -%SOUP_WEBSOCKET_STATE_CLOSED state. The value will often be in the -#SoupWebsocketCloseCode enumeration, but may also be an application -defined close code. - - the close code or zero. - - - - - the WebSocket - - - - - - Get the close data received from the WebSocket peer. - -This only becomes valid once the WebSocket is in the -%SOUP_WEBSOCKET_STATE_CLOSED state. The data may be freed once -the main loop is run, so copy it if you need to keep it around. - - the close data or %NULL - - - - - the WebSocket - - - - - - Get the connection type (client/server) of the connection. - - the connection type - - - - - the WebSocket - - - - - - Get the extensions chosen via negotiation with the peer. - - a #GList of #SoupWebsocketExtension objects - - - - - - - the WebSocket - - - - - - Get the I/O stream the WebSocket is communicating over. - - the WebSocket's I/O stream. - - - - - the WebSocket - - - - - - Gets the keepalive interval in seconds or 0 if disabled. - - the keepalive interval. - - - - - the WebSocket - - - - - - Gets the maximum payload size allowed for incoming packets. - - the maximum payload size. - - - - - the WebSocket - - - - - - Get the origin of the WebSocket. - - the origin, or %NULL - - - - - the WebSocket - - - - - - Get the protocol chosen via negotiation with the peer. - - the chosen protocol, or %NULL - - - - - the WebSocket - - - - - - Get the current state of the WebSocket. - - the state - - - - - the WebSocket - - - - - - Get the URI of the WebSocket. - -For servers this represents the address of the WebSocket, and -for clients it is the address connected to. - - the URI - - - - - the WebSocket - - - - - - Send a binary message to the peer. If @length is 0, @data may be %NULL. - -The message is queued to be sent and will be sent when the main loop -is run. - - - - - - the WebSocket - - - - the message contents - - - - - - the length of @data - - - - - - Send a message of the given @type to the peer. Note that this method, -allows to send text messages containing %NULL characters. - -The message is queued to be sent and will be sent when the main loop -is run. - - - - - - the WebSocket - - - - the type of message contents - - - - the message data as #GBytes - - - - - - Send a %NULL-terminated text (UTF-8) message to the peer. If you need -to send text messages containing %NULL characters use -soup_websocket_connection_send_message() instead. - -The message is queued to be sent and will be sent when the main loop -is run. - - - - - - the WebSocket - - - - the message contents - - - - - - Sets the interval in seconds on when to send a ping message which will serve -as a keepalive message. If set to 0 the keepalive message is disabled. - - - - - - the WebSocket - - - - the interval to send a ping message or 0 to disable it - - - - - - Sets the maximum payload size allowed for incoming packets. It -does not limit the outgoing packet size. - - - - - - the WebSocket - - - - the maximum payload size - - - - - - The type of connection (client/server). - - - - List of #SoupWebsocketExtension objects that are active in the connection. - - - - The underlying IO stream the WebSocket is communicating -over. - -The input and output streams must be pollable streams. - - - - Interval in seconds on when to send a ping message which will -serve as a keepalive message. If set to 0 the keepalive message is -disabled. - - - - The maximum payload size for incoming packets the protocol expects -or 0 to not limit it. - - - - The client's Origin. - - - - The chosen protocol, or %NULL if a protocol was not agreed -upon. - - - - The current state of the WebSocket. - - - - The URI of the WebSocket. - -For servers this represents the address of the WebSocket, -and for clients it is the address connected to. - - - - - - - - - - Emitted when the connection has completely closed, either -due to an orderly close from the peer, one initiated via -soup_websocket_connection_close() or a fatal error -condition that caused a close. - -This signal will be emitted once. - - - - - - This signal will be emitted during an orderly close. - - - - - - Emitted when an error occurred on the WebSocket. This may -be fired multiple times. Fatal errors will be followed by -the #SoupWebsocketConnection::closed signal being emitted. - - - - - - the error that occured - - - - - - Emitted when we receive a message from the peer. - -As a convenience, the @message data will always be -NUL-terminated, but the NUL byte will not be included in -the length count. - - - - - - the type of message contents - - - - the message data - - - - - - Emitted when we receive a Pong frame (solicited or -unsolicited) from the peer. - -As a convenience, the @message data will always be -NUL-terminated, but the NUL byte will not be included in -the length count. - - - - - - the application data (if any) - - - - - - - The abstract base class for #SoupWebsocketConnection - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The type of a #SoupWebsocketConnection. - - unknown/invalid connection - - - a client-side connection - - - a server-side connection - - - - The type of data contained in a #SoupWebsocketConnection::message -signal. - - UTF-8 text - - - binary data - - - - WebSocket-related errors. - - a generic error - - - attempted to handshake with a - server that does not appear to understand WebSockets. - - - the WebSocket handshake failed - because some detail was invalid (eg, incorrect accept key). - - - the WebSocket handshake failed - because the "Origin" header was not an allowed value. - - - - - - - - - SoupWebsocketExtension is the base class for WebSocket extension objects. - - Configures @extension with the given @params - - %TRUE if extension could be configured with the given parameters, or %FALSE otherwise - - - - - a #SoupWebsocketExtension - - - - either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER - - - - the parameters, or %NULL - - - - - - - - - Get the parameters strings to be included in the request header. If the extension -doesn't include any parameter in the request, this function returns %NULL. - - a new allocated string with the parameters - - - - - a #SoupWebsocketExtension - - - - - - Get the parameters strings to be included in the response header. If the extension -doesn't include any parameter in the response, this function returns %NULL. - - a new allocated string with the parameters - - - - - a #SoupWebsocketExtension - - - - - - Process a message after it's received. If the payload isn't changed the given -@payload is just returned, otherwise g_bytes_unref() is called on the given -@payload and a new #GBytes is returned with the new data. - -Extensions using reserved bits of the header will reset them in @header. - - the message payload data, or %NULL in case of error - - - - - a #SoupWebsocketExtension - - - - the message header - - - - the payload data - - - - - - Process a message before it's sent. If the payload isn't changed the given -@payload is just returned, otherwise g_bytes_unref() is called on the given -@payload and a new #GBytes is returned with the new data. - -Extensions using reserved bits of the header will change them in @header. - - the message payload data, or %NULL in case of error - - - - - a #SoupWebsocketExtension - - - - the message header - - - - the payload data - - - - - - Configures @extension with the given @params - - %TRUE if extension could be configured with the given parameters, or %FALSE otherwise - - - - - a #SoupWebsocketExtension - - - - either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER - - - - the parameters, or %NULL - - - - - - - - - Get the parameters strings to be included in the request header. If the extension -doesn't include any parameter in the request, this function returns %NULL. - - a new allocated string with the parameters - - - - - a #SoupWebsocketExtension - - - - - - Get the parameters strings to be included in the response header. If the extension -doesn't include any parameter in the response, this function returns %NULL. - - a new allocated string with the parameters - - - - - a #SoupWebsocketExtension - - - - - - Process a message after it's received. If the payload isn't changed the given -@payload is just returned, otherwise g_bytes_unref() is called on the given -@payload and a new #GBytes is returned with the new data. - -Extensions using reserved bits of the header will reset them in @header. - - the message payload data, or %NULL in case of error - - - - - a #SoupWebsocketExtension - - - - the message header - - - - the payload data - - - - - - Process a message before it's sent. If the payload isn't changed the given -@payload is just returned, otherwise g_bytes_unref() is called on the given -@payload and a new #GBytes is returned with the new data. - -Extensions using reserved bits of the header will change them in @header. - - the message payload data, or %NULL in case of error - - - - - a #SoupWebsocketExtension - - - - the message header - - - - the payload data - - - - - - - - - - The class structure for the SoupWebsocketExtension. - - the parent class - - - - - - - - - %TRUE if extension could be configured with the given parameters, or %FALSE otherwise - - - - - a #SoupWebsocketExtension - - - - either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER - - - - the parameters, or %NULL - - - - - - - - - - - - a new allocated string with the parameters - - - - - a #SoupWebsocketExtension - - - - - - - - - a new allocated string with the parameters - - - - - a #SoupWebsocketExtension - - - - - - - - - the message payload data, or %NULL in case of error - - - - - a #SoupWebsocketExtension - - - - the message header - - - - the payload data - - - - - - - - - the message payload data, or %NULL in case of error - - - - - a #SoupWebsocketExtension - - - - the message header - - - - the payload data - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SoupWebsocketExtensionManager is the #SoupSessionFeature that handles WebSockets -extensions for a #SoupSession. - -A SoupWebsocketExtensionManager is added to the session by default, and normally -you don't need to worry about it at all. However, if you want to -disable WebSocket extensions, you can remove the feature from the -session with soup_session_remove_feature_by_type(), or disable it on -individual requests with soup_message_disable_feature(). - - - - - - - - - - - - The state of the WebSocket connection. - - the connection is ready to send messages - - - the connection is in the process of - closing down; messages may be received, but not sent - - - the connection is completely closed down - - - - - - - - - - - - - - - Pre-defined XML-RPC fault codes from <ulink -url="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</ulink>. -These are an extension, not part of the XML-RPC spec; you can't -assume servers will use them. - - request was not - well-formed - - - request was in - an unsupported encoding - - - request contained an invalid character - - - request was not - valid XML-RPC - - - method - not found - - - invalid - parameters - - - internal - error - - - start of reserved range for - application error codes - - - start of reserved range for - system error codes - - - start of reserved range for - transport error codes - - - - - - - - - Opaque structure containing XML-RPC methodCall parameter values. -Can be parsed using soup_xmlrpc_params_parse() and freed with -soup_xmlrpc_params_free(). - - Free a #SoupXMLRPCParams returned by soup_xmlrpc_parse_request(). - - - - - - a SoupXMLRPCParams - - - - - - Parse method parameters returned by soup_xmlrpc_parse_request(). - -Deserialization details: - - If @signature is provided, &lt;int&gt; and &lt;i4&gt; can be deserialized - to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise - it will be deserialized to int32. If the value is out of range - for the target type it will return an error. - - &lt;struct&gt; will be deserialized to "a{sv}". @signature could define - another value type (e.g. "a{ss}"). - - &lt;array&gt; will be deserialized to "av". @signature could define - another element type (e.g. "as") or could be a tuple (e.g. "(ss)"). - - &lt;base64&gt; will be deserialized to "ay". - - &lt;string&gt; will be deserialized to "s". - - &lt;dateTime.iso8601&gt; will be deserialized to an unspecified variant - type. If @signature is provided it must have the generic "v" type, which - means there is no guarantee that it's actually a datetime that has been - received. soup_xmlrpc_variant_get_datetime() must be used to parse and - type check this special variant. - - @signature must not have maybes, otherwise an error is returned. - - Dictionaries must have string keys, otherwise an error is returned. - - a new (non-floating) #GVariant, or %NULL - - - - - A #SoupXMLRPCParams - - - - A valid #GVariant type string, or %NULL - - - - - - - Adds @function to be executed from inside @async_context with the -default priority. Use this when you want to complete an action in -@async_context's main loop, as soon as possible. - - a #GSource, which can be removed from @async_context -with g_source_destroy(). - - - - - the #GMainContext to dispatch the I/O -watch in, or %NULL for the default context - - - - the callback to invoke - - - - user data to pass to @function - - - - - - Adds an idle event as with g_idle_add(), but using the given -@async_context. - -If you want @function to run "right away", use -soup_add_completion(), since that sets a higher priority on the -#GSource than soup_add_idle() does. - - a #GSource, which can be removed from @async_context -with g_source_destroy(). - - - - - the #GMainContext to dispatch the I/O -watch in, or %NULL for the default context - - - - the callback to invoke at idle time - - - - user data to pass to @function - - - - - - Adds an I/O watch as with g_io_add_watch(), but using the given -@async_context. - - a #GSource, which can be removed from @async_context -with g_source_destroy(). - - - - - the #GMainContext to dispatch the I/O -watch in, or %NULL for the default context - - - - the #GIOChannel to watch - - - - the condition to watch for - - - - the callback to invoke when @condition occurs - - - - user data to pass to @function - - - - - - Adds a timeout as with g_timeout_add(), but using the given -@async_context. - - a #GSource, which can be removed from @async_context -with g_source_destroy(). - - - - - the #GMainContext to dispatch the I/O -watch in, or %NULL for the default context - - - - the timeout interval, in milliseconds - - - - the callback to invoke at timeout time - - - - user data to pass to @function - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Like SOUP_CHECK_VERSION, but the check for soup_check_version is -at runtime instead of compile time. This is useful for compiling -against older versions of libsoup, but using features from newer -versions. - - %TRUE if the version of the libsoup currently loaded -is the same as or newer than the passed-in version. - - - - - the major version to check - - - - the minor version to check - - - - the micro version to check - - - - - - Parses @header and returns a #SoupCookie. (If @header contains -multiple cookies, only the first one will be parsed.) - -If @header does not have "path" or "domain" attributes, they will -be defaulted from @origin. If @origin is %NULL, path will default -to "/", but domain will be left as %NULL. Note that this is not a -valid state for a #SoupCookie, and you will need to fill in some -appropriate string for the domain if you want to actually make use -of the cookie. - - a new #SoupCookie, or %NULL if it could -not be parsed, or contained an illegal "domain" attribute for a -cookie originating from @origin. - - - - - a cookie string (eg, the value of a Set-Cookie header) - - - - origin of the cookie, or %NULL - - - - - - Frees @cookies. - - - - - - a #GSList of #SoupCookie - - - - - - - - Parses @msg's Cookie request header and returns a #GSList of -#SoupCookie<!-- -->s. As the "Cookie" header, unlike "Set-Cookie", -only contains cookie names and values, none of the other -#SoupCookie fields will be filled in. (Thus, you can't generally -pass a cookie returned from this method directly to -soup_cookies_to_response().) - - a #GSList -of #SoupCookie<!-- -->s, which can be freed with -soup_cookies_free(). - - - - - - - a #SoupMessage containing a "Cookie" request header - - - - - - Parses @msg's Set-Cookie response headers and returns a #GSList of -#SoupCookie<!-- -->s. Cookies that do not specify "path" or -"domain" attributes will have their values defaulted from @msg. - - a #GSList -of #SoupCookie<!-- -->s, which can be freed with -soup_cookies_free(). - - - - - - - a #SoupMessage containing a "Set-Cookie" response header - - - - - - Serializes a #GSList of #SoupCookie into a string suitable for -setting as the value of the "Cookie" header. - - the serialization of @cookies - - - - - a #GSList of #SoupCookie - - - - - - - - Adds the name and value of each cookie in @cookies to @msg's -"Cookie" request. (If @msg already has a "Cookie" request header, -these cookies will be appended to the cookies already present. Be -careful that you do not append the same cookies twice, eg, when -requeuing a message.) - - - - - - a #GSList of #SoupCookie - - - - - - a #SoupMessage - - - - - - Appends a "Set-Cookie" response header to @msg for each cookie in -@cookies. (This is in addition to any other "Set-Cookie" headers -@msg may already have.) - - - - - - a #GSList of #SoupCookie - - - - - - a #SoupMessage - - - - - - Decodes @form, which is an urlencoded dataset as defined in the -HTML 4.01 spec. - - a hash -table containing the name/value pairs from @encoded_form, which you -can free with g_hash_table_destroy(). - - - - - - - - data of type "application/x-www-form-urlencoded" - - - - - - Decodes the "multipart/form-data" request in @msg; this is a -convenience method for the case when you have a single file upload -control in a form. (Or when you don't have any file upload -controls, but are still using "multipart/form-data" anyway.) Pass -the name of the file upload control in @file_control_name, and -soup_form_decode_multipart() will extract the uploaded file data -into @filename, @content_type, and @file. All of the other form -control data will be returned (as strings, as with -soup_form_decode()) in the returned #GHashTable. - -You may pass %NULL for @filename, @content_type and/or @file if you do not -care about those fields. soup_form_decode_multipart() may also -return %NULL in those fields if the client did not provide that -information. You must free the returned filename and content-type -with g_free(), and the returned file data with soup_buffer_free(). - -If you have a form with more than one file upload control, you will -need to decode it manually, using soup_multipart_new_from_message() -and soup_multipart_get_part(). - - -a hash table containing the name/value pairs (other than -@file_control_name) from @msg, which you can free with -g_hash_table_destroy(). On error, it will return %NULL. - - - - - - - - a #SoupMessage containing a "multipart/form-data" request body - - - - the name of the HTML file upload control, or %NULL - - - - return location for the name of the uploaded file, or %NULL - - - - return location for the MIME type of the uploaded file, or %NULL - - - - return location for the uploaded file data, or %NULL - - - - - - Encodes the given field names and values into a value of type -"application/x-www-form-urlencoded", as defined in the HTML 4.01 -spec. - -This method requires you to know the names of the form fields (or -at the very least, the total number of fields) at compile time; for -working with dynamic forms, use soup_form_encode_hash() or -soup_form_encode_datalist(). - - the encoded form - - - - - name of the first form field - - - - value of @first_field, followed by additional field names -and values, terminated by %NULL. - - - - - - Encodes @form_data_set into a value of type -"application/x-www-form-urlencoded", as defined in the HTML 4.01 -spec. Unlike soup_form_encode_hash(), this preserves the ordering -of the form elements, which may be required in some situations. - - the encoded form - - - - - a datalist containing name/value pairs - - - - - - Encodes @form_data_set into a value of type -"application/x-www-form-urlencoded", as defined in the HTML 4.01 -spec. - -Note that the HTML spec states that "The control names/values are -listed in the order they appear in the document." Since this method -takes a hash table, it cannot enforce that; if you care about the -ordering of the form fields, use soup_form_encode_datalist(). - - the encoded form - - - - - a hash table containing -name/value pairs (as strings) - - - - - - - - - See soup_form_encode(). This is mostly an internal method, used by -various other methods such as soup_uri_set_query_from_fields() and -soup_form_request_new(). - - the encoded form - - - - - name of the first form field - - - - pointer to additional values, as in soup_form_encode() - - - - - - Creates a new %SoupMessage and sets it up to send the given data -to @uri via @method. (That is, if @method is "GET", it will encode -the form data into @uri's query field, and if @method is "POST", it -will encode it into the %SoupMessage's request_body.) - - the new %SoupMessage - - - - - the HTTP method, either "GET" or "POST" - - - - the URI to send the form data to - - - - name of the first form field - - - - value of @first_field, followed by additional field names -and values, terminated by %NULL. - - - - - - Creates a new %SoupMessage and sets it up to send @form_data_set to -@uri via @method, as with soup_form_request_new(). - - the new %SoupMessage - - - - - the HTTP method, either "GET" or "POST" - - - - the URI to send the form data to - - - - the data to send to @uri - - - - - - Creates a new %SoupMessage and sets it up to send @form_data_set to -@uri via @method, as with soup_form_request_new(). - - the new %SoupMessage - - - - - the HTTP method, either "GET" or "POST" - - - - the URI to send the form data to - - - - the data to send to @uri - - - - - - - - - Creates a new %SoupMessage and sets it up to send @multipart to -@uri via POST. - -To send a <literal>"multipart/form-data"</literal> POST, first -create a #SoupMultipart, using %SOUP_FORM_MIME_TYPE_MULTIPART as -the MIME type. Then use soup_multipart_append_form_string() and -soup_multipart_append_form_file() to add the value of each form -control to the multipart. (These are just convenience methods, and -you can use soup_multipart_append_part() if you need greater -control over the part headers.) Finally, call -soup_form_request_new_from_multipart() to serialize the multipart -structure and create a #SoupMessage. - - the new %SoupMessage - - - - - the URI to send the form data to - - - - a "multipart/form-data" #SoupMultipart - - - - - - Returns the major version number of the libsoup library. -(e.g. in libsoup version 2.42.0 this is 2.) - -This function is in the library, so it represents the libsoup library -your code is running against. Contrast with the #SOUP_MAJOR_VERSION -macro, which represents the major version of the libsoup headers you -have included when compiling your code. - - the major version number of the libsoup library - - - - - Returns the micro version number of the libsoup library. -(e.g. in libsoup version 2.42.0 this is 0.) - -This function is in the library, so it represents the libsoup library -your code is running against. Contrast with the #SOUP_MICRO_VERSION -macro, which represents the micro version of the libsoup headers you -have included when compiling your code. - - the micro version number of the libsoup library - - - - - Returns the minor version number of the libsoup library. -(e.g. in libsoup version 2.42.0 this is 42.) - -This function is in the library, so it represents the libsoup library -your code is running against. Contrast with the #SOUP_MINOR_VERSION -macro, which represents the minor version of the libsoup headers you -have included when compiling your code. - - the minor version number of the libsoup library - - - - - - - - - - Parses @header to see if it contains the token @token (matched -case-insensitively). Note that this can't be used with lists -that have qvalues. - - whether or not @header contains @token - - - - - An HTTP header suitable for parsing with -soup_header_parse_list() - - - - a token - - - - - - Frees @list. - - - - - - a #GSList returned from soup_header_parse_list() or -soup_header_parse_quality_list() - - - - - - - - Frees @param_list. - - - - - - a #GHashTable returned from soup_header_parse_param_list() -or soup_header_parse_semi_param_list() - - - - - - - - - Appends something like <literal>@name=@value</literal> to @string, -taking care to quote @value if needed, and if so, to escape any -quotes or backslashes in @value. - -Alternatively, if @value is a non-ASCII UTF-8 string, it will be -appended using RFC5987 syntax. Although in theory this is supposed -to work anywhere in HTTP that uses this style of parameter, in -reality, it can only be used portably with the Content-Disposition -"filename" parameter. - -If @value is %NULL, this will just append @name to @string. - - - - - - a #GString being used to construct an HTTP header value - - - - a parameter name - - - - a parameter value, or %NULL - - - - - - Appends something like <literal>@name="@value"</literal> to -@string, taking care to escape any quotes or backslashes in @value. - -If @value is (non-ASCII) UTF-8, this will instead use RFC 5987 -encoding, just like soup_header_g_string_append_param(). - - - - - - a #GString being used to construct an HTTP header value - - - - a parameter name - - - - a parameter value - - - - - - Parses a header whose content is described by RFC2616 as -"#something", where "something" does not itself contain commas, -except as part of quoted-strings. - - a #GSList of -list elements, as allocated strings - - - - - - - a header value - - - - - - Parses a header which is a comma-delimited list of something like: -<literal>token [ "=" ( token | quoted-string ) ]</literal>. - -Tokens that don't have an associated value will still be added to -the resulting hash table, but with a %NULL value. - -This also handles RFC5987 encoding (which in HTTP is mostly used -for giving UTF8-encoded filenames in the Content-Disposition -header). - - a -#GHashTable of list elements, which can be freed with -soup_header_free_param_list(). - - - - - - - - a header value - - - - - - A strict version of soup_header_parse_param_list() -that bails out if there are duplicate parameters. -Note that this function will treat RFC5987-encoded -parameters as duplicated if an ASCII version is also -present. For header fields that might contain -RFC5987-encoded parameters, use -soup_header_parse_param_list() instead. - - -a #GHashTable of list elements, which can be freed with -soup_header_free_param_list() or %NULL if there are duplicate -elements. - - - - - - - - a header value - - - - - - Parses a header whose content is a list of items with optional -"qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding, -Accept-Language, TE). - -If @unacceptable is not %NULL, then on return, it will contain the -items with qvalue 0. Either way, those items will be removed from -the main list. - - a #GSList of -acceptable values (as allocated strings), highest-qvalue first. - - - - - - - a header value - - - - on -return, will contain a list of unacceptable values - - - - - - - - Parses a header which is a semicolon-delimited list of something -like: <literal>token [ "=" ( token | quoted-string ) ]</literal>. - -Tokens that don't have an associated value will still be added to -the resulting hash table, but with a %NULL value. - -This also handles RFC5987 encoding (which in HTTP is mostly used -for giving UTF8-encoded filenames in the Content-Disposition -header). - - a -#GHashTable of list elements, which can be freed with -soup_header_free_param_list(). - - - - - - - - a header value - - - - - - A strict version of soup_header_parse_semi_param_list() -that bails out if there are duplicate parameters. -Note that this function will treat RFC5987-encoded -parameters as duplicated if an ASCII version is also -present. For header fields that might contain -RFC5987-encoded parameters, use -soup_header_parse_semi_param_list() instead. - - -a #GHashTable of list elements, which can be freed with -soup_header_free_param_list() or %NULL if there are duplicate -elements. - - - - - - - - a header value - - - - - - Parses the headers of an HTTP request or response in @str and -stores the results in @dest. Beware that @dest may be modified even -on failure. - -This is a low-level method; normally you would use -soup_headers_parse_request() or soup_headers_parse_response(). - - success or failure - - - - - the header string (including the Request-Line or Status-Line, - but not the trailing blank line) - - - - length of @str - - - - #SoupMessageHeaders to store the header values in - - - - - - Parses the headers of an HTTP request in @str and stores the -results in @req_method, @req_path, @ver, and @req_headers. - -Beware that @req_headers may be modified even on failure. - - %SOUP_STATUS_OK if the headers could be parsed, or an -HTTP error to be returned to the client if they could not be. - - - - - the headers (up to, but not including, the trailing blank line) - - - - length of @str - - - - #SoupMessageHeaders to store the header values in - - - - if non-%NULL, will be filled in with the -request method - - - - if non-%NULL, will be filled in with the -request path - - - - if non-%NULL, will be filled in with the HTTP -version - - - - - - Parses the headers of an HTTP response in @str and stores the -results in @ver, @status_code, @reason_phrase, and @headers. - -Beware that @headers may be modified even on failure. - - success or failure. - - - - - the headers (up to, but not including, the trailing blank line) - - - - length of @str - - - - #SoupMessageHeaders to store the header values in - - - - if non-%NULL, will be filled in with the HTTP -version - - - - if non-%NULL, will be filled in with -the status code - - - - if non-%NULL, will be filled in with -the reason phrase - - - - - - Parses the HTTP Status-Line string in @status_line into @ver, -@status_code, and @reason_phrase. @status_line must be terminated by -either "\0" or "\r\n". - - %TRUE if @status_line was parsed successfully. - - - - - an HTTP Status-Line - - - - if non-%NULL, will be filled in with the HTTP -version - - - - if non-%NULL, will be filled in with -the status code - - - - if non-%NULL, will be filled in with -the reason phrase - - - - - - - - - - - Initializes @iter for iterating @hdrs. - - - - - - a pointer to a %SoupMessageHeadersIter -structure - - - - a %SoupMessageHeaders - - - - - - - - - - - - - - - - libsoup contains several help methods for processing HTML forms as -defined by <ulink -url="http://www.w3.org/TR/html401/interact/forms.html#h-17.13">the -HTML 4.01 specification</ulink>. - - soup-method.h contains a number of defines for standard HTTP and -WebDAV headers. You do not need to use these defines; you can pass -arbitrary strings to soup_message_new() if you prefer. - -The thing that these defines <emphasis>are</emphasis> useful for is -performing quick comparisons against #SoupMessage's %method field; -because that field always contains an interned string, and these -macros return interned strings, you can compare %method directly -against these macros rather than needing to use strcmp(). This is -most useful in SoupServer handlers. Eg: - -<informalexample><programlisting> - if (msg->method != SOUP_METHOD_GET &amp;&amp; msg->method != SOUP_METHOD_HEAD) { - soup_message_set_status (msg, SOUP_METHOD_NOT_IMPLEMENTED); - return; - } -</programlisting></informalexample> - - - These functions can be used to parse hostnames to attempt to determine -what part of the name belongs to the domain owner, and what part is -simply a "public suffix" such as ".com". - - - These methods are useful for manipulating #GValue<!-- -->s, and in + + These methods are useful for manipulating #GValue<!-- -->s, and in particular, arrays and hash tables of #GValue<!-- -->s, in a slightly nicer way than the standard #GValue API. They are written for use with soup-xmlrpc, but they also work with types not used by XML-RPC. - - #SoupWebsocketConnection provides support for the <ulink + + #SoupWebsocketConnection provides support for the <ulink url="http://tools.ietf.org/html/rfc6455">WebSocket</ulink> protocol. To connect to a WebSocket server, create a #SoupSession and call @@ -19152,8 +29604,29 @@ and soup_websocket_connection_send_binary() to send data, and the (#SoupWebsocketConnection currently only supports asynchronous I/O.) - - Looks up the stock HTTP description of @status_code. This is used + + SoupWebsocketExtension is the base class for WebSocket extension objects. + + + SoupWebsocketExtensionManager is the #SoupSessionFeature that handles WebSockets +extensions for a #SoupSession. + +A SoupWebsocketExtensionManager is added to the session by default, and normally +you don't need to worry about it at all. However, if you want to +disable WebSocket extensions, you can remove the feature from the +session with soup_session_remove_feature_by_type(), or disable it on +individual requests with soup_message_disable_feature(). + + + Looks up the stock HTTP description of @status_code. This is used by soup_message_set_status() to get the correct text to go with a given status code. @@ -19166,88 +29639,144 @@ phrases are not localized, and are not generally very descriptive anyway, and so they should never be presented to the user directly. Instead, you should create you own error messages based on the status code, and on what you were trying to do. + - the (terse, English) description of @status_code + the (terse, English) description of @status_code - an HTTP status code + an HTTP status code - - Turns %SOUP_STATUS_CANT_RESOLVE into + + Turns %SOUP_STATUS_CANT_RESOLVE into %SOUP_STATUS_CANT_RESOLVE_PROXY and %SOUP_STATUS_CANT_CONNECT into %SOUP_STATUS_CANT_CONNECT_PROXY. Other status codes are passed through unchanged. + - the "proxified" equivalent of @status_code. + the "proxified" equivalent of @status_code. - a status code + a status code - Compares @v1 and @v2 in a case-insensitive manner + Compares @v1 and @v2 in a case-insensitive manner + - %TRUE if they are equal (modulo case) + %TRUE if they are equal (modulo case) - - an ASCII string + + an ASCII string - - another ASCII string + + another ASCII string - Hashes @key in a case-insensitive manner. + Hashes @key in a case-insensitive manner. + - the hash code. + the hash code. - - ASCII string to hash + + ASCII string to hash - - Looks whether the @domain passed as argument is a public domain + + Looks whether the @domain passed as argument is a public domain suffix (.org, .com, .co.uk, etc) or not. Prior to libsoup 2.46, this function required that @domain be in UTF-8 if it was an IDN. From 2.46 on, the name can be in either UTF-8 or ASCII format. + - %TRUE if it is a public domain, %FALSE otherwise. + %TRUE if it is a public domain, %FALSE otherwise. - a domain name + a domain name - + - - Finds the base domain for a given @hostname. The base domain is + + Finds the base domain for a given @hostname. The base domain is composed by the top level domain (such as .org, .com, .co.uk, etc) plus the second level domain, for example for myhost.mydomain.com it will return mydomain.com. @@ -19260,57 +29789,89 @@ Prior to libsoup 2.46, this function required that @hostname be in UTF-8 if it was an IDN. From 2.46 on, the name can be in either UTF-8 or ASCII format (and the return value will be in the same format). + - a pointer to the start of the base domain in @hostname. If + a pointer to the start of the base domain in @hostname. If an error occurs, %NULL will be returned and @error set. - a hostname + a hostname - - Fully %<!-- -->-decodes @part. + + Fully %<!-- -->-decodes @part. In the past, this would return %NULL if @part contained invalid percent-encoding, but now it just ignores the problem (as soup_uri_new() already did). + - the decoded URI part. + the decoded URI part. - a URI part + a URI part - - This %<!-- -->-encodes the given URI part and returns the escaped + + This %<!-- -->-encodes the given URI part and returns the escaped version in allocated memory, which the caller must free when it is done. + - the encoded URI part + the encoded URI part - a URI part + a URI part - - additional reserved characters to + + additional reserved characters to escape (or %NULL) - - %<!-- -->-decodes any "unreserved" characters (or characters in + + %<!-- -->-decodes any "unreserved" characters (or characters in @unescape_extra) in @part, and %<!-- -->-encodes any non-ASCII characters, spaces, and non-printing characters in @part. @@ -19327,308 +29888,474 @@ server. In the past, this would return %NULL if @part contained invalid percent-encoding, but now it just ignores the problem (as soup_uri_new() already did). + - the normalized URI part + the normalized URI part - a URI part + a URI part - - reserved characters to unescape (or %NULL) + + reserved characters to unescape (or %NULL) - - Appends the provided value of type @type to @array as with + + Appends the provided value of type @type to @array as with g_value_array_append(). (The provided data is copied rather than being inserted directly.) Use #GVariant API instead. + - a #GValueArray + a #GValueArray - a #GType + a #GType - a value of type @type + a value of type @type - - Appends the provided values into @array as with + + Appends the provided values into @array as with g_value_array_append(). (The provided data is copied rather than being inserted directly.) Use #GVariant API instead. + - a #GValueArray + a #GValueArray - the type of the first value to add + the type of the first value to add - the first value to add, followed by other type/value + the first value to add, followed by other type/value pairs, terminated by %G_TYPE_INVALID - - Creates a #GValueArray from the provided arguments, which must + + Creates a #GValueArray from the provided arguments, which must consist of pairs of a #GType and a value of that type, terminated by %G_TYPE_INVALID. (The array will contain copies of the provided data rather than pointing to the passed-in data directly.) Use #GVariant API instead. + - a new #GValueArray, or %NULL if an error + a new #GValueArray, or %NULL if an error occurred. - arguments to create a #GValueArray from + arguments to create a #GValueArray from - - Gets the @index_ element of @array and stores its value into the + + Gets the @index_ element of @array and stores its value into the provided location. Use #GVariant API instead. + - %TRUE if @array contained a value with index @index_ + %TRUE if @array contained a value with index @index_ and type @type, %FALSE if not. - a #GValueArray + a #GValueArray - the index to look up + the index to look up - a #GType + a #GType - a value of type pointer-to-@type + a value of type pointer-to-@type - - Inserts the provided value of type @type into @array as with + + Inserts the provided value of type @type into @array as with g_value_array_insert(). (The provided data is copied rather than being inserted directly.) Use #GVariant API instead. + - a #GValueArray + a #GValueArray - the index to insert at + the index to insert at - a #GType + a #GType - a value of type @type + a value of type @type - - Creates a new %GValueArray. (This is just a wrapper around + + Creates a new %GValueArray. (This is just a wrapper around g_value_array_new(), for naming consistency purposes.) Use #GVariant API instead. + - a new %GValueArray + a new %GValueArray - - Creates a new %GValueArray and copies the provided values + + Creates a new %GValueArray and copies the provided values into it. Use #GVariant API instead. + - a new %GValueArray + a new %GValueArray - the type of the first value to add + the type of the first value to add - the first value to add, followed by other type/value + the first value to add, followed by other type/value pairs, terminated by %G_TYPE_INVALID - - Extracts a #GValueArray into the provided arguments, which must + + Extracts a #GValueArray into the provided arguments, which must consist of pairs of a #GType and a value of pointer-to-that-type, terminated by %G_TYPE_INVALID. The returned values will point to the same memory as the values in the array. Use #GVariant API instead. + - success or failure + success or failure - a #GValueArray + a #GValueArray - arguments to extract @array into + arguments to extract @array into - - Inserts the provided value of type @type into @hash. (Unlike with + + Inserts the provided value of type @type into @hash. (Unlike with g_hash_table_insert(), both the key and the value are copied). Use #GVariant API instead. + - a value hash + a value hash - the key + the key - a #GType + a #GType - a value of type @type + a value of type @type - - Inserts the given data into @hash. As with + + Inserts the given data into @hash. As with soup_value_hash_insert(), the keys and values are copied rather than being inserted directly. Use #GVariant API instead. + - a value hash + a value hash - the key for the first value + the key for the first value - the type of @first_key, followed by the value, followed + the type of @first_key, followed by the value, followed by additional key/type/value triplets, terminated by %NULL - - Inserts @value into @hash. (Unlike with g_hash_table_insert(), both + + Inserts @value into @hash. (Unlike with g_hash_table_insert(), both the key and the value are copied). Use #GVariant API instead. + - a value hash + a value hash - the key + the key - a value + a value - - Looks up @key in @hash and stores its value into the provided + + Looks up @key in @hash and stores its value into the provided location. Use #GVariant API instead. + - %TRUE if @hash contained a value with key @key and + %TRUE if @hash contained a value with key @key and type @type, %FALSE if not. - a value hash + a value hash - the key to look up + the key to look up - a #GType + a #GType - a value of type pointer-to-@type + a value of type pointer-to-@type - - Looks up a number of keys in @hash and returns their values. + + Looks up a number of keys in @hash and returns their values. Use #GVariant API instead. + - %TRUE if all of the keys were found, %FALSE + %TRUE if all of the keys were found, %FALSE if any were missing; note that you will generally need to initialize each destination variable to a reasonable default value, since there is no way to tell which keys were found @@ -19637,30 +30364,43 @@ and which were not. - a value hash + a value hash - the first key to look up + the first key to look up - the type of @first_key, a pointer to that type, and + the type of @first_key, a pointer to that type, and then additional key/type/pointer triplets, terminated by %NULL. - - Creates a #GHashTable whose keys are strings and whose values + + Creates a #GHashTable whose keys are strings and whose values are #GValue. Use #GVariant API instead. + - a new + a new empty #GHashTable @@ -19668,14 +30408,22 @@ empty #GHashTable - - Creates a #GHashTable whose keys are strings and whose values + + Creates a #GHashTable whose keys are strings and whose values are #GValue, and initializes it with the provided data. As with soup_value_hash_insert(), the keys and values are copied rather than being inserted directly. Use #GVariant API instead. + - a new + a new #GHashTable, initialized with the given values @@ -19684,18 +30432,26 @@ rather than being inserted directly. - the key for the first value + the key for the first value - the type of @first_key, followed by the value, followed + the type of @first_key, followed by the value, followed by additional key/type/value triplets, terminated by %NULL - - Adds the necessary headers to @msg to request a WebSocket + + Adds the necessary headers to @msg to request a WebSocket handshake. The message body and non-WebSocket-related headers are not modified. @@ -19705,20 +30461,33 @@ want to include "Sec-WebSocket-Extensions" header in the request. This is a low-level function; if you use soup_session_websocket_connect_async() to create a WebSocket connection, it will call this for you. + - a #SoupMessage + a #SoupMessage - - the "Origin" header to set + + the "Origin" header to set - - list of + + list of protocols to offer @@ -19726,8 +30495,12 @@ connection, it will call this for you. - - Adds the necessary headers to @msg to request a WebSocket + + Adds the necessary headers to @msg to request a WebSocket handshake including supported WebSocket extensions. The message body and non-WebSocket-related headers are not modified. @@ -19735,27 +30508,45 @@ not modified. This is a low-level function; if you use soup_session_websocket_connect_async() to create a WebSocket connection, it will call this for you. + - a #SoupMessage + a #SoupMessage - - the "Origin" header to set + + the "Origin" header to set - - list of + + list of protocols to offer - - list + + list of supported extension types @@ -19763,8 +30554,13 @@ connection, it will call this for you. - - Looks at the response status code and headers in @msg and + + Looks at the response status code and headers in @msg and determines if they contain a valid WebSocket handshake response (given the handshake request in @msg's request headers). @@ -19776,21 +30572,31 @@ responses with extensions. This is a low-level function; if you use soup_session_websocket_connect_async() to create a WebSocket connection, it will call this for you. + - %TRUE if @msg contains a completed valid WebSocket + %TRUE if @msg contains a completed valid WebSocket handshake, %FALSE and an error if not. - #SoupMessage containing both client and server sides of a + #SoupMessage containing both client and server sides of a WebSocket handshake - - Looks at the response status code and headers in @msg and + + Looks at the response status code and headers in @msg and determines if they contain a valid WebSocket handshake response (given the handshake request in @msg's request headers). @@ -19801,26 +30607,43 @@ extensions are returned in @accepted_extensions parameter if non-%NULL. This is a low-level function; if you use soup_session_websocket_connect_async() to create a WebSocket connection, it will call this for you. + - %TRUE if @msg contains a completed valid WebSocket + %TRUE if @msg contains a completed valid WebSocket handshake, %FALSE and an error if not. - #SoupMessage containing both client and server sides of a + #SoupMessage containing both client and server sides of a WebSocket handshake - - list + + list of supported extension types - - a + + a #GList of #SoupWebsocketExtension objects @@ -19828,13 +30651,21 @@ connection, it will call this for you. - + + - - Examines the method and request headers in @msg and determines + + Examines the method and request headers in @msg and determines whether @msg contains a valid handshake request. If @origin is non-%NULL, then only requests containing a matching @@ -19854,22 +30685,37 @@ to handle accepting WebSocket connections, it will call that for you. However, this function may be useful if you need to perform more complicated validation; eg, accepting multiple different Origins, or handling different protocols depending on the path. + - %TRUE if @msg contained a valid WebSocket handshake, + %TRUE if @msg contained a valid WebSocket handshake, %FALSE and an error if not. - #SoupMessage containing the client side of a WebSocket handshake + #SoupMessage containing the client side of a WebSocket handshake - - expected Origin header + + expected Origin header - - allowed WebSocket + + allowed WebSocket protocols. @@ -19877,8 +30723,13 @@ or handling different protocols depending on the path. - - Examines the method and request headers in @msg and determines + + Examines the method and request headers in @msg and determines whether @msg contains a valid handshake request. If @origin is non-%NULL, then only requests containing a matching @@ -19895,29 +30746,49 @@ connections, it will call that for you. However, this function may be useful if you need to perform more complicated validation; eg, accepting multiple different Origins, or handling different protocols depending on the path. + - %TRUE if @msg contained a valid WebSocket handshake, + %TRUE if @msg contained a valid WebSocket handshake, %FALSE and an error if not. - #SoupMessage containing the client side of a WebSocket handshake + #SoupMessage containing the client side of a WebSocket handshake - - expected Origin header + + expected Origin header - - allowed WebSocket + + allowed WebSocket protocols. - - list + + list of supported extension types @@ -19925,8 +30796,12 @@ depending on the path. - - Examines the method and request headers in @msg and (assuming @msg + + Examines the method and request headers in @msg and (assuming @msg contains a valid handshake request), fills in the handshake response. @@ -19944,22 +30819,37 @@ the list of supported extension types. This is a low-level function; if you use soup_server_add_websocket_handler() to handle accepting WebSocket connections, it will call this for you. + - %TRUE if @msg contained a valid WebSocket handshake + %TRUE if @msg contained a valid WebSocket handshake request and was updated to contain a handshake response. %FALSE if not. - #SoupMessage containing the client side of a WebSocket handshake + #SoupMessage containing the client side of a WebSocket handshake - - expected Origin header + + expected Origin header - - allowed WebSocket + + allowed WebSocket protocols. @@ -19967,8 +30857,12 @@ connections, it will call this for you. - - Examines the method and request headers in @msg and (assuming @msg + + Examines the method and request headers in @msg and (assuming @msg contains a valid handshake request), fills in the handshake response. @@ -19983,36 +30877,63 @@ will be returned in @accepted_extensions parameter if non-%NULL. This is a low-level function; if you use soup_server_add_websocket_handler() to handle accepting WebSocket connections, it will call this for you. + - %TRUE if @msg contained a valid WebSocket handshake + %TRUE if @msg contained a valid WebSocket handshake request and was updated to contain a handshake response. %FALSE if not. - #SoupMessage containing the client side of a WebSocket handshake + #SoupMessage containing the client side of a WebSocket handshake - - expected Origin header + + expected Origin header - - allowed WebSocket + + allowed WebSocket protocols. - - list + + list of supported extension types - - a + + a #GList of #SoupWebsocketExtension objects @@ -20020,31 +30941,48 @@ connections, it will call this for you. - - This creates an XML-RPC fault response and returns it as a string. + + This creates an XML-RPC fault response and returns it as a string. (To create a successful response, use soup_xmlrpc_build_method_response().) + - the text of the fault + the text of the fault - the fault code + the fault code - a printf()-style format string + a printf()-style format string - the parameters to @fault_format + the parameters to @fault_format - - This creates an XML-RPC methodCall and returns it as a string. + + This creates an XML-RPC methodCall and returns it as a string. This is the low-level method that soup_xmlrpc_request_new() is built on. @@ -20067,50 +31005,73 @@ The correspondence between glib types and XML-RPC types is: For structs, use a #GHashTable that maps strings to #GValue; soup_value_hash_new() and related methods can help with this. Use soup_xmlrpc_build_request() instead. + - the text of the methodCall, or %NULL on + the text of the methodCall, or %NULL on error - the name of the XML-RPC method + the name of the XML-RPC method - arguments to @method + arguments to @method - length of @params + length of @params - - This creates a (successful) XML-RPC methodResponse and returns it + + This creates a (successful) XML-RPC methodResponse and returns it as a string. To create a fault response, use soup_xmlrpc_build_fault(). The glib type to XML-RPC type mapping is as with soup_xmlrpc_build_method_call(), qv. Use soup_xmlrpc_build_response() instead. + - the text of the methodResponse, or %NULL + the text of the methodResponse, or %NULL on error - the return value + the return value - - This creates an XML-RPC methodCall and returns it as a string. + + This creates an XML-RPC methodCall and returns it as a string. This is the low-level method that soup_xmlrpc_message_new() is built on. @@ -20133,23 +31094,35 @@ Serialization details: and dictionaries with non-string keys. If @params is floating, it is consumed. + - the text of the methodCall, or %NULL on error. + the text of the methodCall, or %NULL on error. - the name of the XML-RPC method + the name of the XML-RPC method - a #GVariant tuple + a #GVariant tuple - - This creates a (successful) XML-RPC methodResponse and returns it + + This creates a (successful) XML-RPC methodResponse and returns it as a string. To create a fault response, use soup_xmlrpc_build_fault(). This is the low-level method that soup_xmlrpc_message_set_response() is built on. @@ -20158,24 +31131,36 @@ that since a method can only have a single return value, @value should not be a tuple here (unless the return value is an array). If @value is floating, it is consumed. + - the text of the methodResponse, or %NULL on error. + the text of the methodResponse, or %NULL on error. - the return value + the return value - + - - Parses @method_call to get the name and parameters, and puts + + Parses @method_call to get the name and parameters, and puts the parameters into variables of the appropriate types. The parameters are handled similarly to @@ -20186,31 +31171,50 @@ variables of the indicated type, rather than values of the type. See also soup_xmlrpc_parse_method_call(), which can be used if you don't know the types of the parameters. Use soup_xmlrpc_parse_request_full() instead. + - success or failure. + success or failure. - the XML-RPC methodCall string + the XML-RPC methodCall string - the length of @method_call, or -1 if it is NUL-terminated + the length of @method_call, or -1 if it is NUL-terminated - - on return, the methodName from @method_call + + on return, the methodName from @method_call - return types and locations for parameters + return types and locations for parameters - - Parses @method_response and extracts the return value into + + Parses @method_response and extracts the return value into a variable of the correct type. If @method_response is a fault, the return value will be unset, @@ -20220,146 +31224,228 @@ containing the fault string. (If @method_response cannot be parsed at all, soup_xmlrpc_extract_method_response() will return %FALSE, but @error will be unset.) Use soup_xmlrpc_parse_response() instead. + - %TRUE if a return value was parsed, %FALSE if the + %TRUE if a return value was parsed, %FALSE if the response was of the wrong type, or contained a fault. - the XML-RPC methodResponse string + the XML-RPC methodResponse string - the length of @method_response, or -1 if it is NUL-terminated + the length of @method_response, or -1 if it is NUL-terminated - error return value + error return value - the expected type of the return value + the expected type of the return value - location for return value + location for return value - + + - - Creates an XML-RPC methodCall and returns a #SoupMessage, ready + + Creates an XML-RPC methodCall and returns a #SoupMessage, ready to send, for that method call. See soup_xmlrpc_build_request() for serialization details. If @params is floating, it is consumed. + - a #SoupMessage encoding the + a #SoupMessage encoding the indicated XML-RPC request, or %NULL on error. - URI of the XML-RPC service + URI of the XML-RPC service - the name of the XML-RPC method to invoke at @uri + the name of the XML-RPC method to invoke at @uri - a #GVariant tuple + a #GVariant tuple - - Sets the status code and response body of @msg to indicate an + + Sets the status code and response body of @msg to indicate an unsuccessful XML-RPC call, with the error described by @fault_code and @fault_format. + - an XML-RPC request + an XML-RPC request - the fault code + the fault code - a printf()-style format string + a printf()-style format string - the parameters to @fault_format + the parameters to @fault_format - - Sets the status code and response body of @msg to indicate a + + Sets the status code and response body of @msg to indicate a successful XML-RPC call, with a return value given by @value. To set a fault response, use soup_xmlrpc_message_set_fault(). See soup_xmlrpc_build_request() for serialization details. If @value is floating, it is consumed. + - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - an XML-RPC request + an XML-RPC request - a #GVariant + a #GVariant - - Parses @method_call to get the name and parameters, and returns the + + Parses @method_call to get the name and parameters, and returns the parameter values in a #GValueArray; see also soup_xmlrpc_extract_method_call(), which is more convenient if you know in advance what the types of the parameters will be. Use soup_xmlrpc_parse_request_full() instead. + - success or failure. + success or failure. - the XML-RPC methodCall string + the XML-RPC methodCall string - the length of @method_call, or -1 if it is NUL-terminated + the length of @method_call, or -1 if it is NUL-terminated - - on return, the methodName from @method_call + + on return, the methodName from @method_call - - on return, the parameters from @method_call + + on return, the parameters from @method_call - - Parses @method_response and returns the return value in @value. If + + Parses @method_response and returns the return value in @value. If @method_response is a fault, @value will be unchanged, and @error will be set to an error of type %SOUP_XMLRPC_FAULT, with the error #code containing the fault code, and the error #message containing @@ -20367,50 +31453,84 @@ the fault string. (If @method_response cannot be parsed at all, soup_xmlrpc_parse_method_response() will return %FALSE, but @error will be unset.) Use soup_xmlrpc_parse_response() instead. + - %TRUE if a return value was parsed, %FALSE if the + %TRUE if a return value was parsed, %FALSE if the response could not be parsed, or contained a fault. - the XML-RPC methodResponse string + the XML-RPC methodResponse string - the length of @method_response, or -1 if it is NUL-terminated + the length of @method_response, or -1 if it is NUL-terminated - - on return, the return value from @method_call + + on return, the return value from @method_call - - Parses @method_call and return the method name. Method parameters can be + + Parses @method_call and return the method name. Method parameters can be parsed later using soup_xmlrpc_params_parse(). + - method's name, or %NULL on error. + method's name, or %NULL on error. - the XML-RPC methodCall string + the XML-RPC methodCall string - the length of @method_call, or -1 if it is NUL-terminated + the length of @method_call, or -1 if it is NUL-terminated - - on success, a new #SoupXMLRPCParams + + on success, a new #SoupXMLRPCParams - - Parses @method_response and returns the return value. If + + Parses @method_response and returns the return value. If @method_response is a fault, %NULL is returned, and @error will be set to an error in the %SOUP_XMLRPC_FAULT domain, with the error code containing the fault code, and the error message containing @@ -20418,124 +31538,190 @@ the fault string. If @method_response cannot be parsed, %NULL is returned, and @error will be set to an error in the %SOUP_XMLRPC_ERROR domain. See soup_xmlrpc_params_parse() for deserialization details. + - a new (non-floating) #GVariant, or %NULL + a new (non-floating) #GVariant, or %NULL - the XML-RPC methodResponse string + the XML-RPC methodResponse string - the length of @method_response, or -1 if it is NUL-terminated + the length of @method_response, or -1 if it is NUL-terminated - - A valid #GVariant type string, or %NULL + + A valid #GVariant type string, or %NULL - - Creates an XML-RPC methodCall and returns a #SoupMessage, ready + + Creates an XML-RPC methodCall and returns a #SoupMessage, ready to send, for that method call. The parameters are passed as type/value pairs; ie, first a #GType, and then a value of the appropriate type, finally terminated by %G_TYPE_INVALID. Use soup_xmlrpc_message_new() instead. + - a #SoupMessage encoding the + a #SoupMessage encoding the indicated XML-RPC request. - URI of the XML-RPC service + URI of the XML-RPC service - the name of the XML-RPC method to invoke at @uri + the name of the XML-RPC method to invoke at @uri - parameters for @method + parameters for @method - - Sets the status code and response body of @msg to indicate an + + Sets the status code and response body of @msg to indicate an unsuccessful XML-RPC call, with the error described by @fault_code and @fault_format. Use soup_xmlrpc_message_set_fault() instead. + - an XML-RPC request + an XML-RPC request - the fault code + the fault code - a printf()-style format string + a printf()-style format string - the parameters to @fault_format + the parameters to @fault_format - - Sets the status code and response body of @msg to indicate a + + Sets the status code and response body of @msg to indicate a successful XML-RPC call, with a return value given by @type and the following varargs argument, of the type indicated by @type. Use soup_xmlrpc_message_set_response() instead. + - an XML-RPC request + an XML-RPC request - the type of the response value + the type of the response value - the response value + the response value - - Get the #SoupDate from special #GVariant created by + + Get the #SoupDate from special #GVariant created by soup_xmlrpc_variant_new_datetime() or by parsing a &lt;dateTime.iso8601&gt; node. See soup_xmlrpc_params_parse(). If @variant does not contain a datetime it will return an error but it is not considered a programmer error because it generally means parameters received are not in the expected type. + - a new #SoupDate, or %NULL on error. + a new #SoupDate, or %NULL on error. - a #GVariant + a #GVariant - - Construct a special #GVariant used to serialize a &lt;dateTime.iso8601&gt; + + Construct a special #GVariant used to serialize a &lt;dateTime.iso8601&gt; node. See soup_xmlrpc_build_request(). The actual type of the returned #GVariant is unspecified and "v" or "*" @@ -20543,13 +31729,18 @@ should be used in variant format strings. For example: <informalexample><programlisting> args = g_variant_new ("(v)", soup_xmlrpc_variant_new_datetime (date)); </programlisting></informalexample> + - a floating #GVariant. + a floating #GVariant. - a #SoupDate + a #SoupDate diff --git a/WebKit2-4.0.gir b/WebKit2-4.0.gir index f5bd59c..4b016a2 100644 --- a/WebKit2-4.0.gir +++ b/WebKit2-4.0.gir @@ -11,356 +11,398 @@ and/or use gtk-doc annotations. --> + + + + + + + - Creates a new #WebKitApplicationInfo + Creates a new #WebKitApplicationInfo + - the newly created #WebKitApplicationInfo. + the newly created #WebKitApplicationInfo. - Get the name of the application. If webkit_application_info_set_name() hasn't been + Get the name of the application. If webkit_application_info_set_name() hasn't been called with a valid name, this returns g_get_prgname(). + - the application name + the application name - a #WebKitApplicationInfo + a #WebKitApplicationInfo - Get the application version previously set with webkit_application_info_set_version(). + Get the application version previously set with webkit_application_info_set_version(). + - a #WebKitApplicationInfo + a #WebKitApplicationInfo - return location for the major version number + return location for the major version number - return location for the minor version number + return location for the minor version number - return location for the micro version number + return location for the micro version number - Atomically increments the reference count of @info by one. This + Atomically increments the reference count of @info by one. This function is MT-safe and may be called from any thread. + - The passed in #WebKitApplicationInfo + The passed in #WebKitApplicationInfo - a #WebKitApplicationInfo + a #WebKitApplicationInfo - Set the name of the application. If not provided, or %NULL is passed, + Set the name of the application. If not provided, or %NULL is passed, g_get_prgname() will be used. + - a #WebKitApplicationInfo + a #WebKitApplicationInfo - the application name + the application name - Set the application version. If the application doesn't use the format + Set the application version. If the application doesn't use the format major.minor.micro you can pass 0 as the micro to use major.minor, or pass 0 as both micro and minor to use only major number. Any other format must be converted to major.minor.micro so that it can be used in version comparisons. + - a #WebKitApplicationInfo + a #WebKitApplicationInfo - the major version number + the major version number - the minor version number + the minor version number - the micro version number + the micro version number - Atomically decrements the reference count of @info by one. If the + Atomically decrements the reference count of @info by one. If the reference count drops to 0, all memory allocated by the #WebKitApplicationInfo is released. This function is MT-safe and may be called from any thread. + - a #WebKitApplicationInfo + a #WebKitApplicationInfo + - Authenticate the #WebKitAuthenticationRequest using the #WebKitCredential + Authenticate the #WebKitAuthenticationRequest using the #WebKitCredential supplied. To continue without credentials, pass %NULL as @credential. + - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - A #WebKitCredential, or %NULL + A #WebKitCredential, or %NULL - Determine whether the authentication method associated with this + Determine whether the authentication method associated with this #WebKitAuthenticationRequest should allow the storage of credentials. This will return %FALSE if WebKit doesn't support credential storing, if private browsing is enabled, or if persistent credential storage has been disabled in #WebKitWebsiteDataManager, unless credentials saving has been explicitly enabled with webkit_authentication_request_set_can_save_credentials(). + - %TRUE if WebKit can store credentials or %FALSE otherwise. + %TRUE if WebKit can store credentials or %FALSE otherwise. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Cancel the authentication challenge. This will also cancel the page loading and result in a + Cancel the authentication challenge. This will also cancel the page loading and result in a #WebKitWebView::load-failed signal with a #WebKitNetworkError of type %WEBKIT_NETWORK_ERROR_CANCELLED being emitted. + - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest + + + + + + Get the #GTlsPasswordFlags of the %WEBKIT_AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE_PIN_REQUESTED authentication challenge. + + + a #GTlsPasswordFlags + + + + + a #WebKitAuthenticationRequest - Get the host that this authentication challenge is applicable to. + Get the host that this authentication challenge is applicable to. + - The host of @request. + The host of @request. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Get the port that this authentication challenge is applicable to. + Get the port that this authentication challenge is applicable to. + - The port of @request. + The port of @request. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Get the #WebKitCredential of the proposed authentication challenge that was + Get the #WebKitCredential of the proposed authentication challenge that was stored from a previous session. The client can use this directly for authentication or construct their own #WebKitCredential. + - A #WebKitCredential encapsulating credential details + A #WebKitCredential encapsulating credential details or %NULL if there is no stored credential. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Get the realm that this authentication challenge is applicable to. + Get the realm that this authentication challenge is applicable to. + - The realm of @request. + The realm of @request. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Get the authentication scheme of the authentication challenge. + Get the authentication scheme of the authentication challenge. + - The #WebKitAuthenticationScheme of @request. + The #WebKitAuthenticationScheme of @request. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Get the #WebKitSecurityOrigin that this authentication challenge is applicable to. + Get the #WebKitSecurityOrigin that this authentication challenge is applicable to. + - a newly created #WebKitSecurityOrigin. + a newly created #WebKitSecurityOrigin. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Determine whether the authentication challenge is associated with a proxy server rather than an "origin" server. + Determine whether the authentication challenge is associated with a proxy server rather than an "origin" server. + - %TRUE if authentication is for a proxy or %FALSE otherwise. + %TRUE if authentication is for a proxy or %FALSE otherwise. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Determine whether this this is a first attempt or a retry for this authentication challenge. + Determine whether this this is a first attempt or a retry for this authentication challenge. + - %TRUE if authentication attempt is a retry or %FALSE otherwise. + %TRUE if authentication attempt is a retry or %FALSE otherwise. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Set whether the authentication method associated with @request + Set whether the authentication method associated with @request should allow the storage of credentials. This should be used by applications handling their own credentials storage to indicate that it should be supported even when internal credential storage is disabled or unsupported. Note that storing of credentials will not be allowed on ephemeral sessions in any case. + - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - value to set + value to set - Set the #WebKitCredential of the proposed authentication challenge that was + Set the #WebKitCredential of the proposed authentication challenge that was stored from a previous session. This should only be used by applications handling their own credential storage. (When using the default WebKit credential storage, webkit_authentication_request_get_proposed_credential() already contains previously-stored credentials.) Passing a %NULL @credential will clear the proposed credential. + - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - a #WebKitCredential, or %NULL + a #WebKitCredential, or %NULL @@ -372,7 +414,7 @@ Passing a %NULL @credential will clear the proposed credential. - This signal is emitted when the user authentication request succeeded. + This signal is emitted when the user authentication request succeeded. Applications handling their own credential storage should connect to this signal to save the credentials. @@ -380,13 +422,13 @@ this signal to save the credentials. - the #WebKitCredential accepted + the #WebKitCredential accepted - This signal is emitted when the user authentication request is + This signal is emitted when the user authentication request is cancelled. It allows the application to dismiss its authentication dialog in case of page load failure for example. @@ -395,11 +437,13 @@ dialog in case of page load failure for example. + + @@ -407,6 +451,7 @@ dialog in case of page load failure for example. + @@ -414,6 +459,7 @@ dialog in case of page load failure for example. + @@ -421,102 +467,112 @@ dialog in case of page load failure for example. + - + + + - Enum values representing the authentication scheme. - - The default authentication scheme of WebKit. + Enum values representing the authentication scheme. + + The default authentication scheme of WebKit. - - Basic authentication scheme as defined in RFC 2617. + + Basic authentication scheme as defined in RFC 2617. - - Digest authentication scheme as defined in RFC 2617. + + Digest authentication scheme as defined in RFC 2617. - - HTML Form authentication. + + HTML Form authentication. - - NTLM Microsoft proprietary authentication scheme. + + NTLM Microsoft proprietary authentication scheme. - - Negotiate (or SPNEGO) authentication scheme as defined in RFC 4559. + + Negotiate (or SPNEGO) authentication scheme as defined in RFC 4559. - - Client Certificate Authentication (see RFC 2246). + + Client Certificate Authentication (see RFC 2246). - - Server Trust Authentication. + + Server Trust Authentication. - - Authentication scheme unknown. + + Client certificate PIN required for use. Since: 2.34 + + + Authentication scheme unknown. - Enum values used for determining the automation browsing context presentation. - - a window + Enum values used for determining the automation browsing context presentation. + + a window - - a tab + + a tab + - Get the #WebKitAutomationSession previously set with webkit_automation_session_set_application_info(). + Get the #WebKitAutomationSession previously set with webkit_automation_session_set_application_info(). + - the #WebKitAutomationSession of @session, or %NULL if no one has been set. + the #WebKitAutomationSession of @session, or %NULL if no one has been set. - a #WebKitAutomationSession + a #WebKitAutomationSession - - Get the unique identifier of a #WebKitAutomationSession + + Get the unique identifier of a #WebKitAutomationSession + - the unique identifier of @session + the unique identifier of @session - a #WebKitAutomationSession + a #WebKitAutomationSession - Set the application information to @session. This information will be used by the driver service + Set the application information to @session. This information will be used by the driver service to match the requested capabilities with the actual application information. If this information is not provided to the session when a new automation session is requested, the creation might fail if the client requested a specific browser name or version. This will not have any effect when called after the automation session has been fully created, so this must be called in the callback of #WebKitWebContext::automation-started signal. + - a #WebKitAutomationSession + a #WebKitAutomationSession - a #WebKitApplicationInfo + a #WebKitApplicationInfo - - The session unique identifier. + + The session unique identifier. @@ -526,7 +582,7 @@ after the automation session has been fully created, so this must be called in t - This signal is emitted when the automation client requests a new + This signal is emitted when the automation client requests a new browsing context to interact with it. The callback handler should return a #WebKitWebView created with #WebKitWebView:is-controlled-by-automation construct property enabled and #WebKitWebView:automation-presentation-type construct @@ -539,17 +595,19 @@ a new web view added to a new window. When creating a new web view and there's an active browsing context, the new window or tab shouldn't be focused. - a #WebKitWebView widget. + a #WebKitWebView widget. + + @@ -557,6 +615,7 @@ or tab shouldn't be focused. + @@ -564,6 +623,7 @@ or tab shouldn't be focused. + @@ -571,80 +631,92 @@ or tab shouldn't be focused. + - + + + - Enum values used to specify autoplay policies. - - Do not restrict autoplay. + Enum values used to specify autoplay policies. + + Do not restrict autoplay. - - Allow videos to autoplay if + + Allow videos to autoplay if they have no audio track, or if their audio track is muted. - - Never allow autoplay. + + Never allow autoplay. + + + + + + + - Returns the item that precedes the current item. + Returns the item that precedes the current item. + - the #WebKitBackForwardListItem + the #WebKitBackForwardListItem preceding the current item or %NULL. - a #WebKitBackForwardList + a #WebKitBackForwardList + - a #GList of + a #GList of items preceding the current item. @@ -652,14 +724,15 @@ or tab shouldn't be focused. - a #WebKitBackForwardList + a #WebKitBackForwardList + - a #GList of + a #GList of items preceding the current item limited by @limit. @@ -667,46 +740,49 @@ or tab shouldn't be focused. - a #WebKitBackForwardList + a #WebKitBackForwardList - the number of items to retrieve + the number of items to retrieve - Returns the current item in @back_forward_list. + Returns the current item in @back_forward_list. + - a #WebKitBackForwardListItem + a #WebKitBackForwardListItem or %NULL if @back_forward_list is empty. - a #WebKitBackForwardList + a #WebKitBackForwardList - Returns the item that follows the current item. + Returns the item that follows the current item. + - the #WebKitBackForwardListItem + the #WebKitBackForwardListItem following the current item or %NULL. - a #WebKitBackForwardList + a #WebKitBackForwardList + - a #GList of + a #GList of items following the current item. @@ -714,14 +790,15 @@ or tab shouldn't be focused. - a #WebKitBackForwardList + a #WebKitBackForwardList + - a #GList of + a #GList of items following the current item limited by @limit. @@ -729,41 +806,43 @@ or tab shouldn't be focused. - a #WebKitBackForwardList + a #WebKitBackForwardList - the number of items to retrieve + the number of items to retrieve + - the length of @back_forward_list. + the length of @back_forward_list. - a #WebKitBackForwardList + a #WebKitBackForwardList - Returns the item at a given index relative to the current item. + Returns the item at a given index relative to the current item. + - the #WebKitBackForwardListItem + the #WebKitBackForwardListItem located at the specified index relative to the current item or %NULL. - a #WebKitBackForwardList + a #WebKitBackForwardList - the index of the item + the index of the item @@ -775,7 +854,7 @@ or tab shouldn't be focused. - This signal is emitted when @back_forward_list changes. This happens + This signal is emitted when @back_forward_list changes. This happens when the current item is updated, a new item is added or one or more items are removed. Note that both @item_added and @items_removed can %NULL when only the current item is updated. Items are only removed @@ -785,22 +864,24 @@ when the list is cleared or the maximum items limit is reached. - the #WebKitBackForwardListItem added or %NULL + the #WebKitBackForwardListItem added or %NULL - a #GList of #WebKitBackForwardListItem<!-- -->s + a #GList of #WebKitBackForwardListItem<!-- -->s + + @@ -808,6 +889,7 @@ when the list is cleared or the maximum items limit is reached. + @@ -815,6 +897,7 @@ when the list is cleared or the maximum items limit is reached. + @@ -822,6 +905,7 @@ when the list is cleared or the maximum items limit is reached. + @@ -829,45 +913,49 @@ when the list is cleared or the maximum items limit is reached. + - See also webkit_back_forward_list_item_get_uri(). + See also webkit_back_forward_list_item_get_uri(). + - the original URI of @list_item or %NULL + the original URI of @list_item or %NULL when the original URI is empty. - a #WebKitBackForwardListItem + a #WebKitBackForwardListItem + - the page title of @list_item or %NULL + the page title of @list_item or %NULL when the title is empty. - a #WebKitBackForwardListItem + a #WebKitBackForwardListItem - This URI may differ from the original URI if the page was, + This URI may differ from the original URI if the page was, for example, redirected to a new location. See also webkit_back_forward_list_item_get_original_uri(). + - the URI of @list_item or %NULL + the URI of @list_item or %NULL when the URI is empty. - a #WebKitBackForwardListItem + a #WebKitBackForwardListItem @@ -880,11 +968,13 @@ See also webkit_back_forward_list_item_get_original_uri(). + + @@ -892,6 +982,7 @@ See also webkit_back_forward_list_item_get_original_uri(). + @@ -899,6 +990,7 @@ See also webkit_back_forward_list_item_get_original_uri(). + @@ -906,197 +998,221 @@ See also webkit_back_forward_list_item_get_original_uri(). + - - + + + + + + + - major version (e.g. 1 for version 1.2.5) + major version (e.g. 1 for version 1.2.5) - minor version (e.g. 2 for version 1.2.5) + minor version (e.g. 2 for version 1.2.5) - micro version (e.g. 5 for version 1.2.5) + micro version (e.g. 5 for version 1.2.5) + + + + + + + + + + + + - Enum values used for determining the #WebKitWebContext cache model. - - Disable the cache completely, which + Enum values used for determining the #WebKitWebContext cache model. + + Disable the cache completely, which substantially reduces memory usage. Useful for applications that only access a single local file, with no navigation to other pages. No remote resources will be cached. - - Improve document load speed substantially + + Improve document load speed substantially by caching a very large number of resources and previously viewed content. - - A cache model optimized for viewing + + A cache model optimized for viewing a series of local files -- for example, a documentation viewer or a website designer. WebKit will cache a moderate number of resources. + - Cancels @request and the input element changes to use the initial color + Cancels @request and the input element changes to use the initial color it has before the request started. The signal #WebKitColorChooserRequest::finished is emitted to notify that the request has finished. + - a #WebKitColorChooserRequest + a #WebKitColorChooserRequest - Finishes @request and the input element keeps the current value of + Finishes @request and the input element keeps the current value of #WebKitColorChooserRequest:rgba. The signal #WebKitColorChooserRequest::finished is emitted to notify that the request has finished. + - a #WebKitColorChooserRequest + a #WebKitColorChooserRequest - Gets the bounding box of the color input element. + Gets the bounding box of the color input element. + - a #WebKitColorChooserRequest + a #WebKitColorChooserRequest - a #GdkRectangle to fill in with the element area + a #GdkRectangle to fill in with the element area - - Gets the current #GdkRGBA color of @request + + Gets the current #GdkRGBA color of @request + - a #WebKitColorChooserRequest + a #WebKitColorChooserRequest - a #GdkRGBA to fill in with the current color. + a #GdkRGBA to fill in with the current color. - - Sets the current #GdkRGBA color of @request + + Sets the current #GdkRGBA color of @request + - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - a pointer #GdkRGBA + a pointer #GdkRGBA - + @@ -1106,7 +1222,7 @@ is emitted to notify that the request has finished. - Emitted when the @request finishes. This signal can be emitted because the + Emitted when the @request finishes. This signal can be emitted because the user completed the @request calling webkit_color_chooser_request_finish(), or cancelled it with webkit_color_chooser_request_cancel() or because the color input element is removed from the DOM. @@ -1116,36 +1232,42 @@ color input element is removed from the DOM. + - + + + + - Creates a new #WebKitContextMenu object to be used as a submenu of an existing + Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view and passed as an argument of #WebKitWebView::context-menu signal. To add items to the menu use webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(). See also webkit_context_menu_new_with_items() to create a #WebKitContextMenu with a list of initial items. + - The newly created #WebKitContextMenu object + The newly created #WebKitContextMenu object - Creates a new #WebKitContextMenu object to be used as a submenu of an existing + Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu with the given initial items. See also webkit_context_menu_new() + - The newly created #WebKitContextMenu object + The newly created #WebKitContextMenu object - a #GList of #WebKitContextMenuItem + a #GList of #WebKitContextMenuItem @@ -1153,57 +1275,61 @@ See also webkit_context_menu_new() - Adds @item at the end of the @menu. + Adds @item at the end of the @menu. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - Gets the first item in the @menu. + Gets the first item in the @menu. + - the first #WebKitContextMenuItem of @menu, + the first #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. - a #WebKitContextMenu + a #WebKitContextMenu - Gets the item at the given position in the @menu. + Gets the item at the given position in the @menu. + - the #WebKitContextMenuItem at position @position in @menu, + the #WebKitContextMenuItem at position @position in @menu, or %NULL if the position is off the end of the @menu. - a #WebKitContextMenu + a #WebKitContextMenu - the position of the item, counting from 0 + the position of the item, counting from 0 - Returns the item list of @menu. + Returns the item list of @menu. + - a #GList of + a #GList of #WebKitContextMenuItem<!-- -->s @@ -1211,160 +1337,169 @@ See also webkit_context_menu_new() - a #WebKitContextMenu + a #WebKitContextMenu - Gets the length of the @menu. + Gets the length of the @menu. + - the number of #WebKitContextMenuItem<!-- -->s in @menu + the number of #WebKitContextMenuItem<!-- -->s in @menu - a #WebKitContextMenu + a #WebKitContextMenu - Gets the user data of @menu. + Gets the user data of @menu. This function can be used from the UI Process to get user data previously set from the Web Process with webkit_context_menu_set_user_data(). + - the user data of @menu, or %NULL if @menu doesn't have user data + the user data of @menu, or %NULL if @menu doesn't have user data - a #WebKitContextMenu + a #WebKitContextMenu - Inserts @item into the @menu at the given position. + Inserts @item into the @menu at the given position. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - the position to insert the item + the position to insert the item - Gets the last item in the @menu. + Gets the last item in the @menu. + - the last #WebKitContextMenuItem of @menu, + the last #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. - a #WebKitContextMenu + a #WebKitContextMenu - Moves @item to the given position in the @menu. + Moves @item to the given position in the @menu. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - the new position to move the item + the new position to move the item - Adds @item at the beginning of the @menu. + Adds @item at the beginning of the @menu. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - Removes @item from the @menu. + Removes @item from the @menu. See also webkit_context_menu_remove_all() to remove all items. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to remove + the #WebKitContextMenuItem to remove - Removes all items of the @menu. + Removes all items of the @menu. + - a #WebKitContextMenu + a #WebKitContextMenu - Sets user data to @menu. + Sets user data to @menu. This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using webkit_context_menu_get_user_data(). If the @user_data #GVariant is floating, it is consumed. + - a #WebKitContextMenu + a #WebKitContextMenu - a #GVariant + a #GVariant @@ -1377,156 +1512,158 @@ If the @user_data #GVariant is floating, it is consumed. - Enum values used to denote the stock actions for + Enum values used to denote the stock actions for #WebKitContextMenuItem<!-- -->s - - No action, used by separator menu items. + + No action, used by separator menu items. - - Open current link. + + Open current link. - - Open current link in a new window. + + Open current link in a new window. - - Download link destination. + + Download link destination. - - Copy link location to the clipboard. + + Copy link location to the clipboard. - - Open current image in a new window. + + Open current image in a new window. - - Download current image. + + Download current image. - - Copy current image to the clipboard. + + Copy current image to the clipboard. - - Copy current image location to the clipboard. + + Copy current image location to the clipboard. - - Open current frame in a new window. + + Open current frame in a new window. - - Load the previous history item. + + Load the previous history item. - - Load the next history item. + + Load the next history item. - - Stop any ongoing loading operation. + + Stop any ongoing loading operation. - - Reload the contents of current view. + + Reload the contents of current view. - - Copy current selection the clipboard. + + Copy current selection the clipboard. - - Cut current selection to the clipboard. + + Cut current selection to the clipboard. - - Paste clipboard contents. + + Paste clipboard contents. - - Delete current selection. + + Delete current selection. - - Select all text. + + Select all text. - - Input methods menu. + + Input methods menu. - - Unicode menu. + + Unicode menu. - - A proposed replacement for a misspelled word. + + A proposed replacement for a misspelled word. - - An indicator that spellchecking found no proposed replacements. + + An indicator that spellchecking found no proposed replacements. - - Causes the spellchecker to ignore the word for this session. + + Causes the spellchecker to ignore the word for this session. - - Causes the spellchecker to add the word to the dictionary. + + Causes the spellchecker to add the word to the dictionary. - - Ignore grammar. + + Ignore grammar. - - Font options menu. + + Font options menu. - - Bold. + + Bold. - - Italic. + + Italic. - - Underline. + + Underline. - - Outline. + + Outline. - - Open current element in the inspector. + + Open current element in the inspector. - - Open current video element in a new window. + + Open current video element in a new window. - - Open current audio element in a new window. + + Open current audio element in a new window. - - Copy video link location in to the clipboard. + + Copy video link location in to the clipboard. - - Copy audio link location in to the clipboard. + + Copy audio link location in to the clipboard. - - Enable or disable media controls. + + Enable or disable media controls. - - Enable or disable media loop. + + Enable or disable media loop. - - Show current video element in fullscreen mode. + + Show current video element in fullscreen mode. - - Play current media element. + + Play current media element. - - Pause current media element. + + Pause current media element. - - Mute current media element. + + Mute current media element. - - Download video to disk. Since 2.2 + + Download video to disk. Since 2.2 - - Download audio to disk. Since 2.2 + + Download audio to disk. Since 2.2 - - Insert an emoji. Since 2.26 + + Insert an emoji. Since 2.26 - - Paste clipboard contents as plain text. Since 2.30 + + Paste clipboard contents as plain text. Since 2.30 - - Custom action defined by applications. + + Custom action defined by applications. + + @@ -1534,6 +1671,7 @@ If the @user_data #GVariant is floating, it is consumed. + @@ -1541,6 +1679,7 @@ If the @user_data #GVariant is floating, it is consumed. + @@ -1548,6 +1687,7 @@ If the @user_data #GVariant is floating, it is consumed. + @@ -1555,44 +1695,47 @@ If the @user_data #GVariant is floating, it is consumed. + - Creates a new #WebKitContextMenuItem for the given @action. + Creates a new #WebKitContextMenuItem for the given @action. Use webkit_context_menu_item_new_from_gaction() instead. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #GtkAction + a #GtkAction - Creates a new #WebKitContextMenuItem for the given @action and @label. On activation + Creates a new #WebKitContextMenuItem for the given @action and @label. On activation @target will be passed as parameter to the callback. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #GAction + a #GAction - the menu item label text + the menu item label text - a #GVariant to use as the action target + a #GVariant to use as the action target - Creates a new #WebKitContextMenuItem for the given stock action. + Creates a new #WebKitContextMenuItem for the given stock action. Stock actions are handled automatically by WebKit so that, for example, when a menu item created with a %WEBKIT_CONTEXT_MENU_ACTION_STOP is activated the action associated will be handled by WebKit and the current @@ -1601,145 +1744,155 @@ load operation will be stopped. You can get the #GAction of a webkit_context_menu_item_get_gaction() and connect to the #GSimpleAction::activate signal to be notified when the item is activated, but you can't prevent the associated action from being performed. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #WebKitContextMenuAction stock action + a #WebKitContextMenuAction stock action - Creates a new #WebKitContextMenuItem for the given stock action using the given @label. + Creates a new #WebKitContextMenuItem for the given stock action using the given @label. Stock actions have a predefined label, this method can be used to create a #WebKitContextMenuItem for a #WebKitContextMenuAction but using a custom label. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #WebKitContextMenuAction stock action + a #WebKitContextMenuAction stock action - a custom label text to use instead of the predefined one + a custom label text to use instead of the predefined one - Creates a new #WebKitContextMenuItem representing a separator. + Creates a new #WebKitContextMenuItem representing a separator. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - Creates a new #WebKitContextMenuItem using the given @label with a submenu. + Creates a new #WebKitContextMenuItem using the given @label with a submenu. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - the menu item label text + the menu item label text - a #WebKitContextMenu to set + a #WebKitContextMenu to set - Gets the action associated to @item as a #GtkAction. + Gets the action associated to @item as a #GtkAction. Use webkit_context_menu_item_get_gaction() instead. + - the #GtkAction associated to the #WebKitContextMenuItem, + the #GtkAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Gets the action associated to @item as a #GAction. + Gets the action associated to @item as a #GAction. + - the #GAction associated to the #WebKitContextMenuItem, + the #GAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not + Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not created for a stock action %WEBKIT_CONTEXT_MENU_ACTION_CUSTOM will be returned. If the #WebKitContextMenuItem is a separator %WEBKIT_CONTEXT_MENU_ACTION_NO_ACTION will be returned. + - the #WebKitContextMenuAction of @item + the #WebKitContextMenuAction of @item - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Gets the submenu of @item. + Gets the submenu of @item. + - the #WebKitContextMenu representing the submenu of + the #WebKitContextMenu representing the submenu of @item or %NULL if @item doesn't have a submenu. - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Checks whether @item is a separator. + Checks whether @item is a separator. + - %TRUE is @item is a separator or %FALSE otherwise + %TRUE is @item is a separator or %FALSE otherwise - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Sets or replaces the @item submenu. If @submenu is %NULL the current + Sets or replaces the @item submenu. If @submenu is %NULL the current submenu of @item is removed. + - a #WebKitContextMenuItem + a #WebKitContextMenuItem - a #WebKitContextMenu + a #WebKitContextMenu @@ -1752,11 +1905,13 @@ submenu of @item is removed. + + @@ -1764,6 +1919,7 @@ submenu of @item is removed. + @@ -1771,6 +1927,7 @@ submenu of @item is removed. + @@ -1778,288 +1935,306 @@ submenu of @item is removed. + - - + + + + + + - Enum values used to denote the cookie acceptance policies. - - Accept all cookies unconditionally. + Enum values used to denote the cookie acceptance policies. + + Accept all cookies unconditionally. - - Reject all cookies unconditionally. + + Reject all cookies unconditionally. - - Accept only cookies set by the main document loaded. + + Accept only cookies set by the main document loaded. + - Asynchronously add a #SoupCookie to the underlying storage. + Asynchronously add a #SoupCookie to the underlying storage. When the operation is finished, @callback will be called. You can then call webkit_cookie_manager_add_cookie_finish() to get the result of the operation. + - a #WebKitCookieManager + a #WebKitCookieManager - the #SoupCookie to be added + the #SoupCookie to be added - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_cookie_manager_add_cookie(). + Finish an asynchronous operation started with webkit_cookie_manager_add_cookie(). + - %TRUE if the cookie was added or %FALSE in case of error. + %TRUE if the cookie was added or %FALSE in case of error. - a #WebKitCookieManager + a #WebKitCookieManager - a #GAsyncResult + a #GAsyncResult - Delete all cookies of @cookie_manager + Delete all cookies of @cookie_manager Use webkit_website_data_manager_clear() instead. + - a #WebKitCookieManager + a #WebKitCookieManager - Asynchronously delete a #SoupCookie from the current session. + Asynchronously delete a #SoupCookie from the current session. When the operation is finished, @callback will be called. You can then call webkit_cookie_manager_delete_cookie_finish() to get the result of the operation. + - a #WebKitCookieManager + a #WebKitCookieManager - the #SoupCookie to be deleted + the #SoupCookie to be deleted - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_cookie_manager_delete_cookie(). + Finish an asynchronous operation started with webkit_cookie_manager_delete_cookie(). + - %TRUE if the cookie was deleted or %FALSE in case of error. + %TRUE if the cookie was deleted or %FALSE in case of error. - a #WebKitCookieManager + a #WebKitCookieManager - a #GAsyncResult + a #GAsyncResult - Remove all cookies of @cookie_manager for the given @domain. + Remove all cookies of @cookie_manager for the given @domain. Use webkit_website_data_manager_remove() instead. + - a #WebKitCookieManager + a #WebKitCookieManager - a domain name + a domain name - Asynchronously get the cookie acceptance policy of @cookie_manager. + Asynchronously get the cookie acceptance policy of @cookie_manager. Note that when policy was set to %WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY and ITP is enabled, this will return %WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS. See also webkit_website_data_manager_set_itp_enabled(). When the operation is finished, @callback will be called. You can then call webkit_cookie_manager_get_accept_policy_finish() to get the result of the operation. + - a #WebKitCookieManager + a #WebKitCookieManager - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_cookie_manager_get_accept_policy(). + Finish an asynchronous operation started with webkit_cookie_manager_get_accept_policy(). + - the cookie acceptance policy of @cookie_manager as a #WebKitCookieAcceptPolicy. + the cookie acceptance policy of @cookie_manager as a #WebKitCookieAcceptPolicy. - a #WebKitCookieManager + a #WebKitCookieManager - a #GAsyncResult + a #GAsyncResult - Asynchronously get a list of #SoupCookie from @cookie_manager associated with @uri, which + Asynchronously get a list of #SoupCookie from @cookie_manager associated with @uri, which must be either an HTTP or an HTTPS URL. When the operation is finished, @callback will be called. You can then call webkit_cookie_manager_get_cookies_finish() to get the result of the operation. + - a #WebKitCookieManager + a #WebKitCookieManager - the URI associated to the cookies to be retrieved + the URI associated to the cookies to be retrieved - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_cookie_manager_get_cookies(). + Finish an asynchronous operation started with webkit_cookie_manager_get_cookies(). The return value is a #GSList of #SoupCookie instances which should be released with g_list_free_full() and soup_cookie_free(). + - A #GList of #SoupCookie instances. + A #GList of #SoupCookie instances. - a #WebKitCookieManager + a #WebKitCookieManager - a #GAsyncResult + a #GAsyncResult - Asynchronously get the list of domains for which @cookie_manager contains cookies. + Asynchronously get the list of domains for which @cookie_manager contains cookies. When the operation is finished, @callback will be called. You can then call webkit_cookie_manager_get_domains_with_cookies_finish() to get the result of the operation. Use webkit_website_data_manager_fetch() instead. + - a #WebKitCookieManager + a #WebKitCookieManager - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_cookie_manager_get_domains_with_cookies(). + Finish an asynchronous operation started with webkit_cookie_manager_get_domains_with_cookies(). The return value is a %NULL terminated list of strings which should be released with g_strfreev(). Use webkit_website_data_manager_fetch_finish() instead. + - A %NULL terminated array of domain names + A %NULL terminated array of domain names or %NULL in case of error. @@ -2067,37 +2242,38 @@ be released with g_strfreev(). - a #WebKitCookieManager + a #WebKitCookieManager - a #GAsyncResult + a #GAsyncResult - Set the cookie acceptance policy of @cookie_manager as @policy. + Set the cookie acceptance policy of @cookie_manager as @policy. Note that ITP has its own way to handle third-party cookies, so when it's enabled, and @policy is set to %WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY, %WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS will be used instead. Once disabled, the policy will be set back to %WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY. See also webkit_website_data_manager_set_itp_enabled(). + - a #WebKitCookieManager + a #WebKitCookieManager - a #WebKitCookieAcceptPolicy + a #WebKitCookieAcceptPolicy - Set the @filename where non-session cookies are stored persistently using + Set the @filename where non-session cookies are stored persistently using @storage as the format to read/write the cookies. Cookies are initially read from @filename to create an initial set of cookies. Then, non-session cookies will be written to @filename when the WebKitCookieManager::changed @@ -2106,20 +2282,21 @@ By default, @cookie_manager doesn't store the cookies persistently, so you need method to keep cookies saved across sessions. This method should never be called on a #WebKitCookieManager associated to an ephemeral #WebKitWebsiteDataManager. + - a #WebKitCookieManager + a #WebKitCookieManager - the filename to read to/write from + the filename to read to/write from - a #WebKitCookiePersistentStorage + a #WebKitCookiePersistentStorage @@ -2131,18 +2308,20 @@ This method should never be called on a #WebKitCookieManager associated to an ep - This signal is emitted when cookies are added, removed or modified. + This signal is emitted when cookies are added, removed or modified. + + @@ -2150,6 +2329,7 @@ This method should never be called on a #WebKitCookieManager associated to an ep + @@ -2157,6 +2337,7 @@ This method should never be called on a #WebKitCookieManager associated to an ep + @@ -2164,179 +2345,250 @@ This method should never be called on a #WebKitCookieManager associated to an ep + - + + + - Enum values used to denote the cookie persistent storage types. - - Cookies are stored in a text + Enum values used to denote the cookie persistent storage types. + + Cookies are stored in a text file in the Mozilla "cookies.txt" format. - - Cookies are stored in a SQLite + + Cookies are stored in a SQLite file in the current Mozilla format. + - Create a new credential from the provided username, password and persistence mode. + Create a new credential from the provided username, password and persistence mode. + - A #WebKitCredential. + A #WebKitCredential. - The username for the new credential + The username for the new credential - The password for the new credential + The password for the new credential - The #WebKitCredentialPersistence of the new credential + The #WebKitCredentialPersistence of the new credential + + + + + + Create a new credential from the @certificate and persistence mode. +Note that %WEBKIT_CREDENTIAL_PERSISTENCE_PERMANENT is not supported for certificate credentials. + + + A #WebKitCredential. + + + + + The #GTlsCertificate, or %NULL + + + + The #WebKitCredentialPersistence of the new credential + + + + + + Create a new credential from the provided PIN and persistence mode. +Note that %WEBKIT_CREDENTIAL_PERSISTENCE_PERMANENT is not supported for certificate pin credentials. + + + A #WebKitCredential. + + + + + The PIN for the new credential + + + + The #WebKitCredentialPersistence of the new credential - Make a copy of the #WebKitCredential. + Make a copy of the #WebKitCredential. + - A copy of passed in #WebKitCredential + A copy of passed in #WebKitCredential - a #WebKitCredential + a #WebKitCredential - Free the #WebKitCredential. + Free the #WebKitCredential. + - A #WebKitCredential + A #WebKitCredential + + + + + + Get the certificate currently held by this #WebKitCredential. + + + a #GTlsCertificate, or %NULL + + + + + a #WebKitCredential - Get the password currently held by this #WebKitCredential. + Get the password currently held by this #WebKitCredential. + - The password stored in the #WebKitCredential. + The password stored in the #WebKitCredential. - a #WebKitCredential + a #WebKitCredential - Get the persistence mode currently held by this #WebKitCredential. + Get the persistence mode currently held by this #WebKitCredential. + - The #WebKitCredentialPersistence stored in the #WebKitCredential. + The #WebKitCredentialPersistence stored in the #WebKitCredential. - a #WebKitCredential + a #WebKitCredential - Get the username currently held by this #WebKitCredential. + Get the username currently held by this #WebKitCredential. + - The username stored in the #WebKitCredential. + The username stored in the #WebKitCredential. - a #WebKitCredential + a #WebKitCredential - Determine whether this credential has a password stored. + Determine whether this credential has a password stored. + - %TRUE if the credential has a password or %FALSE otherwise. + %TRUE if the credential has a password or %FALSE otherwise. - a #WebKitCredential + a #WebKitCredential - Enum values representing the duration for which a credential persists. - - Credential does not persist + Enum values representing the duration for which a credential persists. + + Credential does not persist - - Credential persists for session only + + Credential persists for session only - - Credential persists permanently + + Credential persists permanently + + + + + + + + @@ -2346,11 +2598,13 @@ This method should never be called on a #WebKitCookieManager associated to an ep + + @@ -2358,6 +2612,7 @@ This method should never be called on a #WebKitCookieManager associated to an ep + @@ -2365,6 +2620,7 @@ This method should never be called on a #WebKitCookieManager associated to an ep + @@ -2372,15 +2628,20 @@ This method should never be called on a #WebKitCookieManager associated to an ep + - + + + + + @@ -2394,160 +2655,170 @@ This method should never be called on a #WebKitCookieManager associated to an ep - Cancels the download. When the ongoing download + Cancels the download. When the ongoing download operation is effectively cancelled the signal #WebKitDownload::failed is emitted with %WEBKIT_DOWNLOAD_ERROR_CANCELLED_BY_USER error. + - a #WebKitDownload + a #WebKitDownload - - Returns the current value of the #WebKitDownload:allow-overwrite property, + + Returns the current value of the #WebKitDownload:allow-overwrite property, which determines whether the download will overwrite an existing file on disk, or if it will fail if the destination already exists. + - the current value of the #WebKitDownload:allow-overwrite property + the current value of the #WebKitDownload:allow-overwrite property - a #WebKitDownload + a #WebKitDownload - - Obtains the URI to which the downloaded file will be written. You + + Obtains the URI to which the downloaded file will be written. You can connect to #WebKitDownload::created-destination to make sure this method returns a valid destination. + - the destination URI or %NULL + the destination URI or %NULL - a #WebKitDownload + a #WebKitDownload - Gets the elapsed time in seconds, including any fractional part. + Gets the elapsed time in seconds, including any fractional part. If the download finished, had an error or was cancelled this is the time between its start and the event. + - seconds since the download was started + seconds since the download was started - a #WebKitDownload + a #WebKitDownload - - Gets the value of the #WebKitDownload:estimated-progress property. + + Gets the value of the #WebKitDownload:estimated-progress property. You can monitor the estimated progress of the download operation by connecting to the notify::estimated-progress signal of @download. + - an estimate of the of the percent complete for a download + an estimate of the of the percent complete for a download as a range from 0.0 to 1.0. - a #WebKitDownload + a #WebKitDownload - Gets the length of the data already downloaded for @download + Gets the length of the data already downloaded for @download in bytes. + - the amount of bytes already downloaded. + the amount of bytes already downloaded. - a #WebKitDownload + a #WebKitDownload - Retrieves the #WebKitURIRequest object that backs the download + Retrieves the #WebKitURIRequest object that backs the download process. + - the #WebKitURIRequest of @download + the #WebKitURIRequest of @download - a #WebKitDownload + a #WebKitDownload - - Retrieves the #WebKitURIResponse object that backs the download + + Retrieves the #WebKitURIResponse object that backs the download process. This method returns %NULL if called before the response is received from the server. You can connect to notify::response signal to be notified when the response is received. + - the #WebKitURIResponse, or %NULL if + the #WebKitURIResponse, or %NULL if the response hasn't been received yet. - a #WebKitDownload + a #WebKitDownload - Get the #WebKitWebView that initiated the download. + Get the #WebKitWebView that initiated the download. + - the #WebKitWebView that initiated @download, + the #WebKitWebView that initiated @download, or %NULL if @download was not initiated by a #WebKitWebView. - a #WebKitDownload + a #WebKitDownload - - Sets the #WebKitDownload:allow-overwrite property, which determines whether + + Sets the #WebKitDownload:allow-overwrite property, which determines whether the download may overwrite an existing file on disk, or if it will fail if the destination already exists. + - a #WebKitDownload + a #WebKitDownload - the new value for the #WebKitDownload:allow-overwrite property + the new value for the #WebKitDownload:allow-overwrite property - Sets the URI to which the downloaded file will be written. + Sets the URI to which the downloaded file will be written. This method should be called before the download transfer starts or it will not have any effect on the ongoing download operation. To set the destination using the filename suggested @@ -2560,32 +2831,33 @@ If #WebKitDownload::decide-destination signal is not handled and destination URI is not set when the download transfer starts, the file will be saved with the filename suggested by the server in %G_USER_DIRECTORY_DOWNLOAD directory. + - a #WebKitDownload + a #WebKitDownload - the destination URI + the destination URI - - Whether or not the download is allowed to overwrite an existing file on + + Whether or not the download is allowed to overwrite an existing file on disk. If this property is %FALSE and the destination already exists, the download will fail. - - The local URI to where the download will be saved. + + The local URI to where the download will be saved. - - An estimate of the percent completion for the download operation. + + An estimate of the percent completion for the download operation. This value will range from 0.0 to 1.0. The value is an estimate based on the total number of bytes expected to be received for a download. @@ -2593,8 +2865,8 @@ If you need a more accurate progress information you can connect to #WebKitDownload::received-data signal to track the progress. - - The #WebKitURIResponse associated with this download. + + The #WebKitURIResponse associated with this download. @@ -2604,7 +2876,7 @@ If you need a more accurate progress information you can connect to - This signal is emitted after #WebKitDownload::decide-destination and before + This signal is emitted after #WebKitDownload::decide-destination and before #WebKitDownload::received-data to notify that destination file has been created successfully at @destination. @@ -2612,30 +2884,30 @@ created successfully at @destination. - the destination URI + the destination URI - This signal is emitted after response is received to + This signal is emitted after response is received to decide a destination URI for the download. If this signal is not handled the file will be downloaded to %G_USER_DIRECTORY_DOWNLOAD directory using @suggested_filename. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the filename suggested for the download + the filename suggested for the download - This signal is emitted when an error occurs during the download + This signal is emitted when an error occurs during the download operation. The given @error, of the domain %WEBKIT_DOWNLOAD_ERROR, contains further details of the failure. If the download is cancelled with webkit_download_cancel(), this signal is emitted with error @@ -2646,20 +2918,20 @@ after an error and #WebKitDownload::finished signal is emitted after this one. - the #GError that was triggered + the #GError that was triggered - This signal is emitted when download finishes successfully or due to an error. + This signal is emitted when download finishes successfully or due to an error. In case of errors #WebKitDownload::failed signal is emitted before this one. - This signal is emitted after response is received, + This signal is emitted after response is received, every time new data has been written to the destination. It's useful to know the progress of the download operation. @@ -2667,18 +2939,20 @@ useful to know the progress of the download operation. - the length of data received in bytes + the length of data received in bytes + + @@ -2694,6 +2968,7 @@ useful to know the progress of the download operation. + @@ -2701,6 +2976,7 @@ useful to know the progress of the download operation. + @@ -2708,6 +2984,7 @@ useful to know the progress of the download operation. + @@ -2715,6 +2992,7 @@ useful to know the progress of the download operation. + @@ -2722,15 +3000,15 @@ useful to know the progress of the download operation. - Enum values used to denote the various download errors. - - Download failure due to network error + Enum values used to denote the various download errors. + + Download failure due to network error - - Download was cancelled by user + + Download was cancelled by user - - Download failure due to destination error + + Download failure due to destination error @@ -2738,184 +3016,205 @@ useful to know the progress of the download operation. - + + + - The copy clipboard command. Copies the current selection inside + The copy clipboard command. Copies the current selection inside a #WebKitWebView to the clipboard. You can check whether it's possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it's possible to copy to the clipboard when there is an active selection inside the #WebKitWebView. + - The create link command. Creates a link element that is inserted at + The create link command. Creates a link element that is inserted at the current cursor position. If there's a selection, the selected text will be used as the link text, otherwise the URL itself will be used. It receives the link URL as argument. This command should be executed with webkit_web_view_execute_editing_command_with_argument() + - The cut clipboard command. Copies the current selection inside + The cut clipboard command. Copies the current selection inside a #WebKitWebView to the clipboard and deletes the selected content. You can check whether it's possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it's possible to cut to the clipboard when the #WebKitWebView content is editable and there is an active selection. + - The insert image command. Creates an image element that is inserted at + The insert image command. Creates an image element that is inserted at the current cursor position. It receives an URI as argument, that is used as the image source. This command should be executed with webkit_web_view_execute_editing_command_with_argument(). + - The paste clipboard command. Pastes the contents of the clipboard to + The paste clipboard command. Pastes the contents of the clipboard to a #WebKitWebView. You can check whether it's possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it's possible to paste from the clipboard when the #WebKitWebView content is editable and clipboard is not empty. + - The paste as plaintext clipboard command. Pastes the contents of the + The paste as plaintext clipboard command. Pastes the contents of the clipboard to a #WebKitWebView, with formatting removed. You can check whether it's possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it's possible to paste from the clipboard when the #WebKitWebView content is editable and clipboard is not empty. + - The redo command. Redoes a previously undone editing command in + The redo command. Redoes a previously undone editing command in a #WebKitWebView. You can check whether it's possible to execute the command with webkit_web_view_can_execute_editing_command(). It's only possible to redo a command when it has been previously undone. + - The select all command. Selects all the content of the current text field in + The select all command. Selects all the content of the current text field in a #WebKitWebView. It is always possible to select all text, no matter whether the #WebKitWebView content is editable or not. You can still check it with webkit_web_view_can_execute_editing_command(). + - The undo command. Undoes the last editing command in a #WebKitWebView. + The undo command. Undoes the last editing command in a #WebKitWebView. You can check whether it's possible to execute the command with webkit_web_view_can_execute_editing_command(). It's only possible to undo a command after a previously executed editing operation. + + + + - - Gets the typing attributes at the current cursor position. + + + Gets the typing attributes at the current cursor position. If there is a selection, this returns the typing attributes of the selected text. Note that in case of a selection, typing attributes are considered active only when they are present throughout the selection. + - a bitmask of #WebKitEditorTypingAttributes flags + a bitmask of #WebKitEditorTypingAttributes flags - a #WebKitEditorState + a #WebKitEditorState - Gets whether a copy command can be issued. + Gets whether a copy command can be issued. + - %TRUE if copy is currently available + %TRUE if copy is currently available - a #WebKitEditorState + a #WebKitEditorState - Gets whether a cut command can be issued. + Gets whether a cut command can be issued. + - %TRUE if cut is currently available + %TRUE if cut is currently available - a #WebKitEditorState + a #WebKitEditorState - Gets whether a paste command can be issued. + Gets whether a paste command can be issued. + - %TRUE if paste is currently available + %TRUE if paste is currently available - a #WebKitEditorState + a #WebKitEditorState - Gets whether a redo command can be issued. + Gets whether a redo command can be issued. + - %TRUE if redo is currently available + %TRUE if redo is currently available - a #WebKitEditorState + a #WebKitEditorState - Gets whether an undo command can be issued. + Gets whether an undo command can be issued. + - %TRUE if undo is currently available + %TRUE if undo is currently available - a #WebKitEditorState + a #WebKitEditorState - - Bitmask of #WebKitEditorTypingAttributes flags. + + Bitmask of #WebKitEditorTypingAttributes flags. See webkit_editor_state_get_typing_attributes() for more information. @@ -2927,11 +3226,13 @@ See webkit_editor_state_get_typing_attributes() for more information. + + @@ -2939,6 +3240,7 @@ See webkit_editor_state_get_typing_attributes() for more information. + @@ -2946,6 +3248,7 @@ See webkit_editor_state_get_typing_attributes() for more information. + @@ -2953,118 +3256,135 @@ See webkit_editor_state_get_typing_attributes() for more information. + - + + + - Enum values with flags representing typing attributes. - - No typing attributes. + Enum values with flags representing typing attributes. + + No typing attributes. - - Bold typing attribute. + + Bold typing attribute. - - Italic typing attribute. + + Italic typing attribute. - - Underline typing attribute. + + Underline typing attribute. - - Strikethrough typing attribute. + + Strikethrough typing attribute. + + + + + + + + + + + + + - Clears all icons from the database. + Clears all icons from the database. + - a #WebKitFaviconDatabase + a #WebKitFaviconDatabase - Asynchronously obtains a #cairo_surface_t of the favicon for the + Asynchronously obtains a #cairo_surface_t of the favicon for the given page URI. It returns the cached icon if it's in the database asynchronously waiting for the icon to be read from the database. @@ -3077,65 +3397,68 @@ the #WebKitWebContext associated with this #WebKitFaviconDatabase before attempting to use this function; otherwise, webkit_favicon_database_get_favicon_finish() will return %WEBKIT_FAVICON_DATABASE_ERROR_NOT_INITIALIZED. + - a #WebKitFaviconDatabase + a #WebKitFaviconDatabase - URI of the page for which we want to retrieve the favicon + URI of the page for which we want to retrieve the favicon - A #GCancellable or %NULL. + A #GCancellable or %NULL. - A #GAsyncReadyCallback to call when the request is + A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result. - The data to pass to @callback. + The data to pass to @callback. - Finishes an operation started with webkit_favicon_database_get_favicon(). + Finishes an operation started with webkit_favicon_database_get_favicon(). + - a new reference to a #cairo_surface_t, or + a new reference to a #cairo_surface_t, or %NULL in case of error. - a #WebKitFaviconDatabase + a #WebKitFaviconDatabase - A #GAsyncResult obtained from the #GAsyncReadyCallback passed to webkit_favicon_database_get_favicon() + A #GAsyncResult obtained from the #GAsyncReadyCallback passed to webkit_favicon_database_get_favicon() - Obtains the URI of the favicon for the given @page_uri. + Obtains the URI of the favicon for the given @page_uri. + - a newly allocated URI for the favicon, or %NULL if the + a newly allocated URI for the favicon, or %NULL if the database doesn't have a favicon for @page_uri. - a #WebKitFaviconDatabase + a #WebKitFaviconDatabase - URI of the page containing the icon + URI of the page containing the icon @@ -3147,7 +3470,7 @@ database doesn't have a favicon for @page_uri. - This signal is emitted when the favicon URI of @page_uri has + This signal is emitted when the favicon URI of @page_uri has been changed to @favicon_uri in the database. You can connect to this signal and call webkit_favicon_database_get_favicon() to get the favicon. If you are interested in the favicon of a @@ -3158,22 +3481,24 @@ property. See webkit_web_view_get_favicon() for more details. - the URI of the Web page containing the icon + the URI of the Web page containing the icon - the URI of the favicon + the URI of the favicon + + @@ -3181,6 +3506,7 @@ property. See webkit_web_view_get_favicon() for more details. + @@ -3188,6 +3514,7 @@ property. See webkit_web_view_get_favicon() for more details. + @@ -3195,6 +3522,7 @@ property. See webkit_web_view_get_favicon() for more details. + @@ -3202,15 +3530,15 @@ property. See webkit_web_view_get_favicon() for more details. - Enum values used to denote the various errors related to the #WebKitFaviconDatabase. - - The #WebKitFaviconDatabase has not been initialized yet + Enum values used to denote the various errors related to the #WebKitFaviconDatabase. + + The #WebKitFaviconDatabase has not been initialized yet - - There is not an icon available for the requested URL + + There is not an icon available for the requested URL - - There might be an icon for the requested URL, but its data is unknown at the moment + + There might be an icon for the requested URL, but its data is unknown at the moment @@ -3218,32 +3546,37 @@ property. See webkit_web_view_get_favicon() for more details. - + + + + - Ask WebKit to cancel the request. It's important to do this in case + Ask WebKit to cancel the request. It's important to do this in case no selection has been made in the client, otherwise the request won't be properly completed and the browser will keep the request pending forever, which might cause the browser to hang. + - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - - Get the list of MIME types the file chooser dialog should handle, + + Get the list of MIME types the file chooser dialog should handle, in the format specified in RFC 2046 for "media types". Its contents depend on the value of the 'accept' attribute for HTML input elements. This function should normally be called before presenting the file chooser dialog to the user, to decide whether to allow the user to select multiple files at once or only one. + - a + a %NULL-terminated array of strings if a list of accepted MIME types is defined or %NULL otherwise, meaning that any MIME type should be accepted. This array and its contents are owned by WebKit and @@ -3254,13 +3587,13 @@ should not be modified or freed. - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - Get the filter currently associated with the request, ready to be + Get the filter currently associated with the request, ready to be used by #GtkFileChooser. This function should normally be called before presenting the file chooser dialog to the user, to decide whether to apply a filter so the user would not be allowed to @@ -3268,37 +3601,39 @@ select files with other MIME types. See webkit_file_chooser_request_get_mime_types() if you are interested in getting the list of accepted MIME types. + - a #GtkFileFilter if a list of accepted + a #GtkFileFilter if a list of accepted MIME types is defined or %NULL otherwise. The returned object is owned by WebKit should not be modified or freed. - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - - Determine whether the file chooser associated to this + + Determine whether the file chooser associated to this #WebKitFileChooserRequest should allow selecting multiple files, which depends on the HTML input element having a 'multiple' attribute defined. + - %TRUE if the file chooser should allow selecting multiple files or %FALSE otherwise. + %TRUE if the file chooser should allow selecting multiple files or %FALSE otherwise. - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - - Get the list of selected files currently associated to the + + Get the list of selected files currently associated to the request. Initially, the return value of this method contains any files selected in previous file chooser requests for this HTML input element. Once webkit_file_chooser_request_select_files, the @@ -3307,8 +3642,9 @@ value will reflect whatever files are given. This function should normally be called only before presenting the file chooser dialog to the user, to decide whether to perform some extra action, like pre-selecting the files from a previous request. + - a + a %NULL-terminated array of strings if there are selected files associated with the request or %NULL otherwise. This array and its contents are owned by WebKit and should not be modified or @@ -3319,24 +3655,25 @@ freed. - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - Ask WebKit to select local files for upload and complete the + Ask WebKit to select local files for upload and complete the request. + - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - a + a %NULL-terminated array of strings, containing paths to local files. @@ -3345,28 +3682,28 @@ request. - The filter currently associated with the request. See + The filter currently associated with the request. See webkit_file_chooser_request_get_mime_types_filter() for more details. - - A %NULL-terminated array of strings containing the list of MIME + + A %NULL-terminated array of strings containing the list of MIME types the file chooser dialog should handle. See webkit_file_chooser_request_get_mime_types() for more details. - - Whether the file chooser should allow selecting multiple + + Whether the file chooser should allow selecting multiple files. See webkit_file_chooser_request_get_select_multiple() for more details. - - A %NULL-terminated array of strings containing the list of + + A %NULL-terminated array of strings containing the list of selected files associated to the current request. See webkit_file_chooser_request_get_selected_files() for more details. @@ -3381,11 +3718,13 @@ webkit_file_chooser_request_get_selected_files() for more details. + + @@ -3393,6 +3732,7 @@ webkit_file_chooser_request_get_selected_files() for more details. + @@ -3400,6 +3740,7 @@ webkit_file_chooser_request_get_selected_files() for more details. + @@ -3407,105 +3748,114 @@ webkit_file_chooser_request_get_selected_files() for more details. + - + + + + - Counts the number of matches for @search_text found in the + Counts the number of matches for @search_text found in the #WebKitWebView with the provided @find_options. The number of matches will be provided by the #WebKitFindController::counted-matches signal. + - the #WebKitFindController + the #WebKitFindController - the text to look for + the text to look for - a bitmask with the #WebKitFindOptions used in the search + a bitmask with the #WebKitFindOptions used in the search - the maximum number of matches allowed in the search + the maximum number of matches allowed in the search - - Gets the maximum number of matches to report during a text + + Gets the maximum number of matches to report during a text lookup. This number is passed as the last argument of webkit_find_controller_search() or webkit_find_controller_count_matches(). + - the maximum number of matches to report. + the maximum number of matches to report. - the #WebKitFindController + the #WebKitFindController - - Gets a bitmask containing the #WebKitFindOptions associated with + + Gets a bitmask containing the #WebKitFindOptions associated with the current search. + - a bitmask containing the #WebKitFindOptions associated + a bitmask containing the #WebKitFindOptions associated with the current search. - the #WebKitFindController + the #WebKitFindController - Gets the text that @find_controller is currently searching + Gets the text that @find_controller is currently searching for. This text is passed to either webkit_find_controller_search() or webkit_find_controller_count_matches(). + - the text to look for in the #WebKitWebView. + the text to look for in the #WebKitWebView. - the #WebKitFindController + the #WebKitFindController - - Gets the #WebKitWebView this find controller is associated to. Do + + Gets the #WebKitWebView this find controller is associated to. Do not dereference the returned instance as it belongs to the #WebKitFindController. + - the #WebKitWebView. + the #WebKitWebView. - the #WebKitFindController + the #WebKitFindController - Looks for @search_text in the #WebKitWebView associated with + Looks for @search_text in the #WebKitWebView associated with @find_controller since the beginning of the document highlighting up to @max_match_count matches. The outcome of the search will be asynchronously provided by the #WebKitFindController::found-text @@ -3524,89 +3874,93 @@ instead of the actual number. Callers should call webkit_find_controller_search_finish() to finish the current search operation. + - the #WebKitFindController + the #WebKitFindController - the text to look for + the text to look for - a bitmask with the #WebKitFindOptions used in the search + a bitmask with the #WebKitFindOptions used in the search - the maximum number of matches allowed in the search + the maximum number of matches allowed in the search - Finishes a find operation started by + Finishes a find operation started by webkit_find_controller_search(). It will basically unhighlight every text match found. This method will be typically called when the search UI is closed/hidden by the client application. + - a #WebKitFindController + a #WebKitFindController - Looks for the next occurrence of the search text. + Looks for the next occurrence of the search text. Calling this method before webkit_find_controller_search() or webkit_find_controller_count_matches() is a programming error. + - the #WebKitFindController + the #WebKitFindController - Looks for the previous occurrence of the search text. + Looks for the previous occurrence of the search text. Calling this method before webkit_find_controller_search() or webkit_find_controller_count_matches() is a programming error. + - the #WebKitFindController + the #WebKitFindController - - The maximum number of matches to report for a given search. + + The maximum number of matches to report for a given search. - - The options to be used in the search operation. + + The options to be used in the search operation. - The current search text for this #WebKitFindController. + The current search text for this #WebKitFindController. - - The #WebKitWebView this controller is associated to. + + The #WebKitWebView this controller is associated to. @@ -3616,7 +3970,7 @@ webkit_find_controller_count_matches() is a programming error. - This signal is emitted when the #WebKitFindController has + This signal is emitted when the #WebKitFindController has counted the number of matches for a given text after a call to webkit_find_controller_count_matches(). @@ -3624,13 +3978,13 @@ to webkit_find_controller_count_matches(). - the number of matches of the search text + the number of matches of the search text - This signal is emitted when a search operation does not find + This signal is emitted when a search operation does not find any result for the given text. It will be issued if the text is not found asynchronously after a call to webkit_find_controller_search(), webkit_find_controller_search_next() @@ -3640,7 +3994,7 @@ or webkit_find_controller_search_previous(). - This signal is emitted when a given text is found in the web + This signal is emitted when a given text is found in the web page text. It will be issued if the text is found asynchronously after a call to webkit_find_controller_search(), webkit_find_controller_search_next() or @@ -3650,18 +4004,20 @@ webkit_find_controller_search_previous(). - the number of matches found of the search text + the number of matches found of the search text + + @@ -3669,6 +4025,7 @@ webkit_find_controller_search_previous(). + @@ -3676,6 +4033,7 @@ webkit_find_controller_search_previous(). + @@ -3683,47 +4041,52 @@ webkit_find_controller_search_previous(). + - + + + - Enum values used to specify search options. - - no search flags, this means a case + Enum values used to specify search options. + + no search flags, this means a case sensitive, no wrap, forward only search. - - case insensitive search. + + case insensitive search. - - search text only at the + + search text only at the begining of the words. - - treat + + treat capital letters in the middle of words as word start. - - search backwards. + + search backwards. - - if not present search will stop + + if not present search will stop at the end of the document. + - Get a #GHashTable with the values of the text fields contained in the form + Get a #GHashTable with the values of the text fields contained in the form associated to @request. Note that fields will be missing if the form contains multiple text input elements with the same name, so this function does not reliably return all text fields. Use webkit_form_submission_request_list_text_fields() instead. + - a #GHashTable with the form + a #GHashTable with the form text fields, or %NULL if the form doesn't contain text fields. @@ -3732,36 +4095,37 @@ function does not reliably return all text fields. - a #WebKitFormSubmissionRequest + a #WebKitFormSubmissionRequest - Get lists with the names and values of the text fields contained in + Get lists with the names and values of the text fields contained in the form associated to @request. Note that names and values may be %NULL. If this function returns %FALSE, then both @field_names and @field_values will be empty. + - %TRUE if the form contains text fields, or %FALSE otherwise + %TRUE if the form contains text fields, or %FALSE otherwise - a #WebKitFormSubmissionRequest + a #WebKitFormSubmissionRequest - + names of the text fields in the form - + values of the text fields in the form @@ -3770,13 +4134,14 @@ If this function returns %FALSE, then both @field_names and - Continue the form submission. + Continue the form submission. + - a #WebKitFormSubmissionRequest + a #WebKitFormSubmissionRequest @@ -3789,11 +4154,13 @@ If this function returns %FALSE, then both @field_names and + + @@ -3801,6 +4168,7 @@ If this function returns %FALSE, then both @field_names and + @@ -3808,6 +4176,7 @@ If this function returns %FALSE, then both @field_names and + @@ -3815,96 +4184,109 @@ If this function returns %FALSE, then both @field_names and + - + + + + + + + + + + - Notify @manager that determining the position failed. + Notify @manager that determining the position failed. + - a #WebKitGeolocationManager + a #WebKitGeolocationManager - the error message + the error message - - Get whether high accuracy is enabled. + + Get whether high accuracy is enabled. + - a #WebKitGeolocationManager + a #WebKitGeolocationManager - Notify @manager that position has been updated to @position. + Notify @manager that position has been updated to @position. + - a #WebKitGeolocationManager + a #WebKitGeolocationManager - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - - Whether high accuracy is enabled. This is a read-only property that will be + + Whether high accuracy is enabled. This is a read-only property that will be set to %TRUE when a #WebKitGeolocationManager needs to get accurate position updates. You can connect to notify::enable-high-accuracy signal to monitor it. @@ -3916,7 +4298,7 @@ You can connect to notify::enable-high-accuracy signal to monitor it. - The signal is emitted to notify that @manager needs to start receiving + The signal is emitted to notify that @manager needs to start receiving position updates. After this signal is emitted the user should provide the updates using webkit_geolocation_manager_update_position() every time the position changes, or use webkit_geolocation_manager_failed() in case @@ -3925,13 +4307,13 @@ it isn't possible to determine the current position. If the signal is not handled, WebKit will try to determine the position using GeoClue if available. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - The signal is emitted to notify that @manager doesn't need to receive + The signal is emitted to notify that @manager doesn't need to receive position updates anymore. @@ -3939,11 +4321,13 @@ position updates anymore. + + @@ -3951,6 +4335,7 @@ position updates anymore. + @@ -3958,6 +4343,7 @@ position updates anymore. + @@ -3965,14 +4351,18 @@ position updates anymore. + - + + + + @@ -3982,11 +4372,13 @@ position updates anymore. + + @@ -3994,6 +4386,7 @@ position updates anymore. + @@ -4001,6 +4394,7 @@ position updates anymore. + @@ -4008,377 +4402,405 @@ position updates anymore. + - + + + - WebKitGeolocationPosition is an opaque struct used to provide position updates to a + WebKitGeolocationPosition is an opaque struct used to provide position updates to a #WebKitGeolocationManager using webkit_geolocation_manager_update_position(). + - Create a new #WebKitGeolocationPosition + Create a new #WebKitGeolocationPosition + - a newly created #WebKitGeolocationPosition + a newly created #WebKitGeolocationPosition - a valid latitude in degrees + a valid latitude in degrees - a valid longitude in degrees + a valid longitude in degrees - accuracy of location in meters + accuracy of location in meters - Make a copy of the #WebKitGeolocationPosition + Make a copy of the #WebKitGeolocationPosition + - a copy of @position + a copy of @position - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - Free the #WebKitGeolocationPosition + Free the #WebKitGeolocationPosition + - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - Set the @position altitude + Set the @position altitude + - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - altitude in meters + altitude in meters - Set the accuracy of @position altitude + Set the accuracy of @position altitude + - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - accuracy of position altitude in meters + accuracy of position altitude in meters - Set the @position heading, as a positive angle between the direction of movement and the North + Set the @position heading, as a positive angle between the direction of movement and the North direction, in clockwise direction. + - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - heading in degrees + heading in degrees - Set the @position speed + Set the @position speed + - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - speed in meters per second + speed in meters per second - Set the @position timestamp. By default it's the time when the @position was created. + Set the @position timestamp. By default it's the time when the @position was created. + - a #WebKitGeolocationPosition + a #WebKitGeolocationPosition - timestamp in seconds since the epoch, or 0 to use current time + timestamp in seconds since the epoch, or 0 to use current time + + + - Enum values used for determining the hardware acceleration policy. - - Hardware acceleration is enabled/disabled as request by web contents. + Enum values used for determining the hardware acceleration policy. + + Hardware acceleration is enabled/disabled as request by web contents. - - Hardware acceleration is always enabled, even for websites not requesting it. + + Hardware acceleration is always enabled, even for websites not requesting it. - - Hardware acceleration is always disabled, even for websites requesting it. + + Hardware acceleration is always disabled, even for websites requesting it. + - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in #WebKitHitTestResult:context. + - %TRUE if there's an editable element at the coordinates of the @hit_test_result, + %TRUE if there's an editable element at the coordinates of the @hit_test_result, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in #WebKitHitTestResult:context. + - %TRUE if there's an image element in the coordinates of the Hit Test, + %TRUE if there's an image element in the coordinates of the Hit Test, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a link element in the coordinates of the Hit Test, + %TRUE if there's a link element in the coordinates of the Hit Test, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a media element in the coordinates of the Hit Test, + %TRUE if there's a media element in the coordinates of the Hit Test, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a scrollbar element at the coordinates of the @hit_test_result, + %TRUE if there's a scrollbar element at the coordinates of the @hit_test_result, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a selected element at the coordinates of the @hit_test_result, + %TRUE if there's a selected element at the coordinates of the @hit_test_result, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:context property. + + Gets the value of the #WebKitHitTestResult:context property. + - a bitmask of #WebKitHitTestResultContext flags + a bitmask of #WebKitHitTestResultContext flags - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:image-uri property. + + Gets the value of the #WebKitHitTestResult:image-uri property. + - the URI of the image element in the coordinates of the Hit Test, + the URI of the image element in the coordinates of the Hit Test, or %NULL if there isn't an image element in @hit_test_result context - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:link-label property. + + Gets the value of the #WebKitHitTestResult:link-label property. + - the label of the link element in the coordinates of the Hit Test, + the label of the link element in the coordinates of the Hit Test, or %NULL if there isn't a link element in @hit_test_result context or the link element doesn't have a label - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:link-title property. + + Gets the value of the #WebKitHitTestResult:link-title property. + - the title of the link element in the coordinates of the Hit Test, + the title of the link element in the coordinates of the Hit Test, or %NULL if there isn't a link element in @hit_test_result context or the link element doesn't have a title - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:link-uri property. + + Gets the value of the #WebKitHitTestResult:link-uri property. + - the URI of the link element in the coordinates of the Hit Test, + the URI of the link element in the coordinates of the Hit Test, or %NULL if there isn't a link element in @hit_test_result context - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:media-uri property. + + Gets the value of the #WebKitHitTestResult:media-uri property. + - the URI of the media element in the coordinates of the Hit Test, + the URI of the media element in the coordinates of the Hit Test, or %NULL if there isn't a media element in @hit_test_result context - a #WebKitHitTestResult + a #WebKitHitTestResult - - Bitmask of #WebKitHitTestResultContext flags representing + + Bitmask of #WebKitHitTestResultContext flags representing the context of the #WebKitHitTestResult. - - The URI of the image if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE + + The URI of the image if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE is present in #WebKitHitTestResult:context - - The label of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK + + The label of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK is present in #WebKitHitTestResult:context - - The title of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK + + The title of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK is present in #WebKitHitTestResult:context - - The URI of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK + + The URI of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK is present in #WebKitHitTestResult:context - - The URI of the media if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA + + The URI of the media if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA is present in #WebKitHitTestResult:context @@ -4390,11 +4812,13 @@ is present in #WebKitHitTestResult:context + + @@ -4402,6 +4826,7 @@ is present in #WebKitHitTestResult:context + @@ -4409,6 +4834,7 @@ is present in #WebKitHitTestResult:context + @@ -4416,6 +4842,7 @@ is present in #WebKitHitTestResult:context + @@ -4423,819 +4850,939 @@ is present in #WebKitHitTestResult:context - Enum values with flags representing the context of a #WebKitHitTestResult. - - anywhere in the document. + Enum values with flags representing the context of a #WebKitHitTestResult. + + anywhere in the document. - - a hyperlink element. + + a hyperlink element. - - an image element. + + an image element. - - a video or audio element. + + a video or audio element. - - an editable element + + an editable element - - a scrollbar element. + + a scrollbar element. - - a selected element. Since 2.8 + + a selected element. Since 2.8 - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Get the domain name of @itp_first_party + Get the domain name of @itp_first_party + - the domain name + the domain name - a #WebKitITPFirstParty + a #WebKitITPFirstParty - Get the last time a #WebKitITPThirdParty has been seen under @itp_first_party. + Get the last time a #WebKitITPThirdParty has been seen under @itp_first_party. Each @WebKitITPFirstParty is created by webkit_itp_third_party_get_first_parties() and therefore corresponds to exactly one #WebKitITPThirdParty. + - the last update time as a #GDateTime + the last update time as a #GDateTime - a #WebKitITPFirstParty + a #WebKitITPFirstParty - Get whether @itp_first_party has granted website data access to its #WebKitITPThirdParty. + Get whether @itp_first_party has granted website data access to its #WebKitITPThirdParty. Each @WebKitITPFirstParty is created by webkit_itp_third_party_get_first_parties() and therefore corresponds to exactly one #WebKitITPThirdParty. + - %TRUE if website data access has been granted, or %FALSE otherwise + %TRUE if website data access has been granted, or %FALSE otherwise - a #WebKitITPFirstParty + a #WebKitITPFirstParty - Atomically increments the reference count of @itp_first_party by one. + Atomically increments the reference count of @itp_first_party by one. This function is MT-safe and may be called from any thread. + - The passed #WebKitITPFirstParty + The passed #WebKitITPFirstParty - a #WebKitITPFirstParty + a #WebKitITPFirstParty - Atomically decrements the reference count of @itp_first_party by one. + Atomically decrements the reference count of @itp_first_party by one. If the reference count drops to 0, all memory allocated by #WebKitITPFirstParty is released. This function is MT-safe and may be called from any thread. + - a #WebKitITPFirstParty + a #WebKitITPFirstParty + - Get the domain name of @itp_third_party + Get the domain name of @itp_third_party + - the domain name + the domain name - a #WebKitITPThirdParty + a #WebKitITPThirdParty - Get the list of #WebKitITPFirstParty under which @itp_third_party has been seen. + Get the list of #WebKitITPFirstParty under which @itp_third_party has been seen. + - a #GList of #WebKitITPFirstParty + a #GList of #WebKitITPFirstParty - a #WebKitITPThirdParty + a #WebKitITPThirdParty - Atomically increments the reference count of @itp_third_party by one. + Atomically increments the reference count of @itp_third_party by one. This function is MT-safe and may be called from any thread. + - The passed #WebKitITPThirdParty + The passed #WebKitITPThirdParty - a #WebKitITPThirdParty + a #WebKitITPThirdParty - Atomically decrements the reference count of @itp_third_party by one. + Atomically decrements the reference count of @itp_third_party by one. If the reference count drops to 0, all memory allocated by #WebKitITPThirdParty is released. This function is MT-safe and may be called from any thread. + - a #WebKitITPThirdParty + a #WebKitITPThirdParty - Enum values used to describe hints that might be taken into account by input methods. - - No special behavior suggested + Enum values used to describe hints that might be taken into account by input methods. + + No special behavior suggested - - Suggest spell checking + + Suggest spell checking - - Suggest to not autocapitlize + + Suggest to not autocapitlize - - Suggest to capitalize all text + + Suggest to capitalize all text - - Suggest to capitalize the first character of each word + + Suggest to capitalize the first character of each word - - Suggest to capitalize the first word of each sentence + + Suggest to capitalize the first word of each sentence - - Suggest to not show an onscreen keyboard + + Suggest to not show an onscreen keyboard + + @@ -5249,6 +5796,7 @@ called from any thread. + @@ -5265,132 +5813,139 @@ called from any thread. - Allow @key_event to be handled by the input method. If %TRUE is returned, then no further processing should be + Allow @key_event to be handled by the input method. If %TRUE is returned, then no further processing should be done for the key event. + - %TRUE if the key event was handled, or %FALSE otherwise + %TRUE if the key event was handled, or %FALSE otherwise - a #WebKitInputMethodContext + a #WebKitInputMethodContext - the key event to filter + the key event to filter - Get the current preedit string for the @context, and a list of WebKitInputMethodUnderline to apply to the string. + Get the current preedit string for the @context, and a list of WebKitInputMethodUnderline to apply to the string. The string will be displayed inserted at @cursor_offset. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - location to store the preedit string + location to store the preedit string - location to store the underlines as a #GList of #WebKitInputMethodUnderline + location to store the underlines as a #GList of #WebKitInputMethodUnderline - location to store the position of cursor in preedit string + location to store the position of cursor in preedit string - Notify @context that cursor area changed in input associated. + Notify @context that cursor area changed in input associated. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - the x coordinate of cursor location + the x coordinate of cursor location - the y coordinate of cursor location + the y coordinate of cursor location - the width of cursor area + the width of cursor area - the height of cursor area + the height of cursor area - Notify @context that input associated has gained focus. + Notify @context that input associated has gained focus. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Notify @context that input associated has lost focus. + Notify @context that input associated has lost focus. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Notify @context that the context surrounding the cursor has changed. + Notify @context that the context surrounding the cursor has changed. If there's no selection @selection_index is the same as @cursor_index. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - text surrounding the insertion point + text surrounding the insertion point - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - the byte index of the selection cursor within @text. + the byte index of the selection cursor within @text. + @@ -5401,6 +5956,7 @@ If there's no selection @selection_index is the same as @cursor_index. + @@ -5411,6 +5967,7 @@ If there's no selection @selection_index is the same as @cursor_index. + @@ -5421,214 +5978,227 @@ If there's no selection @selection_index is the same as @cursor_index. - Reset the @context. This will typically cause the input to clear the preedit state. + Reset the @context. This will typically cause the input to clear the preedit state. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Set whether @context should enable preedit to display feedback. + Set whether @context should enable preedit to display feedback. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - whether to enable preedit + whether to enable preedit - Allow @key_event to be handled by the input method. If %TRUE is returned, then no further processing should be + Allow @key_event to be handled by the input method. If %TRUE is returned, then no further processing should be done for the key event. + - %TRUE if the key event was handled, or %FALSE otherwise + %TRUE if the key event was handled, or %FALSE otherwise - a #WebKitInputMethodContext + a #WebKitInputMethodContext - the key event to filter + the key event to filter - - Get the value of the #WebKitInputMethodContext:input-hints property. + + Get the value of the #WebKitInputMethodContext:input-hints property. + - the #WebKitInputHints of the input associated with @context + the #WebKitInputHints of the input associated with @context - a #WebKitInputMethodContext + a #WebKitInputMethodContext - - Get the value of the #WebKitInputMethodContext:input-purpose property. + + Get the value of the #WebKitInputMethodContext:input-purpose property. + - the #WebKitInputPurpose of the input associated with @context + the #WebKitInputPurpose of the input associated with @context - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Get the current preedit string for the @context, and a list of WebKitInputMethodUnderline to apply to the string. + Get the current preedit string for the @context, and a list of WebKitInputMethodUnderline to apply to the string. The string will be displayed inserted at @cursor_offset. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - location to store the preedit string + location to store the preedit string - location to store the underlines as a #GList of #WebKitInputMethodUnderline + location to store the underlines as a #GList of #WebKitInputMethodUnderline - location to store the position of cursor in preedit string + location to store the position of cursor in preedit string - Notify @context that cursor area changed in input associated. + Notify @context that cursor area changed in input associated. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - the x coordinate of cursor location + the x coordinate of cursor location - the y coordinate of cursor location + the y coordinate of cursor location - the width of cursor area + the width of cursor area - the height of cursor area + the height of cursor area - Notify @context that input associated has gained focus. + Notify @context that input associated has gained focus. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Notify @context that input associated has lost focus. + Notify @context that input associated has lost focus. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Notify @context that the context surrounding the cursor has changed. + Notify @context that the context surrounding the cursor has changed. If there's no selection @selection_index is the same as @cursor_index. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - text surrounding the insertion point + text surrounding the insertion point - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - the byte index of the selection cursor within @text. + the byte index of the selection cursor within @text. - Reset the @context. This will typically cause the input to clear the preedit state. + Reset the @context. This will typically cause the input to clear the preedit state. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - Set whether @context should enable preedit to display feedback. + Set whether @context should enable preedit to display feedback. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - whether to enable preedit + whether to enable preedit - + + @@ -5641,26 +6211,27 @@ If there's no selection @selection_index is the same as @cursor_index. - - Set the value of the #WebKitInputMethodContext:input-purpose property. + + Set the value of the #WebKitInputMethodContext:input-purpose property. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - a #WebKitInputPurpose + a #WebKitInputPurpose - + - + @@ -5670,7 +6241,7 @@ If there's no selection @selection_index is the same as @cursor_index. - Emitted when a complete input sequence has been entered by the user. + Emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting. @@ -5678,30 +6249,30 @@ final result of preediting. - the string result + the string result - Emitted when the input method wants to delete the context surrounding the cursor. + Emitted when the input method wants to delete the context surrounding the cursor. If @offset is a negative value, it means a position before the cursor. - the character offset from the cursor position of the text to be deleted. + the character offset from the cursor position of the text to be deleted. - the number of characters to be deleted + the number of characters to be deleted - Emitted whenever the preedit sequence currently being entered has changed. + Emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case webkit_input_method_context_get_preedit() returns the empty string. @@ -5709,24 +6280,26 @@ webkit_input_method_context_get_preedit() returns the empty string. - Emitted when a preediting sequence has been completed or canceled. + Emitted when a preediting sequence has been completed or canceled. - Emitted when a new preediting sequence starts. + Emitted when a new preediting sequence starts. + + @@ -5739,6 +6312,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5751,6 +6325,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5763,6 +6338,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5778,6 +6354,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5796,16 +6373,17 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - whether to enable preedit + whether to enable preedit @@ -5813,26 +6391,27 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - location to store the preedit string + location to store the preedit string - location to store the underlines as a #GList of #WebKitInputMethodUnderline + location to store the underlines as a #GList of #WebKitInputMethodUnderline - location to store the position of cursor in preedit string + location to store the position of cursor in preedit string @@ -5840,17 +6419,18 @@ webkit_input_method_context_get_preedit() returns the empty string. + - %TRUE if the key event was handled, or %FALSE otherwise + %TRUE if the key event was handled, or %FALSE otherwise - a #WebKitInputMethodContext + a #WebKitInputMethodContext - the key event to filter + the key event to filter @@ -5858,12 +6438,13 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext @@ -5871,12 +6452,13 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext @@ -5884,28 +6466,29 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - the x coordinate of cursor location + the x coordinate of cursor location - the y coordinate of cursor location + the y coordinate of cursor location - the width of cursor area + the width of cursor area - the height of cursor area + the height of cursor area @@ -5913,28 +6496,29 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext - text surrounding the insertion point + text surrounding the insertion point - the length of @text, or -1 if @text is nul-terminated + the length of @text, or -1 if @text is nul-terminated - the byte index of the insertion cursor within @text. + the byte index of the insertion cursor within @text. - the byte index of the selection cursor within @text. + the byte index of the selection cursor within @text. @@ -5942,12 +6526,13 @@ webkit_input_method_context_get_preedit() returns the empty string. + - a #WebKitInputMethodContext + a #WebKitInputMethodContext @@ -5955,6 +6540,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5962,6 +6548,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5969,6 +6556,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5976,6 +6564,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5983,6 +6572,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5990,6 +6580,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -5997,6 +6588,7 @@ webkit_input_method_context_get_preedit() returns the empty string. + @@ -6004,123 +6596,133 @@ webkit_input_method_context_get_preedit() returns the empty string. + - + + + + - Create a new #WebKitInputMethodUnderline for the given range in preedit string + Create a new #WebKitInputMethodUnderline for the given range in preedit string + - A newly created #WebKitInputMethodUnderline + A newly created #WebKitInputMethodUnderline - the start offset in preedit string + the start offset in preedit string - the end offset in preedit string + the end offset in preedit string - Make a copy of the #WebKitInputMethodUnderline. + Make a copy of the #WebKitInputMethodUnderline. + - A copy of passed in #WebKitInputMethodUnderline + A copy of passed in #WebKitInputMethodUnderline - a #WebKitInputMethodUnderline + a #WebKitInputMethodUnderline - Free the #WebKitInputMethodUnderline. + Free the #WebKitInputMethodUnderline. + - A #WebKitInputMethodUnderline + A #WebKitInputMethodUnderline - Set the color of the underline. If @rgba is %NULL the foreground text color will be used + Set the color of the underline. If @rgba is %NULL the foreground text color will be used for the underline too. + - a #WebKitInputMethodUnderline + a #WebKitInputMethodUnderline - a #GdkRGBA or %NULL + a #GdkRGBA or %NULL - Enum values used to describe the primary purpose of the active editable element. - - Editable element expects any characters + Enum values used to describe the primary purpose of the active editable element. + + Editable element expects any characters - - Editable element expects digits + + Editable element expects digits - - Editable element expects a number + + Editable element expects a number - - Editable element expects a telephone + + Editable element expects a telephone - - Editable element expects a URL + + Editable element expects a URL - - Editable element expects an email + + Editable element expects an email - - Editable element expects a password + + Editable element expects a password - Enum values used to denote the different events which can trigger + Enum values used to denote the different events which can trigger the detection of insecure content. - - Insecure content has been detected by + + Insecure content has been detected by trying to execute any kind of logic (e.g. a script) from an untrusted source. - - Insecure content has been + + Insecure content has been detected by trying to display any kind of resource (e.g. an image) from an untrusted source. + - Gets the description about the missing plugins provided by the media backend when a media couldn't be played. + Gets the description about the missing plugins provided by the media backend when a media couldn't be played. + - a string with the description provided by the media backend. + a string with the description provided by the media backend. - a #WebKitInstallMissingMediaPluginsPermissionRequest + a #WebKitInstallMissingMediaPluginsPermissionRequest @@ -6133,11 +6735,13 @@ from an untrusted source. + + @@ -6145,6 +6749,7 @@ from an untrusted source. + @@ -6152,6 +6757,7 @@ from an untrusted source. + @@ -6159,17 +6765,20 @@ from an untrusted source. + - + + + - Enum values used to denote errors happening when executing JavaScript - - An exception was raised in JavaScript execution + Enum values used to denote errors happening when executing JavaScript + + An exception was raised in JavaScript execution @@ -6178,110 +6787,165 @@ from an untrusted source. + + + Get the global Javascript context that should be used with the +<function>JSValueRef</function> returned by webkit_javascript_result_get_value(). + Use jsc_value_get_context() instead. + + + the <function>JSGlobalContextRef</function> for the #WebKitJavascriptResult + + + + + a #WebKitJavascriptResult + + + + - Get the #JSCValue of @js_result. + Get the #JSCValue of @js_result. + - the #JSCValue of the #WebKitJavascriptResult + the #JSCValue of the #WebKitJavascriptResult - a #WebKitJavascriptResult + a #WebKitJavascriptResult + + + + + + Get the value of @js_result. You should use the <function>JSGlobalContextRef</function> +returned by webkit_javascript_result_get_global_context() to use the <function>JSValueRef</function>. + Use webkit_javascript_result_get_js_value() instead. + + + the <function>JSValueRef</function> of the #WebKitJavascriptResult + + + + + a #WebKitJavascriptResult - Atomically increments the reference count of @js_result by one. This + Atomically increments the reference count of @js_result by one. This function is MT-safe and may be called from any thread. + - The passed in #WebKitJavascriptResult + The passed in #WebKitJavascriptResult - a #WebKitJavascriptResult + a #WebKitJavascriptResult - Atomically decrements the reference count of @js_result by one. If the + Atomically decrements the reference count of @js_result by one. If the reference count drops to 0, all memory allocated by the #WebKitJavascriptResult is released. This function is MT-safe and may be called from any thread. + - a #WebKitJavascriptResult + a #WebKitJavascriptResult - Enum values used to denote the different events that happen during a + Enum values used to denote the different events that happen during a #WebKitWebView load operation. - - A new load request has been made. + + A new load request has been made. No data has been received yet, empty structures have been allocated to perform the load; the load may still fail due to transport issues such as not being able to resolve a name, or connect to a port. - - A provisional data source received + + A provisional data source received a server redirect. - - The content started arriving for a page load. + + The content started arriving for a page load. The necessary transport requirements are established, and the load is being performed. - - Load completed. All resources are done loading + + Load completed. All resources are done loading or there was an error during the load operation. - Like webkit_get_major_version(), but from the headers used at + Like webkit_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + + + + - - Like webkit_get_micro_version(), but from the headers used at + + Like webkit_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + - - Like webkit_get_minor_version(), but from the headers used at + + Like webkit_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. + + + Enum values used to specify the capture state of a media device. + + Media capture is disabled. + + + Media capture is active. + + + Media capture is muted. + + + @@ -6291,11 +6955,13 @@ against at application run time. + + @@ -6303,6 +6969,7 @@ against at application run time. + @@ -6310,6 +6977,7 @@ against at application run time. + @@ -6317,31 +6985,246 @@ against at application run time. + - - - + + + + + + + Create a new #WebKitMemoryPressureSettings with the default values. + + + A new #WebKitMemoryPressureSettings instance filled with the default values. + + + + + Make a copy of @settings. + + + A copy of of the passed #WebKitMemoryPressureSettings. + + + + + a #WebKitMemoryPressureSettings + + + + + + Free the #WebKitMemoryPressureSettings. + - the description of the MIME type of @info + + + + + a #WebKitMemoryPressureSettings + + + + + + + + the value of the the conservative threshold inside @settings. + + + + + a #WebKitMemoryPressureSettings + + + + + + + + the value of the the kill threshold inside @settings. + + + + + a #WebKitMemoryPressureSettings + + + + + + + + the value in MB of the memory limit inside @settings. + + + + + a #WebKitMemoryPressureSettings + + + + + + + + the value in seconds of the the poll interval inside @settings. + + + + + a #WebKitMemoryPressureSettings + + + + + + + + the value of the the strict threshold inside @settings. + + + + + a #WebKitMemoryPressureSettings + + + + + + Sets @value as the fraction of the defined memory limit where the conservative +policy starts working. This policy will try to reduce the memory footprint by +releasing non critical memory. + +The threshold must be bigger than 0 and smaller than 1, and it must be smaller +than the strict threshold defined in @settings. The default value is 0.33. + + + + + + + a #WebKitMemoryPressureSettings + + + + fraction of the memory limit where the conservative policy starts working. + + + + + + Sets @value as the fraction of the defined memory limit where the process will be +killed. + +The threshold must be a value bigger or equal to 0. A value of 0 means that the process +is never killed. If the threshold is not 0, then it must be bigger than the strict threshold +defined in @settings. The threshold can also have values bigger than 1. The default value is 0. + + + + + + + a #WebKitMemoryPressureSettings + + + + fraction of the memory limit where the process will be killed because + of excessive memory usage. + + + + + + Sets @memory_limit the memory limit value to @settings. + +The default value is the system's RAM size with a maximum of 3GB. + + + + + + + a #WebKitMemoryPressureSettings + + + + amount of memory (in MB) that the process is allowed to use. + + + + + + Sets @value as the poll interval used by @settings. + +The poll interval value must be bigger than 0. The default value is 30 seconds. + + + + + + + a #WebKitMemoryPressureSettings + + + + period (in seconds) between memory usage measurements. + + + + + + Sets @value as the fraction of the defined memory limit where the strict +policy starts working. This policy will try to reduce the memory footprint by +releasing critical memory. + +The threshold must be bigger than 0 and smaller than 1. Also, it must be bigger +than the conservative threshold defined in @settings, and smaller than the kill +threshold if the latter is not 0. The default value is 0.5. + + + + + + + a #WebKitMemoryPressureSettings + + + + fraction of the memory limit where the strict policy starts working. + + + + + + + + + + + the description of the MIME type of @info - a #WebKitMimeInfo + a #WebKitMimeInfo - Get the list of file extensions associated to the + Get the list of file extensions associated to the MIME type of @info + - a + a %NULL-terminated array of strings @@ -6349,311 +7232,339 @@ MIME type of @info - a #WebKitMimeInfo + a #WebKitMimeInfo + - the MIME type of @info + the MIME type of @info - a #WebKitMimeInfo + a #WebKitMimeInfo - Atomically increments the reference count of @info by one. This + Atomically increments the reference count of @info by one. This function is MT-safe and may be called from any thread. + - The passed in #WebKitMimeInfo + The passed in #WebKitMimeInfo - a #WebKitMimeInfo + a #WebKitMimeInfo - Atomically decrements the reference count of @info by one. If the + Atomically decrements the reference count of @info by one. If the reference count drops to 0, all memory allocated by the #WebKitMimeInfo is released. This function is MT-safe and may be called from any thread. + - a #WebKitMimeInfo + a #WebKitMimeInfo + + + + + + + + + + - Make a copy of @navigation. + Make a copy of @navigation. + - A copy of passed in #WebKitNavigationAction + A copy of passed in #WebKitNavigationAction - a #WebKitNavigationAction + a #WebKitNavigationAction - Free the #WebKitNavigationAction + Free the #WebKitNavigationAction + - a #WebKitNavigationAction + a #WebKitNavigationAction - Return a bitmask of #GdkModifierType values describing the modifier keys that were in effect + Return a bitmask of #GdkModifierType values describing the modifier keys that were in effect when the navigation was requested + - the modifier keys + the modifier keys - a #WebKitNavigationAction + a #WebKitNavigationAction - Return the number of the mouse button that triggered the navigation, or 0 if + Return the number of the mouse button that triggered the navigation, or 0 if the navigation was not started by a mouse event. + - the mouse button number or 0 + the mouse button number or 0 - a #WebKitNavigationAction + a #WebKitNavigationAction - Return the type of action that triggered the navigation. + Return the type of action that triggered the navigation. + - a #WebKitNavigationType + a #WebKitNavigationType - a #WebKitNavigationAction + a #WebKitNavigationAction - Return the #WebKitURIRequest associated with the navigation action. + Return the #WebKitURIRequest associated with the navigation action. Modifications to the returned object are <emphasis>not</emphasis> taken into account when the request is sent over the network, and is intended only to aid in evaluating whether a navigation action should be taken or not. To modify requests before they are sent over the network the #WebKitPage::send-request signal can be used instead. + - a #WebKitURIRequest + a #WebKitURIRequest - a #WebKitNavigationAction + a #WebKitNavigationAction - Returns whether the @navigation was redirected. + Returns whether the @navigation was redirected. + - %TRUE if the original navigation was redirected, %FALSE otherwise. + %TRUE if the original navigation was redirected, %FALSE otherwise. - a #WebKitNavigationAction + a #WebKitNavigationAction - Return whether the navigation was triggered by a user gesture like a mouse click. + Return whether the navigation was triggered by a user gesture like a mouse click. + - whether navigation action is a user gesture + whether navigation action is a user gesture - a #WebKitNavigationAction + a #WebKitNavigationAction - - Gets the value of the #WebKitNavigationPolicyDecision:frame-name property. + + + Gets the value of the #WebKitNavigationPolicyDecision:frame-name property. + - The name of the new frame this navigation action targets or %NULL + The name of the new frame this navigation action targets or %NULL - a #WebKitNavigationPolicyDecision + a #WebKitNavigationPolicyDecision - - Gets the value of the #WebKitNavigationPolicyDecision:modifiers property. + + Gets the value of the #WebKitNavigationPolicyDecision:modifiers property. Use webkit_navigation_policy_decision_get_navigation_action() instead. + - The modifiers active if this decision was triggered by a mouse event + The modifiers active if this decision was triggered by a mouse event - a #WebKitNavigationPolicyDecision + a #WebKitNavigationPolicyDecision - - Gets the value of the #WebKitNavigationPolicyDecision:mouse-button property. + + Gets the value of the #WebKitNavigationPolicyDecision:mouse-button property. Use webkit_navigation_policy_decision_get_navigation_action() instead. + - The mouse button used if this decision was triggered by a mouse event or 0 otherwise + The mouse button used if this decision was triggered by a mouse event or 0 otherwise - a #WebKitNavigationPolicyDecision + a #WebKitNavigationPolicyDecision - - Gets the value of the #WebKitNavigationPolicyDecision:navigation-action property. + + Gets the value of the #WebKitNavigationPolicyDecision:navigation-action property. + - The #WebKitNavigationAction triggering this policy decision. + The #WebKitNavigationAction triggering this policy decision. - a #WebKitNavigationPolicyDecision + a #WebKitNavigationPolicyDecision - - Gets the value of the #WebKitNavigationPolicyDecision:navigation-type property. + + Gets the value of the #WebKitNavigationPolicyDecision:navigation-type property. Use webkit_navigation_policy_decision_get_navigation_action() instead. + - The type of navigation triggering this policy decision. + The type of navigation triggering this policy decision. - a #WebKitNavigationPolicyDecision + a #WebKitNavigationPolicyDecision - - Gets the value of the #WebKitNavigationPolicyDecision:request property. + + Gets the value of the #WebKitNavigationPolicyDecision:request property. Use webkit_navigation_policy_decision_get_navigation_action() instead. + - The URI request that is associated with this navigation + The URI request that is associated with this navigation - a #WebKitNavigationPolicyDecision + a #WebKitNavigationPolicyDecision - - If this navigation request targets a new frame, this property contains + + If this navigation request targets a new frame, this property contains the name of that frame. For example if the decision was triggered by clicking a link with a target attribute equal to "_blank", this property will contain the value of that attribute. In all other cases, this value will be %NULL. - - If the navigation associated with this policy decision was originally + + If the navigation associated with this policy decision was originally triggered by a mouse event, this property contains a bitmask of various #GdkModifierType values describing the modifiers used for that click. If the navigation was not triggered by a mouse event or no modifiers @@ -6661,8 +7572,8 @@ were active, the value of this property will be zero. Use #WebKitNavigationPolicyDecision:navigation-action instead - - If the navigation associated with this policy decision was originally + + If the navigation associated with this policy decision was originally triggered by a mouse event, this property contains non-zero button number of the button triggering that event. The button numbers match those from GDK. If the navigation was not triggered by a mouse event, the value of this @@ -6670,19 +7581,19 @@ property will be 0. Use #WebKitNavigationPolicyDecision:navigation-action instead - - The #WebKitNavigationAction that triggered this policy decision. + + The #WebKitNavigationAction that triggered this policy decision. - - The type of navigation that triggered this policy decision. This is + + The type of navigation that triggered this policy decision. This is useful for enacting different policies depending on what type of user action caused the navigation. Use #WebKitNavigationPolicyDecision:navigation-action instead - - This property contains the #WebKitURIRequest associated with this + + This property contains the #WebKitURIRequest associated with this navigation. Use #WebKitNavigationPolicyDecision:navigation-action instead @@ -6695,11 +7606,13 @@ navigation. + + @@ -6707,6 +7620,7 @@ navigation. + @@ -6714,6 +7628,7 @@ navigation. + @@ -6721,50 +7636,53 @@ navigation. + - + + + - Enum values used to denote the various navigation types. - - The navigation was triggered by clicking a link. + Enum values used to denote the various navigation types. + + The navigation was triggered by clicking a link. - - The navigation was triggered by submitting a form. + + The navigation was triggered by submitting a form. - - The navigation was triggered by navigating forward or backward. + + The navigation was triggered by navigating forward or backward. - - The navigation was triggered by reloading. + + The navigation was triggered by reloading. - - The navigation was triggered by resubmitting a form. + + The navigation was triggered by resubmitting a form. - - The navigation was triggered by some other action. + + The navigation was triggered by some other action. - Enum values used to denote the various network errors. - - Generic load failure + Enum values used to denote the various network errors. + + Generic load failure - - Load failure due to transport error + + Load failure due to transport error - - Load failure due to unknown protocol + + Load failure due to unknown protocol - - Load failure due to cancellation + + Load failure due to cancellation - - Load failure due to missing file + + Load failure due to missing file @@ -6773,20 +7691,21 @@ navigation. - Enum values used to set the network proxy mode. - - Use the default proxy of the system. + Enum values used to set the network proxy mode. + + Use the default proxy of the system. - - Do not use any proxy. + + Do not use any proxy. - - Use custom proxy settings. + + Use custom proxy settings. + - Create a new #WebKitNetworkProxySettings with the given @default_proxy_uri and @ignore_hosts. + Create a new #WebKitNetworkProxySettings with the given @default_proxy_uri and @ignore_hosts. The default proxy URI will be used for any URI that doesn't match @ignore_hosts, and doesn't match any of the schemes added with webkit_network_proxy_settings_add_proxy_for_scheme(). @@ -6817,17 +7736,18 @@ Note that when dealing with Unicode hostnames, the matching is done against the Also note that hostname exclusions apply only to connections made to hosts identified by name, and IP address exclusions apply only to connections made to hosts identified by address. That is, if example.com has an address of 192.168.1.1, and @ignore_hosts contains only "192.168.1.1", then a connection to "example.com" will use the proxy, and a connection to 192.168.1.1" will not. + - A new #WebKitNetworkProxySettings. + A new #WebKitNetworkProxySettings. - the default proxy URI to use, or %NULL. + the default proxy URI to use, or %NULL. - an optional list of hosts/IP addresses to not use a proxy for. + an optional list of hosts/IP addresses to not use a proxy for. @@ -6835,145 +7755,155 @@ contains only "192.168.1.1", then a connection to "example.com" will use the pro - Adds a URI-scheme-specific proxy. URIs whose scheme matches @uri_scheme will be proxied via @proxy_uri. + Adds a URI-scheme-specific proxy. URIs whose scheme matches @uri_scheme will be proxied via @proxy_uri. As with the default proxy URI, if @proxy_uri starts with "socks://", it will be treated as referring to all three of the socks5, socks4a, and socks4 proxy types. + - a #WebKitNetworkProxySettings + a #WebKitNetworkProxySettings - the URI scheme to add a proxy for + the URI scheme to add a proxy for - the proxy URI to use for @uri_scheme + the proxy URI to use for @uri_scheme - Make a copy of the #WebKitNetworkProxySettings. + Make a copy of the #WebKitNetworkProxySettings. + - A copy of passed in #WebKitNetworkProxySettings + A copy of passed in #WebKitNetworkProxySettings - a #WebKitNetworkProxySettings + a #WebKitNetworkProxySettings - Free the #WebKitNetworkProxySettings. + Free the #WebKitNetworkProxySettings. + - A #WebKitNetworkProxySettings + A #WebKitNetworkProxySettings + - Tells WebKit the notification has been clicked. This will emit the + Tells WebKit the notification has been clicked. This will emit the #WebKitNotification::clicked signal. + - a #WebKitNotification + a #WebKitNotification - Closes the notification. + Closes the notification. + - a #WebKitNotification + a #WebKitNotification - - Obtains the body for the notification. + + Obtains the body for the notification. + - the body for the notification + the body for the notification - a #WebKitNotification + a #WebKitNotification - - Obtains the unique id for the notification. + + Obtains the unique id for the notification. + - the unique id for the notification + the unique id for the notification - a #WebKitNotification + a #WebKitNotification - - Obtains the tag identifier for the notification. + + Obtains the tag identifier for the notification. + - the tag for the notification + the tag for the notification - a #WebKitNotification + a #WebKitNotification - - Obtains the title for the notification. + + Obtains the title for the notification. + - the title for the notification + the title for the notification - a #WebKitNotification + a #WebKitNotification - - The body for the notification. + + The body for the notification. - - The unique id for the notification. + + The unique id for the notification. - - The tag identifier for the notification. + + The tag identifier for the notification. - - The title for the notification. + + The title for the notification. @@ -6983,13 +7913,13 @@ all three of the socks5, socks4a, and socks4 proxy types. - Emitted when a notification has been clicked. See webkit_notification_clicked(). + Emitted when a notification has been clicked. See webkit_notification_clicked(). - Emitted when a notification has been withdrawn. + Emitted when a notification has been withdrawn. The default handler will close the notification using libnotify, if built with support for it. @@ -6999,11 +7929,13 @@ support for it. + + @@ -7011,6 +7943,7 @@ support for it. + @@ -7018,6 +7951,7 @@ support for it. + @@ -7025,6 +7959,7 @@ support for it. + @@ -7032,6 +7967,7 @@ support for it. + @@ -7039,6 +7975,7 @@ support for it. + @@ -7046,6 +7983,7 @@ support for it. + @@ -7055,111 +7993,125 @@ support for it. + - - + + + + + + + + + + - Activates the #WebKitOptionMenuItem at @index in @menu. Activating an item changes the value + Activates the #WebKitOptionMenuItem at @index in @menu. Activating an item changes the value of the element making the item the active one. You are expected to close the menu with webkit_option_menu_close() after activating an item, calling this function again will have no effect. + - a #WebKitOptionMenu + a #WebKitOptionMenu - the index of the item + the index of the item - Request to close a #WebKitOptionMenu. This emits WebKitOptionMenu::close signal. + Request to close a #WebKitOptionMenu. This emits WebKitOptionMenu::close signal. This function should always be called to notify WebKit that the associated menu has been closed. If the menu is closed and neither webkit_option_menu_select_item() nor webkit_option_menu_activate_item() have been called, the element value remains unchanged. + - a #WebKitOptionMenu + a #WebKitOptionMenu - Returns the #WebKitOptionMenuItem at @index in @menu. + Returns the #WebKitOptionMenuItem at @index in @menu. + - a #WebKitOptionMenuItem of @menu. + a #WebKitOptionMenuItem of @menu. - a #WebKitOptionMenu + a #WebKitOptionMenu - the index of the item + the index of the item - Gets the length of the @menu. + Gets the length of the @menu. + - the number of #WebKitOptionMenuItem<!-- -->s in @menu + the number of #WebKitOptionMenuItem<!-- -->s in @menu - a #WebKitOptionMenu + a #WebKitOptionMenu - Selects the #WebKitOptionMenuItem at @index in @menu. Selecting an item changes the + Selects the #WebKitOptionMenuItem at @index in @menu. Selecting an item changes the text shown by the combo button, but it doesn't change the value of the element. You need to explicitly activate the item with webkit_option_menu_select_item() or close the menu with webkit_option_menu_close() in which case the currently selected item will be activated. + - a #WebKitOptionMenu + a #WebKitOptionMenu - the index of the item + the index of the item @@ -7171,7 +8123,7 @@ webkit_option_menu_close() in which case the currently selected item will be act - Emitted when closing a #WebKitOptionMenu is requested. This can happen + Emitted when closing a #WebKitOptionMenu is requested. This can happen when the user explicitly calls webkit_option_menu_close() or when the element is detached from the current page. @@ -7180,11 +8132,13 @@ element is detached from the current page. + + @@ -7192,6 +8146,7 @@ element is detached from the current page. + @@ -7199,6 +8154,7 @@ element is detached from the current page. + @@ -7206,6 +8162,7 @@ element is detached from the current page. + @@ -7213,275 +8170,310 @@ element is detached from the current page. + - Make a copy of the #WebKitOptionMenuItem. + Make a copy of the #WebKitOptionMenuItem. + - A copy of passed in #WebKitOptionMenuItem + A copy of passed in #WebKitOptionMenuItem - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - Free the #WebKitOptionMenuItem. + Free the #WebKitOptionMenuItem. + - A #WebKitOptionMenuItem + A #WebKitOptionMenuItem - Get the label of a #WebKitOptionMenuItem. + Get the label of a #WebKitOptionMenuItem. + - The label of @item. + The label of @item. - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - Get the tooltip of a #WebKitOptionMenuItem. + Get the tooltip of a #WebKitOptionMenuItem. + - The tooltip of @item, or %NULL. + The tooltip of @item, or %NULL. - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - Whether a #WebKitOptionMenuItem is enabled. + Whether a #WebKitOptionMenuItem is enabled. + - %TRUE if the @item is enabled or %FALSE otherwise. + %TRUE if the @item is enabled or %FALSE otherwise. - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - Whether a #WebKitOptionMenuItem is a group child. + Whether a #WebKitOptionMenuItem is a group child. + - %TRUE if the @item is a group child or %FALSE otherwise. + %TRUE if the @item is a group child or %FALSE otherwise. - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - Whether a #WebKitOptionMenuItem is a group label. + Whether a #WebKitOptionMenuItem is a group label. + - %TRUE if the @item is a group label or %FALSE otherwise. + %TRUE if the @item is a group label or %FALSE otherwise. - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - Whether a #WebKitOptionMenuItem is the currently selected one. + Whether a #WebKitOptionMenuItem is the currently selected one. + - %TRUE if the @item is selected or %FALSE otherwise. + %TRUE if the @item is selected or %FALSE otherwise. - a #WebKitOptionMenuItem + a #WebKitOptionMenuItem - + + + + + + + + + + + + + + + + + + + + + - Allow the action which triggered this request. + Allow the action which triggered this request. + - a #WebKitPermissionRequest + a #WebKitPermissionRequest - Deny the action which triggered this request. + Deny the action which triggered this request. + - a #WebKitPermissionRequest + a #WebKitPermissionRequest - Allow the action which triggered this request. + Allow the action which triggered this request. + - a #WebKitPermissionRequest + a #WebKitPermissionRequest - Deny the action which triggered this request. + Deny the action which triggered this request. + - a #WebKitPermissionRequest + a #WebKitPermissionRequest + + - a #WebKitPermissionRequest + a #WebKitPermissionRequest @@ -7489,12 +8481,13 @@ element is detached from the current page. + - a #WebKitPermissionRequest + a #WebKitPermissionRequest @@ -7502,54 +8495,59 @@ element is detached from the current page. + + - the description of the plugin. + the description of the plugin. - a #WebKitPlugin + a #WebKitPlugin - Get information about MIME types handled by the plugin, + Get information about MIME types handled by the plugin, as a list of #WebKitMimeInfo. + - a #GList of #WebKitMimeInfo. + a #GList of #WebKitMimeInfo. - a #WebKitPlugin + a #WebKitPlugin + - the name of the plugin. + the name of the plugin. - a #WebKitPlugin + a #WebKitPlugin + - the absolute path where the plugin is installed. + the absolute path where the plugin is installed. - a #WebKitPlugin + a #WebKitPlugin @@ -7562,11 +8560,13 @@ as a list of #WebKitMimeInfo. + + @@ -7574,6 +8574,7 @@ as a list of #WebKitMimeInfo. + @@ -7581,6 +8582,7 @@ as a list of #WebKitMimeInfo. + @@ -7588,6 +8590,7 @@ as a list of #WebKitMimeInfo. + @@ -7595,24 +8598,24 @@ as a list of #WebKitMimeInfo. - Enum values used to denote the various plugin and multimedia errors. - - Generic plugin load failure. Deprecated 2.32 + Enum values used to denote the various plugin and multimedia errors. + + Generic plugin load failure. Deprecated 2.32 - - Load failure due to missing plugin. Deprecated 2.32 + + Load failure due to missing plugin. Deprecated 2.32 - - Load failure due to inability to load plugin. Deprecated 2.32 + + Load failure due to inability to load plugin. Deprecated 2.32 - - Load failure due to missing Java support that is required to load plugin. Deprecated 2.32 + + Load failure due to missing Java support that is required to load plugin. Deprecated 2.32 - - Load failure due to connection cancellation. Deprecated 2.32 + + Load failure due to connection cancellation. Deprecated 2.32 - - Preliminary load failure for media content types. A new load will be started to perform the media load. + + Preliminary load failure for media content types. A new load will be started to perform the media load. @@ -7620,8 +8623,11 @@ as a list of #WebKitMimeInfo. - + + + + @@ -7631,11 +8637,13 @@ as a list of #WebKitMimeInfo. + + @@ -7643,6 +8651,7 @@ as a list of #WebKitMimeInfo. + @@ -7650,6 +8659,7 @@ as a list of #WebKitMimeInfo. + @@ -7657,69 +8667,77 @@ as a list of #WebKitMimeInfo. + - + + + + - Spawn a download from this decision. + Spawn a download from this decision. + - a #WebKitPolicyDecision + a #WebKitPolicyDecision - Ignore the action which triggered this decision. For instance, for a + Ignore the action which triggered this decision. For instance, for a #WebKitResponsePolicyDecision, this would cancel the request. + - a #WebKitPolicyDecision + a #WebKitPolicyDecision - Accept the action which triggered this decision. + Accept the action which triggered this decision. + - a #WebKitPolicyDecision + a #WebKitPolicyDecision - Accept the navigation action which triggered this decision, and + Accept the navigation action which triggered this decision, and continue with @policies affecting all subsequent loads of resources in the origin associated with the accepted navigation action. For example, a navigation decision to a video sharing website may be accepted under the priviso no movies are allowed to autoplay. The autoplay policy in this case would be set in the @policies. + - a #WebKitPolicyDecision + a #WebKitPolicyDecision - a #WebKitWebsitePolicies + a #WebKitWebsitePolicies @@ -7732,11 +8750,13 @@ autoplay policy in this case would be set in the @policies. + + @@ -7744,6 +8764,7 @@ autoplay policy in this case would be set in the @policies. + @@ -7751,6 +8772,7 @@ autoplay policy in this case would be set in the @policies. + @@ -7758,25 +8780,28 @@ autoplay policy in this case would be set in the @policies. + - + + + - Enum values used for determining the type of a policy decision during + Enum values used for determining the type of a policy decision during #WebKitWebView::decide-policy. - - This type of policy decision + + This type of policy decision is requested when WebKit is about to navigate to a new page in either the main frame or a subframe. Acceptable policy decisions are either webkit_policy_decision_use() or webkit_policy_decision_ignore(). This type of policy decision is always a #WebKitNavigationPolicyDecision. - - This type of policy decision + + This type of policy decision is requested when WebKit is about to create a new window. Acceptable policy decisions are either webkit_policy_decision_use() or webkit_policy_decision_ignore(). This type of policy decision is always @@ -7785,8 +8810,8 @@ autoplay policy in this case would be set in the @policies. in a tab when a keyboard modifier is active or handling a special target attribute on &lt;a&gt; elements. - - This type of decision is used when WebKit has + + This type of decision is used when WebKit has received a response for a network resource and is about to start the load. Note that these resources include all subresources of a page such as images and stylesheets as well as main documents. Appropriate policy responses to @@ -7798,21 +8823,21 @@ autoplay policy in this case would be set in the @policies. - Enum values used to denote the various policy errors. - - Generic load failure due to policy error + Enum values used to denote the various policy errors. + + Generic load failure due to policy error - - Load failure due to unsupported mime type + + Load failure due to unsupported mime type - - Load failure due to URI that can not be shown + + Load failure due to URI that can not be shown - - Load failure due to frame load interruption by policy change + + Load failure due to frame load interruption by policy change - - Load failure due to port restriction + + Load failure due to port restriction @@ -7821,27 +8846,30 @@ autoplay policy in this case would be set in the @policies. + - Create a new #WebKitPrintCustomWidget with given @widget and @title. The @widget + Create a new #WebKitPrintCustomWidget with given @widget and @title. The @widget ownership is taken and it is destroyed together with the dialog even if this object could still be alive at that point. You typically want to pass a container widget with multiple widgets in it. + - a new #WebKitPrintOperation. + a new #WebKitPrintOperation. - a #GtkWidget + a #GtkWidget - a @widget's title + a @widget's title + @@ -7855,6 +8883,7 @@ widget with multiple widgets in it. + @@ -7873,43 +8902,45 @@ widget with multiple widgets in it. - - Return the value of #WebKitPrintCustomWidget:title property for the given + + Return the value of #WebKitPrintCustomWidget:title property for the given @print_custom_widget object. + - Title of the @print_custom_widget. + Title of the @print_custom_widget. - a #WebKitPrintCustomWidget + a #WebKitPrintCustomWidget - - Return the value of #WebKitPrintCustomWidget:widget property for the given + + Return the value of #WebKitPrintCustomWidget:widget property for the given @print_custom_widget object. The returned value will always be valid if called from #WebKitPrintCustomWidget::apply or #WebKitPrintCustomWidget::update callbacks, but it will be %NULL if called after the #WebKitPrintCustomWidget::apply signal is emitted. + - a #GtkWidget. + a #GtkWidget. - a #WebKitPrintCustomWidget + a #WebKitPrintCustomWidget - - The title of the custom widget. + + The title of the custom widget. - - The custom #GtkWidget that will be embedded in the dialog. + + The custom #GtkWidget that will be embedded in the dialog. @@ -7919,7 +8950,7 @@ callbacks, but it will be %NULL if called after the - Emitted right before the printing will start. You should read the information + Emitted right before the printing will start. You should read the information from the widget and update the content based on it if necessary. The widget is not guaranteed to be valid at a later time. @@ -7927,7 +8958,7 @@ is not guaranteed to be valid at a later time. - Emitted after change of selected printer in the dialog. The actual page setup + Emitted after change of selected printer in the dialog. The actual page setup and print settings are available and the custom widget can actualize itself according to their values. @@ -7935,22 +8966,24 @@ according to their values. - actual page setup + actual page setup - actual print settings + actual print settings + + @@ -7966,6 +8999,7 @@ according to their values. + @@ -7987,6 +9021,7 @@ according to their values. + @@ -7994,6 +9029,7 @@ according to their values. + @@ -8001,6 +9037,7 @@ according to their values. + @@ -8008,23 +9045,26 @@ according to their values. + - + + + - Enum values used to denote the various print errors. - - Unspecified error during a print operation + Enum values used to denote the various print errors. + + Unspecified error during a print operation - - Selected printer cannot be found + + Selected printer cannot be found - - Invalid page range + + Invalid page range @@ -8033,51 +9073,55 @@ according to their values. + - Create a new #WebKitPrintOperation to print @web_view contents. + Create a new #WebKitPrintOperation to print @web_view contents. + - a new #WebKitPrintOperation. + a new #WebKitPrintOperation. - a #WebKitWebView + a #WebKitWebView - - Return the current page setup of @print_operation. It returns %NULL until + + Return the current page setup of @print_operation. It returns %NULL until either webkit_print_operation_set_page_setup() or webkit_print_operation_run_dialog() have been called. + - the current #GtkPageSetup of @print_operation. + the current #GtkPageSetup of @print_operation. - a #WebKitPrintOperation + a #WebKitPrintOperation - - Return the current print settings of @print_operation. It returns %NULL until + + Return the current print settings of @print_operation. It returns %NULL until either webkit_print_operation_set_print_settings() or webkit_print_operation_run_dialog() have been called. + - the current #GtkPrintSettings of @print_operation. + the current #GtkPrintSettings of @print_operation. - a #WebKitPrintOperation + a #WebKitPrintOperation - Start a print operation using current print settings and page setup + Start a print operation using current print settings and page setup without showing the print dialog. If either print settings or page setup are not set with webkit_print_operation_set_print_settings() and webkit_print_operation_set_page_setup(), the default options will be used @@ -8085,18 +9129,19 @@ and the print job will be sent to the default printer. The #WebKitPrintOperation::finished signal is emitted when the printing operation finishes. If an error occurs while printing the signal #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::finished. + - a #WebKitPrintOperation + a #WebKitPrintOperation - Run the print dialog and start printing using the options selected by + Run the print dialog and start printing using the options selected by the user. This method returns when the print dialog is closed. If the print dialog is cancelled %WEBKIT_PRINT_OPERATION_RESPONSE_CANCEL is returned. If the user clicks on the print button, %WEBKIT_PRINT_OPERATION_RESPONSE_PRINT @@ -8108,65 +9153,68 @@ are updated with options selected by the user when Print button is pressed in pr You can get the updated print settings and page setup by calling webkit_print_operation_get_print_settings() and webkit_print_operation_get_page_setup() after this method. + - the #WebKitPrintOperationResponse of the print dialog + the #WebKitPrintOperationResponse of the print dialog - a #WebKitPrintOperation + a #WebKitPrintOperation - transient parent of the print dialog + transient parent of the print dialog - - Set the current page setup of @print_operation. Current page setup is used for the + + Set the current page setup of @print_operation. Current page setup is used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called. + - a #WebKitPrintOperation + a #WebKitPrintOperation - a #GtkPageSetup to set + a #GtkPageSetup to set - - Set the current print settings of @print_operation. Current print settings are used for + + Set the current print settings of @print_operation. Current print settings are used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called. + - a #WebKitPrintOperation + a #WebKitPrintOperation - a #GtkPrintSettings to set + a #GtkPrintSettings to set - - The initial #GtkPageSetup for the print operation. + + The initial #GtkPageSetup for the print operation. - - The initial #GtkPrintSettings for the print operation. + + The initial #GtkPrintSettings for the print operation. - The #WebKitWebView that will be printed. + The #WebKitWebView that will be printed. @@ -8176,17 +9224,17 @@ the initial values of the print dialog when webkit_print_operation_run_dialog() - Emitted when displaying the print dialog with webkit_print_operation_run_dialog(). + Emitted when displaying the print dialog with webkit_print_operation_run_dialog(). The returned #WebKitPrintCustomWidget will be added to the print dialog and it will be owned by the @print_operation. However, the object is guaranteed to be alive until the #WebKitPrintCustomWidget::apply is emitted. - A #WebKitPrintCustomWidget that will be embedded in the dialog. + A #WebKitPrintCustomWidget that will be embedded in the dialog. - Emitted when an error occurs while printing. The given @error, of the domain + Emitted when an error occurs while printing. The given @error, of the domain %WEBKIT_PRINT_ERROR, contains further details of the failure. The #WebKitPrintOperation::finished signal is emitted after this one. @@ -8194,13 +9242,13 @@ The #WebKitPrintOperation::finished signal is emitted after this one. - the #GError that was triggered + the #GError that was triggered - Emitted when the print operation has finished doing everything + Emitted when the print operation has finished doing everything required for printing. @@ -8208,11 +9256,13 @@ required for printing. + + @@ -8220,6 +9270,7 @@ required for printing. + @@ -8227,6 +9278,7 @@ required for printing. + @@ -8234,30 +9286,33 @@ required for printing. + - + + + - Enum values representing the response of the print dialog shown with + Enum values representing the response of the print dialog shown with webkit_print_operation_run_dialog(). - - Print button was clicked in print dialog + + Print button was clicked in print dialog - - Print dialog was cancelled + + Print dialog was cancelled - Enum values used for determining the #WebKitWebContext process model. - - Deprecated 2.26. + Enum values used for determining the #WebKitWebContext process model. + + Deprecated 2.26. - - Use one process + + Use one process for each #WebKitWebView, while still allowing for some of them to share a process in certain situations. The main advantage of this process model is that the rendering process for a web view @@ -8269,76 +9324,83 @@ webkit_print_operation_run_dialog(). + + + - - Return the #WebKitURIRequest associated with the response decision. + + + Return the #WebKitURIRequest associated with the response decision. Modifications to the returned object are <emphasis>not</emphasis> taken into account when the request is sent over the network, and is intended only to aid in evaluating whether a response decision should be taken or not. To modify requests before they are sent over the network the #WebKitPage::send-request signal can be used instead. + - The URI request that is associated with this policy decision. + The URI request that is associated with this policy decision. - a #WebKitResponsePolicyDecision + a #WebKitResponsePolicyDecision - - Gets the value of the #WebKitResponsePolicyDecision:response property. + + Gets the value of the #WebKitResponsePolicyDecision:response property. + - The URI response that is associated with this policy decision. + The URI response that is associated with this policy decision. - a #WebKitResponsePolicyDecision + a #WebKitResponsePolicyDecision - Gets whether the MIME type of the response can be displayed in the #WebKitWebView + Gets whether the MIME type of the response can be displayed in the #WebKitWebView that triggered this policy decision request. See also webkit_web_view_can_show_mime_type(). + - %TRUE if the MIME type of the response is supported or %FALSE otherwise + %TRUE if the MIME type of the response is supported or %FALSE otherwise - a #WebKitResponsePolicyDecision + a #WebKitResponsePolicyDecision - - This property contains the #WebKitURIRequest associated with this + + This property contains the #WebKitURIRequest associated with this policy decision. - - This property contains the #WebKitURIResponse associated with this + + This property contains the #WebKitURIResponse associated with this policy decision. @@ -8350,11 +9412,13 @@ policy decision. + + @@ -8362,6 +9426,7 @@ policy decision. + @@ -8369,6 +9434,7 @@ policy decision. + @@ -8376,413 +9442,444 @@ policy decision. + - + + + + + + + + + - Enum values to specify the different ways in which a #WebKitWebView + Enum values to specify the different ways in which a #WebKitWebView can save its current web page into a self-contained file. - - Save the current page using the MHTML format. + + Save the current page using the MHTML format. + - Close @dialog. When handling a #WebKitScriptDialog asynchronously (webkit_script_dialog_ref() + Close @dialog. When handling a #WebKitScriptDialog asynchronously (webkit_script_dialog_ref() was called in #WebKitWebView::script-dialog callback), this function needs to be called to notify that we are done with the script dialog. The dialog will be closed on destruction if this function hasn't been called before. + - a #WebKitScriptDialog + a #WebKitScriptDialog - This method is used for %WEBKIT_SCRIPT_DIALOG_CONFIRM and %WEBKIT_SCRIPT_DIALOG_BEFORE_UNLOAD_CONFIRM dialogs when + This method is used for %WEBKIT_SCRIPT_DIALOG_CONFIRM and %WEBKIT_SCRIPT_DIALOG_BEFORE_UNLOAD_CONFIRM dialogs when #WebKitWebView::script-dialog signal is emitted to set whether the user confirmed the dialog or not. The default implementation of #WebKitWebView::script-dialog signal sets %TRUE when the OK or Stay buttons are clicked and %FALSE otherwise. It's an error to use this method with a #WebKitScriptDialog that is not of type %WEBKIT_SCRIPT_DIALOG_CONFIRM or %WEBKIT_SCRIPT_DIALOG_BEFORE_UNLOAD_CONFIRM + - a #WebKitScriptDialog + a #WebKitScriptDialog - whether user confirmed the dialog + whether user confirmed the dialog - Get the dialog type of a #WebKitScriptDialog. + Get the dialog type of a #WebKitScriptDialog. + - the #WebKitScriptDialogType of @dialog + the #WebKitScriptDialogType of @dialog - a #WebKitScriptDialog + a #WebKitScriptDialog - Get the message of a #WebKitScriptDialog. + Get the message of a #WebKitScriptDialog. + - the message of @dialog. + the message of @dialog. - a #WebKitScriptDialog + a #WebKitScriptDialog - Get the default text of a #WebKitScriptDialog of type %WEBKIT_SCRIPT_DIALOG_PROMPT. + Get the default text of a #WebKitScriptDialog of type %WEBKIT_SCRIPT_DIALOG_PROMPT. It's an error to use this method with a #WebKitScriptDialog that is not of type %WEBKIT_SCRIPT_DIALOG_PROMPT. + - the default text of @dialog + the default text of @dialog - a #WebKitScriptDialog + a #WebKitScriptDialog - This method is used for %WEBKIT_SCRIPT_DIALOG_PROMPT dialogs when + This method is used for %WEBKIT_SCRIPT_DIALOG_PROMPT dialogs when #WebKitWebView::script-dialog signal is emitted to set the text entered by the user. The default implementation of #WebKitWebView::script-dialog signal sets the text of the entry form when OK button is clicked, otherwise %NULL is set. It's an error to use this method with a #WebKitScriptDialog that is not of type %WEBKIT_SCRIPT_DIALOG_PROMPT. + - a #WebKitScriptDialog + a #WebKitScriptDialog - the text to set + the text to set - Atomically increments the reference count of @dialog by one. This + Atomically increments the reference count of @dialog by one. This function is MT-safe and may be called from any thread. + - The passed in #WebKitScriptDialog + The passed in #WebKitScriptDialog - a #WebKitScriptDialog + a #WebKitScriptDialog - Atomically decrements the reference count of @dialog by one. If the + Atomically decrements the reference count of @dialog by one. If the reference count drops to 0, all memory allocated by the #WebKitScriptdialog is released. This function is MT-safe and may be called from any thread. + - a #WebKitScriptDialog + a #WebKitScriptDialog - Enum values used for determining the type of #WebKitScriptDialog - - Alert script dialog, used to show a + Enum values used for determining the type of #WebKitScriptDialog + + Alert script dialog, used to show a message to the user. - - Confirm script dialog, used to ask + + Confirm script dialog, used to ask confirmation to the user. - - Prompt script dialog, used to ask + + Prompt script dialog, used to ask information to the user. - - Before unload confirm dialog, + + Before unload confirm dialog, used to ask confirmation to leave the current page to the user. Since 2.12 + - Register @scheme as a CORS (Cross-origin resource sharing) enabled scheme. + Register @scheme as a CORS (Cross-origin resource sharing) enabled scheme. This means that CORS requests are allowed. See W3C CORS specification http://www.w3.org/TR/cors/. + - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Register @scheme as a display isolated scheme. This means that pages cannot + Register @scheme as a display isolated scheme. This means that pages cannot display these URIs unless they are from the same scheme. + - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Register @scheme as an empty document scheme. This means that + Register @scheme as an empty document scheme. This means that they are allowed to commit synchronously. + - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Register @scheme as a local scheme. This means that other non-local pages + Register @scheme as a local scheme. This means that other non-local pages cannot link to or access URIs of this scheme. + - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Register @scheme as a no-access scheme. This means that pages loaded + Register @scheme as a no-access scheme. This means that pages loaded with this URI scheme cannot access pages loaded with any other URI scheme. + - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Register @scheme as a secure scheme. This means that mixed + Register @scheme as a secure scheme. This means that mixed content warnings won't be generated for this scheme when included by an HTTPS page. + - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Whether @scheme is considered as a CORS enabled scheme. + Whether @scheme is considered as a CORS enabled scheme. See also webkit_security_manager_register_uri_scheme_as_cors_enabled(). + - %TRUE if @scheme is a CORS enabled scheme or %FALSE otherwise. + %TRUE if @scheme is a CORS enabled scheme or %FALSE otherwise. - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Whether @scheme is considered as a display isolated scheme. + Whether @scheme is considered as a display isolated scheme. See also webkit_security_manager_register_uri_scheme_as_display_isolated(). + - %TRUE if @scheme is a display isolated scheme or %FALSE otherwise. + %TRUE if @scheme is a display isolated scheme or %FALSE otherwise. - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Whether @scheme is considered as an empty document scheme. + Whether @scheme is considered as an empty document scheme. See also webkit_security_manager_register_uri_scheme_as_empty_document(). + - %TRUE if @scheme is an empty document scheme or %FALSE otherwise. + %TRUE if @scheme is an empty document scheme or %FALSE otherwise. - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Whether @scheme is considered as a local scheme. + Whether @scheme is considered as a local scheme. See also webkit_security_manager_register_uri_scheme_as_local(). + - %TRUE if @scheme is a local scheme or %FALSE otherwise. + %TRUE if @scheme is a local scheme or %FALSE otherwise. - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Whether @scheme is considered as a no-access scheme. + Whether @scheme is considered as a no-access scheme. See also webkit_security_manager_register_uri_scheme_as_no_access(). + - %TRUE if @scheme is a no-access scheme or %FALSE otherwise. + %TRUE if @scheme is a no-access scheme or %FALSE otherwise. - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme - Whether @scheme is considered as a secure scheme. + Whether @scheme is considered as a secure scheme. See also webkit_security_manager_register_uri_scheme_as_secure(). + - %TRUE if @scheme is a secure scheme or %FALSE otherwise. + %TRUE if @scheme is a secure scheme or %FALSE otherwise. - a #WebKitSecurityManager + a #WebKitSecurityManager - a URI scheme + a URI scheme @@ -8795,11 +9892,13 @@ See also webkit_security_manager_register_uri_scheme_as_secure(). + + @@ -8807,6 +9906,7 @@ See also webkit_security_manager_register_uri_scheme_as_secure(). + @@ -8814,6 +9914,7 @@ See also webkit_security_manager_register_uri_scheme_as_secure(). + @@ -8821,310 +9922,336 @@ See also webkit_security_manager_register_uri_scheme_as_secure(). + - + + + + - Create a new security origin from the provided protocol, host and + Create a new security origin from the provided protocol, host and port. + - A #WebKitSecurityOrigin. + A #WebKitSecurityOrigin. - The protocol for the new origin + The protocol for the new origin - The host for the new origin + The host for the new origin - The port number for the new origin, or 0 to indicate the + The port number for the new origin, or 0 to indicate the default port for @protocol - Create a new security origin from the provided URI. Components of + Create a new security origin from the provided URI. Components of @uri other than protocol, host, and port do not affect the created #WebKitSecurityOrigin. + - A #WebKitSecurityOrigin. + A #WebKitSecurityOrigin. - The URI for the new origin + The URI for the new origin - Gets the hostname of @origin. It is reasonable for this to be %NULL + Gets the hostname of @origin. It is reasonable for this to be %NULL if its protocol does not require a host component. + - The host of the #WebKitSecurityOrigin + The host of the #WebKitSecurityOrigin - a #WebKitSecurityOrigin + a #WebKitSecurityOrigin - Gets the port of @origin. This function will always return 0 if the + Gets the port of @origin. This function will always return 0 if the port is the default port for the given protocol. For example, http://example.com has the same security origin as http://example.com:80, and this function will return 0 for a #WebKitSecurityOrigin constructed from either URI. + - The port of the #WebKitSecurityOrigin. + The port of the #WebKitSecurityOrigin. - a #WebKitSecurityOrigin + a #WebKitSecurityOrigin - Gets the protocol of @origin. + Gets the protocol of @origin. + - The protocol of the #WebKitSecurityOrigin + The protocol of the #WebKitSecurityOrigin - a #WebKitSecurityOrigin + a #WebKitSecurityOrigin - This function returns %FALSE. #WebKitSecurityOrigin is now a simple + This function returns %FALSE. #WebKitSecurityOrigin is now a simple wrapper around a &lt;protocol, host, port&gt; triplet, and no longer represents an origin as defined by web standards that may be opaque. + - %FALSE + %FALSE - a #WebKitSecurityOrigin + a #WebKitSecurityOrigin - Atomically increments the reference count of @origin by one. + Atomically increments the reference count of @origin by one. This function is MT-safe and may be called from any thread. + - The passed #WebKitSecurityOrigin + The passed #WebKitSecurityOrigin - a #WebKitSecurityOrigin + a #WebKitSecurityOrigin - Gets a string representation of @origin. The string representation + Gets a string representation of @origin. The string representation is a valid URI with only protocol, host, and port components, or %NULL. + - a URI representing @origin. + a URI representing @origin. - a #WebKitSecurityOrigin + a #WebKitSecurityOrigin - Atomically decrements the reference count of @origin by one. + Atomically decrements the reference count of @origin by one. If the reference count drops to 0, all memory allocated by #WebKitSecurityOrigin is released. This function is MT-safe and may be called from any thread. + - A #WebKitSecurityOrigin + A #WebKitSecurityOrigin + - Creates a new #WebKitSettings instance with default values. It must + Creates a new #WebKitSettings instance with default values. It must be manually attached to a #WebKitWebView. See also webkit_settings_new_with_settings(). + - a new #WebKitSettings instance. + a new #WebKitSettings instance. - Creates a new #WebKitSettings instance with the given settings. It must + Creates a new #WebKitSettings instance with the given settings. It must be manually attached to a #WebKitWebView. + - a new #WebKitSettings instance. + a new #WebKitSettings instance. - name of first setting to set + name of first setting to set - value of first setting, followed by more settings, + value of first setting, followed by more settings, %NULL-terminated - Convert @points to the equivalent value in pixels, based on the current + Convert @points to the equivalent value in pixels, based on the current screen DPI. Applications can use this function to convert font size values in points to font size values in pixels when setting the font size properties of #WebKitSettings. + - the equivalent font size in pixels. + the equivalent font size in pixels. - the font size in points to convert to pixels + the font size in points to convert to pixels - Convert @pixels to the equivalent value in points, based on the current + Convert @pixels to the equivalent value in points, based on the current screen DPI. Applications can use this function to convert font size values in pixels to font size values in points when getting the font size properties of #WebKitSettings. + - the equivalent font size in points. + the equivalent font size in points. - the font size in pixels to convert to points + the font size in pixels to convert to points - - Get the #WebKitSettings:allow-file-access-from-file-urls property. + + Get the #WebKitSettings:allow-file-access-from-file-urls property. + - %TRUE If file access from file URLs is allowed or %FALSE otherwise. + %TRUE If file access from file URLs is allowed or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:allow-modal-dialogs property. + + Get the #WebKitSettings:allow-modal-dialogs property. + - %TRUE if it's allowed to create and run modal dialogs or %FALSE otherwise. + %TRUE if it's allowed to create and run modal dialogs or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:allow-top-navigation-to-data-urls property. + + Get the #WebKitSettings:allow-top-navigation-to-data-urls property. + - %TRUE If navigation to data URLs from the top frame is allowed or %FALSE\ + %TRUE If navigation to data URLs from the top frame is allowed or %FALSE\ otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:allow-universal-access-from-file-urls property. + + Get the #WebKitSettings:allow-universal-access-from-file-urls property. + - %TRUE If universal access from file URLs is allowed or %FALSE otherwise. + %TRUE If universal access from file URLs is allowed or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:auto-load-images property. + + Get the #WebKitSettings:auto-load-images property. + - %TRUE If auto loading of images is enabled or %FALSE otherwise. + %TRUE If auto loading of images is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:cursive-font-family property. + + Gets the #WebKitSettings:cursive-font-family property. + - The default font family used to display content marked with cursive font. + The default font family used to display content marked with cursive font. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:default-charset property. + + Gets the #WebKitSettings:default-charset property. + - Default charset. + Default charset. - a #WebKitSettings + a #WebKitSettings - + + @@ -9134,1651 +10261,1762 @@ otherwise. - - Gets the #WebKitSettings:default-font-size property. + + Gets the #WebKitSettings:default-font-size property. + - The default font size, in pixels. + The default font size, in pixels. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:default-monospace-font-size property. + + Gets the #WebKitSettings:default-monospace-font-size property. + - Default monospace font size, in pixels. + Default monospace font size, in pixels. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:draw-compositing-indicators property. + + Get the #WebKitSettings:draw-compositing-indicators property. + - %TRUE If compositing borders are drawn or %FALSE otherwise. + %TRUE If compositing borders are drawn or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-accelerated-2d-canvas property. + + Get the #WebKitSettings:enable-accelerated-2d-canvas property. + - %TRUE if accelerated 2D canvas is enabled or %FALSE otherwise. + %TRUE if accelerated 2D canvas is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-back-forward-navigation-gestures property. + + Get the #WebKitSettings:enable-back-forward-navigation-gestures property. + - %TRUE if horizontal swipe gesture will trigger back-forward navigaiton or %FALSE otherwise. + %TRUE if horizontal swipe gesture will trigger back-forward navigaiton or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-caret-browsing property. + + Get the #WebKitSettings:enable-caret-browsing property. + - %TRUE If caret browsing is enabled or %FALSE otherwise. + %TRUE If caret browsing is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-developer-extras property. + + Get the #WebKitSettings:enable-developer-extras property. + - %TRUE If developer extras is enabled or %FALSE otherwise. + %TRUE If developer extras is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-dns-prefetching property. + + Get the #WebKitSettings:enable-dns-prefetching property. + - %TRUE If DNS prefetching is enabled or %FALSE otherwise. + %TRUE If DNS prefetching is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-encrypted-media property. + + Get the #WebKitSettings:enable-encrypted-media property. + - %TRUE if EncryptedMedia support is enabled or %FALSE otherwise. + %TRUE if EncryptedMedia support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-frame-flattening property. + + Get the #WebKitSettings:enable-frame-flattening property. + - %TRUE If frame flattening is enabled or %FALSE otherwise. + %TRUE If frame flattening is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-fullscreen property. + + Get the #WebKitSettings:enable-fullscreen property. + - %TRUE If fullscreen support is enabled or %FALSE otherwise. + %TRUE If fullscreen support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-html5-database property. + + Get the #WebKitSettings:enable-html5-database property. + - %TRUE if IndexedDB support is enabled or %FALSE otherwise. + %TRUE if IndexedDB support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-html5-local-storage property. + + Get the #WebKitSettings:enable-html5-local-storage property. + - %TRUE If HTML5 local storage support is enabled or %FALSE otherwise. + %TRUE If HTML5 local storage support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-hyperlink-auditing property. + + Get the #WebKitSettings:enable-hyperlink-auditing property. + - %TRUE If hyper link auditing is enabled or %FALSE otherwise. + %TRUE If hyper link auditing is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-java property. + + Get the #WebKitSettings:enable-java property. + - %TRUE If Java is enabled or %FALSE otherwise. + %TRUE If Java is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-javascript property. + + Get the #WebKitSettings:enable-javascript property. + - %TRUE If JavaScript is enabled or %FALSE otherwise. + %TRUE If JavaScript is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-javascript-markup property. + + Get the #WebKitSettings:enable-javascript-markup property. + - %TRUE if JavaScript markup is enabled or %FALSE otherwise. + %TRUE if JavaScript markup is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-media property. + + Get the #WebKitSettings:enable-media property. + - %TRUE if media support is enabled or %FALSE otherwise. + %TRUE if media support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-media-capabilities property. + + Get the #WebKitSettings:enable-media-capabilities property. + - %TRUE if MediaCapabilities support is enabled or %FALSE otherwise. + %TRUE if MediaCapabilities support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-media-stream property. + + Get the #WebKitSettings:enable-media-stream property. + - %TRUE If mediastream support is enabled or %FALSE otherwise. + %TRUE If mediastream support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-mediasource property. + + Get the #WebKitSettings:enable-mediasource property. + - %TRUE If MediaSource support is enabled or %FALSE otherwise. + %TRUE If MediaSource support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-mock-capture-devices property. + + Get the #WebKitSettings:enable-mock-capture-devices property. + - %TRUE If mock capture devices is enabled or %FALSE otherwise. + %TRUE If mock capture devices is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-offline-web-application-cache property. + + Get the #WebKitSettings:enable-offline-web-application-cache property. + - %TRUE If HTML5 offline web application cache support is enabled or %FALSE otherwise. + %TRUE If HTML5 offline web application cache support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-page-cache property. + + Get the #WebKitSettings:enable-page-cache property. + - %TRUE if page cache enabled or %FALSE otherwise. + %TRUE if page cache enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-plugins property. + + Get the #WebKitSettings:enable-plugins property. + - %TRUE If plugins are enabled or %FALSE otherwise. + %TRUE If plugins are enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-private-browsing property. + + Get the #WebKitSettings:enable-private-browsing property. Use #WebKitWebView:is-ephemeral or #WebKitWebContext:is-ephemeral instead. + - %TRUE If private browsing is enabled or %FALSE otherwise. + %TRUE If private browsing is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-resizable-text-areas property. + + Get the #WebKitSettings:enable-resizable-text-areas property. + - %TRUE If text areas can be resized or %FALSE otherwise. + %TRUE If text areas can be resized or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-site-specific-quirks property. + + Get the #WebKitSettings:enable-site-specific-quirks property. + - %TRUE if site specific quirks are enabled or %FALSE otherwise. + %TRUE if site specific quirks are enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-smooth-scrolling property. + + Get the #WebKitSettings:enable-smooth-scrolling property. + - %TRUE if smooth scrolling is enabled or %FALSE otherwise. + %TRUE if smooth scrolling is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-spatial-navigation property. + + Get the #WebKitSettings:enable-spatial-navigation property. + - %TRUE If HTML5 spatial navigation support is enabled or %FALSE otherwise. + %TRUE If HTML5 spatial navigation support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-tabs-to-links property. + + Get the #WebKitSettings:enable-tabs-to-links property. + - %TRUE If tabs to link is enabled or %FALSE otherwise. + %TRUE If tabs to link is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-webaudio property. + + Get the #WebKitSettings:enable-webaudio property. + - %TRUE If webaudio support is enabled or %FALSE otherwise. + %TRUE If webaudio support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-webgl property. + + Get the #WebKitSettings:enable-webgl property. + - %TRUE If WebGL support is enabled or %FALSE otherwise. + %TRUE If WebGL support is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-write-console-messages-to-stdout property. + + Get the #WebKitSettings:enable-write-console-messages-to-stdout property. + - %TRUE if writing console messages to stdout is enabled or %FALSE + %TRUE if writing console messages to stdout is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:enable-xss-auditor property. + + Get the #WebKitSettings:enable-xss-auditor property. + - %TRUE If XSS auditing is enabled or %FALSE otherwise. + %TRUE If XSS auditing is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:fantasy-font-family property. + + Gets the #WebKitSettings:fantasy-font-family property. + - The default font family used to display content marked with fantasy font. + The default font family used to display content marked with fantasy font. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:hardware-acceleration-policy property. + + Get the #WebKitSettings:hardware-acceleration-policy property. + - a #WebKitHardwareAccelerationPolicy + a #WebKitHardwareAccelerationPolicy - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:javascript-can-access-clipboard property. + + Get the #WebKitSettings:javascript-can-access-clipboard property. + - %TRUE If javascript-can-access-clipboard is enabled or %FALSE otherwise. + %TRUE If javascript-can-access-clipboard is enabled or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:javascript-can-open-windows-automatically property. + + Get the #WebKitSettings:javascript-can-open-windows-automatically property. + - %TRUE If JavaScript can open window automatically or %FALSE otherwise. + %TRUE If JavaScript can open window automatically or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:load-icons-ignoring-image-load-setting property. + + Get the #WebKitSettings:load-icons-ignoring-image-load-setting property. + - %TRUE If site icon can be loaded irrespective of image loading preference or %FALSE otherwise. + %TRUE If site icon can be loaded irrespective of image loading preference or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:media-content-types-requiring-hardware-support property. + + Gets the #WebKitSettings:media-content-types-requiring-hardware-support property. + - Media content types requiring hardware support, or %NULL. + Media content types requiring hardware support, or %NULL. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:media-playback-allows-inline property. + + Get the #WebKitSettings:media-playback-allows-inline property. + - %TRUE If inline playback is allowed for media + %TRUE If inline playback is allowed for media or %FALSE if only fullscreen playback is allowed. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:media-playback-requires-user-gesture property. + + Get the #WebKitSettings:media-playback-requires-user-gesture property. + - %TRUE If an user gesture is needed to play or load media + %TRUE If an user gesture is needed to play or load media or %FALSE if no user gesture is needed. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:minimum-font-size property. + + Gets the #WebKitSettings:minimum-font-size property. + - Minimum font size, in pixels. + Minimum font size, in pixels. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:monospace-font-family property. + + Gets the #WebKitSettings:monospace-font-family property. + - Default font family used to display content marked with monospace font. + Default font family used to display content marked with monospace font. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:pictograph-font-family property. + + Gets the #WebKitSettings:pictograph-font-family property. + - The default font family used to display content marked with pictograph font. + The default font family used to display content marked with pictograph font. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:print-backgrounds property. + + Get the #WebKitSettings:print-backgrounds property. + - %TRUE If background images should be printed or %FALSE otherwise. + %TRUE If background images should be printed or %FALSE otherwise. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:sans-serif-font-family property. + + Gets the #WebKitSettings:sans-serif-font-family property. + - The default font family used to display content marked with sans-serif font. + The default font family used to display content marked with sans-serif font. - a #WebKitSettings + a #WebKitSettings - - Gets the #WebKitSettings:serif-font-family property. + + Gets the #WebKitSettings:serif-font-family property. + - The default font family used to display content marked with serif font. + The default font family used to display content marked with serif font. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:user-agent property. + + Get the #WebKitSettings:user-agent property. + - The current value of the user-agent property. + The current value of the user-agent property. - a #WebKitSettings + a #WebKitSettings - - Get the #WebKitSettings:zoom-text-only property. + + Get the #WebKitSettings:zoom-text-only property. + - %TRUE If zoom level of the view should only affect the text + %TRUE If zoom level of the view should only affect the text or %FALSE if all view contents should be scaled. - a #WebKitSettings + a #WebKitSettings - - Set the #WebKitSettings:allow-file-access-from-file-urls property. + + Set the #WebKitSettings:allow-file-access-from-file-urls property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:allow-modal-dialogs property. + + Set the #WebKitSettings:allow-modal-dialogs property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:allow-top-navigation-to-data-urls property. + + Set the #WebKitSettings:allow-top-navigation-to-data-urls property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:allow-universal-access-from-file-urls property. + + Set the #WebKitSettings:allow-universal-access-from-file-urls property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:auto-load-images property. + + Set the #WebKitSettings:auto-load-images property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:cursive-font-family property. + + Set the #WebKitSettings:cursive-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default cursive font family + the new default cursive font family - - Set the #WebKitSettings:default-charset property. + + Set the #WebKitSettings:default-charset property. + - a #WebKitSettings + a #WebKitSettings - default charset to be set + default charset to be set - - Set the #WebKitSettings:default-font-family property. + + Set the #WebKitSettings:default-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default font family + the new default font family - - Set the #WebKitSettings:default-font-size property. + + Set the #WebKitSettings:default-font-size property. + - a #WebKitSettings + a #WebKitSettings - default font size to be set in pixels + default font size to be set in pixels - - Set the #WebKitSettings:default-monospace-font-size property. + + Set the #WebKitSettings:default-monospace-font-size property. + - a #WebKitSettings + a #WebKitSettings - default monospace font size to be set in pixels + default monospace font size to be set in pixels - - Set the #WebKitSettings:draw-compositing-indicators property. + + Set the #WebKitSettings:draw-compositing-indicators property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-accelerated-2d-canvas property. + + Set the #WebKitSettings:enable-accelerated-2d-canvas property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-back-forward-navigation-gestures property. + + Set the #WebKitSettings:enable-back-forward-navigation-gestures property. + - a #WebKitSettings + a #WebKitSettings - value to be set + value to be set - - Set the #WebKitSettings:enable-caret-browsing property. + + Set the #WebKitSettings:enable-caret-browsing property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-developer-extras property. + + Set the #WebKitSettings:enable-developer-extras property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-dns-prefetching property. + + Set the #WebKitSettings:enable-dns-prefetching property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-encrypted-media property. + + Set the #WebKitSettings:enable-encrypted-media property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-frame-flattening property. + + Set the #WebKitSettings:enable-frame-flattening property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-fullscreen property. + + Set the #WebKitSettings:enable-fullscreen property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-html5-database property. + + Set the #WebKitSettings:enable-html5-database property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-html5-local-storage property. + + Set the #WebKitSettings:enable-html5-local-storage property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-hyperlink-auditing property. + + Set the #WebKitSettings:enable-hyperlink-auditing property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-java property. + + Set the #WebKitSettings:enable-java property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-javascript property. + + Set the #WebKitSettings:enable-javascript property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-javascript-markup property. + + Set the #WebKitSettings:enable-javascript-markup property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-media property. + + Set the #WebKitSettings:enable-media property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-media-capabilities property. + + Set the #WebKitSettings:enable-media-capabilities property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-media-stream property. + + Set the #WebKitSettings:enable-media-stream property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-mediasource property. + + Set the #WebKitSettings:enable-mediasource property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-mock-capture-devices property. + + Set the #WebKitSettings:enable-mock-capture-devices property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-offline-web-application-cache property. + + Set the #WebKitSettings:enable-offline-web-application-cache property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-page-cache property. + + Set the #WebKitSettings:enable-page-cache property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-plugins property. + + Set the #WebKitSettings:enable-plugins property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-private-browsing property. + + Set the #WebKitSettings:enable-private-browsing property. Use #WebKitWebView:is-ephemeral or #WebKitWebContext:is-ephemeral instead. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-resizable-text-areas property. + + Set the #WebKitSettings:enable-resizable-text-areas property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-site-specific-quirks property. + + Set the #WebKitSettings:enable-site-specific-quirks property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-smooth-scrolling property. + + Set the #WebKitSettings:enable-smooth-scrolling property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-spatial-navigation property. + + Set the #WebKitSettings:enable-spatial-navigation property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-tabs-to-links property. + + Set the #WebKitSettings:enable-tabs-to-links property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-webaudio property. + + Set the #WebKitSettings:enable-webaudio property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-webgl property. + + Set the #WebKitSettings:enable-webgl property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-write-console-messages-to-stdout property. + + Set the #WebKitSettings:enable-write-console-messages-to-stdout property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:enable-xss-auditor property. + + Set the #WebKitSettings:enable-xss-auditor property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:fantasy-font-family property. + + Set the #WebKitSettings:fantasy-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default fantasy font family + the new default fantasy font family - - Set the #WebKitSettings:hardware-acceleration-policy property. + + Set the #WebKitSettings:hardware-acceleration-policy property. + - a #WebKitSettings + a #WebKitSettings - a #WebKitHardwareAccelerationPolicy + a #WebKitHardwareAccelerationPolicy - - Set the #WebKitSettings:javascript-can-access-clipboard property. + + Set the #WebKitSettings:javascript-can-access-clipboard property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:javascript-can-open-windows-automatically property. + + Set the #WebKitSettings:javascript-can-open-windows-automatically property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:load-icons-ignoring-image-load-setting property. + + Set the #WebKitSettings:load-icons-ignoring-image-load-setting property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:media-content-types-requiring-hardware-support property. + + Set the #WebKitSettings:media-content-types-requiring-hardware-support property. + - a #WebKitSettings + a #WebKitSettings - list of media content types requiring hardware support split by semicolons (:) or %NULL to use the default value. + list of media content types requiring hardware support split by semicolons (:) or %NULL to use the default value. - - Set the #WebKitSettings:media-playback-allows-inline property. + + Set the #WebKitSettings:media-playback-allows-inline property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:media-playback-requires-user-gesture property. + + Set the #WebKitSettings:media-playback-requires-user-gesture property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:minimum-font-size property. + + Set the #WebKitSettings:minimum-font-size property. + - a #WebKitSettings + a #WebKitSettings - minimum font size to be set in pixels + minimum font size to be set in pixels - - Set the #WebKitSettings:monospace-font-family property. + + Set the #WebKitSettings:monospace-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default monospace font family + the new default monospace font family - - Set the #WebKitSettings:pictograph-font-family property. + + Set the #WebKitSettings:pictograph-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default pictograph font family + the new default pictograph font family - - Set the #WebKitSettings:print-backgrounds property. + + Set the #WebKitSettings:print-backgrounds property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Set the #WebKitSettings:sans-serif-font-family property. + + Set the #WebKitSettings:sans-serif-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default sans-serif font family + the new default sans-serif font family - - Set the #WebKitSettings:serif-font-family property. + + Set the #WebKitSettings:serif-font-family property. + - a #WebKitSettings + a #WebKitSettings - the new default serif font family + the new default serif font family - - Set the #WebKitSettings:user-agent property. + + Set the #WebKitSettings:user-agent property. + - a #WebKitSettings + a #WebKitSettings - The new custom user agent string or %NULL to use the default user agent + The new custom user agent string or %NULL to use the default user agent - Set the #WebKitSettings:user-agent property by appending the application details to the default user + Set the #WebKitSettings:user-agent property by appending the application details to the default user agent. If no application name or version is given, the default user agent used will be used. If only the version is given, the default engine version is used with the given application name. + - a #WebKitSettings + a #WebKitSettings - The application name used for the user agent or %NULL to use the default user agent. + The application name used for the user agent or %NULL to use the default user agent. - The application version for the user agent or %NULL to user the default version. + The application version for the user agent or %NULL to user the default version. - - Set the #WebKitSettings:zoom-text-only property. + + Set the #WebKitSettings:zoom-text-only property. + - a #WebKitSettings + a #WebKitSettings - Value to be set + Value to be set - - Whether file access is allowed from file URLs. By default, when + + Whether file access is allowed from file URLs. By default, when something is loaded in a #WebKitWebView using a file URI, cross origin requests to other file resources are not allowed. This setting allows you to change that behaviour, so that it would be possible to do a XMLHttpRequest of a local file, for example. - - Determine whether it's allowed to create and run modal dialogs + + Determine whether it's allowed to create and run modal dialogs from a #WebKitWebView through JavaScript with <function>window.showModalDialog</function>. If it's set to %FALSE, the associated #WebKitWebView won't be able to create @@ -10786,15 +12024,15 @@ new modal dialogs, so not even the #WebKitWebView::create signal will be emitted. - - Whether or not the top frame is allowed to navigate to data URLs. It is disabled by default + + Whether or not the top frame is allowed to navigate to data URLs. It is disabled by default due to the risk it poses when loading untrusted URLs, with data URLs being used in scamming and phishing attacks. In contrast, a scenario where it could be enabled could be an app that embeds a WebView and you have control of the pages being show instead of a generic browser. - - Whether or not JavaScript running in the context of a file scheme URL + + Whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from any origin. By default, when something is loaded in a #WebKitWebView using a file scheme URL, access to the local file system and arbitrary local storage is not @@ -10802,66 +12040,66 @@ allowed. This setting allows you to change that behaviour, so that it would be possible to use local storage, for example. - - Determines whether images should be automatically loaded or not. + + Determines whether images should be automatically loaded or not. On devices where network bandwidth is of concern, it might be useful to turn this property off. - - The font family used as the default for content using a cursive font. + + The font family used as the default for content using a cursive font. - - The default text charset used when interpreting content with an unspecified charset. + + The default text charset used when interpreting content with an unspecified charset. - - The font family to use as the default for content that does not specify a font. + + The font family to use as the default for content that does not specify a font. - - The default font size in pixels to use for content displayed if + + The default font size in pixels to use for content displayed if no font size is specified. - - The default font size in pixels to use for content displayed in + + The default font size in pixels to use for content displayed in monospace font if no font size is specified. - - Whether to draw compositing borders and repaint counters on layers drawn + + Whether to draw compositing borders and repaint counters on layers drawn with accelerated compositing. This is useful for debugging issues related to web content that is composited with the GPU. - - Enable or disable accelerated 2D canvas. Accelerated 2D canvas is only available + + Enable or disable accelerated 2D canvas. Accelerated 2D canvas is only available if WebKit was compiled with a version of Cairo including the unstable CairoGL API. When accelerated 2D canvas is enabled, WebKit may render some 2D canvas content using hardware accelerated drawing operations. - - Enable or disable horizontal swipe gesture for back-forward navigation. + + Enable or disable horizontal swipe gesture for back-forward navigation. - - Whether to enable accessibility enhanced keyboard navigation. + + Whether to enable accessibility enhanced keyboard navigation. - - Determines whether or not developer tools, such as the Web Inspector, are enabled. + + Determines whether or not developer tools, such as the Web Inspector, are enabled. - - Determines whether or not to prefetch domain names. DNS prefetching attempts + + Determines whether or not to prefetch domain names. DNS prefetching attempts to resolve domain names before a user tries to follow a link. - - Enable or disable support for Encrypted Media API on pages. + + Enable or disable support for Encrypted Media API on pages. EncryptedMedia is an experimental JavaScript API for playing encrypted media in HTML. This property will only work as intended if the EncryptedMedia feature is enabled at build time with the ENABLE_ENCRYPTED_MEDIA flag. @@ -10869,60 +12107,60 @@ with the ENABLE_ENCRYPTED_MEDIA flag. See https://www.w3.org/TR/encrypted-media/ - - Whether to enable the frame flattening. With this setting each subframe is expanded + + Whether to enable the frame flattening. With this setting each subframe is expanded to its contents, which will flatten all the frames to become one scrollable page. On touch devices scrollable subframes on a page can result in a confusing user experience. - - Whether to enable the Javascript Fullscreen API. The API + + Whether to enable the Javascript Fullscreen API. The API allows any HTML element to request fullscreen display. See also the current draft of the spec: http://www.w3.org/TR/fullscreen/ - - Whether to enable HTML5 client-side SQL database support (IndexedDB). + + Whether to enable HTML5 client-side SQL database support (IndexedDB). - - Whether to enable HTML5 local storage support. Local storage provides + + Whether to enable HTML5 local storage support. Local storage provides simple synchronous storage access. HTML5 local storage specification is available at http://dev.w3.org/html5/webstorage/. - - Determines whether or not hyperlink auditing is enabled. + + Determines whether or not hyperlink auditing is enabled. The hyperlink auditing specification is available at http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#hyperlink-auditing. - - Determines whether or not Java is enabled on the page. + + Determines whether or not Java is enabled on the page. - - Determines whether or not JavaScript executes within a page. + + Determines whether or not JavaScript executes within a page. - - Determines whether or not JavaScript markup is allowed in document. When this setting is disabled, + + Determines whether or not JavaScript markup is allowed in document. When this setting is disabled, all JavaScript-related elements and attributes are removed from the document during parsing. Note that executing JavaScript is still allowed if #WebKitSettings:enable-javascript is %TRUE. - - Enable or disable support for media playback on pages. This setting is enabled by + + Enable or disable support for media playback on pages. This setting is enabled by default. Disabling it means `<audio>`, `<track>` and `<video>` elements will have playback support disabled. - - Enable or disable support for MediaCapabilities on pages. This + + Enable or disable support for MediaCapabilities on pages. This specification intends to provide APIs to allow websites to make an optimal decision when picking media content for the user. The APIs will expose information about the decoding and encoding capabilities for a given format @@ -10932,30 +12170,30 @@ display. See also https://wicg.github.io/media-capabilities/ - - Enable or disable support for MediaStream on pages. MediaStream + + Enable or disable support for MediaStream on pages. MediaStream is an experimental proposal for allowing web pages to access audio and video devices for capture. See also http://dev.w3.org/2011/webrtc/editor/getusermedia.html - - Enable or disable support for MediaSource on pages. MediaSource + + Enable or disable support for MediaSource on pages. MediaSource extends HTMLMediaElement to allow JavaScript to generate media streams for playback. See also http://www.w3.org/TR/media-source/ - - Enable or disable the Mock Capture Devices. Those are fake + + Enable or disable the Mock Capture Devices. Those are fake Microphone and Camera devices to be used as MediaStream sources. - - Whether to enable HTML5 offline web application cache support. Offline + + Whether to enable HTML5 offline web application cache support. Offline web application cache allows web applications to run even when the user is not connected to the network. @@ -10963,8 +12201,8 @@ HTML5 offline web application specification is available at http://dev.w3.org/html5/spec/offline.html. - - Enable or disable the page cache. Disabling the page cache is + + Enable or disable the page cache. Disabling the page cache is generally only useful for special circumstances like low-memory scenarios or special purpose applications like static HTML viewers. This setting only controls the Page Cache, this cache @@ -10975,22 +12213,22 @@ of caches and their purposes see: http://webkit.org/blog/427/webkit-page-cache-i-the-basics/ - - Determines whether or not plugins on the page are enabled. + + Determines whether or not plugins on the page are enabled. - - Determines whether or not private browsing is enabled. Private browsing + + Determines whether or not private browsing is enabled. Private browsing will disable history, cache and form auto-fill for any pages visited. Use #WebKitWebView:is-ephemeral or #WebKitWebsiteDataManager:is-ephemeral instead. - - Determines whether or not text areas can be resized. + + Determines whether or not text areas can be resized. - - Whether to turn on site-specific quirks. Turning this on will + + Whether to turn on site-specific quirks. Turning this on will tell WebKit to use some site-specific workarounds for better web compatibility. For example, older versions of MediaWiki will incorrectly send to WebKit a CSS file with KHTML @@ -10998,12 +12236,12 @@ workarounds. By turning on site-specific quirks, WebKit will special-case this and other cases to make some specific sites work. - - Enable or disable smooth scrolling. + + Enable or disable smooth scrolling. - - Whether to enable Spatial Navigation. This feature consists in the ability + + Whether to enable Spatial Navigation. This feature consists in the ability to navigate between focusable elements in a Web page, such as hyperlinks and form controls, by using Left, Right, Up and Down arrow keys. For example, if an user presses the Right key, heuristics determine whether @@ -11011,41 +12249,41 @@ there is an element they might be trying to reach towards the right, and if there are multiple elements, which element they probably wants. - - Determines whether the tab key cycles through the elements on the page. + + Determines whether the tab key cycles through the elements on the page. When this setting is enabled, users will be able to focus the next element in the page by pressing the tab key. If the selected element is editable, then pressing tab key will insert the tab character. - - Enable or disable support for WebAudio on pages. WebAudio is an + + Enable or disable support for WebAudio on pages. WebAudio is an API for processing and synthesizing audio in web applications See also https://webaudio.github.io/web-audio-api - - Enable or disable support for WebGL on pages. WebGL enables web + + Enable or disable support for WebGL on pages. WebGL enables web content to use an API based on OpenGL ES 2.0. - - Enable or disable writing console messages to stdout. These are messages + + Enable or disable writing console messages to stdout. These are messages sent to the console with console.log and related methods. - - Whether to enable the XSS auditor. This feature filters some kinds of + + Whether to enable the XSS auditor. This feature filters some kinds of reflective XSS attacks on vulnerable web sites. - - The font family used as the default for content using a fantasy font. + + The font family used as the default for content using a fantasy font. - - The #WebKitHardwareAccelerationPolicy to decide how to enable and disable + + The #WebKitHardwareAccelerationPolicy to decide how to enable and disable hardware acceleration. The default value %WEBKIT_HARDWARE_ACCELERATION_POLICY_ON_DEMAND enables the hardware acceleration when the web contents request it. It's possible to enforce hardware acceleration to be always enabled @@ -11058,68 +12296,68 @@ supported by the hardware or the system. In that case you can get the value to k actual policy being used, but changing the setting will not have any effect. - - Whether JavaScript can access the clipboard. The default value is %FALSE. If + + Whether JavaScript can access the clipboard. The default value is %FALSE. If set to %TRUE, document.execCommand() allows cut, copy and paste commands. - - Whether JavaScript can open popup windows automatically without user + + Whether JavaScript can open popup windows automatically without user intervention. - - Determines whether a site can load favicons irrespective + + Determines whether a site can load favicons irrespective of the value of #WebKitSettings:auto-load-images. - - List of media content types requiring hardware support, split by semicolons (:). + + List of media content types requiring hardware support, split by semicolons (:). For example: 'video/webm; codecs="vp*":video/mp4; codecs="avc*":video/&ast; codecs="av1*"'. - - Whether media playback is full-screen only or inline playback is allowed. + + Whether media playback is full-screen only or inline playback is allowed. This is %TRUE by default, so media playback can be inline. Setting it to %FALSE allows specifying that media playback should be always fullscreen. - - Whether a user gesture (such as clicking the play button) + + Whether a user gesture (such as clicking the play button) would be required to start media playback or load media. This is off by default, so media playback could start automatically. Setting it on requires a gesture by the user to start playback, or to load the media. - - The minimum font size in pixels used to display text. This setting + + The minimum font size in pixels used to display text. This setting controls the absolute smallest size. Values other than 0 can potentially break page layouts. - - The font family used as the default for content using a monospace font. + + The font family used as the default for content using a monospace font. - - The font family used as the default for content using a pictograph font. + + The font family used as the default for content using a pictograph font. - - Whether background images should be drawn during printing. + + Whether background images should be drawn during printing. - - The font family used as the default for content using a sans-serif font. + + The font family used as the default for content using a sans-serif font. - - The font family used as the default for content using a serif font. + + The font family used as the default for content using a serif font. - - The user-agent string used by WebKit. Unusual user-agent strings may cause web + + The user-agent string used by WebKit. Unusual user-agent strings may cause web content to render incorrectly or fail to run, as many web pages are written to parse the user-agent strings of only the most popular browsers. Therefore, it's typically better to not completely override the standard user-agent, but to use @@ -11129,8 +12367,8 @@ If this property is set to the empty string or %NULL, it will revert to the stan user-agent. - - Whether #WebKitWebView:zoom-level affects only the + + Whether #WebKitWebView:zoom-level affects only the text of the page or all the contents. Other contents containing text like form controls will be also affected by zoom factor when this property is enabled. @@ -11144,11 +12382,13 @@ this property is enabled. + + @@ -11156,6 +12396,7 @@ this property is enabled. + @@ -11163,6 +12404,7 @@ this property is enabled. + @@ -11170,17 +12412,20 @@ this property is enabled. + - + + + - Enum values used to denote errors happening when creating snapshots of #WebKitWebView - - An error occurred when creating a webpage snapshot. + Enum values used to denote errors happening when creating snapshots of #WebKitWebView + + An error occurred when creating a webpage snapshot. @@ -11189,115 +12434,121 @@ this property is enabled. - Enum values used to specify options when taking a snapshot + Enum values used to specify options when taking a snapshot from a #WebKitWebView. - - Do not include any special options. + + Do not include any special options. - - Whether to include in the + + Whether to include in the snapshot the highlight of the selected content. - - Do not fill the background with white before + + Do not fill the background with white before rendering the snapshot. Since 2.8 - Enum values used to specify the region from which to get a #WebKitWebView + Enum values used to specify the region from which to get a #WebKitWebView snapshot - - Specifies a snapshot only for the area that is + + Specifies a snapshot only for the area that is visible in the webview - - A snapshot of the entire document. + + A snapshot of the entire document. - Enum values used to denote the TLS errors policy. - - Ignore TLS errors. + Enum values used to denote the TLS errors policy. + + Ignore TLS errors. - - TLS errors will emit + + TLS errors will emit #WebKitWebView::load-failed-with-tls-errors and, if the signal is handled, finish the load. In case the signal is not handled, #WebKitWebView::load-failed is emitted before the load finishes. + - Creates a new #WebKitURIRequest for the given URI. + Creates a new #WebKitURIRequest for the given URI. + - a new #WebKitURIRequest + a new #WebKitURIRequest - an URI + an URI - Get the HTTP headers of a #WebKitURIRequest as a #SoupMessageHeaders. + Get the HTTP headers of a #WebKitURIRequest as a #SoupMessageHeaders. + - a #SoupMessageHeaders with the HTTP headers of @request + a #SoupMessageHeaders with the HTTP headers of @request or %NULL if @request is not an HTTP request. - a #WebKitURIRequest + a #WebKitURIRequest - Get the HTTP method of the #WebKitURIRequest. + Get the HTTP method of the #WebKitURIRequest. + - the HTTP method of the #WebKitURIRequest or %NULL if @request is not + the HTTP method of the #WebKitURIRequest or %NULL if @request is not an HTTP request. - a #WebKitURIRequest + a #WebKitURIRequest - + + - the uri of the #WebKitURIRequest + the uri of the #WebKitURIRequest - a #WebKitURIRequest + a #WebKitURIRequest - - Set the URI of @request + + Set the URI of @request + - a #WebKitURIRequest + a #WebKitURIRequest - an URI + an URI - - The URI to which the request will be made. + + The URI to which the request will be made. @@ -11308,11 +12559,13 @@ visible in the webview + + @@ -11320,6 +12573,7 @@ visible in the webview + @@ -11327,6 +12581,7 @@ visible in the webview + @@ -11334,120 +12589,130 @@ visible in the webview + - + + + - - Get the expected content length of the #WebKitURIResponse. It can + + + Get the expected content length of the #WebKitURIResponse. It can be 0 if the server provided an incorrect or missing Content-Length. + - the expected content length of @response. + the expected content length of @response. - a #WebKitURIResponse + a #WebKitURIResponse - - Get the HTTP headers of a #WebKitURIResponse as a #SoupMessageHeaders. + + Get the HTTP headers of a #WebKitURIResponse as a #SoupMessageHeaders. + - a #SoupMessageHeaders with the HTTP headers of @response + a #SoupMessageHeaders with the HTTP headers of @response or %NULL if @response is not an HTTP response. - a #WebKitURIResponse + a #WebKitURIResponse - + + - the MIME type of the #WebKitURIResponse + the MIME type of the #WebKitURIResponse - a #WebKitURIResponse + a #WebKitURIResponse - - Get the status code of the #WebKitURIResponse as returned by + + Get the status code of the #WebKitURIResponse as returned by the server. It will normally be a #SoupKnownStatusCode, for example %SOUP_STATUS_OK, though the server can respond with any unsigned integer. + - the status code of @response + the status code of @response - a #WebKitURIResponse + a #WebKitURIResponse - - Get the suggested filename for @response, as specified by + + Get the suggested filename for @response, as specified by the 'Content-Disposition' HTTP header, or %NULL if it's not present. + - the suggested filename or %NULL if + the suggested filename or %NULL if the 'Content-Disposition' HTTP header is not present. - a #WebKitURIResponse + a #WebKitURIResponse - + + - the uri of the #WebKitURIResponse + the uri of the #WebKitURIResponse - a #WebKitURIResponse + a #WebKitURIResponse - - The expected content length of the response. + + The expected content length of the response. - - The HTTP headers of the response, or %NULL if the response is not an HTTP response. + + The HTTP headers of the response, or %NULL if the response is not an HTTP response. - - The MIME type of the response. + + The MIME type of the response. - - The status code of the response as returned by the server. + + The status code of the response as returned by the server. - - The suggested filename for the URI response. + + The suggested filename for the URI response. - - The URI for which the response was made. + + The URI for which the response was made. @@ -11458,11 +12723,13 @@ present. + + @@ -11470,6 +12737,7 @@ present. + @@ -11477,6 +12745,7 @@ present. + @@ -11484,102 +12753,112 @@ present. + - + + + + - Finish a #WebKitURISchemeRequest by setting the contents of the request and its mime type. + Finish a #WebKitURISchemeRequest by setting the contents of the request and its mime type. + - a #WebKitURISchemeRequest + a #WebKitURISchemeRequest - a #GInputStream to read the contents of the request + a #GInputStream to read the contents of the request - the length of the stream or -1 if not known + the length of the stream or -1 if not known - the content type of the stream or %NULL if not known + the content type of the stream or %NULL if not known - Finish a #WebKitURISchemeRequest with a #GError. + Finish a #WebKitURISchemeRequest with a #GError. + - a #WebKitURISchemeRequest + a #WebKitURISchemeRequest - a #GError that will be passed to the #WebKitWebView + a #GError that will be passed to the #WebKitWebView - Get the URI path of @request + Get the URI path of @request + - the URI path of @request + the URI path of @request - a #WebKitURISchemeRequest + a #WebKitURISchemeRequest - Get the URI scheme of @request + Get the URI scheme of @request + - the URI scheme of @request + the URI scheme of @request - a #WebKitURISchemeRequest + a #WebKitURISchemeRequest - Get the URI of @request + Get the URI of @request + - the full URI of @request + the full URI of @request - a #WebKitURISchemeRequest + a #WebKitURISchemeRequest - Get the #WebKitWebView that initiated the request. + Get the #WebKitWebView that initiated the request. + - the #WebKitWebView that initiated @request. + the #WebKitWebView that initiated @request. - a #WebKitURISchemeRequest + a #WebKitURISchemeRequest @@ -11592,28 +12871,31 @@ present. - Type definition for a function that will be called back when an URI request is + Type definition for a function that will be called back when an URI request is made for a user registered URI scheme. + - the #WebKitURISchemeRequest + the #WebKitURISchemeRequest - user data passed to the callback + user data passed to the callback + + @@ -11621,6 +12903,7 @@ made for a user registered URI scheme. + @@ -11628,6 +12911,7 @@ made for a user registered URI scheme. + @@ -11635,189 +12919,217 @@ made for a user registered URI scheme. + - + + + + + + + + + + + + + + + + + + + + + + + + + - Obtain the identifier previously used to save the @user_content_filter in the + Obtain the identifier previously used to save the @user_content_filter in the #WebKitUserContentFilterStore. + - the identifier for the filter + the identifier for the filter - A #WebKitUserContentFilter + A #WebKitUserContentFilter - Atomically increments the reference count of @user_content_filter by one. + Atomically increments the reference count of @user_content_filter by one. This function is MT-safe and may be called from any thread. + - A #WebKitUserContentFilter + A #WebKitUserContentFilter - Atomically decrements the reference count of @user_content_filter by one. + Atomically decrements the reference count of @user_content_filter by one. If the reference count drops to 0, all the memory allocated by the #WebKitUserContentFilter is released. This function is MT-safe and may be called from any thread. + - A #WebKitUserContentFilter + A #WebKitUserContentFilter - - The JSON source for a content filter is invalid. + + The JSON source for a content filter is invalid. - - The requested content filter could not be found. + + The requested content filter could not be found. @@ -11826,182 +13138,191 @@ be called from any thread. + - Create a new #WebKitUserContentFilterStore to manipulate filters stored at @storage_path. + Create a new #WebKitUserContentFilterStore to manipulate filters stored at @storage_path. The path must point to a local filesystem, and will be created if needed. + - a newly created #WebKitUserContentFilterStore + a newly created #WebKitUserContentFilterStore - path where data for filters will be stored on disk + path where data for filters will be stored on disk - Asynchronously retrieve a list of the identifiers for all the stored filters. + Asynchronously retrieve a list of the identifiers for all the stored filters. When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_fetch_identifiers_finish() to obtain the list of filter identifiers. + - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the removal is completed + a #GAsyncReadyCallback to call when the removal is completed - the data to pass to the callback function + the data to pass to the callback function - Finishes an asynchronous fetch of the list of identifiers for the stored filters previously + Finishes an asynchronous fetch of the list of identifiers for the stored filters previously started with webkit_user_content_filter_store_fetch_identifiers(). + - a %NULL-terminated list of filter identifiers. + a %NULL-terminated list of filter identifiers. - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a #GAsyncResult + a #GAsyncResult - + + - The storage path for user content filters. + The storage path for user content filters. - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - Asynchronously load a content filter given its @identifier. The filter must have been + Asynchronously load a content filter given its @identifier. The filter must have been previously stored using webkit_user_content_filter_store_save(). When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_load_finish() to obtain the resulting filter. + - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a filter identifier + a filter identifier - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the load is completed + a #GAsyncReadyCallback to call when the load is completed - the data to pass to the callback function + the data to pass to the callback function - Finishes an asynchronous filter load previously started with + Finishes an asynchronous filter load previously started with webkit_user_content_filter_store_load(). + - a #WebKitUserContentFilter, or %NULL if the load failed + a #WebKitUserContentFilter, or %NULL if the load failed - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a #GAsyncResult + a #GAsyncResult - Asynchronously remove a content filter given its @identifier. + Asynchronously remove a content filter given its @identifier. When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_remove_finish() to check whether the removal was successful. + - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a filter identifier + a filter identifier - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the removal is completed + a #GAsyncReadyCallback to call when the removal is completed - the data to pass to the callback function + the data to pass to the callback function - Finishes an asynchronous filter removal previously started with + Finishes an asynchronous filter removal previously started with webkit_user_content_filter_store_remove(). + - whether the removal was successful + whether the removal was successful - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a #GAsyncResult + a #GAsyncResult - Asynchronously save a content filter from a source rule set in the + Asynchronously save a content filter from a source rule set in the [WebKit content extesions JSON format](https://webkit.org/blog/3476/content-blockers-first-look/). The @identifier can be used afterwards to refer to the filter when using @@ -12011,111 +13332,115 @@ the one saved beforehand for the same identifier. When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_save_finish() to obtain the resulting filter. + - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a string used to identify the saved filter + a string used to identify the saved filter - #GBytes containing the rule set in JSON format + #GBytes containing the rule set in JSON format - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when saving is completed + a #GAsyncReadyCallback to call when saving is completed - the data to pass to the callback function + the data to pass to the callback function - Finishes an asynchronous filter save previously started with + Finishes an asynchronous filter save previously started with webkit_user_content_filter_store_save(). + - a #WebKitUserContentFilter, or %NULL if saving failed + a #WebKitUserContentFilter, or %NULL if saving failed - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a #GAsyncResult + a #GAsyncResult - Asynchronously save a content filter from the contents of a file, which must be + Asynchronously save a content filter from the contents of a file, which must be native to the platform, as checked by g_file_is_native(). See webkit_user_content_filter_store_save() for more details. When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_save_finish() to obtain the resulting filter. + - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a string used to identify the saved filter + a string used to identify the saved filter - a #GFile containing the rule set in JSON format + a #GFile containing the rule set in JSON format - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when saving is completed + a #GAsyncReadyCallback to call when saving is completed - the data to pass to the callback function + the data to pass to the callback function - Finishes and asynchronous filter save previously started with + Finishes and asynchronous filter save previously started with webkit_user_content_filter_store_save_from_file(). + - a #WebKitUserContentFilter, or %NULL if saving failed. + a #WebKitUserContentFilter, or %NULL if saving failed. - a #WebKitUserContentFilterStore + a #WebKitUserContentFilterStore - a #GAsyncResult + a #GAsyncResult - - The directory used for filter storage. This path is used as the base + + The directory used for filter storage. This path is used as the base directory where user content filters are stored on disk. @@ -12127,11 +13452,13 @@ directory where user content filters are stored on disk. + + @@ -12139,6 +13466,7 @@ directory where user content filters are stored on disk. + @@ -12146,6 +13474,7 @@ directory where user content filters are stored on disk. + @@ -12153,92 +13482,100 @@ directory where user content filters are stored on disk. + - + + + - Specifies in which frames user style sheets are to be inserted in. - - Insert the user style + Specifies in which frames user style sheets are to be inserted in. + + Insert the user style sheet in all the frames loaded by the web view, including nested frames. This is the default. - - Insert the user style + + Insert the user style sheet *only* in the top-level frame loaded by the web view, and *not* in the nested frames. + - Creates a new user content manager. + Creates a new user content manager. + - A #WebKitUserContentManager + A #WebKitUserContentManager - Adds a #WebKitUserContentFilter to the given #WebKitUserContentManager. + Adds a #WebKitUserContentFilter to the given #WebKitUserContentManager. The same #WebKitUserContentFilter can be reused with multiple #WebKitUserContentManager instances. Filters need to be saved and loaded from #WebKitUserContentFilterStore. + - A #WebKitUserContentManager + A #WebKitUserContentManager - A #WebKitUserContentFilter + A #WebKitUserContentFilter - Adds a #WebKitUserScript to the given #WebKitUserContentManager. + Adds a #WebKitUserScript to the given #WebKitUserContentManager. The same #WebKitUserScript can be reused with multiple #WebKitUserContentManager instances. + - A #WebKitUserContentManager + A #WebKitUserContentManager - A #WebKitUserScript + A #WebKitUserScript - Adds a #WebKitUserStyleSheet to the given #WebKitUserContentManager. + Adds a #WebKitUserStyleSheet to the given #WebKitUserContentManager. The same #WebKitUserStyleSheet can be reused with multiple #WebKitUserContentManager instances. + - A #WebKitUserContentManager + A #WebKitUserContentManager - A #WebKitUserStyleSheet + A #WebKitUserStyleSheet - Registers a new user script message handler. After it is registered, + Registers a new user script message handler. After it is registered, scripts can use `window.webkit.messageHandlers.&lt;name&gt;.postMessage(value)` to send messages. Those messages are received by connecting handlers to the #WebKitUserContentManager::script-message-received signal. The @@ -12257,158 +13594,167 @@ webkit_user_content_manager_register_script_message_handler (manager, "foobar"); Registering a script message handler will fail if the requested name has been already registered before. + - %TRUE if message handler was registered successfully, or %FALSE otherwise. + %TRUE if message handler was registered successfully, or %FALSE otherwise. - A #WebKitUserContentManager + A #WebKitUserContentManager - Name of the script message channel + Name of the script message channel - Registers a new user script message handler in script world with name @world_name. + Registers a new user script message handler in script world with name @world_name. See webkit_user_content_manager_register_script_message_handler() for full description. Registering a script message handler will fail if the requested name has been already registered before. + - %TRUE if message handler was registered successfully, or %FALSE otherwise. + %TRUE if message handler was registered successfully, or %FALSE otherwise. - A #WebKitUserContentManager + A #WebKitUserContentManager - Name of the script message channel + Name of the script message channel - the name of a #WebKitScriptWorld + the name of a #WebKitScriptWorld - Removes all content filters from the given #WebKitUserContentManager. + Removes all content filters from the given #WebKitUserContentManager. + - A #WebKitUserContentManager + A #WebKitUserContentManager - Removes all user scripts from the given #WebKitUserContentManager + Removes all user scripts from the given #WebKitUserContentManager See also webkit_user_content_manager_remove_script(). + - A #WebKitUserContentManager + A #WebKitUserContentManager - Removes all user style sheets from the given #WebKitUserContentManager. + Removes all user style sheets from the given #WebKitUserContentManager. + - A #WebKitUserContentManager + A #WebKitUserContentManager - Removes a filter from the given #WebKitUserContentManager. + Removes a filter from the given #WebKitUserContentManager. Since 2.24 + - A #WebKitUserContentManager + A #WebKitUserContentManager - A #WebKitUserContentFilter + A #WebKitUserContentFilter - Removes a filter from the given #WebKitUserContentManager given the + Removes a filter from the given #WebKitUserContentManager given the identifier of a #WebKitUserContentFilter as returned by webkit_user_content_filter_get_identifier(). + - A #WebKitUserContentManager + A #WebKitUserContentManager - Filter identifier + Filter identifier - Removes a #WebKitUserScript from the given #WebKitUserContentManager. + Removes a #WebKitUserScript from the given #WebKitUserContentManager. See also webkit_user_content_manager_remove_all_scripts(). + - A #WebKitUserContentManager + A #WebKitUserContentManager - A #WebKitUserScript + A #WebKitUserScript - Removes a #WebKitUserStyleSheet from the given #WebKitUserContentManager. + Removes a #WebKitUserStyleSheet from the given #WebKitUserContentManager. See also webkit_user_content_manager_remove_all_style_sheets(). + - A #WebKitUserContentManager + A #WebKitUserContentManager - A #WebKitUserStyleSheet + A #WebKitUserStyleSheet - Unregisters a previously registered message handler. + Unregisters a previously registered message handler. Note that this does *not* disconnect handlers for the #WebKitUserContentManager::script-message-received signal; @@ -12416,22 +13762,23 @@ they will be kept connected, but the signal will not be emitted unless the handler name is registered again. See also webkit_user_content_manager_register_script_message_handler(). + - A #WebKitUserContentManager + A #WebKitUserContentManager - Name of the script message channel + Name of the script message channel - Unregisters a previously registered message handler in script world with name @world_name. + Unregisters a previously registered message handler in script world with name @world_name. Note that this does *not* disconnect handlers for the #WebKitUserContentManager::script-message-received signal; @@ -12439,20 +13786,21 @@ they will be kept connected, but the signal will not be emitted unless the handler name is registered again. See also webkit_user_content_manager_register_script_message_handler_in_world(). + - A #WebKitUserContentManager + A #WebKitUserContentManager - Name of the script message channel + Name of the script message channel - the name of a #WebKitScriptWorld + the name of a #WebKitScriptWorld @@ -12464,7 +13812,7 @@ See also webkit_user_content_manager_register_script_message_handler_in_world(). - This signal is emitted when JavaScript in a web view calls + This signal is emitted when JavaScript in a web view calls <code>window.webkit.messageHandlers.&lt;name&gt;.postMessage()</code>, after registering <code>&lt;name&gt;</code> using webkit_user_content_manager_register_script_message_handler() @@ -12473,18 +13821,20 @@ webkit_user_content_manager_register_script_message_handler() - the #WebKitJavascriptResult holding the value received from the JavaScript world. + the #WebKitJavascriptResult holding the value received from the JavaScript world. + + @@ -12492,6 +13842,7 @@ webkit_user_content_manager_register_script_message_handler() + @@ -12499,6 +13850,7 @@ webkit_user_content_manager_register_script_message_handler() + @@ -12506,14 +13858,18 @@ webkit_user_content_manager_register_script_message_handler() + - + + + + @@ -12529,11 +13885,13 @@ webkit_user_content_manager_register_script_message_handler() + + @@ -12541,6 +13899,7 @@ webkit_user_content_manager_register_script_message_handler() + @@ -12548,6 +13907,7 @@ webkit_user_content_manager_register_script_message_handler() + @@ -12555,119 +13915,129 @@ webkit_user_content_manager_register_script_message_handler() + - + + + + - Create a new #WebKitUserMessage with @name. + Create a new #WebKitUserMessage with @name. + - the newly created #WebKitUserMessage object. + the newly created #WebKitUserMessage object. - the message name + the message name - the message parameters as a #GVariant, or %NULL + the message parameters as a #GVariant, or %NULL - Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent. + Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent. + - the newly created #WebKitUserMessage object. + the newly created #WebKitUserMessage object. - the message name + the message name - the message parameters as a #GVariant + the message parameters as a #GVariant - the message file descriptors + the message file descriptors - - Get the @message list of file descritpor + + Get the @message list of file descritpor + - the message list of file descriptors + the message list of file descriptors - a #WebKitUserMessage + a #WebKitUserMessage - - Get the @message name + + Get the @message name + - the message name + the message name - a #WebKitUserMessage + a #WebKitUserMessage - - Get the @message parameters + + Get the @message parameters + - the message parameters + the message parameters - a #WebKitUserMessage + a #WebKitUserMessage - Send a reply to @message. If @reply is floating, it's consumed. + Send a reply to @message. If @reply is floating, it's consumed. You can only send a reply to a #WebKitUserMessage that has been received. + - a #WebKitUserMessage + a #WebKitUserMessage - a #WebKitUserMessage to send as reply + a #WebKitUserMessage to send as reply - - The UNIX file descriptors of the user message. + + The UNIX file descriptors of the user message. - - The name of the user message. + + The name of the user message. - - The parameters of the user message as a #GVariant, or %NULL + + The parameters of the user message as a #GVariant, or %NULL if the message doesn't include parameters. Note that only complete types are allowed. @@ -12680,11 +14050,13 @@ allowed. + + @@ -12692,6 +14064,7 @@ allowed. + @@ -12699,6 +14072,7 @@ allowed. + @@ -12706,6 +14080,7 @@ allowed. + @@ -12713,9 +14088,9 @@ allowed. - Enum values used to denote errors happening when sending user messages. - - The message was not handled by the receiver. + Enum values used to denote errors happening when sending user messages. + + The message was not handled by the receiver. @@ -12723,41 +14098,45 @@ allowed. - + + + + - Creates a new user script. Scripts can be applied to some URIs + Creates a new user script. Scripts can be applied to some URIs only by passing non-null values for @allow_list or @block_list. Passing a %NULL allow_list implies that all URIs are on the allow_list. The script is applied if an URI matches the allow_list and not the block_list. URI patterns must be of the form `[protocol]://[host]/[path]`, where the *host* and *path* components can contain the wildcard character (`*`) to represent zero or more other characters. + - A new #WebKitUserScript + A new #WebKitUserScript - Source code of the user script. + Source code of the user script. - A #WebKitUserContentInjectedFrames value + A #WebKitUserContentInjectedFrames value - A #WebKitUserScriptInjectionTime value + A #WebKitUserScriptInjectionTime value - An allow_list of URI patterns or %NULL + An allow_list of URI patterns or %NULL - A block_list of URI patterns or %NULL + A block_list of URI patterns or %NULL @@ -12765,37 +14144,38 @@ represent zero or more other characters. - Creates a new user script for script world with name @world_name. + Creates a new user script for script world with name @world_name. See webkit_user_script_new() for a full description. + - A new #WebKitUserScript + A new #WebKitUserScript - Source code of the user script. + Source code of the user script. - A #WebKitUserContentInjectedFrames value + A #WebKitUserContentInjectedFrames value - A #WebKitUserScriptInjectionTime value + A #WebKitUserScriptInjectionTime value - the name of a #WebKitScriptWorld + the name of a #WebKitScriptWorld - An allow_list of URI patterns or %NULL + An allow_list of URI patterns or %NULL - A block_list of URI patterns or %NULL + A block_list of URI patterns or %NULL @@ -12803,92 +14183,96 @@ See webkit_user_script_new() for a full description. - Atomically increments the reference count of @user_script by one. + Atomically increments the reference count of @user_script by one. This function is MT-safe and may be called from any thread. + - The passed #WebKitUserScript + The passed #WebKitUserScript - a #WebKitUserScript + a #WebKitUserScript - Atomically decrements the reference count of @user_script by one. + Atomically decrements the reference count of @user_script by one. If the reference count drops to 0, all memory allocated by #WebKitUserScript is released. This function is MT-safe and may be called from any thread. + - a #WebKitUserScript + a #WebKitUserScript - Specifies at which place of documents an user script will be inserted. - - Insert the code of the user + Specifies at which place of documents an user script will be inserted. + + Insert the code of the user script at the beginning of loaded documents. This is the default. - - Insert the code of the user + + Insert the code of the user script at the end of the loaded documents. - Specifies how to treat an user style sheet. - - The style sheet is an user style sheet, + Specifies how to treat an user style sheet. + + The style sheet is an user style sheet, its contents always override other style sheets. This is the default. - - The style sheet will be treated as if + + The style sheet will be treated as if it was provided by the loaded documents. That means other user style sheets may still override it. + - Creates a new user style sheet. Style sheets can be applied to some URIs + Creates a new user style sheet. Style sheets can be applied to some URIs only by passing non-null values for @allow_list or @block_list. Passing a %NULL allow_list implies that all URIs are on the allow_list. The style sheet is applied if an URI matches the allow_list and not the block_list. URI patterns must be of the form `[protocol]://[host]/[path]`, where the *host* and *path* components can contain the wildcard character (`*`) to represent zero or more other characters. + - A new #WebKitUserStyleSheet + A new #WebKitUserStyleSheet - Source code of the user style sheet. + Source code of the user style sheet. - A #WebKitUserContentInjectedFrames value + A #WebKitUserContentInjectedFrames value - A #WebKitUserStyleLevel + A #WebKitUserStyleLevel - An allow_list of URI patterns or %NULL + An allow_list of URI patterns or %NULL - A block_list of URI patterns or %NULL + A block_list of URI patterns or %NULL @@ -12896,37 +14280,38 @@ represent zero or more other characters. - Creates a new user style sheet for script world with name @world_name. + Creates a new user style sheet for script world with name @world_name. See webkit_user_style_sheet_new() for a full description. + - A new #WebKitUserStyleSheet + A new #WebKitUserStyleSheet - Source code of the user style sheet. + Source code of the user style sheet. - A #WebKitUserContentInjectedFrames value + A #WebKitUserContentInjectedFrames value - A #WebKitUserStyleLevel + A #WebKitUserStyleLevel - the name of a #WebKitScriptWorld + the name of a #WebKitScriptWorld - An allow_list of URI patterns or %NULL + An allow_list of URI patterns or %NULL - A block_list of URI patterns or %NULL + A block_list of URI patterns or %NULL @@ -12934,238 +14319,273 @@ See webkit_user_style_sheet_new() for a full description. - Atomically increments the reference count of @user_style_sheet by one. + Atomically increments the reference count of @user_style_sheet by one. This function is MT-safe and may be called from any thread. + - The passed #WebKitUserStyleSheet + The passed #WebKitUserStyleSheet - a #WebKitUserStyleSheet + a #WebKitUserStyleSheet - Atomically decrements the reference count of @user_style_sheet by one. + Atomically decrements the reference count of @user_style_sheet by one. If the reference count drops to 0, all memory allocated by #WebKitUserStyleSheet is released. This function is MT-safe and may be called from any thread. + - a #WebKitUserStyleSheet + a #WebKitUserStyleSheet + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Create a new #WebKitWebContext + Create a new #WebKitWebContext + - a newly created #WebKitWebContext + a newly created #WebKitWebContext - Create a new ephemeral #WebKitWebContext. An ephemeral #WebKitWebContext is a context + Create a new ephemeral #WebKitWebContext. An ephemeral #WebKitWebContext is a context created with an ephemeral #WebKitWebsiteDataManager. This is just a convenient method to create ephemeral contexts without having to create your own #WebKitWebsiteDataManager. All #WebKitWebView<!-- -->s associated with this context will also be ephemeral. Websites will not store any data in the client storage. This is normally used to implement private instances. + - a new ephemeral #WebKitWebContext. + a new ephemeral #WebKitWebContext. - Create a new #WebKitWebContext with a #WebKitWebsiteDataManager. + Create a new #WebKitWebContext with a #WebKitWebsiteDataManager. + - a newly created #WebKitWebContext + a newly created #WebKitWebContext - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Gets the default web context + Gets the default web context + - a #WebKitWebContext + a #WebKitWebContext + @@ -13179,6 +14599,7 @@ This is normally used to implement private instances. + @@ -13192,6 +14613,7 @@ This is normally used to implement private instances. + @@ -13202,6 +14624,7 @@ This is normally used to implement private instances. + @@ -13212,6 +14635,7 @@ This is normally used to implement private instances. + @@ -13225,7 +14649,7 @@ This is normally used to implement private instances. - Adds a path to be mounted in the sandbox. @path must exist before any web process + Adds a path to be mounted in the sandbox. @path must exist before any web process has been created otherwise it will be silently ignored. It is a fatal error to add paths after a web process has been spawned. @@ -13233,124 +14657,131 @@ Paths in directories such as `/sys`, `/proc`, and `/dev` or all of `/` are not valid. See also webkit_web_context_set_sandbox_enabled() + - a #WebKitWebContext + a #WebKitWebContext - an absolute path to mount in the sandbox + an absolute path to mount in the sandbox - if %TRUE the path will be read-only + if %TRUE the path will be read-only - Ignore further TLS errors on the @host for the certificate present in @info. + Ignore further TLS errors on the @host for the certificate present in @info. + - a #WebKitWebContext + a #WebKitWebContext - a #GTlsCertificate + a #GTlsCertificate - the host for which a certificate is to be allowed + the host for which a certificate is to be allowed - Clears all resources currently cached. + Clears all resources currently cached. See also webkit_web_context_set_cache_model(). + - a #WebKitWebContext + a #WebKitWebContext - Requests downloading of the specified URI string. The download operation + Requests downloading of the specified URI string. The download operation will not be associated to any #WebKitWebView, if you are interested in starting a download from a particular #WebKitWebView use webkit_web_view_download_uri() instead. + - a new #WebKitDownload representing + a new #WebKitDownload representing the download operation. - a #WebKitWebContext + a #WebKitWebContext - the URI to download + the URI to download - Returns the current cache model. For more information about this + Returns the current cache model. For more information about this value check the documentation of the function webkit_web_context_set_cache_model(). + - the current #WebKitCacheModel + the current #WebKitCacheModel - the #WebKitWebContext + the #WebKitWebContext - Get the #WebKitCookieManager of the @context's #WebKitWebsiteDataManager. + Get the #WebKitCookieManager of the @context's #WebKitWebsiteDataManager. + - the #WebKitCookieManager of @context. + the #WebKitCookieManager of @context. - a #WebKitWebContext + a #WebKitWebContext - Get the #WebKitFaviconDatabase associated with @context. + Get the #WebKitFaviconDatabase associated with @context. To initialize the database you need to call webkit_web_context_set_favicon_database_directory(). + - the #WebKitFaviconDatabase of @context. + the #WebKitFaviconDatabase of @context. - a #WebKitWebContext + a #WebKitWebContext - Get the directory path being used to store the favicons database + Get the directory path being used to store the favicons database for @context, or %NULL if webkit_web_context_set_favicon_database_directory() hasn't been called yet. @@ -13358,62 +14789,66 @@ called yet. This function will always return the same path after having called webkit_web_context_set_favicon_database_directory() for the first time. + - the path of the directory of the favicons + the path of the directory of the favicons database associated with @context, or %NULL. - a #WebKitWebContext + a #WebKitWebContext - Get the #WebKitGeolocationManager of @context. + Get the #WebKitGeolocationManager of @context. + - the #WebKitGeolocationManager of @context. + the #WebKitGeolocationManager of @context. - a #WebKitWebContext + a #WebKitWebContext - Asynchronously get the list of installed plugins. + Asynchronously get the list of installed plugins. When the operation is finished, @callback will be called. You can then call webkit_web_context_get_plugins_finish() to get the result of the operation. + - a #WebKitWebContext + a #WebKitWebContext - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_context_get_plugins. + Finish an asynchronous operation started with webkit_web_context_get_plugins. + - a #GList of #WebKitPlugin. You must free the #GList with + a #GList of #WebKitPlugin. You must free the #GList with g_list_free() and unref the #WebKitPlugin<!-- -->s with g_object_unref() when you're done with them. @@ -13421,76 +14856,81 @@ webkit_web_context_get_plugins_finish() to get the result of the operation. - a #WebKitWebContext + a #WebKitWebContext - a #GAsyncResult + a #GAsyncResult - Returns the current process model. For more information about this value + Returns the current process model. For more information about this value see webkit_web_context_set_process_model(). + - the current #WebKitProcessModel + the current #WebKitProcessModel - the #WebKitWebContext + the #WebKitWebContext - Get whether sandboxing is currently enabled. + Get whether sandboxing is currently enabled. + - %TRUE if sandboxing is enabled, or %FALSE otherwise. + %TRUE if sandboxing is enabled, or %FALSE otherwise. - a #WebKitWebContext + a #WebKitWebContext - Get the #WebKitSecurityManager of @context. + Get the #WebKitSecurityManager of @context. + - the #WebKitSecurityManager of @context. + the #WebKitSecurityManager of @context. - a #WebKitWebContext + a #WebKitWebContext - Get whether spell checking feature is currently enabled. + Get whether spell checking feature is currently enabled. + - %TRUE If spell checking is enabled, or %FALSE otherwise. + %TRUE If spell checking is enabled, or %FALSE otherwise. - a #WebKitWebContext + a #WebKitWebContext - Get the the list of spell checking languages associated with + Get the the list of spell checking languages associated with @context, or %NULL if no languages have been previously set. See webkit_web_context_set_spell_checking_languages() for more details on the format of the languages in the list. + - A %NULL-terminated + A %NULL-terminated array of languages if available, or %NULL otherwise. @@ -13498,68 +14938,72 @@ details on the format of the languages in the list. - a #WebKitWebContext + a #WebKitWebContext - Get the TLS errors policy of @context + Get the TLS errors policy of @context Use webkit_website_data_manager_get_tls_errors_policy() instead. + - a #WebKitTLSErrorsPolicy + a #WebKitTLSErrorsPolicy - a #WebKitWebContext + a #WebKitWebContext - - Get the #WebKitWebContext:use-system-appearance-for-scrollbars property. + + Get the #WebKitWebContext:use-system-appearance-for-scrollbars property. + - %TRUE if scrollbars are rendering using the system appearance, or %FALSE otherwise + %TRUE if scrollbars are rendering using the system appearance, or %FALSE otherwise - a #WebKitWebContext + a #WebKitWebContext - Gets the maximum number of web processes that can be created at the same time for the @context. + Gets the maximum number of web processes that can be created at the same time for the @context. This function is now deprecated and always returns 0 (no limit). See also webkit_web_context_set_web_process_count_limit(). + - the maximum limit of web processes, or 0 if there isn't a limit. + the maximum limit of web processes, or 0 if there isn't a limit. - the #WebKitWebContext + the #WebKitWebContext - - Get the #WebKitWebsiteDataManager of @context. + + Get the #WebKitWebsiteDataManager of @context. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - the #WebKitWebContext + the #WebKitWebContext - Sets initial desktop notification permissions for the @context. + Sets initial desktop notification permissions for the @context. @allowed_origins and @disallowed_origins must each be #GList of #WebKitSecurityOrigin objects representing origins that will, respectively, either always or never have permission to show desktop @@ -13574,22 +15018,23 @@ created. The best time to call it is when handling #WebKitWebContext::initialize-notification-permissions so as to ensure that new web processes receive the most recent set of permissions. + - the #WebKitWebContext + the #WebKitWebContext - a #GList of security origins + a #GList of security origins - a #GList of security origins + a #GList of security origins @@ -13597,51 +15042,54 @@ permissions. - Get whether automation is allowed in @context. + Get whether automation is allowed in @context. See also webkit_web_context_set_automation_allowed(). + - %TRUE if automation is allowed or %FALSE otherwise. + %TRUE if automation is allowed or %FALSE otherwise. - the #WebKitWebContext + the #WebKitWebContext - Get whether a #WebKitWebContext is ephemeral. + Get whether a #WebKitWebContext is ephemeral. + - %TRUE if @context is ephemeral or %FALSE otherwise. + %TRUE if @context is ephemeral or %FALSE otherwise. - the #WebKitWebContext + the #WebKitWebContext - Resolve the domain name of the given @hostname in advance, so that if a URI + Resolve the domain name of the given @hostname in advance, so that if a URI of @hostname is requested the load will be performed more quickly. + - a #WebKitWebContext + a #WebKitWebContext - a hostname to be resolved + a hostname to be resolved - Register @scheme in @context, so that when an URI request with @scheme is made in the + Register @scheme in @context, so that when an URI request with @scheme is made in the #WebKitWebContext, the #WebKitURISchemeRequestCallback registered will be called with a #WebKitURISchemeRequest. It is possible to handle URI scheme requests asynchronously, by calling g_object_ref() on the @@ -13681,67 +15129,70 @@ about_uri_scheme_request_cb (WebKitURISchemeRequest *request, g_object_unref (stream); } </programlisting></informalexample> + - a #WebKitWebContext + a #WebKitWebContext - the network scheme to register + the network scheme to register - a #WebKitURISchemeRequestCallback + a #WebKitURISchemeRequestCallback - data to pass to callback function + data to pass to callback function - destroy notify for @user_data + destroy notify for @user_data - Send @message to all #WebKitWebExtension<!-- -->s associated to @context. + Send @message to all #WebKitWebExtension<!-- -->s associated to @context. If @message is floating, it's consumed. + - the #WebKitWebContext + the #WebKitWebContext - a #WebKitUserMessage + a #WebKitUserMessage - Set an additional directory where WebKit will look for plugins. + Set an additional directory where WebKit will look for plugins. + - a #WebKitWebContext + a #WebKitWebContext - the directory to add + the directory to add - Set whether automation is allowed in @context. When automation is enabled the browser could + Set whether automation is allowed in @context. When automation is enabled the browser could be controlled by another process by requesting an automation session. When a new automation session is requested the signal #WebKitWebContext::automation-started is emitted. Automation is disabled by default, so you need to explicitly call this method passing %TRUE @@ -13749,22 +15200,23 @@ to enable it. Note that only one #WebKitWebContext can have automation enabled, so this will do nothing if there's another #WebKitWebContext with automation already enabled. + - the #WebKitWebContext + the #WebKitWebContext - value to set + value to set - Specifies a usage model for WebViews, which WebKit will use to + Specifies a usage model for WebViews, which WebKit will use to determine its caching behavior. All web views follow the cache model. This cache model determines the RAM and disk space to use for caching previously viewed content . @@ -13782,22 +15234,23 @@ specifying %WEBKIT_CACHE_MODEL_WEB_BROWSER. Applications without a browsing interface can reduce memory usage substantially by specifying %WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER. The default value is %WEBKIT_CACHE_MODEL_WEB_BROWSER. + - the #WebKitWebContext + the #WebKitWebContext - a #WebKitCacheModel + a #WebKitCacheModel - Set the directory where disk cache files will be stored + Set the directory where disk cache files will be stored This method must be called before loading anything in this context, otherwise it will not have any effect. @@ -13805,22 +15258,23 @@ Note that this method overrides the directory set in the #WebKitWebsiteDataManag but it doesn't change the value returned by webkit_website_data_manager_get_disk_cache_directory() since the #WebKitWebsiteDataManager is immutable. Use webkit_web_context_new_with_website_data_manager() instead. + - a #WebKitWebContext + a #WebKitWebContext - the directory to set + the directory to set - Set the directory path to be used to store the favicons database + Set the directory path to be used to store the favicons database for @context on disk. Passing %NULL as @path means using the default directory for the platform (see g_get_user_cache_dir()). @@ -13828,23 +15282,24 @@ Calling this method also means enabling the favicons database for its use from the applications, so that's why it's expected to be called only once. Further calls for the same instance of #WebKitWebContext won't cause any effect. + - a #WebKitWebContext + a #WebKitWebContext - an absolute path to the icon database + an absolute path to the icon database directory or %NULL to use the defaults - Set the network proxy settings to be used by connections started in @context. + Set the network proxy settings to be used by connections started in @context. By default %WEBKIT_NETWORK_PROXY_MODE_DEFAULT is used, which means that the system settings will be used (g_proxy_resolver_get_default()). If you want to override the system default settings, you can either use @@ -13853,39 +15308,41 @@ or %WEBKIT_NETWORK_PROXY_MODE_CUSTOM to provide your own proxy settings. When @proxy_mode is %WEBKIT_NETWORK_PROXY_MODE_CUSTOM @proxy_settings must be a valid #WebKitNetworkProxySettings; otherwise, @proxy_settings must be %NULL. Use webkit_website_data_manager_set_network_proxy_settings() instead. + - a #WebKitWebContext + a #WebKitWebContext - a #WebKitNetworkProxyMode + a #WebKitNetworkProxyMode - a #WebKitNetworkProxySettings, or %NULL + a #WebKitNetworkProxySettings, or %NULL - Set the list of preferred languages, sorted from most desirable + Set the list of preferred languages, sorted from most desirable to least desirable. The list will be used to build the "Accept-Language" header that will be included in the network requests started by the #WebKitWebContext. + - a #WebKitWebContext + a #WebKitWebContext - a %NULL-terminated list of language identifiers + a %NULL-terminated list of language identifiers @@ -13893,7 +15350,7 @@ the #WebKitWebContext. - Specifies a process model for WebViews, which WebKit will use to + Specifies a process model for WebViews, which WebKit will use to determine how auxiliary processes are handled. %WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES will use @@ -13910,59 +15367,62 @@ using it has no effect for security reasons. This method **must be called before any web process has been created**, as early as possible in your application. Calling it later will make your application crash. + - the #WebKitWebContext + the #WebKitWebContext - a #WebKitProcessModel + a #WebKitProcessModel - Set whether WebKit subprocesses will be sandboxed, limiting access to the system. + Set whether WebKit subprocesses will be sandboxed, limiting access to the system. This method **must be called before any web process has been created**, as early as possible in your application. Calling it later is a fatal error. This is only implemented on Linux and is a no-op otherwise. + - a #WebKitWebContext + a #WebKitWebContext - if %TRUE enable sandboxing + if %TRUE enable sandboxing - Enable or disable the spell checking feature. + Enable or disable the spell checking feature. + - a #WebKitWebContext + a #WebKitWebContext - Value to be set + Value to be set - Set the list of spell checking languages to be used for spell + Set the list of spell checking languages to be used for spell checking. The locale string typically is in the form lang_COUNTRY, where lang @@ -13973,16 +15433,17 @@ for Portuguese as written in Brazil. You need to call this function with a valid list of languages at least once in order to properly enable the spell checking feature in WebKit. + - a #WebKitWebContext + a #WebKitWebContext - a %NULL-terminated list of spell checking languages + a %NULL-terminated list of spell checking languages @@ -13990,106 +15451,115 @@ in WebKit. - Set the TLS errors policy of @context as @policy + Set the TLS errors policy of @context as @policy Use webkit_website_data_manager_set_tls_errors_policy() instead. + - a #WebKitWebContext + a #WebKitWebContext - a #WebKitTLSErrorsPolicy + a #WebKitTLSErrorsPolicy - - Set the #WebKitWebContext:use-system-appearance-for-scrollbars property. + + Set the #WebKitWebContext:use-system-appearance-for-scrollbars property. + - a #WebKitWebContext + a #WebKitWebContext - value to set + value to set - Set the directory where WebKit will look for Web Extensions. + Set the directory where WebKit will look for Web Extensions. This method must be called before loading anything in this context, otherwise it will not have any effect. You can connect to #WebKitWebContext::initialize-web-extensions to call this method before anything is loaded. + - a #WebKitWebContext + a #WebKitWebContext - the directory to add + the directory to add - Set user data to be passed to Web Extensions on initialization. + Set user data to be passed to Web Extensions on initialization. The data will be passed to the #WebKitWebExtensionInitializeWithUserDataFunction. This method must be called before loading anything in this context, otherwise it will not have any effect. You can connect to #WebKitWebContext::initialize-web-extensions to call this method before anything is loaded. + - a #WebKitWebContext + a #WebKitWebContext - a #GVariant + a #GVariant - Sets the maximum number of web processes that can be created at the same time for the @context. + Sets the maximum number of web processes that can be created at the same time for the @context. The default value is 0 and means no limit. This function is now deprecated and does nothing for security reasons. + - the #WebKitWebContext + the #WebKitWebContext - the maximum number of web processes + the maximum number of web processes - The directory where local storage data will be saved. + The directory where local storage data will be saved. Use #WebKitWebsiteDataManager:local-storage-directory instead. + + The #WebKitMemoryPressureSettings applied to the web processes created by this context. + + - Whether swap Web processes on cross-site navigations is enabled. + Whether swap Web processes on cross-site navigations is enabled. When enabled, pages from each security origin will be handled by their own separate Web processes, which are started (and @@ -14098,16 +15568,16 @@ domains. This is an important security measure which helps prevent websites stealing data from other visited pages. - - Whether to use system appearance for rendering scrollbars. + + Whether to use system appearance for rendering scrollbars. This is enabled by default for backwards compatibility, but it's only recommened to use when the application includes other widgets to ensure consistency, or when consistency with other applications is required too. - - The #WebKitWebsiteDataManager associated with this context. + + The #WebKitWebsiteDataManager associated with this context. @@ -14117,7 +15587,7 @@ consistency, or when consistency with other applications is required too. - This signal is emitted when a new automation request is made. + This signal is emitted when a new automation request is made. Note that it will never be emitted if automation is not enabled in @context, see webkit_web_context_set_automation_allowed() for more details. @@ -14125,25 +15595,25 @@ see webkit_web_context_set_automation_allowed() for more details. - the #WebKitAutomationSession associated with this event + the #WebKitAutomationSession associated with this event - This signal is emitted when a new download request is made. + This signal is emitted when a new download request is made. - the #WebKitDownload associated with this event + the #WebKitDownload associated with this event - This signal is emitted when a #WebKitWebContext needs to set + This signal is emitted when a #WebKitWebContext needs to set initial notification permissions for a web process. It is emitted when a new web process is about to be launched, and signals the most appropriate moment to use @@ -14156,7 +15626,7 @@ webkit_web_context_initialize_notification_permissions() again. - This signal is emitted when a new web process is about to be + This signal is emitted when a new web process is about to be launched. It signals the most appropriate moment to use webkit_web_context_set_web_extensions_initialization_user_data() and webkit_web_context_set_web_extensions_directory(). @@ -14165,30 +15635,32 @@ and webkit_web_context_set_web_extensions_directory(). - This signal is emitted when a #WebKitUserMessage is received from a + This signal is emitted when a #WebKitUserMessage is received from a #WebKitWebExtension. You can reply to the message using webkit_user_message_send_reply(). You can handle the user message asynchronously by calling g_object_ref() on @message and returning %TRUE. - %TRUE if the message was handled, or %FALSE otherwise. + %TRUE if the message was handled, or %FALSE otherwise. - the #WebKitUserMessage received + the #WebKitUserMessage received + + @@ -14204,6 +15676,7 @@ You can handle the user message asynchronously by calling g_object_ref() on + @@ -14216,6 +15689,7 @@ You can handle the user message asynchronously by calling g_object_ref() on + @@ -14228,6 +15702,7 @@ You can handle the user message asynchronously by calling g_object_ref() on + @@ -14243,6 +15718,7 @@ You can handle the user message asynchronously by calling g_object_ref() on + @@ -14258,6 +15734,7 @@ You can handle the user message asynchronously by calling g_object_ref() on + @@ -14265,6 +15742,7 @@ You can handle the user message asynchronously by calling g_object_ref() on + @@ -14272,150 +15750,163 @@ You can handle the user message asynchronously by calling g_object_ref() on + - + + + + - Request @inspector to be attached. The signal #WebKitWebInspector::attach + Request @inspector to be attached. The signal #WebKitWebInspector::attach will be emitted. If the inspector is already attached it does nothing. + - a #WebKitWebInspector + a #WebKitWebInspector - Request @inspector to be closed. + Request @inspector to be closed. + - a #WebKitWebInspector + a #WebKitWebInspector - Request @inspector to be detached. The signal #WebKitWebInspector::detach + Request @inspector to be detached. The signal #WebKitWebInspector::detach will be emitted. If the inspector is already detached it does nothing. + - a #WebKitWebInspector + a #WebKitWebInspector - - Get the height that the inspector view should have when + + Get the height that the inspector view should have when it's attached. If the inspector view is not attached this returns 0. + - the height of the inspector view when attached + the height of the inspector view when attached - a #WebKitWebInspector + a #WebKitWebInspector - - Whether the @inspector can be attached to the same window that contains + + Whether the @inspector can be attached to the same window that contains the inspected view. + - %TRUE if there is enough room for the inspector view inside the + %TRUE if there is enough room for the inspector view inside the window that contains the inspected view, or %FALSE otherwise. - a #WebKitWebInspector + a #WebKitWebInspector - - Get the URI that is currently being inspected. This can be %NULL if + + Get the URI that is currently being inspected. This can be %NULL if nothing has been loaded yet in the inspected view, if the inspector has been closed or when inspected view was loaded from a HTML string instead of a URI. + - the URI that is currently being inspected or %NULL + the URI that is currently being inspected or %NULL - a #WebKitWebInspector + a #WebKitWebInspector - Get the #WebKitWebViewBase used to display the inspector. + Get the #WebKitWebViewBase used to display the inspector. This might be %NULL if the inspector hasn't been loaded yet, or it has been closed. + - the #WebKitWebViewBase used to display the inspector or %NULL + the #WebKitWebViewBase used to display the inspector or %NULL - a #WebKitWebInspector + a #WebKitWebInspector - Whether the @inspector view is currently attached to the same window that contains + Whether the @inspector view is currently attached to the same window that contains the inspected view. + - %TRUE if @inspector is currently attached or %FALSE otherwise + %TRUE if @inspector is currently attached or %FALSE otherwise - a #WebKitWebInspector + a #WebKitWebInspector - Request @inspector to be shown. + Request @inspector to be shown. + - a #WebKitWebInspector + a #WebKitWebInspector - - The height that the inspector view should have when it is attached. + + The height that the inspector view should have when it is attached. - - Whether the @inspector can be attached to the same window that contains + + Whether the @inspector can be attached to the same window that contains the inspected view. - - The URI that is currently being inspected. + + The URI that is currently being inspected. @@ -14425,7 +15916,7 @@ the inspected view. - Emitted when the inspector is requested to be attached to the window + Emitted when the inspector is requested to be attached to the window where the inspected web view is. If this signal is not handled the inspector view will be automatically attached to the inspected view, so you only need to handle this signal @@ -14435,13 +15926,13 @@ the inspector view to a browser tab). To prevent the inspector view from being attached you can connect to this signal and simply return %TRUE. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - Emitted when the inspector should be shown. + Emitted when the inspector should be shown. If the inspector is not attached the inspector window should be shown on top of any other windows. @@ -14453,13 +15944,13 @@ In both cases, if this signal is not handled, the default implementation calls gtk_window_present() on the current toplevel #GtkWindow of the inspector view. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - Emitted when the inspector page is closed. If you are using your own + Emitted when the inspector page is closed. If you are using your own inspector window, you should connect to this signal and destroy your window. @@ -14467,7 +15958,7 @@ window. - Emitted when the inspector is requested to be detached from the window + Emitted when the inspector is requested to be detached from the window it is currently attached to. The inspector is detached when the inspector page is about to be closed, and this signal is emitted right before #WebKitWebInspector::closed, or when the user clicks on the detach button @@ -14477,13 +15968,13 @@ the signal #WebKitWebInspector::open-window is emitted after this one. To prevent the inspector view from being detached you can connect to this signal and simply return %TRUE. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - Emitted when the inspector is requested to open in a separate window. + Emitted when the inspector is requested to open in a separate window. If this signal is not handled, a #GtkWindow with the inspector will be created and shown, so you only need to handle this signal if you want to use your own window. @@ -14493,18 +15984,20 @@ the inspector in a separate window after being detached. To prevent the inspector from being shown you can connect to this signal and simply return %TRUE - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. + + @@ -14512,6 +16005,7 @@ signal and simply return %TRUE + @@ -14519,6 +16013,7 @@ signal and simply return %TRUE + @@ -14526,15 +16021,18 @@ signal and simply return %TRUE + - + + + - Whenever a client attempts to load a page protected by HTTP + Whenever a client attempts to load a page protected by HTTP authentication, credentials will need to be provided to authorize access. To allow the client to decide how it wishes to handle authentication, WebKit will fire a #WebKitWebView::authenticate signal with a @@ -14548,7 +16046,7 @@ authentication asynchronously, simply increase the reference count of the WebKitAuthenticationRequest object. - WebKitAutomationSession represents an automation session of a WebKitWebContext. + WebKitAutomationSession represents an automation session of a WebKitWebContext. When a new session is requested, a WebKitAutomationSession is created and the signal WebKitWebContext::automation-started is emitted with the WebKitAutomationSession as argument. Then, the automation client can request the session to create a new @@ -14556,7 +16054,7 @@ argument. Then, the automation client can request the session to create a new is emitted. - WebKitBackForwardList maintains a list of visited pages used to + WebKitBackForwardList maintains a list of visited pages used to navigate to recent pages. Items are inserted in the list in the order they are visited. @@ -14571,11 +16069,11 @@ do not change the value of the current item, they just return the requested item or items. - A history item is part of the #WebKitBackForwardList and consists + A history item is part of the #WebKitBackForwardList and consists out of a title and a URI. - Whenever the user interacts with an &lt;input type='color' /&gt; + Whenever the user interacts with an &lt;input type='color' /&gt; HTML element, WebKit will need to show a dialog to choose a color. For that to happen in a general way, instead of just opening a #GtkColorChooser (which might be not desirable in some cases, which could prefer to use their @@ -14590,7 +16088,7 @@ WebKit will provide a default handler which will asynchronously run a regular #GtkColorChooserDialog for the user to interact with. - #WebKitContextMenu represents a context menu containing + #WebKitContextMenu represents a context menu containing #WebKitContextMenuItem<!-- -->s in a #WebKitWebView. When a #WebKitWebView is about to display the context menu, it @@ -14603,21 +16101,21 @@ webkit_context_menu_insert(), maybe after having removed the existing ones with webkit_context_menu_remove_all(). - The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- + The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- -->s. These items can be created from a #GtkAction, from a #WebKitContextMenuAction or from a #WebKitContextMenuAction and a label. These #WebKitContextMenuAction<!-- -->s denote stock actions for the items. You can also create separators and submenus. - The WebKitCookieManager defines how to set up and handle cookies. + The WebKitCookieManager defines how to set up and handle cookies. You can get it from a #WebKitWebsiteDataManager with webkit_website_data_manager_get_cookie_manager(), and use it to set where to store cookies with webkit_cookie_manager_set_persistent_storage(), or to set the acceptance policy, with webkit_cookie_manager_get_accept_policy(). - WebKitUserMediaPermissionRequest represents a request for + WebKitUserMediaPermissionRequest represents a request for permission to whether WebKit should be allowed to access the user's devices information when requested through the enumeraceDevices API. @@ -14625,22 +16123,22 @@ When a WebKitDeviceInfoPermissionRequest is not handled by the user, it is denied by default. - #WebKitDownload carries information about a download request and + #WebKitDownload carries information about a download request and response, including a #WebKitURIRequest and a #WebKitURIResponse objects. The application may use this object to control the download process, or to simply figure out what is to be downloaded, and handle the download process itself. - WebKitEditorState represents the state of a #WebKitWebView editor. + WebKitEditorState represents the state of a #WebKitWebView editor. Use webkit_web_view_get_editor_state() to get the WebKitEditorState of a #WebKitWebView. - Categorized WebKit errors. + Categorized WebKit errors. - #WebKitFaviconDatabase provides access to the icons associated with + #WebKitFaviconDatabase provides access to the icons associated with web sites. WebKit will automatically look for available icons in &lt;link&gt; @@ -14654,7 +16152,7 @@ be deleted from it. Nevertheless, WebKit will still store them in the in-memory cache during the current execution. - Whenever the user interacts with an &lt;input type='file' /&gt; + Whenever the user interacts with an &lt;input type='file' /&gt; HTML element, WebKit will need to show a dialog to choose one or more files to be uploaded to the server along with the rest of the form data. For that to happen in a general way, instead of just @@ -14672,7 +16170,7 @@ WebKit will provide a default handler which will asynchronously run a regular #GtkFileChooserDialog for the user to interact with. - A #WebKitFindController is used to search text in a #WebKitWebView. You + A #WebKitFindController is used to search text in a #WebKitWebView. You can get a #WebKitWebView<!-- -->'s #WebKitFindController with webkit_web_view_get_find_controller(), and later use it to search for text using webkit_find_controller_search(), or get the @@ -14683,7 +16181,7 @@ operations are asynchronous and trigger signals when ready, such as #WebKitFindController::counted-matches<!-- -->. - When a form is about to be submitted in a #WebKitWebView, the + When a form is about to be submitted in a #WebKitWebView, the #WebKitWebView::submit-form signal is emitted. Its request argument contains information about the text fields of the form, that are typically used to store login information, returned as lists by @@ -14691,7 +16189,7 @@ webkit_form_submission_request_list_text_fields(). You can submit the form with webkit_form_submission_request_submit(). - WebKitGeolocationManager provides API to get the geographical position of the user. + WebKitGeolocationManager provides API to get the geographical position of the user. Once a #WebKitGeolocationPermissionRequest is allowed, when WebKit needs to know the user location #WebKitGeolocationManager::start signal is emitted. If the signal is handled and returns %TRUE, the application is responsible for providing the position every time it's @@ -14699,7 +16197,7 @@ updated by calling webkit_geolocation_manager_update_position(). The signal #Web will be emitted when location updates are no longer needed. - WebKitGeolocationPermissionRequest represents a request for + WebKitGeolocationPermissionRequest represents a request for permission to decide whether WebKit should provide the user's location to a website when requested through the Geolocation API. @@ -14723,7 +16221,7 @@ during initialization is needed when the name of the executable on disk does not match the name of a valid `.desktop` file. - A Hit Test is an operation to get context information about a given + A Hit Test is an operation to get context information about a given point in a #WebKitWebView. #WebKitHitTestResult represents the result of a Hit Test. It provides context information about what is at the coordinates of the Hit Test, such as if there's a link, @@ -14743,7 +16241,7 @@ for the mouse coordinates and #WebKitWebView::mouse-target-changed signal is emitted with a #WebKitHitTestResult. - WebKitInputMethodContext defines the interface to implement WebKit input methods. + WebKitInputMethodContext defines the interface to implement WebKit input methods. The input methods are used by WebKit, when editable content is focused, to map from key events to Unicode character strings. @@ -14753,7 +16251,7 @@ may provide feedback about this process by displaying the intermediate composition states as preedit text. - WebKitInstallMissingMediaPluginsPermissionRequest represents a request for + WebKitInstallMissingMediaPluginsPermissionRequest represents a request for permission to decide whether WebKit should try to start a helper application to install missing media plugins when the media backend couldn't play a media because the required plugins were not available. @@ -14762,7 +16260,7 @@ When a WebKitInstallMissingMediaPluginsPermissionRequest is not handled by the u it is allowed by default. - WebKitMediaKeySystemPermissionRequest represents a request for permission to decide whether + WebKitMediaKeySystemPermissionRequest represents a request for permission to decide whether WebKit should use the given CDM to access protected media when requested through the MediaKeySystem API. @@ -14771,19 +16269,39 @@ it is denied by default. When handling this permission request the application may perform additional installation of the requested CDM, unless it is already present on the host system. + + + #WebKitMemoryPressureSettings is a boxed type that can be used to provide some custom settings +to control how the memory pressure situations are handled by the different processes. + +The memory pressure system implemented inside the different process will try to keep the memory usage +under the defined memory limit. In order to do that, it will check the used memory with a user defined +frequency and decide whether it should try to release memory. The thresholds passed will define how urgent +is to release that memory. + +Take into account that badly defined parameters can greatly reduce the performance of the engine. For +example, setting memory limit too low with a fast poll interval can cause the process to constantly +be trying to release memory. + +A #WebKitMemoryPressureSettings can be passed to a #WebKitWebContext constructor, and the settings will +be applied to all the web processes created by that context. + +A #WebKitMemoryPressureSettings can be passed to webkit_website_data_manager_set_memory_pressure_settings(), +and the settings will be applied to all the network processes created after that call by any instance of +#WebKitWebsiteDataManager. - WebKitNavigationPolicyDecision represents a policy decision for events associated with + WebKitNavigationPolicyDecision represents a policy decision for events associated with navigations. If the value of #WebKitNavigationPolicyDecision:mouse-button is not 0, then the navigation was triggered by a mouse event. - WebKitNetworkProxySettings can be used to provide a custom proxy configuration + WebKitNetworkProxySettings can be used to provide a custom proxy configuration to a #WebKitWebContext. You need to call webkit_web_context_set_network_proxy_settings() with %WEBKIT_NETWORK_PROXY_MODE_CUSTOM and a WebKitNetworkProxySettings. - WebKitNotificationPermissionRequest represents a request for + WebKitNotificationPermissionRequest represents a request for permission to decide whether WebKit should provide the user with notifications through the Web Notification API. @@ -14791,20 +16309,20 @@ When a WebKitNotificationPermissionRequest is not handled by the user, it is denied by default. - WebKitOptionMenu represents the dropdown menu of a select element in a #WebKitWebView. + WebKitOptionMenu represents the dropdown menu of a select element in a #WebKitWebView. When a select element in a #WebKitWebView needs to display a dropdown menu, the signal #WebKitWebView::show-option-menu is emitted, providing a WebKitOptionMenu with the #WebKitOptionMenuItem<!-- -->s that should be displayed. - The #WebKitOptionMenu is composed of WebKitOptionMenuItem<!-- -->s. + The #WebKitOptionMenu is composed of WebKitOptionMenuItem<!-- -->s. A WebKitOptionMenuItem always has a label and can contain a tooltip text. You can use the WebKitOptionMenuItem of a #WebKitOptionMenu to build your own menus. - There are situations where an embedder would need to ask the user + There are situations where an embedder would need to ask the user for permission to do certain types of operations, such as switching to fullscreen mode or reporting the user's location through the standard Geolocation API. In those cases, WebKit will emit a @@ -14812,7 +16330,7 @@ standard Geolocation API. In those cases, WebKit will emit a #WebKitPermissionRequest object attached to it. - This object represents a single plugin, found while scanning the + This object represents a single plugin, found while scanning the various platform plugin directories. This object can be used to get more information about a plugin, and enable/disable it, allowing fine-grained control of plugins. The list of available plugins can @@ -14820,7 +16338,7 @@ be obtained from the #WebKitWebContext, with webkit_web_context_get_plugins(). - WebKitPointerLockPermissionRequest represents a request for + WebKitPointerLockPermissionRequest represents a request for permission to decide whether WebKit can lock the pointer device when requested by web content. @@ -14828,7 +16346,7 @@ When a WebKitPointerLockPermissionRequest is not handled by the user, it is allowed by default. - Often WebKit allows the client to decide the policy for certain + Often WebKit allows the client to decide the policy for certain operations. For instance, a client may want to open a link in a new tab, block a navigation entirely, query the user or trigger a download instead of a navigation. In these cases WebKit will fire the @@ -14839,34 +16357,34 @@ completes. To make a policy decision asynchronously, simply increment the reference count of the #WebKitPolicyDecision object. - A WebKitPrintCustomWidget allows to embed a custom widget in the print + A WebKitPrintCustomWidget allows to embed a custom widget in the print dialog by connecting to the #WebKitPrintOperation::create-custom-widget signal, creating a new WebKitPrintCustomWidget with webkit_print_custom_widget_new() and returning it from there. You can later use webkit_print_operation_run_dialog() to display the dialog. - A #WebKitPrintOperation controls a print operation in WebKit. With + A #WebKitPrintOperation controls a print operation in WebKit. With a similar API to #GtkPrintOperation, it lets you set the print settings with webkit_print_operation_set_print_settings() or display the print dialog with webkit_print_operation_run_dialog(). - WebKitResponsePolicyDecision represents a policy decision for a + WebKitResponsePolicyDecision represents a policy decision for a resource response, whether from the network or the local system. A very common use case for these types of decision is deciding whether or not to download a particular resource or to load it normally. - The #WebKitSecurityManager defines security settings for URI + The #WebKitSecurityManager defines security settings for URI schemes in a #WebKitWebContext. Get it from the context with webkit_web_context_get_security_manager(), and use it to register a URI scheme with a certain security level, or to check if it already has it. - #WebKitSecurityOrigin is a representation of a security domain + #WebKitSecurityOrigin is a representation of a security domain defined by websites. A security origin consists of a protocol, a hostname, and an optional port number. @@ -14876,7 +16394,7 @@ origins, beware that if both protocol and host are %NULL, the origins should not be treated as equal. - #WebKitSettings can be applied to a #WebKitWebView to control text charset, + #WebKitSettings can be applied to a #WebKitWebView to control text charset, color, font sizes, printing mode, script support, loading of images and various other things on a #WebKitWebView. After creation, a #WebKitSettings object contains default settings. @@ -14889,17 +16407,17 @@ webkit_settings_set_enable_javascript (settings, FALSE); </programlisting></informalexample> - A #WebKitURIRequest can be created with a URI using the + A #WebKitURIRequest can be created with a URI using the webkit_uri_request_new() method, and you can get the URI of an existing request with the webkit_uri_request_get_uri() one. - A #WebKitURIResponse contains information such as the URI, the + A #WebKitURIResponse contains information such as the URI, the status code, the content length, the mime type, the HTTP status or the suggested filename. - If you register a particular URI scheme in a #WebKitWebContext, + If you register a particular URI scheme in a #WebKitWebContext, using webkit_web_context_register_uri_scheme(), you have to provide a #WebKitURISchemeRequestCallback. After that, when a URI request is made with that particular scheme, your callback will be @@ -14909,10 +16427,10 @@ request, and also finish the request with webkit_uri_scheme_request_finish(). - See also: #WebKitUserContentManager + See also: #WebKitUserContentManager - The WebKitUserContentFilterStore provides the means to import and save + The WebKitUserContentFilterStore provides the means to import and save [JSON rule sets](https://webkit.org/blog/3476/content-blockers-first-look/), which can be loaded later in an efficient manner. Once filters are stored, the #WebKitUserContentFilter objects which represent them can be added to @@ -14926,7 +16444,7 @@ webkit_user_content_filter_store_load() can be used to retrieve a previously sav filter, and removed from the store with webkit_user_content_filter_store_remove(). - Using a #WebKitUserContentManager user CSS style sheets can be set to + Using a #WebKitUserContentManager user CSS style sheets can be set to be injected in the web pages loaded by a #WebKitWebView, by webkit_user_content_manager_add_style_sheet(). @@ -14939,7 +16457,7 @@ User style sheets can be added and removed at any time, but they will affect the web pages loaded afterwards. - WebKitUserMediaPermissionRequest represents a request for + WebKitUserMediaPermissionRequest represents a request for permission to decide whether WebKit should be allowed to access the user's audio and video source devices when requested through the getUserMedia API. @@ -14947,7 +16465,7 @@ When a WebKitUserMediaPermissionRequest is not handled by the user, it is denied by default. - A WebKitUserMessage is a message that can be used for the communication between the UI process + A WebKitUserMessage is a message that can be used for the communication between the UI process and web extensions. A WebKitUserMessage always has a name, and it can also include parameters and UNIX file descriptors. Messages can be sent from a #WebKitWebContext to all #WebKitWebExtension<!-- -->s, from a #WebKitWebExtension to its corresponding #WebKitWebContext, and from a #WebKitWebView to its @@ -14955,7 +16473,7 @@ corresponding #WebKitWebPage (and vice versa). One to one messages can be replie webkit_user_message_send_reply(). - Provides convenience functions returning WebKit's major, minor and + Provides convenience functions returning WebKit's major, minor and micro versions of the WebKit library your code is running against. This is not necessarily the same as the #WEBKIT_MAJOR_VERSION, #WEBKIT_MINOR_VERSION or @@ -14963,7 +16481,7 @@ against. This is not necessarily the same as the headers included when compiling the code. - The #WebKitWebContext manages all aspects common to all + The #WebKitWebContext manages all aspects common to all #WebKitWebView<!-- -->s. You can define the #WebKitCacheModel and #WebKitProcessModel with @@ -14989,7 +16507,7 @@ to set the policy %WEBKIT_TLS_ERRORS_POLICY_IGNORE; however, this is not appropriate for Internet applications. - The WebKit Inspector is a graphical tool to inspect and change the + The WebKit Inspector is a graphical tool to inspect and change the content of a #WebKitWebView. It also includes an interactive JavaScript debugger. Using this class one can get a #GtkWidget which can be embedded into an application to show the inspector. @@ -15012,7 +16530,7 @@ webkit_web_inspector_show (WEBKIT_WEB_INSPECTOR(inspector)); </programlisting></informalexample> - A #WebKitWebResource encapsulates content for each resource at the + A #WebKitWebResource encapsulates content for each resource at the end of a particular URI. For example, one #WebKitWebResource will be created for each separate image and stylesheet when a page is loaded. @@ -15023,7 +16541,7 @@ webkit_web_resource_get_response(), as well as the raw data, using webkit_web_resource_get_data(). - #WebKitWebView is the central class of the WPE WebKit and WebKitGTK + #WebKitWebView is the central class of the WPE WebKit and WebKitGTK APIs. It is responsible for managing the drawing of the content and forwarding of events. You can load any URI into the #WebKitWebView or a data string. With #WebKitSettings you can control various aspects @@ -15033,7 +16551,7 @@ Note that in WebKitGTK, #WebKitWebView is scrollable by itself, so you don't need to embed it in a #GtkScrolledWindow. - WebKitWebsiteData represents data stored in the client by a particular website. + WebKitWebsiteData represents data stored in the client by a particular website. A website is normally a set of URLs grouped by domain name. You can get the website name, which is usually the domain, with webkit_website_data_get_name(). Documents loaded from the file system, like file:// URIs, are all grouped in the same WebKitWebsiteData @@ -15048,14 +16566,14 @@ A list of WebKitWebsiteData can be retrieved with webkit_website_data_manager_fe for more information. - WebKitWebsiteDataAccessPermissionRequest represents a request for + WebKitWebsiteDataAccessPermissionRequest represents a request for permission to allow a third-party domain access its cookies. When a WebKitWebsiteDataAccessPermissionRequest is not handled by the user, it is denied by default. - WebKitWebsiteDataManager allows you to manage the data that websites + WebKitWebsiteDataManager allows you to manage the data that websites can store in the client file system like databases or caches. You can use WebKitWebsiteDataManager to configure the local directories where the Website data will be stored, by creating a new manager with @@ -15086,11 +16604,11 @@ stored by particular websites, or clear data for all websites modified since a g period of time. - WebKitWebsitePolicies allows you to configure per-page policies, + WebKitWebsitePolicies allows you to configure per-page policies, currently only autoplay policies are supported. - The content of a #WebKitWebView can request to change certain + The content of a #WebKitWebView can request to change certain properties of the window containing the view. This can include the x, y position of the window, the width and height but also if a toolbar, scrollbar, statusbar, locationbar should be visible to the user, @@ -15146,46 +16664,52 @@ static void ready_to_show_cb (WebKitWebView *web_view, gpointer user_data) </programlisting></informalexample> - Enum values used to specify the reason why the web process terminated abnormally. - - the web process crashed. + Enum values used to specify the reason why the web process terminated abnormally. + + the web process crashed. - - the web process exceeded the memory limit. + + the web process exceeded the memory limit. + + + the web process termination was requested by an API call. Since: 2.34 + - Asynchronously get the raw data for @resource. + Asynchronously get the raw data for @resource. When the operation is finished, @callback will be called. You can then call webkit_web_resource_get_data_finish() to get the result of the operation. + - a #WebKitWebResource + a #WebKitWebResource - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_resource_get_data(). + Finish an asynchronous operation started with webkit_web_resource_get_data(). + - a + a string with the data of @resource, or %NULL in case of error. if @length is not %NULL, the size of the data will be assigned to it. @@ -15194,38 +16718,39 @@ webkit_web_resource_get_data_finish() to get the result of the operation. - a #WebKitWebResource + a #WebKitWebResource - a #GAsyncResult + a #GAsyncResult - return location for the length of the resource data + return location for the length of the resource data - - Retrieves the #WebKitURIResponse of the resource load operation. + + Retrieves the #WebKitURIResponse of the resource load operation. This method returns %NULL if called before the response is received from the server. You can connect to notify::response signal to be notified when the response is received. + - the #WebKitURIResponse, or %NULL if + the #WebKitURIResponse, or %NULL if the response hasn't been received yet. - a #WebKitWebResource + a #WebKitWebResource - - Returns the current active URI of @resource. The active URI might change during + + Returns the current active URI of @resource. The active URI might change during a load operation: <orderedlist> @@ -15250,23 +16775,24 @@ a load operation: You can monitor the active URI by connecting to the notify::uri signal of @resource. + - the current active URI of @resource + the current active URI of @resource - a #WebKitWebResource + a #WebKitWebResource - - The #WebKitURIResponse associated with this resource. + + The #WebKitURIResponse associated with this resource. - - The current active URI of the #WebKitWebResource. + + The current active URI of the #WebKitWebResource. See webkit_web_resource_get_uri() for more details. @@ -15277,36 +16803,36 @@ See webkit_web_resource_get_uri() for more details. - This signal is emitted when an error occurs during the resource + This signal is emitted when an error occurs during the resource load operation. - the #GError that was triggered + the #GError that was triggered - This signal is emitted when a TLS error occurs during the resource load operation. + This signal is emitted when a TLS error occurs during the resource load operation. - a #GTlsCertificate + a #GTlsCertificate - a #GTlsCertificateFlags with the verification status of @certificate + a #GTlsCertificateFlags with the verification status of @certificate - This signal is emitted when the resource load finishes successfully + This signal is emitted when the resource load finishes successfully or due to an error. In case of errors #WebKitWebResource::failed signal is emitted before this one. @@ -15314,7 +16840,7 @@ is emitted before this one. - This signal is emitted after response is received, + This signal is emitted after response is received, every time new data has been received. It's useful to know the progress of the resource load operation. @@ -15322,13 +16848,13 @@ useful to know the progress of the resource load operation. - the length of data received in bytes + the length of data received in bytes - This signal is emitted when @request has been sent to the + This signal is emitted when @request has been sent to the server. In case of a server redirection this signal is emitted again with the @request argument containing the new request sent to the server due to the redirection and the @@ -15339,22 +16865,24 @@ received by the server for the initial request. - a #WebKitURIRequest + a #WebKitURIRequest - a #WebKitURIResponse, or %NULL + a #WebKitURIResponse, or %NULL + + @@ -15362,6 +16890,7 @@ received by the server for the initial request. + @@ -15369,6 +16898,7 @@ received by the server for the initial request. + @@ -15376,45 +16906,51 @@ received by the server for the initial request. + - + + + + - Creates a new #WebKitWebView with the default #WebKitWebContext and + Creates a new #WebKitWebView with the default #WebKitWebContext and no #WebKitUserContentManager associated with it. See also webkit_web_view_new_with_context(), webkit_web_view_new_with_user_content_manager(), and webkit_web_view_new_with_settings(). + - The newly created #WebKitWebView widget + The newly created #WebKitWebView widget - Creates a new #WebKitWebView with the given #WebKitWebContext and + Creates a new #WebKitWebView with the given #WebKitWebContext and no #WebKitUserContentManager associated with it. See also webkit_web_view_new_with_user_content_manager() and webkit_web_view_new_with_settings(). + - The newly created #WebKitWebView widget + The newly created #WebKitWebView widget - the #WebKitWebContext to be used by the #WebKitWebView + the #WebKitWebContext to be used by the #WebKitWebView - Creates a new #WebKitWebView sharing the same web process with @web_view. + Creates a new #WebKitWebView sharing the same web process with @web_view. This method doesn't have any effect when %WEBKIT_PROCESS_MODEL_SHARED_SECONDARY_PROCESS process model is used, because a single web process is shared for all the web views in the same #WebKitWebContext. When using %WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES process model, @@ -15424,48 +16960,52 @@ like for example, sharing the same web process for all the views in the same sec The newly created #WebKitWebView will also have the same #WebKitUserContentManager, #WebKitSettings, and #WebKitWebsitePolicies as @web_view. + - The newly created #WebKitWebView widget + The newly created #WebKitWebView widget - the related #WebKitWebView + the related #WebKitWebView - Creates a new #WebKitWebView with the given #WebKitSettings. + Creates a new #WebKitWebView with the given #WebKitSettings. See also webkit_web_view_new_with_context(), and webkit_web_view_new_with_user_content_manager(). + - The newly created #WebKitWebView widget + The newly created #WebKitWebView widget - a #WebKitSettings + a #WebKitSettings - Creates a new #WebKitWebView with the given #WebKitUserContentManager. + Creates a new #WebKitWebView with the given #WebKitUserContentManager. The content loaded in the view may be affected by the content injected in the view by the user content manager. + - The newly created #WebKitWebView widget + The newly created #WebKitWebView widget - a #WebKitUserContentManager. + a #WebKitUserContentManager. + @@ -15479,6 +17019,7 @@ in the view by the user content manager. + @@ -15489,6 +17030,7 @@ in the view by the user content manager. + @@ -15508,6 +17050,7 @@ in the view by the user content manager. + @@ -15518,6 +17061,7 @@ in the view by the user content manager. + @@ -15531,6 +17075,7 @@ in the view by the user content manager. + @@ -15547,6 +17092,7 @@ in the view by the user content manager. + @@ -15557,6 +17103,7 @@ in the view by the user content manager. + @@ -15570,6 +17117,7 @@ in the view by the user content manager. + @@ -15580,6 +17128,7 @@ in the view by the user content manager. + @@ -15593,6 +17142,7 @@ in the view by the user content manager. + @@ -15612,6 +17162,7 @@ in the view by the user content manager. + @@ -15631,6 +17182,7 @@ in the view by the user content manager. + @@ -15647,6 +17199,7 @@ in the view by the user content manager. + @@ -15660,6 +17213,7 @@ in the view by the user content manager. + @@ -15673,6 +17227,7 @@ in the view by the user content manager. + @@ -15683,6 +17238,7 @@ in the view by the user content manager. + @@ -15699,6 +17255,7 @@ in the view by the user content manager. + @@ -15709,6 +17266,7 @@ in the view by the user content manager. + @@ -15722,6 +17280,7 @@ in the view by the user content manager. + @@ -15735,6 +17294,7 @@ in the view by the user content manager. + @@ -15748,6 +17308,7 @@ in the view by the user content manager. + @@ -15761,6 +17322,7 @@ in the view by the user content manager. + @@ -15777,6 +17339,7 @@ in the view by the user content manager. + @@ -15790,6 +17353,7 @@ in the view by the user content manager. + @@ -15803,6 +17367,7 @@ in the view by the user content manager. + @@ -15813,6 +17378,7 @@ in the view by the user content manager. + @@ -15826,368 +17392,464 @@ in the view by the user content manager. - Asynchronously check if it is possible to execute the given editing command. + Asynchronously check if it is possible to execute the given editing command. When the operation is finished, @callback will be called. You can then call webkit_web_view_can_execute_editing_command_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the command to check + the command to check - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command(). + Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command(). + - %TRUE if the editing command can be executed or %FALSE otherwise + %TRUE if the editing command can be executed or %FALSE otherwise - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Determines whether @web_view has a previous history item. + Determines whether @web_view has a previous history item. + - %TRUE if able to move back or %FALSE otherwise. + %TRUE if able to move back or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - Determines whether @web_view has a next history item. + Determines whether @web_view has a next history item. + - %TRUE if able to move forward or %FALSE otherwise. + %TRUE if able to move forward or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - Whether or not a MIME type can be displayed in @web_view. + Whether or not a MIME type can be displayed in @web_view. + - %TRUE if the MIME type @mime_type can be displayed or %FALSE otherwise + %TRUE if the MIME type @mime_type can be displayed or %FALSE otherwise - a #WebKitWebView + a #WebKitWebView - a MIME type + a MIME type - Requests downloading of the specified URI string for @web_view. + Requests downloading of the specified URI string for @web_view. + - a new #WebKitDownload representing + a new #WebKitDownload representing the download operation. - a #WebKitWebView + a #WebKitWebView - the URI to download + the URI to download - Request to execute the given @command for @web_view. You can use + Request to execute the given @command for @web_view. You can use webkit_web_view_can_execute_editing_command() to check whether it's possible to execute the command. + - a #WebKitWebView + a #WebKitWebView - the command to execute + the command to execute - Request to execute the given @command with @argument for @web_view. You can use + Request to execute the given @command with @argument for @web_view. You can use webkit_web_view_can_execute_editing_command() to check whether it's possible to execute the command. + - a #WebKitWebView + a #WebKitWebView - the command to execute + the command to execute - the command argument + the command argument - - Get the presentation type of #WebKitWebView when created for automation. + + Get the presentation type of #WebKitWebView when created for automation. + - a #WebKitAutomationBrowsingContextPresentation. + a #WebKitAutomationBrowsingContextPresentation. - a #WebKitWebView + a #WebKitWebView - Obtains the #WebKitBackForwardList associated with the given #WebKitWebView. The + Obtains the #WebKitBackForwardList associated with the given #WebKitWebView. The #WebKitBackForwardList is owned by the #WebKitWebView. + - the #WebKitBackForwardList + the #WebKitBackForwardList - a #WebKitWebView + a #WebKitWebView - Gets the color that is used to draw the @web_view background before + Gets the color that is used to draw the @web_view background before the actual contents are rendered. For more information see also webkit_web_view_set_background_color() + - a #WebKitWebView + a #WebKitWebView - a #GdkRGBA to fill in with the background color + a #GdkRGBA to fill in with the background color - - Gets the web context of @web_view. + + Get the camera capture state of a #WebKitWebView. + - the #WebKitWebContext of the view + The #WebKitMediaCaptureState of the camera device. If #WebKitSettings:enable-mediastream +is %FALSE, this method will return %WEBKIT_MEDIA_CAPTURE_STATE_NONE. + + + + + a #WebKitWebView + + + + + + Gets the web context of @web_view. + + + the #WebKitWebContext of the view - a #WebKitWebView + a #WebKitWebView - Returns the current custom character encoding name of @web_view. + Returns the current custom character encoding name of @web_view. + - the current custom character encoding name or %NULL if no + the current custom character encoding name or %NULL if no custom character encoding has been set. - a #WebKitWebView + a #WebKitWebView + + + + + + Get the display capture state of a #WebKitWebView. + + + The #WebKitMediaCaptureState of the display device. If #WebKitSettings:enable-mediastream +is %FALSE, this method will return %WEBKIT_MEDIA_CAPTURE_STATE_NONE. + + + + + a #WebKitWebView - Gets the web editor state of @web_view. + Gets the web editor state of @web_view. + - the #WebKitEditorState of the view + the #WebKitEditorState of the view - a #WebKitWebView + a #WebKitWebView - - Gets the value of the #WebKitWebView:estimated-load-progress property. + + Gets the value of the #WebKitWebView:estimated-load-progress property. You can monitor the estimated progress of a load operation by connecting to the notify::estimated-load-progress signal of @web_view. + - an estimate of the of the percent complete for a document + an estimate of the of the percent complete for a document load as a range from 0.0 to 1.0. - a #WebKitWebView + a #WebKitWebView - - Returns favicon currently associated to @web_view, if any. You can + + Returns favicon currently associated to @web_view, if any. You can connect to notify::favicon signal of @web_view to be notified when the favicon is available. + - a pointer to a #cairo_surface_t with the + a pointer to a #cairo_surface_t with the favicon or %NULL if there's no icon associated with @web_view. - a #WebKitWebView + a #WebKitWebView - Gets the #WebKitFindController that will allow the caller to query + Gets the #WebKitFindController that will allow the caller to query the #WebKitWebView for the text to look for. + - the #WebKitFindController associated to + the #WebKitFindController associated to this particular #WebKitWebView. - the #WebKitWebView + the #WebKitWebView - Get the #WebKitInputMethodContext currently in use by @web_view, or %NULL if no input method is being used. + Get the #WebKitInputMethodContext currently in use by @web_view, or %NULL if no input method is being used. + - a #WebKitInputMethodContext, or %NULL + a #WebKitInputMethodContext, or %NULL - a #WebKitWebView + a #WebKitWebView - Get the #WebKitWebInspector associated to @web_view + Get the #WebKitWebInspector associated to @web_view + - the #WebKitWebInspector of @web_view + the #WebKitWebInspector of @web_view - a #WebKitWebView + a #WebKitWebView - - Gets the mute state of @web_view. + + Gets the mute state of @web_view. + - %TRUE if @web_view audio is muted or %FALSE is audio is not muted. + %TRUE if @web_view audio is muted or %FALSE is audio is not muted. - a #WebKitWebView + a #WebKitWebView + + + + + + + + + + + + + + + + + Get the global JavaScript context used by @web_view to deserialize the +result values of scripts executed with webkit_web_view_run_javascript(). + Use jsc_value_get_context() instead. + + + the <function>JSGlobalContextRef</function> used by @web_view to deserialize + the result values of scripts. + + + + + a #WebKitWebView - Return the main resource of @web_view. + Return the main resource of @web_view. + - the main #WebKitWebResource of the view + the main #WebKitWebResource of the view or %NULL if nothing has been loaded. - a #WebKitWebView + a #WebKitWebView - - Get the identifier of the #WebKitWebPage corresponding to -the #WebKitWebView + + Get the microphone capture state of a #WebKitWebView. + - the page ID of @web_view. + The #WebKitMediaCaptureState of the microphone device. If #WebKitSettings:enable-mediastream +is %FALSE, this method will return %WEBKIT_MEDIA_CAPTURE_STATE_NONE. + + + + + a #WebKitWebView + + + + + + Get the identifier of the #WebKitWebPage corresponding to +the #WebKitWebView + + + the page ID of @web_view. - a #WebKitWebView + a #WebKitWebView - Gets the current session state of @web_view + Gets the current session state of @web_view + - a #WebKitWebViewSessionState + a #WebKitWebViewSessionState - a #WebKitWebView + a #WebKitWebView - Gets the #WebKitSettings currently applied to @web_view. + Gets the #WebKitSettings currently applied to @web_view. If no other #WebKitSettings have been explicitly applied to @web_view with webkit_web_view_set_settings(), the default #WebKitSettings will be returned. This method always returns @@ -16200,88 +17862,92 @@ settings with webkit_web_view_set_settings() or get the existing can be shared by multiple #WebKitWebView<!-- -->s, so modifying the settings of a #WebKitWebView would affect other #WebKitWebView<!-- -->s using the same #WebKitSettings. + - the #WebKitSettings attached to @web_view + the #WebKitSettings attached to @web_view - a #WebKitWebView + a #WebKitWebView - Asynchronously retrieves a snapshot of @web_view for @region. + Asynchronously retrieves a snapshot of @web_view for @region. @options specifies how the snapshot should be rendered. When the operation is finished, @callback will be called. You must call webkit_web_view_get_snapshot_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the #WebKitSnapshotRegion for this snapshot + the #WebKitSnapshotRegion for this snapshot - #WebKitSnapshotOptions for the snapshot + #WebKitSnapshotOptions for the snapshot - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data + user data - Finishes an asynchronous operation started with webkit_web_view_get_snapshot(). + Finishes an asynchronous operation started with webkit_web_view_get_snapshot(). + - a #cairo_surface_t with the retrieved snapshot or %NULL in error. + a #cairo_surface_t with the retrieved snapshot or %NULL in error. - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - - Gets the value of the #WebKitWebView:title property. + + Gets the value of the #WebKitWebView:title property. You can connect to notify::title signal of @web_view to be notified when the title has been received. + - The main frame document title of @web_view. + The main frame document title of @web_view. - a #WebKitWebView + a #WebKitWebView - Retrieves the #GTlsCertificate associated with the main resource of @web_view, + Retrieves the #GTlsCertificate associated with the main resource of @web_view, and the #GTlsCertificateFlags showing what problems, if any, have been found with that certificate. If the connection is not HTTPS, this function returns %FALSE. @@ -16290,33 +17956,34 @@ server, so you can connect to #WebKitWebView::load-changed and call this functio when it's emitted with %WEBKIT_LOAD_COMMITTED event. Note that this function provides no information about the security of the web -page if the current #WebKitTLSErrorsPolicy is @WEBKIT_TLS_ERRORS_POLICY_IGNORE, +page if the current #WebKitTLSErrorsPolicy is %WEBKIT_TLS_ERRORS_POLICY_IGNORE, as subresources of the page may be controlled by an attacker. This function may safely be used to determine the security status of the current page only -if the current #WebKitTLSErrorsPolicy is @WEBKIT_TLS_ERRORS_POLICY_FAIL, in +if the current #WebKitTLSErrorsPolicy is %WEBKIT_TLS_ERRORS_POLICY_FAIL, in which case subresources that fail certificate verification will be blocked. + - %TRUE if the @web_view connection uses HTTPS and a response has been received + %TRUE if the @web_view connection uses HTTPS and a response has been received from the server, or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - return location for a #GTlsCertificate + return location for a #GTlsCertificate - return location for a #GTlsCertificateFlags the verification status of @certificate + return location for a #GTlsCertificateFlags the verification status of @certificate - - Returns the current active URI of @web_view. The active URI might change during + + Returns the current active URI of @web_view. The active URI might change during a load operation: <orderedlist> @@ -16366,154 +18033,165 @@ a load operation: You can monitor the active URI by connecting to the notify::uri signal of @web_view. + - the current active URI of @web_view or %NULL + the current active URI of @web_view or %NULL if nothing has been loaded yet. - a #WebKitWebView + a #WebKitWebView - - Gets the user content manager associated to @web_view. + + Gets the user content manager associated to @web_view. + - the #WebKitUserContentManager associated with the view + the #WebKitUserContentManager associated with the view - a #WebKitWebView + a #WebKitWebView - Get the #WebKitWebsiteDataManager associated to @web_view. If @web_view is not ephemeral, + Get the #WebKitWebsiteDataManager associated to @web_view. If @web_view is not ephemeral, the returned #WebKitWebsiteDataManager will be the same as the #WebKitWebsiteDataManager of @web_view's #WebKitWebContext. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #WebKitWebView + a #WebKitWebView - - Gets the default website policies set on construction in the + + Gets the default website policies set on construction in the @web_view. These can be overridden on a per-origin basis via the #WebKitWebView::decide-policy signal handler. See also webkit_policy_decision_use_with_policies(). + - the default #WebKitWebsitePolicies + the default #WebKitWebsitePolicies associated with the view. - a #WebKitWebView + a #WebKitWebView - Get the #WebKitWindowProperties object containing the properties + Get the #WebKitWindowProperties object containing the properties that the window containing @web_view should have. + - the #WebKitWindowProperties of @web_view + the #WebKitWindowProperties of @web_view - a #WebKitWebView + a #WebKitWebView - - Get the zoom level of @web_view, i.e. the factor by which the + + Get the zoom level of @web_view, i.e. the factor by which the view contents are scaled with respect to their original size. + - the current zoom level of @web_view + the current zoom level of @web_view - a #WebKitWebView + a #WebKitWebView - Loads the previous history item. + Loads the previous history item. You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - Loads the next history item. + Loads the next history item. You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - Loads the specific history item @list_item. + Loads the specific history item @list_item. You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - a #WebKitBackForwardListItem + a #WebKitBackForwardListItem - Get whether a #WebKitWebView was created with #WebKitWebView:is-controlled-by-automation + Get whether a #WebKitWebView was created with #WebKitWebView:is-controlled-by-automation property enabled. Only #WebKitWebView<!-- -->s controlled by automation can be used in an automation session. + - %TRUE if @web_view is controlled by automation, or %FALSE otherwise. + %TRUE if @web_view is controlled by automation, or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView + @@ -16524,119 +18202,124 @@ automation session. - Get whether a #WebKitWebView is ephemeral. To create an ephemeral #WebKitWebView you need to + Get whether a #WebKitWebView is ephemeral. To create an ephemeral #WebKitWebView you need to use g_object_new() and pass is-ephemeral property with %TRUE value. See #WebKitWebView:is-ephemeral for more details. If @web_view was created with a ephemeral #WebKitWebView:related-view or an ephemeral #WebKitWebView:web-context it will also be ephemeral. + - %TRUE if @web_view is ephemeral or %FALSE otherwise. + %TRUE if @web_view is ephemeral or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - - Gets the value of the #WebKitWebView:is-loading property. + + Gets the value of the #WebKitWebView:is-loading property. You can monitor when a #WebKitWebView is loading a page by connecting to notify::is-loading signal of @web_view. This is useful when you are interesting in knowing when the view is loading something but not in the details about the status of the load operation, for example to start a spinner when the view is loading a page and stop it when it finishes. + - %TRUE if @web_view is loading a page or %FALSE otherwise. + %TRUE if @web_view is loading a page or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - - Gets the value of the #WebKitWebView:is-playing-audio property. + + Gets the value of the #WebKitWebView:is-playing-audio property. You can monitor when a page in a #WebKitWebView is playing audio by connecting to the notify::is-playing-audio signal of @web_view. This is useful when the application wants to provide visual feedback when a page is producing sound. + - %TRUE if a page in @web_view is playing audio or %FALSE otherwise. + %TRUE if a page in @web_view is playing audio or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - Load the given @content string for the URI @content_uri. + Load the given @content string for the URI @content_uri. This allows clients to display page-loading errors in the #WebKitWebView itself. When this method is called from #WebKitWebView::load-failed signal to show an error page, then the back-forward list is maintained appropriately. For everything else this method works the same way as webkit_web_view_load_html(). + - a #WebKitWebView + a #WebKitWebView - the new content to display as the main page of the @web_view + the new content to display as the main page of the @web_view - the URI for the alternate page content + the URI for the alternate page content - the base URI for relative locations or %NULL + the base URI for relative locations or %NULL - Load the specified @bytes into @web_view using the given @mime_type and @encoding. + Load the specified @bytes into @web_view using the given @mime_type and @encoding. When @mime_type is %NULL, it defaults to "text/html". When @encoding is %NULL, it defaults to "UTF-8". When @base_uri is %NULL, it defaults to "about:blank". You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - input data to load + input data to load - the MIME type of @bytes, or %NULL + the MIME type of @bytes, or %NULL - the character encoding of @bytes, or %NULL + the character encoding of @bytes, or %NULL - the base URI for relative locations or %NULL + the base URI for relative locations or %NULL - Load the given @content string with the specified @base_uri. + Load the given @content string with the specified @base_uri. If @base_uri is not %NULL, relative URLs in the @content will be resolved against @base_uri and absolute local paths must be children of the @base_uri. For security reasons absolute local paths that are not children of @base_uri @@ -16645,154 +18328,162 @@ If you need to include URLs in @content that are local paths in a different directory than @base_uri you can build a data URI for them. When @base_uri is %NULL, it defaults to "about:blank". The mime type of the document will be "text/html". You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - The HTML string to load + The HTML string to load - The base URI for relative locations or %NULL + The base URI for relative locations or %NULL - Load the specified @plain_text string into @web_view. The mime type of + Load the specified @plain_text string into @web_view. The mime type of document will be "text/plain". You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - The plain text to load + The plain text to load - Requests loading of the specified #WebKitURIRequest. + Requests loading of the specified #WebKitURIRequest. You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - a #WebKitURIRequest to load + a #WebKitURIRequest to load - Requests loading of the specified URI string. + Requests loading of the specified URI string. You can monitor the load operation by connecting to #WebKitWebView::load-changed signal. + - a #WebKitWebView + a #WebKitWebView - an URI string + an URI string - Reloads the current contents of @web_view. + Reloads the current contents of @web_view. See also webkit_web_view_reload_bypass_cache(). + - a #WebKitWebView + a #WebKitWebView - Reloads the current contents of @web_view without + Reloads the current contents of @web_view without using any cached data. + - a #WebKitWebView + a #WebKitWebView - Restore the @web_view session state from @state + Restore the @web_view session state from @state + - a #WebKitWebView + a #WebKitWebView - a #WebKitWebViewSessionState + a #WebKitWebViewSessionState - Asynchronously run @script in the context of the current page in @web_view. If + Asynchronously run @script in the context of the current page in @web_view. If WebKitSettings:enable-javascript is FALSE, this method will do nothing. When the operation is finished, @callback will be called. You can then call webkit_web_view_run_javascript_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the script to run + the script to run - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the script finished + a #GAsyncReadyCallback to call when the script finished - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_run_javascript(). + Finish an asynchronous operation started with webkit_web_view_run_javascript(). This is an example of using webkit_web_view_run_javascript() with a script returning a string: @@ -16843,287 +18534,298 @@ web_view_get_link_url (WebKitWebView *web_view, g_free (script); } </programlisting></informalexample> + - a #WebKitJavascriptResult with the result of the last executed statement in @script + a #WebKitJavascriptResult with the result of the last executed statement in @script or %NULL in case of error - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Asynchronously run the script from @resource in the context of the + Asynchronously run the script from @resource in the context of the current page in @web_view. When the operation is finished, @callback will be called. You can then call webkit_web_view_run_javascript_from_gresource_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the location of the resource to load + the location of the resource to load - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the script finished + a #GAsyncReadyCallback to call when the script finished - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_run_javascript_from_gresource(). + Finish an asynchronous operation started with webkit_web_view_run_javascript_from_gresource(). Check webkit_web_view_run_javascript_finish() for a usage example. + - a #WebKitJavascriptResult with the result of the last executed statement in @script + a #WebKitJavascriptResult with the result of the last executed statement in @script or %NULL in case of error - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Asynchronously run @script in the script world with name @world_name of the current page context in @web_view. + Asynchronously run @script in the script world with name @world_name of the current page context in @web_view. If WebKitSettings:enable-javascript is FALSE, this method will do nothing. When the operation is finished, @callback will be called. You can then call webkit_web_view_run_javascript_in_world_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the script to run + the script to run - the name of a #WebKitScriptWorld + the name of a #WebKitScriptWorld - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the script finished + a #GAsyncReadyCallback to call when the script finished - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_run_javascript_in_world(). + Finish an asynchronous operation started with webkit_web_view_run_javascript_in_world(). + - a #WebKitJavascriptResult with the result of the last executed statement in @script + a #WebKitJavascriptResult with the result of the last executed statement in @script or %NULL in case of error - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Asynchronously save the current web page associated to the + Asynchronously save the current web page associated to the #WebKitWebView into a self-contained format using the mode specified in @save_mode. When the operation is finished, @callback will be called. You can then call webkit_web_view_save_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the #WebKitSaveMode specifying how the web page should be saved. + the #WebKitSaveMode specifying how the web page should be saved. - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_save(). + Finish an asynchronous operation started with webkit_web_view_save(). + - a #GInputStream with the result of saving + a #GInputStream with the result of saving the current web page or %NULL in case of error. - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Asynchronously save the current web page associated to the + Asynchronously save the current web page associated to the #WebKitWebView into a self-contained format using the mode specified in @save_mode and writing it to @file. When the operation is finished, @callback will be called. You can then call webkit_web_view_save_to_file_finish() to get the result of the operation. + - a #WebKitWebView + a #WebKitWebView - the #GFile where the current web page should be saved to. + the #GFile where the current web page should be saved to. - the #WebKitSaveMode specifying how the web page should be saved. + the #WebKitSaveMode specifying how the web page should be saved. - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_save_to_file(). + Finish an asynchronous operation started with webkit_web_view_save_to_file(). + - %TRUE if the web page was successfully saved to a file or %FALSE otherwise. + %TRUE if the web page was successfully saved to a file or %FALSE otherwise. - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Send @message to the #WebKitWebPage corresponding to @web_view. If @message is floating, it's consumed. + Send @message to the #WebKitWebPage corresponding to @web_view. If @message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @callback. When the operation is finished, @callback will be called. You can then call webkit_web_view_send_message_to_page_finish() to get the message reply. + - a #WebKitWebView + a #WebKitWebView - a #WebKitUserMessage + a #WebKitUserMessage - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - (nullable): A #GAsyncReadyCallback to call when the request is satisfied or %NULL + (nullable): A #GAsyncReadyCallback to call when the request is satisfied or %NULL - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_view_send_message_to_page(). + Finish an asynchronous operation started with webkit_web_view_send_message_to_page(). + - a #WebKitUserMessage with the reply or %NULL in case of error. + a #WebKitUserMessage with the reply or %NULL in case of error. - a #WebKitWebView + a #WebKitWebView - a #GAsyncResult + a #GAsyncResult - Sets the color that will be used to draw the @web_view background before + Sets the color that will be used to draw the @web_view background before the actual contents are rendered. Note that if the web page loaded in @web_view specifies a background color, it will take precedence over the @rgba color. By default the @web_view background color is opaque white. @@ -17148,42 +18850,118 @@ static void browser_window_set_background_color (BrowserWindow *window, webkit_web_view_set_background_color (web_view, rgba); } </programlisting></informalexample> + - a #WebKitWebView + a #WebKitWebView - a #GdkRGBA + a #GdkRGBA - - Sets the current custom character encoding override of @web_view. The custom -character encoding will override any text encoding detected via HTTP headers or -META tags. Calling this method will stop any current load operation and reload the -current page. Setting the custom character encoding to %NULL removes the character -encoding override. + + Set the camera capture state of a #WebKitWebView. + +If #WebKitSettings:enable-mediastream is %FALSE, this method will have no visible effect. Once the +state of the device has been set to %WEBKIT_MEDIA_CAPTURE_STATE_NONE it cannot be changed +anymore. The page can however request capture again using the mediaDevices API. + - a #WebKitWebView + a #WebKitWebView + + + + a #WebKitMediaCaptureState + + + + + + Sets the @allowlist for which +[Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) +checks are disabled in @web_view. URI patterns must be of the form +`[protocol]://[host]/[path]`, each component may contain the wildcard +character (`*`) to represent zero or more other characters. All three +components are required and must not be omitted from the URI +patterns. + +Disabling CORS checks permits resources from other origins to load +allowlisted resources. It does not permit the allowlisted resources +to load resources from other origins. + +If this function is called multiple times, only the allowlist set by +the most recent call will be effective. + + + + + + + a #WebKitWebView + + + + an allowlist of URI patterns, or %NULL + + + + + + + + Sets the current custom character encoding override of @web_view. The custom +character encoding will override any text encoding detected via HTTP headers or +META tags. Calling this method will stop any current load operation and reload the +current page. Setting the custom character encoding to %NULL removes the character +encoding override. + + + + + + + a #WebKitWebView - a character encoding name or %NULL + a character encoding name or %NULL - - Sets whether the user is allowed to edit the HTML document. + + Set the display capture state of a #WebKitWebView. + +If #WebKitSettings:enable-mediastream is %FALSE, this method will have no visible effect. Once the +state of the device has been set to %WEBKIT_MEDIA_CAPTURE_STATE_NONE it cannot be changed +anymore. The page can however request capture again using the mediaDevices API. + + + + + + + a #WebKitWebView + + + + a #WebKitMediaCaptureState + + + + + + Sets whether the user is allowed to edit the HTML document. If @editable is %TRUE, @web_view allows the user to edit the HTML document. If @editable is %FALSE, an element in @web_view's document can only be edited if the @@ -17193,135 +18971,206 @@ elements. By default a #WebKitWebView is not editable. Normally, a HTML document is not editable unless the elements within the document are editable. This function provides a way to make the contents of a #WebKitWebView editable without altering the document or DOM structure. + - a #WebKitWebView + a #WebKitWebView - a #gboolean indicating the editable state + a #gboolean indicating the editable state - Set the #WebKitInputMethodContext to be used by @web_view, or %NULL to not use any input method. + Set the #WebKitInputMethodContext to be used by @web_view, or %NULL to not use any input method. Note that the same #WebKitInputMethodContext can't be set on more than one #WebKitWebView at the same time. + - a #WebKitWebView + a #WebKitWebView - the #WebKitInputMethodContext to set, or %NULL + the #WebKitInputMethodContext to set, or %NULL - - Sets the mute state of @web_view. + + Sets the mute state of @web_view. + - a #WebKitWebView + a #WebKitWebView - mute flag + mute flag - - Sets the #WebKitSettings to be applied to @web_view. The + + Set the microphone capture state of a #WebKitWebView. + +If #WebKitSettings:enable-mediastream is %FALSE, this method will have no visible effect. Once the +state of the device has been set to %WEBKIT_MEDIA_CAPTURE_STATE_NONE it cannot be changed +anymore. The page can however request capture again using the mediaDevices API. + + + + + + + a #WebKitWebView + + + + a #WebKitMediaCaptureState + + + + + + Sets the #WebKitSettings to be applied to @web_view. The existing #WebKitSettings of @web_view will be replaced by @settings. New settings are applied immediately on @web_view. The same #WebKitSettings object can be shared by multiple #WebKitWebView<!-- -->s. + - a #WebKitWebView + a #WebKitWebView - a #WebKitSettings + a #WebKitSettings - - Set the zoom level of @web_view, i.e. the factor by which the + + Set the zoom level of @web_view, i.e. the factor by which the view contents are scaled with respect to their original size. + - a #WebKitWebView + a #WebKitWebView - the zoom level + the zoom level - Stops any ongoing loading operation in @web_view. + Stops any ongoing loading operation in @web_view. This method does nothing if no content is being loaded. If there is a loading operation in progress, it will be cancelled and #WebKitWebView::load-failed signal will be emitted with %WEBKIT_NETWORK_ERROR_CANCELLED error. + - a #WebKitWebView + a #WebKitWebView + + + + + + Terminates the web process associated to @web_view. When the web process gets terminated +using this method, the #WebKitWebView::web-process-terminated signal is emitted with +%WEBKIT_WEB_PROCESS_TERMINATED_BY_API as the reason for termination. + + + + + + + a #WebKitWebView - Tries to close the @web_view. This will fire the onbeforeunload event + Tries to close the @web_view. This will fire the onbeforeunload event to ask the user for confirmation to close the page. If there isn't an onbeforeunload event handler or the user confirms to close the page, the #WebKitWebView::close signal is emitted, otherwise nothing happens. + - a #WebKitWebView + a #WebKitWebView - - The #WebKitAutomationBrowsingContextPresentation of #WebKitWebView. This should only be used when + + The #WebKitAutomationBrowsingContextPresentation of #WebKitWebView. This should only be used when creating a new #WebKitWebView as a response to #WebKitAutomationSession::create-web-view signal request. If the new WebView was added to a new tab of current browsing context window %WEBKIT_AUTOMATION_BROWSING_CONTEXT_PRESENTATION_TAB should be used. - - Whether the pages loaded inside #WebKitWebView are editable. For more + + Capture state of the camera device. Whenever the user grants a media-request sent by the web +page, requesting video capture capabilities (`navigator.mediaDevices.getUserMedia({video: +true})`) this property will be set to %WEBKIT_MEDIA_CAPTURE_STATE_ACTIVE. + +The application can monitor this property and provide a visual indicator allowing to optionally +deactivate or mute the capture device by setting this property respectively to +%WEBKIT_MEDIA_CAPTURE_STATE_NONE or %WEBKIT_MEDIA_CAPTURE_STATE_MUTED. + +If the capture state of the device is set to %WEBKIT_MEDIA_CAPTURE_STATE_NONE the web-page +can still re-request the permission to the user. Permission desision caching is left to the +application. + + + + Capture state of the display device. Whenever the user grants a media-request sent by the web +page, requesting screencasting capabilities (`navigator.mediaDevices.getDisplayMedia() this +property will be set to %WEBKIT_MEDIA_CAPTURE_STATE_ACTIVE. + +The application can monitor this property and provide a visual indicator allowing to +optionally deactivate or mute the capture device by setting this property respectively to +%WEBKIT_MEDIA_CAPTURE_STATE_NONE or %WEBKIT_MEDIA_CAPTURE_STATE_MUTED. + +If the capture state of the device is set to %WEBKIT_MEDIA_CAPTURE_STATE_NONE the web-page +can still re-request the permission to the user. Permission desision caching is left to the +application. + + + + Whether the pages loaded inside #WebKitWebView are editable. For more information see webkit_web_view_set_editable(). - - An estimate of the percent completion for the current loading operation. + + An estimate of the percent completion for the current loading operation. This value will range from 0.0 to 1.0 and, once a load completes, will remain at 1.0 until a new load starts, at which point it will be reset to 0.0. @@ -17330,19 +19179,19 @@ to be received for a document, including all its possible subresources and child documents. - - The favicon currently associated to the #WebKitWebView. + + The favicon currently associated to the #WebKitWebView. See webkit_web_view_get_favicon() for more details. - Whether the #WebKitWebView is controlled by automation. This should only be used when + Whether the #WebKitWebView is controlled by automation. This should only be used when creating a new #WebKitWebView as a response to #WebKitAutomationSession::create-web-view signal request. - Whether the #WebKitWebView is ephemeral. An ephemeral web view never writes + Whether the #WebKitWebView is ephemeral. An ephemeral web view never writes website data to the client storage, no matter what #WebKitWebsiteDataManager its context is using. This is normally used to implement private browsing mode. This is a %G_PARAM_CONSTRUCT_ONLY property, so you have to create an ephemeral @@ -17356,8 +19205,8 @@ will be ephemeral automatically. See also webkit_web_context_new_ephemeral(). - - Whether the #WebKitWebView is currently loading a page. This property becomes + + Whether the #WebKitWebView is currently loading a page. This property becomes %TRUE as soon as a new load operation is requested and before the #WebKitWebView::load-changed signal is emitted with %WEBKIT_LOAD_STARTED and at that point the active URI is the requested one. @@ -17365,56 +19214,74 @@ When the load operation finishes the property is set to %FALSE before #WebKitWebView::load-changed is emitted with %WEBKIT_LOAD_FINISHED. - - Whether the #WebKitWebView audio is muted. When %TRUE, audio is silenced. + + Whether the #WebKitWebView audio is muted. When %TRUE, audio is silenced. It may still be playing, i.e. #WebKitWebView:is-playing-audio may be %TRUE. - - Whether the #WebKitWebView is currently playing audio from a page. + + Whether the #WebKitWebView is currently playing audio from a page. This property becomes %TRUE as soon as web content starts playing any kind of audio. When a page is no longer playing any kind of sound, the property is set back to %FALSE. - - The identifier of the #WebKitWebPage corresponding to the #WebKitWebView. + + Whether the web process currently associated to the #WebKitWebView is responsive. + + + + Capture state of the microphone device. Whenever the user grants a media-request sent by the web +page, requesting audio capture capabilities (`navigator.mediaDevices.getUserMedia({audio: +true})`) this property will be set to %WEBKIT_MEDIA_CAPTURE_STATE_ACTIVE. + +The application can monitor this property and provide a visual indicator allowing to +optionally deactivate or mute the capture device by setting this property respectively to +%WEBKIT_MEDIA_CAPTURE_STATE_NONE or %WEBKIT_MEDIA_CAPTURE_STATE_MUTED. + +If the capture state of the device is set to %WEBKIT_MEDIA_CAPTURE_STATE_NONE the web-page +can still re-request the permission to the user. Permission desision caching is left to the +application. + + + + The identifier of the #WebKitWebPage corresponding to the #WebKitWebView. - The related #WebKitWebView used when creating the view to share the + The related #WebKitWebView used when creating the view to share the same web process. This property is not readable because the related web view is only valid during the object construction. - - The #WebKitSettings of the view. + + The #WebKitSettings of the view. - - The main frame document title of this #WebKitWebView. If + + The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL. - - The current active URI of the #WebKitWebView. + + The current active URI of the #WebKitWebView. See webkit_web_view_get_uri() for more details. - - The #WebKitUserContentManager of the view. + + The #WebKitUserContentManager of the view. - The #WebKitWebContext of the view. + The #WebKitWebContext of the view. - - The #WebKitWebsitePolicies for the view. + + The #WebKitWebsitePolicies for the view. - - The zoom level of the #WebKitWebView content. + + The zoom level of the #WebKitWebView content. See webkit_web_view_set_zoom_level() for more details. @@ -17425,7 +19292,7 @@ See webkit_web_view_set_zoom_level() for more details. - This signal is emitted when the user is challenged with HTTP + This signal is emitted when the user is challenged with HTTP authentication. To let the application access or supply the credentials as well as to allow the client application to either cancel the request or perform the authentication, @@ -17438,19 +19305,19 @@ entirely, connect to this signal and simply return %TRUE. The default signal handler will run a default authentication dialog asynchronously for the user to interact with. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - a #WebKitAuthenticationRequest + a #WebKitAuthenticationRequest - Emitted when closing a #WebKitWebView is requested. This occurs when a + Emitted when closing a #WebKitWebView is requested. This occurs when a call is made from JavaScript's <function>window.close</function> function or after trying to close the @web_view with webkit_web_view_try_close(). It is the owner's responsibility to handle this signal to hide or @@ -17460,7 +19327,7 @@ destroy the #WebKitWebView, if necessary. - Emitted when a context menu is about to be displayed to give the application + Emitted when a context menu is about to be displayed to give the application a chance to customize the proposed menu, prevent the menu from being displayed, or build its own context menu. <itemizedlist> @@ -17510,34 +19377,34 @@ will be shown, if it return %TRUE the context menu will not be shown. The proposed #WebKitContextMenu passed in @context_menu argument is only valid during the signal emission. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the proposed #WebKitContextMenu + the proposed #WebKitContextMenu - the #GdkEvent that triggered the context menu + the #GdkEvent that triggered the context menu - a #WebKitHitTestResult + a #WebKitHitTestResult - Emitted after #WebKitWebView::context-menu signal, if the context menu is shown, + Emitted after #WebKitWebView::context-menu signal, if the context menu is shown, to notify that the context menu is dismissed. - Emitted when the creation of a new #WebKitWebView is requested. + Emitted when the creation of a new #WebKitWebView is requested. If this signal is handled the signal handler should return the newly created #WebKitWebView. @@ -17550,19 +19417,19 @@ webkit_web_view_new_with_related_view() for more details. The new #WebKitWebView should not be displayed to the user until the #WebKitWebView::ready-to-show signal is emitted. - a newly allocated #WebKitWebView widget + a newly allocated #WebKitWebView widget or %NULL to propagate the event further. - a #WebKitNavigationAction + a #WebKitNavigationAction - This signal is emitted when WebKit is requesting the client to decide a policy + This signal is emitted when WebKit is requesting the client to decide a policy decision, such as whether to navigate to a page, open a new window or whether or not to download a resource. The #WebKitNavigationPolicyDecision passed in the @decision argument is a generic type, but should be casted to a more @@ -17604,23 +19471,23 @@ made explicitly, webkit_policy_decision_use() will be the default policy decisio default signal handler will simply call webkit_policy_decision_use(). Only the first policy decision chosen for a given #WebKitPolicyDecision will have any affect. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #WebKitPolicyDecision + the #WebKitPolicyDecision - a #WebKitPolicyDecisionType denoting the type of @decision + a #WebKitPolicyDecisionType denoting the type of @decision - Emitted when JavaScript code calls + Emitted when JavaScript code calls <function>element.webkitRequestFullScreen</function>. If the signal is not handled the #WebKitWebView will proceed to full screen its top level window. This signal can be used by client code to @@ -17629,13 +19496,13 @@ transition and eventually prepare the top-level window (e.g. hide some widgets that would otherwise be part of the full screen window). - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to continue emission of the event. - This signal is emitted when insecure content has been detected + This signal is emitted when insecure content has been detected in a page loaded through a secure connection. This typically means that a external resource from an unstrusted source has been run or displayed, resulting in a mix of HTTPS and @@ -17648,24 +19515,24 @@ of event has been detected (see #WebKitInsecureContentEvent). - the #WebKitInsecureContentEvent + the #WebKitInsecureContentEvent - Emitted when the #WebKitWebView is about to restore its top level + Emitted when the #WebKitWebView is about to restore its top level window out of its full screen state. This signal can be used by client code to restore widgets hidden during the #WebKitWebView::enter-fullscreen stage for instance. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to continue emission of the event. - Emitted when a load operation in @web_view changes. + Emitted when a load operation in @web_view changes. The signal is always emitted with %WEBKIT_LOAD_STARTED when a new load request is made and %WEBKIT_LOAD_FINISHED when the load finishes successfully or due to an error. When the ongoing load @@ -17714,13 +19581,13 @@ static void web_view_load_changed (WebKitWebView *web_view, - the #WebKitLoadEvent + the #WebKitLoadEvent - Emitted when an error occurs during a load operation. + Emitted when an error occurs during a load operation. If the error happened when starting to load data for a page @load_event will be %WEBKIT_LOAD_STARTED. If it happened while loading a committed data source @load_event will be %WEBKIT_LOAD_COMMITTED. @@ -17731,27 +19598,27 @@ WebKitWebView::load-changed will always be emitted with By default, if the signal is not handled, a stock error page will be displayed. You need to handle the signal if you want to provide your own error page. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #WebKitLoadEvent of the load operation + the #WebKitLoadEvent of the load operation - the URI that failed to load + the URI that failed to load - the #GError that was triggered + the #GError that was triggered - Emitted when a TLS error occurs during a load operation. + Emitted when a TLS error occurs during a load operation. To allow an exception for this @certificate and the host of @failing_uri use webkit_web_context_allow_tls_certificate_for_host(). @@ -17761,27 +19628,27 @@ and return %TRUE. If %FALSE is returned, #WebKitWebView::load-failed will be emitted. The load will finish regardless of the returned value. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the URI that failed to load + the URI that failed to load - a #GTlsCertificate + a #GTlsCertificate - a #GTlsCertificateFlags with the verification status of @certificate + a #GTlsCertificateFlags with the verification status of @certificate - This signal is emitted when the mouse cursor moves over an + This signal is emitted when the mouse cursor moves over an element such as a link, image or a media element. To determine what type of element the mouse cursor is over, a Hit Test is performed on the current mouse coordinates and the result is passed in the @@ -17794,17 +19661,17 @@ current element with a new @hit_test_result. - a #WebKitHitTestResult + a #WebKitHitTestResult - a bitmask of #GdkModifierType + a bitmask of #GdkModifierType - This signal is emitted when WebKit is requesting the client to + This signal is emitted when WebKit is requesting the client to decide about a permission request, such as allowing the browser to switch to fullscreen mode, sharing its location or similar operations. @@ -17851,19 +19718,19 @@ by the specific #WebKitPermissionRequest that could allow or deny it. Check the documentation of classes implementing #WebKitPermissionRequest interface to know their default action. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #WebKitPermissionRequest + the #WebKitPermissionRequest - Emitted when printing is requested on @web_view, usually by a JavaScript call, + Emitted when printing is requested on @web_view, usually by a JavaScript call, before the print dialog is shown. This signal can be used to set the initial print settings and page setup of @print_operation to be used as default values in the print dialog. You can call webkit_print_operation_set_print_settings() and @@ -17873,19 +19740,19 @@ event so that the print dialog is shown. You can connect to this signal and return %TRUE to cancel the print operation or implement your own print dialog. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #WebKitPrintOperation that will handle the print request + the #WebKitPrintOperation that will handle the print request - Emitted after #WebKitWebView::create on the newly created #WebKitWebView + Emitted after #WebKitWebView::create on the newly created #WebKitWebView when it should be displayed to the user. When this signal is emitted all the information about how the window should look, including size, position, whether the location, status and scrollbars @@ -17896,7 +19763,7 @@ of @web_view. See also webkit_web_view_get_window_properties(). - Emitted when a new resource is going to be loaded. The @request parameter + Emitted when a new resource is going to be loaded. The @request parameter contains the #WebKitURIRequest that will be sent to the server. You can monitor the load operation by connecting to the different signals of @resource. @@ -17905,17 +19772,17 @@ of @resource. - a #WebKitWebResource + a #WebKitWebResource - a #WebKitURIRequest + a #WebKitURIRequest - Emitted after #WebKitWebView::ready-to-show on the newly + Emitted after #WebKitWebView::ready-to-show on the newly created #WebKitWebView when JavaScript code calls <function>window.showModalDialog</function>. The purpose of this signal is to allow the client application to prepare the @@ -17927,7 +19794,7 @@ main loop will be run to block user interaction in the parent - This signal is emitted when the user interacts with a &lt;input + This signal is emitted when the user interacts with a &lt;input type='color' /&gt; HTML element, requesting from WebKit to show a dialog to select a color. To let the application know the details of the color chooser, as well as to allow the client application to either @@ -17941,19 +19808,19 @@ reference count of the request. The default signal handler will asynchronously run a regular #GtkColorChooser for the user to interact with. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - a #WebKitColorChooserRequest + a #WebKitColorChooserRequest - This signal is emitted when the user interacts with a &lt;input + This signal is emitted when the user interacts with a &lt;input type='file' /&gt; HTML element, requesting from WebKit to show a dialog to select one or more files to be uploaded. To let the application know the details of the file chooser, as well as to @@ -17965,19 +19832,19 @@ argument. The default signal handler will asynchronously run a regular #GtkFileChooserDialog for the user to interact with. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - a #WebKitFileChooserRequest + a #WebKitFileChooserRequest - Emitted when JavaScript code calls <function>window.alert</function>, + Emitted when JavaScript code calls <function>window.alert</function>, <function>window.confirm</function> or <function>window.prompt</function>, or when <function>onbeforeunload</function> event is fired. The @dialog parameter should be used to build the dialog. @@ -18005,61 +19872,67 @@ webkit_script_dialog_close() when done. If the last reference is removed on a #WebKitScriptDialog and the dialog has not been closed, webkit_script_dialog_close() will be called. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - the #WebKitScriptDialog to show + the #WebKitScriptDialog to show - This signal is emitted when a notification should be presented to the + This signal is emitted when a notification should be presented to the user. The @notification is kept alive until either: 1) the web page cancels it or 2) a navigation happens. The default handler will emit a notification using libnotify, if built with support for it. - %TRUE to stop other handlers from being invoked. %FALSE otherwise. + %TRUE to stop other handlers from being invoked. %FALSE otherwise. - a #WebKitNotification + a #WebKitNotification - - This signal is emitted when a select element in @web_view needs to display a + + This signal is emitted when a select element in @web_view needs to display a dropdown menu. This signal can be used to show a custom menu, using @menu to get the details of all items that should be displayed. The area of the element in the #WebKitWebView is given as @rectangle parameter, it can be used to position the -menu. -To handle this signal asynchronously you should keep a ref of the @menu. +menu. If this was triggered by a user interaction, like a mouse click, +@event parameter provides the #GdkEvent. +To handle this signal asynchronously you should keep a ref of the @menu. + +The default signal handler will pop up a #GtkMenu. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - + + the #WebKitOptionMenu - + + the #GdkEvent that triggered the menu, or %NULL - + + the option element area - This signal is emitted when a form is about to be submitted. The @request + This signal is emitted when a form is about to be submitted. The @request argument passed contains information about the text fields of the form. This is typically used to store login information that can be used later to pre-fill the form. @@ -18075,13 +19948,13 @@ form has not been submitted, webkit_form_submission_request_submit() will be cal - a #WebKitFormSubmissionRequest + a #WebKitFormSubmissionRequest - This signal is emitted when a #WebKitUserMessage is received from the + This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebPage corresponding to @web_view. You can reply to the message using webkit_user_message_send_reply(). @@ -18090,40 +19963,41 @@ You can handle the user message asynchronously by calling g_object_ref() on and the message has not been replied to, the operation in the #WebKitWebPage will finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. - %TRUE if the message was handled, or %FALSE otherwise. + %TRUE if the message was handled, or %FALSE otherwise. - the #WebKitUserMessage received + the #WebKitUserMessage received - This signal is emitted when the web process crashes. + This signal is emitted when the web process crashes. Use WebKitWebView::web-process-terminated instead. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. - This signal is emitted when the web process terminates abnormally due + This signal is emitted when the web process terminates abnormally due to @reason. - the a #WebKitWebProcessTerminationReason + the a #WebKitWebProcessTerminationReason + @@ -18134,11 +20008,13 @@ to @reason. + + @@ -18146,6 +20022,7 @@ to @reason. + @@ -18153,6 +20030,7 @@ to @reason. + @@ -18160,19 +20038,24 @@ to @reason. + - + + + + + @@ -18188,6 +20071,7 @@ to @reason. + @@ -18209,6 +20093,7 @@ to @reason. + @@ -18224,6 +20109,7 @@ to @reason. + @@ -18236,6 +20122,7 @@ to @reason. + @@ -18248,6 +20135,7 @@ to @reason. + @@ -18260,6 +20148,7 @@ to @reason. + @@ -18275,6 +20164,7 @@ to @reason. + @@ -18293,6 +20183,7 @@ to @reason. + @@ -18308,6 +20199,7 @@ to @reason. + @@ -18326,6 +20218,7 @@ to @reason. + @@ -18341,6 +20234,7 @@ to @reason. + @@ -18359,6 +20253,7 @@ to @reason. + @@ -18371,6 +20266,7 @@ to @reason. + @@ -18383,6 +20279,7 @@ to @reason. + @@ -18398,6 +20295,7 @@ to @reason. + @@ -18419,6 +20317,7 @@ to @reason. + @@ -18431,6 +20330,7 @@ to @reason. + @@ -18446,6 +20346,7 @@ to @reason. + @@ -18461,6 +20362,7 @@ to @reason. + @@ -18473,6 +20375,7 @@ to @reason. + @@ -18488,6 +20391,7 @@ to @reason. + @@ -18509,6 +20413,7 @@ to @reason. + @@ -18524,6 +20429,7 @@ to @reason. + @@ -18539,6 +20445,7 @@ to @reason. + @@ -18557,6 +20464,7 @@ to @reason. + @@ -18572,6 +20480,7 @@ to @reason. + @@ -18587,173 +20496,190 @@ to @reason. + - + + + + - Creates a new #WebKitWebViewSessionState from serialized data. + Creates a new #WebKitWebViewSessionState from serialized data. + - a new #WebKitWebViewSessionState, or %NULL if @data doesn't contain a + a new #WebKitWebViewSessionState, or %NULL if @data doesn't contain a valid serialized #WebKitWebViewSessionState. - a #GBytes + a #GBytes - Atomically increments the reference count of @state by one. This + Atomically increments the reference count of @state by one. This function is MT-safe and may be called from any thread. + - The passed in #WebKitWebViewSessionState + The passed in #WebKitWebViewSessionState - a #WebKitWebViewSessionState + a #WebKitWebViewSessionState - Serializes a #WebKitWebViewSessionState. + Serializes a #WebKitWebViewSessionState. + - a #GBytes containing the @state serialized. + a #GBytes containing the @state serialized. - a #WebKitWebViewSessionState + a #WebKitWebViewSessionState - Atomically decrements the reference count of @state by one. If the + Atomically decrements the reference count of @state by one. If the reference count drops to 0, all memory allocated by the #WebKitWebViewSessionState is released. This function is MT-safe and may be called from any thread. + - a #WebKitWebViewSessionState + a #WebKitWebViewSessionState + - Gets the name of #WebKitWebsiteData. This is the website name, normally represented by + Gets the name of #WebKitWebsiteData. This is the website name, normally represented by a domain or host name. All local documents are grouped in the same #WebKitWebsiteData using the name "Local files". + - the website name of @website_data. + the website name of @website_data. - a #WebKitWebsiteData + a #WebKitWebsiteData - Gets the size of the data of types @types in a #WebKitWebsiteData. + Gets the size of the data of types @types in a #WebKitWebsiteData. Note that currently the data size is only known for %WEBKIT_WEBSITE_DATA_DISK_CACHE data type so for all other types 0 will be returned. + - the size of @website_data for the given @types. + the size of @website_data for the given @types. - a #WebKitWebsiteData + a #WebKitWebsiteData - a bitmask of #WebKitWebsiteDataTypes + a bitmask of #WebKitWebsiteDataTypes - Gets the types of data stored in the client for a #WebKitWebsiteData. These are the + Gets the types of data stored in the client for a #WebKitWebsiteData. These are the types actually present, not the types queried with webkit_website_data_manager_fetch(). + - a bitmask of #WebKitWebsiteDataTypes in @website_data + a bitmask of #WebKitWebsiteDataTypes in @website_data - a #WebKitWebsiteData + a #WebKitWebsiteData - Atomically increments the reference count of @website_data by one. + Atomically increments the reference count of @website_data by one. This function is MT-safe and may be called from any thread. + - The passed #WebKitWebsiteData + The passed #WebKitWebsiteData - a #WebKitWebsiteData + a #WebKitWebsiteData - Atomically decrements the reference count of @website_data by one. + Atomically decrements the reference count of @website_data by one. If the reference count drops to 0, all memory allocated by #WebKitWebsiteData is released. This function is MT-safe and may be called from any thread. + - A #WebKitWebsiteData + A #WebKitWebsiteData + - Get the current domain being browsed. + Get the current domain being browsed. + - the current domain name + the current domain name - a #WebKitWebsiteDataAccessPermissionRequest + a #WebKitWebsiteDataAccessPermissionRequest - Get the domain requesting permission to access its cookies while browsing the current domain. + Get the domain requesting permission to access its cookies while browsing the current domain. + - the requesting domain name + the requesting domain name - a #WebKitWebsiteDataAccessPermissionRequest + a #WebKitWebsiteDataAccessPermissionRequest @@ -18766,11 +20692,13 @@ called from any thread. + + @@ -18778,6 +20706,7 @@ called from any thread. + @@ -18785,6 +20714,7 @@ called from any thread. + @@ -18792,41 +20722,70 @@ called from any thread. + - + + + + - Creates a new #WebKitWebsiteDataManager with the given options. It must + Creates a new #WebKitWebsiteDataManager with the given options. It must be passed as construction parameter of a #WebKitWebContext. + - the newly created #WebKitWebsiteDataManager + the newly created #WebKitWebsiteDataManager - name of the first option to set + name of the first option to set - value of first option, followed by more options, %NULL-terminated + value of first option, followed by more options, %NULL-terminated - Creates an ephemeral #WebKitWebsiteDataManager. See #WebKitWebsiteDataManager:is-ephemeral for more details. + Creates an ephemeral #WebKitWebsiteDataManager. See #WebKitWebsiteDataManager:is-ephemeral for more details. + - a new ephemeral #WebKitWebsiteDataManager. + a new ephemeral #WebKitWebsiteDataManager. + + Sets @settings as the #WebKitMemoryPressureSettings to be used by all the network +processes created by any instance of #WebKitWebsiteDataManager after this function +is called. + +Be sure to call this function before creating any #WebKitWebsiteDataManager, as network +processes of existing instances are not guaranteed to receive the passed settings. + +The periodic check for used memory is disabled by default on network processes. This will +be enabled only if custom settings have been set using this function. After that, in order +to remove the custom settings and disable the periodic check, this function must be called +passing %NULL as the value of @settings. + + + + + + + a WebKitMemoryPressureSettings. + + + + - Asynchronously clear the website data of the given @types modified in the past @timespan. + Asynchronously clear the website data of the given @types modified in the past @timespan. If @timespan is 0, all website data will be removed. When the operation is finished, @callback will be called. You can then call @@ -18835,88 +20794,92 @@ webkit_website_data_manager_clear_finish() to get the result of the operation. Due to implementation limitations, this function does not currently delete any stored cookies if @timespan is nonzero. This behavior may change in the future. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - #WebKitWebsiteDataTypes + #WebKitWebsiteDataTypes - a #GTimeSpan + a #GTimeSpan - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_website_data_manager_clear() + Finish an asynchronous operation started with webkit_website_data_manager_clear() + - %TRUE if website data was successfully cleared, or %FALSE otherwise. + %TRUE if website data was successfully cleared, or %FALSE otherwise. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #GAsyncResult + a #GAsyncResult - Asynchronously get the list of #WebKitWebsiteData for the given @types. + Asynchronously get the list of #WebKitWebsiteData for the given @types. When the operation is finished, @callback will be called. You can then call webkit_website_data_manager_fetch_finish() to get the result of the operation. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - #WebKitWebsiteDataTypes + #WebKitWebsiteDataTypes - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_website_data_manager_fetch(). + Finish an asynchronous operation started with webkit_website_data_manager_fetch(). + - a #GList of #WebKitWebsiteData. You must free the #GList with + a #GList of #WebKitWebsiteData. You must free the #GList with g_list_free() and unref the #WebKitWebsiteData<!-- -->s with webkit_website_data_unref() when you're done with them. @@ -18924,166 +20887,177 @@ webkit_website_data_manager_fetch_finish() to get the result of the operation. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #GAsyncResult + a #GAsyncResult - - Get the #WebKitWebsiteDataManager:base-cache-directory property. + + Get the #WebKitWebsiteDataManager:base-cache-directory property. + - the base directory for Website cache, or %NULL if + the base directory for Website cache, or %NULL if #WebKitWebsiteDataManager:base-cache-directory was not provided or @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:base-data-directory property. + + Get the #WebKitWebsiteDataManager:base-data-directory property. + - the base directory for Website data, or %NULL if + the base directory for Website data, or %NULL if #WebKitWebsiteDataManager:base-data-directory was not provided or @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Get the #WebKitCookieManager of @manager. + Get the #WebKitCookieManager of @manager. + - a #WebKitCookieManager + a #WebKitCookieManager - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:disk-cache-directory property. + + Get the #WebKitWebsiteDataManager:disk-cache-directory property. + - the directory where HTTP disk cache is stored or %NULL if @manager is ephemeral. + the directory where HTTP disk cache is stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:dom-cache-directory property. + + Get the #WebKitWebsiteDataManager:dom-cache-directory property. + - the directory where DOM cache is stored or %NULL if @manager is ephemeral. + the directory where DOM cache is stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:hsts-cache-directory property. + + Get the #WebKitWebsiteDataManager:hsts-cache-directory property. + - the directory where the HSTS cache is stored or %NULL if @manager is ephemeral. + the directory where the HSTS cache is stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:indexeddb-directory property. + + Get the #WebKitWebsiteDataManager:indexeddb-directory property. + - the directory where IndexedDB databases are stored or %NULL if @manager is ephemeral. + the directory where IndexedDB databases are stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:itp-directory property. + + Get the #WebKitWebsiteDataManager:itp-directory property. + - the directory where Intelligent Tracking Prevention data is stored or %NULL if @manager is ephemeral. + the directory where Intelligent Tracking Prevention data is stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Get whether Intelligent Tracking Prevention (ITP) is enabled or not. + Get whether Intelligent Tracking Prevention (ITP) is enabled or not. + - %TRUE if ITP is enabled, or %FALSE otherwise. + %TRUE if ITP is enabled, or %FALSE otherwise. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Asynchronously get the list of #WebKitITPThirdParty seen for @manager. Every #WebKitITPThirdParty + Asynchronously get the list of #WebKitITPThirdParty seen for @manager. Every #WebKitITPThirdParty contains the list of #WebKitITPFirstParty under which it has been seen. When the operation is finished, @callback will be called. You can then call webkit_website_data_manager_get_itp_summary_finish() to get the result of the operation. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_website_data_manager_get_itp_summary(). + Finish an asynchronous operation started with webkit_website_data_manager_get_itp_summary(). + - a #GList of #WebKitITPThirdParty. + a #GList of #WebKitITPThirdParty. You must free the #GList with g_list_free() and unref the #WebKitITPThirdParty<!-- -->s with webkit_itp_third_party_unref() when you're done with them. @@ -19092,184 +21066,194 @@ webkit_website_data_manager_get_itp_summary_finish() to get the result of the op - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #GAsyncResult + a #GAsyncResult - - Get the #WebKitWebsiteDataManager:local-storage-directory property. + + Get the #WebKitWebsiteDataManager:local-storage-directory property. + - the directory where local storage data is stored or %NULL if @manager is ephemeral. + the directory where local storage data is stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:offline-application-cache-directory property. + + Get the #WebKitWebsiteDataManager:offline-application-cache-directory property. + - the directory where offline web application cache is stored or %NULL if @manager is ephemeral. + the directory where offline web application cache is stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Get whether persistent credential storage is enabled or not. + Get whether persistent credential storage is enabled or not. See also webkit_website_data_manager_set_persistent_credential_storage_enabled(). + - %TRUE if persistent credential storage is enabled, or %FALSE otherwise. + %TRUE if persistent credential storage is enabled, or %FALSE otherwise. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:service-worker-registrations-directory property. + + Get the #WebKitWebsiteDataManager:service-worker-registrations-directory property. + - the directory where service worker registrations are stored or %NULL if @manager is ephemeral. + the directory where service worker registrations are stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Get the TLS errors policy of @manager + Get the TLS errors policy of @manager + - a #WebKitTLSErrorsPolicy + a #WebKitTLSErrorsPolicy - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - - Get the #WebKitWebsiteDataManager:websql-directory property. + + Get the #WebKitWebsiteDataManager:websql-directory property. WebSQL is no longer supported. Use IndexedDB instead. + - the directory where WebSQL databases are stored or %NULL if @manager is ephemeral. + the directory where WebSQL databases are stored or %NULL if @manager is ephemeral. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Get whether a #WebKitWebsiteDataManager is ephemeral. See #WebKitWebsiteDataManager:is-ephemeral for more details. + Get whether a #WebKitWebsiteDataManager is ephemeral. See #WebKitWebsiteDataManager:is-ephemeral for more details. + - %TRUE if @manager is ephemeral or %FALSE otherwise. + %TRUE if @manager is ephemeral or %FALSE otherwise. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - Asynchronously removes the website data of the for the given @types for websites in the given @website_data list. + Asynchronously removes the website data of the for the given @types for websites in the given @website_data list. Use webkit_website_data_manager_clear() if you want to remove the website data for all sites. When the operation is finished, @callback will be called. You can then call webkit_website_data_manager_remove_finish() to get the result of the operation. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - #WebKitWebsiteDataTypes + #WebKitWebsiteDataTypes - a #GList of #WebKitWebsiteData + a #GList of #WebKitWebsiteData - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_website_data_manager_remove(). + Finish an asynchronous operation started with webkit_website_data_manager_remove(). + - %TRUE if website data resources were successfully removed, or %FALSE otherwise. + %TRUE if website data resources were successfully removed, or %FALSE otherwise. - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #GAsyncResult + a #GAsyncResult - Enable or disable Intelligent Tracking Prevention (ITP). When ITP is enabled resource load statistics + Enable or disable Intelligent Tracking Prevention (ITP). When ITP is enabled resource load statistics are collected and used to decide whether to allow or block third-party cookies and prevent user tracking. Note that while ITP is enabled the accept policy %WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY is ignored and %WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS is used instead. See also webkit_cookie_manager_set_accept_policy(). + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - value to set + value to set - Set the network proxy settings to be used by connections started in @manager session. + Set the network proxy settings to be used by connections started in @manager session. By default %WEBKIT_NETWORK_PROXY_MODE_DEFAULT is used, which means that the system settings will be used (g_proxy_resolver_get_default()). If you want to override the system default settings, you can either use @@ -19277,109 +21261,112 @@ If you want to override the system default settings, you can either use or %WEBKIT_NETWORK_PROXY_MODE_CUSTOM to provide your own proxy settings. When @proxy_mode is %WEBKIT_NETWORK_PROXY_MODE_CUSTOM @proxy_settings must be a valid #WebKitNetworkProxySettings; otherwise, @proxy_settings must be %NULL. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #WebKitNetworkProxyMode + a #WebKitNetworkProxyMode - a #WebKitNetworkProxySettings, or %NULL + a #WebKitNetworkProxySettings, or %NULL - Enable or disable persistent credential storage. When enabled, which is the default for + Enable or disable persistent credential storage. When enabled, which is the default for non-ephemeral sessions, the network process will try to read and write HTTP authentiacation credentials from persistent storage. + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - value to set + value to set - Set the TLS errors policy of @manager as @policy + Set the TLS errors policy of @manager as @policy + - a #WebKitWebsiteDataManager + a #WebKitWebsiteDataManager - a #WebKitTLSErrorsPolicy + a #WebKitTLSErrorsPolicy - - The base directory for Website cache. This is used as a base directory + + The base directory for Website cache. This is used as a base directory for any Website cache when no specific cache directory has been provided. - - The base directory for Website data. This is used as a base directory + + The base directory for Website data. This is used as a base directory for any Website data when no specific data directory has been provided. - - The directory where HTTP disk cache will be stored. + + The directory where HTTP disk cache will be stored. - - The directory where DOM cache will be stored. + + The directory where DOM cache will be stored. - - The directory where the HTTP Strict-Transport-Security (HSTS) cache will be stored. + + The directory where the HTTP Strict-Transport-Security (HSTS) cache will be stored. - - The directory where IndexedDB databases will be stored. + + The directory where IndexedDB databases will be stored. - Whether the #WebKitWebsiteDataManager is ephemeral. An ephemeral #WebKitWebsiteDataManager + Whether the #WebKitWebsiteDataManager is ephemeral. An ephemeral #WebKitWebsiteDataManager handles all websites data as non-persistent, and nothing will be written to the client storage. Note that if you create an ephemeral #WebKitWebsiteDataManager all other construction parameters to configure data directories will be ignored. - - The directory where Intelligent Tracking Prevention (ITP) data will be stored. + + The directory where Intelligent Tracking Prevention (ITP) data will be stored. - - The directory where local storage data will be stored. + + The directory where local storage data will be stored. - - The directory where offline web application cache will be stored. + + The directory where offline web application cache will be stored. - - The directory where service workers registrations will be stored. + + The directory where service workers registrations will be stored. - - The directory where WebSQL databases will be stored. + + The directory where WebSQL databases will be stored. WebSQL is no longer supported. Use IndexedDB instead. @@ -19391,11 +21378,13 @@ parameters to configure data directories will be ignored. + + @@ -19403,6 +21392,7 @@ parameters to configure data directories will be ignored. + @@ -19410,6 +21400,7 @@ parameters to configure data directories will be ignored. + @@ -19417,74 +21408,80 @@ parameters to configure data directories will be ignored. + - + + + - Enum values with flags representing types of Website data. - - Memory cache. + Enum values with flags representing types of Website data. + + Memory cache. - - HTTP disk cache. + + HTTP disk cache. - - Offline web application cache. + + Offline web application cache. - - Session storage data. + + Session storage data. - - Local storage data. + + Local storage data. - - WebSQL databases. Deprecated 2.24 + + WebSQL databases. Deprecated 2.24 - - IndexedDB databases. + + IndexedDB databases. - - Plugins data. Deprecated 2.32 + + Plugins data. Deprecated 2.32 - - Cookies. + + Cookies. - - Hash salt used to generate the device ids used by webpages. Since 2.24 + + Hash salt used to generate the device ids used by webpages. Since 2.24 - - HSTS cache. Since 2.26 + + HSTS cache. Since 2.26 - - Intelligent Tracking Prevention data. Since 2.30. + + Intelligent Tracking Prevention data. Since 2.30. - - Service worker registrations. Since 2.30 + + Service worker registrations. Since 2.30 - - DOM (CacheStorage) cache. Since 2.30 + + DOM (CacheStorage) cache. Since 2.30 - - All types. + + All types. + - Create a new #WebKitWebsitePolicies + Create a new #WebKitWebsitePolicies + - the newly created #WebKitWebsitePolicies + the newly created #WebKitWebsitePolicies - Create a new #WebKitWebsitePolicies with policies given as variadic + Create a new #WebKitWebsitePolicies with policies given as variadic arguments. + - the newly created #WebKitWebsitePolicies + the newly created #WebKitWebsitePolicies <informalexample><programlisting> WebKitWebsitePolicies *default_website_policies = webkit_website_policies_new_with_policies( @@ -19503,30 +21500,31 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, - name of the first policy to set + name of the first policy to set - value of first policy, followed by more policies, %NULL-terminated + value of first policy, followed by more policies, %NULL-terminated - Get the #WebKitWebsitePolicies:autoplay property. + Get the #WebKitWebsitePolicies:autoplay property. + - #WebKitAutoplayPolicy + #WebKitAutoplayPolicy - a #WebKitWebsitePolicies + a #WebKitWebsitePolicies - The #WebKitAutoplayPolicy of #WebKitWebsitePolicies. + The #WebKitAutoplayPolicy of #WebKitWebsitePolicies. @@ -19537,11 +21535,13 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + + @@ -19549,6 +21549,7 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + @@ -19556,6 +21557,7 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + @@ -19563,143 +21565,155 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + - + + + - - Get whether the window should be shown in fullscreen state or not. + + + Get whether the window should be shown in fullscreen state or not. + - %TRUE if the window should be fullscreen or %FALSE otherwise. + %TRUE if the window should be fullscreen or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - - Get the geometry the window should have on the screen when shown. + + Get the geometry the window should have on the screen when shown. + - a #WebKitWindowProperties + a #WebKitWindowProperties - return location for the window geometry + return location for the window geometry - - Get whether the window should have the locationbar visible or not. + + Get whether the window should have the locationbar visible or not. + - %TRUE if locationbar should be visible or %FALSE otherwise. + %TRUE if locationbar should be visible or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - - Get whether the window should have the menubar visible or not. + + Get whether the window should have the menubar visible or not. + - %TRUE if menubar should be visible or %FALSE otherwise. + %TRUE if menubar should be visible or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - - Get whether the window should be resizable by the user or not. + + Get whether the window should be resizable by the user or not. + - %TRUE if the window should be resizable or %FALSE otherwise. + %TRUE if the window should be resizable or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - - Get whether the window should have the scrollbars visible or not. + + Get whether the window should have the scrollbars visible or not. + - %TRUE if scrollbars should be visible or %FALSE otherwise. + %TRUE if scrollbars should be visible or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - - Get whether the window should have the statusbar visible or not. + + Get whether the window should have the statusbar visible or not. + - %TRUE if statusbar should be visible or %FALSE otherwise. + %TRUE if statusbar should be visible or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - - Get whether the window should have the toolbar visible or not. + + Get whether the window should have the toolbar visible or not. + - %TRUE if toolbar should be visible or %FALSE otherwise. + %TRUE if toolbar should be visible or %FALSE otherwise. - a #WebKitWindowProperties + a #WebKitWindowProperties - + - + - + - + - + - + - + - + @@ -19710,11 +21724,13 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + + @@ -19722,6 +21738,7 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + @@ -19729,6 +21746,7 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + @@ -19736,13 +21754,16 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, + - + + + @@ -19754,41 +21775,44 @@ WebKitWebView *view = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW, - Returns the major version number of the WebKit library. + Returns the major version number of the WebKit library. (e.g. in WebKit version 1.8.3 this is 1.) This function is in the library, so it represents the WebKit library your code is running against. Contrast with the #WEBKIT_MAJOR_VERSION macro, which represents the major version of the WebKit headers you have included when compiling your code. + - the major version number of the WebKit library + the major version number of the WebKit library - Returns the micro version number of the WebKit library. + Returns the micro version number of the WebKit library. (e.g. in WebKit version 1.8.3 this is 3.) This function is in the library, so it represents the WebKit library your code is running against. Contrast with the #WEBKIT_MICRO_VERSION macro, which represents the micro version of the WebKit headers you have included when compiling your code. + - the micro version number of the WebKit library + the micro version number of the WebKit library - Returns the minor version number of the WebKit library. + Returns the minor version number of the WebKit library. (e.g. in WebKit version 1.8.3 this is 8.) This function is in the library, so it represents the WebKit library your code is running against. Contrast with the #WEBKIT_MINOR_VERSION macro, which represents the minor version of the WebKit headers you have included when compiling your code. + - the minor version number of the WebKit library + the minor version number of the WebKit library @@ -19798,14 +21822,15 @@ have included when compiling your code. - Get the key system for which access permission is being requested. + Get the key system for which access permission is being requested. + - the key system name for @request + the key system name for @request - a #WebKitMediaKeySystemPermissionRequest + a #WebKitMediaKeySystemPermissionRequest @@ -19836,19 +21861,20 @@ have included when compiling your code. - Use this function to format a URI for display. The URIs used internally by + Use this function to format a URI for display. The URIs used internally by WebKit may contain percent-encoded characters or Punycode, which are not generally suitable to display to users. This function provides protection against IDN homograph attacks, so in some cases the host part of the returned URI may be in Punycode if the safety check fails. + - @uri suitable for display, or %NULL in + @uri suitable for display, or %NULL in case of error. - the URI to be converted + the URI to be converted @@ -19859,25 +21885,40 @@ URI may be in Punycode if the safety check fails. + - %TRUE if access to an audio device was requested. + %TRUE if access to an audio device was requested. - a #WebKitUserMediaPermissionRequest + a #WebKitUserMediaPermissionRequest + + + + + + + + %TRUE if access to a display device was requested. + + + + + a #WebKitUserMediaPermissionRequest + - %TRUE if access to a video device was requested. + %TRUE if access to a video device was requested. - a #WebKitUserMediaPermissionRequest + a #WebKitUserMediaPermissionRequest diff --git a/WebKit2WebExtension-4.0.gir b/WebKit2WebExtension-4.0.gir index e61aafe..f9931d8 100644 --- a/WebKit2WebExtension-4.0.gir +++ b/WebKit2WebExtension-4.0.gir @@ -11,194 +11,211 @@ and/or use gtk-doc annotations. --> + + + + + + + - Make a copy of @console_message. + Make a copy of @console_message. + - A copy of passed in #WebKitConsoleMessage + A copy of passed in #WebKitConsoleMessage - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Free the #WebKitConsoleMessage + Free the #WebKitConsoleMessage + - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Gets the log level of a #WebKitConsoleMessage + Gets the log level of a #WebKitConsoleMessage + - a #WebKitConsoleMessageLevel indicating the log level of @console_message + a #WebKitConsoleMessageLevel indicating the log level of @console_message - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Gets the line number of a #WebKitConsoleMessage + Gets the line number of a #WebKitConsoleMessage + - the line number of @console_message + the line number of @console_message - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Gets the source of a #WebKitConsoleMessage + Gets the source of a #WebKitConsoleMessage + - a #WebKitConsoleMessageSource indicating the source of @console_message + a #WebKitConsoleMessageSource indicating the source of @console_message - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Gets the source identifier of a #WebKitConsoleMessage + Gets the source identifier of a #WebKitConsoleMessage + - the source identifier of @console_message + the source identifier of @console_message - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Gets the text message of a #WebKitConsoleMessage + Gets the text message of a #WebKitConsoleMessage + - the text message of @console_message + the text message of @console_message - a #WebKitConsoleMessage + a #WebKitConsoleMessage - Enum values used to denote the various levels of console messages. - - Information message. + Enum values used to denote the various levels of console messages. + + Information message. - - Log message. + + Log message. - - Warning message. + + Warning message. - - Error message. + + Error message. - - Debug message. + + Debug message. - Enum values used to denote the various sources of console messages. - - Message produced by JavaScript. + Enum values used to denote the various sources of console messages. + + Message produced by JavaScript. - - Network messages. + + Network messages. - - Messages produced by console API. + + Messages produced by console API. - - Security messages. + + Security messages. - - Other messages. + + Other messages. + - Creates a new #WebKitContextMenu object to be used as a submenu of an existing + Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view and passed as an argument of #WebKitWebView::context-menu signal. To add items to the menu use webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(). See also webkit_context_menu_new_with_items() to create a #WebKitContextMenu with a list of initial items. + - The newly created #WebKitContextMenu object + The newly created #WebKitContextMenu object - Creates a new #WebKitContextMenu object to be used as a submenu of an existing + Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu with the given initial items. See also webkit_context_menu_new() + - The newly created #WebKitContextMenu object + The newly created #WebKitContextMenu object - a #GList of #WebKitContextMenuItem + a #GList of #WebKitContextMenuItem @@ -206,57 +223,61 @@ See also webkit_context_menu_new() - Adds @item at the end of the @menu. + Adds @item at the end of the @menu. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - Gets the first item in the @menu. + Gets the first item in the @menu. + - the first #WebKitContextMenuItem of @menu, + the first #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. - a #WebKitContextMenu + a #WebKitContextMenu - Gets the item at the given position in the @menu. + Gets the item at the given position in the @menu. + - the #WebKitContextMenuItem at position @position in @menu, + the #WebKitContextMenuItem at position @position in @menu, or %NULL if the position is off the end of the @menu. - a #WebKitContextMenu + a #WebKitContextMenu - the position of the item, counting from 0 + the position of the item, counting from 0 - Returns the item list of @menu. + Returns the item list of @menu. + - a #GList of + a #GList of #WebKitContextMenuItem<!-- -->s @@ -264,316 +285,328 @@ See also webkit_context_menu_new() - a #WebKitContextMenu + a #WebKitContextMenu - Gets the length of the @menu. + Gets the length of the @menu. + - the number of #WebKitContextMenuItem<!-- -->s in @menu + the number of #WebKitContextMenuItem<!-- -->s in @menu - a #WebKitContextMenu + a #WebKitContextMenu - Gets the user data of @menu. + Gets the user data of @menu. This function can be used from the UI Process to get user data previously set from the Web Process with webkit_context_menu_set_user_data(). + - the user data of @menu, or %NULL if @menu doesn't have user data + the user data of @menu, or %NULL if @menu doesn't have user data - a #WebKitContextMenu + a #WebKitContextMenu - Inserts @item into the @menu at the given position. + Inserts @item into the @menu at the given position. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - the position to insert the item + the position to insert the item - Gets the last item in the @menu. + Gets the last item in the @menu. + - the last #WebKitContextMenuItem of @menu, + the last #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. - a #WebKitContextMenu + a #WebKitContextMenu - Moves @item to the given position in the @menu. + Moves @item to the given position in the @menu. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - the new position to move the item + the new position to move the item - Adds @item at the beginning of the @menu. + Adds @item at the beginning of the @menu. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to add + the #WebKitContextMenuItem to add - Removes @item from the @menu. + Removes @item from the @menu. See also webkit_context_menu_remove_all() to remove all items. + - a #WebKitContextMenu + a #WebKitContextMenu - the #WebKitContextMenuItem to remove + the #WebKitContextMenuItem to remove - Removes all items of the @menu. + Removes all items of the @menu. + - a #WebKitContextMenu + a #WebKitContextMenu - Sets user data to @menu. + Sets user data to @menu. This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using webkit_context_menu_get_user_data(). If the @user_data #GVariant is floating, it is consumed. + - a #WebKitContextMenu + a #WebKitContextMenu - a #GVariant + a #GVariant - Enum values used to denote the stock actions for + Enum values used to denote the stock actions for #WebKitContextMenuItem<!-- -->s + - No action, used by separator menu items. + No action, used by separator menu items. - Open current link. + Open current link. - Open current link in a new window. + Open current link in a new window. - Download link destination. + Download link destination. - Copy link location to the clipboard. + Copy link location to the clipboard. - Open current image in a new window. + Open current image in a new window. - Download current image. + Download current image. - Copy current image to the clipboard. + Copy current image to the clipboard. - Copy current image location to the clipboard. + Copy current image location to the clipboard. - Open current frame in a new window. + Open current frame in a new window. - Load the previous history item. + Load the previous history item. - Load the next history item. + Load the next history item. - Stop any ongoing loading operation. + Stop any ongoing loading operation. - Reload the contents of current view. + Reload the contents of current view. - Copy current selection the clipboard. + Copy current selection the clipboard. - Cut current selection to the clipboard. + Cut current selection to the clipboard. - Paste clipboard contents. + Paste clipboard contents. - Delete current selection. + Delete current selection. - Select all text. + Select all text. - Input methods menu. + Input methods menu. - Unicode menu. + Unicode menu. - A proposed replacement for a misspelled word. + A proposed replacement for a misspelled word. - An indicator that spellchecking found no proposed replacements. + An indicator that spellchecking found no proposed replacements. - Causes the spellchecker to ignore the word for this session. + Causes the spellchecker to ignore the word for this session. - Causes the spellchecker to add the word to the dictionary. + Causes the spellchecker to add the word to the dictionary. - Ignore grammar. + Ignore grammar. - Font options menu. + Font options menu. - Bold. + Bold. - Italic. + Italic. - Underline. + Underline. - Outline. + Outline. - Open current element in the inspector. + Open current element in the inspector. - Open current video element in a new window. + Open current video element in a new window. - Open current audio element in a new window. + Open current audio element in a new window. - Copy video link location in to the clipboard. + Copy video link location in to the clipboard. - Copy audio link location in to the clipboard. + Copy audio link location in to the clipboard. - Enable or disable media controls. + Enable or disable media controls. - Enable or disable media loop. + Enable or disable media loop. - Show current video element in fullscreen mode. + Show current video element in fullscreen mode. - Play current media element. + Play current media element. - Pause current media element. + Pause current media element. - Mute current media element. + Mute current media element. - Download video to disk. Since 2.2 + Download video to disk. Since 2.2 - Download audio to disk. Since 2.2 + Download audio to disk. Since 2.2 - Insert an emoji. Since 2.26 + Insert an emoji. Since 2.26 - Paste clipboard contents as plain text. Since 2.30 + Paste clipboard contents as plain text. Since 2.30 - Custom action defined by applications. + Custom action defined by applications. + + @@ -581,6 +614,7 @@ If the @user_data #GVariant is floating, it is consumed. + @@ -588,6 +622,7 @@ If the @user_data #GVariant is floating, it is consumed. + @@ -595,6 +630,7 @@ If the @user_data #GVariant is floating, it is consumed. + @@ -602,44 +638,47 @@ If the @user_data #GVariant is floating, it is consumed. + - Creates a new #WebKitContextMenuItem for the given @action. + Creates a new #WebKitContextMenuItem for the given @action. Use webkit_context_menu_item_new_from_gaction() instead. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #GtkAction + a #GtkAction - Creates a new #WebKitContextMenuItem for the given @action and @label. On activation + Creates a new #WebKitContextMenuItem for the given @action and @label. On activation @target will be passed as parameter to the callback. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #GAction + a #GAction - the menu item label text + the menu item label text - a #GVariant to use as the action target + a #GVariant to use as the action target - Creates a new #WebKitContextMenuItem for the given stock action. + Creates a new #WebKitContextMenuItem for the given stock action. Stock actions are handled automatically by WebKit so that, for example, when a menu item created with a %WEBKIT_CONTEXT_MENU_ACTION_STOP is activated the action associated will be handled by WebKit and the current @@ -648,156 +687,168 @@ load operation will be stopped. You can get the #GAction of a webkit_context_menu_item_get_gaction() and connect to the #GSimpleAction::activate signal to be notified when the item is activated, but you can't prevent the associated action from being performed. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #WebKitContextMenuAction stock action + a #WebKitContextMenuAction stock action - Creates a new #WebKitContextMenuItem for the given stock action using the given @label. + Creates a new #WebKitContextMenuItem for the given stock action using the given @label. Stock actions have a predefined label, this method can be used to create a #WebKitContextMenuItem for a #WebKitContextMenuAction but using a custom label. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - a #WebKitContextMenuAction stock action + a #WebKitContextMenuAction stock action - a custom label text to use instead of the predefined one + a custom label text to use instead of the predefined one - Creates a new #WebKitContextMenuItem representing a separator. + Creates a new #WebKitContextMenuItem representing a separator. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - Creates a new #WebKitContextMenuItem using the given @label with a submenu. + Creates a new #WebKitContextMenuItem using the given @label with a submenu. + - the newly created #WebKitContextMenuItem object. + the newly created #WebKitContextMenuItem object. - the menu item label text + the menu item label text - a #WebKitContextMenu to set + a #WebKitContextMenu to set - Gets the action associated to @item as a #GtkAction. + Gets the action associated to @item as a #GtkAction. Use webkit_context_menu_item_get_gaction() instead. + - the #GtkAction associated to the #WebKitContextMenuItem, + the #GtkAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Gets the action associated to @item as a #GAction. + Gets the action associated to @item as a #GAction. + - the #GAction associated to the #WebKitContextMenuItem, + the #GAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not + Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not created for a stock action %WEBKIT_CONTEXT_MENU_ACTION_CUSTOM will be returned. If the #WebKitContextMenuItem is a separator %WEBKIT_CONTEXT_MENU_ACTION_NO_ACTION will be returned. + - the #WebKitContextMenuAction of @item + the #WebKitContextMenuAction of @item - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Gets the submenu of @item. + Gets the submenu of @item. + - the #WebKitContextMenu representing the submenu of + the #WebKitContextMenu representing the submenu of @item or %NULL if @item doesn't have a submenu. - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Checks whether @item is a separator. + Checks whether @item is a separator. + - %TRUE is @item is a separator or %FALSE otherwise + %TRUE is @item is a separator or %FALSE otherwise - a #WebKitContextMenuItem + a #WebKitContextMenuItem - Sets or replaces the @item submenu. If @submenu is %NULL the current + Sets or replaces the @item submenu. If @submenu is %NULL the current submenu of @item is removed. + - a #WebKitContextMenuItem + a #WebKitContextMenuItem - a #WebKitContextMenu + a #WebKitContextMenu + + @@ -805,6 +856,7 @@ submenu of @item is removed. + @@ -812,6 +864,7 @@ submenu of @item is removed. + @@ -819,148 +872,163 @@ submenu of @item is removed. + - - + + + + + + + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMAttr + A #WebKitDOMAttr - + Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #gchar + A #gchar - + - + - + - + - + - + - + @@ -968,25 +1036,28 @@ submenu of @item is removed. + - + + Use JavaScriptCore API instead + - A #guint64 + A #guint64 - A #WebKitDOMBlob + A #WebKitDOMBlob - + @@ -994,97 +1065,106 @@ submenu of @item is removed. + + + - + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - + Use JavaScriptCore API instead + - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - + Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - + Use JavaScriptCore API instead + - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - A #gchar + A #gchar - + - + - + @@ -1095,42 +1175,46 @@ submenu of @item is removed. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMCSSRuleList + A #WebKitDOMCSSRuleList Use JavaScriptCore API instead + - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - A #WebKitDOMCSSRuleList + A #WebKitDOMCSSRuleList - A #gulong + A #gulong - + @@ -1138,199 +1222,212 @@ submenu of @item is removed. + - + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - + Use JavaScriptCore API instead + - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gulong + A #gulong Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #gchar + A #gchar - A #gchar + A #gchar - A #gchar + A #gchar - + - + - + @@ -1338,135 +1435,144 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - A #gchar + A #gchar - A #gchar + A #gchar - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #WebKitDOMCSSRuleList + A #WebKitDOMCSSRuleList - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - + Use JavaScriptCore API instead + - A #WebKitDOMCSSRule + A #WebKitDOMCSSRule - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - + Use JavaScriptCore API instead + - A #WebKitDOMCSSRuleList + A #WebKitDOMCSSRuleList - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - A #gchar + A #gchar - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - A #gulong + A #gulong - + - + - + @@ -1474,57 +1580,62 @@ submenu of @item is removed. + - + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCSSValue + A #WebKitDOMCSSValue - + Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMCSSValue + A #WebKitDOMCSSValue - + Use JavaScriptCore API instead + - A #WebKitDOMCSSValue + A #WebKitDOMCSSValue - A #gchar + A #gchar - + - + @@ -1532,159 +1643,169 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - A #gulong + A #gulong - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData Use JavaScriptCore API instead + - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - A #gulong + A #gulong - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - A #gulong + A #gulong - A #gulong + A #gulong - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMCharacterData + A #WebKitDOMCharacterData - A #gulong + A #gulong - A #gulong + A #gulong - + - + @@ -1692,111 +1813,119 @@ submenu of @item is removed. + - - Returns the bottom coordinate of @self, relative to the viewport. + + + Returns the bottom coordinate of @self, relative to the viewport. Use JavaScriptCore API instead + - A #gfloat + A #gfloat - A #WebKitDOMClientRect + A #WebKitDOMClientRect - - Returns the height of @self. + + Returns the height of @self. Use JavaScriptCore API instead + - A #gfloat + A #gfloat - A #WebKitDOMClientRect + A #WebKitDOMClientRect - - Returns the left coordinate of @self, relative to the viewport. + + Returns the left coordinate of @self, relative to the viewport. Use JavaScriptCore API instead + - A #gfloat + A #gfloat - A #WebKitDOMClientRect + A #WebKitDOMClientRect - - Returns the right coordinate of @self, relative to the viewport. + + Returns the right coordinate of @self, relative to the viewport. Use JavaScriptCore API instead + - A #gfloat + A #gfloat - A #WebKitDOMClientRect + A #WebKitDOMClientRect - - Returns the top coordinate of @self, relative to the viewport. + + Returns the top coordinate of @self, relative to the viewport. Use JavaScriptCore API instead + - A #gfloat + A #gfloat - A #WebKitDOMClientRect + A #WebKitDOMClientRect - - Returns the width of @self. + + Returns the width of @self. Use JavaScriptCore API instead + - A #gfloat + A #gfloat - A #WebKitDOMClientRect + A #WebKitDOMClientRect - + - + - + - + - + - + @@ -1804,44 +1933,48 @@ submenu of @item is removed. + - - Returns the number of #WebKitDOMClientRect objects that @self contains. + + + Returns the number of #WebKitDOMClientRect objects that @self contains. Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMClientRectList + A #WebKitDOMClientRectList - Returns the #WebKitDOMClientRect object that @self contains at @index. + Returns the #WebKitDOMClientRect object that @self contains at @index. Use JavaScriptCore API instead + - A #WebKitDOMClientRect + A #WebKitDOMClientRect - A #WebKitDOMClientRectList + A #WebKitDOMClientRectList - A #gulong + A #gulong - + @@ -1849,127 +1982,136 @@ submenu of @item is removed. + + + + Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleSheet + A #WebKitDOMCSSStyleSheet - A #WebKitDOMDOMImplementation + A #WebKitDOMDOMImplementation - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMDOMImplementation + A #WebKitDOMDOMImplementation - A #gchar + A #gchar - A #gchar + A #gchar - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType Use JavaScriptCore API instead + - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - A #WebKitDOMDOMImplementation + A #WebKitDOMDOMImplementation - A #gchar + A #gchar - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #WebKitDOMDOMImplementation + A #WebKitDOMDOMImplementation - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMImplementation + A #WebKitDOMDOMImplementation - A #gchar + A #gchar - A #gchar + A #gchar @@ -1979,424 +2121,451 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMNode + A #WebKitDOMNode - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #gchar + A #gchar - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong - + - + - + - + - + - + - + - + - + - + @@ -2407,172 +2576,183 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - #GError + #GError - list of #gchar ended by %NULL. + list of #gchar ended by %NULL. Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - #GError + #GError - list of #gchar ended by %NULL. + list of #gchar ended by %NULL. Use JavaScriptCore API instead + - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #gchar + A #gchar - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #gchar + A #gchar - A #gboolean + A #gboolean - + - + @@ -2580,758 +2760,811 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #WebKitDOMDOMSelection + A #WebKitDOMDOMSelection - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gfloat + A #gfloat - A #gfloat + A #gfloat Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gfloat + A #gfloat - A #gfloat + A #gfloat Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gfloat + A #gfloat - A #gfloat + A #gfloat Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gfloat + A #gfloat - A #gfloat + A #gfloat Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gdouble + A #gdouble - A #gdouble + A #gdouble Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gdouble + A #gdouble - A #gdouble + A #gdouble - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow + @@ -3347,88 +3580,88 @@ submenu of @item is removed. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -3436,1765 +3669,1872 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMDocument + A #WebKitDOMDocument - A #glong + A #glong - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMCDATASection + A #WebKitDOMCDATASection - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMComment + A #WebKitDOMComment - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #gchar + A #gchar - This function has been removed from the DOM spec and it just returns %NULL. + This function has been removed from the DOM spec and it just returns %NULL. + - A #WebKitDOMEntityReference + A #WebKitDOMEntityReference - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMEvent + A #WebKitDOMEvent - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMXPathExpression + A #WebKitDOMXPathExpression - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #WebKitDOMXPathNSResolver + A #WebKitDOMXPathNSResolver Use JavaScriptCore API instead + - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMXPathNSResolver + A #WebKitDOMXPathNSResolver - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMProcessingInstruction + A #WebKitDOMProcessingInstruction - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMText + A #WebKitDOMText - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMNode + A #WebKitDOMNode - A #gulong + A #gulong - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - A #glong + A #glong - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMXPathNSResolver + A #WebKitDOMXPathNSResolver - A #gushort + A #gushort - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #gboolean + A #gboolean - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #WebKitDOMDocument + A #WebKitDOMDocument + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use webkit_dom_document_get_elements_by_class_name_as_html_collection() instead. + - a #WebKitDOMNodeList + a #WebKitDOMNodeList - A #WebKitDOMDocument + A #WebKitDOMDocument - a #gchar with the tag name + a #gchar with the tag name Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNodeList + A #WebKitDOMNodeList - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use webkit_dom_document_get_elements_by_tag_name_as_html_collection() instead. + - a #WebKitDOMNodeList + a #WebKitDOMNodeList - A #WebKitDOMDocument + A #WebKitDOMDocument - a #gchar with the tag name + a #gchar with the tag name Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use webkit_dom_document_get_elements_by_tag_name_ns_as_html_collection() instead. + - a #WebKitDOMNodeList + a #WebKitDOMNodeList - A #WebKitDOMDocument + A #WebKitDOMDocument - a #gchar with the namespace URI + a #gchar with the namespace URI - a #gchar with the tag name + a #gchar with the tag name Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHeadElement + A #WebKitDOMHTMLHeadElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMDOMImplementation + A #WebKitDOMDOMImplementation - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - - This function has been removed and does nothing. + + This function has been removed and does nothing. Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - - This function has been removed and does nothing. + + This function has been removed and does nothing. Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMStyleSheetList + A #WebKitDOMStyleSheetList - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMNode + A #WebKitDOMNode - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNodeList + A #WebKitDOMNodeList - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - - This function has been removed and does nothing. + + This function has been removed and does nothing. Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -5203,22 +5543,22 @@ submenu of @item is removed. - + - + - + - + - + @@ -5226,125 +5566,134 @@ submenu of @item is removed. + + - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNodeList + A #WebKitDOMNodeList - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #gchar + A #gchar - + - + - + - + @@ -5352,106 +5701,114 @@ submenu of @item is removed. + + - + Use JavaScriptCore API instead + - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - + Use JavaScriptCore API instead + - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMDocumentType + A #WebKitDOMDocumentType - + - + - + - + - + - + @@ -5459,724 +5816,776 @@ submenu of @item is removed. + + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #WebKitDOMElement + A #WebKitDOMElement - Returns a #WebKitDOMClientRect representing the size and position of @self + Returns a #WebKitDOMClientRect representing the size and position of @self relative to the viewport. Use JavaScriptCore API instead + - A #WebKitDOMClientRect + A #WebKitDOMClientRect - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - Returns a collection of #WebKitDOMClientRect objects, each of which describe + Returns a collection of #WebKitDOMClientRect objects, each of which describe the size and position of a CSS border box relative to the viewport. Use JavaScriptCore API instead + - A #WebKitDOMClientRectList + A #WebKitDOMClientRectList - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement Use webkit_dom_element_get_elements_by_class_name_as_html_collection() instead. + - a #WebKitDOMNodeList + a #WebKitDOMNodeList - A #WebKitDOMElement + A #WebKitDOMElement - a #gchar with the tag name + a #gchar with the tag name Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use webkit_dom_element_get_elements_by_tag_name_as_html_collection() instead. + - a #WebKitDOMNodeList + a #WebKitDOMNodeList - A #WebKitDOMElement + A #WebKitDOMElement - a #gchar with the tag name + a #gchar with the tag name Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use webkit_dom_element_get_elements_by_tag_name_ns_as_html_collection() instead. + - a #WebKitDOMNodeList + a #WebKitDOMNodeList - A #WebKitDOMElement + A #WebKitDOMElement - a #gchar with the namespace URI + a #gchar with the namespace URI - a #gchar with the tag name + a #gchar with the tag name Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #WebKitDOMCSSStyleDeclaration + A #WebKitDOMCSSStyleDeclaration - A #WebKitDOMElement + A #WebKitDOMElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement - - CSS Regions support has been removed. This function does nothing. + + CSS Regions support has been removed. This function does nothing. + - %NULL + %NULL - A #WebKitDOMElement + A #WebKitDOMElement Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMElement + A #WebKitDOMElement + @@ -6187,600 +6596,630 @@ the size and position of a CSS border box relative to the viewport. - Get whether @element is an HTML text input element that has been edited by a user action. + Get whether @element is an HTML text input element that has been edited by a user action. + - whether @element has been edited by a user action. + whether @element has been edited by a user action. - a #WebKitDOMElement + a #WebKitDOMElement - Set whether the element is an HTML input element that has been filled automatically. + Set whether the element is an HTML input element that has been filled automatically. If @element is not an HTML input element this function does nothing. + - a #WebKitDOMElement + a #WebKitDOMElement - value to set + value to set - Set the value of an HTML input element as if it had been edited by + Set the value of an HTML input element as if it had been edited by the user, triggering a change event. If @element is not an HTML input element this function does nothing. + - a #WebKitDOMElement + a #WebKitDOMElement - the text to set + the text to set Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #WebKitDOMElement + A #WebKitDOMElement Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNodeList + A #WebKitDOMNodeList - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMAttr + A #WebKitDOMAttr Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMAttr + A #WebKitDOMAttr Use JavaScriptCore API instead + - A #WebKitDOMAttr + A #WebKitDOMAttr - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMAttr + A #WebKitDOMAttr Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - A #gchar + A #gchar - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #glong + A #glong Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMElement + A #WebKitDOMElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -6788,257 +7227,276 @@ element this function does nothing. + + + - + + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMEvent + A #WebKitDOMEvent Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #guint32 + A #guint32 - A #WebKitDOMEvent + A #WebKitDOMEvent Use JavaScriptCore API instead + - A #WebKitDOMEvent + A #WebKitDOMEvent - A #gchar + A #gchar - A #gboolean + A #gboolean - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMEvent + A #WebKitDOMEvent - + Use JavaScriptCore API instead + - A #WebKitDOMEvent + A #WebKitDOMEvent - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMEvent + A #WebKitDOMEvent - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMEvent + A #WebKitDOMEvent - + - + - + - + - + - + - + - + - + @@ -7049,12 +7507,15 @@ element this function does nothing. + + + @@ -7075,189 +7536,198 @@ element this function does nothing. Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMEvent + A #WebKitDOMEvent Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #gchar + A #gchar - A #GCallback + A #GCallback - A #gboolean + A #gboolean Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #gchar + A #gchar - A #GCallback + A #GCallback - A #gboolean + A #gboolean - A #gpointer + A #gpointer - Version of webkit_dom_event_target_add_event_listener() using a closure + Version of webkit_dom_event_target_add_event_listener() using a closure instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #gchar + A #gchar - A #GClosure + A #GClosure - A #gboolean + A #gboolean Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMEvent + A #WebKitDOMEvent Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #gchar + A #gchar - A #GCallback + A #GCallback - A #gboolean + A #gboolean - Version of webkit_dom_event_target_remove_event_listener() using a closure + Version of webkit_dom_event_target_remove_event_listener() using a closure instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #gchar + A #gchar - A #GClosure + A #GClosure - A #gboolean + A #gboolean + + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMEvent + A #WebKitDOMEvent @@ -7265,6 +7735,7 @@ instead of a callbacks for easier binding in other languages. + @@ -7286,25 +7757,26 @@ instead of a callbacks for easier binding in other languages. + - a #gboolean + a #gboolean - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #gchar + A #gchar - A #GCallback + A #GCallback - A #gboolean + A #gboolean @@ -7312,6 +7784,7 @@ instead of a callbacks for easier binding in other languages. + @@ -7319,6 +7792,7 @@ instead of a callbacks for easier binding in other languages. + @@ -7326,6 +7800,7 @@ instead of a callbacks for easier binding in other languages. + @@ -7333,6 +7808,7 @@ instead of a callbacks for easier binding in other languages. + @@ -7340,20 +7816,22 @@ instead of a callbacks for easier binding in other languages. - + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMFile + A #WebKitDOMFile - + @@ -7361,42 +7839,46 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMFileList + A #WebKitDOMFileList Use JavaScriptCore API instead + - A #WebKitDOMFile + A #WebKitDOMFile - A #WebKitDOMFileList + A #WebKitDOMFileList - A #gulong + A #gulong - + @@ -7404,583 +7886,621 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLAnchorElement + A #WebKitDOMHTMLAnchorElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -7991,362 +8511,386 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAppletElement + A #WebKitDOMHTMLAppletElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + @@ -8354,426 +8898,454 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLAreaElement + A #WebKitDOMHTMLAreaElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -8781,42 +9353,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBRElement + A #WebKitDOMHTMLBRElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBRElement + A #WebKitDOMHTMLBRElement - A #gchar + A #gchar - + @@ -8824,74 +9400,80 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBaseElement + A #WebKitDOMHTMLBaseElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBaseElement + A #WebKitDOMHTMLBaseElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBaseElement + A #WebKitDOMHTMLBaseElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBaseElement + A #WebKitDOMHTMLBaseElement - A #gchar + A #gchar - + - + @@ -8899,95 +9481,103 @@ instead of a callbacks for easier binding in other languages. + + - This function has been removed from the DOM spec and it just returns %NULL. + This function has been removed from the DOM spec and it just returns %NULL. + - A #gchar + A #gchar - A #WebKitDOMHTMLBaseFontElement + A #WebKitDOMHTMLBaseFontElement - This function has been removed from the DOM spec and it just returns %NULL. + This function has been removed from the DOM spec and it just returns %NULL. + - A #gchar + A #gchar - A #WebKitDOMHTMLBaseFontElement + A #WebKitDOMHTMLBaseFontElement - This function has been removed from the DOM spec and it just returns 0. + This function has been removed from the DOM spec and it just returns 0. + - A #glong + A #glong - A #WebKitDOMHTMLBaseFontElement + A #WebKitDOMHTMLBaseFontElement - This function has been removed from the DOM spec and it does nothing. + This function has been removed from the DOM spec and it does nothing. + - A #WebKitDOMHTMLBaseFontElement + A #WebKitDOMHTMLBaseFontElement - A #gchar + A #gchar - This function has been removed from the DOM spec and it does nothing. + This function has been removed from the DOM spec and it does nothing. + - A #WebKitDOMHTMLBaseFontElement + A #WebKitDOMHTMLBaseFontElement - A #gchar + A #gchar - This function has been removed from the DOM spec and it does nothing. + This function has been removed from the DOM spec and it does nothing. + - A #WebKitDOMHTMLBaseFontElement + A #WebKitDOMHTMLBaseFontElement - A #glong + A #glong @@ -8997,202 +9587,216 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLBodyElement + A #WebKitDOMHTMLBodyElement - A #gchar + A #gchar - + - + - + - + - + - + @@ -9200,202 +9804,216 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLButtonElement + A #WebKitDOMHTMLButtonElement - A #gchar + A #gchar - + - + - + - + - + - + @@ -9403,74 +10021,80 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLCanvasElement + A #WebKitDOMHTMLCanvasElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLCanvasElement + A #WebKitDOMHTMLCanvasElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCanvasElement + A #WebKitDOMHTMLCanvasElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCanvasElement + A #WebKitDOMHTMLCanvasElement - A #glong + A #glong - + - + @@ -9478,59 +10102,64 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #gchar + A #gchar - + @@ -9538,42 +10167,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLDListElement + A #WebKitDOMHTMLDListElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDListElement + A #WebKitDOMHTMLDListElement - A #gboolean + A #gboolean - + @@ -9581,42 +10214,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLDirectoryElement + A #WebKitDOMHTMLDirectoryElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDirectoryElement + A #WebKitDOMHTMLDirectoryElement - A #gboolean + A #gboolean - + @@ -9624,42 +10261,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDivElement + A #WebKitDOMHTMLDivElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDivElement + A #WebKitDOMHTMLDivElement - A #gchar + A #gchar - + @@ -9667,363 +10308,389 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use webkit_dom_document_get_compat_mode() instead. + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use webkit_dom_document_get_design_mode() instead. + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use webkit_dom_document_get_embeds() instead. + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use webkit_dom_document_get_plugins() instead. + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use webkit_dom_document_get_scripts() instead. + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar Use webkit_dom_document_set_design_mode() instead. + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLDocument + A #WebKitDOMHTMLDocument - A #gchar + A #gchar - + - + - + - + - + - + - + - + @@ -10031,525 +10698,560 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement Use webkit_dom_element_get_children() instead. + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement Use webkit_dom_element_get_inner_html() instead. + - a #gchar + a #gchar - a #WebKitDOMHTMLElement + a #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement Use webkit_dom_element_get_outer_html() instead. + - a #gchar + a #gchar - a #WebKitDOMHTMLElement + a #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gboolean + A #gboolean Use webkit_dom_element_set_inner_html() instead. + - a #WebKitDOMHTMLElement + a #WebKitDOMHTMLElement - a #gchar with contents to set + a #gchar with contents to set - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar Use webkit_dom_element_set_outer_html() instead. + - a #WebKitDOMHTMLElement + a #WebKitDOMHTMLElement - a #gchar with contents to set + a #gchar with contents to set - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -10557,202 +11259,216 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLEmbedElement + A #WebKitDOMHTMLEmbedElement - A #glong + A #glong - + - + - + - + - + @@ -10760,26 +11476,29 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLFieldSetElement + A #WebKitDOMHTMLFieldSetElement - + @@ -10787,106 +11506,114 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFontElement + A #WebKitDOMHTMLFontElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFontElement + A #WebKitDOMHTMLFontElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFontElement + A #WebKitDOMHTMLFontElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFontElement + A #WebKitDOMHTMLFontElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFontElement + A #WebKitDOMHTMLFontElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFontElement + A #WebKitDOMHTMLFontElement - A #gchar + A #gchar - + - + - + @@ -10894,290 +11621,310 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - + - + - + - + - + - + - + - + - + @@ -11185,330 +11932,352 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameElement + A #WebKitDOMHTMLFrameElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + @@ -11516,74 +12285,80 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameSetElement + A #WebKitDOMHTMLFrameSetElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLFrameSetElement + A #WebKitDOMHTMLFrameSetElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameSetElement + A #WebKitDOMHTMLFrameSetElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFrameSetElement + A #WebKitDOMHTMLFrameSetElement - A #gchar + A #gchar - + - + @@ -11591,138 +12366,148 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHRElement + A #WebKitDOMHTMLHRElement - A #gchar + A #gchar - + - + - + - + @@ -11730,42 +12515,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLHeadElement + A #WebKitDOMHTMLHeadElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHeadElement + A #WebKitDOMHTMLHeadElement - A #gchar + A #gchar - + @@ -11773,42 +12562,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLHeadingElement + A #WebKitDOMHTMLHeadingElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHeadingElement + A #WebKitDOMHTMLHeadingElement - A #gchar + A #gchar - + @@ -11816,42 +12609,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLHtmlElement + A #WebKitDOMHTMLHtmlElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLHtmlElement + A #WebKitDOMHTMLHtmlElement - A #gchar + A #gchar - + @@ -11859,362 +12656,386 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLIFrameElement + A #WebKitDOMHTMLIFrameElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + @@ -12222,506 +13043,539 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLImageElement + A #WebKitDOMHTMLImageElement - A #glong + A #glong - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -12729,829 +13583,883 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement Use webkit_dom_element_html_input_element_get_auto_filled() instead. + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use webkit_dom_html_input_element_get_capture_type() instead. + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #WebKitDOMFileList + A #WebKitDOMFileList - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement Use webkit_dom_element_html_input_element_is_user_edited() instead. + - A #gboolean + A #gboolean - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar Use webkit_dom_element_html_input_element_set_auto_filled() instead. + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean Use webkit_dom_element_html_input_element_set_editing_value() instead. + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #WebKitDOMFileList + A #WebKitDOMFileList - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLInputElement + A #WebKitDOMHTMLInputElement - A #gulong + A #gulong - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -13559,66 +14467,72 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLIElement + A #WebKitDOMHTMLLIElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLLIElement + A #WebKitDOMHTMLLIElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLLIElement + A #WebKitDOMHTMLLIElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLIElement + A #WebKitDOMHTMLLIElement - A #glong + A #glong @@ -13626,7 +14540,7 @@ instead of a callbacks for easier binding in other languages. - + @@ -13634,58 +14548,63 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLLabelElement + A #WebKitDOMHTMLLabelElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLabelElement + A #WebKitDOMHTMLLabelElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLabelElement + A #WebKitDOMHTMLLabelElement - A #gchar + A #gchar - + - + @@ -13693,58 +14612,63 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLegendElement + A #WebKitDOMHTMLLegendElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLLegendElement + A #WebKitDOMHTMLLegendElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLegendElement + A #WebKitDOMHTMLLegendElement - A #gchar + A #gchar - + - + @@ -13752,343 +14676,366 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #WebKitDOMDOMTokenList + A #WebKitDOMDOMTokenList - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - a #gchar + a #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLLinkElement + A #WebKitDOMHTMLLinkElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + @@ -14099,58 +15046,63 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLMapElement + A #WebKitDOMHTMLMapElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLMapElement + A #WebKitDOMHTMLMapElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMapElement + A #WebKitDOMHTMLMapElement - A #gchar + A #gchar - + - + @@ -14158,32 +15110,36 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMarqueeElement + A #WebKitDOMHTMLMarqueeElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLMarqueeElement + A #WebKitDOMHTMLMarqueeElement @@ -14193,42 +15149,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLMenuElement + A #WebKitDOMHTMLMenuElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMenuElement + A #WebKitDOMHTMLMenuElement - A #gboolean + A #gboolean - + @@ -14236,138 +15196,148 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLMetaElement + A #WebKitDOMHTMLMetaElement - A #gchar + A #gchar - + - + - + - + @@ -14375,74 +15345,80 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLModElement + A #WebKitDOMHTMLModElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLModElement + A #WebKitDOMHTMLModElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLModElement + A #WebKitDOMHTMLModElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLModElement + A #WebKitDOMHTMLModElement - A #gchar + A #gchar - + - + @@ -14450,103 +15426,111 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLOListElement + A #WebKitDOMHTMLOListElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLOListElement + A #WebKitDOMHTMLOListElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLOListElement + A #WebKitDOMHTMLOListElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOListElement + A #WebKitDOMHTMLOListElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOListElement + A #WebKitDOMHTMLOListElement - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMHTMLOListElement + A #WebKitDOMHTMLOListElement - A #gchar + A #gchar - + - + @@ -14557,554 +15541,590 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLObjectElement + A #WebKitDOMHTMLObjectElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -15112,74 +16132,80 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLOptGroupElement + A #WebKitDOMHTMLOptGroupElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLOptGroupElement + A #WebKitDOMHTMLOptGroupElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptGroupElement + A #WebKitDOMHTMLOptGroupElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptGroupElement + A #WebKitDOMHTMLOptGroupElement - A #gchar + A #gchar - + - + @@ -15187,218 +16213,233 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionElement + A #WebKitDOMHTMLOptionElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + @@ -15406,74 +16447,80 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMHTMLOptionsCollection + A #WebKitDOMHTMLOptionsCollection - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLOptionsCollection + A #WebKitDOMHTMLOptionsCollection Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMHTMLOptionsCollection + A #WebKitDOMHTMLOptionsCollection - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionsCollection + A #WebKitDOMHTMLOptionsCollection - A #glong + A #glong - + - + @@ -15481,42 +16528,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLParagraphElement + A #WebKitDOMHTMLParagraphElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLParagraphElement + A #WebKitDOMHTMLParagraphElement - A #gchar + A #gchar - + @@ -15524,138 +16575,148 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLParamElement + A #WebKitDOMHTMLParamElement - A #gchar + A #gchar - + - + - + @@ -15663,74 +16724,80 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLPreElement + A #WebKitDOMHTMLPreElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLPreElement + A #WebKitDOMHTMLPreElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLPreElement + A #WebKitDOMHTMLPreElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLPreElement + A #WebKitDOMHTMLPreElement - A #gboolean + A #gboolean - + - + @@ -15738,42 +16805,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLQuoteElement + A #WebKitDOMHTMLQuoteElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLQuoteElement + A #WebKitDOMHTMLQuoteElement - A #gchar + A #gchar - + @@ -15781,231 +16852,247 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLScriptElement + A #WebKitDOMHTMLScriptElement - A #gchar + A #gchar - + - + - + - + - + - + @@ -16016,400 +17103,426 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLOptionsCollection + A #WebKitDOMHTMLOptionsCollection - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLSelectElement + A #WebKitDOMHTMLSelectElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + @@ -16417,119 +17530,128 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement - + Use JavaScriptCore API instead + - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLStyleElement + A #WebKitDOMHTMLStyleElement - A #gchar + A #gchar - + - + - + @@ -16540,42 +17662,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCaptionElement + A #WebKitDOMHTMLTableCaptionElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCaptionElement + A #WebKitDOMHTMLTableCaptionElement - A #gchar + A #gchar - + @@ -16583,474 +17709,505 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCellElement + A #WebKitDOMHTMLTableCellElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -17058,202 +18215,216 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableColElement + A #WebKitDOMHTMLTableColElement - A #gchar + A #gchar - + - + - + - + - + - + @@ -17261,502 +18432,536 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableCaptionElement + A #WebKitDOMHTMLTableCaptionElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #WebKitDOMHTMLTableCaptionElement + A #WebKitDOMHTMLTableCaptionElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableElement + A #WebKitDOMHTMLTableElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -17764,251 +18969,268 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableRowElement + A #WebKitDOMHTMLTableRowElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + @@ -18016,187 +19238,200 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLCollection + A #WebKitDOMHTMLCollection - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLElement + A #WebKitDOMHTMLElement - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTableSectionElement + A #WebKitDOMHTMLTableSectionElement - A #gchar + A #gchar - + - + - + - + - + @@ -18204,427 +19439,455 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLFormElement + A #WebKitDOMHTMLFormElement - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #gboolean + A #gboolean - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #glong + A #glong - A #glong + A #glong - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #glong + A #glong - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTextAreaElement + A #WebKitDOMHTMLTextAreaElement - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + @@ -18632,42 +19895,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLTitleElement + A #WebKitDOMHTMLTitleElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLTitleElement + A #WebKitDOMHTMLTitleElement - A #gchar + A #gchar - + @@ -18675,71 +19942,77 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMHTMLUListElement + A #WebKitDOMHTMLUListElement Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMHTMLUListElement + A #WebKitDOMHTMLUListElement - + Use JavaScriptCore API instead + - A #WebKitDOMHTMLUListElement + A #WebKitDOMHTMLUListElement - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMHTMLUListElement + A #WebKitDOMHTMLUListElement - A #gchar + A #gchar - + @@ -18750,194 +20023,205 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent Use JavaScriptCore API instead + - A #WebKitDOMKeyboardEvent + A #WebKitDOMKeyboardEvent - A #gchar + A #gchar - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #gchar + A #gchar - A #gulong + A #gulong - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - + - + - + - + - + - + - + @@ -18945,106 +20229,114 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMMediaList + A #WebKitDOMMediaList - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMMediaList + A #WebKitDOMMediaList - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMMediaList + A #WebKitDOMMediaList - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMMediaList + A #WebKitDOMMediaList Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMMediaList + A #WebKitDOMMediaList - A #gulong + A #gulong - + Use JavaScriptCore API instead + - A #WebKitDOMMediaList + A #WebKitDOMMediaList - A #gchar + A #gchar - + - + @@ -19052,337 +20344,356 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent Use JavaScriptCore API instead + - A #WebKitDOMMouseEvent + A #WebKitDOMMouseEvent - A #gchar + A #gchar - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #glong + A #glong - A #glong + A #glong - A #glong + A #glong - A #glong + A #glong - A #glong + A #glong - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gushort + A #gushort - A #WebKitDOMEventTarget + A #WebKitDOMEventTarget - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -19390,152 +20701,162 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #gulong + A #gulong Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNamedNodeMap + A #WebKitDOMNamedNodeMap - A #WebKitDOMNode + A #WebKitDOMNode - + @@ -19543,592 +20864,630 @@ instead of a callbacks for easier binding in other languages. + + - Get the #WebKitDOMNode for the DOM node referenced by @value. + Get the #WebKitDOMNode for the DOM node referenced by @value. + - a #WebKitDOMNode, or %NULL if @value doesn't reference a DOM node. + a #WebKitDOMNode, or %NULL if @value doesn't reference a DOM node. - a #JSCValue + a #JSCValue Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use webkit_dom_node_clone_node_with_error() instead. + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNodeList + A #WebKitDOMNodeList - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use webkit_dom_attr_get_local_name() or webkit_dom_element_get_local_name() instead. + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode Use webkit_dom_attr_get_namespace_uri() or webkit_dom_element_get_namespace_uri() instead. + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMDocument + A #WebKitDOMDocument - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMElement + A #WebKitDOMElement - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use webkit_dom_attr_get_prefix() or webkit_dom_element_get_prefix() instead. + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNode + A #WebKitDOMNode - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar + - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #gchar + A #gchar - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -20136,63 +21495,69 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - a #gshort + a #gshort - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - a #gshort + a #gshort - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #WebKitDOMNode + A #WebKitDOMNode + + - a #gshort + a #gshort - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #WebKitDOMNode + A #WebKitDOMNode @@ -20200,6 +21565,7 @@ instead of a callbacks for easier binding in other languages. + @@ -20207,6 +21573,7 @@ instead of a callbacks for easier binding in other languages. + @@ -20214,6 +21581,7 @@ instead of a callbacks for easier binding in other languages. + @@ -20221,6 +21589,7 @@ instead of a callbacks for easier binding in other languages. + @@ -20228,135 +21597,145 @@ instead of a callbacks for easier binding in other languages. + Use JavaScriptCore API instead + - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - This function has been removed from the DOM spec and it just returns %FALSE. + This function has been removed from the DOM spec and it just returns %FALSE. + - A #gboolean * + A #gboolean * - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - + Use JavaScriptCore API instead + - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNodeIterator + A #WebKitDOMNodeIterator - + - + - + - + - + @@ -20364,42 +21743,46 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMNodeList + A #WebKitDOMNodeList Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMNodeList + A #WebKitDOMNodeList - A #gulong + A #gulong - + @@ -20407,11 +21790,13 @@ instead of a callbacks for easier binding in other languages. + + @@ -20423,42 +21808,46 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - A #WebKitDOMProcessingInstruction + A #WebKitDOMProcessingInstruction - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMProcessingInstruction + A #WebKitDOMProcessingInstruction - + - + @@ -20466,511 +21855,544 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #gboolean + A #gboolean Use JavaScriptCore API instead + - A #gshort + A #gshort - A #WebKitDOMRange + A #WebKitDOMRange - A #gushort + A #gushort - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #gshort + A #gshort - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gshort + A #gshort - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #WebKitDOMRange + A #WebKitDOMRange - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMDocumentFragment + A #WebKitDOMDocumentFragment - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMRange + A #WebKitDOMRange - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMRange + A #WebKitDOMRange Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode - A #glong + A #glong Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #WebKitDOMRange + A #WebKitDOMRange - A #WebKitDOMNode + A #WebKitDOMNode Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMRange + A #WebKitDOMRange - + - + - + - + - + - + - + @@ -20978,134 +22400,144 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #WebKitDOMMediaList + A #WebKitDOMMediaList - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - + Use JavaScriptCore API instead + - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - A #gboolean + A #gboolean - + - + - + - + - + - + @@ -21116,42 +22548,46 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMStyleSheetList + A #WebKitDOMStyleSheetList Use JavaScriptCore API instead + - A #WebKitDOMStyleSheet + A #WebKitDOMStyleSheet - A #WebKitDOMStyleSheetList + A #WebKitDOMStyleSheetList - A #gulong + A #gulong - + @@ -21159,59 +22595,64 @@ instead of a callbacks for easier binding in other languages. + + - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMText + A #WebKitDOMText + - A #WebKitDOMText + A #WebKitDOMText - A #WebKitDOMText + A #WebKitDOMText - A #gchar + A #gchar Use JavaScriptCore API instead + - A #WebKitDOMText + A #WebKitDOMText - A #WebKitDOMText + A #WebKitDOMText - A #gulong + A #gulong - + @@ -21219,193 +22660,208 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - This function has been removed from the DOM spec and it just returns %FALSE. + This function has been removed from the DOM spec and it just returns %FALSE. + - A #gboolean + A #gboolean - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - + Use JavaScriptCore API instead + - A #WebKitDOMNodeFilter + A #WebKitDOMNodeFilter - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker Use JavaScriptCore API instead + - A #WebKitDOMTreeWalker + A #WebKitDOMTreeWalker - A #WebKitDOMNode + A #WebKitDOMNode - + - + - + - + @@ -21413,169 +22869,180 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - + Use JavaScriptCore API instead + - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent Use JavaScriptCore API instead + - A #WebKitDOMUIEvent + A #WebKitDOMUIEvent - A #gchar + A #gchar - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #glong + A #glong - + - + - + - + - + - + - + - + @@ -21583,113 +23050,119 @@ instead of a callbacks for easier binding in other languages. + - + + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMWheelEvent + A #WebKitDOMWheelEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMWheelEvent + A #WebKitDOMWheelEvent - + Use JavaScriptCore API instead + - A #glong + A #glong - A #WebKitDOMWheelEvent + A #WebKitDOMWheelEvent Use JavaScriptCore API instead + - A #WebKitDOMWheelEvent + A #WebKitDOMWheelEvent - A #glong + A #glong - A #glong + A #glong - A #WebKitDOMDOMWindow + A #WebKitDOMDOMWindow - A #glong + A #glong - A #glong + A #glong - A #glong + A #glong - A #glong + A #glong - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - A #gboolean + A #gboolean - + - + - + @@ -21697,32 +23170,35 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - A #WebKitDOMXPathExpression + A #WebKitDOMXPathExpression - A #WebKitDOMNode + A #WebKitDOMNode - A #gushort + A #gushort - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult @@ -21732,63 +23208,69 @@ instead of a callbacks for easier binding in other languages. + + Use JavaScriptCore API instead + - a #gchar + a #gchar - A #WebKitDOMXPathNSResolver + A #WebKitDOMXPathNSResolver - The prefix to lookup + The prefix to lookup Use JavaScriptCore API instead + - a #gchar + a #gchar - A #WebKitDOMXPathNSResolver + A #WebKitDOMXPathNSResolver - The prefix to lookup + The prefix to lookup + + - a #gchar + a #gchar - A #WebKitDOMXPathNSResolver + A #WebKitDOMXPathNSResolver - The prefix to lookup + The prefix to lookup @@ -21796,6 +23278,7 @@ instead of a callbacks for easier binding in other languages. + @@ -21803,6 +23286,7 @@ instead of a callbacks for easier binding in other languages. + @@ -21810,6 +23294,7 @@ instead of a callbacks for easier binding in other languages. + @@ -21817,6 +23302,7 @@ instead of a callbacks for easier binding in other languages. + @@ -21824,146 +23310,156 @@ instead of a callbacks for easier binding in other languages. - + + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - + Use JavaScriptCore API instead + - A #gboolean + A #gboolean - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - + Use JavaScriptCore API instead + - A #gdouble + A #gdouble - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - + Use JavaScriptCore API instead + - A #gushort + A #gushort - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - + Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - + Use JavaScriptCore API instead + - A #gulong + A #gulong - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - + Use JavaScriptCore API instead + - A #gchar + A #gchar - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult Use JavaScriptCore API instead + - A #WebKitDOMNode + A #WebKitDOMNode - A #WebKitDOMXPathResult + A #WebKitDOMXPathResult - A #gulong + A #gulong - + - + - + - + - + - + - + @@ -21971,137 +23467,160 @@ instead of a callbacks for easier binding in other languages. + + + + + + + + + + + + + + + + + + + + + + + @@ -22109,9 +23628,11 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + + @@ -22119,9 +23640,11 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + + @@ -22129,21 +23652,25 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + + + + @@ -22151,63 +23678,75 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + + + + + + @@ -22215,153 +23754,180 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + + + + + + + + + + + + + + + + + + + + + @@ -22369,39 +23935,46 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + + + + + + + @@ -22409,25 +23982,31 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + @@ -22435,21 +24014,26 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + @@ -22457,2377 +24041,2777 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -24835,75 +26819,89 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + + + + + + + + @@ -24911,13 +26909,16 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + + @@ -24925,196 +26926,235 @@ instead of a callbacks for easier binding in other languages. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + - Accept the node. Use this macro as return value of webkit_dom_node_filter_accept_node() + Accept the node. Use this macro as return value of webkit_dom_node_filter_accept_node() implementation to accept the given #WebKitDOMNode Use JavaScriptCore API instead + + + - Reject the node. Use this macro as return value of webkit_dom_node_filter_accept_node() + Reject the node. Use this macro as return value of webkit_dom_node_filter_accept_node() implementation to reject the given #WebKitDOMNode. The children of the given node will be rejected too. Use JavaScriptCore API instead + - Show all nodes. + Show all nodes. Use JavaScriptCore API instead - + + - Show #WebKitDOMAttr nodes. + Show #WebKitDOMAttr nodes. Use JavaScriptCore API instead + - Show #WebKitDOMCDataSection nodes. + Show #WebKitDOMCDataSection nodes. Use JavaScriptCore API instead + - Show #WebKitDOMComment nodes. + Show #WebKitDOMComment nodes. Use JavaScriptCore API instead + - Show #WebKitDOMDocument nodes. + Show #WebKitDOMDocument nodes. Use JavaScriptCore API instead + - Show #WebKitDOMDocumentFragment nodes. + Show #WebKitDOMDocumentFragment nodes. Use JavaScriptCore API instead + - Show #WebKitDOMDocumentType nodes. + Show #WebKitDOMDocumentType nodes. Use JavaScriptCore API instead + - Show #WebKitDOMElement nodes. + Show #WebKitDOMElement nodes. Use JavaScriptCore API instead + - Show #WebKitDOMEntity nodes. + Show #WebKitDOMEntity nodes. Use JavaScriptCore API instead + - Show #WebKitDOMEntityReference nodes. + Show #WebKitDOMEntityReference nodes. Use JavaScriptCore API instead + - Show #WebKitDOMNotation nodes. + Show #WebKitDOMNotation nodes. Use JavaScriptCore API instead + - Show #WebKitDOMProcessingInstruction nodes. + Show #WebKitDOMProcessingInstruction nodes. Use JavaScriptCore API instead + - Show #WebKitDOMText nodes. + Show #WebKitDOMText nodes. Use JavaScriptCore API instead + - Skip the node. Use this macro as return value of webkit_dom_node_filter_accept_node() + Skip the node. Use this macro as return value of webkit_dom_node_filter_accept_node() implementation to skip the given #WebKitDOMNode. The children of the given node will not be skipped. Use JavaScriptCore API instead + + + + + + + + @@ -25122,55 +27162,65 @@ not be skipped. Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + + + + + + @@ -25178,13 +27228,16 @@ not be skipped. Use JavaScriptCore API instead + Use JavaScriptCore API instead + + @@ -25192,173 +27245,204 @@ not be skipped. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -25366,17 +27450,21 @@ not be skipped. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + @@ -25384,9 +27472,11 @@ not be skipped. Use JavaScriptCore API instead + + @@ -25394,201 +27484,220 @@ not be skipped. Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + Use JavaScriptCore API instead + + + + - Used to indicate a particular stage in form submission. See + Used to indicate a particular stage in form submission. See #WebKitWebPage::will-submit-form. - - indicates the form's + + indicates the form's DOM submit event is about to be emitted. - - indicates the form is about + + indicates the form is about to be submitted. + - Gets the process-unique identifier of this #WebKitFrame. No other + Gets the process-unique identifier of this #WebKitFrame. No other frame in the same web process will have the same ID; however, frames in other web processes may. + - the identifier of @frame + the identifier of @frame - a #WebKitFrame + a #WebKitFrame - Gets the JavaScript execution context of @frame for the given #WebKitScriptWorld. + Gets the JavaScript execution context of @frame for the given #WebKitScriptWorld. Use webkit_frame_get_js_context_for_script_world() instead. + - the JavaScript context of @frame for @world - + the JavaScript context of @frame for @world + - a #WebKitFrame + a #WebKitFrame - a #WebKitScriptWorld + a #WebKitScriptWorld - Gets the global JavaScript execution context. Use this function to bridge + Gets the global JavaScript execution context. Use this function to bridge between the WebKit and JavaScriptCore APIs. Use webkit_frame_get_js_context() instead. + - the global JavaScript context of @frame - + the global JavaScript context of @frame + - a #WebKitFrame + a #WebKitFrame - Get the JavaScript execution context of @frame. Use this function to bridge + Get the JavaScript execution context of @frame. Use this function to bridge between the WebKit and JavaScriptCore APIs. + - the #JSCContext for the JavaScript execution context of @frame. + the #JSCContext for the JavaScript execution context of @frame. - a #WebKitFrame + a #WebKitFrame - Get the JavaScript execution context of @frame for the given #WebKitScriptWorld. + Get the JavaScript execution context of @frame for the given #WebKitScriptWorld. + - the #JSCContext for the JavaScript execution context of @frame for @world. + the #JSCContext for the JavaScript execution context of @frame for @world. - a #WebKitFrame + a #WebKitFrame - a #WebKitScriptWorld + a #WebKitScriptWorld - Get a #JSCValue referencing the given DOM object. The value is created in the JavaScript execution + Get a #JSCValue referencing the given DOM object. The value is created in the JavaScript execution context of @frame. + - the #JSCValue referencing @dom_object. + the #JSCValue referencing @dom_object. - a #WebKitFrame + a #WebKitFrame - a #WebKitDOMObject + a #WebKitDOMObject - Get a #JSCValue referencing the given DOM object. The value is created in the JavaScript execution + Get a #JSCValue referencing the given DOM object. The value is created in the JavaScript execution context of @frame for the given #WebKitScriptWorld. + - the #JSCValue referencing @dom_object + the #JSCValue referencing @dom_object - a #WebKitFrame + a #WebKitFrame - a #WebKitDOMObject + a #WebKitDOMObject - a #WebKitScriptWorld + a #WebKitScriptWorld - Gets the current active URI of @frame. + Gets the current active URI of @frame. + - the current active URI of @frame or %NULL if nothing has been + the current active URI of @frame or %NULL if nothing has been loaded yet. - a #WebKitFrame + a #WebKitFrame - Gets whether @frame is the main frame of a #WebKitWebPage + Gets whether @frame is the main frame of a #WebKitWebPage + - %TRUE if @frame is a main frame or %FALSE otherwise + %TRUE if @frame is a main frame or %FALSE otherwise - a #WebKitFrame + a #WebKitFrame @@ -25601,232 +27710,251 @@ context of @frame for the given #WebKitScriptWorld. + - + + + + + + + - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in #WebKitHitTestResult:context. + - %TRUE if there's an editable element at the coordinates of the @hit_test_result, + %TRUE if there's an editable element at the coordinates of the @hit_test_result, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in #WebKitHitTestResult:context. + - %TRUE if there's an image element in the coordinates of the Hit Test, + %TRUE if there's an image element in the coordinates of the Hit Test, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a link element in the coordinates of the Hit Test, + %TRUE if there's a link element in the coordinates of the Hit Test, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a media element in the coordinates of the Hit Test, + %TRUE if there's a media element in the coordinates of the Hit Test, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a scrollbar element at the coordinates of the @hit_test_result, + %TRUE if there's a scrollbar element at the coordinates of the @hit_test_result, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in + Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in #WebKitHitTestResult:context. + - %TRUE if there's a selected element at the coordinates of the @hit_test_result, + %TRUE if there's a selected element at the coordinates of the @hit_test_result, or %FALSE otherwise - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:context property. + + Gets the value of the #WebKitHitTestResult:context property. + - a bitmask of #WebKitHitTestResultContext flags + a bitmask of #WebKitHitTestResultContext flags - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:image-uri property. + + Gets the value of the #WebKitHitTestResult:image-uri property. + - the URI of the image element in the coordinates of the Hit Test, + the URI of the image element in the coordinates of the Hit Test, or %NULL if there isn't an image element in @hit_test_result context - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:link-label property. + + Gets the value of the #WebKitHitTestResult:link-label property. + - the label of the link element in the coordinates of the Hit Test, + the label of the link element in the coordinates of the Hit Test, or %NULL if there isn't a link element in @hit_test_result context or the link element doesn't have a label - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:link-title property. + + Gets the value of the #WebKitHitTestResult:link-title property. + - the title of the link element in the coordinates of the Hit Test, + the title of the link element in the coordinates of the Hit Test, or %NULL if there isn't a link element in @hit_test_result context or the link element doesn't have a title - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:link-uri property. + + Gets the value of the #WebKitHitTestResult:link-uri property. + - the URI of the link element in the coordinates of the Hit Test, + the URI of the link element in the coordinates of the Hit Test, or %NULL if there isn't a link element in @hit_test_result context - a #WebKitHitTestResult + a #WebKitHitTestResult - - Gets the value of the #WebKitHitTestResult:media-uri property. + + Gets the value of the #WebKitHitTestResult:media-uri property. + - the URI of the media element in the coordinates of the Hit Test, + the URI of the media element in the coordinates of the Hit Test, or %NULL if there isn't a media element in @hit_test_result context - a #WebKitHitTestResult + a #WebKitHitTestResult - - Bitmask of #WebKitHitTestResultContext flags representing + + Bitmask of #WebKitHitTestResultContext flags representing the context of the #WebKitHitTestResult. - - The URI of the image if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE + + The URI of the image if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE is present in #WebKitHitTestResult:context - - The label of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK + + The label of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK is present in #WebKitHitTestResult:context - - The title of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK + + The title of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK is present in #WebKitHitTestResult:context - - The URI of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK + + The URI of the link if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK is present in #WebKitHitTestResult:context - - The URI of the media if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA + + The URI of the media if flag %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA is present in #WebKitHitTestResult:context @@ -25838,11 +27966,13 @@ is present in #WebKitHitTestResult:context + + @@ -25850,6 +27980,7 @@ is present in #WebKitHitTestResult:context + @@ -25857,6 +27988,7 @@ is present in #WebKitHitTestResult:context + @@ -25864,6 +27996,7 @@ is present in #WebKitHitTestResult:context + @@ -25871,195 +28004,226 @@ is present in #WebKitHitTestResult:context - Enum values with flags representing the context of a #WebKitHitTestResult. + Enum values with flags representing the context of a #WebKitHitTestResult. + - anywhere in the document. + anywhere in the document. - a hyperlink element. + a hyperlink element. - an image element. + an image element. - a video or audio element. + a video or audio element. - an editable element + an editable element - a scrollbar element. + a scrollbar element. - a selected element. Since 2.8 + a selected element. Since 2.8 - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Creates a new isolated #WebKitScriptWorld. Scripts executed in + Creates a new isolated #WebKitScriptWorld. Scripts executed in isolated worlds have access to the DOM but not to other variable or functions created by the page. The #WebKitScriptWorld is created with a generated unique name. Use @@ -26067,47 +28231,51 @@ webkit_script_world_new_with_name() if you want to create it with a custom name. You can get the JavaScript execution context of a #WebKitScriptWorld for a given #WebKitFrame with webkit_frame_get_javascript_context_for_script_world(). + - a new isolated #WebKitScriptWorld + a new isolated #WebKitScriptWorld - Creates a new isolated #WebKitScriptWorld with a name. Scripts executed in + Creates a new isolated #WebKitScriptWorld with a name. Scripts executed in isolated worlds have access to the DOM but not to other variable or functions created by the page. You can get the JavaScript execution context of a #WebKitScriptWorld for a given #WebKitFrame with webkit_frame_get_javascript_context_for_script_world(). + - a new isolated #WebKitScriptWorld + a new isolated #WebKitScriptWorld - a name for the script world + a name for the script world - Get the default #WebKitScriptWorld. This is the normal script world + Get the default #WebKitScriptWorld. This is the normal script world where all scripts are executed by default. You can get the JavaScript execution context of a #WebKitScriptWorld for a given #WebKitFrame with webkit_frame_get_javascript_context_for_script_world(). + - the default #WebKitScriptWorld + the default #WebKitScriptWorld - Get the name of a #WebKitScriptWorld. + Get the name of a #WebKitScriptWorld. + - the name of @world + the name of @world - a #WebKitScriptWorld + a #WebKitScriptWorld @@ -26119,7 +28287,7 @@ for a given #WebKitFrame with webkit_frame_get_javascript_context_for_script_wor - Emitted when the JavaScript window object in a #WebKitScriptWorld has been + Emitted when the JavaScript window object in a #WebKitScriptWorld has been cleared. This is the preferred place to set custom properties on the window object using the JavaScriptCore API. You can get the window object of @frame from the JavaScript execution context of @world that is returned by @@ -26129,22 +28297,24 @@ webkit_frame_get_js_context_for_script_world(). - a #WebKitWebPage + a #WebKitWebPage - the #WebKitFrame to which @world belongs + the #WebKitFrame to which @world belongs + + @@ -26152,6 +28322,7 @@ webkit_frame_get_js_context_for_script_world(). + @@ -26159,6 +28330,7 @@ webkit_frame_get_js_context_for_script_world(). + @@ -26166,85 +28338,94 @@ webkit_frame_get_js_context_for_script_world(). + - + + + + - Creates a new #WebKitURIRequest for the given URI. + Creates a new #WebKitURIRequest for the given URI. + - a new #WebKitURIRequest + a new #WebKitURIRequest - an URI + an URI - Get the HTTP headers of a #WebKitURIRequest as a #SoupMessageHeaders. + Get the HTTP headers of a #WebKitURIRequest as a #SoupMessageHeaders. + - a #SoupMessageHeaders with the HTTP headers of @request + a #SoupMessageHeaders with the HTTP headers of @request or %NULL if @request is not an HTTP request. - a #WebKitURIRequest + a #WebKitURIRequest - Get the HTTP method of the #WebKitURIRequest. + Get the HTTP method of the #WebKitURIRequest. + - the HTTP method of the #WebKitURIRequest or %NULL if @request is not + the HTTP method of the #WebKitURIRequest or %NULL if @request is not an HTTP request. - a #WebKitURIRequest + a #WebKitURIRequest - + + - the uri of the #WebKitURIRequest + the uri of the #WebKitURIRequest - a #WebKitURIRequest + a #WebKitURIRequest - - Set the URI of @request + + Set the URI of @request + - a #WebKitURIRequest + a #WebKitURIRequest - an URI + an URI - - The URI to which the request will be made. + + The URI to which the request will be made. @@ -26255,11 +28436,13 @@ webkit_frame_get_js_context_for_script_world(). + + @@ -26267,6 +28450,7 @@ webkit_frame_get_js_context_for_script_world(). + @@ -26274,6 +28458,7 @@ webkit_frame_get_js_context_for_script_world(). + @@ -26281,120 +28466,130 @@ webkit_frame_get_js_context_for_script_world(). + - + + + - - Get the expected content length of the #WebKitURIResponse. It can + + + Get the expected content length of the #WebKitURIResponse. It can be 0 if the server provided an incorrect or missing Content-Length. + - the expected content length of @response. + the expected content length of @response. - a #WebKitURIResponse + a #WebKitURIResponse - - Get the HTTP headers of a #WebKitURIResponse as a #SoupMessageHeaders. + + Get the HTTP headers of a #WebKitURIResponse as a #SoupMessageHeaders. + - a #SoupMessageHeaders with the HTTP headers of @response + a #SoupMessageHeaders with the HTTP headers of @response or %NULL if @response is not an HTTP response. - a #WebKitURIResponse + a #WebKitURIResponse - + + - the MIME type of the #WebKitURIResponse + the MIME type of the #WebKitURIResponse - a #WebKitURIResponse + a #WebKitURIResponse - - Get the status code of the #WebKitURIResponse as returned by + + Get the status code of the #WebKitURIResponse as returned by the server. It will normally be a #SoupKnownStatusCode, for example %SOUP_STATUS_OK, though the server can respond with any unsigned integer. + - the status code of @response + the status code of @response - a #WebKitURIResponse + a #WebKitURIResponse - - Get the suggested filename for @response, as specified by + + Get the suggested filename for @response, as specified by the 'Content-Disposition' HTTP header, or %NULL if it's not present. + - the suggested filename or %NULL if + the suggested filename or %NULL if the 'Content-Disposition' HTTP header is not present. - a #WebKitURIResponse + a #WebKitURIResponse - + + - the uri of the #WebKitURIResponse + the uri of the #WebKitURIResponse - a #WebKitURIResponse + a #WebKitURIResponse - - The expected content length of the response. + + The expected content length of the response. - - The HTTP headers of the response, or %NULL if the response is not an HTTP response. + + The HTTP headers of the response, or %NULL if the response is not an HTTP response. - - The MIME type of the response. + + The MIME type of the response. - - The status code of the response as returned by the server. + + The status code of the response as returned by the server. - - The suggested filename for the URI response. + + The suggested filename for the URI response. - - The URI for which the response was made. + + The URI for which the response was made. @@ -26405,11 +28600,13 @@ present. + + @@ -26417,6 +28614,7 @@ present. + @@ -26424,6 +28622,7 @@ present. + @@ -26431,102 +28630,117 @@ present. + - + + + + + + + + + + + + + - Create a new #WebKitUserMessage with @name. + Create a new #WebKitUserMessage with @name. + - the newly created #WebKitUserMessage object. + the newly created #WebKitUserMessage object. - the message name + the message name - the message parameters as a #GVariant, or %NULL + the message parameters as a #GVariant, or %NULL - Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent. + Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent. + - the newly created #WebKitUserMessage object. + the newly created #WebKitUserMessage object. - the message name + the message name - the message parameters as a #GVariant + the message parameters as a #GVariant - the message file descriptors + the message file descriptors @@ -26536,73 +28750,77 @@ present. - - Get the @message list of file descritpor + + Get the @message list of file descritpor + - the message list of file descriptors + the message list of file descriptors - a #WebKitUserMessage + a #WebKitUserMessage - - Get the @message name + + Get the @message name + - the message name + the message name - a #WebKitUserMessage + a #WebKitUserMessage - - Get the @message parameters + + Get the @message parameters + - the message parameters + the message parameters - a #WebKitUserMessage + a #WebKitUserMessage - Send a reply to @message. If @reply is floating, it's consumed. + Send a reply to @message. If @reply is floating, it's consumed. You can only send a reply to a #WebKitUserMessage that has been received. + - a #WebKitUserMessage + a #WebKitUserMessage - a #WebKitUserMessage to send as reply + a #WebKitUserMessage to send as reply - - The UNIX file descriptors of the user message. + + The UNIX file descriptors of the user message. - - The name of the user message. + + The name of the user message. - - The parameters of the user message as a #GVariant, or %NULL + + The parameters of the user message as a #GVariant, or %NULL if the message doesn't include parameters. Note that only complete types are allowed. @@ -26615,11 +28833,13 @@ allowed. + + @@ -26627,6 +28847,7 @@ allowed. + @@ -26634,6 +28855,7 @@ allowed. + @@ -26641,6 +28863,7 @@ allowed. + @@ -26648,95 +28871,112 @@ allowed. - Enum values used to denote errors happening when sending user messages. + Enum values used to denote errors happening when sending user messages. + - The message was not handled by the receiver. + The message was not handled by the receiver. - + + + + + + + + + + + + + + + + - Gets the #WebKitWebPage that is associated with the #WebKitWebEditor that can + Gets the #WebKitWebPage that is associated with the #WebKitWebEditor that can be used to access the #WebKitDOMDocument currently loaded into it. + - the associated #WebKitWebPage + the associated #WebKitWebPage - a #WebKitWebEditor + a #WebKitWebEditor @@ -26748,7 +28988,7 @@ be used to access the #WebKitDOMDocument currently loaded into it. - This signal is emitted for every selection change inside a #WebKitWebPage + This signal is emitted for every selection change inside a #WebKitWebPage as well as for every caret position change as the caret is a collapsed selection. @@ -26757,75 +28997,82 @@ selection. + - + + + + - Get the web page of the given @page_id. + Get the web page of the given @page_id. + - the #WebKitWebPage for the given @page_id, or %NULL if the + the #WebKitWebPage for the given @page_id, or %NULL if the identifier doesn't correspond to an existing web page. - a #WebKitWebExtension + a #WebKitWebExtension - the identifier of the #WebKitWebPage to get + the identifier of the #WebKitWebPage to get - Send @message to the #WebKitWebContext corresponding to @extension. If @message is floating, it's consumed. + Send @message to the #WebKitWebContext corresponding to @extension. If @message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @calback. When the operation is finished, @callback will be called. You can then call webkit_web_extension_send_message_to_context_finish() to get the message reply. + - a #WebKitWebExtension + a #WebKitWebExtension - a #WebKitUserMessage + a #WebKitUserMessage - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - (nullable): A #GAsyncReadyCallback to call when the request is satisfied or %NULL + (nullable): A #GAsyncReadyCallback to call when the request is satisfied or %NULL - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_extension_send_message_to_context(). + Finish an asynchronous operation started with webkit_web_extension_send_message_to_context(). + - a #WebKitUserMessage with the reply or %NULL in case of error. + a #WebKitUserMessage with the reply or %NULL in case of error. - a #WebKitWebExtension + a #WebKitWebExtension - a #GAsyncResult + a #GAsyncResult @@ -26837,20 +29084,20 @@ webkit_web_extension_send_message_to_context_finish() to get the message reply.< - This signal is emitted when a new #WebKitWebPage is created in + This signal is emitted when a new #WebKitWebPage is created in the Web Process. - the #WebKitWebPage created + the #WebKitWebPage created - This signal is emitted when a #WebKitUserMessage is received from the + This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebContext corresponding to @extension. Messages sent by #WebKitWebContext are always broadcasted to all #WebKitWebExtension<!-- -->s and they can't be replied to. Calling webkit_user_message_send_reply() will do nothing. @@ -26859,66 +29106,73 @@ replied to. Calling webkit_user_message_send_reply() will do nothing. - the #WebKitUserMessage received + the #WebKitUserMessage received + - Type definition for a function that will be called to initialize + Type definition for a function that will be called to initialize the web extension when the web process starts. + - a #WebKitWebExtension + a #WebKitWebExtension - Type definition for a function that will be called to initialize + Type definition for a function that will be called to initialize the web extensions when the web process starts, and which receives as additional argument the user data set with webkit_web_context_set_web_extensions_initialization_user_data(). + - a #WebKitWebExtension + a #WebKitWebExtension - a #GVariant + a #GVariant - + + + - - Get the #WebKitDOMNode in the coordinates of the Hit Test. + + + Get the #WebKitDOMNode in the coordinates of the Hit Test. + - a #WebKitDOMNode + a #WebKitDOMNode - a #WebKitWebHitTestResult + a #WebKitWebHitTestResult - - The #WebKitDOMNode + + The #WebKitDOMNode @@ -26929,11 +29183,13 @@ webkit_web_context_set_web_extensions_initialization_user_data(). + + @@ -26941,6 +29197,7 @@ webkit_web_context_set_web_extensions_initialization_user_data(). + @@ -26948,6 +29205,7 @@ webkit_web_context_set_web_extensions_initialization_user_data(). + @@ -26955,15 +29213,18 @@ webkit_web_context_set_web_extensions_initialization_user_data(). + - + + + - #WebKitContextMenu represents a context menu containing + #WebKitContextMenu represents a context menu containing #WebKitContextMenuItem<!-- -->s in a #WebKitWebView. When a #WebKitWebView is about to display the context menu, it @@ -26976,14 +29237,14 @@ webkit_context_menu_insert(), maybe after having removed the existing ones with webkit_context_menu_remove_all(). - The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- + The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- -->s. These items can be created from a #GtkAction, from a #WebKitContextMenuAction or from a #WebKitContextMenuAction and a label. These #WebKitContextMenuAction<!-- -->s denote stock actions for the items. You can also create separators and submenus. - A Hit Test is an operation to get context information about a given + A Hit Test is an operation to get context information about a given point in a #WebKitWebView. #WebKitHitTestResult represents the result of a Hit Test. It provides context information about what is at the coordinates of the Hit Test, such as if there's a link, @@ -27003,17 +29264,17 @@ for the mouse coordinates and #WebKitWebView::mouse-target-changed signal is emitted with a #WebKitHitTestResult. - A #WebKitURIRequest can be created with a URI using the + A #WebKitURIRequest can be created with a URI using the webkit_uri_request_new() method, and you can get the URI of an existing request with the webkit_uri_request_get_uri() one. - A #WebKitURIResponse contains information such as the URI, the + A #WebKitURIResponse contains information such as the URI, the status code, the content length, the mime type, the HTTP status or the suggested filename. - A WebKitUserMessage is a message that can be used for the communication between the UI process + A WebKitUserMessage is a message that can be used for the communication between the UI process and web extensions. A WebKitUserMessage always has a name, and it can also include parameters and UNIX file descriptors. Messages can be sent from a #WebKitWebContext to all #WebKitWebExtension<!-- -->s, from a #WebKitWebExtension to its corresponding #WebKitWebContext, and from a #WebKitWebView to its @@ -27021,12 +29282,12 @@ corresponding #WebKitWebPage (and vice versa). One to one messages can be replie webkit_user_message_send_reply(). - The WebKitWebEditor provides access to various editing capabilities of + The WebKitWebEditor provides access to various editing capabilities of a #WebKitWebPage such as a possibility to react to the current selection in #WebKitWebPage. - WebKitWebExtension is a loadable module for the WebProcess. It allows you to execute code in the + WebKitWebExtension is a loadable module for the WebProcess. It allows you to execute code in the WebProcess and being able to use the DOM API, to change any request or to inject custom JavaScript code, for example. @@ -27097,131 +29358,139 @@ int main (int argc, char **argv) </programlisting></informalexample> - WebKitWebHitTestResult extends #WebKitHitTestResult to provide information + WebKitWebHitTestResult extends #WebKitHitTestResult to provide information about the #WebKitDOMNode in the coordinates of the Hit Test. + - Get the #WebKitDOMDocument currently loaded in @web_page + Get the #WebKitDOMDocument currently loaded in @web_page + - the #WebKitDOMDocument currently loaded, or %NULL + the #WebKitDOMDocument currently loaded, or %NULL if no document is currently loaded. - a #WebKitWebPage + a #WebKitWebPage - Gets the #WebKitWebEditor of a #WebKitWebPage. + Gets the #WebKitWebEditor of a #WebKitWebPage. + - the #WebKitWebEditor + the #WebKitWebEditor - a #WebKitWebPage + a #WebKitWebPage - Get the identifier of the #WebKitWebPage + Get the identifier of the #WebKitWebPage + - the identifier of @web_page + the identifier of @web_page - a #WebKitWebPage + a #WebKitWebPage - Returns the main frame of a #WebKitWebPage. + Returns the main frame of a #WebKitWebPage. + - the #WebKitFrame that is the main frame of @web_page + the #WebKitFrame that is the main frame of @web_page - a #WebKitWebPage + a #WebKitWebPage - - Returns the current active URI of @web_page. + + Returns the current active URI of @web_page. You can monitor the active URI by connecting to the notify::uri signal of @web_page. + - the current active URI of @web_view or %NULL if nothing has been + the current active URI of @web_view or %NULL if nothing has been loaded yet. - a #WebKitWebPage + a #WebKitWebPage - Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. + Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @callback. When the operation is finished, @callback will be called. You can then call webkit_web_page_send_message_to_view_finish() to get the message reply. + - a #WebKitWebPage + a #WebKitWebPage - a #WebKitUserMessage + a #WebKitUserMessage - a #GCancellable or %NULL to ignore + a #GCancellable or %NULL to ignore - (nullable): A #GAsyncReadyCallback to call when the request is satisfied or %NULL + (nullable): A #GAsyncReadyCallback to call when the request is satisfied or %NULL - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). + Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). + - a #WebKitUserMessage with the reply or %NULL in case of error. + a #WebKitUserMessage with the reply or %NULL in case of error. - a #WebKitWebPage + a #WebKitWebPage - a #GAsyncResult + a #GAsyncResult - - The current active URI of the #WebKitWebPage. + + The current active URI of the #WebKitWebPage. @@ -27231,7 +29500,7 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. - Emitted when a message is sent to the console. This can be a message + Emitted when a message is sent to the console. This can be a message produced by the use of JavaScript console API, a JavaScript exception, a security error or other errors, warnings, debug or log messages. The @console_message contains information of the message. @@ -27240,13 +29509,13 @@ The @console_message contains information of the message. - the #WebKitConsoleMessage + the #WebKitConsoleMessage - Emitted before a context menu is displayed in the UI Process to + Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process @@ -27255,22 +29524,22 @@ add menu entries depending on the #WebKitDOMNode at the coordinates of the @hit_test_result. Otherwise, it's recommended to use #WebKitWebView::context-menu signal instead. - %TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. + %TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. - the proposed #WebKitContextMenu + the proposed #WebKitContextMenu - a #WebKitWebHitTestResult + a #WebKitWebHitTestResult - This signal is emitted when the DOM document of a #WebKitWebPage has been + This signal is emitted when the DOM document of a #WebKitWebPage has been loaded. You can wait for this signal to get the DOM document with @@ -27280,7 +29549,7 @@ webkit_web_page_get_dom_document(). - Emitted after form elements (or form associated elements) are associated to a particular web + Emitted after form elements (or form associated elements) are associated to a particular web page. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same web page. @@ -27295,7 +29564,7 @@ keep them alive after the signal handler returns. - a #GPtrArray of + a #GPtrArray of #WebKitDOMElement with the list of forms in the page @@ -27304,7 +29573,7 @@ keep them alive after the signal handler returns. - Emitted after form elements (or form associated elements) are associated to a particular web + Emitted after form elements (or form associated elements) are associated to a particular web page. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same web page. @@ -27318,20 +29587,20 @@ keep them alive after the signal handler returns. - a #GPtrArray of + a #GPtrArray of #WebKitDOMElement with the list of forms in the page - the #WebKitFrame + the #WebKitFrame - This signal is emitted when @request is about to be sent to + This signal is emitted when @request is about to be sent to the server. This signal can be used to modify the #WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning %TRUE. @@ -27346,23 +29615,23 @@ Modifications to the #WebKitURIRequest and its associated #SoupMessageHeaders will be taken into account when the request is sent over the network. - %TRUE to stop other handlers from being invoked for the event. + %TRUE to stop other handlers from being invoked for the event. %FALSE to continue emission of the event. - a #WebKitURIRequest + a #WebKitURIRequest - a #WebKitURIResponse, or %NULL + a #WebKitURIResponse, or %NULL - This signal is emitted when a #WebKitUserMessage is received from the + This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebView corresponding to @web_page. You can reply to the message using webkit_user_message_send_reply(). @@ -27371,18 +29640,18 @@ You can handle the user message asynchronously by calling g_object_ref() on and the message has been replied, the operation in the #WebKitWebView will finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. - %TRUE if the message was handled, or %FALSE otherwise. + %TRUE if the message was handled, or %FALSE otherwise. - the #WebKitUserMessage received + the #WebKitUserMessage received - This signal is emitted to indicate various points during form + This signal is emitted to indicate various points during form submission. @step indicates the current stage of form submission. If this signal is emitted with %WEBKIT_FORM_SUBMISSION_WILL_SEND_DOM_EVENT, @@ -27414,33 +29683,33 @@ emitted. - the #WebKitDOMElement to be submitted, which will always correspond to an HTMLFormElement + the #WebKitDOMElement to be submitted, which will always correspond to an HTMLFormElement - a #WebKitFormSubmissionEventType indicating the current + a #WebKitFormSubmissionEventType indicating the current stage of form submission - the #WebKitFrame containing the form to be + the #WebKitFrame containing the form to be submitted - the #WebKitFrame containing the form's target, + the #WebKitFrame containing the form's target, which may be the same as @source_frame if no target was specified - names of + names of the form's text fields - values + values of the form's text fields @@ -27450,12 +29719,16 @@ of the form's text fields + - + + + + @@ -27464,6 +29737,7 @@ of the form's text fields + diff --git a/dl.sh b/dl.sh index 472f412..4412fc8 100755 --- a/dl.sh +++ b/dl.sh @@ -1,17 +1,18 @@ #!/bin/bash set -e -./gir-dl.sh https://packages.debian.org/stable/amd64/libatk1.0-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libgirepository1.0-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libgraphene-1.0-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libgdk-pixbuf-2.0-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libgtk-3-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libgtk-4-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libharfbuzz-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libpango1.0-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libjavascriptcoregtk-4.0-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libsoup2.4-dev/download http.us.debian.org -./gir-dl.sh https://packages.debian.org/stable/amd64/libwebkit2gtk-4.0-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libatk1.0-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libgirepository1.0-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libgraphene-1.0-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libgdk-pixbuf-2.0-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libgtk-3-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libgtk-4-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libharfbuzz-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libpango1.0-dev/download http.us.debian.org + +./gir-dl.sh https://packages.debian.org/unstable/amd64/libjavascriptcoregtk-4.0-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libsoup2.4-dev/download http.us.debian.org +./gir-dl.sh https://packages.debian.org/unstable/amd64/libwebkit2gtk-4.0-dev/download http.us.debian.org ./reformat.sh ./fix.sh diff --git a/fix.sh b/fix.sh index f30aee0..3ce613f 100755 --- a/fix.sh +++ b/fix.sh @@ -141,3 +141,23 @@ xmlstarlet ed -L \ -u '//_:constant[@name="INVALID_LIST_POSITION"]/_:type/@name' -v "guint" \ -u '//_:constant[@name="INVALID_LIST_POSITION"]/_:type/@c:type' -v "guint" \ Gtk-4.0.gir + +# change int to uint to prevent overflow +xmlstarlet ed -L \ + -u '//_:constant[@name="DOM_NODE_FILTER_SHOW_ALL"]/_:type[@name="gint"]/@c:type' -v "guint" \ + -u '//_:constant[@name="DOM_NODE_FILTER_SHOW_ALL"]/_:type[@name="gint"]/@name' -v "guint" \ + WebKit2WebExtension-4.0.gir + +xmlstarlet tr JavaScriptCore-4.0.xsl JavaScriptCore-4.0.gir | xmlstarlet fo >JavaScriptCore-4.0.gir.tmp +mv JavaScriptCore-4.0.gir.tmp JavaScriptCore-4.0.gir + +# fill in types from JavaScriptCore +xmlstarlet ed -L \ + -i '///_:type[not(@name) and @c:type="JSGlobalContextRef"]' -t 'attr' -n 'name' -v "JavaScriptCore.GlobalContextRef" \ + -i '///_:type[not(@name) and @c:type="JSValueRef"]' -t 'attr' -n 'name' -v "JavaScriptCore.ValueRef" \ + WebKit2WebExtension-4.0.gir WebKit2-4.0.gir + +xmlstarlet ed -L \ + -u '//_:constant[@name="DOM_NODE_FILTER_SHOW_ALL"]/_:type/@name' -v "guint" \ + -u '//_:constant[@name="DOM_NODE_FILTER_SHOW_ALL"]/_:type/@c:type' -v "guint" \ + WebKit2WebExtension-4.0.gir diff --git a/freetype2-2.0.gir b/freetype2-2.0.gir index ac74dc8..5772e1e 100644 --- a/freetype2-2.0.gir +++ b/freetype2-2.0.gir @@ -1,16 +1,9 @@ - - + + - - - diff --git a/win32-1.0.gir b/win32-1.0.gir index ac9db85..edd3381 100644 --- a/win32-1.0.gir +++ b/win32-1.0.gir @@ -1,10 +1,6 @@ - - + + @@ -16,4 +12,3 @@ -